Add support for C++0x nullptr.
[platform/upstream/gcc.git] / gcc / cp / mangle.c
1 /* Name mangling for the 3.0 C++ ABI.
2    Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2007, 2008, 2009
3    Free Software Foundation, Inc.
4    Written by Alex Samuel <samuel@codesourcery.com>
5
6    This file is part of GCC.
7
8    GCC is free software; you can redistribute it and/or modify it
9    under the terms of the GNU General Public License as published by
10    the Free Software Foundation; either version 3, or (at your option)
11    any later version.
12
13    GCC is distributed in the hope that it will be useful, but
14    WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16    General Public License for more details.
17
18 You should have received a copy of the GNU General Public License
19 along with GCC; see the file COPYING3.  If not see
20 <http://www.gnu.org/licenses/>.  */
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 #include "config.h"
49 #include "system.h"
50 #include "coretypes.h"
51 #include "tm.h"
52 #include "tree.h"
53 #include "tm_p.h"
54 #include "cp-tree.h"
55 #include "real.h"
56 #include "obstack.h"
57 #include "toplev.h"
58 #include "flags.h"
59 #include "target.h"
60 #include "cgraph.h"
61
62 /* Debugging support.  */
63
64 /* Define DEBUG_MANGLE to enable very verbose trace messages.  */
65 #ifndef DEBUG_MANGLE
66 #define DEBUG_MANGLE 0
67 #endif
68
69 /* Macros for tracing the write_* functions.  */
70 #if DEBUG_MANGLE
71 # define MANGLE_TRACE(FN, INPUT) \
72   fprintf (stderr, "  %-24s: %-24s\n", (FN), (INPUT))
73 # define MANGLE_TRACE_TREE(FN, NODE) \
74   fprintf (stderr, "  %-24s: %-24s (%p)\n", \
75            (FN), tree_code_name[TREE_CODE (NODE)], (void *) (NODE))
76 #else
77 # define MANGLE_TRACE(FN, INPUT)
78 # define MANGLE_TRACE_TREE(FN, NODE)
79 #endif
80
81 /* Nonzero if NODE is a class template-id.  We can't rely on
82    CLASSTYPE_USE_TEMPLATE here because of tricky bugs in the parser
83    that hard to distinguish A<T> from A, where A<T> is the type as
84    instantiated outside of the template, and A is the type used
85    without parameters inside the template.  */
86 #define CLASSTYPE_TEMPLATE_ID_P(NODE)                                   \
87   (TYPE_LANG_SPECIFIC (NODE) != NULL                                    \
88    && (TREE_CODE (NODE) == BOUND_TEMPLATE_TEMPLATE_PARM                 \
89        || (CLASSTYPE_TEMPLATE_INFO (NODE) != NULL                       \
90            && (PRIMARY_TEMPLATE_P (CLASSTYPE_TI_TEMPLATE (NODE))))))
91
92 /* Things we only need one of.  This module is not reentrant.  */
93 typedef struct GTY(()) globals {
94   /* An array of the current substitution candidates, in the order
95      we've seen them.  */
96   VEC(tree,gc) *substitutions;
97
98   /* The entity that is being mangled.  */
99   tree GTY ((skip)) entity;
100
101   /* True if the mangling will be different in a future version of the
102      ABI.  */
103   bool need_abi_warning;
104 } globals;
105
106 static GTY (()) globals G;
107
108 /* The obstack on which we build mangled names.  */
109 static struct obstack *mangle_obstack;
110
111 /* The obstack on which we build mangled names that are not going to
112    be IDENTIFIER_NODEs.  */
113 static struct obstack name_obstack;
114
115 /* The first object on the name_obstack; we use this to free memory
116    allocated on the name_obstack.  */
117 static void *name_base;
118
119 /* Indices into subst_identifiers.  These are identifiers used in
120    special substitution rules.  */
121 typedef enum
122 {
123   SUBID_ALLOCATOR,
124   SUBID_BASIC_STRING,
125   SUBID_CHAR_TRAITS,
126   SUBID_BASIC_ISTREAM,
127   SUBID_BASIC_OSTREAM,
128   SUBID_BASIC_IOSTREAM,
129   SUBID_MAX
130 }
131 substitution_identifier_index_t;
132
133 /* For quick substitution checks, look up these common identifiers
134    once only.  */
135 static GTY(()) tree subst_identifiers[SUBID_MAX];
136
137 /* Single-letter codes for builtin integer types, defined in
138    <builtin-type>.  These are indexed by integer_type_kind values.  */
139 static const char
140 integer_type_codes[itk_none] =
141 {
142   'c',  /* itk_char */
143   'a',  /* itk_signed_char */
144   'h',  /* itk_unsigned_char */
145   's',  /* itk_short */
146   't',  /* itk_unsigned_short */
147   'i',  /* itk_int */
148   'j',  /* itk_unsigned_int */
149   'l',  /* itk_long */
150   'm',  /* itk_unsigned_long */
151   'x',  /* itk_long_long */
152   'y'   /* itk_unsigned_long_long */
153 };
154
155 static int decl_is_template_id (const tree, tree* const);
156
157 /* Functions for handling substitutions.  */
158
159 static inline tree canonicalize_for_substitution (tree);
160 static void add_substitution (tree);
161 static inline int is_std_substitution (const tree,
162                                        const substitution_identifier_index_t);
163 static inline int is_std_substitution_char (const tree,
164                                             const substitution_identifier_index_t);
165 static int find_substitution (tree);
166 static void mangle_call_offset (const tree, const tree);
167
168 /* Functions for emitting mangled representations of things.  */
169
170 static void write_mangled_name (const tree, bool);
171 static void write_encoding (const tree);
172 static void write_name (tree, const int);
173 static void write_unscoped_name (const tree);
174 static void write_unscoped_template_name (const tree);
175 static void write_nested_name (const tree);
176 static void write_prefix (const tree);
177 static void write_template_prefix (const tree);
178 static void write_unqualified_name (const tree);
179 static void write_conversion_operator_name (const tree);
180 static void write_source_name (tree);
181 static void write_unnamed_type_name (const tree);
182 static void write_closure_type_name (const tree);
183 static int hwint_to_ascii (unsigned HOST_WIDE_INT, const unsigned int, char *,
184                            const unsigned int);
185 static void write_number (unsigned HOST_WIDE_INT, const int,
186                           const unsigned int);
187 static void write_compact_number (int num);
188 static void write_integer_cst (const tree);
189 static void write_real_cst (const tree);
190 static void write_identifier (const char *);
191 static void write_special_name_constructor (const tree);
192 static void write_special_name_destructor (const tree);
193 static void write_type (tree);
194 static int write_CV_qualifiers_for_type (const tree);
195 static void write_builtin_type (tree);
196 static void write_function_type (const tree);
197 static void write_bare_function_type (const tree, const int, const tree);
198 static void write_method_parms (tree, const int, const tree);
199 static void write_class_enum_type (const tree);
200 static void write_template_args (tree);
201 static void write_expression (tree);
202 static void write_template_arg_literal (const tree);
203 static void write_template_arg (tree);
204 static void write_template_template_arg (const tree);
205 static void write_array_type (const tree);
206 static void write_pointer_to_member_type (const tree);
207 static void write_template_param (const tree);
208 static void write_template_template_param (const tree);
209 static void write_substitution (const int);
210 static int discriminator_for_local_entity (tree);
211 static int discriminator_for_string_literal (tree, tree);
212 static void write_discriminator (const int);
213 static void write_local_name (tree, const tree, const tree);
214 static void dump_substitution_candidates (void);
215 static tree mangle_decl_string (const tree);
216 static int local_class_index (tree);
217
218 /* Control functions.  */
219
220 static inline void start_mangling (const tree);
221 static inline const char *finish_mangling (const bool);
222 static tree mangle_special_for_type (const tree, const char *);
223
224 /* Foreign language functions.  */
225
226 static void write_java_integer_type_codes (const tree);
227
228 /* Append a single character to the end of the mangled
229    representation.  */
230 #define write_char(CHAR)                                                \
231   obstack_1grow (mangle_obstack, (CHAR))
232
233 /* Append a sized buffer to the end of the mangled representation.  */
234 #define write_chars(CHAR, LEN)                                          \
235   obstack_grow (mangle_obstack, (CHAR), (LEN))
236
237 /* Append a NUL-terminated string to the end of the mangled
238    representation.  */
239 #define write_string(STRING)                                            \
240   obstack_grow (mangle_obstack, (STRING), strlen (STRING))
241
242 /* Nonzero if NODE1 and NODE2 are both TREE_LIST nodes and have the
243    same purpose (context, which may be a type) and value (template
244    decl).  See write_template_prefix for more information on what this
245    is used for.  */
246 #define NESTED_TEMPLATE_MATCH(NODE1, NODE2)                             \
247   (TREE_CODE (NODE1) == TREE_LIST                                       \
248    && TREE_CODE (NODE2) == TREE_LIST                                    \
249    && ((TYPE_P (TREE_PURPOSE (NODE1))                                   \
250         && same_type_p (TREE_PURPOSE (NODE1), TREE_PURPOSE (NODE2)))    \
251        || TREE_PURPOSE (NODE1) == TREE_PURPOSE (NODE2))                 \
252    && TREE_VALUE (NODE1) == TREE_VALUE (NODE2))
253
254 /* Write out an unsigned quantity in base 10.  */
255 #define write_unsigned_number(NUMBER)                                   \
256   write_number ((NUMBER), /*unsigned_p=*/1, 10)
257
258 /* If DECL is a template instance, return nonzero and, if
259    TEMPLATE_INFO is non-NULL, set *TEMPLATE_INFO to its template info.
260    Otherwise return zero.  */
261
262 static int
263 decl_is_template_id (const tree decl, tree* const template_info)
264 {
265   if (TREE_CODE (decl) == TYPE_DECL)
266     {
267       /* TYPE_DECLs are handled specially.  Look at its type to decide
268          if this is a template instantiation.  */
269       const tree type = TREE_TYPE (decl);
270
271       if (CLASS_TYPE_P (type) && CLASSTYPE_TEMPLATE_ID_P (type))
272         {
273           if (template_info != NULL)
274             /* For a templated TYPE_DECL, the template info is hanging
275                off the type.  */
276             *template_info = TYPE_TEMPLATE_INFO (type);
277           return 1;
278         }
279     }
280   else
281     {
282       /* Check if this is a primary template.  */
283       if (DECL_LANG_SPECIFIC (decl) != NULL
284           && DECL_USE_TEMPLATE (decl)
285           && PRIMARY_TEMPLATE_P (DECL_TI_TEMPLATE (decl))
286           && TREE_CODE (decl) != TEMPLATE_DECL)
287         {
288           if (template_info != NULL)
289             /* For most templated decls, the template info is hanging
290                off the decl.  */
291             *template_info = DECL_TEMPLATE_INFO (decl);
292           return 1;
293         }
294     }
295
296   /* It's not a template id.  */
297   return 0;
298 }
299
300 /* Produce debugging output of current substitution candidates.  */
301
302 static void
303 dump_substitution_candidates (void)
304 {
305   unsigned i;
306   tree el;
307
308   fprintf (stderr, "  ++ substitutions  ");
309   for (i = 0; VEC_iterate (tree, G.substitutions, i, el); ++i)
310     {
311       const char *name = "???";
312
313       if (i > 0)
314         fprintf (stderr, "                    ");
315       if (DECL_P (el))
316         name = IDENTIFIER_POINTER (DECL_NAME (el));
317       else if (TREE_CODE (el) == TREE_LIST)
318         name = IDENTIFIER_POINTER (DECL_NAME (TREE_VALUE (el)));
319       else if (TYPE_NAME (el))
320         name = IDENTIFIER_POINTER (DECL_NAME (TYPE_NAME (el)));
321       fprintf (stderr, " S%d_ = ", i - 1);
322       if (TYPE_P (el) &&
323           (CP_TYPE_RESTRICT_P (el)
324            || CP_TYPE_VOLATILE_P (el)
325            || CP_TYPE_CONST_P (el)))
326         fprintf (stderr, "CV-");
327       fprintf (stderr, "%s (%s at %p)\n",
328                name, tree_code_name[TREE_CODE (el)], (void *) el);
329     }
330 }
331
332 /* Both decls and types can be substitution candidates, but sometimes
333    they refer to the same thing.  For instance, a TYPE_DECL and
334    RECORD_TYPE for the same class refer to the same thing, and should
335    be treated accordingly in substitutions.  This function returns a
336    canonicalized tree node representing NODE that is used when adding
337    and substitution candidates and finding matches.  */
338
339 static inline tree
340 canonicalize_for_substitution (tree node)
341 {
342   /* For a TYPE_DECL, use the type instead.  */
343   if (TREE_CODE (node) == TYPE_DECL)
344     node = TREE_TYPE (node);
345   if (TYPE_P (node)
346       && TYPE_CANONICAL (node) != node
347       && TYPE_MAIN_VARIANT (node) != node)
348       /* Here we want to strip the topmost typedef only.
349          We need to do that so is_std_substitution can do proper
350          name matching.  */
351     node = cp_build_qualified_type (TYPE_MAIN_VARIANT (node),
352                                     cp_type_quals (node));
353   return node;
354 }
355
356 /* Add NODE as a substitution candidate.  NODE must not already be on
357    the list of candidates.  */
358
359 static void
360 add_substitution (tree node)
361 {
362   tree c;
363
364   if (DEBUG_MANGLE)
365     fprintf (stderr, "  ++ add_substitution (%s at %10p)\n",
366              tree_code_name[TREE_CODE (node)], (void *) node);
367
368   /* Get the canonicalized substitution candidate for NODE.  */
369   c = canonicalize_for_substitution (node);
370   if (DEBUG_MANGLE && c != node)
371     fprintf (stderr, "  ++ using candidate (%s at %10p)\n",
372              tree_code_name[TREE_CODE (node)], (void *) node);
373   node = c;
374
375 #if ENABLE_CHECKING
376   /* Make sure NODE isn't already a candidate.  */
377   {
378     int i;
379     tree candidate;
380
381     for (i = 0; VEC_iterate (tree, G.substitutions, i, candidate); i++)
382       {
383         gcc_assert (!(DECL_P (node) && node == candidate));
384         gcc_assert (!(TYPE_P (node) && TYPE_P (candidate)
385                       && same_type_p (node, candidate)));
386       }
387   }
388 #endif /* ENABLE_CHECKING */
389
390   /* Put the decl onto the varray of substitution candidates.  */
391   VEC_safe_push (tree, gc, G.substitutions, node);
392
393   if (DEBUG_MANGLE)
394     dump_substitution_candidates ();
395 }
396
397 /* Helper function for find_substitution.  Returns nonzero if NODE,
398    which may be a decl or a CLASS_TYPE, is a template-id with template
399    name of substitution_index[INDEX] in the ::std namespace.  */
400
401 static inline int
402 is_std_substitution (const tree node,
403                      const substitution_identifier_index_t index)
404 {
405   tree type = NULL;
406   tree decl = NULL;
407
408   if (DECL_P (node))
409     {
410       type = TREE_TYPE (node);
411       decl = node;
412     }
413   else if (CLASS_TYPE_P (node))
414     {
415       type = node;
416       decl = TYPE_NAME (node);
417     }
418   else
419     /* These are not the droids you're looking for.  */
420     return 0;
421
422   return (DECL_NAMESPACE_STD_P (CP_DECL_CONTEXT (decl))
423           && TYPE_LANG_SPECIFIC (type)
424           && TYPE_TEMPLATE_INFO (type)
425           && (DECL_NAME (TYPE_TI_TEMPLATE (type))
426               == subst_identifiers[index]));
427 }
428
429 /* Helper function for find_substitution.  Returns nonzero if NODE,
430    which may be a decl or a CLASS_TYPE, is the template-id
431    ::std::identifier<char>, where identifier is
432    substitution_index[INDEX].  */
433
434 static inline int
435 is_std_substitution_char (const tree node,
436                           const substitution_identifier_index_t index)
437 {
438   tree args;
439   /* Check NODE's name is ::std::identifier.  */
440   if (!is_std_substitution (node, index))
441     return 0;
442   /* Figure out its template args.  */
443   if (DECL_P (node))
444     args = DECL_TI_ARGS (node);
445   else if (CLASS_TYPE_P (node))
446     args = CLASSTYPE_TI_ARGS (node);
447   else
448     /* Oops, not a template.  */
449     return 0;
450   /* NODE's template arg list should be <char>.  */
451   return
452     TREE_VEC_LENGTH (args) == 1
453     && TREE_VEC_ELT (args, 0) == char_type_node;
454 }
455
456 /* Check whether a substitution should be used to represent NODE in
457    the mangling.
458
459    First, check standard special-case substitutions.
460
461      <substitution> ::= St
462          # ::std
463
464                     ::= Sa
465          # ::std::allocator
466
467                     ::= Sb
468          # ::std::basic_string
469
470                     ::= Ss
471          # ::std::basic_string<char,
472                                ::std::char_traits<char>,
473                                ::std::allocator<char> >
474
475                     ::= Si
476          # ::std::basic_istream<char, ::std::char_traits<char> >
477
478                     ::= So
479          # ::std::basic_ostream<char, ::std::char_traits<char> >
480
481                     ::= Sd
482          # ::std::basic_iostream<char, ::std::char_traits<char> >
483
484    Then examine the stack of currently available substitution
485    candidates for entities appearing earlier in the same mangling
486
487    If a substitution is found, write its mangled representation and
488    return nonzero.  If none is found, just return zero.  */
489
490 static int
491 find_substitution (tree node)
492 {
493   int i;
494   const int size = VEC_length (tree, G.substitutions);
495   tree decl;
496   tree type;
497
498   if (DEBUG_MANGLE)
499     fprintf (stderr, "  ++ find_substitution (%s at %p)\n",
500              tree_code_name[TREE_CODE (node)], (void *) node);
501
502   /* Obtain the canonicalized substitution representation for NODE.
503      This is what we'll compare against.  */
504   node = canonicalize_for_substitution (node);
505
506   /* Check for builtin substitutions.  */
507
508   decl = TYPE_P (node) ? TYPE_NAME (node) : node;
509   type = TYPE_P (node) ? node : TREE_TYPE (node);
510
511   /* Check for std::allocator.  */
512   if (decl
513       && is_std_substitution (decl, SUBID_ALLOCATOR)
514       && !CLASSTYPE_USE_TEMPLATE (TREE_TYPE (decl)))
515     {
516       write_string ("Sa");
517       return 1;
518     }
519
520   /* Check for std::basic_string.  */
521   if (decl && is_std_substitution (decl, SUBID_BASIC_STRING))
522     {
523       if (TYPE_P (node))
524         {
525           /* If this is a type (i.e. a fully-qualified template-id),
526              check for
527                  std::basic_string <char,
528                                     std::char_traits<char>,
529                                     std::allocator<char> > .  */
530           if (cp_type_quals (type) == TYPE_UNQUALIFIED
531               && CLASSTYPE_USE_TEMPLATE (type))
532             {
533               tree args = CLASSTYPE_TI_ARGS (type);
534               if (TREE_VEC_LENGTH (args) == 3
535                   && same_type_p (TREE_VEC_ELT (args, 0), char_type_node)
536                   && is_std_substitution_char (TREE_VEC_ELT (args, 1),
537                                                SUBID_CHAR_TRAITS)
538                   && is_std_substitution_char (TREE_VEC_ELT (args, 2),
539                                                SUBID_ALLOCATOR))
540                 {
541                   write_string ("Ss");
542                   return 1;
543                 }
544             }
545         }
546       else
547         /* Substitute for the template name only if this isn't a type.  */
548         {
549           write_string ("Sb");
550           return 1;
551         }
552     }
553
554   /* Check for basic_{i,o,io}stream.  */
555   if (TYPE_P (node)
556       && cp_type_quals (type) == TYPE_UNQUALIFIED
557       && CLASS_TYPE_P (type)
558       && CLASSTYPE_USE_TEMPLATE (type)
559       && CLASSTYPE_TEMPLATE_INFO (type) != NULL)
560     {
561       /* First, check for the template
562          args <char, std::char_traits<char> > .  */
563       tree args = CLASSTYPE_TI_ARGS (type);
564       if (TREE_VEC_LENGTH (args) == 2
565           && TYPE_P (TREE_VEC_ELT (args, 0))
566           && same_type_p (TREE_VEC_ELT (args, 0), char_type_node)
567           && is_std_substitution_char (TREE_VEC_ELT (args, 1),
568                                        SUBID_CHAR_TRAITS))
569         {
570           /* Got them.  Is this basic_istream?  */
571           if (is_std_substitution (decl, SUBID_BASIC_ISTREAM))
572             {
573               write_string ("Si");
574               return 1;
575             }
576           /* Or basic_ostream?  */
577           else if (is_std_substitution (decl, SUBID_BASIC_OSTREAM))
578             {
579               write_string ("So");
580               return 1;
581             }
582           /* Or basic_iostream?  */
583           else if (is_std_substitution (decl, SUBID_BASIC_IOSTREAM))
584             {
585               write_string ("Sd");
586               return 1;
587             }
588         }
589     }
590
591   /* Check for namespace std.  */
592   if (decl && DECL_NAMESPACE_STD_P (decl))
593     {
594       write_string ("St");
595       return 1;
596     }
597
598   /* Now check the list of available substitutions for this mangling
599      operation.  */
600   for (i = 0; i < size; ++i)
601     {
602       tree candidate = VEC_index (tree, G.substitutions, i);
603       /* NODE is a matched to a candidate if it's the same decl node or
604          if it's the same type.  */
605       if (decl == candidate
606           || (TYPE_P (candidate) && type && TYPE_P (type)
607               && same_type_p (type, candidate))
608           || NESTED_TEMPLATE_MATCH (node, candidate))
609         {
610           write_substitution (i);
611           return 1;
612         }
613     }
614
615   /* No substitution found.  */
616   return 0;
617 }
618
619
620 /* TOP_LEVEL is true, if this is being called at outermost level of
621   mangling. It should be false when mangling a decl appearing in an
622   expression within some other mangling.
623
624   <mangled-name>      ::= _Z <encoding>  */
625
626 static void
627 write_mangled_name (const tree decl, bool top_level)
628 {
629   MANGLE_TRACE_TREE ("mangled-name", decl);
630
631   if (/* The names of `extern "C"' functions are not mangled.  */
632       DECL_EXTERN_C_FUNCTION_P (decl)
633       /* But overloaded operator names *are* mangled.  */
634       && !DECL_OVERLOADED_OPERATOR_P (decl))
635     {
636     unmangled_name:;
637
638       if (top_level)
639         write_string (IDENTIFIER_POINTER (DECL_NAME (decl)));
640       else
641         {
642           /* The standard notes: "The <encoding> of an extern "C"
643              function is treated like global-scope data, i.e. as its
644              <source-name> without a type."  We cannot write
645              overloaded operators that way though, because it contains
646              characters invalid in assembler.  */
647           if (abi_version_at_least (2))
648             write_string ("_Z");
649           else
650             G.need_abi_warning = true;
651           write_source_name (DECL_NAME (decl));
652         }
653     }
654   else if (TREE_CODE (decl) == VAR_DECL
655            /* The names of non-static global variables aren't mangled.  */
656            && DECL_EXTERNAL_LINKAGE_P (decl)
657            && (CP_DECL_CONTEXT (decl) == global_namespace
658                /* And neither are `extern "C"' variables.  */
659                || DECL_EXTERN_C_P (decl)))
660     {
661       if (top_level || abi_version_at_least (2))
662         goto unmangled_name;
663       else
664         {
665           G.need_abi_warning = true;
666           goto mangled_name;
667         }
668     }
669   else
670     {
671     mangled_name:;
672       write_string ("_Z");
673       write_encoding (decl);
674       if (DECL_LANG_SPECIFIC (decl)
675           && (DECL_MAYBE_IN_CHARGE_DESTRUCTOR_P (decl)
676               || DECL_MAYBE_IN_CHARGE_CONSTRUCTOR_P (decl)))
677         /* We need a distinct mangled name for these entities, but
678            we should never actually output it.  So, we append some
679            characters the assembler won't like.  */
680         write_string (" *INTERNAL* ");
681     }
682 }
683
684 /*   <encoding>         ::= <function name> <bare-function-type>
685                         ::= <data name>  */
686
687 static void
688 write_encoding (const tree decl)
689 {
690   MANGLE_TRACE_TREE ("encoding", decl);
691
692   if (DECL_LANG_SPECIFIC (decl) && DECL_EXTERN_C_FUNCTION_P (decl))
693     {
694       /* For overloaded operators write just the mangled name
695          without arguments.  */
696       if (DECL_OVERLOADED_OPERATOR_P (decl))
697         write_name (decl, /*ignore_local_scope=*/0);
698       else
699         write_source_name (DECL_NAME (decl));
700       return;
701     }
702
703   write_name (decl, /*ignore_local_scope=*/0);
704   if (TREE_CODE (decl) == FUNCTION_DECL)
705     {
706       tree fn_type;
707       tree d;
708
709       if (decl_is_template_id (decl, NULL))
710         {
711           fn_type = get_mostly_instantiated_function_type (decl);
712           /* FN_TYPE will not have parameter types for in-charge or
713              VTT parameters.  Therefore, we pass NULL_TREE to
714              write_bare_function_type -- otherwise, it will get
715              confused about which artificial parameters to skip.  */
716           d = NULL_TREE;
717         }
718       else
719         {
720           fn_type = TREE_TYPE (decl);
721           d = decl;
722         }
723
724       write_bare_function_type (fn_type,
725                                 (!DECL_CONSTRUCTOR_P (decl)
726                                  && !DECL_DESTRUCTOR_P (decl)
727                                  && !DECL_CONV_FN_P (decl)
728                                  && decl_is_template_id (decl, NULL)),
729                                 d);
730     }
731 }
732
733 /* Lambdas can have a bit more context for mangling, specifically VAR_DECL
734    or PARM_DECL context, which doesn't belong in DECL_CONTEXT.  */
735
736 static tree
737 decl_mangling_context (tree decl)
738 {
739   if (TREE_CODE (decl) == TYPE_DECL
740       && LAMBDA_TYPE_P (TREE_TYPE (decl)))
741     {
742       tree extra = LAMBDA_TYPE_EXTRA_SCOPE (TREE_TYPE (decl));
743       if (extra)
744         return extra;
745     }
746     else if (TREE_CODE (decl) == TYPE_DECL
747              && TREE_CODE (TREE_TYPE (decl)) == TEMPLATE_TYPE_PARM)
748      /* template type parms have no mangling context.  */
749       return NULL_TREE;
750   return CP_DECL_CONTEXT (decl);
751 }
752
753 /* <name> ::= <unscoped-name>
754           ::= <unscoped-template-name> <template-args>
755           ::= <nested-name>
756           ::= <local-name>
757
758    If IGNORE_LOCAL_SCOPE is nonzero, this production of <name> is
759    called from <local-name>, which mangles the enclosing scope
760    elsewhere and then uses this function to mangle just the part
761    underneath the function scope.  So don't use the <local-name>
762    production, to avoid an infinite recursion.  */
763
764 static void
765 write_name (tree decl, const int ignore_local_scope)
766 {
767   tree context;
768
769   MANGLE_TRACE_TREE ("name", decl);
770
771   if (TREE_CODE (decl) == TYPE_DECL)
772     {
773       /* In case this is a typedef, fish out the corresponding
774          TYPE_DECL for the main variant.  */
775       decl = TYPE_NAME (TYPE_MAIN_VARIANT (TREE_TYPE (decl)));
776     }
777
778   context = decl_mangling_context (decl);
779
780   /* A decl in :: or ::std scope is treated specially.  The former is
781      mangled using <unscoped-name> or <unscoped-template-name>, the
782      latter with a special substitution.  Also, a name that is
783      directly in a local function scope is also mangled with
784      <unscoped-name> rather than a full <nested-name>.  */
785   if (context == NULL
786       || context == global_namespace
787       || DECL_NAMESPACE_STD_P (context)
788       || (ignore_local_scope && TREE_CODE (context) == FUNCTION_DECL))
789     {
790       tree template_info;
791       /* Is this a template instance?  */
792       if (decl_is_template_id (decl, &template_info))
793         {
794           /* Yes: use <unscoped-template-name>.  */
795           write_unscoped_template_name (TI_TEMPLATE (template_info));
796           write_template_args (TI_ARGS (template_info));
797         }
798       else
799         /* Everything else gets an <unqualified-name>.  */
800         write_unscoped_name (decl);
801     }
802   else
803     {
804       /* Handle local names, unless we asked not to (that is, invoked
805          under <local-name>, to handle only the part of the name under
806          the local scope).  */
807       if (!ignore_local_scope)
808         {
809           /* Scan up the list of scope context, looking for a
810              function.  If we find one, this entity is in local
811              function scope.  local_entity tracks context one scope
812              level down, so it will contain the element that's
813              directly in that function's scope, either decl or one of
814              its enclosing scopes.  */
815           tree local_entity = decl;
816           while (context != NULL && context != global_namespace)
817             {
818               /* Make sure we're always dealing with decls.  */
819               if (context != NULL && TYPE_P (context))
820                 context = TYPE_NAME (context);
821               /* Is this a function?  */
822               if (TREE_CODE (context) == FUNCTION_DECL
823                   || TREE_CODE (context) == PARM_DECL)
824                 {
825                   /* Yes, we have local scope.  Use the <local-name>
826                      production for the innermost function scope.  */
827                   write_local_name (context, local_entity, decl);
828                   return;
829                 }
830               /* Up one scope level.  */
831               local_entity = context;
832               context = decl_mangling_context (context);
833             }
834
835           /* No local scope found?  Fall through to <nested-name>.  */
836         }
837
838       /* Other decls get a <nested-name> to encode their scope.  */
839       write_nested_name (decl);
840     }
841 }
842
843 /* <unscoped-name> ::= <unqualified-name>
844                    ::= St <unqualified-name>   # ::std::  */
845
846 static void
847 write_unscoped_name (const tree decl)
848 {
849   tree context = CP_DECL_CONTEXT (decl);
850
851   MANGLE_TRACE_TREE ("unscoped-name", decl);
852
853   /* Is DECL in ::std?  */
854   if (DECL_NAMESPACE_STD_P (context))
855     {
856       write_string ("St");
857       write_unqualified_name (decl);
858     }
859   else
860     {
861       /* If not, it should be either in the global namespace, or directly
862          in a local function scope.  */
863       gcc_assert (context == global_namespace
864                   || context != NULL
865                   || TREE_CODE (context) == FUNCTION_DECL);
866
867       write_unqualified_name (decl);
868     }
869 }
870
871 /* <unscoped-template-name> ::= <unscoped-name>
872                             ::= <substitution>  */
873
874 static void
875 write_unscoped_template_name (const tree decl)
876 {
877   MANGLE_TRACE_TREE ("unscoped-template-name", decl);
878
879   if (find_substitution (decl))
880     return;
881   write_unscoped_name (decl);
882   add_substitution (decl);
883 }
884
885 /* Write the nested name, including CV-qualifiers, of DECL.
886
887    <nested-name> ::= N [<CV-qualifiers>] <prefix> <unqualified-name> E
888                  ::= N [<CV-qualifiers>] <template-prefix> <template-args> E
889
890    <CV-qualifiers> ::= [r] [V] [K]  */
891
892 static void
893 write_nested_name (const tree decl)
894 {
895   tree template_info;
896
897   MANGLE_TRACE_TREE ("nested-name", decl);
898
899   write_char ('N');
900
901   /* Write CV-qualifiers, if this is a member function.  */
902   if (TREE_CODE (decl) == FUNCTION_DECL
903       && DECL_NONSTATIC_MEMBER_FUNCTION_P (decl))
904     {
905       if (DECL_VOLATILE_MEMFUNC_P (decl))
906         write_char ('V');
907       if (DECL_CONST_MEMFUNC_P (decl))
908         write_char ('K');
909     }
910
911   /* Is this a template instance?  */
912   if (decl_is_template_id (decl, &template_info))
913     {
914       /* Yes, use <template-prefix>.  */
915       write_template_prefix (decl);
916       write_template_args (TI_ARGS (template_info));
917     }
918   else if (TREE_CODE (TREE_TYPE (decl)) == TYPENAME_TYPE)
919     {
920       tree name = TYPENAME_TYPE_FULLNAME (TREE_TYPE (decl));
921       if (TREE_CODE (name) == TEMPLATE_ID_EXPR)
922         {
923           write_template_prefix (decl);
924           write_template_args (TREE_OPERAND (name, 1));
925         }
926       else
927         {
928           write_prefix (CP_DECL_CONTEXT (decl));
929           write_unqualified_name (decl);
930         }
931     }
932   else
933     {
934       /* No, just use <prefix>  */
935       write_prefix (DECL_CONTEXT (decl));
936       write_unqualified_name (decl);
937     }
938   write_char ('E');
939 }
940
941 /* <prefix> ::= <prefix> <unqualified-name>
942             ::= <template-param>
943             ::= <template-prefix> <template-args>
944             ::= # empty
945             ::= <substitution>  */
946
947 static void
948 write_prefix (const tree node)
949 {
950   tree decl;
951   /* Non-NULL if NODE represents a template-id.  */
952   tree template_info = NULL;
953
954   if (node == NULL
955       || node == global_namespace)
956     return;
957
958   MANGLE_TRACE_TREE ("prefix", node);
959
960   if (find_substitution (node))
961     return;
962
963   if (DECL_P (node))
964     {
965       /* If this is a function or parm decl, that means we've hit function
966          scope, so this prefix must be for a local name.  In this
967          case, we're under the <local-name> production, which encodes
968          the enclosing function scope elsewhere.  So don't continue
969          here.  */
970       if (TREE_CODE (node) == FUNCTION_DECL
971           || TREE_CODE (node) == PARM_DECL)
972         return;
973
974       decl = node;
975       decl_is_template_id (decl, &template_info);
976     }
977   else
978     {
979       /* Node is a type.  */
980       decl = TYPE_NAME (node);
981       if (CLASSTYPE_TEMPLATE_ID_P (node))
982         template_info = TYPE_TEMPLATE_INFO (node);
983     }
984
985   /* In G++ 3.2, the name of the template parameter was used.  */
986   if (TREE_CODE (node) == TEMPLATE_TYPE_PARM
987       && !abi_version_at_least (2))
988     G.need_abi_warning = true;
989
990   if (TREE_CODE (node) == TEMPLATE_TYPE_PARM
991       && abi_version_at_least (2))
992     write_template_param (node);
993   else if (template_info != NULL)
994     /* Templated.  */
995     {
996       write_template_prefix (decl);
997       write_template_args (TI_ARGS (template_info));
998     }
999   else if (TREE_CODE (TREE_TYPE (decl)) == TYPENAME_TYPE)
1000     {
1001       tree name = TYPENAME_TYPE_FULLNAME (TREE_TYPE (decl));
1002       if (TREE_CODE (name) == TEMPLATE_ID_EXPR)
1003         {
1004           write_template_prefix (decl);
1005           write_template_args (TREE_OPERAND (name, 1));
1006         }
1007       else
1008         {
1009           write_prefix (CP_DECL_CONTEXT (decl));
1010           write_unqualified_name (decl);
1011         }
1012     }
1013   else
1014     /* Not templated.  */
1015     {
1016       write_prefix (decl_mangling_context (decl));
1017       write_unqualified_name (decl);
1018       if (TREE_CODE (decl) == VAR_DECL
1019           || TREE_CODE (decl) == FIELD_DECL)
1020         {
1021           /* <data-member-prefix> := <member source-name> M */
1022           write_char ('M');
1023           return;
1024         }
1025     }
1026
1027   add_substitution (node);
1028 }
1029
1030 /* <template-prefix> ::= <prefix> <template component>
1031                      ::= <template-param>
1032                      ::= <substitution>  */
1033
1034 static void
1035 write_template_prefix (const tree node)
1036 {
1037   tree decl = DECL_P (node) ? node : TYPE_NAME (node);
1038   tree type = DECL_P (node) ? TREE_TYPE (node) : node;
1039   tree context = CP_DECL_CONTEXT (decl);
1040   tree template_info;
1041   tree templ;
1042   tree substitution;
1043
1044   MANGLE_TRACE_TREE ("template-prefix", node);
1045
1046   /* Find the template decl.  */
1047   if (decl_is_template_id (decl, &template_info))
1048     templ = TI_TEMPLATE (template_info);
1049   else if (TREE_CODE (type) == TYPENAME_TYPE)
1050     /* For a typename type, all we have is the name.  */
1051     templ = DECL_NAME (decl);
1052   else
1053     {
1054       gcc_assert (CLASSTYPE_TEMPLATE_ID_P (type));
1055
1056       templ = TYPE_TI_TEMPLATE (type);
1057     }
1058
1059   /* For a member template, though, the template name for the
1060      innermost name must have all the outer template levels
1061      instantiated.  For instance, consider
1062
1063        template<typename T> struct Outer {
1064          template<typename U> struct Inner {};
1065        };
1066
1067      The template name for `Inner' in `Outer<int>::Inner<float>' is
1068      `Outer<int>::Inner<U>'.  In g++, we don't instantiate the template
1069      levels separately, so there's no TEMPLATE_DECL available for this
1070      (there's only `Outer<T>::Inner<U>').
1071
1072      In order to get the substitutions right, we create a special
1073      TREE_LIST to represent the substitution candidate for a nested
1074      template.  The TREE_PURPOSE is the template's context, fully
1075      instantiated, and the TREE_VALUE is the TEMPLATE_DECL for the inner
1076      template.
1077
1078      So, for the example above, `Outer<int>::Inner' is represented as a
1079      substitution candidate by a TREE_LIST whose purpose is `Outer<int>'
1080      and whose value is `Outer<T>::Inner<U>'.  */
1081   if (TYPE_P (context))
1082     substitution = build_tree_list (context, templ);
1083   else
1084     substitution = templ;
1085
1086   if (find_substitution (substitution))
1087     return;
1088
1089   /* In G++ 3.2, the name of the template template parameter was used.  */
1090   if (TREE_TYPE (templ)
1091       && TREE_CODE (TREE_TYPE (templ)) == TEMPLATE_TEMPLATE_PARM
1092       && !abi_version_at_least (2))
1093     G.need_abi_warning = true;
1094
1095   if (TREE_TYPE (templ)
1096       && TREE_CODE (TREE_TYPE (templ)) == TEMPLATE_TEMPLATE_PARM
1097       && abi_version_at_least (2))
1098     write_template_param (TREE_TYPE (templ));
1099   else
1100     {
1101       write_prefix (context);
1102       write_unqualified_name (decl);
1103     }
1104
1105   add_substitution (substitution);
1106 }
1107
1108 /* We don't need to handle thunks, vtables, or VTTs here.  Those are
1109    mangled through special entry points.
1110
1111     <unqualified-name>  ::= <operator-name>
1112                         ::= <special-name>
1113                         ::= <source-name>
1114                         ::= <unnamed-type-name>
1115                         ::= <local-source-name> 
1116
1117     <local-source-name> ::= L <source-name> <discriminator> */
1118
1119 static void
1120 write_unqualified_id (tree identifier)
1121 {
1122   if (IDENTIFIER_TYPENAME_P (identifier))
1123     write_conversion_operator_name (TREE_TYPE (identifier));
1124   else if (IDENTIFIER_OPNAME_P (identifier))
1125     {
1126       int i;
1127       const char *mangled_name = NULL;
1128
1129       /* Unfortunately, there is no easy way to go from the
1130          name of the operator back to the corresponding tree
1131          code.  */
1132       for (i = 0; i < MAX_TREE_CODES; ++i)
1133         if (operator_name_info[i].identifier == identifier)
1134           {
1135             /* The ABI says that we prefer binary operator
1136                names to unary operator names.  */
1137             if (operator_name_info[i].arity == 2)
1138               {
1139                 mangled_name = operator_name_info[i].mangled_name;
1140                 break;
1141               }
1142             else if (!mangled_name)
1143               mangled_name = operator_name_info[i].mangled_name;
1144           }
1145         else if (assignment_operator_name_info[i].identifier
1146                  == identifier)
1147           {
1148             mangled_name
1149               = assignment_operator_name_info[i].mangled_name;
1150             break;
1151           }
1152       write_string (mangled_name);
1153     }
1154   else
1155     write_source_name (identifier);
1156 }
1157
1158 static void
1159 write_unqualified_name (const tree decl)
1160 {
1161   MANGLE_TRACE_TREE ("unqualified-name", decl);
1162
1163   if (TREE_CODE (decl) == IDENTIFIER_NODE)
1164     {
1165       write_unqualified_id (decl);
1166       return;
1167     }
1168
1169   if (DECL_NAME (decl) == NULL_TREE)
1170     {
1171       gcc_assert (DECL_ASSEMBLER_NAME_SET_P (decl));
1172       write_source_name (DECL_ASSEMBLER_NAME (decl));
1173       return;
1174     }
1175   else if (DECL_DECLARES_FUNCTION_P (decl))
1176     {
1177       bool found = true;
1178       if (DECL_CONSTRUCTOR_P (decl))
1179         write_special_name_constructor (decl);
1180       else if (DECL_DESTRUCTOR_P (decl))
1181         write_special_name_destructor (decl);
1182       else if (DECL_CONV_FN_P (decl))
1183         {
1184           /* Conversion operator. Handle it right here.
1185              <operator> ::= cv <type>  */
1186           tree type;
1187           if (decl_is_template_id (decl, NULL))
1188             {
1189               tree fn_type;
1190               fn_type = get_mostly_instantiated_function_type (decl);
1191               type = TREE_TYPE (fn_type);
1192             }
1193           else
1194             type = DECL_CONV_FN_TYPE (decl);
1195           write_conversion_operator_name (type);
1196         }
1197       else if (DECL_OVERLOADED_OPERATOR_P (decl))
1198         {
1199           operator_name_info_t *oni;
1200           if (DECL_ASSIGNMENT_OPERATOR_P (decl))
1201             oni = assignment_operator_name_info;
1202           else
1203             oni = operator_name_info;
1204
1205           write_string (oni[DECL_OVERLOADED_OPERATOR_P (decl)].mangled_name);
1206         }
1207       else
1208         found = false;
1209
1210       if (found)
1211         return;
1212     }
1213
1214   if (VAR_OR_FUNCTION_DECL_P (decl) && ! TREE_PUBLIC (decl)
1215       && DECL_NAMESPACE_SCOPE_P (decl)
1216       && decl_linkage (decl) == lk_internal)
1217     {
1218       MANGLE_TRACE_TREE ("local-source-name", decl);
1219       write_char ('L');
1220       write_source_name (DECL_NAME (decl));
1221       /* The default discriminator is 1, and that's all we ever use,
1222          so there's no code to output one here.  */
1223     }
1224   else
1225     {
1226       tree type = TREE_TYPE (decl);
1227
1228       if (TREE_CODE (decl) == TYPE_DECL
1229           && TYPE_ANONYMOUS_P (type))
1230         write_unnamed_type_name (type);
1231       else if (TREE_CODE (decl) == TYPE_DECL
1232                && LAMBDA_TYPE_P (type))
1233         write_closure_type_name (type);
1234       else
1235         write_source_name (DECL_NAME (decl));
1236     }
1237 }
1238
1239 /* Write the unqualified-name for a conversion operator to TYPE.  */
1240
1241 static void
1242 write_conversion_operator_name (const tree type)
1243 {
1244   write_string ("cv");
1245   write_type (type);
1246 }
1247
1248 /* Non-terminal <source-name>.  IDENTIFIER is an IDENTIFIER_NODE.
1249
1250      <source-name> ::= </length/ number> <identifier>  */
1251
1252 static void
1253 write_source_name (tree identifier)
1254 {
1255   MANGLE_TRACE_TREE ("source-name", identifier);
1256
1257   /* Never write the whole template-id name including the template
1258      arguments; we only want the template name.  */
1259   if (IDENTIFIER_TEMPLATE (identifier))
1260     identifier = IDENTIFIER_TEMPLATE (identifier);
1261
1262   write_unsigned_number (IDENTIFIER_LENGTH (identifier));
1263   write_identifier (IDENTIFIER_POINTER (identifier));
1264 }
1265
1266 /* Encode 0 as _, and 1+ as n-1_.  */
1267
1268 static void
1269 write_compact_number (int num)
1270 {
1271   if (num > 0)
1272     write_unsigned_number (num - 1);
1273   write_char ('_');
1274 }
1275
1276 /* Return how many unnamed types precede TYPE in its enclosing class.  */
1277
1278 static int
1279 nested_anon_class_index (tree type)
1280 {
1281   int index = 0;
1282   tree member = TYPE_FIELDS (TYPE_CONTEXT (type));
1283   for (; member; member = TREE_CHAIN (member))
1284     if (DECL_IMPLICIT_TYPEDEF_P (member))
1285       {
1286         tree memtype = TREE_TYPE (member);
1287         if (memtype == type)
1288           return index;
1289         else if (TYPE_ANONYMOUS_P (memtype))
1290           ++index;
1291       }
1292
1293   gcc_unreachable ();
1294 }
1295
1296 /* <unnamed-type-name> ::= Ut [ <nonnegative number> ] _ */
1297
1298 static void
1299 write_unnamed_type_name (const tree type __attribute__ ((__unused__)))
1300 {
1301   int discriminator;
1302   MANGLE_TRACE_TREE ("unnamed-type-name", type);
1303
1304   if (TYPE_FUNCTION_SCOPE_P (type))
1305     discriminator = local_class_index (type);
1306   else if (TYPE_CLASS_SCOPE_P (type))
1307     discriminator = nested_anon_class_index (type);
1308   else
1309     {
1310       gcc_assert (no_linkage_check (type, /*relaxed_p=*/true));
1311       /* Just use the old mangling at namespace scope.  */
1312       write_source_name (TYPE_IDENTIFIER (type));
1313       return;
1314     }
1315
1316   write_string ("Ut");
1317   write_compact_number (discriminator);
1318 }
1319
1320 /* <closure-type-name> ::= Ul <lambda-sig> E [ <nonnegative number> ] _
1321    <lambda-sig> ::= <parameter type>+  # Parameter types or "v" if the lambda has no parameters */
1322
1323 static void
1324 write_closure_type_name (const tree type)
1325 {
1326   tree fn = lambda_function (type);
1327   tree lambda = CLASSTYPE_LAMBDA_EXPR (type);
1328   tree parms = TYPE_ARG_TYPES (TREE_TYPE (fn));
1329
1330   MANGLE_TRACE_TREE ("closure-type-name", type);
1331
1332   write_string ("Ul");
1333   write_method_parms (parms, /*method_p=*/1, fn);
1334   write_char ('E');
1335   write_compact_number (LAMBDA_EXPR_DISCRIMINATOR (lambda));
1336 }
1337
1338 /* Convert NUMBER to ascii using base BASE and generating at least
1339    MIN_DIGITS characters. BUFFER points to the _end_ of the buffer
1340    into which to store the characters. Returns the number of
1341    characters generated (these will be layed out in advance of where
1342    BUFFER points).  */
1343
1344 static int
1345 hwint_to_ascii (unsigned HOST_WIDE_INT number, const unsigned int base,
1346                 char *buffer, const unsigned int min_digits)
1347 {
1348   static const char base_digits[] = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ";
1349   unsigned digits = 0;
1350
1351   while (number)
1352     {
1353       unsigned HOST_WIDE_INT d = number / base;
1354
1355       *--buffer = base_digits[number - d * base];
1356       digits++;
1357       number = d;
1358     }
1359   while (digits < min_digits)
1360     {
1361       *--buffer = base_digits[0];
1362       digits++;
1363     }
1364   return digits;
1365 }
1366
1367 /* Non-terminal <number>.
1368
1369      <number> ::= [n] </decimal integer/>  */
1370
1371 static void
1372 write_number (unsigned HOST_WIDE_INT number, const int unsigned_p,
1373               const unsigned int base)
1374 {
1375   char buffer[sizeof (HOST_WIDE_INT) * 8];
1376   unsigned count = 0;
1377
1378   if (!unsigned_p && (HOST_WIDE_INT) number < 0)
1379     {
1380       write_char ('n');
1381       number = -((HOST_WIDE_INT) number);
1382     }
1383   count = hwint_to_ascii (number, base, buffer + sizeof (buffer), 1);
1384   write_chars (buffer + sizeof (buffer) - count, count);
1385 }
1386
1387 /* Write out an integral CST in decimal. Most numbers are small, and
1388    representable in a HOST_WIDE_INT. Occasionally we'll have numbers
1389    bigger than that, which we must deal with.  */
1390
1391 static inline void
1392 write_integer_cst (const tree cst)
1393 {
1394   int sign = tree_int_cst_sgn (cst);
1395
1396   if (TREE_INT_CST_HIGH (cst) + (sign < 0))
1397     {
1398       /* A bignum. We do this in chunks, each of which fits in a
1399          HOST_WIDE_INT.  */
1400       char buffer[sizeof (HOST_WIDE_INT) * 8 * 2];
1401       unsigned HOST_WIDE_INT chunk;
1402       unsigned chunk_digits;
1403       char *ptr = buffer + sizeof (buffer);
1404       unsigned count = 0;
1405       tree n, base, type;
1406       int done;
1407
1408       /* HOST_WIDE_INT must be at least 32 bits, so 10^9 is
1409          representable.  */
1410       chunk = 1000000000;
1411       chunk_digits = 9;
1412
1413       if (sizeof (HOST_WIDE_INT) >= 8)
1414         {
1415           /* It is at least 64 bits, so 10^18 is representable.  */
1416           chunk_digits = 18;
1417           chunk *= chunk;
1418         }
1419
1420       type = c_common_signed_or_unsigned_type (1, TREE_TYPE (cst));
1421       base = build_int_cstu (type, chunk);
1422       n = build_int_cst_wide (type,
1423                               TREE_INT_CST_LOW (cst), TREE_INT_CST_HIGH (cst));
1424
1425       if (sign < 0)
1426         {
1427           write_char ('n');
1428           n = fold_build1_loc (input_location, NEGATE_EXPR, type, n);
1429         }
1430       do
1431         {
1432           tree d = fold_build2_loc (input_location, FLOOR_DIV_EXPR, type, n, base);
1433           tree tmp = fold_build2_loc (input_location, MULT_EXPR, type, d, base);
1434           unsigned c;
1435
1436           done = integer_zerop (d);
1437           tmp = fold_build2_loc (input_location, MINUS_EXPR, type, n, tmp);
1438           c = hwint_to_ascii (TREE_INT_CST_LOW (tmp), 10, ptr,
1439                               done ? 1 : chunk_digits);
1440           ptr -= c;
1441           count += c;
1442           n = d;
1443         }
1444       while (!done);
1445       write_chars (ptr, count);
1446     }
1447   else
1448     {
1449       /* A small num.  */
1450       unsigned HOST_WIDE_INT low = TREE_INT_CST_LOW (cst);
1451
1452       if (sign < 0)
1453         {
1454           write_char ('n');
1455           low = -low;
1456         }
1457       write_unsigned_number (low);
1458     }
1459 }
1460
1461 /* Write out a floating-point literal.
1462
1463     "Floating-point literals are encoded using the bit pattern of the
1464     target processor's internal representation of that number, as a
1465     fixed-length lowercase hexadecimal string, high-order bytes first
1466     (even if the target processor would store low-order bytes first).
1467     The "n" prefix is not used for floating-point literals; the sign
1468     bit is encoded with the rest of the number.
1469
1470     Here are some examples, assuming the IEEE standard representation
1471     for floating point numbers.  (Spaces are for readability, not
1472     part of the encoding.)
1473
1474         1.0f                    Lf 3f80 0000 E
1475        -1.0f                    Lf bf80 0000 E
1476         1.17549435e-38f         Lf 0080 0000 E
1477         1.40129846e-45f         Lf 0000 0001 E
1478         0.0f                    Lf 0000 0000 E"
1479
1480    Caller is responsible for the Lx and the E.  */
1481 static void
1482 write_real_cst (const tree value)
1483 {
1484   if (abi_version_at_least (2))
1485     {
1486       long target_real[4];  /* largest supported float */
1487       char buffer[9];       /* eight hex digits in a 32-bit number */
1488       int i, limit, dir;
1489
1490       tree type = TREE_TYPE (value);
1491       int words = GET_MODE_BITSIZE (TYPE_MODE (type)) / 32;
1492
1493       real_to_target (target_real, &TREE_REAL_CST (value),
1494                       TYPE_MODE (type));
1495
1496       /* The value in target_real is in the target word order,
1497          so we must write it out backward if that happens to be
1498          little-endian.  write_number cannot be used, it will
1499          produce uppercase.  */
1500       if (FLOAT_WORDS_BIG_ENDIAN)
1501         i = 0, limit = words, dir = 1;
1502       else
1503         i = words - 1, limit = -1, dir = -1;
1504
1505       for (; i != limit; i += dir)
1506         {
1507           sprintf (buffer, "%08lx", (unsigned long) target_real[i]);
1508           write_chars (buffer, 8);
1509         }
1510     }
1511   else
1512     {
1513       /* In G++ 3.3 and before the REAL_VALUE_TYPE was written out
1514          literally.  Note that compatibility with 3.2 is impossible,
1515          because the old floating-point emulator used a different
1516          format for REAL_VALUE_TYPE.  */
1517       size_t i;
1518       for (i = 0; i < sizeof (TREE_REAL_CST (value)); ++i)
1519         write_number (((unsigned char *) &TREE_REAL_CST (value))[i],
1520                       /*unsigned_p*/ 1,
1521                       /*base*/ 16);
1522       G.need_abi_warning = 1;
1523     }
1524 }
1525
1526 /* Non-terminal <identifier>.
1527
1528      <identifier> ::= </unqualified source code identifier>  */
1529
1530 static void
1531 write_identifier (const char *identifier)
1532 {
1533   MANGLE_TRACE ("identifier", identifier);
1534   write_string (identifier);
1535 }
1536
1537 /* Handle constructor productions of non-terminal <special-name>.
1538    CTOR is a constructor FUNCTION_DECL.
1539
1540      <special-name> ::= C1   # complete object constructor
1541                     ::= C2   # base object constructor
1542                     ::= C3   # complete object allocating constructor
1543
1544    Currently, allocating constructors are never used.
1545
1546    We also need to provide mangled names for the maybe-in-charge
1547    constructor, so we treat it here too.  mangle_decl_string will
1548    append *INTERNAL* to that, to make sure we never emit it.  */
1549
1550 static void
1551 write_special_name_constructor (const tree ctor)
1552 {
1553   if (DECL_BASE_CONSTRUCTOR_P (ctor))
1554     write_string ("C2");
1555   else
1556     {
1557       gcc_assert (DECL_COMPLETE_CONSTRUCTOR_P (ctor)
1558                   /* Even though we don't ever emit a definition of
1559                      the old-style destructor, we still have to
1560                      consider entities (like static variables) nested
1561                      inside it.  */
1562                   || DECL_MAYBE_IN_CHARGE_CONSTRUCTOR_P (ctor));
1563       write_string ("C1");
1564     }
1565 }
1566
1567 /* Handle destructor productions of non-terminal <special-name>.
1568    DTOR is a destructor FUNCTION_DECL.
1569
1570      <special-name> ::= D0 # deleting (in-charge) destructor
1571                     ::= D1 # complete object (in-charge) destructor
1572                     ::= D2 # base object (not-in-charge) destructor
1573
1574    We also need to provide mangled names for the maybe-incharge
1575    destructor, so we treat it here too.  mangle_decl_string will
1576    append *INTERNAL* to that, to make sure we never emit it.  */
1577
1578 static void
1579 write_special_name_destructor (const tree dtor)
1580 {
1581   if (DECL_DELETING_DESTRUCTOR_P (dtor))
1582     write_string ("D0");
1583   else if (DECL_BASE_DESTRUCTOR_P (dtor))
1584     write_string ("D2");
1585   else
1586     {
1587       gcc_assert (DECL_COMPLETE_DESTRUCTOR_P (dtor)
1588                   /* Even though we don't ever emit a definition of
1589                      the old-style destructor, we still have to
1590                      consider entities (like static variables) nested
1591                      inside it.  */
1592                   || DECL_MAYBE_IN_CHARGE_DESTRUCTOR_P (dtor));
1593       write_string ("D1");
1594     }
1595 }
1596
1597 /* Scan the vector of local classes and return how many others with the
1598    same name (or same no name) and context precede ENTITY.  */
1599
1600 static int
1601 local_class_index (tree entity)
1602 {
1603   int ix, discriminator = 0;
1604   tree name = (TYPE_ANONYMOUS_P (entity) ? NULL_TREE
1605                : TYPE_IDENTIFIER (entity));
1606   tree ctx = TYPE_CONTEXT (entity);
1607   for (ix = 0; ; ix++)
1608     {
1609       tree type = VEC_index (tree, local_classes, ix);
1610       if (type == entity)
1611         return discriminator;
1612       if (TYPE_CONTEXT (type) == ctx
1613           && (name ? TYPE_IDENTIFIER (type) == name
1614               : TYPE_ANONYMOUS_P (type)))
1615         ++discriminator;
1616     }
1617   gcc_unreachable ();
1618 }
1619
1620 /* Return the discriminator for ENTITY appearing inside
1621    FUNCTION.  The discriminator is the lexical ordinal of VAR among
1622    entities with the same name in the same FUNCTION.  */
1623
1624 static int
1625 discriminator_for_local_entity (tree entity)
1626 {
1627   if (DECL_DISCRIMINATOR_P (entity))
1628     {
1629       if (DECL_DISCRIMINATOR_SET_P (entity))
1630         return DECL_DISCRIMINATOR (entity);
1631       else
1632         /* The first entity with a particular name doesn't get
1633            DECL_DISCRIMINATOR set up.  */
1634         return 0;
1635     }
1636   else if (TREE_CODE (entity) == TYPE_DECL)
1637     {
1638       /* Scan the list of local classes.  */
1639       entity = TREE_TYPE (entity);
1640
1641       /* Lambdas and unnamed types have their own discriminators.  */
1642       if (LAMBDA_TYPE_P (entity) || TYPE_ANONYMOUS_P (entity))
1643         return 0;
1644
1645       return local_class_index (entity);
1646     }
1647   else
1648     gcc_unreachable ();
1649 }
1650
1651 /* Return the discriminator for STRING, a string literal used inside
1652    FUNCTION.  The discriminator is the lexical ordinal of STRING among
1653    string literals used in FUNCTION.  */
1654
1655 static int
1656 discriminator_for_string_literal (tree function ATTRIBUTE_UNUSED,
1657                                   tree string ATTRIBUTE_UNUSED)
1658 {
1659   /* For now, we don't discriminate amongst string literals.  */
1660   return 0;
1661 }
1662
1663 /*   <discriminator> := _ <number>
1664
1665    The discriminator is used only for the second and later occurrences
1666    of the same name within a single function. In this case <number> is
1667    n - 2, if this is the nth occurrence, in lexical order.  */
1668
1669 static void
1670 write_discriminator (const int discriminator)
1671 {
1672   /* If discriminator is zero, don't write anything.  Otherwise...  */
1673   if (discriminator > 0)
1674     {
1675       write_char ('_');
1676       write_unsigned_number (discriminator - 1);
1677     }
1678 }
1679
1680 /* Mangle the name of a function-scope entity.  FUNCTION is the
1681    FUNCTION_DECL for the enclosing function, or a PARM_DECL for lambdas in
1682    default argument scope.  ENTITY is the decl for the entity itself.
1683    LOCAL_ENTITY is the entity that's directly scoped in FUNCTION_DECL,
1684    either ENTITY itself or an enclosing scope of ENTITY.
1685
1686      <local-name> := Z <function encoding> E <entity name> [<discriminator>]
1687                   := Z <function encoding> E s [<discriminator>]
1688                   := Z <function encoding> Ed [ <parameter number> ] _ <entity name> */
1689
1690 static void
1691 write_local_name (tree function, const tree local_entity,
1692                   const tree entity)
1693 {
1694   tree parm = NULL_TREE;
1695
1696   MANGLE_TRACE_TREE ("local-name", entity);
1697
1698   if (TREE_CODE (function) == PARM_DECL)
1699     {
1700       parm = function;
1701       function = DECL_CONTEXT (parm);
1702     }
1703
1704   write_char ('Z');
1705   write_encoding (function);
1706   write_char ('E');
1707
1708   /* For this purpose, parameters are numbered from right-to-left.  */
1709   if (parm)
1710     {
1711       tree t;
1712       int i = 0;
1713       for (t = DECL_ARGUMENTS (function); t; t = TREE_CHAIN (t))
1714         {
1715           if (t == parm)
1716             i = 1;
1717           else if (i)
1718             ++i;
1719         }
1720       write_char ('d');
1721       write_compact_number (i - 1);
1722     }
1723
1724   if (TREE_CODE (entity) == STRING_CST)
1725     {
1726       write_char ('s');
1727       write_discriminator (discriminator_for_string_literal (function,
1728                                                              entity));
1729     }
1730   else
1731     {
1732       /* Now the <entity name>.  Let write_name know its being called
1733          from <local-name>, so it doesn't try to process the enclosing
1734          function scope again.  */
1735       write_name (entity, /*ignore_local_scope=*/1);
1736       write_discriminator (discriminator_for_local_entity (local_entity));
1737     }
1738 }
1739
1740 /* Non-terminals <type> and <CV-qualifier>.
1741
1742      <type> ::= <builtin-type>
1743             ::= <function-type>
1744             ::= <class-enum-type>
1745             ::= <array-type>
1746             ::= <pointer-to-member-type>
1747             ::= <template-param>
1748             ::= <substitution>
1749             ::= <CV-qualifier>
1750             ::= P <type>    # pointer-to
1751             ::= R <type>    # reference-to
1752             ::= C <type>    # complex pair (C 2000)
1753             ::= G <type>    # imaginary (C 2000)     [not supported]
1754             ::= U <source-name> <type>   # vendor extended type qualifier
1755
1756    C++0x extensions
1757
1758      <type> ::= RR <type>   # rvalue reference-to
1759      <type> ::= Dt <expression> # decltype of an id-expression or 
1760                                 # class member access
1761      <type> ::= DT <expression> # decltype of an expression
1762      <type> ::= Dn              # decltype of nullptr
1763
1764    TYPE is a type node.  */
1765
1766 static void
1767 write_type (tree type)
1768 {
1769   /* This gets set to nonzero if TYPE turns out to be a (possibly
1770      CV-qualified) builtin type.  */
1771   int is_builtin_type = 0;
1772
1773   MANGLE_TRACE_TREE ("type", type);
1774
1775   if (type == error_mark_node)
1776     return;
1777
1778   if (find_substitution (type))
1779     return;
1780
1781   /* According to the C++ ABI, some library classes are passed the
1782      same as the scalar type of their single member and use the same
1783      mangling.  */
1784   if (TREE_CODE (type) == RECORD_TYPE && TYPE_TRANSPARENT_AGGR (type))
1785     type = TREE_TYPE (first_field (type));
1786
1787   if (write_CV_qualifiers_for_type (type) > 0)
1788     /* If TYPE was CV-qualified, we just wrote the qualifiers; now
1789        mangle the unqualified type.  The recursive call is needed here
1790        since both the qualified and unqualified types are substitution
1791        candidates.  */
1792     write_type (TYPE_MAIN_VARIANT (type));
1793   else if (TREE_CODE (type) == ARRAY_TYPE)
1794     /* It is important not to use the TYPE_MAIN_VARIANT of TYPE here
1795        so that the cv-qualification of the element type is available
1796        in write_array_type.  */
1797     write_array_type (type);
1798   else
1799     {
1800       tree type_orig = type;
1801
1802       /* See through any typedefs.  */
1803       type = TYPE_MAIN_VARIANT (type);
1804
1805       if (TYPE_PTRMEM_P (type))
1806         write_pointer_to_member_type (type);
1807       else
1808         {
1809           /* Handle any target-specific fundamental types.  */
1810           const char *target_mangling
1811             = targetm.mangle_type (type_orig);
1812
1813           if (target_mangling)
1814             {
1815               write_string (target_mangling);
1816               /* Add substitutions for types other than fundamental
1817                  types.  */
1818               if (TREE_CODE (type) != VOID_TYPE
1819                   && TREE_CODE (type) != INTEGER_TYPE
1820                   && TREE_CODE (type) != REAL_TYPE
1821                   && TREE_CODE (type) != BOOLEAN_TYPE)
1822                 add_substitution (type);
1823               return;
1824             }
1825
1826           switch (TREE_CODE (type))
1827             {
1828             case VOID_TYPE:
1829             case BOOLEAN_TYPE:
1830             case INTEGER_TYPE:  /* Includes wchar_t.  */
1831             case REAL_TYPE:
1832             case FIXED_POINT_TYPE:
1833               {
1834                 /* If this is a typedef, TYPE may not be one of
1835                    the standard builtin type nodes, but an alias of one.  Use
1836                    TYPE_MAIN_VARIANT to get to the underlying builtin type.  */
1837                 write_builtin_type (TYPE_MAIN_VARIANT (type));
1838                 ++is_builtin_type;
1839               }
1840               break;
1841
1842             case COMPLEX_TYPE:
1843               write_char ('C');
1844               write_type (TREE_TYPE (type));
1845               break;
1846
1847             case FUNCTION_TYPE:
1848             case METHOD_TYPE:
1849               write_function_type (type);
1850               break;
1851
1852             case UNION_TYPE:
1853             case RECORD_TYPE:
1854             case ENUMERAL_TYPE:
1855               /* A pointer-to-member function is represented as a special
1856                  RECORD_TYPE, so check for this first.  */
1857               if (TYPE_PTRMEMFUNC_P (type))
1858                 write_pointer_to_member_type (type);
1859               else
1860                 write_class_enum_type (type);
1861               break;
1862
1863             case TYPENAME_TYPE:
1864             case UNBOUND_CLASS_TEMPLATE:
1865               /* We handle TYPENAME_TYPEs and UNBOUND_CLASS_TEMPLATEs like
1866                  ordinary nested names.  */
1867               write_nested_name (TYPE_STUB_DECL (type));
1868               break;
1869
1870             case POINTER_TYPE:
1871               write_char ('P');
1872               write_type (TREE_TYPE (type));
1873               break;
1874
1875             case REFERENCE_TYPE:
1876               if (TYPE_REF_IS_RVALUE (type))
1877                 write_char('O');
1878               else
1879                 write_char ('R');
1880               write_type (TREE_TYPE (type));
1881               break;
1882
1883             case TEMPLATE_TYPE_PARM:
1884             case TEMPLATE_PARM_INDEX:
1885               write_template_param (type);
1886               break;
1887
1888             case TEMPLATE_TEMPLATE_PARM:
1889               write_template_template_param (type);
1890               break;
1891
1892             case BOUND_TEMPLATE_TEMPLATE_PARM:
1893               write_template_template_param (type);
1894               write_template_args
1895                 (TI_ARGS (TEMPLATE_TEMPLATE_PARM_TEMPLATE_INFO (type)));
1896               break;
1897
1898             case VECTOR_TYPE:
1899               if (abi_version_at_least (4))
1900                 {
1901                   write_string ("Dv");
1902                   /* Non-constant vector size would be encoded with
1903                      _ expression, but we don't support that yet.  */
1904                   write_unsigned_number (TYPE_VECTOR_SUBPARTS (type));
1905                   write_char ('_');
1906                 }
1907               else
1908                 {
1909                   G.need_abi_warning = 1;
1910                   write_string ("U8__vector");
1911                 }
1912               write_type (TREE_TYPE (type));
1913               break;
1914
1915             case TYPE_PACK_EXPANSION:
1916               write_string ("Dp");
1917               write_type (PACK_EXPANSION_PATTERN (type));
1918               break;
1919
1920             case DECLTYPE_TYPE:
1921               /* These shouldn't make it into mangling.  */
1922               gcc_assert (!DECLTYPE_FOR_LAMBDA_CAPTURE (type)
1923                           && !DECLTYPE_FOR_LAMBDA_RETURN (type));
1924
1925               write_char ('D');
1926               if (DECLTYPE_TYPE_ID_EXPR_OR_MEMBER_ACCESS_P (type))
1927                 write_char ('t');
1928               else
1929                 write_char ('T');
1930               ++cp_unevaluated_operand;
1931               write_expression (DECLTYPE_TYPE_EXPR (type));
1932               --cp_unevaluated_operand;
1933               write_char ('E');
1934               break;
1935
1936             case NULLPTR_TYPE:
1937               write_string ("Dn");
1938               break;
1939
1940             case TYPEOF_TYPE:
1941               sorry ("mangling typeof, use decltype instead");
1942               break;
1943
1944             default:
1945               gcc_unreachable ();
1946             }
1947         }
1948     }
1949
1950   /* Types other than builtin types are substitution candidates.  */
1951   if (!is_builtin_type)
1952     add_substitution (type);
1953 }
1954
1955 /* Non-terminal <CV-qualifiers> for type nodes.  Returns the number of
1956    CV-qualifiers written for TYPE.
1957
1958      <CV-qualifiers> ::= [r] [V] [K]  */
1959
1960 static int
1961 write_CV_qualifiers_for_type (const tree type)
1962 {
1963   int num_qualifiers = 0;
1964
1965   /* The order is specified by:
1966
1967        "In cases where multiple order-insensitive qualifiers are
1968        present, they should be ordered 'K' (closest to the base type),
1969        'V', 'r', and 'U' (farthest from the base type) ..."
1970
1971      Note that we do not use cp_type_quals below; given "const
1972      int[3]", the "const" is emitted with the "int", not with the
1973      array.  */
1974
1975   if (TYPE_QUALS (type) & TYPE_QUAL_RESTRICT)
1976     {
1977       write_char ('r');
1978       ++num_qualifiers;
1979     }
1980   if (TYPE_QUALS (type) & TYPE_QUAL_VOLATILE)
1981     {
1982       write_char ('V');
1983       ++num_qualifiers;
1984     }
1985   if (TYPE_QUALS (type) & TYPE_QUAL_CONST)
1986     {
1987       write_char ('K');
1988       ++num_qualifiers;
1989     }
1990
1991   return num_qualifiers;
1992 }
1993
1994 /* Non-terminal <builtin-type>.
1995
1996      <builtin-type> ::= v   # void
1997                     ::= b   # bool
1998                     ::= w   # wchar_t
1999                     ::= c   # char
2000                     ::= a   # signed char
2001                     ::= h   # unsigned char
2002                     ::= s   # short
2003                     ::= t   # unsigned short
2004                     ::= i   # int
2005                     ::= j   # unsigned int
2006                     ::= l   # long
2007                     ::= m   # unsigned long
2008                     ::= x   # long long, __int64
2009                     ::= y   # unsigned long long, __int64
2010                     ::= n   # __int128
2011                     ::= o   # unsigned __int128
2012                     ::= f   # float
2013                     ::= d   # double
2014                     ::= e   # long double, __float80
2015                     ::= g   # __float128          [not supported]
2016                     ::= u <source-name>  # vendor extended type */
2017
2018 static void
2019 write_builtin_type (tree type)
2020 {
2021   if (TYPE_CANONICAL (type))
2022     type = TYPE_CANONICAL (type);
2023
2024   switch (TREE_CODE (type))
2025     {
2026     case VOID_TYPE:
2027       write_char ('v');
2028       break;
2029
2030     case BOOLEAN_TYPE:
2031       write_char ('b');
2032       break;
2033
2034     case INTEGER_TYPE:
2035       /* TYPE may still be wchar_t, char16_t, or char32_t, since that
2036          isn't in integer_type_nodes.  */
2037       if (type == wchar_type_node)
2038         write_char ('w');
2039       else if (type == char16_type_node)
2040         write_string ("Ds");
2041       else if (type == char32_type_node)
2042         write_string ("Di");
2043       else if (TYPE_FOR_JAVA (type))
2044         write_java_integer_type_codes (type);
2045       else
2046         {
2047           size_t itk;
2048           /* Assume TYPE is one of the shared integer type nodes.  Find
2049              it in the array of these nodes.  */
2050         iagain:
2051           for (itk = 0; itk < itk_none; ++itk)
2052             if (type == integer_types[itk])
2053               {
2054                 /* Print the corresponding single-letter code.  */
2055                 write_char (integer_type_codes[itk]);
2056                 break;
2057               }
2058
2059           if (itk == itk_none)
2060             {
2061               tree t = c_common_type_for_mode (TYPE_MODE (type),
2062                                                TYPE_UNSIGNED (type));
2063               if (type != t)
2064                 {
2065                   type = t;
2066                   goto iagain;
2067                 }
2068
2069               if (TYPE_PRECISION (type) == 128)
2070                 write_char (TYPE_UNSIGNED (type) ? 'o' : 'n');
2071               else
2072                 {
2073                   /* Allow for cases where TYPE is not one of the shared
2074                      integer type nodes and write a "vendor extended builtin
2075                      type" with a name the form intN or uintN, respectively.
2076                      Situations like this can happen if you have an
2077                      __attribute__((__mode__(__SI__))) type and use exotic
2078                      switches like '-mint8' on AVR.  Of course, this is
2079                      undefined by the C++ ABI (and '-mint8' is not even
2080                      Standard C conforming), but when using such special
2081                      options you're pretty much in nowhere land anyway.  */
2082                   const char *prefix;
2083                   char prec[11];        /* up to ten digits for an unsigned */
2084
2085                   prefix = TYPE_UNSIGNED (type) ? "uint" : "int";
2086                   sprintf (prec, "%u", (unsigned) TYPE_PRECISION (type));
2087                   write_char ('u');     /* "vendor extended builtin type" */
2088                   write_unsigned_number (strlen (prefix) + strlen (prec));
2089                   write_string (prefix);
2090                   write_string (prec);
2091                 }
2092             }
2093         }
2094       break;
2095
2096     case REAL_TYPE:
2097       if (type == float_type_node
2098           || type == java_float_type_node)
2099         write_char ('f');
2100       else if (type == double_type_node
2101                || type == java_double_type_node)
2102         write_char ('d');
2103       else if (type == long_double_type_node)
2104         write_char ('e');
2105       else if (type == dfloat32_type_node)
2106         write_string ("Df");
2107       else if (type == dfloat64_type_node)
2108         write_string ("Dd");
2109       else if (type == dfloat128_type_node)
2110         write_string ("De");
2111       else
2112         gcc_unreachable ();
2113       break;
2114
2115     case FIXED_POINT_TYPE:
2116       write_string ("DF");
2117       if (GET_MODE_IBIT (TYPE_MODE (type)) > 0)
2118         write_unsigned_number (GET_MODE_IBIT (TYPE_MODE (type)));
2119       if (type == fract_type_node
2120           || type == sat_fract_type_node
2121           || type == accum_type_node
2122           || type == sat_accum_type_node)
2123         write_char ('i');
2124       else if (type == unsigned_fract_type_node
2125                || type == sat_unsigned_fract_type_node
2126                || type == unsigned_accum_type_node
2127                || type == sat_unsigned_accum_type_node)
2128         write_char ('j');
2129       else if (type == short_fract_type_node
2130                || type == sat_short_fract_type_node
2131                || type == short_accum_type_node
2132                || type == sat_short_accum_type_node)
2133         write_char ('s');
2134       else if (type == unsigned_short_fract_type_node
2135                || type == sat_unsigned_short_fract_type_node
2136                || type == unsigned_short_accum_type_node
2137                || type == sat_unsigned_short_accum_type_node)
2138         write_char ('t');
2139       else if (type == long_fract_type_node
2140                || type == sat_long_fract_type_node
2141                || type == long_accum_type_node
2142                || type == sat_long_accum_type_node)
2143         write_char ('l');
2144       else if (type == unsigned_long_fract_type_node
2145                || type == sat_unsigned_long_fract_type_node
2146                || type == unsigned_long_accum_type_node
2147                || type == sat_unsigned_long_accum_type_node)
2148         write_char ('m');
2149       else if (type == long_long_fract_type_node
2150                || type == sat_long_long_fract_type_node
2151                || type == long_long_accum_type_node
2152                || type == sat_long_long_accum_type_node)
2153         write_char ('x');
2154       else if (type == unsigned_long_long_fract_type_node
2155                || type == sat_unsigned_long_long_fract_type_node
2156                || type == unsigned_long_long_accum_type_node
2157                || type == sat_unsigned_long_long_accum_type_node)
2158         write_char ('y');
2159       else
2160         sorry ("mangling unknown fixed point type");
2161       write_unsigned_number (GET_MODE_FBIT (TYPE_MODE (type)));
2162       if (TYPE_SATURATING (type))
2163         write_char ('s');
2164       else
2165         write_char ('n');
2166       break;
2167
2168     default:
2169       gcc_unreachable ();
2170     }
2171 }
2172
2173 /* Non-terminal <function-type>.  NODE is a FUNCTION_TYPE or
2174    METHOD_TYPE.  The return type is mangled before the parameter
2175    types.
2176
2177      <function-type> ::= F [Y] <bare-function-type> E   */
2178
2179 static void
2180 write_function_type (const tree type)
2181 {
2182   MANGLE_TRACE_TREE ("function-type", type);
2183
2184   /* For a pointer to member function, the function type may have
2185      cv-qualifiers, indicating the quals for the artificial 'this'
2186      parameter.  */
2187   if (TREE_CODE (type) == METHOD_TYPE)
2188     {
2189       /* The first parameter must be a POINTER_TYPE pointing to the
2190          `this' parameter.  */
2191       tree this_type = TREE_TYPE (TREE_VALUE (TYPE_ARG_TYPES (type)));
2192       write_CV_qualifiers_for_type (this_type);
2193     }
2194
2195   write_char ('F');
2196   /* We don't track whether or not a type is `extern "C"'.  Note that
2197      you can have an `extern "C"' function that does not have
2198      `extern "C"' type, and vice versa:
2199
2200        extern "C" typedef void function_t();
2201        function_t f; // f has C++ linkage, but its type is
2202                      // `extern "C"'
2203
2204        typedef void function_t();
2205        extern "C" function_t f; // Vice versa.
2206
2207      See [dcl.link].  */
2208   write_bare_function_type (type, /*include_return_type_p=*/1,
2209                             /*decl=*/NULL);
2210   write_char ('E');
2211 }
2212
2213 /* Non-terminal <bare-function-type>.  TYPE is a FUNCTION_TYPE or
2214    METHOD_TYPE.  If INCLUDE_RETURN_TYPE is nonzero, the return value
2215    is mangled before the parameter types.  If non-NULL, DECL is
2216    FUNCTION_DECL for the function whose type is being emitted.
2217
2218    If DECL is a member of a Java type, then a literal 'J'
2219    is output and the return type is mangled as if INCLUDE_RETURN_TYPE
2220    were nonzero.
2221
2222      <bare-function-type> ::= [J]</signature/ type>+  */
2223
2224 static void
2225 write_bare_function_type (const tree type, const int include_return_type_p,
2226                           const tree decl)
2227 {
2228   int java_method_p;
2229
2230   MANGLE_TRACE_TREE ("bare-function-type", type);
2231
2232   /* Detect Java methods and emit special encoding.  */
2233   if (decl != NULL
2234       && DECL_FUNCTION_MEMBER_P (decl)
2235       && TYPE_FOR_JAVA (DECL_CONTEXT (decl))
2236       && !DECL_CONSTRUCTOR_P (decl)
2237       && !DECL_DESTRUCTOR_P (decl)
2238       && !DECL_CONV_FN_P (decl))
2239     {
2240       java_method_p = 1;
2241       write_char ('J');
2242     }
2243   else
2244     {
2245       java_method_p = 0;
2246     }
2247
2248   /* Mangle the return type, if requested.  */
2249   if (include_return_type_p || java_method_p)
2250     write_type (TREE_TYPE (type));
2251
2252   /* Now mangle the types of the arguments.  */
2253   write_method_parms (TYPE_ARG_TYPES (type),
2254                       TREE_CODE (type) == METHOD_TYPE,
2255                       decl);
2256 }
2257
2258 /* Write the mangled representation of a method parameter list of
2259    types given in PARM_TYPES.  If METHOD_P is nonzero, the function is
2260    considered a non-static method, and the this parameter is omitted.
2261    If non-NULL, DECL is the FUNCTION_DECL for the function whose
2262    parameters are being emitted.  */
2263
2264 static void
2265 write_method_parms (tree parm_types, const int method_p, const tree decl)
2266 {
2267   tree first_parm_type;
2268   tree parm_decl = decl ? DECL_ARGUMENTS (decl) : NULL_TREE;
2269
2270   /* Assume this parameter type list is variable-length.  If it ends
2271      with a void type, then it's not.  */
2272   int varargs_p = 1;
2273
2274   /* If this is a member function, skip the first arg, which is the
2275      this pointer.
2276        "Member functions do not encode the type of their implicit this
2277        parameter."
2278
2279      Similarly, there's no need to mangle artificial parameters, like
2280      the VTT parameters for constructors and destructors.  */
2281   if (method_p)
2282     {
2283       parm_types = TREE_CHAIN (parm_types);
2284       parm_decl = parm_decl ? TREE_CHAIN (parm_decl) : NULL_TREE;
2285
2286       while (parm_decl && DECL_ARTIFICIAL (parm_decl))
2287         {
2288           parm_types = TREE_CHAIN (parm_types);
2289           parm_decl = TREE_CHAIN (parm_decl);
2290         }
2291     }
2292
2293   for (first_parm_type = parm_types;
2294        parm_types;
2295        parm_types = TREE_CHAIN (parm_types))
2296     {
2297       tree parm = TREE_VALUE (parm_types);
2298       if (parm == void_type_node)
2299         {
2300           /* "Empty parameter lists, whether declared as () or
2301              conventionally as (void), are encoded with a void parameter
2302              (v)."  */
2303           if (parm_types == first_parm_type)
2304             write_type (parm);
2305           /* If the parm list is terminated with a void type, it's
2306              fixed-length.  */
2307           varargs_p = 0;
2308           /* A void type better be the last one.  */
2309           gcc_assert (TREE_CHAIN (parm_types) == NULL);
2310         }
2311       else
2312         write_type (parm);
2313     }
2314
2315   if (varargs_p)
2316     /* <builtin-type> ::= z  # ellipsis  */
2317     write_char ('z');
2318 }
2319
2320 /* <class-enum-type> ::= <name>  */
2321
2322 static void
2323 write_class_enum_type (const tree type)
2324 {
2325   write_name (TYPE_NAME (type), /*ignore_local_scope=*/0);
2326 }
2327
2328 /* Non-terminal <template-args>.  ARGS is a TREE_VEC of template
2329    arguments.
2330
2331      <template-args> ::= I <template-arg>* E  */
2332
2333 static void
2334 write_template_args (tree args)
2335 {
2336   int i;
2337   int length = 0;
2338
2339   MANGLE_TRACE_TREE ("template-args", args);
2340
2341   write_char ('I');
2342
2343   if (args)
2344     length = TREE_VEC_LENGTH (args);
2345
2346   if (args && TREE_CODE (TREE_VEC_ELT (args, 0)) == TREE_VEC)
2347     {
2348       /* We have nested template args.  We want the innermost template
2349          argument list.  */
2350       args = TREE_VEC_ELT (args, length - 1);
2351       length = TREE_VEC_LENGTH (args);
2352     }
2353   for (i = 0; i < length; ++i)
2354     write_template_arg (TREE_VEC_ELT (args, i));
2355
2356   write_char ('E');
2357 }
2358
2359 /* Write out the
2360    <unqualified-name>
2361    <unqualified-name> <template-args>
2362    part of SCOPE_REF or COMPONENT_REF mangling.  */
2363
2364 static void
2365 write_member_name (tree member)
2366 {
2367   if (TREE_CODE (member) == IDENTIFIER_NODE)
2368     write_unqualified_id (member);
2369   else if (DECL_P (member))
2370     write_unqualified_name (member);
2371   else if (TREE_CODE (member) == TEMPLATE_ID_EXPR)
2372     {
2373       tree name = TREE_OPERAND (member, 0);
2374       if (TREE_CODE (name) == OVERLOAD)
2375         name = OVL_FUNCTION (name);
2376       write_member_name (name);
2377       write_template_args (TREE_OPERAND (member, 1));
2378     }
2379   else
2380     write_expression (member);
2381 }
2382
2383 /* <expression> ::= <unary operator-name> <expression>
2384                 ::= <binary operator-name> <expression> <expression>
2385                 ::= <expr-primary>
2386
2387    <expr-primary> ::= <template-param>
2388                   ::= L <type> <value number> E         # literal
2389                   ::= L <mangled-name> E                # external name
2390                   ::= st <type>                         # sizeof
2391                   ::= sr <type> <unqualified-name>      # dependent name
2392                   ::= sr <type> <unqualified-name> <template-args> */
2393
2394 static void
2395 write_expression (tree expr)
2396 {
2397   enum tree_code code = TREE_CODE (expr);
2398
2399   /* Skip NOP_EXPRs.  They can occur when (say) a pointer argument
2400      is converted (via qualification conversions) to another
2401      type.  */
2402   while (TREE_CODE (expr) == NOP_EXPR
2403          || TREE_CODE (expr) == NON_LVALUE_EXPR)
2404     {
2405       expr = TREE_OPERAND (expr, 0);
2406       code = TREE_CODE (expr);
2407     }
2408
2409   if (code == BASELINK)
2410     {
2411       expr = BASELINK_FUNCTIONS (expr);
2412       code = TREE_CODE (expr);
2413     }
2414
2415   /* Handle pointers-to-members by making them look like expression
2416      nodes.  */
2417   if (code == PTRMEM_CST)
2418     {
2419       expr = build_nt (ADDR_EXPR,
2420                        build_qualified_name (/*type=*/NULL_TREE,
2421                                              PTRMEM_CST_CLASS (expr),
2422                                              PTRMEM_CST_MEMBER (expr),
2423                                              /*template_p=*/false));
2424       code = TREE_CODE (expr);
2425     }
2426
2427   /* Handle template parameters.  */
2428   if (code == TEMPLATE_TYPE_PARM
2429       || code == TEMPLATE_TEMPLATE_PARM
2430       || code == BOUND_TEMPLATE_TEMPLATE_PARM
2431       || code == TEMPLATE_PARM_INDEX)
2432     write_template_param (expr);
2433   /* Handle literals.  */
2434   else if (TREE_CODE_CLASS (code) == tcc_constant
2435            || (abi_version_at_least (2) && code == CONST_DECL))
2436     write_template_arg_literal (expr);
2437   else if (code == PARM_DECL)
2438     {
2439       /* A function parameter used in a late-specified return type.  */
2440       int index = DECL_PARM_INDEX (expr);
2441       gcc_assert (index >= 1);
2442       write_string ("fp");
2443       write_compact_number (index - 1);
2444     }
2445   else if (DECL_P (expr))
2446     {
2447       /* G++ 3.2 incorrectly mangled non-type template arguments of
2448          enumeration type using their names.  */
2449       if (code == CONST_DECL)
2450         G.need_abi_warning = 1;
2451       write_char ('L');
2452       write_mangled_name (expr, false);
2453       write_char ('E');
2454     }
2455   else if (TREE_CODE (expr) == SIZEOF_EXPR
2456            && TYPE_P (TREE_OPERAND (expr, 0)))
2457     {
2458       write_string ("st");
2459       write_type (TREE_OPERAND (expr, 0));
2460     }
2461   else if (TREE_CODE (expr) == ALIGNOF_EXPR
2462            && TYPE_P (TREE_OPERAND (expr, 0)))
2463     {
2464       write_string ("at");
2465       write_type (TREE_OPERAND (expr, 0));
2466     }
2467   else if (TREE_CODE (expr) == SCOPE_REF)
2468     {
2469       tree scope = TREE_OPERAND (expr, 0);
2470       tree member = TREE_OPERAND (expr, 1);
2471
2472       if (!abi_version_at_least (2))
2473         {
2474           write_string ("sr");
2475           write_type (scope);
2476           /* G++ 3.2 incorrectly put out both the "sr" code and
2477              the nested name of the qualified name.  */
2478           G.need_abi_warning = 1;
2479           write_encoding (member);
2480         }
2481
2482       /* If the MEMBER is a real declaration, then the qualifying
2483          scope was not dependent.  Ideally, we would not have a
2484          SCOPE_REF in those cases, but sometimes we do.  If the second
2485          argument is a DECL, then the name must not have been
2486          dependent.  */
2487       else if (DECL_P (member))
2488         write_expression (member);
2489       else
2490         {
2491           write_string ("sr");
2492           write_type (scope);
2493           write_member_name (member);
2494         }
2495     }
2496   else if (TREE_CODE (expr) == INDIRECT_REF
2497            && TREE_TYPE (TREE_OPERAND (expr, 0))
2498            && TREE_CODE (TREE_TYPE (TREE_OPERAND (expr, 0))) == REFERENCE_TYPE)
2499     {
2500       write_expression (TREE_OPERAND (expr, 0));
2501     }
2502   else if (TREE_CODE (expr) == IDENTIFIER_NODE)
2503     {
2504       /* An operator name appearing as a dependent name needs to be
2505          specially marked to disambiguate between a use of the operator
2506          name and a use of the operator in an expression.  */
2507       if (IDENTIFIER_OPNAME_P (expr))
2508         write_string ("on");
2509       write_unqualified_id (expr);
2510     }
2511   else if (TREE_CODE (expr) == TEMPLATE_ID_EXPR)
2512     {
2513       tree fn = TREE_OPERAND (expr, 0);
2514       if (is_overloaded_fn (fn))
2515         fn = DECL_NAME (get_first_fn (fn));
2516       if (IDENTIFIER_OPNAME_P (fn))
2517         write_string ("on");
2518       write_unqualified_id (fn);
2519       write_template_args (TREE_OPERAND (expr, 1));
2520     }
2521   else
2522     {
2523       int i, len;
2524       const char *name;
2525
2526       /* When we bind a variable or function to a non-type template
2527          argument with reference type, we create an ADDR_EXPR to show
2528          the fact that the entity's address has been taken.  But, we
2529          don't actually want to output a mangling code for the `&'.  */
2530       if (TREE_CODE (expr) == ADDR_EXPR
2531           && TREE_TYPE (expr)
2532           && TREE_CODE (TREE_TYPE (expr)) == REFERENCE_TYPE)
2533         {
2534           expr = TREE_OPERAND (expr, 0);
2535           if (DECL_P (expr))
2536             {
2537               write_expression (expr);
2538               return;
2539             }
2540
2541           code = TREE_CODE (expr);
2542         }
2543
2544       if (code == COMPONENT_REF)
2545         {
2546           tree ob = TREE_OPERAND (expr, 0);
2547
2548           if (TREE_CODE (ob) == ARROW_EXPR)
2549             {
2550               write_string (operator_name_info[(int)code].mangled_name);
2551               ob = TREE_OPERAND (ob, 0);
2552             }
2553           else
2554             write_string ("dt");
2555
2556           write_expression (ob);
2557           write_member_name (TREE_OPERAND (expr, 1));
2558           return;
2559         }
2560
2561       /* If it wasn't any of those, recursively expand the expression.  */
2562       name = operator_name_info[(int) code].mangled_name;
2563       if (name == NULL)
2564         {
2565           sorry ("mangling %C", code);
2566           return;
2567         }
2568       else
2569         write_string (name);    
2570
2571       switch (code)
2572         {
2573         case CALL_EXPR:
2574           {
2575             tree fn = CALL_EXPR_FN (expr);
2576
2577             if (TREE_CODE (fn) == ADDR_EXPR)
2578               fn = TREE_OPERAND (fn, 0);
2579
2580             /* Mangle a dependent name as the name, not whatever happens to
2581                be the first function in the overload set.  */
2582             if ((TREE_CODE (fn) == FUNCTION_DECL
2583                  || TREE_CODE (fn) == OVERLOAD)
2584                 && type_dependent_expression_p_push (expr))
2585               fn = DECL_NAME (get_first_fn (fn));
2586
2587             write_expression (fn);
2588           }
2589
2590           for (i = 0; i < call_expr_nargs (expr); ++i)
2591             write_expression (CALL_EXPR_ARG (expr, i));
2592           write_char ('E');
2593           break;
2594
2595         case CAST_EXPR:
2596           write_type (TREE_TYPE (expr));
2597           if (list_length (TREE_OPERAND (expr, 0)) == 1)          
2598             write_expression (TREE_VALUE (TREE_OPERAND (expr, 0)));
2599           else
2600             {
2601               tree args = TREE_OPERAND (expr, 0);
2602               write_char ('_');
2603               for (; args; args = TREE_CHAIN (args))
2604                 write_expression (TREE_VALUE (args));
2605               write_char ('E');
2606             }
2607           break;
2608
2609           /* FIXME these should have a distinct mangling.  */
2610         case STATIC_CAST_EXPR:
2611         case CONST_CAST_EXPR:
2612           write_type (TREE_TYPE (expr));
2613           write_expression (TREE_OPERAND (expr, 0));
2614           break;
2615
2616         case NEW_EXPR:
2617           sorry ("mangling new-expression");
2618           break;
2619
2620         default:
2621           /* In the middle-end, some expressions have more operands than
2622              they do in templates (and mangling).  */
2623           switch (code)
2624             {
2625             case PREINCREMENT_EXPR:
2626             case PREDECREMENT_EXPR:
2627             case POSTINCREMENT_EXPR:
2628             case POSTDECREMENT_EXPR:
2629               len = 1;
2630               break;
2631
2632             case ARRAY_REF:
2633               len = 2;
2634               break;
2635
2636             default:
2637               len = TREE_OPERAND_LENGTH (expr);
2638               break;
2639             }
2640
2641           for (i = 0; i < len; ++i)
2642             {
2643               tree operand = TREE_OPERAND (expr, i);
2644               /* As a GNU extension, the middle operand of a
2645                  conditional may be omitted.  Since expression
2646                  manglings are supposed to represent the input token
2647                  stream, there's no good way to mangle such an
2648                  expression without extending the C++ ABI.  */
2649               if (code == COND_EXPR && i == 1 && !operand)
2650                 {
2651                   error ("omitted middle operand to %<?:%> operand "
2652                          "cannot be mangled");
2653                   continue;
2654                 }
2655               write_expression (operand);
2656             }
2657         }
2658     }
2659 }
2660
2661 /* Literal subcase of non-terminal <template-arg>.
2662
2663      "Literal arguments, e.g. "A<42L>", are encoded with their type
2664      and value. Negative integer values are preceded with "n"; for
2665      example, "A<-42L>" becomes "1AILln42EE". The bool value false is
2666      encoded as 0, true as 1."  */
2667
2668 static void
2669 write_template_arg_literal (const tree value)
2670 {
2671   write_char ('L');
2672   write_type (TREE_TYPE (value));
2673
2674   switch (TREE_CODE (value))
2675     {
2676     case CONST_DECL:
2677       write_integer_cst (DECL_INITIAL (value));
2678       break;
2679
2680     case INTEGER_CST:
2681       gcc_assert (!same_type_p (TREE_TYPE (value), boolean_type_node)
2682                   || integer_zerop (value) || integer_onep (value));
2683       write_integer_cst (value);
2684       break;
2685
2686     case REAL_CST:
2687       write_real_cst (value);
2688       break;
2689
2690     default:
2691       gcc_unreachable ();
2692     }
2693
2694   write_char ('E');
2695 }
2696
2697 /* Non-terminal <template-arg>.
2698
2699      <template-arg> ::= <type>                          # type
2700                     ::= L <type> </value/ number> E     # literal
2701                     ::= LZ <name> E                     # external name
2702                     ::= X <expression> E                # expression  */
2703
2704 static void
2705 write_template_arg (tree node)
2706 {
2707   enum tree_code code = TREE_CODE (node);
2708
2709   MANGLE_TRACE_TREE ("template-arg", node);
2710
2711   /* A template template parameter's argument list contains TREE_LIST
2712      nodes of which the value field is the actual argument.  */
2713   if (code == TREE_LIST)
2714     {
2715       node = TREE_VALUE (node);
2716       /* If it's a decl, deal with its type instead.  */
2717       if (DECL_P (node))
2718         {
2719           node = TREE_TYPE (node);
2720           code = TREE_CODE (node);
2721         }
2722     }
2723
2724   if (TREE_CODE (node) == NOP_EXPR
2725       && TREE_CODE (TREE_TYPE (node)) == REFERENCE_TYPE)
2726     {
2727       /* Template parameters can be of reference type. To maintain
2728          internal consistency, such arguments use a conversion from
2729          address of object to reference type.  */
2730       gcc_assert (TREE_CODE (TREE_OPERAND (node, 0)) == ADDR_EXPR);
2731       if (abi_version_at_least (2))
2732         node = TREE_OPERAND (TREE_OPERAND (node, 0), 0);
2733       else
2734         G.need_abi_warning = 1;
2735     }
2736
2737   if (ARGUMENT_PACK_P (node))
2738     {
2739       /* Expand the template argument pack. */
2740       tree args = ARGUMENT_PACK_ARGS (node);
2741       int i, length = TREE_VEC_LENGTH (args);
2742       write_char ('I');
2743       for (i = 0; i < length; ++i)
2744         write_template_arg (TREE_VEC_ELT (args, i));
2745       write_char ('E');
2746     }
2747   else if (TYPE_P (node))
2748     write_type (node);
2749   else if (code == TEMPLATE_DECL)
2750     /* A template appearing as a template arg is a template template arg.  */
2751     write_template_template_arg (node);
2752   else if ((TREE_CODE_CLASS (code) == tcc_constant && code != PTRMEM_CST)
2753            || (abi_version_at_least (2) && code == CONST_DECL))
2754     write_template_arg_literal (node);
2755   else if (DECL_P (node))
2756     {
2757       /* Until ABI version 2, non-type template arguments of
2758          enumeration type were mangled using their names.  */
2759       if (code == CONST_DECL && !abi_version_at_least (2))
2760         G.need_abi_warning = 1;
2761       write_char ('L');
2762       /* Until ABI version 3, the underscore before the mangled name
2763          was incorrectly omitted.  */
2764       if (!abi_version_at_least (3))
2765         {
2766           G.need_abi_warning = 1;
2767           write_char ('Z');
2768         }
2769       else
2770         write_string ("_Z");
2771       write_encoding (node);
2772       write_char ('E');
2773     }
2774   else
2775     {
2776       /* Template arguments may be expressions.  */
2777       write_char ('X');
2778       write_expression (node);
2779       write_char ('E');
2780     }
2781 }
2782
2783 /*  <template-template-arg>
2784                         ::= <name>
2785                         ::= <substitution>  */
2786
2787 static void
2788 write_template_template_arg (const tree decl)
2789 {
2790   MANGLE_TRACE_TREE ("template-template-arg", decl);
2791
2792   if (find_substitution (decl))
2793     return;
2794   write_name (decl, /*ignore_local_scope=*/0);
2795   add_substitution (decl);
2796 }
2797
2798
2799 /* Non-terminal <array-type>.  TYPE is an ARRAY_TYPE.
2800
2801      <array-type> ::= A [</dimension/ number>] _ </element/ type>
2802                   ::= A <expression> _ </element/ type>
2803
2804      "Array types encode the dimension (number of elements) and the
2805      element type. For variable length arrays, the dimension (but not
2806      the '_' separator) is omitted."  */
2807
2808 static void
2809 write_array_type (const tree type)
2810 {
2811   write_char ('A');
2812   if (TYPE_DOMAIN (type))
2813     {
2814       tree index_type;
2815       tree max;
2816
2817       index_type = TYPE_DOMAIN (type);
2818       /* The INDEX_TYPE gives the upper and lower bounds of the
2819          array.  */
2820       max = TYPE_MAX_VALUE (index_type);
2821       if (TREE_CODE (max) == INTEGER_CST)
2822         {
2823           /* The ABI specifies that we should mangle the number of
2824              elements in the array, not the largest allowed index.  */
2825           max = size_binop (PLUS_EXPR, max, size_one_node);
2826           write_unsigned_number (tree_low_cst (max, 1));
2827         }
2828       else
2829         {
2830           max = TREE_OPERAND (max, 0);
2831           if (!abi_version_at_least (2))
2832             {
2833               /* value_dependent_expression_p presumes nothing is
2834                  dependent when PROCESSING_TEMPLATE_DECL is zero.  */
2835               ++processing_template_decl;
2836               if (!value_dependent_expression_p (max))
2837                 G.need_abi_warning = 1;
2838               --processing_template_decl;
2839             }
2840           write_expression (max);
2841         }
2842
2843     }
2844   write_char ('_');
2845   write_type (TREE_TYPE (type));
2846 }
2847
2848 /* Non-terminal <pointer-to-member-type> for pointer-to-member
2849    variables.  TYPE is a pointer-to-member POINTER_TYPE.
2850
2851      <pointer-to-member-type> ::= M </class/ type> </member/ type>  */
2852
2853 static void
2854 write_pointer_to_member_type (const tree type)
2855 {
2856   write_char ('M');
2857   write_type (TYPE_PTRMEM_CLASS_TYPE (type));
2858   write_type (TYPE_PTRMEM_POINTED_TO_TYPE (type));
2859 }
2860
2861 /* Non-terminal <template-param>.  PARM is a TEMPLATE_TYPE_PARM,
2862    TEMPLATE_TEMPLATE_PARM, BOUND_TEMPLATE_TEMPLATE_PARM or a
2863    TEMPLATE_PARM_INDEX.
2864
2865      <template-param> ::= T </parameter/ number> _  */
2866
2867 static void
2868 write_template_param (const tree parm)
2869 {
2870   int parm_index;
2871
2872   MANGLE_TRACE_TREE ("template-parm", parm);
2873
2874   switch (TREE_CODE (parm))
2875     {
2876     case TEMPLATE_TYPE_PARM:
2877     case TEMPLATE_TEMPLATE_PARM:
2878     case BOUND_TEMPLATE_TEMPLATE_PARM:
2879       parm_index = TEMPLATE_TYPE_IDX (parm);
2880       break;
2881
2882     case TEMPLATE_PARM_INDEX:
2883       parm_index = TEMPLATE_PARM_IDX (parm);
2884       break;
2885
2886     default:
2887       gcc_unreachable ();
2888     }
2889
2890   write_char ('T');
2891   /* NUMBER as it appears in the mangling is (-1)-indexed, with the
2892      earliest template param denoted by `_'.  */
2893   write_compact_number (parm_index);
2894 }
2895
2896 /*  <template-template-param>
2897                         ::= <template-param>
2898                         ::= <substitution>  */
2899
2900 static void
2901 write_template_template_param (const tree parm)
2902 {
2903   tree templ = NULL_TREE;
2904
2905   /* PARM, a TEMPLATE_TEMPLATE_PARM, is an instantiation of the
2906      template template parameter.  The substitution candidate here is
2907      only the template.  */
2908   if (TREE_CODE (parm) == BOUND_TEMPLATE_TEMPLATE_PARM)
2909     {
2910       templ
2911         = TI_TEMPLATE (TEMPLATE_TEMPLATE_PARM_TEMPLATE_INFO (parm));
2912       if (find_substitution (templ))
2913         return;
2914     }
2915
2916   /* <template-param> encodes only the template parameter position,
2917      not its template arguments, which is fine here.  */
2918   write_template_param (parm);
2919   if (templ)
2920     add_substitution (templ);
2921 }
2922
2923 /* Non-terminal <substitution>.
2924
2925       <substitution> ::= S <seq-id> _
2926                      ::= S_  */
2927
2928 static void
2929 write_substitution (const int seq_id)
2930 {
2931   MANGLE_TRACE ("substitution", "");
2932
2933   write_char ('S');
2934   if (seq_id > 0)
2935     write_number (seq_id - 1, /*unsigned=*/1, 36);
2936   write_char ('_');
2937 }
2938
2939 /* Start mangling ENTITY.  */
2940
2941 static inline void
2942 start_mangling (const tree entity)
2943 {
2944   G.entity = entity;
2945   G.need_abi_warning = false;
2946   obstack_free (&name_obstack, name_base);
2947   mangle_obstack = &name_obstack;
2948   name_base = obstack_alloc (&name_obstack, 0);
2949 }
2950
2951 /* Done with mangling. If WARN is true, and the name of G.entity will
2952    be mangled differently in a future version of the ABI, issue a
2953    warning.  */
2954
2955 static void
2956 finish_mangling_internal (const bool warn)
2957 {
2958   if (warn_abi && warn && G.need_abi_warning)
2959     warning (OPT_Wabi, "the mangled name of %qD will change in a future "
2960              "version of GCC",
2961              G.entity);
2962
2963   /* Clear all the substitutions.  */
2964   VEC_truncate (tree, G.substitutions, 0);
2965
2966   /* Null-terminate the string.  */
2967   write_char ('\0');
2968 }
2969
2970
2971 /* Like finish_mangling_internal, but return the mangled string.  */
2972
2973 static inline const char *
2974 finish_mangling (const bool warn)
2975 {
2976   finish_mangling_internal (warn);
2977   return (const char *) obstack_finish (mangle_obstack);
2978 }
2979
2980 /* Like finish_mangling_internal, but return an identifier.  */
2981
2982 static tree
2983 finish_mangling_get_identifier (const bool warn)
2984 {
2985   finish_mangling_internal (warn);
2986   /* Don't obstack_finish here, and the next start_mangling will
2987      remove the identifier.  */
2988   return get_identifier ((const char *) obstack_base (mangle_obstack));
2989 }
2990
2991 /* Initialize data structures for mangling.  */
2992
2993 void
2994 init_mangle (void)
2995 {
2996   gcc_obstack_init (&name_obstack);
2997   name_base = obstack_alloc (&name_obstack, 0);
2998   G.substitutions = NULL;
2999
3000   /* Cache these identifiers for quick comparison when checking for
3001      standard substitutions.  */
3002   subst_identifiers[SUBID_ALLOCATOR] = get_identifier ("allocator");
3003   subst_identifiers[SUBID_BASIC_STRING] = get_identifier ("basic_string");
3004   subst_identifiers[SUBID_CHAR_TRAITS] = get_identifier ("char_traits");
3005   subst_identifiers[SUBID_BASIC_ISTREAM] = get_identifier ("basic_istream");
3006   subst_identifiers[SUBID_BASIC_OSTREAM] = get_identifier ("basic_ostream");
3007   subst_identifiers[SUBID_BASIC_IOSTREAM] = get_identifier ("basic_iostream");
3008 }
3009
3010 /* Generate the mangled name of DECL.  */
3011
3012 static tree
3013 mangle_decl_string (const tree decl)
3014 {
3015   tree result;
3016   location_t saved_loc = input_location;
3017   tree saved_fn = NULL_TREE;
3018   bool template_p = false;
3019
3020   if (DECL_LANG_SPECIFIC (decl) && DECL_USE_TEMPLATE (decl))
3021     {
3022       struct tinst_level *tl = current_instantiation ();
3023       if (!tl || tl->decl != decl)
3024         {
3025           template_p = true;
3026           saved_fn = current_function_decl;
3027           push_tinst_level (decl);
3028           current_function_decl = NULL_TREE;
3029         }
3030     }
3031   input_location = DECL_SOURCE_LOCATION (decl);
3032
3033   start_mangling (decl);
3034
3035   if (TREE_CODE (decl) == TYPE_DECL)
3036     write_type (TREE_TYPE (decl));
3037   else
3038     write_mangled_name (decl, true);
3039
3040   result = finish_mangling_get_identifier (/*warn=*/true);
3041   if (DEBUG_MANGLE)
3042     fprintf (stderr, "mangle_decl_string = '%s'\n\n",
3043              IDENTIFIER_POINTER (result));
3044
3045   if (template_p)
3046     {
3047       pop_tinst_level ();
3048       current_function_decl = saved_fn;
3049     }
3050   input_location = saved_loc;
3051
3052   return result;
3053 }
3054
3055 /* Create an identifier for the external mangled name of DECL.  */
3056
3057 void
3058 mangle_decl (const tree decl)
3059 {
3060   tree id = mangle_decl_string (decl);
3061   id = targetm.mangle_decl_assembler_name (decl, id);
3062   SET_DECL_ASSEMBLER_NAME (decl, id);
3063
3064   if (G.need_abi_warning)
3065     {
3066 #ifdef ASM_OUTPUT_DEF
3067       /* If the mangling will change in the future, emit an alias with the
3068          future mangled name for forward-compatibility.  */
3069       int save_ver;
3070       tree id2, alias;
3071 #endif
3072
3073       SET_IDENTIFIER_GLOBAL_VALUE (id, decl);
3074       if (IDENTIFIER_GLOBAL_VALUE (id) != decl)
3075         inform (DECL_SOURCE_LOCATION (decl), "-fabi-version=4 (or =0) "
3076                 "avoids this error with a change in vector mangling");
3077
3078 #ifdef ASM_OUTPUT_DEF
3079       save_ver = flag_abi_version;
3080       flag_abi_version = 0;
3081       id2 = mangle_decl_string (decl);
3082       id2 = targetm.mangle_decl_assembler_name (decl, id2);
3083       flag_abi_version = save_ver;
3084
3085       alias = make_alias_for (decl, id2);
3086       DECL_IGNORED_P (alias) = 1;
3087       TREE_PUBLIC (alias) = TREE_PUBLIC (decl);
3088       DECL_VISIBILITY (alias) = DECL_VISIBILITY (decl);
3089       if (vague_linkage_p (decl))
3090         DECL_WEAK (alias) = 1;
3091       if (TREE_CODE (decl) == FUNCTION_DECL)
3092         cgraph_same_body_alias (alias, decl);
3093       else
3094         varpool_extra_name_alias (alias, decl);
3095 #endif
3096     }
3097 }
3098
3099 /* Generate the mangled representation of TYPE.  */
3100
3101 const char *
3102 mangle_type_string (const tree type)
3103 {
3104   const char *result;
3105
3106   start_mangling (type);
3107   write_type (type);
3108   result = finish_mangling (/*warn=*/false);
3109   if (DEBUG_MANGLE)
3110     fprintf (stderr, "mangle_type_string = '%s'\n\n", result);
3111   return result;
3112 }
3113
3114 /* Create an identifier for the mangled name of a special component
3115    for belonging to TYPE.  CODE is the ABI-specified code for this
3116    component.  */
3117
3118 static tree
3119 mangle_special_for_type (const tree type, const char *code)
3120 {
3121   tree result;
3122
3123   /* We don't have an actual decl here for the special component, so
3124      we can't just process the <encoded-name>.  Instead, fake it.  */
3125   start_mangling (type);
3126
3127   /* Start the mangling.  */
3128   write_string ("_Z");
3129   write_string (code);
3130
3131   /* Add the type.  */
3132   write_type (type);
3133   result = finish_mangling_get_identifier (/*warn=*/false);
3134
3135   if (DEBUG_MANGLE)
3136     fprintf (stderr, "mangle_special_for_type = %s\n\n",
3137              IDENTIFIER_POINTER (result));
3138
3139   return result;
3140 }
3141
3142 /* Create an identifier for the mangled representation of the typeinfo
3143    structure for TYPE.  */
3144
3145 tree
3146 mangle_typeinfo_for_type (const tree type)
3147 {
3148   return mangle_special_for_type (type, "TI");
3149 }
3150
3151 /* Create an identifier for the mangled name of the NTBS containing
3152    the mangled name of TYPE.  */
3153
3154 tree
3155 mangle_typeinfo_string_for_type (const tree type)
3156 {
3157   return mangle_special_for_type (type, "TS");
3158 }
3159
3160 /* Create an identifier for the mangled name of the vtable for TYPE.  */
3161
3162 tree
3163 mangle_vtbl_for_type (const tree type)
3164 {
3165   return mangle_special_for_type (type, "TV");
3166 }
3167
3168 /* Returns an identifier for the mangled name of the VTT for TYPE.  */
3169
3170 tree
3171 mangle_vtt_for_type (const tree type)
3172 {
3173   return mangle_special_for_type (type, "TT");
3174 }
3175
3176 /* Return an identifier for a construction vtable group.  TYPE is
3177    the most derived class in the hierarchy; BINFO is the base
3178    subobject for which this construction vtable group will be used.
3179
3180    This mangling isn't part of the ABI specification; in the ABI
3181    specification, the vtable group is dumped in the same COMDAT as the
3182    main vtable, and is referenced only from that vtable, so it doesn't
3183    need an external name.  For binary formats without COMDAT sections,
3184    though, we need external names for the vtable groups.
3185
3186    We use the production
3187
3188     <special-name> ::= CT <type> <offset number> _ <base type>  */
3189
3190 tree
3191 mangle_ctor_vtbl_for_type (const tree type, const tree binfo)
3192 {
3193   tree result;
3194
3195   start_mangling (type);
3196
3197   write_string ("_Z");
3198   write_string ("TC");
3199   write_type (type);
3200   write_integer_cst (BINFO_OFFSET (binfo));
3201   write_char ('_');
3202   write_type (BINFO_TYPE (binfo));
3203
3204   result = finish_mangling_get_identifier (/*warn=*/false);
3205   if (DEBUG_MANGLE)
3206     fprintf (stderr, "mangle_ctor_vtbl_for_type = %s\n\n",
3207              IDENTIFIER_POINTER (result));
3208   return result;
3209 }
3210
3211 /* Mangle a this pointer or result pointer adjustment.
3212
3213    <call-offset> ::= h <fixed offset number> _
3214                  ::= v <fixed offset number> _ <virtual offset number> _ */
3215
3216 static void
3217 mangle_call_offset (const tree fixed_offset, const tree virtual_offset)
3218 {
3219   write_char (virtual_offset ? 'v' : 'h');
3220
3221   /* For either flavor, write the fixed offset.  */
3222   write_integer_cst (fixed_offset);
3223   write_char ('_');
3224
3225   /* For a virtual thunk, add the virtual offset.  */
3226   if (virtual_offset)
3227     {
3228       write_integer_cst (virtual_offset);
3229       write_char ('_');
3230     }
3231 }
3232
3233 /* Return an identifier for the mangled name of a this-adjusting or
3234    covariant thunk to FN_DECL.  FIXED_OFFSET is the initial adjustment
3235    to this used to find the vptr.  If VIRTUAL_OFFSET is non-NULL, this
3236    is a virtual thunk, and it is the vtbl offset in
3237    bytes. THIS_ADJUSTING is nonzero for a this adjusting thunk and
3238    zero for a covariant thunk. Note, that FN_DECL might be a covariant
3239    thunk itself. A covariant thunk name always includes the adjustment
3240    for the this pointer, even if there is none.
3241
3242    <special-name> ::= T <call-offset> <base encoding>
3243                   ::= Tc <this_adjust call-offset> <result_adjust call-offset>
3244                                         <base encoding>  */
3245
3246 tree
3247 mangle_thunk (tree fn_decl, const int this_adjusting, tree fixed_offset,
3248               tree virtual_offset)
3249 {
3250   tree result;
3251
3252   start_mangling (fn_decl);
3253
3254   write_string ("_Z");
3255   write_char ('T');
3256
3257   if (!this_adjusting)
3258     {
3259       /* Covariant thunk with no this adjustment */
3260       write_char ('c');
3261       mangle_call_offset (integer_zero_node, NULL_TREE);
3262       mangle_call_offset (fixed_offset, virtual_offset);
3263     }
3264   else if (!DECL_THUNK_P (fn_decl))
3265     /* Plain this adjusting thunk.  */
3266     mangle_call_offset (fixed_offset, virtual_offset);
3267   else
3268     {
3269       /* This adjusting thunk to covariant thunk.  */
3270       write_char ('c');
3271       mangle_call_offset (fixed_offset, virtual_offset);
3272       fixed_offset = ssize_int (THUNK_FIXED_OFFSET (fn_decl));
3273       virtual_offset = THUNK_VIRTUAL_OFFSET (fn_decl);
3274       if (virtual_offset)
3275         virtual_offset = BINFO_VPTR_FIELD (virtual_offset);
3276       mangle_call_offset (fixed_offset, virtual_offset);
3277       fn_decl = THUNK_TARGET (fn_decl);
3278     }
3279
3280   /* Scoped name.  */
3281   write_encoding (fn_decl);
3282
3283   result = finish_mangling_get_identifier (/*warn=*/false);
3284   if (DEBUG_MANGLE)
3285     fprintf (stderr, "mangle_thunk = %s\n\n", IDENTIFIER_POINTER (result));
3286   return result;
3287 }
3288
3289 /* This hash table maps TYPEs to the IDENTIFIER for a conversion
3290    operator to TYPE.  The nodes are IDENTIFIERs whose TREE_TYPE is the
3291    TYPE.  */
3292
3293 static GTY ((param_is (union tree_node))) htab_t conv_type_names;
3294
3295 /* Hash a node (VAL1) in the table.  */
3296
3297 static hashval_t
3298 hash_type (const void *val)
3299 {
3300   return (hashval_t) TYPE_UID (TREE_TYPE ((const_tree) val));
3301 }
3302
3303 /* Compare VAL1 (a node in the table) with VAL2 (a TYPE).  */
3304
3305 static int
3306 compare_type (const void *val1, const void *val2)
3307 {
3308   return TREE_TYPE ((const_tree) val1) == (const_tree) val2;
3309 }
3310
3311 /* Return an identifier for the mangled unqualified name for a
3312    conversion operator to TYPE.  This mangling is not specified by the
3313    ABI spec; it is only used internally.  */
3314
3315 tree
3316 mangle_conv_op_name_for_type (const tree type)
3317 {
3318   void **slot;
3319   tree identifier;
3320
3321   if (type == error_mark_node)
3322     return error_mark_node;
3323
3324   if (conv_type_names == NULL)
3325     conv_type_names = htab_create_ggc (31, &hash_type, &compare_type, NULL);
3326
3327   slot = htab_find_slot_with_hash (conv_type_names, type,
3328                                    (hashval_t) TYPE_UID (type), INSERT);
3329   identifier = (tree)*slot;
3330   if (!identifier)
3331     {
3332       char buffer[64];
3333
3334        /* Create a unique name corresponding to TYPE.  */
3335       sprintf (buffer, "operator %lu",
3336                (unsigned long) htab_elements (conv_type_names));
3337       identifier = get_identifier (buffer);
3338       *slot = identifier;
3339
3340       /* Hang TYPE off the identifier so it can be found easily later
3341          when performing conversions.  */
3342       TREE_TYPE (identifier) = type;
3343
3344       /* Set bits on the identifier so we know later it's a conversion.  */
3345       IDENTIFIER_OPNAME_P (identifier) = 1;
3346       IDENTIFIER_TYPENAME_P (identifier) = 1;
3347     }
3348
3349   return identifier;
3350 }
3351
3352 /* Return an identifier for the name of an initialization guard
3353    variable for indicated VARIABLE.  */
3354
3355 tree
3356 mangle_guard_variable (const tree variable)
3357 {
3358   start_mangling (variable);
3359   write_string ("_ZGV");
3360   if (strncmp (IDENTIFIER_POINTER (DECL_NAME (variable)), "_ZGR", 4) == 0)
3361     /* The name of a guard variable for a reference temporary should refer
3362        to the reference, not the temporary.  */
3363     write_string (IDENTIFIER_POINTER (DECL_NAME (variable)) + 4);
3364   else
3365     write_name (variable, /*ignore_local_scope=*/0);
3366   return finish_mangling_get_identifier (/*warn=*/false);
3367 }
3368
3369 /* Return an identifier for the name of a temporary variable used to
3370    initialize a static reference.  This isn't part of the ABI, but we might
3371    as well call them something readable.  */
3372
3373 tree
3374 mangle_ref_init_variable (const tree variable)
3375 {
3376   start_mangling (variable);
3377   write_string ("_ZGR");
3378   write_name (variable, /*ignore_local_scope=*/0);
3379   return finish_mangling_get_identifier (/*warn=*/false);
3380 }
3381 \f
3382
3383 /* Foreign language type mangling section.  */
3384
3385 /* How to write the type codes for the integer Java type.  */
3386
3387 static void
3388 write_java_integer_type_codes (const tree type)
3389 {
3390   if (type == java_int_type_node)
3391     write_char ('i');
3392   else if (type == java_short_type_node)
3393     write_char ('s');
3394   else if (type == java_byte_type_node)
3395     write_char ('c');
3396   else if (type == java_char_type_node)
3397     write_char ('w');
3398   else if (type == java_long_type_node)
3399     write_char ('x');
3400   else if (type == java_boolean_type_node)
3401     write_char ('b');
3402   else
3403     gcc_unreachable ();
3404 }
3405
3406 #include "gt-cp-mangle.h"