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