* MAINTAINERS: Update Elena's email address.
[deliverable/binutils-gdb.git] / gdb / completer.c
CommitLineData
c5f0f3d0 1/* Line completion stuff for GDB, the GNU debugger.
0fb0cc75 2 Copyright (C) 2000, 2001, 2007, 2008, 2009 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"
20#include "symtab.h"
21#include "gdbtypes.h"
22#include "expression.h"
9c3f90bd 23#include "filenames.h" /* For DOSish file names. */
51065942 24#include "language.h"
c5f0f3d0 25
18a642a1
AC
26#include "cli/cli-decode.h"
27
03717487
MS
28/* FIXME: This is needed because of lookup_cmd_1 (). We should be
29 calling a hook instead so we eliminate the CLI dependency. */
c5f0f3d0
FN
30#include "gdbcmd.h"
31
c94fdfd0 32/* Needed for rl_completer_word_break_characters() and for
38017ce8 33 rl_filename_completion_function. */
dbda9972 34#include "readline/readline.h"
c5f0f3d0
FN
35
36/* readline defines this. */
37#undef savestring
38
39#include "completer.h"
40
9c3f90bd 41/* Prototypes for local functions. */
38017ce8 42static
03717487
MS
43char *line_completion_function (const char *text, int matches,
44 char *line_buffer,
d75b5104 45 int point);
c5f0f3d0
FN
46
47/* readline uses the word breaks for two things:
48 (1) In figuring out where to point the TEXT parameter to the
49 rl_completion_entry_function. Since we don't use TEXT for much,
50 it doesn't matter a lot what the word breaks are for this purpose, but
51 it does affect how much stuff M-? lists.
52 (2) If one of the matches contains a word break character, readline
53 will quote it. That's why we switch between
51065942 54 current_language->la_word_break_characters() and
c5f0f3d0
FN
55 gdb_completer_command_word_break_characters. I'm not sure when
56 we need this behavior (perhaps for funky characters in C++ symbols?). */
57
58/* Variables which are necessary for fancy command line editing. */
c5f0f3d0
FN
59
60/* When completing on command names, we remove '-' from the list of
61 word break characters, since we use it in command names. If the
62 readline library sees one in any of the current completion strings,
63 it thinks that the string needs to be quoted and automatically supplies
9c3f90bd 64 a leading quote. */
c5f0f3d0
FN
65static char *gdb_completer_command_word_break_characters =
66" \t\n!@#$%^&*()+=|~`}{[]\"';:?/>.<,";
67
68/* When completing on file names, we remove from the list of word
69 break characters any characters that are commonly used in file
70 names, such as '-', '+', '~', etc. Otherwise, readline displays
71 incorrect completion candidates. */
c3690141 72#ifdef HAVE_DOS_BASED_FILE_SYSTEM
7830cf6f
EZ
73/* MS-DOS and MS-Windows use colon as part of the drive spec, and most
74 programs support @foo style response files. */
75static char *gdb_completer_file_name_break_characters = " \t\n*|\"';?><@";
76#else
77static char *gdb_completer_file_name_break_characters = " \t\n*|\"';:?><";
78#endif
c5f0f3d0 79
c94fdfd0
EZ
80/* These are used when completing on locations, which can mix file
81 names and symbol names separated by a colon. */
82static char *gdb_completer_loc_break_characters = " \t\n*|\"';:?><,";
83
c5f0f3d0
FN
84/* Characters that can be used to quote completion strings. Note that we
85 can't include '"' because the gdb C parser treats such quoted sequences
9c3f90bd 86 as strings. */
c5f0f3d0
FN
87static char *gdb_completer_quote_characters = "'";
88\f
9c3f90bd 89/* Accessor for some completer data that may interest other files. */
c5f0f3d0 90
c5f0f3d0
FN
91char *
92get_gdb_completer_quote_characters (void)
93{
94 return gdb_completer_quote_characters;
95}
96
d75b5104
EZ
97/* Line completion interface function for readline. */
98
99char *
38017ce8 100readline_line_completion_function (const char *text, int matches)
d75b5104
EZ
101{
102 return line_completion_function (text, matches, rl_line_buffer, rl_point);
103}
104
105/* This can be used for functions which don't want to complete on symbols
106 but don't want to complete on anything else either. */
107char **
108noop_completer (char *text, char *prefix)
109{
110 return NULL;
111}
112
c5f0f3d0
FN
113/* Complete on filenames. */
114char **
115filename_completer (char *text, char *word)
116{
c5f0f3d0
FN
117 int subsequent_name;
118 char **return_val;
119 int return_val_used;
120 int return_val_alloced;
121
122 return_val_used = 0;
123 /* Small for testing. */
124 return_val_alloced = 1;
125 return_val = (char **) xmalloc (return_val_alloced * sizeof (char *));
126
127 subsequent_name = 0;
128 while (1)
129 {
1e8189fb 130 char *p, *q;
38017ce8 131 p = rl_filename_completion_function (text, subsequent_name);
c5f0f3d0
FN
132 if (return_val_used >= return_val_alloced)
133 {
134 return_val_alloced *= 2;
135 return_val =
136 (char **) xrealloc (return_val,
137 return_val_alloced * sizeof (char *));
138 }
139 if (p == NULL)
140 {
141 return_val[return_val_used++] = p;
142 break;
143 }
144 /* We need to set subsequent_name to a non-zero value before the
145 continue line below, because otherwise, if the first file seen
146 by GDB is a backup file whose name ends in a `~', we will loop
147 indefinitely. */
148 subsequent_name = 1;
149 /* Like emacs, don't complete on old versions. Especially useful
150 in the "source" command. */
151 if (p[strlen (p) - 1] == '~')
1e8189fb
MS
152 {
153 xfree (p);
154 continue;
155 }
c5f0f3d0 156
1e8189fb
MS
157 if (word == text)
158 /* Return exactly p. */
159 return_val[return_val_used++] = p;
160 else if (word > text)
161 {
162 /* Return some portion of p. */
163 q = xmalloc (strlen (p) + 5);
164 strcpy (q, p + (word - text));
165 return_val[return_val_used++] = q;
166 xfree (p);
167 }
168 else
169 {
170 /* Return some of TEXT plus p. */
171 q = xmalloc (strlen (p) + (text - word) + 5);
172 strncpy (q, word, text - word);
173 q[text - word] = '\0';
174 strcat (q, p);
175 return_val[return_val_used++] = q;
176 xfree (p);
177 }
c5f0f3d0
FN
178 }
179#if 0
180 /* There is no way to do this just long enough to affect quote inserting
181 without also affecting the next completion. This should be fixed in
182 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
187 return return_val;
188}
189
c94fdfd0
EZ
190/* Complete on locations, which might be of two possible forms:
191
192 file:line
193 or
194 symbol+offset
195
196 This is intended to be used in commands that set breakpoints etc. */
197char **
198location_completer (char *text, char *word)
199{
200 int n_syms = 0, n_files = 0;
201 char ** fn_list = NULL;
202 char ** list = NULL;
203 char *p;
204 int quote_found = 0;
205 int quoted = *text == '\'' || *text == '"';
206 int quote_char = '\0';
207 char *colon = NULL;
208 char *file_to_match = NULL;
209 char *symbol_start = text;
210 char *orig_text = text;
211 size_t text_len;
212
213 /* Do we have an unquoted colon, as in "break foo.c::bar"? */
214 for (p = text; *p != '\0'; ++p)
215 {
216 if (*p == '\\' && p[1] == '\'')
217 p++;
218 else if (*p == '\'' || *p == '"')
219 {
220 quote_found = *p;
221 quote_char = *p++;
222 while (*p != '\0' && *p != quote_found)
223 {
224 if (*p == '\\' && p[1] == quote_found)
225 p++;
226 p++;
227 }
228
229 if (*p == quote_found)
230 quote_found = 0;
231 else
9c3f90bd 232 break; /* Hit the end of text. */
c94fdfd0
EZ
233 }
234#if HAVE_DOS_BASED_FILE_SYSTEM
235 /* If we have a DOS-style absolute file name at the beginning of
236 TEXT, and the colon after the drive letter is the only colon
237 we found, pretend the colon is not there. */
238 else if (p < text + 3 && *p == ':' && p == text + 1 + quoted)
239 ;
240#endif
241 else if (*p == ':' && !colon)
242 {
243 colon = p;
244 symbol_start = p + 1;
245 }
51065942 246 else if (strchr (current_language->la_word_break_characters(), *p))
c94fdfd0
EZ
247 symbol_start = p + 1;
248 }
249
250 if (quoted)
251 text++;
252 text_len = strlen (text);
253
254 /* Where is the file name? */
255 if (colon)
256 {
257 char *s;
258
259 file_to_match = (char *) xmalloc (colon - text + 1);
260 strncpy (file_to_match, text, colon - text + 1);
261 /* Remove trailing colons and quotes from the file name. */
262 for (s = file_to_match + (colon - text);
263 s > file_to_match;
264 s--)
265 if (*s == ':' || *s == quote_char)
266 *s = '\0';
267 }
268 /* If the text includes a colon, they want completion only on a
269 symbol name after the colon. Otherwise, we need to complete on
270 symbols as well as on files. */
271 if (colon)
272 {
273 list = make_file_symbol_completion_list (symbol_start, word,
274 file_to_match);
275 xfree (file_to_match);
276 }
277 else
278 {
279 list = make_symbol_completion_list (symbol_start, word);
280 /* If text includes characters which cannot appear in a file
281 name, they cannot be asking for completion on files. */
1f20ed91
MS
282 if (strcspn (text,
283 gdb_completer_file_name_break_characters) == text_len)
c94fdfd0
EZ
284 fn_list = make_source_files_completion_list (text, text);
285 }
286
287 /* How many completions do we have in both lists? */
288 if (fn_list)
289 for ( ; fn_list[n_files]; n_files++)
290 ;
291 if (list)
292 for ( ; list[n_syms]; n_syms++)
293 ;
294
295 /* Make list[] large enough to hold both lists, then catenate
296 fn_list[] onto the end of list[]. */
297 if (n_syms && n_files)
298 {
299 list = xrealloc (list, (n_syms + n_files + 1) * sizeof (char *));
300 memcpy (list + n_syms, fn_list, (n_files + 1) * sizeof (char *));
301 xfree (fn_list);
302 }
303 else if (n_files)
304 {
305 /* If we only have file names as possible completion, we should
306 bring them in sync with what rl_complete expects. The
307 problem is that if the user types "break /foo/b TAB", and the
308 possible completions are "/foo/bar" and "/foo/baz"
309 rl_complete expects us to return "bar" and "baz", without the
310 leading directories, as possible completions, because `word'
311 starts at the "b". But we ignore the value of `word' when we
312 call make_source_files_completion_list above (because that
313 would not DTRT when the completion results in both symbols
314 and file names), so make_source_files_completion_list returns
315 the full "/foo/bar" and "/foo/baz" strings. This produces
316 wrong results when, e.g., there's only one possible
317 completion, because rl_complete will prepend "/foo/" to each
318 candidate completion. The loop below removes that leading
319 part. */
320 for (n_files = 0; fn_list[n_files]; n_files++)
321 {
322 memmove (fn_list[n_files], fn_list[n_files] + (word - text),
323 strlen (fn_list[n_files]) + 1 - (word - text));
324 }
325 /* Return just the file-name list as the result. */
326 list = fn_list;
327 }
328 else if (!n_syms)
329 {
330 /* No completions at all. As the final resort, try completing
331 on the entire text as a symbol. */
332 list = make_symbol_completion_list (orig_text, word);
1f20ed91 333 xfree (fn_list);
c94fdfd0 334 }
1f20ed91
MS
335 else
336 xfree (fn_list);
c94fdfd0
EZ
337
338 return list;
339}
340
65d12d83 341/* Helper for expression_completer which recursively counts the number
1c71341a 342 of named fields and methods in a structure or union type. */
65d12d83
TT
343static int
344count_struct_fields (struct type *type)
345{
346 int i, result = 0;
347
348 CHECK_TYPEDEF (type);
349 for (i = 0; i < TYPE_NFIELDS (type); ++i)
350 {
351 if (i < TYPE_N_BASECLASSES (type))
352 result += count_struct_fields (TYPE_BASECLASS (type, i));
353 else if (TYPE_FIELD_NAME (type, i))
354 ++result;
355 }
1c71341a
TT
356
357 for (i = TYPE_NFN_FIELDS (type) - 1; i >= 0; --i)
358 {
359 if (TYPE_FN_FIELDLIST_NAME (type, i))
360 ++result;
361 }
362
65d12d83
TT
363 return result;
364}
365
1c71341a
TT
366/* Helper for expression_completer which recursively adds field and
367 method names from TYPE, a struct or union type, to the array
368 OUTPUT. This function assumes that OUTPUT is correctly-sized. */
65d12d83
TT
369static void
370add_struct_fields (struct type *type, int *nextp, char **output,
371 char *fieldname, int namelen)
372{
373 int i;
1c71341a 374 char *type_name = NULL;
65d12d83
TT
375
376 CHECK_TYPEDEF (type);
377 for (i = 0; i < TYPE_NFIELDS (type); ++i)
378 {
379 if (i < TYPE_N_BASECLASSES (type))
380 add_struct_fields (TYPE_BASECLASS (type, i), nextp, output,
381 fieldname, namelen);
382 else if (TYPE_FIELD_NAME (type, i)
383 && ! strncmp (TYPE_FIELD_NAME (type, i), fieldname, namelen))
384 {
385 output[*nextp] = xstrdup (TYPE_FIELD_NAME (type, i));
386 ++*nextp;
387 }
388 }
1c71341a
TT
389
390 for (i = TYPE_NFN_FIELDS (type) - 1; i >= 0; --i)
391 {
392 char *name = TYPE_FN_FIELDLIST_NAME (type, i);
393 if (name && ! strncmp (name, fieldname, namelen))
394 {
395 if (!type_name)
396 type_name = type_name_no_tag (type);
397 /* Omit constructors from the completion list. */
398 if (strcmp (type_name, name))
399 {
400 output[*nextp] = xstrdup (name);
401 ++*nextp;
402 }
403 }
404 }
65d12d83
TT
405}
406
407/* Complete on expressions. Often this means completing on symbol
408 names, but some language parsers also have support for completing
409 field names. */
410char **
411expression_completer (char *text, char *word)
412{
413 struct type *type;
37cd5d19 414 char *fieldname, *p;
65d12d83
TT
415
416 /* Perform a tentative parse of the expression, to see whether a
417 field completion is required. */
418 fieldname = NULL;
419 type = parse_field_expression (text, &fieldname);
420 if (fieldname && type)
421 {
422 for (;;)
423 {
424 CHECK_TYPEDEF (type);
425 if (TYPE_CODE (type) != TYPE_CODE_PTR
426 && TYPE_CODE (type) != TYPE_CODE_REF)
427 break;
428 type = TYPE_TARGET_TYPE (type);
429 }
430
431 if (TYPE_CODE (type) == TYPE_CODE_UNION
432 || TYPE_CODE (type) == TYPE_CODE_STRUCT)
433 {
434 int alloc = count_struct_fields (type);
435 int flen = strlen (fieldname);
436 int out = 0;
437 char **result = (char **) xmalloc ((alloc + 1) * sizeof (char *));
438
439 add_struct_fields (type, &out, result, fieldname, flen);
440 result[out] = NULL;
a0b7aece 441 xfree (fieldname);
65d12d83
TT
442 return result;
443 }
444 }
a0b7aece 445 xfree (fieldname);
65d12d83 446
37cd5d19
TT
447 /* Commands which complete on locations want to see the entire
448 argument. */
449 for (p = word;
450 p > text && p[-1] != ' ' && p[-1] != '\t';
451 p--)
452 ;
453
65d12d83 454 /* Not ideal but it is what we used to do before... */
37cd5d19 455 return location_completer (p, word);
65d12d83
TT
456}
457
c5f0f3d0
FN
458/* Here are some useful test cases for completion. FIXME: These should
459 be put in the test suite. They should be tested with both M-? and TAB.
460
461 "show output-" "radix"
462 "show output" "-radix"
463 "p" ambiguous (commands starting with p--path, print, printf, etc.)
464 "p " ambiguous (all symbols)
465 "info t foo" no completions
466 "info t " no completions
467 "info t" ambiguous ("info target", "info terminal", etc.)
468 "info ajksdlfk" no completions
469 "info ajksdlfk " no completions
470 "info" " "
471 "info " ambiguous (all info commands)
472 "p \"a" no completions (string constant)
473 "p 'a" ambiguous (all symbols starting with a)
474 "p b-a" ambiguous (all symbols starting with a)
475 "p b-" ambiguous (all symbols)
476 "file Make" "file" (word break hard to screw up here)
477 "file ../gdb.stabs/we" "ird" (needs to not break word at slash)
478 */
479
83d31a92
TT
480/* Generate completions all at once. Returns a NULL-terminated array
481 of strings. Both the array and each element are allocated with
482 xmalloc. It can also return NULL if there are no completions.
c5f0f3d0
FN
483
484 TEXT is the caller's idea of the "word" we are looking at.
485
c5f0f3d0
FN
486 LINE_BUFFER is available to be looked at; it contains the entire text
487 of the line. POINT is the offset in that line of the cursor. You
14032a66
TT
488 should pretend that the line ends at POINT.
489
490 FOR_HELP is true when completing a 'help' command. In this case,
491 once sub-command completions are exhausted, we simply return NULL.
492 When FOR_HELP is false, we will call a sub-command's completion
493 function. */
494
495static char **
496complete_line_internal (const char *text, char *line_buffer, int point,
497 int for_help)
c5f0f3d0 498{
83d31a92 499 char **list = NULL;
c5f0f3d0
FN
500 char *tmp_command, *p;
501 /* Pointer within tmp_command which corresponds to text. */
502 char *word;
503 struct cmd_list_element *c, *result_list;
504
83d31a92
TT
505 /* Choose the default set of word break characters to break completions.
506 If we later find out that we are doing completions on command strings
507 (as opposed to strings supplied by the individual command completer
508 functions, which can be any string) then we will switch to the
509 special word break set for command strings, which leaves out the
510 '-' character used in some commands. */
c5f0f3d0 511
83d31a92 512 rl_completer_word_break_characters =
51065942 513 current_language->la_word_break_characters();
c5f0f3d0 514
9c3f90bd 515 /* Decide whether to complete on a list of gdb commands or on symbols. */
83d31a92
TT
516 tmp_command = (char *) alloca (point + 1);
517 p = tmp_command;
c5f0f3d0 518
83d31a92
TT
519 strncpy (tmp_command, line_buffer, point);
520 tmp_command[point] = '\0';
521 /* Since text always contains some number of characters leading up
522 to point, we can find the equivalent position in tmp_command
523 by subtracting that many characters from the end of tmp_command. */
524 word = tmp_command + point - strlen (text);
c5f0f3d0 525
83d31a92
TT
526 if (point == 0)
527 {
528 /* An empty line we want to consider ambiguous; that is, it
529 could be any command. */
530 c = (struct cmd_list_element *) -1;
531 result_list = 0;
532 }
533 else
534 {
535 c = lookup_cmd_1 (&p, cmdlist, &result_list, 1);
536 }
c5f0f3d0 537
83d31a92
TT
538 /* Move p up to the next interesting thing. */
539 while (*p == ' ' || *p == '\t')
540 {
541 p++;
542 }
c5f0f3d0 543
83d31a92
TT
544 if (!c)
545 {
546 /* It is an unrecognized command. So there are no
547 possible completions. */
548 list = NULL;
549 }
550 else if (c == (struct cmd_list_element *) -1)
551 {
552 char *q;
553
554 /* lookup_cmd_1 advances p up to the first ambiguous thing, but
555 doesn't advance over that thing itself. Do so now. */
556 q = p;
557 while (*q && (isalnum (*q) || *q == '-' || *q == '_'))
558 ++q;
559 if (q != tmp_command + point)
c5f0f3d0 560 {
83d31a92
TT
561 /* There is something beyond the ambiguous
562 command, so there are no possible completions. For
563 example, "info t " or "info t foo" does not complete
564 to anything, because "info t" can be "info target" or
565 "info terminal". */
c5f0f3d0
FN
566 list = NULL;
567 }
83d31a92 568 else
c5f0f3d0 569 {
83d31a92
TT
570 /* We're trying to complete on the command which was ambiguous.
571 This we can deal with. */
572 if (result_list)
c5f0f3d0 573 {
83d31a92
TT
574 list = complete_on_cmdlist (*result_list->prefixlist, p,
575 word);
c5f0f3d0
FN
576 }
577 else
578 {
83d31a92 579 list = complete_on_cmdlist (cmdlist, p, word);
c5f0f3d0 580 }
489f0516 581 /* Ensure that readline does the right thing with respect to
83d31a92
TT
582 inserting quotes. */
583 rl_completer_word_break_characters =
584 gdb_completer_command_word_break_characters;
c5f0f3d0 585 }
83d31a92
TT
586 }
587 else
588 {
589 /* We've recognized a full command. */
590
591 if (p == tmp_command + point)
c5f0f3d0 592 {
83d31a92 593 /* There is no non-whitespace in the line beyond the command. */
c5f0f3d0 594
83d31a92 595 if (p[-1] == ' ' || p[-1] == '\t')
c5f0f3d0 596 {
83d31a92
TT
597 /* The command is followed by whitespace; we need to complete
598 on whatever comes after command. */
599 if (c->prefixlist)
c5f0f3d0 600 {
83d31a92
TT
601 /* It is a prefix command; what comes after it is
602 a subcommand (e.g. "info "). */
603 list = complete_on_cmdlist (*c->prefixlist, p, word);
c5f0f3d0 604
489f0516 605 /* Ensure that readline does the right thing
9c3f90bd 606 with respect to inserting quotes. */
c5f0f3d0
FN
607 rl_completer_word_break_characters =
608 gdb_completer_command_word_break_characters;
609 }
14032a66
TT
610 else if (for_help)
611 list = NULL;
c5f0f3d0
FN
612 else if (c->enums)
613 {
614 list = complete_on_enum (c->enums, p, word);
83d31a92
TT
615 rl_completer_word_break_characters =
616 gdb_completer_command_word_break_characters;
c5f0f3d0
FN
617 }
618 else
619 {
83d31a92
TT
620 /* It is a normal command; what comes after it is
621 completed by the command's completer function. */
c5f0f3d0 622 if (c->completer == filename_completer)
7830cf6f 623 {
83d31a92
TT
624 /* Many commands which want to complete on
625 file names accept several file names, as
626 in "run foo bar >>baz". So we don't want
627 to complete the entire text after the
628 command, just the last word. To this
629 end, we need to find the beginning of the
630 file name by starting at `word' and going
631 backwards. */
7830cf6f
EZ
632 for (p = word;
633 p > tmp_command
634 && strchr (gdb_completer_file_name_break_characters, p[-1]) == NULL;
635 p--)
636 ;
637 rl_completer_word_break_characters =
638 gdb_completer_file_name_break_characters;
639 }
37cd5d19 640 else if (c->completer == location_completer)
c94fdfd0 641 {
83d31a92
TT
642 /* Commands which complete on locations want to
643 see the entire argument. */
c94fdfd0
EZ
644 for (p = word;
645 p > tmp_command
646 && p[-1] != ' ' && p[-1] != '\t';
647 p--)
648 ;
649 }
7830cf6f 650 list = (*c->completer) (p, word);
c5f0f3d0
FN
651 }
652 }
83d31a92
TT
653 else
654 {
655 /* The command is not followed by whitespace; we need to
656 complete on the command itself. e.g. "p" which is a
657 command itself but also can complete to "print", "ptype"
658 etc. */
659 char *q;
660
661 /* Find the command we are completing on. */
662 q = p;
663 while (q > tmp_command)
664 {
665 if (isalnum (q[-1]) || q[-1] == '-' || q[-1] == '_')
666 --q;
667 else
668 break;
669 }
670
671 list = complete_on_cmdlist (result_list, q, word);
672
489f0516 673 /* Ensure that readline does the right thing
9c3f90bd 674 with respect to inserting quotes. */
83d31a92
TT
675 rl_completer_word_break_characters =
676 gdb_completer_command_word_break_characters;
677 }
678 }
14032a66
TT
679 else if (for_help)
680 list = NULL;
83d31a92
TT
681 else
682 {
683 /* There is non-whitespace beyond the command. */
684
685 if (c->prefixlist && !c->allow_unknown)
686 {
687 /* It is an unrecognized subcommand of a prefix command,
688 e.g. "info adsfkdj". */
689 list = NULL;
690 }
691 else if (c->enums)
692 {
693 list = complete_on_enum (c->enums, p, word);
694 }
695 else
696 {
697 /* It is a normal command. */
698 if (c->completer == filename_completer)
699 {
700 /* See the commentary above about the specifics
701 of file-name completion. */
702 for (p = word;
703 p > tmp_command
704 && strchr (gdb_completer_file_name_break_characters, p[-1]) == NULL;
705 p--)
706 ;
707 rl_completer_word_break_characters =
708 gdb_completer_file_name_break_characters;
709 }
37cd5d19 710 else if (c->completer == location_completer)
83d31a92
TT
711 {
712 for (p = word;
713 p > tmp_command
714 && p[-1] != ' ' && p[-1] != '\t';
715 p--)
716 ;
717 }
718 list = (*c->completer) (p, word);
719 }
720 }
721 }
722
723 return list;
724}
725
14032a66
TT
726/* Like complete_line_internal, but always passes 0 for FOR_HELP. */
727
728char **
729complete_line (const char *text, char *line_buffer, int point)
730{
731 return complete_line_internal (text, line_buffer, point, 0);
732}
733
734/* Complete on command names. Used by "help". */
735char **
736command_completer (char *text, char *word)
737{
738 return complete_line_internal (word, text, strlen (text), 1);
739}
740
83d31a92
TT
741/* Generate completions one by one for the completer. Each time we are
742 called return another potential completion to the caller.
743 line_completion just completes on commands or passes the buck to the
744 command's completer function, the stuff specific to symbol completion
745 is in make_symbol_completion_list.
746
747 TEXT is the caller's idea of the "word" we are looking at.
748
749 MATCHES is the number of matches that have currently been collected from
750 calling this completion function. When zero, then we need to initialize,
751 otherwise the initialization has already taken place and we can just
752 return the next potential completion string.
753
754 LINE_BUFFER is available to be looked at; it contains the entire text
755 of the line. POINT is the offset in that line of the cursor. You
756 should pretend that the line ends at POINT.
757
758 Returns NULL if there are no more completions, else a pointer to a string
759 which is a possible completion, it is the caller's responsibility to
760 free the string. */
761
38017ce8 762static char *
9c3f90bd
MS
763line_completion_function (const char *text, int matches,
764 char *line_buffer, int point)
83d31a92 765{
9c3f90bd
MS
766 static char **list = (char **) NULL; /* Cache of completions. */
767 static int index; /* Next cached completion. */
83d31a92
TT
768 char *output = NULL;
769
770 if (matches == 0)
771 {
772 /* The caller is beginning to accumulate a new set of completions, so
773 we need to find all of them now, and cache them for returning one at
9c3f90bd 774 a time on future calls. */
83d31a92
TT
775
776 if (list)
777 {
778 /* Free the storage used by LIST, but not by the strings inside.
6f4de6c9
JK
779 This is because rl_complete_internal () frees the strings.
780 As complete_line may abort by calling `error' clear LIST now. */
83d31a92 781 xfree (list);
6f4de6c9 782 list = NULL;
c5f0f3d0 783 }
83d31a92
TT
784 index = 0;
785 list = complete_line (text, line_buffer, point);
c5f0f3d0
FN
786 }
787
788 /* If we found a list of potential completions during initialization then
789 dole them out one at a time. The vector of completions is NULL
790 terminated, so after returning the last one, return NULL (and continue
791 to do so) each time we are called after that, until a new list is
9c3f90bd 792 available. */
c5f0f3d0
FN
793
794 if (list)
795 {
796 output = list[index];
797 if (output)
798 {
799 index++;
800 }
801 }
802
803#if 0
804 /* Can't do this because readline hasn't yet checked the word breaks
805 for figuring out whether to insert a quote. */
806 if (output == NULL)
807 /* Make sure the word break characters are set back to normal for the
808 next time that readline tries to complete something. */
809 rl_completer_word_break_characters =
51065942 810 current_language->la_word_break_characters();
c5f0f3d0
FN
811#endif
812
813 return (output);
814}
4e87b832
KD
815
816/* Skip over the possibly quoted word STR (as defined by the quote
817 characters QUOTECHARS and the the word break characters
818 BREAKCHARS). Returns pointer to the location after the "word". If
819 either QUOTECHARS or BREAKCHARS is NULL, use the same values used
820 by the completer. */
c5f0f3d0
FN
821
822char *
4e87b832 823skip_quoted_chars (char *str, char *quotechars, char *breakchars)
c5f0f3d0
FN
824{
825 char quote_char = '\0';
826 char *scan;
827
4e87b832
KD
828 if (quotechars == NULL)
829 quotechars = gdb_completer_quote_characters;
830
831 if (breakchars == NULL)
51065942 832 breakchars = current_language->la_word_break_characters();
4e87b832 833
c5f0f3d0
FN
834 for (scan = str; *scan != '\0'; scan++)
835 {
836 if (quote_char != '\0')
837 {
9c3f90bd 838 /* Ignore everything until the matching close quote char. */
c5f0f3d0
FN
839 if (*scan == quote_char)
840 {
9c3f90bd 841 /* Found matching close quote. */
c5f0f3d0
FN
842 scan++;
843 break;
844 }
845 }
4e87b832 846 else if (strchr (quotechars, *scan))
c5f0f3d0
FN
847 {
848 /* Found start of a quoted string. */
849 quote_char = *scan;
850 }
4e87b832 851 else if (strchr (breakchars, *scan))
c5f0f3d0
FN
852 {
853 break;
854 }
855 }
4e87b832 856
c5f0f3d0
FN
857 return (scan);
858}
859
4e87b832
KD
860/* Skip over the possibly quoted word STR (as defined by the quote
861 characters and word break characters used by the completer).
9c3f90bd 862 Returns pointer to the location after the "word". */
4e87b832
KD
863
864char *
865skip_quoted (char *str)
866{
867 return skip_quoted_chars (str, NULL, NULL);
868}
This page took 0.612379 seconds and 4 git commands to generate.