documentation/doxygen/Platform_8h_source.html

// Copyright Contributors to the OpenVDB Project

// SPDX-License-Identifier: Apache-2.0

///

/// @file Platform.h


#ifndef OPENVDB_PLATFORM_HAS_BEEN_INCLUDED

#define OPENVDB_PLATFORM_HAS_BEEN_INCLUDED


#define PRAGMA(x) _Pragma(#x)


/// @name Utilities

/// @{

/// @cond OPENVDB_DOCS_INTERNAL

#define OPENVDB_PREPROC_STRINGIFY_(x) #x

/// @endcond

/// @brief Return @a x as a string literal.  If @a x is a macro,

/// return its value as a string literal.

/// @hideinitializer

#define OPENVDB_PREPROC_STRINGIFY(x) OPENVDB_PREPROC_STRINGIFY_(x)


/// @cond OPENVDB_DOCS_INTERNAL

#define OPENVDB_PREPROC_CONCAT_(x, y) x ## y

/// @endcond

/// @brief Form a new token by concatenating two existing tokens.

/// If either token is a macro, concatenate its value.

/// @hideinitializer

#define OPENVDB_PREPROC_CONCAT(x, y) OPENVDB_PREPROC_CONCAT_(x, y)

/// @}


/// Macro for determining if GCC version is >= than X.Y

#if defined(__GNUC__)

    #define OPENVDB_CHECK_GCC(MAJOR, MINOR) \

        (__GNUC__ > MAJOR || (__GNUC__ == MAJOR && __GNUC_MINOR__ >= MINOR))

#else

    #define OPENVDB_CHECK_GCC(MAJOR, MINOR) 0

#endif


/// OpenVDB now requires C++17

#define OPENVDB_HAS_CXX11 1 // kept for backward compatibility


#if __cplusplus >= 202002L

    #define OPENVDB_HAS_CXX20

#endif


/// Windows defines

#ifdef _WIN32

    ///Disable the non-portable Windows definitions of min() and max() macros

    #ifndef NOMINMAX

        #define NOMINMAX

    #endif


    // By default, assume we're building OpenVDB as a DLL if we're dynamically

    // linking in the CRT, unless OPENVDB_STATICLIB is defined.

    #if defined(_DLL) && !defined(OPENVDB_STATICLIB) && !defined(OPENVDB_DLL)

        #define OPENVDB_DLL

    #endif

#endif


/// Macros to suppress undefined behaviour sanitizer warnings. Should be used

/// sparingly, primarily to suppress issues in upstream dependencies.

#if defined(__clang__)

#define OPENVDB_UBSAN_SUPPRESS(X) __attribute__((no_sanitize(X)))

#else

#define OPENVDB_UBSAN_SUPPRESS(X)

#endif


/// Macros to alias to compiler builtins which hint at critical edge selection

/// during conditional statements.

#if defined(__GNUC__) || defined(__clang__) || defined(__INTEL_COMPILER)

#ifdef __cplusplus

#define OPENVDB_LIKELY(x) (__builtin_expect(static_cast<bool>(x), true))

#define OPENVDB_UNLIKELY(x) (__builtin_expect(static_cast<bool>(x), false))

#else

#define OPENVDB_LIKELY(x) (__builtin_expect((x), 1))

#define OPENVDB_UNLIKELY(x) (__builtin_expect((x), 0))

#endif

#else

#define OPENVDB_LIKELY(x) (x)

#define OPENVDB_UNLIKELY(x) (x)

#endif


/// Macros for assume builtins. Note that we currently don't simply apply these

/// in place of asserts (when asserts are disabled) - they should be only be

/// applied with an assert once profiled

#ifdef __has_cpp_attribute

  #if __has_cpp_attribute(assume) >= 202207L

    #define OPENVDB_ASSUME(...) [[assume(__VA_ARGS__)]]

  #endif

#endif

#ifndef OPENVDB_ASSUME

  #if defined(__clang__)

    #define OPENVDB_ASSUME(...)  __builtin_assume(__VA_ARGS__);

  #elif defined(_MSC_VER)

    #define OPENVDB_ASSUME(...) __assume(__VA_ARGS__);

  #elif defined(__GNUC__)

    #if __GNUC__ >= 13

      #define OPENVDB_ASSUME(...) __attribute__((__assume__(__VA_ARGS__)))

    #endif

  #endif

