src/cxml.h

   1 /*
   2     Copyright (C) 2012-2019 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of libcxml.
   5
   6     libcxml is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     libcxml is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with libcxml.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 #ifndef LIBCXML_CXML_H
  22 #define LIBCXML_CXML_H
  23
  24 #include <boost/shared_ptr.hpp>
  25 #include <boost/optional.hpp>
  26 #include <boost/filesystem.hpp>
  27 #include <boost/algorithm/string/erase.hpp>
  28 #include <stdint.h>
  29 #include <string>
  30 #include <list>
  31
  32 /* Hack for OS X compile failure; see https://bugs.launchpad.net/hugin/+bug/910160 */
  33 #ifdef check
  34 #undef check
  35 #endif
  36
  37 namespace xmlpp {
  38         class Node;
  39         class DomParser;
  40 }
  41
  42 namespace cxml {
  43
  44 /** @brief An error */
  45 class Error : public std::exception
  46 {
  47 public:
  48         /** Construct an Error exception.
  49          *  @param message Error message.
  50          */
  51         Error (std::string const & message) : _message (message) {}
  52
  53         /** Error destructor */
  54         ~Error () throw () {}
  55
  56         /** @return error message.  Caller must not free the returned
  57          *  value.
  58          */
  59         char const * what () const throw () {
  60                 return _message.c_str ();
  61         }
  62
  63 private:
  64         /** error message */
  65         std::string _message;
  66 };
  67
  68 /** A sort-of version of boost::lexical_cast that does uses the "C"
  69  *  locale (i.e. no thousands separators and a . for the decimal separator).
  70  */
  71 template <typename P, typename Q>
  72 P
  73 raw_convert (Q v)
  74 {
  75         /* We can't write a generic version of raw_convert; all required
  76            versions must be specialised.
  77         */
  78         BOOST_STATIC_ASSERT (sizeof(Q) == 0);
  79 }
  80
  81 template <>
  82 int
  83 raw_convert (std::string v);
  84
  85 template <>
  86 float
  87 raw_convert (std::string v);
  88
  89 template <>
  90 double
  91 raw_convert (std::string v);
  92
  93 /** @brief A wrapper for a xmlpp::Node which simplifies parsing */
  94 class Node
  95 {
  96 public:
  97         Node ();
  98
  99         /** Construct a Node from an xmlpp::Node.  This class will
 100          *  not destroy the xmlpp::Node.
 101          *  @param node xmlpp::Node.
 102          */
 103         Node (xmlpp::Node* node);
 104
 105         std::string name () const;
 106
 107         /* A set of methods which look up a child of this node by
 108          * its name, and return its contents as some type or other.
 109          *
 110          * If, for example, this object has been created with
 111          * a node named "Fred", we might have the following XML:
 112          *
 113          * <Fred>
 114          *   <Jim>42</Jim>
 115          * </Fred>
 116          *
 117          * string_child ("Jim") would return "42"
 118          * number_child<int64_t> ("Jim") would return 42.
 119          * ...and so on.
 120          *
 121          * The methods not marked "optional" will throw an exception
 122          * if the child node is not present.  The "optional" methods
 123          * will return an empty boost::optional<> in that case.
 124          *
 125          * All methods will also throw an exception if there is more
 126          * than one of the specified child node.
 127          */
 128
 129         std::string string_child (std::string c) const;
 130         boost::optional<std::string> optional_string_child (std::string) const;
 131
 132         bool bool_child (std::string) const;
 133         boost::optional<bool> optional_bool_child (std::string) const;
 134
 135         template <class T>
 136         T number_child (std::string c) const
 137         {
 138                 std::string s = string_child (c);
 139                 boost::erase_all (s, " ");
 140                 return raw_convert<T> (s);
 141         }
 142
 143         template <class T>
 144         boost::optional<T> optional_number_child (std::string c) const
 145         {
 146                 boost::optional<std::string> s = optional_string_child (c);
 147                 if (!s) {
 148                         return boost::optional<T> ();
 149                 }
 150
 151                 std::string t = s.get ();
 152                 boost::erase_all (t, " ");
 153                 return raw_convert<T> (t);
 154         }
 155
 156         /** This will mark a child as to be ignored when calling done() */
 157         void ignore_child (std::string) const;
 158
 159         /** Check whether all children of this Node have been looked up
 160          *  or passed to ignore_child().  If not, an exception is thrown.
 161          */
 162         void done () const;
 163
 164         /* These methods look for an attribute of this node, in the
 165          * same way as the child methods do.
 166          */
 167
 168         std::string string_attribute (std::string) const;
 169         boost::optional<std::string> optional_string_attribute (std::string) const;
 170
 171         bool bool_attribute (std::string) const;
 172         boost::optional<bool> optional_bool_attribute (std::string) const;
 173
 174         template <class T>
 175         T number_attribute (std::string c) const
 176         {
 177                 std::string s = string_attribute (c);
 178                 boost::erase_all (s, " ");
 179                 return raw_convert<T> (s);
 180         }
 181
 182         template <class T>
 183         boost::optional<T> optional_number_attribute (std::string c) const
 184         {
 185                 boost::optional<std::string> s = optional_string_attribute (c);
 186                 if (!s) {
 187                         return boost::optional<T> ();
 188                 }
 189
 190                 std::string t = s.get ();
 191                 boost::erase_all (t, " ");
 192                 return raw_convert<T> (t);
 193         }
 194
 195         /** @return The text content of this node (excluding comments or CDATA) */
 196         std::string content () const;
 197
 198         /** @return namespace URI of this node */
 199         std::string namespace_uri () const;
 200
 201         /** @return namespace prefix of this node */
 202         std::string namespace_prefix () const;
 203
 204         boost::shared_ptr<Node> node_child (std::string) const;
 205         boost::shared_ptr<Node> optional_node_child (std::string) const;
 206
 207         std::list<boost::shared_ptr<Node> > node_children () const;
 208         std::list<boost::shared_ptr<Node> > node_children (std::string) const;
 209
 210         xmlpp::Node* node () const {
 211                 return _node;
 212         }
 213
 214 protected:
 215         xmlpp::Node* _node;
 216
 217 private:
 218         mutable std::list<std::string> _taken;
 219 };
 220
 221 typedef boost::shared_ptr<cxml::Node> NodePtr;
 222 typedef boost::shared_ptr<const cxml::Node> ConstNodePtr;
 223
 224 class Document : public Node
 225 {
 226 public:
 227         Document ();
 228         Document (std::string root_name);
 229         Document (std::string root_name, boost::filesystem::path);
 230
 231         virtual ~Document ();
 232
 233         void read_file (boost::filesystem::path);
 234         void read_string (std::string);
 235
 236         std::string root_name () const {
 237                 return _root_name;
 238         }
 239
 240 private:
 241         void take_root_node ();
 242
 243         xmlpp::DomParser* _parser;
 244         std::string _root_name;
 245 };
 246
 247 }
 248
 249 #endif