src/complain.h

   1 /* Declaration for error-reporting function for Bison.
   2
   3    Copyright (C) 2000-2002, 2006, 2009-2012 Free Software Foundation,
   4    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 #ifndef COMPLAIN_H_
  20 # define COMPLAIN_H_ 1
  21
  22 # include "location.h"
  23
  24 # ifdef __cplusplus
  25 extern "C" {
  26 # endif
  27
  28 /*-------------.
  29 | --warnings.  |
  30 `-------------*/
  31
  32 enum warnings
  33   {
  34     Wnone             = 0,      /**< Issue no warnings.  */
  35     Werror            = 1 << 0, /**< Warnings are treated as errors.  */
  36     Wmidrule_values   = 1 << 1, /**< Unset or unused midrule values.  */
  37     Wyacc             = 1 << 2, /**< POSIXME.  */
  38     Wconflicts_sr     = 1 << 3, /**< S/R conflicts.  */
  39     Wconflicts_rr     = 1 << 4, /**< R/R conflicts.  */
  40     Wother            = 1 << 5, /**< All other warnings.  */
  41     Wall              = ~Werror /**< All above warnings.  */
  42   };
  43
  44 /** What warnings are issued.  */
  45 extern int warnings_flag;
  46
  47 /** Record that a warning is about to be issued, and treat it as an
  48     error if <tt>warnings_flag & Werror</tt>.  This is exported
  49     only for the sake of Yacc-compatible conflict reports in conflicts.c.
  50     All other warnings should be implemented in complain.c and should use
  51     the normal warning format.  */
  52 void set_warning_issued (void);
  53
  54 /** Informative messages, but we proceed.  Report iff
  55     <tt>warnings_flag & Wother</tt>.  */
  56
  57 void warn (char const *format, ...)
  58   __attribute__ ((__format__ (__printf__, 1, 2)));
  59
  60 void warn_at (location loc, char const *format, ...)
  61   __attribute__ ((__format__ (__printf__, 2, 3)));
  62
  63 /* Generate a message aligned by an indent.
  64    When *indent == 0, assign message's indent to *indent,
  65    When *indent > 0, align the message by *indent value. */
  66 void warn_at_indent (location loc, unsigned *indent,
  67                      char const *format, ...)
  68   __attribute__ ((__format__ (__printf__, 3, 4)));
  69
  70 /** An error, but we continue and die later.  */
  71
  72 void complain (char const *format, ...)
  73   __attribute__ ((__format__ (__printf__, 1, 2)));
  74
  75 void complain_at (location loc, char const *format, ...)
  76   __attribute__ ((__format__ (__printf__, 2, 3)));
  77
  78 /* Generate a message aligned by an indent.
  79    When *indent == 0, assign message's indent to *indent,
  80    When *indent > 0, align the message by *indent value. */
  81 void complain_at_indent (location loc, unsigned *indent,
  82                          char const *format, ...)
  83   __attribute__ ((__format__ (__printf__, 3, 4)));
  84
  85 /** An incompatibility with POSIX Yacc: mapped either to warn* or
  86     complain* depending on yacc_flag. */
  87
  88 void yacc_at (location loc, char const *format, ...)
  89   __attribute__ ((__format__ (__printf__, 2, 3)));
  90
  91 /** A midrule-value warning.  Report iff
  92     <tt>warnings_flag & Wmidrule_values</tt>.  */
  93
  94 void midrule_value_at (location loc, char const *format, ...)
  95   __attribute__ ((__format__ (__printf__, 2, 3)));
  96
  97 /** A fatal error, causing immediate exit.  */
  98
  99 void fatal (char const *format, ...)
 100   __attribute__ ((__noreturn__, __format__ (__printf__, 1, 2)));
 101
 102 void fatal_at (location loc, char const *format, ...)
 103   __attribute__ ((__noreturn__, __format__ (__printf__, 2, 3)));
 104
 105 /** Whether an error was reported.  */
 106 extern bool complaint_issued;
 107
 108 # ifdef __cplusplus
 109 }
 110 # endif
 111
 112 #endif /* !COMPLAIN_H_ */