gcc/gcc-plugin.h

   1 /* Public header file for plugins to include.
   2    Copyright (C) 2009 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 3, 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 COPYING3.  If not see
  18 <http://www.gnu.org/licenses/>.  */
  19
  20 #ifndef GCC_PLUGIN_H
  21 #define GCC_PLUGIN_H
  22
  23 /* Event names.  Keep in sync with plugin_event_name[].  */
  24 enum plugin_event
  25 {
  26   PLUGIN_PASS_MANAGER_SETUP,    /* To hook into pass manager.  */
  27   PLUGIN_FINISH_TYPE,           /* After finishing parsing a type.  */
  28   PLUGIN_FINISH_UNIT,           /* Useful for summary processing.  */
  29   PLUGIN_CXX_CP_PRE_GENERICIZE, /* Allows to see low level AST in C++ FE.  */
  30   PLUGIN_FINISH,                /* Called before GCC exits.  */
  31   PLUGIN_EVENT_LAST             /* Dummy event used for indexing callback
  32                                    array.  */
  33 };
  34
  35 extern const char *plugin_event_name[];
  36
  37 struct plugin_argument
  38 {
  39   char *key;    /* key of the argument.  */
  40   char *value;  /* value is optional and can be NULL.  */
  41 };
  42
  43 enum pass_positioning_ops
  44 {
  45   PASS_POS_INSERT_AFTER,  /* Insert after the reference pass.  */
  46   PASS_POS_INSERT_BEFORE, /* Insert before the reference pass.  */
  47   PASS_POS_REPLACE        /* Replace the reference pass.  */
  48 };
  49
  50 struct plugin_pass
  51 {
  52   struct opt_pass *pass;            /* New pass provided by the plugin.  */
  53   const char *reference_pass_name;  /* Name of the reference pass for hooking
  54                                        up the new pass.  */
  55   int ref_pass_instance_number;     /* Insert the pass at the specified
  56                                        instance number of the reference pass.
  57                                        Do it for every instance if it is 0.  */
  58   enum pass_positioning_ops pos_op; /* how to insert the new pass.  */
  59 };
  60
  61 /* Function type for the plugin initialization routine. Each plugin module
  62    should define this as an externally-visible function with name
  63    "plugin_init."
  64
  65    PLUGIN_NAME - name of the plugin (useful for error reporting)
  66    ARGC        - the size of the ARGV array
  67    ARGV        - an array of key-value argument pair
  68
  69    Returns 0 if initialization finishes successfully.  */
  70
  71 typedef int (*plugin_init_func) (const char *plugin_name,
  72                                  int argc, struct plugin_argument *argv);
  73
  74 /* Declaration for "plugin_init" function so that it doesn't need to be
  75    duplicated in every plugin.  */
  76 extern int plugin_init (const char *, int, struct plugin_argument *);
  77
  78 /* Function type for a plugin callback routine.
  79
  80    GCC_DATA  - event-specific data provided by GCC
  81    USER_DATA - plugin-specific data provided by the plugin  */
  82
  83 typedef void (*plugin_callback_func) (void *gcc_data, void *user_data);
  84
  85 /* Called from the plugin's initialization code. Register a single callback.
  86    This function can be called multiple times.
  87
  88    PLUGIN_NAME - display name for this plugin
  89    EVENT       - which event the callback is for
  90    CALLBACK    - the callback to be called at the event
  91    USER_DATA   - plugin-provided data   */
  92
  93 extern void register_callback (const char *plugin_name,
  94                                enum plugin_event event,
  95                                plugin_callback_func callback,
  96                                void *user_data);
  97
  98 #endif /* GCC_PLUGIN_H */