Subversion Repositories or1k

/* Parser for linespec for the GNU debugger, GDB.

   Copyright 1986, 1987, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995,

   1996, 1997, 1998, 1999, 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 "symtab.h"

#include "frame.h"

#include "command.h"

#include "symfile.h"

#include "objfiles.h"

#include "demangle.h"

#include "value.h"

#include "completer.h"

#include "cp-abi.h"

/* Prototype for one function in parser-defs.h,

   instead of including that entire file. */

extern char *find_template_name_end (char *);

/* We share this one with symtab.c, but it is not exported widely. */

extern char *operator_chars (char *, char **);

/* Prototypes for local functions */

static void cplusplus_error (const char *name, const char *fmt, ...) ATTR_FORMAT (printf, 2, 3);

static int total_number_of_methods (struct type *type);

static int find_methods (struct type *, char *, struct symbol **);

static void build_canonical_line_spec (struct symtab_and_line *,

                                       char *, char ***);

static char *find_toplevel_char (char *s, char c);

static struct symtabs_and_lines decode_line_2 (struct symbol *[],

                                               int, int, char ***);

/* Helper functions. */

/* Issue a helpful hint on using the command completion feature on

   single quoted demangled C++ symbols as part of the completion

   error.  */

static void

cplusplus_error (const char *name, const char *fmt, ...)

{

  struct ui_file *tmp_stream;

  tmp_stream = mem_fileopen ();

  make_cleanup_ui_file_delete (tmp_stream);

  {

    va_list args;

    va_start (args, fmt);

    vfprintf_unfiltered (tmp_stream, fmt, args);

    va_end (args);

  }

  while (*name == '\'')

    name++;

  fprintf_unfiltered (tmp_stream,

                      ("Hint: try '%s<TAB> or '%s<ESC-?>\n"

                       "(Note leading single quote.)"),

                      name, name);

  error_stream (tmp_stream);

}

/* Return the number of methods described for TYPE, including the

   methods from types it derives from. This can't be done in the symbol

   reader because the type of the baseclass might still be stubbed

   when the definition of the derived class is parsed.  */

static int

total_number_of_methods (struct type *type)

{

  int n;

  int count;

  CHECK_TYPEDEF (type);

  if (TYPE_CPLUS_SPECIFIC (type) == NULL)

    return 0;

  count = TYPE_NFN_FIELDS_TOTAL (type);

  for (n = 0; n < TYPE_N_BASECLASSES (type); n++)

    count += total_number_of_methods (TYPE_BASECLASS (type, n));

  return count;

}

/* Recursive helper function for decode_line_1.

   Look for methods named NAME in type T.

   Return number of matches.

   Put matches in SYM_ARR, which should have been allocated with

   a size of total_number_of_methods (T) * sizeof (struct symbol *).

   Note that this function is g++ specific.  */

static int

find_methods (struct type *t, char *name, struct symbol **sym_arr)

