/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 * 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. *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

/*
 * This file contains private information about the H5DL module
 * for dealing with links in an HDF5 file.
 */
#ifndef _H5Lprivate_H
#define _H5Lprivate_H

/* Include package's public header */
#include "H5Lpublic.h"

/* Private headers needed by this file */
#include "H5Gprivate.h"
#include "H5Oprivate.h"

/* Definitions for creating intermediate groups */
#define H5L_CRT_INTERMEDIATE_GROUP_NAME         "intermediate_group"
#define H5L_CRT_INTERMEDIATE_GROUP_SIZE         sizeof(unsigned)
#define H5L_CRT_INTERMEDIATE_GROUP_DEF          0

/* Definitions for accessing links */
#define H5L_NLINKS_NAME        "max soft links"
#define H5L_NLINKS_SIZE        sizeof(size_t)
#define H5L_NLINKS_DEF         16 /*max symlinks to follow per lookup  */

#define H5L_ELINK_PREFIX_NAME        "external link prefix"
#define H5L_ELINK_PREFIX_SIZE        sizeof(char *)
#define H5L_ELINK_PREFIX_DEF         NULL /*default is no prefix */

/* Functions that understand link messages */
/* forward reference for later use */
struct H5HL_t; /* defined in H5HLprivate.h */

H5_DLL herr_t H5L_link(H5G_loc_t *new_loc, const char *new_name,
    H5G_loc_t *obj_loc, hid_t lcpl_id, hid_t lapl_id, hid_t dxpl_id);
H5_DLL hid_t H5L_get_default_lcpl(void);
H5_DLL herr_t H5L_get_linkinfo(const H5G_loc_t *loc, const char *name,
    H5L_linkinfo_t *linkbuf/*out*/, hid_t lapl_id, hid_t dxpl_id);
H5_DLL herr_t H5L_init(void);
H5_DLL herr_t H5L_register_external(void);

/* User-defined link functions */
H5_DLL herr_t H5L_register (const H5L_link_class_t *cls);
H5_DLL herr_t H5L_unregister (H5L_link_t id);
H5_DLL const H5L_link_class_t *H5L_find_class(H5L_link_t id);


#endif /* _H5Lprivate_H */