hlink: Site data should only be set if the hlink has an HlinkSite.
[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     IXMLDOMElement_tid,
41     IXMLDOMEntityReference_tid,
42     IXMLDOMImplementation_tid,
43     IXMLDOMNamedNodeMap_tid,
44     IXMLDOMNode_tid,
45     IXMLDOMNodeList_tid,
46     IXMLDOMParseError_tid,
47     IXMLDOMProcessingInstruction_tid,
48     IXMLDOMSchemaCollection_tid,
49     IXMLDOMSelection_tid,
50     IXMLDOMText_tid,
51     IXMLElement_tid,
52     IXMLDocument_tid,
53     IXMLHTTPRequest_tid,
54     IVBSAXAttributes_tid,
55     IVBSAXContentHandler_tid,
56     IVBSAXDeclHandler_tid,
57     IVBSAXDTDHandler_tid,
58     IVBSAXEntityResolver_tid,
59     IVBSAXErrorHandler_tid,
60     IVBSAXLexicalHandler_tid,
61     IVBSAXLocator_tid,
62     IVBSAXXMLFilter_tid,
63     IVBSAXXMLReader_tid,
64     IMXAttributes_tid,
65     IMXReaderControl_tid,
66     IMXWriter_tid,
67     LAST_tid
68 } tid_t;
69
70 extern HRESULT get_typeinfo(tid_t tid, ITypeInfo **typeinfo);
71 extern void release_typelib(void);
72
73 typedef struct dispex_data_t dispex_data_t;
74 typedef struct dispex_dynamic_data_t dispex_dynamic_data_t;
75
76 #define MSXML_DISPID_CUSTOM_MIN 0x60000000
77 #define MSXML_DISPID_CUSTOM_MAX 0x6fffffff
78
79 typedef struct {
80     HRESULT (*get_dispid)(IUnknown*,BSTR,DWORD,DISPID*);
81     HRESULT (*invoke)(IUnknown*,DISPID,LCID,WORD,DISPPARAMS*,VARIANT*,EXCEPINFO*);
82 } dispex_static_data_vtbl_t;
83
84 typedef struct {
85     const dispex_static_data_vtbl_t *vtbl;
86     const tid_t disp_tid;
87     dispex_data_t *data;
88     const tid_t* const iface_tids;
89 } dispex_static_data_t;
90
91 typedef struct {
92     const IDispatchExVtbl  *lpIDispatchExVtbl;
93
94     IUnknown *outer;
95
96     dispex_static_data_t *data;
97     dispex_dynamic_data_t *dynamic_data;
98 } DispatchEx;
99
100 void init_dispex(DispatchEx*,IUnknown*,dispex_static_data_t*);
101 BOOL dispex_query_interface(DispatchEx*,REFIID,void**);
102
103 #ifdef HAVE_LIBXML2
104
105 #ifdef HAVE_LIBXML_PARSER_H
106 #include <libxml/parser.h>
107 #endif
108
109
110 #include <libxml/xmlerror.h>
111
112 /* constructors */
113 extern IUnknown         *create_domdoc( xmlNodePtr document );
114 extern IUnknown         *create_xmldoc( void );
115 extern IXMLDOMNode      *create_node( xmlNodePtr node );
116 extern IUnknown         *create_element( xmlNodePtr element );
117 extern IUnknown         *create_attribute( xmlNodePtr attribute );
118 extern IUnknown         *create_text( xmlNodePtr text );
119 extern IUnknown         *create_pi( xmlNodePtr pi );
120 extern IUnknown         *create_comment( xmlNodePtr comment );
121 extern IUnknown         *create_cdata( xmlNodePtr text );
122 extern IXMLDOMNodeList  *create_children_nodelist( xmlNodePtr );
123 extern IXMLDOMNamedNodeMap *create_nodemap( IXMLDOMNode *node );
124 extern IUnknown         *create_doc_Implementation(void);
125 extern IUnknown         *create_doc_fragment( xmlNodePtr fragment );
126 extern IUnknown         *create_doc_entity_ref( xmlNodePtr entity );
127
128 extern HRESULT queryresult_create( xmlNodePtr, LPCWSTR, IXMLDOMNodeList ** );
129
130 /* data accessors */
131 xmlNodePtr xmlNodePtr_from_domnode( IXMLDOMNode *iface, xmlElementType type );
132
133 /* helpers */
134 extern xmlChar *xmlChar_from_wchar( LPCWSTR str );
135
136 extern void xmldoc_init( xmlDocPtr doc, const GUID *clsid );
137 extern LONG xmldoc_add_ref( xmlDocPtr doc );
138 extern LONG xmldoc_release( xmlDocPtr doc );
139 extern HRESULT xmldoc_add_orphan( xmlDocPtr doc, xmlNodePtr node );
140 extern HRESULT xmldoc_remove_orphan( xmlDocPtr doc, xmlNodePtr node );
141 extern void xmldoc_link_xmldecl(xmlDocPtr doc, xmlNodePtr node);
142 extern xmlNodePtr xmldoc_unlink_xmldecl(xmlDocPtr doc);
143
144 extern HRESULT XMLElement_create( IUnknown *pUnkOuter, xmlNodePtr node, LPVOID *ppObj, BOOL own );
145
146 extern void wineXmlCallbackLog(char const* caller, xmlErrorLevel lvl, char const* msg, va_list ap);
147
148 #define LIBXML2_LOG_CALLBACK __WINE_PRINTF_ATTR(2,3)
149
150 #define LIBXML2_CALLBACK_TRACE(caller, msg, ap) \
151         wineXmlCallbackLog(#caller, XML_ERR_NONE, msg, ap)
152
153 #define LIBXML2_CALLBACK_WARN(caller, msg, ap) \
154         wineXmlCallbackLog(#caller, XML_ERR_WARNING, msg, ap)
155
156 #define LIBXML2_CALLBACK_ERR(caller, msg, ap) \
157         wineXmlCallbackLog(#caller, XML_ERR_ERROR, msg, ap)
158
159 #define LIBXML2_CALLBACK_SERROR(caller, err) \
160         wineXmlCallbackLog(#caller, err->level, err->message, NULL)
161
162 /* IXMLDOMNode Internal Structure */
163 typedef struct _xmlnode
164 {
165     DispatchEx dispex;
166     const struct IXMLDOMNodeVtbl *lpVtbl;
167     IXMLDOMNode *iface;
168     xmlNodePtr node;
169 } xmlnode;
170
171 static inline IXMLDOMNode *IXMLDOMNode_from_impl(xmlnode *This)
172 {
173     return (IXMLDOMNode*)&This->lpVtbl;
174 }
175
176 extern void init_xmlnode(xmlnode*,xmlNodePtr,IXMLDOMNode*,dispex_static_data_t*);
177 extern void destroy_xmlnode(xmlnode*);
178 extern BOOL node_query_interface(xmlnode*,REFIID,void**);
179 extern xmlnode *get_node_obj(IXMLDOMNode*);
180
181 extern HRESULT node_get_nodeName(xmlnode*,BSTR*);
182 extern HRESULT node_get_content(xmlnode*,VARIANT*);
183 extern HRESULT node_set_content(xmlnode*,LPCWSTR);
184 extern HRESULT node_put_value(xmlnode*,VARIANT*);
185 extern HRESULT node_get_parent(xmlnode*,IXMLDOMNode**);
186 extern HRESULT node_get_child_nodes(xmlnode*,IXMLDOMNodeList**);
187 extern HRESULT node_get_first_child(xmlnode*,IXMLDOMNode**);
188 extern HRESULT node_get_last_child(xmlnode*,IXMLDOMNode**);
189 extern HRESULT node_get_previous_sibling(xmlnode*,IXMLDOMNode**);
190 extern HRESULT node_get_next_sibling(xmlnode*,IXMLDOMNode**);
191 extern HRESULT node_insert_before(xmlnode*,IXMLDOMNode*,const VARIANT*,IXMLDOMNode**);
192 extern HRESULT node_replace_child(xmlnode*,IXMLDOMNode*,IXMLDOMNode*,IXMLDOMNode**);
193 extern HRESULT node_put_text(xmlnode*,BSTR);
194 extern HRESULT node_get_xml(xmlnode*,BOOL,BOOL,BSTR*);
195 extern HRESULT node_clone(xmlnode*,VARIANT_BOOL,IXMLDOMNode**);
196 extern HRESULT node_get_prefix(xmlnode*,BSTR*);
197 extern HRESULT node_get_base_name(xmlnode*,BSTR*);
198
199 extern HRESULT DOMDocument_create_from_xmldoc(xmlDocPtr xmldoc, IXMLDOMDocument3 **document);
200
201 static inline BSTR bstr_from_xmlChar(const xmlChar *str)
202 {
203     BSTR ret = NULL;
204
205     if(str) {
206         DWORD len = MultiByteToWideChar(CP_UTF8, 0, (LPCSTR)str, -1, NULL, 0);
207         ret = SysAllocStringLen(NULL, len-1);
208         if(ret)
209             MultiByteToWideChar( CP_UTF8, 0, (LPCSTR)str, -1, ret, len);
210     }
211     else
212         ret = SysAllocStringLen(NULL, 0);
213
214     return ret;
215 }
216
217 static inline HRESULT return_bstr(const WCHAR *value, BSTR *p)
218 {
219     if(!p)
220         return E_INVALIDARG;
221
222     if(value) {
223         *p = SysAllocString(value);
224         if(!*p)
225             return E_OUTOFMEMORY;
226     }else {
227         *p = NULL;
228     }
229
230     return S_OK;
231 }
232
233 static inline HRESULT return_null_node(IXMLDOMNode **p)
234 {
235     if(!p)
236         return E_INVALIDARG;
237     *p = NULL;
238     return S_FALSE;
239 }
240
241 static inline HRESULT return_null_ptr(void **p)
242 {
243     if(!p)
244         return E_INVALIDARG;
245     *p = NULL;
246     return S_FALSE;
247 }
248
249 static inline HRESULT return_null_var(VARIANT *p)
250 {
251     if(!p)
252         return E_INVALIDARG;
253
254     V_VT(p) = VT_NULL;
255     return S_FALSE;
256 }
257
258 static inline HRESULT return_null_bstr(BSTR *p)
259 {
260     if(!p)
261         return E_INVALIDARG;
262
263     *p = NULL;
264     return S_FALSE;
265 }
266
267 #endif
268
269 extern void* libxslt_handle;
270 #ifdef SONAME_LIBXSLT
271 # ifdef HAVE_LIBXSLT_PATTERN_H
272 #  include <libxslt/pattern.h>
273 # endif
274 # ifdef HAVE_LIBXSLT_TRANSFORM_H
275 #  include <libxslt/transform.h>
276 # endif
277 # include <libxslt/xsltutils.h>
278 # include <libxslt/xsltInternals.h>
279
280 # define MAKE_FUNCPTR(f) extern typeof(f) * p##f
281 MAKE_FUNCPTR(xsltApplyStylesheet);
282 MAKE_FUNCPTR(xsltCleanupGlobals);
283 MAKE_FUNCPTR(xsltFreeStylesheet);
284 MAKE_FUNCPTR(xsltParseStylesheetDoc);
285 # undef MAKE_FUNCPTR
286 #endif
287
288 extern IXMLDOMParseError *create_parseError( LONG code, BSTR url, BSTR reason, BSTR srcText,
289                                              LONG line, LONG linepos, LONG filepos );
290 extern HRESULT DOMDocument_create( const GUID *clsid, IUnknown *pUnkOuter, void **ppObj );
291 extern HRESULT SchemaCache_create( IUnknown *pUnkOuter, void **pObj );
292 extern HRESULT XMLDocument_create( IUnknown *pUnkOuter, void **pObj );
293 extern HRESULT SAXXMLReader_create(IUnknown *pUnkOuter, void **pObj );
294 extern HRESULT XMLHTTPRequest_create(IUnknown *pUnkOuter, void **pObj);
295
296 typedef struct bsc_t bsc_t;
297
298 HRESULT bind_url(LPCWSTR, HRESULT (*onDataAvailable)(void*,char*,DWORD), void*, bsc_t**);
299 void detach_bsc(bsc_t*);
300
301 /* memory allocation functions */
302
303 static inline void *heap_alloc(size_t len)
304 {
305     return HeapAlloc(GetProcessHeap(), 0, len);
306 }
307
308 static inline void *heap_alloc_zero(size_t len)
309 {
310     return HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, len);
311 }
312
313 static inline void *heap_realloc(void *mem, size_t len)
314 {
315     return HeapReAlloc(GetProcessHeap(), 0, mem, len);
316 }
317
318 static inline BOOL heap_free(void *mem)
319 {
320     return HeapFree(GetProcessHeap(), 0, mem);
321 }
322
323 static inline LPWSTR heap_strdupW(LPCWSTR str)
324 {
325     LPWSTR ret = NULL;
326
327     if(str) {
328         DWORD size;
329
330         size = (strlenW(str)+1)*sizeof(WCHAR);
331         ret = heap_alloc(size);
332         memcpy(ret, str, size);
333     }
334
335     return ret;
336 }
337
338 #endif /* __MSXML_PRIVATE__ */