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