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   // dump folders if any
 333   dumpPostponed(true);
 334   return isOk;
 335 }
 336
 337 bool ModelHighAPI_Dumper::processSubs(
 338   const std::shared_ptr<ModelAPI_CompositeFeature>& theComposite,
 339   bool theDumpModelDo)
 340 {
 341   bool isOk = true;
 342   // dump all sub-features;
 343   bool isSubDumped = false;
 344   int aNbSubs = theComposite->numberOfSubs();
 345   for (int anIndex = 0; anIndex < aNbSubs; ++anIndex) {
 346     FeaturePtr aFeature = theComposite->subFeature(anIndex);
 347     if (isDumped(EntityPtr(aFeature)))
 348       continue;
 349
 350     isSubDumped = true;
 351     CompositeFeaturePtr aCompFeat = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aFeature);
 352     if (aCompFeat) // iteratively process composite features
 353       isOk = process(aCompFeat) && isOk;
 354     else
 355       dumpFeature(aFeature, true);
 356   }
 357
 358   bool isDumpSetName = !myEntitiesStack.empty() &&
 359       myEntitiesStack.top().myEntity == EntityPtr(theComposite);
 360   bool isForceModelDo = isSubDumped && isDumpSetName &&
 361       (myEntitiesStack.top().myUserName || !myEntitiesStack.top().myResults.empty());
 362   // It is necessary for the sketch to create its result when complete (command "model.do()").
 363   // This option is set by flat theDumpModelDo.
 364   // However, nested sketches are rebuilt by parent feature, so, they do not need
 365   // explicit call of "model.do()". This will be controlled by the depth of the stack.
 366   if (isForceModelDo || (theDumpModelDo && gCompositeStackDepth <= 1))
 367     *this << "model.do()" << std::endl;
 368
 369   // dump "setName" for composite feature
 370   if (isDumpSetName)
 371     dumpEntitySetName();
 372   // dump folders if any
 373   dumpPostponed(true);
 374   return isOk;
 375 }
 376
 377 void ModelHighAPI_Dumper::postpone(const EntityPtr& theEntity)
 378 {
 379   // keep the name
 380   name(theEntity, false);
 381   myPostponed.push_back(theEntity);
 382 }
 383
 384 void ModelHighAPI_Dumper::dumpPostponed(bool theDumpFolders)
 385 {
 386   if (myDumpPostponedInProgress)
 387     return;
 388
 389   myDumpPostponedInProgress = true;
 390   // make a copy of postponed entities, because the list will be updated
 391   // if some features are not able to be dumped
 392   std::list<EntityPtr> aPostponedCopy = myPostponed;
 393   myPostponed.clear();
 394
 395   // iterate over postponed entities and try to dump them
 396   std::list<EntityPtr>::const_iterator anIt = aPostponedCopy.begin();
 397   for (; anIt != aPostponedCopy.end(); ++anIt) {
 398     FolderPtr aFolder = std::dynamic_pointer_cast<ModelAPI_Folder>(*anIt);
 399     if (aFolder) {
 400       if (theDumpFolders)
 401         dumpFolder(aFolder);
 402       else
 403         myPostponed.push_back(*anIt);
 404     }
 405     else {
 406       FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(*anIt);
 407       if (aFeature)
 408         dumpFeature(aFeature);
 409     }
 410   }
 411   myDumpPostponedInProgress = false;
 412 }
 413
 414 void ModelHighAPI_Dumper::dumpSubFeatureNameAndColor(const std::string theSubFeatureGet,
 415                                                      const FeaturePtr& theSubFeature)
 416 {
 417   name(theSubFeature, false);
 418   myNames[theSubFeature] = EntityName(theSubFeatureGet, theSubFeature->name(), false);
 419
 420   // store results if they have user-defined names or colors
 421   std::list<ResultPtr> aResultsWithNameOrColor;
 422   const std::list<ResultPtr>& aResults = theSubFeature->results();
 423   std::list<ResultPtr>::const_iterator aResIt = aResults.begin();
 424   for (; aResIt != aResults.end(); ++aResIt) {
 425     std::string aResName = (*aResIt)->data()->name();
 426     myNames[*aResIt] = EntityName(aResName, aResName, false);
 427     aResultsWithNameOrColor.push_back(*aResIt);
 428   }
 429
 430   // store just dumped entity to stack
 431   myEntitiesStack.push(LastDumpedEntity(theSubFeature, true, aResultsWithNameOrColor));
 432
 433   dumpEntitySetName();
 434 }
 435
 436 bool ModelHighAPI_Dumper::exportTo(const std::string& theFileName)
 437 {
 438   std::ofstream aFile;
 439   OSD_OpenStream(aFile, theFileName.c_str(), std::ofstream::out);
 440   if (!aFile.is_open())
 441     return false;
 442
 443   // standard header
 444   for (ModulesMap::const_iterator aModIt = myModules.begin();
 445        aModIt != myModules.end(); ++aModIt) {
 446     aFile << "from " << aModIt->first << " import ";
 447     if (aModIt->second.empty() ||
 448         aModIt->second.find(std::string()) != aModIt->second.end())
 449       aFile << "*"; // import whole module
 450     else {
 451       // import specific features
 452       std::set<std::string>::const_iterator anObjIt = aModIt->second.begin();
 453       aFile << *anObjIt;
 454       for (++anObjIt; anObjIt != aModIt->second.end(); ++anObjIt)
 455         aFile << ", " << *anObjIt;
 456     }
 457     aFile << std::endl;
 458   }
 459   if (!myModules.empty())
 460     aFile << std::endl;
 461
 462   aFile << "from salome.shaper import model" << std::endl << std::endl;
 463   aFile << "model.begin()" << std::endl;
 464
 465   // dump collected data
 466   aFile << myFullDump.str();
 467   aFile << myDumpBuffer.str();
 468
 469   // standard footer
 470   aFile << "model.end()" << std::endl;
 471
 472   aFile.close();
 473   clear();
 474
 475   return true;
 476 }
 477
 478 void ModelHighAPI_Dumper::importModule(const std::string& theModuleName,
 479                                        const std::string& theObject)
 480 {
 481   myModules[theModuleName].insert(theObject);
 482 }
 483
 484 void ModelHighAPI_Dumper::dumpEntitySetName()
 485 {
 486   const LastDumpedEntity& aLastDumped = myEntitiesStack.top();
 487
 488   // dump "setName" for the entity
 489   if (aLastDumped.myUserName) {
 490     EntityName& anEntityNames = myNames[aLastDumped.myEntity];
 491     if (!anEntityNames.myIsDefault)
 492       myDumpBuffer << anEntityNames.myCurrentName << ".setName(\""
 493                    << anEntityNames.myUserName << "\")" << std::endl;
 494     // don't dump "setName" for the entity twice
 495     anEntityNames.myUserName.clear();
 496     anEntityNames.myIsDefault = true;
 497   }
 498   // dump "setName" for results
 499   std::list<ResultPtr>::const_iterator aResIt = aLastDumped.myResults.begin();
 500   std::list<ResultPtr>::const_iterator aResEnd = aLastDumped.myResults.end();
 501   for (; aResIt != aResEnd; ++aResIt) {
 502     // set result name
 503     EntityName& anEntityNames = myNames[*aResIt];
 504     if (!anEntityNames.myIsDefault) {
 505       *this << *aResIt;
 506       myDumpBuffer << ".setName(\"" << anEntityNames.myUserName << "\")" << std::endl;
 507       // don't dump "setName" for the entity twice
 508       anEntityNames.myUserName.clear();
 509       anEntityNames.myIsDefault = true;
 510     }
 511     // set result color
 512     if (!isDefaultColor(*aResIt)) {
 513       AttributeIntArrayPtr aColor = (*aResIt)->data()->intArray(ModelAPI_Result::COLOR_ID());
 514       if (aColor && aColor->isInitialized()) {
 515         *this << *aResIt;
 516         myDumpBuffer << ".setColor(" << aColor->value(0) << ", " << aColor->value(1)
 517                      << ", " << aColor->value(2) << ")" << std::endl;
 518       }
 519     }
 520     // set result deflection
 521     if (!isDefaultDeflection(*aResIt)) {
 522       AttributeDoublePtr aDeflectionAttr =
 523         (*aResIt)->data()->real(ModelAPI_Result::DEFLECTION_ID());
 524       if(aDeflectionAttr.get() && aDeflectionAttr->isInitialized()) {
 525         *this << *aResIt;
 526         myDumpBuffer << ".setDeflection(" << aDeflectionAttr->value() << ")" << std::endl;
 527       }
 528     }
 529     // set result transparency
 530     if (!isDefaultTransparency(*aResIt)) {
 531       AttributeDoublePtr aTransparencyAttr =
 532         (*aResIt)->data()->real(ModelAPI_Result::TRANSPARENCY_ID());
 533       if(aTransparencyAttr.get() && aTransparencyAttr->isInitialized()) {
 534         *this << *aResIt;
 535         myDumpBuffer << ".setTransparency(" << aTransparencyAttr->value() << ")" << std::endl;
 536       }
 537     }
 538   }
 539
 540   myNames[aLastDumped.myEntity].myIsDumped = true;
 541   myEntitiesStack.pop();
 542 }
 543
 544 bool ModelHighAPI_Dumper::isDumped(const EntityPtr& theEntity) const
 545 {
 546   EntityNameMap::const_iterator aFound = myNames.find(theEntity);
 547   FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(theEntity);
 548   return (aFound != myNames.end() && aFound->second.myIsDumped) ||
 549          myFeaturesToSkip.find(aFeature) != myFeaturesToSkip.end();
 550 }
 551
 552 bool ModelHighAPI_Dumper::isDumped(const AttributeRefAttrPtr& theRefAttr) const
 553 {
 554   FeaturePtr aFeature;
 555   if (theRefAttr->isObject())
 556     aFeature = ModelAPI_Feature::feature(theRefAttr->object());
 557   else
 558     aFeature = ModelAPI_Feature::feature(theRefAttr->attr()->owner());
 559   return aFeature && isDumped(EntityPtr(aFeature));
 560 }
 561
 562 bool ModelHighAPI_Dumper::isDumped(const AttributeRefListPtr& theRefList) const
 563 {
 564   std::list<ObjectPtr> aRefs = theRefList->list();
 565   std::list<ObjectPtr>::iterator anIt = aRefs.begin();
 566   for (; anIt != aRefs.end(); ++anIt) {
 567     FeaturePtr aFeature = ModelAPI_Feature::feature(*anIt);
 568     if (aFeature && !isDumped(EntityPtr(aFeature)))
 569       return false;
 570   }
 571   return true;
 572 }
 573
 574 bool ModelHighAPI_Dumper::isDefaultColor(const ResultPtr& theResult) const
 575 {
 576   AttributeIntArrayPtr aColor = theResult->data()->intArray(ModelAPI_Result::COLOR_ID());
 577   if (!aColor || !aColor->isInitialized())
 578     return true;
 579
 580   std::string aSection, aName, aDefault;
 581   theResult->colorConfigInfo(aSection, aName, aDefault);
 582
 583   // dump current color
 584   std::ostringstream aColorInfo;
 585   aColorInfo << aColor->value(0) << "," << aColor->value(1) << "," << aColor->value(2);
 586
 587   return aDefault == aColorInfo.str();
 588 }
 589
 590 bool ModelHighAPI_Dumper::isDefaultDeflection(const ResultPtr& theResult) const
 591 {
 592   AttributeDoublePtr aDeflectionAttr = theResult->data()->real(ModelAPI_Result::DEFLECTION_ID());
 593   if(!aDeflectionAttr || !aDeflectionAttr->isInitialized()) {
 594     return true;
 595   }
 596
 597   double aCurrent = aDeflectionAttr->value();
 598   double aDefault = -1;
 599
 600   bool isConstruction = false;
 601   std::string aResultGroup = theResult->groupName();
 602   if (aResultGroup == ModelAPI_ResultConstruction::group())
 603     isConstruction = true;
 604   else if (aResultGroup == ModelAPI_ResultBody::group()) {
 605     GeomShapePtr aGeomShape = theResult->shape();
 606     if (aGeomShape.get()) {
 607       // if the shape could not be exploded on faces, it contains only wires, edges, and vertices
 608       // correction of deviation for them should not influence to the application performance
 609       GeomAPI_ShapeExplorer anExp(aGeomShape, GeomAPI_Shape::FACE);
 610       isConstruction = !anExp.more();
 611     }
 612   }
 613   if (isConstruction)
 614     aDefault = Config_PropManager::real("Visualization", "construction_deflection");
 615   else
 616     aDefault = Config_PropManager::real("Visualization", "body_deflection");
 617
 618   return fabs(aCurrent - aDefault) < 1.e-12;
 619 }
 620
 621 bool ModelHighAPI_Dumper::isDefaultTransparency(const ResultPtr& theResult) const
 622 {
 623   AttributeDoublePtr anAttribute = theResult->data()->real(ModelAPI_Result::TRANSPARENCY_ID());
 624   if(!anAttribute || !anAttribute->isInitialized()) {
 625     return true;
 626   }
 627   return fabs(anAttribute->value()) < 1.e-12;
 628 }
 629
 630 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const char theChar)
 631 {
 632   myDumpBuffer << theChar;
 633   return *this;
 634 }
 635
 636 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const char* theString)
 637 {
 638   myDumpBuffer << theString;
 639   return *this;
 640 }
 641
 642 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const std::string& theString)
 643 {
 644   myDumpBuffer << theString;
 645   return *this;
 646 }
 647
 648 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const bool theValue)
 649 {
 650   myDumpBuffer << (theValue ? "True" : "False");
 651   return *this;
 652 }
 653
 654 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const int theValue)
 655 {
 656   myDumpBuffer << theValue;
 657   return *this;
 658 }
 659
 660 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const double theValue)
 661 {
 662   myDumpBuffer << theValue;
 663   return *this;
 664 }
 665
 666 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const std::shared_ptr<GeomAPI_Pnt>& thePoint)
 667 {
 668   importModule("GeomAPI", "GeomAPI_Pnt");
 669   myDumpBuffer << "GeomAPI_Pnt(" << thePoint->x() << ", "
 670                << thePoint->y() << ", " << thePoint->z() << ")";
 671   return *this;
 672 }
 673
 674 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const std::shared_ptr<GeomAPI_Dir>& theDir)
 675 {
 676   importModule("GeomAPI", "GeomAPI_Dir");
 677   myDumpBuffer << "GeomAPI_Dir(" << theDir->x() << ", "
 678                << theDir->y() << ", " << theDir->z() << ")";
 679   return *this;
 680 }
 681
 682 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
 683     const std::shared_ptr<GeomDataAPI_Dir>& theDir)
 684 {
 685   myDumpBuffer << theDir->x() << ", " << theDir->y() << ", " << theDir->z();
 686   return *this;
 687 }
 688
 689 static void dumpArray(std::ostringstream& theOutput, int theSize,
 690                       double* theValues, std::string* theTexts)
 691 {
 692   for (int i = 0; i < theSize; ++i) {
 693     if (i > 0)
 694       theOutput << ", ";
 695     if (theTexts[i].empty())
 696       theOutput << theValues[i];
 697     else
 698       theOutput << "\"" << theTexts[i] << "\"";
 699   }
 700 }
 701
 702 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
 703     const std::shared_ptr<GeomDataAPI_Point>& thePoint)
 704 {
 705   static const int aSize = 3;
 706   double aValues[aSize] = {thePoint->x(), thePoint->y(), thePoint->z()};
 707   std::string aTexts[aSize] = {thePoint->textX(), thePoint->textY(), thePoint->textZ()};
 708   dumpArray(myDumpBuffer, aSize, aValues, aTexts);
 709   return *this;
 710 }
 711
 712 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
 713     const std::shared_ptr<GeomDataAPI_Point2D>& thePoint)
 714 {
 715   static const int aSize = 2;
 716   double aValues[aSize] = {thePoint->x(), thePoint->y()};
 717   std::string aTexts[aSize] = {thePoint->textX(), thePoint->textY()};
 718   dumpArray(myDumpBuffer, aSize, aValues, aTexts);
 719   return *this;
 720 }
 721
 722 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
 723     const std::shared_ptr<ModelAPI_AttributeBoolean>& theAttrBool)
 724 {
 725   myDumpBuffer << (theAttrBool->value() ? "True" : "False");
 726   return *this;
 727 }
 728
 729 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
 730     const std::shared_ptr<ModelAPI_AttributeInteger>& theAttrInt)
 731 {
 732   std::string aText = theAttrInt->text();
 733   if (aText.empty())
 734     myDumpBuffer << theAttrInt->value();
 735   else
 736     myDumpBuffer << "\"" << aText << "\"";
 737   return *this;
 738 }
 739
 740 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
 741     const std::shared_ptr<ModelAPI_AttributeDouble>& theAttrReal)
 742 {
 743   std::string aText = theAttrReal->text();
 744   if (aText.empty())
 745     myDumpBuffer << theAttrReal->value();
 746   else
 747     myDumpBuffer << "\"" << aText << "\"";
 748   return *this;
 749 }
 750
 751 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
 752     const std::shared_ptr<ModelAPI_AttributeString>& theAttrStr)
 753 {
 754   myDumpBuffer << "\"" << theAttrStr->value() << "\"";
 755   return *this;
 756 }
 757
 758 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const FolderPtr& theFolder)
 759 {
 760   myDumpBuffer << name(theFolder);
 761   return *this;
 762 }
 763
 764 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const FeaturePtr& theEntity)
 765 {
 766   myDumpBuffer << name(theEntity);
 767
 768   if (!myNames[theEntity].myIsDumped) {
 769     bool isUserDefinedName = !myNames[theEntity].myIsDefault;
 770     // store results if they have user-defined names or colors
 771     std::list<ResultPtr> aResultsWithNameOrColor;
 772     const std::list<ResultPtr>& aResults = theEntity->results();
 773     std::list<ResultPtr>::const_iterator aResIt = aResults.begin();
 774     for (; aResIt != aResults.end(); ++aResIt) {
 775       if (!myNames[*aResIt].myIsDefault || !isDefaultColor(*aResIt) ||
 776           !isDefaultDeflection(*aResIt) || !isDefaultTransparency(*aResIt))
 777         aResultsWithNameOrColor.push_back(*aResIt);
 778
 779       ResultCompSolidPtr aCompSolid =
 780           std::dynamic_pointer_cast<ModelAPI_ResultCompSolid>(*aResIt);
 781       if (aCompSolid) {
 782         int aNbSubs = aCompSolid->numberOfSubs();
 783         for (int i = 0; i < aNbSubs; ++i) {
 784           ResultPtr aCurRes = aCompSolid->subResult(i);
 785           if (!myNames[aCurRes].myIsDefault || !isDefaultColor(aCurRes) ||
 786               !isDefaultDeflection(aCurRes) || !isDefaultTransparency(aCurRes))
 787             aResultsWithNameOrColor.push_back(aCurRes);
 788         }
 789       }
 790     }
 791     // store just dumped entity to stack
 792     if (myEntitiesStack.empty() || myEntitiesStack.top().myEntity != theEntity)
 793       myEntitiesStack.push(
 794           LastDumpedEntity(theEntity, isUserDefinedName, aResultsWithNameOrColor));
 795   }
 796
 797   // remove entity from the list of not dumped items
 798   myNotDumpedEntities.erase(theEntity);
 799   return *this;
 800 }
 801
 802 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const ResultPtr& theResult)
 803 {
 804   FeaturePtr aFeature = ModelAPI_Feature::feature(theResult);
 805   int anIndex = 0;
 806   int aSubIndex = -1;
 807   std::list<ResultPtr> aResults = aFeature->results();
 808   for(std::list<ResultPtr>::const_iterator
 809       anIt = aResults.cbegin(); anIt != aResults.cend(); ++anIt, ++anIndex) {
 810     if(theResult->isSame(*anIt)) {
 811       break;
 812     }
 813
 814     ResultCompSolidPtr aCompSolid = std::dynamic_pointer_cast<ModelAPI_ResultCompSolid>(*anIt);
 815     if (aCompSolid) {
 816       int aNbSubs = aCompSolid->numberOfSubs();
 817       for (aSubIndex = 0; aSubIndex < aNbSubs; ++aSubIndex)
 818         if (theResult->isSame(aCompSolid->subResult(aSubIndex)))
 819           break;
 820       if (aSubIndex < aNbSubs)
 821         break;
 822       aSubIndex = -1;
 823     }
 824   }
 825
 826   myDumpBuffer << name(aFeature);
 827   if(anIndex == 0) {
 828     myDumpBuffer << ".result()";
 829   } else {
 830     myDumpBuffer << ".results()[" << anIndex << "]";
 831   }
 832   if (aSubIndex >= 0) {
 833     myDumpBuffer << ".subResult(" << aSubIndex << ")";
 834   }
 835   return *this;
 836 }
 837
 838 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const ObjectPtr& theObject)
 839 {
 840   FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(theObject);
 841   if(aFeature.get()) {
 842     myDumpBuffer << name(aFeature);
 843     return *this;
 844   }
 845
 846   ResultPtr aResult = std::dynamic_pointer_cast<ModelAPI_Result>(theObject);
 847   if(aResult.get()) {
 848     *this << aResult;
 849     return *this;
 850   }
 851
 852   return *this;
 853 }
 854
 855 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(const AttributePtr& theAttr)
 856 {
 857   FeaturePtr anOwner = ModelAPI_Feature::feature(theAttr->owner());
 858
 859   std::string aWrapperPrefix, aWrapperSuffix;
 860   // Check the attribute belongs to copied (in multi-translation or multi-rotation) feature.
 861   // In this case we need to cast explicitly feature to appropriate type.
 862   AttributeBooleanPtr isCopy = anOwner->boolean("Copy");
 863   if (isCopy.get() && isCopy->value()) {
 864     aWrapperPrefix = featureWrapper(anOwner) + "(";
 865     aWrapperSuffix = ")";
 866     importModule("SketchAPI");
 867   }
 868
 869   myDumpBuffer << aWrapperPrefix << name(anOwner) << aWrapperSuffix
 870                << "." << attributeGetter(anOwner, theAttr->id()) << "()";
 871   return *this;
 872 }
 873
 874 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
 875     const std::shared_ptr<ModelAPI_AttributeRefAttr>& theRefAttr)
 876 {
 877   if (theRefAttr->isObject())
 878     *this << theRefAttr->object();
 879   else
 880     *this << theRefAttr->attr();
 881   return *this;
 882 }
 883
 884 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
 885     const std::shared_ptr<ModelAPI_AttributeRefAttrList>& theRefAttrList)
 886 {
 887   myDumpBuffer << "[";
 888   std::list<std::pair<ObjectPtr, AttributePtr> > aList = theRefAttrList->list();
 889   bool isAdded = false;
 890   std::list<std::pair<ObjectPtr, AttributePtr> >::const_iterator anIt = aList.begin();
 891   for (; anIt != aList.end(); ++anIt) {
 892     if (isAdded)
 893       myDumpBuffer << ", ";
 894     else
 895       isAdded = true;
 896     if (anIt->first)
 897       *this << anIt->first;
 898     else if (anIt->second)
 899       * this << anIt->second;
 900   }
 901   myDumpBuffer << "]";
 902   return *this;
 903 }
 904
 905 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
 906     const std::shared_ptr<ModelAPI_AttributeReference>& theReference)
 907 {
 908   *this << theReference->value();
 909   return *this;
 910 }
 911
 912 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
 913     const std::shared_ptr<ModelAPI_AttributeRefList>& theRefList)
 914 {
 915   static const int aThreshold = 2;
 916   // if number of elements in the list if greater than a threshold,
 917   // dump it in a separate line with specific name
 918   std::string aDumped = myDumpBuffer.str();
 919   if (aDumped.empty() || theRefList->size() <= aThreshold) {
 920     myDumpBuffer << "[";
 921     std::list<ObjectPtr> aList = theRefList->list();
 922     bool isAdded = false;
 923     std::list<ObjectPtr>::const_iterator anIt = aList.begin();
 924     for (; anIt != aList.end(); ++anIt) {
 925       if (isAdded)
 926         myDumpBuffer << ", ";
 927       else
 928         isAdded = true;
 929
 930       *this << *anIt;
 931     }
 932     myDumpBuffer << "]";
 933   } else {
 934     // clear buffer and store list "as is"
 935     myDumpBuffer.str("");
 936     *this << theRefList;
 937     // save buffer and clear it again
 938     std::string aDumpedList = myDumpBuffer.str();
 939     myDumpBuffer.str("");
 940     // obtain name of list
 941     FeaturePtr anOwner = ModelAPI_Feature::feature(theRefList->owner());
 942     std::string aListName = name(anOwner) + "_objects";
 943     // store all previous data
 944     myDumpBuffer << aListName << " = " << aDumpedList << std::endl
 945                  << aDumped << aListName;
 946   }
 947   return *this;
 948 }
 949
 950 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
 951     const std::shared_ptr<ModelAPI_AttributeSelection>& theAttrSelect)
 952 {
 953   myDumpBuffer << "model.selection(";
 954
 955   if(!theAttrSelect->isInitialized()) {
 956     myDumpBuffer << ")";
 957     return *this;
 958   }
 959
 960   GeomShapePtr aShape = theAttrSelect->value();
 961   if(!aShape.get()) {
 962     aShape = theAttrSelect->context()->shape();
 963   }
 964
 965   if(!aShape.get()) {
 966     myDumpBuffer << ")";
 967     return *this;
 968   }
 969
 970   myDumpBuffer << "\"" << aShape->shapeTypeStr() << "\", \"" <<
 971     theAttrSelect->namingName() << "\")";
 972   return *this;
 973 }
 974
 975 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
 976     const std::shared_ptr<ModelAPI_AttributeSelectionList>& theAttrSelList)
 977 {
 978   myDumpBuffer << "[";
 979
 980   GeomShapePtr aShape;
 981   std::string aShapeTypeStr;
 982
 983   bool isAdded = false;
 984
 985   for(int anIndex = 0; anIndex < theAttrSelList->size(); ++anIndex) {
 986     AttributeSelectionPtr anAttribute = theAttrSelList->value(anIndex);
 987     aShape = anAttribute->value();
 988     if(!aShape.get()) {
 989       ResultPtr aContext = anAttribute->context();
 990       if (aContext.get())
 991         aShape = aContext->shape();
 992     }
 993
 994     if(!aShape.get()) {
 995       continue;
 996     }
 997
 998     if(isAdded) {
 999       myDumpBuffer << ", ";
1000     } else {
1001       isAdded = true;
1002     }
1003     myDumpBuffer << "model.selection(\"" <<
1004       aShape->shapeTypeStr() << "\", \"" << anAttribute->namingName() << "\")";
1005   }
1006
1007   myDumpBuffer << "]";
1008   return *this;
1009 }
1010
1011 ModelHighAPI_Dumper& ModelHighAPI_Dumper::operator<<(
1012   const std::shared_ptr<ModelAPI_AttributeStringArray>& theArray)
1013 {
1014   myDumpBuffer<<"[";
1015   for(int anIndex = 0; anIndex < theArray->size(); ++anIndex) {
1016     if (anIndex != 0)
1017       myDumpBuffer<<", ";
1018
1019     myDumpBuffer<<"\""<<theArray->value(anIndex)<<"\"";
1020   }
1021
1022   myDumpBuffer<<"]";
1023   return *this;
1024 }
1025
1026 /// Dump std::endl
1027 ModelHighAPI_Dumper& operator<<(ModelHighAPI_Dumper& theDumper,
1028                                 std::basic_ostream<char>& (*theEndl)(std::basic_ostream<char>&))
1029 {
1030   theDumper.myDumpBuffer << theEndl;
1031
1032   if (!theDumper.myEntitiesStack.empty()) {
1033     bool isCopy;
1034     // all copies have been stored into stack, pop them all
1035     do {
1036       isCopy = false;
1037       // Name for composite feature is dumped when all sub-entities are dumped
1038       // (see method ModelHighAPI_Dumper::processSubs).
1039       const ModelHighAPI_Dumper::LastDumpedEntity& aLastDumped = theDumper.myEntitiesStack.top();
1040       CompositeFeaturePtr aComposite =
1041           std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aLastDumped.myEntity);
1042       if (!aComposite) {
1043         theDumper.dumpEntitySetName();
1044         FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(aLastDumped.myEntity);
1045         if (aFeature) {
1046           AttributeBooleanPtr aCopyAttr = aFeature->boolean("Copy");
1047           isCopy = aCopyAttr.get() && aCopyAttr->value();
1048         }
1049       }
1050     } while (isCopy && !theDumper.myEntitiesStack.empty());
1051   }
1052
1053   // store all not-dumped entities first
1054   std::set<EntityPtr> aNotDumped = theDumper.myNotDumpedEntities;
1055   std::string aBufCopy = theDumper.myDumpBuffer.str();
1056   theDumper.clear(true);
1057   std::set<EntityPtr>::const_iterator anIt = aNotDumped.begin();
1058   for (; anIt != aNotDumped.end(); ++anIt) {
1059     // if the feature is composite, dump it with all subs
1060     CompositeFeaturePtr aCompFeat =
1061         std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(*anIt);
1062     if (aCompFeat)
1063       theDumper.process(aCompFeat, true);
1064     else {
1065       FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(*anIt);
1066       theDumper.dumpFeature(aFeature, true);
1067       // dump the Projection feature which produces this "Copy" entity
1068       AttributeBooleanPtr aCopyAttr = aFeature->boolean("Copy");
1069       if (aCopyAttr.get() && aCopyAttr->value())
1070       {
1071         const std::set<AttributePtr>& aRefs = aFeature->data()->refsToMe();
1072         std::set<AttributePtr>::iterator aRefIt = aRefs.begin();
1073         for (; aRefIt != aRefs.end(); ++aRefIt)
1074           if ((*aRefIt)->id() == "ProjectedFeature")
1075           { // process projection only
1076             FeaturePtr anOwner = ModelAPI_Feature::feature((*aRefIt)->owner());
1077             if (anOwner && !theDumper.isDumped(EntityPtr(anOwner)))
1078               theDumper.dumpFeature(anOwner, true);
1079           }
1080       }
1081     }
1082   }
1083
1084   // avoid multiple empty lines
1085   size_t anInd = std::string::npos;
1086   while ((anInd = aBufCopy.find("\n\n\n")) != std::string::npos)
1087     aBufCopy.erase(anInd, 1);
1088   // then store currently dumped string
1089   theDumper.myFullDump << aBufCopy;
1090
1091   // now, store all postponed features
1092   theDumper.dumpPostponed();
1093
1094   return theDumper;
1095 }