-
-
Notifications
You must be signed in to change notification settings - Fork 65
/
CppModelBuilder.cs
2550 lines (2223 loc) · 105 KB
/
CppModelBuilder.cs
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 (c) Alexandre Mutel. All rights reserved.
// Licensed under the BSD-Clause 2 license.
// See license.txt file in the project root for full license information.
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Text;
using ClangSharp.Interop;
namespace CppAst
{
/// <summary>
/// Internal class used to build the entire C++ model from the libclang representation.
/// </summary>
internal unsafe class CppModelBuilder
{
private readonly CppContainerContext _rootContainerContext;
private readonly Dictionary<string, CppContainerContext> _containers;
private readonly Dictionary<string, CppType> _typedefs;
public CppModelBuilder()
{
_containers = new Dictionary<string, CppContainerContext>();
RootCompilation = new CppCompilation();
_typedefs = new Dictionary<string, CppType>();
_rootContainerContext = new CppContainerContext(RootCompilation);
}
public bool AutoSquashTypedef { get; set; }
public bool ParseSystemIncludes { get; set; }
public bool ParseAttributeEnabled { get; set; }
public CppCompilation RootCompilation { get; }
public CXChildVisitResult VisitTranslationUnit(CXCursor cursor, CXCursor parent, void* data)
{
_rootContainerContext.Container = RootCompilation;
if (cursor.Location.IsInSystemHeader)
{
if (!ParseSystemIncludes) return CXChildVisitResult.CXChildVisit_Continue;
_rootContainerContext.Container = RootCompilation.System;
}
return VisitMember(cursor, parent, data);
}
private CppContainerContext GetOrCreateDeclarationContainer(CXCursor cursor, void* data)
{
var typeAsCString = clang.getCursorUSR(cursor).CString.ToString();
if (string.IsNullOrEmpty(typeAsCString))
{
typeAsCString = clang.getCursorDisplayName(cursor).ToString();
}
// Try to workaround anonymous types
var typeKey = $"{cursor.Kind}:{typeAsCString}{(cursor.IsAnonymous ? "/" + cursor.Hash : string.Empty)}";
if (_containers.TryGetValue(typeKey, out var containerContext))
{
return containerContext;
}
ICppContainer symbol = null;
ICppContainer parent = null;
if (cursor.Kind != CXCursorKind.CXCursor_TranslationUnit && cursor.Kind != CXCursorKind.CXCursor_UnexposedDecl)
{
parent = GetOrCreateDeclarationContainer(cursor.SemanticParent, data).Container;
}
ICppDeclarationContainer parentDeclarationContainer = (ICppDeclarationContainer)parent;
var parentGlobalDeclarationContainer = parent as ICppGlobalDeclarationContainer;
var defaultContainerVisibility = CppVisibility.Default;
switch (cursor.Kind)
{
case CXCursorKind.CXCursor_Namespace:
Debug.Assert(parentGlobalDeclarationContainer != null);
var ns = new CppNamespace(GetCursorSpelling(cursor));
symbol = ns;
defaultContainerVisibility = CppVisibility.Default;
parentGlobalDeclarationContainer.Namespaces.Add(ns);
break;
case CXCursorKind.CXCursor_EnumDecl:
Debug.Assert(parent != null);
var cppEnum = new CppEnum(GetCursorSpelling(cursor))
{
IsAnonymous = cursor.IsAnonymous
};
parentDeclarationContainer.Enums.Add(cppEnum);
symbol = cppEnum;
break;
case CXCursorKind.CXCursor_ClassTemplate:
case CXCursorKind.CXCursor_ClassDecl:
case CXCursorKind.CXCursor_StructDecl:
case CXCursorKind.CXCursor_UnionDecl:
Debug.Assert(parent != null);
var cppClass = new CppClass(GetCursorSpelling(cursor));
parentDeclarationContainer.Classes.Add(cppClass);
symbol = cppClass;
cppClass.IsAnonymous = cursor.IsAnonymous;
switch (cursor.Kind)
{
case CXCursorKind.CXCursor_ClassDecl:
cppClass.ClassKind = CppClassKind.Class;
break;
case CXCursorKind.CXCursor_StructDecl:
cppClass.ClassKind = CppClassKind.Struct;
break;
case CXCursorKind.CXCursor_UnionDecl:
cppClass.ClassKind = CppClassKind.Union;
break;
}
if (cursor.Kind == CXCursorKind.CXCursor_ClassTemplate)
{
cursor.VisitChildren((childCursor, classCursor, clientData) =>
{
switch (childCursor.Kind)
{
case CXCursorKind.CXCursor_TemplateTypeParameter:
var parameterTypeName = new CppTemplateParameterType(GetCursorSpelling(childCursor));
cppClass.TemplateParameters.Add(parameterTypeName);
break;
}
return CXChildVisitResult.CXChildVisit_Continue;
}, new CXClientData((IntPtr)data));
}
else
{
var templateParameters = ParseTemplateArguments(cursor, cursor.Type, new CXClientData((IntPtr)data));
if (templateParameters != null)
{
cppClass.TemplateParameters.AddRange(templateParameters);
if (cursor.DeclKind == CX_DeclKind.CX_DeclKind_ClassTemplateSpecialization)
{
cppClass.SpecializedTemplate = (CppClass)GetOrCreateDeclarationContainer(cursor.SpecializedCursorTemplate, data).Container;
}
}
}
defaultContainerVisibility = cursor.Kind == CXCursorKind.CXCursor_ClassDecl ? CppVisibility.Private : CppVisibility.Public;
break;
case CXCursorKind.CXCursor_TranslationUnit:
case CXCursorKind.CXCursor_UnexposedDecl:
return _rootContainerContext;
default:
Unhandled(cursor);
break;
}
containerContext = new CppContainerContext(symbol) { CurrentVisibility = defaultContainerVisibility };
// The type could have been added separately as part of the GetCppType above TemplateParameters
if (!_containers.ContainsKey(typeKey))
{
_containers.Add(typeKey, containerContext);
}
return containerContext;
}
private TCppElement GetOrCreateDeclarationContainer<TCppElement>(CXCursor cursor, void* data, out CppContainerContext context) where TCppElement : CppElement, ICppContainer
{
context = GetOrCreateDeclarationContainer(cursor, data);
if (context.Container is TCppElement typedCppElement)
{
return typedCppElement;
}
throw new InvalidOperationException($"The element `{context.Container}` doesn't match the expected type `{typeof(TCppElement)}");
}
private CppNamespace VisitNamespace(CXCursor cursor, void* data)
{
// Create the container if not already created
var ns = GetOrCreateDeclarationContainer<CppNamespace>(cursor, data, out var context);
ns.Attributes.AddRange(ParseAttributes(cursor));
cursor.VisitChildren(VisitMember, new CXClientData((IntPtr)data));
return ns;
}
private CppClass VisitClassDecl(CXCursor cursor, void* data)
{
var cppStruct = GetOrCreateDeclarationContainer<CppClass>(cursor, data, out var context);
if (cursor.IsDefinition && !cppStruct.IsDefinition)
{
cppStruct.Attributes.AddRange(ParseAttributes(cursor));
cppStruct.IsDefinition = true;
cppStruct.SizeOf = (int)cursor.Type.SizeOf;
cppStruct.AlignOf = (int)cursor.Type.AlignOf;
context.IsChildrenVisited = true;
cursor.VisitChildren(VisitMember, new CXClientData((IntPtr)data));
}
return cppStruct;
}
private CXChildVisitResult VisitMember(CXCursor cursor, CXCursor parent, void* data)
{
CppElement element = null;
switch (cursor.Kind)
{
case CXCursorKind.CXCursor_FieldDecl:
case CXCursorKind.CXCursor_VarDecl:
{
var containerContext = GetOrCreateDeclarationContainer(parent, data);
element = VisitFieldOrVariable(containerContext, cursor, data);
break;
}
case CXCursorKind.CXCursor_EnumConstantDecl:
{
var containerContext = GetOrCreateDeclarationContainer(parent, data);
var cppEnum = (CppEnum)containerContext.Container;
var enumItem = new CppEnumItem(GetCursorSpelling(cursor), cursor.EnumConstantDeclValue);
VisitInitValue(cursor, data, out var enumItemExpression, out var enumValue);
enumItem.ValueExpression = enumItemExpression;
cppEnum.Items.Add(enumItem);
element = enumItem;
break;
}
case CXCursorKind.CXCursor_Namespace:
element = VisitNamespace(cursor, data);
break;
case CXCursorKind.CXCursor_ClassTemplate:
case CXCursorKind.CXCursor_ClassDecl:
case CXCursorKind.CXCursor_StructDecl:
case CXCursorKind.CXCursor_UnionDecl:
{
bool isAnonymous = cursor.IsAnonymous;
var cppClass = VisitClassDecl(cursor, data);
// Empty struct/class/union declaration are considered as fields
if (isAnonymous)
{
Debug.Assert(string.IsNullOrEmpty(cppClass.Name));
var containerContext = GetOrCreateDeclarationContainer(parent, data);
// We try to recover the offset from the previous field
// Might not be always correct (with alignment rules),
// but not sure how to recover the offset without recalculating the entire offsets
var offset = 0;
var cppClassContainer = containerContext.Container as CppClass;
if (cppClassContainer is object && cppClassContainer.Fields.Count > 0)
{
var lastField = cppClassContainer.Fields[cppClassContainer.Fields.Count - 1];
offset = (int)lastField.Offset + lastField.Type.SizeOf;
}
// Create an anonymous field for the type
var cppField = new CppField(cppClass, string.Empty)
{
Visibility = containerContext.CurrentVisibility,
StorageQualifier = GetStorageQualifier(cursor),
IsAnonymous = true,
Offset = offset,
Attributes = ParseAttributes(cursor)
};
containerContext.DeclarationContainer.Fields.Add(cppField);
element = cppField;
}
else
{
element = cppClass;
}
break;
}
case CXCursorKind.CXCursor_EnumDecl:
element = VisitEnumDecl(cursor, data);
break;
case CXCursorKind.CXCursor_TypedefDecl:
element = VisitTypeDefDecl(cursor, data);
break;
case CXCursorKind.CXCursor_TypeAliasDecl:
case CXCursorKind.CXCursor_TypeAliasTemplateDecl:
element = VisitTypeAliasDecl(cursor, data);
break;
case CXCursorKind.CXCursor_FunctionTemplate:
case CXCursorKind.CXCursor_FunctionDecl:
case CXCursorKind.CXCursor_Constructor:
case CXCursorKind.CXCursor_CXXMethod:
element = VisitFunctionDecl(cursor, parent, data);
break;
case CXCursorKind.CXCursor_UsingDirective:
// We don't visit directive
break;
case CXCursorKind.CXCursor_UnexposedDecl:
return CXChildVisitResult.CXChildVisit_Recurse;
case CXCursorKind.CXCursor_CXXBaseSpecifier:
{
var cppClass = (CppClass)GetOrCreateDeclarationContainer(parent, data).Container;
var baseType = GetCppType(cursor.Type.Declaration, cursor.Type, cursor, data);
var cppBaseType = new CppBaseType(baseType)
{
Visibility = GetVisibility(cursor.CXXAccessSpecifier),
IsVirtual = cursor.IsVirtualBase
};
cppClass.BaseTypes.Add(cppBaseType);
break;
}
case CXCursorKind.CXCursor_CXXAccessSpecifier:
{
var containerContext = GetOrCreateDeclarationContainer(parent, data);
containerContext.CurrentVisibility = GetVisibility(cursor.CXXAccessSpecifier);
}
break;
case CXCursorKind.CXCursor_MacroDefinition:
element = ParseMacro(cursor);
break;
case CXCursorKind.CXCursor_MacroExpansion:
break;
case CXCursorKind.CXCursor_VisibilityAttr:
{
var containerContext = GetOrCreateDeclarationContainer(parent, data).Container;
var cppClass = containerContext as CppClass;
if (cppClass != null)
{
CppAttribute attribute = new CppAttribute("visibility");
AssignSourceSpan(cursor, attribute);
attribute.Arguments = string.Format("\"{0}\"", cursor.DisplayName.ToString());
cppClass.Attributes.Add(attribute);
}
}
break;
case CXCursorKind.CXCursor_DLLImport:
{
var containerContext = GetOrCreateDeclarationContainer(parent, data).Container;
var cppClass = containerContext as CppClass;
if (cppClass != null)
{
CppAttribute attribute = new CppAttribute("dllimport");
AssignSourceSpan(cursor, attribute);
cppClass.Attributes.Add(attribute);
}
}
break;
case CXCursorKind.CXCursor_DLLExport:
{
var containerContext = GetOrCreateDeclarationContainer(parent, data).Container;
var cppClass = containerContext as CppClass;
if (cppClass != null)
{
CppAttribute attribute = new CppAttribute("dllexport");
AssignSourceSpan(cursor, attribute);
cppClass.Attributes.Add(attribute);
}
}
break;
case CXCursorKind.CXCursor_InclusionDirective:
// Don't emit warning for this directive
break;
case CXCursorKind.CXCursor_Destructor:
case CXCursorKind.CXCursor_TemplateTypeParameter:
// Don't emit warning
break;
default:
WarningUnhandled(cursor, parent);
break;
}
if (element != null)
{
AssignSourceSpan(cursor, element);
}
if (element is ICppDeclaration cppDeclaration)
{
cppDeclaration.Comment = GetComment(cursor);
}
return CXChildVisitResult.CXChildVisit_Continue;
}
private CppComment GetComment(CXCursor cursor)
{
var cxComment = cursor.ParsedComment;
return GetComment(cxComment);
}
private CppComment GetComment(CXComment cxComment)
{
var cppKind = GetCommentKind(cxComment.Kind);
CppComment cppComment = null;
bool removeTrailingEmptyText = false;
switch (cppKind)
{
case CppCommentKind.Null:
return null;
case CppCommentKind.Text:
cppComment = new CppCommentText()
{
Text = cxComment.TextComment_Text.ToString()?.TrimStart()
};
break;
case CppCommentKind.InlineCommand:
var inline = new CppCommentInlineCommand();
inline.CommandName = cxComment.InlineCommandComment_CommandName.ToString();
cppComment = inline;
switch (cxComment.InlineCommandComment_RenderKind)
{
case CXCommentInlineCommandRenderKind.CXCommentInlineCommandRenderKind_Normal:
inline.RenderKind = CppCommentInlineCommandRenderKind.Normal;
break;
case CXCommentInlineCommandRenderKind.CXCommentInlineCommandRenderKind_Bold:
inline.RenderKind = CppCommentInlineCommandRenderKind.Bold;
break;
case CXCommentInlineCommandRenderKind.CXCommentInlineCommandRenderKind_Monospaced:
inline.RenderKind = CppCommentInlineCommandRenderKind.Monospaced;
break;
case CXCommentInlineCommandRenderKind.CXCommentInlineCommandRenderKind_Emphasized:
inline.RenderKind = CppCommentInlineCommandRenderKind.Emphasized;
break;
}
for (uint i = 0; i < cxComment.InlineCommandComment_NumArgs; i++)
{
inline.Arguments.Add(cxComment.InlineCommandComment_GetArgText(i).ToString());
}
break;
case CppCommentKind.HtmlStartTag:
var htmlStartTag = new CppCommentHtmlStartTag();
htmlStartTag.TagName = cxComment.HtmlTagComment_TagName.ToString();
htmlStartTag.IsSelfClosing = cxComment.HtmlStartTagComment_IsSelfClosing;
for (uint i = 0; i < cxComment.HtmlStartTag_NumAttrs; i++)
{
htmlStartTag.Attributes.Add(new KeyValuePair<string, string>(
cxComment.HtmlStartTag_GetAttrName(i).ToString(),
cxComment.HtmlStartTag_GetAttrValue(i).ToString()
));
}
cppComment = htmlStartTag;
break;
case CppCommentKind.HtmlEndTag:
var htmlEndTag = new CppCommentHtmlEndTag();
htmlEndTag.TagName = cxComment.HtmlTagComment_TagName.ToString();
cppComment = htmlEndTag;
break;
case CppCommentKind.Paragraph:
cppComment = new CppCommentParagraph();
break;
case CppCommentKind.BlockCommand:
var blockComment = new CppCommentBlockCommand();
blockComment.CommandName = cxComment.BlockCommandComment_CommandName.ToString();
for (uint i = 0; i < cxComment.BlockCommandComment_NumArgs; i++)
{
blockComment.Arguments.Add(cxComment.BlockCommandComment_GetArgText(i).ToString());
}
removeTrailingEmptyText = true;
cppComment = blockComment;
break;
case CppCommentKind.ParamCommand:
var paramComment = new CppCommentParamCommand();
paramComment.CommandName = "param";
paramComment.ParamName = cxComment.ParamCommandComment_ParamName.ToString();
paramComment.IsDirectionExplicit = cxComment.ParamCommandComment_IsDirectionExplicit;
paramComment.IsParamIndexValid = cxComment.ParamCommandComment_IsParamIndexValid;
paramComment.ParamIndex = (int)cxComment.ParamCommandComment_ParamIndex;
switch (cxComment.ParamCommandComment_Direction)
{
case CXCommentParamPassDirection.CXCommentParamPassDirection_In:
paramComment.Direction = CppCommentParamDirection.In;
break;
case CXCommentParamPassDirection.CXCommentParamPassDirection_Out:
paramComment.Direction = CppCommentParamDirection.Out;
break;
case CXCommentParamPassDirection.CXCommentParamPassDirection_InOut:
paramComment.Direction = CppCommentParamDirection.InOut;
break;
}
removeTrailingEmptyText = true;
cppComment = paramComment;
break;
case CppCommentKind.TemplateParamCommand:
var tParamComment = new CppCommentTemplateParamCommand();
tParamComment.CommandName = "tparam";
tParamComment.ParamName = cxComment.TParamCommandComment_ParamName.ToString();
tParamComment.Depth = (int)cxComment.TParamCommandComment_Depth;
// TODO: index
tParamComment.IsPositionValid = cxComment.TParamCommandComment_IsParamPositionValid;
removeTrailingEmptyText = true;
cppComment = tParamComment;
break;
case CppCommentKind.VerbatimBlockCommand:
var verbatimBlock = new CppCommentVerbatimBlockCommand();
verbatimBlock.CommandName = cxComment.BlockCommandComment_CommandName.ToString();
for (uint i = 0; i < cxComment.BlockCommandComment_NumArgs; i++)
{
verbatimBlock.Arguments.Add(cxComment.BlockCommandComment_GetArgText(i).ToString());
}
cppComment = verbatimBlock;
break;
case CppCommentKind.VerbatimBlockLine:
var text = cxComment.VerbatimBlockLineComment_Text.ToString();
// For some reason, VerbatimBlockLineComment_Text can return the rest of the file instead of just the line
// So we explicitly trim the line here
var indexOfLine = text.IndexOf('\n');
if (indexOfLine >= 0)
{
text = text.Substring(0, indexOfLine);
}
cppComment = new CppCommentVerbatimBlockLine()
{
Text = text
};
break;
case CppCommentKind.VerbatimLine:
cppComment = new CppCommentVerbatimLine()
{
Text = cxComment.VerbatimLineComment_Text.ToString()
};
break;
case CppCommentKind.Full:
cppComment = new CppCommentFull();
break;
default:
return null;
}
Debug.Assert(cppComment != null);
for (uint i = 0; i < cxComment.NumChildren; i++)
{
var cxChildComment = cxComment.GetChild(i);
var cppChildComment = GetComment(cxChildComment);
if (cppChildComment != null)
{
if (cppComment.Children == null)
{
cppComment.Children = new List<CppComment>();
}
cppComment.Children.Add(cppChildComment);
}
}
if (removeTrailingEmptyText)
{
RemoveTrailingEmptyText(cppComment);
}
return cppComment;
}
private static void RemoveTrailingEmptyText(CppComment cppComment)
{
// Remove the last paragraph if it is an empty string text
if (cppComment.Children != null && cppComment.Children.Count > 0 && cppComment.Children[cppComment.Children.Count - 1] is CppCommentParagraph paragraph)
{
// Remove the last paragraph if it is an empty string text
if (paragraph.Children != null && paragraph.Children.Count > 0 && paragraph.Children[paragraph.Children.Count - 1] is CppCommentText text && string.IsNullOrWhiteSpace(text.Text))
{
paragraph.Children.RemoveAt(paragraph.Children.Count - 1);
}
}
}
private CppCommentKind GetCommentKind(CXCommentKind kind)
{
switch (kind)
{
case CXCommentKind.CXComment_Null:
return CppCommentKind.Null;
case CXCommentKind.CXComment_Text:
return CppCommentKind.Text;
case CXCommentKind.CXComment_InlineCommand:
return CppCommentKind.InlineCommand;
case CXCommentKind.CXComment_HTMLStartTag:
return CppCommentKind.HtmlStartTag;
case CXCommentKind.CXComment_HTMLEndTag:
return CppCommentKind.HtmlEndTag;
case CXCommentKind.CXComment_Paragraph:
return CppCommentKind.Paragraph;
case CXCommentKind.CXComment_BlockCommand:
return CppCommentKind.BlockCommand;
case CXCommentKind.CXComment_ParamCommand:
return CppCommentKind.ParamCommand;
case CXCommentKind.CXComment_TParamCommand:
return CppCommentKind.TemplateParamCommand;
case CXCommentKind.CXComment_VerbatimBlockCommand:
return CppCommentKind.VerbatimBlockCommand;
case CXCommentKind.CXComment_VerbatimBlockLine:
return CppCommentKind.VerbatimBlockLine;
case CXCommentKind.CXComment_VerbatimLine:
return CppCommentKind.VerbatimLine;
case CXCommentKind.CXComment_FullComment:
return CppCommentKind.Full;
default:
throw new ArgumentOutOfRangeException($"Unsupported comment kind `{kind}`");
}
}
private CppMacro ParseMacro(CXCursor cursor)
{
// TODO: reuse internal class Tokenizer
// As we don't have an API to check macros, we are
var originalRange = cursor.Extent;
var tu = cursor.TranslationUnit;
// Try to extend the parsing of the macro to the end of line in order to recover comments
originalRange.End.GetFileLocation(out var startFile, out var endLine, out var endColumn, out var startOffset);
var range = originalRange;
if (startFile.Handle != IntPtr.Zero)
{
var nextLineLocation = clang.getLocation(tu, startFile, endLine + 1, 1);
if (!nextLineLocation.Equals(CXSourceLocation.Null))
{
range = clang.getRange(originalRange.Start, nextLineLocation);
}
}
var tokens = tu.Tokenize(range);
var name = GetCursorSpelling(cursor);
var cppMacro = new CppMacro(name);
uint previousLine = 0;
uint previousColumn = 0;
bool parsingMacroParameters = false;
List<string> macroParameters = null;
// Loop decoding tokens for the value
// We need to parse
for (int i = 0; i < tokens.Length; i++)
{
var token = tokens[i];
var tokenRange = token.GetExtent(tu);
tokenRange.Start.GetFileLocation(out var file, out var line, out var column, out var offset);
if (line >= endLine + 1)
{
break;
}
var tokenStr = token.GetSpelling(tu).CString;
// If we are parsing the token right after the MACRO name token
// if the `(` is right after the name without
if (i == 1 && tokenStr == "(" && (previousLine == line && previousColumn == column))
{
parsingMacroParameters = true;
macroParameters = new List<string>();
}
tokenRange.End.GetFileLocation(out file, out previousLine, out previousColumn, out offset);
if (parsingMacroParameters)
{
if (tokenStr == ")")
{
parsingMacroParameters = false;
}
else if (token.Kind != CXTokenKind.CXToken_Punctuation)
{
macroParameters.Add(tokenStr);
}
}
else if (i > 0)
{
CppTokenKind cppTokenKind = 0;
switch (token.Kind)
{
case CXTokenKind.CXToken_Punctuation:
cppTokenKind = CppTokenKind.Punctuation;
break;
case CXTokenKind.CXToken_Keyword:
cppTokenKind = CppTokenKind.Keyword;
break;
case CXTokenKind.CXToken_Identifier:
cppTokenKind = CppTokenKind.Identifier;
break;
case CXTokenKind.CXToken_Literal:
cppTokenKind = CppTokenKind.Literal;
break;
case CXTokenKind.CXToken_Comment:
cppTokenKind = CppTokenKind.Comment;
break;
default:
RootCompilation.Diagnostics.Warning($"Token kind {tokenStr} is not supported for macros", GetSourceLocation(token.GetLocation(tu)));
break;
}
var cppToken = new CppToken(cppTokenKind, tokenStr)
{
Span = new CppSourceSpan(GetSourceLocation(tokenRange.Start), GetSourceLocation(tokenRange.End))
};
cppMacro.Tokens.Add(cppToken);
}
}
// Update the value from the tokens
cppMacro.UpdateValueFromTokens();
cppMacro.Parameters = macroParameters;
var globalContainer = (CppGlobalDeclarationContainer)_rootContainerContext.DeclarationContainer;
globalContainer.Macros.Add(cppMacro);
return cppMacro;
}
private static CppVisibility GetVisibility(CX_CXXAccessSpecifier accessSpecifier)
{
switch (accessSpecifier)
{
case CX_CXXAccessSpecifier.CX_CXXProtected:
return CppVisibility.Protected;
case CX_CXXAccessSpecifier.CX_CXXPrivate:
return CppVisibility.Private;
default:
return CppVisibility.Public;
}
}
private static void AssignSourceSpan(CXCursor cursor, CppElement element)
{
var start = cursor.Extent.Start;
var end = cursor.Extent.End;
element.Span = new CppSourceSpan(GetSourceLocation(start), GetSourceLocation(end));
}
public static CppSourceLocation GetSourceLocation(CXSourceLocation start)
{
start.GetFileLocation(out var file, out var line, out var column, out var offset);
return new CppSourceLocation(file.Name.CString, (int)offset, (int)line, (int)column);
}
private CppField VisitFieldOrVariable(CppContainerContext containerContext, CXCursor cursor, void* data)
{
var fieldName = GetCursorSpelling(cursor);
var type = GetCppType(cursor.Type.Declaration, cursor.Type, cursor, data);
var previousField = containerContext.DeclarationContainer.Fields.Count > 0 ? containerContext.DeclarationContainer.Fields[containerContext.DeclarationContainer.Fields.Count - 1] : null;
CppField cppField;
// This happen in the type is anonymous, we create implicitly a field for it, but if type is the same
// we should reuse the anonymous field we created just before
if (previousField != null && previousField.IsAnonymous && ReferenceEquals(previousField.Type, type))
{
cppField = previousField;
cppField.Name = fieldName;
cppField.Offset = cursor.OffsetOfField / 8;
}
else
{
cppField = new CppField(type, fieldName)
{
Visibility = containerContext.CurrentVisibility,
StorageQualifier = GetStorageQualifier(cursor),
IsBitField = cursor.IsBitField,
BitFieldWidth = cursor.FieldDeclBitWidth,
Offset = cursor.OffsetOfField / 8,
};
containerContext.DeclarationContainer.Fields.Add(cppField);
cppField.Attributes = ParseAttributes(cursor);
if (cursor.Kind == CXCursorKind.CXCursor_VarDecl)
{
VisitInitValue(cursor, data, out var fieldExpr, out var fieldValue);
cppField.InitValue = fieldValue;
cppField.InitExpression = fieldExpr;
}
}
return cppField;
}
private void AddAnonymousTypeWithField(CppContainerContext containerContext, CXCursor cursor, CppType fieldType)
{
var fieldName = "__anonymous__" + containerContext.DeclarationContainer.Fields.Count;
var cppField = new CppField(fieldType, fieldName)
{
Visibility = containerContext.CurrentVisibility,
StorageQualifier = GetStorageQualifier(cursor),
IsAnonymous = true,
Offset = cursor.OffsetOfField / 8,
};
containerContext.DeclarationContainer.Fields.Add(cppField);
cppField.Attributes = ParseAttributes(cursor);
}
private void VisitInitValue(CXCursor cursor, void* data, out CppExpression expression, out CppValue value)
{
CppExpression localExpression = null;
CppValue localValue = null;
cursor.VisitChildren((initCursor, varCursor, clientData) =>
{
if (IsExpression(initCursor))
{
localExpression = VisitExpression(initCursor, clientData);
return CXChildVisitResult.CXChildVisit_Break;
}
return CXChildVisitResult.CXChildVisit_Continue;
}, new CXClientData((IntPtr)data));
// Still tries to extract the compiled value
var resultEval = new CXEvalResult((IntPtr)clang.Cursor_Evaluate(cursor));
switch (resultEval.Kind)
{
case CXEvalResultKind.CXEval_Int:
localValue = new CppValue(resultEval.AsLongLong);
break;
case CXEvalResultKind.CXEval_Float:
localValue = new CppValue(resultEval.AsDouble);
break;
case CXEvalResultKind.CXEval_ObjCStrLiteral:
case CXEvalResultKind.CXEval_StrLiteral:
case CXEvalResultKind.CXEval_CFStr:
localValue = new CppValue(resultEval.AsStr);
break;
case CXEvalResultKind.CXEval_UnExposed:
break;
default:
RootCompilation.Diagnostics.Warning($"Not supported field default value {cursor}", GetSourceLocation(cursor.Location));
break;
}
expression = localExpression;
value = localValue;
}
private static bool IsExpression(CXCursor cursor)
{
return cursor.Kind >= CXCursorKind.CXCursor_FirstExpr && cursor.Kind <= CXCursorKind.CXCursor_LastExpr;
}
private CppExpression VisitExpression(CXCursor cursor, void* data)
{
CppExpression expr = null;
bool visitChildren = false;
switch (cursor.Kind)
{
case CXCursorKind.CXCursor_UnexposedExpr:
expr = new CppRawExpression(CppExpressionKind.Unexposed);
AppendTokensToExpression(cursor, expr);
break;
case CXCursorKind.CXCursor_DeclRefExpr:
expr = new CppRawExpression(CppExpressionKind.DeclRef);
AppendTokensToExpression(cursor, expr);
break;
case CXCursorKind.CXCursor_MemberRefExpr:
expr = new CppRawExpression(CppExpressionKind.MemberRef);
AppendTokensToExpression(cursor, expr);
break;
case CXCursorKind.CXCursor_CallExpr:
expr = new CppRawExpression(CppExpressionKind.Call);
AppendTokensToExpression(cursor, expr);
break;
case CXCursorKind.CXCursor_ObjCMessageExpr:
expr = new CppRawExpression(CppExpressionKind.ObjCMessage);
AppendTokensToExpression(cursor, expr);
break;
case CXCursorKind.CXCursor_BlockExpr:
expr = new CppRawExpression(CppExpressionKind.Block);
AppendTokensToExpression(cursor, expr);
break;
case CXCursorKind.CXCursor_IntegerLiteral:
expr = new CppLiteralExpression(CppExpressionKind.IntegerLiteral, GetCursorAsText(cursor));
break;
case CXCursorKind.CXCursor_FloatingLiteral:
expr = new CppLiteralExpression(CppExpressionKind.FloatingLiteral, GetCursorAsText(cursor));
break;
case CXCursorKind.CXCursor_ImaginaryLiteral:
expr = new CppLiteralExpression(CppExpressionKind.ImaginaryLiteral, GetCursorAsText(cursor));
break;
case CXCursorKind.CXCursor_StringLiteral:
expr = new CppLiteralExpression(CppExpressionKind.StringLiteral, GetCursorAsText(cursor));
break;
case CXCursorKind.CXCursor_CharacterLiteral:
expr = new CppLiteralExpression(CppExpressionKind.CharacterLiteral, GetCursorAsText(cursor));
break;
case CXCursorKind.CXCursor_ParenExpr:
expr = new CppParenExpression();
visitChildren = true;
break;
case CXCursorKind.CXCursor_UnaryOperator:
var tokens = new Tokenizer(cursor);
expr = new CppUnaryExpression(CppExpressionKind.UnaryOperator)
{
Operator = tokens.Count > 0 ? tokens.GetString(0) : string.Empty
};
visitChildren = true;
break;
case CXCursorKind.CXCursor_ArraySubscriptExpr:
expr = new CppRawExpression(CppExpressionKind.ArraySubscript);
AppendTokensToExpression(cursor, expr);
break;
case CXCursorKind.CXCursor_BinaryOperator:
expr = new CppBinaryExpression(CppExpressionKind.BinaryOperator);
visitChildren = true;
break;
case CXCursorKind.CXCursor_CompoundAssignOperator:
expr = new CppRawExpression(CppExpressionKind.CompoundAssignOperator);
AppendTokensToExpression(cursor, expr);
break;
case CXCursorKind.CXCursor_ConditionalOperator:
expr = new CppRawExpression(CppExpressionKind.ConditionalOperator);
AppendTokensToExpression(cursor, expr);
break;
case CXCursorKind.CXCursor_CStyleCastExpr:
expr = new CppRawExpression(CppExpressionKind.CStyleCast);
AppendTokensToExpression(cursor, expr);
break;
case CXCursorKind.CXCursor_CompoundLiteralExpr:
expr = new CppRawExpression(CppExpressionKind.CompoundLiteral);
AppendTokensToExpression(cursor, expr);
break;
case CXCursorKind.CXCursor_InitListExpr:
expr = new CppInitListExpression();
visitChildren = true;
break;
case CXCursorKind.CXCursor_AddrLabelExpr:
expr = new CppRawExpression(CppExpressionKind.AddrLabel);
AppendTokensToExpression(cursor, expr);
break;
case CXCursorKind.CXCursor_StmtExpr:
expr = new CppRawExpression(CppExpressionKind.Stmt);
AppendTokensToExpression(cursor, expr);
break;
case CXCursorKind.CXCursor_GenericSelectionExpr:
expr = new CppRawExpression(CppExpressionKind.GenericSelection);
AppendTokensToExpression(cursor, expr);
break;
case CXCursorKind.CXCursor_GNUNullExpr:
expr = new CppRawExpression(CppExpressionKind.GNUNull);
AppendTokensToExpression(cursor, expr);
break;
case CXCursorKind.CXCursor_CXXStaticCastExpr:
expr = new CppRawExpression(CppExpressionKind.CXXStaticCast);
AppendTokensToExpression(cursor, expr);
break;
case CXCursorKind.CXCursor_CXXDynamicCastExpr:
expr = new CppRawExpression(CppExpressionKind.CXXDynamicCast);
AppendTokensToExpression(cursor, expr);
break;
case CXCursorKind.CXCursor_CXXReinterpretCastExpr:
expr = new CppRawExpression(CppExpressionKind.CXXReinterpretCast);
AppendTokensToExpression(cursor, expr);
break;
case CXCursorKind.CXCursor_CXXConstCastExpr:
expr = new CppRawExpression(CppExpressionKind.CXXConstCast);
AppendTokensToExpression(cursor, expr);
break;
case CXCursorKind.CXCursor_CXXFunctionalCastExpr:
expr = new CppRawExpression(CppExpressionKind.CXXFunctionalCast);
AppendTokensToExpression(cursor, expr);
break;
case CXCursorKind.CXCursor_CXXTypeidExpr:
expr = new CppRawExpression(CppExpressionKind.CXXTypeid);
AppendTokensToExpression(cursor, expr);
break;
case CXCursorKind.CXCursor_CXXBoolLiteralExpr:
expr = new CppRawExpression(CppExpressionKind.CXXBoolLiteral);
AppendTokensToExpression(cursor, expr);
break;
case CXCursorKind.CXCursor_CXXNullPtrLiteralExpr:
expr = new CppRawExpression(CppExpressionKind.CXXNullPtrLiteral);
AppendTokensToExpression(cursor, expr);
break;
case CXCursorKind.CXCursor_CXXThisExpr:
expr = new CppRawExpression(CppExpressionKind.CXXThis);
AppendTokensToExpression(cursor, expr);
break;
case CXCursorKind.CXCursor_CXXThrowExpr:
expr = new CppRawExpression(CppExpressionKind.CXXThrow);
AppendTokensToExpression(cursor, expr);