2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
5 * Copyright (c) 2001-2004, The GROMACS development team.
6 * Copyright (c) 2013,2014,2015,2016,2017 by the GROMACS development team.
7 * Copyright (c) 2018,2019,2020, by the GROMACS development team, led by
8 * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
9 * and including many others, as listed in the AUTHORS file in the
10 * top-level source directory and at http://www.gromacs.org.
12 * GROMACS is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU Lesser General Public License
14 * as published by the Free Software Foundation; either version 2.1
15 * of the License, or (at your option) any later version.
17 * GROMACS is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * Lesser General Public License for more details.
22 * You should have received a copy of the GNU Lesser General Public
23 * License along with GROMACS; if not, see
24 * http://www.gnu.org/licenses, or write to the Free Software Foundation,
25 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
27 * If you want to redistribute modifications to GROMACS, please
28 * consider that scientific software is very special. Version
29 * control is crucial - bugs must be traceable. We will be happy to
30 * consider code for inclusion in the official distribution, but
31 * derived work must not be called official GROMACS. Details are found
32 * in the README & COPYING files - if they are missing, get the
33 * official version at http://www.gromacs.org.
35 * To help us fund GROMACS development, we humbly ask that you cite
36 * the research papers on the package. Check out http://www.gromacs.org.
46 #include "gromacs/utility/cstringutil.h"
47 #include "gromacs/utility/fatalerror.h"
48 #include "gromacs/utility/smalloc.h"
50 typedef struct warninp
52 gmx_bool bAllowWarnings
;
61 warninp_t
init_warning(gmx_bool bAllowWarnings
, int maxwarning
)
63 warninp_t wi
= new warninp
;
65 wi
->bAllowWarnings
= bAllowWarnings
;
66 wi
->maxwarn
= maxwarning
;
68 wi
->filenm
= "unknown";
74 void warning_reset(warninp_t wi
)
81 void set_warning_line(warninp_t wi
, const char* s
, int line
)
90 int get_warning_line(warninp_t wi
)
95 const char* get_warning_file(warninp_t wi
)
97 return wi
->filenm
.c_str();
100 static void low_warning(warninp_t wi
, const char* wtype
, int n
, const char* s
)
108 s
= "Empty error message.";
110 snew(temp
, std::strlen(s
) + indent
+ 1);
111 for (i
= 0; i
< indent
; i
++)
116 std::strcat(temp
, s
);
117 temp2
= wrap_lines(temp
, 78 - indent
, indent
, FALSE
);
118 if (!wi
->filenm
.empty())
120 if (wi
->lineno
!= -1)
122 fprintf(stderr
, "\n%s %d [file %s, line %d]:\n%s\n\n", wtype
, n
, wi
->filenm
.c_str(),
127 fprintf(stderr
, "\n%s %d [file %s]:\n%s\n\n", wtype
, n
, wi
->filenm
.c_str(), temp2
);
132 fprintf(stderr
, "\n%s %d:\n%s\n\n", wtype
, n
, temp2
);
138 void warning(warninp_t wi
, const char* s
)
140 if (wi
->bAllowWarnings
)
143 low_warning(wi
, "WARNING", wi
->nwarn_warn
, s
);
147 warning_error(wi
, s
);
151 void warning(warninp_t wi
, const std::string
& s
)
153 warning(wi
, s
.c_str());
156 void warning_note(warninp_t wi
, const char* s
)
159 low_warning(wi
, "NOTE", wi
->nwarn_note
, s
);
162 void warning_note(warninp_t wi
, const std::string
& s
)
164 warning_note(wi
, s
.c_str());
167 void warning_error(warninp_t wi
, const char* s
)
170 low_warning(wi
, "ERROR", wi
->nwarn_error
, s
);
173 void warning_error(warninp_t wi
, const std::string
& s
)
175 warning_error(wi
, s
.c_str());
178 static void print_warn_count(const char* type
, int n
)
182 fprintf(stderr
, "\nThere %s %d %s%s\n", (n
== 1) ? "was" : "were", n
, type
, (n
== 1) ? "" : "s");
186 // Note it is the caller's responsibility to ensure that exiting is correct behaviour
187 [[noreturn
]] static void check_warning_error_impl(warninp_t wi
, int f_errno
, const char* file
, int line
)
189 print_warn_count("note", wi
->nwarn_note
);
190 print_warn_count("warning", wi
->nwarn_warn
);
192 gmx_fatal(f_errno
, file
, line
, "There %s %d error%s in input file(s)",
193 (wi
->nwarn_error
== 1) ? "was" : "were", wi
->nwarn_error
, (wi
->nwarn_error
== 1) ? "" : "s");
196 void check_warning_error(warninp_t wi
, int f_errno
, const char* file
, int line
)
198 if (wi
->nwarn_error
> 0)
200 check_warning_error_impl(wi
, f_errno
, file
, line
);
204 void warning_error_and_exit(warninp_t wi
, const char* s
, int f_errno
, const char* file
, int line
)
206 warning_error(wi
, s
);
207 check_warning_error_impl(wi
, f_errno
, file
, line
);
210 void warning_error_and_exit(warninp_t wi
, const std::string
& s
, int f_errno
, const char* file
, int line
)
212 warning_error_and_exit(wi
, s
.c_str(), f_errno
, file
, line
);
215 gmx_bool
warning_errors_exist(warninp_t wi
)
217 return (wi
->nwarn_error
> 0);
220 void done_warning(warninp_t wi
, int f_errno
, const char* file
, int line
)
222 // If we've had an error, then this will report the number of
223 // notes and warnings, and then exit.
224 check_warning_error(wi
, f_errno
, file
, line
);
226 // Otherwise, we report the number of notes and warnings.
227 print_warn_count("note", wi
->nwarn_note
);
228 print_warn_count("warning", wi
->nwarn_warn
);
230 if (wi
->maxwarn
>= 0 && wi
->nwarn_warn
> wi
->maxwarn
)
232 gmx_fatal(f_errno
, file
, line
,
233 "Too many warnings (%d).\n"
234 "If you are sure all warnings are harmless, use the -maxwarn option.",
241 void free_warning(warninp_t wi
)
246 void _too_few(warninp_t wi
, const char* fn
, int line
)
250 sprintf(buf
, "Too few parameters on line (source file %s, line %d)", fn
, line
);
254 void _incorrect_n_param(warninp_t wi
, const char* fn
, int line
)
258 sprintf(buf
, "Incorrect number of parameters on line (source file %s, line %d)", fn
, line
);