Salome HOME
Update copyrights
[modules/smesh.git] / src / SMESHGUI / SMESHGUI_XmlHandler.cxx
1 // Copyright (C) 2007-2019  CEA/DEN, EDF R&D, OPEN CASCADE
2 //
3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
5 //
6 // This library is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 2.1 of the License, or (at your option) any later version.
10 //
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14 // Lesser General Public License for more details.
15 //
16 // You should have received a copy of the GNU Lesser General Public
17 // License along with this library; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
19 //
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 //
22
23 // SMESH SMESHGUI : reading of xml file with list of available hypotheses and algorithms
24 // File   : SMESHGUI_XmlHandler.cxx
25 // Author : Julia DOROVSKIKH, Open CASCADE S.A.S.
26 // SMESH includes
27 //
28 #include "SMESHGUI_XmlHandler.h"
29
30 #include "SMESHGUI.h"
31 #include "SMESHGUI_Hypotheses.h"
32
33 // SALOME GUI includes
34 #include "SUIT_ResourceMgr.h"
35
36 // SALOME KERNEL includes
37 #include <utilities.h>
38
39 #define BAD_HYP_FLAG "NOT_FOUND"
40
41 /*!
42   Constructor
43 */
44 SMESHGUI_XmlHandler::SMESHGUI_XmlHandler()
45 {
46 }
47
48 /*!
49   Destructor
50 */
51 SMESHGUI_XmlHandler::~SMESHGUI_XmlHandler()
52 {
53 }
54
55 /*!
56   Starts parsing of document. Does some initialization
57
58   Reimplemented from QXmlDefaultHandler.
59 */
60 bool SMESHGUI_XmlHandler::startDocument()
61 {
62   myErrorProt = "";
63   return true;
64 }
65
66 /*!
67   Does different actions depending on the name of the tag and the
68   state you are in document.
69
70   Reimplemented from QXmlDefaultHandler.
71 */
72 bool SMESHGUI_XmlHandler::startElement (const QString&, const QString&,
73                                         const QString& qName,
74                                         const QXmlAttributes& atts)
75 {
76   if (qName == "meshers")
77   {
78     myHypothesesMap.clear();
79     myAlgorithmsMap.clear();
80   }
81   else if (qName == "meshers-group") // group of hypotheses and algorithms
82   {
83     //    if (atts.value("server-lib") != "")
84     {
85       myPluginName = atts.value("name");
86       myServerLib  = atts.value("server-lib");
87       myClientLib  = atts.value("gui-lib");
88       /* It's Need to translate lib name for WIN32 or X platform
89        * (only client lib, because server lib translates in SMESH_Gen_i::createHypothesis
90        *  for normal work of *.py files )
91        */
92       if( !myClientLib.isEmpty() )
93       {
94 #if defined(WIN32)
95         //myServerLib += ".dll";
96         myClientLib += ".dll";
97 #elif defined(__APPLE__)
98         myClientLib = "lib" + myClientLib + ".dylib";
99 #else
100         myClientLib = "lib" + myClientLib + ".so";
101 #endif
102       }
103
104
105       QString aResName = atts.value("resources");
106       if (aResName != "")
107       {
108         //MESSAGE("Loading Resources " << aResName.toLatin1().data());
109         SUIT_ResourceMgr* resMgr = SMESHGUI::resourceMgr();
110         QString lang = resMgr->stringValue( resMgr->langSection(), "language", "en" );
111         resMgr->loadTranslator( "resources", QString( "%1_msg_%2.qm" ).arg( aResName, lang ) );
112         resMgr->loadTranslator( "resources", QString( "%1_images.qm" ).arg( aResName, lang ) );
113       }
114     }
115   }
116   else if (qName == "hypotheses") // group of hypotheses
117   {
118   }
119   else if (qName == "algorithms") // group of algorithms
120   {
121   }
122   else if (qName == "hypothesis" || qName == "algorithm") // hypothesis or algorithm
123   {
124     if (atts.value("type") != "")
125     {
126       QString aHypAlType = atts.value("type");
127       QString     aLabel = atts.value("label-id");
128       QString     anIcon = atts.value("icon-id");
129       bool isAuxOrNeedHyp = ( qName == "hypothesis" ?
130                               atts.value("auxiliary") == "true" :
131                               atts.value("need-hyp" ) == "true" );
132       int  isNeedGeom = 1;
133       bool isSupportSubmeshes = false;
134       QString aNeedGeom = atts.value("need-geom");
135       if ( !aNeedGeom.isEmpty() )
136         isNeedGeom = (aNeedGeom == "true") ? 1 : (aNeedGeom == "never") ? -1 : 0;
137       QString suppSub = atts.value("support-submeshes");
138       if ( !suppSub.isEmpty() )
139         isSupportSubmeshes = (suppSub == "true");
140       QString context = atts.value("context");
141       if ( context.isEmpty() )
142         context = "ANY";
143       else
144         context = context.toUpper();
145
146       bool isOk;
147       QString groupIDStr = atts.value("group-id");
148       int groupID = groupIDStr.toUInt( &isOk );
149       if ( !isOk ) groupID = -1;
150       QString priorityStr = atts.value("priority");
151       int priority = priorityStr.toUInt( &isOk );
152       if ( !isOk ) priority = -1;
153
154       QString aDimStr = atts.value("dim");
155       aDimStr = aDimStr.remove( ' ' );
156       QStringList aDimList = aDimStr.split( ',', QString::SkipEmptyParts );
157       QStringList::iterator anIter;
158       QList<int> aDim;
159       for ( anIter = aDimList.begin(); anIter != aDimList.end(); ++anIter )
160       {
161         int aVal = (*anIter).toInt( &isOk );
162         if ( isOk )
163           aDim.append( aVal );
164       }
165
166       // for algo
167       enum { HYPOS = 0, OPT_HYPOS, INPUT, OUTPUT, NB_ATTRIBUTES };
168       const char* name [NB_ATTRIBUTES] = { "hypos", "opt-hypos", "input", "output" };
169       QStringList attr [NB_ATTRIBUTES];
170       for ( int i = 0; i < NB_ATTRIBUTES; ++i ) {
171         QString aStr = atts.value( name[i] );
172         if ( !aStr.isEmpty() ) {
173           attr[i] = aStr.split( ',', QString::SkipEmptyParts );
174           for ( int j = 0; j < attr[i].count(); ++j )
175             attr[i][j] = attr[i][j].trimmed();
176         }
177       }
178
179       if ( !aHypAlType.contains( BAD_HYP_FLAG ) ) {
180         HypothesisData* aHypData =
181           new HypothesisData (aHypAlType, myPluginName, myServerLib, myClientLib,
182                               aLabel, anIcon, context, groupID, priority, aDim, isAuxOrNeedHyp,
183                               attr[ HYPOS ], attr[ OPT_HYPOS ], attr[ INPUT ], attr[ OUTPUT ],
184                               isNeedGeom, isSupportSubmeshes );
185
186         if (qName == "algorithm")
187         {
188           myAlgorithmsMap.insert(aHypAlType,aHypData);
189         }
190         else
191         {
192           myHypothesesMap.insert(aHypAlType,aHypData);
193         }
194       }
195     }
196   }
197   else if (qName == "hypotheses-set-group") // group of sets of hypotheses
198   {
199   }
200   else if (qName == "hypotheses-set") // a set of hypotheses
201   {
202     if (atts.value("name") != "")
203     {
204       QString hypos = atts.value("hypos").remove( ' ' );
205       QString algos = atts.value("algos").remove( ' ' );
206       bool badSet = hypos.contains( BAD_HYP_FLAG ) || algos.contains( BAD_HYP_FLAG );
207
208       if ( !badSet )
209         myListOfHypothesesSets.append( new HypothesesSet ( atts.value("name"),
210                                                            hypos.split( ',', QString::SkipEmptyParts ),
211                                                            algos.split( ',', QString::SkipEmptyParts ) ) );
212     }
213   }
214   else if ( qName == "python-wrap" ||
215             qName == "algo"        ||
216             qName == "hypo"        ||
217             qName == "accumulative-methods")
218   {
219     // elements used in SMESH_2smeshpy
220     return true;
221   }
222   else
223   {
224     // error
225     return false;
226   }
227   return true;
228 }
229
230
231 /*!
232   Reimplemented from QXmlDefaultHandler.
233 */
234 bool SMESHGUI_XmlHandler::endElement (const QString&, const QString&, const QString&)
235 {
236   return true;
237 }
238
239
240 /*!
241   Reimplemented from QXmlDefaultHandler.
242 */
243 bool SMESHGUI_XmlHandler::characters (const QString& ch)
244 {
245   // we are not interested in whitespaces
246   QString ch_simplified = ch.simplified();
247   if ( ch_simplified.isEmpty() )
248     return true;
249   return true;
250 }
251
252
253 /*!
254   Returns the default error string.
255
256   Reimplemented from QXmlDefaultHandler.
257 */
258 QString SMESHGUI_XmlHandler::errorString()
259 {
260   return "the document is not in the quote file format";
261 }
262
263 /*!
264   Returns the error protocol if parsing failed
265
266   Reimplemented from QXmlDefaultHandler.
267 */
268 QString SMESHGUI_XmlHandler::errorProtocol()
269 {
270   return myErrorProt;
271 }
272
273 /*!
274   Returns exception
275
276   Reimplemented from QXmlDefaultHandler.
277 */
278 bool SMESHGUI_XmlHandler::fatalError (const QXmlParseException& exception)
279 {
280   myErrorProt += QString("fatal parsing error: %1 in line %2, column %3\n")
281     .arg(exception.message())
282     .arg(exception.lineNumber())
283     .arg(exception.columnNumber());
284   
285   return QXmlDefaultHandler::fatalError( exception );
286 }