Site Map | Careers | Contact Us

• PRODUCTS
• SUPPORT
• RESOURCES

• PARTNERS
• CUSTOMERS
• ABOUT US

Home > Support > Documentation

osrtxml.h

Go to the documentation of this file.

/*
 * Copyright (C) 2003-2006 by Objective Systems, Inc.
 *
 * This software is furnished under a license and may be used and copied
 * only in accordance with the terms of such license and with the
 * inclusion of the above copyright notice. This software or any other
 * copies thereof may not be provided or otherwise made available to any
 * other person. No title to and ownership of the software is hereby
 * transferred.
 *
 * The information in this software is subject to change without notice
 * and should not be construed as a commitment by Objective Systems, Inc.
 *
 * PROPRIETARY NOTICE
 *
 * This software is an unpublished work subject to a confidentiality agreement
 * and is protected by copyright and trade secret law.  Unauthorized copying,
 * redistribution or other use of this work is prohibited.
 *
 * The above notice of copyright on this source code product does not indicate
 * any actual or intended publication of such source code.
 *
 *****************************************************************************/
#ifndef _OSRTXML_H_
#define _OSRTXML_H_

#ifdef BUILDXMLDLL
#define EXTERNXML __declspec(dllexport)
#elif defined (USEXMLDLL)
#define EXTERNXML __declspec(dllimport)
#else
#define EXTERNXML
#endif /* BUILDXMLDLL */

#include "rtxsrc/rtxCommon.h"
#include "rtxmlsrc/rtSaxDefs.h"
#include "rtxsrc/rtxDList.h"
#include "rtxsrc/rtxMemBuf.h"
#include "rtxmlsrc/rtXmlErrCodes.h"

/* XML specific context flags */

#define OSUPCASE        0x00008000  /* convert characters to upper case */
#define OSTERMSTART     0x00004000  /* term for start elem (>) needed   */

typedef enum { 
   OSXMLUTF8, 
   OSXMLUTF16
} OSXMLEncoding;

typedef struct OSXMLFacets {
   int totalDigits;
   int fractionDigits;
} OSXMLFacets;

typedef struct {
   const OSUTF8CHAR* value;
   size_t length;
} OSXMLStrFragment;

typedef struct {
   OSXMLStrFragment mQName;
   OSXMLStrFragment mLocalName;
   OSXMLStrFragment mPrefix;
} OSXMLNameFragments;

typedef struct OSXMLItemDescr {
   OSXMLStrFragment localName;
   OSINT16 nsidx; /* namespace index */
} OSXMLItemDescr;

typedef OSXMLItemDescr OSXMLAttrDescr;
typedef OSXMLItemDescr OSXMLElemDescr;

typedef struct OSXMLElemIDRec {
   OSXMLElemDescr descr;
   OSUINT16 id;
} OSXMLElemIDRec;

typedef struct OSXMLGroupDesc {
   int row;
   int num;
   int anyCase;
} OSXMLGroupDesc;

#define OSXMLFRAGSEQUAL(frag1,frag2) \
(frag1.length==frag2.length && !memcmp(frag1.value,frag2.value,frag1.length))

#define OSXMLQNAMEEQUALS(xnamefrag,qnametext) rtxUTF8StrnEqual \
(xnamefrag.mQName.value, OSUTF8(qnametext), xnamefrag.mQName.length)

#define OSXMLTERMSTARTELEM(pctxt) \
OSRTSAFEPUTCHAR (pctxt, '>'); \
pctxt->flags &= ~OSTERMSTART; \
pctxt->state = OSXMLSTART;

/*
 * NOTE: If a field is added to this structure, make sure to add code to 
 * to rtXmlInitCtxtAppInfo in rtXmlContext.c to initialize it.
 */
typedef struct {
   OSFreeCtxtAppInfoPtr  pFreeFunc; /* Free function pointer            */
   OSResetCtxtAppInfoPtr pResetFunc;/* Reset function pointer           */
   OSUTF8CHAR* schemaLocation;  /* xsi:schemaLocation attribute         */
   OSUTF8CHAR* noNSSchemaLoc;   /* xsi:noNamespaceSchemaLocation attr   */
   OSUTF8CHAR* xsiTypeAttr;     /* xsi:type attribute value             */
   OSXMLEncoding encoding;      /* XML document encoding (ex. UTF-8)    */
   OSRTDList namespaceList;     /* list of OSXMLNamespace               */
   OSRTMEMBUF  memBuf;          /* memory buffer for character method   */
   OSINT32 mSaxLevel;
   OSINT32 mSkipLevel;
   OSUINT32 maxSaxErrors;       /* maximum number of errors             */
   OSUINT32 errorsCnt;          /* counter of errors                    */
   OSUINT8 indent;              /* XML output indent                    */
   OSBOOL mbCdataProcessed;     /* CDATA section was processed          */
   OSBOOL encDocHeader;         /* encode XML document header           */
   OSXMLFacets facets;
   char indentChar;             /* indent char, default is space (' ')  */
   const OSUTF8CHAR* encodingStr;/* name of encoding ("UTF-8", "ISO-...")*/
   struct OSXMLReader* pXmlPPReader; /* pull-parser reader object       */
} OSXMLCtxtInfo;

typedef enum { 
   OSXMLINIT, 
   OSXMLHEADER, 
   OSXMLSTART, 
   OSXMLDATA, 
   OSXMLEND
} OSXMLState;

typedef struct OSXMLQName {
   const OSUTF8CHAR* nsPrefix;
   const OSUTF8CHAR* ncName;
} OSXMLQName;

struct OSSAXHandlerBase;

typedef struct OSIntegerFmt {
   OSINT8 integerMaxDigits;   /* Maximum digits in integer part; 
                                 leading zeros will be added, if necessary. */
   OSBOOL signPresent;        /* Indicates, sign must present, even if value 
                                 is positive. */
} OSIntegerFmt;

