Added wxCriticalSection::TryEnter() method.

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

diff --git a/include/wx/xml/xml.h b/include/wx/xml/xml.h
index 19557b0b14b53710ff679c06741aa5af54f89526..fbd6faa4acaff834915885277c0a0f985df84167 100644 (file)
--- a/include/wx/xml/xml.h
+++ b/include/wx/xml/xml.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        xml.h
+// Name:        wx/xml/xml.h

 // Purpose:     wxXmlDocument - XML parser & data holder class
 // Author:      Vaclav Slavik
 // Created:     2000/03/05
 // Purpose:     wxXmlDocument - XML parser & data holder class
 // Author:      Vaclav Slavik
 // Created:     2000/03/05


@@ -19,6 +19,7 @@
 #include "wx/string.h"
 #include "wx/object.h"
 #include "wx/list.h"
 #include "wx/string.h"
 #include "wx/object.h"
 #include "wx/list.h"

+#include "wx/versioninfo.h"

 
 #ifdef WXMAKINGDLL_XML
     #define WXDLLIMPEXP_XML WXEXPORT
 
 #ifdef WXMAKINGDLL_XML
     #define WXDLLIMPEXP_XML WXEXPORT


@@ -29,13 +30,12 @@
 #endif
 
 class WXDLLIMPEXP_FWD_XML wxXmlNode;
 #endif
 
 class WXDLLIMPEXP_FWD_XML wxXmlNode;

-class WXDLLIMPEXP_FWD_XML wxXmlProperty;
+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;
 
 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
 {
 // Represents XML node type.
 enum wxXmlNodeType
 {


@@ -60,33 +60,38 @@ enum wxXmlNodeType
 // Example: in <img src="hello.gif" id="3"/> "src" is property with value
 //          "hello.gif" and "id" is prop. with value "3".
 
 // 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 wxXmlProperty
+class WXDLLIMPEXP_XML wxXmlAttribute

 {
 public:
 {
 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) {}
             : 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 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;
 
 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 <title>hi</title> there is
 // element with name="title", irrelevant content and one child (wxXML_TEXT_NODE
 // with content="hi").
 // 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").


@@ -97,28 +102,36 @@ private:
 class WXDLLIMPEXP_XML wxXmlNode
 {
 public:
 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,
     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();
 
     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=.
     // 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,
     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 AddChild(wxXmlNode *child);

-    virtual bool 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 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; }
 
     // access methods:
     wxXmlNodeType GetType() const { return m_type; }


@@ -139,11 +152,13 @@ public:
     wxXmlNode *GetNext() const { return m_next; }
     wxXmlNode *GetChildren() const { return m_children; }
 
     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; }
 
     void SetType(wxXmlNodeType type) { m_type = type; }
     void SetName(const wxString& name) { m_name = name; }


@@ -153,19 +168,72 @@ public:
     void SetNext(wxXmlNode *next) { m_next = next; }
     void SetChildren(wxXmlNode *child) { m_children = child; }
 
     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;
 
 private:
     wxXmlNodeType m_type;
     wxString m_name;
     wxString m_content;

-    wxXmlProperty *m_properties;
+    wxXmlAttribute *m_attrs;

     wxXmlNode *m_parent, *m_children, *m_next;
     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 DoCopy(const wxXmlNode& node);
 };
 
 
     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
 
 
 // special indentation value for wxXmlDocument::Save


@@ -189,7 +257,7 @@ public:
                   const wxString& encoding = wxT("UTF-8"));
     wxXmlDocument(wxInputStream& stream,
                   const wxString& encoding = wxT("UTF-8"));
                   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);
 
     wxXmlDocument(const wxXmlDocument& doc);
     wxXmlDocument& operator=(const wxXmlDocument& doc);


@@ -200,15 +268,18 @@ public:
                       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);
                       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.
     // Saves document as .xml file.

-    virtual bool Save(const wxString& filename, int indentstep = 1) const;
-    virtual bool Save(wxOutputStream& stream, int indentstep = 1) 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.
 
     // 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).
     const wxString& GetVersion() const { return m_version; }
 
     // Returns version of document (may be empty).
     const wxString& GetVersion() const { return m_version; }


@@ -218,10 +289,13 @@ public:
     const wxString& GetFileEncoding() const { return m_fileEncoding; }
 
     // Write-access methods:
     const wxString& GetFileEncoding() const { return m_fileEncoding; }
 
     // Write-access methods:

-    wxXmlNode *DetachRoot() { wxXmlNode *old=m_root; m_root=NULL; return old; }
-    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 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
 
 #if !wxUSE_UNICODE
     // Returns encoding of in-memory representation of the document


@@ -231,13 +305,15 @@ public:
     void SetEncoding(const wxString& enc) { m_encoding = enc; }
 #endif
 
     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
 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);
 
 
     void DoCopy(const wxXmlDocument& doc);