include/llvm/DebugInfo/MSF/IMSFFile.h

   1 //===- IMSFFile.h - Abstract base class for an MSF file ---------*- C++ -*-===//
   2 //
   3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
   4 // See https://llvm.org/LICENSE.txt for license information.
   5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
   6 //
   7 //===----------------------------------------------------------------------===//
   8
   9 #ifndef LLVM_DEBUGINFO_MSF_IMSFFILE_H
  10 #define LLVM_DEBUGINFO_MSF_IMSFFILE_H
  11
  12 #include "llvm/ADT/ArrayRef.h"
  13 #include "llvm/Support/Endian.h"
  14 #include "llvm/Support/Error.h"
  15 #include <cstdint>
  16
  17 namespace llvm {
  18 namespace msf {
  19
  20 class IMSFFile {
  21 public:
  22   virtual ~IMSFFile() = default;
  23
  24   virtual uint32_t getBlockSize() const = 0;
  25   virtual uint32_t getBlockCount() const = 0;
  26
  27   virtual uint32_t getNumStreams() const = 0;
  28   virtual uint32_t getStreamByteSize(uint32_t StreamIndex) const = 0;
  29   virtual ArrayRef<support::ulittle32_t>
  30   getStreamBlockList(uint32_t StreamIndex) const = 0;
  31
  32   virtual Expected<ArrayRef<uint8_t>> getBlockData(uint32_t BlockIndex,
  33                                                    uint32_t NumBytes) const = 0;
  34   virtual Error setBlockData(uint32_t BlockIndex, uint32_t Offset,
  35                              ArrayRef<uint8_t> Data) const = 0;
  36 };
  37
  38 } // end namespace msf
  39 } // end namespace llvm
  40
  41 #endif // LLVM_DEBUGINFO_MSF_IMSFFILE_H