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