[svn-r12832] Description:

    Clean up formatting and re-organize a bit...

Tested on:
    Max OS X/32 10.4.8 (amazon)
    FreeBSD/32 4.11 (sleipnir)
    Linux/32 2.4 (heping)
    Linux/64 2.4 (mir)

1 files changed, 70 insertions, 43 deletions

diff --git a/src/H5Gpublic.h b/src/H5Gpublic.h
index e6851f4..ada6ca8 100644
--- a/src/H5Gpublic.h
+++ b/src/H5Gpublic.h
@@ -18,27 +18,56 @@
  *                      Jul 11 1997
  *                      Robb Matzke <matzke@llnl.gov>
  *
- * Purpose:             Public declarations for the H5G package (symbol
- *                      tables).
+ * Purpose:             Public declarations for the H5G package
  *
  *-------------------------------------------------------------------------
  */
 #ifndef _H5Gpublic_H
 #define _H5Gpublic_H
 
-/* Public headers needed by this file */
+/* System headers needed by this file */
 #include <sys/types.h>
 
+/* Public headers needed by this file */
 #include "H5public.h"
 #include "H5Ipublic.h"
 #include "H5Lpublic.h"
 #include "H5Opublic.h"
 #include "H5Tpublic.h"
 
+/*****************/
+/* Public Macros */
+/*****************/
+
+/* Macros for types of objects in a group (see H5G_obj_t definition) */
+#define H5G_NTYPES	256		/* Max possible number of types	*/
+#define H5G_NLIBTYPES	8		/* Number of internal types	*/
+#define H5G_NUSERTYPES	(H5G_NTYPES-H5G_NLIBTYPES)
+#define H5G_USERTYPE(X)	(8+(X))		/* User defined types		*/
+
+/* Flags for object copy (H5Gcopy) */
+#define H5G_COPY_SHALLOW_HIERARCHY_FLAG (0x0001u)   /* Copy only immediate members */
+#define H5G_COPY_EXPAND_SOFT_LINK_FLAG  (0x0002u)   /* Expand soft links into new objects */
+#define H5G_COPY_EXPAND_EXT_LINK_FLAG   (0x0004u)   /* Expand external links into new objects */
+#define H5G_COPY_EXPAND_REFERENCE_FLAG	(0x0008u)   /* Copy objects that are pointed by references */
+#define H5G_COPY_WITHOUT_ATTR_FLAG      (0x0010u)   /* Copy object without copying attributes */
+#define H5G_COPY_ALL                    (0x001Fu)   /* All object copying flags (for internal checking) */
+
+/* Deprecated macros, for backward compatibility */
+#define H5G_LINK_ERROR H5L_TYPE_ERROR
+#define H5G_LINK_HARD H5L_TYPE_HARD
+#define H5G_LINK_SOFT H5L_TYPE_SOFT
+#define H5G_link_t H5L_type_t
+#define H5G_SAME_LOC H5L_SAME_LOC
+
 #ifdef __cplusplus
 extern "C" {
 #endif
 
+/*******************/
+/* Public Typedefs */
+/*******************/
+
 /*
  * An object has a certain type. The first few numbers are reserved for use
  * internally by HDF5. Users may add their own types with higher values.  The
@@ -58,11 +87,6 @@ typedef enum H5G_obj_t {
     H5G_RESERVED_7		/* Reserved for future use	*/
 } H5G_obj_t;
 
