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 TARGET_FLOAT_BIT / TARGET_CHAR_BIT,
554 0, "float", objfile);
556 case FT_DBL_PREC_FLOAT:
557 type = init_type (TYPE_CODE_FLT,
558 TARGET_DOUBLE_BIT / TARGET_CHAR_BIT,
559 0, "double", objfile);
561 case FT_EXT_PREC_FLOAT:
562 type = init_type (TYPE_CODE_FLT,
563 TARGET_LONG_DOUBLE_BIT / TARGET_CHAR_BIT,
564 0, "long double", objfile);
570 /* Determine if we are currently in the Objective-C dispatch function.
571 If so, get the address of the method function that the dispatcher
572 would call and use that as the function to step into instead. Also
573 skip over the trampoline for the function (if any). This is better
574 for the user since they are only interested in stepping into the
575 method function anyway. */
577 objc_skip_trampoline (CORE_ADDR stop_pc)
579 CORE_ADDR real_stop_pc;
580 CORE_ADDR method_stop_pc;
582 real_stop_pc = gdbarch_skip_trampoline_code (current_gdbarch, stop_pc);
584 if (real_stop_pc != 0)
585 find_objc_msgcall (real_stop_pc, &method_stop_pc);
587 find_objc_msgcall (stop_pc, &method_stop_pc);
591 real_stop_pc = gdbarch_skip_trampoline_code
592 (current_gdbarch, method_stop_pc);
593 if (real_stop_pc == 0)
594 real_stop_pc = method_stop_pc;
601 /* Table mapping opcodes into strings for printing operators
602 and precedences of the operators. */
604 static const struct op_print objc_op_print_tab[] =
606 {",", BINOP_COMMA, PREC_COMMA, 0},
607 {"=", BINOP_ASSIGN, PREC_ASSIGN, 1},
608 {"||", BINOP_LOGICAL_OR, PREC_LOGICAL_OR, 0},
609 {"&&", BINOP_LOGICAL_AND, PREC_LOGICAL_AND, 0},
610 {"|", BINOP_BITWISE_IOR, PREC_BITWISE_IOR, 0},
611 {"^", BINOP_BITWISE_XOR, PREC_BITWISE_XOR, 0},
612 {"&", BINOP_BITWISE_AND, PREC_BITWISE_AND, 0},
613 {"==", BINOP_EQUAL, PREC_EQUAL, 0},
614 {"!=", BINOP_NOTEQUAL, PREC_EQUAL, 0},
615 {"<=", BINOP_LEQ, PREC_ORDER, 0},
616 {">=", BINOP_GEQ, PREC_ORDER, 0},
617 {">", BINOP_GTR, PREC_ORDER, 0},
618 {"<", BINOP_LESS, PREC_ORDER, 0},
619 {">>", BINOP_RSH, PREC_SHIFT, 0},
620 {"<<", BINOP_LSH, PREC_SHIFT, 0},
621 {"+", BINOP_ADD, PREC_ADD, 0},
622 {"-", BINOP_SUB, PREC_ADD, 0},
623 {"*", BINOP_MUL, PREC_MUL, 0},
624 {"/", BINOP_DIV, PREC_MUL, 0},
625 {"%", BINOP_REM, PREC_MUL, 0},
626 {"@", BINOP_REPEAT, PREC_REPEAT, 0},
627 {"-", UNOP_NEG, PREC_PREFIX, 0},
628 {"!", UNOP_LOGICAL_NOT, PREC_PREFIX, 0},
629 {"~", UNOP_COMPLEMENT, PREC_PREFIX, 0},
630 {"*", UNOP_IND, PREC_PREFIX, 0},
631 {"&", UNOP_ADDR, PREC_PREFIX, 0},
632 {"sizeof ", UNOP_SIZEOF, PREC_PREFIX, 0},
633 {"++", UNOP_PREINCREMENT, PREC_PREFIX, 0},
634 {"--", UNOP_PREDECREMENT, PREC_PREFIX, 0},
635 {NULL, OP_NULL, PREC_NULL, 0}
638 struct type ** const (objc_builtin_types[]) =
645 &builtin_type_double,
647 &builtin_type_long_long,
648 &builtin_type_signed_char,
649 &builtin_type_unsigned_char,
650 &builtin_type_unsigned_short,
651 &builtin_type_unsigned_int,
652 &builtin_type_unsigned_long,
653 &builtin_type_unsigned_long_long,
654 &builtin_type_long_double,
655 &builtin_type_complex,
656 &builtin_type_double_complex,
660 const struct language_defn objc_language_defn = {
661 "objective-c", /* Language name */
668 &exp_descriptor_standard,
672 objc_printchar, /* Print a character constant */
673 objc_printstr, /* Function to print string constant */
675 objc_create_fundamental_type, /* Create fundamental type in this language */
676 c_print_type, /* Print a type using appropriate syntax */
677 c_val_print, /* Print a value using appropriate syntax */
678 c_value_print, /* Print a top-level value */
679 objc_skip_trampoline, /* Language specific skip_trampoline */
680 value_of_this, /* value_of_this */
681 basic_lookup_symbol_nonlocal, /* lookup_symbol_nonlocal */
682 basic_lookup_transparent_type,/* lookup_transparent_type */
683 objc_demangle, /* Language specific symbol demangler */
684 NULL, /* Language specific class_name_from_physname */
685 objc_op_print_tab, /* Expression operators for printing */
686 1, /* C-style arrays */
687 0, /* String lower bound */
688 &builtin_type_char, /* Type of string elements */
689 default_word_break_characters,
690 NULL, /* FIXME: la_language_arch_info. */
691 default_print_array_index,
697 * Following functions help construct Objective-C message calls
700 struct selname /* For parsing Objective-C. */
702 struct selname *next;
707 static int msglist_len;
708 static struct selname *selname_chain;
709 static char *msglist_sel;
714 struct selname *new =
715 (struct selname *) xmalloc (sizeof (struct selname));
717 new->next = selname_chain;
718 new->msglist_len = msglist_len;
719 new->msglist_sel = msglist_sel;
721 msglist_sel = (char *)xmalloc(1);
727 add_msglist(struct stoken *str, int addcolon)
732 if (str == 0) { /* Unnamed arg, or... */
733 if (addcolon == 0) { /* variable number of args. */
743 len = plen + strlen(msglist_sel) + 2;
744 s = (char *)xmalloc(len);
745 strcpy(s, msglist_sel);
760 int val = msglist_len;
761 struct selname *sel = selname_chain;
762 char *p = msglist_sel;
765 selname_chain = sel->next;
766 msglist_len = sel->msglist_len;
767 msglist_sel = sel->msglist_sel;
768 selid = lookup_child_selector(p);
770 error (_("Can't find selector \"%s\""), p);
771 write_exp_elt_longcst (selid);
773 write_exp_elt_longcst (val); /* Number of args */
780 * Function: specialcmp (char *a, char *b)
782 * Special strcmp: treats ']' and ' ' as end-of-string.
783 * Used for qsorting lists of objc methods (either by class or selector).
787 specialcmp (char *a, char *b)
789 while (*a && *a != ' ' && *a != ']' && *b && *b != ' ' && *b != ']')
795 if (*a && *a != ' ' && *a != ']')
796 return 1; /* a is longer therefore greater */
797 if (*b && *b != ' ' && *b != ']')
798 return -1; /* a is shorter therefore lesser */
799 return 0; /* a and b are identical */
803 * Function: compare_selectors (const void *, const void *)
805 * Comparison function for use with qsort. Arguments are symbols or
806 * msymbols Compares selector part of objc method name alphabetically.
810 compare_selectors (const void *a, const void *b)
814 aname = SYMBOL_PRINT_NAME (*(struct symbol **) a);
815 bname = SYMBOL_PRINT_NAME (*(struct symbol **) b);
816 if (aname == NULL || bname == NULL)
817 error (_("internal: compare_selectors(1)"));
819 aname = strchr(aname, ' ');
820 bname = strchr(bname, ' ');
821 if (aname == NULL || bname == NULL)
822 error (_("internal: compare_selectors(2)"));
824 return specialcmp (aname+1, bname+1);
828 * Function: selectors_info (regexp, from_tty)
830 * Implements the "Info selectors" command. Takes an optional regexp
831 * arg. Lists all objective c selectors that match the regexp. Works
832 * by grepping thru all symbols for objective c methods. Output list
833 * is sorted and uniqued.
837 selectors_info (char *regexp, int from_tty)
839 struct objfile *objfile;
840 struct minimal_symbol *msymbol;
848 struct symbol **sym_arr;
852 strcpy(myregexp, ".*]"); /* Null input, match all objc methods. */
855 if (*regexp == '+' || *regexp == '-')
856 { /* User wants only class methods or only instance methods. */
857 plusminus = *regexp++;
858 while (*regexp == ' ' || *regexp == '\t')
862 strcpy(myregexp, ".*]");
865 strcpy(myregexp, regexp);
866 if (myregexp[strlen(myregexp) - 1] == '$') /* end of selector */
867 myregexp[strlen(myregexp) - 1] = ']'; /* end of method name */
869 strcat(myregexp, ".*]");
875 val = re_comp (myregexp);
877 error (_("Invalid regexp (%s): %s"), val, regexp);
880 /* First time thru is JUST to get max length and count. */
881 ALL_MSYMBOLS (objfile, msymbol)
884 name = SYMBOL_NATURAL_NAME (msymbol);
886 (name[0] == '-' || name[0] == '+') &&
887 name[1] == '[') /* Got a method name. */
889 /* Filter for class/instance methods. */
890 if (plusminus && name[0] != plusminus)
892 /* Find selector part. */
893 name = (char *) strchr(name+2, ' ');
894 if (regexp == NULL || re_exec(++name) != 0)
896 char *mystart = name;
897 char *myend = (char *) strchr(mystart, ']');
899 if (myend && (myend - mystart > maxlen))
900 maxlen = myend - mystart; /* Get longest selector. */
907 printf_filtered (_("Selectors matching \"%s\":\n\n"),
908 regexp ? regexp : "*");
910 sym_arr = alloca (matches * sizeof (struct symbol *));
912 ALL_MSYMBOLS (objfile, msymbol)
915 name = SYMBOL_NATURAL_NAME (msymbol);
917 (name[0] == '-' || name[0] == '+') &&
918 name[1] == '[') /* Got a method name. */
920 /* Filter for class/instance methods. */
921 if (plusminus && name[0] != plusminus)
923 /* Find selector part. */
924 name = (char *) strchr(name+2, ' ');
925 if (regexp == NULL || re_exec(++name) != 0)
926 sym_arr[matches++] = (struct symbol *) msymbol;
930 qsort (sym_arr, matches, sizeof (struct minimal_symbol *),
932 /* Prevent compare on first iteration. */
934 for (ix = 0; ix < matches; ix++) /* Now do the output. */
939 name = SYMBOL_NATURAL_NAME (sym_arr[ix]);
940 name = strchr (name, ' ') + 1;
941 if (p[0] && specialcmp(name, p) == 0)
942 continue; /* Seen this one already (not unique). */
944 /* Copy selector part. */
945 while (*name && *name != ']')
948 /* Print in columns. */
949 puts_filtered_tabular(asel, maxlen + 1, 0);
954 printf_filtered (_("No selectors matching \"%s\"\n"), regexp ? regexp : "*");
958 * Function: compare_classes (const void *, const void *)
960 * Comparison function for use with qsort. Arguments are symbols or
961 * msymbols Compares class part of objc method name alphabetically.
965 compare_classes (const void *a, const void *b)
969 aname = SYMBOL_PRINT_NAME (*(struct symbol **) a);
970 bname = SYMBOL_PRINT_NAME (*(struct symbol **) b);
971 if (aname == NULL || bname == NULL)
972 error (_("internal: compare_classes(1)"));
974 return specialcmp (aname+1, bname+1);
978 * Function: classes_info(regexp, from_tty)
980 * Implements the "info classes" command for objective c classes.
981 * Lists all objective c classes that match the optional regexp.
982 * Works by grepping thru the list of objective c methods. List will
983 * be sorted and uniqued (since one class may have many methods).
984 * BUGS: will not list a class that has no methods.
988 classes_info (char *regexp, int from_tty)
990 struct objfile *objfile;
991 struct minimal_symbol *msymbol;
999 struct symbol **sym_arr;
1002 strcpy(myregexp, ".* "); /* Null input: match all objc classes. */
1005 strcpy(myregexp, regexp);
1006 if (myregexp[strlen(myregexp) - 1] == '$')
1007 /* In the method name, the end of the class name is marked by ' '. */
1008 myregexp[strlen(myregexp) - 1] = ' ';
1010 strcat(myregexp, ".* ");
1015 val = re_comp (myregexp);
1017 error (_("Invalid regexp (%s): %s"), val, regexp);
1020 /* First time thru is JUST to get max length and count. */
1021 ALL_MSYMBOLS (objfile, msymbol)
1024 name = SYMBOL_NATURAL_NAME (msymbol);
1026 (name[0] == '-' || name[0] == '+') &&
1027 name[1] == '[') /* Got a method name. */
1028 if (regexp == NULL || re_exec(name+2) != 0)
1030 /* Compute length of classname part. */
1031 char *mystart = name + 2;
1032 char *myend = (char *) strchr(mystart, ' ');
1034 if (myend && (myend - mystart > maxlen))
1035 maxlen = myend - mystart;
1041 printf_filtered (_("Classes matching \"%s\":\n\n"),
1042 regexp ? regexp : "*");
1043 sym_arr = alloca (matches * sizeof (struct symbol *));
1045 ALL_MSYMBOLS (objfile, msymbol)
1048 name = SYMBOL_NATURAL_NAME (msymbol);
1050 (name[0] == '-' || name[0] == '+') &&
1051 name[1] == '[') /* Got a method name. */
1052 if (regexp == NULL || re_exec(name+2) != 0)
1053 sym_arr[matches++] = (struct symbol *) msymbol;
1056 qsort (sym_arr, matches, sizeof (struct minimal_symbol *),
1058 /* Prevent compare on first iteration. */
1060 for (ix = 0; ix < matches; ix++) /* Now do the output. */
1065 name = SYMBOL_NATURAL_NAME (sym_arr[ix]);
1067 if (p[0] && specialcmp(name, p) == 0)
1068 continue; /* Seen this one already (not unique). */
1070 /* Copy class part of method name. */
1071 while (*name && *name != ' ')
1074 /* Print in columns. */
1075 puts_filtered_tabular(aclass, maxlen + 1, 0);
1080 printf_filtered (_("No classes matching \"%s\"\n"), regexp ? regexp : "*");
1084 * Function: find_imps (char *selector, struct symbol **sym_arr)
1086 * Input: a string representing a selector
1087 * a pointer to an array of symbol pointers
1088 * possibly a pointer to a symbol found by the caller.
1090 * Output: number of methods that implement that selector. Side
1091 * effects: The array of symbol pointers is filled with matching syms.
1093 * By analogy with function "find_methods" (symtab.c), builds a list
1094 * of symbols matching the ambiguous input, so that "decode_line_2"
1095 * (symtab.c) can list them and ask the user to choose one or more.
1096 * In this case the matches are objective c methods
1097 * ("implementations") matching an objective c selector.
1099 * Note that it is possible for a normal (c-style) function to have
1100 * the same name as an objective c selector. To prevent the selector
1101 * from eclipsing the function, we allow the caller (decode_line_1) to
1102 * search for such a function first, and if it finds one, pass it in
1103 * to us. We will then integrate it into the list. We also search
1104 * for one here, among the minsyms.
1106 * NOTE: if NUM_DEBUGGABLE is non-zero, the sym_arr will be divided
1107 * into two parts: debuggable (struct symbol) syms, and
1108 * non_debuggable (struct minimal_symbol) syms. The debuggable
1109 * ones will come first, before NUM_DEBUGGABLE (which will thus
1110 * be the index of the first non-debuggable one).
1114 * Function: total_number_of_imps (char *selector);
1116 * Input: a string representing a selector
1117 * Output: number of methods that implement that selector.
1119 * By analogy with function "total_number_of_methods", this allows
1120 * decode_line_1 (symtab.c) to detect if there are objective c methods
1121 * matching the input, and to allocate an array of pointers to them
1122 * which can be manipulated by "decode_line_2" (also in symtab.c).
1126 parse_selector (char *method, char **selector)
1130 int found_quote = 0;
1132 char *nselector = NULL;
1134 gdb_assert (selector != NULL);
1138 while (isspace (*s1))
1145 while (isspace (*s1))
1152 if (isalnum (*s2) || (*s2 == '_') || (*s2 == ':'))
1154 else if (isspace (*s2))
1156 else if ((*s2 == '\0') || (*s2 == '\''))
1164 while (isspace (*s2))
1170 while (isspace (*s2))
1174 if (selector != NULL)
1175 *selector = nselector;
1181 parse_method (char *method, char *type, char **class,
1182 char **category, char **selector)
1186 int found_quote = 0;
1189 char *nclass = NULL;
1190 char *ncategory = NULL;
1191 char *nselector = NULL;
1193 gdb_assert (type != NULL);
1194 gdb_assert (class != NULL);
1195 gdb_assert (category != NULL);
1196 gdb_assert (selector != NULL);
1200 while (isspace (*s1))
1207 while (isspace (*s1))
1210 if ((s1[0] == '+') || (s1[0] == '-'))
1213 while (isspace (*s1))
1221 while (isalnum (*s1) || (*s1 == '_'))
1225 while (isspace (*s2))
1231 while (isspace (*s2))
1234 while (isalnum (*s2) || (*s2 == '_'))
1239 /* Truncate the class name now that we're not using the open paren. */
1246 if (isalnum (*s2) || (*s2 == '_') || (*s2 == ':'))
1248 else if (isspace (*s2))
1250 else if (*s2 == ']')
1259 while (isspace (*s2))
1266 while (isspace (*s2))
1274 if (category != NULL)
1275 *category = ncategory;
1276 if (selector != NULL)
1277 *selector = nselector;
1283 find_methods (struct symtab *symtab, char type,
1284 const char *class, const char *category,
1285 const char *selector, struct symbol **syms,
1286 unsigned int *nsym, unsigned int *ndebug)
1288 struct objfile *objfile = NULL;
1289 struct minimal_symbol *msymbol = NULL;
1290 struct block *block = NULL;
1291 struct symbol *sym = NULL;
1293 char *symname = NULL;
1296 char *nclass = NULL;
1297 char *ncategory = NULL;
1298 char *nselector = NULL;
1300 unsigned int csym = 0;
1301 unsigned int cdebug = 0;
1303 static char *tmp = NULL;
1304 static unsigned int tmplen = 0;
1306 gdb_assert (nsym != NULL);
1307 gdb_assert (ndebug != NULL);
1310 block = BLOCKVECTOR_BLOCK (BLOCKVECTOR (symtab), STATIC_BLOCK);
1312 ALL_MSYMBOLS (objfile, msymbol)
1316 if ((msymbol->type != mst_text) && (msymbol->type != mst_file_text))
1317 /* Not a function or method. */
1321 if ((SYMBOL_VALUE_ADDRESS (msymbol) < BLOCK_START (block)) ||
1322 (SYMBOL_VALUE_ADDRESS (msymbol) >= BLOCK_END (block)))
1323 /* Not in the specified symtab. */
1326 symname = SYMBOL_NATURAL_NAME (msymbol);
1327 if (symname == NULL)
1330 if ((symname[0] != '-' && symname[0] != '+') || (symname[1] != '['))
1331 /* Not a method name. */
1334 while ((strlen (symname) + 1) >= tmplen)
1336 tmplen = (tmplen == 0) ? 1024 : tmplen * 2;
1337 tmp = xrealloc (tmp, tmplen);
1339 strcpy (tmp, symname);
1341 if (parse_method (tmp, &ntype, &nclass, &ncategory, &nselector) == NULL)
1344 if ((type != '\0') && (ntype != type))
1348 && ((nclass == NULL) || (strcmp (class, nclass) != 0)))
1351 if ((category != NULL) &&
1352 ((ncategory == NULL) || (strcmp (category, ncategory) != 0)))
1355 if ((selector != NULL) &&
1356 ((nselector == NULL) || (strcmp (selector, nselector) != 0)))
1359 sym = find_pc_function (SYMBOL_VALUE_ADDRESS (msymbol));
1362 const char *newsymname = SYMBOL_NATURAL_NAME (sym);
1364 if (strcmp (symname, newsymname) == 0)
1366 /* Found a high-level method sym: swap it into the
1367 lower part of sym_arr (below num_debuggable). */
1370 syms[csym] = syms[cdebug];
1379 "debugging symbol \"%s\" does not match minimal symbol (\"%s\"); ignoring",
1380 newsymname, symname);
1382 syms[csym] = (struct symbol *) msymbol;
1388 /* Found a non-debuggable method symbol. */
1390 syms[csym] = (struct symbol *) msymbol;
1401 char *find_imps (struct symtab *symtab, struct block *block,
1402 char *method, struct symbol **syms,
1403 unsigned int *nsym, unsigned int *ndebug)
1407 char *category = NULL;
1408 char *selector = NULL;
1410 unsigned int csym = 0;
1411 unsigned int cdebug = 0;
1413 unsigned int ncsym = 0;
1414 unsigned int ncdebug = 0;
1419 gdb_assert (nsym != NULL);
1420 gdb_assert (ndebug != NULL);
1427 buf = (char *) alloca (strlen (method) + 1);
1428 strcpy (buf, method);
1429 tmp = parse_method (buf, &type, &class, &category, &selector);
1433 struct symbol *sym = NULL;
1434 struct minimal_symbol *msym = NULL;
1436 strcpy (buf, method);
1437 tmp = parse_selector (buf, &selector);
1442 sym = lookup_symbol (selector, block, VAR_DOMAIN, 0, NULL);
1452 msym = lookup_minimal_symbol (selector, 0, 0);
1457 syms[csym] = (struct symbol *)msym;
1463 find_methods (symtab, type, class, category, selector,
1464 syms + csym, &ncsym, &ncdebug);
1466 find_methods (symtab, type, class, category, selector,
1467 NULL, &ncsym, &ncdebug);
1469 /* If we didn't find any methods, just return. */
1470 if (ncsym == 0 && ncdebug == 0)
1473 /* Take debug symbols from the second batch of symbols and swap them
1474 * with debug symbols from the first batch. Repeat until either the
1475 * second section is out of debug symbols or the first section is
1476 * full of debug symbols. Either way we have all debug symbols
1477 * packed to the beginning of the buffer.
1482 while ((cdebug < csym) && (ncdebug > 0))
1484 struct symbol *s = NULL;
1485 /* First non-debugging symbol. */
1486 unsigned int i = cdebug;
1487 /* Last of second batch of debug symbols. */
1488 unsigned int j = csym + ncdebug - 1;
1494 /* We've moved a symbol from the second debug section to the
1510 return method + (tmp - buf);
1514 /* Sort debuggable symbols. */
1516 qsort (syms, cdebug, sizeof (struct minimal_symbol *),
1519 /* Sort minimal_symbols. */
1520 if ((csym - cdebug) > 1)
1521 qsort (&syms[cdebug], csym - cdebug,
1522 sizeof (struct minimal_symbol *), compare_classes);
1524 /* Terminate the sym_arr list. */
1527 return method + (tmp - buf);
1531 print_object_command (char *args, int from_tty)
1533 struct value *object, *function, *description;
1534 CORE_ADDR string_addr, object_addr;
1538 if (!args || !*args)
1540 "The 'print-object' command requires an argument (an Objective-C object)");
1543 struct expression *expr = parse_expression (args);
1544 struct cleanup *old_chain =
1545 make_cleanup (free_current_contents, &expr);
1548 object = expr->language_defn->la_exp_desc->evaluate_exp
1549 (builtin_type_void_data_ptr, expr, &pc, EVAL_NORMAL);
1550 do_cleanups (old_chain);
1553 /* Validate the address for sanity. */
1554 object_addr = value_as_long (object);
1555 read_memory (object_addr, &c, 1);
1557 function = find_function_in_inferior ("_NSPrintForDebugger");
1558 if (function == NULL)
1559 error (_("Unable to locate _NSPrintForDebugger in child process"));
1561 description = call_function_by_hand (function, 1, &object);
1563 string_addr = value_as_long (description);
1564 if (string_addr == 0)
1565 error (_("object returns null description"));
1567 read_memory (string_addr + i++, &c, 1);
1570 { /* Read and print characters up to EOS. */
1572 printf_filtered ("%c", c);
1573 read_memory (string_addr + i++, &c, 1);
1576 printf_filtered(_("<object returns empty description>"));
1577 printf_filtered ("\n");
1580 /* The data structure 'methcalls' is used to detect method calls (thru
1581 * ObjC runtime lib functions objc_msgSend, objc_msgSendSuper, etc.),
1582 * and ultimately find the method being called.
1585 struct objc_methcall {
1587 /* Return instance method to be called. */
1588 int (*stop_at) (CORE_ADDR, CORE_ADDR *);
1589 /* Start of pc range corresponding to method invocation. */
1591 /* End of pc range corresponding to method invocation. */
1595 static int resolve_msgsend (CORE_ADDR pc, CORE_ADDR *new_pc);
1596 static int resolve_msgsend_stret (CORE_ADDR pc, CORE_ADDR *new_pc);
1597 static int resolve_msgsend_super (CORE_ADDR pc, CORE_ADDR *new_pc);
1598 static int resolve_msgsend_super_stret (CORE_ADDR pc, CORE_ADDR *new_pc);
1600 static struct objc_methcall methcalls[] = {
1601 { "_objc_msgSend", resolve_msgsend, 0, 0},
1602 { "_objc_msgSend_stret", resolve_msgsend_stret, 0, 0},
1603 { "_objc_msgSendSuper", resolve_msgsend_super, 0, 0},
1604 { "_objc_msgSendSuper_stret", resolve_msgsend_super_stret, 0, 0},
1605 { "_objc_getClass", NULL, 0, 0},
1606 { "_objc_getMetaClass", NULL, 0, 0}
1609 #define nmethcalls (sizeof (methcalls) / sizeof (methcalls[0]))
1611 /* The following function, "find_objc_msgsend", fills in the data
1612 * structure "objc_msgs" by finding the addresses of each of the
1613 * (currently four) functions that it holds (of which objc_msgSend is
1614 * the first). This must be called each time symbols are loaded, in
1615 * case the functions have moved for some reason.
1619 find_objc_msgsend (void)
1622 for (i = 0; i < nmethcalls; i++) {
1624 struct minimal_symbol *func;
1626 /* Try both with and without underscore. */
1627 func = lookup_minimal_symbol (methcalls[i].name, NULL, NULL);
1628 if ((func == NULL) && (methcalls[i].name[0] == '_')) {
1629 func = lookup_minimal_symbol (methcalls[i].name + 1, NULL, NULL);
1632 methcalls[i].begin = 0;
1633 methcalls[i].end = 0;
1637 methcalls[i].begin = SYMBOL_VALUE_ADDRESS (func);
1639 methcalls[i].end = SYMBOL_VALUE_ADDRESS (++func);
1640 } while (methcalls[i].begin == methcalls[i].end);
1644 /* find_objc_msgcall (replaces pc_off_limits)
1646 * ALL that this function now does is to determine whether the input
1647 * address ("pc") is the address of one of the Objective-C message
1648 * dispatch functions (mainly objc_msgSend or objc_msgSendSuper), and
1649 * if so, it returns the address of the method that will be called.
1651 * The old function "pc_off_limits" used to do a lot of other things
1652 * in addition, such as detecting shared library jump stubs and
1653 * returning the address of the shlib function that would be called.
1654 * That functionality has been moved into the gdbarch_skip_trampoline_code and
1655 * IN_SOLIB_TRAMPOLINE macros, which are resolved in the target-
1656 * dependent modules.
1659 struct objc_submethod_helper_data {
1660 int (*f) (CORE_ADDR, CORE_ADDR *);
1666 find_objc_msgcall_submethod_helper (void * arg)
1668 struct objc_submethod_helper_data *s =
1669 (struct objc_submethod_helper_data *) arg;
1671 if (s->f (s->pc, s->new_pc) == 0)
1678 find_objc_msgcall_submethod (int (*f) (CORE_ADDR, CORE_ADDR *),
1682 struct objc_submethod_helper_data s;
1688 if (catch_errors (find_objc_msgcall_submethod_helper,
1690 "Unable to determine target of Objective-C method call (ignoring):\n",
1691 RETURN_MASK_ALL) == 0)
1698 find_objc_msgcall (CORE_ADDR pc, CORE_ADDR *new_pc)
1702 find_objc_msgsend ();
1708 for (i = 0; i < nmethcalls; i++)
1709 if ((pc >= methcalls[i].begin) && (pc < methcalls[i].end))
1711 if (methcalls[i].stop_at != NULL)
1712 return find_objc_msgcall_submethod (methcalls[i].stop_at,
1721 extern initialize_file_ftype _initialize_objc_language; /* -Wmissing-prototypes */
1724 _initialize_objc_language (void)
1726 add_language (&objc_language_defn);
1727 add_info ("selectors", selectors_info, /* INFO SELECTORS command. */
1728 _("All Objective-C selectors, or those matching REGEXP."));
1729 add_info ("classes", classes_info, /* INFO CLASSES command. */
1730 _("All Objective-C classes, or those matching REGEXP."));
1731 add_com ("print-object", class_vars, print_object_command,
1732 _("Ask an Objective-C object to print itself."));
1733 add_com_alias ("po", "print-object", class_vars, 1);
1737 read_objc_method (CORE_ADDR addr, struct objc_method *method)
1739 method->name = read_memory_unsigned_integer (addr + 0, 4);
1740 method->types = read_memory_unsigned_integer (addr + 4, 4);
1741 method->imp = read_memory_unsigned_integer (addr + 8, 4);
1745 unsigned long read_objc_methlist_nmethods (CORE_ADDR addr)
1747 return read_memory_unsigned_integer (addr + 4, 4);
1751 read_objc_methlist_method (CORE_ADDR addr, unsigned long num,
1752 struct objc_method *method)
1754 gdb_assert (num < read_objc_methlist_nmethods (addr));
1755 read_objc_method (addr + 8 + (12 * num), method);
1759 read_objc_object (CORE_ADDR addr, struct objc_object *object)
1761 object->isa = read_memory_unsigned_integer (addr, 4);
1765 read_objc_super (CORE_ADDR addr, struct objc_super *super)
1767 super->receiver = read_memory_unsigned_integer (addr, 4);
1768 super->class = read_memory_unsigned_integer (addr + 4, 4);
1772 read_objc_class (CORE_ADDR addr, struct objc_class *class)
1774 class->isa = read_memory_unsigned_integer (addr, 4);
1775 class->super_class = read_memory_unsigned_integer (addr + 4, 4);
1776 class->name = read_memory_unsigned_integer (addr + 8, 4);
1777 class->version = read_memory_unsigned_integer (addr + 12, 4);
1778 class->info = read_memory_unsigned_integer (addr + 16, 4);
1779 class->instance_size = read_memory_unsigned_integer (addr + 18, 4);
1780 class->ivars = read_memory_unsigned_integer (addr + 24, 4);
1781 class->methods = read_memory_unsigned_integer (addr + 28, 4);
1782 class->cache = read_memory_unsigned_integer (addr + 32, 4);
1783 class->protocols = read_memory_unsigned_integer (addr + 36, 4);
1787 find_implementation_from_class (CORE_ADDR class, CORE_ADDR sel)
1789 CORE_ADDR subclass = class;
1791 while (subclass != 0)
1794 struct objc_class class_str;
1795 unsigned mlistnum = 0;
1797 read_objc_class (subclass, &class_str);
1802 unsigned long nmethods;
1805 mlist = read_memory_unsigned_integer (class_str.methods +
1810 nmethods = read_objc_methlist_nmethods (mlist);
1812 for (i = 0; i < nmethods; i++)
1814 struct objc_method meth_str;
1815 read_objc_methlist_method (mlist, i, &meth_str);
1819 "checking method 0x%lx against selector 0x%lx\n",
1820 meth_str.name, sel);
1823 if (meth_str.name == sel)
1824 /* FIXME: hppa arch was doing a pointer dereference
1825 here. There needs to be a better way to do that. */
1826 return meth_str.imp;
1830 subclass = class_str.super_class;
1837 find_implementation (CORE_ADDR object, CORE_ADDR sel)
1839 struct objc_object ostr;
1843 read_objc_object (object, &ostr);
1847 return find_implementation_from_class (ostr.isa, sel);
1850 #define OBJC_FETCH_POINTER_ARGUMENT(argi) \
1851 gdbarch_fetch_pointer_argument (current_gdbarch, get_current_frame (), \
1852 argi, builtin_type_void_func_ptr)
1855 resolve_msgsend (CORE_ADDR pc, CORE_ADDR *new_pc)
1861 object = OBJC_FETCH_POINTER_ARGUMENT (0);
1862 sel = OBJC_FETCH_POINTER_ARGUMENT (1);
1864 res = find_implementation (object, sel);
1873 resolve_msgsend_stret (CORE_ADDR pc, CORE_ADDR *new_pc)
1879 object = OBJC_FETCH_POINTER_ARGUMENT (1);
1880 sel = OBJC_FETCH_POINTER_ARGUMENT (2);
1882 res = find_implementation (object, sel);
1891 resolve_msgsend_super (CORE_ADDR pc, CORE_ADDR *new_pc)
1893 struct objc_super sstr;
1899 super = OBJC_FETCH_POINTER_ARGUMENT (0);
1900 sel = OBJC_FETCH_POINTER_ARGUMENT (1);
1902 read_objc_super (super, &sstr);
1903 if (sstr.class == 0)
1906 res = find_implementation_from_class (sstr.class, sel);
1915 resolve_msgsend_super_stret (CORE_ADDR pc, CORE_ADDR *new_pc)
1917 struct objc_super sstr;
1923 super = OBJC_FETCH_POINTER_ARGUMENT (1);
1924 sel = OBJC_FETCH_POINTER_ARGUMENT (2);
1926 read_objc_super (super, &sstr);
1927 if (sstr.class == 0)
1930 res = find_implementation_from_class (sstr.class, sel);