src/complain.h

   1 /* Declaration for error-reporting function for Bison.
   2
   3    Copyright (C) 2000-2002, 2006, 2009-2011 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 /** Informative messages, but we proceed.  Report iff
  29     <tt>warnings_flag & warnings_other</tt>.  */
  30
  31 void warn (char const *format, ...)
  32   __attribute__ ((__format__ (__printf__, 1, 2)));
  33
  34 void warn_at (location loc, char const *format, ...)
  35   __attribute__ ((__format__ (__printf__, 2, 3)));
  36
  37 /* Generate a message aligned by an indent.
  38    When *indent == 0, assign message's indent to *indent,
  39    When *indent > 0, align the message by *indent value. */
  40 void warn_at_indent (location loc, unsigned *indent,
  41                      char const *format, ...)
  42   __attribute__ ((__format__ (__printf__, 3, 4)));
  43
  44 /** An error, but we continue and die later.  */
  45
  46 void complain (char const *format, ...)
  47   __attribute__ ((__format__ (__printf__, 1, 2)));
  48
  49 void complain_at (location loc, char const *format, ...)
  50   __attribute__ ((__format__ (__printf__, 2, 3)));
  51
  52 /* Generate a message aligned by an indent.
  53    When *indent == 0, assign message's indent to *indent,
  54    When *indent > 0, align the message by *indent value. */
  55 void complain_at_indent (location loc, unsigned *indent,
  56                          char const *format, ...)
  57   __attribute__ ((__format__ (__printf__, 3, 4)));
  58
  59 /** An incompatibility with POSIX Yacc: mapped either to warn* or
  60     complain* depending on yacc_flag. */
  61
  62 void yacc_at (location loc, char const *format, ...)
  63   __attribute__ ((__format__ (__printf__, 2, 3)));
  64
  65 /** A midrule-value warning.  Report iff
  66     <tt>warnings_flag & warnings_midrule_values</tt>.  */
  67
  68 void midrule_value_at (location loc, char const *format, ...)
  69   __attribute__ ((__format__ (__printf__, 2, 3)));
  70
  71 /** A fatal error, causing immediate exit.  */
  72
  73 void fatal (char const *format, ...)
  74   __attribute__ ((__noreturn__, __format__ (__printf__, 1, 2)));
  75
  76 void fatal_at (location loc, char const *format, ...)
  77   __attribute__ ((__noreturn__, __format__ (__printf__, 2, 3)));
  78
  79 /** Whether an error was reported.  */
  80 extern bool complaint_issued;
  81
  82 # ifdef __cplusplus
  83 }
  84 # endif
  85
  86 #endif /* !COMPLAIN_H_ */