1 // Copyright (C) 2007-2011 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)
35 class SMESH_MeshEditor_i;
36 class TCollection_AsciiString;
37 class Resource_DataMapOfAsciiStringAsciiString;
39 // ===========================================================================================
41 * \brief Tool converting SMESH engine calls into commands defined in smeshDC.py
43 * Implementation is in SMESH_2smeshpy.cxx
45 // ===========================================================================================
51 * \brief Convert a python script using commands of smesh.py
52 * \param theScript - Input script
53 * \param theEntry2AccessorMethod - The returning method names to access to
54 * objects wrapped with python class
55 * \param theHistoricalDump - true means to keep all commands, false means
56 * to exclude commands relating to objects removed from study
57 * \retval TCollection_AsciiString - Convertion result
59 static TCollection_AsciiString
60 ConvertScript(const TCollection_AsciiString& theScript,
61 Resource_DataMapOfAsciiStringAsciiString& theEntry2AccessorMethod,
62 Resource_DataMapOfAsciiStringAsciiString& theObjectNames,
63 SALOMEDS::Study_ptr& theStudy,
64 const bool theHistoricalDump);
67 * \brief Return the name of the python file wrapping IDL API
68 * \retval TCollection_AsciiString - The file name
70 static const char* SmeshpyName() { return "smesh"; }
71 static const char* GenName() { return "smesh"; }
76 class FilterLibrary_i;
77 class FilterManager_i;
82 // ===========================================================================================
84 * \brief Utility helping in storing SMESH engine calls as python commands
86 // ===========================================================================================
88 class SMESH_I_EXPORT TPythonDump
90 std::ostringstream myStream;
91 static size_t myCounter;
94 virtual ~TPythonDump();
97 operator<<(long int theArg);
100 operator<<(int theArg);
103 operator<<(double theArg);
106 operator<<(float theArg);
109 operator<<(const void* theArg);
112 operator<<(const char* theArg);
115 operator<<(const SMESH::ElementType& theArg);
118 operator<<(const SMESH::GeometryType& theArg);
121 operator<<(const SMESH::long_array& theArg);
124 operator<<(const SMESH::double_array& theArg);
127 operator<<(const SMESH::string_array& theArg);
130 operator<<(SMESH::SMESH_Hypothesis_ptr theArg);
133 operator<<(SMESH::SMESH_IDSource_ptr theArg);
136 operator<<(SALOMEDS::SObject_ptr theArg);
139 operator<<(CORBA::Object_ptr theArg);
142 operator<<(SMESH::FilterLibrary_i* theArg);
145 operator<<(SMESH::FilterManager_i* theArg);
148 operator<<(SMESH::Filter_i* theArg);
151 operator<<(SMESH::Functor_i* theArg);
154 operator<<(SMESH::Measurements_i* theArg);
157 operator<<(SMESH_Gen_i* theArg);
160 operator<<(SMESH_MeshEditor_i* theArg);
163 operator<<(SMESH::MED_VERSION theArg);
166 operator<<(const SMESH::AxisStruct & theAxis);
169 operator<<(const SMESH::DirStruct & theDir);
172 operator<<(const TCollection_AsciiString & theArg);
175 operator<<(const SMESH::ListOfGroups& theList);
178 operator<<(const SMESH::ListOfGroups * theList);
181 operator<<(const SMESH::ListOfIDSources& theList);
183 static const char* SMESHGenName() { return "smeshgen"; }
184 static const char* MeshEditorName() { return "mesh_editor"; }
187 * \brief Return marker of long string literal beginning
188 * \param type - a name of functionality producing the string literal
189 * \retval TCollection_AsciiString - the marker string to be written into
190 * a raw python script
192 static TCollection_AsciiString LongStringStart(const char* type);
194 * \brief Return marker of long string literal end
195 * \retval TCollection_AsciiString - the marker string to be written into
196 * a raw python script
198 static TCollection_AsciiString LongStringEnd();
200 * \brief Cut out a long string literal from a string
201 * \param theText - text possibly containing string literals
202 * \param theFrom - position in the text to search from
203 * \param theLongString - the retrieved literal
204 * \param theStringType - a name of functionality produced the literal
205 * \retval bool - true if a string literal found
207 * The literal is removed from theText; theFrom points position right after
208 * the removed literal
210 static bool CutoutLongString( TCollection_AsciiString & theText,
212 TCollection_AsciiString & theLongString,
213 TCollection_AsciiString & theStringType);