1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: Model_Document.cxx
4 // Created: 28 Feb 2014
5 // Author: Mikhail PONIKAROV
7 #include <Model_Document.h>
8 #include <Model_Data.h>
9 #include <Model_Objects.h>
10 #include <Model_Application.h>
11 #include <Model_Session.h>
12 #include <Model_Events.h>
13 #include <ModelAPI_ResultPart.h>
14 #include <ModelAPI_Validator.h>
15 #include <ModelAPI_CompositeFeature.h>
16 #include <ModelAPI_AttributeSelectionList.h>
17 #include <ModelAPI_Tools.h>
19 #include <Events_Loop.h>
20 #include <Events_Error.h>
22 #include <TDataStd_Integer.hxx>
23 #include <TDataStd_Comment.hxx>
24 #include <TDF_ChildIDIterator.hxx>
25 #include <TDataStd_ReferenceArray.hxx>
26 #include <TDataStd_ReferenceList.hxx>
27 #include <TDataStd_IntegerArray.hxx>
28 #include <TDataStd_HLabelArray1.hxx>
29 #include <TDataStd_Name.hxx>
30 #include <TDataStd_AsciiString.hxx>
31 #include <TDF_Reference.hxx>
32 #include <TDF_ChildIDIterator.hxx>
33 #include <TDF_LabelMapHasher.hxx>
34 #include <TDF_Delta.hxx>
35 #include <OSD_File.hxx>
36 #include <OSD_Path.hxx>
37 #include <TDF_AttributeDelta.hxx>
38 #include <TDF_AttributeDeltaList.hxx>
39 #include <TDF_ListIteratorOfAttributeDeltaList.hxx>
40 #include <TDF_ListIteratorOfLabelList.hxx>
48 # define _separator_ '\\'
50 # define _separator_ '/'
53 static const int UNDO_LIMIT = 1000; // number of possible undo operations (big for sketcher)
55 static const int TAG_GENERAL = 1; // general properties tag
58 static const int TAG_CURRENT_FEATURE = 1; ///< where the reference to the current feature label is located (or no attribute if null feature)
59 static const int TAG_CURRENT_TRANSACTION = 2; ///< integer, index of the transaction
60 static const int TAG_SELECTION_FEATURE = 3; ///< integer, tag of the selection feature label
62 Model_Document::Model_Document(const std::string theID, const std::string theKind)
63 : myID(theID), myKind(theKind), myIsActive(false),
64 myDoc(new TDocStd_Document("BinOcaf")) // binary OCAF format
66 myObjs = new Model_Objects(myDoc->Main());
67 myDoc->SetUndoLimit(UNDO_LIMIT);
68 myTransactionSave = 0;
69 myExecuteFeatures = true;
70 // to have something in the document and avoid empty doc open/save problem
71 // in transaction for nesting correct working
73 TDataStd_Integer::Set(myDoc->Main().Father(), 0);
74 // this to avoid creation of integer attribute outside the transaction after undo
76 myDoc->CommitCommand();
79 void Model_Document::setThis(DocumentPtr theDoc)
81 myObjs->setOwner(theDoc);
84 /// Returns the file name of this document by the nameof directory and identifuer of a document
85 static TCollection_ExtendedString DocFileName(const char* theFileName, const std::string& theID)
87 TCollection_ExtendedString aPath((const Standard_CString) theFileName);
88 // remove end-separators
89 while(aPath.Length() &&
90 (aPath.Value(aPath.Length()) == '\\' || aPath.Value(aPath.Length()) == '/'))
91 aPath.Remove(aPath.Length());
93 aPath += theID.c_str();
94 aPath += ".cbf"; // standard binary file extension
98 bool Model_Document::isRoot() const
100 return this == Model_Session::get()->moduleDocument().get();
103 bool Model_Document::load(const char* theFileName, DocumentPtr theThis)
105 Handle(Model_Application) anApp = Model_Application::getApplication();
107 anApp->setLoadPath(theFileName);
109 TCollection_ExtendedString aPath(DocFileName(theFileName, myID));
110 PCDM_ReaderStatus aStatus = (PCDM_ReaderStatus) -1;
111 Handle(TDocStd_Document) aLoaded;
113 aStatus = anApp->Open(aPath, aLoaded);
114 } catch (Standard_Failure) {
115 Handle(Standard_Failure) aFail = Standard_Failure::Caught();
117 std::string("Exception in opening of document: ") + aFail->GetMessageString());
120 bool isError = aStatus != PCDM_RS_OK;
123 case PCDM_RS_UnknownDocument:
124 Events_Error::send(std::string("Can not open document"));
126 case PCDM_RS_AlreadyRetrieved:
127 Events_Error::send(std::string("Can not open document: already opened"));
129 case PCDM_RS_AlreadyRetrievedAndModified:
131 std::string("Can not open document: already opened and modified"));
133 case PCDM_RS_NoDriver:
134 Events_Error::send(std::string("Can not open document: driver library is not found"));
136 case PCDM_RS_UnknownFileDriver:
137 Events_Error::send(std::string("Can not open document: unknown driver for opening"));
139 case PCDM_RS_OpenError:
140 Events_Error::send(std::string("Can not open document: file open error"));
142 case PCDM_RS_NoVersion:
143 Events_Error::send(std::string("Can not open document: invalid version"));
145 case PCDM_RS_NoModel:
146 Events_Error::send(std::string("Can not open document: no data model"));
148 case PCDM_RS_NoDocument:
149 Events_Error::send(std::string("Can not open document: no document inside"));
151 case PCDM_RS_FormatFailure:
152 Events_Error::send(std::string("Can not open document: format failure"));
154 case PCDM_RS_TypeNotFoundInSchema:
155 Events_Error::send(std::string("Can not open document: invalid object"));
157 case PCDM_RS_UnrecognizedFileFormat:
158 Events_Error::send(std::string("Can not open document: unrecognized file format"));
160 case PCDM_RS_MakeFailure:
161 Events_Error::send(std::string("Can not open document: make failure"));
163 case PCDM_RS_PermissionDenied:
164 Events_Error::send(std::string("Can not open document: permission denied"));
166 case PCDM_RS_DriverFailure:
167 Events_Error::send(std::string("Can not open document: driver failure"));
170 Events_Error::send(std::string("Can not open document: unknown error"));
174 std::shared_ptr<Model_Session> aSession =
175 std::dynamic_pointer_cast<Model_Session>(Model_Session::get());
178 myDoc->SetUndoLimit(UNDO_LIMIT);
179 // to avoid the problem that feature is created in the current, not this, document
180 aSession->setActiveDocument(anApp->getDocument(myID), false);
181 aSession->setCheckTransactions(false);
184 myObjs = new Model_Objects(myDoc->Main()); // synchronisation is inside
185 myObjs->setOwner(theThis);
186 // update the current features status
187 setCurrentFeature(currentFeature(false), false);
188 aSession->setCheckTransactions(true);
189 aSession->setActiveDocument(Model_Session::get()->moduleDocument(), false);
190 // this is done in Part result "activate", so no needed here. Causes not-blue active part.
191 // aSession->setActiveDocument(anApp->getDocument(myID), true);
192 } else { // open failed, but new documnet was created to work with it: inform the model
193 aSession->setActiveDocument(Model_Session::get()->moduleDocument(), false);
198 bool Model_Document::save(const char* theFileName, std::list<std::string>& theResults)
200 // create a directory in the root document if it is not yet exist
201 Handle(Model_Application) anApp = Model_Application::getApplication();
204 CreateDirectory(theFileName, NULL);
206 mkdir(theFileName, 0x1ff);
209 // filename in the dir is id of document inside of the given directory
210 TCollection_ExtendedString aPath(DocFileName(theFileName, myID));
211 PCDM_StoreStatus aStatus;
213 aStatus = anApp->SaveAs(myDoc, aPath);
214 } catch (Standard_Failure) {
215 Handle(Standard_Failure) aFail = Standard_Failure::Caught();
217 std::string("Exception in saving of document: ") + aFail->GetMessageString());
220 bool isDone = aStatus == PCDM_SS_OK || aStatus == PCDM_SS_No_Obj;
223 case PCDM_SS_DriverFailure:
224 Events_Error::send(std::string("Can not save document: save driver-library failure"));
226 case PCDM_SS_WriteFailure:
227 Events_Error::send(std::string("Can not save document: file writing failure"));
229 case PCDM_SS_Failure:
231 Events_Error::send(std::string("Can not save document"));
235 myTransactionSave = myTransactions.size();
236 if (isDone) { // save also sub-documents if any
237 theResults.push_back(TCollection_AsciiString(aPath).ToCString());
238 const std::set<std::string> aSubs = subDocuments(false);
239 std::set<std::string>::iterator aSubIter = aSubs.begin();
240 for (; aSubIter != aSubs.end() && isDone; aSubIter++) {
241 if (anApp->isLoadByDemand(*aSubIter)) {
242 // copy not-activated document that is not in the memory
243 std::string aDocName = *aSubIter;
244 if (!aDocName.empty()) {
246 TCollection_AsciiString aSubPath(DocFileName(anApp->loadPath().c_str(), aDocName));
247 OSD_Path aPath(aSubPath);
248 OSD_File aFile(aPath);
249 if (aFile.Exists()) {
250 TCollection_AsciiString aDestinationDir(DocFileName(theFileName, aDocName));
251 OSD_Path aDestination(aDestinationDir);
252 aFile.Copy(aDestination);
253 theResults.push_back(aDestinationDir.ToCString());
256 std::string("Can not open file ") + aSubPath.ToCString() + " for saving");
259 } else { // simply save opened document
260 isDone = subDoc(*aSubIter)->save(theFileName, theResults);
267 void Model_Document::close(const bool theForever)
269 std::shared_ptr<ModelAPI_Session> aPM = Model_Session::get();
270 if (!isRoot() && this == aPM->activeDocument().get()) {
271 aPM->setActiveDocument(aPM->moduleDocument());
272 } else if (isRoot()) {
273 // erase the active document if root is closed
274 aPM->setActiveDocument(DocumentPtr());
277 const std::set<std::string> aSubs = subDocuments(true);
278 std::set<std::string>::iterator aSubIter = aSubs.begin();
279 for (; aSubIter != aSubs.end(); aSubIter++) {
280 std::shared_ptr<Model_Document> aSub = subDoc(*aSubIter);
281 if (aSub->myObjs) // if it was not closed before
282 aSub->close(theForever);
285 // close for thid document needs no transaction in this document
286 std::static_pointer_cast<Model_Session>(Model_Session::get())->setCheckTransactions(false);
288 // close all only if it is really asked, otherwise it can be undoed/redoed
290 // flush everything to avoid messages with bad objects
293 if (myDoc->CanClose() == CDM_CCS_OK)
295 mySelectionFeature.reset();
297 setCurrentFeature(FeaturePtr(), false); // disables all features
300 std::static_pointer_cast<Model_Session>(Model_Session::get())->setCheckTransactions(true);
303 void Model_Document::startOperation()
305 incrementTransactionID(); // outside of transaction in order to avoid empty transactions keeping
306 if (myDoc->HasOpenCommand()) { // start of nested command
307 if (myDoc->CommitCommand()) { // commit the current: it will contain all nested after compactification
308 myTransactions.rbegin()->myOCAFNum++; // if has open command, the list is not empty
310 myNestedNum.push_back(0); // start of nested operation with zero transactions inside yet
311 myDoc->OpenCommand();
312 } else { // start the simple command
315 // starts a new operation
316 myTransactions.push_back(Transaction());
317 if (!myNestedNum.empty())
318 (*myNestedNum.rbegin())++;
320 // new command for all subs
321 const std::set<std::string> aSubs = subDocuments(true);
322 std::set<std::string>::iterator aSubIter = aSubs.begin();
323 for (; aSubIter != aSubs.end(); aSubIter++)
324 subDoc(*aSubIter)->startOperation();
327 void Model_Document::compactNested()
329 if (!myNestedNum.empty()) {
330 int aNumToCompact = *(myNestedNum.rbegin());
331 int aSumOfTransaction = 0;
332 for(int a = 0; a < aNumToCompact; a++) {
333 aSumOfTransaction += myTransactions.rbegin()->myOCAFNum;
334 myTransactions.pop_back();
336 // the latest transaction is the start of lower-level operation which startes the nested
337 myTransactions.rbegin()->myOCAFNum += aSumOfTransaction;
338 myNestedNum.pop_back();
342 /// Compares the content ofthe given attributes, returns true if equal.
343 /// This method is used to avoid empty transactions when only "current" is changed
344 /// to some value and then comes back in this transaction, so, it compares only
345 /// references and Boolean and Integer Arrays for the current moment.
346 static bool isEqualContent(Handle(TDF_Attribute) theAttr1, Handle(TDF_Attribute) theAttr2)
348 if (Standard_GUID::IsEqual(theAttr1->ID(), TDF_Reference::GetID())) { // reference
349 Handle(TDF_Reference) aRef1 = Handle(TDF_Reference)::DownCast(theAttr1);
350 Handle(TDF_Reference) aRef2 = Handle(TDF_Reference)::DownCast(theAttr2);
351 if (aRef1.IsNull() && aRef2.IsNull())
353 if (aRef1.IsNull() || aRef2.IsNull())
355 return aRef1->Get().IsEqual(aRef2->Get()) == Standard_True;
356 } else if (Standard_GUID::IsEqual(theAttr1->ID(), TDataStd_BooleanArray::GetID())) {
357 Handle(TDataStd_BooleanArray) anArr1 = Handle(TDataStd_BooleanArray)::DownCast(theAttr1);
358 Handle(TDataStd_BooleanArray) anArr2 = Handle(TDataStd_BooleanArray)::DownCast(theAttr2);
359 if (anArr1.IsNull() && anArr2.IsNull())
361 if (anArr1.IsNull() || anArr2.IsNull())
363 if (anArr1->Lower() == anArr2->Lower() && anArr1->Upper() == anArr2->Upper()) {
364 for(int a = anArr1->Lower(); a <= anArr1->Upper(); a++)
365 if (a != 1 && anArr1->Value(a) != anArr2->Value(a)) // second is for display
369 } else if (Standard_GUID::IsEqual(theAttr1->ID(), TDataStd_IntegerArray::GetID())) {
370 Handle(TDataStd_IntegerArray) anArr1 = Handle(TDataStd_IntegerArray)::DownCast(theAttr1);
371 Handle(TDataStd_IntegerArray) anArr2 = Handle(TDataStd_IntegerArray)::DownCast(theAttr2);
372 if (anArr1.IsNull() && anArr2.IsNull())
374 if (anArr1.IsNull() || anArr2.IsNull())
376 if (anArr1->Lower() == anArr2->Lower() && anArr1->Upper() == anArr2->Upper()) {
377 for(int a = anArr1->Lower(); a <= anArr1->Upper(); a++)
378 if (anArr1->Value(a) != anArr2->Value(a)) {
379 // avoid the transaction ID checking
380 if (a == 2 && anArr1->Upper() == 2 && anArr2->Label().Tag() == 1 &&
381 (anArr2->Label().Depth() == 4 || anArr2->Label().Depth() == 6))
387 } else if (Standard_GUID::IsEqual(theAttr1->ID(), TDataStd_ReferenceArray::GetID())) {
388 Handle(TDataStd_ReferenceArray) anArr1 = Handle(TDataStd_ReferenceArray)::DownCast(theAttr1);
389 Handle(TDataStd_ReferenceArray) anArr2 = Handle(TDataStd_ReferenceArray)::DownCast(theAttr2);
390 if (anArr1.IsNull() && anArr2.IsNull())
392 if (anArr1.IsNull() || anArr2.IsNull())
394 if (anArr1->Lower() == anArr2->Lower() && anArr1->Upper() == anArr2->Upper()) {
395 for(int a = anArr1->Lower(); a <= anArr1->Upper(); a++)
396 if (anArr1->Value(a) != anArr2->Value(a)) {
397 // avoid the transaction ID checking
398 if (a == 2 && anArr1->Upper() == 2 && anArr2->Label().Tag() == 1 &&
399 (anArr2->Label().Depth() == 4 || anArr2->Label().Depth() == 6))
405 } else if (Standard_GUID::IsEqual(theAttr1->ID(), TDataStd_ReferenceList::GetID())) {
406 Handle(TDataStd_ReferenceList) aList1 = Handle(TDataStd_ReferenceList)::DownCast(theAttr1);
407 Handle(TDataStd_ReferenceList) aList2= Handle(TDataStd_ReferenceList)::DownCast(theAttr2);
408 if (aList1.IsNull() && aList2.IsNull())
410 if (aList1.IsNull() || aList2.IsNull())
412 const TDF_LabelList& aLList1 = aList1->List();
413 const TDF_LabelList& aLList2 = aList2->List();
414 TDF_ListIteratorOfLabelList aLIter1(aLList1);
415 TDF_ListIteratorOfLabelList aLIter2(aLList2);
416 for(; aLIter1.More() && aLIter2.More(); aLIter1.Next(), aLIter2.Next()) {
417 if (aLIter1.Value() != aLIter2.Value())
420 return !aLIter1.More() && !aLIter2.More(); // both lists are with the same size
421 } else if (Standard_GUID::IsEqual(theAttr1->ID(), TDF_TagSource::GetID())) {
422 return true; // it just for created and removed feature: nothing is changed
427 /// Returns true if the last transaction is actually empty: modification to te same values
428 /// were performed only
429 static bool isEmptyTransaction(const Handle(TDocStd_Document)& theDoc) {
430 Handle(TDF_Delta) aDelta;
431 aDelta = theDoc->GetUndos().Last();
432 TDF_LabelList aDeltaList;
433 aDelta->Labels(aDeltaList); // it clears list, so, use new one and then append to the result
434 for(TDF_ListIteratorOfLabelList aListIter(aDeltaList); aListIter.More(); aListIter.Next()) {
437 // add also label of the modified attributes
438 const TDF_AttributeDeltaList& anAttrs = aDelta->AttributeDeltas();
439 for (TDF_ListIteratorOfAttributeDeltaList anAttr(anAttrs); anAttr.More(); anAttr.Next()) {
440 Handle(TDF_AttributeDelta)& anADelta = anAttr.Value();
441 if (!anADelta->Label().IsNull() && !anADelta->Attribute().IsNull()) {
442 Handle(TDF_Attribute) aCurrentAttr;
443 if (anADelta->Label().FindAttribute(anADelta->Attribute()->ID(), aCurrentAttr)) {
444 if (isEqualContent(anADelta->Attribute(), aCurrentAttr)) {
445 continue; // attribute is not changed actually
447 } else if (Standard_GUID::IsEqual(anADelta->Attribute()->ID(), TDataStd_AsciiString::GetID())) {
448 continue; // error message is disappeared
456 bool Model_Document::finishOperation()
458 bool isNestedClosed = !myDoc->HasOpenCommand() && !myNestedNum.empty();
459 static std::shared_ptr<Model_Session> aSession =
460 std::static_pointer_cast<Model_Session>(Model_Session::get());
461 // do it before flashes to enable and recompute nesting features correctly
462 if (myNestedNum.empty() || (isNestedClosed && myNestedNum.size() == 1)) {
463 // if all nested operations are closed, make current the higher level objects (to perform
464 // it in the python scripts correctly): sketch become current after creation ofsub-elements
465 FeaturePtr aCurrent = currentFeature(false);
466 CompositeFeaturePtr aMain, aNext = ModelAPI_Tools::compositeOwner(aCurrent);
469 aNext = ModelAPI_Tools::compositeOwner(aMain);
471 if (aMain.get() && aMain != aCurrent)
472 setCurrentFeature(aMain, false);
474 myObjs->synchronizeBackRefs();
475 Events_Loop* aLoop = Events_Loop::loop();
476 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_CREATED));
477 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_UPDATED));
478 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_TO_REDISPLAY));
479 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_DELETED));
480 // this must be here just after everything is finished but before real transaction stop
481 // to avoid messages about modifications outside of the transaction
482 // and to rebuild everything after all updates and creates
483 if (isRoot()) { // once for root document
484 Events_Loop::loop()->autoFlush(Events_Loop::eventByName(EVENT_OBJECT_UPDATED));
485 static std::shared_ptr<Events_Message> aFinishMsg
486 (new Events_Message(Events_Loop::eventByName("FinishOperation")));
487 Events_Loop::loop()->send(aFinishMsg);
488 Events_Loop::loop()->autoFlush(Events_Loop::eventByName(EVENT_OBJECT_UPDATED), false);
490 // to avoid "updated" message appearance by updater
491 //aLoop->clear(Events_Loop::eventByName(EVENT_OBJECT_UPDATED));
493 // finish for all subs first: to avoid nested finishing and "isOperation" calls problems inside
494 bool aResult = false;
495 const std::set<std::string> aSubs = subDocuments(true);
496 std::set<std::string>::iterator aSubIter = aSubs.begin();
497 for (; aSubIter != aSubs.end(); aSubIter++)
498 if (subDoc(*aSubIter)->finishOperation())
501 // transaction may be empty if this document was created during this transaction (create part)
502 if (!myTransactions.empty() && myDoc->CommitCommand()) { // if commit is successfull, just increment counters
503 if (isEmptyTransaction(myDoc)) { // erase this transaction
507 myTransactions.rbegin()->myOCAFNum++;
512 if (isNestedClosed) {
515 if (!aResult && !myTransactions.empty() /* it can be for just created part document */)
516 aResult = myTransactions.rbegin()->myOCAFNum != 0;
518 if (!aResult && isRoot()) {
519 // nothing inside in all documents, so remove this transaction from the transactions list
520 undoInternal(true, false);
522 // on finish clear redos in any case (issue 446) and for all subs (issue 408)
525 for (aSubIter = aSubs.begin(); aSubIter != aSubs.end(); aSubIter++) {
526 subDoc(*aSubIter)->myDoc->ClearRedos();
527 subDoc(*aSubIter)->myRedos.clear();
533 /// Returns in theDelta labels that has been modified in the latest transaction of theDoc
534 static void modifiedLabels(const Handle(TDocStd_Document)& theDoc, TDF_LabelList& theDelta,
535 const bool isRedo = false) {
536 Handle(TDF_Delta) aDelta;
538 aDelta = theDoc->GetRedos().First();
540 aDelta = theDoc->GetUndos().Last();
541 TDF_LabelList aDeltaList;
542 aDelta->Labels(aDeltaList); // it clears list, so, use new one and then append to the result
543 for(TDF_ListIteratorOfLabelList aListIter(aDeltaList); aListIter.More(); aListIter.Next()) {
544 theDelta.Append(aListIter.Value());
546 // add also label of the modified attributes
547 const TDF_AttributeDeltaList& anAttrs = aDelta->AttributeDeltas();
548 for (TDF_ListIteratorOfAttributeDeltaList anAttr(anAttrs); anAttr.More(); anAttr.Next()) {
549 theDelta.Append(anAttr.Value()->Label());
553 void Model_Document::abortOperation()
555 TDF_LabelList aDeltaLabels; // labels that are updated during "abort"
556 if (!myNestedNum.empty() && !myDoc->HasOpenCommand()) { // abort all what was done in nested
558 // store undo-delta here as undo actually does in the method later
559 int a, aNumTransactions = myTransactions.rbegin()->myOCAFNum;
560 for(a = 0; a < aNumTransactions; a++) {
561 modifiedLabels(myDoc, aDeltaLabels);
564 for(a = 0; a < aNumTransactions; a++) {
568 undoInternal(false, false);
571 } else { // abort the current
572 int aNumTransactions = myTransactions.rbegin()->myOCAFNum;
573 myTransactions.pop_back();
574 if (!myNestedNum.empty())
575 (*myNestedNum.rbegin())--;
576 // roll back the needed number of transactions
577 // make commit/undo to get the modification delta
578 //myDoc->AbortCommand();
579 if (myDoc->CommitCommand()) {
580 modifiedLabels(myDoc, aDeltaLabels);
583 for(int a = 0; a < aNumTransactions; a++) {
584 modifiedLabels(myDoc, aDeltaLabels);
589 // abort for all subs, flushes will be later, in the end of root abort
590 const std::set<std::string> aSubs = subDocuments(true);
591 std::set<std::string>::iterator aSubIter = aSubs.begin();
592 for (; aSubIter != aSubs.end(); aSubIter++)
593 subDoc(*aSubIter)->abortOperation();
594 // references may be changed because they are set in attributes on the fly
595 myObjs->synchronizeFeatures(aDeltaLabels, true, isRoot());
598 bool Model_Document::isOperation() const
600 // operation is opened for all documents: no need to check subs
601 return myDoc->HasOpenCommand() == Standard_True ;
604 bool Model_Document::isModified()
606 // is modified if at least one operation was commited and not undoed
607 return myTransactions.size() != myTransactionSave || isOperation();
610 bool Model_Document::canUndo()
612 // issue 406 : if transaction is opened, but nothing to undo behind, can not undo
613 int aCurrentNum = isOperation() ? 1 : 0;
614 if (myDoc->GetAvailableUndos() > 0 &&
615 (myNestedNum.empty() || *myNestedNum.rbegin() - aCurrentNum > 0) && // there is something to undo in nested
616 myTransactions.size() - aCurrentNum > 0 /* for omitting the first useless transaction */)
618 // check other subs contains operation that can be undoed
619 const std::set<std::string> aSubs = subDocuments(true);
620 std::set<std::string>::iterator aSubIter = aSubs.begin();
621 for (; aSubIter != aSubs.end(); aSubIter++) {
622 std::shared_ptr<Model_Document> aSub = subDoc(*aSubIter);
623 if (aSub->myObjs) {// if it was not closed before
632 void Model_Document::undoInternal(const bool theWithSubs, const bool theSynchronize)
634 int aNumTransactions = myTransactions.rbegin()->myOCAFNum;
635 myRedos.push_back(*myTransactions.rbegin());
636 myTransactions.pop_back();
637 if (!myNestedNum.empty())
638 (*myNestedNum.rbegin())--;
639 // roll back the needed number of transactions
640 TDF_LabelList aDeltaLabels;
641 for(int a = 0; a < aNumTransactions; a++) {
643 modifiedLabels(myDoc, aDeltaLabels);
649 const std::set<std::string> aSubs = subDocuments(true);
650 std::set<std::string>::iterator aSubIter = aSubs.begin();
651 for (; aSubIter != aSubs.end(); aSubIter++) {
652 if (!subDoc(*aSubIter)->myObjs)
654 subDoc(*aSubIter)->undoInternal(theWithSubs, theSynchronize);
657 // after undo of all sub-documents to avoid updates on not-modified data (issue 370)
658 if (theSynchronize) {
659 myObjs->synchronizeFeatures(aDeltaLabels, true, isRoot());
660 // update the current features status
661 setCurrentFeature(currentFeature(false), false);
665 void Model_Document::undo()
667 undoInternal(true, true);
670 bool Model_Document::canRedo()
672 if (!myRedos.empty())
674 // check other subs contains operation that can be redoed
675 const std::set<std::string> aSubs = subDocuments(true);
676 std::set<std::string>::iterator aSubIter = aSubs.begin();
677 for (; aSubIter != aSubs.end(); aSubIter++) {
678 if (!subDoc(*aSubIter)->myObjs)
680 if (subDoc(*aSubIter)->canRedo())
686 void Model_Document::redo()
688 if (!myNestedNum.empty())
689 (*myNestedNum.rbegin())++;
690 int aNumRedos = myRedos.rbegin()->myOCAFNum;
691 myTransactions.push_back(*myRedos.rbegin());
693 TDF_LabelList aDeltaLabels;
694 for(int a = 0; a < aNumRedos; a++) {
695 modifiedLabels(myDoc, aDeltaLabels, true);
700 const std::set<std::string> aSubs = subDocuments(true);
701 std::set<std::string>::iterator aSubIter = aSubs.begin();
702 for (; aSubIter != aSubs.end(); aSubIter++)
703 subDoc(*aSubIter)->redo();
705 // after redo of all sub-documents to avoid updates on not-modified data (issue 370)
706 myObjs->synchronizeFeatures(aDeltaLabels, true, isRoot());
707 // update the current features status
708 setCurrentFeature(currentFeature(false), false);
711 std::list<std::string> Model_Document::undoList() const
713 std::list<std::string> aResult;
714 // the number of skipped current operations (on undo they will be aborted)
715 int aSkipCurrent = isOperation() ? 1 : 0;
716 std::list<Transaction>::const_reverse_iterator aTrIter = myTransactions.crbegin();
717 int aNumUndo = myTransactions.size();
718 if (!myNestedNum.empty())
719 aNumUndo = *myNestedNum.rbegin();
720 for( ; aNumUndo > 0; aTrIter++, aNumUndo--) {
721 if (aSkipCurrent == 0) aResult.push_back(aTrIter->myId);
727 std::list<std::string> Model_Document::redoList() const
729 std::list<std::string> aResult;
730 std::list<Transaction>::const_reverse_iterator aTrIter = myRedos.crbegin();
731 for( ; aTrIter != myRedos.crend(); aTrIter++) {
732 aResult.push_back(aTrIter->myId);
737 void Model_Document::operationId(const std::string& theId)
739 myTransactions.rbegin()->myId = theId;
742 FeaturePtr Model_Document::addFeature(std::string theID, const bool theMakeCurrent)
744 std::shared_ptr<Model_Session> aSession =
745 std::dynamic_pointer_cast<Model_Session>(ModelAPI_Session::get());
746 FeaturePtr aFeature = aSession->createFeature(theID, this);
750 Model_Document* aDocToAdd;
751 if (!aFeature->documentToAdd().empty()) { // use the customized document to add
752 if (aFeature->documentToAdd() != kind()) { // the root document by default
753 aDocToAdd = std::dynamic_pointer_cast<Model_Document>(aSession->moduleDocument()).get();
757 } else { // if customized is not presented, add to "this" document
761 // searching for feature after which must be added the next feature: this is the current feature
762 // but also all sub-features of this feature
763 FeaturePtr aCurrent = aDocToAdd->currentFeature(false);
764 bool isModified = true;
765 for(CompositeFeaturePtr aComp = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aCurrent);
766 aComp.get() && isModified;
767 aComp = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aCurrent)) {
769 int aSubs = aComp->numberOfSubs(false);
770 for(int a = 0; a < aSubs; a++) {
771 FeaturePtr aSub = aComp->subFeature(a, false);
772 if (myObjs->isLater(aSub, aCurrent)) {
778 aDocToAdd->myObjs->addFeature(aFeature, aCurrent);
779 if (!aFeature->isAction()) { // do not add action to the data model
780 if (theMakeCurrent) // after all this feature stays in the document, so make it current
781 aDocToAdd->setCurrentFeature(aFeature, false);
782 } else { // feature must be executed
783 // no creation event => updater not working, problem with remove part
791 void Model_Document::refsToFeature(FeaturePtr theFeature,
792 std::set<std::shared_ptr<ModelAPI_Feature> >& theRefs, const bool isSendError)
794 myObjs->refsToFeature(theFeature, theRefs, isSendError);
797 void Model_Document::removeFeature(FeaturePtr theFeature)
799 myObjs->removeFeature(theFeature);
802 void Model_Document::moveFeature(FeaturePtr theMoved, FeaturePtr theAfterThis)
804 myObjs->moveFeature(theMoved, theAfterThis);
805 if (theAfterThis == currentFeature(true))
806 setCurrentFeature(theMoved, true);
809 void Model_Document::updateHistory(const std::shared_ptr<ModelAPI_Object> theObject)
811 myObjs->updateHistory(theObject);
814 void Model_Document::updateHistory(const std::string theGroup)
816 myObjs->updateHistory(theGroup);
819 std::shared_ptr<ModelAPI_Document> Model_Document::subDocument(std::string theDocID)
821 return Model_Application::getApplication()->getDocument(theDocID);
824 const std::set<std::string> Model_Document::subDocuments(const bool theActivatedOnly) const
826 std::set<std::string> aResult;
827 std::list<ResultPtr> aPartResults;
828 myObjs->allResults(ModelAPI_ResultPart::group(), aPartResults);
829 std::list<ResultPtr>::iterator aPartRes = aPartResults.begin();
830 for(; aPartRes != aPartResults.end(); aPartRes++) {
831 ResultPartPtr aPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(*aPartRes);
832 if (aPart && (!theActivatedOnly || aPart->isActivated())) {
833 aResult.insert(aPart->original()->data()->name());
839 std::shared_ptr<Model_Document> Model_Document::subDoc(std::string theDocID)
841 // just store sub-document identifier here to manage it later
842 return std::dynamic_pointer_cast<Model_Document>(
843 Model_Application::getApplication()->getDocument(theDocID));
846 ObjectPtr Model_Document::object(const std::string& theGroupID, const int theIndex)
848 return myObjs->object(theGroupID, theIndex);
851 std::shared_ptr<ModelAPI_Object> Model_Document::objectByName(
852 const std::string& theGroupID, const std::string& theName)
854 return myObjs->objectByName(theGroupID, theName);
857 const int Model_Document::index(std::shared_ptr<ModelAPI_Object> theObject)
859 return myObjs->index(theObject);
862 int Model_Document::size(const std::string& theGroupID)
864 return myObjs->size(theGroupID);
867 std::shared_ptr<ModelAPI_Feature> Model_Document::currentFeature(const bool theVisible)
869 if (!myObjs) // on close document feature destruction it may call this method
870 return std::shared_ptr<ModelAPI_Feature>();
871 TDF_Label aRefLab = generalLabel().FindChild(TAG_CURRENT_FEATURE);
872 Handle(TDF_Reference) aRef;
873 if (aRefLab.FindAttribute(TDF_Reference::GetID(), aRef)) {
874 TDF_Label aLab = aRef->Get();
875 FeaturePtr aResult = myObjs->feature(aLab);
876 if (theVisible) { // get nearest visible (in history) going up
877 while(aResult.get() && !aResult->isInHistory()) {
878 aResult = myObjs->nextFeature(aResult, true);
883 return std::shared_ptr<ModelAPI_Feature>(); // null feature means the higher than first
886 void Model_Document::setCurrentFeature(
887 std::shared_ptr<ModelAPI_Feature> theCurrent, const bool theVisible)
889 // blocks the flush signals to avoid each objects visualization in the viewer
890 // they should not be shown once after all modifications are performed
891 Events_Loop* aLoop = Events_Loop::loop();
892 bool isActive = aLoop->activateFlushes(false);
894 TDF_Label aRefLab = generalLabel().FindChild(TAG_CURRENT_FEATURE);
895 CompositeFeaturePtr aMain; // main feature that may nest the new current
896 std::set<FeaturePtr> anOwners; // composites that contain theCurrent (with any level of nesting)
897 if (theCurrent.get()) {
898 aMain = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(theCurrent);
899 CompositeFeaturePtr anOwner = ModelAPI_Tools::compositeOwner(theCurrent);
900 while(anOwner.get()) {
904 anOwners.insert(anOwner);
905 anOwner = ModelAPI_Tools::compositeOwner(anOwner);
909 if (theVisible) { // make features below which are not in history also enabled: sketch subs
911 theCurrent.get() ? myObjs->nextFeature(theCurrent) : myObjs->firstFeature();
912 for (; aNext.get(); aNext = myObjs->nextFeature(theCurrent)) {
913 if (aNext->isInHistory()) {
914 break; // next in history is not needed
915 } else { // next not in history is good for making current
920 if (theCurrent.get()) {
921 std::shared_ptr<Model_Data> aData = std::static_pointer_cast<Model_Data>(theCurrent->data());
922 if (!aData.get() || !aData->isValid()) {
923 aLoop->activateFlushes(isActive);
926 TDF_Label aFeatureLabel = aData->label().Father();
928 Handle(TDF_Reference) aRef;
929 if (aRefLab.FindAttribute(TDF_Reference::GetID(), aRef)) {
930 aRef->Set(aFeatureLabel);
932 aRef = TDF_Reference::Set(aRefLab, aFeatureLabel);
934 } else { // remove reference for the null feature
935 aRefLab.ForgetAttribute(TDF_Reference::GetID());
937 // make all features after this feature disabled in reversed order (to remove results without deps)
938 static Events_ID aRedispEvent = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
939 static Events_ID aCreateEvent = Events_Loop::eventByName(EVENT_OBJECT_CREATED);
940 static Events_ID aDeleteEvent = aLoop->eventByName(EVENT_OBJECT_DELETED);
942 bool aPassed = false; // flag that the current object is already passed in cycle
943 FeaturePtr anIter = myObjs->lastFeature();
944 bool aWasChanged = false;
945 for(; anIter.get(); anIter = myObjs->nextFeature(anIter, true)) {
946 // check this before passed become enabled: the current feature is enabled!
947 if (anIter == theCurrent) aPassed = true;
949 bool aDisabledFlag = !aPassed;
951 if (aMain->isSub(anIter)) // sub-elements of not-disabled feature are not disabled
952 aDisabledFlag = false;
953 else if (anOwners.find(anIter) != anOwners.end()) // disable the higher-level feature is the nested is the current
954 aDisabledFlag = true;
957 if (anIter->getKind() == "Parameter") {// parameters are always out of the history of features, but not parameters
958 if (theCurrent.get() && theCurrent->getKind() != "Parameter")
959 aDisabledFlag = false;
961 if (anIter->setDisabled(aDisabledFlag)) {
962 // state of feature is changed => so feature become updated
963 static Events_ID anUpdateEvent = aLoop->eventByName(EVENT_OBJECT_UPDATED);
964 ModelAPI_EventCreator::get()->sendUpdated(anIter, anUpdateEvent);
965 // flush is in the end of this method
966 ModelAPI_EventCreator::get()->sendUpdated(anIter, aRedispEvent /*, false*/);
969 // update for everyone the concealment flag immideately: on edit feature in the midle of history
971 const std::list<std::shared_ptr<ModelAPI_Result> >& aResList = anIter->results();
972 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRes = aResList.begin();
973 for(; aRes != aResList.end(); aRes++) {
974 if ((*aRes).get() && (*aRes)->data()->isValid() && !(*aRes)->isDisabled())
975 std::dynamic_pointer_cast<Model_Data>((*aRes)->data())->updateConcealmentFlag();
980 // unblock the flush signals and up them after this
981 aLoop->activateFlushes(isActive);
984 void Model_Document::setCurrentFeatureUp()
986 // on remove just go up for minimum step: highlight external objects in sketch causes
987 // problems if it is true: here and in "setCurrentFeature"
988 FeaturePtr aCurrent = currentFeature(false);
989 if (aCurrent.get()) { // if not, do nothing because null is the upper
990 FeaturePtr aPrev = myObjs->nextFeature(aCurrent, true);
991 // do not flush: it is called only on remove, it will be flushed in the end of transaction
992 setCurrentFeature(aPrev, false);
996 TDF_Label Model_Document::generalLabel() const
998 return myDoc->Main().FindChild(TAG_GENERAL);
1001 std::shared_ptr<ModelAPI_ResultConstruction> Model_Document::createConstruction(
1002 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1004 return myObjs->createConstruction(theFeatureData, theIndex);
1007 std::shared_ptr<ModelAPI_ResultBody> Model_Document::createBody(
1008 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1010 return myObjs->createBody(theFeatureData, theIndex);
1013 std::shared_ptr<ModelAPI_ResultPart> Model_Document::createPart(
1014 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1016 return myObjs->createPart(theFeatureData, theIndex);
1019 std::shared_ptr<ModelAPI_ResultPart> Model_Document::copyPart(
1020 const std::shared_ptr<ModelAPI_ResultPart>& theOrigin,
1021 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1023 return myObjs->copyPart(theOrigin, theFeatureData, theIndex);
1026 std::shared_ptr<ModelAPI_ResultGroup> Model_Document::createGroup(
1027 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1029 return myObjs->createGroup(theFeatureData, theIndex);
1032 std::shared_ptr<ModelAPI_ResultParameter> Model_Document::createParameter(
1033 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1035 return myObjs->createParameter(theFeatureData, theIndex);
1038 std::shared_ptr<ModelAPI_Feature> Model_Document::feature(
1039 const std::shared_ptr<ModelAPI_Result>& theResult)
1041 return myObjs->feature(theResult);
1044 Standard_Integer HashCode(const TDF_Label& theLab, const Standard_Integer theUpper)
1046 return TDF_LabelMapHasher::HashCode(theLab, theUpper);
1049 Standard_Boolean IsEqual(const TDF_Label& theLab1, const TDF_Label& theLab2)
1051 return TDF_LabelMapHasher::IsEqual(theLab1, theLab2);
1054 void Model_Document::addNamingName(const TDF_Label theLabel, std::string theName)
1056 myNamingNames[theName] = theLabel;
1059 TDF_Label Model_Document::findNamingName(std::string theName)
1061 std::map<std::string, TDF_Label>::iterator aFind = myNamingNames.find(theName);
1062 if (aFind == myNamingNames.end())
1063 return TDF_Label(); // not found
1064 return aFind->second;
1067 ResultPtr Model_Document::findByName(const std::string theName)
1069 return myObjs->findByName(theName);
1072 std::list<std::shared_ptr<ModelAPI_Feature> > Model_Document::allFeatures()
1074 return myObjs->allFeatures();
1077 void Model_Document::setActive(const bool theFlag)
1079 if (theFlag != myIsActive) {
1080 myIsActive = theFlag;
1081 // redisplay all the objects of this part
1082 static Events_Loop* aLoop = Events_Loop::loop();
1083 static Events_ID aRedispEvent = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
1085 for(int a = size(ModelAPI_Feature::group()) - 1; a >= 0; a--) {
1086 FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(
1087 object(ModelAPI_Feature::group(), a));
1088 if (aFeature.get() && aFeature->data()->isValid()) {
1089 const std::list<std::shared_ptr<ModelAPI_Result> >& aResList = aFeature->results();
1090 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRes = aResList.begin();
1091 for(; aRes != aResList.end(); aRes++) {
1092 ModelAPI_EventCreator::get()->sendUpdated(*aRes, aRedispEvent);
1093 // #issue 1048: sub-compsolids also
1094 ResultCompSolidPtr aCompRes = std::dynamic_pointer_cast<ModelAPI_ResultCompSolid>(*aRes);
1095 if (aCompRes.get()) {
1096 int aNumSubs = aCompRes->numberOfSubs();
1097 for(int a = 0; a < aNumSubs; a++) {
1098 ResultPtr aSub = aCompRes->subResult(a);
1100 ModelAPI_EventCreator::get()->sendUpdated(aSub, aRedispEvent);
1110 bool Model_Document::isActive() const
1115 int Model_Document::transactionID()
1117 Handle(TDataStd_Integer) anIndex;
1118 if (!generalLabel().FindChild(TAG_CURRENT_TRANSACTION).
1119 FindAttribute(TDataStd_Integer::GetID(), anIndex)) {
1120 anIndex = TDataStd_Integer::Set(generalLabel().FindChild(TAG_CURRENT_TRANSACTION), 1);
1122 return anIndex->Get();
1125 void Model_Document::incrementTransactionID()
1127 int aNewVal = transactionID() + 1;
1128 TDataStd_Integer::Set(generalLabel().FindChild(TAG_CURRENT_TRANSACTION), aNewVal);
1130 void Model_Document::decrementTransactionID()
1132 int aNewVal = transactionID() - 1;
1133 TDataStd_Integer::Set(generalLabel().FindChild(TAG_CURRENT_TRANSACTION), aNewVal);
1136 bool Model_Document::isOpened()
1138 return myObjs && !myDoc.IsNull();
1141 int Model_Document::numInternalFeatures()
1143 return myObjs->numInternalFeatures();
1146 std::shared_ptr<ModelAPI_Feature> Model_Document::internalFeature(const int theIndex)
1148 return myObjs->internalFeature(theIndex);
1151 void Model_Document::synchronizeTransactions()
1153 Model_Document* aRoot =
1154 std::dynamic_pointer_cast<Model_Document>(ModelAPI_Session::get()->moduleDocument()).get();
1156 return; // don't need to synchronise root with root
1158 std::shared_ptr<Model_Session> aSession =
1159 std::dynamic_pointer_cast<Model_Session>(Model_Session::get());
1160 while(myRedos.size() > aRoot->myRedos.size()) { // remove redos in this
1161 aSession->setCheckTransactions(false);
1163 aSession->setCheckTransactions(true);
1165 /* this case can not be reproduced in any known case for the current moment, so, just comment
1166 while(myRedos.size() < aRoot->myRedos.size()) { // add more redos in this
1167 undoInternal(false, true);
1171 /// Feature that is used for selection in the Part document by the external request
1172 class Model_SelectionInPartFeature : public ModelAPI_Feature {
1174 /// Nothing to do in constructor
1175 Model_SelectionInPartFeature() : ModelAPI_Feature() {}
1177 /// Returns the unique kind of a feature
1178 virtual const std::string& getKind() {
1179 static std::string MY_KIND("InternalSelectionInPartFeature");
1182 /// Request for initialization of data model of the object: adding all attributes
1183 virtual void initAttributes() {
1184 data()->addAttribute("selection", ModelAPI_AttributeSelectionList::typeId());
1186 /// Nothing to do in the execution function
1187 virtual void execute() {}
1191 //! Returns the feature that is used for calculation of selection externally from the document
1192 AttributeSelectionListPtr Model_Document::selectionInPartFeature()
1194 // return already created, otherwise create
1195 if (!mySelectionFeature.get() || !mySelectionFeature->data()->isValid()) {
1197 mySelectionFeature = FeaturePtr(new Model_SelectionInPartFeature);
1199 TDF_Label aFeatureLab = generalLabel().FindChild(TAG_SELECTION_FEATURE);
1200 std::shared_ptr<Model_Data> aData(new Model_Data);
1201 aData->setLabel(aFeatureLab.FindChild(1));
1202 aData->setObject(mySelectionFeature);
1203 mySelectionFeature->setDoc(myObjs->owner());
1204 mySelectionFeature->setData(aData);
1205 std::string aName = id() + "_Part";
1206 mySelectionFeature->data()->setName(aName);
1207 mySelectionFeature->setDoc(myObjs->owner());
1208 mySelectionFeature->initAttributes();
1210 return mySelectionFeature->selectionList("selection");
1213 FeaturePtr Model_Document::lastFeature()
1216 return myObjs->lastFeature();
1217 return FeaturePtr();