src/SMESH_I/SMESH_PythonDump.cxx

   1 // Copyright (C) 2007-2022  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, or (at your option) any later version.
  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 //  File    : SMESH_DumpPython.cxx
  23 //  Created : Thu Mar 24 17:17:59 2005
  24 //  Author  : Julia DOROVSKIKH
  25 //  Module  : SMESH
  26
  27 #include "SMESH_PythonDump.hxx"
  28
  29 #include "SMESH_2smeshpy.hxx"
  30 #include "SMESH_Comment.hxx"
  31 #include "SMESH_Filter_i.hxx"
  32 #include "SMESH_Gen_i.hxx"
  33 #include "SMESH_MeshEditor_i.hxx"
  34
  35 #include <Basics_Utils.hxx>
  36 #include <Basics_OCCTVersion.hxx>
  37 #include <SALOMEDS_wrap.hxx>
  38
  39 #include <LDOMParser.hxx>
  40 #include <TColStd_HSequenceOfInteger.hxx>
  41 #include <TCollection_AsciiString.hxx>
  42
  43 #if OCC_VERSION_LARGE < 0x07050000
  44 #include <Resource_DataMapIteratorOfDataMapOfAsciiStringAsciiString.hxx>
  45 #endif
  46
  47 #include <cstring>
  48
  49 #include "SMESH_TryCatch.hxx"
  50
  51 namespace SMESH
  52 {
  53
  54   size_t TPythonDump::myCounter = 0;
  55   const char theNotPublishedObjectName[] = "__NOT__Published__Object__";
  56
  57   TVar::TVar(CORBA::Double   value):myVals(1), myIsList(false) { myVals[0] = SMESH_Comment(value); }
  58   TVar::TVar(CORBA::Long     value):myVals(1), myIsList(false) { myVals[0] = SMESH_Comment(value); }
  59   TVar::TVar(CORBA::LongLong value):myVals(1), myIsList(false) { myVals[0] = SMESH_Comment(value); }
  60   TVar::TVar(CORBA::Short    value):myVals(1), myIsList(false) { myVals[0] = SMESH_Comment(value); }
  61   TVar::TVar(const SMESH::double_array& value):myVals(value.length()), myIsList(true)
  62   {
  63     for ( size_t i = 0; i < value.length(); i++)
  64       myVals[i] = SMESH_Comment(value[i]);
  65   }
  66
  67   TPythonDump::TPythonDump():myVarsCounter(0),mySmesh(SMESH_Gen_i::GetSMESHGen())
  68   {
  69     ++myCounter;
  70   }
  71
  72   TPythonDump::TPythonDump(SMESH_Gen_i *smesh):myVarsCounter(0),mySmesh(smesh)
  73   {
  74     ++myCounter;
  75   }
  76   TPythonDump::
  77   ~TPythonDump()
  78   {
  79     if(--myCounter == 0){
  80       SMESH_Gen_i* aSMESHGen = SMESH_Gen_i::GetSMESHGen();
  81       std::string aString = myStream.str();
  82       TCollection_AsciiString aCollection(Standard_CString(aString.c_str()));
  83       if(!aCollection.IsEmpty())
  84       {
  85         const std::string & objEntry = aSMESHGen->GetLastObjEntry();
  86         if ( !objEntry.empty() )
  87           aCollection += (TVar::ObjPrefix() + objEntry ).c_str();
  88         aSMESHGen->AddToPythonScript(aCollection);
  89         MESSAGE(aString);
  90         // prevent misuse of already treated variables
  91         aSMESHGen->UpdateParameters(CORBA::Object_var().in(),"");
  92       }
  93     }
  94   }
  95
  96   TPythonDump& //!< store a variable value. Write either a value or '$varID$'
  97   TPythonDump::
  98   operator<<(const TVar& theVarValue)
  99   {
 100     const std::vector< int >& varIDs = SMESH_Gen_i::GetSMESHGen()->GetLastParamIndices();
 101     if ( theVarValue.myIsList )
 102     {
 103       myStream << "[ ";
 104       for ( size_t i = 1; i <= theVarValue.myVals.size(); ++i )
 105       {
 106         if ( myVarsCounter < (int)varIDs.size() && varIDs[ myVarsCounter ] >= 0 )
 107           myStream << TVar::Quote() << varIDs[ myVarsCounter ] << TVar::Quote();
 108         else
 109           myStream << theVarValue.myVals[i-1];
 110         if ( i < theVarValue.myVals.size() )
 111           myStream << ", ";
 112         ++myVarsCounter;
 113       }
 114       myStream << " ]";
 115     }
 116     else
 117     {
 118       if ( myVarsCounter < (int)varIDs.size() && varIDs[ myVarsCounter ] >= 0 )
 119         myStream << TVar::Quote() << varIDs[ myVarsCounter ] << TVar::Quote();
 120       else
 121         myStream << theVarValue.myVals[0];
 122       ++myVarsCounter;
 123     }
 124     return *this;
 125   }
 126
 127   TPythonDump&
 128   TPythonDump::
 129   operator<<(long int theArg){
 130     myStream<<theArg;
 131     return *this;
 132   }
 133
 134   TPythonDump&
 135   TPythonDump::
 136   operator<<(int theArg){
 137     myStream<<theArg;
 138     return *this;
 139   }
 140
 141   TPythonDump&
 142   TPythonDump::
 143   operator<<(long long theArg){
 144     myStream<<theArg;
 145     return *this;
 146   }
 147
 148   TPythonDump&
 149   TPythonDump::
 150   operator<<(double theArg){
 151     myStream<<theArg;
 152     return *this;
 153   }
 154
 155   TPythonDump&
 156   TPythonDump::
 157   operator<<(float theArg){
 158     myStream<<theArg;
 159     return *this;
 160   }
 161
 162   TPythonDump&
 163   TPythonDump::
 164   operator<<(const void* theArg){
 165     myStream<<theArg;
 166     return *this;
 167   }
 168
 169   TPythonDump&
 170   TPythonDump::
 171   operator<<(const char* theArg){
 172     if ( theArg )
 173       myStream<<theArg;
 174     return *this;
 175   }
 176
 177   TPythonDump&
 178   TPythonDump::
 179   operator<<(const std::string& theArg){
 180     myStream<<theArg;
 181     return *this;
 182   }
 183
 184   TPythonDump&
 185   TPythonDump::
 186   operator<<(const SMESH::ElementType& theArg)
 187   {
 188     myStream<<"SMESH.";
 189     switch(theArg){
 190     case ALL:    myStream<<"ALL";    break;
 191     case NODE:   myStream<<"NODE";   break;
 192     case EDGE:   myStream<<"EDGE";   break;
 193     case FACE:   myStream<<"FACE";   break;
 194     case VOLUME: myStream<<"VOLUME"; break;
 195     case ELEM0D: myStream<<"ELEM0D"; break;
 196     case BALL:   myStream<<"BALL";   break;
 197     default:     myStream<<"__UNKNOWN__ElementType: " << theArg;
 198     }
 199     return *this;
 200   }
 201
 202   TPythonDump&
 203   TPythonDump::
 204   operator<<(const SMESH::GeometryType& theArg)
 205   {
 206     myStream<<"SMESH.";
 207     switch(theArg){
 208     case Geom_POINT:      myStream<<"Geom_POINT";      break;
 209     case Geom_EDGE:       myStream<<"Geom_EDGE";       break;
 210     case Geom_TRIANGLE:   myStream<<"Geom_TRIANGLE";   break;
 211     case Geom_QUADRANGLE: myStream<<"Geom_QUADRANGLE"; break;
 212     case Geom_POLYGON:    myStream<<"Geom_POLYGON";    break;
 213     case Geom_TETRA:      myStream<<"Geom_TETRA";      break;
 214     case Geom_PYRAMID:    myStream<<"Geom_PYRAMID";    break;
 215     case Geom_HEXA:       myStream<<"Geom_HEXA";       break;
 216     case Geom_PENTA:      myStream<<"Geom_PENTA";      break;
 217     case Geom_POLYHEDRA:  myStream<<"Geom_POLYHEDRA";  break;
 218     case Geom_BALL:       myStream<<"Geom_BALL";       break;
 219     default:    myStream<<"__UNKNOWN__GeometryType: " << theArg;
 220     }
 221     return *this;
 222   }
 223   TPythonDump&
 224   TPythonDump::
 225   operator<<(const SMESH::EntityType& theArg)
 226   {
 227     myStream<<"SMESH.";
 228     switch(theArg){
 229     case Entity_0D:                myStream<<"Entity_0D";                break;
 230     case Entity_Edge:              myStream<<"Entity_Edge";              break;
 231     case Entity_Quad_Edge:         myStream<<"Entity_Quad_Edge";         break;
 232     case Entity_Triangle:          myStream<<"Entity_Triangle";          break;
 233     case Entity_Quad_Triangle:     myStream<<"Entity_Quad_Triangle";     break;
 234     case Entity_BiQuad_Triangle:   myStream<<"Entity_BiQuad_Triangle";   break;
 235     case Entity_Quadrangle:        myStream<<"Entity_Quadrangle";        break;
 236     case Entity_Quad_Quadrangle:   myStream<<"Entity_Quad_Quadrangle";   break;
 237     case Entity_BiQuad_Quadrangle: myStream<<"Entity_BiQuad_Quadrangle"; break;
 238     case Entity_Polygon:           myStream<<"Entity_Polygon";           break;
 239     case Entity_Quad_Polygon:      myStream<<"Entity_Quad_Polygon";      break;
 240     case Entity_Tetra:             myStream<<"Entity_Tetra";             break;
 241     case Entity_Quad_Tetra:        myStream<<"Entity_Quad_Tetra";        break;
 242     case Entity_Pyramid:           myStream<<"Entity_Pyramid";           break;
 243     case Entity_Quad_Pyramid:      myStream<<"Entity_Quad_Pyramid";      break;
 244     case Entity_Hexa:              myStream<<"Entity_Hexa";              break;
 245     case Entity_Quad_Hexa:         myStream<<"Entity_Quad_Hexa";         break;
 246     case Entity_TriQuad_Hexa:      myStream<<"Entity_TriQuad_Hexa";      break;
 247     case Entity_Penta:             myStream<<"Entity_Penta";             break;
 248     case Entity_Quad_Penta:        myStream<<"Entity_Quad_Penta";        break;
 249     case Entity_BiQuad_Penta:      myStream<<"Entity_BiQuad_Penta";      break;
 250     case Entity_Hexagonal_Prism:   myStream<<"Entity_Hexagonal_Prism";   break;
 251     case Entity_Polyhedra:         myStream<<"Entity_Polyhedra";         break;
 252     case Entity_Quad_Polyhedra:    myStream<<"Entity_Quad_Polyhedra";    break;
 253     case Entity_Ball:              myStream<<"Entity_Ball";              break;
 254     case Entity_Last:              myStream<<"Entity_Last";              break;
 255     default:    myStream<<"__UNKNOWN__EntityType: " << theArg;
 256     }
 257     return *this;
 258   }
 259
 260   TPythonDump&
 261   TPythonDump::operator<<(const SMESH::long_array& theArg)
 262   {
 263     DumpArray( theArg, *this );
 264     return *this;
 265   }
 266
 267   TPythonDump&
 268   TPythonDump::operator<<(const SMESH::smIdType_array& theArg)
 269   {
 270     DumpArray( theArg, *this );
 271     return *this;
 272   }
 273
 274   TPythonDump&
 275   TPythonDump::operator<<(const SMESH::double_array& theArg)
 276   {
 277     DumpArray( theArg, *this );
 278     return *this;
 279   }
 280
 281   TPythonDump&
 282   TPythonDump::operator<<(const SMESH::nodes_array& theArg)
 283   {
 284     DumpArray( theArg, *this );
 285     return *this;
 286   }
 287
 288   TPythonDump&
 289   TPythonDump::operator<<(const SMESH::string_array& theArray)
 290   {
 291     myStream << "[ ";
 292     for ( CORBA::ULong i = 1; i <= theArray.length(); i++ ) {
 293       myStream << "'" << theArray[i-1] << "'";
 294       if ( i < theArray.length() )
 295         myStream << ", ";
 296     }
 297     myStream << " ]";
 298     return *this;
 299   }
 300
 301   TPythonDump&
 302   TPythonDump::
 303   operator<<(SALOMEDS::SObject_ptr aSObject)
 304   {
 305     if ( !aSObject->_is_nil() ) {
 306       CORBA::String_var entry = aSObject->GetID();
 307       myStream << entry.in();
 308     }
 309     else {
 310       myStream << theNotPublishedObjectName;
 311     }
 312     return *this;
 313   }
 314
 315   TPythonDump&
 316   TPythonDump::
 317   operator<<(CORBA::Object_ptr theArg)
 318   {
 319     SMESH_Gen_i*          aSMESHGen = SMESH_Gen_i::GetSMESHGen();
 320     SALOMEDS::SObject_wrap aSObject = mySmesh->ObjectToSObject(theArg);
 321     if(!aSObject->_is_nil()) {
 322       CORBA::String_var id = aSObject->GetID();
 323       myStream << id;
 324     } else if ( !CORBA::is_nil(theArg)) {
 325       if ( aSMESHGen->CanPublishInStudy( theArg )) // not published SMESH object
 326         myStream << "smeshObj_" << size_t(theArg);
 327       else
 328         myStream << theNotPublishedObjectName;
 329     }
 330     else
 331       myStream << "None";
 332     return *this;
 333   }
 334
 335   TPythonDump&
 336   TPythonDump::
 337   operator<<(SMESH::SMESH_Hypothesis_ptr theArg)
 338   {
 339     SALOMEDS::SObject_wrap aSObject = mySmesh->ObjectToSObject(theArg);
 340     if(aSObject->_is_nil() && !CORBA::is_nil(theArg))
 341       myStream << "hyp_" << theArg->GetId();
 342     else
 343       *this << aSObject;
 344     return *this;
 345   }
 346
 347   TPythonDump&
 348   TPythonDump::
 349   operator<<(SMESH::SMESH_IDSource_ptr theArg)
 350   {
 351     if ( CORBA::is_nil( theArg ) )
 352       return *this << "None";
 353     SALOMEDS::SObject_wrap aSObject = mySmesh->ObjectToSObject(theArg);
 354     if(!aSObject->_is_nil())
 355     {
 356       return *this << aSObject;
 357     }
 358     if ( SMESH::Filter_i* filter = SMESH::DownCast<SMESH::Filter_i*>( theArg ))
 359     {
 360       return *this << filter;
 361     }
 362     if ( SMESH_MeshEditor_i::IsTemporaryIDSource( theArg ))
 363     {
 364       SMESH::SMESH_Mesh_var             mesh = theArg->GetMesh();
 365       SMESH::smIdType_array_var anElementsId = theArg->GetIDs();
 366       SMESH::array_of_ElementType_var  types = theArg->GetTypes();
 367       SMESH::ElementType                type = types->length() ? types[0] : SMESH::ALL;
 368       SALOMEDS::SObject_wrap          meshSO = mySmesh->ObjectToSObject(mesh);
 369
 370       if ( meshSO->_is_nil() ) // don't waste memory for dumping not published objects
 371         return *this << mesh << ".GetIDSource([], " << type << ")";
 372       else
 373         return *this << mesh << ".GetIDSource(" << anElementsId << ", " << type << ")";
 374     }
 375     return *this << theNotPublishedObjectName;
 376   }
 377
 378   TPythonDump&
 379   TPythonDump::
 380   operator<<(SMESH::FilterLibrary_i* theArg)
 381   {
 382     myStream<<"aFilterLibrary"<<theArg;
 383     return *this;
 384   }
 385
 386   TPythonDump&
 387   TPythonDump::
 388   operator<<(SMESH::FilterManager_i* /*theArg*/)
 389   {
 390     myStream<<"aFilterManager";
 391     return *this;
 392   }
 393
 394   TPythonDump&
 395   TPythonDump::
 396   operator<<(SMESH::Filter_i* theArg)
 397   {
 398     myStream<<"aFilter"<<theArg;
 399     return *this;
 400   }
 401
 402   TPythonDump&
 403   TPythonDump::
 404   operator<<(SMESH::Functor_i* theArg)
 405   {
 406     if ( theArg ) {
 407       FunctorType aFunctorType = theArg->GetFunctorType();
 408       switch(aFunctorType) {
 409       case FT_AspectRatio:           myStream<< "aAspectRatio";           break;
 410       case FT_AspectRatio3D:         myStream<< "aAspectRatio3D";         break;
 411       case FT_Warping:               myStream<< "aWarping";               break;
 412       case FT_MinimumAngle:          myStream<< "aMinimumAngle";          break;
 413       case FT_Taper:                 myStream<< "aTaper";                 break;
 414       case FT_Skew:                  myStream<< "aSkew";                  break;
 415       case FT_Area:                  myStream<< "aArea";                  break;
 416       case FT_Volume3D:              myStream<< "aVolume3D";              break;
 417       case FT_MaxElementLength2D:    myStream<< "aMaxElementLength2D";    break;
 418       case FT_MaxElementLength3D:    myStream<< "aMaxElementLength3D";    break;
 419       case FT_FreeBorders:           myStream<< "aFreeBorders";           break;
 420       case FT_FreeEdges:             myStream<< "aFreeEdges";             break;
 421       case FT_FreeNodes:             myStream<< "aFreeNodes";             break;
 422       case FT_FreeFaces:             myStream<< "aFreeFaces";             break;
 423       case FT_EqualNodes:            myStream<< "aEqualNodes";            break;
 424       case FT_EqualEdges:            myStream<< "aEqualEdges";            break;
 425       case FT_EqualFaces:            myStream<< "aEqualFaces";            break;
 426       case FT_EqualVolumes:          myStream<< "aEqualVolumes";          break;
 427       case FT_MultiConnection:       myStream<< "aMultiConnection";       break;
 428       case FT_MultiConnection2D:     myStream<< "aMultiConnection2D";     break;
 429       case FT_Length:                myStream<< "aLength";                break;
 430       case FT_Length2D:              myStream<< "aLength2D";              break;
 431       case FT_Length3D:              myStream<< "aLength3D";              break;
 432       case FT_Deflection2D:          myStream<< "aDeflection2D";          break;
 433       case FT_NodeConnectivityNumber:myStream<< "aNodeConnectivityNumber";break;
 434       case FT_BelongToMeshGroup:     myStream<< "aBelongToMeshGroup";     break;
 435       case FT_BelongToGeom:          myStream<< "aBelongToGeom";          break;
 436       case FT_BelongToPlane:         myStream<< "aBelongToPlane";         break;
 437       case FT_BelongToCylinder:      myStream<< "aBelongToCylinder";      break;
 438       case FT_BelongToGenSurface:    myStream<< "aBelongToGenSurface";    break;
 439       case FT_LyingOnGeom:           myStream<< "aLyingOnGeom";           break;
 440       case FT_RangeOfIds:            myStream<< "aRangeOfIds";            break;
 441       case FT_BadOrientedVolume:     myStream<< "aBadOrientedVolume";     break;
 442       case FT_BareBorderVolume:      myStream<< "aBareBorderVolume";      break;
 443       case FT_BareBorderFace:        myStream<< "aBareBorderFace";        break;
 444       case FT_OverConstrainedVolume: myStream<< "aOverConstrainedVolume"; break;
 445       case FT_OverConstrainedFace:   myStream<< "aOverConstrainedFace";   break;
 446       case FT_LinearOrQuadratic:     myStream<< "aLinearOrQuadratic";     break;
 447       case FT_GroupColor:            myStream<< "aGroupColor";            break;
 448       case FT_ElemGeomType:          myStream<< "aElemGeomType";          break;
 449       case FT_EntityType:            myStream<< "aEntityType";            break;
 450       case FT_CoplanarFaces:         myStream<< "aCoplanarFaces";         break;
 451       case FT_BallDiameter:          myStream<< "aBallDiameter";          break;
 452       case FT_ConnectedElements:     myStream<< "aConnectedElements";     break;
 453       case FT_LessThan:              myStream<< "aLessThan";              break;
 454       case FT_MoreThan:              myStream<< "aMoreThan";              break;
 455       case FT_EqualTo:               myStream<< "aEqualTo";               break;
 456       case FT_LogicalNOT:            myStream<< "aLogicalNOT";            break;
 457       case FT_LogicalAND:            myStream<< "aLogicalAND";            break;
 458       case FT_LogicalOR:             myStream<< "aLogicalOR";             break;
 459       case FT_Undefined:             myStream<< "anUndefined";            break;
 460         //default: -- commented to have a compilation warning
 461       }
 462       myStream<<theArg;
 463     }
 464     return *this;
 465   }
 466
 467   TPythonDump&
 468   TPythonDump::
 469   operator<<(SMESH::Measurements_i* /*theArg*/)
 470   {
 471     myStream<<"aMeasurements";
 472     return *this;
 473   }
 474
 475   TPythonDump& TPythonDump:: operator<<(SMESH_Gen_i* /*theArg*/)
 476   {
 477     myStream << SMESHGenName(); return *this;
 478   }
 479
 480   TPythonDump& TPythonDump::operator<<(SMESH_MeshEditor_i* theArg)
 481   {
 482     myStream << MeshEditorName() << "_" << ( theArg ? theArg->GetMeshId() : -1 ); return *this;
 483   }
 484
 485   TPythonDump& TPythonDump::operator<<(const TCollection_AsciiString & theStr)
 486   {
 487     myStream << theStr; return *this;
 488   }
 489
 490   TPythonDump& TPythonDump::operator<<(const SMESH::AxisStruct & theAxis)
 491   {
 492     *this << "SMESH.AxisStruct( "
 493           << TVar( theAxis.x  ) << ", "
 494           << TVar( theAxis.y  ) << ", "
 495           << TVar( theAxis.z  ) << ", "
 496           << TVar( theAxis.vx ) << ", "
 497           << TVar( theAxis.vy ) << ", "
 498           << TVar( theAxis.vz ) << " )";
 499     return *this;
 500   }
 501
 502   TPythonDump& TPythonDump::operator<<(const SMESH::DirStruct & theDir)
 503   {
 504     const SMESH::PointStruct & P = theDir.PS;
 505     *this << "SMESH.DirStruct( SMESH.PointStruct ( "
 506           << TVar( P.x ) << ", "
 507           << TVar( P.y ) << ", "
 508           << TVar( P.z ) << " ))";
 509     return *this;
 510   }
 511
 512   TPythonDump& TPythonDump::operator<<(const SMESH::PointStruct & P)
 513   {
 514     *this << "SMESH.PointStruct ( "
 515           << TVar( P.x ) << ", "
 516           << TVar( P.y ) << ", "
 517           << TVar( P.z ) << " )";
 518     return *this;
 519   }
 520
 521   TPythonDump& TPythonDump::operator<<(const SMESH::ListOfGroups& theList)
 522   {
 523     DumpArray( theList, *this );
 524     return *this;
 525   }
 526   TPythonDump& TPythonDump::operator<<(const SMESH::ListOfGroups * theList)
 527   {
 528     DumpArray( *theList, *this );
 529     return *this;
 530   }
 531   TPythonDump& TPythonDump::operator<<(const GEOM::ListOfGO& theList)
 532   {
 533     DumpArray( theList, *this );
 534     return *this;
 535   }
 536   TPythonDump& TPythonDump::operator<<(const GEOM::ListOfGBO& theList)
 537   {
 538     DumpArray( theList, *this );
 539     return *this;
 540   }
 541   TPythonDump& TPythonDump::operator<<(const SMESH::ListOfIDSources& theList)
 542   {
 543     DumpArray( theList, *this );
 544     return *this;
 545   }
 546   TPythonDump& TPythonDump::operator<<(const SMESH::submesh_array& theList)
 547   {
 548     DumpArray( theList, *this );
 549     return *this;
 550   }
 551   TPythonDump& TPythonDump::operator<<(const SMESH::ListOfHypothesis& theList)
 552   {
 553     DumpArray( theList, *this );
 554     return *this;
 555   }
 556   TPythonDump& TPythonDump::operator<<(const SMESH::CoincidentFreeBorders& theCFB)
 557   {
 558     // dump CoincidentFreeBorders as a list of lists, each enclosed list
 559     // contains node IDs of a group of coincident free borders where
 560     // each consequent triple of IDs describe a free border: (n1, n2, nLast)
 561     // For example [[1, 2, 10, 20, 21, 40], [11, 12, 15, 55, 54, 41]] describes
 562     // two groups of coincident free borders, each group including two borders
 563
 564     myStream << "[";
 565     for ( CORBA::ULong i = 0; i < theCFB.coincidentGroups.length(); ++i )
 566     {
 567       const SMESH::FreeBordersGroup& aGRP = theCFB.coincidentGroups[ i ];
 568       if ( i ) myStream << ",";
 569       myStream << "[";
 570       for ( CORBA::ULong iP = 0; iP < aGRP.length(); ++iP )
 571       {
 572         const SMESH::FreeBorderPart& aPART = aGRP[ iP ];
 573         if ( 0 <= aPART.border && aPART.border < (CORBA::Long)theCFB.borders.length() )
 574         {
 575           if ( iP ) myStream << ", ";
 576           const SMESH::FreeBorder& aBRD = theCFB.borders[ aPART.border ];
 577           myStream << aBRD.nodeIDs[ aPART.node1    ] << ",";
 578           myStream << aBRD.nodeIDs[ aPART.node2    ] << ",";
 579           myStream << aBRD.nodeIDs[ aPART.nodeLast ];
 580         }
 581       }
 582       myStream << "]";
 583     }
 584     myStream << "]";
 585
 586     return *this;
 587   }
 588
 589   const char* TPythonDump::NotPublishedObjectName()
 590   {
 591     return theNotPublishedObjectName;
 592   }
 593
 594   TCollection_AsciiString myLongStringStart( "TPythonDump::LongStringStart" );
 595   TCollection_AsciiString myLongStringEnd  ( "TPythonDump::LongStringEnd" );
 596
 597   //================================================================================
 598   /*!
 599    * \brief Return marker of long string literal beginning
 600    * \param type - a name of functionality producing the string literal
 601    * \retval TCollection_AsciiString - the marker string to be written into
 602    * a raw python script
 603    */
 604   //================================================================================
 605
 606   TCollection_AsciiString TPythonDump::LongStringStart(const char* type)
 607   {
 608     return
 609       myLongStringStart +
 610       (Standard_Integer) strlen(type) +
 611       " " +
 612       (char*) type;
 613   }
 614
 615   //================================================================================
 616   /*!
 617      * \brief Return marker of long string literal end
 618       * \retval TCollection_AsciiString - the marker string to be written into
 619       * a raw python script
 620    */
 621   //================================================================================
 622
 623   TCollection_AsciiString TPythonDump::LongStringEnd()
 624   {
 625     return myLongStringEnd;
 626   }
 627
 628   //================================================================================
 629   /*!
 630      * \brief Cut out a long string literal from a string
 631       * \param theText - text possibly containing string literals
 632       * \param theFrom - position in the text to search from
 633       * \param theLongString - the retrieved literal
 634       * \param theStringType - a name of functionality produced the literal
 635       * \retval bool - true if a string literal found
 636      *
 637      * The literal is removed from theText; theFrom points position right after
 638      * the removed literal
 639    */
 640   //================================================================================
 641
 642   bool  TPythonDump::CutoutLongString( TCollection_AsciiString & theText,
 643                                        int                     & theFrom,
 644                                        TCollection_AsciiString & theLongString,
 645                                        TCollection_AsciiString & theStringType)
 646   {
 647     if ( theFrom < 1 || theFrom > theText.Length() )
 648       return false;
 649
 650     // ...script \  beg marker    \ \ type \       literal              \  end marker  \ script...
 651     //  "theText myLongStringStart7 Pattern!!! SALOME Mesh Pattern file myLongStringEndtextEnd"
 652     //  012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789
 653     //  0         1         2         3         4         5         6         7         8
 654
 655     theFrom = theText.Location( myLongStringStart, theFrom, theText.Length() ); // = 09
 656     if ( !theFrom )
 657       return false;
 658
 659     // find where literal begins
 660     int literalBeg = theFrom + myLongStringStart.Length(); // = 26
 661     char* typeLenStr = (char*) theText.ToCString() + literalBeg - 1; // = "7 Pattern!!! SALO...."
 662     int typeLen = atoi ( typeLenStr ); // = 7
 663     while ( *typeLenStr != ' ' ) { // look for ' ' after typeLen
 664       literalBeg++; // 26 -> 27
 665       typeLenStr++;
 666     }
 667     literalBeg += typeLen + 1; // = 35
 668     if ( literalBeg > theText.Length() )
 669       return false;
 670
 671     // where literal ends (i.e. end marker begins)
 672     int literalEnd = theText.Location( myLongStringEnd, literalBeg, theText.Length() ); // = 64
 673     if ( !literalEnd )
 674       literalEnd = theText.Length();
 675
 676     // literal
 677     theLongString = theText.SubString( literalBeg, literalEnd - 1); // "!!! SALOME Mesh Pattern file "
 678     // type
 679     theStringType = theText.SubString( literalBeg - typeLen, literalBeg - 1 ); // "Pattern"
 680     // cut off literal
 681     literalEnd += myLongStringEnd.Length(); // = 79
 682     TCollection_AsciiString textEnd = theText.SubString( literalEnd, theText.Length() ); // "textE..."
 683     theText = theText.SubString( 1, theFrom - 1 ) + textEnd;
 684
 685     return true;
 686   }
 687
 688   void printException( const char* text )
 689   {
 690     if (SALOME::VerbosityActivated())
 691       std::cout << "Exception in SMESH_Gen_i::DumpPython(): " << text << std::endl;
 692   }
 693
 694 //=======================================================================
 695 //function : RemoveTabulation
 696 //purpose  :
 697 //=======================================================================
 698   void RemoveTabulation( TCollection_AsciiString& theScript )
 699   {
 700     std::string aString( theScript.ToCString() );
 701     std::string::size_type aPos = 0;
 702     while( aPos < aString.length() )
 703     {
 704       aPos = aString.find( "\n\t", aPos );
 705       if( aPos == std::string::npos )
 706         break;
 707       aString.replace( aPos, 2, "\n" );
 708       aPos++;
 709     }
 710     theScript = aString.c_str();
 711   }
 712 }
 713
 714 //=======================================================================
 715 //function : DumpPython
 716 //purpose  :
 717 //=======================================================================
 718 Engines::TMPFile* SMESH_Gen_i::DumpPython( CORBA::Boolean  isPublished,
 719                                            CORBA::Boolean  isMultiFile,
 720                                            CORBA::Boolean& isValidScript)
 721 {
 722   // localizing
 723   Kernel_Utils::Localizer loc;
 724
 725   SALOMEDS::Study_var aStudy = getStudyServant();
 726   if (CORBA::is_nil(aStudy))
 727     return new Engines::TMPFile(0);
 728
 729   CORBA::String_var compDataType = ComponentDataType();
 730   SALOMEDS::SObject_wrap aSO = aStudy->FindComponent( compDataType.in() );
 731   if (CORBA::is_nil(aSO))
 732     return new Engines::TMPFile(0);
 733
 734   // Map study entries to object names
 735   Resource_DataMapOfAsciiStringAsciiString aMap;
 736   Resource_DataMapOfAsciiStringAsciiString aMapNames;
 737
 738   SALOMEDS::ChildIterator_wrap Itr = aStudy->NewChildIterator(aSO);
 739   for (Itr->InitEx(true); Itr->More(); Itr->Next()) {
 740     SALOMEDS::SObject_wrap aValue = Itr->Value();
 741     CORBA::String_var anID = aValue->GetID();
 742     CORBA::String_var aName = aValue->GetName();
 743     TCollection_AsciiString aGUIName ( (char*) aName.in() );
 744     TCollection_AsciiString anEntry ( (char*) anID.in() );
 745     if (aGUIName.Length() > 0) {
 746       aMapNames.Bind( anEntry, aGUIName );
 747       aMap.Bind( anEntry, aGUIName );
 748     }
 749   }
 750
 751   // Get trace of restored study
 752   SALOMEDS::StudyBuilder_var aStudyBuilder = aStudy->NewBuilder();
 753   SALOMEDS::GenericAttribute_wrap anAttr =
 754     aStudyBuilder->FindOrCreateAttribute(aSO, "AttributePythonObject");
 755
 756   SALOMEDS::AttributePythonObject_var pyAttr =
 757     SALOMEDS::AttributePythonObject::_narrow(anAttr);
 758   CORBA::String_var oldValue = pyAttr->GetObject();
 759   TCollection_AsciiString aSavedTrace (oldValue.in());
 760
 761   // Add trace of API methods calls and replace study entries by names
 762   TCollection_AsciiString aScript;
 763   aScript += DumpPython_impl(aMap, aMapNames, isPublished, isMultiFile,
 764                              myIsHistoricalPythonDump, isValidScript, aSavedTrace);
 765
 766   int aLen = aScript.Length();
 767   unsigned char* aBuffer = new unsigned char[aLen+1];
 768   strcpy((char*)aBuffer, aScript.ToCString());
 769
 770   CORBA::Octet* anOctetBuf =  (CORBA::Octet*)aBuffer;
 771   Engines::TMPFile_var aStreamFile = new Engines::TMPFile(aLen+1, aLen+1, anOctetBuf, 1);
 772
 773   bool hasNotPublishedObjects = aScript.Location( SMESH::theNotPublishedObjectName, 1, aLen);
 774   isValidScript = isValidScript && !hasNotPublishedObjects;
 775
 776   return aStreamFile._retn();
 777 }
 778
 779 //=============================================================================
 780 /*!
 781  *  AddToPythonScript
 782  */
 783 //=============================================================================
 784 void SMESH_Gen_i::AddToPythonScript (const TCollection_AsciiString& theString)
 785 {
 786   if (myPythonScript.IsNull()) {
 787     myPythonScript = new TColStd_HSequenceOfAsciiString;
 788   }
 789   myPythonScript->Append(theString);
 790 }
 791
 792 //=============================================================================
 793 /*!
 794  *  RemoveLastFromPythonScript
 795  */
 796 //=============================================================================
 797 void SMESH_Gen_i::RemoveLastFromPythonScript()
 798 {
 799   if (!myPythonScript.IsNull()) {
 800     int aLen = myPythonScript->Length();
 801     myPythonScript->Remove(aLen);
 802   }
 803 }
 804
 805 //=======================================================================
 806 //function : SavePython
 807 //purpose  :
 808 //=======================================================================
 809 void SMESH_Gen_i::SavePython()
 810 {
 811   // Dump trace of API methods calls
 812   TCollection_AsciiString aScript = GetNewPythonLines();
 813
 814   // Check contents of PythonObject attribute
 815   CORBA::String_var compDataType = ComponentDataType();
 816   SALOMEDS::SObject_wrap aSO = getStudyServant()->FindComponent( compDataType.in() );
 817   SALOMEDS::StudyBuilder_var aStudyBuilder = getStudyServant()->NewBuilder();
 818   SALOMEDS::GenericAttribute_wrap anAttr =
 819     aStudyBuilder->FindOrCreateAttribute(aSO, "AttributePythonObject");
 820
 821   SALOMEDS::AttributePythonObject_var pyAttr =
 822     SALOMEDS::AttributePythonObject::_narrow(anAttr);
 823   CORBA::String_var oldValue = pyAttr->GetObject();
 824   TCollection_AsciiString oldScript (oldValue.in());
 825
 826   if (oldScript.Length() > 0) {
 827     oldScript += "\n";
 828     oldScript += aScript;
 829   } else {
 830     oldScript = aScript;
 831   }
 832
 833   // Store in PythonObject attribute
 834   pyAttr->SetObject(oldScript.ToCString(), 1);
 835
 836   // Clean trace of API methods calls
 837   CleanPythonTrace();
 838 }
 839
 840
 841 // impl
 842
 843
 844 //=============================================================================
 845 /*!
 846  *  FindEntries: Returns a sequence of start/end positions of entries in the string
 847  */
 848 //=============================================================================
 849 Handle(TColStd_HSequenceOfInteger) FindEntries (TCollection_AsciiString& theString)
 850 {
 851   Handle(TColStd_HSequenceOfInteger) aSeq = new TColStd_HSequenceOfInteger;
 852   Standard_Integer aLen = theString.Length();
 853   Standard_Boolean isFound = Standard_False;
 854
 855   char* arr = (char*) theString.ToCString();
 856   Standard_Integer i = 0, j;
 857
 858   while(i < aLen) {
 859     int c = (int)arr[i];
 860     j = i+1;
 861     if ( isdigit( c )) { //Is digit?
 862
 863       isFound = Standard_False;
 864       while((j < aLen) && ( isdigit(c) || c == ':' )) { //Check if it is an entry
 865         c = (int)arr[j++];
 866         if(c == ':') isFound = Standard_True;
 867       }
 868
 869       if (isFound) {
 870         int prev = (i < 1) ? 0 : (int)arr[i - 1];
 871         // to distinguish from a sketcher command:
 872         // last char should be a digit, not ":",
 873         // previous char should not be '"'.
 874         if (arr[j-2] != ':' && prev != '"') {
 875           aSeq->Append(i+1); // +1 because AsciiString starts from 1
 876           aSeq->Append(j-1);
 877         }
 878       }
 879     }
 880
 881     i = j;
 882   }
 883
 884   return aSeq;
 885 }
 886
 887 namespace {
 888
 889   //================================================================================
 890   /*!
 891    * \brief Make a string be a valid python name
 892     * \param aName - a string to fix
 893     * \retval bool - true if aName was not modified
 894    */
 895   //================================================================================
 896
 897   bool fixPythonName(TCollection_AsciiString & aName)
 898   {
 899     bool isValidName = true;
 900     int nbUnderscore = 0;
 901     int p;
 902     // replace not allowed chars by underscore
 903     const char* name = aName.ToCString();
 904     for ( p = 0; name[p]; ++p ) {
 905       if ( !isalnum( name[p] ) && name[p] != '_' )
 906       {
 907         if ( p == 0 || p+1 == aName.Length() || name[p-1] == '_')
 908         {
 909           aName.Remove( p+1, 1 ); // remove __ and _ from the start and the end
 910           --p;
 911           name = aName.ToCString();
 912         }
 913         else
 914         {
 915           aName.SetValue( p+1, '_');
 916           nbUnderscore++;
 917         }
 918         isValidName = false;
 919       }
 920     }
 921     // aName must not start with a digit
 922     if ( aName.IsIntegerValue() ) {
 923       aName.Insert( 1, 'a' );
 924       isValidName = false;
 925     }
 926     // shorten names like CartesianParameters3D_400_400_400_1000000_1
 927     const int nbAllowedUnderscore = 3; /* changed from 2 to 3 by an user request
 928                                           posted to SALOME Forum */
 929     if ( aName.Length() > 20 && nbUnderscore > nbAllowedUnderscore )
 930     {
 931       p = aName.Location( "_", 20, aName.Length());
 932       if ( p > 1 )
 933         aName.Trunc( p-1 );
 934     }
 935     return isValidName;
 936   }
 937
 938   //================================================================================
 939   /*!
 940    * \brief Return Python module names of available plug-ins.
 941    */
 942   //================================================================================
 943
 944   std::vector<std::string> getPluginNames()
 945   {
 946     std::vector<std::string> pluginNames;
 947     std::vector< std::string > xmlPaths = SMESH_Gen::GetPluginXMLPaths();
 948     LDOMParser xmlParser;
 949     for ( size_t i = 0; i < xmlPaths.size(); ++i )
 950     {
 951       bool error = xmlParser.parse( xmlPaths[i].c_str() );
 952       if ( error )
 953       {
 954         TCollection_AsciiString data;
 955         INFOS( xmlParser.GetError(data) );
 956         continue;
 957       }
 958       // <meshers-group name="Standard Meshers"
 959       //                resources="StdMeshers"
 960       //                idl-module="StdMeshers"
 961       //                server-lib="StdMeshersEngine"
 962       //                gui-lib="StdMeshersGUI">
 963       LDOM_Document xmlDoc   = xmlParser.getDocument();
 964       LDOM_NodeList nodeList = xmlDoc.getElementsByTagName( "meshers-group" );
 965       for ( int i = 0; i < nodeList.getLength(); ++i )
 966       {
 967         LDOM_Node       node = nodeList.item( i );
 968         LDOM_Element&   elem = (LDOM_Element&) node;
 969         LDOMString idlModule = elem.getAttribute( "idl-module" );
 970         if ( strlen( idlModule.GetString() ) > 0 )
 971           pluginNames.push_back( idlModule.GetString() );
 972       }
 973     }
 974     return pluginNames;
 975   }
 976 }
 977
 978 //================================================================================
 979 /*!
 980  * \brief Creates a Dump Python script
 981  *  \param [in,out] theObjectNames - map of an entry to a study and python name
 982  *  \param [in] theNames -  - map of an entry to a study name
 983  *  \param [in] isPublished - \c true if dump of object publication in study is needed
 984  *  \param [in] isMultiFile - \c true if dump of each module goes to a separate file
 985  *  \param [in] isHistoricalDump - \c true if removed object should be dumped
 986  *  \param [out] aValidScript - returns \c true if the returned script seems valid
 987  *  \param [in,out] theSavedTrace - the dump stored in the study. It's cleared to
 988  *         decrease memory usage.
 989  *  \return TCollection_AsciiString - the result dump script.
 990  */
 991 //================================================================================
 992
 993 TCollection_AsciiString SMESH_Gen_i::DumpPython_impl
 994                         (Resource_DataMapOfAsciiStringAsciiString& theObjectNames,
 995                          Resource_DataMapOfAsciiStringAsciiString& theNames,
 996                          bool                                      isPublished,
 997                          bool                                      isMultiFile,
 998                          bool                                      isHistoricalDump,
 999                          bool&                                     aValidScript,
1000                          TCollection_AsciiString&                  theSavedTrace)
1001 {
1002   SMESH_TRY;
1003
1004   const TCollection_AsciiString aSmeshpy ( SMESH_2smeshpy::SmeshpyName() );
1005   const TCollection_AsciiString aSMESHGen( SMESH_2smeshpy::GenName() );
1006   const TCollection_AsciiString anOldGen ( SMESH::TPythonDump::SMESHGenName() );
1007   const TCollection_AsciiString helper; // to comfortably append C strings to TCollection_AsciiString
1008   const TCollection_AsciiString tab( isMultiFile ? "\t" : "" ), nt = helper + "\n" + tab;
1009   TCollection_AsciiString optionalComment;
1010
1011   std::list< TCollection_AsciiString > lines; // lines of a script
1012   std::list< TCollection_AsciiString >::iterator linesIt;
1013
1014   lines.push_back(  aSMESHGen + " = smeshBuilder.New()" );
1015   if ( isPublished )
1016     optionalComment = "#";
1017   lines.push_back( optionalComment + aSMESHGen + ".SetEnablePublish( False ) # Set to False to avoid publish in study if not needed or in some particular situations:" );
1018   lines.push_back( "                                 # multiples meshes built in parallel, complex and numerous mesh edition (performance)\n" );
1019   lines.push_back( helper + "aFilterManager = " + aSMESHGen + ".CreateFilterManager()" );
1020   lines.push_back( helper + "aMeasurements = "  + aSMESHGen + ".CreateMeasurements()" );
1021
1022   // Treat dump trace of restored study
1023   if (theSavedTrace.Length() > 0)
1024   {
1025     linesIt = --lines.end();
1026     // Split theSavedTrace into lines
1027     int from = 1, end = theSavedTrace.Length(), to;
1028     while ( from < end && ( to = theSavedTrace.Location( "\n", from, end )))
1029     {
1030       if ( theSavedTrace.ToCString()[from-1] == '\t' )
1031         ++from;
1032       if ( to != from )
1033         lines.push_back( theSavedTrace.SubString( from, to - 1 ));
1034       from = to + 1;
1035     }
1036     // For the conversion of IDL API calls -> smeshBuilder.py API, "smesh" standing for SMESH_Gen
1037     // was replaces with "smeshgen" (==TPythonDump::SMESHGenName()).
1038     // Change "smesh" -> "smeshgen" in the trace saved before passage to smeshBuilder.py API
1039     bool isNewVersion =
1040       theSavedTrace.Location( anOldGen + ".", 1, theSavedTrace.Length() );
1041     theSavedTrace.Clear();
1042     if ( !isNewVersion )
1043     {
1044       const TCollection_AsciiString aSmeshCall ( "smesh." ), gen( "gen" );
1045       int beg, end, from;
1046       for ( ++linesIt; linesIt != lines.end(); ++linesIt )
1047       {
1048         TCollection_AsciiString& aSavedLine = *linesIt;
1049         end = aSavedLine.Length(), from = 1;
1050         while ( from < end && ( beg = aSavedLine.Location( aSmeshCall, from, end )))
1051         {
1052           char charBefore = ( beg == 1 ) ? ' ' : aSavedLine.Value( beg - 1 );
1053           if ( isspace( charBefore ) || charBefore == '=' ) { // "smesh." is not a part of a long word
1054             aSavedLine.Insert( beg + aSmeshCall.Length() - 1, gen );// "smesh" -> "smeshgen"
1055             end += gen.Length();
1056           }
1057           from = beg + aSmeshCall.Length();
1058         }
1059       }
1060     }
1061   }
1062
1063   // Add new dump trace of API methods calls to script lines
1064   if (!myPythonScript.IsNull())
1065   {
1066     Handle(TColStd_HSequenceOfAsciiString) aPythonScript = myPythonScript;
1067     Standard_Integer istr, aLen = aPythonScript->Length();
1068     for (istr = 1; istr <= aLen; istr++)
1069       lines.push_back( aPythonScript->Value( istr ));
1070   }
1071
1072   // Convert IDL API calls into smeshBuilder.py API.
1073   // Some objects are wrapped with python classes and
1074   // Resource_DataMapOfAsciiStringAsciiString holds methods returning wrapped objects
1075   Resource_DataMapOfAsciiStringAsciiString anEntry2AccessorMethod;
1076   std::set< TCollection_AsciiString >      aRemovedObjIDs;
1077   if ( !getenv("NO_2smeshpy_conversion"))
1078     SMESH_2smeshpy::ConvertScript( lines, anEntry2AccessorMethod,
1079                                    theObjectNames, aRemovedObjIDs,
1080                                    isHistoricalDump );
1081
1082   bool importGeom = false;
1083   GEOM::GEOM_Gen_ptr geom[2];
1084   for ( int isShaper = 0; isShaper < 2; ++isShaper )
1085   {
1086     geom[ isShaper ] = GetGeomEngine( isShaper );
1087     if ( CORBA::is_nil( geom[ isShaper ]))
1088       continue;
1089     // Add names of GEOM objects to theObjectNames to exclude same names of SMESH objects
1090     GEOM::string_array_var aGeomNames = geom[ isShaper ]->GetAllDumpNames();
1091     for ( CORBA::ULong ign = 0; ign < aGeomNames->length(); ign++) {
1092       TCollection_AsciiString aName = aGeomNames[ign].in();
1093       theObjectNames.Bind(aName, "1");
1094     }
1095   }
1096
1097   TCollection_AsciiString anUpdatedScript;
1098
1099   Resource_DataMapOfAsciiStringAsciiString mapRemoved;
1100   Resource_DataMapOfAsciiStringAsciiString mapEntries; // { entry: name } present in anUpdatedScript
1101   Standard_Integer objectCounter = 0;
1102   TCollection_AsciiString anEntry, aName, aGUIName, aBaseName("smeshObj_");
1103
1104   std::string           compDataType = ComponentDataType(); // SMESH module's data type
1105   SALOMEDS::SComponent_var   smeshSO = getStudyServant()->FindComponent( compDataType.c_str() );
1106   CORBA::String_var          smeshID = smeshSO->GetID();
1107   TCollection_AsciiString smeshEntry = smeshID.in();
1108
1109   // Treat every script line and add it to anUpdatedScript
1110   for ( linesIt = lines.begin(); linesIt != lines.end(); ++linesIt )
1111   {
1112     TCollection_AsciiString& aLine = *linesIt;
1113     anUpdatedScript += tab;
1114     {
1115       //Replace characters used instead of quote marks to quote notebook variables
1116       int pos = 1;
1117       while (( pos = aLine.Location( 1, SMESH::TVar::Quote(), pos, aLine.Length() )))
1118         aLine.SetValue( pos, '"' );
1119     }
1120     // Find entries to be replaced by names
1121     Handle(TColStd_HSequenceOfInteger) aSeq = FindEntries(aLine);
1122     const Standard_Integer aSeqLen = aSeq->Length();
1123     Standard_Integer aStart = 1;
1124     for (Standard_Integer i = 1; i <= aSeqLen; i += 2)
1125     {
1126       if ( aStart < aSeq->Value(i) )
1127         anUpdatedScript += aLine.SubString( aStart, aSeq->Value(i) - 1 ); // line part before i-th entry
1128       anEntry = aLine.SubString( aSeq->Value(i), aSeq->Value(i + 1) );
1129       // is a GEOM object?
1130       CORBA::String_var geomName;
1131       if ( !CORBA::is_nil( geom[0] ))
1132         geomName = geom[0]->GetDumpName( anEntry.ToCString() );
1133       if (( !geomName.in() || !geomName.in()[0] ) && !CORBA::is_nil( geom[1] ))
1134         geomName = geom[1]->GetDumpName( anEntry.ToCString() );
1135       if ( !geomName.in() || !geomName.in()[0] ) {
1136         // is a SMESH object
1137         if ( theObjectNames.IsBound( anEntry )) {
1138           // The Object is in Study
1139           aName = theObjectNames.Find( anEntry );
1140           // check validity of aName
1141           bool isValidName = fixPythonName( aName );
1142           if (theObjectNames.IsBound(aName) && anEntry != theObjectNames(aName)) {
1143             // diff objects have same name - make a new name by appending a digit
1144             TCollection_AsciiString aName2;
1145             Standard_Integer i = 0;
1146             do {
1147               aName2 = aName + "_" + ++i;
1148             } while (theObjectNames.IsBound(aName2) && anEntry != theObjectNames(aName2));
1149             aName = aName2;
1150             isValidName = false;
1151           }
1152           if ( !isValidName )
1153             theObjectNames(anEntry) = aName;
1154
1155           if ( aLine.Value(1) != '#' )
1156             mapEntries.Bind(anEntry, aName);
1157         }
1158         else
1159         {
1160           if ( !anEntry.StartsWith( smeshEntry )) // not SMESH object
1161           {
1162             aName = SMESH::TPythonDump::NotPublishedObjectName();
1163           }
1164           else
1165           {
1166             // Removed Object
1167             do {
1168               aName = aBaseName + (++objectCounter);
1169             } while (theObjectNames.IsBound(aName));
1170
1171             if ( !aRemovedObjIDs.count( anEntry ) && aLine.Value(1) != '#')
1172               mapRemoved.Bind(anEntry, aName);
1173
1174             theObjectNames.Bind(anEntry, aName);
1175           }
1176         }
1177         theObjectNames.Bind(aName, anEntry); // to detect same name of diff objects
1178       }
1179       else
1180       {
1181         aName = geomName.in();
1182         importGeom = true;
1183       }
1184       anUpdatedScript += aName;
1185       aStart = aSeq->Value(i + 1) + 1;
1186
1187     } // loop on entries within aLine
1188
1189     if ( aSeqLen == 0 )
1190       anUpdatedScript += aLine;
1191     else if ( aSeq->Value( aSeqLen ) < aLine.Length() )
1192       anUpdatedScript += aLine.SubString( aSeq->Value(aSeqLen) + 1, aLine.Length() );
1193
1194     anUpdatedScript += '\n';
1195   }
1196
1197   // Make an initial part of aSript
1198
1199   TCollection_AsciiString initPart = "import ";
1200   if ( isMultiFile )
1201     initPart += "salome, ";
1202   initPart += " SMESH, SALOMEDS\n";
1203   initPart += "from salome.smesh import smeshBuilder\n";
1204   if ( importGeom && isMultiFile )
1205   {
1206     initPart += ("\n## import GEOM dump file ## \n"
1207                  "import string, os, sys, re, inspect\n"
1208                  "thisFile   = inspect.getfile( inspect.currentframe() )\n"
1209                  "thisModule = os.path.splitext( os.path.basename( thisFile ))[0]\n"
1210                  "sys.path.insert( 0, os.path.dirname( thisFile ))\n"
1211                  "exec(\"from \"+re.sub(\"SMESH$\",\"GEOM\",thisModule)+\" import *\")\n\n");
1212   }
1213   // import python files corresponding to plugins if they are used in anUpdatedScript
1214   {
1215     //TCollection_AsciiString importStr;
1216     std::vector<std::string> pluginNames = getPluginNames();
1217     for ( size_t i = 0; i < pluginNames.size(); ++i )
1218     {
1219       // Convert access to plugin members:
1220       // e.g. StdMeshers.QUAD_REDUCED -> smeshBuilder.QUAD_REDUCED
1221       TCollection_AsciiString pluginAccess = (pluginNames[i] + ".").c_str() ;
1222       int iFrom = 1, iPos;
1223       while (( iPos = anUpdatedScript.Location( pluginAccess, iFrom, anUpdatedScript.Length() )))
1224       {
1225         //anUpdatedScript.Insert( iPos + pluginNames[i].size(), "Builder" );
1226         anUpdatedScript.Remove( iPos, pluginNames[i].size() );
1227         anUpdatedScript.Insert( iPos, "smeshBuilder" );
1228         iFrom = iPos - pluginNames[i].size() + 12;
1229       }
1230       // if any plugin member is used, import the plugin
1231       // if ( iFrom > 1 )
1232       //   importStr += ( helper + "\n" "from salome." + pluginNames[i].c_str() +
1233       //                  " import " + pluginNames[i].c_str() +"Builder" );
1234     }
1235     // if ( !importStr.IsEmpty() )
1236     //   initPart += importStr + "\n";
1237   }
1238
1239   if ( isMultiFile )
1240     initPart += "def RebuildData():";
1241   initPart += "\n";
1242
1243   anUpdatedScript.Prepend( initPart );
1244
1245   // Make a final part of aScript
1246
1247   // Dump object removal
1248   TCollection_AsciiString removeObjPart;
1249   if ( !mapRemoved.IsEmpty() ) {
1250     removeObjPart += nt + "## some objects were removed";
1251     removeObjPart += nt + "aStudyBuilder = salome.myStudy.NewBuilder()";
1252     Resource_DataMapIteratorOfDataMapOfAsciiStringAsciiString mapRemovedIt;
1253     for ( mapRemovedIt.Initialize( mapRemoved ); mapRemovedIt.More(); mapRemovedIt.Next() ) {
1254       aName   = mapRemovedIt.Value(); // python name
1255       anEntry = mapRemovedIt.Key();
1256       removeObjPart += nt + "SO = salome.myStudy.FindObjectIOR(salome.myStudy.ConvertObjectToIOR(";
1257       removeObjPart += aName;
1258       // for object wrapped by class of smeshBuilder.py
1259       if ( anEntry2AccessorMethod.IsBound( anEntry ) )
1260         removeObjPart += helper + "." + anEntry2AccessorMethod( anEntry );
1261       removeObjPart += helper + "))" + nt + "if SO: aStudyBuilder.RemoveObjectWithChildren(SO)";
1262     }
1263   }
1264
1265   // Set object names
1266   TCollection_AsciiString setNamePart;
1267   Resource_DataMapIteratorOfDataMapOfAsciiStringAsciiString mapEntriesIt;
1268   for ( mapEntriesIt.Initialize( mapEntries ); mapEntriesIt.More(); mapEntriesIt.Next() )
1269   {
1270     anEntry = mapEntriesIt.Key();
1271     aName   = mapEntriesIt.Value(); // python name
1272     if ( theNames.IsBound( anEntry ))
1273     {
1274       aGUIName = theNames.Find(anEntry);
1275       aGUIName.RemoveAll('\''); // remove a quote from a name (issue 22360)
1276       setNamePart += nt + aSMESHGen + ".SetName(" + aName;
1277       if ( anEntry2AccessorMethod.IsBound( anEntry ) )
1278         setNamePart += helper + "." + anEntry2AccessorMethod( anEntry );
1279       setNamePart += helper + ", '" + aGUIName + "')";
1280     }
1281   }
1282   if ( !setNamePart.IsEmpty() )
1283   {
1284     setNamePart.Insert( 1, nt + "## Set names of Mesh objects" );
1285   }
1286
1287   // Store visual properties of displayed objects
1288
1289   TCollection_AsciiString visualPropertiesPart;
1290   if (isPublished)
1291   {
1292     //Output the script that sets up the visual parameters.
1293     CORBA::String_var compDataType = ComponentDataType();
1294     CORBA::String_var script = getStudyServant()->GetDefaultScript( compDataType.in(), tab.ToCString() );
1295     if ( script.in() && script.in()[0] ) {
1296       visualPropertiesPart += nt + "### Store presentation parameters of displayed objects\n";
1297       visualPropertiesPart += script.in();
1298     }
1299   }
1300
1301   anUpdatedScript += removeObjPart + '\n' + setNamePart + '\n' + visualPropertiesPart;
1302
1303   if ( isMultiFile )
1304   {
1305     anUpdatedScript +=
1306       "\n\tpass"
1307       "\n"
1308       "\nif __name__ == '__main__':"
1309       "\n\tSMESH_RebuildData = RebuildData"
1310       "\n\texec('import '+re.sub('SMESH$','GEOM',thisModule)+' as GEOM_dump')"
1311       "\n\tGEOM_dump.RebuildData()"
1312       "\n\texec('from '+re.sub('SMESH$','GEOM',thisModule)+' import * ')"
1313       "\n\tSMESH_RebuildData()";
1314   }
1315   anUpdatedScript += "\n";
1316
1317   // no need now as we use 'tab' and 'nt' variables depending on isMultiFile
1318   // if( !isMultiFile ) // remove unnecessary tabulation
1319   //   RemoveTabulation( anUpdatedScript );
1320
1321   // -----------------------------------------------------------------
1322   // put string literals describing patterns into separate functions
1323   // -----------------------------------------------------------------
1324
1325   TCollection_AsciiString aLongString, aFunctionType;
1326   int where = 1;
1327   std::set< std::string > functionNameSet;
1328   while ( SMESH::TPythonDump::CutoutLongString( anUpdatedScript, where, aLongString, aFunctionType ))
1329   {
1330     // make a python string literal
1331     aLongString.Prepend(":\n\treturn '''\n");
1332     aLongString += "\n\t'''\n\tpass\n";
1333
1334     TCollection_AsciiString functionName;
1335
1336     // check if the function returning this literal is already defined
1337     int posAlready = anUpdatedScript.Location( aLongString, where, anUpdatedScript.Length() );
1338     if ( posAlready ) // already defined
1339     {
1340       // find the function name
1341       int functBeg = posAlready;
1342       char* script = (char*) anUpdatedScript.ToCString() + posAlready - 1; // look at ":" after "def function()"
1343       while ( *script != ' ' ) {
1344         script--;
1345         functBeg--;
1346       }
1347       functBeg++; // do not take ' '
1348       posAlready--; // do not take ':'
1349       functionName = anUpdatedScript.SubString( functBeg, posAlready );
1350     }
1351     else // not defined yet
1352     {
1353       // find a unique function name
1354       fixPythonName( aFunctionType );
1355       Standard_Integer nb = 0;
1356       do functionName = aFunctionType + "_" + ( nb++ ) + "()";
1357       while ( !functionNameSet.insert( functionName.ToCString() ).second );
1358
1359       // define function
1360       TCollection_AsciiString funDef = helper + "def " + functionName + aLongString;
1361       if ( isMultiFile )
1362       {
1363         anUpdatedScript += helper + "\n\n" + funDef;
1364       }
1365       else
1366       {
1367         funDef += "\n\n";
1368         anUpdatedScript.Insert( 1, funDef);
1369         where += funDef.Length();
1370       }
1371     }
1372     anUpdatedScript.InsertBefore( where, functionName ); // call function
1373   }
1374
1375   aValidScript = true;
1376
1377   return anUpdatedScript;
1378
1379   SMESH_CATCH( SMESH::printException );
1380
1381   aValidScript = false;
1382   return "";
1383 }
1384
1385 //=============================================================================
1386 /*!
1387  *  GetNewPythonLines
1388  */
1389 //=============================================================================
1390 TCollection_AsciiString SMESH_Gen_i::GetNewPythonLines()
1391 {
1392   TCollection_AsciiString aScript;
1393
1394   // Dump trace of API methods calls
1395   if (!myPythonScript.IsNull()) {
1396     Handle(TColStd_HSequenceOfAsciiString) aPythonScript = myPythonScript;
1397     Standard_Integer istr, aLen = aPythonScript->Length();
1398     for (istr = 1; istr <= aLen; istr++) {
1399       aScript += "\n";
1400       aScript += aPythonScript->Value(istr);
1401     }
1402     aScript += "\n";
1403   }
1404
1405   return aScript;
1406 }
1407
1408 //=============================================================================
1409 /*!
1410  *  CleanPythonTrace
1411  */
1412 //=============================================================================
1413 void SMESH_Gen_i::CleanPythonTrace()
1414 {
1415   TCollection_AsciiString aScript;
1416
1417   // Clean trace of API methods calls
1418   if (!myPythonScript.IsNull()) {
1419     myPythonScript->Clear();
1420   }
1421 }
1422
1423 //================================================================================
1424 /*!
1425  * \brief Count inclusions of a string in a raw Python dump script
1426  */
1427 //================================================================================
1428
1429 int SMESH_Gen_i::CountInPyDump(const TCollection_AsciiString& theText)
1430 {
1431   int count = 0;
1432
1433   SALOMEDS::Study_var aStudy = getStudyServant();
1434   if ( CORBA::is_nil( aStudy ))
1435     return count;
1436
1437   SMESH_Gen_i* me = GetSMESHGen();
1438   CORBA::String_var compDataType = me->ComponentDataType();
1439   SALOMEDS::SObject_wrap aSO = aStudy->FindComponent( compDataType.in() );
1440   if ( CORBA::is_nil( aSO ))
1441     return count;
1442
1443   // Trace saved in the study
1444   SALOMEDS::GenericAttribute_wrap attr;
1445   if ( aSO->FindAttribute( attr.inout(), "AttributePythonObject" ))
1446   {
1447     SALOMEDS::AttributePythonObject_var pyAttr =
1448       SALOMEDS::AttributePythonObject::_narrow( attr );
1449     CORBA::String_var script = pyAttr->GetObject();
1450     for ( const char * scriptPos = script.in(); true; ++scriptPos )
1451       if (( scriptPos = strstr( scriptPos, theText.ToCString() )))
1452         ++count;
1453       else
1454         break;
1455   }
1456
1457   // New python commands
1458   if ( !me->myPythonScript.IsNull() )
1459   {
1460     const int nbLines = me->myPythonScript->Length();
1461     for ( int i = 1; i <= nbLines; ++i )
1462     {
1463       const TCollection_AsciiString& line = me->myPythonScript->Value( i );
1464       for ( int loc = 1; loc <= line.Length(); ++loc )
1465         if (( loc = line.Location( theText, loc, line.Length() )))
1466           ++count;
1467         else
1468           break;
1469     }
1470   }
1471
1472   return count;
1473 }