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