src/ModelHighAPI/ModelHighAPI_Dumper.cpp

   1 // Copyright (C) 2014-2020  CEA/DEN, EDF R&D
   2 //
   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.
   7 //
   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.
  12 //
  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
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #include "ModelHighAPI_Dumper.h"
  21
  22 #include <Config_PropManager.h>
  23
  24 #include <GeomAPI_Circ.h>
  25 #include <GeomAPI_Edge.h>
  26 #include <GeomAPI_Ellipse.h>
  27 #include <GeomAPI_Dir.h>
  28 #include <GeomAPI_Pnt.h>
  29 #include <GeomAPI_Pnt2d.h>
  30 #include <GeomAPI_ShapeExplorer.h>
  31 #include <GeomAPI_ShapeIterator.h>
  32 #include <GeomAPI_Vertex.h>
  33 #include <GeomAlgoAPI_NExplode.h>
  34
  35 #include <GeomDataAPI_Dir.h>
  36 #include <GeomDataAPI_Point.h>
  37 #include <GeomDataAPI_Point2D.h>
  38 #include <GeomDataAPI_Point2DArray.h>
  39
  40 #include <ModelAPI_AttributeBoolean.h>
  41 #include <ModelAPI_AttributeDouble.h>
  42 #include <ModelAPI_AttributeDoubleArray.h>
  43 #include <ModelAPI_AttributeIntArray.h>
  44 #include <ModelAPI_AttributeInteger.h>
  45 #include <ModelAPI_AttributeRefAttr.h>
  46 #include <ModelAPI_AttributeRefAttrList.h>
  47 #include <ModelAPI_AttributeReference.h>
  48 #include <ModelAPI_AttributeRefList.h>
  49 #include <ModelAPI_AttributeSelection.h>
  50 #include <ModelAPI_AttributeSelectionList.h>
  51 #include <ModelAPI_AttributeString.h>
  52 #include <ModelAPI_AttributeStringArray.h>
  53 #include <ModelAPI_CompositeFeature.h>
  54 #include <ModelAPI_Document.h>
  55 #include <ModelAPI_Entity.h>
  56 #include <ModelAPI_Feature.h>
  57 #include <ModelAPI_FiltersFeature.h>
  58 #include <ModelAPI_Folder.h>
  59 #include <ModelAPI_Result.h>
  60 #include <ModelAPI_ResultBody.h>
  61 #include <ModelAPI_ResultConstruction.h>
  62 #include <ModelAPI_ResultGroup.h>
  63 #include <ModelAPI_ResultPart.h>
  64 #include <ModelAPI_Session.h>
  65 #include <ModelAPI_Tools.h>
  66
  67 #include <ModelGeomAlgo_Shape.h>
  68
  69 #include <PartSetPlugin_Part.h>
  70
  71 #include <OSD_OpenFile.hxx>
  72
  73 #include <fstream>
  74
  75 // ===========    Implementation of storage of dumped data    ===========
  76 static const int THE_DUMP_PRECISION = 16;
  77
  78 class ModelHighAPI_Dumper::DumpStorageBuffer : public ModelHighAPI_Dumper::DumpStorage
  79 {
  80 public:
  81   void addStorage(const ModelHighAPI_Dumper::DumpStoragePtr& theStorage)
  82   { myStorageArray.push_back(theStorage); }
  83
  84   void clear() { myStorageArray.clear(); }
  85
  86   bool isBufferEmpty()
  87   {
  88     return myStorageArray.empty() || myStorageArray.front()->buffer().str().empty();
  89   }
  90
  91   void mergeBuffer()
  92   {
  93     std::list<ModelHighAPI_Dumper::DumpStoragePtr>::iterator anIt = myStorageArray.begin();
  94     for (; anIt != myStorageArray.end(); ++anIt) {
  95       // avoid multiple empty lines
  96       std::string aBuf = (*anIt)->buffer().str();
  97       size_t anInd = std::string::npos;
  98       while ((anInd = aBuf.find("\n\n\n")) != std::string::npos)
  99         aBuf.erase(anInd, 1);
 100
 101       (*anIt)->fullDump() << aBuf;
 102       (*anIt)->buffer().str("");
 103     }
 104   }
 105
 106   void write(const std::string& theValue)
 107   {
 108     if (myStorageArray.empty())
 109       addStorage(DumpStoragePtr(new DumpStorage));
 110
 111     std::list<ModelHighAPI_Dumper::DumpStoragePtr>::iterator anIt = myStorageArray.begin();
 112     for (; anIt != myStorageArray.end(); ++anIt)
 113       (*anIt)->buffer() << theValue;
 114   }
 115
 116   DumpStorageBuffer& operator<<(const char theChar)
 117   {
 118     std::ostringstream out;
 119     out << theChar;
 120     write(out.str());
 121     return *this;
 122   }
 123
 124   DumpStorageBuffer& operator<<(const char* theString)
 125   {
 126     write(theString);
 127     return *this;
 128   }
 129
 130   DumpStorageBuffer& operator<<(const std::string& theString)
 131   {
 132     write(theString);
 133     return *this;
 134   }
 135
 136   DumpStorageBuffer& operator<<(const bool theValue)
 137   {
 138     std::ostringstream out;
 139     out << theValue;
 140     write(out.str());
 141     return *this;
 142   }
 143
 144   DumpStorageBuffer& operator<<(const int theValue)
 145   {
 146     std::ostringstream out;
 147     out << theValue;
 148     write(out.str());
 149     return *this;
 150   }
 151
 152   DumpStorageBuffer& operator<<(const double theValue)
 153   {
 154     std::ostringstream out;
 155     out << std::setprecision(THE_DUMP_PRECISION) << theValue;
 156     write(out.str());
 157     return *this;
 158   }
 159   /// Dump std::endl
 160   friend
 161   DumpStorageBuffer& operator<<(DumpStorageBuffer& theBuffer,
 162                                 std::basic_ostream<char>& (*theEndl)(std::basic_ostream<char>&))
 163   {
 164     theBuffer.write("\n");
 165     return theBuffer;
 166   }
 167
 168   void dumpArray(int theSize, double* theValues, std::string* theTexts)
 169   {
 170     std::ostringstream anOutput;
 171     anOutput << std::setprecision(THE_DUMP_PRECISION);
 172     for (int i = 0; i < theSize; ++i) {
 173       if (i > 0)
 174         anOutput << ", ";
 175       if (theTexts[i].empty())
 176         anOutput << theValues[i];
 177       else
 178         anOutput << "\"" << theTexts[i] << "\"";
 179     }
 180     write(anOutput.str());
 181   }
 182
 183   virtual void write(const std::shared_ptr<ModelAPI_AttributeSelection>& theAttrSelect)
 184   {
 185     if (myStorageArray.empty())
 186       addStorage(DumpStoragePtr(new DumpStorage));
 187
 188     std::list<ModelHighAPI_Dumper::DumpStoragePtr>::iterator anIt = myStorageArray.begin();
 189     for (; anIt != myStorageArray.end(); ++anIt)
 190       (*anIt)->write(theAttrSelect);
 191   }
 192
 193   virtual void reserveBuffer()
 194   {
 195     std::list<ModelHighAPI_Dumper::DumpStoragePtr>::iterator anIt = myStorageArray.begin();
 196     for (; anIt != myStorageArray.end(); ++anIt)
 197       (*anIt)->reserveBuffer();
 198   }
 199
 200   virtual void restoreReservedBuffer()
 201   {
 202     std::list<ModelHighAPI_Dumper::DumpStoragePtr>::iterator anIt = myStorageArray.begin();
 203     for (; anIt != myStorageArray.end(); ++anIt)
 204       (*anIt)->restoreReservedBuffer();
 205   }
 206
 207   virtual bool exportTo(const std::string& theFilename, const ModulesSet& theUsedModules)
 208   {
 209     static const std::string THE_EXT = ".py";
 210     std::string aFilenameBase = theFilename;
 211     if (aFilenameBase.rfind(THE_EXT) == aFilenameBase.size() - THE_EXT.size())
 212       aFilenameBase = aFilenameBase.substr(0, aFilenameBase.size() - THE_EXT.size());
 213
 214     bool isOk = true;
 215     std::list<ModelHighAPI_Dumper::DumpStoragePtr>::iterator anIt = myStorageArray.begin();
 216     for (; anIt != myStorageArray.end(); ++anIt) {
 217       std::string aFilename = aFilenameBase + (*anIt)->myFilenameSuffix + THE_EXT;
 218       isOk = (*anIt)->exportTo(aFilename, theUsedModules) && isOk;
 219     }
 220     return isOk;
 221   }
 222
 223 private:
 224   std::list<ModelHighAPI_Dumper::DumpStoragePtr> myStorageArray;
 225 };
 226
 227
 228 ModelHighAPI_Dumper::DumpStorage::DumpStorage(const DumpStorage& theOther)
 229   : myFilenameSuffix(theOther.myFilenameSuffix),
 230     myDumpBufferHideout(theOther.myDumpBufferHideout)
 231 {
 232   myFullDump.str(theOther.myFullDump.str());
 233   myDumpBuffer.str(theOther.myDumpBuffer.str());
 234 }
 235
 236 const ModelHighAPI_Dumper::DumpStorage&
 237 ModelHighAPI_Dumper::DumpStorage::operator=(const ModelHighAPI_Dumper::DumpStorage& theOther)
 238 {
 239   myFilenameSuffix = theOther.myFilenameSuffix;
 240   myFullDump.str(theOther.myFullDump.str());
 241   myDumpBuffer.str(theOther.myDumpBuffer.str());
 242   myDumpBufferHideout = theOther.myDumpBufferHideout;
 243   return *this;
 244 }
 245
 246 void ModelHighAPI_Dumper::DumpStorage::reserveBuffer()
 247 {
 248   myDumpBufferHideout.push(myDumpBuffer.str());
 249   myDumpBuffer.str("");
 250 }
 251
 252 void ModelHighAPI_Dumper::DumpStorage::restoreReservedBuffer()
 253 {
 254   myDumpBuffer << myDumpBufferHideout.top();
 255   myDumpBufferHideout.pop();
 256 }
 257
 258 bool ModelHighAPI_Dumper::DumpStorage::exportTo(const std::string& theFilename,
 259                                                 const ModulesSet& theUsedModules)
 260 {
 261   std::ofstream aFile;
 262   OSD_OpenStream(aFile, theFilename.c_str(), std::ofstream::out);
 263   if (!aFile.is_open())
 264     return false;
 265
 266   // standard header imported modules
 267   for (ModulesSet::const_iterator aModIt = theUsedModules.begin();
 268     aModIt != theUsedModules.end(); ++aModIt) {
 269     aFile << "from " << *aModIt << " import *" << std::endl;
 270   }
 271   if (!theUsedModules.empty())
 272     aFile << std::endl;
 273
 274   aFile << "from salome.shaper import model" << std::endl << std::endl;
 275   aFile << "model.begin()" << std::endl;
 276
 277   // dump collected data
 278   aFile << myFullDump.str();
 279   aFile << myDumpBuffer.str();
 280
 281   // standard footer
 282   aFile << "model.end()" << std::endl;
 283   aFile.close();
 284
 285   return true;
 286 }
 287
 288 static void getShapeAndContext(const AttributeSelectionPtr& theAttrSelect,
 289                                GeomShapePtr& theShape, ResultPtr& theContext)
 290 {
 291   if (theAttrSelect->isInitialized()) {
 292     theShape = theAttrSelect->value();
 293     theContext = theAttrSelect->context();
 294     if (!theShape.get())
 295       theShape = theContext->shape();
 296
 297     if (theAttrSelect->isGeometricalSelection() &&
 298         theShape.get() && theShape->shapeType() == GeomAPI_Shape::COMPOUND &&
 299         theContext.get() && !theShape->isEqual(theContext->shape()) &&
 300         theContext->groupName() != ModelAPI_ResultPart::group() &&
 301         theContext->groupName() != ModelAPI_ResultGroup::group()) {
 302       GeomAPI_ShapeIterator anIt(theShape);
 303       theShape = anIt.current();
 304     }
 305   }
 306 }
 307
 308 void ModelHighAPI_Dumper::DumpStorage::write(const AttributeSelectionPtr& theAttrSelect)
 309 {
 310   myDumpBuffer << "model.selection(";
 311
 312   GeomShapePtr aShape;
 313   ResultPtr aContext;
 314   getShapeAndContext(theAttrSelect, aShape, aContext);
 315
 316   if (aShape.get()) {
 317     myDumpBuffer << "\"" << aShape->shapeTypeStr() << "\", \""
 318                  << theAttrSelect->namingName() << "\"";
 319   }
 320
 321   myDumpBuffer << ")";
 322 }
 323
 324 static int possibleSelectionsByPoint(const GeomPointPtr& thePoint,
 325                                      const ResultPtr& theResult,
 326                                      const GeomShapePtr& theShape,
 327                                      const FeaturePtr& theStartFeature,
 328                                      const FeaturePtr& theEndFeature)
 329 {
 330   DocumentPtr aDoc1 = theStartFeature->document();
 331   DocumentPtr aDoc2 = theEndFeature->document();
 332
 333   std::list<FeaturePtr> aFeatures = aDoc1->allFeatures();
 334   if (aDoc1 != aDoc2) {
 335     // Find the position of the part, where its features should be inserted.
 336     // It will avoid checking of appropriate elements in partSet after the current part.
 337     std::list<FeaturePtr>::iterator aFIt = aFeatures.begin();
 338     for (; aFIt != aFeatures.end(); ++aFIt) {
 339       ResultPartPtr aPartRes =
 340           std::dynamic_pointer_cast<ModelAPI_ResultPart>((*aFIt)->lastResult());
 341       if (aPartRes && aPartRes->partDoc() == aDoc2)
 342         break;
 343     }
 344
 345     std::list<FeaturePtr> anAdditionalFeatures = aDoc2->allFeatures();
 346     aFeatures.insert(aFIt, anAdditionalFeatures.begin(), anAdditionalFeatures.end());
 347   }
 348
 349   CompositeFeaturePtr aLastCompositeFeature;
 350
 351   std::list<FeaturePtr>::const_iterator aFIt = aFeatures.begin();
 352   while (aFIt != aFeatures.end() && *aFIt != theStartFeature) {
 353     CompositeFeaturePtr aCompFeat = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(*aFIt);
 354     if (aCompFeat)
 355       aLastCompositeFeature = aCompFeat;
 356     ++aFIt;
 357   }
 358
 359   // collect the list of composite features, containing the last feature;
 360   // these features should be excluded from searching,
 361   // because the feature cannot select sub-shapes from its parent
 362   std::set<FeaturePtr> aEndFeatureParents = ModelAPI_Tools::getParents(theEndFeature);
 363
 364   int aNbPossibleSelections = 0;
 365   for (; aFIt != aFeatures.end() && *aFIt != theEndFeature; ++aFIt) {
 366     bool isSkipFeature = false;
 367     if (aLastCompositeFeature && aLastCompositeFeature->isSub(*aFIt))
 368       isSkipFeature = true;
 369     CompositeFeaturePtr aCompFeat = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(*aFIt);
 370     if (aCompFeat) {
 371       ResultPartPtr aPartRes =
 372           std::dynamic_pointer_cast<ModelAPI_ResultPart>(aCompFeat->firstResult());
 373       if (!aPartRes)
 374         aLastCompositeFeature = aCompFeat;
 375       if (aEndFeatureParents.find(aCompFeat) != aEndFeatureParents.end()) {
 376         // do not process the parent for the last feature,
 377         // because it cannot select objects from its parent
 378         isSkipFeature = true;
 379       }
 380     }
 381     if (isSkipFeature)
 382       continue;
 383
 384     std::list<ModelGeomAlgo_Shape::SubshapeOfResult> anApproproate;
 385     if (ModelGeomAlgo_Shape::findSubshapeByPoint(*aFIt, thePoint, theShape->shapeType(),
 386                                                  anApproproate)) {
 387       bool isContinue = true;
 388       std::list<std::pair<GeomShapePtr, int> > aCenters;
 389       std::list<ModelGeomAlgo_Shape::SubshapeOfResult>::iterator anApIt = anApproproate.begin();
 390       for (; anApIt != anApproproate.end() && isContinue; ++anApIt) {
 391         ++aNbPossibleSelections;
 392
 393         // stop if the target shape and result are found
 394         GeomShapePtr aCurShape = anApIt->mySubshape;
 395         if (!aCurShape)
 396           aCurShape = anApIt->myResult->shape();
 397
 398         if (anApIt->myResult->isSame(theResult)) {
 399           if (anApIt->myCenterType == (int)ModelAPI_AttributeSelection::NOT_CENTER)
 400             isContinue = !aCurShape->isSame(theShape);
 401           else if (theShape->isVertex() && aCurShape->isEdge()) {
 402             GeomEdgePtr aCurEdge = aCurShape->edge();
 403             GeomVertexPtr aVertex = theShape->vertex();
 404             GeomPointPtr aCenter;
 405             switch (anApIt->myCenterType) {
 406             case (int)ModelAPI_AttributeSelection::CIRCLE_CENTER: {
 407                 GeomCirclePtr aCirc = aCurEdge->circle();
 408                 if (aCirc)
 409                   aCenter = aCirc->center();
 410                 break;
 411               }
 412             case (int)ModelAPI_AttributeSelection::ELLIPSE_FIRST_FOCUS: {
 413                 GeomEllipsePtr anEllipse = aCurEdge->ellipse();
 414                 if (anEllipse)
 415                   aCenter = anEllipse->firstFocus();
 416                 break;
 417               }
 418             case (int)ModelAPI_AttributeSelection::ELLIPSE_SECOND_FOCUS: {
 419                 GeomEllipsePtr anEllipse = aCurEdge->ellipse();
 420                 if (anEllipse)
 421                   aCenter = anEllipse->secondFocus();
 422                 break;
 423               }
 424             }
 425             if (aCenter && aCenter->distance(aVertex->point()) < 1.e-7)
 426               aCenters.push_back(std::pair<GeomShapePtr, int>(aCurShape, aNbPossibleSelections));
 427           }
 428         }
 429       }
 430       // passed till the appropriate shape, check the center of circle
 431       // or a focus of ellipse is selected
 432       if (isContinue && !aCenters.empty())
 433         aNbPossibleSelections = aCenters.front().second;
 434     }
 435   }
 436   return aNbPossibleSelections;
 437 }
 438
 439 void ModelHighAPI_Dumper::DumpStorageGeom::write(const AttributeSelectionPtr& theAttrSelect)
 440 {
 441   GeomShapePtr aShape;
 442   ResultPtr aContext;
 443   getShapeAndContext(theAttrSelect, aShape, aContext);
 444
 445   // how to dump selection: construction features are dumped by name always
 446   FeaturePtr aSelectedFeature;
 447   FeaturePtr aFeature = theAttrSelect->contextFeature();
 448   if (aShape && aContext && !aFeature)
 449     aSelectedFeature = ModelAPI_Feature::feature(aContext->data()->owner());
 450   bool isDumpByGeom = aSelectedFeature && aSelectedFeature->isInHistory();
 451
 452   if (isDumpByGeom) {
 453     myDumpBuffer << "model.selection(\"" << aShape->shapeTypeStr();
 454     // check the selected item is a ResultPart;
 455     // in this case it is necessary to get shape with full transformation
 456     // for correct calculation of the middle point
 457     ResultPartPtr aResPart =
 458       std::dynamic_pointer_cast<ModelAPI_ResultPart>(theAttrSelect->context());
 459     if (aResPart && aShape->shapeType() == GeomAPI_Shape::COMPOUND)
 460       aShape = aResPart->shape();
 461     GeomPointPtr aMiddlePoint = aShape->middlePoint();
 462     // calculate number of features, which could be selected by the same point
 463     FeaturePtr anOwner = ModelAPI_Feature::feature(theAttrSelect->owner());
 464     int aNbPossibleSelections = possibleSelectionsByPoint(aMiddlePoint,
 465         theAttrSelect->context(), aShape, aSelectedFeature, anOwner);
 466
 467     // produce the index if the number of applicable features is greater than 1
 468     std::string anIndex;
 469     if (aNbPossibleSelections > 1) {
 470       std::ostringstream anOutput;
 471       anOutput << "_" << aNbPossibleSelections;
 472       anIndex = anOutput.str();
 473     }
 474
 475     myDumpBuffer << std::setprecision(THE_DUMP_PRECISION)
 476                  << anIndex << "\", ("
 477                  << aMiddlePoint->x() << ", "
 478                  << aMiddlePoint->y() << ", "
 479                  << aMiddlePoint->z() << ")";
 480     myDumpBuffer << ")";
 481   }
 482   else
 483     DumpStorage::write(theAttrSelect);
 484 }
 485
 486 void ModelHighAPI_Dumper::DumpStorageWeak::write(const AttributeSelectionPtr& theAttrSelect)
 487 {
 488   GeomShapePtr aShape;
 489   ResultPtr aContext;
 490   getShapeAndContext(theAttrSelect, aShape, aContext);
 491
 492   bool aStandardDump = true;
 493   if (aShape.get() && aContext.get() &&
 494       aShape != aContext->shape()) { // weak naming for local selection only
 495     GeomAlgoAPI_NExplode aNExplode(aContext->shape(), aShape->shapeType());
 496     int anIndex = aNExplode.index(aShape);
 497     if (anIndex != 0) { // found a week-naming index, so, export it
 498       myDumpBuffer << "model.selection(\"" << aShape->shapeTypeStr() << "\", \""
 499                    << theAttrSelect->contextName(aContext) << "\", " << anIndex << ")";
 500       aStandardDump = false;
 501     }
 502   }
 503   if (aStandardDump)
 504     DumpStorage::write(theAttrSelect);
 505 }
 506 // ======================================================================
 507
 508
 509 static int gCompositeStackDepth = 0;
 510
 511 ModelHighAPI_Dumper* ModelHighAPI_Dumper::mySelf = 0;
 512
 513 ModelHighAPI_Dumper::ModelHighAPI_Dumper()
 514   : myDumpStorage(new DumpStorageBuffer),
 515     myDumpPostponedInProgress(false)
 516 {
 517 }
 518
 519 ModelHighAPI_Dumper::~ModelHighAPI_Dumper()
 520 {
 521   delete myDumpStorage;
 522 }
 523
 524 void ModelHighAPI_Dumper::setInstance(ModelHighAPI_Dumper* theDumper)
 525 {
 526   if (mySelf == 0)
 527     mySelf = theDumper;
 528 }
 529
 530 ModelHighAPI_Dumper* ModelHighAPI_Dumper::getInstance()
 531 {
 532   return mySelf;
 533 }
 534
 535 void ModelHighAPI_Dumper::addCustomStorage(const ModelHighAPI_Dumper::DumpStoragePtr& theStorage)
 536 {
 537   myDumpStorage->addStorage(theStorage);
 538 }
 539
 540 void ModelHighAPI_Dumper::clearCustomStorage()
 541 {
 542   myDumpStorage->clear();
 543
 544   myNames.clear();
 545   myModules.clear();
 546   myFeatureCount.clear();
 547   myPostponed.clear();
 548   while (!myEntitiesStack.empty())
 549     myEntitiesStack.pop();
 550   clearNotDumped();
 551 }
 552
 553 void ModelHighAPI_Dumper::clearNotDumped()
 554 {
 555   myNotDumpedEntities.clear();
 556 }
 557
 558 // Convert string to integer. If the string is not a number, return -1
 559 static int toInt(const std::string& theString)
 560 {
 561   std::string::const_iterator aChar = theString.begin();
 562   for (; aChar != theString.end(); ++aChar)
 563     if (!std::isdigit(*aChar))
 564       break;
 565   if (aChar != theString.end())
 566     return -1; // not a number
 567   return std::stoi(theString);
 568 }
 569
 570 const std::string& ModelHighAPI_Dumper::name(const EntityPtr& theEntity,
 571                                              bool theSaveNotDumped,
 572                                              bool theUseEntityName)
 573 {
 574   EntityNameMap::const_iterator aFound = myNames.find(theEntity);
 575   if (aFound != myNames.end())
 576     return aFound->second.myCurrentName;
 577
 578   // entity is not found, store it
 579   std::string aName, aKind;
 580   bool isDefaultName = false;
 581   bool isSaveNotDumped = theSaveNotDumped;
 582   std::ostringstream aDefaultName;
 583   FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(theEntity);
 584   if (aFeature) {
 585     aName = aFeature->name();
 586     aKind = aFeature->getKind();
 587   } else {
 588     FolderPtr aFolder = std::dynamic_pointer_cast<ModelAPI_Folder>(theEntity);
 589     if (aFolder) {
 590       aName = aFolder->data()->name();
 591       aKind = ModelAPI_Folder::ID();
 592       isSaveNotDumped = false;
 593     }
 594   }
 595
 596   ObjectPtr anObject = std::dynamic_pointer_cast<ModelAPI_Object>(theEntity);
 597   if (anObject) {
 598     DocumentPtr aDoc = anObject->document();
 599     std::pair<int, int>& aNbFeatures = myFeatureCount[aDoc][aKind];
 600     aNbFeatures.first += 1;
 601
 602     size_t anIndex = aName.find(aKind);
 603     if (anIndex == 0 && aName[aKind.length()] == '_') { // name starts with "FeatureKind_"
 604       std::string anIdStr = aName.substr(aKind.length() + 1);
 605       int anId = toInt(anIdStr);
 606
 607       // Check number of already registered objects of such kind. Index of current object
 608       // should be the same to identify feature's name as automatically generated.
 609       if (aNbFeatures.first == anId && aNbFeatures.second < anId) {
 610         // name is not user-defined
 611         isDefaultName = true;
 612
 613         // check there are postponed features of this kind,
 614         // dump their names, because the sequence of features may be changed
 615         for (std::list<EntityPtr>::const_iterator aPpIt = myPostponed.begin();
 616             aPpIt != myPostponed.end(); ++aPpIt) {
 617           FeaturePtr aCurFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(*aPpIt);
 618           if (aCurFeature && aCurFeature->getKind() == aKind) {
 619             myNames[*aPpIt].myIsDefault = false;
 620             isDefaultName = false;
 621           }
 622         }
 623       }
 624
 625       if (anId > aNbFeatures.second)
 626         aNbFeatures.second = anId;
 627     }
 628
 629     // obtain default name for the feature
 630     if (theUseEntityName)
 631       aDefaultName << aName;
 632     else {
 633       int aFullIndex = 0;
 634       NbFeaturesMap::const_iterator aFIt = myFeatureCount.begin();
 635       for (; aFIt != myFeatureCount.end(); ++aFIt) {
 636         std::map<std::string, std::pair<int, int> >::const_iterator aFound =
 637           aFIt->second.find(aKind);
 638         if (aFound != aFIt->second.end())
 639           aFullIndex += aFound->second.first;
 640       }
 641       aDefaultName << aKind << "_" << aFullIndex;
 642     }
 643   }
 644
 645   myNames[theEntity] = EntityName(aDefaultName.str(), aName, isDefaultName);
 646   if (isSaveNotDumped)
 647     myNotDumpedEntities.insert(theEntity);
 648
 649   // store names of results
 650   if (aFeature)
 651     saveResultNames(aFeature);
 652
 653   return myNames[theEntity].myCurrentName;
 654 }
 655
 656 const std::string& ModelHighAPI_Dumper::parentName(const FeaturePtr& theEntity)
 657 {
 658   const std::set<AttributePtr>& aRefs = theEntity->data()->refsToMe();
 659   std::set<AttributePtr>::const_iterator aRefIt = aRefs.begin();
 660   for (; aRefIt != aRefs.end(); ++aRefIt) {
 661     CompositeFeaturePtr anOwner = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(
 662         ModelAPI_Feature::feature((*aRefIt)->owner()));
 663     if (anOwner)
 664       return name(anOwner);
 665   }
 666
 667   static const std::string DUMMY;
 668   return DUMMY;
 669 }
 670
 671 void ModelHighAPI_Dumper::saveResultNames(const FeaturePtr& theFeature)
 672 {
 673   // Default name of the feature
 674   bool isFeatureDefaultName = myNames[theFeature].myIsDefault;
 675
 676   // Save only names of results which is not correspond to default feature name
 677   std::list<ResultPtr> allRes;
 678   ModelAPI_Tools::allResults(theFeature, allRes);
 679   for(std::list<ResultPtr>::iterator aRes = allRes.begin(); aRes != allRes.end(); aRes++) {
 680     std::pair<std::string, bool> aName = ModelAPI_Tools::getDefaultName(*aRes);
 681     std::string aDefaultName = aName.first;
 682     std::string aResName = (*aRes)->data()->name();
 683     bool isUserDefined = !(isFeatureDefaultName && aDefaultName == aResName);
 684     myNames[*aRes] =
 685       EntityName(aResName, (isUserDefined ? aResName : std::string()), !isUserDefined);
 686   }
 687 }
 688
 689 bool ModelHighAPI_Dumper::process(const std::shared_ptr<ModelAPI_Document>& theDoc,
 690                                   const std::string& theFileName)
 691 {
 692   // dump top level document feature
 693   static const std::string aDocName("partSet");
 694   myNames[theDoc] = EntityName(aDocName, std::string(), true);
 695   *this << aDocName << " = model.moduleDocument()" << std::endl;
 696
 697   // dump subfeatures and store result to file
 698   bool isOk = process(theDoc) && myDumpStorage->exportTo(theFileName, myModules);
 699   return isOk;
 700 }
 701
 702 bool ModelHighAPI_Dumper::process(const std::shared_ptr<ModelAPI_Document>& theDoc)
 703 {
 704   bool isOk = true;
 705   std::list<ObjectPtr> anObjects = theDoc->allObjects();
 706   std::list<ObjectPtr>::const_iterator anObjIt = anObjects.begin();
 707   // firstly, dump all parameters
 708   for (; anObjIt != anObjects.end(); ++ anObjIt) {
 709     FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(*anObjIt);
 710     if (aFeature)
 711       dumpParameter(aFeature);
 712   }
 713   // dump all other features
 714   for (anObjIt = anObjects.begin(); anObjIt != anObjects.end(); ++anObjIt) {
 715     CompositeFeaturePtr aCompFeat = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(*anObjIt);
 716     if (aCompFeat) {
 717       // iteratively process composite features,
 718       // if the composite feature is the last in the document, no need to dump "model.do()" action
 719       std::list<ObjectPtr>::const_iterator aNext = anObjIt;
 720       isOk = process(aCompFeat, false, ++aNext != anObjects.end()) && isOk;
 721     }
 722     else if (!isDumped(EntityPtr(*anObjIt))) {
 723       // dump folder
 724       FolderPtr aFolder = std::dynamic_pointer_cast<ModelAPI_Folder>(*anObjIt);
 725       if (aFolder)
 726         dumpFolder(aFolder);
 727       else {
 728         FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(*anObjIt);
 729         if (aFeature) // dump common feature
 730           dumpFeature(aFeature);
 731       }
 732     }
 733   }
 734   // dump folders if any
 735   dumpPostponed(true);
 736   return isOk;
 737 }
 738
 739 bool ModelHighAPI_Dumper::process(const std::shared_ptr<ModelAPI_CompositeFeature>& theComposite,
 740                                   bool isForce, bool isDumpModelDo)
 741 {
 742   // increase composite features stack
 743   ++gCompositeStackDepth;
 744   // dump composite itself
 745   if (!isDumped(EntityPtr(theComposite)) || isForce)
 746     dumpFeature(FeaturePtr(theComposite), isForce);
 747
 748   // sub-part is processed independently, because it provides separate document
 749   if (theComposite->getKind() == PartSetPlugin_Part::ID()) {
 750     // dump name of the part if it is different from default
 751     if (!myEntitiesStack.empty())
 752       dumpEntitySetName();
 753
 754     // decrease composite features stack because we run into separate document
 755     --gCompositeStackDepth;
 756
 757     ResultPartPtr aPartResult =
 758         std::dynamic_pointer_cast<ModelAPI_ResultPart>(theComposite->lastResult());
 759     if (!aPartResult)
 760       return false;
 761     DocumentPtr aSubDoc = aPartResult->partDoc();
 762     if (!aSubDoc)
 763       return false;
 764     // set name of document
 765     const std::string& aPartName = myNames[theComposite].myCurrentName;
 766     std::string aDocName = aPartName + "_doc";
 767     myNames[aSubDoc] = EntityName(aDocName, std::string(), true);
 768
 769     // dump document in a separate line
 770     *this << aDocName << " = " << aPartName << ".document()" << std::endl;
 771     // dump features in the document
 772     bool aRes = process(aSubDoc);
 773     if (isDumpModelDo)
 774       *this << "model.do()\n";
 775     *this << std::endl;
 776     return aRes;
 777   }
 778
 779   // dump sub-features
 780   bool isOk = processSubs(theComposite);
 781   // decrease composite features stack
 782   --gCompositeStackDepth;
 783
 784   return isOk;
 785 }
 786
 787 bool ModelHighAPI_Dumper::processSubs(
 788   const std::shared_ptr<ModelAPI_CompositeFeature>& theComposite,
 789   bool theDumpModelDo)
 790 {
 791   bool isOk = true;
 792   // dump all sub-features;
 793   bool isSubDumped = false;
 794   int aNbSubs = theComposite->numberOfSubs();
 795   for (int anIndex = 0; anIndex < aNbSubs; ++anIndex) {
 796     FeaturePtr aFeature = theComposite->subFeature(anIndex);
 797     if (isDumped(EntityPtr(aFeature)))
 798       continue;
 799
 800     isSubDumped = true;
 801     CompositeFeaturePtr aCompFeat = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aFeature);
 802     if (aCompFeat) // iteratively process composite features
 803       isOk = process(aCompFeat) && isOk;
 804     else
 805       dumpFeature(aFeature, true);
 806   }
 807
 808   bool isDumpSetName = !myEntitiesStack.empty() &&
 809       myEntitiesStack.top().myEntity == EntityPtr(theComposite);
 810   bool isForceModelDo = isSubDumped && isDumpSetName &&
 811       (myEntitiesStack.top().myUserName || !myEntitiesStack.top().myResults.empty());
 812   // It is necessary for the sketch to create its result when complete (command "model.do()").
 813   // This option is set by flat theDumpModelDo.
 814   // However, nested sketches are rebuilt by parent feature, so, they do not need
 815   // explicit call of "model.do()". This will be controlled by the depth of the stack.
 816   if (isForceModelDo || (theDumpModelDo && gCompositeStackDepth <= 1))
 817     *this << "model.do()" << std::endl;
 818
 819   // dump "setName" for composite feature
 820   if (isDumpSetName)
 821     dumpEntitySetName();
 822   return isOk;
 823 }
 824
 825 void ModelHighAPI_Dumper::postpone(const EntityPtr& theEntity)
 826 {
 827   // keep the name
 828   name(theEntity, false);
 829   myPostponed.push_back(theEntity);
 830 }
 831
 832 void ModelHighAPI_Dumper::dumpPostponed(bool theDumpFolders)
 833 {
 834   if (myDumpPostponedInProgress)
 835     return;
 836
 837   myDumpPostponedInProgress = true;
 838   // make a copy of postponed entities, because the list will be updated
 839   // if some features are not able to be dumped
 840   std::list<EntityPtr> aPostponedCopy = myPostponed;
 841   myPostponed.clear();
 842
 843   // iterate over postponed entities and try to dump them
 844   std::list<EntityPtr>::const_iterator anIt = aPostponedCopy.begin();
 845   for (; anIt != aPostponedCopy.end(); ++anIt) {
 846     FolderPtr aFolder = std::dynamic_pointer_cast<ModelAPI_Folder>(*anIt);
 847     if (aFolder) {
 848       if (theDumpFolders)
 849         dumpFolder(aFolder);
 850       else
 851         myPostponed.push_back(*anIt);
 852     }
 853     else {
 854       FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(*anIt);
 855       if (aFeature)
 856         dumpFeature(aFeature, true);
 857     }
 858   }
 859   myDumpPostponedInProgress = false;
 860 }
 861
 862 void ModelHighAPI_Dumper::dumpSubFeatureNameAndColor(const std::string theSubFeatureGet,
 863                                                      const FeaturePtr& theSubFeature)
 864 {
 865   name(theSubFeature, false);
 866   myNames[theSubFeature] = EntityName(theSubFeatureGet, theSubFeature->name(), false);
 867
 868   // store results if they have user-defined names or colors
 869   std::list<ResultPtr> aResultsWithNameOrColor;
 870   const std::list<ResultPtr>& aResults = theSubFeature->results();
 871   std::list<ResultPtr>::const_iterator aResIt = aResults.begin();
 872   for (; aResIt != aResults.end(); ++aResIt) {
 873     std::string aResName = (*aResIt)->data()->name();
 874     myNames[*aResIt] = EntityName(aResName, aResName, false);
 875     aResultsWithNameOrColor.push_back(*aResIt);
 876   }
 877
 878   // store just dumped entity to stack
 879   myEntitiesStack.push(LastDumpedEntity(theSubFeature, true, aResultsWithNameOrColor));
 880
 881   dumpEntitySetName();
 882 }
 883
 884 void ModelHighAPI_Dumper::importModule(const std::string& theModuleName)
 885 {
 886   myModules.insert(theModuleName);
 887 }
 888
 889 void ModelHighAPI_Dumper::dumpEntitySetName()
 890 {
 891   const LastDumpedEntity& aLastDumped = myEntitiesStack.top();
 892   bool isBufferEmpty = myDumpStorage->isBufferEmpty();
 893
 894   // dump "setName" for the entity
 895   if (aLastDumped.myUserName) {
 896     EntityName& anEntityNames = myNames[aLastDumped.myEntity];
 897     if (!anEntityNames.myIsDefault)
 898       *myDumpStorage << anEntityNames.myCurrentName << ".setName(\""
 899                      << anEntityNames.myUserName << "\")\n";
 900     // don't dump "setName" for the entity twice
 901     anEntityNames.myUserName.clear();
 902     anEntityNames.myIsDefault = true;
 903   }
 904   // dump "setName" for results
 905   std::list<ResultPtr>::const_iterator aResIt = aLastDumped.myResults.begin();
 906   std::list<ResultPtr>::const_iterator aResEnd = aLastDumped.myResults.end();
 907   for (; aResIt != aResEnd; ++aResIt) {
 908     // set result name
 909     EntityName& anEntityNames = myNames[*aResIt];
 910     if (!anEntityNames.myIsDefault) {
 911       *this << *aResIt;
 912       *myDumpStorage << ".setName(\"" << anEntityNames.myUserName << "\")\n";
 913       // don't dump "setName" for the entity twice
 914       anEntityNames.myUserName.clear();
 915       anEntityNames.myIsDefault = true;
 916     }
 917     // set result color
 918     if (!isDefaultColor(*aResIt)) {
 919       AttributeIntArrayPtr aColor = (*aResIt)->data()->intArray(ModelAPI_Result::COLOR_ID());
 920       if (aColor && aColor->isInitialized()) {
 921         *this << *aResIt;
 922         *myDumpStorage << ".setColor(" << aColor->value(0) << ", " << aColor->value(1)
 923                        << ", " << aColor->value(2) << ")\n";
 924       }
 925     }
 926     // set result deflection
 927     if (!isDefaultDeflection(*aResIt)) {
 928       AttributeDoublePtr aDeflectionAttr =
 929         (*aResIt)->data()->real(ModelAPI_Result::DEFLECTION_ID());
 930       if(aDeflectionAttr.get() && aDeflectionAttr->isInitialized()) {
 931         *this << *aResIt;
 932         *myDumpStorage << ".setDeflection(" << aDeflectionAttr->value() << ")\n";
 933       }
 934     }
 935     // set result transparency
 936     if (!isDefaultTransparency(*aResIt)) {
 937       AttributeDoublePtr aTransparencyAttr =
 938         (*aResIt)->data()->real(ModelAPI_Result::TRANSPARENCY_ID());
 939       if(aTransparencyAttr.get() && aTransparencyAttr->isInitialized()) {
 940         *this << *aResIt;
 941         *myDumpStorage << ".setTransparency(" << aTransparencyAttr->value() << ")\n";
 942       }
 943     }
 944   }
 945
 946   myNames[aLastDumped.myEntity].myIsDumped = true;
 947   myEntitiesStack.pop();
 948
 949   // clean buffer if it was clear before
 950   if (isBufferEmpty)
 951     myDumpStorage->mergeBuffer();
 952 }
 953
 954 bool ModelHighAPI_Dumper::isDumped(const EntityPtr& theEntity) const
 955 {
 956   EntityNameMap::const_iterator aFound = myNames.find(theEntity);
 957   FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(theEntity);
 958   return (aFound != myNames.end() && aFound->second.myIsDumped) ||
 959          myFeaturesToSkip.find(aFeature) != myFeaturesToSkip.end();
 960 }
 961
 962 bool ModelHighAPI_Dumper::isDumped(const AttributeRefAttrPtr& theRefAttr) const
 963 {
 964   FeaturePtr aFeature;
 965   if (theRefAttr->isObject())
 966     aFeature = ModelAPI_Feature::feature(theRefAttr->object());
 967   else
 968     aFeature = ModelAPI_Feature::feature(theRefAttr->attr()->owner());
 969   return aFeature && isDumped(EntityPtr(aFeature));
 970 }
 971
 972 bool ModelHighAPI_Dumper::isDumped(const AttributeRefListPtr& theRefList) const
 973 {
 974   std::list<ObjectPtr> aRefs = theRefList->list();
 975   std::list<ObjectPtr>::iterator anIt = aRefs.begin();
 976   for (; anIt != aRefs.end(); ++anIt) {
 977     FeaturePtr aFeature = ModelAPI_Feature::feature(*anIt);
 978     if (aFeature && !isDumped(EntityPtr(aFeature)))
 979       return false;
 980   }
 981   return true;
 982 }
 983
 984 static bool isSketchSub(const FeaturePtr& theFeature)
 985 {
 986   static const std::string SKETCH("Sketch");
 987   CompositeFeaturePtr anOwner = ModelAPI_Tools::compositeOwner(theFeature);
 988   return anOwner && anOwner->getKind() == SKETCH;
 989 }
 990
 991 bool ModelHighAPI_Dumper::isDefaultColor(const ResultPtr& theResult) const
 992 {
 993   AttributeIntArrayPtr aColor = theResult->data()->intArray(ModelAPI_Result::COLOR_ID());
 994   if (!aColor || !aColor->isInitialized())
 995     return true;
 996
 997   // check the result belongs to sketch entity, do not dump color in this way
 998   ResultConstructionPtr aResConstr =
 999       std::dynamic_pointer_cast<ModelAPI_ResultConstruction>(theResult);
1000   if (aResConstr) {
1001     FeaturePtr aFeature = ModelAPI_Feature::feature(theResult->data()->owner());
1002     if (isSketchSub(aFeature))
1003       return true;
1004   }
1005
1006   std::string aSection, aName, aDefault;
1007   theResult->colorConfigInfo(aSection, aName, aDefault);
1008
1009   // dump current color
1010   std::ostringstream aColorInfo;
1011   aColorInfo << aColor->value(0) << "," << aColor->value(1) << "," << aColor->value(2);
1012
1013   return aDefault == aColorInfo.str();
1014 }
1015
1016 bool ModelHighAPI_Dumper::isDefaultDeflection(const ResultPtr& theResult) const
1017 {
1018   AttributeDoublePtr aDeflectionAttr = theResult->data()->real(ModelAPI_Result::DEFLECTION_ID());
1019   if(!aDeflectionAttr || !aDeflectionAttr->isInitialized()) {
1020     return true;
1021   }
1022
1023   double aCurrent = aDeflectionAttr->value();
1024   double aDefault = -1;
1025
1026   bool isConstruction = false;
1027   std::string aResultGroup = theResult->groupName();
1028   if (aResultGroup == ModelAPI_ResultConstruction::group())
1029     isConstruction = true;
1030   else if (aResultGroup == ModelAPI_ResultBody::group()) {
1031     GeomShapePtr aGeomShape = theResult->shape();
1032     if (aGeomShape.get()) {
1033       // if the shape could not be exploded on faces, it contains only wires, edges, and vertices
1034       // correction of deviation for them should not influence to the application performance
1035       GeomAPI_ShapeExplorer anExp(aGeomShape, GeomAPI_Shape::FACE);
1036       isConstruction = !anExp.more();
1037     }
1038   }
1039   if (isConstruction)
1040     aDefault = Config_PropManager::real("Visualization", "construction_deflection");
1041   else
1042     aDefault = Config_PropManager::real("Visualization", "body_deflection");
1043
1044   return fabs(aCurrent - aDefault) < 1.e-12;
1045 }
1046
1047 bool ModelHighAPI_Dumper::isDefaultTransparency(const ResultPtr& theResult) const
1048 {
1049   AttributeDoublePtr anAttribute = theResult->data()->real(ModelAPI_Result::TRANSPARENCY_ID());
1050   if(!anAttribute || !anAttribute->isInitialized()) {
1051     return true;
1052   }
1053   return fabs(anAttribute->value()) < 1.e-12;
1054 }
1055
1056 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const char theChar)
1057 {
1058   *myDumpStorage << theChar;
1059   return *this;
1060 }
1061
1062 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const char* theString)
1063 {
1064   *myDumpStorage << theString;
1065   return *this;
1066 }
1067
1068 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const std::string& theString)
1069 {
1070   *myDumpStorage << theString;
1071   return *this;
1072 }
1073
1074 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const bool theValue)
1075 {
1076   *myDumpStorage << (theValue ? "True" : "False");
1077   return *this;
1078 }
1079
1080 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const int theValue)
1081 {
1082   *myDumpStorage << theValue;
1083   return *this;
1084 }
1085
1086 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const double theValue)
1087 {
1088   *myDumpStorage << theValue;
1089   return *this;
1090 }
1091
1092 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const std::shared_ptr<GeomAPI_Pnt>& thePoint)
1093 {
1094   importModule("GeomAPI");
1095   *myDumpStorage << "GeomAPI_Pnt(" << thePoint->x() << ", "
1096                  << thePoint->y() << ", " << thePoint->z() << ")";
1097   return *this;
1098 }
1099
1100 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const std::shared_ptr<GeomAPI_Dir>& theDir)
1101 {
1102   importModule("GeomAPI");
1103   *myDumpStorage << "GeomAPI_Dir(" << theDir->x() << ", "
1104                  << theDir->y() << ", " << theDir->z() << ")";
1105   return *this;
1106 }
1107
1108 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
1109     const std::shared_ptr<GeomDataAPI_Dir>& theDir)
1110 {
1111   *myDumpStorage << theDir->x() << ", " << theDir->y() << ", " << theDir->z();
1112   return *this;
1113 }
1114
1115 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
1116     const std::shared_ptr<GeomDataAPI_Point>& thePoint)
1117 {
1118   static const int aSize = 3;
1119   double aValues[aSize] = {thePoint->x(), thePoint->y(), thePoint->z()};
1120   std::string aTexts[aSize] = {thePoint->textX(), thePoint->textY(), thePoint->textZ()};
1121   myDumpStorage->dumpArray(aSize, aValues, aTexts);
1122   return *this;
1123 }
1124
1125 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
1126     const std::shared_ptr<GeomDataAPI_Point2D>& thePoint)
1127 {
1128   static const int aSize = 2;
1129   double aValues[aSize] = {thePoint->x(), thePoint->y()};
1130   std::string aTexts[aSize] = {thePoint->textX(), thePoint->textY()};
1131   myDumpStorage->dumpArray(aSize, aValues, aTexts);
1132   return *this;
1133 }
1134
1135 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
1136   const std::shared_ptr<GeomDataAPI_Point2DArray>& thePointArray)
1137 {
1138   static const int aThreshold = 4;
1139   static bool aDumpAsIs = false;
1140   static std::string aSeparator = "";
1141   // if number of elements in the list if greater than a threshold,
1142   // dump it in a separate line with specific name
1143   int aSize = thePointArray->size();
1144   if (aDumpAsIs || aSize <= aThreshold) {
1145     *myDumpStorage << "[";
1146     GeomPnt2dPtr aPoint = thePointArray->pnt(0);
1147     *myDumpStorage << "(" << aPoint->x() << ", " << aPoint->y() << ")";
1148     for (int anIndex = 1; anIndex < aSize; ++anIndex) {
1149       aPoint = thePointArray->pnt(anIndex);
1150       *myDumpStorage << "," << aSeparator << " (" << aPoint->x() << ", " << aPoint->y() << ")";
1151     }
1152     *myDumpStorage << aSeparator << "]";
1153   }
1154   else {
1155     // name of list
1156     FeaturePtr anOwner = ModelAPI_Feature::feature(thePointArray->owner());
1157     std::string aListName = name(anOwner) + "_" + thePointArray->id();
1158     // reserve dumped buffer and store list "as is"
1159     myDumpStorage->reserveBuffer();
1160     aDumpAsIs = true;
1161     aSeparator = std::string("\n") + std::string(aListName.size() + 3, ' ');
1162     *this << aListName << " = " << thePointArray << "\n";
1163     aDumpAsIs = false;
1164     aSeparator = "";
1165     // append reserved data to the end of the current buffer
1166     myDumpStorage->restoreReservedBuffer();
1167     *myDumpStorage << aListName;
1168   }
1169   return *this;
1170 }
1171
1172 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
1173     const std::shared_ptr<ModelAPI_AttributeBoolean>& theAttrBool)
1174 {
1175   *myDumpStorage << (theAttrBool->value() ? "True" : "False");
1176   return *this;
1177 }
1178
1179 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
1180     const std::shared_ptr<ModelAPI_AttributeInteger>& theAttrInt)
1181 {
1182   std::string aText = theAttrInt->text();
1183   if (aText.empty())
1184     *myDumpStorage << theAttrInt->value();
1185   else
1186     *myDumpStorage << "\"" << aText << "\"";
1187   return *this;
1188 }
1189
1190 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
1191     const std::shared_ptr<ModelAPI_AttributeIntArray>& theArray)
1192 {
1193   *myDumpStorage << "[";
1194   int aSize = theArray->size();
1195   if (aSize > 0) {
1196     *myDumpStorage << theArray->value(0);
1197     for (int anIndex = 1; anIndex < aSize; ++anIndex)
1198       *myDumpStorage << ", " << theArray->value(anIndex);
1199   }
1200   *myDumpStorage << "]";
1201   return *this;
1202 }
1203
1204 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
1205     const std::shared_ptr<ModelAPI_AttributeDouble>& theAttrReal)
1206 {
1207   std::string aText = theAttrReal->text();
1208   if (aText.empty())
1209     *myDumpStorage << theAttrReal->value();
1210   else
1211     *myDumpStorage << "\"" << aText << "\"";
1212   return *this;
1213 }
1214
1215 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
1216   const std::shared_ptr<ModelAPI_AttributeDoubleArray>& theArray)
1217 {
1218   *myDumpStorage << "[";
1219   int aSize = theArray->size();
1220   if (aSize > 0) {
1221     *myDumpStorage << theArray->value(0);
1222     for (int anIndex = 1; anIndex < aSize; ++anIndex)
1223       *myDumpStorage << ", " << theArray->value(anIndex);
1224   }
1225   *myDumpStorage << "]";
1226   return *this;
1227 }
1228
1229 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
1230     const std::shared_ptr<ModelAPI_AttributeString>& theAttrStr)
1231 {
1232   *myDumpStorage << "\"" << theAttrStr->value() << "\"";
1233   return *this;
1234 }
1235
1236 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const FolderPtr& theFolder)
1237 {
1238   *myDumpStorage << name(theFolder);
1239
1240   // add dumped folder to a stack
1241   if (!myNames[theFolder].myIsDumped &&
1242      (myEntitiesStack.empty() || myEntitiesStack.top().myEntity != theFolder))
1243     myEntitiesStack.push(LastDumpedEntity(theFolder, !myNames[theFolder].myIsDefault));
1244
1245   return *this;
1246 }
1247
1248 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const FeaturePtr& theEntity)
1249 {
1250   *myDumpStorage << name(theEntity);
1251
1252   if (!myNames[theEntity].myIsDumped) {
1253     bool isUserDefinedName = !myNames[theEntity].myIsDefault;
1254     // store results if they have user-defined names or colors
1255     std::list<ResultPtr> aResultsWithNameOrColor;
1256     std::list<ResultPtr> allRes;
1257     ModelAPI_Tools::allResults(theEntity, allRes);
1258     for(std::list<ResultPtr>::iterator aRes = allRes.begin(); aRes != allRes.end(); aRes++) {
1259       if(!myNames[*aRes].myIsDefault || !isDefaultColor(*aRes) ||
1260          !isDefaultDeflection(*aRes) || !isDefaultTransparency(*aRes))
1261         aResultsWithNameOrColor.push_back(*aRes);
1262     }
1263     // store just dumped entity to stack
1264     if (myEntitiesStack.empty() || myEntitiesStack.top().myEntity != theEntity)
1265       myEntitiesStack.push(
1266           LastDumpedEntity(theEntity, isUserDefinedName, aResultsWithNameOrColor));
1267   }
1268
1269   // remove entity from the list of not dumped items
1270   myNotDumpedEntities.erase(theEntity);
1271   return *this;
1272 }
1273
1274 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const ResultPtr& theResult)
1275 {
1276   // iterate in the structure of sub-results to the parent
1277   ResultPtr aCurRes = theResult;
1278   FeaturePtr aFeature = ModelAPI_Feature::feature(theResult);
1279   std::list<int> anIndices; // indexes of results in the parent result, starting from topmost
1280   while(aCurRes.get()) {
1281     ResultBodyPtr aParent = ModelAPI_Tools::bodyOwner(aCurRes);
1282     if (aParent) {
1283       anIndices.push_front(ModelAPI_Tools::bodyIndex(aCurRes));
1284     } else { // index of the result in the feature
1285       std::list<ResultPtr>::const_iterator aRes = aFeature->results().cbegin();
1286       for(int anIndex = 0; aRes != aFeature->results().cend(); aRes++, anIndex++) {
1287         if (*aRes == aCurRes) {
1288           anIndices.push_front(anIndex);
1289           break;
1290         }
1291       }
1292     }
1293     aCurRes = aParent;
1294   }
1295
1296   *myDumpStorage << name(aFeature);
1297   for (std::list<int>::iterator anI = anIndices.begin(); anI != anIndices.end(); anI++) {
1298     if (anI == anIndices.begin()) {
1299       if(*anI == 0) {
1300         *myDumpStorage << ".result()";
1301       }
1302       else {
1303         *myDumpStorage << ".results()[" << *anI << "]";
1304       }
1305     } else {
1306       *myDumpStorage << ".subResult(" << *anI << ")";
1307     }
1308   }
1309
1310   return *this;
1311 }
1312
1313 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const std::list<ResultPtr>& theResults)
1314 {
1315   *this << "[";
1316   for (std::list<ResultPtr>::const_iterator anIt = theResults.begin();
1317        anIt != theResults.end(); ++anIt) {
1318     if (anIt != theResults.begin())
1319       *this << ", ";
1320     *this << *anIt;
1321   }
1322   *this << "]";
1323   return *this;
1324 }
1325
1326 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const ObjectPtr& theObject)
1327 {
1328   FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(theObject);
1329   if(aFeature.get()) {
1330     *myDumpStorage << name(aFeature);
1331     return *this;
1332   }
1333
1334   ResultPtr aResult = std::dynamic_pointer_cast<ModelAPI_Result>(theObject);
1335   if(aResult.get()) {
1336     *this << aResult;
1337     return *this;
1338   }
1339
1340   return *this;
1341 }
1342
1343 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const AttributePtr& theAttr)
1344 {
1345   FeaturePtr anOwner = ModelAPI_Feature::feature(theAttr->owner());
1346
1347   std::string aWrapperPrefix, aWrapperSuffix;
1348   // Check the attribute belongs to copied (in multi-translation or multi-rotation) feature.
1349   // In this case we need to cast explicitly feature to appropriate type.
1350   AttributeBooleanPtr isCopy = anOwner->boolean("Copy");
1351   AttributeReferencePtr hasParent = anOwner->reference("ParentFeature");
1352   if ((isCopy.get() && isCopy->value()) || (hasParent && hasParent->value())) {
1353     aWrapperPrefix = featureWrapper(anOwner) + "(";
1354     aWrapperSuffix = ")";
1355     importModule("SketchAPI");
1356   }
1357
1358   *myDumpStorage << aWrapperPrefix << name(anOwner) << aWrapperSuffix
1359                  << "." << attributeGetter(anOwner, theAttr->id()) << "()";
1360   return *this;
1361 }
1362
1363 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
1364     const std::shared_ptr<ModelAPI_AttributeRefAttr>& theRefAttr)
1365 {
1366   if (theRefAttr->isObject())
1367     *this << theRefAttr->object();
1368   else
1369     *this << theRefAttr->attr();
1370   return *this;
1371 }
1372
1373 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
1374     const std::shared_ptr<ModelAPI_AttributeRefAttrList>& theRefAttrList)
1375 {
1376   *myDumpStorage << "[";
1377   std::list<std::pair<ObjectPtr, AttributePtr> > aList = theRefAttrList->list();
1378   bool isAdded = false;
1379   std::list<std::pair<ObjectPtr, AttributePtr> >::const_iterator anIt = aList.begin();
1380   for (; anIt != aList.end(); ++anIt) {
1381     if (isAdded)
1382       *myDumpStorage << ", ";
1383     else
1384       isAdded = true;
1385     if (anIt->first)
1386       *this << anIt->first;
1387     else if (anIt->second)
1388       * this << anIt->second;
1389   }
1390   *myDumpStorage << "]";
1391   return *this;
1392 }
1393
1394 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
1395     const std::shared_ptr<ModelAPI_AttributeReference>& theReference)
1396 {
1397   *this << theReference->value();
1398   return *this;
1399 }
1400
1401 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
1402     const std::shared_ptr<ModelAPI_AttributeRefList>& theRefList)
1403 {
1404   static const int aThreshold = 2;
1405   static bool aDumpAsIs = false;
1406   // if number of elements in the list if greater than a threshold,
1407   // dump it in a separate line with specific name
1408   if (aDumpAsIs || theRefList->size() <= aThreshold) {
1409     *myDumpStorage << "[";
1410     std::list<ObjectPtr> aList = theRefList->list();
1411     bool isAdded = false;
1412     std::list<ObjectPtr>::const_iterator anIt = aList.begin();
1413     for (; anIt != aList.end(); ++anIt) {
1414       if (isAdded)
1415         *myDumpStorage << ", ";
1416       else
1417         isAdded = true;
1418
1419       *this << *anIt;
1420     }
1421     *myDumpStorage << "]";
1422   } else {
1423     // name of list
1424     FeaturePtr anOwner = ModelAPI_Feature::feature(theRefList->owner());
1425     std::string aListName = name(anOwner) + "_objects";
1426     // reserve dumped buffer and store list "as is"
1427     myDumpStorage->reserveBuffer();
1428     aDumpAsIs = true;
1429     *this << aListName << " = " << theRefList << "\n";
1430     aDumpAsIs = false;
1431     // append reserved data to the end of the current buffer
1432     myDumpStorage->restoreReservedBuffer();
1433     *myDumpStorage << aListName;
1434   }
1435   return *this;
1436 }
1437
1438 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
1439     const std::shared_ptr<ModelAPI_AttributeSelection>& theAttrSelect)
1440 {
1441   myDumpStorage->write(theAttrSelect);
1442   return *this;
1443 }
1444
1445 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
1446     const std::shared_ptr<ModelAPI_AttributeSelectionList>& theAttrSelList)
1447 {
1448   static const int aThreshold = 2;
1449   static bool aDumpAsIs = false;
1450   // if number of elements in the list if greater than a threshold,
1451   // dump it in a separate line with specific name
1452   if (aDumpAsIs || theAttrSelList->size() <= aThreshold) {
1453     *myDumpStorage << "[";
1454
1455     GeomShapePtr aShape;
1456     std::string aShapeTypeStr;
1457
1458     bool isAdded = false;
1459
1460     for(int anIndex = 0; anIndex < theAttrSelList->size(); ++anIndex) {
1461       AttributeSelectionPtr anAttribute = theAttrSelList->value(anIndex);
1462       aShape = anAttribute->value();
1463       if(!aShape.get()) {
1464         ResultPtr aContext = anAttribute->context();
1465         if (aContext.get())
1466           aShape = aContext->shape();
1467       }
1468
1469       if(!aShape.get()) {
1470         continue;
1471       }
1472
1473       if(isAdded) {
1474         *myDumpStorage << ", ";
1475       } else {
1476         isAdded = true;
1477       }
1478       *this << anAttribute;
1479     }
1480
1481     // check selection list is obtained by filters
1482     FiltersFeaturePtr aFilters = theAttrSelList->filters();
1483     if (aFilters) {
1484       if (theAttrSelList->size() > 0)
1485         *myDumpStorage << ", ";
1486       dumpFeature(aFilters, true);
1487     }
1488
1489     *myDumpStorage << "]";
1490   } else {
1491     // obtain name of list (the feature may contain several selection lists)
1492     FeaturePtr anOwner = ModelAPI_Feature::feature(theAttrSelList->owner());
1493     std::string aListName = name(anOwner) + "_objects";
1494     std::list<AttributePtr> aSelLists =
1495         anOwner->data()->attributes(ModelAPI_AttributeSelectionList::typeId());
1496     if (aSelLists.size() > 1) {
1497       int anIndex = 1;
1498       for (std::list<AttributePtr>::iterator aSIt = aSelLists.begin();
1499            aSIt != aSelLists.end(); ++aSIt, ++anIndex)
1500         if ((*aSIt).get() == theAttrSelList.get())
1501           break;
1502       std::ostringstream aSStream;
1503       aSStream << aListName << "_" << anIndex;
1504       aListName = aSStream.str();
1505     }
1506     // reserve dumped buffer and store list "as is"
1507     myDumpStorage->reserveBuffer();
1508     aDumpAsIs = true;
1509     *this << aListName << " = " << theAttrSelList << "\n";
1510     aDumpAsIs = false;
1511     // append reserved data to the end of the current buffer
1512     myDumpStorage->restoreReservedBuffer();
1513     *myDumpStorage << aListName;
1514   }
1515   return *this;
1516 }
1517
1518 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
1519   const std::shared_ptr<ModelAPI_AttributeStringArray>& theArray)
1520 {
1521   std::ostringstream aBuffer;
1522   aBuffer << "[";
1523   for(int anIndex = 0; anIndex < theArray->size(); ++anIndex) {
1524     if (anIndex != 0)
1525       aBuffer << ", ";
1526
1527     aBuffer << "\"" << theArray->value(anIndex) << "\"";
1528   }
1529   aBuffer << "]";
1530
1531   myDumpStorage->write(aBuffer.str());
1532   return *this;
1533 }
1534
1535 /// Dump std::endl
1536 ModelHighAPI_Dumper& operator<<(ModelHighAPI_Dumper& theDumper,
1537                                 std::basic_ostream<char>& (*theEndl)(std::basic_ostream<char>&))
1538 {
1539   *theDumper.myDumpStorage << theEndl;
1540
1541   if (!theDumper.myEntitiesStack.empty()) {
1542     bool isCopy;
1543     // all copies have been stored into stack, pop them all
1544     do {
1545       isCopy = false;
1546       // Name for composite feature is dumped when all sub-entities are dumped
1547       // (see method ModelHighAPI_Dumper::processSubs).
1548       const ModelHighAPI_Dumper::LastDumpedEntity& aLastDumped = theDumper.myEntitiesStack.top();
1549       CompositeFeaturePtr aComposite =
1550           std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aLastDumped.myEntity);
1551       if (!aComposite) {
1552         theDumper.dumpEntitySetName();
1553         FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(aLastDumped.myEntity);
1554         if (aFeature) {
1555           AttributeBooleanPtr aCopyAttr = aFeature->boolean("Copy");
1556           isCopy = aCopyAttr.get() && aCopyAttr->value();
1557         }
1558       }
1559     } while (isCopy && !theDumper.myEntitiesStack.empty());
1560   }
1561
1562   // store all not-dumped entities first
1563   std::set<EntityPtr> aNotDumped = theDumper.myNotDumpedEntities;
1564   theDumper.myDumpStorage->reserveBuffer();
1565   std::set<EntityPtr>::const_iterator anIt = aNotDumped.begin();
1566   for (; anIt != aNotDumped.end(); ++anIt) {
1567     // if the feature is composite, dump it with all subs
1568     CompositeFeaturePtr aCompFeat =
1569         std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(*anIt);
1570     if (aCompFeat)
1571       theDumper.process(aCompFeat, true);
1572     else {
1573       FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(*anIt);
1574       theDumper.dumpFeature(aFeature, true);
1575       // dump the Projection feature which produces this "Copy" entity
1576       AttributeBooleanPtr aCopyAttr = aFeature->boolean("Copy");
1577       if (aCopyAttr.get() && aCopyAttr->value())
1578       {
1579         const std::set<AttributePtr>& aRefs = aFeature->data()->refsToMe();
1580         std::set<AttributePtr>::iterator aRefIt = aRefs.begin();
1581         for (; aRefIt != aRefs.end(); ++aRefIt)
1582           if ((*aRefIt)->id() == "ProjectedFeature")
1583           { // process projection only
1584             FeaturePtr anOwner = ModelAPI_Feature::feature((*aRefIt)->owner());
1585             if (anOwner && !theDumper.isDumped(EntityPtr(anOwner)))
1586               theDumper.dumpFeature(anOwner, true);
1587           }
1588       }
1589     }
1590   }
1591
1592   // then store the reserved data
1593   theDumper.myDumpStorage->restoreReservedBuffer();
1594   theDumper.myDumpStorage->mergeBuffer();
1595
1596   // now, store all postponed features
1597   theDumper.dumpPostponed();
1598
1599   return theDumper;
1600 }
1601
1602
1603 void ModelHighAPI_Dumper::exportVariables() const
1604 {
1605   DocumentPtr aRoot = ModelAPI_Session::get()->moduleDocument();
1606   EntityNameMap::const_iterator aNameIter = myNames.cbegin();
1607   for(; aNameIter != myNames.end(); aNameIter++) {
1608     FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(aNameIter->first);
1609     if (aFeature.get() && aFeature->document() != aRoot) {
1610       FeaturePtr aPartFeat = ModelAPI_Tools::findPartFeature(aRoot, aFeature->document());
1611       if (aPartFeat.get()) {
1612         int aFeatureId = aFeature->data()->featureId();
1613         int aPartId = aPartFeat->data()->featureId();
1614         std::ostringstream anEntryStr;
1615         anEntryStr<<aPartId<<":"<<aFeatureId;
1616         std::string anEntry = anEntryStr.str();
1617         exportVariable(anEntry, aNameIter->second.myCurrentName);
1618         size_t aSize = aFeature->results().size();
1619         if (aSize > 1) { // additional entries for features with more than one result
1620           for(size_t a = 1; a < aSize; a++) {
1621             std::ostringstream aResEntryStr;
1622             aResEntryStr<<anEntry<<":"<<a;
1623             std::string aResEntry = aResEntryStr.str();
1624             exportVariable(aResEntry, aNameIter->second.myCurrentName);
1625           }
1626         }
1627       }
1628     }
1629   }
1630 }