xmlsrv_plat/cxml_library_api/inc/nw_xmlp_xmlp2wbxml.h
author hgs
Wed, 23 Jun 2010 20:27:15 +0530
changeset 24 74f0b3eb154c
permissions -rw-r--r--
201024
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
24
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2000 - 2001 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of the License "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description: 
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
/** ----------------------------------------------------------------------- **
hgs
parents:
diff changeset
    20
    @package:     NW_XML
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
    @synopsis:    default
hgs
parents:
diff changeset
    23
hgs
parents:
diff changeset
    24
    @description: default
hgs
parents:
diff changeset
    25
hgs
parents:
diff changeset
    26
 ** ----------------------------------------------------------------------- **/
hgs
parents:
diff changeset
    27
hgs
parents:
diff changeset
    28
#ifndef NW_XMLP2WBXML_H
hgs
parents:
diff changeset
    29
#define NW_XMLP2WBXML_H
hgs
parents:
diff changeset
    30
hgs
parents:
diff changeset
    31
#include <xml/cxml/nw_xmlp_xmlreader.h>
hgs
parents:
diff changeset
    32
hgs
parents:
diff changeset
    33
#ifdef __cplusplus
hgs
parents:
diff changeset
    34
extern "C" {
hgs
parents:
diff changeset
    35
#endif /* __cplusplus */
hgs
parents:
diff changeset
    36
  
hgs
parents:
diff changeset
    37
hgs
parents:
diff changeset
    38
/** ----------------------------------------------------------------------- **
hgs
parents:
diff changeset
    39
    @function:    NW_Xml_Text2WbxmlEncoder_New
hgs
parents:
diff changeset
    40
hgs
parents:
diff changeset
    41
    @synopsis:    Constructor.
hgs
parents:
diff changeset
    42
hgs
parents:
diff changeset
    43
    @scope:       public
hgs
parents:
diff changeset
    44
hgs
parents:
diff changeset
    45
    @parameters:
hgs
parents:
diff changeset
    46
       [in] NW_Uint32 publicID
hgs
parents:
diff changeset
    47
                  The public ID.
hgs
parents:
diff changeset
    48
hgs
parents:
diff changeset
    49
       [in] NW_Uint32 encoding
hgs
parents:
diff changeset
    50
                  The encoding.
hgs
parents:
diff changeset
    51
hgs
parents:
diff changeset
    52
       [out] void** ppV
hgs
parents:
diff changeset
    53
                  The returned structure.
hgs
parents:
diff changeset
    54
hgs
parents:
diff changeset
    55
    @description: Constructor.
hgs
parents:
diff changeset
    56
hgs
parents:
diff changeset
    57
    @returns:     NW_Status_t
hgs
parents:
diff changeset
    58
                  Status of operation.
hgs
parents:
diff changeset
    59
hgs
parents:
diff changeset
    60
 ** ----------------------------------------------------------------------- **/
hgs
parents:
diff changeset
    61
NW_Status_t
hgs
parents:
diff changeset
    62
NW_XML_Text2WbxmlEncoder_New(NW_Uint32 publicID, NW_Uint32 encoding, void** ppV);
hgs
parents:
diff changeset
    63
hgs
parents:
diff changeset
    64
hgs
parents:
diff changeset
    65
/** ----------------------------------------------------------------------- **
hgs
parents:
diff changeset
    66
    @function:    NW_XML_XmlpWbxmlEncoder_Delete
hgs
parents:
diff changeset
    67
hgs
parents:
diff changeset
    68
    @synopsis:    Destructor.
hgs
parents:
diff changeset
    69
hgs
parents:
diff changeset
    70
    @scope:       public
hgs
parents:
diff changeset
    71
hgs
parents:
diff changeset
    72
    @parameters:
hgs
parents:
diff changeset
    73
       [in] void* pV
hgs
parents:
diff changeset
    74
                  The encoder.
hgs
parents:
diff changeset
    75
hgs
parents:
diff changeset
    76
    @description: Destructor.
hgs
parents:
diff changeset
    77
 ** ----------------------------------------------------------------------- **/
hgs
parents:
diff changeset
    78
void
hgs
parents:
diff changeset
    79
NW_XML_XmlpWbxmlEncoder_Delete(void* pV);
hgs
parents:
diff changeset
    80
hgs
parents:
diff changeset
    81
hgs
parents:
diff changeset
    82
/** ----------------------------------------------------------------------- **
hgs
parents:
diff changeset
    83
    @function:    NW_XML_ComputeEncoding
hgs
parents:
diff changeset
    84
hgs
parents:
diff changeset
    85
    @synopsis:    Compute encoding.
hgs
parents:
diff changeset
    86
hgs
parents:
diff changeset
    87
    @scope:       public
hgs
parents:
diff changeset
    88
hgs
parents:
diff changeset
    89
    @parameters:
hgs
parents:
diff changeset
    90
       [in] NW_Uint32 length
hgs
parents:
diff changeset
    91
                  Length of buffer.
hgs
parents:
diff changeset
    92
hgs
parents:
diff changeset
    93
       [in] const unsigned char* pBuf
hgs
parents:
diff changeset
    94
                  Buffer.
hgs
parents:
diff changeset
    95
hgs
parents:
diff changeset
    96
       [out] NW_Uint32* pEncoding
hgs
parents:
diff changeset
    97
                  The calculated encoding.
hgs
parents:
diff changeset
    98
hgs
parents:
diff changeset
    99
       [out] NW_XML_Endianness_t* pEndianness
hgs
parents:
diff changeset
   100
                  The calculated endianness.
hgs
parents:
diff changeset
   101
hgs
parents:
diff changeset
   102
    @description: Compute encoding.
hgs
parents:
diff changeset
   103
hgs
parents:
diff changeset
   104
    @returns:     NW_Status_t
hgs
parents:
diff changeset
   105
                  Status of operation.
hgs
parents:
diff changeset
   106
hgs
parents:
diff changeset
   107
       [NW_STAT_SUCCESS]
hgs
parents:
diff changeset
   108
                  Endianness and encoding determined.
hgs
parents:
diff changeset
   109
hgs
parents:
diff changeset
   110
       [NW_STAT_FAILURE]
hgs
parents:
diff changeset
   111
                  Invalid length. Must be >= 4 to determine encoding.
hgs
parents:
diff changeset
   112
hgs
parents:
diff changeset
   113
 ** ----------------------------------------------------------------------- **/
hgs
parents:
diff changeset
   114
IMPORT_C 
hgs
parents:
diff changeset
   115
NW_Status_t
hgs
parents:
diff changeset
   116
NW_XML_ComputeEncoding(NW_Uint32 length, const unsigned char* pBuf,
hgs
parents:
diff changeset
   117
                             NW_Uint32* pEncoding, NW_XML_Endianness_t* pEndianness);
hgs
parents:
diff changeset
   118
hgs
parents:
diff changeset
   119
hgs
parents:
diff changeset
   120
/** ----------------------------------------------------------------------- **
hgs
parents:
diff changeset
   121
    @function:    NW_XML_XmlToWbxml
hgs
parents:
diff changeset
   122
hgs
parents:
diff changeset
   123
    @synopsis:    Convert buffer from Xml to Wbxml.
hgs
parents:
diff changeset
   124
hgs
parents:
diff changeset
   125
    @scope:       public
hgs
parents:
diff changeset
   126
hgs
parents:
diff changeset
   127
    @parameters:
hgs
parents:
diff changeset
   128
       [in] NW_Buffer_t* pInBuf
hgs
parents:
diff changeset
   129
                  The input buffer.
hgs
parents:
diff changeset
   130
hgs
parents:
diff changeset
   131
       [in] NW_Uint32 encoding
hgs
parents:
diff changeset
   132
                  The encoding.
hgs
parents:
diff changeset
   133
hgs
parents:
diff changeset
   134
       [out] NW_Buffer_t** ppOutBuf
hgs
parents:
diff changeset
   135
                  Converted data.
hgs
parents:
diff changeset
   136
hgs
parents:
diff changeset
   137
       [out] NW_Uint32* line
hgs
parents:
diff changeset
   138
                  Line count.
hgs
parents:
diff changeset
   139
hgs
parents:
diff changeset
   140
       [in] NW_Uint32 publicID
hgs
parents:
diff changeset
   141
                  The public ID.
hgs
parents:
diff changeset
   142
       [out] void** WBXMLEncStrTbl:
hgs
parents:
diff changeset
   143
                Stores the string table of WBXML encoder.
hgs
parents:
diff changeset
   144
hgs
parents:
diff changeset
   145
    @description: Convert buffer from Xml to Wbxml.
hgs
parents:
diff changeset
   146
hgs
parents:
diff changeset
   147
    @returns:     NW_Status_t
hgs
parents:
diff changeset
   148
                  Status of operation.
hgs
parents:
diff changeset
   149
hgs
parents:
diff changeset
   150
       [NW_STAT_SUCCESS]
hgs
parents:
diff changeset
   151
                  Buffer converted to WBXML.
hgs
parents:
diff changeset
   152
hgs
parents:
diff changeset
   153
       [NW_STAT_FAILURE]
hgs
parents:
diff changeset
   154
                  Required parameter is NULL, doc has odd number of bytes
hgs
parents:
diff changeset
   155
                  or no data to process.
hgs
parents:
diff changeset
   156
hgs
parents:
diff changeset
   157
 ** ----------------------------------------------------------------------- **/
hgs
parents:
diff changeset
   158
NW_Status_t
hgs
parents:
diff changeset
   159
NW_XML_XmlToWbxml(NW_Buffer_t* pInBuf, NW_Uint32 encoding, 
hgs
parents:
diff changeset
   160
                  NW_Buffer_t** ppOutBuf, NW_Uint32* line, 
hgs
parents:
diff changeset
   161
                  NW_Uint32 publicID, void** WBXMLEncStrTbl);
hgs
parents:
diff changeset
   162
hgs
parents:
diff changeset
   163
hgs
parents:
diff changeset
   164
#ifdef __cplusplus
hgs
parents:
diff changeset
   165
} // extern "C" {
hgs
parents:
diff changeset
   166
#endif /* __cplusplus */
hgs
parents:
diff changeset
   167
hgs
parents:
diff changeset
   168
#endif  /* NW_XMLP2WBXML_H */