src/Model/Model_Document.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 <Model_Document.h>
  21 #include <Model_Data.h>
  22 #include <Model_Objects.h>
  23 #include <Model_Application.h>
  24 #include <Model_Session.h>
  25 #include <Model_Events.h>
  26 #include <Model_Tools.h>
  27 #include <ModelAPI_ResultPart.h>
  28 #include <ModelAPI_Validator.h>
  29 #include <ModelAPI_CompositeFeature.h>
  30 #include <ModelAPI_AttributeSelectionList.h>
  31 #include <ModelAPI_Tools.h>
  32 #include <ModelAPI_ResultBody.h>
  33 #include <Events_Loop.h>
  34 #include <Events_InfoMessage.h>
  35 #include <GeomAPI_Tools.h>
  36
  37 #include <TDataStd_Integer.hxx>
  38 #include <TDataStd_Comment.hxx>
  39 #include <TDF_ChildIDIterator.hxx>
  40 #include <TDataStd_ReferenceArray.hxx>
  41 #include <TDataStd_ReferenceList.hxx>
  42 #include <TDataStd_IntegerArray.hxx>
  43 #include <TDataStd_HLabelArray1.hxx>
  44 #include <TDataStd_Name.hxx>
  45 #include <TDataStd_AsciiString.hxx>
  46 #include <TDF_Reference.hxx>
  47 #include <TDF_ChildIDIterator.hxx>
  48 #include <TDF_Delta.hxx>
  49 #include <TDF_AttributeDelta.hxx>
  50 #include <TDF_AttributeDeltaList.hxx>
  51 #include <TDF_ListIteratorOfAttributeDeltaList.hxx>
  52 #include <TDF_ListIteratorOfLabelList.hxx>
  53 #include <TDF_LabelMap.hxx>
  54 #include <TDF_Tool.hxx>
  55 #include <TDF_DeltaOnAddition.hxx>
  56 #include <TDataStd_ExtStringList.hxx>
  57 #include <TDataStd_UAttribute.hxx>
  58 #include <TNaming_Builder.hxx>
  59 #include <TNaming_SameShapeIterator.hxx>
  60 #include <TNaming_Iterator.hxx>
  61 #include <TNaming_NamedShape.hxx>
  62 #include <TNaming_Tool.hxx>
  63 #include <TNaming_OldShapeIterator.hxx>
  64 #include <TopTools_DataMapOfShapeShape.hxx>
  65 #include <TopTools_ListOfShape.hxx>
  66
  67 #include <TopExp_Explorer.hxx>
  68 #include <TopoDS_Shape.hxx>
  69
  70 #include <OSD_Directory.hxx>
  71 #include <OSD_File.hxx>
  72 #include <OSD_Path.hxx>
  73 #include <OSD_Protection.hxx>
  74 #include <CDF_Session.hxx>
  75 #include <CDF_Directory.hxx>
  76 #include <UTL.hxx>
  77
  78 #include <climits>
  79 #ifndef WIN32
  80 #include <sys/stat.h>
  81 #endif
  82
  83 #ifdef WIN32
  84 # define _separator_ '\\'
  85 #else
  86 # define _separator_ '/'
  87 #endif
  88
  89 static const int UNDO_LIMIT = 1000;  // number of possible undo operations (big for sketcher)
  90
  91 static const int TAG_GENERAL = 1;  // general properties tag
  92
  93 // general sub-labels
  94 /// where the reference to the current feature label is located (or no attribute if null feature)
  95 static const int TAG_CURRENT_FEATURE = 1; ///< reference to the current feature
  96 /// integer, index of the transaction + GUID for auto recomputation blocking
  97 static const int TAG_CURRENT_TRANSACTION = 2;
  98 static const int TAG_SELECTION_FEATURE = 3; ///< integer, tag of the selection feature label
  99 static const int TAG_NODES_STATE = 4; ///< array, tag of the Object Browser nodes states
 100 ///< naming structures constructions selected from other document
 101 static const int TAG_EXTERNAL_CONSTRUCTIONS = 5;
 102
 103 /// reference to the shape in external document: sting list attribute identifier
 104 static const Standard_GUID kEXTERNAL_SHAPE_REF("9aa5dd14-6d34-4a8d-8786-05842fd7bbbd");
 105
 106 Model_Document::Model_Document(const int theID, const std::string theKind)
 107     : myID(theID), myKind(theKind), myIsActive(false), myIsSetCurrentFeature(false),
 108       myDoc(new TDocStd_Document("BinOcaf"))  // binary OCAF format
 109 {
 110 #ifdef TINSPECTOR
 111   CDF_Session::CurrentSession()->Directory()->Add(myDoc);
 112 #endif
 113   myObjs = new Model_Objects(myDoc->Main());
 114   myDoc->SetUndoLimit(UNDO_LIMIT);
 115   myTransactionSave = 0;
 116   myExecuteFeatures = true;
 117   // to have something in the document and avoid empty doc open/save problem
 118   // in transaction for nesting correct working
 119   myDoc->NewCommand();
 120   TDataStd_Integer::Set(myDoc->Main().Father(), 0);
 121   // this to avoid creation of integer attribute outside the transaction after undo
 122   transactionID();
 123   myDoc->CommitCommand();
 124 }
 125
 126 void Model_Document::setThis(DocumentPtr theDoc)
 127 {
 128   myObjs->setOwner(theDoc);
 129 }
 130
 131 /// Returns the file name of this document by the name of directory and identifier of a document
 132 static TCollection_ExtendedString DocFileName(const char* theDirName, const std::string& theID)
 133 {
 134   TCollection_ExtendedString aPath((const Standard_CString) theDirName);
 135   // remove end-separators
 136   while(aPath.Length() &&
 137         (aPath.Value(aPath.Length()) == '\\' || aPath.Value(aPath.Length()) == '/'))
 138     aPath.Remove(aPath.Length());
 139   aPath += _separator_;
 140   aPath += theID.c_str();
 141   aPath += ".cbf";  // standard binary file extension
 142   return aPath;
 143 }
 144
 145 bool Model_Document::isRoot() const
 146 {
 147   return this == Model_Session::get()->moduleDocument().get();
 148 }
 149
 150 // LCOV_EXCL_START
 151 /// Makes all modification and generation naming shapes that have old shapes corresponding to
 152 /// shapes in a root document be equal to this root document
 153 static void updateShapesFromRoot(const TDF_Label theThisAccess, const TDF_Label theRootAccess)
 154 {
 155   TopTools_DataMapOfShapeShape aCurrentToRoot; // shapes that must be updated: from this to root
 156   TDF_ChildIDIterator aThisIter(theThisAccess.Root(), kEXTERNAL_SHAPE_REF, true);
 157   for(; aThisIter.More(); aThisIter.Next()) {
 158     aCurrentToRoot.Clear();
 159     Handle(TNaming_NamedShape) aNS;
 160     if (!aThisIter.Value()->Label().FindAttribute(TNaming_NamedShape::GetID(), aNS))
 161       continue;
 162     if (aNS->Evolution() != TNaming_GENERATED && aNS->Evolution() != TNaming_MODIFY)
 163       continue;
 164     for (TNaming_Iterator aNSIter(aNS); aNSIter.More(); aNSIter.Next()) {
 165       const TopoDS_Shape& anOld = aNSIter.OldShape();
 166       if (anOld.IsNull())
 167         continue;
 168       TNaming_OldShapeIterator aNewIter(anOld, theThisAccess);
 169       for (; aNewIter.More(); aNewIter.Next()) {
 170         TNaming_Evolution anEvolution = aNewIter.NamedShape()->Evolution();
 171         if (anEvolution != TNaming_SELECTED && anEvolution != TNaming_DELETE)
 172           break;
 173       }
 174       if (aNewIter.More())
 175         continue;
 176       GeomShapePtr anOldShape(new GeomAPI_Shape), aRootShape(new GeomAPI_Shape);
 177       anOldShape->setImpl<TopoDS_Shape>(new TopoDS_Shape(anOld));
 178       anOldShape = GeomAPI_Tools::getTypedShape(anOldShape);
 179
 180       // search the same shape in the root document
 181       Handle(TDataStd_ExtStringList) anEntries =
 182         Handle(TDataStd_ExtStringList)::DownCast(aThisIter.Value());
 183       TDataStd_ListOfExtendedString::Iterator anIter(anEntries->List());
 184       for (; anIter.More(); anIter.Next()) {
 185         TDF_Label aRootLab;
 186         TDF_Tool::Label(theRootAccess.Data(), anIter.Value(), aRootLab);
 187         if (aRootLab.IsNull())
 188           continue;
 189         Handle(TNaming_NamedShape) aRootNS;
 190         if (!aRootLab.FindAttribute(TNaming_NamedShape::GetID(), aRootNS))
 191           continue;
 192         TNaming_Iterator aRootShapes(aRootNS);
 193         for (; aRootShapes.More(); aRootShapes.Next()) {
 194           if (aRootShapes.NewShape().IsNull())
 195             continue;
 196           aRootShape->setImpl(new TopoDS_Shape(aRootShapes.NewShape()));
 197           aRootShape = GeomAPI_Tools::getTypedShape(aRootShape);
 198           if (!anOldShape->isEqual(aRootShape)) // special checking by geometry
 199             continue;
 200           // found a good corresponded shape
 201           if (!anOld.IsEqual(aRootShapes.NewShape()))
 202             aCurrentToRoot.Bind(anOld, aRootShapes.NewShape());
 203         }
 204       }
 205     }
 206     if (!aCurrentToRoot.IsEmpty()) { // update the whole named shape content
 207       TopTools_ListOfShape anOld, aNew;
 208       TNaming_Evolution anEvol = aNS->Evolution();
 209       for(TNaming_Iterator aNSIter(aNS); aNSIter.More(); aNSIter.Next()) {
 210         anOld.Prepend(aCurrentToRoot.IsBound(aNSIter.OldShape()) ?
 211           aCurrentToRoot.Find(aNSIter.OldShape()) : aNSIter.OldShape());
 212         aNew.Prepend(aNSIter.NewShape());
 213       }
 214       TNaming_Builder aBuilder(aNS->Label());
 215       TopTools_ListOfShape::Iterator anOldIter(anOld), aNewIter(aNew);
 216       for(; anOldIter.More(); anOldIter.Next(), aNewIter.Next()) {
 217         if (anEvol == TNaming_GENERATED) {
 218           aBuilder.Generated(anOldIter.Value(), aNewIter.Value());
 219         } else if (anEvol == TNaming_MODIFY) {
 220           aBuilder.Modify(anOldIter.Value(), aNewIter.Value());
 221         }
 222       }
 223     }
 224   }
 225 }
 226 // LCOV_EXCL_STOP
 227
 228 static bool loadDocument(Handle(Model_Application) theApp,
 229                          Handle(TDocStd_Document)& theDoc,
 230                          const TCollection_ExtendedString& theFilename)
 231 {
 232   PCDM_ReaderStatus aStatus = (PCDM_ReaderStatus)-1;
 233   try {
 234     aStatus = theApp->Open(theFilename, theDoc);
 235   } catch (Standard_Failure const& anException) {
 236     Events_InfoMessage("Model_Document",
 237         "Exception in opening of document: %1").arg(anException.GetMessageString()).send();
 238     return false;
 239   }
 240   bool isOk = aStatus == PCDM_RS_OK;
 241   if (!isOk) {
 242     // LCOV_EXCL_START
 243     switch (aStatus) {
 244       case PCDM_RS_UnknownDocument:
 245         Events_InfoMessage("Model_Document", "Can not open document").send();
 246         break;
 247       case PCDM_RS_AlreadyRetrieved:
 248         Events_InfoMessage("Model_Document", "Can not open document: already opened").send();
 249         break;
 250       case PCDM_RS_AlreadyRetrievedAndModified:
 251         Events_InfoMessage("Model_Document",
 252             "Can not open document: already opened and modified").send();
 253         break;
 254       case PCDM_RS_NoDriver:
 255         Events_InfoMessage("Model_Document",
 256                            "Can not open document: driver library is not found").send();
 257         break;
 258       case PCDM_RS_UnknownFileDriver:
 259         Events_InfoMessage("Model_Document",
 260                            "Can not open document: unknown driver for opening").send();
 261         break;
 262       case PCDM_RS_OpenError:
 263         Events_InfoMessage("Model_Document", "Can not open document: file open error").send();
 264         break;
 265       case PCDM_RS_NoVersion:
 266         Events_InfoMessage("Model_Document", "Can not open document: invalid version").send();
 267         break;
 268       case PCDM_RS_NoModel:
 269         Events_InfoMessage("Model_Document", "Can not open document: no data model").send();
 270         break;
 271       case PCDM_RS_NoDocument:
 272         Events_InfoMessage("Model_Document", "Can not open document: no document inside").send();
 273         break;
 274       case PCDM_RS_FormatFailure:
 275         Events_InfoMessage("Model_Document", "Can not open document: format failure").send();
 276         break;
 277       case PCDM_RS_TypeNotFoundInSchema:
 278         Events_InfoMessage("Model_Document", "Can not open document: invalid object").send();
 279         break;
 280       case PCDM_RS_UnrecognizedFileFormat:
 281         Events_InfoMessage("Model_Document",
 282                            "Can not open document: unrecognized file format").send();
 283         break;
 284       case PCDM_RS_MakeFailure:
 285         Events_InfoMessage("Model_Document", "Can not open document: make failure").send();
 286         break;
 287       case PCDM_RS_PermissionDenied:
 288         Events_InfoMessage("Model_Document", "Can not open document: permission denied").send();
 289         break;
 290       case PCDM_RS_DriverFailure:
 291         Events_InfoMessage("Model_Document", "Can not open document: driver failure").send();
 292         break;
 293       default:
 294         Events_InfoMessage("Model_Document", "Can not open document: unknown error").send();
 295         break;
 296     }
 297     // LCOV_EXCL_STOP
 298   }
 299   return isOk;
 300 }
 301
 302 bool Model_Document::load(const char* theDirName, const char* theFileName, DocumentPtr theThis)
 303 {
 304   Handle(Model_Application) anApp = Model_Application::getApplication();
 305   if (isRoot()) {
 306     anApp->setLoadPath(theDirName);
 307   }
 308   TCollection_ExtendedString aPath(DocFileName(theDirName, theFileName));
 309   Handle(TDocStd_Document) aLoaded;
 310   bool isOk = loadDocument(anApp, aLoaded, aPath);
 311
 312   std::shared_ptr<Model_Session> aSession =
 313     std::dynamic_pointer_cast<Model_Session>(Model_Session::get());
 314   if (isOk) {
 315     myDoc = aLoaded;
 316     myDoc->SetUndoLimit(UNDO_LIMIT);
 317
 318     // to avoid the problem that feature is created in the current, not this, document
 319     aSession->setActiveDocument(anApp->document(myID), false);
 320     aSession->setCheckTransactions(false);
 321     if (myObjs)
 322       delete myObjs;
 323     myObjs = new Model_Objects(myDoc->Main()); // synchronization is inside
 324     myObjs->setOwner(theThis);
 325     // update the current features status
 326     setCurrentFeature(currentFeature(false), false);
 327     aSession->setCheckTransactions(true);
 328     aSession->setActiveDocument(aSession->moduleDocument(), false);
 329     // this is done in Part result "activate", so no needed here. Causes not-blue active part.
 330     // aSession->setActiveDocument(anApp->getDocument(myID), true);
 331
 332     // make sub-parts as loaded by demand
 333     std::list<ResultPtr> aPartResults;
 334     myObjs->allResults(ModelAPI_ResultPart::group(), aPartResults);
 335     std::list<ResultPtr>::iterator aPartRes = aPartResults.begin();
 336     for(; aPartRes != aPartResults.end(); aPartRes++) {
 337       ResultPartPtr aPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(*aPartRes);
 338       if (aPart.get())
 339         anApp->setLoadByDemand(aPart->data()->name(),
 340           aPart->data()->document(ModelAPI_ResultPart::DOC_REF())->docId());
 341     }
 342     if (!isRoot()) {
 343       updateShapesFromRoot(myDoc->Main(),
 344         std::dynamic_pointer_cast<Model_Document>(aSession->moduleDocument())->generalLabel());
 345     }
 346   } else { // open failed, but new document was created to work with it: inform the model
 347     aSession->setActiveDocument(Model_Session::get()->moduleDocument(), false);
 348   }
 349   return isOk;
 350 }
 351
 352 bool Model_Document::importPart(const char* theFileName,
 353                                 std::list<std::shared_ptr<ModelAPI_Feature> >& theImported,
 354                                 bool theCheckOnly)
 355 {
 356   Handle(Model_Application) anApp = Model_Application::getApplication();
 357   TCollection_ExtendedString aFormat;
 358   if (!anApp->Format(theFileName, aFormat))
 359     return false;
 360
 361   Handle(TDocStd_Document) aTempDoc;
 362   bool isOk = loadDocument(anApp, aTempDoc, theFileName);
 363
 364   if (isOk && theCheckOnly) {
 365     // verify all features are applicable for the current document type (e.g. PartSet)
 366     std::shared_ptr<Model_Session> aSession =
 367         std::dynamic_pointer_cast<Model_Session>(ModelAPI_Session::get());
 368     for (TDF_ChildIterator anIt(aTempDoc->Main()); anIt.More() && isOk; anIt.Next()) {
 369       TDF_Label aCurrentLab = anIt.Value();
 370       Handle(TDataStd_Comment) aFeatureID;
 371       TDF_Label aNewFeatuerLab;
 372       if (aCurrentLab.FindAttribute(TDataStd_Comment::GetID(), aFeatureID)) {
 373         TCollection_AsciiString anID(aFeatureID->Get());
 374         std::string aFeatureKind(anID.ToCString());
 375         if (aSession->myPlugins.find(aFeatureKind) != aSession->myPlugins.end()) {
 376           std::string& aDocKind = aSession->myPlugins[aFeatureKind].second;
 377           isOk = aDocKind.empty() || aDocKind == kind();
 378         }
 379       }
 380     }
 381   }
 382
 383   if (isOk && !theCheckOnly) {
 384     // copy features from the temporary document to the current
 385     Handle(TDF_RelocationTable) aRelocTable = new TDF_RelocationTable();
 386     TDF_LabelList anAllNewFeatures;
 387     // Perform the copying twice for correct references:
 388     // 1. copy labels hierarchy and fill the relocation table
 389     TDF_Label aMain = myDoc->Main();
 390     for (TDF_ChildIterator anIt(aTempDoc->Main()); anIt.More(); anIt.Next()) {
 391       TDF_Label aCurrentLab = anIt.Value();
 392       Handle(TDataStd_Comment) aFeatureID;
 393       TDF_Label aNewFeatuerLab;
 394       if (aCurrentLab.FindAttribute(TDataStd_Comment::GetID(), aFeatureID)) {
 395         TCollection_AsciiString anID(aFeatureID->Get());
 396         FeaturePtr aNewFeature = addFeature(anID.ToCString());
 397         std::shared_ptr<Model_Data> aData =
 398             std::dynamic_pointer_cast<Model_Data>(aNewFeature->data());
 399         aNewFeatuerLab = aData->label().Father();
 400         Model_Tools::copyLabels(aCurrentLab, aNewFeatuerLab, aRelocTable);
 401         theImported.push_back(aNewFeature);
 402       }
 403       anAllNewFeatures.Append(aNewFeatuerLab);
 404     }
 405     // 2. copy attributes
 406     std::set<TCollection_AsciiString> aCoordinateLabels;
 407     Model_Tools::labelsOfCoordinates(aCoordinateLabels, aRelocTable);
 408     TDF_ListIteratorOfLabelList aNewIt(anAllNewFeatures);
 409     for (TDF_ChildIterator anIt(aTempDoc->Main()); anIt.More(); anIt.Next()) {
 410       TDF_Label aCurrentLab = anIt.Value();
 411       TDF_Label aFeatureLab = aNewIt.Value();
 412       if (aFeatureLab.IsNull())
 413         anAllNewFeatures.Remove(aNewIt);
 414       else {
 415         Model_Tools::copyAttrsAndKeepRefsToCoordinates(
 416             aCurrentLab, aFeatureLab, aCoordinateLabels, aRelocTable);
 417         aNewIt.Next();
 418       }
 419     }
 420
 421     myObjs->synchronizeFeatures(anAllNewFeatures, true, false, false, true);
 422   }
 423
 424   if (anApp->CanClose(aTempDoc) == CDM_CCS_OK)
 425     anApp->Close(aTempDoc);
 426   return isOk;
 427 }
 428
 429 static bool saveDocument(Handle(Model_Application) theApp,
 430                          Handle(TDocStd_Document) theDoc,
 431                          const TCollection_ExtendedString& theFilename)
 432 {
 433   PCDM_StoreStatus aStatus;
 434   try {
 435     // create the directory to save the document
 436     OSD_Path aPathToFile = UTL::Path(theFilename);
 437     aPathToFile.SetName("");
 438     aPathToFile.SetExtension("");
 439     OSD_Directory aBaseDir(aPathToFile);
 440     if (aPathToFile.TrekLength() != 0 && !aBaseDir.Exists())
 441       aBaseDir.Build(OSD_Protection());
 442     // save the document
 443     aStatus = theApp->SaveAs(theDoc, theFilename);
 444   }
 445   catch (Standard_Failure const& anException) {
 446     Events_InfoMessage("Model_Document",
 447       "Exception in saving of document: %1").arg(anException.GetMessageString()).send();
 448     return false;
 449   }
 450   bool isDone = aStatus == PCDM_SS_OK || aStatus == PCDM_SS_No_Obj;
 451   if (!isDone) {
 452     switch (aStatus) {
 453     case PCDM_SS_DriverFailure:
 454       Events_InfoMessage("Model_Document",
 455         "Can not save document: save driver-library failure").send();
 456       break;
 457     case PCDM_SS_WriteFailure:
 458       Events_InfoMessage("Model_Document", "Can not save document: file writing failure").send();
 459       break;
 460     case PCDM_SS_Failure:
 461     default:
 462       Events_InfoMessage("Model_Document", "Can not save document").send();
 463       break;
 464     }
 465   }
 466   return isDone;
 467 }
 468
 469 bool Model_Document::save(
 470   const char* theDirName, const char* theFileName, std::list<std::string>& theResults)
 471 {
 472   // if the history line is not in the end, move it to the end before save, otherwise
 473   // problems with results restore and (the most important) naming problems will appear
 474   // due to change evolution to SELECTION (problems in NamedShape and Name)
 475   FeaturePtr aWasCurrent;
 476   std::shared_ptr<Model_Session> aSession =
 477     std::dynamic_pointer_cast<Model_Session>(Model_Session::get());
 478   if (currentFeature(false) != lastFeature()) {
 479     aSession->setCheckTransactions(false);
 480     aWasCurrent = currentFeature(false);
 481     // if last is nested into something else, make this something else as last:
 482     // otherwise it will look like edition of sub-element, so, the main will be disabled
 483     FeaturePtr aLast = lastFeature();
 484     if (aLast.get()) {
 485       CompositeFeaturePtr aMain = ModelAPI_Tools::compositeOwner(aLast);
 486       while(aMain.get()) {
 487         aLast = aMain;
 488         aMain = ModelAPI_Tools::compositeOwner(aLast);
 489       }
 490     }
 491     setCurrentFeature(aLast, true);
 492   }
 493   // create a directory in the root document if it is not yet exist
 494   Handle(Model_Application) anApp = Model_Application::getApplication();
 495   if (isRoot()) {
 496 #ifdef WIN32
 497     size_t aDirLen = strlen(theDirName);
 498     std::wstring aWStr(aDirLen, L'#');
 499     mbstowcs(&aWStr[0], theDirName, aDirLen);
 500     CreateDirectory(aWStr.c_str(), NULL);
 501 #else
 502     mkdir(theDirName, 0x1ff);
 503 #endif
 504   }
 505   // filename in the dir is id of document inside of the given directory
 506   TCollection_ExtendedString aPath(DocFileName(theDirName, theFileName));
 507   bool isDone = saveDocument(anApp, myDoc, aPath);
 508
 509   if (aWasCurrent.get()) { // return the current feature to the initial position
 510     setCurrentFeature(aWasCurrent, false);
 511     aSession->setCheckTransactions(true);
 512   }
 513
 514   myTransactionSave = int(myTransactions.size());
 515   if (isDone) {  // save also sub-documents if any
 516     theResults.push_back(TCollection_AsciiString(aPath).ToCString());
 517     // iterate all result parts to find all loaded or not yet loaded documents
 518     std::list<ResultPtr> aPartResults;
 519     myObjs->allResults(ModelAPI_ResultPart::group(), aPartResults);
 520     std::list<ResultPtr>::iterator aPartRes = aPartResults.begin();
 521     for(; aPartRes != aPartResults.end(); aPartRes++) {
 522       ResultPartPtr aPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(*aPartRes);
 523       if (!aPart->isActivated()) {
 524         // copy not-activated document that is not in the memory
 525         std::string aDocName = ModelAPI_Tools::toString(aPart->data()->name());
 526         if (!aDocName.empty()) {
 527           // just copy file
 528           TCollection_AsciiString aSubPath(DocFileName(anApp->loadPath().c_str(), aDocName));
 529           OSD_Path aPath(aSubPath);
 530           OSD_File aFile(aPath);
 531           if (aFile.Exists()) {
 532             TCollection_AsciiString aDestinationDir(DocFileName(theDirName, aDocName));
 533             OSD_Path aDestination(aDestinationDir);
 534             aFile.Copy(aDestination);
 535             theResults.push_back(aDestinationDir.ToCString());
 536           } else {
 537             Events_InfoMessage("Model_Document",
 538               "Can not open file %1 for saving").arg(aSubPath.ToCString()).send();
 539           }
 540         }
 541       } else { // simply save opened document
 542         std::string aDocName = ModelAPI_Tools::toString(aPart->data()->name());
 543         isDone = std::dynamic_pointer_cast<Model_Document>(aPart->partDoc())->
 544           save(theDirName, aDocName.c_str(), theResults);
 545       }
 546     }
 547   }
 548   return isDone;
 549 }
 550
 551 bool Model_Document::save(const char* theFilename,
 552                           const std::list<FeaturePtr>& theExportFeatures) const
 553 {
 554   Handle(Model_Application) anApp = Model_Application::getApplication();
 555   TCollection_ExtendedString aFormat;
 556   if (!anApp->Format(theFilename, aFormat))
 557     return false;
 558
 559   Handle(TDocStd_Document) aTempDoc = new TDocStd_Document(aFormat);
 560   TDF_Label aMain = aTempDoc->Main();
 561
 562   Handle(TDF_RelocationTable) aRelocTable = new TDF_RelocationTable();
 563   std::list<FeaturePtr>::const_iterator anIt = theExportFeatures.begin();
 564   // Perform the copying twice for correct references:
 565   // 1. copy labels hierarchy and fill the relocation table
 566   for (; anIt != theExportFeatures.end(); ++anIt) {
 567     TDF_Label aFeatureLab = aMain.NewChild();
 568     std::shared_ptr<Model_Data> aData = std::dynamic_pointer_cast<Model_Data>((*anIt)->data());
 569     Model_Tools::copyLabels(aData->label().Father(), aFeatureLab, aRelocTable);
 570   }
 571   // 2. copy attributes
 572   std::set<TCollection_AsciiString> aCoordinateLabels;
 573   Model_Tools::labelsOfCoordinates(aCoordinateLabels, aRelocTable);
 574   TDF_ChildIterator aChildIt(aMain);
 575   for (anIt = theExportFeatures.begin(); anIt != theExportFeatures.end(); ++anIt) {
 576     TDF_Label aFeatureLab = aChildIt.Value();
 577     std::shared_ptr<Model_Data> aData = std::dynamic_pointer_cast<Model_Data>((*anIt)->data());
 578     Model_Tools::copyAttrsAndKeepRefsToCoordinates(
 579         aData->label().Father(), aFeatureLab, aCoordinateLabels, aRelocTable);
 580     aChildIt.Next();
 581   }
 582
 583   bool isDone = saveDocument(anApp, aTempDoc, theFilename);
 584   if (aTempDoc->CanClose() == CDM_CCS_OK)
 585     aTempDoc->Close();
 586   return isDone;
 587 }
 588
 589 void Model_Document::close(const bool theForever)
 590 {
 591   std::shared_ptr<ModelAPI_Session> aPM = Model_Session::get();
 592   if (!isRoot() && this == aPM->activeDocument().get()) {
 593     aPM->setActiveDocument(aPM->moduleDocument());
 594   } else if (isRoot()) {
 595     // erase the active document if root is closed
 596     aPM->setActiveDocument(DocumentPtr());
 597   }
 598   // close all subs
 599   const std::set<int> aSubs = subDocuments();
 600   std::set<int>::iterator aSubIter = aSubs.begin();
 601   for (; aSubIter != aSubs.end(); aSubIter++) {
 602     std::shared_ptr<Model_Document> aSub = subDoc(*aSubIter);
 603     if (aSub->myObjs) // if it was not closed before
 604       aSub->close(theForever);
 605   }
 606
 607   // close for this document needs no transaction in this document
 608   std::static_pointer_cast<Model_Session>(Model_Session::get())->setCheckTransactions(false);
 609
 610   // close all only if it is really asked, otherwise it can be undone/redone
 611   if (theForever) {
 612     // flush everything to avoid messages with bad objects
 613     delete myObjs;
 614     myObjs = 0;
 615     if (myDoc->CanClose() == CDM_CCS_OK)
 616       myDoc->Close();
 617     mySelectionFeature.reset();
 618   } else {
 619     setCurrentFeature(FeaturePtr(), false); // disables all features
 620     // update the OB: features are disabled (on remove of Part)
 621     Events_Loop* aLoop = Events_Loop::loop();
 622     static Events_ID aDeleteEvent = Events_Loop::eventByName(EVENT_OBJECT_DELETED);
 623     aLoop->flush(aDeleteEvent);
 624   }
 625
 626   std::static_pointer_cast<Model_Session>(Model_Session::get())->setCheckTransactions(true);
 627 }
 628
 629 void Model_Document::startOperation()
 630 {
 631   incrementTransactionID(); // outside of transaction in order to avoid empty transactions keeping
 632   if (myDoc->HasOpenCommand()) {  // start of nested command
 633     if (myDoc->CommitCommand()) {
 634       // commit the current: it will contain all nested after compactification
 635       myTransactions.rbegin()->myOCAFNum++; // if has open command, the list is not empty
 636     }
 637     myNestedNum.push_back(0); // start of nested operation with zero transactions inside yet
 638     myDoc->OpenCommand();
 639   } else {  // start the simple command
 640     myDoc->NewCommand();
 641   }
 642   // starts a new operation
 643   myTransactions.push_back(Transaction());
 644   if (!myNestedNum.empty())
 645     (*myNestedNum.rbegin())++;
 646   myRedos.clear();
 647   // new command for all subs
 648   const std::set<int> aSubs = subDocuments();
 649   std::set<int>::iterator aSubIter = aSubs.begin();
 650   for (; aSubIter != aSubs.end(); aSubIter++)
 651     subDoc(*aSubIter)->startOperation();
 652 }
 653
 654 void Model_Document::compactNested()
 655 {
 656   if (!myNestedNum.empty()) {
 657     int aNumToCompact = *(myNestedNum.rbegin());
 658     int aSumOfTransaction = 0;
 659     for(int a = 0; a < aNumToCompact; a++) {
 660       aSumOfTransaction += myTransactions.rbegin()->myOCAFNum;
 661       myTransactions.pop_back();
 662     }
 663     // the latest transaction is the start of lower-level operation which starts the nested
 664     myTransactions.rbegin()->myOCAFNum += aSumOfTransaction;
 665     myNestedNum.pop_back();
 666   }
 667 }
 668
 669 /// Compares the content of the given attributes, returns true if equal.
 670 /// This method is used to avoid empty transactions when only "current" is changed
 671 /// to some value and then comes back in this transaction, so, it compares only
 672 /// references and Boolean and Integer Arrays for the current moment.
 673 static bool isEqualContent(Handle(TDF_Attribute) theAttr1, Handle(TDF_Attribute) theAttr2)
 674 {
 675   if (Standard_GUID::IsEqual(theAttr1->ID(), TDF_Reference::GetID())) { // reference
 676     Handle(TDF_Reference) aRef1 = Handle(TDF_Reference)::DownCast(theAttr1);
 677     Handle(TDF_Reference) aRef2 = Handle(TDF_Reference)::DownCast(theAttr2);
 678     if (aRef1.IsNull() && aRef2.IsNull())
 679       return true;
 680     if (aRef1.IsNull() || aRef2.IsNull())
 681       return false;
 682     return aRef1->Get().IsEqual(aRef2->Get()) == Standard_True;
 683   } else if (Standard_GUID::IsEqual(theAttr1->ID(), TDataStd_BooleanArray::GetID())) {
 684     Handle(TDataStd_BooleanArray) anArr1 = Handle(TDataStd_BooleanArray)::DownCast(theAttr1);
 685     Handle(TDataStd_BooleanArray) anArr2 = Handle(TDataStd_BooleanArray)::DownCast(theAttr2);
 686     if (anArr1.IsNull() && anArr2.IsNull())
 687       return true;
 688     if (anArr1.IsNull() || anArr2.IsNull())
 689       return false;
 690     if (anArr1->Lower() == anArr2->Lower() && anArr1->Upper() == anArr2->Upper()) {
 691       for(int a = anArr1->Lower(); a <= anArr1->Upper(); a++) {
 692         if (a == 1 && // second is for display
 693             anArr2->Label().Tag() == 1 && (anArr2->Label().Depth() == 4 ||
 694             anArr2->Label().Depth() == 6))
 695           continue;
 696         if (anArr1->Value(a) != anArr2->Value(a))
 697           return false;
 698       }
 699       return true;
 700     }
 701   } else if (Standard_GUID::IsEqual(theAttr1->ID(), TDataStd_IntegerArray::GetID())) {
 702     Handle(TDataStd_IntegerArray) anArr1 = Handle(TDataStd_IntegerArray)::DownCast(theAttr1);
 703     Handle(TDataStd_IntegerArray) anArr2 = Handle(TDataStd_IntegerArray)::DownCast(theAttr2);
 704     if (anArr1.IsNull() && anArr2.IsNull())
 705       return true;
 706     if (anArr1.IsNull() || anArr2.IsNull())
 707       return false;
 708     if (anArr1->Lower() == anArr2->Lower() && anArr1->Upper() == anArr2->Upper()) {
 709       for(int a = anArr1->Lower(); a <= anArr1->Upper(); a++)
 710         if (anArr1->Value(a) != anArr2->Value(a)) {
 711           // avoid the transaction ID checking
 712           if (a == 2 && anArr1->Upper() == 2 && anArr2->Label().Tag() == 1 &&
 713             (anArr2->Label().Depth() == 4 || anArr2->Label().Depth() == 6))
 714             continue;
 715           return false;
 716         }
 717       return true;
 718     }
 719   } else if (Standard_GUID::IsEqual(theAttr1->ID(), TDataStd_ReferenceArray::GetID())) {
 720     Handle(TDataStd_ReferenceArray) anArr1 = Handle(TDataStd_ReferenceArray)::DownCast(theAttr1);
 721     Handle(TDataStd_ReferenceArray) anArr2 = Handle(TDataStd_ReferenceArray)::DownCast(theAttr2);
 722     if (anArr1.IsNull() && anArr2.IsNull())
 723       return true;
 724     if (anArr1.IsNull() || anArr2.IsNull())
 725       return false;
 726     if (anArr1->Lower() == anArr2->Lower() && anArr1->Upper() == anArr2->Upper()) {
 727       for(int a = anArr1->Lower(); a <= anArr1->Upper(); a++)
 728         if (anArr1->Value(a) != anArr2->Value(a)) {
 729           // avoid the transaction ID checking
 730           if (a == 2 && anArr1->Upper() == 2 && anArr2->Label().Tag() == 1 &&
 731             (anArr2->Label().Depth() == 4 || anArr2->Label().Depth() == 6))
 732             continue;
 733           return false;
 734         }
 735       return true;
 736     }
 737   } else if (Standard_GUID::IsEqual(theAttr1->ID(), TDataStd_ReferenceList::GetID())) {
 738     Handle(TDataStd_ReferenceList) aList1 = Handle(TDataStd_ReferenceList)::DownCast(theAttr1);
 739     Handle(TDataStd_ReferenceList) aList2= Handle(TDataStd_ReferenceList)::DownCast(theAttr2);
 740     if (aList1.IsNull() && aList2.IsNull())
 741       return true;
 742     if (aList1.IsNull() || aList2.IsNull())
 743       return false;
 744     const TDF_LabelList& aLList1 = aList1->List();
 745     const TDF_LabelList& aLList2 = aList2->List();
 746     TDF_ListIteratorOfLabelList aLIter1(aLList1);
 747     TDF_ListIteratorOfLabelList aLIter2(aLList2);
 748     for(; aLIter1.More() && aLIter2.More(); aLIter1.Next(), aLIter2.Next()) {
 749       if (aLIter1.Value() != aLIter2.Value())
 750         return false;
 751     }
 752     return !aLIter1.More() && !aLIter2.More(); // both lists are with the same size
 753   } else if (Standard_GUID::IsEqual(theAttr1->ID(), TDF_TagSource::GetID())) {
 754     return true; // it just for created and removed feature: nothing is changed
 755   }
 756   return false;
 757 }
 758
 759 /// Returns true if the last transaction is actually empty: modification to the same values
 760 /// were performed only
 761 static bool isEmptyTransaction(const Handle(TDocStd_Document)& theDoc) {
 762   Handle(TDF_Delta) aDelta;
 763   aDelta = theDoc->GetUndos().Last();
 764   TDF_LabelList aDeltaList;
 765   aDelta->Labels(aDeltaList); // it clears list, so, use new one and then append to the result
 766   for(TDF_ListIteratorOfLabelList aListIter(aDeltaList); aListIter.More(); aListIter.Next()) {
 767     return false;
 768   }
 769   // add also label of the modified attributes
 770   const TDF_AttributeDeltaList& anAttrs = aDelta->AttributeDeltas();
 771   for (TDF_ListIteratorOfAttributeDeltaList anAttr(anAttrs); anAttr.More(); anAttr.Next()) {
 772     Handle(TDF_AttributeDelta)& anADelta = anAttr.Value();
 773     Handle(TDF_DeltaOnAddition) anAddition = Handle(TDF_DeltaOnAddition)::DownCast(anADelta);
 774     if (anAddition.IsNull()) { // if the attribute was added, transaction is not empty
 775       if (!anADelta->Label().IsNull() && !anADelta->Attribute().IsNull()) {
 776         Handle(TDF_Attribute) aCurrentAttr;
 777         if (anADelta->Label().FindAttribute(anADelta->Attribute()->ID(), aCurrentAttr)) {
 778           if (isEqualContent(anADelta->Attribute(), aCurrentAttr)) {
 779             continue; // attribute is not changed actually
 780           }
 781         } else
 782           if (Standard_GUID::IsEqual(anADelta->Attribute()->ID(), TDataStd_AsciiString::GetID())) {
 783             continue; // error message is disappeared
 784         }
 785       }
 786     }
 787     return false;
 788   }
 789   return true;
 790 }
 791
 792 bool Model_Document::finishOperation()
 793 {
 794   bool isNestedClosed = !myDoc->HasOpenCommand() && !myNestedNum.empty();
 795   static std::shared_ptr<Model_Session> aSession =
 796     std::static_pointer_cast<Model_Session>(Model_Session::get());
 797
 798   // open transaction if nested is closed to fit inside
 799   // all synchronizeBackRefs and flushed consequences
 800   if (isNestedClosed) {
 801     myDoc->OpenCommand();
 802   }
 803   // do it before flashes to enable and recompute nesting features correctly
 804   if (myNestedNum.empty() || (isNestedClosed && myNestedNum.size() == 1)) {
 805     // if all nested operations are closed, make current the higher level objects (to perform
 806     // it in the python scripts correctly): sketch become current after creation of sub-elements
 807     FeaturePtr aCurrent = currentFeature(false);
 808     CompositeFeaturePtr aMain, aNext = ModelAPI_Tools::compositeOwner(aCurrent);
 809     while(aNext.get()) {
 810       aMain = aNext;
 811       aNext = ModelAPI_Tools::compositeOwner(aMain);
 812     }
 813     if (aMain.get() && aMain != aCurrent)
 814       setCurrentFeature(aMain, false);
 815   }
 816   myObjs->synchronizeBackRefs();
 817   Events_Loop* aLoop = Events_Loop::loop();
 818   static const Events_ID kCreatedEvent = aLoop->eventByName(EVENT_OBJECT_CREATED);
 819   static const Events_ID kUpdatedEvent = aLoop->eventByName(EVENT_OBJECT_UPDATED);
 820   static const Events_ID kRedispEvent = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
 821   static const Events_ID kDeletedEvent = aLoop->eventByName(EVENT_OBJECT_DELETED);
 822   aLoop->flush(kCreatedEvent);
 823   aLoop->flush(kUpdatedEvent);
 824   aLoop->flush(kRedispEvent);
 825   aLoop->flush(kDeletedEvent);
 826
 827   if (isNestedClosed) {
 828     if (myDoc->CommitCommand())
 829       myTransactions.rbegin()->myOCAFNum++;
 830   }
 831
 832   // this must be here just after everything is finished but before real transaction stop
 833   // to avoid messages about modifications outside of the transaction
 834   // and to rebuild everything after all updates and creates
 835   if (isRoot()) { // once for root document
 836     static std::shared_ptr<Events_Message> aFinishMsg
 837       (new Events_Message(Events_Loop::eventByName("FinishOperation")));
 838     Events_Loop::loop()->send(aFinishMsg);
 839   }
 840
 841   // for open of document with primitive box inside (finish transaction in initAttributes)
 842   bool aWasActivatedFlushes = aLoop->activateFlushes(true);
 843   while(aLoop->hasGrouppedEvent(kCreatedEvent) || aLoop->hasGrouppedEvent(kUpdatedEvent) ||
 844         aLoop->hasGrouppedEvent(kRedispEvent) || aLoop->hasGrouppedEvent(kDeletedEvent)) {
 845     aLoop->flush(kCreatedEvent);
 846     aLoop->flush(kUpdatedEvent);
 847     aLoop->flush(kRedispEvent);
 848     aLoop->flush(kDeletedEvent);
 849   }
 850   aLoop->activateFlushes(aWasActivatedFlushes);
 851
 852   // to avoid "updated" message appearance by updater
 853   //aLoop->clear(Events_Loop::eventByName(EVENT_OBJECT_UPDATED));
 854
 855   // finish for all subs first: to avoid nested finishing and "isOperation" calls problems inside
 856   bool aResult = false;
 857   const std::set<int> aSubs = subDocuments();
 858   std::set<int>::iterator aSubIter = aSubs.begin();
 859   for (; aSubIter != aSubs.end(); aSubIter++)
 860     if (subDoc(*aSubIter)->finishOperation())
 861       aResult = true;
 862
 863   // transaction may be empty if this document was created during this transaction (create part)
 864   if (!myTransactions.empty() && myDoc->CommitCommand()) {
 865     // if commit is successful, just increment counters
 866     if (isEmptyTransaction(myDoc)) { // erase this transaction
 867       myDoc->Undo();
 868       myDoc->ClearRedos();
 869     } else {
 870       myTransactions.rbegin()->myOCAFNum++;
 871       aResult = true;
 872     }
 873   }
 874
 875   if (isNestedClosed) {
 876     compactNested();
 877   }
 878   if (!aResult && !myTransactions.empty() /* it can be for just created part document */)
 879     aResult = myTransactions.rbegin()->myOCAFNum != 0;
 880
 881   if (!aResult && isRoot()) {
 882     // nothing inside in all documents, so remove this transaction from the transactions list
 883     undoInternal(true, false);
 884   }
 885   // on finish clear redo in any case (issue 446) and for all subs (issue 408)
 886   myDoc->ClearRedos();
 887   myRedos.clear();
 888   for (aSubIter = aSubs.begin(); aSubIter != aSubs.end(); aSubIter++) {
 889     subDoc(*aSubIter)->myDoc->ClearRedos();
 890     subDoc(*aSubIter)->myRedos.clear();
 891   }
 892
 893   return aResult;
 894 }
 895
 896 /// Returns in theDelta labels that has been modified in the latest transaction of theDoc
 897 static void modifiedLabels(const Handle(TDocStd_Document)& theDoc, TDF_LabelList& theDelta,
 898   const bool isRedo = false) {
 899   Handle(TDF_Delta) aDelta;
 900   if (isRedo)
 901     aDelta = theDoc->GetRedos().First();
 902   else
 903     aDelta = theDoc->GetUndos().Last();
 904   TDF_LabelList aDeltaList;
 905   aDelta->Labels(aDeltaList); // it clears list, so, use new one and then append to the result
 906   for(TDF_ListIteratorOfLabelList aListIter(aDeltaList); aListIter.More(); aListIter.Next()) {
 907     theDelta.Append(aListIter.Value());
 908   }
 909   // add also label of the modified attributes
 910   const TDF_AttributeDeltaList& anAttrs = aDelta->AttributeDeltas();
 911   /// named shape evolution also modifies integer on this label: exclude it
 912   TDF_LabelMap anExcludedInt;
 913   for (TDF_ListIteratorOfAttributeDeltaList anAttr(anAttrs); anAttr.More(); anAttr.Next()) {
 914     if (anAttr.Value()->Attribute()->ID() == TDataStd_BooleanArray::GetID()) {
 915       // Boolean array is used for feature auxiliary attributes only, feature args are not modified
 916       continue;
 917     }
 918     if (anAttr.Value()->Attribute()->ID() == TNaming_NamedShape::GetID()) {
 919       anExcludedInt.Add(anAttr.Value()->Label());
 920       // named shape evolution is changed in history update => skip them,
 921       // they are not the features arguments
 922       continue;
 923     }
 924     if (anAttr.Value()->Attribute()->ID() == TDataStd_Integer::GetID()) {
 925       if (anExcludedInt.Contains(anAttr.Value()->Label()))
 926         continue;
 927     }
 928       theDelta.Append(anAttr.Value()->Label());
 929   }
 930   TDF_ListIteratorOfLabelList aDeltaIter(theDelta);
 931   for(; aDeltaIter.More(); aDeltaIter.Next()) {
 932     if (anExcludedInt.Contains(aDeltaIter.Value())) {
 933       theDelta.Remove(aDeltaIter);
 934       if (!aDeltaIter.More())
 935         break;
 936     }
 937   }
 938 }
 939
 940 void Model_Document::abortOperation()
 941 {
 942   TDF_LabelList aDeltaLabels; // labels that are updated during "abort"
 943   if (!myNestedNum.empty() && !myDoc->HasOpenCommand()) {  // abort all what was done in nested
 944     compactNested();
 945     // store undo-delta here as undo actually does in the method later
 946     int a, aNumTransactions = myTransactions.rbegin()->myOCAFNum;
 947     for(a = 0; a < aNumTransactions; a++) {
 948       modifiedLabels(myDoc, aDeltaLabels);
 949       myDoc->Undo();
 950     }
 951     for(a = 0; a < aNumTransactions; a++) {
 952       myDoc->Redo();
 953     }
 954
 955     undoInternal(false, false);
 956     myDoc->ClearRedos();
 957     myRedos.clear();
 958   } else { // abort the current
 959     int aNumTransactions = myTransactions.rbegin()->myOCAFNum;
 960     myTransactions.pop_back();
 961     if (!myNestedNum.empty())
 962       (*myNestedNum.rbegin())--;
 963     // roll back the needed number of transactions
 964     //myDoc->AbortCommand();
 965     // instead of abort, do commit and undo: to get the delta of modifications
 966     if (myDoc->CommitCommand())  {
 967       modifiedLabels(myDoc, aDeltaLabels);
 968       myDoc->Undo();
 969     }
 970     for(int a = 0; a < aNumTransactions; a++) {
 971       modifiedLabels(myDoc, aDeltaLabels);
 972       myDoc->Undo();
 973     }
 974     myDoc->ClearRedos();
 975   }
 976   // abort for all subs, flushes will be later, in the end of root abort
 977   const std::set<int> aSubs = subDocuments();
 978   std::set<int>::iterator aSubIter = aSubs.begin();
 979   for (; aSubIter != aSubs.end(); aSubIter++)
 980     subDoc(*aSubIter)->abortOperation();
 981   // references may be changed because they are set in attributes on the fly
 982   myObjs->synchronizeFeatures(aDeltaLabels, true, false, false, isRoot());
 983 }
 984
 985 bool Model_Document::isOperation() const
 986 {
 987   // operation is opened for all documents: no need to check subs
 988   return myDoc->HasOpenCommand() == Standard_True ;
 989 }
 990
 991 bool Model_Document::isModified()
 992 {
 993   // is modified if at least one operation was committed and not undone
 994   return myTransactions.size() != myTransactionSave || isOperation();
 995 }
 996
 997 bool Model_Document::canUndo()
 998 {
 999   // issue 406 : if transaction is opened, but nothing to undo behind, can not undo
1000   int aCurrentNum = isOperation() ? 1 : 0;
1001   if (myDoc->GetAvailableUndos() > 0 &&
1002       // there is something to undo in nested
1003       (myNestedNum.empty() || *myNestedNum.rbegin() - aCurrentNum > 0) &&
1004       myTransactions.size() - aCurrentNum > 0 /* for omitting the first useless transaction */)
1005     return true;
1006   // check other subs contains operation that can be undone
1007   const std::set<int> aSubs = subDocuments();
1008   std::set<int>::iterator aSubIter = aSubs.begin();
1009   for (; aSubIter != aSubs.end(); aSubIter++) {
1010     std::shared_ptr<Model_Document> aSub = subDoc(*aSubIter);
1011     if (aSub->myObjs) {// if it was not closed before
1012       if (aSub->canUndo())
1013         return true;
1014     }
1015   }
1016
1017   return false;
1018 }
1019
1020 void Model_Document::undoInternal(const bool theWithSubs, const bool theSynchronize)
1021 {
1022   if (myTransactions.empty())
1023     return;
1024   int aNumTransactions = myTransactions.rbegin()->myOCAFNum;
1025   myRedos.push_back(*myTransactions.rbegin());
1026   myTransactions.pop_back();
1027   if (!myNestedNum.empty())
1028     (*myNestedNum.rbegin())--;
1029   // roll back the needed number of transactions
1030   TDF_LabelList aDeltaLabels;
1031   for(int a = 0; a < aNumTransactions; a++) {
1032     if (theSynchronize)
1033       modifiedLabels(myDoc, aDeltaLabels);
1034     myDoc->Undo();
1035   }
1036
1037   std::set<int> aSubs;
1038   if (theWithSubs) {
1039     // undo for all subs
1040     aSubs = subDocuments();
1041     std::set<int>::iterator aSubIter = aSubs.begin();
1042     for (; aSubIter != aSubs.end(); aSubIter++) {
1043       if (!subDoc(*aSubIter)->myObjs)
1044         continue;
1045       subDoc(*aSubIter)->undoInternal(theWithSubs, theSynchronize);
1046     }
1047   }
1048   // after undo of all sub-documents to avoid updates on not-modified data (issue 370)
1049   if (theSynchronize) {
1050     myObjs->synchronizeFeatures(aDeltaLabels, true, false, false, isRoot());
1051     // update the current features status
1052     setCurrentFeature(currentFeature(false), false);
1053
1054     if (theWithSubs) {
1055       // undo for all subs
1056       const std::set<int> aNewSubs = subDocuments();
1057       std::set<int>::iterator aNewSubIter = aNewSubs.begin();
1058       for (; aNewSubIter != aNewSubs.end(); aNewSubIter++) {
1059         // synchronize only newly appeared documents
1060         if (!subDoc(*aNewSubIter)->myObjs || aSubs.find(*aNewSubIter) != aSubs.end())
1061           continue;
1062         TDF_LabelList anEmptyDeltas;
1063         subDoc(*aNewSubIter)->myObjs->synchronizeFeatures(anEmptyDeltas, true, false, true, true);
1064       }
1065     }
1066   }
1067 }
1068
1069 void Model_Document::undo()
1070 {
1071   undoInternal(true, true);
1072 }
1073
1074 bool Model_Document::canRedo()
1075 {
1076   if (!myRedos.empty())
1077     return true;
1078   // check other subs contains operation that can be redone
1079   const std::set<int> aSubs = subDocuments();
1080   std::set<int>::iterator aSubIter = aSubs.begin();
1081   for (; aSubIter != aSubs.end(); aSubIter++) {
1082     if (!subDoc(*aSubIter)->myObjs)
1083       continue;
1084     if (subDoc(*aSubIter)->canRedo())
1085       return true;
1086   }
1087   return false;
1088 }
1089
1090 void Model_Document::redo()
1091 {
1092   if (!myNestedNum.empty())
1093     (*myNestedNum.rbegin())++;
1094   int aNumRedos = myRedos.rbegin()->myOCAFNum;
1095   myTransactions.push_back(*myRedos.rbegin());
1096   myRedos.pop_back();
1097   TDF_LabelList aDeltaLabels;
1098   for(int a = 0; a < aNumRedos; a++) {
1099     modifiedLabels(myDoc, aDeltaLabels, true);
1100     myDoc->Redo();
1101   }
1102
1103   // redo for all subs
1104   const std::set<int> aSubs = subDocuments();
1105   std::set<int>::iterator aSubIter = aSubs.begin();
1106   for (; aSubIter != aSubs.end(); aSubIter++)
1107     subDoc(*aSubIter)->redo();
1108
1109   // after redo of all sub-documents to avoid updates on not-modified data (issue 370)
1110   myObjs->synchronizeFeatures(aDeltaLabels, true, false, false, isRoot());
1111   // update the current features status
1112   setCurrentFeature(currentFeature(false), false);
1113 }
1114 // this is used for creation of undo/redo1-list by GUI
1115 // LCOV_EXCL_START
1116 std::list<std::string> Model_Document::undoList() const
1117 {
1118   std::list<std::string> aResult;
1119   // the number of skipped current operations (on undo they will be aborted)
1120   int aSkipCurrent = isOperation() ? 1 : 0;
1121   std::list<Transaction>::const_reverse_iterator aTrIter = myTransactions.crbegin();
1122   int aNumUndo = int(myTransactions.size());
1123   if (!myNestedNum.empty())
1124     aNumUndo = *myNestedNum.rbegin();
1125   for( ; aNumUndo > 0; aTrIter++, aNumUndo--) {
1126     if (aSkipCurrent == 0) aResult.push_back(aTrIter->myId);
1127     else aSkipCurrent--;
1128   }
1129   return aResult;
1130 }
1131
1132 std::list<std::string> Model_Document::redoList() const
1133 {
1134   std::list<std::string> aResult;
1135   std::list<Transaction>::const_reverse_iterator aTrIter = myRedos.crbegin();
1136   for( ; aTrIter != myRedos.crend(); aTrIter++) {
1137     aResult.push_back(aTrIter->myId);
1138   }
1139   return aResult;
1140 }
1141 // LCOV_EXCL_STOP
1142
1143 void Model_Document::operationId(const std::string& theId)
1144 {
1145   myTransactions.rbegin()->myId = theId;
1146 }
1147
1148 FeaturePtr Model_Document::addFeature(std::string theID, const bool theMakeCurrent)
1149 {
1150   std::shared_ptr<Model_Session> aSession =
1151     std::dynamic_pointer_cast<Model_Session>(ModelAPI_Session::get());
1152   FeaturePtr aFeature = aSession->createFeature(theID, this);
1153   if (!aFeature)
1154     return aFeature;
1155   aFeature->init();
1156   Model_Document* aDocToAdd;
1157   if (!aFeature->documentToAdd().empty()) { // use the customized document to add
1158     if (aFeature->documentToAdd() != kind()) { // the root document by default
1159       aDocToAdd = std::dynamic_pointer_cast<Model_Document>(aSession->moduleDocument()).get();
1160     } else {
1161       aDocToAdd = this;
1162     }
1163   } else { // if customized is not presented, add to "this" document
1164     aDocToAdd = this;
1165   }
1166   if (aFeature) {
1167     // searching for feature after which must be added the next feature: this is the current feature
1168     // but also all sub-features of this feature
1169     FeaturePtr aCurrent = aDocToAdd->currentFeature(false);
1170     bool isModified = true;
1171     for(CompositeFeaturePtr aComp = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aCurrent);
1172         aComp.get() && isModified;
1173         aComp = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aCurrent)) {
1174       isModified =  false;
1175       int aSubs = aComp->numberOfSubs(false);
1176       for(int a = 0; a < aSubs; a++) {
1177         FeaturePtr aSub = aComp->subFeature(a, false);
1178         if (aSub && myObjs->isLater(aSub, aCurrent)) {
1179           isModified =  true;
1180           aCurrent = aSub;
1181         }
1182       }
1183     }
1184     // #2861,3029: if the parameter is added, add it after parameters existing in the list
1185     if (aCurrent.get() &&
1186       (aFeature->getKind() == "Parameter" || aFeature->getKind() == "ParametersMgr")) {
1187       int anIndex = kUNDEFINED_FEATURE_INDEX;
1188       for(FeaturePtr aNextFeat = myObjs->nextFeature(aCurrent, anIndex);
1189         aNextFeat.get() && aNextFeat->getKind() == "Parameter";
1190         aNextFeat = myObjs->nextFeature(aCurrent, anIndex))
1191         aCurrent = aNextFeat;
1192     }
1193     aDocToAdd->myObjs->addFeature(aFeature, aCurrent);
1194     if (!aFeature->isAction()) {  // do not add action to the data model
1195       if (theMakeCurrent)  // after all this feature stays in the document, so make it current
1196         aDocToAdd->setCurrentFeature(aFeature, false);
1197     } else { // feature must be executed
1198        // no creation event => updater not working, problem with remove part
1199       aFeature->execute();
1200     }
1201   }
1202   return aFeature;
1203 }
1204
1205 void Model_Document::refsToFeature(FeaturePtr theFeature,
1206   std::set<std::shared_ptr<ModelAPI_Feature> >& theRefs, const bool isSendError)
1207 {
1208   myObjs->refsToFeature(theFeature, theRefs, isSendError);
1209 }
1210
1211 void Model_Document::removeFeature(FeaturePtr theFeature)
1212 {
1213   myObjs->removeFeature(theFeature);
1214   // fix for #2723: send signal that part is updated
1215   if (!isRoot() && isOperation()) {
1216     std::shared_ptr<Model_Document> aRoot =
1217       std::dynamic_pointer_cast<Model_Document>(ModelAPI_Session::get()->moduleDocument());
1218     std::list<ResultPtr> allParts;
1219     aRoot->objects()->allResults(ModelAPI_ResultPart::group(), allParts);
1220     std::list<ResultPtr>::iterator aParts = allParts.begin();
1221     for(; aParts != allParts.end(); aParts++) {
1222       ResultPartPtr aPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(*aParts);
1223       if (aPart->partDoc().get() == this) {
1224         static Events_ID anEvent = Events_Loop::eventByName(EVENT_OBJECT_UPDATED);
1225         ModelAPI_EventCreator::get()->sendUpdated(aRoot->feature(aPart), anEvent);
1226         break;
1227       }
1228     }
1229   }
1230 }
1231
1232 // recursive function to check if theSub is a child of theMain composite feature
1233 // through all the hierarchy of parents
1234 static bool isSub(const CompositeFeaturePtr theMain, const FeaturePtr theSub) {
1235   CompositeFeaturePtr aParent = ModelAPI_Tools::compositeOwner(theSub);
1236   if (!aParent.get())
1237     return false;
1238   if (aParent == theMain)
1239     return true;
1240   return isSub(theMain, aParent);
1241 }
1242
1243 void Model_Document::moveFeature(FeaturePtr theMoved, FeaturePtr theAfterThis, const bool theSplit)
1244 {
1245   bool aCurrentUp = theMoved == currentFeature(false);
1246   if (aCurrentUp) {
1247     setCurrentFeatureUp();
1248   }
1249   // if user adds after high-level feature with nested,
1250   // add it after all nested (otherwise the nested will be disabled)
1251   CompositeFeaturePtr aCompositeAfter =
1252     std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(theAfterThis);
1253   FeaturePtr anAfterThisSub = theAfterThis;
1254   if (aCompositeAfter.get()) {
1255     FeaturePtr aSub = aCompositeAfter;
1256     int anIndex = kUNDEFINED_FEATURE_INDEX;
1257     do {
1258       FeaturePtr aNext = myObjs->nextFeature(aSub, anIndex);
1259       if (!isSub(aCompositeAfter, aNext)) {
1260         anAfterThisSub = aSub;
1261         break;
1262       }
1263       aSub = aNext;
1264     } while (aSub.get());
1265   }
1266
1267   AttributeSelectionListPtr aMovedList;
1268   if (theMoved->getKind() == "Group") {
1269     aMovedList = theMoved->selectionList("group_list");
1270     if (aMovedList.get())
1271       aMovedList->setMakeCopy(true);
1272   }
1273   myObjs->moveFeature(theMoved, anAfterThisSub);
1274
1275   if (theSplit) { // split the group into sub-features
1276     theMoved->customAction("split");
1277   }
1278
1279   if (aCurrentUp) { // make the moved feature enabled or disabled due to the real status
1280     setCurrentFeature(currentFeature(false), false);
1281   } else if (theAfterThis == currentFeature(false) || anAfterThisSub == currentFeature(false)) {
1282     // must be after move to make enabled all features which are before theMoved
1283     setCurrentFeature(theMoved, true);
1284   }
1285   if (aMovedList.get())
1286     aMovedList->setMakeCopy(false);
1287 }
1288
1289 void Model_Document::updateHistory(const std::shared_ptr<ModelAPI_Object> theObject)
1290 {
1291   if (myObjs)
1292     myObjs->updateHistory(theObject);
1293 }
1294
1295 void Model_Document::updateHistory(const std::string theGroup)
1296 {
1297   if (myObjs)
1298     myObjs->updateHistory(theGroup);
1299 }
1300
1301 const std::set<int> Model_Document::subDocuments() const
1302 {
1303   std::set<int> aResult;
1304   std::list<ResultPtr> aPartResults;
1305   myObjs->allResults(ModelAPI_ResultPart::group(), aPartResults);
1306   std::list<ResultPtr>::iterator aPartRes = aPartResults.begin();
1307   for(; aPartRes != aPartResults.end(); aPartRes++) {
1308     ResultPartPtr aPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(*aPartRes);
1309     if (aPart && aPart->isActivated()) {
1310       aResult.insert(aPart->original()->partDoc()->id());
1311     }
1312   }
1313   return aResult;
1314 }
1315
1316 std::shared_ptr<Model_Document> Model_Document::subDoc(int theDocID)
1317 {
1318   // just store sub-document identifier here to manage it later
1319   return std::dynamic_pointer_cast<Model_Document>(
1320     Model_Application::getApplication()->document(theDocID));
1321 }
1322
1323 ObjectPtr Model_Document::object(const std::string& theGroupID,
1324                                  const int theIndex,
1325                                  const bool theAllowFolder)
1326 {
1327   return myObjs->object(theGroupID, theIndex, theAllowFolder);
1328 }
1329
1330 std::shared_ptr<ModelAPI_Object> Model_Document::objectByName(
1331     const std::string& theGroupID, const std::wstring& theName)
1332 {
1333   return myObjs->objectByName(theGroupID, theName);
1334 }
1335
1336 const int Model_Document::index(std::shared_ptr<ModelAPI_Object> theObject,
1337                                 const bool theAllowFolder)
1338 {
1339   return myObjs->index(theObject, theAllowFolder);
1340 }
1341
1342 int Model_Document::size(const std::string& theGroupID, const bool theAllowFolder)
1343 {
1344   if (myObjs == 0) // may be on close
1345     return 0;
1346   return myObjs->size(theGroupID, theAllowFolder);
1347 }
1348
1349 std::shared_ptr<ModelAPI_Object> Model_Document::parent(
1350   const std::shared_ptr<ModelAPI_Object> theChild)
1351 {
1352   if(myObjs == 0) // may be on close
1353     return ObjectPtr();
1354   return myObjs->parent(theChild);
1355 }
1356
1357 std::shared_ptr<ModelAPI_Feature> Model_Document::currentFeature(const bool theVisible)
1358 {
1359   if (!myObjs) // on close document feature destruction it may call this method
1360     return std::shared_ptr<ModelAPI_Feature>();
1361   TDF_Label aRefLab = generalLabel().FindChild(TAG_CURRENT_FEATURE);
1362   Handle(TDF_Reference) aRef;
1363   if (aRefLab.FindAttribute(TDF_Reference::GetID(), aRef)) {
1364     TDF_Label aLab = aRef->Get();
1365     FeaturePtr aResult = myObjs->feature(aLab);
1366     if (theVisible) { // get nearest visible (in history) going up
1367       int anIndex = kUNDEFINED_FEATURE_INDEX;
1368       while(aResult.get() &&  !aResult->isInHistory()) {
1369         aResult = myObjs->nextFeature(aResult, anIndex, true);
1370       }
1371     }
1372     return aResult;
1373   }
1374   return std::shared_ptr<ModelAPI_Feature>(); // null feature means the higher than first
1375 }
1376
1377 void Model_Document::setCurrentFeature(
1378   std::shared_ptr<ModelAPI_Feature> theCurrent, const bool theVisible)
1379 {
1380   if (myIsSetCurrentFeature)
1381     return;
1382   myIsSetCurrentFeature = true;
1383   // blocks the flush signals to avoid each objects visualization in the viewer
1384   // they should not be shown once after all modifications are performed
1385   Events_Loop* aLoop = Events_Loop::loop();
1386   bool isActive = aLoop->activateFlushes(false);
1387
1388   TDF_Label aRefLab = generalLabel().FindChild(TAG_CURRENT_FEATURE);
1389   CompositeFeaturePtr aMain; // main feature that may nest the new current
1390   std::set<FeaturePtr> anOwners; // composites that contain theCurrent (with any level of nesting)
1391   if (theCurrent.get()) {
1392     aMain = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(theCurrent);
1393     CompositeFeaturePtr anOwner = ModelAPI_Tools::compositeOwner(theCurrent);
1394     while(anOwner.get()) {
1395       if (!aMain.get()) {
1396         aMain = anOwner;
1397       }
1398       anOwners.insert(anOwner);
1399       anOwner = ModelAPI_Tools::compositeOwner(anOwner);
1400     }
1401   }
1402
1403   if (theVisible && !theCurrent.get()) {
1404     // needed to avoid disabling of PartSet initial constructions
1405     int anIndex = kUNDEFINED_FEATURE_INDEX;
1406     FeaturePtr aNext =
1407       theCurrent.get() ? myObjs->nextFeature(theCurrent, anIndex, false) : myObjs->firstFeature();
1408     for (; aNext.get(); aNext = myObjs->nextFeature(theCurrent, anIndex, false)) {
1409       if (aNext->isInHistory()) {
1410         break; // next in history is not needed
1411       } else { // next not in history is good for making current
1412         theCurrent = aNext;
1413       }
1414     }
1415   }
1416   if (theVisible) { // make RemoveResults feature be active even it is performed after the current
1417     int anIndex = kUNDEFINED_FEATURE_INDEX;
1418     FeaturePtr aNext =
1419       theCurrent.get() ? myObjs->nextFeature(theCurrent, anIndex, false) : myObjs->firstFeature();
1420     for (; aNext.get(); aNext = myObjs->nextFeature(theCurrent, anIndex, false)) {
1421       if (aNext->isInHistory()) {
1422         break; // next in history is not needed
1423       } else if (aNext->getKind() == "RemoveResults"){
1424         theCurrent = aNext;
1425       }
1426     }
1427   }
1428   if (theCurrent.get()) {
1429     std::shared_ptr<Model_Data> aData = std::static_pointer_cast<Model_Data>(theCurrent->data());
1430     if (!aData.get() || !aData->isValid()) {
1431       aLoop->activateFlushes(isActive);
1432       myIsSetCurrentFeature = false;
1433       return;
1434     }
1435     TDF_Label aFeatureLabel = aData->label().Father();
1436
1437     Handle(TDF_Reference) aRef;
1438     if (aRefLab.FindAttribute(TDF_Reference::GetID(), aRef)) {
1439       aRef->Set(aFeatureLabel);
1440     } else {
1441       aRef = TDF_Reference::Set(aRefLab, aFeatureLabel);
1442     }
1443   } else { // remove reference for the null feature
1444     aRefLab.ForgetAttribute(TDF_Reference::GetID());
1445   }
1446   // make all features after this feature disabled in reversed order
1447   // (to remove results without dependencies)
1448   static Events_ID aRedispEvent = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
1449
1450   bool aPassed = false; // flag that the current object is already passed in cycle
1451   FeaturePtr anIter = myObjs->lastFeature();
1452   bool aWasChanged = false;
1453   bool isCurrentParameter = theCurrent.get() && theCurrent->getKind() == "Parameter";
1454   int anIndex = kUNDEFINED_FEATURE_INDEX;
1455   for(; anIter.get(); anIter = myObjs->nextFeature(anIter, anIndex, true)) {
1456     // check this before passed become enabled: the current feature is enabled!
1457     if (anIter == theCurrent) aPassed = true;
1458
1459     bool aDisabledFlag = !aPassed;
1460     if (aMain.get()) {
1461       if (isSub(aMain, anIter)) // sub-elements of not-disabled feature are not disabled
1462         aDisabledFlag = false;
1463       else if (anOwners.find(anIter) != anOwners.end())
1464         // disable the higher-level feature if the nested is the current
1465         if (aMain->getKind() != "Import") // exception for the import XAO feature with Group (2430)
1466           aDisabledFlag = true;
1467     }
1468
1469     if (anIter->getKind() == "Parameter") {
1470       // parameters are always out of the history of features, but not parameters
1471       // due to the issue 1491 all parameters are kept enabled any time
1472       //if (!isCurrentParameter)
1473         aDisabledFlag = false;
1474     } else if (isCurrentParameter) {
1475       // if parameter is active, all other features become enabled (issue 1307)
1476       aDisabledFlag = false;
1477     }
1478
1479     if (anIter->setDisabled(aDisabledFlag)) {
1480       static Events_ID anUpdateEvent = aLoop->eventByName(EVENT_OBJECT_UPDATED);
1481       // state of feature is changed => so inform that it must be updated if it has such state
1482       if (!aDisabledFlag &&
1483           (anIter->data()->execState() == ModelAPI_StateMustBeUpdated ||
1484            anIter->data()->execState() == ModelAPI_StateInvalidArgument))
1485         ModelAPI_EventCreator::get()->sendUpdated(anIter, anUpdateEvent);
1486       // flush is in the end of this method
1487       ModelAPI_EventCreator::get()->sendUpdated(anIter, aRedispEvent /*, false*/);
1488       aWasChanged = true;
1489     }
1490     // update for everyone concealment flag immediately: on edit feature in the middle of history
1491     if (aWasChanged) {
1492       std::list<ResultPtr> aResults;
1493       ModelAPI_Tools::allResults(anIter, aResults);
1494       std::list<ResultPtr>::const_iterator aRes = aResults.begin();
1495       for(; aRes != aResults.end(); aRes++) {
1496         if ((*aRes).get() && (*aRes)->data()->isValid() && !(*aRes)->isDisabled())
1497           std::dynamic_pointer_cast<Model_Data>((*aRes)->data())->updateConcealmentFlag();
1498       }
1499       // update the concealment status for display in isConcealed of ResultBody
1500       for(aRes = aResults.begin(); aRes != aResults.end(); aRes++) {
1501         if ((*aRes).get() && (*aRes)->data()->isValid() && !(*aRes)->isDisabled())
1502           (*aRes)->isConcealed();
1503       }
1504     }
1505   }
1506   myIsSetCurrentFeature = false;
1507   // unblock  the flush signals and up them after this
1508   aLoop->activateFlushes(isActive);
1509
1510   static Events_ID kUpdatedSel = aLoop->eventByName(EVENT_UPDATE_SELECTION);
1511   aLoop->flush(kUpdatedSel);
1512 }
1513
1514 void Model_Document::setCurrentFeatureUp()
1515 {
1516   // on remove just go up for minimum step: highlight external objects in sketch causes
1517   // problems if it is true: here and in "setCurrentFeature"
1518   FeaturePtr aCurrent = currentFeature(false);
1519   if (aCurrent.get()) { // if not, do nothing because null is the upper
1520     int anIndex = kUNDEFINED_FEATURE_INDEX;
1521     FeaturePtr aPrev = myObjs->nextFeature(aCurrent, anIndex, true);
1522     // make the higher level composite as current (sketch becomes disabled if line is enabled)
1523     if (aPrev.get()) {
1524       FeaturePtr aComp = ModelAPI_Tools::compositeOwner(aPrev);
1525       // without cycle (issue 1555): otherwise extrusion fuse
1526       // will be enabled and displayed when inside sketch
1527       if (aComp.get())
1528           aPrev = aComp;
1529     }
1530     // do not flush: it is called only on remove, it will be flushed in the end of transaction
1531     setCurrentFeature(aPrev, false);
1532   }
1533 }
1534
1535 TDF_Label Model_Document::generalLabel() const
1536 {
1537   return myDoc->Main().FindChild(TAG_GENERAL);
1538 }
1539
1540 std::shared_ptr<ModelAPI_ResultConstruction> Model_Document::createConstruction(
1541     const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1542 {
1543   return myObjs->createConstruction(theFeatureData, theIndex);
1544 }
1545
1546 std::shared_ptr<ModelAPI_ResultBody> Model_Document::createBody(
1547     const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1548 {
1549   return myObjs->createBody(theFeatureData, theIndex);
1550 }
1551
1552 std::shared_ptr<ModelAPI_ResultPart> Model_Document::createPart(
1553     const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1554 {
1555   return myObjs->createPart(theFeatureData, theIndex);
1556 }
1557
1558 std::shared_ptr<ModelAPI_ResultPart> Model_Document::copyPart(
1559       const std::shared_ptr<ModelAPI_ResultPart>& theOrigin,
1560       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1561 {
1562   return myObjs->copyPart(theOrigin, theFeatureData, theIndex);
1563 }
1564
1565 std::shared_ptr<ModelAPI_ResultGroup> Model_Document::createGroup(
1566     const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1567 {
1568   return myObjs->createGroup(theFeatureData, theIndex);
1569 }
1570
1571 std::shared_ptr<ModelAPI_ResultField> Model_Document::createField(
1572     const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1573 {
1574   return myObjs->createField(theFeatureData, theIndex);
1575 }
1576
1577 std::shared_ptr<ModelAPI_ResultParameter> Model_Document::createParameter(
1578       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1579 {
1580   return myObjs->createParameter(theFeatureData, theIndex);
1581 }
1582
1583 std::shared_ptr<ModelAPI_Folder> Model_Document::addFolder(
1584     std::shared_ptr<ModelAPI_Feature> theAddBefore)
1585 {
1586   return myObjs->createFolder(theAddBefore);
1587 }
1588
1589 void Model_Document::removeFolder(std::shared_ptr<ModelAPI_Folder> theFolder)
1590 {
1591   if (theFolder)
1592     myObjs->removeFolder(theFolder);
1593 }
1594
1595 std::shared_ptr<ModelAPI_Folder> Model_Document::findFolderAbove(
1596       const std::list<std::shared_ptr<ModelAPI_Feature> >& theFeatures)
1597 {
1598   return myObjs->findFolder(theFeatures, false);
1599 }
1600
1601 std::shared_ptr<ModelAPI_Folder> Model_Document::findFolderBelow(
1602       const std::list<std::shared_ptr<ModelAPI_Feature> >& theFeatures)
1603 {
1604   return myObjs->findFolder(theFeatures, true);
1605 }
1606
1607 std::shared_ptr<ModelAPI_Folder> Model_Document::findContainingFolder(
1608       const std::shared_ptr<ModelAPI_Feature>& theFeature,
1609       int& theIndexInFolder)
1610 {
1611   return myObjs->findContainingFolder(theFeature, theIndexInFolder);
1612 }
1613
1614 bool Model_Document::moveToFolder(
1615       const std::list<std::shared_ptr<ModelAPI_Feature> >& theFeatures,
1616       const std::shared_ptr<ModelAPI_Folder>& theFolder)
1617 {
1618   return myObjs->moveToFolder(theFeatures, theFolder);
1619 }
1620
1621 bool Model_Document::removeFromFolder(
1622       const std::list<std::shared_ptr<ModelAPI_Feature> >& theFeatures,
1623       const bool theBefore)
1624 {
1625   return myObjs->removeFromFolder(theFeatures, theBefore);
1626 }
1627
1628 std::shared_ptr<ModelAPI_Feature> Model_Document::feature(
1629     const std::shared_ptr<ModelAPI_Result>& theResult)
1630 {
1631   if (myObjs == 0) // may be on close
1632     return std::shared_ptr<ModelAPI_Feature>();
1633   return myObjs->feature(theResult);
1634 }
1635
1636 FeaturePtr Model_Document::featureByLab(const TDF_Label& theLab) {
1637   TDF_Label aCurrentLab = theLab;
1638   while(aCurrentLab.Depth() > 3)
1639     aCurrentLab = aCurrentLab.Father();
1640   return myObjs->feature(aCurrentLab);
1641 }
1642
1643 ResultPtr Model_Document::resultByLab(const TDF_Label& theLab)
1644 {
1645   TDF_Label aCurrentLab = theLab;
1646   while(aCurrentLab.Depth() > 3) {
1647     ObjectPtr aResultObj = myObjs->object(aCurrentLab);
1648     if (aResultObj.get()) {
1649       return std::dynamic_pointer_cast<ModelAPI_Result>(aResultObj); // this may be null if feature
1650     }
1651     aCurrentLab = aCurrentLab.Father();
1652   }
1653   return ResultPtr(); // not found
1654 }
1655
1656 void Model_Document::addNamingName(const TDF_Label theLabel, std::wstring theName)
1657 {
1658   std::map<std::wstring, std::list<TDF_Label> >::iterator aFind = myNamingNames.find(theName);
1659
1660   if (aFind != myNamingNames.end()) { // to avoid duplicate-labels
1661     // to keep correct order in spite of history line management
1662     std::list<TDF_Label>::iterator anAddAfterThis = aFind->second.end();
1663     FeaturePtr anAddedFeature = featureByLab(theLabel);
1664     std::list<TDF_Label>::iterator aLabIter = aFind->second.begin();
1665     while(aLabIter != aFind->second.end()) {
1666       if (theLabel.IsEqual(*aLabIter)) {
1667         std::list<TDF_Label>::iterator aTmpIter = aLabIter;
1668         aLabIter++;
1669         aFind->second.erase(aTmpIter);
1670       } else {
1671         FeaturePtr aCurFeature = featureByLab(*aLabIter);
1672         if (aCurFeature.get() && anAddedFeature.get() &&
1673             myObjs->isLater(anAddedFeature, aCurFeature))
1674           anAddAfterThis = aLabIter;
1675
1676         aLabIter++;
1677       }
1678     }
1679     if (anAddAfterThis != aFind->second.end()) {
1680       anAddAfterThis++;
1681       if (anAddAfterThis != aFind->second.end()) {
1682         myNamingNames[theName].insert(anAddAfterThis, theLabel); // inserts before anAddAfterThis
1683         return;
1684       }
1685     }
1686   }
1687   myNamingNames[theName].push_back(theLabel);
1688 }
1689
1690 void Model_Document::changeNamingName(const std::wstring theOldName,
1691                                       const std::wstring theNewName,
1692                                       const TDF_Label& theLabel)
1693 {
1694   std::map<std::wstring, std::list<TDF_Label> >::iterator aFind = myNamingNames.find(theOldName);
1695   if (aFind != myNamingNames.end()) {
1696     std::list<TDF_Label>::iterator aLabIter = aFind->second.begin();
1697     for(; aLabIter != aFind->second.end(); aLabIter++) {
1698       if (theLabel.IsEqual(*aLabIter)) { // found the label
1699         myNamingNames[theNewName].push_back(theLabel);
1700         if (aFind->second.size() == 1) { // only one element, so, just change the name
1701           myNamingNames.erase(theOldName);
1702         } else { // remove from the list
1703           aFind->second.erase(aLabIter);
1704         }
1705         // check the sketch vertex name located under renamed sketch line
1706         TDF_ChildIDIterator aChild(theLabel, TDataStd_Name::GetID());
1707         for(; aChild.More(); aChild.Next()) {
1708           Handle(TDataStd_Name) aSubName = Handle(TDataStd_Name)::DownCast(aChild.Value());
1709           std::wstring aName = (wchar_t*)aSubName->Get().ToExtString();
1710           if (aName.find(theOldName) == 0) { // started from parent name
1711             std::wstring aNewSubName = theNewName + aName.substr(theOldName.size());
1712             changeNamingName(aName, aNewSubName, aSubName->Label());
1713             aSubName->Set(aNewSubName.c_str());
1714           }
1715         }
1716         return;
1717       }
1718     }
1719   }
1720 }
1721
1722 // returns true if names consist of the same sub-elements but with different order.
1723 // Sub-elements are separated by "-" symbol. First part must be "Face", second at the same place.
1724 static bool IsExchangedName(const TCollection_ExtendedString& theName1,
1725                             const TCollection_ExtendedString& theName2)
1726 {
1727   static const TCollection_ExtendedString aSepStr("-");
1728   static const Standard_ExtString aSep = aSepStr.ToExtString();
1729   static const TCollection_ExtendedString aWireTail("_wire");
1730   if (theName1.Token(aSep, 1) != "Face" || theName2.Token(aSep, 1) != "Face")
1731     return false;
1732   if (theName1.Token(aSep, 2) != theName2.Token(aSep, 2))
1733     return false;
1734   // Collect Map of the sub-elements of the first name
1735   NCollection_Map<TCollection_ExtendedString> aSubsMap;
1736   TCollection_ExtendedString aWireSuffix;
1737   int a = 3;
1738   for (; true ; a++) {
1739     TCollection_ExtendedString aToken = theName1.Token(aSep, a);
1740     if (aToken.IsEmpty())
1741       break;
1742     int aTailPos = aToken.Search(aWireTail);
1743     if (aTailPos > 0) {
1744       aWireSuffix = aToken.Split(aTailPos - 1);
1745     }
1746     aSubsMap.Add(aToken);
1747   }
1748   // check all subs in the second name are in the map
1749   for (int a2 = 3; true; a2++) {
1750     TCollection_ExtendedString aToken = theName2.Token(aSep, a2);
1751     if (aToken.IsEmpty()) {
1752       if (a2 != a) // number of sub-elements is not equal
1753         return false;
1754       break;
1755     }
1756     int aTailPos = aToken.Search(aWireTail);
1757     if (aTailPos > 0) {
1758       TCollection_ExtendedString aSuffix = aToken.Split(aTailPos - 1);
1759       if (aWireSuffix != aSuffix)
1760         return false;
1761     }
1762     if (!aSubsMap.Contains(aToken))
1763       return false;
1764   }
1765   return true;
1766 }
1767
1768 TDF_Label Model_Document::findNamingName(std::wstring theName, ResultPtr theContext)
1769 {
1770   std::map<std::wstring, std::list<TDF_Label> >::iterator aFind = myNamingNames.find(theName);
1771   if (aFind != myNamingNames.end()) {
1772       std::list<TDF_Label>::reverse_iterator aLabIter = aFind->second.rbegin();
1773       for(; aLabIter != aFind->second.rend(); aLabIter++) {
1774         if (theContext.get()) {
1775           // context is defined and not like this, so, skip
1776           if (theContext == myObjs->object(aLabIter->Father()))
1777             return *aLabIter;
1778         }
1779       }
1780       return *(aFind->second.rbegin()); // no more variants, so, return the last
1781   }
1782   // not found exact name, try to find by sub-components
1783   std::string::size_type aSlash = theName.rfind('/');
1784   if (aSlash != std::string::npos) {
1785     std::wstring anObjName = theName.substr(0, aSlash);
1786     aFind = myNamingNames.find(anObjName);
1787     if (aFind != myNamingNames.end()) {
1788       TCollection_ExtendedString aSubName(theName.substr(aSlash + 1).c_str());
1789       // iterate all possible same-named labels starting from the last one (the recent)
1790       std::list<TDF_Label>::reverse_iterator aLabIter = aFind->second.rbegin();
1791       for(; aLabIter != aFind->second.rend(); aLabIter++) {
1792         if (theContext.get()) {
1793           // context is defined and not like this, so, skip
1794           if (theContext != myObjs->object(aLabIter->Father()))
1795             continue;
1796         }
1797         // copy aSubName to avoid incorrect further processing after its suffix cutting
1798         TCollection_ExtendedString aSubNameCopy(aSubName);
1799         TDF_Label aFaceLabelWithExchangedSubs; // check also exchanged sub-elements of the name
1800         // searching sub-labels with this name
1801         TDF_ChildIDIterator aNamesIter(*aLabIter, TDataStd_Name::GetID(), Standard_True);
1802         for(; aNamesIter.More(); aNamesIter.Next()) {
1803           Handle(TDataStd_Name) aName = Handle(TDataStd_Name)::DownCast(aNamesIter.Value());
1804           if (aName->Get() == aSubNameCopy)
1805             return aName->Label();
1806           if (aName->Get().Length() == aSubNameCopy.Length() &&
1807               IsExchangedName(aName->Get(),  aSubNameCopy))
1808             aFaceLabelWithExchangedSubs = aName->Label();
1809         }
1810         if (!aFaceLabelWithExchangedSubs.IsNull())
1811           return aFaceLabelWithExchangedSubs;
1812         // If not found child label with the exact sub-name, then try to find compound with
1813         // such sub-name without suffix.
1814         Standard_Integer aSuffixPos = aSubNameCopy.SearchFromEnd('_');
1815         if (aSuffixPos != -1 && aSuffixPos != aSubNameCopy.Length()) {
1816           TCollection_ExtendedString anIndexStr = aSubNameCopy.Split(aSuffixPos);
1817           aSubNameCopy.Remove(aSuffixPos);
1818           aNamesIter.Initialize(*aLabIter, TDataStd_Name::GetID(), Standard_True);
1819           for(; aNamesIter.More(); aNamesIter.Next()) {
1820             Handle(TDataStd_Name) aName = Handle(TDataStd_Name)::DownCast(aNamesIter.Value());
1821             if (aName->Get() == aSubNameCopy) {
1822               return aName->Label();
1823             }
1824           }
1825           // check also "this" label
1826           Handle(TDataStd_Name) aName;
1827           if (aLabIter->FindAttribute(TDataStd_Name::GetID(), aName)) {
1828             if (aName->Get() == aSubNameCopy) {
1829               return aName->Label();
1830             }
1831           }
1832         }
1833       }
1834       // verify context's name is same as sub-component's and use context's label
1835       if (aSubName.IsEqual(anObjName.c_str()))
1836         return *(aFind->second.rbegin());
1837     }
1838   }
1839   return TDF_Label(); // not found
1840 }
1841
1842 bool Model_Document::isLaterByDep(FeaturePtr theThis, FeaturePtr theOther) {
1843   // check dependencies first: if theOther depends on theThis, theThis is not later
1844   std::list<std::pair<std::string, std::list<std::shared_ptr<ModelAPI_Object> > > > aRefs;
1845   theOther->data()->referencesToObjects(aRefs);
1846   std::list<std::pair<std::string, std::list<std::shared_ptr<ModelAPI_Object> > > >::iterator
1847     aRefIt = aRefs.begin();
1848   for(; aRefIt != aRefs.end(); aRefIt++) {
1849     std::list<ObjectPtr>::iterator aRefObjIt = aRefIt->second.begin();
1850     for(; aRefObjIt != aRefIt->second.end(); aRefObjIt++) {
1851       ObjectPtr aRefObj = *aRefObjIt;
1852       if (aRefObj.get()) {
1853         FeaturePtr aRefFeat = std::dynamic_pointer_cast<ModelAPI_Feature>(aRefObj);
1854         if (!aRefFeat.get()) { // take feature of the result
1855           aRefFeat = feature(std::dynamic_pointer_cast<ModelAPI_Result>(aRefObj));
1856         }
1857         if (aRefFeat.get()) {
1858           if (aRefFeat == theThis)
1859             return false; // other references to this, so other later than this
1860           //if (std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aRefFeat)) {
1861           //  if (!isLaterByDep(theThis, aRefFeat)) // nested composites: recursion
1862           //    return false;
1863           //}
1864         }
1865       }
1866     }
1867   }
1868   FeaturePtr aThisOwner = ModelAPI_Tools::compositeOwner(theThis);
1869   if (aThisOwner.get()) {
1870     if (aThisOwner == theOther)
1871       return true; // composite owner is later that its sub
1872     if (!isLaterByDep(aThisOwner, theOther))
1873       return false;
1874   }
1875   return myObjs->isLater(theThis, theOther);
1876 }
1877
1878 int Model_Document::numberOfNameInHistory(
1879   const ObjectPtr& theNameObject, const TDF_Label& theStartFrom)
1880 {
1881   std::map<std::wstring, std::list<TDF_Label> >::iterator aFind =
1882     myNamingNames.find(theNameObject->data()->name());
1883   if (aFind == myNamingNames.end() || aFind->second.size() < 2) {
1884     return 1; // no need to specify the name by additional identifiers
1885   }
1886   // get the feature of the object for relative compare
1887   FeaturePtr aStart = myObjs->feature(theStartFrom);
1888   if (!aStart.get()) // strange, but can not find feature by the label
1889     return 1;
1890   // feature that contain result with this name
1891   FeaturePtr aNameFeature;
1892   ResultPtr aNameResult = std::dynamic_pointer_cast<ModelAPI_Result>(theNameObject);
1893   if (aNameResult)
1894     aNameFeature = myObjs->feature(aNameResult);
1895   else
1896     aNameFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(theNameObject);
1897   // iterate all labels with this name to find the nearest just before or equal relative
1898   std::list<TDF_Label>::reverse_iterator aLabIter = aFind->second.rbegin();
1899   for(; aLabIter != aFind->second.rend(); aLabIter++) {
1900     FeaturePtr aLabFeat = featureByLab(*aLabIter);
1901     if (!aLabFeat.get())
1902       continue;
1903     if (isLaterByDep(aStart, aLabFeat)) // skip also start: its result don't used
1904       break;
1905   }
1906   int aResIndex = 1;
1907   for(; aLabIter != aFind->second.rend(); aLabIter++) {
1908     FeaturePtr aLabFeat = featureByLab(*aLabIter);
1909     if (!aLabFeat.get())
1910       continue;
1911     if (aLabFeat == aNameFeature || isLaterByDep(aNameFeature, aLabFeat))
1912       return aResIndex;
1913     aResIndex++;
1914   }
1915   return aResIndex; // strange
1916 }
1917
1918 ResultPtr Model_Document::findByName(
1919   std::wstring& theName, std::wstring& theSubShapeName, bool& theUniqueContext)
1920 {
1921   int aNumInHistory = 0;
1922   std::wstring aName = theName;
1923   ResultPtr aRes = myObjs->findByName(aName);
1924   theUniqueContext = !(aRes.get() && myNamingNames.find(aName) != myNamingNames.end());
1925   while(!aRes.get() && aName[0] == '_') { // this may be theContext with the history index
1926     aNumInHistory++;
1927     aName = aName.substr(1);
1928     aRes = myObjs->findByName(aName);
1929   }
1930   if (aNumInHistory) {
1931     std::map<std::wstring, std::list<TDF_Label> >::iterator aFind = myNamingNames.find(aName);
1932     if (aFind != myNamingNames.end() && aFind->second.size() > aNumInHistory) {
1933       std::list<TDF_Label>::reverse_iterator aLibIt = aFind->second.rbegin();
1934       for(; aNumInHistory != 0; aNumInHistory--)
1935         aLibIt++;
1936       const TDF_Label& aResultLab = *aLibIt;
1937       aRes = std::dynamic_pointer_cast<ModelAPI_Result>(myObjs->object(aResultLab.Father()));
1938       if (aRes) { // modify the incoming names
1939         if (!theSubShapeName.empty())
1940           theSubShapeName = theSubShapeName.substr(theName.size() - aName.size());
1941         theName = aName;
1942       }
1943     }
1944   }
1945   return aRes;
1946 }
1947
1948 std::list<std::shared_ptr<ModelAPI_Feature> > Model_Document::allFeatures()
1949 {
1950   return myObjs->allFeatures();
1951 }
1952
1953 std::list<std::shared_ptr<ModelAPI_Object> > Model_Document::allObjects()
1954 {
1955   return myObjs->allObjects();
1956 }
1957
1958 void Model_Document::setActive(const bool theFlag)
1959 {
1960   if (theFlag != myIsActive) {
1961     myIsActive = theFlag;
1962     // redisplay all the objects of this part
1963     static Events_Loop* aLoop = Events_Loop::loop();
1964     static Events_ID aRedispEvent = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
1965
1966     for(int a = size(ModelAPI_Feature::group()) - 1; a >= 0; a--) {
1967       FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(
1968         object(ModelAPI_Feature::group(), a));
1969       if (aFeature.get() && aFeature->data()->isValid()) {
1970         std::list<ResultPtr> aResults;
1971         ModelAPI_Tools::allResults(aFeature, aResults);
1972         for (std::list<ResultPtr>::iterator aRes = aResults.begin();
1973                                                 aRes != aResults.end(); aRes++) {
1974           ModelAPI_EventCreator::get()->sendUpdated(*aRes, aRedispEvent);
1975         }
1976       }
1977     }
1978   }
1979 }
1980
1981 bool Model_Document::isActive() const
1982 {
1983   return myIsActive;
1984 }
1985
1986 int Model_Document::transactionID()
1987 {
1988   Handle(TDataStd_Integer) anIndex;
1989   if (!generalLabel().FindChild(TAG_CURRENT_TRANSACTION).
1990       FindAttribute(TDataStd_Integer::GetID(), anIndex)) {
1991     anIndex = TDataStd_Integer::Set(generalLabel().FindChild(TAG_CURRENT_TRANSACTION), 1);
1992   }
1993   return anIndex->Get();
1994 }
1995
1996 void Model_Document::incrementTransactionID()
1997 {
1998   int aNewVal = transactionID() + 1;
1999   TDataStd_Integer::Set(generalLabel().FindChild(TAG_CURRENT_TRANSACTION), aNewVal);
2000 }
2001
2002 TDF_Label Model_Document::extConstructionsLabel() const
2003 {
2004   return myDoc->Main().FindChild(TAG_EXTERNAL_CONSTRUCTIONS);
2005 }
2006
2007 bool Model_Document::isOpened()
2008 {
2009   return myObjs && !myDoc.IsNull();
2010 }
2011
2012 int Model_Document::numInternalFeatures()
2013 {
2014   return myObjs->numInternalFeatures();
2015 }
2016
2017 std::shared_ptr<ModelAPI_Feature> Model_Document::internalFeature(const int theIndex)
2018 {
2019   return myObjs->internalFeature(theIndex);
2020 }
2021
2022 void Model_Document::synchronizeTransactions()
2023 {
2024   Model_Document* aRoot =
2025     std::dynamic_pointer_cast<Model_Document>(ModelAPI_Session::get()->moduleDocument()).get();
2026   if (aRoot == this)
2027     return; // don't need to synchronize root with root
2028
2029   std::shared_ptr<Model_Session> aSession =
2030     std::dynamic_pointer_cast<Model_Session>(Model_Session::get());
2031   while(myRedos.size() > aRoot->myRedos.size()) { // remove redo in this
2032     aSession->setCheckTransactions(false);
2033     redo();
2034     aSession->setCheckTransactions(true);
2035   }
2036   /* this case can not be reproduced in any known case for the current moment, so, just comment
2037   while(myRedos.size() < aRoot->myRedos.size()) { // add more redo in this
2038     undoInternal(false, true);
2039   }*/
2040 }
2041
2042 /// Feature that is used for selection in the Part document by the external request
2043 class Model_SelectionInPartFeature : public ModelAPI_Feature {
2044 public:
2045   /// Nothing to do in constructor
2046   Model_SelectionInPartFeature() : ModelAPI_Feature() {}
2047
2048   /// Returns the unique kind of a feature
2049   virtual const std::string& getKind() {
2050     static std::string MY_KIND("InternalSelectionInPartFeature");
2051     return MY_KIND;
2052   }
2053   /// Request for initialization of data model of the object: adding all attributes
2054   virtual void initAttributes() {
2055     data()->addAttribute("selection", ModelAPI_AttributeSelectionList::typeId());
2056   }
2057   /// Nothing to do in the execution function
2058   virtual void execute() {}
2059
2060 };
2061
2062 //! Returns the feature that is used for calculation of selection externally from the document
2063 AttributeSelectionListPtr Model_Document::selectionInPartFeature()
2064 {
2065   // return already created, otherwise create
2066   if (!mySelectionFeature.get() || !mySelectionFeature->data()->isValid()) {
2067     // create a new one
2068     mySelectionFeature = FeaturePtr(new Model_SelectionInPartFeature);
2069
2070     TDF_Label aFeatureLab = generalLabel().FindChild(TAG_SELECTION_FEATURE);
2071     std::shared_ptr<Model_Data> aData(new Model_Data);
2072     aData->setLabel(aFeatureLab.FindChild(1));
2073     aData->setObject(mySelectionFeature);
2074     mySelectionFeature->setDoc(myObjs->owner());
2075     mySelectionFeature->setData(aData);
2076     std::wstring aName = id() + L"_Part";
2077     mySelectionFeature->data()->setName(aName);
2078     mySelectionFeature->setDoc(myObjs->owner());
2079     mySelectionFeature->initAttributes();
2080     mySelectionFeature->init(); // to make it enabled and Update correctly
2081     // this update may cause recomputation of the part after selection on it, that is not needed
2082     mySelectionFeature->data()->blockSendAttributeUpdated(true);
2083   }
2084   return mySelectionFeature->selectionList("selection");
2085 }
2086
2087 FeaturePtr Model_Document::lastFeature()
2088 {
2089   if (myObjs)
2090     return myObjs->lastFeature();
2091   return FeaturePtr();
2092 }
2093
2094 static Handle(TNaming_NamedShape) searchForOriginalShape(TopoDS_Shape theShape, TDF_Label aMain) {
2095   Handle(TNaming_NamedShape) aResult;
2096   while(!theShape.IsNull()) { // searching for the very initial shape that produces this one
2097     TopoDS_Shape aShape = theShape;
2098     theShape.Nullify();
2099     // to avoid crash of TNaming_SameShapeIterator if pure shape does not exists
2100     if (!TNaming_Tool::HasLabel(aMain, aShape))
2101       break;
2102     for(TNaming_SameShapeIterator anIter(aShape, aMain); anIter.More(); anIter.Next()) {
2103       TDF_Label aNSLab = anIter.Label();
2104       Handle(TNaming_NamedShape) aNS;
2105       if (aNSLab.FindAttribute(TNaming_NamedShape::GetID(), aNS)) {
2106         for(TNaming_Iterator aShapesIter(aNS); aShapesIter.More(); aShapesIter.Next()) {
2107           if (aShapesIter.Evolution() == TNaming_SELECTED ||
2108               aShapesIter.Evolution() == TNaming_DELETE)
2109             continue; // don't use the selection evolution
2110           if (aShapesIter.NewShape().IsSame(aShape)) { // found the original shape
2111             aResult = aNS;
2112             if (aResult->Evolution() == TNaming_MODIFY)
2113               theShape = aShapesIter.OldShape();
2114             // otherwise may me searching for another item of this shape with longer history
2115             if (!theShape.IsNull())
2116               break;
2117           }
2118         }
2119       }
2120     }
2121   }
2122   return aResult;
2123 }
2124
2125 std::shared_ptr<ModelAPI_Feature> Model_Document::producedByFeature(
2126     std::shared_ptr<ModelAPI_Result> theResult,
2127     const std::shared_ptr<GeomAPI_Shape>& theShape)
2128 {
2129   ResultBodyPtr aBody = std::dynamic_pointer_cast<ModelAPI_ResultBody>(theResult);
2130   if (!aBody.get()) {
2131     return feature(theResult); // for not-body just returns the feature that produced this result
2132   }
2133   // otherwise get the shape and search the very initial label for it
2134   TopoDS_Shape aShape = theShape->impl<TopoDS_Shape>();
2135   if (aShape.IsNull())
2136     return FeaturePtr();
2137
2138   // for compsolids and compounds all the naming is located in the main object, so, try to use
2139   // it first
2140   ResultBodyPtr aMain = ModelAPI_Tools::bodyOwner(theResult);
2141   while (aMain.get()) { // get the top-most main
2142     ResultBodyPtr aNextMain = ModelAPI_Tools::bodyOwner(aMain);
2143     if (aNextMain.get())
2144       aMain = aNextMain;
2145     else break;
2146   }
2147   if (aMain.get()) {
2148     FeaturePtr aMainRes = producedByFeature(aMain, theShape);
2149     if (aMainRes)
2150       return aMainRes;
2151   }
2152
2153   std::shared_ptr<Model_Data> aBodyData = std::dynamic_pointer_cast<Model_Data>(theResult->data());
2154   if (!aBodyData.get() || !aBodyData->isValid())
2155     return FeaturePtr();
2156
2157   TopoDS_Shape anOldShape; // old shape in the pair old shape->theShape in the named shape
2158   TopoDS_Shape aShapeContainer; // old shape of the shape that contains aShape as sub-element
2159   Handle(TNaming_NamedShape) aCandidatInThis, aCandidatContainer;
2160   TDF_Label aBodyLab = aBodyData->shapeLab();
2161   // use child and this label (the lowest priority)
2162   TDF_ChildIDIterator aNSIter(aBodyLab, TNaming_NamedShape::GetID(), Standard_True);
2163   bool aUseThis = !aNSIter.More();
2164   while(anOldShape.IsNull() && (aNSIter.More() || aUseThis)) {
2165     Handle(TNaming_NamedShape) aNS;
2166     if (aUseThis) {
2167       if (!aBodyLab.FindAttribute(TNaming_NamedShape::GetID(), aNS))
2168         break;
2169     } else {
2170       aNS = Handle(TNaming_NamedShape)::DownCast(aNSIter.Value());
2171     }
2172     for(TNaming_Iterator aShapesIter(aNS); aShapesIter.More(); aShapesIter.Next()) {
2173       if (aShapesIter.Evolution() == TNaming_SELECTED || aShapesIter.Evolution() == TNaming_DELETE)
2174         continue; // don't use the selection evolution
2175       if (aShapesIter.NewShape().IsSame(aShape)) { // found the original shape
2176         aCandidatInThis = aNS;
2177         if (aCandidatInThis->Evolution() == TNaming_MODIFY)
2178           anOldShape = aShapesIter.OldShape();
2179         // otherwise may me searching for another item of this shape with longer history
2180         if (!anOldShape.IsNull())
2181           break;
2182       }
2183       // check that the shape contains aShape as sub-shape to fill container
2184       if (aShapesIter.NewShape().ShapeType() < aShape.ShapeType() && aCandidatContainer.IsNull()) {
2185         TopExp_Explorer anExp(aShapesIter.NewShape(), aShape.ShapeType());
2186         for(; anExp.More(); anExp.Next()) {
2187           if (aShape.IsSame(anExp.Current())) {
2188             aCandidatContainer = aNS;
2189             aShapeContainer = aShapesIter.NewShape();
2190           }
2191         }
2192       }
2193     }
2194     // iterate to the next label or to the body label in the end
2195     if (!aUseThis)
2196       aNSIter.Next();
2197     if (!aNSIter.More()) {
2198       if (aUseThis)
2199         break;
2200       aUseThis = true;
2201     }
2202   }
2203   if (aCandidatInThis.IsNull()) {
2204     // to fix 1512: searching for original shape of this shape
2205     // if modification of it is not in this result
2206     aCandidatInThis = searchForOriginalShape(aShape, myDoc->Main());
2207     if (aCandidatInThis.IsNull()) {
2208       if (aCandidatContainer.IsNull())
2209         return FeaturePtr();
2210       // with the lower priority use the higher level shape that contains aShape
2211       aCandidatInThis = aCandidatContainer;
2212       anOldShape = aShapeContainer;
2213     } else {
2214       // to stop the searching by the following searchForOriginalShape
2215       anOldShape.Nullify();
2216     }
2217   }
2218
2219   Handle(TNaming_NamedShape) aNS = searchForOriginalShape(anOldShape, myDoc->Main());
2220   if (!aNS.IsNull())
2221     aCandidatInThis = aNS;
2222
2223   FeaturePtr aResult;
2224   TDF_Label aResultLab = aCandidatInThis->Label();
2225   while(aResultLab.Depth() > 3)
2226     aResultLab = aResultLab.Father();
2227   FeaturePtr aFeature = myObjs->feature(aResultLab);
2228   if (aFeature.get()) {
2229     if (!aResult.get() || myObjs->isLater(aResult, aFeature)) {
2230       aResult = aFeature;
2231     }
2232   }
2233   return aResult;
2234 }
2235
2236 bool Model_Document::isLater(FeaturePtr theLater, FeaturePtr theCurrent) const
2237 {
2238   return myObjs->isLater(theLater, theCurrent);
2239 }
2240
2241 // Object Browser nodes states
2242 // LCOV_EXCL_START
2243 void Model_Document::storeNodesState(const std::list<bool>& theStates)
2244 {
2245   TDF_Label aLab = generalLabel().FindChild(TAG_NODES_STATE);
2246   aLab.ForgetAllAttributes();
2247   if (!theStates.empty()) {
2248     Handle(TDataStd_BooleanArray) anArray =
2249       TDataStd_BooleanArray::Set(aLab, 0, int(theStates.size()) - 1);
2250     std::list<bool>::const_iterator aState = theStates.begin();
2251     for(int anIndex = 0; aState != theStates.end(); aState++, anIndex++) {
2252       anArray->SetValue(anIndex, *aState);
2253     }
2254   }
2255 }
2256
2257 void Model_Document::restoreNodesState(std::list<bool>& theStates) const
2258 {
2259   TDF_Label aLab = generalLabel().FindChild(TAG_NODES_STATE);
2260   Handle(TDataStd_BooleanArray) anArray;
2261   if (aLab.FindAttribute(TDataStd_BooleanArray::GetID(), anArray)) {
2262     int anUpper = anArray->Upper();
2263     for(int anIndex = 0; anIndex <= anUpper; anIndex++) {
2264       theStates.push_back(anArray->Value(anIndex) == Standard_True);
2265     }
2266   }
2267 }
2268 // LCOV_EXCL_STOP
2269
2270 void Model_Document::eraseAllFeatures()
2271 {
2272   if (myObjs)
2273     myObjs->eraseAllFeatures();
2274 }
2275
2276 std::shared_ptr<ModelAPI_Feature> Model_Document::nextFeature(
2277   std::shared_ptr<ModelAPI_Feature> theCurrent, const bool theReverse) const
2278 {
2279   if (theCurrent.get() && myObjs) {
2280     int anIndex = kUNDEFINED_FEATURE_INDEX;
2281     return myObjs->nextFeature(theCurrent, anIndex, theReverse);
2282   }
2283   return FeaturePtr(); // nothing by default
2284 }
2285
2286 void Model_Document::setExecuteFeatures(const bool theFlag)
2287 {
2288   myExecuteFeatures = theFlag;
2289   const std::set<int> aSubs = subDocuments();
2290   std::set<int>::iterator aSubIter = aSubs.begin();
2291   for (; aSubIter != aSubs.end(); aSubIter++) {
2292     if (!subDoc(*aSubIter)->myObjs)
2293       continue;
2294     subDoc(*aSubIter)->setExecuteFeatures(theFlag);
2295   }
2296 }
2297
2298 void Model_Document::appendTransactionToPrevious()
2299 {
2300   Transaction anAppended =  myTransactions.back();
2301   myTransactions.pop_back();
2302   if (!myTransactions.empty()) { // if it is empty, just forget the appended
2303     myTransactions.back().myOCAFNum += anAppended.myOCAFNum;
2304   }
2305   // propagate the same action to sub-documents
2306   const std::set<int> aSubs = subDocuments();
2307   for (std::set<int>::iterator aSubIter = aSubs.begin(); aSubIter != aSubs.end(); aSubIter++) {
2308     subDoc(*aSubIter)->appendTransactionToPrevious();
2309   }
2310 }
2311
2312 /// GUID for keeping information about the auto-recomputation state
2313 static const Standard_GUID kAutoRecomputationID("8493fb74-0674-4912-a100-1cf46c7cfab3");
2314
2315 void Model_Document::setAutoRecomutationState(const bool theState)
2316 {
2317   if (theState)
2318     generalLabel().FindChild(TAG_CURRENT_TRANSACTION).ForgetAttribute(kAutoRecomputationID);
2319   else
2320     TDataStd_UAttribute::Set(
2321       generalLabel().FindChild(TAG_CURRENT_TRANSACTION), kAutoRecomputationID);
2322 }
2323
2324 bool Model_Document::autoRecomutationState() const
2325 {
2326   return !generalLabel().FindChild(TAG_CURRENT_TRANSACTION).IsAttribute(kAutoRecomputationID);
2327 }