1 //===--  BitcodeWriter.cpp - ClangDoc Bitcode Writer ------------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 
10 #include "BitcodeWriter.h"
11 #include "llvm/ADT/IndexedMap.h"
12 #include <initializer_list>
13 
14 namespace clang {
15 namespace doc {
16 
17 // Empty SymbolID for comparison, so we don't have to construct one every time.
18 static const SymbolID EmptySID = SymbolID();
19 
20 // Since id enums are not zero-indexed, we need to transform the given id into
21 // its associated index.
22 struct BlockIdToIndexFunctor {
23   using argument_type = unsigned;
24   unsigned operator()(unsigned ID) const { return ID - BI_FIRST; }
25 };
26 
27 struct RecordIdToIndexFunctor {
28   using argument_type = unsigned;
29   unsigned operator()(unsigned ID) const { return ID - RI_FIRST; }
30 };
31 
32 using AbbrevDsc = void (*)(std::shared_ptr<llvm::BitCodeAbbrev> &Abbrev);
33 
34 static void AbbrevGen(std::shared_ptr<llvm::BitCodeAbbrev> &Abbrev,
35                       const std::initializer_list<llvm::BitCodeAbbrevOp> Ops) {
36   for (const auto &Op : Ops)
37     Abbrev->Add(Op);
38 }
39 
40 static void BoolAbbrev(std::shared_ptr<llvm::BitCodeAbbrev> &Abbrev) {
41   AbbrevGen(Abbrev,
42             {// 0. Boolean
43              llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Fixed,
44                                    BitCodeConstants::BoolSize)});
45 }
46 
47 static void IntAbbrev(std::shared_ptr<llvm::BitCodeAbbrev> &Abbrev) {
48   AbbrevGen(Abbrev,
49             {// 0. Fixed-size integer
50              llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Fixed,
51                                    BitCodeConstants::IntSize)});
52 }
53 
54 static void SymbolIDAbbrev(std::shared_ptr<llvm::BitCodeAbbrev> &Abbrev) {
55   AbbrevGen(Abbrev,
56             {// 0. Fixed-size integer (length of the sha1'd USR)
57              llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Fixed,
58                                    BitCodeConstants::USRLengthSize),
59              // 1. Fixed-size array of Char6 (USR)
60              llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Array),
61              llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Fixed,
62                                    BitCodeConstants::USRBitLengthSize)});
63 }
64 
65 static void StringAbbrev(std::shared_ptr<llvm::BitCodeAbbrev> &Abbrev) {
66   AbbrevGen(Abbrev,
67             {// 0. Fixed-size integer (length of the following string)
68              llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Fixed,
69                                    BitCodeConstants::StringLengthSize),
70              // 1. The string blob
71              llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob)});
72 }
73 
74 // Assumes that the file will not have more than 65535 lines.
75 static void LocationAbbrev(std::shared_ptr<llvm::BitCodeAbbrev> &Abbrev) {
76   AbbrevGen(
77       Abbrev,
78       {// 0. Fixed-size integer (line number)
79        llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Fixed,
80                              BitCodeConstants::LineNumberSize),
81        // 1. Fixed-size integer (length of the following string (filename))
82        llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Fixed,
83                              BitCodeConstants::StringLengthSize),
84        // 2. The string blob
85        llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob)});
86 }
87 
88 struct RecordIdDsc {
89   llvm::StringRef Name;
90   AbbrevDsc Abbrev = nullptr;
91 
92   RecordIdDsc() = default;
93   RecordIdDsc(llvm::StringRef Name, AbbrevDsc Abbrev)
94       : Name(Name), Abbrev(Abbrev) {}
95 
96   // Is this 'description' valid?
97   operator bool() const {
98     return Abbrev != nullptr && Name.data() != nullptr && !Name.empty();
99   }
100 };
101 
102 static const llvm::IndexedMap<llvm::StringRef, BlockIdToIndexFunctor>
103     BlockIdNameMap = []() {
104       llvm::IndexedMap<llvm::StringRef, BlockIdToIndexFunctor> BlockIdNameMap;
105       BlockIdNameMap.resize(BlockIdCount);
106 
107       // There is no init-list constructor for the IndexedMap, so have to
108       // improvise
109       static const std::vector<std::pair<BlockId, const char *const>> Inits = {
110           {BI_VERSION_BLOCK_ID, "VersionBlock"},
111           {BI_NAMESPACE_BLOCK_ID, "NamespaceBlock"},
112           {BI_ENUM_BLOCK_ID, "EnumBlock"},
113           {BI_TYPE_BLOCK_ID, "TypeBlock"},
114           {BI_FIELD_TYPE_BLOCK_ID, "FieldTypeBlock"},
115           {BI_MEMBER_TYPE_BLOCK_ID, "MemberTypeBlock"},
116           {BI_RECORD_BLOCK_ID, "RecordBlock"},
117           {BI_FUNCTION_BLOCK_ID, "FunctionBlock"},
118           {BI_COMMENT_BLOCK_ID, "CommentBlock"},
119           {BI_REFERENCE_BLOCK_ID, "ReferenceBlock"}};
120       assert(Inits.size() == BlockIdCount);
121       for (const auto &Init : Inits)
122         BlockIdNameMap[Init.first] = Init.second;
123       assert(BlockIdNameMap.size() == BlockIdCount);
124       return BlockIdNameMap;
125     }();
126 
127 static const llvm::IndexedMap<RecordIdDsc, RecordIdToIndexFunctor>
128     RecordIdNameMap = []() {
129       llvm::IndexedMap<RecordIdDsc, RecordIdToIndexFunctor> RecordIdNameMap;
130       RecordIdNameMap.resize(RecordIdCount);
131 
132       // There is no init-list constructor for the IndexedMap, so have to
133       // improvise
134       static const std::vector<std::pair<RecordId, RecordIdDsc>> Inits = {
135           {VERSION, {"Version", &IntAbbrev}},
136           {COMMENT_KIND, {"Kind", &StringAbbrev}},
137           {COMMENT_TEXT, {"Text", &StringAbbrev}},
138           {COMMENT_NAME, {"Name", &StringAbbrev}},
139           {COMMENT_DIRECTION, {"Direction", &StringAbbrev}},
140           {COMMENT_PARAMNAME, {"ParamName", &StringAbbrev}},
141           {COMMENT_CLOSENAME, {"CloseName", &StringAbbrev}},
142           {COMMENT_SELFCLOSING, {"SelfClosing", &BoolAbbrev}},
143           {COMMENT_EXPLICIT, {"Explicit", &BoolAbbrev}},
144           {COMMENT_ATTRKEY, {"AttrKey", &StringAbbrev}},
145           {COMMENT_ATTRVAL, {"AttrVal", &StringAbbrev}},
146           {COMMENT_ARG, {"Arg", &StringAbbrev}},
147           {FIELD_TYPE_NAME, {"Name", &StringAbbrev}},
148           {MEMBER_TYPE_NAME, {"Name", &StringAbbrev}},
149           {MEMBER_TYPE_ACCESS, {"Access", &IntAbbrev}},
150           {NAMESPACE_USR, {"USR", &SymbolIDAbbrev}},
151           {NAMESPACE_NAME, {"Name", &StringAbbrev}},
152           {ENUM_USR, {"USR", &SymbolIDAbbrev}},
153           {ENUM_NAME, {"Name", &StringAbbrev}},
154           {ENUM_DEFLOCATION, {"DefLocation", &LocationAbbrev}},
155           {ENUM_LOCATION, {"Location", &LocationAbbrev}},
156           {ENUM_MEMBER, {"Member", &StringAbbrev}},
157           {ENUM_SCOPED, {"Scoped", &BoolAbbrev}},
158           {RECORD_USR, {"USR", &SymbolIDAbbrev}},
159           {RECORD_NAME, {"Name", &StringAbbrev}},
160           {RECORD_DEFLOCATION, {"DefLocation", &LocationAbbrev}},
161           {RECORD_LOCATION, {"Location", &LocationAbbrev}},
162           {RECORD_TAG_TYPE, {"TagType", &IntAbbrev}},
163           {FUNCTION_USR, {"USR", &SymbolIDAbbrev}},
164           {FUNCTION_NAME, {"Name", &StringAbbrev}},
165           {FUNCTION_DEFLOCATION, {"DefLocation", &LocationAbbrev}},
166           {FUNCTION_LOCATION, {"Location", &LocationAbbrev}},
167           {FUNCTION_ACCESS, {"Access", &IntAbbrev}},
168           {FUNCTION_IS_METHOD, {"IsMethod", &BoolAbbrev}},
169           {REFERENCE_USR, {"USR", &SymbolIDAbbrev}},
170           {REFERENCE_NAME, {"Name", &StringAbbrev}},
171           {REFERENCE_TYPE, {"RefType", &IntAbbrev}},
172           {REFERENCE_FIELD, {"Field", &IntAbbrev}}};
173       assert(Inits.size() == RecordIdCount);
174       for (const auto &Init : Inits) {
175         RecordIdNameMap[Init.first] = Init.second;
176         assert((Init.second.Name.size() + 1) <= BitCodeConstants::RecordSize);
177       }
178       assert(RecordIdNameMap.size() == RecordIdCount);
179       return RecordIdNameMap;
180     }();
181 
182 static const std::vector<std::pair<BlockId, std::vector<RecordId>>>
183     RecordsByBlock{
184         // Version Block
185         {BI_VERSION_BLOCK_ID, {VERSION}},
186         // Comment Block
187         {BI_COMMENT_BLOCK_ID,
188          {COMMENT_KIND, COMMENT_TEXT, COMMENT_NAME, COMMENT_DIRECTION,
189           COMMENT_PARAMNAME, COMMENT_CLOSENAME, COMMENT_SELFCLOSING,
190           COMMENT_EXPLICIT, COMMENT_ATTRKEY, COMMENT_ATTRVAL, COMMENT_ARG}},
191         // Type Block
192         {BI_TYPE_BLOCK_ID, {}},
193         // FieldType Block
194         {BI_FIELD_TYPE_BLOCK_ID, {FIELD_TYPE_NAME}},
195         // MemberType Block
196         {BI_MEMBER_TYPE_BLOCK_ID, {MEMBER_TYPE_NAME, MEMBER_TYPE_ACCESS}},
197         // Enum Block
198         {BI_ENUM_BLOCK_ID,
199          {ENUM_USR, ENUM_NAME, ENUM_DEFLOCATION, ENUM_LOCATION, ENUM_MEMBER,
200           ENUM_SCOPED}},
201         // Namespace Block
202         {BI_NAMESPACE_BLOCK_ID, {NAMESPACE_USR, NAMESPACE_NAME}},
203         // Record Block
204         {BI_RECORD_BLOCK_ID,
205          {RECORD_USR, RECORD_NAME, RECORD_DEFLOCATION, RECORD_LOCATION,
206           RECORD_TAG_TYPE}},
207         // Function Block
208         {BI_FUNCTION_BLOCK_ID,
209          {FUNCTION_USR, FUNCTION_NAME, FUNCTION_DEFLOCATION, FUNCTION_LOCATION,
210           FUNCTION_ACCESS, FUNCTION_IS_METHOD}},
211         // Reference Block
212         {BI_REFERENCE_BLOCK_ID,
213          {REFERENCE_USR, REFERENCE_NAME, REFERENCE_TYPE, REFERENCE_FIELD}}};
214 
215 // AbbreviationMap
216 
217 void ClangDocBitcodeWriter::AbbreviationMap::add(RecordId RID,
218                                                  unsigned AbbrevID) {
219   assert(RecordIdNameMap[RID] && "Unknown RecordId.");
220   assert(Abbrevs.find(RID) == Abbrevs.end() && "Abbreviation already added.");
221   Abbrevs[RID] = AbbrevID;
222 }
223 
224 unsigned ClangDocBitcodeWriter::AbbreviationMap::get(RecordId RID) const {
225   assert(RecordIdNameMap[RID] && "Unknown RecordId.");
226   assert(Abbrevs.find(RID) != Abbrevs.end() && "Unknown abbreviation.");
227   return Abbrevs.lookup(RID);
228 }
229 
230 // Validation and Overview Blocks
231 
232 /// \brief Emits the magic number header to check that its the right format,
233 /// in this case, 'DOCS'.
234 void ClangDocBitcodeWriter::emitHeader() {
235   for (char C : llvm::StringRef("DOCS"))
236     Stream.Emit((unsigned)C, BitCodeConstants::SignatureBitSize);
237 }
238 
239 void ClangDocBitcodeWriter::emitVersionBlock() {
240   StreamSubBlockGuard Block(Stream, BI_VERSION_BLOCK_ID);
241   emitRecord(VersionNumber, VERSION);
242 }
243 
244 /// \brief Emits a block ID and the block name to the BLOCKINFO block.
245 void ClangDocBitcodeWriter::emitBlockID(BlockId BID) {
246   const auto &BlockIdName = BlockIdNameMap[BID];
247   assert(BlockIdName.data() && BlockIdName.size() && "Unknown BlockId.");
248 
249   Record.clear();
250   Record.push_back(BID);
251   Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_SETBID, Record);
252   Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_BLOCKNAME,
253                     ArrayRef<unsigned char>(BlockIdName.bytes_begin(),
254                                             BlockIdName.bytes_end()));
255 }
256 
257 /// \brief Emits a record name to the BLOCKINFO block.
258 void ClangDocBitcodeWriter::emitRecordID(RecordId ID) {
259   assert(RecordIdNameMap[ID] && "Unknown RecordId.");
260   prepRecordData(ID);
261   Record.append(RecordIdNameMap[ID].Name.begin(),
262                 RecordIdNameMap[ID].Name.end());
263   Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_SETRECORDNAME, Record);
264 }
265 
266 // Abbreviations
267 
268 void ClangDocBitcodeWriter::emitAbbrev(RecordId ID, BlockId Block) {
269   assert(RecordIdNameMap[ID] && "Unknown abbreviation.");
270   auto Abbrev = std::make_shared<llvm::BitCodeAbbrev>();
271   Abbrev->Add(llvm::BitCodeAbbrevOp(ID));
272   RecordIdNameMap[ID].Abbrev(Abbrev);
273   Abbrevs.add(ID, Stream.EmitBlockInfoAbbrev(Block, std::move(Abbrev)));
274 }
275 
276 // Records
277 
278 void ClangDocBitcodeWriter::emitRecord(const SymbolID &Sym, RecordId ID) {
279   assert(RecordIdNameMap[ID] && "Unknown RecordId.");
280   assert(RecordIdNameMap[ID].Abbrev == &SymbolIDAbbrev &&
281          "Abbrev type mismatch.");
282   if (!prepRecordData(ID, Sym != EmptySID))
283     return;
284   assert(Sym.size() == 20);
285   Record.push_back(Sym.size());
286   Record.append(Sym.begin(), Sym.end());
287   Stream.EmitRecordWithAbbrev(Abbrevs.get(ID), Record);
288 }
289 
290 void ClangDocBitcodeWriter::emitRecord(llvm::StringRef Str, RecordId ID) {
291   assert(RecordIdNameMap[ID] && "Unknown RecordId.");
292   assert(RecordIdNameMap[ID].Abbrev == &StringAbbrev &&
293          "Abbrev type mismatch.");
294   if (!prepRecordData(ID, !Str.empty()))
295     return;
296   assert(Str.size() < (1U << BitCodeConstants::StringLengthSize));
297   Record.push_back(Str.size());
298   Stream.EmitRecordWithBlob(Abbrevs.get(ID), Record, Str);
299 }
300 
301 void ClangDocBitcodeWriter::emitRecord(const Location &Loc, RecordId ID) {
302   assert(RecordIdNameMap[ID] && "Unknown RecordId.");
303   assert(RecordIdNameMap[ID].Abbrev == &LocationAbbrev &&
304          "Abbrev type mismatch.");
305   if (!prepRecordData(ID, true))
306     return;
307   // FIXME: Assert that the line number is of the appropriate size.
308   Record.push_back(Loc.LineNumber);
309   assert(Loc.Filename.size() < (1U << BitCodeConstants::StringLengthSize));
310   // Record.push_back(Loc.Filename.size());
311   // Stream.EmitRecordWithBlob(Abbrevs.get(ID), Record, Loc.Filename);
312   Record.push_back(4);
313   Stream.EmitRecordWithBlob(Abbrevs.get(ID), Record, "test");
314 }
315 
316 void ClangDocBitcodeWriter::emitRecord(bool Val, RecordId ID) {
317   assert(RecordIdNameMap[ID] && "Unknown RecordId.");
318   assert(RecordIdNameMap[ID].Abbrev == &BoolAbbrev && "Abbrev type mismatch.");
319   if (!prepRecordData(ID, Val))
320     return;
321   Record.push_back(Val);
322   Stream.EmitRecordWithAbbrev(Abbrevs.get(ID), Record);
323 }
324 
325 void ClangDocBitcodeWriter::emitRecord(int Val, RecordId ID) {
326   assert(RecordIdNameMap[ID] && "Unknown RecordId.");
327   assert(RecordIdNameMap[ID].Abbrev == &IntAbbrev && "Abbrev type mismatch.");
328   if (!prepRecordData(ID, Val))
329     return;
330   // FIXME: Assert that the integer is of the appropriate size.
331   Record.push_back(Val);
332   Stream.EmitRecordWithAbbrev(Abbrevs.get(ID), Record);
333 }
334 
335 void ClangDocBitcodeWriter::emitRecord(unsigned Val, RecordId ID) {
336   assert(RecordIdNameMap[ID] && "Unknown RecordId.");
337   assert(RecordIdNameMap[ID].Abbrev == &IntAbbrev && "Abbrev type mismatch.");
338   if (!prepRecordData(ID, Val))
339     return;
340   assert(Val < (1U << BitCodeConstants::IntSize));
341   Record.push_back(Val);
342   Stream.EmitRecordWithAbbrev(Abbrevs.get(ID), Record);
343 }
344 
345 bool ClangDocBitcodeWriter::prepRecordData(RecordId ID, bool ShouldEmit) {
346   assert(RecordIdNameMap[ID] && "Unknown RecordId.");
347   if (!ShouldEmit)
348     return false;
349   Record.clear();
350   Record.push_back(ID);
351   return true;
352 }
353 
354 // BlockInfo Block
355 
356 void ClangDocBitcodeWriter::emitBlockInfoBlock() {
357   Stream.EnterBlockInfoBlock();
358   for (const auto &Block : RecordsByBlock) {
359     assert(Block.second.size() < (1U << BitCodeConstants::SubblockIDSize));
360     emitBlockInfo(Block.first, Block.second);
361   }
362   Stream.ExitBlock();
363 }
364 
365 void ClangDocBitcodeWriter::emitBlockInfo(BlockId BID,
366                                           const std::vector<RecordId> &RIDs) {
367   assert(RIDs.size() < (1U << BitCodeConstants::SubblockIDSize));
368   emitBlockID(BID);
369   for (RecordId RID : RIDs) {
370     emitRecordID(RID);
371     emitAbbrev(RID, BID);
372   }
373 }
374 
375 // Block emission
376 
377 void ClangDocBitcodeWriter::emitBlock(const Reference &R, FieldId Field) {
378   if (R.USR == EmptySID && R.Name.empty())
379     return;
380   StreamSubBlockGuard Block(Stream, BI_REFERENCE_BLOCK_ID);
381   emitRecord(R.USR, REFERENCE_USR);
382   emitRecord(R.Name, REFERENCE_NAME);
383   emitRecord((unsigned)R.RefType, REFERENCE_TYPE);
384   emitRecord((unsigned)Field, REFERENCE_FIELD);
385 }
386 
387 void ClangDocBitcodeWriter::emitBlock(const TypeInfo &T) {
388   StreamSubBlockGuard Block(Stream, BI_TYPE_BLOCK_ID);
389   emitBlock(T.Type, FieldId::F_type);
390 }
391 
392 void ClangDocBitcodeWriter::emitBlock(const FieldTypeInfo &T) {
393   StreamSubBlockGuard Block(Stream, BI_FIELD_TYPE_BLOCK_ID);
394   emitBlock(T.Type, FieldId::F_type);
395   emitRecord(T.Name, FIELD_TYPE_NAME);
396 }
397 
398 void ClangDocBitcodeWriter::emitBlock(const MemberTypeInfo &T) {
399   StreamSubBlockGuard Block(Stream, BI_MEMBER_TYPE_BLOCK_ID);
400   emitBlock(T.Type, FieldId::F_type);
401   emitRecord(T.Name, MEMBER_TYPE_NAME);
402   emitRecord(T.Access, MEMBER_TYPE_ACCESS);
403 }
404 
405 void ClangDocBitcodeWriter::emitBlock(const CommentInfo &I) {
406   StreamSubBlockGuard Block(Stream, BI_COMMENT_BLOCK_ID);
407   for (const auto &L : std::vector<std::pair<llvm::StringRef, RecordId>>{
408            {I.Kind, COMMENT_KIND},
409            {I.Text, COMMENT_TEXT},
410            {I.Name, COMMENT_NAME},
411            {I.Direction, COMMENT_DIRECTION},
412            {I.ParamName, COMMENT_PARAMNAME},
413            {I.CloseName, COMMENT_CLOSENAME}})
414     emitRecord(L.first, L.second);
415   emitRecord(I.SelfClosing, COMMENT_SELFCLOSING);
416   emitRecord(I.Explicit, COMMENT_EXPLICIT);
417   for (const auto &A : I.AttrKeys)
418     emitRecord(A, COMMENT_ATTRKEY);
419   for (const auto &A : I.AttrValues)
420     emitRecord(A, COMMENT_ATTRVAL);
421   for (const auto &A : I.Args)
422     emitRecord(A, COMMENT_ARG);
423   for (const auto &C : I.Children)
424     emitBlock(*C);
425 }
426 
427 #define EMITINFO(X)                                                            \
428   emitRecord(I.USR, X##_USR);                                                  \
429   emitRecord(I.Name, X##_NAME);                                                \
430   for (const auto &N : I.Namespace)                                            \
431     emitBlock(N, FieldId::F_namespace);                                        \
432   for (const auto &CI : I.Description)                                         \
433     emitBlock(CI);
434 
435 void ClangDocBitcodeWriter::emitBlock(const NamespaceInfo &I) {
436   StreamSubBlockGuard Block(Stream, BI_NAMESPACE_BLOCK_ID);
437   EMITINFO(NAMESPACE)
438 }
439 
440 void ClangDocBitcodeWriter::emitBlock(const EnumInfo &I) {
441   StreamSubBlockGuard Block(Stream, BI_ENUM_BLOCK_ID);
442   EMITINFO(ENUM)
443   if (I.DefLoc)
444     emitRecord(I.DefLoc.getValue(), ENUM_DEFLOCATION);
445   for (const auto &L : I.Loc)
446     emitRecord(L, ENUM_LOCATION);
447   emitRecord(I.Scoped, ENUM_SCOPED);
448   for (const auto &N : I.Members)
449     emitRecord(N, ENUM_MEMBER);
450 }
451 
452 void ClangDocBitcodeWriter::emitBlock(const RecordInfo &I) {
453   StreamSubBlockGuard Block(Stream, BI_RECORD_BLOCK_ID);
454   EMITINFO(RECORD)
455   if (I.DefLoc)
456     emitRecord(I.DefLoc.getValue(), RECORD_DEFLOCATION);
457   for (const auto &L : I.Loc)
458     emitRecord(L, RECORD_LOCATION);
459   emitRecord(I.TagType, RECORD_TAG_TYPE);
460   for (const auto &N : I.Members)
461     emitBlock(N);
462   for (const auto &P : I.Parents)
463     emitBlock(P, FieldId::F_parent);
464   for (const auto &P : I.VirtualParents)
465     emitBlock(P, FieldId::F_vparent);
466 }
467 
468 void ClangDocBitcodeWriter::emitBlock(const FunctionInfo &I) {
469   StreamSubBlockGuard Block(Stream, BI_FUNCTION_BLOCK_ID);
470   EMITINFO(FUNCTION)
471   emitRecord(I.IsMethod, FUNCTION_IS_METHOD);
472   if (I.DefLoc)
473     emitRecord(I.DefLoc.getValue(), FUNCTION_DEFLOCATION);
474   for (const auto &L : I.Loc)
475     emitRecord(L, FUNCTION_LOCATION);
476   emitBlock(I.Parent, FieldId::F_parent);
477   emitBlock(I.ReturnType);
478   for (const auto &N : I.Params)
479     emitBlock(N);
480 }
481 
482 #undef EMITINFO
483 
484 } // namespace doc
485 } // namespace clang
486