Merge pull request #13998 from rouault/deprecate_OGRFeatureDefn_Dereference

OGRFeatureDefn::Dereference(): deprecate its use within GDAL

Author: rouault

ogr/ogr_feature.h

@@ -819,6 +819,9 @@ class CPL_DLL OGRFeatureDefn
     }
 
     int Dereference()
+#if defined(GDAL_COMPILATION) && !defined(DOXYGEN_XML)
+        CPL_WARN_DEPRECATED("Use Release() instead")
+#endif
     {
         return CPLAtomicDec(&nRefCount);
     }

ogr/ogrfeaturedefn.cpp

@@ -122,8 +122,15 @@ void OGR_FD_Destroy(OGRFeatureDefnH hDefn)
 void OGRFeatureDefn::Release()
 
 {
+#ifdef __GNUC__
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
+#endif
     if (Dereference() <= 0)
         delete this;
+#ifdef __GNUC__
+#pragma GCC diagnostic pop
+#endif
 }
 
 /************************************************************************/
@@ -1179,6 +1186,9 @@ int OGR_FD_Reference(OGRFeatureDefnH hDefn)
  *
  * \brief Decrements the reference count by one.
  *
+ * \warning This method does not destroy the object when the reference count
+ *          is zero. You generally want to use Release() instead.
+ *
  * This method is the same as the C function OGR_FD_Dereference().
  *
  * @return the updated reference count.
@@ -1191,6 +1201,9 @@ int OGR_FD_Reference(OGRFeatureDefnH hDefn)
 /**
  * \brief Decrements the reference count by one.
  *
+ * \warning This method does not destroy the object when the reference count
+ *          is zero. You generally want to use OGR_FD_Release() instead.
+
  * This function is the same as the C++ method OGRFeatureDefn::Dereference().
  *
  * @param hDefn handle to the feature definition on witch OGRFeature are
@@ -1201,7 +1214,14 @@ int OGR_FD_Reference(OGRFeatureDefnH hDefn)
 int OGR_FD_Dereference(OGRFeatureDefnH hDefn)
 
 {
+#ifdef __GNUC__
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
+#endif
     return OGRFeatureDefn::FromHandle(hDefn)->Dereference();
+#ifdef __GNUC__
+#pragma GCC diagnostic pop
+#endif
 }
 
 /************************************************************************/

ogr/ogrsf_frmts/generic/ogrlayerarrow.cpp

@@ -8263,29 +8263,23 @@ bool OGRLayer::WriteArrowBatch(const struct ArrowSchema *schema,
         }
     }
 
-    OGRFeatureDefn oLayerDefnTmp(poLayerDefn->GetName());
-
-    struct LayerDefnTmpRefReleaser
+    struct FeatureDefnReleaser
     {
-        OGRFeatureDefn &m_oDefn;
-
-        explicit LayerDefnTmpRefReleaser(OGRFeatureDefn &oDefn) : m_oDefn(oDefn)
-        {
-            m_oDefn.Reference();
-        }
-
-        ~LayerDefnTmpRefReleaser()
+        void operator()(OGRFeatureDefn *poFDefn)
         {
-            m_oDefn.Dereference();
+            if (poFDefn)
+                poFDefn->Release();
         }
     };
 
-    LayerDefnTmpRefReleaser oLayerDefnTmpRefReleaser(oLayerDefnTmp);
+    std::unique_ptr<OGRFeatureDefn, FeatureDefnReleaser> poLayerDefnTmp(
+        std::make_unique<OGRFeatureDefn>(poLayerDefn->GetName()).release());
+    poLayerDefnTmp->Reference();
 
     std::vector<int> anIdentityFieldMap;
     if (bFallbackTypesUsed)
     {
-        oLayerDefnTmp.SetGeomType(wkbNone);
+        poLayerDefnTmp->SetGeomType(wkbNone);
         for (int i = 0; i < poLayerDefn->GetFieldCount(); ++i)
         {
             anIdentityFieldMap.push_back(i);
@@ -8299,11 +8293,11 @@ bool OGRLayer::WriteArrowBatch(const struct ArrowSchema *schema,
             if (oIter != oMapOGRFieldIndexToFieldInfoIndex.end())
                 asFieldInfo[oIter->second].eSetFeatureFieldType =
                     asFieldInfo[oIter->second].eNominalFieldType;
-            oLayerDefnTmp.AddFieldDefn(&oFieldDefn);
+            poLayerDefnTmp->AddFieldDefn(&oFieldDefn);
         }
         for (int i = 0; i < poLayerDefn->GetGeomFieldCount(); ++i)
         {
-            oLayerDefnTmp.AddGeomFieldDefn(poLayerDefn->GetGeomFieldDefn(i));
+            poLayerDefnTmp->AddGeomFieldDefn(poLayerDefn->GetGeomFieldDefn(i));
         }
     }
     else
@@ -8342,7 +8336,8 @@ bool OGRLayer::WriteArrowBatch(const struct ArrowSchema *schema,
         }
     };
 
