src/Model/Model_Document.cpp

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        Model_Document.cxx
   4 // Created:     28 Feb 2014
   5 // Author:      Mikhail PONIKAROV
   6
   7 #include <Model_Document.h>
   8 #include <Model_Data.h>
   9 #include <Model_Objects.h>
  10 #include <Model_Application.h>
  11 #include <Model_Session.h>
  12 #include <Model_Events.h>
  13 #include <ModelAPI_ResultPart.h>
  14 #include <ModelAPI_Validator.h>
  15 #include <ModelAPI_CompositeFeature.h>
  16 #include <ModelAPI_AttributeSelectionList.h>
  17 #include <ModelAPI_Tools.h>
  18 #include <ModelAPI_ResultBody.h>
  19 #include <Events_Loop.h>
  20 #include <Events_InfoMessage.h>
  21
  22 #include <TDataStd_Integer.hxx>
  23 #include <TDataStd_Comment.hxx>
  24 #include <TDF_ChildIDIterator.hxx>
  25 #include <TDataStd_ReferenceArray.hxx>
  26 #include <TDataStd_ReferenceList.hxx>
  27 #include <TDataStd_IntegerArray.hxx>
  28 #include <TDataStd_HLabelArray1.hxx>
  29 #include <TDataStd_Name.hxx>
  30 #include <TDataStd_AsciiString.hxx>
  31 #include <TDF_Reference.hxx>
  32 #include <TDF_ChildIDIterator.hxx>
  33 #include <TDF_LabelMapHasher.hxx>
  34 #include <TDF_Delta.hxx>
  35 #include <TDF_AttributeDelta.hxx>
  36 #include <TDF_AttributeDeltaList.hxx>
  37 #include <TDF_ListIteratorOfAttributeDeltaList.hxx>
  38 #include <TDF_ListIteratorOfLabelList.hxx>
  39 #include <TDF_LabelMap.hxx>
  40 #include <TNaming_SameShapeIterator.hxx>
  41 #include <TNaming_Iterator.hxx>
  42 #include <TNaming_NamedShape.hxx>
  43 #include <TNaming_Tool.hxx>
  44
  45 #include <TopExp_Explorer.hxx>
  46 #include <TopoDS_Shape.hxx>
  47
  48 #include <OSD_File.hxx>
  49 #include <OSD_Path.hxx>
  50 #include <CDF_Session.hxx>
  51 #include <CDF_Directory.hxx>
  52
  53 #include <climits>
  54 #ifndef WIN32
  55 #include <sys/stat.h>
  56 #endif
  57
  58 #ifdef WIN32
  59 # define _separator_ '\\'
  60 #else
  61 # define _separator_ '/'
  62 #endif
  63
  64 static const int UNDO_LIMIT = 1000;  // number of possible undo operations (big for sketcher)
  65
  66 static const int TAG_GENERAL = 1;  // general properties tag
  67
  68 // general sub-labels
  69 /// where the reference to the current feature label is located (or no attribute if null feature)
  70 static const int TAG_CURRENT_FEATURE = 1; ///< reference to the current feature
  71 static const int TAG_CURRENT_TRANSACTION = 2; ///< integer, index of the transaction
  72 static const int TAG_SELECTION_FEATURE = 3; ///< integer, tag of the selection feature label
  73 static const int TAG_NODES_STATE = 4; ///< array, tag of the Object Browser nodes states
  74
  75 Model_Document::Model_Document(const int theID, const std::string theKind)
  76     : myID(theID), myKind(theKind), myIsActive(false),
  77       myDoc(new TDocStd_Document("BinOcaf"))  // binary OCAF format
  78 {
  79 #ifdef DFBROWSER
  80   CDF_Session::CurrentSession()->Directory()->Add(myDoc);
  81 #endif
  82   myObjs = new Model_Objects(myDoc->Main());
  83   myDoc->SetUndoLimit(UNDO_LIMIT);
  84   myTransactionSave = 0;
  85   myExecuteFeatures = true;
  86   // to have something in the document and avoid empty doc open/save problem
  87   // in transaction for nesting correct working
  88   myDoc->NewCommand();
  89   TDataStd_Integer::Set(myDoc->Main().Father(), 0);
  90   // this to avoid creation of integer attribute outside the transaction after undo
  91   transactionID();
  92   myDoc->CommitCommand();
  93 }
  94
  95 void Model_Document::setThis(DocumentPtr theDoc)
  96 {
  97   myObjs->setOwner(theDoc);
  98 }
  99
 100 /// Returns the file name of this document by the name of directory and identifier of a document
 101 static TCollection_ExtendedString DocFileName(const char* theDirName, const std::string& theID)
 102 {
 103   TCollection_ExtendedString aPath((const Standard_CString) theDirName);
 104   // remove end-separators
 105   while(aPath.Length() &&
 106         (aPath.Value(aPath.Length()) == '\\' || aPath.Value(aPath.Length()) == '/'))
 107     aPath.Remove(aPath.Length());
 108   aPath += _separator_;
 109   aPath += theID.c_str();
 110   aPath += ".cbf";  // standard binary file extension
 111   return aPath;
 112 }
 113
 114 bool Model_Document::isRoot() const
 115 {
 116   return this == Model_Session::get()->moduleDocument().get();
 117 }
 118
 119 bool Model_Document::load(const char* theDirName, const char* theFileName, DocumentPtr theThis)
 120 {
 121   Handle(Model_Application) anApp = Model_Application::getApplication();
 122   if (isRoot()) {
 123     anApp->setLoadPath(theDirName);
 124   }
 125   TCollection_ExtendedString aPath(DocFileName(theDirName, theFileName));
 126   PCDM_ReaderStatus aStatus = (PCDM_ReaderStatus) -1;
 127   Handle(TDocStd_Document) aLoaded;
 128   try {
 129     aStatus = anApp->Open(aPath, aLoaded);
 130   } catch (Standard_Failure) {
 131     Handle(Standard_Failure) aFail = Standard_Failure::Caught();
 132     Events_InfoMessage("Model_Document",
 133         "Exception in opening of document: %1").arg(aFail->GetMessageString()).send();
 134     return false;
 135   }
 136   bool isError = aStatus != PCDM_RS_OK;
 137   if (isError) {
 138     switch (aStatus) {
 139       case PCDM_RS_UnknownDocument:
 140         Events_InfoMessage("Model_Document", "Can not open document").send();
 141         break;
 142       case PCDM_RS_AlreadyRetrieved:
 143         Events_InfoMessage("Model_Document", "Can not open document: already opened").send();
 144         break;
 145       case PCDM_RS_AlreadyRetrievedAndModified:
 146         Events_InfoMessage("Model_Document",
 147             "Can not open document: already opened and modified").send();
 148         break;
 149       case PCDM_RS_NoDriver:
 150         Events_InfoMessage("Model_Document",
 151                            "Can not open document: driver library is not found").send();
 152         break;
 153       case PCDM_RS_UnknownFileDriver:
 154         Events_InfoMessage("Model_Document",
 155                            "Can not open document: unknown driver for opening").send();
 156         break;
 157       case PCDM_RS_OpenError:
 158         Events_InfoMessage("Model_Document", "Can not open document: file open error").send();
 159         break;
 160       case PCDM_RS_NoVersion:
 161         Events_InfoMessage("Model_Document", "Can not open document: invalid version").send();
 162         break;
 163       case PCDM_RS_NoModel:
 164         Events_InfoMessage("Model_Document", "Can not open document: no data model").send();
 165         break;
 166       case PCDM_RS_NoDocument:
 167         Events_InfoMessage("Model_Document", "Can not open document: no document inside").send();
 168         break;
 169       case PCDM_RS_FormatFailure:
 170         Events_InfoMessage("Model_Document", "Can not open document: format failure").send();
 171         break;
 172       case PCDM_RS_TypeNotFoundInSchema:
 173         Events_InfoMessage("Model_Document", "Can not open document: invalid object").send();
 174         break;
 175       case PCDM_RS_UnrecognizedFileFormat:
 176         Events_InfoMessage("Model_Document",
 177                            "Can not open document: unrecognized file format").send();
 178         break;
 179       case PCDM_RS_MakeFailure:
 180         Events_InfoMessage("Model_Document", "Can not open document: make failure").send();
 181         break;
 182       case PCDM_RS_PermissionDenied:
 183         Events_InfoMessage("Model_Document", "Can not open document: permission denied").send();
 184         break;
 185       case PCDM_RS_DriverFailure:
 186         Events_InfoMessage("Model_Document", "Can not open document: driver failure").send();
 187         break;
 188       default:
 189         Events_InfoMessage("Model_Document", "Can not open document: unknown error").send();
 190         break;
 191     }
 192   }
 193   std::shared_ptr<Model_Session> aSession =
 194     std::dynamic_pointer_cast<Model_Session>(Model_Session::get());
 195   if (!isError) {
 196     myDoc = aLoaded;
 197     myDoc->SetUndoLimit(UNDO_LIMIT);
 198     // to avoid the problem that feature is created in the current, not this, document
 199     aSession->setActiveDocument(anApp->document(myID), false);
 200     aSession->setCheckTransactions(false);
 201     if (myObjs)
 202       delete myObjs;
 203     myObjs = new Model_Objects(myDoc->Main()); // synchronisation is inside
 204     myObjs->setOwner(theThis);
 205     // update the current features status
 206     setCurrentFeature(currentFeature(false), false);
 207     aSession->setCheckTransactions(true);
 208     aSession->setActiveDocument(Model_Session::get()->moduleDocument(), false);
 209     // this is done in Part result "activate", so no needed here. Causes not-blue active part.
 210     // aSession->setActiveDocument(anApp->getDocument(myID), true);
 211
 212     // make sub-parts as loaded by demand
 213     std::list<ResultPtr> aPartResults;
 214     myObjs->allResults(ModelAPI_ResultPart::group(), aPartResults);
 215     std::list<ResultPtr>::iterator aPartRes = aPartResults.begin();
 216     for(; aPartRes != aPartResults.end(); aPartRes++) {
 217       ResultPartPtr aPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(*aPartRes);
 218       if (aPart.get())
 219         anApp->setLoadByDemand(aPart->data()->name());
 220     }
 221
 222   } else { // open failed, but new documnet was created to work with it: inform the model
 223     aSession->setActiveDocument(Model_Session::get()->moduleDocument(), false);
 224   }
 225   return !isError;
 226 }
 227
 228 bool Model_Document::save(
 229   const char* theDirName, const char* theFileName, std::list<std::string>& theResults)
 230 {
 231   // create a directory in the root document if it is not yet exist
 232   Handle(Model_Application) anApp = Model_Application::getApplication();
 233   if (isRoot()) {
 234 #ifdef WIN32
 235     CreateDirectory(theDirName, NULL);
 236 #else
 237     mkdir(theDirName, 0x1ff);
 238 #endif
 239   }
 240   // filename in the dir is id of document inside of the given directory
 241   TCollection_ExtendedString aPath(DocFileName(theDirName, theFileName));
 242   PCDM_StoreStatus aStatus;
 243   try {
 244     aStatus = anApp->SaveAs(myDoc, aPath);
 245   } catch (Standard_Failure) {
 246     Handle(Standard_Failure) aFail = Standard_Failure::Caught();
 247     Events_InfoMessage("Model_Document",
 248         "Exception in saving of document: %1").arg(aFail->GetMessageString()).send();
 249     return false;
 250   }
 251   bool isDone = aStatus == PCDM_SS_OK || aStatus == PCDM_SS_No_Obj;
 252   if (!isDone) {
 253     switch (aStatus) {
 254       case PCDM_SS_DriverFailure:
 255         Events_InfoMessage("Model_Document",
 256                            "Can not save document: save driver-library failure").send();
 257         break;
 258       case PCDM_SS_WriteFailure:
 259         Events_InfoMessage("Model_Document", "Can not save document: file writing failure").send();
 260         break;
 261       case PCDM_SS_Failure:
 262       default:
 263         Events_InfoMessage("Model_Document", "Can not save document").send();
 264         break;
 265     }
 266   }
 267   myTransactionSave = int(myTransactions.size());
 268   if (isDone) {  // save also sub-documents if any
 269     theResults.push_back(TCollection_AsciiString(aPath).ToCString());
 270     // iterate all result parts to find all loaded or not yet loaded documents
 271     std::list<ResultPtr> aPartResults;
 272     myObjs->allResults(ModelAPI_ResultPart::group(), aPartResults);
 273     std::list<ResultPtr>::iterator aPartRes = aPartResults.begin();
 274     for(; aPartRes != aPartResults.end(); aPartRes++) {
 275       ResultPartPtr aPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(*aPartRes);
 276       if (!aPart->isActivated()) {
 277         // copy not-activated document that is not in the memory
 278         std::string aDocName = aPart->data()->name();
 279         if (!aDocName.empty()) {
 280           // just copy file
 281           TCollection_AsciiString aSubPath(DocFileName(anApp->loadPath().c_str(), aDocName));
 282           OSD_Path aPath(aSubPath);
 283           OSD_File aFile(aPath);
 284           if (aFile.Exists()) {
 285             TCollection_AsciiString aDestinationDir(DocFileName(theDirName, aDocName));
 286             OSD_Path aDestination(aDestinationDir);
 287             aFile.Copy(aDestination);
 288             theResults.push_back(aDestinationDir.ToCString());
 289           } else {
 290             Events_InfoMessage("Model_Document",
 291               "Can not open file %1 for saving").arg(aSubPath.ToCString()).send();
 292           }
 293         }
 294       } else { // simply save opened document
 295         isDone = std::dynamic_pointer_cast<Model_Document>(aPart->partDoc())->
 296           save(theDirName, aPart->data()->name().c_str(), theResults);
 297       }
 298     }
 299   }
 300   return isDone;
 301 }
 302
 303 void Model_Document::close(const bool theForever)
 304 {
 305   std::shared_ptr<ModelAPI_Session> aPM = Model_Session::get();
 306   if (!isRoot() && this == aPM->activeDocument().get()) {
 307     aPM->setActiveDocument(aPM->moduleDocument());
 308   } else if (isRoot()) {
 309     // erase the active document if root is closed
 310     aPM->setActiveDocument(DocumentPtr());
 311   }
 312   // close all subs
 313   const std::set<int> aSubs = subDocuments();
 314   std::set<int>::iterator aSubIter = aSubs.begin();
 315   for (; aSubIter != aSubs.end(); aSubIter++) {
 316     std::shared_ptr<Model_Document> aSub = subDoc(*aSubIter);
 317     if (aSub->myObjs) // if it was not closed before
 318       aSub->close(theForever);
 319   }
 320
 321   // close for thid document needs no transaction in this document
 322   std::static_pointer_cast<Model_Session>(Model_Session::get())->setCheckTransactions(false);
 323
 324   // close all only if it is really asked, otherwise it can be undoed/redoed
 325   if (theForever) {
 326     // flush everything to avoid messages with bad objects
 327     delete myObjs;
 328     myObjs = 0;
 329     if (myDoc->CanClose() == CDM_CCS_OK)
 330       myDoc->Close();
 331     mySelectionFeature.reset();
 332   } else {
 333     setCurrentFeature(FeaturePtr(), false); // disables all features
 334     // update the OB: features are disabled (on remove of Part)
 335     Events_Loop* aLoop = Events_Loop::loop();
 336     static Events_ID aDeleteEvent = Events_Loop::eventByName(EVENT_OBJECT_DELETED);
 337     aLoop->flush(aDeleteEvent);
 338   }
 339
 340   std::static_pointer_cast<Model_Session>(Model_Session::get())->setCheckTransactions(true);
 341 }
 342
 343 void Model_Document::startOperation()
 344 {
 345   incrementTransactionID(); // outside of transaction in order to avoid empty transactions keeping
 346   if (myDoc->HasOpenCommand()) {  // start of nested command
 347     if (myDoc->CommitCommand()) {
 348       // commit the current: it will contain all nested after compactification
 349       myTransactions.rbegin()->myOCAFNum++; // if has open command, the list is not empty
 350     }
 351     myNestedNum.push_back(0); // start of nested operation with zero transactions inside yet
 352     myDoc->OpenCommand();
 353   } else {  // start the simple command
 354     myDoc->NewCommand();
 355   }
 356   // starts a new operation
 357   myTransactions.push_back(Transaction());
 358   if (!myNestedNum.empty())
 359     (*myNestedNum.rbegin())++;
 360   myRedos.clear();
 361   // new command for all subs
 362   const std::set<int> aSubs = subDocuments();
 363   std::set<int>::iterator aSubIter = aSubs.begin();
 364   for (; aSubIter != aSubs.end(); aSubIter++)
 365     subDoc(*aSubIter)->startOperation();
 366 }
 367
 368 void Model_Document::compactNested()
 369 {
 370   if (!myNestedNum.empty()) {
 371     int aNumToCompact = *(myNestedNum.rbegin());
 372     int aSumOfTransaction = 0;
 373     for(int a = 0; a < aNumToCompact; a++) {
 374       aSumOfTransaction += myTransactions.rbegin()->myOCAFNum;
 375       myTransactions.pop_back();
 376     }
 377     // the latest transaction is the start of lower-level operation which startes the nested
 378     myTransactions.rbegin()->myOCAFNum += aSumOfTransaction;
 379     myNestedNum.pop_back();
 380   }
 381 }
 382
 383 /// Compares the content of the given attributes, returns true if equal.
 384 /// This method is used to avoid empty transactions when only "current" is changed
 385 /// to some value and then comes back in this transaction, so, it compares only
 386 /// references and Boolean and Integer Arrays for the current moment.
 387 static bool isEqualContent(Handle(TDF_Attribute) theAttr1, Handle(TDF_Attribute) theAttr2)
 388 {
 389   if (Standard_GUID::IsEqual(theAttr1->ID(), TDF_Reference::GetID())) { // reference
 390     Handle(TDF_Reference) aRef1 = Handle(TDF_Reference)::DownCast(theAttr1);
 391     Handle(TDF_Reference) aRef2 = Handle(TDF_Reference)::DownCast(theAttr2);
 392     if (aRef1.IsNull() && aRef2.IsNull())
 393       return true;
 394     if (aRef1.IsNull() || aRef2.IsNull())
 395       return false;
 396     return aRef1->Get().IsEqual(aRef2->Get()) == Standard_True;
 397   } else if (Standard_GUID::IsEqual(theAttr1->ID(), TDataStd_BooleanArray::GetID())) {
 398     Handle(TDataStd_BooleanArray) anArr1 = Handle(TDataStd_BooleanArray)::DownCast(theAttr1);
 399     Handle(TDataStd_BooleanArray) anArr2 = Handle(TDataStd_BooleanArray)::DownCast(theAttr2);
 400     if (anArr1.IsNull() && anArr2.IsNull())
 401       return true;
 402     if (anArr1.IsNull() || anArr2.IsNull())
 403       return false;
 404     if (anArr1->Lower() == anArr2->Lower() && anArr1->Upper() == anArr2->Upper()) {
 405       for(int a = anArr1->Lower(); a <= anArr1->Upper(); a++) {
 406         if (a == 1 && // second is for display
 407             anArr2->Label().Tag() == 1 && (anArr2->Label().Depth() == 4 ||
 408             anArr2->Label().Depth() == 6))
 409           continue;
 410         if (anArr1->Value(a) != anArr2->Value(a))
 411           return false;
 412       }
 413       return true;
 414     }
 415   } else if (Standard_GUID::IsEqual(theAttr1->ID(), TDataStd_IntegerArray::GetID())) {
 416     Handle(TDataStd_IntegerArray) anArr1 = Handle(TDataStd_IntegerArray)::DownCast(theAttr1);
 417     Handle(TDataStd_IntegerArray) anArr2 = Handle(TDataStd_IntegerArray)::DownCast(theAttr2);
 418     if (anArr1.IsNull() && anArr2.IsNull())
 419       return true;
 420     if (anArr1.IsNull() || anArr2.IsNull())
 421       return false;
 422     if (anArr1->Lower() == anArr2->Lower() && anArr1->Upper() == anArr2->Upper()) {
 423       for(int a = anArr1->Lower(); a <= anArr1->Upper(); a++)
 424         if (anArr1->Value(a) != anArr2->Value(a)) {
 425           // avoid the transaction ID checking
 426           if (a == 2 && anArr1->Upper() == 2 && anArr2->Label().Tag() == 1 &&
 427             (anArr2->Label().Depth() == 4 || anArr2->Label().Depth() == 6))
 428             continue;
 429           return false;
 430         }
 431       return true;
 432     }
 433   } else if (Standard_GUID::IsEqual(theAttr1->ID(), TDataStd_ReferenceArray::GetID())) {
 434     Handle(TDataStd_ReferenceArray) anArr1 = Handle(TDataStd_ReferenceArray)::DownCast(theAttr1);
 435     Handle(TDataStd_ReferenceArray) anArr2 = Handle(TDataStd_ReferenceArray)::DownCast(theAttr2);
 436     if (anArr1.IsNull() && anArr2.IsNull())
 437       return true;
 438     if (anArr1.IsNull() || anArr2.IsNull())
 439       return false;
 440     if (anArr1->Lower() == anArr2->Lower() && anArr1->Upper() == anArr2->Upper()) {
 441       for(int a = anArr1->Lower(); a <= anArr1->Upper(); a++)
 442         if (anArr1->Value(a) != anArr2->Value(a)) {
 443           // avoid the transaction ID checking
 444           if (a == 2 && anArr1->Upper() == 2 && anArr2->Label().Tag() == 1 &&
 445             (anArr2->Label().Depth() == 4 || anArr2->Label().Depth() == 6))
 446             continue;
 447           return false;
 448         }
 449       return true;
 450     }
 451   } else if (Standard_GUID::IsEqual(theAttr1->ID(), TDataStd_ReferenceList::GetID())) {
 452     Handle(TDataStd_ReferenceList) aList1 = Handle(TDataStd_ReferenceList)::DownCast(theAttr1);
 453     Handle(TDataStd_ReferenceList) aList2= Handle(TDataStd_ReferenceList)::DownCast(theAttr2);
 454     if (aList1.IsNull() && aList2.IsNull())
 455       return true;
 456     if (aList1.IsNull() || aList2.IsNull())
 457       return false;
 458     const TDF_LabelList& aLList1 = aList1->List();
 459     const TDF_LabelList& aLList2 = aList2->List();
 460     TDF_ListIteratorOfLabelList aLIter1(aLList1);
 461     TDF_ListIteratorOfLabelList aLIter2(aLList2);
 462     for(; aLIter1.More() && aLIter2.More(); aLIter1.Next(), aLIter2.Next()) {
 463       if (aLIter1.Value() != aLIter2.Value())
 464         return false;
 465     }
 466     return !aLIter1.More() && !aLIter2.More(); // both lists are with the same size
 467   } else if (Standard_GUID::IsEqual(theAttr1->ID(), TDF_TagSource::GetID())) {
 468     return true; // it just for created and removed feature: nothing is changed
 469   }
 470   return false;
 471 }
 472
 473 /// Returns true if the last transaction is actually empty: modification to te same values
 474 /// were performed only
 475 static bool isEmptyTransaction(const Handle(TDocStd_Document)& theDoc) {
 476   Handle(TDF_Delta) aDelta;
 477   aDelta = theDoc->GetUndos().Last();
 478   TDF_LabelList aDeltaList;
 479   aDelta->Labels(aDeltaList); // it clears list, so, use new one and then append to the result
 480   for(TDF_ListIteratorOfLabelList aListIter(aDeltaList); aListIter.More(); aListIter.Next()) {
 481     return false;
 482   }
 483   // add also label of the modified attributes
 484   const TDF_AttributeDeltaList& anAttrs = aDelta->AttributeDeltas();
 485   for (TDF_ListIteratorOfAttributeDeltaList anAttr(anAttrs); anAttr.More(); anAttr.Next()) {
 486     Handle(TDF_AttributeDelta)& anADelta = anAttr.Value();
 487     Handle(TDF_DeltaOnAddition) anAddition = Handle(TDF_DeltaOnAddition)::DownCast(anADelta);
 488     if (anAddition.IsNull()) { // if the attribute was added, transaction is not empty
 489       if (!anADelta->Label().IsNull() && !anADelta->Attribute().IsNull()) {
 490         Handle(TDF_Attribute) aCurrentAttr;
 491         if (anADelta->Label().FindAttribute(anADelta->Attribute()->ID(), aCurrentAttr)) {
 492           if (isEqualContent(anADelta->Attribute(), aCurrentAttr)) {
 493             continue; // attribute is not changed actually
 494           }
 495         } else
 496           if (Standard_GUID::IsEqual(anADelta->Attribute()->ID(), TDataStd_AsciiString::GetID())) {
 497             continue; // error message is disappeared
 498         }
 499       }
 500     }
 501     return false;
 502   }
 503   return true;
 504 }
 505
 506 bool Model_Document::finishOperation()
 507 {
 508   bool isNestedClosed = !myDoc->HasOpenCommand() && !myNestedNum.empty();
 509   static std::shared_ptr<Model_Session> aSession =
 510     std::static_pointer_cast<Model_Session>(Model_Session::get());
 511
 512   // open transaction if nested is closed to fit inside
 513   // all synchronizeBackRefs and flushed consequences
 514   if (isNestedClosed) {
 515     myDoc->OpenCommand();
 516   }
 517   // do it before flashes to enable and recompute nesting features correctly
 518   if (myNestedNum.empty() || (isNestedClosed && myNestedNum.size() == 1)) {
 519     // if all nested operations are closed, make current the higher level objects (to perform
 520     // it in the python scripts correctly): sketch become current after creation ofsub-elements
 521     FeaturePtr aCurrent = currentFeature(false);
 522     CompositeFeaturePtr aMain, aNext = ModelAPI_Tools::compositeOwner(aCurrent);
 523     while(aNext.get()) {
 524       aMain = aNext;
 525       aNext = ModelAPI_Tools::compositeOwner(aMain);
 526     }
 527     if (aMain.get() && aMain != aCurrent)
 528       setCurrentFeature(aMain, false);
 529   }
 530   myObjs->synchronizeBackRefs();
 531   Events_Loop* aLoop = Events_Loop::loop();
 532   aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_CREATED));
 533   aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_UPDATED));
 534   aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_TO_REDISPLAY));
 535   aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_DELETED));
 536
 537   if (isNestedClosed) {
 538     if (myDoc->CommitCommand())
 539       myTransactions.rbegin()->myOCAFNum++;
 540   }
 541
 542   // this must be here just after everything is finished but before real transaction stop
 543   // to avoid messages about modifications outside of the transaction
 544   // and to rebuild everything after all updates and creates
 545   if (isRoot()) { // once for root document
 546     Events_Loop::loop()->autoFlush(Events_Loop::eventByName(EVENT_OBJECT_UPDATED));
 547     static std::shared_ptr<Events_Message> aFinishMsg
 548       (new Events_Message(Events_Loop::eventByName("FinishOperation")));
 549     Events_Loop::loop()->send(aFinishMsg);
 550     Events_Loop::loop()->autoFlush(Events_Loop::eventByName(EVENT_OBJECT_UPDATED), false);
 551   }
 552   // to avoid "updated" message appearance by updater
 553   //aLoop->clear(Events_Loop::eventByName(EVENT_OBJECT_UPDATED));
 554
 555   // finish for all subs first: to avoid nested finishing and "isOperation" calls problems inside
 556   bool aResult = false;
 557   const std::set<int> aSubs = subDocuments();
 558   std::set<int>::iterator aSubIter = aSubs.begin();
 559   for (; aSubIter != aSubs.end(); aSubIter++)
 560     if (subDoc(*aSubIter)->finishOperation())
 561       aResult = true;
 562
 563   // transaction may be empty if this document was created during this transaction (create part)
 564   if (!myTransactions.empty() && myDoc->CommitCommand()) {
 565     // if commit is successfull, just increment counters
 566     if (isEmptyTransaction(myDoc)) { // erase this transaction
 567       myDoc->Undo();
 568       myDoc->ClearRedos();
 569     } else {
 570       myTransactions.rbegin()->myOCAFNum++;
 571       aResult = true;
 572     }
 573   }
 574
 575   if (isNestedClosed) {
 576     compactNested();
 577   }
 578   if (!aResult && !myTransactions.empty() /* it can be for just created part document */)
 579     aResult = myTransactions.rbegin()->myOCAFNum != 0;
 580
 581   if (!aResult && isRoot()) {
 582     // nothing inside in all documents, so remove this transaction from the transactions list
 583     undoInternal(true, false);
 584   }
 585   // on finish clear redos in any case (issue 446) and for all subs (issue 408)
 586   myDoc->ClearRedos();
 587   myRedos.clear();
 588   for (aSubIter = aSubs.begin(); aSubIter != aSubs.end(); aSubIter++) {
 589     subDoc(*aSubIter)->myDoc->ClearRedos();
 590     subDoc(*aSubIter)->myRedos.clear();
 591   }
 592
 593   return aResult;
 594 }
 595
 596 /// Returns in theDelta labels that has been modified in the latest transaction of theDoc
 597 static void modifiedLabels(const Handle(TDocStd_Document)& theDoc, TDF_LabelList& theDelta,
 598   const bool isRedo = false) {
 599   Handle(TDF_Delta) aDelta;
 600   if (isRedo)
 601     aDelta = theDoc->GetRedos().First();
 602   else
 603     aDelta = theDoc->GetUndos().Last();
 604   TDF_LabelList aDeltaList;
 605   aDelta->Labels(aDeltaList); // it clears list, so, use new one and then append to the result
 606   for(TDF_ListIteratorOfLabelList aListIter(aDeltaList); aListIter.More(); aListIter.Next()) {
 607     theDelta.Append(aListIter.Value());
 608   }
 609   // add also label of the modified attributes
 610   const TDF_AttributeDeltaList& anAttrs = aDelta->AttributeDeltas();
 611   /// named shape evolution also modifies integer on this label: exclude it
 612   TDF_LabelMap anExcludedInt;
 613   for (TDF_ListIteratorOfAttributeDeltaList anAttr(anAttrs); anAttr.More(); anAttr.Next()) {
 614     if (anAttr.Value()->Attribute()->ID() == TDataStd_BooleanArray::GetID()) {
 615       // Boolean array is used for feature auxiliary attributes only, feature args are not modified
 616       continue;
 617     }
 618     if (anAttr.Value()->Attribute()->ID() == TNaming_NamedShape::GetID()) {
 619       anExcludedInt.Add(anAttr.Value()->Label());
 620       // named shape evolution is changed in history update => skip them,
 621       // they are not the features arguents
 622       continue;
 623     }
 624     if (anAttr.Value()->Attribute()->ID() == TDataStd_Integer::GetID()) {
 625       if (anExcludedInt.Contains(anAttr.Value()->Label()))
 626         continue;
 627     }
 628       theDelta.Append(anAttr.Value()->Label());
 629   }
 630   TDF_ListIteratorOfLabelList aDeltaIter(theDelta);
 631   for(; aDeltaIter.More(); aDeltaIter.Next()) {
 632     if (anExcludedInt.Contains(aDeltaIter.Value())) {
 633       theDelta.Remove(aDeltaIter);
 634       if (!aDeltaIter.More())
 635         break;
 636     }
 637   }
 638 }
 639
 640 void Model_Document::abortOperation()
 641 {
 642   TDF_LabelList aDeltaLabels; // labels that are updated during "abort"
 643   if (!myNestedNum.empty() && !myDoc->HasOpenCommand()) {  // abort all what was done in nested
 644     compactNested();
 645     // store undo-delta here as undo actually does in the method later
 646     int a, aNumTransactions = myTransactions.rbegin()->myOCAFNum;
 647     for(a = 0; a < aNumTransactions; a++) {
 648       modifiedLabels(myDoc, aDeltaLabels);
 649       myDoc->Undo();
 650     }
 651     for(a = 0; a < aNumTransactions; a++) {
 652       myDoc->Redo();
 653     }
 654
 655     undoInternal(false, false);
 656     myDoc->ClearRedos();
 657     myRedos.clear();
 658   } else { // abort the current
 659     int aNumTransactions = myTransactions.rbegin()->myOCAFNum;
 660     myTransactions.pop_back();
 661     if (!myNestedNum.empty())
 662       (*myNestedNum.rbegin())--;
 663     // roll back the needed number of transactions
 664     //myDoc->AbortCommand();
 665     // instead of abort, do commit and undo: to get the delta of modifications
 666     if (myDoc->CommitCommand())  {
 667       modifiedLabels(myDoc, aDeltaLabels);
 668       myDoc->Undo();
 669     }
 670     for(int a = 0; a < aNumTransactions; a++) {
 671       modifiedLabels(myDoc, aDeltaLabels);
 672       myDoc->Undo();
 673     }
 674     myDoc->ClearRedos();
 675   }
 676   // abort for all subs, flushes will be later, in the end of root abort
 677   const std::set<int> aSubs = subDocuments();
 678   std::set<int>::iterator aSubIter = aSubs.begin();
 679   for (; aSubIter != aSubs.end(); aSubIter++)
 680     subDoc(*aSubIter)->abortOperation();
 681   // references may be changed because they are set in attributes on the fly
 682   myObjs->synchronizeFeatures(aDeltaLabels, true, false, isRoot());
 683 }
 684
 685 bool Model_Document::isOperation() const
 686 {
 687   // operation is opened for all documents: no need to check subs
 688   return myDoc->HasOpenCommand() == Standard_True ;
 689 }
 690
 691 bool Model_Document::isModified()
 692 {
 693   // is modified if at least one operation was commited and not undoed
 694   return myTransactions.size() != myTransactionSave || isOperation();
 695 }
 696
 697 bool Model_Document::canUndo()
 698 {
 699   // issue 406 : if transaction is opened, but nothing to undo behind, can not undo
 700   int aCurrentNum = isOperation() ? 1 : 0;
 701   if (myDoc->GetAvailableUndos() > 0 &&
 702       // there is something to undo in nested
 703       (myNestedNum.empty() || *myNestedNum.rbegin() - aCurrentNum > 0) &&
 704       myTransactions.size() - aCurrentNum > 0 /* for omitting the first useless transaction */)
 705     return true;
 706   // check other subs contains operation that can be undoed
 707   const std::set<int> aSubs = subDocuments();
 708   std::set<int>::iterator aSubIter = aSubs.begin();
 709   for (; aSubIter != aSubs.end(); aSubIter++) {
 710     std::shared_ptr<Model_Document> aSub = subDoc(*aSubIter);
 711     if (aSub->myObjs) {// if it was not closed before
 712       if (aSub->canUndo())
 713         return true;
 714     }
 715   }
 716
 717   return false;
 718 }
 719
 720 void Model_Document::undoInternal(const bool theWithSubs, const bool theSynchronize)
 721 {
 722   if (myTransactions.empty())
 723     return;
 724   int aNumTransactions = myTransactions.rbegin()->myOCAFNum;
 725   myRedos.push_back(*myTransactions.rbegin());
 726   myTransactions.pop_back();
 727   if (!myNestedNum.empty())
 728     (*myNestedNum.rbegin())--;
 729   // roll back the needed number of transactions
 730   TDF_LabelList aDeltaLabels;
 731   for(int a = 0; a < aNumTransactions; a++) {
 732     if (theSynchronize)
 733       modifiedLabels(myDoc, aDeltaLabels);
 734     myDoc->Undo();
 735   }
 736
 737   if (theWithSubs) {
 738     // undo for all subs
 739     const std::set<int> aSubs = subDocuments();
 740     std::set<int>::iterator aSubIter = aSubs.begin();
 741     for (; aSubIter != aSubs.end(); aSubIter++) {
 742       if (!subDoc(*aSubIter)->myObjs)
 743         continue;
 744       subDoc(*aSubIter)->undoInternal(theWithSubs, theSynchronize);
 745     }
 746   }
 747   // after undo of all sub-documents to avoid updates on not-modified data (issue 370)
 748   if (theSynchronize) {
 749     myObjs->synchronizeFeatures(aDeltaLabels, true, false, isRoot());
 750     // update the current features status
 751     setCurrentFeature(currentFeature(false), false);
 752   }
 753 }
 754
 755 void Model_Document::undo()
 756 {
 757   undoInternal(true, true);
 758 }
 759
 760 bool Model_Document::canRedo()
 761 {
 762   if (!myRedos.empty())
 763     return true;
 764   // check other subs contains operation that can be redoed
 765   const std::set<int> aSubs = subDocuments();
 766   std::set<int>::iterator aSubIter = aSubs.begin();
 767   for (; aSubIter != aSubs.end(); aSubIter++) {
 768     if (!subDoc(*aSubIter)->myObjs)
 769       continue;
 770     if (subDoc(*aSubIter)->canRedo())
 771       return true;
 772   }
 773   return false;
 774 }
 775
 776 void Model_Document::redo()
 777 {
 778   if (!myNestedNum.empty())
 779     (*myNestedNum.rbegin())++;
 780   int aNumRedos = myRedos.rbegin()->myOCAFNum;
 781   myTransactions.push_back(*myRedos.rbegin());
 782   myRedos.pop_back();
 783   TDF_LabelList aDeltaLabels;
 784   for(int a = 0; a < aNumRedos; a++) {
 785     modifiedLabels(myDoc, aDeltaLabels, true);
 786     myDoc->Redo();
 787   }
 788
 789   // redo for all subs
 790   const std::set<int> aSubs = subDocuments();
 791   std::set<int>::iterator aSubIter = aSubs.begin();
 792   for (; aSubIter != aSubs.end(); aSubIter++)
 793     subDoc(*aSubIter)->redo();
 794
 795   // after redo of all sub-documents to avoid updates on not-modified data (issue 370)
 796   myObjs->synchronizeFeatures(aDeltaLabels, true, false, isRoot());
 797   // update the current features status
 798   setCurrentFeature(currentFeature(false), false);
 799 }
 800
 801 std::list<std::string> Model_Document::undoList() const
 802 {
 803   std::list<std::string> aResult;
 804   // the number of skipped current operations (on undo they will be aborted)
 805   int aSkipCurrent = isOperation() ? 1 : 0;
 806   std::list<Transaction>::const_reverse_iterator aTrIter = myTransactions.crbegin();
 807   int aNumUndo = int(myTransactions.size());
 808   if (!myNestedNum.empty())
 809     aNumUndo = *myNestedNum.rbegin();
 810   for( ; aNumUndo > 0; aTrIter++, aNumUndo--) {
 811     if (aSkipCurrent == 0) aResult.push_back(aTrIter->myId);
 812     else aSkipCurrent--;
 813   }
 814   return aResult;
 815 }
 816
 817 std::list<std::string> Model_Document::redoList() const
 818 {
 819   std::list<std::string> aResult;
 820   std::list<Transaction>::const_reverse_iterator aTrIter = myRedos.crbegin();
 821   for( ; aTrIter != myRedos.crend(); aTrIter++) {
 822     aResult.push_back(aTrIter->myId);
 823   }
 824   return aResult;
 825 }
 826
 827 void Model_Document::operationId(const std::string& theId)
 828 {
 829   myTransactions.rbegin()->myId = theId;
 830 }
 831
 832 FeaturePtr Model_Document::addFeature(std::string theID, const bool theMakeCurrent)
 833 {
 834   std::shared_ptr<Model_Session> aSession =
 835     std::dynamic_pointer_cast<Model_Session>(ModelAPI_Session::get());
 836   FeaturePtr aFeature = aSession->createFeature(theID, this);
 837   if (!aFeature)
 838     return aFeature;
 839   aFeature->init();
 840   Model_Document* aDocToAdd;
 841   if (!aFeature->documentToAdd().empty()) { // use the customized document to add
 842     if (aFeature->documentToAdd() != kind()) { // the root document by default
 843       aDocToAdd = std::dynamic_pointer_cast<Model_Document>(aSession->moduleDocument()).get();
 844     } else {
 845       aDocToAdd = this;
 846     }
 847   } else { // if customized is not presented, add to "this" document
 848     aDocToAdd = this;
 849   }
 850   if (aFeature) {
 851     // searching for feature after which must be added the next feature: this is the current feature
 852     // but also all sub-features of this feature
 853     FeaturePtr aCurrent = aDocToAdd->currentFeature(false);
 854     bool isModified = true;
 855     for(CompositeFeaturePtr aComp = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aCurrent);
 856         aComp.get() && isModified;
 857         aComp = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aCurrent)) {
 858       isModified =  false;
 859       int aSubs = aComp->numberOfSubs(false);
 860       for(int a = 0; a < aSubs; a++) {
 861         FeaturePtr aSub = aComp->subFeature(a, false);
 862         if (myObjs->isLater(aSub, aCurrent)) {
 863           isModified =  true;
 864           aCurrent = aSub;
 865         }
 866       }
 867     }
 868     aDocToAdd->myObjs->addFeature(aFeature, aCurrent);
 869     if (!aFeature->isAction()) {  // do not add action to the data model
 870       if (theMakeCurrent)  // after all this feature stays in the document, so make it current
 871         aDocToAdd->setCurrentFeature(aFeature, false);
 872     } else { // feature must be executed
 873        // no creation event => updater not working, problem with remove part
 874       aFeature->execute();
 875     }
 876   }
 877   return aFeature;
 878 }
 879
 880
 881 void Model_Document::refsToFeature(FeaturePtr theFeature,
 882   std::set<std::shared_ptr<ModelAPI_Feature> >& theRefs, const bool isSendError)
 883 {
 884   myObjs->refsToFeature(theFeature, theRefs, isSendError);
 885 }
 886
 887 void Model_Document::removeFeature(FeaturePtr theFeature)
 888 {
 889   myObjs->removeFeature(theFeature);
 890 }
 891
 892 // recursive function to check if theSub is a child of theMain composite feature
 893 // through all the hierarchy of parents
 894 static bool isSub(const CompositeFeaturePtr theMain, const FeaturePtr theSub) {
 895   CompositeFeaturePtr aParent = ModelAPI_Tools::compositeOwner(theSub);
 896   if (!aParent.get())
 897     return false;
 898   if (aParent == theMain)
 899     return true;
 900   return isSub(theMain, aParent);
 901 }
 902
 903
 904 void Model_Document::moveFeature(FeaturePtr theMoved, FeaturePtr theAfterThis)
 905 {
 906   bool aCurrentUp = theMoved == currentFeature(false);
 907   if (aCurrentUp) {
 908     setCurrentFeatureUp();
 909   }
 910   // if user adds after high-level feature with nested,
 911   // add it after all nested (otherwise the nested will be disabled)
 912   CompositeFeaturePtr aCompositeAfter =
 913     std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(theAfterThis);
 914   if (aCompositeAfter.get()) {
 915     FeaturePtr aSub = aCompositeAfter;
 916     do {
 917       FeaturePtr aNext = myObjs->nextFeature(aSub);
 918       if (!isSub(aCompositeAfter, aNext)) {
 919         theAfterThis = aSub;
 920         break;
 921       }
 922       aSub = aNext;
 923     } while (aSub.get());
 924   }
 925
 926   myObjs->moveFeature(theMoved, theAfterThis);
 927   if (aCurrentUp) { // make the moved feature enabled or disabled due to the real status
 928     setCurrentFeature(currentFeature(false), false);
 929   } else if (theAfterThis == currentFeature(false)) {
 930     // must be after move to make enabled all features which are before theMoved
 931     setCurrentFeature(theMoved, true);
 932   }
 933 }
 934
 935 void Model_Document::updateHistory(const std::shared_ptr<ModelAPI_Object> theObject)
 936 {
 937   myObjs->updateHistory(theObject);
 938 }
 939
 940 void Model_Document::updateHistory(const std::string theGroup)
 941 {
 942   myObjs->updateHistory(theGroup);
 943 }
 944
 945 const std::set<int> Model_Document::subDocuments() const
 946 {
 947   std::set<int> aResult;
 948   std::list<ResultPtr> aPartResults;
 949   myObjs->allResults(ModelAPI_ResultPart::group(), aPartResults);
 950   std::list<ResultPtr>::iterator aPartRes = aPartResults.begin();
 951   for(; aPartRes != aPartResults.end(); aPartRes++) {
 952     ResultPartPtr aPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(*aPartRes);
 953     if (aPart && aPart->isActivated()) {
 954       aResult.insert(aPart->original()->partDoc()->id());
 955     }
 956   }
 957   return aResult;
 958 }
 959
 960 std::shared_ptr<Model_Document> Model_Document::subDoc(int theDocID)
 961 {
 962   // just store sub-document identifier here to manage it later
 963   return std::dynamic_pointer_cast<Model_Document>(
 964     Model_Application::getApplication()->document(theDocID));
 965 }
 966
 967 ObjectPtr Model_Document::object(const std::string& theGroupID, const int theIndex)
 968 {
 969   return myObjs->object(theGroupID, theIndex);
 970 }
 971
 972 std::shared_ptr<ModelAPI_Object> Model_Document::objectByName(
 973     const std::string& theGroupID, const std::string& theName)
 974 {
 975   return myObjs->objectByName(theGroupID, theName);
 976 }
 977
 978 const int Model_Document::index(std::shared_ptr<ModelAPI_Object> theObject)
 979 {
 980   return myObjs->index(theObject);
 981 }
 982
 983 int Model_Document::size(const std::string& theGroupID)
 984 {
 985   if (myObjs == 0) // may be on close
 986     return 0;
 987   return myObjs->size(theGroupID);
 988 }
 989
 990 std::shared_ptr<ModelAPI_Feature> Model_Document::currentFeature(const bool theVisible)
 991 {
 992   if (!myObjs) // on close document feature destruction it may call this method
 993     return std::shared_ptr<ModelAPI_Feature>();
 994   TDF_Label aRefLab = generalLabel().FindChild(TAG_CURRENT_FEATURE);
 995   Handle(TDF_Reference) aRef;
 996   if (aRefLab.FindAttribute(TDF_Reference::GetID(), aRef)) {
 997     TDF_Label aLab = aRef->Get();
 998     FeaturePtr aResult = myObjs->feature(aLab);
 999     if (theVisible) { // get nearest visible (in history) going up
1000       while(aResult.get() &&  !aResult->isInHistory()) {
1001         aResult = myObjs->nextFeature(aResult, true);
1002       }
1003     }
1004     return aResult;
1005   }
1006   return std::shared_ptr<ModelAPI_Feature>(); // null feature means the higher than first
1007 }
1008
1009 void Model_Document::setCurrentFeature(
1010   std::shared_ptr<ModelAPI_Feature> theCurrent, const bool theVisible)
1011 {
1012   // blocks the flush signals to avoid each objects visualization in the viewer
1013   // they should not be shown once after all modifications are performed
1014   Events_Loop* aLoop = Events_Loop::loop();
1015   bool isActive = aLoop->activateFlushes(false);
1016
1017   TDF_Label aRefLab = generalLabel().FindChild(TAG_CURRENT_FEATURE);
1018   CompositeFeaturePtr aMain; // main feature that may nest the new current
1019   std::set<FeaturePtr> anOwners; // composites that contain theCurrent (with any level of nesting)
1020   if (theCurrent.get()) {
1021     aMain = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(theCurrent);
1022     CompositeFeaturePtr anOwner = ModelAPI_Tools::compositeOwner(theCurrent);
1023     while(anOwner.get()) {
1024       if (!aMain.get()) {
1025         aMain = anOwner;
1026       }
1027       anOwners.insert(anOwner);
1028       anOwner = ModelAPI_Tools::compositeOwner(anOwner);
1029     }
1030   }
1031
1032   if (theVisible && !theCurrent.get()) {
1033     // needed to avoid disabling of PartSet initial constructions
1034     FeaturePtr aNext =
1035       theCurrent.get() ? myObjs->nextFeature(theCurrent) : myObjs->firstFeature();
1036     for (; aNext.get(); aNext = myObjs->nextFeature(theCurrent)) {
1037       if (aNext->isInHistory()) {
1038         break; // next in history is not needed
1039       } else { // next not in history is good for making current
1040         theCurrent = aNext;
1041       }
1042     }
1043   }
1044   if (theCurrent.get()) {
1045     std::shared_ptr<Model_Data> aData = std::static_pointer_cast<Model_Data>(theCurrent->data());
1046     if (!aData.get() || !aData->isValid()) {
1047       aLoop->activateFlushes(isActive);
1048       return;
1049     }
1050     TDF_Label aFeatureLabel = aData->label().Father();
1051
1052     Handle(TDF_Reference) aRef;
1053     if (aRefLab.FindAttribute(TDF_Reference::GetID(), aRef)) {
1054       aRef->Set(aFeatureLabel);
1055     } else {
1056       aRef = TDF_Reference::Set(aRefLab, aFeatureLabel);
1057     }
1058   } else { // remove reference for the null feature
1059     aRefLab.ForgetAttribute(TDF_Reference::GetID());
1060   }
1061   // make all features after this feature disabled in reversed order
1062   // (to remove results without deps)
1063   static Events_ID aRedispEvent = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
1064
1065   bool aPassed = false; // flag that the current object is already passed in cycle
1066   FeaturePtr anIter = myObjs->lastFeature();
1067   bool aWasChanged = false;
1068   bool isCurrentParameter = theCurrent.get() && theCurrent->getKind() == "Parameter";
1069   for(; anIter.get(); anIter = myObjs->nextFeature(anIter, true)) {
1070     // check this before passed become enabled: the current feature is enabled!
1071     if (anIter == theCurrent) aPassed = true;
1072
1073     bool aDisabledFlag = !aPassed;
1074     if (aMain.get()) {
1075       if (isSub(aMain, anIter)) // sub-elements of not-disabled feature are not disabled
1076         aDisabledFlag = false;
1077       else if (anOwners.find(anIter) != anOwners.end())
1078         // disable the higher-level feature is the nested is the current
1079         aDisabledFlag = true;
1080     }
1081
1082     if (anIter->getKind() == "Parameter") {
1083       // parameters are always out of the history of features, but not parameters
1084       // due to the issue 1491 all parameters are kept enabled any time
1085       //if (!isCurrentParameter)
1086         aDisabledFlag = false;
1087     } else if (isCurrentParameter) {
1088       // if paramater is active, all other features become enabled (issue 1307)
1089       aDisabledFlag = false;
1090     }
1091
1092     if (anIter->setDisabled(aDisabledFlag)) {
1093       static Events_ID anUpdateEvent = aLoop->eventByName(EVENT_OBJECT_UPDATED);
1094       // state of feature is changed => so inform that it must be updated if it has such state
1095       if (!aDisabledFlag &&
1096           (anIter->data()->execState() == ModelAPI_StateMustBeUpdated ||
1097            anIter->data()->execState() == ModelAPI_StateInvalidArgument))
1098         ModelAPI_EventCreator::get()->sendUpdated(anIter, anUpdateEvent);
1099       // flush is in the end of this method
1100       ModelAPI_EventCreator::get()->sendUpdated(anIter, aRedispEvent /*, false*/);
1101       aWasChanged = true;
1102     }
1103     // update for everyone the concealment flag immideately: on edit feature in the midle of history
1104     if (aWasChanged) {
1105       std::list<ResultPtr> aResults;
1106       ModelAPI_Tools::allResults(anIter, aResults);
1107       std::list<ResultPtr>::const_iterator aRes = aResults.begin();
1108       for(; aRes != aResults.end(); aRes++) {
1109         if ((*aRes).get() && (*aRes)->data()->isValid() && !(*aRes)->isDisabled())
1110           std::dynamic_pointer_cast<Model_Data>((*aRes)->data())->updateConcealmentFlag();
1111       }
1112       // update the concealment status for disply in isConcealed of ResultBody
1113       for(aRes = aResults.begin(); aRes != aResults.end(); aRes++) {
1114         if ((*aRes).get() && (*aRes)->data()->isValid() && !(*aRes)->isDisabled())
1115           (*aRes)->isConcealed();
1116       }
1117     }
1118   }
1119   // unblock  the flush signals and up them after this
1120   aLoop->activateFlushes(isActive);
1121 }
1122
1123 void Model_Document::setCurrentFeatureUp()
1124 {
1125   // on remove just go up for minimum step: highlight external objects in sketch causes
1126   // problems if it is true: here and in "setCurrentFeature"
1127   FeaturePtr aCurrent = currentFeature(false);
1128   if (aCurrent.get()) { // if not, do nothing because null is the upper
1129     FeaturePtr aPrev = myObjs->nextFeature(aCurrent, true);
1130     // make the higher level composite as current (sketch becomes disabled if line is enabled)
1131     if (aPrev.get()) {
1132       FeaturePtr aComp = ModelAPI_Tools::compositeOwner(aPrev);
1133       // without cycle (issue 1555): otherwise extrusion fuse
1134       // will be enabled and displayed whaen inside sketch
1135       if (aComp.get())
1136           aPrev = aComp;
1137     }
1138     // do not flush: it is called only on remove, it will be flushed in the end of transaction
1139     setCurrentFeature(aPrev, false);
1140   }
1141 }
1142
1143 TDF_Label Model_Document::generalLabel() const
1144 {
1145   return myDoc->Main().FindChild(TAG_GENERAL);
1146 }
1147
1148 std::shared_ptr<ModelAPI_ResultConstruction> Model_Document::createConstruction(
1149     const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1150 {
1151   return myObjs->createConstruction(theFeatureData, theIndex);
1152 }
1153
1154 std::shared_ptr<ModelAPI_ResultBody> Model_Document::createBody(
1155     const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1156 {
1157   return myObjs->createBody(theFeatureData, theIndex);
1158 }
1159
1160 std::shared_ptr<ModelAPI_ResultPart> Model_Document::createPart(
1161     const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1162 {
1163   return myObjs->createPart(theFeatureData, theIndex);
1164 }
1165
1166 std::shared_ptr<ModelAPI_ResultPart> Model_Document::copyPart(
1167       const std::shared_ptr<ModelAPI_ResultPart>& theOrigin,
1168       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1169 {
1170   return myObjs->copyPart(theOrigin, theFeatureData, theIndex);
1171 }
1172
1173 std::shared_ptr<ModelAPI_ResultGroup> Model_Document::createGroup(
1174     const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1175 {
1176   return myObjs->createGroup(theFeatureData, theIndex);
1177 }
1178
1179 std::shared_ptr<ModelAPI_ResultField> Model_Document::createField(
1180     const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1181 {
1182   return myObjs->createField(theFeatureData, theIndex);
1183 }
1184
1185 std::shared_ptr<ModelAPI_ResultParameter> Model_Document::createParameter(
1186       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1187 {
1188   return myObjs->createParameter(theFeatureData, theIndex);
1189 }
1190
1191 std::shared_ptr<ModelAPI_Feature> Model_Document::feature(
1192     const std::shared_ptr<ModelAPI_Result>& theResult)
1193 {
1194   return myObjs->feature(theResult);
1195 }
1196
1197 Standard_Integer HashCode(const TDF_Label& theLab, const Standard_Integer theUpper)
1198 {
1199   return TDF_LabelMapHasher::HashCode(theLab, theUpper);
1200
1201 }
1202 Standard_Boolean IsEqual(const TDF_Label& theLab1, const TDF_Label& theLab2)
1203 {
1204   return TDF_LabelMapHasher::IsEqual(theLab1, theLab2);
1205 }
1206
1207 void Model_Document::addNamingName(const TDF_Label theLabel, std::string theName)
1208 {
1209   myNamingNames[theName] = theLabel;
1210 }
1211
1212 void Model_Document::changeNamingName(const std::string theOldName, const std::string theNewName)
1213 {
1214   std::map<std::string, TDF_Label>::iterator aFind = myNamingNames.find(theOldName);
1215   if (aFind != myNamingNames.end()) {
1216     myNamingNames[theNewName] = aFind->second;
1217     myNamingNames.erase(theOldName);
1218   }
1219 }
1220
1221 TDF_Label Model_Document::findNamingName(std::string theName)
1222 {
1223   std::map<std::string, TDF_Label>::iterator aFind = myNamingNames.find(theName);
1224   if (aFind != myNamingNames.end()) {
1225     return aFind->second;
1226   }
1227   // not found exact name, try to find by sub-components
1228   std::string::size_type aSlash = theName.rfind('/');
1229   if (aSlash != std::string::npos) {
1230     std::string anObjName = theName.substr(0, aSlash);
1231     aFind = myNamingNames.find(anObjName);
1232     if (aFind != myNamingNames.end()) {
1233       TCollection_ExtendedString aSubName(theName.substr(aSlash + 1).c_str());
1234       // searching sub-labels with this name
1235       TDF_ChildIDIterator aNamesIter(aFind->second, TDataStd_Name::GetID(), Standard_True);
1236       for(; aNamesIter.More(); aNamesIter.Next()) {
1237         Handle(TDataStd_Name) aName = Handle(TDataStd_Name)::DownCast(aNamesIter.Value());
1238         if (aName->Get() == aSubName)
1239           return aName->Label();
1240       }
1241     }
1242   }
1243   return TDF_Label(); // not found
1244 }
1245
1246 ResultPtr Model_Document::findByName(const std::string theName)
1247 {
1248   return myObjs->findByName(theName);
1249 }
1250
1251 std::list<std::shared_ptr<ModelAPI_Feature> > Model_Document::allFeatures()
1252 {
1253   return myObjs->allFeatures();
1254 }
1255
1256 void Model_Document::setActive(const bool theFlag)
1257 {
1258   if (theFlag != myIsActive) {
1259     myIsActive = theFlag;
1260     // redisplay all the objects of this part
1261     static Events_Loop* aLoop = Events_Loop::loop();
1262     static Events_ID aRedispEvent = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
1263
1264     for(int a = size(ModelAPI_Feature::group()) - 1; a >= 0; a--) {
1265       FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(
1266         object(ModelAPI_Feature::group(), a));
1267       if (aFeature.get() && aFeature->data()->isValid()) {
1268         const std::list<std::shared_ptr<ModelAPI_Result> >& aResList = aFeature->results();
1269         std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRes = aResList.begin();
1270         for(; aRes != aResList.end(); aRes++) {
1271           ModelAPI_EventCreator::get()->sendUpdated(*aRes, aRedispEvent);
1272           // #issue 1048: sub-compsolids also
1273           ResultCompSolidPtr aCompRes = std::dynamic_pointer_cast<ModelAPI_ResultCompSolid>(*aRes);
1274           if (aCompRes.get()) {
1275             int aNumSubs = aCompRes->numberOfSubs();
1276             for(int a = 0; a < aNumSubs; a++) {
1277               ResultPtr aSub = aCompRes->subResult(a);
1278               if (aSub.get()) {
1279                 ModelAPI_EventCreator::get()->sendUpdated(aSub, aRedispEvent);
1280               }
1281             }
1282           }
1283         }
1284       }
1285     }
1286   }
1287 }
1288
1289 bool Model_Document::isActive() const
1290 {
1291   return myIsActive;
1292 }
1293
1294 int Model_Document::transactionID()
1295 {
1296   Handle(TDataStd_Integer) anIndex;
1297   if (!generalLabel().FindChild(TAG_CURRENT_TRANSACTION).
1298       FindAttribute(TDataStd_Integer::GetID(), anIndex)) {
1299     anIndex = TDataStd_Integer::Set(generalLabel().FindChild(TAG_CURRENT_TRANSACTION), 1);
1300   }
1301   return anIndex->Get();
1302 }
1303
1304 void Model_Document::incrementTransactionID()
1305 {
1306   int aNewVal = transactionID() + 1;
1307   TDataStd_Integer::Set(generalLabel().FindChild(TAG_CURRENT_TRANSACTION), aNewVal);
1308 }
1309 void Model_Document::decrementTransactionID()
1310 {
1311   int aNewVal = transactionID() - 1;
1312   TDataStd_Integer::Set(generalLabel().FindChild(TAG_CURRENT_TRANSACTION), aNewVal);
1313 }
1314
1315 bool Model_Document::isOpened()
1316 {
1317   return myObjs && !myDoc.IsNull();
1318 }
1319
1320 int Model_Document::numInternalFeatures()
1321 {
1322   return myObjs->numInternalFeatures();
1323 }
1324
1325 std::shared_ptr<ModelAPI_Feature> Model_Document::internalFeature(const int theIndex)
1326 {
1327   return myObjs->internalFeature(theIndex);
1328 }
1329
1330 std::shared_ptr<ModelAPI_Feature> Model_Document::featureById(const int theId)
1331 {
1332   return myObjs->featureById(theId);
1333 }
1334
1335 void Model_Document::synchronizeTransactions()
1336 {
1337   Model_Document* aRoot =
1338     std::dynamic_pointer_cast<Model_Document>(ModelAPI_Session::get()->moduleDocument()).get();
1339   if (aRoot == this)
1340     return; // don't need to synchronise root with root
1341
1342   std::shared_ptr<Model_Session> aSession =
1343     std::dynamic_pointer_cast<Model_Session>(Model_Session::get());
1344   while(myRedos.size() > aRoot->myRedos.size()) { // remove redos in this
1345     aSession->setCheckTransactions(false);
1346     redo();
1347     aSession->setCheckTransactions(true);
1348   }
1349   /* this case can not be reproduced in any known case for the current moment, so, just comment
1350   while(myRedos.size() < aRoot->myRedos.size()) { // add more redos in this
1351     undoInternal(false, true);
1352   }*/
1353 }
1354
1355 /// Feature that is used for selection in the Part document by the external request
1356 class Model_SelectionInPartFeature : public ModelAPI_Feature {
1357 public:
1358   /// Nothing to do in constructor
1359   Model_SelectionInPartFeature() : ModelAPI_Feature() {}
1360
1361   /// Returns the unique kind of a feature
1362   virtual const std::string& getKind() {
1363     static std::string MY_KIND("InternalSelectionInPartFeature");
1364     return MY_KIND;
1365   }
1366   /// Request for initialization of data model of the object: adding all attributes
1367   virtual void initAttributes() {
1368     data()->addAttribute("selection", ModelAPI_AttributeSelectionList::typeId());
1369   }
1370   /// Nothing to do in the execution function
1371   virtual void execute() {}
1372
1373 };
1374
1375 //! Returns the feature that is used for calculation of selection externally from the document
1376 AttributeSelectionListPtr Model_Document::selectionInPartFeature()
1377 {
1378   // return already created, otherwise create
1379   if (!mySelectionFeature.get() || !mySelectionFeature->data()->isValid()) {
1380     // create a new one
1381     mySelectionFeature = FeaturePtr(new Model_SelectionInPartFeature);
1382
1383     TDF_Label aFeatureLab = generalLabel().FindChild(TAG_SELECTION_FEATURE);
1384     std::shared_ptr<Model_Data> aData(new Model_Data);
1385     aData->setLabel(aFeatureLab.FindChild(1));
1386     aData->setObject(mySelectionFeature);
1387     mySelectionFeature->setDoc(myObjs->owner());
1388     mySelectionFeature->setData(aData);
1389     std::string aName = id() + "_Part";
1390     mySelectionFeature->data()->setName(aName);
1391     mySelectionFeature->setDoc(myObjs->owner());
1392     mySelectionFeature->initAttributes();
1393     mySelectionFeature->init(); // to make it enabled and Update correctly
1394     // this update may cause recomputation of the part after selection on it, that is not needed
1395     mySelectionFeature->data()->blockSendAttributeUpdated(true);
1396   }
1397   return mySelectionFeature->selectionList("selection");
1398 }
1399
1400 FeaturePtr Model_Document::lastFeature()
1401 {
1402   if (myObjs)
1403     return myObjs->lastFeature();
1404   return FeaturePtr();
1405 }
1406
1407 static Handle(TNaming_NamedShape) searchForOriginalShape(TopoDS_Shape theShape, TDF_Label aMain) {
1408   Handle(TNaming_NamedShape) aResult;
1409   while(!theShape.IsNull()) { // searching for the very initial shape that produces this one
1410     TopoDS_Shape aShape = theShape;
1411     theShape.Nullify();
1412     // to avoid crash of TNaming_SameShapeIterator if pure shape does not exists
1413     if (!TNaming_Tool::HasLabel(aMain, aShape))
1414       break;
1415     for(TNaming_SameShapeIterator anIter(aShape, aMain); anIter.More(); anIter.Next()) {
1416       TDF_Label aNSLab = anIter.Label();
1417       Handle(TNaming_NamedShape) aNS;
1418       if (aNSLab.FindAttribute(TNaming_NamedShape::GetID(), aNS)) {
1419         for(TNaming_Iterator aShapesIter(aNS); aShapesIter.More(); aShapesIter.Next()) {
1420           if (aShapesIter.Evolution() == TNaming_SELECTED ||
1421               aShapesIter.Evolution() == TNaming_DELETE)
1422             continue; // don't use the selection evolution
1423           if (aShapesIter.NewShape().IsSame(aShape)) { // found the original shape
1424             aResult = aNS;
1425             if (aResult->Evolution() == TNaming_MODIFY)
1426               theShape = aShapesIter.OldShape();
1427             // otherwise may me searching for another item of this shape with longer history
1428             if (!theShape.IsNull())
1429               break;
1430           }
1431         }
1432       }
1433     }
1434   }
1435   return aResult;
1436 }
1437
1438 std::shared_ptr<ModelAPI_Feature> Model_Document::producedByFeature(
1439     std::shared_ptr<ModelAPI_Result> theResult,
1440     const std::shared_ptr<GeomAPI_Shape>& theShape)
1441 {
1442   ResultBodyPtr aBody = std::dynamic_pointer_cast<ModelAPI_ResultBody>(theResult);
1443   if (!aBody.get()) {
1444     return feature(theResult); // for not-body just returns the feature that produced this result
1445   }
1446   // otherwise get the shape and search the very initial label for it
1447   TopoDS_Shape aShape = theShape->impl<TopoDS_Shape>();
1448   if (aShape.IsNull())
1449     return FeaturePtr();
1450
1451   // for comsolids and compounds all the naming is located in the main object, so, try to use
1452   // it first
1453   ResultCompSolidPtr aMain = ModelAPI_Tools::compSolidOwner(theResult);
1454   if (aMain.get()) {
1455     FeaturePtr aMainRes = producedByFeature(aMain, theShape);
1456     if (aMainRes)
1457       return aMainRes;
1458   }
1459
1460   std::shared_ptr<Model_Data> aBodyData = std::dynamic_pointer_cast<Model_Data>(theResult->data());
1461   if (!aBodyData.get() || !aBodyData->isValid())
1462     return FeaturePtr();
1463
1464   TopoDS_Shape anOldShape; // old shape in the pair oldshape->theShape in the named shape
1465   TopoDS_Shape aShapeContainer; // old shape of the shape that contains aShape as sub-element
1466   Handle(TNaming_NamedShape) aCandidatInThis, aCandidatContainer;
1467   TDF_Label aBodyLab = aBodyData->label();
1468   // use childs and this label (the lowest priority)
1469   TDF_ChildIDIterator aNSIter(aBodyLab, TNaming_NamedShape::GetID(), Standard_True);
1470   bool aUseThis = !aNSIter.More();
1471   while(anOldShape.IsNull() && (aNSIter.More() || aUseThis)) {
1472     Handle(TNaming_NamedShape) aNS;
1473     if (aUseThis) {
1474       if (!aBodyLab.FindAttribute(TNaming_NamedShape::GetID(), aNS))
1475         break;
1476     } else {
1477       aNS = Handle(TNaming_NamedShape)::DownCast(aNSIter.Value());
1478     }
1479     for(TNaming_Iterator aShapesIter(aNS); aShapesIter.More(); aShapesIter.Next()) {
1480       if (aShapesIter.Evolution() == TNaming_SELECTED || aShapesIter.Evolution() == TNaming_DELETE)
1481         continue; // don't use the selection evolution
1482       if (aShapesIter.NewShape().IsSame(aShape)) { // found the original shape
1483         aCandidatInThis = aNS;
1484         if (aCandidatInThis->Evolution() == TNaming_MODIFY)
1485           anOldShape = aShapesIter.OldShape();
1486         // otherwise may me searching for another item of this shape with longer history
1487         if (!anOldShape.IsNull())
1488           break;
1489       }
1490       // check that the shape contains aShape as sub-shape to fill container
1491       if (aShapesIter.NewShape().ShapeType() < aShape.ShapeType() && aCandidatContainer.IsNull()) {
1492         TopExp_Explorer anExp(aShapesIter.NewShape(), aShape.ShapeType());
1493         for(; anExp.More(); anExp.Next()) {
1494           if (aShape.IsSame(anExp.Current())) {
1495             aCandidatContainer = aNS;
1496             aShapeContainer = aShapesIter.NewShape();
1497           }
1498         }
1499       }
1500     }
1501     // iterate to the next label or to the body label in the end
1502     if (!aUseThis)
1503       aNSIter.Next();
1504     if (!aNSIter.More()) {
1505       if (aUseThis)
1506         break;
1507       aUseThis = true;
1508     }
1509   }
1510   if (aCandidatInThis.IsNull()) {
1511     // to fix 1512: searching for original shape of this shape
1512     // if modification of it is not in this result
1513     aCandidatInThis = searchForOriginalShape(aShape, myDoc->Main());
1514     if (aCandidatInThis.IsNull()) {
1515       if (aCandidatContainer.IsNull())
1516         return FeaturePtr();
1517       // with the lower priority use the higher level shape that contains aShape
1518       aCandidatInThis = aCandidatContainer;
1519       anOldShape = aShapeContainer;
1520     } else {
1521       // to stop the searching by the following searchForOriginalShape
1522       anOldShape.Nullify();
1523     }
1524   }
1525
1526   Handle(TNaming_NamedShape) aNS = searchForOriginalShape(anOldShape, myDoc->Main());
1527   if (!aNS.IsNull())
1528     aCandidatInThis = aNS;
1529
1530   FeaturePtr aResult;
1531   TDF_Label aResultLab = aCandidatInThis->Label();
1532   while(aResultLab.Depth() > 3)
1533     aResultLab = aResultLab.Father();
1534   FeaturePtr aFeature = myObjs->feature(aResultLab);
1535   if (aFeature.get()) {
1536     if (!aResult.get() || myObjs->isLater(aResult, aFeature)) {
1537       aResult = aFeature;
1538     }
1539   }
1540   return aResult;
1541 }
1542
1543 bool Model_Document::isLater(FeaturePtr theLater, FeaturePtr theCurrent) const
1544 {
1545   return myObjs->isLater(theLater, theCurrent);
1546 }
1547
1548 void Model_Document::storeNodesState(const std::list<bool>& theStates)
1549 {
1550   TDF_Label aLab = generalLabel().FindChild(TAG_NODES_STATE);
1551   aLab.ForgetAllAttributes();
1552   if (!theStates.empty()) {
1553     Handle(TDataStd_BooleanArray) anArray =
1554       TDataStd_BooleanArray::Set(aLab, 0, int(theStates.size()) - 1);
1555     std::list<bool>::const_iterator aState = theStates.begin();
1556     for(int anIndex = 0; aState != theStates.end(); aState++, anIndex++) {
1557       anArray->SetValue(anIndex, *aState);
1558     }
1559   }
1560 }
1561
1562 void Model_Document::restoreNodesState(std::list<bool>& theStates) const
1563 {
1564   TDF_Label aLab = generalLabel().FindChild(TAG_NODES_STATE);
1565   Handle(TDataStd_BooleanArray) anArray;
1566   if (aLab.FindAttribute(TDataStd_BooleanArray::GetID(), anArray)) {
1567     int anUpper = anArray->Upper();
1568     for(int anIndex = 0; anIndex <= anUpper; anIndex++) {
1569       theStates.push_back(anArray->Value(anIndex) == Standard_True);
1570     }
1571   }
1572 }