#endif

#ifndef OPENVDB_ASSUME

  #define OPENVDB_ASSUME(...)

#endif


/// Force inline function macros. These macros do not necessary guarantee that

/// the decorated function will be inlined, but provide the strongest vendor

/// annotations to that end.

#if defined(__GNUC__)

#define OPENVDB_FORCE_INLINE __attribute__((always_inline)) inline

#elif defined(_MSC_VER)

#define OPENVDB_FORCE_INLINE __forceinline

#else

#define OPENVDB_FORCE_INLINE inline

#endif


/// Bracket code with OPENVDB_NO_UNREACHABLE_CODE_WARNING_BEGIN/_END,

/// as in the following example, to inhibit ICC remarks about unreachable code:

/// @code

/// template<typename NodeType>

/// void processNode(NodeType& node)

/// {

///     OPENVDB_NO_UNREACHABLE_CODE_WARNING_BEGIN

///     if (NodeType::LEVEL == 0) return; // ignore leaf nodes

///     int i = 0;

///     ...

///     OPENVDB_NO_UNREACHABLE_CODE_WARNING_END

/// }

/// @endcode

/// In the above, <tt>NodeType::LEVEL == 0</tt> is a compile-time constant expression,

/// so for some template instantiations, the line below it is unreachable.

#if defined(__INTEL_COMPILER)

    // Disable ICC remarks 111 ("statement is unreachable"), 128 ("loop is not reachable"),

    // 185 ("dynamic initialization in unreachable code"), and 280 ("selector expression

    // is constant").

    #define OPENVDB_NO_UNREACHABLE_CODE_WARNING_BEGIN \

        _Pragma("warning (push)") \

        _Pragma("warning (disable:111)") \

        _Pragma("warning (disable:128)") \

        _Pragma("warning (disable:185)") \

        _Pragma("warning (disable:280)")

    #define OPENVDB_NO_UNREACHABLE_CODE_WARNING_END \

        _Pragma("warning (pop)")

#elif defined(__clang__)

    #define OPENVDB_NO_UNREACHABLE_CODE_WARNING_BEGIN \

        PRAGMA(clang diagnostic push) \

        PRAGMA(clang diagnostic ignored "-Wunreachable-code")

    #define OPENVDB_NO_UNREACHABLE_CODE_WARNING_END \

        PRAGMA(clang diagnostic pop)

#else

    #define OPENVDB_NO_UNREACHABLE_CODE_WARNING_BEGIN

    #define OPENVDB_NO_UNREACHABLE_CODE_WARNING_END

#endif


/// Deprecation macros. Define OPENVDB_NO_DEPRECATION_WARNINGS to disable all

/// deprecation warnings in OpenVDB.

#ifndef OPENVDB_NO_DEPRECATION_WARNINGS

#define OPENVDB_DEPRECATED [[deprecated]]

#define OPENVDB_DEPRECATED_MESSAGE(msg) [[deprecated(msg)]]

#else

#define OPENVDB_DEPRECATED

#define OPENVDB_DEPRECATED_MESSAGE(msg)

#endif


/// @brief Bracket code with OPENVDB_NO_DEPRECATION_WARNING_BEGIN/_END,

/// to inhibit warnings about deprecated code.

/// @note Only intended to be used internally whilst parent code is being

///   deprecated

/// @details Example:

/// @code

/// OPENVDB_DEPRECATED void myDeprecatedFunction() {}

///

/// {

///     OPENVDB_NO_DEPRECATION_WARNING_BEGIN

///     myDeprecatedFunction();

///     OPENVDB_NO_DEPRECATION_WARNING_END

/// }

/// @endcode

#if defined __INTEL_COMPILER

    #define OPENVDB_NO_DEPRECATION_WARNING_BEGIN \

        _Pragma("warning (push)") \

        _Pragma("warning (disable:1478)")

    #define OPENVDB_NO_DEPRECATION_WARNING_END \

        _Pragma("warning (pop)")

#elif defined __clang__

    #define OPENVDB_NO_DEPRECATION_WARNING_BEGIN \

        _Pragma("clang diagnostic push") \

        _Pragma("clang diagnostic ignored \"-Wdeprecated-declarations\"")

        // note: no #pragma message, since Clang treats them as warnings

    #define OPENVDB_NO_DEPRECATION_WARNING_END \

        _Pragma("clang diagnostic pop")

