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 #include "wine/list.h"
  28
  29 #ifndef __WINE_CONFIG_H
  30 # error You must include config.h to use this header
  31 #endif
  32
  33 typedef enum {
  34     MSXML_DEFAULT = 0,
  35     MSXML2        = 20,
  36     MSXML26       = 26,
  37     MSXML3        = 30,
  38     MSXML4        = 40,
  39     MSXML6        = 60
  40 } MSXML_VERSION;
  41
  42 /* typelibs */
  43 typedef enum tid_t {
  44     NULL_tid,
  45     IXMLDOMAttribute_tid,
  46     IXMLDOMCDATASection_tid,
  47     IXMLDOMComment_tid,
  48     IXMLDOMDocument_tid,
  49     IXMLDOMDocument2_tid,
  50     IXMLDOMDocument3_tid,
  51     IXMLDOMDocumentFragment_tid,
  52     IXMLDOMDocumentType_tid,
  53     IXMLDOMElement_tid,
  54     IXMLDOMEntityReference_tid,
  55     IXMLDOMImplementation_tid,
  56     IXMLDOMNamedNodeMap_tid,
  57     IXMLDOMNode_tid,
  58     IXMLDOMNodeList_tid,
  59     IXMLDOMParseError2_tid,
  60     IXMLDOMProcessingInstruction_tid,
  61     IXMLDOMSchemaCollection_tid,
  62     IXMLDOMSchemaCollection2_tid,
  63     IXMLDOMSelection_tid,
  64     IXMLDOMText_tid,
  65     IXMLElement_tid,
  66     IXMLDocument_tid,
  67     IXMLHTTPRequest_tid,
  68     IXSLProcessor_tid,
  69     IXSLTemplate_tid,
  70     IVBSAXAttributes_tid,
  71     IVBSAXContentHandler_tid,
  72     IVBSAXDeclHandler_tid,
  73     IVBSAXDTDHandler_tid,
  74     IVBSAXEntityResolver_tid,
  75     IVBSAXErrorHandler_tid,
  76     IVBSAXLexicalHandler_tid,
  77     IVBSAXLocator_tid,
  78     IVBSAXXMLFilter_tid,
  79     IVBSAXXMLReader_tid,
  80     IMXAttributes_tid,
  81     IMXReaderControl_tid,
  82     IMXWriter_tid,
  83     IVBMXNamespaceManager_tid,
  84     IServerXMLHTTPRequest_tid,
  85     LAST_tid
  86 } tid_t;
  87
  88 /* The XDR datatypes (urn:schemas-microsoft-com:datatypes)
  89  * These are actually valid for XSD schemas as well
  90  * See datatypes.xsd
  91  */
  92 typedef enum _XDR_DT {
  93     DT_INVALID = -1,
  94     DT_BIN_BASE64,
  95     DT_BIN_HEX,
  96     DT_BOOLEAN,
  97     DT_CHAR,
  98     DT_DATE,
  99     DT_DATE_TZ,
 100     DT_DATETIME,
 101     DT_DATETIME_TZ,
 102     DT_ENTITY,
 103     DT_ENTITIES,
 104     DT_ENUMERATION,
 105     DT_FIXED_14_4,
 106     DT_FLOAT,
 107     DT_I1,
 108     DT_I2,
 109     DT_I4,
 110     DT_I8,
 111     DT_ID,
 112     DT_IDREF,
 113     DT_IDREFS,
 114     DT_INT,
 115     DT_NMTOKEN,
 116     DT_NMTOKENS,
 117     DT_NOTATION,
 118     DT_NUMBER,
 119     DT_R4,
 120     DT_R8,
 121     DT_STRING,
 122     DT_TIME,
 123     DT_TIME_TZ,
 124     DT_UI1,
 125     DT_UI2,
 126     DT_UI4,
 127     DT_UI8,
 128     DT_URI,
 129     DT_UUID,
 130     LAST_DT
 131 } XDR_DT;
 132
 133 extern HRESULT get_typeinfo(tid_t tid, ITypeInfo **typeinfo) DECLSPEC_HIDDEN;
 134 extern void release_typelib(void) DECLSPEC_HIDDEN;
 135
 136 typedef struct dispex_data_t dispex_data_t;
 137
 138 typedef struct {
 139     HRESULT (*get_dispid)(IUnknown*,BSTR,DWORD,DISPID*);
 140     HRESULT (*invoke)(IUnknown*,DISPID,LCID,WORD,DISPPARAMS*,VARIANT*,EXCEPINFO*);
 141 } dispex_static_data_vtbl_t;
 142
 143 typedef struct {
 144     const dispex_static_data_vtbl_t *vtbl;
 145     const tid_t disp_tid;
 146     dispex_data_t *data;
 147     const tid_t* const iface_tids;
 148 } dispex_static_data_t;
 149
 150 typedef struct {
 151     IDispatchEx IDispatchEx_iface;
 152
 153     IUnknown *outer;
 154
 155     dispex_static_data_t *data;
 156 } DispatchEx;
 157
 158 extern HINSTANCE MSXML_hInstance DECLSPEC_HIDDEN;
 159
 160 void init_dispex(DispatchEx*,IUnknown*,dispex_static_data_t*) DECLSPEC_HIDDEN;
 161 void release_dispex(DispatchEx*) DECLSPEC_HIDDEN;
 162 BOOL dispex_query_interface(DispatchEx*,REFIID,void**) DECLSPEC_HIDDEN;
 163 const IID *get_riid_from_tid(enum tid_t tid) DECLSPEC_HIDDEN;
 164
 165 /* memory allocation functions */
 166
 167 static inline void *heap_alloc(size_t len)
 168 {
 169     return HeapAlloc(GetProcessHeap(), 0, len);
 170 }
 171
 172 static inline void *heap_alloc_zero(size_t len)
 173 {
 174     return HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, len);
 175 }
 176
 177 static inline void *heap_realloc(void *mem, size_t len)
 178 {
 179     return HeapReAlloc(GetProcessHeap(), 0, mem, len);
 180 }
 181
 182 static inline void *heap_realloc_zero(void *mem, size_t len)
 183 {
 184     return HeapReAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, mem, len);
 185 }
 186
 187 static inline BOOL heap_free(void *mem)
 188 {
 189     return HeapFree(GetProcessHeap(), 0, mem);
 190 }
 191
 192 static inline LPWSTR heap_strdupW(LPCWSTR str)
 193 {
 194     LPWSTR ret = NULL;
 195
 196     if(str) {
 197         DWORD size;
 198
 199         size = (strlenW(str)+1)*sizeof(WCHAR);
 200         ret = heap_alloc(size);
 201         if(ret)
 202             memcpy(ret, str, size);
 203     }
 204
 205     return ret;
 206 }
 207
 208 static inline LPSTR heap_strdupWtoA(LPCWSTR str)
 209 {
 210     LPSTR ret = NULL;
 211
 212     if(str) {
 213         DWORD len = WideCharToMultiByte(CP_ACP, 0, str, -1, NULL, 0, NULL, NULL);
 214         ret = heap_alloc(len+1);
 215         if(!ret)
 216             return NULL;
 217
 218         WideCharToMultiByte(CP_ACP, 0, str, -1, ret, len+1, NULL, NULL);
 219     }
 220
 221     return ret;
 222 }
 223
 224 /* XSLProcessor parameter list */
 225 struct xslprocessor_par
 226 {
 227     struct list entry;
 228     BSTR name;
 229     BSTR value;
 230 };
 231
 232 struct xslprocessor_params
 233 {
 234     struct list  list;
 235     unsigned int count;
 236 };
 237
 238 #ifdef HAVE_LIBXML2
 239
 240 extern void schemasInit(void) DECLSPEC_HIDDEN;
 241 extern void schemasCleanup(void) DECLSPEC_HIDDEN;
 242
 243 #ifndef HAVE_XMLFIRSTELEMENTCHILD
 244 static inline xmlNodePtr wine_xmlFirstElementChild(xmlNodePtr parent)
 245 {
 246     xmlNodePtr child;
 247     for (child = parent->children; child != NULL; child = child->next)
 248         if (child->type == XML_ELEMENT_NODE)
 249             break;
 250
 251     return child;
 252 }
 253 #define xmlFirstElementChild wine_xmlFirstElementChild
 254 #endif
 255
 256 /* IXMLDOMNode Internal Structure */
 257 typedef struct _xmlnode
 258 {
 259     DispatchEx   dispex;
 260     IXMLDOMNode *iface;
 261     IXMLDOMNode *parent;
 262     xmlNodePtr   node;
 263 } xmlnode;
 264
 265 /* IXMLDOMNamedNodeMap custom function table */
 266 struct nodemap_funcs
 267 {
 268     HRESULT (*get_named_item)(const xmlNodePtr,BSTR,IXMLDOMNode**);
 269     HRESULT (*set_named_item)(xmlNodePtr,IXMLDOMNode*,IXMLDOMNode**);
 270     HRESULT (*remove_named_item)(xmlNodePtr,BSTR,IXMLDOMNode**);
 271     HRESULT (*get_item)(xmlNodePtr,LONG,IXMLDOMNode**);
 272     HRESULT (*get_length)(xmlNodePtr,LONG*);
 273     HRESULT (*get_qualified_item)(const xmlNodePtr,BSTR,BSTR,IXMLDOMNode**);
 274     HRESULT (*remove_qualified_item)(xmlNodePtr,BSTR,BSTR,IXMLDOMNode**);
 275     HRESULT (*next_node)(const xmlNodePtr,LONG*,IXMLDOMNode**);
 276 };
 277
 278 /* used by IEnumVARIANT to access outer object items */
 279 struct enumvariant_funcs
 280 {
 281     HRESULT (*get_item)(IUnknown*, LONG, VARIANT*);
 282     HRESULT (*next)(IUnknown*);
 283 };
 284
 285 /* constructors */
 286 extern IUnknown         *create_domdoc( xmlNodePtr ) DECLSPEC_HIDDEN;
 287 extern IUnknown         *create_xmldoc( void ) DECLSPEC_HIDDEN;
 288 extern IXMLDOMNode      *create_node( xmlNodePtr ) DECLSPEC_HIDDEN;
 289 extern IUnknown         *create_element( xmlNodePtr ) DECLSPEC_HIDDEN;
 290 extern IUnknown         *create_attribute( xmlNodePtr ) DECLSPEC_HIDDEN;
 291 extern IUnknown         *create_text( xmlNodePtr ) DECLSPEC_HIDDEN;
 292 extern IUnknown         *create_pi( xmlNodePtr ) DECLSPEC_HIDDEN;
 293 extern IUnknown         *create_comment( xmlNodePtr ) DECLSPEC_HIDDEN;
 294 extern IUnknown         *create_cdata( xmlNodePtr ) DECLSPEC_HIDDEN;
 295 extern IXMLDOMNodeList  *create_children_nodelist( xmlNodePtr ) DECLSPEC_HIDDEN;
 296 extern IXMLDOMNamedNodeMap *create_nodemap( xmlNodePtr, const struct nodemap_funcs* ) DECLSPEC_HIDDEN;
 297 extern IUnknown         *create_doc_Implementation(void) DECLSPEC_HIDDEN;
 298 extern IUnknown         *create_doc_fragment( xmlNodePtr ) DECLSPEC_HIDDEN;
 299 extern IUnknown         *create_doc_entity_ref( xmlNodePtr ) DECLSPEC_HIDDEN;
 300 extern IUnknown         *create_doc_type( xmlNodePtr ) DECLSPEC_HIDDEN;
 301 extern HRESULT           create_selection( xmlNodePtr, xmlChar*, IXMLDOMNodeList** ) DECLSPEC_HIDDEN;
 302 extern HRESULT           create_enumvariant( IUnknown*, BOOL, const struct enumvariant_funcs*, IEnumVARIANT**) DECLSPEC_HIDDEN;
 303
 304 /* data accessors */
 305 xmlNodePtr xmlNodePtr_from_domnode( IXMLDOMNode *iface, xmlElementType type ) DECLSPEC_HIDDEN;
 306
 307 /* helpers */
 308 extern xmlChar *xmlChar_from_wchar( LPCWSTR str ) DECLSPEC_HIDDEN;
 309
 310 extern void xmldoc_init( xmlDocPtr doc, MSXML_VERSION version ) DECLSPEC_HIDDEN;
 311 extern LONG xmldoc_add_ref( xmlDocPtr doc ) DECLSPEC_HIDDEN;
 312 extern LONG xmldoc_release( xmlDocPtr doc ) DECLSPEC_HIDDEN;
 313 extern LONG xmldoc_add_refs( xmlDocPtr doc, LONG refs ) DECLSPEC_HIDDEN;
 314 extern LONG xmldoc_release_refs ( xmlDocPtr doc, LONG refs ) DECLSPEC_HIDDEN;
 315 extern int xmlnode_get_inst_cnt( xmlnode *node ) DECLSPEC_HIDDEN;
 316 extern HRESULT xmldoc_add_orphan( xmlDocPtr doc, xmlNodePtr node ) DECLSPEC_HIDDEN;
 317 extern HRESULT xmldoc_remove_orphan( xmlDocPtr doc, xmlNodePtr node ) DECLSPEC_HIDDEN;
 318 extern void xmldoc_link_xmldecl(xmlDocPtr doc, xmlNodePtr node) DECLSPEC_HIDDEN;
 319 extern xmlNodePtr xmldoc_unlink_xmldecl(xmlDocPtr doc) DECLSPEC_HIDDEN;
 320
 321 extern HRESULT XMLElement_create( xmlNodePtr node, LPVOID *ppObj, BOOL own ) DECLSPEC_HIDDEN;
 322
 323 extern void wineXmlCallbackLog(char const* caller, xmlErrorLevel lvl, char const* msg, va_list ap) DECLSPEC_HIDDEN;
 324 extern void wineXmlCallbackError(char const* caller, xmlErrorPtr err) DECLSPEC_HIDDEN;
 325
 326 #define LIBXML2_LOG_CALLBACK __WINE_PRINTF_ATTR(2,3)
 327
 328 #define LIBXML2_CALLBACK_TRACE(caller, msg, ap) \
 329         wineXmlCallbackLog(#caller, XML_ERR_NONE, msg, ap)
 330
 331 #define LIBXML2_CALLBACK_WARN(caller, msg, ap) \
 332         wineXmlCallbackLog(#caller, XML_ERR_WARNING, msg, ap)
 333
 334 #define LIBXML2_CALLBACK_ERR(caller, msg, ap) \
 335         wineXmlCallbackLog(#caller, XML_ERR_ERROR, msg, ap)
 336
 337 #define LIBXML2_CALLBACK_SERROR(caller, err) wineXmlCallbackError(#caller, err)
 338
 339 extern BOOL is_preserving_whitespace(xmlNodePtr node) DECLSPEC_HIDDEN;
 340 extern BOOL is_xpathmode(const xmlDocPtr doc) DECLSPEC_HIDDEN;
 341 extern void set_xpathmode(xmlDocPtr doc, BOOL xpath) DECLSPEC_HIDDEN;
 342
 343 extern void init_xmlnode(xmlnode*,xmlNodePtr,IXMLDOMNode*,dispex_static_data_t*) DECLSPEC_HIDDEN;
 344 extern void destroy_xmlnode(xmlnode*) DECLSPEC_HIDDEN;
 345 extern BOOL node_query_interface(xmlnode*,REFIID,void**) DECLSPEC_HIDDEN;
 346 extern xmlnode *get_node_obj(IXMLDOMNode*) DECLSPEC_HIDDEN;
 347
 348 extern HRESULT node_append_child(xmlnode*,IXMLDOMNode*,IXMLDOMNode**) DECLSPEC_HIDDEN;
 349 extern HRESULT node_get_nodeName(xmlnode*,BSTR*) DECLSPEC_HIDDEN;
 350 extern HRESULT node_get_content(xmlnode*,VARIANT*) DECLSPEC_HIDDEN;
 351 extern HRESULT node_set_content(xmlnode*,LPCWSTR) DECLSPEC_HIDDEN;
 352 extern HRESULT node_put_value(xmlnode*,VARIANT*) DECLSPEC_HIDDEN;
 353 extern HRESULT node_put_value_escaped(xmlnode*,VARIANT*) DECLSPEC_HIDDEN;
 354 extern HRESULT node_get_parent(xmlnode*,IXMLDOMNode**) DECLSPEC_HIDDEN;
 355 extern HRESULT node_get_child_nodes(xmlnode*,IXMLDOMNodeList**) DECLSPEC_HIDDEN;
 356 extern HRESULT node_get_first_child(xmlnode*,IXMLDOMNode**) DECLSPEC_HIDDEN;
 357 extern HRESULT node_get_last_child(xmlnode*,IXMLDOMNode**) DECLSPEC_HIDDEN;
 358 extern HRESULT node_get_previous_sibling(xmlnode*,IXMLDOMNode**) DECLSPEC_HIDDEN;
 359 extern HRESULT node_get_next_sibling(xmlnode*,IXMLDOMNode**) DECLSPEC_HIDDEN;
 360 extern HRESULT node_insert_before(xmlnode*,IXMLDOMNode*,const VARIANT*,IXMLDOMNode**) DECLSPEC_HIDDEN;
 361 extern HRESULT node_replace_child(xmlnode*,IXMLDOMNode*,IXMLDOMNode*,IXMLDOMNode**) DECLSPEC_HIDDEN;
 362 extern HRESULT node_put_text(xmlnode*,BSTR) DECLSPEC_HIDDEN;
 363 extern HRESULT node_get_xml(xmlnode*,BOOL,BSTR*) DECLSPEC_HIDDEN;
 364 extern HRESULT node_clone(xmlnode*,VARIANT_BOOL,IXMLDOMNode**) DECLSPEC_HIDDEN;
 365 extern HRESULT node_get_prefix(xmlnode*,BSTR*) DECLSPEC_HIDDEN;
 366 extern HRESULT node_get_base_name(xmlnode*,BSTR*) DECLSPEC_HIDDEN;
 367 extern HRESULT node_get_namespaceURI(xmlnode*,BSTR*) DECLSPEC_HIDDEN;
 368 extern HRESULT node_remove_child(xmlnode*,IXMLDOMNode*,IXMLDOMNode**) DECLSPEC_HIDDEN;
 369 extern HRESULT node_has_childnodes(const xmlnode*,VARIANT_BOOL*) DECLSPEC_HIDDEN;
 370 extern HRESULT node_get_owner_doc(const xmlnode*,IXMLDOMDocument**) DECLSPEC_HIDDEN;
 371 extern HRESULT node_get_text(const xmlnode*,BSTR*) DECLSPEC_HIDDEN;
 372 extern HRESULT node_select_nodes(const xmlnode*,BSTR,IXMLDOMNodeList**) DECLSPEC_HIDDEN;
 373 extern HRESULT node_select_singlenode(const xmlnode*,BSTR,IXMLDOMNode**) DECLSPEC_HIDDEN;
 374 extern HRESULT node_transform_node(const xmlnode*,IXMLDOMNode*,BSTR*) DECLSPEC_HIDDEN;
 375 extern HRESULT node_transform_node_params(const xmlnode*,IXMLDOMNode*,BSTR*,IStream*,const struct xslprocessor_params*) DECLSPEC_HIDDEN;
 376 extern HRESULT node_create_supporterrorinfo(const tid_t*,void**) DECLSPEC_HIDDEN;
 377
 378 extern HRESULT get_domdoc_from_xmldoc(xmlDocPtr xmldoc, IXMLDOMDocument3 **document) DECLSPEC_HIDDEN;
 379
 380 extern HRESULT SchemaCache_validate_tree(IXMLDOMSchemaCollection2*, xmlNodePtr) DECLSPEC_HIDDEN;
 381 extern XDR_DT  SchemaCache_get_node_dt(IXMLDOMSchemaCollection2*, xmlNodePtr) DECLSPEC_HIDDEN;
 382 extern HRESULT cache_from_doc_ns(IXMLDOMSchemaCollection2*, xmlnode*) DECLSPEC_HIDDEN;
 383
 384 extern XDR_DT str_to_dt(xmlChar const* str, int len /* calculated if -1 */) DECLSPEC_HIDDEN;
 385 extern XDR_DT bstr_to_dt(OLECHAR const* bstr, int len /* calculated if -1 */) DECLSPEC_HIDDEN;
 386 extern xmlChar const* dt_to_str(XDR_DT dt) DECLSPEC_HIDDEN;
 387 extern const char* debugstr_dt(XDR_DT dt) DECLSPEC_HIDDEN;
 388 extern OLECHAR const* dt_to_bstr(XDR_DT dt) DECLSPEC_HIDDEN;
 389 extern HRESULT dt_validate(XDR_DT dt, xmlChar const* content) DECLSPEC_HIDDEN;
 390
 391 extern BSTR EnsureCorrectEOL(BSTR) DECLSPEC_HIDDEN;
 392
 393 extern xmlChar* tagName_to_XPath(const BSTR tagName) DECLSPEC_HIDDEN;
 394
 395 static inline BSTR bstr_from_xmlChar(const xmlChar *str)
 396 {
 397     BSTR ret = NULL;
 398
 399     if(str) {
 400         DWORD len = MultiByteToWideChar(CP_UTF8, 0, (LPCSTR)str, -1, NULL, 0);
 401         ret = SysAllocStringLen(NULL, len-1);
 402         if(ret)
 403             MultiByteToWideChar( CP_UTF8, 0, (LPCSTR)str, -1, ret, len);
 404     }
 405     else
 406         ret = SysAllocStringLen(NULL, 0);
 407
 408     return ret;
 409 }
 410
 411 static inline xmlChar *xmlchar_from_wcharn(const WCHAR *str, int nchars)
 412 {
 413     xmlChar *xmlstr;
 414     DWORD len = WideCharToMultiByte( CP_UTF8, 0, str, nchars, NULL, 0, NULL, NULL );
 415
 416     xmlstr = heap_alloc( len+1 );
 417     if ( xmlstr )
 418     {
 419         WideCharToMultiByte( CP_UTF8, 0, str, nchars, (LPSTR) xmlstr, len+1, NULL, NULL );
 420         xmlstr[len] = 0;
 421     }
 422     return xmlstr;
 423 }
 424
 425 static inline xmlChar *xmlchar_from_wchar( const WCHAR *str )
 426 {
 427     return xmlchar_from_wcharn(str, -1);
 428 }
 429
 430 static inline xmlChar *heap_strdupxmlChar(const xmlChar *str)
 431 {
 432     xmlChar *ret = NULL;
 433
 434     if(str) {
 435         DWORD size;
 436
 437         size = (xmlStrlen(str)+1)*sizeof(xmlChar);
 438         ret = heap_alloc(size);
 439         memcpy(ret, str, size);
 440     }
 441
 442     return ret;
 443 }
 444
 445 #endif
 446
 447 static inline HRESULT return_bstr(const WCHAR *value, BSTR *p)
 448 {
 449     if(!p)
 450         return E_INVALIDARG;
 451
 452     if(value) {
 453         *p = SysAllocString(value);
 454         if(!*p)
 455             return E_OUTOFMEMORY;
 456     }else {
 457         *p = NULL;
 458     }
 459
 460     return S_OK;
 461 }
 462
 463 static inline HRESULT return_bstrn(const WCHAR *value, int len, BSTR *p)
 464 {
 465     if(value) {
 466         *p = SysAllocStringLen(value, len);
 467         if(!*p)
 468             return E_OUTOFMEMORY;
 469     }else
 470         *p = NULL;
 471
 472     return S_OK;
 473 }
 474
 475 static inline HRESULT return_null_node(IXMLDOMNode **p)
 476 {
 477     if(!p)
 478         return E_INVALIDARG;
 479     *p = NULL;
 480     return S_FALSE;
 481 }
 482
 483 static inline HRESULT return_null_ptr(void **p)
 484 {
 485     if(!p)
 486         return E_INVALIDARG;
 487     *p = NULL;
 488     return S_FALSE;
 489 }
 490
 491 static inline HRESULT return_null_var(VARIANT *p)
 492 {
 493     if(!p)
 494         return E_INVALIDARG;
 495
 496     V_VT(p) = VT_NULL;
 497     return S_FALSE;
 498 }
 499
 500 static inline HRESULT return_null_bstr(BSTR *p)
 501 {
 502     if(!p)
 503         return E_INVALIDARG;
 504
 505     *p = NULL;
 506     return S_FALSE;
 507 }
 508
 509 static inline HRESULT return_var_false(VARIANT_BOOL *p)
 510 {
 511     if(!p)
 512         return E_INVALIDARG;
 513
 514     *p = VARIANT_FALSE;
 515     return S_FALSE;
 516 }
 517
 518 extern IXMLDOMParseError *create_parseError( LONG code, BSTR url, BSTR reason, BSTR srcText,
 519                                              LONG line, LONG linepos, LONG filepos ) DECLSPEC_HIDDEN;
 520 extern HRESULT DOMDocument_create(MSXML_VERSION, void**) DECLSPEC_HIDDEN;
 521 extern HRESULT SchemaCache_create(MSXML_VERSION, void**) DECLSPEC_HIDDEN;
 522 extern HRESULT XMLDocument_create(void**) DECLSPEC_HIDDEN;
 523 extern HRESULT SAXXMLReader_create(MSXML_VERSION, void**) DECLSPEC_HIDDEN;
 524 extern HRESULT SAXAttributes_create(MSXML_VERSION, void**) DECLSPEC_HIDDEN;
 525 extern HRESULT XMLHTTPRequest_create(void **) DECLSPEC_HIDDEN;
 526 extern HRESULT ServerXMLHTTP_create(void **) DECLSPEC_HIDDEN;
 527 extern HRESULT XSLTemplate_create(void**) DECLSPEC_HIDDEN;
 528 extern HRESULT MXWriter_create(MSXML_VERSION, void**) DECLSPEC_HIDDEN;
 529 extern HRESULT MXNamespaceManager_create(void**) DECLSPEC_HIDDEN;
 530 extern HRESULT XMLParser_create(void**) DECLSPEC_HIDDEN;
 531 extern HRESULT XMLView_create(void**) DECLSPEC_HIDDEN;
 532
 533 static inline const CLSID* DOMDocument_version(MSXML_VERSION v)
 534 {
 535     switch (v)
 536     {
 537     default:
 538     case MSXML_DEFAULT: return &CLSID_DOMDocument;
 539     case MSXML3: return &CLSID_DOMDocument30;
 540     case MSXML4: return &CLSID_DOMDocument40;
 541     case MSXML6: return &CLSID_DOMDocument60;
 542     }
 543 }
 544
 545 static inline const CLSID* SchemaCache_version(MSXML_VERSION v)
 546 {
 547     switch (v)
 548     {
 549     default:
 550     case MSXML_DEFAULT: return &CLSID_XMLSchemaCache;
 551     case MSXML3: return &CLSID_XMLSchemaCache30;
 552     case MSXML4: return &CLSID_XMLSchemaCache40;
 553     case MSXML6: return &CLSID_XMLSchemaCache60;
 554     }
 555 }
 556
 557 typedef struct bsc_t bsc_t;
 558
 559 HRESULT create_moniker_from_url(LPCWSTR, IMoniker**) DECLSPEC_HIDDEN;
 560 HRESULT bind_url(IMoniker*, HRESULT (*onDataAvailable)(void*,char*,DWORD), void*, bsc_t**) DECLSPEC_HIDDEN;
 561 HRESULT detach_bsc(bsc_t*) DECLSPEC_HIDDEN;
 562
 563 const char *debugstr_variant(const VARIANT*) DECLSPEC_HIDDEN;
 564
 565 /* Error Codes - not defined anywhere in the public headers */
 566 #define E_XML_ELEMENT_UNDECLARED            0xC00CE00D
 567 #define E_XML_ELEMENT_ID_NOT_FOUND          0xC00CE00E
 568 /* ... */
 569 #define E_XML_EMPTY_NOT_ALLOWED             0xC00CE011
 570 #define E_XML_ELEMENT_NOT_COMPLETE          0xC00CE012
 571 #define E_XML_ROOT_NAME_MISMATCH            0xC00CE013
 572 #define E_XML_INVALID_CONTENT               0xC00CE014
 573 #define E_XML_ATTRIBUTE_NOT_DEFINED         0xC00CE015
 574 #define E_XML_ATTRIBUTE_FIXED               0xC00CE016
 575 #define E_XML_ATTRIBUTE_VALUE               0xC00CE017
 576 #define E_XML_ILLEGAL_TEXT                  0xC00CE018
 577 /* ... */
 578 #define E_XML_REQUIRED_ATTRIBUTE_MISSING    0xC00CE020
 579
 580 #endif /* __MSXML_PRIVATE__ */