-    OGRFeature oFeature(bFallbackTypesUsed ? &oLayerDefnTmp : poLayerDefn);
+    OGRFeature oFeature(bFallbackTypesUsed ? poLayerDefnTmp.get()
+                                           : poLayerDefn);
     FeatureCleaner oCleaner(oFeature, abUseStringOptim);
     OGRFeature oFeatureTarget(poLayerDefn);
     OGRFeature *const poFeatureTarget =
@@ -8409,7 +8404,7 @@ bool OGRLayer::WriteArrowBatch(const struct ArrowSchema *schema,
                     }
                     bool bLossyConversion = false;
                     const auto eSrcType =
-                        oLayerDefnTmp.GetFieldDefnUnsafe(i)->GetType();
+                        poLayerDefnTmp->GetFieldDefnUnsafe(i)->GetType();
                     const auto eDstType =
                         poLayerDefn->GetFieldDefnUnsafe(i)->GetType();
 
@@ -8460,7 +8455,7 @@ bool OGRLayer::WriteArrowBatch(const struct ArrowSchema *schema,
                                  "For feature " CPL_FRMT_GIB
                                  ", value of field %s cannot not preserved",
                                  oFeatureTarget.GetFID(),
-                                 oLayerDefnTmp.GetFieldDefn(i)->GetNameRef());
+                                 poLayerDefnTmp->GetFieldDefn(i)->GetNameRef());
                         if (bTransactionOK)
                             RollbackTransaction();
                         return false;

ogr/ogrsf_frmts/mitab/mitab_miffile.cpp

@@ -1073,8 +1073,8 @@ int MIFFile::Close()
      * Note: we have to check the reference count before deleting
      * m_poSpatialRef and m_poDefn
      *----------------------------------------------------------------*/
-    if (m_poDefn && m_poDefn->Dereference() == 0)
-        delete m_poDefn;
+    if (m_poDefn)
+        m_poDefn->Release();
     m_poDefn = nullptr;
 
     if (m_poSpatialRef && m_poSpatialRef->Dereference() == 0)
@@ -1534,8 +1534,8 @@ int MIFFile::SetFeatureDefn(
      * Delete current feature defn if there is already one.
      * AddFieldNative() will take care of creating a new one for us.
      *----------------------------------------------------------------*/
-    if (m_poDefn && m_poDefn->Dereference() == 0)
-        delete m_poDefn;
+    if (m_poDefn)
+        m_poDefn->Release();
     m_poDefn = nullptr;
 
     /*-----------------------------------------------------------------

ogr/ogrsf_frmts/mitab/mitab_tabfile.cpp

@@ -2017,9 +2017,8 @@ int TABFile::SetFeatureDefn(
      * Keep a reference to the OGRFeatureDefn... we'll have to take the
      * reference count into account when we are done with it.
      *----------------------------------------------------------------*/
-    if (m_poDefn && m_poDefn->Dereference() == 0)
-        delete m_poDefn;
-
+    if (m_poDefn)
+        m_poDefn->Release();
     m_poDefn = poFeatureDefn;
     m_poDefn->Reference();
 

ogr/ogrsf_frmts/mitab/mitab_tabview.cpp

@@ -1235,8 +1235,8 @@ void TABRelation::ResetAllMembers()
     /*-----------------------------------------------------------------
      * Note: we have to check the reference count before deleting m_poDefn
      *----------------------------------------------------------------*/
-    if (m_poDefn && m_poDefn->Dereference() == 0)
-        delete m_poDefn;
+    if (m_poDefn)
+        m_poDefn->Release();
     m_poDefn = nullptr;
 }
 
@@ -1983,9 +1983,8 @@ int TABRelation::SetFeatureDefn(
      * Keep a reference to the OGRFeatureDefn... we'll have to take the
      * reference count into account when we are done with it.
      *----------------------------------------------------------------*/
-    if (m_poDefn && m_poDefn->Dereference() == 0)
-        delete m_poDefn;
-
+    if (m_poDefn)
+        m_poDefn->Release();
     m_poDefn = poFeatureDefn;
     m_poDefn->Reference();
 

ogr/ogrsf_frmts/oci/ogrocistatement.cpp

@@ -74,9 +74,9 @@ void OGROCIStatement::Clean()
     CPLFree(panFieldMap);
     panFieldMap = nullptr;
 
-    if (poDefn != nullptr && poDefn->Dereference() <= 0)
+    if (poDefn != nullptr)
     {
-        delete poDefn;
+        poDefn->Release();
         poDefn = nullptr;
     }