1 //===- Error.h - system_error extensions for Object -------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This declares a new error_category for the Object library.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_OBJECT_ERROR_H
15 #define LLVM_OBJECT_ERROR_H
17 #include "llvm/ADT/Twine.h"
18 #include "llvm/Support/Error.h"
19 #include <system_error>
26 const std::error_category &object_category();
28 enum class object_error {
29 // Error code 0 is absent. Use std::error_code() instead.
34 string_table_non_null_end,
35 invalid_section_index,
36 bitcode_section_not_found,
40 inline std::error_code make_error_code(object_error e) {
41 return std::error_code(static_cast<int>(e), object_category());
44 /// Base class for all errors indicating malformed binary files.
46 /// Having a subclass for all malformed binary files allows archive-walking
47 /// code to skip malformed files without having to understand every possible
48 /// way that a binary file might be malformed.
50 /// Currently inherits from ECError for easy interoperability with
51 /// std::error_code, but this will be removed in the future.
52 class BinaryError : public ErrorInfo<BinaryError, ECError> {
56 // Default to parse_failed, can be overridden with setErrorCode.
57 setErrorCode(make_error_code(object_error::parse_failed));
61 /// Generic binary error.
63 /// For errors that don't require their own specific sub-error (most errors)
64 /// this class can be used to describe the error via a string message.
65 class GenericBinaryError : public ErrorInfo<GenericBinaryError, BinaryError> {
68 GenericBinaryError(Twine Msg);
69 GenericBinaryError(Twine Msg, object_error ECOverride);
70 const std::string &getMessage() const { return Msg; }
71 void log(raw_ostream &OS) const override;
76 /// isNotObjectErrorInvalidFileType() is used when looping through the children
77 /// of an archive after calling getAsBinary() on the child and it returns an
78 /// llvm::Error. In the cases we want to loop through the children and ignore the
79 /// non-objects in the archive this is used to test the error to see if an
80 /// error() function needs to called on the llvm::Error.
81 Error isNotObjectErrorInvalidFileType(llvm::Error Err);
83 } // end namespace object.
85 } // end namespace llvm.
89 struct is_error_code_enum<llvm::object::object_error> : std::true_type {};