summaryrefslogtreecommitdiffstats
path: root/src/H5Ppkg.h
diff options
context:
space:
mode:
authorAllen Byrne <byrn@hdfgroup.org>2020-10-01 16:47:45 (GMT)
committerAllen Byrne <byrn@hdfgroup.org>2020-10-01 16:47:45 (GMT)
commit1ba1f2f3222cbe8df0bf601929a4bffd478d7e02 (patch)
treeae51dfc33cf40432dad25a5088767115a98f195e /src/H5Ppkg.h
parent8eef7d295cc3dd134aef0a826f1de4287629996d (diff)
downloadhdf5-1ba1f2f3222cbe8df0bf601929a4bffd478d7e02.zip
hdf5-1ba1f2f3222cbe8df0bf601929a4bffd478d7e02.tar.gz
hdf5-1ba1f2f3222cbe8df0bf601929a4bffd478d7e02.tar.bz2
Source formatted
Diffstat (limited to 'src/H5Ppkg.h')
-rw-r--r--src/H5Ppkg.h170
1 files changed, 82 insertions, 88 deletions
diff --git a/src/H5Ppkg.h b/src/H5Ppkg.h
index 2160d55..0b264eb 100644
--- a/src/H5Ppkg.h
+++ b/src/H5Ppkg.h
@@ -30,27 +30,26 @@
#include "H5Pprivate.h"
/* Other private headers needed by this file */
-#include "H5SLprivate.h" /* Skip lists */
+#include "H5SLprivate.h" /* Skip lists */
/**************************/
/* Package Private Macros */
/**************************/
-
/****************************/
/* Package Private Typedefs */
/****************************/
/* Define enum for type of object that property is within */
typedef enum {
- H5P_PROP_WITHIN_UNKNOWN=0, /* Property container is unknown */
- H5P_PROP_WITHIN_LIST, /* Property is within a list */
- H5P_PROP_WITHIN_CLASS /* Property is within a class */
+ H5P_PROP_WITHIN_UNKNOWN = 0, /* Property container is unknown */
+ H5P_PROP_WITHIN_LIST, /* Property is within a list */
+ H5P_PROP_WITHIN_CLASS /* Property is within a class */
} H5P_prop_within_t;
/* Define enum for modifications to class */
typedef enum {
- H5P_MOD_ERR=(-1), /* Indicate an error */
+ H5P_MOD_ERR = (-1), /* Indicate an error */
H5P_MOD_INC_CLS, /* Increment the dependant class count*/
H5P_MOD_DEC_CLS, /* Decrement the dependant class count*/
H5P_MOD_INC_LST, /* Increment the dependant list count*/
@@ -63,52 +62,54 @@ typedef enum {
/* Define structure to hold property information */
typedef struct H5P_genprop_t {
/* Values for this property */
- char *name; /* Name of property */
- size_t size; /* Size of property value */
- void *value; /* Pointer to property value */
- H5P_prop_within_t type; /* Type of object the property is within */
- hbool_t shared_name; /* Whether the name is shared or not */
+ char * name; /* Name of property */
+ size_t size; /* Size of property value */
+ void * value; /* Pointer to property value */
+ H5P_prop_within_t type; /* Type of object the property is within */
+ hbool_t shared_name; /* Whether the name is shared or not */
/* Callback function pointers & info */
- H5P_prp_create_func_t create; /* Function to call when a property is created */
- H5P_prp_set_func_t set; /* Function to call when a property value is set */
- H5P_prp_get_func_t get; /* Function to call when a property value is retrieved */
- H5P_prp_delete_func_t del; /* Function to call when a property is deleted */
- H5P_prp_copy_func_t copy; /* Function to call when a property is copied */
- H5P_prp_compare_func_t cmp; /* Function to call when a property is compared */
- H5P_prp_close_func_t close; /* Function to call when a property is closed */
+ H5P_prp_create_func_t create; /* Function to call when a property is created */
+ H5P_prp_set_func_t set; /* Function to call when a property value is set */
+ H5P_prp_get_func_t get; /* Function to call when a property value is retrieved */
+ H5P_prp_delete_func_t del; /* Function to call when a property is deleted */
+ H5P_prp_copy_func_t copy; /* Function to call when a property is copied */
+ H5P_prp_compare_func_t cmp; /* Function to call when a property is compared */
+ H5P_prp_close_func_t close; /* Function to call when a property is closed */
} H5P_genprop_t;
/* Define structure to hold class information */
struct H5P_genclass_t {
- struct H5P_genclass_t *parent; /* Pointer to parent class */
- char *name; /* Name of property list class */
- H5P_plist_type_t type; /* Type of property */
- size_t nprops; /* Number of properties in class */
- unsigned plists; /* Number of property lists that have been created since the last modification to the class */
- unsigned classes; /* Number of classes that have been derived since the last modification to the class */
- unsigned ref_count; /* Number of oustanding ID's open on this class object */
- hbool_t deleted; /* Whether this class has been deleted and is waiting for dependent classes & proplists to close */
- unsigned revision; /* Revision number of a particular class (global) */
- H5SL_t *props; /* Skip list containing properties */
+ struct H5P_genclass_t *parent; /* Pointer to parent class */
+ char * name; /* Name of property list class */
+ H5P_plist_type_t type; /* Type of property */
+ size_t nprops; /* Number of properties in class */
+ unsigned
+ plists; /* Number of property lists that have been created since the last modification to the class */
+ unsigned classes; /* Number of classes that have been derived since the last modification to the class */
+ unsigned ref_count; /* Number of oustanding ID's open on this class object */
+ hbool_t deleted; /* Whether this class has been deleted and is waiting for dependent classes & proplists
+ to close */
+ unsigned revision; /* Revision number of a particular class (global) */
+ H5SL_t * props; /* Skip list containing properties */
/* Callback function pointers & info */
- H5P_cls_create_func_t create_func; /* Function to call when a property list is created */
- void *create_data; /* Pointer to user data to pass along to create callback */
- H5P_cls_copy_func_t copy_func; /* Function to call when a property list is copied */
- void *copy_data; /* Pointer to user data to pass along to copy callback */
- H5P_cls_close_func_t close_func; /* Function to call when a property list is closed */
- void *close_data; /* Pointer to user data to pass along to close callback */
+ H5P_cls_create_func_t create_func; /* Function to call when a property list is created */
+ void * create_data; /* Pointer to user data to pass along to create callback */
+ H5P_cls_copy_func_t copy_func; /* Function to call when a property list is copied */
+ void * copy_data; /* Pointer to user data to pass along to copy callback */
+ H5P_cls_close_func_t close_func; /* Function to call when a property list is closed */
+ void * close_data; /* Pointer to user data to pass along to close callback */
};
/* Define structure to hold property list information */
struct H5P_genplist_t {
- H5P_genclass_t *pclass; /* Pointer to class info */
- hid_t plist_id; /* Copy of the property list ID (for use in close callback) */
- size_t nprops; /* Number of properties in class */
- hbool_t class_init; /* Whether the class initialization callback finished successfully */
- H5SL_t *del; /* Skip list containing names of deleted properties */
- H5SL_t *props; /* Skip list containing properties */
+ H5P_genclass_t *pclass; /* Pointer to class info */
+ hid_t plist_id; /* Copy of the property list ID (for use in close callback) */
+ size_t nprops; /* Number of properties in class */
+ hbool_t class_init; /* Whether the class initialization callback finished successfully */
+ H5SL_t * del; /* Skip list containing names of deleted properties */
+ H5SL_t * props; /* Skip list containing properties */
};
/* Function pointer for library classes with properties to register */
@@ -120,22 +121,22 @@ typedef herr_t (*H5P_reg_prop_func_t)(H5P_genclass_t *pclass);
* class variables and methods used to initialize the class.
*/
typedef struct H5P_libclass_t {
- const char *name; /* Class name */
- H5P_plist_type_t type; /* Class type */
+ const char * name; /* Class name */
+ H5P_plist_type_t type; /* Class type */
- H5P_genclass_t * * par_pclass; /* Pointer to global parent class property list class */
- H5P_genclass_t * * pclass; /* Pointer to global property list class */
- hid_t * const class_id; /* Pointer to global property list class ID */
- hid_t * const def_plist_id; /* Pointer to global default property list ID */
- H5P_reg_prop_func_t reg_prop_func; /* Register class's properties */
+ H5P_genclass_t ** par_pclass; /* Pointer to global parent class property list class */
+ H5P_genclass_t ** pclass; /* Pointer to global property list class */
+ hid_t *const class_id; /* Pointer to global property list class ID */
+ hid_t *const def_plist_id; /* Pointer to global default property list ID */
+ H5P_reg_prop_func_t reg_prop_func; /* Register class's properties */
/* Class callback function pointers & info */
- H5P_cls_create_func_t create_func; /* Function to call when a property list is created */
- void *create_data; /* Pointer to user data to pass along to create callback */
- H5P_cls_copy_func_t copy_func; /* Function to call when a property list is copied */
- void *copy_data; /* Pointer to user data to pass along to copy callback */
- H5P_cls_close_func_t close_func; /* Function to call when a property list is closed */
- void *close_data; /* Pointer to user data to pass along to close callback */
+ H5P_cls_create_func_t create_func; /* Function to call when a property list is created */
+ void * create_data; /* Pointer to user data to pass along to create callback */
+ H5P_cls_copy_func_t copy_func; /* Function to call when a property list is copied */
+ void * copy_data; /* Pointer to user data to pass along to copy callback */
+ H5P_cls_close_func_t close_func; /* Function to call when a property list is closed */
+ void * close_data; /* Pointer to user data to pass along to close callback */
} H5P_libclass_t;
/* Property list/class iterator callback function pointer */
@@ -148,7 +149,6 @@ struct H5Z_filter_info_t;
/* Package Private Variables */
/*****************************/
-
/******************************/
/* Package Private Prototypes */
/******************************/
@@ -156,57 +156,51 @@ struct H5Z_filter_info_t;
/* Private functions, not part of the publicly documented API */
H5_DLL herr_t H5P__term_pub_interface(void);
H5_DLL herr_t H5P__term_deprec_interface(void);
-H5_DLL H5P_genclass_t *H5P_create_class(H5P_genclass_t *par_class,
- const char *name, H5P_plist_type_t type,
- H5P_cls_create_func_t cls_create, void *create_data,
- H5P_cls_copy_func_t cls_copy, void *copy_data,
- H5P_cls_close_func_t cls_close, void *close_data);
+H5_DLL H5P_genclass_t *H5P_create_class(H5P_genclass_t *par_class, const char *name, H5P_plist_type_t type,
+ H5P_cls_create_func_t cls_create, void *create_data,
+ H5P_cls_copy_func_t cls_copy, void *copy_data,
+ H5P_cls_close_func_t cls_close, void *close_data);
H5_DLL H5P_genclass_t *H5P_copy_pclass(H5P_genclass_t *pclass);
-H5_DLL herr_t H5P_register_real(H5P_genclass_t *pclass, const char *name, size_t size,
- const void *def_value, H5P_prp_create_func_t prp_create, H5P_prp_set_func_t prp_set,
- H5P_prp_get_func_t prp_get, H5P_prp_delete_func_t prp_delete,
- H5P_prp_copy_func_t prp_copy, H5P_prp_compare_func_t prp_cmp,
- H5P_prp_close_func_t prp_close);
-H5_DLL herr_t H5P_register(H5P_genclass_t **pclass, const char *name, size_t size,
- const void *def_value, H5P_prp_create_func_t prp_create, H5P_prp_set_func_t prp_set,
- H5P_prp_get_func_t prp_get, H5P_prp_delete_func_t prp_delete,
- H5P_prp_copy_func_t prp_copy, H5P_prp_compare_func_t prp_cmp,
- H5P_prp_close_func_t prp_close);
+H5_DLL herr_t H5P_register_real(H5P_genclass_t *pclass, const char *name, size_t size, const void *def_value,
+ H5P_prp_create_func_t prp_create, H5P_prp_set_func_t prp_set,
+ H5P_prp_get_func_t prp_get, H5P_prp_delete_func_t prp_delete,
+ H5P_prp_copy_func_t prp_copy, H5P_prp_compare_func_t prp_cmp,
+ H5P_prp_close_func_t prp_close);
+H5_DLL herr_t H5P_register(H5P_genclass_t **pclass, const char *name, size_t size, const void *def_value,
+ H5P_prp_create_func_t prp_create, H5P_prp_set_func_t prp_set,
+ H5P_prp_get_func_t prp_get, H5P_prp_delete_func_t prp_delete,
+ H5P_prp_copy_func_t prp_copy, H5P_prp_compare_func_t prp_cmp,
+ H5P_prp_close_func_t prp_close);
H5_DLL herr_t H5P_add_prop(H5SL_t *props, H5P_genprop_t *prop);
H5_DLL herr_t H5P_access_class(H5P_genclass_t *pclass, H5P_class_mod_t mod);
H5_DLL htri_t H5P_exist_pclass(H5P_genclass_t *pclass, const char *name);
-H5_DLL herr_t H5P_get_size_plist(const H5P_genplist_t *plist, const char *name,
- size_t *size);
-H5_DLL herr_t H5P_get_size_pclass(H5P_genclass_t *pclass, const char *name,
- size_t *size);
+H5_DLL herr_t H5P_get_size_plist(const H5P_genplist_t *plist, const char *name, size_t *size);
+H5_DLL herr_t H5P_get_size_pclass(H5P_genclass_t *pclass, const char *name, size_t *size);
H5_DLL herr_t H5P_get_nprops_plist(const H5P_genplist_t *plist, size_t *nprops);
-H5_DLL int H5P_cmp_class(const H5P_genclass_t *pclass1, const H5P_genclass_t *pclass2);
-H5_DLL herr_t H5P_cmp_plist(const H5P_genplist_t *plist1, const H5P_genplist_t *plist2,
- int *cmp_ret);
-H5_DLL int H5P_iterate_plist(const H5P_genplist_t *plist, hbool_t iter_all_prop,
- int *idx, H5P_iterate_int_t iter_func, void *iter_data);
-H5_DLL int H5P_iterate_pclass(const H5P_genclass_t *pclass, int *idx,
- H5P_iterate_int_t iter_func, void *iter_data);
+H5_DLL int H5P_cmp_class(const H5P_genclass_t *pclass1, const H5P_genclass_t *pclass2);
+H5_DLL herr_t H5P_cmp_plist(const H5P_genplist_t *plist1, const H5P_genplist_t *plist2, int *cmp_ret);
+H5_DLL int H5P_iterate_plist(const H5P_genplist_t *plist, hbool_t iter_all_prop, int *idx,
+ H5P_iterate_int_t iter_func, void *iter_data);
+H5_DLL int H5P_iterate_pclass(const H5P_genclass_t *pclass, int *idx, H5P_iterate_int_t iter_func,
+ void *iter_data);
H5_DLL herr_t H5P_copy_prop_plist(hid_t dst_id, hid_t src_id, const char *name);
H5_DLL herr_t H5P_copy_prop_pclass(hid_t dst_id, hid_t src_id, const char *name);
H5_DLL herr_t H5P_unregister(H5P_genclass_t *pclass, const char *name);
-H5_DLL char *H5P_get_class_path(H5P_genclass_t *pclass);
+H5_DLL char * H5P_get_class_path(H5P_genclass_t *pclass);
H5_DLL H5P_genclass_t *H5P_open_class_path(const char *path);
H5_DLL H5P_genclass_t *H5P_get_class_parent(const H5P_genclass_t *pclass);
-H5_DLL herr_t H5P_close_class(void *_pclass);
+H5_DLL herr_t H5P_close_class(void *_pclass);
H5_DLL H5P_genprop_t *H5P__find_prop_plist(const H5P_genplist_t *plist, const char *name);
/* Private OCPL routines */
-H5_DLL herr_t H5P_get_filter(const struct H5Z_filter_info_t *filter,
- unsigned int *flags, size_t *cd_nelmts, unsigned cd_values[],
- size_t namelen, char name[], unsigned *filter_config);
+H5_DLL herr_t H5P_get_filter(const struct H5Z_filter_info_t *filter, unsigned int *flags, size_t *cd_nelmts,
+ unsigned cd_values[], size_t namelen, char name[], unsigned *filter_config);
/* Testing functions */
#ifdef H5P_TESTING
-H5_DLL char *H5P_get_class_path_test(hid_t pclass_id);
-H5_DLL hid_t H5P_open_class_path_test(const char *path);
+H5_DLL char * H5P_get_class_path_test(hid_t pclass_id);
+H5_DLL hid_t H5P_open_class_path_test(const char *path);
H5_DLL herr_t H5P_reset_external_file_test(hid_t dcpl_id);
#endif /* H5P_TESTING */
#endif /* _H5Ppkg_H */
-