{

  int i1 = 0;

  int ibase;

  char *class_name = type_name_no_tag (t);

  /* Ignore this class if it doesn't have a name.  This is ugly, but

     unless we figure out how to get the physname without the name of

     the class, then the loop can't do any good.  */

  if (class_name

      && (lookup_symbol (class_name, (struct block *) NULL,

                         STRUCT_NAMESPACE, (int *) NULL,

                         (struct symtab **) NULL)))

    {

      int method_counter;

      int name_len = strlen (name);

      CHECK_TYPEDEF (t);

      /* Loop over each method name.  At this level, all overloads of a name

         are counted as a single name.  There is an inner loop which loops over

         each overload.  */

      for (method_counter = TYPE_NFN_FIELDS (t) - 1;

           method_counter >= 0;

           --method_counter)

        {

          int field_counter;

          char *method_name = TYPE_FN_FIELDLIST_NAME (t, method_counter);

          char dem_opname[64];

          if (strncmp (method_name, "__", 2) == 0 ||

              strncmp (method_name, "op", 2) == 0 ||

              strncmp (method_name, "type", 4) == 0)

            {

              if (cplus_demangle_opname (method_name, dem_opname, DMGL_ANSI))

                method_name = dem_opname;

              else if (cplus_demangle_opname (method_name, dem_opname, 0))

                method_name = dem_opname;

            }

          if (strcmp_iw (name, method_name) == 0)

            /* Find all the overloaded methods with that name.  */

            for (field_counter = TYPE_FN_FIELDLIST_LENGTH (t, method_counter) - 1;

                 field_counter >= 0;

                 --field_counter)

              {

                struct fn_field *f;

                char *phys_name;

                f = TYPE_FN_FIELDLIST1 (t, method_counter);

                if (TYPE_FN_FIELD_STUB (f, field_counter))

                  {

                    char *tmp_name;

                    tmp_name = gdb_mangle_name (t,

                                                method_counter,

                                                field_counter);

                    phys_name = alloca (strlen (tmp_name) + 1);

                    strcpy (phys_name, tmp_name);

                    xfree (tmp_name);

                  }

                else

                  phys_name = TYPE_FN_FIELD_PHYSNAME (f, field_counter);

                /* Destructor is handled by caller, dont add it to the list */

                if (is_destructor_name (phys_name) != 0)

                  continue;

                sym_arr[i1] = lookup_symbol (phys_name,

                                             NULL, VAR_NAMESPACE,

                                             (int *) NULL,

                                             (struct symtab **) NULL);

                if (sym_arr[i1])

                  i1++;

                else

                  {

                    /* This error message gets printed, but the method

                       still seems to be found

                       fputs_filtered("(Cannot find method ", gdb_stdout);

                       fprintf_symbol_filtered (gdb_stdout, phys_name,

                       language_cplus,

                       DMGL_PARAMS | DMGL_ANSI);

                       fputs_filtered(" - possibly inlined.)\n", gdb_stdout);

                     */

                  }

              }

          else if (strncmp (class_name, name, name_len) == 0

                   && (class_name[name_len] == '\0'

                       || class_name[name_len] == '<'))

            {

              /* For GCC 3.x and stabs, constructors and destructors have names

                 like __base_ctor and __complete_dtor.  Check the physname for now

                 if we're looking for a constructor.  */

              for (field_counter

                     = TYPE_FN_FIELDLIST_LENGTH (t, method_counter) - 1;

                   field_counter >= 0;

                   --field_counter)

                {

                  struct fn_field *f;

                  char *phys_name;

                  f = TYPE_FN_FIELDLIST1 (t, method_counter);

                  /* GCC 3.x will never produce stabs stub methods, so we don't need

                     to handle this case.  */

                  if (TYPE_FN_FIELD_STUB (f, field_counter))

                    continue;

                  phys_name = TYPE_FN_FIELD_PHYSNAME (f, field_counter);

                  if (! is_constructor_name (phys_name))

                    continue;

                  /* If this method is actually defined, include it in the

                     list.  */

                  sym_arr[i1] = lookup_symbol (phys_name,

                                               NULL, VAR_NAMESPACE,

                                               (int *) NULL,

                                               (struct symtab **) NULL);

                  if (sym_arr[i1])

                    i1++;

                }

            }

        }

    }

  /* Only search baseclasses if there is no match yet, since names in

     derived classes override those in baseclasses.

     FIXME: The above is not true; it is only true of member functions

     if they have the same number of arguments (??? - section 13.1 of the

     ARM says the function members are not in the same scope but doesn't

     really spell out the rules in a way I understand.  In any case, if

     the number of arguments differ this is a case in which we can overload

     rather than hiding without any problem, and gcc 2.4.5 does overload

     rather than hiding in this case).  */

  if (i1 == 0)

    for (ibase = 0; ibase < TYPE_N_BASECLASSES (t); ibase++)

      i1 += find_methods (TYPE_BASECLASS (t, ibase), name, sym_arr + i1);

  return i1;

}

/* Helper function for decode_line_1.

   Build a canonical line spec in CANONICAL if it is non-NULL and if

   the SAL has a symtab.

   If SYMNAME is non-NULL the canonical line spec is `filename:symname'.

   If SYMNAME is NULL the line number from SAL is used and the canonical

   line spec is `filename:linenum'.  */

static void

build_canonical_line_spec (struct symtab_and_line *sal, char *symname,

                           char ***canonical)

