maint: update gnu-web-doc-update.

[bison.git] / src / system.h

diff --git a/src/system.h b/src/system.h
index cc2b09b22d14c280b58e2b18749f5cfd18c34188..d3c544b4720a36dea8a132feb3b407ab9293e7de 100644 (file)
--- a/src/system.h
+++ b/src/system.h
@@ -1,7 +1,6 @@
 /* System-dependent definitions for Bison.
 
 /* System-dependent definitions for Bison.
 

-   Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2009
-   Free Software Foundation, Inc.
+   Copyright (C) 2000-2007, 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
 
    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


@@ -17,105 +16,113 @@
    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
 
 #ifndef BISON_SYSTEM_H
    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
 
 #ifndef BISON_SYSTEM_H

-#define BISON_SYSTEM_H
+# define BISON_SYSTEM_H

 
 /* flex 2.5.31 gratutiously defines macros like INT8_MIN.  But this
    runs afoul of pre-C99 compilers that have <inttypes.h> or
    <stdint.h>, which are included below if available.  It also runs
    afoul of pre-C99 compilers that define these macros in <limits.h>.  */
 
 /* flex 2.5.31 gratutiously defines macros like INT8_MIN.  But this
    runs afoul of pre-C99 compilers that have <inttypes.h> or
    <stdint.h>, which are included below if available.  It also runs
    afoul of pre-C99 compilers that define these macros in <limits.h>.  */

-#if ! defined __STDC_VERSION__ || __STDC_VERSION__ < 199901
-# undef INT8_MIN
-# undef INT16_MIN
-# undef INT32_MIN
-# undef INT8_MAX
-# undef INT16_MAX
-# undef UINT8_MAX
-# undef INT32_MAX
-# undef UINT16_MAX
-# undef UINT32_MAX
-#endif
-
-#include <limits.h>
-#include <stddef.h>
-#include <stdlib.h>
-#include <string.h>
-
-#if HAVE_SYS_TYPES_H
-# include <sys/types.h>
-#endif
-
-#include <unistd.h>
-#include <inttypes.h>
-
-#ifndef UINTPTR_MAX
+# if ! defined __STDC_VERSION__ || __STDC_VERSION__ < 199901
+#  undef INT8_MIN
+#  undef INT16_MIN
+#  undef INT32_MIN
+#  undef INT8_MAX
+#  undef INT16_MAX
+#  undef UINT8_MAX
+#  undef INT32_MAX
+#  undef UINT16_MAX
+#  undef UINT32_MAX
+# endif
+
+# include <limits.h>
+# include <stddef.h>
+# include <stdlib.h>
+# include <string.h>
+
+# if HAVE_SYS_TYPES_H
+#  include <sys/types.h>
+# endif
+
+# include <unistd.h>
+# include <inttypes.h>
+
+# ifndef UINTPTR_MAX

 /* This isn't perfect, but it's good enough for Bison, which needs
    only to hash pointers.  */
 typedef size_t uintptr_t;
 /* This isn't perfect, but it's good enough for Bison, which needs
    only to hash pointers.  */
 typedef size_t uintptr_t;

-#endif
+# endif

 
 

+// Version mismatch.
+# define EX_MISMATCH 63

 
 /*---------.
 | Gnulib.  |
 `---------*/
 
 
 /*---------.
 | Gnulib.  |
 `---------*/
 

-#include <unlocked-io.h>
-#include <verify.h>
-#include <xalloc.h>
+# include <unlocked-io.h>
+# include <verify.h>
+# include <xalloc.h>

 
 
 /*-----------------.
 | GCC extensions.  |
 `-----------------*/
 
 
 
 /*-----------------.
 | GCC extensions.  |
 `-----------------*/
 

-/* Use this to suppress gcc's `...may be used before initialized'
-   warnings.  */
-#ifdef lint
-# define IF_LINT(Code) Code
-#else
-# define IF_LINT(Code) /* empty */
-#endif
-
-#ifndef __attribute__
+/* Use PACIFY_CC to indicate that Code is unimportant to the logic of Bison
+   but that it is necessary for suppressing compiler warnings.  For example,
+   Code might be a variable initializer that's always overwritten before the
+   variable is used.
+
+   PACIFY_CC is intended to be useful only as a comment as it does not alter
+   Code.  It is tempting to redefine PACIFY_CC so that it will suppress Code
+   when configuring without --enable-gcc-warnings.  However, that would mean
+   that, for maintainers, Bison would compile with potentially less warnings
+   and safer logic than it would for users.  Due to the overhead of M4,
+   suppressing Code is unlikely to offer any significant improvement in
+   Bison's performance anyway.  */
+# define PACIFY_CC(Code) Code
+
+# ifndef __attribute__

 /* This feature is available in gcc versions 2.5 and later.  */
 /* This feature is available in gcc versions 2.5 and later.  */

