doc: clean up references to `Tracking Locations'.

[bison.git] / src / complain.h

diff --git a/src/complain.h b/src/complain.h
index 79a3e122a8ebfadc0742fcbe4d4c1fe2bbf26c32..07d401cbb193385dff37ac428f6bf78f876baf5e 100644 (file)
--- a/src/complain.h
+++ b/src/complain.h
@@ -1,10 +1,12 @@
 /* Declaration for error-reporting function for Bison.
-   Copyright 2000, 2001 Free Software Foundation, Inc.
 
-   This program is free software; you can redistribute it and/or modify it
-   under the terms of the GNU General Public License as published by the
-   Free Software Foundation; either version 2, or (at your option) any
-   later version.
+   Copyright (C) 2000-2002, 2006, 2009-2011 Free Software Foundation,
+   Inc.
+
+   This program is free software: you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation, either version 3 of the License, or
+   (at your option) any later version.
 
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ -12,64 +14,80 @@
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software
-   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
-   USA.  */
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
 
 #ifndef COMPLAIN_H_
-#define COMPLAIN_H_ 1
+# define COMPLAIN_H_ 1
+
+# include "location.h"
 
-#ifdef __cplusplus
+# ifdef        __cplusplus
 extern "C" {
-#endif
+# endif
 
-#ifdef __STDC__
+/** Record that a warning is about to be issued, and treat it as an
+    error if <tt>warnings_flag & warnings_error</tt>.  This is exported
+    only for the sake of Yacc-compatible conflict reports in conflicts.c.
+    All other warnings should be implemented in complain.c and should use
+    the normal warning format.  */
+void set_warning_issued (void);
 
-/* Informative messages, but we proceed. */
+/** Informative messages, but we proceed.  Report iff
+    <tt>warnings_flag & warnings_other</tt>.  */
 
-void warn (const char *format, ...)
+void warn (char const *format, ...)
   __attribute__ ((__format__ (__printf__, 1, 2)));
 
-void warn_at (int location, const char *format, ...)
+void warn_at (location loc, char const *format, ...)
   __attribute__ ((__format__ (__printf__, 2, 3)));
 
-/* Something bad happen, but let's continue and die later. */
+/* Generate a message aligned by an indent.
+   When *indent == 0, assign message's indent to *indent,
+   When *indent > 0, align the message by *indent value. */
+void warn_at_indent (location loc, unsigned *indent,
+                     char const *format, ...)
+  __attribute__ ((__format__ (__printf__, 3, 4)));
 
-void complain (const char *format, ...)
+/** An error, but we continue and die later.  */
+
+void complain (char const *format, ...)
   __attribute__ ((__format__ (__printf__, 1, 2)));
 
-void complain_at (int location, const char *format, ...)
+void complain_at (location loc, char const *format, ...)
   __attribute__ ((__format__ (__printf__, 2, 3)));
 
-/* Something bad happen and we die now. */
+/* Generate a message aligned by an indent.
+   When *indent == 0, assign message's indent to *indent,
+   When *indent > 0, align the message by *indent value. */
+void complain_at_indent (location loc, unsigned *indent,
+                         char const *format, ...)
+  __attribute__ ((__format__ (__printf__, 3, 4)));
 
-void fatal (const char *format, ...)
-  __attribute__ ((__format__ (__printf__, 1, 2)));
+/** An incompatibility with POSIX Yacc: mapped either to warn* or
+    complain* depending on yacc_flag. */
+
+void yacc_at (location loc, char const *format, ...)
+  __attribute__ ((__format__ (__printf__, 2, 3)));
+
+/** A midrule-value warning.  Report iff
+    <tt>warnings_flag & warnings_midrule_values</tt>.  */
 
-void fatal_at (int location, const char *format, ...)
+void midrule_value_at (location loc, char const *format, ...)
   __attribute__ ((__format__ (__printf__, 2, 3)));
 
-#else
-void warn ();
-void warn_at ();
-void complain ();
-void complain_at ();
-void fatal ();
-void fatal_at ();
-#endif
+/** A fatal error, causing immediate exit.  */
 
-/* Position in the current input file. */
-extern char *infile;
-extern int lineno;
+void fatal (char const *format, ...)
+  __attribute__ ((__noreturn__, __format__ (__printf__, 1, 2)));
 
-/* This variable is incremented each time `warn' is called.  */
-extern unsigned int warn_message_count;
+void fatal_at (location loc, char const *format, ...)
+  __attribute__ ((__noreturn__, __format__ (__printf__, 2, 3)));
 
-/* This variable is incremented each time `complain' is called.  */
-extern unsigned int complain_message_count;
+/** Whether an error was reported.  */
+extern bool complaint_issued;
 
-#ifdef __cplusplus
+# ifdef        __cplusplus
 }
-#endif
+# endif
 
 #endif /* !COMPLAIN_H_ */