]> SALOME platform Git repositories - modules/shaper.git/blob - src/ModelHighAPI/ModelHighAPI_Dumper.h
Salome HOME
984ca70e28dd147c430112381da8361df71dbb1b
[modules/shaper.git] / src / ModelHighAPI / ModelHighAPI_Dumper.h
1 // Copyright (C) 2014-2020  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 ModelHighAPI_Dumper_H_
21 #define ModelHighAPI_Dumper_H_
22
23 #include "ModelHighAPI.h"
24
25 #include <list>
26 #include <map>
27 #include <memory>
28 #include <set>
29 #include <sstream>
30 #include <stack>
31 #include <string>
32
33 class GeomAPI_Pnt;
34 class GeomAPI_Dir;
35
36 class GeomDataAPI_Dir;
37 class GeomDataAPI_Point;
38 class GeomDataAPI_Point2D;
39 class GeomDataAPI_Point2DArray;
40
41 class ModelAPI_Attribute;
42 class ModelAPI_AttributeBoolean;
43 class ModelAPI_AttributeDouble;
44 class ModelAPI_AttributeDoubleArray;
45 class ModelAPI_AttributeIntArray;
46 class ModelAPI_AttributeInteger;
47 class ModelAPI_AttributeRefAttr;
48 class ModelAPI_AttributeRefAttrList;
49 class ModelAPI_AttributeReference;
50 class ModelAPI_AttributeRefList;
51 class ModelAPI_AttributeSelection;
52 class ModelAPI_AttributeSelectionList;
53 class ModelAPI_AttributeString;
54 class ModelAPI_AttributeStringArray;
55 class ModelAPI_CompositeFeature;
56 class ModelAPI_Document;
57 class ModelAPI_Entity;
58 class ModelAPI_Feature;
59 class ModelAPI_Folder;
60 class ModelAPI_Object;
61 class ModelAPI_Result;
62
63 typedef std::shared_ptr<ModelAPI_Document> DocumentPtr;
64 typedef std::shared_ptr<ModelAPI_Entity>   EntityPtr;
65 typedef std::shared_ptr<ModelAPI_Feature>  FeaturePtr;
66 typedef std::shared_ptr<ModelAPI_Folder>   FolderPtr;
67 typedef std::shared_ptr<ModelAPI_Result>   ResultPtr;
68
69 typedef std::set<std::string>                                                ModulesSet;
70 typedef std::map<DocumentPtr, std::map<std::string, std::pair<int, int> > >  NbFeaturesMap;
71
72 /**\class ModelHighAPI_Dumper
73  * \ingroup CPPHighAPI
74  * \brief Dump engine for the model
75  *
76  * The dumper can be customized by the set of storages (DumpStorage), for example to identify
77  * dumped selected objects by their geometrical properties. By default, the dump is executed to
78  * store original names of the selected shapes.
79  */
80 class ModelHighAPI_Dumper
81 {
82 public:
83   /** \class DumpStorage
84    *  \ingroup CPPHighAPI
85    *  \brief Storage for the dumped data. Process selection attributes to be dumped by naming.
86    */
87   class DumpStorage
88   {
89   public:
90     DumpStorage() {}
91     MODELHIGHAPI_EXPORT DumpStorage(const DumpStorage& theOther);
92     MODELHIGHAPI_EXPORT const DumpStorage& operator=(const DumpStorage& theOther);
93
94     virtual ~DumpStorage() {}
95
96     void setFilenameSuffix(const std::string& theSuffix) { myFilenameSuffix = theSuffix; }
97
98   protected:
99     std::ostringstream& buffer() { return myDumpBuffer; }
100     std::ostringstream& fullDump() { return myFullDump; }
101
102     MODELHIGHAPI_EXPORT virtual void reserveBuffer();
103     MODELHIGHAPI_EXPORT virtual void restoreReservedBuffer();
104
105     MODELHIGHAPI_EXPORT
106     virtual void write(const std::shared_ptr<ModelAPI_AttributeSelection>& theAttrSelect);
107
108     MODELHIGHAPI_EXPORT
109     virtual bool exportTo(const std::string& theFilename, const ModulesSet& theUsedModules);
110
111   private:
112     std::string myFilenameSuffix;
113     std::ostringstream myDumpBuffer;
114     std::ostringstream myFullDump;
115
116     std::stack<std::string> myDumpBufferHideout;
117
118     friend class ModelHighAPI_Dumper;
119   };
120   typedef std::shared_ptr<DumpStorage> DumpStoragePtr;
121
122   /** \class DumpStorageGeom
123    *  \ingroup CPPHighAPI
124    *  \brief Process selection attributes to be dumped by geometric properties.
125    */
126   class DumpStorageGeom : public DumpStorage
127   {
128   protected:
129     MODELHIGHAPI_EXPORT
130     virtual void write(const std::shared_ptr<ModelAPI_AttributeSelection>& theAttrSelect);
131   };
132
133   /** \class DumpStorageWeak
134    *  \ingroup CPPHighAPI
135    *  \brief Process selection attributes to be dumped by weak naming.
136    */
137   class DumpStorageWeak : public DumpStorage
138   {
139   protected:
140     MODELHIGHAPI_EXPORT
141     virtual void write(const std::shared_ptr<ModelAPI_AttributeSelection>& theAttrSelect);
142   };
143
144 public:
145   /// Default constructor
146   MODELHIGHAPI_EXPORT
147   ModelHighAPI_Dumper();
148
149   /// Sets instance of a dumper
150   MODELHIGHAPI_EXPORT
151   static void setInstance(ModelHighAPI_Dumper* theDumper);
152
153   /// Returns instance of a dumper
154   MODELHIGHAPI_EXPORT
155   static ModelHighAPI_Dumper* getInstance();
156
157   /// Destructor
158   MODELHIGHAPI_EXPORT
159   virtual ~ModelHighAPI_Dumper();
160
161   /// Add custom storage to collect corresponding dump
162   MODELHIGHAPI_EXPORT
163   void addCustomStorage(const DumpStoragePtr& theStorage);
164   /// Clear custom storages list
165   MODELHIGHAPI_EXPORT
166   void clearCustomStorage();
167   /// Dump given document into the file
168   /// \return \c true, if succeed
169   MODELHIGHAPI_EXPORT
170   bool process(const std::shared_ptr<ModelAPI_Document>& theDoc, const std::string& theFileName);
171
172   /// Add module to list of imported modules
173   /// \param theModuleName  name of the module to be imported
174   MODELHIGHAPI_EXPORT
175   void importModule(const std::string& theModuleName);
176
177   /// Returns name of specified entity
178   /// \param theEntity        [in] named entity
179   /// \param theSaveNotDumped [in]
180   ///    if \c true, the entity should be stored as not dumped (will be dumped automatically)
181   /// \param theUseEntityName [in]
182   ///    if \c true, the entity name should be used "as is" without changing default name
183   /// \return name of the entity
184   MODELHIGHAPI_EXPORT
185   const std::string& name(const EntityPtr& theEntity, bool theSaveNotDumped = true,
186                           bool theUseEntityName = false);
187
188   /// Returns name of parent composite feature for specified entity
189   MODELHIGHAPI_EXPORT
190   const std::string& parentName(const FeaturePtr& theFeature);
191
192   /// Dump parameter feature only
193   virtual void dumpParameter(const FeaturePtr& theFeature) = 0;
194   /// Dump given feature
195   virtual void dumpFeature(const FeaturePtr& theFeature, const bool theForce = false) = 0;
196   /// Dump folder
197   virtual void dumpFolder(const FolderPtr& theFolder) = 0;
198
199   /// Set feature postponed until all its dependencies are not dumped.
200   /// The name of the feature is stored anyway.
201   MODELHIGHAPI_EXPORT
202   void postpone(const EntityPtr& theEntity);
203
204   /// Set a feature that should not be dumped anyway
205   MODELHIGHAPI_EXPORT
206   void doNotDumpFeature(const FeaturePtr& theFeature)
207   { myFeaturesToSkip.insert(theFeature); }
208
209   /// Dump sub-feature name and color, without dumping feature creation.
210   /// Used for features which creates sub-features in their execute method.
211   /// \param theSubFeatureGet [in] method for getting sub-feature (e.g. "Feature_1.subFeature(0)")
212   /// \param theSubFeature    [in] sub-feature
213   MODELHIGHAPI_EXPORT
214   void dumpSubFeatureNameAndColor(const std::string theSubFeatureGet,
215                                   const FeaturePtr& theSubFeature);
216
217   /// Return name of getter for corresponding attribute
218   virtual std::string attributeGetter(const FeaturePtr& theFeature,
219                                       const std::string& theAttrName) const = 0;
220
221   /// Return name of wrapper feature
222   virtual std::string featureWrapper(const FeaturePtr& theFeature) const = 0;
223
224   /// Dump character
225   MODELHIGHAPI_EXPORT
226   ModelHighAPI_Dumper& operator<<(const char theChar);
227   /// Dump string
228   MODELHIGHAPI_EXPORT
229   ModelHighAPI_Dumper& operator<<(const char* theString);
230   /// Dump string
231   MODELHIGHAPI_EXPORT
232   ModelHighAPI_Dumper& operator<<(const std::string& theString);
233   /// Dump boolean
234   MODELHIGHAPI_EXPORT
235   ModelHighAPI_Dumper& operator<<(const bool theValue);
236   /// Dump integer
237   MODELHIGHAPI_EXPORT
238   ModelHighAPI_Dumper& operator<<(const int theValue);
239   /// Dump real
240   MODELHIGHAPI_EXPORT
241   ModelHighAPI_Dumper& operator<<(const double theValue);
242   /// Dump std::endl
243   friend
244   MODELHIGHAPI_EXPORT
245   ModelHighAPI_Dumper& operator<<(ModelHighAPI_Dumper& theDumper,
246                                 std::basic_ostream<char>& (*theEndl)(std::basic_ostream<char>&));
247
248   /// Dump GeomAPI_Pnt in the following form:
249   /// "GeomAPI_Pnt(X, Y, Z)"
250   MODELHIGHAPI_EXPORT
251   ModelHighAPI_Dumper& operator<<(const std::shared_ptr<GeomAPI_Pnt>& thePoint);
252   /// Dump GeomAPI_Dir
253   /// "GeomAPI_Dir(X, Y, Z)"
254   MODELHIGHAPI_EXPORT
255   ModelHighAPI_Dumper& operator<<(const std::shared_ptr<GeomAPI_Dir>& theDir);
256
257   /// Dump GeomDataAPI_Dir in the following form:
258   /// "X, Y, Z"
259   MODELHIGHAPI_EXPORT
260   ModelHighAPI_Dumper& operator<<(const std::shared_ptr<GeomDataAPI_Dir>& theDir);
261   /// Dump GeomDataAPI_Point in the following form:
262   /// "X, Y, Z"
263   MODELHIGHAPI_EXPORT
264   ModelHighAPI_Dumper& operator<<(const std::shared_ptr<GeomDataAPI_Point>& thePoint);
265   /// Dump GeomDataAPI_Point2D in the following form:
266   /// "X, Y"
267   MODELHIGHAPI_EXPORT
268   ModelHighAPI_Dumper& operator<<(const std::shared_ptr<GeomDataAPI_Point2D>& thePoint);
269   /// Dump GeomDataAPI_Point2DArray as a list of 2D points
270   MODELHIGHAPI_EXPORT
271   ModelHighAPI_Dumper& operator<<(const std::shared_ptr<GeomDataAPI_Point2DArray>& thePointArray);
272
273   /// Dump AttributeBoolean
274   MODELHIGHAPI_EXPORT
275   ModelHighAPI_Dumper& operator<<(const std::shared_ptr<ModelAPI_AttributeBoolean>& theAttrBool);
276   /// Dump AttributeInteger
277   MODELHIGHAPI_EXPORT
278   ModelHighAPI_Dumper& operator<<(const std::shared_ptr<ModelAPI_AttributeInteger>& theAttrInt);
279   /// Dump AttributeIntArray
280   MODELHIGHAPI_EXPORT
281   ModelHighAPI_Dumper& operator<<(const std::shared_ptr<ModelAPI_AttributeIntArray>& theArray);
282   /// Dump AttributeDouble
283   MODELHIGHAPI_EXPORT
284   ModelHighAPI_Dumper& operator<<(const std::shared_ptr<ModelAPI_AttributeDouble>& theAttrReal);
285   /// Dump AttributeDoubleArray
286   MODELHIGHAPI_EXPORT
287   ModelHighAPI_Dumper& operator<<(const std::shared_ptr<ModelAPI_AttributeDoubleArray>& theArray);
288   /// Dump AttributeString
289   MODELHIGHAPI_EXPORT
290   ModelHighAPI_Dumper& operator<<(const std::shared_ptr<ModelAPI_AttributeString>& theAttrStr);
291   /// Dump name of entity and remember to dump "setName" if the entity has user-defined name
292   MODELHIGHAPI_EXPORT
293   ModelHighAPI_Dumper& operator<<(const FeaturePtr& theEntity);
294
295   /// Dump folder
296   MODELHIGHAPI_EXPORT
297   ModelHighAPI_Dumper& operator<<(const FolderPtr& theFolder);
298
299   /// Dump result
300   MODELHIGHAPI_EXPORT
301   ModelHighAPI_Dumper& operator<<(const ResultPtr& theResult);
302
303   /// Dump a list of results
304   MODELHIGHAPI_EXPORT
305   ModelHighAPI_Dumper& operator<<(const std::list<ResultPtr>& theResults);
306
307   /// Dump Attribute
308   MODELHIGHAPI_EXPORT ModelHighAPI_Dumper&
309     operator<<(const std::shared_ptr<ModelAPI_Attribute>& theAttr);
310   /// Dump Object
311   MODELHIGHAPI_EXPORT ModelHighAPI_Dumper&
312     operator<<(const std::shared_ptr<ModelAPI_Object>& theObject);
313
314   /// Dump AttributeRefAttr
315   MODELHIGHAPI_EXPORT ModelHighAPI_Dumper&
316     operator<<(const std::shared_ptr<ModelAPI_AttributeRefAttr>& theRefAttr);
317   /// Dump AttributeRefAttrList as follows:
318   /// "[obj1, obj2, obj3, ...]"
319   MODELHIGHAPI_EXPORT ModelHighAPI_Dumper&
320     operator<<(const std::shared_ptr<ModelAPI_AttributeRefAttrList>& theRefAttrList);
321   /// Dump AttributeRefList as follows:
322   /// "[obj1, obj2, obj3, ...]"
323   MODELHIGHAPI_EXPORT ModelHighAPI_Dumper&
324     operator<<(const std::shared_ptr<ModelAPI_AttributeRefList>& theRefList);
325   /// Dump AttributeSelection
326   MODELHIGHAPI_EXPORT ModelHighAPI_Dumper&
327     operator<<(const std::shared_ptr<ModelAPI_AttributeSelection>& theAttrSelect);
328   /// Dump AttributeSelectionList
329   MODELHIGHAPI_EXPORT ModelHighAPI_Dumper&
330     operator<<(const std::shared_ptr<ModelAPI_AttributeSelectionList>& theAttrSelList);
331   /// Dump AttributeReference
332   MODELHIGHAPI_EXPORT ModelHighAPI_Dumper&
333   operator<<(const std::shared_ptr<ModelAPI_AttributeReference>& theReference);
334   /// Dump AttributeStringArray
335   MODELHIGHAPI_EXPORT ModelHighAPI_Dumper&
336     operator<<(const std::shared_ptr<ModelAPI_AttributeStringArray>& theArray);
337
338   /// clear list of not dumped entities
339   MODELHIGHAPI_EXPORT void clearNotDumped();
340
341   /// Check the entity is already dumped
342   MODELHIGHAPI_EXPORT
343   bool isDumped(const EntityPtr& theEntity) const;
344   /// Check theRefAttr is already dumped
345   MODELHIGHAPI_EXPORT
346   bool isDumped(const std::shared_ptr<ModelAPI_AttributeRefAttr>& theRefAttr) const;
347   /// Check all objects in theRefList are already dumped
348   MODELHIGHAPI_EXPORT
349   bool isDumped(const std::shared_ptr<ModelAPI_AttributeRefList>& theRefList) const;
350
351   /// Export variables names to another module (calls exportVariable implemented in python)
352   MODELHIGHAPI_EXPORT virtual void exportVariables() const;
353
354   /// Export one variable name to another module (implemented in python)
355   MODELHIGHAPI_EXPORT virtual void exportVariable(
356     const std::string& theEntry, const std::string& theVarName) const {}
357
358 protected:
359   /// Dump "setName" command if last entity had user-defined name
360   MODELHIGHAPI_EXPORT void dumpEntitySetName();
361
362 private:
363   ModelHighAPI_Dumper(const ModelHighAPI_Dumper&);
364   const ModelHighAPI_Dumper& operator=(const ModelHighAPI_Dumper&);
365
366   /// Iterate all features in document and dump them into intermediate buffer
367   bool process(const std::shared_ptr<ModelAPI_Document>& theDoc);
368
369   /// Dump composite feature and all it sub-features
370   bool process(const std::shared_ptr<ModelAPI_CompositeFeature>& theComposite,
371                bool isForce = false,
372                bool isDumpModelDo = true);
373
374   /// Iterate all features in composite feature and dump them into intermediate buffer
375   /// \param theComposite   [in] parent composite feature
376   /// \param theDumpModelDo [in] shows that command "model.do()" should be written at the end
377   MODELHIGHAPI_EXPORT
378   bool processSubs(const std::shared_ptr<ModelAPI_CompositeFeature>& theComposite,
379                    bool theDumpModelDo = false);
380
381   /// Stores names of results for the given feature
382   void saveResultNames(const FeaturePtr& theFeature);
383
384   /// Check the result feature has default color
385   bool isDefaultColor(const ResultPtr& theResult) const;
386
387   /// Check the result feature has default deflection
388   bool isDefaultDeflection(const ResultPtr& theResult) const;
389
390   /// Check the result feature has default transparency
391   bool isDefaultTransparency(const ResultPtr& theResult) const;
392
393   /// Dump postponed entities
394   void dumpPostponed(bool theDumpFolders = false);
395
396 private:
397   struct EntityName {
398     std::string myCurrentName; ///< default name of current feature
399     std::string myUserName;    ///< user-defined name
400     bool        myIsDefault;   ///< \c true if the name is default
401     bool        myIsDumped;    ///< shows that the names of the feature are already stored
402
403     EntityName() {}
404
405     EntityName(const std::string& theCurName, const std::string& theUserName, bool theDefault)
406       : myCurrentName(theCurName),
407         myUserName(theUserName),
408         myIsDefault(theDefault),
409         myIsDumped(false)
410     {}
411   };
412   typedef std::map<EntityPtr, EntityName> EntityNameMap;
413
414   struct LastDumpedEntity {
415     EntityPtr            myEntity;   ///< last dumped entity
416     bool                 myUserName; ///< the entity hase user-defined name
417     /// results of this entity, which has user-defined names or specific colors
418     std::list<ResultPtr> myResults;
419
420     LastDumpedEntity(EntityPtr theEntity, bool theUserName,
421       const std::list<ResultPtr>& theResults = std::list<ResultPtr>())
422       : myEntity(theEntity), myUserName(theUserName), myResults(theResults)
423     {}
424   };
425   typedef std::stack<LastDumpedEntity> DumpStack;
426
427   static ModelHighAPI_Dumper* mySelf;
428
429   class DumpStorageBuffer;
430   DumpStorageBuffer*  myDumpStorage;        ///< storage of dumped data
431
432   ModulesSet          myModules;            ///< modules and entities to be imported
433   EntityNameMap       myNames;              ///< names of the entities
434   DumpStack           myEntitiesStack;      ///< stack of dumped entities
435
436   NbFeaturesMap       myFeatureCount;       ///< number of features of each kind
437
438   /// features which should not be dumped (like coincidence and tangency created by tangent arc)
439   std::set<FeaturePtr> myFeaturesToSkip;
440
441   std::list<EntityPtr> myPostponed; ///< list of postponed entities (sketch constraints or folders)
442   bool myDumpPostponedInProgress; ///< processing postponed is in progress
443
444 protected:
445   /// list of entities, used by other features but not dumped yet
446   std::set<EntityPtr> myNotDumpedEntities;
447
448   friend class SketchAPI_Sketch;
449   friend class ModelHighAPI_Folder;
450 };
451
452 #endif