src/Model/Model_Document.cpp

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