[wxWidgets.git] / include / wx / xml / xml.h

/////////////////////////////////////////////////////////////////////////////
// Name:        wx/xml/xml.h
// Purpose:     wxXmlDocument - XML parser & data holder class
// Author:      Vaclav Slavik
// Created:     2000/03/05
// RCS-ID:      $Id$
// Copyright:   (c) 2000 Vaclav Slavik
// Licence:     wxWindows licence
/////////////////////////////////////////////////////////////////////////////


#ifndef _WX_XML_H_
#define _WX_XML_H_

#include "wx/defs.h"

#if wxUSE_XML

#include "wx/string.h"
#include "wx/object.h"
#include "wx/list.h"
#include "wx/versioninfo.h"

#ifdef WXMAKINGDLL_XML
    #define WXDLLIMPEXP_XML WXEXPORT
#elif defined(WXUSINGDLL)
    #define WXDLLIMPEXP_XML WXIMPORT
#else // not making nor using DLL
    #define WXDLLIMPEXP_XML
#endif

class WXDLLIMPEXP_FWD_XML wxXmlNode;
class WXDLLIMPEXP_FWD_XML wxXmlAttribute;
class WXDLLIMPEXP_FWD_XML wxXmlDocument;
class WXDLLIMPEXP_FWD_XML wxXmlIOHandler;
class WXDLLIMPEXP_FWD_BASE wxInputStream;
class WXDLLIMPEXP_FWD_BASE wxOutputStream;

// Represents XML node type.
enum wxXmlNodeType
{
    // note: values are synchronized with xmlElementType from libxml
    wxXML_ELEMENT_NODE       =  1,
    wxXML_ATTRIBUTE_NODE     =  2,
    wxXML_TEXT_NODE          =  3,
    wxXML_CDATA_SECTION_NODE =  4,
    wxXML_ENTITY_REF_NODE    =  5,
    wxXML_ENTITY_NODE        =  6,
    wxXML_PI_NODE            =  7,
    wxXML_COMMENT_NODE       =  8,
    wxXML_DOCUMENT_NODE      =  9,
    wxXML_DOCUMENT_TYPE_NODE = 10,
    wxXML_DOCUMENT_FRAG_NODE = 11,
    wxXML_NOTATION_NODE      = 12,
    wxXML_HTML_DOCUMENT_NODE = 13
};


// Represents node property(ies).
// Example: in <img src="hello.gif" id="3"/> "src" is property with value
//          "hello.gif" and "id" is prop. with value "3".

class WXDLLIMPEXP_XML wxXmlAttribute
{
public:
    wxXmlAttribute() : m_next(NULL) {}
    wxXmlAttribute(const wxString& name, const wxString& value,
                  wxXmlAttribute *next = NULL)
            : m_name(name), m_value(value), m_next(next) {}
    virtual ~wxXmlAttribute() {}

    const wxString& GetName() const { return m_name; }
    const wxString& GetValue() const { return m_value; }
    wxXmlAttribute *GetNext() const { return m_next; }

    void SetName(const wxString& name) { m_name = name; }
    void SetValue(const wxString& value) { m_value = value; }
    void SetNext(wxXmlAttribute *next) { m_next = next; }

private:
    wxString m_name;
    wxString m_value;
    wxXmlAttribute *m_next;
};

#if WXWIN_COMPATIBILITY_2_8
    // NB: #define is used instead of typedef so that forward declarations
    //     continue to work
    #define wxXmlProperty wxXmlAttribute
#endif


// Represents node in XML document. Node has name and may have content and
// attributes. Most common node types are wxXML_TEXT_NODE (name and attributes
// are irrelevant) and wxXML_ELEMENT_NODE (e.g. in <title>hi</title> there is
// element with name="title", irrelevant content and one child (wxXML_TEXT_NODE
// with content="hi").
//
// If wxUSE_UNICODE is 0, all strings are encoded in the encoding given to Load
// (default is UTF-8).

