gcc/java/parse.h

   1 /* Language parser definitions for the GNU compiler for the Java(TM) language.
   2    Copyright (C) 1997, 1998, 1999, 2000 Free Software Foundation, Inc.
   3    Contributed by Alexandre Petit-Bianco (apbianco@cygnus.com)
   4
   5 This file is part of GNU CC.
   6
   7 GNU CC 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 2, or (at your option)
  10 any later version.
  11
  12 GNU CC 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 GNU CC; see the file COPYING.  If not, write to
  19 the Free Software Foundation, 59 Temple Place - Suite 330,
  20 Boston, MA 02111-1307, USA.
  21
  22 Java and all Java-based marks are trademarks or registered trademarks
  23 of Sun Microsystems, Inc. in the United States and other countries.
  24 The Free Software Foundation is independent of Sun Microsystems, Inc.  */
  25
  26 #ifndef JV_LANG_H
  27 #define JV_LANG_H
  28
  29 #include "lex.h"
  30
  31 /* Extern global variable declarations */
  32 extern int java_error_count;
  33 extern struct obstack temporary_obstack;
  34 extern struct obstack permanent_obstack;
  35 extern int quiet_flag;
  36
  37 #ifndef JC1_LITE
  38 /* Function extern to java/ */
  39 extern int int_fits_type_p PARAMS ((tree, tree));
  40 extern tree stabilize_reference PARAMS ((tree));
  41 #endif
  42
  43 /* Macros for verbose debug info  */
  44 #ifdef  VERBOSE_SKELETON
  45 #define RULE( rule ) printf ( "jv_yacc:%d: rule %s\n", lineno, rule )
  46 #else
  47 #define RULE( rule )
  48 #endif
  49
  50 #ifdef VERBOSE_SKELETON
  51 #undef SOURCE_FRONTEND_DEBUG
  52 #define SOURCE_FRONTEND_DEBUG(X)                                \
  53   {if (!quiet_flag) {printf ("* "); printf X; putchar ('\n');} }
  54 #else
  55 #define SOURCE_FRONTEND_DEBUG(X)
  56 #endif
  57
  58 /* Macro for error recovering  */
  59 #ifdef YYDEBUG
  60 #define RECOVERED                                       \
  61   { if (!quiet_flag) {printf ("** Recovered\n");} }
  62 #define DRECOVERED(s)                                           \
  63   { if (!quiet_flag) {printf ("** Recovered (%s)\n", #s);}}
  64 #else
  65 #define RECOVERED
  66 #define DRECOVERED(s)
  67 #endif
  68
  69 #define DRECOVER(s) {yyerrok; DRECOVERED(s);}
  70 #define RECOVER     {yyerrok; RECOVERED;}
  71
  72 #define YYERROR_NOW ctxp->java_error_flag = 1
  73 #define YYNOT_TWICE if (ctxp->prevent_ese != lineno)
  74
  75 /* Accepted modifiers */
  76 #define CLASS_MODIFIERS ACC_PUBLIC|ACC_ABSTRACT|ACC_FINAL
  77 #define FIELD_MODIFIERS ACC_PUBLIC|ACC_PROTECTED|ACC_PRIVATE|ACC_FINAL| \
  78                         ACC_STATIC|ACC_TRANSIENT|ACC_VOLATILE
  79 #define METHOD_MODIFIERS ACC_PUBLIC|ACC_PROTECTED|ACC_PRIVATE|ACC_ABSTRACT| \
  80                          ACC_STATIC|ACC_FINAL|ACC_SYNCHRONIZED|ACC_NATIVE
  81 #define INTERFACE_MODIFIERS ACC_PUBLIC|ACC_ABSTRACT
  82 #define INTERFACE_METHOD_MODIFIERS ACC_PUBLIC|ACC_ABSTRACT
  83 #define INTERFACE_FIELD_MODIFIERS ACC_PUBLIC|ACC_STATIC|ACC_FINAL
  84
  85 /* Getting a modifier WFL */
  86 #define MODIFIER_WFL(M)   (ctxp->modifier_ctx [(M) - PUBLIC_TK])
  87
  88 /* Check on modifiers */
  89 #define THIS_MODIFIER_ONLY(f, m, v, count, l)                           \
  90   if ((f) & (m))                                                        \
  91     {                                                                   \
  92       tree node = MODIFIER_WFL (v);                                     \
  93       if ((l)                                                           \
  94           && ((EXPR_WFL_COLNO (node) > EXPR_WFL_COLNO (l))              \
  95               || (EXPR_WFL_LINENO (node) > EXPR_WFL_LINENO (l))))       \
  96         l = node;                                                       \
  97       else if (!(l))                                                    \
  98         l = node;                                                       \
  99       count++;                                                          \
 100     }
 101
 102 #define ABSTRACT_CHECK(FLAG, V, CL, S)                          \
 103   if ((FLAG) & (V))                                             \
 104     parse_error_context ((CL), "%s method can't be abstract", (S));
 105
 106 #define JCONSTRUCTOR_CHECK(FLAG, V, CL, S)                      \
 107   if ((FLAG) & (V))                                             \
 108     parse_error_context ((CL), "Constructor can't be %s", (S)); \
 109
 110 /* Misc. */
 111 #define exit_java_complete_class()              \
 112   {                                             \
 113     pop_obstacks ();                            \
 114     return;                                     \
 115   }
 116
 117 #define CLASS_OR_INTERFACE(decl, s1, s2)                        \
 118    (decl ?                                                      \
 119     ((get_access_flags_from_decl (TYPE_NAME (TREE_TYPE (decl))) \
 120       & ACC_INTERFACE) ?                                        \
 121      s2 : s1) : ((s1 [0]=='S'|| s1 [0]=='s') ?                  \
 122                  (s1 [0]=='S' ? "Supertype" : "supertype") :    \
 123                  (s1 [0] > 'A' ? "Type" : "type")))
 124
 125 #define GET_REAL_TYPE(TYPE)                                     \
 126   (TREE_CODE (TYPE) == TREE_LIST ? TREE_PURPOSE (TYPE) : TYPE)
 127
 128 #define GET_METHOD_NAME(METHOD)                                 \
 129   (TREE_CODE (DECL_NAME (METHOD)) == EXPR_WITH_FILE_LOCATION ?  \
 130    EXPR_WFL_NODE (DECL_NAME (METHOD)) : DECL_NAME (METHOD))
 131
 132 /* Get TYPE name string, regardless whether TYPE is a class or an
 133    array. */
 134 #define GET_TYPE_NAME(TYPE)                             \
 135   (TREE_CODE (TYPE_NAME (TYPE)) == IDENTIFIER_NODE ?    \
 136    IDENTIFIER_POINTER (TYPE_NAME (TYPE)) :              \
 137    IDENTIFIER_POINTER (DECL_NAME (TYPE_NAME (TYPE))))
 138
 139 /* Pedantic warning on obsolete modifiers. Note: when cl is NULL,
 140    flags was set artificially, such as for a interface method */
 141 #define OBSOLETE_MODIFIER_WARNING(cl, flags, __modifier, arg)                \
 142   {                                                                          \
 143     if (flag_redundant && (cl) && ((flags) & (__modifier)))                  \
 144       parse_warning_context (cl,                                             \
 145      "Discouraged redundant use of `%s' modifier in declaration of %s",      \
 146                              java_accstring_lookup (__modifier), arg);       \
 147   }
 148 #define OBSOLETE_MODIFIER_WARNING2(cl, flags, __modifier, arg1, arg2)        \
 149   {                                                                          \
 150     if (flag_redundant && (cl) && ((flags) & (__modifier)))                  \
 151       parse_warning_context (cl,                                             \
 152      "Discouraged redundant use of `%s' modifier in declaration of %s `%s'", \
 153                              java_accstring_lookup (__modifier), arg1, arg2);\
 154   }
 155
 156 /* Quickly build a temporary pointer on hypothetical type NAME. */
 157 #define BUILD_PTR_FROM_NAME(ptr, name)          \
 158   {                                             \
 159     ptr = build (POINTER_TYPE, NULL_TREE);      \
 160     TYPE_NAME (ptr) = name;                     \
 161   }
 162
 163 #define INCOMPLETE_TYPE_P(NODE)                         \
 164   ((TREE_CODE (NODE) == POINTER_TYPE)                   \
 165    && !TREE_TYPE (NODE)                                 \
 166    && TREE_CODE (TYPE_NAME (NODE)) == IDENTIFIER_NODE)
 167
 168 /* Set the EMIT_LINE_NOTE flag of a EXPR_WLF to 1 if debug information
 169    are requested. Works in the context of a parser rule. */
 170 #define JAVA_MAYBE_GENERATE_DEBUG_INFO(node)            \
 171   (debug_info_level != DINFO_LEVEL_NONE ?               \
 172     EXPR_WFL_EMIT_LINE_NOTE (node) = 1, node : node)
 173
 174 /* Types classification, according to the JLS, section 4.2 */
 175 #define JFLOAT_TYPE_P(TYPE)      (TYPE && TREE_CODE ((TYPE)) == REAL_TYPE)
 176 #define JINTEGRAL_TYPE_P(TYPE)   ((TYPE)                                   \
 177                                   && (TREE_CODE ((TYPE)) == INTEGER_TYPE   \
 178                                       || TREE_CODE ((TYPE)) == CHAR_TYPE))
 179 #define JNUMERIC_TYPE_P(TYPE)    ((TYPE)                                \
 180                                   && (JFLOAT_TYPE_P ((TYPE))            \
 181                                       || JINTEGRAL_TYPE_P ((TYPE))))
 182 #define JPRIMITIVE_TYPE_P(TYPE)  ((TYPE)                                  \
 183                                   && (JNUMERIC_TYPE_P ((TYPE))            \
 184                                   || TREE_CODE ((TYPE)) == BOOLEAN_TYPE))
 185
 186 #define JBSC_TYPE_P(TYPE) ((TYPE) && (((TYPE) == byte_type_node)        \
 187                                       || ((TYPE) == short_type_node)    \
 188                                       || ((TYPE) == char_type_node)))
 189
 190 /* Not defined in the LRM */
 191 #define JSTRING_TYPE_P(TYPE) ((TYPE)                                       \
 192                               && ((TYPE) == string_type_node ||            \
 193                                   (TREE_CODE (TYPE) == POINTER_TYPE &&     \
 194                                    TREE_TYPE (TYPE) == string_type_node)))
 195 #define JSTRING_P(NODE) ((NODE)                                         \
 196                          && (TREE_CODE (NODE) == STRING_CST             \
 197                              || IS_CRAFTED_STRING_BUFFER_P (NODE)       \
 198                              || JSTRING_TYPE_P (TREE_TYPE (NODE))))
 199
 200 #define JREFERENCE_TYPE_P(TYPE) ((TYPE)                                       \
 201                                  && (TREE_CODE (TYPE) == RECORD_TYPE          \
 202                                      || (TREE_CODE (TYPE) == POINTER_TYPE     \
 203                                          &&  TREE_CODE (TREE_TYPE (TYPE)) ==  \
 204                                          RECORD_TYPE)))
 205 #define JNULLP_TYPE_P(TYPE) ((TYPE) && (TREE_CODE (TYPE) == POINTER_TYPE) \
 206                              && (TYPE) == TREE_TYPE (null_pointer_node))
 207
 208 /* Other predicates */
 209 #define JDECL_P(NODE) (NODE && (TREE_CODE (NODE) == PARM_DECL           \
 210                                 || TREE_CODE (NODE) == VAR_DECL         \
 211                                 || TREE_CODE (NODE) == FIELD_DECL))
 212
 213 #define TYPE_INTERFACE_P(TYPE)                                  \
 214   (CLASS_P (TYPE) && CLASS_INTERFACE (TYPE_NAME (TYPE)))
 215
 216 #define TYPE_CLASS_P(TYPE) (CLASS_P (TYPE)                              \
 217                             && !CLASS_INTERFACE (TYPE_NAME (TYPE)))
 218
 219 /* Identifier business related to 1.1 language extensions.  */
 220
 221 #define IDENTIFIER_INNER_CLASS_OUTER_FIELD_ACCESS(NODE) \
 222   (TREE_CODE (NODE) == IDENTIFIER_NODE &&               \
 223    IDENTIFIER_LENGTH (NODE) >= 8 &&                     \
 224    IDENTIFIER_POINTER (NODE)[7] != '0')
 225
 226 /* Build the string val$<O> and store it into N. The is used to
 227    construct the name of inner class hidden fields used to alias outer
 228    scope local variables.  */
 229 #define MANGLE_OUTER_LOCAL_VARIABLE_NAME(N, O)                          \
 230   {                                                                     \
 231     obstack_grow (&temporary_obstack, "val$", 4);                       \
 232     obstack_grow (&temporary_obstack,                                   \
 233                   IDENTIFIER_POINTER ((O)), IDENTIFIER_LENGTH ((O)));   \
 234     obstack_1grow (&temporary_obstack, '\0');                           \
 235     (N) = obstack_finish (&temporary_obstack);                          \
 236   }
 237
 238 /* Build the string parm$<O> and store in into the identifier N. This
 239    is used to contruct the name of hidden parameters used to
 240    initialize outer scope aliases.  */
 241 #define MANGLE_ALIAS_INITIALIZER_PARAMETER_NAME_ID(N, O)                \
 242   {                                                                     \
 243     obstack_grow (&temporary_obstack, "parm$", 5);                      \
 244     obstack_grow (&temporary_obstack,                                   \
 245                   IDENTIFIER_POINTER ((O)), IDENTIFIER_LENGTH ((O)));   \
 246     obstack_1grow (&temporary_obstack, '\0');                           \
 247     (N) = obstack_finish (&temporary_obstack);                          \
 248   }
 249
 250 #define MANGLE_ALIAS_INITIALIZER_PARAMETER_NAME_STR(N, S)       \
 251   {                                                             \
 252     obstack_grow (&temporary_obstack, "parm$", 5);              \
 253     obstack_grow (&temporary_obstack, (S), strlen ((S)));       \
 254     obstack_1grow (&temporary_obstack, '\0');                   \
 255     (N) = obstack_finish (&temporary_obstack);                  \
 256   }
 257
 258 /* Skip THIS and artificial parameters found in function decl M and
 259    assign the result to C. We don't do that for $finit$, since it's
 260    knowingly called with artificial parms.  */
 261 #define SKIP_THIS_AND_ARTIFICIAL_PARMS(C,M)                     \
 262   {                                                             \
 263     int i;                                                      \
 264     (C) = TYPE_ARG_TYPES (TREE_TYPE ((M)));                     \
 265     if (!METHOD_STATIC ((M)))                                   \
 266       (C) = TREE_CHAIN (C);                                     \
 267     if (DECL_CONSTRUCTOR_P ((M))                                \
 268         && PURE_INNER_CLASS_TYPE_P (DECL_CONTEXT ((M))))        \
 269       (C) = TREE_CHAIN (C);                                     \
 270     if (!DECL_FINIT_P ((M)))                                    \
 271       for (i = DECL_FUNCTION_NAP ((M)); i; i--)                 \
 272        (C) = TREE_CHAIN (C);                                    \
 273   }
 274
 275 /* Mark final parameters in method M, by comparison of the argument
 276    list L. This macro is used to set the flag once the method has been
 277    build.  */
 278 #define MARK_FINAL_PARMS(M, L)                                          \
 279   {                                                                     \
 280     tree current = TYPE_ARG_TYPES (TREE_TYPE ((M)));                    \
 281     tree list = (L);                                                    \
 282     if (!METHOD_STATIC ((M)))                                           \
 283       current = TREE_CHAIN (current);                                   \
 284     for (; current !=  end_params_node;                                 \
 285          current = TREE_CHAIN (current), list = TREE_CHAIN (list))      \
 286       ARG_FINAL_P (current) = ARG_FINAL_P (list);                       \
 287     if (current != list)                                                \
 288       fatal ("MARK_FINAL_PARMS");                                       \
 289   }
 290
 291 /* Reset the ARG_FINAL_P that might have been set in method M args.  */
 292 #define UNMARK_FINAL_PARMS(M)                                           \
 293   {                                                                     \
 294     tree current;                                                       \
 295     for (current = TYPE_ARG_TYPES (TREE_TYPE ((M)));                    \
 296          current != end_params_node; current = TREE_CHAIN (current))    \
 297       ARG_FINAL_P (current) = 0;                                        \
 298   }
 299
 300 /* Reverse a crafted parameter list as required.  */
 301 #define CRAFTED_PARAM_LIST_FIXUP(P)             \
 302   {                                             \
 303     if ((P))                                    \
 304       {                                         \
 305         tree last = (P);                        \
 306         (P) = nreverse (P);                     \
 307         TREE_CHAIN (last) = end_params_node;    \
 308       }                                         \
 309     else                                        \
 310       (P) = end_params_node;                    \
 311   }
 312
 313 /* Modes governing the creation of a alias initializer parameter
 314    lists. AIPL stands for Alias Initializer Parameter List.  */
 315 enum {
 316   AIPL_FUNCTION_CREATION,         /* Suitable for artificial method creation */
 317   AIPL_FUNCTION_DECLARATION,      /* Suitable for declared methods */
 318   AIPL_FUNCTION_CTOR_INVOCATION,  /* Invocation of constructors */
 319   AIPL_FUNCTION_FINIT_INVOCATION  /* Invocation of $finit$ */
 320 };
 321
 322 /* Standard error messages */
 323 #define ERROR_CANT_CONVERT_TO_BOOLEAN(OPERATOR, NODE, TYPE)             \
 324   parse_error_context ((OPERATOR),                                      \
 325     "Incompatible type for `%s'. Can't convert `%s' to boolean",        \
 326     operator_string ((NODE)), lang_printable_name ((TYPE),0))
 327
 328 #define ERROR_CANT_CONVERT_TO_NUMERIC(OPERATOR, NODE, TYPE)             \
 329   parse_error_context ((OPERATOR),                                      \
 330       "Incompatible type for `%s'. Can't convert `%s' to numeric type", \
 331       operator_string ((NODE)), lang_printable_name ((TYPE), 0))
 332
 333 #define ERROR_CAST_NEEDED_TO_INTEGRAL(OPERATOR, NODE, TYPE)             \
 334 do {                                                                    \
 335   tree _operator = (OPERATOR), _node = (NODE), _type = (TYPE);          \
 336   if (JPRIMITIVE_TYPE_P (_type))                                        \
 337     parse_error_context (_operator,                                     \
 338 "Incompatible type for `%s'. Explicit cast needed to convert `%s' to integral",\
 339                          operator_string(_node),                        \
 340                          lang_printable_name (_type, 0));               \
 341   else                                                                  \
 342     parse_error_context (_operator,                                     \
 343       "Incompatible type for `%s'. Can't convert `%s' to integral",     \
 344                          operator_string(_node),                        \
 345                          lang_printable_name (_type, 0));               \
 346 } while (0)
 347
 348 #define ERROR_VARIABLE_NOT_INITIALIZED(WFL, V)                  \
 349   parse_error_context                                           \
 350     ((WFL), "Variable `%s' may not have been initialized",      \
 351      IDENTIFIER_POINTER (V))
 352
 353 /* Definition for loop handling. This is Java's own definition of a
 354    loop body. See parse.y for documentation. It's valid once you hold
 355    a loop's body (LOOP_EXPR_BODY) */
 356
 357 /* The loop main block is the one hold the condition and the loop body */
 358 #define LOOP_EXPR_BODY_MAIN_BLOCK(NODE) TREE_OPERAND (NODE, 0)
 359 /* And then there is the loop update block */
 360 #define LOOP_EXPR_BODY_UPDATE_BLOCK(NODE) TREE_OPERAND (NODE, 1)
 361
 362 /* Inside the loop main block, there is the loop condition and the
 363    loop body. They may be reversed if the loop being described is a
 364    do-while loop. NOTE: if you use a WFL around the EXIT_EXPR so you
 365    can issue debug info for it, the EXIT_EXPR will be one operand
 366    further. */
 367 #define LOOP_EXPR_BODY_CONDITION_EXPR(NODE, R)                  \
 368   TREE_OPERAND (LOOP_EXPR_BODY_MAIN_BLOCK (NODE), (R ? 1 : 0))
 369
 370 /* Here is the labeled block the loop real body is encapsulated in */
 371 #define LOOP_EXPR_BODY_LABELED_BODY(NODE, R)                    \
 372   TREE_OPERAND (LOOP_EXPR_BODY_MAIN_BLOCK (NODE), (R ? 0 : 1))
 373 /* And here is the loop's real body */
 374 #define LOOP_EXPR_BODY_BODY_EXPR(NODE, R)                       \
 375   LABELED_BLOCK_BODY (LOOP_EXPR_BODY_LABELED_BODY(NODE, R))
 376
 377 #define PUSH_LABELED_BLOCK(B)                           \
 378   {                                                     \
 379     TREE_CHAIN (B) = ctxp->current_labeled_block;       \
 380     ctxp->current_labeled_block = (B);                  \
 381   }
 382 #define POP_LABELED_BLOCK()                                             \
 383   ctxp->current_labeled_block = TREE_CHAIN (ctxp->current_labeled_block)
 384
 385 #define PUSH_LOOP(L)                            \
 386   {                                             \
 387     TREE_CHAIN (L) = ctxp->current_loop;        \
 388     ctxp->current_loop = (L);                   \
 389   }
 390 #define POP_LOOP() ctxp->current_loop = TREE_CHAIN (ctxp->current_loop)
 391
 392 #define PUSH_EXCEPTIONS(E)                                      \
 393   currently_caught_type_list =                                  \
 394     tree_cons (NULL_TREE, (E), currently_caught_type_list);
 395
 396 #define POP_EXCEPTIONS()                                                \
 397   currently_caught_type_list = TREE_CHAIN (currently_caught_type_list)
 398
 399 /* Check that we're inside a try block.  */
 400 #define IN_TRY_BLOCK_P()                                \
 401   (currently_caught_type_list                           \
 402    && ((TREE_VALUE (currently_caught_type_list) !=      \
 403         DECL_FUNCTION_THROWS (current_function_decl))   \
 404        || TREE_CHAIN (currently_caught_type_list)))
 405
 406 /* Check that we have exceptions in E.  */
 407 #define EXCEPTIONS_P(E) ((E) ? TREE_VALUE (E) : NULL_TREE)
 408
 409 /* Anonymous array access */
 410 #define ANONYMOUS_ARRAY_BASE_TYPE(N)   TREE_OPERAND ((N), 0)
 411 #define ANONYMOUS_ARRAY_DIMS_SIG(N)    TREE_OPERAND ((N), 1)
 412 #define ANONYMOUS_ARRAY_INITIALIZER(N) TREE_OPERAND ((N), 2)
 413
 414 /* Invocation modes, as returned by invocation_mode (). */
 415 enum {
 416   INVOKE_STATIC,
 417   INVOKE_NONVIRTUAL,
 418   INVOKE_SUPER,
 419   INVOKE_INTERFACE,
 420   INVOKE_VIRTUAL
 421 };
 422
 423 /* We need the resolution stuff only if we compile jc1 */
 424 #ifndef JC1_LITE
 425
 426 /* Unresolved type identifiers handling. When we process the source
 427    code, we blindly accept an unknown type identifier and try to
 428    resolve it later. When an unknown type identifier is encountered
 429    and used, we record in a struct jdep element what the incomplete
 430    type is and what it should patch. Later, java_complete_class will
 431    process all classes known to have unresolved type
 432    dependencies. Within each of these classes, this routine will
 433    process unresolved type dependencies (JDEP_TO_RESOLVE), patch what
 434    needs to be patched in the dependent tree node (JDEP_GET_PATCH,
 435    JDEP_APPLY_PATCH) and perform other actions dictated by the context
 436    of the patch (JDEP_KIND). The ideas are: we patch only what needs
 437    to be patched, and with java_complete_class called at the right
 438    time, we will start processing incomplete function bodies tree
 439    nodes with everything external to function's bodies already
 440    completed, it makes things much simpler. */
 441
 442 enum jdep_code {
 443   JDEP_NO_PATCH,                /* Must be first */
 444   JDEP_SUPER,                   /* Patch the type of one type
 445                                    supertype. Requires some check
 446                                    before it's done */
 447   JDEP_FIELD,                   /* Patch the type of a class field */
 448
 449   /* JDEP_{METHOD,METHOD_RETURN,METHOD_END} to be kept in order */
 450   JDEP_METHOD,                  /* Mark the beginning of the patching
 451                                    of a method declaration, including
 452                                    it's arguments */
 453   JDEP_METHOD_RETURN,           /* Mark the beginning of the patching
 454                                    of a method declaration. Arguments
 455                                    aren't patched, only the returned
 456                                    type is */
 457   JDEP_METHOD_END,              /* Mark the end of the patching of a
 458                                    method declaration. It indicates
 459                                    that it's time to compute and
 460                                    install a new signature */
 461
 462   JDEP_INTERFACE,               /* Patch the type of a Class/interface
 463                                    extension */
 464   JDEP_VARIABLE,                /* Patch the type of a variable declaration */
 465   JDEP_PARM,                    /* Patch the type of a parm declaration */
 466   JDEP_TYPE,                    /* Patch a random tree node type,
 467                                    without the need for any specific
 468                                    actions */
 469   JDEP_EXCEPTION,               /* Patch exceptions specified by `throws' */
 470   JDEP_ANONYMOUS                /* Patch anonymous classes
 471                                    (implementation or extension.) */
 472
 473 };
 474
 475 typedef struct _jdep {
 476 #ifdef ONLY_INT_FIELDS
 477   int  kind : 8;                /* Type of patch */
 478 #else
 479   enum jdep_code kind : 8;
 480 #endif
 481
 482   int  flag0 : 1;               /* Some flags */
 483   tree decl;                    /* Tied decl/or WFL */
 484   tree solv;                    /* What to solve */
 485   tree wfl;                     /* Where thing to resolve where found */
 486   tree misc;                    /* Miscellaneous info (optional). */
 487   tree enclosing;               /* The enclosing (current) class */
 488   tree *patch;                  /* Address of a location to patch */
 489   struct _jdep *next;           /* Linked list */
 490 } jdep;
 491
 492
 493 #define JDEP_DECL(J)          ((J)->decl)
 494 #define JDEP_DECL_WFL(J)      ((J)->decl)
 495 #define JDEP_KIND(J)          ((J)->kind)
 496 #define JDEP_SOLV(J)          ((J)->solv)
 497 #define JDEP_WFL(J)           ((J)->wfl)
 498 #define JDEP_MISC(J)          ((J)->misc)
 499 #define JDEP_ENCLOSING(J)     ((J)->enclosing)
 500 #define JDEP_CLASS(J)         ((J)->class)
 501 #define JDEP_APPLY_PATCH(J,P) (*(J)->patch = (P))
 502 #define JDEP_GET_PATCH(J)     ((J)->patch)
 503 #define JDEP_CHAIN(J)         ((J)->next)
 504 #define JDEP_TO_RESOLVE(J)    ((J)->solv)
 505 #define JDEP_RESOLVED_DECL(J) ((J)->solv)
 506 #define JDEP_RESOLVED(J, D)   ((J)->solv = D)
 507 #define JDEP_RESOLVED_P(J)    \
 508         (!(J)->solv || TREE_CODE ((J)->solv) != POINTER_TYPE)
 509
 510 typedef struct _jdeplist {
 511   jdep *first;
 512   jdep *last;
 513   struct _jdeplist *next;
 514 } jdeplist;
 515
 516 #endif /* JC1_LITE */
 517
 518 #define CLASSD_FIRST(CD) ((CD)->first)
 519 #define CLASSD_LAST(CD)  ((CD)->last)
 520 #define CLASSD_CHAIN(CD) ((CD)->next)
 521
 522 #define JDEP_INSERT(L,J)                        \
 523   {                                             \
 524     if (!(L)->first)                            \
 525       (L)->last = (L)->first = (J);             \
 526     else                                        \
 527       {                                         \
 528         JDEP_CHAIN ((L)->last) = (J);           \
 529         (L)->last = (J);                        \
 530       }                                         \
 531   }
 532
 533 /* if TYPE can't be resolved, obtain something suitable for its
 534    resolution (TYPE is saved in SAVE before being changed). and set
 535    CHAIN to 1. Otherwise, type is set to something usable. CHAIN is
 536    usually used to determine that a new DEP must be installed on TYPE.
 537    Note that when compiling java.lang.Object, references to Object are
 538    java.lang.Object.  */
 539 #define SET_TYPE_FOR_RESOLUTION(TYPE, SAVE, CHAIN)                      \
 540   {                                                                     \
 541     tree returned_type;                                                 \
 542     (CHAIN) = 0;                                                        \
 543     if (TREE_TYPE (ctxp->current_parsed_class) == object_type_node      \
 544         && TREE_CODE (TYPE) == EXPR_WITH_FILE_LOCATION                  \
 545         && EXPR_WFL_NODE (TYPE) == unqualified_object_id_node)          \
 546       (TYPE) = object_type_node;                                        \
 547     else                                                                \
 548       {                                                                 \
 549         if (unresolved_type_p (type, &returned_type))                   \
 550           {                                                             \
 551             if (returned_type)                                          \
 552               (TYPE) = returned_type;                                   \
 553             else                                                        \
 554               {                                                         \
 555                 (SAVE) = (TYPE);                                        \
 556                 (TYPE) = obtain_incomplete_type (TYPE);                 \
 557                 CHAIN = 1;                                              \
 558               }                                                         \
 559           }                                                             \
 560       }                                                                 \
 561   }
 562 /* Promote a type if it won't be registered as a patch */
 563 #define PROMOTE_RECORD_IF_COMPLETE(TYPE, IS_INCOMPLETE)         \
 564   {                                                             \
 565     if (!(IS_INCOMPLETE) && TREE_CODE (TYPE) == RECORD_TYPE)    \
 566       (TYPE) = promote_type (TYPE);                             \
 567   }
 568
 569 /* Insert a DECL in the current block */
 570 #define BLOCK_CHAIN_DECL(NODE)                                              \
 571   {                                                                         \
 572     TREE_CHAIN ((NODE)) =                                                   \
 573       BLOCK_EXPR_DECLS (GET_CURRENT_BLOCK (current_function_decl));         \
 574     BLOCK_EXPR_DECLS (GET_CURRENT_BLOCK (current_function_decl)) = (NODE);  \
 575   }
 576
 577 /* Return the current block, either found in the body of the currently
 578    declared function or in the current static block being defined. */
 579 #define GET_CURRENT_BLOCK(F) ((F) ? DECL_FUNCTION_BODY ((F)) :  \
 580                              current_static_block)
 581
 582 /* For an artificial BLOCK (created to house a local variable declaration not
 583    at the start of an existing block), the parent block;  otherwise NULL. */
 584 #define BLOCK_EXPR_ORIGIN(NODE) BLOCK_ABSTRACT_ORIGIN(NODE)
 585
 586 /* Merge an other line to the source line number of a decl. Used to
 587    remember function's end. */
 588 #define DECL_SOURCE_LINE_MERGE(DECL,NO) DECL_SOURCE_LINE(DECL) |= (NO << 16)
 589
 590 /* Retrieve those two info separately. */
 591 #define DECL_SOURCE_LINE_FIRST(DECL)    (DECL_SOURCE_LINE(DECL) & 0x0000ffff)
 592 #define DECL_SOURCE_LINE_LAST(DECL)     (DECL_SOURCE_LINE(DECL) >> 16)
 593
 594 /* Retrieve line/column from a WFL. */
 595 #define EXPR_WFL_GET_LINECOL(V,LINE,COL)        \
 596   {                                             \
 597      (LINE) = (V) >> 12;                        \
 598      (COL) = (V) & 0xfff;                       \
 599    }
 600 /* Add X to the column number information */
 601 #define EXPR_WFL_ADD_COL(V, X)                                  \
 602   (V) = (((V) & 0xfffff000) | ((((V) & 0xfff) + (X)) & 0xfff))
 603
 604 /* Build a WFL for expression nodes */
 605 #define BUILD_EXPR_WFL(NODE, WFL)                                       \
 606   build_expr_wfl ((NODE), input_filename, EXPR_WFL_LINENO ((WFL)),      \
 607                   EXPR_WFL_COLNO ((WFL)))
 608
 609 #define EXPR_WFL_QUALIFICATION(WFL) TREE_OPERAND ((WFL), 2)
 610 #define QUAL_WFL(NODE) TREE_PURPOSE (NODE)
 611 #define QUAL_RESOLUTION(NODE) TREE_VALUE (NODE)
 612 #define QUAL_DECL_TYPE(NODE) GET_SKIP_TYPE (NODE)
 613
 614 #define GET_SKIP_TYPE(NODE)                             \
 615   (TREE_CODE (TREE_TYPE (NODE)) == POINTER_TYPE ?       \
 616    TREE_TYPE (TREE_TYPE (NODE)): TREE_TYPE (NODE))
 617
 618 /* Handy macros for the walk operation */
 619 #define COMPLETE_CHECK_OP(NODE, N)                      \
 620 {                                                       \
 621   TREE_OPERAND ((NODE), (N)) =                          \
 622     java_complete_tree (TREE_OPERAND ((NODE), (N)));    \
 623   if (TREE_OPERAND ((NODE), (N)) == error_mark_node)    \
 624     return error_mark_node;                             \
 625 }
 626 #define COMPLETE_CHECK_OP_0(NODE) COMPLETE_CHECK_OP(NODE, 0)
 627 #define COMPLETE_CHECK_OP_1(NODE) COMPLETE_CHECK_OP(NODE, 1)
 628 #define COMPLETE_CHECK_OP_2(NODE) COMPLETE_CHECK_OP(NODE, 2)
 629
 630 /* Building invocations: append(ARG) and StringBuffer(ARG) */
 631 #define BUILD_APPEND(ARG)                                                     \
 632   ((JSTRING_TYPE_P (TREE_TYPE (ARG)) || JPRIMITIVE_TYPE_P (TREE_TYPE (ARG)))  \
 633    ? build_method_invocation (wfl_append,                                     \
 634                               ARG ? build_tree_list (NULL, (ARG)) : NULL_TREE)\
 635    : build_method_invocation (wfl_append,                                     \
 636                               ARG ? build_tree_list (NULL,                    \
 637                                                      build1 (CONVERT_EXPR,    \
 638                                                              object_type_node,\
 639                                                              (ARG)))          \
 640                               : NULL_TREE))
 641 #define BUILD_STRING_BUFFER(ARG)                                              \
 642   build_new_invocation (wfl_string_buffer,                                    \
 643                         (ARG ? build_tree_list (NULL, (ARG)) : NULL_TREE))
 644
 645 /* For exception handling, build diverse function calls */
 646 #define BUILD_ASSIGN_EXCEPTION_INFO(WHERE, TO)          \
 647   {                                                     \
 648     (WHERE) = build (MODIFY_EXPR, void_type_node, (TO), \
 649                      soft_exceptioninfo_call_node);     \
 650     TREE_SIDE_EFFECTS (WHERE) = 1;                      \
 651   }
 652
 653 #define BUILD_THROW(WHERE, WHAT)                                            \
 654   {                                                                         \
 655     (WHERE) =                                                               \
 656       build (CALL_EXPR, void_type_node,                                     \
 657              build_address_of (throw_node[exceptions_via_longjmp ? 1 : 0]), \
 658              build_tree_list (NULL_TREE, (WHAT)), NULL_TREE);               \
 659     TREE_SIDE_EFFECTS ((WHERE)) = 1;                                        \
 660   }
 661
 662 /* Set wfl_operator for the most accurate error location */
 663 #define SET_WFL_OPERATOR(WHICH, NODE, WFL)              \
 664   EXPR_WFL_LINECOL (WHICH) =                            \
 665     (TREE_CODE (WFL) == EXPR_WITH_FILE_LOCATION ?       \
 666      EXPR_WFL_LINECOL (WFL) : EXPR_WFL_LINECOL (NODE))
 667
 668 #define PATCH_METHOD_RETURN_ERROR()             \
 669   {                                             \
 670     if (ret_decl)                               \
 671       *ret_decl = NULL_TREE;                    \
 672     return error_mark_node;                     \
 673   }
 674
 675 /* Convenient macro to check. Assumes that CLASS is a CLASS_DECL.  */
 676 #define CHECK_METHODS(CLASS)                    \
 677   {                                             \
 678     if (CLASS_INTERFACE ((CLASS)))              \
 679       java_check_abstract_methods ((CLASS));    \
 680     else                                        \
 681       java_check_regular_methods ((CLASS));     \
 682   }
 683
 684 /* Using and reseting the @deprecated tag flag */
 685 #define CHECK_DEPRECATED(DECL)                  \
 686   {                                             \
 687     if (ctxp->deprecated)                       \
 688       DECL_DEPRECATED (DECL) = 1;               \
 689     ctxp->deprecated = 0;                       \
 690   }
 691
 692 /* Register an import */
 693 #define REGISTER_IMPORT(WHOLE, NAME)                    \
 694 {                                                       \
 695   IS_A_SINGLE_IMPORT_CLASSFILE_NAME_P ((NAME)) = 1;     \
 696   node = build_tree_list ((WHOLE), (NAME));             \
 697   TREE_CHAIN (node) = ctxp->import_list;                \
 698   ctxp->import_list = node;                             \
 699 }
 700
 701 /* Macro to access the osb (opening square bracket) count */
 702 #define CURRENT_OSB(C) (C)->osb_number [(C)->osb_depth]
 703
 704 /* Macro for the xreferencer */
 705 #define DECL_END_SOURCE_LINE(DECL)       DECL_FRAME_SIZE (DECL)
 706 #define DECL_INHERITED_SOURCE_LINE(DECL) (DECL_CHECK (DECL)->decl.u2.i)
 707
 708 /* Parser context data structure. */
 709 struct parser_ctxt {
 710
 711   char *filename;                   /* Current filename */
 712   FILE *finput;                     /* Current file input stream */
 713   struct parser_ctxt *next;
 714
 715   char marker_begining;              /* Marker. Should be a sub-struct */
 716   struct java_line *p_line, *c_line; /* Previous and current line */
 717   java_lc elc;                       /* Error's line column info */
 718   unicode_t unget_utf8_value;        /* An unget utf8 value */
 719   int ccb_indent;                    /* Keep track of {} indent, lexer */
 720   int first_ccb_indent1;             /* First { at ident level 1 */
 721   int last_ccb_indent1;              /* Last } at ident level 1 */
 722   int parser_ccb_indent;             /* Keep track of {} indent, parser */
 723   int osb_depth;                     /* Current depth of [ in an expression */
 724   int osb_limit;                     /* Limit of this depth */
 725   int *osb_number;                   /* Keep track of ['s */
 726   int lineno;                        /* Current lineno */
 727   char marker_end;                   /* End marker. Should be a sub-struct */
 728
 729   /* The flags section */
 730
 731   /* Indicates a context used for saving the parser status. The
 732      context must be popped when the status is restored. */
 733   unsigned saved_data_ctx:1;
 734   /* Indicates that a context already contains saved data and that the
 735      next save operation will require a new context to be created. */
 736   unsigned saved_data:1;
 737   /* Integral literal overflow */
 738   unsigned minus_seen:1;
 739   /* Report error when true */
 740   unsigned java_error_flag:1;
 741   /* @deprecated tag seen */
 742   unsigned deprecated:1;
 743   /* Flag to report certain errors (fix this documentation. FIXME) */
 744   unsigned class_err:1;
 745
 746   /* This section is defined only if we compile jc1 */
 747 #ifndef JC1_LITE
 748   tree modifier_ctx [11];           /* WFL of modifiers */
 749   tree current_class;               /* Current class */
 750   tree current_function_decl;       /* Current function decl, save/restore */
 751
 752   struct JCF *current_jcf;          /* CU jcf */
 753
 754   int prevent_ese;                  /* Prevent expression statement error */
 755
 756   int formal_parameter_number;      /* Number of parameters found */
 757   int interface_number;             /* # itfs declared to extend an itf def */
 758
 759   tree package;                     /* Defined package ID */
 760
 761   /* Those two list are saved accross file traversal */
 762   tree  incomplete_class;           /* List of non-complete classes */
 763   tree  gclass_list;                /* All classes seen from source code */
 764
 765   /* These two lists won't survive file traversal */
 766   tree  class_list;                 /* List of classes in a CU */
 767   jdeplist *classd_list;            /* Classe dependencies in a CU */
 768
 769   tree  current_parsed_class;       /* Class currently parsed */
 770   tree  current_parsed_class_un;    /* Curr. parsed class unqualified name */
 771
 772   tree non_static_initialized;      /* List of non static initialized fields */
 773   tree static_initialized;          /* List of static non final initialized */
 774   tree instance_initializers;       /* List of instancei initializers stmts */
 775
 776   tree import_list;                 /* List of import */
 777   tree import_demand_list;          /* List of import on demand */
 778
 779   tree current_loop;                /* List of the currently nested
 780                                        loops/switches */
 781   tree current_labeled_block;       /* List of currently nested
 782                                        labeled blocks. */
 783
 784   int pending_block;                /* Pending block to close */
 785
 786   int explicit_constructor_p;       /* >0 when processing an explicit
 787                                        constructor. This flag is used to trap
 788                                        illegal argument usage during an
 789                                        explicit constructor invocation. */
 790 #endif /* JC1_LITE */
 791 };
 792
 793 /* A set of macros to push/pop/access the currently parsed class.  */
 794 #define GET_CPC_LIST()     ctxp->current_parsed_class
 795
 796 /* Currently class being parsed is an inner class if an enclosing
 797    class has been already pushed. This truth value is only valid prior
 798    an inner class is pushed. After, use FIXME. */
 799 #define CPC_INNER_P() GET_CPC_LIST ()
 800
 801 /* Get the currently parsed class DECL_TYPE node.  */
 802 #define GET_CPC() TREE_VALUE (GET_CPC_LIST ())
 803
 804 /* Get the currently parsed class unqualified IDENTIFIER_NODE.  */
 805 #define GET_CPC_UN() TREE_PURPOSE (GET_CPC_LIST ())
 806
 807 /* Get a parsed class unqualified IDENTIFIER_NODE from its CPC node.  */
 808 #define GET_CPC_UN_NODE(N) TREE_PURPOSE (N)
 809
 810 /* Get the currently parsed class DECL_TYPE from its CPC node.  */
 811 #define GET_CPC_DECL_NODE(N) TREE_VALUE (N)
 812
 813 /* The currently parsed enclosing currently parsed TREE_LIST node.  */
 814 #define GET_ENCLOSING_CPC() TREE_CHAIN (GET_CPC_LIST ())
 815
 816 /* Get the next enclosing context.  */
 817 #define GET_NEXT_ENCLOSING_CPC(C) TREE_CHAIN (C)
 818
 819 /* The DECL_TYPE node of the enclosing currently parsed
 820    class. NULL_TREE if the currently parsed class isn't an inner
 821    class.  */
 822 #define GET_ENCLOSING_CPC_CONTEXT() (GET_ENCLOSING_CPC () ?                   \
 823                                      TREE_VALUE (GET_ENCLOSING_CPC ()) :      \
 824                                      NULL_TREE)
 825
 826 /* Make sure that innerclass T sits in an appropriate enclosing
 827    context.  */
 828 #define INNER_ENCLOSING_SCOPE_CHECK(T)                                  \
 829   (INNER_CLASS_TYPE_P ((T)) && !ANONYMOUS_CLASS_P ((T))                 \
 830    /* We have a this and it's not the right one */                      \
 831    && ((current_this                                                    \
 832         && (DECL_CONTEXT (TYPE_NAME ((T)))                              \
 833             != TYPE_NAME (TREE_TYPE (TREE_TYPE (current_this)))))       \
 834        /* We don't have a this. */                                      \
 835        || !current_this))
 836
 837 /* Push macro. First argument to PUSH_CPC is a DECL_TYPE, second
 838    argument is the unqualified currently parsed class name.  */
 839 #define PUSH_CPC(C,R) {                                         \
 840                         ctxp->current_parsed_class =            \
 841                         tree_cons ((R), (C), GET_CPC_LIST ());  \
 842                       }
 843
 844 /* In case of an error, push an error.  */
 845 #define PUSH_ERROR() PUSH_CPC (error_mark_node, error_mark_node)
 846
 847 /* Pop macro. Before we pop, we link the current inner class decl (if any)
 848    to its enclosing class.  */
 849 #define POP_CPC() {                                     \
 850                     link_nested_class_to_enclosing ();  \
 851                     ctxp->current_parsed_class =        \
 852                       TREE_CHAIN (GET_CPC_LIST ());     \
 853                   }
 854
 855 #define DEBUG_CPC()                                             \
 856   do                                                            \
 857     {                                                           \
 858       tree tmp =  ctxp->current_parsed_class;                   \
 859       while (tmp)                                               \
 860         {                                                       \
 861           fprintf (stderr, "%s ",                               \
 862                    IDENTIFIER_POINTER (TREE_PURPOSE (tmp)));    \
 863           tmp = TREE_CHAIN (tmp);                               \
 864         }                                                       \
 865     }                                                           \
 866   while (0);
 867
 868 /* Access to the various initializer statement lists */
 869 #define CPC_INITIALIZER_LIST(C)          ((C)->non_static_initialized)
 870 #define CPC_STATIC_INITIALIZER_LIST(C)   ((C)->static_initialized)
 871 #define CPC_INSTANCE_INITIALIZER_LIST(C) ((C)->instance_initializers)
 872
 873 /* Access to the various initializer statements */
 874 #define CPC_INITIALIZER_STMT(C) (TREE_PURPOSE (CPC_INITIALIZER_LIST (C)))
 875 #define CPC_STATIC_INITIALIZER_STMT(C) \
 876   (TREE_PURPOSE (CPC_STATIC_INITIALIZER_LIST (C)))
 877 #define CPC_INSTANCE_INITIALIZER_STMT(C) \
 878   (TREE_PURPOSE (CPC_INSTANCE_INITIALIZER_LIST (C)))
 879
 880 /* Set various initializer statements */
 881 #define SET_CPC_INITIALIZER_STMT(C,S)                   \
 882   if (CPC_INITIALIZER_LIST (C))                         \
 883     TREE_PURPOSE (CPC_INITIALIZER_LIST (C)) = (S);
 884 #define SET_CPC_STATIC_INITIALIZER_STMT(C,S)                    \
 885   if (CPC_STATIC_INITIALIZER_LIST (C))                          \
 886     TREE_PURPOSE (CPC_STATIC_INITIALIZER_LIST (C)) = (S);
 887 #define SET_CPC_INSTANCE_INITIALIZER_STMT(C,S)                  \
 888   if (CPC_INSTANCE_INITIALIZER_LIST(C))                         \
 889     TREE_PURPOSE (CPC_INSTANCE_INITIALIZER_LIST (C)) = (S);
 890
 891 #ifndef JC1_LITE
 892 void java_complete_class PARAMS ((void));
 893 void java_check_circular_reference PARAMS ((void));
 894 void java_fix_constructors PARAMS ((void));
 895 void java_layout_classes PARAMS ((void));
 896 void java_reorder_fields PARAMS ((void));
 897 tree java_method_add_stmt PARAMS ((tree, tree));
 898 void java_expand_switch PARAMS ((tree));
 899 int java_report_errors PARAMS ((void));
 900 extern tree do_resolve_class PARAMS ((tree, tree, tree, tree));
 901 #endif
 902 char *java_get_line_col PARAMS ((char *, int, int));
 903 extern void reset_report PARAMS ((void));
 904
 905 /* Always in use, no matter what you compile */
 906 void java_push_parser_context PARAMS ((void));
 907 void java_pop_parser_context PARAMS ((int));
 908 void java_init_lex PARAMS ((void));
 909 extern void java_parser_context_save_global PARAMS ((void));
 910 extern void java_parser_context_restore_global PARAMS ((void));
 911 int yyparse PARAMS ((void));
 912 extern int java_parse PARAMS ((void));
 913 void yyerror PARAMS ((const char *));
 914 extern void java_expand_classes PARAMS ((void));
 915 #endif