-/*
- * Config_XMLReader.cpp
- *
- * Created on: Mar 14, 2014
- * Author: sbh
- */
+// 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
+// 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
+//
#include <Config_XMLReader.h>
+#include <Config_Keywords.h>
+#include <Config_Common.h>
+#include <Config_PropManager.h>
+#include <Config_ModuleReader.h>
-#include <Event_Loop.hxx>
+#include <Events_Loop.h>
+#include <Events_InfoMessage.h>
+#include <libxml/parser.h>
+#include <libxml/tree.h>
+
+#include <fstream>
+#include <sstream>
-#include <libxml\parser.h>
-#include <libxml\tree.h>
#ifdef WIN32
-//For GetModuleFileNameW
-#include <windows.h>
+#pragma warning(disable : 4996) // for getenv
#endif
#ifdef _DEBUG
#include <iostream>
#endif
-static bool IsNode(xmlNodePtr theNode, const char* theNodeName)
+#ifdef WIN32
+ static const char FSEP = '\\';
+#else
+ static const char FSEP = '/';
+#endif
+
+Config_XMLReader::Config_XMLReader(const std::string& theXmlFileName, bool isXMLContent)
+ : myXmlDoc(NULL), myRootFileName(theXmlFileName)
{
- return theNode->type == XML_ELEMENT_NODE
- && !xmlStrcmp(theNode->name, (const xmlChar *) theNodeName);
+ isFromMemory = isXMLContent;
+ if (!isXMLContent) {
+ myDocumentPath = findConfigFile(theXmlFileName);
+ if (myDocumentPath.empty()) {
+ Events_InfoMessage("Config_XMLReader", "Unable to open %1").arg(theXmlFileName).send();
+ }
+ }
}
-const static char* FEATURE_ID = "id";
-const static char* FEATURE_TEXT = "text";
-const static char* FEATURE_TOOLTIP = "tooltip";
-const static char* FEATURE_ICON = "icon";
-const static char* FEATURE_KEYSEQUENCE = "keysequence";
-const static char* FEATURE_GROUP_NAME = "name";
+Config_XMLReader::~Config_XMLReader()
+{
+ xmlFreeDoc(myXmlDoc);
+}
-Config_XMLReader::Config_XMLReader(const std::string& theXmlFile)
+// LCOV_EXCL_START
+std::string Config_XMLReader::resourcesConfigFile()
{
- setDocumentPath(theXmlFile);
+ std::string aValue;
+ char* anEnv = getenv("SHAPER_ROOT_DIR");
+ if (anEnv) {
+ aValue = std::string(anEnv) +
+ FSEP + "share" + FSEP + "salome" + FSEP + "resources" + FSEP + "shaper";
+ } else {
+ anEnv = getenv("CADBUILDER_ROOT_DIR");
+ if (anEnv) {
+ aValue = std::string(anEnv) + FSEP + "resources";
+ }
+ }
+ return aValue;
}
-Config_XMLReader::~Config_XMLReader()
+std::string Config_XMLReader::pluginConfigFile()
{
+ std::string aValue;
+ char* anEnv = getenv("SHAPER_ROOT_DIR");
+ if (anEnv) {
+ aValue = std::string(anEnv) +
+ FSEP + "share" + FSEP + "salome" + FSEP + "resources" + FSEP + "shaper";
+ } else {
+ anEnv = getenv("CADBUILDER_ROOT_DIR");
+ if (anEnv) {
+ aValue = std::string(anEnv) + FSEP + "plugins";
+ }
+ }
+ return aValue;
}
+// LCOV_EXCL_STOP
-std::string Config_XMLReader::documentPath() const
+std::string Config_XMLReader::findConfigFile(const std::string theFileName, const int theFindIndex)
{
- return m_DocumentPath;
+ int aResultIndex = 0;
+ for(int aSolution = 0; aSolution < 12; aSolution++) {
+ std::string aFileName;
+ if (aSolution == 0) {
+ Config_Prop* aProp = Config_PropManager::findProp("Plugins", "default_path");
+ if (!aProp)
+ continue;
+ aFileName = aProp->value();
+ } else {
+ std::ostringstream anEnvName;
+ if (aSolution == 1)
+ anEnvName<<"SHAPER_ROOT_DIR";
+ else if (aSolution == 2)
+ anEnvName<<"CADBUILDER_ROOT_DIR";
+ else
+ anEnvName<<"CADBUILDER_ROOT_DIR";
+
+ char* anEnv = getenv(anEnvName.str().c_str());
+ if (!anEnv)
+ continue;
+ if (aSolution > 2) { // there may be several paths separated by ";" symbol
+// LCOV_EXCL_START
+ std::string anEnvPart = anEnv;
+ size_t aPosStart = 0, aPosEnd;
+ for(int aSubNum = 0; aSubNum < aSolution - 3; aSubNum++) {
+ aPosStart++;
+ aPosStart = anEnvPart.find(';', aPosStart);
+ if (aPosStart == std::string::npos)
+ break;
+ }
+ if (aPosStart == std::string::npos)
+ break;
+ if (aPosStart != 0)
+ aPosStart++;
+ aPosEnd = anEnvPart.find(';', aPosStart);
+ aFileName = anEnvPart.substr(aPosStart,
+ aPosEnd == std::string::npos ? aPosEnd : aPosEnd - aPosStart) + FSEP;
+// LCOV_EXCL_STOP
+ } else {
+ aFileName = std::string(anEnv) + FSEP;
+ }
+ if (aSolution == 1)
+ aFileName += std::string("share") + FSEP + "salome" + FSEP + "resources" + FSEP + "shaper";
+ else if (aSolution == 2)
+ aFileName += "plugins";
+ }
+
+ aFileName += FSEP + theFileName;
+ std::ifstream aTestFile(aFileName);
+ if (aTestFile) {
+ if (aResultIndex == theFindIndex)
+ return aFileName;
+ aResultIndex++;
+ if (aSolution == 1) // don't allow SHAPER and CADBuilder paths treated simultaneously
+ aSolution++;
+ }
+ }
+ return ""; // no files found
}
-void Config_XMLReader::setDocumentPath(std::string documentPath)
+void Config_XMLReader::readAll()
{
- std::string prefix;
-#ifdef WIN32
- HMODULE hModule = GetModuleHandleW(NULL);
- WCHAR wchar_path[MAX_PATH];
- GetModuleFileNameW(hModule, wchar_path, MAX_PATH);
- char char_path[MAX_PATH];
- char DefChar = ' ';
- WideCharToMultiByte(CP_ACP, 0, wchar_path, -1, char_path, MAX_PATH, &DefChar, NULL);
- prefix = std::string(char_path);
- //chop "bin\XGUI.exe"
- unsigned found = prefix.rfind("bin");
- if(found != std::string::npos)
- prefix.replace(found, prefix.length(), "plugins\\");
-#else
- //TODO(sbh): Find full path to binary on linux
- prefix = "../plugins/";
+ if (isFromMemory) {
+ myXmlDoc = xmlParseMemory(myRootFileName.c_str(), (int)myRootFileName.length());
+ xmlNodePtr aRoot = xmlDocGetRootElement(myXmlDoc);
+ readRecursively(aRoot);
+ return;
+ }
+
+ // to load external modules dependencies (like GEOM for Connector Feature)
+ Config_ModuleReader::loadScript("salome.shaper.initConfig", false);
+
+ for(int aSolution = 0; true; aSolution++) {
+ std::string aFoundFile = findConfigFile(myRootFileName, aSolution);
+ if (aFoundFile.empty()) {
+ break; // no more solutions
+ }
+
+ if (myXmlDoc != NULL) { // clear the previous XML document - now the new one will be opened
+ xmlFreeDoc(myXmlDoc);
+ myXmlDoc = NULL;
+ }
+ xmlNodePtr aRoot = findRoot(aFoundFile);
+ readRecursively(aRoot);
+ }
+}
+
+void Config_XMLReader::processNode(xmlNodePtr theNode)
+{
+ if (isNode(theNode, NODE_SOURCE, NULL)) {
+ std::string aSourceFile = getProperty(theNode, SOURCE_FILE);
+ Config_XMLReader aSourceReader = Config_XMLReader(aSourceFile);
+ readRecursively(aSourceReader.findRoot());
+#ifdef _DEBUG
+ //std::cout << "Config_XMLReader::sourced node: " << aSourceFile << std::endl;
#endif
- m_DocumentPath = prefix + documentPath;
+ }
}
-void Config_XMLReader::readAll()
+void Config_XMLReader::cleanup(xmlNodePtr)
{
- import();
+ // do nothing;
}
-/*
- * TODO: make virtual as beforeImport
- */
-bool Config_XMLReader::import()
+// LCOV_EXCL_START
+bool Config_XMLReader::processChildren(xmlNodePtr /*aNode*/)
{
- bool result = false;
- xmlDocPtr aDoc;
- aDoc = xmlParseFile(m_DocumentPath.c_str());
- if(aDoc == NULL) {
- #ifdef _DEBUG
- std::cout << "Config_XMLReader::import: " << "Document " << m_DocumentPath
- << " is not parsed successfully." << std::endl;
- #endif
- return result;
+ return true;
+}
+// LCOV_EXCL_STOP
+
+xmlNodePtr Config_XMLReader::findRoot(const std::string theDocumentPath)
+{
+ std::string aDocPath = theDocumentPath.empty() ? myDocumentPath : theDocumentPath;
+ if (myXmlDoc == NULL) {
+ myXmlDoc = xmlParseFile(aDocPath.c_str());
+ }
+ if (myXmlDoc == NULL) {
+#ifdef _DEBUG
+ std::cout << "Config_XMLReader::import: " << "Document " << aDocPath
+ << " is not parsed successfully." << std::endl;
+#endif
+ return NULL;
}
- xmlNodePtr aRoot = xmlDocGetRootElement(aDoc);
+ xmlNodePtr aRoot = xmlDocGetRootElement(myXmlDoc);
+#ifdef _DEBUG
if(aRoot == NULL) {
- #ifdef _DEBUG
std::cout << "Config_XMLReader::import: " << "Error: empty document";
- #endif
- return result;
- }
- xmlNodePtr aWbSec;
- for(aWbSec = aRoot->xmlChildrenNode; aWbSec; aWbSec = aWbSec->next) { // searching for higher level element "workbench"
- if(IsNode(aWbSec, "workbench")) {
- result = importWorkbench(aWbSec);
- } else {
- #ifdef _DEBUG
- std::cout << "Config_XMLReader::import: "
- << "Found strange section, should be workbench" << std::endl;
- #endif
- continue;
- }
}
- return result;
+#endif
+ return aRoot;
}
-/*
- * TODO(sbh): make virtual as doImport
- */
-bool Config_XMLReader::importWorkbench(void* theRoot)
+void Config_XMLReader::readRecursively(xmlNodePtr theParent)
{
- xmlNodePtr aGroupNode = (static_cast<xmlNodePtr>(theRoot))->xmlChildrenNode;
- Event_Loop* aEvLoop = Event_Loop::Loop();
- if(!aEvLoop) {
- #ifdef _DEBUG
- std::cout << "Config_XMLReader::importWorkbench: "
- << "No event loop registered" << std::endl;
- #endif
- return false;
- }
- for(; aGroupNode; aGroupNode = aGroupNode->next) { // searching for record
- if(!IsNode(aGroupNode, "group"))
+ if (!theParent)
+ return;
+ xmlNodePtr aNode = theParent->xmlChildrenNode;
+ for (; aNode; aNode = aNode->next) {
+ //Still no text processing in features...
+ if (!isElementNode(aNode)) {
continue;
- std::string aGroupName = getProperty(aGroupNode, FEATURE_GROUP_NAME);
- if(aGroupName.empty())
- continue;
- xmlNodePtr aFtNode = aGroupNode->xmlChildrenNode;
- for(; aFtNode; aFtNode = aFtNode->next) {
- if(!IsNode(aFtNode, "feature"))
- continue;
- //Create feature...
- Config_FeatureMessage aMessage(aEvLoop->EventByName("Feature"), this);
- fillFeature(aFtNode, aMessage);
- aMessage.m_group = aGroupName;
- aEvLoop->Send(aMessage);
}
+ processNode(aNode);
+ if (processChildren(aNode)) {
+ readRecursively(aNode);
+ }
+ cleanup(aNode);
}
- return true;
}
-void Config_XMLReader::fillFeature(void *theRoot,
- Config_FeatureMessage& outFeatureMessage)
+// LCOV_EXCL_START
+xmlNodePtr Config_XMLReader::node(void* theNode)
{
- outFeatureMessage.m_id = getProperty(theRoot, FEATURE_ID);
- outFeatureMessage.m_text = getProperty(theRoot, FEATURE_TEXT);
- outFeatureMessage.m_tooltip = getProperty(theRoot, FEATURE_TOOLTIP);
- outFeatureMessage.m_icon = getProperty(theRoot, FEATURE_ICON);
- outFeatureMessage.m_keysequence = getProperty(theRoot, FEATURE_KEYSEQUENCE);
+ return static_cast<xmlNodePtr>(theNode);
}
+// LCOV_EXCL_STOP
-std::string Config_XMLReader::getProperty(void *theRoot, const char* name)
+std::string Config_XMLReader::getNodeName(xmlNodePtr theNode)
{
std::string result = "";
- xmlNodePtr aNode = (static_cast<xmlNodePtr>(theRoot));
- char* aPropChars = (char*) xmlGetProp(aNode, BAD_CAST name);
- if(!aPropChars || aPropChars[0] == 0)
+ char* aPropChars = (char*) theNode->name;
+ if (!aPropChars || aPropChars[0] == 0)
return result;
result = std::string(aPropChars);
return result;
}
+
+void Config_XMLReader::storeAttribute(xmlNodePtr theNode, const char* theAttribute, bool doClean)
+{
+ std::string aKey = getNodeName(theNode) + ":" + std::string(theAttribute);
+ std::string aValue = getProperty(theNode, theAttribute);
+ if (doClean || !aValue.empty()) {
+ myCachedAttributes[aKey] = aValue;
+ }
+}
+
+// LCOV_EXCL_START
+std::string Config_XMLReader::restoreAttribute(xmlNodePtr theNode, const char* theAttribute)
+{
+ return restoreAttribute(getNodeName(theNode).c_str(), theAttribute);
+}
+// LCOV_EXCL_STOP
+
+std::string Config_XMLReader::restoreAttribute(const char* theNodeName, const char* theAttribute)
+{
+ std::string aKey = std::string(theNodeName) + ":" + std::string(theAttribute);
+ std::string result = "";
+ if(myCachedAttributes.find(aKey) != myCachedAttributes.end()) {
+ result = myCachedAttributes[aKey];
+ }
+ return result;
+}
+
+bool Config_XMLReader::cleanupAttribute(xmlNodePtr theNode, const char* theNodeAttribute)
+{
+ return cleanupAttribute(getNodeName(theNode).c_str(), theNodeAttribute);
+}
+
+bool Config_XMLReader::cleanupAttribute(const char* theNodeName, const char* theNodeAttribute)
+{
+ std::string aKey = std::string(theNodeName) + ":" + std::string(theNodeAttribute);
+ bool result = false;
+ std::map<std::string, std::string>::iterator anEntry = myCachedAttributes.find(aKey);
+ if( anEntry != myCachedAttributes.end()) {
+ myCachedAttributes.erase(anEntry);
+ result = true;
+ }
+ return result;
+}
+
+// LCOV_EXCL_START
+const char* Config_XMLReader::encoding() const
+{
+ return (const char*) myXmlDoc->encoding;
+}
+// LCOV_EXCL_STOP
