Merge remote-tracking branch 'origin/maint'

[bison.git] / src / system.h

diff --git a/src/system.h b/src/system.h
index 9c8ac08e281b8e8a0929ae3ff0fa7fd938c1b4e9..987ebe2adb2c5368424fd0f8c14503006276912e 100644 (file)
--- a/src/system.h
+++ b/src/system.h
@@ -1,10 +1,11 @@
-/* system-dependent definitions for Bison.
-   Copyright (C) 2000 Free Software Foundation, Inc.
+/* System-dependent definitions for Bison.

 
 

-   This program is free software; you can redistribute it and/or modify
+   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
    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.
+   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
 
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of


@@ -12,79 +13,109 @@
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    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 BISON_SYSTEM_H
 #define BISON_SYSTEM_H
 
 
 #ifndef BISON_SYSTEM_H
 #define BISON_SYSTEM_H
 

-#ifdef HAVE_CONFIG_H
-# include <config.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
 
 #endif
 

-#include <stdio.h>
+#include <limits.h>
+#include <stddef.h>
+#include <stdlib.h>
+#include <string.h>

 
 

-#ifdef MSDOS
-# include <io.h>
-#endif
+#define ARRAY_CARDINALITY(Array) (sizeof (Array) / sizeof *(Array))
+#define STREQ(L, R)  (strcmp(L, R) == 0)
+#define STRNEQ(L, R) (!STREQ(L, R))

 
 

-#ifdef _MSC_VER
-# include <stdlib.h>
-# include <process.h>
-# define getpid _getpid
-#endif
+/* Just like strncmp, but the second argument must be a literal string
+   and you don't specify the length.  */
+#define STRNCMP_LIT(S, Literal)                         \
+  strncmp (S, "" Literal "", sizeof (Literal) - 1)

 
 

-#if defined(HAVE_STDLIB_H) || defined(MSDOS)
-# include <stdlib.h>
-#endif
+/* Whether Literal is a prefix of S.  */
+#define STRPREFIX_LIT(Literal, S)               \
+  (STRNCMP_LIT (S, Literal) == 0)

 
 

-#if defined(HAVE_UNISTD_H)
-# include <unistd.h>
-#endif
+#include <unistd.h>
+#include <inttypes.h>
+
+#define ARRAY_CARDINALITY(Array) (sizeof (Array) / sizeof *(Array))
+#define STREQ(L, R)  (strcmp(L, R) == 0)
+#define STRNEQ(L, R) (!STREQ(L, R))

 
 

-#if (defined(VMS) || defined(MSDOS)) && !defined(HAVE_STRING_H)
-# define HAVE_STRING_H 1
+#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;

 #endif
 
 #endif
 

-#if defined(STDC_HEADERS) || defined(HAVE_STRING_H)
-# include <string.h>
-/* An ANSI string.h and pre-ANSI memory.h might conflict.  */
-# if !defined(STDC_HEADERS) && defined(HAVE_MEMORY_H)
-#  include <memory.h>
-# endif /* not STDC_HEADERS and HAVE_MEMORY_H */
-# ifndef bcopy
-#  define bcopy(src, dst, num) memcpy((dst), (src), (num))
-# endif
-#else /* not STDC_HEADERS and not HAVE_STRING_H */
-# include <strings.h>
-/* memory.h and strings.h conflict on some systems.  */
-#endif /* not STDC_HEADERS and not HAVE_STRING_H */
+// Version mismatch.
+#define EX_MISMATCH 63

 
 

-#if defined(STDC_HEADERS) || defined(HAVE_CTYPE_H)
-# include <ctype.h>
-#endif
+/*---------.
+| Gnulib.  |
+`---------*/

 
 

-#include <errno.h>
-#ifndef errno
-extern int errno;
-#endif
+#include <unlocked-io.h>
+#include <verify.h>
+#include <xalloc.h>

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

+/* 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.  */
 #ifndef __attribute__
 /* This feature is available in gcc versions 2.5 and later.  */

-# if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 5) || __STRICT_ANSI__
+# if (! defined __GNUC__ || __GNUC__ < 2 \
+       || (__GNUC__ == 2 && __GNUC_MINOR__ < 5))

 #  define __attribute__(Spec) /* empty */
 # endif
 #  define __attribute__(Spec) /* empty */
 # 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_UNUSED
+# define ATTRIBUTE_UNUSED __attribute__ ((__unused__))

 #endif
 
 
 #endif
 
 


@@ -92,58 +123,143 @@ extern int errno;
 | NLS.  |
 `------*/
 
 | NLS.  |
 `------*/
 

-#ifdef HAVE_LOCALE_H
-# include <locale.h>
-#endif
-#ifndef HAVE_SETLOCALE
-# define setlocale(Category, Locale)
-#endif
+#include <locale.h>

 
 

-#ifdef ENABLE_NLS
-# include <libintl.h>
-# define _(Text) gettext (Text)
-#else
-# undef bindtextdomain
-# define bindtextdomain(Domain, Directory)
-# undef textdomain
-# define textdomain(Domain)
-# define _(Text) Text
-#endif
-#define N_(Text) Text
+#include <gettext.h>
+#define _(Msgid)  gettext (Msgid)
+#define N_(Msgid) (Msgid)

 
 
 
 