#elif defined __GNUC__

    #define OPENVDB_NO_DEPRECATION_WARNING_BEGIN \

        _Pragma("GCC diagnostic push") \

        _Pragma("GCC diagnostic ignored \"-Wdeprecated-declarations\"")

    #define OPENVDB_NO_DEPRECATION_WARNING_END \

        _Pragma("GCC diagnostic pop")

#elif defined _MSC_VER

    #define OPENVDB_NO_DEPRECATION_WARNING_BEGIN \

        __pragma(warning(push)) \

        __pragma(warning(disable : 4996))

    #define OPENVDB_NO_DEPRECATION_WARNING_END \

        __pragma(warning(pop))

#else

    #define OPENVDB_NO_DEPRECATION_WARNING_BEGIN

    #define OPENVDB_NO_DEPRECATION_WARNING_END

#endif


/// @brief Bracket code with OPENVDB_NO_TYPE_CONVERSION_WARNING_BEGIN/_END,

/// to inhibit warnings about type conversion.

/// @note Use this sparingly.  Use static casts and explicit type conversion if at all possible.

/// @details Example:

/// @code

/// float value = 0.1f;

/// OPENVDB_NO_TYPE_CONVERSION_WARNING_BEGIN

/// int valueAsInt = value;

/// OPENVDB_NO_TYPE_CONVERSION_WARNING_END

/// @endcode

#if defined __INTEL_COMPILER

    #define OPENVDB_NO_TYPE_CONVERSION_WARNING_BEGIN

    #define OPENVDB_NO_TYPE_CONVERSION_WARNING_END

#elif defined __GNUC__

    // -Wfloat-conversion was only introduced in GCC 4.9

    #define OPENVDB_NO_TYPE_CONVERSION_WARNING_BEGIN \

        _Pragma("GCC diagnostic push") \

        _Pragma("GCC diagnostic ignored \"-Wconversion\"") \

        _Pragma("GCC diagnostic ignored \"-Wfloat-conversion\"")

    #define OPENVDB_NO_TYPE_CONVERSION_WARNING_END \

        _Pragma("GCC diagnostic pop")

#else

    #define OPENVDB_NO_TYPE_CONVERSION_WARNING_BEGIN

    #define OPENVDB_NO_TYPE_CONVERSION_WARNING_END

#endif


/// Helper macros for defining library symbol visibility

#ifdef OPENVDB_EXPORT

#undef OPENVDB_EXPORT

#endif

#ifdef OPENVDB_IMPORT

#undef OPENVDB_IMPORT

#endif

#ifdef _WIN32

    #ifdef OPENVDB_DLL

        #define OPENVDB_EXPORT __declspec(dllexport)

        #define OPENVDB_IMPORT __declspec(dllimport)

    #else

        #define OPENVDB_EXPORT

        #define OPENVDB_IMPORT

    #endif

#elif defined(__GNUC__)

    #define OPENVDB_EXPORT __attribute__((visibility("default")))

    #define OPENVDB_IMPORT __attribute__((visibility("default")))

#endif


/// Helper macros for explicit template instantiation

#if defined(_WIN32) && defined(OPENVDB_DLL)

    #ifdef OPENVDB_PRIVATE

        #define OPENVDB_TEMPLATE_EXPORT OPENVDB_EXPORT

        #define OPENVDB_TEMPLATE_IMPORT

    #else

        #define OPENVDB_TEMPLATE_EXPORT

        #define OPENVDB_TEMPLATE_IMPORT OPENVDB_IMPORT

    #endif

#else

    #define OPENVDB_TEMPLATE_IMPORT

    #define OPENVDB_TEMPLATE_EXPORT

#endif


/// All classes and public free standing functions must be explicitly marked

/// as <lib>_API to be exported. The <lib>_PRIVATE macros are defined when

/// building that particular library.

#ifdef OPENVDB_API

#undef OPENVDB_API

#endif

#ifdef OPENVDB_PRIVATE

    #define OPENVDB_API OPENVDB_EXPORT

#else

    #define OPENVDB_API OPENVDB_IMPORT

#endif

#ifdef OPENVDB_HOUDINI_API

#undef OPENVDB_HOUDINI_API

#endif

