| // Copyright 2020 The Pigweed Authors |
| // |
| // Licensed under the Apache License, Version 2.0 (the "License"); you may not |
| // use this file except in compliance with the License. You may obtain a copy of |
| // the License at |
| // |
| // https://www.apache.org/licenses/LICENSE-2.0 |
| // |
| // Unless required by applicable law or agreed to in writing, software |
| // distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| // WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
| // License for the specific language governing permissions and limitations under |
| // the License. |
| #pragma once |
| |
| #include "pw_assert/options.h" // For PW_ASSERT_ENABLE_DEBUG |
| #include "pw_preprocessor/compiler.h" |
| #include "pw_preprocessor/util.h" |
| |
| PW_EXTERN_C_START |
| |
| PW_NO_RETURN void pw_assert_HandleFailure(void); |
| |
| PW_EXTERN_C_END |
| |
| // A header- and constexpr-safe version of PW_CHECK(). |
| // |
| // If the given condition is false, crash the system. Otherwise, do nothing. |
| // The condition is guaranteed to be evaluated. This assert implementation is |
| // guaranteed to be constexpr-safe. |
| // |
| // IMPORTANT: Unlike the PW_CHECK_*() suite of macros, this API captures no |
| // rich information like line numbers, the file, expression arguments, or the |
| // stringified expression. Use these macros only when absolutely necessary -- |
| // in headers, constexr contexts, or in rare cases where the call site overhead |
| // of a full PW_CHECK must be avoided. Use PW_CHECK_*() whenever possible. |
| #define PW_ASSERT(condition) \ |
| do { \ |
| if (!(condition)) { \ |
| pw_assert_HandleFailure(); \ |
| } \ |
| } while (0) |
| |
| // A header- and constexpr-safe version of PW_DCHECK(). |
| // |
| // Same as PW_ASSERT(), except that if PW_ASSERT_ENABLE_DEBUG == 1, the assert |
| // is disabled and condition is not evaluated. |
| // |
| // IMPORTANT: Unlike the PW_CHECK_*() suite of macros, this API captures no |
| // rich information like line numbers, the file, expression arguments, or the |
| // stringified expression. Use these macros only when absolutely necessary -- |
| // in headers, constexr contexts, or in rare cases where the call site overhead |
| // of a full PW_CHECK must be avoided. Use PW_DCHECK_*() whenever possible. |
| #define PW_DASSERT(condition) \ |
| do { \ |
| if ((PW_ASSERT_ENABLE_DEBUG == 1) && !(condition)) { \ |
| pw_assert_HandleFailure(); \ |
| } \ |
| } while (0) |