Merge branch 'develop' into feature/coding_standardsfeature/coding_standards

1 files changed, 91 insertions, 105 deletions

diff --git a/src/H5Goh.c b/src/H5Goh.c
index f29529b..fcc62de 100644
--- a/src/H5Goh.c
+++ b/src/H5Goh.c
@@ -6,7 +6,7 @@
  * This file is part of HDF5.  The full HDF5 copyright notice, including     *
  * terms governing use, modification, and redistribution, is contained in    *
  * the COPYING file, which can be found at the root of the source code       *
- * distribution tree, or in https://support.hdfgroup.org/ftp/HDF5/releases.  *
+ * distribution tree, or in https://www.hdfgroup.org/licenses.               *
  * If you do not have access to either file, you may request a copy from     *
  * help@hdfgroup.org.                                                        *
  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
@@ -15,77 +15,68 @@
 /* Module Setup */
 /****************/
 
-#include "H5Gmodule.h"          /* This source code file is part of the H5G module */
-#define H5O_FRIEND		/*suppress error about including H5Opkg	  */
-
+#include "H5Gmodule.h" /* This source code file is part of the H5G module */
+#define H5O_FRIEND     /*suppress error about including H5Opkg	  */
 
 /***********/
 /* Headers */
 /***********/
-#include "H5private.h"		/* Generic Functions			*/
-#include "H5Eprivate.h"		/* Error handling		  	*/
-#include "H5Gpkg.h"             /* Groups				*/
-#include "H5Iprivate.h"		/* IDs			  		*/
-#include "H5Opkg.h"             /* Object headers			*/
-#include "H5VLprivate.h"        /* Virtual Object Layer                     */
-
+#include "H5private.h"   /* Generic Functions			*/
+#include "H5Eprivate.h"  /* Error handling		  	*/
+#include "H5Gpkg.h"      /* Groups				*/
+#include "H5Iprivate.h"  /* IDs			  		*/
+#include "H5Opkg.h"      /* Object headers			*/
+#include "H5VLprivate.h" /* Virtual Object Layer                     */
 
 /****************/
 /* Local Macros */
 /****************/
 
-
 /******************/
 /* Local Typedefs */
 /******************/
 
-
 /********************/
 /* Local Prototypes */
 /********************/
 
-static void *H5O__group_get_copy_file_udata(void);
-static void H5O__group_free_copy_file_udata(void *udata);
-static htri_t H5O__group_isa(const H5O_t *loc);
-static void *H5O__group_open(const H5G_loc_t *obj_loc, H5I_type_t *opened_type);
-static void *H5O__group_create(H5F_t *f, void *_crt_info, H5G_loc_t *obj_loc);
+static void *     H5O__group_get_copy_file_udata(void);
+static void       H5O__group_free_copy_file_udata(void *udata);
+static htri_t     H5O__group_isa(const H5O_t *loc);
+static void *     H5O__group_open(const H5G_loc_t *obj_loc, H5I_type_t *opened_type);
+static void *     H5O__group_create(H5F_t *f, void *_crt_info, H5G_loc_t *obj_loc);
 static H5O_loc_t *H5O__group_get_oloc(hid_t obj_id);
-static herr_t H5O__group_bh_info(const H5O_loc_t *loc, H5O_t *oh,
-    H5_ih_info_t *bh_info);
-
+static herr_t     H5O__group_bh_info(const H5O_loc_t *loc, H5O_t *oh, H5_ih_info_t *bh_info);
 
 /*********************/
 /* Package Variables */
 /*********************/
 
-
 /*****************************/
 /* Library Private Variables */
 /*****************************/
 
-
 /*******************/
 /* Local Variables */
 /*******************/
 
 /* This message derives from H5O object class */
 const H5O_obj_class_t H5O_OBJ_GROUP[1] = {{
-    H5O_TYPE_GROUP,		/* object type			*/
-    "group",			/* object name, for debugging	*/
-    H5O__group_get_copy_file_udata, /* get 'copy file' user data	*/
+    H5O_TYPE_GROUP,                  /* object type			*/
+    "group",                         /* object name, for debugging	*/
+    H5O__group_get_copy_file_udata,  /* get 'copy file' user data	*/
     H5O__group_free_copy_file_udata, /* free 'copy file' user data */
-    H5O__group_isa, 		/* "isa" message		*/
-    H5O__group_open, 		/* open an object of this class */
-    H5O__group_create, 		/* create an object of this class */
-    H5O__group_get_oloc,	/* get an object header location for an object */
-    H5O__group_bh_info, 	/* get the index & heap info for an object */
-    NULL 			/* flush an opened object of this class */
+    H5O__group_isa,                  /* "isa" message		*/
+    H5O__group_open,                 /* open an object of this class */
+    H5O__group_create,               /* create an object of this class */
+    H5O__group_get_oloc,             /* get an object header location for an object */
+    H5O__group_bh_info,              /* get the index & heap info for an object */
+    NULL                             /* flush an opened object of this class */
 }};
 
 /* Declare the external free list to manage the H5O_ginfo_t struct */
 H5FL_DEFINE(H5G_copy_file_ud_t);
 