class WXDLLIMPEXP_XML wxXmlNode
{
public:
    wxXmlNode()
        : m_attrs(NULL), m_parent(NULL), m_children(NULL), m_next(NULL),
          m_lineNo(-1), m_noConversion(false)
    {
    }

    wxXmlNode(wxXmlNode *parent, wxXmlNodeType type,
              const wxString& name, const wxString& content = wxEmptyString,
              wxXmlAttribute *attrs = NULL, wxXmlNode *next = NULL,
              int lineNo = -1);

    virtual ~wxXmlNode();

    // copy ctor & operator=. Note that this does NOT copy siblings
    // and parent pointer, i.e. m_parent and m_next will be NULL
    // after using copy ctor and are never unmodified by operator=.
    // On the other hand, it DOES copy children and attributes.
    wxXmlNode(const wxXmlNode& node);
    wxXmlNode& operator=(const wxXmlNode& node);

    // user-friendly creation:
    wxXmlNode(wxXmlNodeType type, const wxString& name,
              const wxString& content = wxEmptyString,
              int lineNo = -1);
    virtual void AddChild(wxXmlNode *child);
    virtual bool InsertChild(wxXmlNode *child, wxXmlNode *followingNode);
    virtual bool InsertChildAfter(wxXmlNode *child, wxXmlNode *precedingNode);
    virtual bool RemoveChild(wxXmlNode *child);
    virtual void AddAttribute(const wxString& name, const wxString& value);
    virtual bool DeleteAttribute(const wxString& name);

    // access methods:
    wxXmlNodeType GetType() const { return m_type; }
    const wxString& GetName() const { return m_name; }
    const wxString& GetContent() const { return m_content; }

    bool IsWhitespaceOnly() const;
    int GetDepth(wxXmlNode *grandparent = NULL) const;

    // Gets node content from wxXML_ENTITY_NODE
    // The problem is, <tag>content<tag> is represented as
    // wxXML_ENTITY_NODE name="tag", content=""
    //    |-- wxXML_TEXT_NODE or
    //        wxXML_CDATA_SECTION_NODE name="" content="content"
    wxString GetNodeContent() const;

    wxXmlNode *GetParent() const { return m_parent; }
    wxXmlNode *GetNext() const { return m_next; }
    wxXmlNode *GetChildren() const { return m_children; }

    wxXmlAttribute *GetAttributes() const { return m_attrs; }
    bool GetAttribute(const wxString& attrName, wxString *value) const;
    wxString GetAttribute(const wxString& attrName,
                          const wxString& defaultVal = wxEmptyString) const;
    bool HasAttribute(const wxString& attrName) const;

    int GetLineNumber() const { return m_lineNo; }

    void SetType(wxXmlNodeType type) { m_type = type; }
    void SetName(const wxString& name) { m_name = name; }
    void SetContent(const wxString& con) { m_content = con; }

    void SetParent(wxXmlNode *parent) { m_parent = parent; }
    void SetNext(wxXmlNode *next) { m_next = next; }
    void SetChildren(wxXmlNode *child) { m_children = child; }

    void SetAttributes(wxXmlAttribute *attr) { m_attrs = attr; }
    virtual void AddAttribute(wxXmlAttribute *attr);

    // If true, don't do encoding conversion to improve efficiency - node content is ACII text
    bool GetNoConversion() const { return m_noConversion; }
    void SetNoConversion(bool noconversion) { m_noConversion = noconversion; }

#if WXWIN_COMPATIBILITY_2_8
    wxDEPRECATED( inline wxXmlAttribute *GetProperties() const );
    wxDEPRECATED( inline bool GetPropVal(const wxString& propName,
                                         wxString *value) const );
    wxDEPRECATED( inline wxString GetPropVal(const wxString& propName,
                                             const wxString& defaultVal) const );
    wxDEPRECATED( inline bool HasProp(const wxString& propName) const );

