xref: /aosp_15_r20/external/pigweed/pw_span/public/pw_span/internal/config.h (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1 // Copyright 2022 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 /// @def PW_SPAN_ENABLE_ASSERTS
17 ///
18 /// @brief Controls whether `pw_span` includes asserts for detecting disallowed
19 /// span operations at runtime.
20 ///
21 /// For C++20 and later, this replaces `std::span` with the custom
22 /// implementation in `pw_span` to ensure bounds-checking asserts have been
23 /// enabled.
24 ///
25 /// This defaults to disabled because of the significant increase in code size
26 /// caused by enabling this feature. It's strongly recommended to enable this
27 /// in debug and testing builds.
28 #if !defined(PW_SPAN_ENABLE_ASSERTS)
29 #define PW_SPAN_ENABLE_ASSERTS 0
30 #endif  // !defined(PW_SPAN_ENABLE_ASSERTS)
31