#include <map_command_handler.hpp>

Classes
struct	command

Public Types
typedef void(Worker::*	command_handler) ()

typedef std::map< std::string, command >	command_map

typedef std::map< std::string, std::string >	command_alias_map

Public Member Functions
	map_command_handler ()

virtual	~map_command_handler ()

bool	empty () const

void	dispatch (std::string cmd)

std::vector< std::string >	get_commands_list () const

void	command_failed (const std::string &message, bool=false)

Protected Member Functions
void	init_map_default ()

virtual void	init_map ()=0

virtual void	print (const std::string &title, const std::string &message)=0

virtual std::string	get_flags_description () const

virtual std::string	get_command_flags_description (const command &) const

virtual bool	is_enabled (const command &) const

virtual void	parse_cmd (const std::string &cmd_string)

virtual std::string	get_arg (unsigned argn) const

virtual std::string	get_data (unsigned argn=1) const

virtual std::string	get_cmd () const

void	command_failed_need_arg (int argn)

void	print_usage ()

std::string	get_actual_cmd (const std::string &cmd) const

const command *	get_command (const std::string &cmd) const

command *	get_command (const std::string &cmd)

void	help ()

bool	help_command (const std::string &acmd)

virtual void	register_command (const std::string &cmd, command_handler h, const std::string &help="", const std::string &usage="", const std::string &flags="")

virtual void	register_alias (const std::string &to_cmd, const std::string &cmd)

Static Protected Member Functions
static void	set_help_on_unknown (bool value)

static void	set_cmd_prefix (const std::string &value)

static void	set_cmd_flag (bool value)

static const std::vector< std::string >	get_aliases (const std::string &cmd)

Protected Attributes
cmd_arg_parser	cap_

Static Private Attributes
static command_map	command_map_ {}

static command_alias_map	command_alias_map_ {}

static bool	help_on_unknown_ = true

static bool	show_unavailable_ = false

static std::string	cmd_prefix_ {}

static bool	cmd_flag_ = false

Detailed Description

template<class Worker>
class events::map_command_handler< Worker >

Definition at line 122 of file map_command_handler.hpp.

Member Typedef Documentation

◆ command_alias_map

template<class Worker >

typedef std::map<std::string, std::string> events::map_command_handler< Worker >::command_alias_map

Definition at line 148 of file map_command_handler.hpp.

◆ command_handler

template<class Worker >

typedef void(Worker::* events::map_command_handler< Worker >::command_handler) ()

Definition at line 125 of file map_command_handler.hpp.

◆ command_map

template<class Worker >

typedef std::map<std::string, command> events::map_command_handler< Worker >::command_map

Definition at line 147 of file map_command_handler.hpp.

Constructor & Destructor Documentation

◆ map_command_handler()

template<class Worker >

events::map_command_handler< Worker >::map_command_handler ( )

inline

Definition at line 150 of file map_command_handler.hpp.

◆ ~map_command_handler()

template<class Worker >

virtual events::map_command_handler< Worker >::~map_command_handler ( )

inlinevirtual

Definition at line 154 of file map_command_handler.hpp.

Member Function Documentation

◆ command_failed()

template<class Worker >

void events::map_command_handler< Worker >::command_failed	(	const std::string &	message,
		bool	= `false`
	)

inline

Definition at line 244 of file map_command_handler.hpp.

References _(), events::map_command_handler< Worker >::get_cmd(), and events::map_command_handler< Worker >::print().

Referenced by events::map_command_handler< Worker >::command_failed_need_arg().

◆ command_failed_need_arg()

template<class Worker >

void events::map_command_handler< Worker >::command_failed_need_arg ( int argn )

inlineprotected

Definition at line 298 of file map_command_handler.hpp.

References events::map_command_handler< Worker >::command_failed(), and VGETTEXT.

◆ dispatch()

template<class Worker >

void events::map_command_handler< Worker >::dispatch ( std::string cmd )

inline

Definition at line 161 of file map_command_handler.hpp.

Referenced by events::menu_handler::do_command(), events::chat_handler::do_speak(), and events::menu_handler::get_commands_list().

◆ empty()

template<class Worker >

