gcc/langhooks.h

   1 /* The lang_hooks data structure.
   2    Copyright 2001, 2002, 2003 Free Software Foundation, Inc.
   3
   4 This file is part of GCC.
   5
   6 GCC 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 GCC 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 GCC; 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) (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) (union tree_node **, int *,
  37                                      union tree_node *(*)
  38                                      (union tree_node **, int *, void *),
  39                                      void *, void *);
  40   int (*cannot_inline_tree_fn) (union tree_node **);
  41   int (*disregard_inline_limits) (union tree_node *);
  42   union tree_node *(*add_pending_fn_decls) (void *, union tree_node *);
  43   int (*tree_chain_matters_p) (union tree_node *);
  44   int (*auto_var_in_fn_p) (union tree_node *, union tree_node *);
  45   union tree_node *(*copy_res_decl_for_inlining) (union tree_node *,
  46                                                   union tree_node *,
  47                                                   union tree_node *,
  48                                                   void *, int *, tree);
  49   int (*anon_aggr_type_p) (union tree_node *);
  50   bool (*var_mod_type_p) (union tree_node *);
  51   int (*start_inlining) (union tree_node *);
  52   void (*end_inlining) (union tree_node *);
  53   union tree_node *(*convert_parm_for_inlining) (union tree_node *,
  54                                                  union tree_node *,
  55                                                  union tree_node *);
  56 };
  57
  58 struct lang_hooks_for_callgraph
  59 {
  60   /* Function passed as argument is needed and will be compiled.
  61      Lower the representation so the calls are explicit.  */
  62   void (*lower_function) (union tree_node *);
  63   /* Produce RTL for function passed as argument.  */
  64   void (*expand_function) (union tree_node *);
  65 };
  66
  67 /* Lang hooks for management of language-specific data or status
  68    when entering / leaving functions etc.  */
  69 struct lang_hooks_for_functions
  70 {
  71   /* Called when entering a function.  */
  72   void (*init) (struct function *);
  73
  74   /* Called when leaving a function.  */
  75   void (*final) (struct function *);
  76
  77   /* Called when entering a nested function.  */
  78   void (*enter_nested) (struct function *);
  79
  80   /* Called when leaving a nested function.  */
  81   void (*leave_nested) (struct function *);
  82 };
  83
  84 /* The following hooks are used by tree-dump.c.  */
  85
  86 struct lang_hooks_for_tree_dump
  87 {
  88   /* Dump language-specific parts of tree nodes.  Returns nonzero if it
  89      does not want the usual dumping of the second argument.  */
  90   bool (*dump_tree) (void *, tree);
  91
  92   /* Determine type qualifiers in a language-specific way.  */
  93   int (*type_quals) (tree);
  94 };
  95
  96 /* Hooks related to types.  */
  97
  98 struct lang_hooks_for_types
  99 {
 100   /* Return a new type (with the indicated CODE), doing whatever
 101      language-specific processing is required.  */
 102   tree (*make_type) (enum tree_code);
 103
 104   /* Given MODE and UNSIGNEDP, return a suitable type-tree with that
 105      mode.  */
 106   tree (*type_for_mode) (enum machine_mode, int);
 107
 108   /* Given PRECISION and UNSIGNEDP, return a suitable type-tree for an
 109      integer type with at least that precision.  */
 110   tree (*type_for_size) (unsigned, int);
 111
 112   /* Given an integer type T, return a type like T but unsigned.
 113      If T is unsigned, the value is T.  */
 114   tree (*unsigned_type) (tree);
 115
 116   /* Given an integer type T, return a type like T but signed.
 117      If T is signed, the value is T.  */
 118   tree (*signed_type) (tree);
 119
 120   /* Return a type the same as TYPE except unsigned or signed
 121      according to UNSIGNEDP.  */
 122   tree (*signed_or_unsigned_type) (int, tree);
 123
 124   /* Given a type, apply default promotions to unnamed function
 125      arguments and return the new type.  Return the same type if no
 126      change.  Required by any language that supports variadic
 127      arguments.  The default hook aborts.  */
 128   tree (*type_promotes_to) (tree);
 129
 130   /* This routine is called in tree.c to print an error message for
 131      invalid use of an incomplete type.  VALUE is the expression that
 132      was used (or 0 if that isn't known) and TYPE is the type that was
 133      invalid.  */
 134   void (*incomplete_type_error) (tree value, tree type);
 135 };
 136
 137 /* Language hooks related to decls and the symbol table.  */
 138
 139 struct lang_hooks_for_decls
 140 {
 141   /* Enter a new lexical scope.  Argument is always zero when called
 142      from outside the front end.  */
 143   void (*pushlevel) (int);
 144
 145   /* Exit a lexical scope and return a BINDING for that scope.
 146      Takes three arguments:
 147      KEEP -- nonzero if there were declarations in this scope.
 148      REVERSE -- reverse the order of decls before returning them.
 149      FUNCTIONBODY -- nonzero if this level is the body of a function.  */
 150   tree (*poplevel) (int, int, int);
 151
 152   /* Returns nonzero if we are in the global binding level.  Ada
 153      returns -1 for an undocumented reason used in stor-layout.c.  */
 154   int (*global_bindings_p) (void);
 155
 156   /* Insert BLOCK at the end of the list of subblocks of the
 157      current binding level.  This is used when a BIND_EXPR is expanded,
 158      to handle the BLOCK node inside the BIND_EXPR.  */
 159   void (*insert_block) (tree);
 160
 161   /* Set the BLOCK node for the current scope level.  */
 162   void (*set_block) (tree);
 163
 164   /* Function to add a decl to the current scope level.  Takes one
 165      argument, a decl to add.  Returns that decl, or, if the same
 166      symbol is already declared, may return a different decl for that
 167      name.  */
 168   tree (*pushdecl) (tree);
 169
 170   /* Returns the chain of decls so far in the current scope level.  */
 171   tree (*getdecls) (void);
 172
 173   /* Returns true when we should warn for an unused global DECL.
 174      We will already have checked that it has static binding.  */
 175   bool (*warn_unused_global) (tree);
 176
 177   /* Obtain a list of globals and do final output on them at end
 178      of compilation */
 179   void (*final_write_globals) (void);
 180
 181   /* Do necessary preparations before assemble_variable can proceed.  */
 182   void (*prepare_assemble_variable) (tree);
 183
 184   /* True if this decl may be called via a sibcall.  */
 185   bool (*ok_for_sibcall) (tree);
 186 };
 187
 188 /* Language-specific hooks.  See langhooks-def.h for defaults.  */
 189
 190 struct lang_hooks
 191 {
 192   /* String identifying the front end.  e.g. "GNU C++".  */
 193   const char *name;
 194
 195   /* sizeof (struct lang_identifier), so make_node () creates
 196      identifier nodes long enough for the language-specific slots.  */
 197   size_t identifier_size;
 198
 199   /* Determines the size of any language-specific 'x' or 'c' nodes.
 200      Since it is called from make_node, the only information available
 201      is the tree code.  Expected to abort on unrecognized codes.  */
 202   size_t (*tree_size) (enum tree_code);
 203
 204   /* The first callback made to the front end, for simple
 205      initialization needed before any calls to handle_option.  Return
 206      the language mask to filter the switch array with.  */
 207   unsigned int (*init_options) (unsigned int argc, const char **argv);
 208
 209   /* Handle the switch CODE, which has real type enum opt_code from
 210      options.h.  If the switch takes an argument, it is passed in ARG
 211      which points to permanent storage.  The handler is responsible for
 212      checking whether ARG is NULL, which indicates that no argument
 213      was in fact supplied.  For -f and -W switches, VALUE is 1 or 0
 214      for the positive and negative forms respectively.
 215
 216      Return 1 if the switch is valid, 0 if invalid, and -1 if it's
 217      valid and should not be treated as language-independent too.  */
 218   int (*handle_option) (size_t code, const char *arg, int value);
 219
 220   /* Handle a filename on the command line.  */
 221   void (*handle_filename) (const char *filename);
 222
 223   /* Return false to use the default complaint about a missing
 224      argument, otherwise output a complaint and return true.  */
 225   bool (*missing_argument) (const char *opt, size_t code);
 226
 227   /* Called when all command line options have been parsed to allow
 228      further processing and initialization
 229
 230      Should return true to indicate that a compiler back-end is
 231      not required, such as with the -E option.
 232
 233      If errorcount is nonzero after this call the compiler exits
 234      immediately and the finish hook is not called.  */
 235   bool (*post_options) (const char **);
 236
 237   /* Called after post_options to initialize the front end.  Return
 238      false to indicate that no further compilation be performed, in
 239      which case the finish hook is called immediately.  */
 240   bool (*init) (void);
 241
 242   /* Called at the end of compilation, as a finalizer.  */
 243   void (*finish) (void);
 244
 245   /* Parses the entire file.  The argument is nonzero to cause bison
 246      parsers to dump debugging information during parsing.  */
 247   void (*parse_file) (int);
 248
 249   /* Called immediately after parsing to clear the binding stack.  */
 250   void (*clear_binding_stack) (void);
 251
 252   /* Called to obtain the alias set to be used for an expression or type.
 253      Returns -1 if the language does nothing special for it.  */
 254   HOST_WIDE_INT (*get_alias_set) (tree);
 255
 256   /* Called with an expression that is to be processed as a constant.
 257      Returns either the same expression or a language-independent
 258      constant equivalent to its input.  */
 259   tree (*expand_constant) (tree);
 260
 261   /* Called by expand_expr for language-specific tree codes.
 262      Fourth argument is actually an enum expand_modifier.  */
 263   rtx (*expand_expr) (tree, rtx, enum machine_mode, int);
 264
 265   /* Prepare expr to be an argument of a TRUTH_NOT_EXPR or other logical
 266      operation.
 267
 268      This preparation consists of taking the ordinary representation
 269      of an expression expr and producing a valid tree boolean
 270      expression describing whether expr is nonzero.  We could simply
 271      always do build_binary_op (NE_EXPR, expr, integer_zero_node, 1),
 272      but we optimize comparisons, &&, ||, and !.
 273
 274      The result should be an expression of boolean type (if not an
 275      error_mark_node).  */
 276   tree (*truthvalue_conversion) (tree);
 277
 278   /* Possibly apply default attributes to a function (represented by
 279      a FUNCTION_DECL).  */
 280   void (*insert_default_attributes) (tree);
 281
 282   /* Hook called by safe_from_p for language-specific tree codes.  It is
 283      up to the language front-end to install a hook if it has any such
 284      codes that safe_from_p needs to know about.  Since same_from_p will
 285      recursively explore the TREE_OPERANDs of an expression, this hook
 286      should not reexamine those pieces.  This routine may recursively
 287      call safe_from_p; it should always pass `0' as the TOP_P
 288      parameter.  */
 289   int (*safe_from_p) (rtx, tree);
 290
 291   /* Function to finish handling an incomplete decl at the end of
 292      compilation.  Default hook is does nothing.  */
 293   void (*finish_incomplete_decl) (tree);
 294
 295   /* Function used by unsafe_for_reeval.  A non-negative number is
 296      returned directly from unsafe_for_reeval, a negative number falls
 297      through.  The default hook returns a negative number.  */
 298   int (*unsafe_for_reeval) (tree);
 299
 300   /* Mark EXP saying that we need to be able to take the address of
 301      it; it should not be allocated in a register.  Return true if
 302      successful.  */
 303   bool (*mark_addressable) (tree);
 304
 305   /* Hook called by staticp for language-specific tree codes.  */
 306   int (*staticp) (tree);
 307
 308   /* Replace the DECL_LANG_SPECIFIC data, which may be NULL, of the
 309      DECL_NODE with a newly GC-allocated copy.  */
 310   void (*dup_lang_specific_decl) (tree);
 311
 312   /* Called before its argument, an UNSAVE_EXPR, is to be
 313      unsaved.  Modify it in-place so that all the evaluate only once
 314      things are cleared out.  */
 315   tree (*unsave_expr_now) (tree);
 316
 317   /* Called by expand_expr to build and return the cleanup-expression
 318      for the passed TARGET_EXPR.  Return NULL if there is none.  */
 319   tree (*maybe_build_cleanup) (tree);
 320
 321   /* Set the DECL_ASSEMBLER_NAME for a node.  If it is the sort of
 322      thing that the assembler should talk about, set
 323      DECL_ASSEMBLER_NAME to an appropriate IDENTIFIER_NODE.
 324      Otherwise, set it to the ERROR_MARK_NODE to ensure that the
 325      assembler does not talk about it.  */
 326   void (*set_decl_assembler_name) (tree);
 327
 328   /* Return nonzero if fold-const is free to use bit-field
 329      optimizations, for instance in fold_truthop().  */
 330   bool (*can_use_bit_fields_p) (void);
 331
 332   /* Nonzero if TYPE_READONLY and TREE_READONLY should always be honored.  */
 333   bool honor_readonly;
 334
 335   /* Nonzero if this front end does not generate a dummy BLOCK between
 336      the outermost scope of the function and the FUNCTION_DECL.  See
 337      is_body_block in stmt.c, and its callers.  */
 338   bool no_body_blocks;
 339
 340   /* The front end can add its own statistics to -fmem-report with
 341      this hook.  It should output to stderr.  */
 342   void (*print_statistics) (void);
 343
 344   /* Called by print_tree when there is a tree of class 'x' that it
 345      doesn't know how to display.  */
 346   lang_print_tree_hook print_xnode;
 347
 348   /* Called to print language-dependent parts of a class 'd', class
 349      't', and IDENTIFIER_NODE nodes.  */
 350   lang_print_tree_hook print_decl;
 351   lang_print_tree_hook print_type;
 352   lang_print_tree_hook print_identifier;
 353
 354   /* Computes the name to use to print a declaration.  DECL is the
 355      non-NULL declaration in question.  VERBOSITY determines what
 356      information will be printed: 0: DECL_NAME, demangled as
 357      necessary.  1: and scope information.  2: and any other
 358      information that might be interesting, such as function parameter
 359      types in C++.  */
 360   const char *(*decl_printable_name) (tree decl, int verbosity);
 361
 362   /* Called by report_error_function to print out function name.  */
 363   void (*print_error_function) (struct diagnostic_context *, const char *);
 364
 365   /* Called from expr_size to calculate the size of the value of an
 366      expression in a language-dependent way.  Returns a tree for the size
 367      in bytes.  A frontend can call lhd_expr_size to get the default
 368      semantics in cases that it doesn't want to handle specially.  */
 369   tree (*expr_size) (tree);
 370
 371   /* Pointers to machine-independent attribute tables, for front ends
 372      using attribs.c.  If one is NULL, it is ignored.  Respectively, a
 373      table of attributes specific to the language, a table of
 374      attributes common to two or more languages (to allow easy
 375      sharing), and a table of attributes for checking formats.  */
 376   const struct attribute_spec *attribute_table;
 377   const struct attribute_spec *common_attribute_table;
 378   const struct attribute_spec *format_attribute_table;
 379
 380   /* Function-related language hooks.  */
 381   struct lang_hooks_for_functions function;
 382
 383   struct lang_hooks_for_tree_inlining tree_inlining;
 384
 385   struct lang_hooks_for_callgraph callgraph;
 386
 387   struct lang_hooks_for_tree_dump tree_dump;
 388
 389   struct lang_hooks_for_decls decls;
 390
 391   struct lang_hooks_for_types types;
 392
 393   /* Whenever you add entries here, make sure you adjust langhooks-def.h
 394      and langhooks.c accordingly.  */
 395 };
 396
 397 /* Each front end provides its own.  */
 398 extern const struct lang_hooks lang_hooks;
 399
 400 #endif /* GCC_LANG_HOOKS_H */