Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[FEATURE] [needs-docs] Add circular data dependencies #30947

Merged
merged 6 commits into from
Aug 26, 2019
Merged

[FEATURE] [needs-docs] Add circular data dependencies #30947

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
88d7008
[FEATURE] [needs-docs] Add circular data dependencies
troopa81 Jul 26, 2019
2428244
fix test
troopa81 Jul 26, 2019
8983695
Set hasDependencyCycle as deprecated
troopa81 Jul 31, 2019
410a1ae
Forget the sip file
troopa81 Jul 31, 2019
ef457cc
Fix tests: Reset project for each test so each test in independant
troopa81 Jul 31, 2019
5fba98d
Correct deprecated messages
troopa81 Jul 31, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion python/core/auto_generated/qgsmaplayer.sip.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1653,9 +1653,12 @@ Sets error message



bool hasDependencyCycle( const QSet<QgsMapLayerDependency> &layers ) const;
bool hasDependencyCycle( const QSet<QgsMapLayerDependency> & ) const;
%Docstring
Checks whether a new set of dependencies will introduce a cycle
this method is now deprecated and always return false, because circular dependencies are now correctly managed.

.. deprecated:: since QGIS 3.10
%End


Expand Down
5 changes: 0 additions & 5 deletions src/app/qgsvectorlayerproperties.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -350,11 +350,6 @@ QgsVectorLayerProperties::QgsVectorLayerProperties(
restoreOptionsBaseUi( title );

mLayersDependenciesTreeGroup.reset( QgsProject::instance()->layerTreeRoot()->clone() );
QgsLayerTreeLayer *layer = mLayersDependenciesTreeGroup->findLayer( mLayer->id() );
if ( layer )
{
layer->parent()->takeChild( layer );
}
mLayersDependenciesTreeModel.reset( new QgsLayerTreeModel( mLayersDependenciesTreeGroup.get() ) );
// use visibility as selection
mLayersDependenciesTreeModel->setFlag( QgsLayerTreeModel::AllowNodeChangeVisibility );
Expand Down
56 changes: 5 additions & 51 deletions src/core/qgsmaplayer.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1769,7 +1769,12 @@ QgsAbstract3DRenderer *QgsMapLayer::renderer3D() const

void QgsMapLayer::triggerRepaint( bool deferredUpdate )
{
if ( mRepaintRequestedFired )
return;

mRepaintRequestedFired = true;
emit repaintRequested( deferredUpdate );
mRepaintRequestedFired = false;
}

void QgsMapLayer::setMetadata( const QgsLayerMetadata &metadata )
Expand Down Expand Up @@ -1799,54 +1804,6 @@ void QgsMapLayer::setExtent( const QgsRectangle &r )
mExtent = r;
}

static QList<const QgsMapLayer *> _depOutEdges( const QgsMapLayer *vl, const QgsMapLayer *that, const QSet<QgsMapLayerDependency> &layers )
{
QList<const QgsMapLayer *> lst;
if ( vl == that )
{
const auto constLayers = layers;
for ( const QgsMapLayerDependency &dep : constLayers )
{
if ( const QgsMapLayer *l = QgsProject::instance()->mapLayer( dep.layerId() ) )
lst << l;
}
}
else
{
const auto constDependencies = vl->dependencies();
for ( const QgsMapLayerDependency &dep : constDependencies )
{
if ( const QgsMapLayer *l = QgsProject::instance()->mapLayer( dep.layerId() ) )
lst << l;
}
}
return lst;
}

static bool _depHasCycleDFS( const QgsMapLayer *n, QHash<const QgsMapLayer *, int> &mark, const QgsMapLayer *that, const QSet<QgsMapLayerDependency> &layers )
{
if ( mark.value( n ) == 1 ) // temporary
return true;
if ( mark.value( n ) == 0 ) // not visited
{
mark[n] = 1; // temporary
const auto depOutEdges { _depOutEdges( n, that, layers ) };
for ( const QgsMapLayer *m : depOutEdges )
{
if ( _depHasCycleDFS( m, mark, that, layers ) )
return true;
}
mark[n] = 2; // permanent
}
return false;
}

bool QgsMapLayer::hasDependencyCycle( const QSet<QgsMapLayerDependency> &layers ) const
{
QHash<const QgsMapLayer *, int> marks;
return _depHasCycleDFS( this, marks, this, layers );
}

