src/complain.h

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