src/SMESH_I/SMESH_PythonDump.hxx

   1 //  Copyright (C) 2007-2010  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
  34 class SMESH_Gen_i;
  35 class SMESH_MeshEditor_i;
  36 class TCollection_AsciiString;
  37 class Resource_DataMapOfAsciiStringAsciiString;
  38
  39 // ===========================================================================================
  40 /*!
  41  * \brief Tool converting SMESH engine calls into commands defined in smesh.py
  42  *
  43  * Implementation is in SMESH_2smeshpy.cxx
  44  */
  45 // ===========================================================================================
  46
  47 class SMESH_2smeshpy
  48 {
  49 public:
  50   /*!
  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    * \retval TCollection_AsciiString - Convertion result
  56    */
  57   static TCollection_AsciiString
  58   ConvertScript(const TCollection_AsciiString& theScript,
  59                 Resource_DataMapOfAsciiStringAsciiString& theEntry2AccessorMethod,
  60                 Resource_DataMapOfAsciiStringAsciiString& theObjectNames);
  61
  62   /*!
  63    * \brief Return the name of the python file wrapping IDL API
  64     * \retval TCollection_AsciiString - The file name
  65    */
  66   static const char* SmeshpyName() { return "smesh"; }
  67   static const char* GenName() { return "smesh"; }
  68 };
  69
  70 namespace SMESH
  71 {
  72   class FilterLibrary_i;
  73   class FilterManager_i;
  74   class Filter_i;
  75   class Functor_i;
  76
  77 // ===========================================================================================
  78 /*!
  79  * \brief Utility helping in storing SMESH engine calls as python commands
  80  */
  81 // ===========================================================================================
  82
  83   class SMESH_I_EXPORT TPythonDump
  84   {
  85     std::ostringstream myStream;
  86     static size_t myCounter;
  87   public:
  88     TPythonDump();
  89     virtual ~TPythonDump();
  90
  91     TPythonDump&
  92     operator<<(long int theArg);
  93
  94     TPythonDump&
  95     operator<<(int theArg);
  96
  97     TPythonDump&
  98     operator<<(double theArg);
  99
 100     TPythonDump&
 101     operator<<(float theArg);
 102
 103     TPythonDump&
 104     operator<<(const void* theArg);
 105
 106     TPythonDump&
 107     operator<<(const char* theArg);
 108
 109     TPythonDump&
 110     operator<<(const SMESH::ElementType& theArg);
 111
 112     TPythonDump&
 113     operator<<(const SMESH::GeometryType& theArg);
 114
 115     TPythonDump&
 116     operator<<(const SMESH::long_array& theArg);
 117
 118     TPythonDump&
 119     operator<<(const SMESH::double_array& theArg);
 120
 121     TPythonDump&
 122     operator<<(SMESH::SMESH_Hypothesis_ptr theArg);
 123
 124     TPythonDump&
 125     operator<<(SMESH::SMESH_IDSource_ptr theArg);
 126
 127     TPythonDump&
 128     operator<<(SALOMEDS::SObject_ptr theArg);
 129
 130     TPythonDump&
 131     operator<<(CORBA::Object_ptr theArg);
 132
 133     TPythonDump&
 134     operator<<(SMESH::FilterLibrary_i* theArg);
 135
 136     TPythonDump&
 137     operator<<(SMESH::FilterManager_i* theArg);
 138
 139     TPythonDump&
 140     operator<<(SMESH::Filter_i* theArg);
 141
 142     TPythonDump&
 143     operator<<(SMESH::Functor_i* theArg);
 144
 145     TPythonDump&
 146     operator<<(SMESH_Gen_i* theArg);
 147
 148     TPythonDump&
 149     operator<<(SMESH_MeshEditor_i* theArg);
 150
 151     TPythonDump&
 152     operator<<(SMESH::MED_VERSION theArg);
 153
 154     TPythonDump&
 155     operator<<(const SMESH::AxisStruct & theAxis);
 156
 157     TPythonDump&
 158     operator<<(const SMESH::DirStruct & theDir);
 159
 160     TPythonDump&
 161     operator<<(const TCollection_AsciiString & theArg);
 162
 163     TPythonDump&
 164     operator<<(const SMESH::ListOfGroups * theList);
 165
 166     static const char* SMESHGenName() { return "smeshgen"; }
 167     static const char* MeshEditorName() { return "mesh_editor"; }
 168
 169     /*!
 170      * \brief Return marker of long string literal beginning
 171       * \param type - a name of functionality producing the string literal
 172       * \retval TCollection_AsciiString - the marker string to be written into
 173       * a raw python script
 174      */
 175     static TCollection_AsciiString LongStringStart(const char* type);
 176     /*!
 177      * \brief Return marker of long string literal end
 178       * \retval TCollection_AsciiString - the marker string to be written into
 179       * a raw python script
 180      */
 181     static TCollection_AsciiString LongStringEnd();
 182     /*!
 183      * \brief Cut out a long string literal from a string
 184       * \param theText - text possibly containing string literals
 185       * \param theFrom - position in the text to search from
 186       * \param theLongString - the retrieved literal
 187       * \param theStringType - a name of functionality produced the literal
 188       * \retval bool - true if a string literal found
 189      *
 190      * The literal is removed from theText; theFrom points position right after
 191      * the removed literal
 192      */
 193     static bool  CutoutLongString( TCollection_AsciiString & theText,
 194                                    int                     & theFrom,
 195                                    TCollection_AsciiString & theLongString,
 196                                    TCollection_AsciiString & theStringType);
 197   };
 198 }
 199
 200 #endif