1 /* Functions related to mangling class names for the GNU compiler
2 for the Java(TM) language.
3 Copyright (C) 1998, 1999, 2001, 2002, 2003
4 Free Software Foundation, Inc.
6 This file is part of GCC.
8 GCC is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2, or (at your option)
13 GCC is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GCC; see the file COPYING. If not, write to
20 the Free Software Foundation, 59 Temple Place - Suite 330,
21 Boston, MA 02111-1307, USA.
23 Java and all Java-based marks are trademarks or registered trademarks
24 of Sun Microsystems, Inc. in the United States and other countries.
25 The Free Software Foundation is independent of Sun Microsystems, Inc. */
27 /* Written by Per Bothner <bothner@cygnus.com> */
31 #include "coretypes.h"
35 #include "java-tree.h"
41 static void mangle_field_decl (tree
);
42 static void mangle_method_decl (tree
);
44 static void mangle_type (tree
);
45 static void mangle_pointer_type (tree
);
46 static void mangle_array_type (tree
);
47 static int mangle_record_type (tree
, int);
49 static int find_compression_pointer_match (tree
);
50 static int find_compression_array_match (tree
);
51 static int find_compression_record_match (tree
, tree
*);
52 static int find_compression_array_template_match (tree
);
54 static void set_type_package_list (tree
);
55 static int entry_match_pointer_p (tree
, int);
56 static void emit_compression_string (int);
58 static void init_mangling (struct obstack
*);
59 static tree
finish_mangling (void);
60 static void compression_table_add (tree
);
62 static void mangle_member_name (tree
);
64 /* We use an incoming obstack, always to be provided to the interface
66 struct obstack
*mangle_obstack
;
67 #define MANGLE_RAW_STRING(S) \
68 obstack_grow (mangle_obstack, (S), sizeof (S)-1)
70 /* atms: array template mangled string. */
71 static GTY(()) tree atms
;
73 /* This is the mangling interface: a decl, a class field (.class) and
77 java_mangle_decl (struct obstack
*obstack
, tree decl
)
79 init_mangling (obstack
);
80 switch (TREE_CODE (decl
))
83 mangle_field_decl (decl
);
86 mangle_method_decl (decl
);
89 internal_error ("can't mangle %s", tree_code_name
[TREE_CODE (decl
)]);
91 return finish_mangling ();
95 java_mangle_class_field (struct obstack
*obstack
, tree type
)
97 init_mangling (obstack
);
98 mangle_record_type (type
, /* for_pointer = */ 0);
99 MANGLE_RAW_STRING ("6class$");
100 obstack_1grow (mangle_obstack
, 'E');
101 return finish_mangling ();
105 java_mangle_vtable (struct obstack
*obstack
, tree type
)
107 init_mangling (obstack
);
108 MANGLE_RAW_STRING ("TV");
109 mangle_record_type (type
, /* for_pointer = */ 0);
110 obstack_1grow (mangle_obstack
, 'E');
111 return finish_mangling ();
114 /* Beginning of the helper functions */
116 /* This mangles a field decl */
119 mangle_field_decl (tree decl
)
121 /* Mangle the name of the this the field belongs to */
122 mangle_record_type (DECL_CONTEXT (decl
), /* for_pointer = */ 0);
124 /* Mangle the name of the field */
125 mangle_member_name (DECL_NAME (decl
));
127 /* Terminate the mangled name */
128 obstack_1grow (mangle_obstack
, 'E');
131 /* This mangles a method decl, first mangling its name and then all
135 mangle_method_decl (tree mdecl
)
137 tree method_name
= DECL_NAME (mdecl
);
140 /* Mangle the name of the type that contains mdecl */
141 mangle_record_type (DECL_CONTEXT (mdecl
), /* for_pointer = */ 0);
143 /* Mangle the function name. There are two cases:
144 - mdecl is a constructor, use `C1' for its name, (denotes a
145 complete object constructor.)
146 - mdecl is not a constructor, standard mangling is performed.
147 We terminate the mangled function name with a `E'. */
148 if (ID_INIT_P (method_name
))
149 obstack_grow (mangle_obstack
, "C1", 2);
151 mangle_member_name (method_name
);
152 obstack_1grow (mangle_obstack
, 'E');
154 /* We mangled type.methodName. Now onto the arguments. */
155 arglist
= TYPE_ARG_TYPES (TREE_TYPE (mdecl
));
156 if (TREE_CODE (TREE_TYPE (mdecl
)) == METHOD_TYPE
)
157 arglist
= TREE_CHAIN (arglist
);
159 /* No arguments is easy. We shortcut it. */
160 if (arglist
== end_params_node
)
161 obstack_1grow (mangle_obstack
, 'v');
165 for (arg
= arglist
; arg
!= end_params_node
; arg
= TREE_CHAIN (arg
))
166 mangle_type (TREE_VALUE (arg
));
170 /* This mangles a member name, like a function name or a field
171 name. Handle cases were `name' is a C++ keyword. Return a nonzero
172 value if unicode encoding was required. */
175 mangle_member_name (tree name
)
177 append_gpp_mangled_name (IDENTIFIER_POINTER (name
),
178 IDENTIFIER_LENGTH (name
));
180 /* If NAME happens to be a C++ keyword, add `$'. */
181 if (cxx_keyword_p (IDENTIFIER_POINTER (name
), IDENTIFIER_LENGTH (name
)))
182 obstack_1grow (mangle_obstack
, '$');
185 /* Append the mangled name of TYPE onto OBSTACK. */
188 mangle_type (tree type
)
190 switch (TREE_CODE (type
))
193 case BOOLEAN_TYPE
: code
= 'b'; goto primitive
;
194 case CHAR_TYPE
: code
= 'w'; goto primitive
;
195 case VOID_TYPE
: code
= 'v'; goto primitive
;
197 /* Get the original type instead of the arguments promoted type.
198 Avoid symbol name clashes. Should call a function to do that.
200 if (type
== promoted_short_type_node
)
201 type
= short_type_node
;
202 if (type
== promoted_byte_type_node
)
203 type
= byte_type_node
;
204 switch (TYPE_PRECISION (type
))
206 case 8: code
= 'c'; goto primitive
;
207 case 16: code
= 's'; goto primitive
;
208 case 32: code
= 'i'; goto primitive
;
209 case 64: code
= 'x'; goto primitive
;
210 default: goto bad_type
;
213 obstack_1grow (mangle_obstack
, code
);
217 switch (TYPE_PRECISION (type
))
219 case 32: code
= 'f'; goto primitive
;
220 case 64: code
= 'd'; goto primitive
;
221 default: goto bad_type
;
224 if (TYPE_ARRAY_P (TREE_TYPE (type
)))
225 mangle_array_type (type
);
227 mangle_pointer_type (type
);
235 /* The compression table is a vector that keeps track of things we've
236 already seen, so they can be reused. For example, java.lang.Object
237 would generate three entries: two package names and a type. If
238 java.lang.String is presented next, the java.lang will be matched
239 against the first two entries (and kept for compression as S0_), and
240 type String would be added to the table. See mangle_record_type.
241 COMPRESSION_NEXT is the index to the location of the next insertion
244 static GTY(()) tree compression_table
;
245 static int compression_next
;
247 /* Find a POINTER_TYPE in the compression table. Use a special
248 function to match pointer entries and start from the end */
251 find_compression_pointer_match (tree type
)
255 for (i
= compression_next
-1; i
>= 0; i
--)
256 if (entry_match_pointer_p (type
, i
))
261 /* Already recorder arrays are handled like pointer as they're always
262 associated with it. */
265 find_compression_array_match (tree type
)
267 return find_compression_pointer_match (type
);
270 /* Match the table of type against STRING. */
273 find_compression_array_template_match (tree string
)
276 for (i
= 0; i
< compression_next
; i
++)
277 if (TREE_VEC_ELT (compression_table
, i
) == string
)
282 /* We go through the compression table and try to find a complete or
283 partial match. The function returns the compression table entry
284 that (eventually partially) matches TYPE. *NEXT_CURRENT can be set
285 to the rest of TYPE to be mangled. */
288 find_compression_record_match (tree type
, tree
*next_current
)
291 tree current
, saved_current
= NULL_TREE
;
293 current
= TYPE_PACKAGE_LIST (type
);
295 for (i
= 0; i
< compression_next
; i
++)
297 tree compression_entry
= TREE_VEC_ELT (compression_table
, i
);
298 if (current
&& compression_entry
== TREE_PURPOSE (current
))
301 saved_current
= current
;
302 current
= TREE_CHAIN (current
);
305 /* We don't want to match an element that appears in the middle
306 of a package name, so skip forward to the next complete type name.
307 IDENTIFIER_NODEs (except for a "6JArray") are partial package
308 names while RECORD_TYPEs represent complete type names. */
309 while (i
< compression_next
310 && TREE_CODE (compression_entry
) == IDENTIFIER_NODE
311 && compression_entry
!= atms
)
312 compression_entry
= TREE_VEC_ELT (compression_table
, ++i
);
318 /* If we have a match, set next_current to the item next to the last
321 *next_current
= TREE_CHAIN (saved_current
);
322 /* We had no match: we'll have to start from the beginning. */
324 *next_current
= TYPE_PACKAGE_LIST (type
);
329 /* Mangle a record type. If a nonzero value is returned, it means
330 that a 'N' was emitted (so that a matching 'E' can be emitted if
331 necessary.) FOR_POINTER indicates that this element is for a pointer
332 symbol, meaning it was preceded by a 'P'. */
335 mangle_record_type (tree type
, int for_pointer
)
342 /* Does this name have a package qualifier? */
343 qualified
= QUALIFIED_P (DECL_NAME (TYPE_NAME (type
)));
346 do { obstack_1grow (mangle_obstack, 'N'); nadded_p = 1; } while (0)
348 if (TREE_CODE (type
) != RECORD_TYPE
)
351 if (!TYPE_PACKAGE_LIST (type
))
352 set_type_package_list (type
);
354 match
= find_compression_record_match (type
, ¤t
);
357 /* If we had a pointer, and there's more, we need to emit
358 'N' after 'P' (for_pointer tells us we already emitted it.) */
359 if (for_pointer
&& current
)
361 emit_compression_string (match
);
365 /* Add the new type to the table */
366 compression_table_add (TREE_PURPOSE (current
));
367 /* Add 'N' if we never got a chance to, but only if we have a qualified
368 name. For non-pointer elements, the name is always qualified. */
369 if ((qualified
|| !for_pointer
) && !nadded_p
)
371 /* Use the bare type name for the mangle. */
372 append_gpp_mangled_name (IDENTIFIER_POINTER (TREE_VALUE (current
)),
373 IDENTIFIER_LENGTH (TREE_VALUE (current
)));
374 current
= TREE_CHAIN (current
);
380 /* Mangle a pointer type. There are two cases: the pointer is already
381 in the compression table: the compression is emitted sans 'P'
382 indicator. Otherwise, a 'P' is emitted and, depending on the type,
383 a partial compression or/plus the rest of the mangling. */
386 mangle_pointer_type (tree type
)
391 /* Search for the type already in the compression table */
392 if ((match
= find_compression_pointer_match (type
)) >= 0)
394 emit_compression_string (match
);
398 /* This didn't work. We start by mangling the pointed-to type */
400 type
= TREE_TYPE (type
);
401 if (TREE_CODE (type
) != RECORD_TYPE
)
404 obstack_1grow (mangle_obstack
, 'P');
405 if (mangle_record_type (type
, /* for_pointer = */ 1))
406 obstack_1grow (mangle_obstack
, 'E');
408 /* Don't forget to insert the pointer type in the table */
409 compression_table_add (pointer_type
);
412 /* Mangle an array type. Search for an easy solution first, then go
413 through the process of finding out whether the bare array type or even
414 the template indicator were already used and compressed appropriately.
415 It handles pointers. */
418 mangle_array_type (tree p_type
)
423 type
= TREE_TYPE (p_type
);
427 elt_type
= TYPE_ARRAY_ELEMENT (type
);
429 /* We cache a bit of the Jarray <> mangle. */
432 atms
= get_identifier ("6JArray");
435 /* Maybe we have what we're looking for in the compression table. */
436 if ((match
= find_compression_array_match (p_type
)) >= 0)
438 emit_compression_string (match
);
442 /* We know for a fact that all arrays are pointers */
443 obstack_1grow (mangle_obstack
, 'P');
444 /* Maybe we already have a Jarray<t> somewhere. PSx_ will be enough. */
445 if ((match
= find_compression_record_match (type
, NULL
)) > 0)
447 emit_compression_string (match
);
451 /* Maybe we already have just JArray somewhere */
452 if ((match
= find_compression_array_template_match (atms
)) > 0)
453 emit_compression_string (match
);
456 /* Start the template mangled name */
457 obstack_grow (mangle_obstack
,
458 IDENTIFIER_POINTER (atms
), IDENTIFIER_LENGTH (atms
));
459 /* Insert in the compression table */
460 compression_table_add (atms
);
463 /* Mangle Jarray <elt_type> */
464 obstack_1grow (mangle_obstack
, 'I');
465 mangle_type (elt_type
);
466 obstack_1grow (mangle_obstack
, 'E');
468 /* Add `Jarray <elt_type>' and `Jarray <elt_type> *' to the table */
469 compression_table_add (type
);
470 compression_table_add (p_type
);
473 /* Write a substitution string for entry I. Substitution string starts a
474 -1 (encoded S_.) The base is 36, and the code shamelessly taken from
478 emit_compression_string (int i
)
481 obstack_1grow (mangle_obstack
, 'S');
484 static const char digits
[] = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ";
485 unsigned HOST_WIDE_INT n
;
486 unsigned HOST_WIDE_INT m
=1;
487 /* How many digits for I in base 36? */
488 for (n
= i
; n
>= 36; n
/= 36, m
*=36);
489 /* Write the digits out */
493 obstack_1grow (mangle_obstack
, digits
[digit
]);
498 obstack_1grow (mangle_obstack
, '_');
501 /* If search the compression table at index I for a pointer type
502 equivalent to TYPE (meaning that after all the indirection, which
503 might all be unique, we find the same RECORD_TYPE.) */
506 entry_match_pointer_p (tree type
, int i
)
508 tree t
= TREE_VEC_ELT (compression_table
, i
);
510 while (TREE_CODE (type
) == POINTER_TYPE
511 && TREE_CODE (t
) == POINTER_TYPE
)
514 type
= TREE_TYPE (type
);
516 return (TREE_CODE (type
) == RECORD_TYPE
517 && TREE_CODE (t
) == RECORD_TYPE
521 /* Go through all qualification of type and build a list of list node
522 elements containings as a purpose what should be used for a match and
523 inserted in the compression table; and as it value the raw name of the
524 part. The result is stored in TYPE_PACKAGE_LIST to be reused. */
527 set_type_package_list (tree type
)
530 const char *type_string
= IDENTIFIER_POINTER (DECL_NAME (TYPE_NAME (type
)));
533 tree list
= NULL_TREE
, elt
;
535 for (ptr
= (char *)type_string
, qualifications
= 0; *ptr
; ptr
++)
539 for (ptr
= (char *)type_string
, i
= 0; i
< qualifications
; ptr
++)
546 /* Can't use an obstack, we're already using it to
547 accumulate the mangling. */
550 identifier
= get_identifier (type_string
);
552 elt
= build_tree_list (identifier
, identifier
);
553 TREE_CHAIN (elt
) = list
;
560 elt
= build_tree_list (type
, get_identifier (type_string
));
561 TREE_CHAIN (elt
) = list
;
563 TYPE_PACKAGE_LIST (type
) = nreverse (list
);
566 /* Add TYPE as the last element of the compression table. Resize the
567 compression table if necessary. */
570 compression_table_add (tree type
)
572 if (compression_next
== TREE_VEC_LENGTH (compression_table
))
574 tree
new = make_tree_vec (2*compression_next
);
577 for (i
= 0; i
< compression_next
; i
++)
578 TREE_VEC_ELT (new, i
) = TREE_VEC_ELT (compression_table
, i
);
580 compression_table
= new;
582 TREE_VEC_ELT (compression_table
, compression_next
++) = type
;
585 /* Mangling initialization routine. */
588 init_mangling (struct obstack
*obstack
)
590 mangle_obstack
= obstack
;
591 if (!compression_table
)
592 compression_table
= make_tree_vec (10);
594 /* Mangling already in progress. */
597 /* Mangled name are to be suffixed */
598 obstack_grow (mangle_obstack
, "_Z", 2);
601 /* Mangling finalization routine. The mangled name is returned as a
605 finish_mangling (void)
609 if (!compression_table
)
610 /* Mangling already finished. */
613 compression_table
= NULL_TREE
;
614 compression_next
= 0;
615 obstack_1grow (mangle_obstack
, '\0');
616 result
= get_identifier (obstack_base (mangle_obstack
));
617 obstack_free (mangle_obstack
, obstack_base (mangle_obstack
));
619 printf ("// %s\n", IDENTIFIER_POINTER (result
));
624 #include "gt-java-mangle.h"