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, GROUP_TOOLBAR);
77 storeAttribute(theNode, WORKBENCH_DOC, true);
78 } else if (myIsProcessWidgets) {
79 // widgets, like shape_selector or containers, like toolbox
80 if (isAttributeNode(theNode)) {
81 std::shared_ptr<Config_AttributeMessage>
82 aMessage(new Config_AttributeMessage(aMenuItemEvent, this));
83 aMessage->setFeatureId(restoreAttribute(NODE_FEATURE, _ID));
84 std::string anAttributeID = getProperty(theNode, _ID);
85 if (!anAttributeID.empty()) {
86 aMessage->setAttributeId(anAttributeID);
87 aMessage->setObligatory(getBooleanAttribute(theNode, ATTR_OBLIGATORY, true));
88 bool isConcealment = getBooleanAttribute(theNode, ATTR_CONCEALMENT, false);
89 aMessage->setConcealment(isConcealment);
90 bool isMainArg = isConcealment && getBooleanAttribute(theNode, ATTR_MAIN_ARG, false);
91 aMessage->setMainArgument(isMainArg);
93 std::list<std::pair<std::string, std::string> > aCases;
94 xmlNodePtr aCaseNode = hasParentRecursive(theNode,
95 WDG_SWITCH_CASE, WDG_TOOLBOX_BOX, WDG_OPTIONALBOX, WDG_RADIOBOX_ITEM, NULL);
97 std::string aCaseNodeID = getProperty(aCaseNode, _ID);
98 std::string aSwitchNodeID = "";
99 const xmlChar* aName = aCaseNode->name;
100 xmlNodePtr aSwitchNode;
101 if (!xmlStrcmp(aName, (const xmlChar *) WDG_SWITCH_CASE)) {
102 aSwitchNode = hasParentRecursive(aCaseNode, WDG_SWITCH, NULL);
104 else if (!xmlStrcmp(aName, (const xmlChar *) WDG_TOOLBOX_BOX)) {
105 aSwitchNode = hasParentRecursive(aCaseNode, WDG_TOOLBOX, NULL);
107 else if (!xmlStrcmp(aName, (const xmlChar *)WDG_RADIOBOX_ITEM)) {
108 aSwitchNode = hasParentRecursive(aCaseNode, WDG_RADIOBOX, NULL);
110 if (!xmlStrcmp(aName, (const xmlChar *) WDG_OPTIONALBOX)) {
111 /// the box is optional, attribute is in case
112 /// if the optional attribute value is not empty
113 aSwitchNode = aCaseNode;
116 aSwitchNodeID = getProperty(aSwitchNode, _ID);
118 aCases.push_back(std::make_pair(aSwitchNodeID, aCaseNodeID));
119 aCaseNode = hasParentRecursive(aSwitchNode, WDG_SWITCH_CASE,
120 WDG_TOOLBOX_BOX, WDG_OPTIONALBOX, WDG_RADIOBOX_ITEM, NULL);
122 aMessage->setCases(aCases);
123 Events_Loop::loop()->send(aMessage);
125 // container pages, like "case" or "box"
126 } else if (isNode(theNode, WDG_OPTIONALBOX, WDG_SWITCH, WDG_SWITCH_CASE,
127 WDG_TOOLBOX, WDG_TOOLBOX_BOX,
128 WDG_RADIOBOX, WDG_RADIOBOX_ITEM, NULL)) {
129 storeAttribute(theNode, _ID); // save case:caseId (or box:boxId)
132 //Process SOURCE nodes.
133 Config_XMLReader::processNode(theNode);
136 void Config_FeatureReader::cleanup(xmlNodePtr theNode)
138 if (isNode(theNode, WDG_OPTIONALBOX, WDG_SWITCH, WDG_SWITCH_CASE,
139 WDG_TOOLBOX, WDG_TOOLBOX_BOX, WDG_RADIOBOX_ITEM, WDG_RADIOBOX, NULL)) {
140 // cleanup id of cases when leave case node
141 cleanupAttribute(theNode, _ID);
145 bool Config_FeatureReader::processChildren(xmlNodePtr theNode)
147 bool result = isNode(theNode, NODE_WORKBENCH, NODE_GROUP, NULL);
148 if(!result && myIsProcessWidgets) {
149 result = isNode(theNode, NODE_FEATURE,
150 WDG_GROUP, WDG_OPTIONALBOX,
151 WDG_TOOLBOX, WDG_TOOLBOX_BOX,
152 WDG_RADIOBOX, WDG_RADIOBOX_ITEM,
153 WDG_SWITCH, WDG_SWITCH_CASE, NULL);
158 void Config_FeatureReader::fillFeature(xmlNodePtr theFeatureNode,
159 const std::shared_ptr<Config_FeatureMessage>& outFeatureMessage)
161 std::string anId = getProperty(theFeatureNode, _ID);
162 outFeatureMessage->setId(anId);
163 outFeatureMessage->setPluginLibrary(myLibraryName);
164 outFeatureMessage->setNestedFeatures(getProperty(theFeatureNode, FEATURE_NESTED));
165 outFeatureMessage->setActionsWhenNested(getNormalizedProperty(theFeatureNode,
166 FEATURE_WHEN_NESTED));
167 outFeatureMessage->setModal(getBooleanAttribute(theFeatureNode, FEATURE_MODAL, false));
168 bool isAutoPreview = getBooleanAttribute(theFeatureNode, FEATURE_AUTO_PREVIEW, true);
169 outFeatureMessage->setAutoPreview(isAutoPreview);
170 outFeatureMessage->setApplyContinue(
171 getBooleanAttribute(theFeatureNode, FEATURE_APPLY_CONTINUE, false));
173 bool isInternal = getBooleanAttribute(theFeatureNode, ATTR_INTERNAL, false);
174 outFeatureMessage->setInternal(isInternal);
176 //Internal feature has no visual representation.
180 std::string aText = Config_Translator::translate(anId, getProperty(theFeatureNode, FEATURE_TEXT));
181 outFeatureMessage->setText(aText);
182 std::string aToolTip = Config_Translator::translate(anId,
183 getProperty(theFeatureNode, FEATURE_TOOLTIP));
184 outFeatureMessage->setIcon(getProperty(theFeatureNode, FEATURE_ICON));
185 outFeatureMessage->setKeysequence(getProperty(theFeatureNode, FEATURE_KEYSEQUENCE));
186 std::string aHelpFile = getProperty(theFeatureNode, HELP_FILE);
187 if (!aHelpFile.empty())
188 outFeatureMessage->setHelpFileName(myLibraryName + "/" + aHelpFile);
190 std::string aGroupName = restoreAttribute(NODE_GROUP, _ID);
191 std::string aWBNName = restoreAttribute(NODE_WORKBENCH, _ID);
192 std::string isGroupToolbarId = restoreAttribute(NODE_GROUP, GROUP_TOOLBAR);
193 bool isGroupToolbar = false;
194 if (isGroupToolbarId.length() > 0)
195 isGroupToolbar = (isGroupToolbarId == "yes");
196 outFeatureMessage->setGroupId(aGroupName);
197 outFeatureMessage->setWorkbenchId(aWBNName);
198 outFeatureMessage->setToolBarId(isGroupToolbar ? aGroupName : aWBNName);
200 // Get document kind of a feature, if empty set workbench's kind (might be empty too)
201 std::string aDocKind = getProperty(theFeatureNode, FEATURE_DOC);
202 if(aDocKind.empty()) {
203 aDocKind = restoreAttribute(NODE_WORKBENCH, WORKBENCH_DOC);
205 outFeatureMessage->setDocumentKind(aDocKind);