src/SMESH_I/SMESH_PythonDump.hxx

   1 // Copyright (C) 2007-2012  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(SALOMEDS)
  31
  32 #include <sstream>
  33 #include <vector>
  34
  35 class SMESH_Gen_i;
  36 class SMESH_MeshEditor_i;
  37 class TCollection_AsciiString;
  38 class Resource_DataMapOfAsciiStringAsciiString;
  39
  40 // ===========================================================================================
  41 /*!
  42  * \brief Tool converting SMESH engine calls into commands defined in smeshDC.py
  43  *
  44  * Implementation is in SMESH_2smeshpy.cxx
  45  */
  46 // ===========================================================================================
  47
  48 class SMESH_2smeshpy
  49 {
  50 public:
  51   /*!
  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
  59    */
  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);
  66
  67   /*!
  68    * \brief Return the name of the python file wrapping IDL API
  69     * \retval const char* - the file name
  70    */
  71   static const char* SmeshpyName() { return "smesh"; }
  72   static const char* GenName() { return "smesh"; }
  73 };
  74
  75 namespace SMESH
  76 {
  77   class FilterLibrary_i;
  78   class FilterManager_i;
  79   class Filter_i;
  80   class Functor_i;
  81   class Measurements_i;
  82
  83   // ===========================================================================================
  84   /*!
  85    * \brief Object used to make TPythonDump know that its held value can be a varible
  86    *
  87    * TPythonDump substitute TVar with names of notebook variables if any.
  88    */
  89   // ===========================================================================================
  90
  91   struct SMESH_I_EXPORT TVar
  92   {
  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 '$'; }
 101   };
 102
 103   // ===========================================================================================
 104   /*!
 105    * \brief Utility helping in storing SMESH engine calls as python commands
 106    */
 107   // ===========================================================================================
 108
 109   class SMESH_I_EXPORT TPythonDump
 110   {
 111     std::ostringstream myStream;
 112     static size_t      myCounter;
 113     int                myVarsCounter; // counts stored TVar's
 114   public:
 115     TPythonDump();
 116     virtual ~TPythonDump();
 117
 118     TPythonDump&
 119     operator<<(const TVar& theVariableValue);
 120
 121     TPythonDump&
 122     operator<<(long int theArg);
 123
 124     TPythonDump&
 125     operator<<(int theArg);
 126
 127     TPythonDump&
 128     operator<<(double theArg);
 129
 130     TPythonDump&
 131     operator<<(float theArg);
 132
 133     TPythonDump&
 134     operator<<(const void* theArg);
 135
 136     TPythonDump&
 137     operator<<(const char* theArg);
 138
 139     TPythonDump&
 140     operator<<(const SMESH::ElementType& theArg);
 141
 142     TPythonDump&
 143     operator<<(const SMESH::GeometryType& theArg);
 144
 145     TPythonDump&
 146     operator<<(const SMESH::EntityType& theArg);
 147
 148     TPythonDump&
 149     operator<<(const SMESH::long_array& theArg);
 150
 151     TPythonDump&
 152     operator<<(const SMESH::double_array& theArg);
 153
 154     TPythonDump&
 155     operator<<(const SMESH::string_array& theArg);
 156
 157     TPythonDump&
 158     operator<<(SMESH::SMESH_Hypothesis_ptr theArg);
 159
 160     TPythonDump&
 161     operator<<(SMESH::SMESH_IDSource_ptr theArg);
 162
 163     TPythonDump&
 164     operator<<(SALOMEDS::SObject_ptr theArg);
 165
 166     TPythonDump&
 167     operator<<(CORBA::Object_ptr theArg);
 168
 169     TPythonDump&
 170     operator<<(SMESH::FilterLibrary_i* theArg);
 171
 172     TPythonDump&
 173     operator<<(SMESH::FilterManager_i* theArg);
 174
 175     TPythonDump&
 176     operator<<(SMESH::Filter_i* theArg);
 177
 178     TPythonDump&
 179     operator<<(SMESH::Functor_i* theArg);
 180
 181     TPythonDump&
 182     operator<<(SMESH::Measurements_i* theArg);
 183
 184     TPythonDump&
 185     operator<<(SMESH_Gen_i* theArg);
 186
 187     TPythonDump&
 188     operator<<(SMESH_MeshEditor_i* theArg);
 189
 190     TPythonDump&
 191     operator<<(SMESH::MED_VERSION theArg);
 192
 193     TPythonDump&
 194     operator<<(const SMESH::AxisStruct & theAxis);
 195
 196     TPythonDump&
 197     operator<<(const SMESH::DirStruct & theDir);
 198
 199     TPythonDump&
 200     operator<<(const SMESH::PointStruct & P);
 201
 202     TPythonDump&
 203     operator<<(const TCollection_AsciiString & theArg);
 204
 205     TPythonDump&
 206     operator<<(const SMESH::ListOfGroups& theList);
 207
 208     TPythonDump&
 209     operator<<(const SMESH::ListOfGroups * theList);
 210
 211     TPythonDump&
 212     operator<<(const SMESH::ListOfIDSources& theList);
 213
 214     static const char* SMESHGenName() { return "smeshgen"; }
 215     static const char* MeshEditorName() { return "mesh_editor"; }
 216
 217     /*!
 218      * \brief Return marker of long string literal beginning
 219       * \param type - a name of functionality producing the string literal
 220       * \retval TCollection_AsciiString - the marker string to be written into
 221       * a raw python script
 222      */
 223     static TCollection_AsciiString LongStringStart(const char* type);
 224     /*!
 225      * \brief Return marker of long string literal end
 226       * \retval TCollection_AsciiString - the marker string to be written into
 227       * a raw python script
 228      */
 229     static TCollection_AsciiString LongStringEnd();
 230     /*!
 231      * \brief Cut out a long string literal from a string
 232       * \param theText - text possibly containing string literals
 233       * \param theFrom - position in the text to search from
 234       * \param theLongString - the retrieved literal
 235       * \param theStringType - a name of functionality produced the literal
 236       * \retval bool - true if a string literal found
 237      *
 238      * The literal is removed from theText; theFrom points position right after
 239      * the removed literal
 240      */
 241     static bool  CutoutLongString( TCollection_AsciiString & theText,
 242                                    int                     & theFrom,
 243                                    TCollection_AsciiString & theLongString,
 244                                    TCollection_AsciiString & theStringType);
 245   };
 246 }
 247
 248 #endif