rtxPrint.h

Go to the documentation of this file.
00001 /*
00002  * Copyright (c) 2003-2016 Objective Systems, Inc.
00003  *
00004  * This software is furnished under a license and may be used and copied
00005  * only in accordance with the terms of such license and with the
00006  * inclusion of the above copyright notice. This software or any other
00007  * copies thereof may not be provided or otherwise made available to any
00008  * other person. No title to and ownership of the software is hereby
00009  * transferred.
00010  *
00011  * The information in this software is subject to change without notice
00012  * and should not be construed as a commitment by Objective Systems, Inc.
00013  *
00014  * PROPRIETARY NOTICE
00015  *
00016  * This software is an unpublished work subject to a confidentiality agreement
00017  * and is protected by copyright and trade secret law.  Unauthorized copying,
00018  * redistribution or other use of this work is prohibited.
00019  *
00020  * The above notice of copyright on this source code product does not indicate
00021  * any actual or intended publication of such source code.
00022  *
00023  *****************************************************************************/
00024 
00028 #ifndef _RTXPRINT_H_
00029 #define _RTXPRINT_H_
00030 
00031 #include <stdio.h>
00032 #include "rtxsrc/osSysTypes.h"
00033 #include "rtxsrc/rtxExternDefs.h"
00034 #include "rtxsrc/rtxDList.h"
00035 
00036 #define OSRTINDENTSPACES        3       /* number of spaces for indent  */
00037 
00038 #ifdef __cplusplus
00039 extern "C" {
00040 #endif
00041 
00042 /* Run-time print utility functions */
00043 
00059 EXTERNRT int rtxByteToHexChar (OSOCTET byte, char* buf, OSSIZE bufsize);
00060 
00070 EXTERNRT int rtxByteToHexCharWithPrefix
00071    (OSOCTET byte, char* buf, OSSIZE bufsize, const char* prefix);
00072 
00079 EXTERNRT void rtxPrintBoolean (const char* name, OSBOOL value);
00080 
00088 EXTERNRT void rtxPrintDate
00089    (const char* name, const OSNumDateTime *pvalue);
00090 
00098 EXTERNRT void rtxPrintTime
00099    (const char* name, const OSNumDateTime *pvalue);
00100 
00108 EXTERNRT void rtxPrintDateTime
00109    (const char* name, const OSNumDateTime *pvalue);
00110 
00111 EXTERNRT void rtxPrintGYear
00112    (const char* name, const OSNumDateTime* pvalue);
00113 
00114 EXTERNRT void rtxPrintGYearMonth
00115    (const char* name, const OSNumDateTime* pvalue);
00116 
00117 EXTERNRT void rtxPrintGMonth
00118    (const char* name, const OSNumDateTime* pvalue);
00119 
00120 EXTERNRT void rtxPrintGMonthDay
00121    (const char* name, const OSNumDateTime* pvalue);
00122 
00123 EXTERNRT void rtxPrintGDay
00124    (const char* name, const OSNumDateTime* pvalue);
00125 
00132 EXTERNRT void rtxPrintInteger (const char* name, OSINT32 value);
00133 
00140 EXTERNRT void rtxPrintInt64 (const char* name, OSINT64 value);
00141 
00148 EXTERNRT void rtxPrintUnsigned (const char* name, OSUINT32 value);
00149 
00156 EXTERNRT void rtxPrintUInt64 (const char* name, OSUINT64 value);
00157 
00168 EXTERNRT void rtxPrintHexStr
00169 (const char* name, OSSIZE numocts, const OSOCTET* data);
00170 
00180 EXTERNRT void rtxPrintHexStrPlain
00181 (const char* name, OSSIZE numocts, const OSOCTET* data);
00182 
00192 EXTERNRT void rtxPrintHexStrNoAscii
00193 (const char* name, OSSIZE numocts, const OSOCTET* data);
00194 
00202 EXTERNRT void rtxPrintHexBinary
00203 (const char* name, OSSIZE numocts, const OSOCTET* data);
00204 
00211 EXTERNRT void rtxPrintCharStr (const char* name, const char* cstring);
00212 
00219 EXTERNRT void rtxPrintUTF8CharStr
00220 (const char* name, const OSUTF8CHAR* cstring);
00221 
00235 EXTERNRT void rtxPrintUnicodeCharStr
00236 (const char* name, const OSUNICHAR* str, int nchars);
00237 
00244 EXTERNRT void rtxPrintReal (const char* name, OSREAL value);
00245 
00251 EXTERNRT void rtxPrintNull (const char* name);
00252 
00259 EXTERNRT void rtxPrintNVP (const char* name, const OSUTF8NVP* value);
00260 
00267 EXTERNRT int rtxPrintFile (const char* filename);
00268 
00269 #ifndef __SYMBIAN32__
00270 
00274 EXTERNRT void rtxPrintIndent (OSVOIDARG);
00275 
00279 EXTERNRT void rtxPrintIncrIndent (OSVOIDARG);
00280 
00284 EXTERNRT void rtxPrintDecrIndent (OSVOIDARG);
00285 
00290 EXTERNRT void rtxPrintCloseBrace (OSVOIDARG);
00291 
00296 EXTERNRT void rtxPrintOpenBrace (const char*);
00297 
00298 #endif
00299 
00309 EXTERNRT int rtxHexDumpToNamedFile
00310 (const char* filename, const OSOCTET* data, OSSIZE numocts);
00311 
00321 EXTERNRT void rtxHexDumpToFile
00322 (FILE* fp, const OSOCTET* data, OSSIZE numocts);
00323 
00335 EXTERNRT void rtxHexDumpToFileEx
00336 (FILE* fp, const OSOCTET* data, OSSIZE numocts, OSSIZE bytesPerUnit);
00337 
00350 EXTERNRT void rtxHexDumpToFileExNoAscii
00351 (FILE* fp, const OSOCTET* data, OSSIZE numocts, OSSIZE bytesPerUnit);
00352 
00360 EXTERNRT void rtxHexDump (const OSOCTET* data, OSSIZE numocts);
00361 
00372 EXTERNRT void rtxHexDumpEx
00373 (const OSOCTET* data, OSSIZE numocts, OSSIZE bytesPerUnit);
00374 
00387 EXTERNRT int rtxHexDumpToString
00388 (const OSOCTET* data, OSSIZE numocts, char* buffer, OSSIZE bufferIndex,
00389  OSSIZE bufferSize);
00390 
00406 EXTERNRT int rtxHexDumpToStringEx
00407 (const OSOCTET* data, OSSIZE numocts, char* buffer,
00408  OSSIZE bufferIndex, OSSIZE bufferSize, OSSIZE bytesPerUnit);
00409 
00416 EXTERNRT int rtxHexDumpFileContents (const char* inFilePath);
00417 
00425 EXTERNRT int rtxHexDumpFileContentsToFile
00426 (const char* inFilePath, const char* outFilePath);
00427 
00431 #ifdef __cplusplus
00432 }
00433 #endif
00434 
00435 #endif