include/llvm/DebugInfo/PDB/IPDBDataStream.h

   1 //===- IPDBDataStream.h - base interface for child enumerator -*- 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 #ifndef LLVM_DEBUGINFO_PDB_IPDBDATASTREAM_H
  11 #define LLVM_DEBUGINFO_PDB_IPDBDATASTREAM_H
  12
  13 #include "llvm/ADT/SmallVector.h"
  14 #include "llvm/ADT/Optional.h"
  15
  16 #include "PDBTypes.h"
  17
  18 namespace llvm {
  19
  20 /// IPDBDataStream defines an interface used to represent a stream consisting
  21 /// of a name and a series of records whose formats depend on the particular
  22 /// stream type.
  23 class IPDBDataStream {
  24 public:
  25   typedef llvm::SmallVector<uint8_t, 32> RecordType;
  26
  27   virtual ~IPDBDataStream();
  28
  29   virtual uint32_t getRecordCount() const = 0;
  30   virtual std::string getName() const = 0;
  31   virtual llvm::Optional<RecordType> getItemAtIndex(uint32_t Index) const = 0;
  32   virtual bool getNext(RecordType &Record) = 0;
  33   virtual void reset() = 0;
  34   virtual std::unique_ptr<IPDBDataStream> clone() const = 0;
  35 };
  36 }
  37
  38 #endif