diff options
author | Pedro Alves <palves@redhat.com> | 2017-07-17 20:21:33 +0100 |
---|---|---|
committer | Pedro Alves <palves@redhat.com> | 2017-07-17 20:21:33 +0100 |
commit | c6756f62e04846d68c24ee922ddb0377d4bd17f2 (patch) | |
tree | e46b28cd0cb1ac766d8c086aef72d08aca2709e3 /gdb/completer.c | |
parent | c5bb8910e80c6cd80c63541f86471c18375c8198 (diff) | |
download | gdb-c6756f62e04846d68c24ee922ddb0377d4bd17f2.zip gdb-c6756f62e04846d68c24ee922ddb0377d4bd17f2.tar.gz gdb-c6756f62e04846d68c24ee922ddb0377d4bd17f2.tar.bz2 |
Rewrite/enhance explicit locations completer, parse left->right
One of the most annoying (to me) things about GDB's completion is when
you have overloads in your program, and you want to set a breakpoint
in one of them:
void function(int); // set breakpoint here.
void function(long);
(gdb) b -f func[TAB]
(gdb) b -f function( # ok, gdb completed as much as possible.
(gdb) b -f function([TAB] # show me the overloads, please.
<_all_ symbols in the program are shown...>
E.g., when debugging GDB, that'd be:
(gdb) b -f function([TAB]
(anonymous namespace)::get_global()::global pt_insn_get_offset@plt scm_new_port_table_entry
asprintf pt_pkt_alloc_decoder scm_new_port_table_entry@plt
asprintf@plt pt_pkt_alloc_decoder@plt scm_out_of_range
bt_ctf_get_char_array pt_pkt_sync_forward scm_out_of_range@plt
bt_ctf_get_char_array@plt pt_pkt_sync_forward@plt scm_putc
bt_ctf_get_uint64 pwrite scm_putc@plt
bt_ctf_get_uint64@plt pwrite@plt scm_reverse_x
bt_ctf_iter_read_event PyErr_Restore scm_reverse_x@plt
bt_ctf_iter_read_event@plt PyErr_Restore@plt scm_set_port_filename_x
<snip...>
Now that's a load of completely useless completions.
The reason GDB offers those is that the completer relies on readline
figuring out the completion word point in the input line based on the
language's word break characters, which include "(". So readline
tells the completer to complete on "", the string that is after '('.
Likewise, if you type "function(i[TAB]" to try to complete to "int",
you're out of luck. GDB shows you all the symbols in the program that
start with "i"... This makes sense for the expression completer, as
what you'd want to type is e.g., a global variable, say:
(gdb) print function(i[TAB]
but, it makes no sense when specifying a function name for a
breakpoint location.
To get around that limitation, users need to quote the function name,
like:
(gdb) b -f 'function([TAB]
function(int) function(long)
(gdb) b 'function(i[TAB]
(gdb) b 'function(int)' # now completes correctly!
Note that the quoting is only necessary for completion. Creating the
breakpoint does not require the quoting:
(gdb) b -f function(int) [RET]
Breakpoint 1 at ....
This patch removes this limitation.
(
Actually, it's a necessary patch, though not sufficient. That'll
start working correctly by the end of the series. With this patch, if try it,
you'll see:
(gdb) b -f function(i[TAB]
(gdb) b -f function
i.e., gdb strips everything after the "(". That's caused by some code
in symtab.c that'll be eliminated further down the series. These
patches are all unfortunately interrelated, which is also the reason
new tests only appear much later in the series.
But let's ignore that reality for the remainder of the description.
)
So... this patch gets rid of the need for quoting.
It does that by adding a way for a completer to control the exact
completion word point that readline should start the completion
request for, instead of letting readline try to figure it out using
the current language's word break chars array, and often failing.
In the case above, we want the completer to figure out that it's
completing a function name that starts with "function(i". It now
does.
It took me a while to figure out a way to ask readline to "use this
exact word point", and for a while I feared that it'd be impossible
with current readline (and having to rely on master readline for core
functionality is something I'd like to avoid very much). Eventually,
after several different attempts, I came up with what is described in
the comment above gdb_custom_word_point_brkchars in the patch.
With this patch, the handle_brkchars phase of the explicit location
completer advances the expected word point as it parses the input line
left to right, until it figures out exactly what we're completing,
instead of expecting readline to break the string using the word break
characters, and then having the completer heuristically fix up a bad
decision by parsing the input string backwards. This allows correctly
knowning that we're completing a symbol name after -function, complete
functions without quoting, etc.
Later, we'll make use of this same mechanims to implement a proper
linespec completer that avoids need for quoting too.
gdb/ChangeLog:
2017-07-17 Pedro Alves <palves@redhat.com>
* ada-lang.c (ada_collect_symbol_completion_matches): Add
complete_symbol_mode parameter.
* cli/cli-cmds.c (complete_command): Get the completion result out
of the handle_brkchars tracker if used a custom word point.
* completer.c: Include "linespec.h".
(enum explicit_location_match_type) <MATCH_LINE>: New enumerator.
(advance_to_expression_complete_word_point): New.
(completion_tracker::completes_to_completion_word): New.
(complete_files_symbols): Pass down
complete_symbol_mode::EXPRESSION.
(explicit_options, probe_options): New.
(collect_explicit_location_matches): Complete on the
explictit_loc->foo instead of word. Use
linespec_complete_function. Handle MATCH_LINE. Handle offering
keyword and options completions.
(backup_text_ptr): Delete.
(skip_keyword): New.
(complete_explicit_location): Remove 'word' parameter. Add
language, quoted_arg_start and quoted_arg_end parameters.
Rewrite, parsing left to right.
(location_completer): Rewrite.
(location_completer_handle_brkchars): New function.
(symbol_completer): Pass down complete_symbol_mode::EXPRESSION.
(enum complete_line_internal_reason): Adjust comments.
(completion_tracker::discard_completions): New.
(completer_handle_brkchars_func_for_completer): Handle
location_completer.
(gdb_custom_word_point_brkchars)
(gdb_org_rl_basic_quote_characters): New.
(gdb_completion_word_break_characters_throw)
(completion_find_completion_word): Handle trackers that use a
custom word point.
(completion_tracker::advance_custom_word_point_by): New.
(completion_tracker::build_completion_result): Don't rely on
readline appending the quote char.
(gdb_rl_attempted_completion_function_throw): Handle trackers that
use a custom word point.
(gdb_rl_attempted_completion_function): Restore
rl_basic_quote_characters.
* completer.h (class completion_tracker): Extend intro comment.
(completion_tracker::set_quote_char)
(completion_tracker::quote_char)
(completion_tracker::set_use_custom_word_point)
(completion_tracker::use_custom_word_point)
(completion_tracker::custom_word_point)
(completion_tracker::set_custom_word_point)
(completion_tracker::advance_custom_word_point_by)
(completion_tracker::completes_to_completion_word)
(completion_tracker::discard_completions): New methods.
(completion_tracker::m_quote_char)
(completion_tracker::m_use_custom_word_point)
(completion_tracker::m_custom_word_point): New fields.
(advance_to_expression_complete_word_point): Declare.
* f-lang.c (f_collect_symbol_completion_matches): Add
complete_symbol_mode parameter.
* language.h (struct language_defn)
<la_collect_symbol_completion_matches>: Add complete_symbol_mode
parameter.
* linespec.c (linespec_keywords): Add NULL terminator. Make extern.
(linespec_complete_function): New function.
(linespec_lexer_lex_keyword): Adjust.
* linespec.h (linespec_keywords, linespec_complete_function): New
declarations.
* location.c (find_end_quote): New function.
(explicit_location_lex_one): Add explicit_completion_info
parameter. Save quoting info. Don't throw if being called for
completion. Don't handle Ada operators here.
(is_cp_operator, skip_op_false_positives, first_of)
(explicit_location_lex_one_function): New function.
(string_to_explicit_location): Replace 'dont_throw' parameter with
an explicit_completion_info pointer parameter. Handle it. Don't
use explicit_location_lex_one to lex function names. Use
explicit_location_lex_one_function instead.
* location.h (struct explicit_completion_info): New.
(string_to_explicit_location): Replace 'dont_throw' parameter with
an explicit_completion_info pointer parameter.
* symtab.c (default_collect_symbol_completion_matches_break_on):
Add complete_symbol_mode parameter. Handle LINESPEC mode.
(default_collect_symbol_completion_matches)
(collect_symbol_completion_matches): Add complete_symbol_mode
parameter.
(collect_symbol_completion_matches_type): Pass down
complete_symbol_mode::EXPRESSION.
(collect_file_symbol_completion_matches): Add complete_symbol_mode
parameter. Handle LINESPEC mode.
* symtab.h (complete_symbol_mode): New.
(default_collect_symbol_completion_matches_break_on)
(default_collect_symbol_completion_matches)
(collect_symbol_completion_matches)
(collect_file_symbol_completion_matches): Add complete_symbol_mode
parameter.
gdb/testsuite/ChangeLog:
2017-07-17 Pedro Alves <palves@redhat.com>
* gdb.linespec/ls-errs.exp (do_test): Adjust expected output.
Diffstat (limited to 'gdb/completer.c')
-rw-r--r-- | gdb/completer.c | 568 |
1 files changed, 459 insertions, 109 deletions
diff --git a/gdb/completer.c b/gdb/completer.c index 196610d..1e4fe18 100644 --- a/gdb/completer.c +++ b/gdb/completer.c @@ -29,6 +29,7 @@ #include "arch-utils.h" #include "location.h" #include <algorithm> +#include "linespec.h" #include "cli/cli-decode.h" /* FIXME: This is needed because of lookup_cmd_1 (). We should be @@ -44,6 +45,9 @@ #include "completer.h" +static void complete_expression (completion_tracker &tracker, + const char *text, const char *word); + /* Misc state that needs to be tracked across several different readline completer entry point calls, all related to a single completion invocation. */ @@ -63,8 +67,9 @@ struct gdb_completer_state /* The current completion state. */ static gdb_completer_state current_completion; -/* An enumeration of the various things a user might - attempt to complete for a location. */ +/* An enumeration of the various things a user might attempt to + complete for a location. If you change this, remember to update + the explicit_options array below too. */ enum explicit_location_match_type { @@ -74,6 +79,9 @@ enum explicit_location_match_type /* The name of a function or method. */ MATCH_FUNCTION, + /* A line number. */ + MATCH_LINE, + /* The name of a label. */ MATCH_LABEL }; @@ -366,6 +374,48 @@ gdb_rl_find_completion_word (struct gdb_rl_completion_word_info *info, return line_buffer + point; } +/* See completer.h. */ + +const char * +advance_to_expression_complete_word_point (completion_tracker &tracker, + const char *text) +{ + gdb_rl_completion_word_info info; + + info.word_break_characters + = current_language->la_word_break_characters (); + info.quote_characters = gdb_completer_quote_characters; + info.basic_quote_characters = rl_basic_quote_characters; + + const char *start + = gdb_rl_find_completion_word (&info, NULL, NULL, text); + + tracker.advance_custom_word_point_by (start - text); + + return start; +} + +/* See completer.h. */ + +bool +completion_tracker::completes_to_completion_word (const char *word) +{ + if (m_lowest_common_denominator_unique) + { + const char *lcd = m_lowest_common_denominator; + + if (strncmp_iw (word, lcd, strlen (lcd)) == 0) + { + /* Maybe skip the function and complete on keywords. */ + size_t wordlen = strlen (word); + if (word[wordlen - 1] == ' ') + return true; + } + } + + return false; +} + /* Complete on linespecs, which might be of two possible forms: file:line @@ -450,7 +500,9 @@ complete_files_symbols (completion_tracker &tracker, symbols as well as on files. */ if (colon) { - collect_file_symbol_completion_matches (tracker, symbol_start, word, + collect_file_symbol_completion_matches (tracker, + complete_symbol_mode::EXPRESSION, + symbol_start, word, file_to_match); xfree (file_to_match); } @@ -458,7 +510,9 @@ complete_files_symbols (completion_tracker &tracker, { size_t text_len = strlen (text); - collect_symbol_completion_matches (tracker, symbol_start, word); + collect_symbol_completion_matches (tracker, + complete_symbol_mode::EXPRESSION, + symbol_start, word); /* If text includes characters which cannot appear in a file name, they cannot be asking for completion on files. */ if (strcspn (text, @@ -499,10 +553,32 @@ complete_files_symbols (completion_tracker &tracker, /* No completions at all. As the final resort, try completing on the entire text as a symbol. */ collect_symbol_completion_matches (tracker, + complete_symbol_mode::EXPRESSION, orig_text, word); } } +/* The explicit location options. Note that indexes into this array + must match the explicit_location_match_type enumerators. */ +static const char *const explicit_options[] = + { + "-source", + "-function", + "-line", + "-label", + NULL + }; + +/* The probe modifier options. These can appear before a location in + breakpoint commands. */ +static const char *const probe_options[] = + { + "-probe", + "-probe-stap", + "-probe-dtrace", + NULL + }; + /* Returns STRING if not NULL, the empty string otherwise. */ static const char * @@ -518,18 +594,22 @@ static void collect_explicit_location_matches (completion_tracker &tracker, struct event_location *location, enum explicit_location_match_type what, - const char *word) + const char *word, + const struct language_defn *language) { const struct explicit_location *explicit_loc = get_explicit_location (location); + /* Note, in the various MATCH_* below, we complete on + explicit_loc->foo instead of WORD, because only the former will + have already skipped past any quote char. */ switch (what) { case MATCH_SOURCE: { const char *source = string_or_empty (explicit_loc->source_filename); completion_list matches - = make_source_files_completion_list (source, word); + = make_source_files_completion_list (source, source); tracker.add_completions (std::move (matches)); } break; @@ -537,18 +617,15 @@ collect_explicit_location_matches (completion_tracker &tracker, case MATCH_FUNCTION: { const char *function = string_or_empty (explicit_loc->function_name); - if (explicit_loc->source_filename != NULL) - { - const char *filename = explicit_loc->source_filename; - - collect_file_symbol_completion_matches (tracker, - function, word, filename); - } - else - collect_symbol_completion_matches (tracker, function, word); + linespec_complete_function (tracker, function, + explicit_loc->source_filename); } break; + case MATCH_LINE: + /* Nothing to offer. */ + break; + case MATCH_LABEL: /* Not supported. */ break; @@ -556,126 +633,296 @@ collect_explicit_location_matches (completion_tracker &tracker, default: gdb_assert_not_reached ("unhandled explicit_location_match_type"); } + + if (tracker.completes_to_completion_word (word)) + { + tracker.discard_completions (); + tracker.advance_custom_word_point_by (strlen (word)); + complete_on_enum (tracker, explicit_options, "", ""); + complete_on_enum (tracker, linespec_keywords, "", ""); + } + else if (!tracker.have_completions ()) + { + /* Maybe we have an unterminated linespec keyword at the tail of + the string. Try completing on that. */ + size_t wordlen = strlen (word); + const char *keyword = word + wordlen; + + if (wordlen > 0 && keyword[-1] != ' ') + { + while (keyword > word && *keyword != ' ') + keyword--; + /* Don't complete on keywords if we'd be completing on the + whole explicit linespec option. E.g., "b -function + thr<tab>" should not complete to the "thread" + keyword. */ + if (keyword != word) + { + keyword = skip_spaces_const (keyword); + + tracker.advance_custom_word_point_by (keyword - word); + complete_on_enum (tracker, linespec_keywords, keyword, keyword); + } + } + else if (wordlen > 0 && keyword[-1] == ' ') + { + /* Assume that we're maybe past the explicit location + argument, and we didn't manage to find any match because + the user wants to create a pending breakpoint. Offer the + keyword and explicit location options as possible + completions. */ + tracker.advance_custom_word_point_by (keyword - word); + complete_on_enum (tracker, linespec_keywords, keyword, keyword); + complete_on_enum (tracker, explicit_options, keyword, keyword); + } + } } -/* A convenience macro to (safely) back up P to the previous word. */ +/* If the next word in *TEXT_P is any of the keywords in KEYWORDS, + then advance both TEXT_P and the word point in the tracker past the + keyword and return the (0-based) index in the KEYWORDS array that + matched. Otherwise, return -1. */ -static const char * -backup_text_ptr (const char *p, const char *text) +static int +skip_keyword (completion_tracker &tracker, + const char * const *keywords, const char **text_p) { - while (p > text && isspace (*p)) - --p; - for (; p > text && !isspace (p[-1]); --p) - ; + const char *text = *text_p; + const char *after = skip_to_space_const (text); + size_t len = after - text; + + if (text[len] != ' ') + return -1; + + int found = -1; + for (int i = 0; keywords[i] != NULL; i++) + { + if (strncmp (keywords[i], text, len) == 0) + { + if (found == -1) + found = i; + else + return -1; + } + } + + if (found != -1) + { + tracker.advance_custom_word_point_by (len + 1); + text += len + 1; + *text_p = text; + return found; + } - return p; + return -1; } /* A completer function for explicit locations. This function - completes both options ("-source", "-line", etc) and values. */ + completes both options ("-source", "-line", etc) and values. If + completing a quoted string, then QUOTED_ARG_START and + QUOTED_ARG_END point to the quote characters. LANGUAGE is the + current language. */ static void complete_explicit_location (completion_tracker &tracker, struct event_location *location, - const char *text, const char *word) + const char *text, + const language_defn *language, + const char *quoted_arg_start, + const char *quoted_arg_end) { - const char *p; + if (*text != '-') + return; - /* Find the beginning of the word. This is necessary because - we need to know if we are completing an option name or value. We - don't get the leading '-' from the completer. */ - p = backup_text_ptr (word, text); + int keyword = skip_keyword (tracker, explicit_options, &text); - if (*p == '-') + if (keyword == -1) + complete_on_enum (tracker, explicit_options, text, text); + else { - /* Completing on option name. */ - static const char *const keywords[] = + /* Completing on value. */ + enum explicit_location_match_type what + = (explicit_location_match_type) keyword; + + if (quoted_arg_start != NULL && quoted_arg_end != NULL) { - "source", - "function", - "line", - "label", - NULL - }; + if (quoted_arg_end[1] == '\0') + { + /* If completing a quoted string with the cursor right + at the terminating quote char, complete the + completion word without interpretation, so that + readline advances the cursor one whitespace past the + quote, even if there's no match. This makes these + cases behave the same: + + before: "b -function function()" + after: "b -function function() " + + before: "b -function 'function()'" + after: "b -function 'function()' " + + and trusts the user in this case: + + before: "b -function 'not_loaded_function_yet()'" + after: "b -function 'not_loaded_function_yet()' " + */ + gdb::unique_xmalloc_ptr<char> text_copy + (xstrdup (text)); + tracker.add_completion (std::move (text_copy)); + } + else if (quoted_arg_end[1] == ' ') + { + /* We're maybe past the explicit location argument. + Skip the argument without interpretion, assuming the + user may want to create pending breakpoint. Offer + the keyword and explicit location options as possible + completions. */ + tracker.advance_custom_word_point_by (strlen (text)); + complete_on_enum (tracker, linespec_keywords, "", ""); + complete_on_enum (tracker, explicit_options, "", ""); + } + return; + } - /* Skip over the '-'. */ - ++p; + /* Now gather matches */ + collect_explicit_location_matches (tracker, location, what, text, + language); + } +} - complete_on_enum (tracker, keywords, p, p); - return; +/* A completer for locations. */ + +void +location_completer (struct cmd_list_element *ignore, + completion_tracker &tracker, + const char *text, const char *word_entry) +{ + int found_probe_option = -1; + + /* If we have a probe modifier, skip it. This can only appear as + first argument. Until we have a specific completer for probes, + falling back to the linespec completer for the remainder of the + line is better than nothing. */ + if (text[0] == '-' && text[1] == 'p') + found_probe_option = skip_keyword (tracker, probe_options, &text); + + const char *option_text = text; + int saved_word_point = tracker.custom_word_point (); + + const char *copy = text; + + explicit_completion_info completion_info; + event_location_up location + = string_to_explicit_location (©, current_language, + &completion_info); + if (completion_info.quoted_arg_start != NULL + && completion_info.quoted_arg_end == NULL) + { + /* Found an unbalanced quote. */ + tracker.set_quote_char (*completion_info.quoted_arg_start); + tracker.advance_custom_word_point_by (1); } - else + + if (location != NULL) { - /* Completing on value (or unknown). Get the previous word to see what - the user is completing on. */ - size_t len, offset; - const char *new_word, *end; - enum explicit_location_match_type what; - struct explicit_location *explicit_loc - = get_explicit_location (location); - - /* Backup P to the previous word, which should be the option - the user is attempting to complete. */ - offset = word - p; - end = --p; - p = backup_text_ptr (p, text); - len = end - p; - - if (strncmp (p, "-source", len) == 0) + if (*copy != '\0') { - what = MATCH_SOURCE; - new_word = explicit_loc->source_filename + offset; + tracker.advance_custom_word_point_by (copy - text); + text = copy; + + /* We found a terminator at the tail end of the string, + which means we're past the explicit location options. We + may have a keyword to complete on. If we have a whole + keyword, then complete whatever comes after as an + expression. This is mainly for the "if" keyword. If the + "thread" and "task" keywords gain their own completers, + they should be used here. */ + int keyword = skip_keyword (tracker, linespec_keywords, &text); + + if (keyword == -1) + { + complete_on_enum (tracker, linespec_keywords, text, text); + } + else + { + const char *word + = advance_to_expression_complete_word_point (tracker, text); + complete_expression (tracker, text, word); + } } - else if (strncmp (p, "-function", len) == 0) + else { - what = MATCH_FUNCTION; - new_word = explicit_loc->function_name + offset; + tracker.advance_custom_word_point_by (completion_info.last_option + - text); + text = completion_info.last_option; + + complete_explicit_location (tracker, location.get (), text, + current_language, + completion_info.quoted_arg_start, + completion_info.quoted_arg_end); + } - else if (strncmp (p, "-label", len) == 0) + } + else + { + /* This is an address or linespec location. */ + if (*text == '*') { - what = MATCH_LABEL; - new_word = explicit_loc->label_name + offset; + tracker.advance_custom_word_point_by (1); + text++; + const char *word + = advance_to_expression_complete_word_point (tracker, text); + complete_expression (tracker, text, word); } else { - /* The user isn't completing on any valid option name, - e.g., "break -source foo.c [tab]". */ - return; + /* Fall back to the old linespec completer, for now. */ + + if (word_entry == NULL) + { + /* We're in the handle_brkchars phase. */ + tracker.set_use_custom_word_point (false); + return; + } + + complete_files_symbols (tracker, text, word_entry); } + } - /* If the user hasn't entered a search expression, e.g., - "break -function <TAB><TAB>", new_word will be NULL, but - search routines require non-NULL search words. */ - if (new_word == NULL) - new_word = ""; + /* Add matches for option names, if either: - /* Now gather matches */ - collect_explicit_location_matches (tracker, location, what, new_word); + - Some completer above found some matches, but the word point did + not advance (e.g., "b <tab>" finds all functions, or "b -<tab>" + matches all objc selectors), or; + + - Some completer above advanced the word point, but found no + matches. + */ + if ((text[0] == '-' || text[0] == '\0') + && (!tracker.have_completions () + || tracker.custom_word_point () == saved_word_point)) + { + tracker.set_custom_word_point (saved_word_point); + text = option_text; + + if (found_probe_option == -1) + complete_on_enum (tracker, probe_options, text, text); + complete_on_enum (tracker, explicit_options, text, text); } } -/* A completer for locations. */ +/* The corresponding completer_handle_brkchars + implementation. */ -void -location_completer (struct cmd_list_element *ignore, - completion_tracker &tracker, - const char *text, const char *word) +static void +location_completer_handle_brkchars (struct cmd_list_element *ignore, + completion_tracker &tracker, + const char *text, + const char *word_ignored) { - const char *copy = text; + tracker.set_use_custom_word_point (true); - event_location_up location = string_to_explicit_location (©, - current_language, - 1); - if (location != NULL) - complete_explicit_location (tracker, location.get (), - text, word); - else - { - /* This is an address or linespec location. - Right now both of these are handled by the (old) linespec - completer. */ - complete_files_symbols (tracker, text, word); - } + location_completer (ignore, tracker, text, NULL); } /* Helper for expression_completer which recursively adds field and @@ -837,7 +1084,8 @@ symbol_completer (struct cmd_list_element *ignore, completion_tracker &tracker, const char *text, const char *word) { - collect_symbol_completion_matches (tracker, text, word); + collect_symbol_completion_matches (tracker, complete_symbol_mode::EXPRESSION, + text, word); } /* Here are some useful test cases for completion. FIXME: These @@ -866,10 +1114,24 @@ symbol_completer (struct cmd_list_element *ignore, enum complete_line_internal_reason { /* Preliminary phase, called by gdb_completion_word_break_characters - function, is used to determine the correct set of chars that are - word delimiters depending on the current command in line_buffer. - No completion list should be generated; the return value should - be NULL. This is checked by an assertion. */ + function, is used to either: + + #1 - Determine the set of chars that are word delimiters + depending on the current command in line_buffer. + + #2 - Manually advance RL_POINT to the "word break" point instead + of letting readline do it (based on too-simple character + matching). + + Simpler completers that just pass a brkchars array to readline + (#1 above) must defer generating the completions to the main + phase (below). No completion list should be generated in this + phase. + + OTOH, completers that manually advance the word point(#2 above) + must set "use_custom_word_point" in the tracker and generate + their completion in this phase. Note that this is the convenient + thing to do since they'll be parsing the input line anyway. */ handle_brkchars, /* Main phase, called by complete_line function, is used to get the @@ -1003,6 +1265,8 @@ complete_line_internal_1 (completion_tracker &tracker, p++; } + tracker.advance_custom_word_point_by (p - tmp_command); + if (!c) { /* It is an unrecognized command. So there are no @@ -1184,6 +1448,24 @@ completion_tracker::completion_tracker () /* See completer.h. */ +void +completion_tracker::discard_completions () +{ + xfree (m_lowest_common_denominator); + m_lowest_common_denominator = NULL; + + m_lowest_common_denominator_unique = false; + + m_entries_vec.clear (); + + htab_delete (m_entries_hash); + m_entries_hash = htab_create_alloc (INITIAL_COMPLETION_HTAB_SIZE, + htab_hash_string, (htab_eq) streq, + NULL, xcalloc, xfree); +} + +/* See completer.h. */ + completion_tracker::~completion_tracker () { xfree (m_lowest_common_denominator); @@ -1412,12 +1694,27 @@ completer_handle_brkchars_func_for_completer (completer_ftype *fn) if (fn == filename_completer) return filename_completer_handle_brkchars; + if (fn == location_completer) + return location_completer_handle_brkchars; + if (fn == command_completer) return command_completer_handle_brkchars; return default_completer_handle_brkchars; } +/* Used as brkchars when we want to tell readline we have a custom + word point. We do that by making our rl_completion_word_break_hook + set RL_POINT to the desired word point, and return the character at + the word break point as the break char. This is two bytes in order + to fit one break character plus the terminating null. */ +static char gdb_custom_word_point_brkchars[2]; + +/* Since rl_basic_quote_characters is not completer-specific, we save + its original value here, in order to be able to restore it in + gdb_rl_attempted_completion_function. */ +static const char *gdb_org_rl_basic_quote_characters = rl_basic_quote_characters; + /* Get the list of chars that are considered as word breaks for the current command. */ @@ -1434,6 +1731,27 @@ gdb_completion_word_break_characters_throw () complete_line_internal (tracker, NULL, rl_line_buffer, rl_point, handle_brkchars); + if (tracker.use_custom_word_point ()) + { + gdb_assert (tracker.custom_word_point () > 0); + rl_point = tracker.custom_word_point () - 1; + gdb_custom_word_point_brkchars[0] = rl_line_buffer[rl_point]; + rl_completer_word_break_characters = gdb_custom_word_point_brkchars; + rl_completer_quote_characters = NULL; + + /* Clear this too, so that if we're completing a quoted string, + readline doesn't consider the quote character a delimiter. + If we didn't do this, readline would auto-complete {b + 'fun<tab>} to {'b 'function()'}, i.e., add the terminating + \', but, it wouldn't append the separator space either, which + is not desirable. So instead we take care of appending the + quote character to the LCD ourselves, in + gdb_rl_attempted_completion_function. Since this global is + not just completer-specific, we'll restore it back to the + default in gdb_rl_attempted_completion_function. */ + rl_basic_quote_characters = NULL; + } + return rl_completer_word_break_characters; } @@ -1468,6 +1786,13 @@ completion_find_completion_word (completion_tracker &tracker, const char *text, complete_line_internal (tracker, NULL, text, point, handle_brkchars); + if (tracker.use_custom_word_point ()) + { + gdb_assert (tracker.custom_word_point () > 0); + *quote_char = tracker.quote_char (); + return text + tracker.custom_word_point (); + } + gdb_rl_completion_word_info info; info.word_break_characters = rl_completer_word_break_characters; @@ -1509,6 +1834,14 @@ completion_tracker::recompute_lowest_common_denominator (const char *new_match) } } +/* See completer.h. */ + +void +completion_tracker::advance_custom_word_point_by (size_t len) +{ + m_custom_word_point += len; +} + /* Build a new C string that is a copy of LCD with the whitespace of ORIG/ORIG_LEN preserved. @@ -1596,6 +1929,13 @@ completion_tracker::build_completion_result (const char *text, if (m_lowest_common_denominator_unique) { + /* We don't rely on readline appending the quote char as + delimiter as then readline wouldn't append the ' ' after the + completion. */ + char buf[2] = { quote_char () }; + + match_list[0] = reconcat (match_list[0], match_list[0], + buf, (char *) NULL); match_list[1] = NULL; /* If we already have a space at the end of the match, tell @@ -1728,14 +2068,20 @@ completion_result::reset_match_list () static char ** gdb_rl_attempted_completion_function_throw (const char *text, int start, int end) { - /* Completers must be called twice. If rl_point (i.e., END) is at - column 0, then readline skips the the handle_brkchars phase, and - so we create a tracker now in that case too. */ - delete current_completion.tracker; - current_completion.tracker = new completion_tracker (); + /* Completers that provide a custom word point in the + handle_brkchars phase also compute their completions then. + Completers that leave the completion word handling to readline + must be called twice. If rl_point (i.e., END) is at column 0, + then readline skips the handle_brkchars phase, and so we create a + tracker now in that case too. */ + if (end == 0 || !current_completion.tracker->use_custom_word_point ()) + { + delete current_completion.tracker; + current_completion.tracker = new completion_tracker (); - complete_line (*current_completion.tracker, text, - rl_line_buffer, rl_point); + complete_line (*current_completion.tracker, text, + rl_line_buffer, rl_point); + } completion_tracker &tracker = *current_completion.tracker; @@ -1753,6 +2099,10 @@ gdb_rl_attempted_completion_function_throw (const char *text, int start, int end char ** gdb_rl_attempted_completion_function (const char *text, int start, int end) { + /* Restore globals that might have been tweaked in + gdb_completion_word_break_characters. */ + rl_basic_quote_characters = gdb_org_rl_basic_quote_characters; + /* If we end up returning NULL, either on error, or simple because there are no matches, inhibit readline's default filename completer. */ |