Salome HOME
updated copyright message
[modules/shaper.git] / src / Config / Config_XMLReader.h
index 53b07024f1b9dac0ed5864c83061276863665a29..18a8b6351ca1beff0c39bb4a48271676e9404540 100644 (file)
@@ -1,4 +1,4 @@
-// Copyright (C) 2014-2017  CEA/DEN, EDF R&D
+// Copyright (C) 2014-2023  CEA, EDF
 //
 // This library is free software; you can redistribute it and/or
 // modify it under the terms of the GNU Lesser General Public
 //
 // 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
+// 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>
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
 //
 
 #ifndef CONFIG_XMLREADER_H_
@@ -52,8 +51,13 @@ class Config_XMLReader
    * 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 Config_XMLReader(const std::string& theXmlFile, bool isXMLContent = false);
   CONFIG_EXPORT virtual ~Config_XMLReader();
+  /*!
+   * Returns a path to resource files (created from ROOT_DIR environment variable)
+   * \return string value
+   */
+  CONFIG_EXPORT static std::string resourcesConfigFile();
   /*!
    * Returns a path to the plugins.xml file (created from ROOT_DIR environment variable)
    * \return string value
@@ -66,13 +70,18 @@ class Config_XMLReader
    */
   CONFIG_EXPORT void readAll();
   /*!
-   * Returns xmlNodePtr to the root of reader's document
-   * or NULL if not found
+   * Returns xmlNodePtr to the root of reader's document or NULL if not found.
+   * If the path to the document to read is empty, uses myDocumentPath.
    */
-  CONFIG_EXPORT xmlNodePtr findRoot();
+  CONFIG_EXPORT xmlNodePtr findRoot(const std::string theDocumentPath = "");
 
   CONFIG_EXPORT const char* encoding() const;
 
+  /// Checks all possible paths to configuration file given
+  /// Uses theFindIndex if several solutions can be found (this is the number of solution to find)
+  CONFIG_EXPORT static std::string
+    findConfigFile(const std::string theFileName, const int theFindIndex = 0);
+
  protected:
   /*!
    * \brief Allows to customize reader's behavior for a node. Virtual.
@@ -117,9 +126,12 @@ class Config_XMLReader
  protected:
   std::string myDocumentPath; ///< Path to the xml document
   xmlDocPtr myXmlDoc; ///< Root of the xml document
+  std::string myRootFileName; ///< name of the root file
   /// A map to store all parent's attributes.
   /// The key has from "Node_Name:Node_Attribute"
   std::map<std::string, std::string> myCachedAttributes;
+
+  bool isFromMemory;
 };
 
 #endif /* CONFIG_XMLREADER_H_ */