gcc/langhooks.h

   1 /* The lang_hooks data structure.
   2    Copyright 2001, 2002 Free Software Foundation, Inc.
   3
   4 This file is part of GNU CC.
   5
   6 GNU CC is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU CC is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU CC; see the file COPYING.  If not, write to
  18 the Free Software Foundation, 59 Temple Place - Suite 330,
  19 Boston, MA 02111-1307, USA.  */
  20
  21 #ifndef GCC_LANG_HOOKS_H
  22 #define GCC_LANG_HOOKS_H
  23
  24 /* This file should be #include-d after tree.h.  */
  25
  26 struct diagnostic_context;
  27
  28 /* A print hook for print_tree ().  */
  29 typedef void (*lang_print_tree_hook) PARAMS ((FILE *, tree, int indent));
  30
  31 /* The following hooks are documented in langhooks.c.  Must not be
  32    NULL.  */
  33
  34 struct lang_hooks_for_tree_inlining
  35 {
  36   union tree_node *(*walk_subtrees) PARAMS ((union tree_node **, int *,
  37                                              union tree_node *(*)
  38                                              (union tree_node **,
  39                                               int *, void *),
  40                                              void *, void *));
  41   int (*cannot_inline_tree_fn) PARAMS ((union tree_node **));
  42   int (*disregard_inline_limits) PARAMS ((union tree_node *));
  43   union tree_node *(*add_pending_fn_decls) PARAMS ((void *,
  44                                                     union tree_node *));
  45   int (*tree_chain_matters_p) PARAMS ((union tree_node *));
  46   int (*auto_var_in_fn_p) PARAMS ((union tree_node *, union tree_node *));
  47   union tree_node *(*copy_res_decl_for_inlining) PARAMS ((union tree_node *,
  48                                                           union tree_node *,
  49                                                           union tree_node *,
  50                                                           void *, int *,
  51                                                           void *));
  52   int (*anon_aggr_type_p) PARAMS ((union tree_node *));
  53   int (*start_inlining) PARAMS ((union tree_node *));
  54   void (*end_inlining) PARAMS ((union tree_node *));
  55   union tree_node *(*convert_parm_for_inlining) PARAMS ((union tree_node *,
  56                                                          union tree_node *,
  57                                                          union tree_node *));
  58 };
  59
  60 /* The following hooks are used by tree-dump.c.  */
  61
  62 struct lang_hooks_for_tree_dump
  63 {
  64   /* Dump language-specific parts of tree nodes.  Returns non-zero if it
  65      does not want the usual dumping of the second argument.  */
  66   int (*dump_tree) PARAMS ((void *, tree));
  67
  68   /* Determine type qualifiers in a language-specific way.  */
  69   int (*type_quals) PARAMS ((tree));
  70 };
  71
  72 /* Hooks related to types.  */
  73
  74 struct lang_hooks_for_types
  75 {
  76   /* Return a new type (with the indicated CODE), doing whatever
  77      language-specific processing is required.  */
  78   tree (*make_type) PARAMS ((enum tree_code));
  79
  80   /* Given MODE and UNSIGNEDP, return a suitable type-tree with that
  81      mode.  */
  82   tree (*type_for_mode) PARAMS ((enum machine_mode, int));
  83
  84   /* Given PRECISION and UNSIGNEDP, return a suitable type-tree for an
  85      integer type with at least that precision.  */
  86   tree (*type_for_size) PARAMS ((unsigned, int));
  87 };
  88
  89 /* Language hooks related to decls and the symbol table.  */
  90
  91 struct lang_hooks_for_decls
  92 {
  93   /* Enter a new lexical scope.  Argument is always zero when called
  94      from outside the front end.  */
  95   void (*pushlevel) PARAMS ((int));
  96
  97   /* Exit a lexical scope and return a BINDING for that scope.
  98      Takes three arguments:
  99      KEEP -- nonzero if there were declarations in this scope.
 100      REVERSE -- reverse the order of decls before returning them.
 101      FUNCTIONBODY -- nonzero if this level is the body of a function.  */
 102   tree (*poplevel) PARAMS ((int, int, int));
 103
 104   /* Returns non-zero if we are in the global binding level.  Ada
 105      returns -1 for an undocumented reason used in stor-layout.c.  */
 106   int (*global_bindings_p) PARAMS ((void));
 107
 108   /* Insert BLOCK at the end of the list of subblocks of the
 109      current binding level.  This is used when a BIND_EXPR is expanded,
 110      to handle the BLOCK node inside the BIND_EXPR.  */
 111   void (*insert_block) PARAMS ((tree));
 112
 113   /* Set the BLOCK node for the current scope level.  */
 114   void (*set_block) PARAMS ((tree));
 115
 116   /* Function to add a decl to the current scope level.  Takes one
 117      argument, a decl to add.  Returns that decl, or, if the same
 118      symbol is already declared, may return a different decl for that
 119      name.  */
 120   tree (*pushdecl) PARAMS ((tree));
 121
 122   /* Returns the chain of decls so far in the current scope level.  */
 123   tree (*getdecls) PARAMS ((void));
 124 };
 125
 126 /* Language-specific hooks.  See langhooks-def.h for defaults.  */
 127
 128 struct lang_hooks
 129 {
 130   /* String identifying the front end.  e.g. "GNU C++".  */
 131   const char *name;
 132
 133   /* sizeof (struct lang_identifier), so make_node () creates
 134      identifier nodes long enough for the language-specific slots.  */
 135   size_t identifier_size;
 136
 137   /* The first callback made to the front end, for simple
 138      initialization needed before any calls to decode_option.  */
 139   void (*init_options) PARAMS ((void));
 140
 141   /* Function called with an option vector as argument, to decode a
 142      single option (typically starting with -f or -W or +).  It should
 143      return the number of command-line arguments it uses if it handles
 144      the option, or 0 and not complain if it does not recognise the
 145      option.  If this function returns a negative number, then its
 146      absolute value is the number of command-line arguments used, but,
 147      in addition, no language-independent option processing should be
 148      done for this option.  */
 149   int (*decode_option) PARAMS ((int, char **));
 150
 151   /* Called when all command line options have been parsed.  Should do
 152      any required consistency checks, modifications etc.  Complex
 153      initialization should be left to the "init" callback, since GC
 154      and the identifier hashes are set up between now and then.  */
 155   void (*post_options) PARAMS ((void));
 156
 157   /* Called after post_options, to initialize the front end.  The main
 158      input filename is passed, which may be NULL; the front end should
 159      return the original filename (e.g. foo.i -> foo.c).  Return NULL
 160      to indicate a serious error of some sort; in that case no
 161      compilation is performed, and the finish hook is called
 162      immediately.  */
 163   const char * (*init) PARAMS ((const char *));
 164
 165   /* Called at the end of compilation, as a finalizer.  */
 166   void (*finish) PARAMS ((void));
 167
 168   /* Parses the entire file.  */
 169   void (*parse_file) PARAMS ((void));
 170
 171   /* Called immediately after parsing to clear the binding stack.  */
 172   void (*clear_binding_stack) PARAMS ((void));
 173
 174   /* Called to obtain the alias set to be used for an expression or type.
 175      Returns -1 if the language does nothing special for it.  */
 176   HOST_WIDE_INT (*get_alias_set) PARAMS ((tree));
 177
 178   /* Called with an expression that is to be processed as a constant.
 179      Returns either the same expression or a language-independent
 180      constant equivalent to its input.  */
 181   tree (*expand_constant) PARAMS ((tree));
 182
 183   /* Called by expand_expr for language-specific tree codes.
 184      Fourth argument is actually an enum expand_modifier.  */
 185   rtx (*expand_expr) PARAMS ((tree, rtx, enum machine_mode, int));
 186
 187   /* Possibly apply default attributes to a function (represented by
 188      a FUNCTION_DECL).  */
 189   void (*insert_default_attributes) PARAMS ((tree));
 190
 191   /* Hook called by safe_from_p for language-specific tree codes.  It is
 192      up to the language front-end to install a hook if it has any such
 193      codes that safe_from_p needs to know about.  Since same_from_p will
 194      recursively explore the TREE_OPERANDs of an expression, this hook
 195      should not reexamine those pieces.  This routine may recursively
 196      call safe_from_p; it should always pass `0' as the TOP_P
 197      parameter.  */
 198   int (*safe_from_p) PARAMS ((rtx, tree));
 199
 200   /* Hook called by staticp for language-specific tree codes.  */
 201   int (*staticp) PARAMS ((tree));
 202
 203   /* Replace the DECL_LANG_SPECIFIC data, which may be NULL, of the
 204      DECL_NODE with a newly GC-allocated copy.  */
 205   void (*dup_lang_specific_decl) PARAMS ((tree));
 206
 207   /* Called before its argument, an UNSAVE_EXPR, is to be
 208      unsaved.  Modify it in-place so that all the evaluate only once
 209      things are cleared out.  */
 210   tree (*unsave_expr_now) PARAMS ((tree));
 211
 212   /* Called by expand_expr to build and return the cleanup-expression
 213      for the passed TARGET_EXPR.  Return NULL if there is none.  */
 214   tree (*maybe_build_cleanup) PARAMS ((tree));
 215
 216   /* Mark nodes held through the lang_specific hooks in the tree.  */
 217   void (*mark_tree) PARAMS ((tree));
 218
 219   /* Nonzero if TYPE_READONLY and TREE_READONLY should always be honored.  */
 220   bool honor_readonly;
 221
 222   /* The front end can add its own statistics to -fmem-report with
 223      this hook.  It should output to stderr.  */
 224   void (*print_statistics) PARAMS ((void));
 225
 226   /* Called by print_tree when there is a tree of class 'x' that it
 227      doesn't know how to display.  */
 228   lang_print_tree_hook print_xnode;
 229
 230   /* Called to print language-dependent parts of a class 'd', class
 231      't', and IDENTIFIER_NODE nodes.  */
 232   lang_print_tree_hook print_decl;
 233   lang_print_tree_hook print_type;
 234   lang_print_tree_hook print_identifier;
 235
 236   /* Computes the name to use to print a declaration.  DECL is the
 237      non-NULL declaration in question.  VERBOSITY determines what
 238      information will be printed: 0: DECL_NAME, demangled as
 239      necessary.  1: and scope information.  2: and any other
 240      information that might be interesting, such as function parameter
 241      types in C++.  */
 242   const char *(*decl_printable_name) PARAMS ((tree decl, int verbosity));
 243
 244   /* Called by report_error_function to print out function name.  */
 245   void (*print_error_function) PARAMS ((struct diagnostic_context *,
 246                                         const char *));
 247
 248   /* Set yydebug for bison-based parsers, when -dy is given on the
 249      command line.  By default, if the parameter is non-zero, prints a
 250      warning that the front end does not use such a parser.  */
 251   void (*set_yydebug) PARAMS ((int));
 252
 253   struct lang_hooks_for_tree_inlining tree_inlining;
 254
 255   struct lang_hooks_for_tree_dump tree_dump;
 256
 257   struct lang_hooks_for_decls decls;
 258
 259   struct lang_hooks_for_types types;
 260
 261   /* Whenever you add entries here, make sure you adjust langhooks-def.h
 262      and langhooks.c accordingly.  */
 263 };
 264
 265 /* Each front end provides its own.  */
 266 extern const struct lang_hooks lang_hooks;
 267
 268 #endif /* GCC_LANG_HOOKS_H */