gdb/completer.c

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