1 /* Header for code translation functions
2 Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008 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 3, 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 COPYING3. If not see
20 <http://www.gnu.org/licenses/>. */
25 /* Mangled symbols take the form __module__name. */
26 #define GFC_MAX_MANGLED_SYMBOL_LEN (GFC_MAX_SYMBOL_LEN*2+4)
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. */
34 unsigned int has_scope
:1;
38 /* a simplified expression */
41 /* Code blocks to be executed before and after using the value. */
45 /* the result of the expression */
48 /* The length of a character string value. */
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;
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.
61 unsigned want_pointer
:1;
63 /* An array function call returning without a temporary. Also used for array
64 pointer assignments. */
65 unsigned direct_byref
:1;
67 /* Ignore absent optional arguments. Used for some intrinsics. */
68 unsigned ignore_optional
:1;
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;
74 /* If set, gfc_conv_function_call does not put byref calls into se->pre. */
75 unsigned no_function_call
:1;
77 /* Scalarization parameters. */
78 struct gfc_se
*parent
;
80 struct gfc_loopinfo
*loop
;
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. */
93 typedef struct gfc_ss_info
96 /* The ref that holds information on this section. */
98 /* The descriptor of this array. */
100 /* holds the pointer to the data array. */
102 /* To move some of the array index calculation out of the innermost loop. */
106 /* Holds the SS for a subscript. Indexed by actual dimension. */
107 struct gfc_ss
*subscript
[GFC_MAX_DIMENSIONS
];
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
112 tree start
[GFC_MAX_DIMENSIONS
];
113 tree end
[GFC_MAX_DIMENSIONS
];
114 tree stride
[GFC_MAX_DIMENSIONS
];
115 tree delta
[GFC_MAX_DIMENSIONS
];
117 /* Translation from scalarizer dimensions to actual dimensions.
118 actual = dim[scalarizer] */
119 int dim
[GFC_MAX_DIMENSIONS
];
125 /* A scalar value. This will be evaluated before entering the
126 scalarization loop. */
129 /* Like GFC_SS_SCALAR except it evaluates a pointer to the expression.
130 Used for elemental function parameters. */
133 /* An array section. Scalarization indices will be substituted during
134 expression translation. */
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, e.g. a(:) = fn(), are handled without a temporary
141 as a special case. */
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. */
149 /* A vector subscript. The vector's descriptor is cached in the
150 "descriptor" field of the associated gfc_ss_info. */
153 /* A temporary array allocated by the scalarizer. Its rank can be less
154 than that of the assignment expression. */
157 /* An intrinsic function call. Many intrinsic functions which map directly
158 to library calls are created as GFC_SS_FUNCTION nodes. */
161 /* A component of a derived type. */
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
176 /* If type is GFC_SS_SCALAR or GFC_SS_REFERENCE. */
186 /* The rank of the temporary. May be less than the rank of the
187 assigned expression. */
192 /* All other types. */
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
;
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. The bit
205 'where' suppresses precalculation of scalars in WHERE assignments. */
206 unsigned useflags
:2, where
:1;
209 #define gfc_get_ss() XCNEW (gfc_ss)
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
;
215 /* Holds information about an expression while it is being scalarized. */
216 typedef struct gfc_loopinfo
223 /* All the SS involved with this loop. */
225 /* The SS describing the temporary used in an assignment. */
228 /* The scalarization loop index variables. */
229 tree loopvar
[GFC_MAX_DIMENSIONS
];
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
];
236 /* The code member contains the code for the body of the next outer loop. */
237 stmtblock_t code
[GFC_MAX_DIMENSIONS
];
239 /* Order in which the dimensions should be looped, innermost first. */
240 int order
[GFC_MAX_DIMENSIONS
];
242 /* The number of dimensions for which a temporary is used. */
245 /* If set we don't need the loop variables. */
246 unsigned array_parameter
:1;
251 /* Information about a symbol that has been shadowed by a temporary. */
254 symbol_attribute attr
;
260 /* Advance the SS chain to the next term. */
261 void gfc_advance_se_ss_chain (gfc_se
*);
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
*);
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 *);
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
);
277 /* Makes sure se is suitable for passing as a function string parameter. */
278 void gfc_conv_string_parameter (gfc_se
* se
);
280 /* Compare two strings. */
281 tree
gfc_build_compare_string (tree
, tree
, tree
, tree
, int);
283 /* Add an item to the end of TREE_LIST. */
284 tree
gfc_chainon_list (tree
, tree
);
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. */
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
);
300 void gfc_conv_scalar_char_value (gfc_symbol
*sym
, gfc_se
*se
, gfc_expr
**expr
);
302 /* Find the decl containing the auxiliary variables for assigned variables. */
303 void gfc_conv_label_variable (gfc_se
* se
, gfc_expr
* expr
);
304 /* If the value is not constant, Create a temporary and copy the value. */
305 tree
gfc_evaluate_now (tree
, stmtblock_t
*);
307 /* Intrinsic function handling. */
308 void gfc_conv_intrinsic_function (gfc_se
*, gfc_expr
*);
310 /* Does an intrinsic map directly to an external library call. */
311 int gfc_is_intrinsic_libcall (gfc_expr
*);
313 /* Used to call the elemental subroutines used in operator assignments. */
314 tree
gfc_conv_operator_assign (gfc_se
*, gfc_se
*, gfc_symbol
*);
316 /* Also used to CALL subroutines. */
317 int gfc_conv_function_call (gfc_se
*, gfc_symbol
*, gfc_actual_arglist
*,
320 void gfc_conv_subref_array_arg (gfc_se
*, gfc_expr
*, int, sym_intent
);
322 /* gfc_trans_* shouldn't call push/poplevel, use gfc_push/pop_scope */
324 /* Generate code for a scalar assignment. */
325 tree
gfc_trans_scalar_assign (gfc_se
*, gfc_se
*, gfc_typespec
, bool, bool);
327 /* Translate COMMON blocks. */
328 void gfc_trans_common (gfc_namespace
*);
330 /* Translate a derived type constructor. */
331 void gfc_conv_structure (gfc_se
*, gfc_expr
*, int);
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
, int);
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_conv_string_length (gfc_charlen
*, stmtblock_t
*);
344 /* Ensure type sizes can be gimplified. */
345 void gfc_trans_vla_type_sizes (gfc_symbol
*, stmtblock_t
*);
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 to a block. */
352 void gfc_add_modify (stmtblock_t
*, tree
, tree
);
354 /* Initialize a statement block. */
355 void gfc_init_block (stmtblock_t
*);
356 /* Start a new statement block. Like gfc_init_block but also starts a new
358 void gfc_start_block (stmtblock_t
*);
359 /* Finish a statement block. Also closes the scope if the block was created
360 with gfc_start_block. */
361 tree
gfc_finish_block (stmtblock_t
*);
362 /* Merge the scope of a block with its parent. */
363 void gfc_merge_block_scope (stmtblock_t
* block
);
365 /* Return the backend label decl. */
366 tree
gfc_get_label_decl (gfc_st_label
*);
368 /* Return the decl for an external function. */
369 tree
gfc_get_extern_function_decl (gfc_symbol
*);
371 /* Return the decl for a function. */
372 tree
gfc_get_function_decl (gfc_symbol
*);
374 /* Build an ADDR_EXPR. */
375 tree
gfc_build_addr_expr (tree
, tree
);
377 /* Build an ARRAY_REF. */
378 tree
gfc_build_array_ref (tree
, tree
, tree
);
380 /* Creates a label. Decl is artificial if label_id == NULL_TREE. */
381 tree
gfc_build_label_decl (tree
);
383 /* Return the decl used to hold the function return value.
384 Do not use if the function has an explicit result variable. */
385 tree
gfc_get_fake_result_decl (gfc_symbol
*, int);
387 /* Get the return label for the current function. */
388 tree
gfc_get_return_label (void);
390 /* Add a decl to the binding level for the current function. */
391 void gfc_add_decl_to_function (tree
);
393 /* Make prototypes for runtime library functions. */
394 void gfc_build_builtin_function_decls (void);
396 /* Set the backend source location of a decl. */
397 void gfc_set_decl_location (tree
, locus
*);
399 /* Return the variable decl for a symbol. */
400 tree
gfc_get_symbol_decl (gfc_symbol
*);
402 /* Build a static initializer. */
403 tree
gfc_conv_initializer (gfc_expr
*, gfc_typespec
*, tree
, bool, bool);
405 /* Assign a default initializer to a derived type. */
406 tree
gfc_init_default_dt (gfc_symbol
*, tree
);
408 /* Substitute a temporary variable in place of the real one. */
409 void gfc_shadow_sym (gfc_symbol
*, tree
, gfc_saved_var
*);
411 /* Restore the original variable. */
412 void gfc_restore_sym (gfc_symbol
*, gfc_saved_var
*);
414 /* Returns true if a variable of specified size should go on the stack. */
415 int gfc_can_put_var_on_stack (tree
);
417 /* Allocate the lang-specific part of a decl node. */
418 void gfc_allocate_lang_decl (tree
);
420 /* Advance along a TREE_CHAIN. */
421 tree
gfc_advance_chain (tree
, int);
423 /* Create a decl for a function. */
424 void gfc_create_function_decl (gfc_namespace
*);
425 /* Generate the code for a function. */
426 void gfc_generate_function_code (gfc_namespace
*);
427 /* Output a BLOCK DATA program unit. */
428 void gfc_generate_block_data (gfc_namespace
*);
429 /* Output a decl for a module variable. */
430 void gfc_generate_module_vars (gfc_namespace
*);
432 /* Get and set the current location. */
433 void gfc_set_backend_locus (locus
*);
434 void gfc_get_backend_locus (locus
*);
436 /* Handle static constructor functions. */
437 extern GTY(()) tree gfc_static_ctors
;
438 void gfc_generate_constructors (void);
440 /* Get the string length of an array constructor. */
441 bool get_array_ctor_strlen (stmtblock_t
*, gfc_constructor
*, tree
*);
443 /* Generate a runtime warning/error check. */
444 void gfc_trans_runtime_check (bool, bool, tree
, stmtblock_t
*, locus
*,
447 /* Generate a call to free() after checking that its arg is non-NULL. */
448 tree
gfc_call_free (tree
);
450 /* Allocate memory after performing a few checks. */
451 tree
gfc_call_malloc (stmtblock_t
*, tree
, tree
);
453 /* Allocate memory for arrays, with optional status variable. */
454 tree
gfc_allocate_array_with_status (stmtblock_t
*, tree
, tree
, tree
);
456 /* Allocate memory, with optional status variable. */
457 tree
gfc_allocate_with_status (stmtblock_t
*, tree
, tree
);
459 /* Generate code to deallocate an array. */
460 tree
gfc_deallocate_with_status (tree
, tree
, bool);
462 /* Generate code to call realloc(). */
463 tree
gfc_call_realloc (stmtblock_t
*, tree
, tree
);
465 /* Generate code for an assignment, includes scalarization. */
466 tree
gfc_trans_assignment (gfc_expr
*, gfc_expr
*, bool);
468 /* Generate code for a pointer assignment. */
469 tree
gfc_trans_pointer_assignment (gfc_expr
*, gfc_expr
*);
471 /* Initialize function decls for library functions. */
472 void gfc_build_intrinsic_lib_fndecls (void);
473 /* Create function decls for IO library functions. */
474 void gfc_trans_io_runtime_check (tree
, tree
, int, const char *, stmtblock_t
*);
475 void gfc_build_io_library_fndecls (void);
476 /* Build a function decl for a library function. */
477 tree
gfc_build_library_function_decl (tree
, tree
, int, ...);
480 tree
pushdecl (tree
);
481 tree
pushdecl_top_level (tree
);
482 void pushlevel (int);
483 tree
poplevel (int, int, int);
484 tree
getdecls (void);
485 tree
gfc_truthvalue_conversion (tree
);
486 tree
gfc_builtin_function (tree
);
487 struct array_descr_info
;
488 bool gfc_get_array_descr_info (const_tree
, struct array_descr_info
*);
490 /* In trans-openmp.c */
491 bool gfc_omp_privatize_by_reference (const_tree
);
492 enum omp_clause_default_kind
gfc_omp_predetermined_sharing (tree
);
493 tree
gfc_omp_clause_default_ctor (tree
, tree
, tree
);
494 tree
gfc_omp_clause_copy_ctor (tree
, tree
, tree
);
495 tree
gfc_omp_clause_assign_op (tree
, tree
, tree
);
496 tree
gfc_omp_clause_dtor (tree
, tree
);
497 bool gfc_omp_disregard_value_expr (tree
, bool);
498 bool gfc_omp_private_debug_clause (tree
, bool);
499 bool gfc_omp_private_outer_ref (tree
);
500 struct gimplify_omp_ctx
;
501 void gfc_omp_firstprivatize_type_sizes (struct gimplify_omp_ctx
*, tree
);
503 /* Runtime library function decls. */
504 extern GTY(()) tree gfor_fndecl_pause_numeric
;
505 extern GTY(()) tree gfor_fndecl_pause_string
;
506 extern GTY(()) tree gfor_fndecl_stop_numeric
;
507 extern GTY(()) tree gfor_fndecl_stop_string
;
508 extern GTY(()) tree gfor_fndecl_runtime_error
;
509 extern GTY(()) tree gfor_fndecl_runtime_error_at
;
510 extern GTY(()) tree gfor_fndecl_runtime_warning_at
;
511 extern GTY(()) tree gfor_fndecl_os_error
;
512 extern GTY(()) tree gfor_fndecl_generate_error
;
513 extern GTY(()) tree gfor_fndecl_set_fpe
;
514 extern GTY(()) tree gfor_fndecl_set_options
;
515 extern GTY(()) tree gfor_fndecl_ttynam
;
516 extern GTY(()) tree gfor_fndecl_ctime
;
517 extern GTY(()) tree gfor_fndecl_fdate
;
518 extern GTY(()) tree gfor_fndecl_in_pack
;
519 extern GTY(()) tree gfor_fndecl_in_unpack
;
520 extern GTY(()) tree gfor_fndecl_associated
;
522 /* Math functions. Many other math functions are handled in
523 trans-intrinsic.c. */
525 typedef struct gfc_powdecl_list
GTY(())
533 extern GTY(()) gfc_powdecl_list gfor_fndecl_math_powi
[4][3];
534 extern GTY(()) tree gfor_fndecl_math_ishftc4
;
535 extern GTY(()) tree gfor_fndecl_math_ishftc8
;
536 extern GTY(()) tree gfor_fndecl_math_ishftc16
;
538 /* BLAS functions. */
539 extern GTY(()) tree gfor_fndecl_sgemm
;
540 extern GTY(()) tree gfor_fndecl_dgemm
;
541 extern GTY(()) tree gfor_fndecl_cgemm
;
542 extern GTY(()) tree gfor_fndecl_zgemm
;
544 /* String functions. */
545 extern GTY(()) tree gfor_fndecl_compare_string
;
546 extern GTY(()) tree gfor_fndecl_concat_string
;
547 extern GTY(()) tree gfor_fndecl_string_len_trim
;
548 extern GTY(()) tree gfor_fndecl_string_index
;
549 extern GTY(()) tree gfor_fndecl_string_scan
;
550 extern GTY(()) tree gfor_fndecl_string_verify
;
551 extern GTY(()) tree gfor_fndecl_string_trim
;
552 extern GTY(()) tree gfor_fndecl_string_minmax
;
553 extern GTY(()) tree gfor_fndecl_adjustl
;
554 extern GTY(()) tree gfor_fndecl_adjustr
;
555 extern GTY(()) tree gfor_fndecl_select_string
;
556 extern GTY(()) tree gfor_fndecl_compare_string_char4
;
557 extern GTY(()) tree gfor_fndecl_concat_string_char4
;
558 extern GTY(()) tree gfor_fndecl_string_len_trim_char4
;
559 extern GTY(()) tree gfor_fndecl_string_index_char4
;
560 extern GTY(()) tree gfor_fndecl_string_scan_char4
;
561 extern GTY(()) tree gfor_fndecl_string_verify_char4
;
562 extern GTY(()) tree gfor_fndecl_string_trim_char4
;
563 extern GTY(()) tree gfor_fndecl_string_minmax_char4
;
564 extern GTY(()) tree gfor_fndecl_adjustl_char4
;
565 extern GTY(()) tree gfor_fndecl_adjustr_char4
;
566 extern GTY(()) tree gfor_fndecl_select_string_char4
;
568 /* Conversion between character kinds. */
569 extern GTY(()) tree gfor_fndecl_convert_char1_to_char4
;
570 extern GTY(()) tree gfor_fndecl_convert_char4_to_char1
;
572 /* Other misc. runtime library functions. */
573 extern GTY(()) tree gfor_fndecl_size0
;
574 extern GTY(()) tree gfor_fndecl_size1
;
575 extern GTY(()) tree gfor_fndecl_iargc
;
577 /* Implemented in Fortran. */
578 extern GTY(()) tree gfor_fndecl_sc_kind
;
579 extern GTY(()) tree gfor_fndecl_si_kind
;
580 extern GTY(()) tree gfor_fndecl_sr_kind
;
583 /* True if node is an integer constant. */
584 #define INTEGER_CST_P(node) (TREE_CODE(node) == INTEGER_CST)
586 /* G95-specific declaration information. */
591 GFC_ARRAY_ASSUMED_SHAPE
,
592 GFC_ARRAY_ALLOCATABLE
,
596 /* Array types only. */
597 struct lang_type
GTY(())
600 enum gfc_array_kind akind
;
601 tree lbound
[GFC_MAX_DIMENSIONS
];
602 tree ubound
[GFC_MAX_DIMENSIONS
];
603 tree stride
[GFC_MAX_DIMENSIONS
];
610 struct lang_decl
GTY(())
612 /* Dummy variables. */
613 tree saved_descriptor
;
614 /* Assigned integer nodes. Stringlength is the IO format string's length.
615 Addr is the address of the string or the target label. Stringlength is
616 initialized to -2 and assigned to -1 when addr is assigned to the
617 address of target label. */
624 #define GFC_DECL_ASSIGN_ADDR(node) DECL_LANG_SPECIFIC(node)->addr
625 #define GFC_DECL_STRING_LEN(node) DECL_LANG_SPECIFIC(node)->stringlen
626 #define GFC_DECL_SPAN(node) DECL_LANG_SPECIFIC(node)->span
627 #define GFC_DECL_SAVED_DESCRIPTOR(node) \
628 (DECL_LANG_SPECIFIC(node)->saved_descriptor)
629 #define GFC_DECL_PACKED_ARRAY(node) DECL_LANG_FLAG_0(node)
630 #define GFC_DECL_PARTIAL_PACKED_ARRAY(node) DECL_LANG_FLAG_1(node)
631 #define GFC_DECL_ASSIGN(node) DECL_LANG_FLAG_2(node)
632 #define GFC_DECL_COMMON_OR_EQUIV(node) DECL_LANG_FLAG_3(node)
633 #define GFC_DECL_CRAY_POINTEE(node) DECL_LANG_FLAG_4(node)
634 #define GFC_DECL_RESULT(node) DECL_LANG_FLAG_5(node)
635 #define GFC_DECL_SUBREF_ARRAY_P(node) DECL_LANG_FLAG_6(node)
637 /* An array descriptor. */
638 #define GFC_DESCRIPTOR_TYPE_P(node) TYPE_LANG_FLAG_1(node)
639 /* An array without a descriptor. */
640 #define GFC_ARRAY_TYPE_P(node) TYPE_LANG_FLAG_2(node)
641 /* Fortran POINTER type. */
642 #define GFC_POINTER_TYPE_P(node) TYPE_LANG_FLAG_3(node)
643 /* The GFC_TYPE_ARRAY_* members are present in both descriptor and
644 descriptorless array types. */
645 #define GFC_TYPE_ARRAY_LBOUND(node, dim) \
646 (TYPE_LANG_SPECIFIC(node)->lbound[dim])
647 #define GFC_TYPE_ARRAY_UBOUND(node, dim) \
648 (TYPE_LANG_SPECIFIC(node)->ubound[dim])
649 #define GFC_TYPE_ARRAY_STRIDE(node, dim) \
650 (TYPE_LANG_SPECIFIC(node)->stride[dim])
651 #define GFC_TYPE_ARRAY_RANK(node) (TYPE_LANG_SPECIFIC(node)->rank)
652 #define GFC_TYPE_ARRAY_SIZE(node) (TYPE_LANG_SPECIFIC(node)->size)
653 #define GFC_TYPE_ARRAY_OFFSET(node) (TYPE_LANG_SPECIFIC(node)->offset)
654 #define GFC_TYPE_ARRAY_AKIND(node) (TYPE_LANG_SPECIFIC(node)->akind)
655 /* Code should use gfc_get_dtype instead of accessing this directly. It may
656 not be known when the type is created. */
657 #define GFC_TYPE_ARRAY_DTYPE(node) (TYPE_LANG_SPECIFIC(node)->dtype)
658 #define GFC_TYPE_ARRAY_DATAPTR_TYPE(node) \
659 (TYPE_LANG_SPECIFIC(node)->dataptr_type)
661 /* Build an expression with void type. */
662 #define build1_v(code, arg) fold_build1(code, void_type_node, arg)
663 #define build2_v(code, arg1, arg2) fold_build2(code, void_type_node, \
665 #define build3_v(code, arg1, arg2, arg3) fold_build3(code, void_type_node, \
667 #define build4_v(code, arg1, arg2, arg3, arg4) build4(code, void_type_node, \
668 arg1, arg2, arg3, arg4)
670 /* This group of functions allows a caller to evaluate an expression from
671 the callee's interface. It establishes a mapping between the interface's
672 dummy arguments and the caller's actual arguments, then applies that
673 mapping to a given gfc_expr.
675 You can initialize a mapping structure like so:
677 gfc_interface_mapping mapping;
679 gfc_init_interface_mapping (&mapping);
681 You should then evaluate each actual argument into a temporary
682 gfc_se structure, here called "se", and map the result to the
683 dummy argument's symbol, here called "sym":
685 gfc_add_interface_mapping (&mapping, sym, &se);
687 After adding all mappings, you should call:
689 gfc_finish_interface_mapping (&mapping, pre, post);
691 where "pre" and "post" are statement blocks for initialization
692 and finalization code respectively. You can then evaluate an
693 interface expression "expr" as follows:
695 gfc_apply_interface_mapping (&mapping, se, expr);
697 Once you've evaluated all expressions, you should free
698 the mapping structure with:
700 gfc_free_interface_mapping (&mapping); */
703 /* This structure represents a mapping from OLD to NEW, where OLD is a
704 dummy argument symbol and NEW is a symbol that represents the value
705 of an actual argument. Mappings are linked together using NEXT
706 (in no particular order). */
707 typedef struct gfc_interface_sym_mapping
709 struct gfc_interface_sym_mapping
*next
;
711 gfc_symtree
*new_sym
;
714 gfc_interface_sym_mapping
;
717 /* This structure is used by callers to evaluate an expression from
718 a callee's interface. */
719 typedef struct gfc_interface_mapping
721 /* Maps the interface's dummy arguments to the values that the caller
722 is passing. The whole list is owned by this gfc_interface_mapping. */
723 gfc_interface_sym_mapping
*syms
;
725 /* A list of gfc_charlens that were needed when creating copies of
726 expressions. The whole list is owned by this gfc_interface_mapping. */
727 gfc_charlen
*charlens
;
729 gfc_interface_mapping
;
731 void gfc_init_interface_mapping (gfc_interface_mapping
*);
732 void gfc_free_interface_mapping (gfc_interface_mapping
*);
733 void gfc_add_interface_mapping (gfc_interface_mapping
*,
734 gfc_symbol
*, gfc_se
*, gfc_expr
*);
735 void gfc_finish_interface_mapping (gfc_interface_mapping
*,
736 stmtblock_t
*, stmtblock_t
*);
737 void gfc_apply_interface_mapping (gfc_interface_mapping
*,
738 gfc_se
*, gfc_expr
*);
741 /* Standard error messages used in all the trans-*.c files. */
742 extern const char gfc_msg_bounds
[];
743 extern const char gfc_msg_fault
[];
744 extern const char gfc_msg_wrong_return
[];
747 #endif /* GFC_TRANS_H */