High-level API for ROM manipulation and automation. More...

#include <rom_automation_api.h>

Collaboration diagram for yaze::cli::automation::RomAutomationAPI:

[legend]

Classes
struct	BatchOperation
	Batch operation for multiple ROM modifications. More...

struct	RomSnapshot
	Snapshot of ROM state at a point in time. More...

struct	ValidationResult
	Validation result for ROM integrity checks. More...

Public Member Functions
	RomAutomationAPI (Rom *rom)

absl::StatusOr< std::vector< uint8_t > >	ReadBytes (uint32_t address, size_t length) const
	Read bytes from ROM at specified address.

absl::Status	WriteBytes (uint32_t address, const std::vector< uint8_t > &data, bool verify=true)
	Write bytes to ROM at specified address.

absl::StatusOr< std::vector< uint32_t > >	FindPattern (const std::vector< uint8_t > &pattern, uint32_t start_address=0, size_t max_results=100) const
	Find pattern in ROM.

absl::StatusOr< RomSnapshot >	CreateSnapshot (const std::string &name, bool compress=true)
	Create a snapshot of current ROM state.

absl::Status	RestoreSnapshot (const RomSnapshot &snapshot, bool verify=true)
	Restore ROM to a previous snapshot.

std::vector< nlohmann::json >	ListSnapshots () const
	List all available snapshots.

absl::StatusOr< nlohmann::json >	CompareWithSnapshot (const RomSnapshot &snapshot) const
	Compare current ROM with snapshot.

ValidationResult	ValidateHeaders () const
	Validate ROM headers.

ValidationResult	ValidateChecksums () const
	Validate ROM checksums.

ValidationResult	ValidateRegions (const std::vector< std::string > &regions) const
	Validate specific ROM regions.

ValidationResult	ValidateFull () const
	Comprehensive ROM validation.

absl::Status	ApplyPatch (const std::vector< uint8_t > &patch_data, const std::string &patch_format)
	Apply IPS/BPS patch to ROM.

absl::StatusOr< std::vector< uint8_t > >	GeneratePatch (const Rom &target_rom, const std::string &patch_format) const
	Generate patch between current ROM and target.

absl::StatusOr< std::vector< uint8_t > >	ExportRegion (const std::string &region_name, uint32_t start_address=0, uint32_t end_address=0) const
	Export a region of ROM to file.

absl::Status	ImportRegion (const std::string &region_name, const std::vector< uint8_t > &data, uint32_t address)
	Import data to a ROM region.

absl::StatusOr< std::vector< nlohmann::json > >	ExecuteBatch (const std::vector< BatchOperation > &operations, bool stop_on_error=true)
	Execute multiple ROM operations atomically.

std::string	BeginTransaction ()
	Begin a ROM modification transaction.

absl::Status	CommitTransaction (const std::string &transaction_id)
	Commit a ROM modification transaction.

absl::Status	RollbackTransaction (const std::string &transaction_id)
	Rollback a ROM modification transaction.

nlohmann::json	GetStatistics () const
	Get ROM statistics.

nlohmann::json	AnalyzePatterns () const
	Analyze ROM for common patterns.

std::vector< std::pair< uint32_t, size_t > >	FindFreeSpace (size_t min_size=16) const
	Find unused space in ROM.

Private Member Functions
std::vector< uint8_t >	CompressData (const std::vector< uint8_t > &data) const

std::vector< uint8_t >	DecompressData (const std::vector< uint8_t > &data) const

bool	VerifyWrite (uint32_t address, const std::vector< uint8_t > &expected) const

Private Attributes
Rom *	rom_

std::map< std::string, RomSnapshot >	snapshots_

std::map< std::string, std::unique_ptr< class Transaction > >	transactions_

Detailed Description

High-level API for ROM manipulation and automation.

Provides a clean interface for AI agents and automation scripts to interact with ROM data without direct memory manipulation.

Definition at line 23 of file rom_automation_api.h.

Constructor & Destructor Documentation

◆ RomAutomationAPI()

yaze::cli::automation::RomAutomationAPI::RomAutomationAPI ( Rom * rom )

inlineexplicit

Definition at line 25 of file rom_automation_api.h.

Member Function Documentation

◆ ReadBytes()

