Salome HOME
Issue #3044: Undo list contains empty string for Load python script
[modules/shaper.git] / src / Model / Model_Session.h
1 // Copyright (C) 2014-2019  CEA/DEN, EDF R&D
2 //
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
7 //
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11 // Lesser General Public License for more details.
12 //
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
16 //
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
18 //
19
20 #ifndef Model_Session_H_
21 #define Model_Session_H_
22
23 #include "Model.h"
24 #include <ModelAPI_Session.h>
25 #include <ModelAPI_Feature.h>
26
27 #include <Events_Listener.h>
28 #include <map>
29
30 class Model_Document;
31
32 /**\class Model_Session
33  * \ingroup DataModel
34  * \brief Object that knows (from the initial XML file) which
35  * plugin contains which feature, loads and stores reference to loaded plugins by
36  * the feature functionality request.
37  */
38 class Model_Session : public ModelAPI_Session, public Events_Listener
39 {
40   bool myPluginsInfoLoaded;  ///< it true if plugins information is loaded
41   /// map of feature IDs to plugin name and document kind
42   std::map<std::string, std::pair<std::string, std::string> > myPlugins;
43   std::map<std::string, ModelAPI_Plugin*> myPluginObjs;  ///< instances of the already plugins
44   std::string myCurrentPluginName;  ///< name of the plugin that must be loaded currently
45   std::shared_ptr<ModelAPI_Document> myCurrentDoc;  ///< current working document
46    ///< map from plugin id to plugins which are used by it (must be loaded before this one)
47   std::map<std::string, std::string> myUsePlugins;
48
49   /// if true, generates error if document is updated outside of transaction
50   bool myCheckTransactions;
51   /// if true, the current operation must be committed twice,
52   /// with nested (list for any nesting depth)
53   std::list<bool> myOperationAttachedToNext;
54  public:
55
56   //! Loads the OCAF document from the file.
57   //! \param theFileName full name of the file to load
58   //! \returns true if file was loaded successfully
59   MODEL_EXPORT virtual bool load(const char* theFileName);
60
61   //! Saves the OCAF document to the file.
62   //! \param theFileName full name of the file to store
63   //! \param theResults the result full file names that were stored by "save"
64   //! \returns true if file was stored successfully
65   MODEL_EXPORT virtual bool save(const char* theFileName, std::list<std::string>& theResults);
66
67   //! Closes all documents
68   MODEL_EXPORT virtual void closeAll();
69
70   //! Starts a new operation (opens a transaction)
71   //! \param theId string-identifier of the started transaction
72   //! \param theAttachedToNested if it is true,
73   //!                            it means that this transaction is attached to the nested
74   //!          where it is located and will be committed on the next commit with the nested
75   MODEL_EXPORT virtual void startOperation(
76     const std::string& theId = "", const bool theAttachedToNested = false);
77   //! Finishes the previously started operation (closes the transaction)
78   MODEL_EXPORT virtual void finishOperation();
79   //! Aborts the operation
80   MODEL_EXPORT virtual void abortOperation();
81   //! Returns true if operation has been started, but not yet finished or aborted
82   MODEL_EXPORT virtual bool isOperation();
83   //! Returns true if document was modified (since creation/opening)
84   MODEL_EXPORT virtual bool isModified();
85
86   //! Returns True if there are available Undos
87   MODEL_EXPORT virtual bool canUndo();
88   //! Undoes last operation
89   MODEL_EXPORT virtual void undo();
90   //! Clean the undo list
91   MODEL_EXPORT virtual void clearUndos();
92   //! Returns True if there are available Redos
93   MODEL_EXPORT virtual bool canRedo();
94   //! Redoes last operation
95   MODEL_EXPORT virtual void redo();
96   //! Returns stack of performed operations
97   MODEL_EXPORT virtual std::list<std::string> undoList();
98   //! Returns stack of rolled back operations
99   MODEL_EXPORT virtual std::list<std::string> redoList();
100
101   /// Returns the root document of the application (that may contains sub-documents)
102   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Document> moduleDocument();
103
104   /// Returns the document by ID, loads if not loaded yet. Returns null if no such document.
105   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Document> document(int theDocID);
106
107   /// Return true if root document has been already created
108   MODEL_EXPORT virtual bool hasModuleDocument();
109
110   /// Returns the current document that used for current work in the application
111   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Document> activeDocument();
112
113   /// Defines the current document that used for current work in the application
114   MODEL_EXPORT virtual void setActiveDocument(
115     std::shared_ptr<ModelAPI_Document> theDoc, bool theSendSignal = true);
116
117   /// Returns all the opened documents of the session (without postponed)
118   MODEL_EXPORT virtual std::list<std::shared_ptr<ModelAPI_Document> > allOpenedDocuments();
119
120   /// Returns true if document is not loaded yet
121   MODEL_EXPORT virtual bool isLoadByDemand(const std::string theDocID, const int theDocIndex);
122
123   /// Registers the plugin that creates features.
124   /// It is obligatory for each plugin to call this function on loading to be found by
125   /// the plugin manager on call of the feature)
126   MODEL_EXPORT virtual void registerPlugin(ModelAPI_Plugin* thePlugin);
127
128   /// Processes the configuration file reading
129   MODEL_EXPORT virtual void processEvent(const std::shared_ptr<Events_Message>& theMessage);
130
131   /// Copies the document to the new one
132   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Document> copy(
133       std::shared_ptr<ModelAPI_Document> theSource, const int theDestID);
134
135   /// Returns the validators factory: the only one instance per application
136   MODEL_EXPORT virtual ModelAPI_ValidatorsFactory* validators();
137
138   /// Returns the filters factory: the only one instance per application
139   MODEL_EXPORT virtual ModelAPI_FiltersFactory* filters();
140
141   /// Sets the flag to check modifications outside the transaction or not
142   void setCheckTransactions(const bool theCheck)
143   {
144     myCheckTransactions = theCheck;
145   }
146
147   /// Is called only once, on startup of the application
148   Model_Session();
149
150   /// Returns the global identifier of the current transaction (needed for the update algo)
151   MODEL_EXPORT virtual int transactionID();
152
153
154   /// Returns true if auto-update in the application is blocked
155   MODEL_EXPORT virtual bool isAutoUpdateBlocked();
156
157   /// Set state of the auto-update of features result in the application
158   MODEL_EXPORT virtual void blockAutoUpdate(const bool theBlock);
159
160  protected:
161   /// Loads (if not done yet) the information about the features and plugins
162   void LoadPluginsInfo();
163
164   /// Creates the feature object using plugins functionality
165   FeaturePtr createFeature(std::string theFeatureID, Model_Document* theDocOwner);
166
167   /// Get the plugin by name. If it is not loaded, load plugin.
168   ModelAPI_Plugin* getPlugin(const std::string& thePluginName);
169
170   friend class Model_Document;
171   friend class Model_Objects;
172 };
173
174 #endif