src/ModelHighAPI/ModelHighAPI_Dumper.cpp

   1 // Copyright (C) 2014-2017  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
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #include "ModelHighAPI_Dumper.h"
  22
  23 #include <Config_PropManager.h>
  24
  25 #include <GeomAPI_Pnt.h>
  26 #include <GeomAPI_Dir.h>
  27 #include <GeomAPI_ShapeExplorer.h>
  28
  29 #include <GeomDataAPI_Dir.h>
  30 #include <GeomDataAPI_Point.h>
  31 #include <GeomDataAPI_Point2D.h>
  32
  33 #include <ModelAPI_AttributeBoolean.h>
  34 #include <ModelAPI_AttributeDouble.h>
  35 #include <ModelAPI_AttributeIntArray.h>
  36 #include <ModelAPI_AttributeInteger.h>
  37 #include <ModelAPI_AttributeRefAttr.h>
  38 #include <ModelAPI_AttributeRefAttrList.h>
  39 #include <ModelAPI_AttributeReference.h>
  40 #include <ModelAPI_AttributeRefList.h>
  41 #include <ModelAPI_AttributeSelection.h>
  42 #include <ModelAPI_AttributeSelectionList.h>
  43 #include <ModelAPI_AttributeString.h>
  44 #include <ModelAPI_AttributeStringArray.h>
  45 #include <ModelAPI_CompositeFeature.h>
  46 #include <ModelAPI_Document.h>
  47 #include <ModelAPI_Entity.h>
  48 #include <ModelAPI_Feature.h>
  49 #include <ModelAPI_Folder.h>
  50 #include <ModelAPI_Result.h>
  51 #include <ModelAPI_ResultBody.h>
  52 #include <ModelAPI_ResultCompSolid.h>
  53 #include <ModelAPI_ResultConstruction.h>
  54 #include <ModelAPI_ResultPart.h>
  55 #include <ModelAPI_Tools.h>
  56
  57 #include <PartSetPlugin_Part.h>
  58
  59 #include <OSD_OpenFile.hxx>
  60
  61 #include <fstream>
  62
  63 static int gCompositeStackDepth = 0;
  64
  65 ModelHighAPI_Dumper* ModelHighAPI_Dumper::mySelf = 0;
  66
  67 ModelHighAPI_Dumper::ModelHighAPI_Dumper()
  68 {
  69   clear();
  70 }
  71
  72 void ModelHighAPI_Dumper::setInstance(ModelHighAPI_Dumper* theDumper)
  73 {
  74   if (mySelf == 0)
  75     mySelf = theDumper;
  76 }
  77
  78 ModelHighAPI_Dumper* ModelHighAPI_Dumper::getInstance()
  79 {
  80   return mySelf;
  81 }
  82
  83 void ModelHighAPI_Dumper::clear(bool bufferOnly)
  84 {
  85   myDumpBuffer.str("");
  86   myDumpBuffer << std::setprecision(16);
  87
  88   clearNotDumped();
  89
  90   if (!bufferOnly) {
  91     myFullDump.str("");
  92     myFullDump << std::setprecision(16);
  93
  94     myNames.clear();
  95     myModules.clear();
  96     myFeatureCount.clear();
  97     while (!myEntitiesStack.empty())
  98       myEntitiesStack.pop();
  99
 100     myPostponed.clear();
 101     myDumpPostponedInProgress = false;
 102   }
 103 }
 104
 105 void ModelHighAPI_Dumper::clearNotDumped()
 106 {
 107   myNotDumpedEntities.clear();
 108 }
 109
 110 // Convert string to integer. If the string is not a number, return -1
 111 static int toInt(const std::string& theString)
 112 {
 113   std::string::const_iterator aChar = theString.begin();
 114   for (; aChar != theString.end(); ++aChar)
 115     if (!std::isdigit(*aChar))
 116       break;
 117   if (aChar != theString.end())
 118     return -1; // not a number
 119   return std::stoi(theString);
 120 }
 121
 122 const std::string& ModelHighAPI_Dumper::name(const EntityPtr& theEntity,
 123                                              bool theSaveNotDumped,
 124                                              bool theUseEntityName)
 125 {
 126   EntityNameMap::const_iterator aFound = myNames.find(theEntity);
 127   if (aFound != myNames.end())
 128     return aFound->second.myCurrentName;
 129
 130   // entity is not found, store it
 131   std::string aName, aKind;
 132   bool isDefaultName = false;
 133   bool isSaveNotDumped = theSaveNotDumped;
 134   std::ostringstream aDefaultName;
 135   FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(theEntity);
 136   if (aFeature) {
 137     aName = aFeature->name();
 138     aKind = aFeature->getKind();
 139   } else {
 140     FolderPtr aFolder = std::dynamic_pointer_cast<ModelAPI_Folder>(theEntity);
 141     if (aFolder) {
 142       aName = aFolder->data()->name();
 143       aKind = ModelAPI_Folder::ID();
 144       isSaveNotDumped = false;
 145     }
 146   }
 147
 148   ObjectPtr anObject = std::dynamic_pointer_cast<ModelAPI_Object>(theEntity);
 149   if (anObject) {
 150     DocumentPtr aDoc = anObject->document();
 151     int& aNbFeatures = myFeatureCount[aDoc][aKind];
 152     aNbFeatures += 1;
 153
 154     size_t anIndex = aName.find(aKind);
 155     if (anIndex == 0 && aName[aKind.length()] == '_') { // name starts with "FeatureKind_"
 156       std::string anIdStr = aName.substr(aKind.length() + 1);
 157       int anId = toInt(anIdStr);
 158
 159       // Check number of already registered objects of such kind. Index of current object
 160       // should be the same to identify feature's name as automatically generated.
 161       if (aNbFeatures == anId) {
 162         // name is not user-defined
 163         isDefaultName = true;
 164       }
 165     }
 166
 167     // obtain default name for the feature
 168     if (theUseEntityName)
 169       aDefaultName << aName;
 170     else {
 171       int aFullIndex = 0;
 172       NbFeaturesMap::const_iterator aFIt = myFeatureCount.begin();
 173       for (; aFIt != myFeatureCount.end(); ++aFIt) {
 174         std::map<std::string, int>::const_iterator aFound = aFIt->second.find(aKind);
 175         if (aFound != aFIt->second.end())
 176           aFullIndex += aFound->second;
 177       }
 178       aDefaultName << aKind << "_" << aFullIndex;
 179     }
 180   }
 181
 182   myNames[theEntity] = EntityName(aDefaultName.str(), aName, isDefaultName);
 183   if (isSaveNotDumped)
 184     myNotDumpedEntities.insert(theEntity);
 185
 186   // store names of results
 187   if (aFeature)
 188     saveResultNames(aFeature);
 189
 190   return myNames[theEntity].myCurrentName;
 191 }
 192
 193 const std::string& ModelHighAPI_Dumper::parentName(const FeaturePtr& theEntity)
 194 {
 195   const std::set<AttributePtr>& aRefs = theEntity->data()->refsToMe();
 196   std::set<AttributePtr>::const_iterator aRefIt = aRefs.begin();
 197   for (; aRefIt != aRefs.end(); ++aRefIt) {
 198     CompositeFeaturePtr anOwner = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(
 199         ModelAPI_Feature::feature((*aRefIt)->owner()));
 200     if (anOwner)
 201       return name(anOwner);
 202   }
 203
 204   static const std::string DUMMY;
 205   return DUMMY;
 206 }
 207
 208 void ModelHighAPI_Dumper::saveResultNames(const FeaturePtr& theFeature)
 209 {
 210   // Default name of the feature
 211   bool isFeatureDefaultName = myNames[theFeature].myIsDefault;
 212
 213   // Save only names of results which is not correspond to default feature name
 214   const std::list<ResultPtr>& aResults = theFeature->results();
 215   std::list<ResultPtr>::const_iterator aResIt = aResults.begin();
 216   for (int i = 0; aResIt != aResults.end(); ++aResIt, ++i) {
 217     std::pair<std::string, bool> aName = ModelAPI_Tools::getDefaultName(*aResIt, i);
 218     std::string aDefaultName = aName.first;
 219     std::string aResName = (*aResIt)->data()->name();
 220
 221     bool isUserDefined = !(isFeatureDefaultName && aDefaultName == aResName);
 222
 223     myNames[*aResIt] = EntityName(aResName,
 224         (isUserDefined ? aResName : std::string()), !isUserDefined);
 225
 226     // check names of sub-results for CompSolid
 227     ResultCompSolidPtr aCompSolid = std::dynamic_pointer_cast<ModelAPI_ResultCompSolid>(*aResIt);
 228     if (aCompSolid) {
 229       int aNbSubs = aCompSolid->numberOfSubs();
 230       for (int j = 0; j < aNbSubs; ++j) {
 231         ResultPtr aSub = aCompSolid->subResult(j);
 232         std::string aSubName = aSub->data()->name();
 233         aName = ModelAPI_Tools::getDefaultName(aSub, j);
 234         aDefaultName = aName.first;
 235
 236         bool isUserDefinedSubName = isUserDefined || aDefaultName != aSubName;
 237         myNames[aSub] = EntityName(aSubName,
 238             (isUserDefinedSubName ? aSubName : std::string()), !isUserDefinedSubName);
 239       }
 240     }
 241   }
 242 }
 243
 244 bool ModelHighAPI_Dumper::process(const std::shared_ptr<ModelAPI_Document>& theDoc,
 245                                   const std::string& theFileName)
 246 {
 247   // dump top level document feature
 248   static const std::string aDocName("partSet");
 249   myNames[theDoc] = EntityName(aDocName, std::string(), true);
 250   *this << aDocName << " = model.moduleDocument()" << std::endl;
 251
 252   // dump subfeatures and store result to file
 253   return process(theDoc) && exportTo(theFileName);
 254 }
 255
 256 bool ModelHighAPI_Dumper::process(const std::shared_ptr<ModelAPI_Document>& theDoc)
 257 {
 258   bool isOk = true;
 259   std::list<ObjectPtr> anObjects = theDoc->allObjects();
 260   std::list<ObjectPtr>::const_iterator anObjIt = anObjects.begin();
 261   // firstly, dump all parameters
 262   for (; anObjIt != anObjects.end(); ++ anObjIt) {
 263     FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(*anObjIt);
 264     if (aFeature)
 265       dumpParameter(aFeature);
 266   }
 267   // dump all other features
 268   for (anObjIt = anObjects.begin(); anObjIt != anObjects.end(); ++anObjIt) {
 269     CompositeFeaturePtr aCompFeat = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(*anObjIt);
 270     if (aCompFeat) // iteratively process composite features
 271       isOk = process(aCompFeat) && isOk;
 272     else if (!isDumped(EntityPtr(*anObjIt))) {
 273       // dump folder
 274       FolderPtr aFolder = std::dynamic_pointer_cast<ModelAPI_Folder>(*anObjIt);
 275       if (aFolder)
 276         dumpFolder(aFolder);
 277       else {
 278         FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(*anObjIt);
 279         if (aFeature) // dump common feature
 280           dumpFeature(aFeature);
 281       }
 282     }
 283   }
 284   // dump folders if any
 285   dumpPostponed(true);
 286   return isOk;
 287 }
 288
 289 bool ModelHighAPI_Dumper::process(const std::shared_ptr<ModelAPI_CompositeFeature>& theComposite,
 290                                   bool isForce)
 291 {
 292   // increase composite features stack
 293   ++gCompositeStackDepth;
 294   // dump composite itself
 295   if (!isDumped(EntityPtr(theComposite)) || isForce)
 296     dumpFeature(FeaturePtr(theComposite), isForce);
 297
 298   // sub-part is processed independently, because it provides separate document
 299   if (theComposite->getKind() == PartSetPlugin_Part::ID()) {
 300     // dump name of the part if it is different from default
 301     if (!myEntitiesStack.empty())
 302       dumpEntitySetName();
 303
 304     // decrease composite features stack because we run into separate document
 305     --gCompositeStackDepth;
 306
 307     ResultPartPtr aPartResult =
 308         std::dynamic_pointer_cast<ModelAPI_ResultPart>(theComposite->lastResult());
 309     if (!aPartResult)
 310       return false;
 311     DocumentPtr aSubDoc = aPartResult->partDoc();
 312     if (!aSubDoc)
 313       return false;
 314     // set name of document
 315     const std::string& aPartName = myNames[theComposite].myCurrentName;
 316     std::string aDocName = aPartName + "_doc";
 317     myNames[aSubDoc] = EntityName(aDocName, std::string(), true);
 318
 319     // dump document in a separate line
 320     *this << aDocName << " = " << aPartName << ".document()" << std::endl;
 321     // dump features in the document
 322     bool aRes = process(aSubDoc);
 323     *this << "model.do()" << std::endl;
 324     return aRes;
 325   }
 326
 327   // dump sub-features
 328   bool isOk = processSubs(theComposite);
 329   // decrease composite features stack
 330   --gCompositeStackDepth;
 331
 332   return isOk;
 333 }
 334
 335 bool ModelHighAPI_Dumper::processSubs(
 336   const std::shared_ptr<ModelAPI_CompositeFeature>& theComposite,
 337   bool theDumpModelDo)
 338 {
 339   bool isOk = true;
 340   // dump all sub-features;
 341   bool isSubDumped = false;
 342   int aNbSubs = theComposite->numberOfSubs();
 343   for (int anIndex = 0; anIndex < aNbSubs; ++anIndex) {
 344     FeaturePtr aFeature = theComposite->subFeature(anIndex);
 345     if (isDumped(EntityPtr(aFeature)))
 346       continue;
 347
 348     isSubDumped = true;
 349     CompositeFeaturePtr aCompFeat = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aFeature);
 350     if (aCompFeat) // iteratively process composite features
 351       isOk = process(aCompFeat) && isOk;
 352     else
 353       dumpFeature(aFeature, true);
 354   }
 355
 356   bool isDumpSetName = !myEntitiesStack.empty() &&
 357       myEntitiesStack.top().myEntity == EntityPtr(theComposite);
 358   bool isForceModelDo = isSubDumped && isDumpSetName &&
 359       (myEntitiesStack.top().myUserName || !myEntitiesStack.top().myResults.empty());
 360   // It is necessary for the sketch to create its result when complete (command "model.do()").
 361   // This option is set by flat theDumpModelDo.
 362   // However, nested sketches are rebuilt by parent feature, so, they do not need
 363   // explicit call of "model.do()". This will be controlled by the depth of the stack.
 364   if (isForceModelDo || (theDumpModelDo && gCompositeStackDepth <= 1))
 365     *this << "model.do()" << std::endl;
 366
 367   // dump "setName" for composite feature
 368   if (isDumpSetName)
 369     dumpEntitySetName();
 370   return isOk;
 371 }
 372
 373 void ModelHighAPI_Dumper::postpone(const EntityPtr& theEntity)
 374 {
 375   // keep the name
 376   name(theEntity, false);
 377   myPostponed.push_back(theEntity);
 378 }
 379
 380 void ModelHighAPI_Dumper::dumpPostponed(bool theDumpFolders)
 381 {
 382   if (myDumpPostponedInProgress)
 383     return;
 384
 385   myDumpPostponedInProgress = true;
 386   // make a copy of postponed entities, because the list will be updated
 387   // if some features are not able to be dumped
 388   std::list<EntityPtr> aPostponedCopy = myPostponed;
 389   myPostponed.clear();
 390
 391   // iterate over postponed entities and try to dump them
 392   std::list<EntityPtr>::const_iterator anIt = aPostponedCopy.begin();
 393   for (; anIt != aPostponedCopy.end(); ++anIt) {
 394     FolderPtr aFolder = std::dynamic_pointer_cast<ModelAPI_Folder>(*anIt);
 395     if (aFolder) {
 396       if (theDumpFolders)
 397         dumpFolder(aFolder);
 398       else
 399         myPostponed.push_back(*anIt);
 400     }
 401     else {
 402       FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(*anIt);
 403       if (aFeature)
 404         dumpFeature(aFeature);
 405     }
 406   }
 407   myDumpPostponedInProgress = false;
 408 }
 409
 410 void ModelHighAPI_Dumper::dumpSubFeatureNameAndColor(const std::string theSubFeatureGet,
 411                                                      const FeaturePtr& theSubFeature)
 412 {
 413   name(theSubFeature, false);
 414   myNames[theSubFeature] = EntityName(theSubFeatureGet, theSubFeature->name(), false);
 415
 416   // store results if they have user-defined names or colors
 417   std::list<ResultPtr> aResultsWithNameOrColor;
 418   const std::list<ResultPtr>& aResults = theSubFeature->results();
 419   std::list<ResultPtr>::const_iterator aResIt = aResults.begin();
 420   for (; aResIt != aResults.end(); ++aResIt) {
 421     std::string aResName = (*aResIt)->data()->name();
 422     myNames[*aResIt] = EntityName(aResName, aResName, false);
 423     aResultsWithNameOrColor.push_back(*aResIt);
 424   }
 425
 426   // store just dumped entity to stack
 427   myEntitiesStack.push(LastDumpedEntity(theSubFeature, true, aResultsWithNameOrColor));
 428
 429   dumpEntitySetName();
 430 }
 431
 432 bool ModelHighAPI_Dumper::exportTo(const std::string& theFileName)
 433 {
 434   std::ofstream aFile;
 435   OSD_OpenStream(aFile, theFileName.c_str(), std::ofstream::out);
 436   if (!aFile.is_open())
 437     return false;
 438
 439   // standard header
 440   for (ModulesMap::const_iterator aModIt = myModules.begin();
 441        aModIt != myModules.end(); ++aModIt) {
 442     aFile << "from " << aModIt->first << " import ";
 443     if (aModIt->second.empty() ||
 444         aModIt->second.find(std::string()) != aModIt->second.end())
 445       aFile << "*"; // import whole module
 446     else {
 447       // import specific features
 448       std::set<std::string>::const_iterator anObjIt = aModIt->second.begin();
 449       aFile << *anObjIt;
 450       for (++anObjIt; anObjIt != aModIt->second.end(); ++anObjIt)
 451         aFile << ", " << *anObjIt;
 452     }
 453     aFile << std::endl;
 454   }
 455   if (!myModules.empty())
 456     aFile << std::endl;
 457
 458   aFile << "from salome.shaper import model" << std::endl << std::endl;
 459   aFile << "model.begin()" << std::endl;
 460
 461   // dump collected data
 462   aFile << myFullDump.str();
 463   aFile << myDumpBuffer.str();
 464
 465   // standard footer
 466   aFile << "model.end()" << std::endl;
 467
 468   aFile.close();
 469   clear();
 470
 471   return true;
 472 }
 473
 474 void ModelHighAPI_Dumper::importModule(const std::string& theModuleName,
 475                                        const std::string& theObject)
 476 {
 477   myModules[theModuleName].insert(theObject);
 478 }
 479
 480 void ModelHighAPI_Dumper::dumpEntitySetName()
 481 {
 482   const LastDumpedEntity& aLastDumped = myEntitiesStack.top();
 483   bool isBufferEmpty = myDumpBuffer.str().empty();
 484
 485   // dump "setName" for the entity
 486   if (aLastDumped.myUserName) {
 487     EntityName& anEntityNames = myNames[aLastDumped.myEntity];
 488     if (!anEntityNames.myIsDefault)
 489       myDumpBuffer << anEntityNames.myCurrentName << ".setName(\""
 490                    << anEntityNames.myUserName << "\")" << std::endl;
 491     // don't dump "setName" for the entity twice
 492     anEntityNames.myUserName.clear();
 493     anEntityNames.myIsDefault = true;
 494   }
 495   // dump "setName" for results
 496   std::list<ResultPtr>::const_iterator aResIt = aLastDumped.myResults.begin();
 497   std::list<ResultPtr>::const_iterator aResEnd = aLastDumped.myResults.end();
 498   for (; aResIt != aResEnd; ++aResIt) {
 499     // set result name
 500     EntityName& anEntityNames = myNames[*aResIt];
 501     if (!anEntityNames.myIsDefault) {
 502       *this << *aResIt;
 503       myDumpBuffer << ".setName(\"" << anEntityNames.myUserName << "\")" << std::endl;
 504       // don't dump "setName" for the entity twice
 505       anEntityNames.myUserName.clear();
 506       anEntityNames.myIsDefault = true;
 507     }
 508     // set result color
 509     if (!isDefaultColor(*aResIt)) {
 510       AttributeIntArrayPtr aColor = (*aResIt)->data()->intArray(ModelAPI_Result::COLOR_ID());
 511       if (aColor && aColor->isInitialized()) {
 512         *this << *aResIt;
 513         myDumpBuffer << ".setColor(" << aColor->value(0) << ", " << aColor->value(1)
 514                      << ", " << aColor->value(2) << ")" << std::endl;
 515       }
 516     }
 517     // set result deflection
 518     if (!isDefaultDeflection(*aResIt)) {
 519       AttributeDoublePtr aDeflectionAttr =
 520         (*aResIt)->data()->real(ModelAPI_Result::DEFLECTION_ID());
 521       if(aDeflectionAttr.get() && aDeflectionAttr->isInitialized()) {
 522         *this << *aResIt;
 523         myDumpBuffer << ".setDeflection(" << aDeflectionAttr->value() << ")" << std::endl;
 524       }
 525     }
 526     // set result transparency
 527     if (!isDefaultTransparency(*aResIt)) {
 528       AttributeDoublePtr aTransparencyAttr =
 529         (*aResIt)->data()->real(ModelAPI_Result::TRANSPARENCY_ID());
 530       if(aTransparencyAttr.get() && aTransparencyAttr->isInitialized()) {
 531         *this << *aResIt;
 532         myDumpBuffer << ".setTransparency(" << aTransparencyAttr->value() << ")" << std::endl;
 533       }
 534     }
 535   }
 536
 537   myNames[aLastDumped.myEntity].myIsDumped = true;
 538   myEntitiesStack.pop();
 539
 540   // clean buffer if it was clear before
 541   if (isBufferEmpty) {
 542     myFullDump << myDumpBuffer.str();
 543     myDumpBuffer.str("");
 544   }
 545 }
 546
 547 bool ModelHighAPI_Dumper::isDumped(const EntityPtr& theEntity) const
 548 {
 549   EntityNameMap::const_iterator aFound = myNames.find(theEntity);
 550   FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(theEntity);
 551   return (aFound != myNames.end() && aFound->second.myIsDumped) ||
 552          myFeaturesToSkip.find(aFeature) != myFeaturesToSkip.end();
 553 }
 554
 555 bool ModelHighAPI_Dumper::isDumped(const AttributeRefAttrPtr& theRefAttr) const
 556 {
 557   FeaturePtr aFeature;
 558   if (theRefAttr->isObject())
 559     aFeature = ModelAPI_Feature::feature(theRefAttr->object());
 560   else
 561     aFeature = ModelAPI_Feature::feature(theRefAttr->attr()->owner());
 562   return aFeature && isDumped(EntityPtr(aFeature));
 563 }
 564
 565 bool ModelHighAPI_Dumper::isDumped(const AttributeRefListPtr& theRefList) const
 566 {
 567   std::list<ObjectPtr> aRefs = theRefList->list();
 568   std::list<ObjectPtr>::iterator anIt = aRefs.begin();
 569   for (; anIt != aRefs.end(); ++anIt) {
 570     FeaturePtr aFeature = ModelAPI_Feature::feature(*anIt);
 571     if (aFeature && !isDumped(EntityPtr(aFeature)))
 572       return false;
 573   }
 574   return true;
 575 }
 576
 577 bool ModelHighAPI_Dumper::isDefaultColor(const ResultPtr& theResult) const
 578 {
 579   AttributeIntArrayPtr aColor = theResult->data()->intArray(ModelAPI_Result::COLOR_ID());
 580   if (!aColor || !aColor->isInitialized())
 581     return true;
 582
 583   std::string aSection, aName, aDefault;
 584   theResult->colorConfigInfo(aSection, aName, aDefault);
 585
 586   // dump current color
 587   std::ostringstream aColorInfo;
 588   aColorInfo << aColor->value(0) << "," << aColor->value(1) << "," << aColor->value(2);
 589
 590   return aDefault == aColorInfo.str();
 591 }
 592
 593 bool ModelHighAPI_Dumper::isDefaultDeflection(const ResultPtr& theResult) const
 594 {
 595   AttributeDoublePtr aDeflectionAttr = theResult->data()->real(ModelAPI_Result::DEFLECTION_ID());
 596   if(!aDeflectionAttr || !aDeflectionAttr->isInitialized()) {
 597     return true;
 598   }
 599
 600   double aCurrent = aDeflectionAttr->value();
 601   double aDefault = -1;
 602
 603   bool isConstruction = false;
 604   std::string aResultGroup = theResult->groupName();
 605   if (aResultGroup == ModelAPI_ResultConstruction::group())
 606     isConstruction = true;
 607   else if (aResultGroup == ModelAPI_ResultBody::group()) {
 608     GeomShapePtr aGeomShape = theResult->shape();
 609     if (aGeomShape.get()) {
 610       // if the shape could not be exploded on faces, it contains only wires, edges, and vertices
 611       // correction of deviation for them should not influence to the application performance
 612       GeomAPI_ShapeExplorer anExp(aGeomShape, GeomAPI_Shape::FACE);
 613       isConstruction = !anExp.more();
 614     }
 615   }
 616   if (isConstruction)
 617     aDefault = Config_PropManager::real("Visualization", "construction_deflection");
 618   else
 619     aDefault = Config_PropManager::real("Visualization", "body_deflection");
 620
 621   return fabs(aCurrent - aDefault) < 1.e-12;
 622 }
 623
 624 bool ModelHighAPI_Dumper::isDefaultTransparency(const ResultPtr& theResult) const
 625 {
 626   AttributeDoublePtr anAttribute = theResult->data()->real(ModelAPI_Result::TRANSPARENCY_ID());
 627   if(!anAttribute || !anAttribute->isInitialized()) {
 628     return true;
 629   }
 630   return fabs(anAttribute->value()) < 1.e-12;
 631 }
 632
 633 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const char theChar)
 634 {
 635   myDumpBuffer << theChar;
 636   return *this;
 637 }
 638
 639 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const char* theString)
 640 {
 641   myDumpBuffer << theString;
 642   return *this;
 643 }
 644
 645 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const std::string& theString)
 646 {
 647   myDumpBuffer << theString;
 648   return *this;
 649 }
 650
 651 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const bool theValue)
 652 {
 653   myDumpBuffer << (theValue ? "True" : "False");
 654   return *this;
 655 }
 656
 657 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const int theValue)
 658 {
 659   myDumpBuffer << theValue;
 660   return *this;
 661 }
 662
 663 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const double theValue)
 664 {
 665   myDumpBuffer << theValue;
 666   return *this;
 667 }
 668
 669 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const std::shared_ptr<GeomAPI_Pnt>& thePoint)
 670 {
 671   importModule("GeomAPI", "GeomAPI_Pnt");
 672   myDumpBuffer << "GeomAPI_Pnt(" << thePoint->x() << ", "
 673                << thePoint->y() << ", " << thePoint->z() << ")";
 674   return *this;
 675 }
 676
 677 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const std::shared_ptr<GeomAPI_Dir>& theDir)
 678 {
 679   importModule("GeomAPI", "GeomAPI_Dir");
 680   myDumpBuffer << "GeomAPI_Dir(" << theDir->x() << ", "
 681                << theDir->y() << ", " << theDir->z() << ")";
 682   return *this;
 683 }
 684
 685 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
 686     const std::shared_ptr<GeomDataAPI_Dir>& theDir)
 687 {
 688   myDumpBuffer << theDir->x() << ", " << theDir->y() << ", " << theDir->z();
 689   return *this;
 690 }
 691
 692 static void dumpArray(std::ostringstream& theOutput, int theSize,
 693                       double* theValues, std::string* theTexts)
 694 {
 695   for (int i = 0; i < theSize; ++i) {
 696     if (i > 0)
 697       theOutput << ", ";
 698     if (theTexts[i].empty())
 699       theOutput << theValues[i];
 700     else
 701       theOutput << "\"" << theTexts[i] << "\"";
 702   }
 703 }
 704
 705 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
 706     const std::shared_ptr<GeomDataAPI_Point>& thePoint)
 707 {
 708   static const int aSize = 3;
 709   double aValues[aSize] = {thePoint->x(), thePoint->y(), thePoint->z()};
 710   std::string aTexts[aSize] = {thePoint->textX(), thePoint->textY(), thePoint->textZ()};
 711   dumpArray(myDumpBuffer, aSize, aValues, aTexts);
 712   return *this;
 713 }
 714
 715 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
 716     const std::shared_ptr<GeomDataAPI_Point2D>& thePoint)
 717 {
 718   static const int aSize = 2;
 719   double aValues[aSize] = {thePoint->x(), thePoint->y()};
 720   std::string aTexts[aSize] = {thePoint->textX(), thePoint->textY()};
 721   dumpArray(myDumpBuffer, aSize, aValues, aTexts);
 722   return *this;
 723 }
 724
 725 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
 726     const std::shared_ptr<ModelAPI_AttributeBoolean>& theAttrBool)
 727 {
 728   myDumpBuffer << (theAttrBool->value() ? "True" : "False");
 729   return *this;
 730 }
 731
 732 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
 733     const std::shared_ptr<ModelAPI_AttributeInteger>& theAttrInt)
 734 {
 735   std::string aText = theAttrInt->text();
 736   if (aText.empty())
 737     myDumpBuffer << theAttrInt->value();
 738   else
 739     myDumpBuffer << "\"" << aText << "\"";
 740   return *this;
 741 }
 742
 743 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
 744     const std::shared_ptr<ModelAPI_AttributeDouble>& theAttrReal)
 745 {
 746   std::string aText = theAttrReal->text();
 747   if (aText.empty())
 748     myDumpBuffer << theAttrReal->value();
 749   else
 750     myDumpBuffer << "\"" << aText << "\"";
 751   return *this;
 752 }
 753
 754 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
 755     const std::shared_ptr<ModelAPI_AttributeString>& theAttrStr)
 756 {
 757   myDumpBuffer << "\"" << theAttrStr->value() << "\"";
 758   return *this;
 759 }
 760
 761 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const FolderPtr& theFolder)
 762 {
 763   myDumpBuffer << name(theFolder);
 764
 765   // add dumped folder to a stack
 766   if (!myNames[theFolder].myIsDumped &&
 767      (myEntitiesStack.empty() || myEntitiesStack.top().myEntity != theFolder))
 768     myEntitiesStack.push(LastDumpedEntity(theFolder, !myNames[theFolder].myIsDefault));
 769
 770   return *this;
 771 }
 772
 773 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const FeaturePtr& theEntity)
 774 {
 775   myDumpBuffer << name(theEntity);
 776
 777   if (!myNames[theEntity].myIsDumped) {
 778     bool isUserDefinedName = !myNames[theEntity].myIsDefault;
 779     // store results if they have user-defined names or colors
 780     std::list<ResultPtr> aResultsWithNameOrColor;
 781     const std::list<ResultPtr>& aResults = theEntity->results();
 782     std::list<ResultPtr>::const_iterator aResIt = aResults.begin();
 783     for (; aResIt != aResults.end(); ++aResIt) {
 784       if (!myNames[*aResIt].myIsDefault || !isDefaultColor(*aResIt) ||
 785           !isDefaultDeflection(*aResIt) || !isDefaultTransparency(*aResIt))
 786         aResultsWithNameOrColor.push_back(*aResIt);
 787
 788       ResultCompSolidPtr aCompSolid =
 789           std::dynamic_pointer_cast<ModelAPI_ResultCompSolid>(*aResIt);
 790       if (aCompSolid) {
 791         int aNbSubs = aCompSolid->numberOfSubs();
 792         for (int i = 0; i < aNbSubs; ++i) {
 793           ResultPtr aCurRes = aCompSolid->subResult(i);
 794           if (!myNames[aCurRes].myIsDefault || !isDefaultColor(aCurRes) ||
 795               !isDefaultDeflection(aCurRes) || !isDefaultTransparency(aCurRes))
 796             aResultsWithNameOrColor.push_back(aCurRes);
 797         }
 798       }
 799     }
 800     // store just dumped entity to stack
 801     if (myEntitiesStack.empty() || myEntitiesStack.top().myEntity != theEntity)
 802       myEntitiesStack.push(
 803           LastDumpedEntity(theEntity, isUserDefinedName, aResultsWithNameOrColor));
 804   }
 805
 806   // remove entity from the list of not dumped items
 807   myNotDumpedEntities.erase(theEntity);
 808   return *this;
 809 }
 810
 811 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const ResultPtr& theResult)
 812 {
 813   FeaturePtr aFeature = ModelAPI_Feature::feature(theResult);
 814   int anIndex = 0;
 815   int aSubIndex = -1;
 816   std::list<ResultPtr> aResults = aFeature->results();
 817   for(std::list<ResultPtr>::const_iterator
 818       anIt = aResults.cbegin(); anIt != aResults.cend(); ++anIt, ++anIndex) {
 819     if(theResult->isSame(*anIt)) {
 820       break;
 821     }
 822
 823     ResultCompSolidPtr aCompSolid = std::dynamic_pointer_cast<ModelAPI_ResultCompSolid>(*anIt);
 824     if (aCompSolid) {
 825       int aNbSubs = aCompSolid->numberOfSubs();
 826       for (aSubIndex = 0; aSubIndex < aNbSubs; ++aSubIndex)
 827         if (theResult->isSame(aCompSolid->subResult(aSubIndex)))
 828           break;
 829       if (aSubIndex < aNbSubs)
 830         break;
 831       aSubIndex = -1;
 832     }
 833   }
 834
 835   myDumpBuffer << name(aFeature);
 836   if(anIndex == 0) {
 837     myDumpBuffer << ".result()";
 838   } else {
 839     myDumpBuffer << ".results()[" << anIndex << "]";
 840   }
 841   if (aSubIndex >= 0) {
 842     myDumpBuffer << ".subResult(" << aSubIndex << ")";
 843   }
 844   return *this;
 845 }
 846
 847 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const ObjectPtr& theObject)
 848 {
 849   FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(theObject);
 850   if(aFeature.get()) {
 851     myDumpBuffer << name(aFeature);
 852     return *this;
 853   }
 854
 855   ResultPtr aResult = std::dynamic_pointer_cast<ModelAPI_Result>(theObject);
 856   if(aResult.get()) {
 857     *this << aResult;
 858     return *this;
 859   }
 860
 861   return *this;
 862 }
 863
 864 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const AttributePtr& theAttr)
 865 {
 866   FeaturePtr anOwner = ModelAPI_Feature::feature(theAttr->owner());
 867
 868   std::string aWrapperPrefix, aWrapperSuffix;
 869   // Check the attribute belongs to copied (in multi-translation or multi-rotation) feature.
 870   // In this case we need to cast explicitly feature to appropriate type.
 871   AttributeBooleanPtr isCopy = anOwner->boolean("Copy");
 872   if (isCopy.get() && isCopy->value()) {
 873     aWrapperPrefix = featureWrapper(anOwner) + "(";
 874     aWrapperSuffix = ")";
 875     importModule("SketchAPI");
 876   }
 877
 878   myDumpBuffer << aWrapperPrefix << name(anOwner) << aWrapperSuffix
 879                << "." << attributeGetter(anOwner, theAttr->id()) << "()";
 880   return *this;
 881 }
 882
 883 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
 884     const std::shared_ptr<ModelAPI_AttributeRefAttr>& theRefAttr)
 885 {
 886   if (theRefAttr->isObject())
 887     *this << theRefAttr->object();
 888   else
 889     *this << theRefAttr->attr();
 890   return *this;
 891 }
 892
 893 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
 894     const std::shared_ptr<ModelAPI_AttributeRefAttrList>& theRefAttrList)
 895 {
 896   myDumpBuffer << "[";
 897   std::list<std::pair<ObjectPtr, AttributePtr> > aList = theRefAttrList->list();
 898   bool isAdded = false;
 899   std::list<std::pair<ObjectPtr, AttributePtr> >::const_iterator anIt = aList.begin();
 900   for (; anIt != aList.end(); ++anIt) {
 901     if (isAdded)
 902       myDumpBuffer << ", ";
 903     else
 904       isAdded = true;
 905     if (anIt->first)
 906       *this << anIt->first;
 907     else if (anIt->second)
 908       * this << anIt->second;
 909   }
 910   myDumpBuffer << "]";
 911   return *this;
 912 }
 913
 914 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
 915     const std::shared_ptr<ModelAPI_AttributeReference>& theReference)
 916 {
 917   *this << theReference->value();
 918   return *this;
 919 }
 920
 921 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
 922     const std::shared_ptr<ModelAPI_AttributeRefList>& theRefList)
 923 {
 924   static const int aThreshold = 2;
 925   // if number of elements in the list if greater than a threshold,
 926   // dump it in a separate line with specific name
 927   std::string aDumped = myDumpBuffer.str();
 928   if (aDumped.empty() || theRefList->size() <= aThreshold) {
 929     myDumpBuffer << "[";
 930     std::list<ObjectPtr> aList = theRefList->list();
 931     bool isAdded = false;
 932     std::list<ObjectPtr>::const_iterator anIt = aList.begin();
 933     for (; anIt != aList.end(); ++anIt) {
 934       if (isAdded)
 935         myDumpBuffer << ", ";
 936       else
 937         isAdded = true;
 938
 939       *this << *anIt;
 940     }
 941     myDumpBuffer << "]";
 942   } else {
 943     // clear buffer and store list "as is"
 944     myDumpBuffer.str("");
 945     *this << theRefList;
 946     // save buffer and clear it again
 947     std::string aDumpedList = myDumpBuffer.str();
 948     myDumpBuffer.str("");
 949     // obtain name of list
 950     FeaturePtr anOwner = ModelAPI_Feature::feature(theRefList->owner());
 951     std::string aListName = name(anOwner) + "_objects";
 952     // store all previous data
 953     myDumpBuffer << aListName << " = " << aDumpedList << std::endl
 954                  << aDumped << aListName;
 955   }
 956   return *this;
 957 }
 958
 959 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
 960     const std::shared_ptr<ModelAPI_AttributeSelection>& theAttrSelect)
 961 {
 962   myDumpBuffer << "model.selection(";
 963
 964   if(!theAttrSelect->isInitialized()) {
 965     myDumpBuffer << ")";
 966     return *this;
 967   }
 968
 969   GeomShapePtr aShape = theAttrSelect->value();
 970   if(!aShape.get()) {
 971     aShape = theAttrSelect->context()->shape();
 972   }
 973
 974   if(!aShape.get()) {
 975     myDumpBuffer << ")";
 976     return *this;
 977   }
 978
 979   myDumpBuffer << "\"" << aShape->shapeTypeStr() << "\", \"" <<
 980     theAttrSelect->namingName() << "\")";
 981   return *this;
 982 }
 983
 984 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
 985     const std::shared_ptr<ModelAPI_AttributeSelectionList>& theAttrSelList)
 986 {
 987   static const int aThreshold = 2;
 988   // if number of elements in the list if greater than a threshold,
 989   // dump it in a separate line with specific name
 990   std::string aDumped = myDumpBuffer.str();
 991
 992   if (aDumped.empty() || theAttrSelList->size() <= aThreshold) {
 993     myDumpBuffer << "[";
 994
 995     GeomShapePtr aShape;
 996     std::string aShapeTypeStr;
 997
 998     bool isAdded = false;
 999
1000     for(int anIndex = 0; anIndex < theAttrSelList->size(); ++anIndex) {
1001       AttributeSelectionPtr anAttribute = theAttrSelList->value(anIndex);
1002       aShape = anAttribute->value();
1003       if(!aShape.get()) {
1004         ResultPtr aContext = anAttribute->context();
1005         if (aContext.get())
1006           aShape = aContext->shape();
1007       }
1008
1009       if(!aShape.get()) {
1010         continue;
1011       }
1012
1013       if(isAdded) {
1014         myDumpBuffer << ", ";
1015       } else {
1016         isAdded = true;
1017       }
1018       myDumpBuffer << "model.selection(\"" <<
1019         aShape->shapeTypeStr() << "\", \"" << anAttribute->namingName() << "\")";
1020     }
1021
1022     myDumpBuffer << "]";
1023   } else {
1024     // clear buffer and store list "as is"
1025     myDumpBuffer.str("");
1026     *this << theAttrSelList;
1027     // save buffer and clear it again
1028     std::string aDumpedList = myDumpBuffer.str();
1029     myDumpBuffer.str("");
1030     // obtain name of list (the feature may contain several selection lists)
1031     FeaturePtr anOwner = ModelAPI_Feature::feature(theAttrSelList->owner());
1032     std::string aListName = name(anOwner) + "_objects";
1033     std::list<AttributePtr> aSelLists =
1034         anOwner->data()->attributes(ModelAPI_AttributeSelectionList::typeId());
1035     if (aSelLists.size() > 1) {
1036       int anIndex = 1;
1037       for (std::list<AttributePtr>::iterator aSIt = aSelLists.begin();
1038            aSIt != aSelLists.end(); ++aSIt, ++anIndex)
1039         if ((*aSIt).get() == theAttrSelList.get())
1040           break;
1041       std::ostringstream aSStream;
1042       aSStream << aListName << "_" << anIndex;
1043       aListName = aSStream.str();
1044     }
1045     // store all previous data
1046     myDumpBuffer << aListName << " = " << aDumpedList << std::endl
1047                  << aDumped << aListName;
1048   }
1049   return *this;
1050 }
1051
1052 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
1053   const std::shared_ptr<ModelAPI_AttributeStringArray>& theArray)
1054 {
1055   myDumpBuffer<<"[";
1056   for(int anIndex = 0; anIndex < theArray->size(); ++anIndex) {
1057     if (anIndex != 0)
1058       myDumpBuffer<<", ";
1059
1060     myDumpBuffer<<"\""<<theArray->value(anIndex)<<"\"";
1061   }
1062
1063   myDumpBuffer<<"]";
1064   return *this;
1065 }
1066
1067 /// Dump std::endl
1068 ModelHighAPI_Dumper& operator<<(ModelHighAPI_Dumper& theDumper,
1069                                 std::basic_ostream<char>& (*theEndl)(std::basic_ostream<char>&))
1070 {
1071   theDumper.myDumpBuffer << theEndl;
1072
1073   if (!theDumper.myEntitiesStack.empty()) {
1074     bool isCopy;
1075     // all copies have been stored into stack, pop them all
1076     do {
1077       isCopy = false;
1078       // Name for composite feature is dumped when all sub-entities are dumped
1079       // (see method ModelHighAPI_Dumper::processSubs).
1080       const ModelHighAPI_Dumper::LastDumpedEntity& aLastDumped = theDumper.myEntitiesStack.top();
1081       CompositeFeaturePtr aComposite =
1082           std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aLastDumped.myEntity);
1083       if (!aComposite) {
1084         theDumper.dumpEntitySetName();
1085         FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(aLastDumped.myEntity);
1086         if (aFeature) {
1087           AttributeBooleanPtr aCopyAttr = aFeature->boolean("Copy");
1088           isCopy = aCopyAttr.get() && aCopyAttr->value();
1089         }
1090       }
1091     } while (isCopy && !theDumper.myEntitiesStack.empty());
1092   }
1093
1094   // store all not-dumped entities first
1095   std::set<EntityPtr> aNotDumped = theDumper.myNotDumpedEntities;
1096   std::string aBufCopy = theDumper.myDumpBuffer.str();
1097   theDumper.clear(true);
1098   std::set<EntityPtr>::const_iterator anIt = aNotDumped.begin();
1099   for (; anIt != aNotDumped.end(); ++anIt) {
1100     // if the feature is composite, dump it with all subs
1101     CompositeFeaturePtr aCompFeat =
1102         std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(*anIt);
1103     if (aCompFeat)
1104       theDumper.process(aCompFeat, true);
1105     else {
1106       FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(*anIt);
1107       theDumper.dumpFeature(aFeature, true);
1108       // dump the Projection feature which produces this "Copy" entity
1109       AttributeBooleanPtr aCopyAttr = aFeature->boolean("Copy");
1110       if (aCopyAttr.get() && aCopyAttr->value())
1111       {
1112         const std::set<AttributePtr>& aRefs = aFeature->data()->refsToMe();
1113         std::set<AttributePtr>::iterator aRefIt = aRefs.begin();
1114         for (; aRefIt != aRefs.end(); ++aRefIt)
1115           if ((*aRefIt)->id() == "ProjectedFeature")
1116           { // process projection only
1117             FeaturePtr anOwner = ModelAPI_Feature::feature((*aRefIt)->owner());
1118             if (anOwner && !theDumper.isDumped(EntityPtr(anOwner)))
1119               theDumper.dumpFeature(anOwner, true);
1120           }
1121       }
1122     }
1123   }
1124
1125   // avoid multiple empty lines
1126   size_t anInd = std::string::npos;
1127   while ((anInd = aBufCopy.find("\n\n\n")) != std::string::npos)
1128     aBufCopy.erase(anInd, 1);
1129   // then store currently dumped string
1130   theDumper.myFullDump << aBufCopy;
1131
1132   // now, store all postponed features
1133   theDumper.dumpPostponed();
1134
1135   return theDumper;
1136 }