    wxDEPRECATED( inline void SetProperties(wxXmlAttribute *prop) );
#endif // WXWIN_COMPATIBILITY_2_8

    // The following three functions are backward compatibility, but because
    // they were virtual, we must make it possible to override them. This
    // is done by calling e.g. AddProperty() from AddAttribute(), so we have
    // to keep AddProperty() even if 2.8 compatibility is off. To prevent
    // old code from compiling in that case, we make them private and
    // non-virtual. (This can be removed when WXWIN_COMPATIBILITY_2_8 is
    // removed, we'll have just *Attribute versions then.)
#if WXWIN_COMPATIBILITY_2_8
    wxDEPRECATED_BUT_USED_INTERNALLY(
        virtual void AddProperty(const wxString& name, const wxString& value) );
    wxDEPRECATED_BUT_USED_INTERNALLY(
        virtual bool DeleteProperty(const wxString& name) );
    wxDEPRECATED_BUT_USED_INTERNALLY(
        virtual void AddProperty(wxXmlAttribute *attr) );
#else
private:
    void AddProperty(const wxString& name, const wxString& value);
    bool DeleteProperty(const wxString& name);
    void AddProperty(wxXmlAttribute *attr);
#endif // WXWIN_COMPATIBILITY_2_8/!WXWIN_COMPATIBILITY_2_8

private:
    wxXmlNodeType m_type;
    wxString m_name;
    wxString m_content;
    wxXmlAttribute *m_attrs;
    wxXmlNode *m_parent, *m_children, *m_next;
    int m_lineNo; // line number in original file, or -1
    bool m_noConversion; // don't do encoding conversion - node is plain text

    void DoFree();
    void DoCopy(const wxXmlNode& node);
};

#if WXWIN_COMPATIBILITY_2_8
inline wxXmlAttribute *wxXmlNode::GetProperties() const
    { return GetAttributes(); }
inline bool wxXmlNode::GetPropVal(const wxString& propName,
                                  wxString *value) const
    { return GetAttribute(propName, value); }
inline wxString wxXmlNode::GetPropVal(const wxString& propName,
                                      const wxString& defaultVal) const
    { return GetAttribute(propName, defaultVal); }
inline bool wxXmlNode::HasProp(const wxString& propName) const
    { return HasAttribute(propName); }
inline void wxXmlNode::SetProperties(wxXmlAttribute *prop)
    { SetAttributes(prop); }
#endif // WXWIN_COMPATIBILITY_2_8


// special indentation value for wxXmlDocument::Save
#define wxXML_NO_INDENTATION           (-1)

// flags for wxXmlDocument::Load
enum wxXmlDocumentLoadFlag
{
    wxXMLDOC_NONE = 0,
    wxXMLDOC_KEEP_WHITESPACE_NODES = 1
};


// This class holds XML data/document as parsed by XML parser.

class WXDLLIMPEXP_XML wxXmlDocument : public wxObject
{
public:
    wxXmlDocument();
    wxXmlDocument(const wxString& filename,
                  const wxString& encoding = wxT("UTF-8"));
    wxXmlDocument(wxInputStream& stream,
                  const wxString& encoding = wxT("UTF-8"));
    virtual ~wxXmlDocument() { wxDELETE(m_docNode); }

    wxXmlDocument(const wxXmlDocument& doc);
    wxXmlDocument& operator=(const wxXmlDocument& doc);

    // Parses .xml file and loads data. Returns TRUE on success, FALSE
    // otherwise.
    virtual bool Load(const wxString& filename,
                      const wxString& encoding = wxT("UTF-8"), int flags = wxXMLDOC_NONE);
    virtual bool Load(wxInputStream& stream,
                      const wxString& encoding = wxT("UTF-8"), int flags = wxXMLDOC_NONE);

    // Saves document as .xml file.
    virtual bool Save(const wxString& filename, int indentstep = 2) const;
    virtual bool Save(wxOutputStream& stream, int indentstep = 2) const;

