Класс svcs::cli::ICommand

Интерфейс (абстрактный базовый класс) для всех команд, выполняемых через CLI. Подробнее...

#include <ICommand.hxx>

Граф наследования:svcs::cli::ICommand:

Открытые члены
virtual	~ICommand ()=default
	Виртуальный деструктор.
virtual std::string	getName () const =0
	Получает уникальное имя команды (например, "init").
virtual std::string	getDescription () const =0
	Получает краткое описание того, что делает команда.
virtual std::string	getUsage () const =0
	Получает синтаксис использования команды.
virtual bool	execute (const std::vector< std::string > &args)=0
	Выполняет основную логику команды.
virtual void	showHelp () const =0
	Отображает подробную справочную информацию о команде (использование и описание).

Подробное описание

Интерфейс (абстрактный базовый класс) для всех команд, выполняемых через CLI.

Каждая конкретная команда (например, InitCommand, CommitCommand) должна наследовать этот интерфейс и реализовывать все его чисто виртуальные методы.

Конструктор(ы)

~ICommand()

virtual svcs::cli::ICommand::~ICommand ( )

virtualdefault

Виртуальный деструктор.

Обеспечивает корректную очистку производных классов через указатель на базовый класс.

Методы

execute()

virtual bool svcs::cli::ICommand::execute ( const std::vector< std::string > & args )

pure virtual

Выполняет основную логику команды.

Аргументы

args	Вектор строковых аргументов, переданных команде (исключая само имя команды).

Возвращает

true если выполнение команды было успешным; false при ошибке.

Замещается в svcs::cli::AddCommand, svcs::cli::BranchCommand, svcs::cli::ClearCommand, svcs::cli::HelpCommand, svcs::cli::HistoryCommand, svcs::cli::InitCommand, svcs::cli::MergeCommand, svcs::cli::RemoveCommand, svcs::cli::SaveCommand, svcs::cli::StatusCommand, svcs::cli::UndoCommand, svcs::cli::VersionCommand, svcs::server::cli::HubCommand, svcs::server::cli::RepoCommand, svcs::server::cli::ServerBaseCommand, svcs::test::cli::HelpCommand, svcs::test::cli::utils::HelpCommand, svcs::test::cli::utils::HistoryCommand, svcs::test::cli::utils::InitCommand, svcs::test::cli::utils::RemoveCommand, svcs::test::cli::utils::SaveCommand, svcs::test::cli::utils::StatusCommand, svcs::test::cli::utils::UndoCommand и svcs::test::cli::utils::VersionCommand.

getDescription()

virtual std::string svcs::cli::ICommand::getDescription ( ) const

nodiscardpure virtual

Получает краткое описание того, что делает команда.

Возвращает

Описание команды.

Замещается в svcs::cli::AddCommand, svcs::cli::BaseCommand, svcs::cli::BranchCommand, svcs::cli::ClearCommand, svcs::cli::HelpCommand, svcs::cli::HistoryCommand, svcs::cli::InitCommand, svcs::cli::MergeCommand, svcs::cli::RemoveCommand, svcs::cli::SaveCommand, svcs::cli::StatusCommand, svcs::cli::UndoCommand, svcs::cli::VersionCommand, svcs::server::cli::HubCommand, svcs::server::cli::RepoCommand, svcs::server::cli::ServerBaseCommand, svcs::test::cli::HelpCommand, svcs::test::cli::utils::HelpCommand, svcs::test::cli::utils::HistoryCommand, svcs::test::cli::utils::InitCommand, svcs::test::cli::utils::RemoveCommand, svcs::test::cli::utils::SaveCommand, svcs::test::cli::utils::StatusCommand, svcs::test::cli::utils::UndoCommand и svcs::test::cli::utils::VersionCommand.

getName()

virtual std::string svcs::cli::ICommand::getName ( ) const

nodiscardpure virtual

Получает уникальное имя команды (например, "init").

Возвращает

Имя команды в виде строки.

Замещается в svcs::cli::AddCommand, svcs::cli::BaseCommand, svcs::cli::BranchCommand, svcs::cli::ClearCommand, svcs::cli::HelpCommand, svcs::cli::HistoryCommand, svcs::cli::InitCommand, svcs::cli::MergeCommand, svcs::cli::RemoveCommand, svcs::cli::SaveCommand, svcs::cli::StatusCommand, svcs::cli::UndoCommand, svcs::cli::VersionCommand, svcs::server::cli::HubCommand, svcs::server::cli::RepoCommand, svcs::server::cli::ServerBaseCommand, svcs::test::cli::HelpCommand, svcs::test::cli::utils::HelpCommand, svcs::test::cli::utils::HistoryCommand, svcs::test::cli::utils::InitCommand, svcs::test::cli::utils::RemoveCommand, svcs::test::cli::utils::SaveCommand, svcs::test::cli::utils::StatusCommand, svcs::test::cli::utils::UndoCommand и svcs::test::cli::utils::VersionCommand.

getUsage()

virtual std::string svcs::cli::ICommand::getUsage ( ) const

nodiscardpure virtual

Получает синтаксис использования команды.

Возвращает

Строка с синтаксисом (например, "vcs commit <message>").

Замещается в svcs::cli::AddCommand, svcs::cli::BaseCommand, svcs::cli::BranchCommand, svcs::cli::ClearCommand, svcs::cli::HelpCommand, svcs::cli::HistoryCommand, svcs::cli::InitCommand, svcs::cli::MergeCommand, svcs::cli::RemoveCommand, svcs::cli::SaveCommand, svcs::cli::StatusCommand, svcs::cli::UndoCommand, svcs::cli::VersionCommand, svcs::server::cli::HubCommand, svcs::server::cli::RepoCommand, svcs::server::cli::ServerBaseCommand, svcs::test::cli::HelpCommand, svcs::test::cli::utils::HelpCommand, svcs::test::cli::utils::HistoryCommand, svcs::test::cli::utils::InitCommand, svcs::test::cli::utils::RemoveCommand, svcs::test::cli::utils::SaveCommand, svcs::test::cli::utils::StatusCommand, svcs::test::cli::utils::UndoCommand и svcs::test::cli::utils::VersionCommand.

showHelp()

virtual void svcs::cli::ICommand::showHelp ( ) const

pure virtual

Отображает подробную справочную информацию о команде (использование и описание).

Замещается в svcs::cli::AddCommand, svcs::cli::BaseCommand, svcs::cli::BranchCommand, svcs::cli::ClearCommand, svcs::cli::HelpCommand, svcs::cli::HistoryCommand, svcs::cli::InitCommand, svcs::cli::MergeCommand, svcs::cli::RemoveCommand, svcs::cli::SaveCommand, svcs::cli::StatusCommand, svcs::cli::UndoCommand, svcs::cli::VersionCommand, svcs::server::cli::HubCommand, svcs::server::cli::RepoCommand, svcs::server::cli::ServerBaseCommand, svcs::test::cli::HelpCommand, svcs::test::cli::utils::HelpCommand, svcs::test::cli::utils::HistoryCommand, svcs::test::cli::utils::InitCommand, svcs::test::cli::utils::RemoveCommand, svcs::test::cli::utils::SaveCommand, svcs::test::cli::utils::StatusCommand, svcs::test::cli::utils::UndoCommand и svcs::test::cli::utils::VersionCommand.

---

Объявления и описания членов класса находятся в файле:

• cli/include/ICommand.hxx