1 /* Header for code translation functions
2 Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007 Free Software
4 Contributed by Paul Brook
6 This file is part of GCC.
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
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
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
26 /* Mangled symbols take the form __module__name. */
27 #define GFC_MAX_MANGLED_SYMBOL_LEN (GFC_MAX_SYMBOL_LEN*2+4)
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. */
35 unsigned int has_scope
:1;
39 /* a simplified expression */
42 /* Code blocks to be executed before and after using the value. */
46 /* the result of the expression */
49 /* The length of a character string value. */
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;
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.
62 unsigned want_pointer
:1;
64 /* An array function call returning without a temporary. Also used for array
65 pointer assignments. */
66 unsigned direct_byref
:1;
68 /* Ignore absent optional arguments. Used for some intrinsics. */
69 unsigned ignore_optional
:1;
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;
75 /* Scalarization parameters. */
76 struct gfc_se
*parent
;
78 struct gfc_loopinfo
*loop
;
83 /* Scalarization State chain. Created by walking an expression tree before
84 creating the scalarization loops. Then passed as part of a gfc_se structure
85 to translate the expression inside the loop. Note that these chains are
86 terminated by gfc_se_terminator, not NULL. A NULL pointer in a gfc_se
87 indicates to gfc_conv_* that this is a scalar expression.
88 Note that some member arrays correspond to scalarizer rank and others
89 are the variable rank. */
91 typedef struct gfc_ss_info
94 /* The ref that holds information on this section. */
96 /* The descriptor of this array. */
98 /* holds the pointer to the data array. */
100 /* To move some of the array index calculation out of the innermost loop. */
104 /* Holds the SS for a subscript. Indexed by actual dimension. */
105 struct gfc_ss
*subscript
[GFC_MAX_DIMENSIONS
];
107 /* stride and delta are used to access this inside a scalarization loop.
108 start is used in the calculation of these. Indexed by scalarizer
110 tree start
[GFC_MAX_DIMENSIONS
];
111 tree end
[GFC_MAX_DIMENSIONS
];
112 tree stride
[GFC_MAX_DIMENSIONS
];
113 tree delta
[GFC_MAX_DIMENSIONS
];
115 /* Translation from scalarizer dimensions to actual dimensions.
116 actual = dim[scalarizer] */
117 int dim
[GFC_MAX_DIMENSIONS
];
123 /* A scalar value. This will be evaluated before entering the
124 scalarization loop. */
127 /* Like GFC_SS_SCALAR except it evaluates a pointer to the expression.
128 Used for elemental function parameters. */
131 /* An array section. Scalarization indices will be substituted during
132 expression translation. */
135 /* A non-elemental function call returning an array. The call is executed
136 before entering the scalarization loop, storing the result in a
137 temporary. This temporary is then used inside the scalarization loop.
138 Simple assignments, eg. a(:) = fn() are handles without a temporary
139 as a special case. */
142 /* An array constructor. The current implementation is sub-optimal in
143 many cases. It allocated a temporary, assigns the values to it, then
144 uses this temporary inside the scalarization loop. */
147 /* A vector subscript. The vector's descriptor is cached in the
148 "descriptor" field of the associated gfc_ss_info. */
151 /* A temporary array allocated by the scalarizer. Its rank can be less
152 than that of the assignment expression. */
155 /* An intrinsic function call. Many intrinsic functions which map directly
156 to library calls are created as GFC_SS_FUNCTION nodes. */
159 /* A component of a derived type. */
164 /* SS structures can only belong to a single loopinfo. They must be added
165 otherwise they will not get freed. */
166 typedef struct gfc_ss
174 /* If type is GFC_SS_SCALAR or GFC_SS_REFERENCE. */
184 /* The rank of the temporary. May be less than the rank of the
185 assigned expression. */
190 /* All other types. */
195 /* All the SS in a loop and linked through loop_chain. The SS for an
196 expression are linked by the next pointer. */
197 struct gfc_ss
*loop_chain
;
200 /* This is used by assignments requiring temporaries. The bits specify which
201 loops the terms appear in. This will be 1 for the RHS expressions,
202 2 for the LHS expressions, and 3(=1|2) for the temporary. */
206 #define gfc_get_ss() gfc_getmem(sizeof(gfc_ss))
208 /* The contents of this aren't actually used. A NULL SS chain indicates a
209 scalar expression, so this pointer is used to terminate SS chains. */
210 extern gfc_ss
* const gfc_ss_terminator
;
212 /* Holds information about an expression while it is being scalarized. */
213 typedef struct gfc_loopinfo
220 /* All the SS involved with this loop. */
222 /* The SS describing the temporary used in an assignment. */
225 /* The scalarization loop index variables. */
226 tree loopvar
[GFC_MAX_DIMENSIONS
];
228 /* The bounds of the scalarization loops. */
229 tree from
[GFC_MAX_DIMENSIONS
];
230 tree to
[GFC_MAX_DIMENSIONS
];
231 gfc_ss
*specloop
[GFC_MAX_DIMENSIONS
];
233 /* The code member contains the code for the body of the next outer loop. */
234 stmtblock_t code
[GFC_MAX_DIMENSIONS
];
236 /* Order in which the dimensions should be looped, innermost first. */
237 int order
[GFC_MAX_DIMENSIONS
];
239 /* The number of dimensions for which a temporary is used. */
242 /* If set we don't need the loop variables. */
243 unsigned array_parameter
:1;
248 /* Information about a symbol that has been shadowed by a temporary. */
251 symbol_attribute attr
;
257 /* Advance the SS chain to the next term. */
258 void gfc_advance_se_ss_chain (gfc_se
*);
260 /* Call this to initialize a gfc_se structure before use
261 first parameter is structure to initialize, second is
262 parent to get scalarization data from, or NULL. */
263 void gfc_init_se (gfc_se
*, gfc_se
*);
265 /* Create an artificial variable decl and add it to the current scope. */
266 tree
gfc_create_var (tree
, const char *);
267 /* Like above but doesn't add it to the current scope. */
268 tree
gfc_create_var_np (tree
, const char *);
270 /* Store the result of an expression in a temp variable so it can be used
271 repeatedly even if the original changes */
272 void gfc_make_safe_expr (gfc_se
* se
);
274 /* Makes sure se is suitable for passing as a function string parameter. */
275 void gfc_conv_string_parameter (gfc_se
* se
);
277 /* Compare two strings. */
278 tree
gfc_build_compare_string (tree
, tree
, tree
, tree
);
280 /* Add an item to the end of TREE_LIST. */
281 tree
gfc_chainon_list (tree
, tree
);
283 /* When using the gfc_conv_* make sure you understand what they do, i.e.
284 when a POST chain may be created, and what the returned expression may be
285 used for. Note that character strings have special handling. This
286 should not be a problem as most statements/operations only deal with
287 numeric/logical types. See the implementations in trans-expr.c
288 for details of the individual functions. */
290 void gfc_conv_expr (gfc_se
* se
, gfc_expr
* expr
);
291 void gfc_conv_expr_val (gfc_se
* se
, gfc_expr
* expr
);
292 void gfc_conv_expr_lhs (gfc_se
* se
, gfc_expr
* expr
);
293 void gfc_conv_expr_reference (gfc_se
* se
, gfc_expr
*);
294 void gfc_conv_expr_type (gfc_se
* se
, gfc_expr
*, tree
);
296 /* Find the decl containing the auxiliary variables for assigned variables. */
297 void gfc_conv_label_variable (gfc_se
* se
, gfc_expr
* expr
);
298 /* If the value is not constant, Create a temporary and copy the value. */
299 tree
gfc_evaluate_now (tree
, stmtblock_t
*);
301 /* Intrinsic function handling. */
302 void gfc_conv_intrinsic_function (gfc_se
*, gfc_expr
*);
304 /* Does an intrinsic map directly to an external library call. */
305 int gfc_is_intrinsic_libcall (gfc_expr
*);
307 /* Used to call the elemental subroutines used in operator assignments. */
308 tree
gfc_conv_operator_assign (gfc_se
*, gfc_se
*, gfc_symbol
*);
310 /* Also used to CALL subroutines. */
311 int gfc_conv_function_call (gfc_se
*, gfc_symbol
*, gfc_actual_arglist
*,
314 void gfc_conv_aliased_arg (gfc_se
*, gfc_expr
*, int, sym_intent
);
315 bool is_aliased_array (gfc_expr
*);
317 /* gfc_trans_* shouldn't call push/poplevel, use gfc_push/pop_scope */
319 /* Generate code for a scalar assignment. */
320 tree
gfc_trans_scalar_assign (gfc_se
*, gfc_se
*, gfc_typespec
, bool, bool);
322 /* Translate COMMON blocks. */
323 void gfc_trans_common (gfc_namespace
*);
325 /* Translate a derived type constructor. */
326 void gfc_conv_structure (gfc_se
*, gfc_expr
*, int);
328 /* Return an expression which determines if a dummy parameter is present. */
329 tree
gfc_conv_expr_present (gfc_symbol
*);
330 /* Convert a missing, dummy argument into a null or zero. */
331 void gfc_conv_missing_dummy (gfc_se
*, gfc_expr
*, gfc_typespec
);
333 /* Generate code to allocate a string temporary. */
334 tree
gfc_conv_string_tmp (gfc_se
*, tree
, tree
);
335 /* Get the string length variable belonging to an expression. */
336 tree
gfc_get_expr_charlen (gfc_expr
*);
337 /* Initialize a string length variable. */
338 void gfc_trans_init_string_length (gfc_charlen
*, stmtblock_t
*);
339 /* Ensure type sizes can be gimplified. */
340 void gfc_trans_vla_type_sizes (gfc_symbol
*, stmtblock_t
*);
342 /* Add an expression to the end of a block. */
343 void gfc_add_expr_to_block (stmtblock_t
*, tree
);
344 /* Add a block to the end of a block. */
345 void gfc_add_block_to_block (stmtblock_t
*, stmtblock_t
*);
346 /* Add a MODIFY_EXPR or a GIMPLE_MODIFY_STMT to a block. */
347 void gfc_add_modify (stmtblock_t
*, tree
, tree
, bool);
348 #define gfc_add_modify_expr(BLOCK, LHS, RHS) \
349 gfc_add_modify ((BLOCK), (LHS), (RHS), false)
350 #define gfc_add_modify_stmt(BLOCK, LHS, RHS) \
351 gfc_add_modify ((BLOCK), (LHS), (RHS), true)
353 /* Initialize a statement block. */
354 void gfc_init_block (stmtblock_t
*);
355 /* Start a new statement block. Like gfc_init_block but also starts a new
357 void gfc_start_block (stmtblock_t
*);
358 /* Finish a statement block. Also closes the scope if the block was created
359 with gfc_start_block. */
360 tree
gfc_finish_block (stmtblock_t
*);
361 /* Merge the scope of a block with its parent. */
362 void gfc_merge_block_scope (stmtblock_t
* block
);
364 /* Return the backend label decl. */
365 tree
gfc_get_label_decl (gfc_st_label
*);
367 /* Return the decl for an external function. */
368 tree
gfc_get_extern_function_decl (gfc_symbol
*);
370 /* Return the decl for a function. */
371 tree
gfc_get_function_decl (gfc_symbol
*);
373 /* Build an ADDR_EXPR. */
374 tree
gfc_build_addr_expr (tree
, tree
);
376 /* Build an ARRAY_REF. */
377 tree
gfc_build_array_ref (tree
, tree
);
379 /* Creates a label. Decl is artificial if label_id == NULL_TREE. */
380 tree
gfc_build_label_decl (tree
);
382 /* Return the decl used to hold the function return value.
383 Do not use if the function has an explicit result variable. */
384 tree
gfc_get_fake_result_decl (gfc_symbol
*, int);
386 /* Get the return label for the current function. */
387 tree
gfc_get_return_label (void);
389 /* Add a decl to the binding level for the current function. */
390 void gfc_add_decl_to_function (tree
);
392 /* Make prototypes for runtime library functions. */
393 void gfc_build_builtin_function_decls (void);
395 /* Set the backend source location of a decl. */
396 void gfc_set_decl_location (tree
, locus
*);
398 /* Return the variable decl for a symbol. */
399 tree
gfc_get_symbol_decl (gfc_symbol
*);
401 /* Build a static initializer. */
402 tree
gfc_conv_initializer (gfc_expr
*, gfc_typespec
*, tree
, bool, bool);
404 /* Substitute a temporary variable in place of the real one. */
405 void gfc_shadow_sym (gfc_symbol
*, tree
, gfc_saved_var
*);
407 /* Restore the original variable. */
408 void gfc_restore_sym (gfc_symbol
*, gfc_saved_var
*);
410 /* Returns true if a variable of specified size should go on the stack. */
411 int gfc_can_put_var_on_stack (tree
);
413 /* Allocate the lang-specific part of a decl node. */
414 void gfc_allocate_lang_decl (tree
);
416 /* Advance along a TREE_CHAIN. */
417 tree
gfc_advance_chain (tree
, int);
419 /* Create a decl for a function. */
420 void gfc_create_function_decl (gfc_namespace
*);
421 /* Generate the code for a function. */
422 void gfc_generate_function_code (gfc_namespace
*);
423 /* Output a BLOCK DATA program unit. */
424 void gfc_generate_block_data (gfc_namespace
*);
425 /* Output a decl for a module variable. */
426 void gfc_generate_module_vars (gfc_namespace
*);
428 /* Get and set the current location. */
429 void gfc_set_backend_locus (locus
*);
430 void gfc_get_backend_locus (locus
*);
432 /* Handle static constructor functions. */
433 extern GTY(()) tree gfc_static_ctors
;
434 void gfc_generate_constructors (void);
436 /* Get the string length of an array constructor. */
437 bool get_array_ctor_strlen (gfc_constructor
*, tree
*);
439 /* Generate a runtime error check. */
440 void gfc_trans_runtime_check (tree
, const char *, stmtblock_t
*, locus
*);
442 /* Generate code for an assignment, includes scalarization. */
443 tree
gfc_trans_assignment (gfc_expr
*, gfc_expr
*, bool);
445 /* Generate code for a pointer assignment. */
446 tree
gfc_trans_pointer_assignment (gfc_expr
*, gfc_expr
*);
448 /* Initialize function decls for library functions. */
449 void gfc_build_intrinsic_lib_fndecls (void);
450 /* Create function decls for IO library functions. */
451 void gfc_trans_io_runtime_check (tree
, tree
, int, const char *, stmtblock_t
*);
452 void gfc_build_io_library_fndecls (void);
453 /* Build a function decl for a library function. */
454 tree
gfc_build_library_function_decl (tree
, tree
, int, ...);
457 tree
pushdecl (tree
);
458 tree
pushdecl_top_level (tree
);
459 void pushlevel (int);
460 tree
poplevel (int, int, int);
461 tree
getdecls (void);
462 tree
gfc_truthvalue_conversion (tree
);
463 tree
gfc_builtin_function (tree
);
465 /* In trans-openmp.c */
466 bool gfc_omp_privatize_by_reference (tree
);
467 enum omp_clause_default_kind
gfc_omp_predetermined_sharing (tree
);
468 tree
gfc_omp_clause_default_ctor (tree
, tree
);
469 bool gfc_omp_disregard_value_expr (tree
, bool);
470 bool gfc_omp_private_debug_clause (tree
, bool);
471 struct gimplify_omp_ctx
;
472 void gfc_omp_firstprivatize_type_sizes (struct gimplify_omp_ctx
*, tree
);
474 /* Runtime library function decls. */
475 extern GTY(()) tree gfor_fndecl_internal_malloc
;
476 extern GTY(()) tree gfor_fndecl_internal_malloc64
;
477 extern GTY(()) tree gfor_fndecl_internal_realloc
;
478 extern GTY(()) tree gfor_fndecl_internal_realloc64
;
479 extern GTY(()) tree gfor_fndecl_internal_free
;
480 extern GTY(()) tree gfor_fndecl_allocate
;
481 extern GTY(()) tree gfor_fndecl_allocate64
;
482 extern GTY(()) tree gfor_fndecl_allocate_array
;
483 extern GTY(()) tree gfor_fndecl_allocate64_array
;
484 extern GTY(()) tree gfor_fndecl_deallocate
;
485 extern GTY(()) tree gfor_fndecl_pause_numeric
;
486 extern GTY(()) tree gfor_fndecl_pause_string
;
487 extern GTY(()) tree gfor_fndecl_stop_numeric
;
488 extern GTY(()) tree gfor_fndecl_stop_string
;
489 extern GTY(()) tree gfor_fndecl_select_string
;
490 extern GTY(()) tree gfor_fndecl_runtime_error
;
491 extern GTY(()) tree gfor_fndecl_runtime_error_at
;
492 extern GTY(()) tree gfor_fndecl_generate_error
;
493 extern GTY(()) tree gfor_fndecl_set_fpe
;
494 extern GTY(()) tree gfor_fndecl_set_std
;
495 extern GTY(()) tree gfor_fndecl_ttynam
;
496 extern GTY(()) tree gfor_fndecl_ctime
;
497 extern GTY(()) tree gfor_fndecl_fdate
;
498 extern GTY(()) tree gfor_fndecl_in_pack
;
499 extern GTY(()) tree gfor_fndecl_in_unpack
;
500 extern GTY(()) tree gfor_fndecl_associated
;
502 /* Math functions. Many other math functions are handled in
503 trans-intrinsic.c. */
505 typedef struct gfc_powdecl_list
GTY(())
513 extern GTY(()) gfc_powdecl_list gfor_fndecl_math_powi
[4][3];
514 extern GTY(()) tree gfor_fndecl_math_cpowf
;
515 extern GTY(()) tree gfor_fndecl_math_cpow
;
516 extern GTY(()) tree gfor_fndecl_math_cpowl10
;
517 extern GTY(()) tree gfor_fndecl_math_cpowl16
;
518 extern GTY(()) tree gfor_fndecl_math_ishftc4
;
519 extern GTY(()) tree gfor_fndecl_math_ishftc8
;
520 extern GTY(()) tree gfor_fndecl_math_ishftc16
;
521 extern GTY(()) tree gfor_fndecl_math_exponent4
;
522 extern GTY(()) tree gfor_fndecl_math_exponent8
;
523 extern GTY(()) tree gfor_fndecl_math_exponent10
;
524 extern GTY(()) tree gfor_fndecl_math_exponent16
;
526 /* BLAS functions. */
527 extern GTY(()) tree gfor_fndecl_sgemm
;
528 extern GTY(()) tree gfor_fndecl_dgemm
;
529 extern GTY(()) tree gfor_fndecl_cgemm
;
530 extern GTY(()) tree gfor_fndecl_zgemm
;
532 /* String functions. */
533 extern GTY(()) tree gfor_fndecl_compare_string
;
534 extern GTY(()) tree gfor_fndecl_concat_string
;
535 extern GTY(()) tree gfor_fndecl_string_len_trim
;
536 extern GTY(()) tree gfor_fndecl_string_index
;
537 extern GTY(()) tree gfor_fndecl_string_scan
;
538 extern GTY(()) tree gfor_fndecl_string_verify
;
539 extern GTY(()) tree gfor_fndecl_string_trim
;
540 extern GTY(()) tree gfor_fndecl_adjustl
;
541 extern GTY(()) tree gfor_fndecl_adjustr
;
543 /* Other misc. runtime library functions. */
544 extern GTY(()) tree gfor_fndecl_size0
;
545 extern GTY(()) tree gfor_fndecl_size1
;
546 extern GTY(()) tree gfor_fndecl_iargc
;
548 /* Implemented in FORTRAN. */
549 extern GTY(()) tree gfor_fndecl_si_kind
;
550 extern GTY(()) tree gfor_fndecl_sr_kind
;
553 /* True if node is an integer constant. */
554 #define INTEGER_CST_P(node) (TREE_CODE(node) == INTEGER_CST)
556 /* G95-specific declaration information. */
558 /* Array types only. */
559 struct lang_type
GTY(())
562 tree lbound
[GFC_MAX_DIMENSIONS
];
563 tree ubound
[GFC_MAX_DIMENSIONS
];
564 tree stride
[GFC_MAX_DIMENSIONS
];
571 struct lang_decl
GTY(())
573 /* Dummy variables. */
574 tree saved_descriptor
;
575 /* Assigned integer nodes. Stringlength is the IO format string's length.
576 Addr is the address of the string or the target label. Stringlength is
577 initialized to -2 and assigned to -1 when addr is assigned to the
578 address of target label. */
584 #define GFC_DECL_ASSIGN_ADDR(node) DECL_LANG_SPECIFIC(node)->addr
585 #define GFC_DECL_STRING_LEN(node) DECL_LANG_SPECIFIC(node)->stringlen
586 #define GFC_DECL_SAVED_DESCRIPTOR(node) \
587 (DECL_LANG_SPECIFIC(node)->saved_descriptor)
588 #define GFC_DECL_PACKED_ARRAY(node) DECL_LANG_FLAG_0(node)
589 #define GFC_DECL_PARTIAL_PACKED_ARRAY(node) DECL_LANG_FLAG_1(node)
590 #define GFC_DECL_ASSIGN(node) DECL_LANG_FLAG_2(node)
591 #define GFC_DECL_COMMON_OR_EQUIV(node) DECL_LANG_FLAG_3(node)
592 #define GFC_DECL_CRAY_POINTEE(node) DECL_LANG_FLAG_4(node)
593 #define GFC_DECL_RESULT(node) DECL_LANG_FLAG_5(node)
595 /* An array descriptor. */
596 #define GFC_DESCRIPTOR_TYPE_P(node) TYPE_LANG_FLAG_1(node)
597 /* An array without a descriptor. */
598 #define GFC_ARRAY_TYPE_P(node) TYPE_LANG_FLAG_2(node)
599 /* The GFC_TYPE_ARRAY_* members are present in both descriptor and
600 descriptorless array types. */
601 #define GFC_TYPE_ARRAY_LBOUND(node, dim) \
602 (TYPE_LANG_SPECIFIC(node)->lbound[dim])
603 #define GFC_TYPE_ARRAY_UBOUND(node, dim) \
604 (TYPE_LANG_SPECIFIC(node)->ubound[dim])
605 #define GFC_TYPE_ARRAY_STRIDE(node, dim) \
606 (TYPE_LANG_SPECIFIC(node)->stride[dim])
607 #define GFC_TYPE_ARRAY_RANK(node) (TYPE_LANG_SPECIFIC(node)->rank)
608 #define GFC_TYPE_ARRAY_SIZE(node) (TYPE_LANG_SPECIFIC(node)->size)
609 #define GFC_TYPE_ARRAY_OFFSET(node) (TYPE_LANG_SPECIFIC(node)->offset)
610 /* Code should use gfc_get_dtype instead of accesig this directly. It may
611 not be known when the type is created. */
612 #define GFC_TYPE_ARRAY_DTYPE(node) (TYPE_LANG_SPECIFIC(node)->dtype)
613 #define GFC_TYPE_ARRAY_DATAPTR_TYPE(node) \
614 (TYPE_LANG_SPECIFIC(node)->dataptr_type)
616 /* I changed this from sorry(...) because it should not return. */
617 /* TODO: Remove gfc_todo_error before releasing version 1.0. */
618 #define gfc_todo_error(args...) fatal_error("gfc_todo: Not Implemented: " args)
620 /* Build an expression with void type. */
621 #define build1_v(code, arg) build1(code, void_type_node, arg)
622 #define build2_v(code, arg1, arg2) build2(code, void_type_node, \
624 #define build3_v(code, arg1, arg2, arg3) build3(code, void_type_node, \
626 #define build4_v(code, arg1, arg2, arg3, arg4) build4(code, void_type_node, \
627 arg1, arg2, arg3, arg4)
629 /* This group of functions allows a caller to evaluate an expression from
630 the callee's interface. It establishes a mapping between the interface's
631 dummy arguments and the caller's actual arguments, then applies that
632 mapping to a given gfc_expr.
634 You can initialize a mapping structure like so:
636 gfc_interface_mapping mapping;
638 gfc_init_interface_mapping (&mapping);
640 You should then evaluate each actual argument into a temporary
641 gfc_se structure, here called "se", and map the result to the
642 dummy argument's symbol, here called "sym":
644 gfc_add_interface_mapping (&mapping, sym, &se);
646 After adding all mappings, you should call:
648 gfc_finish_interface_mapping (&mapping, pre, post);
650 where "pre" and "post" are statement blocks for initialization
651 and finalization code respectively. You can then evaluate an
652 interface expression "expr" as follows:
654 gfc_apply_interface_mapping (&mapping, se, expr);
656 Once you've evaluated all expressions, you should free
657 the mapping structure with:
659 gfc_free_interface_mapping (&mapping); */
662 /* This structure represents a mapping from OLD to NEW, where OLD is a
663 dummy argument symbol and NEW is a symbol that represents the value
664 of an actual argument. Mappings are linked together using NEXT
665 (in no particular order). */
666 typedef struct gfc_interface_sym_mapping
668 struct gfc_interface_sym_mapping
*next
;
672 gfc_interface_sym_mapping
;
675 /* This structure is used by callers to evaluate an expression from
676 a callee's interface. */
677 typedef struct gfc_interface_mapping
679 /* Maps the interface's dummy arguments to the values that the caller
680 is passing. The whole list is owned by this gfc_interface_mapping. */
681 gfc_interface_sym_mapping
*syms
;
683 /* A list of gfc_charlens that were needed when creating copies of
684 expressions. The whole list is owned by this gfc_interface_mapping. */
685 gfc_charlen
*charlens
;
687 gfc_interface_mapping
;
689 void gfc_init_interface_mapping (gfc_interface_mapping
*);
690 void gfc_free_interface_mapping (gfc_interface_mapping
*);
691 void gfc_add_interface_mapping (gfc_interface_mapping
*,
692 gfc_symbol
*, gfc_se
*);
693 void gfc_finish_interface_mapping (gfc_interface_mapping
*,
694 stmtblock_t
*, stmtblock_t
*);
695 void gfc_apply_interface_mapping (gfc_interface_mapping
*,
696 gfc_se
*, gfc_expr
*);
699 /* Standard error messages used in all the trans-*.c files. */
700 extern char gfc_msg_bounds
[];
701 extern char gfc_msg_fault
[];
702 extern char gfc_msg_wrong_return
[];
705 #endif /* GFC_TRANS_H */