juliehockett updated this revision to Diff 140275.
juliehockett added a comment.
Fixing assert on vector size.
https://reviews.llvm.org/D43341
Files:
clang-doc/BitcodeReader.cpp
clang-doc/BitcodeReader.h
clang-doc/BitcodeWriter.cpp
clang-doc/BitcodeWriter.h
clang-doc/CMakeLists.txt
clang-doc/Reducer.cpp
clang-doc/Reducer.h
clang-doc/Representation.cpp
clang-doc/Representation.h
clang-doc/tool/ClangDocMain.cpp
docs/ReleaseNotes.rst
test/clang-doc/bc-comment.cpp
test/clang-doc/bc-namespace.cpp
test/clang-doc/bc-record.cpp
Index: test/clang-doc/bc-record.cpp
===================================================================
--- /dev/null
+++ test/clang-doc/bc-record.cpp
@@ -0,0 +1,178 @@
+// This test requires Linux due to the system-dependent USR for the
+// inner class in function H.
+// REQUIRES: system-linux
+// RUN: rm -rf %t
+// RUN: mkdir %t
+// RUN: echo "" > %t/compile_flags.txt
+// RUN: cp "%s" "%t/test.cpp"
+// RUN: clang-doc --dump -doxygen -p %t %t/test.cpp -output=%t/docs
+// RUN: llvm-bcanalyzer %t/docs/bc/docs.bc --dump | FileCheck %s
+
+union A { int X; int Y; };
+
+enum B { X, Y };
+
+enum class Bc { A, B };
+
+struct C { int i; };
+
+class D {};
+
+class E {
+public:
+ E() {}
+ ~E() {}
+
+protected:
+ void ProtectedMethod();
+};
+
+void E::ProtectedMethod() {}
+
+class F : virtual private D, public E {};
+
+class X {
+ class Y {};
+};
+
+void H() {
+ class I {};
+}
+
+// CHECK: <BLOCKINFO_BLOCK/>
+// CHECK-NEXT: <VersionBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Version abbrevid=4 op0=1/>
+// CHECK-NEXT: </VersionBlock>
+// CHECK-NEXT: <FunctionBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <USR abbrevid=4 op0=20 op1=222 op2=180 op3=172 op4=28 op5=217 op6=37 op7=60 op8=217 op9=239 op10=127 op11=190 op12=107 op13=202 op14=197 op15=6 op16=215 op17=121 op18=132 op19=171 op20=212/>
+ // CHECK-NEXT: <Name abbrevid=5 op0=1/> blob data = 'E'
+ // CHECK-NEXT: <Namespace abbrevid=6 op0=1 op1=40/> blob data = '289584A8E0FF4178A794622A547AA622503967A1'
+ // CHECK-NEXT: <IsMethod abbrevid=11 op0=1/>
+ // CHECK-NEXT: <DefLocation abbrevid=7 op0=23 op1={{[0-9]*}}/> blob data = '{{.*}}'
+ // CHECK-NEXT: <Parent abbrevid=9 op0=1 op1=40/> blob data = '289584A8E0FF4178A794622A547AA622503967A1'
+ // CHECK-NEXT: <TypeBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Type abbrevid=4 op0=4 op1=4/> blob data = 'void'
+ // CHECK-NEXT: </TypeBlock>
+// CHECK-NEXT: </FunctionBlock>
+// CHECK-NEXT: <FunctionBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <USR abbrevid=4 op0=20 op1=189 op2=43 op3=222 op4=189 op5=66 op6=63 op7=128 op8=186 op9=204 op10=234 op11=117 op12=222 op13=109 op14=102 op15=34 op16=211 op17=85 op18=252 op19=45 op20=23/>
+ // CHECK-NEXT: <Name abbrevid=5 op0=2/> blob data = '~E'
+ // CHECK-NEXT: <Namespace abbrevid=6 op0=1 op1=40/> blob data = '289584A8E0FF4178A794622A547AA622503967A1'
+ // CHECK-NEXT: <IsMethod abbrevid=11 op0=1/>
+ // CHECK-NEXT: <DefLocation abbrevid=7 op0=24 op1={{[0-9]*}}/> blob data = '{{.*}}'
+ // CHECK-NEXT: <Parent abbrevid=9 op0=1 op1=40/> blob data = '289584A8E0FF4178A794622A547AA622503967A1'
+ // CHECK-NEXT: <TypeBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Type abbrevid=4 op0=4 op1=4/> blob data = 'void'
+ // CHECK-NEXT: </TypeBlock>
+// CHECK-NEXT: </FunctionBlock>
+// CHECK-NEXT: <FunctionBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <USR abbrevid=4 op0=20 op1=80 op2=147 op3=212 op4=40 op5=205 op6=198 op7=32 op8=150 op9=166 op10=117 op11=71 op12=186 op13=82 op14=86 op15=110 op16=79 op17=185 op18=64 op19=78 op20=238/>
+ // CHECK-NEXT: <Name abbrevid=5 op0=15/> blob data = 'ProtectedMethod'
+ // CHECK-NEXT: <Namespace abbrevid=6 op0=1 op1=40/> blob data = '289584A8E0FF4178A794622A547AA622503967A1'
+ // CHECK-NEXT: <IsMethod abbrevid=11 op0=1/>
+ // CHECK-NEXT: <DefLocation abbrevid=7 op0=30 op1={{[0-9]*}}/> blob data = '{{.*}}'
+ // CHECK-NEXT: <Location abbrevid=8 op0=27 op1={{[0-9]*}}/> blob data = '{{.*}}'
+ // CHECK-NEXT: <Parent abbrevid=9 op0=1 op1=40/> blob data = '289584A8E0FF4178A794622A547AA622503967A1'
+ // CHECK-NEXT: <TypeBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Type abbrevid=4 op0=4 op1=4/> blob data = 'void'
+ // CHECK-NEXT: </TypeBlock>
+// CHECK-NEXT: </FunctionBlock>
+// CHECK-NEXT: <FunctionBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <USR abbrevid=4 op0=20 op1=182 op2=172 op3=76 op4=92 op5=159 op6=46 op7=163 op8=242 op9=179 op10=236 op11=225 op12=163 op13=61 op14=52 op15=159 op16=78 op17=229 op18=2 op19=178 op20=78/>
+ // CHECK-NEXT: <Name abbrevid=5 op0=1/> blob data = 'H'
+ // CHECK-NEXT: <Records abbrevid=13 op0=1 op1=40/> blob data = '3433664532ABFCC39301646A10E768C1882BF194'
+ // CHECK-NEXT: <DefLocation abbrevid=7 op0=38 op1={{[0-9]*}}/> blob data = '{{.*}}'
+ // CHECK-NEXT: <TypeBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Type abbrevid=4 op0=4 op1=4/> blob data = 'void'
+ // CHECK-NEXT: </TypeBlock>
+// CHECK-NEXT: </FunctionBlock>
+// CHECK-NEXT: <RecordBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <USR abbrevid=4 op0=20 op1=172 op2=232 op3=26 op4=250 op5=102 op6=39 op7=180 op8=206 op9=242 op10=180 op11=86 op12=251 op13=110 op14=18 op15=82 op16=146 op17=86 op18=116 op19=175 op20=126/>
+ // CHECK-NEXT: <Name abbrevid=5 op0=1/> blob data = 'A'
+ // CHECK-NEXT: <DefLocation abbrevid=7 op0=11 op1={{[0-9]*}}/> blob data = '{{.*}}'
+ // CHECK-NEXT: <TagType abbrevid=9 op0=2/>
+ // CHECK-NEXT: <MemberTypeBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Type abbrevid=4 op0=4 op1=3/> blob data = 'int'
+ // CHECK-NEXT: <Name abbrevid=5 op0=4/> blob data = 'A::X'
+ // CHECK-NEXT: <Access abbrevid=6 op0=3/>
+ // CHECK-NEXT: </MemberTypeBlock>
+ // CHECK-NEXT: <MemberTypeBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Type abbrevid=4 op0=4 op1=3/> blob data = 'int'
+ // CHECK-NEXT: <Name abbrevid=5 op0=4/> blob data = 'A::Y'
+ // CHECK-NEXT: <Access abbrevid=6 op0=3/>
+ // CHECK-NEXT: </MemberTypeBlock>
+// CHECK-NEXT: </RecordBlock>
+// CHECK-NEXT: <RecordBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <USR abbrevid=4 op0=20 op1=6 op2=181 op3=246 op4=161 op5=155 op6=169 op7=246 op8=168 op9=50 op10=225 op11=39 op12=201 op13=150 op14=130 op15=130 op16=185 op17=70 op18=25 op19=178 op20=16/>
+ // CHECK-NEXT: <Name abbrevid=5 op0=1/> blob data = 'C'
+ // CHECK-NEXT: <DefLocation abbrevid=7 op0=17 op1={{[0-9]*}}/> blob data = '{{.*}}'
+ // CHECK-NEXT: <MemberTypeBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Type abbrevid=4 op0=4 op1=3/> blob data = 'int'
+ // CHECK-NEXT: <Name abbrevid=5 op0=4/> blob data = 'C::i'
+ // CHECK-NEXT: <Access abbrevid=6 op0=3/>
+ // CHECK-NEXT: </MemberTypeBlock>
+// CHECK-NEXT: </RecordBlock>
+// CHECK-NEXT: <RecordBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <USR abbrevid=4 op0=20 op1=9 op2=33 op3=115 op4=117 op5=65 op6=32 op7=139 op8=143 op9=169 op10=187 op11=66 op12=182 op13=15 op14=120 op15=172 op16=29 op17=119 op18=154 op19=160 op20=84/>
+ // CHECK-NEXT: <Name abbrevid=5 op0=1/> blob data = 'D'
+ // CHECK-NEXT: <Records abbrevid=13 op0=1 op1=40/> blob data = 'E3B54702FABFF4037025BA194FC27C47006330B5'
+ // CHECK-NEXT: <DefLocation abbrevid=7 op0=19 op1={{[0-9]*}}/> blob data = '{{.*}}'
+ // CHECK-NEXT: <TagType abbrevid=9 op0=3/>
+// CHECK-NEXT: </RecordBlock>
+// CHECK-NEXT: <RecordBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <USR abbrevid=4 op0=20 op1=40 op2=149 op3=132 op4=168 op5=224 op6=255 op7=65 op8=120 op9=167 op10=148 op11=98 op12=42 op13=84 op14=122 op15=166 op16=34 op17=80 op18=57 op19=103 op20=161/>
+ // CHECK-NEXT: <Name abbrevid=5 op0=1/> blob data = 'E'
+ // CHECK-NEXT: <Records abbrevid=13 op0=1 op1=40/> blob data = 'E3B54702FABFF4037025BA194FC27C47006330B5'
+ // CHECK-NEXT: <Functions abbrevid=14 op0=2 op1=40/> blob data = 'DEB4AC1CD9253CD9EF7FBE6BCAC506D77984ABD4'
+ // CHECK-NEXT: <Functions abbrevid=14 op0=2 op1=40/> blob data = 'DEB4AC1CD9253CD9EF7FBE6BCAC506D77984ABD4'
+ // CHECK-NEXT: <Functions abbrevid=14 op0=2 op1=40/> blob data = 'BD2BDEBD423F80BACCEA75DE6D6622D355FC2D17'
+ // CHECK-NEXT: <Functions abbrevid=14 op0=2 op1=40/> blob data = 'BD2BDEBD423F80BACCEA75DE6D6622D355FC2D17'
+ // CHECK-NEXT: <Functions abbrevid=14 op0=2 op1=40/> blob data = '5093D428CDC62096A67547BA52566E4FB9404EEE'
+ // CHECK-NEXT: <Functions abbrevid=14 op0=2 op1=40/> blob data = '5093D428CDC62096A67547BA52566E4FB9404EEE'
+ // CHECK-NEXT: <DefLocation abbrevid=7 op0=21 op1={{[0-9]*}}/> blob data = '{{.*}}'
+ // CHECK-NEXT: <TagType abbrevid=9 op0=3/>
+// CHECK-NEXT: </RecordBlock>
+// CHECK-NEXT: <RecordBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <USR abbrevid=4 op0=20 op1=227 op2=181 op3=71 op4=2 op5=250 op6=191 op7=244 op8=3 op9=112 op10=37 op11=186 op12=25 op13=79 op14=194 op15=124 op16=71 op17=0 op18=99 op19=48 op20=181/>
+ // CHECK-NEXT: <Name abbrevid=5 op0=1/> blob data = 'F'
+ // CHECK-NEXT: <DefLocation abbrevid=7 op0=32 op1={{[0-9]*}}/> blob data = '{{.*}}'
+ // CHECK-NEXT: <TagType abbrevid=9 op0=3/>
+ // CHECK-NEXT: <Parent abbrevid=10 op0=1 op1=40/> blob data = '289584A8E0FF4178A794622A547AA622503967A1'
+ // CHECK-NEXT: <VParent abbrevid=11 op0=1 op1=40/> blob data = '0921737541208B8FA9BB42B60F78AC1D779AA054'
+// CHECK-NEXT: </RecordBlock>
+// CHECK-NEXT: <RecordBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <USR abbrevid=4 op0=20 op1=202 op2=124 op3=121 op4=53 op5=115 op6=11 op7=94 op8=172 op9=210 op10=95 op11=8 op12=14 op13=156 op14=131 op15=250 op16=8 op17=124 op18=205 op19=199 op20=94/>
+ // CHECK-NEXT: <Name abbrevid=5 op0=1/> blob data = 'X'
+ // CHECK-NEXT: <Records abbrevid=13 op0=1 op1=40/> blob data = '641AB4A3D36399954ACDE29C7A8833032BF40472'
+ // CHECK-NEXT: <DefLocation abbrevid=7 op0=34 op1={{[0-9]*}}/> blob data = '{{.*}}'
+ // CHECK-NEXT: <TagType abbrevid=9 op0=3/>
+// CHECK-NEXT: </RecordBlock>
+// CHECK-NEXT: <RecordBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <USR abbrevid=4 op0=20 op1=100 op2=26 op3=180 op4=163 op5=211 op6=99 op7=153 op8=149 op9=74 op10=205 op11=226 op12=156 op13=122 op14=136 op15=51 op16=3 op17=43 op18=244 op19=4 op20=114/>
+ // CHECK-NEXT: <Name abbrevid=5 op0=1/> blob data = 'Y'
+ // CHECK-NEXT: <Namespace abbrevid=6 op0=1 op1=40/> blob data = 'CA7C7935730B5EACD25F080E9C83FA087CCDC75E'
+ // CHECK-NEXT: <DefLocation abbrevid=7 op0=35 op1={{[0-9]*}}/> blob data = '{{.*}}'
+ // CHECK-NEXT: <TagType abbrevid=9 op0=3/>
+// CHECK-NEXT: </RecordBlock>
+// CHECK-NEXT: <RecordBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <USR abbrevid=4 op0=20 op1=52 op2=51 op3=102 op4=69 op5=50 op6=171 op7=252 op8=195 op9=147 op10=1 op11=100 op12=106 op13=16 op14=231 op15=104 op16=193 op17=136 op18=43 op19=241 op20=148/>
+ // CHECK-NEXT: <Name abbrevid=5 op0=1/> blob data = 'I'
+ // CHECK-NEXT: <Namespace abbrevid=6 op0=2 op1=40/> blob data = 'B6AC4C5C9F2EA3F2B3ECE1A33D349F4EE502B24E'
+ // CHECK-NEXT: <DefLocation abbrevid=7 op0=39 op1={{[0-9]*}}/> blob data = '{{.*}}'
+ // CHECK-NEXT: <TagType abbrevid=9 op0=3/>
+// CHECK-NEXT: </RecordBlock>
+// CHECK-NEXT: <EnumBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <USR abbrevid=4 op0=20 op1=252 op2=7 op3=189 op4=52 op5=213 op6=231 op7=119 op8=130 op9=194 op10=99 op11=250 op12=148 op13=68 op14=71 op15=146 op16=158 op17=168 op18=117 op19=55 op20=64/>
+ // CHECK-NEXT: <Name abbrevid=5 op0=1/> blob data = 'B'
+ // CHECK-NEXT: <DefLocation abbrevid=7 op0=13 op1={{[0-9]*}}/> blob data = '{{.*}}'
+ // CHECK-NEXT: <Member abbrevid=9 op0=1/> blob data = 'X'
+ // CHECK-NEXT: <Member abbrevid=9 op0=1/> blob data = 'Y'
+// CHECK-NEXT: </EnumBlock>
+// CHECK-NEXT: <EnumBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <USR abbrevid=4 op0=20 op1=30 op2=52 op3=56 op4=160 op5=139 op6=162 op7=32 op8=37 op9=192 op10=180 op11=98 op12=137 op13=255 op14=6 op15=134 op16=249 op17=44 op18=137 op19=36 op20=197/>
+ // CHECK-NEXT: <Name abbrevid=5 op0=2/> blob data = 'Bc'
+ // CHECK-NEXT: <DefLocation abbrevid=7 op0=15 op1={{[0-9]*}}/> blob data = '{{.*}}'
+ // CHECK-NEXT: <Scoped abbrevid=10 op0=1/>
+ // CHECK-NEXT: <Member abbrevid=9 op0=1/> blob data = 'A'
+ // CHECK-NEXT: <Member abbrevid=9 op0=1/> blob data = 'B'
+// CHECK-NEXT: </EnumBlock>
Index: test/clang-doc/bc-namespace.cpp
===================================================================
--- /dev/null
+++ test/clang-doc/bc-namespace.cpp
@@ -0,0 +1,78 @@
+// RUN: rm -rf %t
+// RUN: mkdir %t
+// RUN: echo "" > %t/compile_flags.txt
+// RUN: cp "%s" "%t/test.cpp"
+// RUN: clang-doc --dump -doxygen -p %t %t/test.cpp -output=%t/docs
+// RUN: llvm-bcanalyzer %t/docs/bc/docs.bc --dump | FileCheck %s
+
+namespace A {
+
+void f();
+
+} // namespace A
+
+namespace A {
+
+void f(){};
+
+namespace B {
+
+enum E { X };
+
+E func(int i) { return X; }
+
+} // namespace B
+} // namespace A
+
+// CHECK: <BLOCKINFO_BLOCK/>
+// CHECK-NEXT: <VersionBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Version abbrevid=4 op0=1/>
+// CHECK-NEXT: </VersionBlock>
+// CHECK-NEXT: <NamespaceBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <USR abbrevid=4 op0=20 op1=141 op2=4 op3=46 op4=255 op5=201 op6=139 op7=55 op8=52 op9=80 op10=188 op11=107 op12=91 op13=144 op14=163 op15=48 op16=194 op17=90 op18=21 op19=14 op20=156/>
+ // CHECK-NEXT: <Name abbrevid=5 op0=1/> blob data = 'A'
+ // CHECK-NEXT: <Namespaces abbrevid=7 op0=0 op1=40/> blob data = 'E21AF79E2A9D02554BA090D10DF39FE273F5CDB5'
+ // CHECK-NEXT: <Functions abbrevid=9 op0=2 op1=40/> blob data = '39D3C95A5F7CE2BA4937BD7B01BAE09EBC2AD8AC'
+ // CHECK-NEXT: <Functions abbrevid=9 op0=2 op1=40/> blob data = '9A82CB33ED0FDF81EE383D31CD0957D153C5E840'
+ // CHECK-NEXT: <Enums abbrevid=10 op0=3 op1=40/> blob data = 'E9ABF7E7E2425B626723D41E76E4BC7E7A5BD775'
+// CHECK-NEXT: </NamespaceBlock>
+// CHECK-NEXT: <NamespaceBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <USR abbrevid=4 op0=20 op1=226 op2=26 op3=247 op4=158 op5=42 op6=157 op7=2 op8=85 op9=75 op10=160 op11=144 op12=209 op13=13 op14=243 op15=159 op16=226 op17=115 op18=245 op19=205 op20=181/>
+ // CHECK-NEXT: <Name abbrevid=5 op0=1/> blob data = 'B'
+ // CHECK-NEXT: <Namespace abbrevid=6 op0=0 op1=40/> blob data = '8D042EFFC98B373450BC6B5B90A330C25A150E9C'
+ // CHECK-NEXT: <Functions abbrevid=9 op0=2 op1=40/> blob data = '9A82CB33ED0FDF81EE383D31CD0957D153C5E840'
+ // CHECK-NEXT: <Enums abbrevid=10 op0=3 op1=40/> blob data = 'E9ABF7E7E2425B626723D41E76E4BC7E7A5BD775'
+// CHECK-NEXT: </NamespaceBlock>
+// CHECK-NEXT: <FunctionBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <USR abbrevid=4 op0=20 op1=57 op2=211 op3=201 op4=90 op5=95 op6=124 op7=226 op8=186 op9=73 op10=55 op11=189 op12=123 op13=1 op14=186 op15=224 op16=158 op17=188 op18=42 op19=216 op20=172/>
+ // CHECK-NEXT: <Name abbrevid=5 op0=1/> blob data = 'f'
+ // CHECK-NEXT: <Namespace abbrevid=6 op0=0 op1=40/> blob data = '8D042EFFC98B373450BC6B5B90A330C25A150E9C'
+ // CHECK-NEXT: <DefLocation abbrevid=7 op0=16 op1={{[0-9]*}}/> blob data = '{{.*}}'
+ // CHECK-NEXT: <Location abbrevid=8 op0=10 op1={{[0-9]*}}/> blob data = '{{.*}}'
+ // CHECK-NEXT: <TypeBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Type abbrevid=4 op0=4 op1=4/> blob data = 'void'
+ // CHECK-NEXT: </TypeBlock>
+// CHECK-NEXT: </FunctionBlock>
+// CHECK-NEXT: <FunctionBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <USR abbrevid=4 op0=20 op1=154 op2=130 op3=203 op4=51 op5=237 op6=15 op7=223 op8=129 op9=238 op10=56 op11=61 op12=49 op13=205 op14=9 op15=87 op16=209 op17=83 op18=197 op19=232 op20=64/>
+ // CHECK-NEXT: <Name abbrevid=5 op0=4/> blob data = 'func'
+ // CHECK-NEXT: <Namespace abbrevid=6 op0=0 op1=40/> blob data = 'E21AF79E2A9D02554BA090D10DF39FE273F5CDB5'
+ // CHECK-NEXT: <Namespace abbrevid=6 op0=0 op1=40/> blob data = '8D042EFFC98B373450BC6B5B90A330C25A150E9C'
+ // CHECK-NEXT: <DefLocation abbrevid=7 op0=22 op1={{[0-9]*}}/> blob data = '{{.*}}'
+ // CHECK-NEXT: <TypeBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Type abbrevid=4 op0=4 op1=12/> blob data = 'enum A::B::E'
+ // CHECK-NEXT: </TypeBlock>
+ // CHECK-NEXT: <FieldTypeBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Type abbrevid=4 op0=4 op1=3/> blob data = 'int'
+ // CHECK-NEXT: <Name abbrevid=5 op0=1/> blob data = 'i'
+ // CHECK-NEXT: </FieldTypeBlock>
+// CHECK-NEXT: </FunctionBlock>
+// CHECK-NEXT: <EnumBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <USR abbrevid=4 op0=20 op1=233 op2=171 op3=247 op4=231 op5=226 op6=66 op7=91 op8=98 op9=103 op10=35 op11=212 op12=30 op13=118 op14=228 op15=188 op16=126 op17=122 op18=91 op19=215 op20=117/>
+ // CHECK-NEXT: <Name abbrevid=5 op0=1/> blob data = 'E'
+ // CHECK-NEXT: <Namespace abbrevid=6 op0=0 op1=40/> blob data = 'E21AF79E2A9D02554BA090D10DF39FE273F5CDB5'
+ // CHECK-NEXT: <Namespace abbrevid=6 op0=0 op1=40/> blob data = '8D042EFFC98B373450BC6B5B90A330C25A150E9C'
+ // CHECK-NEXT: <DefLocation abbrevid=7 op0=20 op1={{[0-9]*}}/> blob data = '{{.*}}'
+ // CHECK-NEXT: <Member abbrevid=9 op0=1/> blob data = 'X'
+// CHECK-NEXT: </EnumBlock>
+
Index: test/clang-doc/bc-comment.cpp
===================================================================
--- /dev/null
+++ test/clang-doc/bc-comment.cpp
@@ -0,0 +1,182 @@
+// RUN: rm -rf %t
+// RUN: mkdir %t
+// RUN: echo "" > %t/compile_flags.txt
+// RUN: cp "%s" "%t/test.cpp"
+// RUN: clang-doc --dump -doxygen -p %t %t/test.cpp -output=%t/docs
+// RUN: llvm-bcanalyzer %t/docs/bc/docs.bc --dump | FileCheck %s
+
+/// \brief Brief description.
+///
+/// Extended description that
+/// continues onto the next line.
+///
+/// <ul class="test">
+/// <li> Testing.
+/// </ul>
+///
+/// \verbatim
+/// The description continues.
+/// \endverbatim
+///
+/// \param [out] I is a parameter.
+/// \param J is a parameter.
+/// \return void
+void F(int I, int J);
+
+/// Bonus comment on definition
+void F(int I, int J) {}
+
+// CHECK: <BLOCKINFO_BLOCK/>
+// CHECK-NEXT: <VersionBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Version abbrevid=4 op0=1/>
+// CHECK-NEXT: </VersionBlock>
+// CHECK-NEXT: <FunctionBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <USR abbrevid=4 op0=20 op1=117 op2=116 op3=99 op4=6 op5=20 op6=165 op7=53 op8=113 op9=14 op10=90 op11=106 op12=188 op13=255 op14=249 op15=139 op16=202 op17=45 op18=6 op19=164 op20=202/>
+ // CHECK-NEXT: <Name abbrevid=5 op0=1/> blob data = 'F'
+ // CHECK-NEXT: <CommentBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <CommentBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Kind abbrevid=4 op0=16/> blob data = 'ParagraphComment'
+ // CHECK-NEXT: <CommentBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Kind abbrevid=4 op0=11/> blob data = 'TextComment'
+ // CHECK-NEXT: </CommentBlock>
+ // CHECK-NEXT: </CommentBlock>
+ // CHECK-NEXT: <CommentBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Kind abbrevid=4 op0=19/> blob data = 'BlockCommandComment'
+ // CHECK-NEXT: <Name abbrevid=6 op0=5/> blob data = 'brief'
+ // CHECK-NEXT: <CommentBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Kind abbrevid=4 op0=16/> blob data = 'ParagraphComment'
+ // CHECK-NEXT: <CommentBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Kind abbrevid=4 op0=11/> blob data = 'TextComment'
+ // CHECK-NEXT: <Text abbrevid=5 op0=19/> blob data = ' Brief description.'
+ // CHECK-NEXT: </CommentBlock>
+ // CHECK-NEXT: </CommentBlock>
+ // CHECK-NEXT: </CommentBlock>
+ // CHECK-NEXT: <CommentBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Kind abbrevid=4 op0=16/> blob data = 'ParagraphComment'
+ // CHECK-NEXT: <CommentBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Kind abbrevid=4 op0=11/> blob data = 'TextComment'
+ // CHECK-NEXT: <Text abbrevid=5 op0=26/> blob data = ' Extended description that'
+ // CHECK-NEXT: </CommentBlock>
+ // CHECK-NEXT: <CommentBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Kind abbrevid=4 op0=11/> blob data = 'TextComment'
+ // CHECK-NEXT: <Text abbrevid=5 op0=30/> blob data = ' continues onto the next line.'
+ // CHECK-NEXT: </CommentBlock>
+ // CHECK-NEXT: </CommentBlock>
+ // CHECK-NEXT: <CommentBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Kind abbrevid=4 op0=16/> blob data = 'ParagraphComment'
+ // CHECK-NEXT: <CommentBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Kind abbrevid=4 op0=11/> blob data = 'TextComment'
+ // CHECK-NEXT: </CommentBlock>
+ // CHECK-NEXT: <CommentBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Kind abbrevid=4 op0=19/> blob data = 'HTMLStartTagComment'
+ // CHECK-NEXT: <Name abbrevid=6 op0=2/> blob data = 'ul'
+ // CHECK-NEXT: <AttrKey abbrevid=12 op0=5/> blob data = 'class'
+ // CHECK-NEXT: <AttrVal abbrevid=13 op0=4/> blob data = 'test'
+ // CHECK-NEXT: </CommentBlock>
+ // CHECK-NEXT: <CommentBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Kind abbrevid=4 op0=11/> blob data = 'TextComment'
+ // CHECK-NEXT: </CommentBlock>
+ // CHECK-NEXT: <CommentBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Kind abbrevid=4 op0=19/> blob data = 'HTMLStartTagComment'
+ // CHECK-NEXT: <Name abbrevid=6 op0=2/> blob data = 'li'
+ // CHECK-NEXT: </CommentBlock>
+ // CHECK-NEXT: <CommentBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Kind abbrevid=4 op0=11/> blob data = 'TextComment'
+ // CHECK-NEXT: <Text abbrevid=5 op0=9/> blob data = ' Testing.'
+ // CHECK-NEXT: </CommentBlock>
+ // CHECK-NEXT: <CommentBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Kind abbrevid=4 op0=11/> blob data = 'TextComment'
+ // CHECK-NEXT: </CommentBlock>
+ // CHECK-NEXT: <CommentBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Kind abbrevid=4 op0=17/> blob data = 'HTMLEndTagComment'
+ // CHECK-NEXT: <Name abbrevid=6 op0=2/> blob data = 'ul'
+ // CHECK-NEXT: <SelfClosing abbrevid=10 op0=1/>
+ // CHECK-NEXT: </CommentBlock>
+ // CHECK-NEXT: </CommentBlock>
+ // CHECK-NEXT: <CommentBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Kind abbrevid=4 op0=16/> blob data = 'ParagraphComment'
+ // CHECK-NEXT: <CommentBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Kind abbrevid=4 op0=11/> blob data = 'TextComment'
+ // CHECK-NEXT: </CommentBlock>
+ // CHECK-NEXT: </CommentBlock>
+ // CHECK-NEXT: <CommentBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Kind abbrevid=4 op0=20/> blob data = 'VerbatimBlockComment'
+ // CHECK-NEXT: <Name abbrevid=6 op0=8/> blob data = 'verbatim'
+ // CHECK-NEXT: <CloseName abbrevid=9 op0=11/> blob data = 'endverbatim'
+ // CHECK-NEXT: <CommentBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Kind abbrevid=4 op0=24/> blob data = 'VerbatimBlockLineComment'
+ // CHECK-NEXT: <Text abbrevid=5 op0=27/> blob data = ' The description continues.'
+ // CHECK-NEXT: </CommentBlock>
+ // CHECK-NEXT: </CommentBlock>
+ // CHECK-NEXT: <CommentBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Kind abbrevid=4 op0=16/> blob data = 'ParagraphComment'
+ // CHECK-NEXT: <CommentBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Kind abbrevid=4 op0=11/> blob data = 'TextComment'
+ // CHECK-NEXT: </CommentBlock>
+ // CHECK-NEXT: </CommentBlock>
+ // CHECK-NEXT: <CommentBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Kind abbrevid=4 op0=19/> blob data = 'ParamCommandComment'
+ // CHECK-NEXT: <Direction abbrevid=7 op0=5/> blob data = '[out]'
+ // CHECK-NEXT: <ParamName abbrevid=8 op0=1/> blob data = 'I'
+ // CHECK-NEXT: <Explicit abbrevid=11 op0=1/>
+ // CHECK-NEXT: <CommentBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Kind abbrevid=4 op0=16/> blob data = 'ParagraphComment'
+ // CHECK-NEXT: <CommentBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Kind abbrevid=4 op0=11/> blob data = 'TextComment'
+ // CHECK-NEXT: <Text abbrevid=5 op0=16/> blob data = ' is a parameter.'
+ // CHECK-NEXT: </CommentBlock>
+ // CHECK-NEXT: <CommentBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Kind abbrevid=4 op0=11/> blob data = 'TextComment'
+ // CHECK-NEXT: </CommentBlock>
+ // CHECK-NEXT: </CommentBlock>
+ // CHECK-NEXT: </CommentBlock>
+ // CHECK-NEXT: <CommentBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Kind abbrevid=4 op0=19/> blob data = 'ParamCommandComment'
+ // CHECK-NEXT: <Direction abbrevid=7 op0=4/> blob data = '[in]'
+ // CHECK-NEXT: <ParamName abbrevid=8 op0=1/> blob data = 'J'
+ // CHECK-NEXT: <CommentBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Kind abbrevid=4 op0=16/> blob data = 'ParagraphComment'
+ // CHECK-NEXT: <CommentBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Kind abbrevid=4 op0=11/> blob data = 'TextComment'
+ // CHECK-NEXT: <Text abbrevid=5 op0=16/> blob data = ' is a parameter.'
+ // CHECK-NEXT: </CommentBlock>
+ // CHECK-NEXT: <CommentBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Kind abbrevid=4 op0=11/> blob data = 'TextComment'
+ // CHECK-NEXT: </CommentBlock>
+ // CHECK-NEXT: </CommentBlock>
+ // CHECK-NEXT: </CommentBlock>
+ // CHECK-NEXT: <CommentBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Kind abbrevid=4 op0=19/> blob data = 'BlockCommandComment'
+ // CHECK-NEXT: <Name abbrevid=6 op0=6/> blob data = 'return'
+ // CHECK-NEXT: <CommentBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Kind abbrevid=4 op0=16/> blob data = 'ParagraphComment'
+ // CHECK-NEXT: <CommentBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Kind abbrevid=4 op0=11/> blob data = 'TextComment'
+ // CHECK-NEXT: <Text abbrevid=5 op0=5/> blob data = ' void'
+ // CHECK-NEXT: </CommentBlock>
+ // CHECK-NEXT: </CommentBlock>
+ // CHECK-NEXT: </CommentBlock>
+ // CHECK-NEXT: </CommentBlock>
+ // CHECK-NEXT: <CommentBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <CommentBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Kind abbrevid=4 op0=16/> blob data = 'ParagraphComment'
+ // CHECK-NEXT: <CommentBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Kind abbrevid=4 op0=11/> blob data = 'TextComment'
+ // CHECK-NEXT: <Text abbrevid=5 op0=28/> blob data = ' Bonus comment on definition'
+ // CHECK-NEXT: </CommentBlock>
+ // CHECK-NEXT: </CommentBlock>
+ // CHECK-NEXT: </CommentBlock>
+ // CHECK-NEXT: <DefLocation abbrevid=7 op0=27 op1={{[0-9]*}}/> blob data = '{{.*}}'
+ // CHECK-NEXT: <Location abbrevid=8 op0=24 op1={{[0-9]*}}/> blob data = '{{.*}}'
+ // CHECK-NEXT: <TypeBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Type abbrevid=4 op0=4 op1=4/> blob data = 'void'
+ // CHECK-NEXT: </TypeBlock>
+ // CHECK-NEXT: <FieldTypeBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Type abbrevid=4 op0=4 op1=3/> blob data = 'int'
+ // CHECK-NEXT: <Name abbrevid=5 op0=1/> blob data = 'I'
+ // CHECK-NEXT: </FieldTypeBlock>
+ // CHECK-NEXT: <FieldTypeBlock NumWords={{[0-9]*}} BlockCodeSize=4>
+ // CHECK-NEXT: <Type abbrevid=4 op0=4 op1=3/> blob data = 'int'
+ // CHECK-NEXT: <Name abbrevid=5 op0=1/> blob data = 'J'
+ // CHECK-NEXT: </FieldTypeBlock>
+// CHECK-NEXT: </FunctionBlock>
Index: docs/ReleaseNotes.rst
===================================================================
--- docs/ReleaseNotes.rst
+++ docs/ReleaseNotes.rst
@@ -42,7 +42,8 @@
Major New Features
------------------
-...
+New tool :doc:`clang-doc <clang-doc>`, a tool for generating C and C++
+documenation from source code and comments.
Improvements to clang-query
---------------------------
Index: clang-doc/tool/ClangDocMain.cpp
===================================================================
--- clang-doc/tool/ClangDocMain.cpp
+++ clang-doc/tool/ClangDocMain.cpp
@@ -18,7 +18,9 @@
//
//===----------------------------------------------------------------------===//
+#include "BitcodeWriter.h"
#include "ClangDoc.h"
+#include "Reducer.h"
#include "clang/AST/AST.h"
#include "clang/AST/Decl.h"
#include "clang/ASTMatchers/ASTMatchFinder.h"
@@ -54,14 +56,42 @@
llvm::cl::desc("Dump mapper results to bitcode file."),
llvm::cl::init(false), llvm::cl::cat(ClangDocCategory));
+static llvm::cl::opt<bool>
+ DumpResult("dump",
+ llvm::cl::desc("Dump intermediate results to bitcode file."),
+ llvm::cl::init(false), llvm::cl::cat(ClangDocCategory));
+
static llvm::cl::opt<bool> DoxygenOnly(
"doxygen",
llvm::cl::desc("Use only doxygen-style comments to generate docs."),
llvm::cl::init(false), llvm::cl::cat(ClangDocCategory));
+bool DumpResultToFile(const Twine &DirName, const Twine &FileName,
+ StringRef Buffer) {
+ std::error_code OK;
+ SmallString<128> IRRootPath;
+ llvm::sys::path::native(OutDirectory, IRRootPath);
+ llvm::sys::path::append(IRRootPath, DirName);
+ std::error_code DirectoryStatus =
+ llvm::sys::fs::create_directories(IRRootPath);
+ if (DirectoryStatus != OK) {
+ llvm::errs() << "Unable to create documentation directories.\n";
+ return true;
+ }
+ llvm::sys::path::append(IRRootPath, FileName);
+ std::error_code OutErrorInfo;
+ llvm::raw_fd_ostream OS(IRRootPath, OutErrorInfo, llvm::sys::fs::F_None);
+ if (OutErrorInfo != OK) {
+ llvm::errs() << "Error opening documentation file.\n";
+ return true;
+ }
+ OS << Buffer;
+ OS.close();
+ return false;
+}
+
int main(int argc, const char **argv) {
llvm::sys::PrintStackTraceOnErrorSignal(argv[0]);
- std::error_code OK;
auto Exec = clang::tooling::createExecutorFromCommandLineArgs(
argc, argv, ClangDocCategory);
@@ -80,34 +110,37 @@
// Mapping phase
llvm::outs() << "Mapping decls...\n";
- auto Err = Exec->get()->execute(doc::newMapperActionFactory(
- Exec->get()->getExecutionContext()),
- ArgAdjuster);
+ auto Err = Exec->get()->execute(
+ doc::newMapperActionFactory(Exec->get()->getExecutionContext()),
+ ArgAdjuster);
if (Err)
llvm::errs() << toString(std::move(Err)) << "\n";
if (DumpMapperResult) {
- Exec->get()->getToolResults()->forEachResult([&](StringRef Key,
- StringRef Value) {
- SmallString<128> IRRootPath;
- llvm::sys::path::native(OutDirectory, IRRootPath);
- llvm::sys::path::append(IRRootPath, "bc");
- std::error_code DirectoryStatus =
- llvm::sys::fs::create_directories(IRRootPath);
- if (DirectoryStatus != OK) {
- llvm::errs() << "Unable to create documentation directories.\n";
- return;
- }
- llvm::sys::path::append(IRRootPath, Key + ".bc");
- std::error_code OutErrorInfo;
- llvm::raw_fd_ostream OS(IRRootPath, OutErrorInfo, llvm::sys::fs::F_None);
- if (OutErrorInfo != OK) {
- llvm::errs() << "Error opening documentation file.\n";
- return;
- }
- OS << Value;
- OS.close();
- });
+ bool Err = false;
+ Exec->get()->getToolResults()->forEachResult(
+ [&](StringRef Key, StringRef Value) {
+ Err = DumpResultToFile("bc", Key + ".bc", Value);
+ });
+ if (Err) return 1;
+ }
+
+ // Reducing phase
+ llvm::outs() << "Reducing infos...\n";
+ auto Infos = doc::mergeInfos(Exec->get()->getToolResults());
+ if (!Infos) {
+ llvm::errs() << "Error reducing infos.\n";
+ return 1;
+ }
+
+ if (DumpResult) {
+ llvm::outs() << "Writing intermediate results...\n";
+ SmallString<4096> Buffer;
+ llvm::BitstreamWriter Stream(Buffer);
+ doc::ClangDocBitcodeWriter Writer(Stream);
+ Writer.emitInfoSet(*Infos);
+ if (DumpResultToFile("bc", "docs.bc", Buffer))
+ return 1;
}
return 0;
Index: clang-doc/Representation.h
===================================================================
--- clang-doc/Representation.h
+++ clang-doc/Representation.h
@@ -17,6 +17,7 @@
#include "clang/AST/Type.h"
#include "clang/Basic/Specifiers.h"
+#include "llvm/ADT/DenseMapInfo.h"
#include "llvm/ADT/Optional.h"
#include "llvm/ADT/SmallVector.h"
#include "llvm/ADT/StringExtras.h"
@@ -26,7 +27,9 @@
namespace clang {
namespace doc {
+// SHA1'd hash of a USR.
using SymbolID = std::array<uint8_t, 20>;
+SymbolID StringToSymbol(llvm::StringRef StringUSR);
struct Info;
enum class InfoType {
@@ -37,18 +40,30 @@
IT_default
};
+enum class TypeInfoType {
+ TT_type,
+ TT_field_type,
+ TT_member_type,
+};
+
// A representation of a parsed comment.
struct CommentInfo {
CommentInfo() = default;
- CommentInfo(CommentInfo &&Other) : Children(std::move(Other.Children)) {}
-
- SmallString<16>
- Kind; // Kind of comment (TextComment, InlineCommandComment,
- // HTMLStartTagComment, HTMLEndTagComment, BlockCommandComment,
- // ParamCommandComment, TParamCommandComment, VerbatimBlockComment,
- // VerbatimBlockLineComment, VerbatimLineComment).
- SmallString<64> Text; // Text of the comment.
- SmallString<16> Name; // Name of the comment (for Verbatim and HTML).
+ CommentInfo(CommentInfo &&Other)
+ : Text(Other.Text), Name(Other.Name), Direction(Other.Direction),
+ ParamName(Other.ParamName), CloseName(Other.CloseName),
+ SelfClosing(Other.SelfClosing), Explicit(Other.Explicit),
+ AttrKeys(std::move(Other.AttrKeys)),
+ AttrValues(std::move(Other.AttrValues)), Args(std::move(Other.Args)),
+ Children(std::move(Other.Children)) {}
+
+ SmallString<16> Kind; // Kind of comment (TextComment, InlineCommandComment,
+ // HTMLStartTagComment, HTMLEndTagComment,
+ // BlockCommandComment, ParamCommandComment,
+ // TParamCommandComment, VerbatimBlockComment,
+ // VerbatimBlockLineComment, VerbatimLineComment).
+ SmallString<64> Text; // Text of the comment.
+ SmallString<16> Name; // Name of the comment (for Verbatim and HTML).
SmallString<8> Direction; // Parameter direction (for (T)ParamCommand).
SmallString<16> ParamName; // Parameter name (for (T)ParamCommand).
SmallString<16> CloseName; // Closing tag name (for VerbatimBlock).
@@ -72,9 +87,10 @@
SymbolID USR; // Unique identifer for referenced decl
SmallString<16> UnresolvedName; // Name of unresolved type.
- InfoType RefType =
- InfoType::IT_default; // Indicates the type of this Reference (namespace,
- // record, function, enum, default).
+ InfoType RefType = InfoType::IT_default; // Indicates the type of this
+ // Reference (namespace, record,
+ // function, enum, default).
+ Info *Ref;
};
// A base struct for TypeInfos
@@ -123,14 +139,24 @@
/// A base struct for Infos.
struct Info {
Info() = default;
- Info(Info &&Other) : Description(std::move(Other.Description)) {}
- virtual ~Info() = default;
+ Info(Info &&Other)
+ : USR(Other.USR), Name(Other.Name), Namespace(std::move(Other.Namespace)),
+ Description(std::move(Other.Description)),
+ Namespaces(std::move(Other.Namespaces)),
+ Records(std::move(Other.Records)),
+ Functions(std::move(Other.Functions)), Enums(std::move(Other.Enums)) {}
SymbolID USR; // Unique identifier for the decl described by this Info.
SmallString<16> Name; // Unqualified name of the decl.
llvm::SmallVector<Reference, 4>
Namespace; // List of parent namespaces for this decl.
std::vector<CommentInfo> Description; // Comment description of this decl.
+
+ // References to be populated after reducer phase.
+ llvm::SmallVector<Reference, 4> Namespaces;
+ llvm::SmallVector<Reference, 4> Records;
+ llvm::SmallVector<Reference, 4> Functions;
+ llvm::SmallVector<Reference, 4> Enums;
};
// Info for namespaces.
@@ -148,10 +174,10 @@
bool IsMethod = false; // Indicates whether this function is a class method.
Reference Parent; // Reference to the parent class decl for this method.
TypeInfo ReturnType; // Info about the return type of this function.
- llvm::SmallVector<FieldTypeInfo, 4> Params; // List of parameters.
- AccessSpecifier Access =
- AccessSpecifier::AS_none; // Access level for this method (public,
- // private, protected, none).
+ llvm::SmallVector<FieldTypeInfo, 4> Params; // List of parameters.
+ AccessSpecifier Access = AccessSpecifier::AS_none; // Access level for this
+ // method (public, private,
+ // protected, none).
};
// TODO: Expand to allow for documenting templating, inheritance access,
@@ -178,7 +204,79 @@
// TODO: Add functionality to include separate markdown pages.
+class InfoSet {
+public:
+ InfoSet() = default;
+
+ void insert(NamespaceInfo &&I);
+ void insert(RecordInfo &&I);
+ void insert(EnumInfo &&I);
+ void insert(FunctionInfo &&I);
+
+ /// Returns the info with a Key, if it exists. Valid until next insert().
+ template <typename T> T *find(SymbolID Key);
+
+ /// Populate the type references in all infos
+ void createReferences();
+
+ const std::vector<NamespaceInfo> &getNamespaceInfos() const {
+ return NamespaceInfos;
+ }
+ const std::vector<FunctionInfo> &getFunctionInfos() const {
+ return FunctionInfos;
+ }
+ const std::vector<RecordInfo> &getRecordInfos() const { return RecordInfos; }
+ const std::vector<EnumInfo> &getEnumInfos() const { return EnumInfos; }
+
+private:
+ void resolveReferences(llvm::SmallVectorImpl<Reference> &References,
+ Reference &Caller);
+ void resolveReferences(llvm::SmallVectorImpl<TypeInfo> &References,
+ Reference &Caller);
+ void resolveReferences(llvm::SmallVectorImpl<FieldTypeInfo> &References,
+ Reference &Caller);
+ void resolveReferences(llvm::SmallVectorImpl<MemberTypeInfo> &References,
+ Reference &Caller);
+ void resolveReferences(TypeInfo &TI, Reference &Caller);
+ void resolveReferences(Reference &Ref, Reference &Caller);
+ void addCaller(Info *I, Reference &Caller);
+
+ std::vector<NamespaceInfo> NamespaceInfos;
+ std::vector<FunctionInfo> FunctionInfos;
+ std::vector<RecordInfo> RecordInfos;
+ std::vector<EnumInfo> EnumInfos;
+ llvm::DenseMap<SymbolID, size_t> InfoIndex;
+};
+
} // namespace doc
} // namespace clang
+namespace llvm {
+
+// Provide DenseMapInfo for std::arrays.
+template <typename T, unsigned U> struct DenseMapInfo<std::array<T, U>> {
+ static inline std::array<T, U> getEmptyKey() { return std::array<T, U>(); }
+
+ static inline std::array<T, U> getTombstoneKey() {
+ return std::array<T, U>();
+ }
+
+ static unsigned getHashValue(ArrayRef<T> Val) {
+ assert(Val.data() != getEmptyKey().data() && "Cannot hash the empty key!");
+ assert(Val.data() != getTombstoneKey().data() &&
+ "Cannot hash the tombstone key!");
+ return (unsigned)(hash_value(Val));
+ }
+
+ static bool isEqual(ArrayRef<T> LHS, ArrayRef<T> RHS) {
+ if (RHS.data() == getEmptyKey().data())
+ return LHS.data() == getEmptyKey().data();
+ if (RHS.data() == getTombstoneKey().data())
+ return LHS.data() == getTombstoneKey().data();
+ return LHS == RHS;
+ }
+};
+
+} // namespace llvm
+
#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_DOC_REPRESENTATION_H
Index: clang-doc/Representation.cpp
===================================================================
--- /dev/null
+++ clang-doc/Representation.cpp
@@ -0,0 +1,223 @@
+///===-- ClangDocRepresentation.cpp - ClangDocRepresenation -----*- C++ -*-===//
+//
+// The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+
+#include "Representation.h"
+#include "llvm/ADT/STLExtras.h"
+#include "llvm/Support/raw_ostream.h"
+
+namespace clang {
+namespace doc {
+
+SymbolID StringToSymbol(llvm::StringRef StringUSR) {
+ SymbolID USR;
+ std::string HexString = fromHex(StringUSR);
+ std::copy(HexString.begin(), HexString.end(), USR.begin());
+ return USR;
+}
+
+static void mergeInfoBase(Info &L, Info &R) {
+ assert(L.USR == R.USR);
+ assert(L.Name == R.Name);
+ if (L.Namespace.empty())
+ L.Namespace = std::move(R.Namespace);
+ std::move(R.Description.begin(), R.Description.end(),
+ std::back_inserter(L.Description));
+}
+
+static void mergeSymbolInfoBase(SymbolInfo &L, SymbolInfo &R) {
+ mergeInfoBase(L, R);
+ if (R.DefLoc)
+ L.DefLoc = std::move(R.DefLoc);
+ L.Loc.insert(L.Loc.end(), R.Loc.begin(), R.Loc.end());
+}
+
+static void mergeInfo(NamespaceInfo &L, NamespaceInfo &&R) {
+ mergeInfoBase(L, R);
+}
+
+static void mergeInfo(RecordInfo &L, RecordInfo &&R) {
+ mergeSymbolInfoBase(L, R);
+ assert(L.TagType == R.TagType);
+ if (L.Members.empty())
+ L.Members = std::move(R.Members);
+ if (L.Parents.empty())
+ L.Parents = std::move(R.Parents);
+ if (L.VirtualParents.empty())
+ L.VirtualParents = std::move(R.VirtualParents);
+}
+
+static void mergeInfo(EnumInfo &L, EnumInfo &&R) {
+ mergeSymbolInfoBase(L, R);
+ assert(L.Scoped == R.Scoped);
+ if (L.Members.empty())
+ L.Members = std::move(R.Members);
+}
+
+static void mergeInfo(FunctionInfo &L, FunctionInfo &&R) {
+ mergeSymbolInfoBase(L, R);
+ assert(
+ (L.ReturnType.Type.RefType == InfoType::IT_default &&
+ L.ReturnType.Type.UnresolvedName == R.ReturnType.Type.UnresolvedName) ||
+ L.ReturnType.Type.USR == R.ReturnType.Type.USR);
+ assert(L.Access == R.Access);
+ if (L.Parent.USR.empty()) {
+ L.Parent.USR = R.Parent.USR;
+ L.Parent.RefType = R.Parent.RefType;
+ }
+ if (L.Params.empty())
+ L.Params = std::move(R.Params);
+}
+
+#define FIND_FUNC(X) \
+ template <> X *InfoSet::find(SymbolID Key) { \
+ auto I = InfoIndex.find(Key); \
+ if (I == InfoIndex.end()) \
+ return nullptr; \
+ return &X##s[I->second]; \
+ }
+
+FIND_FUNC(NamespaceInfo)
+FIND_FUNC(RecordInfo)
+FIND_FUNC(EnumInfo)
+FIND_FUNC(FunctionInfo)
+
+#undef FIND_FUNC
+
+#define INSERT_FUNC(X) \
+ void InfoSet::insert(X &&I) { \
+ auto R = InfoIndex.try_emplace(I.USR, X##s.size()); \
+ if (R.second) \
+ X##s.push_back(std::move(I)); \
+ else \
+ mergeInfo(X##s[R.first->second], std::move(I)); \
+ }
+
+INSERT_FUNC(NamespaceInfo)
+INSERT_FUNC(RecordInfo)
+INSERT_FUNC(EnumInfo)
+INSERT_FUNC(FunctionInfo)
+
+#undef INSERT_FUNC
+
+void InfoSet::createReferences() {
+ Reference Caller;
+ for (auto &I : NamespaceInfos) {
+ Caller.USR = I.USR;
+ Caller.RefType = InfoType::IT_namespace;
+ Caller.Ref = &I;
+ resolveReferences(I.Namespace, Caller);
+ }
+ for (auto &I : FunctionInfos) {
+ Caller.USR = I.USR;
+ Caller.RefType = InfoType::IT_function;
+ Caller.Ref = &I;
+ resolveReferences(I.Namespace, Caller);
+ resolveReferences(I.Parent, Caller);
+ resolveReferences(I.ReturnType, Caller);
+ resolveReferences(I.Params, Caller);
+ }
+ for (auto &I : RecordInfos) {
+ Caller.USR = I.USR;
+ Caller.RefType = InfoType::IT_record;
+ Caller.Ref = &I;
+ resolveReferences(I.Namespace, Caller);
+ resolveReferences(I.Members, Caller);
+ resolveReferences(I.Parents, Caller);
+ resolveReferences(I.VirtualParents, Caller);
+ }
+ for (auto &I : EnumInfos) {
+ Caller.USR = I.USR;
+ Caller.RefType = InfoType::IT_enum;
+ Caller.Ref = &I;
+ resolveReferences(I.Namespace, Caller);
+ }
+}
+
+void InfoSet::resolveReferences(llvm::SmallVectorImpl<Reference> &References,
+ Reference &Caller) {
+ for (auto &Ref : References)
+ resolveReferences(Ref, Caller);
+}
+
+void InfoSet::resolveReferences(llvm::SmallVectorImpl<TypeInfo> &References,
+ Reference &Caller) {
+ for (auto &Ref : References)
+ resolveReferences(Ref.Type, Caller);
+}
+
+void InfoSet::resolveReferences(
+ llvm::SmallVectorImpl<FieldTypeInfo> &References, Reference &Caller) {
+ for (auto &Ref : References)
+ resolveReferences(Ref.Type, Caller);
+}
+
+void InfoSet::resolveReferences(
+ llvm::SmallVectorImpl<MemberTypeInfo> &References, Reference &Caller) {
+ for (auto &Ref : References)
+ resolveReferences(Ref.Type, Caller);
+}
+
+void InfoSet::resolveReferences(TypeInfo &TI, Reference &Caller) {
+ resolveReferences(TI.Type, Caller);
+}
+
+void InfoSet::resolveReferences(Reference &Ref, Reference &Caller) {
+ switch (Ref.RefType) {
+ case InfoType::IT_namespace:
+ if (auto *I = find<NamespaceInfo>(Ref.USR)) {
+ Ref.Ref = I;
+ addCaller(I, Caller);
+ }
+ return;
+ case InfoType::IT_record:
+ if (auto *I = find<RecordInfo>(Ref.USR)) {
+ Ref.Ref = I;
+ addCaller(I, Caller);
+ }
+ return;
+ case InfoType::IT_function:
+ if (auto *I = find<FunctionInfo>(Ref.USR)) {
+ Ref.Ref = I;
+ addCaller(I, Caller);
+ }
+ return;
+ case InfoType::IT_enum:
+ if (auto *I = find<EnumInfo>(Ref.USR)) {
+ Ref.Ref = I;
+ addCaller(I, Caller);
+ }
+ return;
+ case InfoType::IT_default:
+ // We don't resolve non-USR references.
+ return;
+ }
+}
+
+void InfoSet::addCaller(Info *I, Reference &Caller) {
+ switch (Caller.RefType) {
+ case InfoType::IT_namespace:
+ I->Namespaces.push_back(Caller);
+ return;
+ case InfoType::IT_record:
+ I->Records.push_back(Caller);
+ return;
+ case InfoType::IT_function:
+ I->Functions.push_back(Caller);
+ return;
+ case InfoType::IT_enum:
+ I->Enums.push_back(Caller);
+ return;
+ default:
+ // We don't resolve non-USR references.
+ return;
+ }
+}
+
+} // namespace doc
+} // namespace clang
Index: clang-doc/Reducer.h
===================================================================
--- /dev/null
+++ clang-doc/Reducer.h
@@ -0,0 +1,26 @@
+///===-- ClangDocReducer.h - ClangDocReducer -------*- C++ -*-===//
+//
+// The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_DOC_REDUCER_H
+#define LLVM_CLANG_TOOLS_EXTRA_CLANG_DOC_REDUCER_H
+
+#include "Representation.h"
+#include "clang/Tooling/Execution.h"
+#include "clang/Tooling/Tooling.h"
+
+namespace clang {
+namespace doc {
+
+// Combine occurrences of the same info across translation units.
+std::unique_ptr<InfoSet> mergeInfos(tooling::ToolResults *Results);
+
+} // namespace doc
+} // namespace clang
+
+#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_DOC_REDUCER_H
Index: clang-doc/Reducer.cpp
===================================================================
--- /dev/null
+++ clang-doc/Reducer.cpp
@@ -0,0 +1,35 @@
+///===-- ClangDocReducer.h - ClangDocReducer -------*- C++ -*-===//
+//
+// The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+
+#include "Reducer.h"
+#include "BitcodeReader.h"
+#include "Representation.h"
+
+namespace clang {
+namespace doc {
+
+std::unique_ptr<InfoSet> mergeInfos(tooling::ToolResults *Results) {
+ std::unique_ptr<InfoSet> UniqueInfos = llvm::make_unique<InfoSet>();
+ bool Err = false;
+ Results->forEachResult([&](StringRef Key, StringRef Value) {
+ llvm::BitstreamCursor Stream(Value);
+ ClangDocBitcodeReader Reader(Stream);
+ if (!Reader.readBitstream(*UniqueInfos)) {
+ Err = true;
+ return;
+ }
+ });
+ if (Err)
+ return nullptr;
+ UniqueInfos->createReferences();
+ return UniqueInfos;
+}
+
+} // namespace doc
+} // namespace clang
Index: clang-doc/CMakeLists.txt
===================================================================
--- clang-doc/CMakeLists.txt
+++ clang-doc/CMakeLists.txt
@@ -3,9 +3,12 @@
)
add_clang_library(clangDoc
+ BitcodeReader.cpp
BitcodeWriter.cpp
ClangDoc.cpp
Mapper.cpp
+ Reducer.cpp
+ Representation.cpp
Serialize.cpp
LINK_LIBS
Index: clang-doc/BitcodeWriter.h
===================================================================
--- clang-doc/BitcodeWriter.h
+++ clang-doc/BitcodeWriter.h
@@ -34,7 +34,7 @@
static const unsigned VersionNumber = 1;
struct BitCodeConstants {
- static constexpr unsigned RecordSize = 16U;
+ static constexpr unsigned RecordSize = 32U;
static constexpr unsigned SignatureBitSize = 8U;
static constexpr unsigned SubblockIDSize = 4U;
static constexpr unsigned BoolSize = 1U;
@@ -45,6 +45,7 @@
static constexpr unsigned ReferenceTypeSize = 8U;
static constexpr unsigned USRLengthSize = 6U;
static constexpr unsigned USRBitLengthSize = 8U;
+ static constexpr char Signature[4] = {'D', 'O', 'C', 'S'};
};
// New Ids need to be added to both the enum here and the relevant IdNameMap in
@@ -65,7 +66,9 @@
// New Ids need to be added to the enum here, and to the relevant IdNameMap and
// initialization list in the implementation file.
-#define INFORECORDS(X) X##_USR, X##_NAME, X##_NAMESPACE
+#define INFORECORDS(X) \
+ X##_USR, X##_NAME, X##_NAMESPACE, X##_NAMESPACES, X##_RECORDS, \
+ X##_FUNCTIONS, X##_ENUMS
enum RecordId {
VERSION = 1,
@@ -124,7 +127,7 @@
#ifndef NDEBUG // Don't want explicit dtor unless needed.
~ClangDocBitcodeWriter() {
// Check that the static size is large-enough.
- assert(Record.capacity() > BitCodeConstants::RecordSize);
+ assert(Record.capacity() == BitCodeConstants::RecordSize);
}
#endif
@@ -137,6 +140,7 @@
void emitBlock(const FieldTypeInfo &B);
void emitBlock(const MemberTypeInfo &B);
void emitBlock(const CommentInfo &B);
+ void emitInfoSet(const InfoSet &ISet);
private:
class AbbreviationMap {
Index: clang-doc/BitcodeWriter.cpp
===================================================================
--- clang-doc/BitcodeWriter.cpp
+++ clang-doc/BitcodeWriter.cpp
@@ -161,29 +161,45 @@
{NAMESPACE_USR, {"USR", &SymbolIDAbbrev}},
{NAMESPACE_NAME, {"Name", &StringAbbrev}},
{NAMESPACE_NAMESPACE, {"Namespace", &ReferenceAbbrev}},
+ {NAMESPACE_NAMESPACES, {"Namespaces", &ReferenceAbbrev}},
+ {NAMESPACE_RECORDS, {"Records", &ReferenceAbbrev}},
+ {NAMESPACE_FUNCTIONS, {"Functions", &ReferenceAbbrev}},
+ {NAMESPACE_ENUMS, {"Enums", &ReferenceAbbrev}},
{ENUM_USR, {"USR", &SymbolIDAbbrev}},
{ENUM_NAME, {"Name", &StringAbbrev}},
{ENUM_NAMESPACE, {"Namespace", &ReferenceAbbrev}},
{ENUM_DEFLOCATION, {"DefLocation", &LocationAbbrev}},
{ENUM_LOCATION, {"Location", &LocationAbbrev}},
{ENUM_MEMBER, {"Member", &StringAbbrev}},
{ENUM_SCOPED, {"Scoped", &BoolAbbrev}},
+ {ENUM_NAMESPACES, {"Namespaces", &ReferenceAbbrev}},
+ {ENUM_RECORDS, {"Records", &ReferenceAbbrev}},
+ {ENUM_FUNCTIONS, {"Functions", &ReferenceAbbrev}},
+ {ENUM_ENUMS, {"Enums", &ReferenceAbbrev}},
{RECORD_USR, {"USR", &SymbolIDAbbrev}},
{RECORD_NAME, {"Name", &StringAbbrev}},
{RECORD_NAMESPACE, {"Namespace", &ReferenceAbbrev}},
{RECORD_DEFLOCATION, {"DefLocation", &LocationAbbrev}},
{RECORD_LOCATION, {"Location", &LocationAbbrev}},
{RECORD_TAG_TYPE, {"TagType", &IntAbbrev}},
{RECORD_PARENT, {"Parent", &ReferenceAbbrev}},
{RECORD_VPARENT, {"VParent", &ReferenceAbbrev}},
+ {RECORD_NAMESPACES, {"Namespaces", &ReferenceAbbrev}},
+ {RECORD_RECORDS, {"Records", &ReferenceAbbrev}},
+ {RECORD_FUNCTIONS, {"Functions", &ReferenceAbbrev}},
+ {RECORD_ENUMS, {"Enums", &ReferenceAbbrev}},
{FUNCTION_USR, {"USR", &SymbolIDAbbrev}},
{FUNCTION_NAME, {"Name", &StringAbbrev}},
{FUNCTION_NAMESPACE, {"Namespace", &ReferenceAbbrev}},
{FUNCTION_DEFLOCATION, {"DefLocation", &LocationAbbrev}},
{FUNCTION_LOCATION, {"Location", &LocationAbbrev}},
{FUNCTION_PARENT, {"Parent", &ReferenceAbbrev}},
{FUNCTION_ACCESS, {"Access", &IntAbbrev}},
- {FUNCTION_IS_METHOD, {"IsMethod", &BoolAbbrev}}};
+ {FUNCTION_IS_METHOD, {"IsMethod", &BoolAbbrev}},
+ {FUNCTION_NAMESPACES, {"Namespaces", &ReferenceAbbrev}},
+ {FUNCTION_RECORDS, {"Records", &ReferenceAbbrev}},
+ {FUNCTION_FUNCTIONS, {"Functions", &ReferenceAbbrev}},
+ {FUNCTION_ENUMS, {"Enums", &ReferenceAbbrev}}};
assert(Inits.size() == RecordIdCount);
for (const auto &Init : Inits) {
RecordIdNameMap[Init.first] = Init.second;
@@ -212,22 +228,29 @@
// Enum Block
{BI_ENUM_BLOCK_ID,
{ENUM_USR, ENUM_NAME, ENUM_NAMESPACE, ENUM_DEFLOCATION, ENUM_LOCATION,
- ENUM_MEMBER, ENUM_SCOPED}},
+ ENUM_MEMBER, ENUM_SCOPED, ENUM_NAMESPACES, ENUM_RECORDS,
+ ENUM_FUNCTIONS, ENUM_ENUMS}},
// Namespace Block
{BI_NAMESPACE_BLOCK_ID,
- {NAMESPACE_USR, NAMESPACE_NAME, NAMESPACE_NAMESPACE}},
+ {NAMESPACE_USR, NAMESPACE_NAME, NAMESPACE_NAMESPACE,
+ NAMESPACE_NAMESPACES, NAMESPACE_RECORDS, NAMESPACE_FUNCTIONS,
+ NAMESPACE_ENUMS}},
// Record Block
{BI_RECORD_BLOCK_ID,
{RECORD_USR, RECORD_NAME, RECORD_NAMESPACE, RECORD_DEFLOCATION,
- RECORD_LOCATION, RECORD_TAG_TYPE, RECORD_PARENT, RECORD_VPARENT}},
+ RECORD_LOCATION, RECORD_TAG_TYPE, RECORD_PARENT, RECORD_VPARENT,
+ RECORD_NAMESPACES, RECORD_RECORDS, RECORD_FUNCTIONS, RECORD_ENUMS}},
// Function Block
{BI_FUNCTION_BLOCK_ID,
{FUNCTION_USR, FUNCTION_NAME, FUNCTION_NAMESPACE, FUNCTION_DEFLOCATION,
FUNCTION_LOCATION, FUNCTION_PARENT, FUNCTION_ACCESS,
- FUNCTION_IS_METHOD}}};
+ FUNCTION_IS_METHOD, FUNCTION_NAMESPACES, FUNCTION_RECORDS,
+ FUNCTION_FUNCTIONS, FUNCTION_ENUMS}}};
// AbbreviationMap
+constexpr char BitCodeConstants::Signature[];
+
void ClangDocBitcodeWriter::AbbreviationMap::add(RecordId RID,
unsigned AbbrevID) {
assert(RecordIdNameMap[RID] && "Unknown RecordId.");
@@ -246,7 +269,7 @@
/// \brief Emits the magic number header to check that its the right format,
/// in this case, 'DOCS'.
void ClangDocBitcodeWriter::emitHeader() {
- for (char C : llvm::StringRef("DOCS"))
+ for (char C : BitCodeConstants::Signature)
Stream.Emit((unsigned)C, BitCodeConstants::SignatureBitSize);
}
@@ -428,8 +451,7 @@
void ClangDocBitcodeWriter::emitBlock(const CommentInfo &I) {
StreamSubBlockGuard Block(Stream, BI_COMMENT_BLOCK_ID);
- for (const auto &L :
- std::vector<std::pair<llvm::StringRef, RecordId>>{
+ for (const auto &L : std::vector<std::pair<llvm::StringRef, RecordId>>{
{I.Kind, COMMENT_KIND},
{I.Text, COMMENT_TEXT},
{I.Name, COMMENT_NAME},
@@ -455,7 +477,15 @@
for (const auto &N : I.Namespace) \
emitRecord(N, X##_NAMESPACE); \
for (const auto &CI : I.Description) \
- emitBlock(CI);
+ emitBlock(CI); \
+ for (const auto &R : I.Namespaces) \
+ emitRecord(R, X##_NAMESPACES); \
+ for (const auto &R : I.Records) \
+ emitRecord(R, X##_RECORDS); \
+ for (const auto &R : I.Functions) \
+ emitRecord(R, X##_FUNCTIONS); \
+ for (const auto &R : I.Enums) \
+ emitRecord(R, X##_ENUMS);
void ClangDocBitcodeWriter::emitBlock(const NamespaceInfo &I) {
StreamSubBlockGuard Block(Stream, BI_NAMESPACE_BLOCK_ID);
@@ -506,5 +536,12 @@
#undef EMITINFO
+void ClangDocBitcodeWriter::emitInfoSet(const InfoSet &ISet) {
+ for (const auto &I : ISet.getNamespaceInfos()) emitBlock(I);
+ for (const auto &I : ISet.getFunctionInfos()) emitBlock(I);
+ for (const auto &I : ISet.getRecordInfos()) emitBlock(I);
+ for (const auto &I : ISet.getEnumInfos()) emitBlock(I);
+}
+
} // namespace doc
} // namespace clang
Index: clang-doc/BitcodeReader.h
===================================================================
--- /dev/null
+++ clang-doc/BitcodeReader.h
@@ -0,0 +1,95 @@
+//===-- BitcodeReader.h - ClangDoc Bitcode Reader --------------*- C++ -*-===//
+//
+// The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+//
+// This file implements a reader for parsing the clang-doc internal
+// representation to LLVM bitcode. The reader takes in a stream of bits and
+// generates the set of infos that it represents.
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_DOC_BITCODEREADER_H
+#define LLVM_CLANG_TOOLS_EXTRA_CLANG_DOC_BITCODEREADER_H
+
+#include "BitcodeWriter.h"
+#include "Representation.h"
+#include "clang/AST/AST.h"
+#include "llvm/ADT/SmallVector.h"
+#include "llvm/Bitcode/BitstreamReader.h"
+
+namespace clang {
+namespace doc {
+
+// Class to read bitstream into an InfoSet collection
+class ClangDocBitcodeReader {
+public:
+ ClangDocBitcodeReader(llvm::BitstreamCursor &Stream) : Stream(Stream) {}
+
+ bool readBitstream(InfoSet &IS);
+
+private:
+ enum class Cursor { BadBlock = 1, Record, BlockEnd, BlockBegin };
+
+ // Top level parsing
+ bool validateStream();
+ bool readVersion();
+ bool readBlockInfoBlock();
+
+ template <typename TInfo>
+ bool readBlockToInfo(unsigned ID, InfoSet &IS);
+
+ // Reading records
+ template <typename TInfo> bool readRecord(unsigned ID, TInfo &I);
+
+ bool parseRecord(unsigned ID, llvm::StringRef Blob, unsigned VersionNo);
+ bool parseRecord(unsigned ID, llvm::StringRef Blob, NamespaceInfo &I);
+ bool parseRecord(unsigned ID, llvm::StringRef Blob, RecordInfo &I);
+ bool parseRecord(unsigned ID, llvm::StringRef Blob, EnumInfo &I);
+ bool parseRecord(unsigned ID, llvm::StringRef Blob, FunctionInfo &I);
+ bool parseRecord(unsigned ID, llvm::StringRef Blob, TypeInfo &I);
+ bool parseRecord(unsigned ID, llvm::StringRef Blob, FieldTypeInfo &I);
+ bool parseRecord(unsigned ID, llvm::StringRef Blob, MemberTypeInfo &I);
+ bool parseRecord(unsigned ID, llvm::StringRef Blob, CommentInfo &I);
+
+ void storeData(llvm::SmallVectorImpl<char> &Field, llvm::StringRef Blob);
+ void storeData(bool &Field, llvm::StringRef Blob);
+ void storeData(int &Field, llvm::StringRef Blob);
+ void storeData(AccessSpecifier &Field, llvm::StringRef Blob);
+ void storeData(TagTypeKind &Field, llvm::StringRef Blob);
+ void storeData(llvm::Optional<Location> &Field, llvm::StringRef Blob);
+ void storeData(SymbolID &Field, llvm::StringRef Blob);
+ void storeData(Reference &Field, llvm::StringRef Blob);
+ void storeData(llvm::SmallVectorImpl<Location> &Field, llvm::StringRef Blob);
+ void storeData(llvm::SmallVectorImpl<Reference> &Field, llvm::StringRef Blob);
+ void storeData(llvm::SmallVectorImpl<llvm::SmallString<16>> &Field,
+ llvm::StringRef Blob);
+
+ // Reading blocks
+ template <typename TInfo> bool readBlock(unsigned ID, TInfo &I);
+ template <typename TInfo> bool readSubBlock(unsigned ID, TInfo &I);
+ Cursor skipUntilRecordOrBlock(unsigned &BlockOrRecordID);
+
+ // Helpers
+ CommentInfo &getCommentInfo(const unsigned int I);
+ CommentInfo &getCommentInfo(TypeInfo &I);
+ CommentInfo &getCommentInfo(Info &I);
+ CommentInfo &getCommentInfo(CommentInfo &I);
+ CommentInfo &getCommentInfo(std::unique_ptr<CommentInfo> &I);
+
+ template <typename TInfo, typename TTypeInfo>
+ void addTypeInfo(TInfo &I, TTypeInfo &&T);
+
+ llvm::BitstreamCursor &Stream;
+ llvm::SmallVector<uint64_t, 1024> Record;
+ Optional<llvm::BitstreamBlockInfo> BlockInfo;
+};
+
+} // namespace doc
+} // namespace clang
+
+#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_DOC_BITCODEREADER_H
Index: clang-doc/BitcodeReader.cpp
===================================================================
--- /dev/null
+++ clang-doc/BitcodeReader.cpp
@@ -0,0 +1,568 @@
+//===-- BitcodeReader.cpp - ClangDoc Bitcode Reader ------------*- C++ -*-===//
+//
+// The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+
+#include "BitcodeReader.h"
+#include "llvm/ADT/IndexedMap.h"
+#include "llvm/ADT/Optional.h"
+#include "llvm/Support/raw_ostream.h"
+
+namespace clang {
+namespace doc {
+
+// Store data
+void ClangDocBitcodeReader::storeData(llvm::SmallVectorImpl<char> &Field,
+ llvm::StringRef Blob) {
+ Field.assign(Blob.begin(), Blob.end());
+}
+
+void ClangDocBitcodeReader::storeData(SymbolID &Field, llvm::StringRef Blob) {
+ assert(Record[0] == 20);
+ // First position in the record is the length of the following array, so we
+ // copy the following elements to the field.
+ for (int I = 0, E = Record[0]; I < E; ++I)
+ Field[I] = Record[I + 1];
+}
+
+void ClangDocBitcodeReader::storeData(bool &Field, llvm::StringRef Blob) {
+ Field = (bool)Record[0];
+}
+
+void ClangDocBitcodeReader::storeData(int &Field, llvm::StringRef Blob) {
+ Field = (int)Record[0];
+}
+
+void ClangDocBitcodeReader::storeData(AccessSpecifier &Field,
+ llvm::StringRef Blob) {
+ Field = (AccessSpecifier)Record[0];
+}
+
+void ClangDocBitcodeReader::storeData(TagTypeKind &Field,
+ llvm::StringRef Blob) {
+ Field = (TagTypeKind)Record[0];
+}
+
+void ClangDocBitcodeReader::storeData(llvm::Optional<Location> &Field,
+ llvm::StringRef Blob) {
+ Field.emplace((int)Record[0], Blob);
+}
+
+void ClangDocBitcodeReader::storeData(Reference &Field, llvm::StringRef Blob) {
+ InfoType IT = (InfoType)Record[0];
+ if (IT == InfoType::IT_default)
+ Field = Reference(Blob);
+ else
+ Field = Reference(StringToSymbol(Blob), (InfoType)Record[0]);
+}
+
+void ClangDocBitcodeReader::storeData(
+ llvm::SmallVectorImpl<llvm::SmallString<16>> &Field, llvm::StringRef Blob) {
+ Field.push_back(Blob);
+}
+
+void ClangDocBitcodeReader::storeData(llvm::SmallVectorImpl<Location> &Field,
+ llvm::StringRef Blob) {
+ Field.emplace_back((int)Record[0], Blob);
+}
+
+void ClangDocBitcodeReader::storeData(llvm::SmallVectorImpl<Reference> &Field,
+ llvm::StringRef Blob) {
+ InfoType IT = (InfoType)Record[0];
+ if (IT == InfoType::IT_default)
+ Field.emplace_back(Blob);
+ else
+ Field.emplace_back(StringToSymbol(Blob), (InfoType)Record[0]);
+}
+
+// Read records
+
+template <typename TInfo>
+bool ClangDocBitcodeReader::readRecord(unsigned ID, TInfo &I) {
+ Record.clear();
+ llvm::StringRef Blob;
+ unsigned RecID = Stream.readRecord(ID, Record, &Blob);
+ return parseRecord(RecID, Blob, I);
+ return false;
+}
+
+bool ClangDocBitcodeReader::parseRecord(unsigned ID, llvm::StringRef Blob,
+ unsigned VersionNo) {
+ if (ID == VERSION && Record[0] == VersionNo)
+ return true;
+ return false;
+}
+
+bool ClangDocBitcodeReader::parseRecord(unsigned ID, llvm::StringRef Blob,
+ NamespaceInfo &I) {
+ switch (ID) {
+ case NAMESPACE_USR:
+ storeData(I.USR, Blob);
+ return true;
+ case NAMESPACE_NAME:
+ storeData(I.Name, Blob);
+ return true;
+ case NAMESPACE_NAMESPACE:
+ storeData(I.Namespace, Blob);
+ return true;
+ case NAMESPACE_NAMESPACES:
+ storeData(I.Namespaces, Blob);
+ return true;
+ case NAMESPACE_RECORDS:
+ storeData(I.Records, Blob);
+ return true;
+ case NAMESPACE_FUNCTIONS:
+ storeData(I.Functions, Blob);
+ return true;
+ case NAMESPACE_ENUMS:
+ storeData(I.Enums, Blob);
+ return true;
+ default:
+ return false;
+ }
+}
+
+bool ClangDocBitcodeReader::parseRecord(unsigned ID, llvm::StringRef Blob,
+ RecordInfo &I) {
+ switch (ID) {
+ case RECORD_USR:
+ storeData(I.USR, Blob);
+ return true;
+ case RECORD_NAME:
+ storeData(I.Name, Blob);
+ return true;
+ case RECORD_NAMESPACE:
+ storeData(I.Namespace, Blob);
+ return true;
+ case RECORD_NAMESPACES:
+ storeData(I.Namespaces, Blob);
+ return true;
+ case RECORD_RECORDS:
+ storeData(I.Records, Blob);
+ return true;
+ case RECORD_FUNCTIONS:
+ storeData(I.Functions, Blob);
+ return true;
+ case RECORD_ENUMS:
+ storeData(I.Enums, Blob);
+ return true;
+ case RECORD_PARENT:
+ storeData(I.Parents, Blob);
+ return true;
+ case RECORD_VPARENT:
+ storeData(I.VirtualParents, Blob);
+ return true;
+ case RECORD_DEFLOCATION:
+ storeData(I.DefLoc, Blob);
+ return true;
+ case RECORD_LOCATION:
+ storeData(I.Loc, Blob);
+ return true;
+ case RECORD_TAG_TYPE:
+ storeData(I.TagType, Blob);
+ return true;
+ default:
+ return false;
+ }
+}
+
+bool ClangDocBitcodeReader::parseRecord(unsigned ID, llvm::StringRef Blob,
+ EnumInfo &I) {
+ switch (ID) {
+ case ENUM_USR:
+ storeData(I.USR, Blob);
+ return true;
+ case ENUM_NAME:
+ storeData(I.Name, Blob);
+ return true;
+ case ENUM_NAMESPACE:
+ storeData(I.Namespace, Blob);
+ return true;
+ case ENUM_NAMESPACES:
+ storeData(I.Namespaces, Blob);
+ return true;
+ case ENUM_RECORDS:
+ storeData(I.Records, Blob);
+ return true;
+ case ENUM_FUNCTIONS:
+ storeData(I.Functions, Blob);
+ return true;
+ case ENUM_ENUMS:
+ storeData(I.Enums, Blob);
+ return true;
+ case ENUM_DEFLOCATION:
+ storeData(I.DefLoc, Blob);
+ return true;
+ case ENUM_LOCATION:
+ storeData(I.Loc, Blob);
+ return true;
+ case ENUM_MEMBER:
+ storeData(I.Members, Blob);
+ return true;
+ case ENUM_SCOPED:
+ storeData(I.Scoped, Blob);
+ return true;
+ default:
+ return false;
+ }
+}
+
+bool ClangDocBitcodeReader::parseRecord(unsigned ID, llvm::StringRef Blob,
+ FunctionInfo &I) {
+ switch (ID) {
+ case FUNCTION_USR:
+ storeData(I.USR, Blob);
+ return true;
+ case FUNCTION_NAME:
+ storeData(I.Name, Blob);
+ return true;
+ case FUNCTION_NAMESPACE:
+ storeData(I.Namespace, Blob);
+ return true;
+ case FUNCTION_NAMESPACES:
+ storeData(I.Namespaces, Blob);
+ return true;
+ case FUNCTION_RECORDS:
+ storeData(I.Records, Blob);
+ return true;
+ case FUNCTION_FUNCTIONS:
+ storeData(I.Functions, Blob);
+ return true;
+ case FUNCTION_ENUMS:
+ storeData(I.Enums, Blob);
+ return true;
+ case FUNCTION_PARENT:
+ storeData(I.Parent, Blob);
+ return true;
+ case FUNCTION_DEFLOCATION:
+ storeData(I.DefLoc, Blob);
+ return true;
+ case FUNCTION_LOCATION:
+ storeData(I.Loc, Blob);
+ return true;
+ case FUNCTION_ACCESS:
+ storeData(I.Access, Blob);
+ return true;
+ case FUNCTION_IS_METHOD:
+ storeData(I.IsMethod, Blob);
+ return true;
+ default:
+ return false;
+ }
+}
+
+bool ClangDocBitcodeReader::parseRecord(unsigned ID, llvm::StringRef Blob,
+ TypeInfo &I) {
+ switch (ID) {
+ case TYPE_REF:
+ storeData(I.Type, Blob);
+ return true;
+ default:
+ return false;
+ }
+}
+
+bool ClangDocBitcodeReader::parseRecord(unsigned ID, llvm::StringRef Blob,
+ FieldTypeInfo &I) {
+ switch (ID) {
+ case FIELD_TYPE_REF:
+ storeData(I.Type, Blob);
+ return true;
+ case FIELD_TYPE_NAME:
+ storeData(I.Name, Blob);
+ return true;
+ default:
+ return false;
+ }
+}
+
+bool ClangDocBitcodeReader::parseRecord(unsigned ID, llvm::StringRef Blob,
+ MemberTypeInfo &I) {
+ switch (ID) {
+ case MEMBER_TYPE_REF:
+ storeData(I.Type, Blob);
+ return true;
+ case MEMBER_TYPE_NAME:
+ storeData(I.Name, Blob);
+ return true;
+ case MEMBER_TYPE_ACCESS:
+ storeData(I.Access, Blob);
+ return true;
+ default:
+ return false;
+ }
+}
+
+bool ClangDocBitcodeReader::parseRecord(unsigned ID, llvm::StringRef Blob,
+ CommentInfo &I) {
+ switch (ID) {
+ case COMMENT_KIND:
+ storeData(I.Kind, Blob);
+ return true;
+ case COMMENT_TEXT:
+ storeData(I.Text, Blob);
+ return true;
+ case COMMENT_NAME:
+ storeData(I.Name, Blob);
+ return true;
+ case COMMENT_DIRECTION:
+ storeData(I.Direction, Blob);
+ return true;
+ case COMMENT_PARAMNAME:
+ storeData(I.ParamName, Blob);
+ return true;
+ case COMMENT_CLOSENAME:
+ storeData(I.CloseName, Blob);
+ return true;
+ case COMMENT_ATTRKEY:
+ storeData(I.AttrKeys, Blob);
+ return true;
+ case COMMENT_ATTRVAL:
+ storeData(I.AttrValues, Blob);
+ return true;
+ case COMMENT_ARG:
+ storeData(I.Args, Blob);
+ return true;
+ case COMMENT_SELFCLOSING:
+ storeData(I.SelfClosing, Blob);
+ return true;
+ case COMMENT_EXPLICIT:
+ storeData(I.Explicit, Blob);
+ return true;
+ default:
+ return false;
+ }
+}
+
+// Helpers
+CommentInfo &ClangDocBitcodeReader::getCommentInfo(const unsigned int I) {
+ llvm::errs() << "Cannot have comment subblock.\n";
+ exit(1);
+}
+
+CommentInfo &ClangDocBitcodeReader::getCommentInfo(TypeInfo &I) {
+ llvm::errs() << "Cannot have comment subblock.\n";
+ exit(1);
+}
+
+CommentInfo &ClangDocBitcodeReader::getCommentInfo(Info &I) {
+ I.Description.emplace_back();
+ return I.Description.back();
+}
+
+CommentInfo &ClangDocBitcodeReader::getCommentInfo(CommentInfo &I) {
+ I.Children.emplace_back(llvm::make_unique<CommentInfo>());
+ return *I.Children.back();
+}
+
+CommentInfo &
+ClangDocBitcodeReader::getCommentInfo(std::unique_ptr<CommentInfo> &I) {
+ return getCommentInfo(*I);
+}
+
+template <typename TInfo, typename TTypeInfo>
+void ClangDocBitcodeReader::addTypeInfo(TInfo &I, TTypeInfo &&T) {
+ llvm::errs() << "Invalid type for info.\n";
+ exit(1);
+}
+
+template <>
+void ClangDocBitcodeReader::addTypeInfo(RecordInfo &I, MemberTypeInfo &&T) {
+ I.Members.emplace_back(std::move(T));
+}
+
+template <>
+void ClangDocBitcodeReader::addTypeInfo(FunctionInfo &I, TypeInfo &&T) {
+ I.ReturnType = std::move(T);
+}
+
+template <>
+void ClangDocBitcodeReader::addTypeInfo(FunctionInfo &I, FieldTypeInfo &&T) {
+ I.Params.emplace_back(std::move(T));
+}
+
+// Read blocks
+template <typename T> bool ClangDocBitcodeReader::readBlock(unsigned ID, T &I) {
+ if (Stream.EnterSubBlock(ID))
+ return false;
+
+ while (true) {
+ unsigned BlockOrCode = 0;
+ Cursor Res = skipUntilRecordOrBlock(BlockOrCode);
+
+ switch (Res) {
+ case Cursor::BadBlock:
+ return false;
+ case Cursor::BlockEnd:
+ return true;
+ case Cursor::BlockBegin:
+ if (readSubBlock(BlockOrCode, I))
+ continue;
+ if (!Stream.SkipBlock())
+ return false;
+ continue;
+ case Cursor::Record:
+ break;
+ }
+ if (!readRecord(BlockOrCode, I))
+ return false;
+ }
+}
+
+template <typename TInfo>
+bool ClangDocBitcodeReader::readSubBlock(unsigned ID, TInfo &I) {
+ switch (ID) {
+ // Blocks can only have Comment or TypeInfo subblocks
+ case BI_COMMENT_BLOCK_ID:
+ if (readBlock(ID, getCommentInfo(I)))
+ return true;
+ return false;
+ case BI_TYPE_BLOCK_ID: {
+ TypeInfo T;
+ if (readBlock(ID, T)) {
+ addTypeInfo(I, std::move(T));
+ return true;
+ }
+ }
+ case BI_FIELD_TYPE_BLOCK_ID: {
+ FieldTypeInfo T;
+ if (readBlock(ID, T)) {
+ addTypeInfo(I, std::move(T));
+ return true;
+ }
+ }
+ case BI_MEMBER_TYPE_BLOCK_ID: {
+ MemberTypeInfo T;
+ if (readBlock(ID, T)) {
+ addTypeInfo(I, std::move(T));
+ return true;
+ }
+ return false;
+ }
+ default:
+ llvm::errs() << "Invalid subblock type.\n";
+ return false;
+ }
+}
+
+ClangDocBitcodeReader::Cursor
+ClangDocBitcodeReader::skipUntilRecordOrBlock(unsigned &BlockOrRecordID) {
+ BlockOrRecordID = 0;
+
+ while (!Stream.AtEndOfStream()) {
+ unsigned Code = Stream.ReadCode();
+
+ switch ((llvm::bitc::FixedAbbrevIDs)Code) {
+ case llvm::bitc::ENTER_SUBBLOCK:
+ BlockOrRecordID = Stream.ReadSubBlockID();
+ return Cursor::BlockBegin;
+ case llvm::bitc::END_BLOCK:
+ if (Stream.ReadBlockEnd())
+ return Cursor::BadBlock;
+ return Cursor::BlockEnd;
+ case llvm::bitc::DEFINE_ABBREV:
+ Stream.ReadAbbrevRecord();
+ continue;
+ case llvm::bitc::UNABBREV_RECORD:
+ return Cursor::BadBlock;
+ default:
+ BlockOrRecordID = Code;
+ return Cursor::Record;
+ }
+ }
+ llvm_unreachable("Premature stream end.");
+}
+
+// Validation and overview
+
+bool ClangDocBitcodeReader::validateStream() {
+ if (Stream.AtEndOfStream())
+ return false;
+
+ // Sniff for the signature.
+ if (Stream.Read(8) != BitCodeConstants::Signature[0] ||
+ Stream.Read(8) != BitCodeConstants::Signature[1] ||
+ Stream.Read(8) != BitCodeConstants::Signature[2] ||
+ Stream.Read(8) != BitCodeConstants::Signature[3])
+ return false;
+ return true;
+}
+
+bool ClangDocBitcodeReader::readBlockInfoBlock() {
+ BlockInfo = Stream.ReadBlockInfoBlock();
+ if (!BlockInfo)
+ return false;
+ Stream.setBlockInfo(&*BlockInfo);
+ return true;
+}
+
+// Entry point
+bool ClangDocBitcodeReader::readBitstream(InfoSet &IS) {
+ if (!validateStream())
+ return false;
+
+ // Read the top level blocks.
+ while (!Stream.AtEndOfStream()) {
+ unsigned Code = Stream.ReadCode();
+ if (Code != llvm::bitc::ENTER_SUBBLOCK)
+ return false;
+
+ unsigned ID = Stream.ReadSubBlockID();
+ switch (ID) {
+ // NamedType and Comment blocks should not appear at the top level
+ case BI_TYPE_BLOCK_ID:
+ case BI_FIELD_TYPE_BLOCK_ID:
+ case BI_MEMBER_TYPE_BLOCK_ID:
+ case BI_COMMENT_BLOCK_ID:
+ llvm::errs() << "Invalid top level block.\n";
+ return false;
+ case BI_VERSION_BLOCK_ID:
+ if (readBlock(ID, VersionNumber))
+ continue;
+ return false;
+ case llvm::bitc::BLOCKINFO_BLOCK_ID:
+ if (readBlockInfoBlock())
+ continue;
+ return false;
+ case BI_NAMESPACE_BLOCK_ID:
+ if (!readBlockToInfo<NamespaceInfo>(ID, IS))
+ return false;
+ continue;
+ case BI_RECORD_BLOCK_ID:
+ if (!readBlockToInfo<RecordInfo>(ID, IS))
+ return false;
+ continue;
+ case BI_ENUM_BLOCK_ID:
+ if (!readBlockToInfo<EnumInfo>(ID, IS))
+ return false;
+ continue;
+ case BI_FUNCTION_BLOCK_ID:
+ if (!readBlockToInfo<FunctionInfo>(ID, IS))
+ return false;
+ continue;
+ default:
+ if (!Stream.SkipBlock())
+ return false;
+ continue;
+ }
+ }
+ return true;
+}
+
+template <typename TInfo>
+bool ClangDocBitcodeReader::readBlockToInfo(unsigned ID, InfoSet &IS) {
+ TInfo I;
+ if (!readBlock(ID, I)) {
+ llvm::errs() << "Error reading from block.\n";
+ return false;
+ }
+ IS.insert(std::move(I));
+ return true;
+}
+
+} // namespace doc
+} // namespace clang
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
