1.12 New References for Dimension Scales (#1139)

config/cmake/H5pubconf.h.in

@@ -502,6 +502,9 @@
 /* Define if the high-level library headers should be included in hdf5.h */
 #cmakedefine H5_INCLUDE_HL @H5_INCLUDE_HL@
 
+/* Define if new-style references should be used with dimension scales */
+#cmakedefine H5_DIMENSION_SCALES_WITH_NEW_REF @H5_DIMENSION_SCALES_WITH_NEW_REF@
+
 /* Define if your system can convert long double to (unsigned) long long
    values correctly. */
 #cmakedefine H5_LDOUBLE_TO_LLONG_ACCURATE @H5_LDOUBLE_TO_LLONG_ACCURATE@

config/cmake/libhdf5.settings.cmake.in

@@ -64,28 +64,29 @@ Languages:
 
 Features:
 ---------
-                   Parallel HDF5: @HDF5_ENABLE_PARALLEL@
-Parallel Filtered Dataset Writes: @PARALLEL_FILTERED_WRITES@
-              Large Parallel I/O: @LARGE_PARALLEL_IO@
-              High-level library: @HDF5_BUILD_HL_LIB@
-                Build HDF5 Tests: @BUILD_TESTING@
-                Build HDF5 Tools: @HDF5_BUILD_TOOLS@
-     Build High-level HDF5 Tools: @HDF5_BUILD_HL_TOOLS@
-                    Threadsafety: @HDF5_ENABLE_THREADSAFE@ (recursive RW locks: @HDF5_USE_RECURSIVE_RW_LOCKS@) 
-             Default API mapping: @DEFAULT_API_VERSION@
-  With deprecated public symbols: @HDF5_ENABLE_DEPRECATED_SYMBOLS@
-          I/O filters (external): @EXTERNAL_FILTERS@
-                             MPE: @H5_HAVE_LIBLMPE@
-                      Direct VFD: @H5_HAVE_DIRECT@
-                      Mirror VFD: @H5_HAVE_MIRROR_VFD@
-              (Read-Only) S3 VFD: @H5_HAVE_ROS3_VFD@
-            (Read-Only) HDFS VFD: @H5_HAVE_LIBHDFS@
-                         dmalloc: @H5_HAVE_LIBDMALLOC@
-  Packages w/ extra debug output: @INTERNAL_DEBUG_OUTPUT@
-                     API Tracing: @HDF5_ENABLE_TRACE@
-            Using memory checker: @HDF5_ENABLE_USING_MEMCHECKER@
- Memory allocation sanity checks: @HDF5_MEMORY_ALLOC_SANITY_CHECK@
-          Function Stack Tracing: @HDF5_ENABLE_CODESTACK@
-                Use file locking: @HDF5_FILE_LOCKING_SETTING@
-       Strict File Format Checks: @HDF5_STRICT_FORMAT_CHECKS@
-    Optimization Instrumentation: @HDF5_Enable_Instrument@
+                     Parallel HDF5: @HDF5_ENABLE_PARALLEL@
+  Parallel Filtered Dataset Writes: @PARALLEL_FILTERED_WRITES@
+                Large Parallel I/O: @LARGE_PARALLEL_IO@
+                High-level library: @HDF5_BUILD_HL_LIB@
+Dimension scales w/ new references: @DIMENSION_SCALES_WITH_NEW_REF@
+                  Build HDF5 Tests: @BUILD_TESTING@
+                  Build HDF5 Tools: @HDF5_BUILD_TOOLS@
+       Build High-level HDF5 Tools: @HDF5_BUILD_HL_TOOLS@
+                      Threadsafety: @HDF5_ENABLE_THREADSAFE@
+               Default API mapping: @DEFAULT_API_VERSION@
+    With deprecated public symbols: @HDF5_ENABLE_DEPRECATED_SYMBOLS@
+            I/O filters (external): @EXTERNAL_FILTERS@
+                               MPE: @H5_HAVE_LIBLMPE@
+                        Direct VFD: @H5_HAVE_DIRECT@
+                        Mirror VFD: @H5_HAVE_MIRROR_VFD@
+                (Read-Only) S3 VFD: @H5_HAVE_ROS3_VFD@
+              (Read-Only) HDFS VFD: @H5_HAVE_LIBHDFS@
+                           dmalloc: @H5_HAVE_LIBDMALLOC@
+    Packages w/ extra debug output: @INTERNAL_DEBUG_OUTPUT@
+                       API Tracing: @HDF5_ENABLE_TRACE@
+              Using memory checker: @HDF5_ENABLE_USING_MEMCHECKER@
+   Memory allocation sanity checks: @HDF5_MEMORY_ALLOC_SANITY_CHECK@
+            Function Stack Tracing: @HDF5_ENABLE_CODESTACK@
+                  Use file locking: @HDF5_FILE_LOCKING_SETTING@
+         Strict File Format Checks: @HDF5_STRICT_FORMAT_CHECKS@
+      Optimization Instrumentation: @HDF5_Enable_Instrument@

configure.ac

@@ -897,6 +897,38 @@ else
 fi
 
 
+## ----------------------------------------------------------------------
+## Enable new references for dimension scales
+##
+AC_SUBST([DIMENSION_SCALES_WITH_NEW_REF])
+AC_MSG_CHECKING([whether to use new references with dimension scales]);
+AC_ARG_ENABLE([dimension-scales-with-new-ref],
+              [AS_HELP_STRING([--enable-dimension-scales-with-new-ref],
+                     [Use new references when creating dimension scales.
+                      [default=no]
+                     ])],
+             [DIMENSION_SCALES_WITH_NEW_REF=$enableval])
+
+## Set the default value to use old references.
+if test "X-$DIMENSION_SCALES_WITH_NEW_REF" = X- ; then
+  DIMENSION_SCALES_WITH_NEW_REF=no
+fi
+
+case "X-$DIMENSION_SCALES_WITH_NEW_REF" in 
+  X-yes)
+    AC_MSG_RESULT([yes])
+    AC_DEFINE([DIMENSION_SCALES_WITH_NEW_REF], [1],
+              [Define if new references for dimension scales were requested])
+
+    ;;
+  X-no)
+    AC_MSG_RESULT([no])
+    ;;
+  *)
+    AC_MSG_ERROR([Unrecognized value: $DIMENSION_SCALES_WITH_NEW_REF])
+    ;;
+esac
+
 ## ----------------------------------------------------------------------
 ## Check which archiving tool to use. This needs to be done before
 ## the AM_PROG_LIBTOOL macro.

hl/CMakeLists.txt

@@ -1,6 +1,14 @@
 cmake_minimum_required (VERSION 3.12)
 project (HDF5_HL C)
 
+#-----------------------------------------------------------------------------
+# Option to use new-style references with dimension scale APIs
+#-----------------------------------------------------------------------------
+option (HDF5_DIMENSION_SCALES_NEW_REF  "Use new-style references with dimension scale APIs" OFF)
+if (HDF5_DIMENSION_SCALES_NEW_REF)
+  set (H5_DIMENSION_SCALES_WITH_NEW_REF 1)
+endif ()
+
 #-----------------------------------------------------------------------------
 # List Source files
 #-----------------------------------------------------------------------------