src/complain.c

   1 /* Declaration for error-reporting function for Bison.
   2
   3    Copyright (C) 2000-2002, 2004-2006, 2009-2013 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 #include "quote.h"
  32
  33 warnings warnings_flag =
  34   Wconflicts_sr | Wconflicts_rr | Wdeprecated  | Wother;
  35
  36 warnings errors_flag;
  37
  38 err_status complaint_status = status_none;
  39 static unsigned *indent_ptr = 0;
  40
  41 void
  42 warnings_print_categories (warnings warn_flags)
  43 {
  44   if (! (warn_flags & silent))
  45     {
  46       char const *warn_names[] =
  47         {
  48           "midrule-values",
  49           "yacc",
  50           "conflicts-sr",
  51           "conflicts-rr",
  52           "deprecated",
  53           "precedence",
  54           "other"
  55         };
  56
  57       bool any = false;
  58       int i;
  59       for (i = 0; i < ARRAY_CARDINALITY (warn_names); ++i)
  60         if (warn_flags & 1 << i)
  61           {
  62             bool err = warn_flags & errors_flag;
  63             fprintf (stderr, "%s-W", any ? ", " : " [");
  64             fprintf (stderr, "%s%s", err ? "error=" : "" , warn_names[i]);
  65             any = true;
  66           }
  67       if (any)
  68         fprintf (stderr, "]");
  69     }
  70 }
  71
  72 /** Report an error message.
  73  *
  74  * \param loc     the location, defaulting to the current file,
  75  *                or the program name.
  76  * \param flags   the category for this message.
  77  * \param prefix  put before the message (e.g., "warning").
  78  * \param message the error message, a printf format string.  Iff it
  79  *                ends with ": ", then no trailing newline is printed,
  80  *                and the caller should print the remaining
  81  *                newline-terminated message to stderr.
  82  * \param args    the arguments of the format string.
  83  */
  84 static
  85 void
  86 error_message (const location *loc, warnings flags, const char *prefix,
  87                const char *message, va_list args)
  88 {
  89   unsigned pos = 0;
  90
  91   if (loc)
  92     pos += location_print (*loc, stderr);
  93   else
  94     pos += fprintf (stderr, "%s", current_file ? current_file : program_name);
  95   pos += fprintf (stderr, ": ");
  96
  97   if (indent_ptr)
  98     {
  99       if (*indent_ptr)
 100         prefix = NULL;
 101       if (!*indent_ptr)
 102         *indent_ptr = pos;
 103       else if (*indent_ptr > pos)
 104         fprintf (stderr, "%*s", *indent_ptr - pos, "");
 105       indent_ptr = 0;
 106     }
 107
 108   if (prefix)
 109     fprintf (stderr, "%s: ", prefix);
 110
 111   vfprintf (stderr, message, args);
 112   warnings_print_categories (flags);
 113   {
 114     size_t l = strlen (message);
 115     if (l < 2 || message[l - 2] != ':' || message[l - 1] != ' ')
 116       {
 117         putc ('\n', stderr);
 118         fflush (stderr);
 119         if (loc && feature_flag & feature_caret && !(flags & no_caret))
 120           location_caret (*loc, stderr);
 121       }
 122   }
 123   fflush (stderr);
 124 }
 125
 126 /** Raise a complaint. That can be a fatal error, a complaint or just a
 127     warning.  */
 128 static inline void
 129 complains (const location *loc, warnings flags, const char *message,
 130            va_list args)
 131 {
 132   const char* prefix =
 133     flags & fatal ? _("fatal error")
 134     : flags & (errors_flag | complaint) ? _("error")
 135     : _("warning");
 136
 137   if ((flags & complaint) && complaint_status < status_complaint)
 138     complaint_status = status_complaint;
 139   else if ((flags & (warnings_flag & errors_flag)) && ! complaint_status)
 140     complaint_status = status_warning_as_error;
 141   if (flags & (warnings_flag | fatal | complaint))
 142     error_message (loc, flags, prefix, message, args);
 143   if (flags & fatal)
 144     exit (EXIT_FAILURE);
 145 }
 146
 147 void
 148 complain (location const *loc, warnings flags, const char *message, ...)
 149 {
 150   va_list args;
 151   va_start (args, message);
 152   complains (loc, flags, message, args);
 153   va_end (args);
 154 }
 155
 156 void
 157 complain_indent (location const *loc, warnings flags, unsigned *indent,
 158                  const char *message, ...)
 159 {
 160   va_list args;
 161   indent_ptr = indent;
 162   va_start (args, message);
 163   complains (loc, flags, message, args);
 164   va_end (args);
 165 }
 166
 167 void
 168 complain_args (location const *loc, warnings w, unsigned *indent,
 169                int argc, char *argv[])
 170 {
 171   switch (argc)
 172   {
 173   case 1:
 174     complain_indent (loc, w, indent, "%s", _(argv[0]));
 175     break;
 176   case 2:
 177     complain_indent (loc, w, indent, _(argv[0]), argv[1]);
 178     break;
 179   case 3:
 180     complain_indent (loc, w, indent, _(argv[0]), argv[1], argv[2]);
 181     break;
 182   case 4:
 183     complain_indent (loc, w, indent, _(argv[0]), argv[1], argv[2], argv[3]);
 184     break;
 185   case 5:
 186     complain_indent (loc, w, indent, _(argv[0]), argv[1], argv[2], argv[3],
 187                      argv[4]);
 188     break;
 189   default:
 190     complain (loc, fatal, "too many arguments for complains");
 191     break;
 192   }
 193
 194 }
 195
 196 void
 197 deprecated_directive (location const *loc, char const *old, char const *upd)
 198 {
 199   if (feature_flag & feature_caret)
 200     complain (loc, Wdeprecated,
 201               _("deprecated directive, use %s"),
 202               quote_n (1, upd));
 203   else
 204     complain (loc, Wdeprecated,
 205               _("deprecated directive: %s, use %s"),
 206               quote (old), quote_n (1, upd));
 207 }