qgsfields.h

Go to the documentation of this file.

/***************************************************************************
  qgsfields.h - QgsFields
 
 ---------------------
 begin                : 22.9.2016
 copyright            : (C) 2016 by Matthias Kuhn
 email                : [email protected]
 ***************************************************************************
 *                                                                         *
 *   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 QGSFIELDS_H
#define QGSFIELDS_H
 
 
#include "qgis_sip.h"
#include "qgis_core.h"
#include "qgsfield.h"
 
class QgsFieldsPrivate;
 
/***************************************************************************
 * This class is considered CRITICAL and any change MUST be accompanied with
 * full unit tests in testqgsfields.cpp.
 * See details in QEP #17
 ****************************************************************************/
 
class CORE_EXPORT  QgsFields
{
  public:
 
    enum FieldOrigin
    {
      OriginUnknown,   
      OriginProvider,  
      OriginJoin,      
      OriginEdit,      
      OriginExpression 
    };
 
#ifndef SIP_RUN
 
    typedef struct Field
    {
      Field()
      {}
 
      Field( const QgsField &f, FieldOrigin o, int oi )
        : field( f )
        , origin( o )
        , originIndex( oi )
      {}
 
      // TODO c++20 - replace with = default
 
      bool operator==( const Field &other ) const { return field == other.field && origin == other.origin && originIndex == other.originIndex; }
      bool operator!=( const Field &other ) const { return !( *this == other ); }
 
      QgsField field;      
      FieldOrigin origin = OriginUnknown ;  
      int originIndex = -1 ;     
    } Field;
 
#endif
 
    QgsFields();
 
    QgsFields( const QgsFields &other );
 
    QgsFields &operator =( const QgsFields &other ) SIP_SKIP;
 
    virtual ~QgsFields();
 
    void clear();
 
    bool append( const QgsField &field, FieldOrigin origin = OriginProvider, int originIndex = -1 );
 
    bool rename( int fieldIdx, const QString &name );
 
    bool appendExpressionField( const QgsField &field, int originIndex );
 
#ifndef SIP_RUN
 
    void remove( int fieldIdx );
#else
 
    void remove( int fieldIdx );
    % MethodCode
    if ( a0 < 0 || a0 >= sipCpp->count() )
    {
      PyErr_SetString( PyExc_KeyError, QByteArray::number( a0 ) );
      sipIsErr = 1;
    }
    else
    {
      sipCpp->remove( a0 );
    }
    % End
#endif
 
    void extend( const QgsFields &other );
 
    bool isEmpty() const;
 
    int count() const;
 
#ifdef SIP_RUN
    int __len__() const;
    % MethodCode
    sipRes = sipCpp->count();
    % End
 
    int __bool__() const;
    % MethodCode
    sipRes = true;
    % End
#endif
 
    int size() const;
 
    QStringList names() const;
 
    bool exists( int i ) const;
 
#ifndef SIP_RUN
    QgsField operator[]( int i ) const;
#endif
 
    QgsField &operator[]( int i ) SIP_FACTORY;
#ifdef SIP_RUN
    % MethodCode
    SIP_SSIZE_T idx = sipConvertFromSequenceIndex( a0, sipCpp->count() );
    if ( idx < 0 )
      sipIsErr = 1;
    else
      sipRes = new QgsField( sipCpp->operator[]( idx ) );
    % End
#endif
 
#ifdef SIP_RUN
    SIP_PYOBJECT __getitem__( const QString &name ) const SIP_TYPEHINT( QgsField );
    % MethodCode
    const int fieldIdx = sipCpp->lookupField( *a0 );
    if ( fieldIdx == -1 )
    {
      PyErr_SetString( PyExc_KeyError, a0->toLatin1() );
      sipIsErr = 1;
    }
    else
    {
      sipRes = sipConvertFromType( new QgsField( sipCpp->at( fieldIdx ) ), sipType_QgsField, Py_None );
    }
    % End
#endif
 
#ifndef SIP_RUN
 
    QgsField at( int i ) const SIP_FACTORY;
#else
 
    QgsField at( int i ) const SIP_FACTORY;
    % MethodCode
    if ( a0 < 0 || a0 >= sipCpp->count() )
    {
      PyErr_SetString( PyExc_KeyError, QByteArray::number( a0 ) );
      sipIsErr = 1;
    }
    else
    {
      sipRes = new QgsField( sipCpp->at( a0 ) );
    }
    % End
#endif
 
#ifndef SIP_RUN
 
