* infrun.c (normal_stop): Don't call
[deliverable/binutils-gdb.git] / gdb / completer.c
index 1ab71bea1887020000efc2fd5ea4b839783e521f..b1b0cf3a94c2bb146fefc9f4236dcc988330417d 100644 (file)
@@ -1,11 +1,11 @@
 /* Line completion stuff for GDB, the GNU debugger.
-   Copyright 2000, 2001 Free Software Foundation, Inc.
+   Copyright (C) 2000, 2001, 2007, 2008, 2009 Free Software Foundation, Inc.
 
    This file is part of GDB.
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
-   the Free Software Foundation; either version 2 of the License, or
+   the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.
 
    This program is distributed in the hope that it will be useful,
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software
-   Foundation, Inc., 59 Temple Place - Suite 330,
-   Boston, MA 02111-1307, USA.  */
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
 
 #include "defs.h"
 #include "symtab.h"
 #include "gdbtypes.h"
 #include "expression.h"
-#include "filenames.h"         /* for DOSish file names */
+#include "filenames.h"         /* For DOSish file names.  */
 #include "language.h"
 
 #include "cli/cli-decode.h"
 
-/* FIXME: This is needed because of lookup_cmd_1().
-   We should be calling a hook instead so we eliminate the CLI dependency. */
+/* FIXME: This is needed because of lookup_cmd_1 ().  We should be
+   calling a hook instead so we eliminate the CLI dependency.  */
 #include "gdbcmd.h"
 
 /* Needed for rl_completer_word_break_characters() and for
    rl_filename_completion_function.  */
-#include <readline/readline.h>
+#include "readline/readline.h"
 
 /* readline defines this.  */
 #undef savestring
 
 #include "completer.h"
 
-/* Prototypes for local functions */
+/* Prototypes for local functions */
 static
