+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
/*
* Config_XMLReader.cpp
*
*/
#include <Config_XMLReader.h>
+#include <Config_Keywords.h>
+#include <Config_Common.h>
+#include <Config_ValidatorMessage.h>
+#include <Config_SelectionFilterMessage.h>
+#include <Config_PropManager.h>
+
+#include <Events_Loop.h>
+#include <Events_Error.h>
+#include <libxml/parser.h>
+#include <libxml/tree.h>
-#include <Event_Loop.hxx>
+#include <fstream>
-#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)
+Config_XMLReader::Config_XMLReader(const std::string& theXmlFileName)
+ : myXmlDoc(NULL)
{
- return theNode->type == XML_ELEMENT_NODE
- && !xmlStrcmp(theNode->name, (const xmlChar *) theNodeName);
-}
-
-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";
+ std::string prefix = "";
+ Config_Prop* aProp = Config_PropManager::findProp("Plugins", "default_path");
+ if (aProp)
+ prefix = aProp->value();
+ /*
+ * Get path to *.xml files (typically ./bin/../plugins/)
-Config_XMLReader::Config_XMLReader(const std::string& theXmlFile)
-{
- setDocumentPath(theXmlFile);
+ * the problem: application may be launched using python executable,
+ * to use environment variable (at least for the current moment)
+ */
+ if (prefix.empty()) {
+ char* anEnv = getenv("NEW_GEOM_CONFIG_FILE");
+ if (anEnv) {
+ prefix = std::string(anEnv);
+ }
+ }
+#ifdef WIN32
+ prefix += "\\";
+#else
+ prefix += "/";
+#endif
+ myDocumentPath = prefix + theXmlFileName;
+ std::ifstream aTestFile(myDocumentPath);
+ if (!aTestFile) Events_Error::send("Unable to open " + myDocumentPath);
+ aTestFile.close();
}
Config_XMLReader::~Config_XMLReader()
{
+ xmlFreeDoc(myXmlDoc);
}
-std::string Config_XMLReader::documentPath() const
+/*
+ * 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.
+ */
+void Config_XMLReader::readAll()
{
- return m_DocumentPath;
+ xmlNodePtr aRoot = findRoot();
+ readRecursively(aRoot);
}
-void Config_XMLReader::setDocumentPath(std::string documentPath)
+/*
+ * Allows to customize reader's behavior for a node. Virtual.
+ * The default impl does nothing. (In debug mode prints
+ * some info)
+ */
+void Config_XMLReader::processNode(xmlNodePtr theNode)
{
- 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 (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;
+ } else if (isNode(theNode, NODE_VALIDATOR, NULL)) {
+ processValidator(theNode);
+ } else if (isNode(theNode, NODE_SELFILTER, NULL)) {
+ processSelectionFilter(theNode);
+ }
}
-void Config_XMLReader::readAll()
+/*
+ * Defines which nodes should be processed recursively. Virtual.
+ * The default impl is to read all nodes.
+ */
+bool Config_XMLReader::processChildren(xmlNodePtr aNode)
{
- import();
+ return true;
}
/*
- * TODO: make virtual as beforeImport
+ *
*/
-bool Config_XMLReader::import()
+xmlNodePtr Config_XMLReader::findRoot()
{
- 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;
+ if (myXmlDoc == NULL) {
+ myXmlDoc = xmlParseFile(myDocumentPath.c_str());
}
- xmlNodePtr aRoot = xmlDocGetRootElement(aDoc);
+ if (myXmlDoc == NULL) {
+#ifdef _DEBUG
+ std::cout << "Config_XMLReader::import: " << "Document " << myDocumentPath
+ << " is not parsed successfully." << std::endl;
+#endif
+ return NULL;
+ }
+ 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
+ * Calls processNode() for each child (for some - recursively)
+ * of the given node.
+ * \sa ReadAll()
*/
-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"))
- continue;
- std::string aGroupName = getProperty(aGroupNode, FEATURE_GROUP_NAME);
- if(aGroupName.empty())
+ if (!theParent)
+ return;
+ xmlNodePtr aNode = theParent->xmlChildrenNode;
+ for (; aNode; aNode = aNode->next) {
+ //Still no text processing in features...
+ if (!isElementNode(aNode)) {
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);
}
}
- return true;
}
-void Config_XMLReader::fillFeature(void *theRoot,
- Config_FeatureMessage& outFeatureMessage)
+/*
+ * void* -> xmlNodePtr
+ */
+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);
}
-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::processValidator(xmlNodePtr theNode)
+{
+ Events_ID aValidatoEvent = Events_Loop::eventByName(EVENT_VALIDATOR_LOADED);
+ Events_Loop* aEvLoop = Events_Loop::loop();
+ std::shared_ptr<Config_ValidatorMessage>
+ aMessage(new Config_ValidatorMessage(aValidatoEvent, this));
+ std::string aValidatorId;
+ std::list<std::string> aParameters;
+ getParametersInfo(theNode, aValidatorId, aParameters);
+ aMessage->setValidatorId(aValidatorId);
+ aMessage->setValidatorParameters(aParameters);
+ xmlNodePtr aFeatureOrWdgNode = theNode->parent;
+ if (isNode(aFeatureOrWdgNode, NODE_FEATURE, NULL)) {
+ aMessage->setFeatureId(getProperty(aFeatureOrWdgNode, _ID));
+ } else {
+ aMessage->setAttributeId(getProperty(aFeatureOrWdgNode, _ID));
+ aMessage->setFeatureId(myCurrentFeature);
+ }
+ aEvLoop->send(aMessage);
+}
+
+void Config_XMLReader::processSelectionFilter(xmlNodePtr theNode)
+{
+ Events_ID aFilterEvent = Events_Loop::eventByName(EVENT_SELFILTER_LOADED);
+ Events_Loop* aEvLoop = Events_Loop::loop();
+ std::shared_ptr<Config_SelectionFilterMessage> aMessage =
+ std::make_shared<Config_SelectionFilterMessage>(aFilterEvent, this);
+ std::string aSelectionFilterId;
+ std::list<std::string> aParameters;
+ getParametersInfo(theNode, aSelectionFilterId, aParameters);
+ aMessage->setSelectionFilterId(aSelectionFilterId);
+ aMessage->setFilterParameters(aParameters);
+
+ xmlNodePtr aFeatureOrWdgNode = theNode->parent;
+ if (isNode(aFeatureOrWdgNode, NODE_FEATURE, NULL)) {
+ aMessage->setFeatureId(getProperty(aFeatureOrWdgNode, _ID));
+ } else {
+ aMessage->setAttributeId(getProperty(aFeatureOrWdgNode, _ID));
+ aMessage->setFeatureId(myCurrentFeature);
+ }
+ aEvLoop->send(aMessage);
+}
