blob: 1748fd13f3dce7dbc248cc52aab916ccb1b7362a [file] [log] [blame]
Andrew Walbran16937d02019-10-22 13:54:20 +01001//===- TBEHandler.h ---------------------------------------------*- 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/// \file
10/// This file declares an interface for reading and writing .tbe (text-based
11/// ELF) files.
12///
13//===-----------------------------------------------------------------------===/
14
15#ifndef LLVM_TEXTAPI_ELF_TBEHANDLER_H
16#define LLVM_TEXTAPI_ELF_TBEHANDLER_H
17
18#include "llvm/Support/VersionTuple.h"
19#include "llvm/Support/Error.h"
20#include <memory>
21
22namespace llvm {
23
24class raw_ostream;
25class Error;
26class StringRef;
27class VersionTuple;
28
29namespace elfabi {
30
31class ELFStub;
32
33const VersionTuple TBEVersionCurrent(1, 0);
34
35/// Attempts to read an ELF interface file from a StringRef buffer.
36Expected<std::unique_ptr<ELFStub>> readTBEFromBuffer(StringRef Buf);
37
38/// Attempts to write an ELF interface file to a raw_ostream.
39Error writeTBEToOutputStream(raw_ostream &OS, const ELFStub &Stub);
40
41} // end namespace elfabi
42} // end namespace llvm
43
44#endif // LLVM_TEXTAPI_ELF_TBEHANDLER_H