XMLCoreNode.h

Go to the documentation of this file.

// This file's extension implies that it's C, but it's really -*- C++ -*-.
/*
 * Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration.
 */
 
 
#ifndef XMLCOREPARSER_XMLCORENODE_H
#define XMLCOREPARSER_XMLCORENODE_H
 
 
#include <string>
#include <map>
#include <vector>
#include <memory>
#include <optional>
#include <iosfwd>
#include <stdexcept>
 

class ExcXMLCore
  : public std::runtime_error
{
public:
  ExcXMLCore (const std::string& what);
};
 

class XMLCoreNode
{
public:
  typedef enum
    {
      DOCUMENT_NODE,
      ELEMENT_NODE,
      COMMENT_NODE,
      TEXT_NODE,
      ENTITY_NODE,
      ENTITY_REFERENCE_NODE
    } NodeType;
 

  XMLCoreNode (NodeType type,
               const std::string& name="",
               const std::string& value="");
 

  void set_attrib (const std::string& name, const std::string& value);
 

  XMLCoreNode* add_child (std::unique_ptr<XMLCoreNode> child);
 

  XMLCoreNode* get_parent();
 

  const XMLCoreNode* get_parent() const;
 

  NodeType get_type () const;
 

  const std::string& get_name () const;
 

  const std::string& get_value () const;
 

  size_t n_attribs() const;
 

  std::string get_attrib_name (size_t i) const;
 

  bool has_attrib (const std::string& name) const;
 

  std::optional<int> try_int_attrib (const std::string& name) const;
 

  std::optional<double> try_double_attrib (const std::string& name) const;
 

  const std::string& get_attrib (const std::string& name) const;
 

  int get_int_attrib (const std::string& name) const;
 

  double get_double_attrib (const std::string& name) const;
 

  const XMLCoreNode* get_child (const std::string& path) const;
 

  std::vector<const XMLCoreNode*> get_children (const std::string& path ="*") const;
 
 
  /*
   * @brief Print the node structure in XML format (to cout).
   * @param header String to print on hte first line.
   * @param depth Initial nesting depth.
   */
  void print (const std::string& header, int depth = 0) const;
 
 
  /*
   * @brief Print the node structure in XML format.
   * @param os Stream to which to print.
   * @param header String to print on hte first line.
   * @param depth Initial nesting depth.
   */
  void print (std::ostream& os, const std::string& header, int depth = 0) const;
 
 
private:
  void set_parent (XMLCoreNode* parent);
 

  template <class T>
  std::optional<T> try_attrib (const std::string& name) const;
 

  void collect_children (const std::string& path,
                         std::vector<const XMLCoreNode*>& children,
                         bool only_one) const;
 

  XMLCoreNode* m_parent = nullptr;

  NodeType m_type;

  std::string m_name;

  std::string m_value;

  std::map<std::string, std::string> m_attribs;

  std::vector<std::unique_ptr<XMLCoreNode> > m_children;
};
 
 
#endif // not XMLCOREPARSER_XMLCORENODE_H