1 // Copyright (C) 2007-2015 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, or (at your option) any later version.
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_BelongToMeshGroup: myStream<< "aBelongToMeshGroup"; break;
427 case FT_BelongToGeom: myStream<< "aBelongToGeom"; break;
428 case FT_BelongToPlane: myStream<< "aBelongToPlane"; break;
429 case FT_BelongToCylinder: myStream<< "aBelongToCylinder"; break;
430 case FT_BelongToGenSurface: myStream<< "aBelongToGenSurface"; break;
431 case FT_LyingOnGeom: myStream<< "aLyingOnGeom"; break;
432 case FT_RangeOfIds: myStream<< "aRangeOfIds"; break;
433 case FT_BadOrientedVolume: myStream<< "aBadOrientedVolume"; break;
434 case FT_BareBorderVolume: myStream<< "aBareBorderVolume"; break;
435 case FT_BareBorderFace: myStream<< "aBareBorderFace"; break;
436 case FT_OverConstrainedVolume: myStream<< "aOverConstrainedVolume"; break;
437 case FT_OverConstrainedFace: myStream<< "aOverConstrainedFace"; break;
438 case FT_LinearOrQuadratic: myStream<< "aLinearOrQuadratic"; break;
439 case FT_GroupColor: myStream<< "aGroupColor"; break;
440 case FT_ElemGeomType: myStream<< "aElemGeomType"; break;
441 case FT_EntityType: myStream<< "aEntityType"; break;
442 case FT_CoplanarFaces: myStream<< "aCoplanarFaces"; break;
443 case FT_BallDiameter: myStream<< "aBallDiameter"; break;
444 case FT_ConnectedElements: myStream<< "aConnectedElements"; break;
445 case FT_LessThan: myStream<< "aLessThan"; break;
446 case FT_MoreThan: myStream<< "aMoreThan"; break;
447 case FT_EqualTo: myStream<< "aEqualTo"; break;
448 case FT_LogicalNOT: myStream<< "aLogicalNOT"; break;
449 case FT_LogicalAND: myStream<< "aLogicalAND"; break;
450 case FT_LogicalOR: myStream<< "aLogicalOR"; break;
452 default: myStream<< "anUndefined"; break;
461 operator<<(SMESH::Measurements_i* theArg)
463 myStream<<"aMeasurements";
468 TPythonDump& TPythonDump:: operator<<(SMESH_Gen_i* theArg)
470 myStream << SMESHGenName(); return *this;
473 TPythonDump& TPythonDump::operator<<(SMESH_MeshEditor_i* theArg)
475 myStream << MeshEditorName() << "_" << ( theArg ? theArg->GetMeshId() : -1 ); return *this;
478 TPythonDump& TPythonDump::operator<<(const TCollection_AsciiString & theStr)
480 myStream << theStr; return *this;
484 TPythonDump& TPythonDump::operator<<(SMESH::MED_VERSION theVersion)
486 switch (theVersion) {
487 case SMESH::MED_V2_1: myStream << "SMESH.MED_V2_1"; break;
488 case SMESH::MED_V2_2: myStream << "SMESH.MED_V2_2"; break;
489 default: myStream << theVersion;
494 TPythonDump& TPythonDump::operator<<(const SMESH::AxisStruct & theAxis)
496 *this << "SMESH.AxisStruct( "
497 << TVar( theAxis.x ) << ", "
498 << TVar( theAxis.y ) << ", "
499 << TVar( theAxis.z ) << ", "
500 << TVar( theAxis.vx ) << ", "
501 << TVar( theAxis.vy ) << ", "
502 << TVar( theAxis.vz ) << " )";
506 TPythonDump& TPythonDump::operator<<(const SMESH::DirStruct & theDir)
508 const SMESH::PointStruct & P = theDir.PS;
509 *this << "SMESH.DirStruct( SMESH.PointStruct ( "
510 << TVar( P.x ) << ", "
511 << TVar( P.y ) << ", "
512 << TVar( P.z ) << " ))";
516 TPythonDump& TPythonDump::operator<<(const SMESH::PointStruct & P)
518 *this << "SMESH.PointStruct ( "
519 << TVar( P.x ) << ", "
520 << TVar( P.y ) << ", "
521 << TVar( P.z ) << " )";
525 TPythonDump& TPythonDump::operator<<(const SMESH::ListOfGroups& theList)
527 DumpArray( theList, *this );
530 TPythonDump& TPythonDump::operator<<(const SMESH::ListOfGroups * theList)
532 DumpArray( *theList, *this );
535 TPythonDump& TPythonDump::operator<<(const GEOM::ListOfGO& theList)
537 DumpArray( theList, *this );
540 TPythonDump& TPythonDump::operator<<(const GEOM::ListOfGBO& theList)
542 DumpArray( theList, *this );
545 TPythonDump& TPythonDump::operator<<(const SMESH::ListOfIDSources& theList)
547 DumpArray( theList, *this );
550 TPythonDump& TPythonDump::operator<<(const SMESH::CoincidentFreeBorders& theCFB)
552 // dump CoincidentFreeBorders as a list of lists, each enclosed list
553 // contains node IDs of a group of coincident free borders where
554 // each consequent triple of IDs describe a free border: (n1, n2, nLast)
555 // For example [[1, 2, 10, 20, 21, 40], [11, 12, 15, 55, 54, 41]] describes
556 // two groups of coincident free borders, each group including two borders
559 for ( CORBA::ULong i = 0; i < theCFB.coincidentGroups.length(); ++i )
561 const SMESH::FreeBordersGroup& aGRP = theCFB.coincidentGroups[ i ];
562 if ( i ) myStream << ",";
564 for ( CORBA::ULong iP = 0; iP < aGRP.length(); ++iP )
566 const SMESH::FreeBorderPart& aPART = aGRP[ iP ];
567 if ( 0 <= aPART.border && aPART.border < theCFB.borders.length() )
569 if ( iP ) myStream << ", ";
570 const SMESH::FreeBorder& aBRD = theCFB.borders[ aPART.border ];
571 myStream << aBRD.nodeIDs[ aPART.node1 ] << ",";
572 myStream << aBRD.nodeIDs[ aPART.node2 ] << ",";
573 myStream << aBRD.nodeIDs[ aPART.nodeLast ];
583 const char* TPythonDump::NotPublishedObjectName()
585 return theNotPublishedObjectName;
588 TCollection_AsciiString myLongStringStart( "TPythonDump::LongStringStart" );
589 TCollection_AsciiString myLongStringEnd ( "TPythonDump::LongStringEnd" );
591 //================================================================================
593 * \brief Return marker of long string literal beginning
594 * \param type - a name of functionality producing the string literal
595 * \retval TCollection_AsciiString - the marker string to be written into
596 * a raw python script
598 //================================================================================
600 TCollection_AsciiString TPythonDump::LongStringStart(const char* type)
604 (Standard_Integer) strlen(type) +
609 //================================================================================
611 * \brief Return marker of long string literal end
612 * \retval TCollection_AsciiString - the marker string to be written into
613 * a raw python script
615 //================================================================================
617 TCollection_AsciiString TPythonDump::LongStringEnd()
619 return myLongStringEnd;
622 //================================================================================
624 * \brief Cut out a long string literal from a string
625 * \param theText - text possibly containing string literals
626 * \param theFrom - position in the text to search from
627 * \param theLongString - the retrieved literal
628 * \param theStringType - a name of functionality produced the literal
629 * \retval bool - true if a string literal found
631 * The literal is removed from theText; theFrom points position right after
632 * the removed literal
634 //================================================================================
636 bool TPythonDump::CutoutLongString( TCollection_AsciiString & theText,
638 TCollection_AsciiString & theLongString,
639 TCollection_AsciiString & theStringType)
641 if ( theFrom < 1 || theFrom > theText.Length() )
644 // ...script \ beg marker \ \ type \ literal \ end marker \ script...
645 // "theText myLongStringStart7 Pattern!!! SALOME Mesh Pattern file myLongStringEndtextEnd"
646 // 012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789
649 theFrom = theText.Location( myLongStringStart, theFrom, theText.Length() ); // = 09
653 // find where literal begins
654 int literalBeg = theFrom + myLongStringStart.Length(); // = 26
655 char* typeLenStr = (char*) theText.ToCString() + literalBeg - 1; // = "7 Pattern!!! SALO...."
656 int typeLen = atoi ( typeLenStr ); // = 7
657 while ( *typeLenStr != ' ' ) { // look for ' ' after typeLen
658 literalBeg++; // 26 -> 27
661 literalBeg += typeLen + 1; // = 35
662 if ( literalBeg > theText.Length() )
665 // where literal ends (i.e. end marker begins)
666 int literalEnd = theText.Location( myLongStringEnd, literalBeg, theText.Length() ); // = 64
668 literalEnd = theText.Length();
671 theLongString = theText.SubString( literalBeg, literalEnd - 1); // "!!! SALOME Mesh Pattern file "
673 theStringType = theText.SubString( literalBeg - typeLen, literalBeg - 1 ); // "Pattern"
675 literalEnd += myLongStringEnd.Length(); // = 79
676 TCollection_AsciiString textEnd = theText.SubString( literalEnd, theText.Length() ); // "textE..."
677 theText = theText.SubString( 1, theFrom - 1 ) + textEnd;
682 void printException( const char* text )
685 cout << "Exception in SMESH_Gen_i::DumpPython(): " << text << endl;
690 //=======================================================================
691 //function : RemoveTabulation
693 //=======================================================================
694 void RemoveTabulation( TCollection_AsciiString& theScript )
696 std::string aString( theScript.ToCString() );
697 std::string::size_type aPos = 0;
698 while( aPos < aString.length() )
700 aPos = aString.find( "\n\t", aPos );
701 if( aPos == std::string::npos )
703 aString.replace( aPos, 2, "\n" );
706 theScript = aString.c_str();
709 //=======================================================================
710 //function : DumpPython
712 //=======================================================================
713 Engines::TMPFile* SMESH_Gen_i::DumpPython (CORBA::Object_ptr theStudy,
714 CORBA::Boolean isPublished,
715 CORBA::Boolean isMultiFile,
716 CORBA::Boolean& isValidScript)
718 SALOMEDS::Study_var aStudy = SALOMEDS::Study::_narrow(theStudy);
719 if (CORBA::is_nil(aStudy))
720 return new Engines::TMPFile(0);
722 CORBA::String_var compDataType = ComponentDataType();
723 SALOMEDS::SObject_wrap aSO = aStudy->FindComponent( compDataType.in() );
724 if (CORBA::is_nil(aSO))
725 return new Engines::TMPFile(0);
727 // Map study entries to object names
728 Resource_DataMapOfAsciiStringAsciiString aMap;
729 Resource_DataMapOfAsciiStringAsciiString aMapNames;
731 SALOMEDS::ChildIterator_wrap Itr = aStudy->NewChildIterator(aSO);
732 for (Itr->InitEx(true); Itr->More(); Itr->Next()) {
733 SALOMEDS::SObject_wrap aValue = Itr->Value();
734 CORBA::String_var anID = aValue->GetID();
735 CORBA::String_var aName = aValue->GetName();
736 TCollection_AsciiString aGUIName ( (char*) aName.in() );
737 TCollection_AsciiString anEntry ( (char*) anID.in() );
738 if (aGUIName.Length() > 0) {
739 aMapNames.Bind( anEntry, aGUIName );
740 aMap.Bind( anEntry, aGUIName );
744 // Get trace of restored study
745 SALOMEDS::StudyBuilder_var aStudyBuilder = aStudy->NewBuilder();
746 SALOMEDS::GenericAttribute_wrap anAttr =
747 aStudyBuilder->FindOrCreateAttribute(aSO, "AttributePythonObject");
749 SALOMEDS::AttributePythonObject_var pyAttr =
750 SALOMEDS::AttributePythonObject::_narrow(anAttr);
751 CORBA::String_var oldValue = pyAttr->GetObject();
752 TCollection_AsciiString aSavedTrace (oldValue.in());
754 // Add trace of API methods calls and replace study entries by names
755 TCollection_AsciiString aScript;
756 aScript += DumpPython_impl(aStudy, aMap, aMapNames, isPublished, isMultiFile,
757 myIsHistoricalPythonDump, isValidScript, aSavedTrace);
759 int aLen = aScript.Length();
760 unsigned char* aBuffer = new unsigned char[aLen+1];
761 strcpy((char*)aBuffer, aScript.ToCString());
763 CORBA::Octet* anOctetBuf = (CORBA::Octet*)aBuffer;
764 Engines::TMPFile_var aStreamFile = new Engines::TMPFile(aLen+1, aLen+1, anOctetBuf, 1);
766 bool hasNotPublishedObjects = aScript.Location( SMESH::theNotPublishedObjectName, 1, aLen);
767 isValidScript = isValidScript && !hasNotPublishedObjects;
769 return aStreamFile._retn();
772 //=============================================================================
776 //=============================================================================
777 void SMESH_Gen_i::AddToPythonScript (int theStudyID, const TCollection_AsciiString& theString)
779 if (myPythonScripts.find(theStudyID) == myPythonScripts.end()) {
780 myPythonScripts[theStudyID] = new TColStd_HSequenceOfAsciiString;
782 myPythonScripts[theStudyID]->Append(theString);
785 //=============================================================================
787 * RemoveLastFromPythonScript
789 //=============================================================================
790 void SMESH_Gen_i::RemoveLastFromPythonScript (int theStudyID)
792 if (myPythonScripts.find(theStudyID) != myPythonScripts.end()) {
793 int aLen = myPythonScripts[theStudyID]->Length();
794 myPythonScripts[theStudyID]->Remove(aLen);
798 //=======================================================================
799 //function : SavePython
801 //=======================================================================
802 void SMESH_Gen_i::SavePython (SALOMEDS::Study_ptr theStudy)
804 // Dump trace of API methods calls
805 TCollection_AsciiString aScript = GetNewPythonLines(theStudy->StudyId());
807 // Check contents of PythonObject attribute
808 CORBA::String_var compDataType = ComponentDataType();
809 SALOMEDS::SObject_wrap aSO = theStudy->FindComponent( compDataType.in() );
810 SALOMEDS::StudyBuilder_var aStudyBuilder = theStudy->NewBuilder();
811 SALOMEDS::GenericAttribute_wrap anAttr =
812 aStudyBuilder->FindOrCreateAttribute(aSO, "AttributePythonObject");
814 SALOMEDS::AttributePythonObject_var pyAttr =
815 SALOMEDS::AttributePythonObject::_narrow(anAttr);
816 CORBA::String_var oldValue = pyAttr->GetObject();
817 TCollection_AsciiString oldScript (oldValue.in());
819 if (oldScript.Length() > 0) {
821 oldScript += aScript;
826 // Store in PythonObject attribute
827 pyAttr->SetObject(oldScript.ToCString(), 1);
829 // Clean trace of API methods calls
830 CleanPythonTrace(theStudy->StudyId());
837 //=============================================================================
839 * FindEntries: Returns a sequence of start/end positions of entries in the string
841 //=============================================================================
842 Handle(TColStd_HSequenceOfInteger) FindEntries (TCollection_AsciiString& theString)
844 Handle(TColStd_HSequenceOfInteger) aSeq = new TColStd_HSequenceOfInteger;
845 Standard_Integer aLen = theString.Length();
846 Standard_Boolean isFound = Standard_False;
848 char* arr = (char*) theString.ToCString();
849 Standard_Integer i = 0, j;
854 if ( isdigit( c )) { //Is digit?
856 isFound = Standard_False;
857 while((j < aLen) && ( isdigit(c) || c == ':' )) { //Check if it is an entry
859 if(c == ':') isFound = Standard_True;
863 int prev = (i < 1) ? 0 : (int)arr[i - 1];
864 // to distinguish from a sketcher command:
865 // last char should be a digit, not ":",
866 // previous char should not be '"'.
867 if (arr[j-2] != ':' && prev != '"') {
868 aSeq->Append(i+1); // +1 because AsciiString starts from 1
882 //================================================================================
884 * \brief Make a string be a valid python name
885 * \param aName - a string to fix
886 * \retval bool - true if aName was not modified
888 //================================================================================
890 bool fixPythonName(TCollection_AsciiString & aName)
892 bool isValidName = true;
893 int nbUnderscore = 0;
895 // replace not allowed chars by underscore
896 const char* name = aName.ToCString();
897 for ( p = 0; name[p]; ++p ) {
898 if ( !isalnum( name[p] ) && name[p] != '_' )
900 if ( p == 0 || p+1 == aName.Length() || name[p-1] == '_')
902 aName.Remove( p+1, 1 ); // remove __ and _ from the start and the end
904 name = aName.ToCString();
908 aName.SetValue( p+1, '_');
914 // aName must not start with a digit
915 if ( aName.IsIntegerValue() ) {
916 aName.Insert( 1, 'a' );
919 // shorten names like CartesianParameters3D_400_400_400_1000000_1
920 const int nbAllowedUnderscore = 3; /* changed from 2 to 3 by an user request
921 posted to SALOME Forum */
922 if ( aName.Length() > 20 && nbUnderscore > nbAllowedUnderscore )
924 p = aName.Location( "_", 20, aName.Length());
931 //================================================================================
933 * \brief Return Python module names of available plug-ins.
935 //================================================================================
937 std::vector<std::string> getPluginNames()
939 std::vector<std::string> pluginNames;
940 std::vector< std::string > xmlPaths = SMESH_Gen::GetPluginXMLPaths();
941 LDOMParser xmlParser;
942 for ( size_t i = 0; i < xmlPaths.size(); ++i )
944 bool error = xmlParser.parse( xmlPaths[i].c_str() );
947 TCollection_AsciiString data;
948 INFOS( xmlParser.GetError(data) );
951 // <meshers-group name="Standard Meshers"
952 // resources="StdMeshers"
953 // idl-module="StdMeshers"
954 // server-lib="StdMeshersEngine"
955 // gui-lib="StdMeshersGUI">
956 LDOM_Document xmlDoc = xmlParser.getDocument();
957 LDOM_NodeList nodeList = xmlDoc.getElementsByTagName( "meshers-group" );
958 for ( int i = 0; i < nodeList.getLength(); ++i )
960 LDOM_Node node = nodeList.item( i );
961 LDOM_Element& elem = (LDOM_Element&) node;
962 LDOMString idlModule = elem.getAttribute( "idl-module" );
963 if ( strlen( idlModule.GetString() ) > 0 )
964 pluginNames.push_back( idlModule.GetString() );
971 //================================================================================
973 * \brief Createa a Dump Python script
974 * \param [in] theStudy - the study to dump
975 * \param [in,out] theObjectNames - map of an entry to a study and python name
976 * \param [in] theNames - - map of an entry to a study name
977 * \param [in] isPublished - \c true if dump of object publication in study is needed
978 * \param [in] isMultiFile - \c true if dump of each module goes to a separate file
979 * \param [in] isHistoricalDump - \c true if removed object should be dumped
980 * \param [out] aValidScript - returns \c true if the returned script seems valid
981 * \param [in,out] theSavedTrace - the dump stored in the study. It's cleared to
982 * decrease memory usage.
983 * \return TCollection_AsciiString - the result dump script.
985 //================================================================================
987 TCollection_AsciiString SMESH_Gen_i::DumpPython_impl
988 (SALOMEDS::Study_ptr theStudy,
989 Resource_DataMapOfAsciiStringAsciiString& theObjectNames,
990 Resource_DataMapOfAsciiStringAsciiString& theNames,
993 bool isHistoricalDump,
995 TCollection_AsciiString& theSavedTrace)
998 const int aStudyID = theStudy->StudyId();
1000 const TCollection_AsciiString aSmeshpy ( SMESH_2smeshpy::SmeshpyName() );
1001 const TCollection_AsciiString aSMESHGen( SMESH_2smeshpy::GenName() );
1002 const TCollection_AsciiString anOldGen ( SMESH::TPythonDump::SMESHGenName() );
1003 const TCollection_AsciiString helper; // to comfortably append C strings to TCollection_AsciiString
1004 const TCollection_AsciiString tab( isMultiFile ? "\t" : "" ), nt = helper + "\n" + tab;
1006 std::list< TCollection_AsciiString > lines; // lines of a script
1007 std::list< TCollection_AsciiString >::iterator linesIt;
1010 lines.push_back( aSMESHGen + " = smeshBuilder.New(theStudy)" );
1012 lines.push_back( aSMESHGen + " = smeshBuilder.New(None)" );
1013 lines.push_back( helper + "aFilterManager = " + aSMESHGen + ".CreateFilterManager()" );
1014 lines.push_back( helper + "aMeasurements = " + aSMESHGen + ".CreateMeasurements()" );
1016 // Treat dump trace of restored study
1017 if (theSavedTrace.Length() > 0)
1019 linesIt = --lines.end();
1020 // Split theSavedTrace into lines
1021 int from = 1, end = theSavedTrace.Length(), to;
1022 while ( from < end && ( to = theSavedTrace.Location( "\n", from, end )))
1024 if ( theSavedTrace.ToCString()[from-1] == '\t' )
1027 lines.push_back( theSavedTrace.SubString( from, to - 1 ));
1030 // For the convertion of IDL API calls -> smeshBuilder.py API, "smesh" standing for SMESH_Gen
1031 // was replaces with "smeshgen" (==TPythonDump::SMESHGenName()).
1032 // Change "smesh" -> "smeshgen" in the trace saved before passage to smeshBuilder.py API
1034 theSavedTrace.Location( anOldGen + ".", 1, theSavedTrace.Length() );
1035 theSavedTrace.Clear();
1036 if ( !isNewVersion )
1038 const TCollection_AsciiString aSmeshCall ( "smesh." ), gen( "gen" );
1040 for ( ++linesIt; linesIt != lines.end(); ++linesIt )
1042 TCollection_AsciiString& aSavedLine = *linesIt;
1043 end = aSavedLine.Length(), from = 1;
1044 while ( from < end && ( beg = aSavedLine.Location( aSmeshCall, from, end )))
1046 char charBefore = ( beg == 1 ) ? ' ' : aSavedLine.Value( beg - 1 );
1047 if ( isspace( charBefore ) || charBefore == '=' ) { // "smesh." is not a part of a long word
1048 aSavedLine.Insert( beg + aSmeshCall.Length() - 1, gen );// "smesh" -> "smeshgen"
1049 end += gen.Length();
1051 from = beg + aSmeshCall.Length();
1057 // Add new dump trace of API methods calls to script lines
1058 if (myPythonScripts.find( aStudyID ) != myPythonScripts.end())
1060 Handle(TColStd_HSequenceOfAsciiString) aPythonScript = myPythonScripts[ aStudyID ];
1061 Standard_Integer istr, aLen = aPythonScript->Length();
1062 for (istr = 1; istr <= aLen; istr++)
1063 lines.push_back( aPythonScript->Value( istr ));
1066 // Convert IDL API calls into smeshBuilder.py API.
1067 // Some objects are wrapped with python classes and
1068 // Resource_DataMapOfAsciiStringAsciiString holds methods returning wrapped objects
1069 Resource_DataMapOfAsciiStringAsciiString anEntry2AccessorMethod;
1070 std::set< TCollection_AsciiString > aRemovedObjIDs;
1071 if ( !getenv("NO_2smeshpy_conversion"))
1072 SMESH_2smeshpy::ConvertScript( lines, anEntry2AccessorMethod,
1073 theObjectNames, aRemovedObjIDs,
1074 theStudy, isHistoricalDump );
1076 bool importGeom = false;
1077 GEOM::GEOM_Gen_ptr geom = GetGeomEngine();
1079 // Add names of GEOM objects to theObjectNames to exclude same names of SMESH objects
1080 GEOM::string_array_var aGeomNames = geom->GetAllDumpNames();
1081 int ign = 0, nbgn = aGeomNames->length();
1082 for (; ign < nbgn; ign++) {
1083 TCollection_AsciiString aName = aGeomNames[ign].in();
1084 theObjectNames.Bind(aName, "1");
1088 TCollection_AsciiString anUpdatedScript;
1090 Resource_DataMapOfAsciiStringAsciiString mapRemoved;
1091 Resource_DataMapOfAsciiStringAsciiString mapEntries; // names and entries present in anUpdatedScript
1092 Standard_Integer objectCounter = 0;
1093 TCollection_AsciiString anEntry, aName, aGUIName, aBaseName("smeshObj_");
1095 // Treat every script line and add it to anUpdatedScript
1096 for ( linesIt = lines.begin(); linesIt != lines.end(); ++linesIt )
1098 TCollection_AsciiString& aLine = *linesIt;
1099 anUpdatedScript += tab;
1101 //Replace characters used instead of quote marks to quote notebook variables
1103 while (( pos = aLine.Location( 1, SMESH::TVar::Quote(), pos, aLine.Length() )))
1104 aLine.SetValue( pos, '"' );
1106 // Find entries to be replaced by names
1107 Handle(TColStd_HSequenceOfInteger) aSeq = FindEntries(aLine);
1108 const Standard_Integer aSeqLen = aSeq->Length();
1109 Standard_Integer aStart = 1;
1110 for (Standard_Integer i = 1; i <= aSeqLen; i += 2)
1112 if ( aStart < aSeq->Value(i) )
1113 anUpdatedScript += aLine.SubString( aStart, aSeq->Value(i) - 1 ); // line part before i-th entry
1114 anEntry = aLine.SubString( aSeq->Value(i), aSeq->Value(i + 1) );
1115 // is a GEOM object?
1116 CORBA::String_var geomName = geom->GetDumpName( anEntry.ToCString() );
1117 if ( !geomName.in() || !geomName.in()[0] ) {
1118 // is a SMESH object
1119 if ( theObjectNames.IsBound( anEntry )) {
1120 // The Object is in Study
1121 aName = theObjectNames.Find( anEntry );
1122 // check validity of aName
1123 bool isValidName = fixPythonName( aName );
1124 if (theObjectNames.IsBound(aName) && anEntry != theObjectNames(aName)) {
1125 // diff objects have same name - make a new name by appending a digit
1126 TCollection_AsciiString aName2;
1127 Standard_Integer i = 0;
1129 aName2 = aName + "_" + ++i;
1130 } while (theObjectNames.IsBound(aName2) && anEntry != theObjectNames(aName2));
1132 isValidName = false;
1135 theObjectNames(anEntry) = aName;
1137 if ( aLine.Value(1) != '#' )
1138 mapEntries.Bind(anEntry, aName);
1144 aName = aBaseName + (++objectCounter);
1145 } while (theObjectNames.IsBound(aName));
1147 if ( !aRemovedObjIDs.count( anEntry ) && aLine.Value(1) != '#')
1148 mapRemoved.Bind(anEntry, aName);
1150 theObjectNames.Bind(anEntry, aName);
1152 theObjectNames.Bind(aName, anEntry); // to detect same name of diff objects
1156 aName = geomName.in();
1159 anUpdatedScript += aName;
1160 aStart = aSeq->Value(i + 1) + 1;
1162 } // loop on entries within aLine
1165 anUpdatedScript += aLine;
1166 else if ( aSeq->Value( aSeqLen ) < aLine.Length() )
1167 anUpdatedScript += aLine.SubString( aSeq->Value(aSeqLen) + 1, aLine.Length() );
1169 anUpdatedScript += '\n';
1172 // Make an initial part of aSript
1174 TCollection_AsciiString initPart = "import ";
1176 initPart += "salome, ";
1177 initPart += " SMESH, SALOMEDS\n";
1178 initPart += "from salome.smesh import smeshBuilder\n";
1179 if ( importGeom && isMultiFile )
1181 initPart += ("\n## import GEOM dump file ## \n"
1182 "import string, os, sys, re\n"
1183 "sys.path.insert( 0, os.path.dirname(__file__) )\n"
1184 "exec(\"from \"+re.sub(\"SMESH$\",\"GEOM\",__name__)+\" import *\")\n");
1186 // import python files corresponding to plugins if they are used in anUpdatedScript
1188 TCollection_AsciiString importStr;
1189 std::vector<std::string> pluginNames = getPluginNames();
1190 for ( size_t i = 0; i < pluginNames.size(); ++i )
1192 // Convert access to plugin members:
1193 // e.g. StdMeshers.QUAD_REDUCED -> StdMeshersBuilder.QUAD_REDUCED
1194 TCollection_AsciiString pluginAccess = (pluginNames[i] + ".").c_str() ;
1195 int iFrom = 1, iPos;
1196 while (( iPos = anUpdatedScript.Location( pluginAccess, iFrom, anUpdatedScript.Length() )))
1198 anUpdatedScript.Insert( iPos + pluginNames[i].size(), "Builder" );
1199 iFrom = iPos + pluginNames[i].size() + 8;
1201 // if any plugin member is used, import the plugin
1203 importStr += ( helper + "\n" "from salome." + pluginNames[i].c_str() +
1204 " import " + pluginNames[i].c_str() +"Builder" );
1206 if ( !importStr.IsEmpty() )
1207 initPart += importStr + "\n";
1211 initPart += "def RebuildData(theStudy):";
1214 anUpdatedScript.Prepend( initPart );
1216 // Make a final part of aScript
1218 // Dump object removal
1219 TCollection_AsciiString removeObjPart;
1220 if ( !mapRemoved.IsEmpty() ) {
1221 removeObjPart += nt + "## some objects were removed";
1222 removeObjPart += nt + "aStudyBuilder = theStudy.NewBuilder()";
1223 Resource_DataMapIteratorOfDataMapOfAsciiStringAsciiString mapRemovedIt;
1224 for ( mapRemovedIt.Initialize( mapRemoved ); mapRemovedIt.More(); mapRemovedIt.Next() ) {
1225 aName = mapRemovedIt.Value(); // python name
1226 anEntry = mapRemovedIt.Key();
1227 removeObjPart += nt + "SO = theStudy.FindObjectIOR(theStudy.ConvertObjectToIOR(";
1228 removeObjPart += aName;
1229 // for object wrapped by class of smeshBuilder.py
1230 if ( anEntry2AccessorMethod.IsBound( anEntry ) )
1231 removeObjPart += helper + "." + anEntry2AccessorMethod( anEntry );
1232 removeObjPart += helper + "))" + nt + "if SO: aStudyBuilder.RemoveObjectWithChildren(SO)";
1237 TCollection_AsciiString setNamePart;
1238 Resource_DataMapIteratorOfDataMapOfAsciiStringAsciiString mapEntriesIt;
1239 for ( mapEntriesIt.Initialize( mapEntries ); mapEntriesIt.More(); mapEntriesIt.Next() )
1241 anEntry = mapEntriesIt.Key();
1242 aName = mapEntriesIt.Value(); // python name
1243 if ( theNames.IsBound( anEntry ))
1245 aGUIName = theNames.Find(anEntry);
1246 aGUIName.RemoveAll('\''); // remove a quote from a name (issue 22360)
1247 setNamePart += nt + aSMESHGen + ".SetName(" + aName;
1248 if ( anEntry2AccessorMethod.IsBound( anEntry ) )
1249 setNamePart += helper + "." + anEntry2AccessorMethod( anEntry );
1250 setNamePart += helper + ", '" + aGUIName + "')";
1253 if ( !setNamePart.IsEmpty() )
1255 setNamePart.Insert( 1, nt + "## Set names of Mesh objects" );
1258 // Store visual properties of displayed objects
1260 TCollection_AsciiString visualPropertiesPart;
1263 //Output the script that sets up the visual parameters.
1264 CORBA::String_var compDataType = ComponentDataType();
1265 CORBA::String_var script = theStudy->GetDefaultScript( compDataType.in(), tab.ToCString() );
1266 if ( script.in() && script.in()[0] ) {
1267 visualPropertiesPart += nt + "### Store presentation parameters of displayed objects\n";
1268 visualPropertiesPart += script.in();
1272 anUpdatedScript += removeObjPart + '\n' + setNamePart + '\n' + visualPropertiesPart;
1275 anUpdatedScript += "\n\tpass";
1276 anUpdatedScript += "\n";
1278 // no need now as we use 'tab' and 'nt' variables depending on isMultiFile
1279 // if( !isMultiFile ) // remove unnecessary tabulation
1280 // RemoveTabulation( anUpdatedScript );
1282 // -----------------------------------------------------------------
1283 // put string literals describing patterns into separate functions
1284 // -----------------------------------------------------------------
1286 TCollection_AsciiString aLongString, aFunctionType;
1288 set< string > functionNameSet;
1289 while ( SMESH::TPythonDump::CutoutLongString( anUpdatedScript, where, aLongString, aFunctionType ))
1291 // make a python string literal
1292 aLongString.Prepend(":\n\treturn '''\n");
1293 aLongString += "\n\t'''\n\tpass\n";
1295 TCollection_AsciiString functionName;
1297 // check if the function returning this literal is already defined
1298 int posAlready = anUpdatedScript.Location( aLongString, where, anUpdatedScript.Length() );
1299 if ( posAlready ) // already defined
1301 // find the function name
1302 int functBeg = posAlready;
1303 char* script = (char*) anUpdatedScript.ToCString() + posAlready - 1; // look at ":" after "def fuction()"
1304 while ( *script != ' ' ) {
1308 functBeg++; // do not take ' '
1309 posAlready--; // do not take ':'
1310 functionName = anUpdatedScript.SubString( functBeg, posAlready );
1312 else // not defined yet
1314 // find a unique function name
1315 fixPythonName( aFunctionType );
1316 Standard_Integer nb = 0;
1317 do functionName = aFunctionType + "_" + ( nb++ ) + "()";
1318 while ( !functionNameSet.insert( functionName.ToCString() ).second );
1321 TCollection_AsciiString funDef = helper + "def " + functionName + aLongString;
1324 anUpdatedScript += helper + "\n\n" + funDef;
1329 anUpdatedScript.Insert( 1, funDef);
1330 where += funDef.Length();
1333 anUpdatedScript.InsertBefore( where, functionName ); // call function
1336 aValidScript = true;
1338 return anUpdatedScript;
1340 SMESH_CATCH( SMESH::printException );
1342 aValidScript = false;
1346 //=============================================================================
1350 //=============================================================================
1351 TCollection_AsciiString SMESH_Gen_i::GetNewPythonLines (int theStudyID)
1353 TCollection_AsciiString aScript;
1355 // Dump trace of API methods calls
1356 if (myPythonScripts.find(theStudyID) != myPythonScripts.end()) {
1357 Handle(TColStd_HSequenceOfAsciiString) aPythonScript = myPythonScripts[theStudyID];
1358 Standard_Integer istr, aLen = aPythonScript->Length();
1359 for (istr = 1; istr <= aLen; istr++) {
1361 aScript += aPythonScript->Value(istr);
1369 //=============================================================================
1373 //=============================================================================
1374 void SMESH_Gen_i::CleanPythonTrace (int theStudyID)
1376 TCollection_AsciiString aScript;
1378 // Clean trace of API methods calls
1379 if (myPythonScripts.find(theStudyID) != myPythonScripts.end()) {
1380 myPythonScripts[theStudyID]->Clear();