src/GEOM_I/GEOM_DumpPython.cc

   1 // Copyright (C) 2007-2013  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.
  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
  23 #ifdef WNT
  24 #pragma warning( disable:4786 )
  25 #endif
  26
  27 #include <Standard_Stream.hxx>
  28
  29 #include "GEOM_Gen_i.hh"
  30
  31 #include <TCollection_AsciiString.hxx>
  32 #include <TCollection_ExtendedString.hxx>
  33 #include <TColStd_HSequenceOfAsciiString.hxx>
  34 #include <Resource_DataMapOfAsciiStringAsciiString.hxx>
  35
  36 #include <vector>
  37 #include <string>
  38
  39 //=======================================================================
  40 //function : RemoveTabulation
  41 //purpose  :
  42 //=======================================================================
  43 void RemoveTabulation( TCollection_AsciiString& theScript )
  44 {
  45   std::string aString( theScript.ToCString() );
  46   std::string::size_type aPos = 0;
  47   while( aPos < aString.length() )
  48   {
  49     aPos = aString.find( "\n\t", aPos );
  50     if( aPos == std::string::npos )
  51       break;
  52     aString.replace( aPos, 2, "\n" );
  53     aPos++;
  54   }
  55   theScript = aString.c_str();
  56 }
  57
  58 //=======================================================================
  59 //function : ConvertV6toV7
  60 //purpose  : dump elements are stored when study is saved,
  61 //           and kept when study is reloaded.
  62 //           When a study from an older version is loaded,
  63 //           the dump must be post processed in case of syntax modification.
  64 //           In V7.2, geompy.GEOM --> GEOM
  65 //=======================================================================
  66 void ConvertV6toV7( TCollection_AsciiString& theScript )
  67 {
  68   std::string aString( theScript.ToCString() );
  69   std::string::size_type aPos = 0;
  70   while( aPos < aString.length() )
  71   {
  72     aPos = aString.find( "geompy.GEOM", aPos );
  73     if( aPos == std::string::npos )
  74       break;
  75     aString.replace( aPos, 11, "GEOM" );
  76     aPos++;
  77   }
  78   theScript = aString.c_str();
  79 }
  80
  81 //=======================================================================
  82 //function : DumpPython
  83 //purpose  :
  84 //=======================================================================
  85
  86 Engines::TMPFile* GEOM_Gen_i::DumpPython(CORBA::Object_ptr theStudy,
  87                                          CORBA::Boolean isPublished,
  88                                          CORBA::Boolean isMultiFile,
  89                                          CORBA::Boolean& isValidScript)
  90 {
  91   SALOMEDS::Study_var aStudy = SALOMEDS::Study::_narrow(theStudy);
  92   if(CORBA::is_nil(aStudy))
  93     return new Engines::TMPFile(0);
  94
  95   SALOMEDS::SObject_var aSO = aStudy->FindComponent(ComponentDataType());
  96   if(CORBA::is_nil(aSO))
  97     return new Engines::TMPFile(0);
  98
  99   TObjectData objData;
 100   std::vector<TObjectData> objectDataVec;
 101
 102   TVariablesList aVariableMap;
 103
 104   SALOMEDS::ChildIterator_var Itr = aStudy->NewChildIterator(aSO);
 105   for(Itr->InitEx(true); Itr->More(); Itr->Next()) {
 106     SALOMEDS::SObject_var aValue = Itr->Value();
 107     CORBA::String_var IOR = aValue->GetIOR();
 108     if(strlen(IOR.in()) > 0) {
 109       CORBA::Object_var obj = _orb->string_to_object(IOR);
 110       GEOM::GEOM_Object_var GO = GEOM::GEOM_Object::_narrow(obj);
 111       if(!CORBA::is_nil(GO)) {
 112         CORBA::String_var aName       = aValue->GetName();
 113         CORBA::String_var anEntry     = GO->GetEntry();
 114         CORBA::String_var aStudyEntry = aValue->GetID();
 115         objData._name       = aName.in();
 116         objData._entry      = anEntry.in();
 117         objData._studyEntry = aStudyEntry.in();
 118
 119         //Find Drawable Attribute
 120         SALOMEDS::GenericAttribute_var aGenAttr;
 121         if(aValue->FindAttribute(aGenAttr, "AttributeDrawable") ) {
 122           SALOMEDS::AttributeDrawable_var aDrw = SALOMEDS::AttributeDrawable::_narrow(aGenAttr);
 123           objData._unpublished = !aDrw->IsDrawable();
 124         } else {
 125           objData._unpublished = false;
 126         }
 127
 128         objectDataVec.push_back( objData );
 129
 130         //Find attribute with list of used notebook variables
 131         SALOMEDS::GenericAttribute_var anAttr;
 132         SALOMEDS::AttributeString_var anAttrStr;
 133         if(aValue->FindAttribute(anAttr,"AttributeString")){
 134           anAttrStr = SALOMEDS::AttributeString::_narrow(anAttr);
 135           SALOMEDS::ListOfListOfStrings_var aSections = aStudy->ParseVariables(anAttrStr->Value());
 136           ObjectStates* aStates = new ObjectStates();
 137           for(int i = 0; i < aSections->length(); i++) {
 138             TState aState;
 139             SALOMEDS::ListOfStrings aListOfVars = aSections[i];
 140             for(int j = 0; j < aListOfVars.length(); j++) {
 141               bool isVar = aStudy->IsVariable(aListOfVars[j].in());
 142               TVariable aVar = TVariable( (char*)aListOfVars[j].in(), isVar );
 143               aState.push_back(aVar);
 144             }
 145             aStates->AddState(aState);
 146           }
 147           aVariableMap.insert(std::make_pair(TCollection_AsciiString(anEntry),aStates));
 148         }
 149       }
 150     }
 151   }
 152
 153   TCollection_AsciiString aScript;
 154   aScript += _impl->DumpPython(aStudy->StudyId(), objectDataVec, aVariableMap, isPublished, isMultiFile, isValidScript);
 155
 156   if (isPublished)
 157   {
 158
 159     SALOMEDS::AttributeParameter_var ap = aStudy->GetModuleParameters("Interface Applicative",
 160                                                                       ComponentDataType(),
 161                                                                       -1);
 162     if(!CORBA::is_nil(ap)) {
 163       //Add the id parameter of the object
 164       std::vector<TObjectData>::iterator it = objectDataVec.begin();
 165       for( ;it != objectDataVec.end(); it++ ) {
 166
 167         //1. Encode entry
 168         if ( (*it)._studyEntry.Length() < 7 ) continue;
 169         std::string tail( (*it)._studyEntry.ToCString(), 6, (*it)._studyEntry.Length()-1 );
 170         std::string newEntry(ComponentDataType());
 171         newEntry+=("_"+tail);
 172
 173         CORBA::String_var anEntry = CORBA::string_dup(newEntry.c_str());
 174
 175         if( ap->IsSet(anEntry, 6) ) { //6 Means string array, see SALOMEDS_Attributes.idl AttributeParameter interface
 176           std::string idCommand = std::string("geompy.getObjectID(") + GetDumpName((*it)._studyEntry.ToCString()) + std::string(")");
 177           SALOMEDS::StringSeq_var aSeq= ap->GetStrArray(anEntry);
 178           int oldLenght = aSeq->length();
 179           aSeq->length(oldLenght+2);
 180           aSeq[oldLenght] = CORBA::string_dup("_PT_OBJECT_ID_");
 181           aSeq[oldLenght + 1] = CORBA::string_dup(idCommand.c_str());
 182           ap->SetStrArray( anEntry, aSeq );
 183         }
 184       }
 185     }
 186
 187     TCollection_AsciiString aDirScript, aNodeName, aNodeEntry, aFatherName, aFatherEntry;
 188     aDirScript += "\n\t### Folders and it's content\n";
 189     Resource_DataMapOfAsciiStringAsciiString aNameToEntry;
 190     SALOMEDS::UseCaseBuilder_var useCaseBuilder = aStudy->GetUseCaseBuilder();
 191     SALOMEDS::UseCaseIterator_var Itr = useCaseBuilder->GetUseCaseIterator(aSO);
 192     SALOMEDS::SObject_var aNodeSO;
 193     SALOMEDS::SObject_var aFatherSO;
 194     SALOMEDS::GenericAttribute_var anIDAttr;
 195     for(Itr->Init(true); Itr->More(); Itr->Next()) {
 196       aFatherName.Clear();
 197       aFatherEntry.Clear();
 198       aNodeSO = Itr->Value();
 199       // get father info
 200       aFatherSO = useCaseBuilder->GetFather( aNodeSO );
 201       if ( aFatherSO->FindAttribute(anIDAttr, "AttributeLocalID") ) {
 202         SALOMEDS::AttributeLocalID_var aLocalID = SALOMEDS::AttributeLocalID::_narrow(anIDAttr);
 203         if ( aLocalID->Value() == 999 ) {
 204           aFatherName = aFatherSO->GetName();
 205           aFatherEntry = aFatherSO->GetID();
 206           _impl->healPyName( aFatherName, aFatherEntry, aNameToEntry);
 207         }
 208         aLocalID->UnRegister();
 209       }
 210       // get node info
 211       if ( aNodeSO->FindAttribute(anIDAttr, "AttributeLocalID") ) {
 212         SALOMEDS::AttributeLocalID_var aLocalID = SALOMEDS::AttributeLocalID::_narrow(anIDAttr);
 213         if ( aLocalID->Value() == 999 ) {
 214           // the node is folder
 215           aNodeName = aNodeSO->GetName();
 216           aNodeEntry = aNodeSO->GetID();
 217           _impl->healPyName( aNodeName, aNodeEntry, aNameToEntry);
 218           aDirScript += aNodeName;
 219           aDirScript += " = geompy.NewFolder('";
 220           aDirScript += aNodeSO->GetName();
 221           aDirScript += "'";
 222           if ( !aFatherName.IsEmpty() && !aFatherEntry.IsEmpty() ) {
 223             // the folder takes place under another folder
 224             aDirScript += ", ";
 225             aDirScript += aFatherName;
 226           }
 227           aDirScript += ")\n";
 228           aNameToEntry.Bind( aNodeName, aNodeEntry );
 229         }
 230         aLocalID->UnRegister();
 231       } else if ( !aFatherName.IsEmpty() && !aFatherEntry.IsEmpty() ) {
 232         // the node is Geom object under folder
 233         aDirScript += "geompy.PutToFolder(";
 234         aDirScript += GetDumpName( aNodeSO->GetID() );
 235         aDirScript += ", ";
 236         aDirScript += aFatherName;
 237         aDirScript += ")\n";
 238       }
 239     }
 240     aScript += aDirScript;
 241
 242     //Output the script that sets up the visual parameters.
 243     char* script = aStudy->GetDefaultScript(ComponentDataType(), "\t");
 244     if (script && strlen(script) > 0) {
 245       aScript += "\n\t### Store presentation parameters of displayed objects\n";
 246       aScript += script;
 247       CORBA::string_free(script);
 248     }
 249   }
 250
 251   if( isMultiFile )
 252     aScript += "\n\tpass";
 253   aScript += "\n";
 254
 255   if( !isMultiFile ) // remove unnecessary tabulation
 256     RemoveTabulation( aScript );
 257
 258   ConvertV6toV7( aScript ); //convert scripts related to studies saved in SALOME V6 and older
 259
 260   int aLen = aScript.Length();
 261   unsigned char* aBuffer = new unsigned char[aLen+1];
 262   strcpy((char*)aBuffer, aScript.ToCString());
 263
 264   CORBA::Octet* anOctetBuf =  (CORBA::Octet*)aBuffer;
 265   Engines::TMPFile_var aStreamFile = new Engines::TMPFile(aLen+1, aLen+1, anOctetBuf, 1);
 266
 267   return aStreamFile._retn();
 268 }
 269
 270 //=======================================================================
 271 //function : GetDumpName
 272 //purpose  :
 273 //=======================================================================
 274
 275 char* GEOM_Gen_i::GetDumpName (const char* theStudyEntry)
 276 {
 277   const char* name = _impl->GetDumpName( theStudyEntry );
 278   if ( name && strlen( name ) > 0 )
 279     return strdup( name );
 280
 281   return NULL;
 282 }
 283
 284 //=======================================================================
 285 //function : GetAllDumpNames
 286 //purpose  :
 287 //=======================================================================
 288
 289 GEOM::string_array* GEOM_Gen_i::GetAllDumpNames()
 290 {
 291   Handle(TColStd_HSequenceOfAsciiString) aHSeq = _impl->GetAllDumpNames();
 292   int i = 0, aLen = aHSeq->Length();
 293
 294   GEOM::string_array_var seq = new GEOM::string_array();
 295   seq->length(aLen);
 296
 297   for (; i < aLen; i++) {
 298     seq[i] = CORBA::string_dup(aHSeq->Value(i + 1).ToCString());
 299   }
 300
 301   return seq._retn();
 302 }