summaryrefslogtreecommitdiffstats
path: root/src/H5Tpublic.h
blob: 10f86b55a65d3e262c0081d90433dbb1d23aaec7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
/****************************************************************************
 * NCSA HDF                                                                 *
 * Software Development Group                                               *
 * National Center for Supercomputing Applications                          *
 * University of Illinois at Urbana-Champaign                               *
 * 605 E. Springfield, Champaign IL 61820                                   *
 *                                                                          *
 * For conditions of distribution and use, see the accompanying             *
 * hdf/COPYING file.                                                        *
 *                                                                          *
 ****************************************************************************/

/* $Id$ */

/*
 * This file contains public declarations for the H5T module.
 */

#ifndef _H5Tpublic_H
#define _H5Tpublic_H

/* Public headers needed by this file */
#include <H5public.h>
#include <H5Apublic.h>

/* Define atomic datatype bases */
#define H5T_CHAR    MAKE_ATOM(H5_DATATYPE,0)
#define H5T_INT     MAKE_ATOM(H5_DATATYPE,1)
#define H5T_FLOAT   MAKE_ATOM(H5_DATATYPE,2)
#define H5T_DATE    MAKE_ATOM(H5_DATATYPE,3)
#define H5T_TIME    MAKE_ATOM(H5_DATATYPE,4)
#define H5T_SPTR    MAKE_ATOM(H5_DATATYPE,5)
#define H5T_PPTR    MAKE_ATOM(H5_DATATYPE,6)
#define H5T_COMPOUND MAKE_ATOM(H5_DATATYPE,7)

/* Define atomic datatype architectures */
#define H5T_BIGENDIAN       0
#define H5T_LITTLEENDIAN    1

/* Define the machine's architecture */
/*
WARNING!
    This is _extremly_ crude is is only valid for very generic architectures,
    anything with a wierd size of integer or wacky floating-point format will
    _not_ work with this hack.  It needs to be replaced with Robb's much more
    comprehensive code from H5detect.c. -QAK
WARNING!
*/
#define H5T_ARCH_BIGENDIAN  0
#define H5T_ARCH_LITTLEENDIAN  1
#ifdef WORDS_BIGENDIAN
#define H5T_ARCH_TYPE  H5T_ARCH_BIGENDIAN
#else /* WORDS_BIGENDIAN */
#define H5T_ARCH_TYPE  H5T_ARCH_LITTLEENDIAN
#endif /* WORDS_BIGENDIAN */

typedef struct {
    hid_t base;           /* Basic datatype */
    uint8 len;              /* Length of base-type, in bytes */
    uint8 arch;             /* Architecture of the base-type */
 } h5_atomic_type_t;

#ifdef __cplusplus
extern "C" {
#endif

/* Functions in H5T.c */
uint32 H5Tget_num_fields(hid_t tid);
hbool_t H5Tis_field_atomic(hid_t tid,uintn fidx);
hbool_t H5Tis_atomic(hid_t tid);
herr_t H5Tset_type(hid_t tid,hid_t base,uint8 len,uint8 arch);
herr_t H5Tget_type(hid_t tid,hid_t *base,uint8 *len,uint8 *arch);
uintn H5Tsize(hid_t tid, hbool_t mem_flag);
intn H5Tarch(hid_t tid);
herr_t H5Tadd_field (hid_t tid, const char *name, hid_t base, uint8 len,
		     uint8 arch, hid_t space);
herr_t H5Tget_fields(hid_t tid, hid_t *field_list);

/* Private functions which need to be globally visible */
void H5T_term_interface (void);
void H5T_destroy(void *datatype);

#ifdef __cplusplus
}
#endif

#endif