{

  char **canonical_arr;

  char *canonical_name;

  char *filename;

  struct symtab *s = sal->symtab;

  if (s == (struct symtab *) NULL

      || s->filename == (char *) NULL

      || canonical == (char ***) NULL)

    return;

  canonical_arr = (char **) xmalloc (sizeof (char *));

  *canonical = canonical_arr;

  filename = s->filename;

  if (symname != NULL)

    {

      canonical_name = xmalloc (strlen (filename) + strlen (symname) + 2);

      sprintf (canonical_name, "%s:%s", filename, symname);

    }

  else

    {

      canonical_name = xmalloc (strlen (filename) + 30);

      sprintf (canonical_name, "%s:%d", filename, sal->line);

    }

  canonical_arr[0] = canonical_name;

}

/* Find an instance of the character C in the string S that is outside

   of all parenthesis pairs, single-quoted strings, and double-quoted

   strings.  Also, ignore the char within a template name, like a ','

   within foo<int, int>.  */

static char *

find_toplevel_char (char *s, char c)

{

  int quoted = 0;                /* zero if we're not in quotes;

                                   '"' if we're in a double-quoted string;

                                   '\'' if we're in a single-quoted string.  */

  int depth = 0;         /* number of unclosed parens we've seen */

  char *scan;

  for (scan = s; *scan; scan++)

    {

      if (quoted)

        {

          if (*scan == quoted)

            quoted = 0;

          else if (*scan == '\\' && *(scan + 1))

            scan++;

        }

      else if (*scan == c && ! quoted && depth == 0)

        return scan;

      else if (*scan == '"' || *scan == '\'')

        quoted = *scan;

      else if (*scan == '(' || *scan == '<')

        depth++;

      else if ((*scan == ')' || *scan == '>') && depth > 0)

        depth--;

    }

  return 0;

}

/* Given a list of NELTS symbols in SYM_ARR, return a list of lines to

   operate on (ask user if necessary).

   If CANONICAL is non-NULL return a corresponding array of mangled names

   as canonical line specs there.  */

static struct symtabs_and_lines

decode_line_2 (struct symbol *sym_arr[], int nelts, int funfirstline,

               char ***canonical)

{

  struct symtabs_and_lines values, return_values;

  char *args, *arg1;

  int i;

  char *prompt;

  char *symname;

  struct cleanup *old_chain;

  char **canonical_arr = (char **) NULL;

  values.sals = (struct symtab_and_line *)

    alloca (nelts * sizeof (struct symtab_and_line));

  return_values.sals = (struct symtab_and_line *)

    xmalloc (nelts * sizeof (struct symtab_and_line));

  old_chain = make_cleanup (xfree, return_values.sals);

  if (canonical)

    {

      canonical_arr = (char **) xmalloc (nelts * sizeof (char *));

      make_cleanup (xfree, canonical_arr);

      memset (canonical_arr, 0, nelts * sizeof (char *));

      *canonical = canonical_arr;

    }

  i = 0;

  printf_unfiltered ("[0] cancel\n[1] all\n");

  while (i < nelts)

    {

      INIT_SAL (&return_values.sals[i]);        /* initialize to zeroes */

      INIT_SAL (&values.sals[i]);

      if (sym_arr[i] && SYMBOL_CLASS (sym_arr[i]) == LOC_BLOCK)

        {

          values.sals[i] = find_function_start_sal (sym_arr[i], funfirstline);

          printf_unfiltered ("[%d] %s at %s:%d\n",

                             (i + 2),

                             SYMBOL_SOURCE_NAME (sym_arr[i]),

                             values.sals[i].symtab->filename,

                             values.sals[i].line);

        }

      else

        printf_unfiltered ("?HERE\n");

      i++;

    }

  if ((prompt = getenv ("PS2")) == NULL)

    {

      prompt = "> ";

    }

  args = command_line_input (prompt, 0, "overload-choice");

  if (args == 0 || *args == 0)

    error_no_arg ("one or more choice numbers");

  i = 0;

  while (*args)

    {

      int num;

      arg1 = args;

      while (*arg1 >= '0' && *arg1 <= '9')

        arg1++;

      if (*arg1 && *arg1 != ' ' && *arg1 != '\t')

        error ("Arguments must be choice numbers.");

      num = atoi (args);

      if (num == 0)

        error ("canceled");

      else if (num == 1)

        {

          if (canonical_arr)

            {

              for (i = 0; i < nelts; i++)

                {

                  if (canonical_arr[i] == NULL)

                    {

                      symname = SYMBOL_NAME (sym_arr[i]);

                      canonical_arr[i] = savestring (symname, strlen (symname));

                    }

                }

            }

          memcpy (return_values.sals, values.sals,

                  (nelts * sizeof (struct symtab_and_line)));

          return_values.nelts = nelts;

          discard_cleanups (old_chain);

          return return_values;

        }

      if (num >= nelts + 2)

        {

          printf_unfiltered ("No choice number %d.\n", num);

        }

      else

        {

          num -= 2;

          if (values.sals[num].pc)

            {

              if (canonical_arr)

                {

                  symname = SYMBOL_NAME (sym_arr[num]);

                  make_cleanup (xfree, symname);

                  canonical_arr[i] = savestring (symname, strlen (symname));

                }

              return_values.sals[i++] = values.sals[num];

              values.sals[num].pc = 0;

            }

          else

            {

              printf_unfiltered ("duplicate request for %d ignored.\n", num);

            }

        }

      args = arg1;

      while (*args == ' ' || *args == '\t')

        args++;

    }

  return_values.nelts = i;

  discard_cleanups (old_chain);

  return return_values;

}

