mshtml: Wine Gecko 1.4 release.
[wine] / dlls / msxml3 / msxml_private.h
1 /*
2  *    Common definitions
3  *
4  * Copyright 2005 Mike McCormack
5  *
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.
10  *
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.
15  *
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
19  */
20
21 #ifndef __MSXML_PRIVATE__
22 #define __MSXML_PRIVATE__
23
24 #include "dispex.h"
25
26 #include "wine/unicode.h"
27
28 #ifndef __WINE_CONFIG_H
29 # error You must include config.h to use this header
30 #endif
31
32 typedef enum {
33     MSXML_DEFAULT = 0,
34     MSXML3 = 30,
35     MSXML4 = 40,
36     MSXML6 = 60
37 } MSXML_VERSION;
38
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;
81
82 /* The XDR datatypes (urn:schemas-microsoft-com:datatypes)
83  * These are actually valid for XSD schemas as well
84  * See datatypes.xsd
85  */
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)
126
127 extern HRESULT get_typeinfo(tid_t tid, ITypeInfo **typeinfo) DECLSPEC_HIDDEN;
128 extern void release_typelib(void) DECLSPEC_HIDDEN;
129
130 typedef struct dispex_data_t dispex_data_t;
131 typedef struct dispex_dynamic_data_t dispex_dynamic_data_t;
132
133 typedef struct {
134     HRESULT (*get_dispid)(IUnknown*,BSTR,DWORD,DISPID*);
135     HRESULT (*invoke)(IUnknown*,DISPID,LCID,WORD,DISPPARAMS*,VARIANT*,EXCEPINFO*);
136 } dispex_static_data_vtbl_t;
137
138 typedef struct {
139     const dispex_static_data_vtbl_t *vtbl;
140     const tid_t disp_tid;
141     dispex_data_t *data;
142     const tid_t* const iface_tids;
143 } dispex_static_data_t;
144
145 typedef struct {
146     IDispatchEx IDispatchEx_iface;
147
148     IUnknown *outer;
149
150     dispex_static_data_t *data;
151     dispex_dynamic_data_t *dynamic_data;
152 } DispatchEx;
153
154 extern HINSTANCE MSXML_hInstance DECLSPEC_HIDDEN;
155
156 void init_dispex(DispatchEx*,IUnknown*,dispex_static_data_t*) DECLSPEC_HIDDEN;
157 void release_dispex(DispatchEx*) DECLSPEC_HIDDEN;
158 BOOL dispex_query_interface(DispatchEx*,REFIID,void**) DECLSPEC_HIDDEN;
159
160 /* memory allocation functions */
161
162 static inline void *heap_alloc(size_t len)
163 {
164     return HeapAlloc(GetProcessHeap(), 0, len);
165 }
166
167 static inline void *heap_alloc_zero(size_t len)
168 {
169     return HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, len);
170 }
171
172 static inline void *heap_realloc(void *mem, size_t len)
173 {
174     return HeapReAlloc(GetProcessHeap(), 0, mem, len);
175 }
176
177 static inline BOOL heap_free(void *mem)
178 {
179     return HeapFree(GetProcessHeap(), 0, mem);
180 }
181
182 static inline LPWSTR heap_strdupW(LPCWSTR str)
183 {
184     LPWSTR ret = NULL;
185
186     if(str) {
187         DWORD size;
188
189         size = (strlenW(str)+1)*sizeof(WCHAR);
190         ret = heap_alloc(size);
191         memcpy(ret, str, size);
192     }
193
194     return ret;
195 }
196
197 static inline LPSTR heap_strdupWtoA(LPCWSTR str)
198 {
199     LPSTR ret = NULL;
200
201     if(str) {
202         DWORD len = WideCharToMultiByte(CP_ACP, 0, str, -1, NULL, 0, NULL, NULL);
203         ret = heap_alloc(len+1);
204         if(!ret)
205             return NULL;
206
207         WideCharToMultiByte(CP_ACP, 0, str, -1, ret, len+1, NULL, NULL);
208     }
209
210     return ret;
211 }
212
213 #ifdef HAVE_LIBXML2
214
215 extern void schemasInit(void) DECLSPEC_HIDDEN;
216 extern void schemasCleanup(void) DECLSPEC_HIDDEN;
217
218 #ifndef HAVE_XMLFIRSTELEMENTCHILD
219 static inline xmlNodePtr wine_xmlFirstElementChild(xmlNodePtr parent)
220 {
221     xmlNodePtr child;
222     for (child = parent->children; child != NULL; child = child->next)
223         if (child->type == XML_ELEMENT_NODE)
224             break;
225
226     return child;
227 }
228 #define xmlFirstElementChild wine_xmlFirstElementChild
229 #endif
230
231 /* constructors */
232 extern IUnknown         *create_domdoc( xmlNodePtr ) DECLSPEC_HIDDEN;
233 extern IUnknown         *create_xmldoc( void ) DECLSPEC_HIDDEN;
234 extern IXMLDOMNode      *create_node( xmlNodePtr ) DECLSPEC_HIDDEN;
235 extern IUnknown         *create_element( xmlNodePtr ) DECLSPEC_HIDDEN;
236 extern IUnknown         *create_attribute( xmlNodePtr ) DECLSPEC_HIDDEN;
237 extern IUnknown         *create_text( xmlNodePtr ) DECLSPEC_HIDDEN;
238 extern IUnknown         *create_pi( xmlNodePtr ) DECLSPEC_HIDDEN;
239 extern IUnknown         *create_comment( xmlNodePtr ) DECLSPEC_HIDDEN;
240 extern IUnknown         *create_cdata( xmlNodePtr ) DECLSPEC_HIDDEN;
241 extern IXMLDOMNodeList  *create_children_nodelist( xmlNodePtr ) DECLSPEC_HIDDEN;
242 extern IXMLDOMNamedNodeMap *create_nodemap( const xmlNodePtr ) DECLSPEC_HIDDEN;
243 extern IUnknown         *create_doc_Implementation(void) DECLSPEC_HIDDEN;
244 extern IUnknown         *create_doc_fragment( xmlNodePtr ) DECLSPEC_HIDDEN;
245 extern IUnknown         *create_doc_entity_ref( xmlNodePtr ) DECLSPEC_HIDDEN;
246 extern IUnknown         *create_doc_type( xmlNodePtr ) DECLSPEC_HIDDEN;
247 extern HRESULT           create_selection( xmlNodePtr, xmlChar*, IXMLDOMNodeList** ) DECLSPEC_HIDDEN;
248
249 /* data accessors */
250 xmlNodePtr xmlNodePtr_from_domnode( IXMLDOMNode *iface, xmlElementType type ) DECLSPEC_HIDDEN;
251
252 /* helpers */
253 extern xmlChar *xmlChar_from_wchar( LPCWSTR str ) DECLSPEC_HIDDEN;
254
255 extern void xmldoc_init( xmlDocPtr doc, MSXML_VERSION version ) DECLSPEC_HIDDEN;
256 extern LONG xmldoc_add_ref( xmlDocPtr doc ) DECLSPEC_HIDDEN;
257 extern LONG xmldoc_release( xmlDocPtr doc ) DECLSPEC_HIDDEN;
258 extern HRESULT xmldoc_add_orphan( xmlDocPtr doc, xmlNodePtr node ) DECLSPEC_HIDDEN;
259 extern HRESULT xmldoc_remove_orphan( xmlDocPtr doc, xmlNodePtr node ) DECLSPEC_HIDDEN;
260 extern void xmldoc_link_xmldecl(xmlDocPtr doc, xmlNodePtr node) DECLSPEC_HIDDEN;
261 extern xmlNodePtr xmldoc_unlink_xmldecl(xmlDocPtr doc) DECLSPEC_HIDDEN;
262
263 extern HRESULT XMLElement_create( IUnknown *pUnkOuter, xmlNodePtr node, LPVOID *ppObj, BOOL own ) DECLSPEC_HIDDEN;
264
265 extern void wineXmlCallbackLog(char const* caller, xmlErrorLevel lvl, char const* msg, va_list ap) DECLSPEC_HIDDEN;
266 extern void wineXmlCallbackError(char const* caller, xmlErrorPtr err) DECLSPEC_HIDDEN;
267
268 #define LIBXML2_LOG_CALLBACK __WINE_PRINTF_ATTR(2,3)
269
270 #define LIBXML2_CALLBACK_TRACE(caller, msg, ap) \
271         wineXmlCallbackLog(#caller, XML_ERR_NONE, msg, ap)
272
273 #define LIBXML2_CALLBACK_WARN(caller, msg, ap) \
274         wineXmlCallbackLog(#caller, XML_ERR_WARNING, msg, ap)
275
276 #define LIBXML2_CALLBACK_ERR(caller, msg, ap) \
277         wineXmlCallbackLog(#caller, XML_ERR_ERROR, msg, ap)
278
279 #define LIBXML2_CALLBACK_SERROR(caller, err) wineXmlCallbackError(#caller, err)
280
281 extern BOOL is_preserving_whitespace(xmlNodePtr node) DECLSPEC_HIDDEN;
282 extern BOOL is_xpathmode(const xmlDocPtr doc) DECLSPEC_HIDDEN;
283 extern void set_xpathmode(xmlDocPtr doc, BOOL xpath) DECLSPEC_HIDDEN;
284
285 /* IXMLDOMNode Internal Structure */
286 typedef struct _xmlnode
287 {
288     DispatchEx   dispex;
289     IXMLDOMNode *iface;
290     IXMLDOMNode *parent;
291     xmlNodePtr   node;
292 } xmlnode;
293
294 extern void init_xmlnode(xmlnode*,xmlNodePtr,IXMLDOMNode*,dispex_static_data_t*) DECLSPEC_HIDDEN;
295 extern void destroy_xmlnode(xmlnode*) DECLSPEC_HIDDEN;
296 extern BOOL node_query_interface(xmlnode*,REFIID,void**) DECLSPEC_HIDDEN;
297 extern xmlnode *get_node_obj(IXMLDOMNode*) DECLSPEC_HIDDEN;
298
299 extern HRESULT node_append_child(xmlnode*,IXMLDOMNode*,IXMLDOMNode**) DECLSPEC_HIDDEN;
300 extern HRESULT node_get_nodeName(xmlnode*,BSTR*) DECLSPEC_HIDDEN;
301 extern HRESULT node_get_content(xmlnode*,VARIANT*) DECLSPEC_HIDDEN;
302 extern HRESULT node_set_content(xmlnode*,LPCWSTR) DECLSPEC_HIDDEN;
303 extern HRESULT node_put_value(xmlnode*,VARIANT*) DECLSPEC_HIDDEN;
304 extern HRESULT node_put_value_escaped(xmlnode*,VARIANT*) DECLSPEC_HIDDEN;
305 extern HRESULT node_get_parent(xmlnode*,IXMLDOMNode**) DECLSPEC_HIDDEN;
306 extern HRESULT node_get_child_nodes(xmlnode*,IXMLDOMNodeList**) DECLSPEC_HIDDEN;
307 extern HRESULT node_get_first_child(xmlnode*,IXMLDOMNode**) DECLSPEC_HIDDEN;
308 extern HRESULT node_get_last_child(xmlnode*,IXMLDOMNode**) DECLSPEC_HIDDEN;
309 extern HRESULT node_get_previous_sibling(xmlnode*,IXMLDOMNode**) DECLSPEC_HIDDEN;
310 extern HRESULT node_get_next_sibling(xmlnode*,IXMLDOMNode**) DECLSPEC_HIDDEN;
311 extern HRESULT node_insert_before(xmlnode*,IXMLDOMNode*,const VARIANT*,IXMLDOMNode**) DECLSPEC_HIDDEN;
312 extern HRESULT node_replace_child(xmlnode*,IXMLDOMNode*,IXMLDOMNode*,IXMLDOMNode**) DECLSPEC_HIDDEN;
313 extern HRESULT node_put_text(xmlnode*,BSTR) DECLSPEC_HIDDEN;
314 extern HRESULT node_get_xml(xmlnode*,BOOL,BOOL,BSTR*) DECLSPEC_HIDDEN;
315 extern HRESULT node_clone(xmlnode*,VARIANT_BOOL,IXMLDOMNode**) DECLSPEC_HIDDEN;
316 extern HRESULT node_get_prefix(xmlnode*,BSTR*) DECLSPEC_HIDDEN;
317 extern HRESULT node_get_base_name(xmlnode*,BSTR*) DECLSPEC_HIDDEN;
318 extern HRESULT node_get_namespaceURI(xmlnode*,BSTR*) DECLSPEC_HIDDEN;
319 extern HRESULT node_remove_child(xmlnode*,IXMLDOMNode*,IXMLDOMNode**) DECLSPEC_HIDDEN;
320 extern HRESULT node_has_childnodes(const xmlnode*,VARIANT_BOOL*) DECLSPEC_HIDDEN;
321 extern HRESULT node_get_owner_doc(const xmlnode*,IXMLDOMDocument**) DECLSPEC_HIDDEN;
322 extern HRESULT node_get_text(const xmlnode*,BSTR*) DECLSPEC_HIDDEN;
323 extern HRESULT node_select_nodes(const xmlnode*,BSTR,IXMLDOMNodeList**) DECLSPEC_HIDDEN;
324 extern HRESULT node_select_singlenode(const xmlnode*,BSTR,IXMLDOMNode**) DECLSPEC_HIDDEN;
325 extern HRESULT node_transform_node(const xmlnode*,IXMLDOMNode*,BSTR*) DECLSPEC_HIDDEN;
326
327 extern HRESULT get_domdoc_from_xmldoc(xmlDocPtr xmldoc, IXMLDOMDocument3 **document) DECLSPEC_HIDDEN;
328
329 extern HRESULT SchemaCache_validate_tree(IXMLDOMSchemaCollection2* iface, xmlNodePtr tree) DECLSPEC_HIDDEN;
330 extern XDR_DT  SchemaCache_get_node_dt(IXMLDOMSchemaCollection2* iface, xmlNodePtr node) DECLSPEC_HIDDEN;
331
332 extern XDR_DT str_to_dt(xmlChar const* str, int len /* calculated if -1 */) DECLSPEC_HIDDEN;
333 extern XDR_DT bstr_to_dt(OLECHAR const* bstr, int len /* calculated if -1 */) DECLSPEC_HIDDEN;
334 extern xmlChar const* dt_to_str(XDR_DT dt) DECLSPEC_HIDDEN;
335 extern const char* debugstr_dt(XDR_DT dt) DECLSPEC_HIDDEN;
336 extern OLECHAR const* dt_to_bstr(XDR_DT dt) DECLSPEC_HIDDEN;
337 extern HRESULT dt_validate(XDR_DT dt, xmlChar const* content) DECLSPEC_HIDDEN;
338
339 extern BSTR EnsureCorrectEOL(BSTR) DECLSPEC_HIDDEN;
340
341 extern xmlChar* tagName_to_XPath(const BSTR tagName) DECLSPEC_HIDDEN;
342
343 static inline BSTR bstr_from_xmlChar(const xmlChar *str)
344 {
345     BSTR ret = NULL;
346
347     if(str) {
348         DWORD len = MultiByteToWideChar(CP_UTF8, 0, (LPCSTR)str, -1, NULL, 0);
349         ret = SysAllocStringLen(NULL, len-1);
350         if(ret)
351             MultiByteToWideChar( CP_UTF8, 0, (LPCSTR)str, -1, ret, len);
352     }
353     else
354         ret = SysAllocStringLen(NULL, 0);
355
356     return ret;
357 }
358
359 static inline HRESULT return_bstr(const WCHAR *value, BSTR *p)
360 {
361     if(!p)
362         return E_INVALIDARG;
363
364     if(value) {
365         *p = SysAllocString(value);
366         if(!*p)
367             return E_OUTOFMEMORY;
368     }else {
369         *p = NULL;
370     }
371
372     return S_OK;
373 }
374
375 static inline HRESULT return_null_node(IXMLDOMNode **p)
376 {
377     if(!p)
378         return E_INVALIDARG;
379     *p = NULL;
380     return S_FALSE;
381 }
382
383 static inline HRESULT return_null_ptr(void **p)
384 {
385     if(!p)
386         return E_INVALIDARG;
387     *p = NULL;
388     return S_FALSE;
389 }
390
391 static inline HRESULT return_null_var(VARIANT *p)
392 {
393     if(!p)
394         return E_INVALIDARG;
395
396     V_VT(p) = VT_NULL;
397     return S_FALSE;
398 }
399
400 static inline HRESULT return_null_bstr(BSTR *p)
401 {
402     if(!p)
403         return E_INVALIDARG;
404
405     *p = NULL;
406     return S_FALSE;
407 }
408
409 static inline xmlChar *xmlchar_from_wcharn(const WCHAR *str, int nchars)
410 {
411     xmlChar *xmlstr;
412     DWORD len = WideCharToMultiByte( CP_UTF8, 0, str, nchars, NULL, 0, NULL, NULL );
413
414     xmlstr = heap_alloc( len+1 );
415     if ( xmlstr )
416     {
417         WideCharToMultiByte( CP_UTF8, 0, str, nchars, (LPSTR) xmlstr, len+1, NULL, NULL );
418         xmlstr[len] = 0;
419     }
420     return xmlstr;
421 }
422
423 static inline xmlChar *xmlchar_from_wchar( const WCHAR *str )
424 {
425     return xmlchar_from_wcharn(str, -1);
426 }
427
428 #endif
429
430 extern IXMLDOMParseError *create_parseError( LONG code, BSTR url, BSTR reason, BSTR srcText,
431                                              LONG line, LONG linepos, LONG filepos ) DECLSPEC_HIDDEN;
432 extern HRESULT DOMDocument_create(MSXML_VERSION, IUnknown*, void**) DECLSPEC_HIDDEN;
433 extern HRESULT SchemaCache_create(MSXML_VERSION, IUnknown*, void**) DECLSPEC_HIDDEN;
434 extern HRESULT XMLDocument_create(IUnknown*, void**) DECLSPEC_HIDDEN;
435 extern HRESULT SAXXMLReader_create(MSXML_VERSION, IUnknown*, void**) DECLSPEC_HIDDEN;
436 extern HRESULT XMLHTTPRequest_create(IUnknown*, void **) DECLSPEC_HIDDEN;
437 extern HRESULT XSLTemplate_create(IUnknown*, void**) DECLSPEC_HIDDEN;
438 extern HRESULT MXWriter_create(MSXML_VERSION, IUnknown*, void**) DECLSPEC_HIDDEN;
439 extern HRESULT MXNamespaceManager_create(IUnknown*,void**) DECLSPEC_HIDDEN;
440 extern HRESULT XMLParser_create(IUnknown*,void**) DECLSPEC_HIDDEN;
441
442 static inline const CLSID* DOMDocument_version(MSXML_VERSION v)
443 {
444     switch (v)
445     {
446     default:
447     case MSXML_DEFAULT: return &CLSID_DOMDocument;
448     case MSXML3: return &CLSID_DOMDocument30;
449     case MSXML4: return &CLSID_DOMDocument40;
450     case MSXML6: return &CLSID_DOMDocument60;
451     }
452 }
453
454 static inline const CLSID* SchemaCache_version(MSXML_VERSION v)
455 {
456     switch (v)
457     {
458     default:
459     case MSXML_DEFAULT: return &CLSID_XMLSchemaCache;
460     case MSXML3: return &CLSID_XMLSchemaCache30;
461     case MSXML4: return &CLSID_XMLSchemaCache40;
462     case MSXML6: return &CLSID_XMLSchemaCache60;
463     }
464 }
465
466 typedef struct bsc_t bsc_t;
467
468 HRESULT bind_url(LPCWSTR, HRESULT (*onDataAvailable)(void*,char*,DWORD), void*, bsc_t**) DECLSPEC_HIDDEN;
469 HRESULT detach_bsc(bsc_t*) DECLSPEC_HIDDEN;
470
471 const char *debugstr_variant(const VARIANT*) DECLSPEC_HIDDEN;
472
473 /* Error Codes - not defined anywhere in the public headers */
474 #define E_XML_ELEMENT_UNDECLARED            0xC00CE00D
475 #define E_XML_ELEMENT_ID_NOT_FOUND          0xC00CE00E
476 /* ... */
477 #define E_XML_EMPTY_NOT_ALLOWED             0xC00CE011
478 #define E_XML_ELEMENT_NOT_COMPLETE          0xC00CE012
479 #define E_XML_ROOT_NAME_MISMATCH            0xC00CE013
480 #define E_XML_INVALID_CONTENT               0xC00CE014
481 #define E_XML_ATTRIBUTE_NOT_DEFINED         0xC00CE015
482 #define E_XML_ATTRIBUTE_FIXED               0xC00CE016
483 #define E_XML_ATTRIBUTE_VALUE               0xC00CE017
484 #define E_XML_ILLEGAL_TEXT                  0xC00CE018
485 /* ... */
486 #define E_XML_REQUIRED_ATTRIBUTE_MISSING    0xC00CE020
487
488 #endif /* __MSXML_PRIVATE__ */