src/system.h

   1 /* System-dependent definitions for Bison.
   2
   3    Copyright (C) 2000-2007, 2009-2010 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
  56 /*---------.
  57 | Gnulib.  |
  58 `---------*/
  59
  60 #include <unlocked-io.h>
  61 #include <verify.h>
  62 #include <xalloc.h>
  63
  64
  65 /*-----------------.
  66 | GCC extensions.  |
  67 `-----------------*/
  68
  69 /* Use this to suppress gcc's `...may be used before initialized'
  70    warnings.  */
  71 #ifdef lint
  72 # define IF_LINT(Code) Code
  73 #else
  74 # define IF_LINT(Code) /* empty */
  75 #endif
  76
  77 #ifndef __attribute__
  78 /* This feature is available in gcc versions 2.5 and later.  */
  79 # if (! defined __GNUC__ || __GNUC__ < 2 \
  80       || (__GNUC__ == 2 && __GNUC_MINOR__ < 5) || __STRICT_ANSI__)
  81 #  define __attribute__(Spec) /* empty */
  82 # endif
  83 #endif
  84
  85 /* The __-protected variants of `format' and `printf' attributes
  86    are accepted by gcc versions 2.6.4 (effectively 2.7) and later.  */
  87 #if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7)
  88 # define __format__ format
  89 # define __printf__ printf
  90 #endif
  91
  92 #ifndef ATTRIBUTE_NORETURN
  93 # define ATTRIBUTE_NORETURN __attribute__ ((__noreturn__))
  94 #endif
  95
  96 #ifndef ATTRIBUTE_UNUSED
  97 # define ATTRIBUTE_UNUSED __attribute__ ((__unused__))
  98 #endif
  99
 100 #define FUNCTION_PRINT() fprintf (stderr, "%s: ", __func__)
 101
 102 /*------.
 103 | NLS.  |
 104 `------*/
 105
 106 #include <locale.h>
 107
 108 #include <gettext.h>
 109 #define _(Msgid)  gettext (Msgid)
 110 #define N_(Msgid) (Msgid)
 111
 112
 113 /*-----------.
 114 | Booleans.  |
 115 `-----------*/
 116
 117 #include <stdbool.h>
 118
 119
 120
 121 /*-------------.
 122 | Assertions.  |
 123 `-------------*/
 124
 125 /* In the past, Bison defined aver to simply invoke abort in the case of
 126    a failed assertion.  The rationale was that <assert.h>'s assertions
 127    were too heavyweight and could be disabled too easily.  See
 128    discussions at
 129    <http://lists.gnu.org/archive/html/bison-patches/2006-01/msg00080.html>
 130    <http://lists.gnu.org/archive/html/bison-patches/2006-09/msg00111.html>.
 131
 132    However, normal assert output can be helpful during development and
 133    in bug reports from users.  Moreover, it's not clear now that
 134    <assert.h>'s assertions are significantly heavyweight.  Finally, if
 135    users want to experiment with disabling assertions, it's debatable
 136    whether it's our responsibility to stop them.  See discussion
 137    starting at
 138    <http://lists.gnu.org/archive/html/bison-patches/2009-09/msg00013.html>.
 139
 140    For now, we use assert but we call it aver throughout Bison in case
 141    we later wish to try another scheme.
 142 */
 143 #include <assert.h>
 144 #define aver assert
 145
 146
 147 /*-----------.
 148 | Obstacks.  |
 149 `-----------*/
 150
 151 #define obstack_chunk_alloc xmalloc
 152 #define obstack_chunk_free  free
 153 #include <obstack.h>
 154
 155 #define obstack_sgrow(Obs, Str) \
 156   obstack_grow (Obs, Str, strlen (Str))
 157
 158 #define obstack_fgrow1(Obs, Format, Arg1)       \
 159 do {                                            \
 160   char buf[4096];                               \
 161   sprintf (buf, Format, Arg1);                  \
 162   obstack_grow (Obs, buf, strlen (buf));        \
 163 } while (0)
 164
 165 #define obstack_fgrow2(Obs, Format, Arg1, Arg2) \
 166 do {                                            \
 167   char buf[4096];                               \
 168   sprintf (buf, Format, Arg1, Arg2);            \
 169   obstack_grow (Obs, buf, strlen (buf));        \
 170 } while (0)
 171
 172 #define obstack_fgrow3(Obs, Format, Arg1, Arg2, Arg3)   \
 173 do {                                                    \
 174   char buf[4096];                                       \
 175   sprintf (buf, Format, Arg1, Arg2, Arg3);              \
 176   obstack_grow (Obs, buf, strlen (buf));                \
 177 } while (0)
 178
 179 #define obstack_fgrow4(Obs, Format, Arg1, Arg2, Arg3, Arg4)     \
 180 do {                                                            \
 181   char buf[4096];                                               \
 182   sprintf (buf, Format, Arg1, Arg2, Arg3, Arg4);                \
 183   obstack_grow (Obs, buf, strlen (buf));                        \
 184 } while (0)
 185
 186
 187
 188 /*-----------------------------------------.
 189 | Extensions to use for the output files.  |
 190 `-----------------------------------------*/
 191
 192 #ifndef OUTPUT_EXT
 193 # define OUTPUT_EXT ".output"
 194 #endif
 195
 196 #ifndef TAB_EXT
 197 # define TAB_EXT ".tab"
 198 #endif
 199
 200 #ifndef DEFAULT_TMPDIR
 201 # define DEFAULT_TMPDIR "/tmp"
 202 #endif
 203
 204
 205
 206 /*---------------------.
 207 | Free a linked list.  |
 208 `---------------------*/
 209
 210 #define LIST_FREE(Type, List)                   \
 211 do {                                            \
 212   Type *_node, *_next;                          \
 213   for (_node = List; _node; _node = _next)      \
 214     {                                           \
 215       _next = _node->next;                      \
 216       free (_node);                             \
 217     }                                           \
 218 } while (0)
 219
 220
 221 /*---------------------------------------------.
 222 | Debugging memory allocation (must be last).  |
 223 `---------------------------------------------*/
 224
 225 # if WITH_DMALLOC
 226 #  define DMALLOC_FUNC_CHECK
 227 #  include <dmalloc.h>
 228 # endif /* WITH_DMALLOC */
 229
 230 #endif  /* ! BISON_SYSTEM_H */