Merge branch 'develop' into feature/coding_standardsfeature/coding_standards

1 files changed, 94 insertions, 122 deletions

diff --git a/src/H5Ostab.c b/src/H5Ostab.c
index 0f14a4b..06480cf 100644
--- a/src/H5Ostab.c
+++ b/src/H5Ostab.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,70 +15,64 @@
  *
  * Created:             H5Ostab.c
  *                      Aug  6 1997
- *                      Robb Matzke <matzke@llnl.gov>
+ *                      Robb Matzke
  *
  * Purpose:             Symbol table messages.
  *
  *-------------------------------------------------------------------------
  */
 
-#define H5G_FRIEND		/*suppress error about including H5Gpkg   */
-#include "H5Omodule.h"          /* This source code file is part of the H5O module */
-
-
-#include "H5private.h"		/* Generic Functions			*/
-#include "H5Eprivate.h"		/* Error handling		  	*/
-#include "H5FLprivate.h"	/* Free lists                           */
-#include "H5Gpkg.h"		/* Groups				*/
-#include "H5HLprivate.h"	/* Local Heaps				*/
-#include "H5Opkg.h"             /* Object headers			*/
+#define H5G_FRIEND     /*suppress error about including H5Gpkg   */
+#include "H5Omodule.h" /* This source code file is part of the H5O module */
 
+#include "H5private.h"   /* Generic Functions			*/
+#include "H5Eprivate.h"  /* Error handling		  	*/
+#include "H5FLprivate.h" /* Free lists                           */
+#include "H5Gpkg.h"      /* Groups				*/
+#include "H5HLprivate.h" /* Local Heaps				*/
+#include "H5Opkg.h"      /* Object headers			*/
 
 /* PRIVATE PROTOTYPES */
-static void *H5O__stab_decode(H5F_t *f, H5O_t *open_oh, unsigned mesg_flags,
-    unsigned *ioflags, size_t p_size, const uint8_t *p);
+static void *H5O__stab_decode(H5F_t *f, H5O_t *open_oh, unsigned mesg_flags, unsigned *ioflags, size_t p_size,
+                              const uint8_t *p);
 static herr_t H5O__stab_encode(H5F_t *f, hbool_t disable_shared, uint8_t *p, const void *_mesg);
-static void *H5O__stab_copy(const void *_mesg, void *_dest);
+static void * H5O__stab_copy(const void *_mesg, void *_dest);
 static size_t H5O__stab_size(const H5F_t *f, hbool_t disable_shared, const void *_mesg);
 static herr_t H5O__stab_free(void *_mesg);
 static herr_t H5O__stab_delete(H5F_t *f, H5O_t *open_oh, void *_mesg);
