//===- StreamReader.h - Reads bytes and objects from a stream ---*- C++ -*-===//
//
//                     The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//

#ifndef LLVM_DEBUGINFO_CODEVIEW_STREAMREADER_H
#define LLVM_DEBUGINFO_CODEVIEW_STREAMREADER_H

#include "llvm/ADT/ArrayRef.h"
#include "llvm/DebugInfo/CodeView/StreamInterface.h"
#include "llvm/Support/Endian.h"
#include "llvm/Support/Error.h"

#include <string>

namespace llvm {
namespace codeview {

class StreamReader {
public:
  StreamReader(const StreamInterface &S);

  Error readBytes(MutableArrayRef<uint8_t> Buffer);
  Error readInteger(uint32_t &Dest);
  Error readZeroString(std::string &Dest);

  template <typename T> Error readObject(T *Dest) {
    MutableArrayRef<uint8_t> Buffer(reinterpret_cast<uint8_t *>(Dest),
                                    sizeof(T));
    return readBytes(Buffer);
  }

  template <typename T> Error readArray(MutableArrayRef<T> Array) {
    MutableArrayRef<uint8_t> Casted(reinterpret_cast<uint8_t *>(Array.data()),
                                    Array.size() * sizeof(T));
    return readBytes(Casted);
  }

  Error getArrayRef(ArrayRef<uint8_t> &Array, uint32_t Length);

  void setOffset(uint32_t Off) { Offset = Off; }
  uint32_t getOffset() const { return Offset; }
  uint32_t getLength() const { return Stream.getLength(); }
  uint32_t bytesRemaining() const { return getLength() - getOffset(); }

private:
  const StreamInterface &Stream;
  uint32_t Offset;
};
} // namespace codeview
} // namespace llvm

#endif // LLVM_DEBUGINFO_CODEVIEW_STREAMREADER_H