[svn-r4282]

Purpose:
    Bug Fix/Feature Add
Description:
    Added new flag ("-f" and "--family") to allow user to specify which
    file driver to use to open the file. If they don't specify anything,
    then it defaults to the old behaviour of trying each driver in turn
    until one actually opens the file.

    If the driver the user specified doesn't succeed in opening the
    file, then we do NOT try other file drivers.
Platforms tested:
    Linux

4 files changed, 152 insertions, 46 deletions

diff --git a/tools/h5dump/h5dump.c b/tools/h5dump/h5dump.c
index 977d67c..fee98aa 100644
--- a/tools/h5dump/h5dump.c
+++ b/tools/h5dump/h5dump.c
@@ -1,6 +1,7 @@
 /*
- * Copyright (C) 1998-2001 National Center for Supercomputing Applications
- *                         All rights reserved.
+ * Copyright (C) 1998, 1999, 2000, 2001
+ *     National Center for Supercomputing Applications
+ *     All rights reserved.
  *
  */
 #include <stdio.h>
@@ -15,10 +16,11 @@
 static const char  *progname = "h5dump";
 
 static int          d_status = EXIT_SUCCESS;
-static int          unamedtype = 0;    /* shared data type with no name */
+static int          unamedtype = 0;     /* shared data type with no name */
 static int          prefix_len = 1024;
 static table_t     *group_table = NULL, *dset_table = NULL, *type_table = NULL;
 static char        *prefix;
+static const char  *driver = NULL;      /* The driver to open the file with. */
 
 static const dump_header *dump_header_format;
 
