Config_XMLReader.h

// Copyright (C) 2014-2026  CEA, EDF
//
// 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
//
 
#ifndef CONFIG_XMLREADER_H_
#define CONFIG_XMLREADER_H_
 
#include <Config_def.h>
 
#include <cstdarg>
#include <string>
#include <map>
 
//>> Forward declaration of xmlNodePtr.
typedef struct _xmlNode xmlNode;
typedef xmlNode *xmlNodePtr;
struct _xmlNode;
//<<
 
//>> Forward declaration of xmlDocPtr.
typedef struct _xmlDoc xmlDoc;
typedef xmlDoc *xmlDocPtr;
struct _xmlDoc;
//<<
 
class Config_XMLReader
{
 public:
  CONFIG_EXPORT Config_XMLReader(const std::string& theXmlFile, bool isXMLContent = false);
  CONFIG_EXPORT virtual ~Config_XMLReader();
  CONFIG_EXPORT static std::string resourcesConfigFile();
  CONFIG_EXPORT static std::string pluginConfigFile();
  CONFIG_EXPORT void readAll();
  CONFIG_EXPORT xmlNodePtr findRoot(const std::string theDocumentPath = "");
 
  CONFIG_EXPORT const char* encoding() const;
 
  CONFIG_EXPORT static std::string
    findConfigFile(const std::string theFileName, const int theFindIndex = 0);
 
 protected:
  virtual void processNode(xmlNodePtr aNode);
 
  virtual void cleanup(xmlNodePtr aNode);
  virtual bool processChildren(xmlNodePtr aNode);
  void readRecursively(xmlNodePtr theParent);
  xmlNodePtr node(void* theNode);
  std::string getNodeName(xmlNodePtr theNode);
  void storeAttribute(xmlNodePtr theNode, const char* theNodeAttribute, bool doClean = false);
  std::string restoreAttribute(xmlNodePtr theNode, const char* theNodeAttribute);
  std::string restoreAttribute(const char* theNodeName, const char* theNodeAttribute);
  bool cleanupAttribute(xmlNodePtr theNode, const char* theNodeAttribute);
  bool cleanupAttribute(const char* theNodeName, const char* theNodeAttribute);
 
 protected:
  std::string myDocumentPath; 
  xmlDocPtr myXmlDoc; 
  std::string myRootFileName; 
  std::map<std::string, std::string> myCachedAttributes;
 
  bool isFromMemory;
};
 
#endif /* CONFIG_XMLREADER_H_ */