    bool IsOk() const { return GetRoot() != NULL; }

    // Returns root node of the document.
    wxXmlNode *GetRoot() const;
    // Returns the document node.
    wxXmlNode *GetDocumentNode() const { return m_docNode; }


    // Returns version of document (may be empty).
    const wxString& GetVersion() const { return m_version; }
    // Returns encoding of document (may be empty).
    // Note: this is the encoding original file was saved in, *not* the
    // encoding of in-memory representation!
    const wxString& GetFileEncoding() const { return m_fileEncoding; }

    // Write-access methods:
    wxXmlNode *DetachDocumentNode() { wxXmlNode *old=m_docNode; m_docNode=NULL; return old; }
    void SetDocumentNode(wxXmlNode *node) { wxDELETE(m_docNode); m_docNode = node; }
    wxXmlNode *DetachRoot();
    void SetRoot(wxXmlNode *node);
    void SetVersion(const wxString& version) { m_version = version; }
    void SetFileEncoding(const wxString& encoding) { m_fileEncoding = encoding; }
    void AppendToProlog(wxXmlNode *node);

#if !wxUSE_UNICODE
    // Returns encoding of in-memory representation of the document
    // (same as passed to Load or ctor, defaults to UTF-8).
    // NB: this is meaningless in Unicode build where data are stored as wchar_t*
    wxString GetEncoding() const { return m_encoding; }
    void SetEncoding(const wxString& enc) { m_encoding = enc; }
#endif

    static wxVersionInfo GetLibraryVersionInfo();

private:
    wxString   m_version;
    wxString   m_fileEncoding;
#if !wxUSE_UNICODE
    wxString   m_encoding;
#endif
    wxXmlNode *m_docNode;

    void DoCopy(const wxXmlDocument& doc);

    DECLARE_CLASS(wxXmlDocument)
};

#endif // wxUSE_XML

#endif // _WX_XML_H_
Commit	Line	Data
27b0c286	1	/////////////////////////////////////////////////////////////////////////////
80fdcdb9	2	// Name: wx/xml/xml.h
27b0c286 VS	3	// Purpose: wxXmlDocument - XML parser & data holder class
	4	// Author: Vaclav Slavik
	5	// Created: 2000/03/05
	6	// RCS-ID: $Id$
	7	// Copyright: (c) 2000 Vaclav Slavik
65571936	8	// Licence: wxWindows licence
27b0c286 VS	9	/////////////////////////////////////////////////////////////////////////////
	10
	11
27b0c286 VS	12	#ifndef _WX_XML_H_
	13	#define _WX_XML_H_
	14
27b0c286 VS	15	#include "wx/defs.h"
	16
	17	#if wxUSE_XML
	18
	19	#include "wx/string.h"
	20	#include "wx/object.h"
	21	#include "wx/list.h"
ccec9093	22	#include "wx/versioninfo.h"
27b0c286 VS	23
	24	#ifdef WXMAKINGDLL_XML
	25	#define WXDLLIMPEXP_XML WXEXPORT
	26	#elif defined(WXUSINGDLL)
	27	#define WXDLLIMPEXP_XML WXIMPORT
	28	#else // not making nor using DLL
	29	#define WXDLLIMPEXP_XML
	30	#endif
	31
b5dbe15d	32	class WXDLLIMPEXP_FWD_XML wxXmlNode;
288b6107	33	class WXDLLIMPEXP_FWD_XML wxXmlAttribute;
b5dbe15d VS	34	class WXDLLIMPEXP_FWD_XML wxXmlDocument;
	35	class WXDLLIMPEXP_FWD_XML wxXmlIOHandler;
	36	class WXDLLIMPEXP_FWD_BASE wxInputStream;
	37	class WXDLLIMPEXP_FWD_BASE wxOutputStream;
