Check memory for anomalies and corruption. More...

#include <memory_inspector_tool.h>

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

[legend]

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

[legend]

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.

bool	RequiresLabels () const override
	Check if the command requires ROM labels.

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 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::MemoryInspectorBase
std::string	DescribeAddress (uint32_t address) const
	Get description for a memory address.

std::string	IdentifyDataType (uint32_t address) const
	Identify data type at address.

std::vector< MemoryRegionInfo >	GetKnownRegions () const
	Get known memory regions.

std::string	FormatHex (const std::vector< uint8_t > &data, int bytes_per_line=16) const
	Format bytes as hex string.

std::string	FormatAscii (const std::vector< uint8_t > &data) const
	Format bytes as ASCII (printable chars only)

absl::StatusOr< uint32_t >	ParseAddress (const std::string &addr_str) const
	Parse address from string (supports hex with $ or 0x prefix)

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< MemoryAnomaly >	CheckSpriteTable (const std::vector< uint8_t > &wram) const

std::vector< MemoryAnomaly >	CheckPlayerState (const std::vector< uint8_t > &wram) const

std::vector< MemoryAnomaly >	CheckGameMode (const std::vector< uint8_t > &wram) const

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 memory for anomalies and corruption.

Usage: memory-check [–region <region_name>] [–format <json|text>]

Scans known memory regions for:

Out of bounds values
Null pointer dereferences
Corrupted structures
Invalid sprite states

Definition at line 284 of file memory_inspector_tool.h.

Member Function Documentation

◆ GetName()

std::string yaze::cli::agent::tools::MemoryCheckTool::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 286 of file memory_inspector_tool.h.

◆ GetDescription()

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

inline

Definition at line 288 of file memory_inspector_tool.h.

◆ GetUsage()

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

inlineoverridevirtual

Get the command usage string.

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

Definition at line 292 of file memory_inspector_tool.h.

◆ RequiresLabels()

bool yaze::cli::agent::tools::MemoryCheckTool::RequiresLabels ( ) const

inlineoverridevirtual

Check if the command requires ROM labels.

Override to return false if labels are not needed.

Reimplemented from yaze::cli::resources::CommandHandler.

Definition at line 296 of file memory_inspector_tool.h.

◆ ValidateArgs()

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

overrideprotectedvirtual

Validate command arguments.

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

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

Definition at line 520 of file memory_inspector_tool.cc.

◆ Execute()

absl::Status yaze::cli::agent::tools::MemoryCheckTool::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 525 of file memory_inspector_tool.cc.

References yaze::cli::resources::OutputFormatter::AddField(), yaze::cli::resources::OutputFormatter::BeginObject(), yaze::cli::resources::OutputFormatter::EndObject(), and yaze::cli::resources::ArgumentParser::GetString().

Here is the call graph for this function:

◆ CheckSpriteTable()

std::vector< MemoryAnomaly > yaze::cli::agent::tools::MemoryCheckTool::CheckSpriteTable ( const std::vector< uint8_t > & wram ) const

private

Definition at line 555 of file memory_inspector_tool.cc.

References yaze::cli::agent::tools::ALTTPMemoryMap::kMaxSprites, yaze::cli::agent::tools::ALTTPMemoryMap::kSpriteState, and yaze::cli::agent::tools::ALTTPMemoryMap::kSpriteType.

◆ CheckPlayerState()

std::vector< MemoryAnomaly > yaze::cli::agent::tools::MemoryCheckTool::CheckPlayerState ( const std::vector< uint8_t > & wram ) const

private

Definition at line 590 of file memory_inspector_tool.cc.

References yaze::cli::agent::tools::ALTTPMemoryMap::kLinkXLow.

◆ CheckGameMode()

std::vector< MemoryAnomaly > yaze::cli::agent::tools::MemoryCheckTool::CheckGameMode ( const std::vector< uint8_t > & wram ) const

private

Definition at line 613 of file memory_inspector_tool.cc.

References yaze::cli::agent::tools::ALTTPMemoryMap::kGameMode.

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

src/cli/service/agent/tools/memory_inspector_tool.h
src/cli/service/agent/tools/memory_inspector_tool.cc

	yaze 0.3.2 Link to the Past ROM Editor

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetName()

◆ GetDescription()

◆ GetUsage()

◆ RequiresLabels()

◆ ValidateArgs()

◆ Execute()

◆ CheckSpriteTable()

◆ CheckPlayerState()

◆ CheckGameMode()