bool QgsMapLayer::isReadOnly() const
{
return true;
Expand Down Expand Up @@ -1902,8 +1859,6 @@ bool QgsMapLayer::setDependencies( const QSet<QgsMapLayerDependency> &oDeps )
if ( dep.origin() == QgsMapLayerDependency::FromUser )
deps << dep;
}
if ( hasDependencyCycle( deps ) )
return false;

mDependencies = deps;
emit dependenciesChanged();
Expand Down Expand Up @@ -1933,4 +1888,3 @@ void QgsMapLayer::onNotifiedTriggerRepaint( const QString &message )
if ( refreshOnNotifyMessage().isEmpty() || refreshOnNotifyMessage() == message )
triggerRepaint();
}

11 changes: 8 additions & 3 deletions src/core/qgsmaplayer.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1499,8 +1499,12 @@ class CORE_EXPORT QgsMapLayer : public QObject
//! List of layers that may modify this layer on modification
QSet<QgsMapLayerDependency> mDependencies;

//! Checks whether a new set of dependencies will introduce a cycle
bool hasDependencyCycle( const QSet<QgsMapLayerDependency> &layers ) const;
troopa81 marked this conversation as resolved.
Show resolved Hide resolved
/**
* Checks whether a new set of dependencies will introduce a cycle
* this method is now deprecated and always return false, because circular dependencies are now correctly managed.
* \deprecated since QGIS 3.10
*/
Q_DECL_DEPRECATED bool hasDependencyCycle( const QSet<QgsMapLayerDependency> & ) const {return false;}

bool mIsRefreshOnNofifyEnabled = false;
QString mRefreshOnNofifyMessage;
Expand Down Expand Up @@ -1585,7 +1589,8 @@ class CORE_EXPORT QgsMapLayer : public QObject
*/
QString mOriginalXmlProperties;


//! To avoid firing multiple time repaintRequested signal on circular layer circular dependencies
bool mRepaintRequestedFired = false;
};

Q_DECLARE_METATYPE( QgsMapLayer * )
Expand Down
42 changes: 25 additions & 17 deletions src/core/qgsvectorlayer.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ QgsVectorLayer::QgsVectorLayer( const QString &vectorLayerPath,
setDataSource( vectorLayerPath, baseName, providerKey, providerOptions, options.loadDefaultStyle );
}

connect( this, &QgsVectorLayer::selectionChanged, this, [ = ] { emit repaintRequested(); } );
connect( this, &QgsVectorLayer::selectionChanged, this, [ = ] { triggerRepaint(); } );
connect( QgsProject::instance()->relationManager(), &QgsRelationManager::relationsLoaded, this, &QgsVectorLayer::onRelationsLoaded );

connect( this, &QgsVectorLayer::subsetStringChanged, this, &QgsMapLayer::configChanged );
Expand Down Expand Up @@ -901,7 +901,7 @@ bool QgsVectorLayer::setSubsetString( const QString &subset )
if ( res )
{
emit subsetStringChanged();
emit repaintRequested();
triggerRepaint();
}

return res;
Expand Down Expand Up @@ -1578,7 +1578,7 @@ void QgsVectorLayer::setDataSource( const QString &dataSource, const QString &ba
}

emit dataSourceChanged();
emit repaintRequested();
triggerRepaint();
}

QString QgsVectorLayer::loadDefaultStyle( bool &resultFlag )
Expand Down Expand Up @@ -1702,7 +1702,7 @@ bool QgsVectorLayer::setDataProvider( QString const &provider, const QgsDataProv
mDataSource = mDataSource + QStringLiteral( "&uid=%1" ).arg( QUuid::createUuid().toString() );
}

connect( mDataProvider, &QgsVectorDataProvider::dataChanged, this, &QgsVectorLayer::dataChanged );
connect( mDataProvider, &QgsVectorDataProvider::dataChanged, this, &QgsVectorLayer::emitDataChanged );
connect( mDataProvider, &QgsVectorDataProvider::dataChanged, this, &QgsVectorLayer::removeSelection );

return true;
Expand Down Expand Up @@ -2991,7 +2991,7 @@ bool QgsVectorLayer::commitChanges()

mDataProvider->leaveUpdateMode();

emit repaintRequested();
triggerRepaint();

return success;
}
Expand Down Expand Up @@ -3040,7 +3040,7 @@ bool QgsVectorLayer::rollBack( bool deleteBuffer )

mDataProvider->leaveUpdateMode();

emit repaintRequested();
triggerRepaint();
return true;
}

