]> git.saurik.com Git - bison.git/blobdiff - src/system.h
api.namespace: demonstrate and use {...} values instead of "..." values
[bison.git] / src / system.h
index 0d69e93e32a98c5f360ce1d90c52a88030b01001..3267f2d24c6cc2dbc4d2ea755f3a2fa341c7aaee 100644 (file)
@@ -1,6 +1,6 @@
 /* System-dependent definitions for Bison.
 
-   Copyright (C) 2000-2007, 2009-2012 Free Software Foundation, Inc.
+   Copyright (C) 2000-2007, 2009-2013 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
    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>.  */
-#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>
-
-#define STREQ(L, R)  (strcmp(L, R) == 0)
-#define STRNEQ(L, R) (!STREQ(L, R))
+# 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>
+
+# define ARRAY_CARDINALITY(Array) (sizeof (Array) / sizeof *(Array))
+# define STREQ(L, R)  (strcmp(L, R) == 0)
+# define STRNEQ(L, R) (!STREQ(L, R))
 
 /* Just like strncmp, but the second argument must be a literal string
    and you don't specify the length.  */
-#define STRNCMP_LIT(S, Literal)                         \
+# define STRNCMP_LIT(S, Literal)                        \
   strncmp (S, "" Literal "", sizeof (Literal) - 1)
 
 /* Whether Literal is a prefix of S.  */
-#define STRPREFIX_LIT(Literal, S)               \
+# define STRPREFIX_LIT(Literal, S)              \
   (STRNCMP_LIT (S, Literal) == 0)
 
-#if HAVE_SYS_TYPES_H
-# include <sys/types.h>
-#endif
+# include <unistd.h>
+# include <inttypes.h>
 
-#include <unistd.h>
-#include <inttypes.h>
-
-#ifndef UINTPTR_MAX
+# 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
 
-// Version mismatch.
-#define EX_MISMATCH 63
+/* Version mismatch. */
+# define EX_MISMATCH 63
 
 /*---------.
 | Gnulib.  |
 `---------*/
 
-#include <unlocked-io.h>
-#include <verify.h>
-#include <xalloc.h>
+# include <unlocked-io.h>
+# include <verify.h>
+# include <xalloc.h>
 
 
 /*-----------------.
@@ -92,49 +89,48 @@ typedef size_t uintptr_t;
    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
+# define PACIFY_CC(Code) Code
 
-#ifndef __attribute__
+# ifndef __attribute__
 /* This feature is available in gcc versions 2.5 and later.  */
-# if (! defined __GNUC__ || __GNUC__ < 2 \
+#  if (! defined __GNUC__ || __GNUC__ < 2 \
        || (__GNUC__ == 2 && __GNUC_MINOR__ < 5))
-#  define __attribute__(Spec) /* empty */
+#   define __attribute__(Spec) /* empty */
+#  endif
 # endif
-#endif
 
-/* The __-protected variants of `format' and `printf' attributes
+/* 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__)
 
 /*------.
 | 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.  |
 `-----------*/
 
-#include <stdbool.h>
+# include <stdbool.h>
 
 
 
@@ -160,66 +156,81 @@ typedef size_t uintptr_t;
    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
+# include <assert.h>
+# define aver assert
 
 
 /*-----------.
 | 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>
+
+/* String-grow: append Str to Obs.  */
 
-#define obstack_sgrow(Obs, Str) \
+# define obstack_sgrow(Obs, Str) \
   obstack_grow (Obs, Str, strlen (Str))
 
-#define obstack_fgrow1(Obs, Format, Arg1)       \
-do {                                            \
-  char buf[4096];                               \
-  sprintf (buf, Format, Arg1);                  \
-  obstack_grow (Obs, buf, strlen (buf));        \
-} while (0)
+/* Output Str escaped for our postprocessing (i.e., escape M4 special
+   characters).
 
-#define obstack_fgrow2(Obs, Format, Arg1, Arg2) \
-do {                                            \
-  char buf[4096];                               \
-  sprintf (buf, Format, Arg1, Arg2);            \
-  obstack_grow (Obs, buf, strlen (buf));        \
-} while (0)
+   For instance "[foo]" -> "@{foo@}", "$$" -> "$][$][". */
 
-#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)
+# 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)
 
-#define obstack_fgrow4(Obs, Format, Arg1, Arg2, Arg3, Arg4)     \
-do {                                                            \
-  char buf[4096];                                               \
-  sprintf (buf, Format, Arg1, Arg2, Arg3, Arg4);                \
-  obstack_grow (Obs, buf, strlen (buf));                        \
-} 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
-
-#ifndef TAB_EXT
-# define TAB_EXT ".tab"
-#endif
+# ifndef OUTPUT_EXT
+#  define OUTPUT_EXT ".output"
+# endif
 
-#ifndef DEFAULT_TMPDIR
-# define DEFAULT_TMPDIR "/tmp"
-#endif
+# ifndef TAB_EXT
+#  define TAB_EXT ".tab"
+# endif
 
 
 
@@ -227,15 +238,15 @@ do {                                                            \
 | 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)
+# define LIST_FREE(Type, List)                  \
+  do {                                          \
+    Type *_node, *_next;                        \
+    for (_node = List; _node; _node = _next)    \
+      {                                         \
+        _next = _node->next;                    \
+        free (_node);                           \
+      }                                         \
+  } while (0)
 
 
 /*---------------------------------------------.