git.oblomov.eu Git - wine/blob - dlls/msvcrt/undname.c

   1 /*
   2  *  Demangle VC++ symbols into C function prototypes
   3  *
   4  *  Copyright 2000 Jon Griffiths
   5  *            2004 Eric Pouech
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with this library; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  20  */
  21
  22 #include "config.h"
  23 #include "wine/port.h"
  24
  25 #include <assert.h>
  26 #include <stdio.h>
  27 #include "msvcrt.h"
  28
  29 #include "wine/debug.h"
  30
  31 WINE_DEFAULT_DEBUG_CHANNEL(msvcrt);
  32
  33 /* TODO:
  34  * - document a bit (grammar + functions)
  35  * - back-port this new code into tools/winedump/msmangle.c
  36  */
  37
  38 #define UNDNAME_COMPLETE                 (0x0000)
  39 #define UNDNAME_NO_LEADING_UNDERSCORES   (0x0001) /* Don't show __ in calling convention */
  40 #define UNDNAME_NO_MS_KEYWORDS           (0x0002) /* Don't show calling convention at all */
  41 #define UNDNAME_NO_FUNCTION_RETURNS      (0x0004) /* Don't show function/method return value */
  42 #define UNDNAME_NO_ALLOCATION_MODEL      (0x0008)
  43 #define UNDNAME_NO_ALLOCATION_LANGUAGE   (0x0010)
  44 #define UNDNAME_NO_MS_THISTYPE           (0x0020)
  45 #define UNDNAME_NO_CV_THISTYPE           (0x0040)
  46 #define UNDNAME_NO_THISTYPE              (0x0060)
  47 #define UNDNAME_NO_ACCESS_SPECIFIERS     (0x0080) /* Don't show access specifier (public/protected/private) */
  48 #define UNDNAME_NO_THROW_SIGNATURES      (0x0100)
  49 #define UNDNAME_NO_MEMBER_TYPE           (0x0200) /* Don't show static/virtual specifier */
  50 #define UNDNAME_NO_RETURN_UDT_MODEL      (0x0400)
  51 #define UNDNAME_32_BIT_DECODE            (0x0800)
  52 #define UNDNAME_NAME_ONLY                (0x1000) /* Only report the variable/method name */
  53 #define UNDNAME_NO_ARGUMENTS             (0x2000) /* Don't show method arguments */
  54 #define UNDNAME_NO_SPECIAL_SYMS          (0x4000)
  55 #define UNDNAME_NO_COMPLEX_TYPE          (0x8000)
  56
  57 /* How data types modifiers are stored:
  58  * M (in the following definitions) is defined for
  59  * 'A', 'B', 'C' and 'D' as follows
  60  *      {<A>}:  ""
  61  *      {<B>}:  "const "
  62  *      {<C>}:  "volatile "
  63  *      {<D>}:  "const volatile "
  64  *
  65  *      in arguments:
  66  *              P<M>x   {<M>}x*
  67  *              Q<M>x   {<M>}x* const
  68  *              A<M>x   {<M>}x&
  69  *      in data fields:
  70  *              same as for arguments and also the following
  71  *              ?<M>x   {<M>}x
  72  *
  73  */
  74
  75 #define MAX_ARRAY_ELTS  32
  76 struct array
  77 {
  78     unsigned            start;          /* first valid reference in array */
  79     unsigned            num;            /* total number of used elts */
  80     unsigned            max;
  81     char*               elts[MAX_ARRAY_ELTS];
  82 };
  83
  84 /* Structure holding a parsed symbol */
  85 struct parsed_symbol
  86 {
  87     unsigned            flags;          /* the UNDNAME_ flags used for demangling */
  88     malloc_func_t       mem_alloc_ptr;  /* internal allocator */
  89     free_func_t         mem_free_ptr;   /* internal deallocator */
  90
  91     const char*         current;        /* pointer in input (mangled) string */
  92     char*               result;         /* demangled string */
  93
  94     struct array        names;          /* array of names for back reference */
  95     struct array        stack;          /* stack of parsed strings */
  96
  97     void*               alloc_list;     /* linked list of allocated blocks */
  98     unsigned            avail_in_first; /* number of available bytes in head block */
  99 };
 100
 101 /* Type for parsing mangled types */
 102 struct datatype_t
 103 {
 104     const char*         left;
 105     const char*         right;
 106 };
 107
 108 /******************************************************************
 109  *              und_alloc
 110  *
 111  * Internal allocator. Uses a simple linked list of large blocks
 112  * where we use a poor-man allocator. It's fast, and since all
 113  * allocation is pool, memory management is easy (esp. freeing).
 114  */
 115 static void*    und_alloc(struct parsed_symbol* sym, size_t len)
 116 {
 117     void*       ptr;
 118
 119 #define BLOCK_SIZE      1024
 120 #define AVAIL_SIZE      (1024 - sizeof(void*))
 121
 122     if (len > AVAIL_SIZE)
 123     {
 124         /* allocate a specific block */
 125         ptr = sym->mem_alloc_ptr(sizeof(void*) + len);
 126         if (!ptr) return NULL;
 127         *(void**)ptr = sym->alloc_list;
 128         sym->alloc_list = ptr;
 129         sym->avail_in_first = 0;
 130         ptr = (char*)sym->alloc_list + sizeof(void*);
 131     }
 132     else
 133     {
 134         if (len > sym->avail_in_first)
 135         {
 136             /* add a new block */
 137             ptr = sym->mem_alloc_ptr(BLOCK_SIZE);
 138             if (!ptr) return NULL;
 139             *(void**)ptr = sym->alloc_list;
 140             sym->alloc_list = ptr;
 141             sym->avail_in_first = AVAIL_SIZE;
 142         }
 143         /* grab memory from head block */
 144         ptr = (char*)sym->alloc_list + BLOCK_SIZE - sym->avail_in_first;
 145         sym->avail_in_first -= len;
 146     }
 147     return ptr;
 148 #undef BLOCK_SIZE
 149 #undef AVAIL_SIZE
 150 }
 151
 152 /******************************************************************
 153  *              und_free
 154  * Frees all the blocks in the list of large blocks allocated by
 155  * und_alloc.
 156  */
 157 static void und_free_all(struct parsed_symbol* sym)
 158 {
 159     void*       next;
 160
 161     while (sym->alloc_list)
 162     {
 163         next = *(void**)sym->alloc_list;
 164         if(sym->mem_free_ptr) sym->mem_free_ptr(sym->alloc_list);
 165         sym->alloc_list = next;
 166     }
 167     sym->avail_in_first = 0;
 168 }
 169
 170 /******************************************************************
 171  *              str_array_init
 172  * Initialises an array of strings
 173  */
 174 static void str_array_init(struct array* a)
 175 {
 176     a->start = a->num = a->max = 0;
 177 }
 178
 179 /******************************************************************
 180  *              str_array_push
 181  * Adding a new string to an array
 182  */
 183 static void str_array_push(struct parsed_symbol* sym, const char* ptr, size_t len,
 184                            struct array* a)
 185 {
 186     assert(ptr);
 187     assert(a);
 188     assert(a->num < MAX_ARRAY_ELTS);
 189     if (len == -1) len = strlen(ptr);
 190     a->elts[a->num] = und_alloc(sym, len + 1);
 191     assert(a->elts[a->num]);
 192     memcpy(a->elts[a->num], ptr, len);
 193     a->elts[a->num][len] = '\0';
 194     if (++a->num >= a->max) a->max = a->num;
 195     {
 196         int i;
 197         char c;
 198
 199         for (i = a->max - 1; i >= 0; i--)
 200         {
 201             c = '>';
 202             if (i < a->start) c = '-';
 203             else if (i >= a->num) c = '}';
 204             TRACE("%p\t%d%c %s\n", a, i, c, a->elts[i]);
 205         }
 206     }
 207 }
 208
 209 /******************************************************************
 210  *              str_array_get_ref
 211  * Extracts a reference from an existing array (doing proper type
 212  * checking)
 213  */
 214 static char* str_array_get_ref(struct array* cref, unsigned idx)
 215 {
 216     assert(cref);
 217     if (cref->start + idx >= cref->max)
 218     {
 219         WARN("Out of bounds: %p %d + %d >= %d\n",
 220               cref, cref->start, idx, cref->max);
 221         return NULL;
 222     }
 223     TRACE("Returning %p[%d] => %s\n",
 224           cref, idx, cref->elts[cref->start + idx]);
 225     return cref->elts[cref->start + idx];
 226 }
 227
 228 /******************************************************************
 229  *              str_printf
 230  * Helper for printf type of command (only %s and %c are implemented)
 231  * while dynamically allocating the buffer
 232  */
 233 static char* str_printf(struct parsed_symbol* sym, const char* format, ...)
 234 {
 235     va_list     args;
 236     size_t      len = 1, i, sz;
 237     char*       tmp;
 238     char*       p;
 239     char*       t;
 240
 241     va_start(args, format);
 242     for (i = 0; format[i]; i++)
 243     {
 244         if (format[i] == '%')
 245         {
 246             switch (format[++i])
 247             {
 248             case 's': t = va_arg(args, char*); if (t) len += strlen(t); break;
 249             case 'c': (void)va_arg(args, int); len++; break;
 250             default: i--; /* fall thru */
 251             case '%': len++; break;
 252             }
 253         }
 254         else len++;
 255     }
 256     va_end(args);
 257     if (!(tmp = und_alloc(sym, len))) return NULL;
 258     va_start(args, format);
 259     for (p = tmp, i = 0; format[i]; i++)
 260     {
 261         if (format[i] == '%')
 262         {
 263             switch (format[++i])
 264             {
 265             case 's':
 266                 t = va_arg(args, char*);
 267                 if (t)
 268                 {
 269                     sz = strlen(t);
 270                     memcpy(p, t, sz);
 271                     p += sz;
 272                 }
 273                 break;
 274             case 'c':
 275                 *p++ = (char)va_arg(args, int);
 276                 break;
 277             default: i--; /* fall thru */
 278             case '%': *p++ = '%'; break;
 279             }
 280         }
 281         else *p++ = format[i];
 282     }
 283     va_end(args);
 284     *p = '\0';
 285     return tmp;
 286 }
 287
 288 /* forward declaration */
 289 static BOOL demangle_datatype(struct parsed_symbol* sym, struct datatype_t* ct,
 290                               struct array* pmt, BOOL in_args);
 291
 292 /******************************************************************
 293  *              get_args
 294  * Parses a list of function/method arguments, creates a string corresponding
 295  * to the arguments' list.
 296  */
 297 static char* get_args(struct parsed_symbol* sym, struct array* pmt_ref, BOOL z_term,
 298                       char open_char, char close_char)
 299
 300 {
 301     struct datatype_t   ct;
 302     struct array        arg_collect;
 303     char*               args_str = NULL;
 304     int                 i;
 305
 306     str_array_init(&arg_collect);
 307
 308     /* Now come the function arguments */
 309     while (*sym->current)
 310     {
 311         /* Decode each data type and append it to the argument list */
 312         if (*sym->current == '@')
 313         {
 314             sym->current++;
 315             break;
 316         }
 317         if (!demangle_datatype(sym, &ct, pmt_ref, TRUE))
 318             return NULL;
 319         /* 'void' terminates an argument list */
 320         if (!strcmp(ct.left, "void"))
 321         {
 322             if (!z_term && *sym->current == '@') sym->current++;
 323             break;
 324         }
 325         str_array_push(sym, str_printf(sym, "%s%s", ct.left, ct.right), -1,
 326                        &arg_collect);
 327         if (!strcmp(ct.left, "...")) break;
 328     }
 329     /* Functions are always terminated by 'Z'. If we made it this far and
 330      * don't find it, we have incorrectly identified a data type.
 331      */
 332     if (z_term && *sym->current++ != 'Z') return NULL;
 333
 334     if (arg_collect.num == 0 ||
 335         (arg_collect.num == 1 && !strcmp(arg_collect.elts[0], "void")))
 336         return str_printf(sym, "%cvoid%c", open_char, close_char);
 337     for (i = 1; i < arg_collect.num; i++)
 338     {
 339         args_str = str_printf(sym, "%s,%s", args_str, arg_collect.elts[i]);
 340     }
 341
 342     if (close_char == '>' && args_str && args_str[strlen(args_str) - 1] == '>')
 343         args_str = str_printf(sym, "%c%s%s %c",
 344                               open_char, arg_collect.elts[0], args_str, close_char);
 345     else
 346         args_str = str_printf(sym, "%c%s%s%c",
 347                               open_char, arg_collect.elts[0], args_str, close_char);
 348
 349     return args_str;
 350 }
 351
 352 /******************************************************************
 353  *              get_modifier
 354  * Parses the type modifier. Always returns a static string
 355  */
 356 static BOOL get_modifier(char ch, const char** ret)
 357 {
 358     switch (ch)
 359     {
 360     case 'A': *ret = NULL; break;
 361     case 'B': *ret = "const"; break;
 362     case 'C': *ret = "volatile"; break;
 363     case 'D': *ret = "const volatile"; break;
 364     default: return FALSE;
 365     }
 366     return TRUE;
 367 }
 368
 369 static const char* get_modified_type(struct parsed_symbol* sym, char modif)
 370 {
 371     const char* modifier;
 372     const char* ret = NULL;
 373     const char* str_modif;
 374
 375     switch (modif)
 376     {
 377     case 'A': str_modif = " &"; break;
 378     case 'B': str_modif = " & volatile"; break;
 379     case 'P': str_modif = " *"; break;
 380     case 'Q': str_modif = " * const"; break;
 381     case 'R': str_modif = " * volatile"; break;
 382     case 'S': str_modif = " * const volatile"; break;
 383     case '?': str_modif = ""; break;
 384     default: return NULL;
 385     }
 386
 387     if (get_modifier(*sym->current++, &modifier))
 388     {
 389         unsigned            mark = sym->stack.num;
 390         struct datatype_t   sub_ct;
 391
 392         /* Recurse to get the referred-to type */
 393         if (!demangle_datatype(sym, &sub_ct, NULL, FALSE))
 394             return NULL;
 395         ret = str_printf(sym, "%s%s%s%s%s",
 396                          sub_ct.left, sub_ct.left && modifier ? " " : NULL,
 397                          modifier, sub_ct.right, str_modif);
 398         sym->stack.num = mark;
 399     }
 400     return ret;
 401 }
 402
 403 /******************************************************************
 404  *             get_literal_string
 405  * Gets the literal name from the current position in the mangled
 406  * symbol to the first '@' character. It pushes the parsed name to
 407  * the symbol names stack and returns a pointer to it or NULL in
 408  * case of an error.
 409  */
 410 static char* get_literal_string(struct parsed_symbol* sym)
 411 {
 412     const char *ptr = sym->current;
 413
 414     do {
 415         if (!((*sym->current >= 'A' && *sym->current <= 'Z') ||
 416               (*sym->current >= 'a' && *sym->current <= 'z') ||
 417               (*sym->current >= '0' && *sym->current <= '9') ||
 418               *sym->current == '_' || *sym->current == '$')) {
 419             TRACE("Failed at '%c' in %s\n", *sym->current, ptr);
 420             return NULL;
 421         }
 422     } while (*++sym->current != '@');
 423     sym->current++;
 424     str_array_push(sym, ptr, sym->current - 1 - ptr, &sym->names);
 425
 426     return str_array_get_ref(&sym->names, sym->names.num - sym->names.start - 1);
 427 }
 428
 429 /******************************************************************
 430  *              get_template_name
 431  * Parses a name with a template argument list and returns it as
 432  * a string.
 433  * In a template argument list the back reference to the names
 434  * table is separately created. '0' points to the class component
 435  * name with the template arguments.  We use the same stack array
 436  * to hold the names but save/restore the stack state before/after
 437  * parsing the template argument list.
 438  */
 439 static char* get_template_name(struct parsed_symbol* sym)
 440 {
 441     char *name, *args;
 442     unsigned num_mark = sym->names.num;
 443     unsigned start_mark = sym->names.start;
 444     unsigned stack_mark = sym->stack.num;
 445
 446     sym->names.start = sym->names.num;
 447     if (!(name = get_literal_string(sym)))
 448         return FALSE;
 449     args = get_args(sym, NULL, FALSE, '<', '>');
 450     if (args != NULL)
 451         name = str_printf(sym, "%s%s", name, args);
 452     sym->names.num = num_mark;
 453     sym->names.start = start_mark;
 454     sym->stack.num = stack_mark;
 455     return name;
 456 }
 457
 458 /******************************************************************
 459  *              get_class
 460  * Parses class as a list of parent-classes, terminated by '@' and stores the
 461  * result in 'a' array. Each parent-classes, as well as the inner element
 462  * (either field/method name or class name), are represented in the mangled
 463  * name by a literal name ([a-zA-Z0-9_]+ terminated by '@') or a back reference
 464  * ([0-9]) or a name with template arguments ('?$' literal name followed by the
 465  * template argument list). The class name components appear in the reverse
 466  * order in the mangled name, e.g aaa@bbb@ccc@@ will be demangled to
 467  * ccc::bbb::aaa
 468  * For each of this class name componets a string will be allocated in the
 469  * array.
 470  */
 471 static BOOL get_class(struct parsed_symbol* sym)
 472 {
 473     const char* name = NULL;
 474
 475     while (*sym->current != '@')
 476     {
 477         switch (*sym->current)
 478         {
 479         case '\0': return FALSE;
 480
 481         case '0': case '1': case '2': case '3':
 482         case '4': case '5': case '6': case '7':
 483         case '8': case '9':
 484             name = str_array_get_ref(&sym->names, *sym->current++ - '0');
 485             break;
 486         case '?':
 487             if (*++sym->current == '$')
 488             {
 489                 sym->current++;
 490                 name = get_template_name(sym);
 491                 str_array_push(sym, name, -1, &sym->names);
 492             }
 493             break;
 494         default:
 495             name = get_literal_string(sym);
 496             break;
 497         }
 498         if (!name)
 499             return FALSE;
 500         str_array_push(sym, name, -1, &sym->stack);
 501     }
 502     sym->current++;
 503     return TRUE;
 504 }
 505
 506 /******************************************************************
 507  *              get_class_string
 508  * From an array collected by get_class in sym->stack, constructs the
 509  * corresponding (allocated) string
 510  */
 511 static char* get_class_string(struct parsed_symbol* sym, int start)
 512 {
 513     int         i;
 514     size_t      len, sz;
 515     char*       ret;
 516     struct array *a = &sym->stack;
 517
 518     for (len = 0, i = start; i < a->num; i++)
 519     {
 520         assert(a->elts[i]);
 521         len += 2 + strlen(a->elts[i]);
 522     }
 523     if (!(ret = und_alloc(sym, len - 1))) return NULL;
 524     for (len = 0, i = a->num - 1; i >= start; i--)
 525     {
 526         sz = strlen(a->elts[i]);
 527         memcpy(ret + len, a->elts[i], sz);
 528         len += sz;
 529         if (i > start)
 530         {
 531             ret[len++] = ':';
 532             ret[len++] = ':';
 533         }
 534     }
 535     ret[len] = '\0';
 536     return ret;
 537 }
 538
 539 /******************************************************************
 540  *            get_class_name
 541  * Wrapper around get_class and get_class_string.
 542  */
 543 static char* get_class_name(struct parsed_symbol* sym)
 544 {
 545     unsigned    mark = sym->stack.num;
 546     char*       s = NULL;
 547
 548     if (get_class(sym))
 549         s = get_class_string(sym, mark);
 550     sym->stack.num = mark;
 551     return s;
 552 }
 553
 554 /******************************************************************
 555  *              get_calling_convention
 556  * Returns a static string corresponding to the calling convention described
 557  * by char 'ch'. Sets export to TRUE iff the calling convention is exported.
 558  */
 559 static BOOL get_calling_convention(char ch, const char** call_conv,
 560                                    const char** exported, unsigned flags)
 561 {
 562     *call_conv = *exported = NULL;
 563
 564     if (!(flags & (UNDNAME_NO_MS_KEYWORDS | UNDNAME_NO_ALLOCATION_LANGUAGE)))
 565     {
 566         if (flags & UNDNAME_NO_LEADING_UNDERSCORES)
 567         {
 568             if (((ch - 'A') % 2) == 1) *exported = "dll_export ";
 569             switch (ch)
 570             {
 571             case 'A': case 'B': *call_conv = "cdecl"; break;
 572             case 'C': case 'D': *call_conv = "pascal"; break;
 573             case 'E': case 'F': *call_conv = "thiscall"; break;
 574             case 'G': case 'H': *call_conv = "stdcall"; break;
 575             case 'I': case 'J': *call_conv = "fastcall"; break;
 576             case 'K': break;
 577             default: ERR("Unknown calling convention %c\n", ch); return FALSE;
 578             }
 579         }
 580         else
 581         {
 582             if (((ch - 'A') % 2) == 1) *exported = "__dll_export ";
 583             switch (ch)
 584             {
 585             case 'A': case 'B': *call_conv = "__cdecl"; break;
 586             case 'C': case 'D': *call_conv = "__pascal"; break;
 587             case 'E': case 'F': *call_conv = "__thiscall"; break;
 588             case 'G': case 'H': *call_conv = "__stdcall"; break;
 589             case 'I': case 'J': *call_conv = "__fastcall"; break;
 590             case 'K': break;
 591             default: ERR("Unknown calling convention %c\n", ch); return FALSE;
 592             }
 593         }
 594     }
 595     return TRUE;
 596 }
 597
 598 /*******************************************************************
 599  *         get_simple_type
 600  * Return a string containing an allocated string for a simple data type
 601  */
 602 static const char* get_simple_type(char c)
 603 {
 604     const char* type_string;
 605
 606     switch (c)
 607     {
 608     case 'C': type_string = "signed char"; break;
 609     case 'D': type_string = "char"; break;
 610     case 'E': type_string = "unsigned char"; break;
 611     case 'F': type_string = "short"; break;
 612     case 'G': type_string = "unsigned short"; break;
 613     case 'H': type_string = "int"; break;
 614     case 'I': type_string = "unsigned int"; break;
 615     case 'J': type_string = "long"; break;
 616     case 'K': type_string = "unsigned long"; break;
 617     case 'M': type_string = "float"; break;
 618     case 'N': type_string = "double"; break;
 619     case 'O': type_string = "long double"; break;
 620     case 'X': type_string = "void"; break;
 621     case 'Z': type_string = "..."; break;
 622     default:  type_string = NULL; break;
 623     }
 624     return type_string;
 625 }
 626
 627 /*******************************************************************
 628  *         get_extented_type
 629  * Return a string containing an allocated string for a simple data type
 630  */
 631 static const char* get_extended_type(char c)
 632 {
 633     const char* type_string;
 634
 635     switch (c)
 636     {
 637     case 'D': type_string = "__int8"; break;
 638     case 'E': type_string = "unsigned __int8"; break;
 639     case 'F': type_string = "__int16"; break;
 640     case 'G': type_string = "unsigned __int16"; break;
 641     case 'H': type_string = "__int32"; break;
 642     case 'I': type_string = "unsigned __int32"; break;
 643     case 'J': type_string = "__int64"; break;
 644     case 'K': type_string = "unsigned __int64"; break;
 645     case 'L': type_string = "__int128"; break;
 646     case 'M': type_string = "unsigned __int128"; break;
 647     case 'N': type_string = "bool"; break;
 648     case 'W': type_string = "wchar_t"; break;
 649     default:  type_string = NULL; break;
 650     }
 651     return type_string;
 652 }
 653
 654 /*******************************************************************
 655  *         demangle_datatype
 656  *
 657  * Attempt to demangle a C++ data type, which may be datatype.
 658  * a datatype type is made up of a number of simple types. e.g:
 659  * char** = (pointer to (pointer to (char)))
 660  */
 661 static BOOL demangle_datatype(struct parsed_symbol* sym, struct datatype_t* ct,
 662                               struct array* pmt_ref, BOOL in_args)
 663 {
 664     char                dt;
 665     BOOL                add_pmt = TRUE;
 666     int                 num_args=0;
 667
 668     assert(ct);
 669     ct->left = ct->right = NULL;
 670
 671     switch (dt = *sym->current++)
 672     {
 673     case '_':
 674         /* MS type: __int8,__int16 etc */
 675         ct->left = get_extended_type(*sym->current++);
 676         break;
 677     case 'C': case 'D': case 'E': case 'F': case 'G':
 678     case 'H': case 'I': case 'J': case 'K': case 'M':
 679     case 'N': case 'O': case 'X': case 'Z':
 680         /* Simple data types */
 681         ct->left = get_simple_type(dt);
 682         add_pmt = FALSE;
 683         break;
 684     case 'T': /* union */
 685     case 'U': /* struct */
 686     case 'V': /* class */
 687         /* Class/struct/union */
 688         {
 689             const char* struct_name = NULL;
 690             const char* type_name = NULL;
 691
 692             if (!(struct_name = get_class_name(sym)))
 693                 goto done;
 694             if (!(sym->flags & UNDNAME_NO_COMPLEX_TYPE))
 695             {
 696                 switch (dt)
 697                 {
 698                 case 'T': type_name = "union ";  break;
 699                 case 'U': type_name = "struct "; break;
 700                 case 'V': type_name = "class ";  break;
 701                 }
 702             }
 703             ct->left = str_printf(sym, "%s%s", type_name, struct_name);
 704         }
 705         break;
 706     case '?':
 707         /* not all the time is seems */
 708         if (!(ct->left = get_modified_type(sym, '?'))) goto done;
 709         break;
 710     case 'A': /* reference */
 711     case 'B': /* volatile reference */
 712         if (!(ct->left = get_modified_type(sym, dt))) goto done;
 713         break;
 714     case 'Q': /* const pointer */
 715     case 'R': /* volatile pointer */
 716     case 'S': /* const volatile pointer */
 717         if (!(ct->left = get_modified_type(sym, in_args ? dt : 'P'))) goto done;
 718         break;
 719     case 'P': /* Pointer */
 720         if (isdigit(*sym->current))
 721         {
 722             /* FIXME: P6 = Function pointer, others who knows.. */
 723             if (*sym->current++ == '6')
 724             {
 725                 char*                   args = NULL;
 726                 const char*             call_conv;
 727                 const char*             exported;
 728                 struct datatype_t       sub_ct;
 729                 unsigned                mark = sym->stack.num;
 730
 731                 if (!get_calling_convention(*sym->current++,
 732                                             &call_conv, &exported,
 733                                             sym->flags & ~UNDNAME_NO_ALLOCATION_LANGUAGE) ||
 734                     !demangle_datatype(sym, &sub_ct, pmt_ref, FALSE))
 735                     goto done;
 736
 737                 args = get_args(sym, pmt_ref, TRUE, '(', ')');
 738                 if (!args) goto done;
 739                 sym->stack.num = mark;
 740
 741                 ct->left  = str_printf(sym, "%s%s (%s*",
 742                                        sub_ct.left, sub_ct.right, call_conv);
 743                 ct->right = str_printf(sym, ")%s", args);
 744             }
 745             else goto done;
 746         }
 747         else if (!(ct->left = get_modified_type(sym, 'P'))) goto done;
 748         break;
 749     case 'W':
 750         if (*sym->current == '4')
 751         {
 752             char*               enum_name;
 753             sym->current++;
 754             if (!(enum_name = get_class_name(sym)))
 755                 goto done;
 756             if (sym->flags & UNDNAME_NO_COMPLEX_TYPE)
 757                 ct->left = enum_name;
 758             else
 759                 ct->left = str_printf(sym, "enum %s", enum_name);
 760         }
 761         else goto done;
 762         break;
 763     case '0': case '1': case '2': case '3': case '4':
 764     case '5': case '6': case '7': case '8': case '9':
 765         /* Referring back to previously parsed type */
 766         ct->left = str_array_get_ref(pmt_ref, dt - '0');
 767         if (!ct->left) goto done;
 768         add_pmt = FALSE;
 769         break;
 770     case '$':
 771         if (sym->current[0] != '0') goto done;
 772         if (sym->current[1] >= '0' && sym->current[1] <= '9')
 773         {
 774             char*       ptr;
 775             ptr = und_alloc(sym, 2);
 776             ptr[0] = sym->current[1] + 1;
 777             ptr[1] = 0;
 778             ct->left = ptr;
 779             sym->current += 2;
 780         }
 781         else if (sym->current[1] >= 'A' && sym->current[1] <= 'P')
 782         {
 783             while (sym->current[1] >= 'A' && sym->current[1] <= 'P')
 784             {
 785                 num_args *= 16;
 786                 num_args += sym->current[1] - 'A';
 787                 sym->current += 1;
 788             }
 789             if(sym->current[1] == '@')
 790             {
 791                 char *ptr;
 792                 ptr = und_alloc(sym, 17);
 793                 sprintf(ptr,"%d",num_args);
 794                 ct->left = ptr;
 795                 sym->current += 1;
 796             }
 797         }
 798         else goto done;
 799         break;
 800     default :
 801         ERR("Unknown type %c\n", dt);
 802         break;
 803     }
 804     if (add_pmt && pmt_ref && in_args)
 805         str_array_push(sym, str_printf(sym, "%s%s", ct->left, ct->right),
 806                        -1, pmt_ref);
 807 done:
 808
 809     return ct->left != NULL;
 810 }
 811
 812 /******************************************************************
 813  *              handle_data
 814  * Does the final parsing and handling for a variable or a field in
 815  * a class.
 816  */
 817 static BOOL handle_data(struct parsed_symbol* sym)
 818 {
 819     const char*         access = NULL;
 820     const char*         member_type = NULL;
 821     const char*         modifier = NULL;
 822     struct datatype_t   ct;
 823     char*               name = NULL;
 824     BOOL                ret = FALSE;
 825     char                dt;
 826
 827     /* 0 private static
 828      * 1 protected static
 829      * 2 public static
 830      * 3 private non-static
 831      * 4 protected non-static
 832      * 5 public non-static
 833      * 6 ?? static
 834      * 7 ?? static
 835      */
 836
 837     if (!(sym->flags & UNDNAME_NO_ACCESS_SPECIFIERS))
 838     {
 839         /* we only print the access for static members */
 840         switch (*sym->current)
 841         {
 842         case '0': access = "private: "; break;
 843         case '1': access = "protected: "; break;
 844         case '2': access = "public: "; break;
 845         }
 846     }
 847
 848     if (!(sym->flags & UNDNAME_NO_MEMBER_TYPE))
 849     {
 850         if (*sym->current >= '0' && *sym->current <= '2')
 851             member_type = "static ";
 852     }
 853
 854     name = get_class_string(sym, 0);
 855
 856     switch (dt = *sym->current++)
 857     {
 858     case '0': case '1': case '2':
 859     case '3': case '4': case '5':
 860         {
 861             unsigned mark = sym->stack.num;
 862             struct array pmt;
 863
 864             str_array_init(&pmt);
 865
 866             if (!demangle_datatype(sym, &ct, &pmt, FALSE)) goto done;
 867             if (!get_modifier(*sym->current++, &modifier)) goto done;
 868             sym->stack.num = mark;
 869         }
 870         break;
 871     case '6' : /* compiler generated static */
 872     case '7' : /* compiler generated static */
 873         ct.left = ct.right = NULL;
 874         if (!get_modifier(*sym->current++, &modifier)) goto done;
 875         if (*sym->current != '@')
 876         {
 877             char*       cls = NULL;
 878
 879             if (!(cls = get_class_name(sym)))
 880                 goto done;
 881             ct.right = str_printf(sym, "{for `%s'}", cls);
 882         }
 883         break;
 884     default: goto done;
 885     }
 886     if (sym->flags & UNDNAME_NAME_ONLY) ct.left = ct.right = modifier = NULL;
 887     sym->result = str_printf(sym, "%s%s%s%s%s%s%s%s", access,
 888                              member_type, ct.left,
 889                              modifier && ct.left ? " " : NULL, modifier,
 890                              modifier || ct.left ? " " : NULL, name, ct.right);
 891     ret = TRUE;
 892 done:
 893     return ret;
 894 }
 895
 896 /******************************************************************
 897  *              handle_method
 898  * Does the final parsing and handling for a function or a method in
 899  * a class.
 900  */
 901 static BOOL handle_method(struct parsed_symbol* sym, BOOL cast_op)
 902 {
 903     const char*         access = NULL;
 904     const char*         member_type = NULL;
 905     struct datatype_t   ct_ret;
 906     const char*         call_conv;
 907     const char*         modifier = NULL;
 908     const char*         exported;
 909     const char*         args_str = NULL;
 910     const char*         name = NULL;
 911     BOOL                ret = FALSE;
 912     unsigned            mark;
 913     struct array        array_pmt;
 914
 915     /* FIXME: why 2 possible letters for each option?
 916      * 'A' private:
 917      * 'B' private:
 918      * 'C' private: static
 919      * 'D' private: static
 920      * 'E' private: virtual
 921      * 'F' private: virtual
 922      * 'G' private: thunk
 923      * 'H' private: thunk
 924      * 'I' protected:
 925      * 'J' protected:
 926      * 'K' protected: static
 927      * 'L' protected: static
 928      * 'M' protected: virtual
 929      * 'N' protected: virtual
 930      * 'O' protected: thunk
 931      * 'P' protected: thunk
 932      * 'Q' public:
 933      * 'R' public:
 934      * 'S' public: static
 935      * 'T' public: static
 936      * 'U' public: virtual
 937      * 'V' public: virtual
 938      * 'W' public: thunk
 939      * 'X' public: thunk
 940      * 'Y'
 941      * 'Z'
 942      */
 943
 944     if (!(sym->flags & UNDNAME_NO_ACCESS_SPECIFIERS))
 945     {
 946         switch ((*sym->current - 'A') / 8)
 947         {
 948         case 0: access = "private: "; break;
 949         case 1: access = "protected: "; break;
 950         case 2: access = "public: "; break;
 951         }
 952     }
 953     if (!(sym->flags & UNDNAME_NO_MEMBER_TYPE))
 954     {
 955         if (*sym->current >= 'A' && *sym->current <= 'X')
 956         {
 957             switch ((*sym->current - 'A') % 8)
 958             {
 959             case 2: case 3: member_type = "static "; break;
 960             case 4: case 5: member_type = "virtual "; break;
 961             case 6: case 7: member_type = "thunk "; break;
 962             }
 963         }
 964     }
 965
 966     if (*sym->current >= 'A' && *sym->current <= 'X')
 967     {
 968         if (!((*sym->current - 'A') & 2))
 969         {
 970             /* Implicit 'this' pointer */
 971             /* If there is an implicit this pointer, const modifier follows */
 972             if (!get_modifier(*++sym->current, &modifier)) goto done;
 973         }
 974     }
 975     else if (*sym->current < 'A' || *sym->current > 'Z') goto done;
 976     sym->current++;
 977
 978     name = get_class_string(sym, 0);
 979
 980     if (!get_calling_convention(*sym->current++, &call_conv, &exported,
 981                                 sym->flags))
 982         goto done;
 983
 984     str_array_init(&array_pmt);
 985
 986     /* Return type, or @ if 'void' */
 987     if (*sym->current == '@')
 988     {
 989         ct_ret.left = "void";
 990         ct_ret.right = NULL;
 991         sym->current++;
 992     }
 993     else
 994     {
 995         if (!demangle_datatype(sym, &ct_ret, &array_pmt, FALSE))
 996             goto done;
 997     }
 998     if (sym->flags & UNDNAME_NO_FUNCTION_RETURNS)
 999         ct_ret.left = ct_ret.right = NULL;
1000     if (cast_op)
1001     {
1002         name = str_printf(sym, "%s%s%s", name, ct_ret.left, ct_ret.right);
1003         ct_ret.left = ct_ret.right = NULL;
1004     }
1005
1006     mark = sym->stack.num;
1007     if (!(args_str = get_args(sym, &array_pmt, TRUE, '(', ')'))) goto done;
1008     if (sym->flags & UNDNAME_NAME_ONLY) args_str = modifier = NULL;
1009     sym->stack.num = mark;
1010
1011     /* Note: '()' after 'Z' means 'throws', but we don't care here
1012      * Yet!!! FIXME
1013      */
1014     sym->result = str_printf(sym, "%s%s%s%s%s%s%s%s%s%s%s%s",
1015                              access, member_type, ct_ret.left,
1016                              (ct_ret.left && !ct_ret.right) ? " " : NULL,
1017                              call_conv, call_conv ? " " : NULL, exported,
1018                              name, args_str, modifier,
1019                              modifier ? " " : NULL, ct_ret.right);
1020     ret = TRUE;
1021 done:
1022     return ret;
1023 }
1024
1025 /*******************************************************************
1026  *         symbol_demangle
1027  * Demangle a C++ linker symbol
1028  */
1029 static BOOL symbol_demangle(struct parsed_symbol* sym)
1030 {
1031     BOOL                ret = FALSE;
1032     unsigned            do_after = 0;
1033     static CHAR         dashed_null[] = "--null--";
1034
1035     /* FIXME seems wrong as name, as it demangles a simple data type */
1036     if (sym->flags & UNDNAME_NO_ARGUMENTS)
1037     {
1038         struct datatype_t   ct;
1039
1040         if (demangle_datatype(sym, &ct, NULL, FALSE))
1041         {
1042             sym->result = str_printf(sym, "%s%s", ct.left, ct.right);
1043             ret = TRUE;
1044         }
1045         goto done;
1046     }
1047
1048     /* MS mangled names always begin with '?' */
1049     if (*sym->current != '?') return FALSE;
1050     str_array_init(&sym->names);
1051     str_array_init(&sym->stack);
1052     sym->current++;
1053
1054     /* Then function name or operator code */
1055     if (*sym->current == '?' && sym->current[1] != '$')
1056     {
1057         const char* function_name = NULL;
1058
1059         /* C++ operator code (one character, or two if the first is '_') */
1060         switch (*++sym->current)
1061         {
1062         case '0': do_after = 1; break;
1063         case '1': do_after = 2; break;
1064         case '2': function_name = "operator new"; break;
1065         case '3': function_name = "operator delete"; break;
1066         case '4': function_name = "operator="; break;
1067         case '5': function_name = "operator>>"; break;
1068         case '6': function_name = "operator<<"; break;
1069         case '7': function_name = "operator!"; break;
1070         case '8': function_name = "operator=="; break;
1071         case '9': function_name = "operator!="; break;
1072         case 'A': function_name = "operator[]"; break;
1073         case 'B': function_name = "operator "; do_after = 3; break;
1074         case 'C': function_name = "operator->"; break;
1075         case 'D': function_name = "operator*"; break;
1076         case 'E': function_name = "operator++"; break;
1077         case 'F': function_name = "operator--"; break;
1078         case 'G': function_name = "operator-"; break;
1079         case 'H': function_name = "operator+"; break;
1080         case 'I': function_name = "operator&"; break;
1081         case 'J': function_name = "operator->*"; break;
1082         case 'K': function_name = "operator/"; break;
1083         case 'L': function_name = "operator%"; break;
1084         case 'M': function_name = "operator<"; break;
1085         case 'N': function_name = "operator<="; break;
1086         case 'O': function_name = "operator>"; break;
1087         case 'P': function_name = "operator>="; break;
1088         case 'Q': function_name = "operator,"; break;
1089         case 'R': function_name = "operator()"; break;
1090         case 'S': function_name = "operator~"; break;
1091         case 'T': function_name = "operator^"; break;
1092         case 'U': function_name = "operator|"; break;
1093         case 'V': function_name = "operator&&"; break;
1094         case 'W': function_name = "operator||"; break;
1095         case 'X': function_name = "operator*="; break;
1096         case 'Y': function_name = "operator+="; break;
1097         case 'Z': function_name = "operator-="; break;
1098         case '_':
1099             switch (*++sym->current)
1100             {
1101             case '0': function_name = "operator/="; break;
1102             case '1': function_name = "operator%="; break;
1103             case '2': function_name = "operator>>="; break;
1104             case '3': function_name = "operator<<="; break;
1105             case '4': function_name = "operator&="; break;
1106             case '5': function_name = "operator|="; break;
1107             case '6': function_name = "operator^="; break;
1108             case '7': function_name = "`vftable'"; break;
1109             case '8': function_name = "`vbtable'"; break;
1110             case '9': function_name = "`vcall'"; break;
1111             case 'A': function_name = "`typeof'"; break;
1112             case 'B': function_name = "`local static guard'"; break;
1113             case 'C': function_name = "`string'"; do_after = 4; break;
1114             case 'D': function_name = "`vbase destructor'"; break;
1115             case 'E': function_name = "`vector deleting destructor'"; break;
1116             case 'F': function_name = "`default constructor closure'"; break;
1117             case 'G': function_name = "`scalar deleting destructor'"; break;
1118             case 'H': function_name = "`vector constructor iterator'"; break;
1119             case 'I': function_name = "`vector destructor iterator'"; break;
1120             case 'J': function_name = "`vector vbase constructor iterator'"; break;
1121             case 'K': function_name = "`virtual displacement map'"; break;
1122             case 'L': function_name = "`eh vector constructor iterator'"; break;
1123             case 'M': function_name = "`eh vector destructor iterator'"; break;
1124             case 'N': function_name = "`eh vector vbase constructor iterator'"; break;
1125             case 'O': function_name = "`copy constructor closure'"; break;
1126             case 'S': function_name = "`local vftable'"; break;
1127             case 'T': function_name = "`local vftable constructor closure'"; break;
1128             case 'U': function_name = "operator new[]"; break;
1129             case 'V': function_name = "operator delete[]"; break;
1130             case 'X': function_name = "`placement delete closure'"; break;
1131             case 'Y': function_name = "`placement delete[] closure'"; break;
1132             default:
1133                 ERR("Unknown operator: _%c\n", *sym->current);
1134                 return FALSE;
1135             }
1136             break;
1137         default:
1138             /* FIXME: Other operators */
1139             ERR("Unknown operator: %c\n", *sym->current);
1140             return FALSE;
1141         }
1142         sym->current++;
1143         switch (do_after)
1144         {
1145         case 1: case 2:
1146             sym->stack.num = sym->stack.max = 1;
1147             sym->stack.elts[0] = dashed_null;
1148             break;
1149         case 4:
1150             sym->result = (char*)function_name;
1151             ret = TRUE;
1152             goto done;
1153         default:
1154             str_array_push(sym, function_name, -1, &sym->stack);
1155             break;
1156         }
1157         sym->stack.start = 1;
1158     }
1159     else if (*sym->current == '$')
1160     {
1161         /* Strange construct, it's a name with a template argument list
1162            and that's all. */
1163         sym->current++;
1164         sym->result = get_template_name(sym);
1165         ret = TRUE;
1166         goto done;
1167     }
1168
1169     /* Either a class name, or '@' if the symbol is not a class member */
1170     if (*sym->current != '@')
1171     {
1172         /* Class the function is associated with, terminated by '@@' */
1173         if (!get_class(sym)) goto done;
1174     }
1175     else sym->current++;
1176
1177     switch (do_after)
1178     {
1179     case 0: default: break;
1180     case 1: case 2:
1181         /* it's time to set the member name for ctor & dtor */
1182         if (sym->stack.num <= 1) goto done;
1183         if (do_after == 1)
1184             sym->stack.elts[0] = sym->stack.elts[1];
1185         else
1186             sym->stack.elts[0] = str_printf(sym, "~%s", sym->stack.elts[1]);
1187         /* ctors and dtors don't have return type */
1188         sym->flags |= UNDNAME_NO_FUNCTION_RETURNS;
1189         break;
1190     case 3:
1191         sym->flags &= ~UNDNAME_NO_FUNCTION_RETURNS;
1192         break;
1193     }
1194
1195     /* Function/Data type and access level */
1196     if (*sym->current >= '0' && *sym->current <= '7')
1197         ret = handle_data(sym);
1198     else if (*sym->current >= 'A' && *sym->current <= 'Z')
1199         ret = handle_method(sym, do_after == 3);
1200     else ret = FALSE;
1201 done:
1202     if (ret) assert(sym->result);
1203     else WARN("Failed at %s\n", sym->current);
1204
1205     return ret;
1206 }
1207
1208 /*********************************************************************
1209  *              __unDNameEx (MSVCRT.@)
1210  *
1211  * Demangle a C++ identifier.
1212  *
1213  * PARAMS
1214  *  buffer   [O] If not NULL, the place to put the demangled string
1215  *  mangled  [I] Mangled name of the function
1216  *  buflen   [I] Length of buffer
1217  *  memget   [I] Function to allocate memory with
1218  *  memfree  [I] Function to free memory with
1219  *  unknown  [?] Unknown, possibly a call back
1220  *  flags    [I] Flags determining demangled format
1221  *
1222  * RETURNS
1223  *  Success: A string pointing to the unmangled name, allocated with memget.
1224  *  Failure: NULL.
1225  */
1226 char* CDECL __unDNameEx(char* buffer, const char* mangled, int buflen,
1227                         malloc_func_t memget, free_func_t memfree,
1228                         void* unknown, unsigned short int flags)
1229 {
1230     struct parsed_symbol        sym;
1231     const char*                 result;
1232
1233     TRACE("(%p,%s,%d,%p,%p,%p,%x)\n",
1234           buffer, mangled, buflen, memget, memfree, unknown, flags);
1235
1236     /* The flags details is not documented by MS. However, it looks exactly
1237      * like the UNDNAME_ manifest constants from imagehlp.h and dbghelp.h
1238      * So, we copied those (on top of the file)
1239      */
1240     memset(&sym, 0, sizeof(struct parsed_symbol));
1241     if (flags & UNDNAME_NAME_ONLY)
1242         flags |= UNDNAME_NO_FUNCTION_RETURNS | UNDNAME_NO_ACCESS_SPECIFIERS |
1243             UNDNAME_NO_MEMBER_TYPE | UNDNAME_NO_ALLOCATION_LANGUAGE |
1244             UNDNAME_NO_COMPLEX_TYPE;
1245
1246     sym.flags         = flags;
1247     sym.mem_alloc_ptr = memget;
1248     sym.mem_free_ptr  = memfree;
1249     sym.current       = mangled;
1250
1251     result = symbol_demangle(&sym) ? sym.result : mangled;
1252     if (buffer && buflen)
1253     {
1254         lstrcpynA( buffer, result, buflen);
1255     }
1256     else
1257     {
1258         buffer = memget(strlen(result) + 1);
1259         if (buffer) strcpy(buffer, result);
1260     }
1261
1262     und_free_all(&sym);
1263
1264     return buffer;
1265 }
1266
1267
1268 /*********************************************************************
1269  *              __unDName (MSVCRT.@)
1270  */
1271 char* CDECL __unDName(char* buffer, const char* mangled, int buflen,
1272                       malloc_func_t memget, free_func_t memfree,
1273                       unsigned short int flags)
1274 {
1275     return __unDNameEx(buffer, mangled, buflen, memget, memfree, NULL, flags);
1276 }