src/KM_xml.h

   1 /*
   2 Copyright (c) 2005-2011, John Hurst
   3 All rights reserved.
   4
   5 Redistribution and use in source and binary forms, with or without
   6 modification, are permitted provided that the following conditions
   7 are met:
   8 1. Redistributions of source code must retain the above copyright
   9    notice, this list of conditions and the following disclaimer.
  10 2. Redistributions in binary form must reproduce the above copyright
  11    notice, this list of conditions and the following disclaimer in the
  12    documentation and/or other materials provided with the distribution.
  13 3. The name of the author may not be used to endorse or promote products
  14    derived from this software without specific prior written permission.
  15
  16 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  17 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  18 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  19 IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  20 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  21 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25 THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26 */
  27 /*! \file    KM_xml.h
  28     \version $Id$
  29     \brief   XML writer
  30 */
  31
  32
  33 #ifndef _KM_XML_H_
  34 #define _KM_XML_H_
  35
  36 #include <KM_util.h>
  37 #include <list>
  38 #include <string>
  39
  40 namespace Kumu
  41 {
  42   class XMLElement;
  43
  44   // Return true if the given string contains an XML document (or the start of one).
  45   bool StringIsXML(const char* document, ui32_t len = 0);
  46
  47   //
  48   struct NVPair
  49   {
  50     std::string name;
  51     std::string value;
  52   };
  53
  54   //
  55   typedef std::list<NVPair> AttributeList;
  56   typedef AttributeList::const_iterator Attr_i;
  57   typedef std::list<XMLElement*> ElementList;
  58   typedef ElementList::const_iterator Elem_i;
  59
  60   //
  61   class XMLNamespace
  62   {
  63     std::string   m_Prefix;
  64     std::string   m_Name;
  65
  66     KM_NO_COPY_CONSTRUCT(XMLNamespace);
  67     XMLNamespace();
  68
  69     public:
  70   XMLNamespace(const char* prefix, const char* name) : m_Prefix(prefix), m_Name(name) {}
  71     ~XMLNamespace() {}
  72
  73     inline const std::string& Prefix() const { return m_Prefix; }
  74     inline const std::string& Name() const { return m_Name; }
  75   };
  76
  77   //
  78   class XMLElement
  79     {
  80       KM_NO_COPY_CONSTRUCT(XMLElement);
  81       XMLElement();
  82
  83     protected:
  84       AttributeList       m_AttrList;
  85       ElementList         m_ChildList;
  86       const XMLNamespace* m_Namespace;
  87       void*               m_NamespaceOwner;
  88
  89       std::string   m_Name;
  90       std::string   m_Body;
  91
  92     public:
  93       XMLElement(const char* name);
  94       ~XMLElement();
  95
  96       inline const XMLNamespace* Namespace() const { return m_Namespace; }
  97       inline void                SetNamespace(const XMLNamespace* ns) { assert(ns); m_Namespace = ns; }
  98
  99       bool        ParseString(const char* document, ui32_t doc_len);
 100       bool        ParseString(const ByteString& document);
 101       bool        ParseString(const std::string& document);
 102
 103       // building
 104       void        SetName(const char* name);
 105       void        SetBody(const std::string& value);
 106       void        AppendBody(const std::string& value);
 107       void        SetAttr(const char* name, const char* value);
 108       void        SetAttr(const char* name, const std::string& value) { SetAttr(name, value.c_str()); }
 109       XMLElement* AddChild(XMLElement* element);
 110       XMLElement* AddChild(const char* name);
 111       XMLElement* AddChildWithContent(const char* name, const char* value);
 112       XMLElement* AddChildWithContent(const char* name, const std::string& value);
 113       XMLElement* AddChildWithPrefixedContent(const char* name, const char* prefix, const char* value);
 114       void        AddComment(const char* value);
 115       void        Render(std::string& str) const { Render(str, true); }
 116       void        Render(std::string&, const bool& pretty) const;
 117       void        RenderElement(std::string& outbuf, const ui32_t& depth, const bool& pretty) const;
 118
 119       // querying
 120       inline const std::string&   GetBody() const { return m_Body; }
 121       inline const ElementList&   GetChildren() const { return m_ChildList; }
 122       inline const std::string&   GetName() const { return m_Name; }
 123       inline const AttributeList& GetAttributes() const { return m_AttrList; }
 124       const char*        GetAttrWithName(const char* name) const;
 125       XMLElement*        GetChildWithName(const char* name) const;
 126       const ElementList& GetChildrenWithName(const char* name, ElementList& outList) const;
 127       bool               HasName(const char* name) const;
 128
 129       // altering
 130       void        DeleteAttributes();
 131       void        DeleteAttrWithName(const char* name);
 132       void        DeleteChildren();
 133       void        DeleteChild(const XMLElement* element);
 134       void        ForgetChild(const XMLElement* element);
 135     };
 136 } // namespace Kumu
 137
 138 #endif // _KM_XML_H_
 139
 140 //
 141 // end KM_xml.h
 142 //