Expand Down Expand Up @@ -4654,6 +4654,16 @@ QSet<QgsMapLayerDependency> QgsVectorLayer::dependencies() const
return mDependencies;
}

void QgsVectorLayer::emitDataChanged()
{
if ( mDataChangedFired )
return;

mDataChangedFired = true;
emit dataChanged();
mDataChangedFired = false;
}

bool QgsVectorLayer::setDependencies( const QSet<QgsMapLayerDependency> &oDeps )
{
QSet<QgsMapLayerDependency> deps;
Expand All @@ -4663,8 +4673,6 @@ bool QgsVectorLayer::setDependencies( const QSet<QgsMapLayerDependency> &oDeps )
if ( dep.origin() == QgsMapLayerDependency::FromUser )
deps << dep;
}
if ( hasDependencyCycle( deps ) )
return false;

QSet<QgsMapLayerDependency> toAdd = deps - dependencies();

Expand All @@ -4674,10 +4682,10 @@ bool QgsVectorLayer::setDependencies( const QSet<QgsMapLayerDependency> &oDeps )
QgsVectorLayer *lyr = static_cast<QgsVectorLayer *>( QgsProject::instance()->mapLayer( dep.layerId() ) );
if ( !lyr )
continue;
disconnect( lyr, &QgsVectorLayer::featureAdded, this, &QgsVectorLayer::dataChanged );
disconnect( lyr, &QgsVectorLayer::featureDeleted, this, &QgsVectorLayer::dataChanged );
disconnect( lyr, &QgsVectorLayer::geometryChanged, this, &QgsVectorLayer::dataChanged );
disconnect( lyr, &QgsVectorLayer::dataChanged, this, &QgsVectorLayer::dataChanged );
disconnect( lyr, &QgsVectorLayer::featureAdded, this, &QgsVectorLayer::emitDataChanged );
disconnect( lyr, &QgsVectorLayer::featureDeleted, this, &QgsVectorLayer::emitDataChanged );
disconnect( lyr, &QgsVectorLayer::geometryChanged, this, &QgsVectorLayer::emitDataChanged );
disconnect( lyr, &QgsVectorLayer::dataChanged, this, &QgsVectorLayer::emitDataChanged );
disconnect( lyr, &QgsVectorLayer::repaintRequested, this, &QgsVectorLayer::triggerRepaint );
}

Expand All @@ -4694,16 +4702,16 @@ bool QgsVectorLayer::setDependencies( const QSet<QgsMapLayerDependency> &oDeps )
QgsVectorLayer *lyr = static_cast<QgsVectorLayer *>( QgsProject::instance()->mapLayer( dep.layerId() ) );
if ( !lyr )
continue;
connect( lyr, &QgsVectorLayer::featureAdded, this, &QgsVectorLayer::dataChanged );
connect( lyr, &QgsVectorLayer::featureDeleted, this, &QgsVectorLayer::dataChanged );
connect( lyr, &QgsVectorLayer::geometryChanged, this, &QgsVectorLayer::dataChanged );
connect( lyr, &QgsVectorLayer::dataChanged, this, &QgsVectorLayer::dataChanged );
connect( lyr, &QgsVectorLayer::featureAdded, this, &QgsVectorLayer::emitDataChanged );
connect( lyr, &QgsVectorLayer::featureDeleted, this, &QgsVectorLayer::emitDataChanged );
connect( lyr, &QgsVectorLayer::geometryChanged, this, &QgsVectorLayer::emitDataChanged );
connect( lyr, &QgsVectorLayer::dataChanged, this, &QgsVectorLayer::emitDataChanged );
connect( lyr, &QgsVectorLayer::repaintRequested, this, &QgsVectorLayer::triggerRepaint );
}

// if new layers are present, emit a data change
if ( ! toAdd.isEmpty() )
emit dataChanged();
emitDataChanged();

return true;
}
Expand Down
4 changes: 4 additions & 0 deletions src/core/qgsvectorlayer.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2464,6 +2464,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte
void onRelationsLoaded();
void onSymbolsCounted();
void onDirtyTransaction( const QString &sql, const QString &name );
void emitDataChanged();

private:
void updateDefaultValues( QgsFeatureId fid, QgsFeature feature = QgsFeature() );
Expand Down Expand Up @@ -2626,6 +2627,9 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte
bool mAllowCommit = true;

friend class QgsVectorLayerFeatureSource;

//! To avoid firing multiple time dataChanged signal on circular layer circular dependencies
bool mDataChangedFired = false;
};


Expand Down
Loading