typedef struct OSDecimalFmt {
   OSINT8 totalDigits;        /* total significiant digits */
   OSINT8 fractionDigits;     /* maximum signficiant digits in fraction, 
                                 precision */
   OSINT8 fractionMinDigits;  /* minimum digits in fraction, if 
                                 fraction digits less than this value 
                                 trailing zeros will be added. */
   OSINT8 integerMaxDigits;   /* Maximum digits in integer part; if it is 0 
                                 and integer part is 0 then integer part 
                                 will be omitted, like .3, or -.3 */
   OSINT8 integerMinDigits;   /* Minimum digits in integer part, leading zeros
                                 will be added if necessary. */
   OSBOOL signPresent;        /* Indicates, sign must present, even if value 
                                 is positive. */
   OSBOOL pointPresent;       /* Indicates, decimal point must present, even 
                                 if value's fraction is 0 */
   OSUINT8 nPatterns;         /* number of patterns stored in 'patterns' */
   const char* const* patterns; /* patterns, used to verify value format is 
                                 correct */
} OSDecimalFmt;

typedef struct OSDoubleFmt {
   OSINT8 totalDigits;        /* total significiant digits */
   OSINT8 fractionDigits;     /* maximum signficiant digits in fraction, 
                                 precision */
   OSINT8 fractionMinDigits;  /* minimum digits in fraction, if 
                                 fraction digits less than this value 
                                 trailing zeros will be added. */
   OSINT8 integerMaxDigits;   /* Maximum digits in integer part; if it is 0 
                                 and integer part is 0 then integer part 
                                 will be omitted, like .3, or -.3 */
   OSINT8 integerMinDigits;   /* Minimum digits in integer part, leading zeros
                                 will be added if necessary. */
   OSINT8 expSymbol;          /* 'E' or 'e' only; 0 if no exp is expected, 
                                 -1 - default ('E') */
   OSINT16 expMinValue;       /* Minimum exponent value. By default - -infinity */
   OSINT16 expMaxValue;       /* Maximum exponent value. By default - infinity */
   OSINT8 expDigits;          /* Total digits in exponent part; if exponent's
                                 value is not enough, trailing zeros will be
                                 added */
   OSBOOL signPresent;        /* Indicates, sign must present, even if value 
                                 is positive. */
   OSBOOL pointPresent;       /* Indicates, decimal point must present, even 
                                 if value's fraction is 0 */
   OSBOOL expPresent;         /* Indicates, exponent must present, even 
                                 if its value is 0 */
   OSBOOL expSignPresent;     /* Indicates, exponent sign must present, even 
                                 if its value is > 0 */
} OSDoubleFmt;

#define OSXMLINDENT     3

#ifdef XML_UNICODE
#define rtXmlErrAddStrParm rtxErrAddUniStrParm
#else
#define rtXmlErrAddStrParm rtxErrAddStrParm
#endif

