Subversion Repositories or1k

/* GDB CLI commands.

   Copyright 2000, 2001 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

   (at your option) any later version.

   This program is distributed in the hope that it will be useful,

   but WITHOUT ANY WARRANTY; without even the implied warranty of

   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

   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.  */

#include "defs.h"

#include "completer.h"

#include "target.h"      /* For baud_rate, remote_debug and remote_timeout */

#include "gdb_wait.h"           /* For shell escape implementation */

#include "gnu-regex.h"          /* Used by apropos_command */

#include "filenames.h"          /* for DOSish file names */

#ifdef UI_OUT

#include "ui-out.h"

#endif

#include "top.h"

#include "cli/cli-decode.h"

#include "cli/cli-script.h"

#include "cli/cli-setshow.h"

#include "cli/cli-cmds.h"

#ifndef GDBINIT_FILENAME

#define GDBINIT_FILENAME        ".gdbinit"

#endif

/* FIXME: this should be auto-configured!  */

#ifdef __MSDOS__

# define CANT_FORK

#endif

/* From gdb/top.c */

extern void dont_repeat (void);

extern void set_verbose (char *, int, struct cmd_list_element *);

extern void show_history (char *, int);

extern void set_history (char *, int);

extern void show_commands (char *, int);

/* Prototypes for local functions */

static void complete_command (char *, int);

static void echo_command (char *, int);

static void pwd_command (char *, int);

static void show_version (char *, int);

static void validate_comname (char *);

static void help_command (char *, int);

static void show_command (char *, int);

static void info_command (char *, int);

static void show_debug (char *, int);

static void set_debug (char *, int);

static void show_user (char *, int);

static void make_command (char *, int);

static void shell_escape (char *, int);

void apropos_command (char *, int);

/* Define all cmd_list_elements.  */

/* Chain containing all defined commands.  */

struct cmd_list_element *cmdlist;

/* Chain containing all defined info subcommands.  */

struct cmd_list_element *infolist;

/* Chain containing all defined enable subcommands. */

struct cmd_list_element *enablelist;

/* Chain containing all defined disable subcommands. */

struct cmd_list_element *disablelist;

/* Chain containing all defined toggle subcommands. */

struct cmd_list_element *togglelist;

/* Chain containing all defined stop subcommands. */

struct cmd_list_element *stoplist;

/* Chain containing all defined delete subcommands. */

struct cmd_list_element *deletelist;

/* Chain containing all defined "enable breakpoint" subcommands. */

struct cmd_list_element *enablebreaklist;

/* Chain containing all defined set subcommands */

struct cmd_list_element *setlist;

/* Chain containing all defined unset subcommands */

struct cmd_list_element *unsetlist;

/* Chain containing all defined show subcommands.  */

struct cmd_list_element *showlist;

/* Chain containing all defined \"set history\".  */

struct cmd_list_element *sethistlist;

/* Chain containing all defined \"show history\".  */

struct cmd_list_element *showhistlist;

/* Chain containing all defined \"unset history\".  */

struct cmd_list_element *unsethistlist;

/* Chain containing all defined maintenance subcommands. */

struct cmd_list_element *maintenancelist;

/* Chain containing all defined "maintenance info" subcommands. */

struct cmd_list_element *maintenanceinfolist;

/* Chain containing all defined "maintenance print" subcommands. */

struct cmd_list_element *maintenanceprintlist;

struct cmd_list_element *setprintlist;

struct cmd_list_element *showprintlist;

struct cmd_list_element *setdebuglist;

struct cmd_list_element *showdebuglist;

struct cmd_list_element *setchecklist;

struct cmd_list_element *showchecklist;

/* Utility used everywhere when at least one argument is needed and

   none is supplied. */

void

error_no_arg (char *why)

{

  error ("Argument required (%s).", why);

}

/* The "info" command is defined as a prefix, with allow_unknown = 0.

   Therefore, its own definition is called only for "info" with no args.  */

/* ARGSUSED */

static void

info_command (char *arg, int from_tty)

{

  printf_unfiltered ("\"info\" must be followed by the name of an info command.\n");

  help_list (infolist, "info ", -1, gdb_stdout);

}

/* The "show" command with no arguments shows all the settings.  */

/* ARGSUSED */

static void

show_command (char *arg, int from_tty)

{

  cmd_show_list (showlist, from_tty, "");

}

/* Provide documentation on command or list given by COMMAND.  FROM_TTY

   is ignored.  */

/* ARGSUSED */

static void

help_command (char *command, int from_tty)

{

  help_cmd (command, gdb_stdout);

}

/* The "complete" command is used by Emacs to implement completion.  */

/* ARGSUSED */

static void

complete_command (char *arg, int from_tty)

