#include <save_state_manager.h>

Collaboration diagram for yaze::emu::render::SaveStateManager:

[legend]

Classes
struct	CacheKey

struct	CacheKeyHash

Public Member Functions
	SaveStateManager (emu::Snes snes, Rom rom)

	~SaveStateManager ()

absl::Status	Initialize ()

absl::Status	LoadState (StateType type, int context_id=0)

absl::Status	GenerateRoomState (int room_id)

absl::Status	GenerateAllBaselineStates ()

bool	HasCachedState (StateType type, int context_id=0) const

absl::StatusOr< StateMetadata >	GetStateMetadata (StateType type, int context_id=0) const

absl::Status	SaveStateToFile (const std::string &path, const StateMetadata &metadata)

absl::Status	LoadStateFromFile (const std::string &path)

void	SetStateDirectory (const std::string &path)

const std::string &	GetStateDirectory () const

uint32_t	CalculateRomChecksum () const

Private Member Functions
absl::Status	BootToTitleScreen ()

absl::Status	NavigateToFileSelect ()

absl::Status	StartNewGame ()

absl::Status	NavigateToRoom (int room_id)

void	PressButton (int button, int frames=1)

void	ReleaseAllButtons ()

void	WaitFrames (int frames)

bool	WaitForModule (uint8_t target, int max_frames)

absl::Status	TeleportToRoomViaWram (int room_id)

absl::Status	NavigateToRoomViaTas (int room_id)

uint8_t	ReadWram (uint32_t addr)

uint16_t	ReadWram16 (uint32_t addr)

int	GetCurrentRoom ()

uint8_t	GetGameModule ()

bool	IsRoomFullyLoaded ()

std::string	GetStatePath (StateType type, int context_id) const

std::string	GetMetadataPath (StateType type, int context_id) const

bool	IsStateCompatible (const StateMetadata &metadata) const

Private Attributes
emu::Snes *	snes_ = nullptr

Rom *	rom_ = nullptr

std::string	state_directory_

uint32_t	rom_checksum_ = 0

std::unordered_map< CacheKey, StateMetadata, CacheKeyHash >	state_cache_

Detailed Description

Definition at line 35 of file save_state_manager.h.

Constructor & Destructor Documentation

◆ SaveStateManager()

yaze::emu::render::SaveStateManager::SaveStateManager	(	emu::Snes *	snes,
		Rom *	rom )

Definition at line 56 of file save_state_manager.cc.

References state_directory_.

◆ ~SaveStateManager()

yaze::emu::render::SaveStateManager::~SaveStateManager ( )

default

Member Function Documentation

◆ Initialize()

absl::Status yaze::emu::render::SaveStateManager::Initialize ( )

Definition at line 64 of file save_state_manager.cc.

References CalculateRomChecksum(), rom_, rom_checksum_, snes_, and state_directory_.

Here is the call graph for this function:

◆ LoadState()

absl::Status yaze::emu::render::SaveStateManager::LoadState	(	StateType	type,
		int	context_id = 0 )

Definition at line 87 of file save_state_manager.cc.

References GetMetadataPath(), GetStateMetadata(), GetStatePath(), IsStateCompatible(), and LoadStateFromFile().

◆ GenerateRoomState()

absl::Status yaze::emu::render::SaveStateManager::GenerateRoomState ( int room_id )

Todo: detect region

Definition at line 107 of file save_state_manager.cc.

References BootToTitleScreen(), yaze::emu::render::StateMetadata::description, yaze::emu::render::StateMetadata::game_module, GetGameModule(), GetStatePath(), yaze::emu::render::kRoomLoaded, NavigateToFileSelect(), NavigateToRoom(), yaze::emu::render::StateMetadata::rom_checksum, rom_checksum_, yaze::emu::render::StateMetadata::rom_region, yaze::emu::render::StateMetadata::room_id, SaveStateToFile(), and StartNewGame().

Referenced by GenerateAllBaselineStates().

◆ GenerateAllBaselineStates()

absl::Status yaze::emu::render::SaveStateManager::GenerateAllBaselineStates ( )

Definition at line 146 of file save_state_manager.cc.

References GenerateRoomState().

Here is the call graph for this function:

