diagnostics: factor the deprecated directive message

[bison.git] / src / complain.h

diff --git a/src/complain.h b/src/complain.h
index 79a3e122a8ebfadc0742fcbe4d4c1fe2bbf26c32..2222aca20b80ea06755985fcf73369560a0ea2ab 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-2012 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,79 @@
    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
-extern "C" {
-#endif
+/* Sub-messages indent. */
+# define SUB_INDENT (4)
 
-#ifdef __STDC__
+/*-------------.
+| --warnings.  |
+`-------------*/
 
-/* Informative messages, but we proceed. */
+typedef enum
+  {
+    Wnone             = 0,       /**< Issue no warnings.  */
+    Wmidrule_values   = 1 << 0,  /**< Unset or unused midrule values.  */
+    Wyacc             = 1 << 1,  /**< POSIXME.  */
+    Wconflicts_sr     = 1 << 2,  /**< S/R conflicts.  */
+    Wconflicts_rr     = 1 << 3,  /**< R/R conflicts.  */
+    Wdeprecated       = 1 << 4,  /**< Obsolete constructs.  */
+    Wother            = 1 << 5,  /**< All other warnings.  */
 
-void warn (const char *format, ...)
-  __attribute__ ((__format__ (__printf__, 1, 2)));
+    Werror            = 1 << 10, /** This bit is no longer used. */
 
-void warn_at (int location, const char *format, ...)
-  __attribute__ ((__format__ (__printf__, 2, 3)));
+    complaint         = 1 << 11, /**< All complaints.  */
+    fatal             = 1 << 12, /**< All fatal errors.  */
+    silent            = 1 << 13, /**< Do not display the warning type.  */
+    no_caret          = 1 << 14, /**< Do not display caret location.  */
 
-/* Something bad happen, but let's continue and die later. */
+    /**< All above warnings.  */
+    Wall              = ~complaint & ~fatal & ~silent
+  } warnings;
 
-void complain (const char *format, ...)
-  __attribute__ ((__format__ (__printf__, 1, 2)));
+/** What warnings are issued.  */
+extern warnings warnings_flag;
 
-void complain_at (int location, const char *format, ...)
-  __attribute__ ((__format__ (__printf__, 2, 3)));
+/** What warnings are made errors.  */
+extern warnings errors_flag;
 
-/* Something bad happen and we die now. */
+/** Display a "[-Wyacc]" like message on stderr.  */
+void warnings_print_categories (warnings warn_flags);
 
-void fatal (const char *format, ...)
-  __attribute__ ((__format__ (__printf__, 1, 2)));
+/** Make a complaint, with maybe a location.  */
+void complain (location const *loc, warnings flags, char const *message, ...)
+  __attribute__ ((__format__ (__printf__, 3, 4)));
 
-void fatal_at (int location, const char *format, ...)
-  __attribute__ ((__format__ (__printf__, 2, 3)));
+/** Likewise, but with an \a argc/argv interface.  */
+void complain_args (location const *loc, warnings w, unsigned *indent,
+                    int argc, char *arg[]);
 
-#else
-void warn ();
-void warn_at ();
-void complain ();
-void complain_at ();
-void fatal ();
-void fatal_at ();
-#endif
+/** Make a complaint with location and some indentation.  */
+void complain_indent (location const *loc, warnings flags, unsigned *indent,
+                      char const *message, ...)
+  __attribute__ ((__format__ (__printf__, 4, 5)));
 
-/* Position in the current input file. */
-extern char *infile;
-extern int lineno;
 
-/* This variable is incremented each time `warn' is called.  */
-extern unsigned int warn_message_count;
+/** Report an obsolete syntax, suggest the updated one.  */
+void deprecated_directive (location const *loc,
+                           char const *obsolete, char const *updated);
 
-/* This variable is incremented each time `complain' is called.  */
-extern unsigned int complain_message_count;
+/** Warnings treated as errors shouldn't stop the execution as regular errors
+    should (because due to their nature, it is safe to go on). Thus, there are
+    three possible execution statuses.  */
+typedef enum
+  {
+    status_none,
+    status_warning_as_error,
+    status_complaint
+  } err_status;
 
-#ifdef __cplusplus
-}
-#endif
+/** Whether an error was reported.  */
+extern err_status complaint_status;
 
 #endif /* !COMPLAIN_H_ */