Future/bison
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/bison.git synced 2026-03-09 04:13:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

rename parser_class_name as api.parser.class

Browse Source 
The previous name was historical and inconsistent.

* src/muscle-tab.c (define_directive): Use the proper value passing
syntax, based on the muscle kind.
(muscle_percent_variable_update): Use the right value passing syntax.
Migrate from parser_class_name to api.parser.class.

* data/skeletons: Migrate from parser_class_name to api.parser.class.

* doc/bison.texi (%define Summary): Document both parser_class_name
and api.parser.class.
Promote the latter over the former.
This commit is contained in:
Akim Demaille
2019-01-01 16:55:52 +01:00
parent 092b787198
commit 890ee8a1fd
14 changed files with 112 additions and 60 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
NEWS
View File

@@ -22,6 +22,11 @@ GNU Bison NEWS
The use of the %error-verbose directive is deprecated in favor of "%define The use of the %error-verbose directive is deprecated in favor of "%define
parse.error verbose" since Bison 3.0, but no warning was issued. parse.error verbose" since Bison 3.0, but no warning was issued.
The following variables have been renamed for consistency. Backward
compatibility is ensured, but upgrading is recommended.
parser_class_name -> api.parser.class
** New features ** New features
*** Bison is now relocatable *** Bison is now relocatable

2
data/skeletons/README-D.txt
View File

@@ -44,7 +44,7 @@ public interface Lexer
- the following (non-standard) %defines are supported: - the following (non-standard) %defines are supported:
%define package "<package_name>" %define package "<package_name>"
%define parser_class_name "my_class_name>" %define api.parser.class "my_class_name>"
%define position_type "my_position_type" %define position_type "my_position_type"
%define location_type "my_location_type" %define location_type "my_location_type"

4
data/skeletons/c++.m4
View File

@@ -25,7 +25,7 @@ b4_percent_define_ifdef([[api.value.union.name]],
m4_include(b4_skeletonsdir/[c.m4]) m4_include(b4_skeletonsdir/[c.m4])
b4_percent_define_check_kind([api.namespace], [code], [deprecated]) b4_percent_define_check_kind([api.namespace], [code], [deprecated])
b4_percent_define_check_kind([parser_class_name], [code], [deprecated]) b4_percent_define_check_kind([api.parser.class], [code], [deprecated])
## ----- ## ## ----- ##
@@ -94,7 +94,7 @@ m4_define([b4_cxx_portability],
## Default values. ## ## Default values. ##
## ---------------- ## ## ---------------- ##
b4_percent_define_default([[parser_class_name]], [[parser]]) b4_percent_define_default([[api.parser.class]], [[parser]])
# Don't do that so that we remember whether we're using a user # Don't do that so that we remember whether we're using a user
# request, or the default value. # request, or the default value.

4
data/skeletons/d.m4
View File

@@ -178,8 +178,8 @@ b4_percent_define_default([[stype]], [[YYSemanticType]])])
# %name-prefix # %name-prefix
m4_define_default([b4_prefix], [[YY]]) m4_define_default([b4_prefix], [[YY]])
b4_percent_define_default([[parser_class_name]], [b4_prefix[]YYParser])]) b4_percent_define_default([[api.parser.class]], [b4_prefix[]YYParser])])
m4_define([b4_parser_class], [b4_percent_define_get([[parser_class_name]])]) m4_define([b4_parser_class], [b4_percent_define_get([[api.parser.class]])])
#b4_percent_define_default([[location_type]], [Location])]) #b4_percent_define_default([[location_type]], [Location])])
m4_define([b4_location_type], b4_percent_define_ifdef([[location_type]],[b4_percent_define_get([[location_type]])],[YYLocation])) m4_define([b4_location_type], b4_percent_define_ifdef([[location_type]],[b4_percent_define_get([[location_type]])],[YYLocation]))

2
data/skeletons/glr.cc
View File

