/* Interface between gdb and its extension languages.
- Copyright (C) 2014 Free Software Foundation, Inc.
+ Copyright (C) 2014-2018 Free Software Foundation, Inc.
This file is part of GDB.
#define EXTENSION_H
#include "mi/mi-cmds.h" /* For PRINT_NO_VALUES, etc. */
+#include "common/vec.h"
struct breakpoint;
struct command_line;
(const struct extension_language_defn *,
struct objfile *, FILE *stream, const char *filename);
+/* A function to execute a script for an objfile.
+ Any exceptions are not caught, and are passed to the caller. */
+typedef void objfile_script_executor_func
+ (const struct extension_language_defn *,
+ struct objfile *, const char *name, const char *script);
+
/* Enum of each extension(/scripting) language. */
enum extension_language
{
EXT_LANG_NONE,
EXT_LANG_GDB,
- EXT_LANG_PYTHON
+ EXT_LANG_PYTHON,
+ EXT_LANG_GUILE
};
/* Extension language frame-filter status return values. */
/* Type-printers from Python. */
void *py_type_printers;
};
-\f
+
+/* The return code for some API calls. */
+
+enum ext_lang_rc
+{
+ /* The operation completed successfully. */
+ EXT_LANG_RC_OK,
+
+ /* The operation was not performed (e.g., no pretty-printer). */
+ EXT_LANG_RC_NOP,
+
+ /* There was an error (e.g., Python error while printing a value).
+ When an error occurs no further extension languages are tried.
+ This is to preserve existing behaviour, and because it's convenient
+ for Python developers.
+ Note: This is different than encountering a memory error trying to read
+ a value for pretty-printing. Here we're referring to, e.g., programming
+ errors that trigger an exception in the extension language. */
+ EXT_LANG_RC_ERROR
+};
+
+/* A type which holds its extension language specific xmethod worker data. */
+
+struct xmethod_worker
+{
+ xmethod_worker (const extension_language_defn *extlang)
+ : m_extlang (extlang)
+ {}
+
+ virtual ~xmethod_worker () = default;
+
+ /* Invoke the xmethod encapsulated in this worker and return the result.
+ The method is invoked on OBJ with arguments in the ARGS array. NARGS is
+ the length of the this array. */
+
+ virtual value *invoke (value *obj, value **args, int nargs) = 0;
+
+ /* Return the arg types of the xmethod encapsulated in this worker.
+ An array of arg types is returned. The length of the array is returned in
+ NARGS. The type of the 'this' object is returned as the first element of
+ array. */
+
+ type **get_arg_types (int *nargs);
+
+ /* Return the type of the result of the xmethod encapsulated in this worker.
+ OBJECT, ARGS, NARGS are the same as for invoke. */
+
+ type *get_result_type (value *object, value **args, int nargs);
+
+private:
+
+ /* Return the types of the arguments the method takes. The number of
+ arguments is returned in NARGS, and their types are returned in the array
+ ARGTYPES. */
+
+ virtual enum ext_lang_rc do_get_arg_types
+ (int *nargs, struct type ***arg_types) = 0;
+
+ /* Fetch the type of the result of the method implemented by this worker.
+ OBJECT, ARGS, NARGS are the same as for the invoked method. The result
+ type is stored in *RESULT_TYPE. */
+
+ virtual enum ext_lang_rc do_get_result_type
+ (struct value *obj, struct value **args, int nargs,
+ struct type **result_type_ptr) = 0;
+
+ /* The language the xmethod worker is implemented in. */
+
+ const extension_language_defn *m_extlang;
+};
+
+typedef std::unique_ptr<xmethod_worker> xmethod_worker_up;
+
/* The interface for gdb's own extension(/scripting) language. */
extern const struct extension_language_defn extension_language_gdb;
extern objfile_script_sourcer_func *ext_lang_objfile_script_sourcer
(const struct extension_language_defn *);
+extern objfile_script_executor_func *ext_lang_objfile_script_executor
+ (const struct extension_language_defn *);
+
extern int ext_lang_auto_load_enabled (const struct extension_language_defn *);
/* Wrappers for each extension language API function that iterate over all
extern void free_ext_lang_type_printers (struct ext_lang_type_printers *);
extern int apply_ext_lang_val_pretty_printer
- (struct type *type, const gdb_byte *valaddr,
- int embedded_offset, CORE_ADDR address,
+ (struct type *type,
+ LONGEST embedded_offset, CORE_ADDR address,
struct ui_file *stream, int recurse,
- const struct value *val, const struct value_print_options *options,
+ struct value *val, const struct value_print_options *options,
const struct language_defn *language);
extern enum ext_lang_bt_status apply_ext_lang_frame_filter
extern int breakpoint_ext_lang_cond_says_stop (struct breakpoint *);
+/* If a method with name METHOD_NAME is to be invoked on an object of type
+ TYPE, then all extension languages are searched for implementations of
+ methods with name METHOD_NAME. All matches found are appended to the WORKERS
+ vector. */
+
+extern void get_matching_xmethod_workers
+ (struct type *type, const char *method_name,
+ std::vector<xmethod_worker_up> *workers);
+
#endif /* EXTENSION_H */
projects / binutils-gdb.git / blobdiff