Blame view

src/xmlbase.h 3.79 KB
f12cc090   Peter M. Groen   Intermediate Commit
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
  /* ****************************************************************************
   * Copyright 2022 Open Systems Development BV                                 *
   *                                                                            *
   * Permission is hereby granted, free of charge, to any person obtaining a    *
   * copy of this software and associated documentation files (the "Software"), *
   * to deal in the Software without restriction, including without limitation  *
   * the rights to use, copy, modify, merge, publish, distribute, sublicense,   *
   * and/or sell copies of the Software, and to permit persons to whom the      *
   * Software is furnished to do so, subject to the following conditions:       *
   *                                                                            *
   * The above copyright notice and this permission notice shall be included in *
   * all copies or substantial portions of the Software.                        *
   *                                                                            *
   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *
   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,   *
   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL    *
   * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING    *
   * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER        *
   * DEALINGS IN THE SOFTWARE.                                                  *
   * ***************************************************************************/
  
  #pragma once
  
  #include <pugixml.hpp>
  #include <string>
  #include <vector>
  #include <variant>
  
  namespace osdev {
  namespace components {
  namespace xml {
  
  /*!
   *  \brief  xml_string_writer
   *          This struct is used to write a pugixml DOM document to a std::string.
   *          pugiXML is not able to do this on its own, but we use the possibility
   *          to dump an xml-document to std::cout.
   */
  struct xml_string_writer : pugi::xml_writer
  {
      std::string result = std::string();
      virtual void write(const void* data, size_t size) override;
  };
  
  /*!
   *  \brief  The XmlBase class describes the base class for all xml related classes.
   *          The basic functionality is implemented here. This class is intrended to
   *          be inherited an d specialized and not to be used directly. ( Nothing bad
   *          will happen, just to make life easier. )
   */
  class XmlBase
  {
  public:
      /*! Default constructor */
      explicit XmlBase(const std::string xmlFile = std::string() );
      virtual ~XmlBase();
  
      /*!
       *  \brief Parses the xml contents of the string.
       *  \param sxml - String containing the xml-string
       *  \return true if succesful, false if not...
       */
      bool parseString(const std::string &sxml);
  
      /*!
       *  \brief Parses the contents of the givenm XML-file.
       *  \param sxml - String with the filepath & -name of the xml file.
       *  \return true if succesfull, false if not.
       */
      bool parseFile(const std::string sxml);
  
      /*!
       *  \brief Adds and XPath expression to the internal structure.
       *  \param sName - Name of the XPath expression. This should be descriptive to make life easier.
       *  \param sXPath - The XPath expression to the specific data we're interested in.
       */
      void addXPath(const std::string &sName, const std::string &sXPath);
  
      /*!
       *  \brief Retrieves an XPatrh expression from the internal structure
       *  \param sXpathSelect - The name of the XPath expression
       *  \return The XPath expression as stored in the internal Hash.
       */
      std::string getXPath(const std::string &sXpathSelect);
  
  
  };
  
  
  }   // End namespace xml
  }   // End namespace components
  }   // End namespace osdev