yaze::cli::agent::tools::ProjectRestoreTool Class Reference

Restore ROM to named checkpoint. More...

#include <project_tool.h>

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

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

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::ProjectToolBase
absl::StatusOr< ProjectManager * >	GetProjectManager (AgentContext *context) const
	Get or create project manager from context.
std::string	FormatEdits (const std::vector< RomEdit > &edits) const
	Format edit list as text.
std::string	FormatSnapshot (const ProjectSnapshot &snapshot) const
	Format snapshot info 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.

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

Restore ROM to named checkpoint.

Usage: project-restore –name <name> [–format <json|text>]

Restores ROM to a previously saved snapshot. Validates ROM checksum before applying edits.

Definition at line 319 of file project_tool.h.

Member Function Documentation

GetName()

std::string yaze::cli::agent::tools::ProjectRestoreTool::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 321 of file project_tool.h.

GetDescription()

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

inline

Definition at line 323 of file project_tool.h.

GetUsage()

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

inlineoverridevirtual

Get the command usage string.

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

Definition at line 327 of file project_tool.h.

RequiresLabels()

bool yaze::cli::agent::tools::ProjectRestoreTool::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 331 of file project_tool.h.

ValidateArgs()

absl::Status yaze::cli::agent::tools::ProjectRestoreTool::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 334 of file project_tool.h.

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

Here is the call graph for this function:

Execute()

absl::Status yaze::cli::agent::tools::ProjectRestoreTool::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 764 of file project_tool.cc.

References yaze::cli::resources::OutputFormatter::AddField(), yaze::cli::resources::OutputFormatter::BeginObject(), yaze::cli::agent::tools::ProjectSnapshot::description, yaze::cli::agent::tools::ProjectSnapshot::edits, yaze::cli::resources::OutputFormatter::EndObject(), yaze::cli::agent::tools::ProjectToolBase::GetProjectManager(), yaze::cli::agent::tools::ProjectManager::GetSnapshot(), yaze::cli::resources::ArgumentParser::GetString(), yaze::Rom::is_loaded(), yaze::cli::agent::tools::ProjectManager::IsInitialized(), yaze::cli::agent::tools::ProjectSnapshot::name, yaze::zelda3::name, and yaze::cli::agent::tools::ProjectManager::RestoreSnapshot().

---

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

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