Split internal H5R functionality into H5Rint.c.

1 files changed, 53 insertions, 65 deletions

diff --git a/src/H5Rdeprec.c b/src/H5Rdeprec.c
index 109bbb4..699f8df 100644
--- a/src/H5Rdeprec.c
+++ b/src/H5Rdeprec.c
@@ -13,11 +13,9 @@
 
 /*-------------------------------------------------------------------------
  *
- * Created:	H5Rdeprec.c
- *		September 13 2007
- *		Quincey Koziol <koziol@hdfgroup.org>
+ * Created:     H5Rdeprec.c
  *
- * Purpose:	Deprecated functions from the H5R interface.  These
+ * Purpose:     Deprecated functions from the H5R interface.  These
  *              functions are here for compatibility purposes and may be
  *              removed in the future.  Applications should switch to the
  *              newer APIs.
@@ -35,13 +33,16 @@
 /***********/
 /* Headers */
 /***********/
-#include "H5private.h"		/* Generic Functions			*/
-#include "H5ACprivate.h"	/* Metadata cache			*/
-#include "H5Eprivate.h"		/* Error handling		  	*/
-#include "H5Gprivate.h"		/* Groups				*/
-#include "H5Oprivate.h"		/* Object headers		  	*/
-#include "H5Rpkg.h"		/* References				*/
-#include "H5Ppublic.h"          /* for using H5P_DATASET_ACCESS_DEFAULT */
+/* Public headers needed by this file */
+#include "H5Ppublic.h"          /* Property lists                           */
+
+/* Private headers needed by this file */
+#include "H5private.h"		    /* Generic Functions                        */
+#include "H5ACprivate.h"	    /* Metadata cache                           */
+#include "H5Eprivate.h"		    /* Error handling                           */
+#include "H5Gprivate.h"		    /* Groups                                   */
+#include "H5Oprivate.h"		    /* Object headers                           */
+#include "H5Rpkg.h"             /* References                               */
 
 
 /****************/
@@ -81,29 +82,22 @@
 
 #ifndef H5_NO_DEPRECATED_SYMBOLS
 
-/*--------------------------------------------------------------------------
- NAME
-    H5Rget_obj_type1
- PURPOSE
-    Retrieves the type of object that an object reference points to
- USAGE
-    H5G_obj_t H5Rget_obj_type1(id, ref_type, ref)
-        hid_t id;       IN: Dataset reference object is in or location ID of
-                            object that the dataset is located within.
-        H5R_type_t ref_type;    IN: Type of reference to query
-        void *ref;          IN: Reference to query.
-
- RETURNS
-    Success:	An object type defined in H5Gpublic.h
-    Failure:	H5G_UNKNOWN
- DESCRIPTION
-    Given a reference to some object, this function returns the type of object
-    pointed to.
- GLOBAL VARIABLES
- COMMENTS, BUGS, ASSUMPTIONS
- EXAMPLES
- REVISION LOG
---------------------------------------------------------------------------*/
+/*-------------------------------------------------------------------------
+ * Function:    H5Rget_obj_type1
+ *
+ * Purpose:     Retrieves the type of the object that an object points to.
+ *
+ * Parameters:
+ *      id          IN: Dataset reference object is in or location ID of
+ *                      object that the dataset is located within
+ *      ref_type    IN: Type of reference to query
+ *      ref         IN: Reference to query
+ *
+ * Return:      Success:	An object type (as defined in H5Gpublic.h)
+ *              Failure:    H5G_UNKNOWN
+ *
+ *-------------------------------------------------------------------------
+ */
 H5G_obj_t
 H5Rget_obj_type1(hid_t id, H5R_type_t ref_type, const void *ref)
 {
@@ -115,16 +109,16 @@ H5Rget_obj_type1(hid_t id, H5R_type_t ref_type, const void *ref)
     H5TRACE3("Go", "iRt*x", id, ref_type, ref);
 
     /* Check args */
-    if(H5G_loc(id, &loc) < 0)
+    if (H5G_loc(id, &loc) < 0)
         HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, H5G_UNKNOWN, "not a location")
