Update develop to 1.18 API

.github/workflows/main-cmake-spc.yml

@@ -199,6 +199,66 @@ jobs:
         run: ctest . --parallel 2 -C Debug -V
         working-directory: ${{ runner.workspace }}/build
 
+  build_v1_14:
+    name: "gcc DBG v1.12 default API"
+    runs-on: ubuntu-latest
+    steps:
+      # SETUP
+      - name: Install Linux Dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install ninja-build doxygen graphviz
+          sudo apt install libssl3 libssl-dev libcurl4 libcurl4-openssl-dev
+          sudo apt install gcc-12 g++-12 gfortran-12
+          echo "CC=gcc-12" >> $GITHUB_ENV
+          echo "CXX=g++-12" >> $GITHUB_ENV
+          echo "FC=gfortran-12" >> $GITHUB_ENV
+
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - name: Get Sources
+        uses: actions/checkout@v4.1.7
+
+      #
+      # CMAKE CONFIGURE
+      #
+      - name: CMake Configure
+        run: |
+          mkdir "${{ runner.workspace }}/build"
+          cd "${{ runner.workspace }}/build"
+          cmake -C $GITHUB_WORKSPACE/config/cmake/cacheinit.cmake \
+            -G Ninja \
+            -DCMAKE_BUILD_TYPE=Debug \
+            -DBUILD_SHARED_LIBS=ON \
+            -DHDF5_ENABLE_ALL_WARNINGS=ON \
+            -DHDF5_ENABLE_PARALLEL:BOOL=OFF \
+            -DHDF5_BUILD_CPP_LIB:BOOL=ON \
+            -DHDF5_BUILD_FORTRAN=ON \
+            -DHDF5_BUILD_JAVA=ON \
+            -DHDF5_BUILD_DOC=OFF \
+            -DLIBAEC_USE_LOCALCONTENT=OFF \
+            -DZLIB_USE_LOCALCONTENT=OFF \
+            -DHDF5_ENABLE_MIRROR_VFD:BOOL=ON \
+            -DHDF5_ENABLE_DIRECT_VFD:BOOL=ON \
+            -DHDF5_ENABLE_ROS3_VFD:BOOL=ON \
+            -DH5_NO_DEPRECATED_SYMBOLS:BOOL=OFF \
+            -DDEFAULT_API_VERSION:STRING=v114 \
+            $GITHUB_WORKSPACE
+        shell: bash
+
+      #
+      # BUILD
+      #
+      - name: CMake Build
+        run: cmake --build . --parallel 3 --config Debug
+        working-directory: ${{ runner.workspace }}/build
+
+      #
+      # RUN TESTS
+      #
+      - name: CMake Run Tests
+        run: ctest . --parallel 2 -C Debug -V
+        working-directory: ${{ runner.workspace }}/build
+
   build_zlibng:
     name: "gcc use zlib-ng filter"
     runs-on: ubuntu-latest

.github/workflows/publish-release.yml

@@ -58,3 +58,7 @@ jobs:
           run: |
                 aws s3 sync ./${{ inputs.file_name }}.doxygen s3://${{ secrets.AWS_S3_BUCKET }}/${{ vars.TARGET_PATH }}/${{ inputs.target_dir }}/documentation/doxygen --delete
 
+        - name: Sync userguide to latest S3 bucket
+          run: |
+                aws s3 sync ./${{ inputs.file_name }}.doxygen s3://${{ secrets.AWS_S3_BUCKET }}/documentation/latest --delete
+

CMakeLists.txt

@@ -856,9 +856,9 @@ if (HDF5_ENABLE_SUBFILING_VFD)
 endif()
 
 
-#option (DEFAULT_API_VERSION "Enable v1.16 API (v16, v18, v110, v112, v114, v116)" "v116")
-set (DEFAULT_API_VERSION "v116" CACHE STRING "Enable v1.16 API (v16, v18, v110, v112, v114, v116)")
-set_property (CACHE DEFAULT_API_VERSION PROPERTY STRINGS v16 v18 v110 v112 v114 v116)
+#option (DEFAULT_API_VERSION "Enable v1.16 API (v16, v18, v110, v112, v114, v116, v118)" "v116")
+set (DEFAULT_API_VERSION "v116" CACHE STRING "Enable v1.16 API (v16, v18, v110, v112, v114, v116, v118)")
+set_property (CACHE DEFAULT_API_VERSION PROPERTY STRINGS v16 v18 v110 v112 v114 v116 v118)
 #-----------------------------------------------------------------------------
 # Option to use 1.6.x API
 #-----------------------------------------------------------------------------
