pointer_operations.h

Go to the documentation of this file.

 
 
#pragma once
 
 
// === DECLARATIONS ===================================================================================================
 
#include "mjolnir/core/fundamental_types.h"
 
#include <cstdint>
 
 
namespace mjolnir
{
 
template <typename T_Type = void>
[[nodiscard]] inline auto integer_to_pointer(UPT integer) noexcept -> T_Type*;
 
 
template <UST t_alignment, typename T_Type>
[[nodiscard]] inline auto is_aligned(const volatile T_Type* pointer) noexcept -> bool;
 
 
template <typename T_Type>
[[nodiscard]] inline auto is_aligned(const volatile T_Type* pointer, UST alignment) noexcept -> bool;
 
 
template <UST t_alignment, typename T_Type>
[[nodiscard]] inline auto misalignment(const volatile T_Type* pointer) noexcept -> UST;
 
 
template <typename T_Type>
[[nodiscard]] inline auto misalignment(const volatile T_Type* pointer, UST alignment) noexcept -> UST;
 
 
template <typename T_Type>
[[nodiscard]] inline auto pointer_to_integer(const volatile T_Type* pointer) noexcept -> UPT;
 
 
} // namespace mjolnir
 
 
// === DEFINITIONS ====================================================================================================
 
namespace mjolnir
{
template <typename T_Type>
[[nodiscard]] inline auto integer_to_pointer(UPT integer) noexcept -> T_Type*
{
    // NOLINTNEXTLINE(cppcoreguidelines-pro-type-reinterpret-cast,performance-no-int-to-ptr)
    return reinterpret_cast<T_Type*>(integer);
}
 
 
// --------------------------------------------------------------------------------------------------------------------
 
template <UST t_alignment, typename T_Type>
[[nodiscard]] inline auto is_aligned(const volatile T_Type* pointer) noexcept -> bool
{
    // https://stackoverflow.com/a/28678613
    return misalignment<t_alignment>(pointer) == 0;
}
 
 
// --------------------------------------------------------------------------------------------------------------------
 
template <typename T_Type>
[[nodiscard]] inline auto is_aligned(const volatile T_Type* pointer, UST alignment) noexcept -> bool
{
    // https://stackoverflow.com/a/28678613
    return misalignment(pointer, alignment) == 0;
}
 
 
// --------------------------------------------------------------------------------------------------------------------
 
template <UST t_alignment, typename T_Type>
[[nodiscard]] inline auto misalignment(const volatile T_Type* pointer) noexcept -> UST
{
    return pointer_to_integer(pointer) % t_alignment;
}
 
 
// --------------------------------------------------------------------------------------------------------------------
 
template <typename T_Type>
[[nodiscard]] inline auto misalignment(const volatile T_Type* pointer, UST alignment) noexcept -> UST
{
    return pointer_to_integer(pointer) % alignment;
}
 
 
// --------------------------------------------------------------------------------------------------------------------
 
template <typename T_Type>
[[nodiscard]] inline auto pointer_to_integer(const volatile T_Type* pointer) noexcept -> UPT
{
    // https://stackoverflow.com/a/26586211
    // NOLINTNEXTLINE(cppcoreguidelines-pro-type-reinterpret-cast) intentional, see link above
    return reinterpret_cast<UPT>(pointer);
}
 
 
} // namespace mjolnir