-/*-------------------------------.
-| Fix broken compilation flags.  |
-`-------------------------------*/
+/*-----------.
+| Booleans.  |
+`-----------*/

 
 

-#ifndef LOCALEDIR
-# define LOCALEDIR "/usr/local/share/locale"
-#endif
+#include <stdbool.h>
+
+
+
+/*-------------.
+| Assertions.  |
+`-------------*/

 
 

-#endif  /* BISON_SYSTEM_H */
+/* 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>.

 
 

-/*---------------------------------.
-| Machine-dependencies for Bison.  |
-`---------------------------------*/
+   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

 
 

-#ifdef eta10
-# define       MAXSHORT        2147483647
-# define       MINSHORT        -2147483648
-#else
-# define       MAXSHORT        32767
-# define       MINSHORT        -32768
+
+/*-----------.
+| Obstacks.  |
+`-----------*/
+
+#define obstack_chunk_alloc xmalloc
+#define obstack_chunk_free  free
+#include <obstack.h>
+
+/* String-grow: append Str to Obs.  */
+
+#define obstack_sgrow(Obs, Str) \
+  obstack_grow (Obs, Str, strlen (Str))
+
+/* Output Str escaped for our postprocessing (i.e., escape M4 special
+   characters).
+
+   For instance "[foo]" -> "@{foo@}", "$$" -> "$][$][". */
+
+# define obstack_escape(Obs, Str)                       \
+  do {                                                  \
+    char const *p__;                                    \
+    for (p__ = Str; *p__; p__++)                        \
+      switch (*p__)                                     \
+        {                                               \
+        case '$': obstack_sgrow (Obs, "$]["); break;    \
+        case '@': obstack_sgrow (Obs, "@@" ); break;    \
+        case '[': obstack_sgrow (Obs, "@{" ); break;    \
+        case ']': obstack_sgrow (Obs, "@}" ); break;    \
+        default:  obstack_1grow (Obs, *p__ ); break;    \
+        }                                               \
+  } while (0)
+
+
+/* Output Str both quoted for M4 (i.e., embed in [[...]]), and escaped
+   for our postprocessing (i.e., escape M4 special characters).  If
+   Str is empty (or NULL), output "[]" instead of "[[]]" as it make M4
+   programming easier (m4_ifval can be used).
+
+   For instance "[foo]" -> "[[@{foo@}]]", "$$" -> "[[$][$][]]". */
+
+# define obstack_quote(Obs, Str)                \
+  do {                                          \
+    char const* obstack_quote_p = Str;          \
+    if (obstack_quote_p && obstack_quote_p[0])  \
+      {                                         \
+        obstack_sgrow (Obs, "[[");              \
+        obstack_escape (Obs, obstack_quote_p);  \
+        obstack_sgrow (Obs, "]]");              \
+      }                                         \
+    else                                        \
+      obstack_sgrow (Obs, "[]");                \
+  } while (0)
+
+
+/* Append the ending 0, finish Obs, and return the string.  */
+
+# define obstack_finish0(Obs)                           \
+  (obstack_1grow (Obs, '\0'), (char *) obstack_finish (Obs))
+
+
+/*-----------------------------------------.
+| Extensions to use for the output files.  |
+`-----------------------------------------*/
+
+#ifndef OUTPUT_EXT
+# define OUTPUT_EXT ".output"

 #endif
 
 #endif
 

-#if defined (MSDOS) && !defined (__GO32__)
-# define       BITS_PER_WORD   16
-# define MAXTABLE      16383
-#else
-# define       BITS_PER_WORD   32
-# define MAXTABLE      32767
+#ifndef TAB_EXT
+# define TAB_EXT ".tab"

 #endif
 
 #endif
 

-#define        WORDSIZE(n)     (((n) + BITS_PER_WORD - 1) / BITS_PER_WORD)
-#define        SETBIT(x, i)    ((x)[(i)/BITS_PER_WORD] |= (1<<((i) % BITS_PER_WORD)))
-#define RESETBIT(x, i) ((x)[(i)/BITS_PER_WORD] &= ~(1<<((i) % BITS_PER_WORD)))
-#define BITISSET(x, i) (((x)[(i)/BITS_PER_WORD] & (1<<((i) % BITS_PER_WORD))) != 0)
+
+
+/*---------------------.
+| Free a linked list.  |
+`---------------------*/
+
+#define LIST_FREE(Type, List)                   \
+do {                                            \
+  Type *_node, *_next;                          \
+  for (_node = List; _node; _node = _next)      \
+    {                                           \
+      _next = _node->next;                      \
+      free (_node);                             \
+    }                                           \
+} while (0)
+
+
+/*---------------------------------------------.
+| Debugging memory allocation (must be last).  |
+`---------------------------------------------*/
+
+# if WITH_DMALLOC
+#  define DMALLOC_FUNC_CHECK
+#  include <dmalloc.h>
+# endif /* WITH_DMALLOC */
+
+#endif  /* ! BISON_SYSTEM_H */