-
 /*-------------------------------------------------------------------------
  * Function:	H5O__group_get_copy_file_udata
  *
@@ -104,21 +95,20 @@ H5FL_DEFINE(H5G_copy_file_ud_t);
 static void *
 H5O__group_get_copy_file_udata(void)
 {
-    void *ret_value = NULL;     /* Return value */
+    void *ret_value = NULL; /* Return value */
 
-    FUNC_ENTER_STATIC
+    FUNC_ENTER_PACKAGE
 
     /* Allocate space for the 'copy file' user data for copying groups.
      * Currently this is only a ginfo, so there is no specific struct type for
      * this operation. */
-    if(NULL == (ret_value = H5FL_CALLOC(H5G_copy_file_ud_t)))
+    if (NULL == (ret_value = H5FL_CALLOC(H5G_copy_file_ud_t)))
         HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed")
 
 done:
     FUNC_LEAVE_NOAPI(ret_value)
 } /* end H5O__group_get_copy_file_udata() */
 
-
 /*-------------------------------------------------------------------------
  * Function:	H5O__group_free_copy_file_udata
  *
@@ -137,7 +127,7 @@ H5O__group_free_copy_file_udata(void *_udata)
 {
     H5G_copy_file_ud_t *udata = (H5G_copy_file_ud_t *)_udata;
 
-    FUNC_ENTER_STATIC_NOERR
+    FUNC_ENTER_PACKAGE_NOERR
 
     /* Sanity check */
     HDassert(udata);
@@ -151,7 +141,6 @@ H5O__group_free_copy_file_udata(void *_udata)
     FUNC_LEAVE_NOAPI_VOID
 } /* end H5O__group_free_copy_file_udata() */
 
-
 /*-------------------------------------------------------------------------
  * Function:	H5O__group_isa
  *
@@ -172,19 +161,19 @@ H5O__group_free_copy_file_udata(void *_udata)
 static htri_t
 H5O__group_isa(const H5O_t *oh)
 {
-    htri_t	stab_exists;            /* Whether the 'stab' message is in the object header */
-    htri_t	linfo_exists;           /* Whether the 'linfo' message is in the object header */
-    htri_t	ret_value = FAIL;       /* Return value */
+    htri_t stab_exists;      /* Whether the 'stab' message is in the object header */
+    htri_t linfo_exists;     /* Whether the 'linfo' message is in the object header */
+    htri_t ret_value = FAIL; /* Return value */
 
-    FUNC_ENTER_STATIC
+    FUNC_ENTER_PACKAGE
 
     HDassert(oh);
 
     /* Check for any of the messages that indicate a group */
-    if((stab_exists = H5O_msg_exists_oh(oh, H5O_STAB_ID)) < 0)
-	HGOTO_ERROR(H5E_SYM, H5E_NOTFOUND, FAIL, "unable to read object header")
-    if((linfo_exists = H5O_msg_exists_oh(oh, H5O_LINFO_ID)) < 0)
-	HGOTO_ERROR(H5E_SYM, H5E_NOTFOUND, FAIL, "unable to read object header")
+    if ((stab_exists = H5O_msg_exists_oh(oh, H5O_STAB_ID)) < 0)
+        HGOTO_ERROR(H5E_SYM, H5E_NOTFOUND, FAIL, "unable to read object header")
+    if ((linfo_exists = H5O_msg_exists_oh(oh, H5O_LINFO_ID)) < 0)
+        HGOTO_ERROR(H5E_SYM, H5E_NOTFOUND, FAIL, "unable to read object header")
 
     ret_value = (stab_exists > 0 || linfo_exists > 0);
 
