OpenE2K/binutils-gdb
12
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
6eb1e6a8c1
binutils-gdb/gdb/cp-abi.c
Pedro Alves eb3ff9a551 Introduce class completion_tracker & rewrite completion<->readline interaction 
This patch reworks the whole completion machinery, and prepares it
for later enhancements.

Adds a new "completion_tracker" class that is meant to hold everything
about the state of the current completion operation.

This class now has the responsibility of tracking the list of
completion matches, and checking whether the max completions limit has
been reached.  You can look at this as this patch starting out by
C++fying the existing "completion_tracker" in symtab.c (it's just an
htab_t typedef currently), moving it to completer.h/c, and then making
it a class/generalizing/enhancing it.

Unlike with the current tracking, completion_tracker now checks
whether the limit has been reached on each completion match list
insertion.  This both simplifies the max-completions handling code
(maybe_add_completion_enum is gone, for example), and is a
prerequisite for follow up patches.

The current completion_tracker is only used for symbol completions,
and the symbol code gets at the current instance via globals.  This
patch cleans that up by adding a completion_tracker reference to the
signature of the completion functions, and passing the tracker around
everywhere necessary.

Then, the patch changes how the completion match list is handed over
to readline.  Currently, we're using the rl_completion_entry_function
readline entry point, and the patch switches to
rl_attempted_completion_function.  A following patch will want to let
GDB itself decide the common completion prefix between all matches
(what readline calls the "lowest common denominator"), instead of
having readline compute it, and that's not possible with the
rl_completion_entry_function entry point.  Also,
rl_attempted_completion_function lets GDB hand over the match list to
readline as an array in one go instead of passing down matches one by
one, so from that angle it's a nicer entry point anyway.

Lastly, the patch catches exceptions around the readline entry points,
because we can't let C++ exceptions cross readline.  We handle that in
the readline input entry point, but the completion entry point isn't
guarded, so GDB can abort if completion throws.  E.g., in current
master:

 (gdb) b -function "fun<tab>
 terminate called after throwing an instance of 'gdb_exception_RETURN_MASK_ERROR'
 Aborted (core dumped)

This patch fixes that.  This will be exercised in the new tests added
later on in the series.

