X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4c43dd9078b2f9f8bb280020a878932272d0163e..66c2bf7b1d9326fb650acfaae22ec50528cfbf7c:/include/wx/xml/xml.h?ds=sidebyside diff --git a/include/wx/xml/xml.h b/include/wx/xml/xml.h index 83bedabb5f..6187e12c35 100644 --- a/include/wx/xml/xml.h +++ b/include/wx/xml/xml.h @@ -1,9 +1,8 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: 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 ///////////////////////////////////////////////////////////////////////////// @@ -19,6 +18,7 @@ #include "wx/string.h" #include "wx/object.h" #include "wx/list.h" +#include "wx/versioninfo.h" #ifdef WXMAKINGDLL_XML #define WXDLLIMPEXP_XML WXEXPORT @@ -28,13 +28,12 @@ #define WXDLLIMPEXP_XML #endif -class WXDLLIMPEXP_XML wxXmlNode; -class WXDLLIMPEXP_XML wxXmlProperty; -class WXDLLIMPEXP_XML wxXmlDocument; -class WXDLLIMPEXP_XML wxXmlIOHandler; -class WXDLLIMPEXP_BASE wxInputStream; -class WXDLLIMPEXP_BASE wxOutputStream; - +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 @@ -60,33 +59,38 @@ enum wxXmlNodeType // Example: in "src" is property with value // "hello.gif" and "id" is prop. with value "3". -class WXDLLIMPEXP_XML wxXmlProperty +class WXDLLIMPEXP_XML wxXmlAttribute { public: - wxXmlProperty() : m_next(NULL) {} - wxXmlProperty(const wxString& name, const wxString& value, - wxXmlProperty *next = NULL) + wxXmlAttribute() : m_next(NULL) {} + wxXmlAttribute(const wxString& name, const wxString& value, + wxXmlAttribute *next = NULL) : m_name(name), m_value(value), m_next(next) {} - virtual ~wxXmlProperty() {} + virtual ~wxXmlAttribute() {} - wxString GetName() const { return m_name; } - wxString GetValue() const { return m_value; } - wxXmlProperty *GetNext() const { return m_next; } + 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(wxXmlProperty *next) { m_next = next; } + void SetNext(wxXmlAttribute *next) { m_next = next; } private: wxString m_name; wxString m_value; - wxXmlProperty *m_next; + 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 properties. Most common node types are wxXML_TEXT_NODE (name and props +// 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 hi there is // element with name="title", irrelevant content and one child (wxXML_TEXT_NODE // with content="hi"). @@ -97,33 +101,44 @@ private: class WXDLLIMPEXP_XML wxXmlNode { public: - wxXmlNode() : m_properties(NULL), m_parent(NULL), - m_children(NULL), m_next(NULL) {} + 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, - wxXmlProperty *props = NULL, wxXmlNode *next = NULL); + wxXmlAttribute *attrs = NULL, wxXmlNode *next = NULL, + int lineNo = -1); + virtual ~wxXmlNode(); - // copy ctor & operator=. Note that this does NOT copy syblings + // 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 properties. + // 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); + const wxString& content = wxEmptyString, + int lineNo = -1); virtual void AddChild(wxXmlNode *child); - virtual void InsertChild(wxXmlNode *child, wxXmlNode *before_node); + virtual bool InsertChild(wxXmlNode *child, wxXmlNode *followingNode); + virtual bool InsertChildAfter(wxXmlNode *child, wxXmlNode *precedingNode); virtual bool RemoveChild(wxXmlNode *child); - virtual void AddProperty(const wxString& name, const wxString& value); - virtual bool DeleteProperty(const wxString& name); + virtual void AddAttribute(const wxString& name, const wxString& value); + virtual bool DeleteAttribute(const wxString& name); // access methods: wxXmlNodeType GetType() const { return m_type; } - wxString GetName() const { return m_name; } - wxString GetContent() const { return m_content; } + 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, content is represented as @@ -136,11 +151,13 @@ public: wxXmlNode *GetNext() const { return m_next; } wxXmlNode *GetChildren() const { return m_children; } - wxXmlProperty *GetProperties() const { return m_properties; } - bool GetPropVal(const wxString& propName, wxString *value) const; - wxString GetPropVal(const wxString& propName, - const wxString& defaultVal) const; - bool HasProp(const wxString& propName) const; + 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; } @@ -150,23 +167,84 @@ public: void SetNext(wxXmlNode *next) { m_next = next; } void SetChildren(wxXmlNode *child) { m_children = child; } - void SetProperties(wxXmlProperty *prop) { m_properties = prop; } - virtual void AddProperty(wxXmlProperty *prop); + 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; - wxXmlProperty *m_properties; + 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. @@ -179,7 +257,7 @@ public: const wxString& encoding = wxT("UTF-8")); wxXmlDocument(wxInputStream& stream, const wxString& encoding = wxT("UTF-8")); - virtual ~wxXmlDocument() { wxDELETE(m_root); } + virtual ~wxXmlDocument() { wxDELETE(m_docNode); } wxXmlDocument(const wxXmlDocument& doc); wxXmlDocument& operator=(const wxXmlDocument& doc); @@ -187,30 +265,37 @@ public: // Parses .xml file and loads data. Returns TRUE on success, FALSE // otherwise. virtual bool Load(const wxString& filename, - const wxString& encoding = wxT("UTF-8")); + const wxString& encoding = wxT("UTF-8"), int flags = wxXMLDOC_NONE); virtual bool Load(wxInputStream& stream, - const wxString& encoding = wxT("UTF-8")); - + const wxString& encoding = wxT("UTF-8"), int flags = wxXMLDOC_NONE); + // Saves document as .xml file. - virtual bool Save(const wxString& filename) const; - virtual bool Save(wxOutputStream& stream) const; + virtual bool Save(const wxString& filename, int indentstep = 2) const; + virtual bool Save(wxOutputStream& stream, int indentstep = 2) const; - bool IsOk() const { return m_root != NULL; } + bool IsOk() const { return GetRoot() != NULL; } // Returns root node of the document. - wxXmlNode *GetRoot() const { return m_root; } + wxXmlNode *GetRoot() const; + // Returns the document node. + wxXmlNode *GetDocumentNode() const { return m_docNode; } + // Returns version of document (may be empty). - wxString GetVersion() const { return m_version; } + 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! - wxString GetFileEncoding() const { return m_fileEncoding; } + const wxString& GetFileEncoding() const { return m_fileEncoding; } // Write-access methods: - void SetRoot(wxXmlNode *node) { wxDELETE(m_root); m_root = node; } + 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 @@ -220,13 +305,15 @@ public: 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_root; + wxXmlNode *m_docNode; void DoCopy(const wxXmlDocument& doc);