#ifdef OPENVDB_HOUDINI_PRIVATE

    #define OPENVDB_HOUDINI_API OPENVDB_EXPORT

#else

    #define OPENVDB_HOUDINI_API OPENVDB_IMPORT

#endif


#ifdef OPENVDB_AX_DLL

#ifdef OPENVDB_AX_API

#undef OPENVDB_AX_API

#endif

#ifdef OPENVDB_AX_PRIVATE

    #define OPENVDB_AX_API OPENVDB_EXPORT

#else

    #define OPENVDB_AX_API OPENVDB_IMPORT

#endif

#else

#define OPENVDB_AX_API

#endif // OPENVDB_AX_DLL


#if defined(__ICC)


// Use these defines to bracket a region of code that has safe static accesses.

// Keep the region as small as possible.

#define OPENVDB_START_THREADSAFE_STATIC_REFERENCE   __pragma(warning(disable:1710))

#define OPENVDB_FINISH_THREADSAFE_STATIC_REFERENCE  __pragma(warning(default:1710))

#define OPENVDB_START_THREADSAFE_STATIC_WRITE       __pragma(warning(disable:1711))

#define OPENVDB_FINISH_THREADSAFE_STATIC_WRITE      __pragma(warning(default:1711))

#define OPENVDB_START_THREADSAFE_STATIC_ADDRESS     __pragma(warning(disable:1712))

#define OPENVDB_FINISH_THREADSAFE_STATIC_ADDRESS    __pragma(warning(default:1712))


// Use these defines to bracket a region of code that has unsafe static accesses.

// Keep the region as small as possible.

#define OPENVDB_START_NON_THREADSAFE_STATIC_REFERENCE   __pragma(warning(disable:1710))

#define OPENVDB_FINISH_NON_THREADSAFE_STATIC_REFERENCE  __pragma(warning(default:1710))

#define OPENVDB_START_NON_THREADSAFE_STATIC_WRITE       __pragma(warning(disable:1711))

#define OPENVDB_FINISH_NON_THREADSAFE_STATIC_WRITE      __pragma(warning(default:1711))

#define OPENVDB_START_NON_THREADSAFE_STATIC_ADDRESS     __pragma(warning(disable:1712))

#define OPENVDB_FINISH_NON_THREADSAFE_STATIC_ADDRESS    __pragma(warning(default:1712))


// Simpler version for one-line cases

#define OPENVDB_THREADSAFE_STATIC_REFERENCE(CODE) \

    __pragma(warning(disable:1710)); CODE; __pragma(warning(default:1710))

#define OPENVDB_THREADSAFE_STATIC_WRITE(CODE) \

    __pragma(warning(disable:1711)); CODE; __pragma(warning(default:1711))

#define OPENVDB_THREADSAFE_STATIC_ADDRESS(CODE) \

    __pragma(warning(disable:1712)); CODE; __pragma(warning(default:1712))


#else // GCC does not support these compiler warnings


#define OPENVDB_START_THREADSAFE_STATIC_REFERENCE

#define OPENVDB_FINISH_THREADSAFE_STATIC_REFERENCE

#define OPENVDB_START_THREADSAFE_STATIC_WRITE

#define OPENVDB_FINISH_THREADSAFE_STATIC_WRITE

#define OPENVDB_START_THREADSAFE_STATIC_ADDRESS

#define OPENVDB_FINISH_THREADSAFE_STATIC_ADDRESS


#define OPENVDB_START_NON_THREADSAFE_STATIC_REFERENCE

#define OPENVDB_FINISH_NON_THREADSAFE_STATIC_REFERENCE

#define OPENVDB_START_NON_THREADSAFE_STATIC_WRITE

#define OPENVDB_FINISH_NON_THREADSAFE_STATIC_WRITE

#define OPENVDB_START_NON_THREADSAFE_STATIC_ADDRESS

#define OPENVDB_FINISH_NON_THREADSAFE_STATIC_ADDRESS


#define OPENVDB_THREADSAFE_STATIC_REFERENCE(CODE) CODE

#define OPENVDB_THREADSAFE_STATIC_WRITE(CODE) CODE

#define OPENVDB_THREADSAFE_STATIC_ADDRESS(CODE) CODE


#endif // defined(__ICC)


#endif // OPENVDB_PLATFORM_HAS_BEEN_INCLUDED