1 /* Public header file for plugins to include.
2 Copyright (C) 2009 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"
34 # define DEFEVENT(NAME) NAME,
35 # include "plugin.def"
37 PLUGIN_EVENT_FIRST_DYNAMIC
40 extern const char **plugin_event_name
;
42 struct plugin_argument
44 char *key
; /* key of the argument. */
45 char *value
; /* value is optional and can be NULL. */
48 /* Additional information about the plugin. Used by --help and --version. */
56 /* Represents the gcc version. Used to avoid using an incompatible plugin. */
58 struct plugin_gcc_version
61 const char *datestamp
;
64 const char *configuration_arguments
;
67 /* Object that keeps track of the plugin name and its arguments. */
68 struct plugin_name_args
70 char *base_name
; /* Short name of the plugin (filename without
72 const char *full_name
; /* Path to the plugin as specified with
74 int argc
; /* Number of arguments specified with
76 struct plugin_argument
*argv
; /* Array of ARGC key-value pairs. */
77 const char *version
; /* Version string provided by plugin. */
78 const char *help
; /* Help string provided by plugin. */
81 /* The default version check. Compares every field in VERSION. */
83 extern bool plugin_default_version_check (struct plugin_gcc_version
*,
84 struct plugin_gcc_version
*);
86 /* Function type for the plugin initialization routine. Each plugin module
87 should define this as an externally-visible function with name
90 PLUGIN_INFO - plugin invocation information.
91 VERSION - the plugin_gcc_version symbol of GCC.
93 Returns 0 if initialization finishes successfully. */
95 typedef int (*plugin_init_func
) (struct plugin_name_args
*plugin_info
,
96 struct plugin_gcc_version
*version
);
98 /* Declaration for "plugin_init" function so that it doesn't need to be
99 duplicated in every plugin. */
100 extern int plugin_init (struct plugin_name_args
*plugin_info
,
101 struct plugin_gcc_version
*version
);
103 /* Function type for a plugin callback routine.
105 GCC_DATA - event-specific data provided by GCC
106 USER_DATA - plugin-specific data provided by the plugin */
108 typedef void (*plugin_callback_func
) (void *gcc_data
, void *user_data
);
110 /* Called from the plugin's initialization code. Register a single callback.
111 This function can be called multiple times.
113 PLUGIN_NAME - display name for this plugin
114 EVENT - which event the callback is for
115 CALLBACK - the callback to be called at the event
116 USER_DATA - plugin-provided data.
119 /* Number of event ids / names registered so far. */
121 extern int event_last
;
123 int get_named_event_id (const char *name
, enum insert_option insert
);
125 /* This is also called without a callback routine for the
126 PLUGIN_PASS_MANAGER_SETUP, PLUGIN_INFO, PLUGIN_REGISTER_GGC_ROOTS and
127 PLUGIN_REGISTER_GGC_CACHES pseudo-events, with a specific user_data.
130 extern void register_callback (const char *plugin_name
,
132 plugin_callback_func callback
,
135 extern int unregister_callback (const char *plugin_name
, int event
);
137 #endif /* GCC_PLUGIN_H */