* m68klinux-nat.c: Remove #ifndef USE_PROC_FS check.
[deliverable/binutils-gdb.git] / gdb / completer.c
index a06eb65ac08679f6b7cd32868031f26e5880f4ff..3656be1d6de3dad9155da28dfe234445cc9c2cb3 100644 (file)
@@ -1,5 +1,5 @@
 /* Line completion stuff for GDB, the GNU debugger.
-   Copyright 2000, 2001 Free Software Foundation, Inc.
+   Copyright (C) 2000, 2001, 2007 Free Software Foundation, Inc.
 
    This file is part of GDB.
 
 
    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.  */
+   Foundation, Inc., 51 Franklin Street, Fifth Floor,
+   Boston, MA 02110-1301, USA.  */
 
 #include "defs.h"
 #include "symtab.h"
 #include "gdbtypes.h"
 #include "expression.h"
 #include "filenames.h"         /* for DOSish file names */
+#include "language.h"
 
-/* FIXME: This is needed because of lookup_cmd_1().
-   We should be calling a hook instead so we eliminate the CLI dependency. */
+#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.  */
 #include "gdbcmd.h"
 
 /* Needed for rl_completer_word_break_characters() and for
-   filename_completion_function.  */
-#include <readline/readline.h>
+   rl_filename_completion_function.  */
+#include "readline/readline.h"
 
 /* readline defines this.  */
 #undef savestring
@@ -38,7 +41,9 @@
 #include "completer.h"
 
 /* Prototypes for local functions */
