Skip to content

Commit

Permalink
Hashing: Improve methods naming
Browse files Browse the repository at this point in the history
  • Loading branch information
@Pagghiu
Pagghiu committed Apr 4, 2024
1 parent 82be102 commit f4f9ffa
Show file tree
Hide file tree
Showing 6 changed files with 36 additions and 36 deletions.
6 changes: 3 additions & 3 deletions Libraries/Build/Internal/BuildWriterVisualStudio.inl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ struct SC::Build::ProjectWriter::WriterVisualStudio
[[nodiscard]] static bool generateGuidFor(const StringView name, Hashing& hashing, String& projectGuid)
{
SC_TRY(hashing.setType(Hashing::TypeSHA1));
SC_TRY(hashing.update(name.toBytesSpan()));
SC_TRY(hashing.update("_Guid"_a8.toBytesSpan()));
SC_TRY(hashing.add(name.toBytesSpan()));
SC_TRY(hashing.add("_Guid"_a8.toBytesSpan()));
Hashing::Result res;
SC_TRY(hashing.finalize(res));
SC_TRY(hashing.getHash(res));
String hexString;
SC_TRY(StringBuilder(hexString).appendHex(res.toBytesSpan(), StringBuilder::AppendHexCase::UpperCase));
StringBuilder guidBuilder(projectGuid);
Expand Down
12 changes: 6 additions & 6 deletions Libraries/Build/Internal/BuildWriterXCode.inl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,10 @@ struct SC::Build::ProjectWriter::WriterXCode
[[nodiscard]] bool computeReferenceHash(StringView name, String& hash)
{
SC_TRY(hashing.setType(Hashing::TypeSHA1));
SC_TRY(hashing.update("reference_"_a8.toBytesSpan()));
SC_TRY(hashing.update(name.toBytesSpan()));
SC_TRY(hashing.add("reference_"_a8.toBytesSpan()));
SC_TRY(hashing.add(name.toBytesSpan()));
Hashing::Result res;
SC_TRY(hashing.finalize(res));
SC_TRY(hashing.getHash(res));
SmallString<64> tmpHash = StringEncoding::Ascii;
SC_TRY(StringBuilder(tmpHash).appendHex(res.toBytesSpan(), StringBuilder::AppendHexCase::UpperCase));
return hash.assign(tmpHash.view().sliceStartLength(0, 24));
Expand All @@ -47,10 +47,10 @@ struct SC::Build::ProjectWriter::WriterXCode
[[nodiscard]] bool computeBuildHash(StringView name, String& hash)
{
SC_TRY(hashing.setType(Hashing::TypeSHA1));
SC_TRY(hashing.update("build_"_a8.toBytesSpan()));
SC_TRY(hashing.update(name.toBytesSpan()));
SC_TRY(hashing.add("build_"_a8.toBytesSpan()));
SC_TRY(hashing.add(name.toBytesSpan()));
Hashing::Result res;
SC_TRY(hashing.finalize(res));
SC_TRY(hashing.getHash(res));
SmallString<64> tmpHash = StringEncoding::Ascii;
SC_TRY(StringBuilder(tmpHash).appendHex(res.toBytesSpan(), StringBuilder::AppendHexCase::UpperCase));
return hash.assign(tmpHash.view().sliceStartLength(0, 24));
Expand Down
16 changes: 8 additions & 8 deletions Libraries/Hashing/Hashing.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ bool SC::Hashing::setType(Type newType)
return false;
}

bool SC::Hashing::update(Span<const uint8_t> data)
bool SC::Hashing::add(Span<const uint8_t> data)
{
if (not inited)
return false;
Expand All @@ -56,7 +56,7 @@ bool SC::Hashing::update(Span<const uint8_t> data)
return true;
}

bool SC::Hashing::finalize(Result& res)
bool SC::Hashing::getHash(Result& res)
{
if (!inited)
return false;
Expand Down Expand Up @@ -140,7 +140,7 @@ bool SC::Hashing::setType(Type newType)
return true;
}

bool SC::Hashing::update(Span<const uint8_t> data)
bool SC::Hashing::add(Span<const uint8_t> data)
{
if (not inited)
return false;
Expand All @@ -152,7 +152,7 @@ bool SC::Hashing::update(Span<const uint8_t> data)
return true;
}

bool SC::Hashing::finalize(Result& res)
bool SC::Hashing::getHash(Result& res)
{
CryptoPrivate& self = *reinterpret_cast<CryptoPrivate*>(buffer);
DWORD hashSize = sizeof(Result::hash);
Expand Down Expand Up @@ -233,7 +233,7 @@ bool SC::Hashing::setType(Type newType)
return true;
}

bool SC::Hashing::update(Span<const uint8_t> data)
bool SC::Hashing::add(Span<const uint8_t> data)
{
if (!inited)
return false;
Expand All @@ -246,7 +246,7 @@ bool SC::Hashing::update(Span<const uint8_t> data)
return true;
}

bool SC::Hashing::finalize(Result& res)
bool SC::Hashing::getHash(Result& res)
{
if (!inited)
return false;
Expand All @@ -270,7 +270,7 @@ bool SC::Hashing::finalize(Result& res)
SC::Hashing::Hashing() {}
SC::Hashing::~Hashing() {}
bool SC::Hashing::setType(Type newType) { return false; }
bool SC::Hashing::update(Span<const uint8_t> data) { return false; }
bool SC::Hashing::finalize(Result& res) { return false; }
bool SC::Hashing::add(Span<const uint8_t> data) { return false; }
bool SC::Hashing::getHash(Result& res) { return false; }

#endif
4 changes: 2 additions & 2 deletions Libraries/Hashing/Hashing.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,12 +54,12 @@ struct Hashing
/// @brief Add data to be hashed. Can be called multiple times before Hashing::finalize
/// @param data Data to be hashed
/// @return `true` if data has been hashed successfully
[[nodiscard]] bool update(Span<const uint8_t> data);
[[nodiscard]] bool add(Span<const uint8_t> data);

/// @brief Finalizes hash computation that has been pushed through Hashing::update
/// @param[out] res Result object holding the actual Result::hash
/// @return `true` if the final hash has been computed successfully
[[nodiscard]] bool finalize(Result& res);
[[nodiscard]] bool getHash(Result& res);

/// @brief Set type of hash to compute
/// @param newType MD5, SHA1, SHA256
Expand Down
30 changes: 15 additions & 15 deletions Libraries/Hashing/Tests/HashingTest.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ struct SC::HashingTest : public SC::TestCase
Hashing hash;
SC_TEST_EXPECT(hash.setType(Hashing::TypeMD5));

SC_TEST_EXPECT(hash.update("test"_a8.toBytesSpan()));
SC_TEST_EXPECT(hash.add("test"_a8.toBytesSpan()));
Hashing::Result res;
SC_TEST_EXPECT(hash.finalize(res));
SC_TEST_EXPECT(hash.getHash(res));

String test;
SC_TEST_EXPECT(StringBuilder(test).appendHex(res.toBytesSpan(), StringBuilder::AppendHexCase::UpperCase));
Expand All @@ -39,10 +39,10 @@ struct SC::HashingTest : public SC::TestCase
Hashing hash;
SC_TEST_EXPECT(hash.setType(Hashing::TypeMD5));

SC_TEST_EXPECT(hash.update("test"_a8.toBytesSpan()));
SC_TEST_EXPECT(hash.update("test"_a8.toBytesSpan()));
SC_TEST_EXPECT(hash.add("test"_a8.toBytesSpan()));
SC_TEST_EXPECT(hash.add("test"_a8.toBytesSpan()));
Hashing::Result res;
SC_TEST_EXPECT(hash.finalize(res));
SC_TEST_EXPECT(hash.getHash(res));

String test;
SC_TEST_EXPECT(StringBuilder(test).appendHex(res.toBytesSpan(), StringBuilder::AppendHexCase::UpperCase));
Expand All @@ -55,9 +55,9 @@ struct SC::HashingTest : public SC::TestCase
Hashing hash;
SC_TEST_EXPECT(hash.setType(Hashing::TypeSHA1));

SC_TEST_EXPECT(hash.update("test"_a8.toBytesSpan()));
SC_TEST_EXPECT(hash.add("test"_a8.toBytesSpan()));
Hashing::Result res;
SC_TEST_EXPECT(hash.finalize(res));
SC_TEST_EXPECT(hash.getHash(res));

String test;
SC_TEST_EXPECT(StringBuilder(test).appendHex(res.toBytesSpan(), StringBuilder::AppendHexCase::UpperCase));
Expand All @@ -70,10 +70,10 @@ struct SC::HashingTest : public SC::TestCase
Hashing hash;
SC_TEST_EXPECT(hash.setType(Hashing::TypeSHA1));

SC_TEST_EXPECT(hash.update("test"_a8.toBytesSpan()));
SC_TEST_EXPECT(hash.update("test"_a8.toBytesSpan()));
SC_TEST_EXPECT(hash.add("test"_a8.toBytesSpan()));
SC_TEST_EXPECT(hash.add("test"_a8.toBytesSpan()));
Hashing::Result res;
SC_TEST_EXPECT(hash.finalize(res));
SC_TEST_EXPECT(hash.getHash(res));

String test;
SC_TEST_EXPECT(StringBuilder(test).appendHex(res.toBytesSpan(), StringBuilder::AppendHexCase::UpperCase));
Expand All @@ -85,9 +85,9 @@ struct SC::HashingTest : public SC::TestCase
Hashing hash;
SC_TEST_EXPECT(hash.setType(Hashing::TypeSHA256));

SC_TEST_EXPECT(hash.update("test"_a8.toBytesSpan()));
SC_TEST_EXPECT(hash.add("test"_a8.toBytesSpan()));
Hashing::Result res;
SC_TEST_EXPECT(hash.finalize(res));
SC_TEST_EXPECT(hash.getHash(res));

String test;
SC_TEST_EXPECT(StringBuilder(test).appendHex(res.toBytesSpan(), StringBuilder::AppendHexCase::UpperCase));
Expand All @@ -100,10 +100,10 @@ struct SC::HashingTest : public SC::TestCase
Hashing hash;
SC_TEST_EXPECT(hash.setType(Hashing::TypeSHA256));

SC_TEST_EXPECT(hash.update("test"_a8.toBytesSpan()));
SC_TEST_EXPECT(hash.update("test"_a8.toBytesSpan()));
SC_TEST_EXPECT(hash.add("test"_a8.toBytesSpan()));
SC_TEST_EXPECT(hash.add("test"_a8.toBytesSpan()));
Hashing::Result res;
SC_TEST_EXPECT(hash.finalize(res));
SC_TEST_EXPECT(hash.getHash(res));

String test;
SC_TEST_EXPECT(StringBuilder(test).appendHex(res.toBytesSpan(), StringBuilder::AppendHexCase::UpperCase));
Expand Down
4 changes: 2 additions & 2 deletions Tools/SC-package.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -91,13 +91,13 @@ struct CustomFunctions
SC_TRY(file.read({data, sizeof(data)}, actuallyRead));
if (actuallyRead.sizeInBytes() > 0)
{
SC_TRY(hashing.update(actuallyRead));
SC_TRY(hashing.add(actuallyRead));
}
else
{
SC_TRY(file.close());
Hashing::Result res;
SC_TRY(hashing.finalize(res));
SC_TRY(hashing.getHash(res));
SmallString<32> result;
SC_TRY(StringBuilder(result).appendHex(res.toBytesSpan(), StringBuilder::AppendHexCase::LowerCase));
SC_TRY_MSG(result.view() == wantedMD5, "MD5 doesn't match");
Expand Down

0 comments on commit f4f9ffa

Please sign in to comment.