absl::StatusOr< std::vector< uint8_t > > yaze::cli::automation::RomAutomationAPI::ReadBytes	(	uint32_t	address,
		size_t	length ) const

Read bytes from ROM at specified address.

Parameters

address	Starting address
length	Number of bytes to read

Returns: Vector of bytes or error

◆ WriteBytes()

absl::Status yaze::cli::automation::RomAutomationAPI::WriteBytes	(	uint32_t	address,
		const std::vector< uint8_t > &	data,
		bool	verify = true )

Write bytes to ROM at specified address.

Parameters

address	Starting address
data	Bytes to write
verify	If true, read back and verify write succeeded

Returns: Status of write operation

◆ FindPattern()

absl::StatusOr< std::vector< uint32_t > > yaze::cli::automation::RomAutomationAPI::FindPattern	(	const std::vector< uint8_t > &	pattern,
		uint32_t	start_address = 0,
		size_t	max_results = 100 ) const

Find pattern in ROM.

Parameters

pattern	Bytes to search for
start_address	Optional starting address
max_results	Maximum number of results to return

Returns: Vector of addresses where pattern was found

◆ CreateSnapshot()

absl::StatusOr< RomSnapshot > yaze::cli::automation::RomAutomationAPI::CreateSnapshot	(	const std::string &	name,
		bool	compress = true )

Create a snapshot of current ROM state.

Parameters

name	Snapshot identifier
compress	If true, compress the snapshot data

Returns: Created snapshot or error

◆ RestoreSnapshot()

absl::Status yaze::cli::automation::RomAutomationAPI::RestoreSnapshot	(	const RomSnapshot &	snapshot,
		bool	verify = true )

Restore ROM to a previous snapshot.

Parameters

snapshot	Snapshot to restore
verify	If true, verify restoration succeeded

Returns: Status of restoration

◆ ListSnapshots()

std::vector< nlohmann::json > yaze::cli::automation::RomAutomationAPI::ListSnapshots ( ) const

List all available snapshots.

Returns: Vector of snapshot metadata

◆ CompareWithSnapshot()

absl::StatusOr< nlohmann::json > yaze::cli::automation::RomAutomationAPI::CompareWithSnapshot ( const RomSnapshot & snapshot ) const

Compare current ROM with snapshot.

Parameters

snapshot Snapshot to compare against

Returns: Difference report as JSON

◆ ValidateHeaders()

ValidationResult yaze::cli::automation::RomAutomationAPI::ValidateHeaders ( ) const

Validate ROM headers.

Returns: Validation result

◆ ValidateChecksums()

ValidationResult yaze::cli::automation::RomAutomationAPI::ValidateChecksums ( ) const

Validate ROM checksums.

Returns: Validation result

◆ ValidateRegions()

ValidationResult yaze::cli::automation::RomAutomationAPI::ValidateRegions ( const std::vector< std::string > & regions ) const

Validate specific ROM regions.

Parameters

regions List of region names to validate

Returns: Validation result

◆ ValidateFull()

ValidationResult yaze::cli::automation::RomAutomationAPI::ValidateFull ( ) const

Comprehensive ROM validation.

Returns: Combined validation result

◆ ApplyPatch()

absl::Status yaze::cli::automation::RomAutomationAPI::ApplyPatch	(	const std::vector< uint8_t > &	patch_data,
		const std::string &	patch_format )

Apply IPS/BPS patch to ROM.

Parameters

patch_data	Patch file contents
patch_format	Format of patch (IPS, BPS, etc.)

Returns: Status of patch application

◆ GeneratePatch()

absl::StatusOr< std::vector< uint8_t > > yaze::cli::automation::RomAutomationAPI::GeneratePatch	(	const Rom &	target_rom,
		const std::string &	patch_format ) const

Generate patch between current ROM and target.

Parameters

target_rom	Target ROM to diff against
patch_format	Format to generate (IPS, BPS)

Returns: Generated patch data or error

◆ ExportRegion()

absl::StatusOr< std::vector< uint8_t > > yaze::cli::automation::RomAutomationAPI::ExportRegion	(	const std::string &	region_name,
		uint32_t	start_address = 0,
		uint32_t	end_address = 0 ) const

Export a region of ROM to file.

Parameters

region_name	Named region or custom range
start_address	Start of region (if custom)
end_address	End of region (if custom)

