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 bool complaint_issued;
  33 static unsigned *indent_ptr = 0;
  34
  35 \f
  36
  37 /** Report an error message.
  38  *
  39  * \param loc     the location, defaulting to the current file,
  40  *                or the program name.
  41  * \param prefix  put before the message (e.g., "warning").
  42  * \param message the error message, a printf format string.  Iff it
  43  *                ends with ": ", then no trailing newline is printed,
  44  *                and the caller should print the remaining
  45  *                newline-terminated message to stderr.
  46  * \param args    the arguments of the format string.
  47  */
  48 static
  49 void
  50 error_message (location *loc,
  51                const char *prefix,
  52                const char *message, va_list args)
  53 {
  54   unsigned pos = 0;
  55
  56   if (loc)
  57     pos += location_print (stderr, *loc);
  58   else
  59     pos += fprintf(stderr, "%s", current_file ? current_file : program_name);
  60   pos += fprintf(stderr, ": ");
  61
  62   if (indent_ptr)
  63     {
  64       if (!*indent_ptr)
  65         *indent_ptr = pos;
  66       else if (*indent_ptr > pos)
  67         fprintf (stderr, "%*s", *indent_ptr - pos, "");
  68       indent_ptr = 0;
  69     }
  70
  71   if (prefix)
  72     fprintf (stderr, "%s: ", prefix);
  73
  74   vfprintf (stderr, message, args);
  75   {
  76     size_t l = strlen (message);
  77     if (l < 2 || message[l-2] != ':' || message[l-1] != ' ')
  78       {
  79         putc ('\n', stderr);
  80         fflush (stderr);
  81       }
  82   }
  83 }
  84
  85 /** Wrap error_message() with varargs handling. */
  86 #define ERROR_MESSAGE(Loc, Prefix, Message)     \
  87 {                                               \
  88   va_list args;                                 \
  89   va_start (args, Message);                     \
  90   error_message (Loc, Prefix, Message, args);   \
  91   va_end (args);                                \
  92 }
  93
  94
  95 /*--------------------------------.
  96 | Report a warning, and proceed.  |
  97 `--------------------------------*/
  98
  99 void
 100 set_warning_issued (void)
 101 {
 102   static bool warning_issued = false;
 103   if (!warning_issued && (warnings_flag & warnings_error))
 104     {
 105       fprintf (stderr, "%s: warnings being treated as errors\n", program_name);
 106       complaint_issued = true;
 107     }
 108   warning_issued = true;
 109 }
 110
 111 void
 112 warn_at (location loc, const char *message, ...)
 113 {
 114   if (!(warnings_flag & warnings_other))
 115     return;
 116   set_warning_issued ();
 117   ERROR_MESSAGE (&loc, _("warning"), message);
 118 }
 119
 120 void
 121 warn_at_indent (location loc, unsigned *indent,
 122                 const char *message, ...)
 123 {
 124   if (!(warnings_flag & warnings_other))
 125     return;
 126   set_warning_issued ();
 127   indent_ptr = indent;
 128   ERROR_MESSAGE (&loc, _("warning"), message);
 129 }
 130
 131 void
 132 warn (const char *message, ...)
 133 {
 134   if (!(warnings_flag & warnings_other))
 135     return;
 136   set_warning_issued ();
 137   ERROR_MESSAGE (NULL, _("warning"), message);
 138 }
 139
 140
 141 /*-----------------------------------------------------------.
 142 | An error has occurred, but we can proceed, and die later.  |
 143 `-----------------------------------------------------------*/
 144
 145 void
 146 complain_at (location loc, const char *message, ...)
 147 {
 148   ERROR_MESSAGE (&loc, NULL, message);
 149   complaint_issued = true;
 150 }
 151
 152 void
 153 complain_at_indent (location loc, unsigned *indent,
 154                     const char *message, ...)
 155 {
 156   indent_ptr = indent;
 157   ERROR_MESSAGE (&loc, NULL, message);
 158   complaint_issued = true;
 159 }
 160
 161 void
 162 complain (const char *message, ...)
 163 {
 164   ERROR_MESSAGE (NULL, NULL, message);
 165   complaint_issued = true;
 166 }
 167
 168
 169 /*--------------------------------------------------------------.
 170 | An incompatibility with POSIX Yacc: mapped either to warn* or |
 171 | complain* depending on yacc_flag.                             |
 172 `--------------------------------------------------------------*/
 173
 174 void
 175 yacc_at (location loc, const char *message, ...)
 176 {
 177   if (yacc_flag)
 178     {
 179       ERROR_MESSAGE (&loc, NULL, message);
 180       complaint_issued = true;
 181     }
 182   else if (warnings_flag & warnings_yacc)
 183     {
 184       set_warning_issued ();
 185       ERROR_MESSAGE (&loc, _("warning"), message);
 186     }
 187 }
 188
 189 void
 190 midrule_value_at (location loc, const char *message, ...)
 191 {
 192   if (!(warnings_flag & warnings_midrule_values))
 193     return;
 194   set_warning_issued ();
 195   ERROR_MESSAGE (&loc, _("warning"), message);
 196 }
 197
 198 /*-------------------------------------------------.
 199 | A severe error has occurred, we cannot proceed.  |
 200 `-------------------------------------------------*/
 201
 202 void
 203 fatal_at (location loc, const char *message, ...)
 204 {
 205   ERROR_MESSAGE (&loc, _("fatal error"), message);
 206   exit (EXIT_FAILURE);
 207 }
 208
 209 void
 210 fatal (const char *message, ...)
 211 {
 212   ERROR_MESSAGE (NULL, _("fatal error"), message);
 213   exit (EXIT_FAILURE);
 214 }