Viet-Hoa Do | ce3c48c | 2023-07-03 13:44:43 +0100 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2023 Arm Limited. |
| 3 | * |
| 4 | * SPDX-License-Identifier: MIT |
| 5 | * |
| 6 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
| 7 | * of this software and associated documentation files (the "Software"), to |
| 8 | * deal in the Software without restriction, including without limitation the |
| 9 | * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or |
| 10 | * sell copies of the Software, and to permit persons to whom the Software is |
| 11 | * furnished to do so, subject to the following conditions: |
| 12 | * |
| 13 | * The above copyright notice and this permission notice shall be included in all |
| 14 | * copies or substantial portions of the Software. |
| 15 | * |
| 16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 19 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| 22 | * SOFTWARE. |
| 23 | */ |
| 24 | |
| 25 | #ifndef CKW_PROTOTYPE_INCLUDE_CKW_ERROR_H |
| 26 | #define CKW_PROTOTYPE_INCLUDE_CKW_ERROR_H |
| 27 | |
| 28 | #include <stdexcept> |
| 29 | #include <string> |
| 30 | |
| 31 | namespace ckw |
| 32 | { |
| 33 | |
| 34 | /** If the condition is not met, throw an std::runtime_error with the specified message. |
| 35 | * |
| 36 | * @param[in] cond The condition that is expected to be true. |
| 37 | * @param[in] msg The error message when the condition is not met. |
| 38 | */ |
| 39 | #define CKW_ASSERT_MSG(cond, msg) \ |
| 40 | do \ |
| 41 | { \ |
| 42 | if(!(cond)) \ |
| 43 | { \ |
| 44 | throw ::std::runtime_error(msg); \ |
| 45 | } \ |
| 46 | } while(false) |
| 47 | |
| 48 | /** If the condition is not met, throw an std::runtime_error. |
| 49 | * |
| 50 | * @param[in] cond The condition that is expected to be true. |
| 51 | */ |
| 52 | #define CKW_ASSERT(cond) CKW_ASSERT_MSG(cond, #cond) |
| 53 | |
| 54 | /** If the precondition is met but the consequence is not met, throw an std::runtime_error. |
| 55 | * |
| 56 | * @param[in] precond The condition if is met requires the consequence must also be met. |
| 57 | * @param[in] cond The condition that is expected to be true if the precondition is true. |
| 58 | */ |
| 59 | #define CKW_ASSERT_IF(precond, cond) \ |
| 60 | CKW_ASSERT_MSG(!(precond) || ((precond) && (cond)), #precond " |-> " #cond) |
| 61 | |
| 62 | /** Mark the variables as unused. |
| 63 | * |
| 64 | * @param[in] ... Variables which are unused. |
| 65 | */ |
| 66 | #define CKW_UNUSED(...) ::ckw::ignore_unused(__VA_ARGS__) // NOLINT |
| 67 | |
| 68 | /** Mark the variables as unused. |
| 69 | * |
| 70 | * @param[in] ... Variables which are unused. |
| 71 | */ |
| 72 | template <typename... T> |
| 73 | inline void ignore_unused(T &&...) |
| 74 | { |
| 75 | } |
| 76 | |
| 77 | } // namespace ckw |
| 78 | |
| 79 | #endif // CKW_INCLUDE_CKW_ERROR_H |