+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
/*
* Config_FeatureReader.cpp
*
* Author: sbh
*/
+#include <Config_Keywords.h>
+#include <Config_Common.h>
+#include <Config_FeatureMessage.h>
+#include <Config_AttributeMessage.h>
#include <Config_FeatureReader.h>
+#include <Events_Message.h>
+#include <Events_Loop.h>
-#include <Event_Loop.h>
+#include <libxml/parser.h>
+#include <libxml/tree.h>
+#include <libxml/xmlstring.h>
-#include <libxml\parser.h>
-#include <libxml\tree.h>
+#include <string>
+#include <algorithm>
+#include <list>
#ifdef _DEBUG
#include <iostream>
#endif
-//Hardcoded xml entities
-// * Nodes
-const static char* NODE_WORKBENCH = "workbench";
-const static char* NODE_GROUP = "group";
-const static char* NODE_FEATURE = "feature";
-
-// * Properties
-const static char* _ID = "id";
-//const static char* WORKBENCH_ID = "id";
-//const static char* GROUP_ID = "id";
-//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";
-
-Config_FeatureReader::Config_FeatureReader(const std::string& theXmlFile)
- : Config_XMLReader(theXmlFile), m_fetchWidgetCfg(false)
+Config_FeatureReader::Config_FeatureReader(const std::string& theXmlFile,
+ const std::string& theLibraryName,
+ const char* theEventGenerated)
+ : Config_XMLReader(theXmlFile),
+ myLibraryName(theLibraryName),
+ myEventGenerated(theEventGenerated ? theEventGenerated : Config_FeatureMessage::GUI_EVENT()),
+ myIsProcessWidgets(theEventGenerated != NULL)
{
-#ifdef _DEBUG
- if(!Event_Loop::Loop()) {
- std::cout << "Config_FeatureReader::importWorkbench: "
- << "No event loop registered" << std::endl;
- }
-#endif
}
Config_FeatureReader::~Config_FeatureReader()
{
}
-std::string Config_FeatureReader::featureWidgetCfg(std::string theFeatureName)
+std::list<std::string> Config_FeatureReader::features() const
{
- m_fetchWidgetCfg = true;
- readAll();
- m_fetchWidgetCfg = false;
- return m_widgetCfg;
+ return myFeatures;
}
void Config_FeatureReader::processNode(xmlNodePtr theNode)
{
+ Events_ID aMenuItemEvent = Events_Loop::eventByName(myEventGenerated);
if (isNode(theNode, NODE_FEATURE, NULL)) {
- if (m_fetchWidgetCfg) {
- xmlBufferPtr buffer = xmlBufferCreate();
- int size = xmlNodeDump(buffer, theNode->doc, theNode, 0, 1);
- m_widgetCfg = std::string((char*) buffer->content);
- } else {
- Event_Loop* aEvLoop = Event_Loop::Loop();
- Config_FeatureMessage aMessage(aEvLoop->EventByName("menu_item"), this);
- fillFeature(theNode, aMessage);
- aEvLoop->Send(aMessage);
+ storeAttribute(theNode, _ID);
+ std::shared_ptr<Config_FeatureMessage> aMessage(new Config_FeatureMessage(aMenuItemEvent, this));
+ fillFeature(theNode, aMessage);
+ myFeatures.push_back(getProperty(theNode, _ID));
+ //If a feature has xml definition for it's widget:
+ aMessage->setUseInput(hasChild(theNode));
+ Events_Loop::loop()->send(aMessage);
+ //The m_last* variables always defined before fillFeature() call. XML is a tree.
+ } else if (isNode(theNode, NODE_WORKBENCH, NODE_GROUP, NULL)) {
+ storeAttribute(theNode, _ID);
+ storeAttribute(theNode, WORKBENCH_DOC);
+ } else if (myIsProcessWidgets && isWidgetNode(theNode)) {
+ std::shared_ptr<Config_AttributeMessage> aMessage(new Config_AttributeMessage(aMenuItemEvent, this));
+ aMessage->setFeatureId(restoreAttribute(NODE_FEATURE, _ID));
+ std::string anAttributeID = getProperty(theNode, _ID);
+ if (!anAttributeID.empty()) {
+ aMessage->setAttributeId(anAttributeID);
+ aMessage->setObligatory(getBooleanAttribute(theNode, ATTR_OBLIGATORY, true));
+ aMessage->setConcealment(getBooleanAttribute(theNode, ATTR_CONCEALMENT, false));
+ Events_Loop::loop()->send(aMessage);
}
}
- //The m_last* variables always defined before fillFeature() call. XML is a tree.
- if (isNode(theNode, NODE_GROUP, NULL)) {
- m_lastGroup = getProperty(theNode, _ID);
- }
- if (isNode(theNode, NODE_WORKBENCH, NULL)) {
- m_lastWorkbench = getProperty(theNode, _ID);
- }
+ //Process SOURCE nodes.
+ Config_XMLReader::processNode(theNode);
}
bool Config_FeatureReader::processChildren(xmlNodePtr theNode)
{
- return isNode(theNode, NODE_WORKBENCH, NODE_GROUP, NULL);
+ bool result = isNode(theNode, NODE_WORKBENCH, NODE_GROUP, NULL);
+ if(!result && myIsProcessWidgets) {
+ result = isNode(theNode, NODE_FEATURE, NULL);
+ }
+ return result;
}
-void Config_FeatureReader::fillFeature(xmlNodePtr theRoot, Config_FeatureMessage& outFtMessage)
+void Config_FeatureReader::fillFeature(xmlNodePtr theFeatureNode,
+ const std::shared_ptr<Config_FeatureMessage>& outFeatureMessage)
{
- outFtMessage.setId(getProperty(theRoot, _ID));
- outFtMessage.setText(getProperty(theRoot, FEATURE_TEXT));
- outFtMessage.setTooltip(getProperty(theRoot, FEATURE_TOOLTIP));
- outFtMessage.setIcon(getProperty(theRoot, FEATURE_ICON));
- outFtMessage.setKeysequence(getProperty(theRoot, FEATURE_KEYSEQUENCE));
- outFtMessage.setGroupId(m_lastGroup);
- outFtMessage.setWorkbenchId(m_lastWorkbench);
+ outFeatureMessage->setId(getProperty(theFeatureNode, _ID));
+ outFeatureMessage->setPluginLibrary(myLibraryName);
+ outFeatureMessage->setNestedFeatures(getProperty(theFeatureNode, FEATURE_NESTED));
+ bool isInternal = getBooleanAttribute(theFeatureNode, ATTR_INTERNAL, false);
+ outFeatureMessage->setInternal(isInternal);
+ if (isInternal) {
+ //Internal feature has no visual representation.
+ return;
+ }
+ outFeatureMessage->setText(getProperty(theFeatureNode, FEATURE_TEXT));
+ outFeatureMessage->setTooltip(getProperty(theFeatureNode, FEATURE_TOOLTIP));
+ outFeatureMessage->setIcon(getProperty(theFeatureNode, FEATURE_ICON));
+ outFeatureMessage->setKeysequence(getProperty(theFeatureNode, FEATURE_KEYSEQUENCE));
+ outFeatureMessage->setGroupId(restoreAttribute(NODE_GROUP, _ID));
+ outFeatureMessage->setWorkbenchId(restoreAttribute(NODE_WORKBENCH, _ID));
+ // Get document kind of a feature, if empty set workbench's kind (might be empty too)
+ std::string aDocKind = getProperty(theFeatureNode, FEATURE_DOC);
+ if(aDocKind.empty()) {
+ aDocKind = restoreAttribute(NODE_WORKBENCH, WORKBENCH_DOC);
+ }
+ outFeatureMessage->setDocumentKind(aDocKind);
}