◆ HasCachedState()

bool yaze::emu::render::SaveStateManager::HasCachedState	(	StateType	type,
		int	context_id = 0 ) const

Definition at line 174 of file save_state_manager.cc.

References GetStatePath().

Here is the call graph for this function:

◆ GetStateMetadata()

absl::StatusOr< StateMetadata > yaze::emu::render::SaveStateManager::GetStateMetadata	(	StateType	type,
		int	context_id = 0 ) const

Definition at line 179 of file save_state_manager.cc.

References yaze::emu::render::StateMetadata::description, yaze::emu::render::StateMetadata::game_module, GetMetadataPath(), yaze::emu::render::StateMetadata::rom_checksum, yaze::emu::render::StateMetadata::rom_region, yaze::emu::render::StateMetadata::room_id, and yaze::emu::render::StateMetadata::version.

Referenced by LoadState().

Here is the call graph for this function:

◆ SaveStateToFile()

absl::Status yaze::emu::render::SaveStateManager::SaveStateToFile	(	const std::string &	path,
		const StateMetadata &	metadata )

Definition at line 212 of file save_state_manager.cc.

References yaze::emu::render::StateMetadata::description, yaze::emu::render::StateMetadata::game_module, yaze::emu::render::StateMetadata::rom_checksum, yaze::emu::render::StateMetadata::rom_region, yaze::emu::render::StateMetadata::room_id, yaze::emu::Snes::saveState(), snes_, and yaze::emu::render::StateMetadata::version.

Referenced by GenerateRoomState().

Here is the call graph for this function:

◆ LoadStateFromFile()

absl::Status yaze::emu::render::SaveStateManager::LoadStateFromFile ( const std::string & path )

Definition at line 255 of file save_state_manager.cc.

References yaze::emu::Snes::loadState(), and snes_.

Referenced by LoadState().

Here is the call graph for this function:

◆ SetStateDirectory()

void yaze::emu::render::SaveStateManager::SetStateDirectory ( const std::string & path )

inline

Definition at line 69 of file save_state_manager.h.

References state_directory_.

◆ GetStateDirectory()

const std::string & yaze::emu::render::SaveStateManager::GetStateDirectory ( ) const

inline

Definition at line 70 of file save_state_manager.h.

References state_directory_.

◆ CalculateRomChecksum()

uint32_t yaze::emu::render::SaveStateManager::CalculateRomChecksum ( ) const

Definition at line 264 of file save_state_manager.cc.

References yaze::emu::render::CalculateCRC32(), yaze::Rom::data(), yaze::Rom::is_loaded(), rom_, and yaze::Rom::size().

Referenced by Initialize().

Here is the call graph for this function:

◆ BootToTitleScreen()

absl::Status yaze::emu::render::SaveStateManager::BootToTitleScreen ( )

private

Definition at line 271 of file save_state_manager.cc.

References GetGameModule(), yaze::emu::render::buttons::kStart, yaze::emu::Snes::Reset(), yaze::emu::Snes::RunFrame(), yaze::emu::Snes::SetButtonState(), and snes_.

Referenced by GenerateRoomState().

Here is the call graph for this function:

◆ NavigateToFileSelect()

absl::Status yaze::emu::render::SaveStateManager::NavigateToFileSelect ( )

private

Definition at line 319 of file save_state_manager.cc.

References GetGameModule(), yaze::emu::render::buttons::kStart, yaze::emu::Snes::RunFrame(), yaze::emu::Snes::SetButtonState(), and snes_.

Referenced by GenerateRoomState().

Here is the call graph for this function:

◆ StartNewGame()

absl::Status yaze::emu::render::SaveStateManager::StartNewGame ( )

private

Definition at line 345 of file save_state_manager.cc.

References GetGameModule(), yaze::emu::render::buttons::kA, yaze::emu::render::buttons::kStart, yaze::emu::Snes::RunFrame(), yaze::emu::Snes::SetButtonState(), snes_, and yaze::emu::Snes::Write().

Referenced by GenerateRoomState().

Here is the call graph for this function:

◆ NavigateToRoom()

absl::Status yaze::emu::render::SaveStateManager::NavigateToRoom ( int room_id )

private

Definition at line 422 of file save_state_manager.cc.

