From: Kidong L. <bri...@us...> - 2004-05-24 01:34:16
|
Update of /cvsroot/syncml-ctoolkit/toolkit/src/sml/inc In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv10631/src/sml/inc Modified Files: sml.h smldef.h smldevinfdtd.h smldtd.h smlerr.h smlmetinfdtd.h Log Message: Modified comments to doxygen-readable Removed duplicated comments Index: smlerr.h =================================================================== RCS file: /cvsroot/syncml-ctoolkit/toolkit/src/sml/inc/smlerr.h,v retrieving revision 1.2 retrieving revision 1.3 diff -C2 -d -r1.2 -r1.3 *** smlerr.h 2 May 2003 22:05:06 -0000 1.2 --- smlerr.h 24 May 2004 01:33:34 -0000 1.3 *************** *** 1,13 **** ! /*************************************************************************/ ! /* module: ErrorLibrary */ ! /* */ ! /* file: smlerr.h */ ! /* target system: all */ ! /* target OS: all */ ! /* */ ! /* Description: */ ! /* Definition of the used Error Codes */ ! /*************************************************************************/ ! --- 1,10 ---- ! /** ! * @file ! * ErrorLibrary ! * ! * @target_system all ! * @target_os all ! * @description Definition of the used Error Codes ! */ *************** *** 60,132 **** ! /** * No error, success code ! **/ ! #define SML_ERR_OK 0x00 // OK ! /** * SyncML Common Error Codes ! **/ // general errors ! #define SML_ERR_UNSPECIFIC 0x10 // unspecific error ! #define SML_ERR_NOT_ENOUGH_SPACE 0x11 // not enough memory to perform this operation ! #define SML_ERR_WRONG_USAGE 0x13 // function was called in wrong context // wrong parameters ! #define SML_ERR_WRONG_PARAM 0x20 // wrong parameter ! #define SML_ERR_INVALID_SIZE 0x21 // param has an invalid size ! #define SML_ERR_INVALID_HANDLE 0x22 // if handle is invalid/unknown ! #define SML_ERR_INVALID_OPTIONS 0x23 // unkown or unallowed options ! /** * SyncML Mgr Error Codes ! **/ ! #define SML_ERR_A_MGR_ERROR 0x1001 // a template ! #define SML_ERR_MGR_INVALID_INSTANCE_INFO 0x1002 // a invalid Instance Info structure is used ! #define SML_ERR_COMMAND_NOT_HANDLED 0x1003 // no callback function is available to handle this command ! #define SML_ERR_ALREADY_INITIALIZED 0x1004 // Mgr allready initialized ! /** * SyncML Xlt Error Codes ! **/ ! #define SML_ERR_XLT_MISSING_CONT 0x2001 // required field content missing ! #define SML_ERR_XLT_BUF_ERR 0x2002 // Buffer too small ! #define SML_ERR_XLT_INVAL_PCDATA_TYPE 0x2003 // Invalid (WBXML) Element Type (STR_I etc.) ! #define SML_ERR_XLT_INVAL_LIST_TYPE 0x2004 // Invalid List Type (COL_LIST etc.) ! #define SML_ERR_XLT_INVAL_TAG_TYPE 0x2005 // Invalid Tag Type (TT_BEG etc.) ! #define SML_ERR_XLT_ENC_UNK 0x2007 // Unknown Encoding (WBXML, XML) ! #define SML_ERR_XLT_INVAL_PROTO_ELEM 0x2008 // Invalid Protocol Element (ADD, Delete, ...) ! #define SML_ERR_MISSING_LIST_ELEM 0x2009 // Missing Content of List Elements ! #define SML_ERR_XLT_INCOMP_WBXML_VERS 0x200A // Incompatible WBXML Content Format Version ! #define SML_ERR_XLT_INVAL_SYNCML_DOC 0x200B // Document does not conform to SyncML DTD ! #define SML_ERR_XLT_INVAL_PCDATA 0x200C // Invalid PCData elem (e.g. not encoded as OPAQUE data) ! #define SML_ERR_XLT_TOKENIZER_ERROR 0x200D // Unspecified tokenizer error ! #define SML_ERR_XLT_INVAL_WBXML_DOC 0x200E // Document does not conform to WBXML specification ! #define SML_ERR_XLT_WBXML_UKN_TOK 0x200F // Document contains unknown WBXML token ! #define SML_ERR_XLT_MISSING_END_TAG 0x2010 // Non-empty start tag without matching end tag ! #define SML_ERR_XLT_INVALID_CODEPAGE 0x2011 // WBXML document uses unspecified code page ! #define SML_ERR_XLT_END_OF_BUFFER 0x2012 // End of buffer reached ! #define SML_ERR_XLT_INVAL_XML_DOC 0x2013 // Document does not conform to XML 1.0 specification ! #define SML_ERR_XLT_XML_UKN_TAG 0x2014 // Document contains unknown XML tag ! #define SML_ERR_XLT_INVAL_PUB_IDENT 0x2015 // Invalid Public Identifier ! #define SML_ERR_XLT_INVAL_EXT 0x2016 // Invalid Codepage Extension ! #define SML_ERR_XLT_NO_MATCHING_CODEPAGE 0x2017 // No matching Codepage could be found ! #define SML_ERR_XLT_INVAL_INPUT_DATA 0x2018 // Data missing in input structure ! /** * SyncML Wsm Error Codes ! **/ ! #define SML_ERR_WSM_BUF_TABLE_FULL 0x3001 // no more empty entries in buffer table available ! /** * SyncML Util Error Codes ! **/ #define SML_ERR_A_UTI_UNKNOWN_PROTO_ELEMENT 0x7001 --- 57,129 ---- ! /* * No error, success code ! */ ! #define SML_ERR_OK 0x00 /**< OK */ ! /* * SyncML Common Error Codes ! */ // general errors ! #define SML_ERR_UNSPECIFIC 0x10 /**< unspecific error */ ! #define SML_ERR_NOT_ENOUGH_SPACE 0x11 /**< not enough memory to perform this operation */ ! #define SML_ERR_WRONG_USAGE 0x13 /**< function was called in wrong context */ // wrong parameters ! #define SML_ERR_WRONG_PARAM 0x20 /**< wrong parameter */ ! #define SML_ERR_INVALID_SIZE 0x21 /**< param has an invalid size */ ! #define SML_ERR_INVALID_HANDLE 0x22 /**< if handle is invalid/unknown */ ! #define SML_ERR_INVALID_OPTIONS 0x23 /**< unkown or unallowed options */ ! /* * SyncML Mgr Error Codes ! */ ! #define SML_ERR_A_MGR_ERROR 0x1001 /**< a template */ ! #define SML_ERR_MGR_INVALID_INSTANCE_INFO 0x1002 /**< a invalid Instance Info structure is used */ ! #define SML_ERR_COMMAND_NOT_HANDLED 0x1003 /**< no callback function is available to handle this command */ ! #define SML_ERR_ALREADY_INITIALIZED 0x1004 /**< Mgr allready initialized */ ! /* * SyncML Xlt Error Codes ! */ ! #define SML_ERR_XLT_MISSING_CONT 0x2001 /**< required field content missing */ ! #define SML_ERR_XLT_BUF_ERR 0x2002 /**< Buffer too small */ ! #define SML_ERR_XLT_INVAL_PCDATA_TYPE 0x2003 /**< Invalid (WBXML) Element Type (STR_I etc.) */ ! #define SML_ERR_XLT_INVAL_LIST_TYPE 0x2004 /**< Invalid List Type (COL_LIST etc.) */ ! #define SML_ERR_XLT_INVAL_TAG_TYPE 0x2005 /**< Invalid Tag Type (TT_BEG etc.) */ ! #define SML_ERR_XLT_ENC_UNK 0x2007 /**< Unknown Encoding (WBXML, XML) */ ! #define SML_ERR_XLT_INVAL_PROTO_ELEM 0x2008 /**< Invalid Protocol Element (ADD, Delete, ...) */ ! #define SML_ERR_MISSING_LIST_ELEM 0x2009 /**< Missing Content of List Elements */ ! #define SML_ERR_XLT_INCOMP_WBXML_VERS 0x200A /**< Incompatible WBXML Content Format Version */ ! #define SML_ERR_XLT_INVAL_SYNCML_DOC 0x200B /**< Document does not conform to SyncML DTD */ ! #define SML_ERR_XLT_INVAL_PCDATA 0x200C /**< Invalid PCData elem (e.g. not encoded as OPAQUE data) */ ! #define SML_ERR_XLT_TOKENIZER_ERROR 0x200D /**< Unspecified tokenizer error */ ! #define SML_ERR_XLT_INVAL_WBXML_DOC 0x200E /**< Document does not conform to WBXML specification */ ! #define SML_ERR_XLT_WBXML_UKN_TOK 0x200F /**< Document contains unknown WBXML token */ ! #define SML_ERR_XLT_MISSING_END_TAG 0x2010 /**< Non-empty start tag without matching end tag */ ! #define SML_ERR_XLT_INVALID_CODEPAGE 0x2011 /**< WBXML document uses unspecified code page */ ! #define SML_ERR_XLT_END_OF_BUFFER 0x2012 /**< End of buffer reached */ ! #define SML_ERR_XLT_INVAL_XML_DOC 0x2013 /**< Document does not conform to XML 1.0 specification */ ! #define SML_ERR_XLT_XML_UKN_TAG 0x2014 /**< Document contains unknown XML tag */ ! #define SML_ERR_XLT_INVAL_PUB_IDENT 0x2015 /**< Invalid Public Identifier */ ! #define SML_ERR_XLT_INVAL_EXT 0x2016 /**< Invalid Codepage Extension */ ! #define SML_ERR_XLT_NO_MATCHING_CODEPAGE 0x2017 /**< No matching Codepage could be found */ ! #define SML_ERR_XLT_INVAL_INPUT_DATA 0x2018 /**< Data missing in input structure */ ! /* * SyncML Wsm Error Codes ! */ ! #define SML_ERR_WSM_BUF_TABLE_FULL 0x3001 /**< no more empty entries in buffer table available */ ! /* * SyncML Util Error Codes ! */ #define SML_ERR_A_UTI_UNKNOWN_PROTO_ELEMENT 0x7001 *************** *** 134,136 **** #endif - --- 131,132 ---- Index: smldevinfdtd.h =================================================================== RCS file: /cvsroot/syncml-ctoolkit/toolkit/src/sml/inc/smldevinfdtd.h,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -d -r1.3 -r1.4 *** smldevinfdtd.h 14 Nov 2003 09:43:25 -0000 1.3 --- smldevinfdtd.h 24 May 2004 01:33:34 -0000 1.4 *************** *** 1,14 **** ! /*****************************************************************************/ ! /* module: SyncML Device Information DTD specific type definitions */ ! /* */ ! /* file: smldevinfdtd.h */ ! /* target system: all */ ! /* target OS: all */ ! /* */ ! /* Description: */ ! /* Definition of structures representing DevInf DTD elements */ ! /* This file reflects DevInf as specified in the document */ ! /* http://www.syncml.org/docs/syncml_devinf_v10_20001207.pdf */ ! /*****************************************************************************/ --- 1,12 ---- ! /** ! * @file ! * SyncML Device Information DTD specific type definitions ! * ! * @target_system all ! * @target_os all ! * @description Definition of structures representing DevInf DTD elements ! * This file reflects DevInf as specified in the document ! * http://www.openmobilealliance.org/tech/affiliates/syncml/syncml_devinf_v101_20010615.pdf ! */ Index: sml.h =================================================================== RCS file: /cvsroot/syncml-ctoolkit/toolkit/src/sml/inc/sml.h,v retrieving revision 1.4 retrieving revision 1.5 diff -C2 -d -r1.4 -r1.5 *** sml.h 22 Oct 2003 16:22:35 -0000 1.4 --- sml.h 24 May 2004 01:33:34 -0000 1.5 *************** *** 1,13 **** ! /*************************************************************************/ ! /* module: External SyncML API */ ! /* */ ! /* file: sml.h */ ! /* target system: all */ ! /* target OS: all */ ! /* */ ! /* Description: */ ! /* Platform independent definition of the SyncML API functions */ ! /* This is the external API exposed to applications using SyncML */ ! /*************************************************************************/ --- 1,11 ---- ! /** ! * @file ! * External SyncML API ! * ! * @target_system all ! * @target_os all ! * @description Platform independent definition of the SyncML API functions ! * This is the external API exposed to applications using SyncML ! */ *************** *** 69,77 **** #if !defined(NOWSM) || !__LINK_TOOLKIT_STATIC__ ! /** * ============================ * General SyncML Functions * ============================ ! **/ SML_API_DEF Ret_t smlInit(SmlOptionsPtr_t pOptions); SML_API_DEF Ret_t smlSetSyncMLOptions (SmlOptionsPtr_t pOptions); --- 67,75 ---- #if !defined(NOWSM) || !__LINK_TOOLKIT_STATIC__ ! /* * ============================ * General SyncML Functions * ============================ ! */ SML_API_DEF Ret_t smlInit(SmlOptionsPtr_t pOptions); SML_API_DEF Ret_t smlSetSyncMLOptions (SmlOptionsPtr_t pOptions); *************** *** 81,90 **** ! /** * ============================ * Workspace Handling Functions * ============================ ! **/ ! SML_API_DEF Ret_t smlLockReadBuffer(InstanceID_t id, MemPtr_t *pReadPosition, MemSize_t *usedSize); SML_API_DEF Ret_t smlUnlockReadBuffer(InstanceID_t id, MemSize_t processedBytes); --- 79,87 ---- ! /* * ============================ * Workspace Handling Functions * ============================ ! */ SML_API_DEF Ret_t smlLockReadBuffer(InstanceID_t id, MemPtr_t *pReadPosition, MemSize_t *usedSize); SML_API_DEF Ret_t smlUnlockReadBuffer(InstanceID_t id, MemSize_t processedBytes); *************** *** 98,106 **** ! /** * =========================================== * Protocol Element Building Functions (for Originator) * =========================================== ! **/ /* Protocol Management */ --- 95,103 ---- ! /* * =========================================== * Protocol Element Building Functions (for Originator) * =========================================== ! */ /* Protocol Management */ *************** *** 148,166 **** ! /** * ============================================ * Command Dispatching Functions (for Receiver) * ============================================ ! **/ ! SML_API_DEF Ret_t smlProcessData(InstanceID_t id, SmlProcessMode_t mode); ! /** * ==================================================== * Callback Functions to be implemented by the Receiver * ==================================================== ! **/ /* Protocol Management */ --- 145,162 ---- ! /* * ============================================ * Command Dispatching Functions (for Receiver) * ============================================ ! */ SML_API_DEF Ret_t smlProcessData(InstanceID_t id, SmlProcessMode_t mode); ! /* * ==================================================== * Callback Functions to be implemented by the Receiver * ==================================================== ! */ /* Protocol Management */ *************** *** 260,268 **** ! /** * ============================ * Instance Management Functions * ============================ ! **/ SML_API_DEF Ret_t smlInitInstance(SmlCallbacksPtr_t pCallbacks, SmlInstanceOptionsPtr_t pOptions, VoidPtr_t pUserData, InstanceID_t *pId); --- 256,264 ---- ! /* * ============================ * Instance Management Functions * ============================ ! */ SML_API_DEF Ret_t smlInitInstance(SmlCallbacksPtr_t pCallbacks, SmlInstanceOptionsPtr_t pOptions, VoidPtr_t pUserData, InstanceID_t *pId); *************** *** 280,288 **** ! /** * =================================== * Some Helper Functions and Utilities * =================================== ! **/ SML_API_DEF Ret_t smlFreeProtoElement(VoidPtr_t pProtoElement); --- 276,284 ---- ! /* * =================================== * Some Helper Functions and Utilities * =================================== ! */ SML_API_DEF Ret_t smlFreeProtoElement(VoidPtr_t pProtoElement); Index: smlmetinfdtd.h =================================================================== RCS file: /cvsroot/syncml-ctoolkit/toolkit/src/sml/inc/smlmetinfdtd.h,v retrieving revision 1.2 retrieving revision 1.3 diff -C2 -d -r1.2 -r1.3 *** smlmetinfdtd.h 2 May 2003 22:05:06 -0000 1.2 --- smlmetinfdtd.h 24 May 2004 01:33:34 -0000 1.3 *************** *** 1,16 **** ! /*****************************************************************************/ ! /* module: SyncML Meta Information DTD specific type definitions */ ! /* */ ! /* file: smlmetinfdtd.h */ ! /* target system: all */ ! /* target OS: all */ ! /* */ ! /* Description: */ ! /* Definition of structures representing MetInf DTD elements */ ! /*****************************************************************************/ /**************************************************************************/ ! /* NOTE: */ /* These definitions are based on the MetInf DTD dated from Aug, 29th, 00 */ /**************************************************************************/ --- 1,14 ---- ! /** ! * @file ! * SyncML Meta Information DTD specific type definitions ! * ! * @target_system all ! * @target_os all ! * @description Definition of structures representing MetInf DTD elements ! */ /**************************************************************************/ ! /* @note */ /* These definitions are based on the MetInf DTD dated from Aug, 29th, 00 */ /**************************************************************************/ Index: smldef.h =================================================================== RCS file: /cvsroot/syncml-ctoolkit/toolkit/src/sml/inc/smldef.h,v retrieving revision 1.4 retrieving revision 1.5 diff -C2 -d -r1.4 -r1.5 *** smldef.h 15 Apr 2004 12:06:15 -0000 1.4 --- smldef.h 24 May 2004 01:33:34 -0000 1.5 *************** *** 1,12 **** ! /*************************************************************************/ ! /* module: Type definitions for SyncML */ ! /* */ ! /* file: SMLDef.h */ ! /* target system: all */ ! /* target OS: all */ ! /* */ ! /* Description: */ ! /* Platform independent header with syncML types and definitions */ ! /*************************************************************************/ --- 1,11 ---- ! /** ! * @file ! * Type definitions for SyncML ! * ! * @target_system all ! * @target_os all ! * ! * @description Platform independent header with syncML types and definitions ! */ *************** *** 63,126 **** /** * include target/compiler specific defines/options/settings ! **/ #include <define.h> ! /** * =================================== * Common all-purpose type definitions * =================================== ! **/ ! /** * ================================== * Basic data types * ================================== ! **/ ! typedef short Short_t; // short integer, 16 Bytes ! typedef long Long_t; // long integer, 32 Bytes ! typedef char* String_t; // String pointer, ! typedef unsigned char Byte_t; // a single byte ! typedef Byte_t Boolean_t; // a boolean ! #ifndef NULL // a NULL pointer #define NULL (void*) 0 #endif ! typedef Short_t Ret_t; // Return Type of API Commands ! typedef Long_t Length_t; // System dependent string length ! typedef Short_t MemHandle_t; // Memory object Handle ! typedef unsigned char *MemPtr_t; // Memory object Pointer ! typedef void *VoidPtr_t; // Void Pointer ! typedef Long_t MemSize_t; // System dependent memory object size ! typedef unsigned char MemByte_t; // Memory element ! typedef unsigned int Flag_t; // A generic flag type. This type is used to ! // declare variables in structures wherever ! // flags are used. ! ! ! /** * ================================== * Definitions used in the SyncML API * ================================== ! **/ ! /** * Application callback function displaying output strings to the user ! **/ typedef void (*smlPrintFunc) (String_t outputString); - /** * structure describing the options and setting of this syncml process ! **/ typedef struct sml_options_s { ! smlPrintFunc defaultPrintFunc; // default application callback for displaying strings, ! MemSize_t maxWorkspaceAvailMem; // size which all workspaces in total MUST not exceed } *SmlOptionsPtr_t, SmlOptions_t; --- 62,122 ---- /** * include target/compiler specific defines/options/settings ! */ #include <define.h> ! /* * =================================== * Common all-purpose type definitions * =================================== ! */ ! /* * ================================== * Basic data types * ================================== ! */ ! typedef short Short_t; /**< short integer, 16 Bytes */ ! typedef long Long_t; /**< long integer, 32 Bytes */ ! typedef char* String_t; /**< String pointer, */ ! typedef unsigned char Byte_t; /**< a single byte */ ! typedef Byte_t Boolean_t; /**< a boolean */ ! #ifndef NULL /**< a NULL pointer */ #define NULL (void*) 0 #endif ! typedef Short_t Ret_t; /**< Return Type of API Commands */ ! typedef Long_t Length_t; /**< System dependent string length */ ! typedef Short_t MemHandle_t; /**< Memory object Handle */ ! typedef unsigned char *MemPtr_t; /**< Memory object Pointer */ ! typedef void *VoidPtr_t; /**< Void Pointer */ ! typedef Long_t MemSize_t; /**< System dependent memory object size */ ! typedef unsigned char MemByte_t; /**< Memory element */ ! typedef unsigned int Flag_t; /**< A generic flag type. This type is ! * used to declare variables in structures ! * wherever flags are used. ! */ ! /* * ================================== * Definitions used in the SyncML API * ================================== ! */ /** * Application callback function displaying output strings to the user ! */ typedef void (*smlPrintFunc) (String_t outputString); /** * structure describing the options and setting of this syncml process ! */ typedef struct sml_options_s { ! smlPrintFunc defaultPrintFunc; /**< default application callback for displaying strings, */ ! MemSize_t maxWorkspaceAvailMem; /**< size which all workspaces in total MUST not exceed */ } *SmlOptionsPtr_t, SmlOptions_t; *************** *** 128,142 **** /** * Reference of an instance ! **/ #ifdef NOWSM ! typedef void *InstanceID_t; // without wsm, instance ID is direct pointer to instance info #else ! typedef MemHandle_t InstanceID_t; // Handle, used as a unique ID of ! #endif // an synchronization instance /** * Type of used encoding ! **/ typedef enum { SML_UNDEF = 0, --- 124,140 ---- /** * Reference of an instance ! */ #ifdef NOWSM ! typedef void *InstanceID_t; /**< without wsm, instance ID is direct pointer to instance info */ #else ! typedef MemHandle_t InstanceID_t; /**< Handle, used as a unique ID of ! * an synchronization instance ! */ ! #endif /** * Type of used encoding ! */ typedef enum { SML_UNDEF = 0, *************** *** 146,152 **** ! /** %%% added luz 2003-07-31: * SyncML version ! **/ typedef enum { SML_VERS_UNDEF = 0, --- 144,151 ---- ! /** * SyncML version ! */ ! // %%% added luz 2003-07-31: typedef enum { SML_VERS_UNDEF = 0, *************** *** 158,169 **** /** * structure describing the options of an instance, ! **/ typedef struct sml_instance_options_s { ! SmlEncoding_t encoding; // Used encoding type, ! MemSize_t workspaceSize; // size of the workspace to allocate (instance buffer size if NOWSM defined) #ifndef NOWSM ! String_t workspaceName; // name of the workspace #else ! MemSize_t maxOutgoingSize; // max size of outgoing message, 0 if no restriction #endif } *SmlInstanceOptionsPtr_t, SmlInstanceOptions_t; --- 157,168 ---- /** * structure describing the options of an instance, ! */ typedef struct sml_instance_options_s { ! SmlEncoding_t encoding; /**< Used encoding type, */ ! MemSize_t workspaceSize; /**< size of the workspace to allocate (instance buffer size if NOWSM defined) */ #ifndef NOWSM ! String_t workspaceName; /**< name of the workspace */ #else ! MemSize_t maxOutgoingSize; /**< max size of outgoing message, 0 if no restriction */ #endif } *SmlInstanceOptionsPtr_t, SmlInstanceOptions_t; *************** *** 172,176 **** /** * Processing modes ! **/ typedef enum { SML_DO_NOTHING = 0, --- 171,175 ---- /** * Processing modes ! */ typedef enum { SML_DO_NOTHING = 0, *************** *** 184,188 **** /** * Requested buffer pointer position ! **/ typedef enum { SML_FIRST_DATA_ITEM = 0, --- 183,187 ---- /** * Requested buffer pointer position ! */ typedef enum { SML_FIRST_DATA_ITEM = 0, *************** *** 194,198 **** /** * SyncML Protocol Management and Command Elements (PE) ! **/ typedef enum { SML_PE_UNDEF = 0, --- 193,197 ---- /** * SyncML Protocol Management and Command Elements (PE) ! */ typedef enum { SML_PE_UNDEF = 0, Index: smldtd.h =================================================================== RCS file: /cvsroot/syncml-ctoolkit/toolkit/src/sml/inc/smldtd.h,v retrieving revision 1.2 retrieving revision 1.3 diff -C2 -d -r1.2 -r1.3 *** smldtd.h 2 May 2003 22:05:06 -0000 1.2 --- smldtd.h 24 May 2004 01:33:34 -0000 1.3 *************** *** 1,16 **** ! /*************************************************************************/ ! /* module: SyncML DTD specific type definitions */ ! /* */ ! /* file: smldtd.h */ ! /* target system: all */ ! /* target OS: all */ ! /* */ ! /* Description: */ ! /* Definition of structures representing DTD elements */ ! /*************************************************************************/ /********************************************************************/ ! /* NOTE: */ /* These definitions are based on the DTD dated from July, 7th, 00 */ /********************************************************************/ --- 1,14 ---- ! /** ! * @file ! * SyncML DTD specific type definitions ! * ! * @target_system all ! * @target_os all ! * @description Definition of structures representing DTD elements ! */ /********************************************************************/ ! /* @note */ /* These definitions are based on the DTD dated from July, 7th, 00 */ /********************************************************************/ *************** *** 77,87 **** /** * PCDATA - types of synchronization data which SyncML supports ! **/ typedef enum { SML_PCDATA_UNDEFINED = 0, ! SML_PCDATA_STRING, // String type ! SML_PCDATA_OPAQUE, // Opaque type ! SML_PCDATA_EXTENSION, // Extention type - specified by PcdataExtension_t ! SML_PCDATA_CDATA // XML CDATA type } SmlPcdataType_t; --- 75,85 ---- /** * PCDATA - types of synchronization data which SyncML supports ! */ typedef enum { SML_PCDATA_UNDEFINED = 0, ! SML_PCDATA_STRING, /**< String type */ ! SML_PCDATA_OPAQUE, /**< Opaque type */ ! SML_PCDATA_EXTENSION, /**< Extention type - specified by PcdataExtension_t */ ! SML_PCDATA_CDATA /**< XML CDATA type */ } SmlPcdataType_t; *************** *** 92,98 **** typedef enum { SML_EXT_UNDEFINED = 0, ! SML_EXT_METINF, // Meta Information ! SML_EXT_DEVINF, // Device Information ! SML_EXT_LAST // last codepage, needed for loops! } SmlPcdataExtension_t; --- 90,96 ---- typedef enum { SML_EXT_UNDEFINED = 0, ! SML_EXT_METINF, /**< Meta Information */ ! SML_EXT_DEVINF, /**< Device Information */ ! SML_EXT_LAST /**< last codepage, needed for loops! */ } SmlPcdataExtension_t; *************** *** 101,113 **** /** * PCDATA - into this structure SyncML wraps the synchronization data itself ! **/ typedef struct sml_pcdata_s { ! SmlPcdataType_t contentType; // The type of data which a PCDATA structure contains ! SmlPcdataExtension_t extension; // PCData Extension type ! MemSize_t length; // length of the data in this PCDATA structure ! VoidPtr_t content; // Pointer to the data itself } *SmlPcdataPtr_t, SmlPcdata_t; ! /* generic list of PCData elements */ typedef struct sml_pcdata_list_s { SmlPcdataPtr_t data; --- 99,111 ---- /** * PCDATA - into this structure SyncML wraps the synchronization data itself ! */ typedef struct sml_pcdata_s { ! SmlPcdataType_t contentType; /**< The type of data which a PCDATA structure contains */ ! SmlPcdataExtension_t extension; /**< PCData Extension type */ ! MemSize_t length; /**< length of the data in this PCDATA structure */ ! VoidPtr_t content; /**< Pointer to the data itself */ } *SmlPcdataPtr_t, SmlPcdata_t; ! /** generic list of PCData elements */ typedef struct sml_pcdata_list_s { SmlPcdataPtr_t data; *************** *** 115,138 **** } *SmlPcdataListPtr_t, SmlPcdataList_t; ! /** * Various flags which are actually declared and (EMPTY) elements in * SyncML. This assumes at least a 16-bit architecture for the * underlying OS. We need to review this if that is deemed a problem. ! **/ ! #define SmlArchive_f 0x8000 // Delete flags ! #define SmlSftDel_f 0x4000 // Delete flags ! #define SmlMoreData_f 0x0400 // MoreData flag ! #define SmlNoResults_f 0x0200 // No Results flag ! #define SmlNoResp_f 0x0100 // No Response flag ! #define SmlFinal_f 0x0001 // Header flag #ifdef __USE_METINF__ ! #define SmlMetInfSharedMem_f 0x0002 // MetInf Shared Memory Flag #endif #ifdef __USE_DEVINF__ ! #define SmlDevInfSharedMem_f 0x0004 // DevInf Shared Memory Flag /* SCTSTK - 18/03/2002, S.H. 2002-04-05 : SyncML 1.1 */ ! #define SmlDevInfUTC_f 0x0001 // DevInf utc Flag ! #define SmlDevInfNOfM_f 0x0002 // DevInf support n of m Flag ! #define SmlDevInfLargeObject_f 0x0008 // DevInf support large object Flag #endif --- 113,136 ---- } *SmlPcdataListPtr_t, SmlPcdataList_t; ! /* * Various flags which are actually declared and (EMPTY) elements in * SyncML. This assumes at least a 16-bit architecture for the * underlying OS. We need to review this if that is deemed a problem. ! */ ! #define SmlArchive_f 0x8000 /**< Delete flags */ ! #define SmlSftDel_f 0x4000 /**< Delete flags */ ! #define SmlMoreData_f 0x0400 /**< MoreData flag */ ! #define SmlNoResults_f 0x0200 /**< No Results flag */ ! #define SmlNoResp_f 0x0100 /**< No Response flag */ ! #define SmlFinal_f 0x0001 /**< Header flag */ #ifdef __USE_METINF__ ! #define SmlMetInfSharedMem_f 0x0002 /**< MetInf Shared Memory Flag */ #endif #ifdef __USE_DEVINF__ ! #define SmlDevInfSharedMem_f 0x0004 /**< DevInf Shared Memory Flag */ /* SCTSTK - 18/03/2002, S.H. 2002-04-05 : SyncML 1.1 */ ! #define SmlDevInfUTC_f 0x0001 /**< DevInf utc Flag */ ! #define SmlDevInfNOfM_f 0x0002 /**< DevInf support n of m Flag */ ! #define SmlDevInfLargeObject_f 0x0008 /**< DevInf support large object Flag */ #endif *************** *** 140,144 **** /** * Chal ! **/ typedef struct sml_chal_s { SmlPcdataPtr_t meta; --- 138,142 ---- /** * Chal ! */ typedef struct sml_chal_s { SmlPcdataPtr_t meta; *************** *** 147,151 **** /** * Credentials ! **/ typedef struct sml_cred_s { SmlPcdataPtr_t meta; // opt. --- 145,149 ---- /** * Credentials ! */ typedef struct sml_cred_s { SmlPcdataPtr_t meta; // opt. *************** *** 154,161 **** - /** * Source or target location ! **/ typedef struct sml_source_or_target_s { SmlPcdataPtr_t locURI; --- 152,158 ---- /** * Source or target location ! */ typedef struct sml_source_or_target_s { SmlPcdataPtr_t locURI; *************** *** 171,179 **** ! /** * ============================== * SyncML Message Header Elements * ============================== ! **/ --- 168,176 ---- ! /* * ============================== * SyncML Message Header Elements * ============================== ! */ *************** *** 182,186 **** * As the header is needed for each SyncML message, it's also the parameter * of the startMessage call. ! **/ typedef struct sml_sync_hdr_s { SmlProtoElement_t elementType; // Internal Toolkit Field --- 179,183 ---- * As the header is needed for each SyncML message, it's also the parameter * of the startMessage call. ! */ typedef struct sml_sync_hdr_s { SmlProtoElement_t elementType; // Internal Toolkit Field *************** *** 203,216 **** ! /** * ========================= * Data description elements * ========================= ! **/ /** * Data in SyncML is encapsulated in an "item" element. ! **/ typedef struct sml_item_s { SmlTargetPtr_t target; // opt. --- 200,213 ---- ! /* * ========================= * Data description elements * ========================= ! */ /** * Data in SyncML is encapsulated in an "item" element. ! */ typedef struct sml_item_s { SmlTargetPtr_t target; // opt. *************** *** 227,242 **** ! /** * ============================================== * SyncML Commands (Protocol Management Elements) * ============================================== ! **/ ! ! /** * Generic commands: * Add, Copy, Replace, Delete ! **/ typedef struct sml_generic_s { SmlProtoElement_t elementType; // Internal Toolkit Field --- 224,237 ---- ! /* * ============================================== * SyncML Commands (Protocol Management Elements) * ============================================== ! */ /** * Generic commands: * Add, Copy, Replace, Delete ! */ typedef struct sml_generic_s { SmlProtoElement_t elementType; // Internal Toolkit Field *************** *** 254,258 **** /** * Alert command: ! **/ typedef struct sml_alert_s { SmlProtoElement_t elementType; // Internal Toolkit Field --- 249,253 ---- /** * Alert command: ! */ typedef struct sml_alert_s { SmlProtoElement_t elementType; // Internal Toolkit Field *************** *** 267,271 **** /** * Atomic/Sequence command: ! **/ typedef struct sml_atomic_s { SmlProtoElement_t elementType; // Internal Toolkit Field --- 262,266 ---- /** * Atomic/Sequence command: ! */ typedef struct sml_atomic_s { SmlProtoElement_t elementType; // Internal Toolkit Field *************** *** 279,283 **** /** * Sync command: ! **/ typedef struct sml_sync_s { SmlProtoElement_t elementType; // Internal Toolkit Field --- 274,278 ---- /** * Sync command: ! */ typedef struct sml_sync_s { SmlProtoElement_t elementType; // Internal Toolkit Field *************** *** 294,298 **** /** * Exec command: ! **/ typedef struct sml_exec_s { SmlProtoElement_t elementType; --- 289,293 ---- /** * Exec command: ! */ typedef struct sml_exec_s { SmlProtoElement_t elementType; *************** *** 307,311 **** /** * Get and Put command: ! **/ typedef struct sml_get_put_s { SmlProtoElement_t elementType; // Internal Toolkit Field --- 302,306 ---- /** * Get and Put command: ! */ typedef struct sml_get_put_s { SmlProtoElement_t elementType; // Internal Toolkit Field *************** *** 322,326 **** /** * Map command: ! **/ typedef struct sml_map_item_s { SmlTargetPtr_t target; --- 317,321 ---- /** * Map command: ! */ typedef struct sml_map_item_s { SmlTargetPtr_t target; *************** *** 344,351 **** - /** * Results command: ! **/ typedef struct sml_results_s { SmlProtoElement_t elementType; // Internal Toolkit Field --- 339,345 ---- /** * Results command: ! */ typedef struct sml_results_s { SmlProtoElement_t elementType; // Internal Toolkit Field *************** *** 362,366 **** /** * Search command: ! **/ typedef struct sml_search_s { SmlProtoElement_t elementType; // Internal Toolkit Field --- 356,360 ---- /** * Search command: ! */ typedef struct sml_search_s { SmlProtoElement_t elementType; // Internal Toolkit Field *************** *** 378,383 **** /** * Status command: ! **/ ! typedef struct sml_target_ref_list_s { SmlPcdataPtr_t targetRef; --- 372,376 ---- /** * Status command: ! */ typedef struct sml_target_ref_list_s { SmlPcdataPtr_t targetRef; *************** *** 407,411 **** /** * a little helper for typecasting ! **/ typedef struct sml_unknown_proto_element_s { SmlProtoElement_t elementType; // Internal Toolkit Field --- 400,404 ---- /** * a little helper for typecasting ! */ typedef struct sml_unknown_proto_element_s { SmlProtoElement_t elementType; // Internal Toolkit Field |