#ifdef __cplusplus
extern "C" {
#endif

/* run-time XML function prototypes */

EXTERNXML int rtXmlInitContext (OSCTXT* pctxt);

EXTERNXML int rtXmlInitCtxtAppInfo (OSCTXT* pctxt);

EXTERNXML int rtXmlCreateFileInputSource (OSCTXT* pctxt, const char* filepath);

EXTERNXML OSBOOL rtXmlCmpQName 
(const OSUTF8CHAR* qname1, const OSUTF8CHAR* name2, const OSUTF8CHAR* nsPrefix2);

EXTERNXML int rtXmlGetBase64StrDecodedLen 
   (const OSUTF8CHAR* inpdata, size_t srcDataSize, 
    size_t* pNumOcts, size_t* pSrcDataLen);

EXTERNXML int rtXmlDecBase64Binary (OSRTMEMBUF* pMemBuf, 
                                    const OSUTF8CHAR* inpdata, 
                                    int length);

EXTERNXML int rtXmlDecBase64Str (OSCTXT* pctxt, 
                                 OSOCTET* pvalue, OSUINT16* pnocts, 
                                 OSINT32 bufsize);

EXTERNXML int rtXmlDecBase64StrValue (OSCTXT* pctxt, 
                                      OSOCTET* pvalue, OSUINT32* pnocts, 
                                      size_t bufSize, size_t srcDataLen);

EXTERNXML int rtXmlDecBigInt 
(OSCTXT* pctxt, const OSUTF8CHAR** ppvalue);

EXTERNXML int rtXmlDecBool (OSCTXT* pctxt, OSBOOL* pvalue);

EXTERNXML int rtXmlDecDate (OSCTXT* pctxt, OSXSDDateTime* pvalue);

EXTERNXML int rtXmlDecTime (OSCTXT* pctxt, OSXSDDateTime* pvalue);

EXTERNXML int rtXmlDecDateTime (OSCTXT* pctxt, OSXSDDateTime* pvalue);

EXTERNXML int rtXmlDecDecimal (OSCTXT* pctxt, OSREAL* pvalue,
                               int totalDigits, int fractionDigits);

EXTERNXML int rtXmlDecDouble (OSCTXT* pctxt, OSREAL* pvalue,
                              int totalDigits, int fractionDigits);

EXTERNXML int rtXmlDecDynBase64Str (OSCTXT* pctxt, OSDynOctStr* pvalue);

EXTERNXML int rtXmlDecDynHexStr (OSCTXT* pctxt, OSDynOctStr* pvalue);

EXTERNXML int rtXmlDecDynUTF8Str (OSCTXT* pctxt, const OSUTF8CHAR** outdata);

EXTERNXML int rtXmlDecHexBinary (OSRTMEMBUF* pMemBuf, 
                                 const OSUTF8CHAR* inpdata, 
                                 int length);

EXTERNXML int rtXmlDecHexStr (OSCTXT* pctxt, 
                              OSOCTET* pvalue, OSUINT16* pnocts, 
                              OSINT32 bufsize);

EXTERNXML int rtXmlDecHexStrValue (OSCTXT* pctxt,
   const OSUTF8CHAR* const inpdata, size_t nbytes, OSOCTET* pvalue, 
   OSUINT32* pnbits, OSINT32 bufsize);

EXTERNXML int rtXmlDecGYear (OSCTXT* pctxt, OSXSDDateTime* pvalue);

EXTERNXML int rtXmlDecGYearMonth (OSCTXT* pctxt, OSXSDDateTime* pvalue);

EXTERNXML int rtXmlDecGMonth (OSCTXT* pctxt, OSXSDDateTime* pvalue);

EXTERNXML int rtXmlDecGMonthDay (OSCTXT* pctxt, OSXSDDateTime* pvalue);

EXTERNXML int rtXmlDecGDay (OSCTXT* pctxt, OSXSDDateTime* pvalue);

EXTERNXML int rtXmlDecInt (OSCTXT* pctxt, OSINT32* pvalue);

EXTERNXML int rtXmlDecInt8 (OSCTXT* pctxt, OSINT8* pvalue);

EXTERNXML int rtXmlDecInt16 (OSCTXT* pctxt, OSINT16* pvalue);

EXTERNXML int rtXmlDecInt64 (OSCTXT* pctxt, OSINT64* pvalue);

EXTERNXML int rtXmlDecUInt (OSCTXT* pctxt, OSUINT32* pvalue);

EXTERNXML int rtXmlDecUInt8 (OSCTXT* pctxt, OSUINT8* pvalue);

EXTERNXML int rtXmlDecUInt16 (OSCTXT* pctxt, OSUINT16* pvalue);

EXTERNXML int rtXmlDecUInt64 (OSCTXT* pctxt, OSUINT64* pvalue);

EXTERNXML const OSUTF8CHAR* rtXmlDecQName 
(OSCTXT* pctxt, const OSUTF8CHAR* qname, const OSUTF8CHAR** prefix);

EXTERNXML int rtXmlDecXSIAttr 
   (OSCTXT* pctxt, const OSUTF8CHAR* attrName, const OSUTF8CHAR* attrValue);

EXTERNXML int rtXmlDecXSIAttrs (OSCTXT* pctxt, const OSUTF8CHAR* const* attrs,
   const char* typeName);

EXTERNXML int rtXmlDecXmlStr (OSCTXT* pctxt, OSXMLSTRING* outdata);

EXTERNXML int rtXmlParseElementName (OSCTXT* pctxt, OSUTF8CHAR** ppName);

EXTERNXML int rtXmlParseElemQName (OSCTXT* pctxt, OSXMLQName* pQName);

EXTERNXML int rtXmlEncAny (OSCTXT* pctxt, OSXMLSTRING* pvalue, 
                           const OSUTF8CHAR* elemName, 
                           const OSUTF8CHAR* nsPrefix);

EXTERNXML int rtXmlEncAnyStr 
(OSCTXT* pctxt, const OSUTF8CHAR* pvalue, 
 const OSUTF8CHAR* elemName, const OSUTF8CHAR* nsPrefix);

EXTERNXML int rtXmlEncAnyAttr (OSCTXT* pctxt, OSRTDList* pAnyAttrList);

EXTERNXML int rtXmlEncBase64Binary (OSCTXT* pctxt, OSUINT32 nocts, 
                                    const OSOCTET* value, 
                                    const OSUTF8CHAR* elemName, 
                                    const OSUTF8CHAR* nsPrefix);

EXTERNXML int rtXmlEncBase64BinaryAttr 
   (OSCTXT* pctxt, OSUINT32 nocts, const OSOCTET* value,
    const OSUTF8CHAR* attrName, OSUINT16 attrNameLen);

EXTERNXML int rtXmlEncBase64StrValue (OSCTXT* pctxt, OSUINT32 nocts, 
                                      const OSOCTET* value);

EXTERNXML int rtXmlEncBigInt (OSCTXT* pctxt, const OSUTF8CHAR* value, 
                              const OSUTF8CHAR* elemName, 
                              const OSUTF8CHAR* nsPrefix);

EXTERNXML int rtXmlEncBigIntAttr (OSCTXT* pctxt, const OSUTF8CHAR* value, 
                       const OSUTF8CHAR* attrName, OSUINT16 attrNameLen);

EXTERNXML int rtXmlEncBigIntValue (OSCTXT* pctxt, const OSUTF8CHAR* value);

EXTERNXML int rtXmlEncBitString (OSCTXT* pctxt, OSUINT32 nbits, 
                                 const OSOCTET* value, 
                                 const OSUTF8CHAR* elemName, 
                                 const OSUTF8CHAR* nsPrefix);

EXTERNXML int rtXmlEncBinStrValue (OSCTXT* pctxt, 
                                   OSUINT32 nbits, 
                                   const OSOCTET* data);

EXTERNXML int rtXmlEncBool (OSCTXT* pctxt, OSBOOL value, 
                            const OSUTF8CHAR* elemName, 
                            const OSUTF8CHAR* nsPrefix);

EXTERNXML int rtXmlEncBoolValue (OSCTXT* pctxt, OSBOOL value);

EXTERNXML int rtXmlEncBoolAttr (OSCTXT* pctxt, OSBOOL value, 
                                const OSUTF8CHAR* attrName, 
                                OSUINT16 attrNameLen);

EXTERNXML int rtXmlEncDate (OSCTXT* pctxt, const OSXSDDateTime* pvalue, 
                            const OSUTF8CHAR* elemName,
                            const OSUTF8CHAR* nsPrefix);

EXTERNXML int rtXmlEncDateValue 
   (OSCTXT* pctxt, const OSXSDDateTime* pvalue);

EXTERNXML int rtXmlEncTime (OSCTXT* pctxt, const OSXSDDateTime* pvalue,
                            const OSUTF8CHAR* elemName,
                            const OSUTF8CHAR* nsPrefix);

EXTERNXML int rtXmlEncTimeValue 
   (OSCTXT* pctxt, const OSXSDDateTime* pvalue);

EXTERNXML int rtXmlEncDateTime (OSCTXT* pctxt, const OSXSDDateTime* pvalue,
                                const OSUTF8CHAR* elemName,
                                const OSUTF8CHAR* nsPrefix);

EXTERNXML int rtXmlEncDateTimeValue 
   (OSCTXT* pctxt, const OSXSDDateTime* pvalue);

EXTERNXML int rtXmlEncDecimal (OSCTXT* pctxt, OSREAL value, 
                               const OSUTF8CHAR* elemName, 
                               const OSUTF8CHAR* nsPrefix,
                               const OSDecimalFmt* pFmtSpec);

EXTERNXML int rtXmlEncDecimalAttr (OSCTXT* pctxt, OSREAL value, 
                                   const OSUTF8CHAR* attrName, 
                                   OSUINT16 attrNameLen,
                                   const OSDecimalFmt* pFmtSpec);

EXTERNXML int rtXmlEncDecimalValue (OSCTXT* pctxt, OSREAL value,
                                    const OSDecimalFmt* pFmtSpec,
                                    char* pDestBuf, size_t destBufSize);

EXTERNXML int rtXmlEncDouble (OSCTXT* pctxt, OSREAL value, 
                              const OSUTF8CHAR* elemName, 
                              const OSUTF8CHAR* nsPrefix,
                              const OSDoubleFmt* pFmtSpec);

EXTERNXML int rtXmlEncDoubleAttr (OSCTXT* pctxt, OSREAL value, 
                                  const OSUTF8CHAR* attrName, 
                                  OSUINT16 attrNameLen,
                                  const OSDoubleFmt* pFmtSpec);

EXTERNXML int rtXmlEncDoubleValue (OSCTXT* pctxt, OSREAL value,
                                   const OSDoubleFmt* pFmtSpec,
                                   int defaultPrecision);

EXTERNXML int rtXmlEncEmptyElement (OSCTXT* pctxt, 
                                    const OSUTF8CHAR* elemName, 
                                    const OSUTF8CHAR* nsPrefix, 
                                    OSBOOL terminate);

EXTERNXML int rtXmlEncEmptyElement2 (OSCTXT* pctxt, 
                                     const OSUTF8CHAR* elemName, 
                                     size_t elemLen,
                                     const OSUTF8CHAR* nsPrefix, 
                                     size_t nsPrefixLen, 
                                     OSBOOL terminate);

EXTERNXML int rtXmlEncEndDocument (OSCTXT* pctxt);

EXTERNXML int rtXmlEncEndElement (OSCTXT* pctxt, 
                                  const OSUTF8CHAR* elemName, 
                                  const OSUTF8CHAR* nsPrefix);

EXTERNXML int rtXmlEncEndElement2 (OSCTXT* pctxt, 
                                   const OSUTF8CHAR* elemName, 
                                   size_t elemLen, 
                                   const OSUTF8CHAR* nsPrefix, 
                                   size_t nsPrefixLen);

EXTERNXML int rtXmlEncEndSoapEnv (OSCTXT* pctxt); 

EXTERNXML int rtXmlEncFloat (OSCTXT* pctxt, OSREAL value, 
                             const OSUTF8CHAR* elemName, 
                             const OSUTF8CHAR* nsPrefix,
                             const OSDoubleFmt* pFmtSpec);

EXTERNXML int rtXmlEncFloatAttr (OSCTXT* pctxt, OSREAL value, 
                                 const OSUTF8CHAR* attrName, 
                                 OSUINT16 attrNameLen,
                                 const OSDoubleFmt* pFmtSpec);

EXTERNXML int rtXmlEncGYear (OSCTXT* pctxt, const OSXSDDateTime* pvalue,
                   const OSUTF8CHAR* elemName,
                   const OSUTF8CHAR* nsPrefix);

EXTERNXML int rtXmlEncGYearMonth (OSCTXT* pctxt, const OSXSDDateTime* pvalue,
                        const OSUTF8CHAR* elemName,
                        const OSUTF8CHAR* nsPrefix);

EXTERNXML int rtXmlEncGMonth (OSCTXT* pctxt, const OSXSDDateTime* pvalue,
                    const OSUTF8CHAR* elemName,
                    const OSUTF8CHAR* nsPrefix);

EXTERNXML int rtXmlEncGMonthDay (OSCTXT* pctxt, const OSXSDDateTime* pvalue,
                       const OSUTF8CHAR* elemName,
                       const OSUTF8CHAR* nsPrefix);

EXTERNXML int rtXmlEncGDay (OSCTXT* pctxt, const OSXSDDateTime* pvalue,
                       const OSUTF8CHAR* elemName,
                       const OSUTF8CHAR* nsPrefix);

EXTERNXML int rtXmlEncGYearValue 
   (OSCTXT* pctxt, const OSXSDDateTime* pvalue);

EXTERNXML int rtXmlEncGYearMonthValue 
   (OSCTXT* pctxt, const OSXSDDateTime* pvalue);

EXTERNXML int rtXmlEncGMonthValue 
   (OSCTXT* pctxt, const OSXSDDateTime* pvalue);

EXTERNXML int rtXmlEncGMonthDayValue 
   (OSCTXT* pctxt, const OSXSDDateTime* pvalue);

EXTERNXML int rtXmlEncGDayValue 
   (OSCTXT* pctxt, const OSXSDDateTime* pvalue);

EXTERNXML int rtXmlEncHexBinary (OSCTXT* pctxt, OSUINT32 nocts, 
                                 const OSOCTET* value, 
                                 const OSUTF8CHAR* elemName, 
                                 const OSUTF8CHAR* nsPrefix);

EXTERNXML int rtXmlEncHexBinaryAttr 
   (OSCTXT* pctxt, OSUINT32 nocts, const OSOCTET* value,
    const OSUTF8CHAR* attrName, OSUINT16 attrNameLen);

EXTERNXML int rtXmlEncHexStrValue (OSCTXT* pctxt, 
                                   OSUINT32 nocts, 
                                   const OSOCTET* data);

EXTERNXML int rtXmlEncIndent (OSCTXT* pctxt);

EXTERNXML int rtXmlEncInt (OSCTXT* pctxt, OSINT32 value, 
                           const OSUTF8CHAR* elemName, 
                           const OSUTF8CHAR* nsPrefix);

EXTERNXML int rtXmlEncIntValue (OSCTXT* pctxt, OSINT32 value);

EXTERNXML int rtXmlEncIntAttr (OSCTXT* pctxt, OSINT32 value, 
                               const OSUTF8CHAR* attrName, 
                               OSUINT16 attrNameLen);

EXTERNXML int rtXmlEncIntPattern (OSCTXT* pctxt, OSINT32 value, 
                                  const OSUTF8CHAR* elemName, 
                                  const OSUTF8CHAR* nsPrefix, 
                                  const OSUTF8CHAR* pattern);

EXTERNXML int rtXmlEncIntPatternValue (OSCTXT* pctxt, OSINT32 value, 
                                       const OSUTF8CHAR* pattern);

EXTERNXML int rtXmlEncInt64 (OSCTXT* pctxt, OSINT64 value, 
                             const OSUTF8CHAR* elemName, 
                             const OSUTF8CHAR* nsPrefix);

EXTERNXML int rtXmlEncInt64Value (OSCTXT* pctxt, OSINT64 value);

EXTERNXML int rtXmlEncInt64Attr (OSCTXT* pctxt, OSINT64 value, 
                                 const OSUTF8CHAR* attrName, 
                                 OSUINT16 attrNameLen);

EXTERNXML int rtXmlEncNamedBits
(OSCTXT* pctxt, const OSBitMapItem* pBitMap, OSUINT32 nbits, 
 const OSOCTET* pvalue, const OSUTF8CHAR* elemName, const OSUTF8CHAR* nsPrefix);

EXTERNXML int rtXmlEncNamedBitsValue
(OSCTXT* pctxt, const OSBitMapItem* pBitMap, OSUINT32 nbits, 
 const OSOCTET* pvalue);

EXTERNXML int rtXmlEncInt64Value (OSCTXT* pctxt, OSINT64 value);

EXTERNXML int rtXmlEncNSAttrs (OSCTXT* pctxt);

EXTERNXML int rtXmlEncReal10 
(OSCTXT *pctxt, const OSUTF8CHAR *pvalue, const OSUTF8CHAR* elemName, 
 const OSUTF8CHAR* nsPrefix);

EXTERNXML int rtXmlEncSoapArrayTypeAttr 
(OSCTXT* pctxt, const OSUTF8CHAR* name, const OSUTF8CHAR* value, 
 size_t itemCount);

EXTERNXML int rtXmlEncSoapArrayTypeAttr2 
(OSCTXT* pctxt, const OSUTF8CHAR* name, size_t nameLen, 
 const OSUTF8CHAR* value, size_t valueLen, size_t itemCount);

EXTERNXML int rtXmlEncStartDocument (OSCTXT* pctxt);

EXTERNXML int rtXmlEncStartElement (OSCTXT* pctxt, 
                                    const OSUTF8CHAR* elemName, 
                                    const OSUTF8CHAR* nsPrefix, 
                                    OSBOOL terminate);

EXTERNXML int rtXmlEncStartElement2 (OSCTXT* pctxt, 
                                     const OSUTF8CHAR* elemName, 
                                     size_t elemLen,
                                     const OSUTF8CHAR* nsPrefix, 
                                     size_t nsPrefixLen,
                                     OSBOOL terminate);

EXTERNXML int rtXmlEncStartSoapEnv (OSCTXT* pctxt); 

EXTERNXML int rtXmlEncString (OSCTXT* pctxt, 
                              OSXMLSTRING* pxmlstr, 
                              const OSUTF8CHAR* elemName, 
                              const OSUTF8CHAR* nsPrefix);

EXTERNXML int rtXmlEncStringValue (OSCTXT* pctxt, const OSUTF8CHAR* value);

EXTERNXML int rtXmlEncStringValue2 
   (OSCTXT* pctxt, const OSUTF8CHAR* value, size_t valueLen);

EXTERNXML int rtXmlEncUnicodeStr (OSCTXT* pctxt, 
                                  const OSUNICHAR* value, 
                                  OSUINT32 nchars, 
                                  const OSUTF8CHAR* elemName, 
                                  const OSUTF8CHAR* nsPrefix);

EXTERNXML int rtXmlEncUTF8Attr (OSCTXT* pctxt, 
                                const OSUTF8CHAR* name, 
                                const OSUTF8CHAR* value);

EXTERNXML int rtXmlEncUTF8Attr2 (OSCTXT* pctxt, 
                                 const OSUTF8CHAR* name, size_t nameLen, 
                                 const OSUTF8CHAR* value, size_t valueLen);

EXTERNXML int rtXmlEncUTF8Str (OSCTXT* pctxt, 
                               const OSUTF8CHAR* value,
                               const OSUTF8CHAR* elemName, 
                               const OSUTF8CHAR* nsPrefix);

EXTERNXML int rtXmlEncUInt (OSCTXT* pctxt, OSUINT32 value, 
                            const OSUTF8CHAR* elemName, 
                            const OSUTF8CHAR* nsPrefix);

EXTERNXML int rtXmlEncUIntValue (OSCTXT* pctxt, OSUINT32 value);

EXTERNXML int rtXmlEncUIntAttr (OSCTXT* pctxt, OSUINT32 value, 
                                const OSUTF8CHAR* attrName, 
                                OSUINT16 attrNameLen);

EXTERNXML int rtXmlEncUInt64 (OSCTXT* pctxt, OSUINT64 value, 
                              const OSUTF8CHAR* elemName, 
                              const OSUTF8CHAR* nsPrefix);

EXTERNXML int rtXmlEncUInt64Value (OSCTXT* pctxt, OSUINT64 value);

EXTERNXML int rtXmlEncUInt64Attr (OSCTXT* pctxt, OSUINT64 value, 
                                  const OSUTF8CHAR* attrName, 
                                  OSUINT16 attrNameLen);

EXTERNXML int rtXmlEncXSIAttrs (OSCTXT* pctxt, OSBOOL needXSI);

EXTERNXML int rtXmlFreeInputSource (OSCTXT* pctxt);

EXTERNXML OSBOOL rtXmlStrCmpAsc (const OSUTF8CHAR* text1, const char* text2);

EXTERNXML OSBOOL rtXmlStrnCmpAsc (const OSUTF8CHAR* text1, 
                                  const char* text2, size_t len);

/*EXTERNXML int rtXmlFinalizeMemBuf (OSRTMEMBUF* pMemBuf);*/

#define rtXmlFinalizeMemBuf(pMemBuf) do { \
(pMemBuf)->pctxt->buffer.data = (pMemBuf)->buffer + (pMemBuf)->startidx; \
(pMemBuf)->pctxt->buffer.size =                                      \
((pMemBuf)->usedcnt - (pMemBuf)->startidx);                          \
(pMemBuf)->pctxt->buffer.dynamic = FALSE;                            \
(pMemBuf)->pctxt->buffer.byteIndex = 0;                              \
rtxMemBufReset (pMemBuf);                                            \
} while(0)

