tests/headers.at

   1 # Bison Parser Headers.                               -*- Autotest -*-
   2
   3 # Copyright (C) 2001-2002, 2006-2007, 2009-2015, 2018-2021 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 <https://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 AT_COMPILE([$1.o], [-I. -c $1.c])
  51
  52 AT_BISON_OPTION_POPDEFS
  53 AT_CLEANUP
  54 ])
  55
  56 AT_TEST_CPP_GUARD_H([input/input])
  57 AT_TEST_CPP_GUARD_H([9foo])
  58 AT_TEST_CPP_GUARD_H([input/input], [%glr-parser])
  59 AT_TEST_CPP_GUARD_H([9foo],        [%glr-parser])
  60
  61
  62
  63 ## ---------------- ##
  64 ## export YYLTYPE.  ##
  65 ## ---------------- ##
  66
  67 AT_SETUP([export YYLTYPE])
  68
  69 AT_BISON_OPTION_PUSHDEFS([%name-prefix "my_"])
  70 AT_DATA_GRAMMAR([input.y],
  71 [[%locations
  72
  73 %name-prefix "my_"
  74 %{
  75 #include <stdio.h>
  76 #include <stdlib.h>
  77
  78 ]AT_YYERROR_DEFINE[
  79 ]AT_YYLEX_DEFINE[
  80 %}
  81 %%
  82 exp: %empty;
  83 ]])
  84
  85 AT_BISON_CHECK([--header -o input.c input.y], [], [],
  86 [[input.y:11.1-18: warning: deprecated directive: '%name-prefix "my_"', use '%define api.prefix {my_}' [-Wdeprecated]
  87 input.y: warning: fix-its can be applied.  Rerun with option '--update'. [-Wother]
  88 ]])
  89
  90 # YYLTYPE should be defined, and MY_LLOC declared.
  91 AT_DATA([caller.c],
  92 [[#include "input.h"
  93 YYLTYPE *my_llocp = &my_lloc;
  94
  95 int my_parse (void);
  96
  97 ]AT_MAIN_DEFINE[
  98 ]])
  99
 100 # Link and execute, just to make sure everything is fine (and in
 101 # particular, that MY_LLOC is indeed defined somewhere).
 102 AT_COMPILE([caller.o])
 103 AT_COMPILE([input.o])
 104 AT_COMPILE([caller], [caller.o input.o])
 105 AT_PARSER_CHECK([caller])
 106 AT_BISON_OPTION_POPDEFS
 107 AT_CLEANUP
 108
 109
 110
 111 ## -------------- ##
 112 ## Sane headers.  ##
 113 ## -------------- ##
 114
 115 # AT_TEST([DIRECTIVES], [COMPILER-FLAGS])
 116 # ---------------------------------------
 117 # Check that headers are self-contained and protected against multiple
 118 # inclusions.
 119
 120 m4_pushdef([AT_TEST],
 121 [AT_SETUP([Sane headers: $1])
 122
 123 AT_BISON_OPTION_PUSHDEFS([$1])
 124 AT_DATA_GRAMMAR([input.y],
 125 [[$1
 126 %define parse.error verbose
 127 ]AT_VARIANT_IF([%token <int> X],
 128 [%union {int integer;}
 129 %token <integer> X])[
 130 %code {
 131 #include <stdio.h> /* printf. */
 132 ]AT_PUSH_IF([[
 133 #if defined __GNUC__ && (7 == __GNUC__ || 9 == __GNUC__)
 134 # pragma GCC diagnostic ignored "-Wmaybe-uninitialized"
 135 #endif
 136 ]])[
 137   ]AT_YYERROR_DECLARE[
 138   ]AT_YYLEX_DECLARE[
 139 }
 140 %%
 141 exp:
 142   X { printf ("x\n"); }
 143 ;
 144
 145 %%
 146 ]AT_YYERROR_DEFINE[
 147 ]AT_YYLEX_DEFINE([{AT_CXX_IF([yy::parser::token::])X, 0}])[
 148 ]])
 149
 150 AT_BISON_CHECK([-d -o input.AT_LANG_EXT input.y])
 151
 152 AT_LANG_COMPILE([input.o])
 153
 154 AT_DATA([main.cc],
 155 [AT_DATA_SOURCE_PROLOGUE
 156 AT_MAIN_DEFINE
 157 ])
 158
 159 # Check that the headers are self-contained, and protected against
 160 # multiple inclusions.  While at it, check they are sane for C++.
 161 for h in *.AT_LANG_HDR
 162 do
 163   # No shell expansion with AT_DATA.
 164   cat >$h.AT_LANG_EXT <<EOF
 165 AT_DATA_SOURCE_PROLOGUE
 166 #include "$h"
 167 #include "$h"
 168 EOF
 169   AT_LANG_COMPILE([$h.o])
 170 done
 171
 172 AT_BISON_OPTION_POPDEFS
 173
 174 AT_CLEANUP
 175 ])# AT_TEST
 176
 177 AT_TEST([])
 178 AT_TEST([%locations %debug])
 179
 180 AT_TEST([%glr-parser])
 181 AT_TEST([%locations %debug %glr-parser])
 182
 183 AT_TEST([%define api.pure])
 184 AT_TEST([%define api.push-pull both])
 185 AT_TEST([%define api.pure %define api.push-pull both])
 186
 187 AT_TEST([%language "c++"])
 188 AT_TEST([%locations %debug %language "c++"])
 189 AT_TEST([%language "c++" %define api.value.type variant %define parse.assert])
 190
 191 AT_TEST([%locations %language "c++" %glr-parser])
 192
 193
 194
 195 ## ----------------- ##
 196 ## Several parsers.  ##
 197 ## ----------------- ##
 198
 199 AT_SETUP([Several parsers])
 200
 201 # AT_TEST([PREFIX], [DIRECTIVES])
 202 # -------------------------------
 203 # Generate and compile to *.o.  Make sure there is no (allowed) YY*
 204 # nor yy* identifiers in the header after applying api.prefix.  Check
 205 # that headers can be compiled by a C++ compiler.
 206 #
 207 # They should all use parse.assert to make sure that we don't even
 208 # conflict of YY_ASSERT.
 209 m4_pushdef([AT_TEST],
 210 [AT_BISON_OPTION_PUSHDEFS([%define api.prefix {$1_} %define parse.assert $2])
 211 AT_DATA_GRAMMAR([$1.y],
 212 [[%define api.prefix {$1_}
 213 %define parse.assert
 214 $2
 215 %define parse.error verbose
 216 ]AT_VARIANT_IF([],
 217 [%union {int integer;}])[
 218
 219 %code {
 220 #include <stdio.h> /* printf. */
 221 ]AT_PUSH_IF([[
 222 #if defined __GNUC__ && (7 == __GNUC__ || 9 == __GNUC__)
 223 # pragma GCC diagnostic ignored "-Wmaybe-uninitialized"
 224 #endif
 225 ]])[
 226   ]AT_YYERROR_DECLARE[
 227   ]AT_YYLEX_DECLARE[
 228 }
 229
 230 %%
 231
 232 exp:
 233   'x' '1' { printf ("x1\n"); }
 234 | 'x' '2' { printf ("x2\n"); }
 235 | 'x' '3' { printf ("x3\n"); }
 236 | 'x' '4' { printf ("x4\n"); }
 237 | 'x' '5' { printf ("x5\n"); }
 238 | 'x' '6' { printf ("x6\n"); }
 239 | 'x' '7' { printf ("x7\n"); }
 240 | 'x' '8' { printf ("x8\n"); }
 241 | 'x' '9' { printf ("x9\n"); }
 242 | 'x' 'a' { printf ("xa\n"); }
 243 | 'x' 'b' { printf ("xb\n"); }
 244 ;
 245
 246 %%
 247
 248 ]AT_YYERROR_DEFINE[
 249 ]AT_YYLEX_DEFINE(["$1"])[
 250 ]])
 251
 252 AT_BISON_CHECK([-d -o $1.AT_LANG_EXT $1.y])
 253
 254 AT_LANG_COMPILE([$1.o])
 255 AT_CHECK([[echo "$1" >>expout]])
 256
 257 AT_BISON_OPTION_POPDEFS
 258 ])# AT_TEST
 259
 260 AT_DATA([main.cc],
 261 [AT_DATA_SOURCE_PROLOGUE
 262 [// If we are compiling with CC=$CXX, then do not load the C headers
 263 // inside extern "C", since they were _not_ compiled this way.
 264 #if ! CC_IS_CXX
 265 extern "C"
 266 {
 267 #endif
 268   #include "x1.h"
 269   #include "x2.h"
 270   #include "x3.h"
 271   #include "x4.h"
 272   #include "x6.h"
 273   #include "x7.h"
 274   #include "x8.h"
 275 #if ! CC_IS_CXX
 276 }
 277 #endif
 278 #include "x5.hh"
 279 #include "x9.hh"
 280 #include "xa.hh"
 281 #include "xb.hh"
 282
 283 #define RUN(S)                                  \
 284   do {                                          \
 285     int res = S;                                \
 286     if (res)                                    \
 287       std::cerr << #S": " << res << '\n';       \
 288   } while (false)
 289
 290 int
 291 main (void)
 292 {
 293   RUN(x1_parse());
 294   RUN(x2_parse());
 295   RUN(x3_parse());
 296   RUN(x4_parse());
 297   x5_::parser p5;
 298   RUN(p5.parse());
 299   RUN(x6_parse());
 300   RUN(x7_parse());
 301   RUN(x8_parse());
 302   x9_::parser p9;
 303   RUN(p9.parse());
 304   xa_::parser pa;
 305   RUN(pa.parse());
 306   xb_::parser pb;
 307   RUN(pb.parse());
 308   return 0;
 309 }
 310 ]])# main.cc
 311
 312 AT_TEST([x1], [])
 313 AT_TEST([x2], [%locations %debug])
 314 AT_TEST([x3], [%glr-parser])
 315 AT_TEST([x4], [%locations %debug %glr-parser])
 316 AT_TEST([x5], [%locations %debug %language "c++"])
 317 AT_TEST([x6], [%define api.pure])
 318 AT_TEST([x7], [%define api.push-pull both])
 319 AT_TEST([x8], [%define api.pure %define api.push-pull both])
 320 AT_TEST([x9], [%locations %code requires {#include "location.hh"} %define api.location.type {::x5_::location} %debug %language "c++"])
 321 AT_TEST([xa], [%locations %code requires {#include "location.hh"} %define api.location.type {::x5_::location} %language "c++" %define api.value.type variant])
 322 AT_TEST([xb], [%locations %define api.location.file none %language "c++" %define api.value.type variant])
 323 #AT_TEST([x5], [%locations %language "c++" %glr-parser])
 324
 325 # Check that api.prefix works properly:
 326 #
 327 # - no 'yy' left.
 328 #   C++ output relies on namespaces and still uses yy a lot.
 329 #
 330 # - no 'YY' left.
 331 #   Ignore YYPUSH_MORE(_DEFINED)? (constant definition),
 332 #   YYDEBUG (not renamed) can be read, but not changed.
 333 AT_PERL_CHECK([[-n -0777 -e '
 334   # Ignore comments.
 335   s{/\*.*?\*/}{}gs;
 336   s{//.*}{}g;
 337   # Ignore warnings.
 338   s{# *pragma .* message ".*"}{}g;
 339
 340   s{\b((defined|if)\ YYDEBUG
 341       |YYChar     # Template parameter.
 342       |YYNTOKENS  # This is actually scoped in a C++ class.
 343       |YYPUSH_MORE(?:_DEFINED)?
 344       |S_(YY(ACCEPT|EMPTY|EOF|error|UNDEF))  # These guys are scoped.
 345       |YY(?:_REINTERPRET)?_CAST
 346       |YY_ATTRIBUTE(?:_PURE|_UNUSED)
 347       |YY_CONSTEXPR
 348       |YY_COPY
 349       |YY_CPLUSPLUS
 350       |YY_IGNORE_(?:MAYBE_UNINITIALIZED|USELESS_CAST)_(?:BEGIN|END)
 351       |YY_INITIAL_VALUE
 352       |YY_MOVE
 353       |YY_MOVE_OR_COPY
 354       |YY_MOVE_REF
 355       |YY_NOEXCEPT
 356       |YY_NOTHROW
 357       |YY_NULLPTR
 358       |YY_RVREF
 359       |YY_USE
 360       |YY_\w+_INCLUDED  # Header guards.
 361       |FILE\ \*yyo      # Function argument.
 362       |const\ yylocp    # Function argument.
 363       )\b}{}gx;
 364   while (/^(.*YY.*)$/gm)
 365   {
 366     print "$ARGV: invalid exported YY: $1\n";
 367   }
 368   if ($ARGV =~ /\.h$/)
 369   {
 370     while (/^(.*yy.*)$/gm)
 371     {
 372       print "$ARGV: invalid exported yy: $1\n";
 373     }
 374   }
 375 ' -- *.hh *.h]])
 376
 377 # Do this late, so that other checks have been performed.
 378 AT_SKIP_IF_CANNOT_LINK_C_AND_CXX
 379
 380 AT_COMPILE_CXX([parser], [[x[1-9a-b].o -DCC_IS_CXX=$CC_IS_CXX main.cc]])
 381 AT_PARSER_CHECK([parser], [0], [[expout]])
 382
 383 m4_popdef([AT_TEST])
 384
 385 AT_CLEANUP