DebugInfo/MSF/IMSFFile.h

0001 //===- IMSFFile.h - Abstract base class for an MSF file ---------*- 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_MSF_IMSFFILE_H
0010 #define LLVM_DEBUGINFO_MSF_IMSFFILE_H
0011
0012 #include "llvm/ADT/ArrayRef.h"
0013 #include "llvm/Support/Endian.h"
0014 #include "llvm/Support/Error.h"
0015 #include <cstdint>
0016
0017 namespace llvm {
0018 namespace msf {
0019
0020 class IMSFFile {
0021 public:
0022   virtual ~IMSFFile() = default;
0023
0024   virtual uint32_t getBlockSize() const = 0;
0025   virtual uint32_t getBlockCount() const = 0;
0026
0027   virtual uint32_t getNumStreams() const = 0;
0028   virtual uint32_t getStreamByteSize(uint32_t StreamIndex) const = 0;
0029   virtual ArrayRef<support::ulittle32_t>
0030   getStreamBlockList(uint32_t StreamIndex) const = 0;
0031
0032   virtual Expected<ArrayRef<uint8_t>> getBlockData(uint32_t BlockIndex,
0033                                                    uint32_t NumBytes) const = 0;
0034   virtual Error setBlockData(uint32_t BlockIndex, uint32_t Offset,
0035                              ArrayRef<uint8_t> Data) const = 0;
0036 };
0037
0038 } // end namespace msf
0039 } // end namespace llvm
0040
0041 #endif // LLVM_DEBUGINFO_MSF_IMSFFILE_H