gcc/fortran/trans-array.h

   1 /* Header for array handling functions
   2    Copyright (C) 2002-2013 Free Software Foundation, Inc.
   3    Contributed by Paul Brook
   4
   5 This file is part of GCC.
   6
   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 3, or (at your option) any later
  10 version.
  11
  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.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GCC; see the file COPYING3.  If not see
  19 <http://www.gnu.org/licenses/>.  */
  20
  21 /* Generate code to free an array.  */
  22 tree gfc_array_deallocate (tree, tree, tree, tree, tree, gfc_expr*);
  23
  24 /* Generate code to initialize and allocate an array.  Statements are added to
  25    se, which should contain an expression for the array descriptor.  */
  26 bool gfc_array_allocate (gfc_se *, gfc_expr *, tree, tree, tree, tree,
  27                          tree, tree *, gfc_expr *);
  28
  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 *);
  32
  33 /* Generate code to create a temporary array.  */
  34 tree gfc_trans_create_temp_array (stmtblock_t *, stmtblock_t *, gfc_ss *,
  35                                   tree, tree, bool, bool, bool, locus *);
  36
  37 /* Generate function entry code for allocation of compiler allocated array
  38    variables.  */
  39 void gfc_trans_auto_array_allocation (tree, gfc_symbol *, gfc_wrapped_block *);
  40 /* Generate entry and exit code for dummy array parameters.  */
  41 void gfc_trans_dummy_array_bias (gfc_symbol *, tree, gfc_wrapped_block *);
  42 /* Generate entry and exit code for g77 calling convention arrays.  */
  43 void gfc_trans_g77_array (gfc_symbol *, gfc_wrapped_block *);
  44 /* Generate code to deallocate an array, if it is allocated.  */
  45 tree gfc_trans_dealloc_allocated (tree, bool);
  46
  47 tree gfc_duplicate_allocatable (tree dest, tree src, tree type, int rank);
  48
  49 tree gfc_copy_allocatable_data (tree dest, tree src, tree type, int rank);
  50
  51 tree gfc_nullify_alloc_comp (gfc_symbol *, tree, int);
  52
  53 tree gfc_deallocate_alloc_comp (gfc_symbol *, tree, int);
  54
  55 tree gfc_copy_alloc_comp (gfc_symbol *, tree, tree, int);
  56
  57 tree gfc_copy_only_alloc_comp (gfc_symbol *, tree, tree, int);
  58
  59 tree gfc_alloc_allocatable_for_assignment (gfc_loopinfo*, gfc_expr*, gfc_expr*);
  60
  61 bool gfc_is_reallocatable_lhs (gfc_expr *);
  62
  63 /* Add initialization for deferred arrays.  */
  64 void gfc_trans_deferred_array (gfc_symbol *, gfc_wrapped_block *);
  65 /* Generate an initializer for a static pointer or allocatable array.  */
  66 void gfc_trans_static_array_pointer (gfc_symbol *);
  67
  68 /* Get the procedure interface for a function call.  */
  69 gfc_symbol *gfc_get_proc_ifc_for_expr (gfc_expr *);
  70 /* Generate scalarization information for an expression.  */
  71 gfc_ss *gfc_walk_expr (gfc_expr *);
  72 /* Workhorse for gfc_walk_expr.  */
  73 gfc_ss *gfc_walk_subexpr (gfc_ss *, gfc_expr *);
  74 /* Workhorse for gfc_walk_variable_expr.  */
  75 gfc_ss *gfc_walk_array_ref (gfc_ss *, gfc_expr *, gfc_ref * ref);
  76 /* Walk the arguments of an elemental function.  */
  77 gfc_ss *gfc_walk_elemental_function_args (gfc_ss *, gfc_actual_arglist *,
  78                                           gfc_symbol *, gfc_ss_type);
  79 /* Walk an intrinsic function.  */
  80 gfc_ss *gfc_walk_intrinsic_function (gfc_ss *, gfc_expr *,
  81                                      gfc_intrinsic_sym *);
  82 /* Reverse the order of an SS chain.  */
  83 gfc_ss *gfc_reverse_ss (gfc_ss *);
  84
  85 /* Free the SS associated with a loop.  */
  86 void gfc_cleanup_loop (gfc_loopinfo *);
  87 /* Associate a SS chain with a loop.  */
  88 void gfc_add_ss_to_loop (gfc_loopinfo *, gfc_ss *);
  89 /* Mark a SS chain as used in this loop.  */
  90 void gfc_mark_ss_chain_used (gfc_ss *, unsigned);
  91 /* Free a gfc_ss chain.  */
  92 void gfc_free_ss_chain (gfc_ss *);
  93 /* Free a single gfc_ss element.  */
  94 void gfc_free_ss (gfc_ss *);
  95 /* Allocate a new array type ss.  */
  96 gfc_ss *gfc_get_array_ss (gfc_ss *, gfc_expr *, int, gfc_ss_type);
  97 /* Allocate a new temporary type ss.  */
  98 gfc_ss *gfc_get_temp_ss (tree, tree, int);
  99 /* Allocate a new scalar type ss.  */
 100 gfc_ss *gfc_get_scalar_ss (gfc_ss *, gfc_expr *);
 101
 102 /* Calculates the lower bound and stride of array sections.  */
 103 void gfc_conv_ss_startstride (gfc_loopinfo *);
 104
 105 void gfc_init_loopinfo (gfc_loopinfo *);
 106 void gfc_copy_loopinfo_to_se (gfc_se *, gfc_loopinfo *);
 107
 108 /* Marks the start of a scalarized expression, and declares loop variables.  */
 109 void gfc_start_scalarized_body (gfc_loopinfo *, stmtblock_t *);
 110 /* Generates one actual loop for a scalarized expression.  */
 111 void  gfc_trans_scalarized_loop_end (gfc_loopinfo *, int, stmtblock_t *);
 112 /* Generates the actual loops for a scalarized expression.  */
 113 void gfc_trans_scalarizing_loops (gfc_loopinfo *, stmtblock_t *);
 114 /* Mark the end of the main loop body and the start of the copying loop.  */
 115 void gfc_trans_scalarized_loop_boundary (gfc_loopinfo *, stmtblock_t *);
 116 /* Initialize the scalarization loop parameters.  */
 117 void gfc_conv_loop_setup (gfc_loopinfo *, locus *);
 118 /* Set each array's delta.  */
 119 void gfc_set_delta (gfc_loopinfo *);
 120 /* Resolve array assignment dependencies.  */
 121 void gfc_conv_resolve_dependencies (gfc_loopinfo *, gfc_ss *, gfc_ss *);
 122 /* Build a null array descriptor constructor.  */
 123 tree gfc_build_null_descriptor (tree);
 124
 125 /* Get a single array element.  */
 126 void gfc_conv_array_ref (gfc_se *, gfc_array_ref *, gfc_symbol *, locus *);
 127 /* Translate a reference to a temporary array.  */
 128 void gfc_conv_tmp_array_ref (gfc_se * se);
 129 /* Translate a reference to an array temporary.  */
 130 void gfc_conv_tmp_ref (gfc_se *);
 131
 132 /* Evaluate an array expression.  */
 133 void gfc_conv_expr_descriptor (gfc_se *, gfc_expr *);
 134 /* Convert an array for passing as an actual function parameter.  */
 135 void gfc_conv_array_parameter (gfc_se *, gfc_expr *, bool,
 136                                const gfc_symbol *, const char *, tree *);
 137 /* Evaluate and transpose a matrix expression.  */
 138 void gfc_conv_array_transpose (gfc_se *, gfc_expr *);
 139
 140 /* These work with both descriptors and descriptorless arrays.  */
 141 tree gfc_conv_array_data (tree);
 142 tree gfc_conv_array_offset (tree);
 143 /* Return either an INT_CST or an expression for that part of the descriptor.  */
 144 tree gfc_conv_array_stride (tree, int);
 145 tree gfc_conv_array_lbound (tree, int);
 146 tree gfc_conv_array_ubound (tree, int);
 147
 148 /* Set cobounds of an array.  */
 149 void gfc_trans_array_cobounds (tree, stmtblock_t *, const gfc_symbol *);
 150
 151 /* Build expressions for accessing components of an array descriptor.  */
 152 tree gfc_conv_descriptor_data_get (tree);
 153 tree gfc_conv_descriptor_data_addr (tree);
 154 tree gfc_conv_descriptor_offset_get (tree);
 155 tree gfc_conv_descriptor_dtype (tree);
 156 tree gfc_conv_descriptor_rank (tree);
 157 tree gfc_get_descriptor_dimension (tree);
 158 tree gfc_conv_descriptor_stride_get (tree, tree);
 159 tree gfc_conv_descriptor_lbound_get (tree, tree);
 160 tree gfc_conv_descriptor_ubound_get (tree, tree);
 161 tree gfc_conv_descriptor_token (tree);
 162
 163 void gfc_conv_descriptor_data_set (stmtblock_t *, tree, tree);
 164 void gfc_conv_descriptor_offset_set (stmtblock_t *, tree, tree);
 165 void gfc_conv_descriptor_stride_set (stmtblock_t *, tree, tree, tree);
 166 void gfc_conv_descriptor_lbound_set (stmtblock_t *, tree, tree, tree);
 167 void gfc_conv_descriptor_ubound_set (stmtblock_t *, tree, tree, tree);
 168
 169 /* Shift lower bound of descriptor, updating ubound and offset.  */
 170 void gfc_conv_shift_descriptor_lbound (stmtblock_t*, tree, int, tree);
 171
 172 /* Add pre-loop scalarization code for intrinsic functions which require
 173    special handling.  */
 174 void gfc_add_intrinsic_ss_code (gfc_loopinfo *, gfc_ss *);
 175
 176 /* Functions for constant array constructor processing.  */
 177 unsigned HOST_WIDE_INT gfc_constant_array_constructor_p (gfc_constructor_base);
 178 tree gfc_build_constant_array_constructor (gfc_expr *, tree);
 179
 180 /* Copy a string from src to dest.  */
 181 void gfc_trans_string_copy (stmtblock_t *, tree, tree, int, tree, tree, int);
 182
 183 /* Calculate extent / size of an array.  */
 184 tree gfc_conv_array_extent_dim (tree, tree, tree*);
 185 tree gfc_conv_descriptor_size (tree, int);
 186 tree gfc_conv_descriptor_cosize (tree, int, int);