-char *line_completion_function (const char *text, int matches, char *line_buffer,
+char *line_completion_function (const char *text, int matches, 
+                               char *line_buffer,
                                int point);
 
 /* readline uses the word breaks for two things:
@@ -62,7 +61,7 @@ char *line_completion_function (const char *text, int matches, char *line_buffer
    word break characters, since we use it in command names.  If the
    readline library sees one in any of the current completion strings,
    it thinks that the string needs to be quoted and automatically supplies
-   a leading quote. */
+   a leading quote.  */
 static char *gdb_completer_command_word_break_characters =
 " \t\n!@#$%^&*()+=|~`}{[]\"';:?/>.<,";
 
@@ -84,10 +83,10 @@ static char *gdb_completer_loc_break_characters = " \t\n*|\"';:?><,";
 
 /* Characters that can be used to quote completion strings.  Note that we
    can't include '"' because the gdb C parser treats such quoted sequences
-   as strings. */
+   as strings.  */
 static char *gdb_completer_quote_characters = "'";
 \f
-/* Accessor for some completer data that may interest other files. */
+/* Accessor for some completer data that may interest other files.  */
 
 char *
 get_gdb_completer_quote_characters (void)
@@ -128,7 +127,7 @@ filename_completer (char *text, char *word)
   subsequent_name = 0;
   while (1)
     {
-      char *p;
+      char *p, *q;
       p = rl_filename_completion_function (text, subsequent_name);
       if (return_val_used >= return_val_alloced)
        {
@@ -150,38 +149,38 @@ filename_completer (char *text, char *word)
       /* Like emacs, don't complete on old versions.  Especially useful
          in the "source" command.  */
       if (p[strlen (p) - 1] == '~')
-       continue;
+       {
+         xfree (p);
+         continue;
+       }
 
-      {
-       char *q;
-       if (word == text)
-         /* Return exactly p.  */
-         return_val[return_val_used++] = p;
-       else if (word > text)
-         {
-           /* Return some portion of p.  */
-           q = xmalloc (strlen (p) + 5);
-           strcpy (q, p + (word - text));
-           return_val[return_val_used++] = q;
-           xfree (p);
-         }
-       else
-         {
-           /* Return some of TEXT plus p.  */
-           q = xmalloc (strlen (p) + (text - word) + 5);
-           strncpy (q, word, text - word);
-           q[text - word] = '\0';
-           strcat (q, p);
-           return_val[return_val_used++] = q;
-           xfree (p);
-         }
-      }
+      if (word == text)
+       /* Return exactly p.  */
+       return_val[return_val_used++] = p;
+      else if (word > text)
+       {
+         /* Return some portion of p.  */
+         q = xmalloc (strlen (p) + 5);
+         strcpy (q, p + (word - text));
+         return_val[return_val_used++] = q;
+         xfree (p);
+       }
+      else
+       {
+         /* Return some of TEXT plus p.  */
+         q = xmalloc (strlen (p) + (text - word) + 5);
+         strncpy (q, word, text - word);
+         q[text - word] = '\0';
+         strcat (q, p);
+         return_val[return_val_used++] = q;
+         xfree (p);
+       }
     }
 #if 0
   /* There is no way to do this just long enough to affect quote inserting
      without also affecting the next completion.  This should be fixed in
      readline.  FIXME.  */
-  /* Insure that readline does the right thing
+  /* Ensure that readline does the right thing
      with respect to inserting quotes.  */
   rl_completer_word_break_characters = "";
 #endif
@@ -230,7 +229,7 @@ location_completer (char *text, char *word)
          if (*p == quote_found)
            quote_found = 0;
          else
-           break;              /* hit the end of text */
+           break;              /* Hit the end of text.  */
        }
 #if HAVE_DOS_BASED_FILE_SYSTEM
       /* If we have a DOS-style absolute file name at the beginning of
@@ -280,7 +279,8 @@ location_completer (char *text, char *word)
       list = make_symbol_completion_list (symbol_start, word);
       /* If text includes characters which cannot appear in a file
         name, they cannot be asking for completion on files.  */
-      if (strcspn (text, gdb_completer_file_name_break_characters) == text_len)
+      if (strcspn (text, 
+                  gdb_completer_file_name_break_characters) == text_len)
        fn_list = make_source_files_completion_list (text, text);
     }
 
@@ -330,18 +330,106 @@ location_completer (char *text, char *word)
       /* No completions at all.  As the final resort, try completing
         on the entire text as a symbol.  */
       list = make_symbol_completion_list (orig_text, word);
+      xfree (fn_list);
     }
+  else
+    xfree (fn_list);
 
   return list;
 }
 
-/* Complete on command names.  Used by "help".  */
-char **
-command_completer (char *text, char *word)
+/* Helper for expression_completer which recursively counts the number
+   of named fields in a structure or union type.  */
+static int
+count_struct_fields (struct type *type)
 {
-  return complete_on_cmdlist (cmdlist, text, word);
+  int i, result = 0;
+
+  CHECK_TYPEDEF (type);
+  for (i = 0; i < TYPE_NFIELDS (type); ++i)
+    {
+      if (i < TYPE_N_BASECLASSES (type))
+       result += count_struct_fields (TYPE_BASECLASS (type, i));
+      else if (TYPE_FIELD_NAME (type, i))
+       ++result;
+    }
+  return result;
 }
 
