X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FConfig%2FConfig_ModuleReader.h;h=eb9bd51dd4c9673b1af9e34d93eecf62a2a0c1d5;hb=b4fa4c082ef0d0e75ee8bf7f3f440b3f9c86e63c;hp=911e5d813c8afa10b11f37a859812378cccb5202;hpb=4bf5c624e120ef5b7fca9625f8fdc23fbdfefc25;p=modules%2Fshaper.git

diff --git a/src/Config/Config_ModuleReader.h b/src/Config/Config_ModuleReader.h
index 911e5d813..eb9bd51dd 100644
--- a/src/Config/Config_ModuleReader.h
+++ b/src/Config/Config_ModuleReader.h
@@ -1,11 +1,22 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-/*
- * Config_XMLModuleReader.h
- *
- *  Created on: Mar 20, 2014
- *      Author: sbh
- */
+// Copyright (C) 2014-2017  CEA/DEN, EDF R&D
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+//
+// See http://www.salome-platform.org/ or
+// email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
+//
 
 #ifndef CONFIG_MODULEREADER_H_
 #define CONFIG_MODULEREADER_H_
@@ -20,6 +31,7 @@
 
 /*!
  * \class Config_ModuleReader
+ * \ingroup Config
  * \brief Class to process plugins.xml - definition of plugins (scripts, libraries).
  */
 class Config_ModuleReader : public Config_XMLReader
@@ -31,38 +43,57 @@ class Config_ModuleReader : public Config_XMLReader
   };
 
  public:
+  /// Constructor
   CONFIG_EXPORT Config_ModuleReader(const char* theEventGenerated = 0);
+  /// Destructor
   CONFIG_EXPORT virtual ~Config_ModuleReader();
-
+  /// Returns map that describes which file contains a feature
+  /// (the feature is key, the file is value)
   CONFIG_EXPORT const std::map<std::string, std::string>& featuresInFiles() const;
-
+  /// Returns list of module's xml files
+  CONFIG_EXPORT const std::set<std::string>& modulePluginFiles() const;
+  /// Returns module name: an xml attribute from the root of the plugins.xml:
+  /// e.g \code <plugins module="PartSet"> \endcode
   CONFIG_EXPORT std::string getModuleName();
-
+  /// Detects type of the given plugin and loads it using loadLibrary or loadScript.
   CONFIG_EXPORT static void loadPlugin(const std::string& thePluginName);
   /// loads the library with specific name, appends "lib*.dll" or "*.so" depending on the platform
   CONFIG_EXPORT static void loadLibrary(const std::string& theLibName);
   /// loads the python module with specified name
-  CONFIG_EXPORT static void loadScript(const std::string& theFileName);
-  // extends set of modules, which will be used for dependency 
-  // checking (if there is no required module in the set, a plugin will not be loaded)
+  /// \param theFileName name of the script
+  /// \param theSendErr send error message in case of faile
+  CONFIG_EXPORT static void loadScript(const std::string& theFileName, bool theSendErr = true);
+  /*!
+   * Extends set of modules,  used for dependency checking (if there is no
+   * required module in the set, a plugin will not be loaded)
+   */
   CONFIG_EXPORT static void addDependencyModule(const std::string& theModuleName);
 
  protected:
-  void processNode(xmlNodePtr aNode);
-  bool processChildren(xmlNodePtr aNode);
-
+  /// Recursively process the given xmlNode
+  virtual void processNode(xmlNodePtr aNode);
+  /// Defines if the reader should process children of the given node
+  virtual bool processChildren(xmlNodePtr aNode);
+  /// check if dependencies of the given node are in the list of loaded modules
   bool hasRequiredModules(xmlNodePtr aNode) const;
+  /// reads info about plugin's features from plugin xml description
   std::list<std::string> importPlugin(const std::string& thePluginLibrary,
                                       const std::string& thePluginFile);
+  /// stores information about plugin in the internal cache
   std::string addPlugin(const std::string& aPluginLibrary,
                         const std::string& aPluginScript,
                         const std::string& aPluginConf);
+  /// Save feature in myFeaturesInFiles.
+  /// Generates an error if the feature name is already registered.
+  void addFeature(const std::string& theFeatureName, const std::string& thePluginConfig);
 
  private:
-  std::map<std::string, std::string> myFeaturesInFiles;
+  std::map<std::string, std::string> myFeaturesInFiles; ///< a feature name is key, a file is value
+  std::set<std::string> myPluginFiles; ///< a feature name is key, a file is value
+  /// a plugin name is key, a plugin type is value
   static std::map<std::string, PluginType> myPluginTypes;
-  static std::set<std::string> myDependencyModules;
-  const char* myEventGenerated;
+  static std::set<std::string> myDependencyModules; ///< set of loaded modules
+  const char* myEventGenerated; ///< gives ability to send Feature_Messages to various listeners
 };
 
 #endif /* CONFIG_XMLMODULEREADER_H_ */