Skip to content

Commit 7f0ab8b

Browse files
m-kuhnm-kuhn
authored
Merge pull request #9103 from m-kuhn/constFeatureInLabeling
Const correctnes for QgsFeature in labeling
2 parents 14db137 + d288560 commit 7f0ab8b

9 files changed

+36
-32
lines changed

‎python/core/auto_generated/qgspallabeling.sip.in

+7-4
Original file line numberDiff line numberDiff line change
@@ -386,9 +386,13 @@ Returns the QgsExpression for this label settings. May be None if isExpression i
386386

387387
double zIndex;
388388

389-
void calculateLabelSize( const QFontMetricsF *fm, QString text, double &labelX, double &labelY, QgsFeature *f = 0, QgsRenderContext *context = 0 );
389+
void calculateLabelSize( const QFontMetricsF *fm, const QString &text, double &labelX, double &labelY, const QgsFeature *f = 0, QgsRenderContext *context = 0 );
390+
%Docstring
391+
Calculates the space required to render the provided ``text`` in map units.
392+
Results will be written to ``labelX`` and ``labelY``.
393+
%End
390394

391-
void registerFeature( QgsFeature &f, QgsRenderContext &context );
395+
void registerFeature( const QgsFeature &f, QgsRenderContext &context );
392396

393397
%Docstring
394398
Register a feature for labeling.
@@ -457,7 +461,7 @@ Sets the label text formatting settings, e.g., font settings, buffer settings, e
457461
.. versionadded:: 3.0
458462
%End
459463

460-
QgsFeature *mCurFeat;
464+
const QgsFeature *mCurFeat;
461465
QgsFields mCurFields;
462466
int fieldIndex;
463467
const QgsMapToPixel *xform;
@@ -469,7 +473,6 @@ Sets the label text formatting settings, e.g., font settings, buffer settings, e
469473
int mFeaturesToLabel;
470474
int mFeatsSendingToPal;
471475
int mFeatsRegPal;
472-
473476
};
474477

475478
class QgsLabelCandidate

‎src/core/dxf/qgsdxfpallabeling.cpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ void QgsDxfLabelProvider::drawLabel( QgsRenderContext &context, pal::LabelPositi
3434
mDxfExport->drawLabel( layerId(), context, label, mSettings );
3535
}
3636

