tests/headers.at

   1 # Bison Parser Headers.                               -*- Autotest -*-
   2
   3 # Copyright (C) 2001-2002, 2006-2007, 2009-2015, 2018-2020 Free Software
   4 # Foundation, Inc.
   5
   6 # This program is free software: you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation, either version 3 of the License, or
   9 # (at your option) any later version.
  10 #
  11 # This program is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 # GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 AT_BANNER([[Parser Headers.]])
  20
  21
  22 ## --------------------- ##
  23 ## Invalid CPP headers.  ##
  24 ## --------------------- ##
  25
  26 # AT_TEST_CPP_GUARD_H(BASE-NAME, [DIRECTIVES])
  27 # --------------------------------------------
  28 # FIXME: Much of this can be covered by calc.at.
  29 m4_define([AT_TEST_CPP_GUARD_H],
  30 [AT_SETUP([Invalid CPP guards: $2 --defines=$1.h])
  31 AT_BISON_OPTION_PUSHDEFS([$2])
  32 # Possibly create inner directories.
  33 dirname=`AS_DIRNAME([$1])`
  34 AS_MKDIR_P([$dirname])
  35
  36 AT_DATA_GRAMMAR([$1.y],
  37 [$2
  38 %{
  39 #include <$1.h>
  40 ]AT_YYERROR_DECLARE_EXTERN[
  41 ]AT_YYLEX_DECLARE_EXTERN[
  42 %}
  43 %%
  44 dummy: %empty;
  45 %%
  46 #include <$1.h>
  47 ])
  48
  49 AT_BISON_CHECK([--defines=$1.h --output=$1.c $1.y])
  50
  51 AT_COMPILE([$1.o], [-I. -c $1.c])
  52
  53 AT_BISON_OPTION_POPDEFS
  54 AT_CLEANUP
  55 ])
  56
  57 AT_TEST_CPP_GUARD_H([input/input])
  58 AT_TEST_CPP_GUARD_H([9foo])
  59 AT_TEST_CPP_GUARD_H([input/input], [%glr-parser])
  60 AT_TEST_CPP_GUARD_H([9foo],        [%glr-parser])
  61
  62
  63
  64 ## ---------------- ##
  65 ## export YYLTYPE.  ##
  66 ## ---------------- ##
  67
  68 AT_SETUP([export YYLTYPE])
  69
  70 AT_BISON_OPTION_PUSHDEFS([%name-prefix "my_"])
  71 AT_DATA_GRAMMAR([input.y],
  72 [[%locations
  73
  74 %name-prefix "my_"
  75 %{
  76 #include <stdio.h>
  77 #include <stdlib.h>
  78
  79 ]AT_YYERROR_DEFINE[
  80 ]AT_YYLEX_DEFINE[
  81 %}
  82 %%
  83 exp: %empty;
  84 ]])
  85
  86 AT_BISON_CHECK([--defines -o input.c input.y], [], [],
  87 [[input.y:11.1-18: warning: deprecated directive: '%name-prefix "my_"', use '%define api.prefix {my_}' [-Wdeprecated]
  88 input.y: warning: fix-its can be applied.  Rerun with option '--update'. [-Wother]
  89 ]])
  90
  91 # YYLTYPE should be defined, and MY_LLOC declared.
  92 AT_DATA([caller.c],
  93 [[#include "input.h"
  94 YYLTYPE *my_llocp = &my_lloc;
  95
  96 int my_parse (void);
  97
  98 ]AT_MAIN_DEFINE[
  99 ]])
 100
 101 # Link and execute, just to make sure everything is fine (and in
 102 # particular, that MY_LLOC is indeed defined somewhere).
 103 AT_COMPILE([caller.o])
 104 AT_COMPILE([input.o])
 105 AT_COMPILE([caller], [caller.o input.o])
 106 AT_PARSER_CHECK([caller])
 107 AT_BISON_OPTION_POPDEFS
 108 AT_CLEANUP
 109
 110
 111
 112 ## -------------- ##
 113 ## Sane headers.  ##
 114 ## -------------- ##
 115
 116 # AT_TEST([DIRECTIVES], [COMPILER-FLAGS])
 117 # ---------------------------------------
 118 # Check that headers are self-contained and protected against multiple
 119 # inclusions.
 120
 121 m4_pushdef([AT_TEST],
 122 [AT_SETUP([Sane headers: $1])
 123
 124 AT_BISON_OPTION_PUSHDEFS([$1])
 125 AT_DATA_GRAMMAR([input.y],
 126 [[$1
 127 %define parse.error verbose
 128 ]AT_VARIANT_IF([%token <int> X],
 129 [%union {int integer;}
 130 %token <integer> X])[
 131 %code {
 132 #include <stdio.h> /* printf. */
 133 ]AT_PUSH_IF([[
 134 #if defined __GNUC__ && (7 == __GNUC__ || 9 == __GNUC__)
 135 # pragma GCC diagnostic ignored "-Wmaybe-uninitialized"
 136 #endif
 137 ]])[
 138   ]AT_YYERROR_DECLARE[
 139   ]AT_YYLEX_DECLARE[
 140 }
 141 %%
 142 exp:
 143   X { printf ("x\n"); }
 144 ;
 145
 146 %%
 147 ]AT_YYERROR_DEFINE[
 148 ]AT_YYLEX_DEFINE([{AT_CXX_IF([yy::parser::token::])X, 0}])[
 149 ]])
 150
 151 AT_BISON_CHECK([-d -o input.AT_LANG_EXT input.y])
 152
 153 AT_LANG_COMPILE([input.o])
 154
 155 AT_DATA([main.cc],
 156 [AT_DATA_SOURCE_PROLOGUE
 157 AT_MAIN_DEFINE
 158 ])
 159
 160 # Check that the headers are self-contained, and protected against
 161 # multiple inclusions.  While at it, check they are sane for C++.
 162 for h in *.AT_LANG_HDR
 163 do
 164   # No shell expansion with AT_DATA.
 165   cat >$h.AT_LANG_EXT <<EOF
 166 AT_DATA_SOURCE_PROLOGUE
 167 #include "$h"
 168 #include "$h"
 169 EOF
 170   AT_LANG_COMPILE([$h.o])
 171 done
 172
 173 AT_BISON_OPTION_POPDEFS
 174
 175 AT_CLEANUP
 176 ])# AT_TEST
 177
 178 AT_TEST([])
 179 AT_TEST([%locations %debug])
 180
 181 AT_TEST([%glr-parser])
 182 AT_TEST([%locations %debug %glr-parser])
 183
 184 AT_TEST([%define api.pure])
 185 AT_TEST([%define api.push-pull both])
 186 AT_TEST([%define api.pure %define api.push-pull both])
 187
 188 AT_TEST([%language "c++"])
 189 AT_TEST([%locations %debug %language "c++"])
 190 AT_TEST([%language "c++" %define api.value.type variant %define parse.assert])
 191
 192 AT_TEST([%locations %language "c++" %glr-parser])
 193
 194
 195
 196 ## ----------------- ##
 197 ## Several parsers.  ##
 198 ## ----------------- ##
 199
 200 AT_SETUP([Several parsers])
 201
 202 # AT_TEST([PREFIX], [DIRECTIVES])
 203 # -------------------------------
 204 # Generate and compile to *.o.  Make sure there is no (allowed) YY*
 205 # nor yy* identifiers in the header after applying api.prefix.  Check
 206 # that headers can be compiled by a C++ compiler.
 207 m4_pushdef([AT_TEST],
 208 [AT_BISON_OPTION_PUSHDEFS([%define api.prefix {$1_} $2])
 209 AT_DATA_GRAMMAR([$1.y],
 210 [[%define api.prefix {$1_}
 211 $2
 212 %define parse.error verbose
 213 %union
 214 {
 215   int integer;
 216 }
 217 %{
 218 #include <stdio.h> /* printf. */
 219 ]AT_PUSH_IF([[
 220 #if defined __GNUC__ && (7 == __GNUC__ || 9 == __GNUC__)
 221 # pragma GCC diagnostic ignored "-Wmaybe-uninitialized"
 222 #endif
 223 ]])[
 224   ]AT_YYERROR_DECLARE[
 225   ]AT_YYLEX_DECLARE[
 226 %}
 227 %%
 228 exp:
 229   'x' '1' { printf ("x1\n"); }
 230 | 'x' '2' { printf ("x2\n"); }
 231 | 'x' '3' { printf ("x3\n"); }
 232 | 'x' '4' { printf ("x4\n"); }
 233 | 'x' '5' { printf ("x5\n"); }
 234 | 'x' '6' { printf ("x6\n"); }
 235 | 'x' '7' { printf ("x7\n"); }
 236 | 'x' '8' { printf ("x8\n"); }
 237 | 'x' '9' { printf ("x9\n"); }
 238 ;
 239
 240 %%
 241 ]AT_YYERROR_DEFINE[
 242 ]AT_YYLEX_DEFINE(["$1"])[
 243 ]])
 244
 245 AT_BISON_CHECK([-d -o $1.AT_LANG_EXT $1.y])
 246
 247 AT_LANG_COMPILE([$1.o])
 248 AT_CHECK([[echo "$1" >>expout]])
 249
 250 AT_BISON_OPTION_POPDEFS
 251 ])# AT_TEST
 252
 253 AT_DATA([main.cc],
 254 [AT_DATA_SOURCE_PROLOGUE
 255 [// If we are compiling with CC=$CXX, then do not load the C headers
 256 // inside extern "C", since they were _not_ compiled this way.
 257 #if ! CC_IS_CXX
 258 extern "C"
 259 {
 260 #endif
 261   #include "x1.h"
 262   #include "x2.h"
 263   #include "x3.h"
 264   #include "x4.h"
 265   #include "x6.h"
 266   #include "x7.h"
 267   #include "x8.h"
 268 #if ! CC_IS_CXX
 269 }
 270 #endif
 271 #include "x5.hh"
 272 #include "x9.hh"
 273
 274 #define RUN(S)                                  \
 275   do {                                          \
 276     int res = S;                                \
 277     if (res)                                    \
 278       std::cerr << #S": " << res << '\n';       \
 279   } while (false)
 280
 281 int
 282 main (void)
 283 {
 284   RUN(x1_parse());
 285   RUN(x2_parse());
 286   RUN(x3_parse());
 287   RUN(x4_parse());
 288   x5_::parser p5;
 289   RUN(p5.parse());
 290   RUN(x6_parse());
 291   RUN(x7_parse());
 292   RUN(x8_parse());
 293   x9_::parser p9;
 294   RUN(p9.parse());
 295   return 0;
 296 }
 297 ]])# main.cc
 298
 299 AT_TEST([x1], [])
 300 AT_TEST([x2], [%locations %debug])
 301 AT_TEST([x3], [%glr-parser])
 302 AT_TEST([x4], [%locations %debug %glr-parser])
 303 AT_TEST([x5], [%locations %debug %language "c++"])
 304 AT_TEST([x6], [%define api.pure])
 305 AT_TEST([x7], [%define api.push-pull both])
 306 AT_TEST([x8], [%define api.pure %define api.push-pull both])
 307 AT_TEST([x9], [%locations %code requires {#include "location.hh"} %define api.location.type {x5_::location} %debug %language "c++"])
 308 #AT_TEST([x5], [%locations %language "c++" %glr-parser])
 309
 310 # Check that api.prefix works properly:
 311 #
 312 # - no 'yy' left.
 313 #   C++ output relies on namespaces and still uses yy a lot.
 314 #
 315 # - no 'YY' left.
 316 #   Ignore comments, YYChar (template parameter), YYPUSH_MORE(_DEFINED)?
 317 #   (constant definition), YY_\w+_INCLUDED (header guards).
 318 #   YYDEBUG (not renamed) can be read, but not changed.
 319 AT_PERL_CHECK([[-n -0777 -e '
 320   s{/\*.*?\*/}{}gs;
 321   s{//.*}{}g;
 322   s{\b((defined|if)\ YYDEBUG
 323       |YYChar
 324       |YYNTOKENS  # This is actual scoped in a C++ class.
 325       |YYPUSH_MORE(?:_DEFINED)?
 326       |S_(YY(ACCEPT|EMPTY|EOF|error|UNDEF))  # These guys are scoped.
 327       |YYUSE
 328       |YY_ATTRIBUTE(?:_PURE|_UNUSED)
 329       |YY(?:_REINTERPRET)?_CAST
 330       |YY_CONSTEXPR
 331       |YY_COPY
 332       |YY_CPLUSPLUS
 333       |YY_IGNORE_(?:MAYBE_UNINITIALIZED|USELESS_CAST)_(?:BEGIN|END)
 334       |YY_INITIAL_VALUE
 335       |YY_MOVE
 336       |YY_MOVE_OR_COPY
 337       |YY_MOVE_REF
 338       |YY_NOEXCEPT
 339       |YY_NOTHROW
 340       |YY_NULLPTR
 341       |YY_RVREF
 342       |YY_\w+_INCLUDED
 343       )\b}{}gx;
 344   while (/^(.*YY.*)$/gm)
 345   {
 346     print "$ARGV: invalid exported YY: $1\n";
 347   }
 348   if ($ARGV =~ /\.h$/)
 349   {
 350     while (/^(.*yy.*)$/gm)
 351     {
 352       print "$ARGV: invalid exported yy: $1\n";
 353     }
 354   }
 355 ' -- *.hh *.h]])
 356
 357 # Do this late, so that other checks have been performed.
 358 AT_SKIP_IF_CANNOT_LINK_C_AND_CXX
 359
 360 AT_COMPILE_CXX([parser], [[x[1-9].o -DCC_IS_CXX=$CC_IS_CXX main.cc]])
 361 AT_PARSER_CHECK([parser], [0], [[expout]])
 362
 363 m4_popdef([AT_TEST])
 364
 365 AT_CLEANUP