rtxContext.h

Go to the documentation of this file.
00001 /*
00002  * Copyright (c) 2003-2009 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  *****************************************************************************/
00028 #ifndef _RTXCONTEXT_H_
00029 #define _RTXCONTEXT_H_
00030 
00031 #include "rtxsrc/rtxDList.h"
00032 
00033 #define OSRTENCBUFSIZ 16*1024    /* dynamic encode buffer extent size     */
00034 
00039 /* run-time error info structures */
00040 
00041 #define OSRTERRSTKSIZ   8       /* error stack size                     */
00042 #define OSRTMAXERRPRM   5       /* maximum error parameters             */
00043 
00051 typedef struct {
00052    const OSUTF8CHAR* module;
00053    OSINT32      lineno;
00054 } OSRTErrLocn;
00055 
00066 typedef struct {
00067    OSRTErrLocn  stack[OSRTERRSTKSIZ];
00068    OSINT16      status;
00069    OSUINT8      stkx;
00070    OSUINT8      parmcnt;
00071    OSUTF8CHAR*  parms[OSRTMAXERRPRM];
00072    OSUTF8CHAR*  elemName;
00073 } OSRTErrInfo;
00074 
00075 typedef struct {
00076    OSRTDList list;              /* list of errors */
00077    OSRTErrInfo reserved;        /* error info elem, used if nomem to alloc */
00078    OSRTDListNode reservedNode;  /* node placeholder for errInfo elem       */
00079 } OSRTErrInfoList;
00080 
00089 typedef struct {
00090    OSOCTET*     data;           /* pointer to start of data buffer      */
00091    size_t       byteIndex;      /* byte index                           */
00092    size_t       size;           /* current buffer size                  */
00093    OSINT16      bitOffset;      /* current bit offset (8 - 1)           */
00094    OSBOOL       dynamic;        /* is buffer dynamic?                   */
00095    OSBOOL       aligned;        /* is buffer byte aligned?              */
00096 } OSRTBuffer;
00097 
00098 typedef OSUINT32 OSRTFLAGS;
00099 
00106 typedef struct {
00107    size_t      byteIndex;      /* byte index                           */
00108    OSINT16     bitOffset;      /* current bit offset (8 - 1)           */
00109    OSRTFLAGS   flags;          /* flag bits                            */
00110 } OSRTBufSave;
00111 
00112 /* OSRTCTXT flag mask values : bits 32 - 16 are for common flags, bits  */
00113 /* 15 - 0 are reserved for application specific flags                   */
00114 
00115 #define OSDIAG          0x80000000  /* diagnostic tracing enabled       */
00116 #define OSTRACE         0x40000000  /* tracing enabled                  */
00117 #define OSDISSTRM       0x20000000  /* disable stream encode/decode     */
00118 #define OSSAVEBUF       0x10000000  /* do not free dynamic encode buffer */
00119 #define OSNOSTRMBACKOFF 0x8000000   /* stream mark/reset funcs is not used */
00120 
00121 struct OSCTXT;
00122 /*
00123  * OSRTFreeCtxtAppInfoPtr is a pointer to pctxt->pAppInfo free function,
00124  * The pctxt->pAppInfo (pXMLInfo and pASN1Info) should contain the pointer 
00125  * to a structure and its first member should be a pointer to an appInfo 
00126  * free function. 
00127  */
00128 typedef int (*OSFreeCtxtAppInfoPtr)(struct OSCTXT* pctxt);
00129 
00130 /*
00131  * OSRTResetCtxtAppInfoPtr is a pointer to pctxt->pAppInfo reset function,
00132  * The pctxt->pAppInfo (pXMLInfo and pASN1Info) should contain the pointer 
00133  * to a structure and its second member should be a pointer to appInfo reset 
00134  * function.
00135  */
00136 typedef int (*OSResetCtxtAppInfoPtr)(struct OSCTXT* pctxt);
00137 
00138 /*
00139  * OSRTFreeCtxtGlobalPtr is a pointer to a memory free function. 
00140  * This type describes the custom global memory free function generated by 
00141  * the compiler to free global nmemory.  A pointer to a function of this 
00142  * type may be stored in the context gblFreeFunc field in order to free 
00143  * global data (pGlobalData) when rtxFreeContext is called.
00144  */
00145 typedef void (*OSFreeCtxtGlobalPtr)(struct OSCTXT* pctxt);
00146 
00147 /* Alias for __cdecl modifier; if __cdecl keyword is not supported, 
00148  * redefine it as empty macro. */
00149 
00150 #if !defined(OSCDECL)
00151 #if defined(_MSC_VER) || defined(__BORLANDC__)
00152 #define OSCDECL __cdecl
00153 #else
00154 #define OSCDECL
00155 #endif
00156 #endif /* OSCDECL */
00157 
00158 /* Memory alloc, realloc, and free function pointer definitions */
00159 typedef void *(OSCDECL *OSMallocFunc ) (size_t size);
00160 typedef void *(OSCDECL *OSReallocFunc) (void *ptr, size_t size);
00161 typedef void  (OSCDECL *OSFreeFunc   ) (void *ptr);
00162 
00170 typedef struct OSCTXT {          /* run-time context block               */
00171    void*         pMemHeap;       /* internal message memory heap         */
00172    OSRTBuffer    buffer;         /* data buffer                          */
00173    OSRTBufSave   savedInfo;      /* saved buffer info                    */
00174    OSRTErrInfoList errInfo;      /* run-time error info                  */
00175    OSUINT32      initCode;       /* code double word to indicate init    */
00176    OSRTFLAGS     flags;          /* flag bits                            */
00177    OSOCTET       level;          /* nesting level                        */
00178    OSOCTET       state;          /* encode/decode process state          */
00179    OSOCTET       diagLevel;      /* diagnostic trace level               */
00180    OSOCTET       spare[1];       /* word boundary padding                */
00181    struct OSRTSTREAM* pStream;   /* Stream                               */
00182    struct OSRTPrintStream *pPrintStrm; /* Print Stream                   */
00183    OSRTDList elemNameStack;      /* element name stack                   */
00184    OSRTDList regExpCache;        /* compiled regular expression cache    */
00185    const OSOCTET* key;           /* pointer to run-time key data         */
00186    size_t        keylen;         /* run-time key length                  */
00187    OSVoidPtr     pXMLInfo;       /* XML specific info                    */
00188    OSVoidPtr     pASN1Info;      /* ASN.1 specific info                  */
00189    OSVoidPtr     pEXIInfo;       /* EXI specific info                    */
00190    OSVoidPtr     pUserData;      /* User defined data                    */
00191    OSVoidPtr     pGlobalData;    /* Global constant data                 */
00192    OSFreeCtxtGlobalPtr gblFreeFunc; /* Global free function              */
00193 } OSCTXT;
00194 
00195 #define OSRT_GET_FIRST_ERROR_INFO(pctxt) \
00196 (((pctxt)->errInfo.list.head == 0) ? (OSRTErrInfo*)0 : \
00197 (OSRTErrInfo*)((pctxt)->errInfo.list.head->data))
00198 
00199 #define OSRT_GET_LAST_ERROR_INFO(pctxt) \
00200 (((pctxt)->errInfo.list.tail == 0) ? (OSRTErrInfo*)0 : \
00201 (OSRTErrInfo*)((pctxt)->errInfo.list.tail->data))
00202 
00206 #define OSRTISSTREAM(pctxt) \
00207 ((pctxt)->pStream != 0 && !((pctxt)->flags & OSDISSTRM))
00208 
00209 #define OSRTBUFSAVE(pctxt) { \
00210 (pctxt)->savedInfo.byteIndex = (pctxt)->buffer.byteIndex; \
00211 (pctxt)->savedInfo.flags = (pctxt)->flags; }
00212 
00213 #define OSRTBUFRESTORE(pctxt) { \
00214 (pctxt)->buffer.byteIndex = (pctxt)->savedInfo.byteIndex; \
00215 (pctxt)->flags = (pctxt)->savedInfo.flags; }
00216 
00217 #ifdef __cplusplus
00218 extern "C" {
00219 #endif
00220 
00247 EXTERNRT int rtxInitContextUsingKey
00248 (OSCTXT* pctxt, const OSOCTET* key, size_t keylen);
00249 
00250 #define rtxInitContextUsingKeyExt
00251 
00263 #ifndef rtxInitContext
00264 EXTERNRT int rtxInitContext (OSCTXT* pctxt);
00265 #endif
00266 
00281 EXTERNRT int rtxInitContextExt (OSCTXT* pctxt,
00282                                 OSMallocFunc malloc_func,
00283                                 OSReallocFunc realloc_func,
00284                                 OSFreeFunc free_func);
00285 
00306 EXTERNRT int rtxInitThreadContext (OSCTXT* pctxt, const OSCTXT* pSrcCtxt);
00307 
00326 EXTERNRT int rtxInitContextBuffer 
00327 (OSCTXT* pctxt, OSOCTET* bufaddr, size_t bufsiz);
00328 
00352 EXTERNRT int rtxCtxtSetBufPtr 
00353 (OSCTXT* pctxt, OSOCTET* bufaddr, size_t bufsiz);
00354 
00366 #define rtxCtxtGetMsgPtr(pctxt) (pctxt)->buffer.data
00367 
00377 #define rtxCtxtGetMsgLen(pctxt) (pctxt)->buffer.byteIndex
00378 
00386 EXTERNRT size_t rtxCtxtGetIOByteCount (OSCTXT* pctxt);
00387 
00397 EXTERNRT int rtxCheckContext (OSCTXT* pctxt);
00398 
00406 EXTERNRT void rtxFreeContext (OSCTXT* pctxt);
00407 
00408 /*
00409  * This function creates a copy of a context structure. The copy is a "shallow
00410  * copy" (i.e. new copies of dynamic memory blocks held within the context are
00411  * not made, only the pointers are transferred to the new context structure).
00412  * This function is mainly for use from within compiler-generated code.
00413  *
00414  * @param pdest        - Context structure to which data is to be copied.
00415  * @param psrc         - Context structure from which data is to be copied.
00416  */
00417 EXTERNRT void rtxCopyContext (OSCTXT* pdest, OSCTXT* psrc);
00418 
00425 EXTERNRT void rtxCtxtSetFlag (OSCTXT* pctxt, OSUINT32 mask);
00426 
00434 EXTERNRT void rtxCtxtClearFlag (OSCTXT* pctxt, OSUINT32 mask);
00435 
00442 #define rtxCtxtTestFlag(pctxt,mask) ((pctxt->flags & mask) != 0)
00443 
00456 EXTERNRT int rtxCtxtPushElemName (OSCTXT* pctxt, const OSUTF8CHAR* elemName);
00457 
00465 EXTERNRT const OSUTF8CHAR* rtxCtxtPopElemName (OSCTXT* pctxt);
00466 
00467 EXTERNRT int  rtxPreInitContext (OSCTXT* pctxt);
00468 #if 0
00469 EXTERNRT void rtxResetContext (OSCTXT* pctxt);
00470 #endif
00471 EXTERNRT void rtxMemFreeOpenSeqExt 
00472 (OSCTXT* pctxt, struct OSRTDList *pElemList);
00473 
00474 /*
00475  * This function sets flags to a heap. May be used to control the heap's
00476  * behavior.
00477  *
00478  * @param pctxt        Pointer to a memory block structure that contains the
00479  *                       list of dynamic memory block maintained by these
00480  *                       functions.
00481  * @param flags        The flags.
00482  */
00483 EXTERNRT void  rtxMemHeapSetFlags (OSCTXT* pctxt, OSUINT32 flags);
00484 
00485 /*
00486  * This function clears memory heap flags.
00487  *
00488  * @param pctxt        Pointer to a memory block structure that contains the
00489  *                       list of dynamic memory block maintained by these
00490  *                       functions.
00491  * @param flags        The flags
00492  */
00493 EXTERNRT void  rtxMemHeapClearFlags (OSCTXT* pctxt, OSUINT32 flags);
00494 
00495 /*
00496  * This function sets the minimum size and the granularity of memory blocks
00497  * in memory heap for the context.  
00498  *
00499  * @param pctxt        Pointer to a context block.
00500  * @param blkSize      The currently used minimum size and the granularity of
00501  *                       memory blocks.
00502  */
00503 EXTERNRT void  rtxMemHeapSetDefBlkSize (OSCTXT* pctxt, OSUINT32 blkSize);
00504 
00505 /*
00506  * This function returns the actual granularity of memory blocks in the 
00507  * context.
00508  *
00509  * @param pctxt        Pointer to a context block.
00510  */
00511 EXTERNRT OSUINT32 rtxMemHeapGetDefBlkSize (OSCTXT* pctxt);
00512 
00516 #define rtxByteAlign(pctxt) \
00517 if ((pctxt)->buffer.bitOffset != 8) { \
00518 (pctxt)->buffer.byteIndex++; (pctxt)->buffer.bitOffset = 8; }
00519 
00520 #ifdef __cplusplus
00521 }
00522 #endif
00523 
00526 #endif