OSDN Git Service

* builtin-types.def (BT_FN_PTR_PTR_SIZE): New type.
[pf3gnuchains/gcc-fork.git] / 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 /* Allocate memory for arrays, with optional status variable.  */
454 tree gfc_allocate_array_with_status (stmtblock_t *, tree, tree, tree);
455
456 /* Allocate memory, with optional status variable.  */
457 tree gfc_allocate_with_status (stmtblock_t *, tree, tree);
458
459 /* Generate code to deallocate an array.  */
460 tree gfc_deallocate_with_status (tree, tree, bool);
461
462 /* Generate code to call realloc().  */
463 tree gfc_call_realloc (stmtblock_t *, tree, tree);
464
465 /* Generate code for an assignment, includes scalarization.  */
466 tree gfc_trans_assignment (gfc_expr *, gfc_expr *, bool);
467
468 /* Generate code for a pointer assignment.  */
469 tree gfc_trans_pointer_assignment (gfc_expr *, gfc_expr *);
470
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, ...);
478
479 /* somewhere! */
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
488 /* In trans-openmp.c */
489 bool gfc_omp_privatize_by_reference (const_tree);
490 enum omp_clause_default_kind gfc_omp_predetermined_sharing (tree);
491 tree gfc_omp_clause_default_ctor (tree, tree);
492 bool gfc_omp_disregard_value_expr (tree, bool);
493 bool gfc_omp_private_debug_clause (tree, bool);
494 struct gimplify_omp_ctx;
495 void gfc_omp_firstprivatize_type_sizes (struct gimplify_omp_ctx *, tree);
496
497 /* Runtime library function decls.  */
498 extern GTY(()) tree gfor_fndecl_pause_numeric;
499 extern GTY(()) tree gfor_fndecl_pause_string;
500 extern GTY(()) tree gfor_fndecl_stop_numeric;
501 extern GTY(()) tree gfor_fndecl_stop_string;
502 extern GTY(()) tree gfor_fndecl_select_string;
503 extern GTY(()) tree gfor_fndecl_runtime_error;
504 extern GTY(()) tree gfor_fndecl_runtime_error_at;
505 extern GTY(()) tree gfor_fndecl_os_error;
506 extern GTY(()) tree gfor_fndecl_generate_error;
507 extern GTY(()) tree gfor_fndecl_set_fpe;
508 extern GTY(()) tree gfor_fndecl_set_options;
509 extern GTY(()) tree gfor_fndecl_ttynam;
510 extern GTY(()) tree gfor_fndecl_ctime;
511 extern GTY(()) tree gfor_fndecl_fdate;
512 extern GTY(()) tree gfor_fndecl_in_pack;
513 extern GTY(()) tree gfor_fndecl_in_unpack;
514 extern GTY(()) tree gfor_fndecl_associated;
515
516 /* Math functions.  Many other math functions are handled in
517    trans-intrinsic.c.  */
518
519 typedef struct gfc_powdecl_list GTY(())
520 {
521   tree integer;
522   tree real;
523   tree cmplx;
524 }
525 gfc_powdecl_list;
526
527 extern GTY(()) gfc_powdecl_list gfor_fndecl_math_powi[4][3];
528 extern GTY(()) tree gfor_fndecl_math_cpowf;
529 extern GTY(()) tree gfor_fndecl_math_cpow;
530 extern GTY(()) tree gfor_fndecl_math_cpowl10;
531 extern GTY(()) tree gfor_fndecl_math_cpowl16;
532 extern GTY(()) tree gfor_fndecl_math_ishftc4;
533 extern GTY(()) tree gfor_fndecl_math_ishftc8;
534 extern GTY(()) tree gfor_fndecl_math_ishftc16;
535 extern GTY(()) tree gfor_fndecl_math_exponent4;
536 extern GTY(()) tree gfor_fndecl_math_exponent8;
537 extern GTY(()) tree gfor_fndecl_math_exponent10;
538 extern GTY(()) tree gfor_fndecl_math_exponent16;
539
540 /* BLAS functions.  */
541 extern GTY(()) tree gfor_fndecl_sgemm;
542 extern GTY(()) tree gfor_fndecl_dgemm;
543 extern GTY(()) tree gfor_fndecl_cgemm;
544 extern GTY(()) tree gfor_fndecl_zgemm;
545
546 /* String functions.  */
547 extern GTY(()) tree gfor_fndecl_compare_string;
548 extern GTY(()) tree gfor_fndecl_concat_string;
549 extern GTY(()) tree gfor_fndecl_string_len_trim;
550 extern GTY(()) tree gfor_fndecl_string_index;
551 extern GTY(()) tree gfor_fndecl_string_scan;
552 extern GTY(()) tree gfor_fndecl_string_verify;
553 extern GTY(()) tree gfor_fndecl_string_trim;
554 extern GTY(()) tree gfor_fndecl_string_minmax;
555 extern GTY(()) tree gfor_fndecl_adjustl;
556 extern GTY(()) tree gfor_fndecl_adjustr;
557
558 /* Other misc. runtime library functions.  */
559 extern GTY(()) tree gfor_fndecl_size0;
560 extern GTY(()) tree gfor_fndecl_size1;
561 extern GTY(()) tree gfor_fndecl_iargc;
562
563 /* Implemented in FORTRAN.  */
564 extern GTY(()) tree gfor_fndecl_si_kind;
565 extern GTY(()) tree gfor_fndecl_sr_kind;
566
567
568 /* True if node is an integer constant.  */
569 #define INTEGER_CST_P(node) (TREE_CODE(node) == INTEGER_CST)
570
571 /* G95-specific declaration information.  */
572
573 /* Array types only.  */
574 struct lang_type                GTY(())
575 {
576   int rank;
577   tree lbound[GFC_MAX_DIMENSIONS];
578   tree ubound[GFC_MAX_DIMENSIONS];
579   tree stride[GFC_MAX_DIMENSIONS];
580   tree size;
581   tree offset;
582   tree dtype;
583   tree dataptr_type;
584 };
585
586 struct lang_decl                GTY(())
587 {
588   /* Dummy variables.  */
589   tree saved_descriptor;
590   /* Assigned integer nodes.  Stringlength is the IO format string's length.
591      Addr is the address of the string or the target label. Stringlength is
592      initialized to -2 and assigned to -1 when addr is assigned to the
593      address of target label.  */
594   tree stringlen;
595   tree addr;
596 };
597
598
599 #define GFC_DECL_ASSIGN_ADDR(node) DECL_LANG_SPECIFIC(node)->addr
600 #define GFC_DECL_STRING_LEN(node) DECL_LANG_SPECIFIC(node)->stringlen
601 #define GFC_DECL_SAVED_DESCRIPTOR(node) \
602   (DECL_LANG_SPECIFIC(node)->saved_descriptor)
603 #define GFC_DECL_PACKED_ARRAY(node) DECL_LANG_FLAG_0(node)
604 #define GFC_DECL_PARTIAL_PACKED_ARRAY(node) DECL_LANG_FLAG_1(node)
605 #define GFC_DECL_ASSIGN(node) DECL_LANG_FLAG_2(node)
606 #define GFC_DECL_COMMON_OR_EQUIV(node) DECL_LANG_FLAG_3(node)
607 #define GFC_DECL_CRAY_POINTEE(node) DECL_LANG_FLAG_4(node)
608 #define GFC_DECL_RESULT(node) DECL_LANG_FLAG_5(node)
609
610 /* An array descriptor.  */
611 #define GFC_DESCRIPTOR_TYPE_P(node) TYPE_LANG_FLAG_1(node)
612 /* An array without a descriptor.  */
613 #define GFC_ARRAY_TYPE_P(node) TYPE_LANG_FLAG_2(node)
614 /* Fortran POINTER type.  */
615 #define GFC_POINTER_TYPE_P(node) TYPE_LANG_FLAG_3(node)
616 /* The GFC_TYPE_ARRAY_* members are present in both descriptor and
617    descriptorless array types.  */
618 #define GFC_TYPE_ARRAY_LBOUND(node, dim) \
619   (TYPE_LANG_SPECIFIC(node)->lbound[dim])
620 #define GFC_TYPE_ARRAY_UBOUND(node, dim) \
621   (TYPE_LANG_SPECIFIC(node)->ubound[dim])
622 #define GFC_TYPE_ARRAY_STRIDE(node, dim) \
623   (TYPE_LANG_SPECIFIC(node)->stride[dim])
624 #define GFC_TYPE_ARRAY_RANK(node) (TYPE_LANG_SPECIFIC(node)->rank)
625 #define GFC_TYPE_ARRAY_SIZE(node) (TYPE_LANG_SPECIFIC(node)->size)
626 #define GFC_TYPE_ARRAY_OFFSET(node) (TYPE_LANG_SPECIFIC(node)->offset)
627 /* Code should use gfc_get_dtype instead of accesig this directly.  It may
628    not be known when the type is created.  */
629 #define GFC_TYPE_ARRAY_DTYPE(node) (TYPE_LANG_SPECIFIC(node)->dtype)
630 #define GFC_TYPE_ARRAY_DATAPTR_TYPE(node) \
631   (TYPE_LANG_SPECIFIC(node)->dataptr_type)
632
633 /* I changed this from sorry(...) because it should not return.  */
634 /* TODO: Remove gfc_todo_error before releasing version 1.0.  */
635 #define gfc_todo_error(args...) fatal_error("gfc_todo: Not Implemented: " args)
636
637 /* Build an expression with void type.  */
638 #define build1_v(code, arg) build1(code, void_type_node, arg)
639 #define build2_v(code, arg1, arg2) build2(code, void_type_node, \
640                                           arg1, arg2)
641 #define build3_v(code, arg1, arg2, arg3) build3(code, void_type_node, \
642                                                 arg1, arg2, arg3)
643 #define build4_v(code, arg1, arg2, arg3, arg4) build4(code, void_type_node, \
644                                                       arg1, arg2, arg3, arg4)
645
646 /* This group of functions allows a caller to evaluate an expression from
647    the callee's interface.  It establishes a mapping between the interface's
648    dummy arguments and the caller's actual arguments, then applies that
649    mapping to a given gfc_expr.
650
651    You can initialize a mapping structure like so:
652
653        gfc_interface_mapping mapping;
654        ...
655        gfc_init_interface_mapping (&mapping);
656
657    You should then evaluate each actual argument into a temporary
658    gfc_se structure, here called "se", and map the result to the
659    dummy argument's symbol, here called "sym":
660
661        gfc_add_interface_mapping (&mapping, sym, &se);
662
663    After adding all mappings, you should call:
664
665        gfc_finish_interface_mapping (&mapping, pre, post);
666
667    where "pre" and "post" are statement blocks for initialization
668    and finalization code respectively.  You can then evaluate an
669    interface expression "expr" as follows:
670
671        gfc_apply_interface_mapping (&mapping, se, expr);
672
673    Once you've evaluated all expressions, you should free
674    the mapping structure with:
675
676        gfc_free_interface_mapping (&mapping); */
677
678
679 /* This structure represents a mapping from OLD to NEW, where OLD is a
680    dummy argument symbol and NEW is a symbol that represents the value
681    of an actual argument.  Mappings are linked together using NEXT
682    (in no particular order).  */
683 typedef struct gfc_interface_sym_mapping
684 {
685   struct gfc_interface_sym_mapping *next;
686   gfc_symbol *old;
687   gfc_symtree *new;
688 }
689 gfc_interface_sym_mapping;
690
691
692 /* This structure is used by callers to evaluate an expression from
693    a callee's interface.  */
694 typedef struct gfc_interface_mapping
695 {
696   /* Maps the interface's dummy arguments to the values that the caller
697      is passing.  The whole list is owned by this gfc_interface_mapping.  */
698   gfc_interface_sym_mapping *syms;
699
700   /* A list of gfc_charlens that were needed when creating copies of
701      expressions.  The whole list is owned by this gfc_interface_mapping.  */
702   gfc_charlen *charlens;
703 }
704 gfc_interface_mapping;
705
706 void gfc_init_interface_mapping (gfc_interface_mapping *);
707 void gfc_free_interface_mapping (gfc_interface_mapping *);
708 void gfc_add_interface_mapping (gfc_interface_mapping *,
709                                 gfc_symbol *, gfc_se *);
710 void gfc_finish_interface_mapping (gfc_interface_mapping *,
711                                    stmtblock_t *, stmtblock_t *);
712 void gfc_apply_interface_mapping (gfc_interface_mapping *,
713                                   gfc_se *, gfc_expr *);
714
715
716 /* Standard error messages used in all the trans-*.c files.  */
717 extern char gfc_msg_bounds[];
718 extern char gfc_msg_fault[];
719 extern char gfc_msg_wrong_return[];
720
721
722 #endif /* GFC_TRANS_H */