1 /* Objective-C language support routines for GDB, the GNU debugger.
3 Copyright (C) 2002-2013 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 3 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, see <http://www.gnu.org/licenses/>. */
26 #include "expression.h"
27 #include "parser-defs.h"
30 #include "objc-lang.h"
31 #include "exceptions.h"
32 #include "complaints.h"
36 #include "gdb_string.h" /* for strchr */
37 #include "target.h" /* for target_has_execution */
41 #include "gdb_regex.h"
46 #include "gdb_assert.h"
47 #include "cli/cli-utils.h"
57 CORE_ADDR super_class;
79 static const struct objfile_data *objc_objfile_data;
81 /* Lookup a structure type named "struct NAME", visible in lexical
82 block BLOCK. If NOERR is nonzero, return zero if NAME is not
86 lookup_struct_typedef (char *name, const struct block *block, int noerr)
90 sym = lookup_symbol (name, block, STRUCT_DOMAIN, 0);
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 (struct gdbarch *gdbarch, char *classname)
113 struct type *char_type = builtin_type (gdbarch)->builtin_char;
114 struct value * function, *classval;
116 if (! target_has_execution)
118 /* Can't call into inferior to lookup class. */
122 if (lookup_minimal_symbol("objc_lookUpClass", 0, 0))
123 function = find_function_in_inferior("objc_lookUpClass", NULL);
124 else if (lookup_minimal_symbol ("objc_lookup_class", 0, 0))
125 function = find_function_in_inferior("objc_lookup_class", NULL);
128 complaint (&symfile_complaints,
129 _("no way to lookup Objective-C classes"));
133 classval = value_string (classname, strlen (classname) + 1, char_type);
134 classval = value_coerce_array (classval);
135 return (CORE_ADDR) value_as_long (call_function_by_hand (function,
140 lookup_child_selector (struct gdbarch *gdbarch, char *selname)
142 struct type *char_type = builtin_type (gdbarch)->builtin_char;
143 struct value * function, *selstring;
145 if (! target_has_execution)
147 /* Can't call into inferior to lookup selector. */
151 if (lookup_minimal_symbol("sel_getUid", 0, 0))
152 function = find_function_in_inferior("sel_getUid", NULL);
153 else if (lookup_minimal_symbol ("sel_get_any_uid", 0, 0))
154 function = find_function_in_inferior("sel_get_any_uid", NULL);
157 complaint (&symfile_complaints,
158 _("no way to lookup Objective-C selectors"));
162 selstring = value_coerce_array (value_string (selname,
163 strlen (selname) + 1,
165 return value_as_long (call_function_by_hand (function, 1, &selstring));
169 value_nsstring (struct gdbarch *gdbarch, char *ptr, int len)
171 struct type *char_type = builtin_type (gdbarch)->builtin_char;
172 struct value *stringValue[3];
173 struct value *function, *nsstringValue;
177 if (!target_has_execution)
178 return 0; /* Can't call into inferior to create NSString. */
180 stringValue[2] = value_string(ptr, len, char_type);
181 stringValue[2] = value_coerce_array(stringValue[2]);
182 /* _NSNewStringFromCString replaces "istr" after Lantern2A. */
183 if (lookup_minimal_symbol("_NSNewStringFromCString", 0, 0))
185 function = find_function_in_inferior("_NSNewStringFromCString", NULL);
186 nsstringValue = call_function_by_hand(function, 1, &stringValue[2]);
188 else if (lookup_minimal_symbol("istr", 0, 0))
190 function = find_function_in_inferior("istr", NULL);
191 nsstringValue = call_function_by_hand(function, 1, &stringValue[2]);
193 else if (lookup_minimal_symbol("+[NSString stringWithCString:]", 0, 0))
196 = find_function_in_inferior("+[NSString stringWithCString:]", NULL);
197 type = builtin_type (gdbarch)->builtin_long;
199 stringValue[0] = value_from_longest
200 (type, lookup_objc_class (gdbarch, "NSString"));
201 stringValue[1] = value_from_longest
202 (type, lookup_child_selector (gdbarch, "stringWithCString:"));
203 nsstringValue = call_function_by_hand(function, 3, &stringValue[0]);
206 error (_("NSString: internal error -- no way to create new NSString"));
208 sym = lookup_struct_typedef("NSString", 0, 1);
210 sym = lookup_struct_typedef("NXString", 0, 1);
212 type = builtin_type (gdbarch)->builtin_data_ptr;
214 type = lookup_pointer_type(SYMBOL_TYPE (sym));
216 deprecated_set_value_type (nsstringValue, type);
217 return nsstringValue;
220 /* Objective-C name demangling. */
223 objc_demangle (const char *mangled, int options)
225 char *demangled, *cp;
227 if (mangled[0] == '_' &&
228 (mangled[1] == 'i' || mangled[1] == 'c') &&
231 cp = demangled = xmalloc(strlen(mangled) + 2);
233 if (mangled[1] == 'i')
234 *cp++ = '-'; /* for instance method */
236 *cp++ = '+'; /* for class method */
238 *cp++ = '['; /* opening left brace */
239 strcpy(cp, mangled+3); /* Tack on the rest of the mangled name. */
241 while (*cp && *cp == '_')
242 cp++; /* Skip any initial underbars in class
245 cp = strchr(cp, '_');
246 if (!cp) /* Find first non-initial underbar. */
248 xfree(demangled); /* not mangled name */
251 if (cp[1] == '_') /* Easy case: no category name. */
253 *cp++ = ' '; /* Replace two '_' with one ' '. */
254 strcpy(cp, mangled + (cp - demangled) + 2);
258 *cp++ = '('; /* Less easy case: category name. */
259 cp = strchr(cp, '_');
262 xfree(demangled); /* not mangled name */
266 *cp++ = ' '; /* Overwriting 1st char of method name... */
267 strcpy(cp, mangled + (cp - demangled)); /* Get it back. */
270 while (*cp && *cp == '_')
271 cp++; /* Skip any initial underbars in
276 *cp = ':'; /* Replace remaining '_' with ':'. */
278 *cp++ = ']'; /* closing right brace */
279 *cp++ = 0; /* string terminator */
283 return NULL; /* Not an objc mangled name. */
286 /* Determine if we are currently in the Objective-C dispatch function.
287 If so, get the address of the method function that the dispatcher
288 would call and use that as the function to step into instead. Also
289 skip over the trampoline for the function (if any). This is better
290 for the user since they are only interested in stepping into the
291 method function anyway. */
293 objc_skip_trampoline (struct frame_info *frame, CORE_ADDR stop_pc)
295 struct gdbarch *gdbarch = get_frame_arch (frame);
296 CORE_ADDR real_stop_pc;
297 CORE_ADDR method_stop_pc;
299 real_stop_pc = gdbarch_skip_trampoline_code (gdbarch, frame, stop_pc);
301 if (real_stop_pc != 0)
302 find_objc_msgcall (real_stop_pc, &method_stop_pc);
304 find_objc_msgcall (stop_pc, &method_stop_pc);
308 real_stop_pc = gdbarch_skip_trampoline_code
309 (gdbarch, frame, method_stop_pc);
310 if (real_stop_pc == 0)
311 real_stop_pc = method_stop_pc;
318 /* Table mapping opcodes into strings for printing operators
319 and precedences of the operators. */
321 static const struct op_print objc_op_print_tab[] =
323 {",", BINOP_COMMA, PREC_COMMA, 0},
324 {"=", BINOP_ASSIGN, PREC_ASSIGN, 1},
325 {"||", BINOP_LOGICAL_OR, PREC_LOGICAL_OR, 0},
326 {"&&", BINOP_LOGICAL_AND, PREC_LOGICAL_AND, 0},
327 {"|", BINOP_BITWISE_IOR, PREC_BITWISE_IOR, 0},
328 {"^", BINOP_BITWISE_XOR, PREC_BITWISE_XOR, 0},
329 {"&", BINOP_BITWISE_AND, PREC_BITWISE_AND, 0},
330 {"==", BINOP_EQUAL, PREC_EQUAL, 0},
331 {"!=", BINOP_NOTEQUAL, PREC_EQUAL, 0},
332 {"<=", BINOP_LEQ, PREC_ORDER, 0},
333 {">=", BINOP_GEQ, PREC_ORDER, 0},
334 {">", BINOP_GTR, PREC_ORDER, 0},
335 {"<", BINOP_LESS, PREC_ORDER, 0},
336 {">>", BINOP_RSH, PREC_SHIFT, 0},
337 {"<<", BINOP_LSH, PREC_SHIFT, 0},
338 {"+", BINOP_ADD, PREC_ADD, 0},
339 {"-", BINOP_SUB, PREC_ADD, 0},
340 {"*", BINOP_MUL, PREC_MUL, 0},
341 {"/", BINOP_DIV, PREC_MUL, 0},
342 {"%", BINOP_REM, PREC_MUL, 0},
343 {"@", BINOP_REPEAT, PREC_REPEAT, 0},
344 {"-", UNOP_NEG, PREC_PREFIX, 0},
345 {"!", UNOP_LOGICAL_NOT, PREC_PREFIX, 0},
346 {"~", UNOP_COMPLEMENT, PREC_PREFIX, 0},
347 {"*", UNOP_IND, PREC_PREFIX, 0},
348 {"&", UNOP_ADDR, PREC_PREFIX, 0},
349 {"sizeof ", UNOP_SIZEOF, PREC_PREFIX, 0},
350 {"++", UNOP_PREINCREMENT, PREC_PREFIX, 0},
351 {"--", UNOP_PREDECREMENT, PREC_PREFIX, 0},
352 {NULL, OP_NULL, PREC_NULL, 0}
355 const struct language_defn objc_language_defn = {
356 "objective-c", /* Language name */
362 &exp_descriptor_standard,
366 c_printchar, /* Print a character constant */
367 c_printstr, /* Function to print string constant */
369 c_print_type, /* Print a type using appropriate syntax */
370 c_print_typedef, /* Print a typedef using appropriate syntax */
371 c_val_print, /* Print a value using appropriate syntax */
372 c_value_print, /* Print a top-level value */
373 default_read_var_value, /* la_read_var_value */
374 objc_skip_trampoline, /* Language specific skip_trampoline */
375 "self", /* name_of_this */
376 basic_lookup_symbol_nonlocal, /* lookup_symbol_nonlocal */
377 basic_lookup_transparent_type,/* lookup_transparent_type */
378 objc_demangle, /* Language specific symbol demangler */
379 NULL, /* Language specific
380 class_name_from_physname */
381 objc_op_print_tab, /* Expression operators for printing */
382 1, /* C-style arrays */
383 0, /* String lower bound */
384 default_word_break_characters,
385 default_make_symbol_completion_list,
386 c_language_arch_info,
387 default_print_array_index,
388 default_pass_by_reference,
390 NULL, /* la_get_symbol_name_cmp */
391 iterate_over_symbols,
397 * Following functions help construct Objective-C message calls.
400 struct selname /* For parsing Objective-C. */
402 struct selname *next;
407 static int msglist_len;
408 static struct selname *selname_chain;
409 static char *msglist_sel;
414 struct selname *new =
415 (struct selname *) xmalloc (sizeof (struct selname));
417 new->next = selname_chain;
418 new->msglist_len = msglist_len;
419 new->msglist_sel = msglist_sel;
421 msglist_sel = (char *)xmalloc(1);
427 add_msglist(struct stoken *str, int addcolon)
432 if (str == 0) /* Unnamed arg, or... */
434 if (addcolon == 0) /* variable number of args. */
447 len = plen + strlen(msglist_sel) + 2;
448 s = (char *)xmalloc(len);
449 strcpy(s, msglist_sel);
466 int val = msglist_len;
467 struct selname *sel = selname_chain;
468 char *p = msglist_sel;
471 selname_chain = sel->next;
472 msglist_len = sel->msglist_len;
473 msglist_sel = sel->msglist_sel;
474 selid = lookup_child_selector (parse_gdbarch, p);
476 error (_("Can't find selector \"%s\""), p);
477 write_exp_elt_longcst (selid);
479 write_exp_elt_longcst (val); /* Number of args */
486 * Function: specialcmp (const char *a, const char *b)
488 * Special strcmp: treats ']' and ' ' as end-of-string.
489 * Used for qsorting lists of objc methods (either by class or selector).
493 specialcmp (const char *a, const char *b)
495 while (*a && *a != ' ' && *a != ']' && *b && *b != ' ' && *b != ']')
501 if (*a && *a != ' ' && *a != ']')
502 return 1; /* a is longer therefore greater. */
503 if (*b && *b != ' ' && *b != ']')
504 return -1; /* a is shorter therefore lesser. */
505 return 0; /* a and b are identical. */
509 * Function: compare_selectors (const void *, const void *)
511 * Comparison function for use with qsort. Arguments are symbols or
512 * msymbols Compares selector part of objc method name alphabetically.
516 compare_selectors (const void *a, const void *b)
518 const char *aname, *bname;
520 aname = SYMBOL_PRINT_NAME (*(struct symbol **) a);
521 bname = SYMBOL_PRINT_NAME (*(struct symbol **) b);
522 if (aname == NULL || bname == NULL)
523 error (_("internal: compare_selectors(1)"));
525 aname = strchr(aname, ' ');
526 bname = strchr(bname, ' ');
527 if (aname == NULL || bname == NULL)
528 error (_("internal: compare_selectors(2)"));
530 return specialcmp (aname+1, bname+1);
534 * Function: selectors_info (regexp, from_tty)
536 * Implements the "Info selectors" command. Takes an optional regexp
537 * arg. Lists all objective c selectors that match the regexp. Works
538 * by grepping thru all symbols for objective c methods. Output list
539 * is sorted and uniqued.
543 selectors_info (char *regexp, int from_tty)
545 struct objfile *objfile;
546 struct minimal_symbol *msymbol;
554 struct symbol **sym_arr;
558 strcpy(myregexp, ".*]"); /* Null input, match all objc methods. */
561 if (*regexp == '+' || *regexp == '-')
562 { /* User wants only class methods or only instance methods. */
563 plusminus = *regexp++;
564 while (*regexp == ' ' || *regexp == '\t')
568 strcpy(myregexp, ".*]");
571 /* Allow a few extra bytes because of the strcat below. */
572 if (sizeof (myregexp) < strlen (regexp) + 4)
573 error (_("Regexp is too long: %s"), regexp);
574 strcpy(myregexp, regexp);
575 if (myregexp[strlen(myregexp) - 1] == '$') /* end of selector */
576 myregexp[strlen(myregexp) - 1] = ']'; /* end of method name */
578 strcat(myregexp, ".*]");
584 val = re_comp (myregexp);
586 error (_("Invalid regexp (%s): %s"), val, regexp);
589 /* First time thru is JUST to get max length and count. */
590 ALL_MSYMBOLS (objfile, msymbol)
593 name = SYMBOL_NATURAL_NAME (msymbol);
595 && (name[0] == '-' || name[0] == '+')
596 && name[1] == '[') /* Got a method name. */
598 /* Filter for class/instance methods. */
599 if (plusminus && name[0] != plusminus)
601 /* Find selector part. */
602 name = (char *) strchr (name+2, ' ');
605 complaint (&symfile_complaints,
606 _("Bad method name '%s'"),
607 SYMBOL_NATURAL_NAME (msymbol));
610 if (regexp == NULL || re_exec(++name) != 0)
612 const char *mystart = name;
613 const char *myend = strchr (mystart, ']');
615 if (myend && (myend - mystart > maxlen))
616 maxlen = myend - mystart; /* Get longest selector. */
623 printf_filtered (_("Selectors matching \"%s\":\n\n"),
624 regexp ? regexp : "*");
626 sym_arr = alloca (matches * sizeof (struct symbol *));
628 ALL_MSYMBOLS (objfile, msymbol)
631 name = SYMBOL_NATURAL_NAME (msymbol);
633 (name[0] == '-' || name[0] == '+') &&
634 name[1] == '[') /* Got a method name. */
636 /* Filter for class/instance methods. */
637 if (plusminus && name[0] != plusminus)
639 /* Find selector part. */
640 name = (char *) strchr(name+2, ' ');
641 if (regexp == NULL || re_exec(++name) != 0)
642 sym_arr[matches++] = (struct symbol *) msymbol;
646 qsort (sym_arr, matches, sizeof (struct minimal_symbol *),
648 /* Prevent compare on first iteration. */
650 for (ix = 0; ix < matches; ix++) /* Now do the output. */
655 name = SYMBOL_NATURAL_NAME (sym_arr[ix]);
656 name = strchr (name, ' ') + 1;
657 if (p[0] && specialcmp(name, p) == 0)
658 continue; /* Seen this one already (not unique). */
660 /* Copy selector part. */
661 while (*name && *name != ']')
664 /* Print in columns. */
665 puts_filtered_tabular(asel, maxlen + 1, 0);
670 printf_filtered (_("No selectors matching \"%s\"\n"),
671 regexp ? regexp : "*");
675 * Function: compare_classes (const void *, const void *)
677 * Comparison function for use with qsort. Arguments are symbols or
678 * msymbols Compares class part of objc method name alphabetically.
682 compare_classes (const void *a, const void *b)
684 const char *aname, *bname;
686 aname = SYMBOL_PRINT_NAME (*(struct symbol **) a);
687 bname = SYMBOL_PRINT_NAME (*(struct symbol **) b);
688 if (aname == NULL || bname == NULL)
689 error (_("internal: compare_classes(1)"));
691 return specialcmp (aname+1, bname+1);
695 * Function: classes_info(regexp, from_tty)
697 * Implements the "info classes" command for objective c classes.
698 * Lists all objective c classes that match the optional regexp.
699 * Works by grepping thru the list of objective c methods. List will
700 * be sorted and uniqued (since one class may have many methods).
701 * BUGS: will not list a class that has no methods.
705 classes_info (char *regexp, int from_tty)
707 struct objfile *objfile;
708 struct minimal_symbol *msymbol;
716 struct symbol **sym_arr;
719 strcpy(myregexp, ".* "); /* Null input: match all objc classes. */
722 /* Allow a few extra bytes because of the strcat below. */
723 if (sizeof (myregexp) < strlen (regexp) + 4)
724 error (_("Regexp is too long: %s"), regexp);
725 strcpy(myregexp, regexp);
726 if (myregexp[strlen(myregexp) - 1] == '$')
727 /* In the method name, the end of the class name is marked by ' '. */
728 myregexp[strlen(myregexp) - 1] = ' ';
730 strcat(myregexp, ".* ");
735 val = re_comp (myregexp);
737 error (_("Invalid regexp (%s): %s"), val, regexp);
740 /* First time thru is JUST to get max length and count. */
741 ALL_MSYMBOLS (objfile, msymbol)
744 name = SYMBOL_NATURAL_NAME (msymbol);
746 (name[0] == '-' || name[0] == '+') &&
747 name[1] == '[') /* Got a method name. */
748 if (regexp == NULL || re_exec(name+2) != 0)
750 /* Compute length of classname part. */
751 const char *mystart = name + 2;
752 const char *myend = strchr (mystart, ' ');
754 if (myend && (myend - mystart > maxlen))
755 maxlen = myend - mystart;
761 printf_filtered (_("Classes matching \"%s\":\n\n"),
762 regexp ? regexp : "*");
763 sym_arr = alloca (matches * sizeof (struct symbol *));
765 ALL_MSYMBOLS (objfile, msymbol)
768 name = SYMBOL_NATURAL_NAME (msymbol);
770 (name[0] == '-' || name[0] == '+') &&
771 name[1] == '[') /* Got a method name. */
772 if (regexp == NULL || re_exec(name+2) != 0)
773 sym_arr[matches++] = (struct symbol *) msymbol;
776 qsort (sym_arr, matches, sizeof (struct minimal_symbol *),
778 /* Prevent compare on first iteration. */
780 for (ix = 0; ix < matches; ix++) /* Now do the output. */
785 name = SYMBOL_NATURAL_NAME (sym_arr[ix]);
787 if (p[0] && specialcmp(name, p) == 0)
788 continue; /* Seen this one already (not unique). */
790 /* Copy class part of method name. */
791 while (*name && *name != ' ')
794 /* Print in columns. */
795 puts_filtered_tabular(aclass, maxlen + 1, 0);
800 printf_filtered (_("No classes matching \"%s\"\n"), regexp ? regexp : "*");
804 parse_selector (char *method, char **selector)
810 char *nselector = NULL;
812 gdb_assert (selector != NULL);
816 s1 = skip_spaces (s1);
822 s1 = skip_spaces (s1);
829 if (isalnum (*s2) || (*s2 == '_') || (*s2 == ':'))
831 else if (isspace (*s2))
833 else if ((*s2 == '\0') || (*s2 == '\''))
841 s2 = skip_spaces (s2);
846 s2 = skip_spaces (s2);
849 if (selector != NULL)
850 *selector = nselector;
856 parse_method (char *method, char *type, char **class,
857 char **category, char **selector)
865 char *ncategory = NULL;
866 char *nselector = NULL;
868 gdb_assert (type != NULL);
869 gdb_assert (class != NULL);
870 gdb_assert (category != NULL);
871 gdb_assert (selector != NULL);
875 s1 = skip_spaces (s1);
881 s1 = skip_spaces (s1);
883 if ((s1[0] == '+') || (s1[0] == '-'))
886 s1 = skip_spaces (s1);
893 while (isalnum (*s1) || (*s1 == '_'))
897 s2 = skip_spaces (s2);
902 s2 = skip_spaces (s2);
904 while (isalnum (*s2) || (*s2 == '_'))
909 /* Truncate the class name now that we're not using the open paren. */
917 if (isalnum (*s2) || (*s2 == '_') || (*s2 == ':'))
919 else if (isspace (*s2))
930 s2 = skip_spaces (s2);
936 s2 = skip_spaces (s2);
943 if (category != NULL)
944 *category = ncategory;
945 if (selector != NULL)
946 *selector = nselector;
952 find_methods (char type, const char *class, const char *category,
953 const char *selector,
954 VEC (const_char_ptr) **symbol_names)
956 struct objfile *objfile = NULL;
958 const char *symname = NULL;
962 char *ncategory = NULL;
963 char *nselector = NULL;
965 static char *tmp = NULL;
966 static unsigned int tmplen = 0;
968 gdb_assert (symbol_names != NULL);
970 ALL_OBJFILES (objfile)
972 unsigned int *objc_csym;
973 struct minimal_symbol *msymbol = NULL;
975 /* The objfile_csym variable counts the number of ObjC methods
976 that this objfile defines. We save that count as a private
977 objfile data. If we have already determined that this objfile
978 provides no ObjC methods, we can skip it entirely. */
980 unsigned int objfile_csym = 0;
982 objc_csym = objfile_data (objfile, objc_objfile_data);
983 if (objc_csym != NULL && *objc_csym == 0)
984 /* There are no ObjC symbols in this objfile. Skip it entirely. */
987 ALL_OBJFILE_MSYMBOLS (objfile, msymbol)
991 /* Check the symbol name first as this can be done entirely without
992 sending any query to the target. */
993 symname = SYMBOL_NATURAL_NAME (msymbol);
997 if ((symname[0] != '-' && symname[0] != '+') || (symname[1] != '['))
998 /* Not a method name. */
1003 /* Now that thinks are a bit sane, clean up the symname. */
1004 while ((strlen (symname) + 1) >= tmplen)
1006 tmplen = (tmplen == 0) ? 1024 : tmplen * 2;
1007 tmp = xrealloc (tmp, tmplen);
1009 strcpy (tmp, symname);
1011 if (parse_method (tmp, &ntype, &nclass,
1012 &ncategory, &nselector) == NULL)
1015 if ((type != '\0') && (ntype != type))
1019 && ((nclass == NULL) || (strcmp (class, nclass) != 0)))
1022 if ((category != NULL) &&
1023 ((ncategory == NULL) || (strcmp (category, ncategory) != 0)))
1026 if ((selector != NULL) &&
1027 ((nselector == NULL) || (strcmp (selector, nselector) != 0)))
1030 VEC_safe_push (const_char_ptr, *symbol_names, symname);
1033 if (objc_csym == NULL)
1035 objc_csym = obstack_alloc (&objfile->objfile_obstack,
1036 sizeof (*objc_csym));
1037 *objc_csym = objfile_csym;
1038 set_objfile_data (objfile, objc_objfile_data, objc_csym);
1041 /* Count of ObjC methods in this objfile should be constant. */
1042 gdb_assert (*objc_csym == objfile_csym);
1046 /* Uniquify a VEC of strings. */
1049 uniquify_strings (VEC (const_char_ptr) **strings)
1052 const char *elem, *last = NULL;
1055 qsort (VEC_address (const_char_ptr, *strings),
1056 VEC_length (const_char_ptr, *strings),
1057 sizeof (const_char_ptr),
1060 for (ix = 0; VEC_iterate (const_char_ptr, *strings, ix, elem); ++ix)
1062 if (last == NULL || strcmp (last, elem) != 0)
1065 VEC_replace (const_char_ptr, *strings, out, elem);
1070 VEC_truncate (const_char_ptr, *strings, out);
1074 * Function: find_imps (char *selector, struct symbol **sym_arr)
1076 * Input: a string representing a selector
1077 * a pointer to an array of symbol pointers
1078 * possibly a pointer to a symbol found by the caller.
1080 * Output: number of methods that implement that selector. Side
1081 * effects: The array of symbol pointers is filled with matching syms.
1083 * By analogy with function "find_methods" (symtab.c), builds a list
1084 * of symbols matching the ambiguous input, so that "decode_line_2"
1085 * (symtab.c) can list them and ask the user to choose one or more.
1086 * In this case the matches are objective c methods
1087 * ("implementations") matching an objective c selector.
1089 * Note that it is possible for a normal (c-style) function to have
1090 * the same name as an objective c selector. To prevent the selector
1091 * from eclipsing the function, we allow the caller (decode_line_1) to
1092 * search for such a function first, and if it finds one, pass it in
1093 * to us. We will then integrate it into the list. We also search
1094 * for one here, among the minsyms.
1096 * NOTE: if NUM_DEBUGGABLE is non-zero, the sym_arr will be divided
1097 * into two parts: debuggable (struct symbol) syms, and
1098 * non_debuggable (struct minimal_symbol) syms. The debuggable
1099 * ones will come first, before NUM_DEBUGGABLE (which will thus
1100 * be the index of the first non-debuggable one).
1104 find_imps (char *method, VEC (const_char_ptr) **symbol_names)
1108 char *category = NULL;
1109 char *selector = NULL;
1114 int selector_case = 0;
1116 gdb_assert (symbol_names != NULL);
1118 buf = (char *) alloca (strlen (method) + 1);
1119 strcpy (buf, method);
1120 tmp = parse_method (buf, &type, &class, &category, &selector);
1124 strcpy (buf, method);
1125 tmp = parse_selector (buf, &selector);
1133 find_methods (type, class, category, selector, symbol_names);
1135 /* If we hit the "selector" case, and we found some methods, then
1136 add the selector itself as a symbol, if it exists. */
1137 if (selector_case && !VEC_empty (const_char_ptr, *symbol_names))
1139 struct symbol *sym = lookup_symbol (selector, NULL, VAR_DOMAIN, 0);
1142 VEC_safe_push (const_char_ptr, *symbol_names,
1143 SYMBOL_NATURAL_NAME (sym));
1146 struct minimal_symbol *msym = lookup_minimal_symbol (selector, 0, 0);
1149 VEC_safe_push (const_char_ptr, *symbol_names,
1150 SYMBOL_NATURAL_NAME (msym));
1154 uniquify_strings (symbol_names);
1156 return method + (tmp - buf);
1160 print_object_command (char *args, int from_tty)
1162 struct value *object, *function, *description;
1163 CORE_ADDR string_addr, object_addr;
1167 if (!args || !*args)
1169 "The 'print-object' command requires an argument (an Objective-C object)");
1172 struct expression *expr = parse_expression (args);
1173 struct cleanup *old_chain =
1174 make_cleanup (free_current_contents, &expr);
1177 object = evaluate_subexp (builtin_type (expr->gdbarch)->builtin_data_ptr,
1178 expr, &pc, EVAL_NORMAL);
1179 do_cleanups (old_chain);
1182 /* Validate the address for sanity. */
1183 object_addr = value_as_long (object);
1184 read_memory (object_addr, &c, 1);
1186 function = find_function_in_inferior ("_NSPrintForDebugger", NULL);
1187 if (function == NULL)
1188 error (_("Unable to locate _NSPrintForDebugger in child process"));
1190 description = call_function_by_hand (function, 1, &object);
1192 string_addr = value_as_long (description);
1193 if (string_addr == 0)
1194 error (_("object returns null description"));
1196 read_memory (string_addr + i++, &c, 1);
1199 { /* Read and print characters up to EOS. */
1201 printf_filtered ("%c", c);
1202 read_memory (string_addr + i++, &c, 1);
1205 printf_filtered(_("<object returns empty description>"));
1206 printf_filtered ("\n");
1209 /* The data structure 'methcalls' is used to detect method calls (thru
1210 * ObjC runtime lib functions objc_msgSend, objc_msgSendSuper, etc.),
1211 * and ultimately find the method being called.
1214 struct objc_methcall {
1216 /* Return instance method to be called. */
1217 int (*stop_at) (CORE_ADDR, CORE_ADDR *);
1218 /* Start of pc range corresponding to method invocation. */
1220 /* End of pc range corresponding to method invocation. */
1224 static int resolve_msgsend (CORE_ADDR pc, CORE_ADDR *new_pc);
1225 static int resolve_msgsend_stret (CORE_ADDR pc, CORE_ADDR *new_pc);
1226 static int resolve_msgsend_super (CORE_ADDR pc, CORE_ADDR *new_pc);
1227 static int resolve_msgsend_super_stret (CORE_ADDR pc, CORE_ADDR *new_pc);
1229 static struct objc_methcall methcalls[] = {
1230 { "_objc_msgSend", resolve_msgsend, 0, 0},
1231 { "_objc_msgSend_stret", resolve_msgsend_stret, 0, 0},
1232 { "_objc_msgSendSuper", resolve_msgsend_super, 0, 0},
1233 { "_objc_msgSendSuper_stret", resolve_msgsend_super_stret, 0, 0},
1234 { "_objc_getClass", NULL, 0, 0},
1235 { "_objc_getMetaClass", NULL, 0, 0}
1238 #define nmethcalls (sizeof (methcalls) / sizeof (methcalls[0]))
1240 /* The following function, "find_objc_msgsend", fills in the data
1241 * structure "objc_msgs" by finding the addresses of each of the
1242 * (currently four) functions that it holds (of which objc_msgSend is
1243 * the first). This must be called each time symbols are loaded, in
1244 * case the functions have moved for some reason.
1248 find_objc_msgsend (void)
1252 for (i = 0; i < nmethcalls; i++)
1254 struct minimal_symbol *func;
1256 /* Try both with and without underscore. */
1257 func = lookup_minimal_symbol (methcalls[i].name, NULL, NULL);
1258 if ((func == NULL) && (methcalls[i].name[0] == '_'))
1260 func = lookup_minimal_symbol (methcalls[i].name + 1, NULL, NULL);
1264 methcalls[i].begin = 0;
1265 methcalls[i].end = 0;
1269 methcalls[i].begin = SYMBOL_VALUE_ADDRESS (func);
1271 methcalls[i].end = SYMBOL_VALUE_ADDRESS (++func);
1272 } while (methcalls[i].begin == methcalls[i].end);
1276 /* find_objc_msgcall (replaces pc_off_limits)
1278 * ALL that this function now does is to determine whether the input
1279 * address ("pc") is the address of one of the Objective-C message
1280 * dispatch functions (mainly objc_msgSend or objc_msgSendSuper), and
1281 * if so, it returns the address of the method that will be called.
1283 * The old function "pc_off_limits" used to do a lot of other things
1284 * in addition, such as detecting shared library jump stubs and
1285 * returning the address of the shlib function that would be called.
1286 * That functionality has been moved into the gdbarch_skip_trampoline_code and
1287 * IN_SOLIB_TRAMPOLINE macros, which are resolved in the target-
1288 * dependent modules.
1291 struct objc_submethod_helper_data {
1292 int (*f) (CORE_ADDR, CORE_ADDR *);
1298 find_objc_msgcall_submethod_helper (void * arg)
1300 struct objc_submethod_helper_data *s =
1301 (struct objc_submethod_helper_data *) arg;
1303 if (s->f (s->pc, s->new_pc) == 0)
1310 find_objc_msgcall_submethod (int (*f) (CORE_ADDR, CORE_ADDR *),
1314 struct objc_submethod_helper_data s;
1320 if (catch_errors (find_objc_msgcall_submethod_helper,
1322 "Unable to determine target of "
1323 "Objective-C method call (ignoring):\n",
1324 RETURN_MASK_ALL) == 0)
1331 find_objc_msgcall (CORE_ADDR pc, CORE_ADDR *new_pc)
1335 find_objc_msgsend ();
1341 for (i = 0; i < nmethcalls; i++)
1342 if ((pc >= methcalls[i].begin) && (pc < methcalls[i].end))
1344 if (methcalls[i].stop_at != NULL)
1345 return find_objc_msgcall_submethod (methcalls[i].stop_at,
1354 /* -Wmissing-prototypes */
1355 extern initialize_file_ftype _initialize_objc_language;
1358 _initialize_objc_language (void)
1360 add_language (&objc_language_defn);
1361 add_info ("selectors", selectors_info, /* INFO SELECTORS command. */
1362 _("All Objective-C selectors, or those matching REGEXP."));
1363 add_info ("classes", classes_info, /* INFO CLASSES command. */
1364 _("All Objective-C classes, or those matching REGEXP."));
1365 add_com ("print-object", class_vars, print_object_command,
1366 _("Ask an Objective-C object to print itself."));
1367 add_com_alias ("po", "print-object", class_vars, 1);
1371 read_objc_method (struct gdbarch *gdbarch, CORE_ADDR addr,
1372 struct objc_method *method)
1374 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
1376 method->name = read_memory_unsigned_integer (addr + 0, 4, byte_order);
1377 method->types = read_memory_unsigned_integer (addr + 4, 4, byte_order);
1378 method->imp = read_memory_unsigned_integer (addr + 8, 4, byte_order);
1381 static unsigned long
1382 read_objc_methlist_nmethods (struct gdbarch *gdbarch, CORE_ADDR addr)
1384 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
1386 return read_memory_unsigned_integer (addr + 4, 4, byte_order);
1390 read_objc_methlist_method (struct gdbarch *gdbarch, CORE_ADDR addr,
1391 unsigned long num, struct objc_method *method)
1393 gdb_assert (num < read_objc_methlist_nmethods (gdbarch, addr));
1394 read_objc_method (gdbarch, addr + 8 + (12 * num), method);
1398 read_objc_object (struct gdbarch *gdbarch, CORE_ADDR addr,
1399 struct objc_object *object)
1401 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
1403 object->isa = read_memory_unsigned_integer (addr, 4, byte_order);
1407 read_objc_super (struct gdbarch *gdbarch, CORE_ADDR addr,
1408 struct objc_super *super)
1410 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
1412 super->receiver = read_memory_unsigned_integer (addr, 4, byte_order);
1413 super->class = read_memory_unsigned_integer (addr + 4, 4, byte_order);
1417 read_objc_class (struct gdbarch *gdbarch, CORE_ADDR addr,
1418 struct objc_class *class)
1420 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
1422 class->isa = read_memory_unsigned_integer (addr, 4, byte_order);
1423 class->super_class = read_memory_unsigned_integer (addr + 4, 4, byte_order);
1424 class->name = read_memory_unsigned_integer (addr + 8, 4, byte_order);
1425 class->version = read_memory_unsigned_integer (addr + 12, 4, byte_order);
1426 class->info = read_memory_unsigned_integer (addr + 16, 4, byte_order);
1427 class->instance_size = read_memory_unsigned_integer (addr + 18, 4,
1429 class->ivars = read_memory_unsigned_integer (addr + 24, 4, byte_order);
1430 class->methods = read_memory_unsigned_integer (addr + 28, 4, byte_order);
1431 class->cache = read_memory_unsigned_integer (addr + 32, 4, byte_order);
1432 class->protocols = read_memory_unsigned_integer (addr + 36, 4, byte_order);
1436 find_implementation_from_class (struct gdbarch *gdbarch,
1437 CORE_ADDR class, CORE_ADDR sel)
1439 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
1440 CORE_ADDR subclass = class;
1442 while (subclass != 0)
1445 struct objc_class class_str;
1446 unsigned mlistnum = 0;
1448 read_objc_class (gdbarch, subclass, &class_str);
1453 unsigned long nmethods;
1456 mlist = read_memory_unsigned_integer (class_str.methods +
1462 nmethods = read_objc_methlist_nmethods (gdbarch, mlist);
1464 for (i = 0; i < nmethods; i++)
1466 struct objc_method meth_str;
1468 read_objc_methlist_method (gdbarch, mlist, i, &meth_str);
1471 "checking method 0x%lx against selector 0x%lx\n",
1472 meth_str.name, sel);
1475 if (meth_str.name == sel)
1476 /* FIXME: hppa arch was doing a pointer dereference
1477 here. There needs to be a better way to do that. */
1478 return meth_str.imp;
1482 subclass = class_str.super_class;
1489 find_implementation (struct gdbarch *gdbarch,
1490 CORE_ADDR object, CORE_ADDR sel)
1492 struct objc_object ostr;
1496 read_objc_object (gdbarch, object, &ostr);
1500 return find_implementation_from_class (gdbarch, ostr.isa, sel);
1504 resolve_msgsend (CORE_ADDR pc, CORE_ADDR *new_pc)
1506 struct frame_info *frame = get_current_frame ();
1507 struct gdbarch *gdbarch = get_frame_arch (frame);
1508 struct type *ptr_type = builtin_type (gdbarch)->builtin_func_ptr;
1514 object = gdbarch_fetch_pointer_argument (gdbarch, frame, 0, ptr_type);
1515 sel = gdbarch_fetch_pointer_argument (gdbarch, frame, 1, ptr_type);
1517 res = find_implementation (gdbarch, object, sel);
1526 resolve_msgsend_stret (CORE_ADDR pc, CORE_ADDR *new_pc)
1528 struct frame_info *frame = get_current_frame ();
1529 struct gdbarch *gdbarch = get_frame_arch (frame);
1530 struct type *ptr_type = builtin_type (gdbarch)->builtin_func_ptr;
1536 object = gdbarch_fetch_pointer_argument (gdbarch, frame, 1, ptr_type);
1537 sel = gdbarch_fetch_pointer_argument (gdbarch, frame, 2, ptr_type);
1539 res = find_implementation (gdbarch, object, sel);
1548 resolve_msgsend_super (CORE_ADDR pc, CORE_ADDR *new_pc)
1550 struct frame_info *frame = get_current_frame ();
1551 struct gdbarch *gdbarch = get_frame_arch (frame);
1552 struct type *ptr_type = builtin_type (gdbarch)->builtin_func_ptr;
1554 struct objc_super sstr;
1560 super = gdbarch_fetch_pointer_argument (gdbarch, frame, 0, ptr_type);
1561 sel = gdbarch_fetch_pointer_argument (gdbarch, frame, 1, ptr_type);
1563 read_objc_super (gdbarch, super, &sstr);
1564 if (sstr.class == 0)
1567 res = find_implementation_from_class (gdbarch, sstr.class, sel);
1576 resolve_msgsend_super_stret (CORE_ADDR pc, CORE_ADDR *new_pc)
1578 struct frame_info *frame = get_current_frame ();
1579 struct gdbarch *gdbarch = get_frame_arch (frame);
1580 struct type *ptr_type = builtin_type (gdbarch)->builtin_func_ptr;
1582 struct objc_super sstr;
1588 super = gdbarch_fetch_pointer_argument (gdbarch, frame, 1, ptr_type);
1589 sel = gdbarch_fetch_pointer_argument (gdbarch, frame, 2, ptr_type);
1591 read_objc_super (gdbarch, super, &sstr);
1592 if (sstr.class == 0)
1595 res = find_implementation_from_class (gdbarch, sstr.class, sel);
1603 /* Provide a prototype to silence -Wmissing-prototypes. */
1604 extern initialize_file_ftype _initialize_objc_lang;
1607 _initialize_objc_lang (void)
1609 objc_objfile_data = register_objfile_data ();