1 /* Objective-C language support routines for GDB, the GNU debugger.
3 Copyright (C) 2002, 2003, 2004, 2005, 2007, 2008, 2009
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 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
, 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 (char *classname
)
113 struct value
* function
, *classval
;
115 if (! target_has_execution
)
117 /* Can't call into inferior to lookup class. */
121 if (lookup_minimal_symbol("objc_lookUpClass", 0, 0))
122 function
= find_function_in_inferior("objc_lookUpClass", NULL
);
123 else if (lookup_minimal_symbol ("objc_lookup_class", 0, 0))
124 function
= find_function_in_inferior("objc_lookup_class", NULL
);
127 complaint (&symfile_complaints
, _("no way to lookup Objective-C classes"));
131 classval
= value_string (classname
, strlen (classname
) + 1);
132 classval
= value_coerce_array (classval
);
133 return (CORE_ADDR
) value_as_long (call_function_by_hand (function
,
138 lookup_child_selector (char *selname
)
140 struct value
* function
, *selstring
;
142 if (! target_has_execution
)
144 /* Can't call into inferior to lookup selector. */
148 if (lookup_minimal_symbol("sel_getUid", 0, 0))
149 function
= find_function_in_inferior("sel_getUid", NULL
);
150 else if (lookup_minimal_symbol ("sel_get_any_uid", 0, 0))
151 function
= find_function_in_inferior("sel_get_any_uid", NULL
);
154 complaint (&symfile_complaints
, _("no way to lookup Objective-C selectors"));
158 selstring
= value_coerce_array (value_string (selname
,
159 strlen (selname
) + 1));
160 return value_as_long (call_function_by_hand (function
, 1, &selstring
));
164 value_nsstring (char *ptr
, int len
)
166 struct value
*stringValue
[3];
167 struct value
*function
, *nsstringValue
;
170 struct objfile
*objf
;
171 struct gdbarch
*gdbarch
;
173 if (!target_has_execution
)
174 return 0; /* Can't call into inferior to create NSString. */
176 stringValue
[2] = value_string(ptr
, len
);
177 stringValue
[2] = value_coerce_array(stringValue
[2]);
178 /* _NSNewStringFromCString replaces "istr" after Lantern2A. */
179 if (lookup_minimal_symbol("_NSNewStringFromCString", 0, 0))
181 function
= find_function_in_inferior("_NSNewStringFromCString", &objf
);
182 nsstringValue
= call_function_by_hand(function
, 1, &stringValue
[2]);
184 else if (lookup_minimal_symbol("istr", 0, 0))
186 function
= find_function_in_inferior("istr", &objf
);
187 nsstringValue
= call_function_by_hand(function
, 1, &stringValue
[2]);
189 else if (lookup_minimal_symbol("+[NSString stringWithCString:]", 0, 0))
192 = find_function_in_inferior("+[NSString stringWithCString:]", &objf
);
193 type
= builtin_type (get_objfile_arch (objf
))->builtin_long
;
195 stringValue
[0] = value_from_longest
196 (type
, lookup_objc_class ("NSString"));
197 stringValue
[1] = value_from_longest
198 (type
, lookup_child_selector ("stringWithCString:"));
199 nsstringValue
= call_function_by_hand(function
, 3, &stringValue
[0]);
202 error (_("NSString: internal error -- no way to create new NSString"));
204 gdbarch
= get_objfile_arch (objf
);
206 sym
= lookup_struct_typedef("NSString", 0, 1);
208 sym
= lookup_struct_typedef("NXString", 0, 1);
210 type
= builtin_type (gdbarch
)->builtin_data_ptr
;
212 type
= lookup_pointer_type(SYMBOL_TYPE (sym
));
214 deprecated_set_value_type (nsstringValue
, type
);
215 return nsstringValue
;
218 /* Objective-C name demangling. */
221 objc_demangle (const char *mangled
, int options
)
223 char *demangled
, *cp
;
225 if (mangled
[0] == '_' &&
226 (mangled
[1] == 'i' || mangled
[1] == 'c') &&
229 cp
= demangled
= xmalloc(strlen(mangled
) + 2);
231 if (mangled
[1] == 'i')
232 *cp
++ = '-'; /* for instance method */
234 *cp
++ = '+'; /* for class method */
236 *cp
++ = '['; /* opening left brace */
237 strcpy(cp
, mangled
+3); /* tack on the rest of the mangled name */
239 while (*cp
&& *cp
== '_')
240 cp
++; /* skip any initial underbars in class name */
242 cp
= strchr(cp
, '_');
243 if (!cp
) /* find first non-initial underbar */
245 xfree(demangled
); /* not mangled name */
248 if (cp
[1] == '_') { /* easy case: no category name */
249 *cp
++ = ' '; /* replace two '_' with one ' ' */
250 strcpy(cp
, mangled
+ (cp
- demangled
) + 2);
253 *cp
++ = '('; /* less easy case: category name */
254 cp
= strchr(cp
, '_');
257 xfree(demangled
); /* not mangled name */
261 *cp
++ = ' '; /* overwriting 1st char of method name... */
262 strcpy(cp
, mangled
+ (cp
- demangled
)); /* get it back */
265 while (*cp
&& *cp
== '_')
266 cp
++; /* skip any initial underbars in method name */
270 *cp
= ':'; /* replace remaining '_' with ':' */
272 *cp
++ = ']'; /* closing right brace */
273 *cp
++ = 0; /* string terminator */
277 return NULL
; /* Not an objc mangled name. */
280 /* Print the character C on STREAM as part of the contents of a
281 literal string whose delimiter is QUOTER. Note that that format
282 for printing characters and strings is language specific. */
285 objc_emit_char (int c
, struct type
*type
, struct ui_file
*stream
, int quoter
)
288 c
&= 0xFF; /* Avoid sign bit follies. */
290 if (PRINT_LITERAL_FORM (c
))
292 if (c
== '\\' || c
== quoter
)
294 fputs_filtered ("\\", stream
);
296 fprintf_filtered (stream
, "%c", c
);
303 fputs_filtered ("\\n", stream
);
306 fputs_filtered ("\\b", stream
);
309 fputs_filtered ("\\t", stream
);
312 fputs_filtered ("\\f", stream
);
315 fputs_filtered ("\\r", stream
);
318 fputs_filtered ("\\e", stream
);
321 fputs_filtered ("\\a", stream
);
324 fprintf_filtered (stream
, "\\%.3o", (unsigned int) c
);
331 objc_printchar (int c
, struct type
*type
, struct ui_file
*stream
)
333 fputs_filtered ("'", stream
);
334 objc_emit_char (c
, type
, stream
, '\'');
335 fputs_filtered ("'", stream
);
338 /* Print the character string STRING, printing at most LENGTH
339 characters. Printing stops early if the number hits print_max;
340 repeat counts are printed as appropriate. Print ellipses at the
341 end if we had to stop before printing LENGTH characters, or if
345 objc_printstr (struct ui_file
*stream
, struct type
*type
,
346 const gdb_byte
*string
, unsigned int length
,
348 const struct value_print_options
*options
)
351 unsigned int things_printed
= 0;
354 int width
= TYPE_LENGTH (type
);
356 /* If the string was not truncated due to `set print elements', and
357 the last byte of it is a null, we don't print that, in
358 traditional C style. */
359 if ((!force_ellipses
) && length
> 0 && string
[length
-1] == '\0')
364 fputs_filtered ("\"\"", stream
);
368 for (i
= 0; i
< length
&& things_printed
< options
->print_max
; ++i
)
370 /* Position of the character we are examining to see whether it
373 /* Number of repetitions we have detected so far. */
380 fputs_filtered (", ", stream
);
386 while (rep1
< length
&& string
[rep1
] == string
[i
])
392 if (reps
> options
->repeat_count_threshold
)
396 if (options
->inspect_it
)
397 fputs_filtered ("\\\", ", stream
);
399 fputs_filtered ("\", ", stream
);
402 objc_printchar (string
[i
], type
, stream
);
403 fprintf_filtered (stream
, " <repeats %u times>", reps
);
405 things_printed
+= options
->repeat_count_threshold
;
412 if (options
->inspect_it
)
413 fputs_filtered ("\\\"", stream
);
415 fputs_filtered ("\"", stream
);
418 objc_emit_char (string
[i
], type
, stream
, '"');
423 /* Terminate the quotes if necessary. */
426 if (options
->inspect_it
)
427 fputs_filtered ("\\\"", stream
);
429 fputs_filtered ("\"", stream
);
432 if (force_ellipses
|| i
< length
)
433 fputs_filtered ("...", stream
);
436 /* Determine if we are currently in the Objective-C dispatch function.
437 If so, get the address of the method function that the dispatcher
438 would call and use that as the function to step into instead. Also
439 skip over the trampoline for the function (if any). This is better
440 for the user since they are only interested in stepping into the
441 method function anyway. */
443 objc_skip_trampoline (struct frame_info
*frame
, CORE_ADDR stop_pc
)
445 CORE_ADDR real_stop_pc
;
446 CORE_ADDR method_stop_pc
;
448 real_stop_pc
= gdbarch_skip_trampoline_code
449 (current_gdbarch
, frame
, stop_pc
);
451 if (real_stop_pc
!= 0)
452 find_objc_msgcall (real_stop_pc
, &method_stop_pc
);
454 find_objc_msgcall (stop_pc
, &method_stop_pc
);
458 real_stop_pc
= gdbarch_skip_trampoline_code
459 (current_gdbarch
, frame
, method_stop_pc
);
460 if (real_stop_pc
== 0)
461 real_stop_pc
= method_stop_pc
;
468 /* Table mapping opcodes into strings for printing operators
469 and precedences of the operators. */
471 static const struct op_print objc_op_print_tab
[] =
473 {",", BINOP_COMMA
, PREC_COMMA
, 0},
474 {"=", BINOP_ASSIGN
, PREC_ASSIGN
, 1},
475 {"||", BINOP_LOGICAL_OR
, PREC_LOGICAL_OR
, 0},
476 {"&&", BINOP_LOGICAL_AND
, PREC_LOGICAL_AND
, 0},
477 {"|", BINOP_BITWISE_IOR
, PREC_BITWISE_IOR
, 0},
478 {"^", BINOP_BITWISE_XOR
, PREC_BITWISE_XOR
, 0},
479 {"&", BINOP_BITWISE_AND
, PREC_BITWISE_AND
, 0},
480 {"==", BINOP_EQUAL
, PREC_EQUAL
, 0},
481 {"!=", BINOP_NOTEQUAL
, PREC_EQUAL
, 0},
482 {"<=", BINOP_LEQ
, PREC_ORDER
, 0},
483 {">=", BINOP_GEQ
, PREC_ORDER
, 0},
484 {">", BINOP_GTR
, PREC_ORDER
, 0},
485 {"<", BINOP_LESS
, PREC_ORDER
, 0},
486 {">>", BINOP_RSH
, PREC_SHIFT
, 0},
487 {"<<", BINOP_LSH
, PREC_SHIFT
, 0},
488 {"+", BINOP_ADD
, PREC_ADD
, 0},
489 {"-", BINOP_SUB
, PREC_ADD
, 0},
490 {"*", BINOP_MUL
, PREC_MUL
, 0},
491 {"/", BINOP_DIV
, PREC_MUL
, 0},
492 {"%", BINOP_REM
, PREC_MUL
, 0},
493 {"@", BINOP_REPEAT
, PREC_REPEAT
, 0},
494 {"-", UNOP_NEG
, PREC_PREFIX
, 0},
495 {"!", UNOP_LOGICAL_NOT
, PREC_PREFIX
, 0},
496 {"~", UNOP_COMPLEMENT
, PREC_PREFIX
, 0},
497 {"*", UNOP_IND
, PREC_PREFIX
, 0},
498 {"&", UNOP_ADDR
, PREC_PREFIX
, 0},
499 {"sizeof ", UNOP_SIZEOF
, PREC_PREFIX
, 0},
500 {"++", UNOP_PREINCREMENT
, PREC_PREFIX
, 0},
501 {"--", UNOP_PREDECREMENT
, PREC_PREFIX
, 0},
502 {NULL
, OP_NULL
, PREC_NULL
, 0}
505 const struct language_defn objc_language_defn
= {
506 "objective-c", /* Language name */
513 &exp_descriptor_standard
,
517 objc_printchar
, /* Print a character constant */
518 objc_printstr
, /* Function to print string constant */
520 c_print_type
, /* Print a type using appropriate syntax */
521 c_print_typedef
, /* Print a typedef using appropriate syntax */
522 c_val_print
, /* Print a value using appropriate syntax */
523 c_value_print
, /* Print a top-level value */
524 objc_skip_trampoline
, /* Language specific skip_trampoline */
525 "self", /* name_of_this */
526 basic_lookup_symbol_nonlocal
, /* lookup_symbol_nonlocal */
527 basic_lookup_transparent_type
,/* lookup_transparent_type */
528 objc_demangle
, /* Language specific symbol demangler */
529 NULL
, /* Language specific class_name_from_physname */
530 objc_op_print_tab
, /* Expression operators for printing */
531 1, /* C-style arrays */
532 0, /* String lower bound */
533 default_word_break_characters
,
534 default_make_symbol_completion_list
,
535 c_language_arch_info
,
536 default_print_array_index
,
537 default_pass_by_reference
,
544 * Following functions help construct Objective-C message calls
547 struct selname
/* For parsing Objective-C. */
549 struct selname
*next
;
554 static int msglist_len
;
555 static struct selname
*selname_chain
;
556 static char *msglist_sel
;
561 struct selname
*new =
562 (struct selname
*) xmalloc (sizeof (struct selname
));
564 new->next
= selname_chain
;
565 new->msglist_len
= msglist_len
;
566 new->msglist_sel
= msglist_sel
;
568 msglist_sel
= (char *)xmalloc(1);
574 add_msglist(struct stoken
*str
, int addcolon
)
579 if (str
== 0) { /* Unnamed arg, or... */
580 if (addcolon
== 0) { /* variable number of args. */
590 len
= plen
+ strlen(msglist_sel
) + 2;
591 s
= (char *)xmalloc(len
);
592 strcpy(s
, msglist_sel
);
607 int val
= msglist_len
;
608 struct selname
*sel
= selname_chain
;
609 char *p
= msglist_sel
;
612 selname_chain
= sel
->next
;
613 msglist_len
= sel
->msglist_len
;
614 msglist_sel
= sel
->msglist_sel
;
615 selid
= lookup_child_selector(p
);
617 error (_("Can't find selector \"%s\""), p
);
618 write_exp_elt_longcst (selid
);
620 write_exp_elt_longcst (val
); /* Number of args */
627 * Function: specialcmp (char *a, char *b)
629 * Special strcmp: treats ']' and ' ' as end-of-string.
630 * Used for qsorting lists of objc methods (either by class or selector).
634 specialcmp (char *a
, char *b
)
636 while (*a
&& *a
!= ' ' && *a
!= ']' && *b
&& *b
!= ' ' && *b
!= ']')
642 if (*a
&& *a
!= ' ' && *a
!= ']')
643 return 1; /* a is longer therefore greater */
644 if (*b
&& *b
!= ' ' && *b
!= ']')
645 return -1; /* a is shorter therefore lesser */
646 return 0; /* a and b are identical */
650 * Function: compare_selectors (const void *, const void *)
652 * Comparison function for use with qsort. Arguments are symbols or
653 * msymbols Compares selector part of objc method name alphabetically.
657 compare_selectors (const void *a
, const void *b
)
661 aname
= SYMBOL_PRINT_NAME (*(struct symbol
**) a
);
662 bname
= SYMBOL_PRINT_NAME (*(struct symbol
**) b
);
663 if (aname
== NULL
|| bname
== NULL
)
664 error (_("internal: compare_selectors(1)"));
666 aname
= strchr(aname
, ' ');
667 bname
= strchr(bname
, ' ');
668 if (aname
== NULL
|| bname
== NULL
)
669 error (_("internal: compare_selectors(2)"));
671 return specialcmp (aname
+1, bname
+1);
675 * Function: selectors_info (regexp, from_tty)
677 * Implements the "Info selectors" command. Takes an optional regexp
678 * arg. Lists all objective c selectors that match the regexp. Works
679 * by grepping thru all symbols for objective c methods. Output list
680 * is sorted and uniqued.
684 selectors_info (char *regexp
, int from_tty
)
686 struct objfile
*objfile
;
687 struct minimal_symbol
*msymbol
;
695 struct symbol
**sym_arr
;
699 strcpy(myregexp
, ".*]"); /* Null input, match all objc methods. */
702 if (*regexp
== '+' || *regexp
== '-')
703 { /* User wants only class methods or only instance methods. */
704 plusminus
= *regexp
++;
705 while (*regexp
== ' ' || *regexp
== '\t')
709 strcpy(myregexp
, ".*]");
712 strcpy(myregexp
, regexp
);
713 if (myregexp
[strlen(myregexp
) - 1] == '$') /* end of selector */
714 myregexp
[strlen(myregexp
) - 1] = ']'; /* end of method name */
716 strcat(myregexp
, ".*]");
722 val
= re_comp (myregexp
);
724 error (_("Invalid regexp (%s): %s"), val
, regexp
);
727 /* First time thru is JUST to get max length and count. */
728 ALL_MSYMBOLS (objfile
, msymbol
)
731 name
= SYMBOL_NATURAL_NAME (msymbol
);
733 (name
[0] == '-' || name
[0] == '+') &&
734 name
[1] == '[') /* Got a method name. */
736 /* Filter for class/instance methods. */
737 if (plusminus
&& name
[0] != plusminus
)
739 /* Find selector part. */
740 name
= (char *) strchr(name
+2, ' ');
741 if (regexp
== NULL
|| re_exec(++name
) != 0)
743 char *mystart
= name
;
744 char *myend
= (char *) strchr(mystart
, ']');
746 if (myend
&& (myend
- mystart
> maxlen
))
747 maxlen
= myend
- mystart
; /* Get longest selector. */
754 printf_filtered (_("Selectors matching \"%s\":\n\n"),
755 regexp
? regexp
: "*");
757 sym_arr
= alloca (matches
* sizeof (struct symbol
*));
759 ALL_MSYMBOLS (objfile
, msymbol
)
762 name
= SYMBOL_NATURAL_NAME (msymbol
);
764 (name
[0] == '-' || name
[0] == '+') &&
765 name
[1] == '[') /* Got a method name. */
767 /* Filter for class/instance methods. */
768 if (plusminus
&& name
[0] != plusminus
)
770 /* Find selector part. */
771 name
= (char *) strchr(name
+2, ' ');
772 if (regexp
== NULL
|| re_exec(++name
) != 0)
773 sym_arr
[matches
++] = (struct symbol
*) msymbol
;
777 qsort (sym_arr
, matches
, sizeof (struct minimal_symbol
*),
779 /* Prevent compare on first iteration. */
781 for (ix
= 0; ix
< matches
; ix
++) /* Now do the output. */
786 name
= SYMBOL_NATURAL_NAME (sym_arr
[ix
]);
787 name
= strchr (name
, ' ') + 1;
788 if (p
[0] && specialcmp(name
, p
) == 0)
789 continue; /* Seen this one already (not unique). */
791 /* Copy selector part. */
792 while (*name
&& *name
!= ']')
795 /* Print in columns. */
796 puts_filtered_tabular(asel
, maxlen
+ 1, 0);
801 printf_filtered (_("No selectors matching \"%s\"\n"), regexp
? regexp
: "*");
805 * Function: compare_classes (const void *, const void *)
807 * Comparison function for use with qsort. Arguments are symbols or
808 * msymbols Compares class part of objc method name alphabetically.
812 compare_classes (const void *a
, const void *b
)
816 aname
= SYMBOL_PRINT_NAME (*(struct symbol
**) a
);
817 bname
= SYMBOL_PRINT_NAME (*(struct symbol
**) b
);
818 if (aname
== NULL
|| bname
== NULL
)
819 error (_("internal: compare_classes(1)"));
821 return specialcmp (aname
+1, bname
+1);
825 * Function: classes_info(regexp, from_tty)
827 * Implements the "info classes" command for objective c classes.
828 * Lists all objective c classes that match the optional regexp.
829 * Works by grepping thru the list of objective c methods. List will
830 * be sorted and uniqued (since one class may have many methods).
831 * BUGS: will not list a class that has no methods.
835 classes_info (char *regexp
, int from_tty
)
837 struct objfile
*objfile
;
838 struct minimal_symbol
*msymbol
;
846 struct symbol
**sym_arr
;
849 strcpy(myregexp
, ".* "); /* Null input: match all objc classes. */
852 strcpy(myregexp
, regexp
);
853 if (myregexp
[strlen(myregexp
) - 1] == '$')
854 /* In the method name, the end of the class name is marked by ' '. */
855 myregexp
[strlen(myregexp
) - 1] = ' ';
857 strcat(myregexp
, ".* ");
862 val
= re_comp (myregexp
);
864 error (_("Invalid regexp (%s): %s"), val
, regexp
);
867 /* First time thru is JUST to get max length and count. */
868 ALL_MSYMBOLS (objfile
, msymbol
)
871 name
= SYMBOL_NATURAL_NAME (msymbol
);
873 (name
[0] == '-' || name
[0] == '+') &&
874 name
[1] == '[') /* Got a method name. */
875 if (regexp
== NULL
|| re_exec(name
+2) != 0)
877 /* Compute length of classname part. */
878 char *mystart
= name
+ 2;
879 char *myend
= (char *) strchr(mystart
, ' ');
881 if (myend
&& (myend
- mystart
> maxlen
))
882 maxlen
= myend
- mystart
;
888 printf_filtered (_("Classes matching \"%s\":\n\n"),
889 regexp
? regexp
: "*");
890 sym_arr
= alloca (matches
* sizeof (struct symbol
*));
892 ALL_MSYMBOLS (objfile
, msymbol
)
895 name
= SYMBOL_NATURAL_NAME (msymbol
);
897 (name
[0] == '-' || name
[0] == '+') &&
898 name
[1] == '[') /* Got a method name. */
899 if (regexp
== NULL
|| re_exec(name
+2) != 0)
900 sym_arr
[matches
++] = (struct symbol
*) msymbol
;
903 qsort (sym_arr
, matches
, sizeof (struct minimal_symbol
*),
905 /* Prevent compare on first iteration. */
907 for (ix
= 0; ix
< matches
; ix
++) /* Now do the output. */
912 name
= SYMBOL_NATURAL_NAME (sym_arr
[ix
]);
914 if (p
[0] && specialcmp(name
, p
) == 0)
915 continue; /* Seen this one already (not unique). */
917 /* Copy class part of method name. */
918 while (*name
&& *name
!= ' ')
921 /* Print in columns. */
922 puts_filtered_tabular(aclass
, maxlen
+ 1, 0);
927 printf_filtered (_("No classes matching \"%s\"\n"), regexp
? regexp
: "*");
931 * Function: find_imps (char *selector, struct symbol **sym_arr)
933 * Input: a string representing a selector
934 * a pointer to an array of symbol pointers
935 * possibly a pointer to a symbol found by the caller.
937 * Output: number of methods that implement that selector. Side
938 * effects: The array of symbol pointers is filled with matching syms.
940 * By analogy with function "find_methods" (symtab.c), builds a list
941 * of symbols matching the ambiguous input, so that "decode_line_2"
942 * (symtab.c) can list them and ask the user to choose one or more.
943 * In this case the matches are objective c methods
944 * ("implementations") matching an objective c selector.
946 * Note that it is possible for a normal (c-style) function to have
947 * the same name as an objective c selector. To prevent the selector
948 * from eclipsing the function, we allow the caller (decode_line_1) to
949 * search for such a function first, and if it finds one, pass it in
950 * to us. We will then integrate it into the list. We also search
951 * for one here, among the minsyms.
953 * NOTE: if NUM_DEBUGGABLE is non-zero, the sym_arr will be divided
954 * into two parts: debuggable (struct symbol) syms, and
955 * non_debuggable (struct minimal_symbol) syms. The debuggable
956 * ones will come first, before NUM_DEBUGGABLE (which will thus
957 * be the index of the first non-debuggable one).
961 * Function: total_number_of_imps (char *selector);
963 * Input: a string representing a selector
964 * Output: number of methods that implement that selector.
966 * By analogy with function "total_number_of_methods", this allows
967 * decode_line_1 (symtab.c) to detect if there are objective c methods
968 * matching the input, and to allocate an array of pointers to them
969 * which can be manipulated by "decode_line_2" (also in symtab.c).
973 parse_selector (char *method
, char **selector
)
979 char *nselector
= NULL
;
981 gdb_assert (selector
!= NULL
);
985 while (isspace (*s1
))
992 while (isspace (*s1
))
999 if (isalnum (*s2
) || (*s2
== '_') || (*s2
== ':'))
1001 else if (isspace (*s2
))
1003 else if ((*s2
== '\0') || (*s2
== '\''))
1011 while (isspace (*s2
))
1017 while (isspace (*s2
))
1021 if (selector
!= NULL
)
1022 *selector
= nselector
;
1028 parse_method (char *method
, char *type
, char **class,
1029 char **category
, char **selector
)
1033 int found_quote
= 0;
1036 char *nclass
= NULL
;
1037 char *ncategory
= NULL
;
1038 char *nselector
= NULL
;
1040 gdb_assert (type
!= NULL
);
1041 gdb_assert (class != NULL
);
1042 gdb_assert (category
!= NULL
);
1043 gdb_assert (selector
!= NULL
);
1047 while (isspace (*s1
))
1054 while (isspace (*s1
))
1057 if ((s1
[0] == '+') || (s1
[0] == '-'))
1060 while (isspace (*s1
))
1068 while (isalnum (*s1
) || (*s1
== '_'))
1072 while (isspace (*s2
))
1078 while (isspace (*s2
))
1081 while (isalnum (*s2
) || (*s2
== '_'))
1086 /* Truncate the class name now that we're not using the open paren. */
1093 if (isalnum (*s2
) || (*s2
== '_') || (*s2
== ':'))
1095 else if (isspace (*s2
))
1097 else if (*s2
== ']')
1106 while (isspace (*s2
))
1113 while (isspace (*s2
))
1121 if (category
!= NULL
)
1122 *category
= ncategory
;
1123 if (selector
!= NULL
)
1124 *selector
= nselector
;
1130 find_methods (struct symtab
*symtab
, char type
,
1131 const char *class, const char *category
,
1132 const char *selector
, struct symbol
**syms
,
1133 unsigned int *nsym
, unsigned int *ndebug
)
1135 struct objfile
*objfile
= NULL
;
1136 struct minimal_symbol
*msymbol
= NULL
;
1137 struct block
*block
= NULL
;
1138 struct symbol
*sym
= NULL
;
1140 char *symname
= NULL
;
1143 char *nclass
= NULL
;
1144 char *ncategory
= NULL
;
1145 char *nselector
= NULL
;
1147 unsigned int csym
= 0;
1148 unsigned int cdebug
= 0;
1150 static char *tmp
= NULL
;
1151 static unsigned int tmplen
= 0;
1153 gdb_assert (nsym
!= NULL
);
1154 gdb_assert (ndebug
!= NULL
);
1157 block
= BLOCKVECTOR_BLOCK (BLOCKVECTOR (symtab
), STATIC_BLOCK
);
1159 ALL_OBJFILES (objfile
)
1161 unsigned int *objc_csym
;
1163 /* The objfile_csym variable counts the number of ObjC methods
1164 that this objfile defines. We save that count as a private
1165 objfile data. If we have already determined that this objfile
1166 provides no ObjC methods, we can skip it entirely. */
1168 unsigned int objfile_csym
= 0;
1170 objc_csym
= objfile_data (objfile
, objc_objfile_data
);
1171 if (objc_csym
!= NULL
&& *objc_csym
== 0)
1172 /* There are no ObjC symbols in this objfile. Skip it entirely. */
1175 ALL_OBJFILE_MSYMBOLS (objfile
, msymbol
)
1179 if ((MSYMBOL_TYPE (msymbol
) != mst_text
)
1180 && (MSYMBOL_TYPE (msymbol
) != mst_file_text
))
1181 /* Not a function or method. */
1185 if ((SYMBOL_VALUE_ADDRESS (msymbol
) < BLOCK_START (block
)) ||
1186 (SYMBOL_VALUE_ADDRESS (msymbol
) >= BLOCK_END (block
)))
1187 /* Not in the specified symtab. */
1190 symname
= SYMBOL_NATURAL_NAME (msymbol
);
1191 if (symname
== NULL
)
1194 if ((symname
[0] != '-' && symname
[0] != '+') || (symname
[1] != '['))
1195 /* Not a method name. */
1198 while ((strlen (symname
) + 1) >= tmplen
)
1200 tmplen
= (tmplen
== 0) ? 1024 : tmplen
* 2;
1201 tmp
= xrealloc (tmp
, tmplen
);
1203 strcpy (tmp
, symname
);
1205 if (parse_method (tmp
, &ntype
, &nclass
, &ncategory
, &nselector
) == NULL
)
1210 if ((type
!= '\0') && (ntype
!= type
))
1214 && ((nclass
== NULL
) || (strcmp (class, nclass
) != 0)))
1217 if ((category
!= NULL
) &&
1218 ((ncategory
== NULL
) || (strcmp (category
, ncategory
) != 0)))
1221 if ((selector
!= NULL
) &&
1222 ((nselector
== NULL
) || (strcmp (selector
, nselector
) != 0)))
1225 sym
= find_pc_function (SYMBOL_VALUE_ADDRESS (msymbol
));
1228 const char *newsymname
= SYMBOL_NATURAL_NAME (sym
);
1230 if (strcmp (symname
, newsymname
) == 0)
1232 /* Found a high-level method sym: swap it into the
1233 lower part of sym_arr (below num_debuggable). */
1236 syms
[csym
] = syms
[cdebug
];
1245 "debugging symbol \"%s\" does not match minimal symbol (\"%s\"); ignoring",
1246 newsymname
, symname
);
1248 syms
[csym
] = (struct symbol
*) msymbol
;
1254 /* Found a non-debuggable method symbol. */
1256 syms
[csym
] = (struct symbol
*) msymbol
;
1260 if (objc_csym
== NULL
)
1262 objc_csym
= xmalloc (sizeof (*objc_csym
));
1263 *objc_csym
= objfile_csym
;
1264 set_objfile_data (objfile
, objc_objfile_data
, objc_csym
);
1267 /* Count of ObjC methods in this objfile should be constant. */
1268 gdb_assert (*objc_csym
== objfile_csym
);
1277 char *find_imps (struct symtab
*symtab
, struct block
*block
,
1278 char *method
, struct symbol
**syms
,
1279 unsigned int *nsym
, unsigned int *ndebug
)
1283 char *category
= NULL
;
1284 char *selector
= NULL
;
1286 unsigned int csym
= 0;
1287 unsigned int cdebug
= 0;
1289 unsigned int ncsym
= 0;
1290 unsigned int ncdebug
= 0;
1295 gdb_assert (nsym
!= NULL
);
1296 gdb_assert (ndebug
!= NULL
);
1303 buf
= (char *) alloca (strlen (method
) + 1);
1304 strcpy (buf
, method
);
1305 tmp
= parse_method (buf
, &type
, &class, &category
, &selector
);
1309 struct symbol
*sym
= NULL
;
1310 struct minimal_symbol
*msym
= NULL
;
1312 strcpy (buf
, method
);
1313 tmp
= parse_selector (buf
, &selector
);
1318 sym
= lookup_symbol (selector
, block
, VAR_DOMAIN
, 0);
1328 msym
= lookup_minimal_symbol (selector
, 0, 0);
1333 syms
[csym
] = (struct symbol
*)msym
;
1339 find_methods (symtab
, type
, class, category
, selector
,
1340 syms
+ csym
, &ncsym
, &ncdebug
);
1342 find_methods (symtab
, type
, class, category
, selector
,
1343 NULL
, &ncsym
, &ncdebug
);
1345 /* If we didn't find any methods, just return. */
1346 if (ncsym
== 0 && ncdebug
== 0)
1349 /* Take debug symbols from the second batch of symbols and swap them
1350 * with debug symbols from the first batch. Repeat until either the
1351 * second section is out of debug symbols or the first section is
1352 * full of debug symbols. Either way we have all debug symbols
1353 * packed to the beginning of the buffer.
1358 while ((cdebug
< csym
) && (ncdebug
> 0))
1360 struct symbol
*s
= NULL
;
1361 /* First non-debugging symbol. */
1362 unsigned int i
= cdebug
;
1363 /* Last of second batch of debug symbols. */
1364 unsigned int j
= csym
+ ncdebug
- 1;
1370 /* We've moved a symbol from the second debug section to the
1386 return method
+ (tmp
- buf
);
1390 /* Sort debuggable symbols. */
1392 qsort (syms
, cdebug
, sizeof (struct minimal_symbol
*),
1395 /* Sort minimal_symbols. */
1396 if ((csym
- cdebug
) > 1)
1397 qsort (&syms
[cdebug
], csym
- cdebug
,
1398 sizeof (struct minimal_symbol
*), compare_classes
);
1400 /* Terminate the sym_arr list. */
1403 return method
+ (tmp
- buf
);
1407 print_object_command (char *args
, int from_tty
)
1409 struct value
*object
, *function
, *description
;
1410 CORE_ADDR string_addr
, object_addr
;
1414 if (!args
|| !*args
)
1416 "The 'print-object' command requires an argument (an Objective-C object)");
1419 struct expression
*expr
= parse_expression (args
);
1420 struct cleanup
*old_chain
=
1421 make_cleanup (free_current_contents
, &expr
);
1424 object
= expr
->language_defn
->la_exp_desc
->evaluate_exp
1425 (builtin_type (expr
->gdbarch
)->builtin_data_ptr
, expr
, &pc
, EVAL_NORMAL
);
1426 do_cleanups (old_chain
);
1429 /* Validate the address for sanity. */
1430 object_addr
= value_as_long (object
);
1431 read_memory (object_addr
, &c
, 1);
1433 function
= find_function_in_inferior ("_NSPrintForDebugger", NULL
);
1434 if (function
== NULL
)
1435 error (_("Unable to locate _NSPrintForDebugger in child process"));
1437 description
= call_function_by_hand (function
, 1, &object
);
1439 string_addr
= value_as_long (description
);
1440 if (string_addr
== 0)
1441 error (_("object returns null description"));
1443 read_memory (string_addr
+ i
++, &c
, 1);
1446 { /* Read and print characters up to EOS. */
1448 printf_filtered ("%c", c
);
1449 read_memory (string_addr
+ i
++, &c
, 1);
1452 printf_filtered(_("<object returns empty description>"));
1453 printf_filtered ("\n");
1456 /* The data structure 'methcalls' is used to detect method calls (thru
1457 * ObjC runtime lib functions objc_msgSend, objc_msgSendSuper, etc.),
1458 * and ultimately find the method being called.
1461 struct objc_methcall
{
1463 /* Return instance method to be called. */
1464 int (*stop_at
) (CORE_ADDR
, CORE_ADDR
*);
1465 /* Start of pc range corresponding to method invocation. */
1467 /* End of pc range corresponding to method invocation. */
1471 static int resolve_msgsend (CORE_ADDR pc
, CORE_ADDR
*new_pc
);
1472 static int resolve_msgsend_stret (CORE_ADDR pc
, CORE_ADDR
*new_pc
);
1473 static int resolve_msgsend_super (CORE_ADDR pc
, CORE_ADDR
*new_pc
);
1474 static int resolve_msgsend_super_stret (CORE_ADDR pc
, CORE_ADDR
*new_pc
);
1476 static struct objc_methcall methcalls
[] = {
1477 { "_objc_msgSend", resolve_msgsend
, 0, 0},
1478 { "_objc_msgSend_stret", resolve_msgsend_stret
, 0, 0},
1479 { "_objc_msgSendSuper", resolve_msgsend_super
, 0, 0},
1480 { "_objc_msgSendSuper_stret", resolve_msgsend_super_stret
, 0, 0},
1481 { "_objc_getClass", NULL
, 0, 0},
1482 { "_objc_getMetaClass", NULL
, 0, 0}
1485 #define nmethcalls (sizeof (methcalls) / sizeof (methcalls[0]))
1487 /* The following function, "find_objc_msgsend", fills in the data
1488 * structure "objc_msgs" by finding the addresses of each of the
1489 * (currently four) functions that it holds (of which objc_msgSend is
1490 * the first). This must be called each time symbols are loaded, in
1491 * case the functions have moved for some reason.
1495 find_objc_msgsend (void)
1498 for (i
= 0; i
< nmethcalls
; i
++) {
1500 struct minimal_symbol
*func
;
1502 /* Try both with and without underscore. */
1503 func
= lookup_minimal_symbol (methcalls
[i
].name
, NULL
, NULL
);
1504 if ((func
== NULL
) && (methcalls
[i
].name
[0] == '_')) {
1505 func
= lookup_minimal_symbol (methcalls
[i
].name
+ 1, NULL
, NULL
);
1508 methcalls
[i
].begin
= 0;
1509 methcalls
[i
].end
= 0;
1513 methcalls
[i
].begin
= SYMBOL_VALUE_ADDRESS (func
);
1515 methcalls
[i
].end
= SYMBOL_VALUE_ADDRESS (++func
);
1516 } while (methcalls
[i
].begin
== methcalls
[i
].end
);
1520 /* find_objc_msgcall (replaces pc_off_limits)
1522 * ALL that this function now does is to determine whether the input
1523 * address ("pc") is the address of one of the Objective-C message
1524 * dispatch functions (mainly objc_msgSend or objc_msgSendSuper), and
1525 * if so, it returns the address of the method that will be called.
1527 * The old function "pc_off_limits" used to do a lot of other things
1528 * in addition, such as detecting shared library jump stubs and
1529 * returning the address of the shlib function that would be called.
1530 * That functionality has been moved into the gdbarch_skip_trampoline_code and
1531 * IN_SOLIB_TRAMPOLINE macros, which are resolved in the target-
1532 * dependent modules.
1535 struct objc_submethod_helper_data
{
1536 int (*f
) (CORE_ADDR
, CORE_ADDR
*);
1542 find_objc_msgcall_submethod_helper (void * arg
)
1544 struct objc_submethod_helper_data
*s
=
1545 (struct objc_submethod_helper_data
*) arg
;
1547 if (s
->f (s
->pc
, s
->new_pc
) == 0)
1554 find_objc_msgcall_submethod (int (*f
) (CORE_ADDR
, CORE_ADDR
*),
1558 struct objc_submethod_helper_data s
;
1564 if (catch_errors (find_objc_msgcall_submethod_helper
,
1566 "Unable to determine target of Objective-C method call (ignoring):\n",
1567 RETURN_MASK_ALL
) == 0)
1574 find_objc_msgcall (CORE_ADDR pc
, CORE_ADDR
*new_pc
)
1578 find_objc_msgsend ();
1584 for (i
= 0; i
< nmethcalls
; i
++)
1585 if ((pc
>= methcalls
[i
].begin
) && (pc
< methcalls
[i
].end
))
1587 if (methcalls
[i
].stop_at
!= NULL
)
1588 return find_objc_msgcall_submethod (methcalls
[i
].stop_at
,
1597 extern initialize_file_ftype _initialize_objc_language
; /* -Wmissing-prototypes */
1600 _initialize_objc_language (void)
1602 add_language (&objc_language_defn
);
1603 add_info ("selectors", selectors_info
, /* INFO SELECTORS command. */
1604 _("All Objective-C selectors, or those matching REGEXP."));
1605 add_info ("classes", classes_info
, /* INFO CLASSES command. */
1606 _("All Objective-C classes, or those matching REGEXP."));
1607 add_com ("print-object", class_vars
, print_object_command
,
1608 _("Ask an Objective-C object to print itself."));
1609 add_com_alias ("po", "print-object", class_vars
, 1);
1613 read_objc_method (CORE_ADDR addr
, struct objc_method
*method
)
1615 method
->name
= read_memory_unsigned_integer (addr
+ 0, 4);
1616 method
->types
= read_memory_unsigned_integer (addr
+ 4, 4);
1617 method
->imp
= read_memory_unsigned_integer (addr
+ 8, 4);
1621 unsigned long read_objc_methlist_nmethods (CORE_ADDR addr
)
1623 return read_memory_unsigned_integer (addr
+ 4, 4);
1627 read_objc_methlist_method (CORE_ADDR addr
, unsigned long num
,
1628 struct objc_method
*method
)
1630 gdb_assert (num
< read_objc_methlist_nmethods (addr
));
1631 read_objc_method (addr
+ 8 + (12 * num
), method
);
1635 read_objc_object (CORE_ADDR addr
, struct objc_object
*object
)
1637 object
->isa
= read_memory_unsigned_integer (addr
, 4);
1641 read_objc_super (CORE_ADDR addr
, struct objc_super
*super
)
1643 super
->receiver
= read_memory_unsigned_integer (addr
, 4);
1644 super
->class = read_memory_unsigned_integer (addr
+ 4, 4);
1648 read_objc_class (CORE_ADDR addr
, struct objc_class
*class)
1650 class->isa
= read_memory_unsigned_integer (addr
, 4);
1651 class->super_class
= read_memory_unsigned_integer (addr
+ 4, 4);
1652 class->name
= read_memory_unsigned_integer (addr
+ 8, 4);
1653 class->version
= read_memory_unsigned_integer (addr
+ 12, 4);
1654 class->info
= read_memory_unsigned_integer (addr
+ 16, 4);
1655 class->instance_size
= read_memory_unsigned_integer (addr
+ 18, 4);
1656 class->ivars
= read_memory_unsigned_integer (addr
+ 24, 4);
1657 class->methods
= read_memory_unsigned_integer (addr
+ 28, 4);
1658 class->cache
= read_memory_unsigned_integer (addr
+ 32, 4);
1659 class->protocols
= read_memory_unsigned_integer (addr
+ 36, 4);
1663 find_implementation_from_class (CORE_ADDR
class, CORE_ADDR sel
)
1665 CORE_ADDR subclass
= class;
1667 while (subclass
!= 0)
1670 struct objc_class class_str
;
1671 unsigned mlistnum
= 0;
1673 read_objc_class (subclass
, &class_str
);
1678 unsigned long nmethods
;
1681 mlist
= read_memory_unsigned_integer (class_str
.methods
+
1686 nmethods
= read_objc_methlist_nmethods (mlist
);
1688 for (i
= 0; i
< nmethods
; i
++)
1690 struct objc_method meth_str
;
1691 read_objc_methlist_method (mlist
, i
, &meth_str
);
1695 "checking method 0x%lx against selector 0x%lx\n",
1696 meth_str
.name
, sel
);
1699 if (meth_str
.name
== sel
)
1700 /* FIXME: hppa arch was doing a pointer dereference
1701 here. There needs to be a better way to do that. */
1702 return meth_str
.imp
;
1706 subclass
= class_str
.super_class
;
1713 find_implementation (CORE_ADDR object
, CORE_ADDR sel
)
1715 struct objc_object ostr
;
1719 read_objc_object (object
, &ostr
);
1723 return find_implementation_from_class (ostr
.isa
, sel
);
1727 resolve_msgsend (CORE_ADDR pc
, CORE_ADDR
*new_pc
)
1729 struct frame_info
*frame
= get_current_frame ();
1730 struct gdbarch
*gdbarch
= get_frame_arch (frame
);
1731 struct type
*ptr_type
= builtin_type (gdbarch
)->builtin_func_ptr
;
1737 object
= gdbarch_fetch_pointer_argument (gdbarch
, frame
, 0, ptr_type
);
1738 sel
= gdbarch_fetch_pointer_argument (gdbarch
, frame
, 1, ptr_type
);
1740 res
= find_implementation (object
, sel
);
1749 resolve_msgsend_stret (CORE_ADDR pc
, CORE_ADDR
*new_pc
)
1751 struct frame_info
*frame
= get_current_frame ();
1752 struct gdbarch
*gdbarch
= get_frame_arch (frame
);
1753 struct type
*ptr_type
= builtin_type (gdbarch
)->builtin_func_ptr
;
1759 object
= gdbarch_fetch_pointer_argument (gdbarch
, frame
, 1, ptr_type
);
1760 sel
= gdbarch_fetch_pointer_argument (gdbarch
, frame
, 2, ptr_type
);
1762 res
= find_implementation (object
, sel
);
1771 resolve_msgsend_super (CORE_ADDR pc
, CORE_ADDR
*new_pc
)
1773 struct frame_info
*frame
= get_current_frame ();
1774 struct gdbarch
*gdbarch
= get_frame_arch (frame
);
1775 struct type
*ptr_type
= builtin_type (gdbarch
)->builtin_func_ptr
;
1777 struct objc_super sstr
;
1783 super
= gdbarch_fetch_pointer_argument (gdbarch
, frame
, 0, ptr_type
);
1784 sel
= gdbarch_fetch_pointer_argument (gdbarch
, frame
, 1, ptr_type
);
1786 read_objc_super (super
, &sstr
);
1787 if (sstr
.class == 0)
1790 res
= find_implementation_from_class (sstr
.class, sel
);
1799 resolve_msgsend_super_stret (CORE_ADDR pc
, CORE_ADDR
*new_pc
)
1801 struct frame_info
*frame
= get_current_frame ();
1802 struct gdbarch
*gdbarch
= get_frame_arch (frame
);
1803 struct type
*ptr_type
= builtin_type (gdbarch
)->builtin_func_ptr
;
1805 struct objc_super sstr
;
1811 super
= gdbarch_fetch_pointer_argument (gdbarch
, frame
, 1, ptr_type
);
1812 sel
= gdbarch_fetch_pointer_argument (gdbarch
, frame
, 2, ptr_type
);
1814 read_objc_super (super
, &sstr
);
1815 if (sstr
.class == 0)
1818 res
= find_implementation_from_class (sstr
.class, sel
);
1827 _initialize_objc_lang (void)
1829 objc_objfile_data
= register_objfile_data ();