XBinder  Version 2.9.x
rtxPrintToStream.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2003-2022 Objective Systems, Inc.
3  *
4  * This software is furnished under a license and may be used and copied
5  * only in accordance with the terms of such license and with the
6  * inclusion of the above copyright notice. This software or any other
7  * copies thereof may not be provided or otherwise made available to any
8  * other person. No title to and ownership of the software is hereby
9  * transferred.
10  *
11  * The information in this software is subject to change without notice
12  * and should not be construed as a commitment by Objective Systems, Inc.
13  *
14  * PROPRIETARY NOTICE
15  *
16  * This software is an unpublished work subject to a confidentiality agreement
17  * and is protected by copyright and trade secret law. Unauthorized copying,
18  * redistribution or other use of this work is prohibited.
19  *
20  * The above notice of copyright on this source code product does not indicate
21  * any actual or intended publication of such source code.
22  *
23  *****************************************************************************/
24 
28 #ifndef _RTXPRINTTOSTREAM_H_
29 #define _RTXPRINTTOSTREAM_H_
30 
31 #include <stdio.h>
32 #include "rtxsrc/rtxContext.h"
33 
34 #define OSRTINDENTSPACES 3 /* number of spaces for indent */
35 
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39 
40 /* Run-time print utility functions */
41 
58 EXTERNRT void rtxPrintToStreamBoolean
59  (OSCTXT* pctxt, const char* name, OSBOOL value);
60 
69 EXTERNRT void rtxPrintToStreamDate
70  (OSCTXT* pctxt, const char* name, const OSNumDateTime *pvalue);
71 
80 EXTERNRT void rtxPrintToStreamTime
81  (OSCTXT* pctxt, const char* name, const OSNumDateTime *pvalue);
82 
91 EXTERNRT void rtxPrintToStreamDateTime
92  (OSCTXT* pctxt, const char* name, const OSNumDateTime *pvalue);
93 
94 EXTERNRT void rtxPrintToStreamGYear
95  (OSCTXT* pctxt, const char* name, const OSNumDateTime* pvalue);
96 
97 EXTERNRT void rtxPrintToStreamGYearMonth
98  (OSCTXT* pctxt, const char* name, const OSNumDateTime* pvalue);
99 
100 EXTERNRT void rtxPrintToStreamGMonth
101  (OSCTXT* pctxt, const char* name, const OSNumDateTime* pvalue);
102 
103 EXTERNRT void rtxPrintToStreamGMonthDay
104  (OSCTXT* pctxt, const char* name, const OSNumDateTime* pvalue);
105 
106 EXTERNRT void rtxPrintToStreamGDay
107  (OSCTXT* pctxt, const char* name, const OSNumDateTime* pvalue);
108 
116 EXTERNRT void rtxPrintToStreamInteger
117  (OSCTXT* pctxt, const char* name, OSINT32 value);
118 
126 EXTERNRT void rtxPrintToStreamInt64
127  (OSCTXT* pctxt, const char* name, OSINT64 value);
128 
136 EXTERNRT void rtxPrintToStreamUnsigned
137  (OSCTXT* pctxt, const char* name, OSUINT32 value);
138 
146 EXTERNRT void rtxPrintToStreamUInt64
147  (OSCTXT* pctxt, const char* name, OSUINT64 value);
148 
160 EXTERNRT void rtxPrintToStreamHexStr
161  (OSCTXT* pctxt, const char* name, OSSIZE numocts, const OSOCTET* data);
162 
173 EXTERNRT void rtxPrintToStreamHexStrPlain
174  (OSCTXT* pctxt, const char* name, OSSIZE numocts, const OSOCTET* data);
175 
187 EXTERNRT void rtxPrintToStreamHexStrNoAscii
188  (OSCTXT* pctxt, const char* name, OSSIZE numocts, const OSOCTET* data);
189 
198 EXTERNRT void rtxPrintToStreamHexBinary
199  (OSCTXT* pctxt, const char* name, OSSIZE numocts, const OSOCTET* data);
200 
208 EXTERNRT void rtxPrintToStreamCharStr
209  (OSCTXT* pctxt, const char* name, const char* cstring);
210 
218 EXTERNRT void rtxPrintToStreamUTF8CharStr
219  (OSCTXT* pctxt, const char* name, const OSUTF8CHAR* cstring);
220 
235 EXTERNRT void rtxPrintToStreamUnicodeCharStr
236  (OSCTXT* pctxt, const char* name, const OSUNICHAR* str, int nchars);
237 
245 EXTERNRT void rtxPrintToStreamReal
246  (OSCTXT* pctxt, const char* name, OSREAL value);
247 
254 EXTERNRT void rtxPrintToStreamNull (OSCTXT* pctxt, const char* name);
255 
263 EXTERNRT void rtxPrintToStreamNVP
264  (OSCTXT* pctxt, const char* name, const OSUTF8NVP* value);
265 
273 EXTERNRT int rtxPrintToStreamFile (OSCTXT* pctxt, const char* filename);
274 
275 #ifndef __SYMBIAN32__
276 
279 EXTERNRT void rtxPrintToStreamIndent (OSCTXT* pctxt);
280 
287 EXTERNRT void rtxPrintToStreamResetIndent (OSCTXT* pctxt);
288 
295 EXTERNRT void rtxPrintToStreamIncrIndent (OSCTXT* pctxt);
296 
303 EXTERNRT void rtxPrintToStreamDecrIndent (OSCTXT* pctxt);
304 
309 EXTERNRT void rtxPrintToStreamCloseBrace (OSCTXT* pctxt);
310 
315 EXTERNRT void rtxPrintToStreamOpenBrace (OSCTXT* pctxt, const char*);
316 
317 #endif
318 
327 EXTERNRT void rtxHexDumpToStream
328  (OSCTXT* pctxt, const OSOCTET* data, OSSIZE numocts);
329 
341 EXTERNRT void rtxHexDumpToStreamEx
342  (OSCTXT* pctxt, const OSOCTET* data, OSSIZE numocts, OSSIZE bytesPerUnit);
343 
355 EXTERNRT void rtxHexDumpToStreamExNoAscii
356  (OSCTXT* pctxt, const OSOCTET* data, OSSIZE numocts, OSSIZE bytesPerUnit);
357 
361 #ifdef __cplusplus
362 }
363 #endif
364 
365 #endif /* _RTXPRINTTOSTREAM_H_ */
EXTERNRT void rtxHexDumpToStreamEx(OSCTXT *pctxt, const OSOCTET *data, OSSIZE numocts, OSSIZE bytesPerUnit)
This function outputs a hexadecimal dump of the current buffer to a print stream, but it may output t...
EXTERNRT void rtxPrintToStreamHexBinary(OSCTXT *pctxt, const char *name, OSSIZE numocts, const OSOCTET *data)
Prints an octet string value in hex binary format to a print stream.
EXTERNRT void rtxPrintToStreamHexStrNoAscii(OSCTXT *pctxt, const char *name, OSSIZE numocts, const OSOCTET *data)
This function prints the value of a binary string in hex format to standard output.
EXTERNRT void rtxPrintToStreamBoolean(OSCTXT *pctxt, const char *name, OSBOOL value)
Prints a boolean value to a print stream.
EXTERNRT void rtxPrintToStreamUnicodeCharStr(OSCTXT *pctxt, const char *name, const OSUNICHAR *str, int nchars)
This function prints a Unicode string to standard output.
EXTERNRT void rtxPrintToStreamTime(OSCTXT *pctxt, const char *name, const OSNumDateTime *pvalue)
Prints a time value to a print stream.
EXTERNRT void rtxPrintToStreamUInt64(OSCTXT *pctxt, const char *name, OSUINT64 value)
Prints an unsigned 64-bit integer value to a print stream.
EXTERNRT void rtxPrintToStreamOpenBrace(OSCTXT *pctxt, const char *)
This function opens a braced region by printing indent spaces, printing the name and opening brace...
EXTERNRT void rtxPrintToStreamResetIndent(OSCTXT *pctxt)
This function resets the current indentation level to zero.
EXTERNRT void rtxPrintToStreamNull(OSCTXT *pctxt, const char *name)
Prints a NULL value to a print stream.
EXTERNRT void rtxHexDumpToStream(OSCTXT *pctxt, const OSOCTET *data, OSSIZE numocts)
This function outputs a hexadecimal dump of the current buffer contents to a print stream...
EXTERNRT void rtxPrintToStreamUTF8CharStr(OSCTXT *pctxt, const char *name, const OSUTF8CHAR *cstring)
Prints a UTF-8 encoded character string value to a print stream.
EXTERNRT void rtxPrintToStreamCloseBrace(OSCTXT *pctxt)
This function closes a braced region by decreasing the indent level, printing indent spaces...
Common run-time context definitions.
EXTERNRT void rtxHexDumpToStreamExNoAscii(OSCTXT *pctxt, const OSOCTET *data, OSSIZE numocts, OSSIZE bytesPerUnit)
This function outputs a formatted hexadecimal dump of the current buffer to a print stream...
EXTERNRT void rtxPrintToStreamNVP(OSCTXT *pctxt, const char *name, const OSUTF8NVP *value)
Prints a name-value pair to a print stream.
EXTERNRT void rtxPrintToStreamInt64(OSCTXT *pctxt, const char *name, OSINT64 value)
Prints a 64-bit integer value to a print stream.
EXTERNRT void rtxPrintToStreamIncrIndent(OSCTXT *pctxt)
This function increments the current indentation level.
EXTERNRT void rtxPrintToStreamHexStrPlain(OSCTXT *pctxt, const char *name, OSSIZE numocts, const OSOCTET *data)
This function prints the value of a binary string in hex format to standard output.
EXTERNRT int rtxPrintToStreamFile(OSCTXT *pctxt, const char *filename)
This function prints the contents of a text file to a print stream.
EXTERNRT void rtxPrintToStreamReal(OSCTXT *pctxt, const char *name, OSREAL value)
Prints a REAL (float, double, decimal) value to a print stream.
EXTERNRT void rtxPrintToStreamDateTime(OSCTXT *pctxt, const char *name, const OSNumDateTime *pvalue)
Prints a dateTime value to a print stream.
EXTERNRT void rtxPrintToStreamDate(OSCTXT *pctxt, const char *name, const OSNumDateTime *pvalue)
Prints a date value to a print stream.
EXTERNRT void rtxPrintToStreamHexStr(OSCTXT *pctxt, const char *name, OSSIZE numocts, const OSOCTET *data)
This function prints the value of a binary string in hex format to standard output.
EXTERNRT void rtxPrintToStreamUnsigned(OSCTXT *pctxt, const char *name, OSUINT32 value)
Prints an unsigned integer value to a print stream.
EXTERNRT void rtxPrintToStreamInteger(OSCTXT *pctxt, const char *name, OSINT32 value)
Prints an integer value to a print stream.
EXTERNRT void rtxPrintToStreamCharStr(OSCTXT *pctxt, const char *name, const char *cstring)
Prints an ASCII character string value to a print stream.
Run-time context structure.
Definition: rtxContext.h:198
EXTERNRT void rtxPrintToStreamIndent(OSCTXT *pctxt)
This function prints indentation spaces to a print stream.
Numeric date/time structure.
Definition: osSysTypes.h:140
EXTERNRT void rtxPrintToStreamDecrIndent(OSCTXT *pctxt)
This function decrements the current indentation level.