1 /* Objective-C language support routines for GDB, the GNU debugger.
3 Copyright (C) 2002, 2003, 2004, 2005, 2007 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"
56 CORE_ADDR super_class
;
78 /* Lookup a structure type named "struct NAME", visible in lexical
79 block BLOCK. If NOERR is nonzero, return zero if NAME is not
83 lookup_struct_typedef (char *name
, struct block
*block
, int noerr
)
87 sym
= lookup_symbol (name
, block
, STRUCT_DOMAIN
, 0,
88 (struct symtab
**) NULL
);
95 error (_("No struct type named %s."), name
);
97 if (TYPE_CODE (SYMBOL_TYPE (sym
)) != TYPE_CODE_STRUCT
)
102 error (_("This context has class, union or enum %s, not a struct."),
109 lookup_objc_class (char *classname
)
111 struct value
* function
, *classval
;
113 if (! target_has_execution
)
115 /* Can't call into inferior to lookup class. */
119 if (lookup_minimal_symbol("objc_lookUpClass", 0, 0))
120 function
= find_function_in_inferior("objc_lookUpClass");
121 else if (lookup_minimal_symbol ("objc_lookup_class", 0, 0))
122 function
= find_function_in_inferior("objc_lookup_class");
125 complaint (&symfile_complaints
, _("no way to lookup Objective-C classes"));
129 classval
= value_string (classname
, strlen (classname
) + 1);
130 classval
= value_coerce_array (classval
);
131 return (CORE_ADDR
) value_as_long (call_function_by_hand (function
,
136 lookup_child_selector (char *selname
)
138 struct value
* function
, *selstring
;
140 if (! target_has_execution
)
142 /* Can't call into inferior to lookup selector. */
146 if (lookup_minimal_symbol("sel_getUid", 0, 0))
147 function
= find_function_in_inferior("sel_getUid");
148 else if (lookup_minimal_symbol ("sel_get_any_uid", 0, 0))
149 function
= find_function_in_inferior("sel_get_any_uid");
152 complaint (&symfile_complaints
, _("no way to lookup Objective-C selectors"));
156 selstring
= value_coerce_array (value_string (selname
,
157 strlen (selname
) + 1));
158 return value_as_long (call_function_by_hand (function
, 1, &selstring
));
162 value_nsstring (char *ptr
, int len
)
164 struct value
*stringValue
[3];
165 struct value
*function
, *nsstringValue
;
169 if (!target_has_execution
)
170 return 0; /* Can't call into inferior to create NSString. */
172 sym
= lookup_struct_typedef("NSString", 0, 1);
174 sym
= lookup_struct_typedef("NXString", 0, 1);
176 type
= lookup_pointer_type(builtin_type_void
);
178 type
= lookup_pointer_type(SYMBOL_TYPE (sym
));
180 stringValue
[2] = value_string(ptr
, len
);
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");
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");
191 nsstringValue
= call_function_by_hand(function
, 1, &stringValue
[2]);
193 else if (lookup_minimal_symbol("+[NSString stringWithCString:]", 0, 0))
195 function
= find_function_in_inferior("+[NSString stringWithCString:]");
196 stringValue
[0] = value_from_longest
197 (builtin_type_long
, lookup_objc_class ("NSString"));
198 stringValue
[1] = value_from_longest
199 (builtin_type_long
, lookup_child_selector ("stringWithCString:"));
200 nsstringValue
= call_function_by_hand(function
, 3, &stringValue
[0]);
203 error (_("NSString: internal error -- no way to create new NSString"));
205 deprecated_set_value_type (nsstringValue
, type
);
206 return nsstringValue
;
209 /* Objective-C name demangling. */
212 objc_demangle (const char *mangled
, int options
)
214 char *demangled
, *cp
;
216 if (mangled
[0] == '_' &&
217 (mangled
[1] == 'i' || mangled
[1] == 'c') &&
220 cp
= demangled
= xmalloc(strlen(mangled
) + 2);
222 if (mangled
[1] == 'i')
223 *cp
++ = '-'; /* for instance method */
225 *cp
++ = '+'; /* for class method */
227 *cp
++ = '['; /* opening left brace */
228 strcpy(cp
, mangled
+3); /* tack on the rest of the mangled name */
230 while (*cp
&& *cp
== '_')
231 cp
++; /* skip any initial underbars in class name */
233 cp
= strchr(cp
, '_');
234 if (!cp
) /* find first non-initial underbar */
236 xfree(demangled
); /* not mangled name */
239 if (cp
[1] == '_') { /* easy case: no category name */
240 *cp
++ = ' '; /* replace two '_' with one ' ' */
241 strcpy(cp
, mangled
+ (cp
- demangled
) + 2);
244 *cp
++ = '('; /* less easy case: category name */
245 cp
= strchr(cp
, '_');
248 xfree(demangled
); /* not mangled name */
252 *cp
++ = ' '; /* overwriting 1st char of method name... */
253 strcpy(cp
, mangled
+ (cp
- demangled
)); /* get it back */
256 while (*cp
&& *cp
== '_')
257 cp
++; /* skip any initial underbars in method name */
261 *cp
= ':'; /* replace remaining '_' with ':' */
263 *cp
++ = ']'; /* closing right brace */
264 *cp
++ = 0; /* string terminator */
268 return NULL
; /* Not an objc mangled name. */
271 /* Print the character C on STREAM as part of the contents of a
272 literal string whose delimiter is QUOTER. Note that that format
273 for printing characters and strings is language specific. */
276 objc_emit_char (int c
, struct ui_file
*stream
, int quoter
)
279 c
&= 0xFF; /* Avoid sign bit follies. */
281 if (PRINT_LITERAL_FORM (c
))
283 if (c
== '\\' || c
== quoter
)
285 fputs_filtered ("\\", stream
);
287 fprintf_filtered (stream
, "%c", c
);
294 fputs_filtered ("\\n", stream
);
297 fputs_filtered ("\\b", stream
);
300 fputs_filtered ("\\t", stream
);
303 fputs_filtered ("\\f", stream
);
306 fputs_filtered ("\\r", stream
);
309 fputs_filtered ("\\e", stream
);
312 fputs_filtered ("\\a", stream
);
315 fprintf_filtered (stream
, "\\%.3o", (unsigned int) c
);
322 objc_printchar (int c
, struct ui_file
*stream
)
324 fputs_filtered ("'", stream
);
325 objc_emit_char (c
, stream
, '\'');
326 fputs_filtered ("'", stream
);
329 /* Print the character string STRING, printing at most LENGTH
330 characters. Printing stops early if the number hits print_max;
331 repeat counts are printed as appropriate. Print ellipses at the
332 end if we had to stop before printing LENGTH characters, or if
336 objc_printstr (struct ui_file
*stream
, const gdb_byte
*string
,
337 unsigned int length
, int width
, int force_ellipses
)
340 unsigned int things_printed
= 0;
344 /* If the string was not truncated due to `set print elements', and
345 the last byte of it is a null, we don't print that, in
346 traditional C style. */
347 if ((!force_ellipses
) && length
> 0 && string
[length
-1] == '\0')
352 fputs_filtered ("\"\"", stream
);
356 for (i
= 0; i
< length
&& things_printed
< print_max
; ++i
)
358 /* Position of the character we are examining to see whether it
361 /* Number of repetitions we have detected so far. */
368 fputs_filtered (", ", stream
);
374 while (rep1
< length
&& string
[rep1
] == string
[i
])
380 if (reps
> repeat_count_threshold
)
385 fputs_filtered ("\\\", ", stream
);
387 fputs_filtered ("\", ", stream
);
390 objc_printchar (string
[i
], stream
);
391 fprintf_filtered (stream
, " <repeats %u times>", reps
);
393 things_printed
+= repeat_count_threshold
;
401 fputs_filtered ("\\\"", stream
);
403 fputs_filtered ("\"", stream
);
406 objc_emit_char (string
[i
], stream
, '"');
411 /* Terminate the quotes if necessary. */
415 fputs_filtered ("\\\"", stream
);
417 fputs_filtered ("\"", stream
);
420 if (force_ellipses
|| i
< length
)
421 fputs_filtered ("...", stream
);
424 /* Determine if we are currently in the Objective-C dispatch function.
425 If so, get the address of the method function that the dispatcher
426 would call and use that as the function to step into instead. Also
427 skip over the trampoline for the function (if any). This is better
428 for the user since they are only interested in stepping into the
429 method function anyway. */
431 objc_skip_trampoline (struct frame_info
*frame
, CORE_ADDR stop_pc
)
433 CORE_ADDR real_stop_pc
;
434 CORE_ADDR method_stop_pc
;
436 real_stop_pc
= gdbarch_skip_trampoline_code
437 (current_gdbarch
, frame
, stop_pc
);
439 if (real_stop_pc
!= 0)
440 find_objc_msgcall (real_stop_pc
, &method_stop_pc
);
442 find_objc_msgcall (stop_pc
, &method_stop_pc
);
446 real_stop_pc
= gdbarch_skip_trampoline_code
447 (current_gdbarch
, frame
, method_stop_pc
);
448 if (real_stop_pc
== 0)
449 real_stop_pc
= method_stop_pc
;
456 /* Table mapping opcodes into strings for printing operators
457 and precedences of the operators. */
459 static const struct op_print objc_op_print_tab
[] =
461 {",", BINOP_COMMA
, PREC_COMMA
, 0},
462 {"=", BINOP_ASSIGN
, PREC_ASSIGN
, 1},
463 {"||", BINOP_LOGICAL_OR
, PREC_LOGICAL_OR
, 0},
464 {"&&", BINOP_LOGICAL_AND
, PREC_LOGICAL_AND
, 0},
465 {"|", BINOP_BITWISE_IOR
, PREC_BITWISE_IOR
, 0},
466 {"^", BINOP_BITWISE_XOR
, PREC_BITWISE_XOR
, 0},
467 {"&", BINOP_BITWISE_AND
, PREC_BITWISE_AND
, 0},
468 {"==", BINOP_EQUAL
, PREC_EQUAL
, 0},
469 {"!=", BINOP_NOTEQUAL
, PREC_EQUAL
, 0},
470 {"<=", BINOP_LEQ
, PREC_ORDER
, 0},
471 {">=", BINOP_GEQ
, PREC_ORDER
, 0},
472 {">", BINOP_GTR
, PREC_ORDER
, 0},
473 {"<", BINOP_LESS
, PREC_ORDER
, 0},
474 {">>", BINOP_RSH
, PREC_SHIFT
, 0},
475 {"<<", BINOP_LSH
, PREC_SHIFT
, 0},
476 {"+", BINOP_ADD
, PREC_ADD
, 0},
477 {"-", BINOP_SUB
, PREC_ADD
, 0},
478 {"*", BINOP_MUL
, PREC_MUL
, 0},
479 {"/", BINOP_DIV
, PREC_MUL
, 0},
480 {"%", BINOP_REM
, PREC_MUL
, 0},
481 {"@", BINOP_REPEAT
, PREC_REPEAT
, 0},
482 {"-", UNOP_NEG
, PREC_PREFIX
, 0},
483 {"!", UNOP_LOGICAL_NOT
, PREC_PREFIX
, 0},
484 {"~", UNOP_COMPLEMENT
, PREC_PREFIX
, 0},
485 {"*", UNOP_IND
, PREC_PREFIX
, 0},
486 {"&", UNOP_ADDR
, PREC_PREFIX
, 0},
487 {"sizeof ", UNOP_SIZEOF
, PREC_PREFIX
, 0},
488 {"++", UNOP_PREINCREMENT
, PREC_PREFIX
, 0},
489 {"--", UNOP_PREDECREMENT
, PREC_PREFIX
, 0},
490 {NULL
, OP_NULL
, PREC_NULL
, 0}
493 const struct language_defn objc_language_defn
= {
494 "objective-c", /* Language name */
500 &exp_descriptor_standard
,
504 objc_printchar
, /* Print a character constant */
505 objc_printstr
, /* Function to print string constant */
507 c_print_type
, /* Print a type using appropriate syntax */
508 c_val_print
, /* Print a value using appropriate syntax */
509 c_value_print
, /* Print a top-level value */
510 objc_skip_trampoline
, /* Language specific skip_trampoline */
511 value_of_this
, /* value_of_this */
512 basic_lookup_symbol_nonlocal
, /* lookup_symbol_nonlocal */
513 basic_lookup_transparent_type
,/* lookup_transparent_type */
514 objc_demangle
, /* Language specific symbol demangler */
515 NULL
, /* Language specific class_name_from_physname */
516 objc_op_print_tab
, /* Expression operators for printing */
517 1, /* C-style arrays */
518 0, /* String lower bound */
519 default_word_break_characters
,
520 c_language_arch_info
,
521 default_print_array_index
,
522 default_pass_by_reference
,
528 * Following functions help construct Objective-C message calls
531 struct selname
/* For parsing Objective-C. */
533 struct selname
*next
;
538 static int msglist_len
;
539 static struct selname
*selname_chain
;
540 static char *msglist_sel
;
545 struct selname
*new =
546 (struct selname
*) xmalloc (sizeof (struct selname
));
548 new->next
= selname_chain
;
549 new->msglist_len
= msglist_len
;
550 new->msglist_sel
= msglist_sel
;
552 msglist_sel
= (char *)xmalloc(1);
558 add_msglist(struct stoken
*str
, int addcolon
)
563 if (str
== 0) { /* Unnamed arg, or... */
564 if (addcolon
== 0) { /* variable number of args. */
574 len
= plen
+ strlen(msglist_sel
) + 2;
575 s
= (char *)xmalloc(len
);
576 strcpy(s
, msglist_sel
);
591 int val
= msglist_len
;
592 struct selname
*sel
= selname_chain
;
593 char *p
= msglist_sel
;
596 selname_chain
= sel
->next
;
597 msglist_len
= sel
->msglist_len
;
598 msglist_sel
= sel
->msglist_sel
;
599 selid
= lookup_child_selector(p
);
601 error (_("Can't find selector \"%s\""), p
);
602 write_exp_elt_longcst (selid
);
604 write_exp_elt_longcst (val
); /* Number of args */
611 * Function: specialcmp (char *a, char *b)
613 * Special strcmp: treats ']' and ' ' as end-of-string.
614 * Used for qsorting lists of objc methods (either by class or selector).
618 specialcmp (char *a
, char *b
)
620 while (*a
&& *a
!= ' ' && *a
!= ']' && *b
&& *b
!= ' ' && *b
!= ']')
626 if (*a
&& *a
!= ' ' && *a
!= ']')
627 return 1; /* a is longer therefore greater */
628 if (*b
&& *b
!= ' ' && *b
!= ']')
629 return -1; /* a is shorter therefore lesser */
630 return 0; /* a and b are identical */
634 * Function: compare_selectors (const void *, const void *)
636 * Comparison function for use with qsort. Arguments are symbols or
637 * msymbols Compares selector part of objc method name alphabetically.
641 compare_selectors (const void *a
, const void *b
)
645 aname
= SYMBOL_PRINT_NAME (*(struct symbol
**) a
);
646 bname
= SYMBOL_PRINT_NAME (*(struct symbol
**) b
);
647 if (aname
== NULL
|| bname
== NULL
)
648 error (_("internal: compare_selectors(1)"));
650 aname
= strchr(aname
, ' ');
651 bname
= strchr(bname
, ' ');
652 if (aname
== NULL
|| bname
== NULL
)
653 error (_("internal: compare_selectors(2)"));
655 return specialcmp (aname
+1, bname
+1);
659 * Function: selectors_info (regexp, from_tty)
661 * Implements the "Info selectors" command. Takes an optional regexp
662 * arg. Lists all objective c selectors that match the regexp. Works
663 * by grepping thru all symbols for objective c methods. Output list
664 * is sorted and uniqued.
668 selectors_info (char *regexp
, int from_tty
)
670 struct objfile
*objfile
;
671 struct minimal_symbol
*msymbol
;
679 struct symbol
**sym_arr
;
683 strcpy(myregexp
, ".*]"); /* Null input, match all objc methods. */
686 if (*regexp
== '+' || *regexp
== '-')
687 { /* User wants only class methods or only instance methods. */
688 plusminus
= *regexp
++;
689 while (*regexp
== ' ' || *regexp
== '\t')
693 strcpy(myregexp
, ".*]");
696 strcpy(myregexp
, regexp
);
697 if (myregexp
[strlen(myregexp
) - 1] == '$') /* end of selector */
698 myregexp
[strlen(myregexp
) - 1] = ']'; /* end of method name */
700 strcat(myregexp
, ".*]");
706 val
= re_comp (myregexp
);
708 error (_("Invalid regexp (%s): %s"), val
, regexp
);
711 /* First time thru is JUST to get max length and count. */
712 ALL_MSYMBOLS (objfile
, msymbol
)
715 name
= SYMBOL_NATURAL_NAME (msymbol
);
717 (name
[0] == '-' || name
[0] == '+') &&
718 name
[1] == '[') /* Got a method name. */
720 /* Filter for class/instance methods. */
721 if (plusminus
&& name
[0] != plusminus
)
723 /* Find selector part. */
724 name
= (char *) strchr(name
+2, ' ');
725 if (regexp
== NULL
|| re_exec(++name
) != 0)
727 char *mystart
= name
;
728 char *myend
= (char *) strchr(mystart
, ']');
730 if (myend
&& (myend
- mystart
> maxlen
))
731 maxlen
= myend
- mystart
; /* Get longest selector. */
738 printf_filtered (_("Selectors matching \"%s\":\n\n"),
739 regexp
? regexp
: "*");
741 sym_arr
= alloca (matches
* sizeof (struct symbol
*));
743 ALL_MSYMBOLS (objfile
, msymbol
)
746 name
= SYMBOL_NATURAL_NAME (msymbol
);
748 (name
[0] == '-' || name
[0] == '+') &&
749 name
[1] == '[') /* Got a method name. */
751 /* Filter for class/instance methods. */
752 if (plusminus
&& name
[0] != plusminus
)
754 /* Find selector part. */
755 name
= (char *) strchr(name
+2, ' ');
756 if (regexp
== NULL
|| re_exec(++name
) != 0)
757 sym_arr
[matches
++] = (struct symbol
*) msymbol
;
761 qsort (sym_arr
, matches
, sizeof (struct minimal_symbol
*),
763 /* Prevent compare on first iteration. */
765 for (ix
= 0; ix
< matches
; ix
++) /* Now do the output. */
770 name
= SYMBOL_NATURAL_NAME (sym_arr
[ix
]);
771 name
= strchr (name
, ' ') + 1;
772 if (p
[0] && specialcmp(name
, p
) == 0)
773 continue; /* Seen this one already (not unique). */
775 /* Copy selector part. */
776 while (*name
&& *name
!= ']')
779 /* Print in columns. */
780 puts_filtered_tabular(asel
, maxlen
+ 1, 0);
785 printf_filtered (_("No selectors matching \"%s\"\n"), regexp
? regexp
: "*");
789 * Function: compare_classes (const void *, const void *)
791 * Comparison function for use with qsort. Arguments are symbols or
792 * msymbols Compares class part of objc method name alphabetically.
796 compare_classes (const void *a
, const void *b
)
800 aname
= SYMBOL_PRINT_NAME (*(struct symbol
**) a
);
801 bname
= SYMBOL_PRINT_NAME (*(struct symbol
**) b
);
802 if (aname
== NULL
|| bname
== NULL
)
803 error (_("internal: compare_classes(1)"));
805 return specialcmp (aname
+1, bname
+1);
809 * Function: classes_info(regexp, from_tty)
811 * Implements the "info classes" command for objective c classes.
812 * Lists all objective c classes that match the optional regexp.
813 * Works by grepping thru the list of objective c methods. List will
814 * be sorted and uniqued (since one class may have many methods).
815 * BUGS: will not list a class that has no methods.
819 classes_info (char *regexp
, int from_tty
)
821 struct objfile
*objfile
;
822 struct minimal_symbol
*msymbol
;
830 struct symbol
**sym_arr
;
833 strcpy(myregexp
, ".* "); /* Null input: match all objc classes. */
836 strcpy(myregexp
, regexp
);
837 if (myregexp
[strlen(myregexp
) - 1] == '$')
838 /* In the method name, the end of the class name is marked by ' '. */
839 myregexp
[strlen(myregexp
) - 1] = ' ';
841 strcat(myregexp
, ".* ");
846 val
= re_comp (myregexp
);
848 error (_("Invalid regexp (%s): %s"), val
, regexp
);
851 /* First time thru is JUST to get max length and count. */
852 ALL_MSYMBOLS (objfile
, msymbol
)
855 name
= SYMBOL_NATURAL_NAME (msymbol
);
857 (name
[0] == '-' || name
[0] == '+') &&
858 name
[1] == '[') /* Got a method name. */
859 if (regexp
== NULL
|| re_exec(name
+2) != 0)
861 /* Compute length of classname part. */
862 char *mystart
= name
+ 2;
863 char *myend
= (char *) strchr(mystart
, ' ');
865 if (myend
&& (myend
- mystart
> maxlen
))
866 maxlen
= myend
- mystart
;
872 printf_filtered (_("Classes matching \"%s\":\n\n"),
873 regexp
? regexp
: "*");
874 sym_arr
= alloca (matches
* sizeof (struct symbol
*));
876 ALL_MSYMBOLS (objfile
, msymbol
)
879 name
= SYMBOL_NATURAL_NAME (msymbol
);
881 (name
[0] == '-' || name
[0] == '+') &&
882 name
[1] == '[') /* Got a method name. */
883 if (regexp
== NULL
|| re_exec(name
+2) != 0)
884 sym_arr
[matches
++] = (struct symbol
*) msymbol
;
887 qsort (sym_arr
, matches
, sizeof (struct minimal_symbol
*),
889 /* Prevent compare on first iteration. */
891 for (ix
= 0; ix
< matches
; ix
++) /* Now do the output. */
896 name
= SYMBOL_NATURAL_NAME (sym_arr
[ix
]);
898 if (p
[0] && specialcmp(name
, p
) == 0)
899 continue; /* Seen this one already (not unique). */
901 /* Copy class part of method name. */
902 while (*name
&& *name
!= ' ')
905 /* Print in columns. */
906 puts_filtered_tabular(aclass
, maxlen
+ 1, 0);
911 printf_filtered (_("No classes matching \"%s\"\n"), regexp
? regexp
: "*");
915 * Function: find_imps (char *selector, struct symbol **sym_arr)
917 * Input: a string representing a selector
918 * a pointer to an array of symbol pointers
919 * possibly a pointer to a symbol found by the caller.
921 * Output: number of methods that implement that selector. Side
922 * effects: The array of symbol pointers is filled with matching syms.
924 * By analogy with function "find_methods" (symtab.c), builds a list
925 * of symbols matching the ambiguous input, so that "decode_line_2"
926 * (symtab.c) can list them and ask the user to choose one or more.
927 * In this case the matches are objective c methods
928 * ("implementations") matching an objective c selector.
930 * Note that it is possible for a normal (c-style) function to have
931 * the same name as an objective c selector. To prevent the selector
932 * from eclipsing the function, we allow the caller (decode_line_1) to
933 * search for such a function first, and if it finds one, pass it in
934 * to us. We will then integrate it into the list. We also search
935 * for one here, among the minsyms.
937 * NOTE: if NUM_DEBUGGABLE is non-zero, the sym_arr will be divided
938 * into two parts: debuggable (struct symbol) syms, and
939 * non_debuggable (struct minimal_symbol) syms. The debuggable
940 * ones will come first, before NUM_DEBUGGABLE (which will thus
941 * be the index of the first non-debuggable one).
945 * Function: total_number_of_imps (char *selector);
947 * Input: a string representing a selector
948 * Output: number of methods that implement that selector.
950 * By analogy with function "total_number_of_methods", this allows
951 * decode_line_1 (symtab.c) to detect if there are objective c methods
952 * matching the input, and to allocate an array of pointers to them
953 * which can be manipulated by "decode_line_2" (also in symtab.c).
957 parse_selector (char *method
, char **selector
)
963 char *nselector
= NULL
;
965 gdb_assert (selector
!= NULL
);
969 while (isspace (*s1
))
976 while (isspace (*s1
))
983 if (isalnum (*s2
) || (*s2
== '_') || (*s2
== ':'))
985 else if (isspace (*s2
))
987 else if ((*s2
== '\0') || (*s2
== '\''))
995 while (isspace (*s2
))
1001 while (isspace (*s2
))
1005 if (selector
!= NULL
)
1006 *selector
= nselector
;
1012 parse_method (char *method
, char *type
, char **class,
1013 char **category
, char **selector
)
1017 int found_quote
= 0;
1020 char *nclass
= NULL
;
1021 char *ncategory
= NULL
;
1022 char *nselector
= NULL
;
1024 gdb_assert (type
!= NULL
);
1025 gdb_assert (class != NULL
);
1026 gdb_assert (category
!= NULL
);
1027 gdb_assert (selector
!= NULL
);
1031 while (isspace (*s1
))
1038 while (isspace (*s1
))
1041 if ((s1
[0] == '+') || (s1
[0] == '-'))
1044 while (isspace (*s1
))
1052 while (isalnum (*s1
) || (*s1
== '_'))
1056 while (isspace (*s2
))
1062 while (isspace (*s2
))
1065 while (isalnum (*s2
) || (*s2
== '_'))
1070 /* Truncate the class name now that we're not using the open paren. */
1077 if (isalnum (*s2
) || (*s2
== '_') || (*s2
== ':'))
1079 else if (isspace (*s2
))
1081 else if (*s2
== ']')
1090 while (isspace (*s2
))
1097 while (isspace (*s2
))
1105 if (category
!= NULL
)
1106 *category
= ncategory
;
1107 if (selector
!= NULL
)
1108 *selector
= nselector
;
1114 find_methods (struct symtab
*symtab
, char type
,
1115 const char *class, const char *category
,
1116 const char *selector
, struct symbol
**syms
,
1117 unsigned int *nsym
, unsigned int *ndebug
)
1119 struct objfile
*objfile
= NULL
;
1120 struct minimal_symbol
*msymbol
= NULL
;
1121 struct block
*block
= NULL
;
1122 struct symbol
*sym
= NULL
;
1124 char *symname
= NULL
;
1127 char *nclass
= NULL
;
1128 char *ncategory
= NULL
;
1129 char *nselector
= NULL
;
1131 unsigned int csym
= 0;
1132 unsigned int cdebug
= 0;
1134 static char *tmp
= NULL
;
1135 static unsigned int tmplen
= 0;
1137 gdb_assert (nsym
!= NULL
);
1138 gdb_assert (ndebug
!= NULL
);
1141 block
= BLOCKVECTOR_BLOCK (BLOCKVECTOR (symtab
), STATIC_BLOCK
);
1143 ALL_MSYMBOLS (objfile
, msymbol
)
1147 if ((msymbol
->type
!= mst_text
) && (msymbol
->type
!= mst_file_text
))
1148 /* Not a function or method. */
1152 if ((SYMBOL_VALUE_ADDRESS (msymbol
) < BLOCK_START (block
)) ||
1153 (SYMBOL_VALUE_ADDRESS (msymbol
) >= BLOCK_END (block
)))
1154 /* Not in the specified symtab. */
1157 symname
= SYMBOL_NATURAL_NAME (msymbol
);
1158 if (symname
== NULL
)
1161 if ((symname
[0] != '-' && symname
[0] != '+') || (symname
[1] != '['))
1162 /* Not a method name. */
1165 while ((strlen (symname
) + 1) >= tmplen
)
1167 tmplen
= (tmplen
== 0) ? 1024 : tmplen
* 2;
1168 tmp
= xrealloc (tmp
, tmplen
);
1170 strcpy (tmp
, symname
);
1172 if (parse_method (tmp
, &ntype
, &nclass
, &ncategory
, &nselector
) == NULL
)
1175 if ((type
!= '\0') && (ntype
!= type
))
1179 && ((nclass
== NULL
) || (strcmp (class, nclass
) != 0)))
1182 if ((category
!= NULL
) &&
1183 ((ncategory
== NULL
) || (strcmp (category
, ncategory
) != 0)))
1186 if ((selector
!= NULL
) &&
1187 ((nselector
== NULL
) || (strcmp (selector
, nselector
) != 0)))
1190 sym
= find_pc_function (SYMBOL_VALUE_ADDRESS (msymbol
));
1193 const char *newsymname
= SYMBOL_NATURAL_NAME (sym
);
1195 if (strcmp (symname
, newsymname
) == 0)
1197 /* Found a high-level method sym: swap it into the
1198 lower part of sym_arr (below num_debuggable). */
1201 syms
[csym
] = syms
[cdebug
];
1210 "debugging symbol \"%s\" does not match minimal symbol (\"%s\"); ignoring",
1211 newsymname
, symname
);
1213 syms
[csym
] = (struct symbol
*) msymbol
;
1219 /* Found a non-debuggable method symbol. */
1221 syms
[csym
] = (struct symbol
*) msymbol
;
1232 char *find_imps (struct symtab
*symtab
, struct block
*block
,
1233 char *method
, struct symbol
**syms
,
1234 unsigned int *nsym
, unsigned int *ndebug
)
1238 char *category
= NULL
;
1239 char *selector
= NULL
;
1241 unsigned int csym
= 0;
1242 unsigned int cdebug
= 0;
1244 unsigned int ncsym
= 0;
1245 unsigned int ncdebug
= 0;
1250 gdb_assert (nsym
!= NULL
);
1251 gdb_assert (ndebug
!= NULL
);
1258 buf
= (char *) alloca (strlen (method
) + 1);
1259 strcpy (buf
, method
);
1260 tmp
= parse_method (buf
, &type
, &class, &category
, &selector
);
1264 struct symbol
*sym
= NULL
;
1265 struct minimal_symbol
*msym
= NULL
;
1267 strcpy (buf
, method
);
1268 tmp
= parse_selector (buf
, &selector
);
1273 sym
= lookup_symbol (selector
, block
, VAR_DOMAIN
, 0, NULL
);
1283 msym
= lookup_minimal_symbol (selector
, 0, 0);
1288 syms
[csym
] = (struct symbol
*)msym
;
1294 find_methods (symtab
, type
, class, category
, selector
,
1295 syms
+ csym
, &ncsym
, &ncdebug
);
1297 find_methods (symtab
, type
, class, category
, selector
,
1298 NULL
, &ncsym
, &ncdebug
);
1300 /* If we didn't find any methods, just return. */
1301 if (ncsym
== 0 && ncdebug
== 0)
1304 /* Take debug symbols from the second batch of symbols and swap them
1305 * with debug symbols from the first batch. Repeat until either the
1306 * second section is out of debug symbols or the first section is
1307 * full of debug symbols. Either way we have all debug symbols
1308 * packed to the beginning of the buffer.
1313 while ((cdebug
< csym
) && (ncdebug
> 0))
1315 struct symbol
*s
= NULL
;
1316 /* First non-debugging symbol. */
1317 unsigned int i
= cdebug
;
1318 /* Last of second batch of debug symbols. */
1319 unsigned int j
= csym
+ ncdebug
- 1;
1325 /* We've moved a symbol from the second debug section to the
1341 return method
+ (tmp
- buf
);
1345 /* Sort debuggable symbols. */
1347 qsort (syms
, cdebug
, sizeof (struct minimal_symbol
*),
1350 /* Sort minimal_symbols. */
1351 if ((csym
- cdebug
) > 1)
1352 qsort (&syms
[cdebug
], csym
- cdebug
,
1353 sizeof (struct minimal_symbol
*), compare_classes
);
1355 /* Terminate the sym_arr list. */
1358 return method
+ (tmp
- buf
);
1362 print_object_command (char *args
, int from_tty
)
1364 struct value
*object
, *function
, *description
;
1365 CORE_ADDR string_addr
, object_addr
;
1369 if (!args
|| !*args
)
1371 "The 'print-object' command requires an argument (an Objective-C object)");
1374 struct expression
*expr
= parse_expression (args
);
1375 struct cleanup
*old_chain
=
1376 make_cleanup (free_current_contents
, &expr
);
1379 object
= expr
->language_defn
->la_exp_desc
->evaluate_exp
1380 (builtin_type_void_data_ptr
, expr
, &pc
, EVAL_NORMAL
);
1381 do_cleanups (old_chain
);
1384 /* Validate the address for sanity. */
1385 object_addr
= value_as_long (object
);
1386 read_memory (object_addr
, &c
, 1);
1388 function
= find_function_in_inferior ("_NSPrintForDebugger");
1389 if (function
== NULL
)
1390 error (_("Unable to locate _NSPrintForDebugger in child process"));
1392 description
= call_function_by_hand (function
, 1, &object
);
1394 string_addr
= value_as_long (description
);
1395 if (string_addr
== 0)
1396 error (_("object returns null description"));
1398 read_memory (string_addr
+ i
++, &c
, 1);
1401 { /* Read and print characters up to EOS. */
1403 printf_filtered ("%c", c
);
1404 read_memory (string_addr
+ i
++, &c
, 1);
1407 printf_filtered(_("<object returns empty description>"));
1408 printf_filtered ("\n");
1411 /* The data structure 'methcalls' is used to detect method calls (thru
1412 * ObjC runtime lib functions objc_msgSend, objc_msgSendSuper, etc.),
1413 * and ultimately find the method being called.
1416 struct objc_methcall
{
1418 /* Return instance method to be called. */
1419 int (*stop_at
) (CORE_ADDR
, CORE_ADDR
*);
1420 /* Start of pc range corresponding to method invocation. */
1422 /* End of pc range corresponding to method invocation. */
1426 static int resolve_msgsend (CORE_ADDR pc
, CORE_ADDR
*new_pc
);
1427 static int resolve_msgsend_stret (CORE_ADDR pc
, CORE_ADDR
*new_pc
);
1428 static int resolve_msgsend_super (CORE_ADDR pc
, CORE_ADDR
*new_pc
);
1429 static int resolve_msgsend_super_stret (CORE_ADDR pc
, CORE_ADDR
*new_pc
);
1431 static struct objc_methcall methcalls
[] = {
1432 { "_objc_msgSend", resolve_msgsend
, 0, 0},
1433 { "_objc_msgSend_stret", resolve_msgsend_stret
, 0, 0},
1434 { "_objc_msgSendSuper", resolve_msgsend_super
, 0, 0},
1435 { "_objc_msgSendSuper_stret", resolve_msgsend_super_stret
, 0, 0},
1436 { "_objc_getClass", NULL
, 0, 0},
1437 { "_objc_getMetaClass", NULL
, 0, 0}
1440 #define nmethcalls (sizeof (methcalls) / sizeof (methcalls[0]))
1442 /* The following function, "find_objc_msgsend", fills in the data
1443 * structure "objc_msgs" by finding the addresses of each of the
1444 * (currently four) functions that it holds (of which objc_msgSend is
1445 * the first). This must be called each time symbols are loaded, in
1446 * case the functions have moved for some reason.
1450 find_objc_msgsend (void)
1453 for (i
= 0; i
< nmethcalls
; i
++) {
1455 struct minimal_symbol
*func
;
1457 /* Try both with and without underscore. */
1458 func
= lookup_minimal_symbol (methcalls
[i
].name
, NULL
, NULL
);
1459 if ((func
== NULL
) && (methcalls
[i
].name
[0] == '_')) {
1460 func
= lookup_minimal_symbol (methcalls
[i
].name
+ 1, NULL
, NULL
);
1463 methcalls
[i
].begin
= 0;
1464 methcalls
[i
].end
= 0;
1468 methcalls
[i
].begin
= SYMBOL_VALUE_ADDRESS (func
);
1470 methcalls
[i
].end
= SYMBOL_VALUE_ADDRESS (++func
);
1471 } while (methcalls
[i
].begin
== methcalls
[i
].end
);
1475 /* find_objc_msgcall (replaces pc_off_limits)
1477 * ALL that this function now does is to determine whether the input
1478 * address ("pc") is the address of one of the Objective-C message
1479 * dispatch functions (mainly objc_msgSend or objc_msgSendSuper), and
1480 * if so, it returns the address of the method that will be called.
1482 * The old function "pc_off_limits" used to do a lot of other things
1483 * in addition, such as detecting shared library jump stubs and
1484 * returning the address of the shlib function that would be called.
1485 * That functionality has been moved into the gdbarch_skip_trampoline_code and
1486 * IN_SOLIB_TRAMPOLINE macros, which are resolved in the target-
1487 * dependent modules.
1490 struct objc_submethod_helper_data
{
1491 int (*f
) (CORE_ADDR
, CORE_ADDR
*);
1497 find_objc_msgcall_submethod_helper (void * arg
)
1499 struct objc_submethod_helper_data
*s
=
1500 (struct objc_submethod_helper_data
*) arg
;
1502 if (s
->f (s
->pc
, s
->new_pc
) == 0)
1509 find_objc_msgcall_submethod (int (*f
) (CORE_ADDR
, CORE_ADDR
*),
1513 struct objc_submethod_helper_data s
;
1519 if (catch_errors (find_objc_msgcall_submethod_helper
,
1521 "Unable to determine target of Objective-C method call (ignoring):\n",
1522 RETURN_MASK_ALL
) == 0)
1529 find_objc_msgcall (CORE_ADDR pc
, CORE_ADDR
*new_pc
)
1533 find_objc_msgsend ();
1539 for (i
= 0; i
< nmethcalls
; i
++)
1540 if ((pc
>= methcalls
[i
].begin
) && (pc
< methcalls
[i
].end
))
1542 if (methcalls
[i
].stop_at
!= NULL
)
1543 return find_objc_msgcall_submethod (methcalls
[i
].stop_at
,
1552 extern initialize_file_ftype _initialize_objc_language
; /* -Wmissing-prototypes */
1555 _initialize_objc_language (void)
1557 add_language (&objc_language_defn
);
1558 add_info ("selectors", selectors_info
, /* INFO SELECTORS command. */
1559 _("All Objective-C selectors, or those matching REGEXP."));
1560 add_info ("classes", classes_info
, /* INFO CLASSES command. */
1561 _("All Objective-C classes, or those matching REGEXP."));
1562 add_com ("print-object", class_vars
, print_object_command
,
1563 _("Ask an Objective-C object to print itself."));
1564 add_com_alias ("po", "print-object", class_vars
, 1);
1568 read_objc_method (CORE_ADDR addr
, struct objc_method
*method
)
1570 method
->name
= read_memory_unsigned_integer (addr
+ 0, 4);
1571 method
->types
= read_memory_unsigned_integer (addr
+ 4, 4);
1572 method
->imp
= read_memory_unsigned_integer (addr
+ 8, 4);
1576 unsigned long read_objc_methlist_nmethods (CORE_ADDR addr
)
1578 return read_memory_unsigned_integer (addr
+ 4, 4);
1582 read_objc_methlist_method (CORE_ADDR addr
, unsigned long num
,
1583 struct objc_method
*method
)
1585 gdb_assert (num
< read_objc_methlist_nmethods (addr
));
1586 read_objc_method (addr
+ 8 + (12 * num
), method
);
1590 read_objc_object (CORE_ADDR addr
, struct objc_object
*object
)
1592 object
->isa
= read_memory_unsigned_integer (addr
, 4);
1596 read_objc_super (CORE_ADDR addr
, struct objc_super
*super
)
1598 super
->receiver
= read_memory_unsigned_integer (addr
, 4);
1599 super
->class = read_memory_unsigned_integer (addr
+ 4, 4);
1603 read_objc_class (CORE_ADDR addr
, struct objc_class
*class)
1605 class->isa
= read_memory_unsigned_integer (addr
, 4);
1606 class->super_class
= read_memory_unsigned_integer (addr
+ 4, 4);
1607 class->name
= read_memory_unsigned_integer (addr
+ 8, 4);
1608 class->version
= read_memory_unsigned_integer (addr
+ 12, 4);
1609 class->info
= read_memory_unsigned_integer (addr
+ 16, 4);
1610 class->instance_size
= read_memory_unsigned_integer (addr
+ 18, 4);
1611 class->ivars
= read_memory_unsigned_integer (addr
+ 24, 4);
1612 class->methods
= read_memory_unsigned_integer (addr
+ 28, 4);
1613 class->cache
= read_memory_unsigned_integer (addr
+ 32, 4);
1614 class->protocols
= read_memory_unsigned_integer (addr
+ 36, 4);
1618 find_implementation_from_class (CORE_ADDR
class, CORE_ADDR sel
)
1620 CORE_ADDR subclass
= class;
1622 while (subclass
!= 0)
1625 struct objc_class class_str
;
1626 unsigned mlistnum
= 0;
1628 read_objc_class (subclass
, &class_str
);
1633 unsigned long nmethods
;
1636 mlist
= read_memory_unsigned_integer (class_str
.methods
+
1641 nmethods
= read_objc_methlist_nmethods (mlist
);
1643 for (i
= 0; i
< nmethods
; i
++)
1645 struct objc_method meth_str
;
1646 read_objc_methlist_method (mlist
, i
, &meth_str
);
1650 "checking method 0x%lx against selector 0x%lx\n",
1651 meth_str
.name
, sel
);
1654 if (meth_str
.name
== sel
)
1655 /* FIXME: hppa arch was doing a pointer dereference
1656 here. There needs to be a better way to do that. */
1657 return meth_str
.imp
;
1661 subclass
= class_str
.super_class
;
1668 find_implementation (CORE_ADDR object
, CORE_ADDR sel
)
1670 struct objc_object ostr
;
1674 read_objc_object (object
, &ostr
);
1678 return find_implementation_from_class (ostr
.isa
, sel
);
1681 #define OBJC_FETCH_POINTER_ARGUMENT(argi) \
1682 gdbarch_fetch_pointer_argument (current_gdbarch, get_current_frame (), \
1683 argi, builtin_type_void_func_ptr)
1686 resolve_msgsend (CORE_ADDR pc
, CORE_ADDR
*new_pc
)
1692 object
= OBJC_FETCH_POINTER_ARGUMENT (0);
1693 sel
= OBJC_FETCH_POINTER_ARGUMENT (1);
1695 res
= find_implementation (object
, sel
);
1704 resolve_msgsend_stret (CORE_ADDR pc
, CORE_ADDR
*new_pc
)
1710 object
= OBJC_FETCH_POINTER_ARGUMENT (1);
1711 sel
= OBJC_FETCH_POINTER_ARGUMENT (2);
1713 res
= find_implementation (object
, sel
);
1722 resolve_msgsend_super (CORE_ADDR pc
, CORE_ADDR
*new_pc
)
1724 struct objc_super sstr
;
1730 super
= OBJC_FETCH_POINTER_ARGUMENT (0);
1731 sel
= OBJC_FETCH_POINTER_ARGUMENT (1);
1733 read_objc_super (super
, &sstr
);
1734 if (sstr
.class == 0)
1737 res
= find_implementation_from_class (sstr
.class, sel
);
1746 resolve_msgsend_super_stret (CORE_ADDR pc
, CORE_ADDR
*new_pc
)
1748 struct objc_super sstr
;
1754 super
= OBJC_FETCH_POINTER_ARGUMENT (1);
1755 sel
= OBJC_FETCH_POINTER_ARGUMENT (2);
1757 read_objc_super (super
, &sstr
);
1758 if (sstr
.class == 0)
1761 res
= find_implementation_from_class (sstr
.class, sel
);