src/system.h

   1 /* System-dependent definitions for Bison.
   2
   3    Copyright (C) 2000-2007, 2009-2012 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 # if HAVE_SYS_TYPES_H
  43 #  include <sys/types.h>
  44 # endif
  45
  46 # include <unistd.h>
  47 # include <inttypes.h>
  48
  49 # ifndef UINTPTR_MAX
  50 /* This isn't perfect, but it's good enough for Bison, which needs
  51    only to hash pointers.  */
  52 typedef size_t uintptr_t;
  53 # endif
  54
  55 // Version mismatch.
  56 # define EX_MISMATCH 63
  57
  58 /*---------.
  59 | Gnulib.  |
  60 `---------*/
  61
  62 # include <unlocked-io.h>
  63 # include <verify.h>
  64 # include <xalloc.h>
  65
  66
  67 /*-----------------.
  68 | GCC extensions.  |
  69 `-----------------*/
  70
  71 /* Use PACIFY_CC to indicate that Code is unimportant to the logic of Bison
  72    but that it is necessary for suppressing compiler warnings.  For example,
  73    Code might be a variable initializer that's always overwritten before the
  74    variable is used.
  75
  76    PACIFY_CC is intended to be useful only as a comment as it does not alter
  77    Code.  It is tempting to redefine PACIFY_CC so that it will suppress Code
  78    when configuring without --enable-gcc-warnings.  However, that would mean
  79    that, for maintainers, Bison would compile with potentially less warnings
  80    and safer logic than it would for users.  Due to the overhead of M4,
  81    suppressing Code is unlikely to offer any significant improvement in
  82    Bison's performance anyway.  */
  83 # define PACIFY_CC(Code) Code
  84
  85 # ifndef __attribute__
  86 /* This feature is available in gcc versions 2.5 and later.  */
  87 #  if (! defined __GNUC__ || __GNUC__ < 2 \
  88        || (__GNUC__ == 2 && __GNUC_MINOR__ < 5))
  89 #   define __attribute__(Spec) /* empty */
  90 #  endif
  91 # endif
  92
  93 /* The __-protected variants of `format' and `printf' attributes
  94    are accepted by gcc versions 2.6.4 (effectively 2.7) and later.  */
  95 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7)
  96 #  define __format__ format
  97 #  define __printf__ printf
  98 # endif
  99
 100 # ifndef ATTRIBUTE_NORETURN
 101 #  define ATTRIBUTE_NORETURN __attribute__ ((__noreturn__))
 102 # endif
 103
 104 # ifndef ATTRIBUTE_UNUSED
 105 #  define ATTRIBUTE_UNUSED __attribute__ ((__unused__))
 106 # endif
 107
 108 # define FUNCTION_PRINT() fprintf (stderr, "%s: ", __func__)
 109
 110 /*------.
 111 | NLS.  |
 112 `------*/
 113
 114 # include <locale.h>
 115
 116 # include <gettext.h>
 117 # define _(Msgid)  gettext (Msgid)
 118 # define N_(Msgid) (Msgid)
 119
 120
 121 /*-----------.
 122 | Booleans.  |
 123 `-----------*/
 124
 125 # include <stdbool.h>
 126
 127
 128
 129 /*-------------.
 130 | Assertions.  |
 131 `-------------*/
 132
 133 /* In the past, Bison defined aver to simply invoke abort in the case of
 134    a failed assertion.  The rationale was that <assert.h>'s assertions
 135    were too heavyweight and could be disabled too easily.  See
 136    discussions at
 137    <http://lists.gnu.org/archive/html/bison-patches/2006-01/msg00080.html>
 138    <http://lists.gnu.org/archive/html/bison-patches/2006-09/msg00111.html>.
 139
 140    However, normal assert output can be helpful during development and
 141    in bug reports from users.  Moreover, it's not clear now that
 142    <assert.h>'s assertions are significantly heavyweight.  Finally, if
 143    users want to experiment with disabling assertions, it's debatable
 144    whether it's our responsibility to stop them.  See discussion
 145    starting at
 146    <http://lists.gnu.org/archive/html/bison-patches/2009-09/msg00013.html>.
 147
 148    For now, we use assert but we call it aver throughout Bison in case
 149    we later wish to try another scheme.
 150 */
 151 # include <assert.h>
 152 # define aver assert
 153
 154
 155 /*-----------.
 156 | Obstacks.  |
 157 `-----------*/
 158
 159 # define obstack_chunk_alloc xmalloc
 160 # define obstack_chunk_free  free
 161 # include <obstack.h>
 162
 163 # define obstack_sgrow(Obs, Str)                \
 164   obstack_grow (Obs, Str, strlen (Str))
 165
 166 # define obstack_fgrow1(Obs, Format, Arg1)      \
 167   do {                                          \
 168     char buf[4096];                             \
 169     sprintf (buf, Format, Arg1);                \
 170     obstack_grow (Obs, buf, strlen (buf));      \
 171   } while (0)
 172
 173 # define obstack_fgrow2(Obs, Format, Arg1, Arg2)        \
 174   do {                                                  \
 175     char buf[4096];                                     \
 176     sprintf (buf, Format, Arg1, Arg2);                  \
 177     obstack_grow (Obs, buf, strlen (buf));              \
 178   } while (0)
 179
 180 # define obstack_fgrow3(Obs, Format, Arg1, Arg2, Arg3)  \
 181   do {                                                  \
 182     char buf[4096];                                     \
 183     sprintf (buf, Format, Arg1, Arg2, Arg3);            \
 184     obstack_grow (Obs, buf, strlen (buf));              \
 185   } while (0)
 186
 187 # define obstack_fgrow4(Obs, Format, Arg1, Arg2, Arg3, Arg4)    \
 188   do {                                                          \
 189     char buf[4096];                                             \
 190     sprintf (buf, Format, Arg1, Arg2, Arg3, Arg4);              \
 191     obstack_grow (Obs, buf, strlen (buf));                      \
 192   } while (0)
 193
 194
 195 /* Output Str escaped for our postprocessing (i.e., escape M4 special
 196    characters).
 197
 198    For instance "[foo]" -> "@{foo@}", "$$" -> "$][$][". */
 199
 200 # define obstack_escape(Obs, Str)                       \
 201   do {                                                  \
 202     char const *p;                                      \
 203     for (p = Str; *p; p++)                              \
 204       switch (*p)                                       \
 205         {                                               \
 206         case '$': obstack_sgrow (Obs, "$]["); break;    \
 207         case '@': obstack_sgrow (Obs, "@@" ); break;    \
 208         case '[': obstack_sgrow (Obs, "@{" ); break;    \
 209         case ']': obstack_sgrow (Obs, "@}" ); break;    \
 210         default:  obstack_1grow (Obs, *p   ); break;    \
 211         }                                               \
 212   } while (0)
 213
 214
 215 /* Output Str both quoted for M4 (i.e., embed in [[...]]), and escaped
 216    for our postprocessing (i.e., escape M4 special characters).  If
 217    Str is empty (or NULL), output "[]" instead of "[[]]" as it make M4
 218    programming easier (m4_ifval can be used).
 219
 220    For instance "[foo]" -> "[[@{foo@}]]", "$$" -> "[[$][$][]]". */
 221
 222 # define obstack_quote(Obs, Str)                \
 223   do {                                          \
 224     char const* obstack_quote_p = Str;          \
 225     if (obstack_quote_p && obstack_quote_p[0])  \
 226       {                                         \
 227         obstack_sgrow (Obs, "[[");              \
 228         obstack_escape (Obs, obstack_quote_p);  \
 229         obstack_sgrow (Obs, "]]");              \
 230       }                                         \
 231     else                                        \
 232       obstack_sgrow (Obs, "[]");                \
 233   } while (0)
 234
 235
 236
 237
 238
 239 /*-----------------------------------------.
 240 | Extensions to use for the output files.  |
 241 `-----------------------------------------*/
 242
 243 # ifndef OUTPUT_EXT
 244 #  define OUTPUT_EXT ".output"
 245 # endif
 246
 247 # ifndef TAB_EXT
 248 #  define TAB_EXT ".tab"
 249 # endif
 250
 251
 252
 253 /*---------------------.
 254 | Free a linked list.  |
 255 `---------------------*/
 256
 257 # define LIST_FREE(Type, List)                  \
 258   do {                                          \
 259     Type *_node, *_next;                        \
 260     for (_node = List; _node; _node = _next)    \
 261       {                                         \
 262         _next = _node->next;                    \
 263         free (_node);                           \
 264       }                                         \
 265   } while (0)
 266
 267
 268 /*---------------------------------------------.
 269 | Debugging memory allocation (must be last).  |
 270 `---------------------------------------------*/
 271
 272 # if WITH_DMALLOC
 273 #  define DMALLOC_FUNC_CHECK
 274 #  include <dmalloc.h>
 275 # endif /* WITH_DMALLOC */
 276
 277 #endif  /* ! BISON_SYSTEM_H */