1 /* Line completion stuff for GDB, the GNU debugger.
2 Copyright (C) 2000-2018 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 /* Misc state that needs to be tracked across several different
49 readline completer entry point calls, all related to a single
50 completion invocation. */
52 struct gdb_completer_state
54 /* The current completion's completion tracker. This is a global
55 because a tracker can be shared between the handle_brkchars and
56 handle_completion phases, which involves different readline
58 completion_tracker
*tracker
= NULL
;
60 /* Whether the current completion was aborted. */
64 /* The current completion state. */
65 static gdb_completer_state current_completion
;
67 /* An enumeration of the various things a user might attempt to
68 complete for a location. If you change this, remember to update
69 the explicit_options array below too. */
71 enum explicit_location_match_type
73 /* The filename of a source file. */
76 /* The name of a function or method. */
79 /* The fully-qualified 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
)
161 gdb::unique_xmalloc_ptr
<char> p_rl
162 (rl_filename_completion_function (text
, subsequent_name
));
165 /* We need to set subsequent_name to a non-zero value before the
166 continue line below, because otherwise, if the first file
167 seen by GDB is a backup file whose name ends in a `~', we
168 will loop indefinitely. */
170 /* Like emacs, don't complete on old versions. Especially
171 useful in the "source" command. */
172 const char *p
= p_rl
.get ();
173 if (p
[strlen (p
) - 1] == '~')
176 tracker
.add_completion
177 (make_completion_match_str (std::move (p_rl
), text
, word
));
180 /* There is no way to do this just long enough to affect quote
181 inserting without also affecting the next completion. This
182 should be fixed in readline. FIXME. */
183 /* Ensure that readline does the right thing
184 with respect to inserting quotes. */
185 rl_completer_word_break_characters
= "";
189 /* The corresponding completer_handle_brkchars
193 filename_completer_handle_brkchars (struct cmd_list_element
*ignore
,
194 completion_tracker
&tracker
,
195 const char *text
, const char *word
)
197 set_rl_completer_word_break_characters
198 (gdb_completer_file_name_break_characters
);
201 /* Possible values for the found_quote flags word used by the completion
202 functions. It says what kind of (shell-like) quoting we found anywhere
204 #define RL_QF_SINGLE_QUOTE 0x01
205 #define RL_QF_DOUBLE_QUOTE 0x02
206 #define RL_QF_BACKSLASH 0x04
207 #define RL_QF_OTHER_QUOTE 0x08
209 /* Find the bounds of the current word for completion purposes, and
210 return a pointer to the end of the word. This mimics (and is a
211 modified version of) readline's _rl_find_completion_word internal
214 This function skips quoted substrings (characters between matched
215 pairs of characters in rl_completer_quote_characters). We try to
216 find an unclosed quoted substring on which to do matching. If one
217 is not found, we use the word break characters to find the
218 boundaries of the current word. QC, if non-null, is set to the
219 opening quote character if we found an unclosed quoted substring,
220 '\0' otherwise. DP, if non-null, is set to the value of the
221 delimiter character that caused a word break. */
223 struct gdb_rl_completion_word_info
225 const char *word_break_characters
;
226 const char *quote_characters
;
227 const char *basic_quote_characters
;
231 gdb_rl_find_completion_word (struct gdb_rl_completion_word_info
*info
,
233 const char *line_buffer
)
235 int scan
, end
, found_quote
, delimiter
, pass_next
, isbrk
;
237 const char *brkchars
;
238 int point
= strlen (line_buffer
);
240 /* The algorithm below does '--point'. Avoid buffer underflow with
252 found_quote
= delimiter
= 0;
255 brkchars
= info
->word_break_characters
;
257 if (info
->quote_characters
!= NULL
)
259 /* We have a list of characters which can be used in pairs to
260 quote substrings for the completer. Try to find the start of
261 an unclosed quoted substring. */
262 /* FOUND_QUOTE is set so we know what kind of quotes we
264 for (scan
= pass_next
= 0;
274 /* Shell-like semantics for single quotes -- don't allow
275 backslash to quote anything in single quotes, especially
276 not the closing quote. If you don't like this, take out
277 the check on the value of quote_char. */
278 if (quote_char
!= '\'' && line_buffer
[scan
] == '\\')
281 found_quote
|= RL_QF_BACKSLASH
;
285 if (quote_char
!= '\0')
287 /* Ignore everything until the matching close quote
289 if (line_buffer
[scan
] == quote_char
)
291 /* Found matching close. Abandon this
297 else if (strchr (info
->quote_characters
, line_buffer
[scan
]))
299 /* Found start of a quoted substring. */
300 quote_char
= line_buffer
[scan
];
302 /* Shell-like quoting conventions. */
303 if (quote_char
== '\'')
304 found_quote
|= RL_QF_SINGLE_QUOTE
;
305 else if (quote_char
== '"')
306 found_quote
|= RL_QF_DOUBLE_QUOTE
;
308 found_quote
|= RL_QF_OTHER_QUOTE
;
313 if (point
== end
&& quote_char
== '\0')
315 /* We didn't find an unclosed quoted substring upon which to do
316 completion, so use the word break characters to find the
317 substring on which to complete. */
320 scan
= line_buffer
[point
];
322 if (strchr (brkchars
, scan
) != 0)
327 /* If we are at an unquoted word break, then advance past it. */
328 scan
= line_buffer
[point
];
332 isbrk
= strchr (brkchars
, scan
) != 0;
336 /* If the character that caused the word break was a quoting
337 character, then remember it as the delimiter. */
338 if (info
->basic_quote_characters
339 && strchr (info
->basic_quote_characters
, scan
)
340 && (end
- point
) > 1)
352 return line_buffer
+ point
;
355 /* See completer.h. */
358 advance_to_expression_complete_word_point (completion_tracker
&tracker
,
361 gdb_rl_completion_word_info info
;
363 info
.word_break_characters
364 = current_language
->la_word_break_characters ();
365 info
.quote_characters
= gdb_completer_quote_characters
;
366 info
.basic_quote_characters
= rl_basic_quote_characters
;
369 = gdb_rl_find_completion_word (&info
, NULL
, NULL
, text
);
371 tracker
.advance_custom_word_point_by (start
- text
);
376 /* See completer.h. */
379 completion_tracker::completes_to_completion_word (const char *word
)
381 if (m_lowest_common_denominator_unique
)
383 const char *lcd
= m_lowest_common_denominator
;
385 if (strncmp_iw (word
, lcd
, strlen (lcd
)) == 0)
387 /* Maybe skip the function and complete on keywords. */
388 size_t wordlen
= strlen (word
);
389 if (word
[wordlen
- 1] == ' ')
397 /* Complete on linespecs, which might be of two possible forms:
403 This is intended to be used in commands that set breakpoints
407 complete_files_symbols (completion_tracker
&tracker
,
408 const char *text
, const char *word
)
410 completion_list fn_list
;
413 int quoted
= *text
== '\'' || *text
== '"';
414 int quote_char
= '\0';
415 const char *colon
= NULL
;
416 char *file_to_match
= NULL
;
417 const char *symbol_start
= text
;
418 const char *orig_text
= text
;
420 /* Do we have an unquoted colon, as in "break foo.c:bar"? */
421 for (p
= text
; *p
!= '\0'; ++p
)
423 if (*p
== '\\' && p
[1] == '\'')
425 else if (*p
== '\'' || *p
== '"')
429 while (*p
!= '\0' && *p
!= quote_found
)
431 if (*p
== '\\' && p
[1] == quote_found
)
436 if (*p
== quote_found
)
439 break; /* Hit the end of text. */
441 #if HAVE_DOS_BASED_FILE_SYSTEM
442 /* If we have a DOS-style absolute file name at the beginning of
443 TEXT, and the colon after the drive letter is the only colon
444 we found, pretend the colon is not there. */
445 else if (p
< text
+ 3 && *p
== ':' && p
== text
+ 1 + quoted
)
448 else if (*p
== ':' && !colon
)
451 symbol_start
= p
+ 1;
453 else if (strchr (current_language
->la_word_break_characters(), *p
))
454 symbol_start
= p
+ 1;
460 /* Where is the file name? */
465 file_to_match
= (char *) xmalloc (colon
- text
+ 1);
466 strncpy (file_to_match
, text
, colon
- text
);
467 file_to_match
[colon
- text
] = '\0';
468 /* Remove trailing colons and quotes from the file name. */
469 for (s
= file_to_match
+ (colon
- text
);
472 if (*s
== ':' || *s
== quote_char
)
475 /* If the text includes a colon, they want completion only on a
476 symbol name after the colon. Otherwise, we need to complete on
477 symbols as well as on files. */
480 collect_file_symbol_completion_matches (tracker
,
481 complete_symbol_mode::EXPRESSION
,
482 symbol_name_match_type::EXPRESSION
,
485 xfree (file_to_match
);
489 size_t text_len
= strlen (text
);
491 collect_symbol_completion_matches (tracker
,
492 complete_symbol_mode::EXPRESSION
,
493 symbol_name_match_type::EXPRESSION
,
495 /* If text includes characters which cannot appear in a file
496 name, they cannot be asking for completion on files. */
498 gdb_completer_file_name_break_characters
) == text_len
)
499 fn_list
= make_source_files_completion_list (text
, text
);
502 if (!fn_list
.empty () && !tracker
.have_completions ())
504 /* If we only have file names as possible completion, we should
505 bring them in sync with what rl_complete expects. The
506 problem is that if the user types "break /foo/b TAB", and the
507 possible completions are "/foo/bar" and "/foo/baz"
508 rl_complete expects us to return "bar" and "baz", without the
509 leading directories, as possible completions, because `word'
510 starts at the "b". But we ignore the value of `word' when we
511 call make_source_files_completion_list above (because that
512 would not DTRT when the completion results in both symbols
513 and file names), so make_source_files_completion_list returns
514 the full "/foo/bar" and "/foo/baz" strings. This produces
515 wrong results when, e.g., there's only one possible
516 completion, because rl_complete will prepend "/foo/" to each
517 candidate completion. The loop below removes that leading
519 for (const auto &fn_up
: fn_list
)
521 char *fn
= fn_up
.get ();
522 memmove (fn
, fn
+ (word
- text
), strlen (fn
) + 1 - (word
- text
));
526 tracker
.add_completions (std::move (fn_list
));
528 if (!tracker
.have_completions ())
530 /* No completions at all. As the final resort, try completing
531 on the entire text as a symbol. */
532 collect_symbol_completion_matches (tracker
,
533 complete_symbol_mode::EXPRESSION
,
534 symbol_name_match_type::EXPRESSION
,
539 /* See completer.h. */
542 complete_source_filenames (const char *text
)
544 size_t text_len
= strlen (text
);
546 /* If text includes characters which cannot appear in a file name,
547 the user cannot be asking for completion on files. */
549 gdb_completer_file_name_break_characters
)
551 return make_source_files_completion_list (text
, text
);
556 /* Complete address and linespec locations. */
559 complete_address_and_linespec_locations (completion_tracker
&tracker
,
561 symbol_name_match_type match_type
)
565 tracker
.advance_custom_word_point_by (1);
568 = advance_to_expression_complete_word_point (tracker
, text
);
569 complete_expression (tracker
, text
, word
);
573 linespec_complete (tracker
, text
, match_type
);
577 /* The explicit location options. Note that indexes into this array
578 must match the explicit_location_match_type enumerators. */
580 static const char *const explicit_options
[] =
590 /* The probe modifier options. These can appear before a location in
591 breakpoint commands. */
592 static const char *const probe_options
[] =
600 /* Returns STRING if not NULL, the empty string otherwise. */
603 string_or_empty (const char *string
)
605 return string
!= NULL
? string
: "";
608 /* A helper function to collect explicit location matches for the given
609 LOCATION, which is attempting to match on WORD. */
612 collect_explicit_location_matches (completion_tracker
&tracker
,
613 struct event_location
*location
,
614 enum explicit_location_match_type what
,
616 const struct language_defn
*language
)
618 const struct explicit_location
*explicit_loc
619 = get_explicit_location (location
);
621 /* True if the option expects an argument. */
622 bool needs_arg
= true;
624 /* Note, in the various MATCH_* below, we complete on
625 explicit_loc->foo instead of WORD, because only the former will
626 have already skipped past any quote char. */
631 const char *source
= string_or_empty (explicit_loc
->source_filename
);
632 completion_list matches
633 = make_source_files_completion_list (source
, source
);
634 tracker
.add_completions (std::move (matches
));
640 const char *function
= string_or_empty (explicit_loc
->function_name
);
641 linespec_complete_function (tracker
, function
,
642 explicit_loc
->func_name_match_type
,
643 explicit_loc
->source_filename
);
647 case MATCH_QUALIFIED
:
651 /* Nothing to offer. */
656 const char *label
= string_or_empty (explicit_loc
->label_name
);
657 linespec_complete_label (tracker
, language
,
658 explicit_loc
->source_filename
,
659 explicit_loc
->function_name
,
660 explicit_loc
->func_name_match_type
,
666 gdb_assert_not_reached ("unhandled explicit_location_match_type");
669 if (!needs_arg
|| tracker
.completes_to_completion_word (word
))
671 tracker
.discard_completions ();
672 tracker
.advance_custom_word_point_by (strlen (word
));
673 complete_on_enum (tracker
, explicit_options
, "", "");
674 complete_on_enum (tracker
, linespec_keywords
, "", "");
676 else if (!tracker
.have_completions ())
678 /* Maybe we have an unterminated linespec keyword at the tail of
679 the string. Try completing on that. */
680 size_t wordlen
= strlen (word
);
681 const char *keyword
= word
+ wordlen
;
683 if (wordlen
> 0 && keyword
[-1] != ' ')
685 while (keyword
> word
&& *keyword
!= ' ')
687 /* Don't complete on keywords if we'd be completing on the
688 whole explicit linespec option. E.g., "b -function
689 thr<tab>" should not complete to the "thread"
693 keyword
= skip_spaces (keyword
);
695 tracker
.advance_custom_word_point_by (keyword
- word
);
696 complete_on_enum (tracker
, linespec_keywords
, keyword
, keyword
);
699 else if (wordlen
> 0 && keyword
[-1] == ' ')
701 /* Assume that we're maybe past the explicit location
702 argument, and we didn't manage to find any match because
703 the user wants to create a pending breakpoint. Offer the
704 keyword and explicit location options as possible
706 tracker
.advance_custom_word_point_by (keyword
- word
);
707 complete_on_enum (tracker
, linespec_keywords
, keyword
, keyword
);
708 complete_on_enum (tracker
, explicit_options
, keyword
, keyword
);
713 /* If the next word in *TEXT_P is any of the keywords in KEYWORDS,
714 then advance both TEXT_P and the word point in the tracker past the
715 keyword and return the (0-based) index in the KEYWORDS array that
716 matched. Otherwise, return -1. */
719 skip_keyword (completion_tracker
&tracker
,
720 const char * const *keywords
, const char **text_p
)
722 const char *text
= *text_p
;
723 const char *after
= skip_to_space (text
);
724 size_t len
= after
- text
;
726 if (text
[len
] != ' ')
730 for (int i
= 0; keywords
[i
] != NULL
; i
++)
732 if (strncmp (keywords
[i
], text
, len
) == 0)
743 tracker
.advance_custom_word_point_by (len
+ 1);
752 /* A completer function for explicit locations. This function
753 completes both options ("-source", "-line", etc) and values. If
754 completing a quoted string, then QUOTED_ARG_START and
755 QUOTED_ARG_END point to the quote characters. LANGUAGE is the
759 complete_explicit_location (completion_tracker
&tracker
,
760 struct event_location
*location
,
762 const language_defn
*language
,
763 const char *quoted_arg_start
,
764 const char *quoted_arg_end
)
769 int keyword
= skip_keyword (tracker
, explicit_options
, &text
);
772 complete_on_enum (tracker
, explicit_options
, text
, text
);
775 /* Completing on value. */
776 enum explicit_location_match_type what
777 = (explicit_location_match_type
) keyword
;
779 if (quoted_arg_start
!= NULL
&& quoted_arg_end
!= NULL
)
781 if (quoted_arg_end
[1] == '\0')
783 /* If completing a quoted string with the cursor right
784 at the terminating quote char, complete the
785 completion word without interpretation, so that
786 readline advances the cursor one whitespace past the
787 quote, even if there's no match. This makes these
788 cases behave the same:
790 before: "b -function function()"
791 after: "b -function function() "
793 before: "b -function 'function()'"
794 after: "b -function 'function()' "
796 and trusts the user in this case:
798 before: "b -function 'not_loaded_function_yet()'"
799 after: "b -function 'not_loaded_function_yet()' "
801 gdb::unique_xmalloc_ptr
<char> text_copy
803 tracker
.add_completion (std::move (text_copy
));
805 else if (quoted_arg_end
[1] == ' ')
807 /* We're maybe past the explicit location argument.
808 Skip the argument without interpretion, assuming the
809 user may want to create pending breakpoint. Offer
810 the keyword and explicit location options as possible
812 tracker
.advance_custom_word_point_by (strlen (text
));
813 complete_on_enum (tracker
, linespec_keywords
, "", "");
814 complete_on_enum (tracker
, explicit_options
, "", "");
819 /* Now gather matches */
820 collect_explicit_location_matches (tracker
, location
, what
, text
,
825 /* A completer for locations. */
828 location_completer (struct cmd_list_element
*ignore
,
829 completion_tracker
&tracker
,
830 const char *text
, const char * /* word */)
832 int found_probe_option
= -1;
834 /* If we have a probe modifier, skip it. This can only appear as
835 first argument. Until we have a specific completer for probes,
836 falling back to the linespec completer for the remainder of the
837 line is better than nothing. */
838 if (text
[0] == '-' && text
[1] == 'p')
839 found_probe_option
= skip_keyword (tracker
, probe_options
, &text
);
841 const char *option_text
= text
;
842 int saved_word_point
= tracker
.custom_word_point ();
844 const char *copy
= text
;
846 explicit_completion_info completion_info
;
847 event_location_up location
848 = string_to_explicit_location (©
, current_language
,
850 if (completion_info
.quoted_arg_start
!= NULL
851 && completion_info
.quoted_arg_end
== NULL
)
853 /* Found an unbalanced quote. */
854 tracker
.set_quote_char (*completion_info
.quoted_arg_start
);
855 tracker
.advance_custom_word_point_by (1);
858 if (completion_info
.saw_explicit_location_option
)
862 tracker
.advance_custom_word_point_by (copy
- text
);
865 /* We found a terminator at the tail end of the string,
866 which means we're past the explicit location options. We
867 may have a keyword to complete on. If we have a whole
868 keyword, then complete whatever comes after as an
869 expression. This is mainly for the "if" keyword. If the
870 "thread" and "task" keywords gain their own completers,
871 they should be used here. */
872 int keyword
= skip_keyword (tracker
, linespec_keywords
, &text
);
876 complete_on_enum (tracker
, linespec_keywords
, text
, text
);
881 = advance_to_expression_complete_word_point (tracker
, text
);
882 complete_expression (tracker
, text
, word
);
887 tracker
.advance_custom_word_point_by (completion_info
.last_option
889 text
= completion_info
.last_option
;
891 complete_explicit_location (tracker
, location
.get (), text
,
893 completion_info
.quoted_arg_start
,
894 completion_info
.quoted_arg_end
);
898 /* This is an address or linespec location. */
899 else if (location
!= NULL
)
901 /* Handle non-explicit location options. */
903 int keyword
= skip_keyword (tracker
, explicit_options
, &text
);
905 complete_on_enum (tracker
, explicit_options
, text
, text
);
908 tracker
.advance_custom_word_point_by (copy
- text
);
911 symbol_name_match_type match_type
912 = get_explicit_location (location
.get ())->func_name_match_type
;
913 complete_address_and_linespec_locations (tracker
, text
, match_type
);
919 complete_address_and_linespec_locations (tracker
, text
,
920 symbol_name_match_type::WILD
);
923 /* Add matches for option names, if either:
925 - Some completer above found some matches, but the word point did
926 not advance (e.g., "b <tab>" finds all functions, or "b -<tab>"
927 matches all objc selectors), or;
929 - Some completer above advanced the word point, but found no
932 if ((text
[0] == '-' || text
[0] == '\0')
933 && (!tracker
.have_completions ()
934 || tracker
.custom_word_point () == saved_word_point
))
936 tracker
.set_custom_word_point (saved_word_point
);
939 if (found_probe_option
== -1)
940 complete_on_enum (tracker
, probe_options
, text
, text
);
941 complete_on_enum (tracker
, explicit_options
, text
, text
);
945 /* The corresponding completer_handle_brkchars
949 location_completer_handle_brkchars (struct cmd_list_element
*ignore
,
950 completion_tracker
&tracker
,
952 const char *word_ignored
)
954 tracker
.set_use_custom_word_point (true);
956 location_completer (ignore
, tracker
, text
, NULL
);
959 /* Helper for expression_completer which recursively adds field and
960 method names from TYPE, a struct or union type, to the OUTPUT
964 add_struct_fields (struct type
*type
, completion_list
&output
,
965 char *fieldname
, int namelen
)
968 int computed_type_name
= 0;
969 const char *type_name
= NULL
;
971 type
= check_typedef (type
);
972 for (i
= 0; i
< TYPE_NFIELDS (type
); ++i
)
974 if (i
< TYPE_N_BASECLASSES (type
))
975 add_struct_fields (TYPE_BASECLASS (type
, i
),
976 output
, fieldname
, namelen
);
977 else if (TYPE_FIELD_NAME (type
, i
))
979 if (TYPE_FIELD_NAME (type
, i
)[0] != '\0')
981 if (! strncmp (TYPE_FIELD_NAME (type
, i
),
983 output
.emplace_back (xstrdup (TYPE_FIELD_NAME (type
, i
)));
985 else if (TYPE_CODE (TYPE_FIELD_TYPE (type
, i
)) == TYPE_CODE_UNION
)
987 /* Recurse into anonymous unions. */
988 add_struct_fields (TYPE_FIELD_TYPE (type
, i
),
989 output
, fieldname
, namelen
);
994 for (i
= TYPE_NFN_FIELDS (type
) - 1; i
>= 0; --i
)
996 const char *name
= TYPE_FN_FIELDLIST_NAME (type
, i
);
998 if (name
&& ! strncmp (name
, fieldname
, namelen
))
1000 if (!computed_type_name
)
1002 type_name
= type_name_no_tag (type
);
1003 computed_type_name
= 1;
1005 /* Omit constructors from the completion list. */
1006 if (!type_name
|| strcmp (type_name
, name
))
1007 output
.emplace_back (xstrdup (name
));
1012 /* See completer.h. */
1015 complete_expression (completion_tracker
&tracker
,
1016 const char *text
, const char *word
)
1018 struct type
*type
= NULL
;
1020 enum type_code code
= TYPE_CODE_UNDEF
;
1022 /* Perform a tentative parse of the expression, to see whether a
1023 field completion is required. */
1027 type
= parse_expression_for_completion (text
, &fieldname
, &code
);
1029 CATCH (except
, RETURN_MASK_ERROR
)
1035 if (fieldname
&& type
)
1039 type
= check_typedef (type
);
1040 if (TYPE_CODE (type
) != TYPE_CODE_PTR
&& !TYPE_IS_REFERENCE (type
))
1042 type
= TYPE_TARGET_TYPE (type
);
1045 if (TYPE_CODE (type
) == TYPE_CODE_UNION
1046 || TYPE_CODE (type
) == TYPE_CODE_STRUCT
)
1048 int flen
= strlen (fieldname
);
1049 completion_list result
;
1051 add_struct_fields (type
, result
, fieldname
, flen
);
1053 tracker
.add_completions (std::move (result
));
1057 else if (fieldname
&& code
!= TYPE_CODE_UNDEF
)
1059 struct cleanup
*cleanup
= make_cleanup (xfree
, fieldname
);
1061 collect_symbol_completion_matches_type (tracker
, fieldname
, fieldname
,
1063 do_cleanups (cleanup
);
1068 complete_files_symbols (tracker
, text
, word
);
1071 /* Complete on expressions. Often this means completing on symbol
1072 names, but some language parsers also have support for completing
1076 expression_completer (struct cmd_list_element
*ignore
,
1077 completion_tracker
&tracker
,
1078 const char *text
, const char *word
)
1080 complete_expression (tracker
, text
, word
);
1083 /* See definition in completer.h. */
1086 set_rl_completer_word_break_characters (const char *break_chars
)
1088 rl_completer_word_break_characters
= (char *) break_chars
;
1091 /* See definition in completer.h. */
1094 set_gdb_completion_word_break_characters (completer_ftype
*fn
)
1096 const char *break_chars
;
1098 /* So far we are only interested in differentiating filename
1099 completers from everything else. */
1100 if (fn
== filename_completer
)
1101 break_chars
= gdb_completer_file_name_break_characters
;
1103 break_chars
= gdb_completer_command_word_break_characters
;
1105 set_rl_completer_word_break_characters (break_chars
);
1108 /* Complete on symbols. */
1111 symbol_completer (struct cmd_list_element
*ignore
,
1112 completion_tracker
&tracker
,
1113 const char *text
, const char *word
)
1115 collect_symbol_completion_matches (tracker
, complete_symbol_mode::EXPRESSION
,
1116 symbol_name_match_type::EXPRESSION
,
1120 /* Here are some useful test cases for completion. FIXME: These
1121 should be put in the test suite. They should be tested with both
1124 "show output-" "radix"
1125 "show output" "-radix"
1126 "p" ambiguous (commands starting with p--path, print, printf, etc.)
1127 "p " ambiguous (all symbols)
1128 "info t foo" no completions
1129 "info t " no completions
1130 "info t" ambiguous ("info target", "info terminal", etc.)
1131 "info ajksdlfk" no completions
1132 "info ajksdlfk " no completions
1134 "info " ambiguous (all info commands)
1135 "p \"a" no completions (string constant)
1136 "p 'a" ambiguous (all symbols starting with a)
1137 "p b-a" ambiguous (all symbols starting with a)
1138 "p b-" ambiguous (all symbols)
1139 "file Make" "file" (word break hard to screw up here)
1140 "file ../gdb.stabs/we" "ird" (needs to not break word at slash)
1143 enum complete_line_internal_reason
1145 /* Preliminary phase, called by gdb_completion_word_break_characters
1146 function, is used to either:
1148 #1 - Determine the set of chars that are word delimiters
1149 depending on the current command in line_buffer.
1151 #2 - Manually advance RL_POINT to the "word break" point instead
1152 of letting readline do it (based on too-simple character
1155 Simpler completers that just pass a brkchars array to readline
1156 (#1 above) must defer generating the completions to the main
1157 phase (below). No completion list should be generated in this
1160 OTOH, completers that manually advance the word point(#2 above)
1161 must set "use_custom_word_point" in the tracker and generate
1162 their completion in this phase. Note that this is the convenient
1163 thing to do since they'll be parsing the input line anyway. */
1166 /* Main phase, called by complete_line function, is used to get the
1167 list of possible completions. */
1170 /* Special case when completing a 'help' command. In this case,
1171 once sub-command completions are exhausted, we simply return
1176 /* Helper for complete_line_internal to simplify it. */
1179 complete_line_internal_normal_command (completion_tracker
&tracker
,
1180 const char *command
, const char *word
,
1181 const char *cmd_args
,
1182 complete_line_internal_reason reason
,
1183 struct cmd_list_element
*c
)
1185 const char *p
= cmd_args
;
1187 if (c
->completer
== filename_completer
)
1189 /* Many commands which want to complete on file names accept
1190 several file names, as in "run foo bar >>baz". So we don't
1191 want to complete the entire text after the command, just the
1192 last word. To this end, we need to find the beginning of the
1193 file name by starting at `word' and going backwards. */
1196 && strchr (gdb_completer_file_name_break_characters
,
1202 if (reason
== handle_brkchars
)
1204 completer_handle_brkchars_ftype
*brkchars_fn
;
1206 if (c
->completer_handle_brkchars
!= NULL
)
1207 brkchars_fn
= c
->completer_handle_brkchars
;
1211 = (completer_handle_brkchars_func_for_completer
1215 brkchars_fn (c
, tracker
, p
, word
);
1218 if (reason
!= handle_brkchars
&& c
->completer
!= NULL
)
1219 (*c
->completer
) (c
, tracker
, p
, word
);
1222 /* Internal function used to handle completions.
1225 TEXT is the caller's idea of the "word" we are looking at.
1227 LINE_BUFFER is available to be looked at; it contains the entire
1228 text of the line. POINT is the offset in that line of the cursor.
1229 You should pretend that the line ends at POINT.
1231 See complete_line_internal_reason for description of REASON. */
1234 complete_line_internal_1 (completion_tracker
&tracker
,
1236 const char *line_buffer
, int point
,
1237 complete_line_internal_reason reason
)
1241 int ignore_help_classes
;
1242 /* Pointer within tmp_command which corresponds to text. */
1244 struct cmd_list_element
*c
, *result_list
;
1246 /* Choose the default set of word break characters to break
1247 completions. If we later find out that we are doing completions
1248 on command strings (as opposed to strings supplied by the
1249 individual command completer functions, which can be any string)
1250 then we will switch to the special word break set for command
1251 strings, which leaves out the '-' character used in some
1253 set_rl_completer_word_break_characters
1254 (current_language
->la_word_break_characters());
1256 /* Decide whether to complete on a list of gdb commands or on
1258 tmp_command
= (char *) alloca (point
+ 1);
1261 /* The help command should complete help aliases. */
1262 ignore_help_classes
= reason
!= handle_help
;
1264 strncpy (tmp_command
, line_buffer
, point
);
1265 tmp_command
[point
] = '\0';
1266 if (reason
== handle_brkchars
)
1268 gdb_assert (text
== NULL
);
1273 /* Since text always contains some number of characters leading up
1274 to point, we can find the equivalent position in tmp_command
1275 by subtracting that many characters from the end of tmp_command. */
1276 word
= tmp_command
+ point
- strlen (text
);
1279 /* Move P up to the start of the command. */
1280 p
= skip_spaces (p
);
1284 /* An empty line is ambiguous; that is, it could be any
1286 c
= CMD_LIST_AMBIGUOUS
;
1291 c
= lookup_cmd_1 (&p
, cmdlist
, &result_list
, ignore_help_classes
);
1294 /* Move p up to the next interesting thing. */
1295 while (*p
== ' ' || *p
== '\t')
1300 tracker
.advance_custom_word_point_by (p
- tmp_command
);
1304 /* It is an unrecognized command. So there are no
1305 possible completions. */
1307 else if (c
== CMD_LIST_AMBIGUOUS
)
1311 /* lookup_cmd_1 advances p up to the first ambiguous thing, but
1312 doesn't advance over that thing itself. Do so now. */
1314 while (*q
&& (isalnum (*q
) || *q
== '-' || *q
== '_'))
1316 if (q
!= tmp_command
+ point
)
1318 /* There is something beyond the ambiguous
1319 command, so there are no possible completions. For
1320 example, "info t " or "info t foo" does not complete
1321 to anything, because "info t" can be "info target" or
1326 /* We're trying to complete on the command which was ambiguous.
1327 This we can deal with. */
1330 if (reason
!= handle_brkchars
)
1331 complete_on_cmdlist (*result_list
->prefixlist
, tracker
, p
,
1332 word
, ignore_help_classes
);
1336 if (reason
!= handle_brkchars
)
1337 complete_on_cmdlist (cmdlist
, tracker
, p
, word
,
1338 ignore_help_classes
);
1340 /* Ensure that readline does the right thing with respect to
1341 inserting quotes. */
1342 set_rl_completer_word_break_characters
1343 (gdb_completer_command_word_break_characters
);
1348 /* We've recognized a full command. */
1350 if (p
== tmp_command
+ point
)
1352 /* There is no non-whitespace in the line beyond the
1355 if (p
[-1] == ' ' || p
[-1] == '\t')
1357 /* The command is followed by whitespace; we need to
1358 complete on whatever comes after command. */
1361 /* It is a prefix command; what comes after it is
1362 a subcommand (e.g. "info "). */
1363 if (reason
!= handle_brkchars
)
1364 complete_on_cmdlist (*c
->prefixlist
, tracker
, p
, word
,
1365 ignore_help_classes
);
1367 /* Ensure that readline does the right thing
1368 with respect to inserting quotes. */
1369 set_rl_completer_word_break_characters
1370 (gdb_completer_command_word_break_characters
);
1372 else if (reason
== handle_help
)
1376 if (reason
!= handle_brkchars
)
1377 complete_on_enum (tracker
, c
->enums
, p
, word
);
1378 set_rl_completer_word_break_characters
1379 (gdb_completer_command_word_break_characters
);
1383 /* It is a normal command; what comes after it is
1384 completed by the command's completer function. */
1385 complete_line_internal_normal_command (tracker
,
1386 tmp_command
, word
, p
,
1392 /* The command is not followed by whitespace; we need to
1393 complete on the command itself, e.g. "p" which is a
1394 command itself but also can complete to "print", "ptype"
1398 /* Find the command we are completing on. */
1400 while (q
> tmp_command
)
1402 if (isalnum (q
[-1]) || q
[-1] == '-' || q
[-1] == '_')
1408 if (reason
!= handle_brkchars
)
1409 complete_on_cmdlist (result_list
, tracker
, q
, word
,
1410 ignore_help_classes
);
1412 /* Ensure that readline does the right thing
1413 with respect to inserting quotes. */
1414 set_rl_completer_word_break_characters
1415 (gdb_completer_command_word_break_characters
);
1418 else if (reason
== handle_help
)
1422 /* There is non-whitespace beyond the command. */
1424 if (c
->prefixlist
&& !c
->allow_unknown
)
1426 /* It is an unrecognized subcommand of a prefix command,
1427 e.g. "info adsfkdj". */
1431 if (reason
!= handle_brkchars
)
1432 complete_on_enum (tracker
, c
->enums
, p
, word
);
1436 /* It is a normal command. */
1437 complete_line_internal_normal_command (tracker
,
1438 tmp_command
, word
, p
,
1445 /* Wrapper around complete_line_internal_1 to handle
1446 MAX_COMPLETIONS_REACHED_ERROR. */
1449 complete_line_internal (completion_tracker
&tracker
,
1451 const char *line_buffer
, int point
,
1452 complete_line_internal_reason reason
)
1456 complete_line_internal_1 (tracker
, text
, line_buffer
, point
, reason
);
1458 CATCH (except
, RETURN_MASK_ERROR
)
1460 if (except
.error
!= MAX_COMPLETIONS_REACHED_ERROR
)
1461 throw_exception (except
);
1466 /* See completer.h. */
1468 int max_completions
= 200;
1470 /* Initial size of the table. It automagically grows from here. */
1471 #define INITIAL_COMPLETION_HTAB_SIZE 200
1473 /* See completer.h. */
1475 completion_tracker::completion_tracker ()
1477 m_entries_hash
= htab_create_alloc (INITIAL_COMPLETION_HTAB_SIZE
,
1478 htab_hash_string
, (htab_eq
) streq
,
1479 NULL
, xcalloc
, xfree
);
1482 /* See completer.h. */
1485 completion_tracker::discard_completions ()
1487 xfree (m_lowest_common_denominator
);
1488 m_lowest_common_denominator
= NULL
;
1490 m_lowest_common_denominator_unique
= false;
1492 m_entries_vec
.clear ();
1494 htab_delete (m_entries_hash
);
1495 m_entries_hash
= htab_create_alloc (INITIAL_COMPLETION_HTAB_SIZE
,
1496 htab_hash_string
, (htab_eq
) streq
,
1497 NULL
, xcalloc
, xfree
);
1500 /* See completer.h. */
1502 completion_tracker::~completion_tracker ()
1504 xfree (m_lowest_common_denominator
);
1505 htab_delete (m_entries_hash
);
1508 /* See completer.h. */
1511 completion_tracker::maybe_add_completion
1512 (gdb::unique_xmalloc_ptr
<char> name
,
1513 completion_match_for_lcd
*match_for_lcd
,
1514 const char *text
, const char *word
)
1518 if (max_completions
== 0)
1521 if (htab_elements (m_entries_hash
) >= max_completions
)
1524 slot
= htab_find_slot (m_entries_hash
, name
.get (), INSERT
);
1525 if (*slot
== HTAB_EMPTY_ENTRY
)
1527 const char *match_for_lcd_str
= NULL
;
1529 if (match_for_lcd
!= NULL
)
1530 match_for_lcd_str
= match_for_lcd
->finish ();
1532 if (match_for_lcd_str
== NULL
)
1533 match_for_lcd_str
= name
.get ();
1535 gdb::unique_xmalloc_ptr
<char> lcd
1536 = make_completion_match_str (match_for_lcd_str
, text
, word
);
1538 recompute_lowest_common_denominator (std::move (lcd
));
1540 *slot
= name
.get ();
1541 m_entries_vec
.push_back (std::move (name
));
1547 /* See completer.h. */
1550 completion_tracker::add_completion (gdb::unique_xmalloc_ptr
<char> name
,
1551 completion_match_for_lcd
*match_for_lcd
,
1552 const char *text
, const char *word
)
1554 if (!maybe_add_completion (std::move (name
), match_for_lcd
, text
, word
))
1555 throw_error (MAX_COMPLETIONS_REACHED_ERROR
, _("Max completions reached."));
1558 /* See completer.h. */
1561 completion_tracker::add_completions (completion_list
&&list
)
1563 for (auto &candidate
: list
)
1564 add_completion (std::move (candidate
));
1567 /* Helper for the make_completion_match_str overloads. Returns NULL
1568 as an indication that we want MATCH_NAME exactly. It is up to the
1569 caller to xstrdup that string if desired. */
1572 make_completion_match_str_1 (const char *match_name
,
1573 const char *text
, const char *word
)
1579 /* Return NULL as an indication that we want MATCH_NAME
1583 else if (word
> text
)
1585 /* Return some portion of MATCH_NAME. */
1586 newobj
= xstrdup (match_name
+ (word
- text
));
1590 /* Return some of WORD plus MATCH_NAME. */
1591 size_t len
= strlen (match_name
);
1592 newobj
= (char *) xmalloc (text
- word
+ len
+ 1);
1593 memcpy (newobj
, word
, text
- word
);
1594 memcpy (newobj
+ (text
- word
), match_name
, len
+ 1);
1600 /* See completer.h. */
1602 gdb::unique_xmalloc_ptr
<char>
1603 make_completion_match_str (const char *match_name
,
1604 const char *text
, const char *word
)
1606 char *newobj
= make_completion_match_str_1 (match_name
, text
, word
);
1608 newobj
= xstrdup (match_name
);
1609 return gdb::unique_xmalloc_ptr
<char> (newobj
);
1612 /* See completer.h. */
1614 gdb::unique_xmalloc_ptr
<char>
1615 make_completion_match_str (gdb::unique_xmalloc_ptr
<char> &&match_name
,
1616 const char *text
, const char *word
)
1618 char *newobj
= make_completion_match_str_1 (match_name
.get (), text
, word
);
1620 return std::move (match_name
);
1621 return gdb::unique_xmalloc_ptr
<char> (newobj
);
1624 /* Generate completions all at once. Does nothing if max_completions
1625 is 0. If max_completions is non-negative, this will collect at
1626 most max_completions strings.
1628 TEXT is the caller's idea of the "word" we are looking at.
1630 LINE_BUFFER is available to be looked at; it contains the entire
1633 POINT is the offset in that line of the cursor. You
1634 should pretend that the line ends at POINT. */
1637 complete_line (completion_tracker
&tracker
,
1638 const char *text
, const char *line_buffer
, int point
)
1640 if (max_completions
== 0)
1642 complete_line_internal (tracker
, text
, line_buffer
, point
,
1643 handle_completions
);
1646 /* Complete on command names. Used by "help". */
1649 command_completer (struct cmd_list_element
*ignore
,
1650 completion_tracker
&tracker
,
1651 const char *text
, const char *word
)
1653 complete_line_internal (tracker
, word
, text
,
1654 strlen (text
), handle_help
);
1657 /* The corresponding completer_handle_brkchars implementation. */
1660 command_completer_handle_brkchars (struct cmd_list_element
*ignore
,
1661 completion_tracker
&tracker
,
1662 const char *text
, const char *word
)
1664 set_rl_completer_word_break_characters
1665 (gdb_completer_command_word_break_characters
);
1668 /* Complete on signals. */
1671 signal_completer (struct cmd_list_element
*ignore
,
1672 completion_tracker
&tracker
,
1673 const char *text
, const char *word
)
1675 size_t len
= strlen (word
);
1677 const char *signame
;
1679 for (signum
= GDB_SIGNAL_FIRST
; signum
!= GDB_SIGNAL_LAST
; ++signum
)
1681 /* Can't handle this, so skip it. */
1682 if (signum
== GDB_SIGNAL_0
)
1685 signame
= gdb_signal_to_name ((enum gdb_signal
) signum
);
1687 /* Ignore the unknown signal case. */
1688 if (!signame
|| strcmp (signame
, "?") == 0)
1691 if (strncasecmp (signame
, word
, len
) == 0)
1693 gdb::unique_xmalloc_ptr
<char> copy (xstrdup (signame
));
1694 tracker
.add_completion (std::move (copy
));
1699 /* Bit-flags for selecting what the register and/or register-group
1700 completer should complete on. */
1702 enum reg_completer_target
1704 complete_register_names
= 0x1,
1705 complete_reggroup_names
= 0x2
1707 DEF_ENUM_FLAGS_TYPE (enum reg_completer_target
, reg_completer_targets
);
1709 /* Complete register names and/or reggroup names based on the value passed
1710 in TARGETS. At least one bit in TARGETS must be set. */
1713 reg_or_group_completer_1 (completion_tracker
&tracker
,
1714 const char *text
, const char *word
,
1715 reg_completer_targets targets
)
1717 size_t len
= strlen (word
);
1718 struct gdbarch
*gdbarch
;
1721 gdb_assert ((targets
& (complete_register_names
1722 | complete_reggroup_names
)) != 0);
1723 gdbarch
= get_current_arch ();
1725 if ((targets
& complete_register_names
) != 0)
1730 (name
= user_reg_map_regnum_to_name (gdbarch
, i
)) != NULL
;
1733 if (*name
!= '\0' && strncmp (word
, name
, len
) == 0)
1735 gdb::unique_xmalloc_ptr
<char> copy (xstrdup (name
));
1736 tracker
.add_completion (std::move (copy
));
1741 if ((targets
& complete_reggroup_names
) != 0)
1743 struct reggroup
*group
;
1745 for (group
= reggroup_next (gdbarch
, NULL
);
1747 group
= reggroup_next (gdbarch
, group
))
1749 name
= reggroup_name (group
);
1750 if (strncmp (word
, name
, len
) == 0)
1752 gdb::unique_xmalloc_ptr
<char> copy (xstrdup (name
));
1753 tracker
.add_completion (std::move (copy
));
1759 /* Perform completion on register and reggroup names. */
1762 reg_or_group_completer (struct cmd_list_element
*ignore
,
1763 completion_tracker
&tracker
,
1764 const char *text
, const char *word
)
1766 reg_or_group_completer_1 (tracker
, text
, word
,
1767 (complete_register_names
1768 | complete_reggroup_names
));
1771 /* Perform completion on reggroup names. */
1774 reggroup_completer (struct cmd_list_element
*ignore
,
1775 completion_tracker
&tracker
,
1776 const char *text
, const char *word
)
1778 reg_or_group_completer_1 (tracker
, text
, word
,
1779 complete_reggroup_names
);
1782 /* The default completer_handle_brkchars implementation. */
1785 default_completer_handle_brkchars (struct cmd_list_element
*ignore
,
1786 completion_tracker
&tracker
,
1787 const char *text
, const char *word
)
1789 set_rl_completer_word_break_characters
1790 (current_language
->la_word_break_characters ());
1793 /* See definition in completer.h. */
1795 completer_handle_brkchars_ftype
*
1796 completer_handle_brkchars_func_for_completer (completer_ftype
*fn
)
1798 if (fn
== filename_completer
)
1799 return filename_completer_handle_brkchars
;
1801 if (fn
== location_completer
)
1802 return location_completer_handle_brkchars
;
1804 if (fn
== command_completer
)
1805 return command_completer_handle_brkchars
;
1807 return default_completer_handle_brkchars
;
1810 /* Used as brkchars when we want to tell readline we have a custom
1811 word point. We do that by making our rl_completion_word_break_hook
1812 set RL_POINT to the desired word point, and return the character at
1813 the word break point as the break char. This is two bytes in order
1814 to fit one break character plus the terminating null. */
1815 static char gdb_custom_word_point_brkchars
[2];
1817 /* Since rl_basic_quote_characters is not completer-specific, we save
1818 its original value here, in order to be able to restore it in
1819 gdb_rl_attempted_completion_function. */
1820 static const char *gdb_org_rl_basic_quote_characters
= rl_basic_quote_characters
;
1822 /* Get the list of chars that are considered as word breaks
1823 for the current command. */
1826 gdb_completion_word_break_characters_throw ()
1828 /* New completion starting. Get rid of the previous tracker and
1830 delete current_completion
.tracker
;
1831 current_completion
.tracker
= new completion_tracker ();
1833 completion_tracker
&tracker
= *current_completion
.tracker
;
1835 complete_line_internal (tracker
, NULL
, rl_line_buffer
,
1836 rl_point
, handle_brkchars
);
1838 if (tracker
.use_custom_word_point ())
1840 gdb_assert (tracker
.custom_word_point () > 0);
1841 rl_point
= tracker
.custom_word_point () - 1;
1842 gdb_custom_word_point_brkchars
[0] = rl_line_buffer
[rl_point
];
1843 rl_completer_word_break_characters
= gdb_custom_word_point_brkchars
;
1844 rl_completer_quote_characters
= NULL
;
1846 /* Clear this too, so that if we're completing a quoted string,
1847 readline doesn't consider the quote character a delimiter.
1848 If we didn't do this, readline would auto-complete {b
1849 'fun<tab>} to {'b 'function()'}, i.e., add the terminating
1850 \', but, it wouldn't append the separator space either, which
1851 is not desirable. So instead we take care of appending the
1852 quote character to the LCD ourselves, in
1853 gdb_rl_attempted_completion_function. Since this global is
1854 not just completer-specific, we'll restore it back to the
1855 default in gdb_rl_attempted_completion_function. */
1856 rl_basic_quote_characters
= NULL
;
1859 return rl_completer_word_break_characters
;
1863 gdb_completion_word_break_characters ()
1865 /* New completion starting. */
1866 current_completion
.aborted
= false;
1870 return gdb_completion_word_break_characters_throw ();
1872 CATCH (ex
, RETURN_MASK_ALL
)
1874 /* Set this to that gdb_rl_attempted_completion_function knows
1876 current_completion
.aborted
= true;
1883 /* See completer.h. */
1886 completion_find_completion_word (completion_tracker
&tracker
, const char *text
,
1889 size_t point
= strlen (text
);
1891 complete_line_internal (tracker
, NULL
, text
, point
, handle_brkchars
);
1893 if (tracker
.use_custom_word_point ())
1895 gdb_assert (tracker
.custom_word_point () > 0);
1896 *quote_char
= tracker
.quote_char ();
1897 return text
+ tracker
.custom_word_point ();
1900 gdb_rl_completion_word_info info
;
1902 info
.word_break_characters
= rl_completer_word_break_characters
;
1903 info
.quote_characters
= gdb_completer_quote_characters
;
1904 info
.basic_quote_characters
= rl_basic_quote_characters
;
1906 return gdb_rl_find_completion_word (&info
, quote_char
, NULL
, text
);
1909 /* See completer.h. */
1912 completion_tracker::recompute_lowest_common_denominator
1913 (gdb::unique_xmalloc_ptr
<char> &&new_match_up
)
1915 if (m_lowest_common_denominator
== NULL
)
1917 /* We don't have a lowest common denominator yet, so simply take
1918 the whole NEW_MATCH_UP as being it. */
1919 m_lowest_common_denominator
= new_match_up
.release ();
1920 m_lowest_common_denominator_unique
= true;
1924 /* Find the common denominator between the currently-known
1925 lowest common denominator and NEW_MATCH_UP. That becomes the
1926 new lowest common denominator. */
1928 const char *new_match
= new_match_up
.get ();
1931 (new_match
[i
] != '\0'
1932 && new_match
[i
] == m_lowest_common_denominator
[i
]);
1935 if (m_lowest_common_denominator
[i
] != new_match
[i
])
1937 m_lowest_common_denominator
[i
] = '\0';
1938 m_lowest_common_denominator_unique
= false;
1943 /* See completer.h. */
1946 completion_tracker::advance_custom_word_point_by (size_t len
)
1948 m_custom_word_point
+= len
;
1951 /* Build a new C string that is a copy of LCD with the whitespace of
1952 ORIG/ORIG_LEN preserved.
1954 Say the user is completing a symbol name, with spaces, like:
1958 and the resulting completion match is:
1962 we want to end up with an input line like:
1965 ^^^^^^^ => text from LCD [1], whitespace from ORIG preserved.
1966 ^^ => new text from LCD
1968 [1] - We must take characters from the LCD instead of the original
1969 text, since some completions want to change upper/lowercase. E.g.:
1975 "handle SIG[QUIT|etc.]"
1979 expand_preserving_ws (const char *orig
, size_t orig_len
,
1982 const char *p_orig
= orig
;
1983 const char *orig_end
= orig
+ orig_len
;
1984 const char *p_lcd
= lcd
;
1987 while (p_orig
< orig_end
)
1991 while (p_orig
< orig_end
&& *p_orig
== ' ')
1993 p_lcd
= skip_spaces (p_lcd
);
1997 /* Take characters from the LCD instead of the original
1998 text, since some completions change upper/lowercase.
2002 "handle SIG[QUIT|etc.]"
2010 while (*p_lcd
!= '\0')
2013 return xstrdup (res
.c_str ());
2016 /* See completer.h. */
2019 completion_tracker::build_completion_result (const char *text
,
2022 completion_list
&list
= m_entries_vec
; /* The completions. */
2027 /* +1 for the LCD, and +1 for NULL termination. */
2028 char **match_list
= XNEWVEC (char *, 1 + list
.size () + 1);
2030 /* Build replacement word, based on the LCD. */
2033 = expand_preserving_ws (text
, end
- start
,
2034 m_lowest_common_denominator
);
2036 if (m_lowest_common_denominator_unique
)
2038 /* We don't rely on readline appending the quote char as
2039 delimiter as then readline wouldn't append the ' ' after the
2041 char buf
[2] = { quote_char () };
2043 match_list
[0] = reconcat (match_list
[0], match_list
[0],
2044 buf
, (char *) NULL
);
2045 match_list
[1] = NULL
;
2047 /* If the tracker wants to, or we already have a space at the
2048 end of the match, tell readline to skip appending
2050 bool completion_suppress_append
2051 = (suppress_append_ws ()
2052 || match_list
[0][strlen (match_list
[0]) - 1] == ' ');
2054 return completion_result (match_list
, 1, completion_suppress_append
);
2060 for (ix
= 0; ix
< list
.size (); ++ix
)
2061 match_list
[ix
+ 1] = list
[ix
].release ();
2062 match_list
[ix
+ 1] = NULL
;
2064 return completion_result (match_list
, list
.size (), false);
2068 /* See completer.h */
2070 completion_result::completion_result ()
2071 : match_list (NULL
), number_matches (0),
2072 completion_suppress_append (false)
2075 /* See completer.h */
2077 completion_result::completion_result (char **match_list_
,
2078 size_t number_matches_
,
2079 bool completion_suppress_append_
)
2080 : match_list (match_list_
),
2081 number_matches (number_matches_
),
2082 completion_suppress_append (completion_suppress_append_
)
2085 /* See completer.h */
2087 completion_result::~completion_result ()
2089 reset_match_list ();
2092 /* See completer.h */
2094 completion_result::completion_result (completion_result
&&rhs
)
2099 reset_match_list ();
2100 match_list
= rhs
.match_list
;
2101 rhs
.match_list
= NULL
;
2102 number_matches
= rhs
.number_matches
;
2103 rhs
.number_matches
= 0;
2106 /* See completer.h */
2109 completion_result::release_match_list ()
2111 char **ret
= match_list
;
2116 /* See completer.h */
2119 completion_result::sort_match_list ()
2121 if (number_matches
> 1)
2123 /* Element 0 is special (it's the common prefix), leave it
2125 std::sort (&match_list
[1],
2126 &match_list
[number_matches
+ 1],
2131 /* See completer.h */
2134 completion_result::reset_match_list ()
2136 if (match_list
!= NULL
)
2138 for (char **p
= match_list
; *p
!= NULL
; p
++)
2145 /* Helper for gdb_rl_attempted_completion_function, which does most of
2146 the work. This is called by readline to build the match list array
2147 and to determine the lowest common denominator. The real matches
2148 list starts at match[1], while match[0] is the slot holding
2149 readline's idea of the lowest common denominator of all matches,
2150 which is what readline replaces the completion "word" with.
2152 TEXT is the caller's idea of the "word" we are looking at, as
2153 computed in the handle_brkchars phase.
2155 START is the offset from RL_LINE_BUFFER where TEXT starts. END is
2156 the offset from RL_LINE_BUFFER where TEXT ends (i.e., where
2159 You should thus pretend that the line ends at END (relative to
2162 RL_LINE_BUFFER contains the entire text of the line. RL_POINT is
2163 the offset in that line of the cursor. You should pretend that the
2166 Returns NULL if there are no completions. */
2169 gdb_rl_attempted_completion_function_throw (const char *text
, int start
, int end
)
2171 /* Completers that provide a custom word point in the
2172 handle_brkchars phase also compute their completions then.
2173 Completers that leave the completion word handling to readline
2174 must be called twice. If rl_point (i.e., END) is at column 0,
2175 then readline skips the handle_brkchars phase, and so we create a
2176 tracker now in that case too. */
2177 if (end
== 0 || !current_completion
.tracker
->use_custom_word_point ())
2179 delete current_completion
.tracker
;
2180 current_completion
.tracker
= new completion_tracker ();
2182 complete_line (*current_completion
.tracker
, text
,
2183 rl_line_buffer
, rl_point
);
2186 completion_tracker
&tracker
= *current_completion
.tracker
;
2188 completion_result result
2189 = tracker
.build_completion_result (text
, start
, end
);
2191 rl_completion_suppress_append
= result
.completion_suppress_append
;
2192 return result
.release_match_list ();
2195 /* Function installed as "rl_attempted_completion_function" readline
2196 hook. Wrapper around gdb_rl_attempted_completion_function_throw
2197 that catches C++ exceptions, which can't cross readline. */
2200 gdb_rl_attempted_completion_function (const char *text
, int start
, int end
)
2202 /* Restore globals that might have been tweaked in
2203 gdb_completion_word_break_characters. */
2204 rl_basic_quote_characters
= gdb_org_rl_basic_quote_characters
;
2206 /* If we end up returning NULL, either on error, or simple because
2207 there are no matches, inhibit readline's default filename
2209 rl_attempted_completion_over
= 1;
2211 /* If the handle_brkchars phase was aborted, don't try
2213 if (current_completion
.aborted
)
2218 return gdb_rl_attempted_completion_function_throw (text
, start
, end
);
2220 CATCH (ex
, RETURN_MASK_ALL
)
2228 /* Skip over the possibly quoted word STR (as defined by the quote
2229 characters QUOTECHARS and the word break characters BREAKCHARS).
2230 Returns pointer to the location after the "word". If either
2231 QUOTECHARS or BREAKCHARS is NULL, use the same values used by the
2235 skip_quoted_chars (const char *str
, const char *quotechars
,
2236 const char *breakchars
)
2238 char quote_char
= '\0';
2241 if (quotechars
== NULL
)
2242 quotechars
= gdb_completer_quote_characters
;
2244 if (breakchars
== NULL
)
2245 breakchars
= current_language
->la_word_break_characters();
2247 for (scan
= str
; *scan
!= '\0'; scan
++)
2249 if (quote_char
!= '\0')
2251 /* Ignore everything until the matching close quote char. */
2252 if (*scan
== quote_char
)
2254 /* Found matching close quote. */
2259 else if (strchr (quotechars
, *scan
))
2261 /* Found start of a quoted string. */
2264 else if (strchr (breakchars
, *scan
))
2273 /* Skip over the possibly quoted word STR (as defined by the quote
2274 characters and word break characters used by the completer).
2275 Returns pointer to the location after the "word". */
2278 skip_quoted (const char *str
)
2280 return skip_quoted_chars (str
, NULL
, NULL
);
2283 /* Return a message indicating that the maximum number of completions
2284 has been reached and that there may be more. */
2287 get_max_completions_reached_message (void)
2289 return _("*** List may be truncated, max-completions reached. ***");
2292 /* GDB replacement for rl_display_match_list.
2293 Readline doesn't provide a clean interface for TUI(curses).
2294 A hack previously used was to send readline's rl_outstream through a pipe
2295 and read it from the event loop. Bleah. IWBN if readline abstracted
2296 away all the necessary bits, and this is what this code does. It
2297 replicates the parts of readline we need and then adds an abstraction
2298 layer, currently implemented as struct match_list_displayer, so that both
2299 CLI and TUI can use it. We copy all this readline code to minimize
2300 GDB-specific mods to readline. Once this code performs as desired then
2301 we can submit it to the readline maintainers.
2303 N.B. A lot of the code is the way it is in order to minimize differences
2304 from readline's copy. */
2306 /* Not supported here. */
2307 #undef VISIBLE_STATS
2309 #if defined (HANDLE_MULTIBYTE)
2310 #define MB_INVALIDCH(x) ((x) == (size_t)-1 || (x) == (size_t)-2)
2311 #define MB_NULLWCH(x) ((x) == 0)
2314 #define ELLIPSIS_LEN 3
2316 /* gdb version of readline/complete.c:get_y_or_n.
2317 'y' -> returns 1, and 'n' -> returns 0.
2318 Also supported: space == 'y', RUBOUT == 'n', ctrl-g == start over.
2319 If FOR_PAGER is non-zero, then also supported are:
2320 NEWLINE or RETURN -> returns 2, and 'q' -> returns 0. */
2323 gdb_get_y_or_n (int for_pager
, const struct match_list_displayer
*displayer
)
2329 RL_SETSTATE (RL_STATE_MOREINPUT
);
2330 c
= displayer
->read_key (displayer
);
2331 RL_UNSETSTATE (RL_STATE_MOREINPUT
);
2333 if (c
== 'y' || c
== 'Y' || c
== ' ')
2335 if (c
== 'n' || c
== 'N' || c
== RUBOUT
)
2337 if (c
== ABORT_CHAR
|| c
< 0)
2339 /* Readline doesn't erase_entire_line here, but without it the
2340 --More-- prompt isn't erased and neither is the text entered
2341 thus far redisplayed. */
2342 displayer
->erase_entire_line (displayer
);
2343 /* Note: The arguments to rl_abort are ignored. */
2346 if (for_pager
&& (c
== NEWLINE
|| c
== RETURN
))
2348 if (for_pager
&& (c
== 'q' || c
== 'Q'))
2350 displayer
->beep (displayer
);
2354 /* Pager function for tab-completion.
2355 This is based on readline/complete.c:_rl_internal_pager.
2356 LINES is the number of lines of output displayed thus far.
2358 -1 -> user pressed 'n' or equivalent,
2359 0 -> user pressed 'y' or equivalent,
2360 N -> user pressed NEWLINE or equivalent and N is LINES - 1. */
2363 gdb_display_match_list_pager (int lines
,
2364 const struct match_list_displayer
*displayer
)
2368 displayer
->puts (displayer
, "--More--");
2369 displayer
->flush (displayer
);
2370 i
= gdb_get_y_or_n (1, displayer
);
2371 displayer
->erase_entire_line (displayer
);
2380 /* Return non-zero if FILENAME is a directory.
2381 Based on readline/complete.c:path_isdir. */
2384 gdb_path_isdir (const char *filename
)
2388 return (stat (filename
, &finfo
) == 0 && S_ISDIR (finfo
.st_mode
));
2391 /* Return the portion of PATHNAME that should be output when listing
2392 possible completions. If we are hacking filename completion, we
2393 are only interested in the basename, the portion following the
2394 final slash. Otherwise, we return what we were passed. Since
2395 printing empty strings is not very informative, if we're doing
2396 filename completion, and the basename is the empty string, we look
2397 for the previous slash and return the portion following that. If
2398 there's no previous slash, we just return what we were passed.
2400 Based on readline/complete.c:printable_part. */
2403 gdb_printable_part (char *pathname
)
2407 if (rl_filename_completion_desired
== 0) /* don't need to do anything */
2410 temp
= strrchr (pathname
, '/');
2411 #if defined (__MSDOS__)
2412 if (temp
== 0 && ISALPHA ((unsigned char)pathname
[0]) && pathname
[1] == ':')
2413 temp
= pathname
+ 1;
2416 if (temp
== 0 || *temp
== '\0')
2418 /* If the basename is NULL, we might have a pathname like '/usr/src/'.
2419 Look for a previous slash and, if one is found, return the portion
2420 following that slash. If there's no previous slash, just return the
2421 pathname we were passed. */
2422 else if (temp
[1] == '\0')
2424 for (x
= temp
- 1; x
> pathname
; x
--)
2427 return ((*x
== '/') ? x
+ 1 : pathname
);
2433 /* Compute width of STRING when displayed on screen by print_filename.
2434 Based on readline/complete.c:fnwidth. */
2437 gdb_fnwidth (const char *string
)
2440 #if defined (HANDLE_MULTIBYTE)
2446 left
= strlen (string
) + 1;
2447 memset (&ps
, 0, sizeof (mbstate_t));
2453 if (CTRL_CHAR (string
[pos
]) || string
[pos
] == RUBOUT
)
2460 #if defined (HANDLE_MULTIBYTE)
2461 clen
= mbrtowc (&wc
, string
+ pos
, left
- pos
, &ps
);
2462 if (MB_INVALIDCH (clen
))
2466 memset (&ps
, 0, sizeof (mbstate_t));
2468 else if (MB_NULLWCH (clen
))
2474 width
+= (w
>= 0) ? w
: 1;
2486 /* Print TO_PRINT, one matching completion.
2487 PREFIX_BYTES is number of common prefix bytes.
2488 Based on readline/complete.c:fnprint. */
2491 gdb_fnprint (const char *to_print
, int prefix_bytes
,
2492 const struct match_list_displayer
*displayer
)
2496 #if defined (HANDLE_MULTIBYTE)
2503 end
= to_print
+ strlen (to_print
) + 1;
2504 memset (&ps
, 0, sizeof (mbstate_t));
2509 /* Don't print only the ellipsis if the common prefix is one of the
2510 possible completions */
2511 if (to_print
[prefix_bytes
] == '\0')
2518 ellipsis
= (to_print
[prefix_bytes
] == '.') ? '_' : '.';
2519 for (w
= 0; w
< ELLIPSIS_LEN
; w
++)
2520 displayer
->putch (displayer
, ellipsis
);
2521 printed_len
= ELLIPSIS_LEN
;
2524 s
= to_print
+ prefix_bytes
;
2529 displayer
->putch (displayer
, '^');
2530 displayer
->putch (displayer
, UNCTRL (*s
));
2533 #if defined (HANDLE_MULTIBYTE)
2534 memset (&ps
, 0, sizeof (mbstate_t));
2537 else if (*s
== RUBOUT
)
2539 displayer
->putch (displayer
, '^');
2540 displayer
->putch (displayer
, '?');
2543 #if defined (HANDLE_MULTIBYTE)
2544 memset (&ps
, 0, sizeof (mbstate_t));
2549 #if defined (HANDLE_MULTIBYTE)
2550 tlen
= mbrtowc (&wc
, s
, end
- s
, &ps
);
2551 if (MB_INVALIDCH (tlen
))
2555 memset (&ps
, 0, sizeof (mbstate_t));
2557 else if (MB_NULLWCH (tlen
))
2562 width
= (w
>= 0) ? w
: 1;
2564 for (w
= 0; w
< tlen
; ++w
)
2565 displayer
->putch (displayer
, s
[w
]);
2567 printed_len
+= width
;
2569 displayer
->putch (displayer
, *s
);
2579 /* Output TO_PRINT to rl_outstream. If VISIBLE_STATS is defined and we
2580 are using it, check for and output a single character for `special'
2581 filenames. Return the number of characters we output.
2582 Based on readline/complete.c:print_filename. */
2585 gdb_print_filename (char *to_print
, char *full_pathname
, int prefix_bytes
,
2586 const struct match_list_displayer
*displayer
)
2588 int printed_len
, extension_char
, slen
, tlen
;
2589 char *s
, c
, *new_full_pathname
;
2591 extern int _rl_complete_mark_directories
;
2594 printed_len
= gdb_fnprint (to_print
, prefix_bytes
, displayer
);
2596 #if defined (VISIBLE_STATS)
2597 if (rl_filename_completion_desired
&& (rl_visible_stats
|| _rl_complete_mark_directories
))
2599 if (rl_filename_completion_desired
&& _rl_complete_mark_directories
)
2602 /* If to_print != full_pathname, to_print is the basename of the
2603 path passed. In this case, we try to expand the directory
2604 name before checking for the stat character. */
2605 if (to_print
!= full_pathname
)
2607 /* Terminate the directory name. */
2609 to_print
[-1] = '\0';
2611 /* If setting the last slash in full_pathname to a NUL results in
2612 full_pathname being the empty string, we are trying to complete
2613 files in the root directory. If we pass a null string to the
2614 bash directory completion hook, for example, it will expand it
2615 to the current directory. We just want the `/'. */
2616 if (full_pathname
== 0 || *full_pathname
== 0)
2618 else if (full_pathname
[0] != '/')
2620 else if (full_pathname
[1] == 0)
2621 dn
= "//"; /* restore trailing slash to `//' */
2622 else if (full_pathname
[1] == '/' && full_pathname
[2] == 0)
2623 dn
= "/"; /* don't turn /// into // */
2626 s
= tilde_expand (dn
);
2627 if (rl_directory_completion_hook
)
2628 (*rl_directory_completion_hook
) (&s
);
2631 tlen
= strlen (to_print
);
2632 new_full_pathname
= (char *)xmalloc (slen
+ tlen
+ 2);
2633 strcpy (new_full_pathname
, s
);
2634 if (s
[slen
- 1] == '/')
2637 new_full_pathname
[slen
] = '/';
2638 new_full_pathname
[slen
] = '/';
2639 strcpy (new_full_pathname
+ slen
+ 1, to_print
);
2641 #if defined (VISIBLE_STATS)
2642 if (rl_visible_stats
)
2643 extension_char
= stat_char (new_full_pathname
);
2646 if (gdb_path_isdir (new_full_pathname
))
2647 extension_char
= '/';
2649 xfree (new_full_pathname
);
2654 s
= tilde_expand (full_pathname
);
2655 #if defined (VISIBLE_STATS)
2656 if (rl_visible_stats
)
2657 extension_char
= stat_char (s
);
2660 if (gdb_path_isdir (s
))
2661 extension_char
= '/';
2667 displayer
->putch (displayer
, extension_char
);
2675 /* GDB version of readline/complete.c:complete_get_screenwidth. */
2678 gdb_complete_get_screenwidth (const struct match_list_displayer
*displayer
)
2680 /* Readline has other stuff here which it's not clear we need. */
2681 return displayer
->width
;
2684 extern int _rl_completion_prefix_display_length
;
2685 extern int _rl_print_completions_horizontally
;
2687 EXTERN_C
int _rl_qsort_string_compare (const void *, const void *);
2688 typedef int QSFUNC (const void *, const void *);
2690 /* GDB version of readline/complete.c:rl_display_match_list.
2691 See gdb_display_match_list for a description of MATCHES, LEN, MAX.
2692 Returns non-zero if all matches are displayed. */
2695 gdb_display_match_list_1 (char **matches
, int len
, int max
,
2696 const struct match_list_displayer
*displayer
)
2698 int count
, limit
, printed_len
, lines
, cols
;
2699 int i
, j
, k
, l
, common_length
, sind
;
2701 int page_completions
= displayer
->height
!= INT_MAX
&& pagination_enabled
;
2703 /* Find the length of the prefix common to all items: length as displayed
2704 characters (common_length) and as a byte index into the matches (sind) */
2705 common_length
= sind
= 0;
2706 if (_rl_completion_prefix_display_length
> 0)
2708 t
= gdb_printable_part (matches
[0]);
2709 temp
= strrchr (t
, '/');
2710 common_length
= temp
? gdb_fnwidth (temp
) : gdb_fnwidth (t
);
2711 sind
= temp
? strlen (temp
) : strlen (t
);
2713 if (common_length
> _rl_completion_prefix_display_length
&& common_length
> ELLIPSIS_LEN
)
2714 max
-= common_length
- ELLIPSIS_LEN
;
2716 common_length
= sind
= 0;
2719 /* How many items of MAX length can we fit in the screen window? */
2720 cols
= gdb_complete_get_screenwidth (displayer
);
2723 if (limit
!= 1 && (limit
* max
== cols
))
2726 /* If cols == 0, limit will end up -1 */
2727 if (cols
< displayer
->width
&& limit
< 0)
2730 /* Avoid a possible floating exception. If max > cols,
2731 limit will be 0 and a divide-by-zero fault will result. */
2735 /* How many iterations of the printing loop? */
2736 count
= (len
+ (limit
- 1)) / limit
;
2738 /* Watch out for special case. If LEN is less than LIMIT, then
2739 just do the inner printing loop.
2740 0 < len <= limit implies count = 1. */
2742 /* Sort the items if they are not already sorted. */
2743 if (rl_ignore_completion_duplicates
== 0 && rl_sort_completion_matches
)
2744 qsort (matches
+ 1, len
, sizeof (char *), (QSFUNC
*)_rl_qsort_string_compare
);
2746 displayer
->crlf (displayer
);
2749 if (_rl_print_completions_horizontally
== 0)
2751 /* Print the sorted items, up-and-down alphabetically, like ls. */
2752 for (i
= 1; i
<= count
; i
++)
2754 for (j
= 0, l
= i
; j
< limit
; j
++)
2756 if (l
> len
|| matches
[l
] == 0)
2760 temp
= gdb_printable_part (matches
[l
]);
2761 printed_len
= gdb_print_filename (temp
, matches
[l
], sind
,
2765 for (k
= 0; k
< max
- printed_len
; k
++)
2766 displayer
->putch (displayer
, ' ');
2770 displayer
->crlf (displayer
);
2772 if (page_completions
&& lines
>= (displayer
->height
- 1) && i
< count
)
2774 lines
= gdb_display_match_list_pager (lines
, displayer
);
2782 /* Print the sorted items, across alphabetically, like ls -x. */
2783 for (i
= 1; matches
[i
]; i
++)
2785 temp
= gdb_printable_part (matches
[i
]);
2786 printed_len
= gdb_print_filename (temp
, matches
[i
], sind
, displayer
);
2787 /* Have we reached the end of this line? */
2790 if (i
&& (limit
> 1) && (i
% limit
) == 0)
2792 displayer
->crlf (displayer
);
2794 if (page_completions
&& lines
>= displayer
->height
- 1)
2796 lines
= gdb_display_match_list_pager (lines
, displayer
);
2802 for (k
= 0; k
< max
- printed_len
; k
++)
2803 displayer
->putch (displayer
, ' ');
2806 displayer
->crlf (displayer
);
2812 /* Utility for displaying completion list matches, used by both CLI and TUI.
2814 MATCHES is the list of strings, in argv format, LEN is the number of
2815 strings in MATCHES, and MAX is the length of the longest string in
2819 gdb_display_match_list (char **matches
, int len
, int max
,
2820 const struct match_list_displayer
*displayer
)
2822 /* Readline will never call this if complete_line returned NULL. */
2823 gdb_assert (max_completions
!= 0);
2825 /* complete_line will never return more than this. */
2826 if (max_completions
> 0)
2827 gdb_assert (len
<= max_completions
);
2829 if (rl_completion_query_items
> 0 && len
>= rl_completion_query_items
)
2833 /* We can't use *query here because they wait for <RET> which is
2834 wrong here. This follows the readline version as closely as possible
2835 for compatibility's sake. See readline/complete.c. */
2837 displayer
->crlf (displayer
);
2839 xsnprintf (msg
, sizeof (msg
),
2840 "Display all %d possibilities? (y or n)", len
);
2841 displayer
->puts (displayer
, msg
);
2842 displayer
->flush (displayer
);
2844 if (gdb_get_y_or_n (0, displayer
) == 0)
2846 displayer
->crlf (displayer
);
2851 if (gdb_display_match_list_1 (matches
, len
, max
, displayer
))
2853 /* Note: MAX_COMPLETIONS may be -1 or zero, but LEN is always > 0. */
2854 if (len
== max_completions
)
2856 /* The maximum number of completions has been reached. Warn the user
2857 that there may be more. */
2858 const char *message
= get_max_completions_reached_message ();
2860 displayer
->puts (displayer
, message
);
2861 displayer
->crlf (displayer
);
2867 _initialize_completer (void)
2869 add_setshow_zuinteger_unlimited_cmd ("max-completions", no_class
,
2870 &max_completions
, _("\
2871 Set maximum number of completion candidates."), _("\
2872 Show maximum number of completion candidates."), _("\
2873 Use this to limit the number of candidates considered\n\
2874 during completion. Specifying \"unlimited\" or -1\n\
2875 disables limiting. Note that setting either no limit or\n\
2876 a very large limit can make completion slow."),
2877 NULL
, NULL
, &setlist
, &showlist
);