Site Map | Careers | Contact Us

• PRODUCTS
• SUPPORT
• RESOURCES

• PARTNERS
• CUSTOMERS
• ABOUT US

Home > Support > Documentation

rtXmlPull.h

/*
 * Copyright (C) 2003-2007 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 __RTXMLPULL_H
#define __RTXMLPULL_H

#include "rtxsrc/rtxCtype.h"
#include "rtxsrc/rtxStream.h"
#include "rtxsrc/rtxStreamBuffered.h"
#include "rtxsrc/rtxErrCodes.h"
#include "rtxsrc/rtxStreamDirectBuf.hh"
#include "rtxmlsrc/osrtxml.h"

/* _PULL_FROM_BUFFER - if defined, parser pull data from context buffer */
/* #define _PULL_FROM_BUFFER */

#define MAX_DELAYED_TASK_SIZE 10

/* default buffer size for qName in ElementName */
#define OSXML_DEFAULT_QNAME_BUF_SIZE 10

#define OSXMLEVT_NONE 0
#define OSXMLEVT_INITIAL OSXMLEVT_NONE
#define OSXMLEVT_START_DOCUMENT 0x1
#define OSXMLEVT_START_TAG 0x2
#define OSXMLEVT_TEXT 0x4
#define OSXMLEVT_END_TAG 0x8
#define OSXMLEVT_END_DOCUMENT 0x10
#define OSXMLEVT_COMMENT 0x20
#define OSXMLEVT_PI 0x40
#define OSXMLEVT_DTD 0x40

#define OSXMLEVT_USED_FLAG 0x80000000u
#define OSXMLEVT_ID_MASK (~OSXMLEVT_USED_FLAG)
#define OSXMLEVT_ALL_MASK  OSXMLEVT_ID_MASK

#define XMLPREADER(pctxt) ((OSXMLCtxtInfo*) pctxt->pXMLInfo)->pXmlPPReader

typedef enum {
   OSXMLS_HEADER = -1,
   OSXMLS_COMMENT = -2,
   OSXMLS_START_ELEMENT = -3,
   OSXMLS_DTD = -4,
   OSXMLS_CONTENT = -5,
   OSXMLS_PI = -6,
   OSXMLS_END_ELEMENT = -7,
   OSXMLS_CDATA = -8,

   OSXMLS_LAST = -9
} OSXMLStates;

typedef enum {
   OSXMLSI_HEADER = -OSXMLS_HEADER-1,
   OSXMLSI_COMMENT = -OSXMLS_COMMENT-1,
   OSXMLSI_START_ELEMENT = -OSXMLS_START_ELEMENT-1,
   OSXMLSI_DTD = -OSXMLS_DTD-1,
   OSXMLSI_CONTENT = -OSXMLS_CONTENT-1,
   OSXMLSI_PI = -OSXMLS_PI-1,
   OSXMLSI_END_ELEMENT = -OSXMLS_END_ELEMENT-1,
   OSXMLSI_CDATA = -OSXMLS_CDATA-1,
   
   OSXMLSI_LAST = -OSXMLS_LAST-1
} OSXMLStatesIndex;

typedef enum {
   OSXMLDM_NONE = 0,
   OSXMLDM_SIMULATED,
   OSXMLDM_CONTENT
} OSXMLDataMode;

typedef enum {
   OSXMLNSI_UNQUALIFIED = 0,
   OSXMLNSI_UNKNOWN = -1,
   OSXMLNSI_UNCHECKED = -2,
   OSXMLNSI_XSI = -3,
   OSXMLNSI_XMLNS = -4,
   OSXMLNSI_XML = -5,
   OSXMLNSI_SOAP_ENVELOPE = -6,
   OSXMLNSI_XSD = -7
} OSXMLNsIndex;

typedef struct {
   size_t offset;
   size_t length;
} OSXMLStrFragOffset;

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

   OSUTF8CHAR           mBuffer[OSXML_DEFAULT_QNAME_BUF_SIZE];
} OSXMLElementName;

typedef struct OSXMLEvent {
   OSUINT32 mId;
   OSINT32 mLevel;
} OSXMLEvent;

typedef struct OSXMLDataCtxt {
   OSINT32 mDataLevel;
   OSXMLDataMode mDataMode;

   /* output */
   int mnChunk;
   OSBOOL mbLastChunk;
   OSBOOL mbCDATA;
   OSXMLStrFragment mData;

   /* for attr only */
   OSXMLStrFragment mSrcData;
   size_t           mSrcDataOffset;
   OSBOOL           mbInsTokenSeparator;
} OSXMLDataCtxt;

typedef struct {
   OSXMLStrFragOffset   mQName;
   OSXMLStrFragOffset   mLocalName;
   OSXMLStrFragOffset   mPrefix;
} OSXMLElemNameOffset;

typedef struct OSXMLStack {
   void*                mpStackArray; /* units specified in params */
   size_t               mSize;        /* allocated size in units */
   size_t               mUnitSize;    /* size of the unit, in octets */
   size_t               mCount;       /* number of used items    */
   OSBOOL               mbDynamic;    /* is dynamic memory allowed */
} OSXMLStack;

typedef struct OSXMLRewindPos {
   size_t      mPos;
   OSXMLEvent  mEvent;
   OSXMLStrFragment mData;
   OSBOOL      mbListMode; 
   OSBOOL      mbLastChunk;
} OSXMLRewindPos;

