rtEXIEvent.h

Go to the documentation of this file.
00001 /*
00002  * Copyright (c) 2008 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 _RTEXIEVENT_H_
00029 #define _RTEXIEVENT_H_
00030 
00031 #include "rtexisrc/rtEXIExternDefs.h"
00032 #include "rtxsrc/rtxXmlQName.h"
00033 
00034 #ifdef __cplusplus
00035 extern "C" {
00036 #endif
00037 
00045 typedef enum { SD, ED, SE, EE, AT, CH, NS, CM, PI, DT, ER } OSEXIEventType;
00046 
00047 typedef struct _OSEXIEvent {
00048     
00052    OSEXIEventType type;
00053     
00058    OSXMLFullQName* qname;
00059 
00060 } OSEXIEvent;
00061 
00062 extern const OSEXIEvent gc_SD;
00063 extern const OSEXIEvent gc_ED;
00064 extern const OSEXIEvent gc_SE;
00065 extern const OSEXIEvent gc_EE;
00066 extern const OSEXIEvent gc_AT;
00067 extern const OSEXIEvent gc_CH;
00068 extern const OSEXIEvent gc_NS;
00069 extern const OSEXIEvent gc_CM;
00070 extern const OSEXIEvent gc_PI;
00071 extern const OSEXIEvent gc_DT;
00072 extern const OSEXIEvent gc_ER;
00073 extern const OSEXIEvent gc_AT_XSITYPE;
00074 extern const OSEXIEvent gc_AT_XSINIL;
00075 
00084 EXTERNEXI void rtEXIEventInit 
00085 (OSCTXT* pctxt, OSEXIEvent* pEvent, OSEXIEventType type, 
00086  const OSXMLFullQName* qname);
00087 
00097 EXTERNEXI OSEXIEvent* rtEXINewEvent 
00098 (OSCTXT* pctxt, OSEXIEventType type, const OSXMLFullQName* qname);
00099 
00110 EXTERNEXI OSEXIEvent* rtEXINewEventDeepCopy 
00111 (OSCTXT* pctxt, const OSEXIEvent* pEvent);
00112 
00121 EXTERNEXI void rtEXIEventDeepCopy 
00122 (OSCTXT* pctxt, OSEXIEvent* pdest, const OSEXIEvent* psrc);
00123 
00132 EXTERNEXI void rtEXIEventFreeMem 
00133 (OSCTXT* pctxt, OSEXIEvent* pEvent, OSBOOL dynamic);
00134 
00141 EXTERNEXI OSUINT32 rtEXIEventHash (const OSEXIEvent* pEvent);
00142 
00150 EXTERNEXI OSBOOL rtEXIEventsEqual 
00151 (const OSEXIEvent* pEvent1, const OSEXIEvent* pEvent2);
00152 
00161 EXTERNEXI const OSEXIEvent* rtEXIGetBaseEvent (const OSEXIEvent* pEvent);
00162 
00171 EXTERNEXI const char* rtEXIEventTypeToString (OSEXIEventType type);
00172 
00182 EXTERNEXI OSUTF8CHAR* rtEXIEventToString 
00183 (OSCTXT* pctxt, const OSEXIEvent* pEvent);
00184 
00190 EXTERNEXI void rtEXIEventPrint (const OSEXIEvent* pEvent);
00191 
00192 #ifdef __cplusplus
00193 }
00194 #endif
00195 
00196 #endif