X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FConfig%2FConfig_XMLReader.h;h=01e64c39494cecb606212073c5daec89c38fd8a9;hb=94303d51165398c71527f80bc3f8e17e75ee5523;hp=785dca9c266d08016b13057db37cc1d9390d8eab;hpb=2a0dd5ede9110d423fbd6b038c0445cb819163a9;p=modules%2Fshaper.git

diff --git a/src/Config/Config_XMLReader.h b/src/Config/Config_XMLReader.h
index 785dca9c2..01e64c394 100644
--- a/src/Config/Config_XMLReader.h
+++ b/src/Config/Config_XMLReader.h
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 /*
  * Config_XMLReader.h
  *
@@ -8,44 +10,89 @@
 #ifndef CONFIG_XMLREADER_H_
 #define CONFIG_XMLREADER_H_
 
-#include "Config.h"
-#include "Config_FeatureMessage.h"
+#include <Config_def.h>
 
-#include <string>
 #include <cstdarg>
+#include <string>
 
-//Forward declaration for xmlNodePtr.
+//>> Forward declaration of xmlNodePtr.
 typedef struct _xmlNode xmlNode;
 typedef xmlNode *xmlNodePtr;
 struct _xmlNode;
+//<<
 
-class CONFIG_EXPORT Config_XMLReader
-{
-public:
-  Config_XMLReader(const std::string& theXmlFile);
-  virtual ~Config_XMLReader();
+//>> Forward declaration of xmlDocPtr.
+typedef struct _xmlDoc xmlDoc;
+typedef xmlDoc *xmlDocPtr;
+struct _xmlDoc;
+//<<
 
-  void readAll();
+/*!
+ * \class Config_XMLReader
+ * \ingroup Config
+ * \brief Base class for all libxml readers. Provides high-level API
+ * for all xml operations.
+*/
+class Config_XMLReader
+{
+ public:
+  /*!
+   * Constructor
+   * \param theXmlFile - full path to the xml file which will be processed by the reader
+   */
+  CONFIG_EXPORT Config_XMLReader(const std::string& theXmlFile);
+  CONFIG_EXPORT virtual ~Config_XMLReader();
+  /*!
+   * Read all nodes in associated xml file,
+   * recursively if processChildren(xmlNode) is true for the xmlNode.
+   * For each read node the processNode will be called.
+   */
+  CONFIG_EXPORT void readAll();
+  /*!
+   * Returns xmlNodePtr to the root of reader's document
+   * or NULL if not found
+   */
+  CONFIG_EXPORT xmlNodePtr findRoot();
 
-protected:
+ protected:
+  /*!
+   * \brief Allows to customize reader's behavior for a node. Virtual.
+   * The default implementation process "source", "validator" and
+   * "selection_filter" nodes.
+   */
   virtual void processNode(xmlNodePtr aNode);
+  /*!
+   * \brief Defines which nodes should be processed recursively. Virtual.
+   * The default impl is to read all nodes.
+   */
   virtual bool processChildren(xmlNodePtr aNode);
-
-  xmlNodePtr findRoot();
+  /*!
+   * Calls processNode() for each child (for some - recursively)
+   * of the given node.
+   * \sa ReadAll()
+   */
   void readRecursively(xmlNodePtr theParent);
-
+  /*!
+   * \brief void* -> xmlNodePtr
+   */
   xmlNodePtr node(void* theNode);
-  std::string getProperty(xmlNodePtr theNode, const char* property);
-  /*
-   * Please note that this function should be called with NULL last argument. 
-   * In example: isNode(aNode, "type1", ["type2", ...], NULL);
-   * ", NULL" is required to use unlimited number of arguments.
-   * TODO(sbh): find a way to simplify calling this method.
+  /// Gets xml node name
+  std::string getNodeName(xmlNodePtr theNode);
+  /*!
+   * \brief Retrieves all the necessary info from the validator node.
+   * Sends ValidatorLoaded event
+   */
+  void processValidator(xmlNodePtr theNode);
+  /*!
+   * \brief Retrieves all the necessary info from the SelectionFilter node.
+   * Sends SelectionFilterLoaded event
    */
-  bool isNode(xmlNodePtr theNode, const char* name, ...);
+  void processSelectionFilter(xmlNodePtr theNode);
 
-private:
-  std::string m_DocumentPath;
+ protected:
+  std::string myCurrentFeature; ///< Name of currently processed feature
+  std::string myDocumentPath; ///< Path to the xml document
+  xmlDocPtr myXmlDoc; ///< Root of the xml document
 };
 
 #endif /* CONFIG_XMLREADER_H_ */