bool events::map_command_handler< Worker >::empty ( ) const

inline

Definition at line 156 of file map_command_handler.hpp.

References events::map_command_handler< Worker >::command_map_.

Referenced by events::map_command_handler< Worker >::dispatch().

◆ get_actual_cmd()

template<class Worker >

std::string events::map_command_handler< Worker >::get_actual_cmd ( const std::string & cmd ) const

inlineprotected

Definition at line 309 of file map_command_handler.hpp.

References events::map_command_handler< Worker >::command_alias_map_, and i.

Referenced by events::map_command_handler< Worker >::dispatch(), and events::map_command_handler< Worker >::help_command().

◆ get_aliases()

template<class Worker >

static const std::vector<std::string> events::map_command_handler< Worker >::get_aliases ( const std::string & cmd )

inlinestaticprotected

Definition at line 438 of file map_command_handler.hpp.

References events::map_command_handler< Worker >::command_alias_map_, i, and p.

Referenced by events::map_command_handler< Worker >::help_command().

◆ get_arg()

template<class Worker >

virtual std::string events::map_command_handler< Worker >::get_arg ( unsigned argn ) const

inlineprotectedvirtual

Reimplemented in events::console_handler.

Definition at line 285 of file map_command_handler.hpp.

References events::map_command_handler< Worker >::cap_, and events::cmd_arg_parser::get_arg().

Referenced by events::map_command_handler< Worker >::help().

◆ get_cmd()

template<class Worker >

virtual std::string events::map_command_handler< Worker >::get_cmd ( ) const

inlineprotectedvirtual

Reimplemented in events::console_handler.

Definition at line 294 of file map_command_handler.hpp.

References events::map_command_handler< Worker >::cap_, and events::cmd_arg_parser::get_cmd().

Referenced by events::map_command_handler< Worker >::command_failed(), events::map_command_handler< Worker >::dispatch(), and events::map_command_handler< Worker >::print_usage().

◆ get_command() [1/2]

template<class Worker >

command* events::map_command_handler< Worker >::get_command ( const std::string & cmd )

inlineprotected

Definition at line 319 of file map_command_handler.hpp.

References events::map_command_handler< Worker >::command_map_, and i.

◆ get_command() [2/2]

template<class Worker >

const command* events::map_command_handler< Worker >::get_command ( const std::string & cmd ) const

inlineprotected

Definition at line 314 of file map_command_handler.hpp.

References events::map_command_handler< Worker >::command_map_, and i.

Referenced by events::map_command_handler< Worker >::dispatch(), and events::map_command_handler< Worker >::help_command().

◆ get_command_flags_description()

template<class Worker >

virtual std::string events::map_command_handler< Worker >::get_command_flags_description ( const command & ) const

inlineprotectedvirtual

Definition at line 270 of file map_command_handler.hpp.

Referenced by events::map_command_handler< Worker >::help_command().

◆ get_commands_list()

template<class Worker >

std::vector<std::string> events::map_command_handler< Worker >::get_commands_list ( ) const

inline

Definition at line 235 of file map_command_handler.hpp.

References events::map_command_handler< Worker >::command_map_, and i.

Referenced by events::menu_handler::get_commands_list().

◆ get_data()

template<class Worker >

virtual std::string events::map_command_handler< Worker >::get_data ( unsigned argn = 1 ) const

inlineprotectedvirtual

Reimplemented in events::console_handler.

Definition at line 290 of file map_command_handler.hpp.

References events::map_command_handler< Worker >::cap_, and events::cmd_arg_parser::get_data().

Referenced by events::map_command_handler< Worker >::dispatch().

◆ get_flags_description()

template<class Worker >

virtual std::string events::map_command_handler< Worker >::get_flags_description ( ) const

inlineprotectedvirtual

Reimplemented in events::console_handler, and events::chat_command_handler.

Definition at line 265 of file map_command_handler.hpp.

Referenced by events::map_command_handler< Worker >::help().

◆ help()

template<class Worker >

void events::map_command_handler< Worker >::help ( )

inlineprotected

Definition at line 324 of file map_command_handler.hpp.

◆ help_command()

template<class Worker >

bool events::map_command_handler< Worker >::help_command ( const std::string & acmd )