@@ -50,7 +50,7 @@ m4_include(b4_skeletonsdir/[c++.m4])
b4_bison_locations_if([m4_include(b4_skeletonsdir/[location.cc])]) b4_bison_locations_if([m4_include(b4_skeletonsdir/[location.cc])])
m4_define([b4_parser_class], m4_define([b4_parser_class],
[b4_percent_define_get([[parser_class_name]])]) [b4_percent_define_get([[api.parser.class]])])
# Save the parse parameters. # Save the parse parameters.
m4_define([b4_parse_param_orig], m4_defn([b4_parse_param])) m4_define([b4_parse_param_orig], m4_defn([b4_parse_param]))

6
data/skeletons/java.m4
View File

@@ -180,7 +180,7 @@ b4_percent_define_check_kind([[extends]], [code], [deprecated])
b4_percent_define_check_kind([[implements]], [code], [deprecated]) b4_percent_define_check_kind([[implements]], [code], [deprecated])
b4_percent_define_check_kind([[init_throws]], [code], [deprecated]) b4_percent_define_check_kind([[init_throws]], [code], [deprecated])
b4_percent_define_check_kind([[lex_throws]], [code], [deprecated]) b4_percent_define_check_kind([[lex_throws]], [code], [deprecated])
b4_percent_define_check_kind([[parser_class_name]], [code], [deprecated]) b4_percent_define_check_kind([[api.parser.class]], [code], [deprecated])
b4_percent_define_check_kind([[throws]], [code], [deprecated]) b4_percent_define_check_kind([[throws]], [code], [deprecated])
@@ -195,8 +195,8 @@ b4_percent_define_default([[api.value.type]], [[Object]])
# %name-prefix # %name-prefix
m4_define_default([b4_prefix], [[YY]]) m4_define_default([b4_prefix], [[YY]])
b4_percent_define_default([[parser_class_name]], [b4_prefix[]Parser]) b4_percent_define_default([[api.parser.class]], [b4_prefix[]Parser])
m4_define([b4_parser_class], [b4_percent_define_get([[parser_class_name]])]) m4_define([b4_parser_class], [b4_percent_define_get([[api.parser.class]])])
b4_percent_define_default([[lex_throws]], [[java.io.IOException]]) b4_percent_define_default([[lex_throws]], [[java.io.IOException]])
m4_define([b4_lex_throws], [b4_percent_define_get([[lex_throws]])]) m4_define([b4_lex_throws], [b4_percent_define_get([[lex_throws]])])

2
data/skeletons/lalr1.cc
View File