@@ -902,14 +902,22 @@ endif ()
 #-----------------------------------------------------------------------------
 # Option to use 1.16.x API
 #-----------------------------------------------------------------------------
-if (NOT DEFAULT_API_VERSION)
-  set (DEFAULT_API_VERSION "v116")
-endif ()
 set (H5_USE_116_API_DEFAULT 0)
 if (DEFAULT_API_VERSION MATCHES "v116")
   set (H5_USE_116_API_DEFAULT 1)
 endif ()
 
+#-----------------------------------------------------------------------------
+# Option to use 1.18.x API
+#-----------------------------------------------------------------------------
+if (NOT DEFAULT_API_VERSION)
+  set (DEFAULT_API_VERSION "v118")
+endif ()
+set (H5_USE_118_API_DEFAULT 0)
+if (DEFAULT_API_VERSION MATCHES "v118")
+  set (H5_USE_118_API_DEFAULT 1)
+endif ()
+
 #-----------------------------------------------------------------------------
 # Include user macros
 #-----------------------------------------------------------------------------

HDF5Examples/C/TUTR/testh5cc.sh.in

@@ -44,6 +44,7 @@ H5_USE_110_API_DEFAULT=`grep '#define H5_USE_110_API_DEFAULT ' ../src/H5pubconf.
 H5_USE_112_API_DEFAULT=`grep '#define H5_USE_112_API_DEFAULT ' ../src/H5pubconf.h`
 H5_USE_114_API_DEFAULT=`grep '#define H5_USE_114_API_DEFAULT ' ../src/H5pubconf.h`
 H5_USE_116_API_DEFAULT=`grep '#define H5_USE_116_API_DEFAULT ' ../src/H5pubconf.h`
+H5_USE_118_API_DEFAULT=`grep '#define H5_USE_118_API_DEFAULT ' ../src/H5pubconf.h`
 
 # setup my machine information.
 myos=`uname -s`
@@ -483,6 +484,8 @@ elif [ -n "$H5_USE_114_API_DEFAULT" ]; then
     echo "H5_USE_114_API_DEFAULT is defined."
 elif [ -n "$H5_USE_116_API_DEFAULT" ]; then
     echo "H5_USE_116_API_DEFAULT is defined."
+elif [ -n "$H5_USE_118_API_DEFAULT" ]; then
+    echo "H5_USE_118_API_DEFAULT is defined."
 else
     echo "No H5 API_DEFAULT is defined."
 fi
@@ -523,17 +526,32 @@ elif [ -n "$H5_USE_114_API_DEFAULT" ]; then
     TOOLTEST -DH5_USE_110_API_DEFAULT $v110main
     TOOLTEST -DH5_USE_112_API_DEFAULT $v112main
     TOOLTEST $v114main
+elif [ -n "$H5_USE_116_API_DEFAULT" ]; then
+    echo "Testing HDF5  with 118_API_DEFAULT"
+    TOOLTEST -DH5_USE_16_API_DEFAULT $v16main
+    TOOLTEST -DH5_USE_18_API_DEFAULT $v18main
+    TOOLTEST -DH5_USE_110_API_DEFAULT $v110main
+    TOOLTEST -DH5_USE_112_API_DEFAULT $v112main
+    TOOLTEST -DH5_USE_114_API_DEFAULT $v114main
+    TOOLTEST -DH5_USE_116_API_DEFAULT $v114main
+    TOOLTEST $v18main
+    TOOLTEST $v110main
+    TOOLTEST $v112main
+    TOOLTEST $v114main
+    TOOLTEST $v116main
 else
-    echo "Testing HDF5  with 116_API_DEFAULT"
+    echo "Testing HDF5  with 118_API_DEFAULT"
     TOOLTEST -DH5_USE_16_API_DEFAULT $v16main
     TOOLTEST -DH5_USE_18_API_DEFAULT $v18main
     TOOLTEST -DH5_USE_110_API_DEFAULT $v110main
     TOOLTEST -DH5_USE_112_API_DEFAULT $v112main
     TOOLTEST -DH5_USE_114_API_DEFAULT $v114main
+    TOOLTEST -DH5_USE_116_API_DEFAULT $v114main
     TOOLTEST $v18main
     TOOLTEST $v110main
     TOOLTEST $v112main
     TOOLTEST $v114main
+    TOOLTEST $v116main
 fi
 
 # Group 6: # HDF5 program that depends on input args.

c++/src/H5FaccProp.cpp

@@ -713,13 +713,17 @@ FileAccPropList::getFileLocking(hbool_t &use_file_locking, hbool_t &ignore_when_
 ///             \li \c H5F_LIBVER_110
 ///             \li \c H5F_LIBVER_112
 ///             \li \c H5F_LIBVER_114
+///             \li \c H5F_LIBVER_116
+///             \li \c H5F_LIBVER_118
 ///             \li \c H5F_LIBVER_LATEST
 ///
 ///             Valid values of \a libver_high are as follows:
 ///             \li \c H5F_LIBVER_18
 ///             \li \c H5F_LIBVER_110
 ///             \li \c H5F_LIBVER_112
 ///             \li \c H5F_LIBVER_114
+///             \li \c H5F_LIBVER_116
+///             \li \c H5F_LIBVER_118
 ///             \li \c H5F_LIBVER_LATEST   (Default)
 ///
 ///             For more detail, please refer to the H5Pset_libver_bounds API in
@@ -751,13 +755,17 @@ FileAccPropList::setLibverBounds(H5F_libver_t libver_low, H5F_libver_t libver_hi
 ///             \li \c H5F_LIBVER_110
 ///             \li \c H5F_LIBVER_112
 ///             \li \c H5F_LIBVER_114
+///             \li \c H5F_LIBVER_116
+///             \li \c H5F_LIBVER_118
 ///             \li \c H5F_LIBVER_LATEST
 ///
 ///             and \a libver_high:
 ///             \li \c H5F_LIBVER_18
 ///             \li \c H5F_LIBVER_110
 ///             \li \c H5F_LIBVER_112
 ///             \li \c H5F_LIBVER_114
+///             \li \c H5F_LIBVER_116
+///             \li \c H5F_LIBVER_118
 ///             \li \c H5F_LIBVER_LATEST
 //--------------------------------------------------------------------------
 void

config/cmake/H5pubconf.h.in

@@ -607,6 +607,9 @@
 /* Define using v1.16 public API symbols by default */
 #cmakedefine H5_USE_116_API_DEFAULT @H5_USE_116_API_DEFAULT@
 
+/* Define using v1.18 public API symbols by default */
+#cmakedefine H5_USE_118_API_DEFAULT @H5_USE_118_API_DEFAULT@
+
 /* Define if the library will use file locking */
 #cmakedefine H5_USE_FILE_LOCKING @H5_USE_FILE_LOCKING@
 

config/cmake/HDF5ExampleCache.cmake

@@ -38,6 +38,8 @@ elseif (DEFAULT_API_VERSION MATCHES "v114")
   set (H5_USE_114_API ON)
 elseif (DEFAULT_API_VERSION MATCHES "v116")
   set (H5_USE_116_API ON)
+elseif (DEFAULT_API_VERSION MATCHES "v118")
+  set (H5_USE_118_API ON)
 endif ()
 message (STATUS "HDF5 H5_LIBVER_DIR: ${H5_LIBVER_DIR} HDF5_API_VERSION: ${DEFAULT_API_VERSION}")
 

configure.ac

@@ -4233,10 +4233,10 @@ esac
 AC_SUBST([DEFAULT_API_VERSION])
 AC_MSG_CHECKING([which version of public symbols to use by default])
 AC_ARG_WITH([default-api-version],
-            [AS_HELP_STRING([--with-default-api-version=(default|v16|v18|v110|v112|v114|v116)],
+            [AS_HELP_STRING([--with-default-api-version=(default|v16|v18|v110|v112|v114|v116|v118)],
                             [Specify default release version of public symbols
-                             [default=v116]])],,
-            [withval=v116])
+                             [default=v118]])],,
+            [withval=v118])
 
 ## Allowing "default" allows the GitHub CI to check that we didn't forget
 ## to change the defaults when creating a new major version
@@ -4270,6 +4270,11 @@ elif test "X$withval" = "Xv116" -o "X$withval" = "Xdefault"; then
     DEFAULT_API_VERSION=v116
     AC_DEFINE([USE_116_API_DEFAULT], [1],
               [Define using v1.16 public API symbols by default])
+elif test "X$withval" = "Xv118" -o "X$withval" = "Xdefault"; then
+    AC_MSG_RESULT([v118])
+    DEFAULT_API_VERSION=v118
+    AC_DEFINE([USE_118_API_DEFAULT], [1],
+              [Define using v1.18 public API symbols by default])
 else
     AC_MSG_ERROR([invalid version of public symbols given])
 fi
@@ -4279,7 +4284,7 @@ fi
 ## if the user insists on doing this via the --enable-unsupported configure
 ## flag, we'll let them.
 if test "X${ALLOW_UNSUPPORTED}" != "Xyes"; then
-  if test "X${DEFAULT_API_VERSION}" != "Xv116" -a "X${DEPRECATED_SYMBOLS}" = "Xno" ; then
+  if test "X${DEFAULT_API_VERSION}" != "Xv118" -a "X${DEPRECATED_SYMBOLS}" = "Xno" ; then
     AC_MSG_ERROR([Removing old public API symbols not allowed when using them as default public API symbols. Use --enable-unsupported to override this error.])
   fi
 fi

fortran/src/H5_f.c

@@ -540,6 +540,7 @@ h5init_flags_c(int_f *h5d_flags, size_t_f *h5d_size_flags, int_f *h5e_flags, hid
     h5f_flags[28] = (int_f)H5F_LIBVER_V112;
     h5f_flags[29] = (int_f)H5F_LIBVER_V114;
     h5f_flags[30] = (int_f)H5F_LIBVER_V116;
+    h5f_flags[31] = (int_f)H5F_LIBVER_V118;
 
     /*
      *  H5FD flags

fortran/src/H5_ff.F90

@@ -380,6 +380,7 @@ END FUNCTION h5init1_flags_c
     H5F_LIBVER_V112_F              = H5F_flags(29)
     H5F_LIBVER_V114_F              = H5F_flags(30)
     H5F_LIBVER_V116_F              = H5F_flags(31)
+    H5F_LIBVER_V118_F              = H5F_flags(32)
     !
     ! H5generic flags
     !

fortran/src/H5f90global.F90

@@ -237,6 +237,7 @@ MODULE H5GLOBAL
   !DEC$ATTRIBUTES DLLEXPORT :: H5F_LIBVER_V112_F
   !DEC$ATTRIBUTES DLLEXPORT :: H5F_LIBVER_V114_F
   !DEC$ATTRIBUTES DLLEXPORT :: H5F_LIBVER_V116_F
+  !DEC$ATTRIBUTES DLLEXPORT :: H5F_LIBVER_V118_F
   !DEC$ATTRIBUTES DLLEXPORT :: H5F_FSPACE_STRATEGY_FSM_AGGR_F
   !DEC$ATTRIBUTES DLLEXPORT :: H5F_FSPACE_STRATEGY_PAGE_F
   !DEC$ATTRIBUTES DLLEXPORT :: H5F_FSPACE_STRATEGY_AGGR_F
@@ -271,6 +272,7 @@ MODULE H5GLOBAL
   INTEGER :: H5F_LIBVER_V112_F     !< H5F_LIBVER_V112
   INTEGER :: H5F_LIBVER_V114_F     !< H5F_LIBVER_V114
   INTEGER :: H5F_LIBVER_V116_F     !< H5F_LIBVER_V116
+  INTEGER :: H5F_LIBVER_V118_F     !< H5F_LIBVER_V118
   INTEGER :: H5F_FSPACE_STRATEGY_FSM_AGGR_F !< H5F_FSPACE_STRATEGY_FSM_AGGR
   INTEGER :: H5F_FSPACE_STRATEGY_PAGE_F     !< H5F_FSPACE_STRATEGY_PAGE
   INTEGER :: H5F_FSPACE_STRATEGY_AGGR_F     !< H5F_FSPACE_STRATEGY_AGGR

fortran/test/tH5P_F03.F90

@@ -235,6 +235,13 @@ SUBROUTINE test_create(total_error)
   CALL VERIFY("***ERROR: Returned wrong low libver_bounds", low, H5F_LIBVER_V116_F, total_error)
   CALL VERIFY("***ERROR: Returned wrong high libver_bounds", high, H5F_LIBVER_V116_F, total_error)
 
+  CALL h5pset_libver_bounds_f(fapl, H5F_LIBVER_V118_F, H5F_LIBVER_V118_F, error)
+  CALL check("h5pset_libver_bounds_f",error, total_error)
+  CALL h5pget_libver_bounds_f(fapl, low, high, error)
+  CALL check("h5pget_libver_bounds_f",error, total_error)
+  CALL VERIFY("***ERROR: Returned wrong low libver_bounds", low, H5F_LIBVER_V118_F, total_error)
+  CALL VERIFY("***ERROR: Returned wrong high libver_bounds", high, H5F_LIBVER_V118_F, total_error)
+
   CALL H5Pset_libver_bounds_f(fapl, H5F_LIBVER_LATEST_F, H5F_LIBVER_LATEST_F, error)
   CALL check("H5Pset_libver_bounds_f",error, total_error)
   CALL h5pget_libver_bounds_f(fapl, low, high, error)

java/src/hdf/hdf5lib/HDF5Constants.java

@@ -575,6 +575,8 @@ public class HDF5Constants {
     /** */
     public static final int H5F_LIBVER_V116 = H5F_LIBVER_V116();
     /** */
+    public static final int H5F_LIBVER_V118 = H5F_LIBVER_V118();
+    /** */
     public static final int H5F_LIBVER_NBOUNDS = H5F_LIBVER_NBOUNDS();
     /** */
     public static final int H5F_LIBVER_LATEST = H5F_LIBVER_LATEST();
@@ -2060,6 +2062,8 @@ public class HDF5Constants {
 
     private static native final int H5F_LIBVER_V116();
 
+    private static native final int H5F_LIBVER_V118();
+
     private static native final int H5F_LIBVER_NBOUNDS();
 
     private static native final int H5F_LIBVER_LATEST();

java/src/jni/h5Constants.c

@@ -1309,6 +1309,11 @@ Java_hdf_hdf5lib_HDF5Constants_H5F_1LIBVER_1V116(JNIEnv *env, jclass cls)
     return H5F_LIBVER_V116;
 }
 JNIEXPORT jint JNICALL
+Java_hdf_hdf5lib_HDF5Constants_H5F_1LIBVER_1V118(JNIEnv *env, jclass cls)
+{
+    return H5F_LIBVER_V118;
+}
+JNIEXPORT jint JNICALL
 Java_hdf_hdf5lib_HDF5Constants_H5F_1LIBVER_1NBOUNDS(JNIEnv *env, jclass cls)
 {
     return H5F_LIBVER_NBOUNDS;

release_docs/INSTALL_CMake.txt

@@ -888,7 +888,7 @@ HDF5_STRICT_FORMAT_CHECKS      "Whether to perform strict file format checks"
 HDF5_WANT_DATA_ACCURACY        "IF data accuracy is guaranteed during data conversions"          ON
 HDF5_WANT_DCONV_EXCEPTION      "exception handling functions is checked during data conversions" ON
 
-DEFAULT_API_VERSION            "Enable default API (v16, v18, v110, v112, v114, v116)"           "v116"
+DEFAULT_API_VERSION            "Enable default API (v16, v18, v110, v112, v114, v116, v118)"           "v118"
 HDF5_USE_FOLDERS               "Enable folder grouping of projects in IDEs."                     ON
 HDF5_MSVC_NAMING_CONVENTION    "Use MSVC Naming conventions for Shared Libraries"                OFF
 HDF5_MINGW_STATIC_GCC_LIBS     "Statically link libgcc/libstdc++"                                OFF

src/H5Aint.c

@@ -96,6 +96,7 @@ const unsigned H5O_attr_ver_bounds[] = {
     H5O_ATTR_VERSION_3,     /* H5F_LIBVER_V112 */
     H5O_ATTR_VERSION_3,     /* H5F_LIBVER_V114 */
     H5O_ATTR_VERSION_3,     /* H5F_LIBVER_V116 */
+    H5O_ATTR_VERSION_3,     /* H5F_LIBVER_V118 */
     H5O_ATTR_VERSION_LATEST /* H5F_LIBVER_LATEST */
 };
 

src/H5Dlayout.c

@@ -49,6 +49,7 @@ const unsigned H5O_layout_ver_bounds[] = {
     H5O_LAYOUT_VERSION_4,     /* H5F_LIBVER_V112 */
     H5O_LAYOUT_VERSION_4,     /* H5F_LIBVER_V114 */
     H5O_LAYOUT_VERSION_4,     /* H5F_LIBVER_V116 */
+    H5O_LAYOUT_VERSION_4,     /* H5F_LIBVER_V118 */
     H5O_LAYOUT_VERSION_LATEST /* H5F_LIBVER_LATEST */
 };
 

src/H5Fpublic.h

@@ -189,10 +189,11 @@ typedef enum H5F_libver_t {
     H5F_LIBVER_V112     = 3, /**< Use the latest v112 format for storing objects */
     H5F_LIBVER_V114     = 4, /**< Use the latest v114 format for storing objects */
     H5F_LIBVER_V116     = 5, /**< Use the latest v116 format for storing objects */
+    H5F_LIBVER_V118     = 6, /**< Use the latest v116 format for storing objects */
     H5F_LIBVER_NBOUNDS       /**< Sentinel */
 } H5F_libver_t;
 
-#define H5F_LIBVER_LATEST H5F_LIBVER_V116
+#define H5F_LIBVER_LATEST H5F_LIBVER_V118
 
 /**
  * File space handling strategy

src/H5Fsuper.c

@@ -72,6 +72,7 @@ static const unsigned HDF5_superblock_ver_bounds[] = {
     HDF5_SUPERBLOCK_VERSION_3,     /* H5F_LIBVER_V112 */
     HDF5_SUPERBLOCK_VERSION_3,     /* H5F_LIBVER_V114 */
     HDF5_SUPERBLOCK_VERSION_3,     /* H5F_LIBVER_V116 */
+    HDF5_SUPERBLOCK_VERSION_3,     /* H5F_LIBVER_V118 */
     HDF5_SUPERBLOCK_VERSION_LATEST /* H5F_LIBVER_LATEST */
 };
 

src/H5Ofill.c

@@ -154,6 +154,7 @@ const unsigned H5O_fill_ver_bounds[] = {
     H5O_FILL_VERSION_3,     /* H5F_LIBVER_V112 */
     H5O_FILL_VERSION_3,     /* H5F_LIBVER_V114 */
     H5O_FILL_VERSION_3,     /* H5F_LIBVER_V116 */
+    H5O_FILL_VERSION_3,     /* H5F_LIBVER_V118 */
     H5O_FILL_VERSION_LATEST /* H5F_LIBVER_LATEST */
 };
 

src/H5Ofsinfo.c

@@ -70,6 +70,7 @@ static const unsigned H5O_fsinfo_ver_bounds[] = {
     H5O_FSINFO_VERSION_1,     /* H5F_LIBVER_V112 */
     H5O_FSINFO_VERSION_1,     /* H5F_LIBVER_V114 */
     H5O_FSINFO_VERSION_1,     /* H5F_LIBVER_V116 */
+    H5O_FSINFO_VERSION_1,     /* H5F_LIBVER_V118 */
     H5O_FSINFO_VERSION_LATEST /* H5F_LIBVER_LATEST */
 };
 #define N_FSINFO_VERSION_BOUNDS H5F_LIBVER_NBOUNDS