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