src/SMESH_I/SMESH_2smeshpy.hxx

   1 // Copyright (C) 2005  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 // File      : SMESH_smesh.hxx
  21 // Created   : Fri Nov 18 12:05:18 2005
  22 // Author    : Edward AGAPOV (eap)
  23
  24 #ifndef SMESH_smesh_HeaderFile
  25 #define SMESH_smesh_HeaderFile
  26
  27 #include <Standard_DefineHandle.hxx>
  28 #include <Standard_Type.hxx>
  29 #include <Standard_Transient.hxx>
  30 #include <TCollection_AsciiString.hxx>
  31 #include <TColStd_SequenceOfAsciiString.hxx>
  32 #include <TColStd_SequenceOfInteger.hxx>
  33
  34 #include <list>
  35 #include <map>
  36
  37 // ===========================================================================================
  38 /*!
  39  * \brief Tool converting SMESH engine calls into commands defined in smesh.py
  40  *
  41  * This file was created in order to respond to requirement of bug PAL10494:
  42  * SMESH python dump uses idl interface.
  43  *
  44  * The creation reason is that smesh.py commands defining hypotheses encapsulate
  45  * several SMESH engine method calls. As well, the dependencies between smesh.py
  46  * classes differ from ones between SMESH IDL interfaces.
  47  *
  48  * The only API method here is SMESH_2smeshpy::ConvertScript(), the rest ones are
  49  * for internal usage
  50  *
  51  * See comments to _pyHypothesis class to know how to assure convertion of a new hypothesis
  52  */
  53 // ===========================================================================================
  54
  55 class Resource_DataMapOfAsciiStringAsciiString;
  56
  57 class SMESH_2smeshpy
  58 {
  59 public:
  60   /*!
  61    * \brief Convert a python script using commands of smesh.py
  62    * \param theScript - Input script
  63    * \param theEntry2AccessorMethod - The returning method names to access to
  64    *        objects wrapped with python class
  65    * \retval TCollection_AsciiString - Convertion result
  66    */
  67   static TCollection_AsciiString
  68   ConvertScript(const TCollection_AsciiString& theScript,
  69                 Resource_DataMapOfAsciiStringAsciiString& theEntry2AccessorMethod);
  70
  71   /*!
  72    * \brief Return the name of the python file wrapping IDL API
  73     * \retval TCollection_AsciiString - The file name
  74    */
  75   static char* SmeshpyName() { return "smesh"; }
  76   static char* GenName() { return "smesh.smesh"; }
  77 };
  78
  79 // ===========================================================================================
  80 // =====================
  81 //    INTERNAL STUFF
  82 // =====================
  83 // ===========================================================================================
  84
  85 class _pyCommand;
  86 class _pyObject;
  87 class _pyGen;
  88 class _pyMesh;
  89 class _pyHypothesis;
  90 class _pyAlgorithm;
  91
  92 DEFINE_STANDARD_HANDLE (_pyCommand   ,Standard_Transient);
  93 DEFINE_STANDARD_HANDLE (_pyObject    ,Standard_Transient);
  94 DEFINE_STANDARD_HANDLE (_pyGen       ,_pyObject);
  95 DEFINE_STANDARD_HANDLE (_pyMesh      ,_pyObject);
  96 DEFINE_STANDARD_HANDLE (_pyHypothesis,_pyObject);
  97 DEFINE_STANDARD_HANDLE (_pyAlgorithm ,_pyHypothesis);
  98
  99 typedef TCollection_AsciiString _pyID;
 100
 101 // ===========================================================
 102 /*!
 103  * \brief Class operating on a command string looking like
 104  *        ResultValue = Object.Method( Arg1, Arg2,...)
 105  */
 106 // ===========================================================
 107
 108 class _pyCommand: public Standard_Transient
 109 {
 110   int                             myOrderNb;            //!< position within the script
 111   TCollection_AsciiString         myString;             //!< command text
 112   TCollection_AsciiString         myRes, myObj, myMeth; //!< found parts of command
 113   TColStd_SequenceOfAsciiString   myArgs;               //!< found arguments
 114   TColStd_SequenceOfInteger       myBegPos;             //!< where myRes, myObj, ... begin
 115   std::list< Handle(_pyCommand) > myDependentCmds; //!< commands that sould follow me in the script
 116
 117   enum { UNKNOWN=-1, EMPTY=0, RESULT_IND, OBJECT_IND, METHOD_IND, ARG1_IND };
 118   int GetBegPos( int thePartIndex );
 119   void SetBegPos( int thePartIndex, int thePosition );
 120   void SetPart( int thePartIndex, const TCollection_AsciiString& theNewPart,
 121                 TCollection_AsciiString& theOldPart);
 122   void FindAllArgs() { GetArg(1); }
 123
 124 public:
 125   _pyCommand() {};
 126   _pyCommand( const TCollection_AsciiString& theString, int theNb )
 127     : myString( theString ), myOrderNb( theNb ) {};
 128   TCollection_AsciiString & GetString() { return myString; }
 129   int GetOrderNb() const { return myOrderNb; }
 130   void SetOrderNb( int theNb ) { myOrderNb = theNb; }
 131   int Length() { return myString.Length(); }
 132   void Clear() { myString.Clear(); myBegPos.Clear(); }
 133   bool IsEmpty() const { return myString.IsEmpty(); }
 134   const TCollection_AsciiString & GetResultValue();
 135   const TCollection_AsciiString & GetObject();
 136   const TCollection_AsciiString & GetMethod();
 137   const TCollection_AsciiString & GetArg( int index );
 138   int GetNbArgs() { FindAllArgs(); return myArgs.Length(); }
 139   //Handle(TColStd_HSequenceOfAsciiString) GetArgs();
 140   void SetResultValue( const TCollection_AsciiString& theResult )
 141   { GetResultValue(); SetPart( RESULT_IND, theResult, myRes ); }
 142   void SetObject(const TCollection_AsciiString& theObject)
 143   { GetObject(); SetPart( OBJECT_IND, theObject, myObj ); }
 144   void SetMethod(const TCollection_AsciiString& theMethod)
 145   { GetMethod(); SetPart( METHOD_IND, theMethod, myMeth ); }
 146   void SetArg( int index, const TCollection_AsciiString& theArg);
 147   void RemoveArgs();
 148   static bool SkipSpaces( const TCollection_AsciiString & theSring, int & thePos );
 149   static TCollection_AsciiString GetWord( const TCollection_AsciiString & theSring,
 150                                           int & theStartPos, const bool theForward,
 151                                           const bool dotIsWord = false);
 152   void AddDependantCmd( Handle(_pyCommand) cmd)
 153   { return myDependentCmds.push_back( cmd ); }
 154   bool SetDependentCmdsAfter() const;
 155
 156   bool AddAccessorMethod( _pyID theObjectID, const char* theAcsMethod );
 157
 158   DEFINE_STANDARD_RTTI (_pyCommand)
 159 };
 160
 161 // -------------------------------------------------------------------------------------
 162 /*!
 163  * \brief Root of all objects
 164  */
 165 // -------------------------------------------------------------------------------------
 166
 167 class _pyObject: public Standard_Transient
 168 {
 169   Handle(_pyCommand)              myCreationCmd;
 170 public:
 171   _pyObject(const Handle(_pyCommand)& theCreationCmd): myCreationCmd(theCreationCmd) {}
 172   const _pyID& GetID() { return myCreationCmd->GetResultValue(); }
 173   const Handle(_pyCommand)& GetCreationCmd() { return myCreationCmd; }
 174   void  SetCreationCmd( Handle(_pyCommand) cmd ) { myCreationCmd = cmd; }
 175   int GetCommandNb() { return myCreationCmd->GetOrderNb(); }
 176   virtual void Process(const Handle(_pyCommand) & theCommand) = 0;
 177   virtual void Flush() = 0;
 178   virtual const char* AccessorMethod() const;
 179
 180   DEFINE_STANDARD_RTTI (_pyObject)
 181 };
 182
 183 // -------------------------------------------------------------------------------------
 184 /*!
 185  * \brief Class corresponding to SMESH_Gen. It holds info on existing
 186  *        meshes and hypotheses
 187  */
 188 // -------------------------------------------------------------------------------------
 189 class _pyGen: public _pyObject
 190 {
 191 public:
 192   _pyGen(Resource_DataMapOfAsciiStringAsciiString& theEntry2AccessorMethod);
 193   //~_pyGen();
 194   void AddCommand( const TCollection_AsciiString& theCommand );
 195   void Process( const Handle(_pyCommand)& theCommand );
 196   void Flush();
 197   Handle(_pyHypothesis) FindHyp( const _pyID& theHypID );
 198   Handle(_pyHypothesis) FindAlgo( const _pyID& theGeom, const _pyID& theMesh,
 199                                  const TCollection_AsciiString& theAlgoType);
 200   void ExchangeCommands( Handle(_pyCommand) theCmd1, Handle(_pyCommand) theCmd2 );
 201   void SetCommandAfter( Handle(_pyCommand) theCmd, Handle(_pyCommand) theAfterCmd );
 202   std::list< Handle(_pyCommand) >& GetCommands() { return myCommands; }
 203   void SetAccessorMethod(const _pyID& theID, const char* theMethod );
 204   const char* AccessorMethod() const { return SMESH_2smeshpy::GenName(); }
 205 private:
 206   std::map< _pyID, Handle(_pyMesh) > myMeshes;
 207   std::list< Handle(_pyHypothesis) > myHypos;
 208   std::list< Handle(_pyCommand) >    myCommands;
 209   int                                myNbCommands;
 210   bool                               myHasPattern;
 211   Resource_DataMapOfAsciiStringAsciiString& myID2AccessorMethod;
 212
 213   DEFINE_STANDARD_RTTI (_pyGen)
 214 };
 215
 216 // -------------------------------------------------------------------------------------
 217 /*!
 218  * \brief Contains commands concerning mesh substructures
 219  */
 220 // -------------------------------------------------------------------------------------
 221 #define _pyMesh_ACCESS_METHOD "GetMesh()"
 222 class _pyMesh: public _pyObject
 223 {
 224   std::list< Handle(_pyHypothesis) > myHypos;
 225   std::list< Handle(_pyCommand) > myAddHypCmds;
 226   std::list< Handle(_pyCommand) > mySubmeshes;
 227   bool                            myHasEditor;
 228 public:
 229   _pyMesh(const Handle(_pyCommand) theCreationCmd);
 230   const _pyID& GetGeom() { return GetCreationCmd()->GetArg(1); }
 231   void Process( const Handle(_pyCommand)& theCommand);
 232   void Flush();
 233   const char* AccessorMethod() const { return _pyMesh_ACCESS_METHOD; }
 234 private:
 235   static void AddMeshAccess( const Handle(_pyCommand)& theCommand )
 236   { theCommand->SetObject( theCommand->GetObject() + "." _pyMesh_ACCESS_METHOD ); }
 237
 238   DEFINE_STANDARD_RTTI (_pyMesh)
 239 };
 240 #undef _pyMesh_ACCESS_METHOD
 241
 242 // -------------------------------------------------------------------------------------
 243 /*!
 244  * \brief Root class for hypothesis
 245  *
 246  * HOWTO assure convertion of a new hypothesis
 247  * In NewHypothesis():
 248  * 1. add a case for the name of the new hypothesis and
 249  * 2. initialize _pyHypothesis fields:
 250  *    . myDim - hypothesis dimention;
 251  *    . myType - type name of the algorithm creating the hypothesis;
 252  *    . myCreationMethod - method name of the algorithm creating the hypothesis;
 253  *    . append to myArgMethods interface methods setting param values in the
 254  *    order they are used when myCreationMethod is called. It is supposed that
 255  *    each interface method sets only one parameter, if it is not so, you are
 256  *    to derive a specific class from _pyHypothesis that would redefine Process(),
 257  *    see _pyComplexParamHypo for example
 258  */
 259 // -------------------------------------------------------------------------------------
 260 class _pyHypothesis: public _pyObject
 261 {
 262 protected:
 263   bool    myIsAlgo, /*myIsLocal, */myIsWrapped, myIsConverted;
 264   int     myDim/*, myAdditionCmdNb*/;
 265   _pyID    myGeom, myMesh;
 266   TCollection_AsciiString       myCreationMethod, myType;
 267   TColStd_SequenceOfAsciiString myArgs;
 268   TColStd_SequenceOfAsciiString myArgMethods;
 269   TColStd_SequenceOfInteger     myNbArgsByMethod;
 270   std::list<Handle(_pyCommand)>  myArgCommands;
 271   std::list<Handle(_pyCommand)>  myUnknownCommands;
 272 public:
 273   _pyHypothesis(const Handle(_pyCommand)& theCreationCmd);
 274   void SetDimMethodType(const int dim, const char* creationMethod, const char* type=0)
 275   { myDim = dim; myCreationMethod = (char*)creationMethod; if ( type ) myType = (char*)type; }
 276   void AddArgMethod(const char* method, const int nbArgs = 1)
 277   { myArgMethods.Append( (char*)method ); myNbArgsByMethod.Append( nbArgs ); }
 278   const TColStd_SequenceOfAsciiString& GetArgs() const { return myArgs; }
 279   const TCollection_AsciiString& GetCreationMethod() const { return myCreationMethod; }
 280   const std::list<Handle(_pyCommand)>& GetArgCommands() const { return myArgCommands; }
 281   void ClearAllCommands();
 282   virtual bool IsAlgo() const { return myIsAlgo; }
 283   bool IsWrapped() const { return myIsWrapped; }
 284   bool & IsConverted() { return myIsConverted; }
 285   int GetDim() const { return myDim; }
 286   const _pyID & GetGeom() const { return myGeom; }
 287   void SetMesh( const _pyID& theMeshId) { if ( myMesh.IsEmpty() ) myMesh = theMeshId; }
 288   const _pyID & GetMesh() const { return myMesh; }
 289   const TCollection_AsciiString GetType() { return myType; }
 290   bool IsWrappable(const _pyID& theMesh) { return !myIsWrapped && myMesh == theMesh; }
 291   virtual bool Addition2Creation( const Handle(_pyCommand)& theAdditionCmd,
 292                                   const _pyID&              theMesh);
 293   static Handle(_pyHypothesis) NewHypothesis( const Handle(_pyCommand)& theCreationCmd);
 294   //     bool HasMesh() const { return !myMesh.IsEmpty(); }
 295   //     void SetGeom( const _pyID& theGeomID ) { myGeom = theGeomID; }
 296   void Process( const Handle(_pyCommand)& theCommand);
 297   void Flush();
 298
 299   DEFINE_STANDARD_RTTI (_pyHypothesis)
 300 };
 301
 302 // -------------------------------------------------------------------------------------
 303 /*!
 304  * \brief Class for hypotheses having several parameters modified by one method
 305  */
 306 // -------------------------------------------------------------------------------------
 307 class _pyComplexParamHypo: public _pyHypothesis
 308 {
 309 public:
 310   _pyComplexParamHypo(const Handle(_pyCommand)& theCreationCmd): _pyHypothesis(theCreationCmd) {}
 311   void Process( const Handle(_pyCommand)& theCommand);
 312
 313   DEFINE_STANDARD_RTTI (_pyComplexParamHypo)
 314 };
 315 DEFINE_STANDARD_HANDLE (_pyComplexParamHypo, _pyHypothesis);
 316
 317 // -------------------------------------------------------------------------------------
 318 /*!
 319  * \brief Class for LayerDistribution hypothesis conversion
 320  */
 321 // -------------------------------------------------------------------------------------
 322 class _pyLayerDistributionHypo: public _pyHypothesis
 323 {
 324   Handle(_pyHypothesis) my1dHyp;
 325 public:
 326   _pyLayerDistributionHypo(const Handle(_pyCommand)& theCreationCmd):
 327     _pyHypothesis(theCreationCmd) {}
 328   void Process( const Handle(_pyCommand)& theCommand);
 329   void Flush();
 330   bool Addition2Creation( const Handle(_pyCommand)& theAdditionCmd,
 331                           const _pyID&              theMesh);
 332
 333   DEFINE_STANDARD_RTTI (_pyLayerDistributionHypo)
 334 };
 335 DEFINE_STANDARD_HANDLE (_pyLayerDistributionHypo, _pyHypothesis);
 336
 337
 338 // -------------------------------------------------------------------------------------
 339 /*!
 340  * \brief Class representing NumberOfSegments hypothesis
 341  */
 342 // -------------------------------------------------------------------------------------
 343 class _pyNumberOfSegmentsHyp: public _pyHypothesis
 344 {
 345 public:
 346   _pyNumberOfSegmentsHyp(const Handle(_pyCommand)& theCrCmd): _pyHypothesis(theCrCmd) {}
 347   virtual bool Addition2Creation( const Handle(_pyCommand)& theAdditionCmd,
 348                                   const _pyID&              theMesh);
 349   void Flush();
 350
 351   DEFINE_STANDARD_RTTI (_pyNumberOfSegmentsHyp)
 352 };
 353 DEFINE_STANDARD_HANDLE (_pyNumberOfSegmentsHyp, _pyHypothesis);
 354
 355 // -------------------------------------------------------------------------------------
 356 /*!
 357  * \brief Class representing smesh.Mesh_Algorithm
 358  */
 359 // -------------------------------------------------------------------------------------
 360 class _pyAlgorithm: public _pyHypothesis
 361 {
 362 public:
 363   _pyAlgorithm(const Handle(_pyCommand)& theCreationCmd);
 364   virtual bool Addition2Creation( const Handle(_pyCommand)& theAdditionCmd,
 365                                   const _pyID&              theMesh);
 366   const char* AccessorMethod() const { return "GetAlgorithm()"; }
 367
 368   DEFINE_STANDARD_RTTI (_pyAlgorithm)
 369 };
 370
 371 #endif