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_Application.h>
13 #include <Model_Events.h>
14 #include <Model_Validator.h>
15 #include <ModelAPI_Events.h>
16 #include <Events_Loop.h>
17 #include <Events_Error.h>
18 #include <Config_FeatureMessage.h>
19 #include <Config_AttributeMessage.h>
20 #include <Config_ValidatorMessage.h>
21 #include <Config_ModuleReader.h>
22 #include <ModelAPI_ResultPart.h>
24 #include <TDF_CopyTool.hxx>
25 #include <TDF_DataSet.hxx>
26 #include <TDF_RelocationTable.hxx>
27 #include <TDF_ClosureTool.hxx>
31 static Model_Session* myImpl = new Model_Session();
33 // t oredirect all calls to the root document
34 #define ROOT_DOC std::dynamic_pointer_cast<Model_Document>(moduleDocument())
36 bool Model_Session::load(const char* theFileName)
38 bool aRes = ROOT_DOC->load(theFileName);
42 bool Model_Session::save(const char* theFileName, std::list<std::string>& theResults)
44 return ROOT_DOC->save(theFileName, theResults);
47 void Model_Session::closeAll()
49 ROOT_DOC->close(true);
50 Model_Application::getApplication()->deleteAllDocuments();
53 void Model_Session::startOperation(const std::string& theId)
55 ROOT_DOC->startOperation();
56 ROOT_DOC->operationId(theId);
57 static std::shared_ptr<Events_Message> aStartedMsg
58 (new Events_Message(Events_Loop::eventByName("StartOperation")));
59 Events_Loop::loop()->send(aStartedMsg);
60 // remove all useless documents that has been closed: on start of operation undo/redo is cleared
61 std::list<std::shared_ptr<ModelAPI_Document> > aUsedDocs = allOpenedDocuments();
62 Model_Application::getApplication()->removeUselessDocuments(aUsedDocs);
65 void Model_Session::finishOperation()
67 setCheckTransactions(false);
68 ROOT_DOC->finishOperation();
69 setCheckTransactions(true);
72 void Model_Session::abortOperation()
74 setCheckTransactions(false);
75 ROOT_DOC->abortOperation();
76 setCheckTransactions(true);
77 // here the update mechanism may work after abort, so, supress the warnings about
78 // modifications outside of the transactions
79 bool aWasCheck = myCheckTransactions;
80 myCheckTransactions = false;
81 static std::shared_ptr<Events_Message> anAbortMsg
82 (new Events_Message(Events_Loop::eventByName("AbortOperation")));
83 Events_Loop::loop()->send(anAbortMsg);
84 myCheckTransactions = true;
85 myCheckTransactions = aWasCheck;
88 bool Model_Session::isOperation()
90 return ROOT_DOC->isOperation();
93 bool Model_Session::isModified()
95 return ROOT_DOC->isModified();
98 bool Model_Session::canUndo()
100 return ROOT_DOC->canUndo();
103 void Model_Session::undo()
105 setCheckTransactions(false);
107 setCheckTransactions(true);
110 bool Model_Session::canRedo()
112 return ROOT_DOC->canRedo();
115 void Model_Session::redo()
117 setCheckTransactions(false);
119 setCheckTransactions(true);
122 //! Returns stack of performed operations
123 std::list<std::string> Model_Session::undoList()
125 return ROOT_DOC->undoList();
127 //! Returns stack of rolled back operations
128 std::list<std::string> Model_Session::redoList()
130 return ROOT_DOC->redoList();
133 FeaturePtr Model_Session::createFeature(string theFeatureID)
135 if (this != myImpl) {
136 return myImpl->createFeature(theFeatureID);
139 // load all information about plugins, features and attributes
142 if (myPlugins.find(theFeatureID) != myPlugins.end()) {
143 std::pair<std::string, std::string>& aPlugin = myPlugins[theFeatureID]; // plugin and doc kind
144 if (!aPlugin.second.empty() && aPlugin.second != activeDocument()->kind()) {
146 string("Feature '") + theFeatureID + "' can be created only in document '"
147 + aPlugin.second + "' by the XML definition");
150 myCurrentPluginName = aPlugin.first;
151 if (myPluginObjs.find(myCurrentPluginName) == myPluginObjs.end()) {
152 // load plugin library if not yet done
153 Config_ModuleReader::loadPlugin(myCurrentPluginName);
155 if (myPluginObjs.find(myCurrentPluginName) != myPluginObjs.end()) {
156 FeaturePtr aCreated = myPluginObjs[myCurrentPluginName]->createFeature(theFeatureID);
159 string("Can not initialize feature '") + theFeatureID + "' in plugin '"
160 + myCurrentPluginName + "'");
164 Events_Error::send(string("Can not load plugin '") + myCurrentPluginName + "'");
167 Events_Error::send(string("Feature '") + theFeatureID + "' not found in any plugin");
170 return FeaturePtr(); // return nothing
173 std::shared_ptr<ModelAPI_Document> Model_Session::moduleDocument()
175 bool aFirstCall = !Model_Application::getApplication()->hasDocument("root");
177 // creation of the root document is always outside of the transaction, so, avoid checking it
178 setCheckTransactions(false);
180 std::shared_ptr<ModelAPI_Document> aDoc = std::shared_ptr<ModelAPI_Document>(
181 Model_Application::getApplication()->getDocument("root"));
183 // creation of the root document is always outside of the transaction, so, avoid checking it
184 setCheckTransactions(true);
189 std::shared_ptr<ModelAPI_Document> Model_Session::document(std::string theDocID)
191 return std::shared_ptr<ModelAPI_Document>(
192 Model_Application::getApplication()->getDocument(theDocID));
195 bool Model_Session::hasModuleDocument()
197 return Model_Application::getApplication()->hasDocument("root");
200 std::shared_ptr<ModelAPI_Document> Model_Session::activeDocument()
202 if (!myCurrentDoc || !Model_Application::getApplication()->hasDocument(myCurrentDoc->id()))
203 myCurrentDoc = moduleDocument();
207 void Model_Session::setActiveDocument(
208 std::shared_ptr<ModelAPI_Document> theDoc, bool theSendSignal)
210 if (myCurrentDoc != theDoc) {
211 myCurrentDoc = theDoc;
212 if (theDoc.get() && theSendSignal) {
213 // syncronize the document: it may be just opened or opened but removed before
214 std::shared_ptr<Model_Document> aDoc = std::dynamic_pointer_cast<Model_Document>(theDoc);
216 bool aWasChecked = myCheckTransactions;
217 setCheckTransactions(false);
218 aDoc->synchronizeFeatures(false, true);
220 setCheckTransactions(true);
222 static std::shared_ptr<Events_Message> aMsg(
223 new Events_Message(Events_Loop::eventByName(EVENT_DOCUMENT_CHANGED)));
224 Events_Loop::loop()->send(aMsg);
229 std::list<std::shared_ptr<ModelAPI_Document> > Model_Session::allOpenedDocuments()
231 list<std::shared_ptr<ModelAPI_Document> > aResult;
232 aResult.push_back(moduleDocument());
233 // add subs recursively
234 list<std::shared_ptr<ModelAPI_Document> >::iterator aDoc = aResult.begin();
235 for(; aDoc != aResult.end(); aDoc++) {
236 DocumentPtr anAPIDoc = *aDoc;
237 std::shared_ptr<Model_Document> aDoc = std::dynamic_pointer_cast<Model_Document>(anAPIDoc);
239 const std::set<std::string> aSubs = aDoc->subDocuments(true);
240 std::set<std::string>::const_iterator aSubIter = aSubs.cbegin();
241 for(; aSubIter != aSubs.cend(); aSubIter++) {
242 if (!Model_Application::getApplication()->isLoadByDemand(*aSubIter)) {
243 aResult.push_back(Model_Application::getApplication()->getDocument(*aSubIter));
251 std::shared_ptr<ModelAPI_Document> Model_Session::copy(
252 std::shared_ptr<ModelAPI_Document> theSource, std::string theID)
254 // create a new document
255 std::shared_ptr<Model_Document> aNew = std::dynamic_pointer_cast<Model_Document>(
256 Model_Application::getApplication()->getDocument(theID));
257 // make a copy of all labels
258 TDF_Label aSourceRoot = std::dynamic_pointer_cast<Model_Document>(theSource)->document()->Main()
260 TDF_Label aTargetRoot = aNew->document()->Main().Father();
261 Handle(TDF_DataSet) aDS = new TDF_DataSet;
262 aDS->AddLabel(aSourceRoot);
263 TDF_ClosureTool::Closure(aDS);
264 Handle(TDF_RelocationTable) aRT = new TDF_RelocationTable;
265 aRT->SetRelocation(aSourceRoot, aTargetRoot);
266 TDF_CopyTool::Copy(aDS, aRT);
268 aNew->synchronizeFeatures(false, true);
272 Model_Session::Model_Session()
274 myPluginsInfoLoaded = false;
275 myCheckTransactions = true;
276 ModelAPI_Session::setSession(std::shared_ptr<ModelAPI_Session>(this));
277 // register the configuration reading listener
278 Events_Loop* aLoop = Events_Loop::loop();
279 static const Events_ID kFeatureEvent =
280 Events_Loop::eventByName(Config_FeatureMessage::MODEL_EVENT());
281 aLoop->registerListener(this, kFeatureEvent);
282 aLoop->registerListener(this, Events_Loop::eventByName(EVENT_OBJECT_CREATED), 0, true);
283 aLoop->registerListener(this, Events_Loop::eventByName(EVENT_OBJECT_UPDATED), 0, true);
284 aLoop->registerListener(this, Events_Loop::eventByName(EVENT_OBJECT_DELETED), 0, true);
285 aLoop->registerListener(this, Events_Loop::eventByName(EVENT_VALIDATOR_LOADED));
288 void Model_Session::processEvent(const std::shared_ptr<Events_Message>& theMessage)
290 static const Events_ID kFeatureEvent =
291 Events_Loop::eventByName(Config_FeatureMessage::MODEL_EVENT());
292 static const Events_ID kValidatorEvent = Events_Loop::eventByName(EVENT_VALIDATOR_LOADED);
293 if (theMessage->eventID() == kFeatureEvent) {
294 const std::shared_ptr<Config_FeatureMessage> aMsg =
295 std::dynamic_pointer_cast<Config_FeatureMessage>(theMessage);
297 // proccess the plugin info, load plugin
298 if (myPlugins.find(aMsg->id()) == myPlugins.end()) {
299 myPlugins[aMsg->id()] = std::pair<std::string, std::string>(
300 aMsg->pluginLibrary(), aMsg->documentKind());
303 const std::shared_ptr<Config_AttributeMessage> aMsgAttr =
304 std::dynamic_pointer_cast<Config_AttributeMessage>(theMessage);
306 if (!aMsgAttr->isObligatory()) {
307 validators()->registerNotObligatory(aMsgAttr->featureId(), aMsgAttr->attributeId());
309 if(aMsgAttr->isConcealment()) {
310 validators()->registerConcealment(aMsgAttr->featureId(), aMsgAttr->attributeId());
312 if (!aMsgAttr->caseId().empty()) {
313 validators()->registerCase(aMsgAttr->featureId(), aMsgAttr->attributeId(),
314 aMsgAttr->switchId(), aMsgAttr->caseId());
318 // plugins information was started to load, so, it will be loaded
319 myPluginsInfoLoaded = true;
320 } else if (theMessage->eventID() == kValidatorEvent) {
321 std::shared_ptr<Config_ValidatorMessage> aMsg =
322 std::dynamic_pointer_cast<Config_ValidatorMessage>(theMessage);
324 if (aMsg->attributeId().empty()) { // feature validator
325 validators()->assignValidator(aMsg->validatorId(), aMsg->featureId(), aMsg->parameters());
326 } else { // attribute validator
327 validators()->assignValidator(aMsg->validatorId(), aMsg->featureId(), aMsg->attributeId(),
331 } else { // create/update/delete
332 if (myCheckTransactions && !isOperation())
333 Events_Error::send("Modification of data structure outside of the transaction");
334 // if part is deleted, make the root as the current document (on undo of Parts creations)
335 static const Events_ID kDeletedEvent = Events_Loop::eventByName(EVENT_OBJECT_DELETED);
336 if (theMessage->eventID() == kDeletedEvent) {
337 std::shared_ptr<ModelAPI_ObjectDeletedMessage> aDeleted =
338 std::dynamic_pointer_cast<ModelAPI_ObjectDeletedMessage>(theMessage);
340 aDeleted->groups().find(ModelAPI_ResultPart::group()) != aDeleted->groups().end())
342 setActiveDocument(moduleDocument());
348 void Model_Session::LoadPluginsInfo()
350 if (myPluginsInfoLoaded) // nothing to do
353 // Read plugins information from XML files
354 Config_ModuleReader aXMLReader(Config_FeatureMessage::MODEL_EVENT());
355 aXMLReader.readAll();
358 void Model_Session::registerPlugin(ModelAPI_Plugin* thePlugin)
360 myPluginObjs[myCurrentPluginName] = thePlugin;
361 static Events_ID EVENT_LOAD = Events_Loop::loop()->eventByName(EVENT_PLUGIN_LOADED);
362 ModelAPI_EventCreator::get()->sendUpdated(ObjectPtr(), EVENT_LOAD);
363 Events_Loop::loop()->flush(EVENT_LOAD);
364 // If the plugin has an ability to process GUI events, register it
365 Events_Listener* aListener = dynamic_cast<Events_Listener*>(thePlugin);
367 Events_Loop* aLoop = Events_Loop::loop();
368 static Events_ID aStateRequestEventId =
369 Events_Loop::loop()->eventByName(EVENT_FEATURE_STATE_REQUEST);
370 aLoop->registerListener(aListener, aStateRequestEventId);
374 ModelAPI_ValidatorsFactory* Model_Session::validators()
376 static Model_ValidatorsFactory* aFactory = new Model_ValidatorsFactory;