@@ -138,7 +138,7 @@ m4_pushdef([b4_copyright_years],
[2002-2015, 2018]) [2002-2015, 2018])
m4_define([b4_parser_class], m4_define([b4_parser_class],
[b4_percent_define_get([[parser_class_name]])]) [b4_percent_define_get([[api.parser.class]])])
b4_bison_locations_if([# Backward compatibility. b4_bison_locations_if([# Backward compatibility.
m4_define([b4_location_constructors]) m4_define([b4_location_constructors])

77
doc/bison.texi
View File

@@ -1807,10 +1807,10 @@ token type is an identifier, that identifier is defined by Bison as a C
macro whose definition is the appropriate number. In this example, macro whose definition is the appropriate number. In this example,
therefore, @code{NUM} becomes a macro for @code{yylex} to use. therefore, @code{NUM} becomes a macro for @code{yylex} to use.
The semantic value of the token (if it has one) is stored into the The semantic value of the token (if it has one) is stored into the global
global variable @code{yylval}, which is where the Bison parser will look variable @code{yylval}, which is where the Bison parser will look for it.
for it. (The C data type of @code{yylval} is @code{YYSTYPE}, whose value (The C data type of @code{yylval} is @code{YYSTYPE}, whose value was defined
was defined at the beginning of the grammar via @samp{%define api.value.type at the beginning of the grammar via @samp{%define api.value.type
@{double@}}; @pxref{Rpcalc Declarations,,Declarations for @code{rpcalc}}.) @{double@}}; @pxref{Rpcalc Declarations,,Declarations for @code{rpcalc}}.)
A token type code of zero is returned if the end-of-input is encountered. A token type code of zero is returned if the end-of-input is encountered.
@@ -5987,6 +5987,29 @@ Introduced in Bison 2.7 for C, C++ and Java. Introduced under the name
@end itemize @end itemize
@end deffn @end deffn
@c ================================================== api.parser.class
@deffn Directive {%define api.parser.class} @{@var{name}@}
@itemize @bullet
@item Language(s):
C++, Java
@item Purpose:
The name of the parser class.
@item Accepted Values:
Any valid identifier.
@item Default Value:
In C++, @code{parser}. In Java, @code{YYParser} or
@code{@var{name-prefix}Parser} (@pxref{Java Bison Interface}).
@item History:
Introduced in Bison 3.3 to replace @code{parser_class_name}.
@end itemize
@end deffn
@c api.parser.class
@c ================================================== api.prefix @c ================================================== api.prefix
@deffn {Directive} {%define api.prefix} @{@var{prefix}@} @deffn {Directive} {%define api.prefix} @{@var{prefix}@}
@@ -6388,8 +6411,8 @@ LR(1) family. @xref{LR Table Construction}.
@c ================================================== namespace @c ================================================== namespace
@deffn Directive %define namespace @{@var{namespace}@} @deffn Directive %define namespace @{@var{namespace}@}
Obsoleted by @code{api.namespace} Obsoleted by @code{api.namespace}
@c namespace
@end deffn @end deffn
@c namespace
@c ================================================== parse.assert @c ================================================== parse.assert
@deffn Directive {%define parse.assert} @deffn Directive {%define parse.assert}
@@ -6472,6 +6495,17 @@ compiled.
@end deffn @end deffn
@c parse.trace @c parse.trace
@c ================================================== parser_class_name
@deffn Directive %define parser_class_name @{@var{name}@}
Obsoleted by @code{api.parser.class}
@end deffn
@c parser_class_name
@node %code Summary @node %code Summary
@subsection %code Summary @subsection %code Summary
@findex %code @findex %code
@@ -10950,19 +10984,19 @@ complete and accurate documentation.
@node C++ Parser Interface @node C++ Parser Interface
@subsection C++ Parser Interface @subsection C++ Parser Interface
@c - define parser_class_name @c - define api.parser.class
@c - Ctor @c - Ctor
@c - parse, error, set_debug_level, debug_level, set_debug_stream, @c - parse, error, set_debug_level, debug_level, set_debug_stream,
@c debug_stream. @c debug_stream.
@c - Reporting errors @c - Reporting errors
The output files @file{@var{file}.hh} and @file{@var{file}.cc} declare The output files @file{@var{file}.hh} and @file{@var{file}.cc} declare and
and define the parser class in the namespace @code{yy}. The class name define the parser class in the namespace @code{yy}. The class name defaults
defaults to @code{parser}, but may be changed using @samp{%define to @code{parser}, but may be changed using @samp{%define api.parser.class
parser_class_name @{@var{name}@}}. The interface of this class is detailed @{@var{name}@}}. The interface of this class is detailed below. It can be
below. It can be extended using the @code{%parse-param} feature: its extended using the @code{%parse-param} feature: its semantics is slightly
semantics is slightly changed since it describes an additional member of the changed since it describes an additional member of the parser class, and an
parser class, and an additional argument for its constructor. additional argument for its constructor.
@defcv {Type} {parser} {semantic_type} @defcv {Type} {parser} {semantic_type}
The types for semantic values. @xref{C++ Semantic Values}. The types for semantic values. @xref{C++ Semantic Values}.
@@ -12330,17 +12364,17 @@ properly, the position class should override the @code{equals} and
@node Java Parser Interface @node Java Parser Interface
@subsection Java Parser Interface @subsection Java Parser Interface
@c - define parser_class_name @c - define api.parser.class
@c - Ctor @c - Ctor
@c - parse, error, set_debug_level, debug_level, set_debug_stream, @c - parse, error, set_debug_level, debug_level, set_debug_stream,
@c debug_stream. @c debug_stream.
@c - Reporting errors @c - Reporting errors
The name of the generated parser class defaults to @code{YYParser}. The The name of the generated parser class defaults to @code{YYParser}. The
@code{YY} prefix may be changed using the @code{%name-prefix} directive @code{YY} prefix may be changed using the @code{%name-prefix} directive or
or the @option{-p}/@option{--name-prefix} option. Alternatively, use the @option{-p}/@option{--name-prefix} option. Alternatively, use
@samp{%define parser_class_name @{@var{name}@}} to give a custom name to @samp{%define api.parser.class @{@var{name}@}} to give a custom name to the
the class. The interface of this class is detailed below. class. The interface of this class is detailed below.
By default, the parser class has package visibility. A declaration By default, the parser class has package visibility. A declaration
@samp{%define public} will change to public visibility. Remember that, @samp{%define public} will change to public visibility. Remember that,
@@ -12719,7 +12753,7 @@ constructor that @emph{creates} a lexer. Default is none.
@deffn {Directive} %name-prefix "@var{prefix}" @deffn {Directive} %name-prefix "@var{prefix}"
The prefix of the parser class name @code{@var{prefix}Parser} if The prefix of the parser class name @code{@var{prefix}Parser} if
@samp{%define parser_class_name} is not used. Default is @code{YY}. @samp{%define api.parser.class} is not used. Default is @code{YY}.
@xref{Java Bison Interface}. @xref{Java Bison Interface}.
@end deffn @end deffn
@@ -12822,10 +12856,9 @@ The package to put the parser class in. Default is none.
@xref{Java Bison Interface}. @xref{Java Bison Interface}.
@end deffn @end deffn
@deffn {Directive} {%define parser_class_name} @{@var{name}@} @deffn {Directive} {%define api.parser.class} @{@var{name}@}
The name of the parser class. Default is @code{YYParser} or The name of the parser class. Default is @code{YYParser} or
@code{@var{name-prefix}Parser}. @code{@var{name-prefix}Parser}. @xref{Java Bison Interface}.
@xref{Java Bison Interface}.
@end deffn @end deffn
@deffn {Directive} {%define api.position.type} @{@var{class}@} @deffn {Directive} {%define api.position.type} @{@var{class}@}

2
examples/d/calc.y
View File

@@ -1,6 +1,6 @@
%language "D" %language "D"
%name-prefix "Calc" %name-prefix "Calc"
%define parser_class_name {Calc} %define api.parser.class {Calc}
%define public %define public
%define parse.error verbose %define parse.error verbose

2
examples/java/Calc.y
View File

@@ -1,6 +1,6 @@
%language "Java" %language "Java"
%name-prefix "Calc" %name-prefix "Calc"
%define parser_class_name {Calc} %define api.parser.class {Calc}
%define public %define public
%define parse.error verbose %locations %define parse.error verbose %locations

48
src/muscle-tab.c
View File

@@ -407,10 +407,16 @@ muscle_user_name_list_grow (char const *key, char const *user_name,
static static
char * char *
define_directive (char const *assignment, char const *value) define_directive (char const *assignment,
muscle_kind kind,
char const *value)
{ {
char *eq = strchr (assignment, '='); char *eq = strchr (assignment, '=');
char const *fmt = !eq && value && *value ? "%%define %s %s" : "%%define %s"; char const *fmt
= eq || !value || !*value ? "%%define %s"
: kind == muscle_code ? "%%define %s {%s}"
: kind == muscle_string ? "%%define %s \"%s\""
: "%%define %s %s";
char *res = xmalloc (strlen (fmt) + strlen (assignment) char *res = xmalloc (strlen (fmt) + strlen (assignment)
+ (value ? strlen (value) : 0)); + (value ? strlen (value) : 0));
sprintf (res, fmt, assignment, value); sprintf (res, fmt, assignment, value);
@@ -427,28 +433,31 @@ define_directive (char const *assignment, char const *value)
static static
char * char *
muscle_percent_variable_update (char const *variable, location variable_loc, muscle_percent_variable_update (char const *variable, location variable_loc,
muscle_kind kind,
char const **value) char const **value)
{ {
typedef struct typedef struct
{ {
const char *obsolete; const char *obsolete;
const char *updated; const char *updated;
muscle_kind kind;
} conversion_type; } conversion_type;
const conversion_type conversion[] = const conversion_type conversion[] =
{ {
{ "api.push_pull", "api.push-pull", }, { "api.push_pull", "api.push-pull", muscle_keyword },
{ "api.tokens.prefix", "api.token.prefix", }, { "api.tokens.prefix", "api.token.prefix", muscle_code },
{ "lex_symbol", "api.token.constructor", }, { "lex_symbol", "api.token.constructor", -1 },
{ "location_type", "api.location.type", }, { "location_type", "api.location.type", muscle_code },
{ "lr.default-reductions", "lr.default-reduction", }, { "lr.default-reductions", "lr.default-reduction", muscle_keyword },
{ "lr.keep-unreachable-states", "lr.keep-unreachable-state", }, { "lr.keep-unreachable-states", "lr.keep-unreachable-state", muscle_keyword },
{ "lr.keep_unreachable_states", "lr.keep-unreachable-state", }, { "lr.keep_unreachable_states", "lr.keep-unreachable-state", muscle_keyword },
{ "namespace", "api.namespace", }, { "namespace", "api.namespace", muscle_code },
{ "stype", "api.value.type", }, { "parser_class_name", "api.parser.class", muscle_code },
{ "variant=", "api.value.type=variant", }, { "stype", "api.value.type", -1 },
{ "variant=true", "api.value.type=variant", }, { "variant=", "api.value.type=variant", -1 },
{ NULL, NULL, } { "variant=true", "api.value.type=variant", -1 },
}; { NULL, NULL, -1, }
};
for (conversion_type const *c = conversion; c->obsolete; ++c) for (conversion_type const *c = conversion; c->obsolete; ++c)
{ {
@@ -458,8 +467,8 @@ muscle_percent_variable_update (char const *variable, location variable_loc,
&& STREQ (eq + 1, *value)) && STREQ (eq + 1, *value))
: STREQ (c->obsolete, variable)) : STREQ (c->obsolete, variable))
{ {
char *old = define_directive (c->obsolete, *value); char *old = define_directive (c->obsolete, kind, *value);
char *upd = define_directive (c->updated, *value); char *upd = define_directive (c->updated, c->kind, *value);
deprecated_directive (&variable_loc, old, upd); deprecated_directive (&variable_loc, old, upd);
free (old); free (old);
free (upd); free (upd);
@@ -483,7 +492,8 @@ muscle_percent_define_insert (char const *var, location variable_loc,
muscle_percent_define_how how) muscle_percent_define_how how)
{ {
/* Backward compatibility. */ /* Backward compatibility. */
char *variable = muscle_percent_variable_update (var, variable_loc, &value); char *variable
= muscle_percent_variable_update (var, variable_loc, kind, &value);
uniqstr name = muscle_name (variable, NULL); uniqstr name = muscle_name (variable, NULL);
uniqstr loc_name = muscle_name (variable, "loc"); uniqstr loc_name = muscle_name (variable, "loc");
uniqstr syncline_name = muscle_name (variable, "syncline"); uniqstr syncline_name = muscle_name (variable, "syncline");

8
tests/input.at
View File

@@ -1834,7 +1834,7 @@ AT_SETUP([["%define" Boolean variables]])
AT_DATA([Input.y], AT_DATA([Input.y],
[[%language "Java" [[%language "Java"
%define public maybe %define public maybe
%define parser_class_name {Input} %define api.parser.class {Input}
%% %%
start: %empty; start: %empty;
]]) ]])
@@ -1991,6 +1991,7 @@ AT_DATA([[input.y]],
%define namespace "foo" %define namespace "foo"
%define api.namespace {foo} %define api.namespace {foo}
%define variant %define variant
%define parser_class_name {parser}
%% %%
start: %empty; start: %empty;
]]) ]])
@@ -2001,7 +2002,7 @@ AT_BISON_CHECK([[-fcaret input.y]], [1], [],
input.y:2.9-34: warning: deprecated directive, use '%define lr.keep-unreachable-state maybe' [-Wdeprecated] input.y:2.9-34: warning: deprecated directive, use '%define lr.keep-unreachable-state maybe' [-Wdeprecated]
%define lr.keep_unreachable_states maybe %define lr.keep_unreachable_states maybe
^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^
input.y:3.9-17: warning: deprecated directive, use '%define api.namespace foo' [-Wdeprecated] input.y:3.9-17: warning: deprecated directive, use '%define api.namespace {foo}' [-Wdeprecated]
%define namespace "foo" %define namespace "foo"
^^^^^^^^^ ^^^^^^^^^
input.y:4.9-21: error: %define variable 'api.namespace' redefined input.y:4.9-21: error: %define variable 'api.namespace' redefined
@@ -2013,6 +2014,9 @@ input.y:3.9-17: previous definition
input.y:5.9-15: warning: deprecated directive, use '%define api.value.type variant' [-Wdeprecated] input.y:5.9-15: warning: deprecated directive, use '%define api.value.type variant' [-Wdeprecated]
%define variant %define variant
^^^^^^^ ^^^^^^^
input.y:6.9-25: warning: deprecated directive, use '%define api.parser.class {parser}' [-Wdeprecated]
%define parser_class_name {parser}
^^^^^^^^^^^^^^^^^
]]) ]])
AT_CLEANUP AT_CLEANUP