-# if (! defined __GNUC__ || __GNUC__ < 2 \
-      || (__GNUC__ == 2 && __GNUC_MINOR__ < 5) || __STRICT_ANSI__)
-#  define __attribute__(Spec) /* empty */
+#  if (! defined __GNUC__ || __GNUC__ < 2 \
+       || (__GNUC__ == 2 && __GNUC_MINOR__ < 5))
+#   define __attribute__(Spec) /* empty */
+#  endif

 # endif
 # endif

-#endif

 
 /* The __-protected variants of `format' and `printf' attributes
    are accepted by gcc versions 2.6.4 (effectively 2.7) and later.  */
 
 /* The __-protected variants of `format' and `printf' attributes
    are accepted by gcc versions 2.6.4 (effectively 2.7) and later.  */

-#if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7)
-# define __format__ format
-# define __printf__ printf
-#endif
+# if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7)
+#  define __format__ format
+#  define __printf__ printf
+# endif

 
 

-#ifndef ATTRIBUTE_NORETURN
-# define ATTRIBUTE_NORETURN __attribute__ ((__noreturn__))
-#endif
+# ifndef ATTRIBUTE_NORETURN
+#  define ATTRIBUTE_NORETURN __attribute__ ((__noreturn__))
+# endif

 
 

-#ifndef ATTRIBUTE_UNUSED
-# define ATTRIBUTE_UNUSED __attribute__ ((__unused__))
-#endif
+# ifndef ATTRIBUTE_UNUSED
+#  define ATTRIBUTE_UNUSED __attribute__ ((__unused__))
+# endif

 
 

-#define FUNCTION_PRINT() fprintf (stderr, "%s: ", __func__)
+# define FUNCTION_PRINT() fprintf (stderr, "%s: ", __func__)

 
 /*------.
 | NLS.  |
 `------*/
 
 
 /*------.
 | NLS.  |
 `------*/
 

-#include <locale.h>
+# include <locale.h>

 
 

-#include <gettext.h>
-#define _(Msgid)  gettext (Msgid)
-#define N_(Msgid) (Msgid)
+# include <gettext.h>
+# define _(Msgid)  gettext (Msgid)
+# define N_(Msgid) (Msgid)

 
 
 /*-----------.
 | Booleans.  |
 `-----------*/
 
 
 
 /*-----------.
 | Booleans.  |
 `-----------*/
 

-#include <stdbool.h>
+# include <stdbool.h>

 
 
 
 
 
 


@@ -123,49 +130,61 @@ typedef size_t uintptr_t;
 | Assertions.  |
 `-------------*/
 
 | Assertions.  |
 `-------------*/
 

-/* <assert.h>'s assertions are too heavyweight, and can be disabled
-   too easily, so use aver rather than assert.  */
-static inline void
-aver (bool assertion)
-{
-  if (! assertion)
-    abort ();
-}
+/* In the past, Bison defined aver to simply invoke abort in the case of
+   a failed assertion.  The rationale was that <assert.h>'s assertions
+   were too heavyweight and could be disabled too easily.  See
+   discussions at
+   <http://lists.gnu.org/archive/html/bison-patches/2006-01/msg00080.html>
+   <http://lists.gnu.org/archive/html/bison-patches/2006-09/msg00111.html>.
+
+   However, normal assert output can be helpful during development and
+   in bug reports from users.  Moreover, it's not clear now that
+   <assert.h>'s assertions are significantly heavyweight.  Finally, if
+   users want to experiment with disabling assertions, it's debatable
+   whether it's our responsibility to stop them.  See discussion
+   starting at
+   <http://lists.gnu.org/archive/html/bison-patches/2009-09/msg00013.html>.
+
+   For now, we use assert but we call it aver throughout Bison in case
+   we later wish to try another scheme.
+*/
+# include <assert.h>
+# define aver assert

 
 
 /*-----------.
 | Obstacks.  |
 `-----------*/
 
 
 
 /*-----------.
 | Obstacks.  |
 `-----------*/
 

