src/Model/Model_Session.cpp

   1 // File:        Model_Session.cxx
   2 // Created:     20 Mar 2014
   3 // Author:      Mikhail PONIKAROV
   4
   5 #include <Model_Session.h>
   6 #include <ModelAPI_Feature.h>
   7 #include <ModelAPI_Plugin.h>
   8 #include <Model_Data.h>
   9 #include <Model_Document.h>
  10 #include <Model_Application.h>
  11 #include <Model_Events.h>
  12 #include <Model_Validator.h>
  13 #include <Events_Loop.h>
  14 #include <Events_Error.h>
  15 #include <Config_FeatureMessage.h>
  16 #include <Config_AttributeMessage.h>
  17 #include <Config_ValidatorMessage.h>
  18 #include <Config_ModuleReader.h>
  19
  20 #include <TDF_CopyTool.hxx>
  21 #include <TDF_DataSet.hxx>
  22 #include <TDF_RelocationTable.hxx>
  23 #include <TDF_ClosureTool.hxx>
  24
  25 using namespace std;
  26
  27 static Model_Session* myImpl = new Model_Session();
  28
  29 // t oredirect all calls to the root document
  30 #define ROOT_DOC boost::dynamic_pointer_cast<Model_Document>(moduleDocument())
  31
  32 bool Model_Session::load(const char* theFileName)
  33 {
  34   return ROOT_DOC->load(theFileName);
  35 }
  36
  37 bool Model_Session::save(const char* theFileName, std::list<std::string>& theResults)
  38 {
  39   return ROOT_DOC->save(theFileName, theResults);
  40 }
  41
  42 void Model_Session::startOperation()
  43 {
  44   ROOT_DOC->startOperation();
  45   static boost::shared_ptr<Events_Message> aStartedMsg
  46     (new Events_Message(Events_Loop::eventByName("StartOperation")));
  47   Events_Loop::loop()->send(aStartedMsg);
  48 }
  49
  50 void Model_Session::finishOperation()
  51 {
  52   ROOT_DOC->finishOperation();
  53 }
  54
  55 void Model_Session::abortOperation()
  56 {
  57   ROOT_DOC->abortOperation();
  58   static boost::shared_ptr<Events_Message> anAbortMsg
  59     (new Events_Message(Events_Loop::eventByName("AbortOperation")));
  60   Events_Loop::loop()->send(anAbortMsg);
  61 }
  62
  63 bool Model_Session::isOperation()
  64 {
  65   return ROOT_DOC->isOperation();
  66 }
  67
  68 bool Model_Session::isModified()
  69 {
  70   return ROOT_DOC->isModified();
  71 }
  72
  73 bool Model_Session::canUndo()
  74 {
  75   return ROOT_DOC->canUndo();
  76 }
  77
  78 void Model_Session::undo()
  79 {
  80   ROOT_DOC->undo();
  81 }
  82
  83 bool Model_Session::canRedo()
  84 {
  85   return ROOT_DOC->canRedo();
  86 }
  87
  88 void Model_Session::redo()
  89 {
  90   ROOT_DOC->redo();
  91 }
  92
  93 FeaturePtr Model_Session::createFeature(string theFeatureID)
  94 {
  95   if (this != myImpl)
  96     return myImpl->createFeature(theFeatureID);
  97
  98   if (myPlugins.find(theFeatureID) != myPlugins.end()) {
  99     std::pair<std::string, std::string>& aPlugin = myPlugins[theFeatureID]; // plugin and doc kind
 100     if (!aPlugin.second.empty() && aPlugin.second != activeDocument()->kind()) {
 101       Events_Error::send(
 102           string("Feature '") + theFeatureID + "' can be created only in document '"
 103               + aPlugin.second + "' by the XML definition");
 104       return FeaturePtr();
 105     }
 106     myCurrentPluginName = aPlugin.first;
 107     if (myPluginObjs.find(myCurrentPluginName) == myPluginObjs.end()) {
 108       // load plugin library if not yet done
 109       Config_ModuleReader::loadLibrary(myCurrentPluginName);
 110     }
 111     if (myPluginObjs.find(myCurrentPluginName) != myPluginObjs.end()) {
 112       FeaturePtr aCreated = myPluginObjs[myCurrentPluginName]->createFeature(theFeatureID);
 113       if (!aCreated) {
 114         Events_Error::send(
 115             string("Can not initialize feature '") + theFeatureID + "' in plugin '"
 116                 + myCurrentPluginName + "'");
 117       }
 118       return aCreated;
 119     } else {
 120       Events_Error::send(string("Can not load plugin '") + myCurrentPluginName + "'");
 121     }
 122   } else {
 123     Events_Error::send(string("Feature '") + theFeatureID + "' not found in any plugin");
 124   }
 125
 126   return FeaturePtr();  // return nothing
 127 }
 128
 129 boost::shared_ptr<ModelAPI_Document> Model_Session::moduleDocument()
 130 {
 131   return boost::shared_ptr<ModelAPI_Document>(
 132       Model_Application::getApplication()->getDocument("root"));
 133 }
 134
 135 bool Model_Session::hasModuleDocument()
 136 {
 137   return Model_Application::getApplication()->hasDocument("root");
 138 }
 139
 140 boost::shared_ptr<ModelAPI_Document> Model_Session::activeDocument()
 141 {
 142   if (!myCurrentDoc || !Model_Application::getApplication()->hasDocument(myCurrentDoc->id()))
 143     myCurrentDoc = moduleDocument();
 144   return myCurrentDoc;
 145 }
 146
 147 void Model_Session::setActiveDocument(
 148   boost::shared_ptr<ModelAPI_Document> theDoc, bool theSendSignal)
 149 {
 150   if (myCurrentDoc != theDoc) {
 151     myCurrentDoc = theDoc;
 152     if (theSendSignal) {
 153       static boost::shared_ptr<Events_Message> aMsg(new Events_Message(Events_Loop::eventByName("CurrentDocumentChanged")));
 154       Events_Loop::loop()->send(aMsg);
 155     }
 156   }
 157 }
 158
 159 std::list<boost::shared_ptr<ModelAPI_Document> > Model_Session::allOpenedDocuments()
 160 {
 161   list<boost::shared_ptr<ModelAPI_Document> > aResult;
 162   aResult.push_back(moduleDocument());
 163   // add subs recursively
 164   list<boost::shared_ptr<ModelAPI_Document> >::iterator aDoc = aResult.begin();
 165   for(; aDoc != aResult.end(); aDoc++) {
 166     DocumentPtr anAPIDoc = *aDoc;
 167     boost::shared_ptr<Model_Document> aDoc = boost::dynamic_pointer_cast<Model_Document>(anAPIDoc);
 168     if (aDoc) {
 169       std::set<std::string>::const_iterator aSubIter = aDoc->subDocuments().cbegin();
 170       for(; aSubIter != aDoc->subDocuments().cend(); aSubIter++) {
 171         if (!Model_Application::getApplication()->isLoadByDemand(*aSubIter)) {
 172           aResult.push_back(Model_Application::getApplication()->getDocument(*aSubIter));
 173         }
 174       }
 175     }
 176   }
 177   return aResult;
 178 }
 179
 180 boost::shared_ptr<ModelAPI_Document> Model_Session::copy(
 181     boost::shared_ptr<ModelAPI_Document> theSource, std::string theID)
 182 {
 183   // create a new document
 184   boost::shared_ptr<Model_Document> aNew = boost::dynamic_pointer_cast<Model_Document>(
 185       Model_Application::getApplication()->getDocument(theID));
 186   // make a copy of all labels
 187   TDF_Label aSourceRoot = boost::dynamic_pointer_cast<Model_Document>(theSource)->document()->Main()
 188       .Father();
 189   TDF_Label aTargetRoot = aNew->document()->Main().Father();
 190   Handle(TDF_DataSet) aDS = new TDF_DataSet;
 191   aDS->AddLabel(aSourceRoot);
 192   TDF_ClosureTool::Closure(aDS);
 193   Handle(TDF_RelocationTable) aRT = new TDF_RelocationTable;
 194   aRT->SetRelocation(aSourceRoot, aTargetRoot);
 195   TDF_CopyTool::Copy(aDS, aRT);
 196
 197   aNew->synchronizeFeatures(false, true);
 198   return aNew;
 199 }
 200
 201 Model_Session::Model_Session()
 202 {
 203   myPluginsInfoLoaded = false;
 204   myCheckTransactions = true;
 205   ModelAPI_Session::setSession(boost::shared_ptr<ModelAPI_Session>(this));
 206   // register the configuration reading listener
 207   Events_Loop* aLoop = Events_Loop::loop();
 208   static const Events_ID kFeatureEvent = Events_Loop::eventByName(Config_FeatureMessage::MODEL_EVENT());
 209   aLoop->registerListener(this, kFeatureEvent);
 210   aLoop->registerListener(this, Events_Loop::eventByName(EVENT_OBJECT_CREATED), 0, true);
 211   aLoop->registerListener(this, Events_Loop::eventByName(EVENT_OBJECT_UPDATED), 0, true);
 212   aLoop->registerListener(this, Events_Loop::eventByName(EVENT_OBJECT_DELETED), 0, true);
 213   aLoop->registerListener(this, Events_Loop::eventByName(EVENT_VALIDATOR_LOADED));
 214
 215   // load all information about plugins, features and attributes
 216   LoadPluginsInfo();
 217 }
 218
 219 void Model_Session::processEvent(const boost::shared_ptr<Events_Message>& theMessage)
 220 {
 221   static const Events_ID kFeatureEvent = Events_Loop::eventByName(Config_FeatureMessage::MODEL_EVENT());
 222   static const Events_ID kValidatorEvent = Events_Loop::eventByName(EVENT_VALIDATOR_LOADED);
 223   if (theMessage->eventID() == kFeatureEvent) {
 224     const boost::shared_ptr<Config_FeatureMessage> aMsg =
 225       boost::dynamic_pointer_cast<Config_FeatureMessage>(theMessage);
 226     if (aMsg) {
 227       // proccess the plugin info, load plugin
 228       if (myPlugins.find(aMsg->id()) == myPlugins.end()) {
 229         myPlugins[aMsg->id()] = std::pair<std::string, std::string>(
 230           aMsg->pluginLibrary(), aMsg->documentKind());
 231       }
 232     } else {
 233       const boost::shared_ptr<Config_AttributeMessage> aMsgAttr =
 234         boost::dynamic_pointer_cast<Config_AttributeMessage>(theMessage);
 235       if (aMsgAttr) {
 236         if (!aMsgAttr->isObligatory()) {
 237           validators()->registerNotObligatory(aMsgAttr->featureId(), aMsgAttr->attributeId());
 238         }
 239         if(aMsgAttr->isConcealment()) {
 240           validators()->registerConcealment(aMsgAttr->featureId(), aMsgAttr->attributeId());
 241         }
 242
 243       }
 244     }
 245     // plugins information was started to load, so, it will be loaded
 246     myPluginsInfoLoaded = true;
 247   } else if (theMessage->eventID() == kValidatorEvent) {
 248     boost::shared_ptr<Config_ValidatorMessage> aMsg =
 249       boost::dynamic_pointer_cast<Config_ValidatorMessage>(theMessage);
 250     if (aMsg) {
 251       if (aMsg->attributeId().empty()) {  // feature validator
 252         validators()->assignValidator(aMsg->validatorId(), aMsg->featureId(), aMsg->parameters());
 253       } else {  // attribute validator
 254         validators()->assignValidator(aMsg->validatorId(), aMsg->featureId(), aMsg->attributeId(),
 255                                       aMsg->parameters());
 256       }
 257     }
 258   } else {  // create/update/delete
 259     if (myCheckTransactions && !isOperation())
 260       Events_Error::send("Modification of data structure outside of the transaction");
 261   }
 262 }
 263
 264 void Model_Session::LoadPluginsInfo()
 265 {
 266   if (myPluginsInfoLoaded)  // nothing to do
 267     return;
 268
 269   // Read plugins information from XML files
 270   Config_ModuleReader aXMLReader(Config_FeatureMessage::MODEL_EVENT());
 271   aXMLReader.readAll();
 272 }
 273
 274 void Model_Session::registerPlugin(ModelAPI_Plugin* thePlugin)
 275 {
 276   myPluginObjs[myCurrentPluginName] = thePlugin;
 277   static Events_ID EVENT_LOAD = Events_Loop::loop()->eventByName(EVENT_PLUGIN_LOADED);
 278   ModelAPI_EventCreator::get()->sendUpdated(ObjectPtr(), EVENT_LOAD);
 279   Events_Loop::loop()->flush(EVENT_LOAD);
 280 }
 281
 282 ModelAPI_ValidatorsFactory* Model_Session::validators()
 283 {
 284   static Model_ValidatorsFactory* aFactory = new Model_ValidatorsFactory;
 285   return aFactory;
 286 }