-
Notifications
You must be signed in to change notification settings - Fork 346
/
gmt_error.h
147 lines (134 loc) · 4.94 KB
/
gmt_error.h
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
/*--------------------------------------------------------------------
*
* Copyright (c) 1991-2024 by the GMT Team (https://www.generic-mapping-tools.org/team.html)
* See LICENSE.TXT file for copying and redistribution conditions.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; version 3 or any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* Contact info: www.generic-mapping-tools.org
*--------------------------------------------------------------------*/
/*
* Include file for GMT error codes
*
* Author: Paul Wessel
* Date: 1-JAN-2010
* Version: 6 API
*/
/*!
* \file gmt_error.h
* \brief Include file for GMT error codes
*/
#ifndef GMT_ERROR_H
#define GMT_ERROR_H
/* Grid i/o error codes */
/* External array with error descriptions */
EXTERN_MSC const char* gmt_error_string[];
enum Gmt_error_code {
GMT_NOERROR_UNUSED=0, /* The real GMT_NOERROR is declared in gmt_resources.h and is part of API */
GMT_GRDIO_NONUNIQUE_FORMAT,
GMT_GRDIO_UNKNOWN_FORMAT,
GMT_GRDIO_UNKNOWN_TYPE,
GMT_GRDIO_UNKNOWN_ID,
GMT_GRDIO_PIPE_CODECHECK,
GMT_GRDIO_DOMAIN_VIOLATION,
GMT_GRDIO_OPEN_FAILED,
GMT_GRDIO_CREATE_FAILED,
GMT_GRDIO_READ_FAILED,
GMT_GRDIO_WRITE_FAILED,
GMT_GRDIO_STAT_FAILED,
GMT_GRDIO_SEEK_FAILED,
GMT_GRDIO_FILE_NOT_FOUND,
GMT_GRDIO_BAD_VAL,
GMT_GRDIO_BAD_XINC,
GMT_GRDIO_BAD_XRANGE,
GMT_GRDIO_BAD_YINC,
GMT_GRDIO_BAD_YRANGE,
GMT_GRDIO_BAD_IMG_LAT,
GMT_GRDIO_NO_2DVAR,
GMT_GRDIO_NO_VAR,
GMT_GRDIO_BAD_DIM,
GMT_GRDIO_NC_NO_PIPE,
GMT_GRDIO_NC_NOT_COARDS,
GMT_GRDIO_NOT_RAS,
GMT_GRDIO_NOT_8BIT_RAS,
GMT_GRDIO_NOT_SURFER,
GMT_GRDIO_SURF7_UNSUPPORTED,
GMT_GRDIO_GRD98_XINC,
GMT_GRDIO_GRD98_YINC,
GMT_GRDIO_GRD98_BADMAGIC,
GMT_GRDIO_GRD98_BADLENGTH,
GMT_GRDIO_ESRI_NONSQUARE,
GMT_GRDIO_RI_OLDBAD,
GMT_GRDIO_RI_NEWBAD,
GMT_GRDIO_RI_NOREPEAT,
GMT_IO_BAD_PLOT_DEGREE_FORMAT,
GMT_CHEBYSHEV_NEG_ORDER,
GMT_CHEBYSHEV_BAD_DOMAIN,
GMT_MAP_EXCEEDS_360,
GMT_MAP_BAD_ELEVATION_MIN,
GMT_MAP_BAD_ELEVATION_MAX,
GMT_MAP_BAD_LAT_MIN,
GMT_MAP_BAD_LAT_MAX,
GMT_MAP_NO_REGION,
GMT_MAP_NO_PROJECTION,
GMT_MAP_BAD_DIST_FLAG,
GMT_MAP_BAD_MEASURE_UNIT
};
EXTERN_MSC const char * GMT_strerror (int err);
#define gmt_M_is_verbose(C,level) (MAX(C->parent->verbose, C->current.setting.verbose) >= level)
/* Check condition and report error if true - passing GMT as arg */
#define gmt_M_check_condition(C,condition,...) ((condition) ? 1+GMT_Report(C->parent,GMT_MSG_ERROR,__VA_ARGS__) : 0)
/* Check condition and report error if true - passing API as arg */
#define gmt_M_check_active(API,condition,...) ((condition) ? 1+GMT_Report(API,GMT_MSG_ERROR,__VA_ARGS__) : 0)
/* Check if a module option has been called more than once (context has opt available), then sets active to true. */
#define gmt_M_repeated_module_option(API,active) gmt_M_check_active (API, active, "Option -%c: Given more than once (offending option is -%c%s)\n", opt->option, opt->option, opt->arg); active = true
/* Because it is called like this:
* n_errors += gmt_M_repeated_module_option (API, Ctrl->T.active);
* the macro expands to the two statements
* n_errors += ((Ctrl->T.active) ? 1+GMT_Report (API,GMT_MSG_ERROR, "Option -%c: Given more than once (offending option is -%c%s)\n", opt->option, opt->option, opt->arg) : 0); Ctrl->T.active = true;
* which is why the macro does not have a semi-colon at the end after setting active = true
*/
/* Set __func__ identifier */
#ifndef HAVE___FUNC__
# ifdef HAVE___FUNCTION__
# define __func__ __FUNCTION__
# else
# define __func__ "<unknown>"
# endif
#endif
/* Concatenate __FILE__ and __LINE__ as string */
#define STRINGIFY(x) #x
#define TOSTRING(x) STRINGIFY(x)
#define __SOURCE_LINE __FILE__ ":" TOSTRING(__LINE__)
static inline char* __source_line_func (const char* src_line, const char* func) {
/* This function is not thread-safe */
static char str[GMT_LEN256];
const char *c = src_line;
size_t len;
*str = '\0';
while ((c = strpbrk (c, "/\\")) != NULL) /* get basename of src_line */
src_line = ++c;
strncat (str, src_line, GMT_LEN256-1);
len = strlen (src_line);
strncat (str, "(", GMT_LEN256 - 2 - len);
strncat (str, func, GMT_LEN256 - 3 - len);
strcat (str, ")");
return str;
}
#define __SOURCE_LINE_FUNC __source_line_func (__FILE__ ":" TOSTRING(__LINE__), __func__)
/* Convenience functions to gmt_err_func */
#ifdef DEBUG
# define gmt_M_err_pass(C,err,file) gmt_err_func(C,err,false,file,__SOURCE_LINE_FUNC)
# define gmt_M_err_fail(C,err,file) gmt_err_func(C,err,true,file,__SOURCE_LINE_FUNC)
#else
# define gmt_M_err_pass(C,err,file) gmt_err_func(C,err,false,file,__func__)
# define gmt_M_err_fail(C,err,file) gmt_err_func(C,err,true,file,__func__)
#endif
#endif /* GMT_ERROR_H */