Site Map | Careers | Contact Us

• PRODUCTS
• SUPPORT
• RESOURCES

• PARTNERS
• CUSTOMERS
• ABOUT US

Home > Support > Documentation

rtxContext.h

Go to the documentation of this file.

/*
 * Copyright (c) 2003-2008 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 _RTXCONTEXT_H_
#define _RTXCONTEXT_H_

#include "rtxsrc/rtxDList.h"

#define OSRTENCBUFSIZ 16*1024    /* dynamic encode buffer extent size     */

/* run-time error info structures */

#define OSRTERRSTKSIZ   8       /* error stack size                     */
#define OSRTMAXERRPRM   5       /* maximum error parameters             */

typedef struct {
   const OSUTF8CHAR* module;
   OSINT32      lineno;
} OSRTErrLocn;

typedef struct {
   OSRTErrLocn  stack[OSRTERRSTKSIZ];
   OSINT16      status;
   OSUINT8      stkx;
   OSUINT8      parmcnt;
   OSUTF8CHAR*  parms[OSRTMAXERRPRM];
   OSUTF8CHAR*  elemName;
} OSRTErrInfo;

typedef struct {
   OSRTDList list;              /* list of errors */
   OSRTErrInfo reserved;        /* error info elem, used if nomem to alloc */
   OSRTDListNode reservedNode;  /* node placeholder for errInfo elem       */
} OSRTErrInfoList;

typedef struct {
   OSOCTET*     data;           /* pointer to start of data buffer      */
   size_t       byteIndex;      /* byte index                           */
   size_t       size;           /* current buffer size                  */
   OSINT16      bitOffset;      /* current bit offset (8 - 1)           */
   OSBOOL       dynamic;        /* is buffer dynamic?                   */
   OSBOOL       aligned;        /* is buffer byte aligned?              */
} OSRTBuffer;

typedef OSUINT32 OSRTFLAGS;

typedef struct {
   size_t      byteIndex;      /* byte index                           */
   OSINT16     bitOffset;      /* current bit offset (8 - 1)           */
   OSRTFLAGS   flags;          /* flag bits                            */
} OSRTBufSave;

/* OSRTCTXT flag mask values : bits 32 - 16 are for common flags, bits  */
/* 15 - 0 are reserved for application specific flags                   */

#define OSDIAG          0x80000000  /* diagnostic tracing enabled       */
#define OSTRACE         0x40000000  /* tracing enabled                  */
#define OSDISSTRM       0x20000000  /* disable stream encode/decode     */
#define OSSAVEBUF       0x10000000  /* do not free dynamic encode buffer */
#define OSNOSTRMBACKOFF 0x8000000   /* stream mark/reset funcs is not used */

typedef struct OSCTXT {          /* run-time context block               */
   void*         pMemHeap;       /* internal message memory heap         */
   OSRTBuffer    buffer;         /* data buffer                          */
   OSRTBufSave   savedInfo;      /* saved buffer info                    */
   OSRTErrInfoList errInfo;      /* run-time error info                  */
   OSUINT32      initCode;       /* code double word to indicate init    */
   OSRTFLAGS     flags;          /* flag bits                            */
   OSOCTET       level;          /* nesting level                        */
   OSOCTET       state;          /* encode/decode process state          */
   OSOCTET       diagLevel;      /* diagnostic trace level               */
   OSOCTET       spare[1];       /* word boundary padding                */
   struct OSRTSTREAM* pStream;   /* Stream                               */
   struct OSRTPrintStream *pPrintStrm; /* Print Stream                   */
   OSRTDList elemNameStack;      /* element name stack                   */
   OSRTDList regExpCache;        /* compiled regular expression cache    */
   const OSOCTET* key;           /* pointer to run-time key data         */
   size_t        keylen;         /* run-time key length                  */
   OSVoidPtr     pXMLInfo;       /* XML specific info                    */
   OSVoidPtr     pASN1Info;      /* ASN.1 specific info                  */
   OSVoidPtr     pEXIInfo;       /* EXI specific info                    */
   OSVoidPtr     pUserData;      /* User defined data                    */
} OSCTXT;

#define OSRT_GET_FIRST_ERROR_INFO(pctxt) \
(((pctxt)->errInfo.list.head == 0) ? (OSRTErrInfo*)0 : \
(OSRTErrInfo*)((pctxt)->errInfo.list.head->data))

#define OSRT_GET_LAST_ERROR_INFO(pctxt) \
(((pctxt)->errInfo.list.tail == 0) ? (OSRTErrInfo*)0 : \
(OSRTErrInfo*)((pctxt)->errInfo.list.tail->data))

