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 <Events_Loop.h>
16 #include <Events_Error.h>
17 #include <Config_FeatureMessage.h>
18 #include <Config_AttributeMessage.h>
19 #include <Config_ValidatorMessage.h>
20 #include <Config_ModuleReader.h>
22 #include <TDF_CopyTool.hxx>
23 #include <TDF_DataSet.hxx>
24 #include <TDF_RelocationTable.hxx>
25 #include <TDF_ClosureTool.hxx>
29 static Model_Session* myImpl = new Model_Session();
31 // t oredirect all calls to the root document
32 #define ROOT_DOC std::dynamic_pointer_cast<Model_Document>(moduleDocument())
34 bool Model_Session::load(const char* theFileName)
36 return ROOT_DOC->load(theFileName);
39 bool Model_Session::save(const char* theFileName, std::list<std::string>& theResults)
41 return ROOT_DOC->save(theFileName, theResults);
44 void Model_Session::closeAll()
46 ROOT_DOC->close(true);
47 Model_Application::getApplication()->deleteAllDocuments();
50 void Model_Session::startOperation()
52 ROOT_DOC->startOperation();
53 static std::shared_ptr<Events_Message> aStartedMsg
54 (new Events_Message(Events_Loop::eventByName("StartOperation")));
55 Events_Loop::loop()->send(aStartedMsg);
58 void Model_Session::finishOperation()
60 ROOT_DOC->finishOperation();
63 void Model_Session::abortOperation()
65 ROOT_DOC->abortOperation();
66 // here the update mechanism may work after abort, so, supress the warnings about
67 // modifications outside of the transactions
68 bool aWasCheck = myCheckTransactions;
69 myCheckTransactions = false;
70 static std::shared_ptr<Events_Message> anAbortMsg
71 (new Events_Message(Events_Loop::eventByName("AbortOperation")));
72 Events_Loop::loop()->send(anAbortMsg);
73 myCheckTransactions = true;
74 myCheckTransactions = aWasCheck;
77 bool Model_Session::isOperation()
79 return ROOT_DOC->isOperation();
82 bool Model_Session::isModified()
84 return ROOT_DOC->isModified();
87 bool Model_Session::canUndo()
89 return ROOT_DOC->canUndo();
92 void Model_Session::undo()
97 bool Model_Session::canRedo()
99 return ROOT_DOC->canRedo();
102 void Model_Session::redo()
107 FeaturePtr Model_Session::createFeature(string theFeatureID)
109 if (this != myImpl) {
110 return myImpl->createFeature(theFeatureID);
113 // load all information about plugins, features and attributes
116 if (myPlugins.find(theFeatureID) != myPlugins.end()) {
117 std::pair<std::string, std::string>& aPlugin = myPlugins[theFeatureID]; // plugin and doc kind
118 if (!aPlugin.second.empty() && aPlugin.second != activeDocument()->kind()) {
120 string("Feature '") + theFeatureID + "' can be created only in document '"
121 + aPlugin.second + "' by the XML definition");
124 myCurrentPluginName = aPlugin.first;
125 if (myPluginObjs.find(myCurrentPluginName) == myPluginObjs.end()) {
126 // load plugin library if not yet done
127 Config_ModuleReader::loadPlugin(myCurrentPluginName);
129 if (myPluginObjs.find(myCurrentPluginName) != myPluginObjs.end()) {
130 FeaturePtr aCreated = myPluginObjs[myCurrentPluginName]->createFeature(theFeatureID);
133 string("Can not initialize feature '") + theFeatureID + "' in plugin '"
134 + myCurrentPluginName + "'");
138 Events_Error::send(string("Can not load plugin '") + myCurrentPluginName + "'");
141 Events_Error::send(string("Feature '") + theFeatureID + "' not found in any plugin");
144 return FeaturePtr(); // return nothing
147 std::shared_ptr<ModelAPI_Document> Model_Session::moduleDocument()
149 return std::shared_ptr<ModelAPI_Document>(
150 Model_Application::getApplication()->getDocument("root"));
153 std::shared_ptr<ModelAPI_Document> Model_Session::document(std::string theDocID)
155 return std::shared_ptr<ModelAPI_Document>(
156 Model_Application::getApplication()->getDocument(theDocID));
159 bool Model_Session::hasModuleDocument()
161 return Model_Application::getApplication()->hasDocument("root");
164 std::shared_ptr<ModelAPI_Document> Model_Session::activeDocument()
166 if (!myCurrentDoc || !Model_Application::getApplication()->hasDocument(myCurrentDoc->id()))
167 myCurrentDoc = moduleDocument();
171 void Model_Session::setActiveDocument(
172 std::shared_ptr<ModelAPI_Document> theDoc, bool theSendSignal)
174 if (myCurrentDoc != theDoc) {
175 myCurrentDoc = theDoc;
177 static std::shared_ptr<Events_Message> aMsg(new Events_Message(Events_Loop::eventByName("CurrentDocumentChanged")));
178 Events_Loop::loop()->send(aMsg);
183 std::list<std::shared_ptr<ModelAPI_Document> > Model_Session::allOpenedDocuments()
185 list<std::shared_ptr<ModelAPI_Document> > aResult;
186 aResult.push_back(moduleDocument());
187 // add subs recursively
188 list<std::shared_ptr<ModelAPI_Document> >::iterator aDoc = aResult.begin();
189 for(; aDoc != aResult.end(); aDoc++) {
190 DocumentPtr anAPIDoc = *aDoc;
191 std::shared_ptr<Model_Document> aDoc = std::dynamic_pointer_cast<Model_Document>(anAPIDoc);
193 const std::set<std::string> aSubs = aDoc->subDocuments(true);
194 std::set<std::string>::const_iterator aSubIter = aSubs.cbegin();
195 for(; aSubIter != aSubs.cend(); aSubIter++) {
196 if (!Model_Application::getApplication()->isLoadByDemand(*aSubIter)) {
197 aResult.push_back(Model_Application::getApplication()->getDocument(*aSubIter));
205 std::shared_ptr<ModelAPI_Document> Model_Session::copy(
206 std::shared_ptr<ModelAPI_Document> theSource, std::string theID)
208 // create a new document
209 std::shared_ptr<Model_Document> aNew = std::dynamic_pointer_cast<Model_Document>(
210 Model_Application::getApplication()->getDocument(theID));
211 // make a copy of all labels
212 TDF_Label aSourceRoot = std::dynamic_pointer_cast<Model_Document>(theSource)->document()->Main()
214 TDF_Label aTargetRoot = aNew->document()->Main().Father();
215 Handle(TDF_DataSet) aDS = new TDF_DataSet;
216 aDS->AddLabel(aSourceRoot);
217 TDF_ClosureTool::Closure(aDS);
218 Handle(TDF_RelocationTable) aRT = new TDF_RelocationTable;
219 aRT->SetRelocation(aSourceRoot, aTargetRoot);
220 TDF_CopyTool::Copy(aDS, aRT);
222 aNew->synchronizeFeatures(false, true);
226 Model_Session::Model_Session()
228 myPluginsInfoLoaded = false;
229 myCheckTransactions = true;
230 ModelAPI_Session::setSession(std::shared_ptr<ModelAPI_Session>(this));
231 // register the configuration reading listener
232 Events_Loop* aLoop = Events_Loop::loop();
233 static const Events_ID kFeatureEvent = Events_Loop::eventByName(Config_FeatureMessage::MODEL_EVENT());
234 aLoop->registerListener(this, kFeatureEvent);
235 aLoop->registerListener(this, Events_Loop::eventByName(EVENT_OBJECT_CREATED), 0, true);
236 aLoop->registerListener(this, Events_Loop::eventByName(EVENT_OBJECT_UPDATED), 0, true);
237 aLoop->registerListener(this, Events_Loop::eventByName(EVENT_OBJECT_DELETED), 0, true);
238 aLoop->registerListener(this, Events_Loop::eventByName(EVENT_VALIDATOR_LOADED));
241 void Model_Session::processEvent(const std::shared_ptr<Events_Message>& theMessage)
243 static const Events_ID kFeatureEvent = Events_Loop::eventByName(Config_FeatureMessage::MODEL_EVENT());
244 static const Events_ID kValidatorEvent = Events_Loop::eventByName(EVENT_VALIDATOR_LOADED);
245 if (theMessage->eventID() == kFeatureEvent) {
246 const std::shared_ptr<Config_FeatureMessage> aMsg =
247 std::dynamic_pointer_cast<Config_FeatureMessage>(theMessage);
249 // proccess the plugin info, load plugin
250 if (myPlugins.find(aMsg->id()) == myPlugins.end()) {
251 myPlugins[aMsg->id()] = std::pair<std::string, std::string>(
252 aMsg->pluginLibrary(), aMsg->documentKind());
255 const std::shared_ptr<Config_AttributeMessage> aMsgAttr =
256 std::dynamic_pointer_cast<Config_AttributeMessage>(theMessage);
258 if (!aMsgAttr->isObligatory()) {
259 validators()->registerNotObligatory(aMsgAttr->featureId(), aMsgAttr->attributeId());
261 if(aMsgAttr->isConcealment()) {
262 validators()->registerConcealment(aMsgAttr->featureId(), aMsgAttr->attributeId());
267 // plugins information was started to load, so, it will be loaded
268 myPluginsInfoLoaded = true;
269 } else if (theMessage->eventID() == kValidatorEvent) {
270 std::shared_ptr<Config_ValidatorMessage> aMsg =
271 std::dynamic_pointer_cast<Config_ValidatorMessage>(theMessage);
273 if (aMsg->attributeId().empty()) { // feature validator
274 validators()->assignValidator(aMsg->validatorId(), aMsg->featureId(), aMsg->parameters());
275 } else { // attribute validator
276 validators()->assignValidator(aMsg->validatorId(), aMsg->featureId(), aMsg->attributeId(),
280 } else { // create/update/delete
281 if (myCheckTransactions && !isOperation())
282 Events_Error::send("Modification of data structure outside of the transaction");
286 void Model_Session::LoadPluginsInfo()
288 if (myPluginsInfoLoaded) // nothing to do
291 // Read plugins information from XML files
292 Config_ModuleReader aXMLReader(Config_FeatureMessage::MODEL_EVENT());
293 aXMLReader.readAll();
296 void Model_Session::registerPlugin(ModelAPI_Plugin* thePlugin)
298 myPluginObjs[myCurrentPluginName] = thePlugin;
299 static Events_ID EVENT_LOAD = Events_Loop::loop()->eventByName(EVENT_PLUGIN_LOADED);
300 ModelAPI_EventCreator::get()->sendUpdated(ObjectPtr(), EVENT_LOAD);
301 Events_Loop::loop()->flush(EVENT_LOAD);
302 // If the plugin has an ability to process GUI events, register it
303 Events_Listener* aListener = dynamic_cast<Events_Listener*>(thePlugin);
305 Events_Loop* aLoop = Events_Loop::loop();
306 static Events_ID aStateRequestEventId =
307 Events_Loop::loop()->eventByName(EVENT_FEATURE_STATE_REQUEST);
308 aLoop->registerListener(aListener, aStateRequestEventId);
312 ModelAPI_ValidatorsFactory* Model_Session::validators()
314 static Model_ValidatorsFactory* aFactory = new Model_ValidatorsFactory;