-#define obstack_chunk_alloc xmalloc
-#define obstack_chunk_free  free
-#include <obstack.h>
+# define obstack_chunk_alloc xmalloc
+# define obstack_chunk_free  free
+# include <obstack.h>

 
 

-#define obstack_sgrow(Obs, Str) \
+# define obstack_sgrow(Obs, Str) \

   obstack_grow (Obs, Str, strlen (Str))
 
   obstack_grow (Obs, Str, strlen (Str))
 

-#define obstack_fgrow1(Obs, Format, Arg1)      \
+# define obstack_fgrow1(Obs, Format, Arg1)     \

 do {                                           \
   char buf[4096];                              \
   sprintf (buf, Format, Arg1);                 \
   obstack_grow (Obs, buf, strlen (buf));       \
 } while (0)
 
 do {                                           \
   char buf[4096];                              \
   sprintf (buf, Format, Arg1);                 \
   obstack_grow (Obs, buf, strlen (buf));       \
 } while (0)
 

-#define obstack_fgrow2(Obs, Format, Arg1, Arg2)        \
+# define obstack_fgrow2(Obs, Format, Arg1, Arg2)       \

 do {                                           \
   char buf[4096];                              \
   sprintf (buf, Format, Arg1, Arg2);           \
   obstack_grow (Obs, buf, strlen (buf));       \
 } while (0)
 
 do {                                           \
   char buf[4096];                              \
   sprintf (buf, Format, Arg1, Arg2);           \
   obstack_grow (Obs, buf, strlen (buf));       \
 } while (0)
 

-#define obstack_fgrow3(Obs, Format, Arg1, Arg2, Arg3)  \
+# define obstack_fgrow3(Obs, Format, Arg1, Arg2, Arg3) \

 do {                                                   \
   char buf[4096];                                      \
   sprintf (buf, Format, Arg1, Arg2, Arg3);             \
   obstack_grow (Obs, buf, strlen (buf));               \
 } while (0)
 
 do {                                                   \
   char buf[4096];                                      \
   sprintf (buf, Format, Arg1, Arg2, Arg3);             \
   obstack_grow (Obs, buf, strlen (buf));               \
 } while (0)
 

-#define obstack_fgrow4(Obs, Format, Arg1, Arg2, Arg3, Arg4)    \
+# define obstack_fgrow4(Obs, Format, Arg1, Arg2, Arg3, Arg4)   \

 do {                                                           \
   char buf[4096];                                              \
   sprintf (buf, Format, Arg1, Arg2, Arg3, Arg4);               \
 do {                                                           \
   char buf[4096];                                              \
   sprintf (buf, Format, Arg1, Arg2, Arg3, Arg4);               \


@@ -178,17 +197,17 @@ do {                                                              \
 | Extensions to use for the output files.  |
 `-----------------------------------------*/
 
 | Extensions to use for the output files.  |
 `-----------------------------------------*/
 

-#ifndef OUTPUT_EXT
-# define OUTPUT_EXT ".output"
-#endif
+# ifndef OUTPUT_EXT
+#  define OUTPUT_EXT ".output"
+# endif

 
 

-#ifndef TAB_EXT
-# define TAB_EXT ".tab"
-#endif
+# ifndef TAB_EXT
+#  define TAB_EXT ".tab"
+# endif

 
 

-#ifndef DEFAULT_TMPDIR
-# define DEFAULT_TMPDIR "/tmp"
-#endif
+# ifndef DEFAULT_TMPDIR
+#  define DEFAULT_TMPDIR "/tmp"
+# endif

 
 
 
 
 
 


@@ -196,7 +215,7 @@ do {                                                                \
 | Free a linked list.  |
 `---------------------*/
 
 | Free a linked list.  |
 `---------------------*/
 

-#define LIST_FREE(Type, List)                  \
+# define LIST_FREE(Type, List)                 \

 do {                                           \
   Type *_node, *_next;                         \
   for (_node = List; _node; _node = _next)     \
 do {                                           \
   Type *_node, *_next;                         \
   for (_node = List; _node; _node = _next)     \