1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: Model_Session.cxx
4 // Created: 20 Mar 2014
5 // Author: Mikhail PONIKAROV
7 #include <Model_Session.h>
8 #include <ModelAPI_Feature.h>
9 #include <ModelAPI_Plugin.h>
10 #include <Model_Data.h>
11 #include <Model_Document.h>
12 #include <Model_Objects.h>
13 #include <Model_Application.h>
14 #include <Model_Events.h>
15 #include <Model_Validator.h>
16 #include <ModelAPI_Events.h>
17 #include <Events_Loop.h>
18 #include <Events_Error.h>
19 #include <Config_FeatureMessage.h>
20 #include <Config_AttributeMessage.h>
21 #include <Config_ValidatorMessage.h>
22 #include <Config_ModuleReader.h>
23 #include <Config_ValidatorReader.h>
24 #include <ModelAPI_ResultPart.h>
25 #include <ModelAPI_Tools.h>
27 #include <TDF_CopyTool.hxx>
28 #include <TDF_DataSet.hxx>
29 #include <TDF_RelocationTable.hxx>
30 #include <TDF_ClosureTool.hxx>
34 static Model_Session* myImpl = new Model_Session();
36 // t oredirect all calls to the root document
37 #define ROOT_DOC std::dynamic_pointer_cast<Model_Document>(moduleDocument())
39 bool Model_Session::load(const char* theFileName)
41 bool aRes = ROOT_DOC->load(theFileName, ROOT_DOC);
45 bool Model_Session::save(const char* theFileName, std::list<std::string>& theResults)
47 return ROOT_DOC->save(theFileName, theResults);
50 void Model_Session::closeAll()
52 Model_Application::getApplication()->deleteAllDocuments();
55 void Model_Session::startOperation(const std::string& theId)
57 ROOT_DOC->startOperation();
58 ROOT_DOC->operationId(theId);
59 static std::shared_ptr<Events_Message> aStartedMsg
60 (new Events_Message(Events_Loop::eventByName("StartOperation")));
61 Events_Loop::loop()->send(aStartedMsg);
62 // remove all useless documents that has been closed: on start of operation undo/redo is cleared
63 std::list<std::shared_ptr<ModelAPI_Document> > aUsedDocs = allOpenedDocuments();
64 Model_Application::getApplication()->removeUselessDocuments(aUsedDocs);
67 void Model_Session::finishOperation()
69 setCheckTransactions(false);
70 ROOT_DOC->finishOperation();
71 setCheckTransactions(true);
74 void Model_Session::abortOperation()
76 setCheckTransactions(false);
77 ROOT_DOC->abortOperation();
78 setCheckTransactions(true);
79 // here the update mechanism may work after abort, so, supress the warnings about
80 // modifications outside of the transactions
81 bool aWasCheck = myCheckTransactions;
82 myCheckTransactions = false;
83 static std::shared_ptr<Events_Message> anAbortMsg
84 (new Events_Message(Events_Loop::eventByName("AbortOperation")));
85 Events_Loop::loop()->send(anAbortMsg);
86 myCheckTransactions = true;
87 myCheckTransactions = aWasCheck;
90 bool Model_Session::isOperation()
92 return ROOT_DOC->isOperation();
95 bool Model_Session::isModified()
97 return ROOT_DOC->isModified();
100 bool Model_Session::canUndo()
102 return ROOT_DOC->canUndo();
105 void Model_Session::undo()
107 setCheckTransactions(false);
109 setCheckTransactions(true);
112 bool Model_Session::canRedo()
114 return ROOT_DOC->canRedo();
117 void Model_Session::redo()
119 setCheckTransactions(false);
121 setCheckTransactions(true);
124 //! Returns stack of performed operations
125 std::list<std::string> Model_Session::undoList()
127 return ROOT_DOC->undoList();
129 //! Returns stack of rolled back operations
130 std::list<std::string> Model_Session::redoList()
132 return ROOT_DOC->redoList();
135 FeaturePtr Model_Session::createFeature(string theFeatureID, Model_Document* theDocOwner)
137 if (this != myImpl) {
138 return myImpl->createFeature(theFeatureID, theDocOwner);
141 // load all information about plugins, features and attributes
144 if (myPlugins.find(theFeatureID) != myPlugins.end()) {
145 std::pair<std::string, std::string>& aPlugin = myPlugins[theFeatureID]; // plugin and doc kind
146 if (!aPlugin.second.empty() && aPlugin.second != theDocOwner->kind()) {
148 string("Feature '") + theFeatureID + "' can be created only in document '"
149 + aPlugin.second + "' by the XML definition");
152 myCurrentPluginName = aPlugin.first;
153 if (myPluginObjs.find(myCurrentPluginName) == myPluginObjs.end()) {
154 // load plugin library if not yet done
155 Config_ModuleReader::loadPlugin(myCurrentPluginName);
157 if (myPluginObjs.find(myCurrentPluginName) != myPluginObjs.end()) {
158 FeaturePtr aCreated = myPluginObjs[myCurrentPluginName]->createFeature(theFeatureID);
161 string("Can not initialize feature '") + theFeatureID + "' in plugin '"
162 + myCurrentPluginName + "'");
166 Events_Error::send(string("Can not load plugin '") + myCurrentPluginName + "'");
169 Events_Error::send(string("Feature '") + theFeatureID + "' not found in any plugin");
172 return FeaturePtr(); // return nothing
175 std::shared_ptr<ModelAPI_Document> Model_Session::moduleDocument()
177 bool aFirstCall = !Model_Application::getApplication()->hasDocument("root");
179 // creation of the root document is always outside of the transaction, so, avoid checking it
180 setCheckTransactions(false);
182 std::shared_ptr<ModelAPI_Document> aDoc = std::shared_ptr<ModelAPI_Document>(
183 Model_Application::getApplication()->getDocument("root"));
185 // creation of the root document is always outside of the transaction, so, avoid checking it
186 setCheckTransactions(true);
191 std::shared_ptr<ModelAPI_Document> Model_Session::document(std::string theDocID)
193 return std::shared_ptr<ModelAPI_Document>(
194 Model_Application::getApplication()->getDocument(theDocID));
197 bool Model_Session::hasModuleDocument()
199 return Model_Application::getApplication()->hasDocument("root");
202 std::shared_ptr<ModelAPI_Document> Model_Session::activeDocument()
204 if (!myCurrentDoc || !Model_Application::getApplication()->hasDocument(myCurrentDoc->id()))
205 myCurrentDoc = moduleDocument();
209 /// makes the last feature in the document as the current
210 static void makeCurrentLast(std::shared_ptr<ModelAPI_Document> theDoc) {
212 FeaturePtr aLastFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(theDoc->object(
213 ModelAPI_Feature::group(), theDoc->size(ModelAPI_Feature::group()) - 1));
214 theDoc->setCurrentFeature(aLastFeature, false);
218 void Model_Session::setActiveDocument(
219 std::shared_ptr<ModelAPI_Document> theDoc, bool theSendSignal)
221 if (myCurrentDoc != theDoc) {
222 std::shared_ptr<ModelAPI_Document> aPrevious = myCurrentDoc;
223 myCurrentDoc = theDoc;
224 if (theDoc.get() && theSendSignal) {
225 // syncronize the document: it may be just opened or opened but removed before
226 std::shared_ptr<Model_Document> aDoc = std::dynamic_pointer_cast<Model_Document>(theDoc);
228 bool aWasChecked = myCheckTransactions;
229 setCheckTransactions(false);
230 aDoc->objects()->synchronizeFeatures(false, true, true);
232 setCheckTransactions(true);
234 static std::shared_ptr<Events_Message> aMsg(
235 new Events_Message(Events_Loop::eventByName(EVENT_DOCUMENT_CHANGED)));
236 Events_Loop::loop()->send(aMsg);
238 // make the current state correct and synchronised in the module and sub-documents
239 if (isOperation()) { // do it only in transaction, not on opening of document
240 if (myCurrentDoc == moduleDocument()) {
241 // make the current feature the latest in root, in previous root current become also last
242 makeCurrentLast(aPrevious);
243 makeCurrentLast(myCurrentDoc);
245 // make the current feature the latest in sub, root current feature becomes this sub
246 makeCurrentLast(myCurrentDoc);
247 DocumentPtr aRoot = moduleDocument();
248 ResultPtr aPartRes = ModelAPI_Tools::findPartResult(aRoot, myCurrentDoc);
249 if (aPartRes.get()) {
250 FeaturePtr aPartFeat = aRoot->feature(aPartRes);
251 if (aPartFeat.get()) {
252 aRoot->setCurrentFeature(aPartFeat, false);
260 std::list<std::shared_ptr<ModelAPI_Document> > Model_Session::allOpenedDocuments()
262 list<std::shared_ptr<ModelAPI_Document> > aResult;
263 aResult.push_back(moduleDocument());
264 // add subs recursively
265 list<std::shared_ptr<ModelAPI_Document> >::iterator aDoc = aResult.begin();
266 for(; aDoc != aResult.end(); aDoc++) {
267 DocumentPtr anAPIDoc = *aDoc;
268 std::shared_ptr<Model_Document> aDoc = std::dynamic_pointer_cast<Model_Document>(anAPIDoc);
270 const std::set<std::string> aSubs = aDoc->subDocuments(true);
271 std::set<std::string>::const_iterator aSubIter = aSubs.cbegin();
272 for(; aSubIter != aSubs.cend(); aSubIter++) {
273 if (!Model_Application::getApplication()->isLoadByDemand(*aSubIter)) {
274 aResult.push_back(Model_Application::getApplication()->getDocument(*aSubIter));
282 bool Model_Session::isLoadByDemand(const std::string theDocID)
284 return Model_Application::getApplication()->isLoadByDemand(theDocID);
287 std::shared_ptr<ModelAPI_Document> Model_Session::copy(
288 std::shared_ptr<ModelAPI_Document> theSource, std::string theID)
290 // create a new document
291 std::shared_ptr<Model_Document> aNew = std::dynamic_pointer_cast<Model_Document>(
292 Model_Application::getApplication()->getDocument(theID));
293 // make a copy of all labels
294 TDF_Label aSourceRoot = std::dynamic_pointer_cast<Model_Document>(theSource)->document()->Main()
296 TDF_Label aTargetRoot = aNew->document()->Main().Father();
297 Handle(TDF_DataSet) aDS = new TDF_DataSet;
298 aDS->AddLabel(aSourceRoot);
299 TDF_ClosureTool::Closure(aDS);
300 Handle(TDF_RelocationTable) aRT = new TDF_RelocationTable;
301 aRT->SetRelocation(aSourceRoot, aTargetRoot);
302 TDF_CopyTool::Copy(aDS, aRT);
304 aNew->objects()->synchronizeFeatures(false, true, true);
308 Model_Session::Model_Session()
310 myPluginsInfoLoaded = false;
311 myCheckTransactions = true;
312 ModelAPI_Session::setSession(std::shared_ptr<ModelAPI_Session>(this));
313 // register the configuration reading listener
314 Events_Loop* aLoop = Events_Loop::loop();
315 static const Events_ID kFeatureEvent =
316 Events_Loop::eventByName(Config_FeatureMessage::MODEL_EVENT());
317 aLoop->registerListener(this, kFeatureEvent);
318 aLoop->registerListener(this, Events_Loop::eventByName(EVENT_OBJECT_CREATED), 0, true);
319 aLoop->registerListener(this, Events_Loop::eventByName(EVENT_OBJECT_UPDATED), 0, true);
320 aLoop->registerListener(this, Events_Loop::eventByName(EVENT_OBJECT_DELETED), 0, true);
321 aLoop->registerListener(this, Events_Loop::eventByName(EVENT_VALIDATOR_LOADED));
324 void Model_Session::processEvent(const std::shared_ptr<Events_Message>& theMessage)
326 static const Events_ID kFeatureEvent =
327 Events_Loop::eventByName(Config_FeatureMessage::MODEL_EVENT());
328 static const Events_ID kValidatorEvent = Events_Loop::eventByName(EVENT_VALIDATOR_LOADED);
329 if (theMessage->eventID() == kFeatureEvent) {
330 const std::shared_ptr<Config_FeatureMessage> aMsg =
331 std::dynamic_pointer_cast<Config_FeatureMessage>(theMessage);
333 // proccess the plugin info, load plugin
334 if (myPlugins.find(aMsg->id()) == myPlugins.end()) {
335 myPlugins[aMsg->id()] = std::pair<std::string, std::string>(
336 aMsg->pluginLibrary(), aMsg->documentKind());
339 const std::shared_ptr<Config_AttributeMessage> aMsgAttr =
340 std::dynamic_pointer_cast<Config_AttributeMessage>(theMessage);
342 if (!aMsgAttr->isObligatory()) {
343 validators()->registerNotObligatory(aMsgAttr->featureId(), aMsgAttr->attributeId());
345 if(aMsgAttr->isConcealment()) {
346 validators()->registerConcealment(aMsgAttr->featureId(), aMsgAttr->attributeId());
348 if (!aMsgAttr->caseId().empty()) {
349 validators()->registerCase(aMsgAttr->featureId(), aMsgAttr->attributeId(),
350 aMsgAttr->switchId(), aMsgAttr->caseId());
354 // plugins information was started to load, so, it will be loaded
355 myPluginsInfoLoaded = true;
356 } else if (theMessage->eventID() == kValidatorEvent) {
357 std::shared_ptr<Config_ValidatorMessage> aMsg =
358 std::dynamic_pointer_cast<Config_ValidatorMessage>(theMessage);
360 if (aMsg->attributeId().empty()) { // feature validator
361 validators()->assignValidator(aMsg->validatorId(), aMsg->featureId(), aMsg->parameters());
362 } else { // attribute validator
363 validators()->assignValidator(aMsg->validatorId(), aMsg->featureId(), aMsg->attributeId(),
367 } else { // create/update/delete
368 if (myCheckTransactions && !isOperation())
369 Events_Error::send("Modification of data structure outside of the transaction");
370 // if part is deleted, make the root as the current document (on undo of Parts creations)
371 static const Events_ID kDeletedEvent = Events_Loop::eventByName(EVENT_OBJECT_DELETED);
372 if (theMessage->eventID() == kDeletedEvent) {
373 std::shared_ptr<ModelAPI_ObjectDeletedMessage> aDeleted =
374 std::dynamic_pointer_cast<ModelAPI_ObjectDeletedMessage>(theMessage);
376 aDeleted->groups().find(ModelAPI_ResultPart::group()) != aDeleted->groups().end() &&
377 !ModelAPI_Tools::findPartResult(moduleDocument(), activeDocument()).get()) // another part may be disabled
379 setActiveDocument(moduleDocument());
385 void Model_Session::LoadPluginsInfo()
387 if (myPluginsInfoLoaded) // nothing to do
390 // Read plugins information from XML files
391 Config_ModuleReader aModuleReader(Config_FeatureMessage::MODEL_EVENT());
392 aModuleReader.readAll();
393 std::set<std::string> aFiles = aModuleReader.modulePluginFiles();
394 std::set<std::string>::iterator it = aFiles.begin();
395 for ( ; it != aFiles.end(); it++ ) {
396 Config_ValidatorReader aValidatorReader (*it);
397 aValidatorReader.readAll();
402 void Model_Session::registerPlugin(ModelAPI_Plugin* thePlugin)
404 myPluginObjs[myCurrentPluginName] = thePlugin;
405 static Events_ID EVENT_LOAD = Events_Loop::loop()->eventByName(EVENT_PLUGIN_LOADED);
406 ModelAPI_EventCreator::get()->sendUpdated(ObjectPtr(), EVENT_LOAD);
407 Events_Loop::loop()->flush(EVENT_LOAD);
408 // If the plugin has an ability to process GUI events, register it
409 Events_Listener* aListener = dynamic_cast<Events_Listener*>(thePlugin);
411 Events_Loop* aLoop = Events_Loop::loop();
412 static Events_ID aStateRequestEventId =
413 Events_Loop::loop()->eventByName(EVENT_FEATURE_STATE_REQUEST);
414 aLoop->registerListener(aListener, aStateRequestEventId);
418 ModelAPI_ValidatorsFactory* Model_Session::validators()
420 static Model_ValidatorsFactory* aFactory = new Model_ValidatorsFactory;