Salome HOME
Enable simultaneous usage of several StdMeshersGUI_SubShapeSelectorWdg's
[modules/smesh.git] / src / SMESH_I / SMESH_PythonDump.cxx
1 // Copyright (C) 2007-2020  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, or (at your option) any later version.
10 //
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14 // Lesser General Public License for more details.
15 //
16 // You should have received a copy of the GNU Lesser General Public
17 // License along with this library; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
19 //
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 //
22 //  File    : SMESH_DumpPython.cxx
23 //  Created : Thu Mar 24 17:17:59 2005
24 //  Author  : Julia DOROVSKIKH
25 //  Module  : SMESH
26
27 #include "SMESH_PythonDump.hxx"
28
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"
34
35 #include <Basics_Utils.hxx>
36 #include <SALOMEDS_wrap.hxx>
37
38 #include <LDOMParser.hxx>
39 #include <Resource_DataMapIteratorOfDataMapOfAsciiStringAsciiString.hxx>
40 #include <TColStd_HSequenceOfInteger.hxx>
41 #include <TCollection_AsciiString.hxx>
42
43 #include <cstring>
44
45 #ifdef _DEBUG_
46 static int MYDEBUG = 0;
47 #else
48 static int MYDEBUG = 0;
49 #endif
50
51 #include "SMESH_TryCatch.hxx"
52
53 namespace SMESH
54 {
55
56   size_t TPythonDump::myCounter = 0;
57   const char theNotPublishedObjectName[] = "__NOT__Published__Object__";
58
59   TVar::TVar(CORBA::Double value):myVals(1), myIsList(false) { myVals[0] = SMESH_Comment(value); }
60   TVar::TVar(CORBA::Long   value):myVals(1), myIsList(false) { myVals[0] = SMESH_Comment(value); }
61   TVar::TVar(CORBA::Short  value):myVals(1), myIsList(false) { myVals[0] = SMESH_Comment(value); }
62   TVar::TVar(const SMESH::double_array& value):myVals(value.length()), myIsList(true)
63   {
64     for ( size_t i = 0; i < value.length(); i++)
65       myVals[i] = SMESH_Comment(value[i]);
66   }
67
68   TPythonDump::
69   TPythonDump():myVarsCounter(0)
70   {
71     ++myCounter;
72   }
73   TPythonDump::
74   ~TPythonDump()
75   {
76     if(--myCounter == 0){
77       SMESH_Gen_i* aSMESHGen = SMESH_Gen_i::GetSMESHGen();
78       std::string aString = myStream.str();
79       TCollection_AsciiString aCollection(Standard_CString(aString.c_str()));
80       if(!aCollection.IsEmpty())
81       {
82         const std::string & objEntry = aSMESHGen->GetLastObjEntry();
83         if ( !objEntry.empty() )
84           aCollection += (TVar::ObjPrefix() + objEntry ).c_str();
85         aSMESHGen->AddToPythonScript(aCollection);
86         if(MYDEBUG) MESSAGE(aString);
87         // prevent misuse of already treated variables
88         aSMESHGen->UpdateParameters(CORBA::Object_var().in(),"");
89       }
90     }
91   }
92
93   TPythonDump& //!< store a variable value. Write either a value or '$varID$'
94   TPythonDump::
95   operator<<(const TVar& theVarValue)
96   {
97     const std::vector< int >& varIDs = SMESH_Gen_i::GetSMESHGen()->GetLastParamIndices();
98     if ( theVarValue.myIsList )
99     {
100       myStream << "[ ";
101       for ( size_t i = 1; i <= theVarValue.myVals.size(); ++i )
102       {
103         if ( myVarsCounter < (int)varIDs.size() && varIDs[ myVarsCounter ] >= 0 )
104           myStream << TVar::Quote() << varIDs[ myVarsCounter ] << TVar::Quote();
105         else
106           myStream << theVarValue.myVals[i-1];
107         if ( i < theVarValue.myVals.size() )
108           myStream << ", ";
109         ++myVarsCounter;
110       }
111       myStream << " ]";
112     }
113     else
114     {
115       if ( myVarsCounter < (int)varIDs.size() && varIDs[ myVarsCounter ] >= 0 )
116         myStream << TVar::Quote() << varIDs[ myVarsCounter ] << TVar::Quote();
117       else
118         myStream << theVarValue.myVals[0];
119       ++myVarsCounter;
120     }
121     return *this;
122   }
123
124   TPythonDump&
125   TPythonDump::
126   operator<<(long int theArg){
127     myStream<<theArg;
128     return *this;
129   }
130
131   TPythonDump&
132   TPythonDump::
133   operator<<(int theArg){
134     myStream<<theArg;
135     return *this;
136   }
137
138   TPythonDump&
139   TPythonDump::
140   operator<<(double theArg){
141     myStream<<theArg;
142     return *this;
143   }
144
145   TPythonDump&
146   TPythonDump::
147   operator<<(float theArg){
148     myStream<<theArg;
149     return *this;
150   }
151
152   TPythonDump&
153   TPythonDump::
154   operator<<(const void* theArg){
155     myStream<<theArg;
156     return *this;
157   }
158
159   TPythonDump&
160   TPythonDump::
161   operator<<(const char* theArg){
162     if ( theArg )
163       myStream<<theArg;
164     return *this;
165   }
166
167   TPythonDump&
168   TPythonDump::
169   operator<<(const std::string& theArg){
170     myStream<<theArg;
171     return *this;
172   }
173
174   TPythonDump&
175   TPythonDump::
176   operator<<(const SMESH::ElementType& theArg)
177   {
178     myStream<<"SMESH.";
179     switch(theArg){
180     case ALL:    myStream<<"ALL";    break;
181     case NODE:   myStream<<"NODE";   break;
182     case EDGE:   myStream<<"EDGE";   break;
183     case FACE:   myStream<<"FACE";   break;
184     case VOLUME: myStream<<"VOLUME"; break;
185     case ELEM0D: myStream<<"ELEM0D"; break;
186     case BALL:   myStream<<"BALL";   break;
187     default:     myStream<<"__UNKNOWN__ElementType: " << theArg;
188     }
189     return *this;
190   }
191
192   TPythonDump&
193   TPythonDump::
194   operator<<(const SMESH::GeometryType& theArg)
195   {
196     myStream<<"SMESH.";
197     switch(theArg){
198     case Geom_POINT:      myStream<<"Geom_POINT";      break;
199     case Geom_EDGE:       myStream<<"Geom_EDGE";       break;
200     case Geom_TRIANGLE:   myStream<<"Geom_TRIANGLE";   break;
201     case Geom_QUADRANGLE: myStream<<"Geom_QUADRANGLE"; break;
202     case Geom_POLYGON:    myStream<<"Geom_POLYGON";    break;
203     case Geom_TETRA:      myStream<<"Geom_TETRA";      break;
204     case Geom_PYRAMID:    myStream<<"Geom_PYRAMID";    break;
205     case Geom_HEXA:       myStream<<"Geom_HEXA";       break;
206     case Geom_PENTA:      myStream<<"Geom_PENTA";      break;
207     case Geom_POLYHEDRA:  myStream<<"Geom_POLYHEDRA";  break;
208     case Geom_BALL:       myStream<<"Geom_BALL";       break;
209     default:    myStream<<"__UNKNOWN__GeometryType: " << theArg;
210     }
211     return *this;
212   }
213   TPythonDump&
214   TPythonDump::
215   operator<<(const SMESH::EntityType& theArg)
216   {
217     myStream<<"SMESH.";
218     switch(theArg){
219     case Entity_0D:                myStream<<"Entity_0D";                break;
220     case Entity_Edge:              myStream<<"Entity_Edge";              break;
221     case Entity_Quad_Edge:         myStream<<"Entity_Quad_Edge";         break;
222     case Entity_Triangle:          myStream<<"Entity_Triangle";          break;
223     case Entity_Quad_Triangle:     myStream<<"Entity_Quad_Triangle";     break;
224     case Entity_BiQuad_Triangle:   myStream<<"Entity_BiQuad_Triangle";   break;
225     case Entity_Quadrangle:        myStream<<"Entity_Quadrangle";        break;
226     case Entity_Quad_Quadrangle:   myStream<<"Entity_Quad_Quadrangle";   break;
227     case Entity_BiQuad_Quadrangle: myStream<<"Entity_BiQuad_Quadrangle"; break;
228     case Entity_Polygon:           myStream<<"Entity_Polygon";           break;
229     case Entity_Quad_Polygon:      myStream<<"Entity_Quad_Polygon";      break;
230     case Entity_Tetra:             myStream<<"Entity_Tetra";             break;
231     case Entity_Quad_Tetra:        myStream<<"Entity_Quad_Tetra";        break;
232     case Entity_Pyramid:           myStream<<"Entity_Pyramid";           break;
233     case Entity_Quad_Pyramid:      myStream<<"Entity_Quad_Pyramid";      break;
234     case Entity_Hexa:              myStream<<"Entity_Hexa";              break;
235     case Entity_Quad_Hexa:         myStream<<"Entity_Quad_Hexa";         break;
236     case Entity_TriQuad_Hexa:      myStream<<"Entity_TriQuad_Hexa";      break;
237     case Entity_Penta:             myStream<<"Entity_Penta";             break;
238     case Entity_Quad_Penta:        myStream<<"Entity_Quad_Penta";        break;
239     case Entity_BiQuad_Penta:      myStream<<"Entity_BiQuad_Penta";      break;
240     case Entity_Hexagonal_Prism:   myStream<<"Entity_Hexagonal_Prism";   break;
241     case Entity_Polyhedra:         myStream<<"Entity_Polyhedra";         break;
242     case Entity_Quad_Polyhedra:    myStream<<"Entity_Quad_Polyhedra";    break;
243     case Entity_Ball:              myStream<<"Entity_Ball";              break;
244     case Entity_Last:              myStream<<"Entity_Last";              break;
245     default:    myStream<<"__UNKNOWN__EntityType: " << theArg;
246     }
247     return *this;
248   }
249
250   TPythonDump&
251   TPythonDump::operator<<(const SMESH::long_array& theArg)
252   {
253     DumpArray( theArg, *this );
254     return *this;
255   }
256
257   TPythonDump&
258   TPythonDump::operator<<(const SMESH::double_array& theArg)
259   {
260     DumpArray( theArg, *this );
261     return *this;
262   }
263
264   TPythonDump&
265   TPythonDump::operator<<(const SMESH::nodes_array& theArg)
266   {
267     DumpArray( theArg, *this );
268     return *this;
269   }
270
271   TPythonDump&
272   TPythonDump::operator<<(const SMESH::string_array& theArray)
273   {
274     myStream << "[ ";
275     for ( CORBA::ULong i = 1; i <= theArray.length(); i++ ) {
276       myStream << "'" << theArray[i-1] << "'";
277       if ( i < theArray.length() )
278         myStream << ", ";
279     }
280     myStream << " ]";
281     return *this;
282   }
283
284   TPythonDump&
285   TPythonDump::
286   operator<<(SALOMEDS::SObject_ptr aSObject)
287   {
288     if ( !aSObject->_is_nil() ) {
289       CORBA::String_var entry = aSObject->GetID();
290       myStream << entry.in();
291     }
292     else {
293       myStream << theNotPublishedObjectName;
294     }
295     return *this;
296   }
297
298   TPythonDump&
299   TPythonDump::
300   operator<<(CORBA::Object_ptr theArg)
301   {
302     SMESH_Gen_i*          aSMESHGen = SMESH_Gen_i::GetSMESHGen();
303     SALOMEDS::SObject_wrap aSObject = SMESH_Gen_i::ObjectToSObject(theArg);
304     if(!aSObject->_is_nil()) {
305       CORBA::String_var id = aSObject->GetID();
306       myStream << id;
307     } else if ( !CORBA::is_nil(theArg)) {
308       if ( aSMESHGen->CanPublishInStudy( theArg )) // not published SMESH object
309         myStream << "smeshObj_" << size_t(theArg);
310       else
311         myStream << theNotPublishedObjectName;
312     }
313     else
314       myStream << "None";
315     return *this;
316   }
317
318   TPythonDump&
319   TPythonDump::
320   operator<<(SMESH::SMESH_Hypothesis_ptr theArg)
321   {
322     SALOMEDS::SObject_wrap aSObject = SMESH_Gen_i::ObjectToSObject(theArg);
323     if(aSObject->_is_nil() && !CORBA::is_nil(theArg))
324       myStream << "hyp_" << theArg->GetId();
325     else
326       *this << aSObject;
327     return *this;
328   }
329
330   TPythonDump&
331   TPythonDump::
332   operator<<(SMESH::SMESH_IDSource_ptr theArg)
333   {
334     if ( CORBA::is_nil( theArg ) )
335       return *this << "None";
336     SALOMEDS::SObject_wrap aSObject = SMESH_Gen_i::ObjectToSObject(theArg);
337     if(!aSObject->_is_nil())
338     {
339       return *this << aSObject;
340     }
341     if ( SMESH::Filter_i* filter = SMESH::DownCast<SMESH::Filter_i*>( theArg ))
342     {
343       return *this << filter;
344     }
345     if ( SMESH_MeshEditor_i::IsTemporaryIDSource( theArg ))
346     {
347       SMESH::SMESH_Mesh_var            mesh = theArg->GetMesh();
348       SMESH::long_array_var    anElementsId = theArg->GetIDs();
349       SMESH::array_of_ElementType_var types = theArg->GetTypes();
350       SMESH::ElementType               type = types->length() ? types[0] : SMESH::ALL;
351       SALOMEDS::SObject_wrap         meshSO = SMESH_Gen_i::ObjectToSObject(mesh);
352       if ( meshSO->_is_nil() ) // don't waste memory for dumping not published objects
353         return *this << mesh << ".GetIDSource([], " << type << ")";
354       else
355         return *this << mesh << ".GetIDSource(" << anElementsId << ", " << type << ")";
356     }
357     return *this << theNotPublishedObjectName;
358   }
359
360   TPythonDump&
361   TPythonDump::
362   operator<<(SMESH::FilterLibrary_i* theArg)
363   {
364     myStream<<"aFilterLibrary"<<theArg;
365     return *this;
366   }
367
368   TPythonDump&
369   TPythonDump::
370   operator<<(SMESH::FilterManager_i* theArg)
371   {
372     myStream<<"aFilterManager";
373     return *this;
374   }
375
376   TPythonDump&
377   TPythonDump::
378   operator<<(SMESH::Filter_i* theArg)
379   {
380     myStream<<"aFilter"<<theArg;
381     return *this;
382   }
383
384   TPythonDump&
385   TPythonDump::
386   operator<<(SMESH::Functor_i* theArg)
387   {
388     if ( theArg ) {
389       FunctorType aFunctorType = theArg->GetFunctorType();
390       switch(aFunctorType) {
391       case FT_AspectRatio:           myStream<< "aAspectRatio";           break;
392       case FT_AspectRatio3D:         myStream<< "aAspectRatio3D";         break;
393       case FT_Warping:               myStream<< "aWarping";               break;
394       case FT_MinimumAngle:          myStream<< "aMinimumAngle";          break;
395       case FT_Taper:                 myStream<< "aTaper";                 break;
396       case FT_Skew:                  myStream<< "aSkew";                  break;
397       case FT_Area:                  myStream<< "aArea";                  break;
398       case FT_Volume3D:              myStream<< "aVolume3D";              break;
399       case FT_MaxElementLength2D:    myStream<< "aMaxElementLength2D";    break;
400       case FT_MaxElementLength3D:    myStream<< "aMaxElementLength3D";    break;
401       case FT_FreeBorders:           myStream<< "aFreeBorders";           break;
402       case FT_FreeEdges:             myStream<< "aFreeEdges";             break;
403       case FT_FreeNodes:             myStream<< "aFreeNodes";             break;
404       case FT_FreeFaces:             myStream<< "aFreeFaces";             break;
405       case FT_EqualNodes:            myStream<< "aEqualNodes";            break;
406       case FT_EqualEdges:            myStream<< "aEqualEdges";            break;
407       case FT_EqualFaces:            myStream<< "aEqualFaces";            break;
408       case FT_EqualVolumes:          myStream<< "aEqualVolumes";          break;
409       case FT_MultiConnection:       myStream<< "aMultiConnection";       break;
410       case FT_MultiConnection2D:     myStream<< "aMultiConnection2D";     break;
411       case FT_Length:                myStream<< "aLength";                break;
412       case FT_Length2D:              myStream<< "aLength2D";              break;
413       case FT_Length3D:              myStream<< "aLength3D";              break;
414       case FT_Deflection2D:          myStream<< "aDeflection2D";          break;
415       case FT_NodeConnectivityNumber:myStream<< "aNodeConnectivityNumber";break;
416       case FT_BelongToMeshGroup:     myStream<< "aBelongToMeshGroup";     break;
417       case FT_BelongToGeom:          myStream<< "aBelongToGeom";          break;
418       case FT_BelongToPlane:         myStream<< "aBelongToPlane";         break;
419       case FT_BelongToCylinder:      myStream<< "aBelongToCylinder";      break;
420       case FT_BelongToGenSurface:    myStream<< "aBelongToGenSurface";    break;
421       case FT_LyingOnGeom:           myStream<< "aLyingOnGeom";           break;
422       case FT_RangeOfIds:            myStream<< "aRangeOfIds";            break;
423       case FT_BadOrientedVolume:     myStream<< "aBadOrientedVolume";     break;
424       case FT_BareBorderVolume:      myStream<< "aBareBorderVolume";      break;
425       case FT_BareBorderFace:        myStream<< "aBareBorderFace";        break;
426       case FT_OverConstrainedVolume: myStream<< "aOverConstrainedVolume"; break;
427       case FT_OverConstrainedFace:   myStream<< "aOverConstrainedFace";   break;
428       case FT_LinearOrQuadratic:     myStream<< "aLinearOrQuadratic";     break;
429       case FT_GroupColor:            myStream<< "aGroupColor";            break;
430       case FT_ElemGeomType:          myStream<< "aElemGeomType";          break;
431       case FT_EntityType:            myStream<< "aEntityType";            break;
432       case FT_CoplanarFaces:         myStream<< "aCoplanarFaces";         break;
433       case FT_BallDiameter:          myStream<< "aBallDiameter";          break;
434       case FT_ConnectedElements:     myStream<< "aConnectedElements";     break;
435       case FT_LessThan:              myStream<< "aLessThan";              break;
436       case FT_MoreThan:              myStream<< "aMoreThan";              break;
437       case FT_EqualTo:               myStream<< "aEqualTo";               break;
438       case FT_LogicalNOT:            myStream<< "aLogicalNOT";            break;
439       case FT_LogicalAND:            myStream<< "aLogicalAND";            break;
440       case FT_LogicalOR:             myStream<< "aLogicalOR";             break;
441       case FT_Undefined:             myStream<< "anUndefined";            break;
442         //default: -- commented to have a compilation warning
443       }
444       myStream<<theArg;
445     }
446     return *this;
447   }
448
449   TPythonDump&
450   TPythonDump::
451   operator<<(SMESH::Measurements_i* theArg)
452   {
453     myStream<<"aMeasurements";
454     return *this;
455   }
456
457   TPythonDump& TPythonDump:: operator<<(SMESH_Gen_i* theArg)
458   {
459     myStream << SMESHGenName(); return *this;
460   }
461
462   TPythonDump& TPythonDump::operator<<(SMESH_MeshEditor_i* theArg)
463   {
464     myStream << MeshEditorName() << "_" << ( theArg ? theArg->GetMeshId() : -1 ); return *this;
465   }
466
467   TPythonDump& TPythonDump::operator<<(const TCollection_AsciiString & theStr)
468   {
469     myStream << theStr; return *this;
470   }
471
472   TPythonDump& TPythonDump::operator<<(const SMESH::AxisStruct & theAxis)
473   {
474     *this << "SMESH.AxisStruct( "
475           << TVar( theAxis.x  ) << ", "
476           << TVar( theAxis.y  ) << ", "
477           << TVar( theAxis.z  ) << ", "
478           << TVar( theAxis.vx ) << ", "
479           << TVar( theAxis.vy ) << ", "
480           << TVar( theAxis.vz ) << " )";
481     return *this;
482   }
483
484   TPythonDump& TPythonDump::operator<<(const SMESH::DirStruct & theDir)
485   {
486     const SMESH::PointStruct & P = theDir.PS;
487     *this << "SMESH.DirStruct( SMESH.PointStruct ( "
488           << TVar( P.x ) << ", "
489           << TVar( P.y ) << ", "
490           << TVar( P.z ) << " ))";
491     return *this;
492   }
493
494   TPythonDump& TPythonDump::operator<<(const SMESH::PointStruct & P)
495   {
496     *this << "SMESH.PointStruct ( "
497           << TVar( P.x ) << ", "
498           << TVar( P.y ) << ", "
499           << TVar( P.z ) << " )";
500     return *this;
501   }
502
503   TPythonDump& TPythonDump::operator<<(const SMESH::ListOfGroups& theList)
504   {
505     DumpArray( theList, *this );
506     return *this;
507   }
508   TPythonDump& TPythonDump::operator<<(const SMESH::ListOfGroups * theList)
509   {
510     DumpArray( *theList, *this );
511     return *this;
512   }
513   TPythonDump& TPythonDump::operator<<(const GEOM::ListOfGO& theList)
514   {
515     DumpArray( theList, *this );
516     return *this;
517   }
518   TPythonDump& TPythonDump::operator<<(const GEOM::ListOfGBO& theList)
519   {
520     DumpArray( theList, *this );
521     return *this;
522   }
523   TPythonDump& TPythonDump::operator<<(const SMESH::ListOfIDSources& theList)
524   {
525     DumpArray( theList, *this );
526     return *this;
527   }
528   TPythonDump& TPythonDump::operator<<(const SMESH::submesh_array& theList)
529   {
530     DumpArray( theList, *this );
531     return *this;
532   }
533   TPythonDump& TPythonDump::operator<<(const SMESH::ListOfHypothesis& theList)
534   {
535     DumpArray( theList, *this );
536     return *this;
537   }
538   TPythonDump& TPythonDump::operator<<(const SMESH::CoincidentFreeBorders& theCFB)
539   {
540     // dump CoincidentFreeBorders as a list of lists, each enclosed list
541     // contains node IDs of a group of coincident free borders where
542     // each consequent triple of IDs describe a free border: (n1, n2, nLast)
543     // For example [[1, 2, 10, 20, 21, 40], [11, 12, 15, 55, 54, 41]] describes
544     // two groups of coincident free borders, each group including two borders
545
546     myStream << "[";
547     for ( CORBA::ULong i = 0; i < theCFB.coincidentGroups.length(); ++i )
548     {
549       const SMESH::FreeBordersGroup& aGRP = theCFB.coincidentGroups[ i ];
550       if ( i ) myStream << ",";
551       myStream << "[";
552       for ( CORBA::ULong iP = 0; iP < aGRP.length(); ++iP )
553       {
554         const SMESH::FreeBorderPart& aPART = aGRP[ iP ];
555         if ( 0 <= aPART.border && aPART.border < (CORBA::Long)theCFB.borders.length() )
556         {
557           if ( iP ) myStream << ", ";
558           const SMESH::FreeBorder& aBRD = theCFB.borders[ aPART.border ];
559           myStream << aBRD.nodeIDs[ aPART.node1    ] << ",";
560           myStream << aBRD.nodeIDs[ aPART.node2    ] << ",";
561           myStream << aBRD.nodeIDs[ aPART.nodeLast ];
562         }
563       }
564       myStream << "]";
565     }
566     myStream << "]";
567
568     return *this;
569   }
570
571   const char* TPythonDump::NotPublishedObjectName()
572   {
573     return theNotPublishedObjectName;
574   }
575
576   TCollection_AsciiString myLongStringStart( "TPythonDump::LongStringStart" );
577   TCollection_AsciiString myLongStringEnd  ( "TPythonDump::LongStringEnd" );
578
579   //================================================================================
580   /*!
581    * \brief Return marker of long string literal beginning
582    * \param type - a name of functionality producing the string literal
583    * \retval TCollection_AsciiString - the marker string to be written into
584    * a raw python script
585    */
586   //================================================================================
587
588   TCollection_AsciiString TPythonDump::LongStringStart(const char* type)
589   {
590     return
591       myLongStringStart +
592       (Standard_Integer) strlen(type) +
593       " " +
594       (char*) type;
595   }
596
597   //================================================================================
598   /*!
599      * \brief Return marker of long string literal end
600       * \retval TCollection_AsciiString - the marker string to be written into
601       * a raw python script
602    */
603   //================================================================================
604
605   TCollection_AsciiString TPythonDump::LongStringEnd()
606   {
607     return myLongStringEnd;
608   }
609
610   //================================================================================
611   /*!
612      * \brief Cut out a long string literal from a string
613       * \param theText - text possibly containing string literals
614       * \param theFrom - position in the text to search from
615       * \param theLongString - the retrieved literal
616       * \param theStringType - a name of functionality produced the literal
617       * \retval bool - true if a string literal found
618      *
619      * The literal is removed from theText; theFrom points position right after
620      * the removed literal
621    */
622   //================================================================================
623
624   bool  TPythonDump::CutoutLongString( TCollection_AsciiString & theText,
625                                        int                     & theFrom,
626                                        TCollection_AsciiString & theLongString,
627                                        TCollection_AsciiString & theStringType)
628   {
629     if ( theFrom < 1 || theFrom > theText.Length() )
630       return false;
631
632     // ...script \  beg marker    \ \ type \       literal              \  end marker  \ script...
633     //  "theText myLongStringStart7 Pattern!!! SALOME Mesh Pattern file myLongStringEndtextEnd"
634     //  012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789
635     //  0         1         2         3         4         5         6         7         8
636
637     theFrom = theText.Location( myLongStringStart, theFrom, theText.Length() ); // = 09
638     if ( !theFrom )
639       return false;
640
641     // find where literal begins
642     int literalBeg = theFrom + myLongStringStart.Length(); // = 26
643     char* typeLenStr = (char*) theText.ToCString() + literalBeg - 1; // = "7 Pattern!!! SALO...."
644     int typeLen = atoi ( typeLenStr ); // = 7
645     while ( *typeLenStr != ' ' ) { // look for ' ' after typeLen
646       literalBeg++; // 26 -> 27
647       typeLenStr++;
648     }
649     literalBeg += typeLen + 1; // = 35
650     if ( literalBeg > theText.Length() )
651       return false;
652
653     // where literal ends (i.e. end marker begins)
654     int literalEnd = theText.Location( myLongStringEnd, literalBeg, theText.Length() ); // = 64
655     if ( !literalEnd )
656       literalEnd = theText.Length();
657
658     // literal
659     theLongString = theText.SubString( literalBeg, literalEnd - 1); // "!!! SALOME Mesh Pattern file "
660     // type
661     theStringType = theText.SubString( literalBeg - typeLen, literalBeg - 1 ); // "Pattern"
662     // cut off literal
663     literalEnd += myLongStringEnd.Length(); // = 79
664     TCollection_AsciiString textEnd = theText.SubString( literalEnd, theText.Length() ); // "textE..."
665     theText = theText.SubString( 1, theFrom - 1 ) + textEnd;
666
667     return true;
668   }
669
670   void printException( const char* text )
671   {
672 #ifdef _DEBUG_
673     std::cout << "Exception in SMESH_Gen_i::DumpPython(): " << text << std::endl;
674 #endif
675   }
676
677 //=======================================================================
678 //function : RemoveTabulation
679 //purpose  : 
680 //=======================================================================
681   void RemoveTabulation( TCollection_AsciiString& theScript )
682   {
683     std::string aString( theScript.ToCString() );
684     std::string::size_type aPos = 0;
685     while( aPos < aString.length() )
686     {
687       aPos = aString.find( "\n\t", aPos );
688       if( aPos == std::string::npos )
689         break;
690       aString.replace( aPos, 2, "\n" );
691       aPos++;
692     }
693     theScript = aString.c_str();
694   }
695 }
696
697 //=======================================================================
698 //function : DumpPython
699 //purpose  :
700 //=======================================================================
701 Engines::TMPFile* SMESH_Gen_i::DumpPython( CORBA::Boolean  isPublished,
702                                            CORBA::Boolean  isMultiFile,
703                                            CORBA::Boolean& isValidScript)
704 {
705   // localizing
706   Kernel_Utils::Localizer loc;
707
708   SALOMEDS::Study_var aStudy = getStudyServant();
709   if (CORBA::is_nil(aStudy))
710     return new Engines::TMPFile(0);
711
712   CORBA::String_var compDataType = ComponentDataType();
713   SALOMEDS::SObject_wrap aSO = aStudy->FindComponent( compDataType.in() );
714   if (CORBA::is_nil(aSO))
715     return new Engines::TMPFile(0);
716
717   // Map study entries to object names
718   Resource_DataMapOfAsciiStringAsciiString aMap;
719   Resource_DataMapOfAsciiStringAsciiString aMapNames;
720
721   SALOMEDS::ChildIterator_wrap Itr = aStudy->NewChildIterator(aSO);
722   for (Itr->InitEx(true); Itr->More(); Itr->Next()) {
723     SALOMEDS::SObject_wrap aValue = Itr->Value();
724     CORBA::String_var anID = aValue->GetID();
725     CORBA::String_var aName = aValue->GetName();
726     TCollection_AsciiString aGUIName ( (char*) aName.in() );
727     TCollection_AsciiString anEntry ( (char*) anID.in() );
728     if (aGUIName.Length() > 0) {
729       aMapNames.Bind( anEntry, aGUIName );
730       aMap.Bind( anEntry, aGUIName );
731     }
732   }
733
734   // Get trace of restored study
735   SALOMEDS::StudyBuilder_var aStudyBuilder = aStudy->NewBuilder();
736   SALOMEDS::GenericAttribute_wrap anAttr =
737     aStudyBuilder->FindOrCreateAttribute(aSO, "AttributePythonObject");
738
739   SALOMEDS::AttributePythonObject_var pyAttr =
740     SALOMEDS::AttributePythonObject::_narrow(anAttr);
741   CORBA::String_var oldValue = pyAttr->GetObject();
742   TCollection_AsciiString aSavedTrace (oldValue.in());
743
744   // Add trace of API methods calls and replace study entries by names
745   TCollection_AsciiString aScript;
746   aScript += DumpPython_impl(aMap, aMapNames, isPublished, isMultiFile,
747                              myIsHistoricalPythonDump, isValidScript, aSavedTrace);
748
749   int aLen = aScript.Length();
750   unsigned char* aBuffer = new unsigned char[aLen+1];
751   strcpy((char*)aBuffer, aScript.ToCString());
752
753   CORBA::Octet* anOctetBuf =  (CORBA::Octet*)aBuffer;
754   Engines::TMPFile_var aStreamFile = new Engines::TMPFile(aLen+1, aLen+1, anOctetBuf, 1);
755
756   bool hasNotPublishedObjects = aScript.Location( SMESH::theNotPublishedObjectName, 1, aLen);
757   isValidScript = isValidScript && !hasNotPublishedObjects;
758
759   return aStreamFile._retn();
760 }
761
762 //=============================================================================
763 /*!
764  *  AddToPythonScript
765  */
766 //=============================================================================
767 void SMESH_Gen_i::AddToPythonScript (const TCollection_AsciiString& theString)
768 {
769   if (myPythonScript.IsNull()) {
770     myPythonScript = new TColStd_HSequenceOfAsciiString;
771   }
772   myPythonScript->Append(theString);
773 }
774
775 //=============================================================================
776 /*!
777  *  RemoveLastFromPythonScript
778  */
779 //=============================================================================
780 void SMESH_Gen_i::RemoveLastFromPythonScript()
781 {
782   if (!myPythonScript.IsNull()) {
783     int aLen = myPythonScript->Length();
784     myPythonScript->Remove(aLen);
785   }
786 }
787
788 //=======================================================================
789 //function : SavePython
790 //purpose  :
791 //=======================================================================
792 void SMESH_Gen_i::SavePython()
793 {
794   // Dump trace of API methods calls
795   TCollection_AsciiString aScript = GetNewPythonLines();
796
797   // Check contents of PythonObject attribute
798   CORBA::String_var compDataType = ComponentDataType();
799   SALOMEDS::SObject_wrap aSO = getStudyServant()->FindComponent( compDataType.in() );
800   SALOMEDS::StudyBuilder_var aStudyBuilder = getStudyServant()->NewBuilder();
801   SALOMEDS::GenericAttribute_wrap anAttr =
802     aStudyBuilder->FindOrCreateAttribute(aSO, "AttributePythonObject");
803
804   SALOMEDS::AttributePythonObject_var pyAttr =
805     SALOMEDS::AttributePythonObject::_narrow(anAttr);
806   CORBA::String_var oldValue = pyAttr->GetObject();
807   TCollection_AsciiString oldScript (oldValue.in());
808
809   if (oldScript.Length() > 0) {
810     oldScript += "\n";
811     oldScript += aScript;
812   } else {
813     oldScript = aScript;
814   }
815
816   // Store in PythonObject attribute
817   pyAttr->SetObject(oldScript.ToCString(), 1);
818
819   // Clean trace of API methods calls
820   CleanPythonTrace();
821 }
822
823
824 // impl
825
826
827 //=============================================================================
828 /*!
829  *  FindEntries: Returns a sequence of start/end positions of entries in the string
830  */
831 //=============================================================================
832 Handle(TColStd_HSequenceOfInteger) FindEntries (TCollection_AsciiString& theString)
833 {
834   Handle(TColStd_HSequenceOfInteger) aSeq = new TColStd_HSequenceOfInteger;
835   Standard_Integer aLen = theString.Length();
836   Standard_Boolean isFound = Standard_False;
837
838   char* arr = (char*) theString.ToCString();
839   Standard_Integer i = 0, j;
840
841   while(i < aLen) {
842     int c = (int)arr[i];
843     j = i+1;
844     if ( isdigit( c )) { //Is digit?
845
846       isFound = Standard_False;
847       while((j < aLen) && ( isdigit(c) || c == ':' )) { //Check if it is an entry
848         c = (int)arr[j++];
849         if(c == ':') isFound = Standard_True;
850       }
851
852       if (isFound) {
853         int prev = (i < 1) ? 0 : (int)arr[i - 1];
854         // to distinguish from a sketcher command:
855         // last char should be a digit, not ":",
856         // previous char should not be '"'.
857         if (arr[j-2] != ':' && prev != '"') {
858           aSeq->Append(i+1); // +1 because AsciiString starts from 1
859           aSeq->Append(j-1);
860         }
861       }
862     }
863
864     i = j;
865   }
866
867   return aSeq;
868 }
869
870 namespace {
871
872   //================================================================================
873   /*!
874    * \brief Make a string be a valid python name
875     * \param aName - a string to fix
876     * \retval bool - true if aName was not modified
877    */
878   //================================================================================
879
880   bool fixPythonName(TCollection_AsciiString & aName)
881   {
882     bool isValidName = true;
883     int nbUnderscore = 0;
884     int p;
885     // replace not allowed chars by underscore
886     const char* name = aName.ToCString();
887     for ( p = 0; name[p]; ++p ) {
888       if ( !isalnum( name[p] ) && name[p] != '_' )
889       {
890         if ( p == 0 || p+1 == aName.Length() || name[p-1] == '_')
891         {
892           aName.Remove( p+1, 1 ); // remove __ and _ from the start and the end
893           --p;
894           name = aName.ToCString();
895         }
896         else
897         {
898           aName.SetValue( p+1, '_');
899           nbUnderscore++;
900         }
901         isValidName = false;
902       }
903     }
904     // aName must not start with a digit
905     if ( aName.IsIntegerValue() ) {
906       aName.Insert( 1, 'a' );
907       isValidName = false;
908     }
909     // shorten names like CartesianParameters3D_400_400_400_1000000_1
910     const int nbAllowedUnderscore = 3; /* changed from 2 to 3 by an user request
911                                           posted to SALOME Forum */
912     if ( aName.Length() > 20 && nbUnderscore > nbAllowedUnderscore )
913     {
914       p = aName.Location( "_", 20, aName.Length());
915       if ( p > 1 )
916         aName.Trunc( p-1 );
917     }
918     return isValidName;
919   }
920
921   //================================================================================
922   /*!
923    * \brief Return Python module names of available plug-ins.
924    */
925   //================================================================================
926
927   std::vector<std::string> getPluginNames()
928   {
929     std::vector<std::string> pluginNames;
930     std::vector< std::string > xmlPaths = SMESH_Gen::GetPluginXMLPaths();
931     LDOMParser xmlParser;
932     for ( size_t i = 0; i < xmlPaths.size(); ++i )
933     {
934       bool error = xmlParser.parse( xmlPaths[i].c_str() );
935       if ( error )
936       {
937         TCollection_AsciiString data;
938         INFOS( xmlParser.GetError(data) );
939         continue;
940       }
941       // <meshers-group name="Standard Meshers"
942       //                resources="StdMeshers"
943       //                idl-module="StdMeshers"
944       //                server-lib="StdMeshersEngine"
945       //                gui-lib="StdMeshersGUI">
946       LDOM_Document xmlDoc   = xmlParser.getDocument();
947       LDOM_NodeList nodeList = xmlDoc.getElementsByTagName( "meshers-group" );
948       for ( int i = 0; i < nodeList.getLength(); ++i )
949       {
950         LDOM_Node       node = nodeList.item( i );
951         LDOM_Element&   elem = (LDOM_Element&) node;
952         LDOMString idlModule = elem.getAttribute( "idl-module" );
953         if ( strlen( idlModule.GetString() ) > 0 )
954           pluginNames.push_back( idlModule.GetString() );
955       }
956     }
957     return pluginNames;
958   }
959 }
960
961 //================================================================================
962 /*!
963  * \brief Creates a Dump Python script
964  *  \param [in,out] theObjectNames - map of an entry to a study and python name
965  *  \param [in] theNames -  - map of an entry to a study name
966  *  \param [in] isPublished - \c true if dump of object publication in study is needed
967  *  \param [in] isMultiFile - \c true if dump of each module goes to a separate file
968  *  \param [in] isHistoricalDump - \c true if removed object should be dumped
969  *  \param [out] aValidScript - returns \c true if the returned script seems valid
970  *  \param [in,out] theSavedTrace - the dump stored in the study. It's cleared to
971  *         decrease memory usage.
972  *  \return TCollection_AsciiString - the result dump script.
973  */
974 //================================================================================
975
976 TCollection_AsciiString SMESH_Gen_i::DumpPython_impl
977                         (Resource_DataMapOfAsciiStringAsciiString& theObjectNames,
978                          Resource_DataMapOfAsciiStringAsciiString& theNames,
979                          bool                                      isPublished,
980                          bool                                      isMultiFile,
981                          bool                                      isHistoricalDump,
982                          bool&                                     aValidScript,
983                          TCollection_AsciiString&                  theSavedTrace)
984 {
985   SMESH_TRY;
986
987   const TCollection_AsciiString aSmeshpy ( SMESH_2smeshpy::SmeshpyName() );
988   const TCollection_AsciiString aSMESHGen( SMESH_2smeshpy::GenName() );
989   const TCollection_AsciiString anOldGen ( SMESH::TPythonDump::SMESHGenName() );
990   const TCollection_AsciiString helper; // to comfortably append C strings to TCollection_AsciiString
991   const TCollection_AsciiString tab( isMultiFile ? "\t" : "" ), nt = helper + "\n" + tab;
992   TCollection_AsciiString optionalComment;
993   
994   std::list< TCollection_AsciiString > lines; // lines of a script
995   std::list< TCollection_AsciiString >::iterator linesIt;
996   
997   lines.push_back(  aSMESHGen + " = smeshBuilder.New()" );
998   if ( isPublished )
999     optionalComment = "#";
1000   lines.push_back( optionalComment + aSMESHGen + ".SetEnablePublish( False ) # Set to False to avoid publish in study if not needed or in some particular situations:" );
1001   lines.push_back( "                                 # multiples meshes built in parallel, complex and numerous mesh edition (performance)\n" );
1002   lines.push_back( helper + "aFilterManager = " + aSMESHGen + ".CreateFilterManager()" );
1003   lines.push_back( helper + "aMeasurements = "  + aSMESHGen + ".CreateMeasurements()" );
1004
1005   // Treat dump trace of restored study
1006   if (theSavedTrace.Length() > 0)
1007   {
1008     linesIt = --lines.end();
1009     // Split theSavedTrace into lines
1010     int from = 1, end = theSavedTrace.Length(), to;
1011     while ( from < end && ( to = theSavedTrace.Location( "\n", from, end )))
1012     {
1013       if ( theSavedTrace.ToCString()[from-1] == '\t' )
1014         ++from;
1015       if ( to != from )
1016         lines.push_back( theSavedTrace.SubString( from, to - 1 ));
1017       from = to + 1;
1018     }
1019     // For the conversion of IDL API calls -> smeshBuilder.py API, "smesh" standing for SMESH_Gen
1020     // was replaces with "smeshgen" (==TPythonDump::SMESHGenName()).
1021     // Change "smesh" -> "smeshgen" in the trace saved before passage to smeshBuilder.py API
1022     bool isNewVersion =
1023       theSavedTrace.Location( anOldGen + ".", 1, theSavedTrace.Length() );
1024     theSavedTrace.Clear();
1025     if ( !isNewVersion )
1026     {
1027       const TCollection_AsciiString aSmeshCall ( "smesh." ), gen( "gen" );
1028       int beg, end, from;
1029       for ( ++linesIt; linesIt != lines.end(); ++linesIt )
1030       {
1031         TCollection_AsciiString& aSavedLine = *linesIt;
1032         end = aSavedLine.Length(), from = 1;
1033         while ( from < end && ( beg = aSavedLine.Location( aSmeshCall, from, end )))
1034         {
1035           char charBefore = ( beg == 1 ) ? ' ' : aSavedLine.Value( beg - 1 );
1036           if ( isspace( charBefore ) || charBefore == '=' ) { // "smesh." is not a part of a long word
1037             aSavedLine.Insert( beg + aSmeshCall.Length() - 1, gen );// "smesh" -> "smeshgen"
1038             end += gen.Length();
1039           }
1040           from = beg + aSmeshCall.Length();
1041         }
1042       }
1043     }
1044   }
1045
1046   // Add new dump trace of API methods calls to script lines
1047   if (!myPythonScript.IsNull())
1048   {
1049     Handle(TColStd_HSequenceOfAsciiString) aPythonScript = myPythonScript;
1050     Standard_Integer istr, aLen = aPythonScript->Length();
1051     for (istr = 1; istr <= aLen; istr++)
1052       lines.push_back( aPythonScript->Value( istr ));
1053   }
1054
1055   // Convert IDL API calls into smeshBuilder.py API.
1056   // Some objects are wrapped with python classes and
1057   // Resource_DataMapOfAsciiStringAsciiString holds methods returning wrapped objects
1058   Resource_DataMapOfAsciiStringAsciiString anEntry2AccessorMethod;
1059   std::set< TCollection_AsciiString >      aRemovedObjIDs;
1060   if ( !getenv("NO_2smeshpy_conversion"))
1061     SMESH_2smeshpy::ConvertScript( lines, anEntry2AccessorMethod,
1062                                    theObjectNames, aRemovedObjIDs,
1063                                    isHistoricalDump );
1064
1065   bool importGeom = false;
1066   GEOM::GEOM_Gen_ptr geom[2];
1067   for ( int isShaper = 0; isShaper < 2; ++isShaper )
1068   {
1069     geom[ isShaper ] = GetGeomEngine( isShaper );
1070     if ( CORBA::is_nil( geom[ isShaper ]))
1071       continue;
1072     // Add names of GEOM objects to theObjectNames to exclude same names of SMESH objects
1073     GEOM::string_array_var aGeomNames = geom[ isShaper ]->GetAllDumpNames();
1074     for ( CORBA::ULong ign = 0; ign < aGeomNames->length(); ign++) {
1075       TCollection_AsciiString aName = aGeomNames[ign].in();
1076       theObjectNames.Bind(aName, "1");
1077     }
1078   }
1079
1080   TCollection_AsciiString anUpdatedScript;
1081
1082   Resource_DataMapOfAsciiStringAsciiString mapRemoved;
1083   Resource_DataMapOfAsciiStringAsciiString mapEntries; // names and entries present in anUpdatedScript
1084   Standard_Integer objectCounter = 0;
1085   TCollection_AsciiString anEntry, aName, aGUIName, aBaseName("smeshObj_");
1086
1087   // Treat every script line and add it to anUpdatedScript
1088   for ( linesIt = lines.begin(); linesIt != lines.end(); ++linesIt )
1089   {
1090     TCollection_AsciiString& aLine = *linesIt;
1091     anUpdatedScript += tab;
1092     {
1093       //Replace characters used instead of quote marks to quote notebook variables
1094       int pos = 1;
1095       while (( pos = aLine.Location( 1, SMESH::TVar::Quote(), pos, aLine.Length() )))
1096         aLine.SetValue( pos, '"' );
1097     }
1098     // Find entries to be replaced by names
1099     Handle(TColStd_HSequenceOfInteger) aSeq = FindEntries(aLine);
1100     const Standard_Integer aSeqLen = aSeq->Length();
1101     Standard_Integer aStart = 1;
1102     for (Standard_Integer i = 1; i <= aSeqLen; i += 2)
1103     {
1104       if ( aStart < aSeq->Value(i) )
1105         anUpdatedScript += aLine.SubString( aStart, aSeq->Value(i) - 1 ); // line part before i-th entry
1106       anEntry = aLine.SubString( aSeq->Value(i), aSeq->Value(i + 1) );
1107       // is a GEOM object?
1108       CORBA::String_var geomName;
1109       if ( !CORBA::is_nil( geom[0] ))
1110         geomName = geom[0]->GetDumpName( anEntry.ToCString() );
1111       if (( !geomName.in() || !geomName.in()[0] ) && !CORBA::is_nil( geom[1] ))
1112         geomName = geom[1]->GetDumpName( anEntry.ToCString() );
1113       if ( !geomName.in() || !geomName.in()[0] ) {
1114         // is a SMESH object
1115         if ( theObjectNames.IsBound( anEntry )) {
1116           // The Object is in Study
1117           aName = theObjectNames.Find( anEntry );
1118           // check validity of aName
1119           bool isValidName = fixPythonName( aName );
1120           if (theObjectNames.IsBound(aName) && anEntry != theObjectNames(aName)) {
1121             // diff objects have same name - make a new name by appending a digit
1122             TCollection_AsciiString aName2;
1123             Standard_Integer i = 0;
1124             do {
1125               aName2 = aName + "_" + ++i;
1126             } while (theObjectNames.IsBound(aName2) && anEntry != theObjectNames(aName2));
1127             aName = aName2;
1128             isValidName = false;
1129           }
1130           if ( !isValidName )
1131             theObjectNames(anEntry) = aName;
1132
1133           if ( aLine.Value(1) != '#' )
1134             mapEntries.Bind(anEntry, aName);
1135         }
1136         else
1137         {
1138           // Removed Object
1139           do {
1140             aName = aBaseName + (++objectCounter);
1141           } while (theObjectNames.IsBound(aName));
1142
1143           if ( !aRemovedObjIDs.count( anEntry ) && aLine.Value(1) != '#')
1144             mapRemoved.Bind(anEntry, aName);
1145
1146           theObjectNames.Bind(anEntry, aName);
1147         }
1148         theObjectNames.Bind(aName, anEntry); // to detect same name of diff objects
1149       }
1150       else
1151       {
1152         aName = geomName.in();
1153         importGeom = true;
1154       }
1155       anUpdatedScript += aName;
1156       aStart = aSeq->Value(i + 1) + 1;
1157
1158     } // loop on entries within aLine
1159
1160     if ( aSeqLen == 0 )
1161       anUpdatedScript += aLine;
1162     else if ( aSeq->Value( aSeqLen ) < aLine.Length() )
1163       anUpdatedScript += aLine.SubString( aSeq->Value(aSeqLen) + 1, aLine.Length() );
1164
1165     anUpdatedScript += '\n';
1166   }
1167
1168   // Make an initial part of aSript
1169
1170   TCollection_AsciiString initPart = "import ";
1171   if ( isMultiFile )
1172     initPart += "salome, ";
1173   initPart += " SMESH, SALOMEDS\n";
1174   initPart += "from salome.smesh import smeshBuilder\n";
1175   if ( importGeom && isMultiFile )
1176   {
1177     initPart += ("\n## import GEOM dump file ## \n"
1178                  "import string, os, sys, re, inspect\n"
1179                  "thisFile   = inspect.getfile( inspect.currentframe() )\n"
1180                  "thisModule = os.path.splitext( os.path.basename( thisFile ))[0]\n"
1181                  "sys.path.insert( 0, os.path.dirname( thisFile ))\n"
1182                  "exec(\"from \"+re.sub(\"SMESH$\",\"GEOM\",thisModule)+\" import *\")\n\n");
1183   }
1184   // import python files corresponding to plugins if they are used in anUpdatedScript
1185   {
1186     //TCollection_AsciiString importStr;
1187     std::vector<std::string> pluginNames = getPluginNames();
1188     for ( size_t i = 0; i < pluginNames.size(); ++i )
1189     {
1190       // Convert access to plugin members:
1191       // e.g. StdMeshers.QUAD_REDUCED -> smeshBuilder.QUAD_REDUCED
1192       TCollection_AsciiString pluginAccess = (pluginNames[i] + ".").c_str() ;
1193       int iFrom = 1, iPos;
1194       while (( iPos = anUpdatedScript.Location( pluginAccess, iFrom, anUpdatedScript.Length() )))
1195       {
1196         //anUpdatedScript.Insert( iPos + pluginNames[i].size(), "Builder" );
1197         anUpdatedScript.Remove( iPos, pluginNames[i].size() );
1198         anUpdatedScript.Insert( iPos, "smeshBuilder" );
1199         iFrom = iPos - pluginNames[i].size() + 12;
1200       }
1201       // if any plugin member is used, import the plugin
1202       // if ( iFrom > 1 )
1203       //   importStr += ( helper + "\n" "from salome." + pluginNames[i].c_str() +
1204       //                  " import " + pluginNames[i].c_str() +"Builder" );
1205     }
1206     // if ( !importStr.IsEmpty() )
1207     //   initPart += importStr + "\n";
1208   }
1209
1210   if ( isMultiFile )
1211     initPart += "def RebuildData():";
1212   initPart += "\n";
1213
1214   anUpdatedScript.Prepend( initPart );
1215
1216   // Make a final part of aScript
1217
1218   // Dump object removal
1219   TCollection_AsciiString removeObjPart;
1220   if ( !mapRemoved.IsEmpty() ) {
1221     removeObjPart += nt + "## some objects were removed";
1222     removeObjPart += nt + "aStudyBuilder = salome.myStudy.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 = salome.myStudy.FindObjectIOR(salome.myStudy.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)";
1233     }
1234   }
1235
1236   // Set object names
1237   TCollection_AsciiString setNamePart;
1238   Resource_DataMapIteratorOfDataMapOfAsciiStringAsciiString mapEntriesIt;
1239   for ( mapEntriesIt.Initialize( mapEntries ); mapEntriesIt.More(); mapEntriesIt.Next() )
1240   {
1241     anEntry = mapEntriesIt.Key();
1242     aName   = mapEntriesIt.Value(); // python name
1243     if ( theNames.IsBound( anEntry ))
1244     {
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 + "')";
1251     }
1252   }
1253   if ( !setNamePart.IsEmpty() )
1254   {
1255     setNamePart.Insert( 1, nt + "## Set names of Mesh objects" );
1256   }
1257
1258   // Store visual properties of displayed objects
1259
1260   TCollection_AsciiString visualPropertiesPart;
1261   if (isPublished)
1262   {
1263     //Output the script that sets up the visual parameters.
1264     CORBA::String_var compDataType = ComponentDataType();
1265     CORBA::String_var script = getStudyServant()->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();
1269     }
1270   }
1271
1272   anUpdatedScript += removeObjPart + '\n' + setNamePart + '\n' + visualPropertiesPart;
1273
1274   if ( isMultiFile )
1275   {
1276     anUpdatedScript +=
1277       "\n\tpass"
1278       "\n"
1279       "\nif __name__ == '__main__':"
1280       "\n\tSMESH_RebuildData = RebuildData"
1281       "\n\texec('import '+re.sub('SMESH$','GEOM',thisModule)+' as GEOM_dump')"
1282       "\n\tGEOM_dump.RebuildData()"
1283       "\n\texec('from '+re.sub('SMESH$','GEOM',thisModule)+' import * ')"
1284       "\n\tSMESH_RebuildData()";
1285   }
1286   anUpdatedScript += "\n";
1287
1288   // no need now as we use 'tab' and 'nt' variables depending on isMultiFile
1289   // if( !isMultiFile ) // remove unnecessary tabulation
1290   //   RemoveTabulation( anUpdatedScript );
1291
1292   // -----------------------------------------------------------------
1293   // put string literals describing patterns into separate functions
1294   // -----------------------------------------------------------------
1295
1296   TCollection_AsciiString aLongString, aFunctionType;
1297   int where = 1;
1298   std::set< std::string > functionNameSet;
1299   while ( SMESH::TPythonDump::CutoutLongString( anUpdatedScript, where, aLongString, aFunctionType ))
1300   {
1301     // make a python string literal
1302     aLongString.Prepend(":\n\treturn '''\n");
1303     aLongString += "\n\t'''\n\tpass\n";
1304
1305     TCollection_AsciiString functionName;
1306
1307     // check if the function returning this literal is already defined
1308     int posAlready = anUpdatedScript.Location( aLongString, where, anUpdatedScript.Length() );
1309     if ( posAlready ) // already defined
1310     {
1311       // find the function name
1312       int functBeg = posAlready;
1313       char* script = (char*) anUpdatedScript.ToCString() + posAlready - 1; // look at ":" after "def function()"
1314       while ( *script != ' ' ) {
1315         script--;
1316         functBeg--;
1317       }
1318       functBeg++; // do not take ' '
1319       posAlready--; // do not take ':'
1320       functionName = anUpdatedScript.SubString( functBeg, posAlready );
1321     }
1322     else // not defined yet
1323     {
1324       // find a unique function name
1325       fixPythonName( aFunctionType );
1326       Standard_Integer nb = 0;
1327       do functionName = aFunctionType + "_" + ( nb++ ) + "()";
1328       while ( !functionNameSet.insert( functionName.ToCString() ).second );
1329
1330       // define function
1331       TCollection_AsciiString funDef = helper + "def " + functionName + aLongString;
1332       if ( isMultiFile )
1333       {
1334         anUpdatedScript += helper + "\n\n" + funDef;
1335       }
1336       else
1337       {
1338         funDef += "\n\n";
1339         anUpdatedScript.Insert( 1, funDef);
1340         where += funDef.Length();
1341       }
1342     }
1343     anUpdatedScript.InsertBefore( where, functionName ); // call function
1344   }
1345
1346   aValidScript = true;
1347
1348   return anUpdatedScript;
1349
1350   SMESH_CATCH( SMESH::printException );
1351
1352   aValidScript = false;
1353   return "";
1354 }
1355
1356 //=============================================================================
1357 /*!
1358  *  GetNewPythonLines
1359  */
1360 //=============================================================================
1361 TCollection_AsciiString SMESH_Gen_i::GetNewPythonLines()
1362 {
1363   TCollection_AsciiString aScript;
1364
1365   // Dump trace of API methods calls
1366   if (!myPythonScript.IsNull()) {
1367     Handle(TColStd_HSequenceOfAsciiString) aPythonScript = myPythonScript;
1368     Standard_Integer istr, aLen = aPythonScript->Length();
1369     for (istr = 1; istr <= aLen; istr++) {
1370       aScript += "\n";
1371       aScript += aPythonScript->Value(istr);
1372     }
1373     aScript += "\n";
1374   }
1375
1376   return aScript;
1377 }
1378
1379 //=============================================================================
1380 /*!
1381  *  CleanPythonTrace
1382  */
1383 //=============================================================================
1384 void SMESH_Gen_i::CleanPythonTrace()
1385 {
1386   TCollection_AsciiString aScript;
1387
1388   // Clean trace of API methods calls
1389   if (!myPythonScript.IsNull()) {
1390     myPythonScript->Clear();
1391   }
1392 }
1393
1394 //================================================================================
1395 /*!
1396  * \brief Count inclusions of a string in a raw Python dump script
1397  */
1398 //================================================================================
1399
1400 int SMESH_Gen_i::CountInPyDump(const TCollection_AsciiString& theText)
1401 {
1402   int count = 0;
1403
1404   SALOMEDS::Study_var aStudy = getStudyServant();
1405   if ( CORBA::is_nil( aStudy ))
1406     return count;
1407
1408   SMESH_Gen_i* me = GetSMESHGen();
1409   CORBA::String_var compDataType = me->ComponentDataType();
1410   SALOMEDS::SObject_wrap aSO = aStudy->FindComponent( compDataType.in() );
1411   if ( CORBA::is_nil( aSO ))
1412     return count;
1413
1414   // Trace saved in the study
1415   SALOMEDS::GenericAttribute_wrap attr;
1416   if ( aSO->FindAttribute( attr.inout(), "AttributePythonObject" ))
1417   {
1418     SALOMEDS::AttributePythonObject_var pyAttr =
1419       SALOMEDS::AttributePythonObject::_narrow( attr );
1420     CORBA::String_var script = pyAttr->GetObject();
1421     for ( const char * scriptPos = script.in(); true; ++scriptPos )
1422       if (( scriptPos = strstr( scriptPos, theText.ToCString() )))
1423         ++count;
1424       else
1425         break;
1426   }
1427
1428   // New python commands
1429   if ( !me->myPythonScript.IsNull() )
1430   {
1431     const int nbLines = me->myPythonScript->Length();
1432     for ( int i = 1; i <= nbLines; ++i )
1433     {
1434       const TCollection_AsciiString& line = me->myPythonScript->Value( i );
1435       for ( int loc = 1; loc <= line.Length(); ++loc )
1436         if (( loc = line.Location( theText, loc, line.Length() )))
1437           ++count;
1438         else
1439           break;
1440     }
1441   }
1442
1443   return count;
1444 }