/* The parser of linespec itself. */

/* Parse a string that specifies a line number.

   Pass the address of a char * variable; that variable will be

   advanced over the characters actually parsed.

   The string can be:

   LINENUM -- that line number in current file.  PC returned is 0.

   FILE:LINENUM -- that line in that file.  PC returned is 0.

   FUNCTION -- line number of openbrace of that function.

   PC returned is the start of the function.

   VARIABLE -- line number of definition of that variable.

   PC returned is 0.

   FILE:FUNCTION -- likewise, but prefer functions in that file.

   *EXPR -- line in which address EXPR appears.

   This may all be followed by an "if EXPR", which we ignore.

   FUNCTION may be an undebuggable function found in minimal symbol table.

   If the argument FUNFIRSTLINE is nonzero, we want the first line

   of real code inside a function when a function is specified, and it is

   not OK to specify a variable or type to get its line number.

   DEFAULT_SYMTAB specifies the file to use if none is specified.

   It defaults to current_source_symtab.

   DEFAULT_LINE specifies the line number to use for relative

   line numbers (that start with signs).  Defaults to current_source_line.

   If CANONICAL is non-NULL, store an array of strings containing the canonical

   line specs there if necessary. Currently overloaded member functions and

   line numbers or static functions without a filename yield a canonical

   line spec. The array and the line spec strings are allocated on the heap,

   it is the callers responsibility to free them.

   Note that it is possible to return zero for the symtab

   if no file is validly specified.  Callers must check that.

   Also, the line number returned may be invalid.  */

/* We allow single quotes in various places.  This is a hideous

   kludge, which exists because the completer can't yet deal with the

   lack of single quotes.  FIXME: write a linespec_completer which we

   can use as appropriate instead of make_symbol_completion_list.  */

struct symtabs_and_lines

decode_line_1 (char **argptr, int funfirstline, struct symtab *default_symtab,

               int default_line, char ***canonical)

