Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix a bad assert in hsRAMStream #1591

Merged
merged 2 commits into from
Jun 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions Sources/Plasma/CoreLib/hsStream.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -629,13 +629,15 @@ uint32_t hsRAMStream::Read(uint32_t byteCount, void * buffer)

uint32_t hsRAMStream::Write(uint32_t byteCount, const void* buffer)
{
hsAssert(fVector.data(), "Trying to write to a null RAM buffer");

size_t spaceUntilEof = fVector.size() - fPosition;
if (byteCount <= spaceUntilEof) {
hsAssert(fVector.data(), "Trying to write to a null RAM buffer");
memcpy(fVector.data() + fPosition, buffer, byteCount);
} else {
memcpy(fVector.data() + fPosition, buffer, spaceUntilEof);
if (spaceUntilEof) {
hsAssert(fVector.data(), "Trying to write to a null RAM buffer");
memcpy(fVector.data() + fPosition, buffer, spaceUntilEof);
}
auto buf = static_cast<const uint8_t*>(buffer);
fVector.insert(fVector.end(), buf + spaceUntilEof, buf + byteCount);
}
Expand Down
1 change: 1 addition & 0 deletions Sources/Tests/CoreTests/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
set(CoreLibTest_SOURCES
test_endianSwap.cpp
test_plCmdParser.cpp
test_RAMStream.cpp
$<$<PLATFORM_ID:Darwin>:test_hsDarwin_CF.cpp>
$<$<PLATFORM_ID:Darwin>:test_hsDarwin_NS.mm>
)
Expand Down
61 changes: 61 additions & 0 deletions Sources/Tests/CoreTests/test_RAMStream.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
/*==LICENSE==*

CyanWorlds.com Engine - MMOG client, server and tools
Copyright (C) 2011 Cyan Worlds, Inc.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program 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 this program. If not, see <http://www.gnu.org/licenses/>.

Additional permissions under GNU GPL version 3 section 7

If you modify this Program, or any covered work, by linking or
combining it with any of RAD Game Tools Bink SDK, Autodesk 3ds Max SDK,
NVIDIA PhysX SDK, Microsoft DirectX SDK, OpenSSL library, Independent
JPEG Group JPEG library, Microsoft Windows Media SDK, or Apple QuickTime SDK
(or a modified version of those libraries),
containing parts covered by the terms of the Bink SDK EULA, 3ds Max EULA,
PhysX SDK EULA, DirectX SDK EULA, OpenSSL and SSLeay licenses, IJG
JPEG Library README, Windows Media SDK EULA, or QuickTime SDK EULA, the
licensors of this Program grant you additional
permission to convey the resulting work. Corresponding Source for a
non-source form of such a combination shall include the source code for
the parts of OpenSSL and IJG JPEG Library used as well as that of the covered
work.

You can contact Cyan Worlds, Inc. by email legal@cyan.com
or by snail mail at:
Cyan Worlds, Inc.
14617 N Newport Hwy
Mead, WA 99021

*==LICENSE==*/

#include <gtest/gtest.h>

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#include <string_view>

#include "hsStream.h"

TEST(hsRAMStream, initializeBufferOnFirstWrite)
{
const char* str = "hsRAMStream initializeBufferOnFirstWrite";
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
const char* str = "hsRAMStream initializeBufferOnFirstWrite";
constexpr std::string_view str = "hsRAMStream initializeBufferOnFirstWrite";

hsRAMStream s;

s.WriteSafeString(str);
EXPECT_EQ(s.GetPosition(), strlen(str) + 2);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
EXPECT_EQ(s.GetPosition(), strlen(str) + 2);
EXPECT_EQ(s.GetPosition(), str.size() + 2);


s.WriteLE32(1);
EXPECT_EQ(s.GetPosition(), strlen(str) + 2 + 4);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
EXPECT_EQ(s.GetPosition(), strlen(str) + 2 + 4);
EXPECT_EQ(s.GetPosition(), str.size() + 2 + 4);


s.Skip(-4);
s.WriteLE32(5);
EXPECT_EQ(s.GetPosition(), strlen(str) + 2 + 4);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
EXPECT_EQ(s.GetPosition(), strlen(str) + 2 + 4);
EXPECT_EQ(s.GetPosition(), str.size() + 2 + 4);

}
Loading