• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 // Copyright 2021 The Pigweed Authors
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License"); you may not
4 // use this file except in compliance with the License. You may obtain a copy of
5 // the License at
6 //
7 //     https://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, WITHOUT
11 // WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
12 // License for the specific language governing permissions and limitations under
13 // the License.
14 #pragma once
15 
16 // PW_ASSERT_ENABLE_DEBUG controls whether DCHECKs and DASSERTs are enabled.
17 //
18 // This block defines PW_ASSERT_ENABLE_DEBUG if it is not already, taking into
19 // account traditional NDEBUG macro.
20 #if !defined(PW_ASSERT_ENABLE_DEBUG)
21 #if defined(NDEBUG)
22 // Release mode; remove all DCHECK*() and DASSERT() asserts.
23 #define PW_ASSERT_ENABLE_DEBUG 0
24 #else
25 // Debug mode; keep all DCHECK*() and DASSERT() asserts.
26 #define PW_ASSERT_ENABLE_DEBUG 1
27 #endif  // defined (NDEBUG)
28 #endif  // !defined(PW_ASSERT_ENABLE_DEBUG)
29 
30 // PW_ASSERT_CAPTURE_VALUES controls whether the evaluated values of a CHECK are
31 // captured in the final string. Disabling this will reduce codesize at CHECK
32 // callsites.
33 #if !defined(PW_ASSERT_CAPTURE_VALUES)
34 #define PW_ASSERT_CAPTURE_VALUES 1
35 #endif  // !defined(PW_ASSERT_CAPTURE_VALUES)
36 
37 // Modes available for how to end an assert failure for pw_assert_basic.
38 #define PW_ASSERT_BASIC_ACTION_ABORT 100
39 #define PW_ASSERT_BASIC_ACTION_EXIT 101
40 #define PW_ASSERT_BASIC_ACTION_LOOP 102
41 
42 #ifdef PW_ASSERT_BASIC_ABORT
43 #error PW_ASSERT_BASIC_ABORT is deprecated! Use PW_ASSERT_BASIC_ACTION instead.
44 #endif  // PW_ASSERT_BASIC_ABORT
45 
46 // Set to one of the following to define how pw_basic_assert should act after an
47 // assert failure:
48 // - PW_ASSERT_BASIC_ACTION_ABORT: Call std::abort()
49 // - PW_ASSERT_BASIC_ACTION_EXIT: Call std::_Exit(-1)
50 // - PW_ASSERT_BASIC_ACTION_LOOP: Loop forever
51 #ifndef PW_ASSERT_BASIC_ACTION
52 #define PW_ASSERT_BASIC_ACTION PW_ASSERT_BASIC_ACTION_ABORT
53 #endif  // PW_ASSERT_BASIC_ACTION
54 
55 // Whether to show the CRASH ASCII art banner.
56 #ifndef PW_ASSERT_BASIC_SHOW_BANNER
57 #define PW_ASSERT_BASIC_SHOW_BANNER 1
58 #endif  // PW_ASSERT_BASIC_SHOW_BANNER
59 
60 // Whether to use ANSI colors.
61 #ifndef PW_ASSERT_BASIC_USE_COLORS
62 #define PW_ASSERT_BASIC_USE_COLORS 1
63 #endif  // PW_ASSERT_BASIC_USE_COLORS
64