{

  int i;

  int argpoint;

  char *completion;

  dont_repeat ();

  if (arg == NULL)

    arg = "";

  argpoint = strlen (arg);

  for (completion = line_completion_function (arg, i = 0, arg, argpoint);

       completion;

       completion = line_completion_function (arg, ++i, arg, argpoint))

    {

      printf_unfiltered ("%s\n", completion);

      xfree (completion);

    }

}

int is_complete_command (void (*func) (char *args, int from_tty))

{

  return func == complete_command;

}

/* ARGSUSED */

static void

show_version (char *args, int from_tty)

{

  immediate_quit++;

  print_gdb_version (gdb_stdout);

  printf_filtered ("\n");

  immediate_quit--;

}

/* Handle the quit command.  */

void

quit_command (char *args, int from_tty)

{

  if (!quit_confirm ())

    error ("Not confirmed.");

  quit_force (args, from_tty);

}

/* ARGSUSED */

static void

pwd_command (char *args, int from_tty)

{

  if (args)

    error ("The \"pwd\" command does not take an argument: %s", args);

  getcwd (gdb_dirbuf, sizeof (gdb_dirbuf));

  if (!STREQ (gdb_dirbuf, current_directory))

    printf_unfiltered ("Working directory %s\n (canonically %s).\n",

                       current_directory, gdb_dirbuf);

  else

    printf_unfiltered ("Working directory %s.\n", current_directory);

}

void

cd_command (char *dir, int from_tty)

{

  int len;

  /* Found something other than leading repetitions of "/..".  */

  int found_real_path;

  char *p;

  /* If the new directory is absolute, repeat is a no-op; if relative,

     repeat might be useful but is more likely to be a mistake.  */

  dont_repeat ();

  if (dir == 0)

    error_no_arg ("new working directory");

  dir = tilde_expand (dir);

  make_cleanup (xfree, dir);

  if (chdir (dir) < 0)

    perror_with_name (dir);

#ifdef HAVE_DOS_BASED_FILE_SYSTEM

  /* There's too much mess with DOSish names like "d:", "d:.",

     "d:./foo" etc.  Instead of having lots of special #ifdef'ed code,

     simply get the canonicalized name of the current directory.  */

  dir = getcwd (gdb_dirbuf, sizeof (gdb_dirbuf));

#endif

  len = strlen (dir);

  if (IS_DIR_SEPARATOR (dir[len - 1]))

    {

      /* Remove the trailing slash unless this is a root directory

         (including a drive letter on non-Unix systems).  */

      if (!(len == 1)           /* "/" */

#ifdef HAVE_DOS_BASED_FILE_SYSTEM

          && !(len == 3 && dir[1] == ':') /* "d:/" */

#endif

          )

        len--;

    }

  dir = savestring (dir, len);

  if (IS_ABSOLUTE_PATH (dir))

    current_directory = dir;

  else

    {

      if (IS_DIR_SEPARATOR (current_directory[strlen (current_directory) - 1]))

        current_directory = concat (current_directory, dir, NULL);

      else

        current_directory = concat (current_directory, SLASH_STRING, dir, NULL);

      xfree (dir);

    }

  /* Now simplify any occurrences of `.' and `..' in the pathname.  */

  found_real_path = 0;

  for (p = current_directory; *p;)

    {

      if (IS_DIR_SEPARATOR (p[0]) && p[1] == '.'

          && (p[2] == 0 || IS_DIR_SEPARATOR (p[2])))

        strcpy (p, p + 2);

      else if (IS_DIR_SEPARATOR (p[0]) && p[1] == '.' && p[2] == '.'

               && (p[3] == 0 || IS_DIR_SEPARATOR (p[3])))

        {

          if (found_real_path)

            {

              /* Search backwards for the directory just before the "/.."

                 and obliterate it and the "/..".  */

              char *q = p;

              while (q != current_directory && !IS_DIR_SEPARATOR (q[-1]))

                --q;

              if (q == current_directory)

                /* current_directory is

                   a relative pathname ("can't happen"--leave it alone).  */

                ++p;

              else

                {

                  strcpy (q - 1, p + 3);

                  p = q - 1;

                }

            }

          else

            /* We are dealing with leading repetitions of "/..", for example

               "/../..", which is the Mach super-root.  */

            p += 3;

        }

      else

        {

          found_real_path = 1;

          ++p;

        }

    }

  forget_cached_source_info ();

  if (from_tty)

    pwd_command ((char *) 0, 1);

}

void

source_command (char *args, int from_tty)