-static void *H5O__stab_copy_file(H5F_t *file_src, void *native_src,
-    H5F_t *file_dst, hbool_t *recompute_size, unsigned *mesg_flags,
-    H5O_copy_t *cpy_info, void *_udata);
-static herr_t H5O__stab_post_copy_file(const H5O_loc_t *src_oloc,
-    const void *mesg_src, H5O_loc_t *dst_oloc, void *mesg_dst,
-    unsigned *mesg_flags, H5O_copy_t *cpy_info);
-static herr_t H5O__stab_debug(H5F_t *f, const void *_mesg,
-    FILE * stream, int indent, int fwidth);
+static void * H5O__stab_copy_file(H5F_t *file_src, void *native_src, H5F_t *file_dst, hbool_t *recompute_size,
+                                  unsigned *mesg_flags, H5O_copy_t *cpy_info, void *_udata);
+static herr_t H5O__stab_post_copy_file(const H5O_loc_t *src_oloc, const void *mesg_src, H5O_loc_t *dst_oloc,
+                                       void *mesg_dst, unsigned *mesg_flags, H5O_copy_t *cpy_info);
+static herr_t H5O__stab_debug(H5F_t *f, const void *_mesg, FILE *stream, int indent, int fwidth);
 
 /* This message derives from H5O message class */
 const H5O_msg_class_t H5O_MSG_STAB[1] = {{
-    H5O_STAB_ID,            	/*message id number             */
-    "stab",                 	/*message name for debugging    */
-    sizeof(H5O_stab_t),     	/*native message size           */
-    0,				/* messages are sharable?       */
-    H5O__stab_decode,        	/*decode message                */
-    H5O__stab_encode,        	/*encode message                */
-    H5O__stab_copy,          	/*copy the native value         */
-    H5O__stab_size,          	/*size of symbol table entry    */
-    NULL,                   	/*default reset method          */
-    H5O__stab_free,	        /* free method			*/
-    H5O__stab_delete,	        /* file delete method		*/
-    NULL,			/* link method			*/
-    NULL, 			/*set share method		*/
-    NULL,		    	/*can share method		*/
-    NULL,			/* pre copy native value to file */
-    H5O__stab_copy_file,	/* copy native value to file    */
-    H5O__stab_post_copy_file,	/* post copy native value to file    */
-    NULL,			/* get creation index		*/
-    NULL,			/* set creation index		*/
-    H5O__stab_debug         	/*debug the message             */
+    H5O_STAB_ID,              /*message id number             */
+    "stab",                   /*message name for debugging    */
+    sizeof(H5O_stab_t),       /*native message size           */
+    0,                        /* messages are shareable?       */
+    H5O__stab_decode,         /*decode message                */
+    H5O__stab_encode,         /*encode message                */
+    H5O__stab_copy,           /*copy the native value         */
+    H5O__stab_size,           /*size of symbol table entry    */
+    NULL,                     /*default reset method          */
+    H5O__stab_free,           /* free method			*/
+    H5O__stab_delete,         /* file delete method		*/
+    NULL,                     /* link method			*/
+    NULL,                     /*set share method		*/
+    NULL,                     /*can share method		*/
+    NULL,                     /* pre copy native value to file */
+    H5O__stab_copy_file,      /* copy native value to file    */
+    H5O__stab_post_copy_file, /* post copy native value to file    */
+    NULL,                     /* get creation index		*/
+    NULL,                     /* set creation index		*/
+    H5O__stab_debug           /*debug the message             */
 }};
 
 /* Declare a free list to manage the H5O_stab_t struct */
 H5FL_DEFINE_STATIC(H5O_stab_t);
 
-
 /*-------------------------------------------------------------------------
  * Function:    H5O__stab_decode
  *
@@ -90,27 +84,25 @@ H5FL_DEFINE_STATIC(H5O_stab_t);
  *              Failure:        NULL
  *
  * Programmer:  Robb Matzke
- *              matzke@llnl.gov
  *              Aug  6 1997
  *
  *-------------------------------------------------------------------------
  */
 static void *