+/* Helper for expression_completer which recursively adds field names
+   from TYPE, a struct or union type, to the array OUTPUT.  This
+   function assumes that OUTPUT is correctly-sized.  */
+static void
+add_struct_fields (struct type *type, int *nextp, char **output,
+                  char *fieldname, int namelen)
+{
+  int i;
+
+  CHECK_TYPEDEF (type);
+  for (i = 0; i < TYPE_NFIELDS (type); ++i)
+    {
+      if (i < TYPE_N_BASECLASSES (type))
+       add_struct_fields (TYPE_BASECLASS (type, i), nextp, output,
+                          fieldname, namelen);
+      else if (TYPE_FIELD_NAME (type, i)
+              && ! strncmp (TYPE_FIELD_NAME (type, i), fieldname, namelen))
+       {
+         output[*nextp] = xstrdup (TYPE_FIELD_NAME (type, i));
+         ++*nextp;
+       }
+    }
+}
+
+/* Complete on expressions.  Often this means completing on symbol
+   names, but some language parsers also have support for completing
+   field names.  */
+char **
+expression_completer (char *text, char *word)
+{
+  struct type *type;
+  char *fieldname, *p;
+
+  /* Perform a tentative parse of the expression, to see whether a
+     field completion is required.  */
+  fieldname = NULL;
+  type = parse_field_expression (text, &fieldname);
+  if (fieldname && type)
+    {
+      for (;;)
+       {
+         CHECK_TYPEDEF (type);
+         if (TYPE_CODE (type) != TYPE_CODE_PTR
+             && TYPE_CODE (type) != TYPE_CODE_REF)
+           break;
+         type = TYPE_TARGET_TYPE (type);
+       }
+
+      if (TYPE_CODE (type) == TYPE_CODE_UNION
+         || TYPE_CODE (type) == TYPE_CODE_STRUCT)
+       {
+         int alloc = count_struct_fields (type);
+         int flen = strlen (fieldname);
+         int out = 0;
+         char **result = (char **) xmalloc ((alloc + 1) * sizeof (char *));
+
+         add_struct_fields (type, &out, result, fieldname, flen);
+         result[out] = NULL;
+         xfree (fieldname);
+         return result;
+       }
+    }
+  xfree (fieldname);
+
+  /* Commands which complete on locations want to see the entire
+     argument.  */
+  for (p = word;
+       p > text && p[-1] != ' ' && p[-1] != '\t';
+       p--)
+    ;
+
+  /* Not ideal but it is what we used to do before... */
+  return location_completer (p, word);
+}
 
 /* Here are some useful test cases for completion.  FIXME: These should
    be put in the test suite.  They should be tested with both M-? and TAB.
@@ -373,10 +461,16 @@ command_completer (char *text, char *word)
 
    LINE_BUFFER is available to be looked at; it contains the entire text
    of the line.  POINT is the offset in that line of the cursor.  You
-   should pretend that the line ends at POINT.  */
-
-char **
-complete_line (const char *text, char *line_buffer, int point)
+   should pretend that the line ends at POINT.
+   
+   FOR_HELP is true when completing a 'help' command.  In this case,
+   once sub-command completions are exhausted, we simply return NULL.
+   When FOR_HELP is false, we will call a sub-command's completion
+   function.  */
+
+static char **
+complete_line_internal (const char *text, char *line_buffer, int point,
+                       int for_help)
 {
   char **list = NULL;
   char *tmp_command, *p;
@@ -394,7 +488,7 @@ complete_line (const char *text, char *line_buffer, int point)
   rl_completer_word_break_characters =
     current_language->la_word_break_characters();
 
-      /* Decide whether to complete on a list of gdb commands or on symbols. */
+  /* Decide whether to complete on a list of gdb commands or on symbols. */
   tmp_command = (char *) alloca (point + 1);
   p = tmp_command;
 
@@ -460,7 +554,7 @@ complete_line (const char *text, char *line_buffer, int point)
            {
              list = complete_on_cmdlist (cmdlist, p, word);
            }
-         /* Insure that readline does the right thing with respect to
+         /* Ensure that readline does the right thing with respect to
             inserting quotes.  */
          rl_completer_word_break_characters =
            gdb_completer_command_word_break_characters;
@@ -484,11 +578,13 @@ complete_line (const char *text, char *line_buffer, int point)
                     a subcommand (e.g. "info ").  */
                  list = complete_on_cmdlist (*c->prefixlist, p, word);
 
-                 /* Insure that readline does the right thing
-                        with respect to inserting quotes.  */
+                 /* Ensure that readline does the right thing
+                    with respect to inserting quotes.  */
                  rl_completer_word_break_characters =
                    gdb_completer_command_word_break_characters;
                }
