Join modifications from BR_Dev_For_4_0 tag V4_1_1.

[modules/smesh.git] / src / SMESH_I / SMESH_PythonDump.hxx

diff --git a/src/SMESH_I/SMESH_PythonDump.hxx b/src/SMESH_I/SMESH_PythonDump.hxx
index 86133cf8aff44c7cc88b5f9003e7dbe232d83d68..518e1be9220ca88703e8707d5aea712a20ac264f 100644 (file)
--- a/src/SMESH_I/SMESH_PythonDump.hxx
+++ b/src/SMESH_I/SMESH_PythonDump.hxx
@@ -15,16 +15,54 @@
 //  License along with this library; if not, write to the Free Software 
 //  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA 
 // 
-//  See http://www.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org 
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
 
 #ifndef _SMESH_PYTHONDUMP_HXX_
 #define _SMESH_PYTHONDUMP_HXX_
 
+#include "SMESH.hxx"
+
 #include <SALOMEconfig.h>
 #include CORBA_SERVER_HEADER(SMESH_Mesh)
+#include CORBA_SERVER_HEADER(SALOMEDS)
 
 #include <sstream>
 
+class SMESH_Gen_i;
+class SMESH_MeshEditor_i;
+class TCollection_AsciiString;
+class Resource_DataMapOfAsciiStringAsciiString;
+
+// ===========================================================================================
+/*!
+ * \brief Tool converting SMESH engine calls into commands defined in smesh.py
+ *
+ * Implementation is in SMESH_2smeshpy.cxx
+ */
+// ===========================================================================================
+
+class SMESH_2smeshpy
+{
+public:
+  /*!
+   * \brief Convert a python script using commands of smesh.py
+   * \param theScript - Input script
+   * \param theEntry2AccessorMethod - The returning method names to access to
+   *        objects wrapped with python class
+   * \retval TCollection_AsciiString - Convertion result
+   */
+  static TCollection_AsciiString
+  ConvertScript(const TCollection_AsciiString& theScript,
+                Resource_DataMapOfAsciiStringAsciiString& theEntry2AccessorMethod);
+
+  /*!
+   * \brief Return the name of the python file wrapping IDL API
+    * \retval TCollection_AsciiString - The file name
+   */
+  static char* SmeshpyName() { return "smesh"; }
+  static char* GenName() { return "smesh.smesh"; }
+};
+
 namespace SMESH
 {
   class FilterLibrary_i;
@@ -32,7 +70,13 @@ namespace SMESH
   class Filter_i;
   class Functor_i;
 
-  class TPythonDump
+// ===========================================================================================
+/*!
+ * \brief Utility helping in storing SMESH engine calls as python commands
+ */
+// ===========================================================================================
+
+  class SMESH_I_EXPORT TPythonDump
   {
     std::ostringstream myStream;
     static size_t myCounter;
@@ -64,6 +108,12 @@ namespace SMESH
     TPythonDump& 
     operator<<(const SMESH::long_array& theArg);
 
+    TPythonDump& 
+    operator<<(const SMESH::double_array& theArg);
+
+    TPythonDump& 
+    operator<<(SALOMEDS::SObject_ptr theArg);
+
     TPythonDump& 
     operator<<(CORBA::Object_ptr theArg);
 
@@ -78,8 +128,57 @@ namespace SMESH
 
     TPythonDump& 
     operator<<(SMESH::Functor_i* theArg);
+
+    TPythonDump& 
+    operator<<(SMESH_Gen_i* theArg);
+
+    TPythonDump& 
+    operator<<(SMESH_MeshEditor_i* theArg);
+
+    TPythonDump& 
+    operator<<(SMESH::MED_VERSION theArg);
+
+    TPythonDump&
+    operator<<(const SMESH::AxisStruct & theAxis);
+
+    TPythonDump&
+    operator<<(const SMESH::DirStruct & theDir);
+
+    TPythonDump&
+    operator<<(const TCollection_AsciiString & theArg);
+
+    static char* SMESHGenName() { return "smeshgen"; }
+    static char* MeshEditorName() { return "mesh_editor"; }
+
+    /*!
+     * \brief Return marker of long string literal beginning
+      * \param type - a name of functionality producing the string literal 
+      * \retval TCollection_AsciiString - the marker string to be written into
+      * a raw python script
+     */
+    static TCollection_AsciiString LongStringStart(const char* type);
+    /*!
+     * \brief Return marker of long string literal end
+      * \retval TCollection_AsciiString - the marker string to be written into
+      * a raw python script
+     */
+    static TCollection_AsciiString LongStringEnd();
+    /*!
+     * \brief Cut out a long string literal from a string
+      * \param theText - text possibly containing string literals
+      * \param theFrom - position in the text to search from
+      * \param theLongString - the retrieved literal
+      * \param theStringType - a name of functionality produced the literal
+      * \retval bool - true if a string literal found
+     * 
+     * The literal is removed from theText; theFrom points position right after
+     * the removed literal
+     */
+    static bool  CutoutLongString( TCollection_AsciiString & theText,
+                                   int                     & theFrom,
+                                   TCollection_AsciiString & theLongString,
+                                   TCollection_AsciiString & theStringType);
   };
 }
 
-
 #endif