* gdbint.texinfo (Host Definition): Remove description of
[deliverable/binutils-gdb.git] / gdb / completer.c
index bd23ca807dec7caf183a4b59695142bf08c2e3c5..f63fe02f99329d272c573019b75b0cbcf42538b7 100644 (file)
@@ -1,5 +1,5 @@
 /* Line completion stuff for GDB, the GNU debugger.
-   Copyright 2000 Free Software Foundation, Inc.
+   Copyright 2000, 2001 Free Software Foundation, Inc.
 
    This file is part of GDB.
 
 #include "symtab.h"
 #include "gdbtypes.h"
 #include "expression.h"
+#include "filenames.h"         /* for DOSish file names */
 
 /* 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() */
+/* Needed for rl_completer_word_break_characters() and for
+   filename_completion_function.  */
 #include <readline/readline.h>
 
 /* readline defines this.  */
@@ -36,6 +38,8 @@
 #include "completer.h"
 
 /* Prototypes for local functions */
+char *line_completion_function (char *text, int matches, char *line_buffer,
+                               int point);
 
 /* readline uses the word breaks for two things:
    (1) In figuring out where to point the TEXT parameter to the
@@ -64,7 +68,17 @@ static char *gdb_completer_command_word_break_characters =
    break characters any characters that are commonly used in file
    names, such as '-', '+', '~', etc.  Otherwise, readline displays
    incorrect completion candidates.  */
-static char *gdb_completer_file_name_break_characters = " \t\n*|\"';:?/><";
+#ifdef HAVE_DOS_BASED_FILE_SYSTEM
+/* MS-DOS and MS-Windows use colon as part of the drive spec, and most
+   programs support @foo style response files.  */
+static char *gdb_completer_file_name_break_characters = " \t\n*|\"';?><@";
+#else
+static char *gdb_completer_file_name_break_characters = " \t\n*|\"';:?><";
+#endif
+
+/* These are used when completing on locations, which can mix file
+   names and symbol names separated by a colon.  */
+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
@@ -85,12 +99,26 @@ get_gdb_completer_quote_characters (void)
   return gdb_completer_quote_characters;
 }
 
+/* Line completion interface function for readline.  */
+
+char *
+readline_line_completion_function (char *text, int matches)
+{
+  return line_completion_function (text, matches, rl_line_buffer, rl_point);
+}
+
+/* This can be used for functions which don't want to complete on symbols
+   but don't want to complete on anything else either.  */
+char **
+noop_completer (char *text, char *prefix)
+{
+  return NULL;
+}
+
 /* Complete on filenames.  */
 char **
 filename_completer (char *text, char *word)
 {
-  /* From readline.  */
-extern char *filename_completion_function (char *, int);
   int subsequent_name;
   char **return_val;
   int return_val_used;
@@ -139,7 +167,7 @@ extern char *filename_completion_function (char *, int);
            q = xmalloc (strlen (p) + 5);
            strcpy (q, p + (word - text));
            return_val[return_val_used++] = q;
-           free (p);
+           xfree (p);
          }
        else
          {
@@ -149,7 +177,7 @@ extern char *filename_completion_function (char *, int);
            q[text - word] = '\0';
            strcat (q, p);
            return_val[return_val_used++] = q;
-           free (p);
+           xfree (p);
          }
       }
     }
@@ -164,6 +192,153 @@ extern char *filename_completion_function (char *, int);
   return return_val;
 }
 
