Salome HOME
Merge branch 'master' of newgeom:newgeom
[modules/shaper.git] / src / Config / Config_XMLReader.cpp
index 658d62478a0bba00239e3a6ac2eaf625fd4b554f..6abf8ea7b04359857add3f1488cecdc19cb2d683 100644 (file)
 
 #include <Config_XMLReader.h>
 
-#include <Event_Loop.hxx>
-
+#include <Event_Loop.h>
 #include <libxml\parser.h>
 #include <libxml\tree.h>
+
+/*
 #ifdef WIN32
 //For GetModuleFileNameW
 #include <windows.h>
 #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);
-}
+  std::string prefix = "";
+  /*
+   * Get path to *.xml files (typically ./bin/../plugins/)
 
-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";
+   * the problem: application may be launched using python executable,
+   * to use environment variable (at least for the current moment)
+   */
+  char* anEnv = getenv("NEW_GEOM_CONFIG_FILE");
+  if (anEnv) {
+    prefix = std::string(anEnv) + "/";
+  }
 
-Config_XMLReader::Config_XMLReader(const std::string& theXmlFile)
-{
-  setDocumentPath(theXmlFile);
+  myDocumentPath = prefix + theXmlFileName;
 }
 
 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 implementation does nothing. (In debug mode prints
+ * some info)
+ */
+void Config_XMLReader::processNode(xmlNodePtr aNode)
 {
-  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/";
+#ifdef _DEBUG
+  std::cout << "Config_XMLReader::processNode: "
+  << aNode->name << " content: "
+  << aNode->content << std::endl;
 #endif
-  m_DocumentPath = prefix + documentPath;
 }
 
-void Config_XMLReader::readAll()
+/*
+ * Defines which nodes should be processed recursively. Virtual.
+ * The default implementation 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;
+  myXmlDoc = xmlParseFile(myDocumentPath.c_str());
+  if (myXmlDoc == NULL) {
+#ifdef _DEBUG
+    std::cout << "Config_XMLReader::import: " << "Document " << myDocumentPath
+    << " 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
+ * 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())
-      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);
+  if (!theParent)
+    return;
+  xmlNodePtr aNode = theParent->xmlChildrenNode;
+  for(; aNode; aNode = aNode->next) {
+    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)
+/*
+ * Returns named property for a given node as std::string.
+ */
+std::string Config_XMLReader::getProperty(xmlNodePtr theNode, const char* name)
 {
   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*) xmlGetProp(theNode, BAD_CAST name);
+  if (!aPropChars || aPropChars[0] == 0)
     return result;
   result = std::string(aPropChars);
   return result;
 }
+
+/*
+ * Returns true if theNode is XML node with a given name.
+ */
+bool Config_XMLReader::isNode(xmlNodePtr theNode, const char* theNodeName, ...)
+{
+  bool result = false;
+  const xmlChar* aName = theNode->name;
+  if (!aName || theNode->type != XML_ELEMENT_NODE)
+    return false;
+
+  if (!xmlStrcmp(aName, (const xmlChar *) theNodeName))
+    return true;
+
+  va_list args; // define argument list variable
+  va_start(args, theNodeName); // init list; point to last defined argument
+  while(true) {
+    char *anArg = va_arg (args, char*); // get next argument
+    if (anArg == NULL)
+      break;
+    if (!xmlStrcmp(aName, (const xmlChar *) anArg)) {
+      va_end(args); // cleanup the system stack
+      return true;
+    }
+  }
+  va_end(args); // cleanup the system stack
+  return false;
+}