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