+/* Complete on locations, which might be of two possible forms:
+
+       file:line
+   or
+       symbol+offset
+
+   This is intended to be used in commands that set breakpoints etc.  */
+char **
+location_completer (char *text, char *word)
+{
+  int n_syms = 0, n_files = 0;
+  char ** fn_list = NULL;
+  char ** list = NULL;
+  char *p;
+  int quote_found = 0;
+  int quoted = *text == '\'' || *text == '"';
+  int quote_char = '\0';
+  char *colon = NULL;
+  char *file_to_match = NULL;
+  char *symbol_start = text;
+  char *orig_text = text;
+  size_t text_len;
+
+  /* Do we have an unquoted colon, as in "break foo.c::bar"?  */
+  for (p = text; *p != '\0'; ++p)
+    {
+      if (*p == '\\' && p[1] == '\'')
+       p++;
+      else if (*p == '\'' || *p == '"')
+       {
+         quote_found = *p;
+         quote_char = *p++;
+         while (*p != '\0' && *p != quote_found)
+           {
+             if (*p == '\\' && p[1] == quote_found)
+               p++;
+             p++;
+           }
+
+         if (*p == quote_found)
+           quote_found = 0;
+         else
+           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
+        TEXT, and the colon after the drive letter is the only colon
+        we found, pretend the colon is not there.  */
+      else if (p < text + 3 && *p == ':' && p == text + 1 + quoted)
+       ;
+#endif
+      else if (*p == ':' && !colon)
+       {
+         colon = p;
+         symbol_start = p + 1;
+       }
+      else if (strchr (gdb_completer_word_break_characters, *p))
+       symbol_start = p + 1;
+    }
+
+  if (quoted)
+    text++;
+  text_len = strlen (text);
+
+  /* Where is the file name?  */
+  if (colon)
+    {
+      char *s;
+
+      file_to_match = (char *) xmalloc (colon - text + 1);
+      strncpy (file_to_match, text, colon - text + 1);
+      /* Remove trailing colons and quotes from the file name.  */
+      for (s = file_to_match + (colon - text);
+          s > file_to_match;
+          s--)
+       if (*s == ':' || *s == quote_char)
+         *s = '\0';
+    }
+  /* If the text includes a colon, they want completion only on a
+     symbol name after the colon.  Otherwise, we need to complete on
+     symbols as well as on files.  */
+  if (colon)
+    {
+      list = make_file_symbol_completion_list (symbol_start, word,
+                                              file_to_match);
+      xfree (file_to_match);
+    }
+  else
+    {
+      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)
+       fn_list = make_source_files_completion_list (text, text);
+    }
+
+  /* How many completions do we have in both lists?  */
+  if (fn_list)
+    for ( ; fn_list[n_files]; n_files++)
+      ;
+  if (list)
+    for ( ; list[n_syms]; n_syms++)
+      ;
+
+  /* Make list[] large enough to hold both lists, then catenate
+     fn_list[] onto the end of list[].  */
+  if (n_syms && n_files)
+    {
+      list = xrealloc (list, (n_syms + n_files + 1) * sizeof (char *));
+      memcpy (list + n_syms, fn_list, (n_files + 1) * sizeof (char *));
+      xfree (fn_list);
+    }
+  else if (n_files)
+    {
+      /* If we only have file names as possible completion, we should
+        bring them in sync with what rl_complete expects.  The
+        problem is that if the user types "break /foo/b TAB", and the
+        possible completions are "/foo/bar" and "/foo/baz"
+        rl_complete expects us to return "bar" and "baz", without the
+        leading directories, as possible completions, because `word'
+        starts at the "b".  But we ignore the value of `word' when we
+        call make_source_files_completion_list above (because that
+        would not DTRT when the completion results in both symbols
+        and file names), so make_source_files_completion_list returns
+        the full "/foo/bar" and "/foo/baz" strings.  This produces
+        wrong results when, e.g., there's only one possible
+        completion, because rl_complete will prepend "/foo/" to each
+        candidate completion.  The loop below removes that leading
+        part.  */
+      for (n_files = 0; fn_list[n_files]; n_files++)
+       {
+         memmove (fn_list[n_files], fn_list[n_files] + (word - text),
+                  strlen (fn_list[n_files]) + 1 - (word - text));
+       }
+      /* Return just the file-name list as the result.  */
+      list = fn_list;
+    }
+  else if (!n_syms)
+    {
+      /* 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);
+    }
+
+  return list;
+}
+
 /* 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.
 
@@ -228,7 +403,7 @@ line_completion_function (char *text, int matches, char *line_buffer, int point)
        {
          /* Free the storage used by LIST, but not by the strings inside.
             This is because rl_complete_internal () frees the strings. */
-         free ((PTR) list);
+         xfree (list);
        }
       list = 0;
       index = 0;
@@ -348,10 +523,35 @@ line_completion_function (char *text, int matches, char *line_buffer, int point)
                    {
                      /* It is a normal command; what comes after it is
                         completed by the command's completer function.  */
-                     list = (*c->completer) (p, word);
                      if (c->completer == filename_completer)
-                       rl_completer_word_break_characters =
-                         gdb_completer_file_name_break_characters;
+                       {
+                         /* 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
@@ -397,10 +597,27 @@ line_completion_function (char *text, int matches, char *line_buffer, int point)
              else
                {
                  /* It is a normal command.  */
-                 list = (*c->completer) (p, word);
                  if (c->completer == filename_completer)
-                   rl_completer_word_break_characters =
-                     gdb_completer_file_name_break_characters;
+                   {
+                     /* 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);
                }
            }
        }
This page took 0.026458 seconds and 4 git commands to generate.