27b0c286	38
27b0c286 VS	39	// Represents XML node type.
	40	enum wxXmlNodeType
	41	{
	42	// note: values are synchronized with xmlElementType from libxml
	43	wxXML_ELEMENT_NODE = 1,
	44	wxXML_ATTRIBUTE_NODE = 2,
	45	wxXML_TEXT_NODE = 3,
	46	wxXML_CDATA_SECTION_NODE = 4,
	47	wxXML_ENTITY_REF_NODE = 5,
	48	wxXML_ENTITY_NODE = 6,
	49	wxXML_PI_NODE = 7,
	50	wxXML_COMMENT_NODE = 8,
	51	wxXML_DOCUMENT_NODE = 9,
	52	wxXML_DOCUMENT_TYPE_NODE = 10,
	53	wxXML_DOCUMENT_FRAG_NODE = 11,
	54	wxXML_NOTATION_NODE = 12,
	55	wxXML_HTML_DOCUMENT_NODE = 13
	56	};
	57
	58
	59	// Represents node property(ies).
	60	// Example: in <img src="hello.gif" id="3"/> "src" is property with value
	61	// "hello.gif" and "id" is prop. with value "3".
	62
288b6107	63	class WXDLLIMPEXP_XML wxXmlAttribute
27b0c286 VS	64	{
27b0c286 VS	65	public:
288b6107 VS	66	wxXmlAttribute() : m_next(NULL) {}
	67	wxXmlAttribute(const wxString& name, const wxString& value,
	68	wxXmlAttribute *next = NULL)
27b0c286	69	: m_name(name), m_value(value), m_next(next) {}
288b6107	70	virtual ~wxXmlAttribute() {}
27b0c286	71
2d55af1d JS	72	const wxString& GetName() const { return m_name; }
2d55af1d JS	73	const wxString& GetValue() const { return m_value; }
288b6107	74	wxXmlAttribute *GetNext() const { return m_next; }
27b0c286 VS	75
	76	void SetName(const wxString& name) { m_name = name; }
	77	void SetValue(const wxString& value) { m_value = value; }
288b6107	78	void SetNext(wxXmlAttribute *next) { m_next = next; }
27b0c286 VS	79
	80	private:
	81	wxString m_name;
	82	wxString m_value;
288b6107	83	wxXmlAttribute *m_next;
27b0c286 VS	84	};
27b0c286 VS	85
288b6107 VS	86	#if WXWIN_COMPATIBILITY_2_8
	87	// NB: #define is used instead of typedef so that forward declarations
	88	// continue to work
	89	#define wxXmlProperty wxXmlAttribute
	90	#endif