@@ -192,7 +181,6 @@ done:
     FUNC_LEAVE_NOAPI(ret_value)
 } /* end H5O__group_isa() */
 
-
 /*-------------------------------------------------------------------------
  * Function:    H5O__group_open
  *
@@ -209,30 +197,29 @@ done:
 static void *
 H5O__group_open(const H5G_loc_t *obj_loc, H5I_type_t *opened_type)
 {
-    H5G_t      *grp         = NULL;         /* Group opened */
-    void       *ret_value   = NULL;         /* Return value */
+    H5G_t *grp       = NULL; /* Group opened */
+    void * ret_value = NULL; /* Return value */
 
-    FUNC_ENTER_STATIC
+    FUNC_ENTER_PACKAGE
 
     HDassert(obj_loc);
 
     *opened_type = H5I_GROUP;
 
     /* Open the group */
-    if(NULL == (grp = H5G_open(obj_loc)))
+    if (NULL == (grp = H5G_open(obj_loc)))
         HGOTO_ERROR(H5E_SYM, H5E_CANTOPENOBJ, NULL, "unable to open group")
 
     ret_value = (void *)grp;
 
 done:
-    if(NULL == ret_value)
-        if(grp && H5G_close(grp) < 0)
+    if (NULL == ret_value)
+        if (grp && H5G_close(grp) < 0)
             HDONE_ERROR(H5E_SYM, H5E_CLOSEERROR, NULL, "unable to release group")
 
     FUNC_LEAVE_NOAPI(ret_value)
 } /* end H5O__group_open() */
 
-
 /*-------------------------------------------------------------------------
  * Function:	H5O__group_create
  *
@@ -249,11 +236,11 @@ done:
 static void *
 H5O__group_create(H5F_t *f, void *_crt_info, H5G_loc_t *obj_loc)
 {
-    H5G_obj_create_t *crt_info = (H5G_obj_create_t *)_crt_info; /* Group creation parameters */
-    H5G_t *grp = NULL;          /* New group created */
-    void *ret_value = NULL;     /* Return value */
+    H5G_obj_create_t *crt_info  = (H5G_obj_create_t *)_crt_info; /* Group creation parameters */
+    H5G_t *           grp       = NULL;                          /* New group created */
+    void *            ret_value = NULL;                          /* Return value */
 
-    FUNC_ENTER_STATIC
+    FUNC_ENTER_PACKAGE
 
     /* Sanity checks */
     HDassert(f);
@@ -261,27 +248,26 @@ H5O__group_create(H5F_t *f, void *_crt_info, H5G_loc_t *obj_loc)
     HDassert(obj_loc);
 
     /* Create the the group */
-    if(NULL == (grp = H5G__create(f, crt_info)))
+    if (NULL == (grp = H5G__create(f, crt_info)))
         HGOTO_ERROR(H5E_SYM, H5E_CANTINIT, NULL, "unable to create group")
 
     /* Set up the new group's location */
-    if(NULL == (obj_loc->oloc = H5G_oloc(grp)))
+    if (NULL == (obj_loc->oloc = H5G_oloc(grp)))
         HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, NULL, "unable to get object location of group")
-    if(NULL == (obj_loc->path = H5G_nameof(grp)))
+    if (NULL == (obj_loc->path = H5G_nameof(grp)))
         HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, NULL, "unable to get path of group")
 
     /* Set the return value */
     ret_value = grp;
 
 done:
-    if(ret_value == NULL)
-        if(grp && H5G_close(grp) < 0)
+    if (ret_value == NULL)
+        if (grp && H5G_close(grp) < 0)
             HDONE_ERROR(H5E_SYM, H5E_CLOSEERROR, NULL, "unable to release group")
 
     FUNC_LEAVE_NOAPI(ret_value)
 } /* end H5O__group_create() */
 
-
 /*-------------------------------------------------------------------------
  * Function:	H5O__group_get_oloc
  *
@@ -298,24 +284,23 @@ done:
 static H5O_loc_t *
 H5O__group_get_oloc(hid_t obj_id)
 {
-    H5G_t       *grp;                   /* Group opened */
-    H5O_loc_t	*ret_value = NULL;      /* Return value */
+    H5G_t *    grp;              /* Group opened */
+    H5O_loc_t *ret_value = NULL; /* Return value */
 
-    FUNC_ENTER_STATIC
+    FUNC_ENTER_PACKAGE
 
     /* Get the group */