EXTERNXML int rtXmlSetEncBufPtr 
(OSCTXT* pctxt, OSOCTET* bufaddr, size_t bufsiz);

#define rtXmlGetEncBufPtr(pctxt) (pctxt)->buffer.data

#define rtXmlGetEncBufLen(pctxt) (pctxt)->buffer.byteIndex


EXTERNXML int rtXmlGetIndent (OSCTXT* pctxt);

EXTERNXML int rtXmlGetIndentChar (OSCTXT* pctxt);
EXTERNXML int rtXmlSetDigitsFacets 
   (OSCTXT* pctxt, int totalDigits, int fractionDigits);

EXTERNXML int rtXmlSetEncDocHdr (OSCTXT* pctxt, OSBOOL value);

EXTERNXML int rtXmlSetEncoding (OSCTXT* pctxt, OSXMLEncoding encoding);

EXTERNXML int rtXmlSetFormatting (OSCTXT* pctxt, OSBOOL doFormatting);

EXTERNXML int rtXmlSetIndent (OSCTXT* pctxt, OSUINT8 indent);

EXTERNXML int rtXmlSetIndentChar (OSCTXT* pctxt, char indentChar);

EXTERNXML int rtXmlSetSchemaLocation 
(OSCTXT* pctxt, const OSUTF8CHAR* schemaLocation);