Returns: Exported data or error

◆ ImportRegion()

absl::Status yaze::cli::automation::RomAutomationAPI::ImportRegion	(	const std::string &	region_name,
		const std::vector< uint8_t > &	data,
		uint32_t	address )

Import data to a ROM region.

Parameters

region_name	Named region or custom range
data	Data to import
address	Starting address for import

Returns: Status of import operation

◆ ExecuteBatch()

absl::StatusOr< std::vector< nlohmann::json > > yaze::cli::automation::RomAutomationAPI::ExecuteBatch	(	const std::vector< BatchOperation > &	operations,
		bool	stop_on_error = true )

Execute multiple ROM operations atomically.

Parameters

operations	List of operations to execute
stop_on_error	If true, abort on first error

Returns: Results of each operation or error

◆ BeginTransaction()

std::string yaze::cli::automation::RomAutomationAPI::BeginTransaction ( )

Begin a ROM modification transaction.

Returns: Transaction ID

◆ CommitTransaction()

absl::Status yaze::cli::automation::RomAutomationAPI::CommitTransaction ( const std::string & transaction_id )

Commit a ROM modification transaction.

Parameters

transaction_id Transaction to commit

Returns: Status of commit

◆ RollbackTransaction()

absl::Status yaze::cli::automation::RomAutomationAPI::RollbackTransaction ( const std::string & transaction_id )

Rollback a ROM modification transaction.

Parameters

transaction_id Transaction to rollback

Returns: Status of rollback

◆ GetStatistics()

nlohmann::json yaze::cli::automation::RomAutomationAPI::GetStatistics ( ) const

Get ROM statistics.

Returns: JSON object with ROM statistics

◆ AnalyzePatterns()

nlohmann::json yaze::cli::automation::RomAutomationAPI::AnalyzePatterns ( ) const

Analyze ROM for common patterns.

Returns: Analysis results as JSON

◆ FindFreeSpace()

std::vector< std::pair< uint32_t, size_t > > yaze::cli::automation::RomAutomationAPI::FindFreeSpace ( size_t min_size = 16 ) const

Find unused space in ROM.

Parameters

min_size Minimum size of free space to report

Returns: List of free regions

◆ CompressData()

std::vector< uint8_t > yaze::cli::automation::RomAutomationAPI::CompressData ( const std::vector< uint8_t > & data ) const

private

◆ DecompressData()

std::vector< uint8_t > yaze::cli::automation::RomAutomationAPI::DecompressData ( const std::vector< uint8_t > & data ) const

private

◆ VerifyWrite()

bool yaze::cli::automation::RomAutomationAPI::VerifyWrite	(	uint32_t	address,
		const std::vector< uint8_t > &	expected ) const

private

Member Data Documentation

◆ rom_

Rom* yaze::cli::automation::RomAutomationAPI::rom_

private

Definition at line 273 of file rom_automation_api.h.

◆ snapshots_

std::map<std::string, RomSnapshot> yaze::cli::automation::RomAutomationAPI::snapshots_

private

Definition at line 274 of file rom_automation_api.h.

◆ transactions_

std::map<std::string, std::unique_ptr<class Transaction> > yaze::cli::automation::RomAutomationAPI::transactions_

private

Definition at line 275 of file rom_automation_api.h.

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

src/cli/automation/rom_automation_api.h

	yaze 0.3.2 Link to the Past ROM Editor

Classes

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ RomAutomationAPI()

Member Function Documentation

◆ ReadBytes()

◆ WriteBytes()

◆ FindPattern()

◆ CreateSnapshot()

◆ RestoreSnapshot()

◆ ListSnapshots()

◆ CompareWithSnapshot()

◆ ValidateHeaders()

◆ ValidateChecksums()

◆ ValidateRegions()

◆ ValidateFull()

◆ ApplyPatch()

◆ GeneratePatch()

◆ ExportRegion()

◆ ImportRegion()

◆ ExecuteBatch()

◆ BeginTransaction()

◆ CommitTransaction()

◆ RollbackTransaction()

◆ GetStatistics()

◆ AnalyzePatterns()

◆ FindFreeSpace()

◆ CompressData()

◆ DecompressData()

◆ VerifyWrite()

Member Data Documentation

◆ rom_

◆ snapshots_

◆ transactions_