-H5O__stab_decode(H5F_t *f, H5O_t H5_ATTR_UNUSED *open_oh,
-    unsigned H5_ATTR_UNUSED mesg_flags, unsigned H5_ATTR_UNUSED *ioflags,
-    size_t H5_ATTR_UNUSED p_size, const uint8_t *p)
+H5O__stab_decode(H5F_t *f, H5O_t H5_ATTR_UNUSED *open_oh, unsigned H5_ATTR_UNUSED mesg_flags,
+                 unsigned H5_ATTR_UNUSED *ioflags, size_t H5_ATTR_UNUSED p_size, const uint8_t *p)
 {
-    H5O_stab_t          *stab = NULL;
-    void                *ret_value = NULL;     /* Return value */
+    H5O_stab_t *stab      = NULL;
+    void *      ret_value = NULL; /* Return value */
 
-    FUNC_ENTER_NOAPI_NOINIT
+    FUNC_ENTER_PACKAGE
 
     /* check args */
     HDassert(f);
     HDassert(p);
 
     /* decode */
-    if(NULL == (stab = H5FL_CALLOC(H5O_stab_t)))
+    if (NULL == (stab = H5FL_CALLOC(H5O_stab_t)))
         HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed")
     H5F_addr_decode(f, &p, &(stab->btree_addr));
     H5F_addr_decode(f, &p, &(stab->heap_addr));
@@ -119,15 +111,13 @@ H5O__stab_decode(H5F_t *f, H5O_t H5_ATTR_UNUSED *open_oh,
     ret_value = stab;
 
 done:
-    if(ret_value == NULL) {
-        if(stab != NULL)
+    if (ret_value == NULL)
+        if (stab != NULL)
             stab = H5FL_FREE(H5O_stab_t, stab);
-    } /* end if */
 
     FUNC_LEAVE_NOAPI(ret_value)
 } /* end H5O__stab_decode() */
 
-
 /*-------------------------------------------------------------------------
  * Function:    H5O__stab_encode
  *
@@ -136,7 +126,6 @@ done:
  * Return:      Non-negative on success/Negative on failure
  *
  * Programmer:  Robb Matzke
- *              matzke@llnl.gov
  *              Aug  6 1997
  *
  *-------------------------------------------------------------------------
@@ -144,9 +133,9 @@ done:
 static herr_t
 H5O__stab_encode(H5F_t *f, hbool_t H5_ATTR_UNUSED disable_shared, uint8_t *p, const void *_mesg)
 {
-    const H5O_stab_t       *stab = (const H5O_stab_t *) _mesg;
+    const H5O_stab_t *stab = (const H5O_stab_t *)_mesg;
 
-    FUNC_ENTER_STATIC_NOERR
+    FUNC_ENTER_PACKAGE_NOERR
 
     /* check args */
     HDassert(f);
@@ -160,7 +149,6 @@ H5O__stab_encode(H5F_t *f, hbool_t H5_ATTR_UNUSED disable_shared, uint8_t *p, co
     FUNC_LEAVE_NOAPI(SUCCEED)
 } /* end H5O__stab_encode() */
 
-
 /*-------------------------------------------------------------------------
  * Function:    H5O__stab_copy
  *
@@ -172,7 +160,6 @@ H5O__stab_encode(H5F_t *f, hbool_t H5_ATTR_UNUSED disable_shared, uint8_t *p, co
  *              Failure:        NULL
  *
  * Programmer:  Robb Matzke
- *              matzke@llnl.gov
  *              Aug  6 1997
  *
  *-------------------------------------------------------------------------
@@ -180,16 +167,16 @@ H5O__stab_encode(H5F_t *f, hbool_t H5_ATTR_UNUSED disable_shared, uint8_t *p, co
 static void *
 H5O__stab_copy(const void *_mesg, void *_dest)
 {
-    const H5O_stab_t    *stab = (const H5O_stab_t *) _mesg;
-    H5O_stab_t          *dest = (H5O_stab_t *) _dest;
-    void                *ret_value = NULL;     /* Return value */
+    const H5O_stab_t *stab      = (const H5O_stab_t *)_mesg;
+    H5O_stab_t *      dest      = (H5O_stab_t *)_dest;
+    void *            ret_value = NULL; /* Return value */
 
-    FUNC_ENTER_STATIC
+    FUNC_ENTER_PACKAGE
 
     /* check args */
     HDassert(stab);
-    if(!dest && NULL == (dest = H5FL_MALLOC(H5O_stab_t)))
-        HGOTO_ERROR (H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed");
+    if (!dest && NULL == (dest = H5FL_MALLOC(H5O_stab_t)))
+        HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed");
 
     /* copy */
     *dest = *stab;
@@ -201,7 +188,6 @@ done:
     FUNC_LEAVE_NOAPI(ret_value)
 } /* end H5O__stab_copy() */
 
-
 /*-------------------------------------------------------------------------
  * Function:    H5O__stab_size
  *
@@ -214,7 +200,6 @@ done:
  *              Failure:        zero
  *
  * Programmer:  Robb Matzke
- *              matzke@llnl.gov
  *              Aug  6 1997
  *
  *-------------------------------------------------------------------------
@@ -222,9 +207,9 @@ done:
 static size_t
 H5O__stab_size(const H5F_t *f, hbool_t H5_ATTR_UNUSED disable_shared, const void H5_ATTR_UNUSED *_mesg)
 {
-    size_t ret_value = 0;       /* Return value */
+    size_t ret_value = 0; /* Return value */
 
-    FUNC_ENTER_STATIC_NOERR
+    FUNC_ENTER_PACKAGE_NOERR
 
     /* Set return value */
     ret_value = (size_t)(2 * H5F_SIZEOF_ADDR(f));
@@ -232,7 +217,6 @@ H5O__stab_size(const H5F_t *f, hbool_t H5_ATTR_UNUSED disable_shared, const void
     FUNC_LEAVE_NOAPI(ret_value)
 } /* end H5O__stab_size() */
 
-
 /*-------------------------------------------------------------------------
  * Function:	H5O__stab_free
  *
@@ -248,7 +232,7 @@ H5O__stab_size(const H5F_t *f, hbool_t H5_ATTR_UNUSED disable_shared, const void
 static herr_t
 H5O__stab_free(void *mesg)
 {
-    FUNC_ENTER_STATIC_NOERR
+    FUNC_ENTER_PACKAGE_NOERR
 
     HDassert(mesg);
 
@@ -257,7 +241,6 @@ H5O__stab_free(void *mesg)
     FUNC_LEAVE_NOAPI(SUCCEED)
 } /* end H5O__stab_free() */
 
-
 /*-------------------------------------------------------------------------
  * Function:    H5O__stab_delete
  *
@@ -273,23 +256,22 @@ H5O__stab_free(void *mesg)
 static herr_t
 H5O__stab_delete(H5F_t *f, H5O_t H5_ATTR_UNUSED *open_oh, void *mesg)
 {
-    herr_t ret_value = SUCCEED;   /* Return value */
+    herr_t ret_value = SUCCEED; /* Return value */
 
-    FUNC_ENTER_STATIC
+    FUNC_ENTER_PACKAGE
 
     /* check args */
     HDassert(f);
     HDassert(mesg);
 
     /* Free the file space for the symbol table */
-    if(H5G__stab_delete(f, (const H5O_stab_t *)mesg) < 0)
+    if (H5G__stab_delete(f, (const H5O_stab_t *)mesg) < 0)
         HGOTO_ERROR(H5E_OHDR, H5E_CANTFREE, FAIL, "unable to free symbol table")
 
 done:
     FUNC_LEAVE_NOAPI(ret_value)
 } /* end H5O__stab_delete() */
 
