src/SMESH_I/SMESH_DumpPython.cxx

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