src/system.h

   1 /* System-dependent definitions for Bison.
   2
   3    Copyright (C) 2000-2007, 2009-2013 Free Software Foundation, Inc.
   4
   5    This program is free software: you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by
   7    the Free Software Foundation, either version 3 of the License, or
   8    (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  17
  18 #ifndef BISON_SYSTEM_H
  19 # define BISON_SYSTEM_H
  20
  21 /* flex 2.5.31 gratutiously defines macros like INT8_MIN.  But this
  22    runs afoul of pre-C99 compilers that have <inttypes.h> or
  23    <stdint.h>, which are included below if available.  It also runs
  24    afoul of pre-C99 compilers that define these macros in <limits.h>.  */
  25 # if ! defined __STDC_VERSION__ || __STDC_VERSION__ < 199901
  26 #  undef INT8_MIN
  27 #  undef INT16_MIN
  28 #  undef INT32_MIN
  29 #  undef INT8_MAX
  30 #  undef INT16_MAX
  31 #  undef UINT8_MAX
  32 #  undef INT32_MAX
  33 #  undef UINT16_MAX
  34 #  undef UINT32_MAX
  35 # endif
  36
  37 # include <limits.h>
  38 # include <stddef.h>
  39 # include <stdlib.h>
  40 # include <string.h>
  41
  42 # define ARRAY_CARDINALITY(Array) (sizeof (Array) / sizeof *(Array))
  43 # define STREQ(L, R)  (strcmp(L, R) == 0)
  44 # define STRNEQ(L, R) (!STREQ(L, R))
  45
  46 /* Just like strncmp, but the second argument must be a literal string
  47    and you don't specify the length.  */
  48 # define STRNCMP_LIT(S, Literal)                        \
  49   strncmp (S, "" Literal "", sizeof (Literal) - 1)
  50
  51 /* Whether Literal is a prefix of S.  */
  52 # define STRPREFIX_LIT(Literal, S)              \
  53   (STRNCMP_LIT (S, Literal) == 0)
  54
  55 # include <unistd.h>
  56 # include <inttypes.h>
  57
  58 # ifndef UINTPTR_MAX
  59 /* This isn't perfect, but it's good enough for Bison, which needs
  60    only to hash pointers.  */
  61 typedef size_t uintptr_t;
  62 # endif
  63
  64 /* Version mismatch. */
  65 # define EX_MISMATCH 63
  66
  67 /*---------.
  68 | Gnulib.  |
  69 `---------*/
  70
  71 # include <unlocked-io.h>
  72 # include <verify.h>
  73 # include <xalloc.h>
  74
  75
  76 /*-----------------.
  77 | GCC extensions.  |
  78 `-----------------*/
  79
  80 /* Use PACIFY_CC to indicate that Code is unimportant to the logic of Bison
  81    but that it is necessary for suppressing compiler warnings.  For example,
  82    Code might be a variable initializer that's always overwritten before the
  83    variable is used.
  84
  85    PACIFY_CC is intended to be useful only as a comment as it does not alter
  86    Code.  It is tempting to redefine PACIFY_CC so that it will suppress Code
  87    when configuring without --enable-gcc-warnings.  However, that would mean
  88    that, for maintainers, Bison would compile with potentially less warnings
  89    and safer logic than it would for users.  Due to the overhead of M4,
  90    suppressing Code is unlikely to offer any significant improvement in
  91    Bison's performance anyway.  */
  92 # define PACIFY_CC(Code) Code
  93
  94 # ifndef __attribute__
  95 /* This feature is available in gcc versions 2.5 and later.  */
  96 #  if (! defined __GNUC__ || __GNUC__ < 2 \
  97        || (__GNUC__ == 2 && __GNUC_MINOR__ < 5))
  98 #   define __attribute__(Spec) /* empty */
  99 #  endif
 100 # endif
 101
 102 /* The __-protected variants of 'format' and 'printf' attributes
 103    are accepted by gcc versions 2.6.4 (effectively 2.7) and later.  */
 104 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7)
 105 #  define __format__ format
 106 #  define __printf__ printf
 107 # endif
 108
 109 # ifndef ATTRIBUTE_NORETURN
 110 #  define ATTRIBUTE_NORETURN __attribute__ ((__noreturn__))
 111 # endif
 112
 113 # ifndef ATTRIBUTE_UNUSED
 114 #  define ATTRIBUTE_UNUSED __attribute__ ((__unused__))
 115 # endif
 116
 117
 118 /*------.
 119 | NLS.  |
 120 `------*/
 121
 122 # include <locale.h>
 123
 124 # include <gettext.h>
 125 # define _(Msgid)  gettext (Msgid)
 126 # define N_(Msgid) (Msgid)
 127
 128
 129 /*-----------.
 130 | Booleans.  |
 131 `-----------*/
 132
 133 # include <stdbool.h>
 134
 135
 136
 137 /*-------------.
 138 | Assertions.  |
 139 `-------------*/
 140
 141 /* In the past, Bison defined aver to simply invoke abort in the case of
 142    a failed assertion.  The rationale was that <assert.h>'s assertions
 143    were too heavyweight and could be disabled too easily.  See
 144    discussions at
 145    <http://lists.gnu.org/archive/html/bison-patches/2006-01/msg00080.html>
 146    <http://lists.gnu.org/archive/html/bison-patches/2006-09/msg00111.html>.
 147
 148    However, normal assert output can be helpful during development and
 149    in bug reports from users.  Moreover, it's not clear now that
 150    <assert.h>'s assertions are significantly heavyweight.  Finally, if
 151    users want to experiment with disabling assertions, it's debatable
 152    whether it's our responsibility to stop them.  See discussion
 153    starting at
 154    <http://lists.gnu.org/archive/html/bison-patches/2009-09/msg00013.html>.
 155
 156    For now, we use assert but we call it aver throughout Bison in case
 157    we later wish to try another scheme.
 158 */
 159 # include <assert.h>
 160 # define aver assert
 161
 162
 163 /*-----------.
 164 | Obstacks.  |
 165 `-----------*/
 166
 167 # define obstack_chunk_alloc xmalloc
 168 # define obstack_chunk_free  free
 169 # include <obstack.h>
 170
 171 /* String-grow: append Str to Obs.  */
 172
 173 # define obstack_sgrow(Obs, Str) \
 174   obstack_grow (Obs, Str, strlen (Str))
 175
 176 /* Output Str escaped for our postprocessing (i.e., escape M4 special
 177    characters).
 178
 179    For instance "[foo]" -> "@{foo@}", "$$" -> "$][$][". */
 180
 181 # define obstack_escape(Obs, Str)                       \
 182   do {                                                  \
 183     char const *p__;                                    \
 184     for (p__ = Str; *p__; p__++)                        \
 185       switch (*p__)                                     \
 186         {                                               \
 187         case '$': obstack_sgrow (Obs, "$]["); break;    \
 188         case '@': obstack_sgrow (Obs, "@@" ); break;    \
 189         case '[': obstack_sgrow (Obs, "@{" ); break;    \
 190         case ']': obstack_sgrow (Obs, "@}" ); break;    \
 191         default:  obstack_1grow (Obs, *p__ ); break;    \
 192         }                                               \
 193   } while (0)
 194
 195
 196 /* Output Str both quoted for M4 (i.e., embed in [[...]]), and escaped
 197    for our postprocessing (i.e., escape M4 special characters).  If
 198    Str is empty (or NULL), output "[]" instead of "[[]]" as it make M4
 199    programming easier (m4_ifval can be used).
 200
 201    For instance "[foo]" -> "[[@{foo@}]]", "$$" -> "[[$][$][]]". */
 202
 203 # define obstack_quote(Obs, Str)                \
 204   do {                                          \
 205     char const* obstack_quote_p = Str;          \
 206     if (obstack_quote_p && obstack_quote_p[0])  \
 207       {                                         \
 208         obstack_sgrow (Obs, "[[");              \
 209         obstack_escape (Obs, obstack_quote_p);  \
 210         obstack_sgrow (Obs, "]]");              \
 211       }                                         \
 212     else                                        \
 213       obstack_sgrow (Obs, "[]");                \
 214   } while (0)
 215
 216
 217 /* Append the ending 0, finish Obs, and return the string.  */
 218
 219 # define obstack_finish0(Obs)                                   \
 220   (obstack_1grow (Obs, '\0'), (char *) obstack_finish (Obs))
 221
 222
 223 /*-----------------------------------------.
 224 | Extensions to use for the output files.  |
 225 `-----------------------------------------*/
 226
 227 # ifndef OUTPUT_EXT
 228 #  define OUTPUT_EXT ".output"
 229 # endif
 230
 231 # ifndef TAB_EXT
 232 #  define TAB_EXT ".tab"
 233 # endif
 234
 235
 236
 237 /*---------------------.
 238 | Free a linked list.  |
 239 `---------------------*/
 240
 241 # define LIST_FREE(Type, List)                  \
 242   do {                                          \
 243     Type *_node, *_next;                        \
 244     for (_node = List; _node; _node = _next)    \
 245       {                                         \
 246         _next = _node->next;                    \
 247         free (_node);                           \
 248       }                                         \
 249   } while (0)
 250
 251
 252 /*---------------------------------------------.
 253 | Debugging memory allocation (must be last).  |
 254 `---------------------------------------------*/
 255
 256 # if WITH_DMALLOC
 257 #  define DMALLOC_FUNC_CHECK
 258 #  include <dmalloc.h>
 259 # endif /* WITH_DMALLOC */
 260
 261 #endif  /* ! BISON_SYSTEM_H */