123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194 |
- /* Generic interface between GCC and GDB
- Copyright (C) 2014-2022 Free Software Foundation, Inc.
- This file is part of GCC.
- This program is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 3 of the License, or
- (at your option) any later version.
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU General Public License for more details.
- You should have received a copy of the GNU General Public License
- along with this program. If not, see <http://www.gnu.org/licenses/>. */
- #ifndef GCC_INTERFACE_H
- #define GCC_INTERFACE_H
- /* This header defines the interface to the GCC API. It must be both
- valid C and valid C++, because it is included by both programs. */
- #ifdef __cplusplus
- extern "C" {
- #endif
- /* Opaque typedefs for objects passed through the interface. */
- typedef unsigned long long gcc_type;
- typedef unsigned long long gcc_decl;
- /* An address in the inferior. */
- typedef unsigned long long gcc_address;
- /* Forward declaration. */
- struct gcc_base_context;
- /* Defined versions of the generic API. */
- enum gcc_base_api_version
- {
- GCC_FE_VERSION_0 = 0,
- /* Deprecated methods set_arguments_v0 and compile_v0. Added methods
- set_arguments, set_triplet_regexp, set_driver_filename, set_verbose and
- compile. */
- GCC_FE_VERSION_1 = 1,
- };
- /* The operations defined by the GCC base API. This is the vtable for
- the real context structure which is passed around.
- The "base" API is concerned with basics shared by all compiler
- front ends: setting command-line arguments, the file names, etc.
- Front-end-specific interfaces inherit from this one. */
- struct gcc_base_vtable
- {
- /* The actual version implemented in this interface. This field can
- be relied on not to move, so users can always check it if they
- desire. The value is one of the gcc_base_api_version constants.
- */
- unsigned int version;
- /* Deprecated GCC_FE_VERSION_0 variant of the GCC_FE_VERSION_1
- methods set_triplet_regexp and set_arguments. */
- char *(*set_arguments_v0) (struct gcc_base_context *self,
- const char *triplet_regexp,
- int argc, char **argv);
- /* Set the file name of the program to compile. The string is
- copied by the method implementation, but the caller must
- guarantee that the file exists through the compilation. */
- void (*set_source_file) (struct gcc_base_context *self, const char *file);
- /* Set a callback to use for printing error messages. DATUM is
- passed through to the callback unchanged. */
- void (*set_print_callback) (struct gcc_base_context *self,
- void (*print_function) (void *datum,
- const char *message),
- void *datum);
- /* Deprecated GCC_FE_VERSION_0 variant of the GCC_FE_VERSION_1
- compile method. GCC_FE_VERSION_0 version verbose parameter has
- been replaced by the set_verbose method. */
- int /* bool */ (*compile_v0) (struct gcc_base_context *self,
- const char *filename,
- int /* bool */ verbose);
- /* Destroy this object. */
- void (*destroy) (struct gcc_base_context *self);
- /* VERBOSE can be set to non-zero to cause GCC to print some
- information as it works. Calling this method overrides its
- possible previous calls.
- This method is only available since GCC_FE_VERSION_1. */
- void (*set_verbose) (struct gcc_base_context *self,
- int /* bool */ verbose);
- /* Perform the compilation. FILENAME is the name of the resulting
- object file. Either set_triplet_regexp or set_driver_filename must
- be called before. Returns true on success, false on error.
- This method is only available since GCC_FE_VERSION_1. */
- int /* bool */ (*compile) (struct gcc_base_context *self,
- const char *filename);
- /* Set the compiler's command-line options for the next compilation.
- The arguments are copied by GCC. ARGV need not be
- NULL-terminated. The arguments must be set separately for each
- compilation; that is, after a compile is requested, the
- previously-set arguments cannot be reused.
- This returns NULL on success. On failure, returns a malloc()d
- error message. The caller is responsible for freeing it.
- This method is only available since GCC_FE_VERSION_1. */
- char *(*set_arguments) (struct gcc_base_context *self,
- int argc, char **argv);
- /* Set TRIPLET_REGEXP as a regular expression that is used to match
- the configury triplet prefix to the compiler. Calling this method
- overrides possible previous call of itself or set_driver_filename.
- This returns NULL on success. On failure, returns a malloc()d
- error message. The caller is responsible for freeing it.
- This method is only available since GCC_FE_VERSION_1. */
- char *(*set_triplet_regexp) (struct gcc_base_context *self,
- const char *triplet_regexp);
- /* DRIVER_FILENAME should be filename of the gcc compiler driver
- program. It will be searched in PATH components like
- TRIPLET_REGEXP. Calling this method overrides possible previous
- call of itself or set_triplet_regexp.
- This returns NULL on success. On failure, returns a malloc()d
- error message. The caller is responsible for freeing it.
- This method is only available since GCC_FE_VERSION_1. */
- char *(*set_driver_filename) (struct gcc_base_context *self,
- const char *driver_filename);
- };
- /* The GCC object. */
- struct gcc_base_context
- {
- /* The virtual table. */
- const struct gcc_base_vtable *ops;
- };
- /* An array of types used for creating function types in multiple
- languages. */
- struct gcc_type_array
- {
- /* Number of elements. */
- int n_elements;
- /* The elements. */
- gcc_type *elements;
- };
- /* The name of the dummy wrapper function generated by gdb. */
- #define GCC_FE_WRAPPER_FUNCTION "_gdb_expr"
- #ifdef __cplusplus
- }
- #endif
- #endif /* GCC_INTERFACE_H */
|