OSDN Git Service

PR c++/4377
[pf3gnuchains/gcc-fork.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
1510                     ::= o   # unsigned __int128
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                 {
1561                   if (TYPE_PRECISION (type) == 128)
1562                     write_char (TREE_UNSIGNED (type) ? 'o' : 'n');
1563                   else
1564                     /* Couldn't find this type.  */
1565                     abort ();
1566                 }
1567               else
1568                 {
1569                   type = t;
1570                   goto iagain;
1571                 }
1572             }
1573         }
1574       break;
1575
1576     case REAL_TYPE:
1577       if (type == float_type_node
1578           || type == java_float_type_node)
1579         write_char ('f');
1580       else if (type == double_type_node
1581                || type == java_double_type_node)
1582         write_char ('d');
1583       else if (type == long_double_type_node)
1584         write_char ('e');
1585       else
1586         abort ();
1587       break;
1588
1589     default:
1590       abort ();
1591     }
1592 }
1593
1594 /* Non-terminal <function-type>.  NODE is a FUNCTION_TYPE or
1595    METHOD_TYPE.  The return type is mangled before the parameter
1596    types.
1597
1598      <function-type> ::= F [Y] <bare-function-type> E   */
1599
1600 static void
1601 write_function_type (type)
1602      tree type;
1603 {
1604   MANGLE_TRACE_TREE ("function-type", type);
1605
1606   /* For a pointer to member function, the function type may have
1607      cv-qualifiers, indicating the quals for the artificial 'this'
1608      parameter.  */
1609   if (TREE_CODE (type) == METHOD_TYPE)
1610     {
1611       /* The first parameter must be a POINTER_TYPE pointing to the
1612          `this' parameter.  */
1613       tree this_type = TREE_TYPE (TREE_VALUE (TYPE_ARG_TYPES (type)));
1614       write_CV_qualifiers_for_type (this_type);
1615     }
1616
1617   write_char ('F');
1618   /* We don't track whether or not a type is `extern "C"'.  Note that
1619      you can have an `extern "C"' function that does not have
1620      `extern "C"' type, and vice versa:
1621
1622        extern "C" typedef void function_t();
1623        function_t f; // f has C++ linkage, but its type is
1624                      // `extern "C"'
1625
1626        typedef void function_t();
1627        extern "C" function_t f; // Vice versa.
1628
1629      See [dcl.link].  */
1630   write_bare_function_type (type, /*include_return_type_p=*/1, 
1631                             /*decl=*/NULL);
1632   write_char ('E');
1633 }
1634
1635 /* Non-terminal <bare-function-type>.  TYPE is a FUNCTION_TYPE or
1636    METHOD_TYPE.  If INCLUDE_RETURN_TYPE is non-zero, the return value
1637    is mangled before the parameter types.  If non-NULL, DECL is
1638    FUNCTION_DECL for the function whose type is being emitted.
1639
1640      <bare-function-type> ::= </signature/ type>+  */
1641
1642 static void
1643 write_bare_function_type (type, include_return_type_p, decl)
1644      tree type;
1645      int include_return_type_p;
1646      tree decl;
1647 {
1648   MANGLE_TRACE_TREE ("bare-function-type", type);
1649
1650   /* Mangle the return type, if requested.  */
1651   if (include_return_type_p)
1652     write_type (TREE_TYPE (type));
1653
1654   /* Now mangle the types of the arguments.  */
1655   write_method_parms (TYPE_ARG_TYPES (type), 
1656                       TREE_CODE (type) == METHOD_TYPE,
1657                       decl);
1658 }
1659
1660 /* Write the mangled representation of a method parameter list of
1661    types given in PARM_TYPES.  If METHOD_P is non-zero, the function is 
1662    considered a non-static method, and the this parameter is omitted.
1663    If non-NULL, DECL is the FUNCTION_DECL for the function whose
1664    parameters are being emitted.  */
1665
1666 static void
1667 write_method_parms (parm_types, method_p, decl)
1668      tree decl;
1669      tree parm_types;
1670      int method_p;
1671 {
1672   tree first_parm_type;
1673   tree parm_decl = decl ? DECL_ARGUMENTS (decl) : NULL_TREE;
1674
1675   /* Assume this parameter type list is variable-length.  If it ends
1676      with a void type, then it's not.  */
1677   int varargs_p = 1;
1678
1679   /* If this is a member function, skip the first arg, which is the
1680      this pointer.  
1681        "Member functions do not encode the type of their implicit this
1682        parameter."  
1683   
1684      Similarly, there's no need to mangle artificial parameters, like
1685      the VTT parameters for constructors and destructors.  */
1686   if (method_p)
1687     {
1688       parm_types = TREE_CHAIN (parm_types);
1689       parm_decl = parm_decl ? TREE_CHAIN (parm_decl) : NULL_TREE;
1690
1691       while (parm_decl && DECL_ARTIFICIAL (parm_decl))
1692         {
1693           parm_types = TREE_CHAIN (parm_types);
1694           parm_decl = TREE_CHAIN (parm_decl);
1695         }
1696     }
1697
1698   for (first_parm_type = parm_types; 
1699        parm_types; 
1700        parm_types = TREE_CHAIN (parm_types))
1701     {
1702       tree parm = TREE_VALUE (parm_types);
1703       if (parm == void_type_node)
1704         {
1705           /* "Empty parameter lists, whether declared as () or
1706              conventionally as (void), are encoded with a void parameter
1707              (v)."  */
1708           if (parm_types == first_parm_type)
1709             write_type (parm);
1710           /* If the parm list is terminated with a void type, it's
1711              fixed-length.  */
1712           varargs_p = 0;
1713           /* A void type better be the last one.  */
1714           my_friendly_assert (TREE_CHAIN (parm_types) == NULL, 20000523);
1715         }
1716       else
1717         write_type (parm);
1718     }
1719
1720   if (varargs_p)
1721     /* <builtin-type> ::= z  # ellipsis  */
1722     write_char ('z');
1723 }
1724
1725 /* <class-enum-type> ::= <name>  */
1726
1727 static void 
1728 write_class_enum_type (type)
1729      tree type;
1730 {
1731   write_name (TYPE_NAME (type), /*ignore_local_scope=*/0);
1732 }
1733
1734 /* Non-terminal <template-args>.  ARGS is a TREE_VEC of template
1735    arguments.
1736
1737      <template-args> ::= I <template-arg>+ E  */
1738
1739 static void
1740 write_template_args (args)
1741      tree args;
1742 {
1743   int i;
1744   int length = TREE_VEC_LENGTH (args);
1745
1746   MANGLE_TRACE_TREE ("template-args", args);
1747
1748   my_friendly_assert (length > 0, 20000422);
1749
1750   if (TREE_CODE (TREE_VEC_ELT (args, 0)) == TREE_VEC)
1751     {
1752       /* We have nested template args.  We want the innermost template
1753          argument list.  */
1754       args = TREE_VEC_ELT (args, length - 1);
1755       length = TREE_VEC_LENGTH (args);
1756     }
1757
1758   write_char ('I');
1759   for (i = 0; i < length; ++i)
1760     write_template_arg (TREE_VEC_ELT (args, i));
1761   write_char ('E');
1762 }
1763
1764 /* <expression> ::= <unary operator-name> <expression>
1765                 ::= <binary operator-name> <expression> <expression>
1766                 ::= <expr-primary>
1767
1768    <expr-primary> ::= <template-param>
1769                   ::= L <type> <value number> E  # literal
1770                   ::= L <mangled-name> E         # external name  */
1771
1772 static void
1773 write_expression (expr)
1774      tree expr;
1775 {
1776   enum tree_code code;
1777
1778   code = TREE_CODE (expr);
1779
1780   /* Handle pointers-to-members by making them look like expression
1781      nodes.  */
1782   if (code == PTRMEM_CST)
1783     {
1784       expr = build_nt (ADDR_EXPR,
1785                        build_nt (SCOPE_REF,
1786                                  PTRMEM_CST_CLASS (expr),
1787                                  PTRMEM_CST_MEMBER (expr)));
1788       code = TREE_CODE (expr);
1789     }
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          || TREE_CODE (expr) == NON_LVALUE_EXPR)
1796     {
1797       expr = TREE_OPERAND (expr, 0);
1798       code = TREE_CODE (expr);
1799     }
1800
1801   /* Handle template parameters. */
1802   if (code == TEMPLATE_TYPE_PARM 
1803       || code == TEMPLATE_TEMPLATE_PARM
1804       || code == BOUND_TEMPLATE_TEMPLATE_PARM
1805       || code == TEMPLATE_PARM_INDEX)
1806     write_template_param (expr);
1807   /* Handle literals.  */
1808   else if (TREE_CODE_CLASS (code) == 'c')
1809     write_template_arg_literal (expr);
1810   else if (DECL_P (expr))
1811     {
1812       write_char ('L');
1813       write_mangled_name (expr);
1814       write_char ('E');
1815     }
1816   else
1817     {
1818       int i;
1819
1820       /* When we bind a variable or function to a non-type template
1821          argument with reference type, we create an ADDR_EXPR to show
1822          the fact that the entity's address has been taken.  But, we
1823          don't actually want to output a mangling code for the `&'.  */
1824       if (TREE_CODE (expr) == ADDR_EXPR
1825           && TREE_TYPE (expr)
1826           && TREE_CODE (TREE_TYPE (expr)) == REFERENCE_TYPE)
1827         {
1828           expr = TREE_OPERAND (expr, 0);
1829           if (DECL_P (expr))
1830             {
1831               write_expression (expr);
1832               return;
1833             }
1834
1835           code = TREE_CODE (expr);
1836         }
1837       
1838       /* If it wasn't any of those, recursively expand the expression.  */
1839       write_string (operator_name_info[(int) code].mangled_name);
1840
1841       switch (code)
1842         {
1843         case CAST_EXPR:
1844           write_type (TREE_TYPE (expr));
1845           write_expression (TREE_VALUE (TREE_OPERAND (expr, 0)));
1846           break;
1847
1848         case STATIC_CAST_EXPR:
1849         case CONST_CAST_EXPR:
1850           write_type (TREE_TYPE (expr));
1851           write_expression (TREE_OPERAND (expr, 0));
1852           break;
1853
1854         /* Handle pointers-to-members specially.  */
1855         case SCOPE_REF:
1856           write_type (TREE_OPERAND (expr, 0));
1857           if (TREE_CODE (TREE_OPERAND (expr, 1)) == IDENTIFIER_NODE)
1858             write_source_name (TREE_OPERAND (expr, 1));
1859           else
1860             write_encoding (TREE_OPERAND (expr, 1));
1861           break;
1862
1863         default:
1864           for (i = 0; i < TREE_CODE_LENGTH (code); ++i)
1865             write_expression (TREE_OPERAND (expr, i));
1866         }
1867     }
1868 }
1869
1870 /* Literal subcase of non-terminal <template-arg>.  
1871
1872      "Literal arguments, e.g. "A<42L>", are encoded with their type
1873      and value. Negative integer values are preceded with "n"; for
1874      example, "A<-42L>" becomes "1AILln42EE". The bool value false is
1875      encoded as 0, true as 1. If floating-point arguments are accepted
1876      as an extension, their values should be encoded using a
1877      fixed-length lowercase hexadecimal string corresponding to the
1878      internal representation (IEEE on IA-64), high-order bytes first,
1879      without leading zeroes. For example: "Lfbff000000E" is -1.0f."  */
1880
1881 static void
1882 write_template_arg_literal (value)
1883      tree value;
1884 {
1885   tree type = TREE_TYPE (value);
1886   write_char ('L');
1887   write_type (type);
1888
1889   if (TREE_CODE (value) == CONST_DECL)
1890     write_integer_cst (DECL_INITIAL (value));
1891   else if (TREE_CODE (value) == INTEGER_CST)
1892     {
1893       if (same_type_p (type, boolean_type_node))
1894         {
1895           if (value == boolean_false_node || integer_zerop (value))
1896             write_unsigned_number (0);
1897           else if (value == boolean_true_node)
1898             write_unsigned_number (1);
1899           else 
1900             abort ();
1901         }
1902       else
1903         write_integer_cst (value);
1904     }
1905   else if (TREE_CODE (value) == REAL_CST)
1906     {
1907 #ifdef CROSS_COMPILE
1908       static int explained;
1909
1910       if (!explained) 
1911         {
1912           sorry ("real-valued template parameters when cross-compiling");
1913           explained = 1;
1914         }
1915 #else
1916       size_t i;
1917       for (i = 0; i < sizeof (TREE_REAL_CST (value)); ++i)
1918         write_number (((unsigned char *) 
1919                        &TREE_REAL_CST (value))[i], 
1920                       /*unsigned_p=*/1,
1921                       16);
1922 #endif
1923     }
1924   else
1925     abort ();
1926
1927   write_char ('E');
1928 }
1929
1930 /* Non-terminal <tempalate-arg>.  
1931
1932      <template-arg> ::= <type>                        # type
1933                     ::= L <type> </value/ number> E   # literal
1934                     ::= LZ <name> E                   # external name
1935                     ::= X <expression> E              # expression  */
1936
1937 static void
1938 write_template_arg (node)
1939      tree node;
1940 {
1941   enum tree_code code = TREE_CODE (node);
1942
1943   MANGLE_TRACE_TREE ("template-arg", node);
1944
1945   /* A template template paramter's argument list contains TREE_LIST
1946      nodes of which the value field is the the actual argument.  */
1947   if (code == TREE_LIST)
1948     {
1949       node = TREE_VALUE (node);
1950       /* If it's a decl, deal with its type instead.  */
1951       if (DECL_P (node))
1952         {
1953           node = TREE_TYPE (node);
1954           code = TREE_CODE (node);
1955         }
1956     }
1957
1958   if (TYPE_P (node))
1959     write_type (node);
1960   else if (code == TEMPLATE_DECL)
1961     /* A template appearing as a template arg is a template template arg.  */
1962     write_template_template_arg (node);
1963   else if (DECL_P (node))
1964     {
1965       write_char ('L');
1966       write_char ('Z');
1967       write_encoding (node);
1968       write_char ('E');
1969     }
1970   else if (TREE_CODE_CLASS (code) == 'c' && code != PTRMEM_CST)
1971     write_template_arg_literal (node);
1972   else
1973     {
1974       /* Template arguments may be expressions.  */
1975       write_char ('X');
1976       write_expression (node);
1977       write_char ('E');
1978     }
1979 }
1980
1981 /*  <template-template-arg>
1982                         ::= <name>
1983                         ::= <substitution>  */
1984
1985 void
1986 write_template_template_arg (tree decl)
1987 {
1988   MANGLE_TRACE_TREE ("template-template-arg", decl);
1989
1990   if (find_substitution (decl))
1991     return;
1992   write_name (decl, /*ignore_local_scope=*/0);
1993   add_substitution (decl);
1994 }
1995
1996
1997 /* Non-terminal <array-type>.  TYPE is an ARRAY_TYPE.  
1998
1999      <array-type> ::= A [</dimension/ number>] _ </element/ type>  
2000                   ::= A <expression> _ </element/ type>
2001
2002      "Array types encode the dimension (number of elements) and the
2003      element type. For variable length arrays, the dimension (but not
2004      the '_' separator) is omitted."  */
2005
2006 static void 
2007 write_array_type (type)
2008   tree type;
2009 {
2010   write_char ('A');
2011   if (TYPE_DOMAIN (type))
2012     {
2013       tree index_type;
2014       tree max;
2015
2016       index_type = TYPE_DOMAIN (type);
2017       /* The INDEX_TYPE gives the upper and lower bounds of the
2018          array.  */
2019       max = TYPE_MAX_VALUE (index_type);
2020       if (TREE_CODE (max) == INTEGER_CST)
2021         {
2022           /* The ABI specifies that we should mangle the number of
2023              elements in the array, not the largest allowed index.  */
2024           max = size_binop (PLUS_EXPR, max, size_one_node);
2025           write_unsigned_number (tree_low_cst (max, 1));
2026         }
2027       else
2028         write_expression (TREE_OPERAND (max, 0));
2029     }
2030   write_char ('_');
2031   write_type (TREE_TYPE (type));
2032 }
2033
2034 /* Non-terminal <pointer-to-member-type> for pointer-to-member
2035    variables.  TYPE is a pointer-to-member POINTER_TYPE.
2036
2037      <pointer-to-member-type> ::= M </class/ type> </member/ type>  */
2038
2039 static void
2040 write_pointer_to_member_type (type)
2041      tree type;
2042 {
2043   write_char ('M');
2044   write_type (TYPE_PTRMEM_CLASS_TYPE (type));
2045   write_type (TYPE_PTRMEM_POINTED_TO_TYPE (type));
2046 }
2047
2048 /* Non-terminal <template-param>.  PARM is a TEMPLATE_TYPE_PARM,
2049    TEMPLATE_TEMPLATE_PARM, BOUND_TEMPLATE_TEMPLATE_PARM or a
2050    TEMPLATE_PARM_INDEX.
2051
2052      <template-param> ::= T </parameter/ number> _  */
2053
2054 static void
2055 write_template_param (parm)
2056      tree parm;
2057 {
2058   int parm_index;
2059
2060   MANGLE_TRACE_TREE ("template-parm", parm);
2061
2062   switch (TREE_CODE (parm))
2063     {
2064     case TEMPLATE_TYPE_PARM:
2065     case TEMPLATE_TEMPLATE_PARM:
2066     case BOUND_TEMPLATE_TEMPLATE_PARM:
2067       parm_index = TEMPLATE_TYPE_IDX (parm);
2068       break;
2069
2070     case TEMPLATE_PARM_INDEX:
2071       parm_index = TEMPLATE_PARM_IDX (parm);
2072       break;
2073
2074     default:
2075       abort ();
2076     }
2077
2078   write_char ('T');
2079   /* NUMBER as it appears in the mangling is (-1)-indexed, with the
2080      earliest template param denoted by `_'.  */
2081   if (parm_index > 0)
2082     write_unsigned_number (parm_index - 1);
2083   write_char ('_');
2084 }
2085
2086 /*  <template-template-param>
2087                         ::= <template-param> 
2088                         ::= <substitution>  */
2089
2090 static void
2091 write_template_template_param (parm)
2092      tree parm;
2093 {
2094   tree template = NULL_TREE;
2095
2096   /* PARM, a TEMPLATE_TEMPLATE_PARM, is an instantiation of the
2097      template template parameter.  The substitution candidate here is
2098      only the template.  */
2099   if (TREE_CODE (parm) == BOUND_TEMPLATE_TEMPLATE_PARM)
2100     {
2101       template 
2102         = TI_TEMPLATE (TEMPLATE_TEMPLATE_PARM_TEMPLATE_INFO (parm));
2103       if (find_substitution (template))
2104         return;
2105     }
2106
2107   /* <template-param> encodes only the template parameter position,
2108      not its template arguments, which is fine here.  */
2109   write_template_param (parm);
2110   if (template)
2111     add_substitution (template);
2112 }
2113
2114 /* Non-terminal <substitution>.  
2115
2116       <substitution> ::= S <seq-id> _
2117                      ::= S_  */
2118
2119 static void
2120 write_substitution (seq_id)
2121      int seq_id;
2122 {
2123   MANGLE_TRACE ("substitution", "");
2124
2125   write_char ('S');
2126   if (seq_id > 0)
2127     write_number (seq_id - 1, /*unsigned=*/1, 36);
2128   write_char ('_');
2129 }
2130
2131 /* Start mangling a new name or type.  */
2132
2133 static inline void
2134 start_mangling ()
2135 {
2136   obstack_free (&G.name_obstack, obstack_base (&G.name_obstack));
2137 }
2138
2139 /* Done with mangling.  Return the generated mangled name.  */
2140
2141 static inline const char *
2142 finish_mangling ()
2143 {
2144   /* Clear all the substitutions.  */
2145   VARRAY_POP_ALL (G.substitutions);
2146
2147   /* Null-terminate the string.  */
2148   write_char ('\0');
2149
2150   return (const char *) obstack_base (&G.name_obstack);
2151 }
2152
2153 /* Initialize data structures for mangling.  */
2154
2155 void
2156 init_mangle ()
2157 {
2158   gcc_obstack_init (&G.name_obstack);
2159   VARRAY_TREE_INIT (G.substitutions, 1, "mangling substitutions");
2160
2161   /* Cache these identifiers for quick comparison when checking for
2162      standard substitutions.  */
2163   subst_identifiers[SUBID_ALLOCATOR] = get_identifier ("allocator");
2164   subst_identifiers[SUBID_BASIC_STRING] = get_identifier ("basic_string");
2165   subst_identifiers[SUBID_CHAR_TRAITS] = get_identifier ("char_traits");
2166   subst_identifiers[SUBID_BASIC_ISTREAM] = get_identifier ("basic_istream");
2167   subst_identifiers[SUBID_BASIC_OSTREAM] = get_identifier ("basic_ostream");
2168   subst_identifiers[SUBID_BASIC_IOSTREAM] = get_identifier ("basic_iostream");
2169 }
2170
2171 /* Generate the mangled name of DECL.  */
2172
2173 static const char *
2174 mangle_decl_string (decl)
2175      tree decl;
2176 {
2177   const char *result;
2178
2179   start_mangling ();
2180
2181   if (TREE_CODE (decl) == TYPE_DECL)
2182     write_type (TREE_TYPE (decl));
2183   else if (/* The names of `extern "C"' functions are not mangled.  */
2184            (DECL_EXTERN_C_FUNCTION_P (decl)
2185             /* But overloaded operator names *are* mangled.  */
2186             && !DECL_OVERLOADED_OPERATOR_P (decl))
2187            /* The names of global variables aren't mangled either.  */
2188            || (TREE_CODE (decl) == VAR_DECL
2189                && CP_DECL_CONTEXT (decl) == global_namespace)
2190            /* And neither are `extern "C"' variables.  */
2191            || (TREE_CODE (decl) == VAR_DECL
2192                && DECL_EXTERN_C_P (decl)))
2193     write_string (IDENTIFIER_POINTER (DECL_NAME (decl)));
2194   else
2195     {
2196       write_mangled_name (decl);
2197       if (DECL_LANG_SPECIFIC (decl)
2198           && (DECL_MAYBE_IN_CHARGE_DESTRUCTOR_P (decl)
2199               || DECL_MAYBE_IN_CHARGE_CONSTRUCTOR_P (decl)))
2200         /* We need a distinct mangled name for these entities, but
2201            we should never actually output it.  So, we append some
2202            characters the assembler won't like.  */
2203         write_string (" *INTERNAL* ");
2204     }
2205
2206   result = finish_mangling ();
2207   if (DEBUG_MANGLE)
2208     fprintf (stderr, "mangle_decl_string = '%s'\n\n", result);
2209   return result;
2210 }
2211
2212 /* Create an identifier for the external mangled name of DECL.  */
2213
2214 void
2215 mangle_decl (decl)
2216      tree decl;
2217 {
2218   tree id = get_identifier (mangle_decl_string (decl));
2219
2220   SET_DECL_ASSEMBLER_NAME (decl, id);
2221 }
2222
2223 /* Generate the mangled representation of TYPE.  */
2224
2225 const char *
2226 mangle_type_string (type)
2227      tree type;
2228 {
2229   const char *result;
2230
2231   start_mangling ();
2232   write_type (type);
2233   result = finish_mangling ();
2234   if (DEBUG_MANGLE)
2235     fprintf (stderr, "mangle_type_string = '%s'\n\n", result);
2236   return result;
2237 }
2238
2239 /* Create an identifier for the mangled representation of TYPE.  */
2240
2241 tree
2242 mangle_type (type)
2243      tree type;
2244 {
2245   return get_identifier (mangle_type_string (type));
2246 }
2247
2248 /* Create an identifier for the mangled name of a special component
2249    for belonging to TYPE.  CODE is the ABI-specified code for this
2250    component.  */
2251
2252 static tree
2253 mangle_special_for_type (type, code)
2254      tree type;
2255      const char *code;
2256 {
2257   const char *result;
2258
2259   /* We don't have an actual decl here for the special component, so
2260      we can't just process the <encoded-name>.  Instead, fake it.  */
2261   start_mangling ();
2262
2263   /* Start the mangling.  */
2264   write_string ("_Z");
2265   write_string (code);
2266
2267   /* Add the type.  */
2268   write_type (type);
2269   result = finish_mangling ();
2270
2271   if (DEBUG_MANGLE)
2272     fprintf (stderr, "mangle_special_for_type = %s\n\n", result);
2273
2274   return get_identifier (result);
2275 }
2276
2277 /* Create an identifier for the mangled representation of the typeinfo
2278    structure for TYPE.  */
2279
2280 tree
2281 mangle_typeinfo_for_type (type)
2282      tree type;
2283 {
2284   return mangle_special_for_type (type, "TI");
2285 }
2286
2287 /* Create an identifier for the mangled name of the NTBS containing
2288    the mangled name of TYPE.  */
2289
2290 tree
2291 mangle_typeinfo_string_for_type (type)
2292      tree type;
2293 {
2294   return mangle_special_for_type (type, "TS");
2295 }
2296
2297 /* Create an identifier for the mangled name of the vtable for TYPE.  */
2298
2299 tree
2300 mangle_vtbl_for_type (type)
2301      tree type;
2302 {
2303   return mangle_special_for_type (type, "TV");
2304 }
2305
2306 /* Returns an identifier for the mangled name of the VTT for TYPE.  */
2307
2308 tree
2309 mangle_vtt_for_type (type)
2310      tree type;
2311 {
2312   return mangle_special_for_type (type, "TT");
2313 }
2314
2315 /* Return an identifier for a construction vtable group.  TYPE is
2316    the most derived class in the hierarchy; BINFO is the base
2317    subobject for which this construction vtable group will be used.  
2318
2319    This mangling isn't part of the ABI specification; in the ABI
2320    specification, the vtable group is dumped in the same COMDAT as the
2321    main vtable, and is referenced only from that vtable, so it doesn't
2322    need an external name.  For binary formats without COMDAT sections,
2323    though, we need external names for the vtable groups.  
2324
2325    We use the production
2326
2327     <special-name> ::= CT <type> <offset number> _ <base type>  */
2328
2329 tree
2330 mangle_ctor_vtbl_for_type (type, binfo)
2331      tree type;
2332      tree binfo;
2333 {
2334   const char *result;
2335
2336   start_mangling ();
2337
2338   write_string ("_Z");
2339   write_string ("TC");
2340   write_type (type);
2341   write_integer_cst (BINFO_OFFSET (binfo));
2342   write_char ('_');
2343   write_type (BINFO_TYPE (binfo));
2344
2345   result = finish_mangling ();
2346   if (DEBUG_MANGLE)
2347     fprintf (stderr, "mangle_ctor_vtbl_for_type = %s\n\n", result);
2348   return get_identifier (result);
2349 }
2350
2351 /* Return an identifier for the mangled name of a thunk to FN_DECL.
2352    OFFSET is the initial adjustment to this used to find the vptr.  If
2353    VCALL_OFFSET is non-NULL, this is a virtual thunk, and it is the
2354    vtbl offset in bytes.  
2355
2356     <special-name> ::= Th <offset number> _ <base encoding>
2357                    ::= Tv <offset number> _ <vcall offset number> _
2358                                                             <base encoding>
2359 */
2360
2361 tree
2362 mangle_thunk (fn_decl, offset, vcall_offset)
2363      tree fn_decl;
2364      tree offset;
2365      tree vcall_offset;
2366 {
2367   const char *result;
2368   
2369   start_mangling ();
2370
2371   write_string ("_Z");
2372   /* The <special-name> for virtual thunks is Tv, for non-virtual
2373      thunks Th.  */
2374   write_char ('T');
2375   if (vcall_offset != 0)
2376     write_char ('v');
2377   else
2378     write_char ('h');
2379
2380   /* For either flavor, write the offset to this.  */
2381   write_integer_cst (offset);
2382   write_char ('_');
2383
2384   /* For a virtual thunk, add the vcall offset.  */
2385   if (vcall_offset)
2386     {
2387       /* Virtual thunk.  Write the vcall offset and base type name.  */
2388       write_integer_cst (vcall_offset);
2389       write_char ('_');
2390     }
2391
2392   /* Scoped name.  */
2393   write_encoding (fn_decl);
2394
2395   result = finish_mangling ();
2396   if (DEBUG_MANGLE)
2397     fprintf (stderr, "mangle_thunk = %s\n\n", result);
2398   return get_identifier (result);
2399 }
2400
2401 /* Return an identifier for the mangled unqualified name for a
2402    conversion operator to TYPE.  This mangling is not specified by the
2403    ABI spec; it is only used internally.  */
2404
2405 tree
2406 mangle_conv_op_name_for_type (type)
2407      tree type;
2408 {
2409   tree identifier;
2410
2411   /* Build the mangling for TYPE.  */
2412   const char *mangled_type = mangle_type_string (type);
2413   /* Allocate a temporary buffer for the complete name.  */
2414   char *op_name = concat ("operator ", mangled_type, NULL);
2415   /* Find or create an identifier.  */
2416   identifier = get_identifier (op_name);
2417   /* Done with the temporary buffer.  */
2418   free (op_name);
2419   /* Set bits on the identifier so we know later it's a conversion.  */
2420   IDENTIFIER_OPNAME_P (identifier) = 1;
2421   IDENTIFIER_TYPENAME_P (identifier) = 1;
2422   /* Hang TYPE off the identifier so it can be found easily later when
2423      performing conversions.  */
2424   TREE_TYPE (identifier) = type;
2425
2426   return identifier;
2427 }
2428
2429 /* Return an identifier for the name of an initialization guard
2430    variable for indicated VARIABLE.  */
2431
2432 tree
2433 mangle_guard_variable (variable)
2434      tree variable;
2435 {
2436   start_mangling ();
2437   write_string ("_ZGV");
2438   if (strncmp (IDENTIFIER_POINTER (DECL_NAME (variable)), "_ZGR", 4) == 0)
2439     /* The name of a guard variable for a reference temporary should refer
2440        to the reference, not the temporary.  */
2441     write_string (IDENTIFIER_POINTER (DECL_NAME (variable)) + 4);
2442   else
2443     write_name (variable, /*ignore_local_scope=*/0);
2444   return get_identifier (finish_mangling ());
2445 }
2446
2447 /* Return an identifier for the name of a temporary variable used to
2448    initialize a static reference.  This isn't part of the ABI, but we might
2449    as well call them something readable.  */
2450
2451 tree
2452 mangle_ref_init_variable (variable)
2453      tree variable;
2454 {
2455   start_mangling ();
2456   write_string ("_ZGR");
2457   write_name (variable, /*ignore_local_scope=*/0);
2458   return get_identifier (finish_mangling ());
2459 }
2460 \f
2461
2462 /* Foreign language type mangling section.  */
2463
2464 /* How to write the type codes for the integer Java type.  */
2465
2466 static void
2467 write_java_integer_type_codes (type)
2468      tree type;
2469 {
2470   if (type == java_int_type_node)
2471     write_char ('i');
2472   else if (type == java_short_type_node)
2473     write_char ('s');
2474   else if (type == java_byte_type_node)
2475     write_char ('c');
2476   else if (type == java_char_type_node)
2477     write_char ('w');
2478   else if (type == java_long_type_node)
2479     write_char ('x');
2480   else if (type == java_boolean_type_node)
2481     write_char ('b');
2482   else
2483     abort ();
2484 }
2485