-    if(ref_type <= H5R_BADTYPE || ref_type >= H5R_MAXTYPE)
+    if (ref_type <= H5R_BADTYPE || ref_type >= H5R_MAXTYPE)
         HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, H5G_UNKNOWN, "invalid reference type")
-    if(ref == NULL)
+    if (ref == NULL)
         HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, H5G_UNKNOWN, "invalid reference pointer")
 
     /* Get the object information */
-    if(H5R_get_obj_type(loc.oloc->file, H5AC_ind_read_dxpl_id, ref_type, ref, &obj_type) < 0)
-	HGOTO_ERROR(H5E_REFERENCE, H5E_CANTINIT, H5G_UNKNOWN, "unable to determine object type")
+    if (H5R_get_obj_type(loc.oloc->file, H5AC_ind_read_dxpl_id, ref_type, ref, &obj_type) < 0)
+        HGOTO_ERROR(H5E_REFERENCE, H5E_CANTINIT, H5G_UNKNOWN, "unable to determine object type")
 
     /* Set return value */
     ret_value = H5G_map_obj_type(obj_type);
@@ -134,28 +128,22 @@ done:
 }   /* end H5Rget_obj_type1() */
 
 
-/*--------------------------------------------------------------------------
- NAME
-    H5Rdereference1
- PURPOSE
-    Opens the HDF5 object referenced.
- USAGE
-    hid_t H5Rdereference1(ref)
-        hid_t id;       IN: Dataset reference object is in or location ID of
-                            object that the dataset is located within.
-        H5R_type_t ref_type;    IN: Type of reference to create
-        void *ref;      IN: Reference to open.
-
- RETURNS
-    Valid ID on success, Negative on failure
- DESCRIPTION
-    Given a reference to some object, open that object and return an ID for
-    that object.
- GLOBAL VARIABLES
- COMMENTS, BUGS, ASSUMPTIONS
- EXAMPLES
- REVISION LOG
---------------------------------------------------------------------------*/
+/*-------------------------------------------------------------------------
+ * Function:    H5Rdereference1
+ *
+ * Purpose:     Opens the HDF5 object referenced.
+ *
+ * Parameters:
+ *      id          IN: Dataset reference object is in or location ID of
+ *                      object that the dataset is located within
+ *      ref_type    IN: Type of reference to create
+ *      ref         IN: Reference to open
+ *
+ * Return:      Success:	Valid HDF5 ID
+ *              Failure:    Negative
+ *
+ *-------------------------------------------------------------------------
+ */
 hid_t
 H5Rdereference1(hid_t obj_id, H5R_type_t ref_type, const void *_ref)
 {
@@ -167,18 +155,18 @@ H5Rdereference1(hid_t obj_id, H5R_type_t ref_type, const void *_ref)
     H5TRACE3("i", "iRt*x", obj_id, ref_type, _ref);
 
     /* Check args */
-    if(H5G_loc(obj_id, &loc) < 0)
+    if (H5G_loc(obj_id, &loc) < 0)
         HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a location")
-    if(ref_type <= H5R_BADTYPE || ref_type >= H5R_MAXTYPE)
+    if (ref_type <= H5R_BADTYPE || ref_type >= H5R_MAXTYPE)
         HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid reference type")
-    if(_ref == NULL)
+    if (_ref == NULL)
         HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid reference pointer")
 
     /* Get the file pointer from the entry */
     file = loc.oloc->file;
 
     /* Create reference */
-    if((ret_value = H5R_dereference(file, H5P_DATASET_ACCESS_DEFAULT, H5AC_ind_read_dxpl_id, ref_type, _ref, TRUE)) < 0)
+    if ((ret_value = H5R_dereference(file, H5P_DATASET_ACCESS_DEFAULT, H5AC_ind_read_dxpl_id, ref_type, _ref, TRUE)) < 0)
         HGOTO_ERROR(H5E_REFERENCE, H5E_CANTINIT, FAIL, "unable dereference object")
 
 done: