DebugInfo/PDB/IPDBDataStream.h

0001 //===- IPDBDataStream.h - base interface for child enumerator ---*- C++ -*-===//
0002 //
0003 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
0004 // See https://llvm.org/LICENSE.txt for license information.
0005 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
0006 //
0007 //===----------------------------------------------------------------------===//
0008
0009 #ifndef LLVM_DEBUGINFO_PDB_IPDBDATASTREAM_H
0010 #define LLVM_DEBUGINFO_PDB_IPDBDATASTREAM_H
0011
0012 #include "llvm/ADT/SmallVector.h"
0013 #include <cstdint>
0014 #include <optional>
0015 #include <string>
0016
0017 namespace llvm {
0018 namespace pdb {
0019
0020 /// IPDBDataStream defines an interface used to represent a stream consisting
0021 /// of a name and a series of records whose formats depend on the particular
0022 /// stream type.
0023 class IPDBDataStream {
0024 public:
0025   using RecordType = SmallVector<uint8_t, 32>;
0026
0027   virtual ~IPDBDataStream();
0028
0029   virtual uint32_t getRecordCount() const = 0;
0030   virtual std::string getName() const = 0;
0031   virtual std::optional<RecordType> getItemAtIndex(uint32_t Index) const = 0;
0032   virtual bool getNext(RecordType &Record) = 0;
0033   virtual void reset() = 0;
0034 };
0035
0036 } // end namespace pdb
0037 } // end namespace llvm
0038
0039 #endif // LLVM_DEBUGINFO_PDB_IPDBDATASTREAM_H