+// Copyright (C) 2007-2024 CEA, EDF, OPEN CASCADE
+//
+// Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
+// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
+
// File: SalomeApp_DataModel.cxx
// Created: 10/25/2004 10:36:06 AM
// Author: Sergey LITONIN
-// Copyright (C) CEA 2004
#include "SalomeApp_DataModel.h"
#include "SalomeApp_Study.h"
#include "SalomeApp_DataObject.h"
#include "SalomeApp_Module.h"
#include "SalomeApp_Application.h"
-#include "SalomeApp_Engine_i.hxx"
-
-#include "LightApp_RootObject.h"
#include <CAM_DataObject.h>
-#include <SUIT_Application.h>
-#include <SUIT_ResourceMgr.h>
-#include <SUIT_Session.h>
-
-#include "SALOMEDS_Tool.hxx"
+#include <SUIT_TreeSync.h>
+#include <SUIT_DataObjectIterator.h>
#include <SALOMEconfig.h>
#include CORBA_SERVER_HEADER(SALOME_Exception)
-//=======================================================================
-// name : BuildTree
-/*!Purpose : static method used by SalomeApp_Study and SalomeApp_DataModel classes
- * to create default SALOMEDS-based data object tree
- */
-//=======================================================================
-SUIT_DataObject* SalomeApp_DataModel::BuildTree( const _PTR(SObject)& obj,
- SUIT_DataObject* parent,
- SalomeApp_Study* study,
- bool skip )
-{
- SalomeApp_DataObject* aDataObj = 0;
- if ( !obj || !study )
- return aDataObj;
-
- _PTR(SObject) refObj;
- if ( obj->GetName().size() || obj->ReferencedObject( refObj ) ) // skip nameless non references SObjects
+typedef _PTR(SObject) kerPtr;
+typedef SUIT_DataObject* suitPtr;
+
+/*!
+ \class SalomeApp_DataModelSync
+ Auxiliary class for synchronizing tree of kernel objects and SUIT_DataObjects
+*/
+class SalomeApp_DataModelSync
+{
+public:
+ SalomeApp_DataModelSync( _PTR( Study ), SUIT_DataObject* );
+
+ bool isEqual( const kerPtr&, const suitPtr& ) const;
+ kerPtr nullSrc() const;
+ suitPtr nullTrg() const;
+ suitPtr createItem( const kerPtr&, const suitPtr&, const suitPtr& ) const;
+ void updateItem( const kerPtr&, const suitPtr& ) const;
+ void deleteItemWithChildren( const suitPtr& ) const;
+ QList<kerPtr> children( const kerPtr& ) const;
+ QList<suitPtr> children( const suitPtr& ) const;
+ suitPtr parent( const suitPtr& ) const;
+
+private:
+ bool isCorrect( const kerPtr& ) const;
+
+private:
+ _PTR( Study ) myStudy;
+ SUIT_DataObject* myRoot;
+};
+
+/*!
+ Constructor
+*/
+SalomeApp_DataModelSync::SalomeApp_DataModelSync( _PTR( Study ) aStudy, SUIT_DataObject* aRoot )
+: myStudy( aStudy ),
+ myRoot( aRoot )
+{
+}
+
+/*!
+ \return true if kernel object is correct (has non empty name or is reference)
+*/
+bool SalomeApp_DataModelSync::isCorrect( const kerPtr& so ) const
+{
+#ifdef WITH_SALOMEDS_OBSERVER
+ // with GUI observers this function is not needed anymore
+ return true;
+#endif
+ kerPtr refObj;
+ QString name = so->GetName().c_str();
+ _PTR( GenericAttribute ) anAttr;
+ bool isDraw = true;
+ if ( so->FindAttribute(anAttr, "AttributeDrawable") )
{
- _PTR(SComponent) aSComp( obj );
+ _PTR(AttributeDrawable) aAttrDraw = anAttr;
+ isDraw = aAttrDraw->IsDrawable();
+ }
+ bool res = so && ( so->GetName().size() || so->ReferencedObject( refObj ) ) && isDraw;
+ return res;
+}
- // patch for bug IPAL9313
- if ( aSComp && parent && skip )
- {
- QString aSName( aSComp->GetName().c_str() );
- DataObjectList allComponents = parent->children( /*recursive=*/false );
- for ( DataObjectListIterator it( allComponents ); it.current(); ++it ) {
- SUIT_DataObject* componentObj = it.current();
- if ( componentObj->name() == aSName ) {
- //mkr : modifications for update already published in
- //object browser, but not loaded yet component
- LightApp_Application* anApp = dynamic_cast<LightApp_Application*>
- ( SUIT_Session::session()->activeApplication() );
- // asv : corresponding DataObjects are DELETED before update (so they are re-built).
- if (anApp && !anApp->module(aSName)) { // if module is not loaded, delete it's DataObject
- // jfa: remove children before DataObject deletion
- DataObjectList chilren = componentObj->children(/*recursive=*/true);
- for (DataObjectListIterator itc (chilren); itc.current(); ++itc)
- componentObj->removeChild(itc.current());
-
- // delete DataObject itself and re-create it and all its sub-objects
- delete componentObj;
- // don't do anything here, because iterator may be corrupted (deleted object inside it)
- break; // proceed to build_a_data_object code below
- }
- else
- return componentObj;
- }
- }
- }
+/*!
+ Creates SUIT object by KERNEL object
+ \param so - corresponding KERNEL object
+ \param parent - parent for SUIT object
+ \param after - previous sibling for SUIT object
+ \param prepend - SUIT object must be added to start of children list
+*/
+suitPtr SalomeApp_DataModelSync::createItem( const kerPtr& so,
+ const suitPtr& parent,
+ const suitPtr& after ) const
+{
+ if( !isCorrect( so ) )
+ return 0;
+
+ _PTR(SComponent) aSComp( so );
+ suitPtr nitem = aSComp ? new SalomeApp_ModuleObject( aSComp, 0 ) :
+ new SalomeApp_DataObject( so, 0 );
+
+ if( parent ) {
+ int pos = after ? parent->childPos( after ) : 0;
+ parent->insertChild( nitem, pos+1 );
+ }
+ else if( myRoot ) {
+ myRoot->appendChild( nitem );
+ }
+ return nitem;
+}
+
+/*!
+ Deletes object with all children
+ \param p - SUIT object
+*/
+void SalomeApp_DataModelSync::deleteItemWithChildren( const suitPtr& p ) const
+{
+ if( !p )
+ return;
+
+ DataObjectList ch;
+ p->children( ch );
+ DataObjectList::const_iterator anIt = ch.begin(), aLast = ch.end();
+ for( ; anIt!=aLast; anIt++ )
+ deleteItemWithChildren( *anIt );
+ delete p;
+}
+
+/*!
+ \return true if objects correspond each other at all
+ \param p - kernel object
+ \param q - suit object
+*/
+bool SalomeApp_DataModelSync::isEqual( const kerPtr& p, const suitPtr& q ) const
+{
+ LightApp_ModuleObject* lobj = dynamic_cast<LightApp_ModuleObject*>( q );
+ SalomeApp_DataObject* sobj = dynamic_cast<SalomeApp_DataObject*>( q );
+ _PTR( SComponent ) aComp( p );
+ bool res = ( !p && !q ) ||
+ ( lobj && !sobj && aComp ) ||
+ ( sobj && isCorrect( p ) && p->GetID().c_str()==sobj->entry() );
+ return res;
+}
+
+/*!
+ \return null kernel object
+*/
+kerPtr SalomeApp_DataModelSync::nullSrc() const
+{
+ return kerPtr();
+}
+
+/*!
+ \return null suit object
+*/
+suitPtr SalomeApp_DataModelSync::nullTrg() const
+{
+ return 0;
+}
- aDataObj = aSComp ? new SalomeApp_ModuleObject( aSComp, parent ) :
- new SalomeApp_DataObject ( obj, parent );
+/*!
+ Fills list with children of kernel object
+ \param obj - kernel object
+ \param ch - list to be filled
+*/
+QList<kerPtr> SalomeApp_DataModelSync::children( const kerPtr& obj ) const
+{
+ QList<kerPtr> ch;
- _PTR(ChildIterator) it ( study->studyDS()->NewChildIterator( obj ) );
- for ( ; it->More(); it->Next() ) {
- // don't use shared_ptr here, for Data Object will take
- // ownership of this pointer
- _PTR(SObject) aSO( it->Value() );
- BuildTree( aSO, aDataObj, study );
+ _PTR( GenericAttribute ) anAttr;
+ bool expandable = true;
+ if ( obj && obj->FindAttribute( anAttr, "AttributeExpandable" ) ) {
+ _PTR(AttributeExpandable) aAttrExp = anAttr;
+ expandable = aAttrExp->IsExpandable();
+ }
+
+ if ( expandable ) {
+ // tmp??
+ _PTR(UseCaseBuilder) aUseCaseBuilder = myStudy->GetUseCaseBuilder();
+ if (aUseCaseBuilder->HasChildren(obj)) {
+ _PTR(UseCaseIterator) it ( aUseCaseBuilder->GetUseCaseIterator( obj ) );
+ for ( ; it->More(); it->Next() )
+ ch.append( it->Value() );
+ }
+ else {
+ _PTR(ChildIterator) it ( myStudy->NewChildIterator( obj ) );
+ for ( ; it->More(); it->Next() )
+ ch.append( it->Value() );
}
}
- return aDataObj;
+
+ return ch;
+}
+
+/*!
+ Fills list with children of SUIT object
+ \param p - SUIT object
+ \param ch - list to be filled
+*/
+QList<suitPtr> SalomeApp_DataModelSync::children( const suitPtr& p ) const
+{
+ QList<suitPtr> ch;
+ if ( p )
+ ch = p->children();
+ return ch;
+}
+
+/*!
+ \return parent of SUIT object
+ \param p - SUIT object
+*/
+suitPtr SalomeApp_DataModelSync::parent( const suitPtr& p ) const
+{
+ return p ? p->parent(): 0;
+}
+
+/*!
+ Updates SUIT object
+ \param p - SUIT object
+*/
+void SalomeApp_DataModelSync::updateItem( const kerPtr&, const suitPtr& ) const
+{
}
-//=======================================================================
-// name : SalomeApp_DataModel::SalomeApp_DataModel
-/*!Purpose : Constructor*/
-//=======================================================================
+/*!
+ Auxiliary function, shows SUIT tree
+*/
+void showTree( SUIT_DataObject* root )
+{
+ qDebug( root ? "<tree>" : "<empty tree>" );
+ if( !root )
+ return;
+
+ SUIT_DataObjectIterator it( root, SUIT_DataObjectIterator::DepthLeft );
+ for( ; it.current(); ++it )
+ {
+ QString marg; marg.fill( ' ', 3*it.depth() );
+ QString nnn = "%1 '%2'";
+ qDebug( nnn.arg( marg ).arg( it.current()->name() ).toUtf8() );
+ }
+}
+
+/*!
+ Constructor
+*/
SalomeApp_DataModel::SalomeApp_DataModel( CAM_Module* theModule )
: LightApp_DataModel( theModule )
{
}
-//=======================================================================
-// name : SalomeApp_DataModel::~SalomeApp_DataModel
-/*! Purpose : Destructor*/
-//=======================================================================
+/*!
+ Destructor
+*/
SalomeApp_DataModel::~SalomeApp_DataModel()
{
}
-//================================================================
-// Function : open
-/*! Purpose : Open data model*/
-//================================================================
-bool SalomeApp_DataModel::open( const QString& name, CAM_Study* study )
+/*!
+ Opens data model
+*/
+bool SalomeApp_DataModel::open( const QString& name, CAM_Study* study, QStringList )
{
SalomeApp_Study* aDoc = dynamic_cast<SalomeApp_Study*>( study );
if ( !aDoc )
if ( anId.isEmpty() )
return true; // Probably nothing to load
- _PTR(Study) aStudy ( aDoc->studyDS() ); // shared_ptr cannot be used here
- _PTR(SComponent) aSComp ( aStudy->FindComponentID( std::string( anId.latin1() ) ) );
+ _PTR(SComponent) aSComp ( SalomeApp_Application::getStudy()->FindComponentID( std::string( anId.toUtf8() ) ) );
if ( aSComp )
- buildTree( aSComp, 0, aDoc );
+ updateTree( aSComp, aDoc );
+
+ QStringList listOfFiles;
+ LightApp_DataModel::open(name, study, listOfFiles);
+ return true;
+}
- LightApp_DataModel::open(name, study);
+/*!
+ Creates data model
+*/
+bool SalomeApp_DataModel::create( CAM_Study* theStudy )
+{
+ update(NULL, (LightApp_Study*)theStudy);
return true;
}
-//================================================================
-// Function : update
-/*! Purpose : Update application.*/
-//================================================================
+/*!
+ Updates application.
+*/
void SalomeApp_DataModel::update( LightApp_DataObject*, LightApp_Study* study )
{
- SalomeApp_Study* aSStudy = 0;
+ SalomeApp_Study* aSStudy = dynamic_cast<SalomeApp_Study*>(study);
LightApp_RootObject* studyRoot = 0;
- _PTR(SObject) sobj;
+ _PTR(SComponent) sobj;
SalomeApp_DataObject* modelRoot = dynamic_cast<SalomeApp_DataObject*>( root() );
if ( !modelRoot ){ // not yet connected to a study -> try using <study> argument
- aSStudy = dynamic_cast<SalomeApp_Study*>( study );
if ( !aSStudy )
aSStudy = dynamic_cast<SalomeApp_Study*>( getModule()->getApp()->activeStudy() );
if ( aSStudy ){
studyRoot = dynamic_cast<LightApp_RootObject*>( aSStudy->root() );
- if ( studyRoot ) {
- QString anId = getRootEntry( aSStudy );
- if ( !anId.isEmpty() ){ // if nothing is published in the study for this module -> do nothing
- _PTR(Study) aStudy ( aSStudy->studyDS() );
- sobj = aStudy->FindComponentID( std::string( anId.latin1() ) );
- }
+ QString anId = getRootEntry( aSStudy );
+ if ( !anId.isEmpty() ){ // if nothing is published in the study for this module -> do nothing
+ sobj = SalomeApp_Application::getStudy()->FindComponentID( std::string( anId.toUtf8() ) );
}
}
}
else{
studyRoot = dynamic_cast<LightApp_RootObject*>( modelRoot->root() );
if ( studyRoot ) {
- aSStudy = dynamic_cast<SalomeApp_Study*>( study );
+ aSStudy = dynamic_cast<SalomeApp_Study*>( studyRoot->study() ); // <study> value should not change here theoretically, but just to make sure
if ( aSStudy ) {
- aSStudy = dynamic_cast<SalomeApp_Study*>( studyRoot->study() ); // <study> value should not change here theoretically, but just to make sure
- if ( aSStudy ) {
- _PTR(Study) aStudy ( aSStudy->studyDS() );
- // modelRoot->object() cannot be reused here: it is about to be deleted by buildTree() soon
- sobj = aStudy->FindComponentID( std::string( modelRoot->entry().latin1() ) );
- }
+ // modelRoot->object() cannot be reused here: it is about to be deleted by buildTree() soon
+ sobj = SalomeApp_Application::getStudy()->FindComponentID( std::string( modelRoot->entry().toUtf8() ) );
}
}
}
- buildTree( sobj, studyRoot, aSStudy );
+ if ( sobj && aSStudy )
+ updateTree( sobj, aSStudy );
}
-//================================================================
-// Function : buildTree
-/*! Purpose : private method, build tree.*/
-//================================================================
-void SalomeApp_DataModel::buildTree( const _PTR(SObject)& obj,
- SUIT_DataObject* parent,
- SalomeApp_Study* study )
+/*!
+ Synchronizes kernel tree and suit data tree starting from component 'sobj'
+*/
+SUIT_DataObject* SalomeApp_DataModel::synchronize( const _PTR( SComponent )& sobj, SalomeApp_Study* study )
{
- if ( !obj )
- return;
- //if ( !root() ){ // Build default SALOMEDS-based data object tree and insert it into study
- SalomeApp_ModuleObject* aNewRoot = dynamic_cast<SalomeApp_ModuleObject*>( BuildTree( obj, parent, study ) );
- if ( aNewRoot ){
- aNewRoot->setDataModel( this );
- setRoot( aNewRoot );
+ if( !study || !study->root() || !sobj )
+ return 0;
+
+ DataObjectList ch; study->root()->children( ch );
+ DataObjectList::const_iterator anIt = ch.begin(), aLast = ch.end();
+ SUIT_DataObject* suitObj = 0;
+ for( ; anIt!=aLast; anIt++ )
+ {
+ LightApp_DataObject* dobj = dynamic_cast<LightApp_DataObject*>( *anIt );
+ if( dobj && dobj->name() == sobj->GetName().c_str() )
+ {
+ suitObj = dobj;
+ break;
}
- //}
+ }
+
+#ifdef WITH_SALOMEDS_OBSERVER
+ SalomeApp_RootObject* root=dynamic_cast<SalomeApp_RootObject*>(study->root());
+ if(!(root->toSynchronize()))
+ return suitObj;
+#endif
+
+ SalomeApp_DataModelSync sync( study->studyDS(), study->root() );
+
+ if( !suitObj || dynamic_cast<SalomeApp_DataObject*>( suitObj ) )
+ suitObj= ::synchronize<kerPtr,suitPtr,SalomeApp_DataModelSync>( sobj, suitObj, sync );
+ else
+ suitObj= 0;
+
+ return suitObj;
}
-//================================================================
-// Function : getModule
-/*! Purpose : gets module*/
-//================================================================
+/*!
+ Updates tree.
+*/
+void SalomeApp_DataModel::updateTree( const _PTR( SComponent )& comp, SalomeApp_Study* study )
+{
+ SalomeApp_ModuleObject* aNewRoot = dynamic_cast<SalomeApp_ModuleObject*>( synchronize( comp, study ) );
+ if( aNewRoot )
+ {
+ aNewRoot->setDataModel( this );
+ setRoot( aNewRoot );
+ }
+}
+/*!
+ \return module
+*/
SalomeApp_Module* SalomeApp_DataModel::getModule() const
{
return dynamic_cast<SalomeApp_Module*>( module() );
}
-//================================================================
-// Function : getStudy
-/*! Purpose : gets study */
-//================================================================
+/*!
+ \return study
+*/
SalomeApp_Study* SalomeApp_DataModel::getStudy() const
{
if(!root()) return 0;
return aStudy;
}
-//================================================================
-// Function : getRootEntry
-/*! Purpose : returns study entry corresponding to this data model*/
-//================================================================
+/*!
+ \return study entry corresponding to this data model
+*/
QString SalomeApp_DataModel::getRootEntry( SalomeApp_Study* study ) const
{
QString anEntry;
anEntry = anObj->entry();
}
else if ( study && study->studyDS() ) { // this works even if <myRoot> is null
- _PTR(SComponent) aSComp( study->studyDS()->FindComponent( module()->name() ) );
+ _PTR(SComponent) aSComp( study->studyDS()->FindComponent( module()->name().toStdString() ) );
if ( aSComp )
anEntry = aSComp->GetID().c_str();
}