Base class for memory inspection tools. More...

#include <memory_inspector_tool.h>

Inherits yaze::cli::resources::CommandHandler.

Inherited by yaze::cli::agent::tools::MemoryAnalyzeTool, yaze::cli::agent::tools::MemoryCheckTool, yaze::cli::agent::tools::MemoryCompareTool, yaze::cli::agent::tools::MemoryRegionsTool, and yaze::cli::agent::tools::MemorySearchTool.

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

[legend]

Protected Member Functions
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 absl::Status	ValidateArgs (const ArgumentParser &parser)=0
	Validate command arguments.

virtual absl::Status	Execute (Rom *rom, const ArgumentParser &parser, OutputFormatter &formatter)=0
	Execute the command business logic.

virtual std::string	GetDefaultFormat () const
	Get the default output format ("json" or "text")

virtual std::string	GetOutputTitle () const
	Get the output title for formatting.

Additional Inherited Members
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 std::string	GetName () const =0
	Get the command name.

virtual Descriptor	Describe () const
	Provide metadata for TUI/help summaries.

virtual std::string	GetUsage () const =0
	Get the command usage string.

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.

virtual void	SetAssemblySymbolTable (const std::map< std::string, core::AsarSymbol > *table)
	Optional Asar symbol table for assembly-aware tools.

virtual void	SetSymbolProvider (emu::debug::SymbolProvider *provider)
	Set the SymbolProvider context.

Protected Attributes inherited from yaze::cli::resources::CommandHandler
Rom *	rom_ = nullptr

emu::debug::SymbolProvider *	symbol_provider_ = nullptr

project::YazeProject *	project_ = nullptr

core::AsarWrapper *	asar_wrapper_ = nullptr

const std::map< std::string, core::AsarSymbol > *	assembly_symbol_table_

Detailed Description

Base class for memory inspection tools.

Definition at line 120 of file memory_inspector_tool.h.

Member Function Documentation

◆ DescribeAddress()

std::string yaze::cli::agent::tools::MemoryInspectorBase::DescribeAddress ( uint32_t address ) const

protected

Get description for a memory address.

Definition at line 91 of file memory_inspector_tool.cc.

Referenced by yaze::cli::agent::tools::MemoryAnalyzeTool::Execute(), yaze::cli::agent::tools::MemoryCompareTool::Execute(), and yaze::cli::agent::tools::MemorySearchTool::FindMatches().

Here is the call graph for this function:

◆ IdentifyDataType()

std::string yaze::cli::agent::tools::MemoryInspectorBase::IdentifyDataType ( uint32_t address ) const

protected

Identify data type at address.

Definition at line 140 of file memory_inspector_tool.cc.

References yaze::cli::agent::tools::ALTTPMemoryMap::IsSaveData(), yaze::cli::agent::tools::ALTTPMemoryMap::IsSpriteTable(), yaze::cli::agent::tools::ALTTPMemoryMap::kGameMode, yaze::cli::agent::tools::ALTTPMemoryMap::kLinkDirection, yaze::cli::agent::tools::ALTTPMemoryMap::kLinkXLow, yaze::cli::agent::tools::ALTTPMemoryMap::kOAMBuffer, yaze::cli::agent::tools::ALTTPMemoryMap::kOAMBufferEnd, and yaze::cli::agent::tools::ALTTPMemoryMap::kSubmodule.

Referenced by yaze::cli::agent::tools::MemoryAnalyzeTool::Execute().

Here is the call graph for this function:

◆ GetKnownRegions()

std::vector< MemoryRegionInfo > yaze::cli::agent::tools::MemoryInspectorBase::GetKnownRegions ( ) const

protected

Get known memory regions.

Definition at line 157 of file memory_inspector_tool.cc.

Referenced by yaze::cli::agent::tools::MemoryRegionsTool::Execute().

◆ FormatHex()

std::string yaze::cli::agent::tools::MemoryInspectorBase::FormatHex	(	const std::vector< uint8_t > &	data,
		int	bytes_per_line = 16 ) const

protected

Format bytes as hex string.

Definition at line 197 of file memory_inspector_tool.cc.

◆ FormatAscii()

std::string yaze::cli::agent::tools::MemoryInspectorBase::FormatAscii ( const std::vector< uint8_t > & data ) const

protected

Format bytes as ASCII (printable chars only)

Definition at line 210 of file memory_inspector_tool.cc.

◆ ParseAddress()

absl::StatusOr< uint32_t > yaze::cli::agent::tools::MemoryInspectorBase::ParseAddress ( const std::string & addr_str ) const

protected

Parse address from string (supports hex with $ or 0x prefix)

Definition at line 220 of file memory_inspector_tool.cc.

Referenced by yaze::cli::agent::tools::MemoryAnalyzeTool::Execute(), and yaze::cli::agent::tools::MemoryCompareTool::Execute().

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

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ DescribeAddress()

◆ IdentifyDataType()

◆ GetKnownRegions()

◆ FormatHex()

◆ FormatAscii()

◆ ParseAddress()