src/SMESH_I/SMESH_PythonDump.hxx

   1 //  Copyright (C) 2003  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   2 //  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   3 //
   4 //  This library is free software; you can redistribute it and/or
   5 //  modify it under the terms of the GNU Lesser General Public
   6 //  License as published by the Free Software Foundation; either
   7 //  version 2.1 of the License.
   8 //
   9 //  This library is distributed in the hope that it will be useful,
  10 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 //  Lesser General Public License for more details.
  13 //
  14 //  You should have received a copy of the GNU Lesser General Public
  15 //  License along with this library; if not, write to the Free Software
  16 //  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  17 //
  18 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  19
  20 #ifndef _SMESH_PYTHONDUMP_HXX_
  21 #define _SMESH_PYTHONDUMP_HXX_
  22
  23 #include "SMESH.hxx"
  24
  25 #include <SALOMEconfig.h>
  26 #include CORBA_SERVER_HEADER(SMESH_Mesh)
  27 #include CORBA_SERVER_HEADER(SALOMEDS)
  28
  29 #include <sstream>
  30
  31 class SMESH_Gen_i;
  32 class SMESH_MeshEditor_i;
  33 class TCollection_AsciiString;
  34 class Resource_DataMapOfAsciiStringAsciiString;
  35
  36 // ===========================================================================================
  37 /*!
  38  * \brief Tool converting SMESH engine calls into commands defined in smesh.py
  39  *
  40  * Implementation is in SMESH_2smeshpy.cxx
  41  */
  42 // ===========================================================================================
  43
  44 class SMESH_2smeshpy
  45 {
  46 public:
  47   /*!
  48    * \brief Convert a python script using commands of smesh.py
  49    * \param theScript - Input script
  50    * \param theEntry2AccessorMethod - The returning method names to access to
  51    *        objects wrapped with python class
  52    * \retval TCollection_AsciiString - Convertion result
  53    */
  54   static TCollection_AsciiString
  55   ConvertScript(const TCollection_AsciiString& theScript,
  56                 Resource_DataMapOfAsciiStringAsciiString& theEntry2AccessorMethod,
  57                 Resource_DataMapOfAsciiStringAsciiString& theObjectNames);
  58
  59   /*!
  60    * \brief Return the name of the python file wrapping IDL API
  61     * \retval TCollection_AsciiString - The file name
  62    */
  63   static const char* SmeshpyName() { return "smesh"; }
  64   static const char* GenName() { return "smesh.smesh"; }
  65 };
  66
  67 namespace SMESH
  68 {
  69   class FilterLibrary_i;
  70   class FilterManager_i;
  71   class Filter_i;
  72   class Functor_i;
  73
  74 // ===========================================================================================
  75 /*!
  76  * \brief Utility helping in storing SMESH engine calls as python commands
  77  */
  78 // ===========================================================================================
  79
  80   class SMESH_I_EXPORT TPythonDump
  81   {
  82     std::ostringstream myStream;
  83     static size_t myCounter;
  84   public:
  85     TPythonDump();
  86     virtual ~TPythonDump();
  87
  88     TPythonDump&
  89     operator<<(long int theArg);
  90
  91     TPythonDump&
  92     operator<<(int theArg);
  93
  94     TPythonDump&
  95     operator<<(double theArg);
  96
  97     TPythonDump&
  98     operator<<(float theArg);
  99
 100     TPythonDump&
 101     operator<<(const void* theArg);
 102
 103     TPythonDump&
 104     operator<<(const char* theArg);
 105
 106     TPythonDump&
 107     operator<<(const SMESH::ElementType& theArg);
 108
 109     TPythonDump&
 110     operator<<(const SMESH::long_array& theArg);
 111
 112     TPythonDump&
 113     operator<<(const SMESH::double_array& theArg);
 114
 115     TPythonDump&
 116     operator<<(SALOMEDS::SObject_ptr theArg);
 117
 118     TPythonDump&
 119     operator<<(CORBA::Object_ptr theArg);
 120
 121     TPythonDump&
 122     operator<<(SMESH::FilterLibrary_i* theArg);
 123
 124     TPythonDump&
 125     operator<<(SMESH::FilterManager_i* theArg);
 126
 127     TPythonDump&
 128     operator<<(SMESH::Filter_i* theArg);
 129
 130     TPythonDump&
 131     operator<<(SMESH::Functor_i* theArg);
 132
 133     TPythonDump&
 134     operator<<(SMESH_Gen_i* theArg);
 135
 136     TPythonDump&
 137     operator<<(SMESH_MeshEditor_i* theArg);
 138
 139     TPythonDump&
 140     operator<<(SMESH::MED_VERSION theArg);
 141
 142     TPythonDump&
 143     operator<<(const SMESH::AxisStruct & theAxis);
 144
 145     TPythonDump&
 146     operator<<(const SMESH::DirStruct & theDir);
 147
 148     TPythonDump&
 149     operator<<(const TCollection_AsciiString & theArg);
 150
 151     TPythonDump&
 152     operator<<(const SMESH::ListOfGroups * theList);
 153
 154     static const char* SMESHGenName() { return "smeshgen"; }
 155     static const char* MeshEditorName() { return "mesh_editor"; }
 156
 157     /*!
 158      * \brief Return marker of long string literal beginning
 159       * \param type - a name of functionality producing the string literal
 160       * \retval TCollection_AsciiString - the marker string to be written into
 161       * a raw python script
 162      */
 163     static TCollection_AsciiString LongStringStart(const char* type);
 164     /*!
 165      * \brief Return marker of long string literal end
 166       * \retval TCollection_AsciiString - the marker string to be written into
 167       * a raw python script
 168      */
 169     static TCollection_AsciiString LongStringEnd();
 170     /*!
 171      * \brief Cut out a long string literal from a string
 172       * \param theText - text possibly containing string literals
 173       * \param theFrom - position in the text to search from
 174       * \param theLongString - the retrieved literal
 175       * \param theStringType - a name of functionality produced the literal
 176       * \retval bool - true if a string literal found
 177      *
 178      * The literal is removed from theText; theFrom points position right after
 179      * the removed literal
 180      */
 181     static bool  CutoutLongString( TCollection_AsciiString & theText,
 182                                    int                     & theFrom,
 183                                    TCollection_AsciiString & theLongString,
 184                                    TCollection_AsciiString & theStringType);
 185   };
 186 }
 187
 188 #endif