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 /*-------------.
  25 | --warnings.  |
  26 `-------------*/
  27
  28 typedef enum
  29   {
  30     Wnone             = 0,       /**< Issue no warnings.  */
  31     Wmidrule_values   = 1 << 0,  /**< Unset or unused midrule values.  */
  32     Wyacc             = 1 << 1,  /**< POSIXME.  */
  33     Wconflicts_sr     = 1 << 2,  /**< S/R conflicts.  */
  34     Wconflicts_rr     = 1 << 3,  /**< R/R conflicts.  */
  35     Wdeprecated       = 1 << 4,  /**< Obsolete constructs.  */
  36     Wother            = 1 << 5,  /**< All other warnings.  */
  37
  38     /* Deprecated, this option now uses a second instance of this enum */
  39     Werror            = 1 << 10, /**< Warnings are treated as errors.  */
  40
  41     complaint         = 1 << 11, /**< All complaints.  */
  42     fatal             = 1 << 12, /**< All fatal errors.  */
  43     silent            = 1 << 13, /**< Do not display the warning type.  */
  44
  45     /**< All above warnings.  */
  46     Wall              = ~complaint & ~fatal & ~silent
  47   } warnings;
  48
  49 /** What warnings are issued.  */
  50 extern warnings warnings_flag;
  51
  52 /** What warnings are made errors.  */
  53 extern warnings errors_flag;
  54
  55 /** Display a "[-Wyacc]" like message on stderr.  */
  56 void warnings_print_categories (warnings warn_flags);
  57
  58 /** Record that a warning is about to be issued, and treat it as an
  59     error if <tt>warnings_flag & Werror</tt>.  This is exported
  60     only for the sake of Yacc-compatible conflict reports in conflicts.c.
  61     All other warnings should be implemented in complain.c and should use
  62     the normal warning format.  */
  63 void set_warning_issued (warnings warning);
  64
  65 /** Make a complaint, but don't specify any location.  */
  66 void complain (warnings flags, char const *message, ...)
  67   __attribute__ ((__format__ (__printf__, 2, 3)));
  68
  69 /** Make a complaint with location.  */
  70 void complain_at (location loc, warnings flags, char const *message, ...)
  71   __attribute__ ((__format__ (__printf__, 3, 4)));
  72
  73 /** Make a complaint with location and some indentation.  */
  74 void complain_at_indent (location loc, warnings flags, unsigned *indent,
  75                          char const *message, ...)
  76   __attribute__ ((__format__ (__printf__, 4, 5)));
  77
  78 /** Whether an error was reported.  */
  79 extern bool complaint_issued;
  80
  81 #endif /* !COMPLAIN_H_ */