tools/llvm-readobj/llvm-readobj.h

   1 //===-- llvm-readobj.h ----------------------------------------------------===//
   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_TOOLS_LLVM_READOBJ_LLVM_READOBJ_H
  10 #define LLVM_TOOLS_LLVM_READOBJ_LLVM_READOBJ_H
  11
  12 #include "llvm/Support/CommandLine.h"
  13 #include "llvm/Support/Compiler.h"
  14 #include "llvm/Support/ErrorOr.h"
  15 #include "llvm/Support/Error.h"
  16 #include <string>
  17
  18 namespace llvm {
  19   namespace object {
  20     class RelocationRef;
  21   }
  22
  23   // Various helper functions.
  24   LLVM_ATTRIBUTE_NORETURN void reportError(Twine Msg);
  25   void reportError(StringRef Input, Error Err);
  26   void reportWarning(Twine Msg);
  27   void reportWarning(StringRef Input, Error Err);
  28   void warn(llvm::Error Err);
  29   void error(std::error_code EC);
  30   void error(llvm::Error EC);
  31   template <typename T> T error(llvm::Expected<T> &&E) {
  32     error(E.takeError());
  33     return std::move(*E);
  34   }
  35
  36   template <class T> T unwrapOrError(ErrorOr<T> EO) {
  37     if (EO)
  38       return *EO;
  39     reportError(EO.getError().message());
  40   }
  41
  42   // TODO: This one is deprecated. Use one with a Input name below.
  43   template <class T> T unwrapOrError(Expected<T> EO) {
  44     if (EO)
  45       return *EO;
  46     std::string Buf;
  47     raw_string_ostream OS(Buf);
  48     logAllUnhandledErrors(EO.takeError(), OS);
  49     OS.flush();
  50     reportError(Buf);
  51   }
  52
  53   template <class T> T unwrapOrError(StringRef Input, Expected<T> EO) {
  54     if (EO)
  55       return *EO;
  56     reportError(Input, EO.takeError());
  57     llvm_unreachable("reportError shouldn't return in this case");
  58   }
  59 } // namespace llvm
  60
  61 namespace opts {
  62   extern llvm::cl::opt<bool> SectionRelocations;
  63   extern llvm::cl::opt<bool> SectionSymbols;
  64   extern llvm::cl::opt<bool> SectionData;
  65   extern llvm::cl::opt<bool> ExpandRelocs;
  66   extern llvm::cl::opt<bool> RawRelr;
  67   extern llvm::cl::opt<bool> CodeViewSubsectionBytes;
  68   extern llvm::cl::opt<bool> Demangle;
  69   enum OutputStyleTy { LLVM, GNU };
  70   extern llvm::cl::opt<OutputStyleTy> Output;
  71 } // namespace opts
  72
  73 #define LLVM_READOBJ_ENUM_ENT(ns, enum) \
  74   { #enum, ns::enum }
  75
  76 #define LLVM_READOBJ_ENUM_CLASS_ENT(enum_class, enum) \
  77   { #enum, std::underlying_type<enum_class>::type(enum_class::enum) }
  78
  79 #endif