1 // Copyright (C) 2007-2013 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
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.
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.
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
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
22 // File : SMESH_DumpPython.cxx
23 // Created : Thu Mar 24 17:17:59 2005
24 // Author : Julia DOROVSKIKH
27 #include "SMESH_PythonDump.hxx"
29 #include "SMESH_2smeshpy.hxx"
30 #include "SMESH_Comment.hxx"
31 #include "SMESH_Filter_i.hxx"
32 #include "SMESH_Gen_i.hxx"
33 #include "SMESH_MeshEditor_i.hxx"
35 #include <SALOMEDS_wrap.hxx>
37 #include <LDOMParser.hxx>
38 #include <Resource_DataMapIteratorOfDataMapOfAsciiStringAsciiString.hxx>
39 #include <TColStd_HSequenceOfInteger.hxx>
40 #include <TCollection_AsciiString.hxx>
43 static int MYDEBUG = 0;
45 static int MYDEBUG = 0;
48 #include "SMESH_TryCatch.hxx"
53 size_t TPythonDump::myCounter = 0;
54 const char theNotPublishedObjectName[] = "__NOT__Published__Object__";
56 TVar::TVar(CORBA::Double value):myVals(1) { myVals[0] = SMESH_Comment(value); }
57 TVar::TVar(CORBA::Long value):myVals(1) { myVals[0] = SMESH_Comment(value); }
58 TVar::TVar(CORBA::Short value):myVals(1) { myVals[0] = SMESH_Comment(value); }
59 TVar::TVar(const SMESH::double_array& value):myVals(value.length())
61 for ( size_t i = 0; i < value.length(); i++)
62 myVals[i] = SMESH_Comment(value[i]);
66 TPythonDump():myVarsCounter(0)
74 SMESH_Gen_i* aSMESHGen = SMESH_Gen_i::GetSMESHGen();
75 std::string aString = myStream.str();
76 TCollection_AsciiString aCollection(Standard_CString(aString.c_str()));
77 SALOMEDS::Study_var aStudy = aSMESHGen->GetCurrentStudy();
78 if(!aStudy->_is_nil() && !aCollection.IsEmpty())
80 const std::string & objEntry = SMESH_Gen_i::GetSMESHGen()->GetLastObjEntry();
81 if ( !objEntry.empty() )
82 aCollection += (TVar::ObjPrefix() + objEntry ).c_str();
83 aSMESHGen->AddToPythonScript(aStudy->StudyId(),aCollection);
84 if(MYDEBUG) MESSAGE(aString);
85 // prevent misuse of already treated variables
86 aSMESHGen->UpdateParameters(CORBA::Object_var().in(),"");
91 TPythonDump& //!< store a variable value. Write either a value or '$varID$'
93 operator<<(const TVar& theVarValue)
95 const std::vector< int >& varIDs = SMESH_Gen_i::GetSMESHGen()->GetLastParamIndices();
96 if ( theVarValue.myVals.size() != 1 )
99 for ( size_t i = 1; i <= theVarValue.myVals.size(); ++i )
101 if ( myVarsCounter < varIDs.size() && varIDs[ myVarsCounter ] >= 0 )
102 myStream << TVar::Quote() << varIDs[ myVarsCounter ] << TVar::Quote();
104 myStream << theVarValue.myVals[i-1];
105 if ( i < theVarValue.myVals.size() )
113 if ( myVarsCounter < varIDs.size() && varIDs[ myVarsCounter ] >= 0 )
114 myStream << TVar::Quote() << varIDs[ myVarsCounter ] << TVar::Quote();
116 myStream << theVarValue.myVals[0];
124 operator<<(long int theArg){
131 operator<<(int theArg){
138 operator<<(double theArg){
145 operator<<(float theArg){
152 operator<<(const void* theArg){
159 operator<<(const char* theArg){
167 operator<<(const SMESH::ElementType& theArg)
171 case ALL: myStream<<"ALL"; break;
172 case NODE: myStream<<"NODE"; break;
173 case EDGE: myStream<<"EDGE"; break;
174 case FACE: myStream<<"FACE"; break;
175 case VOLUME: myStream<<"VOLUME"; break;
176 case ELEM0D: myStream<<"ELEM0D"; break;
177 case BALL: myStream<<"BALL"; break;
178 default: myStream<<"__UNKNOWN__ElementType: " << theArg;
185 operator<<(const SMESH::GeometryType& theArg)
189 case Geom_POINT: myStream<<"Geom_POINT"; break;
190 case Geom_EDGE: myStream<<"Geom_EDGE"; break;
191 case Geom_TRIANGLE: myStream<<"Geom_TRIANGLE"; break;
192 case Geom_QUADRANGLE: myStream<<"Geom_QUADRANGLE"; break;
193 case Geom_POLYGON: myStream<<"Geom_POLYGON"; break;
194 case Geom_TETRA: myStream<<"Geom_TETRA"; break;
195 case Geom_PYRAMID: myStream<<"Geom_PYRAMID"; break;
196 case Geom_HEXA: myStream<<"Geom_HEXA"; break;
197 case Geom_PENTA: myStream<<"Geom_PENTA"; break;
198 case Geom_POLYHEDRA: myStream<<"Geom_POLYHEDRA"; break;
199 case Geom_BALL: myStream<<"Geom_BALL"; break;
200 default: myStream<<"__UNKNOWN__GeometryType: " << theArg;
206 operator<<(const SMESH::EntityType& theArg)
210 case Entity_0D: myStream<<"Entity_0D"; break;
211 case Entity_Edge: myStream<<"Entity_Edge"; break;
212 case Entity_Quad_Edge: myStream<<"Entity_Quad_Edge"; break;
213 case Entity_Triangle: myStream<<"Entity_Triangle"; break;
214 case Entity_Quad_Triangle: myStream<<"Entity_Quad_Triangle"; break;
215 case Entity_BiQuad_Triangle: myStream<<"Entity_BiQuad_Triangle"; break;
216 case Entity_Quadrangle: myStream<<"Entity_Quadrangle"; break;
217 case Entity_Quad_Quadrangle: myStream<<"Entity_Quad_Quadrangle"; break;
218 case Entity_BiQuad_Quadrangle: myStream<<"Entity_BiQuad_Quadrangle"; break;
219 case Entity_Polygon: myStream<<"Entity_Polygon"; break;
220 case Entity_Quad_Polygon: myStream<<"Entity_Quad_Polygon"; break;
221 case Entity_Tetra: myStream<<"Entity_Tetra"; break;
222 case Entity_Quad_Tetra: myStream<<"Entity_Quad_Tetra"; break;
223 case Entity_Pyramid: myStream<<"Entity_Pyramid"; break;
224 case Entity_Quad_Pyramid: myStream<<"Entity_Quad_Pyramid"; break;
225 case Entity_Hexa: myStream<<"Entity_Hexa"; break;
226 case Entity_Quad_Hexa: myStream<<"Entity_Quad_Hexa"; break;
227 case Entity_TriQuad_Hexa: myStream<<"Entity_TriQuad_Hexa"; break;
228 case Entity_Penta: myStream<<"Entity_Penta"; break;
229 case Entity_Quad_Penta: myStream<<"Entity_Quad_Penta"; break;
230 case Entity_Hexagonal_Prism: myStream<<"Entity_Hexagonal_Prism"; break;
231 case Entity_Polyhedra: myStream<<"Entity_Polyhedra"; break;
232 case Entity_Quad_Polyhedra: myStream<<"Entity_Quad_Polyhedra"; break;
233 case Entity_Ball: myStream<<"Entity_Ball"; break;
234 case Entity_Last: myStream<<"Entity_Last"; break;
235 default: myStream<<"__UNKNOWN__EntityType: " << theArg;
240 template<class TArray>
241 void DumpArray(const TArray& theArray, TPythonDump & theStream)
243 if ( theArray.length() == 0 )
250 for (int i = 1; i <= theArray.length(); i++) {
251 theStream << theArray[i-1];
252 if ( i < theArray.length() )
260 TPythonDump::operator<<(const SMESH::long_array& theArg)
262 DumpArray( theArg, *this );
267 TPythonDump::operator<<(const SMESH::double_array& theArg)
269 DumpArray( theArg, *this );
274 TPythonDump::operator<<(const SMESH::nodes_array& theArg)
276 DumpArray( theArg, *this );
281 TPythonDump::operator<<(const SMESH::string_array& theArray)
284 for (int i = 1; i <= theArray.length(); i++) {
285 myStream << "'" << theArray[i-1] << "'";
286 if ( i < theArray.length() )
295 operator<<(SALOMEDS::SObject_ptr aSObject)
297 if ( !aSObject->_is_nil() ) {
298 CORBA::String_var entry = aSObject->GetID();
299 myStream << entry.in();
302 myStream << theNotPublishedObjectName;
309 operator<<(CORBA::Object_ptr theArg)
311 SMESH_Gen_i* aSMESHGen = SMESH_Gen_i::GetSMESHGen();
312 SALOMEDS::Study_var aStudy = aSMESHGen->GetCurrentStudy();
313 SALOMEDS::SObject_wrap aSObject = SMESH_Gen_i::ObjectToSObject(aStudy,theArg);
314 if(!aSObject->_is_nil()) {
315 CORBA::String_var id = aSObject->GetID();
317 } else if ( !CORBA::is_nil(theArg)) {
318 if ( aSMESHGen->CanPublishInStudy( theArg )) // not published SMESH object
319 myStream << "smeshObj_" << size_t(theArg);
321 myStream << theNotPublishedObjectName;
330 operator<<(SMESH::SMESH_Hypothesis_ptr theArg)
332 SALOMEDS::Study_var aStudy = SMESH_Gen_i::GetSMESHGen()->GetCurrentStudy();
333 SALOMEDS::SObject_wrap aSObject = SMESH_Gen_i::ObjectToSObject(aStudy,theArg);
334 if(aSObject->_is_nil() && !CORBA::is_nil(theArg))
335 myStream << "hyp_" << theArg->GetId();
343 operator<<(SMESH::SMESH_IDSource_ptr theArg)
345 if ( CORBA::is_nil( theArg ) )
346 return *this << "None";
347 SMESH_Gen_i* aSMESHGen = SMESH_Gen_i::GetSMESHGen();
348 SALOMEDS::Study_var aStudy = aSMESHGen->GetCurrentStudy();
349 SALOMEDS::SObject_wrap aSObject = SMESH_Gen_i::ObjectToSObject(aStudy,theArg);
350 if(!aSObject->_is_nil())
352 return *this << aSObject;
354 if ( SMESH::Filter_i* filter = SMESH::DownCast<SMESH::Filter_i*>( theArg ))
356 return *this << filter;
358 if ( SMESH_MeshEditor_i::IsTemporaryIDSource( theArg ))
360 SMESH::SMESH_Mesh_var mesh = theArg->GetMesh();
361 SMESH::long_array_var anElementsId = theArg->GetIDs();
362 SMESH::array_of_ElementType_var types = theArg->GetTypes();
363 SMESH::ElementType type = types->length() ? types[0] : SMESH::ALL;
364 SALOMEDS::SObject_wrap meshSO = SMESH_Gen_i::ObjectToSObject(aStudy,mesh);
365 if ( meshSO->_is_nil() ) // don't waste memory for dumping not published objects
366 return *this << mesh << ".GetIDSource([], " << type << ")";
368 return *this << mesh << ".GetIDSource(" << anElementsId << ", " << type << ")";
370 return *this << theNotPublishedObjectName;
375 operator<<(SMESH::FilterLibrary_i* theArg)
377 myStream<<"aFilterLibrary"<<theArg;
383 operator<<(SMESH::FilterManager_i* theArg)
385 myStream<<"aFilterManager";
391 operator<<(SMESH::Filter_i* theArg)
393 myStream<<"aFilter"<<theArg;
399 operator<<(SMESH::Functor_i* theArg)
402 FunctorType aFunctorType = theArg->GetFunctorType();
403 switch(aFunctorType) {
404 case FT_AspectRatio: myStream<< "aAspectRatio"; break;
405 case FT_AspectRatio3D: myStream<< "aAspectRatio3D"; break;
406 case FT_Warping: myStream<< "aWarping"; break;
407 case FT_MinimumAngle: myStream<< "aMinimumAngle"; break;
408 case FT_Taper: myStream<< "aTaper"; break;
409 case FT_Skew: myStream<< "aSkew"; break;
410 case FT_Area: myStream<< "aArea"; break;
411 case FT_Volume3D: myStream<< "aVolume3D"; break;
412 case FT_MaxElementLength2D: myStream<< "aMaxElementLength2D"; break;
413 case FT_MaxElementLength3D: myStream<< "aMaxElementLength3D"; break;
414 case FT_FreeBorders: myStream<< "aFreeBorders"; break;
415 case FT_FreeEdges: myStream<< "aFreeEdges"; break;
416 case FT_FreeNodes: myStream<< "aFreeNodes"; break;
417 case FT_FreeFaces: myStream<< "aFreeFaces"; break;
418 case FT_EqualNodes: myStream<< "aEqualNodes"; break;
419 case FT_EqualEdges: myStream<< "aEqualEdges"; break;
420 case FT_EqualFaces: myStream<< "aEqualFaces"; break;
421 case FT_EqualVolumes: myStream<< "aEqualVolumes"; break;
422 case FT_MultiConnection: myStream<< "aMultiConnection"; break;
423 case FT_MultiConnection2D: myStream<< "aMultiConnection2D"; break;
424 case FT_Length: myStream<< "aLength"; break;
425 case FT_Length2D: myStream<< "aLength2D"; break;
426 case FT_BelongToGeom: myStream<< "aBelongToGeom"; break;
427 case FT_BelongToPlane: myStream<< "aBelongToPlane"; break;
428 case FT_BelongToCylinder: myStream<< "aBelongToCylinder"; break;
429 case FT_BelongToGenSurface: myStream<< "aBelongToGenSurface"; break;
430 case FT_LyingOnGeom: myStream<< "aLyingOnGeom"; break;
431 case FT_RangeOfIds: myStream<< "aRangeOfIds"; break;
432 case FT_BadOrientedVolume: myStream<< "aBadOrientedVolume"; break;
433 case FT_BareBorderVolume: myStream<< "aBareBorderVolume"; break;
434 case FT_BareBorderFace: myStream<< "aBareBorderFace"; break;
435 case FT_OverConstrainedVolume: myStream<< "aOverConstrainedVolume"; break;
436 case FT_OverConstrainedFace: myStream<< "aOverConstrainedFace"; break;
437 case FT_LinearOrQuadratic: myStream<< "aLinearOrQuadratic"; break;
438 case FT_GroupColor: myStream<< "aGroupColor"; break;
439 case FT_ElemGeomType: myStream<< "aElemGeomType"; break;
440 case FT_EntityType: myStream<< "aEntityType"; break;
441 case FT_CoplanarFaces: myStream<< "aCoplanarFaces"; break;
442 case FT_BallDiameter: myStream<< "aBallDiameter"; break;
443 case FT_ConnectedElements: myStream<< "aConnectedElements"; break;
444 case FT_LessThan: myStream<< "aLessThan"; break;
445 case FT_MoreThan: myStream<< "aMoreThan"; break;
446 case FT_EqualTo: myStream<< "aEqualTo"; break;
447 case FT_LogicalNOT: myStream<< "aLogicalNOT"; break;
448 case FT_LogicalAND: myStream<< "aLogicalAND"; break;
449 case FT_LogicalOR: myStream<< "aLogicalOR"; break;
451 default: myStream<< "anUndefined"; break;
460 operator<<(SMESH::Measurements_i* theArg)
462 myStream<<"aMeasurements";
467 TPythonDump& TPythonDump:: operator<<(SMESH_Gen_i* theArg)
469 myStream << SMESHGenName(); return *this;
472 TPythonDump& TPythonDump::operator<<(SMESH_MeshEditor_i* theArg)
474 myStream << MeshEditorName() << "_" << ( theArg ? theArg->GetMeshId() : -1 ); return *this;
477 TPythonDump& TPythonDump::operator<<(const TCollection_AsciiString & theStr)
479 myStream << theStr; return *this;
483 TPythonDump& TPythonDump::operator<<(SMESH::MED_VERSION theVersion)
485 switch (theVersion) {
486 case SMESH::MED_V2_1: myStream << "SMESH.MED_V2_1"; break;
487 case SMESH::MED_V2_2: myStream << "SMESH.MED_V2_2"; break;
488 default: myStream << theVersion;
493 TPythonDump& TPythonDump::operator<<(const SMESH::AxisStruct & theAxis)
495 *this << "SMESH.AxisStruct( "
496 << TVar( theAxis.x ) << ", "
497 << TVar( theAxis.y ) << ", "
498 << TVar( theAxis.z ) << ", "
499 << TVar( theAxis.vx ) << ", "
500 << TVar( theAxis.vy ) << ", "
501 << TVar( theAxis.vz ) << " )";
505 TPythonDump& TPythonDump::operator<<(const SMESH::DirStruct & theDir)
507 const SMESH::PointStruct & P = theDir.PS;
508 *this << "SMESH.DirStruct( SMESH.PointStruct ( "
509 << TVar( P.x ) << ", "
510 << TVar( P.y ) << ", "
511 << TVar( P.z ) << " ))";
515 TPythonDump& TPythonDump::operator<<(const SMESH::PointStruct & P)
517 *this << "SMESH.PointStruct ( "
518 << TVar( P.x ) << ", "
519 << TVar( P.y ) << ", "
520 << TVar( P.z ) << " )";
524 TPythonDump& TPythonDump::operator<<(const SMESH::ListOfGroups& theList)
526 DumpArray( theList, *this );
529 TPythonDump& TPythonDump::operator<<(const SMESH::ListOfGroups * theList)
531 DumpArray( *theList, *this );
534 TPythonDump& TPythonDump::operator<<(const GEOM::ListOfGO& theList)
536 DumpArray( theList, *this );
539 TPythonDump& TPythonDump::operator<<(const SMESH::ListOfIDSources& theList)
541 DumpArray( theList, *this );
544 const char* TPythonDump::NotPublishedObjectName()
546 return theNotPublishedObjectName;
549 TCollection_AsciiString myLongStringStart( "TPythonDump::LongStringStart" );
550 TCollection_AsciiString myLongStringEnd ( "TPythonDump::LongStringEnd" );
552 //================================================================================
554 * \brief Return marker of long string literal beginning
555 * \param type - a name of functionality producing the string literal
556 * \retval TCollection_AsciiString - the marker string to be written into
557 * a raw python script
559 //================================================================================
561 TCollection_AsciiString TPythonDump::LongStringStart(const char* type)
565 (Standard_Integer) strlen(type) +
570 //================================================================================
572 * \brief Return marker of long string literal end
573 * \retval TCollection_AsciiString - the marker string to be written into
574 * a raw python script
576 //================================================================================
578 TCollection_AsciiString TPythonDump::LongStringEnd()
580 return myLongStringEnd;
583 //================================================================================
585 * \brief Cut out a long string literal from a string
586 * \param theText - text possibly containing string literals
587 * \param theFrom - position in the text to search from
588 * \param theLongString - the retrieved literal
589 * \param theStringType - a name of functionality produced the literal
590 * \retval bool - true if a string literal found
592 * The literal is removed from theText; theFrom points position right after
593 * the removed literal
595 //================================================================================
597 bool TPythonDump::CutoutLongString( TCollection_AsciiString & theText,
599 TCollection_AsciiString & theLongString,
600 TCollection_AsciiString & theStringType)
602 if ( theFrom < 1 || theFrom > theText.Length() )
605 // ...script \ beg marker \ \ type \ literal \ end marker \ script...
606 // "theText myLongStringStart7 Pattern!!! SALOME Mesh Pattern file myLongStringEndtextEnd"
607 // 012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789
610 theFrom = theText.Location( myLongStringStart, theFrom, theText.Length() ); // = 09
614 // find where literal begins
615 int literalBeg = theFrom + myLongStringStart.Length(); // = 26
616 char* typeLenStr = (char*) theText.ToCString() + literalBeg - 1; // = "7 Pattern!!! SALO...."
617 int typeLen = atoi ( typeLenStr ); // = 7
618 while ( *typeLenStr != ' ' ) { // look for ' ' after typeLen
619 literalBeg++; // 26 -> 27
622 literalBeg += typeLen + 1; // = 35
623 if ( literalBeg > theText.Length() )
626 // where literal ends (i.e. end marker begins)
627 int literalEnd = theText.Location( myLongStringEnd, literalBeg, theText.Length() ); // = 64
629 literalEnd = theText.Length();
632 theLongString = theText.SubString( literalBeg, literalEnd - 1); // "!!! SALOME Mesh Pattern file "
634 theStringType = theText.SubString( literalBeg - typeLen, literalBeg - 1 ); // "Pattern"
636 literalEnd += myLongStringEnd.Length(); // = 79
637 TCollection_AsciiString textEnd = theText.SubString( literalEnd, theText.Length() ); // "textE..."
638 theText = theText.SubString( 1, theFrom - 1 ) + textEnd;
643 void printException( const char* text )
646 cout << "Exception in SMESH_Gen_i::DumpPython(): " << text << endl;
651 //=======================================================================
652 //function : RemoveTabulation
654 //=======================================================================
655 void RemoveTabulation( TCollection_AsciiString& theScript )
657 std::string aString( theScript.ToCString() );
658 std::string::size_type aPos = 0;
659 while( aPos < aString.length() )
661 aPos = aString.find( "\n\t", aPos );
662 if( aPos == std::string::npos )
664 aString.replace( aPos, 2, "\n" );
667 theScript = aString.c_str();
670 //=======================================================================
671 //function : DumpPython
673 //=======================================================================
674 Engines::TMPFile* SMESH_Gen_i::DumpPython (CORBA::Object_ptr theStudy,
675 CORBA::Boolean isPublished,
676 CORBA::Boolean isMultiFile,
677 CORBA::Boolean& isValidScript)
679 SALOMEDS::Study_var aStudy = SALOMEDS::Study::_narrow(theStudy);
680 if (CORBA::is_nil(aStudy))
681 return new Engines::TMPFile(0);
683 CORBA::String_var compDataType = ComponentDataType();
684 SALOMEDS::SObject_wrap aSO = aStudy->FindComponent( compDataType.in() );
685 if (CORBA::is_nil(aSO))
686 return new Engines::TMPFile(0);
688 // Map study entries to object names
689 Resource_DataMapOfAsciiStringAsciiString aMap;
690 Resource_DataMapOfAsciiStringAsciiString aMapNames;
692 SALOMEDS::ChildIterator_wrap Itr = aStudy->NewChildIterator(aSO);
693 for (Itr->InitEx(true); Itr->More(); Itr->Next()) {
694 SALOMEDS::SObject_wrap aValue = Itr->Value();
695 CORBA::String_var anID = aValue->GetID();
696 CORBA::String_var aName = aValue->GetName();
697 TCollection_AsciiString aGUIName ( (char*) aName.in() );
698 TCollection_AsciiString anEntry ( (char*) anID.in() );
699 if (aGUIName.Length() > 0) {
700 aMapNames.Bind( anEntry, aGUIName );
701 aMap.Bind( anEntry, aGUIName );
705 // Get trace of restored study
706 SALOMEDS::StudyBuilder_var aStudyBuilder = aStudy->NewBuilder();
707 SALOMEDS::GenericAttribute_wrap anAttr =
708 aStudyBuilder->FindOrCreateAttribute(aSO, "AttributePythonObject");
710 SALOMEDS::AttributePythonObject_var pyAttr =
711 SALOMEDS::AttributePythonObject::_narrow(anAttr);
712 CORBA::String_var oldValue = pyAttr->GetObject();
713 TCollection_AsciiString aSavedTrace (oldValue.in());
715 // Add trace of API methods calls and replace study entries by names
716 TCollection_AsciiString aScript;
717 aScript += DumpPython_impl(aStudy, aMap, aMapNames, isPublished, isMultiFile,
718 myIsHistoricalPythonDump, isValidScript, aSavedTrace);
720 int aLen = aScript.Length();
721 unsigned char* aBuffer = new unsigned char[aLen+1];
722 strcpy((char*)aBuffer, aScript.ToCString());
724 CORBA::Octet* anOctetBuf = (CORBA::Octet*)aBuffer;
725 Engines::TMPFile_var aStreamFile = new Engines::TMPFile(aLen+1, aLen+1, anOctetBuf, 1);
727 bool hasNotPublishedObjects = aScript.Location( SMESH::theNotPublishedObjectName, 1, aLen);
728 isValidScript = isValidScript && !hasNotPublishedObjects;
730 return aStreamFile._retn();
733 //=============================================================================
737 //=============================================================================
738 void SMESH_Gen_i::AddToPythonScript (int theStudyID, const TCollection_AsciiString& theString)
740 if (myPythonScripts.find(theStudyID) == myPythonScripts.end()) {
741 myPythonScripts[theStudyID] = new TColStd_HSequenceOfAsciiString;
743 myPythonScripts[theStudyID]->Append(theString);
746 //=============================================================================
748 * RemoveLastFromPythonScript
750 //=============================================================================
751 void SMESH_Gen_i::RemoveLastFromPythonScript (int theStudyID)
753 if (myPythonScripts.find(theStudyID) != myPythonScripts.end()) {
754 int aLen = myPythonScripts[theStudyID]->Length();
755 myPythonScripts[theStudyID]->Remove(aLen);
759 //=======================================================================
760 //function : SavePython
762 //=======================================================================
763 void SMESH_Gen_i::SavePython (SALOMEDS::Study_ptr theStudy)
765 // Dump trace of API methods calls
766 TCollection_AsciiString aScript = GetNewPythonLines(theStudy->StudyId());
768 // Check contents of PythonObject attribute
769 CORBA::String_var compDataType = ComponentDataType();
770 SALOMEDS::SObject_wrap aSO = theStudy->FindComponent( compDataType.in() );
771 SALOMEDS::StudyBuilder_var aStudyBuilder = theStudy->NewBuilder();
772 SALOMEDS::GenericAttribute_wrap anAttr =
773 aStudyBuilder->FindOrCreateAttribute(aSO, "AttributePythonObject");
775 SALOMEDS::AttributePythonObject_var pyAttr =
776 SALOMEDS::AttributePythonObject::_narrow(anAttr);
777 CORBA::String_var oldValue = pyAttr->GetObject();
778 TCollection_AsciiString oldScript (oldValue.in());
780 if (oldScript.Length() > 0) {
782 oldScript += aScript;
787 // Store in PythonObject attribute
788 pyAttr->SetObject(oldScript.ToCString(), 1);
790 // Clean trace of API methods calls
791 CleanPythonTrace(theStudy->StudyId());
798 //=============================================================================
800 * FindEntries: Returns a sequence of start/end positions of entries in the string
802 //=============================================================================
803 Handle(TColStd_HSequenceOfInteger) FindEntries (TCollection_AsciiString& theString)
805 Handle(TColStd_HSequenceOfInteger) aSeq = new TColStd_HSequenceOfInteger;
806 Standard_Integer aLen = theString.Length();
807 Standard_Boolean isFound = Standard_False;
809 char* arr = (char*) theString.ToCString();
810 Standard_Integer i = 0, j;
815 if ( isdigit( c )) { //Is digit?
817 isFound = Standard_False;
818 while((j < aLen) && ( isdigit(c) || c == ':' )) { //Check if it is an entry
820 if(c == ':') isFound = Standard_True;
824 int prev = (i < 1) ? 0 : (int)arr[i - 1];
825 // to distinguish from a sketcher command:
826 // last char should be a digit, not ":",
827 // previous char should not be '"'.
828 if (arr[j-2] != ':' && prev != '"') {
829 aSeq->Append(i+1); // +1 because AsciiString starts from 1
843 //================================================================================
845 * \brief Make a string be a valid python name
846 * \param aName - a string to fix
847 * \retval bool - true if aName was not modified
849 //================================================================================
851 bool fixPythonName(TCollection_AsciiString & aName)
853 bool isValidName = true;
854 int nbUnderscore = 0;
856 // replace not allowed chars by underscore
857 const char* name = aName.ToCString();
858 for ( p = 0; name[p]; ++p ) {
859 if ( !isalnum( name[p] ) && name[p] != '_' )
861 if ( p == 0 || p+1 == aName.Length() || name[p-1] == '_')
863 aName.Remove( p+1, 1 ); // remove __ and _ from the start and the end
865 name = aName.ToCString();
869 aName.SetValue( p+1, '_');
875 // aName must not start with a digit
876 if ( aName.IsIntegerValue() ) {
877 aName.Insert( 1, 'a' );
880 // shorten names like CartesianParameters3D_400_400_400_1000000_1
881 const int nbAllowedUnderscore = 3; /* changed from 2 to 3 by an user request
882 posted to SALOME Forum */
883 if ( aName.Length() > 20 && nbUnderscore > nbAllowedUnderscore )
885 p = aName.Location( "_", 20, aName.Length());
892 //================================================================================
894 * \brief Return Python module names of available plug-ins.
896 //================================================================================
898 std::vector<std::string> getPluginNames()
900 std::vector<std::string> pluginNames;
901 std::vector< std::string > xmlPaths = SMESH_Gen::GetPluginXMLPaths();
902 LDOMParser xmlParser;
903 for ( size_t i = 0; i < xmlPaths.size(); ++i )
905 bool error = xmlParser.parse( xmlPaths[i].c_str() );
908 TCollection_AsciiString data;
909 INFOS( xmlParser.GetError(data) );
912 // <meshers-group name="Standard Meshers"
913 // resources="StdMeshers"
914 // idl-module="StdMeshers"
915 // server-lib="StdMeshersEngine"
916 // gui-lib="StdMeshersGUI">
917 LDOM_Document xmlDoc = xmlParser.getDocument();
918 LDOM_NodeList nodeList = xmlDoc.getElementsByTagName( "meshers-group" );
919 for ( int i = 0; i < nodeList.getLength(); ++i )
921 LDOM_Node node = nodeList.item( i );
922 LDOM_Element& elem = (LDOM_Element&) node;
923 LDOMString idlModule = elem.getAttribute( "idl-module" );
924 if ( strlen( idlModule.GetString() ) > 0 )
925 pluginNames.push_back( idlModule.GetString() );
932 //================================================================================
934 * \brief Createa a Dump Python script
935 * \param [in] theStudy - the study to dump
936 * \param [in,out] theObjectNames - map of an entry to a study and python name
937 * \param [in] theNames - - map of an entry to a study name
938 * \param [in] isPublished - \c true if dump of object publication in study is needed
939 * \param [in] isMultiFile - \c true if dump of each module goes to a separate file
940 * \param [in] isHistoricalDump - \c true if removed object should be dumped
941 * \param [out] aValidScript - returns \c true if the returned script seems valid
942 * \param [in,out] theSavedTrace - the dump stored in the study. It's cleared to
943 * decrease memory usage.
944 * \return TCollection_AsciiString - the result dump script.
946 //================================================================================
948 TCollection_AsciiString SMESH_Gen_i::DumpPython_impl
949 (SALOMEDS::Study_ptr theStudy,
950 Resource_DataMapOfAsciiStringAsciiString& theObjectNames,
951 Resource_DataMapOfAsciiStringAsciiString& theNames,
954 bool isHistoricalDump,
956 TCollection_AsciiString& theSavedTrace)
959 const int aStudyID = theStudy->StudyId();
961 const TCollection_AsciiString aSmeshpy ( SMESH_2smeshpy::SmeshpyName() );
962 const TCollection_AsciiString aSMESHGen( SMESH_2smeshpy::GenName() );
963 const TCollection_AsciiString anOldGen ( SMESH::TPythonDump::SMESHGenName() );
964 const TCollection_AsciiString helper; // to comfortably append C strings to TCollection_AsciiString
965 const TCollection_AsciiString tab( isMultiFile ? "\t" : "" ), nt = helper + "\n" + tab;
967 std::list< TCollection_AsciiString > lines; // lines of a script
968 std::list< TCollection_AsciiString >::iterator linesIt;
971 lines.push_back( aSMESHGen + " = smeshBuilder.New(theStudy)" );
973 lines.push_back( aSMESHGen + " = smeshBuilder.New(None)" );
974 lines.push_back( helper + "aFilterManager = " + aSMESHGen + ".CreateFilterManager()" );
975 lines.push_back( helper + "aMeasurements = " + aSMESHGen + ".CreateMeasurements()" );
977 // Treat dump trace of restored study
978 if (theSavedTrace.Length() > 0)
980 linesIt = --lines.end();
981 // Split theSavedTrace into lines
982 int from = 1, end = theSavedTrace.Length(), to;
983 while ( from < end && ( to = theSavedTrace.Location( "\n", from, end )))
985 if ( theSavedTrace.ToCString()[from-1] == '\t' )
988 lines.push_back( theSavedTrace.SubString( from, to - 1 ));
991 // For the convertion of IDL API calls -> smeshBuilder.py API, "smesh" standing for SMESH_Gen
992 // was replaces with "smeshgen" (==TPythonDump::SMESHGenName()).
993 // Change "smesh" -> "smeshgen" in the trace saved before passage to smeshBuilder.py API
995 theSavedTrace.Location( anOldGen + ".", 1, theSavedTrace.Length() );
996 theSavedTrace.Clear();
999 const TCollection_AsciiString aSmeshCall ( "smesh." ), gen( "gen" );
1001 for ( ++linesIt; linesIt != lines.end(); ++linesIt )
1003 TCollection_AsciiString& aSavedLine = *linesIt;
1004 end = aSavedLine.Length(), from = 1;
1005 while ( from < end && ( beg = aSavedLine.Location( aSmeshCall, from, end )))
1007 char charBefore = ( beg == 1 ) ? ' ' : aSavedLine.Value( beg - 1 );
1008 if ( isspace( charBefore ) || charBefore == '=' ) { // "smesh." is not a part of a long word
1009 aSavedLine.Insert( beg + aSmeshCall.Length() - 1, gen );// "smesh" -> "smeshgen"
1010 end += gen.Length();
1012 from = beg + aSmeshCall.Length();
1018 // Add new dump trace of API methods calls to script lines
1019 if (myPythonScripts.find( aStudyID ) != myPythonScripts.end())
1021 Handle(TColStd_HSequenceOfAsciiString) aPythonScript = myPythonScripts[ aStudyID ];
1022 Standard_Integer istr, aLen = aPythonScript->Length();
1023 for (istr = 1; istr <= aLen; istr++)
1024 lines.push_back( aPythonScript->Value( istr ));
1027 // Convert IDL API calls into smeshBuilder.py API.
1028 // Some objects are wrapped with python classes and
1029 // Resource_DataMapOfAsciiStringAsciiString holds methods returning wrapped objects
1030 Resource_DataMapOfAsciiStringAsciiString anEntry2AccessorMethod;
1031 std::set< TCollection_AsciiString > aRemovedObjIDs;
1032 if ( !getenv("NO_2smeshpy_conversion"))
1033 SMESH_2smeshpy::ConvertScript( lines, anEntry2AccessorMethod,
1034 theObjectNames, aRemovedObjIDs,
1035 theStudy, isHistoricalDump );
1037 bool importGeom = false;
1038 GEOM::GEOM_Gen_ptr geom = GetGeomEngine();
1040 // Add names of GEOM objects to theObjectNames to exclude same names of SMESH objects
1041 GEOM::string_array_var aGeomNames = geom->GetAllDumpNames();
1042 int ign = 0, nbgn = aGeomNames->length();
1043 for (; ign < nbgn; ign++) {
1044 TCollection_AsciiString aName = aGeomNames[ign].in();
1045 theObjectNames.Bind(aName, "1");
1049 TCollection_AsciiString anUpdatedScript;
1051 Resource_DataMapOfAsciiStringAsciiString mapRemoved;
1052 Resource_DataMapOfAsciiStringAsciiString mapEntries; // names and entries present in anUpdatedScript
1053 Standard_Integer objectCounter = 0;
1054 TCollection_AsciiString anEntry, aName, aGUIName, aBaseName("smeshObj_");
1056 // Treat every script line and add it to anUpdatedScript
1057 for ( linesIt = lines.begin(); linesIt != lines.end(); ++linesIt )
1059 TCollection_AsciiString& aLine = *linesIt;
1060 anUpdatedScript += tab;
1062 //Replace characters used instead of quote marks to quote notebook variables
1064 while (( pos = aLine.Location( 1, SMESH::TVar::Quote(), pos, aLine.Length() )))
1065 aLine.SetValue( pos, '"' );
1067 // Find entries to be replaced by names
1068 Handle(TColStd_HSequenceOfInteger) aSeq = FindEntries(aLine);
1069 const Standard_Integer aSeqLen = aSeq->Length();
1070 Standard_Integer aStart = 1;
1071 for (Standard_Integer i = 1; i <= aSeqLen; i += 2)
1073 if ( aStart < aSeq->Value(i) )
1074 anUpdatedScript += aLine.SubString( aStart, aSeq->Value(i) - 1 ); // line part before i-th entry
1075 anEntry = aLine.SubString( aSeq->Value(i), aSeq->Value(i + 1) );
1076 // is a GEOM object?
1077 CORBA::String_var geomName = geom->GetDumpName( anEntry.ToCString() );
1078 if ( !geomName.in() || !geomName.in()[0] ) {
1079 // is a SMESH object
1080 if ( theObjectNames.IsBound( anEntry )) {
1081 // The Object is in Study
1082 aName = theObjectNames.Find( anEntry );
1083 // check validity of aName
1084 bool isValidName = fixPythonName( aName );
1085 if (theObjectNames.IsBound(aName) && anEntry != theObjectNames(aName)) {
1086 // diff objects have same name - make a new name by appending a digit
1087 TCollection_AsciiString aName2;
1088 Standard_Integer i = 0;
1090 aName2 = aName + "_" + ++i;
1091 } while (theObjectNames.IsBound(aName2) && anEntry != theObjectNames(aName2));
1093 isValidName = false;
1096 theObjectNames(anEntry) = aName;
1098 if ( aLine.Value(1) != '#' )
1099 mapEntries.Bind(anEntry, aName);
1105 aName = aBaseName + (++objectCounter);
1106 } while (theObjectNames.IsBound(aName));
1108 if ( !aRemovedObjIDs.count( anEntry ) && aLine.Value(1) != '#')
1109 mapRemoved.Bind(anEntry, aName);
1111 theObjectNames.Bind(anEntry, aName);
1113 theObjectNames.Bind(aName, anEntry); // to detect same name of diff objects
1117 aName = geomName.in();
1120 anUpdatedScript += aName;
1121 aStart = aSeq->Value(i + 1) + 1;
1123 } // loop on entries within aLine
1126 anUpdatedScript += aLine;
1127 else if ( aSeq->Value( aSeqLen ) < aLine.Length() )
1128 anUpdatedScript += aLine.SubString( aSeq->Value(aSeqLen) + 1, aLine.Length() );
1130 anUpdatedScript += '\n';
1133 // Make an initial part of aSript
1135 TCollection_AsciiString initPart = "import ";
1137 initPart += "salome, ";
1138 initPart += " SMESH, SALOMEDS\n";
1139 initPart += "from salome.smesh import smeshBuilder\n";
1140 if ( importGeom && isMultiFile )
1142 initPart += ("\n## import GEOM dump file ## \n"
1143 "import string, os, sys, re\n"
1144 "sys.path.insert( 0, os.path.dirname(__file__) )\n"
1145 "exec(\"from \"+re.sub(\"SMESH$\",\"GEOM\",__name__)+\" import *\")\n");
1147 // import python files corresponding to plugins if they are used in anUpdatedScript
1149 TCollection_AsciiString importStr;
1150 std::vector<std::string> pluginNames = getPluginNames();
1151 for ( size_t i = 0; i < pluginNames.size(); ++i )
1153 // Convert access to plugin members:
1154 // e.g. StdMeshers.QUAD_REDUCED -> StdMeshersBuilder.QUAD_REDUCED
1155 TCollection_AsciiString pluginAccess = (pluginNames[i] + ".").c_str() ;
1156 int iFrom = 1, iPos;
1157 while (( iPos = anUpdatedScript.Location( pluginAccess, iFrom, anUpdatedScript.Length() )))
1159 anUpdatedScript.Insert( iPos + pluginNames[i].size(), "Builder" );
1160 iFrom = iPos + pluginNames[i].size() + 8;
1162 // if any plugin member is used, import the plugin
1164 importStr += ( helper + "\n" "from salome." + pluginNames[i].c_str() +
1165 " import " + pluginNames[i].c_str() +"Builder" );
1167 if ( !importStr.IsEmpty() )
1168 initPart += importStr + "\n";
1172 initPart += "def RebuildData(theStudy):";
1175 anUpdatedScript.Prepend( initPart );
1177 // Make a final part of aScript
1179 // Dump object removal
1180 TCollection_AsciiString removeObjPart;
1181 if ( !mapRemoved.IsEmpty() ) {
1182 removeObjPart += nt + "## some objects were removed";
1183 removeObjPart += nt + "aStudyBuilder = theStudy.NewBuilder()";
1184 Resource_DataMapIteratorOfDataMapOfAsciiStringAsciiString mapRemovedIt;
1185 for ( mapRemovedIt.Initialize( mapRemoved ); mapRemovedIt.More(); mapRemovedIt.Next() ) {
1186 aName = mapRemovedIt.Value(); // python name
1187 anEntry = mapRemovedIt.Key();
1188 removeObjPart += nt + "SO = theStudy.FindObjectIOR(theStudy.ConvertObjectToIOR(";
1189 removeObjPart += aName;
1190 // for object wrapped by class of smeshBuilder.py
1191 if ( anEntry2AccessorMethod.IsBound( anEntry ) )
1192 removeObjPart += helper + "." + anEntry2AccessorMethod( anEntry );
1193 removeObjPart += helper + "))" + nt + "if SO: aStudyBuilder.RemoveObjectWithChildren(SO)";
1198 TCollection_AsciiString setNamePart;
1199 Resource_DataMapIteratorOfDataMapOfAsciiStringAsciiString mapEntriesIt;
1200 for ( mapEntriesIt.Initialize( mapEntries ); mapEntriesIt.More(); mapEntriesIt.Next() )
1202 anEntry = mapEntriesIt.Key();
1203 aName = mapEntriesIt.Value(); // python name
1204 if ( theNames.IsBound( anEntry ))
1206 aGUIName = theNames.Find(anEntry);
1207 setNamePart += nt + aSMESHGen + ".SetName(" + aName;
1208 if ( anEntry2AccessorMethod.IsBound( anEntry ) )
1209 setNamePart += helper + "." + anEntry2AccessorMethod( anEntry );
1210 setNamePart += helper + ", '" + aGUIName + "')";
1213 if ( !setNamePart.IsEmpty() )
1215 setNamePart.Insert( 1, nt + "## Set names of Mesh objects" );
1218 // Store visual properties of displayed objects
1220 TCollection_AsciiString visualPropertiesPart;
1223 //Output the script that sets up the visual parameters.
1224 CORBA::String_var compDataType = ComponentDataType();
1225 CORBA::String_var script = theStudy->GetDefaultScript( compDataType.in(), tab.ToCString() );
1226 if ( script.in() && script.in()[0] ) {
1227 visualPropertiesPart += nt + "### Store presentation parameters of displayed objects\n";
1228 visualPropertiesPart += script.in();
1232 anUpdatedScript += removeObjPart + '\n' + setNamePart + '\n' + visualPropertiesPart;
1235 anUpdatedScript += "\n\tpass";
1236 anUpdatedScript += "\n";
1238 // no need now as we use 'tab' and 'nt' variables depending on isMultiFile
1239 // if( !isMultiFile ) // remove unnecessary tabulation
1240 // RemoveTabulation( anUpdatedScript );
1242 // -----------------------------------------------------------------
1243 // put string literals describing patterns into separate functions
1244 // -----------------------------------------------------------------
1246 TCollection_AsciiString aLongString, aFunctionType;
1248 set< string > functionNameSet;
1249 while ( SMESH::TPythonDump::CutoutLongString( anUpdatedScript, where, aLongString, aFunctionType ))
1251 // make a python string literal
1252 aLongString.Prepend(":\n\treturn '''\n");
1253 aLongString += "\n\t'''\n\tpass\n";
1255 TCollection_AsciiString functionName;
1257 // check if the function returning this literal is already defined
1258 int posAlready = anUpdatedScript.Location( aLongString, where, anUpdatedScript.Length() );
1259 if ( posAlready ) // already defined
1261 // find the function name
1262 int functBeg = posAlready;
1263 char* script = (char*) anUpdatedScript.ToCString() + posAlready - 1; // look at ":" after "def fuction()"
1264 while ( *script != ' ' ) {
1268 functBeg++; // do not take ' '
1269 posAlready--; // do not take ':'
1270 functionName = anUpdatedScript.SubString( functBeg, posAlready );
1272 else // not defined yet
1274 // find a unique function name
1275 fixPythonName( aFunctionType );
1276 Standard_Integer nb = 0;
1277 do functionName = aFunctionType + "_" + ( nb++ ) + "()";
1278 while ( !functionNameSet.insert( functionName.ToCString() ).second );
1281 TCollection_AsciiString funDef = helper + "def " + functionName + aLongString;
1284 anUpdatedScript += helper + "\n\n" + funDef;
1289 anUpdatedScript.Insert( 1, funDef);
1290 where += funDef.Length();
1293 anUpdatedScript.InsertBefore( where, functionName ); // call function
1296 aValidScript = true;
1298 return anUpdatedScript;
1300 SMESH_CATCH( SMESH::printException );
1302 aValidScript = false;
1306 //=============================================================================
1310 //=============================================================================
1311 TCollection_AsciiString SMESH_Gen_i::GetNewPythonLines (int theStudyID)
1313 TCollection_AsciiString aScript;
1315 // Dump trace of API methods calls
1316 if (myPythonScripts.find(theStudyID) != myPythonScripts.end()) {
1317 Handle(TColStd_HSequenceOfAsciiString) aPythonScript = myPythonScripts[theStudyID];
1318 Standard_Integer istr, aLen = aPythonScript->Length();
1319 for (istr = 1; istr <= aLen; istr++) {
1321 aScript += aPythonScript->Value(istr);
1329 //=============================================================================
1333 //=============================================================================
1334 void SMESH_Gen_i::CleanPythonTrace (int theStudyID)
1336 TCollection_AsciiString aScript;
1338 // Clean trace of API methods calls
1339 if (myPythonScripts.find(theStudyID) != myPythonScripts.end()) {
1340 myPythonScripts[theStudyID]->Clear();