Add typedefs for QPointer QgsMapLayers

nyalldawson · nyalldawson · commit 6c928ef08593 · 2017-02-01T20:57:56.000+10:00
diff --git a/src/core/annotations/qgsannotation.h b/src/core/annotations/qgsannotation.h
@@ -348,7 +348,7 @@ class CORE_EXPORT QgsAnnotation : public QObject
     QPointF mBalloonSegmentPoint2;
 
     //! Associated layer (or nullptr if not attached to a layer)
-    QPointer<QgsMapLayer> mMapLayer;
+    QgsWeakMapLayerPointer mMapLayer;
 
     //! Associated feature, or invalid feature if no feature associated
     QgsFeature mFeature;
diff --git a/src/core/composer/qgscomposermap.cpp b/src/core/composer/qgscomposermap.cpp
@@ -1231,7 +1231,7 @@ bool QgsComposerMap::writeXml( QDomElement& elem, QDomDocument & doc ) const
 
   //layer set
   QDomElement layerSetElem = doc.createElement( QStringLiteral( "LayerSet" ) );
-  Q_FOREACH ( const QPointer<QgsMapLayer>& layerPtr, mLayers )
+  Q_FOREACH ( const QgsWeakMapLayerPointer& layerPtr, mLayers )
   {
     QgsMapLayer* layer = layerPtr.data();
     if ( !layer )
@@ -1557,7 +1557,7 @@ void QgsComposerMap::setLayerStyleOverrides( const QMap<QString, QString>& overr
 void QgsComposerMap::storeCurrentLayerStyles()
 {
   mLayerStyleOverrides.clear();
-  Q_FOREACH ( const QPointer<QgsMapLayer>& layerPtr, mLayers )
+  Q_FOREACH ( const QgsWeakMapLayerPointer& layerPtr, mLayers )
   {
     if ( QgsMapLayer* layer = layerPtr.data() )
     {
diff --git a/src/core/composer/qgscomposermap.h b/src/core/composer/qgscomposermap.h
@@ -23,6 +23,7 @@
 #include "qgsrectangle.h"
 #include "qgscoordinatereferencesystem.h"
 #include "qgsrendercontext.h"
+#include "qgsmaplayer.h"
 #include <QFont>
 #include <QGraphicsRectItem>
 
@@ -542,7 +543,7 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
     bool mKeepLayerSet;
 
     //! Stored layer list (used if layer live-link mKeepLayerSet is disabled)
-    QList< QPointer<QgsMapLayer> > mLayers;
+    QgsWeakMapLayerPointerList mLayers;
 
     bool mKeepLayerStyles;
     //! Stored style names (value) to be used with particular layer IDs (key) instead of default style
diff --git a/src/core/qgsexpression.cpp b/src/core/qgsexpression.cpp
@@ -332,7 +332,7 @@ static QgsExpression::Node* getNode( const QVariant& value, QgsExpression* paren
 
 QgsVectorLayer* getVectorLayer( const QVariant& value, QgsExpression* )
 {
-  QgsMapLayer* ml = value.value< QPointer<QgsMapLayer> >().data();
+  QgsMapLayer* ml = value.value< QgsWeakMapLayerPointer >().data();
   QgsVectorLayer* vl = qobject_cast<QgsVectorLayer*>( ml );
   if ( !vl )
   {
diff --git a/src/core/qgsexpressioncontext.cpp b/src/core/qgsexpressioncontext.cpp
@@ -760,7 +760,7 @@ QgsExpressionContextScope* QgsExpressionContextUtils::layerScope( const QgsMapLa
 
   scope->addVariable( QgsExpressionContextScope::StaticVariable( QStringLiteral( "layer_name" ), layer->name(), true ) );
   scope->addVariable( QgsExpressionContextScope::StaticVariable( QStringLiteral( "layer_id" ), layer->id(), true ) );
-  scope->addVariable( QgsExpressionContextScope::StaticVariable( QStringLiteral( "layer" ), QVariant::fromValue<QPointer<QgsMapLayer> >( QPointer<QgsMapLayer>( const_cast<QgsMapLayer*>( layer ) ) ), true ) );
+  scope->addVariable( QgsExpressionContextScope::StaticVariable( QStringLiteral( "layer" ), QVariant::fromValue<QgsWeakMapLayerPointer >( QgsWeakMapLayerPointer( const_cast<QgsMapLayer*>( layer ) ) ), true ) );
 
   const QgsVectorLayer* vLayer = dynamic_cast< const QgsVectorLayer* >( layer );
   if ( vLayer )
diff --git a/src/core/qgsmaplayer.h b/src/core/qgsmaplayer.h
@@ -920,4 +920,18 @@ class CORE_EXPORT QgsMapLayer : public QObject
 
 Q_DECLARE_METATYPE( QgsMapLayer* )
 
+/**
+ * Weak pointer for QgsMapLayer
+ * @note added in QGIS 3.0
+ * @note not available in Python bindings
+ */
+typedef QPointer< QgsMapLayer > QgsWeakMapLayerPointer;
+
+/**
+ * A list of weak pointers to QgsMapLayers.
+ * @note added in QGIS 3.0
+ * @note not available in Python bindings
+ */
+typedef QList< QgsWeakMapLayerPointer > QgsWeakMapLayerPointerList;
+
 #endif
diff --git a/src/core/qgsmaplayerlistutils.h b/src/core/qgsmaplayerlistutils.h
@@ -16,21 +16,21 @@
 
 /// @cond PRIVATE
 
-inline QList<QgsMapLayer*> _qgis_listQPointerToRaw( const QList< QPointer<QgsMapLayer> >& layers )
+inline QList<QgsMapLayer*> _qgis_listQPointerToRaw( const QgsWeakMapLayerPointerList& layers )
 {
   QList<QgsMapLayer*> lst;
   lst.reserve( layers.count() );
-  Q_FOREACH ( const QPointer<QgsMapLayer>& layerPtr, layers )
+  Q_FOREACH ( const QgsWeakMapLayerPointer& layerPtr, layers )
   {
     if ( layerPtr )
       lst.append( layerPtr.data() );
   }
   return lst;
 }
 
-inline QList< QPointer<QgsMapLayer> > _qgis_listRawToQPointer( const QList<QgsMapLayer*>& layers )
+inline QgsWeakMapLayerPointerList _qgis_listRawToQPointer( const QList<QgsMapLayer*>& layers )
 {
-  QList< QPointer<QgsMapLayer> > lst;
+  QgsWeakMapLayerPointerList lst;
   lst.reserve( layers.count() );
   Q_FOREACH ( QgsMapLayer* layer, layers )
   {
@@ -39,11 +39,11 @@ inline QList< QPointer<QgsMapLayer> > _qgis_listRawToQPointer( const QList<QgsMa
   return lst;
 }
 
-inline QStringList _qgis_listQPointerToIDs( const QList< QPointer<QgsMapLayer> >& layers )
+inline QStringList _qgis_listQPointerToIDs( const QgsWeakMapLayerPointerList& layers )
 {
   QStringList lst;
   lst.reserve( layers.count() );
-  Q_FOREACH ( const QPointer<QgsMapLayer>& layerPtr, layers )
+  Q_FOREACH ( const QgsWeakMapLayerPointer& layerPtr, layers )
   {
     if ( layerPtr )
       lst << layerPtr->id();
@@ -93,7 +93,7 @@ inline static QgsMapLayer* _qgis_findLayer( const QList< QgsMapLayer*> layers, c
   }
 }
 
-inline uint qHash( const QPointer< QgsMapLayer >& key )
+inline uint qHash( const QgsWeakMapLayerPointer& key )
 {
   return qHash( key ? key->id() : QString() );
 }
diff --git a/src/core/qgsmaprenderercache.cpp b/src/core/qgsmaprenderercache.cpp
@@ -35,7 +35,7 @@ void QgsMapRendererCache::clearInternal()
   mScale = 0;
 
   // make sure we are disconnected from all layers
-  Q_FOREACH ( const QPointer< QgsMapLayer >& layer, mConnectedLayers )
+  Q_FOREACH ( const QgsWeakMapLayerPointer& layer, mConnectedLayers )
   {
     if ( layer.data() )
     {
@@ -48,9 +48,9 @@ void QgsMapRendererCache::clearInternal()
 
 void QgsMapRendererCache::dropUnusedConnections()
 {
-  QSet< QPointer< QgsMapLayer > > stillDepends = dependentLayers();
-  QSet< QPointer< QgsMapLayer > > disconnects = mConnectedLayers.subtract( stillDepends );
-  Q_FOREACH ( const QPointer< QgsMapLayer >& layer, disconnects )
+  QSet< QgsWeakMapLayerPointer > stillDepends = dependentLayers();
+  QSet< QgsWeakMapLayerPointer > disconnects = mConnectedLayers.subtract( stillDepends );
+  Q_FOREACH ( const QgsWeakMapLayerPointer& layer, disconnects )
   {
     if ( layer.data() )
     {
@@ -61,13 +61,13 @@ void QgsMapRendererCache::dropUnusedConnections()
   mConnectedLayers = stillDepends;
 }
 
-QSet<QPointer<QgsMapLayer> > QgsMapRendererCache::dependentLayers() const
+QSet<QgsWeakMapLayerPointer > QgsMapRendererCache::dependentLayers() const
 {
-  QSet< QPointer< QgsMapLayer > > result;
+  QSet< QgsWeakMapLayerPointer > result;
   QMap<QString, CacheParameters>::const_iterator it = mCachedImages.constBegin();
   for ( ; it != mCachedImages.constEnd(); ++it )
   {
-    Q_FOREACH ( const QPointer< QgsMapLayer >& l, it.value().dependentLayers )
+    Q_FOREACH ( const QgsWeakMapLayerPointer& l, it.value().dependentLayers )
     {
       if ( l.data() )
         result << l;
@@ -107,7 +107,7 @@ void QgsMapRendererCache::setCacheImage( const QString& cacheKey, const QImage&
     if ( layer )
     {
       params.dependentLayers << layer;
-      if ( !mConnectedLayers.contains( QPointer< QgsMapLayer >( layer ) ) )
+      if ( !mConnectedLayers.contains( QgsWeakMapLayerPointer( layer ) ) )
       {
         connect( layer, &QgsMapLayer::repaintRequested, this, &QgsMapRendererCache::layerRequestedRepaint );
         mConnectedLayers << layer;
diff --git a/src/core/qgsmaprenderercache.h b/src/core/qgsmaprenderercache.h
@@ -99,7 +99,7 @@ class CORE_EXPORT QgsMapRendererCache : public QObject
     struct CacheParameters
     {
       QImage cachedImage;
-      QList< QPointer< QgsMapLayer > > dependentLayers;
+      QgsWeakMapLayerPointerList dependentLayers;
     };
 
     //! Invalidate cache contents (without locking)
@@ -108,7 +108,7 @@ class CORE_EXPORT QgsMapRendererCache : public QObject
     //! Disconnects from layers we no longer care about
     void dropUnusedConnections();
 
-    QSet< QPointer< QgsMapLayer > > dependentLayers() const;
+    QSet< QgsWeakMapLayerPointer > dependentLayers() const;
 
     mutable QMutex mMutex;
     QgsRectangle mExtent;
@@ -117,7 +117,7 @@ class CORE_EXPORT QgsMapRendererCache : public QObject
     //! Map of cache key to cache parameters
     QMap<QString, CacheParameters> mCachedImages;
     //! List of all layers on which this cache is currently connected
-    QSet< QPointer< QgsMapLayer > > mConnectedLayers;
+    QSet< QgsWeakMapLayerPointer > mConnectedLayers;
 };
 
 
diff --git a/src/core/qgsmaprendererjob.h b/src/core/qgsmaprendererjob.h
@@ -50,7 +50,7 @@ struct LayerRenderJob
   QPainter::CompositionMode blendMode;
   double opacity;
   bool cached; // if true, img already contains cached image from previous rendering
-  QPointer< QgsMapLayer > layer;
+  QgsWeakMapLayerPointer layer;
   int renderingTime; //!< Time it took to render the layer in ms (it is -1 if not rendered or still rendering)
 };
 
diff --git a/src/core/qgsmapsettings.cpp b/src/core/qgsmapsettings.cpp
@@ -551,7 +551,7 @@ QgsRectangle QgsMapSettings::fullExtent() const
   // iterate through the map layers and test each layers extent
   // against the current min and max values
   QgsDebugMsg( QString( "Layer count: %1" ).arg( mLayers.count() ) );
-  Q_FOREACH ( const QPointer<QgsMapLayer>& layerPtr, mLayers )
+  Q_FOREACH ( const QgsWeakMapLayerPointer& layerPtr, mLayers )
   {
     if ( QgsMapLayer* lyr = layerPtr.data() )
     {
diff --git a/src/core/qgsmapsettings.h b/src/core/qgsmapsettings.h
@@ -30,13 +30,13 @@
 #include "qgsrectangle.h"
 #include "qgsscalecalculator.h"
 #include "qgsexpressioncontext.h"
+#include "qgsmaplayer.h"
 
 class QPainter;
 
 class QgsCoordinateTransform;
 class QgsScaleCalculator;
 class QgsMapRendererJob;
-class QgsMapLayer;
 
 
 /** \ingroup core
@@ -310,7 +310,7 @@ class CORE_EXPORT QgsMapSettings
     double mMagnificationFactor;
 
     //! list of layers to be rendered (stored as weak pointers)
-    QList< QPointer<QgsMapLayer> > mLayers;
+    QgsWeakMapLayerPointerList mLayers;
     QMap<QString, QString> mLayerStyleOverrides;
     QString mCustomRenderFlags;
     QgsExpressionContext mExpressionContext;
diff --git a/src/core/qgsmapthemecollection.h b/src/core/qgsmapthemecollection.h
@@ -84,7 +84,7 @@ class CORE_EXPORT QgsMapThemeCollection : public QObject
         QSet<QString> checkedLegendItems;
       private:
         //! Weak pointer to the layer
-        QPointer<QgsMapLayer> mLayer;
+        QgsWeakMapLayerPointer mLayer;
     };
 
     /**
diff --git a/tests/src/core/testqgsmapsettings.cpp b/tests/src/core/testqgsmapsettings.cpp
@@ -198,7 +198,7 @@ void TestQgsMapSettings::testMapLayerListUtils()
   l = _qgis_findLayer( listRawSource, QStringLiteral( "z" ) );
   QCOMPARE( !l, true );
 
-  QList< QPointer<QgsMapLayer> > listQPointer = _qgis_listRawToQPointer( listRawSource );
+  QgsWeakMapLayerPointerList listQPointer = _qgis_listRawToQPointer( listRawSource );
 
   QCOMPARE( listQPointer.count(), 2 );
   QCOMPARE( listQPointer[0].data(), vlA );

Original file line number	Diff line number	Diff line change
`@@ -1231,7 +1231,7 @@ bool QgsComposerMap::writeXml( QDomElement& elem, QDomDocument & doc ) const`
`1231`	`1231`
`1232`	`1232`	`//layer set`
`1233`	`1233`	`QDomElement layerSetElem = doc.createElement( QStringLiteral( "LayerSet" ) );`
`1234`		`- Q_FOREACH ( const QPointer<QgsMapLayer>& layerPtr, mLayers )`
	`1234`	`+ Q_FOREACH ( const QgsWeakMapLayerPointer& layerPtr, mLayers )`
`1235`	`1235`	`{`
`1236`	`1236`	`QgsMapLayer* layer = layerPtr.data();`
`1237`	`1237`	`if ( !layer )`
`@@ -1557,7 +1557,7 @@ void QgsComposerMap::setLayerStyleOverrides( const QMap<QString, QString>& overr`
`1557`	`1557`	`void QgsComposerMap::storeCurrentLayerStyles()`
`1558`	`1558`	`{`
`1559`	`1559`	`mLayerStyleOverrides.clear();`
`1560`		`- Q_FOREACH ( const QPointer<QgsMapLayer>& layerPtr, mLayers )`
	`1560`	`+ Q_FOREACH ( const QgsWeakMapLayerPointer& layerPtr, mLayers )`
`1561`	`1561`	`{`
`1562`	`1562`	`if ( QgsMapLayer* layer = layerPtr.data() )`
`1563`	`1563`	`{`
Original file line number	Diff line number	Diff line change
`@@ -332,7 +332,7 @@ static QgsExpression::Node* getNode( const QVariant& value, QgsExpression* paren`
`332`	`332`
`333`	`333`	`QgsVectorLayer* getVectorLayer( const QVariant& value, QgsExpression* )`
`334`	`334`	`{`
`335`		`- QgsMapLayer* ml = value.value< QPointer<QgsMapLayer> >().data();`
	`335`	`+ QgsMapLayer* ml = value.value< QgsWeakMapLayerPointer >().data();`
`336`	`336`	`QgsVectorLayer* vl = qobject_cast<QgsVectorLayer*>( ml );`
`337`	`337`	`if ( !vl )`
`338`	`338`	`{`
Original file line number	Diff line number	Diff line change
`@@ -16,21 +16,21 @@`
`16`	`16`
`17`	`17`	`/// @cond PRIVATE`
`18`	`18`
`19`		`-inline QList<QgsMapLayer*> _qgis_listQPointerToRaw( const QList< QPointer<QgsMapLayer> >& layers )`
	`19`	`+inline QList<QgsMapLayer*> _qgis_listQPointerToRaw( const QgsWeakMapLayerPointerList& layers )`
`20`	`20`	`{`
`21`	`21`	`QList<QgsMapLayer*> lst;`
`22`	`22`	`lst.reserve( layers.count() );`
`23`		`- Q_FOREACH ( const QPointer<QgsMapLayer>& layerPtr, layers )`
	`23`	`+ Q_FOREACH ( const QgsWeakMapLayerPointer& layerPtr, layers )`
`24`	`24`	`{`
`25`	`25`	`if ( layerPtr )`
`26`	`26`	`lst.append( layerPtr.data() );`
`27`	`27`	`}`
`28`	`28`	`return lst;`
`29`	`29`	`}`
`30`	`30`
`31`		`-inline QList< QPointer<QgsMapLayer> > _qgis_listRawToQPointer( const QList<QgsMapLayer*>& layers )`
	`31`	`+inline QgsWeakMapLayerPointerList _qgis_listRawToQPointer( const QList<QgsMapLayer*>& layers )`
`32`	`32`	`{`
`33`		`- QList< QPointer<QgsMapLayer> > lst;`
	`33`	`+ QgsWeakMapLayerPointerList lst;`
`34`	`34`	`lst.reserve( layers.count() );`
`35`	`35`	`Q_FOREACH ( QgsMapLayer* layer, layers )`
`36`	`36`	`{`
`@@ -39,11 +39,11 @@ inline QList< QPointer<QgsMapLayer> > _qgis_listRawToQPointer( const QList<QgsMa`
`39`	`39`	`return lst;`
`40`	`40`	`}`
`41`	`41`
`42`		`-inline QStringList _qgis_listQPointerToIDs( const QList< QPointer<QgsMapLayer> >& layers )`
	`42`	`+inline QStringList _qgis_listQPointerToIDs( const QgsWeakMapLayerPointerList& layers )`
`43`	`43`	`{`
`44`	`44`	`QStringList lst;`
`45`	`45`	`lst.reserve( layers.count() );`
`46`		`- Q_FOREACH ( const QPointer<QgsMapLayer>& layerPtr, layers )`
	`46`	`+ Q_FOREACH ( const QgsWeakMapLayerPointer& layerPtr, layers )`
`47`	`47`	`{`
`48`	`48`	`if ( layerPtr )`
`49`	`49`	`lst << layerPtr->id();`
`@@ -93,7 +93,7 @@ inline static QgsMapLayer* _qgis_findLayer( const QList< QgsMapLayer*> layers, c`
`93`	`93`	`}`
`94`	`94`	`}`
`95`	`95`
`96`		`-inline uint qHash( const QPointer< QgsMapLayer >& key )`
	`96`	`+inline uint qHash( const QgsWeakMapLayerPointer& key )`
`97`	`97`	`{`
`98`	`98`	`return qHash( key ? key->id() : QString() );`
`99`	`99`	`}`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ void QgsMapRendererCache::clearInternal()`
`35`	`35`	`mScale = 0;`
`36`	`36`
`37`	`37`	`// make sure we are disconnected from all layers`
`38`		`- Q_FOREACH ( const QPointer< QgsMapLayer >& layer, mConnectedLayers )`
	`38`	`+ Q_FOREACH ( const QgsWeakMapLayerPointer& layer, mConnectedLayers )`
`39`	`39`	`{`
`40`	`40`	`if ( layer.data() )`
`41`	`41`	`{`
`@@ -48,9 +48,9 @@ void QgsMapRendererCache::clearInternal()`
`48`	`48`
`49`	`49`	`void QgsMapRendererCache::dropUnusedConnections()`
`50`	`50`	`{`
`51`		`- QSet< QPointer< QgsMapLayer > > stillDepends = dependentLayers();`
`52`		`- QSet< QPointer< QgsMapLayer > > disconnects = mConnectedLayers.subtract( stillDepends );`
`53`		`- Q_FOREACH ( const QPointer< QgsMapLayer >& layer, disconnects )`
	`51`	`+ QSet< QgsWeakMapLayerPointer > stillDepends = dependentLayers();`
	`52`	`+ QSet< QgsWeakMapLayerPointer > disconnects = mConnectedLayers.subtract( stillDepends );`
	`53`	`+ Q_FOREACH ( const QgsWeakMapLayerPointer& layer, disconnects )`
`54`	`54`	`{`
`55`	`55`	`if ( layer.data() )`
`56`	`56`	`{`
`@@ -61,13 +61,13 @@ void QgsMapRendererCache::dropUnusedConnections()`
`61`	`61`	`mConnectedLayers = stillDepends;`
`62`	`62`	`}`
`63`	`63`
`64`		`-QSet<QPointer<QgsMapLayer> > QgsMapRendererCache::dependentLayers() const`
	`64`	`+QSet<QgsWeakMapLayerPointer > QgsMapRendererCache::dependentLayers() const`
`65`	`65`	`{`
`66`		`- QSet< QPointer< QgsMapLayer > > result;`
	`66`	`+ QSet< QgsWeakMapLayerPointer > result;`
`67`	`67`	`QMap<QString, CacheParameters>::const_iterator it = mCachedImages.constBegin();`
`68`	`68`	`for ( ; it != mCachedImages.constEnd(); ++it )`
`69`	`69`	`{`
`70`		`- Q_FOREACH ( const QPointer< QgsMapLayer >& l, it.value().dependentLayers )`
	`70`	`+ Q_FOREACH ( const QgsWeakMapLayerPointer& l, it.value().dependentLayers )`
`71`	`71`	`{`
`72`	`72`	`if ( l.data() )`
`73`	`73`	`result << l;`
`@@ -107,7 +107,7 @@ void QgsMapRendererCache::setCacheImage( const QString& cacheKey, const QImage&`
`107`	`107`	`if ( layer )`
`108`	`108`	`{`
`109`	`109`	`params.dependentLayers << layer;`
`110`		`- if ( !mConnectedLayers.contains( QPointer< QgsMapLayer >( layer ) ) )`
	`110`	`+ if ( !mConnectedLayers.contains( QgsWeakMapLayerPointer( layer ) ) )`
`111`	`111`	`{`
`112`	`112`	`connect( layer, &QgsMapLayer::repaintRequested, this, &QgsMapRendererCache::layerRequestedRepaint );`
`113`	`113`	`mConnectedLayers << layer;`