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