gcc/fortran/trans.h

   1 /* Header for code translation functions
   2    Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007 Free Software
   3    Foundation, Inc.
   4    Contributed by Paul Brook
   5
   6 This file is part of GCC.
   7
   8 GCC is free software; you can redistribute it and/or modify it under
   9 the terms of the GNU General Public License as published by the Free
  10 Software Foundation; either version 2, or (at your option) any later
  11 version.
  12
  13 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  15 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  16 for more details.
  17
  18 You should have received a copy of the GNU General Public License
  19 along with GCC; see the file COPYING.  If not, write to the Free
  20 Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA
  21 02110-1301, USA.  */
  22
  23 #ifndef GFC_TRANS_H
  24 #define GFC_TRANS_H
  25
  26 /* Mangled symbols take the form __module__name.  */
  27 #define GFC_MAX_MANGLED_SYMBOL_LEN  (GFC_MAX_SYMBOL_LEN*2+4)
  28
  29 /* Struct for holding a block of statements.  It should be treated as an
  30    opaque entity and not modified directly.  This allows us to change the
  31    underlying representation of statement lists.  */
  32 typedef struct
  33 {
  34   tree head;
  35   unsigned int has_scope:1;
  36 }
  37 stmtblock_t;
  38
  39 /* a simplified expression */
  40 typedef struct gfc_se
  41 {
  42   /* Code blocks to be executed before and after using the value.  */
  43   stmtblock_t pre;
  44   stmtblock_t post;
  45
  46   /* the result of the expression */
  47   tree expr;
  48
  49   /* The length of a character string value.  */
  50   tree string_length;
  51
  52   /* If set gfc_conv_variable will return an expression for the array
  53      descriptor. When set, want_pointer should also be set.
  54      If not set scalarizing variables will be substituted.  */
  55   unsigned descriptor_only:1;
  56
  57   /* When this is set gfc_conv_expr returns the address of a variable.  Only
  58      applies to EXPR_VARIABLE nodes.
  59      Also used by gfc_conv_array_parameter. When set this indicates a pointer
  60      to the descriptor should be returned, rather than the descriptor itself.
  61    */
  62   unsigned want_pointer:1;
  63
  64   /* An array function call returning without a temporary.  Also used for array
  65      pointer assignments.  */
  66   unsigned direct_byref:1;
  67
  68   /* Ignore absent optional arguments.  Used for some intrinsics.  */
  69   unsigned ignore_optional:1;
  70
  71   /* When this is set the data and offset fields of the returned descriptor
  72      are NULL.  Used by intrinsic size.  */
  73   unsigned data_not_needed:1;
  74
  75   /* If set, gfc_conv_function_call does not put byref calls into se->pre.  */
  76   unsigned no_function_call:1;
  77
  78   /* Scalarization parameters.  */
  79   struct gfc_se *parent;
  80   struct gfc_ss *ss;
  81   struct gfc_loopinfo *loop;
  82 }
  83 gfc_se;
  84
  85
  86 /* Scalarization State chain.  Created by walking an expression tree before
  87    creating the scalarization loops. Then passed as part of a gfc_se structure
  88    to translate the expression inside the loop.  Note that these chains are
  89    terminated by gfc_se_terminator, not NULL.  A NULL pointer in a gfc_se
  90    indicates to gfc_conv_* that this is a scalar expression.
  91    Note that some member arrays correspond to scalarizer rank and others
  92    are the variable rank.  */
  93
  94 typedef struct gfc_ss_info
  95 {
  96   int dimen;
  97   /* The ref that holds information on this section.  */
  98   gfc_ref *ref;
  99   /* The descriptor of this array.  */
 100   tree descriptor;
 101   /* holds the pointer to the data array.  */
 102   tree data;
 103   /* To move some of the array index calculation out of the innermost loop.  */
 104   tree offset;
 105   tree saved_offset;
 106   tree stride0;
 107   /* Holds the SS for a subscript.  Indexed by actual dimension.  */
 108   struct gfc_ss *subscript[GFC_MAX_DIMENSIONS];
 109
 110   /* stride and delta are used to access this inside a scalarization loop.
 111      start is used in the calculation of these.  Indexed by scalarizer
 112      dimension.  */
 113   tree start[GFC_MAX_DIMENSIONS];
 114   tree end[GFC_MAX_DIMENSIONS];
 115   tree stride[GFC_MAX_DIMENSIONS];
 116   tree delta[GFC_MAX_DIMENSIONS];
 117
 118   /* Translation from scalarizer dimensions to actual dimensions.
 119      actual = dim[scalarizer]  */
 120   int dim[GFC_MAX_DIMENSIONS];
 121 }
 122 gfc_ss_info;
 123
 124 typedef enum
 125 {
 126   /* A scalar value.  This will be evaluated before entering the
 127      scalarization loop.  */
 128   GFC_SS_SCALAR,
 129
 130   /* Like GFC_SS_SCALAR except it evaluates a pointer to the expression.
 131      Used for elemental function parameters.  */
 132   GFC_SS_REFERENCE,
 133
 134   /* An array section.  Scalarization indices will be substituted during
 135      expression translation.  */
 136   GFC_SS_SECTION,
 137
 138   /* A non-elemental function call returning an array.  The call is executed
 139      before entering the scalarization loop, storing the result in a
 140      temporary.  This temporary is then used inside the scalarization loop.
 141      Simple assignments, eg. a(:) = fn() are handles without a temporary
 142      as a special case.  */
 143   GFC_SS_FUNCTION,
 144
 145   /* An array constructor.  The current implementation is sub-optimal in
 146      many cases.  It allocated a temporary, assigns the values to it, then
 147      uses this temporary inside the scalarization loop.  */
 148   GFC_SS_CONSTRUCTOR,
 149
 150   /* A vector subscript.  The vector's descriptor is cached in the
 151      "descriptor" field of the associated gfc_ss_info.  */
 152   GFC_SS_VECTOR,
 153
 154   /* A temporary array allocated by the scalarizer.  Its rank can be less
 155      than that of the assignment expression.  */
 156   GFC_SS_TEMP,
 157
 158   /* An intrinsic function call.  Many intrinsic functions which map directly
 159      to library calls are created as GFC_SS_FUNCTION nodes.  */
 160   GFC_SS_INTRINSIC,
 161
 162   /* A component of a derived type.  */
 163   GFC_SS_COMPONENT
 164 }
 165 gfc_ss_type;
 166
 167 /* SS structures can only belong to a single loopinfo.  They must be added
 168    otherwise they will not get freed.  */
 169 typedef struct gfc_ss
 170 {
 171   gfc_ss_type type;
 172   gfc_expr *expr;
 173   mpz_t *shape;
 174   tree string_length;
 175   union
 176   {
 177     /* If type is GFC_SS_SCALAR or GFC_SS_REFERENCE.  */
 178     struct
 179     {
 180       tree expr;
 181     }
 182     scalar;
 183
 184     /* GFC_SS_TEMP.  */
 185     struct
 186     {
 187       /* The rank of the temporary.  May be less than the rank of the
 188          assigned expression.  */
 189       int dimen;
 190       tree type;
 191     }
 192     temp;
 193     /* All other types.  */
 194     gfc_ss_info info;
 195   }
 196   data;
 197
 198   /* All the SS in a loop and linked through loop_chain.  The SS for an
 199      expression are linked by the next pointer.  */
 200   struct gfc_ss *loop_chain;
 201   struct gfc_ss *next;
 202
 203   /* This is used by assignments requiring temporaries. The bits specify which
 204      loops the terms appear in.  This will be 1 for the RHS expressions,
 205      2 for the LHS expressions, and 3(=1|2) for the temporary.  */
 206   unsigned useflags:2;
 207 }
 208 gfc_ss;
 209 #define gfc_get_ss() gfc_getmem(sizeof(gfc_ss))
 210
 211 /* The contents of this aren't actually used.  A NULL SS chain indicates a
 212    scalar expression, so this pointer is used to terminate SS chains.  */
 213 extern gfc_ss * const gfc_ss_terminator;
 214
 215 /* Holds information about an expression while it is being scalarized.  */
 216 typedef struct gfc_loopinfo
 217 {
 218   stmtblock_t pre;
 219   stmtblock_t post;
 220
 221   int dimen;
 222
 223   /* All the SS involved with this loop.  */
 224   gfc_ss *ss;
 225   /* The SS describing the temporary used in an assignment.  */
 226   gfc_ss *temp_ss;
 227
 228   /* The scalarization loop index variables.  */
 229   tree loopvar[GFC_MAX_DIMENSIONS];
 230
 231   /* The bounds of the scalarization loops.  */
 232   tree from[GFC_MAX_DIMENSIONS];
 233   tree to[GFC_MAX_DIMENSIONS];
 234   gfc_ss *specloop[GFC_MAX_DIMENSIONS];
 235
 236   /* The code member contains the code for the body of the next outer loop.  */
 237   stmtblock_t code[GFC_MAX_DIMENSIONS];
 238
 239   /* Order in which the dimensions should be looped, innermost first.  */
 240   int order[GFC_MAX_DIMENSIONS];
 241
 242   /* The number of dimensions for which a temporary is used.  */
 243   int temp_dim;
 244
 245   /* If set we don't need the loop variables.  */
 246   unsigned array_parameter:1;
 247 }
 248 gfc_loopinfo;
 249
 250
 251 /* Information about a symbol that has been shadowed by a temporary.  */
 252 typedef struct
 253 {
 254   symbol_attribute attr;
 255   tree decl;
 256 }
 257 gfc_saved_var;
 258
 259
 260 /* Advance the SS chain to the next term.  */
 261 void gfc_advance_se_ss_chain (gfc_se *);
 262
 263 /* Call this to initialize a gfc_se structure before use
 264    first parameter is structure to initialize, second is
 265    parent to get scalarization data from, or NULL.  */
 266 void gfc_init_se (gfc_se *, gfc_se *);
 267
 268 /* Create an artificial variable decl and add it to the current scope.  */
 269 tree gfc_create_var (tree, const char *);
 270 /* Like above but doesn't add it to the current scope.  */
 271 tree gfc_create_var_np (tree, const char *);
 272
 273 /* Store the result of an expression in a temp variable so it can be used
 274    repeatedly even if the original changes */
 275 void gfc_make_safe_expr (gfc_se * se);
 276
 277 /* Makes sure se is suitable for passing as a function string parameter.  */
 278 void gfc_conv_string_parameter (gfc_se * se);
 279
 280 /* Compare two strings.  */
 281 tree gfc_build_compare_string (tree, tree, tree, tree);
 282
 283 /* Add an item to the end of TREE_LIST.  */
 284 tree gfc_chainon_list (tree, tree);
 285
 286 /* When using the gfc_conv_* make sure you understand what they do, i.e.
 287    when a POST chain may be created, and what the returned expression may be
 288    used for.  Note that character strings have special handling.  This
 289    should not be a problem as most statements/operations only deal with
 290    numeric/logical types.  See the implementations in trans-expr.c
 291    for details of the individual functions.  */
 292
 293 void gfc_conv_expr (gfc_se * se, gfc_expr * expr);
 294 void gfc_conv_expr_val (gfc_se * se, gfc_expr * expr);
 295 void gfc_conv_expr_lhs (gfc_se * se, gfc_expr * expr);
 296 void gfc_conv_expr_reference (gfc_se * se, gfc_expr *);
 297 void gfc_conv_expr_type (gfc_se * se, gfc_expr *, tree);
 298
 299 /* Find the decl containing the auxiliary variables for assigned variables.  */
 300 void gfc_conv_label_variable (gfc_se * se, gfc_expr * expr);
 301 /* If the value is not constant, Create a temporary and copy the value.  */
 302 tree gfc_evaluate_now (tree, stmtblock_t *);
 303
 304 /* Intrinsic function handling.  */
 305 void gfc_conv_intrinsic_function (gfc_se *, gfc_expr *);
 306
 307 /* Does an intrinsic map directly to an external library call.  */
 308 int gfc_is_intrinsic_libcall (gfc_expr *);
 309
 310 /* Used to call the elemental subroutines used in operator assignments.  */
 311 tree gfc_conv_operator_assign (gfc_se *, gfc_se *, gfc_symbol *);
 312
 313 /* Also used to CALL subroutines.  */
 314 int gfc_conv_function_call (gfc_se *, gfc_symbol *, gfc_actual_arglist *,
 315                             tree);
 316
 317 void gfc_conv_aliased_arg (gfc_se *, gfc_expr *, int, sym_intent);
 318 bool is_aliased_array (gfc_expr *);
 319
 320 /* gfc_trans_* shouldn't call push/poplevel, use gfc_push/pop_scope */
 321
 322 /* Generate code for a scalar assignment.  */
 323 tree gfc_trans_scalar_assign (gfc_se *, gfc_se *, gfc_typespec, bool, bool);
 324
 325 /* Translate COMMON blocks.  */
 326 void gfc_trans_common (gfc_namespace *);
 327
 328 /* Translate a derived type constructor.  */
 329 void gfc_conv_structure (gfc_se *, gfc_expr *, int);
 330
 331 /* Return an expression which determines if a dummy parameter is present.  */
 332 tree gfc_conv_expr_present (gfc_symbol *);
 333 /* Convert a missing, dummy argument into a null or zero.  */
 334 void gfc_conv_missing_dummy (gfc_se *, gfc_expr *, gfc_typespec);
 335
 336 /* Generate code to allocate a string temporary.  */
 337 tree gfc_conv_string_tmp (gfc_se *, tree, tree);
 338 /* Get the string length variable belonging to an expression.  */
 339 tree gfc_get_expr_charlen (gfc_expr *);
 340 /* Initialize a string length variable.  */
 341 void gfc_trans_init_string_length (gfc_charlen *, stmtblock_t *);
 342 /* Ensure type sizes can be gimplified.  */
 343 void gfc_trans_vla_type_sizes (gfc_symbol *, stmtblock_t *);
 344
 345 /* Add an expression to the end of a block.  */
 346 void gfc_add_expr_to_block (stmtblock_t *, tree);
 347 /* Add a block to the end of a block.  */
 348 void gfc_add_block_to_block (stmtblock_t *, stmtblock_t *);
 349 /* Add a MODIFY_EXPR or a GIMPLE_MODIFY_STMT to a block.  */
 350 void gfc_add_modify (stmtblock_t *, tree, tree, bool);
 351 #define gfc_add_modify_expr(BLOCK, LHS, RHS) \
 352        gfc_add_modify ((BLOCK), (LHS), (RHS), false)
 353 #define gfc_add_modify_stmt(BLOCK, LHS, RHS) \
 354        gfc_add_modify ((BLOCK), (LHS), (RHS), true)
 355
 356 /* Initialize a statement block.  */
 357 void gfc_init_block (stmtblock_t *);
 358 /* Start a new statement block.  Like gfc_init_block but also starts a new
 359    variable scope.  */
 360 void gfc_start_block (stmtblock_t *);
 361 /* Finish a statement block.  Also closes the scope if the block was created
 362    with gfc_start_block.  */
 363 tree gfc_finish_block (stmtblock_t *);
 364 /* Merge the scope of a block with its parent.  */
 365 void gfc_merge_block_scope (stmtblock_t * block);
 366
 367 /* Return the backend label decl.  */
 368 tree gfc_get_label_decl (gfc_st_label *);
 369
 370 /* Return the decl for an external function.  */
 371 tree gfc_get_extern_function_decl (gfc_symbol *);
 372
 373 /* Return the decl for a function.  */
 374 tree gfc_get_function_decl (gfc_symbol *);
 375
 376 /* Build an ADDR_EXPR.  */
 377 tree gfc_build_addr_expr (tree, tree);
 378
 379 /* Build an ARRAY_REF.  */
 380 tree gfc_build_array_ref (tree, tree);
 381
 382 /* Creates a label.  Decl is artificial if label_id == NULL_TREE.  */
 383 tree gfc_build_label_decl (tree);
 384
 385 /* Return the decl used to hold the function return value.
 386    Do not use if the function has an explicit result variable.  */
 387 tree gfc_get_fake_result_decl (gfc_symbol *, int);
 388
 389 /* Get the return label for the current function.  */
 390 tree gfc_get_return_label (void);
 391
 392 /* Add a decl to the binding level for the current function.  */
 393 void gfc_add_decl_to_function (tree);
 394
 395 /* Make prototypes for runtime library functions.  */
 396 void gfc_build_builtin_function_decls (void);
 397
 398 /* Set the backend source location of a decl.  */
 399 void gfc_set_decl_location (tree, locus *);
 400
 401 /* Return the variable decl for a symbol.  */
 402 tree gfc_get_symbol_decl (gfc_symbol *);
 403
 404 /* Build a static initializer.  */
 405 tree gfc_conv_initializer (gfc_expr *, gfc_typespec *, tree, bool, bool);
 406
 407 /* Substitute a temporary variable in place of the real one.  */
 408 void gfc_shadow_sym (gfc_symbol *, tree, gfc_saved_var *);
 409
 410 /* Restore the original variable.  */
 411 void gfc_restore_sym (gfc_symbol *, gfc_saved_var *);
 412
 413 /* Returns true if a variable of specified size should go on the stack.  */
 414 int gfc_can_put_var_on_stack (tree);
 415
 416 /* Allocate the lang-specific part of a decl node.  */
 417 void gfc_allocate_lang_decl (tree);
 418
 419 /* Advance along a TREE_CHAIN.  */
 420 tree gfc_advance_chain (tree, int);
 421
 422 /* Create a decl for a function.  */
 423 void gfc_create_function_decl (gfc_namespace *);
 424 /* Generate the code for a function.  */
 425 void gfc_generate_function_code (gfc_namespace *);
 426 /* Output a BLOCK DATA program unit.  */
 427 void gfc_generate_block_data (gfc_namespace *);
 428 /* Output a decl for a module variable.  */
 429 void gfc_generate_module_vars (gfc_namespace *);
 430
 431 /* Get and set the current location.  */
 432 void gfc_set_backend_locus (locus *);
 433 void gfc_get_backend_locus (locus *);
 434
 435 /* Handle static constructor functions.  */
 436 extern GTY(()) tree gfc_static_ctors;
 437 void gfc_generate_constructors (void);
 438
 439 /* Get the string length of an array constructor.  */
 440 bool get_array_ctor_strlen (stmtblock_t *, gfc_constructor *, tree *);
 441
 442 /* Generate a runtime error check.  */
 443 void gfc_trans_runtime_check (tree, const char *, stmtblock_t *, locus *);
 444
 445 /* Generate a call to free() after checking that its arg is non-NULL.  */
 446 tree gfc_call_free (tree);
 447
 448 /* Allocate memory after performing a few checks.  */
 449 tree gfc_call_malloc (stmtblock_t *, tree, tree);
 450
 451 /* Generate code for an assignment, includes scalarization.  */
 452 tree gfc_trans_assignment (gfc_expr *, gfc_expr *, bool);
 453
 454 /* Generate code for a pointer assignment.  */
 455 tree gfc_trans_pointer_assignment (gfc_expr *, gfc_expr *);
 456
 457 /* Initialize function decls for library functions.  */
 458 void gfc_build_intrinsic_lib_fndecls (void);
 459 /* Create function decls for IO library functions.  */
 460 void gfc_trans_io_runtime_check (tree, tree, int, const char *, stmtblock_t *);
 461 void gfc_build_io_library_fndecls (void);
 462 /* Build a function decl for a library function.  */
 463 tree gfc_build_library_function_decl (tree, tree, int, ...);
 464
 465 /* somewhere! */
 466 tree pushdecl (tree);
 467 tree pushdecl_top_level (tree);
 468 void pushlevel (int);
 469 tree poplevel (int, int, int);
 470 tree getdecls (void);
 471 tree gfc_truthvalue_conversion (tree);
 472 tree gfc_builtin_function (tree);
 473
 474 /* In trans-openmp.c */
 475 bool gfc_omp_privatize_by_reference (tree);
 476 enum omp_clause_default_kind gfc_omp_predetermined_sharing (tree);
 477 tree gfc_omp_clause_default_ctor (tree, tree);
 478 bool gfc_omp_disregard_value_expr (tree, bool);
 479 bool gfc_omp_private_debug_clause (tree, bool);
 480 struct gimplify_omp_ctx;
 481 void gfc_omp_firstprivatize_type_sizes (struct gimplify_omp_ctx *, tree);
 482
 483 /* Runtime library function decls.  */
 484 extern GTY(()) tree gfor_fndecl_internal_realloc;
 485 extern GTY(()) tree gfor_fndecl_allocate;
 486 extern GTY(()) tree gfor_fndecl_allocate_array;
 487 extern GTY(()) tree gfor_fndecl_deallocate;
 488 extern GTY(()) tree gfor_fndecl_pause_numeric;
 489 extern GTY(()) tree gfor_fndecl_pause_string;
 490 extern GTY(()) tree gfor_fndecl_stop_numeric;
 491 extern GTY(()) tree gfor_fndecl_stop_string;
 492 extern GTY(()) tree gfor_fndecl_select_string;
 493 extern GTY(()) tree gfor_fndecl_runtime_error;
 494 extern GTY(()) tree gfor_fndecl_runtime_error_at;
 495 extern GTY(()) tree gfor_fndecl_os_error;
 496 extern GTY(()) tree gfor_fndecl_generate_error;
 497 extern GTY(()) tree gfor_fndecl_set_fpe;
 498 extern GTY(()) tree gfor_fndecl_set_options;
 499 extern GTY(()) tree gfor_fndecl_ttynam;
 500 extern GTY(()) tree gfor_fndecl_ctime;
 501 extern GTY(()) tree gfor_fndecl_fdate;
 502 extern GTY(()) tree gfor_fndecl_in_pack;
 503 extern GTY(()) tree gfor_fndecl_in_unpack;
 504 extern GTY(()) tree gfor_fndecl_associated;
 505
 506 /* Math functions.  Many other math functions are handled in
 507    trans-intrinsic.c.  */
 508
 509 typedef struct gfc_powdecl_list GTY(())
 510 {
 511   tree integer;
 512   tree real;
 513   tree cmplx;
 514 }
 515 gfc_powdecl_list;
 516
 517 extern GTY(()) gfc_powdecl_list gfor_fndecl_math_powi[4][3];
 518 extern GTY(()) tree gfor_fndecl_math_cpowf;
 519 extern GTY(()) tree gfor_fndecl_math_cpow;
 520 extern GTY(()) tree gfor_fndecl_math_cpowl10;
 521 extern GTY(()) tree gfor_fndecl_math_cpowl16;
 522 extern GTY(()) tree gfor_fndecl_math_ishftc4;
 523 extern GTY(()) tree gfor_fndecl_math_ishftc8;
 524 extern GTY(()) tree gfor_fndecl_math_ishftc16;
 525 extern GTY(()) tree gfor_fndecl_math_exponent4;
 526 extern GTY(()) tree gfor_fndecl_math_exponent8;
 527 extern GTY(()) tree gfor_fndecl_math_exponent10;
 528 extern GTY(()) tree gfor_fndecl_math_exponent16;
 529
 530 /* BLAS functions.  */
 531 extern GTY(()) tree gfor_fndecl_sgemm;
 532 extern GTY(()) tree gfor_fndecl_dgemm;
 533 extern GTY(()) tree gfor_fndecl_cgemm;
 534 extern GTY(()) tree gfor_fndecl_zgemm;
 535
 536 /* String functions.  */
 537 extern GTY(()) tree gfor_fndecl_compare_string;
 538 extern GTY(()) tree gfor_fndecl_concat_string;
 539 extern GTY(()) tree gfor_fndecl_string_len_trim;
 540 extern GTY(()) tree gfor_fndecl_string_index;
 541 extern GTY(()) tree gfor_fndecl_string_scan;
 542 extern GTY(()) tree gfor_fndecl_string_verify;
 543 extern GTY(()) tree gfor_fndecl_string_trim;
 544 extern GTY(()) tree gfor_fndecl_adjustl;
 545 extern GTY(()) tree gfor_fndecl_adjustr;
 546
 547 /* Other misc. runtime library functions.  */
 548 extern GTY(()) tree gfor_fndecl_size0;
 549 extern GTY(()) tree gfor_fndecl_size1;
 550 extern GTY(()) tree gfor_fndecl_iargc;
 551
 552 /* Implemented in FORTRAN.  */
 553 extern GTY(()) tree gfor_fndecl_si_kind;
 554 extern GTY(()) tree gfor_fndecl_sr_kind;
 555
 556
 557 /* True if node is an integer constant.  */
 558 #define INTEGER_CST_P(node) (TREE_CODE(node) == INTEGER_CST)
 559
 560 /* G95-specific declaration information.  */
 561
 562 /* Array types only.  */
 563 struct lang_type                GTY(())
 564 {
 565   int rank;
 566   tree lbound[GFC_MAX_DIMENSIONS];
 567   tree ubound[GFC_MAX_DIMENSIONS];
 568   tree stride[GFC_MAX_DIMENSIONS];
 569   tree size;
 570   tree offset;
 571   tree dtype;
 572   tree dataptr_type;
 573 };
 574
 575 struct lang_decl                GTY(())
 576 {
 577   /* Dummy variables.  */
 578   tree saved_descriptor;
 579   /* Assigned integer nodes.  Stringlength is the IO format string's length.
 580      Addr is the address of the string or the target label. Stringlength is
 581      initialized to -2 and assigned to -1 when addr is assigned to the
 582      address of target label.  */
 583   tree stringlen;
 584   tree addr;
 585 };
 586
 587
 588 #define GFC_DECL_ASSIGN_ADDR(node) DECL_LANG_SPECIFIC(node)->addr
 589 #define GFC_DECL_STRING_LEN(node) DECL_LANG_SPECIFIC(node)->stringlen
 590 #define GFC_DECL_SAVED_DESCRIPTOR(node) \
 591   (DECL_LANG_SPECIFIC(node)->saved_descriptor)
 592 #define GFC_DECL_PACKED_ARRAY(node) DECL_LANG_FLAG_0(node)
 593 #define GFC_DECL_PARTIAL_PACKED_ARRAY(node) DECL_LANG_FLAG_1(node)
 594 #define GFC_DECL_ASSIGN(node) DECL_LANG_FLAG_2(node)
 595 #define GFC_DECL_COMMON_OR_EQUIV(node) DECL_LANG_FLAG_3(node)
 596 #define GFC_DECL_CRAY_POINTEE(node) DECL_LANG_FLAG_4(node)
 597 #define GFC_DECL_RESULT(node) DECL_LANG_FLAG_5(node)
 598
 599 /* An array descriptor.  */
 600 #define GFC_DESCRIPTOR_TYPE_P(node) TYPE_LANG_FLAG_1(node)
 601 /* An array without a descriptor.  */
 602 #define GFC_ARRAY_TYPE_P(node) TYPE_LANG_FLAG_2(node)
 603 /* Fortran POINTER type.  */
 604 #define GFC_POINTER_TYPE_P(node) TYPE_LANG_FLAG_3(node)
 605 /* The GFC_TYPE_ARRAY_* members are present in both descriptor and
 606    descriptorless array types.  */
 607 #define GFC_TYPE_ARRAY_LBOUND(node, dim) \
 608   (TYPE_LANG_SPECIFIC(node)->lbound[dim])
 609 #define GFC_TYPE_ARRAY_UBOUND(node, dim) \
 610   (TYPE_LANG_SPECIFIC(node)->ubound[dim])
 611 #define GFC_TYPE_ARRAY_STRIDE(node, dim) \
 612   (TYPE_LANG_SPECIFIC(node)->stride[dim])
 613 #define GFC_TYPE_ARRAY_RANK(node) (TYPE_LANG_SPECIFIC(node)->rank)
 614 #define GFC_TYPE_ARRAY_SIZE(node) (TYPE_LANG_SPECIFIC(node)->size)
 615 #define GFC_TYPE_ARRAY_OFFSET(node) (TYPE_LANG_SPECIFIC(node)->offset)
 616 /* Code should use gfc_get_dtype instead of accesig this directly.  It may
 617    not be known when the type is created.  */
 618 #define GFC_TYPE_ARRAY_DTYPE(node) (TYPE_LANG_SPECIFIC(node)->dtype)
 619 #define GFC_TYPE_ARRAY_DATAPTR_TYPE(node) \
 620   (TYPE_LANG_SPECIFIC(node)->dataptr_type)
 621
 622 /* I changed this from sorry(...) because it should not return.  */
 623 /* TODO: Remove gfc_todo_error before releasing version 1.0.  */
 624 #define gfc_todo_error(args...) fatal_error("gfc_todo: Not Implemented: " args)
 625
 626 /* Build an expression with void type.  */
 627 #define build1_v(code, arg) build1(code, void_type_node, arg)
 628 #define build2_v(code, arg1, arg2) build2(code, void_type_node, \
 629                                           arg1, arg2)
 630 #define build3_v(code, arg1, arg2, arg3) build3(code, void_type_node, \
 631                                                 arg1, arg2, arg3)
 632 #define build4_v(code, arg1, arg2, arg3, arg4) build4(code, void_type_node, \
 633                                                       arg1, arg2, arg3, arg4)
 634
 635 /* This group of functions allows a caller to evaluate an expression from
 636    the callee's interface.  It establishes a mapping between the interface's
 637    dummy arguments and the caller's actual arguments, then applies that
 638    mapping to a given gfc_expr.
 639
 640    You can initialize a mapping structure like so:
 641
 642        gfc_interface_mapping mapping;
 643        ...
 644        gfc_init_interface_mapping (&mapping);
 645
 646    You should then evaluate each actual argument into a temporary
 647    gfc_se structure, here called "se", and map the result to the
 648    dummy argument's symbol, here called "sym":
 649
 650        gfc_add_interface_mapping (&mapping, sym, &se);
 651
 652    After adding all mappings, you should call:
 653
 654        gfc_finish_interface_mapping (&mapping, pre, post);
 655
 656    where "pre" and "post" are statement blocks for initialization
 657    and finalization code respectively.  You can then evaluate an
 658    interface expression "expr" as follows:
 659
 660        gfc_apply_interface_mapping (&mapping, se, expr);
 661
 662    Once you've evaluated all expressions, you should free
 663    the mapping structure with:
 664
 665        gfc_free_interface_mapping (&mapping); */
 666
 667
 668 /* This structure represents a mapping from OLD to NEW, where OLD is a
 669    dummy argument symbol and NEW is a symbol that represents the value
 670    of an actual argument.  Mappings are linked together using NEXT
 671    (in no particular order).  */
 672 typedef struct gfc_interface_sym_mapping
 673 {
 674   struct gfc_interface_sym_mapping *next;
 675   gfc_symbol *old;
 676   gfc_symtree *new;
 677 }
 678 gfc_interface_sym_mapping;
 679
 680
 681 /* This structure is used by callers to evaluate an expression from
 682    a callee's interface.  */
 683 typedef struct gfc_interface_mapping
 684 {
 685   /* Maps the interface's dummy arguments to the values that the caller
 686      is passing.  The whole list is owned by this gfc_interface_mapping.  */
 687   gfc_interface_sym_mapping *syms;
 688
 689   /* A list of gfc_charlens that were needed when creating copies of
 690      expressions.  The whole list is owned by this gfc_interface_mapping.  */
 691   gfc_charlen *charlens;
 692 }
 693 gfc_interface_mapping;
 694
 695 void gfc_init_interface_mapping (gfc_interface_mapping *);
 696 void gfc_free_interface_mapping (gfc_interface_mapping *);
 697 void gfc_add_interface_mapping (gfc_interface_mapping *,
 698                                 gfc_symbol *, gfc_se *);
 699 void gfc_finish_interface_mapping (gfc_interface_mapping *,
 700                                    stmtblock_t *, stmtblock_t *);
 701 void gfc_apply_interface_mapping (gfc_interface_mapping *,
 702                                   gfc_se *, gfc_expr *);
 703
 704
 705 /* Standard error messages used in all the trans-*.c files.  */
 706 extern char gfc_msg_bounds[];
 707 extern char gfc_msg_fault[];
 708 extern char gfc_msg_wrong_return[];
 709
 710
 711 #endif /* GFC_TRANS_H */