Salome HOME
22806: EDF SMESH: Regression: Prism_3D error
[modules/smesh.git] / src / SMESH_I / SMESH_DumpPython.cxx
1 // Copyright (C) 2007-2014  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_BelongToGeom:          myStream<< "aBelongToGeom";          break;
427       case FT_BelongToPlane:         myStream<< "aBelongToPlane";         break;
428       case FT_BelongToCylinder:      myStream<< "aBelongToCylinder";      break;
429       case FT_BelongToGenSurface:    myStream<< "aBelongToGenSurface";    break;
430       case FT_LyingOnGeom:           myStream<< "aLyingOnGeom";           break;
431       case FT_RangeOfIds:            myStream<< "aRangeOfIds";            break;
432       case FT_BadOrientedVolume:     myStream<< "aBadOrientedVolume";     break;
433       case FT_BareBorderVolume:      myStream<< "aBareBorderVolume";      break;
434       case FT_BareBorderFace:        myStream<< "aBareBorderFace";        break;
435       case FT_OverConstrainedVolume: myStream<< "aOverConstrainedVolume"; break;
436       case FT_OverConstrainedFace:   myStream<< "aOverConstrainedFace";   break;
437       case FT_LinearOrQuadratic:     myStream<< "aLinearOrQuadratic";     break;
438       case FT_GroupColor:            myStream<< "aGroupColor";            break;
439       case FT_ElemGeomType:          myStream<< "aElemGeomType";          break;
440       case FT_EntityType:            myStream<< "aEntityType";            break;
441       case FT_CoplanarFaces:         myStream<< "aCoplanarFaces";         break;
442       case FT_BallDiameter:          myStream<< "aBallDiameter";          break;
443       case FT_ConnectedElements:     myStream<< "aConnectedElements";     break;
444       case FT_LessThan:              myStream<< "aLessThan";              break;
445       case FT_MoreThan:              myStream<< "aMoreThan";              break;
446       case FT_EqualTo:               myStream<< "aEqualTo";               break;
447       case FT_LogicalNOT:            myStream<< "aLogicalNOT";            break;
448       case FT_LogicalAND:            myStream<< "aLogicalAND";            break;
449       case FT_LogicalOR:             myStream<< "aLogicalOR";             break;
450       case FT_Undefined:
451       default:                       myStream<< "anUndefined";            break;
452       }
453       myStream<<theArg;
454     }
455     return *this;
456   }
457
458   TPythonDump&
459   TPythonDump::
460   operator<<(SMESH::Measurements_i* theArg)
461   {
462     myStream<<"aMeasurements";
463     return *this;
464   }
465
466
467   TPythonDump& TPythonDump:: operator<<(SMESH_Gen_i* theArg)
468   {
469     myStream << SMESHGenName(); return *this;
470   }
471
472   TPythonDump& TPythonDump::operator<<(SMESH_MeshEditor_i* theArg)
473   {
474     myStream << MeshEditorName() << "_" << ( theArg ? theArg->GetMeshId() : -1 ); return *this;
475   }
476
477   TPythonDump& TPythonDump::operator<<(const TCollection_AsciiString & theStr)
478   {
479     myStream << theStr; return *this;
480   }
481
482
483   TPythonDump& TPythonDump::operator<<(SMESH::MED_VERSION theVersion)
484   {
485     switch (theVersion) {
486     case SMESH::MED_V2_1: myStream << "SMESH.MED_V2_1"; break;
487     case SMESH::MED_V2_2: myStream << "SMESH.MED_V2_2"; break;
488     default: myStream << theVersion;
489     }
490     return *this;
491   }
492
493   TPythonDump& TPythonDump::operator<<(const SMESH::AxisStruct & theAxis)
494   {
495     *this << "SMESH.AxisStruct( "
496           << TVar( theAxis.x  ) << ", "
497           << TVar( theAxis.y  ) << ", "
498           << TVar( theAxis.z  ) << ", "
499           << TVar( theAxis.vx ) << ", "
500           << TVar( theAxis.vy ) << ", "
501           << TVar( theAxis.vz ) << " )";
502     return *this;
503   }
504
505   TPythonDump& TPythonDump::operator<<(const SMESH::DirStruct & theDir)
506   {
507     const SMESH::PointStruct & P = theDir.PS;
508     *this << "SMESH.DirStruct( SMESH.PointStruct ( "
509           << TVar( P.x ) << ", "
510           << TVar( P.y ) << ", "
511           << TVar( P.z ) << " ))";
512     return *this;
513   }
514
515   TPythonDump& TPythonDump::operator<<(const SMESH::PointStruct & P)
516   {
517     *this << "SMESH.PointStruct ( "
518           << TVar( P.x ) << ", "
519           << TVar( P.y ) << ", "
520           << TVar( P.z ) << " )";
521     return *this;
522   }
523
524   TPythonDump& TPythonDump::operator<<(const SMESH::ListOfGroups& theList)
525   {
526     DumpArray( theList, *this );
527     return *this;
528   }
529   TPythonDump& TPythonDump::operator<<(const SMESH::ListOfGroups * theList)
530   {
531     DumpArray( *theList, *this );
532     return *this;
533   }
534   TPythonDump& TPythonDump::operator<<(const GEOM::ListOfGO& theList)
535   {
536     DumpArray( theList, *this );
537     return *this;
538   }
539   TPythonDump& TPythonDump::operator<<(const GEOM::ListOfGBO& theList)
540   {
541     DumpArray( theList, *this );
542     return *this;
543   }
544   TPythonDump& TPythonDump::operator<<(const SMESH::ListOfIDSources& theList)
545   {
546     DumpArray( theList, *this );
547     return *this;
548   }
549   const char* TPythonDump::NotPublishedObjectName()
550   {
551     return theNotPublishedObjectName;
552   }
553
554   TCollection_AsciiString myLongStringStart( "TPythonDump::LongStringStart" );
555   TCollection_AsciiString myLongStringEnd  ( "TPythonDump::LongStringEnd" );
556
557   //================================================================================
558   /*!
559    * \brief Return marker of long string literal beginning
560    * \param type - a name of functionality producing the string literal
561    * \retval TCollection_AsciiString - the marker string to be written into
562    * a raw python script
563    */
564   //================================================================================
565
566   TCollection_AsciiString TPythonDump::LongStringStart(const char* type)
567   {
568     return
569       myLongStringStart +
570       (Standard_Integer) strlen(type) +
571       " " +
572       (char*) type;
573   }
574
575   //================================================================================
576   /*!
577      * \brief Return marker of long string literal end
578       * \retval TCollection_AsciiString - the marker string to be written into
579       * a raw python script
580    */
581   //================================================================================
582
583   TCollection_AsciiString TPythonDump::LongStringEnd()
584   {
585     return myLongStringEnd;
586   }
587
588   //================================================================================
589   /*!
590      * \brief Cut out a long string literal from a string
591       * \param theText - text possibly containing string literals
592       * \param theFrom - position in the text to search from
593       * \param theLongString - the retrieved literal
594       * \param theStringType - a name of functionality produced the literal
595       * \retval bool - true if a string literal found
596      *
597      * The literal is removed from theText; theFrom points position right after
598      * the removed literal
599    */
600   //================================================================================
601
602   bool  TPythonDump::CutoutLongString( TCollection_AsciiString & theText,
603                                        int                     & theFrom,
604                                        TCollection_AsciiString & theLongString,
605                                        TCollection_AsciiString & theStringType)
606   {
607     if ( theFrom < 1 || theFrom > theText.Length() )
608       return false;
609
610     // ...script \  beg marker    \ \ type \       literal              \  end marker  \ script...
611     //  "theText myLongStringStart7 Pattern!!! SALOME Mesh Pattern file myLongStringEndtextEnd"
612     //  012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789
613     //  0         1         2         3         4         5         6         7         8
614
615     theFrom = theText.Location( myLongStringStart, theFrom, theText.Length() ); // = 09
616     if ( !theFrom )
617       return false;
618
619     // find where literal begins
620     int literalBeg = theFrom + myLongStringStart.Length(); // = 26
621     char* typeLenStr = (char*) theText.ToCString() + literalBeg - 1; // = "7 Pattern!!! SALO...."
622     int typeLen = atoi ( typeLenStr ); // = 7
623     while ( *typeLenStr != ' ' ) { // look for ' ' after typeLen
624       literalBeg++; // 26 -> 27
625       typeLenStr++;
626     }
627     literalBeg += typeLen + 1; // = 35
628     if ( literalBeg > theText.Length() )
629       return false;
630
631     // where literal ends (i.e. end marker begins)
632     int literalEnd = theText.Location( myLongStringEnd, literalBeg, theText.Length() ); // = 64
633     if ( !literalEnd )
634       literalEnd = theText.Length();
635
636     // literal
637     theLongString = theText.SubString( literalBeg, literalEnd - 1); // "!!! SALOME Mesh Pattern file "
638     // type
639     theStringType = theText.SubString( literalBeg - typeLen, literalBeg - 1 ); // "Pattern"
640     // cut off literal
641     literalEnd += myLongStringEnd.Length(); // = 79
642     TCollection_AsciiString textEnd = theText.SubString( literalEnd, theText.Length() ); // "textE..."
643     theText = theText.SubString( 1, theFrom - 1 ) + textEnd;
644
645     return true;
646   }
647
648   void printException( const char* text )
649   {
650 #ifdef _DEBUG_
651     cout << "Exception in SMESH_Gen_i::DumpPython(): " << text << endl;
652 #endif
653   }
654 }
655
656 //=======================================================================
657 //function : RemoveTabulation
658 //purpose  : 
659 //=======================================================================
660 void RemoveTabulation( TCollection_AsciiString& theScript )
661 {
662   std::string aString( theScript.ToCString() );
663   std::string::size_type aPos = 0;
664   while( aPos < aString.length() )
665   {
666     aPos = aString.find( "\n\t", aPos );
667     if( aPos == std::string::npos )
668       break;
669     aString.replace( aPos, 2, "\n" );
670     aPos++;
671   }
672   theScript = aString.c_str();
673 }
674
675 //=======================================================================
676 //function : DumpPython
677 //purpose  :
678 //=======================================================================
679 Engines::TMPFile* SMESH_Gen_i::DumpPython (CORBA::Object_ptr theStudy,
680                                            CORBA::Boolean isPublished,
681                                            CORBA::Boolean isMultiFile,
682                                            CORBA::Boolean& isValidScript)
683 {
684   SALOMEDS::Study_var aStudy = SALOMEDS::Study::_narrow(theStudy);
685   if (CORBA::is_nil(aStudy))
686     return new Engines::TMPFile(0);
687
688   CORBA::String_var compDataType = ComponentDataType();
689   SALOMEDS::SObject_wrap aSO = aStudy->FindComponent( compDataType.in() );
690   if (CORBA::is_nil(aSO))
691     return new Engines::TMPFile(0);
692
693   // Map study entries to object names
694   Resource_DataMapOfAsciiStringAsciiString aMap;
695   Resource_DataMapOfAsciiStringAsciiString aMapNames;
696
697   SALOMEDS::ChildIterator_wrap Itr = aStudy->NewChildIterator(aSO);
698   for (Itr->InitEx(true); Itr->More(); Itr->Next()) {
699     SALOMEDS::SObject_wrap aValue = Itr->Value();
700     CORBA::String_var anID = aValue->GetID();
701     CORBA::String_var aName = aValue->GetName();
702     TCollection_AsciiString aGUIName ( (char*) aName.in() );
703     TCollection_AsciiString anEntry ( (char*) anID.in() );
704     if (aGUIName.Length() > 0) {
705       aMapNames.Bind( anEntry, aGUIName );
706       aMap.Bind( anEntry, aGUIName );
707     }
708   }
709
710   // Get trace of restored study
711   SALOMEDS::StudyBuilder_var aStudyBuilder = aStudy->NewBuilder();
712   SALOMEDS::GenericAttribute_wrap anAttr =
713     aStudyBuilder->FindOrCreateAttribute(aSO, "AttributePythonObject");
714
715   SALOMEDS::AttributePythonObject_var pyAttr =
716     SALOMEDS::AttributePythonObject::_narrow(anAttr);
717   CORBA::String_var oldValue = pyAttr->GetObject();
718   TCollection_AsciiString aSavedTrace (oldValue.in());
719
720   // Add trace of API methods calls and replace study entries by names
721   TCollection_AsciiString aScript;
722   aScript += DumpPython_impl(aStudy, aMap, aMapNames, isPublished, isMultiFile,
723                              myIsHistoricalPythonDump, isValidScript, aSavedTrace);
724
725   int aLen = aScript.Length();
726   unsigned char* aBuffer = new unsigned char[aLen+1];
727   strcpy((char*)aBuffer, aScript.ToCString());
728
729   CORBA::Octet* anOctetBuf =  (CORBA::Octet*)aBuffer;
730   Engines::TMPFile_var aStreamFile = new Engines::TMPFile(aLen+1, aLen+1, anOctetBuf, 1);
731
732   bool hasNotPublishedObjects = aScript.Location( SMESH::theNotPublishedObjectName, 1, aLen);
733   isValidScript = isValidScript && !hasNotPublishedObjects;
734
735   return aStreamFile._retn();
736 }
737
738 //=============================================================================
739 /*!
740  *  AddToPythonScript
741  */
742 //=============================================================================
743 void SMESH_Gen_i::AddToPythonScript (int theStudyID, const TCollection_AsciiString& theString)
744 {
745   if (myPythonScripts.find(theStudyID) == myPythonScripts.end()) {
746     myPythonScripts[theStudyID] = new TColStd_HSequenceOfAsciiString;
747   }
748   myPythonScripts[theStudyID]->Append(theString);
749 }
750
751 //=============================================================================
752 /*!
753  *  RemoveLastFromPythonScript
754  */
755 //=============================================================================
756 void SMESH_Gen_i::RemoveLastFromPythonScript (int theStudyID)
757 {
758   if (myPythonScripts.find(theStudyID) != myPythonScripts.end()) {
759     int aLen = myPythonScripts[theStudyID]->Length();
760     myPythonScripts[theStudyID]->Remove(aLen);
761   }
762 }
763
764 //=======================================================================
765 //function : SavePython
766 //purpose  :
767 //=======================================================================
768 void SMESH_Gen_i::SavePython (SALOMEDS::Study_ptr theStudy)
769 {
770   // Dump trace of API methods calls
771   TCollection_AsciiString aScript = GetNewPythonLines(theStudy->StudyId());
772
773   // Check contents of PythonObject attribute
774   CORBA::String_var compDataType = ComponentDataType();
775   SALOMEDS::SObject_wrap aSO = theStudy->FindComponent( compDataType.in() );
776   SALOMEDS::StudyBuilder_var aStudyBuilder = theStudy->NewBuilder();
777   SALOMEDS::GenericAttribute_wrap anAttr =
778     aStudyBuilder->FindOrCreateAttribute(aSO, "AttributePythonObject");
779
780   SALOMEDS::AttributePythonObject_var pyAttr =
781     SALOMEDS::AttributePythonObject::_narrow(anAttr);
782   CORBA::String_var oldValue = pyAttr->GetObject();
783   TCollection_AsciiString oldScript (oldValue.in());
784
785   if (oldScript.Length() > 0) {
786     oldScript += "\n";
787     oldScript += aScript;
788   } else {
789     oldScript = aScript;
790   }
791
792   // Store in PythonObject attribute
793   pyAttr->SetObject(oldScript.ToCString(), 1);
794
795   // Clean trace of API methods calls
796   CleanPythonTrace(theStudy->StudyId());
797 }
798
799
800 // impl
801
802
803 //=============================================================================
804 /*!
805  *  FindEntries: Returns a sequence of start/end positions of entries in the string
806  */
807 //=============================================================================
808 Handle(TColStd_HSequenceOfInteger) FindEntries (TCollection_AsciiString& theString)
809 {
810   Handle(TColStd_HSequenceOfInteger) aSeq = new TColStd_HSequenceOfInteger;
811   Standard_Integer aLen = theString.Length();
812   Standard_Boolean isFound = Standard_False;
813
814   char* arr = (char*) theString.ToCString();
815   Standard_Integer i = 0, j;
816
817   while(i < aLen) {
818     int c = (int)arr[i];
819     j = i+1;
820     if ( isdigit( c )) { //Is digit?
821
822       isFound = Standard_False;
823       while((j < aLen) && ( isdigit(c) || c == ':' )) { //Check if it is an entry
824         c = (int)arr[j++];
825         if(c == ':') isFound = Standard_True;
826       }
827
828       if (isFound) {
829         int prev = (i < 1) ? 0 : (int)arr[i - 1];
830         // to distinguish from a sketcher command:
831         // last char should be a digit, not ":",
832         // previous char should not be '"'.
833         if (arr[j-2] != ':' && prev != '"') {
834           aSeq->Append(i+1); // +1 because AsciiString starts from 1
835           aSeq->Append(j-1);
836         }
837       }
838     }
839
840     i = j;
841   }
842
843   return aSeq;
844 }
845
846 namespace {
847
848   //================================================================================
849   /*!
850    * \brief Make a string be a valid python name
851     * \param aName - a string to fix
852     * \retval bool - true if aName was not modified
853    */
854   //================================================================================
855
856   bool fixPythonName(TCollection_AsciiString & aName)
857   {
858     bool isValidName = true;
859     int nbUnderscore = 0;
860     int p;
861     // replace not allowed chars by underscore
862     const char* name = aName.ToCString();
863     for ( p = 0; name[p]; ++p ) {
864       if ( !isalnum( name[p] ) && name[p] != '_' )
865       {
866         if ( p == 0 || p+1 == aName.Length() || name[p-1] == '_')
867         {
868           aName.Remove( p+1, 1 ); // remove __ and _ from the start and the end
869           --p;
870           name = aName.ToCString();
871         }
872         else
873         {
874           aName.SetValue( p+1, '_');
875           nbUnderscore++;
876         }
877         isValidName = false;
878       }
879     }
880     // aName must not start with a digit
881     if ( aName.IsIntegerValue() ) {
882       aName.Insert( 1, 'a' );
883       isValidName = false;
884     }
885     // shorten names like CartesianParameters3D_400_400_400_1000000_1
886     const int nbAllowedUnderscore = 3; /* changed from 2 to 3 by an user request
887                                           posted to SALOME Forum */
888     if ( aName.Length() > 20 && nbUnderscore > nbAllowedUnderscore )
889     {
890       p = aName.Location( "_", 20, aName.Length());
891       if ( p > 1 )
892         aName.Trunc( p-1 );
893     }
894     return isValidName;
895   }
896
897   //================================================================================
898   /*!
899    * \brief Return Python module names of available plug-ins.
900    */
901   //================================================================================
902
903   std::vector<std::string> getPluginNames()
904   {
905     std::vector<std::string> pluginNames;
906     std::vector< std::string > xmlPaths = SMESH_Gen::GetPluginXMLPaths();
907     LDOMParser xmlParser;
908     for ( size_t i = 0; i < xmlPaths.size(); ++i )
909     {
910       bool error = xmlParser.parse( xmlPaths[i].c_str() );
911       if ( error )
912       {
913         TCollection_AsciiString data;
914         INFOS( xmlParser.GetError(data) );
915         continue;
916       }
917       // <meshers-group name="Standard Meshers"
918       //                resources="StdMeshers"
919       //                idl-module="StdMeshers"
920       //                server-lib="StdMeshersEngine"
921       //                gui-lib="StdMeshersGUI">
922       LDOM_Document xmlDoc   = xmlParser.getDocument();
923       LDOM_NodeList nodeList = xmlDoc.getElementsByTagName( "meshers-group" );
924       for ( int i = 0; i < nodeList.getLength(); ++i )
925       {
926         LDOM_Node       node = nodeList.item( i );
927         LDOM_Element&   elem = (LDOM_Element&) node;
928         LDOMString idlModule = elem.getAttribute( "idl-module" );
929         if ( strlen( idlModule.GetString() ) > 0 )
930           pluginNames.push_back( idlModule.GetString() );
931       }
932     }
933     return pluginNames;
934   }
935 }
936
937 //================================================================================
938 /*!
939  * \brief Createa a Dump Python script
940  *  \param [in] theStudy - the study to dump
941  *  \param [in,out] theObjectNames - map of an entry to a study and python name
942  *  \param [in] theNames -  - map of an entry to a study name
943  *  \param [in] isPublished - \c true if dump of object publication in study is needed
944  *  \param [in] isMultiFile - \c true if dump of each module goes to a separate file
945  *  \param [in] isHistoricalDump - \c true if removed object should be dumped
946  *  \param [out] aValidScript - returns \c true if the returned script seems valid
947  *  \param [in,out] theSavedTrace - the dump stored in the study. It's cleared to
948  *         decrease memory usage.
949  *  \return TCollection_AsciiString - the result dump script.
950  */
951 //================================================================================
952
953 TCollection_AsciiString SMESH_Gen_i::DumpPython_impl
954                         (SALOMEDS::Study_ptr                       theStudy,
955                          Resource_DataMapOfAsciiStringAsciiString& theObjectNames,
956                          Resource_DataMapOfAsciiStringAsciiString& theNames,
957                          bool                                      isPublished,
958                          bool                                      isMultiFile,
959                          bool                                      isHistoricalDump,
960                          bool&                                     aValidScript,
961                          TCollection_AsciiString&                  theSavedTrace)
962 {
963   SMESH_TRY;
964   const int aStudyID = theStudy->StudyId();
965
966   const TCollection_AsciiString aSmeshpy ( SMESH_2smeshpy::SmeshpyName() );
967   const TCollection_AsciiString aSMESHGen( SMESH_2smeshpy::GenName() );
968   const TCollection_AsciiString anOldGen ( SMESH::TPythonDump::SMESHGenName() );
969   const TCollection_AsciiString helper; // to comfortably append C strings to TCollection_AsciiString
970   const TCollection_AsciiString tab( isMultiFile ? "\t" : "" ), nt = helper + "\n" + tab;
971
972   std::list< TCollection_AsciiString > lines; // lines of a script
973   std::list< TCollection_AsciiString >::iterator linesIt;
974   
975   if ( isPublished )
976     lines.push_back(  aSMESHGen + " = smeshBuilder.New(theStudy)" );
977    else
978     lines.push_back(  aSMESHGen + " = smeshBuilder.New(None)" );
979   lines.push_back( helper + "aFilterManager = " + aSMESHGen + ".CreateFilterManager()" );
980   lines.push_back( helper + "aMeasurements = "  + aSMESHGen + ".CreateMeasurements()" );
981
982   // Treat dump trace of restored study
983   if (theSavedTrace.Length() > 0)
984   {
985     linesIt = --lines.end();
986     // Split theSavedTrace into lines
987     int from = 1, end = theSavedTrace.Length(), to;
988     while ( from < end && ( to = theSavedTrace.Location( "\n", from, end )))
989     {
990       if ( theSavedTrace.ToCString()[from-1] == '\t' )
991         ++from;
992       if ( to != from )
993         lines.push_back( theSavedTrace.SubString( from, to - 1 ));
994       from = to + 1;
995     }
996     // For the convertion of IDL API calls -> smeshBuilder.py API, "smesh" standing for SMESH_Gen
997     // was replaces with "smeshgen" (==TPythonDump::SMESHGenName()).
998     // Change "smesh" -> "smeshgen" in the trace saved before passage to smeshBuilder.py API
999     bool isNewVersion =
1000       theSavedTrace.Location( anOldGen + ".", 1, theSavedTrace.Length() );
1001     theSavedTrace.Clear();
1002     if ( !isNewVersion )
1003     {
1004       const TCollection_AsciiString aSmeshCall ( "smesh." ), gen( "gen" );
1005       int beg, end, from;
1006       for ( ++linesIt; linesIt != lines.end(); ++linesIt )
1007       {
1008         TCollection_AsciiString& aSavedLine = *linesIt;
1009         end = aSavedLine.Length(), from = 1;
1010         while ( from < end && ( beg = aSavedLine.Location( aSmeshCall, from, end )))
1011         {
1012           char charBefore = ( beg == 1 ) ? ' ' : aSavedLine.Value( beg - 1 );
1013           if ( isspace( charBefore ) || charBefore == '=' ) { // "smesh." is not a part of a long word
1014             aSavedLine.Insert( beg + aSmeshCall.Length() - 1, gen );// "smesh" -> "smeshgen"
1015             end += gen.Length();
1016           }
1017           from = beg + aSmeshCall.Length();
1018         }
1019       }
1020     }
1021   }
1022
1023   // Add new dump trace of API methods calls to script lines
1024   if (myPythonScripts.find( aStudyID ) != myPythonScripts.end())
1025   {
1026     Handle(TColStd_HSequenceOfAsciiString) aPythonScript = myPythonScripts[ aStudyID ];
1027     Standard_Integer istr, aLen = aPythonScript->Length();
1028     for (istr = 1; istr <= aLen; istr++)
1029       lines.push_back( aPythonScript->Value( istr ));
1030   }
1031
1032   // Convert IDL API calls into smeshBuilder.py API.
1033   // Some objects are wrapped with python classes and
1034   // Resource_DataMapOfAsciiStringAsciiString holds methods returning wrapped objects
1035   Resource_DataMapOfAsciiStringAsciiString anEntry2AccessorMethod;
1036   std::set< TCollection_AsciiString >      aRemovedObjIDs;
1037   if ( !getenv("NO_2smeshpy_conversion"))
1038     SMESH_2smeshpy::ConvertScript( lines, anEntry2AccessorMethod,
1039                                    theObjectNames, aRemovedObjIDs,
1040                                    theStudy, isHistoricalDump );
1041
1042   bool importGeom = false;
1043   GEOM::GEOM_Gen_ptr geom = GetGeomEngine();
1044   {
1045     // Add names of GEOM objects to theObjectNames to exclude same names of SMESH objects
1046     GEOM::string_array_var aGeomNames = geom->GetAllDumpNames();
1047     int ign = 0, nbgn = aGeomNames->length();
1048     for (; ign < nbgn; ign++) {
1049       TCollection_AsciiString aName = aGeomNames[ign].in();
1050       theObjectNames.Bind(aName, "1");
1051     }
1052   }
1053
1054   TCollection_AsciiString anUpdatedScript;
1055
1056   Resource_DataMapOfAsciiStringAsciiString mapRemoved;
1057   Resource_DataMapOfAsciiStringAsciiString mapEntries; // names and entries present in anUpdatedScript
1058   Standard_Integer objectCounter = 0;
1059   TCollection_AsciiString anEntry, aName, aGUIName, aBaseName("smeshObj_");
1060
1061   // Treat every script line and add it to anUpdatedScript
1062   for ( linesIt = lines.begin(); linesIt != lines.end(); ++linesIt )
1063   {
1064     TCollection_AsciiString& aLine = *linesIt;
1065     anUpdatedScript += tab;
1066     {
1067       //Replace characters used instead of quote marks to quote notebook variables
1068       int pos = 1;
1069       while (( pos = aLine.Location( 1, SMESH::TVar::Quote(), pos, aLine.Length() )))
1070         aLine.SetValue( pos, '"' );
1071     }
1072     // Find entries to be replaced by names
1073     Handle(TColStd_HSequenceOfInteger) aSeq = FindEntries(aLine);
1074     const Standard_Integer aSeqLen = aSeq->Length();
1075     Standard_Integer aStart = 1;
1076     for (Standard_Integer i = 1; i <= aSeqLen; i += 2)
1077     {
1078       if ( aStart < aSeq->Value(i) )
1079         anUpdatedScript += aLine.SubString( aStart, aSeq->Value(i) - 1 ); // line part before i-th entry
1080       anEntry = aLine.SubString( aSeq->Value(i), aSeq->Value(i + 1) );
1081       // is a GEOM object?
1082       CORBA::String_var geomName = geom->GetDumpName( anEntry.ToCString() );
1083       if ( !geomName.in() || !geomName.in()[0] ) {
1084         // is a SMESH object
1085         if ( theObjectNames.IsBound( anEntry )) {
1086           // The Object is in Study
1087           aName = theObjectNames.Find( anEntry );
1088           // check validity of aName
1089           bool isValidName = fixPythonName( aName );
1090           if (theObjectNames.IsBound(aName) && anEntry != theObjectNames(aName)) {
1091             // diff objects have same name - make a new name by appending a digit
1092             TCollection_AsciiString aName2;
1093             Standard_Integer i = 0;
1094             do {
1095               aName2 = aName + "_" + ++i;
1096             } while (theObjectNames.IsBound(aName2) && anEntry != theObjectNames(aName2));
1097             aName = aName2;
1098             isValidName = false;
1099           }
1100           if ( !isValidName )
1101             theObjectNames(anEntry) = aName;
1102
1103           if ( aLine.Value(1) != '#' )
1104             mapEntries.Bind(anEntry, aName);
1105         }
1106         else
1107         {
1108           // Removed Object
1109           do {
1110             aName = aBaseName + (++objectCounter);
1111           } while (theObjectNames.IsBound(aName));
1112
1113           if ( !aRemovedObjIDs.count( anEntry ) && aLine.Value(1) != '#')
1114             mapRemoved.Bind(anEntry, aName);
1115
1116           theObjectNames.Bind(anEntry, aName);
1117         }
1118         theObjectNames.Bind(aName, anEntry); // to detect same name of diff objects
1119       }
1120       else
1121       {
1122         aName = geomName.in();
1123         importGeom = true;
1124       }
1125       anUpdatedScript += aName;
1126       aStart = aSeq->Value(i + 1) + 1;
1127
1128     } // loop on entries within aLine
1129
1130     if ( aSeqLen == 0 )
1131       anUpdatedScript += aLine;
1132     else if ( aSeq->Value( aSeqLen ) < aLine.Length() )
1133       anUpdatedScript += aLine.SubString( aSeq->Value(aSeqLen) + 1, aLine.Length() );
1134
1135     anUpdatedScript += '\n';
1136   }
1137
1138   // Make an initial part of aSript
1139
1140   TCollection_AsciiString initPart = "import ";
1141   if ( isMultiFile )
1142     initPart += "salome, ";
1143   initPart += " SMESH, SALOMEDS\n";
1144   initPart += "from salome.smesh import smeshBuilder\n";
1145   if ( importGeom && isMultiFile )
1146   {
1147     initPart += ("\n## import GEOM dump file ## \n"
1148                  "import string, os, sys, re\n"
1149                  "sys.path.insert( 0, os.path.dirname(__file__) )\n"
1150                  "exec(\"from \"+re.sub(\"SMESH$\",\"GEOM\",__name__)+\" import *\")\n");
1151   }
1152   // import python files corresponding to plugins if they are used in anUpdatedScript
1153   {
1154     TCollection_AsciiString importStr;
1155     std::vector<std::string> pluginNames = getPluginNames();
1156     for ( size_t i = 0; i < pluginNames.size(); ++i )
1157     {
1158       // Convert access to plugin members:
1159       // e.g. StdMeshers.QUAD_REDUCED -> StdMeshersBuilder.QUAD_REDUCED
1160       TCollection_AsciiString pluginAccess = (pluginNames[i] + ".").c_str() ;
1161       int iFrom = 1, iPos;
1162       while (( iPos = anUpdatedScript.Location( pluginAccess, iFrom, anUpdatedScript.Length() )))
1163       {
1164         anUpdatedScript.Insert( iPos + pluginNames[i].size(), "Builder" );
1165         iFrom = iPos + pluginNames[i].size() + 8;
1166       }
1167       // if any plugin member is used, import the plugin
1168       if ( iFrom > 1 )
1169         importStr += ( helper + "\n" "from salome." + pluginNames[i].c_str() +
1170                        " import " + pluginNames[i].c_str() +"Builder" );
1171     }
1172     if ( !importStr.IsEmpty() )
1173       initPart += importStr + "\n";
1174   }
1175
1176   if( isMultiFile )
1177     initPart += "def RebuildData(theStudy):";
1178   initPart += "\n";
1179
1180   anUpdatedScript.Prepend( initPart );
1181
1182   // Make a final part of aScript
1183
1184   // Dump object removal
1185   TCollection_AsciiString removeObjPart;
1186   if ( !mapRemoved.IsEmpty() ) {
1187     removeObjPart += nt + "## some objects were removed";
1188     removeObjPart += nt + "aStudyBuilder = theStudy.NewBuilder()";
1189     Resource_DataMapIteratorOfDataMapOfAsciiStringAsciiString mapRemovedIt;
1190     for ( mapRemovedIt.Initialize( mapRemoved ); mapRemovedIt.More(); mapRemovedIt.Next() ) {
1191       aName   = mapRemovedIt.Value(); // python name
1192       anEntry = mapRemovedIt.Key();
1193       removeObjPart += nt + "SO = theStudy.FindObjectIOR(theStudy.ConvertObjectToIOR(";
1194       removeObjPart += aName;
1195       // for object wrapped by class of smeshBuilder.py
1196       if ( anEntry2AccessorMethod.IsBound( anEntry ) )
1197         removeObjPart += helper + "." + anEntry2AccessorMethod( anEntry );
1198       removeObjPart += helper + "))" + nt + "if SO: aStudyBuilder.RemoveObjectWithChildren(SO)";
1199     }
1200   }
1201
1202   // Set object names
1203   TCollection_AsciiString setNamePart;
1204   Resource_DataMapIteratorOfDataMapOfAsciiStringAsciiString mapEntriesIt;
1205   for ( mapEntriesIt.Initialize( mapEntries ); mapEntriesIt.More(); mapEntriesIt.Next() )
1206   {
1207     anEntry = mapEntriesIt.Key();
1208     aName   = mapEntriesIt.Value(); // python name
1209     if ( theNames.IsBound( anEntry ))
1210     {
1211       aGUIName = theNames.Find(anEntry);
1212       aGUIName.RemoveAll('\''); // remove a quote from a name (issue 22360)
1213       setNamePart += nt + aSMESHGen + ".SetName(" + aName;
1214       if ( anEntry2AccessorMethod.IsBound( anEntry ) )
1215         setNamePart += helper + "." + anEntry2AccessorMethod( anEntry );
1216       setNamePart += helper + ", '" + aGUIName + "')";
1217     }
1218   }
1219   if ( !setNamePart.IsEmpty() )
1220   {
1221     setNamePart.Insert( 1, nt + "## Set names of Mesh objects" );
1222   }
1223
1224   // Store visual properties of displayed objects
1225
1226   TCollection_AsciiString visualPropertiesPart;
1227   if (isPublished)
1228   {
1229     //Output the script that sets up the visual parameters.
1230     CORBA::String_var compDataType = ComponentDataType();
1231     CORBA::String_var script = theStudy->GetDefaultScript( compDataType.in(), tab.ToCString() );
1232     if ( script.in() && script.in()[0] ) {
1233       visualPropertiesPart += nt + "### Store presentation parameters of displayed objects\n";
1234       visualPropertiesPart += script.in();
1235     }
1236   }
1237
1238   anUpdatedScript += removeObjPart + '\n' + setNamePart + '\n' + visualPropertiesPart;
1239
1240   if( isMultiFile )
1241     anUpdatedScript += "\n\tpass";
1242   anUpdatedScript += "\n";
1243
1244   // no need now as we use 'tab' and 'nt' variables depending on isMultiFile
1245   // if( !isMultiFile ) // remove unnecessary tabulation
1246   //   RemoveTabulation( anUpdatedScript );
1247
1248   // -----------------------------------------------------------------
1249   // put string literals describing patterns into separate functions
1250   // -----------------------------------------------------------------
1251
1252   TCollection_AsciiString aLongString, aFunctionType;
1253   int where = 1;
1254   set< string > functionNameSet;
1255   while ( SMESH::TPythonDump::CutoutLongString( anUpdatedScript, where, aLongString, aFunctionType ))
1256   {
1257     // make a python string literal
1258     aLongString.Prepend(":\n\treturn '''\n");
1259     aLongString += "\n\t'''\n\tpass\n";
1260
1261     TCollection_AsciiString functionName;
1262
1263     // check if the function returning this literal is already defined
1264     int posAlready = anUpdatedScript.Location( aLongString, where, anUpdatedScript.Length() );
1265     if ( posAlready ) // already defined
1266     {
1267       // find the function name
1268       int functBeg = posAlready;
1269       char* script = (char*) anUpdatedScript.ToCString() + posAlready - 1; // look at ":" after "def fuction()"
1270       while ( *script != ' ' ) {
1271         script--;
1272         functBeg--;
1273       }
1274       functBeg++; // do not take ' '
1275       posAlready--; // do not take ':'
1276       functionName = anUpdatedScript.SubString( functBeg, posAlready );
1277     }
1278     else // not defined yet
1279     {
1280       // find a unique function name
1281       fixPythonName( aFunctionType );
1282       Standard_Integer nb = 0;
1283       do functionName = aFunctionType + "_" + ( nb++ ) + "()";
1284       while ( !functionNameSet.insert( functionName.ToCString() ).second );
1285
1286       // define function
1287       TCollection_AsciiString funDef = helper + "def " + functionName + aLongString;
1288       if ( isMultiFile )
1289       {
1290         anUpdatedScript += helper + "\n\n" + funDef;
1291       }
1292       else
1293       {
1294         funDef += "\n\n";
1295         anUpdatedScript.Insert( 1, funDef);
1296         where += funDef.Length();
1297       }
1298     }
1299     anUpdatedScript.InsertBefore( where, functionName ); // call function
1300   }
1301
1302   aValidScript = true;
1303
1304   return anUpdatedScript;
1305
1306   SMESH_CATCH( SMESH::printException );
1307
1308   aValidScript = false;
1309   return "";
1310 }
1311
1312 //=============================================================================
1313 /*!
1314  *  GetNewPythonLines
1315  */
1316 //=============================================================================
1317 TCollection_AsciiString SMESH_Gen_i::GetNewPythonLines (int theStudyID)
1318 {
1319   TCollection_AsciiString aScript;
1320
1321   // Dump trace of API methods calls
1322   if (myPythonScripts.find(theStudyID) != myPythonScripts.end()) {
1323     Handle(TColStd_HSequenceOfAsciiString) aPythonScript = myPythonScripts[theStudyID];
1324     Standard_Integer istr, aLen = aPythonScript->Length();
1325     for (istr = 1; istr <= aLen; istr++) {
1326       aScript += "\n";
1327       aScript += aPythonScript->Value(istr);
1328     }
1329     aScript += "\n";
1330   }
1331
1332   return aScript;
1333 }
1334
1335 //=============================================================================
1336 /*!
1337  *  CleanPythonTrace
1338  */
1339 //=============================================================================
1340 void SMESH_Gen_i::CleanPythonTrace (int theStudyID)
1341 {
1342   TCollection_AsciiString aScript;
1343
1344   // Clean trace of API methods calls
1345   if (myPythonScripts.find(theStudyID) != myPythonScripts.end()) {
1346     myPythonScripts[theStudyID]->Clear();
1347   }
1348 }