4
tests/java.at
View File

@@ -37,7 +37,7 @@ AT_DATA([Calc.y],
[[/* Infix notation calculator--calc */ [[/* Infix notation calculator--calc */
%language "Java" %language "Java"
%name-prefix "Calc" %name-prefix "Calc"
%define parser_class_name {Calc} %define api.parser.class {Calc}
%define public %define public
]$4[ ]$4[
@@ -463,7 +463,7 @@ AT_CHECK_JAVA_GREP([[class PrefixParser]])
AT_CHECK_JAVA_MINIMAL([[%define api.token.prefix {TOK_}]]) AT_CHECK_JAVA_MINIMAL([[%define api.token.prefix {TOK_}]])
AT_CHECK_JAVA_GREP([[.*TOK_END.*]]) AT_CHECK_JAVA_GREP([[.*TOK_END.*]])
AT_CHECK_JAVA_MINIMAL([[%define parser_class_name {ParserClassName}]]) AT_CHECK_JAVA_MINIMAL([[%define api.parser.class {ParserClassName}]])
AT_CHECK_JAVA_GREP([[class ParserClassName]]) AT_CHECK_JAVA_GREP([[class ParserClassName]])
AT_CHECK_JAVA_MINIMAL([[%define package {user_java_package}]]) AT_CHECK_JAVA_MINIMAL([[%define package {user_java_package}]])

6
tests/javapush.at
View File

@@ -44,7 +44,7 @@ AT_BANNER([[Java Push Parsing Tests]])
# This is missing main(), so two versions # This is missing main(), so two versions
# are instantiated with different main() procedures. # are instantiated with different main() procedures.
m4_define([AT_TRIVIAL_GRAMMAR],[ m4_define([AT_TRIVIAL_GRAMMAR],[
%define parser_class_name {YYParser} %define api.parser.class {YYParser}
%define parse.error verbose %define parse.error verbose
%code imports { %code imports {
@@ -346,7 +346,7 @@ AT_DATA([input],[[1 + 2 * 3 = 7
AT_DATA([Calc.y],[[/* Infix notation calculator--calc */ AT_DATA([Calc.y],[[/* Infix notation calculator--calc */
%language "Java" %language "Java"
%name-prefix "Calc" %name-prefix "Calc"
%define parser_class_name {Calc} %define api.parser.class {Calc}
%code { %code {
static class UserLexer implements Calc.Lexer static class UserLexer implements Calc.Lexer
@@ -620,7 +620,7 @@ AT_BISON_OPTION_PUSHDEFS
AT_DATA([Calc.y],[[/* Infix notation calculator--calc. */ AT_DATA([Calc.y],[[/* Infix notation calculator--calc. */
%language "Java" %language "Java"
%name-prefix "Calc" %name-prefix "Calc"
%define parser_class_name {Calc} %define api.parser.class {Calc}
%lex-param { Reader rdr } %lex-param { Reader rdr }
%locations %locations