src/SMESH_I/SMESH_DumpPython.cxx

   1 //  Copyright (C) 2007-2010  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, std::ostringstream & 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, myStream );
 170     return *this;
 171   }
 172
 173   TPythonDump&
 174   TPythonDump::operator<<(const SMESH::double_array& theArg)
 175   {
 176     DumpArray( theArg, myStream );
 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_RangeOfIds:       myStream<< "aRangeOfIds";       break;
 291       case FT_BadOrientedVolume:myStream<< "aBadOrientedVolume";break;
 292       case FT_LinearOrQuadratic:myStream<< "aLinearOrQuadratic";break;
 293       case FT_GroupColor:       myStream<< "aGroupColor";       break;
 294       case FT_ElemGeomType:     myStream<< "anElemGeomType";    break;
 295       case FT_LessThan:         myStream<< "aLessThan";         break;
 296       case FT_MoreThan:         myStream<< "aMoreThan";         break;
 297       case FT_EqualTo:          myStream<< "anEqualTo";         break;
 298       case FT_LogicalNOT:       myStream<< "aLogicalNOT";       break;
 299       case FT_LogicalAND:       myStream<< "aLogicalAND";       break;
 300       case FT_LogicalOR:        myStream<< "aLogicalOR";        break;
 301       case FT_Undefined:
 302       default:                  myStream<< "anUndefined";       break;
 303       }
 304       myStream<<theArg;
 305     }
 306     return *this;
 307   }
 308
 309   TPythonDump& TPythonDump:: operator<<(SMESH_Gen_i* theArg)
 310   {
 311     myStream << SMESHGenName(); return *this;
 312   }
 313
 314   TPythonDump& TPythonDump::operator<<(SMESH_MeshEditor_i* theArg)
 315   {
 316     myStream << MeshEditorName() << "_" << ( theArg ? theArg->GetMeshId() : -1 ); return *this;
 317   }
 318
 319   TPythonDump& TPythonDump::operator<<(const TCollection_AsciiString & theStr)
 320   {
 321     myStream << theStr; return *this;
 322   }
 323
 324
 325   TPythonDump& TPythonDump::operator<<(SMESH::MED_VERSION theVersion)
 326   {
 327     switch (theVersion) {
 328     case SMESH::MED_V2_1: myStream << "SMESH.MED_V2_1"; break;
 329     case SMESH::MED_V2_2: myStream << "SMESH.MED_V2_2"; break;
 330     default: myStream << theVersion;
 331     }
 332     return *this;
 333   }
 334
 335   TPythonDump& TPythonDump::operator<<(const SMESH::AxisStruct & theAxis)
 336   {
 337     myStream << "SMESH.AxisStruct( "
 338              << theAxis.x  << ", "
 339              << theAxis.y  << ", "
 340              << theAxis.z  << ", "
 341              << theAxis.vx << ", "
 342              << theAxis.vy << ", "
 343              << theAxis.vz << " )";
 344     return *this;
 345   }
 346
 347   TPythonDump& TPythonDump::operator<<(const SMESH::DirStruct & theDir)
 348   {
 349     const SMESH::PointStruct & P = theDir.PS;
 350     myStream << "SMESH.DirStruct( SMESH.PointStruct ( "
 351              << P.x  << ", "
 352              << P.y  << ", "
 353              << P.z  << " ))";
 354     return *this;
 355   }
 356
 357   TPythonDump& TPythonDump::operator<<(const SMESH::ListOfGroups& theList)
 358   {
 359     SMESH_Gen_i* aSMESHGen = SMESH_Gen_i::GetSMESHGen();
 360     SALOMEDS::Study_ptr aStudy = aSMESHGen->GetCurrentStudy();
 361     myStream << "[";
 362     int aListLen = theList.length();
 363     for(int i = 0 ; i < aListLen; i++)
 364     {
 365       SALOMEDS::SObject_var aSObject = SMESH_Gen_i::ObjectToSObject(aStudy,theList[i]);
 366       if(!aSObject->_is_nil()) {
 367         CORBA::String_var entry = aSObject->GetID();
 368         myStream << entry;
 369         if ( i < (aListLen - 1) )
 370           myStream<<", ";
 371       }
 372     }
 373     myStream<<"]";
 374     return *this;
 375   }
 376
 377   TCollection_AsciiString myLongStringStart( "TPythonDump::LongStringStart" );
 378   TCollection_AsciiString myLongStringEnd  ( "TPythonDump::LongStringEnd" );
 379
 380   //================================================================================
 381   /*!
 382    * \brief Return marker of long string literal beginning
 383    * \param type - a name of functionality producing the string literal
 384    * \retval TCollection_AsciiString - the marker string to be written into
 385    * a raw python script
 386    */
 387   //================================================================================
 388
 389   TCollection_AsciiString TPythonDump::LongStringStart(const char* type)
 390   {
 391     return
 392       myLongStringStart +
 393       (Standard_Integer) strlen(type) +
 394       " " +
 395       (char*) type;
 396   }
 397
 398   //================================================================================
 399   /*!
 400      * \brief Return marker of long string literal end
 401       * \retval TCollection_AsciiString - the marker string to be written into
 402       * a raw python script
 403    */
 404   //================================================================================
 405
 406   TCollection_AsciiString TPythonDump::LongStringEnd()
 407   {
 408     return myLongStringEnd;
 409   }
 410
 411   //================================================================================
 412   /*!
 413      * \brief Cut out a long string literal from a string
 414       * \param theText - text possibly containing string literals
 415       * \param theFrom - position in the text to search from
 416       * \param theLongString - the retrieved literal
 417       * \param theStringType - a name of functionality produced the literal
 418       * \retval bool - true if a string literal found
 419      *
 420      * The literal is removed from theText; theFrom points position right after
 421      * the removed literal
 422    */
 423   //================================================================================
 424
 425   bool  TPythonDump::CutoutLongString( TCollection_AsciiString & theText,
 426                                        int                     & theFrom,
 427                                        TCollection_AsciiString & theLongString,
 428                                        TCollection_AsciiString & theStringType)
 429   {
 430     if ( theFrom < 1 || theFrom > theText.Length() )
 431       return false;
 432
 433     // ...script \  beg marker    \ \ type \       literal              \  end marker  \ script...
 434     //  "theText myLongStringStart7 Pattern!!! SALOME Mesh Pattern file myLongStringEndtextEnd"
 435     //  012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789
 436     //  0         1         2         3         4         5         6         7         8
 437
 438     theFrom = theText.Location( myLongStringStart, theFrom, theText.Length() ); // = 09
 439     if ( !theFrom )
 440       return false;
 441
 442     // find where literal begins
 443     int literalBeg = theFrom + myLongStringStart.Length(); // = 26
 444     char* typeLenStr = (char*) theText.ToCString() + literalBeg - 1; // = "7 Pattern!!! SALO...."
 445     int typeLen = atoi ( typeLenStr ); // = 7
 446     while ( *typeLenStr != ' ' ) { // look for ' ' after typeLen
 447       literalBeg++; // 26 -> 27
 448       typeLenStr++;
 449     }
 450     literalBeg += typeLen + 1; // = 35
 451     if ( literalBeg > theText.Length() )
 452       return false;
 453
 454     // where literal ends (i.e. end marker begins)
 455     int literalEnd = theText.Location( myLongStringEnd, literalBeg, theText.Length() ); // = 64
 456     if ( !literalEnd )
 457       literalEnd = theText.Length();
 458
 459     // literal
 460     theLongString = theText.SubString( literalBeg, literalEnd - 1); // "!!! SALOME Mesh Pattern file "
 461     // type
 462     theStringType = theText.SubString( literalBeg - typeLen, literalBeg - 1 ); // "Pattern"
 463     // cut off literal
 464     literalEnd += myLongStringEnd.Length(); // = 79
 465     TCollection_AsciiString textEnd = theText.SubString( literalEnd, theText.Length() ); // "textE..."
 466     theText = theText.SubString( 1, theFrom - 1 ) + textEnd;
 467
 468     return true;
 469   }
 470 }
 471
 472 //=======================================================================
 473 //function : DumpPython
 474 //purpose  :
 475 //=======================================================================
 476 Engines::TMPFile* SMESH_Gen_i::DumpPython (CORBA::Object_ptr theStudy,
 477                                            CORBA::Boolean isPublished,
 478                                            CORBA::Boolean& isValidScript)
 479 {
 480   SALOMEDS::Study_var aStudy = SALOMEDS::Study::_narrow(theStudy);
 481   if (CORBA::is_nil(aStudy))
 482     return new Engines::TMPFile(0);
 483
 484   SALOMEDS::SObject_var aSO = aStudy->FindComponent(ComponentDataType());
 485   if (CORBA::is_nil(aSO))
 486     return new Engines::TMPFile(0);
 487
 488   // Map study entries to object names
 489   Resource_DataMapOfAsciiStringAsciiString aMap;
 490   Resource_DataMapOfAsciiStringAsciiString aMapNames;
 491   //TCollection_AsciiString s ("qwertyuioplkjhgfdsazxcvbnmQWERTYUIOPLKJHGFDSAZXCVBNM0987654321_");
 492
 493   SALOMEDS::ChildIterator_var Itr = aStudy->NewChildIterator(aSO);
 494   for (Itr->InitEx(true); Itr->More(); Itr->Next()) {
 495     SALOMEDS::SObject_var aValue = Itr->Value();
 496     CORBA::String_var anID = aValue->GetID();
 497     CORBA::String_var aName = aValue->GetName();
 498     TCollection_AsciiString aGUIName ( (char*) aName.in() );
 499     TCollection_AsciiString anEnrty ( (char*) anID.in() );
 500     if (aGUIName.Length() > 0) {
 501       aMapNames.Bind( anEnrty, aGUIName );
 502       aMap.Bind( anEnrty, aGUIName );
 503     }
 504   }
 505
 506   // Get trace of restored study
 507   //SALOMEDS::SObject_var aSO = SMESH_Gen_i::ObjectToSObject(theStudy, _this());
 508   SALOMEDS::StudyBuilder_var aStudyBuilder = aStudy->NewBuilder();
 509   SALOMEDS::GenericAttribute_var anAttr =
 510     aStudyBuilder->FindOrCreateAttribute(aSO, "AttributePythonObject");
 511
 512   char* oldValue = SALOMEDS::AttributePythonObject::_narrow(anAttr)->GetObject();
 513   TCollection_AsciiString aSavedTrace (oldValue);
 514
 515   // Add trace of API methods calls and replace study entries by names
 516   TCollection_AsciiString aScript;
 517   aScript += DumpPython_impl(aStudy, aMap, aMapNames,
 518                              isPublished, isValidScript, aSavedTrace);
 519
 520   int aLen = aScript.Length();
 521   unsigned char* aBuffer = new unsigned char[aLen+1];
 522   strcpy((char*)aBuffer, aScript.ToCString());
 523
 524   CORBA::Octet* anOctetBuf =  (CORBA::Octet*)aBuffer;
 525   Engines::TMPFile_var aStreamFile = new Engines::TMPFile(aLen+1, aLen+1, anOctetBuf, 1);
 526
 527   bool hasNotPublishedObjects = aScript.Location( NotPublishedObjectName(), 1, aLen);
 528   isValidScript = isValidScript && !hasNotPublishedObjects;
 529
 530   return aStreamFile._retn();
 531 }
 532
 533 //=============================================================================
 534 /*!
 535  *  AddToPythonScript
 536  */
 537 //=============================================================================
 538 void SMESH_Gen_i::AddToPythonScript (int theStudyID, const TCollection_AsciiString& theString)
 539 {
 540   if (myPythonScripts.find(theStudyID) == myPythonScripts.end()) {
 541     myPythonScripts[theStudyID] = new TColStd_HSequenceOfAsciiString;
 542   }
 543   myPythonScripts[theStudyID]->Append(theString);
 544 }
 545
 546 //=============================================================================
 547 /*!
 548  *  RemoveLastFromPythonScript
 549  */
 550 //=============================================================================
 551 void SMESH_Gen_i::RemoveLastFromPythonScript (int theStudyID)
 552 {
 553   if (myPythonScripts.find(theStudyID) != myPythonScripts.end()) {
 554     int aLen = myPythonScripts[theStudyID]->Length();
 555     myPythonScripts[theStudyID]->Remove(aLen);
 556   }
 557 }
 558
 559 //=======================================================================
 560 //function : SavePython
 561 //purpose  :
 562 //=======================================================================
 563 void SMESH_Gen_i::SavePython (SALOMEDS::Study_ptr theStudy)
 564 {
 565   // Dump trace of API methods calls
 566   TCollection_AsciiString aScript = GetNewPythonLines(theStudy->StudyId());
 567
 568   // Check contents of PythonObject attribute
 569   SALOMEDS::SObject_var aSO = theStudy->FindComponent(ComponentDataType());
 570   //SALOMEDS::SObject_var aSO = SMESH_Gen_i::ObjectToSObject(theStudy, _this());
 571   SALOMEDS::StudyBuilder_var aStudyBuilder = theStudy->NewBuilder();
 572   SALOMEDS::GenericAttribute_var anAttr =
 573     aStudyBuilder->FindOrCreateAttribute(aSO, "AttributePythonObject");
 574
 575   char* oldValue = SALOMEDS::AttributePythonObject::_narrow(anAttr)->GetObject();
 576   TCollection_AsciiString oldScript (oldValue);
 577
 578   if (oldScript.Length() > 0) {
 579     oldScript += "\n";
 580     oldScript += aScript;
 581   } else {
 582     oldScript = aScript;
 583   }
 584
 585   // Store in PythonObject attribute
 586   SALOMEDS::AttributePythonObject::_narrow(anAttr)->SetObject(oldScript.ToCString(), 1);
 587
 588   // Clean trace of API methods calls
 589   CleanPythonTrace(theStudy->StudyId());
 590 }
 591
 592
 593 // impl
 594
 595
 596 //=============================================================================
 597 /*!
 598  *  FindEntries: Returns a sequence of start/end positions of entries in the string
 599  */
 600 //=============================================================================
 601 Handle(TColStd_HSequenceOfInteger) FindEntries (TCollection_AsciiString& theString)
 602 {
 603   Handle(TColStd_HSequenceOfInteger) aSeq = new TColStd_HSequenceOfInteger;
 604   Standard_Integer aLen = theString.Length();
 605   Standard_Boolean isFound = Standard_False;
 606
 607   char* arr = (char*) theString.ToCString();
 608   Standard_Integer i = 0, j;
 609
 610   while(i < aLen) {
 611     int c = (int)arr[i];
 612     j = i+1;
 613     if ( isdigit( c )) { //Is digit?
 614
 615       isFound = Standard_False;
 616       while((j < aLen) && ( isdigit(c) || c == ':' )) { //Check if it is an entry
 617         c = (int)arr[j++];
 618         if(c == ':') isFound = Standard_True;
 619       }
 620
 621       if (isFound) {
 622         int prev = (i < 1) ? 0 : (int)arr[i - 1];
 623         // to distinguish from a sketcher command:
 624         // last char should be a digit, not ":",
 625         // previous char should not be '"'.
 626         if (arr[j-2] != ':' && prev != '"') {
 627           aSeq->Append(i+1); // +1 because AsciiString starts from 1
 628           aSeq->Append(j-1);
 629         }
 630       }
 631     }
 632
 633     i = j;
 634   }
 635
 636   return aSeq;
 637 }
 638
 639 namespace {
 640
 641   //================================================================================
 642   /*!
 643    * \brief Make a string be a valid python name
 644     * \param aName - a string to fix
 645     * \retval bool - true if aName was not modified
 646    */
 647   //================================================================================
 648
 649   bool fixPythonName(TCollection_AsciiString & aName )
 650   {
 651     const TCollection_AsciiString allowedChars =
 652       "qwertyuioplkjhgfdsazxcvbnmQWERTYUIOPLKJHGFDSAZXCVBNM0987654321_";
 653     bool isValidName = true;
 654     int p=1; // replace not allowed chars with underscore
 655     while (p <= aName.Length() &&
 656            (p = aName.FirstLocationNotInSet(allowedChars, p, aName.Length())))
 657     {
 658       if ( p == 1 || p == aName.Length() || aName.Value(p-1) == '_')
 659         aName.Remove( p, 1 ); // remove double _ and from the start and the end
 660       else
 661         aName.SetValue(p, '_');
 662       isValidName = false;
 663     }
 664     if ( aName.IsIntegerValue() ) { // aName must not start with a digit
 665       aName.Insert( 1, 'a' );
 666       isValidName = false;
 667     }
 668     return isValidName;
 669   }
 670 }
 671
 672 //=============================================================================
 673 /*!
 674  *  DumpPython
 675  */
 676 //=============================================================================
 677 TCollection_AsciiString SMESH_Gen_i::DumpPython_impl
 678                         (SALOMEDS::Study_ptr theStudy,
 679                          Resource_DataMapOfAsciiStringAsciiString& theObjectNames,
 680                          Resource_DataMapOfAsciiStringAsciiString& theNames,
 681                          bool isPublished,
 682                          bool& aValidScript,
 683                          const TCollection_AsciiString& theSavedTrace)
 684 {
 685   int aStudyID = theStudy->StudyId();
 686
 687   TCollection_AsciiString helper; // to comfortably concatenate C strings
 688   TCollection_AsciiString aSmeshpy( SMESH_2smeshpy::SmeshpyName() );
 689   TCollection_AsciiString aSMESHGen( SMESH_2smeshpy::GenName() );
 690   TCollection_AsciiString anOldGen( SMESH::TPythonDump::SMESHGenName() );
 691
 692   TCollection_AsciiString aScript;
 693   aScript = "def RebuildData(theStudy):\n\t";
 694   aScript += helper + "aFilterManager = " + aSMESHGen + ".CreateFilterManager()\n\t";
 695   if ( isPublished )
 696     aScript += aSMESHGen + ".SetCurrentStudy(theStudy)";
 697   else
 698     aScript += aSMESHGen + ".SetCurrentStudy(None)";
 699
 700   // import python files corresponding to plugins
 701   set<string> moduleNameSet;
 702   map<string, GenericHypothesisCreator_i*>::iterator hyp_creator = myHypCreatorMap.begin();
 703   for ( ; hyp_creator != myHypCreatorMap.end(); ++hyp_creator ) {
 704     string moduleName = hyp_creator->second->GetModuleName();
 705     bool newModule = moduleNameSet.insert( moduleName ).second;
 706     if ( newModule )
 707       aScript += helper + "\n\t" + "import " + (char*) moduleName.c_str();
 708   }
 709
 710   // Dump trace of restored study
 711   if (theSavedTrace.Length() > 0) {
 712     // For the convertion of IDL API calls -> smesh.py API, "smesh" standing for SMESH_Gen
 713     // was replaces with "smeshgen" (==TPythonDump::SMESHGenName()).
 714     // Change "smesh" -> "smeshgen" in the trace saved before passage to smesh.py API
 715     bool isNewVersion =
 716       theSavedTrace.Location( anOldGen + ".", 1, theSavedTrace.Length() );
 717     if ( !isNewVersion ) {
 718       TCollection_AsciiString aSavedTrace( theSavedTrace );
 719       TCollection_AsciiString aSmeshCall ( "smesh." ), gen( "gen" );
 720       int beg, end = aSavedTrace.Length(), from = 1;
 721       while ( from < end && ( beg = aSavedTrace.Location( aSmeshCall, from, end ))) {
 722         char charBefore = ( beg == 1 ) ? ' ' : aSavedTrace.Value( beg - 1 );
 723         if ( isspace( charBefore ) || charBefore == '=' ) { // "smesh." is not a part of a long word
 724           aSavedTrace.Insert( beg + aSmeshCall.Length() - 1, gen );// "smesh" -> "smeshgen"
 725           end += gen.Length();
 726         }
 727         from = beg + aSmeshCall.Length();
 728       }
 729       aScript += helper + "\n" + aSavedTrace;
 730     }
 731     else
 732       // append a saved trace to the script
 733       aScript += helper + "\n" + theSavedTrace;
 734   }
 735
 736   // Dump trace of API methods calls
 737   TCollection_AsciiString aNewLines = GetNewPythonLines(aStudyID);
 738   if (aNewLines.Length() > 0) {
 739     aScript += helper + "\n" + aNewLines;
 740   }
 741
 742   // Convert IDL API calls into smesh.py API.
 743   // Some objects are wrapped with python classes and
 744   // Resource_DataMapOfAsciiStringAsciiString holds methods returning wrapped objects
 745   Resource_DataMapOfAsciiStringAsciiString anEntry2AccessorMethod;
 746   aScript = SMESH_2smeshpy::ConvertScript( aScript, anEntry2AccessorMethod, theObjectNames );
 747
 748   // Find entries to be replaced by names
 749   Handle(TColStd_HSequenceOfInteger) aSeq = FindEntries(aScript);
 750   Standard_Integer aLen = aSeq->Length();
 751
 752   if (aLen == 0)
 753     return aScript;
 754
 755   // Replace entries by the names
 756   GEOM::GEOM_Gen_ptr geom = GetGeomEngine();
 757   TColStd_SequenceOfAsciiString seqRemoved;
 758   Resource_DataMapOfAsciiStringAsciiString mapRemoved;
 759   Standard_Integer objectCounter = 0, aStart = 1, aScriptLength = aScript.Length();
 760   TCollection_AsciiString anUpdatedScript, anEntry, aName, aBaseName("smeshObj_");
 761
 762   // Collect names of GEOM objects to exclude same names for SMESH objects
 763   GEOM::string_array_var aGeomNames = geom->GetAllDumpNames();
 764   int ign = 0, nbgn = aGeomNames->length();
 765   for (; ign < nbgn; ign++) {
 766     aName = aGeomNames[ign];
 767     theObjectNames.Bind(aName, "1");
 768   }
 769
 770   bool importGeom = false;
 771   for (Standard_Integer i = 1; i <= aLen; i += 2) {
 772     anUpdatedScript += aScript.SubString(aStart, aSeq->Value(i) - 1);
 773     anEntry = aScript.SubString(aSeq->Value(i), aSeq->Value(i + 1));
 774     // is a GEOM object?
 775     aName = geom->GetDumpName( anEntry.ToCString() );
 776     if (aName.IsEmpty()) {
 777       // is a SMESH object
 778       if (theObjectNames.IsBound(anEntry)) {
 779         // The Object is in Study
 780         aName = theObjectNames.Find(anEntry);
 781         // check validity of aName
 782         bool isValidName = fixPythonName( aName );
 783         if (theObjectNames.IsBound(aName) && anEntry != theObjectNames(aName)) {
 784           // diff objects have same name - make a new name by appending a digit
 785           TCollection_AsciiString aName2;
 786           Standard_Integer i = 0;
 787           do {
 788             aName2 = aName + "_" + ++i;
 789           } while (theObjectNames.IsBound(aName2) && anEntry != theObjectNames(aName2));
 790           aName = aName2;
 791           isValidName = false;
 792         }
 793         if ( !isValidName )
 794           theObjectNames(anEntry) = aName;
 795
 796       } else {
 797         // Removed Object
 798         do {
 799           aName = aBaseName + (++objectCounter);
 800         } while (theObjectNames.IsBound(aName));
 801         seqRemoved.Append(aName);
 802         mapRemoved.Bind(anEntry, "1");
 803         theObjectNames.Bind(anEntry, aName);
 804       }
 805       theObjectNames.Bind(aName, anEntry); // to detect same name of diff objects
 806     }
 807     else
 808     {
 809       importGeom = true;
 810     }
 811     anUpdatedScript += aName;
 812     aStart = aSeq->Value(i + 1) + 1;
 813   }
 814
 815   // set initial part of aSript
 816   TCollection_AsciiString initPart = "import salome, SMESH, SALOMEDS\n";
 817   initPart += helper + "import " + aSmeshpy + "\n\n";
 818   if ( importGeom )
 819   {
 820     initPart += ("## import GEOM dump file ## \n"
 821                  "import string, os, sys, re\n"
 822                  "sys.path.insert( 0, os.path.dirname(__file__) )\n"
 823                  "exec(\"from \"+re.sub(\"SMESH$\",\"GEOM\",__name__)+\" import *\")\n\n");
 824   }
 825   anUpdatedScript.Insert ( 1, initPart );
 826
 827   // add final part of aScript
 828   if (aSeq->Value(aLen) < aScriptLength)
 829     anUpdatedScript += aScript.SubString(aSeq->Value(aLen) + 1, aScriptLength);
 830
 831   // Set colors
 832   SALOMEDS::SObject_var aComp = theStudy->FindComponent(ComponentDataType());
 833   if( !CORBA::is_nil(aComp) )
 834   {
 835     SALOMEDS::ChildIterator_var Itr = theStudy->NewChildIterator(aComp);
 836     for( Itr->InitEx(true); Itr->More(); Itr->Next() )
 837     {
 838       SALOMEDS::SObject_var aSObj = Itr->Value();
 839       SMESH::SMESH_Mesh_var aMesh = SMESH::SMESH_Mesh::_narrow( SObjectToObject( aSObj ) );
 840       // mesh auto color
 841       if( !CORBA::is_nil(aMesh) && aMesh->GetAutoColor() )
 842       {
 843         CORBA::String_var anEntry = aSObj->GetID();
 844         anUpdatedScript +=
 845           SMESH_Comment("\n\t") << theObjectNames(anEntry.inout()) << ".SetAutoColor(1)";
 846       }
 847       SMESH::SMESH_GroupBase_var aGroup = SMESH::SMESH_GroupBase::_narrow( SObjectToObject(aSObj));
 848       if( !CORBA::is_nil(aGroup) )
 849       {
 850         SALOMEDS::Color aColor = aGroup->GetColor();
 851         if ( aColor.R >= 0 || aColor.G >= 0 || aColor.B >= 0 )
 852         {
 853           CORBA::String_var anEntry = aSObj->GetID();
 854           anUpdatedScript += SMESH_Comment("\n\t")
 855             << theObjectNames(anEntry.inout()) << ".SetColor(SALOMEDS.Color("
 856             << aColor.R <<", "<< aColor.G <<", "<< aColor.B <<" ))";
 857         }
 858       }
 859     }
 860   }
 861
 862   // Remove removed objects
 863   if ( seqRemoved.Length() > 0 ) {
 864     anUpdatedScript += "\n\t## some objects were removed";
 865     anUpdatedScript += "\n\taStudyBuilder = theStudy.NewBuilder()";
 866   }
 867   for (int ir = 1; ir <= seqRemoved.Length(); ir++) {
 868     anUpdatedScript += "\n\tSO = theStudy.FindObjectIOR(theStudy.ConvertObjectToIOR(";
 869     anUpdatedScript += seqRemoved.Value(ir);
 870     // for object wrapped by class of smesh.py
 871     anEntry = theObjectNames( seqRemoved.Value(ir) );
 872     if ( anEntry2AccessorMethod.IsBound( anEntry ) )
 873       anUpdatedScript += helper + "." + anEntry2AccessorMethod( anEntry );
 874     anUpdatedScript += "))\n\tif SO is not None: aStudyBuilder.RemoveObjectWithChildren(SO)";
 875   }
 876
 877   // Set object names
 878   anUpdatedScript += "\n\t## set object names";
 879 //   anUpdatedScript += "\n\t\tsmeshgui = salome.ImportComponentGUI(\"SMESH\")";
 880 //   anUpdatedScript += "\n\t\tsmeshgui.Init(theStudy._get_StudyId())";
 881 //   anUpdatedScript += "\n";
 882
 883   TCollection_AsciiString aGUIName;
 884   Resource_DataMapOfAsciiStringAsciiString mapEntries;
 885   for (Standard_Integer i = 1; i <= aLen; i += 2)
 886   {
 887     anEntry = aScript.SubString(aSeq->Value(i), aSeq->Value(i + 1));
 888     aName = geom->GetDumpName( anEntry.ToCString() );
 889     if (aName.IsEmpty() && // Not a GEOM object
 890         theNames.IsBound(anEntry) &&
 891         !mapEntries.IsBound(anEntry) && // Not yet processed
 892         !mapRemoved.IsBound(anEntry)) // Was not removed
 893     {
 894       aName = theObjectNames.Find(anEntry);
 895       aGUIName = theNames.Find(anEntry);
 896       mapEntries.Bind(anEntry, aName);
 897       anUpdatedScript += helper + "\n\t" + aSMESHGen + ".SetName(" + aName;
 898       if ( anEntry2AccessorMethod.IsBound( anEntry ) )
 899         anUpdatedScript += helper + "." + anEntry2AccessorMethod( anEntry );
 900       anUpdatedScript += helper + ", '" + aGUIName + "')";
 901     }
 902   }
 903   anUpdatedScript += "\n\tif salome.sg.hasDesktop():";
 904   anUpdatedScript += "\n\t\tsalome.sg.updateObjBrowser(0)";
 905
 906   // -----------------------------------------------------------------
 907   // store visual properties of displayed objects
 908   // -----------------------------------------------------------------
 909
 910   if (isPublished)
 911   {
 912     //Output the script that sets up the visual parameters.
 913     char* script = theStudy->GetDefaultScript(ComponentDataType(), "\t");
 914     if (script && strlen(script) > 0) {
 915       anUpdatedScript += "\n\n\t### Store presentation parameters of displayed objects\n";
 916       anUpdatedScript += script;
 917       CORBA::string_free(script);
 918     }
 919   }
 920   anUpdatedScript += "\n\n\tpass\n";
 921
 922   // -----------------------------------------------------------------
 923   // put string literals describing patterns into separate functions
 924   // -----------------------------------------------------------------
 925
 926   TCollection_AsciiString aLongString, aFunctionType;
 927   int where = 1;
 928   set< string > functionNameSet;
 929   while ( SMESH::TPythonDump::CutoutLongString( anUpdatedScript, where, aLongString, aFunctionType ))
 930   {
 931     // make a python string literal
 932     aLongString.Prepend(":\n\treturn '''\n");
 933     aLongString += "\n\t'''\n\tpass\n";
 934
 935     TCollection_AsciiString functionName;
 936
 937     // check if the function returning this literal is already defined
 938     int posAlready = anUpdatedScript.Location( aLongString, where, anUpdatedScript.Length() );
 939     if ( posAlready ) // already defined
 940     {
 941       // find the function name
 942       int functBeg = posAlready;
 943       char* script = (char*) anUpdatedScript.ToCString() + posAlready - 1; // look at ":" after "def fuction()"
 944       while ( *script != ' ' ) {
 945         script--;
 946         functBeg--;
 947       }
 948       functBeg++; // do not take ' '
 949       posAlready--; // do not take ':'
 950       functionName = anUpdatedScript.SubString( functBeg, posAlready );
 951     }
 952     else // not defined yet
 953     {
 954       // find a unique function name
 955       fixPythonName( aFunctionType );
 956       Standard_Integer nb = 0;
 957       do functionName = aFunctionType + "_" + ( nb++ ) + "()";
 958       while ( !functionNameSet.insert( functionName.ToCString() ).second );
 959
 960       anUpdatedScript += helper + "\n\ndef " + functionName + aLongString; // define function
 961     }
 962     anUpdatedScript.InsertBefore( where, functionName ); // call function
 963   }
 964
 965   aValidScript = true;
 966
 967   return anUpdatedScript;
 968 }
 969
 970 //=============================================================================
 971 /*!
 972  *  GetNewPythonLines
 973  */
 974 //=============================================================================
 975 TCollection_AsciiString SMESH_Gen_i::GetNewPythonLines (int theStudyID)
 976 {
 977   TCollection_AsciiString aScript;
 978
 979   // Dump trace of API methods calls
 980   if (myPythonScripts.find(theStudyID) != myPythonScripts.end()) {
 981     Handle(TColStd_HSequenceOfAsciiString) aPythonScript = myPythonScripts[theStudyID];
 982     Standard_Integer istr, aLen = aPythonScript->Length();
 983     for (istr = 1; istr <= aLen; istr++) {
 984       aScript += "\n\t";
 985       aScript += aPythonScript->Value(istr);
 986     }
 987     aScript += "\n";
 988   }
 989
 990   return aScript;
 991 }
 992
 993 //=============================================================================
 994 /*!
 995  *  CleanPythonTrace
 996  */
 997 //=============================================================================
 998 void SMESH_Gen_i::CleanPythonTrace (int theStudyID)
 999 {
1000   TCollection_AsciiString aScript;
1001
1002   // Clean trace of API methods calls
1003   if (myPythonScripts.find(theStudyID) != myPythonScripts.end()) {
1004     myPythonScripts[theStudyID]->Clear();
1005   }
1006 }