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 Handle(TDF_DeltaOnAddition) anAddition = Handle(TDF_DeltaOnAddition)::DownCast(anADelta);
442 if (anAddition.IsNull()) { // if the attribute was added, transaction is not empty
443 if (!anADelta->Label().IsNull() && !anADelta->Attribute().IsNull()) {
444 Handle(TDF_Attribute) aCurrentAttr;
445 if (anADelta->Label().FindAttribute(anADelta->Attribute()->ID(), aCurrentAttr)) {
446 if (isEqualContent(anADelta->Attribute(), aCurrentAttr)) {
447 continue; // attribute is not changed actually
449 } else if (Standard_GUID::IsEqual(anADelta->Attribute()->ID(), TDataStd_AsciiString::GetID())) {
450 continue; // error message is disappeared
459 bool Model_Document::finishOperation()
461 bool isNestedClosed = !myDoc->HasOpenCommand() && !myNestedNum.empty();
462 static std::shared_ptr<Model_Session> aSession =
463 std::static_pointer_cast<Model_Session>(Model_Session::get());
464 // do it before flashes to enable and recompute nesting features correctly
465 if (myNestedNum.empty() || (isNestedClosed && myNestedNum.size() == 1)) {
466 // if all nested operations are closed, make current the higher level objects (to perform
467 // it in the python scripts correctly): sketch become current after creation ofsub-elements
468 FeaturePtr aCurrent = currentFeature(false);
469 CompositeFeaturePtr aMain, aNext = ModelAPI_Tools::compositeOwner(aCurrent);
472 aNext = ModelAPI_Tools::compositeOwner(aMain);
474 if (aMain.get() && aMain != aCurrent)
475 setCurrentFeature(aMain, false);
477 myObjs->synchronizeBackRefs();
478 Events_Loop* aLoop = Events_Loop::loop();
479 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_CREATED));
480 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_UPDATED));
481 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_TO_REDISPLAY));
482 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_DELETED));
483 // this must be here just after everything is finished but before real transaction stop
484 // to avoid messages about modifications outside of the transaction
485 // and to rebuild everything after all updates and creates
486 if (isRoot()) { // once for root document
487 Events_Loop::loop()->autoFlush(Events_Loop::eventByName(EVENT_OBJECT_UPDATED));
488 static std::shared_ptr<Events_Message> aFinishMsg
489 (new Events_Message(Events_Loop::eventByName("FinishOperation")));
490 Events_Loop::loop()->send(aFinishMsg);
491 Events_Loop::loop()->autoFlush(Events_Loop::eventByName(EVENT_OBJECT_UPDATED), false);
493 // to avoid "updated" message appearance by updater
494 //aLoop->clear(Events_Loop::eventByName(EVENT_OBJECT_UPDATED));
496 // finish for all subs first: to avoid nested finishing and "isOperation" calls problems inside
497 bool aResult = false;
498 const std::set<std::string> aSubs = subDocuments(true);
499 std::set<std::string>::iterator aSubIter = aSubs.begin();
500 for (; aSubIter != aSubs.end(); aSubIter++)
501 if (subDoc(*aSubIter)->finishOperation())
504 // transaction may be empty if this document was created during this transaction (create part)
505 if (!myTransactions.empty() && myDoc->CommitCommand()) { // if commit is successfull, just increment counters
506 if (isEmptyTransaction(myDoc)) { // erase this transaction
510 myTransactions.rbegin()->myOCAFNum++;
515 if (isNestedClosed) {
518 if (!aResult && !myTransactions.empty() /* it can be for just created part document */)
519 aResult = myTransactions.rbegin()->myOCAFNum != 0;
521 if (!aResult && isRoot()) {
522 // nothing inside in all documents, so remove this transaction from the transactions list
523 undoInternal(true, false);
525 // on finish clear redos in any case (issue 446) and for all subs (issue 408)
528 for (aSubIter = aSubs.begin(); aSubIter != aSubs.end(); aSubIter++) {
529 subDoc(*aSubIter)->myDoc->ClearRedos();
530 subDoc(*aSubIter)->myRedos.clear();
536 /// Returns in theDelta labels that has been modified in the latest transaction of theDoc
537 static void modifiedLabels(const Handle(TDocStd_Document)& theDoc, TDF_LabelList& theDelta,
538 const bool isRedo = false) {
539 Handle(TDF_Delta) aDelta;
541 aDelta = theDoc->GetRedos().First();
543 aDelta = theDoc->GetUndos().Last();
544 TDF_LabelList aDeltaList;
545 aDelta->Labels(aDeltaList); // it clears list, so, use new one and then append to the result
546 for(TDF_ListIteratorOfLabelList aListIter(aDeltaList); aListIter.More(); aListIter.Next()) {
547 theDelta.Append(aListIter.Value());
549 // add also label of the modified attributes
550 const TDF_AttributeDeltaList& anAttrs = aDelta->AttributeDeltas();
551 for (TDF_ListIteratorOfAttributeDeltaList anAttr(anAttrs); anAttr.More(); anAttr.Next()) {
552 theDelta.Append(anAttr.Value()->Label());
556 void Model_Document::abortOperation()
558 TDF_LabelList aDeltaLabels; // labels that are updated during "abort"
559 if (!myNestedNum.empty() && !myDoc->HasOpenCommand()) { // abort all what was done in nested
561 // store undo-delta here as undo actually does in the method later
562 int a, aNumTransactions = myTransactions.rbegin()->myOCAFNum;
563 for(a = 0; a < aNumTransactions; a++) {
564 modifiedLabels(myDoc, aDeltaLabels);
567 for(a = 0; a < aNumTransactions; a++) {
571 undoInternal(false, false);
574 } else { // abort the current
575 int aNumTransactions = myTransactions.rbegin()->myOCAFNum;
576 myTransactions.pop_back();
577 if (!myNestedNum.empty())
578 (*myNestedNum.rbegin())--;
579 // roll back the needed number of transactions
580 // make commit/undo to get the modification delta
581 //myDoc->AbortCommand();
582 if (myDoc->CommitCommand()) {
583 modifiedLabels(myDoc, aDeltaLabels);
586 for(int a = 0; a < aNumTransactions; a++) {
587 modifiedLabels(myDoc, aDeltaLabels);
592 // abort for all subs, flushes will be later, in the end of root abort
593 const std::set<std::string> aSubs = subDocuments(true);
594 std::set<std::string>::iterator aSubIter = aSubs.begin();
595 for (; aSubIter != aSubs.end(); aSubIter++)
596 subDoc(*aSubIter)->abortOperation();
597 // references may be changed because they are set in attributes on the fly
598 myObjs->synchronizeFeatures(aDeltaLabels, true, isRoot());
601 bool Model_Document::isOperation() const
603 // operation is opened for all documents: no need to check subs
604 return myDoc->HasOpenCommand() == Standard_True ;
607 bool Model_Document::isModified()
609 // is modified if at least one operation was commited and not undoed
610 return myTransactions.size() != myTransactionSave || isOperation();
613 bool Model_Document::canUndo()
615 // issue 406 : if transaction is opened, but nothing to undo behind, can not undo
616 int aCurrentNum = isOperation() ? 1 : 0;
617 if (myDoc->GetAvailableUndos() > 0 &&
618 (myNestedNum.empty() || *myNestedNum.rbegin() - aCurrentNum > 0) && // there is something to undo in nested
619 myTransactions.size() - aCurrentNum > 0 /* for omitting the first useless transaction */)
621 // check other subs contains operation that can be undoed
622 const std::set<std::string> aSubs = subDocuments(true);
623 std::set<std::string>::iterator aSubIter = aSubs.begin();
624 for (; aSubIter != aSubs.end(); aSubIter++) {
625 std::shared_ptr<Model_Document> aSub = subDoc(*aSubIter);
626 if (aSub->myObjs) {// if it was not closed before
635 void Model_Document::undoInternal(const bool theWithSubs, const bool theSynchronize)
637 int aNumTransactions = myTransactions.rbegin()->myOCAFNum;
638 myRedos.push_back(*myTransactions.rbegin());
639 myTransactions.pop_back();
640 if (!myNestedNum.empty())
641 (*myNestedNum.rbegin())--;
642 // roll back the needed number of transactions
643 TDF_LabelList aDeltaLabels;
644 for(int a = 0; a < aNumTransactions; a++) {
646 modifiedLabels(myDoc, aDeltaLabels);
652 const std::set<std::string> aSubs = subDocuments(true);
653 std::set<std::string>::iterator aSubIter = aSubs.begin();
654 for (; aSubIter != aSubs.end(); aSubIter++) {
655 if (!subDoc(*aSubIter)->myObjs)
657 subDoc(*aSubIter)->undoInternal(theWithSubs, theSynchronize);
660 // after undo of all sub-documents to avoid updates on not-modified data (issue 370)
661 if (theSynchronize) {
662 myObjs->synchronizeFeatures(aDeltaLabels, true, isRoot());
663 // update the current features status
664 setCurrentFeature(currentFeature(false), false);
668 void Model_Document::undo()
670 undoInternal(true, true);
673 bool Model_Document::canRedo()
675 if (!myRedos.empty())
677 // check other subs contains operation that can be redoed
678 const std::set<std::string> aSubs = subDocuments(true);
679 std::set<std::string>::iterator aSubIter = aSubs.begin();
680 for (; aSubIter != aSubs.end(); aSubIter++) {
681 if (!subDoc(*aSubIter)->myObjs)
683 if (subDoc(*aSubIter)->canRedo())
689 void Model_Document::redo()
691 if (!myNestedNum.empty())
692 (*myNestedNum.rbegin())++;
693 int aNumRedos = myRedos.rbegin()->myOCAFNum;
694 myTransactions.push_back(*myRedos.rbegin());
696 TDF_LabelList aDeltaLabels;
697 for(int a = 0; a < aNumRedos; a++) {
698 modifiedLabels(myDoc, aDeltaLabels, true);
703 const std::set<std::string> aSubs = subDocuments(true);
704 std::set<std::string>::iterator aSubIter = aSubs.begin();
705 for (; aSubIter != aSubs.end(); aSubIter++)
706 subDoc(*aSubIter)->redo();
708 // after redo of all sub-documents to avoid updates on not-modified data (issue 370)
709 myObjs->synchronizeFeatures(aDeltaLabels, true, isRoot());
710 // update the current features status
711 setCurrentFeature(currentFeature(false), false);
714 std::list<std::string> Model_Document::undoList() const
716 std::list<std::string> aResult;
717 // the number of skipped current operations (on undo they will be aborted)
718 int aSkipCurrent = isOperation() ? 1 : 0;
719 std::list<Transaction>::const_reverse_iterator aTrIter = myTransactions.crbegin();
720 int aNumUndo = myTransactions.size();
721 if (!myNestedNum.empty())
722 aNumUndo = *myNestedNum.rbegin();
723 for( ; aNumUndo > 0; aTrIter++, aNumUndo--) {
724 if (aSkipCurrent == 0) aResult.push_back(aTrIter->myId);
730 std::list<std::string> Model_Document::redoList() const
732 std::list<std::string> aResult;
733 std::list<Transaction>::const_reverse_iterator aTrIter = myRedos.crbegin();
734 for( ; aTrIter != myRedos.crend(); aTrIter++) {
735 aResult.push_back(aTrIter->myId);
740 void Model_Document::operationId(const std::string& theId)
742 myTransactions.rbegin()->myId = theId;
745 FeaturePtr Model_Document::addFeature(std::string theID, const bool theMakeCurrent)
747 std::shared_ptr<Model_Session> aSession =
748 std::dynamic_pointer_cast<Model_Session>(ModelAPI_Session::get());
749 FeaturePtr aFeature = aSession->createFeature(theID, this);
753 Model_Document* aDocToAdd;
754 if (!aFeature->documentToAdd().empty()) { // use the customized document to add
755 if (aFeature->documentToAdd() != kind()) { // the root document by default
756 aDocToAdd = std::dynamic_pointer_cast<Model_Document>(aSession->moduleDocument()).get();
760 } else { // if customized is not presented, add to "this" document
764 // searching for feature after which must be added the next feature: this is the current feature
765 // but also all sub-features of this feature
766 FeaturePtr aCurrent = aDocToAdd->currentFeature(false);
767 bool isModified = true;
768 for(CompositeFeaturePtr aComp = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aCurrent);
769 aComp.get() && isModified;
770 aComp = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aCurrent)) {
772 int aSubs = aComp->numberOfSubs(false);
773 for(int a = 0; a < aSubs; a++) {
774 FeaturePtr aSub = aComp->subFeature(a, false);
775 if (myObjs->isLater(aSub, aCurrent)) {
781 aDocToAdd->myObjs->addFeature(aFeature, aCurrent);
782 if (!aFeature->isAction()) { // do not add action to the data model
783 if (theMakeCurrent) // after all this feature stays in the document, so make it current
784 aDocToAdd->setCurrentFeature(aFeature, false);
785 } else { // feature must be executed
786 // no creation event => updater not working, problem with remove part
794 void Model_Document::refsToFeature(FeaturePtr theFeature,
795 std::set<std::shared_ptr<ModelAPI_Feature> >& theRefs, const bool isSendError)
797 myObjs->refsToFeature(theFeature, theRefs, isSendError);
800 void Model_Document::removeFeature(FeaturePtr theFeature)
802 myObjs->removeFeature(theFeature);
805 void Model_Document::moveFeature(FeaturePtr theMoved, FeaturePtr theAfterThis)
807 myObjs->moveFeature(theMoved, theAfterThis);
808 if (theAfterThis == currentFeature(true))
809 setCurrentFeature(theMoved, true);
812 void Model_Document::updateHistory(const std::shared_ptr<ModelAPI_Object> theObject)
814 myObjs->updateHistory(theObject);
817 void Model_Document::updateHistory(const std::string theGroup)
819 myObjs->updateHistory(theGroup);
822 std::shared_ptr<ModelAPI_Document> Model_Document::subDocument(std::string theDocID)
824 return Model_Application::getApplication()->getDocument(theDocID);
827 const std::set<std::string> Model_Document::subDocuments(const bool theActivatedOnly) const
829 std::set<std::string> aResult;
830 std::list<ResultPtr> aPartResults;
831 myObjs->allResults(ModelAPI_ResultPart::group(), aPartResults);
832 std::list<ResultPtr>::iterator aPartRes = aPartResults.begin();
833 for(; aPartRes != aPartResults.end(); aPartRes++) {
834 ResultPartPtr aPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(*aPartRes);
835 if (aPart && (!theActivatedOnly || aPart->isActivated())) {
836 aResult.insert(aPart->original()->data()->name());
842 std::shared_ptr<Model_Document> Model_Document::subDoc(std::string theDocID)
844 // just store sub-document identifier here to manage it later
845 return std::dynamic_pointer_cast<Model_Document>(
846 Model_Application::getApplication()->getDocument(theDocID));
849 ObjectPtr Model_Document::object(const std::string& theGroupID, const int theIndex)
851 return myObjs->object(theGroupID, theIndex);
854 std::shared_ptr<ModelAPI_Object> Model_Document::objectByName(
855 const std::string& theGroupID, const std::string& theName)
857 return myObjs->objectByName(theGroupID, theName);
860 const int Model_Document::index(std::shared_ptr<ModelAPI_Object> theObject)
862 return myObjs->index(theObject);
865 int Model_Document::size(const std::string& theGroupID)
867 return myObjs->size(theGroupID);
870 std::shared_ptr<ModelAPI_Feature> Model_Document::currentFeature(const bool theVisible)
872 if (!myObjs) // on close document feature destruction it may call this method
873 return std::shared_ptr<ModelAPI_Feature>();
874 TDF_Label aRefLab = generalLabel().FindChild(TAG_CURRENT_FEATURE);
875 Handle(TDF_Reference) aRef;
876 if (aRefLab.FindAttribute(TDF_Reference::GetID(), aRef)) {
877 TDF_Label aLab = aRef->Get();
878 FeaturePtr aResult = myObjs->feature(aLab);
879 if (theVisible) { // get nearest visible (in history) going up
880 while(aResult.get() && !aResult->isInHistory()) {
881 aResult = myObjs->nextFeature(aResult, true);
886 return std::shared_ptr<ModelAPI_Feature>(); // null feature means the higher than first
889 void Model_Document::setCurrentFeature(
890 std::shared_ptr<ModelAPI_Feature> theCurrent, const bool theVisible)
892 // blocks the flush signals to avoid each objects visualization in the viewer
893 // they should not be shown once after all modifications are performed
894 Events_Loop* aLoop = Events_Loop::loop();
895 bool isActive = aLoop->activateFlushes(false);
897 TDF_Label aRefLab = generalLabel().FindChild(TAG_CURRENT_FEATURE);
898 CompositeFeaturePtr aMain; // main feature that may nest the new current
899 std::set<FeaturePtr> anOwners; // composites that contain theCurrent (with any level of nesting)
900 if (theCurrent.get()) {
901 aMain = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(theCurrent);
902 CompositeFeaturePtr anOwner = ModelAPI_Tools::compositeOwner(theCurrent);
903 while(anOwner.get()) {
907 anOwners.insert(anOwner);
908 anOwner = ModelAPI_Tools::compositeOwner(anOwner);
912 if (theVisible) { // make features below which are not in history also enabled: sketch subs
914 theCurrent.get() ? myObjs->nextFeature(theCurrent) : myObjs->firstFeature();
915 for (; aNext.get(); aNext = myObjs->nextFeature(theCurrent)) {
916 if (aNext->isInHistory()) {
917 break; // next in history is not needed
918 } else { // next not in history is good for making current
923 if (theCurrent.get()) {
924 std::shared_ptr<Model_Data> aData = std::static_pointer_cast<Model_Data>(theCurrent->data());
925 if (!aData.get() || !aData->isValid()) {
926 aLoop->activateFlushes(isActive);
929 TDF_Label aFeatureLabel = aData->label().Father();
931 Handle(TDF_Reference) aRef;
932 if (aRefLab.FindAttribute(TDF_Reference::GetID(), aRef)) {
933 aRef->Set(aFeatureLabel);
935 aRef = TDF_Reference::Set(aRefLab, aFeatureLabel);
937 } else { // remove reference for the null feature
938 aRefLab.ForgetAttribute(TDF_Reference::GetID());
940 // make all features after this feature disabled in reversed order (to remove results without deps)
941 static Events_ID aRedispEvent = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
942 static Events_ID aCreateEvent = Events_Loop::eventByName(EVENT_OBJECT_CREATED);
943 static Events_ID aDeleteEvent = aLoop->eventByName(EVENT_OBJECT_DELETED);
945 bool aPassed = false; // flag that the current object is already passed in cycle
946 FeaturePtr anIter = myObjs->lastFeature();
947 bool aWasChanged = false;
948 for(; anIter.get(); anIter = myObjs->nextFeature(anIter, true)) {
949 // check this before passed become enabled: the current feature is enabled!
950 if (anIter == theCurrent) aPassed = true;
952 bool aDisabledFlag = !aPassed;
954 if (aMain->isSub(anIter)) // sub-elements of not-disabled feature are not disabled
955 aDisabledFlag = false;
956 else if (anOwners.find(anIter) != anOwners.end()) // disable the higher-level feature is the nested is the current
957 aDisabledFlag = true;
960 if (anIter->getKind() == "Parameter") {// parameters are always out of the history of features, but not parameters
961 if (theCurrent.get() && theCurrent->getKind() != "Parameter")
962 aDisabledFlag = false;
964 if (anIter->setDisabled(aDisabledFlag)) {
965 // state of feature is changed => so feature become updated
966 static Events_ID anUpdateEvent = aLoop->eventByName(EVENT_OBJECT_UPDATED);
967 ModelAPI_EventCreator::get()->sendUpdated(anIter, anUpdateEvent);
968 // flush is in the end of this method
969 ModelAPI_EventCreator::get()->sendUpdated(anIter, aRedispEvent /*, false*/);
972 // update for everyone the concealment flag immideately: on edit feature in the midle of history
974 const std::list<std::shared_ptr<ModelAPI_Result> >& aResList = anIter->results();
975 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRes = aResList.begin();
976 for(; aRes != aResList.end(); aRes++) {
977 if ((*aRes).get() && (*aRes)->data()->isValid() && !(*aRes)->isDisabled())
978 std::dynamic_pointer_cast<Model_Data>((*aRes)->data())->updateConcealmentFlag();
983 // unblock the flush signals and up them after this
984 aLoop->activateFlushes(isActive);
987 void Model_Document::setCurrentFeatureUp()
989 // on remove just go up for minimum step: highlight external objects in sketch causes
990 // problems if it is true: here and in "setCurrentFeature"
991 FeaturePtr aCurrent = currentFeature(false);
992 if (aCurrent.get()) { // if not, do nothing because null is the upper
993 FeaturePtr aPrev = myObjs->nextFeature(aCurrent, true);
994 // do not flush: it is called only on remove, it will be flushed in the end of transaction
995 setCurrentFeature(aPrev, false);
999 TDF_Label Model_Document::generalLabel() const
1001 return myDoc->Main().FindChild(TAG_GENERAL);
1004 std::shared_ptr<ModelAPI_ResultConstruction> Model_Document::createConstruction(
1005 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1007 return myObjs->createConstruction(theFeatureData, theIndex);
1010 std::shared_ptr<ModelAPI_ResultBody> Model_Document::createBody(
1011 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1013 return myObjs->createBody(theFeatureData, theIndex);
1016 std::shared_ptr<ModelAPI_ResultPart> Model_Document::createPart(
1017 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1019 return myObjs->createPart(theFeatureData, theIndex);
1022 std::shared_ptr<ModelAPI_ResultPart> Model_Document::copyPart(
1023 const std::shared_ptr<ModelAPI_ResultPart>& theOrigin,
1024 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1026 return myObjs->copyPart(theOrigin, theFeatureData, theIndex);
1029 std::shared_ptr<ModelAPI_ResultGroup> Model_Document::createGroup(
1030 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1032 return myObjs->createGroup(theFeatureData, theIndex);
1035 std::shared_ptr<ModelAPI_ResultParameter> Model_Document::createParameter(
1036 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1038 return myObjs->createParameter(theFeatureData, theIndex);
1041 std::shared_ptr<ModelAPI_Feature> Model_Document::feature(
1042 const std::shared_ptr<ModelAPI_Result>& theResult)
1044 return myObjs->feature(theResult);
1047 Standard_Integer HashCode(const TDF_Label& theLab, const Standard_Integer theUpper)
1049 return TDF_LabelMapHasher::HashCode(theLab, theUpper);
1052 Standard_Boolean IsEqual(const TDF_Label& theLab1, const TDF_Label& theLab2)
1054 return TDF_LabelMapHasher::IsEqual(theLab1, theLab2);
1057 void Model_Document::addNamingName(const TDF_Label theLabel, std::string theName)
1059 myNamingNames[theName] = theLabel;
1062 TDF_Label Model_Document::findNamingName(std::string theName)
1064 std::map<std::string, TDF_Label>::iterator aFind = myNamingNames.find(theName);
1065 if (aFind == myNamingNames.end())
1066 return TDF_Label(); // not found
1067 return aFind->second;
1070 ResultPtr Model_Document::findByName(const std::string theName)
1072 return myObjs->findByName(theName);
1075 std::list<std::shared_ptr<ModelAPI_Feature> > Model_Document::allFeatures()
1077 return myObjs->allFeatures();
1080 void Model_Document::setActive(const bool theFlag)
1082 if (theFlag != myIsActive) {
1083 myIsActive = theFlag;
1084 // redisplay all the objects of this part
1085 static Events_Loop* aLoop = Events_Loop::loop();
1086 static Events_ID aRedispEvent = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
1088 for(int a = size(ModelAPI_Feature::group()) - 1; a >= 0; a--) {
1089 FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(
1090 object(ModelAPI_Feature::group(), a));
1091 if (aFeature.get() && aFeature->data()->isValid()) {
1092 const std::list<std::shared_ptr<ModelAPI_Result> >& aResList = aFeature->results();
1093 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRes = aResList.begin();
1094 for(; aRes != aResList.end(); aRes++) {
1095 ModelAPI_EventCreator::get()->sendUpdated(*aRes, aRedispEvent);
1096 // #issue 1048: sub-compsolids also
1097 ResultCompSolidPtr aCompRes = std::dynamic_pointer_cast<ModelAPI_ResultCompSolid>(*aRes);
1098 if (aCompRes.get()) {
1099 int aNumSubs = aCompRes->numberOfSubs();
1100 for(int a = 0; a < aNumSubs; a++) {
1101 ResultPtr aSub = aCompRes->subResult(a);
1103 ModelAPI_EventCreator::get()->sendUpdated(aSub, aRedispEvent);
1113 bool Model_Document::isActive() const
1118 int Model_Document::transactionID()
1120 Handle(TDataStd_Integer) anIndex;
1121 if (!generalLabel().FindChild(TAG_CURRENT_TRANSACTION).
1122 FindAttribute(TDataStd_Integer::GetID(), anIndex)) {
1123 anIndex = TDataStd_Integer::Set(generalLabel().FindChild(TAG_CURRENT_TRANSACTION), 1);
1125 return anIndex->Get();
1128 void Model_Document::incrementTransactionID()
1130 int aNewVal = transactionID() + 1;
1131 TDataStd_Integer::Set(generalLabel().FindChild(TAG_CURRENT_TRANSACTION), aNewVal);
1133 void Model_Document::decrementTransactionID()
1135 int aNewVal = transactionID() - 1;
1136 TDataStd_Integer::Set(generalLabel().FindChild(TAG_CURRENT_TRANSACTION), aNewVal);
1139 bool Model_Document::isOpened()
1141 return myObjs && !myDoc.IsNull();
1144 int Model_Document::numInternalFeatures()
1146 return myObjs->numInternalFeatures();
1149 std::shared_ptr<ModelAPI_Feature> Model_Document::internalFeature(const int theIndex)
1151 return myObjs->internalFeature(theIndex);
1154 void Model_Document::synchronizeTransactions()
1156 Model_Document* aRoot =
1157 std::dynamic_pointer_cast<Model_Document>(ModelAPI_Session::get()->moduleDocument()).get();
1159 return; // don't need to synchronise root with root
1161 std::shared_ptr<Model_Session> aSession =
1162 std::dynamic_pointer_cast<Model_Session>(Model_Session::get());
1163 while(myRedos.size() > aRoot->myRedos.size()) { // remove redos in this
1164 aSession->setCheckTransactions(false);
1166 aSession->setCheckTransactions(true);
1168 /* this case can not be reproduced in any known case for the current moment, so, just comment
1169 while(myRedos.size() < aRoot->myRedos.size()) { // add more redos in this
1170 undoInternal(false, true);
1174 /// Feature that is used for selection in the Part document by the external request
1175 class Model_SelectionInPartFeature : public ModelAPI_Feature {
1177 /// Nothing to do in constructor
1178 Model_SelectionInPartFeature() : ModelAPI_Feature() {}
1180 /// Returns the unique kind of a feature
1181 virtual const std::string& getKind() {
1182 static std::string MY_KIND("InternalSelectionInPartFeature");
1185 /// Request for initialization of data model of the object: adding all attributes
1186 virtual void initAttributes() {
1187 data()->addAttribute("selection", ModelAPI_AttributeSelectionList::typeId());
1189 /// Nothing to do in the execution function
1190 virtual void execute() {}
1194 //! Returns the feature that is used for calculation of selection externally from the document
1195 AttributeSelectionListPtr Model_Document::selectionInPartFeature()
1197 // return already created, otherwise create
1198 if (!mySelectionFeature.get() || !mySelectionFeature->data()->isValid()) {
1200 mySelectionFeature = FeaturePtr(new Model_SelectionInPartFeature);
1202 TDF_Label aFeatureLab = generalLabel().FindChild(TAG_SELECTION_FEATURE);
1203 std::shared_ptr<Model_Data> aData(new Model_Data);
1204 aData->setLabel(aFeatureLab.FindChild(1));
1205 aData->setObject(mySelectionFeature);
1206 mySelectionFeature->setDoc(myObjs->owner());
1207 mySelectionFeature->setData(aData);
1208 std::string aName = id() + "_Part";
1209 mySelectionFeature->data()->setName(aName);
1210 mySelectionFeature->setDoc(myObjs->owner());
1211 mySelectionFeature->initAttributes();
1213 return mySelectionFeature->selectionList("selection");
1216 FeaturePtr Model_Document::lastFeature()
1219 return myObjs->lastFeature();
1220 return FeaturePtr();