{

  FILE *stream;

  struct cleanup *old_cleanups;

  char *file = args;

  if (file == NULL)

    {

      error ("source command requires pathname of file to source.");

    }

  file = tilde_expand (file);

  old_cleanups = make_cleanup (xfree, file);

  stream = fopen (file, FOPEN_RT);

  if (!stream)

    {

      if (from_tty)

        perror_with_name (file);

      else

        return;

    }

  script_from_file (stream, file);

  do_cleanups (old_cleanups);

}

/* ARGSUSED */

static void

echo_command (char *text, int from_tty)

{

  char *p = text;

  register int c;

  if (text)

    while ((c = *p++) != '\0')

      {

        if (c == '\\')

          {

            /* \ at end of argument is used after spaces

               so they won't be lost.  */

            if (*p == 0)

              return;

            c = parse_escape (&p);

            if (c >= 0)

              printf_filtered ("%c", c);

          }

        else

          printf_filtered ("%c", c);

      }

  /* Force this output to appear now.  */

  wrap_here ("");

  gdb_flush (gdb_stdout);

}

/* ARGSUSED */

static void

shell_escape (char *arg, int from_tty)

{

#ifdef CANT_FORK

  /* If ARG is NULL, they want an inferior shell, but `system' just

     reports if the shell is available when passed a NULL arg.  */

  int rc = system (arg ? arg : "");

  if (!arg)

    arg = "inferior shell";

  if (rc == -1)

    {

      fprintf_unfiltered (gdb_stderr, "Cannot execute %s: %s\n", arg,

                          safe_strerror (errno));

      gdb_flush (gdb_stderr);

    }

  else if (rc)

    {

      fprintf_unfiltered (gdb_stderr, "%s exited with status %d\n", arg, rc);

      gdb_flush (gdb_stderr);

    }

#ifdef __DJGPP__

  /* Make sure to return to the directory GDB thinks it is, in case the

     shell command we just ran changed it.  */

  chdir (current_directory);

#endif

#else /* Can fork.  */

  int rc, status, pid;

  char *p, *user_shell;

  if ((user_shell = (char *) getenv ("SHELL")) == NULL)

    user_shell = "/bin/sh";

  /* Get the name of the shell for arg0 */

  if ((p = strrchr (user_shell, '/')) == NULL)

    p = user_shell;

  else

    p++;                        /* Get past '/' */

  if ((pid = fork ()) == 0)

    {

      if (!arg)

        execl (user_shell, p, 0);

      else

        execl (user_shell, p, "-c", arg, 0);

      fprintf_unfiltered (gdb_stderr, "Cannot execute %s: %s\n", user_shell,

                          safe_strerror (errno));

      gdb_flush (gdb_stderr);

      _exit (0177);

    }

  if (pid != -1)

    while ((rc = wait (&status)) != pid && rc != -1)

      ;

  else

    error ("Fork failed");

#endif /* Can fork.  */

}

static void

make_command (char *arg, int from_tty)

{

  char *p;

  if (arg == 0)

    p = "make";

  else

    {

      p = xmalloc (sizeof ("make ") + strlen (arg));

      strcpy (p, "make ");

      strcpy (p + sizeof ("make ") - 1, arg);

    }

  shell_escape (p, from_tty);

}

/* ARGSUSED */

static void

show_user (char *args, int from_tty)

{

  struct cmd_list_element *c;

  extern struct cmd_list_element *cmdlist;

  if (args)

    {

      c = lookup_cmd (&args, cmdlist, "", 0, 1);

      if (c->class != class_user)

        error ("Not a user command.");

      show_user_1 (c, gdb_stdout);

    }

  else

    {

      for (c = cmdlist; c; c = c->next)

        {

          if (c->class == class_user)

            show_user_1 (c, gdb_stdout);

        }

    }

}

/* Search through names of commands and documentations for a certain

   regular expression.

*/

void

apropos_command (char *searchstr, int from_tty)

{

  extern struct cmd_list_element *cmdlist; /*This is the main command list*/

  regex_t pattern;

  char *pattern_fastmap;

  char errorbuffer[512];

  pattern_fastmap = xcalloc (256, sizeof (char));

  if (searchstr == NULL)

      error("REGEXP string is empty");

  if (regcomp(&pattern,searchstr,REG_ICASE) == 0)

    {

      pattern.fastmap=pattern_fastmap;

      re_compile_fastmap(&pattern);

      apropos_cmd (gdb_stdout,cmdlist,&pattern,"");

    }

  else

    {

      regerror(regcomp(&pattern,searchstr,REG_ICASE),NULL,errorbuffer,512);

      error("Error in regular expression:%s",errorbuffer);

    }

  xfree (pattern_fastmap);

}

static void

set_debug (char *arg, int from_tty)

{

  printf_unfiltered ("\"set debug\" must be followed by the name of a print subcommand.\n");

  help_list (setdebuglist, "set debug ", -1, gdb_stdout);

}

static void

show_debug (char *args, int from_tty)