gdb/ChangeLog:
2017-07-17  Pedro Alves  <palves@redhat.com>

	* ada-lang.c (symbol_completion_match): Adjust comments.
	(symbol_completion_add): Replace vector parameter with
	completion_tracker parameter.  Use it.
	(ada_make_symbol_completion_list): Rename to...
	(ada_collect_symbol_completion_matches): ... this.  Add
	completion_tracker parameter and use it.
	(ada_language_defn): Adjust.
	* break-catch-syscall.c (catch_syscall_completer): Adjust
	prototype and work with completion_tracker instead of VEC.
	* breakpoint.c (condition_completer): Adjust prototype and work
	with completion_tracker instead of VEC.
	* c-lang.c (c_language_defn, cplus_language_defn)
	(asm_language_defn, minimal_language_defn): Adjust to renames.
	* cli/cli-cmds.c (complete_command): Rework using
	completion_tracker.  Catch exceptions when completing.
	* cli/cli-decode.c (integer_unlimited_completer)
	(complete_on_cmdlist, complete_on_enum): Adjust prototype and work
	with completion_tracker instead of VEC.
	* command.h (struct completion_tracker): Forward declare.
	(completer_ftype, completer_handle_brkchars_ftype): Change
	types.
	(complete_on_cmdlist, complete_on_enum): Adjust.
	* completer.c: Include <algorithm>.
	(struct gdb_completer_state): New.
	(current_completion): New global.
	(readline_line_completion_function): Delete.
	(noop_completer, filename_completer)
	(filename_completer_handle_brkchars, complete_files_symbols)
	(linespec_location_completer): Adjust to work with a
	completion_tracker instead of a VEC.
	(string_or_empty): New.
	(collect_explicit_location_matches): Adjust to work with a
	completion_tracker instead of a VEC.
	(explicit_location_completer): Rename to ...
	(complete_explicit_location): ... this and adjust to work with a
	completion_tracker instead of a VEC.
	(location_completer): Adjust to work with a completion_tracker
	instead of a VEC.
	(add_struct_fields): Adjust to work with a completion_list instead
	of VEC.
	(expression_completer): Rename to ...
	(complete_expression): ... this and adjust to work with a
	completion_tracker instead of a VEC.  Use complete_files_symbols.
	(expression_completer): Reimplement on top of complete_expression.
	(symbol_completer): Adjust to work with a completion_tracker
	instead of a VEC.
	(enum complete_line_internal_reason): Add describing comments.
	(complete_line_internal_normal_command): Adjust to work with a
	completion_tracker instead of a VEC.
	(complete_line_internal): Rename to ...
	(complete_line_internal_1): ... this and adjust to work with a
	completion_tracker instead of a VEC.  Assert TEXT is NULL in the
	handle_brkchars phase.
	(new_completion_tracker): Delete.
	(complete_line_internal): Reimplement as TRY/CATCH wrapper around
	complete_line_internal_1.
	(free_completion_tracker): Delete.
	(INITIAL_COMPLETION_HTAB_SIZE): New.
	(completion_tracker::completion_tracker)
	(completion_tracker::~completion_tracker): New.
	(maybe_add_completion): Delete.
	(completion_tracker::maybe_add_completion)
	(completion_tracker::add_completion)
	(completion_tracker::add_completions): New.
	(throw_max_completions_reached_error): Delete.
	(complete_line): Adjust to work with a completion_tracker instead
	of a VEC.  Don't create a completion_tracker_t or check for max
	completions here.
	(command_completer, command_completer_handle_brkchars)
	(signal_completer, reg_or_group_completer_1)
	(reg_or_group_completer, default_completer_handle_brkchars):
	Adjust to work with a completion_tracker.
	(gdb_completion_word_break_characters_throw): New.
	(gdb_completion_word_break_characters): Reimplement.
	(line_completion_function): Delete.
	(completion_tracker::recompute_lowest_common_denominator)
	(expand_preserving_ws)
	(completion_tracker::build_completion_result)
	(completion_result::completion_result)
	(completion_result::completion_result)
	(completion_result::~completion_result)
	(completion_result::completion_result)
	(completion_result::release_match_list, compare_cstrings)
	(completion_result::sort_match_list)
	(completion_result::reset_match_list)
	(gdb_rl_attempted_completion_function_throw)
	(gdb_rl_attempted_completion_function): New.
	* completer.h (completion_list, struct completion_result)
	(class completion_tracker): New.
	(complete_line): Add completion_tracker parameter.
	(readline_line_completion_function): Delete.
	(gdb_rl_attempted_completion_function): New.
	(noop_completer, filename_completer, expression_completer)
	(location_completer, symbol_completer, command_completer)
	(signal_completer, reg_or_group_completer): Update prototypes.
	(completion_tracker_t, new_completion_tracker)
	(make_cleanup_free_completion_tracker): Delete.
	(enum maybe_add_completion_enum): Delete.
	(maybe_add_completion): Delete.
	(throw_max_completions_reached_error): Delete.
	* corefile.c (complete_set_gnutarget): Adjust to work with a
	completion_tracker instead of a VEC.
	* cp-abi.c (cp_abi_completer): Adjust to work with a
	completion_tracker instead of a VEC.
	* d-lang.c (d_language_defn): Adjust.
	* disasm.c (disassembler_options_completer): Adjust to work with a
	completion_tracker instead of a VEC.
	* f-lang.c (f_make_symbol_completion_list): Rename to ...
	(f_collect_symbol_completion_matches): ... this.  Adjust to work
	with a completion_tracker instead of a VEC.
	(f_language_defn): Adjust.
	* go-lang.c (go_language_defn): Adjust.
	* guile/scm-cmd.c (cmdscm_add_completion, cmdscm_completer):
	Adjust to work with a completion_tracker instead of a VEC.
	* infrun.c (handle_completer): Likewise.
	* interps.c (interpreter_completer): Likewise.
	* interps.h (interpreter_completer): Likewise.
	* language.c (unknown_language_defn, auto_language_defn)
	(local_language_defn): Adjust.
	* language.h (language_defn::la_make_symbol_completion_list):
	Rename to ...
	(language_defn::la_collect_symbol_completion_matches): ... this
	and adjust to work with a completion_tracker instead of a VEC.
	* m2-lang.c (m2_language_defn): Adjust.
	* objc-lang.c (objc_language_defn): Adjust.
	* opencl-lang.c (opencl_language_defn): Adjust.
	* p-lang.c (pascal_language_defn): Adjust.
	* python/py-cmd.c (cmdpy_completer_helper): Handle NULL word.
	(cmdpy_completer_handle_brkchars, cmdpy_completer): Adjust to work
	with a completion_tracker.
	* rust-lang.c (rust_language_defn): Adjust.
	* symtab.c (free_completion_list, do_free_completion_list)
	(return_val, completion_tracker): Delete.
	(completion_list_add_name, completion_list_add_symbol)
	(completion_list_add_msymbol, completion_list_objc_symbol)
	(completion_list_add_fields, add_symtab_completions): Add
	completion_tracker parameter and use it.
	(default_make_symbol_completion_list_break_on_1): Rename to...
	(default_collect_symbol_completion_matches_break_on): ... this.
	Add completion_tracker parameter and use it instead of allocating
	a completion tracker here.
	(default_make_symbol_completion_list_break_on): Delete old
	implementation.
	(default_make_symbol_completion_list): Delete.
	(default_collect_symbol_completion_matches): New.
	(make_symbol_completion_list): Delete.
	(collect_symbol_completion_matches): New.
	(make_symbol_completion_type): Rename to ...
	(collect_symbol_completion_matches_type): ... this.  Add
	completion_tracker parameter and use it instead of VEC.
	(make_file_symbol_completion_list_1): Rename to...
	(collect_file_symbol_completion_matches): ... this.  Add
	completion_tracker parameter and use it instead of VEC.
	(make_file_symbol_completion_list): Delete.
	(add_filename_to_list): Use completion_list instead of a VEC.
	(add_partial_filename_data::list): Now a completion_list.
	(make_source_files_completion_list): Work with a completion_list
	instead of a VEC.
	* symtab.h: Include "completer.h".
	(default_make_symbol_completion_list_break_on)
	(default_make_symbol_completion_list, make_symbol_completion_list)
	(make_symbol_completion_type, make_file_symbol_completion_list)
	(make_source_files_completion_list): Delete.
	(default_collect_symbol_completion_matches_break_on)
	(default_collect_symbol_completion_matches)
	(collect_symbol_completion_matches)
	(collect_symbol_completion_matches_type)
	(collect_file_symbol_completion_matches)
	(make_source_files_completion_list): New.
	* top.c (init_main): Don't install a rl_completion_entry_function
	hook.  Install a rl_attempted_completion_function hook instead.
	* tui/tui-layout.c (layout_completer): Adjust to work with a
	completion_tracker.
	* tui/tui-regs.c (tui_reggroup_completer):
	* tui/tui-win.c (window_name_completer, focus_completer)
	(winheight_completer): Adjust to work with a completion_tracker.
	* value.c: Include "completer.h".
	(complete_internalvar): Adjust to work with a completion_tracker.
	* value.h (complete_internalvar): Likewise.
