src/SMESH_I/SMESH_PythonDump.hxx

   1 // Copyright (C) 2007-2013  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.
  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(GEOM_Gen)
  31 #include CORBA_SERVER_HEADER(SALOMEDS)
  32
  33 #include <TCollection_AsciiString.hxx>
  34
  35 #include <sstream>
  36 #include <vector>
  37 #include <set>
  38 #include <list>
  39
  40 class SMESH_Gen_i;
  41 class SMESH_MeshEditor_i;
  42 class Resource_DataMapOfAsciiStringAsciiString;
  43
  44 // ===========================================================================================
  45 /*!
  46  * \brief Tool converting SMESH engine calls into commands defined in smeshBuilder.py
  47  *
  48  * Implementation is in SMESH_2smeshpy.cxx
  49  */
  50 // ===========================================================================================
  51
  52 class SMESH_2smeshpy
  53 {
  54 public:
  55   /*!
  56    * \brief Convert a python script using commands of smeshBuilder.py
  57    * \param theScript - the Input script to convert
  58    * \param theEntry2AccessorMethod - returns method names to access to
  59    *        objects wrapped with python class
  60    * \param theObjectNames - names of objects
  61    * \param theRemovedObjIDs - entries of objects whose created commands were removed
  62    * \param theHistoricalDump - true means to keep all commands, false means
  63    *        to exclude commands relating to objects removed from study
  64    * \retval TCollection_AsciiString - Convertion result
  65    */
  66   static void
  67   ConvertScript(std::list< TCollection_AsciiString >&     theScriptLines,
  68                 Resource_DataMapOfAsciiStringAsciiString& theEntry2AccessorMethod,
  69                 Resource_DataMapOfAsciiStringAsciiString& theObjectNames,
  70                 std::set< TCollection_AsciiString >&      theRemovedObjIDs,
  71                 SALOMEDS::Study_ptr&                      theStudy,
  72                 const bool                                theHistoricalDump);
  73
  74   /*!
  75    * \brief Return the name of the python file wrapping IDL API
  76     * \retval const char* - the file name
  77    */
  78   static const char* SmeshpyName() { return "smesh"; }
  79   static const char* GenName() { return "smesh"; }
  80 };
  81
  82 namespace SMESH
  83 {
  84   class FilterLibrary_i;
  85   class FilterManager_i;
  86   class Filter_i;
  87   class Functor_i;
  88   class Measurements_i;
  89
  90   // ===========================================================================================
  91   /*!
  92    * \brief Object used to make TPythonDump know that its held value can be a varible
  93    *
  94    * TPythonDump substitute TVar with names of notebook variables if any.
  95    */
  96   // ===========================================================================================
  97
  98   struct SMESH_I_EXPORT TVar
  99   {
 100     std::vector< std::string > myVals;
 101     TVar(CORBA::Double value);
 102     TVar(CORBA::Long   value);
 103     TVar(CORBA::Short  value);
 104     TVar(const SMESH::double_array& value);
 105     // string used to temporary quote variable names in order
 106     // not to confuse variables with string arguments
 107     static char Quote() { return '$'; }
 108     // string preceding an entry of object storing the attribute holding var names
 109     static const char* ObjPrefix() { return " # OBJ: "; }
 110   };
 111
 112   // ===========================================================================================
 113   /*!
 114    * \brief Utility helping in storing SMESH engine calls as python commands
 115    */
 116   // ===========================================================================================
 117
 118   class SMESH_I_EXPORT TPythonDump
 119   {
 120     std::ostringstream myStream;
 121     static size_t      myCounter;
 122     int                myVarsCounter; // counts stored TVar's
 123   public:
 124     TPythonDump();
 125     virtual ~TPythonDump();
 126
 127     TPythonDump&
 128     operator<<(const TVar& theVariableValue);
 129
 130     TPythonDump&
 131     operator<<(long int theArg);
 132
 133     TPythonDump&
 134     operator<<(int theArg);
 135
 136     TPythonDump&
 137     operator<<(double theArg);
 138
 139     TPythonDump&
 140     operator<<(float theArg);
 141
 142     TPythonDump&
 143     operator<<(const void* theArg);
 144
 145     TPythonDump&
 146     operator<<(const char* theArg);
 147
 148     TPythonDump&
 149     operator<<(const SMESH::ElementType& theArg);
 150
 151     TPythonDump&
 152     operator<<(const SMESH::GeometryType& theArg);
 153
 154     TPythonDump&
 155     operator<<(const SMESH::EntityType& theArg);
 156
 157     TPythonDump&
 158     operator<<(const SMESH::long_array& theArg);
 159
 160     TPythonDump&
 161     operator<<(const SMESH::double_array& theArg);
 162
 163     TPythonDump&
 164     operator<<(const SMESH::string_array& theArg);
 165
 166     TPythonDump&
 167     operator<<(const SMESH::nodes_array& theArg);
 168
 169     TPythonDump&
 170     operator<<(SMESH::SMESH_Hypothesis_ptr theArg);
 171
 172     TPythonDump&
 173     operator<<(SMESH::SMESH_IDSource_ptr theArg);
 174
 175     TPythonDump&
 176     operator<<(SALOMEDS::SObject_ptr theArg);
 177
 178     TPythonDump&
 179     operator<<(CORBA::Object_ptr theArg);
 180
 181     TPythonDump&
 182     operator<<(SMESH::FilterLibrary_i* theArg);
 183
 184     TPythonDump&
 185     operator<<(SMESH::FilterManager_i* theArg);
 186
 187     TPythonDump&
 188     operator<<(SMESH::Filter_i* theArg);
 189
 190     TPythonDump&
 191     operator<<(SMESH::Functor_i* theArg);
 192
 193     TPythonDump&
 194     operator<<(SMESH::Measurements_i* theArg);
 195
 196     TPythonDump&
 197     operator<<(SMESH_Gen_i* theArg);
 198
 199     TPythonDump&
 200     operator<<(SMESH_MeshEditor_i* theArg);
 201
 202     TPythonDump&
 203     operator<<(SMESH::MED_VERSION theArg);
 204
 205     TPythonDump&
 206     operator<<(const SMESH::AxisStruct & theAxis);
 207
 208     TPythonDump&
 209     operator<<(const SMESH::DirStruct & theDir);
 210
 211     TPythonDump&
 212     operator<<(const SMESH::PointStruct & P);
 213
 214     TPythonDump&
 215     operator<<(const TCollection_AsciiString & theArg);
 216
 217     TPythonDump&
 218     operator<<(const SMESH::ListOfGroups& theList);
 219
 220     TPythonDump&
 221     operator<<(const SMESH::ListOfGroups * theList);
 222
 223     TPythonDump&
 224     operator<<(const GEOM::ListOfGO& theList);
 225
 226     TPythonDump&
 227     operator<<(const SMESH::ListOfIDSources& theList);
 228
 229     static const char* SMESHGenName() { return "smeshgen"; }
 230     static const char* MeshEditorName() { return "mesh_editor"; }
 231     static const char* NotPublishedObjectName();
 232
 233     /*!
 234      * \brief Return marker of long string literal beginning
 235       * \param type - a name of functionality producing the string literal
 236       * \retval TCollection_AsciiString - the marker string to be written into
 237       * a raw python script
 238      */
 239     static TCollection_AsciiString LongStringStart(const char* type);
 240     /*!
 241      * \brief Return marker of long string literal end
 242       * \retval TCollection_AsciiString - the marker string to be written into
 243       * a raw python script
 244      */
 245     static TCollection_AsciiString LongStringEnd();
 246     /*!
 247      * \brief Cut out a long string literal from a string
 248       * \param theText - text possibly containing string literals
 249       * \param theFrom - position in the text to search from
 250       * \param theLongString - the retrieved literal
 251       * \param theStringType - a name of functionality produced the literal
 252       * \retval bool - true if a string literal found
 253      *
 254      * The literal is removed from theText; theFrom points position right after
 255      * the removed literal
 256      */
 257     static bool  CutoutLongString( TCollection_AsciiString & theText,
 258                                    int                     & theFrom,
 259                                    TCollection_AsciiString & theLongString,
 260                                    TCollection_AsciiString & theStringType);
 261   };
 262 }
 263
 264 #endif