-    if(NULL ==  (grp = (H5G_t *)H5VL_object(obj_id)))
-        HGOTO_ERROR(H5E_OHDR, H5E_BADATOM, NULL, "couldn't get object from ID")
+    if (NULL == (grp = (H5G_t *)H5VL_object(obj_id)))
+        HGOTO_ERROR(H5E_OHDR, H5E_BADID, NULL, "couldn't get object from ID")
 
     /* Get the group's object header location */
-    if(NULL == (ret_value = H5G_oloc(grp)))
+    if (NULL == (ret_value = H5G_oloc(grp)))
         HGOTO_ERROR(H5E_OHDR, H5E_CANTGET, NULL, "unable to get object location from object")
 
 done:
     FUNC_LEAVE_NOAPI(ret_value)
 } /* end H5O__group_get_oloc() */
 
-
 /*-------------------------------------------------------------------------
  * Function:    H5O__group_bh_info
  *
@@ -332,13 +317,13 @@ done:
 static herr_t
 H5O__group_bh_info(const H5O_loc_t *loc, H5O_t *oh, H5_ih_info_t *bh_info)
 {
-    htri_t	exists;                 /* Flag if header message of interest exists */
-    H5HF_t      *fheap = NULL;          /* Fractal heap handle */
-    H5B2_t      *bt2_name = NULL;       /* v2 B-tree handle for name index */
-    H5B2_t      *bt2_corder = NULL;     /* v2 B-tree handle for creation order index */
-    herr_t      ret_value = SUCCEED;  	/* Return value */
+    htri_t  exists;               /* Flag if header message of interest exists */
+    H5HF_t *fheap      = NULL;    /* Fractal heap handle */
+    H5B2_t *bt2_name   = NULL;    /* v2 B-tree handle for name index */
+    H5B2_t *bt2_corder = NULL;    /* v2 B-tree handle for creation order index */
+    herr_t  ret_value  = SUCCEED; /* Return value */
 
-    FUNC_ENTER_STATIC_TAG(oh->cache_info.addr)
+    FUNC_ENTER_PACKAGE
 
     /* Sanity check */
     HDassert(loc);
@@ -348,69 +333,70 @@ H5O__group_bh_info(const H5O_loc_t *loc, H5O_t *oh, H5_ih_info_t *bh_info)
     HDassert(bh_info);
 
     /* Check for "new style" group info */
