1 /* Objective-C language support routines for GDB, the GNU debugger.
3 Copyright (C) 2002, 2003, 2004, 2005, 2007 Free Software Foundation, Inc.
5 Contributed by Apple Computer, Inc.
6 Written by Michael Snyder.
8 This file is part of GDB.
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 2 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program; if not, write to the Free Software
22 Foundation, Inc., 51 Franklin Street, Fifth Floor,
23 Boston, MA 02110-1301, USA. */
28 #include "expression.h"
29 #include "parser-defs.h"
32 #include "objc-lang.h"
33 #include "exceptions.h"
34 #include "complaints.h"
38 #include "gdb_string.h" /* for strchr */
39 #include "target.h" /* for target_has_execution */
43 #include "gdb_regex.h"
48 #include "gdb_assert.h"
58 CORE_ADDR super_class;
80 /* Lookup a structure type named "struct NAME", visible in lexical
81 block BLOCK. If NOERR is nonzero, return zero if NAME is not
85 lookup_struct_typedef (char *name, struct block *block, int noerr)
89 sym = lookup_symbol (name, block, STRUCT_DOMAIN, 0,
90 (struct symtab **) NULL);
97 error (_("No struct type named %s."), name);
99 if (TYPE_CODE (SYMBOL_TYPE (sym)) != TYPE_CODE_STRUCT)
104 error (_("This context has class, union or enum %s, not a struct."),
111 lookup_objc_class (char *classname)
113 struct value * function, *classval;
115 if (! target_has_execution)
117 /* Can't call into inferior to lookup class. */
121 if (lookup_minimal_symbol("objc_lookUpClass", 0, 0))
122 function = find_function_in_inferior("objc_lookUpClass");
123 else if (lookup_minimal_symbol ("objc_lookup_class", 0, 0))
124 function = find_function_in_inferior("objc_lookup_class");
127 complaint (&symfile_complaints, _("no way to lookup Objective-C classes"));
131 classval = value_string (classname, strlen (classname) + 1);
132 classval = value_coerce_array (classval);
133 return (CORE_ADDR) value_as_long (call_function_by_hand (function,
138 lookup_child_selector (char *selname)
140 struct value * function, *selstring;
142 if (! target_has_execution)
144 /* Can't call into inferior to lookup selector. */
148 if (lookup_minimal_symbol("sel_getUid", 0, 0))
149 function = find_function_in_inferior("sel_getUid");
150 else if (lookup_minimal_symbol ("sel_get_any_uid", 0, 0))
151 function = find_function_in_inferior("sel_get_any_uid");
154 complaint (&symfile_complaints, _("no way to lookup Objective-C selectors"));
158 selstring = value_coerce_array (value_string (selname,
159 strlen (selname) + 1));
160 return value_as_long (call_function_by_hand (function, 1, &selstring));
164 value_nsstring (char *ptr, int len)
166 struct value *stringValue[3];
167 struct value *function, *nsstringValue;
171 if (!target_has_execution)
172 return 0; /* Can't call into inferior to create NSString. */
174 sym = lookup_struct_typedef("NSString", 0, 1);
176 sym = lookup_struct_typedef("NXString", 0, 1);
178 type = lookup_pointer_type(builtin_type_void);
180 type = lookup_pointer_type(SYMBOL_TYPE (sym));
182 stringValue[2] = value_string(ptr, len);
183 stringValue[2] = value_coerce_array(stringValue[2]);
184 /* _NSNewStringFromCString replaces "istr" after Lantern2A. */
185 if (lookup_minimal_symbol("_NSNewStringFromCString", 0, 0))
187 function = find_function_in_inferior("_NSNewStringFromCString");
188 nsstringValue = call_function_by_hand(function, 1, &stringValue[2]);
190 else if (lookup_minimal_symbol("istr", 0, 0))
192 function = find_function_in_inferior("istr");
193 nsstringValue = call_function_by_hand(function, 1, &stringValue[2]);
195 else if (lookup_minimal_symbol("+[NSString stringWithCString:]", 0, 0))
197 function = find_function_in_inferior("+[NSString stringWithCString:]");
198 stringValue[0] = value_from_longest
199 (builtin_type_long, lookup_objc_class ("NSString"));
200 stringValue[1] = value_from_longest
201 (builtin_type_long, lookup_child_selector ("stringWithCString:"));
202 nsstringValue = call_function_by_hand(function, 3, &stringValue[0]);
205 error (_("NSString: internal error -- no way to create new NSString"));
207 deprecated_set_value_type (nsstringValue, type);
208 return nsstringValue;
211 /* Objective-C name demangling. */
214 objc_demangle (const char *mangled, int options)
216 char *demangled, *cp;
218 if (mangled[0] == '_' &&
219 (mangled[1] == 'i' || mangled[1] == 'c') &&
222 cp = demangled = xmalloc(strlen(mangled) + 2);
224 if (mangled[1] == 'i')
225 *cp++ = '-'; /* for instance method */
227 *cp++ = '+'; /* for class method */
229 *cp++ = '['; /* opening left brace */
230 strcpy(cp, mangled+3); /* tack on the rest of the mangled name */
232 while (*cp && *cp == '_')
233 cp++; /* skip any initial underbars in class name */
235 cp = strchr(cp, '_');
236 if (!cp) /* find first non-initial underbar */
238 xfree(demangled); /* not mangled name */
241 if (cp[1] == '_') { /* easy case: no category name */
242 *cp++ = ' '; /* replace two '_' with one ' ' */
243 strcpy(cp, mangled + (cp - demangled) + 2);
246 *cp++ = '('; /* less easy case: category name */
247 cp = strchr(cp, '_');
250 xfree(demangled); /* not mangled name */
254 *cp++ = ' '; /* overwriting 1st char of method name... */
255 strcpy(cp, mangled + (cp - demangled)); /* get it back */
258 while (*cp && *cp == '_')
259 cp++; /* skip any initial underbars in method name */
263 *cp = ':'; /* replace remaining '_' with ':' */
265 *cp++ = ']'; /* closing right brace */
266 *cp++ = 0; /* string terminator */
270 return NULL; /* Not an objc mangled name. */
273 /* Print the character C on STREAM as part of the contents of a
274 literal string whose delimiter is QUOTER. Note that that format
275 for printing characters and strings is language specific. */
278 objc_emit_char (int c, struct ui_file *stream, int quoter)
281 c &= 0xFF; /* Avoid sign bit follies. */
283 if (PRINT_LITERAL_FORM (c))
285 if (c == '\\' || c == quoter)
287 fputs_filtered ("\\", stream);
289 fprintf_filtered (stream, "%c", c);
296 fputs_filtered ("\\n", stream);
299 fputs_filtered ("\\b", stream);
302 fputs_filtered ("\\t", stream);
305 fputs_filtered ("\\f", stream);
308 fputs_filtered ("\\r", stream);
311 fputs_filtered ("\\e", stream);
314 fputs_filtered ("\\a", stream);
317 fprintf_filtered (stream, "\\%.3o", (unsigned int) c);
324 objc_printchar (int c, struct ui_file *stream)
326 fputs_filtered ("'", stream);
327 objc_emit_char (c, stream, '\'');
328 fputs_filtered ("'", stream);
331 /* Print the character string STRING, printing at most LENGTH
332 characters. Printing stops early if the number hits print_max;
333 repeat counts are printed as appropriate. Print ellipses at the
334 end if we had to stop before printing LENGTH characters, or if
338 objc_printstr (struct ui_file *stream, const gdb_byte *string,
339 unsigned int length, int width, int force_ellipses)
342 unsigned int things_printed = 0;
346 /* If the string was not truncated due to `set print elements', and
347 the last byte of it is a null, we don't print that, in
348 traditional C style. */
349 if ((!force_ellipses) && length > 0 && string[length-1] == '\0')
354 fputs_filtered ("\"\"", stream);
358 for (i = 0; i < length && things_printed < print_max; ++i)
360 /* Position of the character we are examining to see whether it
363 /* Number of repetitions we have detected so far. */
370 fputs_filtered (", ", stream);
376 while (rep1 < length && string[rep1] == string[i])
382 if (reps > repeat_count_threshold)
387 fputs_filtered ("\\\", ", stream);
389 fputs_filtered ("\", ", stream);
392 objc_printchar (string[i], stream);
393 fprintf_filtered (stream, " <repeats %u times>", reps);
395 things_printed += repeat_count_threshold;
403 fputs_filtered ("\\\"", stream);
405 fputs_filtered ("\"", stream);
408 objc_emit_char (string[i], stream, '"');
413 /* Terminate the quotes if necessary. */
417 fputs_filtered ("\\\"", stream);
419 fputs_filtered ("\"", stream);
422 if (force_ellipses || i < length)
423 fputs_filtered ("...", stream);
426 /* Create a fundamental C type using default reasonable for the
429 Some object/debugging file formats (DWARF version 1, COFF, etc) do
430 not define fundamental types such as "int" or "double". Others
431 (stabs or DWARF version 2, etc) do define fundamental types. For
432 the formats which don't provide fundamental types, gdb can create
433 such types using this function.
435 FIXME: Some compilers distinguish explicitly signed integral types
436 (signed short, signed int, signed long) from "regular" integral
437 types (short, int, long) in the debugging information. There is
438 some disagreement as to how useful this feature is. In particular,
439 gcc does not support this. Also, only some debugging formats allow
440 the distinction to be passed on to a debugger. For now, we always
441 just use "short", "int", or "long" as the type name, for both the
442 implicit and explicitly signed types. This also makes life easier
443 for the gdb test suite since we don't have to account for the
444 differences in output depending upon what the compiler and
445 debugging format support. We will probably have to re-examine the
446 issue when gdb starts taking it's fundamental type information
447 directly from the debugging information supplied by the compiler.
451 objc_create_fundamental_type (struct objfile *objfile, int typeid)
453 struct type *type = NULL;
458 /* FIXME: For now, if we are asked to produce a type not in
459 this language, create the equivalent of a C integer type
460 with the name "<?type?>". When all the dust settles from
461 the type reconstruction work, this should probably become
463 type = init_type (TYPE_CODE_INT,
464 gdbarch_int_bit (current_gdbarch) / TARGET_CHAR_BIT,
465 0, "<?type?>", objfile);
466 warning (_("internal error: no C/C++ fundamental type %d"), typeid);
469 type = init_type (TYPE_CODE_VOID,
470 TARGET_CHAR_BIT / TARGET_CHAR_BIT,
474 type = init_type (TYPE_CODE_INT,
475 TARGET_CHAR_BIT / TARGET_CHAR_BIT,
479 type = init_type (TYPE_CODE_INT,
480 TARGET_CHAR_BIT / TARGET_CHAR_BIT,
481 0, "signed char", objfile);
483 case FT_UNSIGNED_CHAR:
484 type = init_type (TYPE_CODE_INT,
485 TARGET_CHAR_BIT / TARGET_CHAR_BIT,
486 TYPE_FLAG_UNSIGNED, "unsigned char", objfile);
489 type = init_type (TYPE_CODE_INT,
490 gdbarch_short_bit (current_gdbarch) / TARGET_CHAR_BIT,
491 0, "short", objfile);
493 case FT_SIGNED_SHORT:
494 type = init_type (TYPE_CODE_INT,
495 gdbarch_short_bit (current_gdbarch) / TARGET_CHAR_BIT,
496 0, "short", objfile); /* FIXME-fnf */
498 case FT_UNSIGNED_SHORT:
499 type = init_type (TYPE_CODE_INT,
500 gdbarch_short_bit (current_gdbarch) / TARGET_CHAR_BIT,
501 TYPE_FLAG_UNSIGNED, "unsigned short", objfile);
504 type = init_type (TYPE_CODE_INT,
505 gdbarch_int_bit (current_gdbarch) / TARGET_CHAR_BIT,
508 case FT_SIGNED_INTEGER:
509 type = init_type (TYPE_CODE_INT,
510 gdbarch_int_bit (current_gdbarch) / TARGET_CHAR_BIT,
511 0, "int", objfile); /* FIXME -fnf */
513 case FT_UNSIGNED_INTEGER:
514 type = init_type (TYPE_CODE_INT,
515 gdbarch_int_bit (current_gdbarch) / TARGET_CHAR_BIT,
516 TYPE_FLAG_UNSIGNED, "unsigned int", objfile);
519 type = init_type (TYPE_CODE_INT,
520 gdbarch_long_bit (current_gdbarch) / TARGET_CHAR_BIT,
524 type = init_type (TYPE_CODE_INT,
525 gdbarch_long_bit (current_gdbarch) / TARGET_CHAR_BIT,
526 0, "long", objfile); /* FIXME -fnf */
528 case FT_UNSIGNED_LONG:
529 type = init_type (TYPE_CODE_INT,
530 gdbarch_long_bit (current_gdbarch) / TARGET_CHAR_BIT,
531 TYPE_FLAG_UNSIGNED, "unsigned long", objfile);
534 type = init_type (TYPE_CODE_INT,
535 gdbarch_long_long_bit (current_gdbarch)
537 0, "long long", objfile);
539 case FT_SIGNED_LONG_LONG:
540 type = init_type (TYPE_CODE_INT,
541 gdbarch_long_long_bit (current_gdbarch)
543 0, "signed long long", objfile);
545 case FT_UNSIGNED_LONG_LONG:
546 type = init_type (TYPE_CODE_INT,
547 gdbarch_long_long_bit (current_gdbarch)
549 TYPE_FLAG_UNSIGNED, "unsigned long long", objfile);
552 type = init_type (TYPE_CODE_FLT,
553 gdbarch_float_bit (current_gdbarch) / TARGET_CHAR_BIT,
554 0, "float", objfile);
556 case FT_DBL_PREC_FLOAT:
557 type = init_type (TYPE_CODE_FLT,
558 gdbarch_double_bit (current_gdbarch)
560 0, "double", objfile);
562 case FT_EXT_PREC_FLOAT:
563 type = init_type (TYPE_CODE_FLT,
564 gdbarch_long_double_bit (current_gdbarch)
566 0, "long double", objfile);
572 /* Determine if we are currently in the Objective-C dispatch function.
573 If so, get the address of the method function that the dispatcher
574 would call and use that as the function to step into instead. Also
575 skip over the trampoline for the function (if any). This is better
576 for the user since they are only interested in stepping into the
577 method function anyway. */
579 objc_skip_trampoline (struct frame_info *frame, CORE_ADDR stop_pc)
581 CORE_ADDR real_stop_pc;
582 CORE_ADDR method_stop_pc;
584 real_stop_pc = gdbarch_skip_trampoline_code
585 (current_gdbarch, frame, stop_pc);
587 if (real_stop_pc != 0)
588 find_objc_msgcall (real_stop_pc, &method_stop_pc);
590 find_objc_msgcall (stop_pc, &method_stop_pc);
594 real_stop_pc = gdbarch_skip_trampoline_code
595 (current_gdbarch, frame, method_stop_pc);
596 if (real_stop_pc == 0)
597 real_stop_pc = method_stop_pc;
604 /* Table mapping opcodes into strings for printing operators
605 and precedences of the operators. */
607 static const struct op_print objc_op_print_tab[] =
609 {",", BINOP_COMMA, PREC_COMMA, 0},
610 {"=", BINOP_ASSIGN, PREC_ASSIGN, 1},
611 {"||", BINOP_LOGICAL_OR, PREC_LOGICAL_OR, 0},
612 {"&&", BINOP_LOGICAL_AND, PREC_LOGICAL_AND, 0},
613 {"|", BINOP_BITWISE_IOR, PREC_BITWISE_IOR, 0},
614 {"^", BINOP_BITWISE_XOR, PREC_BITWISE_XOR, 0},
615 {"&", BINOP_BITWISE_AND, PREC_BITWISE_AND, 0},
616 {"==", BINOP_EQUAL, PREC_EQUAL, 0},
617 {"!=", BINOP_NOTEQUAL, PREC_EQUAL, 0},
618 {"<=", BINOP_LEQ, PREC_ORDER, 0},
619 {">=", BINOP_GEQ, PREC_ORDER, 0},
620 {">", BINOP_GTR, PREC_ORDER, 0},
621 {"<", BINOP_LESS, PREC_ORDER, 0},
622 {">>", BINOP_RSH, PREC_SHIFT, 0},
623 {"<<", BINOP_LSH, PREC_SHIFT, 0},
624 {"+", BINOP_ADD, PREC_ADD, 0},
625 {"-", BINOP_SUB, PREC_ADD, 0},
626 {"*", BINOP_MUL, PREC_MUL, 0},
627 {"/", BINOP_DIV, PREC_MUL, 0},
628 {"%", BINOP_REM, PREC_MUL, 0},
629 {"@", BINOP_REPEAT, PREC_REPEAT, 0},
630 {"-", UNOP_NEG, PREC_PREFIX, 0},
631 {"!", UNOP_LOGICAL_NOT, PREC_PREFIX, 0},
632 {"~", UNOP_COMPLEMENT, PREC_PREFIX, 0},
633 {"*", UNOP_IND, PREC_PREFIX, 0},
634 {"&", UNOP_ADDR, PREC_PREFIX, 0},
635 {"sizeof ", UNOP_SIZEOF, PREC_PREFIX, 0},
636 {"++", UNOP_PREINCREMENT, PREC_PREFIX, 0},
637 {"--", UNOP_PREDECREMENT, PREC_PREFIX, 0},
638 {NULL, OP_NULL, PREC_NULL, 0}
641 struct type ** const (objc_builtin_types[]) =
648 &builtin_type_double,
650 &builtin_type_long_long,
651 &builtin_type_signed_char,
652 &builtin_type_unsigned_char,
653 &builtin_type_unsigned_short,
654 &builtin_type_unsigned_int,
655 &builtin_type_unsigned_long,
656 &builtin_type_unsigned_long_long,
657 &builtin_type_long_double,
658 &builtin_type_complex,
659 &builtin_type_double_complex,
663 const struct language_defn objc_language_defn = {
664 "objective-c", /* Language name */
671 &exp_descriptor_standard,
675 objc_printchar, /* Print a character constant */
676 objc_printstr, /* Function to print string constant */
678 objc_create_fundamental_type, /* Create fundamental type in this language */
679 c_print_type, /* Print a type using appropriate syntax */
680 c_val_print, /* Print a value using appropriate syntax */
681 c_value_print, /* Print a top-level value */
682 objc_skip_trampoline, /* Language specific skip_trampoline */
683 value_of_this, /* value_of_this */
684 basic_lookup_symbol_nonlocal, /* lookup_symbol_nonlocal */
685 basic_lookup_transparent_type,/* lookup_transparent_type */
686 objc_demangle, /* Language specific symbol demangler */
687 NULL, /* Language specific class_name_from_physname */
688 objc_op_print_tab, /* Expression operators for printing */
689 1, /* C-style arrays */
690 0, /* String lower bound */
691 &builtin_type_char, /* Type of string elements */
692 default_word_break_characters,
693 NULL, /* FIXME: la_language_arch_info. */
694 default_print_array_index,
700 * Following functions help construct Objective-C message calls
703 struct selname /* For parsing Objective-C. */
705 struct selname *next;
710 static int msglist_len;
711 static struct selname *selname_chain;
712 static char *msglist_sel;
717 struct selname *new =
718 (struct selname *) xmalloc (sizeof (struct selname));
720 new->next = selname_chain;
721 new->msglist_len = msglist_len;
722 new->msglist_sel = msglist_sel;
724 msglist_sel = (char *)xmalloc(1);
730 add_msglist(struct stoken *str, int addcolon)
735 if (str == 0) { /* Unnamed arg, or... */
736 if (addcolon == 0) { /* variable number of args. */
746 len = plen + strlen(msglist_sel) + 2;
747 s = (char *)xmalloc(len);
748 strcpy(s, msglist_sel);
763 int val = msglist_len;
764 struct selname *sel = selname_chain;
765 char *p = msglist_sel;
768 selname_chain = sel->next;
769 msglist_len = sel->msglist_len;
770 msglist_sel = sel->msglist_sel;
771 selid = lookup_child_selector(p);
773 error (_("Can't find selector \"%s\""), p);
774 write_exp_elt_longcst (selid);
776 write_exp_elt_longcst (val); /* Number of args */
783 * Function: specialcmp (char *a, char *b)
785 * Special strcmp: treats ']' and ' ' as end-of-string.
786 * Used for qsorting lists of objc methods (either by class or selector).
790 specialcmp (char *a, char *b)
792 while (*a && *a != ' ' && *a != ']' && *b && *b != ' ' && *b != ']')
798 if (*a && *a != ' ' && *a != ']')
799 return 1; /* a is longer therefore greater */
800 if (*b && *b != ' ' && *b != ']')
801 return -1; /* a is shorter therefore lesser */
802 return 0; /* a and b are identical */
806 * Function: compare_selectors (const void *, const void *)
808 * Comparison function for use with qsort. Arguments are symbols or
809 * msymbols Compares selector part of objc method name alphabetically.
813 compare_selectors (const void *a, const void *b)
817 aname = SYMBOL_PRINT_NAME (*(struct symbol **) a);
818 bname = SYMBOL_PRINT_NAME (*(struct symbol **) b);
819 if (aname == NULL || bname == NULL)
820 error (_("internal: compare_selectors(1)"));
822 aname = strchr(aname, ' ');
823 bname = strchr(bname, ' ');
824 if (aname == NULL || bname == NULL)
825 error (_("internal: compare_selectors(2)"));
827 return specialcmp (aname+1, bname+1);
831 * Function: selectors_info (regexp, from_tty)
833 * Implements the "Info selectors" command. Takes an optional regexp
834 * arg. Lists all objective c selectors that match the regexp. Works
835 * by grepping thru all symbols for objective c methods. Output list
836 * is sorted and uniqued.
840 selectors_info (char *regexp, int from_tty)
842 struct objfile *objfile;
843 struct minimal_symbol *msymbol;
851 struct symbol **sym_arr;
855 strcpy(myregexp, ".*]"); /* Null input, match all objc methods. */
858 if (*regexp == '+' || *regexp == '-')
859 { /* User wants only class methods or only instance methods. */
860 plusminus = *regexp++;
861 while (*regexp == ' ' || *regexp == '\t')
865 strcpy(myregexp, ".*]");
868 strcpy(myregexp, regexp);
869 if (myregexp[strlen(myregexp) - 1] == '$') /* end of selector */
870 myregexp[strlen(myregexp) - 1] = ']'; /* end of method name */
872 strcat(myregexp, ".*]");
878 val = re_comp (myregexp);
880 error (_("Invalid regexp (%s): %s"), val, regexp);
883 /* First time thru is JUST to get max length and count. */
884 ALL_MSYMBOLS (objfile, msymbol)
887 name = SYMBOL_NATURAL_NAME (msymbol);
889 (name[0] == '-' || name[0] == '+') &&
890 name[1] == '[') /* Got a method name. */
892 /* Filter for class/instance methods. */
893 if (plusminus && name[0] != plusminus)
895 /* Find selector part. */
896 name = (char *) strchr(name+2, ' ');
897 if (regexp == NULL || re_exec(++name) != 0)
899 char *mystart = name;
900 char *myend = (char *) strchr(mystart, ']');
902 if (myend && (myend - mystart > maxlen))
903 maxlen = myend - mystart; /* Get longest selector. */
910 printf_filtered (_("Selectors matching \"%s\":\n\n"),
911 regexp ? regexp : "*");
913 sym_arr = alloca (matches * sizeof (struct symbol *));
915 ALL_MSYMBOLS (objfile, msymbol)
918 name = SYMBOL_NATURAL_NAME (msymbol);
920 (name[0] == '-' || name[0] == '+') &&
921 name[1] == '[') /* Got a method name. */
923 /* Filter for class/instance methods. */
924 if (plusminus && name[0] != plusminus)
926 /* Find selector part. */
927 name = (char *) strchr(name+2, ' ');
928 if (regexp == NULL || re_exec(++name) != 0)
929 sym_arr[matches++] = (struct symbol *) msymbol;
933 qsort (sym_arr, matches, sizeof (struct minimal_symbol *),
935 /* Prevent compare on first iteration. */
937 for (ix = 0; ix < matches; ix++) /* Now do the output. */
942 name = SYMBOL_NATURAL_NAME (sym_arr[ix]);
943 name = strchr (name, ' ') + 1;
944 if (p[0] && specialcmp(name, p) == 0)
945 continue; /* Seen this one already (not unique). */
947 /* Copy selector part. */
948 while (*name && *name != ']')
951 /* Print in columns. */
952 puts_filtered_tabular(asel, maxlen + 1, 0);
957 printf_filtered (_("No selectors matching \"%s\"\n"), regexp ? regexp : "*");
961 * Function: compare_classes (const void *, const void *)
963 * Comparison function for use with qsort. Arguments are symbols or
964 * msymbols Compares class part of objc method name alphabetically.
968 compare_classes (const void *a, const void *b)
972 aname = SYMBOL_PRINT_NAME (*(struct symbol **) a);
973 bname = SYMBOL_PRINT_NAME (*(struct symbol **) b);
974 if (aname == NULL || bname == NULL)
975 error (_("internal: compare_classes(1)"));
977 return specialcmp (aname+1, bname+1);
981 * Function: classes_info(regexp, from_tty)
983 * Implements the "info classes" command for objective c classes.
984 * Lists all objective c classes that match the optional regexp.
985 * Works by grepping thru the list of objective c methods. List will
986 * be sorted and uniqued (since one class may have many methods).
987 * BUGS: will not list a class that has no methods.
991 classes_info (char *regexp, int from_tty)
993 struct objfile *objfile;
994 struct minimal_symbol *msymbol;
1000 char myregexp[2048];
1002 struct symbol **sym_arr;
1005 strcpy(myregexp, ".* "); /* Null input: match all objc classes. */
1008 strcpy(myregexp, regexp);
1009 if (myregexp[strlen(myregexp) - 1] == '$')
1010 /* In the method name, the end of the class name is marked by ' '. */
1011 myregexp[strlen(myregexp) - 1] = ' ';
1013 strcat(myregexp, ".* ");
1018 val = re_comp (myregexp);
1020 error (_("Invalid regexp (%s): %s"), val, regexp);
1023 /* First time thru is JUST to get max length and count. */
1024 ALL_MSYMBOLS (objfile, msymbol)
1027 name = SYMBOL_NATURAL_NAME (msymbol);
1029 (name[0] == '-' || name[0] == '+') &&
1030 name[1] == '[') /* Got a method name. */
1031 if (regexp == NULL || re_exec(name+2) != 0)
1033 /* Compute length of classname part. */
1034 char *mystart = name + 2;
1035 char *myend = (char *) strchr(mystart, ' ');
1037 if (myend && (myend - mystart > maxlen))
1038 maxlen = myend - mystart;
1044 printf_filtered (_("Classes matching \"%s\":\n\n"),
1045 regexp ? regexp : "*");
1046 sym_arr = alloca (matches * sizeof (struct symbol *));
1048 ALL_MSYMBOLS (objfile, msymbol)
1051 name = SYMBOL_NATURAL_NAME (msymbol);
1053 (name[0] == '-' || name[0] == '+') &&
1054 name[1] == '[') /* Got a method name. */
1055 if (regexp == NULL || re_exec(name+2) != 0)
1056 sym_arr[matches++] = (struct symbol *) msymbol;
1059 qsort (sym_arr, matches, sizeof (struct minimal_symbol *),
1061 /* Prevent compare on first iteration. */
1063 for (ix = 0; ix < matches; ix++) /* Now do the output. */
1068 name = SYMBOL_NATURAL_NAME (sym_arr[ix]);
1070 if (p[0] && specialcmp(name, p) == 0)
1071 continue; /* Seen this one already (not unique). */
1073 /* Copy class part of method name. */
1074 while (*name && *name != ' ')
1077 /* Print in columns. */
1078 puts_filtered_tabular(aclass, maxlen + 1, 0);
1083 printf_filtered (_("No classes matching \"%s\"\n"), regexp ? regexp : "*");
1087 * Function: find_imps (char *selector, struct symbol **sym_arr)
1089 * Input: a string representing a selector
1090 * a pointer to an array of symbol pointers
1091 * possibly a pointer to a symbol found by the caller.
1093 * Output: number of methods that implement that selector. Side
1094 * effects: The array of symbol pointers is filled with matching syms.
1096 * By analogy with function "find_methods" (symtab.c), builds a list
1097 * of symbols matching the ambiguous input, so that "decode_line_2"
1098 * (symtab.c) can list them and ask the user to choose one or more.
1099 * In this case the matches are objective c methods
1100 * ("implementations") matching an objective c selector.
1102 * Note that it is possible for a normal (c-style) function to have
1103 * the same name as an objective c selector. To prevent the selector
1104 * from eclipsing the function, we allow the caller (decode_line_1) to
1105 * search for such a function first, and if it finds one, pass it in
1106 * to us. We will then integrate it into the list. We also search
1107 * for one here, among the minsyms.
1109 * NOTE: if NUM_DEBUGGABLE is non-zero, the sym_arr will be divided
1110 * into two parts: debuggable (struct symbol) syms, and
1111 * non_debuggable (struct minimal_symbol) syms. The debuggable
1112 * ones will come first, before NUM_DEBUGGABLE (which will thus
1113 * be the index of the first non-debuggable one).
1117 * Function: total_number_of_imps (char *selector);
1119 * Input: a string representing a selector
1120 * Output: number of methods that implement that selector.
1122 * By analogy with function "total_number_of_methods", this allows
1123 * decode_line_1 (symtab.c) to detect if there are objective c methods
1124 * matching the input, and to allocate an array of pointers to them
1125 * which can be manipulated by "decode_line_2" (also in symtab.c).
1129 parse_selector (char *method, char **selector)
1133 int found_quote = 0;
1135 char *nselector = NULL;
1137 gdb_assert (selector != NULL);
1141 while (isspace (*s1))
1148 while (isspace (*s1))
1155 if (isalnum (*s2) || (*s2 == '_') || (*s2 == ':'))
1157 else if (isspace (*s2))
1159 else if ((*s2 == '\0') || (*s2 == '\''))
1167 while (isspace (*s2))
1173 while (isspace (*s2))
1177 if (selector != NULL)
1178 *selector = nselector;
1184 parse_method (char *method, char *type, char **class,
1185 char **category, char **selector)
1189 int found_quote = 0;
1192 char *nclass = NULL;
1193 char *ncategory = NULL;
1194 char *nselector = NULL;
1196 gdb_assert (type != NULL);
1197 gdb_assert (class != NULL);
1198 gdb_assert (category != NULL);
1199 gdb_assert (selector != NULL);
1203 while (isspace (*s1))
1210 while (isspace (*s1))
1213 if ((s1[0] == '+') || (s1[0] == '-'))
1216 while (isspace (*s1))
1224 while (isalnum (*s1) || (*s1 == '_'))
1228 while (isspace (*s2))
1234 while (isspace (*s2))
1237 while (isalnum (*s2) || (*s2 == '_'))
1242 /* Truncate the class name now that we're not using the open paren. */
1249 if (isalnum (*s2) || (*s2 == '_') || (*s2 == ':'))
1251 else if (isspace (*s2))
1253 else if (*s2 == ']')
1262 while (isspace (*s2))
1269 while (isspace (*s2))
1277 if (category != NULL)
1278 *category = ncategory;
1279 if (selector != NULL)
1280 *selector = nselector;
1286 find_methods (struct symtab *symtab, char type,
1287 const char *class, const char *category,
1288 const char *selector, struct symbol **syms,
1289 unsigned int *nsym, unsigned int *ndebug)
1291 struct objfile *objfile = NULL;
1292 struct minimal_symbol *msymbol = NULL;
1293 struct block *block = NULL;
1294 struct symbol *sym = NULL;
1296 char *symname = NULL;
1299 char *nclass = NULL;
1300 char *ncategory = NULL;
1301 char *nselector = NULL;
1303 unsigned int csym = 0;
1304 unsigned int cdebug = 0;
1306 static char *tmp = NULL;
1307 static unsigned int tmplen = 0;
1309 gdb_assert (nsym != NULL);
1310 gdb_assert (ndebug != NULL);
1313 block = BLOCKVECTOR_BLOCK (BLOCKVECTOR (symtab), STATIC_BLOCK);
1315 ALL_MSYMBOLS (objfile, msymbol)
1319 if ((msymbol->type != mst_text) && (msymbol->type != mst_file_text))
1320 /* Not a function or method. */
1324 if ((SYMBOL_VALUE_ADDRESS (msymbol) < BLOCK_START (block)) ||
1325 (SYMBOL_VALUE_ADDRESS (msymbol) >= BLOCK_END (block)))
1326 /* Not in the specified symtab. */
1329 symname = SYMBOL_NATURAL_NAME (msymbol);
1330 if (symname == NULL)
1333 if ((symname[0] != '-' && symname[0] != '+') || (symname[1] != '['))
1334 /* Not a method name. */
1337 while ((strlen (symname) + 1) >= tmplen)
1339 tmplen = (tmplen == 0) ? 1024 : tmplen * 2;
1340 tmp = xrealloc (tmp, tmplen);
1342 strcpy (tmp, symname);
1344 if (parse_method (tmp, &ntype, &nclass, &ncategory, &nselector) == NULL)
1347 if ((type != '\0') && (ntype != type))
1351 && ((nclass == NULL) || (strcmp (class, nclass) != 0)))
1354 if ((category != NULL) &&
1355 ((ncategory == NULL) || (strcmp (category, ncategory) != 0)))
1358 if ((selector != NULL) &&
1359 ((nselector == NULL) || (strcmp (selector, nselector) != 0)))
1362 sym = find_pc_function (SYMBOL_VALUE_ADDRESS (msymbol));
1365 const char *newsymname = SYMBOL_NATURAL_NAME (sym);
1367 if (strcmp (symname, newsymname) == 0)
1369 /* Found a high-level method sym: swap it into the
1370 lower part of sym_arr (below num_debuggable). */
1373 syms[csym] = syms[cdebug];
1382 "debugging symbol \"%s\" does not match minimal symbol (\"%s\"); ignoring",
1383 newsymname, symname);
1385 syms[csym] = (struct symbol *) msymbol;
1391 /* Found a non-debuggable method symbol. */
1393 syms[csym] = (struct symbol *) msymbol;
1404 char *find_imps (struct symtab *symtab, struct block *block,
1405 char *method, struct symbol **syms,
1406 unsigned int *nsym, unsigned int *ndebug)
1410 char *category = NULL;
1411 char *selector = NULL;
1413 unsigned int csym = 0;
1414 unsigned int cdebug = 0;
1416 unsigned int ncsym = 0;
1417 unsigned int ncdebug = 0;
1422 gdb_assert (nsym != NULL);
1423 gdb_assert (ndebug != NULL);
1430 buf = (char *) alloca (strlen (method) + 1);
1431 strcpy (buf, method);
1432 tmp = parse_method (buf, &type, &class, &category, &selector);
1436 struct symbol *sym = NULL;
1437 struct minimal_symbol *msym = NULL;
1439 strcpy (buf, method);
1440 tmp = parse_selector (buf, &selector);
1445 sym = lookup_symbol (selector, block, VAR_DOMAIN, 0, NULL);
1455 msym = lookup_minimal_symbol (selector, 0, 0);
1460 syms[csym] = (struct symbol *)msym;
1466 find_methods (symtab, type, class, category, selector,
1467 syms + csym, &ncsym, &ncdebug);
1469 find_methods (symtab, type, class, category, selector,
1470 NULL, &ncsym, &ncdebug);
1472 /* If we didn't find any methods, just return. */
1473 if (ncsym == 0 && ncdebug == 0)
1476 /* Take debug symbols from the second batch of symbols and swap them
1477 * with debug symbols from the first batch. Repeat until either the
1478 * second section is out of debug symbols or the first section is
1479 * full of debug symbols. Either way we have all debug symbols
1480 * packed to the beginning of the buffer.
1485 while ((cdebug < csym) && (ncdebug > 0))
1487 struct symbol *s = NULL;
1488 /* First non-debugging symbol. */
1489 unsigned int i = cdebug;
1490 /* Last of second batch of debug symbols. */
1491 unsigned int j = csym + ncdebug - 1;
1497 /* We've moved a symbol from the second debug section to the
1513 return method + (tmp - buf);
1517 /* Sort debuggable symbols. */
1519 qsort (syms, cdebug, sizeof (struct minimal_symbol *),
1522 /* Sort minimal_symbols. */
1523 if ((csym - cdebug) > 1)
1524 qsort (&syms[cdebug], csym - cdebug,
1525 sizeof (struct minimal_symbol *), compare_classes);
1527 /* Terminate the sym_arr list. */
1530 return method + (tmp - buf);
1534 print_object_command (char *args, int from_tty)
1536 struct value *object, *function, *description;
1537 CORE_ADDR string_addr, object_addr;
1541 if (!args || !*args)
1543 "The 'print-object' command requires an argument (an Objective-C object)");
1546 struct expression *expr = parse_expression (args);
1547 struct cleanup *old_chain =
1548 make_cleanup (free_current_contents, &expr);
1551 object = expr->language_defn->la_exp_desc->evaluate_exp
1552 (builtin_type_void_data_ptr, expr, &pc, EVAL_NORMAL);
1553 do_cleanups (old_chain);
1556 /* Validate the address for sanity. */
1557 object_addr = value_as_long (object);
1558 read_memory (object_addr, &c, 1);
1560 function = find_function_in_inferior ("_NSPrintForDebugger");
1561 if (function == NULL)
1562 error (_("Unable to locate _NSPrintForDebugger in child process"));
1564 description = call_function_by_hand (function, 1, &object);
1566 string_addr = value_as_long (description);
1567 if (string_addr == 0)
1568 error (_("object returns null description"));
1570 read_memory (string_addr + i++, &c, 1);
1573 { /* Read and print characters up to EOS. */
1575 printf_filtered ("%c", c);
1576 read_memory (string_addr + i++, &c, 1);
1579 printf_filtered(_("<object returns empty description>"));
1580 printf_filtered ("\n");
1583 /* The data structure 'methcalls' is used to detect method calls (thru
1584 * ObjC runtime lib functions objc_msgSend, objc_msgSendSuper, etc.),
1585 * and ultimately find the method being called.
1588 struct objc_methcall {
1590 /* Return instance method to be called. */
1591 int (*stop_at) (CORE_ADDR, CORE_ADDR *);
1592 /* Start of pc range corresponding to method invocation. */
1594 /* End of pc range corresponding to method invocation. */
1598 static int resolve_msgsend (CORE_ADDR pc, CORE_ADDR *new_pc);
1599 static int resolve_msgsend_stret (CORE_ADDR pc, CORE_ADDR *new_pc);
1600 static int resolve_msgsend_super (CORE_ADDR pc, CORE_ADDR *new_pc);
1601 static int resolve_msgsend_super_stret (CORE_ADDR pc, CORE_ADDR *new_pc);
1603 static struct objc_methcall methcalls[] = {
1604 { "_objc_msgSend", resolve_msgsend, 0, 0},
1605 { "_objc_msgSend_stret", resolve_msgsend_stret, 0, 0},
1606 { "_objc_msgSendSuper", resolve_msgsend_super, 0, 0},
1607 { "_objc_msgSendSuper_stret", resolve_msgsend_super_stret, 0, 0},
1608 { "_objc_getClass", NULL, 0, 0},
1609 { "_objc_getMetaClass", NULL, 0, 0}
1612 #define nmethcalls (sizeof (methcalls) / sizeof (methcalls[0]))
1614 /* The following function, "find_objc_msgsend", fills in the data
1615 * structure "objc_msgs" by finding the addresses of each of the
1616 * (currently four) functions that it holds (of which objc_msgSend is
1617 * the first). This must be called each time symbols are loaded, in
1618 * case the functions have moved for some reason.
1622 find_objc_msgsend (void)
1625 for (i = 0; i < nmethcalls; i++) {
1627 struct minimal_symbol *func;
1629 /* Try both with and without underscore. */
1630 func = lookup_minimal_symbol (methcalls[i].name, NULL, NULL);
1631 if ((func == NULL) && (methcalls[i].name[0] == '_')) {
1632 func = lookup_minimal_symbol (methcalls[i].name + 1, NULL, NULL);
1635 methcalls[i].begin = 0;
1636 methcalls[i].end = 0;
1640 methcalls[i].begin = SYMBOL_VALUE_ADDRESS (func);
1642 methcalls[i].end = SYMBOL_VALUE_ADDRESS (++func);
1643 } while (methcalls[i].begin == methcalls[i].end);
1647 /* find_objc_msgcall (replaces pc_off_limits)
1649 * ALL that this function now does is to determine whether the input
1650 * address ("pc") is the address of one of the Objective-C message
1651 * dispatch functions (mainly objc_msgSend or objc_msgSendSuper), and
1652 * if so, it returns the address of the method that will be called.
1654 * The old function "pc_off_limits" used to do a lot of other things
1655 * in addition, such as detecting shared library jump stubs and
1656 * returning the address of the shlib function that would be called.
1657 * That functionality has been moved into the gdbarch_skip_trampoline_code and
1658 * IN_SOLIB_TRAMPOLINE macros, which are resolved in the target-
1659 * dependent modules.
1662 struct objc_submethod_helper_data {
1663 int (*f) (CORE_ADDR, CORE_ADDR *);
1669 find_objc_msgcall_submethod_helper (void * arg)
1671 struct objc_submethod_helper_data *s =
1672 (struct objc_submethod_helper_data *) arg;
1674 if (s->f (s->pc, s->new_pc) == 0)
1681 find_objc_msgcall_submethod (int (*f) (CORE_ADDR, CORE_ADDR *),
1685 struct objc_submethod_helper_data s;
1691 if (catch_errors (find_objc_msgcall_submethod_helper,
1693 "Unable to determine target of Objective-C method call (ignoring):\n",
1694 RETURN_MASK_ALL) == 0)
1701 find_objc_msgcall (CORE_ADDR pc, CORE_ADDR *new_pc)
1705 find_objc_msgsend ();
1711 for (i = 0; i < nmethcalls; i++)
1712 if ((pc >= methcalls[i].begin) && (pc < methcalls[i].end))
1714 if (methcalls[i].stop_at != NULL)
1715 return find_objc_msgcall_submethod (methcalls[i].stop_at,
1724 extern initialize_file_ftype _initialize_objc_language; /* -Wmissing-prototypes */
1727 _initialize_objc_language (void)
1729 add_language (&objc_language_defn);
1730 add_info ("selectors", selectors_info, /* INFO SELECTORS command. */
1731 _("All Objective-C selectors, or those matching REGEXP."));
1732 add_info ("classes", classes_info, /* INFO CLASSES command. */
1733 _("All Objective-C classes, or those matching REGEXP."));
1734 add_com ("print-object", class_vars, print_object_command,
1735 _("Ask an Objective-C object to print itself."));
1736 add_com_alias ("po", "print-object", class_vars, 1);
1740 read_objc_method (CORE_ADDR addr, struct objc_method *method)
1742 method->name = read_memory_unsigned_integer (addr + 0, 4);
1743 method->types = read_memory_unsigned_integer (addr + 4, 4);
1744 method->imp = read_memory_unsigned_integer (addr + 8, 4);
1748 unsigned long read_objc_methlist_nmethods (CORE_ADDR addr)
1750 return read_memory_unsigned_integer (addr + 4, 4);
1754 read_objc_methlist_method (CORE_ADDR addr, unsigned long num,
1755 struct objc_method *method)
1757 gdb_assert (num < read_objc_methlist_nmethods (addr));
1758 read_objc_method (addr + 8 + (12 * num), method);
1762 read_objc_object (CORE_ADDR addr, struct objc_object *object)
1764 object->isa = read_memory_unsigned_integer (addr, 4);
1768 read_objc_super (CORE_ADDR addr, struct objc_super *super)
1770 super->receiver = read_memory_unsigned_integer (addr, 4);
1771 super->class = read_memory_unsigned_integer (addr + 4, 4);
1775 read_objc_class (CORE_ADDR addr, struct objc_class *class)
1777 class->isa = read_memory_unsigned_integer (addr, 4);
1778 class->super_class = read_memory_unsigned_integer (addr + 4, 4);
1779 class->name = read_memory_unsigned_integer (addr + 8, 4);
1780 class->version = read_memory_unsigned_integer (addr + 12, 4);
1781 class->info = read_memory_unsigned_integer (addr + 16, 4);
1782 class->instance_size = read_memory_unsigned_integer (addr + 18, 4);
1783 class->ivars = read_memory_unsigned_integer (addr + 24, 4);
1784 class->methods = read_memory_unsigned_integer (addr + 28, 4);
1785 class->cache = read_memory_unsigned_integer (addr + 32, 4);
1786 class->protocols = read_memory_unsigned_integer (addr + 36, 4);
1790 find_implementation_from_class (CORE_ADDR class, CORE_ADDR sel)
1792 CORE_ADDR subclass = class;
1794 while (subclass != 0)
1797 struct objc_class class_str;
1798 unsigned mlistnum = 0;
1800 read_objc_class (subclass, &class_str);
1805 unsigned long nmethods;
1808 mlist = read_memory_unsigned_integer (class_str.methods +
1813 nmethods = read_objc_methlist_nmethods (mlist);
1815 for (i = 0; i < nmethods; i++)
1817 struct objc_method meth_str;
1818 read_objc_methlist_method (mlist, i, &meth_str);
1822 "checking method 0x%lx against selector 0x%lx\n",
1823 meth_str.name, sel);
1826 if (meth_str.name == sel)
1827 /* FIXME: hppa arch was doing a pointer dereference
1828 here. There needs to be a better way to do that. */
1829 return meth_str.imp;
1833 subclass = class_str.super_class;
1840 find_implementation (CORE_ADDR object, CORE_ADDR sel)
1842 struct objc_object ostr;
1846 read_objc_object (object, &ostr);
1850 return find_implementation_from_class (ostr.isa, sel);
1853 #define OBJC_FETCH_POINTER_ARGUMENT(argi) \
1854 gdbarch_fetch_pointer_argument (current_gdbarch, get_current_frame (), \
1855 argi, builtin_type_void_func_ptr)
1858 resolve_msgsend (CORE_ADDR pc, CORE_ADDR *new_pc)
1864 object = OBJC_FETCH_POINTER_ARGUMENT (0);
1865 sel = OBJC_FETCH_POINTER_ARGUMENT (1);
1867 res = find_implementation (object, sel);
1876 resolve_msgsend_stret (CORE_ADDR pc, CORE_ADDR *new_pc)
1882 object = OBJC_FETCH_POINTER_ARGUMENT (1);
1883 sel = OBJC_FETCH_POINTER_ARGUMENT (2);
1885 res = find_implementation (object, sel);
1894 resolve_msgsend_super (CORE_ADDR pc, CORE_ADDR *new_pc)
1896 struct objc_super sstr;
1902 super = OBJC_FETCH_POINTER_ARGUMENT (0);
1903 sel = OBJC_FETCH_POINTER_ARGUMENT (1);
1905 read_objc_super (super, &sstr);
1906 if (sstr.class == 0)
1909 res = find_implementation_from_class (sstr.class, sel);
1918 resolve_msgsend_super_stret (CORE_ADDR pc, CORE_ADDR *new_pc)
1920 struct objc_super sstr;
1926 super = OBJC_FETCH_POINTER_ARGUMENT (1);
1927 sel = OBJC_FETCH_POINTER_ARGUMENT (2);
1929 read_objc_super (super, &sstr);
1930 if (sstr.class == 0)
1933 res = find_implementation_from_class (sstr.class, sel);