27b0c286 VS	91
27b0c286 VS	92
288b6107 VS	93	// Represents node in XML document. Node has name and may have content and
288b6107 VS	94	// attributes. Most common node types are wxXML_TEXT_NODE (name and attributes
27b0c286 VS	95	// are irrelevant) and wxXML_ELEMENT_NODE (e.g. in <title>hi</title> there is
	96	// element with name="title", irrelevant content and one child (wxXML_TEXT_NODE
	97	// with content="hi").
	98	//
	99	// If wxUSE_UNICODE is 0, all strings are encoded in the encoding given to Load
	100	// (default is UTF-8).
	101
	102	class WXDLLIMPEXP_XML wxXmlNode
	103	{
	104	public:
288b6107	105	wxXmlNode()
6e26d6b7	106	: m_attrs(NULL), m_parent(NULL), m_children(NULL), m_next(NULL),
30f6914b	107	m_lineNo(-1), m_noConversion(false)
6e26d6b7 VS	108	{
	109	}
	110
4c43dd90 JS	111	wxXmlNode(wxXmlNode *parent, wxXmlNodeType type,
4c43dd90 JS	112	const wxString& name, const wxString& content = wxEmptyString,
6e26d6b7 VS	113	wxXmlAttribute attrs = NULL, wxXmlNode next = NULL,
	114	int lineNo = -1);
	115
4c43dd90	116	virtual ~wxXmlNode();
27b0c286	117
4c51a665	118	// copy ctor & operator=. Note that this does NOT copy siblings
27b0c286 VS	119	// and parent pointer, i.e. m_parent and m_next will be NULL
27b0c286 VS	120	// after using copy ctor and are never unmodified by operator=.
288b6107	121	// On the other hand, it DOES copy children and attributes.
27b0c286 VS	122	wxXmlNode(const wxXmlNode& node);
	123	wxXmlNode& operator=(const wxXmlNode& node);
	124
	125	// user-friendly creation:
	126	wxXmlNode(wxXmlNodeType type, const wxString& name,
6e26d6b7 VS	127	const wxString& content = wxEmptyString,
6e26d6b7 VS	128	int lineNo = -1);
4c43dd90	129	virtual void AddChild(wxXmlNode *child);
5e05df3c	130	virtual bool InsertChild(wxXmlNode child, wxXmlNode followingNode);
43a302f2	131	virtual bool InsertChildAfter(wxXmlNode child, wxXmlNode precedingNode);
4c43dd90	132	virtual bool RemoveChild(wxXmlNode *child);
e13ce4a3 VZ	133	virtual void AddAttribute(const wxString& name, const wxString& value);
e13ce4a3 VZ	134	virtual bool DeleteAttribute(const wxString& name);
27b0c286 VS	135
	136	// access methods:
	137	wxXmlNodeType GetType() const { return m_type; }
12058e0c VS	138	const wxString& GetName() const { return m_name; }
12058e0c VS	139	const wxString& GetContent() const { return m_content; }
27b0c286	140
538f3830 VS	141	bool IsWhitespaceOnly() const;
	142	int GetDepth(wxXmlNode *grandparent = NULL) const;
	143
4c43dd90 JS	144	// Gets node content from wxXML_ENTITY_NODE
	145	// The problem is, <tag>content<tag> is represented as
	146	// wxXML_ENTITY_NODE name="tag", content=""
	147	// \|-- wxXML_TEXT_NODE or
	148	// wxXML_CDATA_SECTION_NODE name="" content="content"
	149	wxString GetNodeContent() const;
	150
27b0c286 VS	151	wxXmlNode *GetParent() const { return m_parent; }
	152	wxXmlNode *GetNext() const { return m_next; }
	153	wxXmlNode *GetChildren() const { return m_children; }
	154
288b6107 VS	155	wxXmlAttribute *GetAttributes() const { return m_attrs; }
	156	bool GetAttribute(const wxString& attrName, wxString *value) const;
	157	wxString GetAttribute(const wxString& attrName,
b5cc5cbd	158	const wxString& defaultVal = wxEmptyString) const;
288b6107	159	bool HasAttribute(const wxString& attrName) const;
27b0c286	160
6e26d6b7 VS	161	int GetLineNumber() const { return m_lineNo; }
6e26d6b7 VS	162
27b0c286 VS	163	void SetType(wxXmlNodeType type) { m_type = type; }
	164	void SetName(const wxString& name) { m_name = name; }
	165	void SetContent(const wxString& con) { m_content = con; }
	166
	167	void SetParent(wxXmlNode *parent) { m_parent = parent; }
	168	void SetNext(wxXmlNode *next) { m_next = next; }
	169	void SetChildren(wxXmlNode *child) { m_children = child; }
	170
288b6107	171	void SetAttributes(wxXmlAttribute *attr) { m_attrs = attr; }
e13ce4a3	172	virtual void AddAttribute(wxXmlAttribute *attr);
288b6107	173
30f6914b JS	174	// If true, don't do encoding conversion to improve efficiency - node content is ACII text
	175	bool GetNoConversion() const { return m_noConversion; }
	176	void SetNoConversion(bool noconversion) { m_noConversion = noconversion; }
	177
288b6107 VS	178	#if WXWIN_COMPATIBILITY_2_8
	179	wxDEPRECATED( inline wxXmlAttribute *GetProperties() const );
	180	wxDEPRECATED( inline bool GetPropVal(const wxString& propName,
	181	wxString *value) const );
	182	wxDEPRECATED( inline wxString GetPropVal(const wxString& propName,
	183	const wxString& defaultVal) const );
	184	wxDEPRECATED( inline bool HasProp(const wxString& propName) const );
	185
	186	wxDEPRECATED( inline void SetProperties(wxXmlAttribute *prop) );
	187	#endif // WXWIN_COMPATIBILITY_2_8
	188
	189	// The following three functions are backward compatibility, but because
	190	// they were virtual, we must make it possible to override them. This
	191	// is done by calling e.g. AddProperty() from AddAttribute(), so we have
	192	// to keep AddProperty() even if 2.8 compatibility is off. To prevent
	193	// old code from compiling in that case, we make them private and
	194	// non-virtual. (This can be removed when WXWIN_COMPATIBILITY_2_8 is
	195	// removed, we'll have just *Attribute versions then.)
	196	#if WXWIN_COMPATIBILITY_2_8
	197	wxDEPRECATED_BUT_USED_INTERNALLY(
	198	virtual void AddProperty(const wxString& name, const wxString& value) );
	199	wxDEPRECATED_BUT_USED_INTERNALLY(
	200	virtual bool DeleteProperty(const wxString& name) );
	201	wxDEPRECATED_BUT_USED_INTERNALLY(
	202	virtual void AddProperty(wxXmlAttribute *attr) );
	203	#else
	204	private:
	205	void AddProperty(const wxString& name, const wxString& value);
	206	bool DeleteProperty(const wxString& name);
	207	void AddProperty(wxXmlAttribute *attr);
	208	#endif // WXWIN_COMPATIBILITY_2_8/!WXWIN_COMPATIBILITY_2_8
27b0c286 VS	209
	210	private:
	211	wxXmlNodeType m_type;
	212	wxString m_name;
	213	wxString m_content;
288b6107	214	wxXmlAttribute *m_attrs;
27b0c286	215	wxXmlNode m_parent, m_children, *m_next;
b5cc5cbd	216	int m_lineNo; // line number in original file, or -1
30f6914b	217	bool m_noConversion; // don't do encoding conversion - node is plain text
27b0c286	218
0b3e395a	219	void DoFree();
27b0c286 VS	220	void DoCopy(const wxXmlNode& node);
	221	};
	222
