1 // Copyright (C) 2007-2010 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
6 // This library is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 2.1 of the License.
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 // Lesser General Public License for more details.
16 // You should have received a copy of the GNU Lesser General Public
17 // License along with this library; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
23 // SMESH SMESHGUI : GUI for SMESH component
24 // File : SMESHGUI_HypothesesUtils.cxx
25 // Author : Julia DOROVSKIKH, Open CASCADE S.A.S.
28 #include "SMESHGUI_HypothesesUtils.h"
31 #include "SMESHGUI_Hypotheses.h"
32 #include "SMESHGUI_XmlHandler.h"
33 #include "SMESHGUI_Utils.h"
34 #include "SMESHGUI_GEOMGenUtils.h"
36 // SALOME GUI includes
37 #include <SUIT_Desktop.h>
38 #include <SUIT_MessageBox.h>
39 #include <SUIT_OverrideCursor.h>
40 #include <SUIT_ResourceMgr.h>
42 #include <SalomeApp_Study.h>
43 #include <SalomeApp_Tools.h>
45 // SALOME KERNEL includes
46 #include <utilities.h>
63 #define LibHandle HMODULE
64 #define LoadLib( name ) LoadLibrary( name )
65 #define GetProc GetProcAddress
66 #define UnLoadLib( handle ) FreeLibrary( handle );
68 #define LibHandle void*
69 #define LoadLib( name ) dlopen( name, RTLD_LAZY )
71 #define UnLoadLib( handle ) dlclose( handle );
75 static int MYDEBUG = 0;
77 static int MYDEBUG = 0;
82 typedef QMap<QString,HypothesisData*> THypothesisDataMap;
83 THypothesisDataMap myHypothesesMap;
84 THypothesisDataMap myAlgorithmsMap;
87 //typedef QMap<QString,SMESHGUI_GenericHypothesisCreator*> THypCreatorMap;
88 //THypCreatorMap myHypCreatorMap;
90 QList<HypothesesSet*> myListOfHypothesesSets;
92 void processHypothesisStatus(const int theHypStatus,
93 SMESH::SMESH_Hypothesis_ptr theHyp,
94 const bool theIsAddition)
96 if (theHypStatus > SMESH::HYP_OK) {
98 QString aHypName ("NULL Hypothesis");
99 if (!CORBA::is_nil(theHyp)) {
100 _PTR(SObject) Shyp = SMESH::FindSObject(theHyp);
103 aHypName = Shyp->GetName().c_str();
106 aHypName = GetHypothesisData(theHyp->GetName())->Label;
110 bool isFatal = (theHypStatus >= SMESH::HYP_UNKNOWN_FATAL);
113 aMsg = (isFatal ? "SMESH_CANT_ADD_HYP" : "SMESH_ADD_HYP_WRN");
115 aMsg = (isFatal ? "SMESH_CANT_RM_HYP" : "SMESH_RM_HYP_WRN");
117 aMsg = QObject::tr(aMsg.toLatin1().data()).arg(aHypName) +
118 QObject::tr(QString("SMESH_HYP_%1").arg(theHypStatus).toLatin1().data());
120 if ( theHypStatus == SMESH::HYP_HIDDEN_ALGO ) // PAL18501
121 aMsg = aMsg.arg( GetHypothesisData(theHyp->GetName())->Dim[0] );
123 SUIT_MessageBox::warning(SMESHGUI::desktop(),
124 QObject::tr("SMESH_WRN_WARNING"),
130 void InitAvailableHypotheses()
132 SUIT_OverrideCursor wc;
133 if (myHypothesesMap.empty() && myAlgorithmsMap.empty()) {
135 SUIT_ResourceMgr* resMgr = SMESHGUI::resourceMgr();
138 // Find name of a resource XML file ("SMESH_Meshers.xml");
140 char* cenv = getenv("SMESH_MeshersList");
142 HypsXml.sprintf("%s", cenv);
144 QStringList HypsXmlList = HypsXml.split(":", QString::SkipEmptyParts);
145 if (HypsXmlList.count() == 0) {
146 SUIT_MessageBox::critical(SMESHGUI::desktop(),
147 QObject::tr("SMESH_WRN_WARNING"),
148 QObject::tr("MESHERS_FILE_NO_VARIABLE"));
152 // loop on files in HypsXml
153 QString aNoAccessFiles;
154 for (int i = 0; i < HypsXmlList.count(); i++) {
155 QString HypsXml = HypsXmlList[ i ];
157 // Find full path to the resource XML file
158 QString xmlFile = resMgr->path("resources", "SMESH", HypsXml + ".xml");
159 if ( xmlFile.isEmpty() ) // try PLUGIN resources
160 xmlFile = resMgr->path("resources", HypsXml, HypsXml + ".xml");
162 QFile file (xmlFile);
163 if (file.exists() && file.open(QIODevice::ReadOnly)) {
166 SMESHGUI_XmlHandler* aXmlHandler = new SMESHGUI_XmlHandler();
169 QXmlInputSource source (&file);
170 QXmlSimpleReader reader;
171 reader.setContentHandler(aXmlHandler);
172 reader.setErrorHandler(aXmlHandler);
173 bool ok = reader.parse(source);
176 myHypothesesMap.unite( aXmlHandler->myHypothesesMap );
177 myAlgorithmsMap.unite( aXmlHandler->myAlgorithmsMap );
178 QList<HypothesesSet*>::iterator it, pos = myListOfHypothesesSets.begin();
179 for ( it = aXmlHandler->myListOfHypothesesSets.begin();
180 it != aXmlHandler->myListOfHypothesesSets.end();
182 myListOfHypothesesSets.insert( pos, *it );
186 SUIT_MessageBox::critical(SMESHGUI::desktop(),
187 QObject::tr("INF_PARSE_ERROR"),
188 QObject::tr(aXmlHandler->errorProtocol().toLatin1().data()));
193 if (aNoAccessFiles.isEmpty())
194 aNoAccessFiles = xmlFile;
196 aNoAccessFiles += ", " + xmlFile;
201 if (!aNoAccessFiles.isEmpty()) {
202 QString aMess = QObject::tr("MESHERS_FILE_CANT_OPEN") + " " + aNoAccessFiles + "\n";
203 aMess += QObject::tr("MESHERS_FILE_CHECK_VARIABLE");
205 SUIT_MessageBox::warning(SMESHGUI::desktop(),
206 QObject::tr("SMESH_WRN_WARNING"),
214 QStringList GetAvailableHypotheses( const bool isAlgo,
217 const bool isNeedGeometry)
219 QStringList aHypList;
221 // Init list of available hypotheses, if needed
222 InitAvailableHypotheses();
223 bool checkGeometry = ( !isNeedGeometry && isAlgo );
224 // fill list of hypotheses/algorithms
225 THypothesisDataMap& pMap = isAlgo ? myAlgorithmsMap : myHypothesesMap;
226 THypothesisDataMap::iterator anIter;
227 for ( anIter = pMap.begin(); anIter != pMap.end(); anIter++ ) {
228 HypothesisData* aData = anIter.value();
229 if ( ( theDim < 0 || aData->Dim.contains( theDim ) ) && aData->IsAux == isAux) {
231 if (aData->IsNeedGeometry == isNeedGeometry)
232 aHypList.append(anIter.key());
235 aHypList.append(anIter.key());
243 QStringList GetHypothesesSets()
245 QStringList aSetNameList;
247 // Init list of available hypotheses, if needed
248 InitAvailableHypotheses();
250 QList<HypothesesSet*>::iterator hypoSet;
251 for ( hypoSet = myListOfHypothesesSets.begin();
252 hypoSet != myListOfHypothesesSets.end();
254 HypothesesSet* aSet = *hypoSet;
255 if ( aSet && aSet->count( true ) ) {
256 aSetNameList.append( aSet->name() );
263 HypothesesSet* GetHypothesesSet(const QString& theSetName)
265 QList<HypothesesSet*>::iterator hypoSet;
266 for ( hypoSet = myListOfHypothesesSets.begin();
267 hypoSet != myListOfHypothesesSets.end();
269 HypothesesSet* aSet = *hypoSet;
270 if ( aSet && aSet->name() == theSetName )
276 HypothesisData* GetHypothesisData (const QString& aHypType)
278 HypothesisData* aHypData = 0;
280 // Init list of available hypotheses, if needed
281 InitAvailableHypotheses();
283 if (myHypothesesMap.find(aHypType) != myHypothesesMap.end()) {
284 aHypData = myHypothesesMap[aHypType];
286 else if (myAlgorithmsMap.find(aHypType) != myAlgorithmsMap.end()) {
287 aHypData = myAlgorithmsMap[aHypType];
292 bool IsAvailableHypothesis(const HypothesisData* algoData,
293 const QString& hypType,
299 if ( algoData->NeededHypos.contains( hypType ))
301 if ( algoData->OptionalHypos.contains( hypType)) {
308 bool IsCompatibleAlgorithm(const HypothesisData* algo1Data,
309 const HypothesisData* algo2Data)
311 if ( !algo1Data || !algo2Data )
313 const HypothesisData* algoIn = algo1Data, *algoMain = algo2Data;
314 if ( algoIn->Dim.first() > algoMain->Dim.first() ) {
315 algoIn = algo2Data; algoMain = algo1Data;
317 // look for any output type of algoIn between input types of algoMain
318 QStringList::const_iterator inElemType = algoIn->OutputTypes.begin();
319 for ( ; inElemType != algoIn->OutputTypes.end(); ++inElemType )
320 if ( algoMain->InputTypes.contains( *inElemType ))
325 SMESHGUI_GenericHypothesisCreator* GetHypothesisCreator(const QString& aHypType)
327 if(MYDEBUG) MESSAGE("Get HypothesisCreator for " << aHypType.toLatin1().data());
329 SMESHGUI_GenericHypothesisCreator* aCreator = 0;
331 // check, if creator for this hypothesis type already exists
333 //if (myHypCreatorMap.find(aHypType) != myHypCreatorMap.end()) {
334 // aCreator = myHypCreatorMap[aHypType];
338 // 1. Init list of available hypotheses, if needed
339 InitAvailableHypotheses();
341 // 2. Get names of plugin libraries
342 HypothesisData* aHypData = GetHypothesisData(aHypType);
346 QString aClientLibName = aHypData->ClientLibName;
347 QString aServerLibName = aHypData->ServerLibName;
349 // 3. Load Client Plugin Library
351 // load plugin library
352 if(MYDEBUG) MESSAGE("Loading client meshers plugin library ...");
353 LibHandle libHandle = LoadLib( aClientLibName.toLatin1().data() );
355 // report any error, if occured
358 const char* anError = "Can't load client meshers plugin library";
360 const char* anError = dlerror();
366 // get method, returning hypothesis creator
367 if(MYDEBUG) MESSAGE("Find GetHypothesisCreator() method ...");
368 typedef SMESHGUI_GenericHypothesisCreator* (*GetHypothesisCreator) \
370 GetHypothesisCreator procHandle =
371 (GetHypothesisCreator)GetProc(libHandle, "GetHypothesisCreator");
373 if(MYDEBUG) MESSAGE("bad hypothesis client plugin library");
374 UnLoadLib(libHandle);
377 // get hypothesis creator
378 if(MYDEBUG) MESSAGE("Get Hypothesis Creator for " << aHypType.toLatin1().data());
379 aCreator = procHandle( aHypType );
381 if(MYDEBUG) MESSAGE("no such a hypothesis in this plugin");
384 // map hypothesis creator to a hypothesis name
386 //myHypCreatorMap[aHypType] = aCreator;
391 catch (const SALOME::SALOME_Exception& S_ex) {
392 SalomeApp_Tools::QtCatchCorbaException(S_ex);
400 SMESH::SMESH_Hypothesis_ptr CreateHypothesis(const QString& aHypType,
401 const QString& aHypName,
404 if(MYDEBUG) MESSAGE("Create " << aHypType.toLatin1().data() <<
405 " with name " << aHypName.toLatin1().data());
406 HypothesisData* aHypData = GetHypothesisData(aHypType);
407 QString aServLib = aHypData->ServerLibName;
409 SMESH::SMESH_Hypothesis_var aHypothesis;
410 aHypothesis = SMESHGUI::GetSMESHGen()->CreateHypothesis(aHypType.toLatin1().data(),
411 aServLib.toLatin1().data());
412 if (!aHypothesis->_is_nil()) {
413 _PTR(SObject) aHypSObject = SMESH::FindSObject(aHypothesis.in());
415 if (!aHypName.isEmpty())
416 SMESH::SetName(aHypSObject, aHypName);
417 SMESHGUI::GetSMESHGUI()->updateObjBrowser();
418 return aHypothesis._retn();
421 } catch (const SALOME::SALOME_Exception & S_ex) {
422 SalomeApp_Tools::QtCatchCorbaException(S_ex);
425 return SMESH::SMESH_Hypothesis::_nil();
429 bool AddHypothesisOnMesh (SMESH::SMESH_Mesh_ptr aMesh, SMESH::SMESH_Hypothesis_ptr aHyp)
431 if(MYDEBUG) MESSAGE ("SMESHGUI::AddHypothesisOnMesh");
432 int res = SMESH::HYP_UNKNOWN_FATAL;
433 SUIT_OverrideCursor wc;
435 if (!aMesh->_is_nil()) {
436 _PTR(SObject) SM = SMESH::FindSObject(aMesh);
437 GEOM::GEOM_Object_var aShapeObject = SMESH::GetShapeOnMeshOrSubMesh(SM);
439 res = aMesh->AddHypothesis(aShapeObject, aHyp);
440 if (res < SMESH::HYP_UNKNOWN_FATAL) {
441 _PTR(SObject) aSH = SMESH::FindSObject(aHyp);
443 SMESH::ModifiedMesh(SM, false, aMesh->NbNodes()==0);
446 if (res > SMESH::HYP_OK) {
448 processHypothesisStatus(res, aHyp, true);
452 catch(const SALOME::SALOME_Exception& S_ex) {
454 SalomeApp_Tools::QtCatchCorbaException(S_ex);
455 res = SMESH::HYP_UNKNOWN_FATAL;
458 return res < SMESH::HYP_UNKNOWN_FATAL;
462 bool AddHypothesisOnSubMesh (SMESH::SMESH_subMesh_ptr aSubMesh, SMESH::SMESH_Hypothesis_ptr aHyp)
464 if(MYDEBUG) MESSAGE("SMESHGUI::AddHypothesisOnSubMesh() ");
465 int res = SMESH::HYP_UNKNOWN_FATAL;
466 SUIT_OverrideCursor wc;
468 if (!aSubMesh->_is_nil() && ! aHyp->_is_nil()) {
470 SMESH::SMESH_Mesh_var aMesh = aSubMesh->GetFather();
471 _PTR(SObject) SsubM = SMESH::FindSObject(aSubMesh);
472 GEOM::GEOM_Object_var aShapeObject = SMESH::GetShapeOnMeshOrSubMesh(SsubM);
473 if (!aMesh->_is_nil() && SsubM && !aShapeObject->_is_nil()) {
474 res = aMesh->AddHypothesis(aShapeObject, aHyp);
475 if (res < SMESH::HYP_UNKNOWN_FATAL) {
476 _PTR(SObject) meshSO = SMESH::FindSObject(aMesh);
478 SMESH::ModifiedMesh(meshSO, false, aMesh->NbNodes()==0);
480 if (res > SMESH::HYP_OK) {
482 processHypothesisStatus(res, aHyp, true);
487 SCRUTE(aHyp->_is_nil());
488 SCRUTE(aMesh->_is_nil());
490 SCRUTE(aShapeObject->_is_nil());
493 catch(const SALOME::SALOME_Exception& S_ex) {
495 SalomeApp_Tools::QtCatchCorbaException(S_ex);
496 res = SMESH::HYP_UNKNOWN_FATAL;
500 SCRUTE(aSubMesh->_is_nil());
501 SCRUTE(aHyp->_is_nil());
503 return res < SMESH::HYP_UNKNOWN_FATAL;
506 bool RemoveHypothesisOrAlgorithmOnMesh (const Handle(SALOME_InteractiveObject)& IObject)
508 int res = SMESH::HYP_UNKNOWN_FATAL;
509 SUIT_OverrideCursor wc;
512 _PTR(Study) aStudy = GetActiveStudyDocument();
513 _PTR(SObject) aHypObj = aStudy->FindObjectID( IObject->getEntry() );
516 _PTR(SObject) MorSM = SMESH::GetMeshOrSubmesh( aHypObj );
517 _PTR(SObject) aRealHypo;
518 if( aHypObj->ReferencedObject( aRealHypo ) )
520 SMESH_Hypothesis_var hypo = SMESH_Hypothesis::_narrow( SObjectToObject( aRealHypo ) );
521 RemoveHypothesisOrAlgorithmOnMesh( MorSM, hypo );
525 SMESH_Hypothesis_var hypo = SMESH_Hypothesis::_narrow( SObjectToObject( aHypObj ) );
526 SObjectList meshList = GetMeshesUsingAlgoOrHypothesis( hypo );
527 for( int i = 0; i < meshList.size(); i++ )
528 RemoveHypothesisOrAlgorithmOnMesh( meshList[ i ], hypo );
532 catch(const SALOME::SALOME_Exception& S_ex)
535 SalomeApp_Tools::QtCatchCorbaException(S_ex);
536 res = SMESH::HYP_UNKNOWN_FATAL;
538 return res < SMESH::HYP_UNKNOWN_FATAL;
541 bool RemoveHypothesisOrAlgorithmOnMesh (_PTR(SObject) MorSM,
542 SMESH::SMESH_Hypothesis_ptr anHyp)
544 SALOMEDS::GenericAttribute_var anAttr;
545 SALOMEDS::AttributeIOR_var anIOR;
546 int res = SMESH::HYP_UNKNOWN_FATAL;
547 SUIT_OverrideCursor wc;
551 GEOM::GEOM_Object_var aShapeObject = SMESH::GetShapeOnMeshOrSubMesh(MorSM);
552 SMESH::SMESH_Mesh_var aMesh = SMESH::SObjectToInterface<SMESH::SMESH_Mesh>(MorSM);
553 SMESH::SMESH_subMesh_var aSubMesh = SMESH::SObjectToInterface<SMESH::SMESH_subMesh>(MorSM);
555 if (!aSubMesh->_is_nil())
556 aMesh = aSubMesh->GetFather();
558 if (!aMesh->_is_nil()) {
559 if (aMesh->HasShapeToMesh() && !aShapeObject->_is_nil()) {
560 res = aMesh->RemoveHypothesis(aShapeObject, anHyp);
561 if (res < SMESH::HYP_UNKNOWN_FATAL) {
562 _PTR(SObject) meshSO = SMESH::FindSObject(aMesh);
564 SMESH::ModifiedMesh(meshSO, false, aMesh->NbNodes()==0);
568 else if(!aMesh->HasShapeToMesh()){
569 res = aMesh->RemoveHypothesis(aShapeObject, anHyp);
570 if (res < SMESH::HYP_UNKNOWN_FATAL) {
571 _PTR(SObject) meshSO = SMESH::FindSObject(aMesh);
573 SMESH::ModifiedMesh(meshSO, false, aMesh->NbNodes()==0);
576 if (res > SMESH::HYP_OK) {
578 processHypothesisStatus(res, anHyp, false);
582 } catch(const SALOME::SALOME_Exception& S_ex) {
584 SalomeApp_Tools::QtCatchCorbaException(S_ex);
585 res = SMESH::HYP_UNKNOWN_FATAL;
588 return res < SMESH::HYP_UNKNOWN_FATAL;
591 SObjectList GetMeshesUsingAlgoOrHypothesis(SMESH::SMESH_Hypothesis_ptr AlgoOrHyp)
593 SObjectList listSOmesh;
594 listSOmesh.resize(0);
596 unsigned int index = 0;
597 if (!AlgoOrHyp->_is_nil()) {
598 _PTR(SObject) SO_Hypothesis = SMESH::FindSObject(AlgoOrHyp);
601 SMESHGUI::activeStudy()->studyDS()->FindDependances(SO_Hypothesis);
603 if(MYDEBUG) MESSAGE("SMESHGUI::GetMeshesUsingAlgoOrHypothesis(): dependency number ="<<listSO.size());
604 for (unsigned int i = 0; i < listSO.size(); i++) {
605 _PTR(SObject) SO = listSO[i];
607 _PTR(SObject) aFather = SO->GetFather();
609 _PTR(SObject) SOfatherFather = aFather->GetFather();
610 if (SOfatherFather) {
611 if(MYDEBUG) MESSAGE("SMESHGUI::GetMeshesUsingAlgoOrHypothesis(): dependency added to list");
613 listSOmesh.resize(index);
614 listSOmesh[index - 1] = SOfatherFather;
621 if (MYDEBUG) MESSAGE("SMESHGUI::GetMeshesUsingAlgoOrHypothesis(): completed");
625 #define CASE2MESSAGE(enum) case SMESH::enum: msg = QObject::tr( "STATE_" #enum ); break;
626 QString GetMessageOnAlgoStateErrors(const algo_error_array& errors)
628 QString resMsg; // PAL14861 = QObject::tr("SMESH_WRN_MISSING_PARAMETERS") + ":\n";
629 for ( int i = 0; i < errors.length(); ++i ) {
630 const SMESH::AlgoStateError & error = errors[ i ];
631 const bool hasAlgo = ( strlen( error.algoName ) != 0 );
634 msg = QObject::tr( "STATE_ALGO_MISSING" );
636 switch( error.state ) {
637 CASE2MESSAGE( HYP_MISSING );
638 CASE2MESSAGE( HYP_NOTCONFORM );
639 CASE2MESSAGE( HYP_BAD_PARAMETER );
640 CASE2MESSAGE( HYP_BAD_GEOMETRY );
643 // apply args to message:
646 msg = msg.arg( error.algoName.in() );
648 msg = msg.arg( error.algoDim );
650 msg = msg.arg( QObject::tr( error.isGlobalAlgo ? "GLOBAL_ALGO" : "LOCAL_ALGO" ));
651 // %4 - hypothesis dim == algoDim
652 msg = msg.arg( error.algoDim );
654 if ( i ) resMsg += ";\n";
659 } // end of namespace SMESH