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