src/xml.h

   1 /*
   2     Copyright (C) 2013-2021 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of libdcp.
   5
   6     libdcp 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     libdcp 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 libdcp.  If not, see <http://www.gnu.org/licenses/>.
  18
  19     In addition, as a special exception, the copyright holders give
  20     permission to link the code of portions of this program with the
  21     OpenSSL library under certain conditions as described in each
  22     individual source file, and distribute linked combinations
  23     including the two.
  24
  25     You must obey the GNU General Public License in all respects
  26     for all of the code used other than OpenSSL.  If you modify
  27     file(s) with this exception, you may extend this exception to your
  28     version of the file(s), but you are not obligated to do so.  If you
  29     do not wish to do so, delete this exception statement from your
  30     version.  If you delete this exception statement from all source
  31     files in the program, then also delete it here.
  32 */
  33
  34
  35 /** @file  src/xml.h
  36  *  @brief Helpers for XML reading with libcxml
  37  */
  38
  39
  40 #ifndef LIBDCP_XML_H
  41 #define LIBDCP_XML_H
  42
  43
  44 #include "exceptions.h"
  45 #include <libcxml/cxml.h>
  46
  47
  48 namespace dcp
  49 {
  50
  51
  52 template <class T>
  53 std::shared_ptr<T>
  54 optional_type_child (cxml::Node const & node, std::string name)
  55 {
  56         auto n = node.node_children (name);
  57         if (n.size() > 1) {
  58                 throw XMLError ("duplicate XML tag");
  59         } else if (n.empty ()) {
  60                 return {};
  61         }
  62
  63         return std::make_shared<T>(n.front());
  64 }
  65
  66
  67 template <class T>
  68 std::shared_ptr<T> type_child (std::shared_ptr<const cxml::Node> node, std::string name) {
  69         return std::make_shared<T>(node->node_child(name));
  70 }
  71
  72
  73 template <class T>
  74 std::shared_ptr<T>
  75 optional_type_child (std::shared_ptr<const cxml::Node> node, std::string name)
  76 {
  77         return optional_type_child<T> (*node.get(), name);
  78 }
  79
  80
  81 template <class T>
  82 std::vector<std::shared_ptr<T>>
  83 type_children (cxml::Node const & node, std::string name)
  84 {
  85         std::vector<std::shared_ptr<T>> r;
  86         for (auto i: node.node_children(name)) {
  87                 r.push_back (std::make_shared<T>(i));
  88         }
  89         return r;
  90 }
  91
  92
  93 template <class T>
  94 std::vector<std::shared_ptr<T>>
  95 type_children (std::shared_ptr<const cxml::Node> node, std::string name)
  96 {
  97         return type_children<T> (*node.get(), name);
  98 }
  99
 100
 101 template <class T>
 102 std::vector<std::shared_ptr<T>>
 103 type_grand_children (cxml::Node const & node, std::string name, std::string sub)
 104 {
 105         return type_children<T> (node.node_child(name), sub);
 106 }
 107
 108
 109 template <class T>
 110 std::vector<std::shared_ptr<T>>
 111 type_grand_children (std::shared_ptr<const cxml::Node> node, std::string name, std::string sub)
 112 {
 113         return type_grand_children<T> (*node.get(), name, sub);
 114 }
 115
 116 }
 117
 118
 119 #endif