src/ModelHighAPI/ModelHighAPI_Dumper.cpp

   1 // Copyright (C) 2014-2019  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     //TODO: vsv 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       //TODO: vsv 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                                              bool theSetIsDumped)
 574 {
 575   EntityNameMap::iterator aFound = myNames.find(theEntity);
 576   if (aFound != myNames.end()) {
 577     // Set dumped flag for postponed constraints which are without names
 578     if (!aFound->second.myIsDumped)
 579       aFound->second.myIsDumped = theSetIsDumped;
 580     return aFound->second.myCurrentName;
 581   }
 582   // entity is not found, store it
 583   std::string aName;
 584   std::string aKind;
 585   bool isDefaultName = false;
 586   bool isSaveNotDumped = theSaveNotDumped;
 587   std::ostringstream aDefaultName;
 588   FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(theEntity);
 589   if (aFeature) {
 590     aName = ModelAPI_Tools::toString(aFeature->name());
 591     aKind = aFeature->getKind();
 592   } else {
 593     FolderPtr aFolder = std::dynamic_pointer_cast<ModelAPI_Folder>(theEntity);
 594     if (aFolder) {
 595       aName = ModelAPI_Tools::toString(aFolder->data()->name());
 596       aKind = ModelAPI_Folder::ID();
 597       isSaveNotDumped = false;
 598     }
 599   }
 600
 601   ObjectPtr anObject = std::dynamic_pointer_cast<ModelAPI_Object>(theEntity);
 602   if (anObject) {
 603     DocumentPtr aDoc = anObject->document();
 604     std::pair<int, int>& aNbFeatures = myFeatureCount[aDoc][aKind];
 605     aNbFeatures.first += 1;
 606
 607     size_t anIndex = aName.find(aKind);
 608     if (anIndex == 0 && aName[aKind.length()] == '_') { // name starts with "FeatureKind_"
 609       std::string anIdStr = aName.substr(aKind.length() + 1);
 610       int anId = toInt(anIdStr);
 611
 612       // Check number of already registered objects of such kind. Index of current object
 613       // should be the same to identify feature's name as automatically generated.
 614       if (aNbFeatures.first == anId && aNbFeatures.second < anId) {
 615         // name is not user-defined
 616         isDefaultName = true;
 617
 618         // check there are postponed features of this kind,
 619         // dump their names, because the sequence of features may be changed
 620         for (std::list<EntityPtr>::const_iterator aPpIt = myPostponed.begin();
 621             aPpIt != myPostponed.end(); ++aPpIt) {
 622           FeaturePtr aCurFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(*aPpIt);
 623           if (aCurFeature && aCurFeature->getKind() == aKind) {
 624             myNames[*aPpIt].myIsDefault = false;
 625             isDefaultName = false;
 626           }
 627         }
 628       }
 629
 630       if (anId > aNbFeatures.second)
 631         aNbFeatures.second = anId;
 632     }
 633
 634     // obtain default name for the feature
 635     if (theUseEntityName)
 636       aDefaultName << aName;
 637     else {
 638       int aFullIndex = 0;
 639       NbFeaturesMap::const_iterator aFIt = myFeatureCount.begin();
 640       for (; aFIt != myFeatureCount.end(); ++aFIt) {
 641         std::map<std::string, std::pair<int, int> >::const_iterator aFound =
 642           aFIt->second.find(aKind);
 643         if (aFound != aFIt->second.end())
 644           aFullIndex += aFound->second.first;
 645       }
 646       aDefaultName << aKind << "_" << aFullIndex;
 647     }
 648   }
 649
 650   myNames[theEntity] = EntityName(aDefaultName.str(), aName, isDefaultName);
 651   if (isSaveNotDumped)
 652     myNotDumpedEntities.insert(theEntity);
 653
 654   // store names of results
 655   if (aFeature)
 656     saveResultNames(aFeature);
 657
 658   myNames[theEntity].myIsDumped = theSetIsDumped;
 659
 660   return myNames[theEntity].myCurrentName;
 661 }
 662
 663 const std::string& ModelHighAPI_Dumper::parentName(const FeaturePtr& theEntity)
 664 {
 665   const std::set<AttributePtr>& aRefs = theEntity->data()->refsToMe();
 666   std::set<AttributePtr>::const_iterator aRefIt = aRefs.begin();
 667   for (; aRefIt != aRefs.end(); ++aRefIt) {
 668     CompositeFeaturePtr anOwner = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(
 669         ModelAPI_Feature::feature((*aRefIt)->owner()));
 670     if (anOwner)
 671       return name(anOwner);
 672   }
 673
 674   static const std::string DUMMY;
 675   return DUMMY;
 676 }
 677
 678 void ModelHighAPI_Dumper::saveResultNames(const FeaturePtr& theFeature)
 679 {
 680   // Default name of the feature
 681   bool isFeatureDefaultName = myNames[theFeature].myIsDefault;
 682
 683   // Save only names of results which is not correspond to default feature name
 684   const std::list<ResultPtr>& aResults = theFeature->results();
 685   std::list<ResultPtr> allRes;
 686   ModelAPI_Tools::allResults(theFeature, allRes);
 687   for(std::list<ResultPtr>::iterator aRes = allRes.begin(); aRes != allRes.end(); aRes++) {
 688     std::pair<std::wstring, bool> aName = ModelAPI_Tools::getDefaultName(*aRes);
 689     std::string aDefaultName = ModelAPI_Tools::toString(aName.first);
 690     std::string aResName = ModelAPI_Tools::toString((*aRes)->data()->name());
 691     bool isUserDefined = !(isFeatureDefaultName && aDefaultName == aResName);
 692     myNames[*aRes] =
 693       EntityName(aResName, (isUserDefined ? aResName : std::string()), !isUserDefined);
 694   }
 695 }
 696
 697 bool ModelHighAPI_Dumper::process(const std::shared_ptr<ModelAPI_Document>& theDoc,
 698                                   const std::string& theFileName)
 699 {
 700   // dump top level document feature
 701   static const std::string aDocName("partSet");
 702   myNames[theDoc] = EntityName(aDocName, std::string(), true);
 703   *this << aDocName << " = model.moduleDocument()" << std::endl;
 704
 705   // dump subfeatures and store result to file
 706   bool isOk = process(theDoc) && myDumpStorage->exportTo(theFileName, myModules);
 707   return isOk;
 708 }
 709
 710 bool ModelHighAPI_Dumper::process(const std::shared_ptr<ModelAPI_Document>& theDoc)
 711 {
 712   bool isOk = true;
 713   std::list<ObjectPtr> anObjects = theDoc->allObjects();
 714   std::list<ObjectPtr>::const_iterator anObjIt = anObjects.begin();
 715   // firstly, dump all parameters
 716   for (; anObjIt != anObjects.end(); ++ anObjIt) {
 717     FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(*anObjIt);
 718     if (aFeature)
 719       dumpParameter(aFeature);
 720   }
 721   // dump all other features
 722   for (anObjIt = anObjects.begin(); anObjIt != anObjects.end(); ++anObjIt) {
 723     CompositeFeaturePtr aCompFeat = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(*anObjIt);
 724     if (aCompFeat) {
 725       // iteratively process composite features,
 726       // if the composite feature is the last in the document, no need to dump "model.do()" action
 727       std::list<ObjectPtr>::const_iterator aNext = anObjIt;
 728       isOk = process(aCompFeat, false, ++aNext != anObjects.end()) && isOk;
 729     }
 730     else if (!isDumped(EntityPtr(*anObjIt))) {
 731       // dump folder
 732       FolderPtr aFolder = std::dynamic_pointer_cast<ModelAPI_Folder>(*anObjIt);
 733       if (aFolder)
 734         dumpFolder(aFolder);
 735       else {
 736         FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(*anObjIt);
 737         if (aFeature) // dump common feature
 738           dumpFeature(aFeature);
 739       }
 740     }
 741   }
 742   // dump folders if any
 743   dumpPostponed(true);
 744   return isOk;
 745 }
 746
 747 bool ModelHighAPI_Dumper::process(const std::shared_ptr<ModelAPI_CompositeFeature>& theComposite,
 748                                   bool isForce, bool isDumpModelDo)
 749 {
 750   // increase composite features stack
 751   ++gCompositeStackDepth;
 752   // dump composite itself
 753   if (!isDumped(EntityPtr(theComposite)) || isForce)
 754     dumpFeature(FeaturePtr(theComposite), isForce);
 755
 756   // sub-part is processed independently, because it provides separate document
 757   if (theComposite->getKind() == PartSetPlugin_Part::ID()) {
 758     // dump name of the part if it is different from default
 759     if (!myEntitiesStack.empty())
 760       dumpEntitySetName();
 761
 762     // decrease composite features stack because we run into separate document
 763     --gCompositeStackDepth;
 764
 765     ResultPartPtr aPartResult =
 766         std::dynamic_pointer_cast<ModelAPI_ResultPart>(theComposite->lastResult());
 767     if (!aPartResult)
 768       return false;
 769     DocumentPtr aSubDoc = aPartResult->partDoc();
 770     if (!aSubDoc)
 771       return false;
 772     // set name of document
 773     const std::string& aPartName = myNames[theComposite].myCurrentName;
 774     std::string aDocName = aPartName + "_doc";
 775     myNames[aSubDoc] = EntityName(aDocName, std::string(), true);
 776
 777     // dump document in a separate line
 778     *this << aDocName << " = " << aPartName << ".document()" << std::endl;
 779     // dump features in the document
 780     bool aRes = process(aSubDoc);
 781     if (isDumpModelDo)
 782       *this << "\nmodel.do()\n";
 783     *this << std::endl;
 784     return aRes;
 785   }
 786
 787   // dump sub-features
 788   bool isOk = processSubs(theComposite);
 789   // decrease composite features stack
 790   --gCompositeStackDepth;
 791
 792   return isOk;
 793 }
 794
 795 bool ModelHighAPI_Dumper::processSubs(
 796   const std::shared_ptr<ModelAPI_CompositeFeature>& theComposite,
 797   bool theDumpModelDo)
 798 {
 799   bool isOk = true;
 800   // dump all sub-features;
 801   bool isSubDumped = false;
 802   int aNbSubs = theComposite->numberOfSubs();
 803   for (int anIndex = 0; anIndex < aNbSubs; ++anIndex) {
 804     FeaturePtr aFeature = theComposite->subFeature(anIndex);
 805     if (isDumped(EntityPtr(aFeature)))
 806       continue;
 807
 808     isSubDumped = true;
 809     CompositeFeaturePtr aCompFeat = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aFeature);
 810     if (aCompFeat) // iteratively process composite features
 811       isOk = process(aCompFeat) && isOk;
 812     else
 813       dumpFeature(aFeature, true);
 814   }
 815
 816   bool isDumpSetName = !myEntitiesStack.empty() &&
 817       myEntitiesStack.top().myEntity == EntityPtr(theComposite);
 818   bool isForceModelDo = isSubDumped && isDumpSetName &&
 819       (myEntitiesStack.top().myUserName || !myEntitiesStack.top().myResults.empty());
 820   // It is necessary for the sketch to create its result when complete (command "model.do()").
 821   // This option is set by flat theDumpModelDo.
 822   // However, nested sketches are rebuilt by parent feature, so, they do not need
 823   // explicit call of "model.do()". This will be controlled by the depth of the stack.
 824   if (isForceModelDo || (theDumpModelDo && gCompositeStackDepth <= 1))
 825     *this << "model.do()" << std::endl;
 826
 827   // dump "setName" for composite feature
 828   if (isDumpSetName)
 829     dumpEntitySetName();
 830   return isOk;
 831 }
 832
 833 void ModelHighAPI_Dumper::postpone(const EntityPtr& theEntity)
 834 {
 835   // keep the name
 836   name(theEntity, false);
 837   myPostponed.push_back(theEntity);
 838 }
 839
 840 void ModelHighAPI_Dumper::dumpPostponed(bool theDumpFolders)
 841 {
 842   if (myDumpPostponedInProgress)
 843     return;
 844
 845   myDumpPostponedInProgress = true;
 846   // make a copy of postponed entities, because the list will be updated
 847   // if some features are not able to be dumped
 848   std::list<EntityPtr> aPostponedCopy = myPostponed;
 849   myPostponed.clear();
 850
 851   // iterate over postponed entities and try to dump them
 852   std::list<EntityPtr>::const_iterator anIt = aPostponedCopy.begin();
 853   for (; anIt != aPostponedCopy.end(); ++anIt) {
 854     FolderPtr aFolder = std::dynamic_pointer_cast<ModelAPI_Folder>(*anIt);
 855     if (aFolder) {
 856       if (theDumpFolders)
 857         dumpFolder(aFolder);
 858       else
 859         myPostponed.push_back(*anIt);
 860     }
 861     else {
 862       FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(*anIt);
 863       if (aFeature)
 864         dumpFeature(aFeature, true);
 865     }
 866   }
 867   myDumpPostponedInProgress = false;
 868 }
 869
 870 void ModelHighAPI_Dumper::dumpSubFeatureNameAndColor(const std::string theSubFeatureGet,
 871                                                      const FeaturePtr& theSubFeature)
 872 {
 873   name(theSubFeature, false);
 874   myNames[theSubFeature] =
 875     EntityName(theSubFeatureGet, ModelAPI_Tools::toString(theSubFeature->name()), false);
 876
 877   // store results if they have user-defined names or colors
 878   std::list<ResultPtr> aResultsWithNameOrColor;
 879   const std::list<ResultPtr>& aResults = theSubFeature->results();
 880   std::list<ResultPtr>::const_iterator aResIt = aResults.begin();
 881   for (; aResIt != aResults.end(); ++aResIt) {
 882     std::string aResName = ModelAPI_Tools::toString((*aResIt)->data()->name());
 883     myNames[*aResIt] = EntityName(aResName, aResName, false);
 884     aResultsWithNameOrColor.push_back(*aResIt);
 885   }
 886
 887   // store just dumped entity to stack
 888   myEntitiesStack.push(LastDumpedEntity(theSubFeature, true, aResultsWithNameOrColor));
 889
 890   dumpEntitySetName();
 891 }
 892
 893 void ModelHighAPI_Dumper::importModule(const std::string& theModuleName)
 894 {
 895   myModules.insert(theModuleName);
 896 }
 897
 898 void ModelHighAPI_Dumper::dumpEntitySetName()
 899 {
 900   const LastDumpedEntity& aLastDumped = myEntitiesStack.top();
 901   bool isBufferEmpty = myDumpStorage->isBufferEmpty();
 902
 903   // dump "setName" for the entity
 904   if (aLastDumped.myUserName) {
 905     EntityName& anEntityNames = myNames[aLastDumped.myEntity];
 906     if (!anEntityNames.myIsDefault)
 907       *myDumpStorage << anEntityNames.myCurrentName << ".setName(\""
 908                      << anEntityNames.myUserName << "\")\n";
 909     // don't dump "setName" for the entity twice
 910     anEntityNames.myUserName.clear();
 911     anEntityNames.myIsDefault = true;
 912   }
 913   // dump "setName" for results
 914   std::list<ResultPtr>::const_iterator aResIt = aLastDumped.myResults.begin();
 915   std::list<ResultPtr>::const_iterator aResEnd = aLastDumped.myResults.end();
 916   for (; aResIt != aResEnd; ++aResIt) {
 917     // set result name
 918     EntityName& anEntityNames = myNames[*aResIt];
 919     if (!anEntityNames.myIsDefault) {
 920       *this << *aResIt;
 921       *myDumpStorage << ".setName(\"" << anEntityNames.myUserName << "\")\n";
 922       // don't dump "setName" for the entity twice
 923       anEntityNames.myUserName.clear();
 924       anEntityNames.myIsDefault = true;
 925     }
 926     // set result color
 927     if (!isDefaultColor(*aResIt)) {
 928       AttributeIntArrayPtr aColor = (*aResIt)->data()->intArray(ModelAPI_Result::COLOR_ID());
 929       if (aColor && aColor->isInitialized()) {
 930         *this << *aResIt;
 931         *myDumpStorage << ".setColor(" << aColor->value(0) << ", " << aColor->value(1)
 932                        << ", " << aColor->value(2) << ")\n";
 933       }
 934     }
 935     // set result deflection
 936     if (!isDefaultDeflection(*aResIt)) {
 937       AttributeDoublePtr aDeflectionAttr =
 938         (*aResIt)->data()->real(ModelAPI_Result::DEFLECTION_ID());
 939       if(aDeflectionAttr.get() && aDeflectionAttr->isInitialized()) {
 940         *this << *aResIt;
 941         *myDumpStorage << ".setDeflection(" << aDeflectionAttr->value() << ")\n";
 942       }
 943     }
 944     // set result transparency
 945     if (!isDefaultTransparency(*aResIt)) {
 946       AttributeDoublePtr aTransparencyAttr =
 947         (*aResIt)->data()->real(ModelAPI_Result::TRANSPARENCY_ID());
 948       if(aTransparencyAttr.get() && aTransparencyAttr->isInitialized()) {
 949         *this << *aResIt;
 950         *myDumpStorage << ".setTransparency(" << aTransparencyAttr->value() << ")\n";
 951       }
 952     }
 953   }
 954
 955   myNames[aLastDumped.myEntity].myIsDumped = true;
 956   myEntitiesStack.pop();
 957
 958   // clean buffer if it was clear before
 959   if (isBufferEmpty)
 960     myDumpStorage->mergeBuffer();
 961 }
 962
 963 bool ModelHighAPI_Dumper::isDumped(const EntityPtr& theEntity) const
 964 {
 965   EntityNameMap::const_iterator aFound = myNames.find(theEntity);
 966   FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(theEntity);
 967   return (aFound != myNames.end() && aFound->second.myIsDumped) ||
 968          myFeaturesToSkip.find(aFeature) != myFeaturesToSkip.end();
 969 }
 970
 971 bool ModelHighAPI_Dumper::isDumped(const AttributeRefAttrPtr& theRefAttr) const
 972 {
 973   FeaturePtr aFeature;
 974   if (theRefAttr->isObject())
 975     aFeature = ModelAPI_Feature::feature(theRefAttr->object());
 976   else
 977     aFeature = ModelAPI_Feature::feature(theRefAttr->attr()->owner());
 978   return aFeature && isDumped(EntityPtr(aFeature));
 979 }
 980
 981 bool ModelHighAPI_Dumper::isDumped(const AttributeRefListPtr& theRefList) const
 982 {
 983   std::list<ObjectPtr> aRefs = theRefList->list();
 984   std::list<ObjectPtr>::iterator anIt = aRefs.begin();
 985   for (; anIt != aRefs.end(); ++anIt) {
 986     FeaturePtr aFeature = ModelAPI_Feature::feature(*anIt);
 987     if (aFeature && !isDumped(EntityPtr(aFeature)))
 988       return false;
 989   }
 990   return true;
 991 }
 992
 993 static bool isSketchSub(const FeaturePtr& theFeature)
 994 {
 995   static const std::string SKETCH("Sketch");
 996   CompositeFeaturePtr anOwner = ModelAPI_Tools::compositeOwner(theFeature);
 997   return anOwner && anOwner->getKind() == SKETCH;
 998 }
 999
