gcc/fortran/trans-array.h

   1 /* Header for array handling functions
   2    Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008
   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);
  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);
  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, bool, bool, bool);
  36
  37 /* Generate function entry code for allocation of compiler allocated array
  38    variables.  */
  39 tree gfc_trans_auto_array_allocation (tree, gfc_symbol *, tree);
  40 /* Generate entry and exit code for dummy array parameters.  */
  41 tree gfc_trans_dummy_array_bias (gfc_symbol *, tree, tree);
  42 /* Generate entry and exit code for g77 calling convention arrays.  */
  43 tree gfc_trans_g77_array (gfc_symbol *, tree);
  44 /* Generate code to deallocate an array, if it is allocated.  */
  45 tree gfc_trans_dealloc_allocated (tree);
  46
  47 tree gfc_duplicate_allocatable(tree dest, tree src, tree type, int rank);
  48
  49 tree gfc_nullify_alloc_comp (gfc_symbol *, tree, int);
  50
  51 tree gfc_deallocate_alloc_comp (gfc_symbol *, tree, int);
  52
  53 tree gfc_copy_alloc_comp (gfc_symbol *, tree, tree, int);
  54
  55 /* Add initialization for deferred arrays.  */
  56 tree gfc_trans_deferred_array (gfc_symbol *, tree);
  57 /* Generate an initializer for a static pointer or allocatable array.  */
  58 void gfc_trans_static_array_pointer (gfc_symbol *);
  59
  60 /* Generate scalarization information for an expression.  */
  61 gfc_ss *gfc_walk_expr (gfc_expr *);
  62 /* Walk the arguments of an elemental function.  */
  63 gfc_ss *gfc_walk_elemental_function_args (gfc_ss *, gfc_actual_arglist *,
  64                                           gfc_ss_type);
  65 /* Walk an intrinsic function.  */
  66 gfc_ss *gfc_walk_intrinsic_function (gfc_ss *, gfc_expr *,
  67                                      gfc_intrinsic_sym *);
  68 /* Reverse the order of an SS chain.  */
  69 gfc_ss *gfc_reverse_ss (gfc_ss *);
  70
  71 /* Free the SS associated with a loop.  */
  72 void gfc_cleanup_loop (gfc_loopinfo *);
  73 /* Associate a SS chain with a loop.  */
  74 void gfc_add_ss_to_loop (gfc_loopinfo *, gfc_ss *);
  75 /* Mark a SS chain as used in this loop.  */
  76 void gfc_mark_ss_chain_used (gfc_ss *, unsigned);
  77
  78 /* Calculates the lower bound and stride of array sections.  */
  79 void gfc_conv_ss_startstride (gfc_loopinfo *);
  80
  81 void gfc_init_loopinfo (gfc_loopinfo *);
  82 void gfc_copy_loopinfo_to_se (gfc_se *, gfc_loopinfo *);
  83
  84 /* Marks the start of a scalarized expression, and declares loop variables.  */
  85 void gfc_start_scalarized_body (gfc_loopinfo *, stmtblock_t *);
  86 /* Generates the actual loops for a scalarized expression.  */
  87 void gfc_trans_scalarizing_loops (gfc_loopinfo *, stmtblock_t *);
  88 /* Mark the end of the main loop body and the start of the copying loop.  */
  89 void gfc_trans_scalarized_loop_boundary (gfc_loopinfo *, stmtblock_t *);
  90 /* Initialize the scalarization loop parameters.  */
  91 void gfc_conv_loop_setup (gfc_loopinfo *);
  92 /* Resolve array assignment dependencies.  */
  93 void gfc_conv_resolve_dependencies (gfc_loopinfo *, gfc_ss *, gfc_ss *);
  94 /* Build a null array descriptor constructor.  */
  95 tree gfc_build_null_descriptor (tree);
  96
  97 /* Get a single array element.  */
  98 void gfc_conv_array_ref (gfc_se *, gfc_array_ref *, gfc_symbol *, locus *);
  99 /* Translate a reference to a temporary array.  */
 100 void gfc_conv_tmp_array_ref (gfc_se * se);
 101 /* Translate a reference to an array temporary.  */
 102 void gfc_conv_tmp_ref (gfc_se *);
 103
 104 /* Evaluate an array expression.  */
 105 void gfc_conv_expr_descriptor (gfc_se *, gfc_expr *, gfc_ss *);
 106 /* Convert an array for passing as an actual function parameter.  */
 107 void gfc_conv_array_parameter (gfc_se *, gfc_expr *, gfc_ss *, int);
 108 /* Evaluate and transpose a matrix expression.  */
 109 void gfc_conv_array_transpose (gfc_se *, gfc_expr *);
 110
 111 /* These work with both descriptors and descriptorless arrays.  */
 112 tree gfc_conv_array_data (tree);
 113 tree gfc_conv_array_offset (tree);
 114 /* Return either an INT_CST or an expression for that part of the descriptor.  */
 115 tree gfc_conv_array_stride (tree, int);
 116 tree gfc_conv_array_lbound (tree, int);
 117 tree gfc_conv_array_ubound (tree, int);
 118
 119 /* Build expressions for accessing components of an array descriptor.  */
 120 tree gfc_conv_descriptor_data_get (tree);
 121 void gfc_conv_descriptor_data_set_internal (stmtblock_t *, tree, tree, bool);
 122 #define gfc_conv_descriptor_data_set(BLOCK, T1, T2)                     \
 123   gfc_conv_descriptor_data_set_internal ((BLOCK), (T1), (T2), false)
 124 #define gfc_conv_descriptor_data_set_tuples(BLOCK, T1, T2)              \
 125   gfc_conv_descriptor_data_set_internal ((BLOCK), (T1), (T2), true)
 126 tree gfc_conv_descriptor_data_addr (tree);
 127 tree gfc_conv_descriptor_offset (tree);
 128 tree gfc_conv_descriptor_dtype (tree);
 129 tree gfc_conv_descriptor_stride (tree, tree);
 130 tree gfc_conv_descriptor_lbound (tree, tree);
 131 tree gfc_conv_descriptor_ubound (tree, tree);
 132
 133 /* Add pre-loop scalarization code for intrinsic functions which require
 134    special handling.  */
 135 void gfc_add_intrinsic_ss_code (gfc_loopinfo *, gfc_ss *);
 136
 137 /* Functions for constant array constructor processing.  */
 138 unsigned HOST_WIDE_INT gfc_constant_array_constructor_p (gfc_constructor *);
 139 tree gfc_build_constant_array_constructor (gfc_expr *, tree);
 140
 141 /* Copy a string from src to dest.  */
 142 void gfc_trans_string_copy (stmtblock_t *, tree, tree, int, tree, tree, int);