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