H5Iprivate.h

00001 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
00002  * Copyright by The HDF Group.                                               *
00003  * Copyright by the Board of Trustees of the University of Illinois.         *
00004  * All rights reserved.                                                      *
00005  *                                                                           *
00006  * This file is part of HDF5.  The full HDF5 copyright notice, including     *
00007  * terms governing use, modification, and redistribution, is contained in    *
00008  * the files COPYING and Copyright.html.  COPYING can be found at the root   *
00009  * of the source code distribution tree; Copyright.html can be found at the  *
00010  * root level of an installed copy of the electronic HDF5 document set and   *
00011  * is linked from the top-level documents page.  It can also be found at     *
00012  * http://hdfgroup.org/HDF5/doc/Copyright.html.  If you do not have          *
00013  * access to either file, you may request a copy from help@hdfgroup.org.     *
00014  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
00015 
00016 /*-----------------------------------------------------------------------------
00017  * File:    H5Iprivate.h
00018  * Purpose: header file for ID API
00019  *---------------------------------------------------------------------------*/
00020 
00021 /* avoid re-inclusion */
00022 #ifndef _H5Iprivate_H
00023 #define _H5Iprivate_H
00024 
00025 /* Include package's public header */
00026 #include "H5Ipublic.h"
00027 
00028 /* Private headers needed by this file */
00029 #include "H5private.h"
00030 
00031 /* Macro to determine if a H5I_type_t is a "library type" */
00032 #define H5I_IS_LIB_TYPE( type ) (type > 0 && type < H5I_NTYPES)
00033 
00034 /* Default sizes of the hash-tables for various atom types */
00035 #define H5I_ERRSTACK_HASHSIZE           64
00036 #define H5I_FILEID_HASHSIZE             64
00037 #define H5I_TEMPID_HASHSIZE             64
00038 #define H5I_DATATYPEID_HASHSIZE         64
00039 #define H5I_DATASPACEID_HASHSIZE        64
00040 #define H5I_DATASETID_HASHSIZE          64
00041 #define H5I_OID_HASHSIZE                64
00042 #define H5I_GROUPID_HASHSIZE            64
00043 #define H5I_ATTRID_HASHSIZE             64
00044 #define H5I_REFID_HASHSIZE              64
00045 #define H5I_VFL_HASHSIZE                64
00046 #define H5I_GENPROPCLS_HASHSIZE         64
00047 #define H5I_GENPROPOBJ_HASHSIZE         128
00048 #define H5I_ERRCLS_HASHSIZE             64
00049 #define H5I_ERRMSG_HASHSIZE             64
00050 #define H5I_ERRSTK_HASHSIZE             64
00051 
00052 /* Private Functions in H5I.c */
00053 H5_DLL H5I_type_t H5I_register_type(H5I_type_t type_id, size_t hash_size, unsigned reserved, H5I_free_t free_func);
00054 H5_DLL int H5I_nmembers(H5I_type_t type);
00055 H5_DLL herr_t H5I_clear_type(H5I_type_t type, hbool_t force, hbool_t app_ref);
00056 H5_DLL int H5I_destroy_type(H5I_type_t type);
00057 H5_DLL hid_t H5I_register(H5I_type_t type, const void *object, hbool_t app_ref);
00058 H5_DLL void *H5I_subst(hid_t id, const void *new_object);
00059 H5_DLL void *H5I_object(hid_t id);
00060 H5_DLL void *H5I_object_verify(hid_t id, H5I_type_t id_type);
00061 H5_DLL H5I_type_t H5I_get_type(hid_t id);
00062 H5_DLL hid_t H5I_get_file_id(hid_t obj_id, hbool_t app_ref);
00063 H5_DLL void *H5I_remove(hid_t id);
00064 H5_DLL void *H5I_remove_verify(hid_t id, H5I_type_t id_type);
00065 H5_DLL void *H5I_search(H5I_type_t type, H5I_search_func_t func, void *key, hbool_t app_ref);
00066 H5_DLL int H5I_get_ref(hid_t id, hbool_t app_ref);
00067 H5_DLL int H5I_inc_ref(hid_t id, hbool_t app_ref);
00068 H5_DLL int H5I_dec_ref(hid_t id, hbool_t app_ref);
00069 H5_DLL int H5I_inc_type_ref(H5I_type_t type);
00070 H5_DLL herr_t H5I_dec_type_ref(H5I_type_t type);
00071 H5_DLL int H5I_get_type_ref(H5I_type_t type);
00072 
00073 #endif /* _H5Iprivate_H */
00074