* Java Semantic Values:: %type and %token vs. Java
* Java Location Values:: The position and location classes
* Java Parser Interface:: Instantiating and running the parser
-* Java Scanner Interface:: Java scanners, and pure parsers
+* Java Scanner Interface:: Specifying the scanner for the parser
+* Java Action Features:: Special features for use in actions.
* Java Differences:: Differences between C/C++ and Java Grammars
+* Java Declarations Summary:: List of Bison declarations used with Java
Frequently Asked Questions
* Java Semantic Values:: %type and %token vs. Java
* Java Location Values:: The position and location classes
* Java Parser Interface:: Instantiating and running the parser
-* Java Scanner Interface:: Java scanners, and pure parsers
+* Java Scanner Interface:: Specifying the scanner for the parser
+* Java Action Features:: Special features for use in actions.
* Java Differences:: Differences between C/C++ and Java Grammars
+* Java Declarations Summary:: List of Bison declarations used with Java
@end menu
@node Java Bison Interface
@subsection Java Bison Interface
@c - %language "Java"
-@c - initial action
(The current Java interface is experimental and may evolve.
More user feedback will help to stabilize it.)
-The Java parser skeletons are selected using a language directive,
-@samp{%language "Java"}, or the synonymous command-line option
-@option{--language=java}.
+The Java parser skeletons are selected using the @code{%language "Java"}
+directive or the @option{-L java}/@option{--language=java} option.
-When run, @command{bison} will create several entities whose name
-starts with @samp{YY}. Use the @samp{%name-prefix} directive to
-change the prefix, see @ref{Decl Summary}; classes can be placed
-in an arbitrary Java package using a @samp{%define package} section.
+@c FIXME: Documented bug.
+When generating a Java parser, @code{bison @var{basename}.y} will create
+a single Java source file named @file{@var{basename}.java}. Using an
+input file without a @file{.y} suffix is currently broken. The basename
+of the output file can be changed by the @code{%file-prefix} directive
+or the @option{-p}/@option{--name-prefix} option. The entire output file
+name can be changed by the @code{%output} directive or the
+@option{-o}/@option{--output} option. The output file contains a single
+class for the parser.
-The parser class defines an inner class, @code{Location}, that is used
-for location tracking. If the parser is pure, it also defines an
-inner interface, @code{Lexer}; see @ref{Java Scanner Interface} for the
-meaning of pure parsers when the Java language is chosen. Other than
-these inner class/interface, and the members described in @ref{Java
-Parser Interface}, all the other members and fields are preceded
-with a @code{yy} prefix to avoid clashes with user code.
-
-No header file can be generated for Java parsers; you must not pass
-@option{-d}/@option{--defines} to @command{bison}, nor use the
-@samp{%defines} directive.
+You can create documentation for generated parsers using Javadoc.
-By default, the @samp{YYParser} class has package visibility. A
-declaration @samp{%define "public"} will change to public visibility.
-Remember that, according to the Java language specification, the name
-of the @file{.java} file should match the name of the class in this
-case.
+Contrary to C parsers, Java parsers do not use global variables; the
+state of the parser is always local to an instance of the parser class.
+Therefore, all Java parsers are ``pure'', and the @code{%pure-parser}
+and @code{%define api.pure} directives does not do anything when used in
+Java.
-Similarly, a declaration @samp{%define "abstract"} will make your
-class abstract.
+Push parsers are currently unsupported in Java and @code{%define
+api.push_pull} have no effect.
-You can create documentation for generated parsers using Javadoc.
+@acronym{GLR} parsers are currently unsupported in Java. Do not use the
+@code{glr-parser} directive.
+
+No header file can be generated for Java parsers. Do not use the
+@code{%defines} directive or the @option{-d}/@option{--defines} options.
+
+@c FIXME: Possible code change.
+Currently, support for debugging and verbose errors are always compiled
+in. Thus the @code{%debug} and @code{%token-table} directives and the
+@option{-t}/@option{--debug} and @option{-k}/@option{--token-table}
+options have no effect. This may change in the future to eliminate
+unused code in the generated parser, so use @code{%debug} and
+@code{%verbose-error} explicitly if needed. Also, in the future the
+@code{%token-table} directive might enable a public interface to
+access the token names and codes.
@node Java Semantic Values
@subsection Java Semantic Values
By default, the semantic stack is declared to have @code{Object} members,
which means that the class types you specify can be of any class.
To improve the type safety of the parser, you can declare the common
-superclass of all the semantic values using the @samp{%define} directive.
-For example, after the following declaration:
+superclass of all the semantic values using the @code{%define stype}
+directive. For example, after the following declaration:
@example
-%define "stype" "ASTNode"
+%define stype "ASTNode"
@end example
@noindent
any @code{%type} or @code{%token} specifying a semantic type which
is not a subclass of ASTNode, will cause a compile-time error.
+@c FIXME: Documented bug.
Types used in the directives may be qualified with a package name.
Primitive data types are accepted for Java version 1.5 or later. Note
that in this case the autoboxing feature of Java 1.5 will be used.
+Generic types may not be used; this is due to a limitation in the
+implementation of Bison, and may change in future releases.
Java parsers do not support @code{%destructor}, since the language
adopts garbage collection. The parser will try to hold references
in a file; Bison itself defines a class representing a @dfn{location},
a range composed of a pair of positions (possibly spanning several
files). The location class is an inner class of the parser; the name
-is @code{Location} by default, may also be renamed using @code{%define
-"location_type" "@var{class-name}}.
+is @code{Location} by default, and may also be renamed using
+@code{%define location_type "@var{class-name}}.
The location class treats the position as a completely opaque value.
By default, the class name is @code{Position}, but this can be changed
-with @code{%define "position_type" "@var{class-name}"}.
+with @code{%define position_type "@var{class-name}"}. This class must
+be supplied by the user.
-@deftypemethod {Location} {Position} begin
-@deftypemethodx {Location} {Position} end
+@deftypeivar {Location} {Position} begin
+@deftypeivarx {Location} {Position} end
The first, inclusive, position of the range, and the first beyond.
-@end deftypemethod
+@end deftypeivar
+
+@deftypeop {Constructor} {Location} {} Location (Position @var{loc})
+Create a @code{Location} denoting an empty range located at a given point.
+@end deftypeop
+
+@deftypeop {Constructor} {Location} {} Location (Position @var{begin}, Position @var{end})
+Create a @code{Location} from the endpoints of the range.
+@end deftypeop
-@deftypemethod {Location} {void} toString ()
+@deftypemethod {Location} {String} toString ()
Prints the range represented by the location. For this to work
properly, the position class should override the @code{equals} and
@code{toString} methods appropriately.
@c debug_stream.
@c - Reporting errors
-The output file defines the parser class in the package optionally
-indicated in the @code{%define package} section. The class name defaults
-to @code{YYParser}. The @code{YY} prefix may be changed using
-@samp{%name-prefix}; alternatively, you can use @samp{%define
-"parser_class_name" "@var{name}"} to give a custom name to the class.
-The interface of this class is detailed below. It can be extended using
-the @code{%parse-param} directive; each occurrence of the directive will
-add a field to the parser class, and an argument to its constructor.
+The name of the generated parser class defaults to @code{YYParser}. The
+@code{YY} prefix may be changed using the @code{%name-prefix} directive
+or the @option{-p}/@option{--name-prefix} option. Alternatively, use
+@code{%define parser_class_name "@var{name}"} to give a custom name to
+the class. The interface of this class is detailed below.
-@deftypemethod {YYParser} {} YYParser (@var{type1} @var{arg1}, ...)
-Build a new parser object. There are no arguments by default, unless
-@samp{%parse-param @{@var{type1} @var{arg1}@}} was used.
-@end deftypemethod
+By default, the parser class has package visibility. A declaration
+@code{%define public} will change to public visibility. Remember that,
+according to the Java language specification, the name of the @file{.java}
+file should match the name of the class in this case. Similarly, you can
+use @code{abstract}, @code{final} and @code{strictfp} with the
+@code{%define} declaration to add other modifiers to the parser class.
+
+The Java package name of the parser class can be specified using the
+@code{%define package} directive. The superclass and the implemented
+interfaces of the parser class can be specified with the @code{%define
+extends} and @code{%define implements} directives.
+
+The parser class defines an inner class, @code{Location}, that is used
+for location tracking (see @ref{Java Location Values}), and a inner
+interface, @code{Lexer} (see @ref{Java Scanner Interface}). Other than
+these inner class/interface, and the members described in the interface
+below, all the other members and fields are preceded with a @code{yy} or
+@code{YY} prefix to avoid clashes with user code.
+
+@c FIXME: The following constants and variables are still undocumented:
+@c @code{bisonVersion}, @code{bisonSkeleton} and @code{errorVerbose}.
+
+The parser class can be extended using the @code{%parse-param}
+directive. Each occurrence of the directive will add a @code{protected
+final} field to the parser class, and an argument to its constructor,
+which initialize them automatically.
+
+Token names defined by @code{%token} and the predefined @code{EOF} token
+name are added as constant fields to the parser class.
+
+@deftypeop {Constructor} {YYParser} {} YYParser (@var{lex_param}, @dots{}, @var{parse_param}, @dots{})
+Build a new parser object with embedded @code{%code lexer}. There are
+no parameters, unless @code{%parse-param}s and/or @code{%lex-param}s are
+used.
+@end deftypeop
+
+@deftypeop {Constructor} {YYParser} {} YYParser (Lexer @var{lexer}, @var{parse_param}, @dots{})
+Build a new parser object using the specified scanner. There are no
+additional parameters unless @code{%parse-param}s are used.
+
+If the scanner is defined by @code{%code lexer}, this constructor is
+declared @code{protected} and is called automatically with a scanner
+created with the correct @code{%lex-param}s.
+@end deftypeop
@deftypemethod {YYParser} {boolean} parse ()
Run the syntactic analysis, and return @code{true} on success,
@deftypemethod {YYParser} {boolean} recovering ()
During the syntactic analysis, return @code{true} if recovering
-from a syntax error. @xref{Error Recovery}.
+from a syntax error.
+@xref{Error Recovery}.
@end deftypemethod
@deftypemethod {YYParser} {java.io.PrintStream} getDebugStream ()
or nonzero, full tracing.
@end deftypemethod
-@deftypemethod {YYParser} {void} error (Location @var{l}, String @var{m})
-The definition for this member function must be supplied by the user
-in the same way as the scanner interface (@pxref{Java Scanner
-Interface}); the parser uses it to report a parser error occurring at
-@var{l}, described by @var{m}.
-@end deftypemethod
-
@node Java Scanner Interface
@subsection Java Scanner Interface
@c - %lex-param
@c - Lexer interface
-Contrary to C parsers, Java parsers do not use global variables; the
-state of the parser is always local to an instance of the parser class.
-Therefore, all Java parsers are ``pure'', and the @code{%pure-parser}
-directive does not do anything when used in Java.
-@c FIXME: But a bit farther it is stated that
-@c If @code{%pure-parser} is not specified, the lexer interface
-@c resides in the same class (@code{YYParser}) as the Bison-generated
-@c parser. The fields and methods that are provided to
-@c this end are as follows.
-
-The scanner always resides in a separate class than the parser.
-Still, there are two possible ways to interface a Bison-generated Java
-parser with a scanner, that is, the scanner may reside in a separate file
-than the Bison grammar, or in the same file. The interface
-to the scanner is similar in the two cases.
-
-In the first case, where the scanner in the same file as the grammar, the
-scanner code has to be placed in @code{%code lexer} blocks. If you want
-to pass parameters from the parser constructor to the scanner constructor,
-specify them with @code{%lex-param}; they are passed before
-@code{%parse-param}s to the constructor.
+There are two possible ways to interface a Bison-generated Java parser
+with a scanner: the scanner may be defined by @code{%code lexer}, or
+defined elsewhere. In either case, the scanner has to implement the
+@code{Lexer} inner interface of the parser class.
+
+In the first case, the body of the scanner class is placed in
+@code{%code lexer} blocks. If you want to pass parameters from the
+parser constructor to the scanner constructor, specify them with
+@code{%lex-param}; they are passed before @code{%parse-param}s to the
+constructor.
In the second case, the scanner has to implement the @code{Lexer} interface,
which is defined within the parser class (e.g., @code{YYParser.Lexer}).
In both cases, the scanner has to implement the following methods.
-@deftypemethod {Lexer} {void} yyerror (Location @var{l}, String @var{m})
-As explained in @pxref{Java Parser Interface}, this method is defined
-by the user to emit an error message. The first parameter is omitted
-if location tracking is not active. Its type can be changed using
-@samp{%define "location_type" "@var{class-name}".}
+@deftypemethod {Lexer} {void} yyerror (Location @var{loc}, String @var{msg})
+This method is defined by the user to emit an error message. The first
+parameter is omitted if location tracking is not active. Its type can be
+changed using @code{%define location_type "@var{class-name}".}
@end deftypemethod
-@deftypemethod {Lexer} {int} yylex (@var{type1} @var{arg1}, ...)
+@deftypemethod {Lexer} {int} yylex ()
Return the next token. Its type is the return value, its semantic
value and location are saved and returned by the ther methods in the
-interface. Invocations of @samp{%lex-param @{@var{type1}
-@var{arg1}@}} yield additional arguments.
+interface.
+
+Use @code{%define lex_throws} to specify any uncaught exceptions.
+Default is @code{java.io.IOException}.
@end deftypemethod
@deftypemethod {Lexer} {Position} getStartPos ()
@code{yylex} returned, and the first position beyond it. These
methods are not needed unless location tracking is active.
-The return type can be changed using @samp{%define "position_type"
+The return type can be changed using @code{%define position_type
"@var{class-name}".}
@end deftypemethod
@deftypemethod {Lexer} {Object} getLVal ()
Return the semantical value of the last token that yylex returned.
-The return type can be changed using @samp{%define "stype"
+The return type can be changed using @code{%define stype
"@var{class-name}".}
@end deftypemethod
-The lexer interface resides in the same class (@code{YYParser}) as the
-Bison-generated parser.
-The fields and methods that are provided to this end are as follows.
+@node Java Action Features
+@subsection Special Features for Use in Java Actions
-@deftypemethod {YYParser} {void} error (Location @var{l}, String @var{m})
-As already explained (@pxref{Java Parser Interface}), this method is defined
-by the user to emit an error message. The first parameter is not used
-unless location tracking is active. Its type can be changed using
-@samp{%define "location_type" "@var{class-name}".}
-@end deftypemethod
+The following special constructs can be uses in Java actions.
+Other analogous C action features are currently unavailable for Java.
-@deftypemethod {YYParser} {int} yylex (@var{type1} @var{arg1}, ...)
-Return the next token. Its type is the return value, its semantic
-value and location are saved into @code{yylval}, @code{yystartpos},
-@code{yyendpos}. Invocations of @samp{%lex-param @{@var{type1}
-@var{arg1}@}} yield additional arguments.
-@end deftypemethod
+Use @code{%define throws} to specify any uncaught exceptions from parser
+actions, and initial actions specified by @code{%initial-action}.
-@deftypecv {Field} {YYParser} Position yystartpos
-@deftypecvx {Field} {YYParser} Position yyendpos
-Contain respectively the first position of the last token that yylex
-returned, and the first position beyond it. These methods are not
-needed unless location tracking is active.
+@defvar $@var{n}
+The semantic value for the @var{n}th component of the current rule.
+This may not be assigned to.
+@xref{Java Semantic Values}.
+@end defvar
-The field's type can be changed using @samp{%define "position_type"
-"@var{class-name}".}
-@end deftypecv
+@defvar $<@var{typealt}>@var{n}
+Like @code{$@var{n}} but specifies a alternative type @var{typealt}.
+@xref{Java Semantic Values}.
+@end defvar
-@deftypecv {Field} {YYParser} Object yylval
-Return respectively the first position of the last token that yylex
-returned, and the first position beyond it.
+@defvar $$
+The semantic value for the grouping made by the current rule. As a
+value, this is in the base type (@code{Object} or as specified by
+@code{%define stype}) as in not cast to the declared subtype because
+casts are not allowed on the left-hand side of Java assignments.
+Use an explicit Java cast if the correct subtype is needed.
+@xref{Java Semantic Values}.
+@end defvar
+
+@defvar $<@var{typealt}>$
+Same as @code{$$} since Java always allow assigning to the base type.
+Perhaps we should use this and @code{$<>$} for the value and @code{$$}
+for setting the value but there is currently no easy way to distinguish
+these constructs.
+@xref{Java Semantic Values}.
+@end defvar
+
+@defvar @@@var{n}
+The location information of the @var{n}th component of the current rule.
+This may not be assigned to.
+@xref{Java Location Values}.
+@end defvar
+
+@defvar @@$
+The location information of the grouping made by the current rule.
+@xref{Java Location Values}.
+@end defvar
+
+@deffn {Statement} {return YYABORT;}
+Return immediately from the parser, indicating failure.
+@xref{Java Parser Interface}.
+@end deffn
+
+@deffn {Statement} {return YYACCEPT;}
+Return immediately from the parser, indicating success.
+@xref{Java Parser Interface}.
+@end deffn
+
+@deffn {Statement} {return YYERROR;}
+Start error recovery without printing an error message.
+@xref{Error Recovery}.
+@end deffn
+
+@deffn {Statement} {return YYFAIL;}
+Print an error message and start error recovery.
+@xref{Error Recovery}.
+@end deffn
+
+@deftypefn {Function} {boolean} recovering ()
+Return whether error recovery is being done. In this state, the parser
+reads token until it reaches a known state, and then restarts normal
+operation.
+@xref{Error Recovery}.
+@end deftypefn
+
+@deftypefn {Function} {protected void} yyerror (String msg)
+@deftypefnx {Function} {protected void} yyerror (Position pos, String msg)
+@deftypefnx {Function} {protected void} yyerror (Location loc, String msg)
+Print an error message using the @code{yyerror} method of the scanner
+instance in use.
+@end deftypefn
-The field's type can be changed using @samp{%define "stype"
-"@var{class-name}".}
-@end deftypecv
@node Java Differences
@subsection Differences between C/C++ and Java Grammars
appear in an action. The actual definition of these symbols is
opaque to the Bison grammar, and it might change in the future. The
only meaningful operation that you can do, is to return them.
+See @pxref{Java Action Features}.
Note that of these three symbols, only @code{YYACCEPT} and
@code{YYABORT} will cause a return from the @code{yyparse}
method than @code{yyparse} in order to have an intuitive syntax that
corresponds to these C macros.}.
+@item
+Java lacks unions, so @code{%union} has no effect. Instead, semantic
+values have a common base type: @code{Object} or as specified by
+@code{%define stype}. Angle backets on @code{%token}, @code{type},
+@code{$@var{n}} and @code{$$} specify subtypes rather than fields of
+an union. The type of @code{$$}, even with angle brackets, is the base
+type since Java casts are not allow on the left-hand side of assignments.
+Also, @code{$@var{n}} and @code{@@@var{n}} are not allowed on the
+left-hand side of assignments. See @pxref{Java Semantic Values} and
+@pxref{Java Action Features}.
+
@item
The prolog declarations have a different meaning than in C/C++ code.
@table @asis
@end table
Other @code{%code} blocks are not supported in Java parsers.
+In particular, @code{%@{ @dots{} %@}} blocks should not be used
+and may give an error in future versions of Bison.
+
The epilogue has the same meaning as in C/C++ code and it can
-be used to define other classes used by the parser.
+be used to define other classes used by the parser @emph{outside}
+the parser class.
@end itemize
+
+@node Java Declarations Summary
+@subsection Java Declarations Summary
+
+This summary only include declarations specific to Java or have special
+meaning when used in a Java parser.
+
+@deffn {Directive} {%language "Java"}
+Generate a Java class for the parser.
+@end deffn
+
+@deffn {Directive} %lex-param @{@var{type} @var{name}@}
+A parameter for the lexer class defined by @code{%code lexer}
+@emph{only}, added as parameters to the lexer constructor and the parser
+constructor that @emph{creates} a lexer. Default is none.
+@xref{Java Scanner Interface}.
+@end deffn
+
+@deffn {Directive} %name-prefix "@var{prefix}"
+The prefix of the parser class name @code{@var{prefix}Parser} if
+@code{%define parser_class_name} is not used. Default is @code{YY}.
+@xref{Java Bison Interface}.
+@end deffn
+
+@deffn {Directive} %parse-param @{@var{type} @var{name}@}
+A parameter for the parser class added as parameters to constructor(s)
+and as fields initialized by the constructor(s). Default is none.
+@xref{Java Parser Interface}.
+@end deffn
+
+@deffn {Directive} %token <@var{type}> @var{token} @dots{}
+Declare tokens. Note that the angle brackets enclose a Java @emph{type}.
+@xref{Java Semantic Values}.
+@end deffn
+
+@deffn {Directive} %type <@var{type}> @var{nonterminal} @dots{}
+Declare the type of nonterminals. Note that the angle brackets enclose
+a Java @emph{type}.
+@xref{Java Semantic Values}.
+@end deffn
+
+@deffn {Directive} %code @{ @var{code} @dots{} @}
+Code appended to the inside of the parser class.
+@xref{Java Differences}.
+@end deffn
+
+@deffn {Directive} {%code imports} @{ @var{code} @dots{} @}
+Code inserted just after the @code{package} declaration.
+@xref{Java Differences}.
+@end deffn
+
+@deffn {Directive} {%code lexer} @{ @var{code} @dots{} @}
+Code added to the body of a inner lexer class within the parser class.
+@xref{Java Scanner Interface}.
+@end deffn
+
+@deffn {Directive} %% @var{code} @dots{}
+Code (after the second @code{%%}) appended to the end of the file,
+@emph{outside} the parser class.
+@xref{Java Differences}.
+@end deffn
+
+@deffn {Directive} %@{ @var{code} @dots{} %@}
+Not supported. Use @code{%code import} instead.
+@xref{Java Differences}.
+@end deffn
+
+@deffn {Directive} {%define abstract}
+Whether the parser class is declared @code{abstract}. Default is false.
+@xref{Java Bison Interface}.
+@end deffn
+
+@deffn {Directive} {%define extends} "@var{superclass}"
+The superclass of the parser class. Default is none.
+@xref{Java Bison Interface}.
+@end deffn
+
+@deffn {Directive} {%define final}
+Whether the parser class is declared @code{final}. Default is false.
+@xref{Java Bison Interface}.
+@end deffn
+
+@deffn {Directive} {%define implements} "@var{interfaces}"
+The implemented interfaces of the parser class, a comma-separated list.
+Default is none.
+@xref{Java Bison Interface}.
+@end deffn
+
+@deffn {Directive} {%define lex_throws} "@var{exceptions}"
+The exceptions thrown by the @code{yylex} method of the lexer, a
+comma-separated list. Default is @code{java.io.IOException}.
+@xref{Java Scanner Interface}.
+@end deffn
+
+@deffn {Directive} {%define location_type} "@var{class}"
+The name of the class used for locations (a range between two
+positions). This class is generated as an inner class of the parser
+class by @command{bison}. Default is @code{Location}.
+@xref{Java Location Values}.
+@end deffn
+
+@deffn {Directive} {%define package} "@var{package}"
+The package to put the parser class in. Default is none.
+@xref{Java Bison Interface}.
+@end deffn
+
+@deffn {Directive} {%define parser_class_name} "@var{name}"
+The name of the parser class. Default is @code{YYParser} or
+@code{@var{name-prefix}Parser}.
+@xref{Java Bison Interface}.
+@end deffn
+
+@deffn {Directive} {%define position_type} "@var{class}"
+The name of the class used for positions. This class must be supplied by
+the user. Default is @code{Position}.
+@xref{Java Location Values}.
+@end deffn
+
+@deffn {Directive} {%define public}
+Whether the parser class is declared @code{public}. Default is false.
+@xref{Java Bison Interface}.
+@end deffn
+
+@deffn {Directive} {%define stype} "@var{class}"
+The base type of semantic values. Default is @code{Object}.
+@xref{Java Semantic Values}.
+@end deffn
+
+@deffn {Directive} {%define strictfp}
+Whether the parser class is declared @code{strictfp}. Default is false.
+@xref{Java Bison Interface}.
+@end deffn
+
+@deffn {Directive} {%define throws} "@var{exceptions}"
+The exceptions thrown by user-supplied parser actions and
+@code{%initial-action}, a comma-separated list. Default is none.
+@xref{Java Parser Interface}.
+@end deffn
+
+
@c ================================================= FAQ
@node FAQ
# Java tests for simple calculator. -*- Autotest -*-
-# Copyright (C) 2007 Free Software Foundation, Inc.
+# Copyright (C) 2007, 2008 Free Software Foundation, Inc.
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
new Calc (System.in).parse ();
}
]])
+
+
+
+# -----------------#
+# Java Directives. #
+# -----------------#
+
+AT_BANNER([Java Parameters.])
+
+
+# AT_CHECK_JAVA_MINIMAL([DIRECTIVES], [PARSER_ACTION], [POSITION_CLASS])
+# ----------------------------------------------------------------------
+# Check that a mininal parser with DIRECTIVES compiles in Java.
+# Put the Java code in YYParser.java.
+m4_define([AT_CHECK_JAVA_MINIMAL],
+[
+AT_DATA([[YYParser.y]], [
+%language "Java"
+%locations
+%debug
+%error-verbose
+%token-table
+$1
+%%
+start: "end" {$2};
+%%
+class m4_default([$3], [Position]) {}
+])
+AT_BISON_CHECK([[YYParser.y]])
+AT_CHECK([[grep -q '[mb]4_' YYParser.y]], [1])
+AT_JAVA_COMPILE([[YYParser.java]])
+])
+
+
+# AT_CHECK_JAVA_MINIMAL_W_LEXER([1:DIRECTIVES], [2:LEX_THROWS],
+# [3:YYLEX_ACTION], [4:LEXER_BODY], [5:PARSER_ACTION], [6:STYPE],
+# [7:POSITION_TYPE], [8:LOCATION_TYPE])
+# ---------------------------------------------------------------------
+# Check that a mininal parser with DIRECTIVES and a "%code lexer".
+# YYLEX is the body of yylex () which throws LEX_THROW.
+# compiles in Java.
+m4_define([AT_CHECK_JAVA_MINIMAL_W_LEXER],
+[AT_CHECK_JAVA_MINIMAL([$1
+
+%code lexer
+{
+ m4_default([$6], [Object]) yylval;
+ public m4_default([$6], [Object]) getLVal() { return yylval; }
+
+ public m4_default([$7], [Position]) getStartPos() { return null; }
+ public m4_default([$7], [Position]) getEndPos() { return null; }
+
+ public void yyerror (m4_default([$8], [Location]) loc, String s)
+ {
+ System.err.println (loc + ": " + s);
+ }
+
+ public int yylex ()$2
+ {
+ $3
+ }
+
+ $4
+}], [$5], [$7])])
+
+
+# AT_CHECK_JAVA_GREP([LINE], [COUNT=1])
+# -------------------------------------
+# Check that YYParser.java contains exactly COUNT lines matching ^LINE$
+# with grep.
+m4_define([AT_CHECK_JAVA_GREP],
+ [AT_CHECK([grep -c '^$1$' YYParser.java], [], [m4_default([$2], [1])
+])
+])
+
+
+# ----------------------------------- #
+# Java parser class and package names #
+# ----------------------------------- #
+
+AT_SETUP([Java parser class and package names])
+
+AT_CHECK_JAVA_MINIMAL([])
+AT_CHECK_JAVA_GREP([[class YYParser]])
+
+AT_CHECK_JAVA_MINIMAL([[%name-prefix "Prefix"]])
+AT_CHECK_JAVA_GREP([[class PrefixParser]])
+
+AT_CHECK_JAVA_MINIMAL([[%define parser_class_name "ParserClassName"]])
+AT_CHECK_JAVA_GREP([[class ParserClassName]])
+
+AT_CHECK_JAVA_MINIMAL([[%define package "user_java_package"]])
+AT_CHECK_JAVA_GREP([[package user_java_package;]])
+
+AT_CLEANUP
+
+
+# --------------------------- #
+# Java parser class modifiers #
+# --------------------------- #
+
+AT_SETUP([Java parser class modifiers])
+
+AT_CHECK_JAVA_MINIMAL([[%define abstract]])
+AT_CHECK_JAVA_GREP([[abstract class YYParser]])
+
+AT_CHECK_JAVA_MINIMAL([[%define final]])
+AT_CHECK_JAVA_GREP([[final class YYParser]])
+
+AT_CHECK_JAVA_MINIMAL([[%define strictfp]])
+AT_CHECK_JAVA_GREP([[strictfp class YYParser]])
+
+AT_CHECK_JAVA_MINIMAL([[
+%define abstract
+%define strictfp]])
+AT_CHECK_JAVA_GREP([[abstract strictfp class YYParser]])
+
+AT_CHECK_JAVA_MINIMAL([[
+%define final
+%define strictfp]])
+AT_CHECK_JAVA_GREP([[final strictfp class YYParser]])
+
+AT_CHECK_JAVA_MINIMAL([[%define public]])
+AT_CHECK_JAVA_GREP([[public class YYParser]])
+
+AT_CHECK_JAVA_MINIMAL([[
+%define public
+%define abstract]])
+AT_CHECK_JAVA_GREP([[public abstract class YYParser]])
+
+AT_CHECK_JAVA_MINIMAL([[
+%define public
+%define final]])
+AT_CHECK_JAVA_GREP([[public final class YYParser]])
+
+AT_CHECK_JAVA_MINIMAL([[
+%define public
+%define strictfp]])
+AT_CHECK_JAVA_GREP([[public strictfp class YYParser]])
+
+AT_CHECK_JAVA_MINIMAL([[
+%define public
+%define abstract
+%define strictfp]])
+AT_CHECK_JAVA_GREP([[public abstract strictfp class YYParser]])
+
+AT_CHECK_JAVA_MINIMAL([[
+%define public
+%define final
+%define strictfp]])
+AT_CHECK_JAVA_GREP([[public final strictfp class YYParser]])
+
+AT_CLEANUP
+
+
+# ---------------------------------------- #
+# Java parser class extends and implements #
+# ---------------------------------------- #
+
+AT_SETUP([Java parser class extends and implements])
+
+AT_CHECK_JAVA_MINIMAL([[%define extends "Thread"]])
+AT_CHECK_JAVA_GREP([[class YYParser extends Thread]])
+
+AT_CHECK_JAVA_MINIMAL([[%define implements "Cloneable"]])
+AT_CHECK_JAVA_GREP([[class YYParser implements Cloneable]])
+
+AT_CHECK_JAVA_MINIMAL([[
+%define extends "Thread"
+%define implements "Cloneable"]])
+AT_CHECK_JAVA_GREP([[class YYParser extends Thread implements Cloneable]])
+
+AT_CLEANUP
+
+
+# -------------------------------- #
+# Java %parse-param and %lex-param #
+# -------------------------------- #
+
+AT_SETUP([Java %parse-param and %lex-param])
+
+AT_CHECK_JAVA_MINIMAL([])
+AT_CHECK_JAVA_GREP([[ *public YYParser (Lexer yylexer) {]])
+
+AT_CHECK_JAVA_MINIMAL([[%parse-param {int parse_param1}]])
+AT_CHECK_JAVA_GREP([[ *protected final int parse_param1;]])
+AT_CHECK_JAVA_GREP([[ *public YYParser (Lexer yylexer, *int parse_param1) {]])
+AT_CHECK_JAVA_GREP([[[ ]*this.parse_param1 = parse_param1;]])
+
+AT_CHECK_JAVA_MINIMAL([[
+%parse-param {int parse_param1}
+%parse-param {long parse_param2}]])
+AT_CHECK_JAVA_GREP([[ *protected final int parse_param1;]])
+AT_CHECK_JAVA_GREP([[ *protected final long parse_param2;]])
+AT_CHECK_JAVA_GREP([[ *public YYParser (Lexer yylexer, *int parse_param1, *long parse_param2) {]])
+AT_CHECK_JAVA_GREP([[[ ]*this.parse_param1 = parse_param1;]])
+AT_CHECK_JAVA_GREP([[[ ]*this.parse_param2 = parse_param2;]])
+
+AT_CHECK_JAVA_MINIMAL_W_LEXER([], [], [[return EOF;]])
+AT_CHECK_JAVA_GREP([[ *public YYParser () {]])
+AT_CHECK_JAVA_GREP([[ *protected YYParser (Lexer yylexer) {]])
+
+AT_CHECK_JAVA_MINIMAL_W_LEXER([[%parse-param {int parse_param1}]],
+ [], [[return EOF;]])
+AT_CHECK_JAVA_GREP([[ *protected final int parse_param1;]])
+AT_CHECK_JAVA_GREP([[ *public YYParser (int parse_param1) {]])
+AT_CHECK_JAVA_GREP([[ *protected YYParser (Lexer yylexer, *int parse_param1) {]])
+AT_CHECK_JAVA_GREP([[[ ]*this.parse_param1 = parse_param1;]], [2])
+
+AT_CHECK_JAVA_MINIMAL_W_LEXER([[
+%parse-param {int parse_param1}
+%parse-param {long parse_param2}]],
+ [], [[return EOF;]])
+AT_CHECK_JAVA_GREP([[ *protected final int parse_param1;]])
+AT_CHECK_JAVA_GREP([[ *protected final long parse_param2;]])
+AT_CHECK_JAVA_GREP([[ *public YYParser (int parse_param1, *long parse_param2) {]])
+AT_CHECK_JAVA_GREP([[ *protected YYParser (Lexer yylexer, *int parse_param1, *long parse_param2) {]])
+AT_CHECK_JAVA_GREP([[[ ]*this.parse_param1 = parse_param1;]], [2])
+AT_CHECK_JAVA_GREP([[[ ]*this.parse_param2 = parse_param2;]], [2])
+
+AT_CHECK_JAVA_MINIMAL_W_LEXER([[%lex-param {char lex_param1}]],
+ [], [[return EOF;]], [[YYLexer (char lex_param1) {}]])
+AT_CHECK_JAVA_GREP([[ *public YYParser (char lex_param1) {]])
+AT_CHECK_JAVA_GREP([[.* = new YYLexer *(lex_param1);]])
+
+AT_CHECK_JAVA_MINIMAL_W_LEXER([[
+%lex-param {char lex_param1}
+%lex-param {short lex_param2}]],
+ [], [[return EOF;]], [[YYLexer (char lex_param1, short lex_param2) {}]])
+AT_CHECK_JAVA_GREP([[ *public YYParser (char lex_param1, *short lex_param2) {]])
+AT_CHECK_JAVA_GREP([[.* = new YYLexer *(lex_param1, *lex_param2);]])
+
+AT_CHECK_JAVA_MINIMAL_W_LEXER([[
+%parse-param {int parse_param1}
+%parse-param {long parse_param2}
+%lex-param {char lex_param1}
+%lex-param {short lex_param2}]],
+ [], [[return EOF;]], [[YYLexer (char lex_param1, short lex_param2) {}]])
+AT_CHECK_JAVA_GREP([[ *protected final int parse_param1;]])
+AT_CHECK_JAVA_GREP([[ *protected final long parse_param2;]])
+AT_CHECK_JAVA_GREP([[ *public YYParser (char lex_param1, *short lex_param2, *int parse_param1, *long parse_param2) {]])
+AT_CHECK_JAVA_GREP([[.* = new YYLexer *(lex_param1, *lex_param2);]])
+AT_CHECK_JAVA_GREP([[ *protected YYParser (Lexer yylexer, *int parse_param1, *long parse_param2) {]])
+AT_CHECK_JAVA_GREP([[[ ]*this.parse_param1 = parse_param1;]], [2])
+AT_CHECK_JAVA_GREP([[[ ]*this.parse_param2 = parse_param2;]], [2])
+
+AT_CLEANUP
+
+
+# ------------------------- #
+# Java throw specifications #
+# ------------------------- #
+
+AT_SETUP([Java throws specifications])
+
+# %define throws - 0 1 2
+# %define lex-throws - 0 1 2
+# %code lexer 0 1
+
+m4_define([AT_JT_lex_throws_define], [m4_case(AT_JT_lex_throws,
+ -1, [],
+ 0, [[%define lex_throws ""]],
+ 1, [[%define lex_throws "InterruptedException"]],
+ 2, [[%define lex_throws "InterruptedException, IllegalAccessException"]])])
+
+m4_define([AT_JT_yylex_throws], [m4_case(AT_JT_lex_throws,
+ -1, [[ throws java.io.IOException]],
+ 0, [],
+ 1, [[ throws InterruptedException]],
+ 2, [[ throws InterruptedException, IllegalAccessException]])])
+
+m4_define([AT_JT_yylex_action], [m4_case(AT_JT_lex_throws,
+ -1, [[throw new java.io.IOException();]],
+ 0, [[return EOF;]],
+ 1, [[throw new InterruptedException();]],
+ 2, [[throw new IllegalAccessException();]])])
+
+
+m4_define([AT_JT_throws_define], [m4_case(AT_JT_throws,
+ -1, [],
+ 0, [[%define throws ""]],
+ 1, [[%define throws "ClassNotFoundException"]],
+ 2, [[%define throws "ClassNotFoundException, InstantiationException"]])])
+
+m4_define([AT_JT_yyaction_throws], [m4_case(AT_JT_throws,
+ -1, [],
+ 0, [],
+ 1, [[ throws ClassNotFoundException]],
+ 2, [[ throws ClassNotFoundException, InstantiationException]])])
+
+m4_define([AT_JT_parse_throws_2], [m4_case(AT_JT_throws,
+ -1, [],
+ 0, [],
+ 1, [[, ClassNotFoundException]],
+ 2, [[, ClassNotFoundException, InstantiationException]])])
+
+m4_define([AT_JT_parse_throws],
+ [m4_if(m4_quote(AT_JT_yylex_throws), [],
+ [AT_JT_yyaction_throws],
+ [AT_JT_yylex_throws[]AT_JT_parse_throws_2])])
+
+m4_define([AT_JT_initial_action], [m4_case(AT_JT_throws,
+ -1, [],
+ 0, [],
+ 1, [[%initial-action {if (true) throw new ClassNotFoundException();}]],
+ 2, [[%initial-action {if (true) throw new InstantiationException();}]])])
+
+m4_define([AT_JT_parse_action], [m4_case(AT_JT_throws,
+ -1, [],
+ 0, [],
+ 1, [[throw new ClassNotFoundException();]],
+ 2, [[throw new ClassNotFoundException();]])])
+
+m4_for([AT_JT_lexer], 0, 1, 1,
+ [m4_for([AT_JT_lex_throws], -1, 2, 1,
+ [m4_for([AT_JT_throws], -1, 2, 1,
+ [m4_if(AT_JT_lexer, 0,
+ [AT_CHECK_JAVA_MINIMAL([
+AT_JT_throws_define
+AT_JT_lex_throws_define
+AT_JT_initial_action],
+[AT_JT_parse_action])],
+ [AT_CHECK_JAVA_MINIMAL_W_LEXER([
+AT_JT_throws_define
+AT_JT_lex_throws_define
+AT_JT_initial_action],
+[AT_JT_yylex_throws],
+[AT_JT_yylex_action],
+[],
+[AT_JT_parse_action])])
+AT_CHECK_JAVA_GREP([[ *int yylex ()]AT_JT_yylex_throws *[;]])
+AT_CHECK_JAVA_GREP([[ *private int yyaction ([^)]*)]AT_JT_yyaction_throws[ *]])
+AT_CHECK_JAVA_GREP([[ *public boolean parse ()]AT_JT_parse_throws[ *]])
+])])])
+
+AT_CLEANUP
+
+
+# --------------------------------------------- #
+# Java stype, position_class and location_class #
+# --------------------------------------------- #
+
+AT_SETUP([Java stype, position_class and location_class])
+
+AT_CHECK_JAVA_MINIMAL([[
+%define stype "java.awt.Color"
+%type<java.awt.Color> start;
+%define location_type "MyLoc"
+%define position_type "MyPos"
+%code { class MyPos {} }]], [[$$ = $<java.awt.Color>1;]], [[MyPos]])
+AT_CHECK([[grep -q 'java.awt.Color' YYParser.java]])
+AT_CHECK([[egrep -v ' */?\*' YYParser.java | grep -q 'Position']], [1])
+AT_CHECK([[egrep -v ' */?\*' YYParser.java | grep -q 'Location']], [1])
+
+AT_CHECK_JAVA_MINIMAL_W_LEXER([[
+%define stype "java.awt.Color"
+%type<java.awt.Color> start;
+%define location_type "MyLoc"
+%define position_type "MyPos"
+%code { class MyPos {} }]], [], [[return EOF;]], [],
+[[$$ = $<java.awt.Color>1;]],
+[[java.awt.Color]], [[MyPos]], [[MyLoc]])
+AT_CHECK([[grep -q 'java.awt.Color' YYParser.java]])
+AT_CHECK([[egrep -v ' */?\*' YYParser.java | grep -q 'Position']], [1])
+AT_CHECK([[egrep -v ' */?\*' YYParser.java | grep -q 'Location']], [1])
+
+AT_CLEANUP
projects / bison.git / commitdiff
