Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

home » brain » inspircd-cvs » inspircd » include

ctables.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	Command
	A structure that defines a command. More...
Defines
#define	CMD_LOCALONLY   CMD_FAILURE
	For commands which should not be replicated to other servers, we usually return CMD_FAILURE.
#define	TRANSLATE1(x1)   translation.push_back(x1);
	Shortcut macros for defining translation lists.
#define	TRANSLATE2(x1, x2)   translation.push_back(x1);translation.push_back(x2);
#define	TRANSLATE3(x1, x2, x3)   translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);
#define	TRANSLATE4(x1, x2, x3, x4)   translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);
#define	TRANSLATE5(x1, x2, x3, x4, x5)
#define	TRANSLATE6(x1, x2, x3, x4, x5, x6)
#define	TRANSLATE7(x1, x2, x3, x4, x5, x6, x7)
#define	TRANSLATE8(x1, x2, x3, x4, x5, x6, x7, x8)
Typedefs
typedef nspace::hash_map< std::string, Command * >	Commandtable
	A hash of commands used by the core.
Enumerations
enum	CmdResult { CMD_FAILURE = 0, CMD_SUCCESS = 1, CMD_INVALID = 2 }
	Used to indicate command success codes. More...
enum	TranslateType {   TR_END, TR_TEXT, TR_NICK, TR_NICKLIST,   TR_SPACENICKLIST, TR_CUSTOM }
	Translation types for translation of parameters to UIDs. More...

---

Define Documentation

#define CMD_LOCALONLY   CMD_FAILURE

For commands which should not be replicated to other servers, we usually return CMD_FAILURE. this isnt readable, so we define this alias for CMD_FAILURE called CMD_LOCALONLY, which of course does the same thing but is much more readable. Definition at line 47 of file ctables.h. Referenced by cmd_rsquit::Handle(), CommandVhost::Handle(), CommandUserip::Handle(), CommandTline::Handle(), CommandTaxonomy::Handle(), CommandSwhois::Handle(), CommandSilence::Handle(), CommandSetidle::Handle(), CommandSethost::Handle(), CommandSATopic::Handle(), CommandSaquit::Handle(), CommandSamode::Handle(), CommandRandquote::Handle(), CommandUnlockserv::Handle(), CommandLockserv::Handle(), CommandJumpserver::Handle(), CommandCycle::Handle(), CommandTitle::Handle(), CommandClose::Handle(), CommandClones::Handle(), CommandChgname::Handle(), CommandChghost::Handle(), CommandCheck::Handle(), CommandWebirc::Handle(), CommandAccept::Handle(), and ShowOperMOTD().

#define TRANSLATE1 (  x1   )     translation.push_back(x1);

Shortcut macros for defining translation lists. Definition at line 208 of file ctables.h.

#define TRANSLATE2 (  x1, x2   )     translation.push_back(x1);translation.push_back(x2);

Definition at line 209 of file ctables.h. Referenced by CommandAccept::CommandAccept(), CommandDevoice::CommandDevoice(), CommandGlobops::CommandGlobops(), CommandSethost::CommandSethost(), CommandSetident::CommandSetident(), CommandSetidle::CommandSetidle(), CommandSetname::CommandSetname(), and CommandWatch::CommandWatch().

#define TRANSLATE3 (  x1, x2, x3   )     translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);

Definition at line 210 of file ctables.h. Referenced by CommandChghost::CommandChghost(), CommandChgident::CommandChgident(), CommandChgname::CommandChgname(), CommandCycle::CommandCycle(), CommandGloadmodule::CommandGloadmodule(), CommandKnock::CommandKnock(), CommandNicklock::CommandNicklock(), CommandSajoin::CommandSajoin(), CommandSanick::CommandSanick(), CommandSaquit::CommandSaquit(), CommandSilence::CommandSilence(), CommandSVSSilence::CommandSVSSilence(), CommandSVSWatch::CommandSVSWatch(), CommandSwhois::CommandSwhois(), CommandTitle::CommandTitle(), and CommandUninvite::CommandUninvite().

#define TRANSLATE4 (  x1, x2, x3, x4   )     translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);

Definition at line 211 of file ctables.h. Referenced by CommandCBan::CommandCBan(), CommandRemove::CommandRemove(), CommandSapart::CommandSapart(), CommandSvshold::CommandSvshold(), and CommandTban::CommandTban().

#define TRANSLATE5 (  x1, x2, x3, x4, x5   )

Value: translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);\ translation.push_back(x5); Definition at line 212 of file ctables.h.

#define TRANSLATE6 (  x1, x2, x3, x4, x5, x6   )

Value: translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);\ translation.push_back(x5);translation.push_back(x6); Definition at line 214 of file ctables.h.

#define TRANSLATE7 (  x1, x2, x3, x4, x5, x6, x7   )

Value: translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);\ translation.push_back(x5);translation.push_back(x6);translation.push_back(x7); Definition at line 216 of file ctables.h.

#define TRANSLATE8 (  x1, x2, x3, x4, x5, x6, x7, x8   )

Value: translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);\ translation.push_back(x5);translation.push_back(x6);translation.push_back(x7);translation.push_back(x8); Definition at line 218 of file ctables.h.

---

Typedef Documentation

typedef nspace::hash_map<std::string,Command*> Commandtable

A hash of commands used by the core. Definition at line 204 of file ctables.h.

---

Enumeration Type Documentation

enum CmdResult

Used to indicate command success codes. Enumerator: CMD_FAILURE  CMD_SUCCESS  CMD_INVALID  Definition at line 19 of file ctables.h.

enum TranslateType

Translation types for translation of parameters to UIDs. This allows the core commands to not have to be aware of how UIDs work (making it still possible to write other linking modules which do not use UID (but why would you want to?) Enumerator: TR_END  TR_TEXT  TR_NICK  TR_NICKLIST  TR_SPACENICKLIST  TR_CUSTOM  Definition at line 31 of file ctables.h.