]> SALOME platform Git repositories - modules/shaper.git/blob - src/Config/Config_XMLReader.h
Salome HOME
Porting to SALOME_8.2.0 : Debug visualization selection for AIS_Trihedron axes.
[modules/shaper.git] / src / Config / Config_XMLReader.h
1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
2
3 /*
4  * Config_XMLReader.h
5  *
6  *  Created on: Mar 14, 2014
7  *      Author: sbh
8  */
9
10 #ifndef CONFIG_XMLREADER_H_
11 #define CONFIG_XMLREADER_H_
12
13 #include <Config_def.h>
14
15 #include <cstdarg>
16 #include <string>
17 #include <map>
18
19 //>> Forward declaration of xmlNodePtr.
20 typedef struct _xmlNode xmlNode;
21 typedef xmlNode *xmlNodePtr;
22 struct _xmlNode;
23 //<<
24
25 //>> Forward declaration of xmlDocPtr.
26 typedef struct _xmlDoc xmlDoc;
27 typedef xmlDoc *xmlDocPtr;
28 struct _xmlDoc;
29 //<<
30
31 /*!
32  * \class Config_XMLReader
33  * \ingroup Config
34  * \brief Base class for all libxml readers. Provides high-level API
35  * for all xml operations.
36 */
37 class Config_XMLReader
38 {
39  public:
40   /*!
41    * Constructor
42    * \param theXmlFile - full path to the xml file which will be processed by the reader
43    */
44   CONFIG_EXPORT Config_XMLReader(const std::string& theXmlFile);
45   CONFIG_EXPORT virtual ~Config_XMLReader();
46   /*!
47    * Returns a path to the plugins.xml file (created from ROOT_DIR environment variable)
48    * \return string value
49    */
50   CONFIG_EXPORT static std::string pluginConfigFile();
51   /*!
52    * Read all nodes in associated xml file,
53    * recursively if processChildren(xmlNode) is true for the xmlNode.
54    * For each read node the processNode will be called.
55    */
56   CONFIG_EXPORT void readAll();
57   /*!
58    * Returns xmlNodePtr to the root of reader's document
59    * or NULL if not found
60    */
61   CONFIG_EXPORT xmlNodePtr findRoot();
62
63   CONFIG_EXPORT const char* encoding() const;
64
65  protected:
66   /*!
67    * \brief Allows to customize reader's behavior for a node. Virtual.
68    * The default implementation process "source", "validator" and
69    * "selection_filter" nodes.
70    */
71   virtual void processNode(xmlNodePtr aNode);
72
73   /*!
74    * This method gives an ability to finalize processing of a node,
75    * when reader is about to leave the node (node and all it's children are processed)
76    */
77   virtual void cleanup(xmlNodePtr aNode);
78   /*!
79    * \brief Defines which nodes should be processed recursively. Virtual.
80    * The default impl is to read all nodes.
81    */
82   virtual bool processChildren(xmlNodePtr aNode);
83   /*!
84    * Calls processNode() for each child (for some - recursively)
85    * of the given node.
86    * \sa ReadAll()
87    */
88   void readRecursively(xmlNodePtr theParent);
89   /*!
90    * \brief void* -> xmlNodePtr
91    */
92   xmlNodePtr node(void* theNode);
93   /// Gets xml node name
94   std::string getNodeName(xmlNodePtr theNode);
95   /// Stores an attribute in internal map for later use.
96   /// Key is "Node_Name:Node_Attribute" and value is getProperty(theNodeAttribute)
97   void storeAttribute(xmlNodePtr theNode, const char* theNodeAttribute, bool doClean = false);
98   /// Restores an attribute from internal map.
99   std::string restoreAttribute(xmlNodePtr theNode, const char* theNodeAttribute);
100   /// Restores an attribute from internal map.
101   std::string restoreAttribute(const char* theNodeName, const char* theNodeAttribute);
102   /// Cleanups attribute from cache
103   bool cleanupAttribute(xmlNodePtr theNode, const char* theNodeAttribute);
104   /// Cleanups attribute from cache
105   bool cleanupAttribute(const char* theNodeName, const char* theNodeAttribute);
106
107  protected:
108   std::string myDocumentPath; ///< Path to the xml document
109   xmlDocPtr myXmlDoc; ///< Root of the xml document
110   /// A map to store all parent's attributes.
111   /// The key has from "Node_Name:Node_Attribute"
112   std::map<std::string, std::string> myCachedAttributes;
113 };
114
115 #endif /* CONFIG_XMLREADER_H_ */