{

  cmd_show_list (showdebuglist, from_tty, "");

}

void

init_cmd_lists (void)

{

  cmdlist = NULL;

  infolist = NULL;

  enablelist = NULL;

  disablelist = NULL;

  togglelist = NULL;

  stoplist = NULL;

  deletelist = NULL;

  enablebreaklist = NULL;

  setlist = NULL;

  unsetlist = NULL;

  showlist = NULL;

  sethistlist = NULL;

  showhistlist = NULL;

  unsethistlist = NULL;

  maintenancelist = NULL;

  maintenanceinfolist = NULL;

  maintenanceprintlist = NULL;

  setprintlist = NULL;

  showprintlist = NULL;

  setchecklist = NULL;

  showchecklist = NULL;

}

void

init_cli_cmds (void)

{

  struct cmd_list_element *c;

  /* Define the classes of commands.

     They will appear in the help list in the reverse of this order.  */

  add_cmd ("internals", class_maintenance, NO_FUNCTION,

           "Maintenance commands.\n\

Some gdb commands are provided just for use by gdb maintainers.\n\

These commands are subject to frequent change, and may not be as\n\

well documented as user commands.",

           &cmdlist);

  add_cmd ("obscure", class_obscure, NO_FUNCTION, "Obscure features.", &cmdlist);

  add_cmd ("aliases", class_alias, NO_FUNCTION, "Aliases of other commands.", &cmdlist);

  add_cmd ("user-defined", class_user, NO_FUNCTION, "User-defined commands.\n\

The commands in this class are those defined by the user.\n\

Use the \"define\" command to define a command.", &cmdlist);

  add_cmd ("support", class_support, NO_FUNCTION, "Support facilities.", &cmdlist);

  if (!dbx_commands)

    add_cmd ("status", class_info, NO_FUNCTION, "Status inquiries.", &cmdlist);

  add_cmd ("files", class_files, NO_FUNCTION, "Specifying and examining files.", &cmdlist);

  add_cmd ("breakpoints", class_breakpoint, NO_FUNCTION, "Making program stop at certain points.", &cmdlist);

  add_cmd ("data", class_vars, NO_FUNCTION, "Examining data.", &cmdlist);

  add_cmd ("stack", class_stack, NO_FUNCTION, "Examining the stack.\n\

The stack is made up of stack frames.  Gdb assigns numbers to stack frames\n\

counting from zero for the innermost (currently executing) frame.\n\n\

At any time gdb identifies one frame as the \"selected\" frame.\n\

Variable lookups are done with respect to the selected frame.\n\

When the program being debugged stops, gdb selects the innermost frame.\n\

The commands below can be used to select other frames by number or address.",

           &cmdlist);

  add_cmd ("running", class_run, NO_FUNCTION, "Running the program.", &cmdlist);

  /* Define general commands. */

  add_com ("pwd", class_files, pwd_command,

        "Print working directory.  This is used for your program as well.");

  c = add_cmd ("cd", class_files, cd_command,

               "Set working directory to DIR for debugger and program being debugged.\n\

The change does not take effect for the program being debugged\n\

until the next time it is started.", &cmdlist);

  c->completer = filename_completer;

  add_com ("echo", class_support, echo_command,

           "Print a constant string.  Give string as argument.\n\

C escape sequences may be used in the argument.\n\

No newline is added at the end of the argument;\n\

use \"\\n\" if you want a newline to be printed.\n\

Since leading and trailing whitespace are ignored in command arguments,\n\

if you want to print some you must use \"\\\" before leading whitespace\n\

to be printed or after trailing whitespace.");

  add_com ("document", class_support, document_command,

           "Document a user-defined command.\n\

Give command name as argument.  Give documentation on following lines.\n\

End with a line of just \"end\".");

  add_com ("define", class_support, define_command,

           "Define a new command name.  Command name is argument.\n\

Definition appears on following lines, one command per line.\n\

End with a line of just \"end\".\n\

Use the \"document\" command to give documentation for the new command.\n\

Commands defined in this way may have up to ten arguments.");

  c = add_cmd ("source", class_support, source_command,

               "Read commands from a file named FILE.\n\

Note that the file \"" GDBINIT_FILENAME "\" is read automatically in this way\n\

when gdb is started.", &cmdlist);

  c->completer = filename_completer;

  add_com ("quit", class_support, quit_command, "Exit gdb.");

  add_com ("help", class_support, help_command, "Print list of commands.");

  add_com_alias ("q", "quit", class_support, 1);

  add_com_alias ("h", "help", class_support, 1);

  c = add_set_cmd ("verbose", class_support, var_boolean, (char *) &info_verbose,

                   "Set ",

                   &setlist),

    add_show_from_set (c, &showlist);