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