df72480395
Now that clang-format makes [[nodiscard]] attributes format sensibly, we can apply them to several functions within the common library to allow the compiler to complain about any misuses of the functions.
97 lines
4.9 KiB
C++
97 lines
4.9 KiB
C++
// Copyright 2019 yuzu emulator team
|
|
// Licensed under GPLv2 or any later version
|
|
// Refer to the license.txt file included.
|
|
|
|
#pragma once
|
|
|
|
#include <algorithm>
|
|
#include <array>
|
|
#include <string>
|
|
|
|
#if !defined(ARCHITECTURE_x86_64)
|
|
#include <cstdlib> // for exit
|
|
#endif
|
|
#include "common/common_types.h"
|
|
|
|
/// Textually concatenates two tokens. The double-expansion is required by the C preprocessor.
|
|
#define CONCAT2(x, y) DO_CONCAT2(x, y)
|
|
#define DO_CONCAT2(x, y) x##y
|
|
|
|
/// Helper macros to insert unused bytes or words to properly align structs. These values will be
|
|
/// zero-initialized.
|
|
#define INSERT_PADDING_BYTES(num_bytes) \
|
|
std::array<u8, num_bytes> CONCAT2(pad, __LINE__) {}
|
|
#define INSERT_PADDING_WORDS(num_words) \
|
|
std::array<u32, num_words> CONCAT2(pad, __LINE__) {}
|
|
|
|
/// These are similar to the INSERT_PADDING_* macros, but are needed for padding unions. This is
|
|
/// because unions can only be initialized by one member.
|
|
#define INSERT_UNION_PADDING_BYTES(num_bytes) std::array<u8, num_bytes> CONCAT2(pad, __LINE__)
|
|
#define INSERT_UNION_PADDING_WORDS(num_words) std::array<u32, num_words> CONCAT2(pad, __LINE__)
|
|
|
|
#ifndef _MSC_VER
|
|
|
|
#ifdef ARCHITECTURE_x86_64
|
|
#define Crash() __asm__ __volatile__("int $3")
|
|
#else
|
|
#define Crash() exit(1)
|
|
#endif
|
|
|
|
#else // _MSC_VER
|
|
|
|
// Locale Cross-Compatibility
|
|
#define locale_t _locale_t
|
|
|
|
extern "C" {
|
|
__declspec(dllimport) void __stdcall DebugBreak(void);
|
|
}
|
|
#define Crash() DebugBreak()
|
|
|
|
#endif // _MSC_VER ndef
|
|
|
|
// Generic function to get last error message.
|
|
// Call directly after the command or use the error num.
|
|
// This function might change the error code.
|
|
// Defined in Misc.cpp.
|
|
[[nodiscard]] std::string GetLastErrorMsg();
|
|
|
|
#define DECLARE_ENUM_FLAG_OPERATORS(type) \
|
|
[[nodiscard]] constexpr type operator|(type a, type b) noexcept { \
|
|
using T = std::underlying_type_t<type>; \
|
|
return static_cast<type>(static_cast<T>(a) | static_cast<T>(b)); \
|
|
} \
|
|
[[nodiscard]] constexpr type operator&(type a, type b) noexcept { \
|
|
using T = std::underlying_type_t<type>; \
|
|
return static_cast<type>(static_cast<T>(a) & static_cast<T>(b)); \
|
|
} \
|
|
constexpr type& operator|=(type& a, type b) noexcept { \
|
|
using T = std::underlying_type_t<type>; \
|
|
a = static_cast<type>(static_cast<T>(a) | static_cast<T>(b)); \
|
|
return a; \
|
|
} \
|
|
constexpr type& operator&=(type& a, type b) noexcept { \
|
|
using T = std::underlying_type_t<type>; \
|
|
a = static_cast<type>(static_cast<T>(a) & static_cast<T>(b)); \
|
|
return a; \
|
|
} \
|
|
[[nodiscard]] constexpr type operator~(type key) noexcept { \
|
|
using T = std::underlying_type_t<type>; \
|
|
return static_cast<type>(~static_cast<T>(key)); \
|
|
} \
|
|
[[nodiscard]] constexpr bool True(type key) noexcept { \
|
|
using T = std::underlying_type_t<type>; \
|
|
return static_cast<T>(key) != 0; \
|
|
} \
|
|
[[nodiscard]] constexpr bool False(type key) noexcept { \
|
|
using T = std::underlying_type_t<type>; \
|
|
return static_cast<T>(key) == 0; \
|
|
}
|
|
|
|
namespace Common {
|
|
|
|
[[nodiscard]] constexpr u32 MakeMagic(char a, char b, char c, char d) {
|
|
return u32(a) | u32(b) << 8 | u32(c) << 16 | u32(d) << 24;
|
|
}
|
|
|
|
} // namespace Common
|