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 "../macros.hpp"
#include "debugger.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);
 
namespace hi { inline namespace v1 {
 
hi_export [[nodiscard]] constexpr bool bound_check(std::unsigned_integral auto index, std::unsigned_integral auto upper) noexcept
{
    using value_type = common_integer_t<decltype(index), decltype(upper)>;
 
    hilet index_ = static_cast<value_type>(index);
    hilet upper_ = static_cast<value_type>(upper);
    return index_ < upper_;
}
 
hi_export [[nodiscard]] constexpr bool bound_check(std::unsigned_integral auto index, std::signed_integral auto upper) noexcept
{
    if (upper <= 0) {
        return false;
    }
    return bound_check(index, static_cast<std::make_unsigned_t<decltype(upper)>>(upper));
}
 
hi_export [[nodiscard]] constexpr bool bound_check(std::integral auto index, std::integral auto lower, std::integral auto upper) noexcept
{
    using value_type = common_integer_t<decltype(index), decltype(lower), decltype(upper)>;
 
    auto index_ = static_cast<value_type>(index);
    auto lower_ = static_cast<value_type>(lower);
    auto upper_ = static_cast<value_type>(upper);
 
#ifndef NDEBUG
    if (not(lower_ < upper_)) {
        hi_debug_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();