summaryrefslogtreecommitdiffstats
path: root/src/H5Epublic.h
blob: 101ad76baf34e2c7e3ea2f3b040d29161d86629e (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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
/****************************************************************************
 * 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 H5E module.
 */

#ifndef _H5Epublic_H
#define _H5Epublic_H

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

/* Declare an enumerated type which holds all the valid major HDF error codes */
typedef enum
  {
      H5E_NONE_MAJOR = 0,      /* special zero, no error */
      H5E_ARGS,                /* Invalid arguments to routine */
      H5E_RESOURCE,            /* Resource unavailable */
      H5E_INTERNAL,            /* Internal error (too specific to document in detail) */
      H5E_FILE,                /* File Accessability */
      H5E_IO,                  /* Low-level I/O */
      H5E_FUNC,                /* Function Entry/Exit */
      H5E_ATOM,                /* Object Atom */
      H5E_CACHE,	       /* Object Cache */
      H5E_BTREE,	       /* B-Tree Node */
      H5E_SYM,		       /* Symbol Table */
      H5E_HEAP,		       /* Heap */
      H5E_OHDR,		       /* Object Header */
      H5E_DIRECTORY,       /* Directory */
      H5E_DATATYPE,	       /* Datatype */
      H5E_DATASPACE,       /* Dataspace */
      H5E_DATASET          /* Dataset */
  }
hdf_maj_err_code_t;

/* Declare an enumerated type which holds all the valid minor HDF error codes */
typedef enum
  {
      H5E_NONE_MINOR = 0,      /* special zero, no error */

    /* Argument errors */
      H5E_UNINITIALIZED,       /* Information is unitialized */
      H5E_UNSUPPORTED,         /* Feature is unsupported */
      H5E_BADTYPE,             /* Incorrect type found */
      H5E_BADRANGE,            /* Argument out of range */
      H5E_BADVALUE,            /* Bad value for argument */

    /* Resource errors */
      H5E_NOSPACE,             /* No space available for allocation */

    /* File accessability errors */
      H5E_FILEEXISTS,          /* File already exists */
      H5E_FILEOPEN,            /* File already open */
      H5E_CANTCREATE,          /* Can't create file */
      H5E_CANTOPEN,            /* Can't open file */
      H5E_NOTHDF5,             /* Not an HDF5 format file */
      H5E_BADFILE,             /* Bad file ID accessed */

    /* Generic low-level file I/O errors */
      H5E_SEEKERROR,           /* Seek failed */
      H5E_READERROR,           /* Read failed */
      H5E_WRITEERROR,          /* Write failed */

    /* Function entry/exit interface errors */
      H5E_CANTINIT,            /* Can't initialize interface */
      H5E_ALREADYINIT,         /* Object already initialized */

    /* Object atom related errors */
      H5E_BADATOM,             /* Can't find atom information */
      H5E_CANTREGISTER,        /* Can't register new atom */

    /* Cache related errors */
      H5E_CANTFLUSH,	       /* Can't flush object from cache */
      H5E_CANTLOAD,	       /* Can't load object into cache */
      H5E_PROTECT,	       /* Protected object error */

    /* B-tree related errors */
      H5E_NOTFOUND,	       /* Object not found */
      H5E_EXISTS,	       /* Object already exists */
      H5E_CANTENCODE,	       /* Can't encode value */
      H5E_CANTDECODE,	       /* Can't decode value */
      H5E_CANTSPLIT,	       /* Can't split node */
      H5E_CANTINSERT,	       /* Can't insert object */
      H5E_CANTLIST,	       /* Can't list node */

    /* Object header related errors */
      H5E_LINKCOUNT,	       /* Bad object header link count */
      H5E_VERSION,	       /* Wrong version number */
      H5E_ALIGNMENT,	       /* Alignment error */
      H5E_BADMESG,	       /* Unrecognized message */

    /* Directory related errors */
      H5E_COMPLEN,	       /* Name component is too long */
      H5E_LINK		       /* Link count failure */
  }
hdf_min_err_code_t;

/* Function pointer to report errors through */
typedef herr_t (*H5E_push_func_t)(int32 errid, hdf_maj_err_code_t maj, hdf_min_err_code_t min, const char *function_name, const char *file_name, intn line);

#ifdef __cplusplus
extern "C" {
#endif

/* Functions in H5E.c */
int32 H5Enew_err_stack(uintn initial_stack_size);
intn H5Edelete_err_stack(int32 err_hand);
#ifdef H5_ERROR_DEBUG
H5E_push_func_t H5Eset_push(H5E_push_func_t func);
#endif
herr_t H5Epush(hdf_maj_err_code_t maj, hdf_min_err_code_t min, const char *function_name, const char *file_name, intn line);
herr_t H5Eclear(int32 err_hand);
void H5E_term_interface(void);

#ifdef __cplusplus
}
#endif

#endif