-char *line_completion_function (char *text, int matches, char *line_buffer,
+static
+char *line_completion_function (const char *text, int matches, 
+                               char *line_buffer,
                                int point);
 
 /* readline uses the word breaks for two things:
@@ -48,13 +53,11 @@ char *line_completion_function (char *text, int matches, char *line_buffer,
    it does affect how much stuff M-? lists.
    (2) If one of the matches contains a word break character, readline
    will quote it.  That's why we switch between
-   gdb_completer_word_break_characters and
+   current_language->la_word_break_characters() and
    gdb_completer_command_word_break_characters.  I'm not sure when
    we need this behavior (perhaps for funky characters in C++ symbols?).  */
 
 /* Variables which are necessary for fancy command line editing.  */
-static char *gdb_completer_word_break_characters =
-" \t\n!@#$%^&*()+=|~`}{[]\"';:?/>.<,-";
 
 /* When completing on command names, we remove '-' from the list of
    word break characters, since we use it in command names.  If the
@@ -87,12 +90,6 @@ static char *gdb_completer_quote_characters = "'";
 \f
 /* Accessor for some completer data that may interest other files. */
 
-char *
-get_gdb_completer_word_break_characters (void)
-{
-  return gdb_completer_word_break_characters;
-}
-
 char *
 get_gdb_completer_quote_characters (void)
 {
@@ -102,7 +99,7 @@ get_gdb_completer_quote_characters (void)
 /* Line completion interface function for readline.  */
 
 char *
-readline_line_completion_function (char *text, int matches)
+readline_line_completion_function (const char *text, int matches)
 {
   return line_completion_function (text, matches, rl_line_buffer, rl_point);
 }
@@ -133,7 +130,7 @@ filename_completer (char *text, char *word)
   while (1)
     {
       char *p;
-      p = filename_completion_function (text, subsequent_name);
+      p = rl_filename_completion_function (text, subsequent_name);
       if (return_val_used >= return_val_alloced)
        {
          return_val_alloced *= 2;
@@ -248,7 +245,7 @@ location_completer (char *text, char *word)
          colon = p;
          symbol_start = p + 1;
        }
-      else if (strchr (gdb_completer_word_break_characters, *p))
+      else if (strchr (current_language->la_word_break_characters(), *p))
        symbol_start = p + 1;
     }
 
@@ -369,246 +366,150 @@ command_completer (char *text, char *word)
    "file ../gdb.stabs/we" "ird" (needs to not break word at slash)
  */
 
-/* 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
-   command's completer function, the stuff specific to symbol completion
-   is in make_symbol_completion_list.
+/* Generate completions all at once.  Returns a NULL-terminated array
+   of strings.  Both the array and each element are allocated with
+   xmalloc.  It can also return NULL if there are no completions.
 
    TEXT is the caller's idea of the "word" we are looking at.
 
-   MATCHES is the number of matches that have currently been collected from
-   calling this completion function.  When zero, then we need to initialize,
-   otherwise the initialization has already taken place and we can just
-   return the next potential completion string.
-
    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.
+   should pretend that the line ends at POINT.  */
 
-   Returns NULL if there are no more completions, else a pointer to a string
-   which is a possible completion, it is the caller's responsibility to
-   free the string.  */
-
-char *
-line_completion_function (char *text, int matches, char *line_buffer, int point)
+char **
+complete_line (const char *text, char *line_buffer, int point)
 {
-  static char **list = (char **) NULL; /* Cache of completions */
-  static int index;            /* Next cached completion */
-  char *output = NULL;
+  char **list = NULL;
   char *tmp_command, *p;
   /* Pointer within tmp_command which corresponds to text.  */
   char *word;
   struct cmd_list_element *c, *result_list;
 
-  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. */
+  /* Choose the default set of word break characters to break completions.
+     If we later find out that we are doing completions on command strings
+     (as opposed to strings supplied by the individual command completer
+     functions, which can be any string) then we will switch to the
+     special word break set for command strings, which leaves out the
+     '-' character used in some commands.  */
 
-      if (list)
-       {
-         /* Free the storage used by LIST, but not by the strings inside.
-            This is because rl_complete_internal () frees the strings. */
-         xfree (list);
-       }
-      list = 0;
-      index = 0;
-
-      /* Choose the default set of word break characters to break completions.
-         If we later find out that we are doing completions on command strings
-         (as opposed to strings supplied by the individual command completer
-         functions, which can be any string) then we will switch to the
-         special word break set for command strings, which leaves out the
-         '-' character used in some commands.  */
-
-      rl_completer_word_break_characters =
-       gdb_completer_word_break_characters;
+  rl_completer_word_break_characters =
+    current_language->la_word_break_characters();
 
       /* Decide whether to complete on a list of gdb commands or on symbols. */
-      tmp_command = (char *) alloca (point + 1);
-      p = tmp_command;
+  tmp_command = (char *) alloca (point + 1);
+  p = tmp_command;
 
-      strncpy (tmp_command, line_buffer, point);
-      tmp_command[point] = '\0';
-      /* Since text always contains some number of characters leading up
-         to point, we can find the equivalent position in tmp_command
-         by subtracting that many characters from the end of tmp_command.  */
-      word = tmp_command + point - strlen (text);
+  strncpy (tmp_command, line_buffer, point);
+  tmp_command[point] = '\0';
+  /* Since text always contains some number of characters leading up
+     to point, we can find the equivalent position in tmp_command
+     by subtracting that many characters from the end of tmp_command.  */
+  word = tmp_command + point - strlen (text);
 
-      if (point == 0)
-       {
-         /* An empty line we want to consider ambiguous; that is, it
-            could be any command.  */
-         c = (struct cmd_list_element *) -1;
-         result_list = 0;
-       }
-      else
-       {
-         c = lookup_cmd_1 (&p, cmdlist, &result_list, 1);
-       }
+  if (point == 0)
+    {
+      /* An empty line we want to consider ambiguous; that is, it
+        could be any command.  */
+      c = (struct cmd_list_element *) -1;
+      result_list = 0;
+    }
+  else
+    {
+      c = lookup_cmd_1 (&p, cmdlist, &result_list, 1);
+    }
 
-      /* Move p up to the next interesting thing.  */
-      while (*p == ' ' || *p == '\t')
-       {
-         p++;
-       }
+  /* Move p up to the next interesting thing.  */
+  while (*p == ' ' || *p == '\t')
+    {
+      p++;
+    }
 
-      if (!c)
+  if (!c)
+    {
+      /* It is an unrecognized command.  So there are no
+        possible completions.  */
+      list = NULL;
+    }
+  else if (c == (struct cmd_list_element *) -1)
+    {
+      char *q;
+
+      /* lookup_cmd_1 advances p up to the first ambiguous thing, but
+        doesn't advance over that thing itself.  Do so now.  */
+      q = p;
+      while (*q && (isalnum (*q) || *q == '-' || *q == '_'))
+       ++q;
+      if (q != tmp_command + point)
        {
-         /* It is an unrecognized command.  So there are no
-            possible completions.  */
+         /* There is something beyond the ambiguous
+            command, so there are no possible completions.  For
+            example, "info t " or "info t foo" does not complete
+            to anything, because "info t" can be "info target" or
+            "info terminal".  */
          list = NULL;
        }
-      else if (c == (struct cmd_list_element *) -1)
+      else
        {
-         char *q;
-
-         /* lookup_cmd_1 advances p up to the first ambiguous thing, but
-            doesn't advance over that thing itself.  Do so now.  */
-         q = p;
-         while (*q && (isalnum (*q) || *q == '-' || *q == '_'))
-           ++q;
-         if (q != tmp_command + point)
+         /* We're trying to complete on the command which was ambiguous.
+            This we can deal with.  */
+         if (result_list)
            {
-             /* There is something beyond the ambiguous
-                command, so there are no possible completions.  For
-                example, "info t " or "info t foo" does not complete
-                to anything, because "info t" can be "info target" or
-                "info terminal".  */
-             list = NULL;
+             list = complete_on_cmdlist (*result_list->prefixlist, p,
+                                         word);
            }
          else
            {
-             /* We're trying to complete on the command which was ambiguous.
-                This we can deal with.  */
-             if (result_list)
-               {
-                 list = complete_on_cmdlist (*result_list->prefixlist, p,
-                                             word);
-               }
-             else
-               {
-                 list = complete_on_cmdlist (cmdlist, p, word);
-               }
-             /* Insure that readline does the right thing with respect to
-                inserting quotes.  */
-             rl_completer_word_break_characters =
-               gdb_completer_command_word_break_characters;
+             list = complete_on_cmdlist (cmdlist, p, word);
            }
+         /* Insure that readline does the right thing with respect to
+            inserting quotes.  */
+         rl_completer_word_break_characters =
+           gdb_completer_command_word_break_characters;
        }
-      else
+    }
+  else
+    {
+      /* We've recognized a full command.  */
+
+      if (p == tmp_command + point)
        {
-         /* We've recognized a full command.  */
+         /* There is no non-whitespace in the line beyond the command.  */
 
-         if (p == tmp_command + point)
+         if (p[-1] == ' ' || p[-1] == '\t')
            {
-             /* There is no non-whitespace in the line beyond the command.  */
-
-             if (p[-1] == ' ' || p[-1] == '\t')
-               {
-                 /* The command is followed by whitespace; we need to complete
-                    on whatever comes after command.  */
-                 if (c->prefixlist)
-                   {
-                     /* It is a prefix command; what comes after it is
-                        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.  */
-                     rl_completer_word_break_characters =
-                       gdb_completer_command_word_break_characters;
-                   }
-                 else if (c->enums)
-                   {
-                     list = complete_on_enum (c->enums, p, word);
-                     rl_completer_word_break_characters =
-                       gdb_completer_command_word_break_characters;
-                   }
-                 else
-                   {
-                     /* It is a normal command; what comes after it is
-                        completed by the command's completer function.  */
-                     if (c->completer == filename_completer)
-                       {
-                         /* Many commands which want to complete on
-                            file names accept several file names, as
-                            in "run foo bar >>baz".  So we don't want
-                            to complete the entire text after the
-                            command, just the last word.  To this
-                            end, we need to find the beginning of the
-                            file name by starting at `word' and going
-                            backwards.  */
-                         for (p = word;
-                              p > tmp_command
-                                && strchr (gdb_completer_file_name_break_characters, p[-1]) == NULL;
-                              p--)
-                           ;
-                         rl_completer_word_break_characters =
-                           gdb_completer_file_name_break_characters;
-                       }
-                     else if (c->completer == location_completer)
-                       {
-                         /* Commands which complete on locations want to
-                            see the entire argument.  */
-                         for (p = word;
-                              p > tmp_command
-                                && p[-1] != ' ' && p[-1] != '\t';
-                              p--)
-                           ;
-                       }
-                     list = (*c->completer) (p, word);
-                   }
-               }
-             else
+             /* The command is followed by whitespace; we need to complete
+                on whatever comes after command.  */
+             if (c->prefixlist)
                {
-                 /* The command is not followed by whitespace; we need to
-                    complete on the command itself.  e.g. "p" which is a
-                    command itself but also can complete to "print", "ptype"
-                    etc.  */
-                 char *q;
-
-                 /* Find the command we are completing on.  */
-                 q = p;
-                 while (q > tmp_command)
-                   {
-                     if (isalnum (q[-1]) || q[-1] == '-' || q[-1] == '_')
-                       --q;
-                     else
-                       break;
-                   }
-
-                 list = complete_on_cmdlist (result_list, q, word);
+                 /* It is a prefix command; what comes after it is
+                    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.  */
+                        with respect to inserting quotes.  */
                  rl_completer_word_break_characters =
                    gdb_completer_command_word_break_characters;
                }
-           }
-         else
-           {
-             /* There is non-whitespace beyond the command.  */
-
-             if (c->prefixlist && !c->allow_unknown)
-               {
-                 /* It is an unrecognized subcommand of a prefix command,
-                    e.g. "info adsfkdj".  */
-                 list = NULL;
-               }
              else if (c->enums)
                {
                  list = complete_on_enum (c->enums, p, word);
+                 rl_completer_word_break_characters =
+                   gdb_completer_command_word_break_characters;
                }
              else
                {
-                 /* It is a normal command.  */
+                 /* It is a normal command; what comes after it is
+                    completed by the command's completer function.  */
                  if (c->completer == filename_completer)
                    {
-                     /* See the commentary above about the specifics
-                        of file-name completion.  */
+                     /* Many commands which want to complete on
+                        file names accept several file names, as
+                        in "run foo bar >>baz".  So we don't want
+                        to complete the entire text after the
+                        command, just the last word.  To this
+                        end, we need to find the beginning of the
+                        file name by starting at `word' and going
+                        backwards.  */
                      for (p = word;
                           p > tmp_command
                             && strchr (gdb_completer_file_name_break_characters, p[-1]) == NULL;
@@ -619,6 +520,8 @@ line_completion_function (char *text, int matches, char *line_buffer, int point)
                    }
                  else if (c->completer == location_completer)
                    {
+                     /* Commands which complete on locations want to
+                        see the entire argument.  */
                      for (p = word;
                           p > tmp_command
                             && p[-1] != ' ' && p[-1] != '\t';
@@ -628,7 +531,119 @@ line_completion_function (char *text, int matches, char *line_buffer, int point)
                  list = (*c->completer) (p, word);
                }
            }
+         else
+           {
+             /* The command is not followed by whitespace; we need to
+                complete on the command itself.  e.g. "p" which is a
+                command itself but also can complete to "print", "ptype"
+                etc.  */
+             char *q;
+
+             /* Find the command we are completing on.  */
+             q = p;
+             while (q > tmp_command)
+               {
+                 if (isalnum (q[-1]) || q[-1] == '-' || q[-1] == '_')
+                   --q;
+                 else
+                   break;
+               }
+
+             list = complete_on_cmdlist (result_list, q, word);
+
+                 /* Insure that readline does the right thing
+                    with respect to inserting quotes.  */
+             rl_completer_word_break_characters =
+               gdb_completer_command_word_break_characters;
+           }
+       }
+      else
+       {
+         /* There is non-whitespace beyond the command.  */
+
+         if (c->prefixlist && !c->allow_unknown)
+           {
+             /* It is an unrecognized subcommand of a prefix command,
+                e.g. "info adsfkdj".  */
+             list = NULL;
+           }
+         else if (c->enums)
+           {
+             list = complete_on_enum (c->enums, p, word);
+           }
+         else
+           {
+             /* It is a normal command.  */
+             if (c->completer == filename_completer)
+               {
+                 /* See the commentary above about the specifics
+                    of file-name completion.  */
+                 for (p = word;
+                      p > tmp_command
+                        && strchr (gdb_completer_file_name_break_characters, p[-1]) == NULL;
+                      p--)
+                   ;
+                 rl_completer_word_break_characters =
+                   gdb_completer_file_name_break_characters;
+               }
+             else if (c->completer == location_completer)
+               {
+                 for (p = word;
+                      p > tmp_command
+                        && p[-1] != ' ' && p[-1] != '\t';
+                      p--)
+                   ;
+               }
+             list = (*c->completer) (p, word);
+           }
+       }
+    }
+
+  return list;
+}
+
+/* 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
+   command's completer function, the stuff specific to symbol completion
+   is in make_symbol_completion_list.
+
+   TEXT is the caller's idea of the "word" we are looking at.
+
+   MATCHES is the number of matches that have currently been collected from
+   calling this completion function.  When zero, then we need to initialize,
+   otherwise the initialization has already taken place and we can just
+   return the next potential completion string.
+
+   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.
+
+   Returns NULL if there are no more completions, else a pointer to a string
+   which is a possible completion, it is the caller's responsibility to
+   free the string.  */
+
+static char *
+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 */
+  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. */
+
+      if (list)
+       {
+         /* Free the storage used by LIST, but not by the strings inside.
+            This is because rl_complete_internal () frees the strings. */
+         xfree (list);
        }
+      index = 0;
+      list = complete_line (text, line_buffer, point);
     }
 
   /* If we found a list of potential completions during initialization then
@@ -653,21 +668,30 @@ line_completion_function (char *text, int matches, char *line_buffer, int point)
     /* Make sure the word break characters are set back to normal for the
        next time that readline tries to complete something.  */
     rl_completer_word_break_characters =
-      gdb_completer_word_break_characters;
+      current_language->la_word_break_characters();
 #endif
 
   return (output);
 }
-/* Skip over a possibly quoted word (as defined by the quote characters
-   and word break characters the completer uses).  Returns pointer to the
-   location after the "word". */
+
+/* Skip over the possibly quoted word STR (as defined by the quote
+   characters QUOTECHARS and the the word break characters
+   BREAKCHARS).  Returns pointer to the location after the "word".  If
+   either QUOTECHARS or BREAKCHARS is NULL, use the same values used
+   by the completer.  */
 
 char *
-skip_quoted (char *str)
+skip_quoted_chars (char *str, char *quotechars, char *breakchars)
 {
   char quote_char = '\0';
   char *scan;
 
+  if (quotechars == NULL)
+    quotechars = gdb_completer_quote_characters;
+
+  if (breakchars == NULL)
+    breakchars = current_language->la_word_break_characters();
+
   for (scan = str; *scan != '\0'; scan++)
     {
       if (quote_char != '\0')
@@ -680,16 +704,26 @@ skip_quoted (char *str)
              break;
            }
        }
-      else if (strchr (gdb_completer_quote_characters, *scan))
+      else if (strchr (quotechars, *scan))
        {
          /* Found start of a quoted string. */
          quote_char = *scan;
        }
-      else if (strchr (gdb_completer_word_break_characters, *scan))
+      else if (strchr (breakchars, *scan))
        {
          break;
        }
     }
+
   return (scan);
 }
 
+/* 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". */
+
+char *
+skip_quoted (char *str)
+{
+  return skip_quoted_chars (str, NULL, NULL);
+}
This page took 0.030836 seconds and 4 git commands to generate.