gcc/langhooks.h

   1 /* The lang_hooks data structure.
   2    Copyright 2001 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 /* A print hook for print_tree ().  */
  25 typedef void (*lang_print_tree_hook) PARAMS ((FILE *, tree, int indent));
  26
  27 /* The following hooks are documented in langhooks.c.  Must not be
  28    NULL.  */
  29
  30 struct lang_hooks_for_tree_inlining
  31 {
  32   union tree_node *(*walk_subtrees) PARAMS ((union tree_node **, int *,
  33                                              union tree_node *(*)
  34                                              (union tree_node **,
  35                                               int *, void *),
  36                                              void *, void *));
  37   int (*cannot_inline_tree_fn) PARAMS ((union tree_node **));
  38   int (*disregard_inline_limits) PARAMS ((union tree_node *));
  39   union tree_node *(*add_pending_fn_decls) PARAMS ((void *,
  40                                                     union tree_node *));
  41   int (*tree_chain_matters_p) PARAMS ((union tree_node *));
  42   int (*auto_var_in_fn_p) PARAMS ((union tree_node *, union tree_node *));
  43   union tree_node *(*copy_res_decl_for_inlining) PARAMS ((union tree_node *,
  44                                                           union tree_node *,
  45                                                           union tree_node *,
  46                                                           void *, int *,
  47                                                           void *));
  48   int (*anon_aggr_type_p) PARAMS ((union tree_node *));
  49 };
  50
  51 /* The following hooks are used by tree-dump.c.  */
  52
  53 struct lang_hooks_for_tree_dump
  54 {
  55   /* Dump language-specific parts of tree nodes.  Returns non-zero if it
  56      does not want the usual dumping of the second argument.  */
  57   int (*dump_tree) PARAMS ((void *, tree));
  58
  59   /* Determine type qualifiers in a language-specific way.  */
  60   int (*type_quals) PARAMS ((tree));
  61 };
  62
  63 /* Language-specific hooks.  See langhooks-def.h for defaults.  */
  64
  65 struct lang_hooks
  66 {
  67   /* String identifying the front end.  e.g. "GNU C++".  */
  68   const char *name;
  69
  70   /* sizeof (struct lang_identifier), so make_node () creates
  71      identifier nodes long enough for the language-specific slots.  */
  72   size_t identifier_size;
  73
  74   /* Called after options parsing, to initialize the front end.  The
  75      main input filename is passed, which may be NULL; the front end
  76      should return the original filename (e.g. foo.i -> foo.c).
  77      Return NULL to indicate a serious error of some sort; in that
  78      case no compilation is performed, and the finish hook is called
  79      immediately.  */
  80   const char * (*init) PARAMS ((const char *));
  81
  82   /* Called last, as a finalizer.  */
  83   void (*finish) PARAMS ((void));
  84
  85   /* Called immediately after parsing to clear the binding stack.  */
  86   void (*clear_binding_stack) PARAMS ((void));
  87
  88   /* Called to initialize options, before any calls to decode_option.  */
  89   void (*init_options) PARAMS ((void));
  90
  91   /* Function called with an option vector as argument, to decode a
  92      single option (typically starting with -f or -W or +).  It should
  93      return the number of command-line arguments it uses if it handles
  94      the option, or 0 and not complain if it does not recognise the
  95      option.  If this function returns a negative number, then its
  96      absolute value is the number of command-line arguments used, but,
  97      in addition, no language-independent option processing should be
  98      done for this option.  */
  99   int (*decode_option) PARAMS ((int, char **));
 100
 101   /* Called when all command line options have been parsed.  */
 102   void (*post_options) PARAMS ((void));
 103
 104   /* Called to obtain the alias set to be used for an expression or type.
 105      Returns -1 if the language does nothing special for it.  */
 106   HOST_WIDE_INT (*get_alias_set) PARAMS ((tree));
 107
 108   /* Nonzero if TYPE_READONLY and TREE_READONLY should always be honored.  */
 109   bool honor_readonly;
 110
 111   /* The front end can add its own statistics to -fmem-report with
 112      this hook.  It should output to stderr.  */
 113   void (*print_statistics) PARAMS ((void));
 114
 115   /* Called by print_tree when there is a tree of class 'x' that it
 116      doesn't know how to display.  */
 117   lang_print_tree_hook print_xnode;
 118
 119   /* Called to print language-dependent parts of a class 'd', class
 120      't', and IDENTIFIER_NODE nodes.  */
 121   lang_print_tree_hook print_decl;
 122   lang_print_tree_hook print_type;
 123   lang_print_tree_hook print_identifier;
 124
 125   /* Set yydebug for bison-based parsers, when -dy is given on the
 126      command line.  By default, if the parameter is non-zero, prints a
 127      warning that the front end does not use such a parser.  */
 128   void (*set_yydebug) PARAMS ((int));
 129
 130   struct lang_hooks_for_tree_inlining tree_inlining;
 131
 132   struct lang_hooks_for_tree_dump tree_dump;
 133
 134   /* Whenever you add entries here, make sure you adjust langhooks-def.h
 135      and langhooks.c accordingly.  */
 136 };
 137
 138 /* Each front end provides its own.  */
 139 extern const struct lang_hooks lang_hooks;
 140
 141 #endif /* GCC_LANG_HOOKS_H */