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, 2011 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 (_("canceled because the command is ambiguous\n"
 498              "See set/show multiple-symbol."));
 499
 500   values.sals = (struct symtab_and_line *)
 501     alloca (nelts * sizeof (struct symtab_and_line));
 502   return_values.sals = (struct symtab_and_line *)
 503     xmalloc (nelts * sizeof (struct symtab_and_line));
 504   old_chain = make_cleanup (xfree, return_values.sals);
 505
 506   if (canonical)
 507     {
 508       canonical_arr = (char **) xmalloc (nelts * sizeof (char *));
 509       make_cleanup (xfree, canonical_arr);
 510       memset (canonical_arr, 0, nelts * sizeof (char *));
 511       *canonical = canonical_arr;
 512     }
 513
 514   i = 0;
 515   while (i < nelts)
 516     {
 517       init_sal (&return_values.sals[i]);        /* Initialize to zeroes.  */
 518       init_sal (&values.sals[i]);
 519       if (sym_arr[i] && SYMBOL_CLASS (sym_arr[i]) == LOC_BLOCK)
 520         values.sals[i] = find_function_start_sal (sym_arr[i], funfirstline);
 521       i++;
 522     }
 523
 524   /* If select_mode is "all", then do not print the multiple-choice
 525      menu and act as if the user had chosen choice "1" (all).  */
 526   if (select_mode == multiple_symbols_all
 527       || ui_out_is_mi_like_p (interp_ui_out (top_level_interpreter ())))
 528     args = "1";
 529   else
 530     {
 531       i = 0;
 532       printf_unfiltered (_("[0] cancel\n[1] all\n"));
 533       while (i < nelts)
 534         {
 535           if (sym_arr[i] && SYMBOL_CLASS (sym_arr[i]) == LOC_BLOCK)
 536             {
 537               if (values.sals[i].symtab)
 538                 printf_unfiltered ("[%d] %s at %s:%d\n",
 539                                    (i + 2),
 540                                    SYMBOL_PRINT_NAME (sym_arr[i]),
 541                                    values.sals[i].symtab->filename,
 542                                    values.sals[i].line);
 543               else
 544                 printf_unfiltered (_("[%d] %s at ?FILE:%d [No symtab? "
 545                                      "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"),
 623                                  num);
 624             }
 625         }
 626
 627       args = arg1;
 628       while (*args == ' ' || *args == '\t')
 629         args++;
 630     }
 631   return_values.nelts = i;
 632   discard_cleanups (old_chain);
 633   return return_values;
 634 }
 635
 636 /* A helper function for decode_line_1 and friends which skips P
 637    past any method overload information at the beginning of P, e.g.,
 638    "(const struct foo *)".
 639
 640    This function assumes that P has already been validated to contain
 641    overload information, and it will assert if *P != '('.  */
 642 static char *
 643 find_method_overload_end (char *p)
 644 {
 645   int depth = 0;
 646
 647   gdb_assert (*p == '(');
 648
 649   while (*p)
 650     {
 651       if (*p == '(')
 652         ++depth;
 653       else if (*p == ')')
 654         {
 655           if (--depth == 0)
 656             {
 657               ++p;
 658               break;
 659             }
 660         }
 661       ++p;
 662     }
 663
 664   return p;
 665 }
 666 \f
 667 /* The parser of linespec itself. */
 668
 669 /* Parse a string that specifies a line number.
 670    Pass the address of a char * variable; that variable will be
 671    advanced over the characters actually parsed.
 672
 673    The string can be:
 674
 675    LINENUM -- that line number in current file.  PC returned is 0.
 676    FILE:LINENUM -- that line in that file.  PC returned is 0.
 677    FUNCTION -- line number of openbrace of that function.
 678    PC returned is the start of the function.
 679    LABEL -- a label in the current scope
 680    VARIABLE -- line number of definition of that variable.
 681    PC returned is 0.
 682    FILE:FUNCTION -- likewise, but prefer functions in that file.
 683    *EXPR -- line in which address EXPR appears.
 684
 685    This may all be followed by an "if EXPR", which we ignore.
 686
 687    FUNCTION may be an undebuggable function found in minimal symbol table.
 688
 689    If the argument FUNFIRSTLINE is nonzero, we want the first line
 690    of real code inside a function when a function is specified, and it is
 691    not OK to specify a variable or type to get its line number.
 692
 693    DEFAULT_SYMTAB specifies the file to use if none is specified.
 694    It defaults to current_source_symtab.
 695    DEFAULT_LINE specifies the line number to use for relative
 696    line numbers (that start with signs).  Defaults to current_source_line.
 697    If CANONICAL is non-NULL, store an array of strings containing the canonical
 698    line specs there if necessary. Currently overloaded member functions and
 699    line numbers or static functions without a filename yield a canonical
 700    line spec. The array and the line spec strings are allocated on the heap,
 701    it is the callers responsibility to free them.
 702
 703    Note that it is possible to return zero for the symtab
 704    if no file is validly specified.  Callers must check that.
 705    Also, the line number returned may be invalid.
 706
 707    If NOT_FOUND_PTR is not null, store a boolean true/false value at
 708    the location, based on whether or not failure occurs due to an
 709    unknown function or file.  In the case where failure does occur due
 710    to an unknown function or file, do not issue an error message.  */
 711
 712 /* We allow single quotes in various places.  This is a hideous
 713    kludge, which exists because the completer can't yet deal with the
 714    lack of single quotes.  FIXME: write a linespec_completer which we
 715    can use as appropriate instead of make_symbol_completion_list.  */
 716
 717 struct symtabs_and_lines
 718 decode_line_1 (char **argptr, int funfirstline, struct symtab *default_symtab,
 719                int default_line, char ***canonical, int *not_found_ptr)
 720 {
 721   char *p;
 722   char *q;
 723   /* If a file name is specified, this is its symtab.  */
 724   struct symtab *file_symtab = NULL;
 725
 726   char *copy;
 727   /* This says whether or not something in *ARGPTR is quoted with
 728      completer_quotes (i.e. with single quotes).  */
 729   int is_quoted;
 730   /* Is *ARGPTR is enclosed in double quotes?  */
 731   int is_quote_enclosed;
 732   int is_objc_method = 0;
 733   char *saved_arg = *argptr;
 734   /* If IS_QUOTED, the end of the quoted bit.  */
 735   char *end_quote = NULL;
 736   /* The "first half" of the linespec.  */
 737   char *first_half;
 738
 739   if (not_found_ptr)
 740     *not_found_ptr = 0;
 741
 742   /* Defaults have defaults.  */
 743
 744   initialize_defaults (&default_symtab, &default_line);
 745
 746   /* See if arg is *PC.  */
 747
 748   if (**argptr == '*')
 749     return decode_indirect (argptr);
 750
 751   is_quoted = (*argptr
 752                && strchr (get_gdb_completer_quote_characters (),
 753                           **argptr) != NULL);
 754   if (is_quoted)
 755     end_quote = skip_quoted (*argptr);
 756
 757   /* Check to see if it's a multipart linespec (with colons or
 758      periods).  */
 759
 760   /* Locate the end of the first half of the linespec.
 761      After the call, for instance, if the argptr string is "foo.c:123"
 762      p will point at "123".  If there is only one part, like "foo", p
 763      will point to "". If this is a C++ name, like "A::B::foo", p will
 764      point to "::B::foo". Argptr is not changed by this call.  */
 765
 766   first_half = p = locate_first_half (argptr, &is_quote_enclosed);
 767
 768   /* Check if this is an Objective-C method (anything that starts with
 769      a '+' or '-' and a '[').  */
 770   if (is_objc_method_format (p))
 771     is_objc_method = 1;
 772
 773   /* Check if the symbol could be an Objective-C selector.  */
 774
 775   {
 776     struct symtabs_and_lines values;
 777
 778     values = decode_objc (argptr, funfirstline, NULL,
 779                           canonical, saved_arg);
 780     if (values.sals != NULL)
 781       return values;
 782   }
 783
 784   /* Does it look like there actually were two parts?  */
 785
 786   if (p[0] == ':' || p[0] == '.')
 787     {
 788       /* Is it a C++ or Java compound data structure?
 789          The check on p[1] == ':' is capturing the case of "::",
 790          since p[0]==':' was checked above.
 791          Note that the call to decode_compound does everything
 792          for us, including the lookup on the symbol table, so we
 793          can return now. */
 794
 795       if (p[0] == '.' || p[1] == ':')
 796         {
 797           struct symtabs_and_lines values;
 798
 799           if (is_quote_enclosed)
 800             ++saved_arg;
 801           values = decode_compound (argptr, funfirstline, canonical,
 802                                     saved_arg, p, not_found_ptr);
 803           if (is_quoted && **argptr == '\'')
 804             *argptr = *argptr + 1;
 805           return values;
 806         }
 807
 808       /* No, the first part is a filename; set file_symtab to be that file's
 809          symtab.  Also, move argptr past the filename.  */
 810
 811       file_symtab = symtab_from_filename (argptr, p, is_quote_enclosed,
 812                                           not_found_ptr);
 813
 814       /* Check for single quotes on the non-filename part.  */
 815       if (!is_quoted)
 816         {
 817           is_quoted = (**argptr
 818                        && strchr (get_gdb_completer_quote_characters (),
 819                                   **argptr) != NULL);
 820           if (is_quoted)
 821             end_quote = skip_quoted (*argptr);
 822         }
 823     }
 824
 825   /* file_symtab is specified file's symtab, or 0 if no file specified.
 826      arg no longer contains the file name.  */
 827
 828   /* If the filename was quoted, we must re-check the quotation.  */
 829
 830   if (end_quote == first_half && *end_quote!= '\0')
 831     {
 832       is_quoted = (**argptr
 833                    && strchr (get_gdb_completer_quote_characters (),
 834                               **argptr) != NULL);
 835       if (is_quoted)
 836         end_quote = skip_quoted (*argptr);
 837     }
 838
 839   /* Check whether arg is all digits (and sign).  */
 840
 841   q = *argptr;
 842   if (*q == '-' || *q == '+')
 843     q++;
 844   while (*q >= '0' && *q <= '9')
 845     q++;
 846
 847   if (q != *argptr && (*q == 0 || *q == ' ' || *q == '\t' || *q == ','))
 848     /* We found a token consisting of all digits -- at least one digit.  */
 849     return decode_all_digits (argptr, default_symtab, default_line,
 850                               canonical, file_symtab, q);
 851
 852   /* Arg token is not digits => try it as a variable name
 853      Find the next token (everything up to end or next whitespace).  */
 854
 855   if (**argptr == '$')          /* May be a convenience variable.  */
 856     /* One or two $ chars possible.  */
 857     p = skip_quoted (*argptr + (((*argptr)[1] == '$') ? 2 : 1));
 858   else if (is_quoted)
 859     {
 860       p = end_quote;
 861       if (p[-1] != '\'')
 862         error (_("Unmatched single quote."));
 863     }
 864   else if (is_objc_method)
 865     {
 866       /* allow word separators in method names for Obj-C */
 867       p = skip_quoted_chars (*argptr, NULL, "");
 868     }
 869   else
 870     {
 871       p = skip_quoted (*argptr);
 872     }
 873
 874   /* Keep any template parameters */
 875   if (*p == '<')
 876     p = find_template_name_end (p);
 877
 878   /* Keep method overload information.  */
 879   if (*p == '(')
 880     p = find_method_overload_end (p);
 881
 882   /* Make sure we keep important kewords like "const" */
 883   if (strncmp (p, " const", 6) == 0)
 884     p += 6;
 885
 886   copy = (char *) alloca (p - *argptr + 1);
 887   memcpy (copy, *argptr, p - *argptr);
 888   copy[p - *argptr] = '\0';
 889   if (p != *argptr
 890       && copy[0]
 891       && copy[0] == copy[p - *argptr - 1]
 892       && strchr (get_gdb_completer_quote_characters (), copy[0]) != NULL)
 893     {
 894       copy[p - *argptr - 1] = '\0';
 895       copy++;
 896     }
 897   else if (is_quoted)
 898     copy[p - *argptr - 1] = '\0';
 899   while (*p == ' ' || *p == '\t')
 900     p++;
 901   *argptr = p;
 902
 903   /* If it starts with $: may be a legitimate variable or routine name
 904      (e.g. HP-UX millicode routines such as $$dyncall), or it may
 905      be history value, or it may be a convenience variable.  */
 906
 907   if (*copy == '$')
 908     return decode_dollar (copy, funfirstline, default_symtab,
 909                           canonical, file_symtab);
 910
 911   /* Try the token as a label, but only if no file was specified,
 912      because we can only really find labels in the current scope.  */
 913
 914   if (!file_symtab)
 915     {
 916       struct symtabs_and_lines label_result;
 917       if (decode_label (copy, canonical, &label_result))
 918         return label_result;
 919     }
 920
 921   /* Look up that token as a variable.
 922      If file specified, use that file's per-file block to start with.  */
 923
 924   return decode_variable (copy, funfirstline, canonical,
 925                           file_symtab, not_found_ptr);
 926 }
 927
 928 \f
 929
 930 /* Now, more helper functions for decode_line_1.  Some conventions
 931    that these functions follow:
 932
 933    Decode_line_1 typically passes along some of its arguments or local
 934    variables to the subfunctions.  It passes the variables by
 935    reference if they are modified by the subfunction, and by value
 936    otherwise.
 937
 938    Some of the functions have side effects that don't arise from
 939    variables that are passed by reference.  In particular, if a
 940    function is passed ARGPTR as an argument, it modifies what ARGPTR
 941    points to; typically, it advances *ARGPTR past whatever substring
 942    it has just looked at.  (If it doesn't modify *ARGPTR, then the
 943    function gets passed *ARGPTR instead, which is then called ARG.)
 944    Also, functions that return a struct symtabs_and_lines may modify
 945    CANONICAL, as in the description of decode_line_1.
 946
 947    If a function returns a struct symtabs_and_lines, then that struct
 948    will immediately make its way up the call chain to be returned by
 949    decode_line_1.  In particular, all of the functions decode_XXX
 950    calculate the appropriate struct symtabs_and_lines, under the
 951    assumption that their argument is of the form XXX.  */
 952
 953 /* First, some functions to initialize stuff at the beggining of the
 954    function.  */
 955
 956 static void
 957 initialize_defaults (struct symtab **default_symtab, int *default_line)
 958 {
 959   if (*default_symtab == 0)
 960     {
 961       /* Use whatever we have for the default source line.  We don't use
 962          get_current_or_default_symtab_and_line as it can recurse and call
 963          us back! */
 964       struct symtab_and_line cursal =
 965         get_current_source_symtab_and_line ();
 966
 967       *default_symtab = cursal.symtab;
 968       *default_line = cursal.line;
 969     }
 970 }
 971
 972 \f
 973
 974 /* Decode arg of the form *PC.  */
 975
 976 static struct symtabs_and_lines
 977 decode_indirect (char **argptr)
 978 {
 979   struct symtabs_and_lines values;
 980   CORE_ADDR pc;
 981
 982   (*argptr)++;
 983   pc = parse_and_eval_address_1 (argptr);
 984
 985   values.sals = (struct symtab_and_line *)
 986     xmalloc (sizeof (struct symtab_and_line));
 987
 988   values.nelts = 1;
 989   values.sals[0] = find_pc_line (pc, 0);
 990   values.sals[0].pc = pc;
 991   values.sals[0].section = find_pc_overlay (pc);
 992   values.sals[0].explicit_pc = 1;
 993
 994   return values;
 995 }
 996
 997 \f
 998
 999 /* Locate the first half of the linespec, ending in a colon, period,
1000    or whitespace.  (More or less.)  Also, check to see if *ARGPTR is
1001    enclosed in double quotes; if so, set is_quote_enclosed, advance
1002    ARGPTR past that and zero out the trailing double quote.
1003    If ARGPTR is just a simple name like "main", p will point to ""
1004    at the end.  */
1005
1006 static char *
1007 locate_first_half (char **argptr, int *is_quote_enclosed)
1008 {
1009   char *ii;
1010   char *p, *p1;
1011   int has_comma;
1012
1013   /* Maybe we were called with a line range FILENAME:LINENUM,FILENAME:LINENUM
1014      and we must isolate the first half.  Outer layers will call again later
1015      for the second half.
1016
1017      Don't count commas that appear in argument lists of overloaded
1018      functions, or in quoted strings.  It's stupid to go to this much
1019      trouble when the rest of the function is such an obvious roach hotel.  */
1020   ii = find_toplevel_char (*argptr, ',');
1021   has_comma = (ii != 0);
1022
1023   /* Temporarily zap out second half to not confuse the code below.
1024      This is undone below. Do not change ii!!  */
1025   if (has_comma)
1026     {
1027       *ii = '\0';
1028     }
1029
1030   /* Maybe arg is FILE : LINENUM or FILE : FUNCTION.  May also be
1031      CLASS::MEMBER, or NAMESPACE::NAME.  Look for ':', but ignore
1032      inside of <>.  */
1033
1034   p = *argptr;
1035   if (p[0] == '"')
1036     {
1037       *is_quote_enclosed = 1;
1038       (*argptr)++;
1039       p++;
1040     }
1041   else
1042     {
1043       *is_quote_enclosed = 0;
1044       if (strchr (get_gdb_completer_quote_characters (), *p))
1045         {
1046           ++(*argptr);
1047           ++p;
1048         }
1049     }
1050   for (; *p; p++)
1051     {
1052       if (p[0] == '<')
1053         {
1054           char *temp_end = find_template_name_end (p);
1055
1056           if (!temp_end)
1057             error (_("malformed template specification in command"));
1058           p = temp_end;
1059         }
1060       /* Check for a colon and a plus or minus and a [ (which
1061          indicates an Objective-C method) */
1062       if (is_objc_method_format (p))
1063         {
1064           break;
1065         }
1066       /* Check for the end of the first half of the linespec.  End of
1067          line, a tab, a double colon or the last single colon, or a
1068          space.  But if enclosed in double quotes we do not break on
1069          enclosed spaces.  */
1070       if (!*p
1071           || p[0] == '\t'
1072           || ((p[0] == ':')
1073               && ((p[1] == ':') || (strchr (p + 1, ':') == NULL)))
1074           || ((p[0] == ' ') && !*is_quote_enclosed))
1075         break;
1076       if (p[0] == '.' && strchr (p, ':') == NULL)
1077         {
1078           /* Java qualified method.  Find the *last* '.', since the
1079              others are package qualifiers.  Stop at any open parenthesis
1080              which might provide overload information.  */
1081           for (p1 = p; *p1 && *p1 != '('; p1++)
1082             {
1083               if (*p1 == '.')
1084                 p = p1;
1085             }
1086           break;
1087         }
1088     }
1089   while (p[0] == ' ' || p[0] == '\t')
1090     p++;
1091
1092   /* If the closing double quote was left at the end, remove it.  */
1093   if (*is_quote_enclosed)
1094     {
1095       char *closing_quote = strchr (p - 1, '"');
1096
1097       if (closing_quote && closing_quote[1] == '\0')
1098         *closing_quote = '\0';
1099     }
1100
1101   /* Now that we've safely parsed the first half, put back ',' so
1102      outer layers can see it.  */
1103   if (has_comma)
1104     *ii = ',';
1105
1106   return p;
1107 }
1108
1109 \f
1110
1111 /* Here's where we recognise an Objective-C Selector.  An Objective C
1112    selector may be implemented by more than one class, therefore it
1113    may represent more than one method/function.  This gives us a
1114    situation somewhat analogous to C++ overloading.  If there's more
1115    than one method that could represent the selector, then use some of
1116    the existing C++ code to let the user choose one.  */
1117
1118 struct symtabs_and_lines
1119 decode_objc (char **argptr, int funfirstline, struct symtab *file_symtab,
1120              char ***canonical, char *saved_arg)
1121 {
1122   struct symtabs_and_lines values;
1123   struct symbol **sym_arr = NULL;
1124   struct symbol *sym = NULL;
1125   char *copy = NULL;
1126   struct block *block = NULL;
1127   unsigned i1 = 0;
1128   unsigned i2 = 0;
1129
1130   values.sals = NULL;
1131   values.nelts = 0;
1132
1133   if (file_symtab != NULL)
1134     block = BLOCKVECTOR_BLOCK (BLOCKVECTOR (file_symtab), STATIC_BLOCK);
1135   else
1136     {
1137       enum language save_language;
1138
1139       /* get_selected_block can change the current language when there is
1140          no selected frame yet.  */
1141       save_language = current_language->la_language;
1142       block = get_selected_block (0);
1143       set_language (save_language);
1144     }
1145
1146   copy = find_imps (file_symtab, block, *argptr, NULL, &i1, &i2);
1147
1148   if (i1 > 0)
1149     {
1150       sym_arr = (struct symbol **) alloca ((i1 + 1) * sizeof (struct symbol *));
1151       sym_arr[i1] = NULL;
1152
1153       copy = find_imps (file_symtab, block, *argptr, sym_arr, &i1, &i2);
1154       *argptr = copy;
1155     }
1156
1157   /* i1 now represents the TOTAL number of matches found.
1158      i2 represents how many HIGH-LEVEL (struct symbol) matches,
1159      which will come first in the sym_arr array.  Any low-level
1160      (minimal_symbol) matches will follow those.  */
1161
1162   if (i1 == 1)
1163     {
1164       if (i2 > 0)
1165         {
1166           /* Already a struct symbol.  */
1167           sym = sym_arr[0];
1168         }
1169       else
1170         {
1171           sym = find_pc_function (SYMBOL_VALUE_ADDRESS (sym_arr[0]));
1172           if ((sym != NULL) && strcmp (SYMBOL_LINKAGE_NAME (sym_arr[0]),
1173                                        SYMBOL_LINKAGE_NAME (sym)) != 0)
1174             {
1175               warning (_("debugging symbol \"%s\" does "
1176                          "not match selector; ignoring"),
1177                        SYMBOL_LINKAGE_NAME (sym));
1178               sym = NULL;
1179             }
1180         }
1181
1182       values.sals = (struct symtab_and_line *)
1183         xmalloc (sizeof (struct symtab_and_line));
1184       values.nelts = 1;
1185
1186       if (sym && SYMBOL_CLASS (sym) == LOC_BLOCK)
1187         {
1188           /* Canonicalize this, so it remains resolved for dylib loads.  */
1189           values.sals[0] = find_function_start_sal (sym, funfirstline);
1190           build_canonical_line_spec (values.sals,
1191                                      SYMBOL_NATURAL_NAME (sym), canonical);
1192         }
1193       else
1194         {
1195           /* The only match was a non-debuggable symbol, which might point
1196              to a function descriptor; resolve it to the actual code address
1197              instead.  */
1198           struct minimal_symbol *msymbol = (struct minimal_symbol *)sym_arr[0];
1199           struct objfile *objfile = msymbol_objfile (msymbol);
1200           struct gdbarch *gdbarch = get_objfile_arch (objfile);
1201           CORE_ADDR pc = SYMBOL_VALUE_ADDRESS (msymbol);
1202
1203           pc = gdbarch_convert_from_func_ptr_addr (gdbarch, pc,
1204                                                    &current_target);
1205
1206           init_sal (&values.sals[0]);
1207           values.sals[0].pc = pc;
1208         }
1209       return values;
1210     }
1211
1212   if (i1 > 1)
1213     {
1214       /* More than one match. The user must choose one or more.  */
1215       return decode_line_2 (sym_arr, i2, funfirstline, canonical);
1216     }
1217
1218   return values;
1219 }
1220
1221 /* This handles C++ and Java compound data structures.  P should point
1222    at the first component separator, i.e. double-colon or period.  As
1223    an example, on entrance to this function we could have ARGPTR
1224    pointing to "AAA::inA::fun" and P pointing to "::inA::fun".  */
1225
1226 static struct symtabs_and_lines
1227 decode_compound (char **argptr, int funfirstline, char ***canonical,
1228                  char *saved_arg, char *p, int *not_found_ptr)
1229 {
1230   struct symtabs_and_lines values;
1231   char *p2;
1232   char *saved_arg2 = *argptr;
1233   char *temp_end;
1234   struct symbol *sym;
1235   char *copy;
1236   struct symbol *sym_class;
1237   struct type *t;
1238   char *saved_java_argptr = NULL;
1239
1240   /* First check for "global" namespace specification, of the form
1241      "::foo".  If found, skip over the colons and jump to normal
1242      symbol processing.  I.e. the whole line specification starts with
1243      "::" (note the condition that *argptr == p). */
1244   if (p[0] == ':'
1245       && ((*argptr == p) || (p[-1] == ' ') || (p[-1] == '\t')))
1246     saved_arg2 += 2;
1247
1248   /* Given our example "AAA::inA::fun", we have two cases to consider:
1249
1250      1) AAA::inA is the name of a class.  In that case, presumably it
1251         has a method called "fun"; we then look up that method using
1252         find_method.
1253
1254      2) AAA::inA isn't the name of a class.  In that case, either the
1255         user made a typo or AAA::inA is the name of a namespace.
1256         Either way, we just look up AAA::inA::fun with lookup_symbol.
1257
1258      Thus, our first task is to find everything before the last set of
1259      double-colons and figure out if it's the name of a class.  So we
1260      first loop through all of the double-colons.  */
1261
1262   p2 = p;               /* Save for restart.  */
1263
1264   /* This is very messy. Following the example above we have now the
1265      following pointers:
1266      p -> "::inA::fun"
1267      argptr -> "AAA::inA::fun
1268      saved_arg -> "AAA::inA::fun
1269      saved_arg2 -> "AAA::inA::fun
1270      p2 -> "::inA::fun". */
1271
1272   /* In the loop below, with these strings, we'll make 2 passes, each
1273      is marked in comments.*/
1274
1275   while (1)
1276     {
1277       /* Move pointer up to next possible class/namespace token.  */
1278
1279       p = p2 + 1;       /* Restart with old value +1.  */
1280
1281       /* PASS1: at this point p2->"::inA::fun", so p->":inA::fun",
1282          i.e. if there is a double-colon, p will now point to the
1283          second colon. */
1284       /* PASS2: p2->"::fun", p->":fun" */
1285
1286       /* Move pointer ahead to next double-colon.  */
1287       while (*p && (p[0] != ' ') && (p[0] != '\t') && (p[0] != '\'')
1288              && (*p != '('))
1289         {
1290           if (current_language->la_language == language_cplus)
1291             p += cp_validate_operator (p);
1292
1293           if (p[0] == '<')
1294             {
1295               temp_end = find_template_name_end (p);
1296               if (!temp_end)
1297                 error (_("malformed template specification in command"));
1298               p = temp_end;
1299             }
1300           /* Note that, since, at the start of this loop, p would be
1301              pointing to the second colon in a double-colon, we only
1302              satisfy the condition below if there is another
1303              double-colon to the right (after). I.e. there is another
1304              component that can be a class or a namespace. I.e, if at
1305              the beginning of this loop (PASS1), we had
1306              p->":inA::fun", we'll trigger this when p has been
1307              advanced to point to "::fun".  */
1308           /* PASS2: we will not trigger this. */
1309           else if ((p[0] == ':') && (p[1] == ':'))
1310             break;      /* Found double-colon.  */
1311           else
1312             /* PASS2: We'll keep getting here, until p->"", at which point
1313                we exit this loop.  */
1314             p++;
1315         }
1316
1317       if (*p != ':')
1318         break;          /* Out of the while (1).  This would happen
1319                            for instance if we have looked up
1320                            unsuccessfully all the components of the
1321                            string, and p->""(PASS2)  */
1322
1323       /* We get here if p points to ' ', '\t', '\'', "::" or ""(i.e
1324          string ended). */
1325       /* Save restart for next time around.  */
1326       p2 = p;
1327       /* Restore argptr as it was on entry to this function.  */
1328       *argptr = saved_arg2;
1329       /* PASS1: at this point p->"::fun" argptr->"AAA::inA::fun",
1330          p2->"::fun".  */
1331
1332       /* All ready for next pass through the loop.  */
1333     }                   /* while (1) */
1334
1335
1336   /* Start of lookup in the symbol tables. */
1337
1338   /* Lookup in the symbol table the substring between argptr and
1339      p. Note, this call changes the value of argptr.  */
1340   /* Before the call, argptr->"AAA::inA::fun",
1341      p->"", p2->"::fun".  After the call: argptr->"fun", p, p2
1342      unchanged.  */
1343   sym_class = lookup_prefix_sym (argptr, p2);
1344
1345   /* If sym_class has been found, and if "AAA::inA" is a class, then
1346      we're in case 1 above.  So we look up "fun" as a method of that
1347      class.  */
1348   if (sym_class &&
1349       (t = check_typedef (SYMBOL_TYPE (sym_class)),
1350        (TYPE_CODE (t) == TYPE_CODE_STRUCT
1351         || TYPE_CODE (t) == TYPE_CODE_UNION)))
1352     {
1353       /* Arg token is not digits => try it as a function name.
1354          Find the next token (everything up to end or next
1355          blank).  */
1356       if (**argptr
1357           && strchr (get_gdb_completer_quote_characters (),
1358                      **argptr) != NULL)
1359         {
1360           p = skip_quoted (*argptr);
1361           *argptr = *argptr + 1;
1362         }
1363       else
1364         {
1365           /* At this point argptr->"fun".  */
1366           char *a;
1367
1368           p = *argptr;
1369           while (*p && *p != ' ' && *p != '\t' && *p != ',' && *p != ':'
1370                  && *p != '(')
1371             p++;
1372           /* At this point p->"".  String ended.  */
1373           /* Nope, C++ operators could have spaces in them
1374              ("foo::operator <" or "foo::operator delete []").
1375              I apologize, this is a bit hacky...  */
1376           if (current_language->la_language == language_cplus
1377               && *p == ' ' && p - 8 - *argptr + 1 > 0)
1378             {
1379               /* The above loop has already swallowed "operator".  */
1380               p += cp_validate_operator (p - 8) - 8;
1381             }
1382
1383           /* Keep any template parameters */
1384           if (*p == '<')
1385             p = find_template_name_end (p);
1386
1387           /* Keep method overload information.  */
1388           a = strchr (p, '(');
1389           if (a != NULL)
1390             p = find_method_overload_end (a);
1391
1392           /* Make sure we keep important kewords like "const" */
1393           if (strncmp (p, " const", 6) == 0)
1394             p += 6;
1395
1396           /* Java may append typenames,  so assume that if there is
1397              anything else left in *argptr, it must be a typename.  */
1398           if (*p && current_language->la_language == language_java)
1399             {
1400               struct type *type;
1401
1402               p2 = p;
1403               while (*p2)
1404                 ++p2;
1405               copy = (char *) alloca (p2 - p + 1);
1406               memcpy (copy, p, p2 - p);
1407               copy[p2 - p] = '\0';
1408               type = lookup_typename (current_language, get_current_arch (),
1409                                       copy, NULL, 1);
1410               if (type != NULL)
1411                 {
1412                   /* Save the location of this just in case this
1413                      method/type combination isn't actually defined.
1414                      It will be checked later.  */
1415                   saved_java_argptr = p;
1416                   p = p2;
1417                 }
1418             }
1419         }
1420
1421       /* Allocate our own copy of the substring between argptr and
1422          p. */
1423       copy = (char *) alloca (p - *argptr + 1);
1424       memcpy (copy, *argptr, p - *argptr);
1425       copy[p - *argptr] = '\0';
1426       if (p != *argptr
1427           && copy[p - *argptr - 1]
1428           && strchr (get_gdb_completer_quote_characters (),
1429                      copy[p - *argptr - 1]) != NULL)
1430         copy[p - *argptr - 1] = '\0';
1431
1432       /* At this point copy->"fun", p->"" */
1433
1434       /* No line number may be specified.  */
1435       while (*p == ' ' || *p == '\t')
1436         p++;
1437       *argptr = p;
1438       /* At this point arptr->"".  */
1439
1440       /* Look for copy as a method of sym_class. */
1441       /* At this point copy->"fun", sym_class is "AAA:inA",
1442          saved_arg->"AAA::inA::fun".  This concludes the scanning of
1443          the string for possible components matches.  If we find it
1444          here, we return. If not, and we are at the and of the string,
1445          we'll lookup the whole string in the symbol tables.  */
1446
1447       values = find_method (funfirstline, canonical, saved_arg,
1448                             copy, t, sym_class, not_found_ptr);
1449       if (saved_java_argptr != NULL && values.nelts == 1)
1450         {
1451           /* The user specified a specific return type for a java method.
1452              Double-check that it really is the one the user specified.
1453              [This is a necessary evil because strcmp_iw_ordered stops
1454              comparisons too prematurely.]  */
1455           sym = find_pc_sect_function (values.sals[0].pc,
1456                                        values.sals[0].section);
1457           /* We just found a SAL, we had better be able to go backwards!  */
1458           gdb_assert (sym != NULL);
1459           if (strcmp_iw (SYMBOL_LINKAGE_NAME (sym), saved_arg) != 0)
1460             {
1461               xfree (values.sals);
1462               error (_("the class `%s' does not have "
1463                        "any method instance named %s"),
1464                      SYMBOL_PRINT_NAME (sym_class), copy);
1465             }
1466         }
1467       return values;
1468     } /* End if symbol found */
1469
1470
1471   /* We couldn't find a class, so we're in case 2 above.  We check the
1472      entire name as a symbol instead.  */
1473
1474   copy = (char *) alloca (p - saved_arg2 + 1);
1475   memcpy (copy, saved_arg2, p - saved_arg2);
1476   /* Note: if is_quoted should be true, we snuff out quote here
1477      anyway.  */
1478   copy[p - saved_arg2] = '\000';
1479   /* Set argptr to skip over the name.  */
1480   *argptr = (*p == '\'') ? p + 1 : p;
1481
1482   /* Look up entire name */
1483   sym = lookup_symbol (copy, 0, VAR_DOMAIN, 0);
1484   if (sym)
1485     return symbol_found (funfirstline, canonical, copy, sym, NULL);
1486
1487   /* Couldn't find any interpretation as classes/namespaces, so give
1488      up.  The quotes are important if copy is empty.  */
1489   if (not_found_ptr)
1490     *not_found_ptr = 1;
1491   cplusplus_error (saved_arg,
1492                    "Can't find member of namespace, "
1493                    "class, struct, or union named \"%s\"\n",
1494                    copy);
1495 }
1496
1497 /* Next come some helper functions for decode_compound.  */
1498
1499 /* Return the symbol corresponding to the substring of *ARGPTR ending
1500    at P, allowing whitespace.  Also, advance *ARGPTR past the symbol
1501    name in question, the compound object separator ("::" or "."), and
1502    whitespace.  Note that *ARGPTR is changed whether or not the
1503    lookup_symbol call finds anything (i.e we return NULL).  As an
1504    example, say ARGPTR is "AAA::inA::fun" and P is "::inA::fun".  */
1505
1506 static struct symbol *
1507 lookup_prefix_sym (char **argptr, char *p)
1508 {
1509   char *p1;
1510   char *copy;
1511   struct symbol *sym;
1512
1513   /* Extract the class name.  */
1514   p1 = p;
1515   while (p != *argptr && p[-1] == ' ')
1516     --p;
1517   copy = (char *) alloca (p - *argptr + 1);
1518   memcpy (copy, *argptr, p - *argptr);
1519   copy[p - *argptr] = 0;
1520
1521   /* Discard the class name from the argptr.  */
1522   p = p1 + (p1[0] == ':' ? 2 : 1);
1523   while (*p == ' ' || *p == '\t')
1524     p++;
1525   *argptr = p;
1526
1527   /* At this point p1->"::inA::fun", p->"inA::fun" copy->"AAA",
1528      argptr->"inA::fun" */
1529
1530   sym = lookup_symbol (copy, 0, STRUCT_DOMAIN, 0);
1531   if (sym == NULL)
1532     {
1533       /* Typedefs are in VAR_DOMAIN so the above symbol lookup will
1534          fail when the user attempts to lookup a method of a class
1535          via a typedef'd name (NOT via the class's name, which is already
1536          handled in symbol_matches_domain).  So try the lookup again
1537          using VAR_DOMAIN (where typedefs live) and double-check that we
1538          found a struct/class type.  */
1539       struct symbol *s = lookup_symbol (copy, 0, VAR_DOMAIN, 0);
1540
1541       if (s != NULL)
1542         {
1543           struct type *t = SYMBOL_TYPE (s);
1544
1545           CHECK_TYPEDEF (t);
1546           if (TYPE_CODE (t) == TYPE_CODE_STRUCT)
1547             return s;
1548         }
1549     }
1550
1551   return sym;
1552 }
1553
1554 /* This finds the method COPY in the class whose type is T and whose
1555    symbol is SYM_CLASS.  */
1556
1557 static struct symtabs_and_lines
1558 find_method (int funfirstline, char ***canonical, char *saved_arg,
1559              char *copy, struct type *t, struct symbol *sym_class,
1560              int *not_found_ptr)
1561 {
1562   struct symtabs_and_lines values;
1563   struct symbol *sym = NULL;
1564   int i1;       /*  Counter for the symbol array.  */
1565   struct symbol **sym_arr =  alloca (total_number_of_methods (t)
1566                                      * sizeof (struct symbol *));
1567
1568   /* Find all methods with a matching name, and put them in
1569      sym_arr.  */
1570
1571   i1 = find_methods (t, copy, SYMBOL_LANGUAGE (sym_class), sym_arr);
1572
1573   if (i1 == 1)
1574     {
1575       /* There is exactly one field with that name.  */
1576       sym = sym_arr[0];
1577
1578       if (sym && SYMBOL_CLASS (sym) == LOC_BLOCK)
1579         {
1580           values.sals = (struct symtab_and_line *)
1581             xmalloc (sizeof (struct symtab_and_line));
1582           values.nelts = 1;
1583           values.sals[0] = find_function_start_sal (sym,
1584                                                     funfirstline);
1585         }
1586       else
1587         {
1588           values.sals = NULL;
1589           values.nelts = 0;
1590         }
1591       return values;
1592     }
1593   if (i1 > 0)
1594     {
1595       /* If we were given a specific overload instance, use that
1596          (or error if no matches were found).  Otherwise ask the user
1597          which one to use.  */
1598       if (strchr (saved_arg, '(') != NULL)
1599         {
1600           int i;
1601           char *name = saved_arg;
1602           char *canon = cp_canonicalize_string (name);
1603           struct cleanup *cleanup;
1604
1605           if (canon != NULL)
1606             {
1607               name = canon;
1608               cleanup = make_cleanup (xfree, canon);
1609             }
1610           else
1611             cleanup = make_cleanup (null_cleanup, NULL);
1612
1613           for (i = 0; i < i1; ++i)
1614             {
1615               if (strcmp_iw (name, SYMBOL_LINKAGE_NAME (sym_arr[i])) == 0)
1616                 {
1617                   values.sals = (struct symtab_and_line *)
1618                     xmalloc (sizeof (struct symtab_and_line));
1619                   values.nelts = 1;
1620                   values.sals[0] = find_function_start_sal (sym_arr[i],
1621                                                             funfirstline);
1622                   do_cleanups (cleanup);
1623                   return values;
1624                 }
1625             }
1626
1627           error (_("the class `%s' does not have "
1628                    "any method instance named %s"),
1629                  SYMBOL_PRINT_NAME (sym_class), copy);
1630         }
1631
1632       return decode_line_2 (sym_arr, i1, funfirstline, canonical);
1633     }
1634   else
1635     {
1636       if (not_found_ptr)
1637         *not_found_ptr = 1;
1638       if (copy[0] == '~')
1639         cplusplus_error (saved_arg,
1640                          "the class `%s' does not have destructor defined\n",
1641                          SYMBOL_PRINT_NAME (sym_class));
1642       else
1643         cplusplus_error (saved_arg,
1644                          "the class %s does not have any method named %s\n",
1645                          SYMBOL_PRINT_NAME (sym_class), copy);
1646     }
1647 }
1648
1649 \f
1650
1651 /* Return the symtab associated to the filename given by the substring
1652    of *ARGPTR ending at P, and advance ARGPTR past that filename.  If
1653    NOT_FOUND_PTR is not null and the source file is not found, store
1654    boolean true at the location pointed to and do not issue an
1655    error message.  */
1656
1657 static struct symtab *
1658 symtab_from_filename (char **argptr, char *p, int is_quote_enclosed,
1659                       int *not_found_ptr)
1660 {
1661   char *p1;
1662   char *copy;
1663   struct symtab *file_symtab;
1664
1665   p1 = p;
1666   while (p != *argptr && p[-1] == ' ')
1667     --p;
1668   if ((*p == '"') && is_quote_enclosed)
1669     --p;
1670   copy = (char *) alloca (p - *argptr + 1);
1671   memcpy (copy, *argptr, p - *argptr);
1672   /* It may have the ending quote right after the file name.  */
1673   if ((is_quote_enclosed && copy[p - *argptr - 1] == '"')
1674       || copy[p - *argptr - 1] == '\'')
1675     copy[p - *argptr - 1] = 0;
1676   else
1677     copy[p - *argptr] = 0;
1678
1679   /* Find that file's data.  */
1680   file_symtab = lookup_symtab (copy);
1681   if (file_symtab == 0)
1682     {
1683       if (not_found_ptr)
1684         *not_found_ptr = 1;
1685       if (!have_full_symbols () && !have_partial_symbols ())
1686         throw_error (NOT_FOUND_ERROR,
1687                      _("No symbol table is loaded.  "
1688                        "Use the \"file\" command."));
1689       throw_error (NOT_FOUND_ERROR, _("No source file named %s."), copy);
1690     }
1691
1692   /* Discard the file name from the arg.  */
1693   p = p1 + 1;
1694   while (*p == ' ' || *p == '\t')
1695     p++;
1696   *argptr = p;
1697
1698   return file_symtab;
1699 }
1700
1701 \f
1702
1703 /* This decodes a line where the argument is all digits (possibly
1704    preceded by a sign).  Q should point to the end of those digits;
1705    the other arguments are as usual.  */
1706
1707 static struct symtabs_and_lines
1708 decode_all_digits (char **argptr, struct symtab *default_symtab,
1709                    int default_line, char ***canonical,
1710                    struct symtab *file_symtab, char *q)
1711
1712 {
1713   struct symtabs_and_lines values;
1714   struct symtab_and_line val;
1715
1716   enum sign
1717     {
1718       none, plus, minus
1719     }
1720   sign = none;
1721
1722   /* We might need a canonical line spec if no file was specified.  */
1723   int need_canonical = (file_symtab == NULL) ? 1 : 0;
1724
1725   init_sal (&val);
1726
1727   val.pspace = current_program_space;
1728
1729   /* This is where we need to make sure that we have good defaults.
1730      We must guarantee that this section of code is never executed
1731      when we are called with just a function name, since
1732      set_default_source_symtab_and_line uses
1733      select_source_symtab that calls us with such an argument.  */
1734
1735   if (file_symtab == 0 && default_symtab == 0)
1736     {
1737       /* Make sure we have at least a default source file.  */
1738       set_default_source_symtab_and_line ();
1739       initialize_defaults (&default_symtab, &default_line);
1740     }
1741
1742   if (**argptr == '+')
1743     sign = plus, (*argptr)++;
1744   else if (**argptr == '-')
1745     sign = minus, (*argptr)++;
1746   val.line = atoi (*argptr);
1747   switch (sign)
1748     {
1749     case plus:
1750       if (q == *argptr)
1751         val.line = 5;
1752       if (file_symtab == 0)
1753         val.line = default_line + val.line;
1754       break;
1755     case minus:
1756       if (q == *argptr)
1757         val.line = 15;
1758       if (file_symtab == 0)
1759         val.line = default_line - val.line;
1760       else
1761         val.line = 1;
1762       break;
1763     case none:
1764       break;            /* No need to adjust val.line.  */
1765     }
1766
1767   while (*q == ' ' || *q == '\t')
1768     q++;
1769   *argptr = q;
1770   if (file_symtab == 0)
1771     file_symtab = default_symtab;
1772
1773   /* It is possible that this source file has more than one symtab,
1774      and that the new line number specification has moved us from the
1775      default (in file_symtab) to a new one.  */
1776   val.symtab = find_line_symtab (file_symtab, val.line, NULL, NULL);
1777   if (val.symtab == 0)
1778     val.symtab = file_symtab;
1779
1780   val.pspace = SYMTAB_PSPACE (val.symtab);
1781   val.pc = 0;
1782   values.sals = (struct symtab_and_line *)
1783     xmalloc (sizeof (struct symtab_and_line));
1784   values.sals[0] = val;
1785   values.nelts = 1;
1786   if (need_canonical)
1787     build_canonical_line_spec (values.sals, NULL, canonical);
1788   values.sals[0].explicit_line = 1;
1789   return values;
1790 }
1791
1792 \f
1793
1794 /* Decode a linespec starting with a dollar sign.  */
1795
1796 static struct symtabs_and_lines
1797 decode_dollar (char *copy, int funfirstline, struct symtab *default_symtab,
1798                char ***canonical, struct symtab *file_symtab)
1799 {
1800   LONGEST valx;
1801   int index = 0;
1802   int need_canonical = 0;
1803   struct symtabs_and_lines values;
1804   struct symtab_and_line val;
1805   char *p;
1806   struct symbol *sym;
1807   struct minimal_symbol *msymbol;
1808
1809   p = (copy[1] == '$') ? copy + 2 : copy + 1;
1810   while (*p >= '0' && *p <= '9')
1811     p++;
1812   if (!*p)              /* Reached end of token without hitting non-digit.  */
1813     {
1814       /* We have a value history reference.  */
1815       struct value *val_history;
1816
1817       sscanf ((copy[1] == '$') ? copy + 2 : copy + 1, "%d", &index);
1818       val_history = access_value_history ((copy[1] == '$') ? -index : index);
1819       if (TYPE_CODE (value_type (val_history)) != TYPE_CODE_INT)
1820         error (_("History values used in line "
1821                  "specs must have integer values."));
1822       valx = value_as_long (val_history);
1823     }
1824   else
1825     {
1826       /* Not all digits -- may be user variable/function or a
1827          convenience variable.  */
1828
1829       /* Look up entire name as a symbol first.  */
1830       sym = lookup_symbol (copy, 0, VAR_DOMAIN, 0);
1831       file_symtab = (struct symtab *) NULL;
1832       need_canonical = 1;
1833       /* Symbol was found --> jump to normal symbol processing.  */
1834       if (sym)
1835         return symbol_found (funfirstline, canonical, copy, sym, NULL);
1836
1837       /* If symbol was not found, look in minimal symbol tables.  */
1838       msymbol = lookup_minimal_symbol (copy, NULL, NULL);
1839       /* Min symbol was found --> jump to minsym processing.  */
1840       if (msymbol)
1841         return minsym_found (funfirstline, msymbol);
1842
1843       /* Not a user variable or function -- must be convenience variable.  */
1844       if (!get_internalvar_integer (lookup_internalvar (copy + 1), &valx))
1845         error (_("Convenience variables used in line "
1846                  "specs must have integer values."));
1847     }
1848
1849   init_sal (&val);
1850
1851   /* Either history value or convenience value from above, in valx.  */
1852   val.symtab = file_symtab ? file_symtab : default_symtab;
1853   val.line = valx;
1854   val.pc = 0;
1855   val.pspace = current_program_space;
1856
1857   values.sals = (struct symtab_and_line *) xmalloc (sizeof val);
1858   values.sals[0] = val;
1859   values.nelts = 1;
1860
1861   if (need_canonical)
1862     build_canonical_line_spec (values.sals, NULL, canonical);
1863
1864   return values;
1865 }
1866
1867 \f
1868
1869 /* A helper for decode_line_1 that tries to find a label.  The label
1870    is searched for in the current block.
1871    COPY is the name of the label to find.
1872    CANONICAL is the same as the "canonical" argument to decode_line_1.
1873    RESULT is a pointer to a symtabs_and_lines structure which will be
1874    filled in on success.
1875    This function returns 1 if a label was found, 0 otherwise.  */
1876
1877 static int
1878 decode_label (char *copy, char ***canonical, struct symtabs_and_lines *result)
1879 {
1880   struct symbol *sym;
1881
1882   sym = lookup_symbol (copy, get_selected_block (0), LABEL_DOMAIN, 0);
1883
1884   if (sym != NULL)
1885     *result = symbol_found (0, canonical, copy, sym, NULL);
1886
1887   return sym != NULL;
1888 }
1889
1890 /* Decode a linespec that's a variable.  If FILE_SYMTAB is non-NULL,
1891    look in that symtab's static variables first.  If NOT_FOUND_PTR is
1892    not NULL and the function cannot be found, store boolean true in
1893    the location pointed to and do not issue an error message.  */
1894
1895 static struct symtabs_and_lines
1896 decode_variable (char *copy, int funfirstline, char ***canonical,
1897                  struct symtab *file_symtab, int *not_found_ptr)
1898 {
1899   struct symbol *sym;
1900   struct minimal_symbol *msymbol;
1901
1902   sym = lookup_symbol (copy,
1903                        (file_symtab
1904                         ? BLOCKVECTOR_BLOCK (BLOCKVECTOR (file_symtab),
1905                                              STATIC_BLOCK)
1906                         : get_selected_block (0)),
1907                        VAR_DOMAIN, 0);
1908
1909   if (sym != NULL)
1910     return symbol_found (funfirstline, canonical, copy, sym, file_symtab);
1911
1912   msymbol = lookup_minimal_symbol (copy, NULL, NULL);
1913
1914   if (msymbol != NULL)
1915     return minsym_found (funfirstline, msymbol);
1916
1917   if (not_found_ptr)
1918     *not_found_ptr = 1;
1919
1920   if (!have_full_symbols ()
1921       && !have_partial_symbols ()
1922       && !have_minimal_symbols ())
1923     throw_error (NOT_FOUND_ERROR,
1924                  _("No symbol table is loaded.  Use the \"file\" command."));
1925   throw_error (NOT_FOUND_ERROR, _("Function \"%s\" not defined."), copy);
1926 }
1927
1928
1929 \f
1930
1931 /* Now come some functions that are called from multiple places within
1932    decode_line_1.  */
1933
1934 /* We've found a symbol SYM to associate with our linespec; build a
1935    corresponding struct symtabs_and_lines.  */
1936
1937 static struct symtabs_and_lines
1938 symbol_found (int funfirstline, char ***canonical, char *copy,
1939               struct symbol *sym, struct symtab *file_symtab)
1940 {
1941   struct symtabs_and_lines values;
1942
1943   if (SYMBOL_CLASS (sym) == LOC_BLOCK)
1944     {
1945       /* Arg is the name of a function */
1946       values.sals = (struct symtab_and_line *)
1947         xmalloc (sizeof (struct symtab_and_line));
1948       values.sals[0] = find_function_start_sal (sym, funfirstline);
1949       values.nelts = 1;
1950
1951       /* Don't use the SYMBOL_LINE; if used at all it points to
1952          the line containing the parameters or thereabouts, not
1953          the first line of code.  */
1954
1955       /* We might need a canonical line spec if it is a static
1956          function.  */
1957       if (file_symtab == 0)
1958         {
1959           struct blockvector *bv = BLOCKVECTOR (SYMBOL_SYMTAB (sym));
1960           struct block *b = BLOCKVECTOR_BLOCK (bv, STATIC_BLOCK);
1961
1962           if (lookup_block_symbol (b, copy, VAR_DOMAIN) != NULL)
1963             build_canonical_line_spec (values.sals, copy, canonical);
1964         }
1965       return values;
1966     }
1967   else
1968     {
1969       if (funfirstline && SYMBOL_CLASS (sym) != LOC_LABEL)
1970         error (_("\"%s\" is not a function"), copy);
1971       else if (SYMBOL_LINE (sym) != 0)
1972         {
1973           /* We know its line number.  */
1974           values.sals = (struct symtab_and_line *)
1975             xmalloc (sizeof (struct symtab_and_line));
1976           values.nelts = 1;
1977           memset (&values.sals[0], 0, sizeof (values.sals[0]));
1978           values.sals[0].symtab = SYMBOL_SYMTAB (sym);
1979           values.sals[0].line = SYMBOL_LINE (sym);
1980           values.sals[0].pspace = SYMTAB_PSPACE (SYMBOL_SYMTAB (sym));
1981           return values;
1982         }
1983       else
1984         /* This can happen if it is compiled with a compiler which doesn't
1985            put out line numbers for variables.  */
1986         /* FIXME: Shouldn't we just set .line and .symtab to zero
1987            and return?  For example, "info line foo" could print
1988            the address.  */
1989         error (_("Line number not known for symbol \"%s\""), copy);
1990     }
1991 }
1992
1993 /* We've found a minimal symbol MSYMBOL to associate with our
1994    linespec; build a corresponding struct symtabs_and_lines.  */
1995
1996 static struct symtabs_and_lines
1997 minsym_found (int funfirstline, struct minimal_symbol *msymbol)
1998 {
1999   struct objfile *objfile = msymbol_objfile (msymbol);
2000   struct gdbarch *gdbarch = get_objfile_arch (objfile);
2001   struct symtabs_and_lines values;
2002   CORE_ADDR pc;
2003
2004   values.sals = (struct symtab_and_line *)
2005     xmalloc (sizeof (struct symtab_and_line));
2006   values.sals[0] = find_pc_sect_line (SYMBOL_VALUE_ADDRESS (msymbol),
2007                                       (struct obj_section *) 0, 0);
2008   values.sals[0].section = SYMBOL_OBJ_SECTION (msymbol);
2009
2010   /* The minimal symbol might point to a function descriptor;
2011      resolve it to the actual code address instead.  */
2012   pc = gdbarch_convert_from_func_ptr_addr (gdbarch,
2013                                            values.sals[0].pc,
2014                                            &current_target);
2015   if (pc != values.sals[0].pc)
2016     values.sals[0] = find_pc_sect_line (pc, NULL, 0);
2017
2018   if (funfirstline)
2019     skip_prologue_sal (&values.sals[0]);
2020
2021   values.nelts = 1;
2022   return values;
2023 }