Normalization of H5S package with develop

1 files changed, 73 insertions, 36 deletions

diff --git a/src/H5Sall.c b/src/H5Sall.c
index 8262f9b..da466d0 100644
--- a/src/H5Sall.c
+++ b/src/H5Sall.c
@@ -18,16 +18,36 @@
  * Purpose:	"All" selection dataspace I/O functions.
  */
 
+/****************/
+/* Module Setup */
+/****************/
+
 #include "H5Smodule.h"          /* This source code file is part of the H5S module */
 
 
-#include "H5private.h"		/* Generic Functions			*/
-#include "H5Eprivate.h"		/* Error handling		        */
-#include "H5Iprivate.h"		/* ID Functions		                */
-#include "H5Spkg.h"		/* Dataspace functions			*/
-#include "H5VMprivate.h"         /* Vector functions                     */
+/***********/
+/* Headers */
+/***********/
+#include "H5private.h"          /* Generic Functions                        */
+#include "H5Eprivate.h"         /* Error handling                           */
+#include "H5Iprivate.h"         /* ID Functions                             */
+#include "H5Spkg.h"             /* Dataspace functions                      */
+#include "H5VMprivate.h"        /* Vector functions                         */
+
+
+/****************/
+/* Local Macros */
+/****************/
+
 
-/* Static function prototypes */
+/******************/
+/* Local Typedefs */
+/******************/
+
+
+/********************/
+/* Local Prototypes */
+/********************/
 
 /* Selection callbacks */
 static herr_t H5S__all_copy(H5S_t *dst, const H5S_t *src, hbool_t share_selection);
@@ -59,6 +79,16 @@ static herr_t H5S__all_iter_next(H5S_sel_iter_t *sel_iter, size_t nelem);
 static herr_t H5S__all_iter_next_block(H5S_sel_iter_t *sel_iter);
 static herr_t H5S__all_iter_release(H5S_sel_iter_t *sel_iter);
 
