assert.hpp

Go to the documentation of this file.

// Copyright Take Vos 2020-2022.
// Distributed under the Boost Software License, Version 1.0.
// (See accompanying file LICENSE_1_0.txt or copy at https://www.boost.org/LICENSE_1_0.txt)
 
#pragma once
 
#include "type_traits.hpp"
#include "terminate.hpp"
#include "../macros.hpp"
#include "exception.hpp"
#include <exception>
#include <ranges>
 
hi_export_module(hikogui.utility.assert);
 
hi_warning_push();
// "C26472: Don't use a static_cast for arithmetic", asserts use static_cast specifically for savety.
hi_warning_ignore_msvc(26472);
 
hi_export namespace hi { inline namespace v1 {
 
hi_export [[nodiscard]] constexpr bool bound_check(std::integral auto index, std::integral auto upper) noexcept
{
    return std::cmp_less(index, upper);
}
 
hi_export [[nodiscard]] constexpr bool bound_check(std::integral auto index, std::integral auto lower, std::integral auto upper) noexcept
{
#ifndef NDEBUG
    if (std::cmp_greater(lower, upper)) {
        hi_assert_abort("bound_check() lower is greater than upper.");
    }
#else
    hi_assume(std::cmp_less_equal(lower, upper));
#endif
 
    return std::cmp_greater_equal(index, lower) and std::cmp_less(index, upper);
}
 
hi_export [[nodiscard]] constexpr bool bound_check(std::floating_point auto index, std::floating_point auto lower, std::floating_point auto upper) noexcept
{
#ifndef NDEBUG
    if (lower > upper) {
        hi_assert_abort("bound_check() lower is greater than upper.");
    }
#else
    hi_assume(lower <= upper);
#endif
 
    return index >= lower and index <= upper;
}
 
template<typename Context>
concept bound_check_range_helper = requires(Context&& range) {
    {
        std::ranges::size(range)
    } -> std::unsigned_integral;
};
 
hi_export [[nodiscard]] constexpr bool bound_check(std::integral auto index, bound_check_range_helper auto&& range) noexcept
{
    static_assert(sizeof(index) <= sizeof(size_t));
 
    if constexpr (std::is_signed_v<std::decay_t<decltype(index)>>) {
        if (index < 0) {
            return false;
        }
    }
 
    return static_cast<size_t>(index) < std::ranges::size(range);
}
 
 
}} // namespace hi::v1
 
hi_warning_pop();