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