References NavigateToRoomViaTas(), and TeleportToRoomViaWram().

Referenced by GenerateRoomState().

Here is the call graph for this function:

◆ PressButton()

void yaze::emu::render::SaveStateManager::PressButton	(	int	button,
		int	frames = 1 )

private

Definition at line 504 of file save_state_manager.cc.

References yaze::emu::Snes::RunFrame(), yaze::emu::Snes::SetButtonState(), and snes_.

Here is the call graph for this function:

◆ ReleaseAllButtons()

void yaze::emu::render::SaveStateManager::ReleaseAllButtons ( )

private

Definition at line 512 of file save_state_manager.cc.

References yaze::emu::render::buttons::kA, yaze::emu::render::buttons::kB, yaze::emu::render::buttons::kDown, yaze::emu::render::buttons::kL, yaze::emu::render::buttons::kLeft, yaze::emu::render::buttons::kR, yaze::emu::render::buttons::kRight, yaze::emu::render::buttons::kSelect, yaze::emu::render::buttons::kStart, yaze::emu::render::buttons::kUp, yaze::emu::render::buttons::kX, yaze::emu::render::buttons::kY, yaze::emu::Snes::SetButtonState(), and snes_.

Here is the call graph for this function:

◆ WaitFrames()

void yaze::emu::render::SaveStateManager::WaitFrames ( int frames )

private

Definition at line 521 of file save_state_manager.cc.

References yaze::emu::Snes::RunFrame(), and snes_.

Here is the call graph for this function:

◆ WaitForModule()

bool yaze::emu::render::SaveStateManager::WaitForModule	(	uint8_t	target,
		int	max_frames )

private

Definition at line 543 of file save_state_manager.cc.

References GetGameModule(), yaze::emu::Snes::RunFrame(), and snes_.

Here is the call graph for this function:

◆ TeleportToRoomViaWram()

absl::Status yaze::emu::render::SaveStateManager::TeleportToRoomViaWram ( int room_id )

private

Definition at line 435 of file save_state_manager.cc.

References GetCurrentRoom(), GetGameModule(), IsRoomFullyLoaded(), ReadWram(), yaze::emu::Snes::RunFrame(), snes_, and yaze::emu::Snes::Write().

Referenced by NavigateToRoom().

◆ NavigateToRoomViaTas()

absl::Status yaze::emu::render::SaveStateManager::NavigateToRoomViaTas ( int room_id )

private

Definition at line 481 of file save_state_manager.cc.

References GetCurrentRoom(), IsRoomFullyLoaded(), yaze::emu::Snes::RunFrame(), and snes_.

Referenced by NavigateToRoom().

Here is the call graph for this function:

◆ ReadWram()

uint8_t yaze::emu::render::SaveStateManager::ReadWram ( uint32_t addr )

private

Definition at line 527 of file save_state_manager.cc.

References yaze::emu::Snes::Read(), and snes_.

Referenced by GetGameModule(), IsRoomFullyLoaded(), and TeleportToRoomViaWram().

Here is the call graph for this function:

◆ ReadWram16()

uint16_t yaze::emu::render::SaveStateManager::ReadWram16 ( uint32_t addr )

private

Definition at line 531 of file save_state_manager.cc.

References yaze::emu::Snes::Read(), and snes_.

Referenced by GetCurrentRoom().

Here is the call graph for this function:

◆ GetCurrentRoom()

int yaze::emu::render::SaveStateManager::GetCurrentRoom ( )

private

Definition at line 535 of file save_state_manager.cc.

References yaze::emu::render::wram_addresses::kRoomId, and ReadWram16().

Referenced by NavigateToRoomViaTas(), and TeleportToRoomViaWram().

Here is the call graph for this function:

◆ GetGameModule()

uint8_t yaze::emu::render::SaveStateManager::GetGameModule ( )

private

Definition at line 539 of file save_state_manager.cc.

References yaze::emu::render::wram_addresses::kGameModule, and ReadWram().

Referenced by BootToTitleScreen(), GenerateRoomState(), NavigateToFileSelect(), StartNewGame(), TeleportToRoomViaWram(), and WaitForModule().

Here is the call graph for this function:

