misc.h

[詳解]

/// @file
/// @brief 雑多なインライン関数やマクロを定義するヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_UTIL_MISC_H
#define AMDAEMON_UTIL_MISC_H

#include "amdaemon/env.h"

#include <cstddef>
#include <cwchar>

/// std::isfinite が実装されている環境ならば真。(VC++2013以降)
#define AMDAEMON_STD_FINITE_SUPPORTED AMDAEMON_MSVC_COMPATIBLE(1800)

#if AMDAEMON_STD_FINITE_SUPPORTED
#include <cmath>    // for std::isfinite
#else // AMDAEMON_STD_FINITE_SUPPORTED
#include <float.h>  // for ::_finite
#endif // AMDAEMON_STD_FINITE_SUPPORTED

/// @addtogroup g_util
/// @{

/// constexpr キーワードが実装されている環境ならば真。(VC++2015以降)
#define AMDAEMON_CONSTEXPR_SUPPORTED AMDAEMON_MSVC_COMPATIBLE(1900)

/// @def AMDAEMON_CONSTEXPR
/// @brief 環境に応じて constexpr キーワードまたは inline キーワードとなる。
///
/// - VC++2015以降およびVC++以外のコンパイラでは constexpr キーワードと等価。
/// - 上記以外の環境では inline キーワードと等価。
#if AMDAEMON_CONSTEXPR_SUPPORTED
#define AMDAEMON_CONSTEXPR constexpr
#else // AMDAEMON_CONSTEXPR_SUPPORTED
#define AMDAEMON_CONSTEXPR inline
#endif // AMDAEMON_CONSTEXPR_SUPPORTED

/// @def AMDAEMON_STRING_TO_WIDE
/// @brief char リテラル文字列を wchar_t リテラル文字列に変換する。
/// @param[in] s char リテラル文字列。
///
/// 引数にマクロを渡した場合、マクロを展開した上で文字列変換する。
#define AMDAEMON_STRING_TO_WIDE_IMPL_(s) L##s
#define AMDAEMON_STRING_TO_WIDE(s) AMDAEMON_STRING_TO_WIDE_IMPL_(s)

/// @}

namespace amdaemon
{
namespace util
{
/// @addtogroup g_util
/// @{

    /// @brief 組み込み配列の要素数を取得する。
    /// @tparam T 組み込み配列の要素型。
    /// @tparam Size 組み込み配列の要素数。
    /// @return 要素数。
    template<class T, std::size_t Size>
    AMDAEMON_CONSTEXPR std::size_t getArraySize(const T (&)[Size])
    {
        return Size;
    }

    /// @brief 浮動小数点数が非数値ではないか否かを取得する。
    /// @param[in] value 調べる浮動小数点数値。
    /// @retval true  value が非数値ではない場合。
    /// @retval false value が非数値である場合。
    ///
    /// value が下記のいずれの値でもなければ true を返す。
    ///
    /// - 正の無限大
    /// - 負の無限大
    /// - NaN
    inline bool isFinite(float value)
    {
#if AMDAEMON_STD_FINITE_SUPPORTED
        return (std::isfinite(value) != 0);
#else // AMDAEMON_STD_FINITE_SUPPORTED
        // _finitef は x86 環境だと利用できないので _finite を使う
        return (::_finite(value) != 0);
#endif // AMDAEMON_STD_FINITE_SUPPORTED
    }

    /// @copydoc isFinite
    inline bool isFinite(double value)
    {
#if AMDAEMON_STD_FINITE_SUPPORTED
        return (std::isfinite(value) != 0);
#else // AMDAEMON_STD_FINITE_SUPPORTED
        return (::_finite(value) != 0);
#endif // AMDAEMON_STD_FINITE_SUPPORTED
    }

    /// @brief 文字がASCIIの10進数字であるか否かを取得する。
    /// @param[in] c 調べる文字。
    /// @retval true  ASCIIの10進数字である場合。
    /// @retval false ASCIIの10進数字ではない場合。
    ///
    /// 標準関数 std::iswdigit は現在のロケールを考慮するため、
    /// 全角文字や想定していない文字まで10進数字として判定される可能性がある。
    AMDAEMON_CONSTEXPR bool isAsciiDigit(wchar_t c)
    {
        return (c >= L'0' && c <= L'9');
    }

