Salome HOME
IMP 23373: [CEA 1170] Optimization of a 3D mesh using MG-Tetra
[modules/smesh.git] / src / SMESH_I / SMESH_PythonDump.hxx
1 // Copyright (C) 2007-2016  CEA/DEN, EDF R&D, OPEN CASCADE
2 //
3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
5 //
6 // This library is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 2.1 of the License, or (at your option) any later version.
10 //
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14 // Lesser General Public License for more details.
15 //
16 // You should have received a copy of the GNU Lesser General Public
17 // License along with this library; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
19 //
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 //
22
23 #ifndef _SMESH_PYTHONDUMP_HXX_
24 #define _SMESH_PYTHONDUMP_HXX_
25
26 #include "SMESH.hxx"
27
28 #include <SALOMEconfig.h>
29 #include CORBA_SERVER_HEADER(SMESH_Mesh)
30 #include CORBA_SERVER_HEADER(SMESH_MeshEditor)
31 #include CORBA_SERVER_HEADER(GEOM_Gen)
32 #include CORBA_SERVER_HEADER(SALOMEDS)
33
34 #include <TCollection_AsciiString.hxx>
35 #include <Resource_DataMapOfAsciiStringAsciiString.hxx>
36
37 #include <sstream>
38 #include <vector>
39 #include <set>
40 #include <list>
41
42 class SMESH_Gen_i;
43 class SMESH_MeshEditor_i;
44
45 // ===========================================================================================
46 /*!
47  * \brief Tool converting SMESH engine calls into commands defined in smeshBuilder.py
48  *
49  * Implementation is in SMESH_2smeshpy.cxx
50  */
51 // ===========================================================================================
52
53 class SMESH_2smeshpy
54 {
55 public:
56   /*!
57    * \brief Convert a python script using commands of smeshBuilder.py
58    * \param theScript - the Input script to convert
59    * \param theEntry2AccessorMethod - returns method names to access to
60    *        objects wrapped with python class
61    * \param theObjectNames - names of objects
62    * \param theRemovedObjIDs - entries of objects whose created commands were removed
63    * \param theHistoricalDump - true means to keep all commands, false means
64    *        to exclude commands relating to objects removed from study
65    * \retval TCollection_AsciiString - Convertion result
66    */
67   static void
68   ConvertScript(std::list< TCollection_AsciiString >&     theScriptLines,
69                 Resource_DataMapOfAsciiStringAsciiString& theEntry2AccessorMethod,
70                 Resource_DataMapOfAsciiStringAsciiString& theObjectNames,
71                 std::set< TCollection_AsciiString >&      theRemovedObjIDs,
72                 SALOMEDS::Study_ptr&                      theStudy,
73                 const bool                                theHistoricalDump);
74
75   /*!
76    * \brief Return the name of the python file wrapping IDL API
77     * \retval const char* - the file name
78    */
79   static const char* SmeshpyName() { return "smesh"; }
80   static const char* GenName() { return "smesh"; }
81 };
82
83 namespace SMESH
84 {
85   class FilterLibrary_i;
86   class FilterManager_i;
87   class Filter_i;
88   class Functor_i;
89   class Measurements_i;
90
91   // ===========================================================================================
92   /*!
93    * \brief Object used to make TPythonDump know that its held value can be a varible
94    *
95    * TPythonDump substitute TVar with names of notebook variables if any.
96    */
97   // ===========================================================================================
98
99   struct SMESH_I_EXPORT TVar
100   {
101     std::vector< std::string > myVals;
102     bool                       myIsList;
103     TVar(CORBA::Double value);
104     TVar(CORBA::Long   value);
105     TVar(CORBA::Short  value);
106     TVar(const SMESH::double_array& value);
107     // string used to temporary quote variable names in order
108     // not to confuse variables with string arguments
109     static char Quote() { return '$'; }
110     // string preceding an entry of object storing the attribute holding var names
111     static const char* ObjPrefix() { return " # OBJ: "; }
112   };
113
114   // ===========================================================================================
115   /*!
116    * \brief Utility helping in storing SMESH engine calls as python commands
117    */
118   // ===========================================================================================
119
120   class SMESH_I_EXPORT TPythonDump
121   {
122     std::ostringstream myStream;
123     static size_t      myCounter;
124     int                myVarsCounter; // counts stored TVar's
125   public:
126     TPythonDump();
127     virtual ~TPythonDump();
128
129     TPythonDump&
130     operator<<(const TVar& theVariableValue);
131
132     TPythonDump&
133     operator<<(long int theArg);
134
135     TPythonDump&
136     operator<<(int theArg);
137
138     TPythonDump&
139     operator<<(double theArg);
140
141     TPythonDump&
142     operator<<(float theArg);
143
144     TPythonDump&
145     operator<<(const void* theArg);
146
147     TPythonDump&
148     operator<<(const char* theArg);
149
150     TPythonDump&
151     operator<<(const SMESH::ElementType& theArg);
152
153     TPythonDump&
154     operator<<(const SMESH::GeometryType& theArg);
155
156     TPythonDump&
157     operator<<(const SMESH::EntityType& theArg);
158
159     TPythonDump&
160     operator<<(const SMESH::long_array& theArg);
161
162     TPythonDump&
163     operator<<(const SMESH::double_array& theArg);
164
165     TPythonDump&
166     operator<<(const SMESH::string_array& theArg);
167
168     TPythonDump&
169     operator<<(const SMESH::nodes_array& theArg);
170
171     TPythonDump&
172     operator<<(SMESH::SMESH_Hypothesis_ptr theArg);
173
174     TPythonDump&
175     operator<<(SMESH::SMESH_IDSource_ptr theArg);
176
177     TPythonDump&
178     operator<<(SALOMEDS::SObject_ptr theArg);
179
180     TPythonDump&
181     operator<<(CORBA::Object_ptr theArg);
182
183     TPythonDump&
184     operator<<(SMESH::FilterLibrary_i* theArg);
185
186     TPythonDump&
187     operator<<(SMESH::FilterManager_i* theArg);
188
189     TPythonDump&
190     operator<<(SMESH::Filter_i* theArg);
191
192     TPythonDump&
193     operator<<(SMESH::Functor_i* theArg);
194
195     TPythonDump&
196     operator<<(SMESH::Measurements_i* theArg);
197
198     TPythonDump&
199     operator<<(SMESH_Gen_i* theArg);
200
201     TPythonDump&
202     operator<<(SMESH_MeshEditor_i* theArg);
203
204     TPythonDump&
205     operator<<(SMESH::MED_VERSION theArg);
206
207     TPythonDump&
208     operator<<(const SMESH::AxisStruct & theAxis);
209
210     TPythonDump&
211     operator<<(const SMESH::DirStruct & theDir);
212
213     TPythonDump&
214     operator<<(const SMESH::PointStruct & P);
215
216     TPythonDump&
217     operator<<(const TCollection_AsciiString & theArg);
218
219     TPythonDump&
220     operator<<(const SMESH::ListOfGroups& theList);
221
222     TPythonDump&
223     operator<<(const SMESH::ListOfGroups * theList);
224
225     TPythonDump&
226     operator<<(const GEOM::ListOfGO& theList);
227
228     TPythonDump&
229     operator<<(const GEOM::ListOfGBO& theList);
230
231     TPythonDump&
232     operator<<(const SMESH::ListOfIDSources& theList);
233
234     TPythonDump&
235     operator<<(const SMESH::CoincidentFreeBorders& theCFB);
236
237     TPythonDump&
238     operator<<(const std::string& theArg);
239
240     static const char* SMESHGenName() { return "smeshgen"; }
241     static const char* MeshEditorName() { return "mesh_editor"; }
242     static const char* NotPublishedObjectName();
243
244     /*!
245      * \brief Return marker of long string literal beginning
246       * \param type - a name of functionality producing the string literal
247       * \retval TCollection_AsciiString - the marker string to be written into
248       * a raw python script
249      */
250     static TCollection_AsciiString LongStringStart(const char* type);
251     /*!
252      * \brief Return marker of long string literal end
253       * \retval TCollection_AsciiString - the marker string to be written into
254       * a raw python script
255      */
256     static TCollection_AsciiString LongStringEnd();
257     /*!
258      * \brief Cut out a long string literal from a string
259       * \param theText - text possibly containing string literals
260       * \param theFrom - position in the text to search from
261       * \param theLongString - the retrieved literal
262       * \param theStringType - a name of functionality produced the literal
263       * \retval bool - true if a string literal found
264      *
265      * The literal is removed from theText; theFrom points position right after
266      * the removed literal
267      */
268     static bool  CutoutLongString( TCollection_AsciiString & theText,
269                                    int                     & theFrom,
270                                    TCollection_AsciiString & theLongString,
271                                    TCollection_AsciiString & theStringType);
272   };
273 }
274
275 #endif