Objective Systems, Inc.  
Home
About ASN.1
Products
Free Software
Documents
Services
Resources
Resellers
Customers
Careers
About Us
Contact Us
 

Google


Objective Systems, Inc.

rtxCommon.h File Reference

Common runtime constants, data structure definitions, and run-time functions to support various data encoding standards. More...

#include "rtxsrc/rtxCommonDefs.h"
#include "rtxsrc/rtxContext.h"
#include "rtxsrc/rtxMemory.h"

Go to the source code of this file.

Classes

struct  OSEnumItem
struct  OSNumericEnumItem

Defines

#define LOG_RTERR(pctxt, stat)   rtxErrSetData(pctxt,stat,__FILE__,__LINE__)
 This macro is used to log a run-time error in the context.
#define LOG_RTERRNEW(pctxt, stat)   rtxErrSetNewData(pctxt,stat,__FILE__,__LINE__)
#define OSRTASSERT(condition)   if (!(condition)) { rtxErrAssertionFailed(#condition,__LINE__,__FILE__); }
 This macro is used to check an assertion.
#define LOG_RTERR1(pctxt, stat, a)   (LOG_RTERR (pctxt, stat),a,stat)
#define LOG_RTERRNEW1(pctxt, stat, a)   (LOG_RTERRNEW (pctxt, stat),a,stat)
#define LOG_RTERR2(pctxt, stat, a, b)   (LOG_RTERR (pctxt, stat),a,b,stat)
#define LOG_RTERRNEW2(pctxt, stat, a, b)   (LOG_RTERRNEW (pctxt, stat),a,b,stat)
#define RTDIAG1(pctxt, msg)
#define RTDIAG2(pctxt, msg, a)
#define RTDIAG3(pctxt, msg, a, b)
#define RTDIAG4(pctxt, msg, a, b, c)
#define RTDIAG5(pctxt, msg, a, b, c, d)
#define RTDIAGU(pctxt, ucstr)
#define RTHEXDUMP(buffer, numocts)

Typedefs

typedef int(* OSErrCbFunc )(const char *ptext, void *cbArg_p)

Functions

int rtxInitContext (OSCTXT *pctxt)
 This function initializes an OSCTXT block.
int rtxInitContextBuffer (OSCTXT *pctxt, OSOCTET *bufaddr, size_t bufsiz)
 This function assigns a message buffer to a context block.
void rtxFreeContext (OSCTXT *pctxt)
 This function frees all dynamic memory associated with a context.
void rtxCtxtSetFlag (OSCTXT *pctxt, OSUINT16 mask)
 This function is used to set a processing flag within the context structure.
void rtxCtxtClearFlag (OSCTXT *pctxt, OSUINT16 mask)
 This function is used to clear a processing flag within the context structure.
long rtxUTF8ToUnicode (OSCTXT *pctxt, const OSUTF8CHAR *inbuf, OSUNICHAR *outbuf, size_t outbufsiz)
 This function converts a UTF-8 string to a Unicode string (UTF-16).
int rtxValidateUTF8 (OSCTXT *pctxt, const OSUTF8CHAR *inbuf)
 This function will validate a UTF-8 encoded string to ensure that it is encoded correctly.
size_t rtxUTF8Len (const OSUTF8CHAR *inbuf)
 This function will return the length (in characters) of a null-terminated UTF-8 encoded string.
size_t rtxUTF8LenBytes (const OSUTF8CHAR *inbuf)
 This function will return the length (in bytes) of a null-terminated UTF-8 encoded string.
int rtxUTF8CharSize (OS32BITCHAR wc)
 This function will return the number of bytes needed to encode the given 32-bit universal character value as a UTF-8 character.
int rtxUTF8EncodeChar (OS32BITCHAR wc, OSOCTET *buf, size_t bufsiz)
 This function will convert a wide character into an encoded UTF-8 character byte string.
int rtxUTF8DecodeChar (OSCTXT *pctxt, const OSUTF8CHAR *pinbuf, int *pInsize)
 This function will convert an encoded UTF-8 character byte string into a wide character value.
OS32BITCHAR rtxUTF8CharToWC (const OSUTF8CHAR *buf, OSUINT32 *len)
 Thia function will convert a UTF-8 encoded character value into a wide character.