EXTERNXML int rtXmlSetNoNSSchemaLocation 
(OSCTXT* pctxt, const OSUTF8CHAR* schemaLocation);

EXTERNXML int rtXmlSetXSITypeAttr (OSCTXT* pctxt, const OSUTF8CHAR* xsiType);

#include "rtxmlsrc/rtXmlNamespace.h"

EXTERNXML int rtXmlMatchHexStr 
(OSCTXT* pctxt, size_t minLength, size_t maxLength);

EXTERNXML int rtXmlMatchBase64Str 
(OSCTXT* pctxt, size_t minLength, size_t maxLength);

EXTERNXML int rtXmlMatchDate (OSCTXT* pctxt);

EXTERNXML int rtXmlMatchTime (OSCTXT* pctxt);

EXTERNXML int rtXmlMatchDateTime (OSCTXT* pctxt);

EXTERNXML int rtXmlMatchGYear (OSCTXT* pctxt);

EXTERNXML int rtXmlMatchGYearMonth (OSCTXT* pctxt);

EXTERNXML int rtXmlMatchGMonth (OSCTXT* pctxt);

EXTERNXML int rtXmlMatchGMonthDay (OSCTXT* pctxt);

EXTERNXML int rtXmlMatchGDay (OSCTXT* pctxt);

