]> git.saurik.com Git - bison.git/blob - data/glr.cc
Use ususual GNU style.
[bison.git] / data / glr.cc
1 m4_divert(-1) -*- C -*-
2
3 # C++ GLR skeleton for Bison
4 # Copyright (C) 2002, 2003, 2004, 2005, 2006 Free Software 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 2 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, write to the Free Software
18 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
19 # 02110-1301 USA
20
21
22 # This skeleton produces a C++ class that encapsulates a C glr parser.
23 # This is in order to reduce the maintenance burden. The glr.c
24 # skeleton is clean and pure enough so that there are no real
25 # problems. The C++ interface is the same as that of lalr1.cc. In
26 # fact, glr.c can replace yacc.c without the user noticing any
27 # difference, and similarly for glr.cc replacing lalr1.cc.
28 #
29 # The passing of parse-params
30 #
31 # The additional arguments are stored as members of the parser
32 # object, yyparser. The C routines need to carry yyparser
33 # throughout the C parser; that easy: just let yyparser become an
34 # additional parse-param. But because the C++ skeleton needs to
35 # know the "real" original parse-param, we save them
36 # (b4_parse_param_orig). Note that b4_parse_param is overquoted
37 # (and c.m4 strips one level of quotes). This is a PITA, and
38 # explains why there are so many levels of quotes.
39 #
40 # The locations
41 #
42 # We use location.cc just like lalr1.cc, but because glr.c stores
43 # the locations in a (C++) union, the position and location classes
44 # must not have a constructor. Therefore, contrary to lalr1.cc, we
45 # must not define "b4_location_constructors". As a consequence the
46 # user must initialize the first positions (in particular the
47 # filename member).
48
49
50 # We require a pure interface using locations.
51 m4_define([b4_location_flag], [1])
52 m4_define([b4_pure], [1])
53
54 m4_include(b4_pkgdatadir/[c++.m4])
55 m4_include(b4_pkgdatadir/[location.cc])
56
57
58 # Save the parse parameters.
59 m4_define([b4_parse_param_orig], m4_defn([b4_parse_param]))
60
61
62 # b4_yy_symbol_print_generate
63 # ---------------------------
64 # Bypass the default implementation to generate the "yy_symbol_print"
65 # and "yy_symbol_value_print" functions.
66 m4_define([b4_yy_symbol_print_generate],
67 [[
68 /*--------------------.
69 | Print this symbol. |
70 `--------------------*/
71
72 ]b4_c_ansi_function_def([yy_symbol_print],
73 [static void],
74 [[FILE *], []],
75 [[int yytype], [yytype]],
76 [[const yy::b4_parser_class_name::semantic_type *yyvaluep],
77 [yyvaluep]],
78 [[const yy::b4_parser_class_name::location_type *yylocationp],
79 [yylocationp]],
80 b4_parse_param)[
81 {
82 ]b4_parse_param_use[]dnl
83 [ yyparser.yy_symbol_print_ (yytype, yyvaluep]b4_location_if([, yylocationp])[);
84 }
85 ]])
86
87
88 # Declare yyerror.
89 m4_append([b4_post_prologue],
90 [/* Line __line__ of glr.cc. */
91 b4_syncline([@oline@], [@ofile@])
92
93 b4_c_ansi_function_decl([yyerror],
94 [static void],
95 [[yy::b4_parser_class_name::location_type *yylocationp], [yylocationp]],
96 b4_parse_param,
97 [[const char* msg], [msg]])])
98
99
100 # Define yyerror.
101 m4_append([b4_epilogue],
102 [/* Line __line__ of glr.cc. */
103 b4_syncline([@oline@], [@ofile@])[
104 /*------------------.
105 | Report an error. |
106 `------------------*/
107
108 ]b4_c_ansi_function_def([yyerror],
109 [static void],
110 [[yy::b4_parser_class_name::location_type *yylocationp], [yylocationp]],
111 b4_parse_param,
112 [[const char* msg], [msg]])[
113 {
114 ]b4_parse_param_use[]dnl
115 [ yyparser.error (*yylocationp, msg);
116 }
117
118
119 namespace yy
120 {
121 ]dnl In this section, the parse param are the original parse_params.
122 m4_pushdef([b4_parse_param], m4_defn([b4_parse_param_orig]))dnl
123 [ /// Build a parser object.
124 ]b4_parser_class_name::b4_parser_class_name[ (]b4_parse_param_decl[)
125 : yycdebug_ (&std::cerr)]b4_parse_param_cons[
126 {
127 }
128
129 ]b4_parser_class_name::~b4_parser_class_name[ ()
130 {
131 }
132
133 int
134 ]b4_parser_class_name[::parse ()
135 {
136 return ::yyparse (*this]b4_user_args[);
137 }
138
139 #if YYDEBUG
140 /*--------------------.
141 | Print this symbol. |
142 `--------------------*/
143
144 inline void
145 ]b4_parser_class_name[::yy_symbol_value_print_ (int yytype,
146 const semantic_type* yyvaluep, const location_type* yylocationp)
147 {
148 /* Pacify ``unused variable'' warnings. */
149 YYUSE (yyvaluep);
150 YYUSE (yylocationp);
151 switch (yytype)
152 {
153 ]m4_map([b4_symbol_actions], m4_defn([b4_symbol_printers]))dnl
154 [ default:
155 break;
156 }
157 }
158
159
160 void
161 ]b4_parser_class_name[::yy_symbol_print_ (int yytype,
162 const semantic_type* yyvaluep, const location_type* yylocationp)
163 {
164 *yycdebug_ << (yytype < YYNTOKENS ? "token" : "nterm")
165 << ' ' << yytname[yytype] << " ("
166 << *yylocationp << ": ";
167 yy_symbol_value_print_ (yytype, yyvaluep, yylocationp);
168 *yycdebug_ << ')';
169 }
170
171 std::ostream&
172 ]b4_parser_class_name[::debug_stream () const
173 {
174 return *yycdebug_;
175 }
176
177 void
178 ]b4_parser_class_name[::set_debug_stream (std::ostream& o)
179 {
180 yycdebug_ = &o;
181 }
182
183
184 ]b4_parser_class_name[::debug_level_type
185 ]b4_parser_class_name[::debug_level () const
186 {
187 return ::yydebug;
188 }
189
190 void
191 ]b4_parser_class_name[::set_debug_level (debug_level_type l)
192 {
193 ::yydebug = l;
194 }
195
196 #endif /* ! YYDEBUG */
197 ]m4_popdef([b4_parse_param])dnl
198 [} // namespace yy
199
200 ]])
201
202
203 # Let glr.c believe that the user arguments include the parser itself.
204 m4_ifset([b4_parse_param],
205 [m4_pushdef([b4_parse_param],
206 m4_dquote([[[yy::b4_parser_class_name& yyparser], [[yyparser]]],]
207 m4_defn([b4_parse_param])))],
208 [m4_pushdef([b4_parse_param],
209 [[[[yy::b4_parser_class_name& yyparser], [[yyparser]]]]])
210 ])
211 m4_include(b4_pkgdatadir/[glr.c])
212 m4_popdef([b4_parse_param])
213
214
215 @output @output_header_name@
216 b4_copyright([C++ Skeleton parser for GLALR(1) parsing with Bison],
217 [2002, 2003, 2004, 2005, 2006])[
218
219 /* C++ GLR parser skeleton written by Akim Demaille. */
220
221 #ifndef PARSER_HEADER_H
222 # define PARSER_HEADER_H
223
224 #include <string>
225 #include <iostream>
226
227 /* Using locations. */
228 #define YYLSP_NEEDED ]b4_locations_flag[
229
230 namespace yy
231 {
232 class position;
233 class location;
234 }
235
236 /* Copy the first part of user declarations. */
237 ]b4_pre_prologue[
238
239 ]/* Line __line__ of glr.cc. */
240 b4_syncline([@oline@], [@ofile@])[
241
242 #include "location.hh"
243
244 /* Enabling traces. */
245 #ifndef YYDEBUG
246 # define YYDEBUG ]b4_debug[
247 #endif
248
249 /* Enabling verbose error messages. */
250 #ifdef YYERROR_VERBOSE
251 # undef YYERROR_VERBOSE
252 # define YYERROR_VERBOSE 1
253 #else
254 # define YYERROR_VERBOSE ]b4_error_verbose[
255 #endif
256
257 /* Enabling the token table. */
258 #ifndef YYTOKEN_TABLE
259 # define YYTOKEN_TABLE ]b4_token_table[
260 #endif
261
262 #if 0
263 /* Copy the second part of user declarations. */
264 ]b4_post_prologue[
265
266 ]/* Line __line__ of glr.cc. */
267
268 b4_syncline([@oline@], [@ofile@])[
269 #endif
270
271 /* YYLLOC_DEFAULT -- Set CURRENT to span from RHS[1] to RHS[N].
272 If N is 0, then set CURRENT to the empty location which ends
273 the previous symbol: RHS[0] (always defined). */
274
275 #ifndef YYLLOC_DEFAULT
276 # define YYLLOC_DEFAULT(Current, Rhs, N) \
277 do \
278 if (N) \
279 { \
280 (Current).begin = YYRHSLOC (Rhs, 1).begin; \
281 (Current).end = YYRHSLOC (Rhs, N).end; \
282 } \
283 else \
284 { \
285 (Current).begin = (Current).end = YYRHSLOC (Rhs, 0).end; \
286 } \
287 while (/*CONSTCOND*/ 0)
288 #endif
289
290 namespace yy
291 {
292 /// A Bison parser.
293 class ]b4_parser_class_name[
294 {
295 public:
296 /// Symbol semantic values.
297 #if ! defined (YYSTYPE)
298 ]m4_ifdef([b4_stype],
299 [ union semantic_type
300 b4_stype
301 /* Line __line__ of lalr1.cc. */
302 b4_syncline([@oline@], [@ofile@])
303 ;],
304 [ typedef int semantic_type;])[
305 #else
306 typedef YYSTYPE semantic_type;
307 #endif
308 /// Symbol locations.
309 typedef ]b4_location_type[ location_type;
310 /// Tokens.
311 struct token
312 {
313 ]b4_token_enums(b4_tokens)[
314 };
315
316 /// Build a parser object.
317 ]b4_parser_class_name[ (]b4_parse_param_decl[);
318 virtual ~]b4_parser_class_name[ ();
319
320 /// Parse.
321 /// \returns 0 iff parsing succeeded.
322 virtual int parse ();
323
324 /// The current debugging stream.
325 std::ostream& debug_stream () const;
326 /// Set the current debugging stream.
327 void set_debug_stream (std::ostream &);
328
329 /// Type for debugging levels.
330 typedef int debug_level_type;
331 /// The current debugging level.
332 debug_level_type debug_level () const;
333 /// Set the current debugging level.
334 void set_debug_level (debug_level_type l);
335
336 private:
337
338 public:
339 /// Report a syntax error.
340 /// \param loc where the syntax error is found.
341 /// \param msg a description of the syntax error.
342 virtual void error (const location_type& loc, const std::string& msg);
343 private:
344
345 #if YYDEBUG
346 public:
347 /// \brief Report a symbol value on the debug stream.
348 /// \param yytype The token type.
349 /// \param yyvaluep Its semantic value.
350 /// \param yylocationp Its location.
351 virtual void yy_symbol_value_print_ (int yytype,
352 const semantic_type* yyvaluep,
353 const location_type* yylocationp);
354 /// \brief Report a symbol on the debug stream.
355 /// \param yytype The token type.
356 /// \param yyvaluep Its semantic value.
357 /// \param yylocationp Its location.
358 virtual void yy_symbol_print_ (int yytype,
359 const semantic_type* yyvaluep,
360 const location_type* yylocationp);
361 private:
362 #endif /* ! YYDEBUG */
363
364
365 /// \brief Reclaim the memory associated to a symbol.
366 /// \param yymsg Why this token is reclaimed.
367 /// \param yytype The symbol type.
368 /// \param yyvaluep Its semantic value.
369 /// \param yylocationp Its location.
370 inline void yydestruct_ (const char* yymsg,
371 int yytype,
372 semantic_type* yyvaluep,
373 location_type* yylocationp);
374
375 /* Debugging. */
376 std::ostream* yycdebug_;
377 ]b4_parse_param_vars[
378 };
379
380 ]dnl Redirections for glr.c.
381 m4_ifset([b4_global_tokens_and_yystype],
382 [b4_token_defines(b4_tokens)])
383 [
384 #ifndef YYSTYPE
385 # define YYSTYPE yy::]b4_parser_class_name[::semantic_type
386 #endif
387 #ifndef YYLTYPE
388 # define YYLTYPE yy::]b4_parser_class_name[::location_type
389 #endif
390
391 }
392
393 #endif /* ! defined PARSER_HEADER_H */]