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