/**************************************************************************/ /* typedefs.h */ /**************************************************************************/ /* This file is part of: */ /* GODOT ENGINE */ /* https://godotengine.org */ /**************************************************************************/ /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */ /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */ /* */ /* Permission is hereby granted, free of charge, to any person obtaining */ /* a copy of this software and associated documentation files (the */ /* "Software"), to deal in the Software without restriction, including */ /* without limitation the rights to use, copy, modify, merge, publish, */ /* distribute, sublicense, and/or sell copies of the Software, and to */ /* permit persons to whom the Software is furnished to do so, subject to */ /* the following conditions: */ /* */ /* The above copyright notice and this permission notice shall be */ /* included in all copies or substantial portions of the Software. */ /* */ /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */ /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */ /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */ /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */ /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */ /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */ /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ /**************************************************************************/ #ifndef TYPEDEFS_H #define TYPEDEFS_H #include <stddef.h> /** * Basic definitions and simple functions to be used everywhere. */ // Include first in case the platform needs to pre-define/include some things. #include "platform_config.h" // Should be available everywhere. #include "core/error/error_list.h" #include <cstdint> // Ensure that C++ standard is at least C++17. If on MSVC, also ensures that the `Zc:__cplusplus` flag is present. static_assert …; // Turn argument to string constant: // https://gcc.gnu.org/onlinedocs/cpp/Stringizing.html#Stringizing #ifndef _STR #define _STR(m_x) … #define _MKSTR(m_x) … #endif // Should always inline no matter what. #ifndef _ALWAYS_INLINE_ #if defined(__GNUC__) #define _ALWAYS_INLINE_ … #elif defined(_MSC_VER) #define _ALWAYS_INLINE_ … #else #define _ALWAYS_INLINE_ … #endif #endif // Should always inline, except in dev builds because it makes debugging harder. #ifndef _FORCE_INLINE_ #ifdef DEV_ENABLED #define _FORCE_INLINE_ … #else #define _FORCE_INLINE_ … #endif #endif // In some cases [[nodiscard]] will get false positives, // we can prevent the warning in specific cases by preceding the call with a cast. #ifndef _ALLOW_DISCARD_ #define _ALLOW_DISCARD_ … #endif // Windows badly defines a lot of stuff we'll never use. Undefine it. #ifdef _WIN32 #undef min // override standard definition #undef max // override standard definition #undef ERROR // override (really stupid) wingdi.h standard definition #undef DELETE // override (another really stupid) winnt.h standard definition #undef MessageBox // override winuser.h standard definition #undef Error #undef OK #undef CONNECT_DEFERRED // override from Windows SDK, clashes with Object enum #undef MemoryBarrier #undef MONO_FONT #endif // Make room for our constexpr's below by overriding potential system-specific macros. #undef ABS #undef SIGN #undef MIN #undef MAX #undef CLAMP // Generic ABS function, for math uses please use Math::abs. template <typename T> constexpr T ABS(T m_v) { … } template <typename T> constexpr const T SIGN(const T m_v) { … } template <typename T, typename T2> constexpr auto MIN(const T m_a, const T2 m_b) { … } template <typename T, typename T2> constexpr auto MAX(const T m_a, const T2 m_b) { … } template <typename T, typename T2, typename T3> constexpr auto CLAMP(const T m_a, const T2 m_min, const T3 m_max) { … } // Generic swap template. #ifndef SWAP #define SWAP(m_x, m_y) … template <typename T> inline void __swap_tmpl(T &x, T &y) { … } #endif // SWAP /* Functions to handle powers of 2 and shifting. */ // Function to find the next power of 2 to an integer. static _FORCE_INLINE_ unsigned int next_power_of_2(unsigned int x) { … } // Function to find the previous power of 2 to an integer. static _FORCE_INLINE_ unsigned int previous_power_of_2(unsigned int x) { … } // Function to find the closest power of 2 to an integer. static _FORCE_INLINE_ unsigned int closest_power_of_2(unsigned int x) { … } // Get a shift value from a power of 2. static inline int get_shift_from_power_of_2(unsigned int p_bits) { … } template <typename T> static _FORCE_INLINE_ T nearest_power_of_2_templated(T x) { … } // Function to find the nearest (bigger) power of 2 to an integer. static inline unsigned int nearest_shift(unsigned int p_number) { … } // constexpr function to find the floored log2 of a number template <typename T> constexpr T floor_log2(T x) { … } // Get the number of bits needed to represent the number. // IE, if you pass in 8, you will get 4. // If you want to know how many bits are needed to store 8 values however, pass in (8 - 1). template <typename T> constexpr T get_num_bits(T x) { … } // Swap 16, 32 and 64 bits value for endianness. #if defined(__GNUC__) #define BSWAP16(x) … #define BSWAP32(x) … #define BSWAP64(x) … #elif defined(_MSC_VER) #define BSWAP16 … #define BSWAP32 … #define BSWAP64 … #else static inline uint16_t BSWAP16(uint16_t x) { return (x >> 8) | (x << 8); } static inline uint32_t BSWAP32(uint32_t x) { return ((x << 24) | ((x << 8) & 0x00FF0000) | ((x >> 8) & 0x0000FF00) | (x >> 24)); } static inline uint64_t BSWAP64(uint64_t x) { x = (x & 0x00000000FFFFFFFF) << 32 | (x & 0xFFFFFFFF00000000) >> 32; x = (x & 0x0000FFFF0000FFFF) << 16 | (x & 0xFFFF0000FFFF0000) >> 16; x = (x & 0x00FF00FF00FF00FF) << 8 | (x & 0xFF00FF00FF00FF00) >> 8; return x; } #endif // Generic comparator used in Map, List, etc. template <typename T> struct Comparator { … }; // Global lock macro, relies on the static Mutex::_global_mutex. void _global_lock(); void _global_unlock(); struct _GlobalLock { … }; #define GLOBAL_LOCK_FUNCTION … #if defined(__GNUC__) #define likely(x) … #define unlikely(x) … #else #define likely … #define unlikely … #endif #if defined(__GNUC__) #define _PRINTF_FORMAT_ATTRIBUTE_2_0 … #define _PRINTF_FORMAT_ATTRIBUTE_2_3 … #else #define _PRINTF_FORMAT_ATTRIBUTE_2_0 #define _PRINTF_FORMAT_ATTRIBUTE_2_3 #endif // This is needed due to a strange OpenGL API that expects a pointer // type for an argument that is actually an offset. #define CAST_INT_TO_UCHAR_PTR(ptr) … // Home-made index sequence trick, so it can be used everywhere without the costly include of std::tuple. // https://stackoverflow.com/questions/15014096/c-index-of-type-during-variadic-template-expansion template <size_t... Is> struct IndexSequence { … }; template <size_t N, size_t... Is> struct BuildIndexSequence : BuildIndexSequence<N - 1, N - 1, Is...> { … }; BuildIndexSequence<0, Is...>; // Limit the depth of recursive algorithms when dealing with Array/Dictionary #define MAX_RECURSION … #ifdef DEBUG_ENABLED #define DEBUG_METHODS_ENABLED #endif // Macro GD_IS_DEFINED() allows to check if a macro is defined. It needs to be defined to anything (say 1) to work. #define __GDARG_PLACEHOLDER_1 … #define __gd_take_second_arg(__ignored, val, ...) … #define ____gd_is_defined(arg1_or_junk) … #define ___gd_is_defined(val) … #define GD_IS_DEFINED(x) … #endif // TYPEDEFS_H
Codebase Browser
godot