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