1 /* Public header file for plugins to include.
2 Copyright (C) 2009, 2010 Free Software Foundation, Inc.
4 This file is part of GCC.
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)
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.
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/>. */
29 #include "highlev-plugin-common.h"
35 # define DEFEVENT(NAME) NAME,
36 # include "plugin.def"
38 PLUGIN_EVENT_FIRST_DYNAMIC
41 extern const char **plugin_event_name;
43 struct plugin_argument
45 char *key; /* key of the argument. */
46 char *value; /* value is optional and can be NULL. */
49 /* Additional information about the plugin. Used by --help and --version. */
57 /* Represents the gcc version. Used to avoid using an incompatible plugin. */
59 struct plugin_gcc_version
62 const char *datestamp;
65 const char *configuration_arguments;
68 /* Object that keeps track of the plugin name and its arguments. */
69 struct plugin_name_args
71 char *base_name; /* Short name of the plugin (filename without
73 const char *full_name; /* Path to the plugin as specified with
75 int argc; /* Number of arguments specified with
77 struct plugin_argument *argv; /* Array of ARGC key-value pairs. */
78 const char *version; /* Version string provided by plugin. */
79 const char *help; /* Help string provided by plugin. */
82 /* The default version check. Compares every field in VERSION. */
84 extern bool plugin_default_version_check (struct plugin_gcc_version *,
85 struct plugin_gcc_version *);
87 /* Function type for the plugin initialization routine. Each plugin module
88 should define this as an externally-visible function with name
91 PLUGIN_INFO - plugin invocation information.
92 VERSION - the plugin_gcc_version symbol of GCC.
94 Returns 0 if initialization finishes successfully. */
96 typedef int (*plugin_init_func) (struct plugin_name_args *plugin_info,
97 struct plugin_gcc_version *version);
102 /* Declaration for "plugin_init" function so that it doesn't need to be
103 duplicated in every plugin. */
104 extern int plugin_init (struct plugin_name_args *plugin_info,
105 struct plugin_gcc_version *version);
110 /* Function type for a plugin callback routine.
112 GCC_DATA - event-specific data provided by GCC
113 USER_DATA - plugin-specific data provided by the plugin */
115 typedef void (*plugin_callback_func) (void *gcc_data, void *user_data);
117 /* Called from the plugin's initialization code. Register a single callback.
118 This function can be called multiple times.
120 PLUGIN_NAME - display name for this plugin
121 EVENT - which event the callback is for
122 CALLBACK - the callback to be called at the event
123 USER_DATA - plugin-provided data.
126 /* Number of event ids / names registered so far. */
128 extern int get_event_last (void);
130 int get_named_event_id (const char *name, enum insert_option insert);
132 /* This is also called without a callback routine for the
133 PLUGIN_PASS_MANAGER_SETUP, PLUGIN_INFO, PLUGIN_REGISTER_GGC_ROOTS and
134 PLUGIN_REGISTER_GGC_CACHES pseudo-events, with a specific user_data.
137 extern void register_callback (const char *plugin_name,
139 plugin_callback_func callback,
142 extern int unregister_callback (const char *plugin_name, int event);
145 /* Retrieve the plugin directory name, as returned by the
146 -fprint-file-name=plugin argument to the gcc program, which is the
147 -iplugindir program argument to cc1. */
148 extern const char* default_plugin_dir_name (void);
150 #endif /* GCC_PLUGIN_H */