288b6107 VS	223	#if WXWIN_COMPATIBILITY_2_8
	224	inline wxXmlAttribute *wxXmlNode::GetProperties() const
	225	{ return GetAttributes(); }
	226	inline bool wxXmlNode::GetPropVal(const wxString& propName,
	227	wxString *value) const
	228	{ return GetAttribute(propName, value); }
	229	inline wxString wxXmlNode::GetPropVal(const wxString& propName,
	230	const wxString& defaultVal) const
	231	{ return GetAttribute(propName, defaultVal); }
	232	inline bool wxXmlNode::HasProp(const wxString& propName) const
	233	{ return HasAttribute(propName); }
	234	inline void wxXmlNode::SetProperties(wxXmlAttribute *prop)
	235	{ SetAttributes(prop); }
	236	#endif // WXWIN_COMPATIBILITY_2_8
	237
27b0c286 VS	238
27b0c286 VS	239
538f3830 VS	240	// special indentation value for wxXmlDocument::Save
538f3830 VS	241	#define wxXML_NO_INDENTATION (-1)
27b0c286	242
538f3830 VS	243	// flags for wxXmlDocument::Load
	244	enum wxXmlDocumentLoadFlag
	245	{
	246	wxXMLDOC_NONE = 0,
	247	wxXMLDOC_KEEP_WHITESPACE_NODES = 1
	248	};
