qgsvectorlayerutils.h

Go to the documentation of this file.

/***************************************************************************
  qgsvectorlayerutils.h
  ---------------------
  Date                 : October 2016
  Copyright            : (C) 2016 by Nyall Dawson
  Email                : nyall dot dawson at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSVECTORLAYERUTILS_H
#define QGSVECTORLAYERUTILS_H
 
#include "qgis_core.h"
#include "qgsfeaturesink.h"
#include "qgsgeometry.h"
#include "qgsselectivemaskingsourceset.h"
#include "qgsvectorlayerfeatureiterator.h"
 
#include <QString>
 
using namespace Qt::StringLiterals;
 
class QgsFeatureRenderer;
class QgsSymbolLayer;
class QgsSymbolLayerId;
 
 
#ifndef SIP_RUN
 
struct QgsMaskedLayer
{
    bool hasEffects = false;
 
    // masked symbol layers
    QSet<QString> symbolLayerIdsToMask;
};

typedef QHash<QString, QgsMaskedLayer> QgsMaskedLayers;
 
#endif

class CORE_EXPORT QgsVectorLayerUtils
{
  public:
    class CORE_EXPORT QgsDuplicateFeatureContext
    {
      public:
        QgsDuplicateFeatureContext() = default;

        QList<QgsVectorLayer *> layers() const;

        QgsFeatureIds duplicatedFeatures( QgsVectorLayer *layer ) const;
 
 
      private:
        QMap<QgsVectorLayer *, QgsFeatureIds> mDuplicatedFeatures;
        friend class QgsVectorLayerUtils;

        void setDuplicatedFeatures( QgsVectorLayer *layer, const QgsFeatureIds &ids );
    };

    class CORE_EXPORT QgsFeatureData
    {
      public:
        QgsFeatureData( const QgsGeometry &geometry = QgsGeometry(), const QgsAttributeMap &attributes = QgsAttributeMap() );

        QgsGeometry geometry() const;

        QgsAttributeMap attributes() const;
 
      private:
        QgsGeometry mGeometry;
        QgsAttributeMap mAttributes;
    };

    enum class FieldIsEditableFlag : int SIP_ENUM_BASETYPE( IntFlag )
    {
      IgnoreLayerEditability = 1 << 0, 
    };
    Q_DECLARE_FLAGS( FieldIsEditableFlags, FieldIsEditableFlag )
 
    // SIP does not like "using", use legacy typedef
    typedef QList<QgsVectorLayerUtils::QgsFeatureData> QgsFeaturesDataList;

    static QgsFeatureIterator getValuesIterator( const QgsVectorLayer *layer, const QString &fieldOrExpression, bool &ok, bool selectedOnly );

    static QList< QVariant > getValues( const QgsVectorLayer *layer, const QString &fieldOrExpression, bool &ok, bool selectedOnly = false, QgsFeedback *feedback = nullptr );

    static QList< QVariant > uniqueValues( const QgsVectorLayer *layer, const QString &fieldOrExpression, bool &ok SIP_OUT, bool selectedOnly = false, int limit = -1, QgsFeedback *feedback = nullptr );

    static QList< double > getDoubleValues( const QgsVectorLayer *layer, const QString &fieldOrExpression, bool &ok, bool selectedOnly = false, int *nullCount = nullptr, QgsFeedback *feedback = nullptr );

    static bool valueExists( const QgsVectorLayer *layer, int fieldIndex, const QVariant &value, const QgsFeatureIds &ignoreIds = QgsFeatureIds() );

    static QVariant createUniqueValue( const QgsVectorLayer *layer, int fieldIndex, const QVariant &seed = QVariant() );

    static QVariant createUniqueValueFromCache( const QgsVectorLayer *layer, int fieldIndex, const QSet<QVariant> &existingValues, const QVariant &seed = QVariant() );

    static bool attributeHasConstraints( const QgsVectorLayer *layer, int attributeIndex );

    static bool validateAttribute(
      const QgsVectorLayer *layer,
      const QgsFeature &feature,
      int attributeIndex,
      QStringList &errors SIP_OUT,
      QgsFieldConstraints::ConstraintStrength strength = QgsFieldConstraints::ConstraintStrengthNotSet,
      QgsFieldConstraints::ConstraintOrigin origin = QgsFieldConstraints::ConstraintOriginNotSet
    );

    static QgsFeature createFeature(
      const QgsVectorLayer *layer, const QgsGeometry &geometry = QgsGeometry(), const QgsAttributeMap &attributes = QgsAttributeMap(), QgsExpressionContext *context = nullptr
    );

    static QgsFeatureList createFeatures( const QgsVectorLayer *layer, const QgsFeaturesDataList &featuresData, QgsExpressionContext *context = nullptr );
 
    // clang-format off
    static QgsFeature duplicateFeature( QgsVectorLayer *layer, const QgsFeature &feature, QgsProject *project, QgsDuplicateFeatureContext &duplicateFeatureContext SIP_OUT, const int maxDepth = 0, int depth SIP_PYARGREMOVE = 0, QList<QgsVectorLayer *> referencedLayersBranch SIP_PYARGREMOVE = QList<QgsVectorLayer *>() );
    // clang-format on
 

    static std::unique_ptr<QgsVectorLayerFeatureSource> getFeatureSource( QPointer<QgsVectorLayer> layer, QgsFeedback *feedback = nullptr ) SIP_SKIP;

    static void matchAttributesToFields( QgsFeature &feature, const QgsFields &fields );

    static QgsFeatureList makeFeatureCompatible( const QgsFeature &feature, const QgsVectorLayer *layer, QgsFeatureSink::SinkFlags sinkFlags = QgsFeatureSink::SinkFlags() );

    static QgsFeatureList makeFeaturesCompatible( const QgsFeatureList &features, const QgsVectorLayer *layer, QgsFeatureSink::SinkFlags sinkFlags = QgsFeatureSink::SinkFlags() );

    static bool fieldIsEditable( const QgsVectorLayer *layer, int fieldIndex, const QgsFeature &feature, QgsVectorLayerUtils::FieldIsEditableFlags flags = QgsVectorLayerUtils::FieldIsEditableFlags() );

    static bool fieldIsReadOnly( const QgsVectorLayer *layer, int fieldIndex );

    static bool fieldEditabilityDependsOnFeature( const QgsVectorLayer *layer, int fieldIndex );

    static QHash<QString, QgsMaskedLayers> collectObjectsMaskedByLabelsFromLayer(
      const QgsVectorLayer *layer, const QHash< QString, QgsSelectiveMaskingSourceSet > &selectiveMaskingSourceSets, const QVector< QgsVectorLayer * > &allRenderedVectorLayers
    ) SIP_SKIP;

    static QgsMaskedLayers collectObjectsMaskedBySymbolLayersFromLayer(
      const QgsVectorLayer *layer, const QHash< QString, QgsSelectiveMaskingSourceSet > &selectiveMaskingSourceSets, const QVector< QgsVectorLayer * > &allRenderedVectorLayers
    ) SIP_SKIP;

    static QString getFeatureDisplayString( const QgsVectorLayer *layer, const QgsFeature &feature );

    enum CascadedFeatureFlag SIP_ENUM_BASETYPE( IntFlag )
    {
      IgnoreAuxiliaryLayers = 1 << 1, 
    };
    Q_DECLARE_FLAGS( CascadedFeatureFlags, CascadedFeatureFlag )
 
    
    static bool impactsCascadeFeatures(
      const QgsVectorLayer *layer,
      const QgsFeatureIds &fids,
      const QgsProject *project,
      QgsDuplicateFeatureContext &context SIP_OUT,
      QgsVectorLayerUtils::CascadedFeatureFlags flags = QgsVectorLayerUtils::CascadedFeatureFlags()
    );
 
#ifndef SIP_RUN

#else

#endif
    static QString guessFriendlyIdentifierField( const QgsFields &fields, bool *foundFriendly SIP_OUT = nullptr ) SIP_PYNAME( guessFriendlyIdentifierFieldV2 );
 
#ifdef SIP_RUN

    static QString guessFriendlyIdentifierField( const QgsFields &fields );
#endif

    static QgsFeatureIds filterValidFeatureIds( const QgsVectorLayer *layer, const QgsFeatureIds &featureIds );
 
#ifndef SIP_RUN
    static QByteArray fieldToDataArray( const QgsFields &fields, const QString &fieldName, QgsFeatureIterator &it, const QVariant &nullValue );
#else
    // clang-format off

    static QByteArray fieldToDataArray( const QgsFields &fields, const QString &fieldName, QgsFeatureIterator &it, const QVariant &nullValue );
    % MethodCode
 
    const int fieldIndex = a0->lookupField( *a1 );
    if ( fieldIndex == -1 )
    {
      PyErr_SetString( PyExc_KeyError, u"Field %1 does not exist."_s.arg( *a1 ).toUtf8().constData() );
      sipIsErr = 1;
    }
    else
    {
      const QgsField field = a0->at( fieldIndex );
      switch ( field.type() )
      {
        case QMetaType::Type::Int:
        case QMetaType::Type::UInt:
        case QMetaType::Type::Long:
        case QMetaType::Type::LongLong:
        case QMetaType::Type::ULong:
        case QMetaType::Type::ULongLong:
        case QMetaType::Type::Float:
        case QMetaType::Type::Double:
        case QMetaType::Type::Short:
        case QMetaType::Type::UShort:
        {
          Py_BEGIN_ALLOW_THREADS
          sipRes = new QByteArray( QgsVectorLayerUtils::fieldToDataArray( *a0, *a1, *a2, *a3 ) );
          Py_END_ALLOW_THREADS
          break;
        }
 
        default:
        {
          PyErr_SetString( PyExc_TypeError, u"Field type (%1) cannot be converted to a data array."_s.arg( QMetaType::typeName( field.type() ) ).toUtf8().constData() );
          sipIsErr = 1;
        }
      }
    }
    % End
 
// clang-format on
#endif
};
 
 
#endif // QGSVECTORLAYERUTILS_H