call.c, [...]: Change my_fancy_abort() to abort().
[platform/upstream/gcc.git] / gcc / cp / mangle.c
1 /* Name mangling for the 3.0 C++ ABI.
2    Copyright (C) 2000, 2001, 2002 Free Software Foundation, Inc.
3    Written by Alex Samuel <sameul@codesourcery.com>
4
5    This file is part of GNU CC.
6
7    GNU CC is free software; you can redistribute it and/or modify it
8    under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 2, or (at your option)
10    any later version.
11
12    GNU CC is distributed in the hope that it will be useful, but
13    WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15    General Public License for more details.
16
17    You should have received a copy of the GNU General Public License
18    along with GNU CC; see the file COPYING.  If not, write to the Free
19    Software Foundation, 59 Temple Place - Suite 330, Boston, MA
20    02111-1307, USA.  */
21
22 /* This file implements mangling of C++ names according to the IA64
23    C++ ABI specification.  A mangled name encodes a function or
24    variable's name, scope, type, and/or template arguments into a text
25    identifier.  This identifier is used as the function's or
26    variable's linkage name, to preserve compatibility between C++'s
27    language features (templates, scoping, and overloading) and C
28    linkers.
29
30    Additionally, g++ uses mangled names internally.  To support this,
31    mangling of types is allowed, even though the mangled name of a
32    type should not appear by itself as an exported name.  Ditto for
33    uninstantiated templates.
34
35    The primary entry point for this module is mangle_decl, which
36    returns an identifier containing the mangled name for a decl.
37    Additional entry points are provided to build mangled names of
38    particular constructs when the appropriate decl for that construct
39    is not available.  These are:
40
41      mangle_typeinfo_for_type:        typeinfo data
42      mangle_typeinfo_string_for_type: typeinfo type name
43      mangle_vtbl_for_type:            virtual table data
44      mangle_vtt_for_type:             VTT data
45      mangle_ctor_vtbl_for_type:       `C-in-B' constructor virtual table data
46      mangle_thunk:                    thunk function or entry
47
48 */
49
50 #include "config.h"
51 #include "system.h"
52 #include "tree.h"
53 #include "cp-tree.h"
54 #include "obstack.h"
55 #include "toplev.h"
56 #include "varray.h"
57
58 /* Debugging support.  */
59
60 /* Define DEBUG_MANGLE to enable very verbose trace messages.  */
61 #ifndef DEBUG_MANGLE
62 #define DEBUG_MANGLE 0
63 #endif
64
65 /* Macros for tracing the write_* functions.  */
66 #if DEBUG_MANGLE
67 # define MANGLE_TRACE(FN, INPUT) \
68   fprintf (stderr, "  %-24s: %-24s\n", (FN), (INPUT))
69 # define MANGLE_TRACE_TREE(FN, NODE) \
70   fprintf (stderr, "  %-24s: %-24s (%p)\n", \
71            (FN), tree_code_name[TREE_CODE (NODE)], (void *) (NODE))
72 #else
73 # define MANGLE_TRACE(FN, INPUT)
74 # define MANGLE_TRACE_TREE(FN, NODE)
75 #endif
76
77 /* Non-zero if NODE is a class template-id.  We can't rely on
78    CLASSTYPE_USE_TEMPLATE here because of tricky bugs in the parser
79    that hard to distinguish A<T> from A, where A<T> is the type as
80    instantiated outside of the template, and A is the type used
81    without parameters inside the template.  */
82 #define CLASSTYPE_TEMPLATE_ID_P(NODE)                                 \
83   (TYPE_LANG_SPECIFIC (NODE) != NULL                                  \
84    && CLASSTYPE_TEMPLATE_INFO (NODE) != NULL                          \
85    && (PRIMARY_TEMPLATE_P (CLASSTYPE_TI_TEMPLATE (NODE))))
86
87 /* Things we only need one of.  This module is not reentrant.  */
88 static struct globals
89 {
90   /* The name in which we're building the mangled name.  */
91   struct obstack name_obstack;
92
93   /* An array of the current substitution candidates, in the order
94      we've seen them.  */
95   varray_type substitutions;
96 } G;
97
98 /* Indices into subst_identifiers.  These are identifiers used in
99    special substitution rules.  */
100 typedef enum
101 {
102   SUBID_ALLOCATOR,
103   SUBID_BASIC_STRING,
104   SUBID_CHAR_TRAITS,
105   SUBID_BASIC_ISTREAM,
106   SUBID_BASIC_OSTREAM,
107   SUBID_BASIC_IOSTREAM,
108   SUBID_MAX
109 }
110 substitution_identifier_index_t;
111
112 /* For quick substitution checks, look up these common identifiers
113    once only.  */
114 static tree subst_identifiers[SUBID_MAX];
115
116 /* Single-letter codes for builtin integer types, defined in
117    <builtin-type>.  These are indexed by integer_type_kind values.  */
118 static char
119 integer_type_codes[itk_none] =
120 {
121   'c',  /* itk_char */
122   'a',  /* itk_signed_char */
123   'h',  /* itk_unsigned_char */
124   's',  /* itk_short */
125   't',  /* itk_unsigned_short */
126   'i',  /* itk_int */
127   'j',  /* itk_unsigned_int */
128   'l',  /* itk_long */
129   'm',  /* itk_unsigned_long */
130   'x',  /* itk_long_long */
131   'y'   /* itk_unsigned_long_long */
132 };
133
134 static int decl_is_template_id PARAMS ((tree, tree*));
135
136 /* Functions for handling substitutions.  */
137
138 static inline tree canonicalize_for_substitution PARAMS ((tree));
139 static void add_substitution PARAMS ((tree));
140 static inline int is_std_substitution PARAMS ((tree, substitution_identifier_index_t));
141 static inline int is_std_substitution_char PARAMS ((tree, substitution_identifier_index_t));
142 static int find_substitution PARAMS ((tree));
143
144 /* Functions for emitting mangled representations of things.  */
145
146 static void write_mangled_name PARAMS ((tree));
147 static void write_encoding PARAMS ((tree));
148 static void write_name PARAMS ((tree, int));
149 static void write_unscoped_name PARAMS ((tree));
150 static void write_unscoped_template_name PARAMS ((tree));
151 static void write_nested_name PARAMS ((tree));
152 static void write_prefix PARAMS ((tree));
153 static void write_template_prefix PARAMS ((tree));
154 static void write_unqualified_name PARAMS ((tree));
155 static void write_source_name PARAMS ((tree));
156 static int hwint_to_ascii PARAMS ((unsigned HOST_WIDE_INT, unsigned int, char *, unsigned));
157 static void write_number PARAMS ((unsigned HOST_WIDE_INT, int,
158                                   unsigned int));
159 static void write_integer_cst PARAMS ((tree));
160 static void write_identifier PARAMS ((const char *));
161 static void write_special_name_constructor PARAMS ((tree));
162 static void write_special_name_destructor PARAMS ((tree));
163 static void write_type PARAMS ((tree));
164 static int write_CV_qualifiers_for_type PARAMS ((tree));
165 static void write_builtin_type PARAMS ((tree));
166 static void write_function_type PARAMS ((tree));
167 static void write_bare_function_type PARAMS ((tree, int, tree));
168 static void write_method_parms PARAMS ((tree, int, tree));
169 static void write_class_enum_type PARAMS ((tree));
170 static void write_template_args PARAMS ((tree));
171 static void write_expression PARAMS ((tree));
172 static void write_template_arg_literal PARAMS ((tree));
173 static void write_template_arg PARAMS ((tree));
174 static void write_template_template_arg PARAMS ((tree));
175 static void write_array_type PARAMS ((tree));
176 static void write_pointer_to_member_type PARAMS ((tree));
177 static void write_template_param PARAMS ((tree));
178 static void write_template_template_param PARAMS ((tree));
179 static void write_substitution PARAMS ((int));
180 static int discriminator_for_local_entity PARAMS ((tree));
181 static int discriminator_for_string_literal PARAMS ((tree, tree));
182 static void write_discriminator PARAMS ((int));
183 static void write_local_name PARAMS ((tree, tree, tree));
184 static void dump_substitution_candidates PARAMS ((void));
185 static const char *mangle_decl_string PARAMS ((tree));
186
187 /* Control functions.  */
188
189 static inline void start_mangling PARAMS ((void));
190 static inline const char *finish_mangling PARAMS ((void));
191 static tree mangle_special_for_type PARAMS ((tree, const char *));
192
193 /* Foreign language functions. */
194
195 static void write_java_integer_type_codes PARAMS ((tree));
196
197 /* Append a single character to the end of the mangled
198    representation.  */
199 #define write_char(CHAR)                                              \
200   obstack_1grow (&G.name_obstack, (CHAR))
201
202 /* Append a sized buffer to the end of the mangled representation. */
203 #define write_chars(CHAR, LEN)                                        \
204   obstack_grow (&G.name_obstack, (CHAR), (LEN))
205
206 /* Append a NUL-terminated string to the end of the mangled
207    representation.  */
208 #define write_string(STRING)                                          \
209   obstack_grow (&G.name_obstack, (STRING), strlen (STRING))
210
211 /* Return the position at which the next character will be appended to
212    the mangled representation.  */
213 #define mangled_position()                                              \
214   obstack_object_size (&G.name_obstack)
215
216 /* Non-zero if NODE1 and NODE2 are both TREE_LIST nodes and have the
217    same purpose (context, which may be a type) and value (template
218    decl).  See write_template_prefix for more information on what this
219    is used for.  */
220 #define NESTED_TEMPLATE_MATCH(NODE1, NODE2)                         \
221   (TREE_CODE (NODE1) == TREE_LIST                                     \
222    && TREE_CODE (NODE2) == TREE_LIST                                  \
223    && ((TYPE_P (TREE_PURPOSE (NODE1))                                 \
224         && same_type_p (TREE_PURPOSE (NODE1), TREE_PURPOSE (NODE2)))\
225        || TREE_PURPOSE (NODE1) == TREE_PURPOSE (NODE2))             \
226    && TREE_VALUE (NODE1) == TREE_VALUE (NODE2))
227
228 /* Write out a signed quantity in base 10.  */
229 #define write_signed_number(NUMBER) \
230   write_number ((NUMBER), /*unsigned_p=*/0, 10)
231
232 /* Write out an unsigned quantity in base 10.  */
233 #define write_unsigned_number(NUMBER) \
234   write_number ((NUMBER), /*unsigned_p=*/1, 10)
235
236 /* If DECL is a template instance, return non-zero and, if
237    TEMPLATE_INFO is non-NULL, set *TEMPLATE_INFO to its template info.
238    Otherwise return zero.  */
239
240 static int
241 decl_is_template_id (decl, template_info)
242      tree decl;
243      tree* template_info;
244 {
245   if (TREE_CODE (decl) == TYPE_DECL)
246     {
247       /* TYPE_DECLs are handled specially.  Look at its type to decide
248          if this is a template instantiation.  */
249       tree type = TREE_TYPE (decl);
250
251       if (CLASS_TYPE_P (type) && CLASSTYPE_TEMPLATE_ID_P (type))
252         {
253           if (template_info != NULL)
254             /* For a templated TYPE_DECL, the template info is hanging
255                off the type.  */
256             *template_info = CLASSTYPE_TEMPLATE_INFO (type);
257           return 1;
258         }
259     } 
260   else
261     {
262       /* Check if this is a primary template.  */
263       if (DECL_LANG_SPECIFIC (decl) != NULL
264           && DECL_USE_TEMPLATE (decl)
265           && PRIMARY_TEMPLATE_P (DECL_TI_TEMPLATE (decl))
266           && TREE_CODE (decl) != TEMPLATE_DECL)
267         {
268           if (template_info != NULL)
269             /* For most templated decls, the template info is hanging
270                off the decl.  */
271             *template_info = DECL_TEMPLATE_INFO (decl);
272           return 1;
273         }
274     }
275
276   /* It's not a template id.  */
277   return 0;
278 }
279
280 /* Produce debugging output of current substitution candidates.  */
281
282 static void
283 dump_substitution_candidates ()
284 {
285   unsigned i;
286
287   fprintf (stderr, "  ++ substitutions  ");
288   for (i = 0; i < VARRAY_ACTIVE_SIZE (G.substitutions); ++i)
289     {
290       tree el = VARRAY_TREE (G.substitutions, i);
291       const char *name = "???";
292
293       if (i > 0)
294         fprintf (stderr, "                    ");
295       if (DECL_P (el))
296         name = IDENTIFIER_POINTER (DECL_NAME (el));
297       else if (TREE_CODE (el) == TREE_LIST)
298         name = IDENTIFIER_POINTER (DECL_NAME (TREE_VALUE (el)));
299       else if (TYPE_NAME (el))
300         name = IDENTIFIER_POINTER (DECL_NAME (TYPE_NAME (el)));
301       fprintf (stderr, " S%d_ = ", i - 1);
302       if (TYPE_P (el) && 
303           (CP_TYPE_RESTRICT_P (el) 
304            || CP_TYPE_VOLATILE_P (el) 
305            || CP_TYPE_CONST_P (el)))
306         fprintf (stderr, "CV-");
307       fprintf (stderr, "%s (%s at %p)\n", 
308                name, tree_code_name[TREE_CODE (el)], (void *) el);
309     }
310 }
311
312 /* Both decls and types can be substitution candidates, but sometimes
313    they refer to the same thing.  For instance, a TYPE_DECL and
314    RECORD_TYPE for the same class refer to the same thing, and should
315    be treated accordinginly in substitutions.  This function returns a
316    canonicalized tree node representing NODE that is used when adding
317    and substitution candidates and finding matches.  */
318
319 static inline tree
320 canonicalize_for_substitution (node)
321      tree node;
322 {
323   /* For a TYPE_DECL, use the type instead.  */
324   if (TREE_CODE (node) == TYPE_DECL)
325     node = TREE_TYPE (node);
326   if (TYPE_P (node))
327     node = canonical_type_variant (node);
328
329   return node;
330 }
331
332 /* Add NODE as a substitution candidate.  NODE must not already be on
333    the list of candidates.  */
334
335 static void
336 add_substitution (node)
337      tree node;
338 {
339   tree c;
340
341   if (DEBUG_MANGLE)
342     fprintf (stderr, "  ++ add_substitution (%s at %10p)\n", 
343              tree_code_name[TREE_CODE (node)], (void *) node);
344
345   /* Get the canonicalized substitution candidate for NODE.  */
346   c = canonicalize_for_substitution (node);
347   if (DEBUG_MANGLE && c != node)
348     fprintf (stderr, "  ++ using candidate (%s at %10p)\n",
349              tree_code_name[TREE_CODE (node)], (void *) node);
350   node = c;
351
352 #if ENABLE_CHECKING
353   /* Make sure NODE isn't already a candidate.  */
354   {
355     int i;
356     for (i = VARRAY_ACTIVE_SIZE (G.substitutions); --i >= 0; )
357       {
358         tree candidate = VARRAY_TREE (G.substitutions, i);
359         if ((DECL_P (node) 
360              && node == candidate)
361             || (TYPE_P (node) 
362                 && TYPE_P (candidate) 
363                 && same_type_p (node, candidate)))
364           abort ();
365       }
366   }
367 #endif /* ENABLE_CHECKING */
368
369   /* Put the decl onto the varray of substitution candidates.  */
370   VARRAY_PUSH_TREE (G.substitutions, node);
371
372   if (DEBUG_MANGLE)
373     dump_substitution_candidates ();
374 }
375
376 /* Helper function for find_substitution.  Returns non-zero if NODE,
377    which may be a decl or a CLASS_TYPE, is a template-id with template
378    name of substitution_index[INDEX] in the ::std namespace.  */
379
380 static inline int 
381 is_std_substitution (node, index)
382      tree node;
383      substitution_identifier_index_t index;
384 {
385   tree type = NULL;
386   tree decl = NULL;
387
388   if (DECL_P (node))
389     {
390       type = TREE_TYPE (node);
391       decl = node;
392     }
393   else if (CLASS_TYPE_P (node))
394     {
395       type = node;
396       decl = TYPE_NAME (node);
397     }
398   else 
399     /* These are not the droids you're looking for.  */
400     return 0;
401
402   return (DECL_NAMESPACE_STD_P (CP_DECL_CONTEXT (decl))
403           && TYPE_LANG_SPECIFIC (type) 
404           && CLASSTYPE_TEMPLATE_INFO (type)
405           && (DECL_NAME (CLASSTYPE_TI_TEMPLATE (type)) 
406               == subst_identifiers[index]));
407 }
408
409 /* Helper function for find_substitution.  Returns non-zero if NODE,
410    which may be a decl or a CLASS_TYPE, is the template-id
411    ::std::identifier<char>, where identifier is
412    substitution_index[INDEX].  */
413
414 static inline int
415 is_std_substitution_char (node, index)
416      tree node;
417      substitution_identifier_index_t index;
418 {
419   tree args;
420   /* Check NODE's name is ::std::identifier.  */
421   if (!is_std_substitution (node, index))
422     return 0;
423   /* Figure out its template args.  */
424   if (DECL_P (node))
425     args = DECL_TI_ARGS (node);  
426   else if (CLASS_TYPE_P (node))
427     args = CLASSTYPE_TI_ARGS (node);
428   else
429     /* Oops, not a template.  */
430     return 0;
431   /* NODE's template arg list should be <char>.  */
432   return 
433     TREE_VEC_LENGTH (args) == 1
434     && TREE_VEC_ELT (args, 0) == char_type_node;
435 }
436
437 /* Check whether a substitution should be used to represent NODE in
438    the mangling.
439
440    First, check standard special-case substitutions.
441
442      <substitution> ::= St     
443          # ::std
444
445                     ::= Sa     
446          # ::std::allocator
447
448                     ::= Sb     
449          # ::std::basic_string
450
451                     ::= Ss 
452          # ::std::basic_string<char,
453                                ::std::char_traits<char>,
454                                ::std::allocator<char> >
455
456                     ::= Si 
457          # ::std::basic_istream<char, ::std::char_traits<char> >
458
459                     ::= So 
460          # ::std::basic_ostream<char, ::std::char_traits<char> >
461
462                     ::= Sd 
463          # ::std::basic_iostream<char, ::std::char_traits<char> >   
464
465    Then examine the stack of currently available substitution
466    candidates for entities appearing earlier in the same mangling
467
468    If a substitution is found, write its mangled representation and
469    return non-zero.  If none is found, just return zero.  */
470
471 static int
472 find_substitution (node)
473      tree node;
474 {
475   int i;
476   int size = VARRAY_ACTIVE_SIZE (G.substitutions);
477   tree decl;
478   tree type;
479
480   if (DEBUG_MANGLE)
481     fprintf (stderr, "  ++ find_substitution (%s at %p)\n",
482              tree_code_name[TREE_CODE (node)], (void *) node);
483
484   /* Obtain the canonicalized substitution representation for NODE.
485      This is what we'll compare against.  */
486   node = canonicalize_for_substitution (node);
487
488   /* Check for builtin substitutions.  */
489
490   decl = TYPE_P (node) ? TYPE_NAME (node) : node;
491   type = TYPE_P (node) ? node : TREE_TYPE (node);
492
493   /* Check for std::allocator.  */
494   if (decl 
495       && is_std_substitution (decl, SUBID_ALLOCATOR)
496       && !CLASSTYPE_USE_TEMPLATE (TREE_TYPE (decl)))
497     {
498       write_string ("Sa");
499       return 1;
500     }
501
502   /* Check for std::basic_string.  */
503   if (decl && is_std_substitution (decl, SUBID_BASIC_STRING))
504     {
505       if (TYPE_P (node))
506         {
507           /* If this is a type (i.e. a fully-qualified template-id), 
508              check for 
509                  std::basic_string <char,
510                                     std::char_traits<char>,
511                                     std::allocator<char> > .  */
512           if (cp_type_quals (type) == TYPE_UNQUALIFIED
513               && CLASSTYPE_USE_TEMPLATE (type))
514             {
515               tree args = CLASSTYPE_TI_ARGS (type);
516               if (TREE_VEC_LENGTH (args) == 3
517                   && same_type_p (TREE_VEC_ELT (args, 0), char_type_node)
518                   && is_std_substitution_char (TREE_VEC_ELT (args, 1),
519                                                SUBID_CHAR_TRAITS)
520                   && is_std_substitution_char (TREE_VEC_ELT (args, 2),
521                                                SUBID_ALLOCATOR))
522                 {
523                   write_string ("Ss");
524                   return 1;
525                 }
526             }
527         }
528       else
529         /* Substitute for the template name only if this isn't a type.  */
530         {
531           write_string ("Sb");
532           return 1;
533         }
534     }
535
536   /* Check for basic_{i,o,io}stream.  */
537   if (TYPE_P (node)
538       && cp_type_quals (type) == TYPE_UNQUALIFIED
539       && CLASS_TYPE_P (type)
540       && CLASSTYPE_USE_TEMPLATE (type)
541       && CLASSTYPE_TEMPLATE_INFO (type) != NULL)
542     {
543       /* First, check for the template 
544          args <char, std::char_traits<char> > .  */
545       tree args = CLASSTYPE_TI_ARGS (type);
546       if (TREE_VEC_LENGTH (args) == 2
547           && same_type_p (TREE_VEC_ELT (args, 0), char_type_node)
548           && is_std_substitution_char (TREE_VEC_ELT (args, 1),
549                                        SUBID_CHAR_TRAITS))
550         {
551           /* Got them.  Is this basic_istream?  */
552           tree name = DECL_NAME (CLASSTYPE_TI_TEMPLATE (type));
553           if (name == subst_identifiers[SUBID_BASIC_ISTREAM])
554             {
555               write_string ("Si");
556               return 1;
557             }
558           /* Or basic_ostream?  */
559           else if (name == subst_identifiers[SUBID_BASIC_OSTREAM])
560             {
561               write_string ("So");
562               return 1;
563             }
564           /* Or basic_iostream?  */
565           else if (name == subst_identifiers[SUBID_BASIC_IOSTREAM])
566             {
567               write_string ("Sd");
568               return 1;
569             }
570         }
571     }
572
573   /* Check for namespace std.  */
574   if (decl && DECL_NAMESPACE_STD_P (decl))
575     {
576       write_string ("St");
577       return 1;
578     }
579
580   /* Now check the list of available substitutions for this mangling
581      operation.    */
582   for (i = 0; i < size; ++i)
583     {
584       tree candidate = VARRAY_TREE (G.substitutions, i);
585       /* NODE is a matched to a candidate if it's the same decl node or
586          if it's the same type.  */
587       if (decl == candidate
588           || (TYPE_P (candidate) && type && TYPE_P (type)
589               && same_type_p (type, candidate))
590           || NESTED_TEMPLATE_MATCH (node, candidate))
591         {
592           write_substitution (i);
593           return 1;
594         }
595     }
596
597   /* No substitution found.  */
598   return 0;
599 }
600
601
602 /*  <mangled-name>      ::= _Z <encoding>  */
603
604 static inline void
605 write_mangled_name (decl)
606      tree decl;
607 {
608   MANGLE_TRACE_TREE ("mangled-name", decl);
609
610   if (DECL_LANG_SPECIFIC (decl)
611       && DECL_EXTERN_C_FUNCTION_P (decl)
612       && ! DECL_OVERLOADED_OPERATOR_P (decl))
613     /* The standard notes:
614          "The <encoding> of an extern "C" function is treated like
615          global-scope data, i.e. as its <source-name> without a type."
616        We cannot write overloaded operators that way though,
617        because it contains characters invalid in assembler.  */
618     write_source_name (DECL_NAME (decl));
619   else
620     /* C++ name; needs to be mangled.  */
621     {
622       write_string ("_Z");
623       write_encoding (decl);
624     }
625 }
626
627 /*   <encoding>         ::= <function name> <bare-function-type>
628                         ::= <data name>  */
629
630 static void
631 write_encoding (decl)
632      tree decl;
633 {
634   MANGLE_TRACE_TREE ("encoding", decl);
635
636   if (DECL_LANG_SPECIFIC (decl) && DECL_EXTERN_C_FUNCTION_P (decl))
637     {
638       /* For overloaded operators write just the mangled name
639          without arguments.  */
640       if (DECL_OVERLOADED_OPERATOR_P (decl))
641         write_name (decl, /*ignore_local_scope=*/0);
642       else
643         write_source_name (DECL_NAME (decl));
644       return;
645     }
646
647   write_name (decl, /*ignore_local_scope=*/0);
648   if (TREE_CODE (decl) == FUNCTION_DECL)
649     {
650       tree fn_type;
651
652       if (decl_is_template_id (decl, NULL))
653         fn_type = get_mostly_instantiated_function_type (decl, NULL, NULL);
654       else
655         fn_type = TREE_TYPE (decl);
656
657       write_bare_function_type (fn_type, 
658                                 (!DECL_CONSTRUCTOR_P (decl)
659                                  && !DECL_DESTRUCTOR_P (decl)
660                                  && !DECL_CONV_FN_P (decl)
661                                  && decl_is_template_id (decl, NULL)),
662                                 decl);
663     }
664 }
665
666 /* <name> ::= <unscoped-name>
667           ::= <unscoped-template-name> <template-args>
668           ::= <nested-name>
669           ::= <local-name>  
670
671    If IGNORE_LOCAL_SCOPE is non-zero, this production of <name> is
672    called from <local-name>, which mangles the enclosing scope
673    elsewhere and then uses this function to mangle just the part
674    underneath the function scope.  So don't use the <local-name>
675    production, to avoid an infinite recursion.  */
676
677 static void
678 write_name (decl, ignore_local_scope)
679      tree decl;
680      int ignore_local_scope;
681 {
682   tree context;
683
684   MANGLE_TRACE_TREE ("name", decl);
685
686   if (TREE_CODE (decl) == TYPE_DECL)
687     {
688       /* In case this is a typedef, fish out the corresponding
689          TYPE_DECL for the main variant.  */
690       decl = TYPE_NAME (TYPE_MAIN_VARIANT (TREE_TYPE (decl)));
691       context = TYPE_CONTEXT (TYPE_MAIN_VARIANT (TREE_TYPE (decl)));
692     }
693   else
694     context = (DECL_CONTEXT (decl) == NULL) ? NULL : CP_DECL_CONTEXT (decl);
695
696   /* A decl in :: or ::std scope is treated specially.  The former is
697      mangled using <unscoped-name> or <unscoped-template-name>, the
698      latter with a special substitution.  Also, a name that is
699      directly in a local function scope is also mangled with
700      <unscoped-name> rather than a full <nested-name>.  */
701   if (context == NULL 
702       || context == global_namespace 
703       || DECL_NAMESPACE_STD_P (context)
704       || (ignore_local_scope && TREE_CODE (context) == FUNCTION_DECL))
705     {
706       tree template_info;
707       /* Is this a template instance?  */
708       if (decl_is_template_id (decl, &template_info))
709         {
710           /* Yes: use <unscoped-template-name>.  */
711           write_unscoped_template_name (TI_TEMPLATE (template_info));
712           write_template_args (TI_ARGS (template_info));
713         }
714       else
715         /* Everything else gets an <unqualified-name>.  */
716         write_unscoped_name (decl);
717     }
718   else
719     {
720       /* Handle local names, unless we asked not to (that is, invoked
721          under <local-name>, to handle only the part of the name under
722          the local scope).  */
723       if (!ignore_local_scope)
724         {
725           /* Scan up the list of scope context, looking for a
726              function.  If we find one, this entity is in local
727              function scope.  local_entity tracks context one scope
728              level down, so it will contain the element that's
729              directly in that function's scope, either decl or one of
730              its enclosing scopes.  */
731           tree local_entity = decl;
732           while (context != NULL && context != global_namespace)
733             {
734               /* Make sure we're always dealing with decls.  */
735               if (context != NULL && TYPE_P (context))
736                 context = TYPE_NAME (context);
737               /* Is this a function?  */
738               if (TREE_CODE (context) == FUNCTION_DECL)
739                 {
740                   /* Yes, we have local scope.  Use the <local-name>
741                      production for the innermost function scope.  */
742                   write_local_name (context, local_entity, decl);
743                   return;
744                 }
745               /* Up one scope level.  */
746               local_entity = context;
747               context = CP_DECL_CONTEXT (context);
748             }
749
750           /* No local scope found?  Fall through to <nested-name>.  */
751         }
752
753       /* Other decls get a <nested-name> to encode their scope.  */
754       write_nested_name (decl);
755     }
756 }
757
758 /* <unscoped-name> ::= <unqualified-name>
759                    ::= St <unqualified-name>   # ::std::  */
760
761 static void
762 write_unscoped_name (decl)
763      tree decl;
764 {
765   tree context = CP_DECL_CONTEXT (decl);
766
767   MANGLE_TRACE_TREE ("unscoped-name", decl);
768
769   /* Is DECL in ::std?  */
770   if (DECL_NAMESPACE_STD_P (context))
771     {
772       write_string ("St");
773       write_unqualified_name (decl);
774     }
775   /* If not, it should be either in the global namespace, or directly
776      in a local function scope.  */
777   else if (context == global_namespace 
778            || context == NULL
779            || TREE_CODE (context) == FUNCTION_DECL)
780     write_unqualified_name (decl);
781   else 
782     abort ();
783 }
784
785 /* <unscoped-template-name> ::= <unscoped-name>
786                             ::= <substitution>  */
787
788 static void
789 write_unscoped_template_name (decl)
790      tree decl;
791 {
792   MANGLE_TRACE_TREE ("unscoped-template-name", decl);
793
794   if (find_substitution (decl))
795     return;
796   write_unscoped_name (decl);
797   add_substitution (decl);
798 }
799
800 /* Write the nested name, including CV-qualifiers, of DECL.
801
802    <nested-name> ::= N [<CV-qualifiers>] <prefix> <unqualified-name> E  
803                  ::= N [<CV-qualifiers>] <template-prefix> <template-args> E
804
805    <CV-qualifiers> ::= [r] [V] [K]  */
806
807 static void
808 write_nested_name (decl)
809      tree decl;
810 {
811   tree template_info;
812
813   MANGLE_TRACE_TREE ("nested-name", decl);
814
815   write_char ('N');
816   
817   /* Write CV-qualifiers, if this is a member function.  */
818   if (TREE_CODE (decl) == FUNCTION_DECL 
819       && DECL_NONSTATIC_MEMBER_FUNCTION_P (decl))
820     {
821       if (DECL_VOLATILE_MEMFUNC_P (decl))
822         write_char ('V');
823       if (DECL_CONST_MEMFUNC_P (decl))
824         write_char ('K');
825     }
826
827   /* Is this a template instance?  */
828   if (decl_is_template_id (decl, &template_info))
829     {
830       /* Yes, use <template-prefix>.  */
831       write_template_prefix (decl);
832       write_template_args (TI_ARGS (template_info));
833     }
834   else
835     {
836       /* No, just use <prefix>  */
837       write_prefix (DECL_CONTEXT (decl));
838       write_unqualified_name (decl);
839     }
840   write_char ('E');
841 }
842
843 /* <prefix> ::= <prefix> <unqualified-name>>
844             ::= <template-prefix> <template-args>
845             ::= # empty
846             ::= <substitution>  */
847
848 static void
849 write_prefix (node)
850      tree node;
851 {
852   tree decl;
853   /* Non-NULL if NODE represents a template-id.  */
854   tree template_info = NULL;
855
856   MANGLE_TRACE_TREE ("prefix", node);
857
858   if (node == NULL
859       || node == global_namespace)
860     return;
861
862   if (find_substitution (node))
863     return;
864
865   if (DECL_P (node))
866     /* Node is a decl.  */
867     {
868       /* If this is a function decl, that means we've hit function
869          scope, so this prefix must be for a local name.  In this
870          case, we're under the <local-name> production, which encodes
871          the enclosing function scope elsewhere.  So don't continue
872          here.  */
873       if (TREE_CODE (node) == FUNCTION_DECL)
874         return;
875
876       decl = node;
877       decl_is_template_id (decl, &template_info);
878     }
879   else
880     /* Node is a type.  */
881     {
882       decl = TYPE_NAME (node);
883       if (CLASSTYPE_TEMPLATE_ID_P (node))
884         template_info = CLASSTYPE_TEMPLATE_INFO (node);
885     }
886
887   if (template_info != NULL)
888     /* Templated.  */
889     {
890       write_template_prefix (decl);
891       write_template_args (TI_ARGS (template_info));
892     }
893   else
894     /* Not templated.  */
895     {
896       write_prefix (CP_DECL_CONTEXT (decl));
897       write_unqualified_name (decl);
898     }
899
900   add_substitution (node);
901 }
902
903 /* <template-prefix> ::= <prefix> <template component>
904                      ::= <substitution>  */
905
906 static void
907 write_template_prefix (node)
908      tree node;
909 {
910   tree decl = DECL_P (node) ? node : TYPE_NAME (node);
911   tree type = DECL_P (node) ? TREE_TYPE (node) : node;
912   tree context = CP_DECL_CONTEXT (decl);
913   tree template_info;
914   tree template;
915   tree substitution;
916
917   MANGLE_TRACE_TREE ("template-prefix", node);
918
919   /* Find the template decl.  */
920   if (decl_is_template_id (decl, &template_info))
921     template = TI_TEMPLATE (template_info);
922   else if (CLASSTYPE_TEMPLATE_ID_P (type))
923     template = CLASSTYPE_TI_TEMPLATE (type);
924   else
925     /* Oops, not a template.  */
926     abort ();
927
928   /* For a member template, though, the template name for the
929      innermost name must have all the outer template levels
930      instantiated.  For instance, consider
931
932        template<typename T> struct Outer {
933          template<typename U> struct Inner {};
934        };
935
936      The template name for `Inner' in `Outer<int>::Inner<float>' is
937      `Outer<int>::Inner<U>'.  In g++, we don't instantiate the template
938      levels separately, so there's no TEMPLATE_DECL available for this
939      (there's only `Outer<T>::Inner<U>').
940
941      In order to get the substitutions right, we create a special
942      TREE_LIST to represent the substitution candidate for a nested
943      template.  The TREE_PURPOSE is the template's context, fully
944      instantiated, and the TREE_VALUE is the TEMPLATE_DECL for the inner
945      template.
946
947      So, for the example above, `Outer<int>::Inner' is represented as a
948      substitution candidate by a TREE_LIST whose purpose is `Outer<int>'
949      and whose value is `Outer<T>::Inner<U>'.  */
950   if (TYPE_P (context))
951     substitution = build_tree_list (context, template);
952   else
953     substitution = template;
954
955   if (find_substitution (substitution))
956     return;
957
958   write_prefix (context);
959   write_unqualified_name (decl);
960
961   add_substitution (substitution);
962 }
963
964 /* We don't need to handle thunks, vtables, or VTTs here.  Those are
965    mangled through special entry points.  
966
967     <unqualified-name>  ::= <operator-name>
968                         ::= <special-name>  
969                         ::= <source-name>  */
970
971 static void
972 write_unqualified_name (decl)
973      tree decl;
974 {
975   MANGLE_TRACE_TREE ("unqualified-name", decl);
976
977   if (DECL_LANG_SPECIFIC (decl) != NULL && DECL_CONSTRUCTOR_P (decl))
978     write_special_name_constructor (decl);
979   else if (DECL_LANG_SPECIFIC (decl) != NULL && DECL_DESTRUCTOR_P (decl))
980     write_special_name_destructor (decl);
981   else if (DECL_CONV_FN_P (decl)) 
982     {
983       /* Conversion operator. Handle it right here.  
984            <operator> ::= cv <type>  */
985       write_string ("cv");
986       write_type (TREE_TYPE (DECL_NAME (decl)));
987     }
988   else if (DECL_OVERLOADED_OPERATOR_P (decl))
989     {
990       operator_name_info_t *oni;
991       if (DECL_ASSIGNMENT_OPERATOR_P (decl))
992         oni = assignment_operator_name_info;
993       else
994         oni = operator_name_info;
995       
996       write_string (oni[DECL_OVERLOADED_OPERATOR_P (decl)].mangled_name);
997     }
998   else
999     write_source_name (DECL_NAME (decl));
1000 }
1001
1002 /* Non-termial <source-name>.  IDENTIFIER is an IDENTIFIER_NODE.  
1003
1004      <source-name> ::= </length/ number> <identifier>  */
1005
1006 static void
1007 write_source_name (identifier)
1008      tree identifier;
1009 {
1010   MANGLE_TRACE_TREE ("source-name", identifier);
1011
1012   /* Never write the whole template-id name including the template
1013      arguments; we only want the template name.  */
1014   if (IDENTIFIER_TEMPLATE (identifier))
1015     identifier = IDENTIFIER_TEMPLATE (identifier);
1016
1017   write_unsigned_number (IDENTIFIER_LENGTH (identifier));
1018   write_identifier (IDENTIFIER_POINTER (identifier));
1019 }
1020
1021 /* Convert NUMBER to ascii using base BASE and generating at least
1022    MIN_DIGITS characters. BUFFER points to the _end_ of the buffer
1023    into which to store the characters. Returns the number of
1024    characters generated (these will be layed out in advance of where
1025    BUFFER points).  */
1026
1027 static int
1028 hwint_to_ascii (number, base, buffer, min_digits)
1029      unsigned HOST_WIDE_INT number;
1030      unsigned int base;
1031      char *buffer;
1032      unsigned min_digits;
1033 {
1034   static const char base_digits[] = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ";
1035   unsigned digits = 0;
1036   
1037   while (number)
1038     {
1039       unsigned HOST_WIDE_INT d = number / base;
1040       
1041       *--buffer = base_digits[number - d * base];
1042       digits++;
1043       number = d;
1044     }
1045   while (digits < min_digits)
1046     {
1047       *--buffer = base_digits[0];
1048       digits++;
1049     }
1050   return digits;
1051 }
1052
1053 /* Non-terminal <number>.
1054
1055      <number> ::= [n] </decimal integer/>  */
1056
1057 static void
1058 write_number (number, unsigned_p, base)
1059      unsigned HOST_WIDE_INT number;
1060      int unsigned_p;
1061      unsigned int base;
1062 {
1063   char buffer[sizeof (HOST_WIDE_INT) * 8];
1064   unsigned count = 0;
1065
1066   if (!unsigned_p && (HOST_WIDE_INT) number < 0)
1067     {
1068       write_char ('n');
1069       number = -((HOST_WIDE_INT) number);
1070     }
1071   count = hwint_to_ascii (number, base, buffer + sizeof (buffer), 1);
1072   write_chars (buffer + sizeof (buffer) - count, count);
1073 }
1074
1075 /* Write out an integral CST in decimal. Most numbers are small, and
1076    representable in a HOST_WIDE_INT. Occasionally we'll have numbers
1077    bigger than that, which we must deal with. */
1078
1079 static inline void
1080 write_integer_cst (cst)
1081      tree cst;
1082 {
1083   int sign = tree_int_cst_sgn (cst);
1084
1085   if (TREE_INT_CST_HIGH (cst) + (sign < 0))
1086     {
1087       /* A bignum. We do this in chunks, each of which fits in a
1088          HOST_WIDE_INT. */
1089       char buffer[sizeof (HOST_WIDE_INT) * 8 * 2];
1090       unsigned HOST_WIDE_INT chunk;
1091       unsigned chunk_digits;
1092       char *ptr = buffer + sizeof (buffer);
1093       unsigned count = 0;
1094       tree n, base, type;
1095       int done;
1096
1097       /* HOST_WIDE_INT must be at least 32 bits, so 10^9 is
1098          representable. */
1099       chunk = 1000000000;
1100       chunk_digits = 9;
1101       
1102       if (sizeof (HOST_WIDE_INT) >= 8)
1103         {
1104           /* It is at least 64 bits, so 10^18 is representable. */
1105           chunk_digits = 18;
1106           chunk *= chunk;
1107         }
1108       
1109       type = signed_or_unsigned_type (1, TREE_TYPE (cst));
1110       base = build_int_2 (chunk, 0);
1111       n = build_int_2 (TREE_INT_CST_LOW (cst), TREE_INT_CST_HIGH (cst));
1112       TREE_TYPE (n) = TREE_TYPE (base) = type;
1113
1114       if (sign < 0)
1115         {
1116           write_char ('n');
1117           n = fold (build1 (NEGATE_EXPR, type, n));
1118         }
1119       do
1120         {
1121           tree d = fold (build (FLOOR_DIV_EXPR, type, n, base));
1122           tree tmp = fold (build (MULT_EXPR, type, d, base));
1123           unsigned c;
1124           
1125           done = integer_zerop (d);
1126           tmp = fold (build (MINUS_EXPR, type, n, tmp));
1127           c = hwint_to_ascii (TREE_INT_CST_LOW (tmp), 10, ptr,
1128                                 done ? 1 : chunk_digits);
1129           ptr -= c;
1130           count += c;
1131           n = d;
1132         }
1133       while (!done);
1134       write_chars (ptr, count);
1135     }
1136   else 
1137     {
1138       /* A small num.  */
1139       unsigned HOST_WIDE_INT low = TREE_INT_CST_LOW (cst);
1140       
1141       if (sign < 0)
1142         {
1143           write_char ('n');
1144           low = -low;
1145         }
1146       write_unsigned_number (low);
1147     }
1148 }
1149
1150 /* Non-terminal <identifier>.
1151
1152      <identifier> ::= </unqualified source code identifier>  */
1153
1154 static void
1155 write_identifier (identifier)
1156      const char *identifier;
1157 {
1158   MANGLE_TRACE ("identifier", identifier);
1159   write_string (identifier);
1160 }
1161
1162 /* Handle constructor productions of non-terminal <special-name>.
1163    CTOR is a constructor FUNCTION_DECL. 
1164
1165      <special-name> ::= C1   # complete object constructor
1166                     ::= C2   # base object constructor
1167                     ::= C3   # complete object allocating constructor
1168
1169    Currently, allocating constructors are never used. 
1170
1171    We also need to provide mangled names for the maybe-in-charge
1172    constructor, so we treat it here too.  mangle_decl_string will
1173    append *INTERNAL* to that, to make sure we never emit it.  */
1174
1175 static void
1176 write_special_name_constructor (ctor)
1177      tree ctor;
1178 {
1179   if (DECL_COMPLETE_CONSTRUCTOR_P (ctor)
1180       /* Even though we don't ever emit a definition of the
1181          old-style destructor, we still have to consider entities
1182          (like static variables) nested inside it.  */
1183       || DECL_MAYBE_IN_CHARGE_CONSTRUCTOR_P (ctor))
1184     write_string ("C1");
1185   else if (DECL_BASE_CONSTRUCTOR_P (ctor))
1186     write_string ("C2");
1187   else
1188     abort ();
1189 }
1190
1191 /* Handle destructor productions of non-terminal <special-name>.
1192    DTOR is a destructor FUNCTION_DECL. 
1193
1194      <special-name> ::= D0 # deleting (in-charge) destructor
1195                     ::= D1 # complete object (in-charge) destructor
1196                     ::= D2 # base object (not-in-charge) destructor
1197
1198    We also need to provide mangled names for the maybe-incharge
1199    destructor, so we treat it here too.  mangle_decl_string will
1200    append *INTERNAL* to that, to make sure we never emit it.  */
1201
1202 static void
1203 write_special_name_destructor (dtor)
1204      tree dtor;
1205 {
1206   if (DECL_DELETING_DESTRUCTOR_P (dtor))
1207     write_string ("D0");
1208   else if (DECL_COMPLETE_DESTRUCTOR_P (dtor)
1209            /* Even though we don't ever emit a definition of the
1210               old-style destructor, we still have to consider entities
1211               (like static variables) nested inside it.  */
1212            || DECL_MAYBE_IN_CHARGE_DESTRUCTOR_P (dtor))
1213     write_string ("D1");
1214   else if (DECL_BASE_DESTRUCTOR_P (dtor))
1215     write_string ("D2");
1216   else
1217     abort ();
1218 }
1219
1220 /* Return the discriminator for ENTITY appearing inside
1221    FUNCTION.  The discriminator is the lexical ordinal of VAR among
1222    entities with the same name in the same FUNCTION.  */
1223
1224 static int
1225 discriminator_for_local_entity (entity)
1226      tree entity;
1227 {
1228   tree *type;
1229   int discriminator;
1230
1231   /* Assume this is the only local entity with this name.  */
1232   discriminator = 0;
1233
1234   if (DECL_DISCRIMINATOR_P (entity) && DECL_LANG_SPECIFIC (entity))
1235     discriminator = DECL_DISCRIMINATOR (entity);
1236   else if (TREE_CODE (entity) == TYPE_DECL)
1237     {
1238       /* Scan the list of local classes.  */
1239       entity = TREE_TYPE (entity);
1240       for (type = &VARRAY_TREE (local_classes, 0); *type != entity; ++type)
1241         if (TYPE_IDENTIFIER (*type) == TYPE_IDENTIFIER (entity)
1242             && TYPE_CONTEXT (*type) == TYPE_CONTEXT (entity))
1243           ++discriminator;
1244     }  
1245
1246   return discriminator;
1247 }
1248
1249 /* Return the discriminator for STRING, a string literal used inside
1250    FUNCTION.  The disciminator is the lexical ordinal of STRING among
1251    string literals used in FUNCTION.  */
1252
1253 static int
1254 discriminator_for_string_literal (function, string)
1255      tree function ATTRIBUTE_UNUSED;
1256      tree string ATTRIBUTE_UNUSED;
1257 {
1258   /* For now, we don't discriminate amongst string literals.  */
1259   return 0;
1260 }
1261
1262 /*   <discriminator> := _ <number>   
1263
1264    The discriminator is used only for the second and later occurrences
1265    of the same name within a single function. In this case <number> is
1266    n - 2, if this is the nth occurrence, in lexical order.  */
1267
1268 static void
1269 write_discriminator (discriminator)
1270      int discriminator;
1271 {
1272   /* If discriminator is zero, don't write anything.  Otherwise... */
1273   if (discriminator > 0)
1274     {
1275       write_char ('_');
1276       write_unsigned_number (discriminator - 1);
1277     }
1278 }
1279
1280 /* Mangle the name of a function-scope entity.  FUNCTION is the
1281    FUNCTION_DECL for the enclosing function.  ENTITY is the decl for
1282    the entity itself.  LOCAL_ENTITY is the entity that's directly
1283    scoped in FUNCTION_DECL, either ENTITY itself or an enclosing scope
1284    of ENTITY.
1285
1286      <local-name> := Z <function encoding> E <entity name> [<discriminator>]
1287                   := Z <function encoding> E s [<discriminator>]  */
1288
1289 static void
1290 write_local_name (function, local_entity, entity)
1291      tree function;
1292      tree local_entity;
1293      tree entity;
1294 {
1295   MANGLE_TRACE_TREE ("local-name", entity);
1296
1297   write_char ('Z');
1298   write_encoding (function);
1299   write_char ('E');
1300   if (TREE_CODE (entity) == STRING_CST)
1301     {
1302       write_char ('s');
1303       write_discriminator (discriminator_for_string_literal (function, 
1304                                                              entity));
1305     }
1306   else
1307     {
1308       /* Now the <entity name>.  Let write_name know its being called
1309          from <local-name>, so it doesn't try to process the enclosing
1310          function scope again.  */
1311       write_name (entity, /*ignore_local_scope=*/1);
1312       write_discriminator (discriminator_for_local_entity (local_entity));
1313     }
1314 }
1315
1316 /* Non-terminals <type> and <CV-qualifier>.  
1317
1318      <type> ::= <builtin-type>
1319             ::= <function-type>
1320             ::= <class-enum-type>
1321             ::= <array-type>
1322             ::= <pointer-to-member-type>
1323             ::= <template-param>
1324             ::= <substitution>
1325             ::= <CV-qualifier>
1326             ::= P <type>    # pointer-to
1327             ::= R <type>    # reference-to
1328             ::= C <type>    # complex pair (C 2000)
1329             ::= G <type>    # imaginary (C 2000)     [not supported]
1330             ::= U <source-name> <type>   # vendor extended type qualifier 
1331
1332    TYPE is a type node.  */
1333
1334 static void 
1335 write_type (type)
1336      tree type;
1337 {
1338   /* This gets set to non-zero if TYPE turns out to be a (possibly
1339      CV-qualified) builtin type.  */
1340   int is_builtin_type = 0;
1341
1342   MANGLE_TRACE_TREE ("type", type);
1343
1344   if (type == error_mark_node)
1345     return;
1346
1347   if (find_substitution (type))
1348     return;
1349   
1350   if (write_CV_qualifiers_for_type (type) > 0)
1351     /* If TYPE was CV-qualified, we just wrote the qualifiers; now
1352        mangle the unqualified type.  The recursive call is needed here
1353        since both the qualified and uqualified types are substitution
1354        candidates.  */
1355     write_type (TYPE_MAIN_VARIANT (type));
1356   else
1357     {
1358       /* See through any typedefs.  */
1359       type = TYPE_MAIN_VARIANT (type);
1360
1361       switch (TREE_CODE (type))
1362         {
1363         case VOID_TYPE:
1364         case BOOLEAN_TYPE:
1365         case INTEGER_TYPE:  /* Includes wchar_t.  */
1366         case REAL_TYPE:
1367           /* If this is a typedef, TYPE may not be one of
1368              the standard builtin type nodes, but an alias of one.  Use
1369              TYPE_MAIN_VARIANT to get to the underlying builtin type.  */
1370           write_builtin_type (TYPE_MAIN_VARIANT (type));
1371           ++is_builtin_type;
1372           break;
1373
1374         case COMPLEX_TYPE:
1375           write_char ('C');
1376           write_type (TREE_TYPE (type));
1377           break;
1378
1379         case FUNCTION_TYPE:
1380         case METHOD_TYPE:
1381           write_function_type (type);
1382           break;
1383
1384         case UNION_TYPE:
1385         case RECORD_TYPE:
1386         case ENUMERAL_TYPE:
1387           /* A pointer-to-member function is represented as a special
1388              RECORD_TYPE, so check for this first.  */
1389           if (TYPE_PTRMEMFUNC_P (type))
1390             write_pointer_to_member_type (type);
1391           else
1392             write_class_enum_type (type);
1393           break;
1394
1395         case TYPENAME_TYPE:
1396         case UNBOUND_CLASS_TEMPLATE:
1397           /* We handle TYPENAME_TYPEs and UNBOUND_CLASS_TEMPLATEs like
1398              ordinary nested names.  */
1399           write_nested_name (TYPE_STUB_DECL (type));
1400           break;
1401
1402         case ARRAY_TYPE:
1403           write_array_type (type);
1404           break;
1405
1406         case POINTER_TYPE:
1407           /* A pointer-to-member variable is represented by a POINTER_TYPE
1408              to an OFFSET_TYPE, so check for this first.  */
1409           if (TYPE_PTRMEM_P (type))
1410             write_pointer_to_member_type (type);
1411           else
1412             {
1413               write_char ('P');
1414               write_type (TREE_TYPE (type));
1415             }
1416           break;
1417
1418         case REFERENCE_TYPE:
1419           write_char ('R');
1420           write_type (TREE_TYPE (type));
1421           break;
1422
1423         case TEMPLATE_TYPE_PARM:
1424         case TEMPLATE_PARM_INDEX:
1425           write_template_param (type);
1426           break;
1427
1428         case TEMPLATE_TEMPLATE_PARM:
1429           write_template_template_param (type);
1430           break;
1431
1432         case BOUND_TEMPLATE_TEMPLATE_PARM:
1433           write_template_template_param (type);
1434           write_template_args 
1435             (TI_ARGS (TEMPLATE_TEMPLATE_PARM_TEMPLATE_INFO (type)));
1436           break;
1437
1438         case OFFSET_TYPE:
1439           write_pointer_to_member_type (build_pointer_type (type));
1440           break;
1441
1442         case VECTOR_TYPE:
1443           write_string ("U8__vector");
1444           write_type (TREE_TYPE (type));
1445           break;
1446
1447         default:
1448           abort ();
1449         }
1450     }
1451
1452   /* Types other than builtin types are substitution candidates.  */
1453   if (!is_builtin_type)
1454     add_substitution (type);
1455 }
1456
1457 /* Non-terminal <CV-qualifiers> for type nodes.  Returns the number of
1458    CV-qualifiers written for TYPE.
1459
1460      <CV-qualifiers> ::= [r] [V] [K]  */
1461
1462 static int
1463 write_CV_qualifiers_for_type (type)
1464      tree type;
1465 {
1466   int num_qualifiers = 0;
1467
1468   /* The order is specified by:
1469
1470        "In cases where multiple order-insensitive qualifiers are
1471        present, they should be ordered 'K' (closest to the base type),
1472        'V', 'r', and 'U' (farthest from the base type) ..."  */
1473
1474   if (CP_TYPE_RESTRICT_P (type))
1475     {
1476       write_char ('r');
1477       ++num_qualifiers;
1478     }
1479   if (CP_TYPE_VOLATILE_P (type))
1480     {
1481       write_char ('V');
1482       ++num_qualifiers;
1483     }
1484   if (CP_TYPE_CONST_P (type))
1485     {
1486       write_char ('K');
1487       ++num_qualifiers;
1488     }
1489
1490   return num_qualifiers;
1491 }
1492
1493 /* Non-terminal <builtin-type>. 
1494
1495      <builtin-type> ::= v   # void 
1496                     ::= b   # bool
1497                     ::= w   # wchar_t
1498                     ::= c   # char
1499                     ::= a   # signed char
1500                     ::= h   # unsigned char
1501                     ::= s   # short
1502                     ::= t   # unsigned short
1503                     ::= i   # int
1504                     ::= j   # unsigned int
1505                     ::= l   # long
1506                     ::= m   # unsigned long
1507                     ::= x   # long long, __int64
1508                     ::= y   # unsigned long long, __int64  
1509                     ::= n   # __int128            [not supported]
1510                     ::= o   # unsigned __int128   [not supported] 
1511                     ::= f   # float
1512                     ::= d   # double
1513                     ::= e   # long double, __float80 
1514                     ::= g   # __float128          [not supported]
1515                     ::= u <source-name>  # vendor extended type */
1516
1517 static void 
1518 write_builtin_type (type)
1519      tree type;
1520 {
1521   switch (TREE_CODE (type))
1522     {
1523     case VOID_TYPE:
1524       write_char ('v');
1525       break;
1526
1527     case BOOLEAN_TYPE:
1528       write_char ('b');
1529       break;
1530
1531     case INTEGER_TYPE:
1532       /* If this is size_t, get the underlying int type.  */
1533       if (TYPE_IS_SIZETYPE (type))
1534         type = TYPE_DOMAIN (type);
1535
1536       /* TYPE may still be wchar_t, since that isn't in
1537          integer_type_nodes.  */
1538       if (type == wchar_type_node)
1539         write_char ('w');
1540       else if (TYPE_FOR_JAVA (type))
1541         write_java_integer_type_codes (type);
1542       else
1543         {
1544           size_t itk;
1545           /* Assume TYPE is one of the shared integer type nodes.  Find
1546              it in the array of these nodes.  */
1547         iagain:
1548           for (itk = 0; itk < itk_none; ++itk)
1549             if (type == integer_types[itk])
1550               {
1551                 /* Print the corresponding single-letter code.  */
1552                 write_char (integer_type_codes[itk]);
1553                 break;
1554               }
1555           
1556           if (itk == itk_none)
1557             {
1558               tree t = type_for_mode (TYPE_MODE (type), TREE_UNSIGNED (type));
1559               if (type == t)
1560                 /* Couldn't find this type.  */
1561                 abort ();
1562               type = t;
1563               goto iagain;
1564             }
1565         }
1566       break;
1567
1568     case REAL_TYPE:
1569       if (type == float_type_node
1570           || type == java_float_type_node)
1571         write_char ('f');
1572       else if (type == double_type_node
1573                || type == java_double_type_node)
1574         write_char ('d');
1575       else if (type == long_double_type_node)
1576         write_char ('e');
1577       else
1578         abort ();
1579       break;
1580
1581     default:
1582       abort ();
1583     }
1584 }
1585
1586 /* Non-terminal <function-type>.  NODE is a FUNCTION_TYPE or
1587    METHOD_TYPE.  The return type is mangled before the parameter
1588    types.
1589
1590      <function-type> ::= F [Y] <bare-function-type> E   */
1591
1592 static void
1593 write_function_type (type)
1594      tree type;
1595 {
1596   MANGLE_TRACE_TREE ("function-type", type);
1597
1598   write_char ('F');
1599   /* We don't track whether or not a type is `extern "C"'.  Note that
1600      you can have an `extern "C"' function that does not have
1601      `extern "C"' type, and vice versa:
1602
1603        extern "C" typedef void function_t();
1604        function_t f; // f has C++ linkage, but its type is
1605                      // `extern "C"'
1606
1607        typedef void function_t();
1608        extern "C" function_t f; // Vice versa.
1609
1610      See [dcl.link].  */
1611   write_bare_function_type (type, /*include_return_type_p=*/1, 
1612                             /*decl=*/NULL);
1613   write_char ('E');
1614 }
1615
1616 /* Non-terminal <bare-function-type>.  TYPE is a FUNCTION_TYPE or
1617    METHOD_TYPE.  If INCLUDE_RETURN_TYPE is non-zero, the return value
1618    is mangled before the parameter types.  If non-NULL, DECL is
1619    FUNCTION_DECL for the function whose type is being emitted.
1620
1621      <bare-function-type> ::= </signature/ type>+  */
1622
1623 static void
1624 write_bare_function_type (type, include_return_type_p, decl)
1625      tree type;
1626      int include_return_type_p;
1627      tree decl;
1628 {
1629   MANGLE_TRACE_TREE ("bare-function-type", type);
1630
1631   /* Mangle the return type, if requested.  */
1632   if (include_return_type_p)
1633     write_type (TREE_TYPE (type));
1634
1635   /* Now mangle the types of the arguments.  */
1636   write_method_parms (TYPE_ARG_TYPES (type), 
1637                       TREE_CODE (type) == METHOD_TYPE,
1638                       decl);
1639 }
1640
1641 /* Write the mangled representation of a method parameter list of
1642    types given in PARM_TYPES.  If METHOD_P is non-zero, the function is 
1643    considered a non-static method, and the this parameter is omitted.
1644    If non-NULL, DECL is the FUNCTION_DECL for the function whose
1645    parameters are being emitted.  */
1646
1647 static void
1648 write_method_parms (parm_types, method_p, decl)
1649      tree decl;
1650      tree parm_types;
1651      int method_p;
1652 {
1653   tree first_parm_type;
1654   tree parm_decl = decl ? DECL_ARGUMENTS (decl) : NULL_TREE;
1655
1656   /* Assume this parameter type list is variable-length.  If it ends
1657      with a void type, then it's not.  */
1658   int varargs_p = 1;
1659
1660   /* If this is a member function, skip the first arg, which is the
1661      this pointer.  
1662        "Member functions do not encode the type of their implicit this
1663        parameter."  
1664   
1665      Similarly, there's no need to mangle artificial parameters, like
1666      the VTT parameters for constructors and destructors.  */
1667   if (method_p)
1668     {
1669       parm_types = TREE_CHAIN (parm_types);
1670       parm_decl = parm_decl ? TREE_CHAIN (parm_decl) : NULL_TREE;
1671
1672       while (parm_decl && DECL_ARTIFICIAL (parm_decl))
1673         {
1674           parm_types = TREE_CHAIN (parm_types);
1675           parm_decl = TREE_CHAIN (parm_decl);
1676         }
1677     }
1678
1679   for (first_parm_type = parm_types; 
1680        parm_types; 
1681        parm_types = TREE_CHAIN (parm_types))
1682     {
1683       tree parm = TREE_VALUE (parm_types);
1684       if (parm == void_type_node)
1685         {
1686           /* "Empty parameter lists, whether declared as () or
1687              conventionally as (void), are encoded with a void parameter
1688              (v)."  */
1689           if (parm_types == first_parm_type)
1690             write_type (parm);
1691           /* If the parm list is terminated with a void type, it's
1692              fixed-length.  */
1693           varargs_p = 0;
1694           /* A void type better be the last one.  */
1695           my_friendly_assert (TREE_CHAIN (parm_types) == NULL, 20000523);
1696         }
1697       else
1698         write_type (parm);
1699     }
1700
1701   if (varargs_p)
1702     /* <builtin-type> ::= z  # ellipsis  */
1703     write_char ('z');
1704 }
1705
1706 /* <class-enum-type> ::= <name>  */
1707
1708 static void 
1709 write_class_enum_type (type)
1710      tree type;
1711 {
1712   write_name (TYPE_NAME (type), /*ignore_local_scope=*/0);
1713 }
1714
1715 /* Non-terminal <template-args>.  ARGS is a TREE_VEC of template
1716    arguments.
1717
1718      <template-args> ::= I <template-arg>+ E  */
1719
1720 static void
1721 write_template_args (args)
1722      tree args;
1723 {
1724   int i;
1725   int length = TREE_VEC_LENGTH (args);
1726
1727   MANGLE_TRACE_TREE ("template-args", args);
1728
1729   my_friendly_assert (length > 0, 20000422);
1730
1731   if (TREE_CODE (TREE_VEC_ELT (args, 0)) == TREE_VEC)
1732     {
1733       /* We have nested template args.  We want the innermost template
1734          argument list.  */
1735       args = TREE_VEC_ELT (args, length - 1);
1736       length = TREE_VEC_LENGTH (args);
1737     }
1738
1739   write_char ('I');
1740   for (i = 0; i < length; ++i)
1741     write_template_arg (TREE_VEC_ELT (args, i));
1742   write_char ('E');
1743 }
1744
1745 /* <expression> ::= <unary operator-name> <expression>
1746                 ::= <binary operator-name> <expression> <expression>
1747                 ::= <expr-primary>
1748
1749    <expr-primary> ::= <template-param>
1750                   ::= L <type> <value number> E  # literal
1751                   ::= L <mangled-name> E         # external name  */
1752
1753 static void
1754 write_expression (expr)
1755      tree expr;
1756 {
1757   enum tree_code code;
1758
1759   code = TREE_CODE (expr);
1760
1761   /* Handle pointers-to-members by making them look like expression
1762      nodes.  */
1763   if (code == PTRMEM_CST)
1764     {
1765       expr = build_nt (ADDR_EXPR,
1766                        build_nt (SCOPE_REF,
1767                                  PTRMEM_CST_CLASS (expr),
1768                                  PTRMEM_CST_MEMBER (expr)));
1769       code = TREE_CODE (expr);
1770     }
1771
1772   /* Handle template parameters. */
1773   if (code == TEMPLATE_TYPE_PARM 
1774       || code == TEMPLATE_TEMPLATE_PARM
1775       || code == BOUND_TEMPLATE_TEMPLATE_PARM
1776       || code == TEMPLATE_PARM_INDEX)
1777     write_template_param (expr);
1778   /* Handle literals.  */
1779   else if (TREE_CODE_CLASS (code) == 'c')
1780     write_template_arg_literal (expr);
1781   else if (DECL_P (expr))
1782     {
1783       write_char ('L');
1784       write_mangled_name (expr);
1785       write_char ('E');
1786     }
1787   else
1788     {
1789       int i;
1790
1791       /* Skip NOP_EXPRs.  They can occur when (say) a pointer argument
1792          is converted (via qualification conversions) to another
1793          type.  */
1794       while (TREE_CODE (expr) == NOP_EXPR)
1795         {
1796           expr = TREE_OPERAND (expr, 0);
1797           code = TREE_CODE (expr);
1798         }
1799
1800       /* When we bind a variable or function to a non-type template
1801          argument with reference type, we create an ADDR_EXPR to show
1802          the fact that the entity's address has been taken.  But, we
1803          don't actually want to output a mangling code for the `&'.  */
1804       if (TREE_CODE (expr) == ADDR_EXPR
1805           && TREE_TYPE (expr)
1806           && TREE_CODE (TREE_TYPE (expr)) == REFERENCE_TYPE)
1807         {
1808           expr = TREE_OPERAND (expr, 0);
1809           if (DECL_P (expr))
1810             {
1811               write_expression (expr);
1812               return;
1813             }
1814
1815           code = TREE_CODE (expr);
1816         }
1817       
1818       /* If it wasn't any of those, recursively expand the expression.  */
1819       write_string (operator_name_info[(int) code].mangled_name);
1820
1821       switch (code)
1822         {
1823         case CAST_EXPR:
1824           write_type (TREE_TYPE (expr));
1825           write_expression (TREE_VALUE (TREE_OPERAND (expr, 0)));
1826           break;
1827
1828         case STATIC_CAST_EXPR:
1829         case CONST_CAST_EXPR:
1830           write_type (TREE_TYPE (expr));
1831           write_expression (TREE_OPERAND (expr, 0));
1832           break;
1833
1834         /* Handle pointers-to-members specially.  */
1835         case SCOPE_REF:
1836           write_type (TREE_OPERAND (expr, 0));
1837           if (TREE_CODE (TREE_OPERAND (expr, 1)) == IDENTIFIER_NODE)
1838             write_source_name (TREE_OPERAND (expr, 1));
1839           else
1840             write_encoding (TREE_OPERAND (expr, 1));
1841           break;
1842
1843         default:
1844           for (i = 0; i < TREE_CODE_LENGTH (code); ++i)
1845             write_expression (TREE_OPERAND (expr, i));
1846         }
1847     }
1848 }
1849
1850 /* Literal subcase of non-terminal <template-arg>.  
1851
1852      "Literal arguments, e.g. "A<42L>", are encoded with their type
1853      and value. Negative integer values are preceded with "n"; for
1854      example, "A<-42L>" becomes "1AILln42EE". The bool value false is
1855      encoded as 0, true as 1. If floating-point arguments are accepted
1856      as an extension, their values should be encoded using a
1857      fixed-length lowercase hexadecimal string corresponding to the
1858      internal representation (IEEE on IA-64), high-order bytes first,
1859      without leading zeroes. For example: "Lfbff000000E" is -1.0f."  */
1860
1861 static void
1862 write_template_arg_literal (value)
1863      tree value;
1864 {
1865   tree type = TREE_TYPE (value);
1866   write_char ('L');
1867   write_type (type);
1868
1869   if (TREE_CODE (value) == CONST_DECL)
1870     write_integer_cst (DECL_INITIAL (value));
1871   else if (TREE_CODE (value) == INTEGER_CST)
1872     {
1873       if (same_type_p (type, boolean_type_node))
1874         {
1875           if (value == boolean_false_node || integer_zerop (value))
1876             write_unsigned_number (0);
1877           else if (value == boolean_true_node)
1878             write_unsigned_number (1);
1879           else 
1880             abort ();
1881         }
1882       else
1883         write_integer_cst (value);
1884     }
1885   else if (TREE_CODE (value) == REAL_CST)
1886     {
1887 #ifdef CROSS_COMPILE
1888       static int explained;
1889
1890       if (!explained) 
1891         {
1892           sorry ("real-valued template parameters when cross-compiling");
1893           explained = 1;
1894         }
1895 #else
1896       size_t i;
1897       for (i = 0; i < sizeof (TREE_REAL_CST (value)); ++i)
1898         write_number (((unsigned char *) 
1899                        &TREE_REAL_CST (value))[i], 
1900                       /*unsigned_p=*/1,
1901                       16);
1902 #endif
1903     }
1904   else
1905     abort ();
1906
1907   write_char ('E');
1908 }
1909
1910 /* Non-terminal <tempalate-arg>.  
1911
1912      <template-arg> ::= <type>                        # type
1913                     ::= L <type> </value/ number> E   # literal
1914                     ::= LZ <name> E                   # external name
1915                     ::= X <expression> E              # expression  */
1916
1917 static void
1918 write_template_arg (node)
1919      tree node;
1920 {
1921   enum tree_code code = TREE_CODE (node);
1922
1923   MANGLE_TRACE_TREE ("template-arg", node);
1924
1925   /* A template template paramter's argument list contains TREE_LIST
1926      nodes of which the value field is the the actual argument.  */
1927   if (code == TREE_LIST)
1928     {
1929       node = TREE_VALUE (node);
1930       /* If it's a decl, deal with its type instead.  */
1931       if (DECL_P (node))
1932         {
1933           node = TREE_TYPE (node);
1934           code = TREE_CODE (node);
1935         }
1936     }
1937
1938   if (TYPE_P (node))
1939     write_type (node);
1940   else if (code == TEMPLATE_DECL)
1941     /* A template appearing as a template arg is a template template arg.  */
1942     write_template_template_arg (node);
1943   else if (DECL_P (node))
1944     {
1945       write_char ('L');
1946       write_char ('Z');
1947       write_encoding (node);
1948       write_char ('E');
1949     }
1950   else if (TREE_CODE_CLASS (code) == 'c' && code != PTRMEM_CST)
1951     write_template_arg_literal (node);
1952   else
1953     {
1954       /* Template arguments may be expressions.  */
1955       write_char ('X');
1956       write_expression (node);
1957       write_char ('E');
1958     }
1959 }
1960
1961 /*  <template-template-arg>
1962                         ::= <name>
1963                         ::= <substitution>  */
1964
1965 void
1966 write_template_template_arg (tree decl)
1967 {
1968   MANGLE_TRACE_TREE ("template-template-arg", decl);
1969
1970   if (find_substitution (decl))
1971     return;
1972   write_name (decl, /*ignore_local_scope=*/0);
1973   add_substitution (decl);
1974 }
1975
1976
1977 /* Non-terminal <array-type>.  TYPE is an ARRAY_TYPE.  
1978
1979      <array-type> ::= A [</dimension/ number>] _ </element/ type>  
1980                   ::= A <expression> _ </element/ type>
1981
1982      "Array types encode the dimension (number of elements) and the
1983      element type. For variable length arrays, the dimension (but not
1984      the '_' separator) is omitted."  */
1985
1986 static void 
1987 write_array_type (type)
1988   tree type;
1989 {
1990   write_char ('A');
1991   if (TYPE_DOMAIN (type))
1992     {
1993       tree index_type;
1994       tree max;
1995
1996       index_type = TYPE_DOMAIN (type);
1997       /* The INDEX_TYPE gives the upper and lower bounds of the
1998          array.  */
1999       max = TYPE_MAX_VALUE (index_type);
2000       if (TREE_CODE (max) == INTEGER_CST)
2001         {
2002           /* The ABI specifies that we should mangle the number of
2003              elements in the array, not the largest allowed index.  */
2004           max = size_binop (PLUS_EXPR, max, size_one_node);
2005           write_unsigned_number (tree_low_cst (max, 1));
2006         }
2007       else
2008         write_expression (TREE_OPERAND (max, 0));
2009     }
2010   write_char ('_');
2011   write_type (TREE_TYPE (type));
2012 }
2013
2014 /* Non-terminal <pointer-to-member-type> for pointer-to-member
2015    variables.  TYPE is a pointer-to-member POINTER_TYPE.
2016
2017      <pointer-to-member-type> ::= M </class/ type> </member/ type>  */
2018
2019 static void
2020 write_pointer_to_member_type (type)
2021      tree type;
2022 {
2023   write_char ('M');
2024   /* For a pointer-to-function member, the class type may be
2025      cv-qualified, bug that won't be reflected in
2026      TYPE_PTRMEM_CLASS_TYPE.  So, we go fishing around in
2027      TYPE_PTRMEM_POINTED_TO_TYPE instead.  */
2028   if (TYPE_PTRMEMFUNC_P (type))
2029     {
2030       tree fn_type;
2031       tree this_type;
2032
2033       fn_type = TYPE_PTRMEM_POINTED_TO_TYPE (type);
2034       /* The first parameter must be a POINTER_TYPE pointing to the
2035          `this' parameter.  */
2036       this_type = TREE_TYPE (TREE_VALUE (TYPE_ARG_TYPES (fn_type)));
2037       write_type (this_type);
2038     }
2039   /* For a pointer-to-data member, things are simpler.  */
2040   else
2041     write_type (TYPE_PTRMEM_CLASS_TYPE (type));
2042   write_type (TYPE_PTRMEM_POINTED_TO_TYPE (type));
2043 }
2044
2045 /* Non-terminal <template-param>.  PARM is a TEMPLATE_TYPE_PARM,
2046    TEMPLATE_TEMPLATE_PARM, BOUND_TEMPLATE_TEMPLATE_PARM or a
2047    TEMPLATE_PARM_INDEX.
2048
2049      <template-param> ::= T </parameter/ number> _  */
2050
2051 static void
2052 write_template_param (parm)
2053      tree parm;
2054 {
2055   int parm_index;
2056
2057   MANGLE_TRACE_TREE ("template-parm", parm);
2058
2059   switch (TREE_CODE (parm))
2060     {
2061     case TEMPLATE_TYPE_PARM:
2062     case TEMPLATE_TEMPLATE_PARM:
2063     case BOUND_TEMPLATE_TEMPLATE_PARM:
2064       parm_index = TEMPLATE_TYPE_IDX (parm);
2065       break;
2066
2067     case TEMPLATE_PARM_INDEX:
2068       parm_index = TEMPLATE_PARM_IDX (parm);
2069       break;
2070
2071     default:
2072       abort ();
2073     }
2074
2075   write_char ('T');
2076   /* NUMBER as it appears in the mangling is (-1)-indexed, with the
2077      earliest template param denoted by `_'.  */
2078   if (parm_index > 0)
2079     write_unsigned_number (parm_index - 1);
2080   write_char ('_');
2081 }
2082
2083 /*  <template-template-param>
2084                         ::= <template-param> 
2085                         ::= <substitution>  */
2086
2087 static void
2088 write_template_template_param (parm)
2089      tree parm;
2090 {
2091   tree template = NULL_TREE;
2092
2093   /* PARM, a TEMPLATE_TEMPLATE_PARM, is an instantiation of the
2094      template template parameter.  The substitution candidate here is
2095      only the template.  */
2096   if (TREE_CODE (parm) == BOUND_TEMPLATE_TEMPLATE_PARM)
2097     {
2098       template 
2099         = TI_TEMPLATE (TEMPLATE_TEMPLATE_PARM_TEMPLATE_INFO (parm));
2100       if (find_substitution (template))
2101         return;
2102     }
2103
2104   /* <template-param> encodes only the template parameter position,
2105      not its template arguments, which is fine here.  */
2106   write_template_param (parm);
2107   if (template)
2108     add_substitution (template);
2109 }
2110
2111 /* Non-terminal <substitution>.  
2112
2113       <substitution> ::= S <seq-id> _
2114                      ::= S_  */
2115
2116 static void
2117 write_substitution (seq_id)
2118      int seq_id;
2119 {
2120   MANGLE_TRACE ("substitution", "");
2121
2122   write_char ('S');
2123   if (seq_id > 0)
2124     write_number (seq_id - 1, /*unsigned=*/1, 36);
2125   write_char ('_');
2126 }
2127
2128 /* Start mangling a new name or type.  */
2129
2130 static inline void
2131 start_mangling ()
2132 {
2133   obstack_free (&G.name_obstack, obstack_base (&G.name_obstack));
2134 }
2135
2136 /* Done with mangling.  Return the generated mangled name.  */
2137
2138 static inline const char *
2139 finish_mangling ()
2140 {
2141   /* Clear all the substitutions.  */
2142   VARRAY_POP_ALL (G.substitutions);
2143
2144   /* Null-terminate the string.  */
2145   write_char ('\0');
2146
2147   return (const char *) obstack_base (&G.name_obstack);
2148 }
2149
2150 /* Initialize data structures for mangling.  */
2151
2152 void
2153 init_mangle ()
2154 {
2155   gcc_obstack_init (&G.name_obstack);
2156   VARRAY_TREE_INIT (G.substitutions, 1, "mangling substitutions");
2157
2158   /* Cache these identifiers for quick comparison when checking for
2159      standard substitutions.  */
2160   subst_identifiers[SUBID_ALLOCATOR] = get_identifier ("allocator");
2161   subst_identifiers[SUBID_BASIC_STRING] = get_identifier ("basic_string");
2162   subst_identifiers[SUBID_CHAR_TRAITS] = get_identifier ("char_traits");
2163   subst_identifiers[SUBID_BASIC_ISTREAM] = get_identifier ("basic_istream");
2164   subst_identifiers[SUBID_BASIC_OSTREAM] = get_identifier ("basic_ostream");
2165   subst_identifiers[SUBID_BASIC_IOSTREAM] = get_identifier ("basic_iostream");
2166 }
2167
2168 /* Generate the mangled name of DECL.  */
2169
2170 static const char *
2171 mangle_decl_string (decl)
2172      tree decl;
2173 {
2174   const char *result;
2175
2176   start_mangling ();
2177
2178   if (TREE_CODE (decl) == TYPE_DECL)
2179     write_type (TREE_TYPE (decl));
2180   else if (/* The names of `extern "C"' functions are not mangled.  */
2181            (DECL_EXTERN_C_FUNCTION_P (decl)
2182             /* But overloaded operator names *are* mangled.  */
2183             && !DECL_OVERLOADED_OPERATOR_P (decl))
2184            /* The names of global variables aren't mangled either.  */
2185            || (TREE_CODE (decl) == VAR_DECL
2186                && CP_DECL_CONTEXT (decl) == global_namespace)
2187            /* And neither are `extern "C"' variables.  */
2188            || (TREE_CODE (decl) == VAR_DECL
2189                && DECL_EXTERN_C_P (decl)))
2190     write_string (IDENTIFIER_POINTER (DECL_NAME (decl)));
2191   else
2192     {
2193       write_mangled_name (decl);
2194       if (DECL_LANG_SPECIFIC (decl)
2195           && (DECL_MAYBE_IN_CHARGE_DESTRUCTOR_P (decl)
2196               || DECL_MAYBE_IN_CHARGE_CONSTRUCTOR_P (decl)))
2197         /* We need a distinct mangled name for these entities, but
2198            we should never actually output it.  So, we append some
2199            characters the assembler won't like.  */
2200         write_string (" *INTERNAL* ");
2201     }
2202
2203   result = finish_mangling ();
2204   if (DEBUG_MANGLE)
2205     fprintf (stderr, "mangle_decl_string = '%s'\n\n", result);
2206   return result;
2207 }
2208
2209 /* Create an identifier for the external mangled name of DECL.  */
2210
2211 void
2212 mangle_decl (decl)
2213      tree decl;
2214 {
2215   tree id = get_identifier (mangle_decl_string (decl));
2216
2217   SET_DECL_ASSEMBLER_NAME (decl, id);
2218 }
2219
2220 /* Generate the mangled representation of TYPE.  */
2221
2222 const char *
2223 mangle_type_string (type)
2224      tree type;
2225 {
2226   const char *result;
2227
2228   start_mangling ();
2229   write_type (type);
2230   result = finish_mangling ();
2231   if (DEBUG_MANGLE)
2232     fprintf (stderr, "mangle_type_string = '%s'\n\n", result);
2233   return result;
2234 }
2235
2236 /* Create an identifier for the mangled representation of TYPE.  */
2237
2238 tree
2239 mangle_type (type)
2240      tree type;
2241 {
2242   return get_identifier (mangle_type_string (type));
2243 }
2244
2245 /* Create an identifier for the mangled name of a special component
2246    for belonging to TYPE.  CODE is the ABI-specified code for this
2247    component.  */
2248
2249 static tree
2250 mangle_special_for_type (type, code)
2251      tree type;
2252      const char *code;
2253 {
2254   const char *result;
2255
2256   /* We don't have an actual decl here for the special component, so
2257      we can't just process the <encoded-name>.  Instead, fake it.  */
2258   start_mangling ();
2259
2260   /* Start the mangling.  */
2261   write_string ("_Z");
2262   write_string (code);
2263
2264   /* Add the type.  */
2265   write_type (type);
2266   result = finish_mangling ();
2267
2268   if (DEBUG_MANGLE)
2269     fprintf (stderr, "mangle_special_for_type = %s\n\n", result);
2270
2271   return get_identifier (result);
2272 }
2273
2274 /* Create an identifier for the mangled representation of the typeinfo
2275    structure for TYPE.  */
2276
2277 tree
2278 mangle_typeinfo_for_type (type)
2279      tree type;
2280 {
2281   return mangle_special_for_type (type, "TI");
2282 }
2283
2284 /* Create an identifier for the mangled name of the NTBS containing
2285    the mangled name of TYPE.  */
2286
2287 tree
2288 mangle_typeinfo_string_for_type (type)
2289      tree type;
2290 {
2291   return mangle_special_for_type (type, "TS");
2292 }
2293
2294 /* Create an identifier for the mangled name of the vtable for TYPE.  */
2295
2296 tree
2297 mangle_vtbl_for_type (type)
2298      tree type;
2299 {
2300   return mangle_special_for_type (type, "TV");
2301 }
2302
2303 /* Returns an identifier for the mangled name of the VTT for TYPE.  */
2304
2305 tree
2306 mangle_vtt_for_type (type)
2307      tree type;
2308 {
2309   return mangle_special_for_type (type, "TT");
2310 }
2311
2312 /* Return an identifier for a construction vtable group.  TYPE is
2313    the most derived class in the hierarchy; BINFO is the base
2314    subobject for which this construction vtable group will be used.  
2315
2316    This mangling isn't part of the ABI specification; in the ABI
2317    specification, the vtable group is dumped in the same COMDAT as the
2318    main vtable, and is referenced only from that vtable, so it doesn't
2319    need an external name.  For binary formats without COMDAT sections,
2320    though, we need external names for the vtable groups.  
2321
2322    We use the production
2323
2324     <special-name> ::= CT <type> <offset number> _ <base type>  */
2325
2326 tree
2327 mangle_ctor_vtbl_for_type (type, binfo)
2328      tree type;
2329      tree binfo;
2330 {
2331   const char *result;
2332
2333   start_mangling ();
2334
2335   write_string ("_Z");
2336   write_string ("TC");
2337   write_type (type);
2338   write_integer_cst (BINFO_OFFSET (binfo));
2339   write_char ('_');
2340   write_type (BINFO_TYPE (binfo));
2341
2342   result = finish_mangling ();
2343   if (DEBUG_MANGLE)
2344     fprintf (stderr, "mangle_ctor_vtbl_for_type = %s\n\n", result);
2345   return get_identifier (result);
2346 }
2347
2348 /* Return an identifier for the mangled name of a thunk to FN_DECL.
2349    OFFSET is the initial adjustment to this used to find the vptr.  If
2350    VCALL_OFFSET is non-NULL, this is a virtual thunk, and it is the
2351    vtbl offset in bytes.  
2352
2353     <special-name> ::= Th <offset number> _ <base encoding>
2354                    ::= Tv <offset number> _ <vcall offset number> _
2355                                                             <base encoding>
2356 */
2357
2358 tree
2359 mangle_thunk (fn_decl, offset, vcall_offset)
2360      tree fn_decl;
2361      tree offset;
2362      tree vcall_offset;
2363 {
2364   const char *result;
2365   
2366   start_mangling ();
2367
2368   write_string ("_Z");
2369   /* The <special-name> for virtual thunks is Tv, for non-virtual
2370      thunks Th.  */
2371   write_char ('T');
2372   if (vcall_offset != 0)
2373     write_char ('v');
2374   else
2375     write_char ('h');
2376
2377   /* For either flavor, write the offset to this.  */
2378   write_integer_cst (offset);
2379   write_char ('_');
2380
2381   /* For a virtual thunk, add the vcall offset.  */
2382   if (vcall_offset)
2383     {
2384       /* Virtual thunk.  Write the vcall offset and base type name.  */
2385       write_integer_cst (vcall_offset);
2386       write_char ('_');
2387     }
2388
2389   /* Scoped name.  */
2390   write_encoding (fn_decl);
2391
2392   result = finish_mangling ();
2393   if (DEBUG_MANGLE)
2394     fprintf (stderr, "mangle_thunk = %s\n\n", result);
2395   return get_identifier (result);
2396 }
2397
2398 /* Return an identifier for the mangled unqualified name for a
2399    conversion operator to TYPE.  This mangling is not specified by the
2400    ABI spec; it is only used internally.  */
2401
2402 tree
2403 mangle_conv_op_name_for_type (type)
2404      tree type;
2405 {
2406   tree identifier;
2407
2408   /* Build the mangling for TYPE.  */
2409   const char *mangled_type = mangle_type_string (type);
2410   /* Allocate a temporary buffer for the complete name.  */
2411   char *op_name = concat ("operator ", mangled_type, NULL);
2412   /* Find or create an identifier.  */
2413   identifier = get_identifier (op_name);
2414   /* Done with the temporary buffer.  */
2415   free (op_name);
2416   /* Set bits on the identifier so we know later it's a conversion.  */
2417   IDENTIFIER_OPNAME_P (identifier) = 1;
2418   IDENTIFIER_TYPENAME_P (identifier) = 1;
2419   /* Hang TYPE off the identifier so it can be found easily later when
2420      performing conversions.  */
2421   TREE_TYPE (identifier) = type;
2422
2423   return identifier;
2424 }
2425
2426 /* Return an identifier for the name of an initialization guard
2427    variable for indicated VARIABLE.  */
2428
2429 tree
2430 mangle_guard_variable (variable)
2431      tree variable;
2432 {
2433   start_mangling ();
2434   write_string ("_ZGV");
2435   if (strncmp (IDENTIFIER_POINTER (DECL_NAME (variable)), "_ZGR", 4) == 0)
2436     /* The name of a guard variable for a reference temporary should refer
2437        to the reference, not the temporary.  */
2438     write_string (IDENTIFIER_POINTER (DECL_NAME (variable)) + 4);
2439   else
2440     write_name (variable, /*ignore_local_scope=*/0);
2441   return get_identifier (finish_mangling ());
2442 }
2443
2444 /* Return an identifier for the name of a temporary variable used to
2445    initialize a static reference.  This isn't part of the ABI, but we might
2446    as well call them something readable.  */
2447
2448 tree
2449 mangle_ref_init_variable (variable)
2450      tree variable;
2451 {
2452   start_mangling ();
2453   write_string ("_ZGR");
2454   write_name (variable, /*ignore_local_scope=*/0);
2455   return get_identifier (finish_mangling ());
2456 }
2457 \f
2458
2459 /* Foreign language type mangling section.  */
2460
2461 /* How to write the type codes for the integer Java type.  */
2462
2463 static void
2464 write_java_integer_type_codes (type)
2465      tree type;
2466 {
2467   if (type == java_int_type_node)
2468     write_char ('i');
2469   else if (type == java_short_type_node)
2470     write_char ('s');
2471   else if (type == java_byte_type_node)
2472     write_char ('c');
2473   else if (type == java_char_type_node)
2474     write_char ('w');
2475   else if (type == java_long_type_node)
2476     write_char ('x');
2477   else if (type == java_boolean_type_node)
2478     write_char ('b');
2479   else
2480     abort ();
2481 }
2482