22e6a261fa
This is a set of squashed reverts of recent clang doc patches, since its breaking something on Darwin builders: https://lab.llvm.org/buildbot/#/builders/23/builds/19172 Revert "[clang-doc][nfc] Default initialize all StringRef members (#191641)" This reverts commit155b9b354c. Revert "[clang-doc] Initialize StringRef members in Info types (#191637)" This reverts commit489dab3827. Revert "[clang-doc] Initialize member variable (#191570)" This reverts commit5d64a44a84. Revert "[clang-doc] Merge data into persistent memory (#190056)" This reverts commit21e0034c69. Revert "[clang-doc] Support deep copy between arenas for merging (#190055)" This reverts commitc70dae8b0c.
87 lines
3.2 KiB
C++
87 lines
3.2 KiB
C++
//===-- BitcodeReader.h - ClangDoc Bitcode Reader --------------*- C++ -*-===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This file implements a reader for parsing the clang-doc internal
|
|
// representation from 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 "llvm/Bitstream/BitstreamReader.h"
|
|
#include "llvm/Support/Error.h"
|
|
#include <optional>
|
|
|
|
namespace clang {
|
|
namespace doc {
|
|
|
|
// Class to read bitstream into an InfoSet collection
|
|
class ClangDocBitcodeReader {
|
|
public:
|
|
ClangDocBitcodeReader(llvm::BitstreamCursor &Stream, DiagnosticsEngine &Diags)
|
|
: Stream(Stream), Diags(Diags) {}
|
|
|
|
// Main entry point, calls readBlock to read each block in the given stream.
|
|
llvm::Expected<OwningPtrArray<Info>> readBitcode();
|
|
|
|
private:
|
|
enum class Cursor { BadBlock = 1, Record, BlockEnd, BlockBegin };
|
|
|
|
// Top level parsing
|
|
llvm::Error validateStream();
|
|
llvm::Error readVersion();
|
|
llvm::Error readBlockInfoBlock();
|
|
|
|
// Read a block of records into a single Info struct, calls readRecord on each
|
|
// record found.
|
|
template <typename T> llvm::Error readBlock(unsigned ID, T I);
|
|
|
|
template <typename T, typename BlockBeginHandler, typename BlockEndHandler,
|
|
typename RecordHandler>
|
|
llvm::Error parseBlock(unsigned ID, T I, BlockBeginHandler &&BBH,
|
|
BlockEndHandler &&BEH, RecordHandler &&RH);
|
|
|
|
// Step through a block of records to find the next data field.
|
|
template <typename T> llvm::Error readSubBlock(unsigned ID, T I);
|
|
|
|
// Read record data into the given Info data field, calling the appropriate
|
|
// parseRecord functions to parse and store the data.
|
|
template <typename T> llvm::Error readRecord(unsigned ID, T I);
|
|
|
|
// Allocate the relevant type of info and add read data to the object.
|
|
template <typename T> llvm::Expected<OwnedPtr<Info>> createInfo(unsigned ID);
|
|
|
|
// Helper function to step through blocks to find and dispatch the next record
|
|
// or block to be read.
|
|
llvm::Expected<Cursor> skipUntilRecordOrBlock(unsigned &BlockOrRecordID);
|
|
|
|
// Helper function to set up the appropriate type of Info.
|
|
llvm::Expected<OwnedPtr<Info>> readBlockToInfo(unsigned ID);
|
|
|
|
template <typename InfoType, typename T, typename CallbackFunction>
|
|
llvm::Error handleSubBlock(unsigned ID, T Parent, CallbackFunction Function);
|
|
|
|
template <typename InfoType, typename T, typename CallbackFunction>
|
|
llvm::Error handleTypeSubBlock(unsigned ID, T Parent,
|
|
CallbackFunction Function);
|
|
|
|
llvm::BitstreamCursor &Stream;
|
|
std::optional<llvm::BitstreamBlockInfo> BlockInfo;
|
|
FieldId CurrentReferenceField;
|
|
DiagnosticsEngine &Diags;
|
|
};
|
|
|
|
} // namespace doc
|
|
} // namespace clang
|
|
|
|
#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_DOC_BITCODEREADER_H
|