1 /* Line completion stuff for GDB, the GNU debugger.
2 Copyright (C) 2000-2020 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 "gdbsupport/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 /* See completer.h. */
50 class completion_tracker::completion_hash_entry
54 completion_hash_entry (gdb::unique_xmalloc_ptr
<char> name
,
55 gdb::unique_xmalloc_ptr
<char> lcd
)
56 : m_name (std::move (name
)),
57 m_lcd (std::move (lcd
))
62 /* Returns a pointer to the lowest common denominator string. This
63 string will only be valid while this hash entry is still valid as the
64 string continues to be owned by this hash entry and will be released
65 when this entry is deleted. */
66 char *get_lcd () const
71 /* Get, and release the name field from this hash entry. This can only
72 be called once, after which the name field is no longer valid. This
73 should be used to pass ownership of the name to someone else. */
76 return m_name
.release ();
79 /* Return true of the name in this hash entry is STR. */
80 bool is_name_eq (const char *str
) const
82 return strcmp (m_name
.get (), str
) == 0;
85 /* Return the hash value based on the name of the entry. */
86 hashval_t
hash_name () const
88 return htab_hash_string (m_name
.get ());
91 /* A static function that can be passed to the htab hash system to be
92 used as a callback that deletes an item from the hash. */
93 static void deleter (void *arg
)
95 completion_hash_entry
*entry
= (completion_hash_entry
*) arg
;
101 /* The symbol name stored in this hash entry. */
102 gdb::unique_xmalloc_ptr
<char> m_name
;
104 /* The lowest common denominator string computed for this hash entry. */
105 gdb::unique_xmalloc_ptr
<char> m_lcd
;
108 /* Misc state that needs to be tracked across several different
109 readline completer entry point calls, all related to a single
110 completion invocation. */
112 struct gdb_completer_state
114 /* The current completion's completion tracker. This is a global
115 because a tracker can be shared between the handle_brkchars and
116 handle_completion phases, which involves different readline
118 completion_tracker
*tracker
= NULL
;
120 /* Whether the current completion was aborted. */
121 bool aborted
= false;
124 /* The current completion state. */
125 static gdb_completer_state current_completion
;
127 /* An enumeration of the various things a user might attempt to
128 complete for a location. If you change this, remember to update
129 the explicit_options array below too. */
131 enum explicit_location_match_type
133 /* The filename of a source file. */
136 /* The name of a function or method. */
139 /* The fully-qualified name of a function or method. */
145 /* The name of a label. */
149 /* Prototypes for local functions. */
151 /* readline uses the word breaks for two things:
152 (1) In figuring out where to point the TEXT parameter to the
153 rl_completion_entry_function. Since we don't use TEXT for much,
154 it doesn't matter a lot what the word breaks are for this purpose,
155 but it does affect how much stuff M-? lists.
156 (2) If one of the matches contains a word break character, readline
157 will quote it. That's why we switch between
158 current_language->la_word_break_characters() and
159 gdb_completer_command_word_break_characters. I'm not sure when
160 we need this behavior (perhaps for funky characters in C++
163 /* Variables which are necessary for fancy command line editing. */
165 /* When completing on command names, we remove '-' and '.' from the list of
166 word break characters, since we use it in command names. If the
167 readline library sees one in any of the current completion strings,
168 it thinks that the string needs to be quoted and automatically
169 supplies a leading quote. */
170 static const char gdb_completer_command_word_break_characters
[] =
171 " \t\n!@#$%^&*()+=|~`}{[]\"';:?/><,";
173 /* When completing on file names, we remove from the list of word
174 break characters any characters that are commonly used in file
175 names, such as '-', '+', '~', etc. Otherwise, readline displays
176 incorrect completion candidates. */
177 /* MS-DOS and MS-Windows use colon as part of the drive spec, and most
178 programs support @foo style response files. */
179 static const char gdb_completer_file_name_break_characters
[] =
180 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
186 /* Characters that can be used to quote completion strings. Note that
187 we can't include '"' because the gdb C parser treats such quoted
188 sequences as strings. */
189 static const char gdb_completer_quote_characters
[] = "'";
191 /* Accessor for some completer data that may interest other files. */
194 get_gdb_completer_quote_characters (void)
196 return gdb_completer_quote_characters
;
199 /* This can be used for functions which don't want to complete on
200 symbols but don't want to complete on anything else either. */
203 noop_completer (struct cmd_list_element
*ignore
,
204 completion_tracker
&tracker
,
205 const char *text
, const char *prefix
)
209 /* Complete on filenames. */
212 filename_completer (struct cmd_list_element
*ignore
,
213 completion_tracker
&tracker
,
214 const char *text
, const char *word
)
221 gdb::unique_xmalloc_ptr
<char> p_rl
222 (rl_filename_completion_function (text
, subsequent_name
));
225 /* We need to set subsequent_name to a non-zero value before the
226 continue line below, because otherwise, if the first file
227 seen by GDB is a backup file whose name ends in a `~', we
228 will loop indefinitely. */
230 /* Like emacs, don't complete on old versions. Especially
231 useful in the "source" command. */
232 const char *p
= p_rl
.get ();
233 if (p
[strlen (p
) - 1] == '~')
236 tracker
.add_completion
237 (make_completion_match_str (std::move (p_rl
), text
, word
));
240 /* There is no way to do this just long enough to affect quote
241 inserting without also affecting the next completion. This
242 should be fixed in readline. FIXME. */
243 /* Ensure that readline does the right thing
244 with respect to inserting quotes. */
245 rl_completer_word_break_characters
= "";
249 /* The corresponding completer_handle_brkchars
253 filename_completer_handle_brkchars (struct cmd_list_element
*ignore
,
254 completion_tracker
&tracker
,
255 const char *text
, const char *word
)
257 set_rl_completer_word_break_characters
258 (gdb_completer_file_name_break_characters
);
261 /* Possible values for the found_quote flags word used by the completion
262 functions. It says what kind of (shell-like) quoting we found anywhere
264 #define RL_QF_SINGLE_QUOTE 0x01
265 #define RL_QF_DOUBLE_QUOTE 0x02
266 #define RL_QF_BACKSLASH 0x04
267 #define RL_QF_OTHER_QUOTE 0x08
269 /* Find the bounds of the current word for completion purposes, and
270 return a pointer to the end of the word. This mimics (and is a
271 modified version of) readline's _rl_find_completion_word internal
274 This function skips quoted substrings (characters between matched
275 pairs of characters in rl_completer_quote_characters). We try to
276 find an unclosed quoted substring on which to do matching. If one
277 is not found, we use the word break characters to find the
278 boundaries of the current word. QC, if non-null, is set to the
279 opening quote character if we found an unclosed quoted substring,
280 '\0' otherwise. DP, if non-null, is set to the value of the
281 delimiter character that caused a word break. */
283 struct gdb_rl_completion_word_info
285 const char *word_break_characters
;
286 const char *quote_characters
;
287 const char *basic_quote_characters
;
291 gdb_rl_find_completion_word (struct gdb_rl_completion_word_info
*info
,
293 const char *line_buffer
)
295 int scan
, end
, found_quote
, delimiter
, pass_next
, isbrk
;
297 const char *brkchars
;
298 int point
= strlen (line_buffer
);
300 /* The algorithm below does '--point'. Avoid buffer underflow with
312 found_quote
= delimiter
= 0;
315 brkchars
= info
->word_break_characters
;
317 if (info
->quote_characters
!= NULL
)
319 /* We have a list of characters which can be used in pairs to
320 quote substrings for the completer. Try to find the start of
321 an unclosed quoted substring. */
322 /* FOUND_QUOTE is set so we know what kind of quotes we
324 for (scan
= pass_next
= 0;
334 /* Shell-like semantics for single quotes -- don't allow
335 backslash to quote anything in single quotes, especially
336 not the closing quote. If you don't like this, take out
337 the check on the value of quote_char. */
338 if (quote_char
!= '\'' && line_buffer
[scan
] == '\\')
341 found_quote
|= RL_QF_BACKSLASH
;
345 if (quote_char
!= '\0')
347 /* Ignore everything until the matching close quote
349 if (line_buffer
[scan
] == quote_char
)
351 /* Found matching close. Abandon this
357 else if (strchr (info
->quote_characters
, line_buffer
[scan
]))
359 /* Found start of a quoted substring. */
360 quote_char
= line_buffer
[scan
];
362 /* Shell-like quoting conventions. */
363 if (quote_char
== '\'')
364 found_quote
|= RL_QF_SINGLE_QUOTE
;
365 else if (quote_char
== '"')
366 found_quote
|= RL_QF_DOUBLE_QUOTE
;
368 found_quote
|= RL_QF_OTHER_QUOTE
;
373 if (point
== end
&& quote_char
== '\0')
375 /* We didn't find an unclosed quoted substring upon which to do
376 completion, so use the word break characters to find the
377 substring on which to complete. */
380 scan
= line_buffer
[point
];
382 if (strchr (brkchars
, scan
) != 0)
387 /* If we are at an unquoted word break, then advance past it. */
388 scan
= line_buffer
[point
];
392 isbrk
= strchr (brkchars
, scan
) != 0;
396 /* If the character that caused the word break was a quoting
397 character, then remember it as the delimiter. */
398 if (info
->basic_quote_characters
399 && strchr (info
->basic_quote_characters
, scan
)
400 && (end
- point
) > 1)
412 return line_buffer
+ point
;
415 /* Find the completion word point for TEXT, emulating the algorithm
416 readline uses to find the word point, using WORD_BREAK_CHARACTERS
417 as word break characters. */
420 advance_to_completion_word (completion_tracker
&tracker
,
421 const char *word_break_characters
,
424 gdb_rl_completion_word_info info
;
426 info
.word_break_characters
= word_break_characters
;
427 info
.quote_characters
= gdb_completer_quote_characters
;
428 info
.basic_quote_characters
= rl_basic_quote_characters
;
432 = gdb_rl_find_completion_word (&info
, NULL
, &delimiter
, text
);
434 tracker
.advance_custom_word_point_by (start
- text
);
438 tracker
.set_quote_char (delimiter
);
439 tracker
.set_suppress_append_ws (true);
445 /* See completer.h. */
448 advance_to_expression_complete_word_point (completion_tracker
&tracker
,
451 const char *brk_chars
= current_language
->la_word_break_characters ();
452 return advance_to_completion_word (tracker
, brk_chars
, text
);
455 /* See completer.h. */
458 advance_to_filename_complete_word_point (completion_tracker
&tracker
,
461 const char *brk_chars
= gdb_completer_file_name_break_characters
;
462 return advance_to_completion_word (tracker
, brk_chars
, text
);
465 /* See completer.h. */
468 completion_tracker::completes_to_completion_word (const char *word
)
470 recompute_lowest_common_denominator ();
471 if (m_lowest_common_denominator_unique
)
473 const char *lcd
= m_lowest_common_denominator
;
475 if (strncmp_iw (word
, lcd
, strlen (lcd
)) == 0)
477 /* Maybe skip the function and complete on keywords. */
478 size_t wordlen
= strlen (word
);
479 if (word
[wordlen
- 1] == ' ')
487 /* See completer.h. */
490 complete_nested_command_line (completion_tracker
&tracker
, const char *text
)
492 /* Must be called from a custom-word-point completer. */
493 gdb_assert (tracker
.use_custom_word_point ());
495 /* Disable the custom word point temporarily, because we want to
496 probe whether the command we're completing itself uses a custom
498 tracker
.set_use_custom_word_point (false);
499 size_t save_custom_word_point
= tracker
.custom_word_point ();
501 int quote_char
= '\0';
502 const char *word
= completion_find_completion_word (tracker
, text
,
505 if (tracker
.use_custom_word_point ())
507 /* The command we're completing uses a custom word point, so the
508 tracker already contains the matches. We're done. */
512 /* Restore the custom word point settings. */
513 tracker
.set_custom_word_point (save_custom_word_point
);
514 tracker
.set_use_custom_word_point (true);
516 /* Run the handle_completions completer phase. */
517 complete_line (tracker
, word
, text
, strlen (text
));
520 /* Complete on linespecs, which might be of two possible forms:
526 This is intended to be used in commands that set breakpoints
530 complete_files_symbols (completion_tracker
&tracker
,
531 const char *text
, const char *word
)
533 completion_list fn_list
;
536 int quoted
= *text
== '\'' || *text
== '"';
537 int quote_char
= '\0';
538 const char *colon
= NULL
;
539 char *file_to_match
= NULL
;
540 const char *symbol_start
= text
;
541 const char *orig_text
= text
;
543 /* Do we have an unquoted colon, as in "break foo.c:bar"? */
544 for (p
= text
; *p
!= '\0'; ++p
)
546 if (*p
== '\\' && p
[1] == '\'')
548 else if (*p
== '\'' || *p
== '"')
552 while (*p
!= '\0' && *p
!= quote_found
)
554 if (*p
== '\\' && p
[1] == quote_found
)
559 if (*p
== quote_found
)
562 break; /* Hit the end of text. */
564 #if HAVE_DOS_BASED_FILE_SYSTEM
565 /* If we have a DOS-style absolute file name at the beginning of
566 TEXT, and the colon after the drive letter is the only colon
567 we found, pretend the colon is not there. */
568 else if (p
< text
+ 3 && *p
== ':' && p
== text
+ 1 + quoted
)
571 else if (*p
== ':' && !colon
)
574 symbol_start
= p
+ 1;
576 else if (strchr (current_language
->la_word_break_characters(), *p
))
577 symbol_start
= p
+ 1;
583 /* Where is the file name? */
588 file_to_match
= (char *) xmalloc (colon
- text
+ 1);
589 strncpy (file_to_match
, text
, colon
- text
);
590 file_to_match
[colon
- text
] = '\0';
591 /* Remove trailing colons and quotes from the file name. */
592 for (s
= file_to_match
+ (colon
- text
);
595 if (*s
== ':' || *s
== quote_char
)
598 /* If the text includes a colon, they want completion only on a
599 symbol name after the colon. Otherwise, we need to complete on
600 symbols as well as on files. */
603 collect_file_symbol_completion_matches (tracker
,
604 complete_symbol_mode::EXPRESSION
,
605 symbol_name_match_type::EXPRESSION
,
608 xfree (file_to_match
);
612 size_t text_len
= strlen (text
);
614 collect_symbol_completion_matches (tracker
,
615 complete_symbol_mode::EXPRESSION
,
616 symbol_name_match_type::EXPRESSION
,
618 /* If text includes characters which cannot appear in a file
619 name, they cannot be asking for completion on files. */
621 gdb_completer_file_name_break_characters
) == text_len
)
622 fn_list
= make_source_files_completion_list (text
, text
);
625 if (!fn_list
.empty () && !tracker
.have_completions ())
627 /* If we only have file names as possible completion, we should
628 bring them in sync with what rl_complete expects. The
629 problem is that if the user types "break /foo/b TAB", and the
630 possible completions are "/foo/bar" and "/foo/baz"
631 rl_complete expects us to return "bar" and "baz", without the
632 leading directories, as possible completions, because `word'
633 starts at the "b". But we ignore the value of `word' when we
634 call make_source_files_completion_list above (because that
635 would not DTRT when the completion results in both symbols
636 and file names), so make_source_files_completion_list returns
637 the full "/foo/bar" and "/foo/baz" strings. This produces
638 wrong results when, e.g., there's only one possible
639 completion, because rl_complete will prepend "/foo/" to each
640 candidate completion. The loop below removes that leading
642 for (const auto &fn_up
: fn_list
)
644 char *fn
= fn_up
.get ();
645 memmove (fn
, fn
+ (word
- text
), strlen (fn
) + 1 - (word
- text
));
649 tracker
.add_completions (std::move (fn_list
));
651 if (!tracker
.have_completions ())
653 /* No completions at all. As the final resort, try completing
654 on the entire text as a symbol. */
655 collect_symbol_completion_matches (tracker
,
656 complete_symbol_mode::EXPRESSION
,
657 symbol_name_match_type::EXPRESSION
,
662 /* See completer.h. */
665 complete_source_filenames (const char *text
)
667 size_t text_len
= strlen (text
);
669 /* If text includes characters which cannot appear in a file name,
670 the user cannot be asking for completion on files. */
672 gdb_completer_file_name_break_characters
)
674 return make_source_files_completion_list (text
, text
);
679 /* Complete address and linespec locations. */
682 complete_address_and_linespec_locations (completion_tracker
&tracker
,
684 symbol_name_match_type match_type
)
688 tracker
.advance_custom_word_point_by (1);
691 = advance_to_expression_complete_word_point (tracker
, text
);
692 complete_expression (tracker
, text
, word
);
696 linespec_complete (tracker
, text
, match_type
);
700 /* The explicit location options. Note that indexes into this array
701 must match the explicit_location_match_type enumerators. */
703 static const char *const explicit_options
[] =
713 /* The probe modifier options. These can appear before a location in
714 breakpoint commands. */
715 static const char *const probe_options
[] =
723 /* Returns STRING if not NULL, the empty string otherwise. */
726 string_or_empty (const char *string
)
728 return string
!= NULL
? string
: "";
731 /* A helper function to collect explicit location matches for the given
732 LOCATION, which is attempting to match on WORD. */
735 collect_explicit_location_matches (completion_tracker
&tracker
,
736 struct event_location
*location
,
737 enum explicit_location_match_type what
,
739 const struct language_defn
*language
)
741 const struct explicit_location
*explicit_loc
742 = get_explicit_location (location
);
744 /* True if the option expects an argument. */
745 bool needs_arg
= true;
747 /* Note, in the various MATCH_* below, we complete on
748 explicit_loc->foo instead of WORD, because only the former will
749 have already skipped past any quote char. */
754 const char *source
= string_or_empty (explicit_loc
->source_filename
);
755 completion_list matches
756 = make_source_files_completion_list (source
, source
);
757 tracker
.add_completions (std::move (matches
));
763 const char *function
= string_or_empty (explicit_loc
->function_name
);
764 linespec_complete_function (tracker
, function
,
765 explicit_loc
->func_name_match_type
,
766 explicit_loc
->source_filename
);
770 case MATCH_QUALIFIED
:
774 /* Nothing to offer. */
779 const char *label
= string_or_empty (explicit_loc
->label_name
);
780 linespec_complete_label (tracker
, language
,
781 explicit_loc
->source_filename
,
782 explicit_loc
->function_name
,
783 explicit_loc
->func_name_match_type
,
789 gdb_assert_not_reached ("unhandled explicit_location_match_type");
792 if (!needs_arg
|| tracker
.completes_to_completion_word (word
))
794 tracker
.discard_completions ();
795 tracker
.advance_custom_word_point_by (strlen (word
));
796 complete_on_enum (tracker
, explicit_options
, "", "");
797 complete_on_enum (tracker
, linespec_keywords
, "", "");
799 else if (!tracker
.have_completions ())
801 /* Maybe we have an unterminated linespec keyword at the tail of
802 the string. Try completing on that. */
803 size_t wordlen
= strlen (word
);
804 const char *keyword
= word
+ wordlen
;
806 if (wordlen
> 0 && keyword
[-1] != ' ')
808 while (keyword
> word
&& *keyword
!= ' ')
810 /* Don't complete on keywords if we'd be completing on the
811 whole explicit linespec option. E.g., "b -function
812 thr<tab>" should not complete to the "thread"
816 keyword
= skip_spaces (keyword
);
818 tracker
.advance_custom_word_point_by (keyword
- word
);
819 complete_on_enum (tracker
, linespec_keywords
, keyword
, keyword
);
822 else if (wordlen
> 0 && keyword
[-1] == ' ')
824 /* Assume that we're maybe past the explicit location
825 argument, and we didn't manage to find any match because
826 the user wants to create a pending breakpoint. Offer the
827 keyword and explicit location options as possible
829 tracker
.advance_custom_word_point_by (keyword
- word
);
830 complete_on_enum (tracker
, linespec_keywords
, keyword
, keyword
);
831 complete_on_enum (tracker
, explicit_options
, keyword
, keyword
);
836 /* If the next word in *TEXT_P is any of the keywords in KEYWORDS,
837 then advance both TEXT_P and the word point in the tracker past the
838 keyword and return the (0-based) index in the KEYWORDS array that
839 matched. Otherwise, return -1. */
842 skip_keyword (completion_tracker
&tracker
,
843 const char * const *keywords
, const char **text_p
)
845 const char *text
= *text_p
;
846 const char *after
= skip_to_space (text
);
847 size_t len
= after
- text
;
849 if (text
[len
] != ' ')
853 for (int i
= 0; keywords
[i
] != NULL
; i
++)
855 if (strncmp (keywords
[i
], text
, len
) == 0)
866 tracker
.advance_custom_word_point_by (len
+ 1);
875 /* A completer function for explicit locations. This function
876 completes both options ("-source", "-line", etc) and values. If
877 completing a quoted string, then QUOTED_ARG_START and
878 QUOTED_ARG_END point to the quote characters. LANGUAGE is the
882 complete_explicit_location (completion_tracker
&tracker
,
883 struct event_location
*location
,
885 const language_defn
*language
,
886 const char *quoted_arg_start
,
887 const char *quoted_arg_end
)
892 int keyword
= skip_keyword (tracker
, explicit_options
, &text
);
895 complete_on_enum (tracker
, explicit_options
, text
, text
);
898 /* Completing on value. */
899 enum explicit_location_match_type what
900 = (explicit_location_match_type
) keyword
;
902 if (quoted_arg_start
!= NULL
&& quoted_arg_end
!= NULL
)
904 if (quoted_arg_end
[1] == '\0')
906 /* If completing a quoted string with the cursor right
907 at the terminating quote char, complete the
908 completion word without interpretation, so that
909 readline advances the cursor one whitespace past the
910 quote, even if there's no match. This makes these
911 cases behave the same:
913 before: "b -function function()"
914 after: "b -function function() "
916 before: "b -function 'function()'"
917 after: "b -function 'function()' "
919 and trusts the user in this case:
921 before: "b -function 'not_loaded_function_yet()'"
922 after: "b -function 'not_loaded_function_yet()' "
924 tracker
.add_completion (make_unique_xstrdup (text
));
926 else if (quoted_arg_end
[1] == ' ')
928 /* We're maybe past the explicit location argument.
929 Skip the argument without interpretation, assuming the
930 user may want to create pending breakpoint. Offer
931 the keyword and explicit location options as possible
933 tracker
.advance_custom_word_point_by (strlen (text
));
934 complete_on_enum (tracker
, linespec_keywords
, "", "");
935 complete_on_enum (tracker
, explicit_options
, "", "");
940 /* Now gather matches */
941 collect_explicit_location_matches (tracker
, location
, what
, text
,
946 /* A completer for locations. */
949 location_completer (struct cmd_list_element
*ignore
,
950 completion_tracker
&tracker
,
951 const char *text
, const char * /* word */)
953 int found_probe_option
= -1;
955 /* If we have a probe modifier, skip it. This can only appear as
956 first argument. Until we have a specific completer for probes,
957 falling back to the linespec completer for the remainder of the
958 line is better than nothing. */
959 if (text
[0] == '-' && text
[1] == 'p')
960 found_probe_option
= skip_keyword (tracker
, probe_options
, &text
);
962 const char *option_text
= text
;
963 int saved_word_point
= tracker
.custom_word_point ();
965 const char *copy
= text
;
967 explicit_completion_info completion_info
;
968 event_location_up location
969 = string_to_explicit_location (©
, current_language
,
971 if (completion_info
.quoted_arg_start
!= NULL
972 && completion_info
.quoted_arg_end
== NULL
)
974 /* Found an unbalanced quote. */
975 tracker
.set_quote_char (*completion_info
.quoted_arg_start
);
976 tracker
.advance_custom_word_point_by (1);
979 if (completion_info
.saw_explicit_location_option
)
983 tracker
.advance_custom_word_point_by (copy
- text
);
986 /* We found a terminator at the tail end of the string,
987 which means we're past the explicit location options. We
988 may have a keyword to complete on. If we have a whole
989 keyword, then complete whatever comes after as an
990 expression. This is mainly for the "if" keyword. If the
991 "thread" and "task" keywords gain their own completers,
992 they should be used here. */
993 int keyword
= skip_keyword (tracker
, linespec_keywords
, &text
);
997 complete_on_enum (tracker
, linespec_keywords
, text
, text
);
1002 = advance_to_expression_complete_word_point (tracker
, text
);
1003 complete_expression (tracker
, text
, word
);
1008 tracker
.advance_custom_word_point_by (completion_info
.last_option
1010 text
= completion_info
.last_option
;
1012 complete_explicit_location (tracker
, location
.get (), text
,
1014 completion_info
.quoted_arg_start
,
1015 completion_info
.quoted_arg_end
);
1019 /* This is an address or linespec location. */
1020 else if (location
!= NULL
)
1022 /* Handle non-explicit location options. */
1024 int keyword
= skip_keyword (tracker
, explicit_options
, &text
);
1026 complete_on_enum (tracker
, explicit_options
, text
, text
);
1029 tracker
.advance_custom_word_point_by (copy
- text
);
1032 symbol_name_match_type match_type
1033 = get_explicit_location (location
.get ())->func_name_match_type
;
1034 complete_address_and_linespec_locations (tracker
, text
, match_type
);
1040 complete_address_and_linespec_locations (tracker
, text
,
1041 symbol_name_match_type::WILD
);
1044 /* Add matches for option names, if either:
1046 - Some completer above found some matches, but the word point did
1047 not advance (e.g., "b <tab>" finds all functions, or "b -<tab>"
1048 matches all objc selectors), or;
1050 - Some completer above advanced the word point, but found no
1053 if ((text
[0] == '-' || text
[0] == '\0')
1054 && (!tracker
.have_completions ()
1055 || tracker
.custom_word_point () == saved_word_point
))
1057 tracker
.set_custom_word_point (saved_word_point
);
1060 if (found_probe_option
== -1)
1061 complete_on_enum (tracker
, probe_options
, text
, text
);
1062 complete_on_enum (tracker
, explicit_options
, text
, text
);
1066 /* The corresponding completer_handle_brkchars
1070 location_completer_handle_brkchars (struct cmd_list_element
*ignore
,
1071 completion_tracker
&tracker
,
1073 const char *word_ignored
)
1075 tracker
.set_use_custom_word_point (true);
1077 location_completer (ignore
, tracker
, text
, NULL
);
1080 /* Helper for expression_completer which recursively adds field and
1081 method names from TYPE, a struct or union type, to the OUTPUT
1085 add_struct_fields (struct type
*type
, completion_list
&output
,
1086 const char *fieldname
, int namelen
)
1089 int computed_type_name
= 0;
1090 const char *type_name
= NULL
;
1092 type
= check_typedef (type
);
1093 for (i
= 0; i
< TYPE_NFIELDS (type
); ++i
)
1095 if (i
< TYPE_N_BASECLASSES (type
))
1096 add_struct_fields (TYPE_BASECLASS (type
, i
),
1097 output
, fieldname
, namelen
);
1098 else if (TYPE_FIELD_NAME (type
, i
))
1100 if (TYPE_FIELD_NAME (type
, i
)[0] != '\0')
1102 if (! strncmp (TYPE_FIELD_NAME (type
, i
),
1103 fieldname
, namelen
))
1104 output
.emplace_back (xstrdup (TYPE_FIELD_NAME (type
, i
)));
1106 else if (TYPE_CODE (TYPE_FIELD_TYPE (type
, i
)) == TYPE_CODE_UNION
)
1108 /* Recurse into anonymous unions. */
1109 add_struct_fields (TYPE_FIELD_TYPE (type
, i
),
1110 output
, fieldname
, namelen
);
1115 for (i
= TYPE_NFN_FIELDS (type
) - 1; i
>= 0; --i
)
1117 const char *name
= TYPE_FN_FIELDLIST_NAME (type
, i
);
1119 if (name
&& ! strncmp (name
, fieldname
, namelen
))
1121 if (!computed_type_name
)
1123 type_name
= TYPE_NAME (type
);
1124 computed_type_name
= 1;
1126 /* Omit constructors from the completion list. */
1127 if (!type_name
|| strcmp (type_name
, name
))
1128 output
.emplace_back (xstrdup (name
));
1133 /* See completer.h. */
1136 complete_expression (completion_tracker
&tracker
,
1137 const char *text
, const char *word
)
1139 struct type
*type
= NULL
;
1140 gdb::unique_xmalloc_ptr
<char> fieldname
;
1141 enum type_code code
= TYPE_CODE_UNDEF
;
1143 /* Perform a tentative parse of the expression, to see whether a
1144 field completion is required. */
1147 type
= parse_expression_for_completion (text
, &fieldname
, &code
);
1149 catch (const gdb_exception_error
&except
)
1154 if (fieldname
!= nullptr && type
)
1158 type
= check_typedef (type
);
1159 if (TYPE_CODE (type
) != TYPE_CODE_PTR
&& !TYPE_IS_REFERENCE (type
))
1161 type
= TYPE_TARGET_TYPE (type
);
1164 if (TYPE_CODE (type
) == TYPE_CODE_UNION
1165 || TYPE_CODE (type
) == TYPE_CODE_STRUCT
)
1167 completion_list result
;
1169 add_struct_fields (type
, result
, fieldname
.get (),
1170 strlen (fieldname
.get ()));
1171 tracker
.add_completions (std::move (result
));
1175 else if (fieldname
!= nullptr && code
!= TYPE_CODE_UNDEF
)
1177 collect_symbol_completion_matches_type (tracker
, fieldname
.get (),
1178 fieldname
.get (), code
);
1182 complete_files_symbols (tracker
, text
, word
);
1185 /* Complete on expressions. Often this means completing on symbol
1186 names, but some language parsers also have support for completing
1190 expression_completer (struct cmd_list_element
*ignore
,
1191 completion_tracker
&tracker
,
1192 const char *text
, const char *word
)
1194 complete_expression (tracker
, text
, word
);
1197 /* See definition in completer.h. */
1200 set_rl_completer_word_break_characters (const char *break_chars
)
1202 rl_completer_word_break_characters
= (char *) break_chars
;
1205 /* Complete on symbols. */
1208 symbol_completer (struct cmd_list_element
*ignore
,
1209 completion_tracker
&tracker
,
1210 const char *text
, const char *word
)
1212 collect_symbol_completion_matches (tracker
, complete_symbol_mode::EXPRESSION
,
1213 symbol_name_match_type::EXPRESSION
,
1217 /* Here are some useful test cases for completion. FIXME: These
1218 should be put in the test suite. They should be tested with both
1221 "show output-" "radix"
1222 "show output" "-radix"
1223 "p" ambiguous (commands starting with p--path, print, printf, etc.)
1224 "p " ambiguous (all symbols)
1225 "info t foo" no completions
1226 "info t " no completions
1227 "info t" ambiguous ("info target", "info terminal", etc.)
1228 "info ajksdlfk" no completions
1229 "info ajksdlfk " no completions
1231 "info " ambiguous (all info commands)
1232 "p \"a" no completions (string constant)
1233 "p 'a" ambiguous (all symbols starting with a)
1234 "p b-a" ambiguous (all symbols starting with a)
1235 "p b-" ambiguous (all symbols)
1236 "file Make" "file" (word break hard to screw up here)
1237 "file ../gdb.stabs/we" "ird" (needs to not break word at slash)
1240 enum complete_line_internal_reason
1242 /* Preliminary phase, called by gdb_completion_word_break_characters
1243 function, is used to either:
1245 #1 - Determine the set of chars that are word delimiters
1246 depending on the current command in line_buffer.
1248 #2 - Manually advance RL_POINT to the "word break" point instead
1249 of letting readline do it (based on too-simple character
1252 Simpler completers that just pass a brkchars array to readline
1253 (#1 above) must defer generating the completions to the main
1254 phase (below). No completion list should be generated in this
1257 OTOH, completers that manually advance the word point(#2 above)
1258 must set "use_custom_word_point" in the tracker and generate
1259 their completion in this phase. Note that this is the convenient
1260 thing to do since they'll be parsing the input line anyway. */
1263 /* Main phase, called by complete_line function, is used to get the
1264 list of possible completions. */
1267 /* Special case when completing a 'help' command. In this case,
1268 once sub-command completions are exhausted, we simply return
1273 /* Helper for complete_line_internal to simplify it. */
1276 complete_line_internal_normal_command (completion_tracker
&tracker
,
1277 const char *command
, const char *word
,
1278 const char *cmd_args
,
1279 complete_line_internal_reason reason
,
1280 struct cmd_list_element
*c
)
1282 const char *p
= cmd_args
;
1284 if (c
->completer
== filename_completer
)
1286 /* Many commands which want to complete on file names accept
1287 several file names, as in "run foo bar >>baz". So we don't
1288 want to complete the entire text after the command, just the
1289 last word. To this end, we need to find the beginning of the
1290 file name by starting at `word' and going backwards. */
1293 && strchr (gdb_completer_file_name_break_characters
,
1299 if (reason
== handle_brkchars
)
1301 completer_handle_brkchars_ftype
*brkchars_fn
;
1303 if (c
->completer_handle_brkchars
!= NULL
)
1304 brkchars_fn
= c
->completer_handle_brkchars
;
1308 = (completer_handle_brkchars_func_for_completer
1312 brkchars_fn (c
, tracker
, p
, word
);
1315 if (reason
!= handle_brkchars
&& c
->completer
!= NULL
)
1316 (*c
->completer
) (c
, tracker
, p
, word
);
1319 /* Internal function used to handle completions.
1322 TEXT is the caller's idea of the "word" we are looking at.
1324 LINE_BUFFER is available to be looked at; it contains the entire
1325 text of the line. POINT is the offset in that line of the cursor.
1326 You should pretend that the line ends at POINT.
1328 See complete_line_internal_reason for description of REASON. */
1331 complete_line_internal_1 (completion_tracker
&tracker
,
1333 const char *line_buffer
, int point
,
1334 complete_line_internal_reason reason
)
1338 int ignore_help_classes
;
1339 /* Pointer within tmp_command which corresponds to text. */
1341 struct cmd_list_element
*c
, *result_list
;
1343 /* Choose the default set of word break characters to break
1344 completions. If we later find out that we are doing completions
1345 on command strings (as opposed to strings supplied by the
1346 individual command completer functions, which can be any string)
1347 then we will switch to the special word break set for command
1348 strings, which leaves out the '-' and '.' character used in some
1350 set_rl_completer_word_break_characters
1351 (current_language
->la_word_break_characters());
1353 /* Decide whether to complete on a list of gdb commands or on
1355 tmp_command
= (char *) alloca (point
+ 1);
1358 /* The help command should complete help aliases. */
1359 ignore_help_classes
= reason
!= handle_help
;
1361 strncpy (tmp_command
, line_buffer
, point
);
1362 tmp_command
[point
] = '\0';
1363 if (reason
== handle_brkchars
)
1365 gdb_assert (text
== NULL
);
1370 /* Since text always contains some number of characters leading up
1371 to point, we can find the equivalent position in tmp_command
1372 by subtracting that many characters from the end of tmp_command. */
1373 word
= tmp_command
+ point
- strlen (text
);
1376 /* Move P up to the start of the command. */
1377 p
= skip_spaces (p
);
1381 /* An empty line is ambiguous; that is, it could be any
1383 c
= CMD_LIST_AMBIGUOUS
;
1388 c
= lookup_cmd_1 (&p
, cmdlist
, &result_list
, ignore_help_classes
);
1391 /* Move p up to the next interesting thing. */
1392 while (*p
== ' ' || *p
== '\t')
1397 tracker
.advance_custom_word_point_by (p
- tmp_command
);
1401 /* It is an unrecognized command. So there are no
1402 possible completions. */
1404 else if (c
== CMD_LIST_AMBIGUOUS
)
1408 /* lookup_cmd_1 advances p up to the first ambiguous thing, but
1409 doesn't advance over that thing itself. Do so now. */
1411 while (valid_cmd_char_p (*q
))
1413 if (q
!= tmp_command
+ point
)
1415 /* There is something beyond the ambiguous
1416 command, so there are no possible completions. For
1417 example, "info t " or "info t foo" does not complete
1418 to anything, because "info t" can be "info target" or
1423 /* We're trying to complete on the command which was ambiguous.
1424 This we can deal with. */
1427 if (reason
!= handle_brkchars
)
1428 complete_on_cmdlist (*result_list
->prefixlist
, tracker
, p
,
1429 word
, ignore_help_classes
);
1433 if (reason
!= handle_brkchars
)
1434 complete_on_cmdlist (cmdlist
, tracker
, p
, word
,
1435 ignore_help_classes
);
1437 /* Ensure that readline does the right thing with respect to
1438 inserting quotes. */
1439 set_rl_completer_word_break_characters
1440 (gdb_completer_command_word_break_characters
);
1445 /* We've recognized a full command. */
1447 if (p
== tmp_command
+ point
)
1449 /* There is no non-whitespace in the line beyond the
1452 if (p
[-1] == ' ' || p
[-1] == '\t')
1454 /* The command is followed by whitespace; we need to
1455 complete on whatever comes after command. */
1458 /* It is a prefix command; what comes after it is
1459 a subcommand (e.g. "info "). */
1460 if (reason
!= handle_brkchars
)
1461 complete_on_cmdlist (*c
->prefixlist
, tracker
, p
, word
,
1462 ignore_help_classes
);
1464 /* Ensure that readline does the right thing
1465 with respect to inserting quotes. */
1466 set_rl_completer_word_break_characters
1467 (gdb_completer_command_word_break_characters
);
1469 else if (reason
== handle_help
)
1473 if (reason
!= handle_brkchars
)
1474 complete_on_enum (tracker
, c
->enums
, p
, word
);
1475 set_rl_completer_word_break_characters
1476 (gdb_completer_command_word_break_characters
);
1480 /* It is a normal command; what comes after it is
1481 completed by the command's completer function. */
1482 complete_line_internal_normal_command (tracker
,
1483 tmp_command
, word
, p
,
1489 /* The command is not followed by whitespace; we need to
1490 complete on the command itself, e.g. "p" which is a
1491 command itself but also can complete to "print", "ptype"
1495 /* Find the command we are completing on. */
1497 while (q
> tmp_command
)
1499 if (valid_cmd_char_p (q
[-1]))
1505 /* Move the custom word point back too. */
1506 tracker
.advance_custom_word_point_by (q
- p
);
1508 if (reason
!= handle_brkchars
)
1509 complete_on_cmdlist (result_list
, tracker
, q
, word
,
1510 ignore_help_classes
);
1512 /* Ensure that readline does the right thing
1513 with respect to inserting quotes. */
1514 set_rl_completer_word_break_characters
1515 (gdb_completer_command_word_break_characters
);
1518 else if (reason
== handle_help
)
1522 /* There is non-whitespace beyond the command. */
1524 if (c
->prefixlist
&& !c
->allow_unknown
)
1526 /* It is an unrecognized subcommand of a prefix command,
1527 e.g. "info adsfkdj". */
1531 if (reason
!= handle_brkchars
)
1532 complete_on_enum (tracker
, c
->enums
, p
, word
);
1536 /* It is a normal command. */
1537 complete_line_internal_normal_command (tracker
,
1538 tmp_command
, word
, p
,
1545 /* Wrapper around complete_line_internal_1 to handle
1546 MAX_COMPLETIONS_REACHED_ERROR. */
1549 complete_line_internal (completion_tracker
&tracker
,
1551 const char *line_buffer
, int point
,
1552 complete_line_internal_reason reason
)
1556 complete_line_internal_1 (tracker
, text
, line_buffer
, point
, reason
);
1558 catch (const gdb_exception_error
&except
)
1560 if (except
.error
!= MAX_COMPLETIONS_REACHED_ERROR
)
1565 /* See completer.h. */
1567 int max_completions
= 200;
1569 /* Initial size of the table. It automagically grows from here. */
1570 #define INITIAL_COMPLETION_HTAB_SIZE 200
1572 /* See completer.h. */
1574 completion_tracker::completion_tracker ()
1576 discard_completions ();
1579 /* See completer.h. */
1582 completion_tracker::discard_completions ()
1584 xfree (m_lowest_common_denominator
);
1585 m_lowest_common_denominator
= NULL
;
1587 m_lowest_common_denominator_unique
= false;
1588 m_lowest_common_denominator_valid
= false;
1590 /* A null check here allows this function to be used from the
1592 if (m_entries_hash
!= NULL
)
1593 htab_delete (m_entries_hash
);
1595 /* A callback used by the hash table to compare new entries with existing
1596 entries. We can't use the standard streq_hash function here as the
1597 key to our hash is just a single string, while the values we store in
1598 the hash are a struct containing multiple strings. */
1599 static auto entry_eq_func
1600 = [] (const void *first
, const void *second
) -> int
1602 /* The FIRST argument is the entry already in the hash table, and
1603 the SECOND argument is the new item being inserted. */
1604 const completion_hash_entry
*entry
1605 = (const completion_hash_entry
*) first
;
1606 const char *name_str
= (const char *) second
;
1608 return entry
->is_name_eq (name_str
);
1611 /* Callback used by the hash table to compute the hash value for an
1612 existing entry. This is needed when expanding the hash table. */
1613 static auto entry_hash_func
1614 = [] (const void *arg
) -> hashval_t
1616 const completion_hash_entry
*entry
1617 = (const completion_hash_entry
*) arg
;
1618 return entry
->hash_name ();
1621 m_entries_hash
= htab_create_alloc (INITIAL_COMPLETION_HTAB_SIZE
,
1622 entry_hash_func
, entry_eq_func
,
1623 completion_hash_entry::deleter
,
1627 /* See completer.h. */
1629 completion_tracker::~completion_tracker ()
1631 xfree (m_lowest_common_denominator
);
1632 htab_delete (m_entries_hash
);
1635 /* See completer.h. */
1638 completion_tracker::maybe_add_completion
1639 (gdb::unique_xmalloc_ptr
<char> name
,
1640 completion_match_for_lcd
*match_for_lcd
,
1641 const char *text
, const char *word
)
1645 if (max_completions
== 0)
1648 if (htab_elements (m_entries_hash
) >= max_completions
)
1651 hashval_t hash
= htab_hash_string (name
.get ());
1652 slot
= htab_find_slot_with_hash (m_entries_hash
, name
.get (), hash
, INSERT
);
1653 if (*slot
== HTAB_EMPTY_ENTRY
)
1655 const char *match_for_lcd_str
= NULL
;
1657 if (match_for_lcd
!= NULL
)
1658 match_for_lcd_str
= match_for_lcd
->finish ();
1660 if (match_for_lcd_str
== NULL
)
1661 match_for_lcd_str
= name
.get ();
1663 gdb::unique_xmalloc_ptr
<char> lcd
1664 = make_completion_match_str (match_for_lcd_str
, text
, word
);
1666 size_t lcd_len
= strlen (lcd
.get ());
1667 *slot
= new completion_hash_entry (std::move (name
), std::move (lcd
));
1669 m_lowest_common_denominator_valid
= false;
1670 m_lowest_common_denominator_max_length
1671 = std::max (m_lowest_common_denominator_max_length
, lcd_len
);
1677 /* See completer.h. */
1680 completion_tracker::add_completion (gdb::unique_xmalloc_ptr
<char> name
,
1681 completion_match_for_lcd
*match_for_lcd
,
1682 const char *text
, const char *word
)
1684 if (!maybe_add_completion (std::move (name
), match_for_lcd
, text
, word
))
1685 throw_error (MAX_COMPLETIONS_REACHED_ERROR
, _("Max completions reached."));
1688 /* See completer.h. */
1691 completion_tracker::add_completions (completion_list
&&list
)
1693 for (auto &candidate
: list
)
1694 add_completion (std::move (candidate
));
1697 /* See completer.h. */
1700 completion_tracker::remove_completion (const char *name
)
1702 hashval_t hash
= htab_hash_string (name
);
1703 if (htab_find_slot_with_hash (m_entries_hash
, name
, hash
, NO_INSERT
)
1706 htab_remove_elt_with_hash (m_entries_hash
, name
, hash
);
1707 m_lowest_common_denominator_valid
= false;
1711 /* Helper for the make_completion_match_str overloads. Returns NULL
1712 as an indication that we want MATCH_NAME exactly. It is up to the
1713 caller to xstrdup that string if desired. */
1716 make_completion_match_str_1 (const char *match_name
,
1717 const char *text
, const char *word
)
1723 /* Return NULL as an indication that we want MATCH_NAME
1727 else if (word
> text
)
1729 /* Return some portion of MATCH_NAME. */
1730 newobj
= xstrdup (match_name
+ (word
- text
));
1734 /* Return some of WORD plus MATCH_NAME. */
1735 size_t len
= strlen (match_name
);
1736 newobj
= (char *) xmalloc (text
- word
+ len
+ 1);
1737 memcpy (newobj
, word
, text
- word
);
1738 memcpy (newobj
+ (text
- word
), match_name
, len
+ 1);
1744 /* See completer.h. */
1746 gdb::unique_xmalloc_ptr
<char>
1747 make_completion_match_str (const char *match_name
,
1748 const char *text
, const char *word
)
1750 char *newobj
= make_completion_match_str_1 (match_name
, text
, word
);
1752 newobj
= xstrdup (match_name
);
1753 return gdb::unique_xmalloc_ptr
<char> (newobj
);
1756 /* See completer.h. */
1758 gdb::unique_xmalloc_ptr
<char>
1759 make_completion_match_str (gdb::unique_xmalloc_ptr
<char> &&match_name
,
1760 const char *text
, const char *word
)
1762 char *newobj
= make_completion_match_str_1 (match_name
.get (), text
, word
);
1764 return std::move (match_name
);
1765 return gdb::unique_xmalloc_ptr
<char> (newobj
);
1768 /* See complete.h. */
1771 complete (const char *line
, char const **word
, int *quote_char
)
1773 completion_tracker tracker_handle_brkchars
;
1774 completion_tracker tracker_handle_completions
;
1775 completion_tracker
*tracker
;
1777 /* The WORD should be set to the end of word to complete. We initialize
1778 to the completion point which is assumed to be at the end of LINE.
1779 This leaves WORD to be initialized to a sensible value in cases
1780 completion_find_completion_word() fails i.e., throws an exception.
1782 *word
= line
+ strlen (line
);
1786 *word
= completion_find_completion_word (tracker_handle_brkchars
,
1789 /* Completers that provide a custom word point in the
1790 handle_brkchars phase also compute their completions then.
1791 Completers that leave the completion word handling to readline
1792 must be called twice. */
1793 if (tracker_handle_brkchars
.use_custom_word_point ())
1794 tracker
= &tracker_handle_brkchars
;
1797 complete_line (tracker_handle_completions
, *word
, line
, strlen (line
));
1798 tracker
= &tracker_handle_completions
;
1801 catch (const gdb_exception
&ex
)
1806 return tracker
->build_completion_result (*word
, *word
- line
, strlen (line
));
1810 /* Generate completions all at once. Does nothing if max_completions
1811 is 0. If max_completions is non-negative, this will collect at
1812 most max_completions strings.
1814 TEXT is the caller's idea of the "word" we are looking at.
1816 LINE_BUFFER is available to be looked at; it contains the entire
1819 POINT is the offset in that line of the cursor. You
1820 should pretend that the line ends at POINT. */
1823 complete_line (completion_tracker
&tracker
,
1824 const char *text
, const char *line_buffer
, int point
)
1826 if (max_completions
== 0)
1828 complete_line_internal (tracker
, text
, line_buffer
, point
,
1829 handle_completions
);
1832 /* Complete on command names. Used by "help". */
1835 command_completer (struct cmd_list_element
*ignore
,
1836 completion_tracker
&tracker
,
1837 const char *text
, const char *word
)
1839 complete_line_internal (tracker
, word
, text
,
1840 strlen (text
), handle_help
);
1843 /* The corresponding completer_handle_brkchars implementation. */
1846 command_completer_handle_brkchars (struct cmd_list_element
*ignore
,
1847 completion_tracker
&tracker
,
1848 const char *text
, const char *word
)
1850 set_rl_completer_word_break_characters
1851 (gdb_completer_command_word_break_characters
);
1854 /* Complete on signals. */
1857 signal_completer (struct cmd_list_element
*ignore
,
1858 completion_tracker
&tracker
,
1859 const char *text
, const char *word
)
1861 size_t len
= strlen (word
);
1863 const char *signame
;
1865 for (signum
= GDB_SIGNAL_FIRST
; signum
!= GDB_SIGNAL_LAST
; ++signum
)
1867 /* Can't handle this, so skip it. */
1868 if (signum
== GDB_SIGNAL_0
)
1871 signame
= gdb_signal_to_name ((enum gdb_signal
) signum
);
1873 /* Ignore the unknown signal case. */
1874 if (!signame
|| strcmp (signame
, "?") == 0)
1877 if (strncasecmp (signame
, word
, len
) == 0)
1878 tracker
.add_completion (make_unique_xstrdup (signame
));
1882 /* Bit-flags for selecting what the register and/or register-group
1883 completer should complete on. */
1885 enum reg_completer_target
1887 complete_register_names
= 0x1,
1888 complete_reggroup_names
= 0x2
1890 DEF_ENUM_FLAGS_TYPE (enum reg_completer_target
, reg_completer_targets
);
1892 /* Complete register names and/or reggroup names based on the value passed
1893 in TARGETS. At least one bit in TARGETS must be set. */
1896 reg_or_group_completer_1 (completion_tracker
&tracker
,
1897 const char *text
, const char *word
,
1898 reg_completer_targets targets
)
1900 size_t len
= strlen (word
);
1901 struct gdbarch
*gdbarch
;
1904 gdb_assert ((targets
& (complete_register_names
1905 | complete_reggroup_names
)) != 0);
1906 gdbarch
= get_current_arch ();
1908 if ((targets
& complete_register_names
) != 0)
1913 (name
= user_reg_map_regnum_to_name (gdbarch
, i
)) != NULL
;
1916 if (*name
!= '\0' && strncmp (word
, name
, len
) == 0)
1917 tracker
.add_completion (make_unique_xstrdup (name
));
1921 if ((targets
& complete_reggroup_names
) != 0)
1923 struct reggroup
*group
;
1925 for (group
= reggroup_next (gdbarch
, NULL
);
1927 group
= reggroup_next (gdbarch
, group
))
1929 name
= reggroup_name (group
);
1930 if (strncmp (word
, name
, len
) == 0)
1931 tracker
.add_completion (make_unique_xstrdup (name
));
1936 /* Perform completion on register and reggroup names. */
1939 reg_or_group_completer (struct cmd_list_element
*ignore
,
1940 completion_tracker
&tracker
,
1941 const char *text
, const char *word
)
1943 reg_or_group_completer_1 (tracker
, text
, word
,
1944 (complete_register_names
1945 | complete_reggroup_names
));
1948 /* Perform completion on reggroup names. */
1951 reggroup_completer (struct cmd_list_element
*ignore
,
1952 completion_tracker
&tracker
,
1953 const char *text
, const char *word
)
1955 reg_or_group_completer_1 (tracker
, text
, word
,
1956 complete_reggroup_names
);
1959 /* The default completer_handle_brkchars implementation. */
1962 default_completer_handle_brkchars (struct cmd_list_element
*ignore
,
1963 completion_tracker
&tracker
,
1964 const char *text
, const char *word
)
1966 set_rl_completer_word_break_characters
1967 (current_language
->la_word_break_characters ());
1970 /* See definition in completer.h. */
1972 completer_handle_brkchars_ftype
*
1973 completer_handle_brkchars_func_for_completer (completer_ftype
*fn
)
1975 if (fn
== filename_completer
)
1976 return filename_completer_handle_brkchars
;
1978 if (fn
== location_completer
)
1979 return location_completer_handle_brkchars
;
1981 if (fn
== command_completer
)
1982 return command_completer_handle_brkchars
;
1984 return default_completer_handle_brkchars
;
1987 /* Used as brkchars when we want to tell readline we have a custom
1988 word point. We do that by making our rl_completion_word_break_hook
1989 set RL_POINT to the desired word point, and return the character at
1990 the word break point as the break char. This is two bytes in order
1991 to fit one break character plus the terminating null. */
1992 static char gdb_custom_word_point_brkchars
[2];
1994 /* Since rl_basic_quote_characters is not completer-specific, we save
1995 its original value here, in order to be able to restore it in
1996 gdb_rl_attempted_completion_function. */
1997 static const char *gdb_org_rl_basic_quote_characters
= rl_basic_quote_characters
;
1999 /* Get the list of chars that are considered as word breaks
2000 for the current command. */
2003 gdb_completion_word_break_characters_throw ()
2005 /* New completion starting. Get rid of the previous tracker and
2007 delete current_completion
.tracker
;
2008 current_completion
.tracker
= new completion_tracker ();
2010 completion_tracker
&tracker
= *current_completion
.tracker
;
2012 complete_line_internal (tracker
, NULL
, rl_line_buffer
,
2013 rl_point
, handle_brkchars
);
2015 if (tracker
.use_custom_word_point ())
2017 gdb_assert (tracker
.custom_word_point () > 0);
2018 rl_point
= tracker
.custom_word_point () - 1;
2020 gdb_assert (rl_point
>= 0 && rl_point
< strlen (rl_line_buffer
));
2022 gdb_custom_word_point_brkchars
[0] = rl_line_buffer
[rl_point
];
2023 rl_completer_word_break_characters
= gdb_custom_word_point_brkchars
;
2024 rl_completer_quote_characters
= NULL
;
2026 /* Clear this too, so that if we're completing a quoted string,
2027 readline doesn't consider the quote character a delimiter.
2028 If we didn't do this, readline would auto-complete {b
2029 'fun<tab>} to {'b 'function()'}, i.e., add the terminating
2030 \', but, it wouldn't append the separator space either, which
2031 is not desirable. So instead we take care of appending the
2032 quote character to the LCD ourselves, in
2033 gdb_rl_attempted_completion_function. Since this global is
2034 not just completer-specific, we'll restore it back to the
2035 default in gdb_rl_attempted_completion_function. */
2036 rl_basic_quote_characters
= NULL
;
2039 return rl_completer_word_break_characters
;
2043 gdb_completion_word_break_characters ()
2045 /* New completion starting. */
2046 current_completion
.aborted
= false;
2050 return gdb_completion_word_break_characters_throw ();
2052 catch (const gdb_exception
&ex
)
2054 /* Set this to that gdb_rl_attempted_completion_function knows
2056 current_completion
.aborted
= true;
2062 /* See completer.h. */
2065 completion_find_completion_word (completion_tracker
&tracker
, const char *text
,
2068 size_t point
= strlen (text
);
2070 complete_line_internal (tracker
, NULL
, text
, point
, handle_brkchars
);
2072 if (tracker
.use_custom_word_point ())
2074 gdb_assert (tracker
.custom_word_point () > 0);
2075 *quote_char
= tracker
.quote_char ();
2076 return text
+ tracker
.custom_word_point ();
2079 gdb_rl_completion_word_info info
;
2081 info
.word_break_characters
= rl_completer_word_break_characters
;
2082 info
.quote_characters
= gdb_completer_quote_characters
;
2083 info
.basic_quote_characters
= rl_basic_quote_characters
;
2085 return gdb_rl_find_completion_word (&info
, quote_char
, NULL
, text
);
2088 /* See completer.h. */
2091 completion_tracker::recompute_lcd_visitor (completion_hash_entry
*entry
)
2093 if (!m_lowest_common_denominator_valid
)
2095 /* This is the first lowest common denominator that we are
2096 considering, just copy it in. */
2097 strcpy (m_lowest_common_denominator
, entry
->get_lcd ());
2098 m_lowest_common_denominator_unique
= true;
2099 m_lowest_common_denominator_valid
= true;
2103 /* Find the common denominator between the currently-known lowest
2104 common denominator and NEW_MATCH_UP. That becomes the new lowest
2105 common denominator. */
2107 const char *new_match
= entry
->get_lcd ();
2110 (new_match
[i
] != '\0'
2111 && new_match
[i
] == m_lowest_common_denominator
[i
]);
2114 if (m_lowest_common_denominator
[i
] != new_match
[i
])
2116 m_lowest_common_denominator
[i
] = '\0';
2117 m_lowest_common_denominator_unique
= false;
2122 /* See completer.h. */
2125 completion_tracker::recompute_lowest_common_denominator ()
2127 /* We've already done this. */
2128 if (m_lowest_common_denominator_valid
)
2131 /* Resize the storage to ensure we have enough space, the plus one gives
2132 us space for the trailing null terminator we will include. */
2133 m_lowest_common_denominator
2134 = (char *) xrealloc (m_lowest_common_denominator
,
2135 m_lowest_common_denominator_max_length
+ 1);
2137 /* Callback used to visit each entry in the m_entries_hash. */
2139 = [] (void **slot
, void *info
) -> int
2141 completion_tracker
*obj
= (completion_tracker
*) info
;
2142 completion_hash_entry
*entry
= (completion_hash_entry
*) *slot
;
2143 obj
->recompute_lcd_visitor (entry
);
2147 htab_traverse (m_entries_hash
, visitor_func
, this);
2148 m_lowest_common_denominator_valid
= true;
2151 /* See completer.h. */
2154 completion_tracker::advance_custom_word_point_by (int len
)
2156 m_custom_word_point
+= len
;
2159 /* Build a new C string that is a copy of LCD with the whitespace of
2160 ORIG/ORIG_LEN preserved.
2162 Say the user is completing a symbol name, with spaces, like:
2166 and the resulting completion match is:
2170 we want to end up with an input line like:
2173 ^^^^^^^ => text from LCD [1], whitespace from ORIG preserved.
2174 ^^ => new text from LCD
2176 [1] - We must take characters from the LCD instead of the original
2177 text, since some completions want to change upper/lowercase. E.g.:
2183 "handle SIG[QUIT|etc.]"
2187 expand_preserving_ws (const char *orig
, size_t orig_len
,
2190 const char *p_orig
= orig
;
2191 const char *orig_end
= orig
+ orig_len
;
2192 const char *p_lcd
= lcd
;
2195 while (p_orig
< orig_end
)
2199 while (p_orig
< orig_end
&& *p_orig
== ' ')
2201 p_lcd
= skip_spaces (p_lcd
);
2205 /* Take characters from the LCD instead of the original
2206 text, since some completions change upper/lowercase.
2210 "handle SIG[QUIT|etc.]"
2218 while (*p_lcd
!= '\0')
2221 return xstrdup (res
.c_str ());
2224 /* See completer.h. */
2227 completion_tracker::build_completion_result (const char *text
,
2230 size_t element_count
= htab_elements (m_entries_hash
);
2232 if (element_count
== 0)
2235 /* +1 for the LCD, and +1 for NULL termination. */
2236 char **match_list
= XNEWVEC (char *, 1 + element_count
+ 1);
2238 /* Build replacement word, based on the LCD. */
2240 recompute_lowest_common_denominator ();
2242 = expand_preserving_ws (text
, end
- start
,
2243 m_lowest_common_denominator
);
2245 if (m_lowest_common_denominator_unique
)
2247 /* We don't rely on readline appending the quote char as
2248 delimiter as then readline wouldn't append the ' ' after the
2250 char buf
[2] = { (char) quote_char () };
2252 match_list
[0] = reconcat (match_list
[0], match_list
[0],
2253 buf
, (char *) NULL
);
2254 match_list
[1] = NULL
;
2256 /* If the tracker wants to, or we already have a space at the
2257 end of the match, tell readline to skip appending
2259 bool completion_suppress_append
2260 = (suppress_append_ws ()
2261 || match_list
[0][strlen (match_list
[0]) - 1] == ' ');
2263 return completion_result (match_list
, 1, completion_suppress_append
);
2267 /* State object used while building the completion list. */
2270 list_builder (char **ml
)
2275 /* The list we are filling. */
2278 /* The next index in the list to write to. */
2281 list_builder
builder (match_list
);
2283 /* Visit each entry in m_entries_hash and add it to the completion
2284 list, updating the builder state object. */
2286 = [] (void **slot
, void *info
) -> int
2288 completion_hash_entry
*entry
= (completion_hash_entry
*) *slot
;
2289 list_builder
*state
= (list_builder
*) info
;
2291 state
->match_list
[state
->index
] = entry
->release_name ();
2296 /* Build the completion list and add a null at the end. */
2297 htab_traverse_noresize (m_entries_hash
, func
, &builder
);
2298 match_list
[builder
.index
] = NULL
;
2300 return completion_result (match_list
, builder
.index
- 1, false);
2304 /* See completer.h */
2306 completion_result::completion_result ()
2307 : match_list (NULL
), number_matches (0),
2308 completion_suppress_append (false)
2311 /* See completer.h */
2313 completion_result::completion_result (char **match_list_
,
2314 size_t number_matches_
,
2315 bool completion_suppress_append_
)
2316 : match_list (match_list_
),
2317 number_matches (number_matches_
),
2318 completion_suppress_append (completion_suppress_append_
)
2321 /* See completer.h */
2323 completion_result::~completion_result ()
2325 reset_match_list ();
2328 /* See completer.h */
2330 completion_result::completion_result (completion_result
&&rhs
) noexcept
2331 : match_list (rhs
.match_list
),
2332 number_matches (rhs
.number_matches
)
2334 rhs
.match_list
= NULL
;
2335 rhs
.number_matches
= 0;
2338 /* See completer.h */
2341 completion_result::release_match_list ()
2343 char **ret
= match_list
;
2348 /* See completer.h */
2351 completion_result::sort_match_list ()
2353 if (number_matches
> 1)
2355 /* Element 0 is special (it's the common prefix), leave it
2357 std::sort (&match_list
[1],
2358 &match_list
[number_matches
+ 1],
2363 /* See completer.h */
2366 completion_result::reset_match_list ()
2368 if (match_list
!= NULL
)
2370 for (char **p
= match_list
; *p
!= NULL
; p
++)
2377 /* Helper for gdb_rl_attempted_completion_function, which does most of
2378 the work. This is called by readline to build the match list array
2379 and to determine the lowest common denominator. The real matches
2380 list starts at match[1], while match[0] is the slot holding
2381 readline's idea of the lowest common denominator of all matches,
2382 which is what readline replaces the completion "word" with.
2384 TEXT is the caller's idea of the "word" we are looking at, as
2385 computed in the handle_brkchars phase.
2387 START is the offset from RL_LINE_BUFFER where TEXT starts. END is
2388 the offset from RL_LINE_BUFFER where TEXT ends (i.e., where
2391 You should thus pretend that the line ends at END (relative to
2394 RL_LINE_BUFFER contains the entire text of the line. RL_POINT is
2395 the offset in that line of the cursor. You should pretend that the
2398 Returns NULL if there are no completions. */
2401 gdb_rl_attempted_completion_function_throw (const char *text
, int start
, int end
)
2403 /* Completers that provide a custom word point in the
2404 handle_brkchars phase also compute their completions then.
2405 Completers that leave the completion word handling to readline
2406 must be called twice. If rl_point (i.e., END) is at column 0,
2407 then readline skips the handle_brkchars phase, and so we create a
2408 tracker now in that case too. */
2409 if (end
== 0 || !current_completion
.tracker
->use_custom_word_point ())
2411 delete current_completion
.tracker
;
2412 current_completion
.tracker
= new completion_tracker ();
2414 complete_line (*current_completion
.tracker
, text
,
2415 rl_line_buffer
, rl_point
);
2418 completion_tracker
&tracker
= *current_completion
.tracker
;
2420 completion_result result
2421 = tracker
.build_completion_result (text
, start
, end
);
2423 rl_completion_suppress_append
= result
.completion_suppress_append
;
2424 return result
.release_match_list ();
2427 /* Function installed as "rl_attempted_completion_function" readline
2428 hook. Wrapper around gdb_rl_attempted_completion_function_throw
2429 that catches C++ exceptions, which can't cross readline. */
2432 gdb_rl_attempted_completion_function (const char *text
, int start
, int end
)
2434 /* Restore globals that might have been tweaked in
2435 gdb_completion_word_break_characters. */
2436 rl_basic_quote_characters
= gdb_org_rl_basic_quote_characters
;
2438 /* If we end up returning NULL, either on error, or simple because
2439 there are no matches, inhibit readline's default filename
2441 rl_attempted_completion_over
= 1;
2443 /* If the handle_brkchars phase was aborted, don't try
2445 if (current_completion
.aborted
)
2450 return gdb_rl_attempted_completion_function_throw (text
, start
, end
);
2452 catch (const gdb_exception
&ex
)
2459 /* Skip over the possibly quoted word STR (as defined by the quote
2460 characters QUOTECHARS and the word break characters BREAKCHARS).
2461 Returns pointer to the location after the "word". If either
2462 QUOTECHARS or BREAKCHARS is NULL, use the same values used by the
2466 skip_quoted_chars (const char *str
, const char *quotechars
,
2467 const char *breakchars
)
2469 char quote_char
= '\0';
2472 if (quotechars
== NULL
)
2473 quotechars
= gdb_completer_quote_characters
;
2475 if (breakchars
== NULL
)
2476 breakchars
= current_language
->la_word_break_characters();
2478 for (scan
= str
; *scan
!= '\0'; scan
++)
2480 if (quote_char
!= '\0')
2482 /* Ignore everything until the matching close quote char. */
2483 if (*scan
== quote_char
)
2485 /* Found matching close quote. */
2490 else if (strchr (quotechars
, *scan
))
2492 /* Found start of a quoted string. */
2495 else if (strchr (breakchars
, *scan
))
2504 /* Skip over the possibly quoted word STR (as defined by the quote
2505 characters and word break characters used by the completer).
2506 Returns pointer to the location after the "word". */
2509 skip_quoted (const char *str
)
2511 return skip_quoted_chars (str
, NULL
, NULL
);
2514 /* Return a message indicating that the maximum number of completions
2515 has been reached and that there may be more. */
2518 get_max_completions_reached_message (void)
2520 return _("*** List may be truncated, max-completions reached. ***");
2523 /* GDB replacement for rl_display_match_list.
2524 Readline doesn't provide a clean interface for TUI(curses).
2525 A hack previously used was to send readline's rl_outstream through a pipe
2526 and read it from the event loop. Bleah. IWBN if readline abstracted
2527 away all the necessary bits, and this is what this code does. It
2528 replicates the parts of readline we need and then adds an abstraction
2529 layer, currently implemented as struct match_list_displayer, so that both
2530 CLI and TUI can use it. We copy all this readline code to minimize
2531 GDB-specific mods to readline. Once this code performs as desired then
2532 we can submit it to the readline maintainers.
2534 N.B. A lot of the code is the way it is in order to minimize differences
2535 from readline's copy. */
2537 /* Not supported here. */
2538 #undef VISIBLE_STATS
2540 #if defined (HANDLE_MULTIBYTE)
2541 #define MB_INVALIDCH(x) ((x) == (size_t)-1 || (x) == (size_t)-2)
2542 #define MB_NULLWCH(x) ((x) == 0)
2545 #define ELLIPSIS_LEN 3
2547 /* gdb version of readline/complete.c:get_y_or_n.
2548 'y' -> returns 1, and 'n' -> returns 0.
2549 Also supported: space == 'y', RUBOUT == 'n', ctrl-g == start over.
2550 If FOR_PAGER is non-zero, then also supported are:
2551 NEWLINE or RETURN -> returns 2, and 'q' -> returns 0. */
2554 gdb_get_y_or_n (int for_pager
, const struct match_list_displayer
*displayer
)
2560 RL_SETSTATE (RL_STATE_MOREINPUT
);
2561 c
= displayer
->read_key (displayer
);
2562 RL_UNSETSTATE (RL_STATE_MOREINPUT
);
2564 if (c
== 'y' || c
== 'Y' || c
== ' ')
2566 if (c
== 'n' || c
== 'N' || c
== RUBOUT
)
2568 if (c
== ABORT_CHAR
|| c
< 0)
2570 /* Readline doesn't erase_entire_line here, but without it the
2571 --More-- prompt isn't erased and neither is the text entered
2572 thus far redisplayed. */
2573 displayer
->erase_entire_line (displayer
);
2574 /* Note: The arguments to rl_abort are ignored. */
2577 if (for_pager
&& (c
== NEWLINE
|| c
== RETURN
))
2579 if (for_pager
&& (c
== 'q' || c
== 'Q'))
2581 displayer
->beep (displayer
);
2585 /* Pager function for tab-completion.
2586 This is based on readline/complete.c:_rl_internal_pager.
2587 LINES is the number of lines of output displayed thus far.
2589 -1 -> user pressed 'n' or equivalent,
2590 0 -> user pressed 'y' or equivalent,
2591 N -> user pressed NEWLINE or equivalent and N is LINES - 1. */
2594 gdb_display_match_list_pager (int lines
,
2595 const struct match_list_displayer
*displayer
)
2599 displayer
->puts (displayer
, "--More--");
2600 displayer
->flush (displayer
);
2601 i
= gdb_get_y_or_n (1, displayer
);
2602 displayer
->erase_entire_line (displayer
);
2611 /* Return non-zero if FILENAME is a directory.
2612 Based on readline/complete.c:path_isdir. */
2615 gdb_path_isdir (const char *filename
)
2619 return (stat (filename
, &finfo
) == 0 && S_ISDIR (finfo
.st_mode
));
2622 /* Return the portion of PATHNAME that should be output when listing
2623 possible completions. If we are hacking filename completion, we
2624 are only interested in the basename, the portion following the
2625 final slash. Otherwise, we return what we were passed. Since
2626 printing empty strings is not very informative, if we're doing
2627 filename completion, and the basename is the empty string, we look
2628 for the previous slash and return the portion following that. If
2629 there's no previous slash, we just return what we were passed.
2631 Based on readline/complete.c:printable_part. */
2634 gdb_printable_part (char *pathname
)
2638 if (rl_filename_completion_desired
== 0) /* don't need to do anything */
2641 temp
= strrchr (pathname
, '/');
2642 #if defined (__MSDOS__)
2643 if (temp
== 0 && ISALPHA ((unsigned char)pathname
[0]) && pathname
[1] == ':')
2644 temp
= pathname
+ 1;
2647 if (temp
== 0 || *temp
== '\0')
2649 /* If the basename is NULL, we might have a pathname like '/usr/src/'.
2650 Look for a previous slash and, if one is found, return the portion
2651 following that slash. If there's no previous slash, just return the
2652 pathname we were passed. */
2653 else if (temp
[1] == '\0')
2655 for (x
= temp
- 1; x
> pathname
; x
--)
2658 return ((*x
== '/') ? x
+ 1 : pathname
);
2664 /* Compute width of STRING when displayed on screen by print_filename.
2665 Based on readline/complete.c:fnwidth. */
2668 gdb_fnwidth (const char *string
)
2671 #if defined (HANDLE_MULTIBYTE)
2677 left
= strlen (string
) + 1;
2678 memset (&ps
, 0, sizeof (mbstate_t));
2684 if (CTRL_CHAR (string
[pos
]) || string
[pos
] == RUBOUT
)
2691 #if defined (HANDLE_MULTIBYTE)
2692 clen
= mbrtowc (&wc
, string
+ pos
, left
- pos
, &ps
);
2693 if (MB_INVALIDCH (clen
))
2697 memset (&ps
, 0, sizeof (mbstate_t));
2699 else if (MB_NULLWCH (clen
))
2705 width
+= (w
>= 0) ? w
: 1;
2717 /* Print TO_PRINT, one matching completion.
2718 PREFIX_BYTES is number of common prefix bytes.
2719 Based on readline/complete.c:fnprint. */
2722 gdb_fnprint (const char *to_print
, int prefix_bytes
,
2723 const struct match_list_displayer
*displayer
)
2727 #if defined (HANDLE_MULTIBYTE)
2734 end
= to_print
+ strlen (to_print
) + 1;
2735 memset (&ps
, 0, sizeof (mbstate_t));
2740 /* Don't print only the ellipsis if the common prefix is one of the
2741 possible completions */
2742 if (to_print
[prefix_bytes
] == '\0')
2749 ellipsis
= (to_print
[prefix_bytes
] == '.') ? '_' : '.';
2750 for (w
= 0; w
< ELLIPSIS_LEN
; w
++)
2751 displayer
->putch (displayer
, ellipsis
);
2752 printed_len
= ELLIPSIS_LEN
;
2755 s
= to_print
+ prefix_bytes
;
2760 displayer
->putch (displayer
, '^');
2761 displayer
->putch (displayer
, UNCTRL (*s
));
2764 #if defined (HANDLE_MULTIBYTE)
2765 memset (&ps
, 0, sizeof (mbstate_t));
2768 else if (*s
== RUBOUT
)
2770 displayer
->putch (displayer
, '^');
2771 displayer
->putch (displayer
, '?');
2774 #if defined (HANDLE_MULTIBYTE)
2775 memset (&ps
, 0, sizeof (mbstate_t));
2780 #if defined (HANDLE_MULTIBYTE)
2781 tlen
= mbrtowc (&wc
, s
, end
- s
, &ps
);
2782 if (MB_INVALIDCH (tlen
))
2786 memset (&ps
, 0, sizeof (mbstate_t));
2788 else if (MB_NULLWCH (tlen
))
2793 width
= (w
>= 0) ? w
: 1;
2795 for (w
= 0; w
< tlen
; ++w
)
2796 displayer
->putch (displayer
, s
[w
]);
2798 printed_len
+= width
;
2800 displayer
->putch (displayer
, *s
);
2810 /* Output TO_PRINT to rl_outstream. If VISIBLE_STATS is defined and we
2811 are using it, check for and output a single character for `special'
2812 filenames. Return the number of characters we output.
2813 Based on readline/complete.c:print_filename. */
2816 gdb_print_filename (char *to_print
, char *full_pathname
, int prefix_bytes
,
2817 const struct match_list_displayer
*displayer
)
2819 int printed_len
, extension_char
, slen
, tlen
;
2820 char *s
, c
, *new_full_pathname
;
2822 extern int _rl_complete_mark_directories
;
2825 printed_len
= gdb_fnprint (to_print
, prefix_bytes
, displayer
);
2827 #if defined (VISIBLE_STATS)
2828 if (rl_filename_completion_desired
&& (rl_visible_stats
|| _rl_complete_mark_directories
))
2830 if (rl_filename_completion_desired
&& _rl_complete_mark_directories
)
2833 /* If to_print != full_pathname, to_print is the basename of the
2834 path passed. In this case, we try to expand the directory
2835 name before checking for the stat character. */
2836 if (to_print
!= full_pathname
)
2838 /* Terminate the directory name. */
2840 to_print
[-1] = '\0';
2842 /* If setting the last slash in full_pathname to a NUL results in
2843 full_pathname being the empty string, we are trying to complete
2844 files in the root directory. If we pass a null string to the
2845 bash directory completion hook, for example, it will expand it
2846 to the current directory. We just want the `/'. */
2847 if (full_pathname
== 0 || *full_pathname
== 0)
2849 else if (full_pathname
[0] != '/')
2851 else if (full_pathname
[1] == 0)
2852 dn
= "//"; /* restore trailing slash to `//' */
2853 else if (full_pathname
[1] == '/' && full_pathname
[2] == 0)
2854 dn
= "/"; /* don't turn /// into // */
2857 s
= tilde_expand (dn
);
2858 if (rl_directory_completion_hook
)
2859 (*rl_directory_completion_hook
) (&s
);
2862 tlen
= strlen (to_print
);
2863 new_full_pathname
= (char *)xmalloc (slen
+ tlen
+ 2);
2864 strcpy (new_full_pathname
, s
);
2865 if (s
[slen
- 1] == '/')
2868 new_full_pathname
[slen
] = '/';
2869 new_full_pathname
[slen
] = '/';
2870 strcpy (new_full_pathname
+ slen
+ 1, to_print
);
2872 #if defined (VISIBLE_STATS)
2873 if (rl_visible_stats
)
2874 extension_char
= stat_char (new_full_pathname
);
2877 if (gdb_path_isdir (new_full_pathname
))
2878 extension_char
= '/';
2880 xfree (new_full_pathname
);
2885 s
= tilde_expand (full_pathname
);
2886 #if defined (VISIBLE_STATS)
2887 if (rl_visible_stats
)
2888 extension_char
= stat_char (s
);
2891 if (gdb_path_isdir (s
))
2892 extension_char
= '/';
2898 displayer
->putch (displayer
, extension_char
);
2906 /* GDB version of readline/complete.c:complete_get_screenwidth. */
2909 gdb_complete_get_screenwidth (const struct match_list_displayer
*displayer
)
2911 /* Readline has other stuff here which it's not clear we need. */
2912 return displayer
->width
;
2915 extern int _rl_completion_prefix_display_length
;
2916 extern int _rl_print_completions_horizontally
;
2918 EXTERN_C
int _rl_qsort_string_compare (const void *, const void *);
2919 typedef int QSFUNC (const void *, const void *);
2921 /* GDB version of readline/complete.c:rl_display_match_list.
2922 See gdb_display_match_list for a description of MATCHES, LEN, MAX.
2923 Returns non-zero if all matches are displayed. */
2926 gdb_display_match_list_1 (char **matches
, int len
, int max
,
2927 const struct match_list_displayer
*displayer
)
2929 int count
, limit
, printed_len
, lines
, cols
;
2930 int i
, j
, k
, l
, common_length
, sind
;
2932 int page_completions
= displayer
->height
!= INT_MAX
&& pagination_enabled
;
2934 /* Find the length of the prefix common to all items: length as displayed
2935 characters (common_length) and as a byte index into the matches (sind) */
2936 common_length
= sind
= 0;
2937 if (_rl_completion_prefix_display_length
> 0)
2939 t
= gdb_printable_part (matches
[0]);
2940 temp
= strrchr (t
, '/');
2941 common_length
= temp
? gdb_fnwidth (temp
) : gdb_fnwidth (t
);
2942 sind
= temp
? strlen (temp
) : strlen (t
);
2944 if (common_length
> _rl_completion_prefix_display_length
&& common_length
> ELLIPSIS_LEN
)
2945 max
-= common_length
- ELLIPSIS_LEN
;
2947 common_length
= sind
= 0;
2950 /* How many items of MAX length can we fit in the screen window? */
2951 cols
= gdb_complete_get_screenwidth (displayer
);
2954 if (limit
!= 1 && (limit
* max
== cols
))
2957 /* If cols == 0, limit will end up -1 */
2958 if (cols
< displayer
->width
&& limit
< 0)
2961 /* Avoid a possible floating exception. If max > cols,
2962 limit will be 0 and a divide-by-zero fault will result. */
2966 /* How many iterations of the printing loop? */
2967 count
= (len
+ (limit
- 1)) / limit
;
2969 /* Watch out for special case. If LEN is less than LIMIT, then
2970 just do the inner printing loop.
2971 0 < len <= limit implies count = 1. */
2973 /* Sort the items if they are not already sorted. */
2974 if (rl_ignore_completion_duplicates
== 0 && rl_sort_completion_matches
)
2975 qsort (matches
+ 1, len
, sizeof (char *), (QSFUNC
*)_rl_qsort_string_compare
);
2977 displayer
->crlf (displayer
);
2980 if (_rl_print_completions_horizontally
== 0)
2982 /* Print the sorted items, up-and-down alphabetically, like ls. */
2983 for (i
= 1; i
<= count
; i
++)
2985 for (j
= 0, l
= i
; j
< limit
; j
++)
2987 if (l
> len
|| matches
[l
] == 0)
2991 temp
= gdb_printable_part (matches
[l
]);
2992 printed_len
= gdb_print_filename (temp
, matches
[l
], sind
,
2996 for (k
= 0; k
< max
- printed_len
; k
++)
2997 displayer
->putch (displayer
, ' ');
3001 displayer
->crlf (displayer
);
3003 if (page_completions
&& lines
>= (displayer
->height
- 1) && i
< count
)
3005 lines
= gdb_display_match_list_pager (lines
, displayer
);
3013 /* Print the sorted items, across alphabetically, like ls -x. */
3014 for (i
= 1; matches
[i
]; i
++)
3016 temp
= gdb_printable_part (matches
[i
]);
3017 printed_len
= gdb_print_filename (temp
, matches
[i
], sind
, displayer
);
3018 /* Have we reached the end of this line? */
3021 if (i
&& (limit
> 1) && (i
% limit
) == 0)
3023 displayer
->crlf (displayer
);
3025 if (page_completions
&& lines
>= displayer
->height
- 1)
3027 lines
= gdb_display_match_list_pager (lines
, displayer
);
3033 for (k
= 0; k
< max
- printed_len
; k
++)
3034 displayer
->putch (displayer
, ' ');
3037 displayer
->crlf (displayer
);
3043 /* Utility for displaying completion list matches, used by both CLI and TUI.
3045 MATCHES is the list of strings, in argv format, LEN is the number of
3046 strings in MATCHES, and MAX is the length of the longest string in
3050 gdb_display_match_list (char **matches
, int len
, int max
,
3051 const struct match_list_displayer
*displayer
)
3053 /* Readline will never call this if complete_line returned NULL. */
3054 gdb_assert (max_completions
!= 0);
3056 /* complete_line will never return more than this. */
3057 if (max_completions
> 0)
3058 gdb_assert (len
<= max_completions
);
3060 if (rl_completion_query_items
> 0 && len
>= rl_completion_query_items
)
3064 /* We can't use *query here because they wait for <RET> which is
3065 wrong here. This follows the readline version as closely as possible
3066 for compatibility's sake. See readline/complete.c. */
3068 displayer
->crlf (displayer
);
3070 xsnprintf (msg
, sizeof (msg
),
3071 "Display all %d possibilities? (y or n)", len
);
3072 displayer
->puts (displayer
, msg
);
3073 displayer
->flush (displayer
);
3075 if (gdb_get_y_or_n (0, displayer
) == 0)
3077 displayer
->crlf (displayer
);
3082 if (gdb_display_match_list_1 (matches
, len
, max
, displayer
))
3084 /* Note: MAX_COMPLETIONS may be -1 or zero, but LEN is always > 0. */
3085 if (len
== max_completions
)
3087 /* The maximum number of completions has been reached. Warn the user
3088 that there may be more. */
3089 const char *message
= get_max_completions_reached_message ();
3091 displayer
->puts (displayer
, message
);
3092 displayer
->crlf (displayer
);
3097 void _initialize_completer ();
3099 _initialize_completer ()
3101 add_setshow_zuinteger_unlimited_cmd ("max-completions", no_class
,
3102 &max_completions
, _("\
3103 Set maximum number of completion candidates."), _("\
3104 Show maximum number of completion candidates."), _("\
3105 Use this to limit the number of candidates considered\n\
3106 during completion. Specifying \"unlimited\" or -1\n\
3107 disables limiting. Note that setting either no limit or\n\
3108 a very large limit can make completion slow."),
3109 NULL
, NULL
, &setlist
, &showlist
);