msxml3: Add type id placeholder for index 0 to make lookup code actually work.
[wine/testsucceed.git] / dlls / msxml3 / msxml_private.h
blob698655e4100d1c7eb32f28998e5a05af0015f96c
1 /*
2 * Common definitions
4 * Copyright 2005 Mike McCormack
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
21 #ifndef __MSXML_PRIVATE__
22 #define __MSXML_PRIVATE__
24 #include "dispex.h"
26 #include "wine/unicode.h"
28 #ifndef __WINE_CONFIG_H
29 # error You must include config.h to use this header
30 #endif
32 typedef enum {
33 MSXML_DEFAULT = 0,
34 MSXML3 = 30,
35 MSXML4 = 40,
36 MSXML6 = 60
37 } MSXML_VERSION;
39 /* typelibs */
40 typedef enum tid_t {
41 NULL_tid,
42 IXMLDOMAttribute_tid,
43 IXMLDOMCDATASection_tid,
44 IXMLDOMComment_tid,
45 IXMLDOMDocument_tid,
46 IXMLDOMDocument2_tid,
47 IXMLDOMDocumentFragment_tid,
48 IXMLDOMDocumentType_tid,
49 IXMLDOMElement_tid,
50 IXMLDOMEntityReference_tid,
51 IXMLDOMImplementation_tid,
52 IXMLDOMNamedNodeMap_tid,
53 IXMLDOMNode_tid,
54 IXMLDOMNodeList_tid,
55 IXMLDOMParseError_tid,
56 IXMLDOMProcessingInstruction_tid,
57 IXMLDOMSchemaCollection_tid,
58 IXMLDOMSelection_tid,
59 IXMLDOMText_tid,
60 IXMLElement_tid,
61 IXMLDocument_tid,
62 IXMLHTTPRequest_tid,
63 IXSLProcessor_tid,
64 IXSLTemplate_tid,
65 IVBSAXAttributes_tid,
66 IVBSAXContentHandler_tid,
67 IVBSAXDeclHandler_tid,
68 IVBSAXDTDHandler_tid,
69 IVBSAXEntityResolver_tid,
70 IVBSAXErrorHandler_tid,
71 IVBSAXLexicalHandler_tid,
72 IVBSAXLocator_tid,
73 IVBSAXXMLFilter_tid,
74 IVBSAXXMLReader_tid,
75 IMXAttributes_tid,
76 IMXReaderControl_tid,
77 IMXWriter_tid,
78 IVBMXNamespaceManager_tid,
79 LAST_tid
80 } tid_t;
82 /* The XDR datatypes (urn:schemas-microsoft-com:datatypes)
83 * These are actually valid for XSD schemas as well
84 * See datatypes.xsd
86 typedef enum _XDR_DT {
87 DT_INVALID = -1,
88 DT_BIN_BASE64,
89 DT_BIN_HEX,
90 DT_BOOLEAN,
91 DT_CHAR,
92 DT_DATE,
93 DT_DATE_TZ,
94 DT_DATETIME,
95 DT_DATETIME_TZ,
96 DT_ENTITY,
97 DT_ENTITIES,
98 DT_ENUMERATION,
99 DT_FIXED_14_4,
100 DT_FLOAT,
101 DT_I1,
102 DT_I2,
103 DT_I4,
104 DT_I8,
105 DT_ID,
106 DT_IDREF,
107 DT_IDREFS,
108 DT_INT,
109 DT_NMTOKEN,
110 DT_NMTOKENS,
111 DT_NOTATION,
112 DT_NUMBER,
113 DT_R4,
114 DT_R8,
115 DT_STRING,
116 DT_TIME,
117 DT_TIME_TZ,
118 DT_UI1,
119 DT_UI2,
120 DT_UI4,
121 DT_UI8,
122 DT_URI,
123 DT_UUID
124 } XDR_DT;
125 #define DT__N_TYPES (DT_UUID+1)
127 extern HRESULT get_typeinfo(tid_t tid, ITypeInfo **typeinfo) DECLSPEC_HIDDEN;
128 extern void release_typelib(void) DECLSPEC_HIDDEN;
130 typedef struct dispex_data_t dispex_data_t;
131 typedef struct dispex_dynamic_data_t dispex_dynamic_data_t;
133 #define MSXML_DISPID_CUSTOM_MIN 0x60000000
134 #define MSXML_DISPID_CUSTOM_MAX 0x6fffffff
136 typedef struct {
137 HRESULT (*get_dispid)(IUnknown*,BSTR,DWORD,DISPID*);
138 HRESULT (*invoke)(IUnknown*,DISPID,LCID,WORD,DISPPARAMS*,VARIANT*,EXCEPINFO*);
139 } dispex_static_data_vtbl_t;
141 typedef struct {
142 const dispex_static_data_vtbl_t *vtbl;
143 const tid_t disp_tid;
144 dispex_data_t *data;
145 const tid_t* const iface_tids;
146 } dispex_static_data_t;
148 typedef struct {
149 IDispatchEx IDispatchEx_iface;
151 IUnknown *outer;
153 dispex_static_data_t *data;
154 dispex_dynamic_data_t *dynamic_data;
155 } DispatchEx;
157 extern HINSTANCE MSXML_hInstance DECLSPEC_HIDDEN;
159 void init_dispex(DispatchEx*,IUnknown*,dispex_static_data_t*) DECLSPEC_HIDDEN;
160 void release_dispex(DispatchEx*) DECLSPEC_HIDDEN;
161 BOOL dispex_query_interface(DispatchEx*,REFIID,void**) DECLSPEC_HIDDEN;
163 /* memory allocation functions */
165 static inline void *heap_alloc(size_t len)
167 return HeapAlloc(GetProcessHeap(), 0, len);
170 static inline void *heap_alloc_zero(size_t len)
172 return HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, len);
175 static inline void *heap_realloc(void *mem, size_t len)
177 return HeapReAlloc(GetProcessHeap(), 0, mem, len);
180 static inline BOOL heap_free(void *mem)
182 return HeapFree(GetProcessHeap(), 0, mem);
185 static inline LPWSTR heap_strdupW(LPCWSTR str)
187 LPWSTR ret = NULL;
189 if(str) {
190 DWORD size;
192 size = (strlenW(str)+1)*sizeof(WCHAR);
193 ret = heap_alloc(size);
194 memcpy(ret, str, size);
197 return ret;
200 static inline LPSTR heap_strdupWtoA(LPCWSTR str)
202 LPSTR ret = NULL;
204 if(str) {
205 DWORD len = WideCharToMultiByte(CP_ACP, 0, str, -1, NULL, 0, NULL, NULL);
206 ret = heap_alloc(len+1);
207 if(!ret)
208 return NULL;
210 WideCharToMultiByte(CP_ACP, 0, str, -1, ret, len+1, NULL, NULL);
213 return ret;
216 #ifdef HAVE_LIBXML2
218 extern void schemasInit(void) DECLSPEC_HIDDEN;
219 extern void schemasCleanup(void) DECLSPEC_HIDDEN;
221 #ifndef HAVE_XMLFIRSTELEMENTCHILD
222 static inline xmlNodePtr wine_xmlFirstElementChild(xmlNodePtr parent)
224 xmlNodePtr child;
225 for (child = parent->children; child != NULL; child = child->next)
226 if (child->type == XML_ELEMENT_NODE)
227 break;
229 return child;
231 #define xmlFirstElementChild wine_xmlFirstElementChild
232 #endif
234 /* constructors */
235 extern IUnknown *create_domdoc( xmlNodePtr ) DECLSPEC_HIDDEN;
236 extern IUnknown *create_xmldoc( void ) DECLSPEC_HIDDEN;
237 extern IXMLDOMNode *create_node( xmlNodePtr ) DECLSPEC_HIDDEN;
238 extern IUnknown *create_element( xmlNodePtr ) DECLSPEC_HIDDEN;
239 extern IUnknown *create_attribute( xmlNodePtr ) DECLSPEC_HIDDEN;
240 extern IUnknown *create_text( xmlNodePtr ) DECLSPEC_HIDDEN;
241 extern IUnknown *create_pi( xmlNodePtr ) DECLSPEC_HIDDEN;
242 extern IUnknown *create_comment( xmlNodePtr ) DECLSPEC_HIDDEN;
243 extern IUnknown *create_cdata( xmlNodePtr ) DECLSPEC_HIDDEN;
244 extern IXMLDOMNodeList *create_children_nodelist( xmlNodePtr ) DECLSPEC_HIDDEN;
245 extern IXMLDOMNamedNodeMap *create_nodemap( const xmlNodePtr ) DECLSPEC_HIDDEN;
246 extern IUnknown *create_doc_Implementation(void) DECLSPEC_HIDDEN;
247 extern IUnknown *create_doc_fragment( xmlNodePtr ) DECLSPEC_HIDDEN;
248 extern IUnknown *create_doc_entity_ref( xmlNodePtr ) DECLSPEC_HIDDEN;
249 extern IUnknown *create_doc_type( xmlNodePtr ) DECLSPEC_HIDDEN;
250 extern HRESULT create_selection( xmlNodePtr, xmlChar*, IXMLDOMNodeList** ) DECLSPEC_HIDDEN;
252 /* data accessors */
253 xmlNodePtr xmlNodePtr_from_domnode( IXMLDOMNode *iface, xmlElementType type ) DECLSPEC_HIDDEN;
255 /* helpers */
256 extern xmlChar *xmlChar_from_wchar( LPCWSTR str ) DECLSPEC_HIDDEN;
258 extern void xmldoc_init( xmlDocPtr doc, MSXML_VERSION version ) DECLSPEC_HIDDEN;
259 extern LONG xmldoc_add_ref( xmlDocPtr doc ) DECLSPEC_HIDDEN;
260 extern LONG xmldoc_release( xmlDocPtr doc ) DECLSPEC_HIDDEN;
261 extern HRESULT xmldoc_add_orphan( xmlDocPtr doc, xmlNodePtr node ) DECLSPEC_HIDDEN;
262 extern HRESULT xmldoc_remove_orphan( xmlDocPtr doc, xmlNodePtr node ) DECLSPEC_HIDDEN;
263 extern void xmldoc_link_xmldecl(xmlDocPtr doc, xmlNodePtr node) DECLSPEC_HIDDEN;
264 extern xmlNodePtr xmldoc_unlink_xmldecl(xmlDocPtr doc) DECLSPEC_HIDDEN;
266 extern HRESULT XMLElement_create( IUnknown *pUnkOuter, xmlNodePtr node, LPVOID *ppObj, BOOL own ) DECLSPEC_HIDDEN;
268 extern void wineXmlCallbackLog(char const* caller, xmlErrorLevel lvl, char const* msg, va_list ap) DECLSPEC_HIDDEN;
269 extern void wineXmlCallbackError(char const* caller, xmlErrorPtr err) DECLSPEC_HIDDEN;
271 #define LIBXML2_LOG_CALLBACK __WINE_PRINTF_ATTR(2,3)
273 #define LIBXML2_CALLBACK_TRACE(caller, msg, ap) \
274 wineXmlCallbackLog(#caller, XML_ERR_NONE, msg, ap)
276 #define LIBXML2_CALLBACK_WARN(caller, msg, ap) \
277 wineXmlCallbackLog(#caller, XML_ERR_WARNING, msg, ap)
279 #define LIBXML2_CALLBACK_ERR(caller, msg, ap) \
280 wineXmlCallbackLog(#caller, XML_ERR_ERROR, msg, ap)
282 #define LIBXML2_CALLBACK_SERROR(caller, err) wineXmlCallbackError(#caller, err)
284 extern BOOL is_preserving_whitespace(xmlNodePtr node) DECLSPEC_HIDDEN;
285 extern BOOL is_xpathmode(const xmlDocPtr doc) DECLSPEC_HIDDEN;
286 extern void set_xpathmode(xmlDocPtr doc, BOOL xpath) DECLSPEC_HIDDEN;
288 /* IXMLDOMNode Internal Structure */
289 typedef struct _xmlnode
291 DispatchEx dispex;
292 IXMLDOMNode *iface;
293 IXMLDOMNode *parent;
294 xmlNodePtr node;
295 } xmlnode;
297 extern void init_xmlnode(xmlnode*,xmlNodePtr,IXMLDOMNode*,dispex_static_data_t*) DECLSPEC_HIDDEN;
298 extern void destroy_xmlnode(xmlnode*) DECLSPEC_HIDDEN;
299 extern BOOL node_query_interface(xmlnode*,REFIID,void**) DECLSPEC_HIDDEN;
300 extern xmlnode *get_node_obj(IXMLDOMNode*) DECLSPEC_HIDDEN;
302 extern HRESULT node_append_child(xmlnode*,IXMLDOMNode*,IXMLDOMNode**) DECLSPEC_HIDDEN;
303 extern HRESULT node_get_nodeName(xmlnode*,BSTR*) DECLSPEC_HIDDEN;
304 extern HRESULT node_get_content(xmlnode*,VARIANT*) DECLSPEC_HIDDEN;
305 extern HRESULT node_set_content(xmlnode*,LPCWSTR) DECLSPEC_HIDDEN;
306 extern HRESULT node_put_value(xmlnode*,VARIANT*) DECLSPEC_HIDDEN;
307 extern HRESULT node_put_value_escaped(xmlnode*,VARIANT*) DECLSPEC_HIDDEN;
308 extern HRESULT node_get_parent(xmlnode*,IXMLDOMNode**) DECLSPEC_HIDDEN;
309 extern HRESULT node_get_child_nodes(xmlnode*,IXMLDOMNodeList**) DECLSPEC_HIDDEN;
310 extern HRESULT node_get_first_child(xmlnode*,IXMLDOMNode**) DECLSPEC_HIDDEN;
311 extern HRESULT node_get_last_child(xmlnode*,IXMLDOMNode**) DECLSPEC_HIDDEN;
312 extern HRESULT node_get_previous_sibling(xmlnode*,IXMLDOMNode**) DECLSPEC_HIDDEN;
313 extern HRESULT node_get_next_sibling(xmlnode*,IXMLDOMNode**) DECLSPEC_HIDDEN;
314 extern HRESULT node_insert_before(xmlnode*,IXMLDOMNode*,const VARIANT*,IXMLDOMNode**) DECLSPEC_HIDDEN;
315 extern HRESULT node_replace_child(xmlnode*,IXMLDOMNode*,IXMLDOMNode*,IXMLDOMNode**) DECLSPEC_HIDDEN;
316 extern HRESULT node_put_text(xmlnode*,BSTR) DECLSPEC_HIDDEN;
317 extern HRESULT node_get_xml(xmlnode*,BOOL,BOOL,BSTR*) DECLSPEC_HIDDEN;
318 extern HRESULT node_clone(xmlnode*,VARIANT_BOOL,IXMLDOMNode**) DECLSPEC_HIDDEN;
319 extern HRESULT node_get_prefix(xmlnode*,BSTR*) DECLSPEC_HIDDEN;
320 extern HRESULT node_get_base_name(xmlnode*,BSTR*) DECLSPEC_HIDDEN;
321 extern HRESULT node_get_namespaceURI(xmlnode*,BSTR*) DECLSPEC_HIDDEN;
322 extern HRESULT node_remove_child(xmlnode*,IXMLDOMNode*,IXMLDOMNode**) DECLSPEC_HIDDEN;
323 extern HRESULT node_has_childnodes(const xmlnode*,VARIANT_BOOL*) DECLSPEC_HIDDEN;
324 extern HRESULT node_get_owner_doc(const xmlnode*,IXMLDOMDocument**) DECLSPEC_HIDDEN;
325 extern HRESULT node_get_text(const xmlnode*,BSTR*) DECLSPEC_HIDDEN;
326 extern HRESULT node_select_nodes(const xmlnode*,BSTR,IXMLDOMNodeList**) DECLSPEC_HIDDEN;
327 extern HRESULT node_select_singlenode(const xmlnode*,BSTR,IXMLDOMNode**) DECLSPEC_HIDDEN;
328 extern HRESULT node_transform_node(const xmlnode*,IXMLDOMNode*,BSTR*) DECLSPEC_HIDDEN;
330 extern HRESULT get_domdoc_from_xmldoc(xmlDocPtr xmldoc, IXMLDOMDocument3 **document) DECLSPEC_HIDDEN;
332 extern HRESULT SchemaCache_validate_tree(IXMLDOMSchemaCollection2* iface, xmlNodePtr tree) DECLSPEC_HIDDEN;
333 extern XDR_DT SchemaCache_get_node_dt(IXMLDOMSchemaCollection2* iface, xmlNodePtr node) DECLSPEC_HIDDEN;
335 extern XDR_DT str_to_dt(xmlChar const* str, int len /* calculated if -1 */) DECLSPEC_HIDDEN;
336 extern XDR_DT bstr_to_dt(OLECHAR const* bstr, int len /* calculated if -1 */) DECLSPEC_HIDDEN;
337 extern xmlChar const* dt_to_str(XDR_DT dt) DECLSPEC_HIDDEN;
338 extern const char* debugstr_dt(XDR_DT dt) DECLSPEC_HIDDEN;
339 extern OLECHAR const* dt_to_bstr(XDR_DT dt) DECLSPEC_HIDDEN;
340 extern HRESULT dt_validate(XDR_DT dt, xmlChar const* content) DECLSPEC_HIDDEN;
342 extern BSTR EnsureCorrectEOL(BSTR) DECLSPEC_HIDDEN;
344 extern xmlChar* tagName_to_XPath(const BSTR tagName) DECLSPEC_HIDDEN;
346 static inline BSTR bstr_from_xmlChar(const xmlChar *str)
348 BSTR ret = NULL;
350 if(str) {
351 DWORD len = MultiByteToWideChar(CP_UTF8, 0, (LPCSTR)str, -1, NULL, 0);
352 ret = SysAllocStringLen(NULL, len-1);
353 if(ret)
354 MultiByteToWideChar( CP_UTF8, 0, (LPCSTR)str, -1, ret, len);
356 else
357 ret = SysAllocStringLen(NULL, 0);
359 return ret;
362 static inline HRESULT return_bstr(const WCHAR *value, BSTR *p)
364 if(!p)
365 return E_INVALIDARG;
367 if(value) {
368 *p = SysAllocString(value);
369 if(!*p)
370 return E_OUTOFMEMORY;
371 }else {
372 *p = NULL;
375 return S_OK;
378 static inline HRESULT return_null_node(IXMLDOMNode **p)
380 if(!p)
381 return E_INVALIDARG;
382 *p = NULL;
383 return S_FALSE;
386 static inline HRESULT return_null_ptr(void **p)
388 if(!p)
389 return E_INVALIDARG;
390 *p = NULL;
391 return S_FALSE;
394 static inline HRESULT return_null_var(VARIANT *p)
396 if(!p)
397 return E_INVALIDARG;
399 V_VT(p) = VT_NULL;
400 return S_FALSE;
403 static inline HRESULT return_null_bstr(BSTR *p)
405 if(!p)
406 return E_INVALIDARG;
408 *p = NULL;
409 return S_FALSE;
412 static inline xmlChar *xmlchar_from_wcharn(const WCHAR *str, int nchars)
414 xmlChar *xmlstr;
415 DWORD len = WideCharToMultiByte( CP_UTF8, 0, str, nchars, NULL, 0, NULL, NULL );
417 xmlstr = heap_alloc( len+1 );
418 if ( xmlstr )
420 WideCharToMultiByte( CP_UTF8, 0, str, nchars, (LPSTR) xmlstr, len+1, NULL, NULL );
421 xmlstr[len] = 0;
423 return xmlstr;
426 static inline xmlChar *xmlchar_from_wchar( const WCHAR *str )
428 return xmlchar_from_wcharn(str, -1);
431 #endif
433 extern IXMLDOMParseError *create_parseError( LONG code, BSTR url, BSTR reason, BSTR srcText,
434 LONG line, LONG linepos, LONG filepos ) DECLSPEC_HIDDEN;
435 extern HRESULT DOMDocument_create(MSXML_VERSION, IUnknown*, void**) DECLSPEC_HIDDEN;
436 extern HRESULT SchemaCache_create(MSXML_VERSION, IUnknown*, void**) DECLSPEC_HIDDEN;
437 extern HRESULT XMLDocument_create(IUnknown*, void**) DECLSPEC_HIDDEN;
438 extern HRESULT SAXXMLReader_create(MSXML_VERSION, IUnknown*, void**) DECLSPEC_HIDDEN;
439 extern HRESULT XMLHTTPRequest_create(IUnknown*, void **) DECLSPEC_HIDDEN;
440 extern HRESULT XSLTemplate_create(IUnknown*, void**) DECLSPEC_HIDDEN;
441 extern HRESULT MXWriter_create(MSXML_VERSION, IUnknown*, void**) DECLSPEC_HIDDEN;
442 extern HRESULT MXNamespaceManager_create(IUnknown*,void**) DECLSPEC_HIDDEN;
443 extern HRESULT XMLParser_create(IUnknown*,void**) DECLSPEC_HIDDEN;
445 static inline const CLSID* DOMDocument_version(MSXML_VERSION v)
447 switch (v)
449 default:
450 case MSXML_DEFAULT: return &CLSID_DOMDocument;
451 case MSXML3: return &CLSID_DOMDocument30;
452 case MSXML4: return &CLSID_DOMDocument40;
453 case MSXML6: return &CLSID_DOMDocument60;
457 static inline const CLSID* SchemaCache_version(MSXML_VERSION v)
459 switch (v)
461 default:
462 case MSXML_DEFAULT: return &CLSID_XMLSchemaCache;
463 case MSXML3: return &CLSID_XMLSchemaCache30;
464 case MSXML4: return &CLSID_XMLSchemaCache40;
465 case MSXML6: return &CLSID_XMLSchemaCache60;
469 typedef struct bsc_t bsc_t;
471 HRESULT bind_url(LPCWSTR, HRESULT (*onDataAvailable)(void*,char*,DWORD), void*, bsc_t**) DECLSPEC_HIDDEN;
472 HRESULT detach_bsc(bsc_t*) DECLSPEC_HIDDEN;
474 const char *debugstr_variant(const VARIANT*) DECLSPEC_HIDDEN;
476 /* Error Codes - not defined anywhere in the public headers */
477 #define E_XML_ELEMENT_UNDECLARED 0xC00CE00D
478 #define E_XML_ELEMENT_ID_NOT_FOUND 0xC00CE00E
479 /* ... */
480 #define E_XML_EMPTY_NOT_ALLOWED 0xC00CE011
481 #define E_XML_ELEMENT_NOT_COMPLETE 0xC00CE012
482 #define E_XML_ROOT_NAME_MISMATCH 0xC00CE013
483 #define E_XML_INVALID_CONTENT 0xC00CE014
484 #define E_XML_ATTRIBUTE_NOT_DEFINED 0xC00CE015
485 #define E_XML_ATTRIBUTE_FIXED 0xC00CE016
486 #define E_XML_ATTRIBUTE_VALUE 0xC00CE017
487 #define E_XML_ILLEGAL_TEXT 0xC00CE018
488 /* ... */
489 #define E_XML_REQUIRED_ATTRIBUTE_MISSING 0xC00CE020
491 #endif /* __MSXML_PRIVATE__ */