-
 /*-------------------------------------------------------------------------
  * Function:    H5O__stab_copy_file
  *
@@ -306,56 +288,55 @@ done:
  */
 static void *
 H5O__stab_copy_file(H5F_t *file_src, void *native_src, H5F_t *file_dst,
-    hbool_t H5_ATTR_UNUSED *recompute_size, unsigned H5_ATTR_UNUSED *mesg_flags,
-    H5O_copy_t H5_ATTR_UNUSED *cpy_info, void *_udata)
+                    hbool_t H5_ATTR_UNUSED *recompute_size, unsigned H5_ATTR_UNUSED *mesg_flags,
+                    H5O_copy_t H5_ATTR_UNUSED *cpy_info, void *_udata)
 {
-    H5O_stab_t          *stab_src = (H5O_stab_t *) native_src;
-    H5O_stab_t          *stab_dst = NULL;
-    H5G_copy_file_ud_t  *udata = (H5G_copy_file_ud_t *)_udata;
-    size_t              size_hint;             /* Local heap initial size */
-    void                *ret_value = NULL;     /* Return value */
+    H5O_stab_t *        stab_src = (H5O_stab_t *)native_src;
+    H5O_stab_t *        stab_dst = NULL;
+    H5G_copy_file_ud_t *udata    = (H5G_copy_file_ud_t *)_udata;
+    size_t              size_hint;        /* Local heap initial size */
+    void *              ret_value = NULL; /* Return value */
 
-    FUNC_ENTER_STATIC
+    FUNC_ENTER_PACKAGE
 
     /* check args */
     HDassert(stab_src);
     HDassert(file_dst);
 
     /* Allocate space for the destination stab */
-    if(NULL == (stab_dst = H5FL_MALLOC(H5O_stab_t)))
-        HGOTO_ERROR (H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed")
+    if (NULL == (stab_dst = H5FL_MALLOC(H5O_stab_t)))
+        HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed")
 
     /* Get the old local heap's size and use that as the hint for the new heap */
-    if(H5HL_get_size(file_src, stab_src->heap_addr, &size_hint) < 0)
+    if (H5HL_get_size(file_src, stab_src->heap_addr, &size_hint) < 0)
         HGOTO_ERROR(H5E_SYM, H5E_CANTGETSIZE, NULL, "can't query local heap size")
 
     /* Set copy metadata tag */
     H5_BEGIN_TAG(H5AC__COPIED_TAG);
 
     /* Create components of symbol table message */
-    if(H5G__stab_create_components(file_dst, stab_dst, size_hint) < 0)
+    if (H5G__stab_create_components(file_dst, stab_dst, size_hint) < 0)
         HGOTO_ERROR_TAG(H5E_SYM, H5E_CANTINIT, NULL, "can't create symbol table components")
 
     /* Reset metadata tag */
     H5_END_TAG
 
     /* Cache stab in udata */
-    udata->cache_type = H5G_CACHED_STAB;
+    udata->cache_type            = H5G_CACHED_STAB;
     udata->cache.stab.btree_addr = stab_dst->btree_addr;
-    udata->cache.stab.heap_addr = stab_dst->heap_addr;
+    udata->cache.stab.heap_addr  = stab_dst->heap_addr;
 
     /* Set return value */
     ret_value = stab_dst;
 
 done:
-    if(!ret_value)
-        if(stab_dst)
+    if (!ret_value)
+        if (stab_dst)
             stab_dst = H5FL_FREE(H5O_stab_t, stab_dst);
 
     FUNC_LEAVE_NOAPI(ret_value)
 } /* H5O__stab_copy_file() */
 
-
 /*-------------------------------------------------------------------------
  * Function:    H5O__stab_post_copy_file
  *
@@ -369,16 +350,15 @@ done:
  *-------------------------------------------------------------------------
  */
 static herr_t
-H5O__stab_post_copy_file(const H5O_loc_t *src_oloc, const void *mesg_src,
-    H5O_loc_t *dst_oloc, void *mesg_dst, unsigned H5_ATTR_UNUSED *mesg_flags,
-    H5O_copy_t *cpy_info)
+H5O__stab_post_copy_file(const H5O_loc_t *src_oloc, const void *mesg_src, H5O_loc_t *dst_oloc, void *mesg_dst,
+                         unsigned H5_ATTR_UNUSED *mesg_flags, H5O_copy_t *cpy_info)
 {
-    const H5O_stab_t    *stab_src = (const H5O_stab_t *)mesg_src;
-    H5O_stab_t          *stab_dst = (H5O_stab_t *)mesg_dst;
-    H5G_bt_it_cpy_t     udata;      /* B-tree user data */
-    herr_t ret_value = SUCCEED;   /* Return value */
+    const H5O_stab_t *stab_src = (const H5O_stab_t *)mesg_src;
+    H5O_stab_t *      stab_dst = (H5O_stab_t *)mesg_dst;
+    H5G_bt_it_cpy_t   udata;               /* B-tree user data */
+    herr_t            ret_value = SUCCEED; /* Return value */
 
-    FUNC_ENTER_STATIC
+    FUNC_ENTER_PACKAGE
 
     /* check args */
     HDassert(stab_src);
@@ -388,25 +368,24 @@ H5O__stab_post_copy_file(const H5O_loc_t *src_oloc, const void *mesg_src,
     HDassert(cpy_info);
 
     /* If we are performing a 'shallow hierarchy' copy, get out now */
-    if(cpy_info->max_depth >= 0 && cpy_info->curr_depth >= cpy_info->max_depth)
+    if (cpy_info->max_depth >= 0 && cpy_info->curr_depth >= cpy_info->max_depth)
         HGOTO_DONE(SUCCEED)
 
     /* Set up B-tree iteration user data */
-    udata.src_oloc = src_oloc;
+    udata.src_oloc      = src_oloc;
     udata.src_heap_addr = stab_src->heap_addr;
-    udata.dst_file = dst_oloc->file;
-    udata.dst_stab = stab_dst;
-    udata.cpy_info = cpy_info;
+    udata.dst_file      = dst_oloc->file;
+    udata.dst_stab      = stab_dst;
+    udata.cpy_info      = cpy_info;
 
     /* Iterate over objects in group, copying them */
-    if((H5B_iterate(src_oloc->file, H5B_SNODE, stab_src->btree_addr, H5G__node_copy, &udata)) < 0)
+    if ((H5B_iterate(src_oloc->file, H5B_SNODE, stab_src->btree_addr, H5G__node_copy, &udata)) < 0)
         HGOTO_ERROR(H5E_SYM, H5E_CANTINIT, FAIL, "iteration operator failed")
 
 done:
     FUNC_LEAVE_NOAPI(ret_value)
 } /* H5O__stab_post_copy_file() */
 
-
 /*-------------------------------------------------------------------------
  * Function:    H5O__stab_debug
  *
@@ -415,20 +394,16 @@ done:
  * Return:      Non-negative on success/Negative on failure
  *
  * Programmer:  Robb Matzke
- *              matzke@llnl.gov
  *              Aug  6 1997
  *
- * Modifications:
- *
  *-------------------------------------------------------------------------
  */
 static herr_t
-H5O__stab_debug(H5F_t H5_ATTR_UNUSED *f, const void *_mesg, FILE * stream,
-    int indent, int fwidth)
+H5O__stab_debug(H5F_t H5_ATTR_UNUSED *f, const void *_mesg, FILE *stream, int indent, int fwidth)
 {
-    const H5O_stab_t       *stab = (const H5O_stab_t *) _mesg;
+    const H5O_stab_t *stab = (const H5O_stab_t *)_mesg;
 
-    FUNC_ENTER_STATIC_NOERR
+    FUNC_ENTER_PACKAGE_NOERR
 
     /* check args */
     HDassert(f);
@@ -437,12 +412,9 @@ H5O__stab_debug(H5F_t H5_ATTR_UNUSED *f, const void *_mesg, FILE * stream,
     HDassert(indent >= 0);
     HDassert(fwidth >= 0);
 
-    HDfprintf(stream, "%*s%-*s %a\n", indent, "", fwidth,
-	      "B-tree address:", stab->btree_addr);
+    HDfprintf(stream, "%*s%-*s %" PRIuHADDR "\n", indent, "", fwidth, "B-tree address:", stab->btree_addr);
 
-    HDfprintf(stream, "%*s%-*s %a\n", indent, "", fwidth,
-	      "Name heap address:", stab->heap_addr);
+    HDfprintf(stream, "%*s%-*s %" PRIuHADDR "\n", indent, "", fwidth, "Name heap address:", stab->heap_addr);
 
     FUNC_LEAVE_NOAPI(SUCCEED)
 } /* end H5O__stab_debug() */
-