OSUTF8CHARrtxUTF8StrChr (OSUTF8CHAR *utf8str, OS32BITCHAR utf8char)
 This function finds a character in the given UTF-8 character string.
OSUTF8CHARrtxUTF8Strdup (OSCTXT *pctxt, const OSUTF8CHAR *utf8str)
 This function creates a duplicate copy of the given UTF-8 character string.
OSUTF8CHARrtxUTF8Strndup (OSCTXT *pctxt, const OSUTF8CHAR *utf8str, size_t nbytes)
 This function creates a duplicate copy of the given UTF-8 character string.
OSBOOL rtxUTF8StrEqual (const OSUTF8CHAR *utf8str1, const OSUTF8CHAR *utf8str2)
 This function compares two UTF-8 string values for equality.
OSBOOL rtxUTF8StrnEqual (const OSUTF8CHAR *utf8str1, const OSUTF8CHAR *utf8str2, size_t count)
 This function compares two UTF-8 string values for equality.
int rtxUTF8Strcmp (const OSUTF8CHAR *utf8str1, const OSUTF8CHAR *utf8str2)
 This function compares two UTF-8 character strings and returns a trinary result (equal, less than, greater than).
int rtxUTF8Strncmp (const OSUTF8CHAR *utf8str1, const OSUTF8CHAR *utf8str2, size_t count)
 This function compares two UTF-8 character strings and returns a trinary result (equal, less than, greater than).
int rtxUTF8StrToInt (const OSUTF8CHAR *utf8str, OSINT32 *pvalue)
 This function converts the given null-terminated UTF-8 string to an integer value.
int rtxUTF8StrnToInt (const OSUTF8CHAR *utf8str, size_t nbytes, OSINT32 *pvalue)
 This function converts the given part of UTF-8 string to an integer value.
OSBOOL rtxErrAddDoubleParm (OSCTXT *pctxt, double errParm)
 This function adds a double parameter to an error information structure.
OSBOOL rtxErrAddIntParm (OSCTXT *pctxt, int errParm)
 This function adds an integer parameter to an error information structure.
OSBOOL rtxErrAddInt64Parm (OSCTXT *pctxt, OSINT64 errParm)
 This function adds a 64-bit integer parameter to an error information structure.
OSBOOL rtxErrAddStrParm (OSCTXT *pctxt, const char *pErrParm)
 This function adds a character string parameter to an error information structure.
OSBOOL rtxErrAddStrnParm (OSCTXT *pctxt, const char *pErrParm, size_t nchars)
 This function adds a given number of characters from a character string parameter to an error information structure.
OSBOOL rtxErrAddUniStrParm (OSCTXT *pctxt, const OSUNICHAR *pErrParm)
 This function adds a Unicode string parameter to an error information structure.
OSBOOL rtxErrAddUIntParm (OSCTXT *pctxt, unsigned int errParm)
 This function adds an unsigned integer parameter to an error information structure.
OSBOOL rtxErrAddUInt64Parm (OSCTXT *pctxt, OSUINT64 errParm)
 This function adds an unsigned 64-bit integer parameter to an error information structure.
void rtxErrAssertionFailed (const char *conditionText, int lineNo, const char *fileName)
 This function is used to record an assertion failure.
void rtxErrFreeParms (OSCTXT *pctxt)
 This function is used to free dynamic memory that was used in the recording of error parameters.
char * rtxErrGetText (OSCTXT *pctxt, char *pBuf, size_t *pBufSize)
 This function returns error text in a memory buffer.
OSErrInfortxErrNewNode (OSCTXT *pctxt)
 This function creates a new empty error record for the passed context.
int rtxErrReset (OSCTXT *pctxt)
 This function is used to reset the error state recorded in the context to successful.
void rtxErrLogUsingCB (OSCTXT *pctxt, OSErrCbFunc cb, void *cbArg_p)
 This function allows error information to be logged using a user-defined callback routine.
void rtxErrPrint (OSCTXT *pctxt)
 This function is used to print the error information stored in the context to the standard output device.
void rtxErrPrintElement (OSErrInfo *pErrInfo)
 This function is used to print the error information stored in the error information element to the standard output device.
