xref: /llvm-project/clang-tools-extra/clang-doc/BitcodeWriter.cpp (revision 91b38c6aaddefabad2a4c959ea3865e356761ed5) 
1 //===--  BitcodeWriter.cpp - ClangDoc Bitcode Writer ------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #include "BitcodeWriter.h"
10 #include "llvm/ADT/IndexedMap.h"
11 #include <initializer_list>
12 
13 namespace clang {
14 namespace doc {
15 
16 // Empty SymbolID for comparison, so we don't have to construct one every time.
17 static const SymbolID EmptySID = SymbolID();
18 
19 // Since id enums are not zero-indexed, we need to transform the given id into
20 // its associated index.
21 struct BlockIdToIndexFunctor {
22   using argument_type = unsigned;
23   unsigned operator()(unsigned ID) const { return ID - BI_FIRST; }
24 };
25 
26 struct RecordIdToIndexFunctor {
27   using argument_type = unsigned;
28   unsigned operator()(unsigned ID) const { return ID - RI_FIRST; }
29 };
30 
31 using AbbrevDsc = void (*)(std::shared_ptr<llvm::BitCodeAbbrev> &Abbrev);
32 
33 static void AbbrevGen(std::shared_ptr<llvm::BitCodeAbbrev> &Abbrev,
34                       const std::initializer_list<llvm::BitCodeAbbrevOp> Ops) {
35   for (const auto &Op : Ops)
36     Abbrev->Add(Op);
37 }
38 
39 static void BoolAbbrev(std::shared_ptr<llvm::BitCodeAbbrev> &Abbrev) {
40   AbbrevGen(Abbrev,
41             {// 0. Boolean
42              llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Fixed,
43                                    BitCodeConstants::BoolSize)});
44 }
45 
46 static void IntAbbrev(std::shared_ptr<llvm::BitCodeAbbrev> &Abbrev) {
47   AbbrevGen(Abbrev,
48             {// 0. Fixed-size integer
49              llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Fixed,
50                                    BitCodeConstants::IntSize)});
51 }
52 
53 static void SymbolIDAbbrev(std::shared_ptr<llvm::BitCodeAbbrev> &Abbrev) {
54   AbbrevGen(Abbrev,
55             {// 0. Fixed-size integer (length of the sha1'd USR)
56              llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Fixed,
57                                    BitCodeConstants::USRLengthSize),
58              // 1. Fixed-size array of Char6 (USR)
59              llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Array),
60              llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Fixed,
61                                    BitCodeConstants::USRBitLengthSize)});
62 }
63 
64 static void StringAbbrev(std::shared_ptr<llvm::BitCodeAbbrev> &Abbrev) {
65   AbbrevGen(Abbrev,
66             {// 0. Fixed-size integer (length of the following string)
67              llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Fixed,
68                                    BitCodeConstants::StringLengthSize),
69              // 1. The string blob
70              llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob)});
71 }
72 
73 // Assumes that the file will not have more than 65535 lines.
74 static void LocationAbbrev(std::shared_ptr<llvm::BitCodeAbbrev> &Abbrev) {
75   AbbrevGen(
76       Abbrev,
77       {// 0. Fixed-size integer (line number)
78        llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Fixed,
79                              BitCodeConstants::LineNumberSize),
80        // 1. Boolean (IsFileInRootDir)
81        llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Fixed,
82                              BitCodeConstants::BoolSize),
83        // 2. Fixed-size integer (length of the following string (filename))
84        llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Fixed,
85                              BitCodeConstants::StringLengthSize),
86        // 3. The string blob
87        llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob)});
88 }
89 
90 struct RecordIdDsc {
91   llvm::StringRef Name;
92   AbbrevDsc Abbrev = nullptr;
93 
94   RecordIdDsc() = default;
95   RecordIdDsc(llvm::StringRef Name, AbbrevDsc Abbrev)
96       : Name(Name), Abbrev(Abbrev) {}
97 
98   // Is this 'description' valid?
99   operator bool() const {
100     return Abbrev != nullptr && Name.data() != nullptr && !Name.empty();
101   }
102 };
103 
104 static const llvm::IndexedMap<llvm::StringRef, BlockIdToIndexFunctor>
105     BlockIdNameMap = []() {
106       llvm::IndexedMap<llvm::StringRef, BlockIdToIndexFunctor> BlockIdNameMap;
107       BlockIdNameMap.resize(BlockIdCount);
108 
109       // There is no init-list constructor for the IndexedMap, so have to
110       // improvise
111       static const std::vector<std::pair<BlockId, const char *const>> Inits = {
112           {BI_VERSION_BLOCK_ID, "VersionBlock"},
113           {BI_NAMESPACE_BLOCK_ID, "NamespaceBlock"},
114           {BI_ENUM_BLOCK_ID, "EnumBlock"},
115           {BI_ENUM_VALUE_BLOCK_ID, "EnumValueBlock"},
116           {BI_TYPEDEF_BLOCK_ID, "TypedefBlock"},
117           {BI_TYPE_BLOCK_ID, "TypeBlock"},
118           {BI_FIELD_TYPE_BLOCK_ID, "FieldTypeBlock"},
119           {BI_MEMBER_TYPE_BLOCK_ID, "MemberTypeBlock"},
120           {BI_RECORD_BLOCK_ID, "RecordBlock"},
121           {BI_BASE_RECORD_BLOCK_ID, "BaseRecordBlock"},
122           {BI_FUNCTION_BLOCK_ID, "FunctionBlock"},
123           {BI_COMMENT_BLOCK_ID, "CommentBlock"},
124           {BI_REFERENCE_BLOCK_ID, "ReferenceBlock"}};
125       assert(Inits.size() == BlockIdCount);
126       for (const auto &Init : Inits)
127         BlockIdNameMap[Init.first] = Init.second;
128       assert(BlockIdNameMap.size() == BlockIdCount);
129       return BlockIdNameMap;
130     }();
131 
132 static const llvm::IndexedMap<RecordIdDsc, RecordIdToIndexFunctor>
133     RecordIdNameMap = []() {
134       llvm::IndexedMap<RecordIdDsc, RecordIdToIndexFunctor> RecordIdNameMap;
135       RecordIdNameMap.resize(RecordIdCount);
136 
137       // There is no init-list constructor for the IndexedMap, so have to
138       // improvise
139       static const std::vector<std::pair<RecordId, RecordIdDsc>> Inits = {
140           {VERSION, {"Version", &IntAbbrev}},
141           {COMMENT_KIND, {"Kind", &StringAbbrev}},
142           {COMMENT_TEXT, {"Text", &StringAbbrev}},
143           {COMMENT_NAME, {"Name", &StringAbbrev}},
144           {COMMENT_DIRECTION, {"Direction", &StringAbbrev}},
145           {COMMENT_PARAMNAME, {"ParamName", &StringAbbrev}},
146           {COMMENT_CLOSENAME, {"CloseName", &StringAbbrev}},
147           {COMMENT_SELFCLOSING, {"SelfClosing", &BoolAbbrev}},
148           {COMMENT_EXPLICIT, {"Explicit", &BoolAbbrev}},
149           {COMMENT_ATTRKEY, {"AttrKey", &StringAbbrev}},
150           {COMMENT_ATTRVAL, {"AttrVal", &StringAbbrev}},
151           {COMMENT_ARG, {"Arg", &StringAbbrev}},
152           {FIELD_TYPE_NAME, {"Name", &StringAbbrev}},
153           {FIELD_DEFAULT_VALUE, {"DefaultValue", &StringAbbrev}},
154           {MEMBER_TYPE_NAME, {"Name", &StringAbbrev}},
155           {MEMBER_TYPE_ACCESS, {"Access", &IntAbbrev}},
156           {NAMESPACE_USR, {"USR", &SymbolIDAbbrev}},
157           {NAMESPACE_NAME, {"Name", &StringAbbrev}},
158           {NAMESPACE_PATH, {"Path", &StringAbbrev}},
159           {ENUM_USR, {"USR", &SymbolIDAbbrev}},
160           {ENUM_NAME, {"Name", &StringAbbrev}},
161           {ENUM_DEFLOCATION, {"DefLocation", &LocationAbbrev}},
162           {ENUM_LOCATION, {"Location", &LocationAbbrev}},
163           {ENUM_SCOPED, {"Scoped", &BoolAbbrev}},
164           {ENUM_VALUE_NAME, {"Name", &StringAbbrev}},
165           {ENUM_VALUE_VALUE, {"Value", &StringAbbrev}},
166           {ENUM_VALUE_EXPR, {"Expr", &StringAbbrev}},
167           {RECORD_USR, {"USR", &SymbolIDAbbrev}},
168           {RECORD_NAME, {"Name", &StringAbbrev}},
169           {RECORD_PATH, {"Path", &StringAbbrev}},
170           {RECORD_DEFLOCATION, {"DefLocation", &LocationAbbrev}},
171           {RECORD_LOCATION, {"Location", &LocationAbbrev}},
172           {RECORD_TAG_TYPE, {"TagType", &IntAbbrev}},
173           {RECORD_IS_TYPE_DEF, {"IsTypeDef", &BoolAbbrev}},
174           {BASE_RECORD_USR, {"USR", &SymbolIDAbbrev}},
175           {BASE_RECORD_NAME, {"Name", &StringAbbrev}},
176           {BASE_RECORD_PATH, {"Path", &StringAbbrev}},
177           {BASE_RECORD_TAG_TYPE, {"TagType", &IntAbbrev}},
178           {BASE_RECORD_IS_VIRTUAL, {"IsVirtual", &BoolAbbrev}},
179           {BASE_RECORD_ACCESS, {"Access", &IntAbbrev}},
180           {BASE_RECORD_IS_PARENT, {"IsParent", &BoolAbbrev}},
181           {FUNCTION_USR, {"USR", &SymbolIDAbbrev}},
182           {FUNCTION_NAME, {"Name", &StringAbbrev}},
183           {FUNCTION_DEFLOCATION, {"DefLocation", &LocationAbbrev}},
184           {FUNCTION_LOCATION, {"Location", &LocationAbbrev}},
185           {FUNCTION_ACCESS, {"Access", &IntAbbrev}},
186           {FUNCTION_IS_METHOD, {"IsMethod", &BoolAbbrev}},
187           {REFERENCE_USR, {"USR", &SymbolIDAbbrev}},
188           {REFERENCE_NAME, {"Name", &StringAbbrev}},
189           {REFERENCE_TYPE, {"RefType", &IntAbbrev}},
190           {REFERENCE_PATH, {"Path", &StringAbbrev}},
191           {REFERENCE_FIELD, {"Field", &IntAbbrev}},
192           {TYPEDEF_USR, {"USR", &SymbolIDAbbrev}},
193           {TYPEDEF_NAME, {"Name", &StringAbbrev}},
194           {TYPEDEF_DEFLOCATION, {"DefLocation", &LocationAbbrev}},
195           {TYPEDEF_IS_USING, {"IsUsing", &BoolAbbrev}}};
196       assert(Inits.size() == RecordIdCount);
197       for (const auto &Init : Inits) {
198         RecordIdNameMap[Init.first] = Init.second;
199         assert((Init.second.Name.size() + 1) <= BitCodeConstants::RecordSize);
200       }
201       assert(RecordIdNameMap.size() == RecordIdCount);
202       return RecordIdNameMap;
203     }();
204 
205 static const std::vector<std::pair<BlockId, std::vector<RecordId>>>
206     RecordsByBlock{
207         // Version Block
208         {BI_VERSION_BLOCK_ID, {VERSION}},
209         // Comment Block
210         {BI_COMMENT_BLOCK_ID,
211          {COMMENT_KIND, COMMENT_TEXT, COMMENT_NAME, COMMENT_DIRECTION,
212           COMMENT_PARAMNAME, COMMENT_CLOSENAME, COMMENT_SELFCLOSING,
213           COMMENT_EXPLICIT, COMMENT_ATTRKEY, COMMENT_ATTRVAL, COMMENT_ARG}},
214         // Type Block
215         {BI_TYPE_BLOCK_ID, {}},
216         // FieldType Block
217         {BI_FIELD_TYPE_BLOCK_ID, {FIELD_TYPE_NAME, FIELD_DEFAULT_VALUE}},
218         // MemberType Block
219         {BI_MEMBER_TYPE_BLOCK_ID, {MEMBER_TYPE_NAME, MEMBER_TYPE_ACCESS}},
220         // Enum Block
221         {BI_ENUM_BLOCK_ID,
222          {ENUM_USR, ENUM_NAME, ENUM_DEFLOCATION, ENUM_LOCATION, ENUM_SCOPED}},
223         // Enum Value Block
224         {BI_ENUM_VALUE_BLOCK_ID,
225          {ENUM_VALUE_NAME, ENUM_VALUE_VALUE, ENUM_VALUE_EXPR}},
226         // Typedef Block
227         {BI_TYPEDEF_BLOCK_ID,
228          {TYPEDEF_USR, TYPEDEF_NAME, TYPEDEF_DEFLOCATION, TYPEDEF_IS_USING}},
229         // Namespace Block
230         {BI_NAMESPACE_BLOCK_ID,
231          {NAMESPACE_USR, NAMESPACE_NAME, NAMESPACE_PATH}},
232         // Record Block
233         {BI_RECORD_BLOCK_ID,
234          {RECORD_USR, RECORD_NAME, RECORD_PATH, RECORD_DEFLOCATION,
235           RECORD_LOCATION, RECORD_TAG_TYPE, RECORD_IS_TYPE_DEF}},
236         // BaseRecord Block
237         {BI_BASE_RECORD_BLOCK_ID,
238          {BASE_RECORD_USR, BASE_RECORD_NAME, BASE_RECORD_PATH,
239           BASE_RECORD_TAG_TYPE, BASE_RECORD_IS_VIRTUAL, BASE_RECORD_ACCESS,
240           BASE_RECORD_IS_PARENT}},
241         // Function Block
242         {BI_FUNCTION_BLOCK_ID,
243          {FUNCTION_USR, FUNCTION_NAME, FUNCTION_DEFLOCATION, FUNCTION_LOCATION,
244           FUNCTION_ACCESS, FUNCTION_IS_METHOD}},
245         // Reference Block
246         {BI_REFERENCE_BLOCK_ID,
247          {REFERENCE_USR, REFERENCE_NAME, REFERENCE_TYPE, REFERENCE_PATH,
248           REFERENCE_FIELD}}};
249 
250 // AbbreviationMap
251 
252 constexpr unsigned char BitCodeConstants::Signature[];
253 
254 void ClangDocBitcodeWriter::AbbreviationMap::add(RecordId RID,
255                                                  unsigned AbbrevID) {
256   assert(RecordIdNameMap[RID] && "Unknown RecordId.");
257   assert(Abbrevs.find(RID) == Abbrevs.end() && "Abbreviation already added.");
258   Abbrevs[RID] = AbbrevID;
259 }
260 
261 unsigned ClangDocBitcodeWriter::AbbreviationMap::get(RecordId RID) const {
262   assert(RecordIdNameMap[RID] && "Unknown RecordId.");
263   assert(Abbrevs.find(RID) != Abbrevs.end() && "Unknown abbreviation.");
264   return Abbrevs.lookup(RID);
265 }
266 
267 // Validation and Overview Blocks
268 
269 /// Emits the magic number header to check that its the right format,
270 /// in this case, 'DOCS'.
271 void ClangDocBitcodeWriter::emitHeader() {
272   for (char C : BitCodeConstants::Signature)
273     Stream.Emit((unsigned)C, BitCodeConstants::SignatureBitSize);
274 }
275 
276 void ClangDocBitcodeWriter::emitVersionBlock() {
277   StreamSubBlockGuard Block(Stream, BI_VERSION_BLOCK_ID);
278   emitRecord(VersionNumber, VERSION);
279 }
280 
281 /// Emits a block ID and the block name to the BLOCKINFO block.
282 void ClangDocBitcodeWriter::emitBlockID(BlockId BID) {
283   const auto &BlockIdName = BlockIdNameMap[BID];
284   assert(BlockIdName.data() && BlockIdName.size() && "Unknown BlockId.");
285 
286   Record.clear();
287   Record.push_back(BID);
288   Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_SETBID, Record);
289   Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_BLOCKNAME,
290                     ArrayRef<unsigned char>(BlockIdName.bytes_begin(),
291                                             BlockIdName.bytes_end()));
292 }
293 
294 /// Emits a record name to the BLOCKINFO block.
295 void ClangDocBitcodeWriter::emitRecordID(RecordId ID) {
296   assert(RecordIdNameMap[ID] && "Unknown RecordId.");
297   prepRecordData(ID);
298   Record.append(RecordIdNameMap[ID].Name.begin(),
299                 RecordIdNameMap[ID].Name.end());
300   Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_SETRECORDNAME, Record);
301 }
302 
303 // Abbreviations
304 
305 void ClangDocBitcodeWriter::emitAbbrev(RecordId ID, BlockId Block) {
306   assert(RecordIdNameMap[ID] && "Unknown abbreviation.");
307   auto Abbrev = std::make_shared<llvm::BitCodeAbbrev>();
308   Abbrev->Add(llvm::BitCodeAbbrevOp(ID));
309   RecordIdNameMap[ID].Abbrev(Abbrev);
310   Abbrevs.add(ID, Stream.EmitBlockInfoAbbrev(Block, std::move(Abbrev)));
311 }
312 
313 // Records
314 
315 void ClangDocBitcodeWriter::emitRecord(const SymbolID &Sym, RecordId ID) {
316   assert(RecordIdNameMap[ID] && "Unknown RecordId.");
317   assert(RecordIdNameMap[ID].Abbrev == &SymbolIDAbbrev &&
318          "Abbrev type mismatch.");
319   if (!prepRecordData(ID, Sym != EmptySID))
320     return;
321   assert(Sym.size() == 20);
322   Record.push_back(Sym.size());
323   Record.append(Sym.begin(), Sym.end());
324   Stream.EmitRecordWithAbbrev(Abbrevs.get(ID), Record);
325 }
326 
327 void ClangDocBitcodeWriter::emitRecord(llvm::StringRef Str, RecordId ID) {
328   assert(RecordIdNameMap[ID] && "Unknown RecordId.");
329   assert(RecordIdNameMap[ID].Abbrev == &StringAbbrev &&
330          "Abbrev type mismatch.");
331   if (!prepRecordData(ID, !Str.empty()))
332     return;
333   assert(Str.size() < (1U << BitCodeConstants::StringLengthSize));
334   Record.push_back(Str.size());
335   Stream.EmitRecordWithBlob(Abbrevs.get(ID), Record, Str);
336 }
337 
338 void ClangDocBitcodeWriter::emitRecord(const Location &Loc, RecordId ID) {
339   assert(RecordIdNameMap[ID] && "Unknown RecordId.");
340   assert(RecordIdNameMap[ID].Abbrev == &LocationAbbrev &&
341          "Abbrev type mismatch.");
342   if (!prepRecordData(ID, true))
343     return;
344   // FIXME: Assert that the line number is of the appropriate size.
345   Record.push_back(Loc.LineNumber);
346   assert(Loc.Filename.size() < (1U << BitCodeConstants::StringLengthSize));
347   Record.push_back(Loc.IsFileInRootDir);
348   Record.push_back(Loc.Filename.size());
349   Stream.EmitRecordWithBlob(Abbrevs.get(ID), Record, Loc.Filename);
350 }
351 
352 void ClangDocBitcodeWriter::emitRecord(bool Val, RecordId ID) {
353   assert(RecordIdNameMap[ID] && "Unknown RecordId.");
354   assert(RecordIdNameMap[ID].Abbrev == &BoolAbbrev && "Abbrev type mismatch.");
355   if (!prepRecordData(ID, Val))
356     return;
357   Record.push_back(Val);
358   Stream.EmitRecordWithAbbrev(Abbrevs.get(ID), Record);
359 }
360 
361 void ClangDocBitcodeWriter::emitRecord(int Val, RecordId ID) {
362   assert(RecordIdNameMap[ID] && "Unknown RecordId.");
363   assert(RecordIdNameMap[ID].Abbrev == &IntAbbrev && "Abbrev type mismatch.");
364   if (!prepRecordData(ID, Val))
365     return;
366   // FIXME: Assert that the integer is of the appropriate size.
367   Record.push_back(Val);
368   Stream.EmitRecordWithAbbrev(Abbrevs.get(ID), Record);
369 }
370 
371 void ClangDocBitcodeWriter::emitRecord(unsigned Val, RecordId ID) {
372   assert(RecordIdNameMap[ID] && "Unknown RecordId.");
373   assert(RecordIdNameMap[ID].Abbrev == &IntAbbrev && "Abbrev type mismatch.");
374   if (!prepRecordData(ID, Val))
375     return;
376   assert(Val < (1U << BitCodeConstants::IntSize));
377   Record.push_back(Val);
378   Stream.EmitRecordWithAbbrev(Abbrevs.get(ID), Record);
379 }
380 
381 bool ClangDocBitcodeWriter::prepRecordData(RecordId ID, bool ShouldEmit) {
382   assert(RecordIdNameMap[ID] && "Unknown RecordId.");
383   if (!ShouldEmit)
384     return false;
385   Record.clear();
386   Record.push_back(ID);
387   return true;
388 }
389 
390 // BlockInfo Block
391 
392 void ClangDocBitcodeWriter::emitBlockInfoBlock() {
393   Stream.EnterBlockInfoBlock();
394   for (const auto &Block : RecordsByBlock) {
395     assert(Block.second.size() < (1U << BitCodeConstants::SubblockIDSize));
396     emitBlockInfo(Block.first, Block.second);
397   }
398   Stream.ExitBlock();
399 }
400 
401 void ClangDocBitcodeWriter::emitBlockInfo(BlockId BID,
402                                           const std::vector<RecordId> &RIDs) {
403   assert(RIDs.size() < (1U << BitCodeConstants::SubblockIDSize));
404   emitBlockID(BID);
405   for (RecordId RID : RIDs) {
406     emitRecordID(RID);
407     emitAbbrev(RID, BID);
408   }
409 }
410 
411 // Block emission
412 
413 void ClangDocBitcodeWriter::emitBlock(const Reference &R, FieldId Field) {
414   if (R.USR == EmptySID && R.Name.empty())
415     return;
416   StreamSubBlockGuard Block(Stream, BI_REFERENCE_BLOCK_ID);
417   emitRecord(R.USR, REFERENCE_USR);
418   emitRecord(R.Name, REFERENCE_NAME);
419   emitRecord((unsigned)R.RefType, REFERENCE_TYPE);
420   emitRecord(R.Path, REFERENCE_PATH);
421   emitRecord((unsigned)Field, REFERENCE_FIELD);
422 }
423 
424 void ClangDocBitcodeWriter::emitBlock(const TypeInfo &T) {
425   StreamSubBlockGuard Block(Stream, BI_TYPE_BLOCK_ID);
426   emitBlock(T.Type, FieldId::F_type);
427 }
428 
429 void ClangDocBitcodeWriter::emitBlock(const TypedefInfo &T) {
430   StreamSubBlockGuard Block(Stream, BI_TYPEDEF_BLOCK_ID);
431   emitRecord(T.USR, TYPEDEF_USR);
432   emitRecord(T.Name, TYPEDEF_NAME);
433   for (const auto &N : T.Namespace)
434     emitBlock(N, FieldId::F_namespace);
435   for (const auto &CI : T.Description)
436     emitBlock(CI);
437   if (T.DefLoc)
438     emitRecord(*T.DefLoc, TYPEDEF_DEFLOCATION);
439   emitRecord(T.IsUsing, TYPEDEF_IS_USING);
440   emitBlock(T.Underlying);
441 }
442 
443 void ClangDocBitcodeWriter::emitBlock(const FieldTypeInfo &T) {
444   StreamSubBlockGuard Block(Stream, BI_FIELD_TYPE_BLOCK_ID);
445   emitBlock(T.Type, FieldId::F_type);
446   emitRecord(T.Name, FIELD_TYPE_NAME);
447   emitRecord(T.DefaultValue, FIELD_DEFAULT_VALUE);
448 }
449 
450 void ClangDocBitcodeWriter::emitBlock(const MemberTypeInfo &T) {
451   StreamSubBlockGuard Block(Stream, BI_MEMBER_TYPE_BLOCK_ID);
452   emitBlock(T.Type, FieldId::F_type);
453   emitRecord(T.Name, MEMBER_TYPE_NAME);
454   emitRecord(T.Access, MEMBER_TYPE_ACCESS);
455   for (const auto &CI : T.Description)
456     emitBlock(CI);
457 }
458 
459 void ClangDocBitcodeWriter::emitBlock(const CommentInfo &I) {
460   StreamSubBlockGuard Block(Stream, BI_COMMENT_BLOCK_ID);
461   for (const auto &L : std::vector<std::pair<llvm::StringRef, RecordId>>{
462            {I.Kind, COMMENT_KIND},
463            {I.Text, COMMENT_TEXT},
464            {I.Name, COMMENT_NAME},
465            {I.Direction, COMMENT_DIRECTION},
466            {I.ParamName, COMMENT_PARAMNAME},
467            {I.CloseName, COMMENT_CLOSENAME}})
468     emitRecord(L.first, L.second);
469   emitRecord(I.SelfClosing, COMMENT_SELFCLOSING);
470   emitRecord(I.Explicit, COMMENT_EXPLICIT);
471   for (const auto &A : I.AttrKeys)
472     emitRecord(A, COMMENT_ATTRKEY);
473   for (const auto &A : I.AttrValues)
474     emitRecord(A, COMMENT_ATTRVAL);
475   for (const auto &A : I.Args)
476     emitRecord(A, COMMENT_ARG);
477   for (const auto &C : I.Children)
478     emitBlock(*C);
479 }
480 
481 void ClangDocBitcodeWriter::emitBlock(const NamespaceInfo &I) {
482   StreamSubBlockGuard Block(Stream, BI_NAMESPACE_BLOCK_ID);
483   emitRecord(I.USR, NAMESPACE_USR);
484   emitRecord(I.Name, NAMESPACE_NAME);
485   emitRecord(I.Path, NAMESPACE_PATH);
486   for (const auto &N : I.Namespace)
487     emitBlock(N, FieldId::F_namespace);
488   for (const auto &CI : I.Description)
489     emitBlock(CI);
490   for (const auto &C : I.Children.Namespaces)
491     emitBlock(C, FieldId::F_child_namespace);
492   for (const auto &C : I.Children.Records)
493     emitBlock(C, FieldId::F_child_record);
494   for (const auto &C : I.Children.Functions)
495     emitBlock(C);
496   for (const auto &C : I.Children.Enums)
497     emitBlock(C);
498   for (const auto &C : I.Children.Typedefs)
499     emitBlock(C);
500 }
501 
502 void ClangDocBitcodeWriter::emitBlock(const EnumInfo &I) {
503   StreamSubBlockGuard Block(Stream, BI_ENUM_BLOCK_ID);
504   emitRecord(I.USR, ENUM_USR);
505   emitRecord(I.Name, ENUM_NAME);
506   for (const auto &N : I.Namespace)
507     emitBlock(N, FieldId::F_namespace);
508   for (const auto &CI : I.Description)
509     emitBlock(CI);
510   if (I.DefLoc)
511     emitRecord(*I.DefLoc, ENUM_DEFLOCATION);
512   for (const auto &L : I.Loc)
513     emitRecord(L, ENUM_LOCATION);
514   emitRecord(I.Scoped, ENUM_SCOPED);
515   if (I.BaseType)
516     emitBlock(*I.BaseType);
517   for (const auto &N : I.Members)
518     emitBlock(N);
519 }
520 
521 void ClangDocBitcodeWriter::emitBlock(const EnumValueInfo &I) {
522   StreamSubBlockGuard Block(Stream, BI_ENUM_VALUE_BLOCK_ID);
523   emitRecord(I.Name, ENUM_VALUE_NAME);
524   emitRecord(I.Value, ENUM_VALUE_VALUE);
525   emitRecord(I.ValueExpr, ENUM_VALUE_EXPR);
526 }
527 
528 void ClangDocBitcodeWriter::emitBlock(const RecordInfo &I) {
529   StreamSubBlockGuard Block(Stream, BI_RECORD_BLOCK_ID);
530   emitRecord(I.USR, RECORD_USR);
531   emitRecord(I.Name, RECORD_NAME);
532   emitRecord(I.Path, RECORD_PATH);
533   for (const auto &N : I.Namespace)
534     emitBlock(N, FieldId::F_namespace);
535   for (const auto &CI : I.Description)
536     emitBlock(CI);
537   if (I.DefLoc)
538     emitRecord(*I.DefLoc, RECORD_DEFLOCATION);
539   for (const auto &L : I.Loc)
540     emitRecord(L, RECORD_LOCATION);
541   emitRecord(I.TagType, RECORD_TAG_TYPE);
542   emitRecord(I.IsTypeDef, RECORD_IS_TYPE_DEF);
543   for (const auto &N : I.Members)
544     emitBlock(N);
545   for (const auto &P : I.Parents)
546     emitBlock(P, FieldId::F_parent);
547   for (const auto &P : I.VirtualParents)
548     emitBlock(P, FieldId::F_vparent);
549   for (const auto &PB : I.Bases)
550     emitBlock(PB);
551   for (const auto &C : I.Children.Records)
552     emitBlock(C, FieldId::F_child_record);
553   for (const auto &C : I.Children.Functions)
554     emitBlock(C);
555   for (const auto &C : I.Children.Enums)
556     emitBlock(C);
557   for (const auto &C : I.Children.Typedefs)
558     emitBlock(C);
559 }
560 
561 void ClangDocBitcodeWriter::emitBlock(const BaseRecordInfo &I) {
562   StreamSubBlockGuard Block(Stream, BI_BASE_RECORD_BLOCK_ID);
563   emitRecord(I.USR, BASE_RECORD_USR);
564   emitRecord(I.Name, BASE_RECORD_NAME);
565   emitRecord(I.Path, BASE_RECORD_PATH);
566   emitRecord(I.TagType, BASE_RECORD_TAG_TYPE);
567   emitRecord(I.IsVirtual, BASE_RECORD_IS_VIRTUAL);
568   emitRecord(I.Access, BASE_RECORD_ACCESS);
569   emitRecord(I.IsParent, BASE_RECORD_IS_PARENT);
570   for (const auto &M : I.Members)
571     emitBlock(M);
572   for (const auto &C : I.Children.Functions)
573     emitBlock(C);
574 }
575 
576 void ClangDocBitcodeWriter::emitBlock(const FunctionInfo &I) {
577   StreamSubBlockGuard Block(Stream, BI_FUNCTION_BLOCK_ID);
578   emitRecord(I.USR, FUNCTION_USR);
579   emitRecord(I.Name, FUNCTION_NAME);
580   for (const auto &N : I.Namespace)
581     emitBlock(N, FieldId::F_namespace);
582   for (const auto &CI : I.Description)
583     emitBlock(CI);
584   emitRecord(I.Access, FUNCTION_ACCESS);
585   emitRecord(I.IsMethod, FUNCTION_IS_METHOD);
586   if (I.DefLoc)
587     emitRecord(*I.DefLoc, FUNCTION_DEFLOCATION);
588   for (const auto &L : I.Loc)
589     emitRecord(L, FUNCTION_LOCATION);
590   emitBlock(I.Parent, FieldId::F_parent);
591   emitBlock(I.ReturnType);
592   for (const auto &N : I.Params)
593     emitBlock(N);
594 }
595 
596 bool ClangDocBitcodeWriter::dispatchInfoForWrite(Info *I) {
597   switch (I->IT) {
598   case InfoType::IT_namespace:
599     emitBlock(*static_cast<clang::doc::NamespaceInfo *>(I));
600     break;
601   case InfoType::IT_record:
602     emitBlock(*static_cast<clang::doc::RecordInfo *>(I));
603     break;
604   case InfoType::IT_enum:
605     emitBlock(*static_cast<clang::doc::EnumInfo *>(I));
606     break;
607   case InfoType::IT_function:
608     emitBlock(*static_cast<clang::doc::FunctionInfo *>(I));
609     break;
610   case InfoType::IT_typedef:
611     emitBlock(*static_cast<clang::doc::TypedefInfo *>(I));
612     break;
613   default:
614     llvm::errs() << "Unexpected info, unable to write.\n";
615     return true;
616   }
617   return false;
618 }
619 
620 } // namespace doc
621 } // namespace clang
622