1 /* Objective-C language support routines for GDB, the GNU debugger.
3 Copyright 2002, 2003 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., 59 Temple Place - Suite 330,
23 Boston, MA 02111-1307, USA. */
28 #include "expression.h"
29 #include "parser-defs.h"
32 #include "objc-lang.h"
33 #include "complaints.h"
37 #include "gdb_string.h" /* for strchr */
38 #include "target.h" /* for target_has_execution */
42 #include "gdb_regex.h"
47 #include "gdb_assert.h"
57 CORE_ADDR super_class;
79 /* Lookup a structure type named "struct NAME", visible in lexical
80 block BLOCK. If NOERR is nonzero, return zero if NAME is not
84 lookup_struct_typedef (char *name, struct block *block, int noerr)
86 register struct symbol *sym;
88 sym = lookup_symbol (name, block, STRUCT_DOMAIN, 0,
89 (struct symtab **) NULL);
96 error ("No struct type named %s.", name);
98 if (TYPE_CODE (SYMBOL_TYPE (sym)) != TYPE_CODE_STRUCT)
103 error ("This context has class, union or enum %s, not a struct.",
110 lookup_objc_class (char *classname)
112 struct value * function, *classval;
114 if (! target_has_execution)
116 /* Can't call into inferior to lookup class. */
120 if (lookup_minimal_symbol("objc_lookUpClass", 0, 0))
121 function = find_function_in_inferior("objc_lookUpClass");
122 else if (lookup_minimal_symbol ("objc_lookup_class", 0, 0))
123 function = find_function_in_inferior("objc_lookup_class");
126 complaint (&symfile_complaints, "no way to lookup Objective-C classes");
130 classval = value_string (classname, strlen (classname) + 1);
131 classval = value_coerce_array (classval);
132 return (CORE_ADDR) value_as_long (call_function_by_hand (function,
137 lookup_child_selector (char *selname)
139 struct value * function, *selstring;
141 if (! target_has_execution)
143 /* Can't call into inferior to lookup selector. */
147 if (lookup_minimal_symbol("sel_getUid", 0, 0))
148 function = find_function_in_inferior("sel_getUid");
149 else if (lookup_minimal_symbol ("sel_get_any_uid", 0, 0))
150 function = find_function_in_inferior("sel_get_any_uid");
153 complaint (&symfile_complaints, "no way to lookup Objective-C selectors");
157 selstring = value_coerce_array (value_string (selname,
158 strlen (selname) + 1));
159 return value_as_long (call_function_by_hand (function, 1, &selstring));
163 value_nsstring (char *ptr, int len)
165 struct value *stringValue[3];
166 struct value *function, *nsstringValue;
170 if (!target_has_execution)
171 return 0; /* Can't call into inferior to create NSString. */
173 sym = lookup_struct_typedef("NSString", 0, 1);
175 sym = lookup_struct_typedef("NXString", 0, 1);
177 type = lookup_pointer_type(builtin_type_void);
179 type = lookup_pointer_type(SYMBOL_TYPE (sym));
181 stringValue[2] = value_string(ptr, len);
182 stringValue[2] = value_coerce_array(stringValue[2]);
183 /* _NSNewStringFromCString replaces "istr" after Lantern2A. */
184 if (lookup_minimal_symbol("_NSNewStringFromCString", 0, 0))
186 function = find_function_in_inferior("_NSNewStringFromCString");
187 nsstringValue = call_function_by_hand(function, 1, &stringValue[2]);
189 else if (lookup_minimal_symbol("istr", 0, 0))
191 function = find_function_in_inferior("istr");
192 nsstringValue = call_function_by_hand(function, 1, &stringValue[2]);
194 else if (lookup_minimal_symbol("+[NSString stringWithCString:]", 0, 0))
196 function = find_function_in_inferior("+[NSString stringWithCString:]");
197 stringValue[0] = value_from_longest
198 (builtin_type_long, lookup_objc_class ("NSString"));
199 stringValue[1] = value_from_longest
200 (builtin_type_long, lookup_child_selector ("stringWithCString:"));
201 nsstringValue = call_function_by_hand(function, 3, &stringValue[0]);
204 error ("NSString: internal error -- no way to create new NSString");
206 VALUE_TYPE(nsstringValue) = type;
207 return nsstringValue;
210 /* Objective-C name demangling. */
213 objc_demangle (const char *mangled, int options)
215 char *demangled, *cp;
217 if (mangled[0] == '_' &&
218 (mangled[1] == 'i' || mangled[1] == 'c') &&
221 cp = demangled = xmalloc(strlen(mangled) + 2);
223 if (mangled[1] == 'i')
224 *cp++ = '-'; /* for instance method */
226 *cp++ = '+'; /* for class method */
228 *cp++ = '['; /* opening left brace */
229 strcpy(cp, mangled+3); /* tack on the rest of the mangled name */
231 while (*cp && *cp == '_')
232 cp++; /* skip any initial underbars in class name */
234 cp = strchr(cp, '_');
235 if (!cp) /* find first non-initial underbar */
237 xfree(demangled); /* not mangled name */
240 if (cp[1] == '_') { /* easy case: no category name */
241 *cp++ = ' '; /* replace two '_' with one ' ' */
242 strcpy(cp, mangled + (cp - demangled) + 2);
245 *cp++ = '('; /* less easy case: category name */
246 cp = strchr(cp, '_');
249 xfree(demangled); /* not mangled name */
253 *cp++ = ' '; /* overwriting 1st char of method name... */
254 strcpy(cp, mangled + (cp - demangled)); /* get it back */
257 while (*cp && *cp == '_')
258 cp++; /* skip any initial underbars in method name */
262 *cp = ':'; /* replace remaining '_' with ':' */
264 *cp++ = ']'; /* closing right brace */
265 *cp++ = 0; /* string terminator */
269 return NULL; /* Not an objc mangled name. */
272 /* Print the character C on STREAM as part of the contents of a
273 literal string whose delimiter is QUOTER. Note that that format
274 for printing characters and strings is language specific. */
277 objc_emit_char (register int c, struct ui_file *stream, int quoter)
280 c &= 0xFF; /* Avoid sign bit follies. */
282 if (PRINT_LITERAL_FORM (c))
284 if (c == '\\' || c == quoter)
286 fputs_filtered ("\\", stream);
288 fprintf_filtered (stream, "%c", c);
295 fputs_filtered ("\\n", stream);
298 fputs_filtered ("\\b", stream);
301 fputs_filtered ("\\t", stream);
304 fputs_filtered ("\\f", stream);
307 fputs_filtered ("\\r", stream);
310 fputs_filtered ("\\e", stream);
313 fputs_filtered ("\\a", stream);
316 fprintf_filtered (stream, "\\%.3o", (unsigned int) c);
323 objc_printchar (int c, struct ui_file *stream)
325 fputs_filtered ("'", stream);
326 objc_emit_char (c, stream, '\'');
327 fputs_filtered ("'", stream);
330 /* Print the character string STRING, printing at most LENGTH
331 characters. Printing stops early if the number hits print_max;
332 repeat counts are printed as appropriate. Print ellipses at the
333 end if we had to stop before printing LENGTH characters, or if
337 objc_printstr (struct ui_file *stream, char *string,
338 unsigned int length, int width, int force_ellipses)
340 register unsigned int i;
341 unsigned int things_printed = 0;
345 /* If the string was not truncated due to `set print elements', and
346 the last byte of it is a null, we don't print that, in
347 traditional C style. */
348 if ((!force_ellipses) && length > 0 && string[length-1] == '\0')
353 fputs_filtered ("\"\"", stream);
357 for (i = 0; i < length && things_printed < print_max; ++i)
359 /* Position of the character we are examining to see whether it
362 /* Number of repetitions we have detected so far. */
369 fputs_filtered (", ", stream);
375 while (rep1 < length && string[rep1] == string[i])
381 if (reps > repeat_count_threshold)
386 fputs_filtered ("\\\", ", stream);
388 fputs_filtered ("\", ", stream);
391 objc_printchar (string[i], stream);
392 fprintf_filtered (stream, " <repeats %u times>", reps);
394 things_printed += repeat_count_threshold;
402 fputs_filtered ("\\\"", stream);
404 fputs_filtered ("\"", stream);
407 objc_emit_char (string[i], stream, '"');
412 /* Terminate the quotes if necessary. */
416 fputs_filtered ("\\\"", stream);
418 fputs_filtered ("\"", stream);
421 if (force_ellipses || i < length)
422 fputs_filtered ("...", stream);
425 /* Create a fundamental C type using default reasonable for the
428 Some object/debugging file formats (DWARF version 1, COFF, etc) do
429 not define fundamental types such as "int" or "double". Others
430 (stabs or DWARF version 2, etc) do define fundamental types. For
431 the formats which don't provide fundamental types, gdb can create
432 such types using this function.
434 FIXME: Some compilers distinguish explicitly signed integral types
435 (signed short, signed int, signed long) from "regular" integral
436 types (short, int, long) in the debugging information. There is
437 some disagreement as to how useful this feature is. In particular,
438 gcc does not support this. Also, only some debugging formats allow
439 the distinction to be passed on to a debugger. For now, we always
440 just use "short", "int", or "long" as the type name, for both the
441 implicit and explicitly signed types. This also makes life easier
442 for the gdb test suite since we don't have to account for the
443 differences in output depending upon what the compiler and
444 debugging format support. We will probably have to re-examine the
445 issue when gdb starts taking it's fundamental type information
446 directly from the debugging information supplied by the compiler.
450 objc_create_fundamental_type (struct objfile *objfile, int typeid)
452 register struct type *type = NULL;
457 /* FIXME: For now, if we are asked to produce a type not in
458 this language, create the equivalent of a C integer type
459 with the name "<?type?>". When all the dust settles from
460 the type reconstruction work, this should probably become
462 type = init_type (TYPE_CODE_INT,
463 TARGET_INT_BIT / TARGET_CHAR_BIT,
464 0, "<?type?>", objfile);
465 warning ("internal error: no C/C++ fundamental type %d", typeid);
468 type = init_type (TYPE_CODE_VOID,
469 TARGET_CHAR_BIT / TARGET_CHAR_BIT,
473 type = init_type (TYPE_CODE_INT,
474 TARGET_CHAR_BIT / TARGET_CHAR_BIT,
478 type = init_type (TYPE_CODE_INT,
479 TARGET_CHAR_BIT / TARGET_CHAR_BIT,
480 0, "signed char", objfile);
482 case FT_UNSIGNED_CHAR:
483 type = init_type (TYPE_CODE_INT,
484 TARGET_CHAR_BIT / TARGET_CHAR_BIT,
485 TYPE_FLAG_UNSIGNED, "unsigned char", objfile);
488 type = init_type (TYPE_CODE_INT,
489 TARGET_SHORT_BIT / TARGET_CHAR_BIT,
490 0, "short", objfile);
492 case FT_SIGNED_SHORT:
493 type = init_type (TYPE_CODE_INT,
494 TARGET_SHORT_BIT / TARGET_CHAR_BIT,
495 0, "short", objfile); /* FIXME-fnf */
497 case FT_UNSIGNED_SHORT:
498 type = init_type (TYPE_CODE_INT,
499 TARGET_SHORT_BIT / TARGET_CHAR_BIT,
500 TYPE_FLAG_UNSIGNED, "unsigned short", objfile);
503 type = init_type (TYPE_CODE_INT,
504 TARGET_INT_BIT / TARGET_CHAR_BIT,
507 case FT_SIGNED_INTEGER:
508 type = init_type (TYPE_CODE_INT,
509 TARGET_INT_BIT / TARGET_CHAR_BIT,
510 0, "int", objfile); /* FIXME -fnf */
512 case FT_UNSIGNED_INTEGER:
513 type = init_type (TYPE_CODE_INT,
514 TARGET_INT_BIT / TARGET_CHAR_BIT,
515 TYPE_FLAG_UNSIGNED, "unsigned int", objfile);
518 type = init_type (TYPE_CODE_INT,
519 TARGET_LONG_BIT / TARGET_CHAR_BIT,
523 type = init_type (TYPE_CODE_INT,
524 TARGET_LONG_BIT / TARGET_CHAR_BIT,
525 0, "long", objfile); /* FIXME -fnf */
527 case FT_UNSIGNED_LONG:
528 type = init_type (TYPE_CODE_INT,
529 TARGET_LONG_BIT / TARGET_CHAR_BIT,
530 TYPE_FLAG_UNSIGNED, "unsigned long", objfile);
533 type = init_type (TYPE_CODE_INT,
534 TARGET_LONG_LONG_BIT / TARGET_CHAR_BIT,
535 0, "long long", objfile);
537 case FT_SIGNED_LONG_LONG:
538 type = init_type (TYPE_CODE_INT,
539 TARGET_LONG_LONG_BIT / TARGET_CHAR_BIT,
540 0, "signed long long", objfile);
542 case FT_UNSIGNED_LONG_LONG:
543 type = init_type (TYPE_CODE_INT,
544 TARGET_LONG_LONG_BIT / TARGET_CHAR_BIT,
545 TYPE_FLAG_UNSIGNED, "unsigned long long", objfile);
548 type = init_type (TYPE_CODE_FLT,
549 TARGET_FLOAT_BIT / TARGET_CHAR_BIT,
550 0, "float", objfile);
552 case FT_DBL_PREC_FLOAT:
553 type = init_type (TYPE_CODE_FLT,
554 TARGET_DOUBLE_BIT / TARGET_CHAR_BIT,
555 0, "double", objfile);
557 case FT_EXT_PREC_FLOAT:
558 type = init_type (TYPE_CODE_FLT,
559 TARGET_LONG_DOUBLE_BIT / TARGET_CHAR_BIT,
560 0, "long double", objfile);
566 /* Determine if we are currently in the Objective-C dispatch function.
567 If so, get the address of the method function that the dispatcher
568 would call and use that as the function to step into instead. Also
569 skip over the trampoline for the function (if any). This is better
570 for the user since they are only interested in stepping into the
571 method function anyway. */
573 objc_skip_trampoline (CORE_ADDR stop_pc)
575 CORE_ADDR real_stop_pc;
576 CORE_ADDR method_stop_pc;
578 real_stop_pc = SKIP_TRAMPOLINE_CODE (stop_pc);
580 if (real_stop_pc != 0)
581 find_objc_msgcall (real_stop_pc, &method_stop_pc);
583 find_objc_msgcall (stop_pc, &method_stop_pc);
587 real_stop_pc = SKIP_TRAMPOLINE_CODE (method_stop_pc);
588 if (real_stop_pc == 0)
589 real_stop_pc = method_stop_pc;
596 /* Table mapping opcodes into strings for printing operators
597 and precedences of the operators. */
599 static const struct op_print objc_op_print_tab[] =
601 {",", BINOP_COMMA, PREC_COMMA, 0},
602 {"=", BINOP_ASSIGN, PREC_ASSIGN, 1},
603 {"||", BINOP_LOGICAL_OR, PREC_LOGICAL_OR, 0},
604 {"&&", BINOP_LOGICAL_AND, PREC_LOGICAL_AND, 0},
605 {"|", BINOP_BITWISE_IOR, PREC_BITWISE_IOR, 0},
606 {"^", BINOP_BITWISE_XOR, PREC_BITWISE_XOR, 0},
607 {"&", BINOP_BITWISE_AND, PREC_BITWISE_AND, 0},
608 {"==", BINOP_EQUAL, PREC_EQUAL, 0},
609 {"!=", BINOP_NOTEQUAL, PREC_EQUAL, 0},
610 {"<=", BINOP_LEQ, PREC_ORDER, 0},
611 {">=", BINOP_GEQ, PREC_ORDER, 0},
612 {">", BINOP_GTR, PREC_ORDER, 0},
613 {"<", BINOP_LESS, PREC_ORDER, 0},
614 {">>", BINOP_RSH, PREC_SHIFT, 0},
615 {"<<", BINOP_LSH, PREC_SHIFT, 0},
616 {"+", BINOP_ADD, PREC_ADD, 0},
617 {"-", BINOP_SUB, PREC_ADD, 0},
618 {"*", BINOP_MUL, PREC_MUL, 0},
619 {"/", BINOP_DIV, PREC_MUL, 0},
620 {"%", BINOP_REM, PREC_MUL, 0},
621 {"@", BINOP_REPEAT, PREC_REPEAT, 0},
622 {"-", UNOP_NEG, PREC_PREFIX, 0},
623 {"!", UNOP_LOGICAL_NOT, PREC_PREFIX, 0},
624 {"~", UNOP_COMPLEMENT, PREC_PREFIX, 0},
625 {"*", UNOP_IND, PREC_PREFIX, 0},
626 {"&", UNOP_ADDR, PREC_PREFIX, 0},
627 {"sizeof ", UNOP_SIZEOF, PREC_PREFIX, 0},
628 {"++", UNOP_PREINCREMENT, PREC_PREFIX, 0},
629 {"--", UNOP_PREDECREMENT, PREC_PREFIX, 0},
630 {NULL, OP_NULL, PREC_NULL, 0}
633 struct type ** const (objc_builtin_types[]) =
640 &builtin_type_double,
642 &builtin_type_long_long,
643 &builtin_type_signed_char,
644 &builtin_type_unsigned_char,
645 &builtin_type_unsigned_short,
646 &builtin_type_unsigned_int,
647 &builtin_type_unsigned_long,
648 &builtin_type_unsigned_long_long,
649 &builtin_type_long_double,
650 &builtin_type_complex,
651 &builtin_type_double_complex,
655 const struct language_defn objc_language_defn = {
656 "objective-c", /* Language name */
664 evaluate_subexp_standard,
665 objc_printchar, /* Print a character constant */
666 objc_printstr, /* Function to print string constant */
668 objc_create_fundamental_type, /* Create fundamental type in this language */
669 c_print_type, /* Print a type using appropriate syntax */
670 c_val_print, /* Print a value using appropriate syntax */
671 c_value_print, /* Print a top-level value */
672 objc_skip_trampoline, /* Language specific skip_trampoline */
673 value_of_this, /* value_of_this */
674 basic_lookup_symbol_nonlocal, /* lookup_symbol_nonlocal */
675 objc_demangle, /* Language specific symbol demangler */
676 {"", "", "", ""}, /* Binary format info */
677 {"0%lo", "0", "o", ""}, /* Octal format info */
678 {"%ld", "", "d", ""}, /* Decimal format info */
679 {"0x%lx", "0x", "x", ""}, /* Hex format info */
680 objc_op_print_tab, /* Expression operators for printing */
681 1, /* C-style arrays */
682 0, /* String lower bound */
683 &builtin_type_char, /* Type of string elements */
689 * Following functions help construct Objective-C message calls
692 struct selname /* For parsing Objective-C. */
694 struct selname *next;
699 static int msglist_len;
700 static struct selname *selname_chain;
701 static char *msglist_sel;
706 register struct selname *new =
707 (struct selname *) xmalloc (sizeof (struct selname));
709 new->next = selname_chain;
710 new->msglist_len = msglist_len;
711 new->msglist_sel = msglist_sel;
713 msglist_sel = (char *)xmalloc(1);
719 add_msglist(struct stoken *str, int addcolon)
724 if (str == 0) { /* Unnamed arg, or... */
725 if (addcolon == 0) { /* variable number of args. */
735 len = plen + strlen(msglist_sel) + 2;
736 s = (char *)xmalloc(len);
737 strcpy(s, msglist_sel);
752 register int val = msglist_len;
753 register struct selname *sel = selname_chain;
754 register char *p = msglist_sel;
757 selname_chain = sel->next;
758 msglist_len = sel->msglist_len;
759 msglist_sel = sel->msglist_sel;
760 selid = lookup_child_selector(p);
762 error("Can't find selector \"%s\"", p);
763 write_exp_elt_longcst (selid);
765 write_exp_elt_longcst (val); /* Number of args */
772 * Function: specialcmp (char *a, char *b)
774 * Special strcmp: treats ']' and ' ' as end-of-string.
775 * Used for qsorting lists of objc methods (either by class or selector).
778 int specialcmp(char *a, char *b)
780 while (*a && *a != ' ' && *a != ']' && *b && *b != ' ' && *b != ']')
786 if (*a && *a != ' ' && *a != ']')
787 return 1; /* a is longer therefore greater */
788 if (*b && *b != ' ' && *b != ']')
789 return -1; /* a is shorter therefore lesser */
790 return 0; /* a and b are identical */
794 * Function: compare_selectors (const void *, const void *)
796 * Comparison function for use with qsort. Arguments are symbols or
797 * msymbols Compares selector part of objc method name alphabetically.
801 compare_selectors (const void *a, const void *b)
805 aname = SYMBOL_PRINT_NAME (*(struct symbol **) a);
806 bname = SYMBOL_PRINT_NAME (*(struct symbol **) b);
807 if (aname == NULL || bname == NULL)
808 error ("internal: compare_selectors(1)");
810 aname = strchr(aname, ' ');
811 bname = strchr(bname, ' ');
812 if (aname == NULL || bname == NULL)
813 error ("internal: compare_selectors(2)");
815 return specialcmp (aname+1, bname+1);
819 * Function: selectors_info (regexp, from_tty)
821 * Implements the "Info selectors" command. Takes an optional regexp
822 * arg. Lists all objective c selectors that match the regexp. Works
823 * by grepping thru all symbols for objective c methods. Output list
824 * is sorted and uniqued.
828 selectors_info (char *regexp, int from_tty)
830 struct objfile *objfile;
831 struct minimal_symbol *msymbol;
839 struct symbol **sym_arr;
843 strcpy(myregexp, ".*]"); /* Null input, match all objc methods. */
846 if (*regexp == '+' || *regexp == '-')
847 { /* User wants only class methods or only instance methods. */
848 plusminus = *regexp++;
849 while (*regexp == ' ' || *regexp == '\t')
853 strcpy(myregexp, ".*]");
856 strcpy(myregexp, regexp);
857 if (myregexp[strlen(myregexp) - 1] == '$') /* end of selector */
858 myregexp[strlen(myregexp) - 1] = ']'; /* end of method name */
860 strcat(myregexp, ".*]");
866 val = re_comp (myregexp);
868 error ("Invalid regexp (%s): %s", val, regexp);
871 /* First time thru is JUST to get max length and count. */
872 ALL_MSYMBOLS (objfile, msymbol)
875 name = SYMBOL_NATURAL_NAME (msymbol);
877 (name[0] == '-' || name[0] == '+') &&
878 name[1] == '[') /* Got a method name. */
880 /* Filter for class/instance methods. */
881 if (plusminus && name[0] != plusminus)
883 /* Find selector part. */
884 name = (char *) strchr(name+2, ' ');
885 if (regexp == NULL || re_exec(++name) != 0)
887 char *mystart = name;
888 char *myend = (char *) strchr(mystart, ']');
890 if (myend && (myend - mystart > maxlen))
891 maxlen = myend - mystart; /* Get longest selector. */
898 printf_filtered ("Selectors matching \"%s\":\n\n",
899 regexp ? regexp : "*");
901 sym_arr = alloca (matches * sizeof (struct symbol *));
903 ALL_MSYMBOLS (objfile, msymbol)
906 name = SYMBOL_NATURAL_NAME (msymbol);
908 (name[0] == '-' || name[0] == '+') &&
909 name[1] == '[') /* Got a method name. */
911 /* Filter for class/instance methods. */
912 if (plusminus && name[0] != plusminus)
914 /* Find selector part. */
915 name = (char *) strchr(name+2, ' ');
916 if (regexp == NULL || re_exec(++name) != 0)
917 sym_arr[matches++] = (struct symbol *) msymbol;
921 qsort (sym_arr, matches, sizeof (struct minimal_symbol *),
923 /* Prevent compare on first iteration. */
925 for (ix = 0; ix < matches; ix++) /* Now do the output. */
930 name = SYMBOL_NATURAL_NAME (sym_arr[ix]);
931 name = strchr (name, ' ') + 1;
932 if (p[0] && specialcmp(name, p) == 0)
933 continue; /* Seen this one already (not unique). */
935 /* Copy selector part. */
936 while (*name && *name != ']')
939 /* Print in columns. */
940 puts_filtered_tabular(asel, maxlen + 1, 0);
945 printf_filtered ("No selectors matching \"%s\"\n", regexp ? regexp : "*");
949 * Function: compare_classes (const void *, const void *)
951 * Comparison function for use with qsort. Arguments are symbols or
952 * msymbols Compares class part of objc method name alphabetically.
956 compare_classes (const void *a, const void *b)
960 aname = SYMBOL_PRINT_NAME (*(struct symbol **) a);
961 bname = SYMBOL_PRINT_NAME (*(struct symbol **) b);
962 if (aname == NULL || bname == NULL)
963 error ("internal: compare_classes(1)");
965 return specialcmp (aname+1, bname+1);
969 * Function: classes_info(regexp, from_tty)
971 * Implements the "info classes" command for objective c classes.
972 * Lists all objective c classes that match the optional regexp.
973 * Works by grepping thru the list of objective c methods. List will
974 * be sorted and uniqued (since one class may have many methods).
975 * BUGS: will not list a class that has no methods.
979 classes_info (char *regexp, int from_tty)
981 struct objfile *objfile;
982 struct minimal_symbol *msymbol;
990 struct symbol **sym_arr;
993 strcpy(myregexp, ".* "); /* Null input: match all objc classes. */
996 strcpy(myregexp, regexp);
997 if (myregexp[strlen(myregexp) - 1] == '$')
998 /* In the method name, the end of the class name is marked by ' '. */
999 myregexp[strlen(myregexp) - 1] = ' ';
1001 strcat(myregexp, ".* ");
1006 val = re_comp (myregexp);
1008 error ("Invalid regexp (%s): %s", val, regexp);
1011 /* First time thru is JUST to get max length and count. */
1012 ALL_MSYMBOLS (objfile, msymbol)
1015 name = SYMBOL_NATURAL_NAME (msymbol);
1017 (name[0] == '-' || name[0] == '+') &&
1018 name[1] == '[') /* Got a method name. */
1019 if (regexp == NULL || re_exec(name+2) != 0)
1021 /* Compute length of classname part. */
1022 char *mystart = name + 2;
1023 char *myend = (char *) strchr(mystart, ' ');
1025 if (myend && (myend - mystart > maxlen))
1026 maxlen = myend - mystart;
1032 printf_filtered ("Classes matching \"%s\":\n\n",
1033 regexp ? regexp : "*");
1034 sym_arr = alloca (matches * sizeof (struct symbol *));
1036 ALL_MSYMBOLS (objfile, msymbol)
1039 name = SYMBOL_NATURAL_NAME (msymbol);
1041 (name[0] == '-' || name[0] == '+') &&
1042 name[1] == '[') /* Got a method name. */
1043 if (regexp == NULL || re_exec(name+2) != 0)
1044 sym_arr[matches++] = (struct symbol *) msymbol;
1047 qsort (sym_arr, matches, sizeof (struct minimal_symbol *),
1049 /* Prevent compare on first iteration. */
1051 for (ix = 0; ix < matches; ix++) /* Now do the output. */
1056 name = SYMBOL_NATURAL_NAME (sym_arr[ix]);
1058 if (p[0] && specialcmp(name, p) == 0)
1059 continue; /* Seen this one already (not unique). */
1061 /* Copy class part of method name. */
1062 while (*name && *name != ' ')
1065 /* Print in columns. */
1066 puts_filtered_tabular(aclass, maxlen + 1, 0);
1071 printf_filtered ("No classes matching \"%s\"\n", regexp ? regexp : "*");
1075 * Function: find_imps (char *selector, struct symbol **sym_arr)
1077 * Input: a string representing a selector
1078 * a pointer to an array of symbol pointers
1079 * possibly a pointer to a symbol found by the caller.
1081 * Output: number of methods that implement that selector. Side
1082 * effects: The array of symbol pointers is filled with matching syms.
1084 * By analogy with function "find_methods" (symtab.c), builds a list
1085 * of symbols matching the ambiguous input, so that "decode_line_2"
1086 * (symtab.c) can list them and ask the user to choose one or more.
1087 * In this case the matches are objective c methods
1088 * ("implementations") matching an objective c selector.
1090 * Note that it is possible for a normal (c-style) function to have
1091 * the same name as an objective c selector. To prevent the selector
1092 * from eclipsing the function, we allow the caller (decode_line_1) to
1093 * search for such a function first, and if it finds one, pass it in
1094 * to us. We will then integrate it into the list. We also search
1095 * for one here, among the minsyms.
1097 * NOTE: if NUM_DEBUGGABLE is non-zero, the sym_arr will be divided
1098 * into two parts: debuggable (struct symbol) syms, and
1099 * non_debuggable (struct minimal_symbol) syms. The debuggable
1100 * ones will come first, before NUM_DEBUGGABLE (which will thus
1101 * be the index of the first non-debuggable one).
1105 * Function: total_number_of_imps (char *selector);
1107 * Input: a string representing a selector
1108 * Output: number of methods that implement that selector.
1110 * By analogy with function "total_number_of_methods", this allows
1111 * decode_line_1 (symtab.c) to detect if there are objective c methods
1112 * matching the input, and to allocate an array of pointers to them
1113 * which can be manipulated by "decode_line_2" (also in symtab.c).
1117 parse_selector (char *method, char **selector)
1121 int found_quote = 0;
1123 char *nselector = NULL;
1125 gdb_assert (selector != NULL);
1129 while (isspace (*s1))
1136 while (isspace (*s1))
1143 if (isalnum (*s2) || (*s2 == '_') || (*s2 == ':'))
1145 else if (isspace (*s2))
1147 else if ((*s2 == '\0') || (*s2 == '\''))
1155 while (isspace (*s2))
1161 while (isspace (*s2))
1165 if (selector != NULL)
1166 *selector = nselector;
1172 parse_method (char *method, char *type, char **class,
1173 char **category, char **selector)
1177 int found_quote = 0;
1180 char *nclass = NULL;
1181 char *ncategory = NULL;
1182 char *nselector = NULL;
1184 gdb_assert (type != NULL);
1185 gdb_assert (class != NULL);
1186 gdb_assert (category != NULL);
1187 gdb_assert (selector != NULL);
1191 while (isspace (*s1))
1198 while (isspace (*s1))
1201 if ((s1[0] == '+') || (s1[0] == '-'))
1204 while (isspace (*s1))
1212 while (isalnum (*s1) || (*s1 == '_'))
1216 while (isspace (*s2))
1222 while (isspace (*s2))
1225 while (isalnum (*s2) || (*s2 == '_'))
1230 /* Truncate the class name now that we're not using the open paren. */
1237 if (isalnum (*s2) || (*s2 == '_') || (*s2 == ':'))
1239 else if (isspace (*s2))
1241 else if (*s2 == ']')
1250 while (isspace (*s2))
1257 while (isspace (*s2))
1265 if (category != NULL)
1266 *category = ncategory;
1267 if (selector != NULL)
1268 *selector = nselector;
1274 find_methods (struct symtab *symtab, char type,
1275 const char *class, const char *category,
1276 const char *selector, struct symbol **syms,
1277 unsigned int *nsym, unsigned int *ndebug)
1279 struct objfile *objfile = NULL;
1280 struct minimal_symbol *msymbol = NULL;
1281 struct block *block = NULL;
1282 struct symbol *sym = NULL;
1284 char *symname = NULL;
1287 char *nclass = NULL;
1288 char *ncategory = NULL;
1289 char *nselector = NULL;
1291 unsigned int csym = 0;
1292 unsigned int cdebug = 0;
1294 static char *tmp = NULL;
1295 static unsigned int tmplen = 0;
1297 gdb_assert (nsym != NULL);
1298 gdb_assert (ndebug != NULL);
1301 block = BLOCKVECTOR_BLOCK (BLOCKVECTOR (symtab), STATIC_BLOCK);
1303 ALL_MSYMBOLS (objfile, msymbol)
1307 if ((msymbol->type != mst_text) && (msymbol->type != mst_file_text))
1308 /* Not a function or method. */
1312 if ((SYMBOL_VALUE_ADDRESS (msymbol) < BLOCK_START (block)) ||
1313 (SYMBOL_VALUE_ADDRESS (msymbol) >= BLOCK_END (block)))
1314 /* Not in the specified symtab. */
1317 symname = SYMBOL_NATURAL_NAME (msymbol);
1318 if (symname == NULL)
1321 if ((symname[0] != '-' && symname[0] != '+') || (symname[1] != '['))
1322 /* Not a method name. */
1325 while ((strlen (symname) + 1) >= tmplen)
1327 tmplen = (tmplen == 0) ? 1024 : tmplen * 2;
1328 tmp = xrealloc (tmp, tmplen);
1330 strcpy (tmp, symname);
1332 if (parse_method (tmp, &ntype, &nclass, &ncategory, &nselector) == NULL)
1335 if ((type != '\0') && (ntype != type))
1339 && ((nclass == NULL) || (strcmp (class, nclass) != 0)))
1342 if ((category != NULL) &&
1343 ((ncategory == NULL) || (strcmp (category, ncategory) != 0)))
1346 if ((selector != NULL) &&
1347 ((nselector == NULL) || (strcmp (selector, nselector) != 0)))
1350 sym = find_pc_function (SYMBOL_VALUE_ADDRESS (msymbol));
1353 const char *newsymname = SYMBOL_NATURAL_NAME (sym);
1355 if (strcmp (symname, newsymname) == 0)
1357 /* Found a high-level method sym: swap it into the
1358 lower part of sym_arr (below num_debuggable). */
1361 syms[csym] = syms[cdebug];
1370 "debugging symbol \"%s\" does not match minimal symbol (\"%s\"); ignoring",
1371 newsymname, symname);
1373 syms[csym] = (struct symbol *) msymbol;
1379 /* Found a non-debuggable method symbol. */
1381 syms[csym] = (struct symbol *) msymbol;
1392 char *find_imps (struct symtab *symtab, struct block *block,
1393 char *method, struct symbol **syms,
1394 unsigned int *nsym, unsigned int *ndebug)
1398 char *category = NULL;
1399 char *selector = NULL;
1401 unsigned int csym = 0;
1402 unsigned int cdebug = 0;
1404 unsigned int ncsym = 0;
1405 unsigned int ncdebug = 0;
1410 gdb_assert (nsym != NULL);
1411 gdb_assert (ndebug != NULL);
1418 buf = (char *) alloca (strlen (method) + 1);
1419 strcpy (buf, method);
1420 tmp = parse_method (buf, &type, &class, &category, &selector);
1424 struct symbol *sym = NULL;
1425 struct minimal_symbol *msym = NULL;
1427 strcpy (buf, method);
1428 tmp = parse_selector (buf, &selector);
1433 sym = lookup_symbol (selector, block, VAR_DOMAIN, 0, NULL);
1443 msym = lookup_minimal_symbol (selector, 0, 0);
1448 syms[csym] = (struct symbol *)msym;
1454 find_methods (symtab, type, class, category, selector,
1455 syms + csym, &ncsym, &ncdebug);
1457 find_methods (symtab, type, class, category, selector,
1458 NULL, &ncsym, &ncdebug);
1460 /* If we didn't find any methods, just return. */
1461 if (ncsym == 0 && ncdebug == 0)
1464 /* Take debug symbols from the second batch of symbols and swap them
1465 * with debug symbols from the first batch. Repeat until either the
1466 * second section is out of debug symbols or the first section is
1467 * full of debug symbols. Either way we have all debug symbols
1468 * packed to the beginning of the buffer.
1473 while ((cdebug < csym) && (ncdebug > 0))
1475 struct symbol *s = NULL;
1476 /* First non-debugging symbol. */
1477 unsigned int i = cdebug;
1478 /* Last of second batch of debug symbols. */
1479 unsigned int j = csym + ncdebug - 1;
1485 /* We've moved a symbol from the second debug section to the
1501 return method + (tmp - buf);
1505 /* Sort debuggable symbols. */
1507 qsort (syms, cdebug, sizeof (struct minimal_symbol *),
1510 /* Sort minimal_symbols. */
1511 if ((csym - cdebug) > 1)
1512 qsort (&syms[cdebug], csym - cdebug,
1513 sizeof (struct minimal_symbol *), compare_classes);
1515 /* Terminate the sym_arr list. */
1518 return method + (tmp - buf);
1522 print_object_command (char *args, int from_tty)
1524 struct value *object, *function, *description;
1525 CORE_ADDR string_addr, object_addr;
1529 if (!args || !*args)
1531 "The 'print-object' command requires an argument (an Objective-C object)");
1534 struct expression *expr = parse_expression (args);
1535 register struct cleanup *old_chain =
1536 make_cleanup (free_current_contents, &expr);
1539 object = expr->language_defn->evaluate_exp (builtin_type_void_data_ptr,
1540 expr, &pc, EVAL_NORMAL);
1541 do_cleanups (old_chain);
1544 /* Validate the address for sanity. */
1545 object_addr = value_as_long (object);
1546 read_memory (object_addr, &c, 1);
1548 function = find_function_in_inferior ("_NSPrintForDebugger");
1549 if (function == NULL)
1550 error ("Unable to locate _NSPrintForDebugger in child process");
1552 description = call_function_by_hand (function, 1, &object);
1554 string_addr = value_as_long (description);
1555 if (string_addr == 0)
1556 error ("object returns null description");
1558 read_memory (string_addr + i++, &c, 1);
1561 { /* Read and print characters up to EOS. */
1563 printf_filtered ("%c", c);
1564 read_memory (string_addr + i++, &c, 1);
1567 printf_filtered("<object returns empty description>");
1568 printf_filtered ("\n");
1571 /* The data structure 'methcalls' is used to detect method calls (thru
1572 * ObjC runtime lib functions objc_msgSend, objc_msgSendSuper, etc.),
1573 * and ultimately find the method being called.
1576 struct objc_methcall {
1578 /* Return instance method to be called. */
1579 int (*stop_at) (CORE_ADDR, CORE_ADDR *);
1580 /* Start of pc range corresponding to method invocation. */
1582 /* End of pc range corresponding to method invocation. */
1586 static int resolve_msgsend (CORE_ADDR pc, CORE_ADDR *new_pc);
1587 static int resolve_msgsend_stret (CORE_ADDR pc, CORE_ADDR *new_pc);
1588 static int resolve_msgsend_super (CORE_ADDR pc, CORE_ADDR *new_pc);
1589 static int resolve_msgsend_super_stret (CORE_ADDR pc, CORE_ADDR *new_pc);
1591 static struct objc_methcall methcalls[] = {
1592 { "_objc_msgSend", resolve_msgsend, 0, 0},
1593 { "_objc_msgSend_stret", resolve_msgsend_stret, 0, 0},
1594 { "_objc_msgSendSuper", resolve_msgsend_super, 0, 0},
1595 { "_objc_msgSendSuper_stret", resolve_msgsend_super_stret, 0, 0},
1596 { "_objc_getClass", NULL, 0, 0},
1597 { "_objc_getMetaClass", NULL, 0, 0}
1600 #define nmethcalls (sizeof (methcalls) / sizeof (methcalls[0]))
1602 /* The following function, "find_objc_msgsend", fills in the data
1603 * structure "objc_msgs" by finding the addresses of each of the
1604 * (currently four) functions that it holds (of which objc_msgSend is
1605 * the first). This must be called each time symbols are loaded, in
1606 * case the functions have moved for some reason.
1610 find_objc_msgsend (void)
1613 for (i = 0; i < nmethcalls; i++) {
1615 struct minimal_symbol *func;
1617 /* Try both with and without underscore. */
1618 func = lookup_minimal_symbol (methcalls[i].name, NULL, NULL);
1619 if ((func == NULL) && (methcalls[i].name[0] == '_')) {
1620 func = lookup_minimal_symbol (methcalls[i].name + 1, NULL, NULL);
1623 methcalls[i].begin = 0;
1624 methcalls[i].end = 0;
1628 methcalls[i].begin = SYMBOL_VALUE_ADDRESS (func);
1630 methcalls[i].end = SYMBOL_VALUE_ADDRESS (++func);
1631 } while (methcalls[i].begin == methcalls[i].end);
1635 /* find_objc_msgcall (replaces pc_off_limits)
1637 * ALL that this function now does is to determine whether the input
1638 * address ("pc") is the address of one of the Objective-C message
1639 * dispatch functions (mainly objc_msgSend or objc_msgSendSuper), and
1640 * if so, it returns the address of the method that will be called.
1642 * The old function "pc_off_limits" used to do a lot of other things
1643 * in addition, such as detecting shared library jump stubs and
1644 * returning the address of the shlib function that would be called.
1645 * That functionality has been moved into the SKIP_TRAMPOLINE_CODE and
1646 * IN_SOLIB_TRAMPOLINE macros, which are resolved in the target-
1647 * dependent modules.
1650 struct objc_submethod_helper_data {
1651 int (*f) (CORE_ADDR, CORE_ADDR *);
1657 find_objc_msgcall_submethod_helper (void * arg)
1659 struct objc_submethod_helper_data *s =
1660 (struct objc_submethod_helper_data *) arg;
1662 if (s->f (s->pc, s->new_pc) == 0)
1669 find_objc_msgcall_submethod (int (*f) (CORE_ADDR, CORE_ADDR *),
1673 struct objc_submethod_helper_data s;
1679 if (catch_errors (find_objc_msgcall_submethod_helper,
1681 "Unable to determine target of Objective-C method call (ignoring):\n",
1682 RETURN_MASK_ALL) == 0)
1689 find_objc_msgcall (CORE_ADDR pc, CORE_ADDR *new_pc)
1693 find_objc_msgsend ();
1699 for (i = 0; i < nmethcalls; i++)
1700 if ((pc >= methcalls[i].begin) && (pc < methcalls[i].end))
1702 if (methcalls[i].stop_at != NULL)
1703 return find_objc_msgcall_submethod (methcalls[i].stop_at,
1713 _initialize_objc_language (void)
1715 add_language (&objc_language_defn);
1716 add_info ("selectors", selectors_info, /* INFO SELECTORS command. */
1717 "All Objective-C selectors, or those matching REGEXP.");
1718 add_info ("classes", classes_info, /* INFO CLASSES command. */
1719 "All Objective-C classes, or those matching REGEXP.");
1720 add_com ("print-object", class_vars, print_object_command,
1721 "Ask an Objective-C object to print itself.");
1722 add_com_alias ("po", "print-object", class_vars, 1);
1726 read_objc_method (CORE_ADDR addr, struct objc_method *method)
1728 method->name = read_memory_unsigned_integer (addr + 0, 4);
1729 method->types = read_memory_unsigned_integer (addr + 4, 4);
1730 method->imp = read_memory_unsigned_integer (addr + 8, 4);
1734 unsigned long read_objc_methlist_nmethods (CORE_ADDR addr)
1736 return read_memory_unsigned_integer (addr + 4, 4);
1740 read_objc_methlist_method (CORE_ADDR addr, unsigned long num,
1741 struct objc_method *method)
1743 gdb_assert (num < read_objc_methlist_nmethods (addr));
1744 read_objc_method (addr + 8 + (12 * num), method);
1748 read_objc_object (CORE_ADDR addr, struct objc_object *object)
1750 object->isa = read_memory_unsigned_integer (addr, 4);
1754 read_objc_super (CORE_ADDR addr, struct objc_super *super)
1756 super->receiver = read_memory_unsigned_integer (addr, 4);
1757 super->class = read_memory_unsigned_integer (addr + 4, 4);
1761 read_objc_class (CORE_ADDR addr, struct objc_class *class)
1763 class->isa = read_memory_unsigned_integer (addr, 4);
1764 class->super_class = read_memory_unsigned_integer (addr + 4, 4);
1765 class->name = read_memory_unsigned_integer (addr + 8, 4);
1766 class->version = read_memory_unsigned_integer (addr + 12, 4);
1767 class->info = read_memory_unsigned_integer (addr + 16, 4);
1768 class->instance_size = read_memory_unsigned_integer (addr + 18, 4);
1769 class->ivars = read_memory_unsigned_integer (addr + 24, 4);
1770 class->methods = read_memory_unsigned_integer (addr + 28, 4);
1771 class->cache = read_memory_unsigned_integer (addr + 32, 4);
1772 class->protocols = read_memory_unsigned_integer (addr + 36, 4);
1776 find_implementation_from_class (CORE_ADDR class, CORE_ADDR sel)
1778 CORE_ADDR subclass = class;
1780 while (subclass != 0)
1783 struct objc_class class_str;
1784 unsigned mlistnum = 0;
1786 read_objc_class (subclass, &class_str);
1791 unsigned long nmethods;
1794 mlist = read_memory_unsigned_integer (class_str.methods +
1799 nmethods = read_objc_methlist_nmethods (mlist);
1801 for (i = 0; i < nmethods; i++)
1803 struct objc_method meth_str;
1804 read_objc_methlist_method (mlist, i, &meth_str);
1808 "checking method 0x%lx against selector 0x%lx\n",
1809 meth_str.name, sel);
1812 if (meth_str.name == sel)
1813 /* FIXME: hppa arch was doing a pointer dereference
1814 here. There needs to be a better way to do that. */
1815 return meth_str.imp;
1819 subclass = class_str.super_class;
1826 find_implementation (CORE_ADDR object, CORE_ADDR sel)
1828 struct objc_object ostr;
1832 read_objc_object (object, &ostr);
1836 return find_implementation_from_class (ostr.isa, sel);
1839 #define OBJC_FETCH_POINTER_ARGUMENT(argi) \
1840 FETCH_POINTER_ARGUMENT (get_current_frame (), argi, builtin_type_void_func_ptr)
1843 resolve_msgsend (CORE_ADDR pc, CORE_ADDR *new_pc)
1849 object = OBJC_FETCH_POINTER_ARGUMENT (0);
1850 sel = OBJC_FETCH_POINTER_ARGUMENT (1);
1852 res = find_implementation (object, sel);
1861 resolve_msgsend_stret (CORE_ADDR pc, CORE_ADDR *new_pc)
1867 object = OBJC_FETCH_POINTER_ARGUMENT (1);
1868 sel = OBJC_FETCH_POINTER_ARGUMENT (2);
1870 res = find_implementation (object, sel);
1879 resolve_msgsend_super (CORE_ADDR pc, CORE_ADDR *new_pc)
1881 struct objc_super sstr;
1887 super = OBJC_FETCH_POINTER_ARGUMENT (0);
1888 sel = OBJC_FETCH_POINTER_ARGUMENT (1);
1890 read_objc_super (super, &sstr);
1891 if (sstr.class == 0)
1894 res = find_implementation_from_class (sstr.class, sel);
1903 resolve_msgsend_super_stret (CORE_ADDR pc, CORE_ADDR *new_pc)
1905 struct objc_super sstr;
1911 super = OBJC_FETCH_POINTER_ARGUMENT (1);
1912 sel = OBJC_FETCH_POINTER_ARGUMENT (2);
1914 read_objc_super (super, &sstr);
1915 if (sstr.class == 0)
1918 res = find_implementation_from_class (sstr.class, sel);