/* not supported yet */
EXTERNXML OSBOOL rtXmlCmpBase64Str (OSCTXT* pctxt, 
                                    OSUINT32 nocts1, 
                                    const OSOCTET* data1,
                                    const OSUTF8CHAR* data2);

/* not supported yet */
EXTERNXML OSBOOL rtXmlCmpHexStr (OSCTXT* pctxt, 
                                 OSUINT32 nocts1, 
                                 const OSOCTET* data1,
                                 const OSUTF8CHAR* data2);

EXTERNXML int rtSaxGetAttributeID (OSCTXT* pctxt, 
                                   const OSUTF8CHAR* attrName,
                                   size_t nAttr, 
                                   const OSUTF8CHAR* attrNames[],
                                   OSUINT32 attrPresent[]);

EXTERNXML int rtSaxGetElemID 
(OSINT16* pState, OSINT16 prevElemIdx, const OSUTF8CHAR* localName, 
 const OSSAXElemTableRec idtab[], const int* fstab, 
 int fstabRows, int fstabCols);

EXTERNXML int rtSaxGetElemID8 
(OSINT16* pState, OSINT16 prevElemIdx, const OSUTF8CHAR* localName, 
 const OSSAXElemTableRec idtab[], const OSINT8* fstab, 
 int fstabRows, int fstabCols);