37-
void QgsDxfLabelProvider::registerDxfFeature( QgsFeature &feature, QgsRenderContext &context, const QString &dxfLayerName )
37+
void QgsDxfLabelProvider::registerDxfFeature( const QgsFeature &feature, QgsRenderContext &context, const QString &dxfLayerName )
3838
{
3939
registerFeature( feature, context );
4040
mDxfExport->registerDxfLayer( layerId(), feature.id(), dxfLayerName );

‎src/core/dxf/qgsdxfpallabeling.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ class QgsDxfLabelProvider : public QgsVectorLayerLabelProvider
5454
* \param context render context
5555
* \param dxfLayerName name of dxf layer
5656
*/
57-
void registerDxfFeature( QgsFeature &feature, QgsRenderContext &context, const QString &dxfLayerName );
57+
void registerDxfFeature( const QgsFeature &feature, QgsRenderContext &context, const QString &dxfLayerName );
5858

5959
protected:
6060
//! pointer to parent DXF export where this instance is used

‎src/core/qgspallabeling.cpp

+10-12
Original file line numberDiff line numberDiff line change
@@ -1038,13 +1038,15 @@ bool QgsPalLayerSettings::checkMinimumSizeMM( const QgsRenderContext &ct, const
10381038
return QgsPalLabeling::checkMinimumSizeMM( ct, geom, minSize );
10391039
}
10401040

1041-
void QgsPalLayerSettings::calculateLabelSize( const QFontMetricsF *fm, QString text, double &labelX, double &labelY, QgsFeature *f, QgsRenderContext *context )
1041+
void QgsPalLayerSettings::calculateLabelSize( const QFontMetricsF *fm, const QString &text, double &labelX, double &labelY, const QgsFeature *f, QgsRenderContext *context )
10421042
{
10431043
if ( !fm || !f )
10441044
{
10451045
return;
10461046
}
10471047

1048+
QString textCopy( text );
1049+
10481050
//try to keep < 2.12 API - handle no passed render context
10491051
std::unique_ptr< QgsRenderContext > scopedRc;
10501052
if ( !context )
@@ -1150,29 +1152,25 @@ void QgsPalLayerSettings::calculateLabelSize( const QFontMetricsF *fm, QString t
11501152

11511153
if ( placeDirSymb == QgsPalLayerSettings::SymbolLeftRight )
11521154
{
1153-
text.append( dirSym );
1155+
textCopy.append( dirSym );
11541156
}
11551157
else
11561158
{
1157-
text.prepend( dirSym + QStringLiteral( "\n" ) ); // SymbolAbove or SymbolBelow
1159+
textCopy.prepend( dirSym + QStringLiteral( "\n" ) ); // SymbolAbove or SymbolBelow
11581160
}
11591161
}
11601162

11611163
double w = 0.0, h = 0.0;
1162-
QStringList multiLineSplit = QgsPalLabeling::splitToLines( text, wrapchr, evalAutoWrapLength, useMaxLineLengthForAutoWrap );
1164+
const QStringList multiLineSplit = QgsPalLabeling::splitToLines( textCopy, wrapchr, evalAutoWrapLength, useMaxLineLengthForAutoWrap );
11631165
int lines = multiLineSplit.size();
11641166

11651167
double labelHeight = fm->ascent() + fm->descent(); // ignore +1 for baseline
11661168

11671169
h += fm->height() + static_cast< double >( ( lines - 1 ) * labelHeight * multilineH );
11681170

1169-
for ( int i = 0; i < lines; ++i )
1171+
for ( const QString &line : multiLineSplit )
11701172
{
1171-
double width = fm->width( multiLineSplit.at( i ) );
1172-
if ( width > w )
1173-
{
1174-
w = width;
1175-
}
1173+
w = std::max( w, fm->width( line ) );
11761174
}
11771175

11781176
#if 0 // XXX strk
@@ -1186,7 +1184,7 @@ void QgsPalLayerSettings::calculateLabelSize( const QFontMetricsF *fm, QString t
11861184
#endif
11871185
}
11881186

1189-
void QgsPalLayerSettings::registerFeature( QgsFeature &f, QgsRenderContext &context, QgsLabelFeature **labelFeature, QgsGeometry obstacleGeometry )
1187+
void QgsPalLayerSettings::registerFeature( const QgsFeature &f, QgsRenderContext &context, QgsLabelFeature **labelFeature, QgsGeometry obstacleGeometry )
11901188
{
11911189
// either used in QgsPalLabeling (palLayer is set) or in QgsLabelingEngine (labelFeature is set)
11921190
Q_ASSERT( labelFeature );
@@ -1995,7 +1993,7 @@ void QgsPalLayerSettings::registerFeature( QgsFeature &f, QgsRenderContext &cont
19951993
lf->setDataDefinedValues( dataDefinedValues );
19961994
}
19971995

1998-
void QgsPalLayerSettings::registerObstacleFeature( QgsFeature &f, QgsRenderContext &context, QgsLabelFeature **obstacleFeature, const QgsGeometry &obstacleGeometry )
1996+
void QgsPalLayerSettings::registerObstacleFeature( const QgsFeature &f, QgsRenderContext &context, QgsLabelFeature **obstacleFeature, const QgsGeometry &obstacleGeometry )
19991997
{
20001998
mCurFeat = &f;
20011999

‎src/core/qgspallabeling.h

+8-6
Original file line numberDiff line numberDiff line change
@@ -750,8 +750,11 @@ class CORE_EXPORT QgsPalLayerSettings
750750
//! Z-Index of label, where labels with a higher z-index are rendered on top of labels with a lower z-index
751751
double zIndex;
752752

753-
// called from register feature hook
754-
void calculateLabelSize( const QFontMetricsF *fm, QString text, double &labelX, double &labelY, QgsFeature *f = nullptr, QgsRenderContext *context = nullptr );
753+
/**
754+
* Calculates the space required to render the provided \a text in map units.
755+
* Results will be written to \a labelX and \a labelY.
756+
*/
757+
void calculateLabelSize( const QFontMetricsF *fm, const QString &text, double &labelX, double &labelY, const QgsFeature *f = nullptr, QgsRenderContext *context = nullptr );
755758

756759
/**
757760
* Register a feature for labeling.
@@ -766,7 +769,7 @@ class CORE_EXPORT QgsPalLayerSettings
766769
* the feature's original geometry will be used as an obstacle for labels. Not available
767770
* in Python bindings.
768771
*/
769-
void registerFeature( QgsFeature &f, QgsRenderContext &context,
772+
void registerFeature( const QgsFeature &f, QgsRenderContext &context,
770773
QgsLabelFeature **labelFeature SIP_PYARGREMOVE = nullptr,
771774
QgsGeometry obstacleGeometry SIP_PYARGREMOVE = QgsGeometry() );
772775

@@ -823,7 +826,7 @@ class CORE_EXPORT QgsPalLayerSettings
823826
void setFormat( const QgsTextFormat &format ) { mFormat = format; }
824827

825828
// temporary stuff: set when layer gets prepared or labeled
826-
QgsFeature *mCurFeat = nullptr;
829+
const QgsFeature *mCurFeat = nullptr;
827830
QgsFields mCurFields;
828831
int fieldIndex;
829832
const QgsMapToPixel *xform = nullptr;
@@ -835,7 +838,6 @@ class CORE_EXPORT QgsPalLayerSettings
835838
int mFeaturesToLabel = 0; // total features that will probably be labeled, may be less (figured before PAL)
836839
int mFeatsSendingToPal = 0; // total features tested for sending into PAL (relative to maxNumLabels)
837840
int mFeatsRegPal = 0; // number of features registered in PAL, when using limitNumLabels
838-
839841
private:
840842

841843
friend class QgsVectorLayer; // to allow calling readFromLayerCustomProperties()
@@ -899,7 +901,7 @@ class CORE_EXPORT QgsPalLayerSettings
899901
/**
900902
* Registers a feature as an obstacle only (no label rendered)
901903
*/
902-
void registerObstacleFeature( QgsFeature &f, QgsRenderContext &context, QgsLabelFeature **obstacleFeature, const QgsGeometry &obstacleGeometry = QgsGeometry() );
904+
void registerObstacleFeature( const QgsFeature &f, QgsRenderContext &context, QgsLabelFeature **obstacleFeature, const QgsGeometry &obstacleGeometry = QgsGeometry() );
903905

904906
QMap<Property, QVariant> dataDefinedValues;
905907

‎src/core/qgsrulebasedlabeling.cpp

+3-3
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ bool QgsRuleBasedLabelProvider::prepare( const QgsRenderContext &context, QSet<Q
3737
return true;
3838
}
3939

40-
void QgsRuleBasedLabelProvider::registerFeature( QgsFeature &feature, QgsRenderContext &context, const QgsGeometry &obstacleGeometry )
40+
void QgsRuleBasedLabelProvider::registerFeature( const QgsFeature &feature, QgsRenderContext &context, const QgsGeometry &obstacleGeometry )
4141
{
4242
// will register the feature to relevant sub-providers
4343
mRules->rootRule()->registerFeature( feature, context, mSubProviders, obstacleGeometry );
@@ -316,7 +316,7 @@ void QgsRuleBasedLabeling::Rule::prepare( const QgsRenderContext &context, QSet<
316316
}
317317
}
318318

319-
QgsRuleBasedLabeling::Rule::RegisterResult QgsRuleBasedLabeling::Rule::registerFeature( QgsFeature &feature, QgsRenderContext &context, QgsRuleBasedLabeling::RuleToProviderMap &subProviders, const QgsGeometry &obstacleGeometry )
319+
QgsRuleBasedLabeling::Rule::RegisterResult QgsRuleBasedLabeling::Rule::registerFeature( const QgsFeature &feature, QgsRenderContext &context, QgsRuleBasedLabeling::RuleToProviderMap &subProviders, const QgsGeometry &obstacleGeometry )
320320
{
321321
if ( !isFilterOK( feature, context )
322322
|| !isScaleOK( context.rendererScale() ) )
@@ -363,7 +363,7 @@ QgsRuleBasedLabeling::Rule::RegisterResult QgsRuleBasedLabeling::Rule::registerF
363363
return Filtered;
364364
}
365365

366-
bool QgsRuleBasedLabeling::Rule::isFilterOK( QgsFeature &f, QgsRenderContext &context ) const
366+
bool QgsRuleBasedLabeling::Rule::isFilterOK( const QgsFeature &f, QgsRenderContext &context ) const
367367
{
368368
if ( ! mFilter || mElseRule )
369369
return true;

‎src/core/qgsrulebasedlabeling.h

+3-3
Original file line numberDiff line numberDiff line change
@@ -282,7 +282,7 @@ class CORE_EXPORT QgsRuleBasedLabeling : public QgsAbstractVectorLayerLabeling
282282
* register individual features
283283
* \note not available in Python bindings
284284
*/
285-
RegisterResult registerFeature( QgsFeature &feature, QgsRenderContext &context, RuleToProviderMap &subProviders, const QgsGeometry &obstacleGeometry = QgsGeometry() ) SIP_SKIP;
285+
RegisterResult registerFeature( const QgsFeature &feature, QgsRenderContext &context, RuleToProviderMap &subProviders, const QgsGeometry &obstacleGeometry = QgsGeometry() ) SIP_SKIP;
286286

287287
/**
288288
* Returns true if this rule or any of its children requires advanced composition effects
@@ -302,7 +302,7 @@ class CORE_EXPORT QgsRuleBasedLabeling : public QgsAbstractVectorLayerLabeling
302302
* \param context The context in which the rendering happens
303303
* \returns True if the feature shall be rendered
304304
*/
305-
bool isFilterOK( QgsFeature &f, QgsRenderContext &context ) const;
305+
bool isFilterOK( const QgsFeature &f, QgsRenderContext &context ) const;
306306

307307
/**
308308
* Check if this rule applies for a given \a scale.
@@ -395,7 +395,7 @@ class CORE_EXPORT QgsRuleBasedLabelProvider : public QgsVectorLayerLabelProvider
395395

396396
bool prepare( const QgsRenderContext &context, QSet<QString> &attributeNames ) override;
397397

398-
void registerFeature( QgsFeature &feature, QgsRenderContext &context, const QgsGeometry &obstacleGeometry = QgsGeometry() ) override;
398+
void registerFeature( const QgsFeature &feature, QgsRenderContext &context, const QgsGeometry &obstacleGeometry = QgsGeometry() ) override;
399399

400400
//! create a label provider
401401
virtual QgsVectorLayerLabelProvider *createProvider( QgsVectorLayer *layer, const QString &providerId, bool withFeatureLoop, const QgsPalLayerSettings *settings );

‎src/core/qgsvectorlayerlabelprovider.cpp

+2-1
Original file line numberDiff line numberDiff line change
@@ -258,9 +258,10 @@ QList<QgsLabelFeature *> QgsVectorLayerLabelProvider::labelFeatures( QgsRenderCo
258258
return mLabels;
259259
}
260260

261-
void QgsVectorLayerLabelProvider::registerFeature( QgsFeature &feature, QgsRenderContext &context, const QgsGeometry &obstacleGeometry )
261+
void QgsVectorLayerLabelProvider::registerFeature( const QgsFeature &feature, QgsRenderContext &context, const QgsGeometry &obstacleGeometry )
262262
{
263263
QgsLabelFeature *label = nullptr;
264+
264265
mSettings.registerFeature( feature, context, &label, obstacleGeometry );
265266
if ( label )
266267
mLabels << label;

‎src/core/qgsvectorlayerlabelprovider.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ class CORE_EXPORT QgsVectorLayerLabelProvider : public QgsAbstractLabelProvider
7474
* symbol, the obstacle geometry should represent the bounds of the offset symbol). If not set,
7575
* the feature's original geometry will be used as an obstacle for labels.
7676
*/
77-
virtual void registerFeature( QgsFeature &feature, QgsRenderContext &context, const QgsGeometry &obstacleGeometry = QgsGeometry() );
77+
virtual void registerFeature( const QgsFeature &feature, QgsRenderContext &context, const QgsGeometry &obstacleGeometry = QgsGeometry() );
7878

7979
/**
8080
* Returns the geometry for a point feature which should be used as an obstacle for labels. This

0 commit comments

Comments
 (0)