-    if((exists = H5O_msg_exists_oh(oh, H5O_LINFO_ID)) < 0)
-	HGOTO_ERROR(H5E_SYM, H5E_NOTFOUND, FAIL, "unable to read object header")
-    if(exists > 0) {
-        H5O_linfo_t linfo;          	/* Link info message */
+    if ((exists = H5O_msg_exists_oh(oh, H5O_LINFO_ID)) < 0)
+        HGOTO_ERROR(H5E_SYM, H5E_NOTFOUND, FAIL, "unable to read object header")
+    if (exists > 0) {
+        H5O_linfo_t linfo; /* Link info message */
 
         /* Get "new style" group info */
-        if(NULL == H5O_msg_read_oh(loc->file, oh, H5O_LINFO_ID, &linfo))
-	    HGOTO_ERROR(H5E_SYM, H5E_CANTGET, FAIL, "can't read LINFO message")
+        if (NULL == H5O_msg_read_oh(loc->file, oh, H5O_LINFO_ID, &linfo))
+            HGOTO_ERROR(H5E_SYM, H5E_CANTGET, FAIL, "can't read LINFO message")
 
         /* Check if name index available */
-        if(H5F_addr_defined(linfo.name_bt2_addr)) {
+        if (H5F_addr_defined(linfo.name_bt2_addr)) {
             /* Open the name index v2 B-tree */
-            if(NULL == (bt2_name = H5B2_open(loc->file, linfo.name_bt2_addr, NULL)))
+            if (NULL == (bt2_name = H5B2_open(loc->file, linfo.name_bt2_addr, NULL)))
                 HGOTO_ERROR(H5E_SYM, H5E_CANTOPENOBJ, FAIL, "unable to open v2 B-tree for name index")
 
             /* Get name index B-tree size */
-            if(H5B2_size(bt2_name, &bh_info->index_size) < 0)
+            if (H5B2_size(bt2_name, &bh_info->index_size) < 0)
                 HGOTO_ERROR(H5E_SYM, H5E_CANTGET, FAIL, "can't retrieve B-tree storage info for name index")
         } /* end if */
 
         /* Check if creation order index available */
-	if(H5F_addr_defined(linfo.corder_bt2_addr)) {
+        if (H5F_addr_defined(linfo.corder_bt2_addr)) {
             /* Open the creation order index v2 B-tree */
-            if(NULL == (bt2_corder = H5B2_open(loc->file, linfo.corder_bt2_addr, NULL)))
-                HGOTO_ERROR(H5E_SYM, H5E_CANTOPENOBJ, FAIL, "unable to open v2 B-tree for creation order index")
+            if (NULL == (bt2_corder = H5B2_open(loc->file, linfo.corder_bt2_addr, NULL)))
+                HGOTO_ERROR(H5E_SYM, H5E_CANTOPENOBJ, FAIL,
+                            "unable to open v2 B-tree for creation order index")
 
             /* Get creation order index B-tree size */
-            if(H5B2_size(bt2_corder, &bh_info->index_size) < 0)
-                HGOTO_ERROR(H5E_SYM, H5E_CANTGET, FAIL, "can't retrieve B-tree storage info for creation order index")
+            if (H5B2_size(bt2_corder, &bh_info->index_size) < 0)
+                HGOTO_ERROR(H5E_SYM, H5E_CANTGET, FAIL,
+                            "can't retrieve B-tree storage info for creation order index")
         } /* end if */
 
         /* Get fractal heap size, if available */
-        if(H5F_addr_defined(linfo.fheap_addr)) {
+        if (H5F_addr_defined(linfo.fheap_addr)) {
             /* Open the fractal heap for links */
-            if(NULL == (fheap = H5HF_open(loc->file, linfo.fheap_addr)))
+            if (NULL == (fheap = H5HF_open(loc->file, linfo.fheap_addr)))
                 HGOTO_ERROR(H5E_SYM, H5E_CANTOPENOBJ, FAIL, "unable to open fractal heap")
 
             /* Get heap storage size */
-            if(H5HF_size(fheap, &bh_info->heap_size) < 0)
+            if (H5HF_size(fheap, &bh_info->heap_size) < 0)
                 HGOTO_ERROR(H5E_SYM, H5E_CANTGET, FAIL, "can't retrieve fractal heap storage info")
         } /* end if */
-    } /* end if */
+    }     /* end if */
     else {
-        H5O_stab_t          stab;       	/* Info about symbol table */
+        H5O_stab_t stab; /* Info about symbol table */
 
         /* Must be "old style" group, get symbol table message */
-        if(NULL == H5O_msg_read_oh(loc->file, oh, H5O_STAB_ID, &stab))
-	    HGOTO_ERROR(H5E_SYM, H5E_CANTGET, FAIL, "can't find LINFO nor STAB messages")
+        if (NULL == H5O_msg_read_oh(loc->file, oh, H5O_STAB_ID, &stab))
+            HGOTO_ERROR(H5E_SYM, H5E_CANTGET, FAIL, "can't find LINFO nor STAB messages")
 
         /* Get symbol table size info */
-        if(H5G__stab_bh_size(loc->file, &stab, bh_info) < 0)
+        if (H5G__stab_bh_size(loc->file, &stab, bh_info) < 0)
             HGOTO_ERROR(H5E_SYM, H5E_CANTGET, FAIL, "can't retrieve symbol table size info")
     } /* end else */
 
 done:
     /* Release resources */
-    if(fheap && H5HF_close(fheap) < 0)
+    if (fheap && H5HF_close(fheap) < 0)
         HDONE_ERROR(H5E_SYM, H5E_CANTCLOSEOBJ, FAIL, "can't close fractal heap")
-    if(bt2_name && H5B2_close(bt2_name) < 0)
+    if (bt2_name && H5B2_close(bt2_name) < 0)
         HDONE_ERROR(H5E_SYM, H5E_CANTCLOSEOBJ, FAIL, "can't close v2 B-tree for name index")
-    if(bt2_corder && H5B2_close(bt2_corder) < 0)
+    if (bt2_corder && H5B2_close(bt2_corder) < 0)
         HDONE_ERROR(H5E_SYM, H5E_CANTCLOSEOBJ, FAIL, "can't close v2 B-tree for creation order index")
 
-    FUNC_LEAVE_NOAPI_TAG(ret_value)
+    FUNC_LEAVE_NOAPI(ret_value)
 } /* end H5O__group_bh_info() */
-