Help_m Class Reference

Private 'help' module. More...

#include <jdb_core_i.h>

Inheritance diagram for Help_m:

List of all members.

Public Member Functions
Jdb_module::Action_code	action (int, void *&, char const *&, int &)
	The actual handler of the module.
int const	num_cmds () const
	The number of commands this modules provides.
Jdb_module::Cmd const *const	cmds () const
	The commands this module provides.
	Help_m ()

---

Detailed Description

Private 'help' module.

This module handles the 'help' or 'h' command and prints out a help screen.

---

Constructor & Destructor Documentation

Help_m::Help_m (   )

---

Member Function Documentation

Jdb_module::Action_code Help_m::action (  int  , void *&  , char const *&  , int &  )  [virtual]

The actual handler of the module. Parameters: cmd  the command ID (see Cmd::id) of the executed command. args  a reference to the argument buffer pointer. fmt  a reference to the format string pointer. This method is pure virtual and must be provided by the specific derivate of the Jdb_module. action() is called if one of the module's commands was issued and the input according to the format string is read. The args and fmt arguments are references because they may be modified by the action() method and extra input may be requested by returning Action_code::EXTRA_INPUT. In the case where Action_code::EXTRA_INPUT is returned the Jdb_core reads again the values according to the given format (fmt) and enters action(). With this mechanism it is possible to request further input depending on the already given input. Implements Jdb_module.

Jdb_module::Cmd const *const Help_m::cmds (   )  const [virtual]

The commands this module provides. An array of Cmd structures must be returned, where each entry describes a single command. The command IDs (see Cmd::id) should be unique within the module, so that action() can distinguish between the different commands. See also: num_cmds() Cmd action() Implements Jdb_module.

int const Help_m::num_cmds (   )  const [virtual]

The number of commands this modules provides. This method must return how many Cmd structures can be found in the array returned by cmds(). See also: cmds() Implements Jdb_module.

---

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

• jdb_core_i.h
• jdb_core.cc

---