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 long int
  87 raw_convert (std::string v);
  88
  89 template <>
  90 float
  91 raw_convert (std::string v);
  92
  93 template <>
  94 double
  95 raw_convert (std::string v);
  96
  97 /** @brief A wrapper for a xmlpp::Node which simplifies parsing */
  98 class Node
  99 {
 100 public:
 101         Node ();
 102
 103         /** Construct a Node from an xmlpp::Node.  This class will
 104          *  not destroy the xmlpp::Node.
 105          *  @param node xmlpp::Node.
 106          */
 107         Node (xmlpp::Node* node);
 108
 109         std::string name () const;
 110
 111         /* A set of methods which look up a child of this node by
 112          * its name, and return its contents as some type or other.
 113          *
 114          * If, for example, this object has been created with
 115          * a node named "Fred", we might have the following XML:
 116          *
 117          * <Fred>
 118          *   <Jim>42</Jim>
 119          * </Fred>
 120          *
 121          * string_child ("Jim") would return "42"
 122          * number_child<int64_t> ("Jim") would return 42.
 123          * ...and so on.
 124          *
 125          * The methods not marked "optional" will throw an exception
 126          * if the child node is not present.  The "optional" methods
 127          * will return an empty boost::optional<> in that case.
 128          *
 129          * All methods will also throw an exception if there is more
 130          * than one of the specified child node.
 131          */
 132
 133         std::string string_child (std::string c) const;
 134         boost::optional<std::string> optional_string_child (std::string) const;
 135
 136         bool bool_child (std::string) const;
 137         boost::optional<bool> optional_bool_child (std::string) const;
 138
 139         template <class T>
 140         T number_child (std::string c) const
 141         {
 142                 std::string s = string_child (c);
 143                 boost::erase_all (s, " ");
 144                 return raw_convert<T> (s);
 145         }
 146
 147         template <class T>
 148         boost::optional<T> optional_number_child (std::string c) const
 149         {
 150                 boost::optional<std::string> s = optional_string_child (c);
 151                 if (!s) {
 152                         return boost::optional<T> ();
 153                 }
 154
 155                 std::string t = s.get ();
 156                 boost::erase_all (t, " ");
 157                 return raw_convert<T> (t);
 158         }
 159
 160         /** This will mark a child as to be ignored when calling done() */
 161         void ignore_child (std::string) const;
 162
 163         /** Check whether all children of this Node have been looked up
 164          *  or passed to ignore_child().  If not, an exception is thrown.
 165          */
 166         void done () const;
 167
 168         /* These methods look for an attribute of this node, in the
 169          * same way as the child methods do.
 170          */
 171
 172         std::string string_attribute (std::string) const;
 173         boost::optional<std::string> optional_string_attribute (std::string) const;
 174
 175         bool bool_attribute (std::string) const;
 176         boost::optional<bool> optional_bool_attribute (std::string) const;
 177
 178         template <class T>
 179         T number_attribute (std::string c) const
 180         {
 181                 std::string s = string_attribute (c);
 182                 boost::erase_all (s, " ");
 183                 return raw_convert<T> (s);
 184         }
 185
 186         template <class T>
 187         boost::optional<T> optional_number_attribute (std::string c) const
 188         {
 189                 boost::optional<std::string> s = optional_string_attribute (c);
 190                 if (!s) {
 191                         return boost::optional<T> ();
 192                 }
 193
 194                 std::string t = s.get ();
 195                 boost::erase_all (t, " ");
 196                 return raw_convert<T> (t);
 197         }
 198
 199         /** @return The text content of this node (excluding comments or CDATA) */
 200         std::string content () const;
 201
 202         /** @return namespace URI of this node */
 203         std::string namespace_uri () const;
 204
 205         /** @return namespace prefix of this node */
 206         std::string namespace_prefix () const;
 207
 208         boost::shared_ptr<Node> node_child (std::string) const;
 209         boost::shared_ptr<Node> optional_node_child (std::string) const;
 210
 211         std::list<boost::shared_ptr<Node> > node_children () const;
 212         std::list<boost::shared_ptr<Node> > node_children (std::string) const;
 213
 214         xmlpp::Node* node () const {
 215                 return _node;
 216         }
 217
 218 protected:
 219         xmlpp::Node* _node;
 220
 221 private:
 222         mutable std::list<std::string> _taken;
 223 };
 224
 225 typedef boost::shared_ptr<cxml::Node> NodePtr;
 226 typedef boost::shared_ptr<const cxml::Node> ConstNodePtr;
 227
 228 class Document : public Node
 229 {
 230 public:
 231         Document ();
 232         Document (std::string root_name);
 233         Document (std::string root_name, boost::filesystem::path);
 234
 235         virtual ~Document ();
 236
 237         void read_file (boost::filesystem::path);
 238         void read_string (std::string);
 239
 240         std::string root_name () const {
 241                 return _root_name;
 242         }
 243
 244 private:
 245         void take_root_node ();
 246
 247         xmlpp::DomParser* _parser;
 248         std::string _root_name;
 249 };
 250
 251 }
 252
 253 #endif