EXTERNXML int rtSaxFindElemID (OSINT16* pState, OSINT16 prevElemIdx,
                               const OSUTF8CHAR* localName, 
                               const OSSAXElemTableRec idtab[], 
                               const int* fstab,
                               int fstabRows, int fstabCols);

EXTERNXML int rtSaxFindElemID8 (OSINT16* pState, OSINT16 prevElemIdx,
                                const OSUTF8CHAR* localName, 
                                const OSSAXElemTableRec idtab[], 
                                const OSINT8* fstab,
                                int fstabRows, int fstabCols);

EXTERNXML OSBOOL rtSaxIsEmptyBuffer (OSCTXT* pctxt, int whitespace);

EXTERNXML int rtSaxLookupElemID (OSCTXT* pctxt, OSINT16* pState, 
                         OSINT16 prevElemIdx,
                         const OSUTF8CHAR* localName, const OSUTF8CHAR* qName,
                         const OSSAXElemTableRec idtab[], 
                         const int* fstab,
                         int fstabRows, int fstabCols);

EXTERNXML int rtSaxLookupElemID8 (OSCTXT* pctxt, OSINT16* pState, 
                         OSINT16 prevElemIdx,
                         const OSUTF8CHAR* localName, const OSUTF8CHAR* qName,
                         const OSSAXElemTableRec idtab[], 
                         const OSINT8* fstab,
                         int fstabRows, int fstabCols);

EXTERNXML int rtSaxStrListParse 
   (OSCTXT* pctxt, OSRTMEMBUF *pMemBuf, OSRTDList* pvalue);

EXTERNXML int rtSaxStrListMatch (OSCTXT* pctxt);

EXTERNXML OSBOOL rtSaxTestFinal (OSINT16 state, 
                                 OSINT16 currElemIdx,
                                 const int* fstab,
                                 int fstabRows, int fstabCols);

EXTERNXML OSBOOL rtSaxTestFinal8 (OSINT16 state, 
                                  OSINT16 currElemIdx,
                                  const OSINT8* fstab,
                                  int fstabRows, int fstabCols);

EXTERNXML int rtSaxSetSkipLevelToCurrent (OSCTXT* pctxt, int stat);

EXTERNXML OSUINT32 rtSaxSetMaxErrors (OSCTXT* pctxt, OSUINT32 maxErrors);

EXTERNXML OSUINT32 rtSaxGetMaxErrors (OSCTXT* pctxt);

EXTERNXML int rtSaxTestAttributesPresent (OSCTXT* pctxt, 
   const OSUINT32* attrPresent, const OSUINT32* reqAttrMask, 
   const OSUTF8CHAR* const* attrNames, size_t numOfAttrs,
   const char* parentTypeName);

EXTERNXML OSBOOL rtSaxIncErrors (OSCTXT* pctxt);

EXTERNXML int rtSaxReportUnexpAttrs (OSCTXT* pctxt, 
    const OSUTF8CHAR* const* attrs, 
    const char* typeName);

EXTERNXML int rtXmlWriteToFile (OSCTXT* pctxt, const char* filename);

EXTERNXML void rtXmlTreatWhitespaces (OSCTXT* pctxt, int whiteSpaceType);

EXTERNXML void rtErrXmlInit (void);

EXTERNXML int rtXmlpDecAny (OSCTXT* pctxt, const OSUTF8CHAR** pvalue);

EXTERNXML int rtXmlpDecAnyAttrStr 
(OSCTXT* pctxt, const OSUTF8CHAR** ppAttrStr, size_t index);

EXTERNXML int rtXmlpDecAnyElem (OSCTXT* pctxt, const OSUTF8CHAR** pvalue);

EXTERNXML int rtXmlpDecBase64Str (OSCTXT* pctxt, OSOCTET* pvalue, 
   OSUINT32* pnocts, OSINT32 bufsize);

EXTERNXML int rtXmlpDecBigInt (OSCTXT* pctxt, const OSUTF8CHAR** pvalue);

EXTERNXML int rtXmlpDecBitString 
(OSCTXT* pctxt, OSOCTET* pvalue, OSUINT32* pnbits, OSUINT32 bufsize);

EXTERNXML int rtXmlpDecBool (OSCTXT* pctxt, OSBOOL* pvalue);

EXTERNXML int rtXmlpDecDate (OSCTXT* pctxt, OSXSDDateTime* pvalue);

EXTERNXML int rtXmlpDecDateTime (OSCTXT* pctxt, OSXSDDateTime* pvalue);

EXTERNXML int rtXmlpDecDecimal (OSCTXT* pctxt, OSREAL* pvalue,
   int totalDigits, int fractionDigits);

EXTERNXML int rtXmlpDecDouble (OSCTXT* pctxt, OSREAL* pvalue,
   int totalDigits, int fractionDigits);

EXTERNXML int rtXmlpDecDynBase64Str (OSCTXT* pctxt, OSDynOctStr* pvalue);

EXTERNXML int rtXmlpDecDynBitString (OSCTXT* pctxt, OSDynOctStr* pvalue);

EXTERNXML int rtXmlpDecDynHexStr (OSCTXT* pctxt, OSDynOctStr* pvalue);

EXTERNXML int rtXmlpDecDynUnicodeStr 
(OSCTXT* pctxt, const OSUNICHAR** ppdata, OSUINT32* pnchars);

