summaryrefslogtreecommitdiffstats
path: root/src/H5Ipkg.h
diff options
context:
space:
mode:
authorQuincey Koziol <koziol@hdfgroup.org>2003-05-15 19:22:33 (GMT)
committerQuincey Koziol <koziol@hdfgroup.org>2003-05-15 19:22:33 (GMT)
commitb496ac1482d97086112c890a0154ce9e1522a815 (patch)
treef3c3ae6ccff7a59bb73e8fe9433f656dfaea680c /src/H5Ipkg.h
parentf36a66b6fb7fb2eed7c8656972d6ce8ec9e75f8c (diff)
downloadhdf5-b496ac1482d97086112c890a0154ce9e1522a815.zip
hdf5-b496ac1482d97086112c890a0154ce9e1522a815.tar.gz
hdf5-b496ac1482d97086112c890a0154ce9e1522a815.tar.bz2
[svn-r6878] Purpose:
Code cleanup Description: Limit the scope on more function prototypes/macros/typedefs. Platforms tested: FreeBSD 4.8 (sleipnir) h5committest not necessary.
Diffstat (limited to 'src/H5Ipkg.h')
-rw-r--r--src/H5Ipkg.h67
1 files changed, 67 insertions, 0 deletions
diff --git a/src/H5Ipkg.h b/src/H5Ipkg.h
new file mode 100644
index 0000000..dc6d55a
--- /dev/null
+++ b/src/H5Ipkg.h
@@ -0,0 +1,67 @@
+/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
+ * 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://hdf.ncsa.uiuc.edu/HDF5/doc/Copyright.html. If you do not have *
+ * access to either file, you may request a copy from hdfhelp@ncsa.uiuc.edu. *
+ * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
+
+/*
+ * Programmer: Quincey Koziol <koziol@ncsa.uiuc.edu>
+ * Thursday, May 15, 2003
+ *
+ * Purpose: This file contains declarations which are visible only within
+ * the H5I package. Source files outside the H5I package should
+ * include H5Iprivate.h instead.
+ */
+#ifndef H5I_PACKAGE
+#error "Do not include this file outside the H5I package!"
+#endif
+
+#ifndef _H5Ipkg_H
+#define _H5Ipkg_H
+
+/* Get package's private header */
+#include "H5Iprivate.h"
+
+/* Other private headers needed by this file */
+
+/**************************/
+/* Package Private Macros */
+/**************************/
+
+/*
+ * Number of bits to use for Group ID in each atom. Increase if H5I_NGROUPS
+ * becomes too large (an assertion would fail in H5I_init_interface). This is
+ * the only number that must be changed since all other bit field sizes and
+ * masks are calculated from GROUP_BITS.
+ */
+#define GROUP_BITS 5
+#define GROUP_MASK ((1<<GROUP_BITS)-1)
+
+/*
+ * Number of bits to use for the Atom index in each atom (assumes 8-bit
+ * bytes). We don't use the sign bit.
+ */
+#define ID_BITS ((sizeof(hid_t)*8)-(GROUP_BITS+1))
+#define ID_MASK ((1<<ID_BITS)-1)
+
+/* Map an atom to a Group number */
+#define H5I_GROUP(a) ((H5I_type_t)(((hid_t)(a)>>ID_BITS) & GROUP_MASK))
+
+
+/****************************/
+/* Package Private Typedefs */
+/****************************/
+
+/******************************/
+/* Package Private Prototypes */
+/******************************/
+
+#endif /*_H5Ipkg_H*/