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/>. */
23 /* Event names. Keep in sync with plugin_event_name[]. */
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_INFO
, /* Information about the plugin */
32 PLUGIN_EVENT_LAST
/* Dummy event used for indexing callback
36 extern const char *plugin_event_name
[];
38 struct plugin_argument
40 char *key
; /* key of the argument. */
41 char *value
; /* value is optional and can be NULL. */
44 enum pass_positioning_ops
46 PASS_POS_INSERT_AFTER
, /* Insert after the reference pass. */
47 PASS_POS_INSERT_BEFORE
, /* Insert before the reference pass. */
48 PASS_POS_REPLACE
/* Replace the reference pass. */
53 struct opt_pass
*pass
; /* New pass provided by the plugin. */
54 const char *reference_pass_name
; /* Name of the reference pass for hooking
56 int ref_pass_instance_number
; /* Insert the pass at the specified
57 instance number of the reference pass.
58 Do it for every instance if it is 0. */
59 enum pass_positioning_ops pos_op
; /* how to insert the new pass. */
62 /* Additional information about the plugin. Used by --help and --version. */
70 /* Represents the gcc version. Used to avoid using an incompatible plugin. */
72 struct plugin_gcc_version
75 const char *datestamp
;
78 const char *configuration_arguments
;
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_NAME - name of the plugin (useful for error reporting)
91 VERSION - the plugin_gcc_version symbol of the plugin itself.
92 ARGC - the size of the ARGV array
93 ARGV - an array of key-value argument pair
95 Returns 0 if initialization finishes successfully. */
97 typedef int (*plugin_init_func
) (const char *plugin_name
,
98 struct plugin_gcc_version
*version
,
99 int argc
, struct plugin_argument
*argv
);
101 /* Declaration for "plugin_init" function so that it doesn't need to be
102 duplicated in every plugin. */
103 extern int plugin_init (const char *, struct plugin_gcc_version
*version
,
104 int, struct plugin_argument
*);
106 /* Function type for a plugin callback routine.
108 GCC_DATA - event-specific data provided by GCC
109 USER_DATA - plugin-specific data provided by the plugin */
111 typedef void (*plugin_callback_func
) (void *gcc_data
, void *user_data
);
113 /* Called from the plugin's initialization code. Register a single callback.
114 This function can be called multiple times.
116 PLUGIN_NAME - display name for this plugin
117 EVENT - which event the callback is for
118 CALLBACK - the callback to be called at the event
119 USER_DATA - plugin-provided data */
121 extern void register_callback (const char *plugin_name
,
122 enum plugin_event event
,
123 plugin_callback_func callback
,
126 #endif /* GCC_PLUGIN_H */