1 // Copyright (C) 2014-2023 CEA, EDF
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 virtual ~DumpStorage() {}
96 void setFilenameSuffix(const std::string& theSuffix) { myFilenameSuffix = theSuffix; }
99 std::ostringstream& buffer() { return myDumpBuffer; }
100 std::ostringstream& fullDump() { return myFullDump; }
102 MODELHIGHAPI_EXPORT virtual void reserveBuffer();
103 MODELHIGHAPI_EXPORT virtual void restoreReservedBuffer();
106 virtual void write(const std::shared_ptr<ModelAPI_AttributeSelection>& theAttrSelect);
109 virtual bool exportTo(const std::string& theFilename, const ModulesSet& theUsedModules);
112 std::string myFilenameSuffix;
113 std::ostringstream myDumpBuffer;
114 std::ostringstream myFullDump;
116 std::stack<std::string> myDumpBufferHideout;
118 friend class ModelHighAPI_Dumper;
120 typedef std::shared_ptr<DumpStorage> DumpStoragePtr;
122 /** \class DumpStorageGeom
123 * \ingroup CPPHighAPI
124 * \brief Process selection attributes to be dumped by geometric properties.
126 class DumpStorageGeom : public DumpStorage
130 virtual void write(const std::shared_ptr<ModelAPI_AttributeSelection>& theAttrSelect);
133 /** \class DumpStorageWeak
134 * \ingroup CPPHighAPI
135 * \brief Process selection attributes to be dumped by weak naming.
137 class DumpStorageWeak : public DumpStorage
141 virtual void write(const std::shared_ptr<ModelAPI_AttributeSelection>& theAttrSelect);
145 /// Default constructor
147 ModelHighAPI_Dumper();
149 /// Sets instance of a dumper
151 static void setInstance(ModelHighAPI_Dumper* theDumper);
153 /// Returns instance of a dumper
155 static ModelHighAPI_Dumper* getInstance();
159 virtual ~ModelHighAPI_Dumper();
161 /// Add custom storage to collect corresponding dump
163 void addCustomStorage(const DumpStoragePtr& theStorage);
164 /// Clear custom storages list
166 void clearCustomStorage();
167 /// Dump given document into the file
168 /// \return \c true, if succeed
170 bool process(const std::shared_ptr<ModelAPI_Document>& theDoc, const std::string& theFileName);
172 /// Keep path to the true dumping directory.
173 /// It is used to store image files or any other external files
174 /// \param theDumpDir path to the true dumping directory
176 void setDumpDir(const std::string& theDumpDir) { myDumpDir = theDumpDir; }
177 /// Return path to the true dumping directory
178 MODELHIGHAPI_EXPORT std::string getDumpDir() const { return myDumpDir; }
180 /// Add module to list of imported modules
181 /// \param theModuleName name of the module to be imported
183 void importModule(const std::string& theModuleName);
185 /// Returns name of specified entity
186 /// \param theEntity [in] named entity
187 /// \param theSaveNotDumped [in]
188 /// if \c true, the entity should be stored as not dumped (will be dumped automatically)
189 /// \param theUseEntityName [in]
190 /// if \c true, the entity name should be used "as is" without changing default name
191 /// \return name of the entity
193 const std::string& name(const EntityPtr& theEntity, bool theSaveNotDumped = true,
194 bool theUseEntityName = false, bool theSetIsDumped = false);
196 /// Returns name of parent composite feature for specified entity
198 const std::string& parentName(const FeaturePtr& theFeature);
200 /// Dump parameter feature only
201 virtual void dumpParameter(const FeaturePtr& theFeature) = 0;
202 /// Dump given feature
203 virtual void dumpFeature(const FeaturePtr& theFeature, const bool theForce = false) = 0;
205 virtual void dumpFolder(const FolderPtr& theFolder) = 0;
207 /// Set feature postponed until all its dependencies are not dumped.
208 /// The name of the feature is stored anyway.
210 void postpone(const EntityPtr& theEntity);
212 /// Set a feature that should not be dumped anyway
214 void doNotDumpFeature(const FeaturePtr& theFeature)
215 { myFeaturesToSkip.insert(theFeature); }
217 /// Dump sub-feature name and color, without dumping feature creation.
218 /// Used for features which creates sub-features in their execute method.
219 /// \param theSubFeatureGet [in] method for getting sub-feature (e.g. "Feature_1.subFeature(0)")
220 /// \param theSubFeature [in] sub-feature
222 void dumpSubFeatureNameAndColor(const std::string theSubFeatureGet,
223 const FeaturePtr& theSubFeature);
225 /// Return name of getter for corresponding attribute
226 virtual std::string attributeGetter(const FeaturePtr& theFeature,
227 const std::string& theAttrName) const = 0;
229 /// Return name of wrapper feature
230 virtual std::string featureWrapper(const FeaturePtr& theFeature) const = 0;
234 ModelHighAPI_Dumper& operator<<(const char theChar);
237 ModelHighAPI_Dumper& operator<<(const char* theString);
240 ModelHighAPI_Dumper& operator<<(const std::string& theString);
243 ModelHighAPI_Dumper& operator<<(const std::wstring& theString);
246 ModelHighAPI_Dumper& operator<<(const bool theValue);
249 ModelHighAPI_Dumper& operator<<(const int theValue);
252 ModelHighAPI_Dumper& operator<<(const double theValue);
256 ModelHighAPI_Dumper& operator<<(ModelHighAPI_Dumper& theDumper,
257 std::basic_ostream<char>& (*theEndl)(std::basic_ostream<char>&));
259 /// Print std::endl from Python
260 MODELHIGHAPI_EXPORT void newline();
262 /// Dump GeomAPI_Pnt in the following form:
263 /// "GeomAPI_Pnt(X, Y, Z)"
265 ModelHighAPI_Dumper& operator<<(const std::shared_ptr<GeomAPI_Pnt>& thePoint);
267 /// "GeomAPI_Dir(X, Y, Z)"
269 ModelHighAPI_Dumper& operator<<(const std::shared_ptr<GeomAPI_Dir>& theDir);
271 /// Dump GeomDataAPI_Dir in the following form:
274 ModelHighAPI_Dumper& operator<<(const std::shared_ptr<GeomDataAPI_Dir>& theDir);
275 /// Dump GeomDataAPI_Point in the following form:
278 ModelHighAPI_Dumper& operator<<(const std::shared_ptr<GeomDataAPI_Point>& thePoint);
279 /// Dump GeomDataAPI_Point2D in the following form:
282 ModelHighAPI_Dumper& operator<<(const std::shared_ptr<GeomDataAPI_Point2D>& thePoint);
283 /// Dump GeomDataAPI_Point2DArray as a list of 2D points
285 ModelHighAPI_Dumper& operator<<(const std::shared_ptr<GeomDataAPI_Point2DArray>& thePointArray);
287 /// Dump AttributeBoolean
289 ModelHighAPI_Dumper& operator<<(const std::shared_ptr<ModelAPI_AttributeBoolean>& theAttrBool);
290 /// Dump AttributeInteger
292 ModelHighAPI_Dumper& operator<<(const std::shared_ptr<ModelAPI_AttributeInteger>& theAttrInt);
293 /// Dump AttributeIntArray
295 ModelHighAPI_Dumper& operator<<(const std::shared_ptr<ModelAPI_AttributeIntArray>& theArray);
296 /// Dump AttributeDouble
298 ModelHighAPI_Dumper& operator<<(const std::shared_ptr<ModelAPI_AttributeDouble>& theAttrReal);
299 /// Dump AttributeDoubleArray
301 ModelHighAPI_Dumper& operator<<(const std::shared_ptr<ModelAPI_AttributeDoubleArray>& theArray);
302 /// Dump AttributeString
304 ModelHighAPI_Dumper& operator<<(const std::shared_ptr<ModelAPI_AttributeString>& theAttrStr);
305 /// Dump name of entity and remember to dump "setName" if the entity has user-defined name
307 ModelHighAPI_Dumper& operator<<(const FeaturePtr& theEntity);
311 ModelHighAPI_Dumper& operator<<(const FolderPtr& theFolder);
315 ModelHighAPI_Dumper& operator<<(const ResultPtr& theResult);
317 /// Dump a list of results
319 ModelHighAPI_Dumper& operator<<(const std::list<ResultPtr>& theResults);
322 MODELHIGHAPI_EXPORT ModelHighAPI_Dumper&
323 operator<<(const std::shared_ptr<ModelAPI_Attribute>& theAttr);
325 MODELHIGHAPI_EXPORT ModelHighAPI_Dumper&
326 operator<<(const std::shared_ptr<ModelAPI_Object>& theObject);
328 /// Dump AttributeRefAttr
329 MODELHIGHAPI_EXPORT ModelHighAPI_Dumper&
330 operator<<(const std::shared_ptr<ModelAPI_AttributeRefAttr>& theRefAttr);
331 /// Dump AttributeRefAttrList as follows:
332 /// "[obj1, obj2, obj3, ...]"
333 MODELHIGHAPI_EXPORT ModelHighAPI_Dumper&
334 operator<<(const std::shared_ptr<ModelAPI_AttributeRefAttrList>& theRefAttrList);
335 /// Dump AttributeRefList as follows:
336 /// "[obj1, obj2, obj3, ...]"
337 MODELHIGHAPI_EXPORT ModelHighAPI_Dumper&
338 operator<<(const std::shared_ptr<ModelAPI_AttributeRefList>& theRefList);
339 /// Dump AttributeSelection
340 MODELHIGHAPI_EXPORT ModelHighAPI_Dumper&
341 operator<<(const std::shared_ptr<ModelAPI_AttributeSelection>& theAttrSelect);
342 /// Dump AttributeSelectionList
343 MODELHIGHAPI_EXPORT ModelHighAPI_Dumper&
344 operator<<(const std::shared_ptr<ModelAPI_AttributeSelectionList>& theAttrSelList);
345 /// Dump AttributeReference
346 MODELHIGHAPI_EXPORT ModelHighAPI_Dumper&
347 operator<<(const std::shared_ptr<ModelAPI_AttributeReference>& theReference);
348 /// Dump AttributeStringArray
349 MODELHIGHAPI_EXPORT ModelHighAPI_Dumper&
350 operator<<(const std::shared_ptr<ModelAPI_AttributeStringArray>& theArray);
352 /// clear list of not dumped entities
353 MODELHIGHAPI_EXPORT void clearNotDumped();
355 /// Check the entity is already dumped
357 bool isDumped(const EntityPtr& theEntity) const;
358 /// Check theRefAttr is already dumped
360 bool isDumped(const std::shared_ptr<ModelAPI_AttributeRefAttr>& theRefAttr) const;
361 /// Check all objects in theRefList are already dumped
363 bool isDumped(const std::shared_ptr<ModelAPI_AttributeRefList>& theRefList) const;
365 /// Returns the index of the first object in the list which is not dumped yet.
367 size_t indexOfFirstNotDumped(const std::shared_ptr<ModelAPI_AttributeRefList>& theRefList) const;
369 /// Export variables names to another module (calls exportVariable implemented in python)
370 MODELHIGHAPI_EXPORT virtual void exportVariables() const;
372 /// Export one variable name to another module (implemented in python)
373 MODELHIGHAPI_EXPORT virtual void exportVariable(const std::string& /*theEntry*/,
374 const std::string& /*theVarName*/) const {}
376 /// Returns \c true if the special comment line to improve the readability
377 /// should be printed before the feature of the given kind.
378 MODELHIGHAPI_EXPORT bool dumpCommentBeforeFeature(const FeaturePtr& theFeature) const;
381 /// Dump "setName" command if last entity had user-defined name
382 MODELHIGHAPI_EXPORT void dumpEntitySetName();
385 ModelHighAPI_Dumper(const ModelHighAPI_Dumper&);
386 const ModelHighAPI_Dumper& operator=(const ModelHighAPI_Dumper&);
388 /// Iterate all features in document and dump them into intermediate buffer
389 bool process(const std::shared_ptr<ModelAPI_Document>& theDoc);
391 /// Dump composite feature and all it sub-features
392 bool process(const std::shared_ptr<ModelAPI_CompositeFeature>& theComposite,
393 bool isForce = false,
394 bool isDumpModelDo = true);
396 /// Iterate all features in composite feature and dump them into intermediate buffer
397 /// \param theComposite [in] parent composite feature
398 /// \param theDumpModelDo [in] shows that command "model.do()" should be written at the end
400 bool processSubs(const std::shared_ptr<ModelAPI_CompositeFeature>& theComposite,
401 bool theDumpModelDo = false);
403 /// Stores names of results for the given feature
404 void saveResultNames(const FeaturePtr& theFeature);
406 /// Check the result feature has default color
407 bool isDefaultColor(const ResultPtr& theResult) const;
409 /// Check the result feature has default deflection
410 bool isDefaultDeflection(const ResultPtr& theResult) const;
412 /// Check the result feature has default transparency
413 bool isDefaultTransparency(const ResultPtr& theResult) const;
415 /// Dump postponed entities
416 void dumpPostponed(bool theDumpFolders = false);
420 std::string myCurrentName; ///< default name of current feature
421 std::string myUserName; ///< user-defined name
422 bool myIsDefault; ///< \c true if the name is default
423 bool myIsDumped; ///< shows that the names of the feature are already stored
427 EntityName(const std::string& theCurName, const std::string& theUserName, bool theDefault)
428 : myCurrentName(theCurName),
429 myUserName(theUserName),
430 myIsDefault(theDefault),
434 typedef std::map<EntityPtr, EntityName> EntityNameMap;
436 struct LastDumpedEntity {
437 EntityPtr myEntity; ///< last dumped entity
438 bool myUserName; ///< the entity hase user-defined name
439 /// results of this entity, which has user-defined names or specific colors
440 std::list<ResultPtr> myResults;
442 LastDumpedEntity(EntityPtr theEntity, bool theUserName,
443 const std::list<ResultPtr>& theResults = std::list<ResultPtr>())
444 : myEntity(theEntity), myUserName(theUserName), myResults(theResults)
447 typedef std::stack<LastDumpedEntity> DumpStack;
449 static ModelHighAPI_Dumper* mySelf;
451 class DumpStorageBuffer;
452 DumpStorageBuffer* myDumpStorage; ///< storage of dumped data
454 ModulesSet myModules; ///< modules and entities to be imported
455 EntityNameMap myNames; ///< names of the entities
456 DumpStack myEntitiesStack; ///< stack of dumped entities
458 NbFeaturesMap myFeatureCount; ///< number of features of each kind
460 /// features which should not be dumped (like coincidence and tangency created by tangent arc)
461 std::set<FeaturePtr> myFeaturesToSkip;
463 std::list<EntityPtr> myPostponed; ///< list of postponed entities (sketch constraints or folders)
464 bool myDumpPostponedInProgress; ///< processing postponed is in progress
466 std::string myDumpDir;
469 /// list of entities, used by other features but not dumped yet
470 std::set<EntityPtr> myNotDumpedEntities;
472 friend class SketchAPI_Sketch;
473 friend class ModelHighAPI_Folder;