{

  struct symtabs_and_lines values;

  struct symtab_and_line val;

  register char *p, *p1;

  char *q, *pp, *ii, *p2;

#if 0

  char *q1;

#endif

  register struct symtab *s;

  register struct symbol *sym;

  /* The symtab that SYM was found in.  */

  struct symtab *sym_symtab;

  register CORE_ADDR pc;

  register struct minimal_symbol *msymbol;

  char *copy;

  struct symbol *sym_class;

  int i1;

  int is_quoted;

  int is_quote_enclosed;

  int has_parens;

  int has_if = 0;

  int has_comma = 0;

  struct symbol **sym_arr;

  struct type *t;

  char *saved_arg = *argptr;

  extern char *gdb_completer_quote_characters;

  INIT_SAL (&val);              /* initialize to zeroes */

  /* Defaults have defaults.  */

  if (default_symtab == 0)

    {

      default_symtab = current_source_symtab;

      default_line = current_source_line;

    }

  /* See if arg is *PC */

  if (**argptr == '*')

    {

      (*argptr)++;

      pc = parse_and_eval_address_1 (argptr);

      values.sals = (struct symtab_and_line *)

        xmalloc (sizeof (struct symtab_and_line));

      values.nelts = 1;

      values.sals[0] = find_pc_line (pc, 0);

      values.sals[0].pc = pc;

      values.sals[0].section = find_pc_overlay (pc);

      return values;

    }

  /* 'has_if' is for the syntax:

   *     (gdb) break foo if (a==b)

   */

  if ((ii = strstr (*argptr, " if ")) != NULL ||

      (ii = strstr (*argptr, "\tif ")) != NULL ||

      (ii = strstr (*argptr, " if\t")) != NULL ||

      (ii = strstr (*argptr, "\tif\t")) != NULL ||

      (ii = strstr (*argptr, " if(")) != NULL ||

      (ii = strstr (*argptr, "\tif( ")) != NULL)

    has_if = 1;

  /* Temporarily zap out "if (condition)" to not

   * confuse the parenthesis-checking code below.

   * This is undone below. Do not change ii!!

   */

  if (has_if)

    {

      *ii = '\0';

    }

  /* Set various flags.

   * 'has_parens' is important for overload checking, where

   * we allow things like:

   *     (gdb) break c::f(int)

   */

  /* Maybe arg is FILE : LINENUM or FILE : FUNCTION */

  is_quoted = (**argptr

               && strchr (get_gdb_completer_quote_characters (),

                          **argptr) != NULL);

  has_parens = ((pp = strchr (*argptr, '(')) != NULL

                && (pp = strrchr (pp, ')')) != NULL);

  /* Now that we're safely past the has_parens check,

   * put back " if (condition)" so outer layers can see it

   */

  if (has_if)

    *ii = ' ';

  /* Maybe we were called with a line range FILENAME:LINENUM,FILENAME:LINENUM

     and we must isolate the first half.  Outer layers will call again later

     for the second half.

     Don't count commas that appear in argument lists of overloaded

     functions, or in quoted strings.  It's stupid to go to this much

     trouble when the rest of the function is such an obvious roach hotel.  */

  ii = find_toplevel_char (*argptr, ',');

  has_comma = (ii != 0);

  /* Temporarily zap out second half to not

   * confuse the code below.

   * This is undone below. Do not change ii!!

   */

  if (has_comma)

    {

      *ii = '\0';

    }

  /* Maybe arg is FILE : LINENUM or FILE : FUNCTION */

  /* May also be CLASS::MEMBER, or NAMESPACE::NAME */

  /* Look for ':', but ignore inside of <> */

  s = NULL;

  p = *argptr;

  if (p[0] == '"')

    {

      is_quote_enclosed = 1;

      (*argptr)++;

      p++;

    }

  else

    is_quote_enclosed = 0;

  for (; *p; p++)

    {

      if (p[0] == '<')

        {

          char *temp_end = find_template_name_end (p);

          if (!temp_end)

            error ("malformed template specification in command");

          p = temp_end;

        }

      /* Check for the end of the first half of the linespec.  End of line,

         a tab, a double colon or the last single colon, or a space.  But

         if enclosed in double quotes we do not break on enclosed spaces */

      if (!*p

          || p[0] == '\t'

          || ((p[0] == ':')

              && ((p[1] == ':') || (strchr (p + 1, ':') == NULL)))

          || ((p[0] == ' ') && !is_quote_enclosed))

        break;

      if (p[0] == '.' && strchr (p, ':') == NULL)        /* Java qualified method. */

        {

          /* Find the *last* '.', since the others are package qualifiers. */

          for (p1 = p; *p1; p1++)

            {

              if (*p1 == '.')

                p = p1;

            }

          break;

        }

    }

  while (p[0] == ' ' || p[0] == '\t')

    p++;

  /* if the closing double quote was left at the end, remove it */

  if (is_quote_enclosed)