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