Salome HOME
23080: [CEA 1497] Do not merge a middle node in quadratic with the extreme nodes...
[modules/smesh.git] / src / SMESH_I / SMESH_DumpPython.cxx
1 // Copyright (C) 2007-2015  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 <SALOMEDS_wrap.hxx>
36
37 #include <LDOMParser.hxx>
38 #include <Resource_DataMapIteratorOfDataMapOfAsciiStringAsciiString.hxx>
39 #include <TColStd_HSequenceOfInteger.hxx>
40 #include <TCollection_AsciiString.hxx>
41
42 #ifdef _DEBUG_
43 static int MYDEBUG = 0;
44 #else
45 static int MYDEBUG = 0;
46 #endif
47
48 #include "SMESH_TryCatch.hxx"
49
50 namespace SMESH
51 {
52
53   size_t TPythonDump::myCounter = 0;
54   const char theNotPublishedObjectName[] = "__NOT__Published__Object__";
55
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())
60   {
61     for ( size_t i = 0; i < value.length(); i++)
62       myVals[i] = SMESH_Comment(value[i]);
63   }
64
65   TPythonDump::
66   TPythonDump():myVarsCounter(0)
67   {
68     ++myCounter;
69   }
70   TPythonDump::
71   ~TPythonDump()
72   {
73     if(--myCounter == 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())
79       {
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(),"");
87       }
88     }
89   }
90
91   TPythonDump& //!< store a variable value. Write either a value or '$varID$'
92   TPythonDump::
93   operator<<(const TVar& theVarValue)
94   {
95     const std::vector< int >& varIDs = SMESH_Gen_i::GetSMESHGen()->GetLastParamIndices();
96     if ( theVarValue.myVals.size() != 1 )
97     {
98       myStream << "[ ";
99       for ( size_t i = 1; i <= theVarValue.myVals.size(); ++i )
100       {
101         if ( myVarsCounter < varIDs.size() && varIDs[ myVarsCounter ] >= 0 )
102           myStream << TVar::Quote() << varIDs[ myVarsCounter ] << TVar::Quote();
103         else
104           myStream << theVarValue.myVals[i-1];
105         if ( i < theVarValue.myVals.size() )
106           myStream << ", ";
107         ++myVarsCounter;
108       }
109       myStream << " ]";
110     }
111     else
112     {
113       if ( myVarsCounter < varIDs.size() && varIDs[ myVarsCounter ] >= 0 )
114         myStream << TVar::Quote() << varIDs[ myVarsCounter ] << TVar::Quote();
115       else
116         myStream << theVarValue.myVals[0];
117       ++myVarsCounter;
118     }
119     return *this;
120   }
121
122   TPythonDump&
123   TPythonDump::
124   operator<<(long int theArg){
125     myStream<<theArg;
126     return *this;
127   }
128
129   TPythonDump&
130   TPythonDump::
131   operator<<(int theArg){
132     myStream<<theArg;
133     return *this;
134   }
135
136   TPythonDump&
137   TPythonDump::
138   operator<<(double theArg){
139     myStream<<theArg;
140     return *this;
141   }
142
143   TPythonDump&
144   TPythonDump::
145   operator<<(float theArg){
146     myStream<<theArg;
147     return *this;
148   }
149
150   TPythonDump&
151   TPythonDump::
152   operator<<(const void* theArg){
153     myStream<<theArg;
154     return *this;
155   }
156
157   TPythonDump&
158   TPythonDump::
159   operator<<(const char* theArg){
160     if ( theArg )
161       myStream<<theArg;
162     return *this;
163   }
164
165   TPythonDump&
166   TPythonDump::
167   operator<<(const SMESH::ElementType& theArg)
168   {
169     myStream<<"SMESH.";
170     switch(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;
179     }
180     return *this;
181   }
182
183   TPythonDump&
184   TPythonDump::
185   operator<<(const SMESH::GeometryType& theArg)
186   {
187     myStream<<"SMESH.";
188     switch(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;
201     }
202     return *this;
203   }
204   TPythonDump&
205   TPythonDump::
206   operator<<(const SMESH::EntityType& theArg)
207   {
208     myStream<<"SMESH.";
209     switch(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;
236     }
237     return *this;
238   }
239
240   template<class TArray>
241   void DumpArray(const TArray& theArray, TPythonDump & theStream)
242   {
243     if ( theArray.length() == 0 )
244     {
245       theStream << "[]";
246     }
247     else
248     {
249       theStream << "[ ";
250       for (int i = 1; i <= theArray.length(); i++) {
251         theStream << theArray[i-1];
252         if ( i < theArray.length() )
253           theStream << ", ";
254       }
255       theStream << " ]";
256     }
257   }
258
259   TPythonDump&
260   TPythonDump::operator<<(const SMESH::long_array& theArg)
261   {
262     DumpArray( theArg, *this );
263     return *this;
264   }
265
266   TPythonDump&
267   TPythonDump::operator<<(const SMESH::double_array& theArg)
268   {
269     DumpArray( theArg, *this );
270     return *this;
271   }
272
273   TPythonDump&
274   TPythonDump::operator<<(const SMESH::nodes_array& theArg)
275   {
276     DumpArray( theArg, *this );
277     return *this;
278   }
279
280   TPythonDump&
281   TPythonDump::operator<<(const SMESH::string_array& theArray)
282   {
283     myStream << "[ ";
284     for (int i = 1; i <= theArray.length(); i++) {
285       myStream << "'" << theArray[i-1] << "'";
286       if ( i < theArray.length() )
287         myStream << ", ";
288     }
289     myStream << " ]";
290     return *this;
291   }
292
293   TPythonDump&
294   TPythonDump::
295   operator<<(SALOMEDS::SObject_ptr aSObject)
296   {
297     if ( !aSObject->_is_nil() ) {
298       CORBA::String_var entry = aSObject->GetID();
299       myStream << entry.in();
300     }
301     else {
302       myStream << theNotPublishedObjectName;
303     }
304     return *this;
305   }
306
307   TPythonDump&
308   TPythonDump::
309   operator<<(CORBA::Object_ptr theArg)
310   {
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();
316       myStream << id;
317     } else if ( !CORBA::is_nil(theArg)) {
318       if ( aSMESHGen->CanPublishInStudy( theArg )) // not published SMESH object
319         myStream << "smeshObj_" << size_t(theArg);
320       else
321         myStream << theNotPublishedObjectName;
322     }
323     else
324       myStream << "None";
325     return *this;
326   }
327
328   TPythonDump&
329   TPythonDump::
330   operator<<(SMESH::SMESH_Hypothesis_ptr theArg)
331   {
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();
336     else
337       *this << aSObject;
338     return *this;
339   }
340
341   TPythonDump&
342   TPythonDump::
343   operator<<(SMESH::SMESH_IDSource_ptr theArg)
344   {
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())
351     {
352       return *this << aSObject;
353     }
354     if ( SMESH::Filter_i* filter = SMESH::DownCast<SMESH::Filter_i*>( theArg ))
355     {
356       return *this << filter;
357     }
358     if ( SMESH_MeshEditor_i::IsTemporaryIDSource( theArg ))
359     {
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 << ")";
367       else
368         return *this << mesh << ".GetIDSource(" << anElementsId << ", " << type << ")";
369     }
370     return *this << theNotPublishedObjectName;
371   }
372
373   TPythonDump&
374   TPythonDump::
375   operator<<(SMESH::FilterLibrary_i* theArg)
376   {
377     myStream<<"aFilterLibrary"<<theArg;
378     return *this;
379   }
380
381   TPythonDump&
382   TPythonDump::
383   operator<<(SMESH::FilterManager_i* theArg)
384   {
385     myStream<<"aFilterManager";
386     return *this;
387   }
388
389   TPythonDump&
390   TPythonDump::
391   operator<<(SMESH::Filter_i* theArg)
392   {
393     myStream<<"aFilter"<<theArg;
394     return *this;
395   }
396
397   TPythonDump&
398   TPythonDump::
399   operator<<(SMESH::Functor_i* theArg)
400   {
401     if ( 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;
451       case FT_Undefined:
452       default:                       myStream<< "anUndefined";            break;
453       }
454       myStream<<theArg;
455     }
456     return *this;
457   }
458
459   TPythonDump&
460   TPythonDump::
461   operator<<(SMESH::Measurements_i* theArg)
462   {
463     myStream<<"aMeasurements";
464     return *this;
465   }
466
467
468   TPythonDump& TPythonDump:: operator<<(SMESH_Gen_i* theArg)
469   {
470     myStream << SMESHGenName(); return *this;
471   }
472
473   TPythonDump& TPythonDump::operator<<(SMESH_MeshEditor_i* theArg)
474   {
475     myStream << MeshEditorName() << "_" << ( theArg ? theArg->GetMeshId() : -1 ); return *this;
476   }
477
478   TPythonDump& TPythonDump::operator<<(const TCollection_AsciiString & theStr)
479   {
480     myStream << theStr; return *this;
481   }
482
483
484   TPythonDump& TPythonDump::operator<<(SMESH::MED_VERSION theVersion)
485   {
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;
490     }
491     return *this;
492   }
493
494   TPythonDump& TPythonDump::operator<<(const SMESH::AxisStruct & theAxis)
495   {
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 ) << " )";
503     return *this;
504   }
505
506   TPythonDump& TPythonDump::operator<<(const SMESH::DirStruct & theDir)
507   {
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 ) << " ))";
513     return *this;
514   }
515
516   TPythonDump& TPythonDump::operator<<(const SMESH::PointStruct & P)
517   {
518     *this << "SMESH.PointStruct ( "
519           << TVar( P.x ) << ", "
520           << TVar( P.y ) << ", "
521           << TVar( P.z ) << " )";
522     return *this;
523   }
524
525   TPythonDump& TPythonDump::operator<<(const SMESH::ListOfGroups& theList)
526   {
527     DumpArray( theList, *this );
528     return *this;
529   }
530   TPythonDump& TPythonDump::operator<<(const SMESH::ListOfGroups * theList)
531   {
532     DumpArray( *theList, *this );
533     return *this;
534   }
535   TPythonDump& TPythonDump::operator<<(const GEOM::ListOfGO& theList)
536   {
537     DumpArray( theList, *this );
538     return *this;
539   }
540   TPythonDump& TPythonDump::operator<<(const GEOM::ListOfGBO& theList)
541   {
542     DumpArray( theList, *this );
543     return *this;
544   }
545   TPythonDump& TPythonDump::operator<<(const SMESH::ListOfIDSources& theList)
546   {
547     DumpArray( theList, *this );
548     return *this;
549   }
550   const char* TPythonDump::NotPublishedObjectName()
551   {
552     return theNotPublishedObjectName;
553   }
554
555   TCollection_AsciiString myLongStringStart( "TPythonDump::LongStringStart" );
556   TCollection_AsciiString myLongStringEnd  ( "TPythonDump::LongStringEnd" );
557
558   //================================================================================
559   /*!
560    * \brief Return marker of long string literal beginning
561    * \param type - a name of functionality producing the string literal
562    * \retval TCollection_AsciiString - the marker string to be written into
563    * a raw python script
564    */
565   //================================================================================
566
567   TCollection_AsciiString TPythonDump::LongStringStart(const char* type)
568   {
569     return
570       myLongStringStart +
571       (Standard_Integer) strlen(type) +
572       " " +
573       (char*) type;
574   }
575
576   //================================================================================
577   /*!
578      * \brief Return marker of long string literal end
579       * \retval TCollection_AsciiString - the marker string to be written into
580       * a raw python script
581    */
582   //================================================================================
583
584   TCollection_AsciiString TPythonDump::LongStringEnd()
585   {
586     return myLongStringEnd;
587   }
588
589   //================================================================================
590   /*!
591      * \brief Cut out a long string literal from a string
592       * \param theText - text possibly containing string literals
593       * \param theFrom - position in the text to search from
594       * \param theLongString - the retrieved literal
595       * \param theStringType - a name of functionality produced the literal
596       * \retval bool - true if a string literal found
597      *
598      * The literal is removed from theText; theFrom points position right after
599      * the removed literal
600    */
601   //================================================================================
602
603   bool  TPythonDump::CutoutLongString( TCollection_AsciiString & theText,
604                                        int                     & theFrom,
605                                        TCollection_AsciiString & theLongString,
606                                        TCollection_AsciiString & theStringType)
607   {
608     if ( theFrom < 1 || theFrom > theText.Length() )
609       return false;
610
611     // ...script \  beg marker    \ \ type \       literal              \  end marker  \ script...
612     //  "theText myLongStringStart7 Pattern!!! SALOME Mesh Pattern file myLongStringEndtextEnd"
613     //  012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789
614     //  0         1         2         3         4         5         6         7         8
615
616     theFrom = theText.Location( myLongStringStart, theFrom, theText.Length() ); // = 09
617     if ( !theFrom )
618       return false;
619
620     // find where literal begins
621     int literalBeg = theFrom + myLongStringStart.Length(); // = 26
622     char* typeLenStr = (char*) theText.ToCString() + literalBeg - 1; // = "7 Pattern!!! SALO...."
623     int typeLen = atoi ( typeLenStr ); // = 7
624     while ( *typeLenStr != ' ' ) { // look for ' ' after typeLen
625       literalBeg++; // 26 -> 27
626       typeLenStr++;
627     }
628     literalBeg += typeLen + 1; // = 35
629     if ( literalBeg > theText.Length() )
630       return false;
631
632     // where literal ends (i.e. end marker begins)
633     int literalEnd = theText.Location( myLongStringEnd, literalBeg, theText.Length() ); // = 64
634     if ( !literalEnd )
635       literalEnd = theText.Length();
636
637     // literal
638     theLongString = theText.SubString( literalBeg, literalEnd - 1); // "!!! SALOME Mesh Pattern file "
639     // type
640     theStringType = theText.SubString( literalBeg - typeLen, literalBeg - 1 ); // "Pattern"
641     // cut off literal
642     literalEnd += myLongStringEnd.Length(); // = 79
643     TCollection_AsciiString textEnd = theText.SubString( literalEnd, theText.Length() ); // "textE..."
644     theText = theText.SubString( 1, theFrom - 1 ) + textEnd;
645
646     return true;
647   }
648
649   void printException( const char* text )
650   {
651 #ifdef _DEBUG_
652     cout << "Exception in SMESH_Gen_i::DumpPython(): " << text << endl;
653 #endif
654   }
655 }
656
657 //=======================================================================
658 //function : RemoveTabulation
659 //purpose  : 
660 //=======================================================================
661 void RemoveTabulation( TCollection_AsciiString& theScript )
662 {
663   std::string aString( theScript.ToCString() );
664   std::string::size_type aPos = 0;
665   while( aPos < aString.length() )
666   {
667     aPos = aString.find( "\n\t", aPos );
668     if( aPos == std::string::npos )
669       break;
670     aString.replace( aPos, 2, "\n" );
671     aPos++;
672   }
673   theScript = aString.c_str();
674 }
675
676 //=======================================================================
677 //function : DumpPython
678 //purpose  :
679 //=======================================================================
680 Engines::TMPFile* SMESH_Gen_i::DumpPython (CORBA::Object_ptr theStudy,
681                                            CORBA::Boolean isPublished,
682                                            CORBA::Boolean isMultiFile,
683                                            CORBA::Boolean& isValidScript)
684 {
685   SALOMEDS::Study_var aStudy = SALOMEDS::Study::_narrow(theStudy);
686   if (CORBA::is_nil(aStudy))
687     return new Engines::TMPFile(0);
688
689   CORBA::String_var compDataType = ComponentDataType();
690   SALOMEDS::SObject_wrap aSO = aStudy->FindComponent( compDataType.in() );
691   if (CORBA::is_nil(aSO))
692     return new Engines::TMPFile(0);
693
694   // Map study entries to object names
695   Resource_DataMapOfAsciiStringAsciiString aMap;
696   Resource_DataMapOfAsciiStringAsciiString aMapNames;
697
698   SALOMEDS::ChildIterator_wrap Itr = aStudy->NewChildIterator(aSO);
699   for (Itr->InitEx(true); Itr->More(); Itr->Next()) {
700     SALOMEDS::SObject_wrap aValue = Itr->Value();
701     CORBA::String_var anID = aValue->GetID();
702     CORBA::String_var aName = aValue->GetName();
703     TCollection_AsciiString aGUIName ( (char*) aName.in() );
704     TCollection_AsciiString anEntry ( (char*) anID.in() );
705     if (aGUIName.Length() > 0) {
706       aMapNames.Bind( anEntry, aGUIName );
707       aMap.Bind( anEntry, aGUIName );
708     }
709   }
710
711   // Get trace of restored study
712   SALOMEDS::StudyBuilder_var aStudyBuilder = aStudy->NewBuilder();
713   SALOMEDS::GenericAttribute_wrap anAttr =
714     aStudyBuilder->FindOrCreateAttribute(aSO, "AttributePythonObject");
715
716   SALOMEDS::AttributePythonObject_var pyAttr =
717     SALOMEDS::AttributePythonObject::_narrow(anAttr);
718   CORBA::String_var oldValue = pyAttr->GetObject();
719   TCollection_AsciiString aSavedTrace (oldValue.in());
720
721   // Add trace of API methods calls and replace study entries by names
722   TCollection_AsciiString aScript;
723   aScript += DumpPython_impl(aStudy, aMap, aMapNames, isPublished, isMultiFile,
724                              myIsHistoricalPythonDump, isValidScript, aSavedTrace);
725
726   int aLen = aScript.Length();
727   unsigned char* aBuffer = new unsigned char[aLen+1];
728   strcpy((char*)aBuffer, aScript.ToCString());
729
730   CORBA::Octet* anOctetBuf =  (CORBA::Octet*)aBuffer;
731   Engines::TMPFile_var aStreamFile = new Engines::TMPFile(aLen+1, aLen+1, anOctetBuf, 1);
732
733   bool hasNotPublishedObjects = aScript.Location( SMESH::theNotPublishedObjectName, 1, aLen);
734   isValidScript = isValidScript && !hasNotPublishedObjects;
735
736   return aStreamFile._retn();
737 }
738
739 //=============================================================================
740 /*!
741  *  AddToPythonScript
742  */
743 //=============================================================================
744 void SMESH_Gen_i::AddToPythonScript (int theStudyID, const TCollection_AsciiString& theString)
745 {
746   if (myPythonScripts.find(theStudyID) == myPythonScripts.end()) {
747     myPythonScripts[theStudyID] = new TColStd_HSequenceOfAsciiString;
748   }
749   myPythonScripts[theStudyID]->Append(theString);
750 }
751
752 //=============================================================================
753 /*!
754  *  RemoveLastFromPythonScript
755  */
756 //=============================================================================
757 void SMESH_Gen_i::RemoveLastFromPythonScript (int theStudyID)
758 {
759   if (myPythonScripts.find(theStudyID) != myPythonScripts.end()) {
760     int aLen = myPythonScripts[theStudyID]->Length();
761     myPythonScripts[theStudyID]->Remove(aLen);
762   }
763 }
764
765 //=======================================================================
766 //function : SavePython
767 //purpose  :
768 //=======================================================================
769 void SMESH_Gen_i::SavePython (SALOMEDS::Study_ptr theStudy)
770 {
771   // Dump trace of API methods calls
772   TCollection_AsciiString aScript = GetNewPythonLines(theStudy->StudyId());
773
774   // Check contents of PythonObject attribute
775   CORBA::String_var compDataType = ComponentDataType();
776   SALOMEDS::SObject_wrap aSO = theStudy->FindComponent( compDataType.in() );
777   SALOMEDS::StudyBuilder_var aStudyBuilder = theStudy->NewBuilder();
778   SALOMEDS::GenericAttribute_wrap anAttr =
779     aStudyBuilder->FindOrCreateAttribute(aSO, "AttributePythonObject");
780
781   SALOMEDS::AttributePythonObject_var pyAttr =
782     SALOMEDS::AttributePythonObject::_narrow(anAttr);
783   CORBA::String_var oldValue = pyAttr->GetObject();
784   TCollection_AsciiString oldScript (oldValue.in());
785
786   if (oldScript.Length() > 0) {
787     oldScript += "\n";
788     oldScript += aScript;
789   } else {
790     oldScript = aScript;
791   }
792
793   // Store in PythonObject attribute
794   pyAttr->SetObject(oldScript.ToCString(), 1);
795
796   // Clean trace of API methods calls
797   CleanPythonTrace(theStudy->StudyId());
798 }
799
800
801 // impl
802
803
804 //=============================================================================
805 /*!
806  *  FindEntries: Returns a sequence of start/end positions of entries in the string
807  */
808 //=============================================================================
809 Handle(TColStd_HSequenceOfInteger) FindEntries (TCollection_AsciiString& theString)
810 {
811   Handle(TColStd_HSequenceOfInteger) aSeq = new TColStd_HSequenceOfInteger;
812   Standard_Integer aLen = theString.Length();
813   Standard_Boolean isFound = Standard_False;
814
815   char* arr = (char*) theString.ToCString();
816   Standard_Integer i = 0, j;
817
818   while(i < aLen) {
819     int c = (int)arr[i];
820     j = i+1;
821     if ( isdigit( c )) { //Is digit?
822
823       isFound = Standard_False;
824       while((j < aLen) && ( isdigit(c) || c == ':' )) { //Check if it is an entry
825         c = (int)arr[j++];
826         if(c == ':') isFound = Standard_True;
827       }
828
829       if (isFound) {
830         int prev = (i < 1) ? 0 : (int)arr[i - 1];
831         // to distinguish from a sketcher command:
832         // last char should be a digit, not ":",
833         // previous char should not be '"'.
834         if (arr[j-2] != ':' && prev != '"') {
835           aSeq->Append(i+1); // +1 because AsciiString starts from 1
836           aSeq->Append(j-1);
837         }
838       }
839     }
840
841     i = j;
842   }
843
844   return aSeq;
845 }
846
847 namespace {
848
849   //================================================================================
850   /*!
851    * \brief Make a string be a valid python name
852     * \param aName - a string to fix
853     * \retval bool - true if aName was not modified
854    */
855   //================================================================================
856
857   bool fixPythonName(TCollection_AsciiString & aName)
858   {
859     bool isValidName = true;
860     int nbUnderscore = 0;
861     int p;
862     // replace not allowed chars by underscore
863     const char* name = aName.ToCString();
864     for ( p = 0; name[p]; ++p ) {
865       if ( !isalnum( name[p] ) && name[p] != '_' )
866       {
867         if ( p == 0 || p+1 == aName.Length() || name[p-1] == '_')
868         {
869           aName.Remove( p+1, 1 ); // remove __ and _ from the start and the end
870           --p;
871           name = aName.ToCString();
872         }
873         else
874         {
875           aName.SetValue( p+1, '_');
876           nbUnderscore++;
877         }
878         isValidName = false;
879       }
880     }
881     // aName must not start with a digit
882     if ( aName.IsIntegerValue() ) {
883       aName.Insert( 1, 'a' );
884       isValidName = false;
885     }
886     // shorten names like CartesianParameters3D_400_400_400_1000000_1
887     const int nbAllowedUnderscore = 3; /* changed from 2 to 3 by an user request
888                                           posted to SALOME Forum */
889     if ( aName.Length() > 20 && nbUnderscore > nbAllowedUnderscore )
890     {
891       p = aName.Location( "_", 20, aName.Length());
892       if ( p > 1 )
893         aName.Trunc( p-1 );
894     }
895     return isValidName;
896   }
897
898   //================================================================================
899   /*!
900    * \brief Return Python module names of available plug-ins.
901    */
902   //================================================================================
903
904   std::vector<std::string> getPluginNames()
905   {
906     std::vector<std::string> pluginNames;
907     std::vector< std::string > xmlPaths = SMESH_Gen::GetPluginXMLPaths();
908     LDOMParser xmlParser;
909     for ( size_t i = 0; i < xmlPaths.size(); ++i )
910     {
911       bool error = xmlParser.parse( xmlPaths[i].c_str() );
912       if ( error )
913       {
914         TCollection_AsciiString data;
915         INFOS( xmlParser.GetError(data) );
916         continue;
917       }
918       // <meshers-group name="Standard Meshers"
919       //                resources="StdMeshers"
920       //                idl-module="StdMeshers"
921       //                server-lib="StdMeshersEngine"
922       //                gui-lib="StdMeshersGUI">
923       LDOM_Document xmlDoc   = xmlParser.getDocument();
924       LDOM_NodeList nodeList = xmlDoc.getElementsByTagName( "meshers-group" );
925       for ( int i = 0; i < nodeList.getLength(); ++i )
926       {
927         LDOM_Node       node = nodeList.item( i );
928         LDOM_Element&   elem = (LDOM_Element&) node;
929         LDOMString idlModule = elem.getAttribute( "idl-module" );
930         if ( strlen( idlModule.GetString() ) > 0 )
931           pluginNames.push_back( idlModule.GetString() );
932       }
933     }
934     return pluginNames;
935   }
936 }
937
938 //================================================================================
939 /*!
940  * \brief Createa a Dump Python script
941  *  \param [in] theStudy - the study to dump
942  *  \param [in,out] theObjectNames - map of an entry to a study and python name
943  *  \param [in] theNames -  - map of an entry to a study name
944  *  \param [in] isPublished - \c true if dump of object publication in study is needed
945  *  \param [in] isMultiFile - \c true if dump of each module goes to a separate file
946  *  \param [in] isHistoricalDump - \c true if removed object should be dumped
947  *  \param [out] aValidScript - returns \c true if the returned script seems valid
948  *  \param [in,out] theSavedTrace - the dump stored in the study. It's cleared to
949  *         decrease memory usage.
950  *  \return TCollection_AsciiString - the result dump script.
951  */
952 //================================================================================
953
954 TCollection_AsciiString SMESH_Gen_i::DumpPython_impl
955                         (SALOMEDS::Study_ptr                       theStudy,
956                          Resource_DataMapOfAsciiStringAsciiString& theObjectNames,
957                          Resource_DataMapOfAsciiStringAsciiString& theNames,
958                          bool                                      isPublished,
959                          bool                                      isMultiFile,
960                          bool                                      isHistoricalDump,
961                          bool&                                     aValidScript,
962                          TCollection_AsciiString&                  theSavedTrace)
963 {
964   SMESH_TRY;
965   const int aStudyID = theStudy->StudyId();
966
967   const TCollection_AsciiString aSmeshpy ( SMESH_2smeshpy::SmeshpyName() );
968   const TCollection_AsciiString aSMESHGen( SMESH_2smeshpy::GenName() );
969   const TCollection_AsciiString anOldGen ( SMESH::TPythonDump::SMESHGenName() );
970   const TCollection_AsciiString helper; // to comfortably append C strings to TCollection_AsciiString
971   const TCollection_AsciiString tab( isMultiFile ? "\t" : "" ), nt = helper + "\n" + tab;
972
973   std::list< TCollection_AsciiString > lines; // lines of a script
974   std::list< TCollection_AsciiString >::iterator linesIt;
975   
976   if ( isPublished )
977     lines.push_back(  aSMESHGen + " = smeshBuilder.New(theStudy)" );
978    else
979     lines.push_back(  aSMESHGen + " = smeshBuilder.New(None)" );
980   lines.push_back( helper + "aFilterManager = " + aSMESHGen + ".CreateFilterManager()" );
981   lines.push_back( helper + "aMeasurements = "  + aSMESHGen + ".CreateMeasurements()" );
982
983   // Treat dump trace of restored study
984   if (theSavedTrace.Length() > 0)
985   {
986     linesIt = --lines.end();
987     // Split theSavedTrace into lines
988     int from = 1, end = theSavedTrace.Length(), to;
989     while ( from < end && ( to = theSavedTrace.Location( "\n", from, end )))
990     {
991       if ( theSavedTrace.ToCString()[from-1] == '\t' )
992         ++from;
993       if ( to != from )
994         lines.push_back( theSavedTrace.SubString( from, to - 1 ));
995       from = to + 1;
996     }
997     // For the convertion of IDL API calls -> smeshBuilder.py API, "smesh" standing for SMESH_Gen
998     // was replaces with "smeshgen" (==TPythonDump::SMESHGenName()).
999     // Change "smesh" -> "smeshgen" in the trace saved before passage to smeshBuilder.py API
1000     bool isNewVersion =
1001       theSavedTrace.Location( anOldGen + ".", 1, theSavedTrace.Length() );
1002     theSavedTrace.Clear();
1003     if ( !isNewVersion )
1004     {
1005       const TCollection_AsciiString aSmeshCall ( "smesh." ), gen( "gen" );
1006       int beg, end, from;
1007       for ( ++linesIt; linesIt != lines.end(); ++linesIt )
1008       {
1009         TCollection_AsciiString& aSavedLine = *linesIt;
1010         end = aSavedLine.Length(), from = 1;
1011         while ( from < end && ( beg = aSavedLine.Location( aSmeshCall, from, end )))
1012         {
1013           char charBefore = ( beg == 1 ) ? ' ' : aSavedLine.Value( beg - 1 );
1014           if ( isspace( charBefore ) || charBefore == '=' ) { // "smesh." is not a part of a long word
1015             aSavedLine.Insert( beg + aSmeshCall.Length() - 1, gen );// "smesh" -> "smeshgen"
1016             end += gen.Length();
1017           }
1018           from = beg + aSmeshCall.Length();
1019         }
1020       }
1021     }
1022   }
1023
1024   // Add new dump trace of API methods calls to script lines
1025   if (myPythonScripts.find( aStudyID ) != myPythonScripts.end())
1026   {
1027     Handle(TColStd_HSequenceOfAsciiString) aPythonScript = myPythonScripts[ aStudyID ];
1028     Standard_Integer istr, aLen = aPythonScript->Length();
1029     for (istr = 1; istr <= aLen; istr++)
1030       lines.push_back( aPythonScript->Value( istr ));
1031   }
1032
1033   // Convert IDL API calls into smeshBuilder.py API.
1034   // Some objects are wrapped with python classes and
1035   // Resource_DataMapOfAsciiStringAsciiString holds methods returning wrapped objects
1036   Resource_DataMapOfAsciiStringAsciiString anEntry2AccessorMethod;
1037   std::set< TCollection_AsciiString >      aRemovedObjIDs;
1038   if ( !getenv("NO_2smeshpy_conversion"))
1039     SMESH_2smeshpy::ConvertScript( lines, anEntry2AccessorMethod,
1040                                    theObjectNames, aRemovedObjIDs,
1041                                    theStudy, isHistoricalDump );
1042
1043   bool importGeom = false;
1044   GEOM::GEOM_Gen_ptr geom = GetGeomEngine();
1045   {
1046     // Add names of GEOM objects to theObjectNames to exclude same names of SMESH objects
1047     GEOM::string_array_var aGeomNames = geom->GetAllDumpNames();
1048     int ign = 0, nbgn = aGeomNames->length();
1049     for (; ign < nbgn; ign++) {
1050       TCollection_AsciiString aName = aGeomNames[ign].in();
1051       theObjectNames.Bind(aName, "1");
1052     }
1053   }
1054
1055   TCollection_AsciiString anUpdatedScript;
1056
1057   Resource_DataMapOfAsciiStringAsciiString mapRemoved;
1058   Resource_DataMapOfAsciiStringAsciiString mapEntries; // names and entries present in anUpdatedScript
1059   Standard_Integer objectCounter = 0;
1060   TCollection_AsciiString anEntry, aName, aGUIName, aBaseName("smeshObj_");
1061
1062   // Treat every script line and add it to anUpdatedScript
1063   for ( linesIt = lines.begin(); linesIt != lines.end(); ++linesIt )
1064   {
1065     TCollection_AsciiString& aLine = *linesIt;
1066     anUpdatedScript += tab;
1067     {
1068       //Replace characters used instead of quote marks to quote notebook variables
1069       int pos = 1;
1070       while (( pos = aLine.Location( 1, SMESH::TVar::Quote(), pos, aLine.Length() )))
1071         aLine.SetValue( pos, '"' );
1072     }
1073     // Find entries to be replaced by names
1074     Handle(TColStd_HSequenceOfInteger) aSeq = FindEntries(aLine);
1075     const Standard_Integer aSeqLen = aSeq->Length();
1076     Standard_Integer aStart = 1;
1077     for (Standard_Integer i = 1; i <= aSeqLen; i += 2)
1078     {
1079       if ( aStart < aSeq->Value(i) )
1080         anUpdatedScript += aLine.SubString( aStart, aSeq->Value(i) - 1 ); // line part before i-th entry
1081       anEntry = aLine.SubString( aSeq->Value(i), aSeq->Value(i + 1) );
1082       // is a GEOM object?
1083       CORBA::String_var geomName = geom->GetDumpName( anEntry.ToCString() );
1084       if ( !geomName.in() || !geomName.in()[0] ) {
1085         // is a SMESH object
1086         if ( theObjectNames.IsBound( anEntry )) {
1087           // The Object is in Study
1088           aName = theObjectNames.Find( anEntry );
1089           // check validity of aName
1090           bool isValidName = fixPythonName( aName );
1091           if (theObjectNames.IsBound(aName) && anEntry != theObjectNames(aName)) {
1092             // diff objects have same name - make a new name by appending a digit
1093             TCollection_AsciiString aName2;
1094             Standard_Integer i = 0;
1095             do {
1096               aName2 = aName + "_" + ++i;
1097             } while (theObjectNames.IsBound(aName2) && anEntry != theObjectNames(aName2));
1098             aName = aName2;
1099             isValidName = false;
1100           }
1101           if ( !isValidName )
1102             theObjectNames(anEntry) = aName;
1103
1104           if ( aLine.Value(1) != '#' )
1105             mapEntries.Bind(anEntry, aName);
1106         }
1107         else
1108         {
1109           // Removed Object
1110           do {
1111             aName = aBaseName + (++objectCounter);
1112           } while (theObjectNames.IsBound(aName));
1113
1114           if ( !aRemovedObjIDs.count( anEntry ) && aLine.Value(1) != '#')
1115             mapRemoved.Bind(anEntry, aName);
1116
1117           theObjectNames.Bind(anEntry, aName);
1118         }
1119         theObjectNames.Bind(aName, anEntry); // to detect same name of diff objects
1120       }
1121       else
1122       {
1123         aName = geomName.in();
1124         importGeom = true;
1125       }
1126       anUpdatedScript += aName;
1127       aStart = aSeq->Value(i + 1) + 1;
1128
1129     } // loop on entries within aLine
1130
1131     if ( aSeqLen == 0 )
1132       anUpdatedScript += aLine;
1133     else if ( aSeq->Value( aSeqLen ) < aLine.Length() )
1134       anUpdatedScript += aLine.SubString( aSeq->Value(aSeqLen) + 1, aLine.Length() );
1135
1136     anUpdatedScript += '\n';
1137   }
1138
1139   // Make an initial part of aSript
1140
1141   TCollection_AsciiString initPart = "import ";
1142   if ( isMultiFile )
1143     initPart += "salome, ";
1144   initPart += " SMESH, SALOMEDS\n";
1145   initPart += "from salome.smesh import smeshBuilder\n";
1146   if ( importGeom && isMultiFile )
1147   {
1148     initPart += ("\n## import GEOM dump file ## \n"
1149                  "import string, os, sys, re\n"
1150                  "sys.path.insert( 0, os.path.dirname(__file__) )\n"
1151                  "exec(\"from \"+re.sub(\"SMESH$\",\"GEOM\",__name__)+\" import *\")\n");
1152   }
1153   // import python files corresponding to plugins if they are used in anUpdatedScript
1154   {
1155     TCollection_AsciiString importStr;
1156     std::vector<std::string> pluginNames = getPluginNames();
1157     for ( size_t i = 0; i < pluginNames.size(); ++i )
1158     {
1159       // Convert access to plugin members:
1160       // e.g. StdMeshers.QUAD_REDUCED -> StdMeshersBuilder.QUAD_REDUCED
1161       TCollection_AsciiString pluginAccess = (pluginNames[i] + ".").c_str() ;
1162       int iFrom = 1, iPos;
1163       while (( iPos = anUpdatedScript.Location( pluginAccess, iFrom, anUpdatedScript.Length() )))
1164       {
1165         anUpdatedScript.Insert( iPos + pluginNames[i].size(), "Builder" );
1166         iFrom = iPos + pluginNames[i].size() + 8;
1167       }
1168       // if any plugin member is used, import the plugin
1169       if ( iFrom > 1 )
1170         importStr += ( helper + "\n" "from salome." + pluginNames[i].c_str() +
1171                        " import " + pluginNames[i].c_str() +"Builder" );
1172     }
1173     if ( !importStr.IsEmpty() )
1174       initPart += importStr + "\n";
1175   }
1176
1177   if( isMultiFile )
1178     initPart += "def RebuildData(theStudy):";
1179   initPart += "\n";
1180
1181   anUpdatedScript.Prepend( initPart );
1182
1183   // Make a final part of aScript
1184
1185   // Dump object removal
1186   TCollection_AsciiString removeObjPart;
1187   if ( !mapRemoved.IsEmpty() ) {
1188     removeObjPart += nt + "## some objects were removed";
1189     removeObjPart += nt + "aStudyBuilder = theStudy.NewBuilder()";
1190     Resource_DataMapIteratorOfDataMapOfAsciiStringAsciiString mapRemovedIt;
1191     for ( mapRemovedIt.Initialize( mapRemoved ); mapRemovedIt.More(); mapRemovedIt.Next() ) {
1192       aName   = mapRemovedIt.Value(); // python name
1193       anEntry = mapRemovedIt.Key();
1194       removeObjPart += nt + "SO = theStudy.FindObjectIOR(theStudy.ConvertObjectToIOR(";
1195       removeObjPart += aName;
1196       // for object wrapped by class of smeshBuilder.py
1197       if ( anEntry2AccessorMethod.IsBound( anEntry ) )
1198         removeObjPart += helper + "." + anEntry2AccessorMethod( anEntry );
1199       removeObjPart += helper + "))" + nt + "if SO: aStudyBuilder.RemoveObjectWithChildren(SO)";
1200     }
1201   }
1202
1203   // Set object names
1204   TCollection_AsciiString setNamePart;
1205   Resource_DataMapIteratorOfDataMapOfAsciiStringAsciiString mapEntriesIt;
1206   for ( mapEntriesIt.Initialize( mapEntries ); mapEntriesIt.More(); mapEntriesIt.Next() )
1207   {
1208     anEntry = mapEntriesIt.Key();
1209     aName   = mapEntriesIt.Value(); // python name
1210     if ( theNames.IsBound( anEntry ))
1211     {
1212       aGUIName = theNames.Find(anEntry);
1213       aGUIName.RemoveAll('\''); // remove a quote from a name (issue 22360)
1214       setNamePart += nt + aSMESHGen + ".SetName(" + aName;
1215       if ( anEntry2AccessorMethod.IsBound( anEntry ) )
1216         setNamePart += helper + "." + anEntry2AccessorMethod( anEntry );
1217       setNamePart += helper + ", '" + aGUIName + "')";
1218     }
1219   }
1220   if ( !setNamePart.IsEmpty() )
1221   {
1222     setNamePart.Insert( 1, nt + "## Set names of Mesh objects" );
1223   }
1224
1225   // Store visual properties of displayed objects
1226
1227   TCollection_AsciiString visualPropertiesPart;
1228   if (isPublished)
1229   {
1230     //Output the script that sets up the visual parameters.
1231     CORBA::String_var compDataType = ComponentDataType();
1232     CORBA::String_var script = theStudy->GetDefaultScript( compDataType.in(), tab.ToCString() );
1233     if ( script.in() && script.in()[0] ) {
1234       visualPropertiesPart += nt + "### Store presentation parameters of displayed objects\n";
1235       visualPropertiesPart += script.in();
1236     }
1237   }
1238
1239   anUpdatedScript += removeObjPart + '\n' + setNamePart + '\n' + visualPropertiesPart;
1240
1241   if( isMultiFile )
1242     anUpdatedScript += "\n\tpass";
1243   anUpdatedScript += "\n";
1244
1245   // no need now as we use 'tab' and 'nt' variables depending on isMultiFile
1246   // if( !isMultiFile ) // remove unnecessary tabulation
1247   //   RemoveTabulation( anUpdatedScript );
1248
1249   // -----------------------------------------------------------------
1250   // put string literals describing patterns into separate functions
1251   // -----------------------------------------------------------------
1252
1253   TCollection_AsciiString aLongString, aFunctionType;
1254   int where = 1;
1255   set< string > functionNameSet;
1256   while ( SMESH::TPythonDump::CutoutLongString( anUpdatedScript, where, aLongString, aFunctionType ))
1257   {
1258     // make a python string literal
1259     aLongString.Prepend(":\n\treturn '''\n");
1260     aLongString += "\n\t'''\n\tpass\n";
1261
1262     TCollection_AsciiString functionName;
1263
1264     // check if the function returning this literal is already defined
1265     int posAlready = anUpdatedScript.Location( aLongString, where, anUpdatedScript.Length() );
1266     if ( posAlready ) // already defined
1267     {
1268       // find the function name
1269       int functBeg = posAlready;
1270       char* script = (char*) anUpdatedScript.ToCString() + posAlready - 1; // look at ":" after "def fuction()"
1271       while ( *script != ' ' ) {
1272         script--;
1273         functBeg--;
1274       }
1275       functBeg++; // do not take ' '
1276       posAlready--; // do not take ':'
1277       functionName = anUpdatedScript.SubString( functBeg, posAlready );
1278     }
1279     else // not defined yet
1280     {
1281       // find a unique function name
1282       fixPythonName( aFunctionType );
1283       Standard_Integer nb = 0;
1284       do functionName = aFunctionType + "_" + ( nb++ ) + "()";
1285       while ( !functionNameSet.insert( functionName.ToCString() ).second );
1286
1287       // define function
1288       TCollection_AsciiString funDef = helper + "def " + functionName + aLongString;
1289       if ( isMultiFile )
1290       {
1291         anUpdatedScript += helper + "\n\n" + funDef;
1292       }
1293       else
1294       {
1295         funDef += "\n\n";
1296         anUpdatedScript.Insert( 1, funDef);
1297         where += funDef.Length();
1298       }
1299     }
1300     anUpdatedScript.InsertBefore( where, functionName ); // call function
1301   }
1302
1303   aValidScript = true;
1304
1305   return anUpdatedScript;
1306
1307   SMESH_CATCH( SMESH::printException );
1308
1309   aValidScript = false;
1310   return "";
1311 }
1312
1313 //=============================================================================
1314 /*!
1315  *  GetNewPythonLines
1316  */
1317 //=============================================================================
1318 TCollection_AsciiString SMESH_Gen_i::GetNewPythonLines (int theStudyID)
1319 {
1320   TCollection_AsciiString aScript;
1321
1322   // Dump trace of API methods calls
1323   if (myPythonScripts.find(theStudyID) != myPythonScripts.end()) {
1324     Handle(TColStd_HSequenceOfAsciiString) aPythonScript = myPythonScripts[theStudyID];
1325     Standard_Integer istr, aLen = aPythonScript->Length();
1326     for (istr = 1; istr <= aLen; istr++) {
1327       aScript += "\n";
1328       aScript += aPythonScript->Value(istr);
1329     }
1330     aScript += "\n";
1331   }
1332
1333   return aScript;
1334 }
1335
1336 //=============================================================================
1337 /*!
1338  *  CleanPythonTrace
1339  */
1340 //=============================================================================
1341 void SMESH_Gen_i::CleanPythonTrace (int theStudyID)
1342 {
1343   TCollection_AsciiString aScript;
1344
1345   // Clean trace of API methods calls
1346   if (myPythonScripts.find(theStudyID) != myPythonScripts.end()) {
1347     myPythonScripts[theStudyID]->Clear();
1348   }
1349 }