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