2017-07-17 14:45:59 +01:00

413 lines
10 KiB
C
Raw Blame History

/* Generic code for supporting multiple C++ ABI's
Copyright (C) 2001-2017 Free Software Foundation, Inc.
This file is part of GDB.
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/>. */
#include "defs.h"
#include "value.h"
#include "cp-abi.h"
#include "command.h"
#include "gdbcmd.h"
#include "ui-out.h"
static struct cp_abi_ops *find_cp_abi (const char *short_name);
static struct cp_abi_ops current_cp_abi = { "", NULL };
static struct cp_abi_ops auto_cp_abi = { "auto", NULL };
#define CP_ABI_MAX 8
static struct cp_abi_ops *cp_abis[CP_ABI_MAX];
static int num_cp_abis = 0;
enum ctor_kinds
is_constructor_name (const char *name)
{
if ((current_cp_abi.is_constructor_name) == NULL)
error (_("ABI doesn't define required function is_constructor_name"));
return (*current_cp_abi.is_constructor_name) (name);
}
enum dtor_kinds
is_destructor_name (const char *name)
{
if ((current_cp_abi.is_destructor_name) == NULL)
error (_("ABI doesn't define required function is_destructor_name"));
return (*current_cp_abi.is_destructor_name) (name);
}
int
is_vtable_name (const char *name)
{
if ((current_cp_abi.is_vtable_name) == NULL)
error (_("ABI doesn't define required function is_vtable_name"));
return (*current_cp_abi.is_vtable_name) (name);
}
int
is_operator_name (const char *name)
{
if ((current_cp_abi.is_operator_name) == NULL)
error (_("ABI doesn't define required function is_operator_name"));
return (*current_cp_abi.is_operator_name) (name);
}
int
baseclass_offset (struct type *type, int index, const gdb_byte *valaddr,
LONGEST embedded_offset, CORE_ADDR address,
const struct value *val)
{
int res = 0;
gdb_assert (current_cp_abi.baseclass_offset != NULL);
TRY
{
res = (*current_cp_abi.baseclass_offset) (type, index, valaddr,
embedded_offset,
address, val);
}
CATCH (ex, RETURN_MASK_ERROR)
{
if (ex.error != NOT_AVAILABLE_ERROR)
throw_exception (ex);
throw_error (NOT_AVAILABLE_ERROR,
_("Cannot determine virtual baseclass offset "
"of incomplete object"));
}
END_CATCH
return res;
}
struct value *
value_virtual_fn_field (struct value **arg1p,
struct fn_field *f, int j,
struct type *type, int offset)
{
if ((current_cp_abi.virtual_fn_field) == NULL)
return NULL;
return (*current_cp_abi.virtual_fn_field) (arg1p, f, j,
type, offset);
}
struct type *
value_rtti_type (struct value *v, int *full,
LONGEST *top, int *using_enc)
{
struct type *ret = NULL;
if ((current_cp_abi.rtti_type) == NULL)
return NULL;
TRY
{
ret = (*current_cp_abi.rtti_type) (v, full, top, using_enc);
}
CATCH (e, RETURN_MASK_ERROR)
{
return NULL;
}
END_CATCH
return ret;
}
void
cplus_print_method_ptr (const gdb_byte *contents,
struct type *type,
struct ui_file *stream)
{
if (current_cp_abi.print_method_ptr == NULL)
error (_("GDB does not support pointers to methods on this target"));
(*current_cp_abi.print_method_ptr) (contents, type, stream);
}
int
cplus_method_ptr_size (struct type *to_type)
{
if (current_cp_abi.method_ptr_size == NULL)
error (_("GDB does not support pointers to methods on this target"));
return (*current_cp_abi.method_ptr_size) (to_type);
}
void
cplus_make_method_ptr (struct type *type, gdb_byte *contents,
CORE_ADDR value, int is_virtual)
{
if (current_cp_abi.make_method_ptr == NULL)
error (_("GDB does not support pointers to methods on this target"));
(*current_cp_abi.make_method_ptr) (type, contents, value, is_virtual);
}
CORE_ADDR
cplus_skip_trampoline (struct frame_info *frame,
CORE_ADDR stop_pc)
{
if (current_cp_abi.skip_trampoline == NULL)
return 0;
return (*current_cp_abi.skip_trampoline) (frame, stop_pc);
}
struct value *
cplus_method_ptr_to_value (struct value **this_p,
struct value *method_ptr)
{
if (current_cp_abi.method_ptr_to_value == NULL)
error (_("GDB does not support pointers to methods on this target"));
return (*current_cp_abi.method_ptr_to_value) (this_p, method_ptr);
}
/* See cp-abi.h. */
void
cplus_print_vtable (struct value *value)
{
if (current_cp_abi.print_vtable == NULL)
error (_("GDB cannot print the vtable on this target"));
(*current_cp_abi.print_vtable) (value);
}
/* See cp-abi.h. */
struct value *
cplus_typeid (struct value *value)
{
if (current_cp_abi.get_typeid == NULL)
error (_("GDB cannot find the typeid on this target"));
return (*current_cp_abi.get_typeid) (value);
}
/* See cp-abi.h. */
struct type *
cplus_typeid_type (struct gdbarch *gdbarch)
{
if (current_cp_abi.get_typeid_type == NULL)
error (_("GDB cannot find the type for 'typeid' on this target"));
return (*current_cp_abi.get_typeid_type) (gdbarch);
}
/* See cp-abi.h. */
struct type *
cplus_type_from_type_info (struct value *value)
{
if (current_cp_abi.get_type_from_type_info == NULL)
error (_("GDB cannot find the type from a std::type_info on this target"));
return (*current_cp_abi.get_type_from_type_info) (value);
}
/* See cp-abi.h. */
std::string
cplus_typename_from_type_info (struct value *value)
{
if (current_cp_abi.get_typename_from_type_info == NULL)
error (_("GDB cannot find the type name "
"from a std::type_info on this target"));
return (*current_cp_abi.get_typename_from_type_info) (value);
}
int
cp_pass_by_reference (struct type *type)
{
if ((current_cp_abi.pass_by_reference) == NULL)
return 0;
return (*current_cp_abi.pass_by_reference) (type);
}
/* Set the current C++ ABI to SHORT_NAME. */
static int
switch_to_cp_abi (const char *short_name)
{
struct cp_abi_ops *abi;
abi = find_cp_abi (short_name);
if (abi == NULL)
return 0;
current_cp_abi = *abi;
return 1;
}
/* Add ABI to the list of supported C++ ABI's. */
int
register_cp_abi (struct cp_abi_ops *abi)
{
if (num_cp_abis == CP_ABI_MAX)
internal_error (__FILE__, __LINE__,
_("Too many C++ ABIs, please increase "
"CP_ABI_MAX in cp-abi.c"));
cp_abis[num_cp_abis++] = abi;
return 1;
}
/* Set the ABI to use in "auto" mode to SHORT_NAME. */
void
set_cp_abi_as_auto_default (const char *short_name)
{
char *new_longname, *new_doc;
struct cp_abi_ops *abi = find_cp_abi (short_name);
if (abi == NULL)
internal_error (__FILE__, __LINE__,
_("Cannot find C++ ABI \"%s\" to set it as auto default."),
short_name);
if (auto_cp_abi.longname != NULL)
xfree ((char *) auto_cp_abi.longname);
if (auto_cp_abi.doc != NULL)
xfree ((char *) auto_cp_abi.doc);
auto_cp_abi = *abi;
auto_cp_abi.shortname = "auto";
new_longname = xstrprintf ("currently \"%s\"", abi->shortname);
auto_cp_abi.longname = new_longname;
new_doc = xstrprintf ("Automatically selected; currently \"%s\"",
abi->shortname);
auto_cp_abi.doc = new_doc;
/* Since we copy the current ABI into current_cp_abi instead of
using a pointer, if auto is currently the default, we need to
reset it. */
if (strcmp (current_cp_abi.shortname, "auto") == 0)
switch_to_cp_abi ("auto");
}
/* Return the ABI operations associated with SHORT_NAME. */
static struct cp_abi_ops *
find_cp_abi (const char *short_name)
{
int i;
for (i = 0; i < num_cp_abis; i++)
if (strcmp (cp_abis[i]->shortname, short_name) == 0)
return cp_abis[i];
return NULL;
}
/* Display the list of registered C++ ABIs. */
static void
list_cp_abis (int from_tty)
{
struct ui_out *uiout = current_uiout;
int i;
uiout->text ("The available C++ ABIs are:\n");
ui_out_emit_tuple tuple_emitter (uiout, "cp-abi-list");
for (i = 0; i < num_cp_abis; i++)
{
char pad[14];
int padcount;
uiout->text (" ");
uiout->field_string ("cp-abi", cp_abis[i]->shortname);
padcount = 16 - 2 - strlen (cp_abis[i]->shortname);
pad[padcount] = 0;
while (padcount > 0)
pad[--padcount] = ' ';
uiout->text (pad);
uiout->field_string ("doc", cp_abis[i]->doc);
uiout->text ("\n");
}
}
/* Set the current C++ ABI, or display the list of options if no
argument is given. */
static void
set_cp_abi_cmd (char *args, int from_tty)
{
if (args == NULL)
{
list_cp_abis (from_tty);
return;
}
if (!switch_to_cp_abi (args))
error (_("Could not find \"%s\" in ABI list"), args);
}
/* A completion function for "set cp-abi". */
static void
cp_abi_completer (struct cmd_list_element *ignore,
completion_tracker &tracker,
const char *text, const char *word)
{
static const char **cp_abi_names;
if (cp_abi_names == NULL)
{
int i;
cp_abi_names = XNEWVEC (const char *, num_cp_abis + 1);
for (i = 0; i < num_cp_abis; ++i)
cp_abi_names[i] = cp_abis[i]->shortname;
cp_abi_names[i] = NULL;
}
complete_on_enum (tracker, cp_abi_names, text, word);
}
/* Show the currently selected C++ ABI. */
static void
show_cp_abi_cmd (char *args, int from_tty)
{
struct ui_out *uiout = current_uiout;
uiout->text ("The currently selected C++ ABI is \"");
uiout->field_string ("cp-abi", current_cp_abi.shortname);
uiout->text ("\" (");
uiout->field_string ("longname", current_cp_abi.longname);
uiout->text (").\n");
}
extern initialize_file_ftype _initialize_cp_abi; /* -Wmissing-prototypes */
void
_initialize_cp_abi (void)
{
struct cmd_list_element *c;
register_cp_abi (&auto_cp_abi);
switch_to_cp_abi ("auto");
c = add_cmd ("cp-abi", class_obscure, set_cp_abi_cmd, _("\
Set the ABI used for inspecting C++ objects.\n\
\"set cp-abi\" with no arguments will list the available ABIs."),
&setlist);
set_cmd_completer (c, cp_abi_completer);
add_cmd ("cp-abi", class_obscure, show_cp_abi_cmd,
_("Show the ABI used for inspecting C++ objects."),
&showlist);
}
Reference in New Issue View Git Blame Copy Permalink