    QgsField field( int fieldIdx ) const SIP_FACTORY;
#else
 
    QgsField field( int fieldIdx ) const SIP_FACTORY;
    % MethodCode
    if ( a0 < 0 || a0 >= sipCpp->count() )
    {
      PyErr_SetString( PyExc_KeyError, QByteArray::number( a0 ) );
      sipIsErr = 1;
    }
    else
    {
      sipRes = new QgsField( sipCpp->field( a0 ) );
    }
    % End
#endif
 
#ifndef SIP_RUN
 
    QgsField field( const QString &name ) const SIP_FACTORY;
#else
 
    QgsField field( const QString &name ) const SIP_FACTORY;
    % MethodCode
    int fieldIdx = sipCpp->indexFromName( *a0 );
    if ( fieldIdx == -1 )
    {
      PyErr_SetString( PyExc_KeyError, a0->toLatin1() );
      sipIsErr = 1;
    }
    else
    {
      sipRes = new QgsField( sipCpp->field( *a0 ) );
    }
    % End
#endif
 
#ifndef SIP_RUN
 
    FieldOrigin fieldOrigin( int fieldIdx ) const;
#else
 
    FieldOrigin fieldOrigin( int fieldIdx ) const;
    % MethodCode
    if ( a0 < 0 || a0 >= sipCpp->count() )
    {
      PyErr_SetString( PyExc_KeyError, QByteArray::number( a0 ) );
      sipIsErr = 1;
    }
    else
    {
      sipRes = sipCpp->fieldOrigin( a0 );
    }
    % End
#endif
 
#ifndef SIP_RUN
 
    int fieldOriginIndex( int fieldIdx ) const;
#else
 
    int fieldOriginIndex( int fieldIdx ) const;
    % MethodCode
    if ( a0 < 0 || a0 >= sipCpp->count() )
    {
      PyErr_SetString( PyExc_KeyError, QByteArray::number( a0 ) );
      sipIsErr = 1;
    }
    else
    {
      sipRes = sipCpp->fieldOriginIndex( a0 );
    }
    % End
#endif
 
    int indexFromName( const QString &fieldName ) const;
 
    int indexOf( const QString &fieldName ) const;
 
    int lookupField( const QString &fieldName ) const;
 
    QgsAttributeList allAttributesList() const;
 
    QList<QgsField> toList() const;
 
    bool operator==( const QgsFields &other ) const;
    bool operator!=( const QgsFields &other ) const { return !( *this == other ); }
 
#ifndef SIP_RUN
 
    QIcon iconForField( int fieldIdx, bool considerOrigin = false ) const SIP_FACTORY;
#else
 
    QIcon iconForField( int fieldIdx, bool considerOrigin = false ) const SIP_FACTORY;
    % MethodCode
    if ( a0 < 0 || a0 >= sipCpp->count() )
    {
      PyErr_SetString( PyExc_KeyError, QByteArray::number( a0 ) );
      sipIsErr = 1;
    }
    else
    {
      sipRes = new QIcon( sipCpp->iconForField( a0 ) );
    }
    % End
#endif
 
    static QIcon iconForFieldType( QVariant::Type type, QVariant::Type subType = QVariant::Type::Invalid, const QString &typeString = QString() );
 
    operator QVariant() const
    {
      return QVariant::fromValue( *this );
    }
 
#ifdef SIP_RUN
 
    void __setitem__( int key, const QgsField &field );
    % MethodCode
    int idx = ( int )sipConvertFromSequenceIndex( a0, sipCpp->count() );
    if ( idx < 0 )
      sipIsErr = 1;
    else
      ( *sipCpp )[idx] = *a1;
    % End
 
#endif
 
#ifndef SIP_RUN
 
 
    class const_iterator;
 
    class iterator
    {
      public:
        QgsFields::Field *d = nullptr;
        typedef std::random_access_iterator_tag  iterator_category;
        typedef qptrdiff difference_type;
 
        inline iterator()
        {}
 
        inline iterator( QgsFields::Field *n )
          : d( n )
        {}
 