typedef struct OSXMLReader {
   /* input */
   OSCTXT*              mpCtxt;
   OSBOOL               mbNoTransform; 
   OSBOOL               mbWSOnlyContext;
   OSBOOL               mbMixedContext; 
   OSBOOL               mbListMode; 
   OSBOOL               mbSkipPullListElem; 
   OSXMLWhiteSpaceMode  mWhiteSpaceMode;
   OSXMLWhiteSpaceMode  mStringWhiteSpaceMode;

   /* output */
   OSXMLEvent           mLastEvent;

   OSXMLElemNameOffset  mElementName;
   OSBOOL               mbHasAttributes;
   OSBOOL               mbEmptyElement;

   OSXMLStack           mAttributes; /* contains OSXMLAttrOffset */

   OSXMLStrFragment     mCharacters;
   OSXMLStrFragment     mData;
   OSBOOL               mbLastChunk;
   OSBOOL               mbCDATA;
   OSINT32              mLevel;
   OSINT32              mDecodeLevel;
   OSUINT32             mLine;
   OSUINT32             mColumn;

   int                  mError;
   
   OSINT16              mElementNsIndex;

   /* internals */
   int mState, mPrevState, mNewState;
   int mLocalStates [OSXMLSI_LAST];
   OSUTF8CHAR  mCharBuf[10];
   OSUTF8CHAR* mpEscapeChar;
   OSUTF8CHAR* mpChars;
   size_t      mMarkedByteIndex;
   OSXMLDataMode mDataMode;
   
   /* contains OSXMLStrFragment for start tags to test against end tags */
   OSXMLStack  mTagNamesStack; 

   /* contains namespaces (OSXMLNamespace) */
   OSXMLStack  mNamespacesStack;
#ifdef OSXMLNS12
   const OSUTF8CHAR** mNamespaceTable;
   int         mNamespacesNumber; 
   const OSUTF8CHAR** mPrevNamespaceTable;
   int         mPrevNamespacesNumber;
#else
   const char** mNamespaceTable;
   int         mNamespacesNumber; 
   const char** mPrevNamespaceTable;
   int         mPrevNamespacesNumber;
#endif

   OSOCTET     mDelayedTasks [MAX_DELAYED_TASK_SIZE];
   size_t      mDelayedTaskCount;
   size_t      mDelayedTaskIndex;

   /* transport */
   OSUTF8CHAR* mpBuffer;
   size_t      mByteIndex;
   size_t      mBufSize;
   size_t      mReadSize;
   size_t      mMarkedPos;

   size_t      mLastBlockSize;
   size_t      mLastByteIndex;

   OSBOOL      mbBackoffEnabled;
   
   OSXMLStack  mRewindPosStack;
} OSXMLReader;

#ifdef __cplusplus
extern "C" {
#endif

struct OSXMLReader* rtXmlRdCreateXmlReader (OSCTXT* pctxt);

OSXMLWhiteSpaceMode rtXmlRdSetWhiteSpaceMode 
   (struct OSXMLReader* pReader, OSXMLWhiteSpaceMode whiteSpaceMode);

long rtXmlRdFirstData (struct OSXMLReader* pReader, OSXMLDataCtxt* pDataCtxt);

long rtXmlRdNextData (struct OSXMLReader* pReader, OSXMLDataCtxt* pDataCtxt);

int rtXmlRdSkipCurrentLevel (struct OSXMLReader* pReader);

int rtXmlRdNext (struct OSXMLReader* pReader);

int rtXmlRdNextTag (struct OSXMLReader* pReader);

int rtXmlRdNextEndTag (struct OSXMLReader* pReader);

OSXMLEvent rtXmlRdGetLastEvent (struct OSXMLReader* pReader);

int rtXmlRdGetTagName (struct OSXMLReader* pReader, 
                       OSXMLStrFragment* localName, 
                       OSINT16* namespaceIndex);

int rtXmlRdGetAttributeCount (struct OSXMLReader* pReader);

int rtXmlRdGetAttributeName (struct OSXMLReader* pReader, 
                             OSXMLNameFragments* pAttr,
                             OSINT16* pNsidx, 
                             size_t index);

int rtXmlRdSelectAttribute (struct OSXMLReader* pReader, size_t index);

OSINT32 rtXmlRdGetCurrentLevel (struct OSXMLReader* pReader);

int rtXmlRdNextEvent (struct OSXMLReader* pReader, 
                      OSUINT32 eventMask, 
                      OSINT32 maxLevel, 
                      OSXMLEvent* pLastEvent);

OSXMLDataMode rtXmlRdGetDataMode (struct OSXMLReader* pReader);

int rtXmlRdMarkLastEventDone (struct OSXMLReader* pReader);

int rtXmlRdMarkLastEventActive (struct OSXMLReader* pReader);

void rtXmlRdResetXmlReader (struct OSXMLReader* pReader);

void rtXmlRdMarkPos (struct OSXMLReader* pReader);
void rtXmlRdRewindToMarkedPos (struct OSXMLReader* pReader);
void rtXmlRdResetMarkedPos (struct OSXMLReader* pReader);

int rtXmlRdGetXSITypeAttr (struct OSXMLReader* pReader, 
                           const OSUTF8CHAR** ppAttrValue, 
                           OSINT16* nsidx, size_t* pLocalOffs);

OSBOOL rtXmlRdIsEmpty (struct OSXMLReader* pReader);

#ifdef __cplusplus
}
#endif

#endif /* __RTXMLPULL_H */

©Copyright 2001-2007. Objective Systems, Inc. All Rights Reserved.