inlineprotected

Definition at line 359 of file map_command_handler.hpp.

References _(), _n(), c, events::map_command_handler< Worker >::cmd_flag_, events::map_command_handler< Worker >::cmd_prefix_, events::map_command_handler< Worker >::get_actual_cmd(), events::map_command_handler< Worker >::get_aliases(), events::map_command_handler< Worker >::get_command(), events::map_command_handler< Worker >::get_command_flags_description(), utils::join(), and events::map_command_handler< Worker >::print().

Referenced by events::map_command_handler< Worker >::help(), and events::map_command_handler< Worker >::print_usage().

◆ init_map()

template<class Worker >

virtual void events::map_command_handler< Worker >::init_map ( )

protectedpure virtual

Implemented in events::console_handler, and events::chat_command_handler.

Referenced by events::map_command_handler< Worker >::dispatch().

◆ init_map_default()

template<class Worker >

void events::map_command_handler< Worker >::init_map_default ( )

inlineprotected

Definition at line 249 of file map_command_handler.hpp.

References _(), and events::map_command_handler< Worker >::register_command().

Referenced by events::map_command_handler< Worker >::dispatch().

◆ is_enabled()

template<class Worker >

virtual bool events::map_command_handler< Worker >::is_enabled ( const command & ) const

inlineprotectedvirtual

Definition at line 276 of file map_command_handler.hpp.

Referenced by events::map_command_handler< Worker >::dispatch(), and events::map_command_handler< Worker >::help().

◆ parse_cmd()

template<class Worker >

virtual void events::map_command_handler< Worker >::parse_cmd ( const std::string & cmd_string )

inlineprotectedvirtual

Definition at line 280 of file map_command_handler.hpp.

References events::map_command_handler< Worker >::cap_, and events::cmd_arg_parser::parse().

Referenced by events::map_command_handler< Worker >::dispatch().

◆ print()

template<class Worker >

virtual void events::map_command_handler< Worker >::print	(	const std::string &	title,
		const std::string &	message
	)

protectedpure virtual

Implemented in events::console_handler, and events::chat_command_handler.

Referenced by events::map_command_handler< Worker >::command_failed(), events::map_command_handler< Worker >::dispatch(), events::map_command_handler< Worker >::help(), and events::map_command_handler< Worker >::help_command().

◆ print_usage()

template<class Worker >

void events::map_command_handler< Worker >::print_usage ( )

inlineprotected

Definition at line 304 of file map_command_handler.hpp.

References events::map_command_handler< Worker >::get_cmd(), and events::map_command_handler< Worker >::help_command().

◆ register_alias()

template<class Worker >

virtual void events::map_command_handler< Worker >::register_alias	(	const std::string &	to_cmd,
		const std::string &	cmd
	)

inlineprotectedvirtual

Reimplemented in events::console_handler.

Definition at line 431 of file map_command_handler.hpp.

References events::map_command_handler< Worker >::command_alias_map_.

◆ register_command()

template<class Worker >

virtual void events::map_command_handler< Worker >::register_command	(	const std::string &	cmd,
		command_handler	h,
		const std::string &	help = `""`,
		const std::string &	usage = `""`,
		const std::string &	flags = `""`
	)

inlineprotectedvirtual

Reimplemented in events::console_handler.

Definition at line 419 of file map_command_handler.hpp.

References c, events::map_command_handler< Worker >::command_map_, and h.

Referenced by events::map_command_handler< Worker >::init_map_default().

◆ set_cmd_flag()

template<class Worker >

static void events::map_command_handler< Worker >::set_cmd_flag ( bool value )

inlinestaticprotected

Definition at line 415 of file map_command_handler.hpp.

References events::map_command_handler< Worker >::cmd_flag_.

◆ set_cmd_prefix()

template<class Worker >

static void events::map_command_handler< Worker >::set_cmd_prefix ( const std::string & value )

inlinestaticprotected

Definition at line 408 of file map_command_handler.hpp.

References events::map_command_handler< Worker >::cmd_prefix_.

◆ set_help_on_unknown()

template<class Worker >

static void events::map_command_handler< Worker >::set_help_on_unknown ( bool value )

