src/gromacs/gmxlib/warninp.c

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2004, The GROMACS development team.
   6  * Copyright (c) 2013,2014, 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.
  10  *
  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.
  15  *
  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.
  20  *
  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.
  25  *
  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.
  33  *
  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.
  36  */
  37 #include "gmxpre.h"
  38
  39 #include <string.h>
  40
  41 #include "gromacs/utility/smalloc.h"
  42 #include "gromacs/legacyheaders/copyrite.h"
  43 #include "gromacs/utility/cstringutil.h"
  44 #include "gromacs/utility/fatalerror.h"
  45 #include "gromacs/legacyheaders/warninp.h"
  46
  47 typedef struct warninp {
  48     gmx_bool bAllowWarnings;
  49     int      nwarn_note;
  50     int      nwarn_warn;
  51     int      nwarn_error;
  52     int      maxwarn;
  53     int      lineno;
  54     char     filenm[256];
  55 } t_warninp;
  56
  57 warninp_t init_warning(gmx_bool bAllowWarnings, int maxwarning)
  58 {
  59     warninp_t wi;
  60
  61     snew(wi, 1);
  62
  63     wi->bAllowWarnings = bAllowWarnings;
  64     wi->maxwarn        = maxwarning;
  65     wi->nwarn_note     = 0;
  66     wi->nwarn_warn     = 0;
  67     wi->nwarn_error    = 0;
  68     strcpy(wi->filenm, "unknown");
  69     wi->lineno         = 0;
  70
  71     return wi;
  72 }
  73
  74 void set_warning_line(warninp_t wi, const char *s, int line)
  75 {
  76     if (s == NULL)
  77     {
  78         gmx_incons("Calling set_warning_line with NULL pointer");
  79     }
  80
  81     strcpy(wi->filenm, s);
  82     wi->lineno = line;
  83 }
  84
  85 int get_warning_line(warninp_t wi)
  86 {
  87     return wi->lineno;
  88 }
  89
  90 const char *get_warning_file(warninp_t wi)
  91 {
  92     return wi->filenm;
  93 }
  94
  95 static void low_warning(warninp_t wi, const char *wtype, int n, const char *s)
  96 {
  97 #define indent 2
  98     char *temp, *temp2;
  99     int   i;
 100
 101     if (s == NULL)
 102     {
 103         s = "Empty error message.";
 104     }
 105     snew(temp, strlen(s)+indent+1);
 106     for (i = 0; i < indent; i++)
 107     {
 108         temp[i] = ' ';
 109     }
 110     temp[indent] = '\0';
 111     strcat(temp, s);
 112     temp2 = wrap_lines(temp, 78-indent, indent, FALSE);
 113     if (strlen(wi->filenm) > 0)
 114     {
 115         if (wi->lineno != -1)
 116         {
 117             fprintf(stderr, "\n%s %d [file %s, line %d]:\n%s\n\n",
 118                     wtype, n, wi->filenm, wi->lineno, temp2);
 119         }
 120         else
 121         {
 122             fprintf(stderr, "\n%s %d [file %s]:\n%s\n\n",
 123                     wtype, n, wi->filenm, temp2);
 124         }
 125     }
 126     else
 127     {
 128         fprintf(stderr, "\n%s %d:\n%s\n\n", wtype, n, temp2);
 129     }
 130     sfree(temp);
 131     sfree(temp2);
 132 }
 133
 134 void warning(warninp_t wi, const char *s)
 135 {
 136     if (wi->bAllowWarnings)
 137     {
 138         wi->nwarn_warn++;
 139         low_warning(wi, "WARNING", wi->nwarn_warn, s);
 140     }
 141     else
 142     {
 143         warning_error(wi, s);
 144     }
 145 }
 146
 147 void warning_note(warninp_t wi, const char *s)
 148 {
 149     wi->nwarn_note++;
 150     low_warning(wi, "NOTE", wi->nwarn_note, s);
 151 }
 152
 153 void warning_error(warninp_t wi, const char *s)
 154 {
 155     wi->nwarn_error++;
 156     low_warning(wi, "ERROR", wi->nwarn_error, s);
 157 }
 158
 159 static void print_warn_count(const char *type, int n)
 160 {
 161     if (n > 0)
 162     {
 163         fprintf(stderr, "\nThere %s %d %s%s\n",
 164                 (n == 1) ? "was" : "were", n, type, (n == 1) ? "" : "s");
 165     }
 166 }
 167
 168 void check_warning_error(warninp_t wi, int f_errno, const char *file, int line)
 169 {
 170     if (wi->nwarn_error > 0)
 171     {
 172         print_warn_count("note", wi->nwarn_note);
 173         print_warn_count("warning", wi->nwarn_warn);
 174
 175         gmx_fatal(f_errno, file, line, "There %s %d error%s in input file(s)",
 176                   (wi->nwarn_error == 1) ? "was" : "were", wi->nwarn_error,
 177                   (wi->nwarn_error == 1) ? ""    : "s");
 178     }
 179 }
 180
 181 void done_warning(warninp_t wi, int f_errno, const char *file, int line)
 182 {
 183     print_warn_count("note", wi->nwarn_note);
 184     print_warn_count("warning", wi->nwarn_warn);
 185
 186     check_warning_error(wi, f_errno, file, line);
 187
 188     if (wi->maxwarn >= 0 && wi->nwarn_warn > wi->maxwarn)
 189     {
 190         gmx_fatal(f_errno, file, line,
 191                   "Too many warnings (%d), %s terminated.\n"
 192                   "If you are sure all warnings are harmless, use the -maxwarn option.",
 193                   wi->nwarn_warn, ShortProgram());
 194     }
 195
 196     sfree(wi);
 197 }
 198
 199 void _too_few(warninp_t wi, const char *fn, int line)
 200 {
 201     char buf[STRLEN];
 202
 203     sprintf(buf,
 204             "Too few parameters on line (source file %s, line %d)",
 205             fn, line);
 206     warning(wi, buf);
 207 }
 208
 209 void _incorrect_n_param(warninp_t wi, const char *fn, int line)
 210 {
 211     char buf[STRLEN];
 212
 213     sprintf(buf,
 214             "Incorrect number of parameters on line (source file %s, line %d)",
 215             fn, line);
 216     warning(wi, buf);
 217 }