◆ IsRoomFullyLoaded()

bool yaze::emu::render::SaveStateManager::IsRoomFullyLoaded ( )

private

Definition at line 553 of file save_state_manager.cc.

References ReadWram().

Referenced by NavigateToRoomViaTas(), and TeleportToRoomViaWram().

Here is the call graph for this function:

◆ GetStatePath()

std::string yaze::emu::render::SaveStateManager::GetStatePath	(	StateType	type,
		int	context_id ) const

private

Definition at line 563 of file save_state_manager.cc.

References yaze::emu::render::kBlankCanvas, yaze::emu::render::kOverworldLoaded, yaze::emu::render::kRoomLoaded, and state_directory_.

Referenced by GenerateRoomState(), GetMetadataPath(), HasCachedState(), and LoadState().

◆ GetMetadataPath()

std::string yaze::emu::render::SaveStateManager::GetMetadataPath	(	StateType	type,
		int	context_id ) const

private

Definition at line 581 of file save_state_manager.cc.

References GetStatePath().

Referenced by GetStateMetadata(), and LoadState().

Here is the call graph for this function:

◆ IsStateCompatible()

bool yaze::emu::render::SaveStateManager::IsStateCompatible ( const StateMetadata & metadata ) const

private

Definition at line 586 of file save_state_manager.cc.

References yaze::emu::render::StateMetadata::rom_checksum, and rom_checksum_.

Referenced by LoadState().

Member Data Documentation

◆ snes_

emu::Snes* yaze::emu::render::SaveStateManager::snes_ = nullptr

private

Definition at line 106 of file save_state_manager.h.

Referenced by BootToTitleScreen(), Initialize(), LoadStateFromFile(), NavigateToFileSelect(), NavigateToRoomViaTas(), PressButton(), ReadWram(), ReadWram16(), ReleaseAllButtons(), SaveStateToFile(), StartNewGame(), TeleportToRoomViaWram(), WaitForModule(), and WaitFrames().

◆ rom_

Rom* yaze::emu::render::SaveStateManager::rom_ = nullptr

private

Definition at line 107 of file save_state_manager.h.

Referenced by CalculateRomChecksum(), and Initialize().

◆ state_directory_

std::string yaze::emu::render::SaveStateManager::state_directory_

private

Definition at line 109 of file save_state_manager.h.

Referenced by GetStateDirectory(), GetStatePath(), Initialize(), SaveStateManager(), and SetStateDirectory().

◆ rom_checksum_

uint32_t yaze::emu::render::SaveStateManager::rom_checksum_ = 0

private

Definition at line 110 of file save_state_manager.h.

Referenced by GenerateRoomState(), Initialize(), and IsStateCompatible().

◆ state_cache_

std::unordered_map<CacheKey, StateMetadata, CacheKeyHash> yaze::emu::render::SaveStateManager::state_cache_

private

Definition at line 126 of file save_state_manager.h.

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

src/app/emu/render/save_state_manager.h
src/app/emu/render/save_state_manager.cc

	yaze 0.3.2 Link to the Past ROM Editor

Classes

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SaveStateManager()

◆ ~SaveStateManager()

Member Function Documentation

◆ Initialize()

◆ LoadState()

◆ GenerateRoomState()

◆ GenerateAllBaselineStates()

◆ HasCachedState()

◆ GetStateMetadata()

◆ SaveStateToFile()

◆ LoadStateFromFile()

◆ SetStateDirectory()

◆ GetStateDirectory()

◆ CalculateRomChecksum()

◆ BootToTitleScreen()

◆ NavigateToFileSelect()

◆ StartNewGame()

◆ NavigateToRoom()

◆ PressButton()

◆ ReleaseAllButtons()

◆ WaitFrames()

◆ WaitForModule()

◆ TeleportToRoomViaWram()

◆ NavigateToRoomViaTas()

◆ ReadWram()

◆ ReadWram16()

◆ GetCurrentRoom()

◆ GetGameModule()

◆ IsRoomFullyLoaded()

◆ GetStatePath()

◆ GetMetadataPath()

◆ IsStateCompatible()

Member Data Documentation

◆ snes_

◆ rom_

◆ state_directory_

◆ rom_checksum_

◆ state_cache_