Skip to content

Commit

Permalink
Common: Add ByteSwap.h
Browse files Browse the repository at this point in the history
Provides a C  23-like std::byteswap implementation.
  • Loading branch information
stenzek authored and refractionpcsx2 committed May 25, 2023
1 parent ab1d200 commit 680affd
Show file tree
Hide file tree
Showing 6 changed files with 88 additions and 0 deletions.
56 changes: 56 additions & 0 deletions common/ByteSwap.h
Original file line number Diff line number Diff line change
@@ -0,0 1,56 @@
/* PCSX2 - PS2 Emulator for PCs
* Copyright (C) 2023 PCSX2 Dev Team
*
* PCSX2 is free software: you can redistribute it and/or modify it under the terms
* of the GNU Lesser General Public License as published by the Free Software Found-
* ation, either version 3 of the License, or (at your option) any later version.
*
* PCSX2 is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
* PURPOSE. See the GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along with PCSX2.
* If not, see <http://www.gnu.org/licenses/>.
*/

#pragma once

#include <cstdint>
#include <type_traits>

#ifdef _MSC_VER
#include <stdlib.h>
#endif

template <typename T>
T ByteSwap(T value)
{
if constexpr (std::is_signed_v<T>)
{
return static_cast<T>(ByteSwap(std::make_unsigned_t<T>(value)));
}
else if constexpr (std::is_same_v<T, std::uint16_t>)
{
#ifdef _MSC_VER
return _byteswap_ushort(value);
#else
return __builtin_bswap16(value);
#endif
}
else if constexpr (std::is_same_v<T, std::uint32_t>)
{
#ifdef _MSC_VER
return _byteswap_ulong(value);
#else
return __builtin_bswap32(value);
#endif
}
else if constexpr (std::is_same_v<T, std::uint64_t>)
{
#ifdef _MSC_VER
return _byteswap_uint64(value);
#else
return __builtin_bswap64(value);
#endif
}
}
1 change: 1 addition & 0 deletions common/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 64,7 @@ target_sources(common PRIVATE
AlignedMalloc.h
Assertions.h
boost_spsc_queue.hpp
ByteSwap.h
Console.h
CrashHandler.h
DynamicLibrary.h
Expand Down
1 change: 1 addition & 0 deletions common/common.vcxproj
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 104,7 @@
<ClInclude Include="Align.h" />
<ClInclude Include="AlignedMalloc.h" />
<ClInclude Include="BitCast.h" />
<ClInclude Include="ByteSwap.h" />
<ClInclude Include="CrashHandler.h" />
<ClInclude Include="DynamicLibrary.h" />
<ClInclude Include="Easing.h" />
Expand Down
3 changes: 3 additions & 0 deletions common/common.vcxproj.filters
Original file line number Diff line number Diff line change
Expand Up @@ -351,6 351,9 @@
<ClInclude Include="FileSystem.h">
<Filter>Header Files</Filter>
</ClInclude>
<ClInclude Include="ByteSwap.h">
<Filter>Header Files</Filter>
</ClInclude>
</ItemGroup>
<ItemGroup>
<Filter Include="Source Files">
Expand Down
1 change: 1 addition & 0 deletions tests/ctest/common/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,4 1,5 @@
add_pcsx2_test(common_test
byteswap_tests.cpp
path_tests.cpp
string_util_tests.cpp
x86emitter/codegen_tests.cpp
Expand Down
26 changes: 26 additions & 0 deletions tests/ctest/common/byteswap_tests.cpp
Original file line number Diff line number Diff line change
@@ -0,0 1,26 @@
/* PCSX2 - PS2 Emulator for PCs
* Copyright (C) 2023 PCSX2 Dev Team
*
* PCSX2 is free software: you can redistribute it and/or modify it under the terms
* of the GNU Lesser General Public License as published by the Free Software Found-
* ation, either version 3 of the License, or (at your option) any later version.
*
* PCSX2 is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
* PURPOSE. See the GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along with PCSX2.
* If not, see <http://www.gnu.org/licenses/>.
*/

#include "common/Pcsx2Defs.h"
#include "common/ByteSwap.h"
#include <gtest/gtest.h>

TEST(ByteSwap, ByteSwap)
{
ASSERT_EQ(ByteSwap(static_cast<u16>(0xabcd)), 0xcdabu);
ASSERT_EQ(ByteSwap(static_cast<u32>(0xabcdef01)), 0x01efcdabu);
ASSERT_EQ(ByteSwap(static_cast<u64>(0xabcdef0123456789ULL)), 0x8967452301efcdabu);
ASSERT_EQ(ByteSwap(static_cast<s32>(0x80123456)), 0x56341280);
}

0 comments on commit 680affd

Please sign in to comment.