qgsvectorlayereditbuffer.h

Go to the documentation of this file.

/***************************************************************************
    qgsvectorlayereditbuffer.h
    ---------------------
    begin                : Dezember 2012
    copyright            : (C) 2012 by Martin Dobias
    email                : wonder dot sk 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 QGSVECTORLAYEREDITBUFFER_H
#define QGSVECTORLAYEREDITBUFFER_H
 
#include "qgis_core.h"
#include "qgsfeature.h"
#include "qgsfields.h"
#include "qgsgeometry.h"
 
#include <QList>
#include <QSet>
 
class QgsVectorLayer;
class QgsVectorLayerEditBufferGroup;
 
typedef QList<int> QgsAttributeList SIP_SKIP;
typedef QSet<int> QgsAttributeIds SIP_SKIP;
typedef QMap<QgsFeatureId, QgsFeature> QgsFeatureMap;

class CORE_EXPORT QgsVectorLayerEditBuffer : public QObject
{
    Q_OBJECT
  public:
    QgsVectorLayerEditBuffer( QgsVectorLayer *layer );

    virtual bool isModified() const;

    virtual bool addFeature( QgsFeature &f );

    virtual bool addFeatures( QgsFeatureList &features );

    virtual bool deleteFeature( QgsFeatureId fid );

    virtual bool deleteFeatures( const QgsFeatureIds &fid );

    virtual bool changeGeometry( QgsFeatureId fid, const QgsGeometry &geom );

    virtual bool changeAttributeValue( QgsFeatureId fid, int field, const QVariant &newValue, const QVariant &oldValue = QVariant() );

    virtual bool changeAttributeValues( QgsFeatureId fid, const QgsAttributeMap &newValues, const QgsAttributeMap &oldValues );

    virtual bool addAttribute( const QgsField &field );

    virtual bool deleteAttribute( int attr );

    virtual bool renameAttribute( int attr, const QString &newName );

    virtual bool commitChanges( QStringList &commitErrors );

    virtual void rollBack();

    QgsFeatureMap addedFeatures() const { return mAddedFeatures; }

    QgsFeatureIds allAddedOrEditedFeatures() const;

    bool isFeatureAdded( QgsFeatureId id ) const { return mAddedFeatures.contains( id ); }

    QgsChangedAttributesMap changedAttributeValues() const { return mChangedAttributeValues; }

    bool isFeatureAttributesChanged( QgsFeatureId id ) const { return mChangedAttributeValues.contains( id ); }

    QgsAttributeList deletedAttributeIds() const { return mDeletedAttributeIds; }

    bool isAttributeDeleted( int index ) const { return mDeletedAttributeIds.contains( index ); }

    QList<QgsField> addedAttributes() const { return mAddedAttributes; }

    QgsGeometryMap changedGeometries() const { return mChangedGeometries; }

    bool isFeatureGeometryChanged( QgsFeatureId id ) const { return mChangedGeometries.contains( id ); }

    QgsFeatureIds deletedFeatureIds() const { return mDeletedFeatureIds; }

    bool isFeatureDeleted( QgsFeatureId id ) const { return mDeletedFeatureIds.contains( id ); }

    void updateFields( QgsFields &fields ) SIP_SKIP;

    QgsVectorLayerEditBufferGroup *editBufferGroup() const;

    void setEditBufferGroup( QgsVectorLayerEditBufferGroup *editBufferGroup );
 
    //QString dumpEditBuffer();
 
  protected slots:
    void undoIndexChanged( int index );
 
  signals:
    void layerModified();

    void featureAdded( QgsFeatureId fid );

    void featureDeleted( QgsFeatureId fid );

    void geometryChanged( QgsFeatureId fid, const QgsGeometry &geom );

    void attributeValueChanged( QgsFeatureId fid, int idx, const QVariant &value );

    void attributeAdded( int idx );

    void attributeDeleted( int idx );

    void attributeRenamed( int idx, const QString &newName );

    void committedAttributesDeleted( const QString &layerId, const QgsAttributeList &deletedAttributes );

    void committedAttributesAdded( const QString &layerId, const QList<QgsField> &addedAttributes );

    void committedAttributesRenamed( const QString &layerId, const QgsFieldNameMap &renamedAttributes );

    void committedFeaturesAdded( const QString &layerId, const QgsFeatureList &addedFeatures );

    void committedFeaturesRemoved( const QString &layerId, const QgsFeatureIds &deletedFeatureIds );

    void committedAttributeValuesChanges( const QString &layerId, const QgsChangedAttributesMap &changedAttributesValues );

    void committedGeometriesChanges( const QString &layerId, const QgsGeometryMap &changedGeometries );
 
  protected:
 
    QgsVectorLayerEditBuffer() = default;

    void updateFeatureGeometry( QgsFeature &f );

    void updateChangedAttributes( QgsFeature &f );

    void handleAttributeAdded( int index, const QgsField &field );

    void handleAttributeDeleted( int index );

    void updateAttributeMapIndex( QgsAttributeMap &attrs, int index, int offset ) const;
 
    void updateLayerFields();
 
  protected:
    QgsVectorLayer *L = nullptr;
 
    friend class QgsVectorLayerUndoCommand;
    friend class QgsVectorLayerUndoCommandAddFeature;
    friend class QgsVectorLayerUndoCommandDeleteFeature;
    friend class QgsVectorLayerUndoCommandChangeGeometry;
    friend class QgsVectorLayerUndoCommandChangeAttribute;
    friend class QgsVectorLayerUndoCommandAddAttribute;
    friend class QgsVectorLayerUndoCommandDeleteAttribute;
    friend class QgsVectorLayerUndoCommandRenameAttribute;
 
    friend class QgsVectorLayerUndoPassthroughCommand;
    friend class QgsVectorLayerUndoPassthroughCommandAddFeatures;
    friend class QgsVectorLayerUndoPassthroughCommandDeleteFeatures;
    friend class QgsVectorLayerUndoPassthroughCommandChangeGeometry;
    friend class QgsVectorLayerUndoPassthroughCommandChangeAttribute;
    friend class QgsVectorLayerUndoPassthroughCommandChangeAttributes;
    friend class QgsVectorLayerUndoPassthroughCommandAddAttribute;
    friend class QgsVectorLayerUndoPassthroughCommandDeleteAttribute;
    friend class QgsVectorLayerUndoPassthroughCommandRenameAttribute;
    friend class QgsVectorLayerUndoPassthroughCommandUpdate;

    QgsFeatureIds mDeletedFeatureIds;

    QgsFeatureMap mAddedFeatures;

    QgsChangedAttributesMap mChangedAttributeValues;

    QgsAttributeList mDeletedAttributeIds;

    QList<QgsField> mAddedAttributes;

    QgsFieldNameMap mRenamedAttributes;

    QgsGeometryMap mChangedGeometries;
 
    QgsVectorLayerEditBufferGroup *mEditBufferGroup = nullptr;
 
    int mBlockModifiedSignals = 0;
 
    friend class QgsGrassProvider; //GRASS provider totally abuses the edit buffer
 
  private:
 
    friend class QgsVectorLayerEditBufferGroup;

    bool commitChangesCheckGeometryTypeCompatibility( QStringList &commitErrors );

    bool commitChangesDeleteAttributes( bool &attributesDeleted, QStringList &commitErrors );

    bool commitChangesRenameAttributes( bool &attributesRenamed, QStringList &commitErrors );

    bool commitChangesAddAttributes( bool &attributesAdded, QStringList &commitErrors );

    bool commitChangesCheckAttributesModifications( const QgsFields oldFields, QStringList &commitErrors );

    bool commitChangesChangeAttributes( bool &attributesChanged, QStringList &commitErrors );

    bool commitChangesDeleteFeatures( bool &featuresDeleted, QStringList &commitErrors );

    bool commitChangesAddFeatures( bool &featuresAdded, QStringList &commitErrors );
};
 
#endif // QGSVECTORLAYEREDITBUFFER_H