27b0c286 VS	249
	250
	251	// This class holds XML data/document as parsed by XML parser.
	252
	253	class WXDLLIMPEXP_XML wxXmlDocument : public wxObject
	254	{
	255	public:
	256	wxXmlDocument();
	257	wxXmlDocument(const wxString& filename,
	258	const wxString& encoding = wxT("UTF-8"));
	259	wxXmlDocument(wxInputStream& stream,
	260	const wxString& encoding = wxT("UTF-8"));
cee8636e	261	virtual ~wxXmlDocument() { wxDELETE(m_docNode); }
27b0c286 VS	262
	263	wxXmlDocument(const wxXmlDocument& doc);
	264	wxXmlDocument& operator=(const wxXmlDocument& doc);
	265
	266	// Parses .xml file and loads data. Returns TRUE on success, FALSE
	267	// otherwise.
4c43dd90	268	virtual bool Load(const wxString& filename,
538f3830	269	const wxString& encoding = wxT("UTF-8"), int flags = wxXMLDOC_NONE);
4c43dd90	270	virtual bool Load(wxInputStream& stream,
538f3830	271	const wxString& encoding = wxT("UTF-8"), int flags = wxXMLDOC_NONE);
b5cc5cbd	272
27b0c286	273	// Saves document as .xml file.
57cc93eb VS	274	virtual bool Save(const wxString& filename, int indentstep = 2) const;
57cc93eb VS	275	virtual bool Save(wxOutputStream& stream, int indentstep = 2) const;
27b0c286	276
cee8636e	277	bool IsOk() const { return GetRoot() != NULL; }
27b0c286 VS	278
27b0c286 VS	279	// Returns root node of the document.
cee8636e VZ	280	wxXmlNode *GetRoot() const;
	281	// Returns the document node.
	282	wxXmlNode *GetDocumentNode() const { return m_docNode; }
	283
27b0c286 VS	284
27b0c286 VS	285	// Returns version of document (may be empty).
12058e0c	286	const wxString& GetVersion() const { return m_version; }
27b0c286 VS	287	// Returns encoding of document (may be empty).
	288	// Note: this is the encoding original file was saved in, not the
	289	// encoding of in-memory representation!
12058e0c	290	const wxString& GetFileEncoding() const { return m_fileEncoding; }
27b0c286 VS	291
27b0c286 VS	292	// Write-access methods:
cee8636e VZ	293	wxXmlNode DetachDocumentNode() { wxXmlNode old=m_docNode; m_docNode=NULL; return old; }
	294	void SetDocumentNode(wxXmlNode *node) { wxDELETE(m_docNode); m_docNode = node; }
	295	wxXmlNode *DetachRoot();
	296	void SetRoot(wxXmlNode *node);
27b0c286 VS	297	void SetVersion(const wxString& version) { m_version = version; }
27b0c286 VS	298	void SetFileEncoding(const wxString& encoding) { m_fileEncoding = encoding; }
cee8636e	299	void AppendToProlog(wxXmlNode *node);
27b0c286 VS	300
	301	#if !wxUSE_UNICODE
	302	// Returns encoding of in-memory representation of the document
	303	// (same as passed to Load or ctor, defaults to UTF-8).
	304	// NB: this is meaningless in Unicode build where data are stored as wchar_t*
	305	wxString GetEncoding() const { return m_encoding; }
	306	void SetEncoding(const wxString& enc) { m_encoding = enc; }
	307	#endif
	308
ccec9093 VZ	309	static wxVersionInfo GetLibraryVersionInfo();
ccec9093 VZ	310
27b0c286 VS	311	private:
	312	wxString m_version;
	313	wxString m_fileEncoding;
	314	#if !wxUSE_UNICODE
	315	wxString m_encoding;
	316	#endif
cee8636e	317	wxXmlNode *m_docNode;
27b0c286 VS	318
27b0c286 VS	319	void DoCopy(const wxXmlDocument& doc);
4c43dd90 JS	320
4c43dd90 JS	321	DECLARE_CLASS(wxXmlDocument)
27b0c286 VS	322	};
	323
	324	#endif // wxUSE_XML
	325
	326	#endif // _WX_XML_H_