EXTERNXML int rtXmlpDecDynUTF8Str (OSCTXT* pctxt, const OSUTF8CHAR** outdata);

EXTERNXML int rtXmlpDecGDay (OSCTXT* pctxt, OSXSDDateTime* pvalue);

EXTERNXML int rtXmlpDecGMonth (OSCTXT* pctxt, OSXSDDateTime* pvalue);

EXTERNXML int rtXmlpDecGMonthDay (OSCTXT* pctxt, OSXSDDateTime* pvalue);

EXTERNXML int rtXmlpDecGYear (OSCTXT* pctxt, OSXSDDateTime* pvalue);

EXTERNXML int rtXmlpDecGYearMonth (OSCTXT* pctxt, OSXSDDateTime* pvalue);

EXTERNXML int rtXmlpDecHexStr 
(OSCTXT* pctxt, OSOCTET* pvalue, OSUINT32* pnocts, OSINT32 bufsize);

EXTERNXML int rtXmlpDecInt (OSCTXT* pctxt, OSINT32* pvalue);

EXTERNXML int rtXmlpDecInt8 (OSCTXT* pctxt, OSINT8* pvalue);

EXTERNXML int rtXmlpDecInt16 (OSCTXT* pctxt, OSINT16* pvalue);

EXTERNXML int rtXmlpDecInt64 (OSCTXT* pctxt, OSINT64* pvalue);
    
EXTERNXML int rtXmlpDecNamedBits 
(OSCTXT* pctxt, const OSBitMapItem* pBitMap,
 OSOCTET* pvalue, OSUINT32* pnbits, OSUINT32 bufsize);

EXTERNXML int rtXmlpDecStrList (OSCTXT* pctxt, OSRTDList* plist);

EXTERNXML int rtXmlpDecTime (OSCTXT* pctxt, OSXSDDateTime* pvalue);

EXTERNXML int rtXmlpDecUInt (OSCTXT* pctxt, OSUINT32* pvalue);

EXTERNXML int rtXmlpDecUInt8 (OSCTXT* pctxt, OSOCTET* pvalue);

EXTERNXML int rtXmlpDecUInt16 (OSCTXT* pctxt, OSUINT16* pvalue);

EXTERNXML int rtXmlpDecUInt64 (OSCTXT* pctxt, OSUINT64* pvalue);
    
EXTERNXML int rtXmlpDecXmlStr (OSCTXT* pctxt, OSXMLSTRING* outdata);

EXTERNXML int rtXmlpDecXSIAttr 
(OSCTXT* pctxt, const OSXMLNameFragments* attrName);

EXTERNXML int rtXmlpDecXSITypeAttr 
(OSCTXT* pctxt, const OSXMLNameFragments* attrName, 
 const OSUTF8CHAR** ppAttrValue);

EXTERNXML int rtXmlpGetAttributeID 
(OSCTXT* pctxt, const OSXMLStrFragment* attrName, OSINT16 nsidx, 
 size_t nAttr, const OSXMLAttrDescr attrNames[], OSUINT32 attrPresent[]);

EXTERNXML int rtXmlpGetNextElem 
(OSCTXT* pctxt, OSXMLElemDescr* pElem, OSINT32 level);

EXTERNXML int rtXmlpGetNextElemID 
(OSCTXT* pctxt, const OSXMLElemIDRec* tab, size_t nrows, OSINT32 level, 
 OSBOOL continueParse);

EXTERNXML OSBOOL rtXmlpIsInGroup 
   (int elemID, int grpId, const OSBOOL* grpTab, int nElems);

EXTERNXML int rtXmlpMarkLastEventActive (OSCTXT* pctxt);

EXTERNXML int rtXmlpMatchStartTag 
   (OSCTXT* pctxt, const OSUTF8CHAR* elemLocalName, OSINT16 nsidx);

EXTERNXML int rtXmlpMatchEndTag (OSCTXT* pctxt, OSINT32 level);

EXTERNXML OSBOOL rtXmlpMatchElemId (OSCTXT* pctxt, int elemID, int matchingID);

EXTERNXML OSBOOL rtXmlpHasAttributes (OSCTXT* pctxt);

EXTERNXML int rtXmlpGetAttributeCount (OSCTXT* pctxt);

EXTERNXML void rtXmlpGetContent (OSCTXT* pctxt, int level);

EXTERNXML int rtXmlpSelectAttribute 
(OSCTXT* pctxt, OSXMLNameFragments* pAttr,  OSINT16* nsidx, size_t index);

EXTERNXML int rtXmlpCreateReader (OSCTXT* pctxt);

EXTERNXML OSINT32 rtXmlpGetCurrentLevel (OSCTXT* pctxt);

typedef enum {
   OSXMLWSM_PRESERVE = 0,
   OSXMLWSM_REPLACE,
   OSXMLWSM_COLLAPSE
} OSXMLWhiteSpaceMode;

EXTERNXML void rtXmlpSetWhiteSpaceMode 
   (OSCTXT* pctxt, OSXMLWhiteSpaceMode whiteSpaceMode);

EXTERNXML void rtXmlpSetMixedContentMode 
   (OSCTXT* pctxt, OSBOOL mixedContentMode);

EXTERNXML OSBOOL rtXmlpIsContentMode (OSCTXT* pctxt); 

EXTERNXML void rtXmlpSetListMode (OSCTXT* pctxt);
EXTERNXML OSBOOL rtXmlpListHasItem (OSCTXT* pctxt);
EXTERNXML void rtXmlpCountListItems (OSCTXT* pctxt, OSUINT32* itemCnt);

EXTERNXML int rtXmlpGetNextSeqElemID 
(OSCTXT* pctxt, const OSXMLElemIDRec* tab, const OSXMLGroupDesc* ppGroup, 
 int curID, int lastMandatoryID);

EXTERNXML int rt