1 /* Objective-C language support routines for GDB, the GNU debugger.
3 Copyright (C) 2002, 2003, 2004, 2005, 2007, 2008
4 Free Software Foundation, Inc.
6 Contributed by Apple Computer, Inc.
7 Written by Michael Snyder.
9 This file is part of GDB.
11 This program is free software; you can redistribute it and/or modify
12 it under the terms of the GNU General Public License as published by
13 the Free Software Foundation; either version 3 of the License, or
14 (at your option) any later version.
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 GNU General Public License for more details.
21 You should have received a copy of the GNU General Public License
22 along with this program. If not, see <http://www.gnu.org/licenses/>. */
27 #include "expression.h"
28 #include "parser-defs.h"
31 #include "objc-lang.h"
32 #include "exceptions.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)
88 sym = lookup_symbol (name, block, STRUCT_DOMAIN, 0);
95 error (_("No struct type named %s."), name);
97 if (TYPE_CODE (SYMBOL_TYPE (sym)) != TYPE_CODE_STRUCT)
102 error (_("This context has class, union or enum %s, not a struct."),
109 lookup_objc_class (char *classname)
111 struct value * function, *classval;
113 if (! target_has_execution)
115 /* Can't call into inferior to lookup class. */
119 if (lookup_minimal_symbol("objc_lookUpClass", 0, 0))
120 function = find_function_in_inferior("objc_lookUpClass", NULL);
121 else if (lookup_minimal_symbol ("objc_lookup_class", 0, 0))
122 function = find_function_in_inferior("objc_lookup_class", NULL);
125 complaint (&symfile_complaints, _("no way to lookup Objective-C classes"));
129 classval = value_string (classname, strlen (classname) + 1);
130 classval = value_coerce_array (classval);
131 return (CORE_ADDR) value_as_long (call_function_by_hand (function,
136 lookup_child_selector (char *selname)
138 struct value * function, *selstring;
140 if (! target_has_execution)
142 /* Can't call into inferior to lookup selector. */
146 if (lookup_minimal_symbol("sel_getUid", 0, 0))
147 function = find_function_in_inferior("sel_getUid", NULL);
148 else if (lookup_minimal_symbol ("sel_get_any_uid", 0, 0))
149 function = find_function_in_inferior("sel_get_any_uid", NULL);
152 complaint (&symfile_complaints, _("no way to lookup Objective-C selectors"));
156 selstring = value_coerce_array (value_string (selname,
157 strlen (selname) + 1));
158 return value_as_long (call_function_by_hand (function, 1, &selstring));
162 value_nsstring (char *ptr, int len)
164 struct value *stringValue[3];
165 struct value *function, *nsstringValue;
168 struct objfile *objf;
169 struct gdbarch *gdbarch;
171 if (!target_has_execution)
172 return 0; /* Can't call into inferior to create NSString. */
174 stringValue[2] = value_string(ptr, len);
175 stringValue[2] = value_coerce_array(stringValue[2]);
176 /* _NSNewStringFromCString replaces "istr" after Lantern2A. */
177 if (lookup_minimal_symbol("_NSNewStringFromCString", 0, 0))
179 function = find_function_in_inferior("_NSNewStringFromCString", &objf);
180 nsstringValue = call_function_by_hand(function, 1, &stringValue[2]);
182 else if (lookup_minimal_symbol("istr", 0, 0))
184 function = find_function_in_inferior("istr", &objf);
185 nsstringValue = call_function_by_hand(function, 1, &stringValue[2]);
187 else if (lookup_minimal_symbol("+[NSString stringWithCString:]", 0, 0))
190 = find_function_in_inferior("+[NSString stringWithCString:]", &objf);
191 type = builtin_type (get_objfile_arch (objf))->builtin_long;
193 stringValue[0] = value_from_longest
194 (type, lookup_objc_class ("NSString"));
195 stringValue[1] = value_from_longest
196 (type, lookup_child_selector ("stringWithCString:"));
197 nsstringValue = call_function_by_hand(function, 3, &stringValue[0]);
200 error (_("NSString: internal error -- no way to create new NSString"));
202 gdbarch = get_objfile_arch (objf);
204 sym = lookup_struct_typedef("NSString", 0, 1);
206 sym = lookup_struct_typedef("NXString", 0, 1);
208 type = builtin_type (gdbarch)->builtin_data_ptr;
210 type = lookup_pointer_type(SYMBOL_TYPE (sym));
212 deprecated_set_value_type (nsstringValue, type);
213 return nsstringValue;
216 /* Objective-C name demangling. */
219 objc_demangle (const char *mangled, int options)
221 char *demangled, *cp;
223 if (mangled[0] == '_' &&
224 (mangled[1] == 'i' || mangled[1] == 'c') &&
227 cp = demangled = xmalloc(strlen(mangled) + 2);
229 if (mangled[1] == 'i')
230 *cp++ = '-'; /* for instance method */
232 *cp++ = '+'; /* for class method */
234 *cp++ = '['; /* opening left brace */
235 strcpy(cp, mangled+3); /* tack on the rest of the mangled name */
237 while (*cp && *cp == '_')
238 cp++; /* skip any initial underbars in class name */
240 cp = strchr(cp, '_');
241 if (!cp) /* find first non-initial underbar */
243 xfree(demangled); /* not mangled name */
246 if (cp[1] == '_') { /* easy case: no category name */
247 *cp++ = ' '; /* replace two '_' with one ' ' */
248 strcpy(cp, mangled + (cp - demangled) + 2);
251 *cp++ = '('; /* less easy case: category name */
252 cp = strchr(cp, '_');
255 xfree(demangled); /* not mangled name */
259 *cp++ = ' '; /* overwriting 1st char of method name... */
260 strcpy(cp, mangled + (cp - demangled)); /* get it back */
263 while (*cp && *cp == '_')
264 cp++; /* skip any initial underbars in method name */
268 *cp = ':'; /* replace remaining '_' with ':' */
270 *cp++ = ']'; /* closing right brace */
271 *cp++ = 0; /* string terminator */
275 return NULL; /* Not an objc mangled name. */
278 /* Print the character C on STREAM as part of the contents of a
279 literal string whose delimiter is QUOTER. Note that that format
280 for printing characters and strings is language specific. */
283 objc_emit_char (int c, struct ui_file *stream, int quoter)
286 c &= 0xFF; /* Avoid sign bit follies. */
288 if (PRINT_LITERAL_FORM (c))
290 if (c == '\\' || c == quoter)
292 fputs_filtered ("\\", stream);
294 fprintf_filtered (stream, "%c", c);
301 fputs_filtered ("\\n", stream);
304 fputs_filtered ("\\b", stream);
307 fputs_filtered ("\\t", stream);
310 fputs_filtered ("\\f", stream);
313 fputs_filtered ("\\r", stream);
316 fputs_filtered ("\\e", stream);
319 fputs_filtered ("\\a", stream);
322 fprintf_filtered (stream, "\\%.3o", (unsigned int) c);
329 objc_printchar (int c, struct ui_file *stream)
331 fputs_filtered ("'", stream);
332 objc_emit_char (c, stream, '\'');
333 fputs_filtered ("'", stream);
336 /* Print the character string STRING, printing at most LENGTH
337 characters. Printing stops early if the number hits print_max;
338 repeat counts are printed as appropriate. Print ellipses at the
339 end if we had to stop before printing LENGTH characters, or if
343 objc_printstr (struct ui_file *stream, const gdb_byte *string,
344 unsigned int length, int width, int force_ellipses)
347 unsigned int things_printed = 0;
351 /* If the string was not truncated due to `set print elements', and
352 the last byte of it is a null, we don't print that, in
353 traditional C style. */
354 if ((!force_ellipses) && length > 0 && string[length-1] == '\0')
359 fputs_filtered ("\"\"", stream);
363 for (i = 0; i < length && things_printed < print_max; ++i)
365 /* Position of the character we are examining to see whether it
368 /* Number of repetitions we have detected so far. */
375 fputs_filtered (", ", stream);
381 while (rep1 < length && string[rep1] == string[i])
387 if (reps > repeat_count_threshold)
392 fputs_filtered ("\\\", ", stream);
394 fputs_filtered ("\", ", stream);
397 objc_printchar (string[i], stream);
398 fprintf_filtered (stream, " <repeats %u times>", reps);
400 things_printed += repeat_count_threshold;
408 fputs_filtered ("\\\"", stream);
410 fputs_filtered ("\"", stream);
413 objc_emit_char (string[i], stream, '"');
418 /* Terminate the quotes if necessary. */
422 fputs_filtered ("\\\"", stream);
424 fputs_filtered ("\"", stream);
427 if (force_ellipses || i < length)
428 fputs_filtered ("...", stream);
431 /* Determine if we are currently in the Objective-C dispatch function.
432 If so, get the address of the method function that the dispatcher
433 would call and use that as the function to step into instead. Also
434 skip over the trampoline for the function (if any). This is better
435 for the user since they are only interested in stepping into the
436 method function anyway. */
438 objc_skip_trampoline (struct frame_info *frame, CORE_ADDR stop_pc)
440 CORE_ADDR real_stop_pc;
441 CORE_ADDR method_stop_pc;
443 real_stop_pc = gdbarch_skip_trampoline_code
444 (current_gdbarch, frame, stop_pc);
446 if (real_stop_pc != 0)
447 find_objc_msgcall (real_stop_pc, &method_stop_pc);
449 find_objc_msgcall (stop_pc, &method_stop_pc);
453 real_stop_pc = gdbarch_skip_trampoline_code
454 (current_gdbarch, frame, method_stop_pc);
455 if (real_stop_pc == 0)
456 real_stop_pc = method_stop_pc;
463 /* Table mapping opcodes into strings for printing operators
464 and precedences of the operators. */
466 static const struct op_print objc_op_print_tab[] =
468 {",", BINOP_COMMA, PREC_COMMA, 0},
469 {"=", BINOP_ASSIGN, PREC_ASSIGN, 1},
470 {"||", BINOP_LOGICAL_OR, PREC_LOGICAL_OR, 0},
471 {"&&", BINOP_LOGICAL_AND, PREC_LOGICAL_AND, 0},
472 {"|", BINOP_BITWISE_IOR, PREC_BITWISE_IOR, 0},
473 {"^", BINOP_BITWISE_XOR, PREC_BITWISE_XOR, 0},
474 {"&", BINOP_BITWISE_AND, PREC_BITWISE_AND, 0},
475 {"==", BINOP_EQUAL, PREC_EQUAL, 0},
476 {"!=", BINOP_NOTEQUAL, PREC_EQUAL, 0},
477 {"<=", BINOP_LEQ, PREC_ORDER, 0},
478 {">=", BINOP_GEQ, PREC_ORDER, 0},
479 {">", BINOP_GTR, PREC_ORDER, 0},
480 {"<", BINOP_LESS, PREC_ORDER, 0},
481 {">>", BINOP_RSH, PREC_SHIFT, 0},
482 {"<<", BINOP_LSH, PREC_SHIFT, 0},
483 {"+", BINOP_ADD, PREC_ADD, 0},
484 {"-", BINOP_SUB, PREC_ADD, 0},
485 {"*", BINOP_MUL, PREC_MUL, 0},
486 {"/", BINOP_DIV, PREC_MUL, 0},
487 {"%", BINOP_REM, PREC_MUL, 0},
488 {"@", BINOP_REPEAT, PREC_REPEAT, 0},
489 {"-", UNOP_NEG, PREC_PREFIX, 0},
490 {"!", UNOP_LOGICAL_NOT, PREC_PREFIX, 0},
491 {"~", UNOP_COMPLEMENT, PREC_PREFIX, 0},
492 {"*", UNOP_IND, PREC_PREFIX, 0},
493 {"&", UNOP_ADDR, PREC_PREFIX, 0},
494 {"sizeof ", UNOP_SIZEOF, PREC_PREFIX, 0},
495 {"++", UNOP_PREINCREMENT, PREC_PREFIX, 0},
496 {"--", UNOP_PREDECREMENT, PREC_PREFIX, 0},
497 {NULL, OP_NULL, PREC_NULL, 0}
500 const struct language_defn objc_language_defn = {
501 "objective-c", /* Language name */
507 &exp_descriptor_standard,
511 objc_printchar, /* Print a character constant */
512 objc_printstr, /* Function to print string constant */
514 c_print_type, /* Print a type using appropriate syntax */
515 c_val_print, /* Print a value using appropriate syntax */
516 c_value_print, /* Print a top-level value */
517 objc_skip_trampoline, /* Language specific skip_trampoline */
518 "self", /* name_of_this */
519 basic_lookup_symbol_nonlocal, /* lookup_symbol_nonlocal */
520 basic_lookup_transparent_type,/* lookup_transparent_type */
521 objc_demangle, /* Language specific symbol demangler */
522 NULL, /* Language specific class_name_from_physname */
523 objc_op_print_tab, /* Expression operators for printing */
524 1, /* C-style arrays */
525 0, /* String lower bound */
526 default_word_break_characters,
527 default_make_symbol_completion_list,
528 c_language_arch_info,
529 default_print_array_index,
530 default_pass_by_reference,
536 * Following functions help construct Objective-C message calls
539 struct selname /* For parsing Objective-C. */
541 struct selname *next;
546 static int msglist_len;
547 static struct selname *selname_chain;
548 static char *msglist_sel;
553 struct selname *new =
554 (struct selname *) xmalloc (sizeof (struct selname));
556 new->next = selname_chain;
557 new->msglist_len = msglist_len;
558 new->msglist_sel = msglist_sel;
560 msglist_sel = (char *)xmalloc(1);
566 add_msglist(struct stoken *str, int addcolon)
571 if (str == 0) { /* Unnamed arg, or... */
572 if (addcolon == 0) { /* variable number of args. */
582 len = plen + strlen(msglist_sel) + 2;
583 s = (char *)xmalloc(len);
584 strcpy(s, msglist_sel);
599 int val = msglist_len;
600 struct selname *sel = selname_chain;
601 char *p = msglist_sel;
604 selname_chain = sel->next;
605 msglist_len = sel->msglist_len;
606 msglist_sel = sel->msglist_sel;
607 selid = lookup_child_selector(p);
609 error (_("Can't find selector \"%s\""), p);
610 write_exp_elt_longcst (selid);
612 write_exp_elt_longcst (val); /* Number of args */
619 * Function: specialcmp (char *a, char *b)
621 * Special strcmp: treats ']' and ' ' as end-of-string.
622 * Used for qsorting lists of objc methods (either by class or selector).
626 specialcmp (char *a, char *b)
628 while (*a && *a != ' ' && *a != ']' && *b && *b != ' ' && *b != ']')
634 if (*a && *a != ' ' && *a != ']')
635 return 1; /* a is longer therefore greater */
636 if (*b && *b != ' ' && *b != ']')
637 return -1; /* a is shorter therefore lesser */
638 return 0; /* a and b are identical */
642 * Function: compare_selectors (const void *, const void *)
644 * Comparison function for use with qsort. Arguments are symbols or
645 * msymbols Compares selector part of objc method name alphabetically.
649 compare_selectors (const void *a, const void *b)
653 aname = SYMBOL_PRINT_NAME (*(struct symbol **) a);
654 bname = SYMBOL_PRINT_NAME (*(struct symbol **) b);
655 if (aname == NULL || bname == NULL)
656 error (_("internal: compare_selectors(1)"));
658 aname = strchr(aname, ' ');
659 bname = strchr(bname, ' ');
660 if (aname == NULL || bname == NULL)
661 error (_("internal: compare_selectors(2)"));
663 return specialcmp (aname+1, bname+1);
667 * Function: selectors_info (regexp, from_tty)
669 * Implements the "Info selectors" command. Takes an optional regexp
670 * arg. Lists all objective c selectors that match the regexp. Works
671 * by grepping thru all symbols for objective c methods. Output list
672 * is sorted and uniqued.
676 selectors_info (char *regexp, int from_tty)
678 struct objfile *objfile;
679 struct minimal_symbol *msymbol;
687 struct symbol **sym_arr;
691 strcpy(myregexp, ".*]"); /* Null input, match all objc methods. */
694 if (*regexp == '+' || *regexp == '-')
695 { /* User wants only class methods or only instance methods. */
696 plusminus = *regexp++;
697 while (*regexp == ' ' || *regexp == '\t')
701 strcpy(myregexp, ".*]");
704 strcpy(myregexp, regexp);
705 if (myregexp[strlen(myregexp) - 1] == '$') /* end of selector */
706 myregexp[strlen(myregexp) - 1] = ']'; /* end of method name */
708 strcat(myregexp, ".*]");
714 val = re_comp (myregexp);
716 error (_("Invalid regexp (%s): %s"), val, regexp);
719 /* First time thru is JUST to get max length and count. */
720 ALL_MSYMBOLS (objfile, msymbol)
723 name = SYMBOL_NATURAL_NAME (msymbol);
725 (name[0] == '-' || name[0] == '+') &&
726 name[1] == '[') /* Got a method name. */
728 /* Filter for class/instance methods. */
729 if (plusminus && name[0] != plusminus)
731 /* Find selector part. */
732 name = (char *) strchr(name+2, ' ');
733 if (regexp == NULL || re_exec(++name) != 0)
735 char *mystart = name;
736 char *myend = (char *) strchr(mystart, ']');
738 if (myend && (myend - mystart > maxlen))
739 maxlen = myend - mystart; /* Get longest selector. */
746 printf_filtered (_("Selectors matching \"%s\":\n\n"),
747 regexp ? regexp : "*");
749 sym_arr = alloca (matches * sizeof (struct symbol *));
751 ALL_MSYMBOLS (objfile, msymbol)
754 name = SYMBOL_NATURAL_NAME (msymbol);
756 (name[0] == '-' || name[0] == '+') &&
757 name[1] == '[') /* Got a method name. */
759 /* Filter for class/instance methods. */
760 if (plusminus && name[0] != plusminus)
762 /* Find selector part. */
763 name = (char *) strchr(name+2, ' ');
764 if (regexp == NULL || re_exec(++name) != 0)
765 sym_arr[matches++] = (struct symbol *) msymbol;
769 qsort (sym_arr, matches, sizeof (struct minimal_symbol *),
771 /* Prevent compare on first iteration. */
773 for (ix = 0; ix < matches; ix++) /* Now do the output. */
778 name = SYMBOL_NATURAL_NAME (sym_arr[ix]);
779 name = strchr (name, ' ') + 1;
780 if (p[0] && specialcmp(name, p) == 0)
781 continue; /* Seen this one already (not unique). */
783 /* Copy selector part. */
784 while (*name && *name != ']')
787 /* Print in columns. */
788 puts_filtered_tabular(asel, maxlen + 1, 0);
793 printf_filtered (_("No selectors matching \"%s\"\n"), regexp ? regexp : "*");
797 * Function: compare_classes (const void *, const void *)
799 * Comparison function for use with qsort. Arguments are symbols or
800 * msymbols Compares class part of objc method name alphabetically.
804 compare_classes (const void *a, const void *b)
808 aname = SYMBOL_PRINT_NAME (*(struct symbol **) a);
809 bname = SYMBOL_PRINT_NAME (*(struct symbol **) b);
810 if (aname == NULL || bname == NULL)
811 error (_("internal: compare_classes(1)"));
813 return specialcmp (aname+1, bname+1);
817 * Function: classes_info(regexp, from_tty)
819 * Implements the "info classes" command for objective c classes.
820 * Lists all objective c classes that match the optional regexp.
821 * Works by grepping thru the list of objective c methods. List will
822 * be sorted and uniqued (since one class may have many methods).
823 * BUGS: will not list a class that has no methods.
827 classes_info (char *regexp, int from_tty)
829 struct objfile *objfile;
830 struct minimal_symbol *msymbol;
838 struct symbol **sym_arr;
841 strcpy(myregexp, ".* "); /* Null input: match all objc classes. */
844 strcpy(myregexp, regexp);
845 if (myregexp[strlen(myregexp) - 1] == '$')
846 /* In the method name, the end of the class name is marked by ' '. */
847 myregexp[strlen(myregexp) - 1] = ' ';
849 strcat(myregexp, ".* ");
854 val = re_comp (myregexp);
856 error (_("Invalid regexp (%s): %s"), val, regexp);
859 /* First time thru is JUST to get max length and count. */
860 ALL_MSYMBOLS (objfile, msymbol)
863 name = SYMBOL_NATURAL_NAME (msymbol);
865 (name[0] == '-' || name[0] == '+') &&
866 name[1] == '[') /* Got a method name. */
867 if (regexp == NULL || re_exec(name+2) != 0)
869 /* Compute length of classname part. */
870 char *mystart = name + 2;
871 char *myend = (char *) strchr(mystart, ' ');
873 if (myend && (myend - mystart > maxlen))
874 maxlen = myend - mystart;
880 printf_filtered (_("Classes matching \"%s\":\n\n"),
881 regexp ? regexp : "*");
882 sym_arr = alloca (matches * sizeof (struct symbol *));
884 ALL_MSYMBOLS (objfile, msymbol)
887 name = SYMBOL_NATURAL_NAME (msymbol);
889 (name[0] == '-' || name[0] == '+') &&
890 name[1] == '[') /* Got a method name. */
891 if (regexp == NULL || re_exec(name+2) != 0)
892 sym_arr[matches++] = (struct symbol *) msymbol;
895 qsort (sym_arr, matches, sizeof (struct minimal_symbol *),
897 /* Prevent compare on first iteration. */
899 for (ix = 0; ix < matches; ix++) /* Now do the output. */
904 name = SYMBOL_NATURAL_NAME (sym_arr[ix]);
906 if (p[0] && specialcmp(name, p) == 0)
907 continue; /* Seen this one already (not unique). */
909 /* Copy class part of method name. */
910 while (*name && *name != ' ')
913 /* Print in columns. */
914 puts_filtered_tabular(aclass, maxlen + 1, 0);
919 printf_filtered (_("No classes matching \"%s\"\n"), regexp ? regexp : "*");
923 * Function: find_imps (char *selector, struct symbol **sym_arr)
925 * Input: a string representing a selector
926 * a pointer to an array of symbol pointers
927 * possibly a pointer to a symbol found by the caller.
929 * Output: number of methods that implement that selector. Side
930 * effects: The array of symbol pointers is filled with matching syms.
932 * By analogy with function "find_methods" (symtab.c), builds a list
933 * of symbols matching the ambiguous input, so that "decode_line_2"
934 * (symtab.c) can list them and ask the user to choose one or more.
935 * In this case the matches are objective c methods
936 * ("implementations") matching an objective c selector.
938 * Note that it is possible for a normal (c-style) function to have
939 * the same name as an objective c selector. To prevent the selector
940 * from eclipsing the function, we allow the caller (decode_line_1) to
941 * search for such a function first, and if it finds one, pass it in
942 * to us. We will then integrate it into the list. We also search
943 * for one here, among the minsyms.
945 * NOTE: if NUM_DEBUGGABLE is non-zero, the sym_arr will be divided
946 * into two parts: debuggable (struct symbol) syms, and
947 * non_debuggable (struct minimal_symbol) syms. The debuggable
948 * ones will come first, before NUM_DEBUGGABLE (which will thus
949 * be the index of the first non-debuggable one).
953 * Function: total_number_of_imps (char *selector);
955 * Input: a string representing a selector
956 * Output: number of methods that implement that selector.
958 * By analogy with function "total_number_of_methods", this allows
959 * decode_line_1 (symtab.c) to detect if there are objective c methods
960 * matching the input, and to allocate an array of pointers to them
961 * which can be manipulated by "decode_line_2" (also in symtab.c).
965 parse_selector (char *method, char **selector)
971 char *nselector = NULL;
973 gdb_assert (selector != NULL);
977 while (isspace (*s1))
984 while (isspace (*s1))
991 if (isalnum (*s2) || (*s2 == '_') || (*s2 == ':'))
993 else if (isspace (*s2))
995 else if ((*s2 == '\0') || (*s2 == '\''))
1003 while (isspace (*s2))
1009 while (isspace (*s2))
1013 if (selector != NULL)
1014 *selector = nselector;
1020 parse_method (char *method, char *type, char **class,
1021 char **category, char **selector)
1025 int found_quote = 0;
1028 char *nclass = NULL;
1029 char *ncategory = NULL;
1030 char *nselector = NULL;
1032 gdb_assert (type != NULL);
1033 gdb_assert (class != NULL);
1034 gdb_assert (category != NULL);
1035 gdb_assert (selector != NULL);
1039 while (isspace (*s1))
1046 while (isspace (*s1))
1049 if ((s1[0] == '+') || (s1[0] == '-'))
1052 while (isspace (*s1))
1060 while (isalnum (*s1) || (*s1 == '_'))
1064 while (isspace (*s2))
1070 while (isspace (*s2))
1073 while (isalnum (*s2) || (*s2 == '_'))
1078 /* Truncate the class name now that we're not using the open paren. */
1085 if (isalnum (*s2) || (*s2 == '_') || (*s2 == ':'))
1087 else if (isspace (*s2))
1089 else if (*s2 == ']')
1098 while (isspace (*s2))
1105 while (isspace (*s2))
1113 if (category != NULL)
1114 *category = ncategory;
1115 if (selector != NULL)
1116 *selector = nselector;
1122 find_methods (struct symtab *symtab, char type,
1123 const char *class, const char *category,
1124 const char *selector, struct symbol **syms,
1125 unsigned int *nsym, unsigned int *ndebug)
1127 struct objfile *objfile = NULL;
1128 struct minimal_symbol *msymbol = NULL;
1129 struct block *block = NULL;
1130 struct symbol *sym = NULL;
1132 char *symname = NULL;
1135 char *nclass = NULL;
1136 char *ncategory = NULL;
1137 char *nselector = NULL;
1139 unsigned int csym = 0;
1140 unsigned int cdebug = 0;
1142 static char *tmp = NULL;
1143 static unsigned int tmplen = 0;
1145 gdb_assert (nsym != NULL);
1146 gdb_assert (ndebug != NULL);
1149 block = BLOCKVECTOR_BLOCK (BLOCKVECTOR (symtab), STATIC_BLOCK);
1151 ALL_MSYMBOLS (objfile, msymbol)
1155 if ((msymbol->type != mst_text) && (msymbol->type != mst_file_text))
1156 /* Not a function or method. */
1160 if ((SYMBOL_VALUE_ADDRESS (msymbol) < BLOCK_START (block)) ||
1161 (SYMBOL_VALUE_ADDRESS (msymbol) >= BLOCK_END (block)))
1162 /* Not in the specified symtab. */
1165 symname = SYMBOL_NATURAL_NAME (msymbol);
1166 if (symname == NULL)
1169 if ((symname[0] != '-' && symname[0] != '+') || (symname[1] != '['))
1170 /* Not a method name. */
1173 while ((strlen (symname) + 1) >= tmplen)
1175 tmplen = (tmplen == 0) ? 1024 : tmplen * 2;
1176 tmp = xrealloc (tmp, tmplen);
1178 strcpy (tmp, symname);
1180 if (parse_method (tmp, &ntype, &nclass, &ncategory, &nselector) == NULL)
1183 if ((type != '\0') && (ntype != type))
1187 && ((nclass == NULL) || (strcmp (class, nclass) != 0)))
1190 if ((category != NULL) &&
1191 ((ncategory == NULL) || (strcmp (category, ncategory) != 0)))
1194 if ((selector != NULL) &&
1195 ((nselector == NULL) || (strcmp (selector, nselector) != 0)))
1198 sym = find_pc_function (SYMBOL_VALUE_ADDRESS (msymbol));
1201 const char *newsymname = SYMBOL_NATURAL_NAME (sym);
1203 if (strcmp (symname, newsymname) == 0)
1205 /* Found a high-level method sym: swap it into the
1206 lower part of sym_arr (below num_debuggable). */
1209 syms[csym] = syms[cdebug];
1218 "debugging symbol \"%s\" does not match minimal symbol (\"%s\"); ignoring",
1219 newsymname, symname);
1221 syms[csym] = (struct symbol *) msymbol;
1227 /* Found a non-debuggable method symbol. */
1229 syms[csym] = (struct symbol *) msymbol;
1240 char *find_imps (struct symtab *symtab, struct block *block,
1241 char *method, struct symbol **syms,
1242 unsigned int *nsym, unsigned int *ndebug)
1246 char *category = NULL;
1247 char *selector = NULL;
1249 unsigned int csym = 0;
1250 unsigned int cdebug = 0;
1252 unsigned int ncsym = 0;
1253 unsigned int ncdebug = 0;
1258 gdb_assert (nsym != NULL);
1259 gdb_assert (ndebug != NULL);
1266 buf = (char *) alloca (strlen (method) + 1);
1267 strcpy (buf, method);
1268 tmp = parse_method (buf, &type, &class, &category, &selector);
1272 struct symbol *sym = NULL;
1273 struct minimal_symbol *msym = NULL;
1275 strcpy (buf, method);
1276 tmp = parse_selector (buf, &selector);
1281 sym = lookup_symbol (selector, block, VAR_DOMAIN, 0);
1291 msym = lookup_minimal_symbol (selector, 0, 0);
1296 syms[csym] = (struct symbol *)msym;
1302 find_methods (symtab, type, class, category, selector,
1303 syms + csym, &ncsym, &ncdebug);
1305 find_methods (symtab, type, class, category, selector,
1306 NULL, &ncsym, &ncdebug);
1308 /* If we didn't find any methods, just return. */
1309 if (ncsym == 0 && ncdebug == 0)
1312 /* Take debug symbols from the second batch of symbols and swap them
1313 * with debug symbols from the first batch. Repeat until either the
1314 * second section is out of debug symbols or the first section is
1315 * full of debug symbols. Either way we have all debug symbols
1316 * packed to the beginning of the buffer.
1321 while ((cdebug < csym) && (ncdebug > 0))
1323 struct symbol *s = NULL;
1324 /* First non-debugging symbol. */
1325 unsigned int i = cdebug;
1326 /* Last of second batch of debug symbols. */
1327 unsigned int j = csym + ncdebug - 1;
1333 /* We've moved a symbol from the second debug section to the
1349 return method + (tmp - buf);
1353 /* Sort debuggable symbols. */
1355 qsort (syms, cdebug, sizeof (struct minimal_symbol *),
1358 /* Sort minimal_symbols. */
1359 if ((csym - cdebug) > 1)
1360 qsort (&syms[cdebug], csym - cdebug,
1361 sizeof (struct minimal_symbol *), compare_classes);
1363 /* Terminate the sym_arr list. */
1366 return method + (tmp - buf);
1370 print_object_command (char *args, int from_tty)
1372 struct value *object, *function, *description;
1373 CORE_ADDR string_addr, object_addr;
1377 if (!args || !*args)
1379 "The 'print-object' command requires an argument (an Objective-C object)");
1382 struct expression *expr = parse_expression (args);
1383 struct cleanup *old_chain =
1384 make_cleanup (free_current_contents, &expr);
1387 object = expr->language_defn->la_exp_desc->evaluate_exp
1388 (builtin_type (expr->gdbarch)->builtin_data_ptr, expr, &pc, EVAL_NORMAL);
1389 do_cleanups (old_chain);
1392 /* Validate the address for sanity. */
1393 object_addr = value_as_long (object);
1394 read_memory (object_addr, &c, 1);
1396 function = find_function_in_inferior ("_NSPrintForDebugger", NULL);
1397 if (function == NULL)
1398 error (_("Unable to locate _NSPrintForDebugger in child process"));
1400 description = call_function_by_hand (function, 1, &object);
1402 string_addr = value_as_long (description);
1403 if (string_addr == 0)
1404 error (_("object returns null description"));
1406 read_memory (string_addr + i++, &c, 1);
1409 { /* Read and print characters up to EOS. */
1411 printf_filtered ("%c", c);
1412 read_memory (string_addr + i++, &c, 1);
1415 printf_filtered(_("<object returns empty description>"));
1416 printf_filtered ("\n");
1419 /* The data structure 'methcalls' is used to detect method calls (thru
1420 * ObjC runtime lib functions objc_msgSend, objc_msgSendSuper, etc.),
1421 * and ultimately find the method being called.
1424 struct objc_methcall {
1426 /* Return instance method to be called. */
1427 int (*stop_at) (CORE_ADDR, CORE_ADDR *);
1428 /* Start of pc range corresponding to method invocation. */
1430 /* End of pc range corresponding to method invocation. */
1434 static int resolve_msgsend (CORE_ADDR pc, CORE_ADDR *new_pc);
1435 static int resolve_msgsend_stret (CORE_ADDR pc, CORE_ADDR *new_pc);
1436 static int resolve_msgsend_super (CORE_ADDR pc, CORE_ADDR *new_pc);
1437 static int resolve_msgsend_super_stret (CORE_ADDR pc, CORE_ADDR *new_pc);
1439 static struct objc_methcall methcalls[] = {
1440 { "_objc_msgSend", resolve_msgsend, 0, 0},
1441 { "_objc_msgSend_stret", resolve_msgsend_stret, 0, 0},
1442 { "_objc_msgSendSuper", resolve_msgsend_super, 0, 0},
1443 { "_objc_msgSendSuper_stret", resolve_msgsend_super_stret, 0, 0},
1444 { "_objc_getClass", NULL, 0, 0},
1445 { "_objc_getMetaClass", NULL, 0, 0}
1448 #define nmethcalls (sizeof (methcalls) / sizeof (methcalls[0]))
1450 /* The following function, "find_objc_msgsend", fills in the data
1451 * structure "objc_msgs" by finding the addresses of each of the
1452 * (currently four) functions that it holds (of which objc_msgSend is
1453 * the first). This must be called each time symbols are loaded, in
1454 * case the functions have moved for some reason.
1458 find_objc_msgsend (void)
1461 for (i = 0; i < nmethcalls; i++) {
1463 struct minimal_symbol *func;
1465 /* Try both with and without underscore. */
1466 func = lookup_minimal_symbol (methcalls[i].name, NULL, NULL);
1467 if ((func == NULL) && (methcalls[i].name[0] == '_')) {
1468 func = lookup_minimal_symbol (methcalls[i].name + 1, NULL, NULL);
1471 methcalls[i].begin = 0;
1472 methcalls[i].end = 0;
1476 methcalls[i].begin = SYMBOL_VALUE_ADDRESS (func);
1478 methcalls[i].end = SYMBOL_VALUE_ADDRESS (++func);
1479 } while (methcalls[i].begin == methcalls[i].end);
1483 /* find_objc_msgcall (replaces pc_off_limits)
1485 * ALL that this function now does is to determine whether the input
1486 * address ("pc") is the address of one of the Objective-C message
1487 * dispatch functions (mainly objc_msgSend or objc_msgSendSuper), and
1488 * if so, it returns the address of the method that will be called.
1490 * The old function "pc_off_limits" used to do a lot of other things
1491 * in addition, such as detecting shared library jump stubs and
1492 * returning the address of the shlib function that would be called.
1493 * That functionality has been moved into the gdbarch_skip_trampoline_code and
1494 * IN_SOLIB_TRAMPOLINE macros, which are resolved in the target-
1495 * dependent modules.
1498 struct objc_submethod_helper_data {
1499 int (*f) (CORE_ADDR, CORE_ADDR *);
1505 find_objc_msgcall_submethod_helper (void * arg)
1507 struct objc_submethod_helper_data *s =
1508 (struct objc_submethod_helper_data *) arg;
1510 if (s->f (s->pc, s->new_pc) == 0)
1517 find_objc_msgcall_submethod (int (*f) (CORE_ADDR, CORE_ADDR *),
1521 struct objc_submethod_helper_data s;
1527 if (catch_errors (find_objc_msgcall_submethod_helper,
1529 "Unable to determine target of Objective-C method call (ignoring):\n",
1530 RETURN_MASK_ALL) == 0)
1537 find_objc_msgcall (CORE_ADDR pc, CORE_ADDR *new_pc)
1541 find_objc_msgsend ();
1547 for (i = 0; i < nmethcalls; i++)
1548 if ((pc >= methcalls[i].begin) && (pc < methcalls[i].end))
1550 if (methcalls[i].stop_at != NULL)
1551 return find_objc_msgcall_submethod (methcalls[i].stop_at,
1560 extern initialize_file_ftype _initialize_objc_language; /* -Wmissing-prototypes */
1563 _initialize_objc_language (void)
1565 add_language (&objc_language_defn);
1566 add_info ("selectors", selectors_info, /* INFO SELECTORS command. */
1567 _("All Objective-C selectors, or those matching REGEXP."));
1568 add_info ("classes", classes_info, /* INFO CLASSES command. */
1569 _("All Objective-C classes, or those matching REGEXP."));
1570 add_com ("print-object", class_vars, print_object_command,
1571 _("Ask an Objective-C object to print itself."));
1572 add_com_alias ("po", "print-object", class_vars, 1);
1576 read_objc_method (CORE_ADDR addr, struct objc_method *method)
1578 method->name = read_memory_unsigned_integer (addr + 0, 4);
1579 method->types = read_memory_unsigned_integer (addr + 4, 4);
1580 method->imp = read_memory_unsigned_integer (addr + 8, 4);
1584 unsigned long read_objc_methlist_nmethods (CORE_ADDR addr)
1586 return read_memory_unsigned_integer (addr + 4, 4);
1590 read_objc_methlist_method (CORE_ADDR addr, unsigned long num,
1591 struct objc_method *method)
1593 gdb_assert (num < read_objc_methlist_nmethods (addr));
1594 read_objc_method (addr + 8 + (12 * num), method);
1598 read_objc_object (CORE_ADDR addr, struct objc_object *object)
1600 object->isa = read_memory_unsigned_integer (addr, 4);
1604 read_objc_super (CORE_ADDR addr, struct objc_super *super)
1606 super->receiver = read_memory_unsigned_integer (addr, 4);
1607 super->class = read_memory_unsigned_integer (addr + 4, 4);
1611 read_objc_class (CORE_ADDR addr, struct objc_class *class)
1613 class->isa = read_memory_unsigned_integer (addr, 4);
1614 class->super_class = read_memory_unsigned_integer (addr + 4, 4);
1615 class->name = read_memory_unsigned_integer (addr + 8, 4);
1616 class->version = read_memory_unsigned_integer (addr + 12, 4);
1617 class->info = read_memory_unsigned_integer (addr + 16, 4);
1618 class->instance_size = read_memory_unsigned_integer (addr + 18, 4);
1619 class->ivars = read_memory_unsigned_integer (addr + 24, 4);
1620 class->methods = read_memory_unsigned_integer (addr + 28, 4);
1621 class->cache = read_memory_unsigned_integer (addr + 32, 4);
1622 class->protocols = read_memory_unsigned_integer (addr + 36, 4);
1626 find_implementation_from_class (CORE_ADDR class, CORE_ADDR sel)
1628 CORE_ADDR subclass = class;
1630 while (subclass != 0)
1633 struct objc_class class_str;
1634 unsigned mlistnum = 0;
1636 read_objc_class (subclass, &class_str);
1641 unsigned long nmethods;
1644 mlist = read_memory_unsigned_integer (class_str.methods +
1649 nmethods = read_objc_methlist_nmethods (mlist);
1651 for (i = 0; i < nmethods; i++)
1653 struct objc_method meth_str;
1654 read_objc_methlist_method (mlist, i, &meth_str);
1658 "checking method 0x%lx against selector 0x%lx\n",
1659 meth_str.name, sel);
1662 if (meth_str.name == sel)
1663 /* FIXME: hppa arch was doing a pointer dereference
1664 here. There needs to be a better way to do that. */
1665 return meth_str.imp;
1669 subclass = class_str.super_class;
1676 find_implementation (CORE_ADDR object, CORE_ADDR sel)
1678 struct objc_object ostr;
1682 read_objc_object (object, &ostr);
1686 return find_implementation_from_class (ostr.isa, sel);
1690 resolve_msgsend (CORE_ADDR pc, CORE_ADDR *new_pc)
1692 struct frame_info *frame = get_current_frame ();
1693 struct gdbarch *gdbarch = get_frame_arch (frame);
1694 struct type *ptr_type = builtin_type (gdbarch)->builtin_func_ptr;
1700 object = gdbarch_fetch_pointer_argument (gdbarch, frame, 0, ptr_type);
1701 sel = gdbarch_fetch_pointer_argument (gdbarch, frame, 1, ptr_type);
1703 res = find_implementation (object, sel);
1712 resolve_msgsend_stret (CORE_ADDR pc, CORE_ADDR *new_pc)
1714 struct frame_info *frame = get_current_frame ();
1715 struct gdbarch *gdbarch = get_frame_arch (frame);
1716 struct type *ptr_type = builtin_type (gdbarch)->builtin_func_ptr;
1722 object = gdbarch_fetch_pointer_argument (gdbarch, frame, 1, ptr_type);
1723 sel = gdbarch_fetch_pointer_argument (gdbarch, frame, 2, ptr_type);
1725 res = find_implementation (object, sel);
1734 resolve_msgsend_super (CORE_ADDR pc, CORE_ADDR *new_pc)
1736 struct frame_info *frame = get_current_frame ();
1737 struct gdbarch *gdbarch = get_frame_arch (frame);
1738 struct type *ptr_type = builtin_type (gdbarch)->builtin_func_ptr;
1740 struct objc_super sstr;
1746 super = gdbarch_fetch_pointer_argument (gdbarch, frame, 0, ptr_type);
1747 sel = gdbarch_fetch_pointer_argument (gdbarch, frame, 1, ptr_type);
1749 read_objc_super (super, &sstr);
1750 if (sstr.class == 0)
1753 res = find_implementation_from_class (sstr.class, sel);
1762 resolve_msgsend_super_stret (CORE_ADDR pc, CORE_ADDR *new_pc)
1764 struct frame_info *frame = get_current_frame ();
1765 struct gdbarch *gdbarch = get_frame_arch (frame);
1766 struct type *ptr_type = builtin_type (gdbarch)->builtin_func_ptr;
1768 struct objc_super sstr;
1774 super = gdbarch_fetch_pointer_argument (gdbarch, frame, 1, ptr_type);
1775 sel = gdbarch_fetch_pointer_argument (gdbarch, frame, 2, ptr_type);
1777 read_objc_super (super, &sstr);
1778 if (sstr.class == 0)
1781 res = find_implementation_from_class (sstr.class, sel);