clamp_typerange.hpp

Go to the documentation of this file.

//    OpenVPN -- An application to securely tunnel IP networks
//               over a single port, with support for SSL/TLS-based
//               session authentication and key exchange,
//               packet encryption, packet authentication, and
//               packet compression.
//
//    Copyright (C) 2023- OpenVPN Inc.
//
//    SPDX-License-Identifier: MPL-2.0 OR AGPL-3.0-only WITH openvpn3-openssl-exception
//
 
 
 
#pragma once
 
#include <limits>
#include <algorithm>
#include <functional>
 
#include "numeric_util.hpp"
 
namespace openvpn::numeric_util {
 
/* ============================================================================================================= */
//  clamp_to_typerange
/* ============================================================================================================= */
 
template <typename OutT, typename InT>
OutT clamp_to_typerange(InT inVal)
{
    if constexpr (numeric_util::is_int_rangesafe<OutT, InT>())
    {
        return static_cast<OutT>(inVal);
    }
    else if constexpr (numeric_util::is_int_u2s<OutT, InT>())
    {
        auto unsignedInVal = static_cast<uintmax_t>(inVal);
        return static_cast<OutT>(std::min(static_cast<uintmax_t>(std::numeric_limits<OutT>::max()), unsignedInVal));
    }
    else if constexpr (numeric_util::is_int_s2u<OutT, InT>())
    {
        auto lowerVal = static_cast<uintmax_t>(std::max(inVal, 0));
        auto upperLimit = static_cast<uintmax_t>(std::numeric_limits<OutT>::max());
        return static_cast<OutT>(std::min(lowerVal, upperLimit));
    }
    else
    {
        auto outMin = static_cast<InT>(std::numeric_limits<OutT>::min());
        auto outMax = static_cast<InT>(std::numeric_limits<OutT>::max());
        return static_cast<OutT>(std::clamp(inVal, outMin, outMax));
    }
}
 
/* ============================================================================================================= */
//  clamp_to_default
/* ============================================================================================================= */
 
template <typename OutT, typename InT>
OutT clamp_to_default(InT inVal, OutT defVal)
{
    if constexpr (!numeric_util::is_int_rangesafe<OutT, InT>())
    {
        if (!is_safe_conversion<OutT>(inVal))
            return defVal;
    }
 
    return static_cast<OutT>(inVal);
}
 
/* ============================================================================================================= */
//  clamp_notify
/* ============================================================================================================= */
 
template <typename OutT, typename InT, typename FuncT>
OutT clamp_notify(InT inVal, FuncT cb)
{
    if constexpr (!numeric_util::is_int_rangesafe<OutT, InT>())
    {
        if (!is_safe_conversion<OutT>(inVal))
            return std::invoke(cb, inVal);
    }
 
    return static_cast<OutT>(inVal);
}
 
} // namespace openvpn::numeric_util