1 // Copyright (C) 2014-2020 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 email : webmaster.salome@opencascade.com
20 #include "ModelHighAPI_Tools.h"
21 #include <ModelHighAPI_FeatureStore.h>
22 //--------------------------------------------------------------------------------------
23 #include <GeomAPI_Dir.h>
24 #include <GeomAPI_Pnt.h>
25 #include <GeomAPI_Pnt2d.h>
26 //--------------------------------------------------------------------------------------
27 #include <GeomDataAPI_Dir.h>
28 #include <GeomDataAPI_Point.h>
29 #include <GeomDataAPI_Point2D.h>
30 #include <GeomDataAPI_Point2DArray.h>
31 //--------------------------------------------------------------------------------------
32 #include <Locale_Convert.h>
33 //--------------------------------------------------------------------------------------
34 #include <ModelAPI_AttributeBoolean.h>
35 #include <ModelAPI_AttributeDocRef.h>
36 #include <ModelAPI_AttributeDouble.h>
37 #include <ModelAPI_AttributeDoubleArray.h>
38 #include <ModelAPI_AttributeIntArray.h>
39 #include <ModelAPI_AttributeInteger.h>
40 #include <ModelAPI_AttributeRefAttr.h>
41 #include <ModelAPI_AttributeRefAttrList.h>
42 #include <ModelAPI_AttributeReference.h>
43 #include <ModelAPI_AttributeRefList.h>
44 #include <ModelAPI_AttributeSelection.h>
45 #include <ModelAPI_AttributeSelectionList.h>
46 #include <ModelAPI_AttributeString.h>
47 #include <ModelAPI_AttributeStringArray.h>
48 #include <ModelAPI_AttributeDoubleArray.h>
49 #include <ModelAPI_Session.h>
50 #include <ModelAPI_Tools.h>
51 #include <ModelAPI_ResultPart.h>
52 #include <ModelAPI_Events.h>
53 //--------------------------------------------------------------------------------------
54 #include <Config_ModuleReader.h>
55 //--------------------------------------------------------------------------------------
56 #include "ModelHighAPI_Double.h"
57 #include "ModelHighAPI_Integer.h"
58 #include "ModelHighAPI_RefAttr.h"
59 #include "ModelHighAPI_Reference.h"
60 #include "ModelHighAPI_Selection.h"
62 #include <Events_InfoMessage.h>
64 // Have to be included before std headers
70 //--------------------------------------------------------------------------------------
71 void fillAttribute(const std::shared_ptr<GeomAPI_Pnt2d> & theValue,
72 const std::shared_ptr<GeomDataAPI_Point2D> & theAttribute)
74 theAttribute->setValue(theValue);
77 void fillAttribute(const std::shared_ptr<GeomDataAPI_Point2D> & theAttribute,
78 double theX, double theY)
80 theAttribute->setValue(theX, theY);
83 //--------------------------------------------------------------------------------------
84 void fillAttribute(const std::shared_ptr<GeomAPI_Dir> & theValue,
85 const std::shared_ptr<GeomDataAPI_Dir> & theAttribute)
87 theAttribute->setValue(theValue);
90 //--------------------------------------------------------------------------------------
91 void fillAttribute(const std::shared_ptr<GeomAPI_Pnt> & theValue,
92 const std::shared_ptr<GeomDataAPI_Point> & theAttribute)
94 theAttribute->setValue(theValue);
97 //--------------------------------------------------------------------------------------
98 void fillAttribute(bool theValue,
99 const std::shared_ptr<ModelAPI_AttributeBoolean> & theAttribute)
101 theAttribute->setValue(theValue);
104 //--------------------------------------------------------------------------------------
105 void fillAttribute(const ModelHighAPI_Double & theValue,
106 const std::shared_ptr<ModelAPI_AttributeDouble> & theAttribute)
108 theValue.fillAttribute(theAttribute);
110 void fillAttribute(double theValue,
111 const std::shared_ptr<ModelAPI_AttributeDouble> & theAttribute)
113 theAttribute->setValue(theValue);
116 //--------------------------------------------------------------------------------------
117 void fillAttribute(const ModelHighAPI_Integer & theValue,
118 const std::shared_ptr<ModelAPI_AttributeInteger> & theAttribute)
120 theValue.fillAttribute(theAttribute);
122 void fillAttribute(int theValue,
123 const std::shared_ptr<ModelAPI_AttributeInteger> & theAttribute)
125 theAttribute->setValue(theValue);
128 //--------------------------------------------------------------------------------------
129 void fillAttribute(const ModelHighAPI_RefAttr & theValue,
130 const std::shared_ptr<ModelAPI_AttributeRefAttr> & theAttribute)
132 theValue.fillAttribute(theAttribute);
135 //--------------------------------------------------------------------------------------
136 void fillAttribute(const std::list<ModelHighAPI_RefAttr> & theValue,
137 const std::shared_ptr<ModelAPI_AttributeRefAttrList> & theAttribute)
139 theAttribute->clear();
140 for (auto it = theValue.begin(); it != theValue.end(); ++it)
141 it->appendToList(theAttribute);
144 //--------------------------------------------------------------------------------------
145 void fillAttribute(const ModelHighAPI_Reference & theValue,
146 const std::shared_ptr<ModelAPI_AttributeReference> & theAttribute)
148 theValue.fillAttribute(theAttribute);
151 //--------------------------------------------------------------------------------------
152 void fillAttribute(const std::list<ModelHighAPI_Reference> & theValue,
153 const std::shared_ptr<ModelAPI_AttributeRefList> & theAttribute)
155 theAttribute->clear();
156 for (auto it = theValue.begin(); it != theValue.end(); ++it)
157 it->appendToList(theAttribute);
160 //--------------------------------------------------------------------------------------
161 void fillAttribute(const std::shared_ptr<ModelAPI_Object> & theValue,
162 const std::shared_ptr<ModelAPI_AttributeReference> & theAttribute)
164 theAttribute->setValue(theValue);
167 //--------------------------------------------------------------------------------------
168 void fillAttribute(const std::list<std::shared_ptr<ModelAPI_Object> > & theValue,
169 const std::shared_ptr<ModelAPI_AttributeRefList> & theAttribute)
171 theAttribute->clear();
172 for (auto it = theValue.begin(); it != theValue.end(); ++it)
173 theAttribute->append(*it);
177 void fillAttribute(const std::list<ModelHighAPI_Selection> & theValue,
178 const std::shared_ptr<ModelAPI_AttributeRefList> & theAttribute)
180 theAttribute->clear();
181 for (auto it = theValue.begin(); it != theValue.end(); ++it) {
182 if (it->resultSubShapePair().first)
183 theAttribute->append(it->resultSubShapePair().first); // use only context
187 //--------------------------------------------------------------------------------------
188 void fillAttribute(const ModelHighAPI_Selection & theValue,
189 const std::shared_ptr<ModelAPI_AttributeSelection> & theAttribute)
191 theValue.fillAttribute(theAttribute);
194 //--------------------------------------------------------------------------------------
195 void fillAttribute(const std::list<ModelHighAPI_Selection> & theValue,
196 const std::shared_ptr<ModelAPI_AttributeSelectionList> & theAttribute)
198 theAttribute->clear();
200 if(!theValue.empty() && theAttribute->selectionType().empty()) {
201 const ModelHighAPI_Selection& aSelection = theValue.front();
202 GeomAPI_Shape::ShapeType aSelectionType = getShapeType(aSelection);
203 theAttribute->setSelectionType(strByShapeType(aSelectionType));
206 for (auto it = theValue.begin(); it != theValue.end(); ++it)
207 it->appendToList(theAttribute);
210 //--------------------------------------------------------------------------------------
211 void fillAttribute(const std::string & theValue,
212 const std::shared_ptr<ModelAPI_AttributeString> & theAttribute)
214 theAttribute->setValue(theValue);
217 //--------------------------------------------------------------------------------------
218 void fillAttribute(const char * theValue,
219 const std::shared_ptr<ModelAPI_AttributeString> & theAttribute)
221 theAttribute->setValue(theValue);
224 //--------------------------------------------------------------------------------------
225 void fillAttribute(const std::list<std::string> & theValue,
226 const std::shared_ptr<ModelAPI_AttributeStringArray> & theAttribute)
228 theAttribute->setSize(int(theValue.size()));
231 for (auto it = theValue.begin(); it != theValue.end(); ++it, ++anIndex)
232 theAttribute->setValue(anIndex, *it);
235 //--------------------------------------------------------------------------------------
236 void fillAttribute(const std::list<ModelHighAPI_Integer> & theValue,
237 const std::shared_ptr<ModelAPI_AttributeIntArray> & theAttribute)
239 theAttribute->setSize(int(theValue.size()));
242 for (auto it = theValue.begin(); it != theValue.end(); ++it, ++anIndex)
243 theAttribute->setValue(anIndex, it->intValue()); // use only values, no text support in array
246 //--------------------------------------------------------------------------------------
247 void fillAttribute(const std::list<ModelHighAPI_Double> & theValue,
248 const std::shared_ptr<ModelAPI_AttributeDoubleArray> & theAttribute)
250 theAttribute->setSize(int(theValue.size()));
253 for (auto it = theValue.begin(); it != theValue.end(); ++it, ++anIndex)
254 theAttribute->setValue(anIndex, it->value()); // use only values, no text support in array
257 //--------------------------------------------------------------------------------------
258 void fillAttribute(const std::list<std::shared_ptr<GeomAPI_Pnt2d> > & theValue,
259 const std::shared_ptr<GeomDataAPI_Point2DArray> & theAttribute)
261 theAttribute->setSize(int(theValue.size()));
264 for (auto it = theValue.begin(); it != theValue.end(); ++it, ++anIndex)
265 theAttribute->setPnt(anIndex, *it);
268 //--------------------------------------------------------------------------------------
269 void fillAttribute(const ModelHighAPI_Double & theX,
270 const ModelHighAPI_Double & theY,
271 const ModelHighAPI_Double & theZ,
272 const std::shared_ptr<GeomDataAPI_Point> & theAttribute)
274 theX.fillAttribute(theAttribute, theX, theY, theZ);
277 //==================================================================================================
278 GeomAPI_Shape::ShapeType shapeTypeByStr(std::string theShapeTypeStr)
280 GeomAPI_Shape::ShapeType aShapeType = GeomAPI_Shape::SHAPE;
282 std::transform(theShapeTypeStr.begin(), theShapeTypeStr.end(), theShapeTypeStr.begin(),
283 [](char c) { return static_cast<char>(::tolower(c)); });
285 if(theShapeTypeStr == "compound") {
286 aShapeType = GeomAPI_Shape::COMPOUND;
287 } else if(theShapeTypeStr == "compsolid") {
288 aShapeType = GeomAPI_Shape::COMPSOLID;
289 } else if(theShapeTypeStr == "solid") {
290 aShapeType = GeomAPI_Shape::SOLID;
291 } else if(theShapeTypeStr == "shell") {
292 aShapeType = GeomAPI_Shape::SHELL;
293 } else if(theShapeTypeStr == "face") {
294 aShapeType = GeomAPI_Shape::FACE;
295 } else if(theShapeTypeStr == "wire") {
296 aShapeType = GeomAPI_Shape::WIRE;
297 } else if(theShapeTypeStr == "edge") {
298 aShapeType = GeomAPI_Shape::EDGE;
299 } else if(theShapeTypeStr == "vertex") {
300 aShapeType = GeomAPI_Shape::VERTEX;
301 } else if(theShapeTypeStr == "shape") {
302 aShapeType = GeomAPI_Shape::SHAPE;
308 std::string strByShapeType(GeomAPI_Shape::ShapeType theShapeType)
310 std::string aShapeTypeStr;
311 switch (theShapeType) {
312 case GeomAPI_Shape::COMPOUND:
313 aShapeTypeStr = "COMPOUND";
315 case GeomAPI_Shape::COMPSOLID:
316 aShapeTypeStr = "COMPSOLID";
318 case GeomAPI_Shape::SOLID:
319 aShapeTypeStr = "SOLID";
321 case GeomAPI_Shape::SHELL:
322 aShapeTypeStr = "SHELL";
324 case GeomAPI_Shape::FACE:
325 aShapeTypeStr = "FACE";
327 case GeomAPI_Shape::WIRE:
328 aShapeTypeStr = "WIRE";
330 case GeomAPI_Shape::EDGE:
331 aShapeTypeStr = "EDGE";
333 case GeomAPI_Shape::VERTEX:
334 aShapeTypeStr = "VERTEX";
337 aShapeTypeStr = "SHAPE";
340 return aShapeTypeStr;
343 //==================================================================================================
344 GeomAPI_Shape::ShapeType getShapeType(const ModelHighAPI_Selection& theSelection)
346 GeomAPI_Shape::ShapeType aShapeType = GeomAPI_Shape::SHAPE;
348 switch(theSelection.variantType()) {
349 case ModelHighAPI_Selection::VT_ResultSubShapePair: {
350 ResultSubShapePair aPair = theSelection.resultSubShapePair();
351 GeomShapePtr aShape = aPair.second;
353 aShape = aPair.first->shape();
358 aShapeType = aShape->shapeType();
361 case ModelHighAPI_Selection::VT_TypeSubShapeNamePair: {
362 TypeSubShapeNamePair aPair = theSelection.typeSubShapeNamePair();
363 std::string aType = aPair.first;
364 aShapeType = shapeTypeByStr(aType);
367 case ModelHighAPI_Selection::VT_TypeInnerPointPair: {
368 TypeInnerPointPair aPair = theSelection.typeInnerPointPair();
369 std::string aType = aPair.first;
370 aType = aType.substr(0, aType.find_first_of('_'));
371 aShapeType = shapeTypeByStr(aType);
374 case ModelHighAPI_Selection::VT_WeakNamingPair: {
375 TypeWeakNamingPair aPair = theSelection.typeWeakNamingPair();
376 std::string aType = aPair.first;
377 aShapeType = shapeTypeByStr(aType);
381 break; // do nothing [to avoid compilation warning]
387 //--------------------------------------------------------------------------------------
388 ModelAPI_AttributeTables::ValueType valueTypeByStr(const std::string& theValueTypeStr)
390 std::string aType = theValueTypeStr;
391 std::transform(aType.begin(), aType.end(), aType.begin(),
392 [](char c) { return static_cast<char>(::tolower(c)); });
393 if (aType == "boolean")
394 return ModelAPI_AttributeTables::BOOLEAN;
395 else if (aType == "integer")
396 return ModelAPI_AttributeTables::INTEGER;
397 else if (aType == "string")
398 return ModelAPI_AttributeTables::STRING;
399 return ModelAPI_AttributeTables::DOUBLE; // default
402 //--------------------------------------------------------------------------------------
403 std::string strByValueType(const ModelAPI_AttributeTables::ValueType theType)
406 case ModelAPI_AttributeTables::BOOLEAN: return "BOOLEAN";
407 case ModelAPI_AttributeTables::INTEGER: return "INTEGER";
408 case ModelAPI_AttributeTables::DOUBLE: return "DOUBLE";
409 case ModelAPI_AttributeTables::STRING: return "STRING";
411 return ""; // bad case
414 /// stores the features information, recursively stores sub-documents features
415 std::string storeFeatures(const std::wstring& theDocName, DocumentPtr theDoc,
416 std::map<std::wstring, std::map<std::wstring, ModelHighAPI_FeatureStore> >& theStore,
417 const bool theCompare) // if false => store
419 std::map<std::wstring, std::map<std::wstring, ModelHighAPI_FeatureStore> >::iterator aDocFind;
421 aDocFind = theStore.find(theDocName);
422 if (aDocFind == theStore.end()) {
423 return "Document '" + Locale::Convert::toString(theDocName) + "' not found";
426 // store the model features information: iterate all features
427 size_t anObjectsCount = 0; // stores the number of compared features for this document to compare
428 std::set<std::wstring> aProcessed; // processed features names (that are in the current document)
430 // process all objects (features and folders)
431 std::list<ObjectPtr> allObjects = theDoc->allObjects();
432 std::list<ObjectPtr>::iterator allIter = allObjects.begin();
433 for(; allIter != allObjects.end(); allIter++) {
434 ObjectPtr anObject = *allIter;
435 FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(anObject);
436 //if (aFeature && aFeature->getKind() == "SketchConstraintCoincidenceInternal")
439 std::string aStr = aFeature->getKind().substr(0, 16);
440 if (aStr == "SketchConstraint")
441 continue; // no need to dump and check constraints
444 std::map<std::wstring, ModelHighAPI_FeatureStore>::iterator
445 anObjFind = aDocFind->second.find(anObject->data()->name());
446 if (anObjFind == aDocFind->second.end()) {
447 return "Document '" + Locale::Convert::toString(theDocName)
448 + "' feature '" + Locale::Convert::toString(anObject->data()->name()) + "' not found";
450 std::string anError = anObjFind->second.compare(anObject);
451 if (!anError.empty()) {
452 anError = "Document " + Locale::Convert::toString(theDocName) + " " + anError;
456 aProcessed.insert(anObject->data()->name());
458 theStore[theDocName][anObject->data()->name()] = ModelHighAPI_FeatureStore(anObject);
462 // iterate all results of this feature
463 std::list<ResultPtr> allResults;
464 ModelAPI_Tools::allResults(aFeature, allResults);
465 std::list<ResultPtr>::iterator aRes = allResults.begin();
466 for(; aRes != allResults.end(); aRes++) {
467 // recursively store features of sub-documents
468 if ((*aRes)->groupName() == ModelAPI_ResultPart::group()) {
469 DocumentPtr aDoc = std::dynamic_pointer_cast<ModelAPI_ResultPart>(*aRes)->partDoc();
471 std::string anError =
472 storeFeatures((*aRes)->data()->name(), aDoc, theStore, theCompare);
473 if (!anError.empty())
480 // checks the number of compared features
482 if (aDocFind->second.size() != anObjectsCount) {
483 // search for disappeared feature
484 std::wstring aLostName;
485 std::map<std::wstring, ModelHighAPI_FeatureStore>::iterator aLostIter;
486 for(aLostIter = aDocFind->second.begin(); aLostIter != aDocFind->second.end(); aLostIter++) {
487 if (aProcessed.find(aLostIter->first) == aProcessed.end()) {
488 aLostName = aLostIter->first;
491 return "For document '" + Locale::Convert::toString(theDocName) +
492 "' the number of features is decreased, there is no feature '" +
493 Locale::Convert::toString(aLostName) + "'";
499 //==================================================================================================
500 typedef std::map<std::wstring, std::map<std::wstring, ModelHighAPI_FeatureStore> > Storage;
502 static bool dumpToPython(SessionPtr theSession,
503 const std::string& theFilename,
504 const checkDumpType theSelectionType,
505 const std::string& theErrorMsgContext)
507 // 2431: set PartSet as a current document
508 theSession->setActiveDocument(theSession->moduleDocument(), true);
509 // dump all to the python file
510 theSession->startOperation("Check python dump");
511 FeaturePtr aDump = theSession->moduleDocument()->addFeature("Dump");
513 aDump->string("file_path")->setValue(theFilename);
514 aDump->string("file_format")->setValue("py");
515 aDump->boolean("topological_naming")->setValue((theSelectionType & CHECK_NAMING) != 0);
516 aDump->boolean("geometric_selection")->setValue((theSelectionType & CHECK_GEOMETRICAL) != 0);
517 aDump->boolean("weak_naming")->setValue((theSelectionType & CHECK_WEAK) != 0);
519 bool isProblem = !aDump.get() || !aDump->error().empty(); // after "finish" dump will be removed
520 if (isProblem && aDump.get()) {
521 std::cout << "Dump feature error " << aDump->error() << std::endl;
522 Events_InfoMessage anErrorMsg(theErrorMsgContext, aDump->error());
525 theSession->finishOperation();
529 static bool checkDump(SessionPtr theSession,
530 const char* theFilename,
532 const std::string& theErrorMsgContext)
535 // close all before importation of the script
536 theSession->closeAll();
538 // execute the dumped
539 PyGILState_STATE gstate = PyGILState_Ensure(); /* acquire python thread */
540 static char aReadMode[] = "r";
541 FILE* PyFileObject = _Py_fopen(theFilename, aReadMode);
542 PyRun_SimpleFileEx(PyFileObject, theFilename, 1);
543 PyGILState_Release(gstate); /* release python thread */
545 // compare with the stored data
546 std::string anError =
547 storeFeatures(Locale::Convert::toWString(theSession->moduleDocument()->kind()),
548 theSession->moduleDocument(), theStorage, true);
549 if (!anError.empty()) {
550 std::cout << anError << std::endl;
551 Events_InfoMessage anErrorMsg(theErrorMsgContext, anError);
561 const std::string&, const std::string&, const std::string&,
563 const std::string& theFilenameNaming,
564 const std::string& theFilenameGeo,
565 const std::string& theFilenameWeak,
567 const checkDumpType theCheckType)
569 static const std::string anErrorByNaming("checkPythonDump by naming");
570 static const std::string anErrorByGeometry("checkPythonDump by geometry");
571 static const std::string anErrorByWeak("checkPythonDump by weak naming");
574 std::string aFileForNamingDump("./check_dump.py");
575 std::string aFileForGeometryDump("./check_dump_geo.py");
576 std::string aFileForWeakDump("./check_dump_weak.py");
578 std::string aFileForNamingDump = theFilenameNaming;
579 std::string aFileForGeometryDump = theFilenameGeo;
580 std::string aFileForWeakDump = theFilenameWeak;
583 SessionPtr aSession = ModelAPI_Session::get();
584 // dump with the specified types
585 std::string aFileName = theCheckType == CHECK_GEOMETRICAL ? aFileForGeometryDump :
586 (theCheckType == CHECK_WEAK ? aFileForWeakDump : aFileForNamingDump);
587 if (!dumpToPython(aSession, aFileName, theCheckType, anErrorByNaming))
590 // map from document name to feature name to feature data
591 std::map<std::wstring, std::map<std::wstring, ModelHighAPI_FeatureStore> > aStore;
592 std::string anError =
593 storeFeatures(Locale::Convert::toWString(aSession->moduleDocument()->kind()),
594 aSession->moduleDocument(), aStore, false);
595 if (!anError.empty()) {
596 Events_InfoMessage anErrorMsg(std::string("checkPythonDump"), anError);
602 if (theCheckType & CHECK_NAMING) {
603 // check dump with the selection by names
604 isOk = checkDump(aSession, aFileForNamingDump.c_str(), aStore, anErrorByNaming);
606 if (theCheckType & CHECK_GEOMETRICAL) {
607 // check dump with the selection by geometry
608 isOk = isOk && checkDump(aSession, aFileForGeometryDump.c_str(), aStore, anErrorByGeometry);
610 if (theCheckType & CHECK_WEAK) {
611 isOk = isOk && checkDump(aSession, aFileForWeakDump.c_str(), aStore, anErrorByWeak);
617 //--------------------------------------------------------------------------------------