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  *****************************************************************************/
00031 #ifndef _RTEXIEVENT_H_
00032 #define _RTEXIEVENT_H_
00033 
00034 #include "rtexisrc/rtEXIExternDefs.h"
00035 #include "rtxsrc/rtxXmlQName.h"
00036 
00037 #ifdef __cplusplus
00038 extern "C" {
00039 #endif
00040 
00048 typedef enum { SD, ED, SE, EE, AT, CH, NS, CM, PI, DT, ER } OSEXIEventType;
00049 
00050 typedef struct _OSEXIEvent {
00051     
00055    OSEXIEventType type;
00056     
00061    OSXMLFullQName* qname;
00062 
00063 } OSEXIEvent;
00064 
00065 extern const OSEXIEvent gc_SD;
00066 extern const OSEXIEvent gc_ED;
00067 extern const OSEXIEvent gc_SE;
00068 extern const OSEXIEvent gc_EE;
00069 extern const OSEXIEvent gc_AT;
00070 extern const OSEXIEvent gc_CH;
00071 extern const OSEXIEvent gc_NS;
00072 extern const OSEXIEvent gc_CM;
00073 extern const OSEXIEvent gc_PI;
00074 extern const OSEXIEvent gc_DT;
00075 extern const OSEXIEvent gc_ER;
00076 
00085 EXTERNEXI void rtEXIEventInit 
00086 (OSCTXT* pctxt, OSEXIEvent* pEvent, OSEXIEventType type, 
00087  const OSXMLFullQName* qname);
00088 
00098 EXTERNEXI OSEXIEvent* rtEXINewEvent 
00099 (OSCTXT* pctxt, OSEXIEventType type, const OSXMLFullQName* qname);
00100 
00111 EXTERNEXI OSEXIEvent* rtEXINewEventDeepCopy 
00112 (OSCTXT* pctxt, const OSEXIEvent* pEvent);
00113 
00122 EXTERNRT void rtEXIEventDeepCopy 
00123 (OSCTXT* pctxt, OSEXIEvent* pdest, const OSEXIEvent* psrc);
00124 
00133 EXTERNRT void rtEXIEventFreeMem 
00134 (OSCTXT* pctxt, OSEXIEvent* pEvent, OSBOOL dynamic);
00135 
00142 EXTERNEXI OSUINT32 rtEXIEventHash (const OSEXIEvent* pEvent);
00143 
00151 EXTERNEXI OSBOOL rtEXIEventsEqual 
00152 (const OSEXIEvent* pEvent1, const OSEXIEvent* pEvent2);
00153 
00162 EXTERNEXI const OSEXIEvent* rtEXIGetBaseEvent (const OSEXIEvent* pEvent);
00163 
00172 EXTERNEXI const char* rtEXIEventTypeToString (OSEXIEventType type);
00173 
00183 EXTERNEXI OSUTF8CHAR* rtEXIEventToString 
00184 (OSCTXT* pctxt, const OSEXIEvent* pEvent);
00185 
00191 EXTERNEXI void rtEXIEventPrint (const OSEXIEvent* pEvent);
00192 
00193 #ifdef __cplusplus
00194 }
00195 #endif
00196 
00199 #endif