    /// @brief 文字がASCIIのアルファベットであるか否かを取得する。
    /// @param[in] c 調べる文字。
    /// @retval true  ASCIIのアルファベットである場合。
    /// @retval false ASCIIのアルファベットではない場合。
    ///
    /// 標準関数 std::iswalpha は現在のロケールを考慮するため、
    /// 全角文字や想定していない文字までアルファベットとして判定される可能性がある。
    AMDAEMON_CONSTEXPR bool isAsciiAlphabet(wchar_t c)
    {
        return ((c >= L'a' && c <= L'z') || (c >= L'A' && c <= L'Z'));
    }

    /// @brief 文字列を文字列バッファへコピーする。
    /// @tparam N 文字配列の要素数。
    /// @param[in] src コピー元の文字列。
    /// @param[out] dest コピー先の文字列バッファ。
    /// @param[in] destCount コピー先バッファの許容文字数。
    ///
    /// - 必ず終端の '¥0' は付与される。
    /// - 引数 src の文字数が destCount 以上である場合、
    ///   (destCount - 1) 文字目までがコピーされる。
    inline void copyString(const wchar_t* src, wchar_t* dest, std::size_t destCount)
    {
#if AMDAEMON_ON_MSVC
        (void)::wcsncpy_s(dest, destCount, src, destCount - 1);
#else // AMDAEMON_ON_MSVC
        (std::wcsncpy(dest, src, destCount - 1))[destCount - 1] = L'¥0';
#endif // AMDAEMON_ON_MSVC
    }

    /// @brief 文字列を文字配列へコピーする。
    /// @tparam N 文字配列の要素数。
    /// @param[in] src コピー元の文字列。
    /// @param[out] dest コピー先の文字配列。
    ///
    /// - 必ず終端の '¥0' は付与される。
    /// - 引数 src の文字数が N 以上である場合、 (N - 1) 文字目までがコピーされる。
    template<std::size_t N>
    inline void copyString(const wchar_t* src, wchar_t (&dest)[N])
    {
        copyString(src, dest, N);
    }

    /// @brief 1次元値の線形変換を行う。
    /// @tparam TDest 線形変換後の値型。引数から推論される。
    /// @tparam TSrc 線形変換前の値型。引数から推論される。
    /// @param[in] value 線形変換する値。
    /// @param[in] minValue 線形変換前の最小値。 maxValue と同値であってはならない。
    /// @param[in] maxValue 線形変換前の最大値。 minValue と同値であってはならない。
    /// @param[in] transMin minValue を線形変換した時の値。
    /// @param[in] transMax maxValue を線形変換した時の値。
    /// @return 線形変換した値。
    template<class TDest, class TSrc>
    inline TDest transformLinear(
        TSrc value,
        TSrc minValue,
        TSrc maxValue,
        TDest transMin,
        TDest transMax)
    {
        const auto range = maxValue - minValue;
        const auto transRange = transMax - transMin;
        return
            (range == 0) ?
                transMin :
                static_cast<TDest>((value - minValue) * transRange / range + transMin);
    }

/// @}

    namespace detail
    {
        /// @brief AMDAEMON_ARRAYSIZE マクロのためのヘルパ関数。
        /// @tparam T 組み込み配列要素型。
        /// @tparam Size 組み込み配列要素数。
        /// @return 組み込み配列の要素数を得るための型。
        ///
        /// 直接呼び出そうとするとコンパイルエラーとなる。
        /// sizeof と組み合わせて用いる。
        template<class T, std::size_t Size>
        char (&array_size_helper(T (&)[Size]))[Size];
    } // namespace detail
} // namespace util
} // namespace amdaemon

/// @addtogroup g_util
/// @{

/// @brief 組み込み配列の要素数を取得する。
/// @param[in] arr 組み込み配列。
#define AMDAEMON_ARRAYSIZE(arr) sizeof(::amdaemon::util::detail::array_size_helper(arr))

/// @}

#endif // AMDAEMON_UTIL_MISC_H