Rename QgsFields::fieldNameIndex() to lookupField()

To have two clearly different names for tolerant/intolerant index lookup

Author: m-kuhn

doc/api_break.dox

@@ -746,6 +746,7 @@ None will need to be modified, as the method will return an empty geometry if th
 
 <ul>
 <li>All const methods which return a field from QgsFields now return a QgsField value, not a reference.</li>
+<li>fieldNameIndex has been renamed to lookupField. See the API documentation for details.</li>
 </ul>
 
 \subsection qgis_api_break_3_0_QgsFieldExpressionWidget QgsFieldExpressionWidget
@@ -1414,6 +1415,7 @@ displayExpression instead. For the map tip use mapTipTemplate() instead.</li>
 <li>Deleted attributeEditorElementFromDomElement
 <li>editFormConfig() returns a copy instead of direct access (Use setEditFormConfig to update)
 <li>Removed valueRelation(), replaced with QgsEditFormConfig::editorWidgetConfig
+<li>Removed fieldNameIndex(), use QgsFields::lookupField() or QgsFields::indexFromName() instead
 </ul>
 
 \subsection qgis_api_break_3_0_QgsVectorLayerEditBuffer QgsVectorLayerEditBuffer

python/core/core.sip

@@ -55,6 +55,7 @@
 %Include qgsfeaturerequest.sip
 %Include qgsfeedback.sip
 %Include qgsfield.sip
+%Include qgsfields.sip
 %Include qgsgeometrysimplifier.sip
 %Include qgsgeometryvalidator.sip
 %Include qgsgml.sip

python/core/qgsexpression.sip

@@ -53,6 +53,13 @@ class QgsExpression
      */
     QStringList referencedColumns() const;
 
+    /**
+     * Return a list of field name indexes obtained from the provided fields.
+     *
+     * @note Added in QGIS 3.0
+     */
+    QSet<int> referencedAttributeIndexes( const QgsFields& fields ) const;
+
     //! Returns true if the expression uses feature geometry for some computation
     bool needsGeometry() const;
 

python/core/qgsfield.sip

@@ -254,224 +254,3 @@ class QgsField
      */
     const QgsEditorWidgetSetup& editorWidgetSetup() const;
 }; // class QgsField
-
-
-/** \class QgsFields
- * \ingroup core
- * Container of fields for a vector layer.
- *
- * In addition to storing a list of QgsField instances, it also:
- * - allows quick lookups of field names to index in the list
- * - keeps track of where the field definition comes from (vector data provider, joined layer or newly added from an editing operation)
- * \note QgsFields objects are implicitly shared.
- */
-
-class QgsFields
-{
-%TypeHeaderCode
-#include <qgsfield.h>
-%End
-  public:
-
-    enum FieldOrigin
-    {
-      OriginUnknown,   //!< it has not been specified where the field comes from
-      OriginProvider,  //!< field comes from the underlying data provider of the vector layer  (originIndex = index in provider's fields)
-      OriginJoin,      //!< field comes from a joined layer   (originIndex / 1000 = index of the join, originIndex % 1000 = index within the join)
-      OriginEdit,      //!< field has been temporarily added in editing mode (originIndex = index in the list of added attributes)
-      OriginExpression //!< field is calculated from an expression
-    };
-
-    /** Constructor for an empty field container
-     */
-    QgsFields();
-
-    /** Copy constructor
-     */
-    QgsFields( const QgsFields& other );
-
-    virtual ~QgsFields();
-
-    //! Remove all fields
-    void clear();
-    //! Append a field. The field must have unique name, otherwise it is rejected (returns false)
-    bool append( const QgsField& field, FieldOrigin origin = OriginProvider, int originIndex = -1 );
-    //! Append an expression field. The field must have unique name, otherwise it is rejected (returns false)
-    bool appendExpressionField( const QgsField& field, int originIndex );
-    //! Remove a field with the given index
-    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
-
-    //! Extend with fields from another QgsFields container
-    void extend( const QgsFields& other );
-
-    //! Check whether the container is empty
-    bool isEmpty() const;
-    //! Return number of items
-    int count() const;
-    // __len__ annotation since sip 4.10.3
-    //int count() const /__len__/;
-    int __len__() const;
-%MethodCode
-  sipRes = sipCpp->count();
-%End
-    //! Return number of items
-    int size() const;
-    //! Return if a field index is valid
-    //! @param i  Index of the field which needs to be checked
-    //! @return   True if the field exists
-    bool exists( int i ) const;
-
-    //! Get field at particular index (must be in range 0..N-1)
-    // const QgsField& operator[]( int i ) const;
-    QgsField& operator[](int i) /Factory/;
-%MethodCode
-  SIP_SSIZE_T idx = sipConvertFromSequenceIndex(a0, sipCpp->count());
-  if (idx < 0)
-    sipIsErr = 1;
-  else
-    sipRes = new QgsField(sipCpp->operator[](idx));
-%End
-
-    //! Get field at particular index (must be in range 0..N-1)
-    QgsField at( int i ) const /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
-
-    //! Get field at particular index (must be in range 0..N-1)
-    QgsField field( int fieldIdx ) const /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
-
-    //! Get field at particular index (must be in range 0..N-1)
-    QgsField field( const QString& name ) const /Factory/;
-%MethodCode
-  int fieldIdx = sipCpp->indexFromName(*a0);
-  if (fieldIdx == -1)
-  {
-    PyErr_SetString(PyExc_KeyError, a0->toAscii());
-    sipIsErr = 1;
-  }
-  else
-  {
-    sipRes = new QgsField( sipCpp->field( *a0 ) );
-  }
-%End
-
-    //! Get field's origin (value from an enumeration)
-    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
-
-    //! Get field's origin index (its meaning is specific to each type of origin)
-    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
-
-    //! Look up field's index from name. Returns -1 on error
-    int indexFromName( const QString& name ) const;
-
-    //! Look up field's index from name
-    //! also looks up case-insensitive if there is no match otherwise
-    //! @note added in 2.4
-    int fieldNameIndex( const QString& fieldName ) const;
-
-    //! Utility function to get list of attribute indexes
-    //! @note added in 2.4
-    QgsAttributeList allAttributesList() const;
-
-    //! Utility function to return a list of QgsField instances
-    QList<QgsField> toList() const;
-
-    //! @note added in 2.6
-    bool operator==( const QgsFields& other ) const;
-    //! @note added in 2.6
-    bool operator!=( const QgsFields& other ) const;
-
-    /** Returns an icon corresponding to a field index, based on the field's type and source
-     * @note added in QGIS 2.14
-     */
-    QIcon iconForField( int fieldIdx ) const /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
-
-    //! Allows direct construction of QVariants from fields.
-    operator QVariant() const;
-
-/*  SIP_PYOBJECT __getitem__(int key);
-%MethodCode
-  if (a0 = sipConvertFromSequenceIndex(a0, sipCpp->count()) < 0)
-    sipIsErr = 1;
-  else
-  {
-    qDebug("__getitem__ %d", a0);
-    QgsField* fld = new QgsField(sipCpp->at(a0));
-    sipRes = sipConvertFromType(fld, sipType_QgsField, Py_None);
-  }
-%End*/
-
-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
-
-};