-
Notifications
You must be signed in to change notification settings - Fork 298
Expand file tree
/
Copy pathdemangle_gnu3.cpp
More file actions
3391 lines (3157 loc) · 106 KB
/
Copy pathdemangle_gnu3.cpp
File metadata and controls
3391 lines (3157 loc) · 106 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright 2016-2026 Vector 35 Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// Includes snippets from LLVM, which is under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
#include "demangle_gnu3.h"
#include "demangler/demangled_log.h"
#include "demangler/demangled_template_simplifier.h"
#include <cstdarg>
#include <algorithm>
#include <memory>
#ifdef BINARYNINJACORE_LIBRARY
using namespace BinaryNinjaCore;
#else
using namespace BinaryNinja;
using namespace std;
#endif
namespace
{
BNTypeClass GetFinalizedTypeClass(const Ref<Type>& type)
{
#ifdef BINARYNINJACORE_LIBRARY
return type->GetTypeClass();
#else
return type->GetClass();
#endif
}
#define hash(x,y) (64 * (x) + (y))
#ifdef GNUDEMANGLE_DEBUG
void LogWithIndentation(const char* fmt, ...)
{
va_list args;
va_start(args, fmt);
_STD_STRING indentedFormat = DemangleLogIndentation::Apply(fmt);
PerformLog(0, DebugLog, "", 0, indentedFormat.c_str(), args);
va_end(args);
}
#define LOG_INDENTATION_SCOPE DemangleLogIndentationScope logIndentationScope
#else
#define LogWithIndentation(...) do {} while(0)
#define LOG_INDENTATION_SCOPE do {} while(0)
#endif
size_t TotalStringSize(const StringList& v)
{
size_t n = 0;
for (const auto& s : v)
n += s.size();
return n;
}
string JoinNameSegments(const StringList& name)
{
if (name.empty())
return {};
if (name.size() == 1)
return name[0];
string out;
out.reserve(TotalStringSize(name) + (name.size() - 1) * 2);
out += name[0];
for (size_t i = 1; i < name.size(); i++)
{
out += "::";
out += name[i];
}
return out;
}
bool TemplateArgsReferenceTemplateParam(std::string_view raw)
{
if (raw.empty() || (raw[0] != 'I' && raw[0] != 'J'))
return false;
size_t i = 0;
size_t depth = 0;
while (i < raw.size())
{
char c = raw[i++];
if (c == 'I' || c == 'J')
{
depth++;
continue;
}
if (c == 'E')
{
if (depth == 0)
return false;
depth--;
if (depth == 0)
return false;
continue;
}
if (c == 'T')
return true;
if (c >= '0' && c <= '9')
{
size_t len = c - '0';
while (i < raw.size() && raw[i] >= '0' && raw[i] <= '9')
len = (len * 10) + (raw[i++] - '0');
i = std::min(raw.size(), i + len);
}
}
return false;
}
DemangledNamePart NameSegmentWithTemplateArgs(std::string_view name, vector<DemangledTypeNode::Param> args)
{
return {string(name), std::move(args), true};
}
void AppendStructuredNameSegments(DemangledQualifiedName& name, const StringList& segments)
{
for (const auto& segment: segments)
name.emplace_back(segment);
}
void SetStructuredExpressionNode(DemangledTypeNode* outNode, const DemangledQualifiedName& name)
{
if (outNode && !name.empty())
{
if (name.size() > 1 && !name.back().HasTemplateArguments())
{
DemangledQualifiedName baseName(name.begin(), name.end() - 1);
DemangledTypeNode baseType = DemangledTypeNode::NamedType(std::move(baseName));
*outNode = DemangledTypeNode::PostfixType(
DemangledTypeNode::CreateShared(std::move(baseType)), "::" + name.back().GetString());
return;
}
*outNode = DemangledTypeNode::NamedType(name);
}
}
std::string_view GetOperator(char elm1, char elm2)
{
switch (hash(elm1, elm2))
{
case hash('d','c'): return "dynamic_cast";
case hash('s','c'): return "static_cast";
case hash('c','c'): return "const_cast";
case hash('r','c'): return "reinterpret_cast";
case hash('t','i'): [[fallthrough]];
case hash('t','e'): return "typeid";
case hash('s','t'): [[fallthrough]];
case hash('s','z'): return "sizeof";
case hash('a','t'): [[fallthrough]];
case hash('a','z'): return "alignof";
case hash('a','w'): return "co_await";
case hash('n','x'): return "noexcept";
case hash('s','Z'): [[fallthrough]];
case hash('s','P'): return "sizeof...";
case hash('s','p'): return "";
case hash('t','w'): [[fallthrough]];
case hash('t','r'): return "throw";
case hash('l','s'): return "<<"; // <<
case hash('r','s'): return ">>"; // >>
case hash('a','S'): return "="; // =
case hash('n','t'): return "!"; // !
case hash('e','q'): return "=="; // ==
case hash('n','e'): return "!="; // !=
case hash('i','x'): return "[]"; // []
case hash('d','t'): return "."; // .
case hash('p','t'): return "->"; // ->
case hash('m','l'): return "*"; // *
case hash('p','p'): return "++"; // ++ (postfix in <expression> context)
case hash('m','m'): return "--"; // -- (postfix in <expression> context)
case hash('n','g'): [[fallthrough]]; // - (unary)
case hash('m','i'): return "-"; // -
case hash('p','s'): [[fallthrough]]; // + (unary)
case hash('p','l'): return "+"; // +
case hash('a','d'): [[fallthrough]]; // & (unary)
case hash('a','n'): return "&"; // &
case hash('p','m'): return "->*"; // ->*
case hash('d','v'): return "/"; // /
case hash('r','m'): return "%"; // %
case hash('l','t'): return "<"; // <
case hash('l','e'): return "<="; // <=
case hash('g','t'): return ">"; // >
case hash('g','e'): return ">="; // >=
case hash('c','m'): return ","; // ,
case hash('c','l'): return "()"; // ()
case hash('c','o'): return "~"; // ~
case hash('e','o'): return "^"; // ^
case hash('o','r'): return "|"; // |
case hash('a','a'): return "&&"; // &&
case hash('o','o'): return "||"; // ||
case hash('d','e'): return "*"; // * (unary)
case hash('m','L'): return "*="; // *=
case hash('p','L'): return "+="; // +=
case hash('m','I'): return "-="; // -=
case hash('d','V'): return "/="; // /=
case hash('r','M'): return "%="; // %=
case hash('r','S'): return ">>="; // >>=
case hash('l','S'): return "<<="; // <<=
case hash('a','N'): return "&="; // &=
case hash('o','R'): return "|="; // |=
case hash('e','O'): return "^="; // ^=
case hash('s','s'): return "<=>"; // <=>
case hash('d','l'): return "delete"; // delete
case hash('d','a'): return "delete[]"; // delete[]
case hash('n','w'): return "new"; // new
case hash('n','a'): return "new[]"; // new []
default: return "";
}
}
BNNameType GetNameType(char elm1, char elm2)
{
switch (hash(elm1, elm2))
{
case hash('n','t'): return OperatorNotNameType; // !
case hash('n','g'): return OperatorMinusNameType; // - (unary)
case hash('p','s'): return OperatorPlusNameType; // + (unary)
case hash('a','d'): return OperatorBitAndNameType; // & (unary)
case hash('d','e'): return OperatorStarNameType; // * (unary)
case hash('i','x'): return OperatorArrayNameType; // []
case hash('p','p'): return OperatorIncrementNameType; // ++ (postfix in <expression> context)
case hash('m','m'): return OperatorDecrementNameType; // -- (postfix in <expression> context)
case hash('l','s'): return OperatorLeftShiftNameType; // <<
case hash('r','s'): return OperatorRightShiftNameType; // >>
case hash('a','S'): return OperatorAssignNameType; // =
case hash('e','q'): return OperatorEqualNameType; // ==
case hash('n','e'): return OperatorNotEqualNameType; // !=
case hash('p','t'): return OperatorArrowNameType; // ->
case hash('m','l'): return OperatorStarNameType; // *
case hash('m','i'): return OperatorMinusNameType; // -
case hash('p','l'): return OperatorPlusNameType; // +
case hash('a','n'): return OperatorBitAndNameType; // &
case hash('p','m'): return OperatorArrowStarNameType; // ->*
case hash('d','v'): return OperatorDivideNameType; // /
case hash('r','m'): return OperatorModulusNameType; // %
case hash('l','t'): return OperatorLessThanNameType; // <
case hash('l','e'): return OperatorLessThanEqualNameType; // <=
case hash('g','t'): return OperatorGreaterThanNameType; // >
case hash('g','e'): return OperatorGreaterThanEqualNameType; // >=
case hash('c','m'): return OperatorCommaNameType; // ,
case hash('c','l'): return OperatorParenthesesNameType; // ()
case hash('c','o'): return OperatorTildeNameType; // ~
case hash('e','o'): return OperatorXorNameType; // ^
case hash('o','r'): return OperatorBitOrNameType; // |
case hash('a','a'): return OperatorLogicalAndNameType; // &&
case hash('o','o'): return OperatorLogicalOrNameType; // ||
case hash('m','L'): return OperatorStarEqualNameType; // *=
case hash('p','L'): return OperatorPlusEqualNameType; // +=
case hash('m','I'): return OperatorMinusEqualNameType; // -=
case hash('d','V'): return OperatorDivideEqualNameType; // /=
case hash('r','M'): return OperatorModulusEqualNameType; // %=
case hash('r','S'): return OperatorRightShiftEqualNameType; // >>=
case hash('l','S'): return OperatorLeftShiftEqualNameType; // <<=
case hash('a','N'): return OperatorAndEqualNameType; // &=
case hash('o','R'): return OperatorOrEqualNameType; // |=
case hash('e','O'): return OperatorXorEqualNameType; // ^=
case hash('d','l'): return OperatorDeleteNameType; // delete
case hash('d','a'): return OperatorDeleteArrayNameType; // delete[]
case hash('n','w'): return OperatorNewNameType; // new
case hash('n','a'): return OperatorNewArrayNameType; // new []
// Note: C1-C5 (constructor) and D0-D5 (destructor) are handled directly
// by DemangleUnqualifiedName with their own case blocks, so they never
// reach GetNameType.
default:
return NoNameType;
}
}
bool IsStaticOnlyMemberFunction(BNNameType nameType)
{
return nameType == OperatorNewNameType || nameType == OperatorNewArrayNameType ||
nameType == OperatorDeleteNameType || nameType == OperatorDeleteArrayNameType;
}
bool IsDirectAnonymousNamespaceFunction(const DemangledQualifiedName& name)
{
return name.size() == 2 && name.front().GetBase() == "(anonymous namespace)";
}
// Decode a big-endian hex string into a float or double.
// Returns the decimal string representation, or the raw hex with a type
// prefix if decoding fails or the result is NaN/Inf.
string DecodeHexFloat(std::string_view hex, size_t byteCount)
{
if (hex.size() != byteCount * 2)
return string(hex);
// Parse big-endian hex into an integer, then reinterpret as float/double
uint64_t bits = 0;
for (size_t i = 0; i < hex.size(); i++)
{
char c = hex[i];
uint64_t nibble;
if (c >= '0' && c <= '9') nibble = c - '0';
else if (c >= 'a' && c <= 'f') nibble = c - 'a' + 10;
else if (c >= 'A' && c <= 'F') nibble = c - 'A' + 10;
else return string(hex);
bits = (bits << 4) | nibble;
}
if (byteCount == 4)
{
union { uint32_t i; float f; } u;
u.i = static_cast<uint32_t>(bits);
if (std::isnan(u.f) || std::isinf(u.f))
{
string out = "(float)";
out.append(hex);
return out;
}
return to_string(u.f);
}
else if (byteCount == 8)
{
union { uint64_t i; double d; } u;
u.i = bits;
if (std::isnan(u.d) || std::isinf(u.d))
{
string out = "(double)";
out.append(hex);
return out;
}
return to_string(u.d);
}
return string(hex);
}
void ExtendTypeName(DemangledTypeNode& type, std::string_view extend)
{
if (type.GetClass() != NamedTypeReferenceClass)
return;
DemangledQualifiedName name = type.GetName();
if (name.empty())
{
name.emplace_back(extend);
type.SetName(std::move(name));
return;
}
name.back().AppendBase(extend);
type.SetName(std::move(name));
}
void ApplyTemplateArgs(DemangledTypeNode& type, DemangleGNU3::ParamList args)
{
if (type.GetClass() != NamedTypeReferenceClass)
return;
DemangledQualifiedName qn = type.GetName();
if (qn.empty())
qn.emplace_back("");
qn.back().SetTemplateArguments(std::move(args), true);
type.SetName(std::move(qn));
}
void AppendTypeName(DemangledTypeNode& type, const DemangledTypeNode& extend)
{
if (type.GetClass() != NamedTypeReferenceClass)
return;
DemangledQualifiedName newName = type.GetName();
DemangledQualifiedName extendName = extend.GetName();
newName.reserve(newName.size() + extendName.size());
newName.insert(newName.end(), extendName.begin(), extendName.end());
type.SetName(std::move(newName));
}
std::string_view LastTypeNameSegmentBase(const DemangledTypeNode& type)
{
const auto& qn = type.GetName();
if (!qn.empty())
return qn.back().GetBase();
return {};
}
bool LastTypeNameSegmentHasTemplateArguments(const DemangledTypeNode& type)
{
const auto& qn = type.GetName();
if (qn.empty())
return false;
return qn.back().HasTemplateArguments();
}
}
// ===== DemangleGNU3 implementation =====
DemangleGNU3::DemangleGNU3(Platform& platform, string mangledName) :
m_mangledName(std::move(mangledName)),
m_reader(m_mangledName, MAX_DEMANGLE_NODE_LENGTH, false),
m_platform(platform),
m_lastTypeRef(nullptr),
m_isParameter(false),
m_topLevel(true),
m_isOperatorOverload(false),
m_parsingLambdaParams(false),
m_lambdaTemplateParamBase(0),
m_permitForwardTemplateRefs(false),
m_inLocalName(false),
m_nestingDepth(0)
{
LogWithIndentation("%s : %s\n", __FUNCTION__, m_reader.GetRaw());
}
void DemangleGNU3::Reset(Platform& platform, string mangledName)
{
m_mangledName = std::move(mangledName);
m_reader.Reset(m_mangledName);
m_platform = std::ref(platform);
m_substitute.clear();
m_templateSubstitute.clear();
m_functionSubstitute.clear();
m_lastTypeRef = nullptr;
m_lastName.clear();
m_isParameter = false;
m_topLevel = true;
m_isOperatorOverload = false;
m_parsingLambdaParams = false;
m_lambdaTemplateParamBase = 0;
m_permitForwardTemplateRefs = false;
m_pendingForwardRefs.clear();
m_inLocalName = false;
m_nestingDepth = 0;
}
void DemangleGNU3::PushEmptyTemplateParamSubstitution()
{
m_templateSubstitute.emplace_back(NodeRef::TemplateParamPack({}));
}
#ifdef GNUDEMANGLE_DEBUG
const DemangledTypeNode& DemangleGNU3::GetTemplateType(size_t ref)
{
if (ref >= m_templateSubstitute.size())
throw DemangleException();
if (m_templateSubstitute[ref].emptyTemplatePack || !m_templateSubstitute[ref])
throw DemangleException();
return *m_templateSubstitute[ref];
}
#endif
DemangleGNU3::NodeRef DemangleGNU3::PushType(const DemangledTypeNode& type)
{
auto ref = DemangledTypeNode::CreateSharedCopy(type);
m_substitute.emplace_back(ref);
return ref;
}
DemangleGNU3::NodeRef DemangleGNU3::PushType(DemangledTypeNode&& type)
{
auto ref = DemangledTypeNode::CreateShared(std::move(type));
m_substitute.emplace_back(ref);
return ref;
}
DemangleGNU3::NodeRef DemangleGNU3::GetTypeRef(size_t ref)
{
if (ref >= m_substitute.size())
throw DemangleException();
if (m_substitute[ref].emptyTemplatePack || !m_substitute[ref])
throw DemangleException();
return m_substitute[ref];
}
const DemangledTypeNode& DemangleGNU3::GetType(size_t ref)
{
return *GetTypeRef(ref);
}
#ifdef GNUDEMANGLE_DEBUG
void DemangleGNU3::PrintTables()
{
LogDebug("Substitution Table\n");
for (int i = 0; (size_t)i < m_substitute.size(); i++)
{
if (m_substitute[i].emptyTemplatePack)
LogDebug("[%d] <empty template pack>\n", i - 1);
else
LogDebug("[%d] %s\n", i - 1, GetType(i).GetString().c_str());
}
LogDebug("Template Table\n");
for (int i = 0; (size_t)i < m_templateSubstitute.size(); i++)
{
if (m_templateSubstitute[i].emptyTemplatePack)
LogDebug("[%d] <empty template pack>\n", i - 1);
else
LogDebug("[%d] %s\n", i - 1, GetTemplateType(i).GetString().c_str());
}
}
#endif
void DemangleGNU3::DemangleCVQualifiers(bool& cnst, bool& vltl, bool& rstrct)
{
cnst = false; vltl = false; rstrct = false;
//[<cv-qualifier>]
while (true)
{
if (m_reader.ConsumeIf('r'))
rstrct = true;
else if (m_reader.ConsumeIf('V'))
vltl = true;
else if (m_reader.ConsumeIf('K'))
cnst = true;
else
return;
}
}
std::string_view DemangleGNU3::DemangleSourceName()
{
LOG_INDENTATION_SCOPE;
LogWithIndentation("%s : %s\n", __FUNCTION__, m_reader.GetRaw());
std::string_view name = m_reader.ReadStringView(DemangleNumber());
m_lastName = name;
return name;
}
DemangledTypeNode DemangleGNU3::DemangleFunction(bool cnst, bool vltl)
{
NestingGuard nestingGuard(m_nestingDepth);
LOG_INDENTATION_SCOPE;
LogWithIndentation("%s : %s\n", __FUNCTION__, m_reader.GetRaw());
bool old_isparam;
if (m_reader.ConsumeIf('Y'))
{
// TODO: This function is external, should we do anything with that info?
}
DemangledTypeNode retType = DemangleType();
NodeRef retTypeRef = m_lastTypeRef;
ParamList params;
old_isparam = m_isParameter;
m_isParameter = true;
m_functionSubstitute.emplace_back();
[[maybe_unused]] int i = 0;
while (!m_reader.ConsumeIf('E'))
{
DemangledTypeNode param = DemangleType();
NodeRef paramRef = m_lastTypeRef;
if (AppendTemplateParamPackExpansion(params, paramRef, true))
continue;
if (param.GetClass() == VoidTypeClass)
continue;
LogWithIndentation("Var_%d - %s\n", i++, param.GetString().c_str());
if (!paramRef)
paramRef = DemangledTypeNode::CreateShared(std::move(param));
m_functionSubstitute.back().emplace_back(paramRef);
params.push_back({"", paramRef});
}
m_functionSubstitute.pop_back();
m_isParameter = old_isparam;
if (!retTypeRef)
retTypeRef = DemangledTypeNode::CreateShared(std::move(retType));
DemangledTypeNode newType = DemangledTypeNode::FunctionType(retTypeRef, nullptr, std::move(params));
PushType(newType);
newType.SetConst(cnst);
newType.SetVolatile(vltl);
if (cnst || vltl)
PushType(newType);
LogWithIndentation("After %s : %s\n", __FUNCTION__, m_reader.GetRaw());
return newType;
}
void DemangleGNU3::ResolveForwardTemplateRefs(DemangledTypeNode&, const ParamList& args)
{
if (m_pendingForwardRefs.empty())
return;
for (const auto& ref : m_pendingForwardRefs)
{
if (!ref.typeRef)
continue;
if (ref.index >= args.size() || !args[ref.index].type)
throw DemangleException();
if (args[ref.index].type->ContainsNodeRef(ref.typeRef))
{
LogWarnF("Rejecting GNU3 demangle: recursive forward template reference T{}_", ref.index);
throw DemangleException("Detected recursive forward template reference");
}
*ref.typeRef = *args[ref.index].type;
}
m_pendingForwardRefs.clear();
}
DemangleGNU3::NodeRef DemangleGNU3::DemangleTemplateSubstitutionEntry(NodeRef* outTypeRef)
{
LOG_INDENTATION_SCOPE;
LogWithIndentation("%s : %s\n", __FUNCTION__, m_reader.GetRaw());
if (outTypeRef)
*outTypeRef = nullptr;
size_t number = 0;
char elm = m_reader.PeekOr();
if (elm == '_')
{
number = 0;
}
else if (isdigit(elm))
{
size_t n = 0;
while (isdigit(m_reader.PeekOr()))
n = n * 10 + (m_reader.Read() - '0');
number = n + 1;
}
else if (isupper(elm))
{
m_reader.Consume();
number = elm - 'A' + 11;
}
else
{
throw DemangleException();
}
if (!m_reader.ConsumeIf('_'))
{
throw DemangleException();
}
if (number < m_templateSubstitute.size())
{
const auto& entry = m_templateSubstitute[number];
if (entry.emptyTemplatePack)
return entry;
if (!entry)
throw DemangleException();
if (outTypeRef)
*outTypeRef = entry;
return entry;
}
// If forward template references are permitted (e.g. inside a cv conversion
// operator type), return a shared placeholder node whose contents will be
// replaced once the outer template args are known.
if (m_permitForwardTemplateRefs)
{
auto typeRef = DemangledTypeNode::CreateShared(DemangledTypeNode::NamedType("auto"));
m_pendingForwardRefs.push_back({number, typeRef});
if (outTypeRef)
*outTypeRef = typeRef;
return typeRef;
}
if (m_parsingLambdaParams && number >= m_lambdaTemplateParamBase)
{
auto typeRef = DemangledTypeNode::CreateShared(DemangledTypeNode::NamedType("auto"));
if (outTypeRef)
*outTypeRef = typeRef;
return typeRef;
}
throw DemangleException();
}
DemangledTypeNode DemangleGNU3::DemangleTemplateSubstitution(NodeRef* outTypeRef)
{
NodeRef entry = DemangleTemplateSubstitutionEntry(outTypeRef);
if (entry.IsTemplateParamPack())
{
if (outTypeRef)
*outTypeRef = entry;
if (entry.emptyTemplatePack)
return DemangledTypeNode::VoidType();
return *entry;
}
if (entry.emptyTemplatePack || !entry)
throw DemangleException();
return *entry;
}
DemangledTypeNode DemangleGNU3::DemangleType()
{
NestingGuard nestingGuard(m_nestingDepth);
LOG_INDENTATION_SCOPE;
LogWithIndentation("%s : %s\n", __FUNCTION__, m_reader.GetRaw());
m_lastTypeRef = nullptr;
DemangledTypeNode type;
NodeRef typeRef = nullptr;
bool cnst = false, vltl = false, rstrct = false;
bool substitute = false;
DemangleCVQualifiers(cnst, vltl, rstrct);
if (cnst || vltl || rstrct)
{
type = DemangleType();
if (cnst)
type.SetConst(true);
if (vltl)
type.SetVolatile(true);
if (rstrct)
type.SetPointerSuffixBits(1u << RestrictSuffix);
typeRef = PushType(type);
m_lastTypeRef = typeRef;
return type;
}
switch(m_reader.Read())
{
case 'S':
{
char next = m_reader.PeekOr();
if (isdigit(next) || next == '_' || isupper(next))
{
type = DemangleSubstitution(&typeRef);
if (m_reader.ConsumeIf('I'))
{
ParamList args;
DemangleTemplateArgs(args);
ApplyTemplateArgs(type, std::move(args));
typeRef = nullptr;
substitute = true;
}
}
else
{
if (m_reader.ConsumeIf('t'))
{
type = DemangleUnqualifiedName();
DemangledQualifiedName qn = type.GetName();
qn.insert(qn.begin(), DemangledNamePart("std"));
type.SetName(std::move(qn));
substitute = true;
}
else
{
type = DemangleSubstitution(&typeRef);
}
if (m_reader.ConsumeIf('I'))
{
bool dependentTemplatePrefix = LastTypeNameSegmentBase(type) == "basic_ostream" &&
TemplateArgsReferenceTemplateParam("I" + m_reader.PeekString(m_reader.Length()));
if (substitute && !dependentTemplatePrefix)
PushType(type);
ParamList args;
DemangleTemplateArgs(args);
ApplyTemplateArgs(type, std::move(args));
typeRef = nullptr;
substitute = true;
}
}
break;
}
case 'T':
{
/* <class-enum-type> ::= <name> # non-dependent type name, dependent type name, or dependent typename-specifier
::= Ts <name> # dependent elaborated type specifier using 'struct' or 'class'
::= Tu <name> # dependent elaborated type specifier using 'union'
::= Te <name> # dependent elaborated type specifier using 'enum'
*/
if (m_reader.ConsumeIf('s'))
{
type = DemangledTypeNode::NamedType(StructNamedTypeClass, DemangleSourceName());
break;
}
else if (m_reader.ConsumeIf('u'))
{
type = DemangledTypeNode::NamedType(UnionNamedTypeClass, DemangleSourceName());
break;
}
else if (m_reader.ConsumeIf('e'))
{
type = DemangledTypeNode::NamedType(
EnumNamedTypeClass, DemangleSourceName(), m_platform.get().GetArchitecture()->GetDefaultIntegerSize());
break;
}
//Template Substitution
type = DemangleTemplateSubstitution(&typeRef);
// In forward-ref mode (cv conversion operator type parsing), do not consume
// trailing I<args>E — it belongs to the enclosing nested-name and will be
// processed by DemangleNestedName's 'I' case, which resolves forward refs.
substitute = !m_permitForwardTemplateRefs && !typeRef.IsTemplateParamPack();
if (!m_permitForwardTemplateRefs && m_reader.ConsumeIf('I'))
{
if (substitute)
PushType(type);
ParamList args;
DemangleTemplateArgs(args);
ApplyTemplateArgs(type, std::move(args));
typeRef = nullptr;
}
break;
}
case 'P':
{
NodeRef childRef = nullptr;
DemangledTypeNode child = DemangleType();
childRef = m_lastTypeRef;
type = childRef ? DemangledTypeNode::PointerType(childRef, cnst, vltl, PointerReferenceType) :
DemangledTypeNode::PointerType(std::move(child), cnst, vltl, PointerReferenceType);
substitute = true;
break;
}
case 'R':
{
NodeRef childRef = nullptr;
DemangledTypeNode child = DemangleType();
childRef = m_lastTypeRef;
type = childRef ? DemangledTypeNode::PointerType(childRef, cnst, vltl, ReferenceReferenceType) :
DemangledTypeNode::PointerType(std::move(child), cnst, vltl, ReferenceReferenceType);
substitute = true;
break;
}
case 'O':
{
NodeRef childRef = nullptr;
DemangledTypeNode child = DemangleType();
childRef = m_lastTypeRef;
type = childRef ? DemangledTypeNode::PointerType(childRef, cnst, vltl, RValueReferenceType) :
DemangledTypeNode::PointerType(std::move(child), cnst, vltl, RValueReferenceType);
substitute = true;
break;
}
case 'C': //TODO:complex
case 'G': //TODO:imaginary
throw DemangleException();
case 'U':
{
// Vendor-extended type: U <source-name> [<template-args>] <type>
// Commonly used for Objective-C block pointers:
// U13block_pointer <function-type> -> "void (params...) block_pointer"
DemangledNamePart extName(DemangleSourceName());
if (m_reader.ConsumeIf('I'))
{
ParamList targs;
DemangleTemplateArgs(targs);
if (!targs.empty())
extName.SetTemplateArguments(std::move(targs), true);
}
DemangledTypeNode inner = DemangleType();
NodeRef innerRef = m_lastTypeRef ? m_lastTypeRef : NodeRef(DemangledTypeNode::CreateShared(std::move(inner)));
auto extType = DemangledTypeNode::NamedType(DemangledQualifiedName{std::move(extName)});
NodeRef extNameRef = DemangledTypeNode::CreateShared(std::move(extType));
type = DemangledTypeNode::PostfixType(innerRef, " ", extNameRef);
substitute = true;
break;
}
case 'u':
{
// Vendor extended type: u <source-name> [<template-args>]
// e.g. u14__remove_cvref, u20__remove_reference_t
DemangledNamePart extName(DemangleSourceName());
if (m_reader.ConsumeIf('I'))
{
ParamList targs;
DemangleTemplateArgs(targs);
if (!targs.empty())
extName.SetTemplateArguments(std::move(targs), true);
}
type = DemangledTypeNode::NamedType(DemangledQualifiedName{std::move(extName)});
substitute = true;
break;
}
case 'v': type = DemangledTypeNode::VoidType(); break;
case 'w': type = DemangledTypeNode::WideCharType(4, "wchar_t"); break; //TODO: verify
case 'b': type = DemangledTypeNode::BoolType(); break;
case 'c': type = DemangledTypeNode::IntegerType(1, true); break;
case 'a': type = DemangledTypeNode::IntegerType(1, true, "signed char"); break;
case 'h': type = DemangledTypeNode::IntegerType(1, false); break;
case 's': type = DemangledTypeNode::IntegerType(2, true); break;
case 't': type = DemangledTypeNode::IntegerType(2, false); break;
case 'i': type = DemangledTypeNode::IntegerType(4, true); break;
case 'j': type = DemangledTypeNode::IntegerType(4, false); break;
case 'l': type = DemangledTypeNode::AddressSizedIntegerType(true); break; //long
case 'm': type = DemangledTypeNode::AddressSizedIntegerType(false); break; //ulong
case 'x': type = DemangledTypeNode::IntegerType(8, true); break;
case 'y': type = DemangledTypeNode::IntegerType(8, false); break;
case 'n': type = DemangledTypeNode::IntegerType(16, true); break;
case 'o': type = DemangledTypeNode::IntegerType(16, false); break;
case 'f': type = DemangledTypeNode::FloatType(4); break;
case 'd': type = DemangledTypeNode::FloatType(8); break;
case 'e': type = DemangledTypeNode::FloatType(10); break;
case 'g': type = DemangledTypeNode::FloatType(16); break;
case 'z': type = DemangledTypeNode::VarArgsType(); break;
case 'M': // TODO: Make into pointer to function member
{
DemangledTypeNode memberName = DemangleType();
NodeRef memberNameRef = m_lastTypeRef ? m_lastTypeRef : NodeRef(DemangledTypeNode::CreateShared(std::move(memberName)));
DemangledTypeNode member = DemangleType();
NodeRef memberRef = m_lastTypeRef ? m_lastTypeRef : NodeRef(DemangledTypeNode::CreateShared(std::move(member)));
type = DemangledTypeNode::MemberPointerType(memberRef, memberNameRef->GetName(), cnst, vltl);
type.SetParenthesizedMemberPointer(true);
substitute = true;
break;
}
case 'F': type = DemangleFunction(cnst, vltl); break;
case 'D':
switch (m_reader.Read())
{
case 'd': type = DemangledTypeNode::FloatType(8, "decimal64"); break;
case 'e': type = DemangledTypeNode::FloatType(16, "decimal128"); break;
case 'f': type = DemangledTypeNode::FloatType(4, "decimal32"); break;
case 'h': type = DemangledTypeNode::FloatType(2); break;
case 'u': type = DemangledTypeNode::IntegerType(1, false, "char8_t"); break;
case 'i': type = DemangledTypeNode::WideCharType(4, "char32_t"); break;
case 's': type = DemangledTypeNode::WideCharType(2, "char16_t"); break;
case 'a': type = DemangledTypeNode::NamedType("auto"); break; //auto type
case 'c': type = DemangledTypeNode::NamedType("decltype(auto)"); break; //decltype(auto)
case 'n':
{
static const StringList stdNullptrTName(vector<string>{"std", "nullptr_t"});
type = DemangledTypeNode::NamedType(stdNullptrTName);
break;
}
case 'p':
{
DemangledTypeNode inner = DemangleType();
NodeRef innerRef = (m_lastTypeRef || m_lastTypeRef.IsTemplateParamPack()) ?
m_lastTypeRef : NodeRef(DemangledTypeNode::CreateShared(std::move(inner)));
if (innerRef.IsTemplateParamPack())
{
typeRef = NodeRef::TemplateParamPackExpansion(*innerRef.templatePack);
type = typeRef ? *typeRef : DemangledTypeNode::VoidType();
break;
}
type = DemangledTypeNode::PostfixType(innerRef, "...");
break;
}
case 't':
case 'T':
type = DemangledTypeNode::NamedType("decltype(" + DemangleExpression() + ")");
if (!m_reader.ConsumeIf('E'))
throw DemangleException();
break;
case 'v':
{
// vector of size
uint64_t size = DemangleNumber();
if (!m_reader.ConsumeIf('_'))
throw DemangleException();
NodeRef childRef = nullptr;
DemangledTypeNode child = DemangleType();
childRef = m_lastTypeRef;
type = childRef ? DemangledTypeNode::ArrayType(childRef, size) :
DemangledTypeNode::ArrayType(std::move(child), size);
break;
}
default:
LogWithIndentation("Unsupported type: %s:'%s'\n", __FUNCTION__, m_reader.GetRaw());
throw DemangleException();
}
break;
case 'N':
type = DemangleNestedName(nullptr, false);
substitute = true;
break;
case 'A':
// <array-type> ::= A <positive dimension number> _ <element type>
// ::= A [<dimension expression>] _ <element type>
if (isdigit(m_reader.PeekOr()))
{
//<positive dimension number> _ <element type>
uint64_t size = DemangleNumber();