Commit | Line | Data |
---|---|---|
c5f0f3d0 | 1 | /* Line completion stuff for GDB, the GNU debugger. |
42a4f53d | 2 | Copyright (C) 2000-2019 Free Software Foundation, Inc. |
c5f0f3d0 FN |
3 | |
4 | This file is part of GDB. | |
5 | ||
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 | |
a9762ec7 | 8 | the Free Software Foundation; either version 3 of the License, or |
c5f0f3d0 FN |
9 | (at your option) any later version. |
10 | ||
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. | |
15 | ||
16 | You should have received a copy of the GNU General Public License | |
a9762ec7 | 17 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
c5f0f3d0 FN |
18 | |
19 | #include "defs.h" | |
4de283e4 | 20 | #include "symtab.h" |
d55e5aa6 | 21 | #include "gdbtypes.h" |
4de283e4 TT |
22 | #include "expression.h" |
23 | #include "filenames.h" /* For DOSish file names. */ | |
51065942 | 24 | #include "language.h" |
4de283e4 | 25 | #include "common/gdb_signals.h" |
d55e5aa6 | 26 | #include "target.h" |
4de283e4 | 27 | #include "reggroups.h" |
71c24708 | 28 | #include "user-regs.h" |
4de283e4 TT |
29 | #include "arch-utils.h" |
30 | #include "location.h" | |
31 | #include <algorithm> | |
32 | #include "linespec.h" | |
33 | #include "cli/cli-decode.h" | |
18a642a1 | 34 | |
03717487 MS |
35 | /* FIXME: This is needed because of lookup_cmd_1 (). We should be |
36 | calling a hook instead so we eliminate the CLI dependency. */ | |
c5f0f3d0 FN |
37 | #include "gdbcmd.h" |
38 | ||
c94fdfd0 | 39 | /* Needed for rl_completer_word_break_characters() and for |
38017ce8 | 40 | rl_filename_completion_function. */ |
dbda9972 | 41 | #include "readline/readline.h" |
c5f0f3d0 FN |
42 | |
43 | /* readline defines this. */ | |
44 | #undef savestring | |
45 | ||
46 | #include "completer.h" | |
47 | ||
eb3ff9a5 PA |
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. */ | |
51 | ||
52 | struct gdb_completer_state | |
53 | { | |
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 | |
57 | callbacks. */ | |
58 | completion_tracker *tracker = NULL; | |
59 | ||
60 | /* Whether the current completion was aborted. */ | |
61 | bool aborted = false; | |
62 | }; | |
63 | ||
64 | /* The current completion state. */ | |
65 | static gdb_completer_state current_completion; | |
66 | ||
c6756f62 PA |
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. */ | |
87f0e720 KS |
70 | |
71 | enum explicit_location_match_type | |
72 | { | |
73 | /* The filename of a source file. */ | |
74 | MATCH_SOURCE, | |
75 | ||
76 | /* The name of a function or method. */ | |
77 | MATCH_FUNCTION, | |
78 | ||
a20714ff PA |
79 | /* The fully-qualified name of a function or method. */ |
80 | MATCH_QUALIFIED, | |
81 | ||
c6756f62 PA |
82 | /* A line number. */ |
83 | MATCH_LINE, | |
84 | ||
87f0e720 KS |
85 | /* The name of a label. */ |
86 | MATCH_LABEL | |
87 | }; | |
88 | ||
9c3f90bd | 89 | /* Prototypes for local functions. */ |
c5f0f3d0 FN |
90 | |
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, | |
aff410f1 MS |
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. | |
c5f0f3d0 FN |
96 | (2) If one of the matches contains a word break character, readline |
97 | will quote it. That's why we switch between | |
51065942 | 98 | current_language->la_word_break_characters() and |
c5f0f3d0 | 99 | gdb_completer_command_word_break_characters. I'm not sure when |
aff410f1 MS |
100 | we need this behavior (perhaps for funky characters in C++ |
101 | symbols?). */ | |
c5f0f3d0 FN |
102 | |
103 | /* Variables which are necessary for fancy command line editing. */ | |
c5f0f3d0 FN |
104 | |
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, | |
aff410f1 MS |
108 | it thinks that the string needs to be quoted and automatically |
109 | supplies a leading quote. */ | |
67cb5b2d | 110 | static const char gdb_completer_command_word_break_characters[] = |
c5f0f3d0 FN |
111 | " \t\n!@#$%^&*()+=|~`}{[]\"';:?/>.<,"; |
112 | ||
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. */ | |
7830cf6f EZ |
117 | /* MS-DOS and MS-Windows use colon as part of the drive spec, and most |
118 | programs support @foo style response files. */ | |
67cb5b2d PA |
119 | static const char gdb_completer_file_name_break_characters[] = |
120 | #ifdef HAVE_DOS_BASED_FILE_SYSTEM | |
121 | " \t\n*|\"';?><@"; | |
7830cf6f | 122 | #else |
67cb5b2d | 123 | " \t\n*|\"';:?><"; |
7830cf6f | 124 | #endif |
c5f0f3d0 | 125 | |
aff410f1 MS |
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. */ | |
67cb5b2d | 129 | static const char gdb_completer_quote_characters[] = "'"; |
c5f0f3d0 | 130 | \f |
9c3f90bd | 131 | /* Accessor for some completer data that may interest other files. */ |
c5f0f3d0 | 132 | |
67cb5b2d | 133 | const char * |
c5f0f3d0 FN |
134 | get_gdb_completer_quote_characters (void) |
135 | { | |
136 | return gdb_completer_quote_characters; | |
137 | } | |
138 | ||
aff410f1 MS |
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. */ | |
eb3ff9a5 PA |
141 | |
142 | void | |
aff410f1 | 143 | noop_completer (struct cmd_list_element *ignore, |
eb3ff9a5 | 144 | completion_tracker &tracker, |
6f937416 | 145 | const char *text, const char *prefix) |
d75b5104 | 146 | { |
d75b5104 EZ |
147 | } |
148 | ||
c5f0f3d0 | 149 | /* Complete on filenames. */ |
6e1dbf8c | 150 | |
eb3ff9a5 PA |
151 | void |
152 | filename_completer (struct cmd_list_element *ignore, | |
153 | completion_tracker &tracker, | |
6f937416 | 154 | const char *text, const char *word) |
c5f0f3d0 | 155 | { |
c5f0f3d0 | 156 | int subsequent_name; |
c5f0f3d0 FN |
157 | |
158 | subsequent_name = 0; | |
159 | while (1) | |
160 | { | |
60a20c19 PA |
161 | gdb::unique_xmalloc_ptr<char> p_rl |
162 | (rl_filename_completion_function (text, subsequent_name)); | |
163 | if (p_rl == NULL) | |
49c4e619 | 164 | break; |
c5f0f3d0 | 165 | /* We need to set subsequent_name to a non-zero value before the |
aff410f1 MS |
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. */ | |
c5f0f3d0 | 169 | subsequent_name = 1; |
aff410f1 MS |
170 | /* Like emacs, don't complete on old versions. Especially |
171 | useful in the "source" command. */ | |
60a20c19 | 172 | const char *p = p_rl.get (); |
c5f0f3d0 | 173 | if (p[strlen (p) - 1] == '~') |
60a20c19 | 174 | continue; |
c5f0f3d0 | 175 | |
60a20c19 PA |
176 | tracker.add_completion |
177 | (make_completion_match_str (std::move (p_rl), text, word)); | |
c5f0f3d0 FN |
178 | } |
179 | #if 0 | |
aff410f1 MS |
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. */ | |
489f0516 | 183 | /* Ensure that readline does the right thing |
c5f0f3d0 FN |
184 | with respect to inserting quotes. */ |
185 | rl_completer_word_break_characters = ""; | |
186 | #endif | |
c5f0f3d0 FN |
187 | } |
188 | ||
6e1dbf8c PA |
189 | /* The corresponding completer_handle_brkchars |
190 | implementation. */ | |
191 | ||
192 | static void | |
193 | filename_completer_handle_brkchars (struct cmd_list_element *ignore, | |
eb3ff9a5 | 194 | completion_tracker &tracker, |
6e1dbf8c PA |
195 | const char *text, const char *word) |
196 | { | |
197 | set_rl_completer_word_break_characters | |
198 | (gdb_completer_file_name_break_characters); | |
199 | } | |
200 | ||
6a2c1b87 PA |
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 | |
203 | in the line. */ | |
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 | |
208 | ||
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 | |
212 | function. | |
213 | ||
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. */ | |
222 | ||
223 | struct gdb_rl_completion_word_info | |
224 | { | |
225 | const char *word_break_characters; | |
226 | const char *quote_characters; | |
227 | const char *basic_quote_characters; | |
228 | }; | |
229 | ||
230 | static const char * | |
231 | gdb_rl_find_completion_word (struct gdb_rl_completion_word_info *info, | |
232 | int *qc, int *dp, | |
233 | const char *line_buffer) | |
234 | { | |
235 | int scan, end, found_quote, delimiter, pass_next, isbrk; | |
236 | char quote_char; | |
237 | const char *brkchars; | |
238 | int point = strlen (line_buffer); | |
239 | ||
240 | /* The algorithm below does '--point'. Avoid buffer underflow with | |
241 | the empty string. */ | |
242 | if (point == 0) | |
243 | { | |
244 | if (qc != NULL) | |
245 | *qc = '\0'; | |
246 | if (dp != NULL) | |
247 | *dp = '\0'; | |
248 | return line_buffer; | |
249 | } | |
250 | ||
251 | end = point; | |
252 | found_quote = delimiter = 0; | |
253 | quote_char = '\0'; | |
254 | ||
255 | brkchars = info->word_break_characters; | |
256 | ||
257 | if (info->quote_characters != NULL) | |
258 | { | |
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 | |
263 | found. */ | |
264 | for (scan = pass_next = 0; | |
265 | scan < end; | |
266 | scan++) | |
267 | { | |
268 | if (pass_next) | |
269 | { | |
270 | pass_next = 0; | |
271 | continue; | |
272 | } | |
273 | ||
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] == '\\') | |
279 | { | |
280 | pass_next = 1; | |
281 | found_quote |= RL_QF_BACKSLASH; | |
282 | continue; | |
283 | } | |
284 | ||
285 | if (quote_char != '\0') | |
286 | { | |
287 | /* Ignore everything until the matching close quote | |
288 | char. */ | |
289 | if (line_buffer[scan] == quote_char) | |
290 | { | |
291 | /* Found matching close. Abandon this | |
292 | substring. */ | |
293 | quote_char = '\0'; | |
294 | point = end; | |
295 | } | |
296 | } | |
297 | else if (strchr (info->quote_characters, line_buffer[scan])) | |
298 | { | |
299 | /* Found start of a quoted substring. */ | |
300 | quote_char = line_buffer[scan]; | |
301 | point = scan + 1; | |
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; | |
307 | else | |
308 | found_quote |= RL_QF_OTHER_QUOTE; | |
309 | } | |
310 | } | |
311 | } | |
312 | ||
313 | if (point == end && quote_char == '\0') | |
314 | { | |
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. */ | |
318 | while (--point) | |
319 | { | |
320 | scan = line_buffer[point]; | |
321 | ||
322 | if (strchr (brkchars, scan) != 0) | |
323 | break; | |
324 | } | |
325 | } | |
326 | ||
327 | /* If we are at an unquoted word break, then advance past it. */ | |
328 | scan = line_buffer[point]; | |
329 | ||
330 | if (scan) | |
331 | { | |
332 | isbrk = strchr (brkchars, scan) != 0; | |
333 | ||
334 | if (isbrk) | |
335 | { | |
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) | |
341 | delimiter = scan; | |
342 | ||
343 | point++; | |
344 | } | |
345 | } | |
346 | ||
347 | if (qc != NULL) | |
348 | *qc = quote_char; | |
349 | if (dp != NULL) | |
350 | *dp = delimiter; | |
351 | ||
352 | return line_buffer + point; | |
353 | } | |
354 | ||
c6756f62 PA |
355 | /* See completer.h. */ |
356 | ||
357 | const char * | |
358 | advance_to_expression_complete_word_point (completion_tracker &tracker, | |
359 | const char *text) | |
360 | { | |
361 | gdb_rl_completion_word_info info; | |
362 | ||
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; | |
367 | ||
00b56dbe | 368 | int delimiter; |
c6756f62 | 369 | const char *start |
00b56dbe | 370 | = gdb_rl_find_completion_word (&info, NULL, &delimiter, text); |
c6756f62 PA |
371 | |
372 | tracker.advance_custom_word_point_by (start - text); | |
373 | ||
00b56dbe PA |
374 | if (delimiter) |
375 | { | |
376 | tracker.set_quote_char (delimiter); | |
377 | tracker.set_suppress_append_ws (true); | |
378 | } | |
379 | ||
c6756f62 PA |
380 | return start; |
381 | } | |
382 | ||
383 | /* See completer.h. */ | |
384 | ||
385 | bool | |
386 | completion_tracker::completes_to_completion_word (const char *word) | |
387 | { | |
388 | if (m_lowest_common_denominator_unique) | |
389 | { | |
390 | const char *lcd = m_lowest_common_denominator; | |
391 | ||
392 | if (strncmp_iw (word, lcd, strlen (lcd)) == 0) | |
393 | { | |
394 | /* Maybe skip the function and complete on keywords. */ | |
395 | size_t wordlen = strlen (word); | |
396 | if (word[wordlen - 1] == ' ') | |
397 | return true; | |
398 | } | |
399 | } | |
400 | ||
401 | return false; | |
402 | } | |
403 | ||
87f0e720 | 404 | /* Complete on linespecs, which might be of two possible forms: |
c94fdfd0 EZ |
405 | |
406 | file:line | |
407 | or | |
408 | symbol+offset | |
409 | ||
aff410f1 MS |
410 | This is intended to be used in commands that set breakpoints |
411 | etc. */ | |
412 | ||
eb3ff9a5 PA |
413 | static void |
414 | complete_files_symbols (completion_tracker &tracker, | |
415 | const char *text, const char *word) | |
c94fdfd0 | 416 | { |
eb3ff9a5 | 417 | completion_list fn_list; |
6f937416 | 418 | const char *p; |
c94fdfd0 EZ |
419 | int quote_found = 0; |
420 | int quoted = *text == '\'' || *text == '"'; | |
421 | int quote_char = '\0'; | |
6f937416 | 422 | const char *colon = NULL; |
c94fdfd0 | 423 | char *file_to_match = NULL; |
6f937416 PA |
424 | const char *symbol_start = text; |
425 | const char *orig_text = text; | |
c94fdfd0 | 426 | |
59be2b6a | 427 | /* Do we have an unquoted colon, as in "break foo.c:bar"? */ |
c94fdfd0 EZ |
428 | for (p = text; *p != '\0'; ++p) |
429 | { | |
430 | if (*p == '\\' && p[1] == '\'') | |
431 | p++; | |
432 | else if (*p == '\'' || *p == '"') | |
433 | { | |
434 | quote_found = *p; | |
435 | quote_char = *p++; | |
436 | while (*p != '\0' && *p != quote_found) | |
437 | { | |
438 | if (*p == '\\' && p[1] == quote_found) | |
439 | p++; | |
440 | p++; | |
441 | } | |
442 | ||
443 | if (*p == quote_found) | |
444 | quote_found = 0; | |
445 | else | |
9c3f90bd | 446 | break; /* Hit the end of text. */ |
c94fdfd0 EZ |
447 | } |
448 | #if HAVE_DOS_BASED_FILE_SYSTEM | |
449 | /* If we have a DOS-style absolute file name at the beginning of | |
450 | TEXT, and the colon after the drive letter is the only colon | |
451 | we found, pretend the colon is not there. */ | |
452 | else if (p < text + 3 && *p == ':' && p == text + 1 + quoted) | |
453 | ; | |
454 | #endif | |
455 | else if (*p == ':' && !colon) | |
456 | { | |
457 | colon = p; | |
458 | symbol_start = p + 1; | |
459 | } | |
51065942 | 460 | else if (strchr (current_language->la_word_break_characters(), *p)) |
c94fdfd0 EZ |
461 | symbol_start = p + 1; |
462 | } | |
463 | ||
464 | if (quoted) | |
465 | text++; | |
c94fdfd0 EZ |
466 | |
467 | /* Where is the file name? */ | |
468 | if (colon) | |
469 | { | |
470 | char *s; | |
471 | ||
472 | file_to_match = (char *) xmalloc (colon - text + 1); | |
bbfa2517 YQ |
473 | strncpy (file_to_match, text, colon - text); |
474 | file_to_match[colon - text] = '\0'; | |
c94fdfd0 EZ |
475 | /* Remove trailing colons and quotes from the file name. */ |
476 | for (s = file_to_match + (colon - text); | |
477 | s > file_to_match; | |
478 | s--) | |
479 | if (*s == ':' || *s == quote_char) | |
480 | *s = '\0'; | |
481 | } | |
482 | /* If the text includes a colon, they want completion only on a | |
483 | symbol name after the colon. Otherwise, we need to complete on | |
484 | symbols as well as on files. */ | |
485 | if (colon) | |
486 | { | |
c6756f62 PA |
487 | collect_file_symbol_completion_matches (tracker, |
488 | complete_symbol_mode::EXPRESSION, | |
b5ec771e | 489 | symbol_name_match_type::EXPRESSION, |
c6756f62 | 490 | symbol_start, word, |
eb3ff9a5 | 491 | file_to_match); |
c94fdfd0 EZ |
492 | xfree (file_to_match); |
493 | } | |
494 | else | |
495 | { | |
eb3ff9a5 PA |
496 | size_t text_len = strlen (text); |
497 | ||
c6756f62 PA |
498 | collect_symbol_completion_matches (tracker, |
499 | complete_symbol_mode::EXPRESSION, | |
b5ec771e | 500 | symbol_name_match_type::EXPRESSION, |
c6756f62 | 501 | symbol_start, word); |
c94fdfd0 EZ |
502 | /* If text includes characters which cannot appear in a file |
503 | name, they cannot be asking for completion on files. */ | |
eb3ff9a5 | 504 | if (strcspn (text, |
1f20ed91 | 505 | gdb_completer_file_name_break_characters) == text_len) |
c94fdfd0 EZ |
506 | fn_list = make_source_files_completion_list (text, text); |
507 | } | |
508 | ||
eb3ff9a5 | 509 | if (!fn_list.empty () && !tracker.have_completions ()) |
c94fdfd0 EZ |
510 | { |
511 | /* If we only have file names as possible completion, we should | |
512 | bring them in sync with what rl_complete expects. The | |
513 | problem is that if the user types "break /foo/b TAB", and the | |
514 | possible completions are "/foo/bar" and "/foo/baz" | |
515 | rl_complete expects us to return "bar" and "baz", without the | |
516 | leading directories, as possible completions, because `word' | |
517 | starts at the "b". But we ignore the value of `word' when we | |
518 | call make_source_files_completion_list above (because that | |
519 | would not DTRT when the completion results in both symbols | |
520 | and file names), so make_source_files_completion_list returns | |
521 | the full "/foo/bar" and "/foo/baz" strings. This produces | |
522 | wrong results when, e.g., there's only one possible | |
523 | completion, because rl_complete will prepend "/foo/" to each | |
524 | candidate completion. The loop below removes that leading | |
525 | part. */ | |
eb3ff9a5 | 526 | for (const auto &fn_up: fn_list) |
c94fdfd0 | 527 | { |
eb3ff9a5 PA |
528 | char *fn = fn_up.get (); |
529 | memmove (fn, fn + (word - text), strlen (fn) + 1 - (word - text)); | |
c94fdfd0 | 530 | } |
c94fdfd0 | 531 | } |
eb3ff9a5 PA |
532 | |
533 | tracker.add_completions (std::move (fn_list)); | |
534 | ||
535 | if (!tracker.have_completions ()) | |
c94fdfd0 EZ |
536 | { |
537 | /* No completions at all. As the final resort, try completing | |
538 | on the entire text as a symbol. */ | |
eb3ff9a5 | 539 | collect_symbol_completion_matches (tracker, |
c6756f62 | 540 | complete_symbol_mode::EXPRESSION, |
b5ec771e | 541 | symbol_name_match_type::EXPRESSION, |
eb3ff9a5 | 542 | orig_text, word); |
c94fdfd0 | 543 | } |
eb3ff9a5 PA |
544 | } |
545 | ||
c45ec17c PA |
546 | /* See completer.h. */ |
547 | ||
548 | completion_list | |
549 | complete_source_filenames (const char *text) | |
550 | { | |
551 | size_t text_len = strlen (text); | |
552 | ||
553 | /* If text includes characters which cannot appear in a file name, | |
554 | the user cannot be asking for completion on files. */ | |
555 | if (strcspn (text, | |
556 | gdb_completer_file_name_break_characters) | |
557 | == text_len) | |
558 | return make_source_files_completion_list (text, text); | |
559 | ||
560 | return {}; | |
561 | } | |
562 | ||
563 | /* Complete address and linespec locations. */ | |
564 | ||
565 | static void | |
566 | complete_address_and_linespec_locations (completion_tracker &tracker, | |
a20714ff PA |
567 | const char *text, |
568 | symbol_name_match_type match_type) | |
c45ec17c PA |
569 | { |
570 | if (*text == '*') | |
571 | { | |
572 | tracker.advance_custom_word_point_by (1); | |
573 | text++; | |
574 | const char *word | |
575 | = advance_to_expression_complete_word_point (tracker, text); | |
576 | complete_expression (tracker, text, word); | |
577 | } | |
578 | else | |
579 | { | |
a20714ff | 580 | linespec_complete (tracker, text, match_type); |
c45ec17c PA |
581 | } |
582 | } | |
583 | ||
c6756f62 PA |
584 | /* The explicit location options. Note that indexes into this array |
585 | must match the explicit_location_match_type enumerators. */ | |
c45ec17c | 586 | |
c6756f62 PA |
587 | static const char *const explicit_options[] = |
588 | { | |
589 | "-source", | |
590 | "-function", | |
a20714ff | 591 | "-qualified", |
c6756f62 PA |
592 | "-line", |
593 | "-label", | |
594 | NULL | |
595 | }; | |
596 | ||
597 | /* The probe modifier options. These can appear before a location in | |
598 | breakpoint commands. */ | |
599 | static const char *const probe_options[] = | |
600 | { | |
601 | "-probe", | |
602 | "-probe-stap", | |
603 | "-probe-dtrace", | |
604 | NULL | |
605 | }; | |
606 | ||
eb3ff9a5 | 607 | /* Returns STRING if not NULL, the empty string otherwise. */ |
c94fdfd0 | 608 | |
eb3ff9a5 PA |
609 | static const char * |
610 | string_or_empty (const char *string) | |
611 | { | |
612 | return string != NULL ? string : ""; | |
c94fdfd0 EZ |
613 | } |
614 | ||
87f0e720 KS |
615 | /* A helper function to collect explicit location matches for the given |
616 | LOCATION, which is attempting to match on WORD. */ | |
617 | ||
eb3ff9a5 PA |
618 | static void |
619 | collect_explicit_location_matches (completion_tracker &tracker, | |
620 | struct event_location *location, | |
87f0e720 | 621 | enum explicit_location_match_type what, |
c6756f62 PA |
622 | const char *word, |
623 | const struct language_defn *language) | |
87f0e720 | 624 | { |
67994074 KS |
625 | const struct explicit_location *explicit_loc |
626 | = get_explicit_location (location); | |
87f0e720 | 627 | |
a20714ff PA |
628 | /* True if the option expects an argument. */ |
629 | bool needs_arg = true; | |
630 | ||
c6756f62 PA |
631 | /* Note, in the various MATCH_* below, we complete on |
632 | explicit_loc->foo instead of WORD, because only the former will | |
633 | have already skipped past any quote char. */ | |
87f0e720 KS |
634 | switch (what) |
635 | { | |
636 | case MATCH_SOURCE: | |
637 | { | |
eb3ff9a5 PA |
638 | const char *source = string_or_empty (explicit_loc->source_filename); |
639 | completion_list matches | |
c6756f62 | 640 | = make_source_files_completion_list (source, source); |
eb3ff9a5 | 641 | tracker.add_completions (std::move (matches)); |
87f0e720 KS |
642 | } |
643 | break; | |
644 | ||
645 | case MATCH_FUNCTION: | |
646 | { | |
eb3ff9a5 | 647 | const char *function = string_or_empty (explicit_loc->function_name); |
c6756f62 | 648 | linespec_complete_function (tracker, function, |
a20714ff | 649 | explicit_loc->func_name_match_type, |
c6756f62 | 650 | explicit_loc->source_filename); |
87f0e720 KS |
651 | } |
652 | break; | |
653 | ||
a20714ff PA |
654 | case MATCH_QUALIFIED: |
655 | needs_arg = false; | |
656 | break; | |
c6756f62 PA |
657 | case MATCH_LINE: |
658 | /* Nothing to offer. */ | |
659 | break; | |
660 | ||
87f0e720 | 661 | case MATCH_LABEL: |
a2459270 PA |
662 | { |
663 | const char *label = string_or_empty (explicit_loc->label_name); | |
664 | linespec_complete_label (tracker, language, | |
665 | explicit_loc->source_filename, | |
666 | explicit_loc->function_name, | |
a20714ff | 667 | explicit_loc->func_name_match_type, |
a2459270 PA |
668 | label); |
669 | } | |
87f0e720 KS |
670 | break; |
671 | ||
672 | default: | |
673 | gdb_assert_not_reached ("unhandled explicit_location_match_type"); | |
674 | } | |
c6756f62 | 675 | |
a20714ff | 676 | if (!needs_arg || tracker.completes_to_completion_word (word)) |
c6756f62 PA |
677 | { |
678 | tracker.discard_completions (); | |
679 | tracker.advance_custom_word_point_by (strlen (word)); | |
680 | complete_on_enum (tracker, explicit_options, "", ""); | |
681 | complete_on_enum (tracker, linespec_keywords, "", ""); | |
682 | } | |
683 | else if (!tracker.have_completions ()) | |
684 | { | |
685 | /* Maybe we have an unterminated linespec keyword at the tail of | |
686 | the string. Try completing on that. */ | |
687 | size_t wordlen = strlen (word); | |
688 | const char *keyword = word + wordlen; | |
689 | ||
690 | if (wordlen > 0 && keyword[-1] != ' ') | |
691 | { | |
692 | while (keyword > word && *keyword != ' ') | |
693 | keyword--; | |
694 | /* Don't complete on keywords if we'd be completing on the | |
695 | whole explicit linespec option. E.g., "b -function | |
696 | thr<tab>" should not complete to the "thread" | |
697 | keyword. */ | |
698 | if (keyword != word) | |
699 | { | |
f1735a53 | 700 | keyword = skip_spaces (keyword); |
c6756f62 PA |
701 | |
702 | tracker.advance_custom_word_point_by (keyword - word); | |
703 | complete_on_enum (tracker, linespec_keywords, keyword, keyword); | |
704 | } | |
705 | } | |
706 | else if (wordlen > 0 && keyword[-1] == ' ') | |
707 | { | |
708 | /* Assume that we're maybe past the explicit location | |
709 | argument, and we didn't manage to find any match because | |
710 | the user wants to create a pending breakpoint. Offer the | |
711 | keyword and explicit location options as possible | |
712 | completions. */ | |
713 | tracker.advance_custom_word_point_by (keyword - word); | |
714 | complete_on_enum (tracker, linespec_keywords, keyword, keyword); | |
715 | complete_on_enum (tracker, explicit_options, keyword, keyword); | |
716 | } | |
717 | } | |
87f0e720 KS |
718 | } |
719 | ||
c6756f62 PA |
720 | /* If the next word in *TEXT_P is any of the keywords in KEYWORDS, |
721 | then advance both TEXT_P and the word point in the tracker past the | |
722 | keyword and return the (0-based) index in the KEYWORDS array that | |
723 | matched. Otherwise, return -1. */ | |
87f0e720 | 724 | |
c6756f62 PA |
725 | static int |
726 | skip_keyword (completion_tracker &tracker, | |
727 | const char * const *keywords, const char **text_p) | |
87f0e720 | 728 | { |
c6756f62 | 729 | const char *text = *text_p; |
f1735a53 | 730 | const char *after = skip_to_space (text); |
c6756f62 | 731 | size_t len = after - text; |
87f0e720 | 732 | |
c6756f62 PA |
733 | if (text[len] != ' ') |
734 | return -1; | |
735 | ||
736 | int found = -1; | |
737 | for (int i = 0; keywords[i] != NULL; i++) | |
738 | { | |
739 | if (strncmp (keywords[i], text, len) == 0) | |
740 | { | |
741 | if (found == -1) | |
742 | found = i; | |
743 | else | |
744 | return -1; | |
745 | } | |
746 | } | |
747 | ||
748 | if (found != -1) | |
749 | { | |
750 | tracker.advance_custom_word_point_by (len + 1); | |
751 | text += len + 1; | |
752 | *text_p = text; | |
753 | return found; | |
754 | } | |
755 | ||
756 | return -1; | |
87f0e720 KS |
757 | } |
758 | ||
759 | /* A completer function for explicit locations. This function | |
c6756f62 PA |
760 | completes both options ("-source", "-line", etc) and values. If |
761 | completing a quoted string, then QUOTED_ARG_START and | |
762 | QUOTED_ARG_END point to the quote characters. LANGUAGE is the | |
763 | current language. */ | |
87f0e720 | 764 | |
eb3ff9a5 PA |
765 | static void |
766 | complete_explicit_location (completion_tracker &tracker, | |
767 | struct event_location *location, | |
c6756f62 PA |
768 | const char *text, |
769 | const language_defn *language, | |
770 | const char *quoted_arg_start, | |
771 | const char *quoted_arg_end) | |
87f0e720 | 772 | { |
c6756f62 PA |
773 | if (*text != '-') |
774 | return; | |
87f0e720 | 775 | |
c6756f62 | 776 | int keyword = skip_keyword (tracker, explicit_options, &text); |
87f0e720 | 777 | |
c6756f62 PA |
778 | if (keyword == -1) |
779 | complete_on_enum (tracker, explicit_options, text, text); | |
780 | else | |
87f0e720 | 781 | { |
c6756f62 PA |
782 | /* Completing on value. */ |
783 | enum explicit_location_match_type what | |
784 | = (explicit_location_match_type) keyword; | |
785 | ||
786 | if (quoted_arg_start != NULL && quoted_arg_end != NULL) | |
87f0e720 | 787 | { |
c6756f62 PA |
788 | if (quoted_arg_end[1] == '\0') |
789 | { | |
790 | /* If completing a quoted string with the cursor right | |
791 | at the terminating quote char, complete the | |
792 | completion word without interpretation, so that | |
793 | readline advances the cursor one whitespace past the | |
794 | quote, even if there's no match. This makes these | |
795 | cases behave the same: | |
796 | ||
797 | before: "b -function function()" | |
798 | after: "b -function function() " | |
799 | ||
800 | before: "b -function 'function()'" | |
801 | after: "b -function 'function()' " | |
802 | ||
803 | and trusts the user in this case: | |
804 | ||
805 | before: "b -function 'not_loaded_function_yet()'" | |
806 | after: "b -function 'not_loaded_function_yet()' " | |
807 | */ | |
b02f78f9 | 808 | tracker.add_completion (make_unique_xstrdup (text)); |
c6756f62 PA |
809 | } |
810 | else if (quoted_arg_end[1] == ' ') | |
811 | { | |
812 | /* We're maybe past the explicit location argument. | |
813 | Skip the argument without interpretion, assuming the | |
814 | user may want to create pending breakpoint. Offer | |
815 | the keyword and explicit location options as possible | |
816 | completions. */ | |
817 | tracker.advance_custom_word_point_by (strlen (text)); | |
818 | complete_on_enum (tracker, linespec_keywords, "", ""); | |
819 | complete_on_enum (tracker, explicit_options, "", ""); | |
820 | } | |
821 | return; | |
822 | } | |
823 | ||
824 | /* Now gather matches */ | |
825 | collect_explicit_location_matches (tracker, location, what, text, | |
826 | language); | |
827 | } | |
828 | } | |
87f0e720 | 829 | |
c6756f62 | 830 | /* A completer for locations. */ |
87f0e720 | 831 | |
c6756f62 PA |
832 | void |
833 | location_completer (struct cmd_list_element *ignore, | |
834 | completion_tracker &tracker, | |
c45ec17c | 835 | const char *text, const char * /* word */) |
c6756f62 PA |
836 | { |
837 | int found_probe_option = -1; | |
838 | ||
839 | /* If we have a probe modifier, skip it. This can only appear as | |
840 | first argument. Until we have a specific completer for probes, | |
841 | falling back to the linespec completer for the remainder of the | |
842 | line is better than nothing. */ | |
843 | if (text[0] == '-' && text[1] == 'p') | |
844 | found_probe_option = skip_keyword (tracker, probe_options, &text); | |
845 | ||
846 | const char *option_text = text; | |
847 | int saved_word_point = tracker.custom_word_point (); | |
848 | ||
849 | const char *copy = text; | |
850 | ||
851 | explicit_completion_info completion_info; | |
852 | event_location_up location | |
853 | = string_to_explicit_location (©, current_language, | |
854 | &completion_info); | |
855 | if (completion_info.quoted_arg_start != NULL | |
856 | && completion_info.quoted_arg_end == NULL) | |
857 | { | |
858 | /* Found an unbalanced quote. */ | |
859 | tracker.set_quote_char (*completion_info.quoted_arg_start); | |
860 | tracker.advance_custom_word_point_by (1); | |
87f0e720 | 861 | } |
c6756f62 | 862 | |
a20714ff | 863 | if (completion_info.saw_explicit_location_option) |
87f0e720 | 864 | { |
c6756f62 | 865 | if (*copy != '\0') |
87f0e720 | 866 | { |
c6756f62 PA |
867 | tracker.advance_custom_word_point_by (copy - text); |
868 | text = copy; | |
869 | ||
870 | /* We found a terminator at the tail end of the string, | |
871 | which means we're past the explicit location options. We | |
872 | may have a keyword to complete on. If we have a whole | |
873 | keyword, then complete whatever comes after as an | |
874 | expression. This is mainly for the "if" keyword. If the | |
875 | "thread" and "task" keywords gain their own completers, | |
876 | they should be used here. */ | |
877 | int keyword = skip_keyword (tracker, linespec_keywords, &text); | |
878 | ||
879 | if (keyword == -1) | |
880 | { | |
881 | complete_on_enum (tracker, linespec_keywords, text, text); | |
882 | } | |
883 | else | |
884 | { | |
885 | const char *word | |
886 | = advance_to_expression_complete_word_point (tracker, text); | |
887 | complete_expression (tracker, text, word); | |
888 | } | |
87f0e720 | 889 | } |
c6756f62 | 890 | else |
87f0e720 | 891 | { |
c6756f62 PA |
892 | tracker.advance_custom_word_point_by (completion_info.last_option |
893 | - text); | |
894 | text = completion_info.last_option; | |
895 | ||
896 | complete_explicit_location (tracker, location.get (), text, | |
897 | current_language, | |
898 | completion_info.quoted_arg_start, | |
899 | completion_info.quoted_arg_end); | |
900 | ||
87f0e720 | 901 | } |
c6756f62 | 902 | } |
a20714ff PA |
903 | /* This is an address or linespec location. */ |
904 | else if (location != NULL) | |
905 | { | |
906 | /* Handle non-explicit location options. */ | |
907 | ||
908 | int keyword = skip_keyword (tracker, explicit_options, &text); | |
909 | if (keyword == -1) | |
910 | complete_on_enum (tracker, explicit_options, text, text); | |
911 | else | |
912 | { | |
913 | tracker.advance_custom_word_point_by (copy - text); | |
914 | text = copy; | |
915 | ||
916 | symbol_name_match_type match_type | |
917 | = get_explicit_location (location.get ())->func_name_match_type; | |
918 | complete_address_and_linespec_locations (tracker, text, match_type); | |
919 | } | |
920 | } | |
c6756f62 PA |
921 | else |
922 | { | |
a20714ff PA |
923 | /* No options. */ |
924 | complete_address_and_linespec_locations (tracker, text, | |
925 | symbol_name_match_type::WILD); | |
c6756f62 | 926 | } |
87f0e720 | 927 | |
c6756f62 | 928 | /* Add matches for option names, if either: |
87f0e720 | 929 | |
c6756f62 PA |
930 | - Some completer above found some matches, but the word point did |
931 | not advance (e.g., "b <tab>" finds all functions, or "b -<tab>" | |
932 | matches all objc selectors), or; | |
933 | ||
934 | - Some completer above advanced the word point, but found no | |
935 | matches. | |
936 | */ | |
937 | if ((text[0] == '-' || text[0] == '\0') | |
938 | && (!tracker.have_completions () | |
939 | || tracker.custom_word_point () == saved_word_point)) | |
940 | { | |
941 | tracker.set_custom_word_point (saved_word_point); | |
942 | text = option_text; | |
943 | ||
944 | if (found_probe_option == -1) | |
945 | complete_on_enum (tracker, probe_options, text, text); | |
946 | complete_on_enum (tracker, explicit_options, text, text); | |
87f0e720 | 947 | } |
87f0e720 KS |
948 | } |
949 | ||
c6756f62 PA |
950 | /* The corresponding completer_handle_brkchars |
951 | implementation. */ | |
87f0e720 | 952 | |
c6756f62 PA |
953 | static void |
954 | location_completer_handle_brkchars (struct cmd_list_element *ignore, | |
955 | completion_tracker &tracker, | |
956 | const char *text, | |
957 | const char *word_ignored) | |
87f0e720 | 958 | { |
c6756f62 | 959 | tracker.set_use_custom_word_point (true); |
87f0e720 | 960 | |
c6756f62 | 961 | location_completer (ignore, tracker, text, NULL); |
87f0e720 KS |
962 | } |
963 | ||
1c71341a | 964 | /* Helper for expression_completer which recursively adds field and |
eb3ff9a5 PA |
965 | method names from TYPE, a struct or union type, to the OUTPUT |
966 | list. */ | |
967 | ||
65d12d83 | 968 | static void |
eb3ff9a5 | 969 | add_struct_fields (struct type *type, completion_list &output, |
3eac2b65 | 970 | const char *fieldname, int namelen) |
65d12d83 TT |
971 | { |
972 | int i; | |
b32d97f3 | 973 | int computed_type_name = 0; |
0d5cff50 | 974 | const char *type_name = NULL; |
65d12d83 | 975 | |
f168693b | 976 | type = check_typedef (type); |
65d12d83 TT |
977 | for (i = 0; i < TYPE_NFIELDS (type); ++i) |
978 | { | |
979 | if (i < TYPE_N_BASECLASSES (type)) | |
49c4e619 | 980 | add_struct_fields (TYPE_BASECLASS (type, i), |
aff410f1 | 981 | output, fieldname, namelen); |
9ae8282d | 982 | else if (TYPE_FIELD_NAME (type, i)) |
65d12d83 | 983 | { |
9ae8282d TT |
984 | if (TYPE_FIELD_NAME (type, i)[0] != '\0') |
985 | { | |
aff410f1 MS |
986 | if (! strncmp (TYPE_FIELD_NAME (type, i), |
987 | fieldname, namelen)) | |
eb3ff9a5 | 988 | output.emplace_back (xstrdup (TYPE_FIELD_NAME (type, i))); |
9ae8282d TT |
989 | } |
990 | else if (TYPE_CODE (TYPE_FIELD_TYPE (type, i)) == TYPE_CODE_UNION) | |
991 | { | |
992 | /* Recurse into anonymous unions. */ | |
49c4e619 | 993 | add_struct_fields (TYPE_FIELD_TYPE (type, i), |
aff410f1 | 994 | output, fieldname, namelen); |
9ae8282d | 995 | } |
65d12d83 TT |
996 | } |
997 | } | |
1c71341a TT |
998 | |
999 | for (i = TYPE_NFN_FIELDS (type) - 1; i >= 0; --i) | |
1000 | { | |
0d5cff50 | 1001 | const char *name = TYPE_FN_FIELDLIST_NAME (type, i); |
c5504eaf | 1002 | |
1c71341a TT |
1003 | if (name && ! strncmp (name, fieldname, namelen)) |
1004 | { | |
b32d97f3 TT |
1005 | if (!computed_type_name) |
1006 | { | |
a737d952 | 1007 | type_name = TYPE_NAME (type); |
b32d97f3 TT |
1008 | computed_type_name = 1; |
1009 | } | |
1c71341a | 1010 | /* Omit constructors from the completion list. */ |
907af001 | 1011 | if (!type_name || strcmp (type_name, name)) |
eb3ff9a5 | 1012 | output.emplace_back (xstrdup (name)); |
1c71341a TT |
1013 | } |
1014 | } | |
65d12d83 TT |
1015 | } |
1016 | ||
c45ec17c | 1017 | /* See completer.h. */ |
eb3ff9a5 | 1018 | |
c45ec17c | 1019 | void |
eb3ff9a5 PA |
1020 | complete_expression (completion_tracker &tracker, |
1021 | const char *text, const char *word) | |
65d12d83 | 1022 | { |
c92817ce | 1023 | struct type *type = NULL; |
3eac2b65 | 1024 | gdb::unique_xmalloc_ptr<char> fieldname; |
2f68a895 | 1025 | enum type_code code = TYPE_CODE_UNDEF; |
65d12d83 TT |
1026 | |
1027 | /* Perform a tentative parse of the expression, to see whether a | |
1028 | field completion is required. */ | |
a70b8144 | 1029 | try |
c92817ce | 1030 | { |
2f68a895 | 1031 | type = parse_expression_for_completion (text, &fieldname, &code); |
c92817ce | 1032 | } |
230d2906 | 1033 | catch (const gdb_exception_error &except) |
492d29ea | 1034 | { |
eb3ff9a5 | 1035 | return; |
492d29ea | 1036 | } |
492d29ea | 1037 | |
3eac2b65 | 1038 | if (fieldname != nullptr && type) |
65d12d83 TT |
1039 | { |
1040 | for (;;) | |
1041 | { | |
f168693b | 1042 | type = check_typedef (type); |
aa006118 | 1043 | if (TYPE_CODE (type) != TYPE_CODE_PTR && !TYPE_IS_REFERENCE (type)) |
65d12d83 TT |
1044 | break; |
1045 | type = TYPE_TARGET_TYPE (type); | |
1046 | } | |
1047 | ||
1048 | if (TYPE_CODE (type) == TYPE_CODE_UNION | |
1049 | || TYPE_CODE (type) == TYPE_CODE_STRUCT) | |
1050 | { | |
eb3ff9a5 | 1051 | completion_list result; |
65d12d83 | 1052 | |
3eac2b65 TT |
1053 | add_struct_fields (type, result, fieldname.get (), |
1054 | strlen (fieldname.get ())); | |
eb3ff9a5 PA |
1055 | tracker.add_completions (std::move (result)); |
1056 | return; | |
65d12d83 TT |
1057 | } |
1058 | } | |
3eac2b65 | 1059 | else if (fieldname != nullptr && code != TYPE_CODE_UNDEF) |
2f68a895 | 1060 | { |
3eac2b65 TT |
1061 | collect_symbol_completion_matches_type (tracker, fieldname.get (), |
1062 | fieldname.get (), code); | |
eb3ff9a5 | 1063 | return; |
2f68a895 | 1064 | } |
65d12d83 | 1065 | |
eb3ff9a5 PA |
1066 | complete_files_symbols (tracker, text, word); |
1067 | } | |
1068 | ||
1069 | /* Complete on expressions. Often this means completing on symbol | |
1070 | names, but some language parsers also have support for completing | |
1071 | field names. */ | |
1072 | ||
1073 | void | |
1074 | expression_completer (struct cmd_list_element *ignore, | |
1075 | completion_tracker &tracker, | |
1076 | const char *text, const char *word) | |
1077 | { | |
1078 | complete_expression (tracker, text, word); | |
65d12d83 TT |
1079 | } |
1080 | ||
7d793aa9 SDJ |
1081 | /* See definition in completer.h. */ |
1082 | ||
67cb5b2d PA |
1083 | void |
1084 | set_rl_completer_word_break_characters (const char *break_chars) | |
1085 | { | |
1086 | rl_completer_word_break_characters = (char *) break_chars; | |
1087 | } | |
1088 | ||
1089 | /* See definition in completer.h. */ | |
1090 | ||
7d793aa9 SDJ |
1091 | void |
1092 | set_gdb_completion_word_break_characters (completer_ftype *fn) | |
1093 | { | |
67cb5b2d PA |
1094 | const char *break_chars; |
1095 | ||
7d793aa9 SDJ |
1096 | /* So far we are only interested in differentiating filename |
1097 | completers from everything else. */ | |
1098 | if (fn == filename_completer) | |
67cb5b2d | 1099 | break_chars = gdb_completer_file_name_break_characters; |
7d793aa9 | 1100 | else |
67cb5b2d PA |
1101 | break_chars = gdb_completer_command_word_break_characters; |
1102 | ||
1103 | set_rl_completer_word_break_characters (break_chars); | |
7d793aa9 SDJ |
1104 | } |
1105 | ||
78b13106 PA |
1106 | /* Complete on symbols. */ |
1107 | ||
eb3ff9a5 | 1108 | void |
78b13106 | 1109 | symbol_completer (struct cmd_list_element *ignore, |
eb3ff9a5 | 1110 | completion_tracker &tracker, |
78b13106 PA |
1111 | const char *text, const char *word) |
1112 | { | |
c6756f62 | 1113 | collect_symbol_completion_matches (tracker, complete_symbol_mode::EXPRESSION, |
b5ec771e | 1114 | symbol_name_match_type::EXPRESSION, |
c6756f62 | 1115 | text, word); |
78b13106 PA |
1116 | } |
1117 | ||
aff410f1 MS |
1118 | /* Here are some useful test cases for completion. FIXME: These |
1119 | should be put in the test suite. They should be tested with both | |
1120 | M-? and TAB. | |
c5f0f3d0 FN |
1121 | |
1122 | "show output-" "radix" | |
1123 | "show output" "-radix" | |
1124 | "p" ambiguous (commands starting with p--path, print, printf, etc.) | |
1125 | "p " ambiguous (all symbols) | |
1126 | "info t foo" no completions | |
1127 | "info t " no completions | |
1128 | "info t" ambiguous ("info target", "info terminal", etc.) | |
1129 | "info ajksdlfk" no completions | |
1130 | "info ajksdlfk " no completions | |
1131 | "info" " " | |
1132 | "info " ambiguous (all info commands) | |
1133 | "p \"a" no completions (string constant) | |
1134 | "p 'a" ambiguous (all symbols starting with a) | |
1135 | "p b-a" ambiguous (all symbols starting with a) | |
1136 | "p b-" ambiguous (all symbols) | |
1137 | "file Make" "file" (word break hard to screw up here) | |
1138 | "file ../gdb.stabs/we" "ird" (needs to not break word at slash) | |
1139 | */ | |
1140 | ||
eb3ff9a5 | 1141 | enum complete_line_internal_reason |
67c296a2 | 1142 | { |
eb3ff9a5 | 1143 | /* Preliminary phase, called by gdb_completion_word_break_characters |
c6756f62 PA |
1144 | function, is used to either: |
1145 | ||
1146 | #1 - Determine the set of chars that are word delimiters | |
1147 | depending on the current command in line_buffer. | |
1148 | ||
1149 | #2 - Manually advance RL_POINT to the "word break" point instead | |
1150 | of letting readline do it (based on too-simple character | |
1151 | matching). | |
1152 | ||
1153 | Simpler completers that just pass a brkchars array to readline | |
1154 | (#1 above) must defer generating the completions to the main | |
1155 | phase (below). No completion list should be generated in this | |
1156 | phase. | |
1157 | ||
1158 | OTOH, completers that manually advance the word point(#2 above) | |
1159 | must set "use_custom_word_point" in the tracker and generate | |
1160 | their completion in this phase. Note that this is the convenient | |
1161 | thing to do since they'll be parsing the input line anyway. */ | |
67c296a2 | 1162 | handle_brkchars, |
eb3ff9a5 PA |
1163 | |
1164 | /* Main phase, called by complete_line function, is used to get the | |
1165 | list of possible completions. */ | |
67c296a2 | 1166 | handle_completions, |
eb3ff9a5 PA |
1167 | |
1168 | /* Special case when completing a 'help' command. In this case, | |
1169 | once sub-command completions are exhausted, we simply return | |
1170 | NULL. */ | |
1171 | handle_help, | |
1172 | }; | |
67c296a2 | 1173 | |
6e1dbf8c PA |
1174 | /* Helper for complete_line_internal to simplify it. */ |
1175 | ||
eb3ff9a5 PA |
1176 | static void |
1177 | complete_line_internal_normal_command (completion_tracker &tracker, | |
1178 | const char *command, const char *word, | |
6e1dbf8c PA |
1179 | const char *cmd_args, |
1180 | complete_line_internal_reason reason, | |
1181 | struct cmd_list_element *c) | |
1182 | { | |
1183 | const char *p = cmd_args; | |
1184 | ||
1185 | if (c->completer == filename_completer) | |
1186 | { | |
1187 | /* Many commands which want to complete on file names accept | |
1188 | several file names, as in "run foo bar >>baz". So we don't | |
1189 | want to complete the entire text after the command, just the | |
1190 | last word. To this end, we need to find the beginning of the | |
1191 | file name by starting at `word' and going backwards. */ | |
1192 | for (p = word; | |
1193 | p > command | |
1194 | && strchr (gdb_completer_file_name_break_characters, | |
1195 | p[-1]) == NULL; | |
1196 | p--) | |
1197 | ; | |
1198 | } | |
1199 | ||
1200 | if (reason == handle_brkchars) | |
1201 | { | |
1202 | completer_handle_brkchars_ftype *brkchars_fn; | |
1203 | ||
1204 | if (c->completer_handle_brkchars != NULL) | |
1205 | brkchars_fn = c->completer_handle_brkchars; | |
1206 | else | |
1207 | { | |
1208 | brkchars_fn | |
1209 | = (completer_handle_brkchars_func_for_completer | |
1210 | (c->completer)); | |
1211 | } | |
1212 | ||
eb3ff9a5 | 1213 | brkchars_fn (c, tracker, p, word); |
6e1dbf8c PA |
1214 | } |
1215 | ||
1216 | if (reason != handle_brkchars && c->completer != NULL) | |
eb3ff9a5 | 1217 | (*c->completer) (c, tracker, p, word); |
6e1dbf8c | 1218 | } |
67c296a2 PM |
1219 | |
1220 | /* Internal function used to handle completions. | |
1221 | ||
c5f0f3d0 FN |
1222 | |
1223 | TEXT is the caller's idea of the "word" we are looking at. | |
1224 | ||
aff410f1 MS |
1225 | LINE_BUFFER is available to be looked at; it contains the entire |
1226 | text of the line. POINT is the offset in that line of the cursor. | |
1227 | You should pretend that the line ends at POINT. | |
67c296a2 | 1228 | |
eb3ff9a5 | 1229 | See complete_line_internal_reason for description of REASON. */ |
14032a66 | 1230 | |
eb3ff9a5 PA |
1231 | static void |
1232 | complete_line_internal_1 (completion_tracker &tracker, | |
1233 | const char *text, | |
1234 | const char *line_buffer, int point, | |
1235 | complete_line_internal_reason reason) | |
c5f0f3d0 | 1236 | { |
6f937416 PA |
1237 | char *tmp_command; |
1238 | const char *p; | |
ace21957 | 1239 | int ignore_help_classes; |
c5f0f3d0 | 1240 | /* Pointer within tmp_command which corresponds to text. */ |
eb3ff9a5 | 1241 | const char *word; |
c5f0f3d0 FN |
1242 | struct cmd_list_element *c, *result_list; |
1243 | ||
aff410f1 MS |
1244 | /* Choose the default set of word break characters to break |
1245 | completions. If we later find out that we are doing completions | |
1246 | on command strings (as opposed to strings supplied by the | |
1247 | individual command completer functions, which can be any string) | |
1248 | then we will switch to the special word break set for command | |
1249 | strings, which leaves out the '-' character used in some | |
1250 | commands. */ | |
67cb5b2d PA |
1251 | set_rl_completer_word_break_characters |
1252 | (current_language->la_word_break_characters()); | |
c5f0f3d0 | 1253 | |
aff410f1 MS |
1254 | /* Decide whether to complete on a list of gdb commands or on |
1255 | symbols. */ | |
83d31a92 TT |
1256 | tmp_command = (char *) alloca (point + 1); |
1257 | p = tmp_command; | |
c5f0f3d0 | 1258 | |
ace21957 MF |
1259 | /* The help command should complete help aliases. */ |
1260 | ignore_help_classes = reason != handle_help; | |
1261 | ||
83d31a92 TT |
1262 | strncpy (tmp_command, line_buffer, point); |
1263 | tmp_command[point] = '\0'; | |
eb3ff9a5 PA |
1264 | if (reason == handle_brkchars) |
1265 | { | |
1266 | gdb_assert (text == NULL); | |
1267 | word = NULL; | |
1268 | } | |
1269 | else | |
1270 | { | |
1271 | /* Since text always contains some number of characters leading up | |
1272 | to point, we can find the equivalent position in tmp_command | |
1273 | by subtracting that many characters from the end of tmp_command. */ | |
1274 | word = tmp_command + point - strlen (text); | |
1275 | } | |
c5f0f3d0 | 1276 | |
a81aaca0 PA |
1277 | /* Move P up to the start of the command. */ |
1278 | p = skip_spaces (p); | |
1279 | ||
1280 | if (*p == '\0') | |
83d31a92 | 1281 | { |
a81aaca0 PA |
1282 | /* An empty line is ambiguous; that is, it could be any |
1283 | command. */ | |
1427fe5e | 1284 | c = CMD_LIST_AMBIGUOUS; |
83d31a92 TT |
1285 | result_list = 0; |
1286 | } | |
1287 | else | |
1288 | { | |
ace21957 | 1289 | c = lookup_cmd_1 (&p, cmdlist, &result_list, ignore_help_classes); |
83d31a92 | 1290 | } |
c5f0f3d0 | 1291 | |
83d31a92 TT |
1292 | /* Move p up to the next interesting thing. */ |
1293 | while (*p == ' ' || *p == '\t') | |
1294 | { | |
1295 | p++; | |
1296 | } | |
c5f0f3d0 | 1297 | |
c6756f62 PA |
1298 | tracker.advance_custom_word_point_by (p - tmp_command); |
1299 | ||
83d31a92 TT |
1300 | if (!c) |
1301 | { | |
1302 | /* It is an unrecognized command. So there are no | |
1303 | possible completions. */ | |
83d31a92 | 1304 | } |
1427fe5e | 1305 | else if (c == CMD_LIST_AMBIGUOUS) |
83d31a92 | 1306 | { |
6f937416 | 1307 | const char *q; |
83d31a92 TT |
1308 | |
1309 | /* lookup_cmd_1 advances p up to the first ambiguous thing, but | |
1310 | doesn't advance over that thing itself. Do so now. */ | |
1311 | q = p; | |
1312 | while (*q && (isalnum (*q) || *q == '-' || *q == '_')) | |
1313 | ++q; | |
1314 | if (q != tmp_command + point) | |
c5f0f3d0 | 1315 | { |
83d31a92 TT |
1316 | /* There is something beyond the ambiguous |
1317 | command, so there are no possible completions. For | |
1318 | example, "info t " or "info t foo" does not complete | |
1319 | to anything, because "info t" can be "info target" or | |
1320 | "info terminal". */ | |
c5f0f3d0 | 1321 | } |
83d31a92 | 1322 | else |
c5f0f3d0 | 1323 | { |
83d31a92 TT |
1324 | /* We're trying to complete on the command which was ambiguous. |
1325 | This we can deal with. */ | |
1326 | if (result_list) | |
c5f0f3d0 | 1327 | { |
67c296a2 | 1328 | if (reason != handle_brkchars) |
eb3ff9a5 PA |
1329 | complete_on_cmdlist (*result_list->prefixlist, tracker, p, |
1330 | word, ignore_help_classes); | |
c5f0f3d0 FN |
1331 | } |
1332 | else | |
1333 | { | |
67c296a2 | 1334 | if (reason != handle_brkchars) |
eb3ff9a5 PA |
1335 | complete_on_cmdlist (cmdlist, tracker, p, word, |
1336 | ignore_help_classes); | |
c5f0f3d0 | 1337 | } |
489f0516 | 1338 | /* Ensure that readline does the right thing with respect to |
83d31a92 | 1339 | inserting quotes. */ |
67cb5b2d PA |
1340 | set_rl_completer_word_break_characters |
1341 | (gdb_completer_command_word_break_characters); | |
c5f0f3d0 | 1342 | } |
83d31a92 TT |
1343 | } |
1344 | else | |
1345 | { | |
1346 | /* We've recognized a full command. */ | |
1347 | ||
1348 | if (p == tmp_command + point) | |
c5f0f3d0 | 1349 | { |
aff410f1 MS |
1350 | /* There is no non-whitespace in the line beyond the |
1351 | command. */ | |
c5f0f3d0 | 1352 | |
83d31a92 | 1353 | if (p[-1] == ' ' || p[-1] == '\t') |
c5f0f3d0 | 1354 | { |
aff410f1 MS |
1355 | /* The command is followed by whitespace; we need to |
1356 | complete on whatever comes after command. */ | |
83d31a92 | 1357 | if (c->prefixlist) |
c5f0f3d0 | 1358 | { |
83d31a92 TT |
1359 | /* It is a prefix command; what comes after it is |
1360 | a subcommand (e.g. "info "). */ | |
67c296a2 | 1361 | if (reason != handle_brkchars) |
eb3ff9a5 PA |
1362 | complete_on_cmdlist (*c->prefixlist, tracker, p, word, |
1363 | ignore_help_classes); | |
c5f0f3d0 | 1364 | |
489f0516 | 1365 | /* Ensure that readline does the right thing |
9c3f90bd | 1366 | with respect to inserting quotes. */ |
67cb5b2d PA |
1367 | set_rl_completer_word_break_characters |
1368 | (gdb_completer_command_word_break_characters); | |
c5f0f3d0 | 1369 | } |
67c296a2 | 1370 | else if (reason == handle_help) |
eb3ff9a5 | 1371 | ; |
c5f0f3d0 FN |
1372 | else if (c->enums) |
1373 | { | |
67c296a2 | 1374 | if (reason != handle_brkchars) |
eb3ff9a5 | 1375 | complete_on_enum (tracker, c->enums, p, word); |
67cb5b2d PA |
1376 | set_rl_completer_word_break_characters |
1377 | (gdb_completer_command_word_break_characters); | |
c5f0f3d0 FN |
1378 | } |
1379 | else | |
1380 | { | |
83d31a92 TT |
1381 | /* It is a normal command; what comes after it is |
1382 | completed by the command's completer function. */ | |
eb3ff9a5 PA |
1383 | complete_line_internal_normal_command (tracker, |
1384 | tmp_command, word, p, | |
1385 | reason, c); | |
c5f0f3d0 FN |
1386 | } |
1387 | } | |
83d31a92 TT |
1388 | else |
1389 | { | |
1390 | /* The command is not followed by whitespace; we need to | |
aff410f1 | 1391 | complete on the command itself, e.g. "p" which is a |
83d31a92 TT |
1392 | command itself but also can complete to "print", "ptype" |
1393 | etc. */ | |
6f937416 | 1394 | const char *q; |
83d31a92 TT |
1395 | |
1396 | /* Find the command we are completing on. */ | |
1397 | q = p; | |
1398 | while (q > tmp_command) | |
1399 | { | |
1400 | if (isalnum (q[-1]) || q[-1] == '-' || q[-1] == '_') | |
1401 | --q; | |
1402 | else | |
1403 | break; | |
1404 | } | |
1405 | ||
3844e605 PA |
1406 | /* Move the custom word point back too. */ |
1407 | tracker.advance_custom_word_point_by (q - p); | |
1408 | ||
67c296a2 | 1409 | if (reason != handle_brkchars) |
eb3ff9a5 PA |
1410 | complete_on_cmdlist (result_list, tracker, q, word, |
1411 | ignore_help_classes); | |
83d31a92 | 1412 | |
489f0516 | 1413 | /* Ensure that readline does the right thing |
9c3f90bd | 1414 | with respect to inserting quotes. */ |
67cb5b2d PA |
1415 | set_rl_completer_word_break_characters |
1416 | (gdb_completer_command_word_break_characters); | |
83d31a92 TT |
1417 | } |
1418 | } | |
67c296a2 | 1419 | else if (reason == handle_help) |
eb3ff9a5 | 1420 | ; |
83d31a92 TT |
1421 | else |
1422 | { | |
1423 | /* There is non-whitespace beyond the command. */ | |
1424 | ||
1425 | if (c->prefixlist && !c->allow_unknown) | |
1426 | { | |
1427 | /* It is an unrecognized subcommand of a prefix command, | |
1428 | e.g. "info adsfkdj". */ | |
83d31a92 TT |
1429 | } |
1430 | else if (c->enums) | |
1431 | { | |
67c296a2 | 1432 | if (reason != handle_brkchars) |
eb3ff9a5 | 1433 | complete_on_enum (tracker, c->enums, p, word); |
83d31a92 TT |
1434 | } |
1435 | else | |
1436 | { | |
1437 | /* It is a normal command. */ | |
eb3ff9a5 PA |
1438 | complete_line_internal_normal_command (tracker, |
1439 | tmp_command, word, p, | |
1440 | reason, c); | |
83d31a92 TT |
1441 | } |
1442 | } | |
1443 | } | |
83d31a92 | 1444 | } |
ef0b411a | 1445 | |
eb3ff9a5 PA |
1446 | /* Wrapper around complete_line_internal_1 to handle |
1447 | MAX_COMPLETIONS_REACHED_ERROR. */ | |
ef0b411a | 1448 | |
eb3ff9a5 PA |
1449 | static void |
1450 | complete_line_internal (completion_tracker &tracker, | |
1451 | const char *text, | |
1452 | const char *line_buffer, int point, | |
1453 | complete_line_internal_reason reason) | |
1454 | { | |
a70b8144 | 1455 | try |
eb3ff9a5 PA |
1456 | { |
1457 | complete_line_internal_1 (tracker, text, line_buffer, point, reason); | |
1458 | } | |
230d2906 | 1459 | catch (const gdb_exception_error &except) |
eb3ff9a5 PA |
1460 | { |
1461 | if (except.error != MAX_COMPLETIONS_REACHED_ERROR) | |
eedc3f4f | 1462 | throw; |
eb3ff9a5 PA |
1463 | } |
1464 | } | |
ef0b411a GB |
1465 | |
1466 | /* See completer.h. */ | |
1467 | ||
eb3ff9a5 | 1468 | int max_completions = 200; |
ef0b411a | 1469 | |
eb3ff9a5 PA |
1470 | /* Initial size of the table. It automagically grows from here. */ |
1471 | #define INITIAL_COMPLETION_HTAB_SIZE 200 | |
ef0b411a | 1472 | |
eb3ff9a5 | 1473 | /* See completer.h. */ |
ef0b411a | 1474 | |
eb3ff9a5 | 1475 | completion_tracker::completion_tracker () |
ef0b411a | 1476 | { |
eb3ff9a5 | 1477 | m_entries_hash = htab_create_alloc (INITIAL_COMPLETION_HTAB_SIZE, |
459a2e4c | 1478 | htab_hash_string, streq_hash, |
eb3ff9a5 | 1479 | NULL, xcalloc, xfree); |
ef0b411a GB |
1480 | } |
1481 | ||
1482 | /* See completer.h. */ | |
1483 | ||
c6756f62 PA |
1484 | void |
1485 | completion_tracker::discard_completions () | |
1486 | { | |
1487 | xfree (m_lowest_common_denominator); | |
1488 | m_lowest_common_denominator = NULL; | |
1489 | ||
1490 | m_lowest_common_denominator_unique = false; | |
1491 | ||
1492 | m_entries_vec.clear (); | |
1493 | ||
1494 | htab_delete (m_entries_hash); | |
1495 | m_entries_hash = htab_create_alloc (INITIAL_COMPLETION_HTAB_SIZE, | |
459a2e4c | 1496 | htab_hash_string, streq_hash, |
c6756f62 PA |
1497 | NULL, xcalloc, xfree); |
1498 | } | |
1499 | ||
1500 | /* See completer.h. */ | |
1501 | ||
eb3ff9a5 | 1502 | completion_tracker::~completion_tracker () |
ef0b411a | 1503 | { |
eb3ff9a5 PA |
1504 | xfree (m_lowest_common_denominator); |
1505 | htab_delete (m_entries_hash); | |
ef0b411a GB |
1506 | } |
1507 | ||
1508 | /* See completer.h. */ | |
1509 | ||
eb3ff9a5 | 1510 | bool |
a207cff2 PA |
1511 | completion_tracker::maybe_add_completion |
1512 | (gdb::unique_xmalloc_ptr<char> name, | |
a22ecf70 PA |
1513 | completion_match_for_lcd *match_for_lcd, |
1514 | const char *text, const char *word) | |
ef0b411a GB |
1515 | { |
1516 | void **slot; | |
1517 | ||
ef0b411a | 1518 | if (max_completions == 0) |
eb3ff9a5 | 1519 | return false; |
ef0b411a | 1520 | |
eb3ff9a5 PA |
1521 | if (htab_elements (m_entries_hash) >= max_completions) |
1522 | return false; | |
ef0b411a | 1523 | |
eb3ff9a5 PA |
1524 | slot = htab_find_slot (m_entries_hash, name.get (), INSERT); |
1525 | if (*slot == HTAB_EMPTY_ENTRY) | |
1526 | { | |
a207cff2 PA |
1527 | const char *match_for_lcd_str = NULL; |
1528 | ||
1529 | if (match_for_lcd != NULL) | |
1530 | match_for_lcd_str = match_for_lcd->finish (); | |
1531 | ||
1532 | if (match_for_lcd_str == NULL) | |
1533 | match_for_lcd_str = name.get (); | |
ef0b411a | 1534 | |
a22ecf70 PA |
1535 | gdb::unique_xmalloc_ptr<char> lcd |
1536 | = make_completion_match_str (match_for_lcd_str, text, word); | |
1537 | ||
1538 | recompute_lowest_common_denominator (std::move (lcd)); | |
ef0b411a | 1539 | |
eb3ff9a5 PA |
1540 | *slot = name.get (); |
1541 | m_entries_vec.push_back (std::move (name)); | |
1542 | } | |
ef0b411a | 1543 | |
eb3ff9a5 PA |
1544 | return true; |
1545 | } | |
1546 | ||
1547 | /* See completer.h. */ | |
ef0b411a | 1548 | |
eb3ff9a5 | 1549 | void |
a207cff2 | 1550 | completion_tracker::add_completion (gdb::unique_xmalloc_ptr<char> name, |
a22ecf70 PA |
1551 | completion_match_for_lcd *match_for_lcd, |
1552 | const char *text, const char *word) | |
eb3ff9a5 | 1553 | { |
a22ecf70 | 1554 | if (!maybe_add_completion (std::move (name), match_for_lcd, text, word)) |
eb3ff9a5 | 1555 | throw_error (MAX_COMPLETIONS_REACHED_ERROR, _("Max completions reached.")); |
ef0b411a GB |
1556 | } |
1557 | ||
eb3ff9a5 PA |
1558 | /* See completer.h. */ |
1559 | ||
ef0b411a | 1560 | void |
eb3ff9a5 | 1561 | completion_tracker::add_completions (completion_list &&list) |
ef0b411a | 1562 | { |
eb3ff9a5 PA |
1563 | for (auto &candidate : list) |
1564 | add_completion (std::move (candidate)); | |
ef0b411a GB |
1565 | } |
1566 | ||
60a20c19 PA |
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. */ | |
1570 | ||
1571 | static char * | |
1572 | make_completion_match_str_1 (const char *match_name, | |
1573 | const char *text, const char *word) | |
1574 | { | |
1575 | char *newobj; | |
1576 | ||
1577 | if (word == text) | |
1578 | { | |
1579 | /* Return NULL as an indication that we want MATCH_NAME | |
1580 | exactly. */ | |
1581 | return NULL; | |
1582 | } | |
1583 | else if (word > text) | |
1584 | { | |
1585 | /* Return some portion of MATCH_NAME. */ | |
1586 | newobj = xstrdup (match_name + (word - text)); | |
1587 | } | |
1588 | else | |
1589 | { | |
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); | |
1595 | } | |
1596 | ||
1597 | return newobj; | |
1598 | } | |
1599 | ||
1600 | /* See completer.h. */ | |
1601 | ||
1602 | gdb::unique_xmalloc_ptr<char> | |
1603 | make_completion_match_str (const char *match_name, | |
1604 | const char *text, const char *word) | |
1605 | { | |
1606 | char *newobj = make_completion_match_str_1 (match_name, text, word); | |
1607 | if (newobj == NULL) | |
1608 | newobj = xstrdup (match_name); | |
1609 | return gdb::unique_xmalloc_ptr<char> (newobj); | |
1610 | } | |
1611 | ||
1612 | /* See completer.h. */ | |
1613 | ||
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) | |
1617 | { | |
1618 | char *newobj = make_completion_match_str_1 (match_name.get (), text, word); | |
1619 | if (newobj == NULL) | |
1620 | return std::move (match_name); | |
1621 | return gdb::unique_xmalloc_ptr<char> (newobj); | |
1622 | } | |
1623 | ||
6e035501 JV |
1624 | /* See complete.h. */ |
1625 | ||
1626 | completion_result | |
1627 | complete (const char *line, char const **word, int *quote_char) | |
1628 | { | |
1629 | completion_tracker tracker_handle_brkchars; | |
1630 | completion_tracker tracker_handle_completions; | |
1631 | completion_tracker *tracker; | |
1632 | ||
0ef209f2 JV |
1633 | /* The WORD should be set to the end of word to complete. We initialize |
1634 | to the completion point which is assumed to be at the end of LINE. | |
1635 | This leaves WORD to be initialized to a sensible value in cases | |
1636 | completion_find_completion_word() fails i.e., throws an exception. | |
1637 | See bug 24587. */ | |
1638 | *word = line + strlen (line); | |
1639 | ||
6e035501 JV |
1640 | try |
1641 | { | |
1642 | *word = completion_find_completion_word (tracker_handle_brkchars, | |
1643 | line, quote_char); | |
1644 | ||
1645 | /* Completers that provide a custom word point in the | |
1646 | handle_brkchars phase also compute their completions then. | |
1647 | Completers that leave the completion word handling to readline | |
1648 | must be called twice. */ | |
1649 | if (tracker_handle_brkchars.use_custom_word_point ()) | |
1650 | tracker = &tracker_handle_brkchars; | |
1651 | else | |
1652 | { | |
1653 | complete_line (tracker_handle_completions, *word, line, strlen (line)); | |
1654 | tracker = &tracker_handle_completions; | |
1655 | } | |
1656 | } | |
1657 | catch (const gdb_exception &ex) | |
1658 | { | |
1659 | return {}; | |
1660 | } | |
1661 | ||
1662 | return tracker->build_completion_result (*word, *word - line, strlen (line)); | |
1663 | } | |
1664 | ||
1665 | ||
eb3ff9a5 PA |
1666 | /* Generate completions all at once. Does nothing if max_completions |
1667 | is 0. If max_completions is non-negative, this will collect at | |
1668 | most max_completions strings. | |
83d31a92 | 1669 | |
67c296a2 PM |
1670 | TEXT is the caller's idea of the "word" we are looking at. |
1671 | ||
aff410f1 MS |
1672 | LINE_BUFFER is available to be looked at; it contains the entire |
1673 | text of the line. | |
67c296a2 PM |
1674 | |
1675 | POINT is the offset in that line of the cursor. You | |
1676 | should pretend that the line ends at POINT. */ | |
14032a66 | 1677 | |
eb3ff9a5 PA |
1678 | void |
1679 | complete_line (completion_tracker &tracker, | |
1680 | const char *text, const char *line_buffer, int point) | |
14032a66 | 1681 | { |
ef0b411a | 1682 | if (max_completions == 0) |
eb3ff9a5 PA |
1683 | return; |
1684 | complete_line_internal (tracker, text, line_buffer, point, | |
1685 | handle_completions); | |
14032a66 TT |
1686 | } |
1687 | ||
1688 | /* Complete on command names. Used by "help". */ | |
6e1dbf8c | 1689 | |
eb3ff9a5 | 1690 | void |
aff410f1 | 1691 | command_completer (struct cmd_list_element *ignore, |
eb3ff9a5 | 1692 | completion_tracker &tracker, |
6f937416 | 1693 | const char *text, const char *word) |
14032a66 | 1694 | { |
eb3ff9a5 PA |
1695 | complete_line_internal (tracker, word, text, |
1696 | strlen (text), handle_help); | |
67c296a2 PM |
1697 | } |
1698 | ||
6e1dbf8c PA |
1699 | /* The corresponding completer_handle_brkchars implementation. */ |
1700 | ||
1701 | static void | |
1702 | command_completer_handle_brkchars (struct cmd_list_element *ignore, | |
eb3ff9a5 | 1703 | completion_tracker &tracker, |
6e1dbf8c PA |
1704 | const char *text, const char *word) |
1705 | { | |
1706 | set_rl_completer_word_break_characters | |
1707 | (gdb_completer_command_word_break_characters); | |
1708 | } | |
1709 | ||
de0bea00 MF |
1710 | /* Complete on signals. */ |
1711 | ||
eb3ff9a5 | 1712 | void |
de0bea00 | 1713 | signal_completer (struct cmd_list_element *ignore, |
eb3ff9a5 | 1714 | completion_tracker &tracker, |
6f937416 | 1715 | const char *text, const char *word) |
de0bea00 | 1716 | { |
de0bea00 | 1717 | size_t len = strlen (word); |
570dc176 | 1718 | int signum; |
de0bea00 MF |
1719 | const char *signame; |
1720 | ||
1721 | for (signum = GDB_SIGNAL_FIRST; signum != GDB_SIGNAL_LAST; ++signum) | |
1722 | { | |
1723 | /* Can't handle this, so skip it. */ | |
1724 | if (signum == GDB_SIGNAL_0) | |
1725 | continue; | |
1726 | ||
570dc176 | 1727 | signame = gdb_signal_to_name ((enum gdb_signal) signum); |
de0bea00 MF |
1728 | |
1729 | /* Ignore the unknown signal case. */ | |
1730 | if (!signame || strcmp (signame, "?") == 0) | |
1731 | continue; | |
1732 | ||
1733 | if (strncasecmp (signame, word, len) == 0) | |
b02f78f9 | 1734 | tracker.add_completion (make_unique_xstrdup (signame)); |
de0bea00 | 1735 | } |
de0bea00 MF |
1736 | } |
1737 | ||
51f0e40d AB |
1738 | /* Bit-flags for selecting what the register and/or register-group |
1739 | completer should complete on. */ | |
71c24708 | 1740 | |
8d297bbf | 1741 | enum reg_completer_target |
51f0e40d AB |
1742 | { |
1743 | complete_register_names = 0x1, | |
1744 | complete_reggroup_names = 0x2 | |
1745 | }; | |
8d297bbf | 1746 | DEF_ENUM_FLAGS_TYPE (enum reg_completer_target, reg_completer_targets); |
51f0e40d AB |
1747 | |
1748 | /* Complete register names and/or reggroup names based on the value passed | |
1749 | in TARGETS. At least one bit in TARGETS must be set. */ | |
1750 | ||
eb3ff9a5 PA |
1751 | static void |
1752 | reg_or_group_completer_1 (completion_tracker &tracker, | |
51f0e40d | 1753 | const char *text, const char *word, |
8d297bbf | 1754 | reg_completer_targets targets) |
71c24708 | 1755 | { |
71c24708 AA |
1756 | size_t len = strlen (word); |
1757 | struct gdbarch *gdbarch; | |
71c24708 | 1758 | const char *name; |
71c24708 | 1759 | |
51f0e40d AB |
1760 | gdb_assert ((targets & (complete_register_names |
1761 | | complete_reggroup_names)) != 0); | |
1762 | gdbarch = get_current_arch (); | |
71c24708 | 1763 | |
51f0e40d | 1764 | if ((targets & complete_register_names) != 0) |
71c24708 | 1765 | { |
51f0e40d AB |
1766 | int i; |
1767 | ||
1768 | for (i = 0; | |
1769 | (name = user_reg_map_regnum_to_name (gdbarch, i)) != NULL; | |
1770 | i++) | |
1771 | { | |
1772 | if (*name != '\0' && strncmp (word, name, len) == 0) | |
b02f78f9 | 1773 | tracker.add_completion (make_unique_xstrdup (name)); |
51f0e40d | 1774 | } |
71c24708 AA |
1775 | } |
1776 | ||
51f0e40d | 1777 | if ((targets & complete_reggroup_names) != 0) |
71c24708 | 1778 | { |
51f0e40d AB |
1779 | struct reggroup *group; |
1780 | ||
1781 | for (group = reggroup_next (gdbarch, NULL); | |
1782 | group != NULL; | |
1783 | group = reggroup_next (gdbarch, group)) | |
1784 | { | |
1785 | name = reggroup_name (group); | |
1786 | if (strncmp (word, name, len) == 0) | |
b02f78f9 | 1787 | tracker.add_completion (make_unique_xstrdup (name)); |
51f0e40d | 1788 | } |
71c24708 | 1789 | } |
71c24708 AA |
1790 | } |
1791 | ||
51f0e40d AB |
1792 | /* Perform completion on register and reggroup names. */ |
1793 | ||
eb3ff9a5 | 1794 | void |
51f0e40d | 1795 | reg_or_group_completer (struct cmd_list_element *ignore, |
eb3ff9a5 | 1796 | completion_tracker &tracker, |
51f0e40d AB |
1797 | const char *text, const char *word) |
1798 | { | |
eb3ff9a5 PA |
1799 | reg_or_group_completer_1 (tracker, text, word, |
1800 | (complete_register_names | |
1801 | | complete_reggroup_names)); | |
51f0e40d AB |
1802 | } |
1803 | ||
1804 | /* Perform completion on reggroup names. */ | |
1805 | ||
eb3ff9a5 | 1806 | void |
51f0e40d | 1807 | reggroup_completer (struct cmd_list_element *ignore, |
eb3ff9a5 | 1808 | completion_tracker &tracker, |
51f0e40d AB |
1809 | const char *text, const char *word) |
1810 | { | |
eb3ff9a5 PA |
1811 | reg_or_group_completer_1 (tracker, text, word, |
1812 | complete_reggroup_names); | |
51f0e40d | 1813 | } |
71c24708 | 1814 | |
6e1dbf8c PA |
1815 | /* The default completer_handle_brkchars implementation. */ |
1816 | ||
1817 | static void | |
1818 | default_completer_handle_brkchars (struct cmd_list_element *ignore, | |
eb3ff9a5 | 1819 | completion_tracker &tracker, |
6e1dbf8c PA |
1820 | const char *text, const char *word) |
1821 | { | |
1822 | set_rl_completer_word_break_characters | |
1823 | (current_language->la_word_break_characters ()); | |
1824 | } | |
1825 | ||
1826 | /* See definition in completer.h. */ | |
1827 | ||
1828 | completer_handle_brkchars_ftype * | |
1829 | completer_handle_brkchars_func_for_completer (completer_ftype *fn) | |
1830 | { | |
1831 | if (fn == filename_completer) | |
1832 | return filename_completer_handle_brkchars; | |
1833 | ||
c6756f62 PA |
1834 | if (fn == location_completer) |
1835 | return location_completer_handle_brkchars; | |
1836 | ||
6e1dbf8c PA |
1837 | if (fn == command_completer) |
1838 | return command_completer_handle_brkchars; | |
1839 | ||
1840 | return default_completer_handle_brkchars; | |
1841 | } | |
1842 | ||
c6756f62 PA |
1843 | /* Used as brkchars when we want to tell readline we have a custom |
1844 | word point. We do that by making our rl_completion_word_break_hook | |
1845 | set RL_POINT to the desired word point, and return the character at | |
1846 | the word break point as the break char. This is two bytes in order | |
1847 | to fit one break character plus the terminating null. */ | |
1848 | static char gdb_custom_word_point_brkchars[2]; | |
1849 | ||
1850 | /* Since rl_basic_quote_characters is not completer-specific, we save | |
1851 | its original value here, in order to be able to restore it in | |
1852 | gdb_rl_attempted_completion_function. */ | |
1853 | static const char *gdb_org_rl_basic_quote_characters = rl_basic_quote_characters; | |
1854 | ||
67c296a2 PM |
1855 | /* Get the list of chars that are considered as word breaks |
1856 | for the current command. */ | |
1857 | ||
eb3ff9a5 PA |
1858 | static char * |
1859 | gdb_completion_word_break_characters_throw () | |
67c296a2 | 1860 | { |
eb3ff9a5 PA |
1861 | /* New completion starting. Get rid of the previous tracker and |
1862 | start afresh. */ | |
1863 | delete current_completion.tracker; | |
1864 | current_completion.tracker = new completion_tracker (); | |
1865 | ||
1866 | completion_tracker &tracker = *current_completion.tracker; | |
1867 | ||
1868 | complete_line_internal (tracker, NULL, rl_line_buffer, | |
1869 | rl_point, handle_brkchars); | |
c5504eaf | 1870 | |
c6756f62 PA |
1871 | if (tracker.use_custom_word_point ()) |
1872 | { | |
1873 | gdb_assert (tracker.custom_word_point () > 0); | |
1874 | rl_point = tracker.custom_word_point () - 1; | |
1875 | gdb_custom_word_point_brkchars[0] = rl_line_buffer[rl_point]; | |
1876 | rl_completer_word_break_characters = gdb_custom_word_point_brkchars; | |
1877 | rl_completer_quote_characters = NULL; | |
1878 | ||
1879 | /* Clear this too, so that if we're completing a quoted string, | |
1880 | readline doesn't consider the quote character a delimiter. | |
1881 | If we didn't do this, readline would auto-complete {b | |
1882 | 'fun<tab>} to {'b 'function()'}, i.e., add the terminating | |
1883 | \', but, it wouldn't append the separator space either, which | |
1884 | is not desirable. So instead we take care of appending the | |
1885 | quote character to the LCD ourselves, in | |
1886 | gdb_rl_attempted_completion_function. Since this global is | |
1887 | not just completer-specific, we'll restore it back to the | |
1888 | default in gdb_rl_attempted_completion_function. */ | |
1889 | rl_basic_quote_characters = NULL; | |
1890 | } | |
1891 | ||
67c296a2 | 1892 | return rl_completer_word_break_characters; |
14032a66 TT |
1893 | } |
1894 | ||
eb3ff9a5 PA |
1895 | char * |
1896 | gdb_completion_word_break_characters () | |
1897 | { | |
1898 | /* New completion starting. */ | |
1899 | current_completion.aborted = false; | |
83d31a92 | 1900 | |
a70b8144 | 1901 | try |
eb3ff9a5 PA |
1902 | { |
1903 | return gdb_completion_word_break_characters_throw (); | |
1904 | } | |
230d2906 | 1905 | catch (const gdb_exception &ex) |
eb3ff9a5 PA |
1906 | { |
1907 | /* Set this to that gdb_rl_attempted_completion_function knows | |
1908 | to abort early. */ | |
1909 | current_completion.aborted = true; | |
1910 | } | |
83d31a92 | 1911 | |
eb3ff9a5 PA |
1912 | return NULL; |
1913 | } | |
83d31a92 | 1914 | |
eb3ff9a5 | 1915 | /* See completer.h. */ |
83d31a92 | 1916 | |
6a2c1b87 PA |
1917 | const char * |
1918 | completion_find_completion_word (completion_tracker &tracker, const char *text, | |
1919 | int *quote_char) | |
1920 | { | |
1921 | size_t point = strlen (text); | |
1922 | ||
1923 | complete_line_internal (tracker, NULL, text, point, handle_brkchars); | |
1924 | ||
c6756f62 PA |
1925 | if (tracker.use_custom_word_point ()) |
1926 | { | |
1927 | gdb_assert (tracker.custom_word_point () > 0); | |
1928 | *quote_char = tracker.quote_char (); | |
1929 | return text + tracker.custom_word_point (); | |
1930 | } | |
1931 | ||
6a2c1b87 PA |
1932 | gdb_rl_completion_word_info info; |
1933 | ||
1934 | info.word_break_characters = rl_completer_word_break_characters; | |
1935 | info.quote_characters = gdb_completer_quote_characters; | |
1936 | info.basic_quote_characters = rl_basic_quote_characters; | |
1937 | ||
1938 | return gdb_rl_find_completion_word (&info, quote_char, NULL, text); | |
1939 | } | |
1940 | ||
1941 | /* See completer.h. */ | |
1942 | ||
eb3ff9a5 | 1943 | void |
a22ecf70 PA |
1944 | completion_tracker::recompute_lowest_common_denominator |
1945 | (gdb::unique_xmalloc_ptr<char> &&new_match_up) | |
83d31a92 | 1946 | { |
eb3ff9a5 PA |
1947 | if (m_lowest_common_denominator == NULL) |
1948 | { | |
1949 | /* We don't have a lowest common denominator yet, so simply take | |
a22ecf70 PA |
1950 | the whole NEW_MATCH_UP as being it. */ |
1951 | m_lowest_common_denominator = new_match_up.release (); | |
eb3ff9a5 PA |
1952 | m_lowest_common_denominator_unique = true; |
1953 | } | |
1954 | else | |
83d31a92 | 1955 | { |
eb3ff9a5 | 1956 | /* Find the common denominator between the currently-known |
a22ecf70 | 1957 | lowest common denominator and NEW_MATCH_UP. That becomes the |
eb3ff9a5 PA |
1958 | new lowest common denominator. */ |
1959 | size_t i; | |
a22ecf70 | 1960 | const char *new_match = new_match_up.get (); |
83d31a92 | 1961 | |
eb3ff9a5 PA |
1962 | for (i = 0; |
1963 | (new_match[i] != '\0' | |
1964 | && new_match[i] == m_lowest_common_denominator[i]); | |
1965 | i++) | |
1966 | ; | |
1967 | if (m_lowest_common_denominator[i] != new_match[i]) | |
83d31a92 | 1968 | { |
eb3ff9a5 PA |
1969 | m_lowest_common_denominator[i] = '\0'; |
1970 | m_lowest_common_denominator_unique = false; | |
c5f0f3d0 FN |
1971 | } |
1972 | } | |
eb3ff9a5 PA |
1973 | } |
1974 | ||
c6756f62 PA |
1975 | /* See completer.h. */ |
1976 | ||
1977 | void | |
3844e605 | 1978 | completion_tracker::advance_custom_word_point_by (int len) |
c6756f62 PA |
1979 | { |
1980 | m_custom_word_point += len; | |
1981 | } | |
1982 | ||
eb3ff9a5 PA |
1983 | /* Build a new C string that is a copy of LCD with the whitespace of |
1984 | ORIG/ORIG_LEN preserved. | |
1985 | ||
1986 | Say the user is completing a symbol name, with spaces, like: | |
1987 | ||
1988 | "foo ( i" | |
1989 | ||
1990 | and the resulting completion match is: | |
1991 | ||
1992 | "foo(int)" | |
1993 | ||
1994 | we want to end up with an input line like: | |
1995 | ||
1996 | "foo ( int)" | |
1997 | ^^^^^^^ => text from LCD [1], whitespace from ORIG preserved. | |
1998 | ^^ => new text from LCD | |
1999 | ||
2000 | [1] - We must take characters from the LCD instead of the original | |
2001 | text, since some completions want to change upper/lowercase. E.g.: | |
c5f0f3d0 | 2002 | |
eb3ff9a5 | 2003 | "handle sig<>" |
c5f0f3d0 | 2004 | |
eb3ff9a5 PA |
2005 | completes to: |
2006 | ||
2007 | "handle SIG[QUIT|etc.]" | |
2008 | */ | |
2009 | ||
2010 | static char * | |
2011 | expand_preserving_ws (const char *orig, size_t orig_len, | |
2012 | const char *lcd) | |
2013 | { | |
2014 | const char *p_orig = orig; | |
2015 | const char *orig_end = orig + orig_len; | |
2016 | const char *p_lcd = lcd; | |
2017 | std::string res; | |
2018 | ||
2019 | while (p_orig < orig_end) | |
c5f0f3d0 | 2020 | { |
eb3ff9a5 PA |
2021 | if (*p_orig == ' ') |
2022 | { | |
2023 | while (p_orig < orig_end && *p_orig == ' ') | |
2024 | res += *p_orig++; | |
f1735a53 | 2025 | p_lcd = skip_spaces (p_lcd); |
eb3ff9a5 PA |
2026 | } |
2027 | else | |
c5f0f3d0 | 2028 | { |
eb3ff9a5 PA |
2029 | /* Take characters from the LCD instead of the original |
2030 | text, since some completions change upper/lowercase. | |
2031 | E.g.: | |
2032 | "handle sig<>" | |
2033 | completes to: | |
2034 | "handle SIG[QUIT|etc.]" | |
2035 | */ | |
2036 | res += *p_lcd; | |
2037 | p_orig++; | |
2038 | p_lcd++; | |
c5f0f3d0 FN |
2039 | } |
2040 | } | |
2041 | ||
eb3ff9a5 PA |
2042 | while (*p_lcd != '\0') |
2043 | res += *p_lcd++; | |
2044 | ||
2045 | return xstrdup (res.c_str ()); | |
2046 | } | |
2047 | ||
2048 | /* See completer.h. */ | |
2049 | ||
2050 | completion_result | |
2051 | completion_tracker::build_completion_result (const char *text, | |
2052 | int start, int end) | |
2053 | { | |
2054 | completion_list &list = m_entries_vec; /* The completions. */ | |
2055 | ||
2056 | if (list.empty ()) | |
2057 | return {}; | |
2058 | ||
2059 | /* +1 for the LCD, and +1 for NULL termination. */ | |
2060 | char **match_list = XNEWVEC (char *, 1 + list.size () + 1); | |
2061 | ||
2062 | /* Build replacement word, based on the LCD. */ | |
2063 | ||
2064 | match_list[0] | |
2065 | = expand_preserving_ws (text, end - start, | |
2066 | m_lowest_common_denominator); | |
2067 | ||
2068 | if (m_lowest_common_denominator_unique) | |
2069 | { | |
c6756f62 PA |
2070 | /* We don't rely on readline appending the quote char as |
2071 | delimiter as then readline wouldn't append the ' ' after the | |
2072 | completion. */ | |
896a7aa6 | 2073 | char buf[2] = { (char) quote_char () }; |
c6756f62 PA |
2074 | |
2075 | match_list[0] = reconcat (match_list[0], match_list[0], | |
2076 | buf, (char *) NULL); | |
eb3ff9a5 PA |
2077 | match_list[1] = NULL; |
2078 | ||
c45ec17c PA |
2079 | /* If the tracker wants to, or we already have a space at the |
2080 | end of the match, tell readline to skip appending | |
2081 | another. */ | |
eb3ff9a5 | 2082 | bool completion_suppress_append |
c45ec17c PA |
2083 | = (suppress_append_ws () |
2084 | || match_list[0][strlen (match_list[0]) - 1] == ' '); | |
eb3ff9a5 PA |
2085 | |
2086 | return completion_result (match_list, 1, completion_suppress_append); | |
2087 | } | |
2088 | else | |
2089 | { | |
2090 | int ix; | |
2091 | ||
2092 | for (ix = 0; ix < list.size (); ++ix) | |
2093 | match_list[ix + 1] = list[ix].release (); | |
2094 | match_list[ix + 1] = NULL; | |
2095 | ||
2096 | return completion_result (match_list, list.size (), false); | |
2097 | } | |
2098 | } | |
2099 | ||
2100 | /* See completer.h */ | |
2101 | ||
2102 | completion_result::completion_result () | |
2103 | : match_list (NULL), number_matches (0), | |
2104 | completion_suppress_append (false) | |
2105 | {} | |
2106 | ||
2107 | /* See completer.h */ | |
2108 | ||
2109 | completion_result::completion_result (char **match_list_, | |
2110 | size_t number_matches_, | |
2111 | bool completion_suppress_append_) | |
2112 | : match_list (match_list_), | |
2113 | number_matches (number_matches_), | |
2114 | completion_suppress_append (completion_suppress_append_) | |
2115 | {} | |
2116 | ||
2117 | /* See completer.h */ | |
2118 | ||
2119 | completion_result::~completion_result () | |
2120 | { | |
2121 | reset_match_list (); | |
2122 | } | |
2123 | ||
2124 | /* See completer.h */ | |
2125 | ||
2126 | completion_result::completion_result (completion_result &&rhs) | |
2127 | { | |
2128 | if (this == &rhs) | |
2129 | return; | |
2130 | ||
2131 | reset_match_list (); | |
2132 | match_list = rhs.match_list; | |
2133 | rhs.match_list = NULL; | |
2134 | number_matches = rhs.number_matches; | |
2135 | rhs.number_matches = 0; | |
2136 | } | |
2137 | ||
2138 | /* See completer.h */ | |
2139 | ||
2140 | char ** | |
2141 | completion_result::release_match_list () | |
2142 | { | |
2143 | char **ret = match_list; | |
2144 | match_list = NULL; | |
2145 | return ret; | |
2146 | } | |
2147 | ||
eb3ff9a5 PA |
2148 | /* See completer.h */ |
2149 | ||
2150 | void | |
2151 | completion_result::sort_match_list () | |
2152 | { | |
2153 | if (number_matches > 1) | |
2154 | { | |
2155 | /* Element 0 is special (it's the common prefix), leave it | |
2156 | be. */ | |
2157 | std::sort (&match_list[1], | |
2158 | &match_list[number_matches + 1], | |
2159 | compare_cstrings); | |
2160 | } | |
2161 | } | |
2162 | ||
2163 | /* See completer.h */ | |
2164 | ||
2165 | void | |
2166 | completion_result::reset_match_list () | |
2167 | { | |
2168 | if (match_list != NULL) | |
2169 | { | |
2170 | for (char **p = match_list; *p != NULL; p++) | |
2171 | xfree (*p); | |
2172 | xfree (match_list); | |
2173 | match_list = NULL; | |
2174 | } | |
2175 | } | |
2176 | ||
2177 | /* Helper for gdb_rl_attempted_completion_function, which does most of | |
2178 | the work. This is called by readline to build the match list array | |
2179 | and to determine the lowest common denominator. The real matches | |
2180 | list starts at match[1], while match[0] is the slot holding | |
2181 | readline's idea of the lowest common denominator of all matches, | |
2182 | which is what readline replaces the completion "word" with. | |
2183 | ||
2184 | TEXT is the caller's idea of the "word" we are looking at, as | |
2185 | computed in the handle_brkchars phase. | |
2186 | ||
2187 | START is the offset from RL_LINE_BUFFER where TEXT starts. END is | |
2188 | the offset from RL_LINE_BUFFER where TEXT ends (i.e., where | |
2189 | rl_point is). | |
2190 | ||
2191 | You should thus pretend that the line ends at END (relative to | |
2192 | RL_LINE_BUFFER). | |
2193 | ||
2194 | RL_LINE_BUFFER contains the entire text of the line. RL_POINT is | |
2195 | the offset in that line of the cursor. You should pretend that the | |
2196 | line ends at POINT. | |
2197 | ||
2198 | Returns NULL if there are no completions. */ | |
2199 | ||
2200 | static char ** | |
2201 | gdb_rl_attempted_completion_function_throw (const char *text, int start, int end) | |
2202 | { | |
c6756f62 PA |
2203 | /* Completers that provide a custom word point in the |
2204 | handle_brkchars phase also compute their completions then. | |
2205 | Completers that leave the completion word handling to readline | |
2206 | must be called twice. If rl_point (i.e., END) is at column 0, | |
2207 | then readline skips the handle_brkchars phase, and so we create a | |
2208 | tracker now in that case too. */ | |
2209 | if (end == 0 || !current_completion.tracker->use_custom_word_point ()) | |
2210 | { | |
2211 | delete current_completion.tracker; | |
2212 | current_completion.tracker = new completion_tracker (); | |
eb3ff9a5 | 2213 | |
c6756f62 PA |
2214 | complete_line (*current_completion.tracker, text, |
2215 | rl_line_buffer, rl_point); | |
2216 | } | |
c5f0f3d0 | 2217 | |
eb3ff9a5 PA |
2218 | completion_tracker &tracker = *current_completion.tracker; |
2219 | ||
2220 | completion_result result | |
2221 | = tracker.build_completion_result (text, start, end); | |
2222 | ||
2223 | rl_completion_suppress_append = result.completion_suppress_append; | |
2224 | return result.release_match_list (); | |
2225 | } | |
2226 | ||
2227 | /* Function installed as "rl_attempted_completion_function" readline | |
2228 | hook. Wrapper around gdb_rl_attempted_completion_function_throw | |
2229 | that catches C++ exceptions, which can't cross readline. */ | |
2230 | ||
2231 | char ** | |
2232 | gdb_rl_attempted_completion_function (const char *text, int start, int end) | |
2233 | { | |
c6756f62 PA |
2234 | /* Restore globals that might have been tweaked in |
2235 | gdb_completion_word_break_characters. */ | |
2236 | rl_basic_quote_characters = gdb_org_rl_basic_quote_characters; | |
2237 | ||
eb3ff9a5 PA |
2238 | /* If we end up returning NULL, either on error, or simple because |
2239 | there are no matches, inhibit readline's default filename | |
2240 | completer. */ | |
2241 | rl_attempted_completion_over = 1; | |
2242 | ||
2243 | /* If the handle_brkchars phase was aborted, don't try | |
2244 | completing. */ | |
2245 | if (current_completion.aborted) | |
2246 | return NULL; | |
2247 | ||
a70b8144 | 2248 | try |
eb3ff9a5 PA |
2249 | { |
2250 | return gdb_rl_attempted_completion_function_throw (text, start, end); | |
2251 | } | |
230d2906 | 2252 | catch (const gdb_exception &ex) |
eb3ff9a5 PA |
2253 | { |
2254 | } | |
eb3ff9a5 PA |
2255 | |
2256 | return NULL; | |
c5f0f3d0 | 2257 | } |
4e87b832 KD |
2258 | |
2259 | /* Skip over the possibly quoted word STR (as defined by the quote | |
b021a221 MS |
2260 | characters QUOTECHARS and the word break characters BREAKCHARS). |
2261 | Returns pointer to the location after the "word". If either | |
2262 | QUOTECHARS or BREAKCHARS is NULL, use the same values used by the | |
2263 | completer. */ | |
c5f0f3d0 | 2264 | |
d7561cbb KS |
2265 | const char * |
2266 | skip_quoted_chars (const char *str, const char *quotechars, | |
2267 | const char *breakchars) | |
c5f0f3d0 FN |
2268 | { |
2269 | char quote_char = '\0'; | |
d7561cbb | 2270 | const char *scan; |
c5f0f3d0 | 2271 | |
4e87b832 KD |
2272 | if (quotechars == NULL) |
2273 | quotechars = gdb_completer_quote_characters; | |
2274 | ||
2275 | if (breakchars == NULL) | |
51065942 | 2276 | breakchars = current_language->la_word_break_characters(); |
4e87b832 | 2277 | |
c5f0f3d0 FN |
2278 | for (scan = str; *scan != '\0'; scan++) |
2279 | { | |
2280 | if (quote_char != '\0') | |
2281 | { | |
9c3f90bd | 2282 | /* Ignore everything until the matching close quote char. */ |
c5f0f3d0 FN |
2283 | if (*scan == quote_char) |
2284 | { | |
9c3f90bd | 2285 | /* Found matching close quote. */ |
c5f0f3d0 FN |
2286 | scan++; |
2287 | break; | |
2288 | } | |
2289 | } | |
4e87b832 | 2290 | else if (strchr (quotechars, *scan)) |
c5f0f3d0 | 2291 | { |
aff410f1 | 2292 | /* Found start of a quoted string. */ |
c5f0f3d0 FN |
2293 | quote_char = *scan; |
2294 | } | |
4e87b832 | 2295 | else if (strchr (breakchars, *scan)) |
c5f0f3d0 FN |
2296 | { |
2297 | break; | |
2298 | } | |
2299 | } | |
4e87b832 | 2300 | |
c5f0f3d0 FN |
2301 | return (scan); |
2302 | } | |
2303 | ||
4e87b832 KD |
2304 | /* Skip over the possibly quoted word STR (as defined by the quote |
2305 | characters and word break characters used by the completer). | |
9c3f90bd | 2306 | Returns pointer to the location after the "word". */ |
4e87b832 | 2307 | |
d7561cbb KS |
2308 | const char * |
2309 | skip_quoted (const char *str) | |
4e87b832 KD |
2310 | { |
2311 | return skip_quoted_chars (str, NULL, NULL); | |
2312 | } | |
ef0b411a GB |
2313 | |
2314 | /* Return a message indicating that the maximum number of completions | |
2315 | has been reached and that there may be more. */ | |
2316 | ||
2317 | const char * | |
2318 | get_max_completions_reached_message (void) | |
2319 | { | |
2320 | return _("*** List may be truncated, max-completions reached. ***"); | |
2321 | } | |
82083d6d DE |
2322 | \f |
2323 | /* GDB replacement for rl_display_match_list. | |
2324 | Readline doesn't provide a clean interface for TUI(curses). | |
2325 | A hack previously used was to send readline's rl_outstream through a pipe | |
2326 | and read it from the event loop. Bleah. IWBN if readline abstracted | |
2327 | away all the necessary bits, and this is what this code does. It | |
2328 | replicates the parts of readline we need and then adds an abstraction | |
2329 | layer, currently implemented as struct match_list_displayer, so that both | |
2330 | CLI and TUI can use it. We copy all this readline code to minimize | |
2331 | GDB-specific mods to readline. Once this code performs as desired then | |
2332 | we can submit it to the readline maintainers. | |
2333 | ||
2334 | N.B. A lot of the code is the way it is in order to minimize differences | |
2335 | from readline's copy. */ | |
2336 | ||
2337 | /* Not supported here. */ | |
2338 | #undef VISIBLE_STATS | |
2339 | ||
2340 | #if defined (HANDLE_MULTIBYTE) | |
2341 | #define MB_INVALIDCH(x) ((x) == (size_t)-1 || (x) == (size_t)-2) | |
2342 | #define MB_NULLWCH(x) ((x) == 0) | |
2343 | #endif | |
2344 | ||
2345 | #define ELLIPSIS_LEN 3 | |
2346 | ||
2347 | /* gdb version of readline/complete.c:get_y_or_n. | |
2348 | 'y' -> returns 1, and 'n' -> returns 0. | |
2349 | Also supported: space == 'y', RUBOUT == 'n', ctrl-g == start over. | |
2350 | If FOR_PAGER is non-zero, then also supported are: | |
2351 | NEWLINE or RETURN -> returns 2, and 'q' -> returns 0. */ | |
2352 | ||
2353 | static int | |
2354 | gdb_get_y_or_n (int for_pager, const struct match_list_displayer *displayer) | |
2355 | { | |
2356 | int c; | |
2357 | ||
2358 | for (;;) | |
2359 | { | |
2360 | RL_SETSTATE (RL_STATE_MOREINPUT); | |
2361 | c = displayer->read_key (displayer); | |
2362 | RL_UNSETSTATE (RL_STATE_MOREINPUT); | |
2363 | ||
2364 | if (c == 'y' || c == 'Y' || c == ' ') | |
2365 | return 1; | |
2366 | if (c == 'n' || c == 'N' || c == RUBOUT) | |
2367 | return 0; | |
2368 | if (c == ABORT_CHAR || c < 0) | |
2369 | { | |
2370 | /* Readline doesn't erase_entire_line here, but without it the | |
2371 | --More-- prompt isn't erased and neither is the text entered | |
2372 | thus far redisplayed. */ | |
2373 | displayer->erase_entire_line (displayer); | |
2374 | /* Note: The arguments to rl_abort are ignored. */ | |
2375 | rl_abort (0, 0); | |
2376 | } | |
2377 | if (for_pager && (c == NEWLINE || c == RETURN)) | |
2378 | return 2; | |
2379 | if (for_pager && (c == 'q' || c == 'Q')) | |
2380 | return 0; | |
2381 | displayer->beep (displayer); | |
2382 | } | |
2383 | } | |
2384 | ||
2385 | /* Pager function for tab-completion. | |
2386 | This is based on readline/complete.c:_rl_internal_pager. | |
2387 | LINES is the number of lines of output displayed thus far. | |
2388 | Returns: | |
2389 | -1 -> user pressed 'n' or equivalent, | |
2390 | 0 -> user pressed 'y' or equivalent, | |
2391 | N -> user pressed NEWLINE or equivalent and N is LINES - 1. */ | |
2392 | ||
2393 | static int | |
2394 | gdb_display_match_list_pager (int lines, | |
2395 | const struct match_list_displayer *displayer) | |
2396 | { | |
2397 | int i; | |
2398 | ||
2399 | displayer->puts (displayer, "--More--"); | |
2400 | displayer->flush (displayer); | |
2401 | i = gdb_get_y_or_n (1, displayer); | |
2402 | displayer->erase_entire_line (displayer); | |
2403 | if (i == 0) | |
2404 | return -1; | |
2405 | else if (i == 2) | |
2406 | return (lines - 1); | |
2407 | else | |
2408 | return 0; | |
2409 | } | |
2410 | ||
2411 | /* Return non-zero if FILENAME is a directory. | |
2412 | Based on readline/complete.c:path_isdir. */ | |
2413 | ||
2414 | static int | |
2415 | gdb_path_isdir (const char *filename) | |
2416 | { | |
2417 | struct stat finfo; | |
2418 | ||
2419 | return (stat (filename, &finfo) == 0 && S_ISDIR (finfo.st_mode)); | |
2420 | } | |
2421 | ||
2422 | /* Return the portion of PATHNAME that should be output when listing | |
2423 | possible completions. If we are hacking filename completion, we | |
2424 | are only interested in the basename, the portion following the | |
2425 | final slash. Otherwise, we return what we were passed. Since | |
2426 | printing empty strings is not very informative, if we're doing | |
2427 | filename completion, and the basename is the empty string, we look | |
2428 | for the previous slash and return the portion following that. If | |
2429 | there's no previous slash, we just return what we were passed. | |
2430 | ||
2431 | Based on readline/complete.c:printable_part. */ | |
2432 | ||
2433 | static char * | |
2434 | gdb_printable_part (char *pathname) | |
2435 | { | |
2436 | char *temp, *x; | |
2437 | ||
2438 | if (rl_filename_completion_desired == 0) /* don't need to do anything */ | |
2439 | return (pathname); | |
2440 | ||
2441 | temp = strrchr (pathname, '/'); | |
5836a818 | 2442 | #if defined (__MSDOS__) |
82083d6d DE |
2443 | if (temp == 0 && ISALPHA ((unsigned char)pathname[0]) && pathname[1] == ':') |
2444 | temp = pathname + 1; | |
2445 | #endif | |
2446 | ||
2447 | if (temp == 0 || *temp == '\0') | |
2448 | return (pathname); | |
2449 | /* If the basename is NULL, we might have a pathname like '/usr/src/'. | |
2450 | Look for a previous slash and, if one is found, return the portion | |
2451 | following that slash. If there's no previous slash, just return the | |
2452 | pathname we were passed. */ | |
2453 | else if (temp[1] == '\0') | |
2454 | { | |
2455 | for (x = temp - 1; x > pathname; x--) | |
2456 | if (*x == '/') | |
2457 | break; | |
2458 | return ((*x == '/') ? x + 1 : pathname); | |
2459 | } | |
2460 | else | |
2461 | return ++temp; | |
2462 | } | |
2463 | ||
2464 | /* Compute width of STRING when displayed on screen by print_filename. | |
2465 | Based on readline/complete.c:fnwidth. */ | |
2466 | ||
2467 | static int | |
2468 | gdb_fnwidth (const char *string) | |
2469 | { | |
2470 | int width, pos; | |
2471 | #if defined (HANDLE_MULTIBYTE) | |
2472 | mbstate_t ps; | |
2473 | int left, w; | |
2474 | size_t clen; | |
2475 | wchar_t wc; | |
2476 | ||
2477 | left = strlen (string) + 1; | |
2478 | memset (&ps, 0, sizeof (mbstate_t)); | |
2479 | #endif | |
2480 | ||
2481 | width = pos = 0; | |
2482 | while (string[pos]) | |
2483 | { | |
2484 | if (CTRL_CHAR (string[pos]) || string[pos] == RUBOUT) | |
2485 | { | |
2486 | width += 2; | |
2487 | pos++; | |
2488 | } | |
2489 | else | |
2490 | { | |
2491 | #if defined (HANDLE_MULTIBYTE) | |
2492 | clen = mbrtowc (&wc, string + pos, left - pos, &ps); | |
2493 | if (MB_INVALIDCH (clen)) | |
2494 | { | |
2495 | width++; | |
2496 | pos++; | |
2497 | memset (&ps, 0, sizeof (mbstate_t)); | |
2498 | } | |
2499 | else if (MB_NULLWCH (clen)) | |
2500 | break; | |
2501 | else | |
2502 | { | |
2503 | pos += clen; | |
2504 | w = wcwidth (wc); | |
2505 | width += (w >= 0) ? w : 1; | |
2506 | } | |
2507 | #else | |
2508 | width++; | |
2509 | pos++; | |
2510 | #endif | |
2511 | } | |
2512 | } | |
2513 | ||
2514 | return width; | |
2515 | } | |
2516 | ||
2517 | /* Print TO_PRINT, one matching completion. | |
2518 | PREFIX_BYTES is number of common prefix bytes. | |
2519 | Based on readline/complete.c:fnprint. */ | |
2520 | ||
2521 | static int | |
2522 | gdb_fnprint (const char *to_print, int prefix_bytes, | |
2523 | const struct match_list_displayer *displayer) | |
2524 | { | |
2525 | int printed_len, w; | |
2526 | const char *s; | |
2527 | #if defined (HANDLE_MULTIBYTE) | |
2528 | mbstate_t ps; | |
2529 | const char *end; | |
2530 | size_t tlen; | |
2531 | int width; | |
2532 | wchar_t wc; | |
2533 | ||
2534 | end = to_print + strlen (to_print) + 1; | |
2535 | memset (&ps, 0, sizeof (mbstate_t)); | |
2536 | #endif | |
2537 | ||
2538 | printed_len = 0; | |
2539 | ||
2540 | /* Don't print only the ellipsis if the common prefix is one of the | |
2541 | possible completions */ | |
2542 | if (to_print[prefix_bytes] == '\0') | |
2543 | prefix_bytes = 0; | |
2544 | ||
2545 | if (prefix_bytes) | |
2546 | { | |
2547 | char ellipsis; | |
2548 | ||
2549 | ellipsis = (to_print[prefix_bytes] == '.') ? '_' : '.'; | |
2550 | for (w = 0; w < ELLIPSIS_LEN; w++) | |
2551 | displayer->putch (displayer, ellipsis); | |
2552 | printed_len = ELLIPSIS_LEN; | |
2553 | } | |
2554 | ||
2555 | s = to_print + prefix_bytes; | |
2556 | while (*s) | |
2557 | { | |
2558 | if (CTRL_CHAR (*s)) | |
2559 | { | |
2560 | displayer->putch (displayer, '^'); | |
2561 | displayer->putch (displayer, UNCTRL (*s)); | |
2562 | printed_len += 2; | |
2563 | s++; | |
2564 | #if defined (HANDLE_MULTIBYTE) | |
2565 | memset (&ps, 0, sizeof (mbstate_t)); | |
2566 | #endif | |
2567 | } | |
2568 | else if (*s == RUBOUT) | |
2569 | { | |
2570 | displayer->putch (displayer, '^'); | |
2571 | displayer->putch (displayer, '?'); | |
2572 | printed_len += 2; | |
2573 | s++; | |
2574 | #if defined (HANDLE_MULTIBYTE) | |
2575 | memset (&ps, 0, sizeof (mbstate_t)); | |
2576 | #endif | |
2577 | } | |
2578 | else | |
2579 | { | |
2580 | #if defined (HANDLE_MULTIBYTE) | |
2581 | tlen = mbrtowc (&wc, s, end - s, &ps); | |
2582 | if (MB_INVALIDCH (tlen)) | |
2583 | { | |
2584 | tlen = 1; | |
2585 | width = 1; | |
2586 | memset (&ps, 0, sizeof (mbstate_t)); | |
2587 | } | |
2588 | else if (MB_NULLWCH (tlen)) | |
2589 | break; | |
2590 | else | |
2591 | { | |
2592 | w = wcwidth (wc); | |
2593 | width = (w >= 0) ? w : 1; | |
2594 | } | |
2595 | for (w = 0; w < tlen; ++w) | |
2596 | displayer->putch (displayer, s[w]); | |
2597 | s += tlen; | |
2598 | printed_len += width; | |
2599 | #else | |
2600 | displayer->putch (displayer, *s); | |
2601 | s++; | |
2602 | printed_len++; | |
2603 | #endif | |
2604 | } | |
2605 | } | |
2606 | ||
2607 | return printed_len; | |
2608 | } | |
2609 | ||
2610 | /* Output TO_PRINT to rl_outstream. If VISIBLE_STATS is defined and we | |
2611 | are using it, check for and output a single character for `special' | |
2612 | filenames. Return the number of characters we output. | |
2613 | Based on readline/complete.c:print_filename. */ | |
2614 | ||
2615 | static int | |
2616 | gdb_print_filename (char *to_print, char *full_pathname, int prefix_bytes, | |
2617 | const struct match_list_displayer *displayer) | |
2618 | { | |
2619 | int printed_len, extension_char, slen, tlen; | |
a121b7c1 PA |
2620 | char *s, c, *new_full_pathname; |
2621 | const char *dn; | |
82083d6d DE |
2622 | extern int _rl_complete_mark_directories; |
2623 | ||
2624 | extension_char = 0; | |
2625 | printed_len = gdb_fnprint (to_print, prefix_bytes, displayer); | |
2626 | ||
2627 | #if defined (VISIBLE_STATS) | |
2628 | if (rl_filename_completion_desired && (rl_visible_stats || _rl_complete_mark_directories)) | |
2629 | #else | |
2630 | if (rl_filename_completion_desired && _rl_complete_mark_directories) | |
2631 | #endif | |
2632 | { | |
2633 | /* If to_print != full_pathname, to_print is the basename of the | |
2634 | path passed. In this case, we try to expand the directory | |
2635 | name before checking for the stat character. */ | |
2636 | if (to_print != full_pathname) | |
2637 | { | |
2638 | /* Terminate the directory name. */ | |
2639 | c = to_print[-1]; | |
2640 | to_print[-1] = '\0'; | |
2641 | ||
2642 | /* If setting the last slash in full_pathname to a NUL results in | |
2643 | full_pathname being the empty string, we are trying to complete | |
2644 | files in the root directory. If we pass a null string to the | |
2645 | bash directory completion hook, for example, it will expand it | |
2646 | to the current directory. We just want the `/'. */ | |
2647 | if (full_pathname == 0 || *full_pathname == 0) | |
2648 | dn = "/"; | |
2649 | else if (full_pathname[0] != '/') | |
2650 | dn = full_pathname; | |
2651 | else if (full_pathname[1] == 0) | |
2652 | dn = "//"; /* restore trailing slash to `//' */ | |
2653 | else if (full_pathname[1] == '/' && full_pathname[2] == 0) | |
2654 | dn = "/"; /* don't turn /// into // */ | |
2655 | else | |
2656 | dn = full_pathname; | |
2657 | s = tilde_expand (dn); | |
2658 | if (rl_directory_completion_hook) | |
2659 | (*rl_directory_completion_hook) (&s); | |
2660 | ||
2661 | slen = strlen (s); | |
2662 | tlen = strlen (to_print); | |
2663 | new_full_pathname = (char *)xmalloc (slen + tlen + 2); | |
2664 | strcpy (new_full_pathname, s); | |
2665 | if (s[slen - 1] == '/') | |
2666 | slen--; | |
2667 | else | |
2668 | new_full_pathname[slen] = '/'; | |
2669 | new_full_pathname[slen] = '/'; | |
2670 | strcpy (new_full_pathname + slen + 1, to_print); | |
2671 | ||
2672 | #if defined (VISIBLE_STATS) | |
2673 | if (rl_visible_stats) | |
2674 | extension_char = stat_char (new_full_pathname); | |
2675 | else | |
2676 | #endif | |
2677 | if (gdb_path_isdir (new_full_pathname)) | |
2678 | extension_char = '/'; | |
2679 | ||
2680 | xfree (new_full_pathname); | |
2681 | to_print[-1] = c; | |
2682 | } | |
2683 | else | |
2684 | { | |
2685 | s = tilde_expand (full_pathname); | |
2686 | #if defined (VISIBLE_STATS) | |
2687 | if (rl_visible_stats) | |
2688 | extension_char = stat_char (s); | |
2689 | else | |
2690 | #endif | |
2691 | if (gdb_path_isdir (s)) | |
2692 | extension_char = '/'; | |
2693 | } | |
2694 | ||
2695 | xfree (s); | |
2696 | if (extension_char) | |
2697 | { | |
2698 | displayer->putch (displayer, extension_char); | |
2699 | printed_len++; | |
2700 | } | |
2701 | } | |
2702 | ||
2703 | return printed_len; | |
2704 | } | |
2705 | ||
2706 | /* GDB version of readline/complete.c:complete_get_screenwidth. */ | |
2707 | ||
2708 | static int | |
2709 | gdb_complete_get_screenwidth (const struct match_list_displayer *displayer) | |
2710 | { | |
2711 | /* Readline has other stuff here which it's not clear we need. */ | |
2712 | return displayer->width; | |
2713 | } | |
2714 | ||
56000a98 PA |
2715 | extern int _rl_completion_prefix_display_length; |
2716 | extern int _rl_print_completions_horizontally; | |
2717 | ||
2718 | EXTERN_C int _rl_qsort_string_compare (const void *, const void *); | |
2719 | typedef int QSFUNC (const void *, const void *); | |
2720 | ||
82083d6d | 2721 | /* GDB version of readline/complete.c:rl_display_match_list. |
ef0b411a GB |
2722 | See gdb_display_match_list for a description of MATCHES, LEN, MAX. |
2723 | Returns non-zero if all matches are displayed. */ | |
82083d6d | 2724 | |
ef0b411a | 2725 | static int |
82083d6d DE |
2726 | gdb_display_match_list_1 (char **matches, int len, int max, |
2727 | const struct match_list_displayer *displayer) | |
2728 | { | |
2729 | int count, limit, printed_len, lines, cols; | |
2730 | int i, j, k, l, common_length, sind; | |
2731 | char *temp, *t; | |
2732 | int page_completions = displayer->height != INT_MAX && pagination_enabled; | |
82083d6d DE |
2733 | |
2734 | /* Find the length of the prefix common to all items: length as displayed | |
2735 | characters (common_length) and as a byte index into the matches (sind) */ | |
2736 | common_length = sind = 0; | |
2737 | if (_rl_completion_prefix_display_length > 0) | |
2738 | { | |
2739 | t = gdb_printable_part (matches[0]); | |
2740 | temp = strrchr (t, '/'); | |
2741 | common_length = temp ? gdb_fnwidth (temp) : gdb_fnwidth (t); | |
2742 | sind = temp ? strlen (temp) : strlen (t); | |
2743 | ||
2744 | if (common_length > _rl_completion_prefix_display_length && common_length > ELLIPSIS_LEN) | |
2745 | max -= common_length - ELLIPSIS_LEN; | |
2746 | else | |
2747 | common_length = sind = 0; | |
2748 | } | |
2749 | ||
2750 | /* How many items of MAX length can we fit in the screen window? */ | |
2751 | cols = gdb_complete_get_screenwidth (displayer); | |
2752 | max += 2; | |
2753 | limit = cols / max; | |
2754 | if (limit != 1 && (limit * max == cols)) | |
2755 | limit--; | |
2756 | ||
2757 | /* If cols == 0, limit will end up -1 */ | |
2758 | if (cols < displayer->width && limit < 0) | |
2759 | limit = 1; | |
2760 | ||
2761 | /* Avoid a possible floating exception. If max > cols, | |
2762 | limit will be 0 and a divide-by-zero fault will result. */ | |
2763 | if (limit == 0) | |
2764 | limit = 1; | |
2765 | ||
2766 | /* How many iterations of the printing loop? */ | |
2767 | count = (len + (limit - 1)) / limit; | |
2768 | ||
2769 | /* Watch out for special case. If LEN is less than LIMIT, then | |
2770 | just do the inner printing loop. | |
2771 | 0 < len <= limit implies count = 1. */ | |
2772 | ||
2773 | /* Sort the items if they are not already sorted. */ | |
2774 | if (rl_ignore_completion_duplicates == 0 && rl_sort_completion_matches) | |
2775 | qsort (matches + 1, len, sizeof (char *), (QSFUNC *)_rl_qsort_string_compare); | |
2776 | ||
2777 | displayer->crlf (displayer); | |
2778 | ||
2779 | lines = 0; | |
2780 | if (_rl_print_completions_horizontally == 0) | |
2781 | { | |
2782 | /* Print the sorted items, up-and-down alphabetically, like ls. */ | |
2783 | for (i = 1; i <= count; i++) | |
2784 | { | |
2785 | for (j = 0, l = i; j < limit; j++) | |
2786 | { | |
2787 | if (l > len || matches[l] == 0) | |
2788 | break; | |
2789 | else | |
2790 | { | |
2791 | temp = gdb_printable_part (matches[l]); | |
2792 | printed_len = gdb_print_filename (temp, matches[l], sind, | |
2793 | displayer); | |
2794 | ||
2795 | if (j + 1 < limit) | |
2796 | for (k = 0; k < max - printed_len; k++) | |
2797 | displayer->putch (displayer, ' '); | |
2798 | } | |
2799 | l += count; | |
2800 | } | |
2801 | displayer->crlf (displayer); | |
2802 | lines++; | |
2803 | if (page_completions && lines >= (displayer->height - 1) && i < count) | |
2804 | { | |
2805 | lines = gdb_display_match_list_pager (lines, displayer); | |
2806 | if (lines < 0) | |
ef0b411a | 2807 | return 0; |
82083d6d DE |
2808 | } |
2809 | } | |
2810 | } | |
2811 | else | |
2812 | { | |
2813 | /* Print the sorted items, across alphabetically, like ls -x. */ | |
2814 | for (i = 1; matches[i]; i++) | |
2815 | { | |
2816 | temp = gdb_printable_part (matches[i]); | |
2817 | printed_len = gdb_print_filename (temp, matches[i], sind, displayer); | |
2818 | /* Have we reached the end of this line? */ | |
2819 | if (matches[i+1]) | |
2820 | { | |
2821 | if (i && (limit > 1) && (i % limit) == 0) | |
2822 | { | |
2823 | displayer->crlf (displayer); | |
2824 | lines++; | |
2825 | if (page_completions && lines >= displayer->height - 1) | |
2826 | { | |
2827 | lines = gdb_display_match_list_pager (lines, displayer); | |
2828 | if (lines < 0) | |
ef0b411a | 2829 | return 0; |
82083d6d DE |
2830 | } |
2831 | } | |
2832 | else | |
2833 | for (k = 0; k < max - printed_len; k++) | |
2834 | displayer->putch (displayer, ' '); | |
2835 | } | |
2836 | } | |
2837 | displayer->crlf (displayer); | |
2838 | } | |
ef0b411a GB |
2839 | |
2840 | return 1; | |
82083d6d DE |
2841 | } |
2842 | ||
2843 | /* Utility for displaying completion list matches, used by both CLI and TUI. | |
2844 | ||
2845 | MATCHES is the list of strings, in argv format, LEN is the number of | |
05cdcf3d DE |
2846 | strings in MATCHES, and MAX is the length of the longest string in |
2847 | MATCHES. */ | |
82083d6d DE |
2848 | |
2849 | void | |
2850 | gdb_display_match_list (char **matches, int len, int max, | |
2851 | const struct match_list_displayer *displayer) | |
2852 | { | |
ef0b411a GB |
2853 | /* Readline will never call this if complete_line returned NULL. */ |
2854 | gdb_assert (max_completions != 0); | |
2855 | ||
2856 | /* complete_line will never return more than this. */ | |
2857 | if (max_completions > 0) | |
2858 | gdb_assert (len <= max_completions); | |
2859 | ||
82083d6d DE |
2860 | if (rl_completion_query_items > 0 && len >= rl_completion_query_items) |
2861 | { | |
2862 | char msg[100]; | |
2863 | ||
2864 | /* We can't use *query here because they wait for <RET> which is | |
2865 | wrong here. This follows the readline version as closely as possible | |
2866 | for compatibility's sake. See readline/complete.c. */ | |
2867 | ||
2868 | displayer->crlf (displayer); | |
2869 | ||
2870 | xsnprintf (msg, sizeof (msg), | |
2871 | "Display all %d possibilities? (y or n)", len); | |
2872 | displayer->puts (displayer, msg); | |
2873 | displayer->flush (displayer); | |
2874 | ||
2875 | if (gdb_get_y_or_n (0, displayer) == 0) | |
2876 | { | |
2877 | displayer->crlf (displayer); | |
2878 | return; | |
2879 | } | |
2880 | } | |
2881 | ||
ef0b411a GB |
2882 | if (gdb_display_match_list_1 (matches, len, max, displayer)) |
2883 | { | |
2884 | /* Note: MAX_COMPLETIONS may be -1 or zero, but LEN is always > 0. */ | |
2885 | if (len == max_completions) | |
2886 | { | |
2887 | /* The maximum number of completions has been reached. Warn the user | |
2888 | that there may be more. */ | |
2889 | const char *message = get_max_completions_reached_message (); | |
2890 | ||
2891 | displayer->puts (displayer, message); | |
2892 | displayer->crlf (displayer); | |
2893 | } | |
2894 | } | |
2895 | } | |
ef0b411a GB |
2896 | |
2897 | void | |
2898 | _initialize_completer (void) | |
2899 | { | |
2900 | add_setshow_zuinteger_unlimited_cmd ("max-completions", no_class, | |
2901 | &max_completions, _("\ | |
2902 | Set maximum number of completion candidates."), _("\ | |
2903 | Show maximum number of completion candidates."), _("\ | |
2904 | Use this to limit the number of candidates considered\n\ | |
2905 | during completion. Specifying \"unlimited\" or -1\n\ | |
2906 | disables limiting. Note that setting either no limit or\n\ | |
2907 | a very large limit can make completion slow."), | |
2908 | NULL, NULL, &setlist, &showlist); | |
82083d6d | 2909 | } |