yaze::cli::agent::tools::PatchCheckTool Class Reference

Check ROM compatibility with patches. More...

#include <validation_tool.h>

Inheritance diagram for yaze::cli::agent::tools::PatchCheckTool:

Collaboration diagram for yaze::cli::agent::tools::PatchCheckTool:

Public Member Functions
std::string	GetName () const override
	Get the command name.
std::string	GetDescription () const
std::string	GetUsage () const override
	Get the command usage string.
Public Member Functions inherited from yaze::cli::resources::CommandHandler
virtual	~CommandHandler ()=default
absl::Status	Run (const std::vector< std::string > &args, Rom *rom_context, std::string *captured_output=nullptr)
	Execute the command.
virtual Descriptor	Describe () const
	Provide metadata for TUI/help summaries.
virtual bool	RequiresRom () const
	Check if the command requires a loaded ROM.
virtual bool	RequiresLabels () const
	Check if the command requires ROM labels.
virtual void	SetProjectContext (project::YazeProject *project)
	Set the YazeProject context. Default implementation does nothing, override if tool needs project info.
virtual void	SetAsarWrapper (core::AsarWrapper *asar_wrapper)
	Set the AsarWrapper context. Default implementation does nothing, override if tool needs Asar access.
virtual void	SetRomContext (Rom *rom)
	Set the ROM context for tools that need ROM access. Default implementation stores the ROM pointer for subclass use.

Protected Member Functions
absl::Status	ValidateArgs (const resources::ArgumentParser &parser) override
	Validate command arguments.
absl::Status	Execute (Rom *rom, const resources::ArgumentParser &parser, resources::OutputFormatter &formatter) override
	Execute the command business logic.
Protected Member Functions inherited from yaze::cli::agent::tools::ValidationToolBase
std::string	FormatIssuesAsJson (const std::vector< ValidationIssue > &issues) const
	Format validation issues as JSON.
std::string	FormatIssuesAsText (const std::vector< ValidationIssue > &issues) const
	Format validation issues as text.
Protected Member Functions inherited from yaze::cli::resources::CommandHandler
virtual std::string	GetDefaultFormat () const
	Get the default output format ("json" or "text")
virtual std::string	GetOutputTitle () const
	Get the output title for formatting.

Private Member Functions
std::vector< ValidationIssue >	CheckFreeSpace (Rom *rom)
std::vector< ValidationIssue >	CheckHooks (Rom *rom, const std::string &patch_path)

Additional Inherited Members
Protected Attributes inherited from yaze::cli::resources::CommandHandler
Rom *	rom_ = nullptr
project::YazeProject *	project_ = nullptr
core::AsarWrapper *	asar_wrapper_ = nullptr

Detailed Description

Check ROM compatibility with patches.

Checks:

• Required free space regions
• Conflicting ASM hooks
• Version compatibility
• Expansion requirements

Usage: patch-check –patch=<path> [–format=<json|text>]

Definition at line 159 of file validation_tool.h.

Member Function Documentation

GetName()

std::string yaze::cli::agent::tools::PatchCheckTool::GetName ( ) const

inlineoverridevirtual

Get the command name.

Override this to provide a unique identifier for the command. This is used for command registration and lookup.

Implements yaze::cli::resources::CommandHandler.

Definition at line 161 of file validation_tool.h.

GetDescription()

std::string yaze::cli::agent::tools::PatchCheckTool::GetDescription ( ) const

inline

Definition at line 163 of file validation_tool.h.

GetUsage()

std::string yaze::cli::agent::tools::PatchCheckTool::GetUsage ( ) const

inlineoverridevirtual

Get the command usage string.

Implements yaze::cli::resources::CommandHandler.

Definition at line 167 of file validation_tool.h.

ValidateArgs()

absl::Status yaze::cli::agent::tools::PatchCheckTool::ValidateArgs ( const resources::ArgumentParser & parser )

inlineoverrideprotectedvirtual

Validate command arguments.

Override this to check required arguments and perform custom validation. Called before Execute().

Implements yaze::cli::resources::CommandHandler.

Definition at line 172 of file validation_tool.h.

References yaze::cli::resources::ArgumentParser::RequireArgs().

Here is the call graph for this function:

Execute()

absl::Status yaze::cli::agent::tools::PatchCheckTool::Execute ( Rom * rom, const resources::ArgumentParser & parser, resources::OutputFormatter & formatter )

overrideprotectedvirtual

Execute the command business logic.

Override this to implement command-specific functionality. The ROM is guaranteed to be loaded and labels initialized.

Implements yaze::cli::resources::CommandHandler.

Definition at line 430 of file validation_tool.cc.

References yaze::cli::resources::OutputFormatter::AddField(), CheckFreeSpace(), CheckHooks(), yaze::cli::agent::tools::ValidationToolBase::FormatIssuesAsJson(), yaze::cli::agent::tools::ValidationToolBase::FormatIssuesAsText(), and yaze::cli::resources::ArgumentParser::GetString().

CheckFreeSpace()

std::vector< ValidationIssue > yaze::cli::agent::tools::PatchCheckTool::CheckFreeSpace ( Rom * rom )

private

Definition at line 456 of file validation_tool.cc.

References yaze::cli::agent::tools::ValidationIssue::kInfo, yaze::cli::agent::tools::ValidationIssue::kWarning, and yaze::Rom::size().

Referenced by Execute().

Here is the call graph for this function:

CheckHooks()

std::vector< ValidationIssue > yaze::cli::agent::tools::PatchCheckTool::CheckHooks ( Rom * rom, const std::string & patch_path )

private

Definition at line 509 of file validation_tool.cc.

References yaze::cli::agent::tools::ValidationIssue::kError, yaze::cli::agent::tools::ValidationIssue::kInfo, yaze::cli::agent::tools::ValidationIssue::kWarning, yaze::Rom::ReadByte(), and yaze::Rom::size().

Referenced by Execute().

Here is the call graph for this function:

---

The documentation for this class was generated from the following files:

• src/cli/service/agent/tools/validation_tool.h
• src/cli/service/agent/tools/validation_tool.cc