]> git.saurik.com Git - bison.git/blame - data/c++.m4
Dub symbol_type_base as a public type.
[bison.git] / data / c++.m4
CommitLineData
08af01c2 1 -*- Autoconf -*-
cf147260
AD
2
3# C++ skeleton for Bison
4
7d3e21ba
AD
5# Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008 Free Software
6# Foundation, Inc.
cf147260 7
f16b0819 8# This program is free software: you can redistribute it and/or modify
cf147260 9# it under the terms of the GNU General Public License as published by
f16b0819 10# the Free Software Foundation, either version 3 of the License, or
cf147260 11# (at your option) any later version.
f16b0819 12#
cf147260
AD
13# This program is distributed in the hope that it will be useful,
14# but WITHOUT ANY WARRANTY; without even the implied warranty of
15# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16# GNU General Public License for more details.
f16b0819 17#
cf147260 18# You should have received a copy of the GNU General Public License
f16b0819 19# along with this program. If not, see <http://www.gnu.org/licenses/>.
cf147260 20
3953ed88
AD
21m4_include(b4_pkgdatadir/[c.m4])
22
cf147260
AD
23## ---------------- ##
24## Default values. ##
25## ---------------- ##
26
27# Default parser class name.
a4e25e1d
JD
28b4_percent_define_default([[parser_class_name]], [[parser]])
29b4_percent_define_default([[location_type]], [[location]])
30b4_percent_define_default([[filename_type]], [[std::string]])
31b4_percent_define_default([[namespace]], m4_defn([b4_prefix]))
c1d19e10 32b4_percent_define_default([[global_tokens_and_yystype]], [[false]])
a4e25e1d
JD
33b4_percent_define_default([[define_location_comparison]],
34 [m4_if(b4_percent_define_get([[filename_type]]),
c1d19e10 35 [std::string], [[true]], [[false]])])
cf147260
AD
36
37
793fbca5
JD
38## ----------- ##
39## Namespace. ##
40## ----------- ##
41
42m4_define([b4_namespace_ref], [b4_percent_define_get([[namespace]])])
43
44# Don't permit an empty b4_namespace_ref. Any `::parser::foo' appended to it
45# would compile as an absolute reference with `parser' in the global namespace.
46# b4_namespace_open would open an anonymous namespace and thus establish
47# internal linkage. This would compile. However, it's cryptic, and internal
48# linkage for the parser would be specified in all translation units that
49# include the header, which is always generated. If we ever need to permit
50# internal linkage somehow, surely we can find a cleaner approach.
51m4_if(m4_bregexp(b4_namespace_ref, [^[ ]*$]), [-1], [],
52[b4_complain_at(b4_percent_define_get_loc([[namespace]]),
53 [[namespace reference is empty]])])
54
55# Instead of assuming the C++ compiler will do it, Bison should reject any
56# invalid b4_namepsace_ref that would be converted to a valid
57# b4_namespace_open. The problem is that Bison doesn't always output
58# b4_namespace_ref to uncommented code but should reserve the ability to do so
59# in future releases without risking breaking any existing user grammars.
60# Specifically, don't allow empty names as b4_namespace_open would just convert
61# those into anonymous namespaces, and that might tempt some users.
62m4_if(m4_bregexp(b4_namespace_ref, [::[ ]*::]), [-1], [],
63[b4_complain_at(b4_percent_define_get_loc([[namespace]]),
64 [[namespace reference has consecutive "::"]])])
65m4_if(m4_bregexp(b4_namespace_ref, [::[ ]*$]), [-1], [],
66[b4_complain_at(b4_percent_define_get_loc([[namespace]]),
67 [[namespace reference has a trailing "::"]])])
68
69m4_define([b4_namespace_open],
70[b4_user_code([b4_percent_define_get_syncline([[namespace]])
71[namespace ]m4_bpatsubst(m4_dquote(m4_bpatsubst(m4_dquote(b4_namespace_ref),
72 [^\(.\)[ ]*::], [\1])),
73 [::], [ { namespace ])[ {]])])
74
75m4_define([b4_namespace_close],
76[b4_user_code([b4_percent_define_get_syncline([[namespace]])
77m4_bpatsubst(m4_dquote(m4_bpatsubst(m4_dquote(b4_namespace_ref),
78 [^\(.\)[ ]*\(::\)?\([^][:]\|:[^][:]\)*],
79 [\1])),
80 [::\([^][:]\|:[^][:]\)*], [} ])[} // ]b4_namespace_ref])])
81
82
cf147260
AD
83# b4_token_enums(LIST-OF-PAIRS-TOKEN-NAME-TOKEN-NUMBER)
84# -----------------------------------------------------
c095d689 85# Output the definition of the tokens as enums.
cf147260 86m4_define([b4_token_enums],
cf147260
AD
87[/* Tokens. */
88 enum yytokentype {
89m4_map_sep([ b4_token_enum], [,
90],
91 [$@])
92 };
c095d689 93])
cf147260
AD
94
95
96## ----------------- ##
97## Semantic Values. ##
98## ----------------- ##
99
b9e4eb5b
AD
100# b4_semantic_type_declare
101# ------------------------
102# Declare semantic_type.
103m4_define([b4_semantic_type_declare],
104[ /// Symbol semantic values.
105m4_ifdef([b4_stype],
106[ union semantic_type
107 {b4_user_stype
108 };],
109[m4_if(b4_tag_seen_flag, 0,
110[[ typedef int semantic_type;]],
111[[ typedef YYSTYPE semantic_type;]])])])
112
113
4f84717d
AD
114# b4_public_types_declare
115# -----------------------
116# Define the public types: token, semantic value, location, and so forth.
1d6b689b 117# Depending on %define token_lex, may be output in the header or source file.
4f84717d
AD
118m4_define([b4_public_types_declare],
119[[#ifndef YYSTYPE
120]b4_semantic_type_declare[
121#else
122 typedef YYSTYPE semantic_type;
123#endif]b4_locations_if([
124 /// Symbol locations.
125 typedef b4_percent_define_get([[location_type]]) location_type;])[
1d6b689b 126
4f84717d
AD
127 /// Tokens.
128 struct token
129 {
130 ]b4_token_enums(b4_tokens)[
131 };
1d6b689b 132
4f84717d
AD
133 /// Token type.
134 typedef token::yytokentype token_type;
1d6b689b
AD
135
136 /// A complete symbol, with its type.
137 template <typename Exact>
138 struct symbol_base_type
139 {
140 /// Default constructor.
141 inline symbol_base_type ();
142
143 /// Constructor.]b4_locations_if([
144 inline symbol_base_type (const location_type& l)])[;
145 inline symbol_base_type (]b4_args(
146 [const semantic_type& v],
147 b4_locations_if([const location_type& l]))[);
148
149 /// Return this with its exact type.
150 const Exact& self () const;
151 Exact& self ();
152
153 /// Return the type of this symbol.
154 int type_get () const;
155
156 /// The semantic value.
157 semantic_type value;]b4_locations_if([
158
159 /// The location.
160 location_type location;])[
161 };
162
163 /// External form of a symbol: its type and attributes.
164 struct symbol_type : symbol_base_type<symbol_type>
165 {
166 /// The parent class.
167 typedef symbol_base_type<symbol_type> super_type;
168
169 /// Default constructor.
170 inline symbol_type ();
171
172 /// Constructor.
173 inline symbol_type (]b4_args([int t],
174 [const semantic_type& v],
175 b4_locations_if([const location_type& l]))[);
176
177 inline symbol_type (]b4_args([int t],
178 b4_locations_if([const location_type& l]))[);
179
180 /// The symbol type.
181 int type;
182
183 /// Return the type corresponding to this state.
184 inline int type_get_ () const;
185
186 /// Its token.
187 inline token_type token () const;
188 };
4f84717d
AD
189]])
190
191
1d6b689b
AD
192# b4_public_types_define
193# ----------------------
194# Provide the implementation needed by the public types.
195m4_define([b4_public_types_define],
196[[ // symbol_base_type.
197 template <typename Exact>
198 ]b4_parser_class_name[::symbol_base_type<Exact>::symbol_base_type ()
199 : value()]b4_locations_if([
200 , location()])[
201 {
202 }]b4_locations_if([[
203
204 template <typename Exact>
205 ]b4_parser_class_name[::symbol_base_type<Exact>::symbol_base_type (const location_type& l)
206 : value()
207 , location(l)
208 {
209 }]])[
210
211 template <typename Exact>
212 ]b4_parser_class_name[::symbol_base_type<Exact>::symbol_base_type (]b4_args(
213 [const semantic_type& v],
214 b4_locations_if([const location_type& l]))[)
215 : value(v)]b4_locations_if([
216 , location(l)])[
217 {
218 }
219
220 template <typename Exact>
221 const Exact&
222 ]b4_parser_class_name[::symbol_base_type<Exact>::self () const
223 {
224 return static_cast<const Exact&>(*this);
225 }
226
227 template <typename Exact>
228 Exact&
229 ]b4_parser_class_name[::symbol_base_type<Exact>::self ()
230 {
231 return static_cast<Exact&>(*this);
232 }
233
234 template <typename Exact>
235 int
236 ]b4_parser_class_name[::symbol_base_type<Exact>::type_get () const
237 {
238 return self ().type_get_ ();
239 }
240
241 // symbol_type.
242 ]b4_parser_class_name[::symbol_type::symbol_type ()
243 : super_type ()
244 , type ()
245 {
246 }
247
248 ]b4_parser_class_name[::symbol_type::symbol_type (]b4_args(
249 [int t],
250 b4_locations_if([const location_type& l]))[)
251 : super_type (]b4_locations_if([l])[)
252 , type (t)
253 {
254 }
255
256 ]b4_parser_class_name[::symbol_type::symbol_type (]b4_args(
257 [int t],
258 [const semantic_type& v],
259 b4_locations_if([const location_type& l]))[)
260 : super_type (v]b4_locations_if([, l])[)
261 , type (t)
262 {
263 }
264
265 int
266 ]b4_parser_class_name[::symbol_type::type_get_ () const
267 {
268 return type;
269 }
270]b4_lex_symbol_if([[
271 ]b4_parser_class_name[::token_type
272 ]b4_parser_class_name[::symbol_type::token () const
273 {
274 // YYTOKNUM[NUM] -- (External) token number corresponding to the
275 // (internal) symbol number NUM (which must be that of a token). */
276 static
277 const ]b4_int_type_for([b4_toknum])[
278 yytoken_number_[] =
279 {
280 ]b4_toknum[
281 };
282 return static_cast<token_type> (yytoken_number_[type]);
283 }
284]])])
285
286
5ab8c47b
AD
287# b4_variant_if([IF-VARIANT-ARE-USED], [IF-NOT])
288# ----------------------------------------------
289m4_define([b4_variant_if],
290[b4_percent_define_ifdef([[variant]], [$1], [$2])])
291
cf147260
AD
292
293# b4_lhs_value([TYPE])
294# --------------------
295# Expansion of $<TYPE>$.
296m4_define([b4_lhs_value],
1fa5d8bb 297[b4_symbol_value([yyval], [$1])])
cf147260
AD
298
299
300# b4_rhs_value(RULE-LENGTH, NUM, [TYPE])
301# --------------------------------------
302# Expansion of $<TYPE>NUM, where the current rule has RULE-LENGTH
303# symbols on RHS.
304m4_define([b4_rhs_value],
1fa5d8bb
AD
305[b4_symbol_value([yysemantic_stack_@{($1) - ($2)@}], [$3])])
306
cf147260
AD
307
308# b4_lhs_location()
309# -----------------
310# Expansion of @$.
311m4_define([b4_lhs_location],
312[(yyloc)])
313
314
315# b4_rhs_location(RULE-LENGTH, NUM)
316# ---------------------------------
317# Expansion of @NUM, where the current rule has RULE-LENGTH symbols
318# on RHS.
319m4_define([b4_rhs_location],
d1ff7a7c 320[(yylocation_stack_@{($1) - ($2)@})])
cf147260
AD
321
322
323# b4_parse_param_decl
324# -------------------
325# Extra formal arguments of the constructor.
326# Change the parameter names from "foo" into "foo_yyarg", so that
327# there is no collision bw the user chosen attribute name, and the
328# argument name in the constructor.
329m4_define([b4_parse_param_decl],
330[m4_ifset([b4_parse_param],
331 [m4_map_sep([b4_parse_param_decl_1], [, ], [b4_parse_param])])])
332
333m4_define([b4_parse_param_decl_1],
334[$1_yyarg])
335
336
337
338# b4_parse_param_cons
339# -------------------
340# Extra initialisations of the constructor.
341m4_define([b4_parse_param_cons],
342 [m4_ifset([b4_parse_param],
fa7b79c0 343 [
cf147260
AD
344 b4_cc_constructor_calls(b4_parse_param)])])
345m4_define([b4_cc_constructor_calls],
346 [m4_map_sep([b4_cc_constructor_call], [,
347 ], [$@])])
348m4_define([b4_cc_constructor_call],
349 [$2 ($2_yyarg)])
350
351# b4_parse_param_vars
352# -------------------
353# Extra instance variables.
354m4_define([b4_parse_param_vars],
355 [m4_ifset([b4_parse_param],
356 [
357 /* User arguments. */
358b4_cc_var_decls(b4_parse_param)])])
359m4_define([b4_cc_var_decls],
360 [m4_map_sep([b4_cc_var_decl], [
361], [$@])])
362m4_define([b4_cc_var_decl],
363 [ $1;])