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