1 // Copyright (C) 2014-2017 CEA/DEN, EDF R&D
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 // Lesser General Public License for more details.
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 // See http://www.salome-platform.org/ or
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
21 #include <Config_Keywords.h>
22 #include <Config_Common.h>
23 #include <Config_FeatureMessage.h>
24 #include <Config_AttributeMessage.h>
25 #include <Config_FeatureReader.h>
26 #include <Config_Translator.h>
27 #include <Events_Message.h>
28 #include <Events_Loop.h>
30 #include <libxml/parser.h>
31 #include <libxml/tree.h>
32 #include <libxml/xmlstring.h>
42 Config_FeatureReader::Config_FeatureReader(const std::string& theXmlFile,
43 const std::string& theLibraryName,
44 const char* theEventGenerated)
45 : Config_XMLReader(theXmlFile),
46 myLibraryName(theLibraryName),
47 myEventGenerated(theEventGenerated ? theEventGenerated : Config_FeatureMessage::GUI_EVENT()),
48 myIsProcessWidgets(theEventGenerated != NULL)
52 Config_FeatureReader::~Config_FeatureReader()
56 std::list<std::string> Config_FeatureReader::features() const
61 void Config_FeatureReader::processNode(xmlNodePtr theNode)
63 Events_ID aMenuItemEvent = Events_Loop::eventByName(myEventGenerated);
64 if (isNode(theNode, NODE_FEATURE, NULL)) {
65 storeAttribute(theNode, _ID);
66 std::shared_ptr<Config_FeatureMessage>
67 aMessage(new Config_FeatureMessage(aMenuItemEvent, this));
68 fillFeature(theNode, aMessage);
69 myFeatures.push_back(getProperty(theNode, _ID));
70 //If a feature has xml definition for it's widget:
71 aMessage->setUseInput(hasChild(theNode));
72 Events_Loop::loop()->send(aMessage);
73 //The m_last* variables always defined before fillFeature() call. XML is a tree.
74 } else if (isNode(theNode, NODE_WORKBENCH, NODE_GROUP, NULL)) {
75 storeAttribute(theNode, _ID);
76 storeAttribute(theNode, WORKBENCH_DOC, true);
77 } else if (myIsProcessWidgets) {
78 // widgets, like shape_selector or containers, like toolbox
79 if (isAttributeNode(theNode)) {
80 std::shared_ptr<Config_AttributeMessage>
81 aMessage(new Config_AttributeMessage(aMenuItemEvent, this));
82 aMessage->setFeatureId(restoreAttribute(NODE_FEATURE, _ID));
83 std::string anAttributeID = getProperty(theNode, _ID);
84 if (!anAttributeID.empty()) {
85 aMessage->setAttributeId(anAttributeID);
86 aMessage->setObligatory(getBooleanAttribute(theNode, ATTR_OBLIGATORY, true));
87 aMessage->setConcealment(getBooleanAttribute(theNode, ATTR_CONCEALMENT, false));
89 std::list<std::pair<std::string, std::string> > aCases;
90 xmlNodePtr aCaseNode =
91 hasParentRecursive(theNode, WDG_SWITCH_CASE, WDG_TOOLBOX_BOX, WDG_OPTIONALBOX, NULL);
93 std::string aCaseNodeID = getProperty(aCaseNode, _ID);
94 std::string aSwitchNodeID = "";
95 const xmlChar* aName = aCaseNode->name;
96 xmlNodePtr aSwitchNode;
97 if (!xmlStrcmp(aName, (const xmlChar *) WDG_SWITCH_CASE)) {
98 aSwitchNode = hasParentRecursive(aCaseNode, WDG_SWITCH, NULL);
100 else if (!xmlStrcmp(aName, (const xmlChar *) WDG_TOOLBOX_BOX)) {
101 aSwitchNode = hasParentRecursive(aCaseNode, WDG_TOOLBOX, NULL);
103 if (!xmlStrcmp(aName, (const xmlChar *) WDG_OPTIONALBOX)) {
104 /// the box is optional, attribute is in case
105 /// if the optional attribute value is not empty
106 aSwitchNode = aCaseNode;
109 aSwitchNodeID = getProperty(aSwitchNode, _ID);
111 aCases.push_back(std::make_pair(aSwitchNodeID, aCaseNodeID));
112 aCaseNode = hasParentRecursive(aSwitchNode, WDG_SWITCH_CASE,
113 WDG_TOOLBOX_BOX, WDG_OPTIONALBOX, NULL);
115 aMessage->setCases(aCases);
116 Events_Loop::loop()->send(aMessage);
118 // container pages, like "case" or "box"
119 } else if (isNode(theNode, WDG_OPTIONALBOX, WDG_SWITCH, WDG_SWITCH_CASE,
120 WDG_TOOLBOX, WDG_TOOLBOX_BOX, NULL)) {
121 storeAttribute(theNode, _ID); // save case:caseId (or box:boxId)
124 //Process SOURCE nodes.
125 Config_XMLReader::processNode(theNode);
128 void Config_FeatureReader::cleanup(xmlNodePtr theNode)
130 if (isNode(theNode, WDG_OPTIONALBOX, WDG_SWITCH, WDG_SWITCH_CASE,
131 WDG_TOOLBOX, WDG_TOOLBOX_BOX, NULL)) {
132 // cleanup id of cases when leave case node
133 cleanupAttribute(theNode, _ID);
137 bool Config_FeatureReader::processChildren(xmlNodePtr theNode)
139 bool result = isNode(theNode, NODE_WORKBENCH, NODE_GROUP, NULL);
140 if(!result && myIsProcessWidgets) {
141 result = isNode(theNode, NODE_FEATURE,
142 WDG_GROUP, WDG_OPTIONALBOX,
143 WDG_TOOLBOX, WDG_TOOLBOX_BOX,
144 WDG_SWITCH, WDG_SWITCH_CASE, NULL);
149 void Config_FeatureReader::fillFeature(xmlNodePtr theFeatureNode,
150 const std::shared_ptr<Config_FeatureMessage>& outFeatureMessage)
152 std::string anId = getProperty(theFeatureNode, _ID);
153 outFeatureMessage->setId(anId);
154 outFeatureMessage->setPluginLibrary(myLibraryName);
155 outFeatureMessage->setNestedFeatures(getProperty(theFeatureNode, FEATURE_NESTED));
156 outFeatureMessage->setActionsWhenNested(getNormalizedProperty(theFeatureNode,
157 FEATURE_WHEN_NESTED));
158 outFeatureMessage->setModal(getBooleanAttribute(theFeatureNode, FEATURE_MODAL, false));
159 bool isAutoPreview = getBooleanAttribute(theFeatureNode, FEATURE_AUTO_PREVIEW, true);
160 outFeatureMessage->setAutoPreview(isAutoPreview);
162 bool isInternal = getBooleanAttribute(theFeatureNode, ATTR_INTERNAL, false);
163 outFeatureMessage->setInternal(isInternal);
165 //Internal feature has no visual representation.
169 std::string aText = Config_Translator::translate(anId, getProperty(theFeatureNode, FEATURE_TEXT));
170 outFeatureMessage->setText(aText);
171 std::string aToolTip = Config_Translator::translate(anId,
172 getProperty(theFeatureNode, FEATURE_TOOLTIP));
173 outFeatureMessage->setTooltip(aToolTip);
174 outFeatureMessage->setIcon(getProperty(theFeatureNode, FEATURE_ICON));
175 outFeatureMessage->setKeysequence(getProperty(theFeatureNode, FEATURE_KEYSEQUENCE));
176 outFeatureMessage->setGroupId(restoreAttribute(NODE_GROUP, _ID));
177 outFeatureMessage->setWorkbenchId(restoreAttribute(NODE_WORKBENCH, _ID));
178 // Get document kind of a feature, if empty set workbench's kind (might be empty too)
179 std::string aDocKind = getProperty(theFeatureNode, FEATURE_DOC);
180 if(aDocKind.empty()) {
181 aDocKind = restoreAttribute(NODE_WORKBENCH, WORKBENCH_DOC);
183 outFeatureMessage->setDocumentKind(aDocKind);