1000 bool ModelHighAPI_Dumper::isDefaultColor(const ResultPtr& theResult) const
1001 {
1002   AttributeIntArrayPtr aColor = theResult->data()->intArray(ModelAPI_Result::COLOR_ID());
1003   if (!aColor || !aColor->isInitialized())
1004     return true;
1005
1006   // check the result belongs to sketch entity, do not dump color in this way
1007   ResultConstructionPtr aResConstr =
1008       std::dynamic_pointer_cast<ModelAPI_ResultConstruction>(theResult);
1009   if (aResConstr) {
1010     FeaturePtr aFeature = ModelAPI_Feature::feature(theResult->data()->owner());
1011     if (isSketchSub(aFeature))
1012       return true;
1013   }
1014
1015   std::string aSection, aName, aDefault;
1016   theResult->colorConfigInfo(aSection, aName, aDefault);
1017
1018   // dump current color
1019   std::ostringstream aColorInfo;
1020   aColorInfo << aColor->value(0) << "," << aColor->value(1) << "," << aColor->value(2);
1021
1022   return aDefault == aColorInfo.str();
1023 }
1024
1025 bool ModelHighAPI_Dumper::isDefaultDeflection(const ResultPtr& theResult) const
1026 {
1027   AttributeDoublePtr aDeflectionAttr = theResult->data()->real(ModelAPI_Result::DEFLECTION_ID());
1028   if(!aDeflectionAttr || !aDeflectionAttr->isInitialized()) {
1029     return true;
1030   }
1031
1032   double aCurrent = aDeflectionAttr->value();
1033   double aDefault = -1;
1034
1035   bool isConstruction = false;
1036   std::string aResultGroup = theResult->groupName();
1037   if (aResultGroup == ModelAPI_ResultConstruction::group())
1038     isConstruction = true;
1039   else if (aResultGroup == ModelAPI_ResultBody::group()) {
1040     GeomShapePtr aGeomShape = theResult->shape();
1041     if (aGeomShape.get()) {
1042       // if the shape could not be exploded on faces, it contains only wires, edges, and vertices
1043       // correction of deviation for them should not influence to the application performance
1044       GeomAPI_ShapeExplorer anExp(aGeomShape, GeomAPI_Shape::FACE);
1045       isConstruction = !anExp.more();
1046     }
1047   }
1048   if (isConstruction)
1049     aDefault = Config_PropManager::real("Visualization", "construction_deflection");
1050   else
1051     aDefault = Config_PropManager::real("Visualization", "body_deflection");
1052
1053   return fabs(aCurrent - aDefault) < 1.e-12;
1054 }
1055
1056 bool ModelHighAPI_Dumper::isDefaultTransparency(const ResultPtr& theResult) const
1057 {
1058   AttributeDoublePtr anAttribute = theResult->data()->real(ModelAPI_Result::TRANSPARENCY_ID());
1059   if(!anAttribute || !anAttribute->isInitialized()) {
1060     return true;
1061   }
1062   return fabs(anAttribute->value()) < 1.e-12;
1063 }
1064
1065 bool ModelHighAPI_Dumper::dumpCommentBeforeFeature(const FeaturePtr& theFeature) const
1066 {
1067   // currently, the comment should not be dumped only before the filters
1068   FiltersFeaturePtr aFilters = std::dynamic_pointer_cast<ModelAPI_FiltersFeature>(theFeature);
1069   if (aFilters)
1070     return false;
1071   // all other features should be commented before the dump
1072   return true;
1073 }
1074
1075 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const char theChar)
1076 {
1077   *myDumpStorage << theChar;
1078   return *this;
1079 }
1080
1081 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const char* theString)
1082 {
1083   *myDumpStorage << theString;
1084   return *this;
1085 }
1086
1087 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const std::string& theString)
1088 {
1089   *myDumpStorage << theString;
1090   return *this;
1091 }
1092
1093 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const std::wstring& theString)
1094 {
1095   *myDumpStorage << ModelAPI_Tools::toString(theString);
1096   return *this;
1097 }
1098
1099 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const bool theValue)
1100 {
1101   *myDumpStorage << (theValue ? "True" : "False");
1102   return *this;
1103 }
1104
1105 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const int theValue)
1106 {
1107   *myDumpStorage << theValue;
1108   return *this;
1109 }
1110
1111 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const double theValue)
1112 {
1113   *myDumpStorage << theValue;
1114   return *this;
1115 }
1116
1117 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const std::shared_ptr<GeomAPI_Pnt>& thePoint)
1118 {
1119   importModule("GeomAPI");
1120   *myDumpStorage << "GeomAPI_Pnt(" << thePoint->x() << ", "
1121                  << thePoint->y() << ", " << thePoint->z() << ")";
1122   return *this;
1123 }
1124
1125 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const std::shared_ptr<GeomAPI_Dir>& theDir)
1126 {
1127   importModule("GeomAPI");
1128   *myDumpStorage << "GeomAPI_Dir(" << theDir->x() << ", "
1129                  << theDir->y() << ", " << theDir->z() << ")";
1130   return *this;
1131 }
1132
1133 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
1134     const std::shared_ptr<GeomDataAPI_Dir>& theDir)
1135 {
1136   *myDumpStorage << theDir->x() << ", " << theDir->y() << ", " << theDir->z();
1137   return *this;
1138 }
1139
1140 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
1141     const std::shared_ptr<GeomDataAPI_Point>& thePoint)
1142 {
1143   static const int aSize = 3;
1144   double aValues[aSize] = {thePoint->x(), thePoint->y(), thePoint->z()};
1145   std::string aTexts[aSize] = {thePoint->textX(), thePoint->textY(), thePoint->textZ()};
1146   myDumpStorage->dumpArray(aSize, aValues, aTexts);
1147   return *this;
1148 }
1149
1150 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
1151     const std::shared_ptr<GeomDataAPI_Point2D>& thePoint)
1152 {
1153   static const int aSize = 2;
1154   double aValues[aSize] = {thePoint->x(), thePoint->y()};
1155   std::string aTexts[aSize] = {thePoint->textX(), thePoint->textY()};
1156   myDumpStorage->dumpArray(aSize, aValues, aTexts);
1157   return *this;
1158 }
1159
1160 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
1161   const std::shared_ptr<GeomDataAPI_Point2DArray>& thePointArray)
1162 {
1163   static const int aThreshold = 4;
1164   static bool aDumpAsIs = false;
1165   static std::string aSeparator = "";
1166   // if number of elements in the list if greater than a threshold,
1167   // dump it in a separate line with specific name
1168   int aSize = thePointArray->size();
1169   if (aDumpAsIs || aSize <= aThreshold) {
1170     *myDumpStorage << "[";
1171     GeomPnt2dPtr aPoint = thePointArray->pnt(0);
1172     *myDumpStorage << "(" << aPoint->x() << ", " << aPoint->y() << ")";
1173     for (int anIndex = 1; anIndex < aSize; ++anIndex) {
1174       aPoint = thePointArray->pnt(anIndex);
1175       *myDumpStorage << "," << aSeparator << " (" << aPoint->x() << ", " << aPoint->y() << ")";
1176     }
1177     *myDumpStorage << aSeparator << "]";
1178   }
1179   else {
1180     // name of list
1181     FeaturePtr anOwner = ModelAPI_Feature::feature(thePointArray->owner());
1182     std::string aListName = name(anOwner) + "_" + thePointArray->id();
1183     // reserve dumped buffer and store list "as is"
1184     myDumpStorage->reserveBuffer();
1185     aDumpAsIs = true;
1186     aSeparator = std::string("\n") + std::string(aListName.size() + 3, ' ');
1187     *this << aListName << " = " << thePointArray << "\n";
1188     aDumpAsIs = false;
1189     aSeparator = "";
1190     // append reserved data to the end of the current buffer
1191     myDumpStorage->restoreReservedBuffer();
1192     *myDumpStorage << aListName;
1193   }
1194   return *this;
1195 }
1196
1197 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
1198     const std::shared_ptr<ModelAPI_AttributeBoolean>& theAttrBool)
1199 {
1200   *myDumpStorage << (theAttrBool->value() ? "True" : "False");
1201   return *this;
1202 }
1203
1204 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
1205     const std::shared_ptr<ModelAPI_AttributeInteger>& theAttrInt)
1206 {
1207   std::string aText = theAttrInt->text();
1208   if (aText.empty())
1209     *myDumpStorage << theAttrInt->value();
1210   else
1211     *myDumpStorage << "\"" << aText << "\"";
1212   return *this;
1213 }
1214
1215 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
1216     const std::shared_ptr<ModelAPI_AttributeIntArray>& 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_AttributeDouble>& theAttrReal)
1231 {
1232   std::string aText = theAttrReal->text();
1233   if (aText.empty())
1234     *myDumpStorage << theAttrReal->value();
1235   else
1236     *myDumpStorage << "\"" << aText << "\"";
1237   return *this;
1238 }
1239
1240 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
1241   const std::shared_ptr<ModelAPI_AttributeDoubleArray>& theArray)
1242 {
1243   *myDumpStorage << "[";
1244   int aSize = theArray->size();
1245   if (aSize > 0) {
1246     *myDumpStorage << theArray->value(0);
1247     for (int anIndex = 1; anIndex < aSize; ++anIndex)
1248       *myDumpStorage << ", " << theArray->value(anIndex);
1249   }
1250   *myDumpStorage << "]";
1251   return *this;
1252 }
1253
1254 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
1255     const std::shared_ptr<ModelAPI_AttributeString>& theAttrStr)
1256 {
1257   *myDumpStorage << "\"" << theAttrStr->value() << "\"";
1258   return *this;
1259 }
1260
1261 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const FolderPtr& theFolder)
1262 {
1263   *myDumpStorage << name(theFolder);
1264
1265   // add dumped folder to a stack
1266   if (!myNames[theFolder].myIsDumped &&
1267      (myEntitiesStack.empty() || myEntitiesStack.top().myEntity != theFolder))
1268     myEntitiesStack.push(LastDumpedEntity(theFolder, !myNames[theFolder].myIsDefault));
1269
1270   return *this;
1271 }
1272
1273 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const FeaturePtr& theEntity)
1274 {
1275   *myDumpStorage << name(theEntity);
1276
1277   if (!myNames[theEntity].myIsDumped) {
1278     bool isUserDefinedName = !myNames[theEntity].myIsDefault;
1279     // store results if they have user-defined names or colors
1280     std::list<ResultPtr> aResultsWithNameOrColor;
1281     std::list<ResultPtr> allRes;
1282     ModelAPI_Tools::allResults(theEntity, allRes);
1283     for(std::list<ResultPtr>::iterator aRes = allRes.begin(); aRes != allRes.end(); aRes++) {
1284       if(!myNames[*aRes].myIsDefault || !isDefaultColor(*aRes) ||
1285          !isDefaultDeflection(*aRes) || !isDefaultTransparency(*aRes))
1286         aResultsWithNameOrColor.push_back(*aRes);
1287     }
1288     // store just dumped entity to stack
1289     if (myEntitiesStack.empty() || myEntitiesStack.top().myEntity != theEntity)
1290       myEntitiesStack.push(
1291           LastDumpedEntity(theEntity, isUserDefinedName, aResultsWithNameOrColor));
1292   }
1293
1294   // remove entity from the list of not dumped items
1295   myNotDumpedEntities.erase(theEntity);
1296   return *this;
1297 }
1298
1299 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const ResultPtr& theResult)
1300 {
1301   // iterate in the structure of sub-results to the parent
1302   ResultPtr aCurRes = theResult;
1303   FeaturePtr aFeature = ModelAPI_Feature::feature(theResult);
1304   std::list<int> anIndices; // indexes of results in the parent result, starting from topmost
1305   while(aCurRes.get()) {
1306     ResultBodyPtr aParent = ModelAPI_Tools::bodyOwner(aCurRes);
1307     if (aParent) {
1308       anIndices.push_front(ModelAPI_Tools::bodyIndex(aCurRes));
1309     } else { // index of the result in the feature
1310       std::list<ResultPtr>::const_iterator aRes = aFeature->results().cbegin();
1311       for(int anIndex = 0; aRes != aFeature->results().cend(); aRes++, anIndex++) {
1312         if (*aRes == aCurRes) {
1313           anIndices.push_front(anIndex);
1314           break;
1315         }
1316       }
1317     }
1318     aCurRes = aParent;
1319   }
1320
1321   *myDumpStorage << name(aFeature);
1322   for (std::list<int>::iterator anI = anIndices.begin(); anI != anIndices.end(); anI++) {
1323     if (anI == anIndices.begin()) {
1324       if(*anI == 0) {
1325         *myDumpStorage << ".result()";
1326       }
1327       else {
1328         *myDumpStorage << ".results()[" << *anI << "]";
1329       }
1330     } else {
1331       *myDumpStorage << ".subResult(" << *anI << ")";
1332     }
1333   }
1334
1335   return *this;
1336 }
1337
1338 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const std::list<ResultPtr>& theResults)
1339 {
1340   *this << "[";
1341   for (std::list<ResultPtr>::const_iterator anIt = theResults.begin();
1342        anIt != theResults.end(); ++anIt) {
1343     if (anIt != theResults.begin())
1344       *this << ", ";
1345     *this << *anIt;
1346   }
1347   *this << "]";
1348   return *this;
1349 }
1350
1351 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const ObjectPtr& theObject)
1352 {
1353   FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(theObject);
1354   if(aFeature.get()) {
1355     *myDumpStorage << name(aFeature);
1356     return *this;
1357   }
1358
1359   ResultPtr aResult = std::dynamic_pointer_cast<ModelAPI_Result>(theObject);
1360   if(aResult.get()) {
1361     *this << aResult;
1362     return *this;
1363   }
1364
1365   return *this;
1366 }
1367
1368 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const AttributePtr& theAttr)
1369 {
1370   FeaturePtr anOwner = ModelAPI_Feature::feature(theAttr->owner());
1371
1372   std::string aWrapperPrefix, aWrapperSuffix;
1373   // Check the attribute belongs to copied (in multi-translation or multi-rotation) feature.
1374   // In this case we need to cast explicitly feature to appropriate type.
1375   AttributeBooleanPtr isCopy = anOwner->boolean("Copy");
1376   AttributeReferencePtr hasParent = anOwner->reference("ParentFeature");
1377   if ((isCopy.get() && isCopy->value()) || (hasParent && hasParent->value())) {
1378     aWrapperPrefix = featureWrapper(anOwner) + "(";
1379     aWrapperSuffix = ")";
1380     importModule("SketchAPI");
1381   }
1382
1383   *myDumpStorage << aWrapperPrefix << name(anOwner) << aWrapperSuffix
1384                  << "." << attributeGetter(anOwner, theAttr->id()) << "()";
1385   return *this;
1386 }
1387
1388 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
1389     const std::shared_ptr<ModelAPI_AttributeRefAttr>& theRefAttr)
1390 {
1391   if (theRefAttr->isObject())
1392     *this << theRefAttr->object();
1393   else
1394     *this << theRefAttr->attr();
1395   return *this;
1396 }
1397
1398 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
1399     const std::shared_ptr<ModelAPI_AttributeRefAttrList>& theRefAttrList)
1400 {
1401   *myDumpStorage << "[";
1402   std::list<std::pair<ObjectPtr, AttributePtr> > aList = theRefAttrList->list();
1403   bool isAdded = false;
1404   std::list<std::pair<ObjectPtr, AttributePtr> >::const_iterator anIt = aList.begin();
1405   for (; anIt != aList.end(); ++anIt) {
1406     if (isAdded)
1407       *myDumpStorage << ", ";
1408     else
1409       isAdded = true;
1410     if (anIt->first)
1411       *this << anIt->first;
1412     else if (anIt->second)
1413       * this << anIt->second;
1414   }
1415   *myDumpStorage << "]";
1416   return *this;
1417 }
1418
1419 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
1420     const std::shared_ptr<ModelAPI_AttributeReference>& theReference)
1421 {
1422   *this << theReference->value();
1423   return *this;
1424 }
1425
1426 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
1427     const std::shared_ptr<ModelAPI_AttributeRefList>& theRefList)
1428 {
1429   static const int aThreshold = 2;
1430   static bool aDumpAsIs = false;
1431   // if number of elements in the list if greater than a threshold,
1432   // dump it in a separate line with specific name
1433   if (aDumpAsIs || theRefList->size() <= aThreshold) {
1434     *myDumpStorage << "[";
1435     std::list<ObjectPtr> aList = theRefList->list();
1436     bool isAdded = false;
1437     std::list<ObjectPtr>::const_iterator anIt = aList.begin();
1438     for (; anIt != aList.end(); ++anIt) {
1439       if (isAdded)
1440         *myDumpStorage << ", ";
1441       else
1442         isAdded = true;
1443
1444       *this << *anIt;
1445     }
1446     *myDumpStorage << "]";
1447   } else {
1448     // name of list
1449     FeaturePtr anOwner = ModelAPI_Feature::feature(theRefList->owner());
1450     std::string aListName = name(anOwner) + "_objects";
1451     // reserve dumped buffer and store list "as is"
1452     myDumpStorage->reserveBuffer();
1453     aDumpAsIs = true;
1454     *this << aListName << " = " << theRefList << "\n";
1455     aDumpAsIs = false;
1456     // append reserved data to the end of the current buffer
1457     myDumpStorage->restoreReservedBuffer();
1458     *myDumpStorage << aListName;
1459   }
1460   return *this;
1461 }
1462
1463 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
1464     const std::shared_ptr<ModelAPI_AttributeSelection>& theAttrSelect)
1465 {
1466   myDumpStorage->write(theAttrSelect);
1467   return *this;
1468 }
1469
1470 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
1471     const std::shared_ptr<ModelAPI_AttributeSelectionList>& theAttrSelList)
1472 {
1473   static const int aThreshold = 2;
1474   static int aNbSpaces = 0;
1475   // if number of elements in the list if greater than a threshold,
1476   // dump it in a separate line with specific name
1477   if (aNbSpaces > 0 || theAttrSelList->size() <= aThreshold) {
1478     *myDumpStorage << "[";
1479
1480     GeomShapePtr aShape;
1481     std::string aShapeTypeStr;
1482
1483     bool isAdded = false;
1484
1485     for(int anIndex = 0; anIndex < theAttrSelList->size(); ++anIndex) {
1486       AttributeSelectionPtr anAttribute = theAttrSelList->value(anIndex);
1487       aShape = anAttribute->value();
1488       if(!aShape.get()) {
1489         ResultPtr aContext = anAttribute->context();
1490         if (aContext.get())
1491           aShape = aContext->shape();
1492       }
1493
1494       if(!aShape.get()) {
1495         continue;
1496       }
1497
1498       if(isAdded) {
1499         *myDumpStorage << ", ";
1500         // print each attribute on separate line with the appropriate shift
1501         if (aNbSpaces > 0) {
1502           std::string aSpaces(aNbSpaces + 1, ' ');
1503           *myDumpStorage << "\n" << aSpaces;
1504         }
1505       } else {
1506         isAdded = true;
1507       }
1508       *this << anAttribute;
1509     }
1510
1511     // check selection list is obtained by filters
1512     FiltersFeaturePtr aFilters = theAttrSelList->filters();
1513     if (aFilters) {
1514       if (theAttrSelList->size() > 0)
1515         *myDumpStorage << ", ";
1516       dumpFeature(aFilters, true);
1517     }
1518
1519     *myDumpStorage << "]";
1520   } else {
1521     // obtain name of list (the feature may contain several selection lists)
1522     FeaturePtr anOwner = ModelAPI_Feature::feature(theAttrSelList->owner());
1523     std::string aListName = name(anOwner) + "_objects";
1524     std::list<AttributePtr> aSelLists =
1525         anOwner->data()->attributes(ModelAPI_AttributeSelectionList::typeId());
1526     if (aSelLists.size() > 1) {
1527       int anIndex = 1;
1528       for (std::list<AttributePtr>::iterator aSIt = aSelLists.begin();
1529            aSIt != aSelLists.end(); ++aSIt, ++anIndex)
1530         if ((*aSIt).get() == theAttrSelList.get())
1531           break;
1532       std::ostringstream aSStream;
1533       aSStream << aListName << "_" << anIndex;
1534       aListName = aSStream.str();
1535     }
1536     // reserve dumped buffer and store list "as is"
1537     myDumpStorage->reserveBuffer();
1538     aNbSpaces = (int)aListName.size() + 3;
1539     *this << aListName << " = " << theAttrSelList << "\n";
1540     aNbSpaces = 0;
1541     // append reserved data to the end of the current buffer
1542     myDumpStorage->restoreReservedBuffer();
1543     *myDumpStorage << aListName;
1544   }
1545   return *this;
1546 }
1547
1548 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
1549   const std::shared_ptr<ModelAPI_AttributeStringArray>& theArray)
1550 {
1551   std::ostringstream aBuffer;
1552   aBuffer << "[";
1553   for(int anIndex = 0; anIndex < theArray->size(); ++anIndex) {
1554     if (anIndex != 0)
1555       aBuffer << ", ";
1556
1557     aBuffer << "\"" << theArray->value(anIndex) << "\"";
1558   }
1559   aBuffer << "]";
1560
1561   myDumpStorage->write(aBuffer.str());
1562   return *this;
1563 }
1564
1565 void ModelHighAPI_Dumper::newline()
1566 {
1567   *this << std::endl;
1568 }
1569
1570 /// Dump std::endl
1571 ModelHighAPI_Dumper& operator<<(ModelHighAPI_Dumper& theDumper,
1572                                 std::basic_ostream<char>& (*theEndl)(std::basic_ostream<char>&))
1573 {
1574   *theDumper.myDumpStorage << theEndl;
1575
1576   if (!theDumper.myEntitiesStack.empty()) {
1577     bool isCopy;
1578     // all copies have been stored into stack, pop them all
1579     do {
1580       isCopy = false;
1581       // Name for composite feature is dumped when all sub-entities are dumped
1582       // (see method ModelHighAPI_Dumper::processSubs).
1583       const ModelHighAPI_Dumper::LastDumpedEntity& aLastDumped = theDumper.myEntitiesStack.top();
1584       CompositeFeaturePtr aComposite =
1585           std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aLastDumped.myEntity);
1586       if (!aComposite) {
1587         theDumper.dumpEntitySetName();
1588         FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(aLastDumped.myEntity);
1589         if (aFeature) {
1590           AttributeBooleanPtr aCopyAttr = aFeature->boolean("Copy");
1591           isCopy = aCopyAttr.get() && aCopyAttr->value();
1592         }
1593       }
1594     } while (isCopy && !theDumper.myEntitiesStack.empty());
1595   }
1596
1597   // store all not-dumped entities first
1598   std::set<EntityPtr> aNotDumped = theDumper.myNotDumpedEntities;
1599   theDumper.clearNotDumped();
1600   theDumper.myDumpStorage->reserveBuffer();
1601   std::set<EntityPtr>::const_iterator anIt = aNotDumped.begin();
1602   for (; anIt != aNotDumped.end(); ++anIt) {
1603     // if the feature is composite, dump it with all subs
1604     CompositeFeaturePtr aCompFeat =
1605         std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(*anIt);
1606     if (aCompFeat)
1607       theDumper.process(aCompFeat, true);
1608     else {
1609       FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(*anIt);
1610       theDumper.dumpFeature(aFeature, true);
1611       // dump the Projection feature which produces this "Copy" entity
1612       AttributeBooleanPtr aCopyAttr = aFeature->boolean("Copy");
1613       if (aCopyAttr.get() && aCopyAttr->value())
1614       {
1615         const std::set<AttributePtr>& aRefs = aFeature->data()->refsToMe();
1616         std::set<AttributePtr>::iterator aRefIt = aRefs.begin();
1617         for (; aRefIt != aRefs.end(); ++aRefIt)
1618           if ((*aRefIt)->id() == "ProjectedFeature")
1619           { // process projection only
1620             FeaturePtr anOwner = ModelAPI_Feature::feature((*aRefIt)->owner());
1621             if (anOwner && !theDumper.isDumped(EntityPtr(anOwner)))
1622               theDumper.dumpFeature(anOwner, true);
1623           }
1624       }
1625     }
1626   }
1627
1628   // then store the reserved data
1629   theDumper.myDumpStorage->restoreReservedBuffer();
1630   theDumper.myDumpStorage->mergeBuffer();
1631
1632   // now, store all postponed features
1633   theDumper.dumpPostponed();
1634
1635   return theDumper;
1636 }
1637
1638
1639 void ModelHighAPI_Dumper::exportVariables() const
1640 {
1641   DocumentPtr aRoot = ModelAPI_Session::get()->moduleDocument();
1642   EntityNameMap::const_iterator aNameIter = myNames.cbegin();
1643   for(; aNameIter != myNames.end(); aNameIter++) {
1644     FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(aNameIter->first);
1645     if (aFeature.get() && aFeature->document() != aRoot) {
1646       FeaturePtr aPartFeat = ModelAPI_Tools::findPartFeature(aRoot, aFeature->document());
1647       if (aPartFeat.get()) {
1648         int aFeatureId = aFeature->data()->featureId();
1649         int aPartId = aPartFeat->data()->featureId();
1650         std::ostringstream anEntryStr;
1651         anEntryStr<<aPartId<<":"<<aFeatureId;
1652         std::string anEntry = anEntryStr.str();
1653         exportVariable(anEntry, aNameIter->second.myCurrentName);
1654         size_t aSize = aFeature->results().size();
1655         if (aSize > 1) { // additional entries for features with more than one result
1656           for(int a = 1; a < aSize; a++) {
1657             std::ostringstream aResEntryStr;
1658             aResEntryStr<<anEntry<<":"<<a;
1659             std::string aResEntry = aResEntryStr.str();
1660             exportVariable(aResEntry, aNameIter->second.myCurrentName);
1661           }
1662         }
1663       }
1664     }
1665   }
1666 }