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_TYPE_BLOCK_ID, "TypeBlock"}, 116 {BI_FIELD_TYPE_BLOCK_ID, "FieldTypeBlock"}, 117 {BI_MEMBER_TYPE_BLOCK_ID, "MemberTypeBlock"}, 118 {BI_RECORD_BLOCK_ID, "RecordBlock"}, 119 {BI_FUNCTION_BLOCK_ID, "FunctionBlock"}, 120 {BI_COMMENT_BLOCK_ID, "CommentBlock"}, 121 {BI_REFERENCE_BLOCK_ID, "ReferenceBlock"}}; 122 assert(Inits.size() == BlockIdCount); 123 for (const auto &Init : Inits) 124 BlockIdNameMap[Init.first] = Init.second; 125 assert(BlockIdNameMap.size() == BlockIdCount); 126 return BlockIdNameMap; 127 }(); 128 129 static const llvm::IndexedMap<RecordIdDsc, RecordIdToIndexFunctor> 130 RecordIdNameMap = []() { 131 llvm::IndexedMap<RecordIdDsc, RecordIdToIndexFunctor> RecordIdNameMap; 132 RecordIdNameMap.resize(RecordIdCount); 133 134 // There is no init-list constructor for the IndexedMap, so have to 135 // improvise 136 static const std::vector<std::pair<RecordId, RecordIdDsc>> Inits = { 137 {VERSION, {"Version", &IntAbbrev}}, 138 {COMMENT_KIND, {"Kind", &StringAbbrev}}, 139 {COMMENT_TEXT, {"Text", &StringAbbrev}}, 140 {COMMENT_NAME, {"Name", &StringAbbrev}}, 141 {COMMENT_DIRECTION, {"Direction", &StringAbbrev}}, 142 {COMMENT_PARAMNAME, {"ParamName", &StringAbbrev}}, 143 {COMMENT_CLOSENAME, {"CloseName", &StringAbbrev}}, 144 {COMMENT_SELFCLOSING, {"SelfClosing", &BoolAbbrev}}, 145 {COMMENT_EXPLICIT, {"Explicit", &BoolAbbrev}}, 146 {COMMENT_ATTRKEY, {"AttrKey", &StringAbbrev}}, 147 {COMMENT_ATTRVAL, {"AttrVal", &StringAbbrev}}, 148 {COMMENT_ARG, {"Arg", &StringAbbrev}}, 149 {FIELD_TYPE_NAME, {"Name", &StringAbbrev}}, 150 {MEMBER_TYPE_NAME, {"Name", &StringAbbrev}}, 151 {MEMBER_TYPE_ACCESS, {"Access", &IntAbbrev}}, 152 {NAMESPACE_USR, {"USR", &SymbolIDAbbrev}}, 153 {NAMESPACE_NAME, {"Name", &StringAbbrev}}, 154 {NAMESPACE_PATH, {"Path", &StringAbbrev}}, 155 {ENUM_USR, {"USR", &SymbolIDAbbrev}}, 156 {ENUM_NAME, {"Name", &StringAbbrev}}, 157 {ENUM_DEFLOCATION, {"DefLocation", &LocationAbbrev}}, 158 {ENUM_LOCATION, {"Location", &LocationAbbrev}}, 159 {ENUM_MEMBER, {"Member", &StringAbbrev}}, 160 {ENUM_SCOPED, {"Scoped", &BoolAbbrev}}, 161 {RECORD_USR, {"USR", &SymbolIDAbbrev}}, 162 {RECORD_NAME, {"Name", &StringAbbrev}}, 163 {RECORD_PATH, {"Path", &StringAbbrev}}, 164 {RECORD_DEFLOCATION, {"DefLocation", &LocationAbbrev}}, 165 {RECORD_LOCATION, {"Location", &LocationAbbrev}}, 166 {RECORD_TAG_TYPE, {"TagType", &IntAbbrev}}, 167 {RECORD_IS_TYPE_DEF, {"IsTypeDef", &BoolAbbrev}}, 168 {FUNCTION_USR, {"USR", &SymbolIDAbbrev}}, 169 {FUNCTION_NAME, {"Name", &StringAbbrev}}, 170 {FUNCTION_DEFLOCATION, {"DefLocation", &LocationAbbrev}}, 171 {FUNCTION_LOCATION, {"Location", &LocationAbbrev}}, 172 {FUNCTION_ACCESS, {"Access", &IntAbbrev}}, 173 {FUNCTION_IS_METHOD, {"IsMethod", &BoolAbbrev}}, 174 {REFERENCE_USR, {"USR", &SymbolIDAbbrev}}, 175 {REFERENCE_NAME, {"Name", &StringAbbrev}}, 176 {REFERENCE_TYPE, {"RefType", &IntAbbrev}}, 177 {REFERENCE_PATH, {"Path", &StringAbbrev}}, 178 {REFERENCE_IS_IN_GLOBAL_NAMESPACE, 179 {"IsInGlobalNamespace", &BoolAbbrev}}, 180 {REFERENCE_FIELD, {"Field", &IntAbbrev}}}; 181 assert(Inits.size() == RecordIdCount); 182 for (const auto &Init : Inits) { 183 RecordIdNameMap[Init.first] = Init.second; 184 assert((Init.second.Name.size() + 1) <= BitCodeConstants::RecordSize); 185 } 186 assert(RecordIdNameMap.size() == RecordIdCount); 187 return RecordIdNameMap; 188 }(); 189 190 static const std::vector<std::pair<BlockId, std::vector<RecordId>>> 191 RecordsByBlock{ 192 // Version Block 193 {BI_VERSION_BLOCK_ID, {VERSION}}, 194 // Comment Block 195 {BI_COMMENT_BLOCK_ID, 196 {COMMENT_KIND, COMMENT_TEXT, COMMENT_NAME, COMMENT_DIRECTION, 197 COMMENT_PARAMNAME, COMMENT_CLOSENAME, COMMENT_SELFCLOSING, 198 COMMENT_EXPLICIT, COMMENT_ATTRKEY, COMMENT_ATTRVAL, COMMENT_ARG}}, 199 // Type Block 200 {BI_TYPE_BLOCK_ID, {}}, 201 // FieldType Block 202 {BI_FIELD_TYPE_BLOCK_ID, {FIELD_TYPE_NAME}}, 203 // MemberType Block 204 {BI_MEMBER_TYPE_BLOCK_ID, {MEMBER_TYPE_NAME, MEMBER_TYPE_ACCESS}}, 205 // Enum Block 206 {BI_ENUM_BLOCK_ID, 207 {ENUM_USR, ENUM_NAME, ENUM_DEFLOCATION, ENUM_LOCATION, ENUM_MEMBER, 208 ENUM_SCOPED}}, 209 // Namespace Block 210 {BI_NAMESPACE_BLOCK_ID, 211 {NAMESPACE_USR, NAMESPACE_NAME, NAMESPACE_PATH}}, 212 // Record Block 213 {BI_RECORD_BLOCK_ID, 214 {RECORD_USR, RECORD_NAME, RECORD_PATH, RECORD_DEFLOCATION, 215 RECORD_LOCATION, RECORD_TAG_TYPE, RECORD_IS_TYPE_DEF}}, 216 // Function Block 217 {BI_FUNCTION_BLOCK_ID, 218 {FUNCTION_USR, FUNCTION_NAME, FUNCTION_DEFLOCATION, FUNCTION_LOCATION, 219 FUNCTION_ACCESS, FUNCTION_IS_METHOD}}, 220 // Reference Block 221 {BI_REFERENCE_BLOCK_ID, 222 {REFERENCE_USR, REFERENCE_NAME, REFERENCE_TYPE, REFERENCE_PATH, 223 REFERENCE_IS_IN_GLOBAL_NAMESPACE, REFERENCE_FIELD}}}; 224 225 // AbbreviationMap 226 227 constexpr unsigned char BitCodeConstants::Signature[]; 228 229 void ClangDocBitcodeWriter::AbbreviationMap::add(RecordId RID, 230 unsigned AbbrevID) { 231 assert(RecordIdNameMap[RID] && "Unknown RecordId."); 232 assert(Abbrevs.find(RID) == Abbrevs.end() && "Abbreviation already added."); 233 Abbrevs[RID] = AbbrevID; 234 } 235 236 unsigned ClangDocBitcodeWriter::AbbreviationMap::get(RecordId RID) const { 237 assert(RecordIdNameMap[RID] && "Unknown RecordId."); 238 assert(Abbrevs.find(RID) != Abbrevs.end() && "Unknown abbreviation."); 239 return Abbrevs.lookup(RID); 240 } 241 242 // Validation and Overview Blocks 243 244 /// \brief Emits the magic number header to check that its the right format, 245 /// in this case, 'DOCS'. 246 void ClangDocBitcodeWriter::emitHeader() { 247 for (char C : BitCodeConstants::Signature) 248 Stream.Emit((unsigned)C, BitCodeConstants::SignatureBitSize); 249 } 250 251 void ClangDocBitcodeWriter::emitVersionBlock() { 252 StreamSubBlockGuard Block(Stream, BI_VERSION_BLOCK_ID); 253 emitRecord(VersionNumber, VERSION); 254 } 255 256 /// \brief Emits a block ID and the block name to the BLOCKINFO block. 257 void ClangDocBitcodeWriter::emitBlockID(BlockId BID) { 258 const auto &BlockIdName = BlockIdNameMap[BID]; 259 assert(BlockIdName.data() && BlockIdName.size() && "Unknown BlockId."); 260 261 Record.clear(); 262 Record.push_back(BID); 263 Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_SETBID, Record); 264 Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_BLOCKNAME, 265 ArrayRef<unsigned char>(BlockIdName.bytes_begin(), 266 BlockIdName.bytes_end())); 267 } 268 269 /// \brief Emits a record name to the BLOCKINFO block. 270 void ClangDocBitcodeWriter::emitRecordID(RecordId ID) { 271 assert(RecordIdNameMap[ID] && "Unknown RecordId."); 272 prepRecordData(ID); 273 Record.append(RecordIdNameMap[ID].Name.begin(), 274 RecordIdNameMap[ID].Name.end()); 275 Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_SETRECORDNAME, Record); 276 } 277 278 // Abbreviations 279 280 void ClangDocBitcodeWriter::emitAbbrev(RecordId ID, BlockId Block) { 281 assert(RecordIdNameMap[ID] && "Unknown abbreviation."); 282 auto Abbrev = std::make_shared<llvm::BitCodeAbbrev>(); 283 Abbrev->Add(llvm::BitCodeAbbrevOp(ID)); 284 RecordIdNameMap[ID].Abbrev(Abbrev); 285 Abbrevs.add(ID, Stream.EmitBlockInfoAbbrev(Block, std::move(Abbrev))); 286 } 287 288 // Records 289 290 void ClangDocBitcodeWriter::emitRecord(const SymbolID &Sym, RecordId ID) { 291 assert(RecordIdNameMap[ID] && "Unknown RecordId."); 292 assert(RecordIdNameMap[ID].Abbrev == &SymbolIDAbbrev && 293 "Abbrev type mismatch."); 294 if (!prepRecordData(ID, Sym != EmptySID)) 295 return; 296 assert(Sym.size() == 20); 297 Record.push_back(Sym.size()); 298 Record.append(Sym.begin(), Sym.end()); 299 Stream.EmitRecordWithAbbrev(Abbrevs.get(ID), Record); 300 } 301 302 void ClangDocBitcodeWriter::emitRecord(llvm::StringRef Str, RecordId ID) { 303 assert(RecordIdNameMap[ID] && "Unknown RecordId."); 304 assert(RecordIdNameMap[ID].Abbrev == &StringAbbrev && 305 "Abbrev type mismatch."); 306 if (!prepRecordData(ID, !Str.empty())) 307 return; 308 assert(Str.size() < (1U << BitCodeConstants::StringLengthSize)); 309 Record.push_back(Str.size()); 310 Stream.EmitRecordWithBlob(Abbrevs.get(ID), Record, Str); 311 } 312 313 void ClangDocBitcodeWriter::emitRecord(const Location &Loc, RecordId ID) { 314 assert(RecordIdNameMap[ID] && "Unknown RecordId."); 315 assert(RecordIdNameMap[ID].Abbrev == &LocationAbbrev && 316 "Abbrev type mismatch."); 317 if (!prepRecordData(ID, true)) 318 return; 319 // FIXME: Assert that the line number is of the appropriate size. 320 Record.push_back(Loc.LineNumber); 321 assert(Loc.Filename.size() < (1U << BitCodeConstants::StringLengthSize)); 322 Record.push_back(Loc.IsFileInRootDir); 323 Record.push_back(Loc.Filename.size()); 324 Stream.EmitRecordWithBlob(Abbrevs.get(ID), Record, Loc.Filename); 325 } 326 327 void ClangDocBitcodeWriter::emitRecord(bool Val, RecordId ID) { 328 assert(RecordIdNameMap[ID] && "Unknown RecordId."); 329 assert(RecordIdNameMap[ID].Abbrev == &BoolAbbrev && "Abbrev type mismatch."); 330 if (!prepRecordData(ID, Val)) 331 return; 332 Record.push_back(Val); 333 Stream.EmitRecordWithAbbrev(Abbrevs.get(ID), Record); 334 } 335 336 void ClangDocBitcodeWriter::emitRecord(int Val, RecordId ID) { 337 assert(RecordIdNameMap[ID] && "Unknown RecordId."); 338 assert(RecordIdNameMap[ID].Abbrev == &IntAbbrev && "Abbrev type mismatch."); 339 if (!prepRecordData(ID, Val)) 340 return; 341 // FIXME: Assert that the integer is of the appropriate size. 342 Record.push_back(Val); 343 Stream.EmitRecordWithAbbrev(Abbrevs.get(ID), Record); 344 } 345 346 void ClangDocBitcodeWriter::emitRecord(unsigned Val, RecordId ID) { 347 assert(RecordIdNameMap[ID] && "Unknown RecordId."); 348 assert(RecordIdNameMap[ID].Abbrev == &IntAbbrev && "Abbrev type mismatch."); 349 if (!prepRecordData(ID, Val)) 350 return; 351 assert(Val < (1U << BitCodeConstants::IntSize)); 352 Record.push_back(Val); 353 Stream.EmitRecordWithAbbrev(Abbrevs.get(ID), Record); 354 } 355 356 bool ClangDocBitcodeWriter::prepRecordData(RecordId ID, bool ShouldEmit) { 357 assert(RecordIdNameMap[ID] && "Unknown RecordId."); 358 if (!ShouldEmit) 359 return false; 360 Record.clear(); 361 Record.push_back(ID); 362 return true; 363 } 364 365 // BlockInfo Block 366 367 void ClangDocBitcodeWriter::emitBlockInfoBlock() { 368 Stream.EnterBlockInfoBlock(); 369 for (const auto &Block : RecordsByBlock) { 370 assert(Block.second.size() < (1U << BitCodeConstants::SubblockIDSize)); 371 emitBlockInfo(Block.first, Block.second); 372 } 373 Stream.ExitBlock(); 374 } 375 376 void ClangDocBitcodeWriter::emitBlockInfo(BlockId BID, 377 const std::vector<RecordId> &RIDs) { 378 assert(RIDs.size() < (1U << BitCodeConstants::SubblockIDSize)); 379 emitBlockID(BID); 380 for (RecordId RID : RIDs) { 381 emitRecordID(RID); 382 emitAbbrev(RID, BID); 383 } 384 } 385 386 // Block emission 387 388 void ClangDocBitcodeWriter::emitBlock(const Reference &R, FieldId Field) { 389 if (R.USR == EmptySID && R.Name.empty()) 390 return; 391 StreamSubBlockGuard Block(Stream, BI_REFERENCE_BLOCK_ID); 392 emitRecord(R.USR, REFERENCE_USR); 393 emitRecord(R.Name, REFERENCE_NAME); 394 emitRecord((unsigned)R.RefType, REFERENCE_TYPE); 395 emitRecord(R.Path, REFERENCE_PATH); 396 emitRecord(R.IsInGlobalNamespace, REFERENCE_IS_IN_GLOBAL_NAMESPACE); 397 emitRecord((unsigned)Field, REFERENCE_FIELD); 398 } 399 400 void ClangDocBitcodeWriter::emitBlock(const TypeInfo &T) { 401 StreamSubBlockGuard Block(Stream, BI_TYPE_BLOCK_ID); 402 emitBlock(T.Type, FieldId::F_type); 403 } 404 405 void ClangDocBitcodeWriter::emitBlock(const FieldTypeInfo &T) { 406 StreamSubBlockGuard Block(Stream, BI_FIELD_TYPE_BLOCK_ID); 407 emitBlock(T.Type, FieldId::F_type); 408 emitRecord(T.Name, FIELD_TYPE_NAME); 409 } 410 411 void ClangDocBitcodeWriter::emitBlock(const MemberTypeInfo &T) { 412 StreamSubBlockGuard Block(Stream, BI_MEMBER_TYPE_BLOCK_ID); 413 emitBlock(T.Type, FieldId::F_type); 414 emitRecord(T.Name, MEMBER_TYPE_NAME); 415 emitRecord(T.Access, MEMBER_TYPE_ACCESS); 416 } 417 418 void ClangDocBitcodeWriter::emitBlock(const CommentInfo &I) { 419 StreamSubBlockGuard Block(Stream, BI_COMMENT_BLOCK_ID); 420 for (const auto &L : std::vector<std::pair<llvm::StringRef, RecordId>>{ 421 {I.Kind, COMMENT_KIND}, 422 {I.Text, COMMENT_TEXT}, 423 {I.Name, COMMENT_NAME}, 424 {I.Direction, COMMENT_DIRECTION}, 425 {I.ParamName, COMMENT_PARAMNAME}, 426 {I.CloseName, COMMENT_CLOSENAME}}) 427 emitRecord(L.first, L.second); 428 emitRecord(I.SelfClosing, COMMENT_SELFCLOSING); 429 emitRecord(I.Explicit, COMMENT_EXPLICIT); 430 for (const auto &A : I.AttrKeys) 431 emitRecord(A, COMMENT_ATTRKEY); 432 for (const auto &A : I.AttrValues) 433 emitRecord(A, COMMENT_ATTRVAL); 434 for (const auto &A : I.Args) 435 emitRecord(A, COMMENT_ARG); 436 for (const auto &C : I.Children) 437 emitBlock(*C); 438 } 439 440 void ClangDocBitcodeWriter::emitBlock(const NamespaceInfo &I) { 441 StreamSubBlockGuard Block(Stream, BI_NAMESPACE_BLOCK_ID); 442 emitRecord(I.USR, NAMESPACE_USR); 443 emitRecord(I.Name, NAMESPACE_NAME); 444 emitRecord(I.Path, NAMESPACE_PATH); 445 for (const auto &N : I.Namespace) 446 emitBlock(N, FieldId::F_namespace); 447 for (const auto &CI : I.Description) 448 emitBlock(CI); 449 for (const auto &C : I.ChildNamespaces) 450 emitBlock(C, FieldId::F_child_namespace); 451 for (const auto &C : I.ChildRecords) 452 emitBlock(C, FieldId::F_child_record); 453 for (const auto &C : I.ChildFunctions) 454 emitBlock(C); 455 for (const auto &C : I.ChildEnums) 456 emitBlock(C); 457 } 458 459 void ClangDocBitcodeWriter::emitBlock(const EnumInfo &I) { 460 StreamSubBlockGuard Block(Stream, BI_ENUM_BLOCK_ID); 461 emitRecord(I.USR, ENUM_USR); 462 emitRecord(I.Name, ENUM_NAME); 463 for (const auto &N : I.Namespace) 464 emitBlock(N, FieldId::F_namespace); 465 for (const auto &CI : I.Description) 466 emitBlock(CI); 467 if (I.DefLoc) 468 emitRecord(I.DefLoc.getValue(), ENUM_DEFLOCATION); 469 for (const auto &L : I.Loc) 470 emitRecord(L, ENUM_LOCATION); 471 emitRecord(I.Scoped, ENUM_SCOPED); 472 for (const auto &N : I.Members) 473 emitRecord(N, ENUM_MEMBER); 474 } 475 476 void ClangDocBitcodeWriter::emitBlock(const RecordInfo &I) { 477 StreamSubBlockGuard Block(Stream, BI_RECORD_BLOCK_ID); 478 emitRecord(I.USR, RECORD_USR); 479 emitRecord(I.Name, RECORD_NAME); 480 emitRecord(I.Path, RECORD_PATH); 481 for (const auto &N : I.Namespace) 482 emitBlock(N, FieldId::F_namespace); 483 for (const auto &CI : I.Description) 484 emitBlock(CI); 485 if (I.DefLoc) 486 emitRecord(I.DefLoc.getValue(), RECORD_DEFLOCATION); 487 for (const auto &L : I.Loc) 488 emitRecord(L, RECORD_LOCATION); 489 emitRecord(I.TagType, RECORD_TAG_TYPE); 490 emitRecord(I.IsTypeDef, RECORD_IS_TYPE_DEF); 491 for (const auto &N : I.Members) 492 emitBlock(N); 493 for (const auto &P : I.Parents) 494 emitBlock(P, FieldId::F_parent); 495 for (const auto &P : I.VirtualParents) 496 emitBlock(P, FieldId::F_vparent); 497 for (const auto &C : I.ChildRecords) 498 emitBlock(C, FieldId::F_child_record); 499 for (const auto &C : I.ChildFunctions) 500 emitBlock(C); 501 for (const auto &C : I.ChildEnums) 502 emitBlock(C); 503 } 504 505 void ClangDocBitcodeWriter::emitBlock(const FunctionInfo &I) { 506 StreamSubBlockGuard Block(Stream, BI_FUNCTION_BLOCK_ID); 507 emitRecord(I.USR, FUNCTION_USR); 508 emitRecord(I.Name, FUNCTION_NAME); 509 for (const auto &N : I.Namespace) 510 emitBlock(N, FieldId::F_namespace); 511 for (const auto &CI : I.Description) 512 emitBlock(CI); 513 emitRecord(I.IsMethod, FUNCTION_IS_METHOD); 514 if (I.DefLoc) 515 emitRecord(I.DefLoc.getValue(), FUNCTION_DEFLOCATION); 516 for (const auto &L : I.Loc) 517 emitRecord(L, FUNCTION_LOCATION); 518 emitBlock(I.Parent, FieldId::F_parent); 519 emitBlock(I.ReturnType); 520 for (const auto &N : I.Params) 521 emitBlock(N); 522 } 523 524 bool ClangDocBitcodeWriter::dispatchInfoForWrite(Info *I) { 525 switch (I->IT) { 526 case InfoType::IT_namespace: 527 emitBlock(*static_cast<clang::doc::NamespaceInfo *>(I)); 528 break; 529 case InfoType::IT_record: 530 emitBlock(*static_cast<clang::doc::RecordInfo *>(I)); 531 break; 532 case InfoType::IT_enum: 533 emitBlock(*static_cast<clang::doc::EnumInfo *>(I)); 534 break; 535 case InfoType::IT_function: 536 emitBlock(*static_cast<clang::doc::FunctionInfo *>(I)); 537 break; 538 default: 539 llvm::errs() << "Unexpected info, unable to write.\n"; 540 return true; 541 } 542 return false; 543 } 544 545 } // namespace doc 546 } // namespace clang 547