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, by the GROMACS development team, led by
7 * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
8 * and including many others, as listed in the AUTHORS file in the
9 * top-level source directory and at http://www.gromacs.org.
11 * GROMACS is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU Lesser General Public License
13 * as published by the Free Software Foundation; either version 2.1
14 * of the License, or (at your option) any later version.
16 * GROMACS is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 * Lesser General Public License for more details.
21 * You should have received a copy of the GNU Lesser General Public
22 * License along with GROMACS; if not, see
23 * http://www.gnu.org/licenses, or write to the Free Software Foundation,
24 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
26 * If you want to redistribute modifications to GROMACS, please
27 * consider that scientific software is very special. Version
28 * control is crucial - bugs must be traceable. We will be happy to
29 * consider code for inclusion in the official distribution, but
30 * derived work must not be called official GROMACS. Details are found
31 * in the README & COPYING files - if they are missing, get the
32 * official version at http://www.gromacs.org.
34 * To help us fund GROMACS development, we humbly ask that you cite
35 * the research papers on the package. Check out http://www.gromacs.org.
43 #include "gromacs/utility/cstringutil.h"
44 #include "gromacs/utility/fatalerror.h"
45 #include "gromacs/utility/smalloc.h"
47 typedef struct warninp {
48 gmx_bool bAllowWarnings;
57 warninp_t init_warning(gmx_bool bAllowWarnings, int maxwarning)
63 wi->bAllowWarnings = bAllowWarnings;
64 wi->maxwarn = maxwarning;
68 strcpy(wi->filenm, "unknown");
74 void set_warning_line(warninp_t wi, const char *s, int line)
78 std::strcpy(wi->filenm, s);
83 int get_warning_line(warninp_t wi)
88 const char *get_warning_file(warninp_t wi)
93 static void low_warning(warninp_t wi, const char *wtype, int n, const char *s)
101 s = "Empty error message.";
103 snew(temp, std::strlen(s)+indent+1);
104 for (i = 0; i < indent; i++)
109 std::strcat(temp, s);
110 temp2 = wrap_lines(temp, 78-indent, indent, FALSE);
111 if (std::strlen(wi->filenm) > 0)
113 if (wi->lineno != -1)
115 fprintf(stderr, "\n%s %d [file %s, line %d]:\n%s\n\n",
116 wtype, n, wi->filenm, wi->lineno, temp2);
120 fprintf(stderr, "\n%s %d [file %s]:\n%s\n\n",
121 wtype, n, wi->filenm, temp2);
126 fprintf(stderr, "\n%s %d:\n%s\n\n", wtype, n, temp2);
132 void warning(warninp_t wi, const char *s)
134 if (wi->bAllowWarnings)
137 low_warning(wi, "WARNING", wi->nwarn_warn, s);
141 warning_error(wi, s);
145 void warning_note(warninp_t wi, const char *s)
148 low_warning(wi, "NOTE", wi->nwarn_note, s);
151 void warning_error(warninp_t wi, const char *s)
154 low_warning(wi, "ERROR", wi->nwarn_error, s);
157 static void print_warn_count(const char *type, int n)
161 fprintf(stderr, "\nThere %s %d %s%s\n",
162 (n == 1) ? "was" : "were", n, type, (n == 1) ? "" : "s");
166 // Note it is the caller's responsibility to ensure that exiting is correct behaviour
167 static gmx_noreturn void check_warning_error_impl(warninp_t wi, int f_errno, const char *file, int line)
169 print_warn_count("note", wi->nwarn_note);
170 print_warn_count("warning", wi->nwarn_warn);
172 gmx_fatal(f_errno, file, line, "There %s %d error%s in input file(s)",
173 (wi->nwarn_error == 1) ? "was" : "were", wi->nwarn_error,
174 (wi->nwarn_error == 1) ? "" : "s");
177 void check_warning_error(warninp_t wi, int f_errno, const char *file, int line)
179 if (wi->nwarn_error > 0)
181 check_warning_error_impl(wi, f_errno, file, line);
185 void warning_error_and_exit(warninp_t wi, const char *s, int f_errno, const char *file, int line)
187 warning_error(wi, s);
188 check_warning_error_impl(wi, f_errno, file, line);
191 gmx_bool warning_errors_exist(warninp_t wi)
193 return (wi->nwarn_error > 0);
196 void done_warning(warninp_t wi, int f_errno, const char *file, int line)
198 // If we've had an error, then this will report the number of
199 // notes and warnings, and then exit.
200 check_warning_error(wi, f_errno, file, line);
202 // Otherwise, we report the number of notes and warnings.
203 print_warn_count("note", wi->nwarn_note);
204 print_warn_count("warning", wi->nwarn_warn);
206 if (wi->maxwarn >= 0 && wi->nwarn_warn > wi->maxwarn)
208 gmx_fatal(f_errno, file, line,
209 "Too many warnings (%d).\n"
210 "If you are sure all warnings are harmless, use the -maxwarn option.",
217 void free_warning(warninp_t wi)
222 void _too_few(warninp_t wi, const char *fn, int line)
227 "Too few parameters on line (source file %s, line %d)",
232 void _incorrect_n_param(warninp_t wi, const char *fn, int line)
237 "Incorrect number of parameters on line (source file %s, line %d)",