include/xmllite.idl

   1 /*
   2  * Copyright (C) 2010 Nikolay Sivov
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  17  */
  18
  19 import "unknwn.idl";
  20 import "objidl.idl";
  21 import "oaidl.idl";
  22
  23 typedef enum XmlNodeType {
  24     XmlNodeType_None                  = 0,
  25     XmlNodeType_Element               = 1,
  26     XmlNodeType_Attribute             = 2,
  27     XmlNodeType_Text                  = 3,
  28     XmlNodeType_CDATA                 = 4,
  29     XmlNodeType_ProcessingInstruction = 7,
  30     XmlNodeType_Comment               = 8,
  31     XmlNodeType_DocumentType          = 10,
  32     XmlNodeType_Whitespace            = 13,
  33     XmlNodeType_EndElement            = 15,
  34     XmlNodeType_XmlDeclaration        = 17,
  35     _XmlNodeType_Last                 = 17
  36 } XmlNodeType;
  37
  38 /* IXmlReader */
  39 [
  40   local,
  41   object,
  42   uuid(7279fc81-709d-4095-b63d-69fe4b0d9030),
  43   pointer_default(unique)
  44 ]
  45 interface IXmlReader : IUnknown
  46 {
  47     HRESULT SetInput( [in] IUnknown *input);
  48     HRESULT GetProperty( [in] UINT property, [out] LONG_PTR *value);
  49     HRESULT SetProperty( [in] UINT property, [in] LONG_PTR value);
  50     HRESULT Read( [out] XmlNodeType *node_type);
  51     HRESULT GetNodeType( [out] XmlNodeType *node_type);
  52     HRESULT MoveToFirstAttribute(void);
  53     HRESULT MoveToNextAttribute(void);
  54     HRESULT MoveToAttributeByName( [in] LPCWSTR local_name,
  55                                    [in] LPCWSTR namespaceUri);
  56     HRESULT MoveToElement(void);
  57     HRESULT GetQualifiedName( [out] LPCWSTR *qualifiedName,
  58                               [out] UINT *qualifiedName_length);
  59     HRESULT GetNamespaceUri( [out] LPCWSTR *namespaceUri,
  60                              [out] UINT *nnamespaceUri_length);
  61     HRESULT GetLocalName( [out] LPCWSTR *local_name,
  62                           [out] UINT *locale_name_length);
  63     HRESULT GetPrefix( [out] LPCWSTR *prefix,
  64                        [out] UINT *prefix_length);
  65     HRESULT GetValue( [out] LPCWSTR *value,
  66                       [out] UINT *value_length);
  67     HRESULT ReadValueChunk( [out] WCHAR *buffer,
  68                             [in]  UINT chunk_size,
  69                             [in,out] UINT *read);
  70     HRESULT GetBaseUri( [out] LPCWSTR *baseUri,
  71                         [out] UINT *baseUri_length);
  72     BOOL IsDefault(void);
  73     BOOL IsEmptyElement(void);
  74     HRESULT GetLineNumber( [out] UINT *lineNumber);
  75     HRESULT GetLinePosition( [out] UINT *linePosition);
  76     HRESULT GetAttributeCount( [out] UINT *attributeCount);
  77     HRESULT GetDepth( [out] UINT *depth);
  78     BOOL IsEOF(void);
  79 }
  80
  81 /* IXmlReader state */
  82 cpp_quote("typedef enum XmlReadState")
  83 cpp_quote("{")
  84 cpp_quote("    XmlReadState_Initial     = 0,")
  85 cpp_quote("    XmlReadState_Interactive = 1,")
  86 cpp_quote("    XmlReadState_Error       = 2,")
  87 cpp_quote("    XmlReadState_EndOfFile   = 3,")
  88 cpp_quote("    XmlReadState_Closed      = 4")
  89 cpp_quote("} XmlReadState;")
  90
  91 /* IXmlReader properties */
  92 cpp_quote("typedef enum XmlReaderProperty")
  93 cpp_quote("{")
  94 cpp_quote("    XmlReaderProperty_MultiLanguage      = 0,")
  95 cpp_quote("    XmlReaderProperty_ConformanceLevel   = XmlReaderProperty_MultiLanguage + 1,")
  96 cpp_quote("    XmlReaderProperty_RandomAccess       = XmlReaderProperty_ConformanceLevel + 1,")
  97 cpp_quote("    XmlReaderProperty_XmlResolver        = XmlReaderProperty_RandomAccess + 1,")
  98 cpp_quote("    XmlReaderProperty_DtdProcessing      = XmlReaderProperty_XmlResolver + 1,")
  99 cpp_quote("    XmlReaderProperty_ReadState          = XmlReaderProperty_DtdProcessing + 1,")
 100 cpp_quote("    XmlReaderProperty_MaxElementDepth    = XmlReaderProperty_ReadState + 1,")
 101 cpp_quote("    XmlReaderProperty_MaxEntityExpansion = XmlReaderProperty_MaxElementDepth + 1,")
 102 cpp_quote("    _XmlReaderProperty_Last              = XmlReaderProperty_MaxEntityExpansion")
 103 cpp_quote("} XmlReaderProperty;")
 104
 105 /* IXmlReader construction */
 106 cpp_quote("STDAPI CreateXmlReader(REFIID riid, void **ppvObject, IMalloc *pMalloc);")
 107
 108 cpp_quote("typedef IUnknown IXmlReaderInput;")
 109 cpp_quote("STDAPI CreateXmlReaderInputWithEncodingName(IUnknown *stream, IMalloc *pMalloc,")
 110 cpp_quote("                                            LPCWSTR encoding, BOOL hint,")
 111 cpp_quote("                                            LPCWSTR base_uri, IXmlReaderInput **ppInput);")
 112
 113 typedef enum XmlStandalone
 114 {
 115     XmlStandalone_Omit,
 116     XmlStandalone_Yes,
 117     XmlStandalone_No,
 118     _XmlStandalone_Last = XmlStandalone_No
 119 } XmlStandalone;
 120
 121 typedef enum XmlWriterProperty
 122 {
 123     XmlWriterProperty_MultiLanguage,
 124     XmlWriterProperty_Indent,
 125     XmlWriterProperty_ByteOrderMark,
 126     XmlWriterProperty_OmitXmlDeclaration,
 127     XmlWriterProperty_ConformanceLevel,
 128     _XmlWriterProperty_Last = XmlWriterProperty_OmitXmlDeclaration
 129 } XmlWriterProperty;
 130
 131 /* IXmlWriter */
 132 [
 133   local,
 134   object,
 135   uuid(7279FC88-709D-4095-B63D-69FE4B0D9030),
 136   pointer_default(unique)
 137 ]
 138 interface IXmlWriter : IUnknown
 139 {
 140     HRESULT SetOutput([in] IUnknown *pOutput);
 141     HRESULT GetProperty([in] UINT nProperty, [out] LONG_PTR *ppValue);
 142     HRESULT SetProperty([in] UINT nProperty, [in] LONG_PTR pValue);
 143     HRESULT WriteAttributes([in] IXmlReader *pReader, [in] BOOL fWriteDefaultAttributes);
 144     HRESULT WriteAttributeString([in] LPCWSTR pwszPrefix, [in] LPCWSTR pwszLocalName,
 145                                  [in] LPCWSTR pwszNamespaceUri, [in] LPCWSTR pwszValue);
 146     HRESULT WriteCData([in] LPCWSTR pwszText);
 147     HRESULT WriteCharEntity([in] WCHAR wch);
 148     HRESULT WriteChars([in] const WCHAR *pwch, [in] UINT cwch);
 149     HRESULT WriteComment([in] LPCWSTR pwszComment);
 150     HRESULT WriteDocType([in] LPCWSTR pwszName, [in] LPCWSTR pwszPublicId,
 151                          [in] LPCWSTR pwszSystemId, [in] LPCWSTR pwszSubset);
 152     HRESULT WriteElementString([in] LPCWSTR pwszPrefix, [in] LPCWSTR pwszLocalName,
 153                                [in] LPCWSTR pwszNamespaceUri, [in] LPCWSTR pwszValue);
 154     HRESULT WriteEndDocument();
 155     HRESULT WriteEndElement();
 156     HRESULT WriteEntityRef([in] LPCWSTR pwszName);
 157     HRESULT WriteFullEndElement();
 158     HRESULT WriteName([in] LPCWSTR pwszName);
 159     HRESULT WriteNmToken([in] LPCWSTR pwszNmToken);
 160     HRESULT WriteNode([in] IXmlReader *pReader, [in] BOOL fWriteDefaultAttributes);
 161     HRESULT WriteNodeShallow([in] IXmlReader *pReader, [in] BOOL fWriteDefaultAttributes);
 162     HRESULT WriteProcessingInstruction([in] LPCWSTR pwszName, [in] LPCWSTR pwszText);
 163     HRESULT WriteQualifiedName([in] LPCWSTR pwszLocalName, [in] LPCWSTR pwszNamespaceUri);
 164     HRESULT WriteRaw([in] LPCWSTR pwszData);
 165     HRESULT WriteRawChars([in] const WCHAR *pwch, [in] UINT cwch);
 166     HRESULT WriteStartDocument([in] XmlStandalone standalone);
 167     HRESULT WriteStartElement([in] LPCWSTR pwszPrefix, [in] LPCWSTR pwszLocalName,
 168                               [in]  LPCWSTR pwszNamespaceUri);
 169     HRESULT WriteString([in] LPCWSTR pwszText);
 170     HRESULT WriteSurrogateCharEntity([in] WCHAR wchLow, [in] WCHAR wchHigh);
 171     HRESULT WriteWhitespace([in] LPCWSTR pwszWhitespace);
 172     HRESULT Flush();
 173 }