src/complain.c

   1 /* Declaration for error-reporting function for Bison.
   2
   3    Copyright (C) 2000-2002, 2004-2006, 2009-2012 Free Software
   4    Foundation, Inc.
   5
   6    This program is free software: you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation, either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  18
  19 /* Based on error.c and error.h,
  20    written by David MacKenzie <djm@gnu.ai.mit.edu>.  */
  21
  22 #include <config.h>
  23 #include "system.h"
  24
  25 #include <stdarg.h>
  26 #include <progname.h>
  27
  28 #include "complain.h"
  29 #include "files.h"
  30 #include "getargs.h"
  31
  32 warnings warnings_flag =
  33   Wconflicts_sr | Wconflicts_rr | Wdeprecated  | Wother;
  34
  35 warnings errors_flag;
  36
  37 err_status complaint_status = status_none;
  38 static unsigned *indent_ptr = 0;
  39
  40 void
  41 warnings_print_categories (warnings warn_flags)
  42 {
  43   if (! (warn_flags & silent))
  44     {
  45       char const *warn_names[] =
  46         {
  47           "midrule-values",
  48           "yacc",
  49           "conflicts-sr",
  50           "conflicts-rr",
  51           "deprecated",
  52           "other"
  53         };
  54
  55       bool any = false;
  56       int i;
  57       for (i = 0; i < ARRAY_CARDINALITY (warn_names); ++i)
  58         if (warn_flags & 1 << i)
  59           {
  60             bool err = warn_flags & errors_flag;
  61             fprintf (stderr, "%s-W", any ? ", " : " [");
  62             fprintf (stderr, "%s%s", err ? "error=" : "" , warn_names[i]);
  63             any = true;
  64           }
  65       if (any)
  66         fprintf (stderr, "]");
  67     }
  68 }
  69
  70 /** Report an error message.
  71  *
  72  * \param loc     the location, defaulting to the current file,
  73  *                or the program name.
  74  * \param flags   the category for this message.
  75  * \param prefix  put before the message (e.g., "warning").
  76  * \param message the error message, a printf format string.  Iff it
  77  *                ends with ": ", then no trailing newline is printed,
  78  *                and the caller should print the remaining
  79  *                newline-terminated message to stderr.
  80  * \param args    the arguments of the format string.
  81  */
  82 static
  83 void
  84 error_message (const location *loc, warnings flags, const char *prefix,
  85                const char *message, va_list args)
  86 {
  87   unsigned pos = 0;
  88
  89   if (loc)
  90     pos += location_print (stderr, *loc);
  91   else
  92     pos += fprintf (stderr, "%s", current_file ? current_file : program_name);
  93   pos += fprintf (stderr, ": ");
  94
  95   if (indent_ptr)
  96     {
  97       if (*indent_ptr)
  98         prefix = NULL;
  99       if (!*indent_ptr)
 100         *indent_ptr = pos;
 101       else if (*indent_ptr > pos)
 102         fprintf (stderr, "%*s", *indent_ptr - pos, "");
 103       indent_ptr = 0;
 104     }
 105
 106   if (prefix)
 107     fprintf (stderr, "%s: ", prefix);
 108
 109   vfprintf (stderr, message, args);
 110   warnings_print_categories (flags);
 111   {
 112     size_t l = strlen (message);
 113     if (l < 2 || message[l - 2] != ':' || message[l - 1] != ' ')
 114       {
 115         putc ('\n', stderr);
 116         fflush (stderr);
 117         if (loc && feature_flag & feature_caret && !(flags & no_caret))
 118           location_caret (stderr, *loc);
 119       }
 120   }
 121   fflush (stderr);
 122 }
 123
 124 /** Raise a complaint. That can be a fatal error, a complaint or just a
 125     warning.  */
 126 static inline void
 127 complains (const location *loc, warnings flags, const char *message,
 128            va_list args)
 129 {
 130   const char* prefix =
 131     flags & fatal ? _("fatal error")
 132     : flags & (errors_flag | complaint) ? _("error")
 133     : _("warning");
 134
 135   if ((flags & complaint) && complaint_status < status_complaint)
 136     complaint_status = status_complaint;
 137   else if ((flags & (warnings_flag & errors_flag)) && ! complaint_status)
 138     complaint_status = status_warning_as_error;
 139   if (flags & (warnings_flag | fatal | complaint))
 140     error_message (loc, flags, prefix, message, args);
 141   if (flags & fatal)
 142     exit (EXIT_FAILURE);
 143 }
 144
 145 void
 146 complain (location const *loc, warnings flags, const char *message, ...)
 147 {
 148   va_list args;
 149   va_start (args, message);
 150   complains (loc, flags, message, args);
 151   va_end (args);
 152 }
 153
 154 void
 155 complain_indent (location const *loc, warnings flags, unsigned *indent,
 156                  const char *message, ...)
 157 {
 158   va_list args;
 159   indent_ptr = indent;
 160   va_start (args, message);
 161   complains (loc, flags, message, args);
 162   va_end (args);
 163 }
 164
 165 void
 166 complain_args (location const *loc, warnings w, unsigned *indent,
 167                int argc, char *argv[])
 168 {
 169   switch (argc)
 170   {
 171   case 1:
 172     complain_indent (loc, w, indent, "%s", _(argv[0]));
 173     break;
 174   case 2:
 175     complain_indent (loc, w, indent, _(argv[0]), argv[1]);
 176     break;
 177   case 3:
 178     complain_indent (loc, w, indent, _(argv[0]), argv[1], argv[2]);
 179     break;
 180   case 4:
 181     complain_indent (loc, w, indent, _(argv[0]), argv[1], argv[2], argv[3]);
 182     break;
 183   case 5:
 184     complain_indent (loc, w, indent, _(argv[0]), argv[1], argv[2], argv[3],
 185                      argv[4]);
 186     break;
 187   default:
 188     complain (loc, fatal, "too many arguments for complains");
 189     break;
 190   }
 191 }