1 /* Line completion stuff for GDB, the GNU debugger.
2 Copyright (C) 2000-2017 Free Software Foundation, Inc.
4 This file is part of GDB.
6 This program 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 of the License, or
9 (at your option) any later version.
11 This program 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 this program. If not, see <http://www.gnu.org/licenses/>. */
22 #include "expression.h"
23 #include "filenames.h" /* For DOSish file names. */
25 #include "gdb_signals.h"
27 #include "reggroups.h"
28 #include "user-regs.h"
29 #include "arch-utils.h"
33 #include "cli/cli-decode.h"
35 /* FIXME: This is needed because of lookup_cmd_1 (). We should be
36 calling a hook instead so we eliminate the CLI dependency. */
39 /* Needed for rl_completer_word_break_characters() and for
40 rl_filename_completion_function. */
41 #include "readline/readline.h"
43 /* readline defines this. */
46 #include "completer.h"
48 static void complete_expression (completion_tracker &tracker,
49 const char *text, const char *word);
51 /* Misc state that needs to be tracked across several different
52 readline completer entry point calls, all related to a single
53 completion invocation. */
55 struct gdb_completer_state
57 /* The current completion's completion tracker. This is a global
58 because a tracker can be shared between the handle_brkchars and
59 handle_completion phases, which involves different readline
61 completion_tracker *tracker = NULL;
63 /* Whether the current completion was aborted. */
67 /* The current completion state. */
68 static gdb_completer_state current_completion;
70 /* An enumeration of the various things a user might attempt to
71 complete for a location. If you change this, remember to update
72 the explicit_options array below too. */
74 enum explicit_location_match_type
76 /* The filename of a source file. */
79 /* The name of a function or method. */
85 /* The name of a label. */
89 /* Prototypes for local functions. */
91 /* readline uses the word breaks for two things:
92 (1) In figuring out where to point the TEXT parameter to the
93 rl_completion_entry_function. Since we don't use TEXT for much,
94 it doesn't matter a lot what the word breaks are for this purpose,
95 but it does affect how much stuff M-? lists.
96 (2) If one of the matches contains a word break character, readline
97 will quote it. That's why we switch between
98 current_language->la_word_break_characters() and
99 gdb_completer_command_word_break_characters. I'm not sure when
100 we need this behavior (perhaps for funky characters in C++
103 /* Variables which are necessary for fancy command line editing. */
105 /* When completing on command names, we remove '-' from the list of
106 word break characters, since we use it in command names. If the
107 readline library sees one in any of the current completion strings,
108 it thinks that the string needs to be quoted and automatically
109 supplies a leading quote. */
110 static const char gdb_completer_command_word_break_characters[] =
111 " \t\n!@#$%^&*()+=|~`}{[]\"';:?/>.<,";
113 /* When completing on file names, we remove from the list of word
114 break characters any characters that are commonly used in file
115 names, such as '-', '+', '~', etc. Otherwise, readline displays
116 incorrect completion candidates. */
117 /* MS-DOS and MS-Windows use colon as part of the drive spec, and most
118 programs support @foo style response files. */
119 static const char gdb_completer_file_name_break_characters[] =
120 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
126 /* Characters that can be used to quote completion strings. Note that
127 we can't include '"' because the gdb C parser treats such quoted
128 sequences as strings. */
129 static const char gdb_completer_quote_characters[] = "'";
131 /* Accessor for some completer data that may interest other files. */
134 get_gdb_completer_quote_characters (void)
136 return gdb_completer_quote_characters;
139 /* This can be used for functions which don't want to complete on
140 symbols but don't want to complete on anything else either. */
143 noop_completer (struct cmd_list_element *ignore,
144 completion_tracker &tracker,
145 const char *text, const char *prefix)
149 /* Complete on filenames. */
152 filename_completer (struct cmd_list_element *ignore,
153 completion_tracker &tracker,
154 const char *text, const char *word)
157 VEC (char_ptr) *return_val = NULL;
164 p = rl_filename_completion_function (text, subsequent_name);
167 /* We need to set subsequent_name to a non-zero value before the
168 continue line below, because otherwise, if the first file
169 seen by GDB is a backup file whose name ends in a `~', we
170 will loop indefinitely. */
172 /* Like emacs, don't complete on old versions. Especially
173 useful in the "source" command. */
174 if (p[strlen (p) - 1] == '~')
181 /* Return exactly p. */
183 else if (word > text)
185 /* Return some portion of p. */
186 q = (char *) xmalloc (strlen (p) + 5);
187 strcpy (q, p + (word - text));
192 /* Return some of TEXT plus p. */
193 q = (char *) xmalloc (strlen (p) + (text - word) + 5);
194 strncpy (q, word, text - word);
195 q[text - word] = '\0';
199 tracker.add_completion (gdb::unique_xmalloc_ptr<char> (q));
202 /* There is no way to do this just long enough to affect quote
203 inserting without also affecting the next completion. This
204 should be fixed in readline. FIXME. */
205 /* Ensure that readline does the right thing
206 with respect to inserting quotes. */
207 rl_completer_word_break_characters = "";
211 /* The corresponding completer_handle_brkchars
215 filename_completer_handle_brkchars (struct cmd_list_element *ignore,
216 completion_tracker &tracker,
217 const char *text, const char *word)
219 set_rl_completer_word_break_characters
220 (gdb_completer_file_name_break_characters);
223 /* Possible values for the found_quote flags word used by the completion
224 functions. It says what kind of (shell-like) quoting we found anywhere
226 #define RL_QF_SINGLE_QUOTE 0x01
227 #define RL_QF_DOUBLE_QUOTE 0x02
228 #define RL_QF_BACKSLASH 0x04
229 #define RL_QF_OTHER_QUOTE 0x08
231 /* Find the bounds of the current word for completion purposes, and
232 return a pointer to the end of the word. This mimics (and is a
233 modified version of) readline's _rl_find_completion_word internal
236 This function skips quoted substrings (characters between matched
237 pairs of characters in rl_completer_quote_characters). We try to
238 find an unclosed quoted substring on which to do matching. If one
239 is not found, we use the word break characters to find the
240 boundaries of the current word. QC, if non-null, is set to the
241 opening quote character if we found an unclosed quoted substring,
242 '\0' otherwise. DP, if non-null, is set to the value of the
243 delimiter character that caused a word break. */
245 struct gdb_rl_completion_word_info
247 const char *word_break_characters;
248 const char *quote_characters;
249 const char *basic_quote_characters;
253 gdb_rl_find_completion_word (struct gdb_rl_completion_word_info *info,
255 const char *line_buffer)
257 int scan, end, found_quote, delimiter, pass_next, isbrk;
259 const char *brkchars;
260 int point = strlen (line_buffer);
262 /* The algorithm below does '--point'. Avoid buffer underflow with
274 found_quote = delimiter = 0;
277 brkchars = info->word_break_characters;
279 if (info->quote_characters != NULL)
281 /* We have a list of characters which can be used in pairs to
282 quote substrings for the completer. Try to find the start of
283 an unclosed quoted substring. */
284 /* FOUND_QUOTE is set so we know what kind of quotes we
286 for (scan = pass_next = 0;
296 /* Shell-like semantics for single quotes -- don't allow
297 backslash to quote anything in single quotes, especially
298 not the closing quote. If you don't like this, take out
299 the check on the value of quote_char. */
300 if (quote_char != '\'' && line_buffer[scan] == '\\')
303 found_quote |= RL_QF_BACKSLASH;
307 if (quote_char != '\0')
309 /* Ignore everything until the matching close quote
311 if (line_buffer[scan] == quote_char)
313 /* Found matching close. Abandon this
319 else if (strchr (info->quote_characters, line_buffer[scan]))
321 /* Found start of a quoted substring. */
322 quote_char = line_buffer[scan];
324 /* Shell-like quoting conventions. */
325 if (quote_char == '\'')
326 found_quote |= RL_QF_SINGLE_QUOTE;
327 else if (quote_char == '"')
328 found_quote |= RL_QF_DOUBLE_QUOTE;
330 found_quote |= RL_QF_OTHER_QUOTE;
335 if (point == end && quote_char == '\0')
337 /* We didn't find an unclosed quoted substring upon which to do
338 completion, so use the word break characters to find the
339 substring on which to complete. */
342 scan = line_buffer[point];
344 if (strchr (brkchars, scan) != 0)
349 /* If we are at an unquoted word break, then advance past it. */
350 scan = line_buffer[point];
354 isbrk = strchr (brkchars, scan) != 0;
358 /* If the character that caused the word break was a quoting
359 character, then remember it as the delimiter. */
360 if (info->basic_quote_characters
361 && strchr (info->basic_quote_characters, scan)
362 && (end - point) > 1)
374 return line_buffer + point;
377 /* See completer.h. */
380 advance_to_expression_complete_word_point (completion_tracker &tracker,
383 gdb_rl_completion_word_info info;
385 info.word_break_characters
386 = current_language->la_word_break_characters ();
387 info.quote_characters = gdb_completer_quote_characters;
388 info.basic_quote_characters = rl_basic_quote_characters;
391 = gdb_rl_find_completion_word (&info, NULL, NULL, text);
393 tracker.advance_custom_word_point_by (start - text);
398 /* See completer.h. */
401 completion_tracker::completes_to_completion_word (const char *word)
403 if (m_lowest_common_denominator_unique)
405 const char *lcd = m_lowest_common_denominator;
407 if (strncmp_iw (word, lcd, strlen (lcd)) == 0)
409 /* Maybe skip the function and complete on keywords. */
410 size_t wordlen = strlen (word);
411 if (word[wordlen - 1] == ' ')
419 /* Complete on linespecs, which might be of two possible forms:
425 This is intended to be used in commands that set breakpoints
429 complete_files_symbols (completion_tracker &tracker,
430 const char *text, const char *word)
433 completion_list fn_list;
436 int quoted = *text == '\'' || *text == '"';
437 int quote_char = '\0';
438 const char *colon = NULL;
439 char *file_to_match = NULL;
440 const char *symbol_start = text;
441 const char *orig_text = text;
443 /* Do we have an unquoted colon, as in "break foo.c:bar"? */
444 for (p = text; *p != '\0'; ++p)
446 if (*p == '\\' && p[1] == '\'')
448 else if (*p == '\'' || *p == '"')
452 while (*p != '\0' && *p != quote_found)
454 if (*p == '\\' && p[1] == quote_found)
459 if (*p == quote_found)
462 break; /* Hit the end of text. */
464 #if HAVE_DOS_BASED_FILE_SYSTEM
465 /* If we have a DOS-style absolute file name at the beginning of
466 TEXT, and the colon after the drive letter is the only colon
467 we found, pretend the colon is not there. */
468 else if (p < text + 3 && *p == ':' && p == text + 1 + quoted)
471 else if (*p == ':' && !colon)
474 symbol_start = p + 1;
476 else if (strchr (current_language->la_word_break_characters(), *p))
477 symbol_start = p + 1;
483 /* Where is the file name? */
488 file_to_match = (char *) xmalloc (colon - text + 1);
489 strncpy (file_to_match, text, colon - text);
490 file_to_match[colon - text] = '\0';
491 /* Remove trailing colons and quotes from the file name. */
492 for (s = file_to_match + (colon - text);
495 if (*s == ':' || *s == quote_char)
498 /* If the text includes a colon, they want completion only on a
499 symbol name after the colon. Otherwise, we need to complete on
500 symbols as well as on files. */
503 collect_file_symbol_completion_matches (tracker,
504 complete_symbol_mode::EXPRESSION,
507 xfree (file_to_match);
511 size_t text_len = strlen (text);
513 collect_symbol_completion_matches (tracker,
514 complete_symbol_mode::EXPRESSION,
516 /* If text includes characters which cannot appear in a file
517 name, they cannot be asking for completion on files. */
519 gdb_completer_file_name_break_characters) == text_len)
520 fn_list = make_source_files_completion_list (text, text);
523 if (!fn_list.empty () && !tracker.have_completions ())
527 /* If we only have file names as possible completion, we should
528 bring them in sync with what rl_complete expects. The
529 problem is that if the user types "break /foo/b TAB", and the
530 possible completions are "/foo/bar" and "/foo/baz"
531 rl_complete expects us to return "bar" and "baz", without the
532 leading directories, as possible completions, because `word'
533 starts at the "b". But we ignore the value of `word' when we
534 call make_source_files_completion_list above (because that
535 would not DTRT when the completion results in both symbols
536 and file names), so make_source_files_completion_list returns
537 the full "/foo/bar" and "/foo/baz" strings. This produces
538 wrong results when, e.g., there's only one possible
539 completion, because rl_complete will prepend "/foo/" to each
540 candidate completion. The loop below removes that leading
542 for (const auto &fn_up: fn_list)
544 char *fn = fn_up.get ();
545 memmove (fn, fn + (word - text), strlen (fn) + 1 - (word - text));
549 tracker.add_completions (std::move (fn_list));
551 if (!tracker.have_completions ())
553 /* No completions at all. As the final resort, try completing
554 on the entire text as a symbol. */
555 collect_symbol_completion_matches (tracker,
556 complete_symbol_mode::EXPRESSION,
561 /* The explicit location options. Note that indexes into this array
562 must match the explicit_location_match_type enumerators. */
563 static const char *const explicit_options[] =
572 /* The probe modifier options. These can appear before a location in
573 breakpoint commands. */
574 static const char *const probe_options[] =
582 /* Returns STRING if not NULL, the empty string otherwise. */
585 string_or_empty (const char *string)
587 return string != NULL ? string : "";
590 /* A helper function to collect explicit location matches for the given
591 LOCATION, which is attempting to match on WORD. */
594 collect_explicit_location_matches (completion_tracker &tracker,
595 struct event_location *location,
596 enum explicit_location_match_type what,
598 const struct language_defn *language)
600 const struct explicit_location *explicit_loc
601 = get_explicit_location (location);
603 /* Note, in the various MATCH_* below, we complete on
604 explicit_loc->foo instead of WORD, because only the former will
605 have already skipped past any quote char. */
610 const char *source = string_or_empty (explicit_loc->source_filename);
611 completion_list matches
612 = make_source_files_completion_list (source, source);
613 tracker.add_completions (std::move (matches));
619 const char *function = string_or_empty (explicit_loc->function_name);
620 linespec_complete_function (tracker, function,
621 explicit_loc->source_filename);
626 /* Nothing to offer. */
631 const char *label = string_or_empty (explicit_loc->label_name);
632 linespec_complete_label (tracker, language,
633 explicit_loc->source_filename,
634 explicit_loc->function_name,
640 gdb_assert_not_reached ("unhandled explicit_location_match_type");
643 if (tracker.completes_to_completion_word (word))
645 tracker.discard_completions ();
646 tracker.advance_custom_word_point_by (strlen (word));
647 complete_on_enum (tracker, explicit_options, "", "");
648 complete_on_enum (tracker, linespec_keywords, "", "");
650 else if (!tracker.have_completions ())
652 /* Maybe we have an unterminated linespec keyword at the tail of
653 the string. Try completing on that. */
654 size_t wordlen = strlen (word);
655 const char *keyword = word + wordlen;
657 if (wordlen > 0 && keyword[-1] != ' ')
659 while (keyword > word && *keyword != ' ')
661 /* Don't complete on keywords if we'd be completing on the
662 whole explicit linespec option. E.g., "b -function
663 thr<tab>" should not complete to the "thread"
667 keyword = skip_spaces_const (keyword);
669 tracker.advance_custom_word_point_by (keyword - word);
670 complete_on_enum (tracker, linespec_keywords, keyword, keyword);
673 else if (wordlen > 0 && keyword[-1] == ' ')
675 /* Assume that we're maybe past the explicit location
676 argument, and we didn't manage to find any match because
677 the user wants to create a pending breakpoint. Offer the
678 keyword and explicit location options as possible
680 tracker.advance_custom_word_point_by (keyword - word);
681 complete_on_enum (tracker, linespec_keywords, keyword, keyword);
682 complete_on_enum (tracker, explicit_options, keyword, keyword);
687 /* If the next word in *TEXT_P is any of the keywords in KEYWORDS,
688 then advance both TEXT_P and the word point in the tracker past the
689 keyword and return the (0-based) index in the KEYWORDS array that
690 matched. Otherwise, return -1. */
693 skip_keyword (completion_tracker &tracker,
694 const char * const *keywords, const char **text_p)
696 const char *text = *text_p;
697 const char *after = skip_to_space_const (text);
698 size_t len = after - text;
700 if (text[len] != ' ')
704 for (int i = 0; keywords[i] != NULL; i++)
706 if (strncmp (keywords[i], text, len) == 0)
717 tracker.advance_custom_word_point_by (len + 1);
726 /* A completer function for explicit locations. This function
727 completes both options ("-source", "-line", etc) and values. If
728 completing a quoted string, then QUOTED_ARG_START and
729 QUOTED_ARG_END point to the quote characters. LANGUAGE is the
733 complete_explicit_location (completion_tracker &tracker,
734 struct event_location *location,
736 const language_defn *language,
737 const char *quoted_arg_start,
738 const char *quoted_arg_end)
743 int keyword = skip_keyword (tracker, explicit_options, &text);
746 complete_on_enum (tracker, explicit_options, text, text);
749 /* Completing on value. */
750 enum explicit_location_match_type what
751 = (explicit_location_match_type) keyword;
753 if (quoted_arg_start != NULL && quoted_arg_end != NULL)
755 if (quoted_arg_end[1] == '\0')
757 /* If completing a quoted string with the cursor right
758 at the terminating quote char, complete the
759 completion word without interpretation, so that
760 readline advances the cursor one whitespace past the
761 quote, even if there's no match. This makes these
762 cases behave the same:
764 before: "b -function function()"
765 after: "b -function function() "
767 before: "b -function 'function()'"
768 after: "b -function 'function()' "
770 and trusts the user in this case:
772 before: "b -function 'not_loaded_function_yet()'"
773 after: "b -function 'not_loaded_function_yet()' "
775 gdb::unique_xmalloc_ptr<char> text_copy
777 tracker.add_completion (std::move (text_copy));
779 else if (quoted_arg_end[1] == ' ')
781 /* We're maybe past the explicit location argument.
782 Skip the argument without interpretion, assuming the
783 user may want to create pending breakpoint. Offer
784 the keyword and explicit location options as possible
786 tracker.advance_custom_word_point_by (strlen (text));
787 complete_on_enum (tracker, linespec_keywords, "", "");
788 complete_on_enum (tracker, explicit_options, "", "");
793 /* Now gather matches */
794 collect_explicit_location_matches (tracker, location, what, text,
799 /* A completer for locations. */
802 location_completer (struct cmd_list_element *ignore,
803 completion_tracker &tracker,
804 const char *text, const char *word_entry)
806 int found_probe_option = -1;
808 /* If we have a probe modifier, skip it. This can only appear as
809 first argument. Until we have a specific completer for probes,
810 falling back to the linespec completer for the remainder of the
811 line is better than nothing. */
812 if (text[0] == '-' && text[1] == 'p')
813 found_probe_option = skip_keyword (tracker, probe_options, &text);
815 const char *option_text = text;
816 int saved_word_point = tracker.custom_word_point ();
818 const char *copy = text;
820 explicit_completion_info completion_info;
821 event_location_up location
822 = string_to_explicit_location (©, current_language,
824 if (completion_info.quoted_arg_start != NULL
825 && completion_info.quoted_arg_end == NULL)
827 /* Found an unbalanced quote. */
828 tracker.set_quote_char (*completion_info.quoted_arg_start);
829 tracker.advance_custom_word_point_by (1);
832 if (location != NULL)
836 tracker.advance_custom_word_point_by (copy - text);
839 /* We found a terminator at the tail end of the string,
840 which means we're past the explicit location options. We
841 may have a keyword to complete on. If we have a whole
842 keyword, then complete whatever comes after as an
843 expression. This is mainly for the "if" keyword. If the
844 "thread" and "task" keywords gain their own completers,
845 they should be used here. */
846 int keyword = skip_keyword (tracker, linespec_keywords, &text);
850 complete_on_enum (tracker, linespec_keywords, text, text);
855 = advance_to_expression_complete_word_point (tracker, text);
856 complete_expression (tracker, text, word);
861 tracker.advance_custom_word_point_by (completion_info.last_option
863 text = completion_info.last_option;
865 complete_explicit_location (tracker, location.get (), text,
867 completion_info.quoted_arg_start,
868 completion_info.quoted_arg_end);
874 /* This is an address or linespec location. */
877 tracker.advance_custom_word_point_by (1);
880 = advance_to_expression_complete_word_point (tracker, text);
881 complete_expression (tracker, text, word);
885 /* Fall back to the old linespec completer, for now. */
887 if (word_entry == NULL)
889 /* We're in the handle_brkchars phase. */
890 tracker.set_use_custom_word_point (false);
894 complete_files_symbols (tracker, text, word_entry);
898 /* Add matches for option names, if either:
900 - Some completer above found some matches, but the word point did
901 not advance (e.g., "b <tab>" finds all functions, or "b -<tab>"
902 matches all objc selectors), or;
904 - Some completer above advanced the word point, but found no
907 if ((text[0] == '-' || text[0] == '\0')
908 && (!tracker.have_completions ()
909 || tracker.custom_word_point () == saved_word_point))
911 tracker.set_custom_word_point (saved_word_point);
914 if (found_probe_option == -1)
915 complete_on_enum (tracker, probe_options, text, text);
916 complete_on_enum (tracker, explicit_options, text, text);
920 /* The corresponding completer_handle_brkchars
924 location_completer_handle_brkchars (struct cmd_list_element *ignore,
925 completion_tracker &tracker,
927 const char *word_ignored)
929 tracker.set_use_custom_word_point (true);
931 location_completer (ignore, tracker, text, NULL);
934 /* Helper for expression_completer which recursively adds field and
935 method names from TYPE, a struct or union type, to the OUTPUT
939 add_struct_fields (struct type *type, completion_list &output,
940 char *fieldname, int namelen)
943 int computed_type_name = 0;
944 const char *type_name = NULL;
946 type = check_typedef (type);
947 for (i = 0; i < TYPE_NFIELDS (type); ++i)
949 if (i < TYPE_N_BASECLASSES (type))
950 add_struct_fields (TYPE_BASECLASS (type, i),
951 output, fieldname, namelen);
952 else if (TYPE_FIELD_NAME (type, i))
954 if (TYPE_FIELD_NAME (type, i)[0] != '\0')
956 if (! strncmp (TYPE_FIELD_NAME (type, i),
958 output.emplace_back (xstrdup (TYPE_FIELD_NAME (type, i)));
960 else if (TYPE_CODE (TYPE_FIELD_TYPE (type, i)) == TYPE_CODE_UNION)
962 /* Recurse into anonymous unions. */
963 add_struct_fields (TYPE_FIELD_TYPE (type, i),
964 output, fieldname, namelen);
969 for (i = TYPE_NFN_FIELDS (type) - 1; i >= 0; --i)
971 const char *name = TYPE_FN_FIELDLIST_NAME (type, i);
973 if (name && ! strncmp (name, fieldname, namelen))
975 if (!computed_type_name)
977 type_name = type_name_no_tag (type);
978 computed_type_name = 1;
980 /* Omit constructors from the completion list. */
981 if (!type_name || strcmp (type_name, name))
982 output.emplace_back (xstrdup (name));
987 /* Complete on expressions. Often this means completing on symbol
988 names, but some language parsers also have support for completing
992 complete_expression (completion_tracker &tracker,
993 const char *text, const char *word)
995 struct type *type = NULL;
997 enum type_code code = TYPE_CODE_UNDEF;
999 /* Perform a tentative parse of the expression, to see whether a
1000 field completion is required. */
1004 type = parse_expression_for_completion (text, &fieldname, &code);
1006 CATCH (except, RETURN_MASK_ERROR)
1012 if (fieldname && type)
1016 type = check_typedef (type);
1017 if (TYPE_CODE (type) != TYPE_CODE_PTR && !TYPE_IS_REFERENCE (type))
1019 type = TYPE_TARGET_TYPE (type);
1022 if (TYPE_CODE (type) == TYPE_CODE_UNION
1023 || TYPE_CODE (type) == TYPE_CODE_STRUCT)
1025 int flen = strlen (fieldname);
1026 completion_list result;
1028 add_struct_fields (type, result, fieldname, flen);
1030 tracker.add_completions (std::move (result));
1034 else if (fieldname && code != TYPE_CODE_UNDEF)
1036 VEC (char_ptr) *result;
1037 struct cleanup *cleanup = make_cleanup (xfree, fieldname);
1039 collect_symbol_completion_matches_type (tracker, fieldname, fieldname,
1041 do_cleanups (cleanup);
1046 complete_files_symbols (tracker, text, word);
1049 /* Complete on expressions. Often this means completing on symbol
1050 names, but some language parsers also have support for completing
1054 expression_completer (struct cmd_list_element *ignore,
1055 completion_tracker &tracker,
1056 const char *text, const char *word)
1058 complete_expression (tracker, text, word);
1061 /* See definition in completer.h. */
1064 set_rl_completer_word_break_characters (const char *break_chars)
1066 rl_completer_word_break_characters = (char *) break_chars;
1069 /* See definition in completer.h. */
1072 set_gdb_completion_word_break_characters (completer_ftype *fn)
1074 const char *break_chars;
1076 /* So far we are only interested in differentiating filename
1077 completers from everything else. */
1078 if (fn == filename_completer)
1079 break_chars = gdb_completer_file_name_break_characters;
1081 break_chars = gdb_completer_command_word_break_characters;
1083 set_rl_completer_word_break_characters (break_chars);
1086 /* Complete on symbols. */
1089 symbol_completer (struct cmd_list_element *ignore,
1090 completion_tracker &tracker,
1091 const char *text, const char *word)
1093 collect_symbol_completion_matches (tracker, complete_symbol_mode::EXPRESSION,
1097 /* Here are some useful test cases for completion. FIXME: These
1098 should be put in the test suite. They should be tested with both
1101 "show output-" "radix"
1102 "show output" "-radix"
1103 "p" ambiguous (commands starting with p--path, print, printf, etc.)
1104 "p " ambiguous (all symbols)
1105 "info t foo" no completions
1106 "info t " no completions
1107 "info t" ambiguous ("info target", "info terminal", etc.)
1108 "info ajksdlfk" no completions
1109 "info ajksdlfk " no completions
1111 "info " ambiguous (all info commands)
1112 "p \"a" no completions (string constant)
1113 "p 'a" ambiguous (all symbols starting with a)
1114 "p b-a" ambiguous (all symbols starting with a)
1115 "p b-" ambiguous (all symbols)
1116 "file Make" "file" (word break hard to screw up here)
1117 "file ../gdb.stabs/we" "ird" (needs to not break word at slash)
1120 enum complete_line_internal_reason
1122 /* Preliminary phase, called by gdb_completion_word_break_characters
1123 function, is used to either:
1125 #1 - Determine the set of chars that are word delimiters
1126 depending on the current command in line_buffer.
1128 #2 - Manually advance RL_POINT to the "word break" point instead
1129 of letting readline do it (based on too-simple character
1132 Simpler completers that just pass a brkchars array to readline
1133 (#1 above) must defer generating the completions to the main
1134 phase (below). No completion list should be generated in this
1137 OTOH, completers that manually advance the word point(#2 above)
1138 must set "use_custom_word_point" in the tracker and generate
1139 their completion in this phase. Note that this is the convenient
1140 thing to do since they'll be parsing the input line anyway. */
1143 /* Main phase, called by complete_line function, is used to get the
1144 list of possible completions. */
1147 /* Special case when completing a 'help' command. In this case,
1148 once sub-command completions are exhausted, we simply return
1153 /* Helper for complete_line_internal to simplify it. */
1156 complete_line_internal_normal_command (completion_tracker &tracker,
1157 const char *command, const char *word,
1158 const char *cmd_args,
1159 complete_line_internal_reason reason,
1160 struct cmd_list_element *c)
1162 const char *p = cmd_args;
1164 if (c->completer == filename_completer)
1166 /* Many commands which want to complete on file names accept
1167 several file names, as in "run foo bar >>baz". So we don't
1168 want to complete the entire text after the command, just the
1169 last word. To this end, we need to find the beginning of the
1170 file name by starting at `word' and going backwards. */
1173 && strchr (gdb_completer_file_name_break_characters,
1179 if (reason == handle_brkchars)
1181 completer_handle_brkchars_ftype *brkchars_fn;
1183 if (c->completer_handle_brkchars != NULL)
1184 brkchars_fn = c->completer_handle_brkchars;
1188 = (completer_handle_brkchars_func_for_completer
1192 brkchars_fn (c, tracker, p, word);
1195 if (reason != handle_brkchars && c->completer != NULL)
1196 (*c->completer) (c, tracker, p, word);
1199 /* Internal function used to handle completions.
1202 TEXT is the caller's idea of the "word" we are looking at.
1204 LINE_BUFFER is available to be looked at; it contains the entire
1205 text of the line. POINT is the offset in that line of the cursor.
1206 You should pretend that the line ends at POINT.
1208 See complete_line_internal_reason for description of REASON. */
1211 complete_line_internal_1 (completion_tracker &tracker,
1213 const char *line_buffer, int point,
1214 complete_line_internal_reason reason)
1218 int ignore_help_classes;
1219 /* Pointer within tmp_command which corresponds to text. */
1221 struct cmd_list_element *c, *result_list;
1223 /* Choose the default set of word break characters to break
1224 completions. If we later find out that we are doing completions
1225 on command strings (as opposed to strings supplied by the
1226 individual command completer functions, which can be any string)
1227 then we will switch to the special word break set for command
1228 strings, which leaves out the '-' character used in some
1230 set_rl_completer_word_break_characters
1231 (current_language->la_word_break_characters());
1233 /* Decide whether to complete on a list of gdb commands or on
1235 tmp_command = (char *) alloca (point + 1);
1238 /* The help command should complete help aliases. */
1239 ignore_help_classes = reason != handle_help;
1241 strncpy (tmp_command, line_buffer, point);
1242 tmp_command[point] = '\0';
1243 if (reason == handle_brkchars)
1245 gdb_assert (text == NULL);
1250 /* Since text always contains some number of characters leading up
1251 to point, we can find the equivalent position in tmp_command
1252 by subtracting that many characters from the end of tmp_command. */
1253 word = tmp_command + point - strlen (text);
1258 /* An empty line we want to consider ambiguous; that is, it
1259 could be any command. */
1260 c = CMD_LIST_AMBIGUOUS;
1265 c = lookup_cmd_1 (&p, cmdlist, &result_list, ignore_help_classes);
1268 /* Move p up to the next interesting thing. */
1269 while (*p == ' ' || *p == '\t')
1274 tracker.advance_custom_word_point_by (p - tmp_command);
1278 /* It is an unrecognized command. So there are no
1279 possible completions. */
1281 else if (c == CMD_LIST_AMBIGUOUS)
1285 /* lookup_cmd_1 advances p up to the first ambiguous thing, but
1286 doesn't advance over that thing itself. Do so now. */
1288 while (*q && (isalnum (*q) || *q == '-' || *q == '_'))
1290 if (q != tmp_command + point)
1292 /* There is something beyond the ambiguous
1293 command, so there are no possible completions. For
1294 example, "info t " or "info t foo" does not complete
1295 to anything, because "info t" can be "info target" or
1300 /* We're trying to complete on the command which was ambiguous.
1301 This we can deal with. */
1304 if (reason != handle_brkchars)
1305 complete_on_cmdlist (*result_list->prefixlist, tracker, p,
1306 word, ignore_help_classes);
1310 if (reason != handle_brkchars)
1311 complete_on_cmdlist (cmdlist, tracker, p, word,
1312 ignore_help_classes);
1314 /* Ensure that readline does the right thing with respect to
1315 inserting quotes. */
1316 set_rl_completer_word_break_characters
1317 (gdb_completer_command_word_break_characters);
1322 /* We've recognized a full command. */
1324 if (p == tmp_command + point)
1326 /* There is no non-whitespace in the line beyond the
1329 if (p[-1] == ' ' || p[-1] == '\t')
1331 /* The command is followed by whitespace; we need to
1332 complete on whatever comes after command. */
1335 /* It is a prefix command; what comes after it is
1336 a subcommand (e.g. "info "). */
1337 if (reason != handle_brkchars)
1338 complete_on_cmdlist (*c->prefixlist, tracker, p, word,
1339 ignore_help_classes);
1341 /* Ensure that readline does the right thing
1342 with respect to inserting quotes. */
1343 set_rl_completer_word_break_characters
1344 (gdb_completer_command_word_break_characters);
1346 else if (reason == handle_help)
1350 if (reason != handle_brkchars)
1351 complete_on_enum (tracker, c->enums, p, word);
1352 set_rl_completer_word_break_characters
1353 (gdb_completer_command_word_break_characters);
1357 /* It is a normal command; what comes after it is
1358 completed by the command's completer function. */
1359 complete_line_internal_normal_command (tracker,
1360 tmp_command, word, p,
1366 /* The command is not followed by whitespace; we need to
1367 complete on the command itself, e.g. "p" which is a
1368 command itself but also can complete to "print", "ptype"
1372 /* Find the command we are completing on. */
1374 while (q > tmp_command)
1376 if (isalnum (q[-1]) || q[-1] == '-' || q[-1] == '_')
1382 if (reason != handle_brkchars)
1383 complete_on_cmdlist (result_list, tracker, q, word,
1384 ignore_help_classes);
1386 /* Ensure that readline does the right thing
1387 with respect to inserting quotes. */
1388 set_rl_completer_word_break_characters
1389 (gdb_completer_command_word_break_characters);
1392 else if (reason == handle_help)
1396 /* There is non-whitespace beyond the command. */
1398 if (c->prefixlist && !c->allow_unknown)
1400 /* It is an unrecognized subcommand of a prefix command,
1401 e.g. "info adsfkdj". */
1405 if (reason != handle_brkchars)
1406 complete_on_enum (tracker, c->enums, p, word);
1410 /* It is a normal command. */
1411 complete_line_internal_normal_command (tracker,
1412 tmp_command, word, p,
1419 /* Wrapper around complete_line_internal_1 to handle
1420 MAX_COMPLETIONS_REACHED_ERROR. */
1423 complete_line_internal (completion_tracker &tracker,
1425 const char *line_buffer, int point,
1426 complete_line_internal_reason reason)
1430 complete_line_internal_1 (tracker, text, line_buffer, point, reason);
1432 CATCH (except, RETURN_MASK_ERROR)
1434 if (except.error != MAX_COMPLETIONS_REACHED_ERROR)
1435 throw_exception (except);
1439 /* See completer.h. */
1441 int max_completions = 200;
1443 /* Initial size of the table. It automagically grows from here. */
1444 #define INITIAL_COMPLETION_HTAB_SIZE 200
1446 /* See completer.h. */
1448 completion_tracker::completion_tracker ()
1450 m_entries_hash = htab_create_alloc (INITIAL_COMPLETION_HTAB_SIZE,
1451 htab_hash_string, (htab_eq) streq,
1452 NULL, xcalloc, xfree);
1455 /* See completer.h. */
1458 completion_tracker::discard_completions ()
1460 xfree (m_lowest_common_denominator);
1461 m_lowest_common_denominator = NULL;
1463 m_lowest_common_denominator_unique = false;
1465 m_entries_vec.clear ();
1467 htab_delete (m_entries_hash);
1468 m_entries_hash = htab_create_alloc (INITIAL_COMPLETION_HTAB_SIZE,
1469 htab_hash_string, (htab_eq) streq,
1470 NULL, xcalloc, xfree);
1473 /* See completer.h. */
1475 completion_tracker::~completion_tracker ()
1477 xfree (m_lowest_common_denominator);
1478 htab_delete (m_entries_hash);
1481 /* See completer.h. */
1484 completion_tracker::maybe_add_completion (gdb::unique_xmalloc_ptr<char> name)
1488 if (max_completions == 0)
1491 if (htab_elements (m_entries_hash) >= max_completions)
1494 slot = htab_find_slot (m_entries_hash, name.get (), INSERT);
1495 if (*slot == HTAB_EMPTY_ENTRY)
1497 const char *match_for_lcd_str = name.get ();
1499 recompute_lowest_common_denominator (match_for_lcd_str);
1501 *slot = name.get ();
1502 m_entries_vec.push_back (std::move (name));
1508 /* See completer.h. */
1511 completion_tracker::add_completion (gdb::unique_xmalloc_ptr<char> name)
1513 if (!maybe_add_completion (std::move (name)))
1514 throw_error (MAX_COMPLETIONS_REACHED_ERROR, _("Max completions reached."));
1517 /* See completer.h. */
1520 completion_tracker::add_completions (completion_list &&list)
1522 for (auto &candidate : list)
1523 add_completion (std::move (candidate));
1526 /* Generate completions all at once. Does nothing if max_completions
1527 is 0. If max_completions is non-negative, this will collect at
1528 most max_completions strings.
1530 TEXT is the caller's idea of the "word" we are looking at.
1532 LINE_BUFFER is available to be looked at; it contains the entire
1535 POINT is the offset in that line of the cursor. You
1536 should pretend that the line ends at POINT. */
1539 complete_line (completion_tracker &tracker,
1540 const char *text, const char *line_buffer, int point)
1542 if (max_completions == 0)
1544 complete_line_internal (tracker, text, line_buffer, point,
1545 handle_completions);
1548 /* Complete on command names. Used by "help". */
1551 command_completer (struct cmd_list_element *ignore,
1552 completion_tracker &tracker,
1553 const char *text, const char *word)
1555 complete_line_internal (tracker, word, text,
1556 strlen (text), handle_help);
1559 /* The corresponding completer_handle_brkchars implementation. */
1562 command_completer_handle_brkchars (struct cmd_list_element *ignore,
1563 completion_tracker &tracker,
1564 const char *text, const char *word)
1566 set_rl_completer_word_break_characters
1567 (gdb_completer_command_word_break_characters);
1570 /* Complete on signals. */
1573 signal_completer (struct cmd_list_element *ignore,
1574 completion_tracker &tracker,
1575 const char *text, const char *word)
1577 size_t len = strlen (word);
1579 const char *signame;
1581 for (signum = GDB_SIGNAL_FIRST; signum != GDB_SIGNAL_LAST; ++signum)
1583 /* Can't handle this, so skip it. */
1584 if (signum == GDB_SIGNAL_0)
1587 signame = gdb_signal_to_name ((enum gdb_signal) signum);
1589 /* Ignore the unknown signal case. */
1590 if (!signame || strcmp (signame, "?") == 0)
1593 if (strncasecmp (signame, word, len) == 0)
1595 gdb::unique_xmalloc_ptr<char> copy (xstrdup (signame));
1596 tracker.add_completion (std::move (copy));
1601 /* Bit-flags for selecting what the register and/or register-group
1602 completer should complete on. */
1604 enum reg_completer_target
1606 complete_register_names = 0x1,
1607 complete_reggroup_names = 0x2
1609 DEF_ENUM_FLAGS_TYPE (enum reg_completer_target, reg_completer_targets);
1611 /* Complete register names and/or reggroup names based on the value passed
1612 in TARGETS. At least one bit in TARGETS must be set. */
1615 reg_or_group_completer_1 (completion_tracker &tracker,
1616 const char *text, const char *word,
1617 reg_completer_targets targets)
1619 size_t len = strlen (word);
1620 struct gdbarch *gdbarch;
1623 gdb_assert ((targets & (complete_register_names
1624 | complete_reggroup_names)) != 0);
1625 gdbarch = get_current_arch ();
1627 if ((targets & complete_register_names) != 0)
1632 (name = user_reg_map_regnum_to_name (gdbarch, i)) != NULL;
1635 if (*name != '\0' && strncmp (word, name, len) == 0)
1637 gdb::unique_xmalloc_ptr<char> copy (xstrdup (name));
1638 tracker.add_completion (std::move (copy));
1643 if ((targets & complete_reggroup_names) != 0)
1645 struct reggroup *group;
1647 for (group = reggroup_next (gdbarch, NULL);
1649 group = reggroup_next (gdbarch, group))
1651 name = reggroup_name (group);
1652 if (strncmp (word, name, len) == 0)
1654 gdb::unique_xmalloc_ptr<char> copy (xstrdup (name));
1655 tracker.add_completion (std::move (copy));
1661 /* Perform completion on register and reggroup names. */
1664 reg_or_group_completer (struct cmd_list_element *ignore,
1665 completion_tracker &tracker,
1666 const char *text, const char *word)
1668 reg_or_group_completer_1 (tracker, text, word,
1669 (complete_register_names
1670 | complete_reggroup_names));
1673 /* Perform completion on reggroup names. */
1676 reggroup_completer (struct cmd_list_element *ignore,
1677 completion_tracker &tracker,
1678 const char *text, const char *word)
1680 reg_or_group_completer_1 (tracker, text, word,
1681 complete_reggroup_names);
1684 /* The default completer_handle_brkchars implementation. */
1687 default_completer_handle_brkchars (struct cmd_list_element *ignore,
1688 completion_tracker &tracker,
1689 const char *text, const char *word)
1691 set_rl_completer_word_break_characters
1692 (current_language->la_word_break_characters ());
1695 /* See definition in completer.h. */
1697 completer_handle_brkchars_ftype *
1698 completer_handle_brkchars_func_for_completer (completer_ftype *fn)
1700 if (fn == filename_completer)
1701 return filename_completer_handle_brkchars;
1703 if (fn == location_completer)
1704 return location_completer_handle_brkchars;
1706 if (fn == command_completer)
1707 return command_completer_handle_brkchars;
1709 return default_completer_handle_brkchars;
1712 /* Used as brkchars when we want to tell readline we have a custom
1713 word point. We do that by making our rl_completion_word_break_hook
1714 set RL_POINT to the desired word point, and return the character at
1715 the word break point as the break char. This is two bytes in order
1716 to fit one break character plus the terminating null. */
1717 static char gdb_custom_word_point_brkchars[2];
1719 /* Since rl_basic_quote_characters is not completer-specific, we save
1720 its original value here, in order to be able to restore it in
1721 gdb_rl_attempted_completion_function. */
1722 static const char *gdb_org_rl_basic_quote_characters = rl_basic_quote_characters;
1724 /* Get the list of chars that are considered as word breaks
1725 for the current command. */
1728 gdb_completion_word_break_characters_throw ()
1730 /* New completion starting. Get rid of the previous tracker and
1732 delete current_completion.tracker;
1733 current_completion.tracker = new completion_tracker ();
1735 completion_tracker &tracker = *current_completion.tracker;
1737 complete_line_internal (tracker, NULL, rl_line_buffer,
1738 rl_point, handle_brkchars);
1740 if (tracker.use_custom_word_point ())
1742 gdb_assert (tracker.custom_word_point () > 0);
1743 rl_point = tracker.custom_word_point () - 1;
1744 gdb_custom_word_point_brkchars[0] = rl_line_buffer[rl_point];
1745 rl_completer_word_break_characters = gdb_custom_word_point_brkchars;
1746 rl_completer_quote_characters = NULL;
1748 /* Clear this too, so that if we're completing a quoted string,
1749 readline doesn't consider the quote character a delimiter.
1750 If we didn't do this, readline would auto-complete {b
1751 'fun<tab>} to {'b 'function()'}, i.e., add the terminating
1752 \', but, it wouldn't append the separator space either, which
1753 is not desirable. So instead we take care of appending the
1754 quote character to the LCD ourselves, in
1755 gdb_rl_attempted_completion_function. Since this global is
1756 not just completer-specific, we'll restore it back to the
1757 default in gdb_rl_attempted_completion_function. */
1758 rl_basic_quote_characters = NULL;
1761 return rl_completer_word_break_characters;
1765 gdb_completion_word_break_characters ()
1767 /* New completion starting. */
1768 current_completion.aborted = false;
1772 return gdb_completion_word_break_characters_throw ();
1774 CATCH (ex, RETURN_MASK_ALL)
1776 /* Set this to that gdb_rl_attempted_completion_function knows
1778 current_completion.aborted = true;
1785 /* See completer.h. */
1788 completion_find_completion_word (completion_tracker &tracker, const char *text,
1791 size_t point = strlen (text);
1793 complete_line_internal (tracker, NULL, text, point, handle_brkchars);
1795 if (tracker.use_custom_word_point ())
1797 gdb_assert (tracker.custom_word_point () > 0);
1798 *quote_char = tracker.quote_char ();
1799 return text + tracker.custom_word_point ();
1802 gdb_rl_completion_word_info info;
1804 info.word_break_characters = rl_completer_word_break_characters;
1805 info.quote_characters = gdb_completer_quote_characters;
1806 info.basic_quote_characters = rl_basic_quote_characters;
1808 return gdb_rl_find_completion_word (&info, quote_char, NULL, text);
1811 /* See completer.h. */
1814 completion_tracker::recompute_lowest_common_denominator (const char *new_match)
1816 if (m_lowest_common_denominator == NULL)
1818 /* We don't have a lowest common denominator yet, so simply take
1819 the whole NEW_MATCH as being it. */
1820 m_lowest_common_denominator = xstrdup (new_match);
1821 m_lowest_common_denominator_unique = true;
1825 /* Find the common denominator between the currently-known
1826 lowest common denominator and NEW_MATCH. That becomes the
1827 new lowest common denominator. */
1831 (new_match[i] != '\0'
1832 && new_match[i] == m_lowest_common_denominator[i]);
1835 if (m_lowest_common_denominator[i] != new_match[i])
1837 m_lowest_common_denominator[i] = '\0';
1838 m_lowest_common_denominator_unique = false;
1843 /* See completer.h. */
1846 completion_tracker::advance_custom_word_point_by (size_t len)
1848 m_custom_word_point += len;
1851 /* Build a new C string that is a copy of LCD with the whitespace of
1852 ORIG/ORIG_LEN preserved.
1854 Say the user is completing a symbol name, with spaces, like:
1858 and the resulting completion match is:
1862 we want to end up with an input line like:
1865 ^^^^^^^ => text from LCD [1], whitespace from ORIG preserved.
1866 ^^ => new text from LCD
1868 [1] - We must take characters from the LCD instead of the original
1869 text, since some completions want to change upper/lowercase. E.g.:
1875 "handle SIG[QUIT|etc.]"
1879 expand_preserving_ws (const char *orig, size_t orig_len,
1882 const char *p_orig = orig;
1883 const char *orig_end = orig + orig_len;
1884 const char *p_lcd = lcd;
1887 while (p_orig < orig_end)
1891 while (p_orig < orig_end && *p_orig == ' ')
1893 p_lcd = skip_spaces_const (p_lcd);
1897 /* Take characters from the LCD instead of the original
1898 text, since some completions change upper/lowercase.
1902 "handle SIG[QUIT|etc.]"
1910 while (*p_lcd != '\0')
1913 return xstrdup (res.c_str ());
1916 /* See completer.h. */
1919 completion_tracker::build_completion_result (const char *text,
1922 completion_list &list = m_entries_vec; /* The completions. */
1927 /* +1 for the LCD, and +1 for NULL termination. */
1928 char **match_list = XNEWVEC (char *, 1 + list.size () + 1);
1930 /* Build replacement word, based on the LCD. */
1933 = expand_preserving_ws (text, end - start,
1934 m_lowest_common_denominator);
1936 if (m_lowest_common_denominator_unique)
1938 /* We don't rely on readline appending the quote char as
1939 delimiter as then readline wouldn't append the ' ' after the
1941 char buf[2] = { quote_char () };
1943 match_list[0] = reconcat (match_list[0], match_list[0],
1944 buf, (char *) NULL);
1945 match_list[1] = NULL;
1947 /* If we already have a space at the end of the match, tell
1948 readline to skip appending another. */
1949 bool completion_suppress_append
1950 = (match_list[0][strlen (match_list[0]) - 1] == ' ');
1952 return completion_result (match_list, 1, completion_suppress_append);
1958 for (ix = 0; ix < list.size (); ++ix)
1959 match_list[ix + 1] = list[ix].release ();
1960 match_list[ix + 1] = NULL;
1962 return completion_result (match_list, list.size (), false);
1966 /* See completer.h */
1968 completion_result::completion_result ()
1969 : match_list (NULL), number_matches (0),
1970 completion_suppress_append (false)
1973 /* See completer.h */
1975 completion_result::completion_result (char **match_list_,
1976 size_t number_matches_,
1977 bool completion_suppress_append_)
1978 : match_list (match_list_),
1979 number_matches (number_matches_),
1980 completion_suppress_append (completion_suppress_append_)
1983 /* See completer.h */
1985 completion_result::~completion_result ()
1987 reset_match_list ();
1990 /* See completer.h */
1992 completion_result::completion_result (completion_result &&rhs)
1997 reset_match_list ();
1998 match_list = rhs.match_list;
1999 rhs.match_list = NULL;
2000 number_matches = rhs.number_matches;
2001 rhs.number_matches = 0;
2004 /* See completer.h */
2007 completion_result::release_match_list ()
2009 char **ret = match_list;
2014 /* Compare C strings for std::sort. */
2017 compare_cstrings (const char *str1, const char *str2)
2019 return strcmp (str1, str2) < 0;
2022 /* See completer.h */
2025 completion_result::sort_match_list ()
2027 if (number_matches > 1)
2029 /* Element 0 is special (it's the common prefix), leave it
2031 std::sort (&match_list[1],
2032 &match_list[number_matches + 1],
2037 /* See completer.h */
2040 completion_result::reset_match_list ()
2042 if (match_list != NULL)
2044 for (char **p = match_list; *p != NULL; p++)
2051 /* Helper for gdb_rl_attempted_completion_function, which does most of
2052 the work. This is called by readline to build the match list array
2053 and to determine the lowest common denominator. The real matches
2054 list starts at match[1], while match[0] is the slot holding
2055 readline's idea of the lowest common denominator of all matches,
2056 which is what readline replaces the completion "word" with.
2058 TEXT is the caller's idea of the "word" we are looking at, as
2059 computed in the handle_brkchars phase.
2061 START is the offset from RL_LINE_BUFFER where TEXT starts. END is
2062 the offset from RL_LINE_BUFFER where TEXT ends (i.e., where
2065 You should thus pretend that the line ends at END (relative to
2068 RL_LINE_BUFFER contains the entire text of the line. RL_POINT is
2069 the offset in that line of the cursor. You should pretend that the
2072 Returns NULL if there are no completions. */
2075 gdb_rl_attempted_completion_function_throw (const char *text, int start, int end)
2077 /* Completers that provide a custom word point in the
2078 handle_brkchars phase also compute their completions then.
2079 Completers that leave the completion word handling to readline
2080 must be called twice. If rl_point (i.e., END) is at column 0,
2081 then readline skips the handle_brkchars phase, and so we create a
2082 tracker now in that case too. */
2083 if (end == 0 || !current_completion.tracker->use_custom_word_point ())
2085 delete current_completion.tracker;
2086 current_completion.tracker = new completion_tracker ();
2088 complete_line (*current_completion.tracker, text,
2089 rl_line_buffer, rl_point);
2092 completion_tracker &tracker = *current_completion.tracker;
2094 completion_result result
2095 = tracker.build_completion_result (text, start, end);
2097 rl_completion_suppress_append = result.completion_suppress_append;
2098 return result.release_match_list ();
2101 /* Function installed as "rl_attempted_completion_function" readline
2102 hook. Wrapper around gdb_rl_attempted_completion_function_throw
2103 that catches C++ exceptions, which can't cross readline. */
2106 gdb_rl_attempted_completion_function (const char *text, int start, int end)
2108 /* Restore globals that might have been tweaked in
2109 gdb_completion_word_break_characters. */
2110 rl_basic_quote_characters = gdb_org_rl_basic_quote_characters;
2112 /* If we end up returning NULL, either on error, or simple because
2113 there are no matches, inhibit readline's default filename
2115 rl_attempted_completion_over = 1;
2117 /* If the handle_brkchars phase was aborted, don't try
2119 if (current_completion.aborted)
2124 return gdb_rl_attempted_completion_function_throw (text, start, end);
2126 CATCH (ex, RETURN_MASK_ALL)
2134 /* Skip over the possibly quoted word STR (as defined by the quote
2135 characters QUOTECHARS and the word break characters BREAKCHARS).
2136 Returns pointer to the location after the "word". If either
2137 QUOTECHARS or BREAKCHARS is NULL, use the same values used by the
2141 skip_quoted_chars (const char *str, const char *quotechars,
2142 const char *breakchars)
2144 char quote_char = '\0';
2147 if (quotechars == NULL)
2148 quotechars = gdb_completer_quote_characters;
2150 if (breakchars == NULL)
2151 breakchars = current_language->la_word_break_characters();
2153 for (scan = str; *scan != '\0'; scan++)
2155 if (quote_char != '\0')
2157 /* Ignore everything until the matching close quote char. */
2158 if (*scan == quote_char)
2160 /* Found matching close quote. */
2165 else if (strchr (quotechars, *scan))
2167 /* Found start of a quoted string. */
2170 else if (strchr (breakchars, *scan))
2179 /* Skip over the possibly quoted word STR (as defined by the quote
2180 characters and word break characters used by the completer).
2181 Returns pointer to the location after the "word". */
2184 skip_quoted (const char *str)
2186 return skip_quoted_chars (str, NULL, NULL);
2189 /* Return a message indicating that the maximum number of completions
2190 has been reached and that there may be more. */
2193 get_max_completions_reached_message (void)
2195 return _("*** List may be truncated, max-completions reached. ***");
2198 /* GDB replacement for rl_display_match_list.
2199 Readline doesn't provide a clean interface for TUI(curses).
2200 A hack previously used was to send readline's rl_outstream through a pipe
2201 and read it from the event loop. Bleah. IWBN if readline abstracted
2202 away all the necessary bits, and this is what this code does. It
2203 replicates the parts of readline we need and then adds an abstraction
2204 layer, currently implemented as struct match_list_displayer, so that both
2205 CLI and TUI can use it. We copy all this readline code to minimize
2206 GDB-specific mods to readline. Once this code performs as desired then
2207 we can submit it to the readline maintainers.
2209 N.B. A lot of the code is the way it is in order to minimize differences
2210 from readline's copy. */
2212 /* Not supported here. */
2213 #undef VISIBLE_STATS
2215 #if defined (HANDLE_MULTIBYTE)
2216 #define MB_INVALIDCH(x) ((x) == (size_t)-1 || (x) == (size_t)-2)
2217 #define MB_NULLWCH(x) ((x) == 0)
2220 #define ELLIPSIS_LEN 3
2222 /* gdb version of readline/complete.c:get_y_or_n.
2223 'y' -> returns 1, and 'n' -> returns 0.
2224 Also supported: space == 'y', RUBOUT == 'n', ctrl-g == start over.
2225 If FOR_PAGER is non-zero, then also supported are:
2226 NEWLINE or RETURN -> returns 2, and 'q' -> returns 0. */
2229 gdb_get_y_or_n (int for_pager, const struct match_list_displayer *displayer)
2235 RL_SETSTATE (RL_STATE_MOREINPUT);
2236 c = displayer->read_key (displayer);
2237 RL_UNSETSTATE (RL_STATE_MOREINPUT);
2239 if (c == 'y' || c == 'Y' || c == ' ')
2241 if (c == 'n' || c == 'N' || c == RUBOUT)
2243 if (c == ABORT_CHAR || c < 0)
2245 /* Readline doesn't erase_entire_line here, but without it the
2246 --More-- prompt isn't erased and neither is the text entered
2247 thus far redisplayed. */
2248 displayer->erase_entire_line (displayer);
2249 /* Note: The arguments to rl_abort are ignored. */
2252 if (for_pager && (c == NEWLINE || c == RETURN))
2254 if (for_pager && (c == 'q' || c == 'Q'))
2256 displayer->beep (displayer);
2260 /* Pager function for tab-completion.
2261 This is based on readline/complete.c:_rl_internal_pager.
2262 LINES is the number of lines of output displayed thus far.
2264 -1 -> user pressed 'n' or equivalent,
2265 0 -> user pressed 'y' or equivalent,
2266 N -> user pressed NEWLINE or equivalent and N is LINES - 1. */
2269 gdb_display_match_list_pager (int lines,
2270 const struct match_list_displayer *displayer)
2274 displayer->puts (displayer, "--More--");
2275 displayer->flush (displayer);
2276 i = gdb_get_y_or_n (1, displayer);
2277 displayer->erase_entire_line (displayer);
2286 /* Return non-zero if FILENAME is a directory.
2287 Based on readline/complete.c:path_isdir. */
2290 gdb_path_isdir (const char *filename)
2294 return (stat (filename, &finfo) == 0 && S_ISDIR (finfo.st_mode));
2297 /* Return the portion of PATHNAME that should be output when listing
2298 possible completions. If we are hacking filename completion, we
2299 are only interested in the basename, the portion following the
2300 final slash. Otherwise, we return what we were passed. Since
2301 printing empty strings is not very informative, if we're doing
2302 filename completion, and the basename is the empty string, we look
2303 for the previous slash and return the portion following that. If
2304 there's no previous slash, we just return what we were passed.
2306 Based on readline/complete.c:printable_part. */
2309 gdb_printable_part (char *pathname)
2313 if (rl_filename_completion_desired == 0) /* don't need to do anything */
2316 temp = strrchr (pathname, '/');
2317 #if defined (__MSDOS__)
2318 if (temp == 0 && ISALPHA ((unsigned char)pathname[0]) && pathname[1] == ':')
2319 temp = pathname + 1;
2322 if (temp == 0 || *temp == '\0')
2324 /* If the basename is NULL, we might have a pathname like '/usr/src/'.
2325 Look for a previous slash and, if one is found, return the portion
2326 following that slash. If there's no previous slash, just return the
2327 pathname we were passed. */
2328 else if (temp[1] == '\0')
2330 for (x = temp - 1; x > pathname; x--)
2333 return ((*x == '/') ? x + 1 : pathname);
2339 /* Compute width of STRING when displayed on screen by print_filename.
2340 Based on readline/complete.c:fnwidth. */
2343 gdb_fnwidth (const char *string)
2346 #if defined (HANDLE_MULTIBYTE)
2352 left = strlen (string) + 1;
2353 memset (&ps, 0, sizeof (mbstate_t));
2359 if (CTRL_CHAR (string[pos]) || string[pos] == RUBOUT)
2366 #if defined (HANDLE_MULTIBYTE)
2367 clen = mbrtowc (&wc, string + pos, left - pos, &ps);
2368 if (MB_INVALIDCH (clen))
2372 memset (&ps, 0, sizeof (mbstate_t));
2374 else if (MB_NULLWCH (clen))
2380 width += (w >= 0) ? w : 1;
2392 /* Print TO_PRINT, one matching completion.
2393 PREFIX_BYTES is number of common prefix bytes.
2394 Based on readline/complete.c:fnprint. */
2397 gdb_fnprint (const char *to_print, int prefix_bytes,
2398 const struct match_list_displayer *displayer)
2402 #if defined (HANDLE_MULTIBYTE)
2409 end = to_print + strlen (to_print) + 1;
2410 memset (&ps, 0, sizeof (mbstate_t));
2415 /* Don't print only the ellipsis if the common prefix is one of the
2416 possible completions */
2417 if (to_print[prefix_bytes] == '\0')
2424 ellipsis = (to_print[prefix_bytes] == '.') ? '_' : '.';
2425 for (w = 0; w < ELLIPSIS_LEN; w++)
2426 displayer->putch (displayer, ellipsis);
2427 printed_len = ELLIPSIS_LEN;
2430 s = to_print + prefix_bytes;
2435 displayer->putch (displayer, '^');
2436 displayer->putch (displayer, UNCTRL (*s));
2439 #if defined (HANDLE_MULTIBYTE)
2440 memset (&ps, 0, sizeof (mbstate_t));
2443 else if (*s == RUBOUT)
2445 displayer->putch (displayer, '^');
2446 displayer->putch (displayer, '?');
2449 #if defined (HANDLE_MULTIBYTE)
2450 memset (&ps, 0, sizeof (mbstate_t));
2455 #if defined (HANDLE_MULTIBYTE)
2456 tlen = mbrtowc (&wc, s, end - s, &ps);
2457 if (MB_INVALIDCH (tlen))
2461 memset (&ps, 0, sizeof (mbstate_t));
2463 else if (MB_NULLWCH (tlen))
2468 width = (w >= 0) ? w : 1;
2470 for (w = 0; w < tlen; ++w)
2471 displayer->putch (displayer, s[w]);
2473 printed_len += width;
2475 displayer->putch (displayer, *s);
2485 /* Output TO_PRINT to rl_outstream. If VISIBLE_STATS is defined and we
2486 are using it, check for and output a single character for `special'
2487 filenames. Return the number of characters we output.
2488 Based on readline/complete.c:print_filename. */
2491 gdb_print_filename (char *to_print, char *full_pathname, int prefix_bytes,
2492 const struct match_list_displayer *displayer)
2494 int printed_len, extension_char, slen, tlen;
2495 char *s, c, *new_full_pathname;
2497 extern int _rl_complete_mark_directories;
2500 printed_len = gdb_fnprint (to_print, prefix_bytes, displayer);
2502 #if defined (VISIBLE_STATS)
2503 if (rl_filename_completion_desired && (rl_visible_stats || _rl_complete_mark_directories))
2505 if (rl_filename_completion_desired && _rl_complete_mark_directories)
2508 /* If to_print != full_pathname, to_print is the basename of the
2509 path passed. In this case, we try to expand the directory
2510 name before checking for the stat character. */
2511 if (to_print != full_pathname)
2513 /* Terminate the directory name. */
2515 to_print[-1] = '\0';
2517 /* If setting the last slash in full_pathname to a NUL results in
2518 full_pathname being the empty string, we are trying to complete
2519 files in the root directory. If we pass a null string to the
2520 bash directory completion hook, for example, it will expand it
2521 to the current directory. We just want the `/'. */
2522 if (full_pathname == 0 || *full_pathname == 0)
2524 else if (full_pathname[0] != '/')
2526 else if (full_pathname[1] == 0)
2527 dn = "//"; /* restore trailing slash to `//' */
2528 else if (full_pathname[1] == '/' && full_pathname[2] == 0)
2529 dn = "/"; /* don't turn /// into // */
2532 s = tilde_expand (dn);
2533 if (rl_directory_completion_hook)
2534 (*rl_directory_completion_hook) (&s);
2537 tlen = strlen (to_print);
2538 new_full_pathname = (char *)xmalloc (slen + tlen + 2);
2539 strcpy (new_full_pathname, s);
2540 if (s[slen - 1] == '/')
2543 new_full_pathname[slen] = '/';
2544 new_full_pathname[slen] = '/';
2545 strcpy (new_full_pathname + slen + 1, to_print);
2547 #if defined (VISIBLE_STATS)
2548 if (rl_visible_stats)
2549 extension_char = stat_char (new_full_pathname);
2552 if (gdb_path_isdir (new_full_pathname))
2553 extension_char = '/';
2555 xfree (new_full_pathname);
2560 s = tilde_expand (full_pathname);
2561 #if defined (VISIBLE_STATS)
2562 if (rl_visible_stats)
2563 extension_char = stat_char (s);
2566 if (gdb_path_isdir (s))
2567 extension_char = '/';
2573 displayer->putch (displayer, extension_char);
2581 /* GDB version of readline/complete.c:complete_get_screenwidth. */
2584 gdb_complete_get_screenwidth (const struct match_list_displayer *displayer)
2586 /* Readline has other stuff here which it's not clear we need. */
2587 return displayer->width;
2590 extern int _rl_completion_prefix_display_length;
2591 extern int _rl_print_completions_horizontally;
2593 EXTERN_C int _rl_qsort_string_compare (const void *, const void *);
2594 typedef int QSFUNC (const void *, const void *);
2596 /* GDB version of readline/complete.c:rl_display_match_list.
2597 See gdb_display_match_list for a description of MATCHES, LEN, MAX.
2598 Returns non-zero if all matches are displayed. */
2601 gdb_display_match_list_1 (char **matches, int len, int max,
2602 const struct match_list_displayer *displayer)
2604 int count, limit, printed_len, lines, cols;
2605 int i, j, k, l, common_length, sind;
2607 int page_completions = displayer->height != INT_MAX && pagination_enabled;
2609 /* Find the length of the prefix common to all items: length as displayed
2610 characters (common_length) and as a byte index into the matches (sind) */
2611 common_length = sind = 0;
2612 if (_rl_completion_prefix_display_length > 0)
2614 t = gdb_printable_part (matches[0]);
2615 temp = strrchr (t, '/');
2616 common_length = temp ? gdb_fnwidth (temp) : gdb_fnwidth (t);
2617 sind = temp ? strlen (temp) : strlen (t);
2619 if (common_length > _rl_completion_prefix_display_length && common_length > ELLIPSIS_LEN)
2620 max -= common_length - ELLIPSIS_LEN;
2622 common_length = sind = 0;
2625 /* How many items of MAX length can we fit in the screen window? */
2626 cols = gdb_complete_get_screenwidth (displayer);
2629 if (limit != 1 && (limit * max == cols))
2632 /* If cols == 0, limit will end up -1 */
2633 if (cols < displayer->width && limit < 0)
2636 /* Avoid a possible floating exception. If max > cols,
2637 limit will be 0 and a divide-by-zero fault will result. */
2641 /* How many iterations of the printing loop? */
2642 count = (len + (limit - 1)) / limit;
2644 /* Watch out for special case. If LEN is less than LIMIT, then
2645 just do the inner printing loop.
2646 0 < len <= limit implies count = 1. */
2648 /* Sort the items if they are not already sorted. */
2649 if (rl_ignore_completion_duplicates == 0 && rl_sort_completion_matches)
2650 qsort (matches + 1, len, sizeof (char *), (QSFUNC *)_rl_qsort_string_compare);
2652 displayer->crlf (displayer);
2655 if (_rl_print_completions_horizontally == 0)
2657 /* Print the sorted items, up-and-down alphabetically, like ls. */
2658 for (i = 1; i <= count; i++)
2660 for (j = 0, l = i; j < limit; j++)
2662 if (l > len || matches[l] == 0)
2666 temp = gdb_printable_part (matches[l]);
2667 printed_len = gdb_print_filename (temp, matches[l], sind,
2671 for (k = 0; k < max - printed_len; k++)
2672 displayer->putch (displayer, ' ');
2676 displayer->crlf (displayer);
2678 if (page_completions && lines >= (displayer->height - 1) && i < count)
2680 lines = gdb_display_match_list_pager (lines, displayer);
2688 /* Print the sorted items, across alphabetically, like ls -x. */
2689 for (i = 1; matches[i]; i++)
2691 temp = gdb_printable_part (matches[i]);
2692 printed_len = gdb_print_filename (temp, matches[i], sind, displayer);
2693 /* Have we reached the end of this line? */
2696 if (i && (limit > 1) && (i % limit) == 0)
2698 displayer->crlf (displayer);
2700 if (page_completions && lines >= displayer->height - 1)
2702 lines = gdb_display_match_list_pager (lines, displayer);
2708 for (k = 0; k < max - printed_len; k++)
2709 displayer->putch (displayer, ' ');
2712 displayer->crlf (displayer);
2718 /* Utility for displaying completion list matches, used by both CLI and TUI.
2720 MATCHES is the list of strings, in argv format, LEN is the number of
2721 strings in MATCHES, and MAX is the length of the longest string in
2725 gdb_display_match_list (char **matches, int len, int max,
2726 const struct match_list_displayer *displayer)
2728 /* Readline will never call this if complete_line returned NULL. */
2729 gdb_assert (max_completions != 0);
2731 /* complete_line will never return more than this. */
2732 if (max_completions > 0)
2733 gdb_assert (len <= max_completions);
2735 if (rl_completion_query_items > 0 && len >= rl_completion_query_items)
2739 /* We can't use *query here because they wait for <RET> which is
2740 wrong here. This follows the readline version as closely as possible
2741 for compatibility's sake. See readline/complete.c. */
2743 displayer->crlf (displayer);
2745 xsnprintf (msg, sizeof (msg),
2746 "Display all %d possibilities? (y or n)", len);
2747 displayer->puts (displayer, msg);
2748 displayer->flush (displayer);
2750 if (gdb_get_y_or_n (0, displayer) == 0)
2752 displayer->crlf (displayer);
2757 if (gdb_display_match_list_1 (matches, len, max, displayer))
2759 /* Note: MAX_COMPLETIONS may be -1 or zero, but LEN is always > 0. */
2760 if (len == max_completions)
2762 /* The maximum number of completions has been reached. Warn the user
2763 that there may be more. */
2764 const char *message = get_max_completions_reached_message ();
2766 displayer->puts (displayer, message);
2767 displayer->crlf (displayer);
2772 extern initialize_file_ftype _initialize_completer; /* -Wmissing-prototypes */
2775 _initialize_completer (void)
2777 add_setshow_zuinteger_unlimited_cmd ("max-completions", no_class,
2778 &max_completions, _("\
2779 Set maximum number of completion candidates."), _("\
2780 Show maximum number of completion candidates."), _("\
2781 Use this to limit the number of candidates considered\n\
2782 during completion. Specifying \"unlimited\" or -1\n\
2783 disables limiting. Note that setting either no limit or\n\
2784 a very large limit can make completion slow."),
2785 NULL, NULL, &setlist, &showlist);