* Mainline merge as of 2006-02-16 (@111136).
[official-gcc.git] / gcc / fortran / trans-array.h
blob2f9fd2d74ffd5884b12a4b72202835c20d79f4f8
1 /* Header for array handling functions
2 Copyright (C) 2002, 2003, 2006 Free Software Foundation, Inc.
3 Contributed by Paul Brook
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 2, or (at your option) any later
10 version.
12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15 for more details.
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING. If not, write to the Free
19 Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA
20 02110-1301, USA. */
22 /* Generate code to free an array. */
23 tree gfc_array_deallocate (tree, tree);
25 /* Generate code to initialize an allocate an array. Statements are added to
26 se, which should contain an expression for the array descriptor. */
27 void gfc_array_allocate (gfc_se *, gfc_ref *, tree);
29 /* Allow the bounds of a loop to be set from a callee's array spec. */
30 void gfc_set_loop_bounds_from_array_spec (gfc_interface_mapping *,
31 gfc_se *, gfc_array_spec *);
33 /* Generate code to allocate a temporary array. */
34 tree gfc_trans_allocate_temp_array (stmtblock_t *, stmtblock_t *,
35 gfc_loopinfo *, gfc_ss_info *, tree, bool,
36 bool);
38 /* Generate function entry code for allocation of compiler allocated array
39 variables. */
40 tree gfc_trans_auto_array_allocation (tree, gfc_symbol *, tree);
41 /* Generate entry and exit code for dummy array parameters. */
42 tree gfc_trans_dummy_array_bias (gfc_symbol *, tree, tree);
43 /* Generate entry and exit code for g77 calling convention arrays. */
44 tree gfc_trans_g77_array (gfc_symbol *, tree);
45 /* Add initialization for deferred arrays. */
46 tree gfc_trans_deferred_array (gfc_symbol *, tree);
47 /* Generate an initializer for a static pointer or allocatable array. */
48 void gfc_trans_static_array_pointer (gfc_symbol *);
50 /* Generate scalarization information for an expression. */
51 gfc_ss *gfc_walk_expr (gfc_expr *);
52 /* Walk the arguments of an elemental function. */
53 gfc_ss *gfc_walk_elemental_function_args (gfc_ss *, gfc_actual_arglist *,
54 gfc_ss_type);
55 /* Walk an intrinsic function. */
56 gfc_ss *gfc_walk_intrinsic_function (gfc_ss *, gfc_expr *,
57 gfc_intrinsic_sym *);
58 /* Reverse the order of an SS chain. */
59 gfc_ss *gfc_reverse_ss (gfc_ss *);
61 /* Free the SS associated with a loop. */
62 void gfc_cleanup_loop (gfc_loopinfo *);
63 /* Associate a SS chain with a loop. */
64 void gfc_add_ss_to_loop (gfc_loopinfo *, gfc_ss *);
65 /* Mark a SS chain as used in this loop. */
66 void gfc_mark_ss_chain_used (gfc_ss *, unsigned);
68 /* Calculates the lower bound and stride of array sections. */
69 void gfc_conv_ss_startstride (gfc_loopinfo *);
71 void gfc_init_loopinfo (gfc_loopinfo *);
72 void gfc_copy_loopinfo_to_se (gfc_se *, gfc_loopinfo *);
74 /* Marks the start of a scalarized expression, and declares loop variables. */
75 void gfc_start_scalarized_body (gfc_loopinfo *, stmtblock_t *);
76 /* Generates the actual loops for a scalarized expression. */
77 void gfc_trans_scalarizing_loops (gfc_loopinfo *, stmtblock_t *);
78 /* Mark the end of the main loop body and the start of the copying loop. */
79 void gfc_trans_scalarized_loop_boundary (gfc_loopinfo *, stmtblock_t *);
80 /* Initialize the scalarization loop parameters. */
81 void gfc_conv_loop_setup (gfc_loopinfo *);
82 /* Resolve array assignment dependencies. */
83 void gfc_conv_resolve_dependencies (gfc_loopinfo *, gfc_ss *, gfc_ss *);
84 /* Build a null array descriptor constructor. */
85 tree gfc_build_null_descriptor (tree);
87 /* Get a single array element. */
88 void gfc_conv_array_ref (gfc_se *, gfc_array_ref *);
89 /* Translate a reference to a temporary array. */
90 void gfc_conv_tmp_array_ref (gfc_se * se);
91 /* Translate a reference to an array temporary. */
92 void gfc_conv_tmp_ref (gfc_se *);
94 /* Evaluate an array expression. */
95 void gfc_conv_expr_descriptor (gfc_se *, gfc_expr *, gfc_ss *);
96 /* Convert an array for passing as an actual function parameter. */
97 void gfc_conv_array_parameter (gfc_se *, gfc_expr *, gfc_ss *, int);
98 /* Evaluate and transpose a matrix expression. */
99 void gfc_conv_array_transpose (gfc_se *, gfc_expr *);
101 /* These work with both descriptors and descriptorless arrays. */
102 tree gfc_conv_array_data (tree);
103 tree gfc_conv_array_offset (tree);
104 /* Return either an INT_CST or an expression for that part of the descriptor. */
105 tree gfc_conv_array_stride (tree, int);
106 tree gfc_conv_array_lbound (tree, int);
107 tree gfc_conv_array_ubound (tree, int);
109 /* Build expressions for accessing components of an array descriptor. */
110 tree gfc_conv_descriptor_data_get (tree);
111 void gfc_conv_descriptor_data_set (stmtblock_t *, tree, tree);
112 tree gfc_conv_descriptor_data_addr (tree);
113 tree gfc_conv_descriptor_offset (tree);
114 tree gfc_conv_descriptor_dtype (tree);
115 tree gfc_conv_descriptor_stride (tree, tree);
116 tree gfc_conv_descriptor_lbound (tree, tree);
117 tree gfc_conv_descriptor_ubound (tree, tree);
119 /* Add pre-loop scalarization code for intrinsic functions which require
120 special handling. */
121 void gfc_add_intrinsic_ss_code (gfc_loopinfo *, gfc_ss *);