        inline QgsField &operator*() const { return d->field; }
        inline QgsField *operator->() const { return &d->field; }
        inline QgsField &operator[]( difference_type j ) const { return d[j].field; }
        inline bool operator==( const iterator &o ) const noexcept { return d == o.d; } // clazy:exclude=function-args-by-value
        inline bool operator!=( const iterator &o ) const noexcept { return d != o.d; } // clazy:exclude=function-args-by-value
        inline bool operator<( const iterator &other ) const noexcept { return d < other.d; } // clazy:exclude=function-args-by-value
        inline bool operator<=( const iterator &other ) const noexcept { return d <= other.d; } // clazy:exclude=function-args-by-value
        inline bool operator>( const iterator &other ) const noexcept { return d > other.d; } // clazy:exclude=function-args-by-value
        inline bool operator>=( const iterator &other ) const noexcept { return d >= other.d; } // clazy:exclude=function-args-by-value
 
        inline iterator &operator++() { ++d; return *this; }
        inline iterator operator++( int ) { QgsFields::Field *n = d; ++d; return n; }
        inline iterator &operator--() { d--; return *this; }
        inline iterator operator--( int ) { QgsFields::Field *n = d; d--; return n; }
        inline iterator &operator+=( difference_type j ) { d += j; return *this; }
        inline iterator &operator-=( difference_type j ) { d -= j; return *this; }
        inline iterator operator+( difference_type j ) const { return iterator( d + j ); }
        inline iterator operator-( difference_type j ) const { return iterator( d - j ); }
        inline int operator-( iterator j ) const { return int( d - j.d ); }
    };
    friend class iterator;
 
    class const_iterator // clazy:exclude=rule-of-three
    {
      public:
        const QgsFields::Field *d = nullptr;
 
        typedef std::random_access_iterator_tag  iterator_category;
        typedef qptrdiff difference_type;
 
        inline const_iterator()
        {}
 
        inline const_iterator( const QgsFields::Field *f )
          : d( f ) {}
        inline const_iterator( const const_iterator &o )
          : d( o.d ) {}
        inline explicit const_iterator( const iterator &o ) // clazy:exclude=function-args-by-value
          : d( o.d ) {}
        inline const QgsField &operator*() const { return d->field; }
        inline const QgsField *operator->() const { return &d->field; }
        inline const QgsField &operator[]( difference_type j ) const noexcept { return d[j].field; }
        inline bool operator==( const const_iterator &o ) const noexcept { return d == o.d; }
        inline bool operator!=( const const_iterator &o ) const noexcept { return d != o.d; }
        inline bool operator<( const const_iterator &other ) const noexcept { return d < other.d; }
        inline bool operator<=( const const_iterator &other ) const noexcept { return d <= other.d; }
        inline bool operator>( const const_iterator &other ) const noexcept { return d > other.d; }
        inline bool operator>=( const const_iterator &other ) const noexcept { return d >= other.d; }
        inline const_iterator &operator++() { ++d; return *this; }
        inline const_iterator operator++( int ) { const QgsFields::Field *n = d; ++d; return n; }
        inline const_iterator &operator--() { d--; return *this; }
        inline const_iterator operator--( int ) { const QgsFields::Field *n = d; --d; return n; }
        inline const_iterator &operator+=( difference_type j ) { d += j; return *this; }
        inline const_iterator &operator-=( difference_type j ) { d -= j; return *this; }
        inline const_iterator operator+( difference_type j ) const { return const_iterator( d + j ); }
        inline const_iterator operator-( difference_type j ) const { return const_iterator( d - j ); }
        inline int operator-( const_iterator j ) const { return int( d - j.d ); } // clazy:exclude=function-args-by-ref
      private:
        const_iterator &operator= ( const const_iterator & ) = delete;
    };
    friend class const_iterator;
 
 
    const_iterator constBegin() const noexcept;
 
    const_iterator constEnd() const noexcept;
 
    const_iterator begin() const noexcept;
 
    const_iterator end() const noexcept;
 
    iterator begin();
 
 
    iterator end();
 
#endif
 
  private:
 
    QSharedDataPointer<QgsFieldsPrivate> d;
 
};
 
Q_DECLARE_METATYPE( QgsFields )
 
 
CORE_EXPORT QDataStream &operator<<( QDataStream &out, const QgsFields &fields );
CORE_EXPORT QDataStream &operator>>( QDataStream &in, QgsFields &fields );
 
#endif // QGSFIELDS_H