+             else if (for_help)
+               list = NULL;
              else if (c->enums)
                {
                  list = complete_on_enum (c->enums, p, word);
@@ -550,12 +646,14 @@ complete_line (const char *text, char *line_buffer, int point)
 
              list = complete_on_cmdlist (result_list, q, word);
 
-                 /* Insure that readline does the right thing
-                    with respect to inserting quotes.  */
+             /* Ensure that readline does the right thing
+                with respect to inserting quotes.  */
              rl_completer_word_break_characters =
                gdb_completer_command_word_break_characters;
            }
        }
+      else if (for_help)
+       list = NULL;
       else
        {
          /* There is non-whitespace beyond the command.  */
@@ -601,6 +699,21 @@ complete_line (const char *text, char *line_buffer, int point)
   return list;
 }
 
+/* Like complete_line_internal, but always passes 0 for FOR_HELP.  */
+
+char **
+complete_line (const char *text, char *line_buffer, int point)
+{
+  return complete_line_internal (text, line_buffer, point, 0);
+}
+
+/* Complete on command names.  Used by "help".  */
+char **
+command_completer (char *text, char *word)
+{
+  return complete_line_internal (word, text, strlen (text), 1);
+}
+
 /* Generate completions one by one for the completer.  Each time we are
    called return another potential completion to the caller.
    line_completion just completes on commands or passes the buck to the
@@ -623,23 +736,26 @@ complete_line (const char *text, char *line_buffer, int point)
    free the string.  */
 
 static char *
-line_completion_function (const char *text, int matches, char *line_buffer, int point)
+line_completion_function (const char *text, int matches, 
+                         char *line_buffer, int point)
 {
-  static char **list = (char **) NULL; /* Cache of completions */
-  static int index;            /* Next cached completion */
+  static char **list = (char **) NULL; /* Cache of completions */
+  static int index;                    /* Next cached completion.  */
   char *output = NULL;
 
   if (matches == 0)
     {
       /* The caller is beginning to accumulate a new set of completions, so
          we need to find all of them now, and cache them for returning one at
-         a time on future calls. */
+         a time on future calls.  */
 
       if (list)
        {
          /* Free the storage used by LIST, but not by the strings inside.
-            This is because rl_complete_internal () frees the strings. */
+            This is because rl_complete_internal () frees the strings.
+            As complete_line may abort by calling `error' clear LIST now.  */
          xfree (list);
+         list = NULL;
        }
       index = 0;
       list = complete_line (text, line_buffer, point);
@@ -649,7 +765,7 @@ line_completion_function (const char *text, int matches, char *line_buffer, int
      dole them out one at a time.  The vector of completions is NULL
      terminated, so after returning the last one, return NULL (and continue
      to do so) each time we are called after that, until a new list is
-     available. */
+     available.  */
 
   if (list)
     {
@@ -695,10 +811,10 @@ skip_quoted_chars (char *str, char *quotechars, char *breakchars)
     {
       if (quote_char != '\0')
        {
-         /* Ignore everything until the matching close quote char */
+         /* Ignore everything until the matching close quote char */
          if (*scan == quote_char)
            {
-             /* Found matching close quote. */
+             /* Found matching close quote.  */
              scan++;
              break;
            }
@@ -719,7 +835,7 @@ skip_quoted_chars (char *str, char *quotechars, char *breakchars)
 
 /* Skip over the possibly quoted word STR (as defined by the quote
    characters and word break characters used by the completer).
-   Returns pointer to the location after the "word". */
+   Returns pointer to the location after the "word".  */
 
 char *
 skip_quoted (char *str)
This page took 0.030645 seconds and 4 git commands to generate.