yaze::cli::handlers::MessageListCommandHandler Class Reference

Command handler for listing messages. More...

#include <message_commands.h>

Inheritance diagram for yaze::cli::handlers::MessageListCommandHandler:

Collaboration diagram for yaze::cli::handlers::MessageListCommandHandler:

Public Member Functions
std::string	GetName () const
	Get the command name.
std::string	GetDescription () const
std::string	GetUsage () const
	Get the command usage string.
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.
Public Member Functions inherited from yaze::cli::resources::CommandHandler
virtual	~CommandHandler ()=default
absl::Status	Run (const std::vector< std::string > &args, Rom *rom_context)
	Execute the command.
virtual Descriptor	Describe () const
	Provide metadata for TUI/help summaries.

Additional Inherited Members
Protected Member Functions inherited from yaze::cli::resources::CommandHandler
virtual bool	RequiresLabels () const
	Check if the command requires ROM labels.
virtual std::string	GetDefaultFormat () const
	Get the default output format ("json" or "text")
virtual std::string	GetOutputTitle () const
	Get the output title for formatting.

Detailed Description

Command handler for listing messages.

Definition at line 13 of file message_commands.h.

Member Function Documentation

GetName()

std::string yaze::cli::handlers::MessageListCommandHandler::GetName ( ) const

inlinevirtual

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 15 of file message_commands.h.

GetDescription()

std::string yaze::cli::handlers::MessageListCommandHandler::GetDescription ( ) const

inline

Definition at line 16 of file message_commands.h.

GetUsage()

std::string yaze::cli::handlers::MessageListCommandHandler::GetUsage ( ) const

inlinevirtual

Get the command usage string.

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

Definition at line 19 of file message_commands.h.

ValidateArgs()

absl::Status yaze::cli::handlers::MessageListCommandHandler::ValidateArgs ( const resources::ArgumentParser &  parser )

inlineoverridevirtual

Validate command arguments.

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

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

Definition at line 23 of file message_commands.h.

Execute()

absl::Status yaze::cli::handlers::MessageListCommandHandler::Execute ( Rom *  rom, const resources::ArgumentParser &  parser, resources::OutputFormatter &  formatter  )

overridevirtual

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 9 of file message_commands.cc.

References yaze::cli::resources::OutputFormatter::AddField(), yaze::cli::resources::OutputFormatter::BeginArray(), yaze::cli::resources::OutputFormatter::BeginObject(), yaze::cli::resources::OutputFormatter::EndArray(), yaze::cli::resources::OutputFormatter::EndObject(), and yaze::cli::resources::ArgumentParser::GetInt().

---

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

• src/cli/handlers/game/message_commands.h
• src/cli/handlers/game/message_commands.cc