summaryrefslogtreecommitdiffstats
path: root/src/H5UCprivate.h
diff options
context:
space:
mode:
authorMohamad Chaarawi <chaarawi@hdfgroup.org>2013-08-30 17:05:42 (GMT)
committerMohamad Chaarawi <chaarawi@hdfgroup.org>2013-08-30 17:05:42 (GMT)
commita3e0aecb2235e487eae80de4dd4c074bd2dabc0f (patch)
tree78599452e6871eca8e444b5878efc6b9b1076a9b /src/H5UCprivate.h
parent7a0f38d807b4f8b10608dd0d860b625d98845498 (diff)
downloadhdf5-a3e0aecb2235e487eae80de4dd4c074bd2dabc0f.zip
hdf5-a3e0aecb2235e487eae80de4dd4c074bd2dabc0f.tar.gz
hdf5-a3e0aecb2235e487eae80de4dd4c074bd2dabc0f.tar.bz2
[svn-r24087] Rename the private H5RC (reference count) module to H5UC (Use Count).
This is needed to avoid a conflict with the Read Context object to be introduced in another Project. No impact on users, since this is a private module, and low for developers as the RC module use is very sparse in the library. Tested with h5committest.
Diffstat (limited to 'src/H5UCprivate.h')
-rw-r--r--src/H5UCprivate.h66
1 files changed, 66 insertions, 0 deletions
diff --git a/src/H5UCprivate.h b/src/H5UCprivate.h
new file mode 100644
index 0000000..a702c03
--- /dev/null
+++ b/src/H5UCprivate.h
@@ -0,0 +1,66 @@
+/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
+ * Copyright by The HDF Group. *
+ * Copyright by the Board of Trustees of the University of Illinois. *
+ * All rights reserved. *
+ * *
+ * This file is part of HDF5. The full HDF5 copyright notice, including *
+ * terms governing use, modification, and redistribution, is contained in *
+ * the files COPYING and Copyright.html. COPYING can be found at the root *
+ * of the source code distribution tree; Copyright.html can be found at the *
+ * root level of an installed copy of the electronic HDF5 document set and *
+ * is linked from the top-level documents page. It can also be found at *
+ * http://hdfgroup.org/HDF5/doc/Copyright.html. If you do not have *
+ * access to either file, you may request a copy from help@hdfgroup.org. *
+ * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
+
+/*
+ * This file contains private information about the H5UC module
+ * The module used to be H5RC, but changed to H5UC because of
+ * conflicting requirement for the use of H5RC.
+ */
+
+#ifndef _H5UCprivate_H
+#define _H5UCprivate_H
+
+/**************************************/
+/* Public headers needed by this file */
+/**************************************/
+#ifdef LATER
+#include "H5UCpublic.h"
+#endif /* LATER */
+
+/***************************************/
+/* Private headers needed by this file */
+/***************************************/
+#include "H5private.h"
+
+/************/
+/* Typedefs */
+/************/
+
+/* Typedef for function to release object when reference count drops to zero */
+typedef herr_t (*H5UC_free_func_t)(void *o);
+
+/* Typedef for reference counted objects */
+typedef struct H5UC_t {
+ void *o; /* Object to be reference counted */
+ size_t n; /* Reference count of number of pointers sharing object */
+ H5UC_free_func_t free_func; /* Function to free object */
+} H5UC_t;
+
+/**********/
+/* Macros */
+/**********/
+#define H5UC_INC(rc) ((rc)->n++)
+#define H5UC_DEC(rc) (H5UC_decr(rc))
+#define H5UC_GET_OBJ(rc) ((rc)->o)
+
+/********************/
+/* Private routines */
+/********************/
+H5_DLL H5UC_t *H5UC_create(void *s, H5UC_free_func_t free_func);
+H5_DLL herr_t H5UC_decr(H5UC_t *rc);
+
+#endif /* _H5RSprivate_H */
+
+