1 // Copyright (C) 2014-2019 CEA/DEN, EDF R&D
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.
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.
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
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 #ifndef ModelHighAPI_Dumper_H_
21 #define ModelHighAPI_Dumper_H_
23 #include "ModelHighAPI.h"
36 class GeomDataAPI_Dir;
37 class GeomDataAPI_Point;
38 class GeomDataAPI_Point2D;
39 class GeomDataAPI_Point2DArray;
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;
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;
69 typedef std::set<std::string> ModulesSet;
70 typedef std::map<DocumentPtr, std::map<std::string, std::pair<int, int> > > NbFeaturesMap;
72 /**\class ModelHighAPI_Dumper
74 * \brief Dump engine for the model
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.
80 class ModelHighAPI_Dumper
83 /** \class DumpStorage
85 * \brief Storage for the dumped data. Process selection attributes to be dumped by naming.
91 MODELHIGHAPI_EXPORT DumpStorage(const DumpStorage& theOther);
92 MODELHIGHAPI_EXPORT const DumpStorage& operator=(const DumpStorage& theOther);
94 void setFilenameSuffix(const std::string& theSuffix) { myFilenameSuffix = theSuffix; }
97 std::ostringstream& buffer() { return myDumpBuffer; }
98 std::ostringstream& fullDump() { return myFullDump; }
100 MODELHIGHAPI_EXPORT virtual void reserveBuffer();
101 MODELHIGHAPI_EXPORT virtual void restoreReservedBuffer();
104 virtual void write(const std::shared_ptr<ModelAPI_AttributeSelection>& theAttrSelect);
107 virtual bool exportTo(const std::string& theFilename, const ModulesSet& theUsedModules);
110 std::string myFilenameSuffix;
111 std::ostringstream myDumpBuffer;
112 std::ostringstream myFullDump;
114 std::stack<std::string> myDumpBufferHideout;
116 friend class ModelHighAPI_Dumper;
118 typedef std::shared_ptr<DumpStorage> DumpStoragePtr;
120 /** \class DumpStorageGeom
121 * \ingroup CPPHighAPI
122 * \brief Process selection attributes to be dumped by geometric properties.
124 class DumpStorageGeom : public DumpStorage
128 virtual void write(const std::shared_ptr<ModelAPI_AttributeSelection>& theAttrSelect);
131 /** \class DumpStorageWeak
132 * \ingroup CPPHighAPI
133 * \brief Process selection attributes to be dumped by weak naming.
135 class DumpStorageWeak : public DumpStorage
139 virtual void write(const std::shared_ptr<ModelAPI_AttributeSelection>& theAttrSelect);
143 /// Default constructor
145 ModelHighAPI_Dumper();
147 /// Sets instance of a dumper
149 static void setInstance(ModelHighAPI_Dumper* theDumper);
151 /// Returns instance of a dumper
153 static ModelHighAPI_Dumper* getInstance();
157 virtual ~ModelHighAPI_Dumper();
159 /// Add custom storage to collect corresponding dump
161 void addCustomStorage(const DumpStoragePtr& theStorage);
162 /// Clear custom storages list
164 void clearCustomStorage();
165 /// Dump given document into the file
166 /// \return \c true, if succeed
168 bool process(const std::shared_ptr<ModelAPI_Document>& theDoc, const std::string& theFileName);
170 /// Add module to list of imported modules
171 /// \param theModuleName name of the module to be imported
173 void importModule(const std::string& theModuleName);
175 /// Returns name of specified entity
176 /// \param theEntity [in] named entity
177 /// \param theSaveNotDumped [in]
178 /// if \c true, the entity should be stored as not dumped (will be dumped automatically)
179 /// \param theUseEntityName [in]
180 /// if \c true, the entity name should be used "as is" without changing default name
181 /// \return name of the entity
183 const std::string& name(const EntityPtr& theEntity, bool theSaveNotDumped = true,
184 bool theUseEntityName = false, bool theSetIsDumped = false);
186 /// Returns name of parent composite feature for specified entity
188 const std::string& parentName(const FeaturePtr& theFeature);
190 /// Dump parameter feature only
191 virtual void dumpParameter(const FeaturePtr& theFeature) = 0;
192 /// Dump given feature
193 virtual void dumpFeature(const FeaturePtr& theFeature, const bool theForce = false) = 0;
195 virtual void dumpFolder(const FolderPtr& theFolder) = 0;
197 /// Set feature postponed until all its dependencies are not dumped.
198 /// The name of the feature is stored anyway.
200 void postpone(const EntityPtr& theEntity);
202 /// Set a feature that should not be dumped anyway
204 void doNotDumpFeature(const FeaturePtr& theFeature)
205 { myFeaturesToSkip.insert(theFeature); }
207 /// Dump sub-feature name and color, without dumping feature creation.
208 /// Used for features which creates sub-features in their execute method.
209 /// \param theSubFeatureGet [in] method for getting sub-feature (e.g. "Feature_1.subFeature(0)")
210 /// \param theSubFeature [in] sub-feature
212 void dumpSubFeatureNameAndColor(const std::string theSubFeatureGet,
213 const FeaturePtr& theSubFeature);
215 /// Return name of getter for corresponding attribute
216 virtual std::string attributeGetter(const FeaturePtr& theFeature,
217 const std::string& theAttrName) const = 0;
219 /// Return name of wrapper feature
220 virtual std::string featureWrapper(const FeaturePtr& theFeature) const = 0;
224 ModelHighAPI_Dumper& operator<<(const char theChar);
227 ModelHighAPI_Dumper& operator<<(const char* theString);
230 ModelHighAPI_Dumper& operator<<(const std::string& theString);
233 ModelHighAPI_Dumper& operator<<(const std::wstring& theString);
236 ModelHighAPI_Dumper& operator<<(const bool theValue);
239 ModelHighAPI_Dumper& operator<<(const int theValue);
242 ModelHighAPI_Dumper& operator<<(const double theValue);
246 ModelHighAPI_Dumper& operator<<(ModelHighAPI_Dumper& theDumper,
247 std::basic_ostream<char>& (*theEndl)(std::basic_ostream<char>&));
249 /// Print std::endl from Python
250 MODELHIGHAPI_EXPORT void newline();
252 /// Dump GeomAPI_Pnt in the following form:
253 /// "GeomAPI_Pnt(X, Y, Z)"
255 ModelHighAPI_Dumper& operator<<(const std::shared_ptr<GeomAPI_Pnt>& thePoint);
257 /// "GeomAPI_Dir(X, Y, Z)"
259 ModelHighAPI_Dumper& operator<<(const std::shared_ptr<GeomAPI_Dir>& theDir);
261 /// Dump GeomDataAPI_Dir in the following form:
264 ModelHighAPI_Dumper& operator<<(const std::shared_ptr<GeomDataAPI_Dir>& theDir);
265 /// Dump GeomDataAPI_Point in the following form:
268 ModelHighAPI_Dumper& operator<<(const std::shared_ptr<GeomDataAPI_Point>& thePoint);
269 /// Dump GeomDataAPI_Point2D in the following form:
272 ModelHighAPI_Dumper& operator<<(const std::shared_ptr<GeomDataAPI_Point2D>& thePoint);
273 /// Dump GeomDataAPI_Point2DArray as a list of 2D points
275 ModelHighAPI_Dumper& operator<<(const std::shared_ptr<GeomDataAPI_Point2DArray>& thePointArray);
277 /// Dump AttributeBoolean
279 ModelHighAPI_Dumper& operator<<(const std::shared_ptr<ModelAPI_AttributeBoolean>& theAttrBool);
280 /// Dump AttributeInteger
282 ModelHighAPI_Dumper& operator<<(const std::shared_ptr<ModelAPI_AttributeInteger>& theAttrInt);
283 /// Dump AttributeIntArray
285 ModelHighAPI_Dumper& operator<<(const std::shared_ptr<ModelAPI_AttributeIntArray>& theArray);
286 /// Dump AttributeDouble
288 ModelHighAPI_Dumper& operator<<(const std::shared_ptr<ModelAPI_AttributeDouble>& theAttrReal);
289 /// Dump AttributeDoubleArray
291 ModelHighAPI_Dumper& operator<<(const std::shared_ptr<ModelAPI_AttributeDoubleArray>& theArray);
292 /// Dump AttributeString
294 ModelHighAPI_Dumper& operator<<(const std::shared_ptr<ModelAPI_AttributeString>& theAttrStr);
295 /// Dump name of entity and remember to dump "setName" if the entity has user-defined name
297 ModelHighAPI_Dumper& operator<<(const FeaturePtr& theEntity);
301 ModelHighAPI_Dumper& operator<<(const FolderPtr& theFolder);
305 ModelHighAPI_Dumper& operator<<(const ResultPtr& theResult);
307 /// Dump a list of results
309 ModelHighAPI_Dumper& operator<<(const std::list<ResultPtr>& theResults);
312 MODELHIGHAPI_EXPORT ModelHighAPI_Dumper&
313 operator<<(const std::shared_ptr<ModelAPI_Attribute>& theAttr);
315 MODELHIGHAPI_EXPORT ModelHighAPI_Dumper&
316 operator<<(const std::shared_ptr<ModelAPI_Object>& theObject);
318 /// Dump AttributeRefAttr
319 MODELHIGHAPI_EXPORT ModelHighAPI_Dumper&
320 operator<<(const std::shared_ptr<ModelAPI_AttributeRefAttr>& theRefAttr);
321 /// Dump AttributeRefAttrList as follows:
322 /// "[obj1, obj2, obj3, ...]"
323 MODELHIGHAPI_EXPORT ModelHighAPI_Dumper&
324 operator<<(const std::shared_ptr<ModelAPI_AttributeRefAttrList>& theRefAttrList);
325 /// Dump AttributeRefList as follows:
326 /// "[obj1, obj2, obj3, ...]"
327 MODELHIGHAPI_EXPORT ModelHighAPI_Dumper&
328 operator<<(const std::shared_ptr<ModelAPI_AttributeRefList>& theRefList);
329 /// Dump AttributeSelection
330 MODELHIGHAPI_EXPORT ModelHighAPI_Dumper&
331 operator<<(const std::shared_ptr<ModelAPI_AttributeSelection>& theAttrSelect);
332 /// Dump AttributeSelectionList
333 MODELHIGHAPI_EXPORT ModelHighAPI_Dumper&
334 operator<<(const std::shared_ptr<ModelAPI_AttributeSelectionList>& theAttrSelList);
335 /// Dump AttributeReference
336 MODELHIGHAPI_EXPORT ModelHighAPI_Dumper&
337 operator<<(const std::shared_ptr<ModelAPI_AttributeReference>& theReference);
338 /// Dump AttributeStringArray
339 MODELHIGHAPI_EXPORT ModelHighAPI_Dumper&
340 operator<<(const std::shared_ptr<ModelAPI_AttributeStringArray>& theArray);
342 /// clear list of not dumped entities
343 MODELHIGHAPI_EXPORT void clearNotDumped();
345 /// Check the entity is already dumped
347 bool isDumped(const EntityPtr& theEntity) const;
348 /// Check theRefAttr is already dumped
350 bool isDumped(const std::shared_ptr<ModelAPI_AttributeRefAttr>& theRefAttr) const;
351 /// Check all objects in theRefList are already dumped
353 bool isDumped(const std::shared_ptr<ModelAPI_AttributeRefList>& theRefList) const;
355 /// Export variables names to another module (calls exportVariable implemented in python)
356 MODELHIGHAPI_EXPORT virtual void exportVariables() const;
358 /// Export one variable name to another module (implemented in python)
359 MODELHIGHAPI_EXPORT virtual void exportVariable(
360 const std::string& theEntry, const std::string& theVarName) const {}
362 /// Returns \c true if the special comment line to improve the readability
363 /// should be printed before the feature of the given kind.
364 MODELHIGHAPI_EXPORT bool dumpCommentBeforeFeature(const FeaturePtr& theFeature) const;
367 /// Dump "setName" command if last entity had user-defined name
368 MODELHIGHAPI_EXPORT void dumpEntitySetName();
371 ModelHighAPI_Dumper(const ModelHighAPI_Dumper&);
372 const ModelHighAPI_Dumper& operator=(const ModelHighAPI_Dumper&);
374 /// Iterate all features in document and dump them into intermediate buffer
375 bool process(const std::shared_ptr<ModelAPI_Document>& theDoc);
377 /// Dump composite feature and all it sub-features
378 bool process(const std::shared_ptr<ModelAPI_CompositeFeature>& theComposite,
379 bool isForce = false,
380 bool isDumpModelDo = true);
382 /// Iterate all features in composite feature and dump them into intermediate buffer
383 /// \param theComposite [in] parent composite feature
384 /// \param theDumpModelDo [in] shows that command "model.do()" should be written at the end
386 bool processSubs(const std::shared_ptr<ModelAPI_CompositeFeature>& theComposite,
387 bool theDumpModelDo = false);
389 /// Stores names of results for the given feature
390 void saveResultNames(const FeaturePtr& theFeature);
392 /// Check the result feature has default color
393 bool isDefaultColor(const ResultPtr& theResult) const;
395 /// Check the result feature has default deflection
396 bool isDefaultDeflection(const ResultPtr& theResult) const;
398 /// Check the result feature has default transparency
399 bool isDefaultTransparency(const ResultPtr& theResult) const;
401 /// Dump postponed entities
402 void dumpPostponed(bool theDumpFolders = false);
406 std::string myCurrentName; ///< default name of current feature
407 std::string myUserName; ///< user-defined name
408 bool myIsDefault; ///< \c true if the name is default
409 bool myIsDumped; ///< shows that the names of the feature are already stored
413 EntityName(const std::string& theCurName, const std::string& theUserName, bool theDefault)
414 : myCurrentName(theCurName),
415 myUserName(theUserName),
416 myIsDefault(theDefault),
420 typedef std::map<EntityPtr, EntityName> EntityNameMap;
422 struct LastDumpedEntity {
423 EntityPtr myEntity; ///< last dumped entity
424 bool myUserName; ///< the entity hase user-defined name
425 /// results of this entity, which has user-defined names or specific colors
426 std::list<ResultPtr> myResults;
428 LastDumpedEntity(EntityPtr theEntity, bool theUserName,
429 const std::list<ResultPtr>& theResults = std::list<ResultPtr>())
430 : myEntity(theEntity), myUserName(theUserName), myResults(theResults)
433 typedef std::stack<LastDumpedEntity> DumpStack;
435 static ModelHighAPI_Dumper* mySelf;
437 class DumpStorageBuffer;
438 DumpStorageBuffer* myDumpStorage; ///< storage of dumped data
440 ModulesSet myModules; ///< modules and entities to be imported
441 EntityNameMap myNames; ///< names of the entities
442 DumpStack myEntitiesStack; ///< stack of dumped entities
444 NbFeaturesMap myFeatureCount; ///< number of features of each kind
446 /// features which should not be dumped (like coincidence and tangency created by tangent arc)
447 std::set<FeaturePtr> myFeaturesToSkip;
449 std::list<EntityPtr> myPostponed; ///< list of postponed entities (sketch constraints or folders)
450 bool myDumpPostponedInProgress; ///< processing postponed is in progress
453 /// list of entities, used by other features but not dumped yet
454 std::set<EntityPtr> myNotDumpedEntities;
456 friend class SketchAPI_Sketch;
457 friend class ModelHighAPI_Folder;