src/SMESH_I/SMESH_DumpPython.cxx

   1 //  Copyright (C) 2007-2011  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 // File    : SMESH_Gen_i_DumpPython.cxx
  24 // Created : Thu Mar 24 17:17:59 2005
  25 // Author  : Julia DOROVSKIKH
  26 // Module  : SMESH
  27 // $Header : $
  28 //
  29 #include "SMESH_PythonDump.hxx"
  30 #include "SMESH_Gen_i.hxx"
  31 #include "SMESH_Filter_i.hxx"
  32 #include "SMESH_MeshEditor_i.hxx"
  33 #include "SMESH_2smeshpy.hxx"
  34
  35 #include <TColStd_HSequenceOfInteger.hxx>
  36 #include <TCollection_AsciiString.hxx>
  37 #include <SMESH_Comment.hxx>
  38
  39
  40 #ifdef _DEBUG_
  41 static int MYDEBUG = 0;
  42 #else
  43 static int MYDEBUG = 0;
  44 #endif
  45
  46 static TCollection_AsciiString NotPublishedObjectName()
  47 {
  48   return "__NOT__Published__Object__";
  49 }
  50
  51 namespace SMESH
  52 {
  53
  54   size_t TPythonDump::myCounter = 0;
  55
  56   TPythonDump::
  57   TPythonDump()
  58   {
  59     ++myCounter;
  60   }
  61   TPythonDump::
  62   ~TPythonDump()
  63   {
  64     if(--myCounter == 0){
  65       SMESH_Gen_i* aSMESHGen = SMESH_Gen_i::GetSMESHGen();
  66       std::string aString = myStream.str();
  67       TCollection_AsciiString aCollection(Standard_CString(aString.c_str()));
  68       SALOMEDS::Study_ptr aStudy = aSMESHGen->GetCurrentStudy();
  69       if(!aStudy->_is_nil() && !aCollection.IsEmpty()){
  70         aSMESHGen->AddToPythonScript(aStudy->StudyId(),aCollection);
  71         if(MYDEBUG) MESSAGE(aString);
  72       }
  73     }
  74   }
  75
  76   TPythonDump&
  77   TPythonDump::
  78   operator<<(long int theArg){
  79     myStream<<theArg;
  80     return *this;
  81   }
  82
  83   TPythonDump&
  84   TPythonDump::
  85   operator<<(int theArg){
  86     myStream<<theArg;
  87     return *this;
  88   }
  89
  90   TPythonDump&
  91   TPythonDump::
  92   operator<<(double theArg){
  93     myStream<<theArg;
  94     return *this;
  95   }
  96
  97   TPythonDump&
  98   TPythonDump::
  99   operator<<(float theArg){
 100     myStream<<theArg;
 101     return *this;
 102   }
 103
 104   TPythonDump&
 105   TPythonDump::
 106   operator<<(const void* theArg){
 107     myStream<<theArg;
 108     return *this;
 109   }
 110
 111   TPythonDump&
 112   TPythonDump::
 113   operator<<(const char* theArg){
 114     if ( theArg )
 115       myStream<<theArg;
 116     return *this;
 117   }
 118
 119   TPythonDump&
 120   TPythonDump::
 121   operator<<(const SMESH::ElementType& theArg)
 122   {
 123     myStream<<"SMESH.";
 124     switch(theArg){
 125     case ALL:   myStream<<"ALL";break;
 126     case NODE:  myStream<<"NODE";break;
 127     case EDGE:  myStream<<"EDGE";break;
 128     case FACE:  myStream<<"FACE";break;
 129     case VOLUME:myStream<<"VOLUME";break;
 130     }
 131     return *this;
 132   }
 133
 134   TPythonDump&
 135   TPythonDump::
 136   operator<<(const SMESH::GeometryType& theArg)
 137   {
 138     myStream<<"SMESH.";
 139     switch(theArg){
 140     case Geom_POINT:      myStream<<"Geom_POINT";      break;
 141     case Geom_EDGE:       myStream<<"Geom_EDGE";       break;
 142     case Geom_TRIANGLE:   myStream<<"Geom_TRIANGLE";   break;
 143     case Geom_QUADRANGLE: myStream<<"Geom_QUADRANGLE"; break;
 144     case Geom_POLYGON:    myStream<<"Geom_POLYGON";    break;
 145     case Geom_TETRA:      myStream<<"Geom_TETRA";      break;
 146     case Geom_PYRAMID:    myStream<<"Geom_PYRAMID";    break;
 147     case Geom_HEXA:       myStream<<"Geom_HEXA";       break;
 148     case Geom_PENTA:      myStream<<"Geom_PENTA";      break;
 149     case Geom_POLYHEDRA:  myStream<<"Geom_POLYHEDRA";  break;
 150    }
 151     return *this;
 152   }
 153
 154   template<class TArray>
 155   void DumpArray(const TArray& theArray, TPythonDump & theStream)
 156   {
 157     theStream << "[ ";
 158     for (int i = 1; i <= theArray.length(); i++) {
 159       theStream << theArray[i-1];
 160       if ( i < theArray.length() )
 161         theStream << ", ";
 162     }
 163     theStream << " ]";
 164   }
 165
 166   TPythonDump&
 167   TPythonDump::operator<<(const SMESH::long_array& theArg)
 168   {
 169     DumpArray( theArg, *this );
 170     return *this;
 171   }
 172
 173   TPythonDump&
 174   TPythonDump::operator<<(const SMESH::double_array& theArg)
 175   {
 176     DumpArray( theArg, *this );
 177     return *this;
 178   }
 179
 180   TPythonDump&
 181   TPythonDump::
 182   operator<<(SALOMEDS::SObject_ptr aSObject)
 183   {
 184     if ( !aSObject->_is_nil() )
 185       myStream << aSObject->GetID();
 186     else
 187       myStream << NotPublishedObjectName();
 188     return *this;
 189   }
 190
 191   TPythonDump&
 192   TPythonDump::
 193   operator<<(CORBA::Object_ptr theArg)
 194   {
 195     SMESH_Gen_i* aSMESHGen = SMESH_Gen_i::GetSMESHGen();
 196     SALOMEDS::Study_var aStudy = aSMESHGen->GetCurrentStudy();
 197     SALOMEDS::SObject_var aSObject = SMESH_Gen_i::ObjectToSObject(aStudy,theArg);
 198     if(!aSObject->_is_nil()) {
 199       CORBA::String_var id = aSObject->GetID();
 200       myStream << id;
 201     } else if ( !CORBA::is_nil(theArg)) {
 202       if ( aSMESHGen->CanPublishInStudy( theArg )) // not published SMESH object
 203         myStream << "smeshObj_" << size_t(theArg);
 204       else
 205         myStream << NotPublishedObjectName();
 206     }
 207     else
 208       myStream << "None";
 209     return *this;
 210   }
 211
 212   TPythonDump&
 213   TPythonDump::
 214   operator<<(SMESH::SMESH_Hypothesis_ptr theArg)
 215   {
 216     SALOMEDS::Study_var aStudy = SMESH_Gen_i::GetSMESHGen()->GetCurrentStudy();
 217     SALOMEDS::SObject_var aSObject = SMESH_Gen_i::ObjectToSObject(aStudy,theArg);
 218     if(aSObject->_is_nil() && !CORBA::is_nil(theArg))
 219       myStream << "hyp_" << theArg->GetId();
 220     else
 221       *this << CORBA::Object_ptr( theArg );
 222     return *this;
 223   }
 224
 225   TPythonDump&
 226   TPythonDump::
 227   operator<<(SMESH::SMESH_IDSource_ptr theArg)
 228   {
 229     SMESH_Gen_i* aSMESHGen = SMESH_Gen_i::GetSMESHGen();
 230     SALOMEDS::Study_var aStudy = aSMESHGen->GetCurrentStudy();
 231     SALOMEDS::SObject_var aSObject = SMESH_Gen_i::ObjectToSObject(aStudy,theArg);
 232     if(!aSObject->_is_nil() || CORBA::is_nil( theArg ))
 233       return *this << aSObject;
 234     SMESH::long_array_var anElementsId = theArg->GetIDs();
 235     return *this << anElementsId;
 236   }
 237
 238   TPythonDump&
 239   TPythonDump::
 240   operator<<(SMESH::FilterLibrary_i* theArg)
 241   {
 242     myStream<<"aFilterLibrary"<<theArg;
 243     return *this;
 244   }
 245
 246   TPythonDump&
 247   TPythonDump::
 248   operator<<(SMESH::FilterManager_i* theArg)
 249   {
 250     myStream<<"aFilterManager";
 251     return *this;
 252   }
 253
 254   TPythonDump&
 255   TPythonDump::
 256   operator<<(SMESH::Filter_i* theArg)
 257   {
 258     myStream<<"aFilter"<<theArg;
 259     return *this;
 260   }
 261
 262   TPythonDump&
 263   TPythonDump::
 264   operator<<(SMESH::Functor_i* theArg)
 265   {
 266     if ( theArg ) {
 267       FunctorType aFunctorType = theArg->GetFunctorType();
 268       switch(aFunctorType){
 269       case FT_AspectRatio:      myStream<< "anAspectRatio";     break;
 270       case FT_AspectRatio3D:    myStream<< "anAspectRatio3D";   break;
 271       case FT_Warping:          myStream<< "aWarping";          break;
 272       case FT_MinimumAngle:     myStream<< "aMinimumAngle";     break;
 273       case FT_Taper:            myStream<< "aTaper";            break;
 274       case FT_Skew:             myStream<< "aSkew";             break;
 275       case FT_Area:             myStream<< "aArea";             break;
 276       case FT_Volume3D:         myStream<< "aVolume3D";         break;
 277       case FT_FreeBorders:      myStream<< "aFreeBorders";      break;
 278       case FT_FreeEdges:        myStream<< "aFreeEdges";        break;
 279       case FT_FreeNodes:        myStream<< "aFreeNodes";        break;
 280       case FT_FreeFaces:        myStream<< "aFreeFaces";        break;
 281       case FT_MultiConnection:  myStream<< "aMultiConnection";  break;
 282       case FT_MultiConnection2D:myStream<< "aMultiConnection2D";break;
 283       case FT_Length:           myStream<< "aLength";           break;
 284       case FT_Length2D:         myStream<< "aLength";           break;
 285       case FT_BelongToGeom:     myStream<< "aBelongToGeom";     break;
 286       case FT_BelongToPlane:    myStream<< "aBelongToPlane";    break;
 287       case FT_BelongToCylinder: myStream<< "aBelongToCylinder"; break;
 288       case FT_BelongToGenSurface:myStream<<"aBelongToGenSurface";break;
 289       case FT_LyingOnGeom:      myStream<< "aLyingOnGeom";      break;
 290       case FT_CoplanarFaces:    myStream<< "aCoplanarFaces";    break;
 291       case FT_RangeOfIds:       myStream<< "aRangeOfIds";       break;
 292       case FT_BadOrientedVolume:myStream<< "aBadOrientedVolume";break;
 293       case FT_LinearOrQuadratic:myStream<< "aLinearOrQuadratic";break;
 294       case FT_GroupColor:       myStream<< "aGroupColor";       break;
 295       case FT_ElemGeomType:     myStream<< "anElemGeomType";    break;
 296       case FT_LessThan:         myStream<< "aLessThan";         break;
 297       case FT_MoreThan:         myStream<< "aMoreThan";         break;
 298       case FT_EqualTo:          myStream<< "anEqualTo";         break;
 299       case FT_LogicalNOT:       myStream<< "aLogicalNOT";       break;
 300       case FT_LogicalAND:       myStream<< "aLogicalAND";       break;
 301       case FT_LogicalOR:        myStream<< "aLogicalOR";        break;
 302       case FT_Undefined:
 303       default:                  myStream<< "anUndefined";       break;
 304       }
 305       myStream<<theArg;
 306     }
 307     return *this;
 308   }
 309
 310   TPythonDump& TPythonDump:: operator<<(SMESH_Gen_i* theArg)
 311   {
 312     myStream << SMESHGenName(); return *this;
 313   }
 314
 315   TPythonDump& TPythonDump::operator<<(SMESH_MeshEditor_i* theArg)
 316   {
 317     myStream << MeshEditorName() << "_" << ( theArg ? theArg->GetMeshId() : -1 ); return *this;
 318   }
 319
 320   TPythonDump& TPythonDump::operator<<(const TCollection_AsciiString & theStr)
 321   {
 322     myStream << theStr; return *this;
 323   }
 324
 325
 326   TPythonDump& TPythonDump::operator<<(SMESH::MED_VERSION theVersion)
 327   {
 328     switch (theVersion) {
 329     case SMESH::MED_V2_1: myStream << "SMESH.MED_V2_1"; break;
 330     case SMESH::MED_V2_2: myStream << "SMESH.MED_V2_2"; break;
 331     default: myStream << theVersion;
 332     }
 333     return *this;
 334   }
 335
 336   TPythonDump& TPythonDump::operator<<(const SMESH::AxisStruct & theAxis)
 337   {
 338     myStream << "SMESH.AxisStruct( "
 339              << theAxis.x  << ", "
 340              << theAxis.y  << ", "
 341              << theAxis.z  << ", "
 342              << theAxis.vx << ", "
 343              << theAxis.vy << ", "
 344              << theAxis.vz << " )";
 345     return *this;
 346   }
 347
 348   TPythonDump& TPythonDump::operator<<(const SMESH::DirStruct & theDir)
 349   {
 350     const SMESH::PointStruct & P = theDir.PS;
 351     myStream << "SMESH.DirStruct( SMESH.PointStruct ( "
 352              << P.x  << ", "
 353              << P.y  << ", "
 354              << P.z  << " ))";
 355     return *this;
 356   }
 357
 358   TPythonDump& TPythonDump::operator<<(const SMESH::ListOfGroups& theList)
 359   {
 360     DumpArray( theList, *this );
 361     return *this;
 362   }
 363   TPythonDump& TPythonDump::operator<<(const SMESH::ListOfIDSources& theList)
 364   {
 365     DumpArray( theList, *this );
 366     return *this;
 367   }
 368
 369   TCollection_AsciiString myLongStringStart( "TPythonDump::LongStringStart" );
 370   TCollection_AsciiString myLongStringEnd  ( "TPythonDump::LongStringEnd" );
 371
 372   //================================================================================
 373   /*!
 374    * \brief Return marker of long string literal beginning
 375    * \param type - a name of functionality producing the string literal
 376    * \retval TCollection_AsciiString - the marker string to be written into
 377    * a raw python script
 378    */
 379   //================================================================================
 380
 381   TCollection_AsciiString TPythonDump::LongStringStart(const char* type)
 382   {
 383     return
 384       myLongStringStart +
 385       (Standard_Integer) strlen(type) +
 386       " " +
 387       (char*) type;
 388   }
 389
 390   //================================================================================
 391   /*!
 392      * \brief Return marker of long string literal end
 393       * \retval TCollection_AsciiString - the marker string to be written into
 394       * a raw python script
 395    */
 396   //================================================================================
 397
 398   TCollection_AsciiString TPythonDump::LongStringEnd()
 399   {
 400     return myLongStringEnd;
 401   }
 402
 403   //================================================================================
 404   /*!
 405      * \brief Cut out a long string literal from a string
 406       * \param theText - text possibly containing string literals
 407       * \param theFrom - position in the text to search from
 408       * \param theLongString - the retrieved literal
 409       * \param theStringType - a name of functionality produced the literal
 410       * \retval bool - true if a string literal found
 411      *
 412      * The literal is removed from theText; theFrom points position right after
 413      * the removed literal
 414    */
 415   //================================================================================
 416
 417   bool  TPythonDump::CutoutLongString( TCollection_AsciiString & theText,
 418                                        int                     & theFrom,
 419                                        TCollection_AsciiString & theLongString,
 420                                        TCollection_AsciiString & theStringType)
 421   {
 422     if ( theFrom < 1 || theFrom > theText.Length() )
 423       return false;
 424
 425     // ...script \  beg marker    \ \ type \       literal              \  end marker  \ script...
 426     //  "theText myLongStringStart7 Pattern!!! SALOME Mesh Pattern file myLongStringEndtextEnd"
 427     //  012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789
 428     //  0         1         2         3         4         5         6         7         8
 429
 430     theFrom = theText.Location( myLongStringStart, theFrom, theText.Length() ); // = 09
 431     if ( !theFrom )
 432       return false;
 433
 434     // find where literal begins
 435     int literalBeg = theFrom + myLongStringStart.Length(); // = 26
 436     char* typeLenStr = (char*) theText.ToCString() + literalBeg - 1; // = "7 Pattern!!! SALO...."
 437     int typeLen = atoi ( typeLenStr ); // = 7
 438     while ( *typeLenStr != ' ' ) { // look for ' ' after typeLen
 439       literalBeg++; // 26 -> 27
 440       typeLenStr++;
 441     }
 442     literalBeg += typeLen + 1; // = 35
 443     if ( literalBeg > theText.Length() )
 444       return false;
 445
 446     // where literal ends (i.e. end marker begins)
 447     int literalEnd = theText.Location( myLongStringEnd, literalBeg, theText.Length() ); // = 64
 448     if ( !literalEnd )
 449       literalEnd = theText.Length();
 450
 451     // literal
 452     theLongString = theText.SubString( literalBeg, literalEnd - 1); // "!!! SALOME Mesh Pattern file "
 453     // type
 454     theStringType = theText.SubString( literalBeg - typeLen, literalBeg - 1 ); // "Pattern"
 455     // cut off literal
 456     literalEnd += myLongStringEnd.Length(); // = 79
 457     TCollection_AsciiString textEnd = theText.SubString( literalEnd, theText.Length() ); // "textE..."
 458     theText = theText.SubString( 1, theFrom - 1 ) + textEnd;
 459
 460     return true;
 461   }
 462 }
 463
 464 //=======================================================================
 465 //function : DumpPython
 466 //purpose  :
 467 //=======================================================================
 468 Engines::TMPFile* SMESH_Gen_i::DumpPython (CORBA::Object_ptr theStudy,
 469                                            CORBA::Boolean isPublished,
 470                                            CORBA::Boolean& isValidScript)
 471 {
 472   SALOMEDS::Study_var aStudy = SALOMEDS::Study::_narrow(theStudy);
 473   if (CORBA::is_nil(aStudy))
 474     return new Engines::TMPFile(0);
 475
 476   SALOMEDS::SObject_var aSO = aStudy->FindComponent(ComponentDataType());
 477   if (CORBA::is_nil(aSO))
 478     return new Engines::TMPFile(0);
 479
 480   // Map study entries to object names
 481   Resource_DataMapOfAsciiStringAsciiString aMap;
 482   Resource_DataMapOfAsciiStringAsciiString aMapNames;
 483   //TCollection_AsciiString s ("qwertyuioplkjhgfdsazxcvbnmQWERTYUIOPLKJHGFDSAZXCVBNM0987654321_");
 484
 485   SALOMEDS::ChildIterator_var Itr = aStudy->NewChildIterator(aSO);
 486   for (Itr->InitEx(true); Itr->More(); Itr->Next()) {
 487     SALOMEDS::SObject_var aValue = Itr->Value();
 488     CORBA::String_var anID = aValue->GetID();
 489     CORBA::String_var aName = aValue->GetName();
 490     TCollection_AsciiString aGUIName ( (char*) aName.in() );
 491     TCollection_AsciiString anEnrty ( (char*) anID.in() );
 492     if (aGUIName.Length() > 0) {
 493       aMapNames.Bind( anEnrty, aGUIName );
 494       aMap.Bind( anEnrty, aGUIName );
 495     }
 496   }
 497
 498   // Get trace of restored study
 499   //SALOMEDS::SObject_var aSO = SMESH_Gen_i::ObjectToSObject(theStudy, _this());
 500   SALOMEDS::StudyBuilder_var aStudyBuilder = aStudy->NewBuilder();
 501   SALOMEDS::GenericAttribute_var anAttr =
 502     aStudyBuilder->FindOrCreateAttribute(aSO, "AttributePythonObject");
 503
 504   char* oldValue = SALOMEDS::AttributePythonObject::_narrow(anAttr)->GetObject();
 505   TCollection_AsciiString aSavedTrace (oldValue);
 506
 507   // Add trace of API methods calls and replace study entries by names
 508   TCollection_AsciiString aScript;
 509   aScript += DumpPython_impl(aStudy, aMap, aMapNames,
 510                              isPublished, isValidScript, aSavedTrace);
 511
 512   int aLen = aScript.Length();
 513   unsigned char* aBuffer = new unsigned char[aLen+1];
 514   strcpy((char*)aBuffer, aScript.ToCString());
 515
 516   CORBA::Octet* anOctetBuf =  (CORBA::Octet*)aBuffer;
 517   Engines::TMPFile_var aStreamFile = new Engines::TMPFile(aLen+1, aLen+1, anOctetBuf, 1);
 518
 519   bool hasNotPublishedObjects = aScript.Location( NotPublishedObjectName(), 1, aLen);
 520   isValidScript = isValidScript && !hasNotPublishedObjects;
 521
 522   return aStreamFile._retn();
 523 }
 524
 525 //=============================================================================
 526 /*!
 527  *  AddToPythonScript
 528  */
 529 //=============================================================================
 530 void SMESH_Gen_i::AddToPythonScript (int theStudyID, const TCollection_AsciiString& theString)
 531 {
 532   if (myPythonScripts.find(theStudyID) == myPythonScripts.end()) {
 533     myPythonScripts[theStudyID] = new TColStd_HSequenceOfAsciiString;
 534   }
 535   myPythonScripts[theStudyID]->Append(theString);
 536 }
 537
 538 //=============================================================================
 539 /*!
 540  *  RemoveLastFromPythonScript
 541  */
 542 //=============================================================================
 543 void SMESH_Gen_i::RemoveLastFromPythonScript (int theStudyID)
 544 {
 545   if (myPythonScripts.find(theStudyID) != myPythonScripts.end()) {
 546     int aLen = myPythonScripts[theStudyID]->Length();
 547     myPythonScripts[theStudyID]->Remove(aLen);
 548   }
 549 }
 550
 551 //=======================================================================
 552 //function : SavePython
 553 //purpose  :
 554 //=======================================================================
 555 void SMESH_Gen_i::SavePython (SALOMEDS::Study_ptr theStudy)
 556 {
 557   // Dump trace of API methods calls
 558   TCollection_AsciiString aScript = GetNewPythonLines(theStudy->StudyId());
 559
 560   // Check contents of PythonObject attribute
 561   SALOMEDS::SObject_var aSO = theStudy->FindComponent(ComponentDataType());
 562   //SALOMEDS::SObject_var aSO = SMESH_Gen_i::ObjectToSObject(theStudy, _this());
 563   SALOMEDS::StudyBuilder_var aStudyBuilder = theStudy->NewBuilder();
 564   SALOMEDS::GenericAttribute_var anAttr =
 565     aStudyBuilder->FindOrCreateAttribute(aSO, "AttributePythonObject");
 566
 567   char* oldValue = SALOMEDS::AttributePythonObject::_narrow(anAttr)->GetObject();
 568   TCollection_AsciiString oldScript (oldValue);
 569
 570   if (oldScript.Length() > 0) {
 571     oldScript += "\n";
 572     oldScript += aScript;
 573   } else {
 574     oldScript = aScript;
 575   }
 576
 577   // Store in PythonObject attribute
 578   SALOMEDS::AttributePythonObject::_narrow(anAttr)->SetObject(oldScript.ToCString(), 1);
 579
 580   // Clean trace of API methods calls
 581   CleanPythonTrace(theStudy->StudyId());
 582 }
 583
 584
 585 // impl
 586
 587
 588 //=============================================================================
 589 /*!
 590  *  FindEntries: Returns a sequence of start/end positions of entries in the string
 591  */
 592 //=============================================================================
 593 Handle(TColStd_HSequenceOfInteger) FindEntries (TCollection_AsciiString& theString)
 594 {
 595   Handle(TColStd_HSequenceOfInteger) aSeq = new TColStd_HSequenceOfInteger;
 596   Standard_Integer aLen = theString.Length();
 597   Standard_Boolean isFound = Standard_False;
 598
 599   char* arr = (char*) theString.ToCString();
 600   Standard_Integer i = 0, j;
 601
 602   while(i < aLen) {
 603     int c = (int)arr[i];
 604     j = i+1;
 605     if ( isdigit( c )) { //Is digit?
 606
 607       isFound = Standard_False;
 608       while((j < aLen) && ( isdigit(c) || c == ':' )) { //Check if it is an entry
 609         c = (int)arr[j++];
 610         if(c == ':') isFound = Standard_True;
 611       }
 612
 613       if (isFound) {
 614         int prev = (i < 1) ? 0 : (int)arr[i - 1];
 615         // to distinguish from a sketcher command:
 616         // last char should be a digit, not ":",
 617         // previous char should not be '"'.
 618         if (arr[j-2] != ':' && prev != '"') {
 619           aSeq->Append(i+1); // +1 because AsciiString starts from 1
 620           aSeq->Append(j-1);
 621         }
 622       }
 623     }
 624
 625     i = j;
 626   }
 627
 628   return aSeq;
 629 }
 630
 631 namespace {
 632
 633   //================================================================================
 634   /*!
 635    * \brief Make a string be a valid python name
 636     * \param aName - a string to fix
 637     * \retval bool - true if aName was not modified
 638    */
 639   //================================================================================
 640
 641   bool fixPythonName(TCollection_AsciiString & aName )
 642   {
 643     const TCollection_AsciiString allowedChars =
 644       "qwertyuioplkjhgfdsazxcvbnmQWERTYUIOPLKJHGFDSAZXCVBNM0987654321_";
 645     bool isValidName = true;
 646     int p=1; // replace not allowed chars with underscore
 647     while (p <= aName.Length() &&
 648            (p = aName.FirstLocationNotInSet(allowedChars, p, aName.Length())))
 649     {
 650       if ( p == 1 || p == aName.Length() || aName.Value(p-1) == '_')
 651         aName.Remove( p, 1 ); // remove double _ and from the start and the end
 652       else
 653         aName.SetValue(p, '_');
 654       isValidName = false;
 655     }
 656     if ( aName.IsIntegerValue() ) { // aName must not start with a digit
 657       aName.Insert( 1, 'a' );
 658       isValidName = false;
 659     }
 660     return isValidName;
 661   }
 662 }
 663
 664 //=============================================================================
 665 /*!
 666  *  DumpPython
 667  */
 668 //=============================================================================
 669 TCollection_AsciiString SMESH_Gen_i::DumpPython_impl
 670                         (SALOMEDS::Study_ptr theStudy,
 671                          Resource_DataMapOfAsciiStringAsciiString& theObjectNames,
 672                          Resource_DataMapOfAsciiStringAsciiString& theNames,
 673                          bool isPublished,
 674                          bool& aValidScript,
 675                          const TCollection_AsciiString& theSavedTrace)
 676 {
 677   int aStudyID = theStudy->StudyId();
 678
 679   TCollection_AsciiString helper; // to comfortably concatenate C strings
 680   TCollection_AsciiString aSmeshpy( SMESH_2smeshpy::SmeshpyName() );
 681   TCollection_AsciiString aSMESHGen( SMESH_2smeshpy::GenName() );
 682   TCollection_AsciiString anOldGen( SMESH::TPythonDump::SMESHGenName() );
 683
 684   TCollection_AsciiString aScript;
 685   aScript = "def RebuildData(theStudy):\n\t";
 686   aScript += helper + "aFilterManager = " + aSMESHGen + ".CreateFilterManager()\n\t";
 687   if ( isPublished )
 688     aScript += aSMESHGen + ".SetCurrentStudy(theStudy)";
 689   else
 690     aScript += aSMESHGen + ".SetCurrentStudy(None)";
 691
 692   // import python files corresponding to plugins
 693   set<string> moduleNameSet;
 694   map<string, GenericHypothesisCreator_i*>::iterator hyp_creator = myHypCreatorMap.begin();
 695   for ( ; hyp_creator != myHypCreatorMap.end(); ++hyp_creator ) {
 696     string moduleName = hyp_creator->second->GetModuleName();
 697     bool newModule = moduleNameSet.insert( moduleName ).second;
 698     if ( newModule )
 699       aScript += helper + "\n\t" + "import " + (char*) moduleName.c_str();
 700   }
 701
 702   // Dump trace of restored study
 703   if (theSavedTrace.Length() > 0) {
 704     // For the convertion of IDL API calls -> smesh.py API, "smesh" standing for SMESH_Gen
 705     // was replaces with "smeshgen" (==TPythonDump::SMESHGenName()).
 706     // Change "smesh" -> "smeshgen" in the trace saved before passage to smesh.py API
 707     bool isNewVersion =
 708       theSavedTrace.Location( anOldGen + ".", 1, theSavedTrace.Length() );
 709     if ( !isNewVersion ) {
 710       TCollection_AsciiString aSavedTrace( theSavedTrace );
 711       TCollection_AsciiString aSmeshCall ( "smesh." ), gen( "gen" );
 712       int beg, end = aSavedTrace.Length(), from = 1;
 713       while ( from < end && ( beg = aSavedTrace.Location( aSmeshCall, from, end ))) {
 714         char charBefore = ( beg == 1 ) ? ' ' : aSavedTrace.Value( beg - 1 );
 715         if ( isspace( charBefore ) || charBefore == '=' ) { // "smesh." is not a part of a long word
 716           aSavedTrace.Insert( beg + aSmeshCall.Length() - 1, gen );// "smesh" -> "smeshgen"
 717           end += gen.Length();
 718         }
 719         from = beg + aSmeshCall.Length();
 720       }
 721       aScript += helper + "\n" + aSavedTrace;
 722     }
 723     else
 724       // append a saved trace to the script
 725       aScript += helper + "\n" + theSavedTrace;
 726   }
 727
 728   // Dump trace of API methods calls
 729   TCollection_AsciiString aNewLines = GetNewPythonLines(aStudyID);
 730   if (aNewLines.Length() > 0) {
 731     aScript += helper + "\n" + aNewLines;
 732   }
 733
 734   // Convert IDL API calls into smesh.py API.
 735   // Some objects are wrapped with python classes and
 736   // Resource_DataMapOfAsciiStringAsciiString holds methods returning wrapped objects
 737   Resource_DataMapOfAsciiStringAsciiString anEntry2AccessorMethod;
 738   aScript = SMESH_2smeshpy::ConvertScript( aScript, anEntry2AccessorMethod, theObjectNames );
 739
 740   // Find entries to be replaced by names
 741   Handle(TColStd_HSequenceOfInteger) aSeq = FindEntries(aScript);
 742   Standard_Integer aLen = aSeq->Length();
 743
 744   if (aLen == 0)
 745     return aScript;
 746
 747   // Replace entries by the names
 748   GEOM::GEOM_Gen_ptr geom = GetGeomEngine();
 749   TColStd_SequenceOfAsciiString seqRemoved;
 750   Resource_DataMapOfAsciiStringAsciiString mapRemoved;
 751   Standard_Integer objectCounter = 0, aStart = 1, aScriptLength = aScript.Length();
 752   TCollection_AsciiString anUpdatedScript, anEntry, aName, aBaseName("smeshObj_");
 753
 754   // Collect names of GEOM objects to exclude same names for SMESH objects
 755   GEOM::string_array_var aGeomNames = geom->GetAllDumpNames();
 756   int ign = 0, nbgn = aGeomNames->length();
 757   for (; ign < nbgn; ign++) {
 758     aName = aGeomNames[ign];
 759     theObjectNames.Bind(aName, "1");
 760   }
 761
 762   bool importGeom = false;
 763   for (Standard_Integer i = 1; i <= aLen; i += 2) {
 764     anUpdatedScript += aScript.SubString(aStart, aSeq->Value(i) - 1);
 765     anEntry = aScript.SubString(aSeq->Value(i), aSeq->Value(i + 1));
 766     // is a GEOM object?
 767     aName = geom->GetDumpName( anEntry.ToCString() );
 768     if (aName.IsEmpty()) {
 769       // is a SMESH object
 770       if (theObjectNames.IsBound(anEntry)) {
 771         // The Object is in Study
 772         aName = theObjectNames.Find(anEntry);
 773         // check validity of aName
 774         bool isValidName = fixPythonName( aName );
 775         if (theObjectNames.IsBound(aName) && anEntry != theObjectNames(aName)) {
 776           // diff objects have same name - make a new name by appending a digit
 777           TCollection_AsciiString aName2;
 778           Standard_Integer i = 0;
 779           do {
 780             aName2 = aName + "_" + ++i;
 781           } while (theObjectNames.IsBound(aName2) && anEntry != theObjectNames(aName2));
 782           aName = aName2;
 783           isValidName = false;
 784         }
 785         if ( !isValidName )
 786           theObjectNames(anEntry) = aName;
 787
 788       } else {
 789         // Removed Object
 790         do {
 791           aName = aBaseName + (++objectCounter);
 792         } while (theObjectNames.IsBound(aName));
 793         seqRemoved.Append(aName);
 794         mapRemoved.Bind(anEntry, "1");
 795         theObjectNames.Bind(anEntry, aName);
 796       }
 797       theObjectNames.Bind(aName, anEntry); // to detect same name of diff objects
 798     }
 799     else
 800     {
 801       importGeom = true;
 802     }
 803     anUpdatedScript += aName;
 804     aStart = aSeq->Value(i + 1) + 1;
 805   }
 806
 807   // set initial part of aSript
 808   TCollection_AsciiString initPart = "import salome, SMESH, SALOMEDS\n";
 809   initPart += helper + "import " + aSmeshpy + "\n\n";
 810   if ( importGeom )
 811   {
 812     initPart += ("## import GEOM dump file ## \n"
 813                  "import string, os, sys, re\n"
 814                  "sys.path.insert( 0, os.path.dirname(__file__) )\n"
 815                  "exec(\"from \"+re.sub(\"SMESH$\",\"GEOM\",__name__)+\" import *\")\n\n");
 816   }
 817   anUpdatedScript.Insert ( 1, initPart );
 818
 819   // add final part of aScript
 820   if (aSeq->Value(aLen) < aScriptLength)
 821     anUpdatedScript += aScript.SubString(aSeq->Value(aLen) + 1, aScriptLength);
 822
 823   // Set colors
 824   SALOMEDS::SObject_var aComp = theStudy->FindComponent(ComponentDataType());
 825   if( !CORBA::is_nil(aComp) )
 826   {
 827     SALOMEDS::ChildIterator_var Itr = theStudy->NewChildIterator(aComp);
 828     for( Itr->InitEx(true); Itr->More(); Itr->Next() )
 829     {
 830       SALOMEDS::SObject_var aSObj = Itr->Value();
 831       SMESH::SMESH_Mesh_var aMesh = SMESH::SMESH_Mesh::_narrow( SObjectToObject( aSObj ) );
 832       // mesh auto color
 833       if( !CORBA::is_nil(aMesh) && aMesh->GetAutoColor() )
 834       {
 835         CORBA::String_var anEntry = aSObj->GetID();
 836         anUpdatedScript +=
 837           SMESH_Comment("\n\t") << theObjectNames(anEntry.inout()) << ".SetAutoColor(1)";
 838       }
 839       SMESH::SMESH_GroupBase_var aGroup = SMESH::SMESH_GroupBase::_narrow( SObjectToObject(aSObj));
 840       if( !CORBA::is_nil(aGroup) )
 841       {
 842         SALOMEDS::Color aColor = aGroup->GetColor();
 843         if ( aColor.R >= 0 || aColor.G >= 0 || aColor.B >= 0 )
 844         {
 845           CORBA::String_var anEntry = aSObj->GetID();
 846           anUpdatedScript += SMESH_Comment("\n\t")
 847             << theObjectNames(anEntry.inout()) << ".SetColor(SALOMEDS.Color("
 848             << aColor.R <<", "<< aColor.G <<", "<< aColor.B <<" ))";
 849         }
 850       }
 851     }
 852   }
 853
 854   // Remove removed objects
 855   if ( seqRemoved.Length() > 0 ) {
 856     anUpdatedScript += "\n\t## some objects were removed";
 857     anUpdatedScript += "\n\taStudyBuilder = theStudy.NewBuilder()";
 858   }
 859   for (int ir = 1; ir <= seqRemoved.Length(); ir++) {
 860     anUpdatedScript += "\n\tSO = theStudy.FindObjectIOR(theStudy.ConvertObjectToIOR(";
 861     anUpdatedScript += seqRemoved.Value(ir);
 862     // for object wrapped by class of smesh.py
 863     anEntry = theObjectNames( seqRemoved.Value(ir) );
 864     if ( anEntry2AccessorMethod.IsBound( anEntry ) )
 865       anUpdatedScript += helper + "." + anEntry2AccessorMethod( anEntry );
 866     anUpdatedScript += "))\n\tif SO is not None: aStudyBuilder.RemoveObjectWithChildren(SO)";
 867   }
 868
 869   // Set object names
 870   anUpdatedScript += "\n\t## set object names";
 871 //   anUpdatedScript += "\n\t\tsmeshgui = salome.ImportComponentGUI(\"SMESH\")";
 872 //   anUpdatedScript += "\n\t\tsmeshgui.Init(theStudy._get_StudyId())";
 873 //   anUpdatedScript += "\n";
 874
 875   TCollection_AsciiString aGUIName;
 876   Resource_DataMapOfAsciiStringAsciiString mapEntries;
 877   for (Standard_Integer i = 1; i <= aLen; i += 2)
 878   {
 879     anEntry = aScript.SubString(aSeq->Value(i), aSeq->Value(i + 1));
 880     aName = geom->GetDumpName( anEntry.ToCString() );
 881     if (aName.IsEmpty() && // Not a GEOM object
 882         theNames.IsBound(anEntry) &&
 883         !mapEntries.IsBound(anEntry) && // Not yet processed
 884         !mapRemoved.IsBound(anEntry)) // Was not removed
 885     {
 886       aName = theObjectNames.Find(anEntry);
 887       aGUIName = theNames.Find(anEntry);
 888       mapEntries.Bind(anEntry, aName);
 889       anUpdatedScript += helper + "\n\t" + aSMESHGen + ".SetName(" + aName;
 890       if ( anEntry2AccessorMethod.IsBound( anEntry ) )
 891         anUpdatedScript += helper + "." + anEntry2AccessorMethod( anEntry );
 892       anUpdatedScript += helper + ", '" + aGUIName + "')";
 893     }
 894   }
 895   anUpdatedScript += "\n\tif salome.sg.hasDesktop():";
 896   anUpdatedScript += "\n\t\tsalome.sg.updateObjBrowser(0)";
 897
 898   // -----------------------------------------------------------------
 899   // store visual properties of displayed objects
 900   // -----------------------------------------------------------------
 901
 902   if (isPublished)
 903   {
 904     //Output the script that sets up the visual parameters.
 905     char* script = theStudy->GetDefaultScript(ComponentDataType(), "\t");
 906     if (script && strlen(script) > 0) {
 907       anUpdatedScript += "\n\n\t### Store presentation parameters of displayed objects\n";
 908       anUpdatedScript += script;
 909       CORBA::string_free(script);
 910     }
 911   }
 912   anUpdatedScript += "\n\n\tpass\n";
 913
 914   // -----------------------------------------------------------------
 915   // put string literals describing patterns into separate functions
 916   // -----------------------------------------------------------------
 917
 918   TCollection_AsciiString aLongString, aFunctionType;
 919   int where = 1;
 920   set< string > functionNameSet;
 921   while ( SMESH::TPythonDump::CutoutLongString( anUpdatedScript, where, aLongString, aFunctionType ))
 922   {
 923     // make a python string literal
 924     aLongString.Prepend(":\n\treturn '''\n");
 925     aLongString += "\n\t'''\n\tpass\n";
 926
 927     TCollection_AsciiString functionName;
 928
 929     // check if the function returning this literal is already defined
 930     int posAlready = anUpdatedScript.Location( aLongString, where, anUpdatedScript.Length() );
 931     if ( posAlready ) // already defined
 932     {
 933       // find the function name
 934       int functBeg = posAlready;
 935       char* script = (char*) anUpdatedScript.ToCString() + posAlready - 1; // look at ":" after "def fuction()"
 936       while ( *script != ' ' ) {
 937         script--;
 938         functBeg--;
 939       }
 940       functBeg++; // do not take ' '
 941       posAlready--; // do not take ':'
 942       functionName = anUpdatedScript.SubString( functBeg, posAlready );
 943     }
 944     else // not defined yet
 945     {
 946       // find a unique function name
 947       fixPythonName( aFunctionType );
 948       Standard_Integer nb = 0;
 949       do functionName = aFunctionType + "_" + ( nb++ ) + "()";
 950       while ( !functionNameSet.insert( functionName.ToCString() ).second );
 951
 952       anUpdatedScript += helper + "\n\ndef " + functionName + aLongString; // define function
 953     }
 954     anUpdatedScript.InsertBefore( where, functionName ); // call function
 955   }
 956
 957   aValidScript = true;
 958
 959   return anUpdatedScript;
 960 }
 961
 962 //=============================================================================
 963 /*!
 964  *  GetNewPythonLines
 965  */
 966 //=============================================================================
 967 TCollection_AsciiString SMESH_Gen_i::GetNewPythonLines (int theStudyID)
 968 {
 969   TCollection_AsciiString aScript;
 970
 971   // Dump trace of API methods calls
 972   if (myPythonScripts.find(theStudyID) != myPythonScripts.end()) {
 973     Handle(TColStd_HSequenceOfAsciiString) aPythonScript = myPythonScripts[theStudyID];
 974     Standard_Integer istr, aLen = aPythonScript->Length();
 975     for (istr = 1; istr <= aLen; istr++) {
 976       aScript += "\n\t";
 977       aScript += aPythonScript->Value(istr);
 978     }
 979     aScript += "\n";
 980   }
 981
 982   return aScript;
 983 }
 984
 985 //=============================================================================
 986 /*!
 987  *  CleanPythonTrace
 988  */
 989 //=============================================================================
 990 void SMESH_Gen_i::CleanPythonTrace (int theStudyID)
 991 {
 992   TCollection_AsciiString aScript;
 993
 994   // Clean trace of API methods calls
 995   if (myPythonScripts.find(theStudyID) != myPythonScripts.end()) {
 996     myPythonScripts[theStudyID]->Clear();
 997   }
 998 }