+
+/*****************************/
+/* Library Private Variables */
+/*****************************/
+
+
+/*********************/
+/* Package Variables */
+/*********************/
+
 /* Selection properties for "all" selections */
 const H5S_select_class_t H5S_sel_all[1] = {{
     H5S_SEL_ALL,
@@ -84,6 +114,11 @@ const H5S_select_class_t H5S_sel_all[1] = {{
     H5S__all_iter_init,
 }};
 
+
+/*******************/
+/* Local Variables */
+/*******************/
+
 /* Iteration properties for "all" selections */
 static const H5S_sel_iter_class_t H5S_sel_iter_all[1] = {{
     H5S_SEL_ALL,
@@ -98,13 +133,14 @@ static const H5S_sel_iter_class_t H5S_sel_iter_all[1] = {{
     H5S__all_iter_release,
 }};
 
+
 
 /*-------------------------------------------------------------------------
  * Function:	H5S__all_iter_init
  *
  * Purpose:	Initializes iteration information for "all" selection.
  *
- * Return:	non-negative on success, negative on failure.
+ * Return:	Non-negative on success, negative on failure.
  *
  * Programmer:	Quincey Koziol
  *              Tuesday, June 16, 1998
@@ -131,7 +167,7 @@ H5S__all_iter_init(H5S_sel_iter_t *iter, const H5S_t *space)
     iter->type = H5S_sel_iter_all;
 
     FUNC_LEAVE_NOAPI(SUCCEED)
-}   /* H5S__all_iter_init() */
+} /* end H5S__all_iter_init() */
 
 
 /*-------------------------------------------------------------------------
@@ -140,7 +176,7 @@ H5S__all_iter_init(H5S_sel_iter_t *iter, const H5S_t *space)
  * Purpose:	Retrieve the current coordinates of iterator for current
  *              selection
  *
- * Return:	non-negative on success, negative on failure
+ * Return:	Non-negative on success, negative on failure
  *
  * Programmer:	Quincey Koziol
  *              Tuesday, April 22, 2003
@@ -164,7 +200,7 @@ H5S__all_iter_coords(const H5S_sel_iter_t *iter, hsize_t *coords)
 
 done:
     FUNC_LEAVE_NOAPI(ret_value)
-}   /* H5S__all_iter_coords() */
+} /* end H5S__all_iter_coords() */
 
 
 /*-------------------------------------------------------------------------
@@ -173,7 +209,7 @@ done:
  * Purpose:	Retrieve the current block of iterator for current
  *              selection
  *
- * Return:	non-negative on success, negative on failure
+ * Return:	Non-negative on success, negative on failure
  *
  * Programmer:	Quincey Koziol
  *              Monday, June 2, 2003
@@ -203,7 +239,7 @@ H5S__all_iter_block(const H5S_sel_iter_t *iter, hsize_t *start, hsize_t *end)
     } /* end for */
 
     FUNC_LEAVE_NOAPI(SUCCEED)
-}   /* H5S__all_iter_block() */
+} /* end H5S__all_iter_block() */
 
 
 /*-------------------------------------------------------------------------
@@ -211,7 +247,7 @@ H5S__all_iter_block(const H5S_sel_iter_t *iter, hsize_t *start, hsize_t *end)
  *
  * Purpose:	Return number of elements left to process in iterator
  *
- * Return:	non-negative number of elements on success, zero on failure
+ * Return:	Non-negative number of elements on success, zero on failure
  *
  * Programmer:	Quincey Koziol
  *              Tuesday, June 16, 1998
@@ -227,7 +263,7 @@ H5S__all_iter_nelmts(const H5S_sel_iter_t *iter)
     HDassert(iter);
 
     FUNC_LEAVE_NOAPI(iter->elmt_left)
-}   /* H5S__all_iter_nelmts() */
+} /* end H5S__all_iter_nelmts() */
 
 
 /*--------------------------------------------------------------------------
@@ -256,7 +292,7 @@ H5S__all_iter_has_next_block(const H5S_sel_iter_t H5_ATTR_UNUSED *iter)
     HDassert(iter);
 
     FUNC_LEAVE_NOAPI(FALSE)
-}   /* H5S__all_iter_has_next_block() */
+} /* end H5S__all_iter_has_next_block() */
 
 
 /*--------------------------------------------------------------------------
@@ -291,7 +327,7 @@ H5S__all_iter_next(H5S_sel_iter_t *iter, size_t nelem)
     iter->u.all.byte_offset += (nelem * iter->elmt_size);
 
     FUNC_LEAVE_NOAPI(SUCCEED)
-}   /* H5S__all_iter_next() */
+} /* end H5S__all_iter_next() */
 
 
 /*--------------------------------------------------------------------------
@@ -320,7 +356,7 @@ H5S__all_iter_next_block(H5S_sel_iter_t H5_ATTR_UNUSED *iter)
     HDassert(iter);
 
     FUNC_LEAVE_NOAPI(FAIL)
-}   /* H5S__all_iter_next_block() */
+} /* end H5S__all_iter_next_block() */
 
 
 /*--------------------------------------------------------------------------
@@ -349,7 +385,7 @@ H5S__all_iter_release(H5S_sel_iter_t H5_ATTR_UNUSED * iter)
     HDassert(iter);
 
     FUNC_LEAVE_NOAPI(SUCCEED)
-}   /* H5S__all_iter_release() */
+} /* end H5S__all_iter_release() */
 
 
 /*--------------------------------------------------------------------------
@@ -381,7 +417,7 @@ H5S__all_release(H5S_t *space)
     space->select.num_elem = 0;
 
     FUNC_LEAVE_NOAPI(SUCCEED)
-}   /* H5S__all_release() */
+} /* end H5S__all_release() */
 
 
 /*--------------------------------------------------------------------------
@@ -456,7 +492,7 @@ H5S__all_is_valid(const H5S_t H5_ATTR_UNUSED *space)
     Determine the number of bytes needed to store the serialized "all"
         selection information.
  USAGE
-    hssize_t H5S_all_serial_size(space)
+    hssize_t H5S__all_serial_size(space)
         H5S_t *space;             IN: Dataspace pointer to query
  RETURNS
     The number of bytes required on success, negative on an error.
@@ -469,7 +505,7 @@ H5S__all_is_valid(const H5S_t H5_ATTR_UNUSED *space)
  REVISION LOG
 --------------------------------------------------------------------------*/
 static hssize_t
-H5S__all_serial_size (const H5S_t H5_ATTR_UNUSED *space)
+H5S__all_serial_size(const H5S_t H5_ATTR_UNUSED *space)
 {
     FUNC_ENTER_STATIC_NOERR
 
@@ -526,7 +562,7 @@ H5S__all_serialize(const H5S_t *space, uint8_t **p)
     *p = pp;
 
     FUNC_LEAVE_NOAPI(SUCCEED)
-}   /* H5S__all_serialize() */
+} /* end H5S__all_serialize() */
 
 
 /*--------------------------------------------------------------------------
@@ -601,7 +637,7 @@ done:
             HDONE_ERROR(H5E_DATASPACE, H5E_CANTFREE, FAIL, "can't close dataspace")
 
     FUNC_LEAVE_NOAPI(ret_value)
-}   /* H5S__all_deserialize() */
+} /* end H5S__all_deserialize() */
 
 
 /*--------------------------------------------------------------------------
@@ -651,7 +687,7 @@ H5S__all_bounds(const H5S_t *space, hsize_t *start, hsize_t *end)
     } /* end for */
 
     FUNC_LEAVE_NOAPI(SUCCEED)