int rtxErrSetData (OSCTXT *pctxt, int status, const char *module, int lineno)
 This function is used to record an error in the context structure.
int rtxErrSetNewData (OSCTXT *pctxt, int status, const char *module, int lineno)
 This function is used to record an error in the context structure.
int rtxErrGetFirstError (const OSCTXT *pctxt)
 This function returns the error code, stored in the first error record.
int rtxErrGetLastError (const OSCTXT *pctxt)
 This function returns the error code, stored in the last error record.
OSUINT32 rtxErrGetErrorsCnt (const OSCTXT *pctxt)
 This function returns the total number of error records.
int rtxErrResetLastErrors (OSCTXT *pctxt, int errorsToReset)
 This function resets last 'errorsToReset` errors in the context.
OSBOOL rtxMatchPattern (OSCTXT *pctxt, const OSUTF8CHAR *text, const OSUTF8CHAR *pattern)
 This function compares the given string to the given pattern.
int rtxCheckBuffer (OSCTXT *pctxt, size_t nbytes)
 ccfPattern
OSBOOL rtxDiagEnabled (OSCTXT *pctxt)
 This function is used to determine if diagnostic tracing is currently enabled for the specified context.
OSBOOL rtxSetDiag (OSCTXT *pctxt, OSBOOL value)
 This function is used to turn diagnostic tracing on or off at run-time.
void rtxDiagPrint (OSCTXT *pctxt, const char *fmtspec,...)
 This function is used to print a diagnostics message to stdout.
void rtxDiagHexDump (OSCTXT *pctxt, const OSOCTET *data, OSUINT32 numocts)
 This function is used to print a diagnostics hex dump of a section of memory.
int rtxDateToString (const OSXSDDateTime *pvalue, OSUTF8CHAR *buffer, size_t bufsize)
 This function formats a numeric date value consisting of individual date components (year, month, day) into XML schema standard format (CCYY-MM-DD).
int rtxTimeToString (const OSXSDDateTime *pvalue, OSUTF8CHAR *buffer, size_t bufsize)
 This function formats a numeric time value consisting of individual time components (hour, minute, second, fraction-of-second, time zone) into XML schema standard format (HH:MM:SS[.frac][TZ]).
int rtxDateTimeToString (const OSXSDDateTime *pvalue, OSUTF8CHAR *buffer, size_t bufsize)
 This function formats a numeric date/time value of all components in the OSXSDDateTime structure into XML schema standard format (CCYY-MM-DDTHH:MM:SS[.frac][TZ]).
int rtxGYearToString (const OSXSDDateTime *pvalue, OSUTF8CHAR *buffer, size_t bufsize)
 This function formats a gregorian year value to a string (CCYY).
int rtxGYearMonthToString (const OSXSDDateTime *pvalue, OSUTF8CHAR *buffer, size_t bufsize)
 This function formats a gregorian year and month value to a string (CCYY-MM).
int rtxGMonthToString (const OSXSDDateTime *pvalue, OSUTF8CHAR *buffer, size_t bufsize)
 This function formats a gregorian month value to a string (MM).
int rtxGMonthDayToString (const OSXSDDateTime *pvalue, OSUTF8CHAR *buffer, size_t bufsize)
 This function formats a gregorian month and day value to a string (MM-DD).
int rtxGDayToString (const OSXSDDateTime *pvalue, OSUTF8CHAR *buffer, size_t bufsize)
 This function formats a gregorian day value to a string (DD).
int rtxGetCurrDateTime (OSXSDDateTime *pvalue)
 This function reads the system date and time and stores the value in the given OSXSDDateTime structure variable.
int rtxCmpDate (const OSXSDDateTime *pvalue1, const OSXSDDateTime *pvalue2)
 This function compares the date part of two OSXSDDateTime structures and returns the result of the comparison.
int rtxCmpDate2 (const OSXSDDateTime *pvalue, OSINT32 year, OSUINT8 mon, OSUINT8 day, OSBOOL tzflag, OSINT32 tzo)
 This function compares the date part of OSXSDDateTime structure and date components, specified as parameters.
int rtxCmpTime (const OSXSDDateTime *pvalue1, const OSXSDDateTime *pvalue2)
 This function compares the time part of two OSXSDDateTime structures and returns the result of the comparison.
