epee::command_handler Class Reference

#include <console_handler.h>

Inheritance diagram for epee::command_handler:

Public Types
typedef boost::function< bool(const std::vector< std::string > &)>	callback
typedef std::map< std::string, std::pair< callback, std::pair< std::string, std::string > > >	lookup

Public Member Functions
std::string	get_usage ()
std::pair< std::string, std::string >	get_documentation (const std::vector< std::string > &cmd)
void	set_handler (const std::string &cmd, const callback &hndlr, const std::string &usage="", const std::string &description="")
bool	process_command_vec (const std::vector< std::string > &cmd)
bool	process_command_str (const std::string &cmd)

Detailed Description

Definition at line 482 of file console_handler.h.

Member Typedef Documentation

callback

typedef boost::function<bool (const std::vector<std::string> &)> epee::command_handler::callback

Definition at line 484 of file console_handler.h.

lookup

typedef std::map<std::string, std::pair<callback, std::pair<std::string, std::string> > > epee::command_handler::lookup

Definition at line 485 of file console_handler.h.

Member Function Documentation

get_documentation()

std::pair< std::string, std::string > epee::command_handler::get_documentation ( const std::vector< std::string > & cmd )

inline

Definition at line 498 of file console_handler.h.

    {
      if(cmd.empty())
        return std::make_pair("", "");
      auto it = m_command_handlers.find(cmd.front());
      if(it == m_command_handlers.end())
        return std::make_pair("", "");
      return it->second.second;
    }

get_usage()

std::string epee::command_handler::get_usage ( )

inline

Definition at line 487 of file console_handler.h.

    {
      std::stringstream ss;
 
      for(auto& x:m_command_handlers)
      {
        ss << x.second.second.first << ENDL;
      }
      return ss.str();
    }

process_command_str()

bool epee::command_handler::process_command_str ( const std::string & cmd )

inline

Definition at line 530 of file console_handler.h.

    {
      std::vector<std::string> cmd_v;
      boost::split(cmd_v,cmd,boost::is_any_of(" "), boost::token_compress_on);
      return process_command_vec(cmd_v);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

process_command_vec()

bool epee::command_handler::process_command_vec ( const std::vector< std::string > & cmd )

inline

Definition at line 519 of file console_handler.h.

    {
      if(!cmd.size())
        return false;
      auto it = m_command_handlers.find(cmd.front());
      if(it == m_command_handlers.end())
        return false;
      std::vector<std::string> cmd_local(cmd.begin()+1, cmd.end());
      return it->second.first(cmd_local);
    }

Here is the caller graph for this function:

set_handler()

void epee::command_handler::set_handler ( const std::string & cmd, const callback & hndlr, const std::string & usage = "", const std::string & description = "" )

inline

Definition at line 508 of file console_handler.h.

    {
      lookup::mapped_type & vt = m_command_handlers[cmd];
      vt.first = hndlr;
      vt.second.first = description.empty() ? cmd : usage;
      vt.second.second = description.empty() ? usage : description;
#ifdef HAVE_READLINE
      rdln::readline_buffer::add_completion(cmd);
#endif
    }

Here is the call graph for this function:

---

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

• /home/abuild/rpmbuild/BUILD/electroneum-5.1.3.1-build/electroneum-5.1.3.1/contrib/epee/include/console_handler.h