events::map_command_handler< Worker > Class Template Reference

Inheritance diagram for events::map_command_handler< Worker >:

Inheritance graph
[legend]
Collaboration diagram for events::map_command_handler< Worker >:

Collaboration graph
[legend]

List of all members.

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
bool has_command (const std::string &cmd) const
void dispatch (std::string cmd)

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
std::string get_cmd () const
void command_failed (const std::string &message)
void command_failed_need_arg (int argn)
void print_usage ()
std::string get_actual_cmd (const std::string &cmd) const
const commandget_command (const std::string &cmd) const
commandget_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 assert_existence (const std::string &cmd)
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_show_unavailable (bool value)
static void set_cmd_prefix (std::string 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_

Classes

struct  command


Detailed Description

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

Definition at line 1919 of file menu_events.cpp.


Member Typedef Documentation

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

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

Definition at line 1944 of file menu_events.cpp.

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

Definition at line 1945 of file menu_events.cpp.


Constructor & Destructor Documentation

template<class Worker>
events::map_command_handler< Worker >::map_command_handler (  )  [inline]

Definition at line 1947 of file menu_events.cpp.

template<class Worker>
virtual events::map_command_handler< Worker >::~map_command_handler (  )  [inline, virtual]

Definition at line 1951 of file menu_events.cpp.


Member Function Documentation

template<class Worker>
bool events::map_command_handler< Worker >::empty (  )  const [inline]

template<class Worker>
bool events::map_command_handler< Worker >::has_command ( const std::string &  cmd  )  const [inline]

Definition at line 1957 of file menu_events.cpp.

template<class Worker>
void events::map_command_handler< Worker >::dispatch ( std::string  cmd  )  [inline]

Definition at line 1962 of file menu_events.cpp.

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

template<class Worker>
void events::map_command_handler< Worker >::init_map_default (  )  [inline, protected]

Definition at line 1996 of file menu_events.cpp.

template<class Worker>
virtual void events::map_command_handler< Worker >::init_map (  )  [protected, pure virtual]

template<class Worker>
virtual void events::map_command_handler< Worker >::print ( const std::string &  title,
const std::string &  message 
) [protected, pure virtual]

template<class Worker>
virtual std::string events::map_command_handler< Worker >::get_flags_description (  )  const [inline, protected, virtual]

Reimplemented in events::console_handler.

Definition at line 2008 of file menu_events.cpp.

template<class Worker>
virtual std::string events::map_command_handler< Worker >::get_command_flags_description ( const command  )  const [inline, protected, virtual]

Reimplemented in events::console_handler.

Definition at line 2013 of file menu_events.cpp.

template<class Worker>
virtual bool events::map_command_handler< Worker >::is_enabled ( const command  )  const [inline, protected, virtual]

Reimplemented in events::console_handler.

Definition at line 2019 of file menu_events.cpp.

template<class Worker>
virtual void events::map_command_handler< Worker >::parse_cmd ( const std::string &  cmd_string  )  [inline, protected, virtual]

Definition at line 2023 of file menu_events.cpp.

template<class Worker>
virtual std::string events::map_command_handler< Worker >::get_arg ( unsigned  argn  )  const [inline, protected, virtual]

template<class Worker>
virtual std::string events::map_command_handler< Worker >::get_data ( unsigned  argn = 1  )  const [inline, protected, virtual]

template<class Worker>
std::string events::map_command_handler< Worker >::get_cmd (  )  const [inline, protected]

Reimplemented in events::console_handler.

Definition at line 2037 of file menu_events.cpp.

Referenced by events::chat_command_handler::do_network_send().

template<class Worker>
void events::map_command_handler< Worker >::command_failed ( const std::string &  message  )  [inline, protected]

template<class Worker>
void events::map_command_handler< Worker >::command_failed_need_arg ( int  argn  )  [inline, protected]

template<class Worker>
void events::map_command_handler< Worker >::print_usage (  )  [inline, protected]

Definition at line 2050 of file menu_events.cpp.

template<class Worker>
std::string events::map_command_handler< Worker >::get_actual_cmd ( const std::string &  cmd  )  const [inline, protected]

Definition at line 2055 of file menu_events.cpp.

template<class Worker>
const command* events::map_command_handler< Worker >::get_command ( const std::string &  cmd  )  const [inline, protected]

Definition at line 2060 of file menu_events.cpp.

template<class Worker>
command* events::map_command_handler< Worker >::get_command ( const std::string &  cmd  )  [inline, protected]

Definition at line 2065 of file menu_events.cpp.

template<class Worker>
void events::map_command_handler< Worker >::help (  )  [inline, protected]

Definition at line 2070 of file menu_events.cpp.

template<class Worker>
bool events::map_command_handler< Worker >::help_command ( const std::string &  acmd  )  [inline, protected]

Definition at line 2096 of file menu_events.cpp.

template<class Worker>
static void events::map_command_handler< Worker >::set_help_on_unknown ( bool  value  )  [inline, static, protected]

Definition at line 2123 of file menu_events.cpp.

template<class Worker>
static void events::map_command_handler< Worker >::set_show_unavailable ( bool  value  )  [inline, static, protected]

Definition at line 2128 of file menu_events.cpp.

template<class Worker>
static void events::map_command_handler< Worker >::set_cmd_prefix ( std::string  value  )  [inline, static, protected]

Definition at line 2133 of file menu_events.cpp.

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 = "" 
) [inline, protected, virtual]

Definition at line 2137 of file menu_events.cpp.

template<class Worker>
virtual void events::map_command_handler< Worker >::assert_existence ( const std::string &  cmd  )  [inline, protected, virtual]

Reimplemented in events::console_handler.

Definition at line 2148 of file menu_events.cpp.

template<class Worker>
virtual void events::map_command_handler< Worker >::register_alias ( const std::string &  to_cmd,
const std::string &  cmd 
) [inline, protected, virtual]

Reimplemented in events::console_handler.

Definition at line 2151 of file menu_events.cpp.

template<class Worker>
static const std::vector<std::string> events::map_command_handler< Worker >::get_aliases ( const std::string &  cmd  )  [inline, static, protected]

Definition at line 2160 of file menu_events.cpp.


Member Data Documentation

template<class Worker>
cmd_arg_parser events::map_command_handler< Worker >::cap_ [protected]

Definition at line 2120 of file menu_events.cpp.

template<class Worker>
map_command_handler< Worker >::command_map events::map_command_handler< Worker >::command_map_ [inline, static, private]

Definition at line 2172 of file menu_events.cpp.

template<class Worker>
map_command_handler< Worker >::command_alias_map events::map_command_handler< Worker >::command_alias_map_ [inline, static, private]

Definition at line 2173 of file menu_events.cpp.

template<class Worker>
bool events::map_command_handler< Worker >::help_on_unknown_ = true [inline, static, private]

Definition at line 2174 of file menu_events.cpp.

template<class Worker>
bool events::map_command_handler< Worker >::show_unavailable_ = false [inline, static, private]

Definition at line 2175 of file menu_events.cpp.

template<class Worker>
std::string events::map_command_handler< Worker >::cmd_prefix_ [inline, static, private]

Definition at line 2176 of file menu_events.cpp.


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

Generated by doxygen 1.5.5 on 23 May 2008 for The Battle for Wesnoth
Gna! | Forum | Wiki | CIA | devdocs