int rtxCmpTime2 (const OSXSDDateTime *pvalue, OSUINT8 hour, OSUINT8 min, OSREAL sec, OSBOOL tzflag, OSINT32 tzo)
 This function compares the time part of OSXSDDateTime structure and time components, specified as parameters.
int rtxCmpDateTime (const OSXSDDateTime *pvalue1, const OSXSDDateTime *pvalue2)
 This function compares two OSXSDDateTime structures and returns the result of the comparison.
int rtxCmpDateTime2 (const OSXSDDateTime *pvalue, OSINT32 year, OSUINT8 mon, OSUINT8 day, OSUINT8 hour, OSUINT8 min, OSREAL sec, OSBOOL tzflag, OSINT32 tzo)
 This function compares the OSXSDDateTime structure and dateTime components, specified as parameters.
int rtxParseDateString (const OSUTF8CHAR *inpdata, size_t inpdatalen, OSXSDDateTime *pvalue)
 This function decodes a date value from a supplied string and sets the given OSXSDDateTime argument to the decoded date value.
int rtxParseTimeString (const OSUTF8CHAR *inpdata, size_t inpdatalen, OSXSDDateTime *pvalue)
 This function decodes a time value from a supplied string and sets the given OSXSDDateTime structure to the decoded time value.
int rtxParseDateTimeString (const OSUTF8CHAR *inpdata, size_t inpdatalen, OSXSDDateTime *pvalue)
 This function decodes a datetime value from a supplied string and sets the given OSXSDDateTime to the decoded date and time value.
int rtxParseGYearString (const OSUTF8CHAR *inpdata, size_t inpdatalen, OSXSDDateTime *pvalue)
 This function decodes a gregorian year value from a supplied string and sets the year in the given OSXSDDateTime to the decoded value.
int rtxParseGYearMonthString (const OSUTF8CHAR *inpdata, size_t inpdatalen, OSXSDDateTime *pvalue)
 This function decodes a gregorian year and month value from a supplied string and sets the year and month fields in the given OSXSDDateTime to the decoded values.
int rtxParseGMonthString (const OSUTF8CHAR *inpdata, size_t inpdatalen, OSXSDDateTime *pvalue)
 This function decodes a gregorian month value from a supplied string and sets the month field in the given OSXSDDateTime to the decoded value.
int rtxParseGMonthDayString (const OSUTF8CHAR *inpdata, size_t inpdatalen, OSXSDDateTime *pvalue)
 This function decodes a gregorian month and day value from a supplied string and sets the month and day fields in the given OSXSDDateTime to the decoded values.
int rtxParseGDayString (const OSUTF8CHAR *inpdata, size_t inpdatalen, OSXSDDateTime *pvalue)
 This function decodes a gregorian day value from a supplied string and sets the day field in the given OSXSDDateTime to the decoded value.
int rtxMSecsToDuration (OSINT32 msecs, OSUTF8CHAR *buf, OSUINT32 bufsize)
 This function converts millisecs to a duration string with format "PnYnMnDTnHnMnS".
int rtxDurationToMSecs (OSUTF8CHAR *buf, OSUINT32 bufsize, OSINT32 *msecs)
 This function converts a duration string to milliseconds.
int rtxSetDateTime (OSXSDDateTime *pvalue, struct tm *timeStruct)
 This function converts a structure of type 'struct tm' to an OSXSDDateTime structure.
int rtxSetLocalDateTime (OSXSDDateTime *pvalue, time_t timeMs)
 This function converts a local date and time value to an OSXSDDateTime structure.
int rtxSetUtcDateTime (OSXSDDateTime *pvalue, time_t timeMs)
 This function converts a UTC date and time value to an OSXSDDateTime structure.
int rtxGetDateTime (const OSXSDDateTime *pvalue, time_t *timeMs)
 This function converts an OSXSDDateTime structure to a calendar time encoded as a value of type time_t.


Detailed Description

Common runtime constants, data structure definitions, and run-time functions to support various data encoding standards.

Definition in file rtxCommon.h.


This file was last modified on 8 Jan 2007.
XBinder, Version 1.1.9