OLD | NEW |
| (Empty) |
1 // Copyright 2014 The Crashpad Authors. All rights reserved. | |
2 // | |
3 // Licensed under the Apache License, Version 2.0 (the "License"); | |
4 // you may not use this file except in compliance with the License. | |
5 // You may obtain a copy of the License at | |
6 // | |
7 // http://www.apache.org/licenses/LICENSE-2.0 | |
8 // | |
9 // Unless required by applicable law or agreed to in writing, software | |
10 // distributed under the License is distributed on an "AS IS" BASIS, | |
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
12 // See the License for the specific language governing permissions and | |
13 // limitations under the License. | |
14 | |
15 #ifndef CRASHPAD_UTIL_TEST_ERRORS_H_ | |
16 #define CRASHPAD_UTIL_TEST_ERRORS_H_ | |
17 | |
18 #include <string> | |
19 | |
20 #include "build/build_config.h" | |
21 | |
22 namespace crashpad { | |
23 namespace test { | |
24 | |
25 // These functions format messages in a similar way to the PLOG and PCHECK | |
26 // family of logging macros in base/logging.h. They exist to interoperate with | |
27 // gtest assertions, which don’t interoperate with logging but can be streamed | |
28 // to. | |
29 // | |
30 // Where non-test code could do: | |
31 // PCHECK(rv == 0) << "close"; | |
32 // gtest-based test code can do: | |
33 // EXPECT_EQ(0, rv) << ErrnoMessage("close"); | |
34 | |
35 //! \brief Formats an error message using an `errno` value. | |
36 //! | |
37 //! The returned string will combine the \a base string, if supplied, with a | |
38 //! a textual and numeric description of the error. | |
39 //! | |
40 //! The message is formatted using `strerror()`. \a err may be `0` or outside of | |
41 //! the range of known error codes, and the message returned will contain the | |
42 //! string that `strerror()` uses in these cases. | |
43 //! | |
44 //! \param[in] err The error code, usable as an `errno` value. | |
45 //! \param[in] base A string to prepend to the error description. | |
46 //! | |
47 //! \return A string of the format `"Operation not permitted (1)"` if \a err has | |
48 //! the value `EPERM` on a system where this is defined to be `1`. If \a | |
49 //! base is not empty, it will be prepended to this string, separated by a | |
50 //! colon. | |
51 std::string ErrnoMessage(int err, const std::string& base = std::string()); | |
52 | |
53 //! \brief Formats an error message using `errno`. | |
54 //! | |
55 //! The returned string will combine the \a base string, if supplied, with a | |
56 //! a textual and numeric description of the error. | |
57 //! | |
58 //! The message is formatted using `strerror()`. `errno` may be `0` or outside | |
59 //! of the range of known error codes, and the message returned will contain the | |
60 //! string that `strerror()` uses in these cases. | |
61 //! | |
62 //! \param[in] base A string to prepend to the error description. | |
63 //! | |
64 //! \return A string of the format `"Operation not permitted (1)"` if `errno` | |
65 //! has the value `EPERM` on a system where this is defined to be `1`. If | |
66 //! \a base is not empty, it will be prepended to this string, separated by | |
67 //! a colon. | |
68 std::string ErrnoMessage(const std::string& base = std::string()); | |
69 | |
70 #if defined(OS_WIN) || DOXYGEN | |
71 //! \brief Formats an error message using `GetLastError()`. | |
72 //! | |
73 //! The returned string will combine the \a base string, if supplied, with a | |
74 //! a textual and numeric description of the error. The format is the same as | |
75 //! the `PLOG()` formatting in base. | |
76 std::string ErrorMessage(const std::string& base = std::string()); | |
77 #endif | |
78 | |
79 } // namespace test | |
80 } // namespace crashpad | |
81 | |
82 #endif // CRASHPAD_UTIL_TEST_ERRORS_H_ | |
OLD | NEW |