inlinestaticprotected

Definition at line 403 of file map_command_handler.hpp.

References events::map_command_handler< Worker >::help_on_unknown_.

Member Data Documentation

◆ cap_

template<class Worker >

cmd_arg_parser events::map_command_handler< Worker >::cap_

protected

Definition at line 400 of file map_command_handler.hpp.

Referenced by events::map_command_handler< Worker >::get_arg(), events::map_command_handler< Worker >::get_cmd(), events::map_command_handler< Worker >::get_data(), and events::map_command_handler< Worker >::parse_cmd().

◆ cmd_flag_

template<class Worker >

bool events::map_command_handler< Worker >::cmd_flag_ = false

inlinestaticprivate

Definition at line 455 of file map_command_handler.hpp.

Referenced by events::map_command_handler< Worker >::dispatch(), events::map_command_handler< Worker >::help(), events::map_command_handler< Worker >::help_command(), and events::map_command_handler< Worker >::set_cmd_flag().

◆ cmd_prefix_

template<class Worker >

std::string events::map_command_handler< Worker >::cmd_prefix_ {}

inlinestaticprivate

Definition at line 454 of file map_command_handler.hpp.

Referenced by events::map_command_handler< Worker >::dispatch(), events::map_command_handler< Worker >::help(), events::map_command_handler< Worker >::help_command(), and events::map_command_handler< Worker >::set_cmd_prefix().

◆ command_alias_map_

template<class Worker >

command_alias_map events::map_command_handler< Worker >::command_alias_map_ {}

inlinestaticprivate

Definition at line 451 of file map_command_handler.hpp.

Referenced by events::map_command_handler< Worker >::get_actual_cmd(), events::map_command_handler< Worker >::get_aliases(), and events::map_command_handler< Worker >::register_alias().

◆ command_map_

template<class Worker >

command_map events::map_command_handler< Worker >::command_map_ {}

inlinestaticprivate

Definition at line 450 of file map_command_handler.hpp.

Referenced by events::map_command_handler< Worker >::dispatch(), events::map_command_handler< Worker >::empty(), events::map_command_handler< Worker >::get_command(), events::map_command_handler< Worker >::get_commands_list(), events::map_command_handler< Worker >::help(), and events::map_command_handler< Worker >::register_command().

◆ help_on_unknown_

template<class Worker >

bool events::map_command_handler< Worker >::help_on_unknown_ = true

inlinestaticprivate

Definition at line 452 of file map_command_handler.hpp.

Referenced by events::map_command_handler< Worker >::dispatch(), and events::map_command_handler< Worker >::set_help_on_unknown().

◆ show_unavailable_

template<class Worker >

bool events::map_command_handler< Worker >::show_unavailable_ = false

inlinestaticprivate

Definition at line 453 of file map_command_handler.hpp.

Referenced by events::map_command_handler< Worker >::help().

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

map_command_handler.hpp

Classes

Public Types

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Private Attributes

Detailed Description

template<class Worker> class events::map_command_handler< Worker >

Member Typedef Documentation

◆ command_alias_map

◆ command_handler

◆ command_map

Constructor & Destructor Documentation

◆ map_command_handler()

◆ ~map_command_handler()

Member Function Documentation

◆ command_failed()

◆ command_failed_need_arg()

◆ dispatch()

◆ empty()

◆ get_actual_cmd()

◆ get_aliases()

◆ get_arg()

◆ get_cmd()

◆ get_command() [1/2]

◆ get_command() [2/2]

◆ get_command_flags_description()

◆ get_commands_list()

◆ get_data()

◆ get_flags_description()

◆ help()

◆ help_command()

◆ init_map()

◆ init_map_default()

◆ is_enabled()

◆ parse_cmd()

◆ print()

◆ print_usage()

◆ register_alias()

◆ register_command()

◆ set_cmd_flag()

◆ set_cmd_prefix()

◆ set_help_on_unknown()

Member Data Documentation

◆ cap_

◆ cmd_flag_

◆ cmd_prefix_

◆ command_alias_map_

◆ command_map_

◆ help_on_unknown_

◆ show_unavailable_

template<class Worker>
class events::map_command_handler< Worker >