msvcrt: Implemented _ltoa_s.
[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 /* typelibs */
33 typedef enum tid_t {
34     IXMLDOMAttribute_tid,
35     IXMLDOMCDATASection_tid,
36     IXMLDOMComment_tid,
37     IXMLDOMDocument_tid,
38     IXMLDOMDocument2_tid,
39     IXMLDOMDocumentFragment_tid,
40     IXMLDOMDocumentType_tid,
41     IXMLDOMElement_tid,
42     IXMLDOMEntityReference_tid,
43     IXMLDOMImplementation_tid,
44     IXMLDOMNamedNodeMap_tid,
45     IXMLDOMNode_tid,
46     IXMLDOMNodeList_tid,
47     IXMLDOMParseError_tid,
48     IXMLDOMProcessingInstruction_tid,
49     IXMLDOMSchemaCollection_tid,
50     IXMLDOMSelection_tid,
51     IXMLDOMText_tid,
52     IXMLElement_tid,
53     IXMLDocument_tid,
54     IXMLHTTPRequest_tid,
55     IVBSAXAttributes_tid,
56     IVBSAXContentHandler_tid,
57     IVBSAXDeclHandler_tid,
58     IVBSAXDTDHandler_tid,
59     IVBSAXEntityResolver_tid,
60     IVBSAXErrorHandler_tid,
61     IVBSAXLexicalHandler_tid,
62     IVBSAXLocator_tid,
63     IVBSAXXMLFilter_tid,
64     IVBSAXXMLReader_tid,
65     IMXAttributes_tid,
66     IMXReaderControl_tid,
67     IMXWriter_tid,
68     LAST_tid
69 } tid_t;
70
71 /* The XDR datatypes (urn:schemas-microsoft-com:datatypes)
72  * These are actually valid for XSD schemas as well
73  * See datatypes.xsd
74  */
75 typedef enum _XDR_DT {
76     DT_INVALID = -1,
77     DT_BIN_BASE64,
78     DT_BIN_HEX,
79     DT_BOOLEAN,
80     DT_CHAR,
81     DT_DATE,
82     DT_DATE_TZ,
83     DT_DATETIME,
84     DT_DATETIME_TZ,
85     DT_ENTITY,
86     DT_ENTITIES,
87     DT_ENUMERATION,
88     DT_FIXED_14_4,
89     DT_FLOAT,
90     DT_I1,
91     DT_I2,
92     DT_I4,
93     DT_I8,
94     DT_ID,
95     DT_IDREF,
96     DT_IDREFS,
97     DT_INT,
98     DT_NMTOKEN,
99     DT_NMTOKENS,
100     DT_NOTATION,
101     DT_NUMBER,
102     DT_R4,
103     DT_R8,
104     DT_STRING,
105     DT_TIME,
106     DT_TIME_TZ,
107     DT_UI1,
108     DT_UI2,
109     DT_UI4,
110     DT_UI8,
111     DT_URI,
112     DT_UUID
113 } XDR_DT;
114 #define DT__N_TYPES  (DT_UUID+1)
115
116 extern HRESULT get_typeinfo(tid_t tid, ITypeInfo **typeinfo);
117 extern void release_typelib(void);
118
119 typedef struct dispex_data_t dispex_data_t;
120 typedef struct dispex_dynamic_data_t dispex_dynamic_data_t;
121
122 #define MSXML_DISPID_CUSTOM_MIN 0x60000000
123 #define MSXML_DISPID_CUSTOM_MAX 0x6fffffff
124
125 typedef struct {
126     HRESULT (*get_dispid)(IUnknown*,BSTR,DWORD,DISPID*);
127     HRESULT (*invoke)(IUnknown*,DISPID,LCID,WORD,DISPPARAMS*,VARIANT*,EXCEPINFO*);
128 } dispex_static_data_vtbl_t;
129
130 typedef struct {
131     const dispex_static_data_vtbl_t *vtbl;
132     const tid_t disp_tid;
133     dispex_data_t *data;
134     const tid_t* const iface_tids;
135 } dispex_static_data_t;
136
137 typedef struct {
138     const IDispatchExVtbl  *lpIDispatchExVtbl;
139
140     IUnknown *outer;
141
142     dispex_static_data_t *data;
143     dispex_dynamic_data_t *dynamic_data;
144 } DispatchEx;
145
146 extern HINSTANCE MSXML_hInstance;
147
148 void init_dispex(DispatchEx*,IUnknown*,dispex_static_data_t*);
149 BOOL dispex_query_interface(DispatchEx*,REFIID,void**);
150
151 #ifdef HAVE_LIBXML2
152
153 #ifdef HAVE_LIBXML_PARSER_H
154 #include <libxml/parser.h>
155 #endif
156
157
158
159 #include <libxml/xmlerror.h>
160
161 extern void schemasInit(void);
162 extern void schemasCleanup(void);
163
164 #ifndef HAVE_XMLFIRSTELEMENTCHILD
165     static inline xmlNodePtr xmlFirstElementChild(xmlNodePtr parent)
166     {
167     xmlNodePtr child;
168     for (child = parent->children; child != NULL; child = child->next)
169         if (child->type == XML_ELEMENT_NODE)
170             break;
171
172     return child;
173 }
174 #endif
175
176 /* constructors */
177 extern IUnknown         *create_domdoc( xmlNodePtr document );
178 extern IUnknown         *create_xmldoc( void );
179 extern IXMLDOMNode      *create_node( xmlNodePtr node );
180 extern IUnknown         *create_element( xmlNodePtr element );
181 extern IUnknown         *create_attribute( xmlNodePtr attribute );
182 extern IUnknown         *create_text( xmlNodePtr text );
183 extern IUnknown         *create_pi( xmlNodePtr pi );
184 extern IUnknown         *create_comment( xmlNodePtr comment );
185 extern IUnknown         *create_cdata( xmlNodePtr text );
186 extern IXMLDOMNodeList  *create_children_nodelist( xmlNodePtr );
187 extern IXMLDOMNamedNodeMap *create_nodemap( IXMLDOMNode *node );
188 extern IUnknown         *create_doc_Implementation(void);
189 extern IUnknown         *create_doc_fragment( xmlNodePtr fragment );
190 extern IUnknown         *create_doc_entity_ref( xmlNodePtr entity );
191 extern IUnknown         *create_doc_type( xmlNodePtr doctype );
192
193 extern HRESULT queryresult_create( xmlNodePtr, LPCWSTR, IXMLDOMNodeList ** );
194
195 /* data accessors */
196 xmlNodePtr xmlNodePtr_from_domnode( IXMLDOMNode *iface, xmlElementType type );
197
198 /* helpers */
199 extern xmlChar *xmlChar_from_wchar( LPCWSTR str );
200
201 extern void xmldoc_init( xmlDocPtr doc, const GUID *clsid );
202 extern LONG xmldoc_add_ref( xmlDocPtr doc );
203 extern LONG xmldoc_release( xmlDocPtr doc );
204 extern HRESULT xmldoc_add_orphan( xmlDocPtr doc, xmlNodePtr node );
205 extern HRESULT xmldoc_remove_orphan( xmlDocPtr doc, xmlNodePtr node );
206 extern void xmldoc_link_xmldecl(xmlDocPtr doc, xmlNodePtr node);
207 extern xmlNodePtr xmldoc_unlink_xmldecl(xmlDocPtr doc);
208
209 extern HRESULT XMLElement_create( IUnknown *pUnkOuter, xmlNodePtr node, LPVOID *ppObj, BOOL own );
210
211 extern void wineXmlCallbackLog(char const* caller, xmlErrorLevel lvl, char const* msg, va_list ap);
212
213 #define LIBXML2_LOG_CALLBACK __WINE_PRINTF_ATTR(2,3)
214
215 #define LIBXML2_CALLBACK_TRACE(caller, msg, ap) \
216         wineXmlCallbackLog(#caller, XML_ERR_NONE, msg, ap)
217
218 #define LIBXML2_CALLBACK_WARN(caller, msg, ap) \
219         wineXmlCallbackLog(#caller, XML_ERR_WARNING, msg, ap)
220
221 #define LIBXML2_CALLBACK_ERR(caller, msg, ap) \
222         wineXmlCallbackLog(#caller, XML_ERR_ERROR, msg, ap)
223
224 #define LIBXML2_CALLBACK_SERROR(caller, err) \
225         wineXmlCallbackLog(#caller, err->level, err->message, NULL)
226
227 extern BOOL is_preserving_whitespace(xmlNodePtr node);
228
229 /* IXMLDOMNode Internal Structure */
230 typedef struct _xmlnode
231 {
232     DispatchEx dispex;
233     const struct IXMLDOMNodeVtbl *lpVtbl;
234     IXMLDOMNode *iface;
235     xmlNodePtr node;
236 } xmlnode;
237
238 static inline IXMLDOMNode *IXMLDOMNode_from_impl(xmlnode *This)
239 {
240     return (IXMLDOMNode*)&This->lpVtbl;
241 }
242
243 extern void init_xmlnode(xmlnode*,xmlNodePtr,IXMLDOMNode*,dispex_static_data_t*);
244 extern void destroy_xmlnode(xmlnode*);
245 extern BOOL node_query_interface(xmlnode*,REFIID,void**);
246 extern xmlnode *get_node_obj(IXMLDOMNode*);
247
248 extern HRESULT node_get_nodeName(xmlnode*,BSTR*);
249 extern HRESULT node_get_content(xmlnode*,VARIANT*);
250 extern HRESULT node_set_content(xmlnode*,LPCWSTR);
251 extern HRESULT node_put_value(xmlnode*,VARIANT*);
252 extern HRESULT node_put_value_escaped(xmlnode*,VARIANT*);
253 extern HRESULT node_get_parent(xmlnode*,IXMLDOMNode**);
254 extern HRESULT node_get_child_nodes(xmlnode*,IXMLDOMNodeList**);
255 extern HRESULT node_get_first_child(xmlnode*,IXMLDOMNode**);
256 extern HRESULT node_get_last_child(xmlnode*,IXMLDOMNode**);
257 extern HRESULT node_get_previous_sibling(xmlnode*,IXMLDOMNode**);
258 extern HRESULT node_get_next_sibling(xmlnode*,IXMLDOMNode**);
259 extern HRESULT node_insert_before(xmlnode*,IXMLDOMNode*,const VARIANT*,IXMLDOMNode**);
260 extern HRESULT node_replace_child(xmlnode*,IXMLDOMNode*,IXMLDOMNode*,IXMLDOMNode**);
261 extern HRESULT node_put_text(xmlnode*,BSTR);
262 extern HRESULT node_get_xml(xmlnode*,BOOL,BOOL,BSTR*);
263 extern HRESULT node_clone(xmlnode*,VARIANT_BOOL,IXMLDOMNode**);
264 extern HRESULT node_get_prefix(xmlnode*,BSTR*);
265 extern HRESULT node_get_base_name(xmlnode*,BSTR*);
266
267 extern HRESULT DOMDocument_create_from_xmldoc(xmlDocPtr xmldoc, IXMLDOMDocument3 **document);
268 extern HRESULT SchemaCache_validate_tree(IXMLDOMSchemaCollection2* iface, xmlNodePtr tree);
269 extern XDR_DT  SchemaCache_get_node_dt(IXMLDOMSchemaCollection2* iface, xmlNodePtr node);
270
271 extern XDR_DT dt_get_type(xmlChar const* str, int len /* calculated if -1 */);
272 extern xmlChar const* dt_get_str(XDR_DT dt);
273
274 extern BSTR EnsureCorrectEOL(BSTR);
275
276 static inline BSTR bstr_from_xmlChar(const xmlChar *str)
277 {
278     BSTR ret = NULL;
279
280     if(str) {
281         DWORD len = MultiByteToWideChar(CP_UTF8, 0, (LPCSTR)str, -1, NULL, 0);
282         ret = SysAllocStringLen(NULL, len-1);
283         if(ret)
284             MultiByteToWideChar( CP_UTF8, 0, (LPCSTR)str, -1, ret, len);
285     }
286     else
287         ret = SysAllocStringLen(NULL, 0);
288
289     return ret;
290 }
291
292 static inline HRESULT return_bstr(const WCHAR *value, BSTR *p)
293 {
294     if(!p)
295         return E_INVALIDARG;
296
297     if(value) {
298         *p = SysAllocString(value);
299         if(!*p)
300             return E_OUTOFMEMORY;
301     }else {
302         *p = NULL;
303     }
304
305     return S_OK;
306 }
307
308 static inline HRESULT return_null_node(IXMLDOMNode **p)
309 {
310     if(!p)
311         return E_INVALIDARG;
312     *p = NULL;
313     return S_FALSE;
314 }
315
316 static inline HRESULT return_null_ptr(void **p)
317 {
318     if(!p)
319         return E_INVALIDARG;
320     *p = NULL;
321     return S_FALSE;
322 }
323
324 static inline HRESULT return_null_var(VARIANT *p)
325 {
326     if(!p)
327         return E_INVALIDARG;
328
329     V_VT(p) = VT_NULL;
330     return S_FALSE;
331 }
332
333 static inline HRESULT return_null_bstr(BSTR *p)
334 {
335     if(!p)
336         return E_INVALIDARG;
337
338     *p = NULL;
339     return S_FALSE;
340 }
341
342 #endif
343
344 extern void* libxslt_handle;
345 #ifdef SONAME_LIBXSLT
346 # ifdef HAVE_LIBXSLT_PATTERN_H
347 #  include <libxslt/pattern.h>
348 # endif
349 # ifdef HAVE_LIBXSLT_TRANSFORM_H
350 #  include <libxslt/transform.h>
351 # endif
352 # include <libxslt/xsltutils.h>
353 # include <libxslt/xsltInternals.h>
354
355 # define MAKE_FUNCPTR(f) extern typeof(f) * p##f
356 MAKE_FUNCPTR(xsltApplyStylesheet);
357 MAKE_FUNCPTR(xsltCleanupGlobals);
358 MAKE_FUNCPTR(xsltFreeStylesheet);
359 MAKE_FUNCPTR(xsltParseStylesheetDoc);
360 # undef MAKE_FUNCPTR
361 #endif
362
363 extern IXMLDOMParseError *create_parseError( LONG code, BSTR url, BSTR reason, BSTR srcText,
364                                              LONG line, LONG linepos, LONG filepos );
365 extern HRESULT DOMDocument_create( const GUID *clsid, IUnknown *pUnkOuter, void **ppObj );
366 extern HRESULT SchemaCache_create( IUnknown *pUnkOuter, void **pObj );
367 extern HRESULT XMLDocument_create( IUnknown *pUnkOuter, void **pObj );
368 extern HRESULT SAXXMLReader_create(IUnknown *pUnkOuter, void **pObj );
369 extern HRESULT XMLHTTPRequest_create(IUnknown *pUnkOuter, void **pObj);
370
371 typedef struct bsc_t bsc_t;
372
373 HRESULT bind_url(LPCWSTR, HRESULT (*onDataAvailable)(void*,char*,DWORD), void*, bsc_t**);
374 void detach_bsc(bsc_t*);
375
376 /* memory allocation functions */
377
378 static inline void *heap_alloc(size_t len)
379 {
380     return HeapAlloc(GetProcessHeap(), 0, len);
381 }
382
383 static inline void *heap_alloc_zero(size_t len)
384 {
385     return HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, len);
386 }
387
388 static inline void *heap_realloc(void *mem, size_t len)
389 {
390     return HeapReAlloc(GetProcessHeap(), 0, mem, len);
391 }
392
393 static inline BOOL heap_free(void *mem)
394 {
395     return HeapFree(GetProcessHeap(), 0, mem);
396 }
397
398 static inline LPWSTR heap_strdupW(LPCWSTR str)
399 {
400     LPWSTR ret = NULL;
401
402     if(str) {
403         DWORD size;
404
405         size = (strlenW(str)+1)*sizeof(WCHAR);
406         ret = heap_alloc(size);
407         memcpy(ret, str, size);
408     }
409
410     return ret;
411 }
412
413 /* Error Codes - not defined anywhere in the public headers */
414 #define E_XML_ELEMENT_UNDECLARED            0xC00CE00D
415 #define E_XML_ELEMENT_ID_NOT_FOUND          0xC00CE00E
416 /* ... */
417 #define E_XML_EMPTY_NOT_ALLOWED             0xC00CE011
418 #define E_XML_ELEMENT_NOT_COMPLETE          0xC00CE012
419 #define E_XML_ROOT_NAME_MISMATCH            0xC00CE013
420 #define E_XML_INVALID_CONTENT               0xC00CE014
421 #define E_XML_ATTRIBUTE_NOT_DEFINED         0xC00CE015
422 #define E_XML_ATTRIBUTE_FIXED               0xC00CE016
423 #define E_XML_ATTRIBUTE_VALUE               0xC00CE017
424 #define E_XML_ILLEGAL_TEXT                  0xC00CE018
425 /* ... */
426 #define E_XML_REQUIRED_ATTRIBUTE_MISSING    0xC00CE020
427
428 #endif /* __MSXML_PRIVATE__ */