1 /* Objective-C language support routines for GDB, the GNU debugger.
3 Copyright (C) 2002-2017 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"
31 #include "objc-lang.h"
32 #include "complaints.h"
36 #include "target.h" /* for target_has_execution */
40 #include "gdb_regex.h"
45 #include "cli/cli-utils.h"
55 CORE_ADDR super_class;
77 static const struct objfile_data *objc_objfile_data;
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 (const char *name, const struct block *block, int noerr)
88 sym = lookup_symbol (name, block, STRUCT_DOMAIN, 0).symbol;
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 (struct gdbarch *gdbarch, const char *classname)
111 struct type *char_type = builtin_type (gdbarch)->builtin_char;
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).minsym)
121 function = find_function_in_inferior("objc_lookUpClass", NULL);
122 else if (lookup_minimal_symbol ("objc_lookup_class", 0, 0).minsym)
123 function = find_function_in_inferior("objc_lookup_class", NULL);
126 complaint (&symfile_complaints,
127 _("no way to lookup Objective-C classes"));
131 classval = value_string (classname, strlen (classname) + 1, char_type);
132 classval = value_coerce_array (classval);
133 return (CORE_ADDR) value_as_long (call_function_by_hand (function,
139 lookup_child_selector (struct gdbarch *gdbarch, const char *selname)
141 struct type *char_type = builtin_type (gdbarch)->builtin_char;
142 struct value * function, *selstring;
144 if (! target_has_execution)
146 /* Can't call into inferior to lookup selector. */
150 if (lookup_minimal_symbol("sel_getUid", 0, 0).minsym)
151 function = find_function_in_inferior("sel_getUid", NULL);
152 else if (lookup_minimal_symbol ("sel_get_any_uid", 0, 0).minsym)
153 function = find_function_in_inferior("sel_get_any_uid", NULL);
156 complaint (&symfile_complaints,
157 _("no way to lookup Objective-C selectors"));
161 selstring = value_coerce_array (value_string (selname,
162 strlen (selname) + 1,
164 return value_as_long (call_function_by_hand (function, NULL, 1, &selstring));
168 value_nsstring (struct gdbarch *gdbarch, char *ptr, int len)
170 struct type *char_type = builtin_type (gdbarch)->builtin_char;
171 struct value *stringValue[3];
172 struct value *function, *nsstringValue;
176 if (!target_has_execution)
177 return 0; /* Can't call into inferior to create NSString. */
179 stringValue[2] = value_string(ptr, len, char_type);
180 stringValue[2] = value_coerce_array(stringValue[2]);
181 /* _NSNewStringFromCString replaces "istr" after Lantern2A. */
182 if (lookup_minimal_symbol("_NSNewStringFromCString", 0, 0).minsym)
184 function = find_function_in_inferior("_NSNewStringFromCString", NULL);
185 nsstringValue = call_function_by_hand(function,
186 NULL, 1, &stringValue[2]);
188 else if (lookup_minimal_symbol("istr", 0, 0).minsym)
190 function = find_function_in_inferior("istr", NULL);
191 nsstringValue = call_function_by_hand(function, NULL, 1, &stringValue[2]);
193 else if (lookup_minimal_symbol("+[NSString stringWithCString:]", 0, 0).minsym)
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, NULL, 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 = (char *) 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 /* la_sniff_from_mangled_name for ObjC. */
289 objc_sniff_from_mangled_name (const char *mangled, char **demangled)
291 *demangled = objc_demangle (mangled, 0);
292 return *demangled != NULL;
295 /* Determine if we are currently in the Objective-C dispatch function.
296 If so, get the address of the method function that the dispatcher
297 would call and use that as the function to step into instead. Also
298 skip over the trampoline for the function (if any). This is better
299 for the user since they are only interested in stepping into the
300 method function anyway. */
302 objc_skip_trampoline (struct frame_info *frame, CORE_ADDR stop_pc)
304 struct gdbarch *gdbarch = get_frame_arch (frame);
305 CORE_ADDR real_stop_pc;
306 CORE_ADDR method_stop_pc;
308 real_stop_pc = gdbarch_skip_trampoline_code (gdbarch, frame, stop_pc);
310 if (real_stop_pc != 0)
311 find_objc_msgcall (real_stop_pc, &method_stop_pc);
313 find_objc_msgcall (stop_pc, &method_stop_pc);
317 real_stop_pc = gdbarch_skip_trampoline_code
318 (gdbarch, frame, method_stop_pc);
319 if (real_stop_pc == 0)
320 real_stop_pc = method_stop_pc;
327 /* Table mapping opcodes into strings for printing operators
328 and precedences of the operators. */
330 static const struct op_print objc_op_print_tab[] =
332 {",", BINOP_COMMA, PREC_COMMA, 0},
333 {"=", BINOP_ASSIGN, PREC_ASSIGN, 1},
334 {"||", BINOP_LOGICAL_OR, PREC_LOGICAL_OR, 0},
335 {"&&", BINOP_LOGICAL_AND, PREC_LOGICAL_AND, 0},
336 {"|", BINOP_BITWISE_IOR, PREC_BITWISE_IOR, 0},
337 {"^", BINOP_BITWISE_XOR, PREC_BITWISE_XOR, 0},
338 {"&", BINOP_BITWISE_AND, PREC_BITWISE_AND, 0},
339 {"==", BINOP_EQUAL, PREC_EQUAL, 0},
340 {"!=", BINOP_NOTEQUAL, PREC_EQUAL, 0},
341 {"<=", BINOP_LEQ, PREC_ORDER, 0},
342 {">=", BINOP_GEQ, PREC_ORDER, 0},
343 {">", BINOP_GTR, PREC_ORDER, 0},
344 {"<", BINOP_LESS, PREC_ORDER, 0},
345 {">>", BINOP_RSH, PREC_SHIFT, 0},
346 {"<<", BINOP_LSH, PREC_SHIFT, 0},
347 {"+", BINOP_ADD, PREC_ADD, 0},
348 {"-", BINOP_SUB, PREC_ADD, 0},
349 {"*", BINOP_MUL, PREC_MUL, 0},
350 {"/", BINOP_DIV, PREC_MUL, 0},
351 {"%", BINOP_REM, PREC_MUL, 0},
352 {"@", BINOP_REPEAT, PREC_REPEAT, 0},
353 {"-", UNOP_NEG, PREC_PREFIX, 0},
354 {"!", UNOP_LOGICAL_NOT, PREC_PREFIX, 0},
355 {"~", UNOP_COMPLEMENT, PREC_PREFIX, 0},
356 {"*", UNOP_IND, PREC_PREFIX, 0},
357 {"&", UNOP_ADDR, PREC_PREFIX, 0},
358 {"sizeof ", UNOP_SIZEOF, PREC_PREFIX, 0},
359 {"++", UNOP_PREINCREMENT, PREC_PREFIX, 0},
360 {"--", UNOP_PREDECREMENT, PREC_PREFIX, 0},
361 {NULL, OP_NULL, PREC_NULL, 0}
364 static const char *objc_extensions[] =
369 extern const struct language_defn objc_language_defn = {
370 "objective-c", /* Language name */
378 &exp_descriptor_standard,
382 c_printchar, /* Print a character constant */
383 c_printstr, /* Function to print string constant */
385 c_print_type, /* Print a type using appropriate syntax */
386 c_print_typedef, /* Print a typedef using appropriate syntax */
387 c_val_print, /* Print a value using appropriate syntax */
388 c_value_print, /* Print a top-level value */
389 default_read_var_value, /* la_read_var_value */
390 objc_skip_trampoline, /* Language specific skip_trampoline */
391 "self", /* name_of_this */
392 basic_lookup_symbol_nonlocal, /* lookup_symbol_nonlocal */
393 basic_lookup_transparent_type,/* lookup_transparent_type */
394 objc_demangle, /* Language specific symbol demangler */
395 objc_sniff_from_mangled_name,
396 NULL, /* Language specific
397 class_name_from_physname */
398 objc_op_print_tab, /* Expression operators for printing */
399 1, /* C-style arrays */
400 0, /* String lower bound */
401 default_word_break_characters,
402 default_collect_symbol_completion_matches,
403 c_language_arch_info,
404 default_print_array_index,
405 default_pass_by_reference,
407 c_watch_location_expression,
408 NULL, /* la_get_symbol_name_matcher */
409 iterate_over_symbols,
410 default_search_name_hash,
419 * Following functions help construct Objective-C message calls.
422 struct selname /* For parsing Objective-C. */
424 struct selname *next;
429 static int msglist_len;
430 static struct selname *selname_chain;
431 static char *msglist_sel;
436 struct selname *newobj = XNEW (struct selname);
438 newobj->next = selname_chain;
439 newobj->msglist_len = msglist_len;
440 newobj->msglist_sel = msglist_sel;
442 msglist_sel = (char *)xmalloc(1);
444 selname_chain = newobj;
448 add_msglist(struct stoken *str, int addcolon)
454 if (str == 0) /* Unnamed arg, or... */
456 if (addcolon == 0) /* variable number of args. */
469 len = plen + strlen(msglist_sel) + 2;
470 s = (char *)xmalloc(len);
471 strcpy(s, msglist_sel);
486 end_msglist (struct parser_state *ps)
488 int val = msglist_len;
489 struct selname *sel = selname_chain;
490 char *p = msglist_sel;
493 selname_chain = sel->next;
494 msglist_len = sel->msglist_len;
495 msglist_sel = sel->msglist_sel;
496 selid = lookup_child_selector (parse_gdbarch (ps), p);
498 error (_("Can't find selector \"%s\""), p);
499 write_exp_elt_longcst (ps, selid);
501 write_exp_elt_longcst (ps, val); /* Number of args */
508 * Function: specialcmp (const char *a, const char *b)
510 * Special strcmp: treats ']' and ' ' as end-of-string.
511 * Used for qsorting lists of objc methods (either by class or selector).
515 specialcmp (const char *a, const char *b)
517 while (*a && *a != ' ' && *a != ']' && *b && *b != ' ' && *b != ']')
523 if (*a && *a != ' ' && *a != ']')
524 return 1; /* a is longer therefore greater. */
525 if (*b && *b != ' ' && *b != ']')
526 return -1; /* a is shorter therefore lesser. */
527 return 0; /* a and b are identical. */
531 * Function: compare_selectors (const void *, const void *)
533 * Comparison function for use with qsort. Arguments are symbols or
534 * msymbols Compares selector part of objc method name alphabetically.
538 compare_selectors (const void *a, const void *b)
540 const char *aname, *bname;
542 aname = SYMBOL_PRINT_NAME (*(struct symbol **) a);
543 bname = SYMBOL_PRINT_NAME (*(struct symbol **) b);
544 if (aname == NULL || bname == NULL)
545 error (_("internal: compare_selectors(1)"));
547 aname = strchr(aname, ' ');
548 bname = strchr(bname, ' ');
549 if (aname == NULL || bname == NULL)
550 error (_("internal: compare_selectors(2)"));
552 return specialcmp (aname+1, bname+1);
556 * Function: selectors_info (regexp, from_tty)
558 * Implements the "Info selectors" command. Takes an optional regexp
559 * arg. Lists all objective c selectors that match the regexp. Works
560 * by grepping thru all symbols for objective c methods. Output list
561 * is sorted and uniqued.
565 info_selectors_command (const char *regexp, int from_tty)
567 struct objfile *objfile;
568 struct minimal_symbol *msymbol;
576 struct symbol **sym_arr;
580 strcpy(myregexp, ".*]"); /* Null input, match all objc methods. */
583 if (*regexp == '+' || *regexp == '-')
584 { /* User wants only class methods or only instance methods. */
585 plusminus = *regexp++;
586 while (*regexp == ' ' || *regexp == '\t')
590 strcpy(myregexp, ".*]");
593 /* Allow a few extra bytes because of the strcat below. */
594 if (sizeof (myregexp) < strlen (regexp) + 4)
595 error (_("Regexp is too long: %s"), regexp);
596 strcpy(myregexp, regexp);
597 if (myregexp[strlen(myregexp) - 1] == '$') /* end of selector */
598 myregexp[strlen(myregexp) - 1] = ']'; /* end of method name */
600 strcat(myregexp, ".*]");
606 val = re_comp (myregexp);
608 error (_("Invalid regexp (%s): %s"), val, regexp);
611 /* First time thru is JUST to get max length and count. */
612 ALL_MSYMBOLS (objfile, msymbol)
615 name = MSYMBOL_NATURAL_NAME (msymbol);
617 && (name[0] == '-' || name[0] == '+')
618 && name[1] == '[') /* Got a method name. */
620 /* Filter for class/instance methods. */
621 if (plusminus && name[0] != plusminus)
623 /* Find selector part. */
624 name = (char *) strchr (name+2, ' ');
627 complaint (&symfile_complaints,
628 _("Bad method name '%s'"),
629 MSYMBOL_NATURAL_NAME (msymbol));
632 if (regexp == NULL || re_exec(++name) != 0)
634 const char *mystart = name;
635 const char *myend = strchr (mystart, ']');
637 if (myend && (myend - mystart > maxlen))
638 maxlen = myend - mystart; /* Get longest selector. */
645 printf_filtered (_("Selectors matching \"%s\":\n\n"),
646 regexp ? regexp : "*");
648 sym_arr = XALLOCAVEC (struct symbol *, matches);
650 ALL_MSYMBOLS (objfile, msymbol)
653 name = MSYMBOL_NATURAL_NAME (msymbol);
655 (name[0] == '-' || name[0] == '+') &&
656 name[1] == '[') /* Got a method name. */
658 /* Filter for class/instance methods. */
659 if (plusminus && name[0] != plusminus)
661 /* Find selector part. */
662 name = (char *) strchr(name+2, ' ');
663 if (regexp == NULL || re_exec(++name) != 0)
664 sym_arr[matches++] = (struct symbol *) msymbol;
668 qsort (sym_arr, matches, sizeof (struct minimal_symbol *),
670 /* Prevent compare on first iteration. */
672 for (ix = 0; ix < matches; ix++) /* Now do the output. */
677 name = SYMBOL_NATURAL_NAME (sym_arr[ix]);
678 name = strchr (name, ' ') + 1;
679 if (p[0] && specialcmp(name, p) == 0)
680 continue; /* Seen this one already (not unique). */
682 /* Copy selector part. */
683 while (*name && *name != ']')
686 /* Print in columns. */
687 puts_filtered_tabular(asel, maxlen + 1, 0);
692 printf_filtered (_("No selectors matching \"%s\"\n"),
693 regexp ? regexp : "*");
697 * Function: compare_classes (const void *, const void *)
699 * Comparison function for use with qsort. Arguments are symbols or
700 * msymbols Compares class part of objc method name alphabetically.
704 compare_classes (const void *a, const void *b)
706 const char *aname, *bname;
708 aname = SYMBOL_PRINT_NAME (*(struct symbol **) a);
709 bname = SYMBOL_PRINT_NAME (*(struct symbol **) b);
710 if (aname == NULL || bname == NULL)
711 error (_("internal: compare_classes(1)"));
713 return specialcmp (aname+1, bname+1);
717 * Function: classes_info(regexp, from_tty)
719 * Implements the "info classes" command for objective c classes.
720 * Lists all objective c classes that match the optional regexp.
721 * Works by grepping thru the list of objective c methods. List will
722 * be sorted and uniqued (since one class may have many methods).
723 * BUGS: will not list a class that has no methods.
727 info_classes_command (const char *regexp, int from_tty)
729 struct objfile *objfile;
730 struct minimal_symbol *msymbol;
738 struct symbol **sym_arr;
741 strcpy(myregexp, ".* "); /* Null input: match all objc classes. */
744 /* Allow a few extra bytes because of the strcat below. */
745 if (sizeof (myregexp) < strlen (regexp) + 4)
746 error (_("Regexp is too long: %s"), regexp);
747 strcpy(myregexp, regexp);
748 if (myregexp[strlen(myregexp) - 1] == '$')
749 /* In the method name, the end of the class name is marked by ' '. */
750 myregexp[strlen(myregexp) - 1] = ' ';
752 strcat(myregexp, ".* ");
757 val = re_comp (myregexp);
759 error (_("Invalid regexp (%s): %s"), val, regexp);
762 /* First time thru is JUST to get max length and count. */
763 ALL_MSYMBOLS (objfile, msymbol)
766 name = MSYMBOL_NATURAL_NAME (msymbol);
768 (name[0] == '-' || name[0] == '+') &&
769 name[1] == '[') /* Got a method name. */
770 if (regexp == NULL || re_exec(name+2) != 0)
772 /* Compute length of classname part. */
773 const char *mystart = name + 2;
774 const char *myend = strchr (mystart, ' ');
776 if (myend && (myend - mystart > maxlen))
777 maxlen = myend - mystart;
783 printf_filtered (_("Classes matching \"%s\":\n\n"),
784 regexp ? regexp : "*");
785 sym_arr = XALLOCAVEC (struct symbol *, matches);
787 ALL_MSYMBOLS (objfile, msymbol)
790 name = MSYMBOL_NATURAL_NAME (msymbol);
792 (name[0] == '-' || name[0] == '+') &&
793 name[1] == '[') /* Got a method name. */
794 if (regexp == NULL || re_exec(name+2) != 0)
795 sym_arr[matches++] = (struct symbol *) msymbol;
798 qsort (sym_arr, matches, sizeof (struct minimal_symbol *),
800 /* Prevent compare on first iteration. */
802 for (ix = 0; ix < matches; ix++) /* Now do the output. */
807 name = SYMBOL_NATURAL_NAME (sym_arr[ix]);
809 if (p[0] && specialcmp(name, p) == 0)
810 continue; /* Seen this one already (not unique). */
812 /* Copy class part of method name. */
813 while (*name && *name != ' ')
816 /* Print in columns. */
817 puts_filtered_tabular(aclass, maxlen + 1, 0);
822 printf_filtered (_("No classes matching \"%s\"\n"), regexp ? regexp : "*");
826 parse_selector (char *method, char **selector)
832 char *nselector = NULL;
834 gdb_assert (selector != NULL);
838 s1 = skip_spaces (s1);
844 s1 = skip_spaces (s1);
851 if (isalnum (*s2) || (*s2 == '_') || (*s2 == ':'))
853 else if (isspace (*s2))
855 else if ((*s2 == '\0') || (*s2 == '\''))
863 s2 = skip_spaces (s2);
868 s2 = skip_spaces (s2);
871 if (selector != NULL)
872 *selector = nselector;
878 parse_method (char *method, char *type, char **theclass,
879 char **category, char **selector)
887 char *ncategory = NULL;
888 char *nselector = NULL;
890 gdb_assert (type != NULL);
891 gdb_assert (theclass != NULL);
892 gdb_assert (category != NULL);
893 gdb_assert (selector != NULL);
897 s1 = skip_spaces (s1);
903 s1 = skip_spaces (s1);
905 if ((s1[0] == '+') || (s1[0] == '-'))
908 s1 = skip_spaces (s1);
915 while (isalnum (*s1) || (*s1 == '_'))
919 s2 = skip_spaces (s2);
924 s2 = skip_spaces (s2);
926 while (isalnum (*s2) || (*s2 == '_'))
931 /* Truncate the class name now that we're not using the open paren. */
939 if (isalnum (*s2) || (*s2 == '_') || (*s2 == ':'))
941 else if (isspace (*s2))
952 s2 = skip_spaces (s2);
958 s2 = skip_spaces (s2);
963 if (theclass != NULL)
965 if (category != NULL)
966 *category = ncategory;
967 if (selector != NULL)
968 *selector = nselector;
974 find_methods (char type, const char *theclass, const char *category,
975 const char *selector,
976 VEC (const_char_ptr) **symbol_names)
978 struct objfile *objfile = NULL;
980 const char *symname = NULL;
984 char *ncategory = NULL;
985 char *nselector = NULL;
987 static char *tmp = NULL;
988 static unsigned int tmplen = 0;
990 gdb_assert (symbol_names != NULL);
992 ALL_OBJFILES (objfile)
994 unsigned int *objc_csym;
995 struct minimal_symbol *msymbol = NULL;
997 /* The objfile_csym variable counts the number of ObjC methods
998 that this objfile defines. We save that count as a private
999 objfile data. If we have already determined that this objfile
1000 provides no ObjC methods, we can skip it entirely. */
1002 unsigned int objfile_csym = 0;
1004 objc_csym = (unsigned int *) objfile_data (objfile, objc_objfile_data);
1005 if (objc_csym != NULL && *objc_csym == 0)
1006 /* There are no ObjC symbols in this objfile. Skip it entirely. */
1009 ALL_OBJFILE_MSYMBOLS (objfile, msymbol)
1013 /* Check the symbol name first as this can be done entirely without
1014 sending any query to the target. */
1015 symname = MSYMBOL_NATURAL_NAME (msymbol);
1016 if (symname == NULL)
1019 if ((symname[0] != '-' && symname[0] != '+') || (symname[1] != '['))
1020 /* Not a method name. */
1025 /* Now that thinks are a bit sane, clean up the symname. */
1026 while ((strlen (symname) + 1) >= tmplen)
1028 tmplen = (tmplen == 0) ? 1024 : tmplen * 2;
1029 tmp = (char *) xrealloc (tmp, tmplen);
1031 strcpy (tmp, symname);
1033 if (parse_method (tmp, &ntype, &nclass,
1034 &ncategory, &nselector) == NULL)
1037 if ((type != '\0') && (ntype != type))
1040 if ((theclass != NULL)
1041 && ((nclass == NULL) || (strcmp (theclass, nclass) != 0)))
1044 if ((category != NULL) &&
1045 ((ncategory == NULL) || (strcmp (category, ncategory) != 0)))
1048 if ((selector != NULL) &&
1049 ((nselector == NULL) || (strcmp (selector, nselector) != 0)))
1052 VEC_safe_push (const_char_ptr, *symbol_names, symname);
1055 if (objc_csym == NULL)
1057 objc_csym = XOBNEW (&objfile->objfile_obstack, unsigned int);
1058 *objc_csym = objfile_csym;
1059 set_objfile_data (objfile, objc_objfile_data, objc_csym);
1062 /* Count of ObjC methods in this objfile should be constant. */
1063 gdb_assert (*objc_csym == objfile_csym);
1067 /* Uniquify a VEC of strings. */
1070 uniquify_strings (VEC (const_char_ptr) **strings)
1073 const char *elem, *last = NULL;
1076 /* If the vector is empty, there's nothing to do. This explicit
1077 check is needed to avoid invoking qsort with NULL. */
1078 if (VEC_empty (const_char_ptr, *strings))
1081 qsort (VEC_address (const_char_ptr, *strings),
1082 VEC_length (const_char_ptr, *strings),
1083 sizeof (const_char_ptr),
1086 for (ix = 0; VEC_iterate (const_char_ptr, *strings, ix, elem); ++ix)
1088 if (last == NULL || strcmp (last, elem) != 0)
1091 VEC_replace (const_char_ptr, *strings, out, elem);
1096 VEC_truncate (const_char_ptr, *strings, out);
1100 * Function: find_imps (const char *selector, struct symbol **sym_arr)
1102 * Input: a string representing a selector
1103 * a pointer to an array of symbol pointers
1104 * possibly a pointer to a symbol found by the caller.
1106 * Output: number of methods that implement that selector. Side
1107 * effects: The array of symbol pointers is filled with matching syms.
1109 * By analogy with function "find_methods" (symtab.c), builds a list
1110 * of symbols matching the ambiguous input, so that "decode_line_2"
1111 * (symtab.c) can list them and ask the user to choose one or more.
1112 * In this case the matches are objective c methods
1113 * ("implementations") matching an objective c selector.
1115 * Note that it is possible for a normal (c-style) function to have
1116 * the same name as an objective c selector. To prevent the selector
1117 * from eclipsing the function, we allow the caller (decode_line_1) to
1118 * search for such a function first, and if it finds one, pass it in
1119 * to us. We will then integrate it into the list. We also search
1120 * for one here, among the minsyms.
1122 * NOTE: if NUM_DEBUGGABLE is non-zero, the sym_arr will be divided
1123 * into two parts: debuggable (struct symbol) syms, and
1124 * non_debuggable (struct minimal_symbol) syms. The debuggable
1125 * ones will come first, before NUM_DEBUGGABLE (which will thus
1126 * be the index of the first non-debuggable one).
1130 find_imps (const char *method, VEC (const_char_ptr) **symbol_names)
1133 char *theclass = NULL;
1134 char *category = NULL;
1135 char *selector = NULL;
1140 int selector_case = 0;
1142 gdb_assert (symbol_names != NULL);
1144 buf = (char *) alloca (strlen (method) + 1);
1145 strcpy (buf, method);
1146 tmp = parse_method (buf, &type, &theclass, &category, &selector);
1150 strcpy (buf, method);
1151 tmp = parse_selector (buf, &selector);
1159 find_methods (type, theclass, category, selector, symbol_names);
1161 /* If we hit the "selector" case, and we found some methods, then
1162 add the selector itself as a symbol, if it exists. */
1163 if (selector_case && !VEC_empty (const_char_ptr, *symbol_names))
1165 struct symbol *sym = lookup_symbol (selector, NULL, VAR_DOMAIN,
1169 VEC_safe_push (const_char_ptr, *symbol_names,
1170 SYMBOL_NATURAL_NAME (sym));
1173 struct bound_minimal_symbol msym
1174 = lookup_minimal_symbol (selector, 0, 0);
1176 if (msym.minsym != NULL)
1177 VEC_safe_push (const_char_ptr, *symbol_names,
1178 MSYMBOL_NATURAL_NAME (msym.minsym));
1182 uniquify_strings (symbol_names);
1184 return method + (tmp - buf);
1188 print_object_command (const char *args, int from_tty)
1190 struct value *object, *function, *description;
1191 CORE_ADDR string_addr, object_addr;
1195 if (!args || !*args)
1197 "The 'print-object' command requires an argument (an Objective-C object)");
1200 expression_up expr = parse_expression (args);
1203 object = evaluate_subexp (builtin_type (expr->gdbarch)->builtin_data_ptr,
1204 expr.get (), &pc, EVAL_NORMAL);
1207 /* Validate the address for sanity. */
1208 object_addr = value_as_long (object);
1209 read_memory (object_addr, &c, 1);
1211 function = find_function_in_inferior ("_NSPrintForDebugger", NULL);
1212 if (function == NULL)
1213 error (_("Unable to locate _NSPrintForDebugger in child process"));
1215 description = call_function_by_hand (function, NULL, 1, &object);
1217 string_addr = value_as_long (description);
1218 if (string_addr == 0)
1219 error (_("object returns null description"));
1221 read_memory (string_addr + i++, &c, 1);
1224 { /* Read and print characters up to EOS. */
1226 printf_filtered ("%c", c);
1227 read_memory (string_addr + i++, &c, 1);
1230 printf_filtered(_("<object returns empty description>"));
1231 printf_filtered ("\n");
1234 /* The data structure 'methcalls' is used to detect method calls (thru
1235 * ObjC runtime lib functions objc_msgSend, objc_msgSendSuper, etc.),
1236 * and ultimately find the method being called.
1239 struct objc_methcall {
1241 /* Return instance method to be called. */
1242 int (*stop_at) (CORE_ADDR, CORE_ADDR *);
1243 /* Start of pc range corresponding to method invocation. */
1245 /* End of pc range corresponding to method invocation. */
1249 static int resolve_msgsend (CORE_ADDR pc, CORE_ADDR *new_pc);
1250 static int resolve_msgsend_stret (CORE_ADDR pc, CORE_ADDR *new_pc);
1251 static int resolve_msgsend_super (CORE_ADDR pc, CORE_ADDR *new_pc);
1252 static int resolve_msgsend_super_stret (CORE_ADDR pc, CORE_ADDR *new_pc);
1254 static struct objc_methcall methcalls[] = {
1255 { "_objc_msgSend", resolve_msgsend, 0, 0},
1256 { "_objc_msgSend_stret", resolve_msgsend_stret, 0, 0},
1257 { "_objc_msgSendSuper", resolve_msgsend_super, 0, 0},
1258 { "_objc_msgSendSuper_stret", resolve_msgsend_super_stret, 0, 0},
1259 { "_objc_getClass", NULL, 0, 0},
1260 { "_objc_getMetaClass", NULL, 0, 0}
1263 #define nmethcalls (sizeof (methcalls) / sizeof (methcalls[0]))
1265 /* The following function, "find_objc_msgsend", fills in the data
1266 * structure "objc_msgs" by finding the addresses of each of the
1267 * (currently four) functions that it holds (of which objc_msgSend is
1268 * the first). This must be called each time symbols are loaded, in
1269 * case the functions have moved for some reason.
1273 find_objc_msgsend (void)
1277 for (i = 0; i < nmethcalls; i++)
1279 struct bound_minimal_symbol func;
1281 /* Try both with and without underscore. */
1282 func = lookup_bound_minimal_symbol (methcalls[i].name);
1283 if ((func.minsym == NULL) && (methcalls[i].name[0] == '_'))
1285 func = lookup_bound_minimal_symbol (methcalls[i].name + 1);
1287 if (func.minsym == NULL)
1289 methcalls[i].begin = 0;
1290 methcalls[i].end = 0;
1294 methcalls[i].begin = BMSYMBOL_VALUE_ADDRESS (func);
1295 methcalls[i].end = minimal_symbol_upper_bound (func);
1299 /* find_objc_msgcall (replaces pc_off_limits)
1301 * ALL that this function now does is to determine whether the input
1302 * address ("pc") is the address of one of the Objective-C message
1303 * dispatch functions (mainly objc_msgSend or objc_msgSendSuper), and
1304 * if so, it returns the address of the method that will be called.
1306 * The old function "pc_off_limits" used to do a lot of other things
1307 * in addition, such as detecting shared library jump stubs and
1308 * returning the address of the shlib function that would be called.
1309 * That functionality has been moved into the gdbarch_skip_trampoline_code and
1310 * IN_SOLIB_TRAMPOLINE macros, which are resolved in the target-
1311 * dependent modules.
1315 find_objc_msgcall_submethod (int (*f) (CORE_ADDR, CORE_ADDR *),
1321 if (f (pc, new_pc) == 0)
1324 CATCH (ex, RETURN_MASK_ALL)
1326 exception_fprintf (gdb_stderr, ex,
1327 "Unable to determine target of "
1328 "Objective-C method call (ignoring):\n");
1336 find_objc_msgcall (CORE_ADDR pc, CORE_ADDR *new_pc)
1340 find_objc_msgsend ();
1346 for (i = 0; i < nmethcalls; i++)
1347 if ((pc >= methcalls[i].begin) && (pc < methcalls[i].end))
1349 if (methcalls[i].stop_at != NULL)
1350 return find_objc_msgcall_submethod (methcalls[i].stop_at,
1360 _initialize_objc_language (void)
1362 add_info ("selectors", info_selectors_command,
1363 _("All Objective-C selectors, or those matching REGEXP."));
1364 add_info ("classes", info_classes_command,
1365 _("All Objective-C classes, or those matching REGEXP."));
1366 add_com ("print-object", class_vars, print_object_command,
1367 _("Ask an Objective-C object to print itself."));
1368 add_com_alias ("po", "print-object", class_vars, 1);
1372 read_objc_method (struct gdbarch *gdbarch, CORE_ADDR addr,
1373 struct objc_method *method)
1375 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
1377 method->name = read_memory_unsigned_integer (addr + 0, 4, byte_order);
1378 method->types = read_memory_unsigned_integer (addr + 4, 4, byte_order);
1379 method->imp = read_memory_unsigned_integer (addr + 8, 4, byte_order);
1382 static unsigned long
1383 read_objc_methlist_nmethods (struct gdbarch *gdbarch, CORE_ADDR addr)
1385 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
1387 return read_memory_unsigned_integer (addr + 4, 4, byte_order);
1391 read_objc_methlist_method (struct gdbarch *gdbarch, CORE_ADDR addr,
1392 unsigned long num, struct objc_method *method)
1394 gdb_assert (num < read_objc_methlist_nmethods (gdbarch, addr));
1395 read_objc_method (gdbarch, addr + 8 + (12 * num), method);
1399 read_objc_object (struct gdbarch *gdbarch, CORE_ADDR addr,
1400 struct objc_object *object)
1402 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
1404 object->isa = read_memory_unsigned_integer (addr, 4, byte_order);
1408 read_objc_super (struct gdbarch *gdbarch, CORE_ADDR addr,
1409 struct objc_super *super)
1411 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
1413 super->receiver = read_memory_unsigned_integer (addr, 4, byte_order);
1414 super->theclass = read_memory_unsigned_integer (addr + 4, 4, byte_order);
1418 read_objc_class (struct gdbarch *gdbarch, CORE_ADDR addr,
1419 struct objc_class *theclass)
1421 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
1423 theclass->isa = read_memory_unsigned_integer (addr, 4, byte_order);
1424 theclass->super_class = read_memory_unsigned_integer (addr + 4, 4, byte_order);
1425 theclass->name = read_memory_unsigned_integer (addr + 8, 4, byte_order);
1426 theclass->version = read_memory_unsigned_integer (addr + 12, 4, byte_order);
1427 theclass->info = read_memory_unsigned_integer (addr + 16, 4, byte_order);
1428 theclass->instance_size = read_memory_unsigned_integer (addr + 18, 4,
1430 theclass->ivars = read_memory_unsigned_integer (addr + 24, 4, byte_order);
1431 theclass->methods = read_memory_unsigned_integer (addr + 28, 4, byte_order);
1432 theclass->cache = read_memory_unsigned_integer (addr + 32, 4, byte_order);
1433 theclass->protocols = read_memory_unsigned_integer (addr + 36, 4, byte_order);
1437 find_implementation_from_class (struct gdbarch *gdbarch,
1438 CORE_ADDR theclass, CORE_ADDR sel)
1440 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
1441 CORE_ADDR subclass = theclass;
1443 while (subclass != 0)
1446 struct objc_class class_str;
1447 unsigned mlistnum = 0;
1449 read_objc_class (gdbarch, subclass, &class_str);
1454 unsigned long nmethods;
1457 mlist = read_memory_unsigned_integer (class_str.methods +
1463 nmethods = read_objc_methlist_nmethods (gdbarch, mlist);
1465 for (i = 0; i < nmethods; i++)
1467 struct objc_method meth_str;
1469 read_objc_methlist_method (gdbarch, mlist, i, &meth_str);
1471 if (meth_str.name == sel)
1472 /* FIXME: hppa arch was doing a pointer dereference
1473 here. There needs to be a better way to do that. */
1474 return meth_str.imp;
1478 subclass = class_str.super_class;
1485 find_implementation (struct gdbarch *gdbarch,
1486 CORE_ADDR object, CORE_ADDR sel)
1488 struct objc_object ostr;
1492 read_objc_object (gdbarch, object, &ostr);
1496 return find_implementation_from_class (gdbarch, ostr.isa, sel);
1500 resolve_msgsend (CORE_ADDR pc, CORE_ADDR *new_pc)
1502 struct frame_info *frame = get_current_frame ();
1503 struct gdbarch *gdbarch = get_frame_arch (frame);
1504 struct type *ptr_type = builtin_type (gdbarch)->builtin_func_ptr;
1510 object = gdbarch_fetch_pointer_argument (gdbarch, frame, 0, ptr_type);
1511 sel = gdbarch_fetch_pointer_argument (gdbarch, frame, 1, ptr_type);
1513 res = find_implementation (gdbarch, object, sel);
1522 resolve_msgsend_stret (CORE_ADDR pc, CORE_ADDR *new_pc)
1524 struct frame_info *frame = get_current_frame ();
1525 struct gdbarch *gdbarch = get_frame_arch (frame);
1526 struct type *ptr_type = builtin_type (gdbarch)->builtin_func_ptr;
1532 object = gdbarch_fetch_pointer_argument (gdbarch, frame, 1, ptr_type);
1533 sel = gdbarch_fetch_pointer_argument (gdbarch, frame, 2, ptr_type);
1535 res = find_implementation (gdbarch, object, sel);
1544 resolve_msgsend_super (CORE_ADDR pc, CORE_ADDR *new_pc)
1546 struct frame_info *frame = get_current_frame ();
1547 struct gdbarch *gdbarch = get_frame_arch (frame);
1548 struct type *ptr_type = builtin_type (gdbarch)->builtin_func_ptr;
1550 struct objc_super sstr;
1556 super = gdbarch_fetch_pointer_argument (gdbarch, frame, 0, ptr_type);
1557 sel = gdbarch_fetch_pointer_argument (gdbarch, frame, 1, ptr_type);
1559 read_objc_super (gdbarch, super, &sstr);
1560 if (sstr.theclass == 0)
1563 res = find_implementation_from_class (gdbarch, sstr.theclass, sel);
1572 resolve_msgsend_super_stret (CORE_ADDR pc, CORE_ADDR *new_pc)
1574 struct frame_info *frame = get_current_frame ();
1575 struct gdbarch *gdbarch = get_frame_arch (frame);
1576 struct type *ptr_type = builtin_type (gdbarch)->builtin_func_ptr;
1578 struct objc_super sstr;
1584 super = gdbarch_fetch_pointer_argument (gdbarch, frame, 1, ptr_type);
1585 sel = gdbarch_fetch_pointer_argument (gdbarch, frame, 2, ptr_type);
1587 read_objc_super (gdbarch, super, &sstr);
1588 if (sstr.theclass == 0)
1591 res = find_implementation_from_class (gdbarch, sstr.theclass, sel);
1600 _initialize_objc_lang (void)
1602 objc_objfile_data = register_objfile_data ();