/*
 * OSRTFreeCtxtAppInfoPtr is a pointer to pctxt->pAppInfo free function,
 * The pctxt->pAppInfo (pXMLInfo and pASN1Info) should contain the pointer 
 * to a structure and its first member should be a pointer to an appInfo 
 * free function. 
 */
typedef int (*OSFreeCtxtAppInfoPtr)(OSCTXT* pctxt);

/*
 * OSRTResetCtxtAppInfoPtr is a pointer to pctxt->pAppInfo reset function,
 * The pctxt->pAppInfo (pXMLInfo and pASN1Info) should contain the pointer 
 * to a structure and its second member should be a pointer to appInfo reset 
 * function.
 */
typedef int (*OSResetCtxtAppInfoPtr)(OSCTXT* pctxt);

#define OSRTISSTREAM(pctxt) \
((pctxt)->pStream != 0 && !((pctxt)->flags & OSDISSTRM))

#define OSRTBUFSAVE(pctxt) { \
(pctxt)->savedInfo.byteIndex = (pctxt)->buffer.byteIndex; \
(pctxt)->savedInfo.flags = (pctxt)->flags; }

#define OSRTBUFRESTORE(pctxt) { \
(pctxt)->buffer.byteIndex = (pctxt)->savedInfo.byteIndex; \
(pctxt)->flags = (pctxt)->savedInfo.flags; }

#ifdef __cplusplus
extern "C" {
#endif

EXTERNRT int rtxInitContext (OSCTXT* pctxt);

EXTERNRT int rtxInitContextBuffer (OSCTXT* pctxt, 
                                    OSOCTET* bufaddr, 
                                    size_t bufsiz);

EXTERNRT int rtxCtxtSetBufPtr 
(OSCTXT* pctxt, OSOCTET* bufaddr, size_t bufsiz);

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

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

EXTERNRT int rtxCheckContext (OSCTXT* pctxt);

EXTERNRT void rtxFreeContext (OSCTXT* pctxt);

/*
 * This function creates a copy of a context structure. The copy is a "shallow
 * copy" (i.e. new copies of dynamic memory blocks held within the context are
 * not made, only the pointers are transferred to the new context structure).
 * This function is mainly for use from within compiler-generated code.
 *
 * @param pdest        - Context structure to which data is to be copied.
 * @param psrc         - Context structure from which data is to be copied.
 */
EXTERNRT void rtxCopyContext (OSCTXT* pdest, OSCTXT* psrc);

EXTERNRT void rtxCtxtSetFlag (OSCTXT* pctxt, OSUINT32 mask);

EXTERNRT void rtxCtxtClearFlag (OSCTXT* pctxt, OSUINT32 mask);

#define rtxCtxtTestFlag(pctxt,mask) ((pctxt->flags & mask) != 0)

EXTERNRT int  rtxPreInitContext (OSCTXT* pctxt);
#if 0
EXTERNRT void rtxResetContext (OSCTXT* pctxt);
#endif
EXTERNRT void rtxMemFreeOpenSeqExt 
(OSCTXT* pctxt, struct OSRTDList *pElemList);

/*
 * This function sets flags to a heap. May be used to control the heap's
 * behavior.
 *
 * @param pctxt        Pointer to a memory block structure that contains the
 *                       list of dynamic memory block maintained by these
 *                       functions.
 * @param flags        The flags.
 */
EXTERNRT void  rtxMemHeapSetFlags (OSCTXT* pctxt, OSUINT32 flags);

/*
 * This function clears memory heap flags.
 *
 * @param pctxt        Pointer to a memory block structure that contains the
 *                       list of dynamic memory block maintained by these
 *                       functions.
 * @param flags        The flags
 */
EXTERNRT void  rtxMemHeapClearFlags (OSCTXT* pctxt, OSUINT32 flags);

/*
 * This function sets the minimum size and the granularity of memory blocks
 * in memory heap for the context.  
 *
 * @param pctxt        Pointer to a context block.
 * @param blkSize      The currently used minimum size and the granularity of
 *                       memory blocks.
 */
EXTERNRT void  rtxMemHeapSetDefBlkSize (OSCTXT* pctxt, OSUINT32 blkSize);

/*
 * This function returns the actual granularity of memory blocks in the 
 * context.
 *
 * @param pctxt        Pointer to a context block.
 */
EXTERNRT OSUINT32 rtxMemHeapGetDefBlkSize (OSCTXT* pctxt);


#ifdef __cplusplus
}
#endif

#endif

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