-#define H5G_NTYPES	256		/* Max possible number of types	*/
-#define H5G_NLIBTYPES	8		/* Number of internal types	*/
-#define H5G_NUSERTYPES	(H5G_NTYPES-H5G_NLIBTYPES)
-#define H5G_USERTYPE(X)	(8+(X))		/* User defined types		*/
-
 /* Information about an object */
 typedef struct H5G_stat_t {
     unsigned long 	fileno[2];	/*file number			*/
@@ -74,63 +98,66 @@ typedef struct H5G_stat_t {
     H5O_stat_t          ohdr;           /* Object header information    */
 } H5G_stat_t;
 
-typedef herr_t (*H5G_iterate_t)(hid_t group, const char *name,
-				void *op_data);
+/* Prototype for H5Giterate() operator */
+typedef herr_t (*H5G_iterate_t)(hid_t group, const char *name, void *op_data);
+
+/*
+ * The types of indices on links in groups.  Primarily used for "<do> <foo> by
+ * index" routines and for iterating over links in groups.
+ */
+typedef enum H5G_index_t {
+    H5G_INDEX_UNKNOWN = -1,	/* Unknown index type			*/
+    H5G_INDEX_NAME,		/* Index on names of links		*/
+    H5G_INDEX_CORDER,		/* Index on creation order of links	*/
+    H5G_INDEX_N			/* Number of indices defined on links in groups */
+} H5G_index_t;
+
+/********************/
+/* Public Variables */
+/********************/
 
-/* Flags for object copy (H5Gcopy) */
-#define H5G_COPY_SHALLOW_HIERARCHY_FLAG         (0x0002u)   /* Copy only immediate members */
-#define H5G_COPY_EXPAND_SOFT_LINK_FLAG          (0x0004u)   /* Expand soft links into new objects */
-#define H5G_COPY_EXPAND_EXT_LINK_FLAG           (0x0008u)   /* Expand external links into new objects */
-#define H5G_COPY_EXPAND_REFERENCE_FLAG      (0x0010u)   /* Copy objects that are pointed by references */
-#define H5G_COPY_WITHOUT_ATTR_FLAG              (0x0020u)   /* Copy object without copying attributes */
-#define H5G_COPY_ALL                            (0x003Fu)   /* All object copying flags (for internal checking) */
 
+/*********************/
+/* Public Prototypes */
+/*********************/
 H5_DLL hid_t H5Gcreate(hid_t loc_id, const char *name, size_t size_hint);
+H5_DLL hid_t H5Gcreate_expand(hid_t loc_id, hid_t gcpl_id, hid_t gapl_id);
 H5_DLL hid_t H5Gopen(hid_t loc_id, const char *name);
 H5_DLL hid_t H5Gopen_expand(hid_t loc_id, const char *name, hid_t gapl_id);
 H5_DLL herr_t H5Gclose(hid_t group_id);
 H5_DLL herr_t H5Giterate(hid_t loc_id, const char *name, int *idx,
-			  H5G_iterate_t op, void *op_data);
+        H5G_iterate_t op, void *op_data);
 H5_DLL herr_t H5Gget_num_objs(hid_t loc_id, hsize_t *num_objs);
 H5_DLL ssize_t H5Gget_objname_by_idx(hid_t loc_id, hsize_t idx, char* name, size_t size);
 H5_DLL H5G_obj_t H5Gget_objtype_by_idx(hid_t loc_id, hsize_t idx);
 H5_DLL herr_t H5Gget_objinfo(hid_t loc_id, const char *name,
-			      hbool_t follow_link, H5G_stat_t *statbuf/*out*/);
-H5_DLL herr_t H5Gset_comment(hid_t loc_id, const char *name,
-			      const char *comment);
+    hbool_t follow_link, H5G_stat_t *statbuf/*out*/);
+H5_DLL herr_t H5Gset_comment(hid_t loc_id, const char *name, const char *comment);
 H5_DLL int H5Gget_comment(hid_t loc_id, const char *name, size_t bufsize,
-			   char *buf);
-H5_DLL hid_t H5Gcreate_expand(hid_t loc_id, hid_t gcpl_id,
-    hid_t gapl_id);
+    char *buf);
 H5_DLL hid_t H5Gget_create_plist(hid_t group_id);
 H5_DLL herr_t H5Gcopy(hid_t src_loc_id, const char *src_name, hid_t dst_loc_id,
-        const char *dst_name, hid_t ocpypl_id, hid_t lcpl_id);
+    const char *dst_name, hid_t ocpypl_id, hid_t lcpl_id);
 
 /* Functions and variables defined for compatibility with previous versions
  * of the HDF5 API.
- * Use of these functions and variables is depreciated.
+ * 
+ * Use of these functions and variables is deprecated.
  */
-H5_DLL herr_t H5Glink(hid_t cur_loc_id, H5L_type_t type,
-               const char *cur_name, const char *new_name);
+H5_DLL herr_t H5Glink(hid_t cur_loc_id, H5L_type_t type, const char *cur_name,
+    const char *new_name);
 H5_DLL herr_t H5Gmove(hid_t src_loc_id, const char *src_name,
-                      const char *dst_name);
-H5_DLL herr_t H5Glink2(hid_t cur_loc_id, const char *cur_name,
-                   H5L_type_t type, hid_t new_loc_id, const char *new_name);
-H5_DLL herr_t H5Gmove2(hid_t src_loc_id, const char *src_name,
-                       hid_t dst_loc_id, const char *dst_name);
+    const char *dst_name);
+H5_DLL herr_t H5Glink2(hid_t cur_loc_id, const char *cur_name, H5L_type_t type,
+    hid_t new_loc_id, const char *new_name);
+H5_DLL herr_t H5Gmove2(hid_t src_loc_id, const char *src_name, hid_t dst_loc_id,
+    const char *dst_name);
 H5_DLL herr_t H5Gunlink(hid_t loc_id, const char *name);
-H5_DLL herr_t H5Gget_linkval(hid_t loc_id, const char *name,
-                      size_t size, char *buf/*out*/);
-
-#define H5G_LINK_ERROR H5L_TYPE_ERROR
-#define H5G_LINK_HARD H5L_TYPE_HARD
-#define H5G_LINK_SOFT H5L_TYPE_SOFT
-#define H5G_link_t H5L_type_t
-#define H5G_SAME_LOC H5L_SAME_LOC
-
+H5_DLL herr_t H5Gget_linkval(hid_t loc_id, const char *name, size_t size,
+    char *buf/*out*/);
 
 #ifdef __cplusplus
 }
 #endif
-#endif
+#endif /* _H5Gpublic_H */