@@ -390,9 +392,9 @@ struct handler_t {
  */
 #if 0
     /* binary: not implemented yet */
-static const char *s_opts = "hbBHvVa:d:g:l:t:w:xD:o:s:S:c:k:";
+static const char *s_opts = "hbBHvVa:d:f:g:l:t:w:xD:o:s:S:c:k:";
 #else
-static const char *s_opts = "hBHvVa:d:g:l:t:w:xD:o:s:S:c:k:";
+static const char *s_opts = "hBHvVa:d:f:g:l:t:w:xD:o:s:S:c:k:";
 #endif  /* 0 */
 static struct long_options l_opts[] = {
     { "help", no_arg, 'h' },
@@ -454,6 +456,11 @@ static struct long_options l_opts[] = {
     { "datatyp", require_arg, 't' },
     { "dataty", require_arg, 't' },
     { "datat", require_arg, 't' },
+    { "family", require_arg, 'f' },
+    { "famil", require_arg, 'f' },
+    { "fami", require_arg, 'f' },
+    { "fam", require_arg, 'f' },
+    { "fa", require_arg, 'f' },
     { "group", require_arg, 'g' },
     { "grou", require_arg, 'g' },
     { "gro", require_arg, 'g' },
@@ -593,6 +600,7 @@ usage: %s [OPTIONS] file\n\
       -V, --version       Print version number and exit\n\
       -a P, --attribute=P Print the specified attribute\n\
       -d P, --dataset=P   Print the specified dataset\n\
+      -f D, --family=D    Specify which driver to open the file with\n\
       -g P, --group=P     Print the specified group and all members\n\
       -l P, --soft-link=P Print the value(s) of the specified soft link\n\
       -o F, --output=F    Output raw data into file F\n\
@@ -613,8 +621,11 @@ usage: %s [OPTIONS] file\n\
       -c L, --count=L     Number of blocks to include in selection\n\
       -k L, --block=L     Size of block in hyperslab\n\
 \n\
-  P - is the full path from the root group to the object.\n\
+  D - is a driver name either: \"sec2\", \"family\", \"split\", \"multi\", or \"stream\".\n\
+        By default, the file will be opened in the same order as specified\n\
+        above until one driver succeeds in opening the file.\n\
   F - is a filename.\n\
+  P - is the full path from the root group to the object.\n\
   N - is an integer greater than 1.\n\
   L - is a list of integers the number of which are equal to the\n\
         number of dimensions in the dataspace being queried\n\
@@ -2456,6 +2467,9 @@ parse_start:
 
             last_was_dset = TRUE;
             break;
+        case 'f':
+            driver = opt_arg;
+            break;
         case 'g':
             display_all = 0;
 
@@ -2715,7 +2729,7 @@ main(int argc, const char *argv[])
     else
 	fname = argv[opt_ind];
 
-    fid = h5tools_fopen(fname, NULL, 0);
+    fid = h5tools_fopen(fname, driver, NULL, 0);
 
     if (fid < 0) {
         error_msg(progname, "unable to open file \"%s\"\n", fname);
diff --git a/tools/h5ls/h5ls.c b/tools/h5ls/h5ls.c
index 1ed03ff..6be56ae 100644
--- a/tools/h5ls/h5ls.c
+++ b/tools/h5ls/h5ls.c
@@ -2104,7 +2104,7 @@ main (int argc, char *argv[])
 	file = -1;
 
 	while (fname && *fname) {
-            file = h5tools_fopen(fname, drivername, sizeof drivername);
+            file = h5tools_fopen(fname, NULL, drivername, sizeof drivername);
 
 	    if (file>=0) {
 		if (verbose_g) {
diff --git a/tools/lib/h5tools.c b/tools/lib/h5tools.c
index ca3c8a6..42cc70c 100644
--- a/tools/lib/h5tools.c
+++ b/tools/lib/h5tools.c
@@ -1,6 +1,7 @@
 /*
- * Copyright (c) 1998-2001 National Center for Supercomputing Applications
- *                         All rights reserved.
+ * Copyright (c) 1998, 1999, 2000, 2001
+ *     National Center for Supercomputing Applications
+ *     All rights reserved.
  *
  * Programmer:  Robb Matzke <matzke@llnl.gov>
  *              Thursday, July 23, 1998
@@ -18,9 +19,6 @@
 #include "hdf5.h"
 #include "H5private.h"
 
-
-
-
 /*
  * The output functions need a temporary buffer to hold a piece of the
  * dataset while it's being printed. This constant sets the limit on the
@@ -113,6 +111,10 @@ h5tools_close(void)
  *      driver to try out. If the HDF5 library is greater than version 1.2,
  *      then we have the FAMILY, SPLIT, and MULTI drivers to play with (and
  *      the STREAM driver if H5_HAVE_STREAM is defined, that is).
+ *
+ *      If DRIVER is non-NULL, then it will try to open the file with that
+ *      driver first. We assume that the user knows what they are doing so, if
+ *      we fail, then we won't try other file drivers.
  * Return:
  *      On success, returns a file id for the opened file. If DRIVERNAME is
  *      non-null then the first DRIVERNAME_SIZE-1 characters of the driver
@@ -145,69 +147,156 @@ h5tools_close(void)
  *      Bill Wendling, 2001-01-10
  *      Changed macro behavior so that if we have a version other than 1.2.x
  *      (i.e., > 1.2), then we do the drivers check.
+ *
+ *      Bill Wendling, 2001-07-30
+ *      Added DRIVER parameter so that the user can specify "try this driver"
+ *      instead of the default behaviour. If it fails to open the file with
+ *      that driver, this will fail completely (i.e., we won't try the other
+ *      drivers). We're assuming the user knows what they're doing. How UNIX
+ *      of us.
  *-------------------------------------------------------------------------
  */
 hid_t
-h5tools_fopen(const char *fname, char *drivername, size_t drivername_size)
+h5tools_fopen(const char *fname, const char *driver, char *drivername,
+              size_t drivername_size)
 {
-    static struct {
+    static struct d_list {
         const char     *name;
         hid_t		fapl;
-    } driver[16];
-    static int          ndrivers = 0;
+    } drivers_list[] = {
+        { "sec2", FAIL },
+        { "family", FAIL },
+        { "split", FAIL },
+        { "multi", FAIL },
+#ifdef H5_HAVE_STREAM
+        { "stream", FAIL },
+#endif	/* H5_HAVE_STREAM */
+    };
+    /* This enum should match the entries in the above drivers_list since they
+     * are indexes into the drivers_list array. */
+    enum {
+        SEC2_IDX = 0,
+        FAMILY_IDX,
+        SPLIT_IDX,
+        MULTI_IDX,
+#ifdef H5_HAVE_STREAM
+        STREAM_IDX,
+#endif	/* H5_HAVE_STREAM */
+    };
+#define NUM_DRIVERS     (sizeof(drivers_list) / sizeof(struct d_list))
+
+    static int          initialized = 0;
     register int        drivernum;
-    hid_t               fid = -1;
+    hid_t               fid = FAIL;
 #ifndef VERSION12
     hid_t               fapl = H5P_DEFAULT;
 #endif  /* !VERSION12 */
 
-    if (!ndrivers) {
+    if (!initialized) {
         /* Build a list of file access property lists which we should try
          * when opening the file.  Eventually we'd like some way for the
          * user to augment/replace this list interactively. */
-        driver[ndrivers].name = "sec2";
-        driver[ndrivers].fapl = H5P_DEFAULT;
-        ndrivers++;
+        ++initialized;
+
+        /* SEC2 Driver */
+        drivers_list[SEC2_IDX].fapl = H5P_DEFAULT;
         
 #ifndef VERSION12
-        driver[ndrivers].name = "family";
-        driver[ndrivers].fapl = fapl = H5Pcreate(H5P_FILE_ACCESS);
+        /* FAMILY Driver */
+        drivers_list[FAMILY_IDX].fapl = fapl = H5Pcreate(H5P_FILE_ACCESS);
         H5Pset_fapl_family(fapl, (hsize_t)0, H5P_DEFAULT);
-        ndrivers++;
 
-        driver[ndrivers].name = "split";
-        driver[ndrivers].fapl = fapl = H5Pcreate(H5P_FILE_ACCESS);
+        /* SPLIT Driver */
+        drivers_list[SPLIT_IDX].fapl = fapl = H5Pcreate(H5P_FILE_ACCESS);
         H5Pset_fapl_split(fapl, "-m.h5", H5P_DEFAULT, "-r.h5", H5P_DEFAULT);
-        ndrivers++;
 
-        driver[ndrivers].name = "multi";
-        driver[ndrivers].fapl = fapl = H5Pcreate(H5P_FILE_ACCESS);
+        /* MULTI Driver */
+        drivers_list[MULTI_IDX].fapl = fapl = H5Pcreate(H5P_FILE_ACCESS);
         H5Pset_fapl_multi(fapl, NULL, NULL, NULL, NULL, TRUE);
-        ndrivers++;
 
 #ifdef H5_HAVE_STREAM
-        driver[ndrivers].name = "stream";
-        driver[ndrivers].fapl = fapl = H5Pcreate(H5P_FILE_ACCESS);
+        /* STREAM Driver */
+        drivers_list[STREAM_IDX].fapl = fapl = H5Pcreate(H5P_FILE_ACCESS);
         H5Pset_fapl_stream(fapl, NULL);
-        ndrivers++;
 #endif	/* H5_HAVE_STREAM */
 #endif	/* !VERSION12 */
     }
 
-    /* Try to open the file using each of the drivers */
-    for (drivernum = 0; drivernum < ndrivers; drivernum++) {
-        H5E_BEGIN_TRY {
-            fid = H5Fopen(fname, H5F_ACC_RDONLY, driver[drivernum].fapl);
-        } H5E_END_TRY;
+    if (driver && *driver) {
+        /* Determine which driver the user wants to open the file with. Try
+         * that driver. If it can't open it, then fail. */
+        if (!strcmp(driver, drivers_list[SEC2_IDX].name)) {
+            H5E_BEGIN_TRY {
+                fid = H5Fopen(fname, H5F_ACC_RDONLY,
+                              drivers_list[SEC2_IDX].fapl);
+            } H5E_END_TRY;
+
+            if (fid == FAIL)
+                goto done;
+
+            drivernum = SEC2_IDX;
+        } else if (!strcmp(driver, drivers_list[FAMILY_IDX].name)) {
+            H5E_BEGIN_TRY {
+                fid = H5Fopen(fname, H5F_ACC_RDONLY,
+                              drivers_list[FAMILY_IDX].fapl);
+            } H5E_END_TRY;
+
+            if (fid == FAIL)
+                goto done;
+
+            drivernum = FAMILY_IDX;
+        } else if (!strcmp(driver, drivers_list[SPLIT_IDX].name)) {
+            H5E_BEGIN_TRY {
+                fid = H5Fopen(fname, H5F_ACC_RDONLY,
+                              drivers_list[SPLIT_IDX].fapl);
+            } H5E_END_TRY;
 
-        if (fid >= 0)
-	    break;
+            if (fid == FAIL)
+                goto done;
+
+            drivernum = SPLIT_IDX;
+        } else if (!strcmp(driver, drivers_list[MULTI_IDX].name)) {
+            H5E_BEGIN_TRY {
+                fid = H5Fopen(fname, H5F_ACC_RDONLY,
+                              drivers_list[MULTI_IDX].fapl);
+            } H5E_END_TRY;
+
+            if (fid == FAIL)
+                goto done;
+
+            drivernum = MULTI_IDX;
+#ifdef H5_HAVE_STREAM
+        } else if (!strcmp(driver, drivers_list[STREAM_IDX].name)) {
+            H5E_BEGIN_TRY {
+                fid = H5Fopen(fname, H5F_ACC_RDONLY,
+                              drivers_list[STREAM_IDX].fapl);
+            } H5E_END_TRY;
+
+            if (fid == FAIL)
+                goto done;
+
+            drivernum = STREAM_IDX;
+#endif	/* H5_HAVE_STREAM */
+        } else {
+            goto done;
+        }
+    } else {
+        /* Try to open the file using each of the drivers */
+        for (drivernum = 0; drivernum < NUM_DRIVERS; drivernum++) {
+            H5E_BEGIN_TRY {
+                fid = H5Fopen(fname, H5F_ACC_RDONLY,
+                              drivers_list[drivernum].fapl);
+            } H5E_END_TRY;
+
+            if (fid != FAIL)
+                break;
+        }
     }
 
     /* Save the driver name */
     if (drivername && drivername_size) {
-        if (fid >= 0) {
-            strncpy(drivername, driver[drivernum].name, drivername_size);
+        if (fid != FAIL) {
+            strncpy(drivername, drivers_list[drivernum].name, drivername_size);
             drivername[drivername_size - 1] = '\0';
         } else {
             /*no file opened*/
@@ -215,6 +304,7 @@ h5tools_fopen(const char *fname, char *drivername, size_t drivername_size)
         }
     }
 
+done:
     return fid;
 }
 
diff --git a/tools/lib/h5tools.h b/tools/lib/h5tools.h
index b4e23d6..eda4a39 100644
--- a/tools/lib/h5tools.h
+++ b/tools/lib/h5tools.h
@@ -1,6 +1,7 @@
 /*
- * Copyright (c) 1998-2001 National Center for Supercomputing Applications
- *                         All rights reserved.
+ * Copyright (c) 1998, 1999, 2000, 2001
+ *     National Center for Supercomputing Applications
+ *     All rights reserved.
  *
  * Programmer:  Robb Matzke <matzke@llnl.gov>
  *              Thursday, July 23, 1998
@@ -464,7 +465,8 @@ extern FILE   *rawdatastream;       /*output stream for raw data            */
 /* Definitions of useful routines */
 extern void     h5tools_init(void);
 extern void     h5tools_close(void);
-extern hid_t    h5tools_fopen(const char *fname, char *drivername, size_t drivername_len);
+extern hid_t    h5tools_fopen(const char *fname, const char *driver,
+                              char *drivername, size_t drivername_len);
 extern hid_t    h5tools_fixtype(hid_t f_type);
 extern int      h5tools_dump_dset(FILE *stream, const h5dump_t *info, hid_t dset,
                                   hid_t p_typ, struct subset_t *sset, int indentlevel);