refactor: contract support library header fles are no longer included in compat_macros.h

docs/users_guide/use_cases/wide_compatibility.md

@@ -157,3 +157,23 @@ from additional features provided with the library).
 This macro resolves to either the `std` or `fmt` namespace, depending on the value of
 [MP_UNITS_API_STD_FORMAT](../../getting_started/installation_and_usage.md#MP_UNITS_API_STD_FORMAT)
 CMake option.
+
+### Contracts
+
+The mp-units library internally does contract checking by default. It can be disabled with a Conan
+or CMake option. However, when enabled, it can use either [gsl-lite](https://github.com/gsl-lite/gsl-lite)
+or [ms-gsl](https://github.com/microsoft/GSL). To write a code that is independent from the
+underlying framework, the following preprocessor macros are exposed:
+
+- `MP_UNITS_EXPECTS(expr)`
+- `MP_UNITS_EXPECTS_DEBUG(expr)`
+- `MP_UNITS_ASSERT(expr)`
+- `MP_UNITS_ASSERT_DEBUG(expr)`
+
+Their meaning is consistent with respective [gsl-lite](https://github.com/gsl-lite/gsl-lite?tab=readme-ov-file#contract-checking-configuration-macros).
+
+Also, to include the header files of the underlying framework, the following include should be used:
+
+```cpp
+#include <mp-units/ext/contracts.h>
+```

example/include/validated_type.h

@@ -24,6 +24,7 @@
 
 #include <mp-units/bits/hacks.h>
 #include <mp-units/compat_macros.h>
+#include <mp-units/ext/contracts.h>
 #include <compare>  // IWYU pragma: export
 #include <ostream>
 #include <utility>

src/core/CMakeLists.txt

@@ -44,6 +44,7 @@ add_mp_units_module(
             include/mp-units/bits/text_tools.h
             include/mp-units/bits/type_list.h
             include/mp-units/ext/algorithm.h
+            include/mp-units/ext/contracts.h
             include/mp-units/ext/fixed_string.h
             include/mp-units/ext/prime.h
             include/mp-units/ext/type_name.h

src/core/include/mp-units/bits/core_gmf.h

@@ -24,6 +24,7 @@
 
 #include <mp-units/bits/hacks.h>
 #include <mp-units/compat_macros.h>
+#include <mp-units/ext/contracts.h>
 #include <array>
 #include <compare>
 #include <concepts>

src/core/include/mp-units/bits/fmt.h

@@ -40,6 +40,7 @@
 #include <cstdint>
 #include <limits>
 #include <string_view>
+#include <mp-units/ext/contracts.h>
 #endif
 
 // most of the below code is based on/copied from fmtlib

src/core/include/mp-units/bits/ratio.h

@@ -27,6 +27,7 @@
 #include <mp-units/compat_macros.h>
 
 #ifndef MP_UNITS_IN_MODULE_INTERFACE
+#include <mp-units/ext/contracts.h>
 #include <compare>  // IWYU pragma: export
 #include <cstdint>
 #include <numeric>

src/core/include/mp-units/compat_macros.h

@@ -101,8 +101,6 @@ MP_UNITS_DIAGNOSTIC_POP
 
 #if MP_UNITS_API_CONTRACTS == 2 || __has_include(<gsl/gsl-lite.hpp>)
 
-#include <gsl/gsl-lite.hpp>
-
 #define MP_UNITS_EXPECTS(expr) gsl_Expects(expr)
 #define MP_UNITS_EXPECTS_DEBUG(expr) gsl_ExpectsDebug(expr)
 #define MP_UNITS_ASSERT(expr) gsl_Assert(expr)
@@ -110,9 +108,6 @@ MP_UNITS_DIAGNOSTIC_POP
 
 #elif MP_UNITS_API_CONTRACTS == 3 || __has_include(<gsl/gsl>)
 
-#include <gsl/gsl>
-#include <cassert>
-
 #define MP_UNITS_EXPECTS(expr) Expects(expr)
 #if defined NDEBUG
 #define MP_UNITS_EXPECTS_DEBUG(expr) static_cast<void>(0)

src/core/include/mp-units/ext/contracts.h

@@ -0,0 +1,49 @@
+// The MIT License (MIT)
+//
+// Copyright (c) 2018 Mateusz Pusz
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+
+#pragma once
+
+#ifndef MP_UNITS_IN_MODULE_INTERFACE
+
+#include <mp-units/bits/hacks.h>
+#include <mp-units/compat_macros.h>
+
+#if MP_UNITS_API_CONTRACTS == 2 || __has_include(<gsl/gsl-lite.hpp>)
+
+#if MP_UNITS_HOSTED
+#include <gsl/gsl-lite.hpp>
+#else
+#include <mp-units/bits/requires_hosted.h>
+#endif
+
+#elif MP_UNITS_API_CONTRACTS == 3 || __has_include(<gsl/gsl>)
+
+#if MP_UNITS_HOSTED
+#include <gsl/gsl>
+#include <cassert>
+#else
+#include <mp-units/bits/requires_hosted.h>
+#endif
+
+#endif
+
+#endif  // MP_UNITS_IN_MODULE_INTERFACE

src/core/include/mp-units/ext/fixed_string.h

@@ -32,6 +32,7 @@
 #include <mp-units/ext/type_traits.h>
 
 #ifndef MP_UNITS_IN_MODULE_INTERFACE
+#include <mp-units/ext/contracts.h>
 #include <compare>  // IWYU pragma: export
 #include <cstddef>
 #include <cstdlib>

src/core/include/mp-units/framework/dimension.h

@@ -34,6 +34,7 @@
 #include <mp-units/framework/symbol_text.h>
 
 #ifndef MP_UNITS_IN_MODULE_INTERFACE
+#include <mp-units/ext/contracts.h>
 #include <array>
 #include <cstdint>
 #include <iterator>

src/core/include/mp-units/framework/quantity.h

@@ -37,6 +37,7 @@
 #include <mp-units/framework/unit_concepts.h>
 
 #ifndef MP_UNITS_IN_MODULE_INTERFACE
+#include <mp-units/ext/contracts.h>
 #include <compare>  // IWYU pragma: export
 #include <utility>
 #endif

src/core/include/mp-units/framework/symbol_text.h

@@ -31,6 +31,7 @@
 #include <mp-units/ext/fixed_string.h>
 
 #ifndef MP_UNITS_IN_MODULE_INTERFACE
+#include <mp-units/ext/contracts.h>
 #include <compare>  // IWYU pragma: export
 #include <cstddef>
 #include <cstdint>

src/core/include/mp-units/framework/unit.h

@@ -41,6 +41,7 @@
 #include <mp-units/framework/unit_concepts.h>
 
 #ifndef MP_UNITS_IN_MODULE_INTERFACE
+#include <mp-units/ext/contracts.h>
 #include <array>
 #include <cstdint>
 #include <iterator>