]> SALOME platform Git repositories - modules/shaper.git/blob - src/Model/Model_Document.cpp
Salome HOME
fe4a17309aa4b432fa244af8b4a55000730981e9
[modules/shaper.git] / 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_Application.h>
10 #include <Model_Session.h>
11 #include <Model_Events.h>
12 #include <Model_ResultPart.h>
13 #include <Model_ResultConstruction.h>
14 #include <Model_ResultBody.h>
15 #include <Model_ResultGroup.h>
16 #include <ModelAPI_Validator.h>
17 #include <ModelAPI_CompositeFeature.h>
18 #include <Events_Loop.h>
19 #include <Events_Error.h>
20
21 #include <TDataStd_Integer.hxx>
22 #include <TDataStd_Comment.hxx>
23 #include <TDF_ChildIDIterator.hxx>
24 #include <TDataStd_ReferenceArray.hxx>
25 #include <TDataStd_HLabelArray1.hxx>
26 #include <TDataStd_Name.hxx>
27 #include <TDF_Reference.hxx>
28 #include <TDF_ChildIDIterator.hxx>
29 #include <TDF_LabelMapHasher.hxx>
30 #include <OSD_File.hxx>
31 #include <OSD_Path.hxx>
32
33 #include <climits>
34 #ifndef WIN32
35 #include <sys/stat.h>
36 #endif
37
38 #ifdef WIN32
39 # define _separator_ '\\'
40 #else
41 # define _separator_ '/'
42 #endif
43
44 static const int UNDO_LIMIT = 1000;  // number of possible undo operations (big for sketcher)
45
46 static const int TAG_GENERAL = 1;  // general properties tag
47 static const int TAG_OBJECTS = 2;  // tag of the objects sub-tree (features, results)
48 static const int TAG_HISTORY = 3;  // tag of the history sub-tree (python dump)
49
50 // feature sub-labels
51 static const int TAG_FEATURE_ARGUMENTS = 1;  ///< where the arguments are located
52 static const int TAG_FEATURE_RESULTS = 2;  ///< where the results are located
53
54 ///
55 /// 0:1:2 - where features are located
56 /// 0:1:2:N:1 - data of the feature N
57 /// 0:1:2:N:2:K:1 - data of the K result of the feature N
58
59 Model_Document::Model_Document(const std::string theID, const std::string theKind)
60     : myID(theID), myKind(theKind),
61       myDoc(new TDocStd_Document("BinOcaf"))  // binary OCAF format
62 {
63   myDoc->SetUndoLimit(UNDO_LIMIT);  
64   myTransactionSave = 0;
65   myExecuteFeatures = true;
66   // to have something in the document and avoid empty doc open/save problem
67   // in transaction for nesting correct working
68   myDoc->NewCommand();
69   TDataStd_Integer::Set(myDoc->Main().Father(), 0);
70   myDoc->CommitCommand();
71 }
72
73 /// Returns the file name of this document by the nameof directory and identifuer of a document
74 static TCollection_ExtendedString DocFileName(const char* theFileName, const std::string& theID)
75 {
76   TCollection_ExtendedString aPath((const Standard_CString) theFileName);
77   // remove end-separators
78   while(aPath.Length() && (aPath.Value(aPath.Length()) == '\\' || aPath.Value(aPath.Length()) == '/'))
79     aPath.Remove(aPath.Length());
80   aPath += _separator_;
81   aPath += theID.c_str();
82   aPath += ".cbf";  // standard binary file extension
83   return aPath;
84 }
85
86 bool Model_Document::load(const char* theFileName)
87 {
88   Handle(Model_Application) anApp = Model_Application::getApplication();
89   if (this == Model_Session::get()->moduleDocument().get()) {
90     anApp->setLoadPath(theFileName);
91   }
92   TCollection_ExtendedString aPath(DocFileName(theFileName, myID));
93   PCDM_ReaderStatus aStatus = (PCDM_ReaderStatus) -1;
94   try {
95     aStatus = anApp->Open(aPath, myDoc);
96   } catch (Standard_Failure) {
97     Handle(Standard_Failure) aFail = Standard_Failure::Caught();
98     Events_Error::send(
99         std::string("Exception in opening of document: ") + aFail->GetMessageString());
100     return false;
101   }
102   bool isError = aStatus != PCDM_RS_OK;
103   if (isError) {
104     switch (aStatus) {
105       case PCDM_RS_UnknownDocument:
106         Events_Error::send(std::string("Can not open document"));
107         break;
108       case PCDM_RS_AlreadyRetrieved:
109         Events_Error::send(std::string("Can not open document: already opened"));
110         break;
111       case PCDM_RS_AlreadyRetrievedAndModified:
112         Events_Error::send(
113             std::string("Can not open document: already opened and modified"));
114         break;
115       case PCDM_RS_NoDriver:
116         Events_Error::send(std::string("Can not open document: driver library is not found"));
117         break;
118       case PCDM_RS_UnknownFileDriver:
119         Events_Error::send(std::string("Can not open document: unknown driver for opening"));
120         break;
121       case PCDM_RS_OpenError:
122         Events_Error::send(std::string("Can not open document: file open error"));
123         break;
124       case PCDM_RS_NoVersion:
125         Events_Error::send(std::string("Can not open document: invalid version"));
126         break;
127       case PCDM_RS_NoModel:
128         Events_Error::send(std::string("Can not open document: no data model"));
129         break;
130       case PCDM_RS_NoDocument:
131         Events_Error::send(std::string("Can not open document: no document inside"));
132         break;
133       case PCDM_RS_FormatFailure:
134         Events_Error::send(std::string("Can not open document: format failure"));
135         break;
136       case PCDM_RS_TypeNotFoundInSchema:
137         Events_Error::send(std::string("Can not open document: invalid object"));
138         break;
139       case PCDM_RS_UnrecognizedFileFormat:
140         Events_Error::send(std::string("Can not open document: unrecognized file format"));
141         break;
142       case PCDM_RS_MakeFailure:
143         Events_Error::send(std::string("Can not open document: make failure"));
144         break;
145       case PCDM_RS_PermissionDenied:
146         Events_Error::send(std::string("Can not open document: permission denied"));
147         break;
148       case PCDM_RS_DriverFailure:
149         Events_Error::send(std::string("Can not open document: driver failure"));
150         break;
151       default:
152         Events_Error::send(std::string("Can not open document: unknown error"));
153         break;
154     }
155   }
156   if (!isError) {
157     myDoc->SetUndoLimit(UNDO_LIMIT);
158     // to avoid the problem that feature is created in the current, not this, document
159     std::shared_ptr<Model_Session> aSession = 
160       std::dynamic_pointer_cast<Model_Session>(Model_Session::get());
161     aSession->setActiveDocument(anApp->getDocument(myID), false);
162     aSession->setCheckTransactions(false);
163     synchronizeFeatures(false, true);
164     aSession->setCheckTransactions(true);
165     aSession->setActiveDocument(Model_Session::get()->moduleDocument(), false);
166     aSession->setActiveDocument(anApp->getDocument(myID), true);
167   }
168   return !isError;
169 }
170
171 bool Model_Document::save(const char* theFileName, std::list<std::string>& theResults)
172 {
173   // create a directory in the root document if it is not yet exist
174   Handle(Model_Application) anApp = Model_Application::getApplication();
175   if (this == Model_Session::get()->moduleDocument().get()) {
176 #ifdef WIN32
177     CreateDirectory(theFileName, NULL);
178 #else
179     mkdir(theFileName, 0x1ff);
180 #endif
181   }
182   // filename in the dir is id of document inside of the given directory
183   TCollection_ExtendedString aPath(DocFileName(theFileName, myID));
184   PCDM_StoreStatus aStatus;
185   try {
186     aStatus = anApp->SaveAs(myDoc, aPath);
187   } catch (Standard_Failure) {
188     Handle(Standard_Failure) aFail = Standard_Failure::Caught();
189     Events_Error::send(
190         std::string("Exception in saving of document: ") + aFail->GetMessageString());
191     return false;
192   }
193   bool isDone = aStatus == PCDM_SS_OK || aStatus == PCDM_SS_No_Obj;
194   if (!isDone) {
195     switch (aStatus) {
196       case PCDM_SS_DriverFailure:
197         Events_Error::send(std::string("Can not save document: save driver-library failure"));
198         break;
199       case PCDM_SS_WriteFailure:
200         Events_Error::send(std::string("Can not save document: file writing failure"));
201         break;
202       case PCDM_SS_Failure:
203       default:
204         Events_Error::send(std::string("Can not save document"));
205         break;
206     }
207   }
208   myTransactionSave = myTransactions.size();
209   if (isDone) {  // save also sub-documents if any
210     theResults.push_back(TCollection_AsciiString(aPath).ToCString());
211     const std::set<std::string> aSubs = subDocuments(false);
212     std::set<std::string>::iterator aSubIter = aSubs.begin();
213     for (; aSubIter != aSubs.end() && isDone; aSubIter++) {
214       if (anApp->isLoadByDemand(*aSubIter)) { 
215         // copy not-activated document that is not in the memory
216         std::string aDocName = *aSubIter;
217         if (!aDocName.empty()) {
218           // just copy file
219           TCollection_AsciiString aSubPath(DocFileName(anApp->loadPath().c_str(), aDocName));
220           OSD_Path aPath(aSubPath);
221           OSD_File aFile(aPath);
222           if (aFile.Exists()) {
223             TCollection_AsciiString aDestinationDir(DocFileName(theFileName, aDocName));
224             OSD_Path aDestination(aDestinationDir);
225             aFile.Copy(aDestination);
226             theResults.push_back(aDestinationDir.ToCString());
227           } else {
228             Events_Error::send(
229               std::string("Can not open file ") + aSubPath.ToCString() + " for saving");
230           }
231         }
232       } else { // simply save opened document
233         isDone = subDoc(*aSubIter)->save(theFileName, theResults);
234       }
235     }
236   }
237   return isDone;
238 }
239
240 void Model_Document::close(const bool theForever)
241 {
242   std::shared_ptr<ModelAPI_Session> aPM = Model_Session::get();
243   if (this != aPM->moduleDocument().get() && this == aPM->activeDocument().get()) {
244     aPM->setActiveDocument(aPM->moduleDocument());
245   } else if (this == aPM->moduleDocument().get()) {
246     // erase the active document if root is closed
247     aPM->setActiveDocument(DocumentPtr());
248   }
249   // close all subs
250   const std::set<std::string> aSubs = subDocuments(true);
251   std::set<std::string>::iterator aSubIter = aSubs.begin();
252   for (; aSubIter != aSubs.end(); aSubIter++)
253     subDoc(*aSubIter)->close(theForever);
254
255   // close for thid document needs no transaction in this document
256   std::static_pointer_cast<Model_Session>(Model_Session::get())->setCheckTransactions(false);
257
258   // delete all features of this document
259   std::shared_ptr<ModelAPI_Document> aThis = 
260     Model_Application::getApplication()->getDocument(myID);
261   Events_Loop* aLoop = Events_Loop::loop();
262   NCollection_DataMap<TDF_Label, FeaturePtr>::Iterator aFeaturesIter(myObjs);
263   for(; aFeaturesIter.More(); aFeaturesIter.Next()) {
264     FeaturePtr aFeature = aFeaturesIter.Value();
265     static Events_ID EVENT_DISP = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
266     ModelAPI_EventCreator::get()->sendDeleted(aThis, ModelAPI_Feature::group());
267     ModelAPI_EventCreator::get()->sendUpdated(aFeature, EVENT_DISP);
268     aFeature->eraseResults();
269     if (theForever) { // issue #294: do not delete content of the document until it can be redone
270       aFeature->erase();
271     } else {
272       aFeature->data()->execState(ModelAPI_StateMustBeUpdated);
273     }
274   }
275   if (theForever) {
276     myObjs.Clear();
277   }
278   aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_DELETED));
279   aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_TO_REDISPLAY));
280
281   // close all only if it is really asked, otherwise it can be undoed/redoed
282   if (theForever) {
283     if (myDoc->CanClose() == CDM_CCS_OK)
284       myDoc->Close();
285   }
286
287   std::static_pointer_cast<Model_Session>(Model_Session::get())->setCheckTransactions(true);
288 }
289
290 void Model_Document::startOperation()
291 {
292   if (myDoc->HasOpenCommand()) {  // start of nested command
293     if (myDoc->CommitCommand()) { // commit the current: it will contain all nested after compactification
294       myTransactions.rbegin()->myOCAFNum++; // if has open command, the list is not empty
295     }
296     myNestedNum.push_back(0); // start of nested operation with zero transactions inside yet
297     myDoc->OpenCommand();
298   } else {  // start the simple command
299     myDoc->NewCommand();
300   }
301   // starts a new operation
302   myTransactions.push_back(Transaction());
303   if (!myNestedNum.empty())
304     (*myNestedNum.rbegin())++;
305   myRedos.clear();
306   // new command for all subs
307   const std::set<std::string> aSubs = subDocuments(true);
308   std::set<std::string>::iterator aSubIter = aSubs.begin();
309   for (; aSubIter != aSubs.end(); aSubIter++)
310     subDoc(*aSubIter)->startOperation();
311 }
312
313 void Model_Document::compactNested()
314 {
315   if (!myNestedNum.empty()) {
316     int aNumToCompact = *(myNestedNum.rbegin());
317     int aSumOfTransaction = 0;
318     for(int a = 0; a < aNumToCompact; a++) {
319       aSumOfTransaction += myTransactions.rbegin()->myOCAFNum;
320       myTransactions.pop_back();
321     }
322     // the latest transaction is the start of lower-level operation which startes the nested
323     myTransactions.rbegin()->myOCAFNum += aSumOfTransaction;
324     myNestedNum.pop_back();
325   }
326 }
327
328 bool Model_Document::finishOperation()
329 {
330   bool isNestedClosed = !myDoc->HasOpenCommand() && !myNestedNum.empty();
331   static std::shared_ptr<Model_Session> aSession = 
332     std::static_pointer_cast<Model_Session>(Model_Session::get());
333   synchronizeBackRefs();
334   Events_Loop* aLoop = Events_Loop::loop();
335   aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_CREATED));
336   aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_UPDATED));
337   aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_TO_REDISPLAY));
338   aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_TOHIDE));
339   aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_DELETED));
340   // this must be here just after everything is finished but before real transaction stop
341   // to avoid messages about modifications outside of the transaction
342   // and to rebuild everything after all updates and creates
343   if (Model_Session::get()->moduleDocument().get() == this) { // once for root document
344     Events_Loop::loop()->autoFlush(Events_Loop::eventByName(EVENT_OBJECT_UPDATED));
345     static std::shared_ptr<Events_Message> aFinishMsg
346       (new Events_Message(Events_Loop::eventByName("FinishOperation")));
347     Events_Loop::loop()->send(aFinishMsg);
348     Events_Loop::loop()->autoFlush(Events_Loop::eventByName(EVENT_OBJECT_UPDATED), false);
349   }
350   // to avoid "updated" message appearance by updater
351   //aLoop->clear(Events_Loop::eventByName(EVENT_OBJECT_UPDATED));
352
353   // finish for all subs first: to avoid nested finishing and "isOperation" calls problems inside
354   bool aResult = false;
355   const std::set<std::string> aSubs = subDocuments(true);
356   std::set<std::string>::iterator aSubIter = aSubs.begin();
357   for (; aSubIter != aSubs.end(); aSubIter++)
358     if (subDoc(*aSubIter)->finishOperation())
359       aResult = true;
360
361   // transaction may be empty if this document was created during this transaction (create part)
362   if (!myTransactions.empty() && myDoc->CommitCommand()) { // if commit is successfull, just increment counters
363     myTransactions.rbegin()->myOCAFNum++;
364     aResult = true;
365   }
366
367   if (isNestedClosed) {
368     compactNested();
369   }
370   if (!aResult && !myTransactions.empty() /* it can be for just created part document */)
371     aResult = myTransactions.rbegin()->myOCAFNum != 0;
372
373   if (!aResult && Model_Session::get()->moduleDocument().get() == this) {
374     // nothing inside in all documents, so remove this transaction from the transactions list
375     undoInternal(true, false);
376     myDoc->ClearRedos();
377     myRedos.clear();
378   }
379   return aResult;
380 }
381
382 void Model_Document::abortOperation()
383 {
384   if (!myNestedNum.empty() && !myDoc->HasOpenCommand()) {  // abort all what was done in nested
385     compactNested();
386     undoInternal(false, false);
387     myDoc->ClearRedos();
388     myRedos.clear();
389   } else { // abort the current
390     int aNumTransactions = myTransactions.rbegin()->myOCAFNum;
391     myTransactions.pop_back();
392     if (!myNestedNum.empty())
393       (*myNestedNum.rbegin())--;
394     // roll back the needed number of transactions
395     myDoc->AbortCommand();
396     for(int a = 0; a < aNumTransactions; a++)
397       myDoc->Undo();
398     myDoc->ClearRedos();
399   }
400   synchronizeFeatures(true, false); // references were not changed since transaction start
401   // abort for all subs
402   const std::set<std::string> aSubs = subDocuments(true);
403   std::set<std::string>::iterator aSubIter = aSubs.begin();
404   for (; aSubIter != aSubs.end(); aSubIter++)
405     subDoc(*aSubIter)->abortOperation();
406 }
407
408 bool Model_Document::isOperation()
409 {
410   // operation is opened for all documents: no need to check subs
411   return myDoc->HasOpenCommand() == Standard_True ;
412 }
413
414 bool Model_Document::isModified()
415 {
416   // is modified if at least one operation was commited and not undoed
417   return myTransactions.size() != myTransactionSave || isOperation();
418 }
419
420 bool Model_Document::canUndo()
421 {
422   if (myDoc->GetAvailableUndos() > 0 && (myNestedNum.empty() || *myNestedNum.rbegin() != 0) &&
423       !myTransactions.empty() /* for omitting the first useless transaction */)
424     return true;
425   // check other subs contains operation that can be undoed
426   const std::set<std::string> aSubs = subDocuments(true);
427   std::set<std::string>::iterator aSubIter = aSubs.begin();
428   for (; aSubIter != aSubs.end(); aSubIter++)
429     if (subDoc(*aSubIter)->canUndo())
430       return true;
431   return false;
432 }
433
434 void Model_Document::undoInternal(const bool theWithSubs, const bool theSynchronize)
435 {
436   int aNumTransactions = myTransactions.rbegin()->myOCAFNum;
437   myRedos.push_back(*myTransactions.rbegin());
438   myTransactions.pop_back();
439   if (!myNestedNum.empty())
440     (*myNestedNum.rbegin())--;
441   // roll back the needed number of transactions
442   for(int a = 0; a < aNumTransactions; a++)
443     myDoc->Undo();
444
445   if (theSynchronize)
446     synchronizeFeatures(true, true);
447   if (theWithSubs) {
448     // undo for all subs
449     const std::set<std::string> aSubs = subDocuments(true);
450     std::set<std::string>::iterator aSubIter = aSubs.begin();
451     for (; aSubIter != aSubs.end(); aSubIter++)
452       subDoc(*aSubIter)->undoInternal(theWithSubs, theSynchronize);
453   }
454 }
455
456 void Model_Document::undo()
457 {
458   undoInternal(true, true);
459 }
460
461 bool Model_Document::canRedo()
462 {
463   if (myDoc->GetAvailableRedos() > 0)
464     return true;
465   // check other subs contains operation that can be redoed
466   const std::set<std::string> aSubs = subDocuments(true);
467   std::set<std::string>::iterator aSubIter = aSubs.begin();
468   for (; aSubIter != aSubs.end(); aSubIter++)
469     if (subDoc(*aSubIter)->canRedo())
470       return true;
471   return false;
472 }
473
474 void Model_Document::redo()
475 {
476   if (!myNestedNum.empty())
477     (*myNestedNum.rbegin())++;
478   int aNumRedos = myRedos.rbegin()->myOCAFNum;
479   myTransactions.push_back(*myRedos.rbegin());
480   myRedos.pop_back();
481   for(int a = 0; a < aNumRedos; a++)
482     myDoc->Redo();
483
484   synchronizeFeatures(true, true);
485   // redo for all subs
486   const std::set<std::string> aSubs = subDocuments(true);
487   std::set<std::string>::iterator aSubIter = aSubs.begin();
488   for (; aSubIter != aSubs.end(); aSubIter++)
489     subDoc(*aSubIter)->redo();
490 }
491
492 std::list<std::string> Model_Document::undoList() const
493 {
494   std::list<std::string> aResult;
495   std::list<Transaction>::const_reverse_iterator aTrIter = myTransactions.crbegin();
496   int aNumUndo = myTransactions.size();
497   if (!myNestedNum.empty())
498     aNumUndo = *myNestedNum.rbegin();
499   for( ; aNumUndo > 0; aTrIter++, aNumUndo--) {
500     aResult.push_back(aTrIter->myId);
501   }
502   return aResult;
503 }
504
505 std::list<std::string> Model_Document::redoList() const
506 {
507   std::list<std::string> aResult;
508   std::list<Transaction>::const_reverse_iterator aTrIter = myRedos.crbegin();
509   for( ; aTrIter != myRedos.crend(); aTrIter++) {
510     aResult.push_back(aTrIter->myId);
511   }
512   return aResult;
513 }
514
515 void Model_Document::operationId(const std::string& theId)
516 {
517   myTransactions.rbegin()->myId = theId;
518 }
519
520 /// Append to the array of references a new referenced label
521 static void AddToRefArray(TDF_Label& theArrayLab, TDF_Label& theReferenced)
522 {
523   Handle(TDataStd_ReferenceArray) aRefs;
524   if (!theArrayLab.FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs)) {
525     aRefs = TDataStd_ReferenceArray::Set(theArrayLab, 0, 0);
526     aRefs->SetValue(0, theReferenced);
527   } else {  // extend array by one more element
528     Handle(TDataStd_HLabelArray1) aNewArray = new TDataStd_HLabelArray1(aRefs->Lower(),
529                                                                         aRefs->Upper() + 1);
530     for (int a = aRefs->Lower(); a <= aRefs->Upper(); a++) {
531       aNewArray->SetValue(a, aRefs->Value(a));
532     }
533     aNewArray->SetValue(aRefs->Upper() + 1, theReferenced);
534     aRefs->SetInternalArray(aNewArray);
535   }
536 }
537
538 FeaturePtr Model_Document::addFeature(std::string theID)
539 {
540   TDF_Label anEmptyLab;
541   FeaturePtr anEmptyFeature;
542   FeaturePtr aFeature = ModelAPI_Session::get()->createFeature(theID);
543   if (!aFeature)
544     return aFeature;
545   std::shared_ptr<Model_Document> aDocToAdd = std::dynamic_pointer_cast<Model_Document>(
546       aFeature->documentToAdd());
547   if (aFeature) {
548     TDF_Label aFeatureLab;
549     if (!aFeature->isAction()) {  // do not add action to the data model
550       TDF_Label aFeaturesLab = aDocToAdd->featuresLabel();
551       aFeatureLab = aFeaturesLab.NewChild();
552       aDocToAdd->initData(aFeature, aFeatureLab, TAG_FEATURE_ARGUMENTS);
553       // keep the feature ID to restore document later correctly
554       TDataStd_Comment::Set(aFeatureLab, aFeature->getKind().c_str());
555       aDocToAdd->myObjs.Bind(aFeatureLab, aFeature);
556       // store feature in the history of features array
557       if (aFeature->isInHistory()) {
558         AddToRefArray(aFeaturesLab, aFeatureLab);
559       }
560     }
561     if (!aFeature->isAction()) {  // do not add action to the data model
562       // event: feature is added
563       static Events_ID anEvent = Events_Loop::eventByName(EVENT_OBJECT_CREATED);
564       ModelAPI_EventCreator::get()->sendUpdated(aFeature, anEvent);
565     } else { // feature must be executed
566        // no creation event => updater not working, problem with remove part
567       aFeature->execute();
568     }
569   }
570   return aFeature;
571 }
572
573 /// Appenad to the array of references a new referenced label.
574 /// If theIndex is not -1, removes element at thisindex, not theReferenced.
575 /// \returns the index of removed element
576 static int RemoveFromRefArray(TDF_Label theArrayLab, TDF_Label theReferenced, const int theIndex =
577                                   -1)
578 {
579   int aResult = -1;  // no returned
580   Handle(TDataStd_ReferenceArray) aRefs;
581   if (theArrayLab.FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs)) {
582     if (aRefs->Length() == 1) {  // just erase an array
583       if ((theIndex == -1 && aRefs->Value(0) == theReferenced) || theIndex == 0) {
584         theArrayLab.ForgetAttribute(TDataStd_ReferenceArray::GetID());
585       }
586       aResult = 0;
587     } else {  // reduce the array
588       Handle(TDataStd_HLabelArray1) aNewArray = new TDataStd_HLabelArray1(aRefs->Lower(),
589                                                                           aRefs->Upper() - 1);
590       int aCount = aRefs->Lower();
591       for (int a = aCount; a <= aRefs->Upper(); a++, aCount++) {
592         if ((theIndex == -1 && aRefs->Value(a) == theReferenced) || theIndex == a) {
593           aCount--;
594           aResult = a;
595         } else {
596           aNewArray->SetValue(aCount, aRefs->Value(a));
597         }
598       }
599       aRefs->SetInternalArray(aNewArray);
600     }
601   }
602   return aResult;
603 }
604
605 void Model_Document::refsToFeature(FeaturePtr theFeature,
606                                    std::set<std::shared_ptr<ModelAPI_Feature> >& theRefs,
607                                    const bool isSendError)
608 {
609   // check the feature: it must have no depended objects on it
610   // the dependencies can be in the feature results
611   std::list<ResultPtr>::const_iterator aResIter = theFeature->results().cbegin();
612   for(; aResIter != theFeature->results().cend(); aResIter++) {
613     ResultPtr aResult = (*aResIter);
614     std::shared_ptr<Model_Data> aData = 
615       std::dynamic_pointer_cast<Model_Data>(aResult->data());
616     if (aData.get() != NULL) {
617       const std::set<AttributePtr>& aRefs = aData->refsToMe();
618       std::set<AttributePtr>::const_iterator aRefIt = aRefs.begin(), aRefLast = aRefs.end();
619       for(; aRefIt != aRefLast; aRefIt++) {
620         FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>((*aRefIt)->owner());
621         if (aFeature.get() != NULL)
622           theRefs.insert(aFeature);
623       }
624     }
625   }
626   // the dependencies can be in the feature itself
627   std::shared_ptr<Model_Data> aData = 
628       std::dynamic_pointer_cast<Model_Data>(theFeature->data());
629   if (aData && !aData->refsToMe().empty()) {
630     const std::set<AttributePtr>& aRefs = aData->refsToMe();
631     std::set<AttributePtr>::const_iterator aRefIt = aRefs.begin(), aRefLast = aRefs.end();
632     for(; aRefIt != aRefLast; aRefIt++) {
633       FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>((*aRefIt)->owner());
634       if (aFeature.get() != NULL)
635         theRefs.insert(aFeature);
636     }
637   }
638
639   if (!theRefs.empty() && isSendError) {
640     Events_Error::send(
641       "Feature '" + theFeature->data()->name() + "' is used and can not be deleted");
642   }
643 }
644
645 void Model_Document::removeFeature(FeaturePtr theFeature/*, const bool theCheck*/)
646 {
647   std::shared_ptr<Model_Data> aData = std::static_pointer_cast<Model_Data>(theFeature->data());
648   if (aData) {
649     TDF_Label aFeatureLabel = aData->label().Father();
650     if (myObjs.IsBound(aFeatureLabel))
651       myObjs.UnBind(aFeatureLabel);
652     else
653       return;  // not found feature => do not remove
654
655     // checking that the sub-element of composite feature is removed: if yes, inform the owner
656     std::set<std::shared_ptr<ModelAPI_Feature> > aRefs;
657     refsToFeature(theFeature, aRefs, false);
658     std::set<std::shared_ptr<ModelAPI_Feature> >::iterator aRefIter = aRefs.begin();
659     for(; aRefIter != aRefs.end(); aRefIter++) {
660       std::shared_ptr<ModelAPI_CompositeFeature> aComposite = 
661         std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(*aRefIter);
662       if (aComposite.get()) {
663         aComposite->removeFeature(theFeature);
664       }
665     }
666
667     // erase fields
668     theFeature->erase();
669     static Events_ID EVENT_DISP = Events_Loop::loop()->eventByName(EVENT_OBJECT_TO_REDISPLAY);
670     ModelAPI_EventCreator::get()->sendUpdated(theFeature, EVENT_DISP);
671     // erase all attributes under the label of feature
672     aFeatureLabel.ForgetAllAttributes();
673     // remove it from the references array
674     if (theFeature->isInHistory()) {
675       RemoveFromRefArray(featuresLabel(), aFeatureLabel);
676     }
677     // event: feature is deleted
678     ModelAPI_EventCreator::get()->sendDeleted(theFeature->document(), ModelAPI_Feature::group());
679   }
680 }
681
682 FeaturePtr Model_Document::feature(TDF_Label& theLabel) const
683 {
684   if (myObjs.IsBound(theLabel))
685     return myObjs.Find(theLabel);
686   return FeaturePtr();  // not found
687 }
688
689 ObjectPtr Model_Document::object(TDF_Label theLabel)
690 {
691   // try feature by label
692   FeaturePtr aFeature = feature(theLabel);
693   if (aFeature)
694     return feature(theLabel);
695   TDF_Label aFeatureLabel = theLabel.Father().Father();  // let's suppose it is result
696   aFeature = feature(aFeatureLabel);
697   if (aFeature) {
698     const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
699     std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.cbegin();
700     for (; aRIter != aResults.cend(); aRIter++) {
701       std::shared_ptr<Model_Data> aResData = std::dynamic_pointer_cast<Model_Data>(
702           (*aRIter)->data());
703       if (aResData->label().Father().IsEqual(theLabel))
704         return *aRIter;
705     }
706   }
707   return FeaturePtr();  // not found
708 }
709
710 std::shared_ptr<ModelAPI_Document> Model_Document::subDocument(std::string theDocID)
711 {
712   return Model_Application::getApplication()->getDocument(theDocID);
713 }
714
715 const std::set<std::string> Model_Document::subDocuments(const bool theActivatedOnly) const
716 {
717   std::set<std::string> aResult;
718   // comment must be in any feature: it is kind
719   int anIndex = 0;
720   TDF_ChildIDIterator aLabIter(featuresLabel(), TDataStd_Comment::GetID());
721   for (; aLabIter.More(); aLabIter.Next()) {
722     TDF_Label aFLabel = aLabIter.Value()->Label();
723     FeaturePtr aFeature = feature(aFLabel);
724     if (aFeature.get()) { // if document is closed the feature may be not in myObjs map
725       const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
726       std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
727       for (; aRIter != aResults.cend(); aRIter++) {
728         if ((*aRIter)->groupName() != ModelAPI_ResultPart::group()) continue;
729         if ((*aRIter)->isInHistory()) {
730           ResultPartPtr aPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(*aRIter);
731           if (aPart && (!theActivatedOnly || aPart->isActivated()))
732             aResult.insert(aPart->data()->name());
733         }
734       }
735     }
736   }
737   return aResult;
738 }
739
740 std::shared_ptr<Model_Document> Model_Document::subDoc(std::string theDocID)
741 {
742   // just store sub-document identifier here to manage it later
743   return std::dynamic_pointer_cast<Model_Document>(
744     Model_Application::getApplication()->getDocument(theDocID));
745 }
746
747 ObjectPtr Model_Document::object(const std::string& theGroupID, const int theIndex,
748                                  const bool theHidden)
749 {
750   if (theGroupID == ModelAPI_Feature::group()) {
751     if (theHidden) {
752       int anIndex = 0;
753       TDF_ChildIDIterator aLabIter(featuresLabel(), TDataStd_Comment::GetID());
754       for (; aLabIter.More(); aLabIter.Next()) {
755         if (theIndex == anIndex) {
756           TDF_Label aFLabel = aLabIter.Value()->Label();
757           return feature(aFLabel);
758         }
759         anIndex++;
760       }
761     } else {
762       Handle(TDataStd_ReferenceArray) aRefs;
763       if (!featuresLabel().FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs))
764         return ObjectPtr();
765       if (aRefs->Lower() > theIndex || aRefs->Upper() < theIndex)
766         return ObjectPtr();
767       TDF_Label aFeatureLabel = aRefs->Value(theIndex);
768       return feature(aFeatureLabel);
769     }
770   } else {
771     // comment must be in any feature: it is kind
772     int anIndex = 0;
773     TDF_ChildIDIterator aLabIter(featuresLabel(), TDataStd_Comment::GetID());
774     for (; aLabIter.More(); aLabIter.Next()) {
775       TDF_Label aFLabel = aLabIter.Value()->Label();
776       FeaturePtr aFeature = feature(aFLabel);
777       const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
778       std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
779       for (; aRIter != aResults.cend(); aRIter++) {
780         if ((*aRIter)->groupName() != theGroupID) continue;
781         bool isIn = theHidden && (*aRIter)->isInHistory();
782         if (!isIn && (*aRIter)->isInHistory()) { // check that there is nobody references this result
783           isIn = !(*aRIter)->isConcealed();
784         }
785         if (isIn) {
786           if (anIndex == theIndex)
787             return *aRIter;
788           anIndex++;
789         }
790       }
791     }
792   }
793   // not found
794   return ObjectPtr();
795 }
796
797 int Model_Document::size(const std::string& theGroupID, const bool theHidden)
798 {
799   int aResult = 0;
800   if (theGroupID == ModelAPI_Feature::group()) {
801     if (theHidden) {
802       return myObjs.Size();
803     } else {
804       Handle(TDataStd_ReferenceArray) aRefs;
805       if (featuresLabel().FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs))
806         return aRefs->Length();
807     }
808   } else {
809     // comment must be in any feature: it is kind
810     TDF_ChildIDIterator aLabIter(featuresLabel(), TDataStd_Comment::GetID());
811     for (; aLabIter.More(); aLabIter.Next()) {
812       TDF_Label aFLabel = aLabIter.Value()->Label();
813       FeaturePtr aFeature = feature(aFLabel);
814       if (!aFeature) // may be on close
815         continue;
816       const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
817       std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
818       for (; aRIter != aResults.cend(); aRIter++) {
819         if ((*aRIter)->groupName() != theGroupID) continue;
820         bool isIn = theHidden;
821         if (!isIn && (*aRIter)->isInHistory()) { // check that there is nobody references this result
822           isIn = !(*aRIter)->isConcealed();
823         }
824         if (isIn)
825           aResult++;
826       }
827     }
828   }
829   // group is not found
830   return aResult;
831 }
832
833 TDF_Label Model_Document::featuresLabel() const
834 {
835   return myDoc->Main().FindChild(TAG_OBJECTS);
836 }
837
838 void Model_Document::setUniqueName(FeaturePtr theFeature)
839 {
840   if (!theFeature->data()->name().empty())
841     return;  // not needed, name is already defined
842   std::string aName;  // result
843   // first count all objects of such kind to start with index = count + 1
844   int aNumObjects = 0;
845   NCollection_DataMap<TDF_Label, FeaturePtr>::Iterator aFIter(myObjs);
846   for (; aFIter.More(); aFIter.Next()) {
847     if (aFIter.Value()->getKind() == theFeature->getKind())
848       aNumObjects++;
849   }
850   // generate candidate name
851   std::stringstream aNameStream;
852   aNameStream << theFeature->getKind() << "_" << aNumObjects + 1;
853   aName = aNameStream.str();
854   // check this is unique, if not, increase index by 1
855   for (aFIter.Initialize(myObjs); aFIter.More();) {
856     FeaturePtr aFeature = aFIter.Value();
857     bool isSameName = aFeature->data()->name() == aName;
858     if (!isSameName) {  // check also results to avoid same results names (actual for Parts)
859       const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
860       std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
861       for (; aRIter != aResults.cend(); aRIter++) {
862         isSameName = (*aRIter)->data()->name() == aName;
863       }
864     }
865     if (isSameName) {
866       aNumObjects++;
867       std::stringstream aNameStream;
868       aNameStream << theFeature->getKind() << "_" << aNumObjects + 1;
869       aName = aNameStream.str();
870       // reinitialize iterator to make sure a new name is unique
871       aFIter.Initialize(myObjs);
872     } else
873       aFIter.Next();
874   }
875   theFeature->data()->setName(aName);
876 }
877
878 void Model_Document::initData(ObjectPtr theObj, TDF_Label theLab, const int theTag)
879 {
880   std::shared_ptr<ModelAPI_Document> aThis = Model_Application::getApplication()->getDocument(
881       myID);
882   std::shared_ptr<Model_Data> aData(new Model_Data);
883   aData->setLabel(theLab.FindChild(theTag));
884   aData->setObject(theObj);
885   theObj->setDoc(aThis);
886   theObj->setData(aData);
887   FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(theObj);
888   if (aFeature) {
889     setUniqueName(aFeature);  // must be before "initAttributes" because duplicate part uses name
890     aFeature->initAttributes();
891   }
892 }
893
894 void Model_Document::synchronizeFeatures(const bool theMarkUpdated, const bool theUpdateReferences)
895 {
896   std::shared_ptr<ModelAPI_Document> aThis = 
897     Model_Application::getApplication()->getDocument(myID);
898   // after all updates, sends a message that groups of features were created or updated
899   Events_Loop* aLoop = Events_Loop::loop();
900   aLoop->activateFlushes(false);
901
902   // update all objects by checking are they of labels or not
903   std::set<FeaturePtr> aNewFeatures, aKeptFeatures;
904   TDF_ChildIDIterator aLabIter(featuresLabel(), TDataStd_Comment::GetID());
905   for (; aLabIter.More(); aLabIter.Next()) {
906     TDF_Label aFeatureLabel = aLabIter.Value()->Label();
907     FeaturePtr aFeature;
908     if (!myObjs.IsBound(aFeatureLabel)) {  // a new feature is inserted
909       // create a feature
910       aFeature = ModelAPI_Session::get()->createFeature(
911           TCollection_AsciiString(Handle(TDataStd_Comment)::DownCast(aLabIter.Value())->Get())
912               .ToCString());
913       if (!aFeature) {  // somethig is wrong, most probably, the opened document has invalid structure
914         Events_Error::send("Invalid type of object in the document");
915         aLabIter.Value()->Label().ForgetAllAttributes();
916         continue;
917       }
918       // this must be before "setData" to redo the sketch line correctly
919       myObjs.Bind(aFeatureLabel, aFeature);
920       aNewFeatures.insert(aFeature);
921       initData(aFeature, aFeatureLabel, TAG_FEATURE_ARGUMENTS);
922
923       // event: model is updated
924       static Events_ID anEvent = Events_Loop::eventByName(EVENT_OBJECT_CREATED);
925       ModelAPI_EventCreator::get()->sendUpdated(aFeature, anEvent);
926     } else {  // nothing is changed, both iterators are incremented
927       aFeature = myObjs.Find(aFeatureLabel);
928       aKeptFeatures.insert(aFeature);
929       if (theMarkUpdated) {
930         static Events_ID anEvent = Events_Loop::eventByName(EVENT_OBJECT_UPDATED);
931         ModelAPI_EventCreator::get()->sendUpdated(aFeature, anEvent);
932       }
933     }
934   }
935   // update results of thefeatures (after features created because they may be connected, like sketch and sub elements)
936   std::list<FeaturePtr> aComposites; // composites must be updated after their subs (issue 360)
937   TDF_ChildIDIterator aLabIter2(featuresLabel(), TDataStd_Comment::GetID());
938   for (; aLabIter2.More(); aLabIter2.Next()) {
939     TDF_Label aFeatureLabel = aLabIter2.Value()->Label();
940     if (myObjs.IsBound(aFeatureLabel)) {  // a new feature is inserted
941       FeaturePtr aFeature = myObjs.Find(aFeatureLabel);
942       if (std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aFeature).get())
943         aComposites.push_back(aFeature);
944       updateResults(aFeature);
945     }
946   }
947   std::list<FeaturePtr>::iterator aComposite = aComposites.begin();
948   for(; aComposite != aComposites.end(); aComposite++) {
949     updateResults(*aComposite);
950   }
951
952   // check all features are checked: if not => it was removed
953   NCollection_DataMap<TDF_Label, FeaturePtr>::Iterator aFIter(myObjs);
954   while (aFIter.More()) {
955     if (aKeptFeatures.find(aFIter.Value()) == aKeptFeatures.end()
956         && aNewFeatures.find(aFIter.Value()) == aNewFeatures.end()) {
957       FeaturePtr aFeature = aFIter.Value();
958       // event: model is updated
959       //if (aFeature->isInHistory()) {
960         ModelAPI_EventCreator::get()->sendDeleted(aThis, ModelAPI_Feature::group());
961       //}
962       // results of this feature must be redisplayed (hided)
963       static Events_ID EVENT_DISP = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
964       const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
965       std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
966       // redisplay also removed feature (used for sketch and AISObject)
967       ModelAPI_EventCreator::get()->sendUpdated(aFeature, EVENT_DISP);
968       aFeature->erase();
969       // unbind after the "erase" call: on abort sketch is removes sub-objects that corrupts aFIter
970       myObjs.UnBind(aFIter.Key());
971       // reinitialize iterator because unbind may corrupt the previous order in the map
972       aFIter.Initialize(myObjs);
973     } else
974       aFIter.Next();
975   }
976
977   if (theUpdateReferences) {
978     synchronizeBackRefs();
979   }
980
981   myExecuteFeatures = false;
982   aLoop->activateFlushes(true);
983
984   aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_CREATED));
985   aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_DELETED));
986   aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_UPDATED));
987   aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_TO_REDISPLAY));
988   aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_TOHIDE));
989   myExecuteFeatures = true;
990 }
991
992 void Model_Document::synchronizeBackRefs()
993 {
994   std::shared_ptr<ModelAPI_Document> aThis = 
995     Model_Application::getApplication()->getDocument(myID);
996   // keeps the concealed flags of result to catch the change and create created/deleted events
997   std::list<std::pair<ResultPtr, bool> > aConcealed;
998   // first cycle: erase all data about back-references
999   NCollection_DataMap<TDF_Label, FeaturePtr>::Iterator aFeatures(myObjs);
1000   for(; aFeatures.More(); aFeatures.Next()) {
1001     FeaturePtr aFeature = aFeatures.Value();
1002     std::shared_ptr<Model_Data> aFData = 
1003       std::dynamic_pointer_cast<Model_Data>(aFeature->data());
1004     if (aFData) {
1005       aFData->eraseBackReferences();
1006     }
1007     const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
1008     std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
1009     for (; aRIter != aResults.cend(); aRIter++) {
1010       std::shared_ptr<Model_Data> aResData = 
1011         std::dynamic_pointer_cast<Model_Data>((*aRIter)->data());
1012       if (aResData) {
1013         aConcealed.push_back(std::pair<ResultPtr, bool>(*aRIter, (*aRIter)->isConcealed()));
1014         aResData->eraseBackReferences();
1015       }
1016     }
1017   }
1018
1019   // second cycle: set new back-references: only features may have reference, iterate only them
1020   ModelAPI_ValidatorsFactory* aValidators = ModelAPI_Session::get()->validators();
1021   for(aFeatures.Initialize(myObjs); aFeatures.More(); aFeatures.Next()) {
1022     FeaturePtr aFeature = aFeatures.Value();
1023     std::shared_ptr<Model_Data> aFData = 
1024       std::dynamic_pointer_cast<Model_Data>(aFeature->data());
1025     if (aFData) {
1026       std::list<std::pair<std::string, std::list<ObjectPtr> > > aRefs;
1027       aFData->referencesToObjects(aRefs);
1028       std::list<std::pair<std::string, std::list<ObjectPtr> > >::iterator aRefsIter = aRefs.begin();
1029       for(; aRefsIter != aRefs.end(); aRefsIter++) {
1030         std::list<ObjectPtr>::iterator aRefTo = aRefsIter->second.begin();
1031         for(; aRefTo != aRefsIter->second.end(); aRefTo++) {
1032           if (*aRefTo) {
1033             std::shared_ptr<Model_Data> aRefData = 
1034               std::dynamic_pointer_cast<Model_Data>((*aRefTo)->data());
1035             aRefData->addBackReference(aFeature, aRefsIter->first); // here the Concealed flag is updated
1036           }
1037         }
1038       }
1039     }
1040   }
1041   std::list<std::pair<ResultPtr, bool> >::iterator aCIter = aConcealed.begin();
1042   for(; aCIter != aConcealed.end(); aCIter++) {
1043     if (aCIter->first->isConcealed() != aCIter->second) { // somethign is changed => produce event
1044       if (aCIter->second) { // was concealed become not => creation event
1045         static Events_ID anEvent = Events_Loop::eventByName(EVENT_OBJECT_CREATED);
1046         ModelAPI_EventCreator::get()->sendUpdated(aCIter->first, anEvent);
1047       } else { // was not concealed become concealed => delete event
1048         ModelAPI_EventCreator::get()->sendDeleted(aThis, aCIter->first->groupName());
1049         // redisplay for the viewer (it must be disappeared also)
1050         static Events_ID EVENT_DISP = 
1051           Events_Loop::loop()->eventByName(EVENT_OBJECT_TO_REDISPLAY);
1052         ModelAPI_EventCreator::get()->sendUpdated(aCIter->first, EVENT_DISP);
1053       }
1054     }
1055   }
1056 }
1057
1058 TDF_Label Model_Document::resultLabel(
1059   const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theResultIndex) 
1060 {
1061   const std::shared_ptr<Model_Data>& aData = 
1062     std::dynamic_pointer_cast<Model_Data>(theFeatureData);
1063   return aData->label().Father().FindChild(TAG_FEATURE_RESULTS).FindChild(theResultIndex + 1);
1064 }
1065
1066 void Model_Document::storeResult(std::shared_ptr<ModelAPI_Data> theFeatureData,
1067                                  std::shared_ptr<ModelAPI_Result> theResult,
1068                                  const int theResultIndex)
1069 {
1070   std::shared_ptr<ModelAPI_Document> aThis = 
1071     Model_Application::getApplication()->getDocument(myID);
1072   theResult->setDoc(aThis);
1073   initData(theResult, resultLabel(theFeatureData, theResultIndex), TAG_FEATURE_ARGUMENTS);
1074   if (theResult->data()->name().empty()) {  // if was not initialized, generate event and set a name
1075     theResult->data()->setName(theFeatureData->name());
1076   }
1077 }
1078
1079 std::shared_ptr<ModelAPI_ResultConstruction> Model_Document::createConstruction(
1080     const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1081 {
1082   TDF_Label aLab = resultLabel(theFeatureData, theIndex);
1083   TDataStd_Comment::Set(aLab, ModelAPI_ResultConstruction::group().c_str());
1084   ObjectPtr anOldObject = object(aLab);
1085   std::shared_ptr<ModelAPI_ResultConstruction> aResult;
1086   if (anOldObject) {
1087     aResult = std::dynamic_pointer_cast<ModelAPI_ResultConstruction>(anOldObject);
1088   }
1089   if (!aResult) {
1090     aResult = std::shared_ptr<ModelAPI_ResultConstruction>(new Model_ResultConstruction);
1091     storeResult(theFeatureData, aResult, theIndex);
1092   }
1093   return aResult;
1094 }
1095
1096 std::shared_ptr<ModelAPI_ResultBody> Model_Document::createBody(
1097     const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1098 {
1099   TDF_Label aLab = resultLabel(theFeatureData, theIndex);
1100   TDataStd_Comment::Set(aLab, ModelAPI_ResultBody::group().c_str());
1101   ObjectPtr anOldObject = object(aLab);
1102   std::shared_ptr<ModelAPI_ResultBody> aResult;
1103   if (anOldObject) {
1104     aResult = std::dynamic_pointer_cast<ModelAPI_ResultBody>(anOldObject);
1105   }
1106   if (!aResult) {
1107     aResult = std::shared_ptr<ModelAPI_ResultBody>(new Model_ResultBody);
1108     storeResult(theFeatureData, aResult, theIndex);
1109   }
1110   return aResult;
1111 }
1112
1113 std::shared_ptr<ModelAPI_ResultPart> Model_Document::createPart(
1114     const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1115 {
1116   TDF_Label aLab = resultLabel(theFeatureData, theIndex);
1117   TDataStd_Comment::Set(aLab, ModelAPI_ResultPart::group().c_str());
1118   ObjectPtr anOldObject = object(aLab);
1119   std::shared_ptr<ModelAPI_ResultPart> aResult;
1120   if (anOldObject) {
1121     aResult = std::dynamic_pointer_cast<ModelAPI_ResultPart>(anOldObject);
1122   }
1123   if (!aResult) {
1124     aResult = std::shared_ptr<ModelAPI_ResultPart>(new Model_ResultPart);
1125     storeResult(theFeatureData, aResult, theIndex);
1126   }
1127   return aResult;
1128 }
1129
1130 std::shared_ptr<ModelAPI_ResultGroup> Model_Document::createGroup(
1131     const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1132 {
1133   TDF_Label aLab = resultLabel(theFeatureData, theIndex);
1134   TDataStd_Comment::Set(aLab, ModelAPI_ResultGroup::group().c_str());
1135   ObjectPtr anOldObject = object(aLab);
1136   std::shared_ptr<ModelAPI_ResultGroup> aResult;
1137   if (anOldObject) {
1138     aResult = std::dynamic_pointer_cast<ModelAPI_ResultGroup>(anOldObject);
1139   }
1140   if (!aResult) {
1141     aResult = std::shared_ptr<ModelAPI_ResultGroup>(new Model_ResultGroup(theFeatureData));
1142     storeResult(theFeatureData, aResult, theIndex);
1143   }
1144   return aResult;
1145 }
1146
1147 std::shared_ptr<ModelAPI_Feature> Model_Document::feature(
1148     const std::shared_ptr<ModelAPI_Result>& theResult)
1149 {
1150   std::shared_ptr<Model_Data> aData = std::dynamic_pointer_cast<Model_Data>(theResult->data());
1151   if (aData) {
1152     TDF_Label aFeatureLab = aData->label().Father().Father().Father();
1153     return feature(aFeatureLab);
1154   }
1155   return FeaturePtr();
1156 }
1157
1158 void Model_Document::updateResults(FeaturePtr theFeature)
1159 {
1160   // for not persistent is will be done by parametric updater automatically
1161   //if (!theFeature->isPersistentResult()) return;
1162   // check the existing results and remove them if there is nothing on the label
1163   std::list<ResultPtr>::const_iterator aResIter = theFeature->results().cbegin();
1164   while(aResIter != theFeature->results().cend()) {
1165     ResultPtr aBody = std::dynamic_pointer_cast<ModelAPI_Result>(*aResIter);
1166     if (aBody) {
1167       if (!aBody->data()->isValid()) { 
1168         // found a disappeared result => remove it
1169         theFeature->removeResult(aBody);
1170         // start iterate from beginning because iterator is corrupted by removing
1171         aResIter = theFeature->results().cbegin();
1172         continue;
1173       }
1174     }
1175     aResIter++;
1176   }
1177   // it may be on undo
1178   if (!theFeature->data() || !theFeature->data()->isValid())
1179     return;
1180   // check that results are presented on all labels
1181   int aResSize = theFeature->results().size();
1182   TDF_ChildIterator aLabIter(resultLabel(theFeature->data(), 0).Father());
1183   for(; aLabIter.More(); aLabIter.Next()) {
1184     // here must be GUID of the feature
1185     int aResIndex = aLabIter.Value().Tag() - 1;
1186     ResultPtr aNewBody;
1187     if (aResSize <= aResIndex) {
1188       TDF_Label anArgLab = aLabIter.Value();
1189       Handle(TDataStd_Comment) aGroup;
1190       if (anArgLab.FindAttribute(TDataStd_Comment::GetID(), aGroup)) {
1191         if (aGroup->Get() == ModelAPI_ResultBody::group().c_str()) {
1192           aNewBody = createBody(theFeature->data(), aResIndex);
1193         } else if (aGroup->Get() == ModelAPI_ResultPart::group().c_str()) {
1194           aNewBody = createPart(theFeature->data(), aResIndex);
1195         } else if (aGroup->Get() == ModelAPI_ResultConstruction::group().c_str()) {
1196           theFeature->execute(); // construction shapes are needed for sketch solver
1197           break;
1198         } else if (aGroup->Get() == ModelAPI_ResultGroup::group().c_str()) {
1199           aNewBody = createGroup(theFeature->data(), aResIndex);
1200         } else {
1201           Events_Error::send(std::string("Unknown type of result is found in the document:") +
1202             TCollection_AsciiString(aGroup->Get()).ToCString());
1203         }
1204       }
1205       if (aNewBody) {
1206         theFeature->setResult(aNewBody, aResIndex);
1207       }
1208     }
1209   }
1210 }
1211
1212 Standard_Integer HashCode(const TDF_Label& theLab, const Standard_Integer theUpper)
1213 {
1214   return TDF_LabelMapHasher::HashCode(theLab, theUpper);
1215
1216 }
1217 Standard_Boolean IsEqual(const TDF_Label& theLab1, const TDF_Label& theLab2)
1218 {
1219   return TDF_LabelMapHasher::IsEqual(theLab1, theLab2);
1220 }
1221
1222 void Model_Document::addNamingName(const TDF_Label theLabel, std::string theName)
1223 {
1224   myNamingNames[theName] = theLabel;
1225 }
1226
1227 TDF_Label Model_Document::findNamingName(std::string theName)
1228 {
1229   std::map<std::string, TDF_Label>::iterator aFind = myNamingNames.find(theName);
1230   if (aFind == myNamingNames.end())
1231     return TDF_Label(); // not found
1232   return aFind->second;
1233 }
1234
1235 ResultPtr Model_Document::findByName(const std::string theName)
1236 {
1237   NCollection_DataMap<TDF_Label, FeaturePtr>::Iterator anObjIter(myObjs);
1238   for(; anObjIter.More(); anObjIter.Next()) {
1239     FeaturePtr& aFeature = anObjIter.ChangeValue();
1240     if (!aFeature) // may be on close
1241       continue;
1242     const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
1243     std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
1244     for (; aRIter != aResults.cend(); aRIter++) {
1245       if (aRIter->get() && (*aRIter)->data() && (*aRIter)->data()->isValid() &&
1246           (*aRIter)->data()->name() == theName) {
1247         return *aRIter;
1248       }
1249     }
1250   }
1251   // not found
1252   return ResultPtr();
1253 }