1 //===- llvm/Support/Errc.h - Defines the llvm::errc enum --------*- 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 // While std::error_code works OK on all platforms we use, there are some
10 // some problems with std::errc that can be avoided by using our own
11 // enumeration:
12 //
13 // * std::errc is a namespace in some implementations. That means that ADL
14 // doesn't work and it is sometimes necessary to write std::make_error_code
15 // or in templates:
16 // using std::make_error_code;
17 // make_error_code(...);
18 //
19 // with this enum it is safe to always just use make_error_code.
20 //
21 // * Some implementations define fewer names than others. This header has
22 // the intersection of all the ones we support.
23 //
24 // * std::errc is just marked with is_error_condition_enum. This means that
25 // common patterns like AnErrorCode == errc::no_such_file_or_directory take
26 // 4 virtual calls instead of two comparisons.
27 //===----------------------------------------------------------------------===//
28
29 #ifndef LLVM_SUPPORT_ERRC_H
30 #define LLVM_SUPPORT_ERRC_H
31
32 #include <system_error>
33
34 namespace llvm {
35 enum class errc {
36 argument_list_too_long = int(std::errc::argument_list_too_long),
37 argument_out_of_domain = int(std::errc::argument_out_of_domain),
38 bad_address = int(std::errc::bad_address),
39 bad_file_descriptor = int(std::errc::bad_file_descriptor),
40 broken_pipe = int(std::errc::broken_pipe),
41 // There is no delete_pending in std::errc; this error code is negative to
42 // avoid conflicts. This error roughly corresponds with Windows'
43 // STATUS_DELETE_PENDING 0xC0000056.
44 delete_pending = -56,
45 device_or_resource_busy = int(std::errc::device_or_resource_busy),
46 directory_not_empty = int(std::errc::directory_not_empty),
47 executable_format_error = int(std::errc::executable_format_error),
48 file_exists = int(std::errc::file_exists),
49 file_too_large = int(std::errc::file_too_large),
50 filename_too_long = int(std::errc::filename_too_long),
51 function_not_supported = int(std::errc::function_not_supported),
52 illegal_byte_sequence = int(std::errc::illegal_byte_sequence),
53 inappropriate_io_control_operation =
54 int(std::errc::inappropriate_io_control_operation),
55 interrupted = int(std::errc::interrupted),
56 invalid_argument = int(std::errc::invalid_argument),
57 invalid_seek = int(std::errc::invalid_seek),
58 io_error = int(std::errc::io_error),
59 is_a_directory = int(std::errc::is_a_directory),
60 no_child_process = int(std::errc::no_child_process),
61 no_lock_available = int(std::errc::no_lock_available),
62 no_space_on_device = int(std::errc::no_space_on_device),
63 no_such_device_or_address = int(std::errc::no_such_device_or_address),
64 no_such_device = int(std::errc::no_such_device),
65 no_such_file_or_directory = int(std::errc::no_such_file_or_directory),
66 no_such_process = int(std::errc::no_such_process),
67 not_a_directory = int(std::errc::not_a_directory),
68 not_enough_memory = int(std::errc::not_enough_memory),
69 not_supported = int(std::errc::not_supported),
70 operation_not_permitted = int(std::errc::operation_not_permitted),
71 permission_denied = int(std::errc::permission_denied),
72 read_only_file_system = int(std::errc::read_only_file_system),
73 resource_deadlock_would_occur = int(std::errc::resource_deadlock_would_occur),
74 resource_unavailable_try_again =
75 int(std::errc::resource_unavailable_try_again),
76 result_out_of_range = int(std::errc::result_out_of_range),
77 too_many_files_open_in_system = int(std::errc::too_many_files_open_in_system),
78 too_many_files_open = int(std::errc::too_many_files_open),
79 too_many_links = int(std::errc::too_many_links)
80 };
81
make_error_code(errc E)82 inline std::error_code make_error_code(errc E) {
83 return std::error_code(static_cast<int>(E), std::generic_category());
84 }
85 }
86
87 namespace std {
88 template <> struct is_error_code_enum<llvm::errc> : std::true_type {};
89 }
90 #endif
91