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 /* memory allocation functions */
 161
 162 static inline void *heap_alloc(size_t len)
 163 {
 164     return HeapAlloc(GetProcessHeap(), 0, len);
 165 }
 166
 167 static inline void *heap_alloc_zero(size_t len)
 168 {
 169     return HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, len);
 170 }
 171
 172 static inline void *heap_realloc(void *mem, size_t len)
 173 {
 174     return HeapReAlloc(GetProcessHeap(), 0, mem, len);
 175 }
 176
 177 static inline BOOL heap_free(void *mem)
 178 {
 179     return HeapFree(GetProcessHeap(), 0, mem);
 180 }
 181
 182 static inline LPWSTR heap_strdupW(LPCWSTR str)
 183 {
 184     LPWSTR ret = NULL;
 185
 186     if(str) {
 187         DWORD size;
 188
 189         size = (strlenW(str)+1)*sizeof(WCHAR);
 190         ret = heap_alloc(size);
 191         memcpy(ret, str, size);
 192     }
 193
 194     return ret;
 195 }
 196
 197 #ifdef HAVE_LIBXML2
 198
 199 extern void schemasInit(void);
 200 extern void schemasCleanup(void);
 201
 202 #ifndef HAVE_XMLFIRSTELEMENTCHILD
 203 static inline xmlNodePtr wine_xmlFirstElementChild(xmlNodePtr parent)
 204 {
 205     xmlNodePtr child;
 206     for (child = parent->children; child != NULL; child = child->next)
 207         if (child->type == XML_ELEMENT_NODE)
 208             break;
 209
 210     return child;
 211 }
 212 #define xmlFirstElementChild wine_xmlFirstElementChild
 213 #endif
 214
 215 /* constructors */
 216 extern IUnknown         *create_domdoc( xmlNodePtr document );
 217 extern IUnknown         *create_xmldoc( void );
 218 extern IXMLDOMNode      *create_node( xmlNodePtr node );
 219 extern IUnknown         *create_element( xmlNodePtr element );
 220 extern IUnknown         *create_attribute( xmlNodePtr attribute );
 221 extern IUnknown         *create_text( xmlNodePtr text );
 222 extern IUnknown         *create_pi( xmlNodePtr pi );
 223 extern IUnknown         *create_comment( xmlNodePtr comment );
 224 extern IUnknown         *create_cdata( xmlNodePtr text );
 225 extern IXMLDOMNodeList  *create_children_nodelist( xmlNodePtr );
 226 extern IXMLDOMNamedNodeMap *create_nodemap( const xmlNodePtr );
 227 extern IUnknown         *create_doc_Implementation(void);
 228 extern IUnknown         *create_doc_fragment( xmlNodePtr fragment );
 229 extern IUnknown         *create_doc_entity_ref( xmlNodePtr entity );
 230 extern IUnknown         *create_doc_type( xmlNodePtr doctype );
 231
 232 extern HRESULT queryresult_create( xmlNodePtr node, xmlChar* szQuery, IXMLDOMNodeList** out );
 233
 234 /* data accessors */
 235 xmlNodePtr xmlNodePtr_from_domnode( IXMLDOMNode *iface, xmlElementType type );
 236
 237 /* helpers */
 238 extern xmlChar *xmlChar_from_wchar( LPCWSTR str );
 239
 240 extern void xmldoc_init( xmlDocPtr doc, const GUID *clsid );
 241 extern LONG xmldoc_add_ref( xmlDocPtr doc );
 242 extern LONG xmldoc_release( xmlDocPtr doc );
 243 extern HRESULT xmldoc_add_orphan( xmlDocPtr doc, xmlNodePtr node );
 244 extern HRESULT xmldoc_remove_orphan( xmlDocPtr doc, xmlNodePtr node );
 245 extern void xmldoc_link_xmldecl(xmlDocPtr doc, xmlNodePtr node);
 246 extern xmlNodePtr xmldoc_unlink_xmldecl(xmlDocPtr doc);
 247
 248 extern HRESULT XMLElement_create( IUnknown *pUnkOuter, xmlNodePtr node, LPVOID *ppObj, BOOL own );
 249
 250 extern void wineXmlCallbackLog(char const* caller, xmlErrorLevel lvl, char const* msg, va_list ap);
 251 extern void wineXmlCallbackError(char const* caller, xmlErrorPtr err);
 252
 253 #define LIBXML2_LOG_CALLBACK __WINE_PRINTF_ATTR(2,3)
 254
 255 #define LIBXML2_CALLBACK_TRACE(caller, msg, ap) \
 256         wineXmlCallbackLog(#caller, XML_ERR_NONE, msg, ap)
 257
 258 #define LIBXML2_CALLBACK_WARN(caller, msg, ap) \
 259         wineXmlCallbackLog(#caller, XML_ERR_WARNING, msg, ap)
 260
 261 #define LIBXML2_CALLBACK_ERR(caller, msg, ap) \
 262         wineXmlCallbackLog(#caller, XML_ERR_ERROR, msg, ap)
 263
 264 #define LIBXML2_CALLBACK_SERROR(caller, err) wineXmlCallbackError(#caller, err)
 265
 266 extern BOOL is_preserving_whitespace(xmlNodePtr node);
 267 extern BOOL is_xpathmode(const xmlDocPtr doc);
 268 extern void set_xpathmode(xmlDocPtr doc, BOOL xpath);
 269
 270 /* IXMLDOMNode Internal Structure */
 271 typedef struct _xmlnode
 272 {
 273     DispatchEx   dispex;
 274     IXMLDOMNode *iface;
 275     IXMLDOMNode *parent;
 276     xmlNodePtr   node;
 277 } xmlnode;
 278
 279 extern void init_xmlnode(xmlnode*,xmlNodePtr,IXMLDOMNode*,dispex_static_data_t*);
 280 extern void destroy_xmlnode(xmlnode*);
 281 extern BOOL node_query_interface(xmlnode*,REFIID,void**);
 282 extern xmlnode *get_node_obj(IXMLDOMNode*);
 283
 284 extern HRESULT node_append_child(xmlnode*,IXMLDOMNode*,IXMLDOMNode**);
 285 extern HRESULT node_get_nodeName(xmlnode*,BSTR*);
 286 extern HRESULT node_get_content(xmlnode*,VARIANT*);
 287 extern HRESULT node_set_content(xmlnode*,LPCWSTR);
 288 extern HRESULT node_put_value(xmlnode*,VARIANT*);
 289 extern HRESULT node_put_value_escaped(xmlnode*,VARIANT*);
 290 extern HRESULT node_get_parent(xmlnode*,IXMLDOMNode**);
 291 extern HRESULT node_get_child_nodes(xmlnode*,IXMLDOMNodeList**);
 292 extern HRESULT node_get_first_child(xmlnode*,IXMLDOMNode**);
 293 extern HRESULT node_get_last_child(xmlnode*,IXMLDOMNode**);
 294 extern HRESULT node_get_previous_sibling(xmlnode*,IXMLDOMNode**);
 295 extern HRESULT node_get_next_sibling(xmlnode*,IXMLDOMNode**);
 296 extern HRESULT node_insert_before(xmlnode*,IXMLDOMNode*,const VARIANT*,IXMLDOMNode**);
 297 extern HRESULT node_replace_child(xmlnode*,IXMLDOMNode*,IXMLDOMNode*,IXMLDOMNode**);
 298 extern HRESULT node_put_text(xmlnode*,BSTR);
 299 extern HRESULT node_get_xml(xmlnode*,BOOL,BOOL,BSTR*);
 300 extern HRESULT node_clone(xmlnode*,VARIANT_BOOL,IXMLDOMNode**);
 301 extern HRESULT node_get_prefix(xmlnode*,BSTR*);
 302 extern HRESULT node_get_base_name(xmlnode*,BSTR*);
 303 extern HRESULT node_get_namespaceURI(xmlnode*,BSTR*);
 304 extern HRESULT node_remove_child(xmlnode*,IXMLDOMNode*,IXMLDOMNode**);
 305 extern HRESULT node_has_childnodes(const xmlnode*,VARIANT_BOOL*);
 306 extern HRESULT node_get_owner_doc(const xmlnode*,IXMLDOMDocument**);
 307 extern HRESULT node_get_text(const xmlnode*,BSTR*);
 308 extern HRESULT node_select_nodes(const xmlnode*,BSTR,IXMLDOMNodeList**);
 309 extern HRESULT node_select_singlenode(const xmlnode*,BSTR,IXMLDOMNode**);
 310 extern HRESULT node_transform_node(const xmlnode*,IXMLDOMNode*,BSTR*);
 311
 312 extern HRESULT get_domdoc_from_xmldoc(xmlDocPtr xmldoc, IXMLDOMDocument3 **document);
 313
 314 extern HRESULT SchemaCache_validate_tree(IXMLDOMSchemaCollection2* iface, xmlNodePtr tree);
 315 extern XDR_DT  SchemaCache_get_node_dt(IXMLDOMSchemaCollection2* iface, xmlNodePtr node);
 316
 317 extern XDR_DT str_to_dt(xmlChar const* str, int len /* calculated if -1 */);
 318 extern XDR_DT bstr_to_dt(OLECHAR const* bstr, int len /* calculated if -1 */);
 319 extern xmlChar const* dt_to_str(XDR_DT dt);
 320 extern OLECHAR const* dt_to_bstr(XDR_DT dt);
 321 extern XDR_DT element_get_dt(xmlNodePtr node);
 322 extern HRESULT dt_validate(XDR_DT dt, xmlChar const* content);
 323
 324 extern BSTR EnsureCorrectEOL(BSTR);
 325
 326 extern xmlChar* tagName_to_XPath(const BSTR tagName);
 327
 328 static inline BSTR bstr_from_xmlChar(const xmlChar *str)
 329 {
 330     BSTR ret = NULL;
 331
 332     if(str) {
 333         DWORD len = MultiByteToWideChar(CP_UTF8, 0, (LPCSTR)str, -1, NULL, 0);
 334         ret = SysAllocStringLen(NULL, len-1);
 335         if(ret)
 336             MultiByteToWideChar( CP_UTF8, 0, (LPCSTR)str, -1, ret, len);
 337     }
 338     else
 339         ret = SysAllocStringLen(NULL, 0);
 340
 341     return ret;
 342 }
 343
 344 static inline HRESULT return_bstr(const WCHAR *value, BSTR *p)
 345 {
 346     if(!p)
 347         return E_INVALIDARG;
 348
 349     if(value) {
 350         *p = SysAllocString(value);
 351         if(!*p)
 352             return E_OUTOFMEMORY;
 353     }else {
 354         *p = NULL;
 355     }
 356
 357     return S_OK;
 358 }
 359
 360 static inline HRESULT return_null_node(IXMLDOMNode **p)
 361 {
 362     if(!p)
 363         return E_INVALIDARG;
 364     *p = NULL;
 365     return S_FALSE;
 366 }
 367
 368 static inline HRESULT return_null_ptr(void **p)
 369 {
 370     if(!p)
 371         return E_INVALIDARG;
 372     *p = NULL;
 373     return S_FALSE;
 374 }
 375
 376 static inline HRESULT return_null_var(VARIANT *p)
 377 {
 378     if(!p)
 379         return E_INVALIDARG;
 380
 381     V_VT(p) = VT_NULL;
 382     return S_FALSE;
 383 }
 384
 385 static inline HRESULT return_null_bstr(BSTR *p)
 386 {
 387     if(!p)
 388         return E_INVALIDARG;
 389
 390     *p = NULL;
 391     return S_FALSE;
 392 }
 393
 394 static inline xmlChar *xmlchar_from_wchar( LPCWSTR str )
 395 {
 396     xmlChar *xmlstr;
 397     DWORD len = WideCharToMultiByte( CP_UTF8, 0, str, -1, NULL, 0, NULL, NULL );
 398
 399     xmlstr = heap_alloc( len );
 400     if ( xmlstr )
 401         WideCharToMultiByte( CP_UTF8, 0, str, -1, (LPSTR) xmlstr, len, NULL, NULL );
 402     return xmlstr;
 403 }
 404
 405 #endif
 406
 407 extern IXMLDOMParseError *create_parseError( LONG code, BSTR url, BSTR reason, BSTR srcText,
 408                                              LONG line, LONG linepos, LONG filepos );
 409 extern HRESULT DOMDocument_create(const GUID*, IUnknown*, void**);
 410 extern HRESULT SchemaCache_create(const GUID*, IUnknown*, void**);
 411 extern HRESULT XMLDocument_create(IUnknown*, void**);
 412 extern HRESULT SAXXMLReader_create(IUnknown*, void**);
 413 extern HRESULT XMLHTTPRequest_create(IUnknown*, void **);
 414 extern HRESULT XSLTemplate_create(IUnknown*, void**);
 415
 416 static inline const CLSID* DOMDocument_version(MSXML_VERSION v)
 417 {
 418     switch (v)
 419     {
 420     default:
 421     case MSXML_DEFAULT: return &CLSID_DOMDocument;
 422     case MSXML3: return &CLSID_DOMDocument30;
 423     case MSXML4: return &CLSID_DOMDocument40;
 424     case MSXML6: return &CLSID_DOMDocument60;
 425     }
 426 }
 427
 428 static inline const CLSID* SchemaCache_version(MSXML_VERSION v)
 429 {
 430     switch (v)
 431     {
 432     default:
 433     case MSXML_DEFAULT: return &CLSID_XMLSchemaCache;
 434     case MSXML3: return &CLSID_XMLSchemaCache30;
 435     case MSXML4: return &CLSID_XMLSchemaCache40;
 436     case MSXML6: return &CLSID_XMLSchemaCache60;
 437     }
 438 }
 439
 440 typedef struct bsc_t bsc_t;
 441
 442 HRESULT bind_url(LPCWSTR, HRESULT (*onDataAvailable)(void*,char*,DWORD), void*, bsc_t**);
 443 void detach_bsc(bsc_t*);
 444
 445 const char *debugstr_variant(const VARIANT*);
 446
 447 /* Error Codes - not defined anywhere in the public headers */
 448 #define E_XML_ELEMENT_UNDECLARED            0xC00CE00D
 449 #define E_XML_ELEMENT_ID_NOT_FOUND          0xC00CE00E
 450 /* ... */
 451 #define E_XML_EMPTY_NOT_ALLOWED             0xC00CE011
 452 #define E_XML_ELEMENT_NOT_COMPLETE          0xC00CE012
 453 #define E_XML_ROOT_NAME_MISMATCH            0xC00CE013
 454 #define E_XML_INVALID_CONTENT               0xC00CE014
 455 #define E_XML_ATTRIBUTE_NOT_DEFINED         0xC00CE015
 456 #define E_XML_ATTRIBUTE_FIXED               0xC00CE016
 457 #define E_XML_ATTRIBUTE_VALUE               0xC00CE017
 458 #define E_XML_ILLEGAL_TEXT                  0xC00CE018
 459 /* ... */
 460 #define E_XML_REQUIRED_ATTRIBUTE_MISSING    0xC00CE020
 461
 462 #endif /* __MSXML_PRIVATE__ */