data/java.m4

   1                                                             -*- Autoconf -*-
   2
   3 # Java language support for Bison
   4
   5 # Copyright (C) 2007-2012 Free Software Foundation, Inc.
   6
   7 # This program is free software: you can redistribute it and/or modify
   8 # it under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation, either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # This program is distributed in the hope that it will be useful,
  13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19
  20
  21 # b4_comment(TEXT)
  22 # ----------------
  23 m4_define([b4_comment], [/* m4_bpatsubst([$1], [
  24 ], [
  25    ])  */])
  26
  27
  28 # b4_list2(LIST1, LIST2)
  29 # --------------------------
  30 # Join two lists with a comma if necessary.
  31 m4_define([b4_list2],
  32           [$1[]m4_ifval(m4_quote($1), [m4_ifval(m4_quote($2), [[, ]])])[]$2])
  33
  34
  35 # b4_percent_define_get3(DEF, PRE, POST, NOT)
  36 # -------------------------------------------
  37 # Expand to the value of DEF surrounded by PRE and POST if it's %define'ed,
  38 # otherwise NOT.
  39 m4_define([b4_percent_define_get3],
  40           [m4_ifval(m4_quote(b4_percent_define_get([$1])),
  41                 [$2[]b4_percent_define_get([$1])[]$3], [$4])])
  42
  43
  44
  45 # b4_flag_value(BOOLEAN-FLAG)
  46 # ---------------------------
  47 m4_define([b4_flag_value], [b4_flag_if([$1], [true], [false])])
  48
  49
  50 # b4_public_if(TRUE, FALSE)
  51 # -------------------------
  52 b4_percent_define_default([[public]], [[false]])
  53 m4_define([b4_public_if],
  54 [b4_percent_define_flag_if([public], [$1], [$2])])
  55
  56
  57 # b4_abstract_if(TRUE, FALSE)
  58 # ---------------------------
  59 b4_percent_define_default([[abstract]], [[false]])
  60 m4_define([b4_abstract_if],
  61 [b4_percent_define_flag_if([abstract], [$1], [$2])])
  62
  63
  64 # b4_final_if(TRUE, FALSE)
  65 # ---------------------------
  66 b4_percent_define_default([[final]], [[false]])
  67 m4_define([b4_final_if],
  68 [b4_percent_define_flag_if([final], [$1], [$2])])
  69
  70
  71 # b4_strictfp_if(TRUE, FALSE)
  72 # ---------------------------
  73 b4_percent_define_default([[strictfp]], [[false]])
  74 m4_define([b4_strictfp_if],
  75 [b4_percent_define_flag_if([strictfp], [$1], [$2])])
  76
  77
  78 # b4_lexer_if(TRUE, FALSE)
  79 # ------------------------
  80 m4_define([b4_lexer_if],
  81 [b4_percent_code_ifdef([[lexer]], [$1], [$2])])
  82
  83
  84 # b4_identification
  85 # -----------------
  86 m4_define([b4_identification],
  87 [  /** Version number for the Bison executable that generated this parser.  */
  88   public static final String bisonVersion = "b4_version";
  89
  90   /** Name of the skeleton that generated this parser.  */
  91   public static final String bisonSkeleton = b4_skeleton;
  92 ])
  93
  94
  95 ## ------------ ##
  96 ## Data types.  ##
  97 ## ------------ ##
  98
  99 # b4_int_type(MIN, MAX)
 100 # ---------------------
 101 # Return the smallest int type able to handle numbers ranging from
 102 # MIN to MAX (included).
 103 m4_define([b4_int_type],
 104 [m4_if(b4_ints_in($@,   [-128],   [127]), [1], [byte],
 105        b4_ints_in($@, [-32768], [32767]), [1], [short],
 106                                                [int])])
 107
 108 # b4_int_type_for(NAME)
 109 # ---------------------
 110 # Return the smallest int type able to handle numbers ranging from
 111 # `NAME_min' to `NAME_max' (included).
 112 m4_define([b4_int_type_for],
 113 [b4_int_type($1_min, $1_max)])
 114
 115 # b4_null
 116 # -------
 117 m4_define([b4_null], [null])
 118
 119
 120 # b4_typed_parser_table_define(TYPE, NAME, DATA, COMMENT)
 121 # -------------------------------------------------------
 122 m4_define([b4_typed_parser_table_define],
 123 [m4_ifval([$4], [b4_comment([$4])
 124   ])dnl
 125 [private static final ]$1[ yy$2_[] = yy$2_init();
 126   private static final ]$1[[] yy$2_init()
 127   {
 128     return new ]$1[[]
 129     {
 130   ]$3[
 131     };
 132   }]])
 133
 134
 135 # b4_integral_parser_table_define(NAME, DATA, COMMENT)
 136 #-----------------------------------------------------
 137 m4_define([b4_integral_parser_table_define],
 138 [b4_typed_parser_table_define([b4_int_type_for([$2])], [$1], [$2], [$3])])
 139
 140
 141 ## ------------------------- ##
 142 ## Assigning token numbers.  ##
 143 ## ------------------------- ##
 144
 145 # b4_token_enum(TOKEN-NAME, TOKEN-NUMBER)
 146 # ---------------------------------------
 147 # Output the definition of this token as an enum.
 148 m4_define([b4_token_enum],
 149 [    /** Token number, to be returned by the scanner.  */
 150     static final int b4_percent_define_get([api.tokens.prefix])$1 = $2;
 151 ])
 152
 153
 154 # b4_token_enums(LIST-OF-PAIRS-TOKEN-NAME-TOKEN-NUMBER)
 155 # -----------------------------------------------------
 156 # Output the definition of the tokens (if there are) as enums.
 157 m4_define([b4_token_enums],
 158 [m4_if([$#$1], [1], [],
 159 [/* Tokens.  */
 160 m4_map([b4_token_enum], [$@])])
 161 ])
 162
 163 # b4-case(ID, CODE)
 164 # -----------------
 165 # We need to fool Java's stupid unreachable code detection.
 166 m4_define([b4_case], [  case $1:
 167   if (yyn == $1)
 168     $2;
 169   break;
 170     ])
 171
 172 # b4_predicate_case(LABEL, CONDITIONS)
 173 # ------------------------------------
 174 m4_define([b4_predicate_case], [  case $1:
 175      if (! ($2)) YYERROR;
 176     break;
 177     ])
 178
 179
 180 ## ---------------- ##
 181 ## Default values.  ##
 182 ## ---------------- ##
 183
 184 m4_define([b4_yystype], [b4_percent_define_get([[stype]])])
 185 b4_percent_define_default([[stype]], [[Object]])
 186
 187 # %name-prefix
 188 m4_define_default([b4_prefix], [[YY]])
 189
 190 b4_percent_define_default([[parser_class_name]], [b4_prefix[]Parser])
 191 m4_define([b4_parser_class_name], [b4_percent_define_get([[parser_class_name]])])
 192
 193 b4_percent_define_default([[lex_throws]], [[java.io.IOException]])
 194 m4_define([b4_lex_throws], [b4_percent_define_get([[lex_throws]])])
 195
 196 b4_percent_define_default([[throws]], [])
 197 m4_define([b4_throws], [b4_percent_define_get([[throws]])])
 198
 199 b4_percent_define_default([[init_throws]], [])
 200 m4_define([b4_init_throws], [b4_percent_define_get([[init_throws]])])
 201
 202 b4_percent_define_default([[location_type]], [Location])
 203 m4_define([b4_location_type], [b4_percent_define_get([[location_type]])])
 204
 205 b4_percent_define_default([[position_type]], [Position])
 206 m4_define([b4_position_type], [b4_percent_define_get([[position_type]])])
 207
 208
 209 ## ----------------- ##
 210 ## Semantic Values.  ##
 211 ## ----------------- ##
 212
 213
 214 # b4_lhs_value([TYPE])
 215 # --------------------
 216 # Expansion of $<TYPE>$.
 217 m4_define([b4_lhs_value], [yyval])
 218
 219
 220 # b4_rhs_value(RULE-LENGTH, NUM, [TYPE])
 221 # --------------------------------------
 222 # Expansion of $<TYPE>NUM, where the current rule has RULE-LENGTH
 223 # symbols on RHS.
 224 #
 225 # In this simple implementation, %token and %type have class names
 226 # between the angle brackets.
 227 m4_define([b4_rhs_value],
 228 [(m4_ifval($3, [($3)])[](yystack.valueAt ($1-($2))))])
 229
 230 # b4_lhs_location()
 231 # -----------------
 232 # Expansion of @$.
 233 m4_define([b4_lhs_location],
 234 [(yyloc)])
 235
 236
 237 # b4_rhs_location(RULE-LENGTH, NUM)
 238 # ---------------------------------
 239 # Expansion of @NUM, where the current rule has RULE-LENGTH symbols
 240 # on RHS.
 241 m4_define([b4_rhs_location],
 242 [yystack.locationAt ($1-($2))])
 243
 244
 245 # b4_lex_param
 246 # b4_parse_param
 247 # --------------
 248 # If defined, b4_lex_param arrives double quoted, but below we prefer
 249 # it to be single quoted.  Same for b4_parse_param.
 250
 251 # TODO: should be in bison.m4
 252 m4_define_default([b4_lex_param], [[]])
 253 m4_define([b4_lex_param], b4_lex_param)
 254 m4_define([b4_parse_param], b4_parse_param)
 255
 256 # b4_lex_param_decl
 257 # -----------------
 258 # Extra formal arguments of the constructor.
 259 m4_define([b4_lex_param_decl],
 260 [m4_ifset([b4_lex_param],
 261           [b4_remove_comma([$1],
 262                            b4_param_decls(b4_lex_param))],
 263           [$1])])
 264
 265 m4_define([b4_param_decls],
 266           [m4_map([b4_param_decl], [$@])])
 267 m4_define([b4_param_decl], [, $1])
 268
 269 m4_define([b4_remove_comma], [m4_ifval(m4_quote($1), [$1, ], [])m4_shift2($@)])
 270
 271
 272
 273 # b4_parse_param_decl
 274 # -------------------
 275 # Extra formal arguments of the constructor.
 276 m4_define([b4_parse_param_decl],
 277 [m4_ifset([b4_parse_param],
 278           [b4_remove_comma([$1],
 279                            b4_param_decls(b4_parse_param))],
 280           [$1])])
 281
 282
 283
 284 # b4_lex_param_call
 285 # -----------------
 286 # Delegating the lexer parameters to the lexer constructor.
 287 m4_define([b4_lex_param_call],
 288           [m4_ifset([b4_lex_param],
 289                     [b4_remove_comma([$1],
 290                                      b4_param_calls(b4_lex_param))],
 291                     [$1])])
 292 m4_define([b4_param_calls],
 293           [m4_map([b4_param_call], [$@])])
 294 m4_define([b4_param_call], [, $2])
 295
 296
 297
 298 # b4_parse_param_cons
 299 # -------------------
 300 # Extra initialisations of the constructor.
 301 m4_define([b4_parse_param_cons],
 302           [m4_ifset([b4_parse_param],
 303                     [b4_constructor_calls(b4_parse_param)])])
 304
 305 m4_define([b4_constructor_calls],
 306           [m4_map([b4_constructor_call], [$@])])
 307 m4_define([b4_constructor_call],
 308           [this.$2 = $2;
 309           ])
 310
 311
 312
 313 # b4_parse_param_vars
 314 # -------------------
 315 # Extra instance variables.
 316 m4_define([b4_parse_param_vars],
 317           [m4_ifset([b4_parse_param],
 318                     [
 319     /* User arguments.  */
 320 b4_var_decls(b4_parse_param)])])
 321
 322 m4_define([b4_var_decls],
 323           [m4_map_sep([b4_var_decl], [
 324 ], [$@])])
 325 m4_define([b4_var_decl],
 326           [    protected final $1;])
 327
 328
 329
 330 # b4_maybe_throws(THROWS)
 331 # -----------------------
 332 # Expand to either an empty string or "throws THROWS".
 333 m4_define([b4_maybe_throws],
 334           [m4_ifval($1, [throws $1])])