-}   /* H5S__all_bounds() */
+} /* end H5S__all_bounds() */
 
 
 /*--------------------------------------------------------------------------
@@ -686,7 +722,7 @@ H5S__all_offset(const H5S_t H5_ATTR_UNUSED *space, hsize_t *offset)
     *offset = 0;
 
     FUNC_LEAVE_NOAPI(SUCCEED)
-}   /* H5S__all_offset() */
+} /* end H5S__all_offset() */
 
 
 /*--------------------------------------------------------------------------
@@ -745,7 +781,7 @@ H5S__all_is_contiguous(const H5S_t H5_ATTR_UNUSED *space)
     HDassert(space);
 
     FUNC_LEAVE_NOAPI(TRUE)
-}   /* H5S__all_is_contiguous() */
+} /* end H5S__all_is_contiguous() */
 
 
 /*--------------------------------------------------------------------------
@@ -774,7 +810,7 @@ H5S__all_is_single(const H5S_t H5_ATTR_UNUSED *space)
     HDassert(space);
 
     FUNC_LEAVE_NOAPI(TRUE)
-}   /* H5S__all_is_single() */
+} /* end H5S__all_is_single() */
 
 
 /*--------------------------------------------------------------------------
@@ -805,7 +841,7 @@ H5S__all_is_regular(const H5S_t H5_ATTR_UNUSED *space)
     HDassert(space);
 
     FUNC_LEAVE_NOAPI(TRUE)
-}   /* H5S__all_is_regular() */
+} /* end H5S__all_is_regular() */
 
 
 /*--------------------------------------------------------------------------
@@ -836,7 +872,7 @@ H5S__all_adjust_u(H5S_t H5_ATTR_UNUSED *space, const hsize_t H5_ATTR_UNUSED *off
     HDassert(offset);
 
     FUNC_LEAVE_NOAPI_VOID
-}   /* H5S__all_adjust_u() */
+} /* end H5S__all_adjust_u() */
 
 
 /*-------------------------------------------------------------------------
@@ -845,7 +881,7 @@ H5S__all_adjust_u(H5S_t H5_ATTR_UNUSED *space, const hsize_t H5_ATTR_UNUSED *off
  * Purpose:	Projects a single element 'all' selection into a scalar
  *              dataspace
  *
- * Return:	non-negative on success, negative on failure.
+ * Return:	Non-negative on success, negative on failure.
  *
  * Programmer:	Quincey Koziol
  *              Sunday, July 18, 2010
@@ -865,7 +901,7 @@ H5S__all_project_scalar(const H5S_t H5_ATTR_UNUSED *space, hsize_t *offset)
     *offset = 0;
 
     FUNC_LEAVE_NOAPI(SUCCEED)
-}   /* H5S__all_project_scalar() */
+} /* end H5S__all_project_scalar() */
 
 
 /*-------------------------------------------------------------------------
@@ -874,7 +910,7 @@ H5S__all_project_scalar(const H5S_t H5_ATTR_UNUSED *space, hsize_t *offset)
  * Purpose:	Projects an 'all' selection onto/into a simple dataspace
  *              of a different rank
  *
- * Return:	non-negative on success, negative on failure.
+ * Return:	Non-negative on success, negative on failure.
  *
  * Programmer:	Quincey Koziol
  *              Sunday, July 18, 2010
@@ -882,7 +918,8 @@ H5S__all_project_scalar(const H5S_t H5_ATTR_UNUSED *space, hsize_t *offset)
  *-------------------------------------------------------------------------
  */
 static herr_t
-H5S__all_project_simple(const H5S_t *base_space, H5S_t *new_space, hsize_t *offset)
+H5S__all_project_simple(const H5S_t H5_ATTR_UNUSED *base_space,
+    H5S_t *new_space, hsize_t H5_ATTR_UNUSED *offset)
 {
     herr_t ret_value = SUCCEED;         /* Return value */
 
@@ -899,7 +936,7 @@ H5S__all_project_simple(const H5S_t *base_space, H5S_t *new_space, hsize_t *offs
 
 done:
     FUNC_LEAVE_NOAPI(ret_value)
-}   /* H5S__all_project_simple() */
+} /* end H5S__all_project_simple() */
 
 
 /*--------------------------------------------------------------------------
@@ -943,7 +980,7 @@ H5S_select_all(H5S_t *space, hbool_t rel_prev)
 
 done:
     FUNC_LEAVE_NOAPI(ret_value)
-}   /* H5S_select_all() */
+} /* end H5S_select_all() */
 
 
 /*--------------------------------------------------------------------------
@@ -982,7 +1019,7 @@ H5Sselect_all(hid_t spaceid)
 
 done:
     FUNC_LEAVE_API(ret_value)
-}   /* H5Sselect_all() */
+} /* end H5Sselect_all() */
 
 
 /*--------------------------------------------------------------------------