-/////////////////////////////////////////////////////////////////////////////
-// Name: 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_
-
-#if defined(__GNUG__) && !defined(__APPLE__)
-#pragma interface "xml.h"
-#endif
-
-#include "wx/defs.h"
-#include "wx/string.h"
-#include "wx/object.h"
-#include "wx/list.h"
-
-#ifdef WXMAKINGDLL_XRC
- #define WXDLLIMPEXP_XRC WXEXPORT
-#elif defined(WXUSINGDLL)
- #define WXDLLIMPEXP_XRC WXIMPORT
-#else // not making nor using DLL
- #define WXDLLIMPEXP_XRC
-#endif
-
-class WXDLLIMPEXP_XRC wxXmlNode;
-class WXDLLIMPEXP_XRC wxXmlProperty;
-class WXDLLIMPEXP_XRC wxXmlDocument;
-class WXDLLIMPEXP_XRC wxXmlIOHandler;
-class WXDLLEXPORT wxInputStream;
-class WXDLLEXPORT 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_XRC wxXmlProperty
-{
-public:
- wxXmlProperty() : m_next(NULL) {}
- wxXmlProperty(const wxString& name, const wxString& value,
- wxXmlProperty *next)
- : m_name(name), m_value(value), m_next(next) {}
-
- wxString GetName() const { return m_name; }
- wxString GetValue() const { return m_value; }
- wxXmlProperty *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; }
-
-private:
- wxString m_name;
- wxString m_value;
- wxXmlProperty *m_next;
-};
-
-
-
-// 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
-// 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_XRC wxXmlNode
-{
-public:
- wxXmlNode() : m_properties(NULL), m_parent(NULL),
- m_children(NULL), m_next(NULL) {}
- wxXmlNode(wxXmlNode *parent,wxXmlNodeType type,
- const wxString& name, const wxString& content,
- wxXmlProperty *props, wxXmlNode *next);
- ~wxXmlNode();
-
- // copy ctor & operator=. Note that this does NOT copy syblings
- // 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.
- wxXmlNode(const wxXmlNode& node);
- wxXmlNode& operator=(const wxXmlNode& node);
-
- // user-friendly creation:
- wxXmlNode(wxXmlNodeType type, const wxString& name,
- const wxString& content = wxEmptyString);
- void AddChild(wxXmlNode *child);
- void InsertChild(wxXmlNode *child, wxXmlNode *before_node);
- bool RemoveChild(wxXmlNode *child);
- void AddProperty(const wxString& name, const wxString& value);
- bool DeleteProperty(const wxString& name);
-
- // access methods:
- wxXmlNodeType GetType() const { return m_type; }
- wxString GetName() const { return m_name; }
- wxString GetContent() const { return m_content; }
-
- wxXmlNode *GetParent() const { return m_parent; }
- 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;
-
- 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 SetProperties(wxXmlProperty *prop) { m_properties = prop; }
- void AddProperty(wxXmlProperty *prop);
-
-private:
- wxXmlNodeType m_type;
- wxString m_name;
- wxString m_content;
- wxXmlProperty *m_properties;
- wxXmlNode *m_parent, *m_children, *m_next;
-
- void DoCopy(const wxXmlNode& node);
-};
-
-
-
-
-
-
-
-// This class holds XML data/document as parsed by XML parser.
-
-class WXDLLIMPEXP_XRC wxXmlDocument : public wxObject
-{
-public:
- wxXmlDocument();
- wxXmlDocument(const wxString& filename,
- const wxString& encoding = wxT("UTF-8"));
- wxXmlDocument(wxInputStream& stream,
- const wxString& encoding = wxT("UTF-8"));
- ~wxXmlDocument() { delete m_root; }
-
- wxXmlDocument(const wxXmlDocument& doc);
- wxXmlDocument& operator=(const wxXmlDocument& doc);
-
- // Parses .xml file and loads data. Returns TRUE on success, FALSE
- // otherwise.
- bool Load(const wxString& filename,
- const wxString& encoding = wxT("UTF-8"));
- bool Load(wxInputStream& stream,
- const wxString& encoding = wxT("UTF-8"));
-
- // Saves document as .xml file.
- bool Save(const wxString& filename) const;
- bool Save(wxOutputStream& stream) const;
-
- bool IsOk() const { return m_root != NULL; }
-
- // Returns root node of the document.
- wxXmlNode *GetRoot() const { return m_root; }
-
- // Returns version of document (may be empty).
- 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; }
-
- // Write-access methods:
- void SetRoot(wxXmlNode *node) { delete m_root ; m_root = node; }
- void SetVersion(const wxString& version) { m_version = version; }
- void SetFileEncoding(const wxString& encoding) { m_fileEncoding = encoding; }
-
-#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
-
-private:
- wxString m_version;
- wxString m_fileEncoding;
-#if !wxUSE_UNICODE
- wxString m_encoding;
-#endif
- wxXmlNode *m_root;
-
- void DoCopy(const wxXmlDocument& doc);
-};
-
-#endif // _WX_XML_H_
projects / wxWidgets.git / commitdiff
