hds-v5: Add function hdsIsOpen

Needed so that the wrapper for hdsNew can determine if a file is already
open prior to creating it.

Author: dsberry

Makefile.am

@@ -119,6 +119,7 @@ hdsDimF2C.c \
 hdsFree.c \
 hdsGroup.c \
 hdsInfoI.c \
+hdsIsOpen.c \
 hdsLock.c \
 hdsNew.c \
 hdsOpen.c \

hds.h

@@ -1057,6 +1057,13 @@ hdsGtune(const char *param_str, int *value, int *status);
 int
 hdsInfoI(const HDSLoc* locator, const char *topic_str, const char *extra, int *result, int *status);
 
+/*=============================================*/
+/* hdsIsOpen - Check if container file is open */
+/*=============================================*/
+
+int
+hdsIsOpen(const char *file_str, int *result, int *status);
+
 /*=================================*/
 /* hdsLink - Link locator to group */
 /*=================================*/

hdsIsOpen.c

@@ -0,0 +1,126 @@
+/*
+*+
+*  Name:
+*     hdsIsOpen
+
+*  Purpose:
+*     Check if a container file is already open in HDS V5.
+
+*  Language:
+*     Starlink ANSI C
+
+*  Type of Module:
+*     Library routine
+
+*  Invocation:
+*     int hdsIsOpen( const char *file_str, int *isopen, int * status );
+
+*  Arguments:
+*     file = const char * (Given)
+*        Container file name. Use DAT__FLEXT (".h5sdf") if no suffix specified.
+*     isopen = int * (Returned)
+*        Pointer to a flag that is returned non-zero if the supplied
+*        container file is already open within HDS V5.
+*     status = int* (Given and Returned)
+*        Pointer to global status.
+
+*  Description:
+*     Checks if the supplied container file is already open within HDS V5.
+
+*  Returned Value:
+*     int = inherited status on exit. This is for compatibility with the
+*           original HDS API.
+
+*  Authors:
+*     DSB: David S Berry (EAO):
+*     {enter_new_authors_here}
+
+*  Notes:
+*     - A file extension of DAT__FLEXT (".h5sdf") is the default.
+
+*  History:
+*     2020-10-15 (DSB):
+*        Initial version
+*     {enter_further_changes_here}
+
+*  Copyright:
+*     Copyright (C) 2020 East Asian Observatory.
+*     All Rights Reserved.
+
+*  Licence:
+*     Redistribution and use in source and binary forms, with or
+*     without modification, are permitted provided that the following
+*     conditions are met:
+*
+*     - Redistributions of source code must retain the above copyright
+*       notice, this list of conditions and the following disclaimer.
+*
+*     - Redistributions in binary form must reproduce the above
+*       copyright notice, this list of conditions and the following
+*       disclaimer in the documentation and/or other materials
+*       provided with the distribution.
+*
+*     - Neither the name of the {organization} nor the names of its
+*       contributors may be used to endorse or promote products
+*       derived from this software without specific prior written
+*       permission.
+*
+*     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
+*     CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+*     INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+*     MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+*     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+*     CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+*     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+*     LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+*     USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+*     AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+*     LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
+*     IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
+*     THE POSSIBILITY OF SUCH DAMAGE.
+
+*  Bugs:
+*     {note_any_bugs_here}
+*-
+*/
+
+#include <stdlib.h>
+#include <string.h>
+#include <unistd.h>
+
+#include "hds1.h"
+#include "dat1.h"
+#include "ems.h"
+#include "dat_err.h"
+#include "hds.h"
+#include "sae_par.h"
+
+#include "star/one.h"
+
+#include "hdf5.h"
+
+int hdsIsOpen(const char *file_str, int *isopen, int *status) {
+
+  char *fname = NULL;
+
+  /* Returns the inherited status for compatibility reasons */
+  if (*status != SAI__OK) return *status;
+
+  /* Configure the HDF5 library for our needs as this routine could be called
+     before any others. */
+  dat1InitHDF5();
+
+  /* Create buffer for file name so that we include the file extension */
+  fname = dau1CheckFileName( file_str, status );
+
+  /* Check to see if the file is currently open. */
+  *isopen = hds1IsOpen( fname, status );
+
+  /* Free allocated resource */
+ CLEANUP:
+  if (fname) MEM_FREE(fname);
+
+  return *status;
+}
+
+

hdsTest.c

@@ -110,6 +110,7 @@ int main (void) {
   char buffer[1024];  /* plenty large enough */
   double darr[] = { 4.5, 2.5 };
   const hdsbool_t boolarr[] = { 1, 0, 1 };
+  int isopen;
   double retdarr[2];
   void *mapv;    /* Mapped void* */
   double *mapd;  /* Mapped _DOUBLE */
@@ -674,9 +675,23 @@ int main (void) {
   printf("Query Locator status:\n");
   hdsShow("LOCATORS", &status);
 
+  /* Check it is now closed */
+  hdsIsOpen( path, &isopen, &status );
+  if( isopen && status == SAI__OK ) {
+     status = DAT__FATAL;
+     emsRepf( "SIZE","File %s should now be closed, but it isn't", &status, path);
+  }
+
   /* Re-open */
   hdsOpen( path, "UPDATE", &loc1, &status );
 
+  /* Check it is now open */
+  hdsIsOpen( path, &isopen, &status );
+  if( !isopen && status == SAI__OK ) {
+     status = DAT__FATAL;
+     emsRepf( "SIZE","File %s should now be open, but it isn't", &status, path);
+  }
+
   /* Look for the data array and map it */
   datFind( loc1, "DATA_ARRAY", &loc2, &status );
   printf("Query files after reopen:\n");

hds_v5.h

@@ -1070,6 +1070,13 @@ hdsLock_v5(const HDSLoc *locator, int *status);
 int
 hdsNew_v5(const char *file_str, const char *name_str, const char *type_str, int ndim, const hdsdim dims[], HDSLoc **locator, int *status);
 
+/*=============================================*/
+/* hdsIsOpen - Check if container file is open */
+/*=============================================*/
+
+int
+hdsIsOpen_v5(const char *file_str, int *isopen, int *status);
+
 /*========================================*/
 /* hdsOpen - Open existing container file */
 /*========================================*/

hds_v5_map.h

@@ -146,6 +146,7 @@
 #define hdsInfoI hdsInfoI_v5
 #define hdsLink hdsLink_v5
 #define hdsLock hdsLock_v5
+#define hdsIsOpen hdsIsOpen_v5
 #define hdsNew hdsNew_v5
 #define hdsOpen hdsOpen_v5
 #define hdsShow hdsShow_v5