gcc/fortran/trans-array.h

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