1 // Copyright (C) 2007-2012 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
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.
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.
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
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
23 #ifndef _SMESH_PYTHONDUMP_HXX_
24 #define _SMESH_PYTHONDUMP_HXX_
28 #include <SALOMEconfig.h>
29 #include CORBA_SERVER_HEADER(SMESH_Mesh)
30 #include CORBA_SERVER_HEADER(SALOMEDS)
36 class SMESH_MeshEditor_i;
37 class TCollection_AsciiString;
38 class Resource_DataMapOfAsciiStringAsciiString;
40 // ===========================================================================================
42 * \brief Tool converting SMESH engine calls into commands defined in smeshDC.py
44 * Implementation is in SMESH_2smeshpy.cxx
46 // ===========================================================================================
52 * \brief Convert a python script using commands of smesh.py
53 * \param theScript - Input script
54 * \param theEntry2AccessorMethod - The returning method names to access to
55 * objects wrapped with python class
56 * \param theHistoricalDump - true means to keep all commands, false means
57 * to exclude commands relating to objects removed from study
58 * \retval TCollection_AsciiString - Convertion result
60 static TCollection_AsciiString
61 ConvertScript(const TCollection_AsciiString& theScript,
62 Resource_DataMapOfAsciiStringAsciiString& theEntry2AccessorMethod,
63 Resource_DataMapOfAsciiStringAsciiString& theObjectNames,
64 SALOMEDS::Study_ptr& theStudy,
65 const bool theHistoricalDump);
68 * \brief Return the name of the python file wrapping IDL API
69 * \retval const char* - the file name
71 static const char* SmeshpyName() { return "smesh"; }
72 static const char* GenName() { return "smesh"; }
77 class FilterLibrary_i;
78 class FilterManager_i;
83 // ===========================================================================================
85 * \brief Object used to make TPythonDump know that its held value can be a varible
87 * TPythonDump substitute TVar with names of notebook variables if any.
89 // ===========================================================================================
91 struct SMESH_I_EXPORT TVar
93 std::vector< std::string > myVals;
94 TVar(CORBA::Double value);
95 TVar(CORBA::Long value);
96 TVar(CORBA::Short value);
97 TVar(const SMESH::double_array& value);
98 // string used to temporary quote variable names in order
99 // not to confuse variables with string arguments
100 static char Quote() { return '$'; }
103 // ===========================================================================================
105 * \brief Utility helping in storing SMESH engine calls as python commands
107 // ===========================================================================================
109 class SMESH_I_EXPORT TPythonDump
111 std::ostringstream myStream;
112 static size_t myCounter;
113 int myVarsCounter; // counts stored TVar's
116 virtual ~TPythonDump();
119 operator<<(const TVar& theVariableValue);
122 operator<<(long int theArg);
125 operator<<(int theArg);
128 operator<<(double theArg);
131 operator<<(float theArg);
134 operator<<(const void* theArg);
137 operator<<(const char* theArg);
140 operator<<(const SMESH::ElementType& theArg);
143 operator<<(const SMESH::GeometryType& theArg);
146 operator<<(const SMESH::long_array& theArg);
149 operator<<(const SMESH::double_array& theArg);
152 operator<<(const SMESH::string_array& theArg);
155 operator<<(SMESH::SMESH_Hypothesis_ptr theArg);
158 operator<<(SMESH::SMESH_IDSource_ptr theArg);
161 operator<<(SALOMEDS::SObject_ptr theArg);
164 operator<<(CORBA::Object_ptr theArg);
167 operator<<(SMESH::FilterLibrary_i* theArg);
170 operator<<(SMESH::FilterManager_i* theArg);
173 operator<<(SMESH::Filter_i* theArg);
176 operator<<(SMESH::Functor_i* theArg);
179 operator<<(SMESH::Measurements_i* theArg);
182 operator<<(SMESH_Gen_i* theArg);
185 operator<<(SMESH_MeshEditor_i* theArg);
188 operator<<(SMESH::MED_VERSION theArg);
191 operator<<(const SMESH::AxisStruct & theAxis);
194 operator<<(const SMESH::DirStruct & theDir);
197 operator<<(const SMESH::PointStruct & P);
200 operator<<(const TCollection_AsciiString & theArg);
203 operator<<(const SMESH::ListOfGroups& theList);
206 operator<<(const SMESH::ListOfGroups * theList);
209 operator<<(const SMESH::ListOfIDSources& theList);
211 static const char* SMESHGenName() { return "smeshgen"; }
212 static const char* MeshEditorName() { return "mesh_editor"; }
215 * \brief Return marker of long string literal beginning
216 * \param type - a name of functionality producing the string literal
217 * \retval TCollection_AsciiString - the marker string to be written into
218 * a raw python script
220 static TCollection_AsciiString LongStringStart(const char* type);
222 * \brief Return marker of long string literal end
223 * \retval TCollection_AsciiString - the marker string to be written into
224 * a raw python script
226 static TCollection_AsciiString LongStringEnd();
228 * \brief Cut out a long string literal from a string
229 * \param theText - text possibly containing string literals
230 * \param theFrom - position in the text to search from
231 * \param theLongString - the retrieved literal
232 * \param theStringType - a name of functionality produced the literal
233 * \retval bool - true if a string literal found
235 * The literal is removed from theText; theFrom points position right after
236 * the removed literal
238 static bool CutoutLongString( TCollection_AsciiString & theText,
240 TCollection_AsciiString & theLongString,
241 TCollection_AsciiString & theStringType);