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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
|
/*
* $Id$
*
* This source code is part of
*
* G R O M A C S
*
* GROningen MAchine for Chemical Simulations
*
* VERSION 3.2.0
* Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
* Copyright (c) 1991-2000, University of Groningen, The Netherlands.
* Copyright (c) 2001-2004, The GROMACS development team,
* check out http://www.gromacs.org for more information.
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* If you want to redistribute modifications, please consider that
* scientific software is very special. Version control is crucial -
* bugs must be traceable. We will be happy to consider code for
* inclusion in the official distribution, but derived work must not
* be called official GROMACS. Details are found in the README & COPYING
* files - if they are missing, get the official version at www.gromacs.org.
*
* To help us fund GROMACS development, we humbly ask that you cite
* the papers on the package - you can find them in the top README file.
*
* For more info, check our website at http://www.gromacs.org
*
* And Hey:
* Gromacs Runs On Most of All Computer Systems
*/
#ifndef _fatal_h
#define _fatal_h
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#ifdef CPLUSPLUS
extern "C" {
#endif
#include <stdio.h>
#include <stdarg.h>
#include <errno.h>
void
_where(const char *file,int line);
#define where() _where(__FILE__,__LINE__)
/* Prints filename and line to stdlog and only on amba memvail */
void
_set_fatal_tmp_file(const char *fn, const char *file, int line);
#define set_fatal_tmp_file(fn) _set_fatal_tmp_file(fn,__FILE__,__LINE__)
/* set filename to be removed when fatal_error is called */
void
_unset_fatal_tmp_file(const char *fn, const char *file, int line);
#define unset_fatal_tmp_file(fn) _unset_fatal_tmp_file(fn,__FILE__,__LINE__)
/* unsets filename to be removed */
void
gmx_fatal(int fatal_errno,const char *file,int line,const char *fmt,...);
#define FARGS 0,__FILE__,__LINE__
/*
* Routine gmx_fatal prints
*
* "fatal error file %s line %s \n\t "
*
* followed by the string specified by fmt and supplied parameters. If
* errno is 0, only the message and arguments are printed. If errno is
* a legal system errno or -1, a perror like message is printed after the
* first message, if errno is -1, the last system errno will be used.
* The format of fmt is that like printf etc, only %d, %x, %c, %f and %s
* are allowed as format specifiers.
*
* Tip of the week:
* call this function using the FARGS macro:
* gmx_fatal(FARGS,fmt,...)
*/
/* This include must not be moved upwards, to prevent compilation problems */
#include "typedefs.h"
void
gmx_fatal_set_log_file(FILE *fp);
/* Set the log file for printing error messages */
void
init_warning(int maxwarning);
/* Set the max number of warnings */
void
set_warning_line(const char *fn,int line);
/* Set filename and linenumber for the warning */
int
get_warning_line(void);
/* Get linenumber for the warning */
const char *
get_warning_file(void);
/* Get filename for the warning */
extern char
warn_buf[1024];
/* Warning buffer of 1024 bytes, which can be used to print messages to */
void
warning(const char *s);
/* Issue a warning, with the string s. If s == NULL, then warn_buf
* will be printed instead. The file and line set by set_warning_line
* are printed, nwarn_warn (local) is incremented.
* A fatal error will be generated after processing the input
* when nwarn_warn is larger than maxwarning passed to init_warning.
* So warning should only be called for issues that should be resolved,
* otherwise warning_note should be called.
*/
void
warning_note(const char *s);
/* Issue a note, with the string s. If s == NULL, then warn_buf
* will be printed instead. The file and line set by set_warning_line
* are printed, nwarn_note (local) is incremented.
* This is for issues which could be a problem for some systems,
* but 100% ok for other systems.
*/
void
warning_error(const char *s);
/* Issue an error, with the string s. If s == NULL, then warn_buf
* will be printed instead. The file and line set by set_warning_line
* are printed, nwarn_error (local) is incremented.
*/
void
check_warning_error(int f_errno,const char *file,int line);
/* When warning_error has been called at least once gmx_fatal is called,
* otherwise does nothing.
*/
void
print_warn_num(bool bFatalError);
/* Print the total number of warnings, if larger than 0.
* When bFatalError == TRUE generates a fatal error
* when the number is larger than maxwarn.
*/
void
_too_few(const char *fn,int line);
#define too_few() _too_few(__FILE__,__LINE__)
/* Issue a warning stating 'Too few parameters' */
void
_invalid_case(const char *fn,int line);
#define invalid_case() _invalid_case(__FILE__,__LINE__)
/* Issue a warning stating 'Invalid case in switch' */
extern void _unexpected_eof(const char *fn,int line,const char *srcfn,int srcline);
#define unexpected_eof(fn,line) _unexpected_eof(fn,line,__FILE__,__LINE__)
/*
* Functions can write to this file for debug info
* Before writing to it, it should be checked whether
* the file is not NULL:
* if (debug) fprintf(debug,"%s","Hallo");
*/
extern FILE *debug;
extern bool gmx_debug_at;
void init_debug (const int dbglevel,const char *dbgfile);
extern bool bDebugMode(void);
/* Return TRUE when the program was started in debug mode */
#if (defined __sgi && defined USE_SGI_FPE)
extern void doexceptions(void);
/* Set exception handlers for debugging */
#endif
/* If msg == NULL, then warn_buf will be printed instead.
*/
extern void _range_check(int n,int n_min,int n_max,const char *var,
const char *file,int line);
#define range_check(n,n_min,n_max) _range_check(n,n_min,n_max,#n,__FILE__,__LINE__)
/* Range check will terminate with an error message if not
* n E [ n_min, n_max >
* That is n_min is inclusive but not n_max.
*/
extern char *gmx_strerror(const char *key);
/* Return error message corresponding to the key.
* Maybe a multi-line message.
* The messages are stored in src/gmxlib/fatal.c
*/
extern void _gmx_error(const char *key,const char *msg,const char *file,int line);
#define gmx_error(key,msg) _gmx_error(key,msg,__FILE__,__LINE__)
/* Error msg of type key is generated and the program is
* terminated unless and error handle is set (see below)
*/
/* Some common error types */
#define gmx_bug(msg) gmx_error("bug",msg)
#define gmx_call(msg) gmx_error("call",msg)
#define gmx_comm(msg) gmx_error("comm",msg)
#define gmx_file(msg) gmx_error("file",msg)
#define gmx_cmd(msg) gmx_error("cmd",msg)
#define gmx_impl(msg) gmx_error("impl",msg)
#define gmx_incons(msg) gmx_error("incons",msg)
#define gmx_input(msg) gmx_error("input",msg)
#define gmx_mem(msg) gmx_error("mem",msg)
#define gmx_open(fn) gmx_error("open",fn)
void
set_gmx_error_handler(void (*func)(const char *msg));
/* An error function will be called that terminates the program
* with a fatal error, unless you override it with another function.
* i.e.:
* set_gmx_error_handler(my_func);
* where my_func is a function that takes a string as an argument.
* The string may be a multi-line string.
*/
#ifdef CPLUSPLUS
}
#endif
#endif /* _fatal_h */
|
