gcc/fortran/trans.h

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