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 namespace crashpad { |
| 21 namespace test { |
| 22 |
| 23 // These functions format messages in a similar way to the PLOG and PCHECK |
| 24 // family of logging macros in base/logging.h. They exist to interoperate with |
| 25 // gtest assertions, which don’t interoperate with logging but can be streamed |
| 26 // to. |
| 27 // |
| 28 // Where non-test code could do: |
| 29 // PCHECK(rv == 0) << "close"; |
| 30 // gtest-based test code can do: |
| 31 // EXPECT_EQ(0, rv) << ErrnoMessage("close"); |
| 32 |
| 33 //! \brief Formats an error message using an `errno` value. |
| 34 //! |
| 35 //! The returned string will combine the \a base string, if supplied, with a |
| 36 //! a textual and numeric description of the error. |
| 37 //! |
| 38 //! The message is formatted using `strerror()`. \a err may be `0` or outside of |
| 39 //! the range of known error codes, and the message returned will contain the |
| 40 //! string that `strerror()` uses in these cases. |
| 41 //! |
| 42 //! \param[in] err The error code, usable as an `errno` value. |
| 43 //! \param[in] base A string to prepend to the error description. |
| 44 //! |
| 45 //! \return A string of the format `"Operation not permitted (1)"` if \a err has |
| 46 //! the value `EPERM` on a system where this is defined to be `1`. If \a |
| 47 //! base is not empty, it will be prepended to this string, separated by a |
| 48 //! colon. |
| 49 std::string ErrnoMessage(int err, const std::string& base = std::string()); |
| 50 |
| 51 //! \brief Formats an error message using `errno`. |
| 52 //! |
| 53 //! The returned string will combine the \a base string, if supplied, with a |
| 54 //! a textual and numeric description of the error. |
| 55 //! |
| 56 //! The message is formatted using `strerror()`. `errno` may be `0` or outside |
| 57 //! of the range of known error codes, and the message returned will contain the |
| 58 //! string that `strerror()` uses in these cases. |
| 59 //! |
| 60 //! \param[in] base A string to prepend to the error description. |
| 61 //! |
| 62 //! \return A string of the format `"Operation not permitted (1)"` if `errno` |
| 63 //! has the value `EPERM` on a system where this is defined to be `1`. If |
| 64 //! \a base is not empty, it will be prepended to this string, separated by |
| 65 //! a colon. |
| 66 std::string ErrnoMessage(const std::string& base = std::string()); |
| 67 |
| 68 } // namespace test |
| 69 } // namespace crashpad |
| 70 |
| 71 #endif // CRASHPAD_UTIL_TEST_ERRORS_H_ |
OLD | NEW |