1 // Copyright (C) 2007-2013 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)
32 #include <TCollection_AsciiString.hxx>
40 class SMESH_MeshEditor_i;
41 class Resource_DataMapOfAsciiStringAsciiString;
43 // ===========================================================================================
45 * \brief Tool converting SMESH engine calls into commands defined in smeshBuilder.py
47 * Implementation is in SMESH_2smeshpy.cxx
49 // ===========================================================================================
55 * \brief Convert a python script using commands of smeshBuilder.py
56 * \param theScript - the Input script to convert
57 * \param theEntry2AccessorMethod - returns method names to access to
58 * objects wrapped with python class
59 * \param theObjectNames - names of objects
60 * \param theRemovedObjIDs - entries of objects whose created commands were removed
61 * \param theHistoricalDump - true means to keep all commands, false means
62 * to exclude commands relating to objects removed from study
63 * \retval TCollection_AsciiString - Convertion result
66 ConvertScript(std::list< TCollection_AsciiString >& theScriptLines,
67 Resource_DataMapOfAsciiStringAsciiString& theEntry2AccessorMethod,
68 Resource_DataMapOfAsciiStringAsciiString& theObjectNames,
69 std::set< TCollection_AsciiString >& theRemovedObjIDs,
70 SALOMEDS::Study_ptr& theStudy,
71 const bool theHistoricalDump);
74 * \brief Return the name of the python file wrapping IDL API
75 * \retval const char* - the file name
77 static const char* SmeshpyName() { return "smesh"; }
78 static const char* GenName() { return "smesh"; }
83 class FilterLibrary_i;
84 class FilterManager_i;
89 // ===========================================================================================
91 * \brief Object used to make TPythonDump know that its held value can be a varible
93 * TPythonDump substitute TVar with names of notebook variables if any.
95 // ===========================================================================================
97 struct SMESH_I_EXPORT TVar
99 std::vector< std::string > myVals;
100 TVar(CORBA::Double value);
101 TVar(CORBA::Long value);
102 TVar(CORBA::Short value);
103 TVar(const SMESH::double_array& value);
104 // string used to temporary quote variable names in order
105 // not to confuse variables with string arguments
106 static char Quote() { return '$'; }
107 // string preceding an entry of object storing the attribute holding var names
108 static const char* ObjPrefix() { return " # OBJ: "; }
111 // ===========================================================================================
113 * \brief Utility helping in storing SMESH engine calls as python commands
115 // ===========================================================================================
117 class SMESH_I_EXPORT TPythonDump
119 std::ostringstream myStream;
120 static size_t myCounter;
121 int myVarsCounter; // counts stored TVar's
124 virtual ~TPythonDump();
127 operator<<(const TVar& theVariableValue);
130 operator<<(long int theArg);
133 operator<<(int theArg);
136 operator<<(double theArg);
139 operator<<(float theArg);
142 operator<<(const void* theArg);
145 operator<<(const char* theArg);
148 operator<<(const SMESH::ElementType& theArg);
151 operator<<(const SMESH::GeometryType& theArg);
154 operator<<(const SMESH::EntityType& theArg);
157 operator<<(const SMESH::long_array& theArg);
160 operator<<(const SMESH::double_array& theArg);
163 operator<<(const SMESH::string_array& theArg);
166 operator<<(SMESH::SMESH_Hypothesis_ptr theArg);
169 operator<<(SMESH::SMESH_IDSource_ptr theArg);
172 operator<<(SALOMEDS::SObject_ptr theArg);
175 operator<<(CORBA::Object_ptr theArg);
178 operator<<(SMESH::FilterLibrary_i* theArg);
181 operator<<(SMESH::FilterManager_i* theArg);
184 operator<<(SMESH::Filter_i* theArg);
187 operator<<(SMESH::Functor_i* theArg);
190 operator<<(SMESH::Measurements_i* theArg);
193 operator<<(SMESH_Gen_i* theArg);
196 operator<<(SMESH_MeshEditor_i* theArg);
199 operator<<(SMESH::MED_VERSION theArg);
202 operator<<(const SMESH::AxisStruct & theAxis);
205 operator<<(const SMESH::DirStruct & theDir);
208 operator<<(const SMESH::PointStruct & P);
211 operator<<(const TCollection_AsciiString & theArg);
214 operator<<(const SMESH::ListOfGroups& theList);
217 operator<<(const SMESH::ListOfGroups * theList);
220 operator<<(const SMESH::ListOfIDSources& theList);
222 static const char* SMESHGenName() { return "smeshgen"; }
223 static const char* MeshEditorName() { return "mesh_editor"; }
224 static const char* NotPublishedObjectName();
227 * \brief Return marker of long string literal beginning
228 * \param type - a name of functionality producing the string literal
229 * \retval TCollection_AsciiString - the marker string to be written into
230 * a raw python script
232 static TCollection_AsciiString LongStringStart(const char* type);
234 * \brief Return marker of long string literal end
235 * \retval TCollection_AsciiString - the marker string to be written into
236 * a raw python script
238 static TCollection_AsciiString LongStringEnd();
240 * \brief Cut out a long string literal from a string
241 * \param theText - text possibly containing string literals
242 * \param theFrom - position in the text to search from
243 * \param theLongString - the retrieved literal
244 * \param theStringType - a name of functionality produced the literal
245 * \retval bool - true if a string literal found
247 * The literal is removed from theText; theFrom points position right after
248 * the removed literal
250 static bool CutoutLongString( TCollection_AsciiString & theText,
252 TCollection_AsciiString & theLongString,
253 TCollection_AsciiString & theStringType);