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   /* Given an integer type T, return a type like T but unsigned.
  89      If T is unsigned, the value is T.  */
  90   tree (*unsigned_type) PARAMS ((tree));
  91
  92   /* Given an integer type T, return a type like T but signed.
  93      If T is signed, the value is T.  */
  94   tree (*signed_type) PARAMS ((tree));
  95
  96   /* Return a type the same as TYPE except unsigned or signed
  97      according to UNSIGNEDP.  */
  98   tree (*signed_or_unsigned_type) PARAMS ((int, tree));
  99
 100   /* This routine is called in tree.c to print an error message for
 101      invalid use of an incomplete type.  VALUE is the expression that
 102      was used (or 0 if that isn't known) and TYPE is the type that was
 103      invalid.  */
 104   void (*incomplete_type_error) PARAMS ((tree value, tree type));
 105 };
 106
 107 /* Language hooks related to decls and the symbol table.  */
 108
 109 struct lang_hooks_for_decls
 110 {
 111   /* Enter a new lexical scope.  Argument is always zero when called
 112      from outside the front end.  */
 113   void (*pushlevel) PARAMS ((int));
 114
 115   /* Exit a lexical scope and return a BINDING for that scope.
 116      Takes three arguments:
 117      KEEP -- nonzero if there were declarations in this scope.
 118      REVERSE -- reverse the order of decls before returning them.
 119      FUNCTIONBODY -- nonzero if this level is the body of a function.  */
 120   tree (*poplevel) PARAMS ((int, int, int));
 121
 122   /* Returns non-zero if we are in the global binding level.  Ada
 123      returns -1 for an undocumented reason used in stor-layout.c.  */
 124   int (*global_bindings_p) PARAMS ((void));
 125
 126   /* Insert BLOCK at the end of the list of subblocks of the
 127      current binding level.  This is used when a BIND_EXPR is expanded,
 128      to handle the BLOCK node inside the BIND_EXPR.  */
 129   void (*insert_block) PARAMS ((tree));
 130
 131   /* Set the BLOCK node for the current scope level.  */
 132   void (*set_block) PARAMS ((tree));
 133
 134   /* Function to add a decl to the current scope level.  Takes one
 135      argument, a decl to add.  Returns that decl, or, if the same
 136      symbol is already declared, may return a different decl for that
 137      name.  */
 138   tree (*pushdecl) PARAMS ((tree));
 139
 140   /* Returns the chain of decls so far in the current scope level.  */
 141   tree (*getdecls) PARAMS ((void));
 142
 143   /* Returns true when we should warn for an unused global DECL.
 144      We will already have checked that it has static binding.  */
 145   bool (*warn_unused_global) PARAMS ((tree));
 146 };
 147
 148 /* Language-specific hooks.  See langhooks-def.h for defaults.  */
 149
 150 struct lang_hooks
 151 {
 152   /* String identifying the front end.  e.g. "GNU C++".  */
 153   const char *name;
 154
 155   /* sizeof (struct lang_identifier), so make_node () creates
 156      identifier nodes long enough for the language-specific slots.  */
 157   size_t identifier_size;
 158
 159   /* The first callback made to the front end, for simple
 160      initialization needed before any calls to decode_option.  */
 161   void (*init_options) PARAMS ((void));
 162
 163   /* Function called with an option vector as argument, to decode a
 164      single option (typically starting with -f or -W or +).  It should
 165      return the number of command-line arguments it uses if it handles
 166      the option, or 0 and not complain if it does not recognise the
 167      option.  If this function returns a negative number, then its
 168      absolute value is the number of command-line arguments used, but,
 169      in addition, no language-independent option processing should be
 170      done for this option.  */
 171   int (*decode_option) PARAMS ((int, char **));
 172
 173   /* Called when all command line options have been parsed.  Should do
 174      any required consistency checks, modifications etc.  Complex
 175      initialization should be left to the "init" callback, since GC
 176      and the identifier hashes are set up between now and then.  */
 177   void (*post_options) PARAMS ((void));
 178
 179   /* Called after post_options, to initialize the front end.  The main
 180      input filename is passed, which may be NULL; the front end should
 181      return the original filename (e.g. foo.i -> foo.c).  Return NULL
 182      to indicate a serious error of some sort; in that case no
 183      compilation is performed, and the finish hook is called
 184      immediately.  */
 185   const char * (*init) PARAMS ((const char *));
 186
 187   /* Called at the end of compilation, as a finalizer.  */
 188   void (*finish) PARAMS ((void));
 189
 190   /* Parses the entire file.  */
 191   void (*parse_file) PARAMS ((void));
 192
 193   /* Called immediately after parsing to clear the binding stack.  */
 194   void (*clear_binding_stack) PARAMS ((void));
 195
 196   /* Called to obtain the alias set to be used for an expression or type.
 197      Returns -1 if the language does nothing special for it.  */
 198   HOST_WIDE_INT (*get_alias_set) PARAMS ((tree));
 199
 200   /* Called with an expression that is to be processed as a constant.
 201      Returns either the same expression or a language-independent
 202      constant equivalent to its input.  */
 203   tree (*expand_constant) PARAMS ((tree));
 204
 205   /* Called by expand_expr for language-specific tree codes.
 206      Fourth argument is actually an enum expand_modifier.  */
 207   rtx (*expand_expr) PARAMS ((tree, rtx, enum machine_mode, int));
 208
 209   /* Prepare expr to be an argument of a TRUTH_NOT_EXPR or other logical
 210      operation.
 211
 212      This preparation consists of taking the ordinary representation
 213      of an expression expr and producing a valid tree boolean
 214      expression describing whether expr is nonzero.  We could simply
 215      always do build_binary_op (NE_EXPR, expr, integer_zero_node, 1),
 216      but we optimize comparisons, &&, ||, and !.
 217
 218      The result should be an expression of boolean type (if not an
 219      error_mark_node).  */
 220   tree (*truthvalue_conversion) PARAMS ((tree));
 221
 222   /* Possibly apply default attributes to a function (represented by
 223      a FUNCTION_DECL).  */
 224   void (*insert_default_attributes) PARAMS ((tree));
 225
 226   /* Hook called by safe_from_p for language-specific tree codes.  It is
 227      up to the language front-end to install a hook if it has any such
 228      codes that safe_from_p needs to know about.  Since same_from_p will
 229      recursively explore the TREE_OPERANDs of an expression, this hook
 230      should not reexamine those pieces.  This routine may recursively
 231      call safe_from_p; it should always pass `0' as the TOP_P
 232      parameter.  */
 233   int (*safe_from_p) PARAMS ((rtx, tree));
 234
 235   /* Function to finish handling an incomplete decl at the end of
 236      compilation.  Default hook is does nothing.  */
 237   void (*finish_incomplete_decl) PARAMS ((tree));
 238
 239   /* Function used by unsafe_for_reeval.  A non-negative number is
 240      returned directly from unsafe_for_reeval, a negative number falls
 241      through.  The default hook returns a negative number.  */
 242   int (*unsafe_for_reeval) PARAMS ((tree));
 243
 244   /* Mark EXP saying that we need to be able to take the address of
 245      it; it should not be allocated in a register.  Return true if
 246      successful.  */
 247   bool (*mark_addressable) PARAMS ((tree));
 248
 249   /* Hook called by staticp for language-specific tree codes.  */
 250   int (*staticp) PARAMS ((tree));
 251
 252   /* Replace the DECL_LANG_SPECIFIC data, which may be NULL, of the
 253      DECL_NODE with a newly GC-allocated copy.  */
 254   void (*dup_lang_specific_decl) PARAMS ((tree));
 255
 256   /* Called before its argument, an UNSAVE_EXPR, is to be
 257      unsaved.  Modify it in-place so that all the evaluate only once
 258      things are cleared out.  */
 259   tree (*unsave_expr_now) PARAMS ((tree));
 260
 261   /* Called by expand_expr to build and return the cleanup-expression
 262      for the passed TARGET_EXPR.  Return NULL if there is none.  */
 263   tree (*maybe_build_cleanup) PARAMS ((tree));
 264
 265   /* Mark nodes held through the lang_specific hooks in the tree.  */
 266   void (*mark_tree) PARAMS ((tree));
 267
 268   /* Set the DECL_ASSEMBLER_NAME for a node.  If it is the sort of
 269      thing that the assembler should talk about, set
 270      DECL_ASSEMBLER_NAME to an appropriate IDENTIFIER_NODE.
 271      Otherwise, set it to the ERROR_MARK_NODE to ensure that the
 272      assembler does not talk about it.  */
 273   void (*set_decl_assembler_name) PARAMS ((tree));
 274
 275   /* Nonzero if TYPE_READONLY and TREE_READONLY should always be honored.  */
 276   bool honor_readonly;
 277
 278   /* The front end can add its own statistics to -fmem-report with
 279      this hook.  It should output to stderr.  */
 280   void (*print_statistics) PARAMS ((void));
 281
 282   /* Called by print_tree when there is a tree of class 'x' that it
 283      doesn't know how to display.  */
 284   lang_print_tree_hook print_xnode;
 285
 286   /* Called to print language-dependent parts of a class 'd', class
 287      't', and IDENTIFIER_NODE nodes.  */
 288   lang_print_tree_hook print_decl;
 289   lang_print_tree_hook print_type;
 290   lang_print_tree_hook print_identifier;
 291
 292   /* Computes the name to use to print a declaration.  DECL is the
 293      non-NULL declaration in question.  VERBOSITY determines what
 294      information will be printed: 0: DECL_NAME, demangled as
 295      necessary.  1: and scope information.  2: and any other
 296      information that might be interesting, such as function parameter
 297      types in C++.  */
 298   const char *(*decl_printable_name) PARAMS ((tree decl, int verbosity));
 299
 300   /* Called by report_error_function to print out function name.  */
 301   void (*print_error_function) PARAMS ((struct diagnostic_context *,
 302                                         const char *));
 303
 304   /* Set yydebug for bison-based parsers, when -dy is given on the
 305      command line.  By default, if the parameter is non-zero, prints a
 306      warning that the front end does not use such a parser.  */
 307   void (*set_yydebug) PARAMS ((int));
 308
 309   struct lang_hooks_for_tree_inlining tree_inlining;
 310
 311   struct lang_hooks_for_tree_dump tree_dump;
 312
 313   struct lang_hooks_for_decls decls;
 314
 315   struct lang_hooks_for_types types;
 316
 317   /* Whenever you add entries here, make sure you adjust langhooks-def.h
 318      and langhooks.c accordingly.  */
 319 };
 320
 321 /* Each front end provides its own.  */
 322 extern const struct lang_hooks lang_hooks;
 323
 324 #endif /* GCC_LANG_HOOKS_H */