Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Merge pull request #11953 from Minty-Meeo/dolphin-tool-code-review-2 
DolphinTool: Ditch OOP design
  • Loading branch information
@AdmiralCurtiss
AdmiralCurtiss committed Jun 17, 2023
2 parents 98b5d72 + 25c020c commit 523f8c5
Show file tree
Hide file tree
Showing 11 changed files with 117 additions and 169 deletions.
1 change: 0 additions & 1 deletion Source/Core/DolphinTool/CMakeLists.txt
View file
@@ -1,6 +1,5 @@
add_executable(dolphin-tool
ToolHeadlessPlatform.cpp
Command.h
ConvertCommand.cpp
ConvertCommand.h
VerifyCommand.cpp
Expand Down
19 changes: 0 additions & 19 deletions Source/Core/DolphinTool/Command.h
View file

This file was deleted.

65 changes: 32 additions & 33 deletions Source/Core/DolphinTool/ConvertCommand.cpp
View file
Expand Up @@ -18,12 +18,42 @@
#include "DiscIO/Volume.h"
#include "DiscIO/VolumeDisc.h"
#include "DiscIO/WIABlob.h"
#include "DolphinTool/Command.h"
#include "UICommon/UICommon.h"

namespace DolphinTool
{
int ConvertCommand::Main(const std::vector<std::string>& args)
static std::optional<DiscIO::WIARVZCompressionType>
ParseCompressionTypeString(const std::string& compression_str)
{
if (compression_str == "none")
return DiscIO::WIARVZCompressionType::None;
else if (compression_str == "purge")
return DiscIO::WIARVZCompressionType::Purge;
else if (compression_str == "bzip2")
return DiscIO::WIARVZCompressionType::Bzip2;
else if (compression_str == "lzma")
return DiscIO::WIARVZCompressionType::LZMA;
else if (compression_str == "lzma2")
return DiscIO::WIARVZCompressionType::LZMA2;
else if (compression_str == "zstd")
return DiscIO::WIARVZCompressionType::Zstd;
return std::nullopt;
}

static std::optional<DiscIO::BlobType> ParseFormatString(const std::string& format_str)
{
if (format_str == "iso")
return DiscIO::BlobType::PLAIN;
else if (format_str == "gcz")
return DiscIO::BlobType::GCZ;
else if (format_str == "wia")
return DiscIO::BlobType::WIA;
else if (format_str == "rvz")
return DiscIO::BlobType::RVZ;
return std::nullopt;
}

int ConvertCommand(const std::vector<std::string>& args)
{
optparse::OptionParser parser;

Expand Down Expand Up @@ -324,35 +354,4 @@ int ConvertCommand::Main(const std::vector<std::string>& args)

return 0;
}

std::optional<DiscIO::WIARVZCompressionType>
ConvertCommand::ParseCompressionTypeString(const std::string& compression_str)
{
if (compression_str == "none")
return DiscIO::WIARVZCompressionType::None;
else if (compression_str == "purge")
return DiscIO::WIARVZCompressionType::Purge;
else if (compression_str == "bzip2")
return DiscIO::WIARVZCompressionType::Bzip2;
else if (compression_str == "lzma")
return DiscIO::WIARVZCompressionType::LZMA;
else if (compression_str == "lzma2")
return DiscIO::WIARVZCompressionType::LZMA2;
else if (compression_str == "zstd")
return DiscIO::WIARVZCompressionType::Zstd;
return std::nullopt;
}

std::optional<DiscIO::BlobType> ConvertCommand::ParseFormatString(const std::string& format_str)
{
if (format_str == "iso")
return DiscIO::BlobType::PLAIN;
else if (format_str == "gcz")
return DiscIO::BlobType::GCZ;
else if (format_str == "wia")
return DiscIO::BlobType::WIA;
else if (format_str == "rvz")
return DiscIO::BlobType::RVZ;
return std::nullopt;
}
} // namespace DolphinTool
17 changes: 1 addition & 16 deletions Source/Core/DolphinTool/ConvertCommand.h
View file
Expand Up @@ -3,25 +3,10 @@

#pragma once

#include <optional>
#include <string>
#include <vector>

#include "DiscIO/Blob.h"
#include "DiscIO/WIABlob.h"
#include "DolphinTool/Command.h"

namespace DolphinTool
{
class ConvertCommand final : public Command
{
public:
int Main(const std::vector<std::string>& args) override;

private:
std::optional<DiscIO::WIARVZCompressionType>
ParseCompressionTypeString(const std::string& compression_str);
std::optional<DiscIO::BlobType> ParseFormatString(const std::string& format_str);
};

int ConvertCommand(const std::vector<std::string>& args);
} // namespace DolphinTool
3 changes: 2 additions & 1 deletion Source/Core/DolphinTool/DolphinTool.filters
View file
Expand Up @@ -3,13 +3,14 @@
<ItemGroup>
<ClCompile Include="ConvertCommand.cpp" />
<ClCompile Include="VerifyCommand.cpp" />
<ClCompile Include="HeaderCommand.cpp" />
<ClCompile Include="ToolHeadlessPlatform.cpp" />
<ClCompile Include="ToolMain.cpp" />
</ItemGroup>
<ItemGroup>
<ClInclude Include="Command.h" />
<ClInclude Include="ConvertCommand.h" />
<ClInclude Include="VerifyCommand.h" />
<ClInclude Include="HeaderCommand.h" />
</ItemGroup>
<ItemGroup>
<Manifest Include="DolphinTool.exe.manifest" />
Expand Down
1 change: 0 additions & 1 deletion Source/Core/DolphinTool/DolphinTool.vcxproj
View file
Expand Up @@ -48,7 +48,6 @@
<SourceFiles Include="$(TargetPath)" />
</ItemGroup>
<ItemGroup>
<ClInclude Include="Command.h" />
<ClInclude Include="ConvertCommand.h" />
<ClInclude Include="VerifyCommand.h" />
<ClInclude Include="HeaderCommand.h" />
Expand Down
12 changes: 8 additions & 4 deletions Source/Core/DolphinTool/HeaderCommand.cpp
View file
Expand Up @@ -2,16 +2,20 @@
// SPDX-License-Identifier: GPL-2.0-or-later

#include "DolphinTool/HeaderCommand.h"

#include <optional>
#include <string>
#include <vector>

#include <OptionParser.h>

#include "DiscIO/Blob.h"
#include "DiscIO/Volume.h"
#include "DiscIO/VolumeDisc.h"

#include <OptionParser.h>
#include <optional>

namespace DolphinTool
{
int HeaderCommand::Main(const std::vector<std::string>& args)
int HeaderCommand(const std::vector<std::string>& args)
{
optparse::OptionParser parser;

Expand Down
9 changes: 1 addition & 8 deletions Source/Core/DolphinTool/HeaderCommand.h
View file
Expand Up @@ -6,14 +6,7 @@
#include <string>
#include <vector>

#include "DolphinTool/Command.h"

namespace DolphinTool
{
class HeaderCommand final : public Command
{
public:
int Main(const std::vector<std::string>& args) override;
};

int HeaderCommand(const std::vector<std::string>& args);
} // namespace DolphinTool
16 changes: 6 additions & 10 deletions Source/Core/DolphinTool/ToolMain.cpp
View file
Expand Up @@ -8,9 +8,10 @@
#include <string_view>
#include <vector>

#include "Common/StringUtil.h"
#include "Common/Version.h"
#include "Core/Core.h"
#include "DolphinTool/Command.h"

#include "DolphinTool/ConvertCommand.h"
#include "DolphinTool/HeaderCommand.h"
#include "DolphinTool/VerifyCommand.h"
Expand Down Expand Up @@ -38,18 +39,13 @@ int main(int argc, char* argv[])
// Take off the program name and command selector before passing arguments down
const std::vector<std::string> args(argv + 2, argv + argc);

std::unique_ptr<DolphinTool::Command> command;

if (command_str == "convert")
command = std::make_unique<DolphinTool::ConvertCommand>();
return DolphinTool::ConvertCommand(args);
else if (command_str == "verify")
command = std::make_unique<DolphinTool::VerifyCommand>();
return DolphinTool::VerifyCommand(args);
else if (command_str == "header")
command = std::make_unique<DolphinTool::HeaderCommand>();
else
return PrintUsage(1);

return command->Main(args);
return DolphinTool::HeaderCommand(args);
return PrintUsage(1);
}

#ifdef _WIN32
Expand Down
125 changes: 66 additions & 59 deletions Source/Core/DolphinTool/VerifyCommand.cpp
View file
Expand Up @@ -2,13 +2,77 @@
// SPDX-License-Identifier: GPL-2.0-or-later

#include "DolphinTool/VerifyCommand.h"
#include "UICommon/UICommon.h"

#include <string>
#include <vector>

#include <OptionParser.h>

#include "Common/StringUtil.h"
#include "DiscIO/VolumeDisc.h"
#include "DiscIO/VolumeVerifier.h"
#include "UICommon/UICommon.h"

namespace DolphinTool
{
int VerifyCommand::Main(const std::vector<std::string>& args)
static std::string HashToHexString(const std::vector<u8>& hash)
{
std::stringstream ss;
ss << std::hex;
for (int i = 0; i < static_cast<int>(hash.size()); ++i)
{
ss << std::setw(2) << std::setfill('0') << static_cast<int>(hash[i]);
}
return ss.str();
}

static void PrintFullReport(const DiscIO::VolumeVerifier::Result& result)
{
if (!result.hashes.crc32.empty())
std::cout << "CRC32: " << HashToHexString(result.hashes.crc32) << std::endl;
else
std::cout << "CRC32 not computed" << std::endl;

if (!result.hashes.md5.empty())
std::cout << "MD5: " << HashToHexString(result.hashes.md5) << std::endl;
else
std::cout << "MD5 not computed" << std::endl;

if (!result.hashes.sha1.empty())
std::cout << "SHA1: " << HashToHexString(result.hashes.sha1) << std::endl;
else
std::cout << "SHA1 not computed" << std::endl;

std::cout << "Problems Found: " << (result.problems.empty() ? "No" : "Yes") << std::endl;

for (const auto& problem : result.problems)
{
std::cout << std::endl << "Severity: ";
switch (problem.severity)
{
case DiscIO::VolumeVerifier::Severity::Low:
std::cout << "Low";
break;
case DiscIO::VolumeVerifier::Severity::Medium:
std::cout << "Medium";
break;
case DiscIO::VolumeVerifier::Severity::High:
std::cout << "High";
break;
case DiscIO::VolumeVerifier::Severity::None:
std::cout << "None";
break;
default:
ASSERT(false);
break;
}
std::cout << std::endl;

std::cout << "Summary: " << problem.text << std::endl << std::endl;
}
}

int VerifyCommand(const std::vector<std::string>& args)
{
optparse::OptionParser parser;

Expand Down Expand Up @@ -115,61 +179,4 @@ int VerifyCommand::Main(const std::vector<std::string>& args)

return 0;
}

void VerifyCommand::PrintFullReport(const DiscIO::VolumeVerifier::Result& result)
{
if (!result.hashes.crc32.empty())
std::cout << "CRC32: " << HashToHexString(result.hashes.crc32) << std::endl;
else
std::cout << "CRC32 not computed" << std::endl;

if (!result.hashes.md5.empty())
std::cout << "MD5: " << HashToHexString(result.hashes.md5) << std::endl;
else
std::cout << "MD5 not computed" << std::endl;

if (!result.hashes.sha1.empty())
std::cout << "SHA1: " << HashToHexString(result.hashes.sha1) << std::endl;
else
std::cout << "SHA1 not computed" << std::endl;

std::cout << "Problems Found: " << (result.problems.empty() ? "No" : "Yes") << std::endl;

for (const auto& problem : result.problems)
{
std::cout << std::endl << "Severity: ";
switch (problem.severity)
{
case DiscIO::VolumeVerifier::Severity::Low:
std::cout << "Low";
break;
case DiscIO::VolumeVerifier::Severity::Medium:
std::cout << "Medium";
break;
case DiscIO::VolumeVerifier::Severity::High:
std::cout << "High";
break;
case DiscIO::VolumeVerifier::Severity::None:
std::cout << "None";
break;
default:
ASSERT(false);
break;
}
std::cout << std::endl;

std::cout << "Summary: " << problem.text << std::endl << std::endl;
}
}

std::string VerifyCommand::HashToHexString(const std::vector<u8>& hash)
{
std::stringstream ss;
ss << std::hex;
for (int i = 0; i < static_cast<int>(hash.size()); ++i)
{
ss << std::setw(2) << std::setfill('0') << static_cast<int>(hash[i]);
}
return ss.str();
}
} // namespace DolphinTool

0 comments on commit 523f8c5

Please sign in to comment.