gdb/linespec.c

   1 /* Parser for linespec for the GNU debugger, GDB.
   2
   3    Copyright (C) 1986, 1987, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995,
   4    1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2007, 2008,
   5    2009, 2010 Free Software Foundation, Inc.
   6
   7    This file is part of GDB.
   8
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation; either version 3 of the License, or
  12    (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  21
  22 #include "defs.h"
  23 #include "symtab.h"
  24 #include "frame.h"
  25 #include "command.h"
  26 #include "symfile.h"
  27 #include "objfiles.h"
  28 #include "source.h"
  29 #include "demangle.h"
  30 #include "value.h"
  31 #include "completer.h"
  32 #include "cp-abi.h"
  33 #include "cp-support.h"
  34 #include "parser-defs.h"
  35 #include "block.h"
  36 #include "objc-lang.h"
  37 #include "linespec.h"
  38 #include "exceptions.h"
  39 #include "language.h"
  40 #include "interps.h"
  41 #include "mi/mi-cmds.h"
  42 #include "target.h"
  43 #include "arch-utils.h"
  44
  45 /* We share this one with symtab.c, but it is not exported widely. */
  46
  47 extern char *operator_chars (char *, char **);
  48
  49 /* Prototypes for local functions */
  50
  51 static void initialize_defaults (struct symtab **default_symtab,
  52                                  int *default_line);
  53
  54 static struct symtabs_and_lines decode_indirect (char **argptr);
  55
  56 static char *locate_first_half (char **argptr, int *is_quote_enclosed);
  57
  58 static struct symtabs_and_lines decode_objc (char **argptr,
  59                                              int funfirstline,
  60                                              struct symtab *file_symtab,
  61                                              char ***canonical,
  62                                              char *saved_arg);
  63
  64 static struct symtabs_and_lines decode_compound (char **argptr,
  65                                                  int funfirstline,
  66                                                  char ***canonical,
  67                                                  char *saved_arg,
  68                                                  char *p,
  69                                                  int *not_found_ptr);
  70
  71 static struct symbol *lookup_prefix_sym (char **argptr, char *p);
  72
  73 static struct symtabs_and_lines find_method (int funfirstline,
  74                                              char ***canonical,
  75                                              char *saved_arg,
  76                                              char *copy,
  77                                              struct type *t,
  78                                              struct symbol *sym_class,
  79                                              int *not_found_ptr);
  80
  81 static void cplusplus_error (const char *name, const char *fmt, ...)
  82      ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (2, 3);
  83
  84 static int total_number_of_methods (struct type *type);
  85
  86 static int find_methods (struct type *, char *,
  87                          enum language, struct symbol **);
  88
  89 static int add_matching_methods (int method_counter, struct type *t,
  90                                  enum language language,
  91                                  struct symbol **sym_arr);
  92
  93 static int add_constructors (int method_counter, struct type *t,
  94                              enum language language,
  95                              struct symbol **sym_arr);
  96
  97 static void build_canonical_line_spec (struct symtab_and_line *,
  98                                        char *, char ***);
  99
 100 static char *find_toplevel_char (char *s, char c);
 101
 102 static int is_objc_method_format (const char *s);
 103
 104 static struct symtabs_and_lines decode_line_2 (struct symbol *[],
 105                                                int, int, char ***);
 106
 107 static struct symtab *symtab_from_filename (char **argptr,
 108                                             char *p, int is_quote_enclosed,
 109                                             int *not_found_ptr);
 110
 111 static struct
 112 symtabs_and_lines decode_all_digits (char **argptr,
 113                                      struct symtab *default_symtab,
 114                                      int default_line,
 115                                      char ***canonical,
 116                                      struct symtab *file_symtab,
 117                                      char *q);
 118
 119 static struct symtabs_and_lines decode_dollar (char *copy,
 120                                                int funfirstline,
 121                                                struct symtab *default_symtab,
 122                                                char ***canonical,
 123                                                struct symtab *file_symtab);
 124
 125 static int decode_label (char *copy, char ***canonical,
 126                          struct symtabs_and_lines *result);
 127
 128 static struct symtabs_and_lines decode_variable (char *copy,
 129                                                  int funfirstline,
 130                                                  char ***canonical,
 131                                                  struct symtab *file_symtab,
 132                                                  int *not_found_ptr);
 133
 134 static struct
 135 symtabs_and_lines symbol_found (int funfirstline,
 136                                 char ***canonical,
 137                                 char *copy,
 138                                 struct symbol *sym,
 139                                 struct symtab *file_symtab);
 140
 141 static struct
 142 symtabs_and_lines minsym_found (int funfirstline,
 143                                 struct minimal_symbol *msymbol);
 144
 145 /* Helper functions. */
 146
 147 /* Issue a helpful hint on using the command completion feature on
 148    single quoted demangled C++ symbols as part of the completion
 149    error.  */
 150
 151 static void
 152 cplusplus_error (const char *name, const char *fmt, ...)
 153 {
 154   struct ui_file *tmp_stream;
 155   char *message;
 156
 157   tmp_stream = mem_fileopen ();
 158   make_cleanup_ui_file_delete (tmp_stream);
 159
 160   {
 161     va_list args;
 162
 163     va_start (args, fmt);
 164     vfprintf_unfiltered (tmp_stream, fmt, args);
 165     va_end (args);
 166   }
 167
 168   while (*name == '\'')
 169     name++;
 170   fprintf_unfiltered (tmp_stream,
 171                       ("Hint: try '%s<TAB> or '%s<ESC-?>\n"
 172                        "(Note leading single quote.)"),
 173                       name, name);
 174
 175   message = ui_file_xstrdup (tmp_stream, NULL);
 176   make_cleanup (xfree, message);
 177   throw_error (NOT_FOUND_ERROR, "%s", message);
 178 }
 179
 180 /* Return the number of methods described for TYPE, including the
 181    methods from types it derives from. This can't be done in the symbol
 182    reader because the type of the baseclass might still be stubbed
 183    when the definition of the derived class is parsed.  */
 184
 185 static int
 186 total_number_of_methods (struct type *type)
 187 {
 188   int n;
 189   int count;
 190
 191   CHECK_TYPEDEF (type);
 192   if (! HAVE_CPLUS_STRUCT (type))
 193     return 0;
 194   count = TYPE_NFN_FIELDS_TOTAL (type);
 195
 196   for (n = 0; n < TYPE_N_BASECLASSES (type); n++)
 197     count += total_number_of_methods (TYPE_BASECLASS (type, n));
 198
 199   return count;
 200 }
 201
 202 /* Recursive helper function for decode_line_1.
 203    Look for methods named NAME in type T.
 204    Return number of matches.
 205    Put matches in SYM_ARR, which should have been allocated with
 206    a size of total_number_of_methods (T) * sizeof (struct symbol *).
 207    Note that this function is g++ specific.  */
 208
 209 static int
 210 find_methods (struct type *t, char *name, enum language language,
 211               struct symbol **sym_arr)
 212 {
 213   int i1 = 0;
 214   int ibase;
 215   char *class_name = type_name_no_tag (t);
 216
 217   /* Ignore this class if it doesn't have a name.  This is ugly, but
 218      unless we figure out how to get the physname without the name of
 219      the class, then the loop can't do any good.  */
 220   if (class_name
 221       && (lookup_symbol_in_language (class_name, (struct block *) NULL,
 222                          STRUCT_DOMAIN, language, (int *) NULL)))
 223     {
 224       int method_counter;
 225       int name_len = strlen (name);
 226
 227       CHECK_TYPEDEF (t);
 228
 229       /* Loop over each method name.  At this level, all overloads of a name
 230          are counted as a single name.  There is an inner loop which loops over
 231          each overload.  */
 232
 233       for (method_counter = TYPE_NFN_FIELDS (t) - 1;
 234            method_counter >= 0;
 235            --method_counter)
 236         {
 237           char *method_name = TYPE_FN_FIELDLIST_NAME (t, method_counter);
 238           char dem_opname[64];
 239
 240           if (strncmp (method_name, "__", 2) == 0 ||
 241               strncmp (method_name, "op", 2) == 0 ||
 242               strncmp (method_name, "type", 4) == 0)
 243             {
 244               if (cplus_demangle_opname (method_name, dem_opname, DMGL_ANSI))
 245                 method_name = dem_opname;
 246               else if (cplus_demangle_opname (method_name, dem_opname, 0))
 247                 method_name = dem_opname;
 248             }
 249
 250           if (strcmp_iw (name, method_name) == 0)
 251             /* Find all the overloaded methods with that name.  */
 252             i1 += add_matching_methods (method_counter, t, language,
 253                                         sym_arr + i1);
 254           else if (strncmp (class_name, name, name_len) == 0
 255                    && (class_name[name_len] == '\0'
 256                        || class_name[name_len] == '<'))
 257             i1 += add_constructors (method_counter, t, language,
 258                                     sym_arr + i1);
 259         }
 260     }
 261
 262   /* Only search baseclasses if there is no match yet, since names in
 263      derived classes override those in baseclasses.
 264
 265      FIXME: The above is not true; it is only true of member functions
 266      if they have the same number of arguments (??? - section 13.1 of the
 267      ARM says the function members are not in the same scope but doesn't
 268      really spell out the rules in a way I understand.  In any case, if
 269      the number of arguments differ this is a case in which we can overload
 270      rather than hiding without any problem, and gcc 2.4.5 does overload
 271      rather than hiding in this case).  */
 272
 273   if (i1 == 0)
 274     for (ibase = 0; ibase < TYPE_N_BASECLASSES (t); ibase++)
 275       i1 += find_methods (TYPE_BASECLASS (t, ibase), name,
 276                           language, sym_arr + i1);
 277
 278   return i1;
 279 }
 280
 281 /* Add the symbols associated to methods of the class whose type is T
 282    and whose name matches the method indexed by METHOD_COUNTER in the
 283    array SYM_ARR.  Return the number of methods added.  */
 284
 285 static int
 286 add_matching_methods (int method_counter, struct type *t,
 287                       enum language language, struct symbol **sym_arr)
 288 {
 289   int field_counter;
 290   int i1 = 0;
 291
 292   for (field_counter = TYPE_FN_FIELDLIST_LENGTH (t, method_counter) - 1;
 293        field_counter >= 0;
 294        --field_counter)
 295     {
 296       struct fn_field *f;
 297       char *phys_name;
 298
 299       f = TYPE_FN_FIELDLIST1 (t, method_counter);
 300
 301       if (TYPE_FN_FIELD_STUB (f, field_counter))
 302         {
 303           char *tmp_name;
 304
 305           tmp_name = gdb_mangle_name (t,
 306                                       method_counter,
 307                                       field_counter);
 308           phys_name = alloca (strlen (tmp_name) + 1);
 309           strcpy (phys_name, tmp_name);
 310           xfree (tmp_name);
 311         }
 312       else
 313         phys_name = TYPE_FN_FIELD_PHYSNAME (f, field_counter);
 314
 315       sym_arr[i1] = lookup_symbol_in_language (phys_name,
 316                                    NULL, VAR_DOMAIN,
 317                                    language,
 318                                    (int *) NULL);
 319       if (sym_arr[i1])
 320         i1++;
 321       else
 322         {
 323           /* This error message gets printed, but the method
 324              still seems to be found
 325              fputs_filtered("(Cannot find method ", gdb_stdout);
 326              fprintf_symbol_filtered (gdb_stdout, phys_name,
 327              language_cplus,
 328              DMGL_PARAMS | DMGL_ANSI);
 329              fputs_filtered(" - possibly inlined.)\n", gdb_stdout);
 330           */
 331         }
 332     }
 333
 334   return i1;
 335 }
 336
 337 /* Add the symbols associated to constructors of the class whose type
 338    is CLASS_TYPE and which are indexed by by METHOD_COUNTER to the
 339    array SYM_ARR.  Return the number of methods added.  */
 340
 341 static int
 342 add_constructors (int method_counter, struct type *t,
 343                   enum language language, struct symbol **sym_arr)
 344 {
 345   int field_counter;
 346   int i1 = 0;
 347
 348   /* For GCC 3.x and stabs, constructors and destructors
 349      have names like __base_ctor and __complete_dtor.
 350      Check the physname for now if we're looking for a
 351      constructor.  */
 352   for (field_counter
 353          = TYPE_FN_FIELDLIST_LENGTH (t, method_counter) - 1;
 354        field_counter >= 0;
 355        --field_counter)
 356     {
 357       struct fn_field *f;
 358       char *phys_name;
 359
 360       f = TYPE_FN_FIELDLIST1 (t, method_counter);
 361
 362       /* GCC 3.x will never produce stabs stub methods, so
 363          we don't need to handle this case.  */
 364       if (TYPE_FN_FIELD_STUB (f, field_counter))
 365         continue;
 366       phys_name = TYPE_FN_FIELD_PHYSNAME (f, field_counter);
 367       if (! is_constructor_name (phys_name))
 368         continue;
 369
 370       /* If this method is actually defined, include it in the
 371          list.  */
 372       sym_arr[i1] = lookup_symbol_in_language (phys_name,
 373                                    NULL, VAR_DOMAIN,
 374                                    language,
 375                                    (int *) NULL);
 376       if (sym_arr[i1])
 377         i1++;
 378     }
 379
 380   return i1;
 381 }
 382
 383 /* Helper function for decode_line_1.
 384    Build a canonical line spec in CANONICAL if it is non-NULL and if
 385    the SAL has a symtab.
 386    If SYMNAME is non-NULL the canonical line spec is `filename:symname'.
 387    If SYMNAME is NULL the line number from SAL is used and the canonical
 388    line spec is `filename:linenum'.  */
 389
 390 static void
 391 build_canonical_line_spec (struct symtab_and_line *sal, char *symname,
 392                            char ***canonical)
 393 {
 394   char **canonical_arr;
 395   char *canonical_name;
 396   char *filename;
 397   struct symtab *s = sal->symtab;
 398
 399   if (s == (struct symtab *) NULL
 400       || s->filename == (char *) NULL
 401       || canonical == (char ***) NULL)
 402     return;
 403
 404   canonical_arr = (char **) xmalloc (sizeof (char *));
 405   *canonical = canonical_arr;
 406
 407   filename = s->filename;
 408   if (symname != NULL)
 409     {
 410       canonical_name = xmalloc (strlen (filename) + strlen (symname) + 2);
 411       sprintf (canonical_name, "%s:%s", filename, symname);
 412     }
 413   else
 414     {
 415       canonical_name = xmalloc (strlen (filename) + 30);
 416       sprintf (canonical_name, "%s:%d", filename, sal->line);
 417     }
 418   canonical_arr[0] = canonical_name;
 419 }
 420
 421
 422
 423 /* Find an instance of the character C in the string S that is outside
 424    of all parenthesis pairs, single-quoted strings, and double-quoted
 425    strings.  Also, ignore the char within a template name, like a ','
 426    within foo<int, int>.  */
 427
 428 static char *
 429 find_toplevel_char (char *s, char c)
 430 {
 431   int quoted = 0;               /* zero if we're not in quotes;
 432                                    '"' if we're in a double-quoted string;
 433                                    '\'' if we're in a single-quoted string.  */
 434   int depth = 0;                /* Number of unclosed parens we've seen.  */
 435   char *scan;
 436
 437   for (scan = s; *scan; scan++)
 438     {
 439       if (quoted)
 440         {
 441           if (*scan == quoted)
 442             quoted = 0;
 443           else if (*scan == '\\' && *(scan + 1))
 444             scan++;
 445         }
 446       else if (*scan == c && ! quoted && depth == 0)
 447         return scan;
 448       else if (*scan == '"' || *scan == '\'')
 449         quoted = *scan;
 450       else if (*scan == '(' || *scan == '<')
 451         depth++;
 452       else if ((*scan == ')' || *scan == '>') && depth > 0)
 453         depth--;
 454     }
 455
 456   return 0;
 457 }
 458
 459 /* Determines if the gives string corresponds to an Objective-C method
 460    representation, such as -[Foo bar:] or +[Foo bar]. Objective-C symbols
 461    are allowed to have spaces and parentheses in them.  */
 462
 463 static int
 464 is_objc_method_format (const char *s)
 465 {
 466   if (s == NULL || *s == '\0')
 467     return 0;
 468   /* Handle arguments with the format FILENAME:SYMBOL.  */
 469   if ((s[0] == ':') && (strchr ("+-", s[1]) != NULL)
 470       && (s[2] == '[') && strchr(s, ']'))
 471     return 1;
 472   /* Handle arguments that are just SYMBOL.  */
 473   else if ((strchr ("+-", s[0]) != NULL) && (s[1] == '[') && strchr(s, ']'))
 474     return 1;
 475   return 0;
 476 }
 477
 478 /* Given a list of NELTS symbols in SYM_ARR, return a list of lines to
 479    operate on (ask user if necessary).
 480    If CANONICAL is non-NULL return a corresponding array of mangled names
 481    as canonical line specs there.  */
 482
 483 static struct symtabs_and_lines
 484 decode_line_2 (struct symbol *sym_arr[], int nelts, int funfirstline,
 485                char ***canonical)
 486 {
 487   struct symtabs_and_lines values, return_values;
 488   char *args, *arg1;
 489   int i;
 490   char *prompt;
 491   char *symname;
 492   struct cleanup *old_chain;
 493   char **canonical_arr = (char **) NULL;
 494   const char *select_mode = multiple_symbols_select_mode ();
 495
 496   if (select_mode == multiple_symbols_cancel)
 497     error (_("\
 498 canceled because the command is ambiguous\n\
 499 See set/show multiple-symbol."));
 500
 501   values.sals = (struct symtab_and_line *)
 502     alloca (nelts * sizeof (struct symtab_and_line));
 503   return_values.sals = (struct symtab_and_line *)
 504     xmalloc (nelts * sizeof (struct symtab_and_line));
 505   old_chain = make_cleanup (xfree, return_values.sals);
 506
 507   if (canonical)
 508     {
 509       canonical_arr = (char **) xmalloc (nelts * sizeof (char *));
 510       make_cleanup (xfree, canonical_arr);
 511       memset (canonical_arr, 0, nelts * sizeof (char *));
 512       *canonical = canonical_arr;
 513     }
 514
 515   i = 0;
 516   while (i < nelts)
 517     {
 518       init_sal (&return_values.sals[i]);        /* Initialize to zeroes.  */
 519       init_sal (&values.sals[i]);
 520       if (sym_arr[i] && SYMBOL_CLASS (sym_arr[i]) == LOC_BLOCK)
 521         values.sals[i] = find_function_start_sal (sym_arr[i], funfirstline);
 522       i++;
 523     }
 524
 525   /* If select_mode is "all", then do not print the multiple-choice
 526      menu and act as if the user had chosen choice "1" (all).  */
 527   if (select_mode == multiple_symbols_all
 528       || ui_out_is_mi_like_p (interp_ui_out (top_level_interpreter ())))
 529     args = "1";
 530   else
 531     {
 532       i = 0;
 533       printf_unfiltered (_("[0] cancel\n[1] all\n"));
 534       while (i < nelts)
 535         {
 536           if (sym_arr[i] && SYMBOL_CLASS (sym_arr[i]) == LOC_BLOCK)
 537             {
 538               if (values.sals[i].symtab)
 539                 printf_unfiltered ("[%d] %s at %s:%d\n",
 540                                    (i + 2),
 541                                    SYMBOL_PRINT_NAME (sym_arr[i]),
 542                                    values.sals[i].symtab->filename,
 543                                    values.sals[i].line);
 544               else
 545                 printf_unfiltered (_("[%d] %s at ?FILE:%d [No symtab? Probably broken debug info...]\n"),
 546                                    (i + 2),
 547                                    SYMBOL_PRINT_NAME (sym_arr[i]),
 548                                    values.sals[i].line);
 549
 550             }
 551           else
 552             printf_unfiltered (_("?HERE\n"));
 553           i++;
 554         }
 555
 556       prompt = getenv ("PS2");
 557       if (prompt == NULL)
 558         {
 559           prompt = "> ";
 560         }
 561       args = command_line_input (prompt, 0, "overload-choice");
 562     }
 563
 564   if (args == 0 || *args == 0)
 565     error_no_arg (_("one or more choice numbers"));
 566
 567   i = 0;
 568   while (*args)
 569     {
 570       int num;
 571
 572       arg1 = args;
 573       while (*arg1 >= '0' && *arg1 <= '9')
 574         arg1++;
 575       if (*arg1 && *arg1 != ' ' && *arg1 != '\t')
 576         error (_("Arguments must be choice numbers."));
 577
 578       num = atoi (args);
 579
 580       if (num == 0)
 581         error (_("canceled"));
 582       else if (num == 1)
 583         {
 584           if (canonical_arr)
 585             {
 586               for (i = 0; i < nelts; i++)
 587                 {
 588                   if (canonical_arr[i] == NULL)
 589                     {
 590                       symname = SYMBOL_LINKAGE_NAME (sym_arr[i]);
 591                       canonical_arr[i] = xstrdup (symname);
 592                     }
 593                 }
 594             }
 595           memcpy (return_values.sals, values.sals,
 596                   (nelts * sizeof (struct symtab_and_line)));
 597           return_values.nelts = nelts;
 598           discard_cleanups (old_chain);
 599           return return_values;
 600         }
 601
 602       if (num >= nelts + 2)
 603         {
 604           printf_unfiltered (_("No choice number %d.\n"), num);
 605         }
 606       else
 607         {
 608           num -= 2;
 609           if (values.sals[num].pc)
 610             {
 611               if (canonical_arr)
 612                 {
 613                   symname = SYMBOL_LINKAGE_NAME (sym_arr[num]);
 614                   make_cleanup (xfree, symname);
 615                   canonical_arr[i] = xstrdup (symname);
 616                 }
 617               return_values.sals[i++] = values.sals[num];
 618               values.sals[num].pc = 0;
 619             }
 620           else
 621             {
 622               printf_unfiltered (_("duplicate request for %d ignored.\n"), num);
 623             }
 624         }
 625
 626       args = arg1;
 627       while (*args == ' ' || *args == '\t')
 628         args++;
 629     }
 630   return_values.nelts = i;
 631   discard_cleanups (old_chain);
 632   return return_values;
 633 }
 634
 635 /* A helper function for decode_line_1 and friends which skips P
 636    past any method overload information at the beginning of P, e.g.,
 637    "(const struct foo *)".
 638
 639    This function assumes that P has already been validated to contain
 640    overload information, and it will assert if *P != '('.  */
 641 static char *
 642 find_method_overload_end (char *p)
 643 {
 644   int depth = 0;
 645
 646   gdb_assert (*p == '(');
 647
 648   while (*p)
 649     {
 650       if (*p == '(')
 651         ++depth;
 652       else if (*p == ')')
 653         {
 654           if (--depth == 0)
 655             {
 656               ++p;
 657               break;
 658             }
 659         }
 660       ++p;
 661     }
 662
 663   return p;
 664 }
 665 \f
 666 /* The parser of linespec itself. */
 667
 668 /* Parse a string that specifies a line number.
 669    Pass the address of a char * variable; that variable will be
 670    advanced over the characters actually parsed.
 671
 672    The string can be:
 673
 674    LINENUM -- that line number in current file.  PC returned is 0.
 675    FILE:LINENUM -- that line in that file.  PC returned is 0.
 676    FUNCTION -- line number of openbrace of that function.
 677    PC returned is the start of the function.
 678    LABEL -- a label in the current scope
 679    VARIABLE -- line number of definition of that variable.
 680    PC returned is 0.
 681    FILE:FUNCTION -- likewise, but prefer functions in that file.
 682    *EXPR -- line in which address EXPR appears.
 683
 684    This may all be followed by an "if EXPR", which we ignore.
 685
 686    FUNCTION may be an undebuggable function found in minimal symbol table.
 687
 688    If the argument FUNFIRSTLINE is nonzero, we want the first line
 689    of real code inside a function when a function is specified, and it is
 690    not OK to specify a variable or type to get its line number.
 691
 692    DEFAULT_SYMTAB specifies the file to use if none is specified.
 693    It defaults to current_source_symtab.
 694    DEFAULT_LINE specifies the line number to use for relative
 695    line numbers (that start with signs).  Defaults to current_source_line.
 696    If CANONICAL is non-NULL, store an array of strings containing the canonical
 697    line specs there if necessary. Currently overloaded member functions and
 698    line numbers or static functions without a filename yield a canonical
 699    line spec. The array and the line spec strings are allocated on the heap,
 700    it is the callers responsibility to free them.
 701
 702    Note that it is possible to return zero for the symtab
 703    if no file is validly specified.  Callers must check that.
 704    Also, the line number returned may be invalid.
 705
 706    If NOT_FOUND_PTR is not null, store a boolean true/false value at the location, based
 707    on whether or not failure occurs due to an unknown function or file.  In the case
 708    where failure does occur due to an unknown function or file, do not issue an error
 709    message.  */
 710
 711 /* We allow single quotes in various places.  This is a hideous
 712    kludge, which exists because the completer can't yet deal with the
 713    lack of single quotes.  FIXME: write a linespec_completer which we
 714    can use as appropriate instead of make_symbol_completion_list.  */
 715
 716 struct symtabs_and_lines
 717 decode_line_1 (char **argptr, int funfirstline, struct symtab *default_symtab,
 718                int default_line, char ***canonical, int *not_found_ptr)
 719 {
 720   char *p;
 721   char *q;
 722   /* If a file name is specified, this is its symtab.  */
 723   struct symtab *file_symtab = NULL;
 724
 725   char *copy;
 726   /* This says whether or not something in *ARGPTR is quoted with
 727      completer_quotes (i.e. with single quotes).  */
 728   int is_quoted;
 729   /* Is *ARGPTR is enclosed in double quotes?  */
 730   int is_quote_enclosed;
 731   int is_objc_method = 0;
 732   char *saved_arg = *argptr;
 733   /* If IS_QUOTED, the end of the quoted bit.  */
 734   char *end_quote = NULL;
 735   /* The "first half" of the linespec.  */
 736   char *first_half;
 737
 738   if (not_found_ptr)
 739     *not_found_ptr = 0;
 740
 741   /* Defaults have defaults.  */
 742
 743   initialize_defaults (&default_symtab, &default_line);
 744
 745   /* See if arg is *PC.  */
 746
 747   if (**argptr == '*')
 748     return decode_indirect (argptr);
 749
 750   is_quoted = (*argptr
 751                && strchr (get_gdb_completer_quote_characters (),
 752                           **argptr) != NULL);
 753   if (is_quoted)
 754     end_quote = skip_quoted (*argptr);
 755
 756   /* Check to see if it's a multipart linespec (with colons or
 757      periods).  */
 758
 759   /* Locate the end of the first half of the linespec.
 760      After the call, for instance, if the argptr string is "foo.c:123"
 761      p will point at "123".  If there is only one part, like "foo", p
 762      will point to "". If this is a C++ name, like "A::B::foo", p will
 763      point to "::B::foo". Argptr is not changed by this call.  */
 764
 765   first_half = p = locate_first_half (argptr, &is_quote_enclosed);
 766
 767   /* Check if this is an Objective-C method (anything that starts with
 768      a '+' or '-' and a '[').  */
 769   if (is_objc_method_format (p))
 770     is_objc_method = 1;
 771
 772   /* Check if the symbol could be an Objective-C selector.  */
 773
 774   {
 775     struct symtabs_and_lines values;
 776
 777     values = decode_objc (argptr, funfirstline, NULL,
 778                           canonical, saved_arg);
 779     if (values.sals != NULL)
 780       return values;
 781   }
 782
 783   /* Does it look like there actually were two parts?  */
 784
 785   if (p[0] == ':' || p[0] == '.')
 786     {
 787       /* Is it a C++ or Java compound data structure?
 788          The check on p[1] == ':' is capturing the case of "::",
 789          since p[0]==':' was checked above.
 790          Note that the call to decode_compound does everything
 791          for us, including the lookup on the symbol table, so we
 792          can return now. */
 793
 794       if (p[0] == '.' || p[1] == ':')
 795         {
 796           struct symtabs_and_lines values;
 797
 798           if (is_quote_enclosed)
 799             ++saved_arg;
 800           values = decode_compound (argptr, funfirstline, canonical,
 801                                     saved_arg, p, not_found_ptr);
 802           if (is_quoted && **argptr == '\'')
 803             *argptr = *argptr + 1;
 804           return values;
 805         }
 806
 807       /* No, the first part is a filename; set file_symtab to be that file's
 808          symtab.  Also, move argptr past the filename.  */
 809
 810       file_symtab = symtab_from_filename (argptr, p, is_quote_enclosed,
 811                                           not_found_ptr);
 812
 813       /* Check for single quotes on the non-filename part.  */
 814       if (!is_quoted)
 815         {
 816           is_quoted = (**argptr
 817                        && strchr (get_gdb_completer_quote_characters (),
 818                                   **argptr) != NULL);
 819           if (is_quoted)
 820             end_quote = skip_quoted (*argptr);
 821         }
 822     }
 823
 824   /* file_symtab is specified file's symtab, or 0 if no file specified.
 825      arg no longer contains the file name.  */
 826
 827   /* If the filename was quoted, we must re-check the quotation.  */
 828
 829   if (end_quote == first_half && *end_quote!= '\0')
 830     {
 831       is_quoted = (**argptr
 832                    && strchr (get_gdb_completer_quote_characters (),
 833                               **argptr) != NULL);
 834       if (is_quoted)
 835         end_quote = skip_quoted (*argptr);
 836     }
 837
 838   /* Check whether arg is all digits (and sign).  */
 839
 840   q = *argptr;
 841   if (*q == '-' || *q == '+')
 842     q++;
 843   while (*q >= '0' && *q <= '9')
 844     q++;
 845
 846   if (q != *argptr && (*q == 0 || *q == ' ' || *q == '\t' || *q == ','))
 847     /* We found a token consisting of all digits -- at least one digit.  */
 848     return decode_all_digits (argptr, default_symtab, default_line,
 849                               canonical, file_symtab, q);
 850
 851   /* Arg token is not digits => try it as a variable name
 852      Find the next token (everything up to end or next whitespace).  */
 853
 854   if (**argptr == '$')          /* May be a convenience variable.  */
 855     /* One or two $ chars possible.  */
 856     p = skip_quoted (*argptr + (((*argptr)[1] == '$') ? 2 : 1));
 857   else if (is_quoted)
 858     {
 859       p = end_quote;
 860       if (p[-1] != '\'')
 861         error (_("Unmatched single quote."));
 862     }
 863   else if (is_objc_method)
 864     {
 865       /* allow word separators in method names for Obj-C */
 866       p = skip_quoted_chars (*argptr, NULL, "");
 867     }
 868   else
 869     {
 870       p = skip_quoted (*argptr);
 871     }
 872
 873   /* Keep any template parameters */
 874   if (*p == '<')
 875     p = find_template_name_end (p);
 876
 877   /* Keep method overload information.  */
 878   if (*p == '(')
 879     p = find_method_overload_end (p);
 880
 881   /* Make sure we keep important kewords like "const" */
 882   if (strncmp (p, " const", 6) == 0)
 883     p += 6;
 884
 885   copy = (char *) alloca (p - *argptr + 1);
 886   memcpy (copy, *argptr, p - *argptr);
 887   copy[p - *argptr] = '\0';
 888   if (p != *argptr
 889       && copy[0]
 890       && copy[0] == copy[p - *argptr - 1]
 891       && strchr (get_gdb_completer_quote_characters (), copy[0]) != NULL)
 892     {
 893       copy[p - *argptr - 1] = '\0';
 894       copy++;
 895     }
 896   else if (is_quoted)
 897     copy[p - *argptr - 1] = '\0';
 898   while (*p == ' ' || *p == '\t')
 899     p++;
 900   *argptr = p;
 901
 902   /* If it starts with $: may be a legitimate variable or routine name
 903      (e.g. HP-UX millicode routines such as $$dyncall), or it may
 904      be history value, or it may be a convenience variable.  */
 905
 906   if (*copy == '$')
 907     return decode_dollar (copy, funfirstline, default_symtab,
 908                           canonical, file_symtab);
 909
 910   /* Try the token as a label, but only if no file was specified,
 911      because we can only really find labels in the current scope.  */
 912
 913   if (!file_symtab)
 914     {
 915       struct symtabs_and_lines label_result;
 916       if (decode_label (copy, canonical, &label_result))
 917         return label_result;
 918     }
 919
 920   /* Look up that token as a variable.
 921      If file specified, use that file's per-file block to start with.  */
 922
 923   return decode_variable (copy, funfirstline, canonical,
 924                           file_symtab, not_found_ptr);
 925 }
 926
 927 \f
 928
 929 /* Now, more helper functions for decode_line_1.  Some conventions
 930    that these functions follow:
 931
 932    Decode_line_1 typically passes along some of its arguments or local
 933    variables to the subfunctions.  It passes the variables by
 934    reference if they are modified by the subfunction, and by value
 935    otherwise.
 936
 937    Some of the functions have side effects that don't arise from
 938    variables that are passed by reference.  In particular, if a
 939    function is passed ARGPTR as an argument, it modifies what ARGPTR
 940    points to; typically, it advances *ARGPTR past whatever substring
 941    it has just looked at.  (If it doesn't modify *ARGPTR, then the
 942    function gets passed *ARGPTR instead, which is then called ARG.)
 943    Also, functions that return a struct symtabs_and_lines may modify
 944    CANONICAL, as in the description of decode_line_1.
 945
 946    If a function returns a struct symtabs_and_lines, then that struct
 947    will immediately make its way up the call chain to be returned by
 948    decode_line_1.  In particular, all of the functions decode_XXX
 949    calculate the appropriate struct symtabs_and_lines, under the
 950    assumption that their argument is of the form XXX.  */
 951
 952 /* First, some functions to initialize stuff at the beggining of the
 953    function.  */
 954
 955 static void
 956 initialize_defaults (struct symtab **default_symtab, int *default_line)
 957 {
 958   if (*default_symtab == 0)
 959     {
 960       /* Use whatever we have for the default source line.  We don't use
 961          get_current_or_default_symtab_and_line as it can recurse and call
 962          us back! */
 963       struct symtab_and_line cursal =
 964         get_current_source_symtab_and_line ();
 965
 966       *default_symtab = cursal.symtab;
 967       *default_line = cursal.line;
 968     }
 969 }
 970
 971 \f
 972
 973 /* Decode arg of the form *PC.  */
 974
 975 static struct symtabs_and_lines
 976 decode_indirect (char **argptr)
 977 {
 978   struct symtabs_and_lines values;
 979   CORE_ADDR pc;
 980
 981   (*argptr)++;
 982   pc = parse_and_eval_address_1 (argptr);
 983
 984   values.sals = (struct symtab_and_line *)
 985     xmalloc (sizeof (struct symtab_and_line));
 986
 987   values.nelts = 1;
 988   values.sals[0] = find_pc_line (pc, 0);
 989   values.sals[0].pc = pc;
 990   values.sals[0].section = find_pc_overlay (pc);
 991   values.sals[0].explicit_pc = 1;
 992
 993   return values;
 994 }
 995
 996 \f
 997
 998 /* Locate the first half of the linespec, ending in a colon, period,
 999    or whitespace.  (More or less.)  Also, check to see if *ARGPTR is
1000    enclosed in double quotes; if so, set is_quote_enclosed, advance
1001    ARGPTR past that and zero out the trailing double quote.
1002    If ARGPTR is just a simple name like "main", p will point to ""
1003    at the end.  */
1004
1005 static char *
1006 locate_first_half (char **argptr, int *is_quote_enclosed)
1007 {
1008   char *ii;
1009   char *p, *p1;
1010   int has_comma;
1011
1012   /* Maybe we were called with a line range FILENAME:LINENUM,FILENAME:LINENUM
1013      and we must isolate the first half.  Outer layers will call again later
1014      for the second half.
1015
1016      Don't count commas that appear in argument lists of overloaded
1017      functions, or in quoted strings.  It's stupid to go to this much
1018      trouble when the rest of the function is such an obvious roach hotel.  */
1019   ii = find_toplevel_char (*argptr, ',');
1020   has_comma = (ii != 0);
1021
1022   /* Temporarily zap out second half to not confuse the code below.
1023      This is undone below. Do not change ii!!  */
1024   if (has_comma)
1025     {
1026       *ii = '\0';
1027     }
1028
1029   /* Maybe arg is FILE : LINENUM or FILE : FUNCTION.  May also be
1030      CLASS::MEMBER, or NAMESPACE::NAME.  Look for ':', but ignore
1031      inside of <>.  */
1032
1033   p = *argptr;
1034   if (p[0] == '"')
1035     {
1036       *is_quote_enclosed = 1;
1037       (*argptr)++;
1038       p++;
1039     }
1040   else
1041     {
1042       *is_quote_enclosed = 0;
1043       if (strchr (get_gdb_completer_quote_characters (), *p))
1044         {
1045           ++(*argptr);
1046           ++p;
1047         }
1048     }
1049   for (; *p; p++)
1050     {
1051       if (p[0] == '<')
1052         {
1053           char *temp_end = find_template_name_end (p);
1054
1055           if (!temp_end)
1056             error (_("malformed template specification in command"));
1057           p = temp_end;
1058         }
1059       /* Check for a colon and a plus or minus and a [ (which
1060          indicates an Objective-C method) */
1061       if (is_objc_method_format (p))
1062         {
1063           break;
1064         }
1065       /* Check for the end of the first half of the linespec.  End of
1066          line, a tab, a double colon or the last single colon, or a
1067          space.  But if enclosed in double quotes we do not break on
1068          enclosed spaces.  */
1069       if (!*p
1070           || p[0] == '\t'
1071           || ((p[0] == ':')
1072               && ((p[1] == ':') || (strchr (p + 1, ':') == NULL)))
1073           || ((p[0] == ' ') && !*is_quote_enclosed))
1074         break;
1075       if (p[0] == '.' && strchr (p, ':') == NULL)
1076         {
1077           /* Java qualified method.  Find the *last* '.', since the
1078              others are package qualifiers.  Stop at any open parenthesis
1079              which might provide overload information.  */
1080           for (p1 = p; *p1 && *p1 != '('; p1++)
1081             {
1082               if (*p1 == '.')
1083                 p = p1;
1084             }
1085           break;
1086         }
1087     }
1088   while (p[0] == ' ' || p[0] == '\t')
1089     p++;
1090
1091   /* If the closing double quote was left at the end, remove it.  */
1092   if (*is_quote_enclosed)
1093     {
1094       char *closing_quote = strchr (p - 1, '"');
1095
1096       if (closing_quote && closing_quote[1] == '\0')
1097         *closing_quote = '\0';
1098     }
1099
1100   /* Now that we've safely parsed the first half, put back ',' so
1101      outer layers can see it.  */
1102   if (has_comma)
1103     *ii = ',';
1104
1105   return p;
1106 }
1107
1108 \f
1109
1110 /* Here's where we recognise an Objective-C Selector.  An Objective C
1111    selector may be implemented by more than one class, therefore it
1112    may represent more than one method/function.  This gives us a
1113    situation somewhat analogous to C++ overloading.  If there's more
1114    than one method that could represent the selector, then use some of
1115    the existing C++ code to let the user choose one.  */
1116
1117 struct symtabs_and_lines
1118 decode_objc (char **argptr, int funfirstline, struct symtab *file_symtab,
1119              char ***canonical, char *saved_arg)
1120 {
1121   struct symtabs_and_lines values;
1122   struct symbol **sym_arr = NULL;
1123   struct symbol *sym = NULL;
1124   char *copy = NULL;
1125   struct block *block = NULL;
1126   unsigned i1 = 0;
1127   unsigned i2 = 0;
1128
1129   values.sals = NULL;
1130   values.nelts = 0;
1131
1132   if (file_symtab != NULL)
1133     block = BLOCKVECTOR_BLOCK (BLOCKVECTOR (file_symtab), STATIC_BLOCK);
1134   else
1135     {
1136       enum language save_language;
1137
1138       /* get_selected_block can change the current language when there is
1139          no selected frame yet.  */
1140       save_language = current_language->la_language;
1141       block = get_selected_block (0);
1142       set_language (save_language);
1143     }
1144
1145   copy = find_imps (file_symtab, block, *argptr, NULL, &i1, &i2);
1146
1147   if (i1 > 0)
1148     {
1149       sym_arr = (struct symbol **) alloca ((i1 + 1) * sizeof (struct symbol *));
1150       sym_arr[i1] = NULL;
1151
1152       copy = find_imps (file_symtab, block, *argptr, sym_arr, &i1, &i2);
1153       *argptr = copy;
1154     }
1155
1156   /* i1 now represents the TOTAL number of matches found.
1157      i2 represents how many HIGH-LEVEL (struct symbol) matches,
1158      which will come first in the sym_arr array.  Any low-level
1159      (minimal_symbol) matches will follow those.  */
1160
1161   if (i1 == 1)
1162     {
1163       if (i2 > 0)
1164         {
1165           /* Already a struct symbol.  */
1166           sym = sym_arr[0];
1167         }
1168       else
1169         {
1170           sym = find_pc_function (SYMBOL_VALUE_ADDRESS (sym_arr[0]));
1171           if ((sym != NULL) && strcmp (SYMBOL_LINKAGE_NAME (sym_arr[0]), SYMBOL_LINKAGE_NAME (sym)) != 0)
1172             {
1173               warning (_("debugging symbol \"%s\" does not match selector; ignoring"), SYMBOL_LINKAGE_NAME (sym));
1174               sym = NULL;
1175             }
1176         }
1177
1178       values.sals = (struct symtab_and_line *) xmalloc (sizeof (struct symtab_and_line));
1179       values.nelts = 1;
1180
1181       if (sym && SYMBOL_CLASS (sym) == LOC_BLOCK)
1182         {
1183           /* Canonicalize this, so it remains resolved for dylib loads.  */
1184           values.sals[0] = find_function_start_sal (sym, funfirstline);
1185           build_canonical_line_spec (values.sals, SYMBOL_NATURAL_NAME (sym), canonical);
1186         }
1187       else
1188         {
1189           /* The only match was a non-debuggable symbol, which might point
1190              to a function descriptor; resolve it to the actual code address
1191              instead.  */
1192           struct minimal_symbol *msymbol = (struct minimal_symbol *)sym_arr[0];
1193           struct objfile *objfile = msymbol_objfile (msymbol);
1194           struct gdbarch *gdbarch = get_objfile_arch (objfile);
1195           CORE_ADDR pc = SYMBOL_VALUE_ADDRESS (msymbol);
1196
1197           pc = gdbarch_convert_from_func_ptr_addr (gdbarch, pc,
1198                                                    &current_target);
1199
1200           init_sal (&values.sals[0]);
1201           values.sals[0].pc = pc;
1202         }
1203       return values;
1204     }
1205
1206   if (i1 > 1)
1207     {
1208       /* More than one match. The user must choose one or more.  */
1209       return decode_line_2 (sym_arr, i2, funfirstline, canonical);
1210     }
1211
1212   return values;
1213 }
1214
1215 /* This handles C++ and Java compound data structures.  P should point
1216    at the first component separator, i.e. double-colon or period.  As
1217    an example, on entrance to this function we could have ARGPTR
1218    pointing to "AAA::inA::fun" and P pointing to "::inA::fun".  */
1219
1220 static struct symtabs_and_lines
1221 decode_compound (char **argptr, int funfirstline, char ***canonical,
1222                  char *saved_arg, char *p, int *not_found_ptr)
1223 {
1224   struct symtabs_and_lines values;
1225   char *p2;
1226   char *saved_arg2 = *argptr;
1227   char *temp_end;
1228   struct symbol *sym;
1229   char *copy;
1230   struct symbol *sym_class;
1231   struct type *t;
1232   char *saved_java_argptr = NULL;
1233
1234   /* First check for "global" namespace specification, of the form
1235      "::foo".  If found, skip over the colons and jump to normal
1236      symbol processing.  I.e. the whole line specification starts with
1237      "::" (note the condition that *argptr == p). */
1238   if (p[0] == ':'
1239       && ((*argptr == p) || (p[-1] == ' ') || (p[-1] == '\t')))
1240     saved_arg2 += 2;
1241
1242   /* Given our example "AAA::inA::fun", we have two cases to consider:
1243
1244      1) AAA::inA is the name of a class.  In that case, presumably it
1245         has a method called "fun"; we then look up that method using
1246         find_method.
1247
1248      2) AAA::inA isn't the name of a class.  In that case, either the
1249         user made a typo or AAA::inA is the name of a namespace.
1250         Either way, we just look up AAA::inA::fun with lookup_symbol.
1251
1252      Thus, our first task is to find everything before the last set of
1253      double-colons and figure out if it's the name of a class.  So we
1254      first loop through all of the double-colons.  */
1255
1256   p2 = p;               /* Save for restart.  */
1257
1258   /* This is very messy. Following the example above we have now the
1259      following pointers:
1260      p -> "::inA::fun"
1261      argptr -> "AAA::inA::fun
1262      saved_arg -> "AAA::inA::fun
1263      saved_arg2 -> "AAA::inA::fun
1264      p2 -> "::inA::fun". */
1265
1266   /* In the loop below, with these strings, we'll make 2 passes, each
1267      is marked in comments.*/
1268
1269   while (1)
1270     {
1271       /* Move pointer up to next possible class/namespace token.  */
1272
1273       p = p2 + 1;       /* Restart with old value +1.  */
1274
1275       /* PASS1: at this point p2->"::inA::fun", so p->":inA::fun",
1276          i.e. if there is a double-colon, p will now point to the
1277          second colon. */
1278       /* PASS2: p2->"::fun", p->":fun" */
1279
1280       /* Move pointer ahead to next double-colon.  */
1281       while (*p && (p[0] != ' ') && (p[0] != '\t') && (p[0] != '\'')
1282              && (*p != '('))
1283         {
1284           if (current_language->la_language == language_cplus)
1285             p += cp_validate_operator (p);
1286
1287           if (p[0] == '<')
1288             {
1289               temp_end = find_template_name_end (p);
1290               if (!temp_end)
1291                 error (_("malformed template specification in command"));
1292               p = temp_end;
1293             }
1294           /* Note that, since, at the start of this loop, p would be
1295              pointing to the second colon in a double-colon, we only
1296              satisfy the condition below if there is another
1297              double-colon to the right (after). I.e. there is another
1298              component that can be a class or a namespace. I.e, if at
1299              the beginning of this loop (PASS1), we had
1300              p->":inA::fun", we'll trigger this when p has been
1301              advanced to point to "::fun".  */
1302           /* PASS2: we will not trigger this. */
1303           else if ((p[0] == ':') && (p[1] == ':'))
1304             break;      /* Found double-colon.  */
1305           else
1306             /* PASS2: We'll keep getting here, until p->"", at which point
1307                we exit this loop.  */
1308             p++;
1309         }
1310
1311       if (*p != ':')
1312         break;          /* Out of the while (1).  This would happen
1313                            for instance if we have looked up
1314                            unsuccessfully all the components of the
1315                            string, and p->""(PASS2)  */
1316
1317       /* We get here if p points to ' ', '\t', '\'', "::" or ""(i.e
1318          string ended). */
1319       /* Save restart for next time around.  */
1320       p2 = p;
1321       /* Restore argptr as it was on entry to this function.  */
1322       *argptr = saved_arg2;
1323       /* PASS1: at this point p->"::fun" argptr->"AAA::inA::fun",
1324          p2->"::fun".  */
1325
1326       /* All ready for next pass through the loop.  */
1327     }                   /* while (1) */
1328
1329
1330   /* Start of lookup in the symbol tables. */
1331
1332   /* Lookup in the symbol table the substring between argptr and
1333      p. Note, this call changes the value of argptr.  */
1334   /* Before the call, argptr->"AAA::inA::fun",
1335      p->"", p2->"::fun".  After the call: argptr->"fun", p, p2
1336      unchanged.  */
1337   sym_class = lookup_prefix_sym (argptr, p2);
1338
1339   /* If sym_class has been found, and if "AAA::inA" is a class, then
1340      we're in case 1 above.  So we look up "fun" as a method of that
1341      class.  */
1342   if (sym_class &&
1343       (t = check_typedef (SYMBOL_TYPE (sym_class)),
1344        (TYPE_CODE (t) == TYPE_CODE_STRUCT
1345         || TYPE_CODE (t) == TYPE_CODE_UNION)))
1346     {
1347       /* Arg token is not digits => try it as a function name.
1348          Find the next token (everything up to end or next
1349          blank).  */
1350       if (**argptr
1351           && strchr (get_gdb_completer_quote_characters (),
1352                      **argptr) != NULL)
1353         {
1354           p = skip_quoted (*argptr);
1355           *argptr = *argptr + 1;
1356         }
1357       else
1358         {
1359           /* At this point argptr->"fun".  */
1360           char *a;
1361
1362           p = *argptr;
1363           while (*p && *p != ' ' && *p != '\t' && *p != ',' && *p != ':'
1364                  && *p != '(')
1365             p++;
1366           /* At this point p->"".  String ended.  */
1367           /* Nope, C++ operators could have spaces in them
1368              ("foo::operator <" or "foo::operator delete []").
1369              I apologize, this is a bit hacky...  */
1370           if (current_language->la_language == language_cplus
1371               && *p == ' ' && p - 8 - *argptr + 1 > 0)
1372             {
1373               /* The above loop has already swallowed "operator".  */
1374               p += cp_validate_operator (p - 8) - 8;
1375             }
1376
1377           /* Keep any template parameters */
1378           if (*p == '<')
1379             p = find_template_name_end (p);
1380
1381           /* Keep method overload information.  */
1382           a = strchr (p, '(');
1383           if (a != NULL)
1384             p = find_method_overload_end (a);
1385
1386           /* Make sure we keep important kewords like "const" */
1387           if (strncmp (p, " const", 6) == 0)
1388             p += 6;
1389
1390           /* Java may append typenames,  so assume that if there is
1391              anything else left in *argptr, it must be a typename.  */
1392           if (*p && current_language->la_language == language_java)
1393             {
1394               struct type *type;
1395
1396               p2 = p;
1397               while (*p2)
1398                 ++p2;
1399               copy = (char *) alloca (p2 - p + 1);
1400               memcpy (copy, p, p2 - p);
1401               copy[p2 - p] = '\0';
1402               type = lookup_typename (current_language, get_current_arch (),
1403                                       copy, NULL, 1);
1404               if (type != NULL)
1405                 {
1406                   /* Save the location of this just in case this
1407                      method/type combination isn't actually defined.
1408                      It will be checked later.  */
1409                   saved_java_argptr = p;
1410                   p = p2;
1411                 }
1412             }
1413         }
1414
1415       /* Allocate our own copy of the substring between argptr and
1416          p. */
1417       copy = (char *) alloca (p - *argptr + 1);
1418       memcpy (copy, *argptr, p - *argptr);
1419       copy[p - *argptr] = '\0';
1420       if (p != *argptr
1421           && copy[p - *argptr - 1]
1422           && strchr (get_gdb_completer_quote_characters (),
1423                      copy[p - *argptr - 1]) != NULL)
1424         copy[p - *argptr - 1] = '\0';
1425
1426       /* At this point copy->"fun", p->"" */
1427
1428       /* No line number may be specified.  */
1429       while (*p == ' ' || *p == '\t')
1430         p++;
1431       *argptr = p;
1432       /* At this point arptr->"".  */
1433
1434       /* Look for copy as a method of sym_class. */
1435       /* At this point copy->"fun", sym_class is "AAA:inA",
1436          saved_arg->"AAA::inA::fun".  This concludes the scanning of
1437          the string for possible components matches.  If we find it
1438          here, we return. If not, and we are at the and of the string,
1439          we'll lookup the whole string in the symbol tables.  */
1440
1441       values = find_method (funfirstline, canonical, saved_arg,
1442                             copy, t, sym_class, not_found_ptr);
1443       if (saved_java_argptr != NULL && values.nelts == 1)
1444         {
1445           /* The user specified a specific return type for a java method.
1446              Double-check that it really is the one the user specified.
1447              [This is a necessary evil because strcmp_iw_ordered stops
1448              comparisons too prematurely.]  */
1449           sym = find_pc_sect_function (values.sals[0].pc,
1450                                        values.sals[0].section);
1451           /* We just found a SAL, we had better be able to go backwards!  */
1452           gdb_assert (sym != NULL);
1453           if (strcmp_iw (SYMBOL_LINKAGE_NAME (sym), saved_arg) != 0)
1454             {
1455               xfree (values.sals);
1456               error (_("the class `%s' does not have any method instance named %s\n"),
1457                      SYMBOL_PRINT_NAME (sym_class), copy);
1458             }
1459         }
1460       return values;
1461     } /* End if symbol found */
1462
1463
1464   /* We couldn't find a class, so we're in case 2 above.  We check the
1465      entire name as a symbol instead.  */
1466
1467   copy = (char *) alloca (p - saved_arg2 + 1);
1468   memcpy (copy, saved_arg2, p - saved_arg2);
1469   /* Note: if is_quoted should be true, we snuff out quote here
1470      anyway.  */
1471   copy[p - saved_arg2] = '\000';
1472   /* Set argptr to skip over the name.  */
1473   *argptr = (*p == '\'') ? p + 1 : p;
1474
1475   /* Look up entire name */
1476   sym = lookup_symbol (copy, 0, VAR_DOMAIN, 0);
1477   if (sym)
1478     return symbol_found (funfirstline, canonical, copy, sym, NULL);
1479
1480   /* Couldn't find any interpretation as classes/namespaces, so give
1481      up.  The quotes are important if copy is empty.  */
1482   if (not_found_ptr)
1483     *not_found_ptr = 1;
1484   cplusplus_error (saved_arg,
1485                    "Can't find member of namespace, class, struct, or union named \"%s\"\n",
1486                    copy);
1487 }
1488
1489 /* Next come some helper functions for decode_compound.  */
1490
1491 /* Return the symbol corresponding to the substring of *ARGPTR ending
1492    at P, allowing whitespace.  Also, advance *ARGPTR past the symbol
1493    name in question, the compound object separator ("::" or "."), and
1494    whitespace.  Note that *ARGPTR is changed whether or not the
1495    lookup_symbol call finds anything (i.e we return NULL).  As an
1496    example, say ARGPTR is "AAA::inA::fun" and P is "::inA::fun".  */
1497
1498 static struct symbol *
1499 lookup_prefix_sym (char **argptr, char *p)
1500 {
1501   char *p1;
1502   char *copy;
1503   struct symbol *sym;
1504
1505   /* Extract the class name.  */
1506   p1 = p;
1507   while (p != *argptr && p[-1] == ' ')
1508     --p;
1509   copy = (char *) alloca (p - *argptr + 1);
1510   memcpy (copy, *argptr, p - *argptr);
1511   copy[p - *argptr] = 0;
1512
1513   /* Discard the class name from the argptr.  */
1514   p = p1 + (p1[0] == ':' ? 2 : 1);
1515   while (*p == ' ' || *p == '\t')
1516     p++;
1517   *argptr = p;
1518
1519   /* At this point p1->"::inA::fun", p->"inA::fun" copy->"AAA",
1520      argptr->"inA::fun" */
1521
1522   sym = lookup_symbol (copy, 0, STRUCT_DOMAIN, 0);
1523   if (sym == NULL)
1524     {
1525       /* Typedefs are in VAR_DOMAIN so the above symbol lookup will
1526          fail when the user attempts to lookup a method of a class
1527          via a typedef'd name (NOT via the class's name, which is already
1528          handled in symbol_matches_domain).  So try the lookup again
1529          using VAR_DOMAIN (where typedefs live) and double-check that we
1530          found a struct/class type.  */
1531       struct symbol *s = lookup_symbol (copy, 0, VAR_DOMAIN, 0);
1532
1533       if (s != NULL)
1534         {
1535           struct type *t = SYMBOL_TYPE (s);
1536
1537           CHECK_TYPEDEF (t);
1538           if (TYPE_CODE (t) == TYPE_CODE_STRUCT)
1539             return s;
1540         }
1541     }
1542
1543   return sym;
1544 }
1545
1546 /* This finds the method COPY in the class whose type is T and whose
1547    symbol is SYM_CLASS.  */
1548
1549 static struct symtabs_and_lines
1550 find_method (int funfirstline, char ***canonical, char *saved_arg,
1551              char *copy, struct type *t, struct symbol *sym_class, int *not_found_ptr)
1552 {
1553   struct symtabs_and_lines values;
1554   struct symbol *sym = NULL;
1555   int i1;       /*  Counter for the symbol array.  */
1556   struct symbol **sym_arr =  alloca (total_number_of_methods (t)
1557                                      * sizeof (struct symbol *));
1558
1559   /* Find all methods with a matching name, and put them in
1560      sym_arr.  */
1561
1562   i1 = find_methods (t, copy, SYMBOL_LANGUAGE (sym_class), sym_arr);
1563
1564   if (i1 == 1)
1565     {
1566       /* There is exactly one field with that name.  */
1567       sym = sym_arr[0];
1568
1569       if (sym && SYMBOL_CLASS (sym) == LOC_BLOCK)
1570         {
1571           values.sals = (struct symtab_and_line *)
1572             xmalloc (sizeof (struct symtab_and_line));
1573           values.nelts = 1;
1574           values.sals[0] = find_function_start_sal (sym,
1575                                                     funfirstline);
1576         }
1577       else
1578         {
1579           values.sals = NULL;
1580           values.nelts = 0;
1581         }
1582       return values;
1583     }
1584   if (i1 > 0)
1585     {
1586       /* If we were given a specific overload instance, use that
1587          (or error if no matches were found).  Otherwise ask the user
1588          which one to use.  */
1589       if (strchr (saved_arg, '(') != NULL)
1590         {
1591           int i;
1592           char *name = saved_arg;
1593           char *canon = cp_canonicalize_string (name);
1594           struct cleanup *cleanup;
1595
1596           if (canon != NULL)
1597             {
1598               name = canon;
1599               cleanup = make_cleanup (xfree, canon);
1600             }
1601           else
1602             cleanup = make_cleanup (null_cleanup, NULL);
1603
1604           for (i = 0; i < i1; ++i)
1605             {
1606               if (strcmp_iw (name, SYMBOL_LINKAGE_NAME (sym_arr[i])) == 0)
1607                 {
1608                   values.sals = (struct symtab_and_line *)
1609                     xmalloc (sizeof (struct symtab_and_line));
1610                   values.nelts = 1;
1611                   values.sals[0] = find_function_start_sal (sym_arr[i],
1612                                                             funfirstline);
1613                   do_cleanups (cleanup);
1614                   return values;
1615                 }
1616             }
1617
1618           error (_("the class `%s' does not have any method instance named %s\n"),
1619                  SYMBOL_PRINT_NAME (sym_class), copy);
1620         }
1621
1622       return decode_line_2 (sym_arr, i1, funfirstline, canonical);
1623     }
1624   else
1625     {
1626       if (not_found_ptr)
1627         *not_found_ptr = 1;
1628       if (copy[0] == '~')
1629         cplusplus_error (saved_arg,
1630                          "the class `%s' does not have destructor defined\n",
1631                          SYMBOL_PRINT_NAME (sym_class));
1632       else
1633         cplusplus_error (saved_arg,
1634                          "the class %s does not have any method named %s\n",
1635                          SYMBOL_PRINT_NAME (sym_class), copy);
1636     }
1637 }
1638
1639 \f
1640
1641 /* Return the symtab associated to the filename given by the substring
1642    of *ARGPTR ending at P, and advance ARGPTR past that filename.  If
1643    NOT_FOUND_PTR is not null and the source file is not found, store
1644    boolean true at the location pointed to and do not issue an
1645    error message.  */
1646
1647 static struct symtab *
1648 symtab_from_filename (char **argptr, char *p, int is_quote_enclosed,
1649                       int *not_found_ptr)
1650 {
1651   char *p1;
1652   char *copy;
1653   struct symtab *file_symtab;
1654
1655   p1 = p;
1656   while (p != *argptr && p[-1] == ' ')
1657     --p;
1658   if ((*p == '"') && is_quote_enclosed)
1659     --p;
1660   copy = (char *) alloca (p - *argptr + 1);
1661   memcpy (copy, *argptr, p - *argptr);
1662   /* It may have the ending quote right after the file name.  */
1663   if ((is_quote_enclosed && copy[p - *argptr - 1] == '"')
1664       || copy[p - *argptr - 1] == '\'')
1665     copy[p - *argptr - 1] = 0;
1666   else
1667     copy[p - *argptr] = 0;
1668
1669   /* Find that file's data.  */
1670   file_symtab = lookup_symtab (copy);
1671   if (file_symtab == 0)
1672     {
1673       if (not_found_ptr)
1674         *not_found_ptr = 1;
1675       if (!have_full_symbols () && !have_partial_symbols ())
1676         throw_error (NOT_FOUND_ERROR,
1677                      _("No symbol table is loaded.  Use the \"file\" command."));
1678       throw_error (NOT_FOUND_ERROR, _("No source file named %s."), copy);
1679     }
1680
1681   /* Discard the file name from the arg.  */
1682   p = p1 + 1;
1683   while (*p == ' ' || *p == '\t')
1684     p++;
1685   *argptr = p;
1686
1687   return file_symtab;
1688 }
1689
1690 \f
1691
1692 /* This decodes a line where the argument is all digits (possibly
1693    preceded by a sign).  Q should point to the end of those digits;
1694    the other arguments are as usual.  */
1695
1696 static struct symtabs_and_lines
1697 decode_all_digits (char **argptr, struct symtab *default_symtab,
1698                    int default_line, char ***canonical,
1699                    struct symtab *file_symtab, char *q)
1700
1701 {
1702   struct symtabs_and_lines values;
1703   struct symtab_and_line val;
1704
1705   enum sign
1706     {
1707       none, plus, minus
1708     }
1709   sign = none;
1710
1711   /* We might need a canonical line spec if no file was specified.  */
1712   int need_canonical = (file_symtab == NULL) ? 1 : 0;
1713
1714   init_sal (&val);
1715
1716   val.pspace = current_program_space;
1717
1718   /* This is where we need to make sure that we have good defaults.
1719      We must guarantee that this section of code is never executed
1720      when we are called with just a function name, since
1721      set_default_source_symtab_and_line uses
1722      select_source_symtab that calls us with such an argument.  */
1723
1724   if (file_symtab == 0 && default_symtab == 0)
1725     {
1726       /* Make sure we have at least a default source file.  */
1727       set_default_source_symtab_and_line ();
1728       initialize_defaults (&default_symtab, &default_line);
1729     }
1730
1731   if (**argptr == '+')
1732     sign = plus, (*argptr)++;
1733   else if (**argptr == '-')
1734     sign = minus, (*argptr)++;
1735   val.line = atoi (*argptr);
1736   switch (sign)
1737     {
1738     case plus:
1739       if (q == *argptr)
1740         val.line = 5;
1741       if (file_symtab == 0)
1742         val.line = default_line + val.line;
1743       break;
1744     case minus:
1745       if (q == *argptr)
1746         val.line = 15;
1747       if (file_symtab == 0)
1748         val.line = default_line - val.line;
1749       else
1750         val.line = 1;
1751       break;
1752     case none:
1753       break;            /* No need to adjust val.line.  */
1754     }
1755
1756   while (*q == ' ' || *q == '\t')
1757     q++;
1758   *argptr = q;
1759   if (file_symtab == 0)
1760     file_symtab = default_symtab;
1761
1762   /* It is possible that this source file has more than one symtab,
1763      and that the new line number specification has moved us from the
1764      default (in file_symtab) to a new one.  */
1765   val.symtab = find_line_symtab (file_symtab, val.line, NULL, NULL);
1766   if (val.symtab == 0)
1767     val.symtab = file_symtab;
1768
1769   val.pspace = SYMTAB_PSPACE (val.symtab);
1770   val.pc = 0;
1771   values.sals = (struct symtab_and_line *)
1772     xmalloc (sizeof (struct symtab_and_line));
1773   values.sals[0] = val;
1774   values.nelts = 1;
1775   if (need_canonical)
1776     build_canonical_line_spec (values.sals, NULL, canonical);
1777   values.sals[0].explicit_line = 1;
1778   return values;
1779 }
1780
1781 \f
1782
1783 /* Decode a linespec starting with a dollar sign.  */
1784
1785 static struct symtabs_and_lines
1786 decode_dollar (char *copy, int funfirstline, struct symtab *default_symtab,
1787                char ***canonical, struct symtab *file_symtab)
1788 {
1789   LONGEST valx;
1790   int index = 0;
1791   int need_canonical = 0;
1792   struct symtabs_and_lines values;
1793   struct symtab_and_line val;
1794   char *p;
1795   struct symbol *sym;
1796   struct minimal_symbol *msymbol;
1797
1798   p = (copy[1] == '$') ? copy + 2 : copy + 1;
1799   while (*p >= '0' && *p <= '9')
1800     p++;
1801   if (!*p)              /* Reached end of token without hitting non-digit.  */
1802     {
1803       /* We have a value history reference.  */
1804       struct value *val_history;
1805
1806       sscanf ((copy[1] == '$') ? copy + 2 : copy + 1, "%d", &index);
1807       val_history = access_value_history ((copy[1] == '$') ? -index : index);
1808       if (TYPE_CODE (value_type (val_history)) != TYPE_CODE_INT)
1809         error (_("History values used in line specs must have integer values."));
1810       valx = value_as_long (val_history);
1811     }
1812   else
1813     {
1814       /* Not all digits -- may be user variable/function or a
1815          convenience variable.  */
1816
1817       /* Look up entire name as a symbol first.  */
1818       sym = lookup_symbol (copy, 0, VAR_DOMAIN, 0);
1819       file_symtab = (struct symtab *) NULL;
1820       need_canonical = 1;
1821       /* Symbol was found --> jump to normal symbol processing.  */
1822       if (sym)
1823         return symbol_found (funfirstline, canonical, copy, sym, NULL);
1824
1825       /* If symbol was not found, look in minimal symbol tables.  */
1826       msymbol = lookup_minimal_symbol (copy, NULL, NULL);
1827       /* Min symbol was found --> jump to minsym processing.  */
1828       if (msymbol)
1829         return minsym_found (funfirstline, msymbol);
1830
1831       /* Not a user variable or function -- must be convenience variable.  */
1832       if (!get_internalvar_integer (lookup_internalvar (copy + 1), &valx))
1833         error (_("Convenience variables used in line specs must have integer values."));
1834     }
1835
1836   init_sal (&val);
1837
1838   /* Either history value or convenience value from above, in valx.  */
1839   val.symtab = file_symtab ? file_symtab : default_symtab;
1840   val.line = valx;
1841   val.pc = 0;
1842   val.pspace = current_program_space;
1843
1844   values.sals = (struct symtab_and_line *) xmalloc (sizeof val);
1845   values.sals[0] = val;
1846   values.nelts = 1;
1847
1848   if (need_canonical)
1849     build_canonical_line_spec (values.sals, NULL, canonical);
1850
1851   return values;
1852 }
1853
1854 \f
1855
1856 /* A helper for decode_line_1 that tries to find a label.  The label
1857    is searched for in the current block.
1858    COPY is the name of the label to find.
1859    CANONICAL is the same as the "canonical" argument to decode_line_1.
1860    RESULT is a pointer to a symtabs_and_lines structure which will be
1861    filled in on success.
1862    This function returns 1 if a label was found, 0 otherwise.  */
1863
1864 static int
1865 decode_label (char *copy, char ***canonical, struct symtabs_and_lines *result)
1866 {
1867   struct symbol *sym;
1868
1869   sym = lookup_symbol (copy, get_selected_block (0), LABEL_DOMAIN, 0);
1870
1871   if (sym != NULL)
1872     *result = symbol_found (0, canonical, copy, sym, NULL);
1873
1874   return sym != NULL;
1875 }
1876
1877 /* Decode a linespec that's a variable.  If FILE_SYMTAB is non-NULL,
1878    look in that symtab's static variables first.  If NOT_FOUND_PTR is not NULL and
1879    the function cannot be found, store boolean true in the location pointed to
1880    and do not issue an error message.  */
1881
1882 static struct symtabs_and_lines
1883 decode_variable (char *copy, int funfirstline, char ***canonical,
1884                  struct symtab *file_symtab, int *not_found_ptr)
1885 {
1886   struct symbol *sym;
1887   struct minimal_symbol *msymbol;
1888
1889   sym = lookup_symbol (copy,
1890                        (file_symtab
1891                         ? BLOCKVECTOR_BLOCK (BLOCKVECTOR (file_symtab),
1892                                              STATIC_BLOCK)
1893                         : get_selected_block (0)),
1894                        VAR_DOMAIN, 0);
1895
1896   if (sym != NULL)
1897     return symbol_found (funfirstline, canonical, copy, sym, file_symtab);
1898
1899   msymbol = lookup_minimal_symbol (copy, NULL, NULL);
1900
1901   if (msymbol != NULL)
1902     return minsym_found (funfirstline, msymbol);
1903
1904   if (not_found_ptr)
1905     *not_found_ptr = 1;
1906
1907   if (!have_full_symbols ()
1908       && !have_partial_symbols ()
1909       && !have_minimal_symbols ())
1910     throw_error (NOT_FOUND_ERROR,
1911                  _("No symbol table is loaded.  Use the \"file\" command."));
1912   throw_error (NOT_FOUND_ERROR, _("Function \"%s\" not defined."), copy);
1913 }
1914
1915
1916 \f
1917
1918 /* Now come some functions that are called from multiple places within
1919    decode_line_1.  */
1920
1921 /* We've found a symbol SYM to associate with our linespec; build a
1922    corresponding struct symtabs_and_lines.  */
1923
1924 static struct symtabs_and_lines
1925 symbol_found (int funfirstline, char ***canonical, char *copy,
1926               struct symbol *sym, struct symtab *file_symtab)
1927 {
1928   struct symtabs_and_lines values;
1929
1930   if (SYMBOL_CLASS (sym) == LOC_BLOCK)
1931     {
1932       /* Arg is the name of a function */
1933       values.sals = (struct symtab_and_line *)
1934         xmalloc (sizeof (struct symtab_and_line));
1935       values.sals[0] = find_function_start_sal (sym, funfirstline);
1936       values.nelts = 1;
1937
1938       /* Don't use the SYMBOL_LINE; if used at all it points to
1939          the line containing the parameters or thereabouts, not
1940          the first line of code.  */
1941
1942       /* We might need a canonical line spec if it is a static
1943          function.  */
1944       if (file_symtab == 0)
1945         {
1946           struct blockvector *bv = BLOCKVECTOR (SYMBOL_SYMTAB (sym));
1947           struct block *b = BLOCKVECTOR_BLOCK (bv, STATIC_BLOCK);
1948
1949           if (lookup_block_symbol (b, copy, VAR_DOMAIN) != NULL)
1950             build_canonical_line_spec (values.sals, copy, canonical);
1951         }
1952       return values;
1953     }
1954   else
1955     {
1956       if (funfirstline && SYMBOL_CLASS (sym) != LOC_LABEL)
1957         error (_("\"%s\" is not a function"), copy);
1958       else if (SYMBOL_LINE (sym) != 0)
1959         {
1960           /* We know its line number.  */
1961           values.sals = (struct symtab_and_line *)
1962             xmalloc (sizeof (struct symtab_and_line));
1963           values.nelts = 1;
1964           memset (&values.sals[0], 0, sizeof (values.sals[0]));
1965           values.sals[0].symtab = SYMBOL_SYMTAB (sym);
1966           values.sals[0].line = SYMBOL_LINE (sym);
1967           values.sals[0].pspace = SYMTAB_PSPACE (SYMBOL_SYMTAB (sym));
1968           return values;
1969         }
1970       else
1971         /* This can happen if it is compiled with a compiler which doesn't
1972            put out line numbers for variables.  */
1973         /* FIXME: Shouldn't we just set .line and .symtab to zero
1974            and return?  For example, "info line foo" could print
1975            the address.  */
1976         error (_("Line number not known for symbol \"%s\""), copy);
1977     }
1978 }
1979
1980 /* We've found a minimal symbol MSYMBOL to associate with our
1981    linespec; build a corresponding struct symtabs_and_lines.  */
1982
1983 static struct symtabs_and_lines
1984 minsym_found (int funfirstline, struct minimal_symbol *msymbol)
1985 {
1986   struct objfile *objfile = msymbol_objfile (msymbol);
1987   struct gdbarch *gdbarch = get_objfile_arch (objfile);
1988   struct symtabs_and_lines values;
1989   CORE_ADDR pc;
1990
1991   values.sals = (struct symtab_and_line *)
1992     xmalloc (sizeof (struct symtab_and_line));
1993   values.sals[0] = find_pc_sect_line (SYMBOL_VALUE_ADDRESS (msymbol),
1994                                       (struct obj_section *) 0, 0);
1995   values.sals[0].section = SYMBOL_OBJ_SECTION (msymbol);
1996
1997   /* The minimal symbol might point to a function descriptor;
1998      resolve it to the actual code address instead.  */
1999   pc = gdbarch_convert_from_func_ptr_addr (gdbarch,
2000                                            values.sals[0].pc,
2001                                            &current_target);
2002   if (pc != values.sals[0].pc)
2003     values.sals[0] = find_pc_sect_line (pc, NULL, 0);
2004
2005   if (funfirstline)
2006     skip_prologue_sal (&values.sals[0]);
2007
2008   values.nelts = 1;
2009   return values;
2010 }