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   bool GetXMLDocType(const ByteString& buf, std::string& ns_prefix, std::string& type_name,
  61                      std::string& namespace_name, AttributeList& doc_attr_list);
  62
  63   bool GetXMLDocType(const std::string& buf, std::string& ns_prefix, std::string& type_name,
  64                      std::string& namespace_name, AttributeList& doc_attr_list);
  65
  66   bool GetXMLDocType(const byte_t* buf, ui32_t buf_len, std::string& ns_prefix, std::string& type_name,
  67                      std::string& namespace_name, AttributeList& doc_attr_list);
  68
  69   //
  70   class XMLNamespace
  71   {
  72     std::string   m_Prefix;
  73     std::string   m_Name;
  74
  75     KM_NO_COPY_CONSTRUCT(XMLNamespace);
  76     XMLNamespace();
  77
  78     public:
  79   XMLNamespace(const char* prefix, const char* name) : m_Prefix(prefix), m_Name(name) {}
  80     ~XMLNamespace() {}
  81
  82     inline const std::string& Prefix() const { return m_Prefix; }
  83     inline const std::string& Name() const { return m_Name; }
  84   };
  85
  86   //
  87   class XMLElement
  88     {
  89       KM_NO_COPY_CONSTRUCT(XMLElement);
  90       XMLElement();
  91
  92     protected:
  93       AttributeList       m_AttrList;
  94       ElementList         m_ChildList;
  95       const XMLNamespace* m_Namespace;
  96       void*               m_NamespaceOwner;
  97
  98       std::string   m_Name;
  99       std::string   m_Body;
 100
 101     public:
 102       XMLElement(const char* name);
 103       ~XMLElement();
 104
 105       inline const XMLNamespace* Namespace() const { return m_Namespace; }
 106       inline void                SetNamespace(const XMLNamespace* ns) { assert(ns); m_Namespace = ns; }
 107
 108       bool        ParseString(const char* document, ui32_t doc_len);
 109       bool        ParseString(const ByteString& document);
 110       bool        ParseString(const std::string& document);
 111
 112       // building
 113       void        SetName(const char* name);
 114       void        SetBody(const std::string& value);
 115       void        AppendBody(const std::string& value);
 116       void        SetAttr(const char* name, const char* value);
 117       void        SetAttr(const char* name, const std::string& value) { SetAttr(name, value.c_str()); }
 118       XMLElement* AddChild(XMLElement* element);
 119       XMLElement* AddChild(const char* name);
 120       XMLElement* AddChildWithContent(const char* name, const char* value);
 121       XMLElement* AddChildWithContent(const char* name, const std::string& value);
 122       XMLElement* AddChildWithPrefixedContent(const char* name, const char* prefix, const char* value);
 123       void        AddComment(const char* value);
 124       void        Render(std::string& str) const { Render(str, true); }
 125       void        Render(std::string&, const bool& pretty) const;
 126       void        RenderElement(std::string& outbuf, const ui32_t& depth, const bool& pretty) const;
 127
 128       // querying
 129       inline const std::string&   GetBody() const { return m_Body; }
 130       inline const ElementList&   GetChildren() const { return m_ChildList; }
 131       inline const std::string&   GetName() const { return m_Name; }
 132       inline const AttributeList& GetAttributes() const { return m_AttrList; }
 133       const char*        GetAttrWithName(const char* name) const;
 134       XMLElement*        GetChildWithName(const char* name) const;
 135       const ElementList& GetChildrenWithName(const char* name, ElementList& outList) const;
 136       bool               HasName(const char* name) const;
 137
 138       // altering
 139       void        DeleteAttributes();
 140       void        DeleteAttrWithName(const char* name);
 141       void        DeleteChildren();
 142       void        DeleteChild(const XMLElement* element);
 143       void        ForgetChild(const XMLElement* element);
 144     };
 145 } // namespace Kumu
 146
 147 #endif // _KM_XML_H_
 148
 149 //
 150 // end KM_xml.h
 151 //