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