Public Member Functions | Data Fields | Protected Member Functions | Private Attributes

Command Class Reference

#include <commands.h>

Inherits Service.

Inherited by CommandBSAct, CommandBSAssign, CommandBSBadwords, CommandBSBot, CommandBSBotList, CommandBSInfo, CommandBSKick, CommandBSSay, CommandBSSet, CommandBSSetDontKickOps, CommandBSSetDontKickVoices, CommandBSSetFantasy, CommandBSSetGreet, CommandBSSetNoBot, CommandBSSetPrivate, CommandBSUnassign, CommandCSAccess, CommandCSAKick, CommandCSBan, CommandCSClone, CommandCSDown, CommandCSDrop, CommandCSEnforce, CommandCSFlags, CommandCSGetKey, CommandCSGStats, CommandCSGTop, CommandCSGTop10, CommandCSInfo, CommandCSInvite, CommandCSKick, CommandCSLevels, CommandCSList, CommandCSLog, CommandCSMode, CommandCSRegister, CommandCSSASet, CommandCSSASetNoexpire, CommandCSSet, CommandCSSetAutoOp, CommandCSSetBanType, CommandCSSetChanstats, CommandCSSetDescription, CommandCSSetFounder, CommandCSSetKeepTopic, CommandCSSetMisc, CommandCSSetPeace, CommandCSSetPersist, CommandCSSetPrivate, CommandCSSetRestricted, CommandCSSetSecure, CommandCSSetSecureFounder, CommandCSSetSecureOps, CommandCSSetSignKick, CommandCSSetSuccessor, CommandCSStats, CommandCSStatus, CommandCSSuspend, CommandCSSync, CommandCSTop, CommandCSTop10, CommandCSTopic, CommandCSUnban, CommandCSUnSuspend, CommandCSUp, CommandEntryMessage, CommandGLGlobal, CommandHelp, CommandHSActivate, CommandHSDel, CommandHSDelAll, CommandHSGroup, CommandHSList, CommandHSOff, CommandHSOn, CommandHSReject, CommandHSRequest, CommandHSSet, CommandHSSetAll, CommandHSWaiting, CommandMSCancel, CommandMSCheck, CommandMSDel, CommandMSIgnore, CommandMSInfo, CommandMSList, CommandMSRead, CommandMSRSend, CommandMSSend, CommandMSSendAll, CommandMSSet, CommandMSStaff, CommandNSAccess, CommandNSAJoin, CommandNSAList, CommandNSCert, CommandNSConfirm, CommandNSDrop, CommandNSGetEMail, CommandNSGetPass, CommandNSGList, CommandNSGroup, CommandNSIdentify, CommandNSInfo, CommandNSList, CommandNSLogout, CommandNSRecover, CommandNSRegister, CommandNSResend, CommandNSResetPass, CommandNSSASet, CommandNSSASetNoexpire, CommandNSSASetPassword, CommandNSSet, CommandNSSetAutoOp, CommandNSSetChanstats, CommandNSSetDisplay, CommandNSSetEmail, CommandNSSetGreet, CommandNSSetHide, CommandNSSetKill, CommandNSSetLanguage, CommandNSSetMessage, CommandNSSetMisc, CommandNSSetPassword, CommandNSSetPrivate, CommandNSSetSecure, CommandNSStatus, CommandNSSuspend, CommandNSUngroup, CommandNSUnSuspend, CommandNSUpdate, CommandOSAKill, CommandOSChanKill, CommandOSChanList, CommandOSConfig, CommandOSDefcon, CommandOSDNS, CommandOSException, CommandOSForbid, CommandOSIgnore, CommandOSJupe, CommandOSKick, CommandOSKill, CommandOSLogin, CommandOSLogout, CommandOSLogSearch, CommandOSMode, CommandOSModInfo, CommandOSModList, CommandOSModLoad, CommandOSModReLoad, CommandOSModUnLoad, CommandOSNOOP, CommandOSOLine, CommandOSOper, CommandOSQuit, CommandOSReload, CommandOSRestart, CommandOSSeen, CommandOSSession, CommandOSSet, CommandOSShutdown, CommandOSStats, CommandOSSVSJoin, CommandOSSVSNick, CommandOSSVSPart, CommandOSSXLineBase, CommandOSUMode, CommandOSUpdate, CommandOSUserList, CommandSeen, NewsBase, RewriteCommand, and XOPBase.

Collaboration diagram for Command:
Collaboration graph
[legend]

Public Member Functions

virtual ~Command ()
bool AllowUnregistered () const
bool RequireUser () const
const Anope::stringGetDesc () const
virtual void Execute (CommandSource &source, const std::vector< Anope::string > &params)=0
virtual void OnServHelp (CommandSource &source)
virtual bool OnHelp (CommandSource &source, const Anope::string &subcommand)
virtual void OnSyntaxError (CommandSource &source, const Anope::string &subcommand)

Data Fields

size_t max_params
size_t min_params
Modulemodule

Protected Member Functions

 Command (Module *owner, const Anope::string &sname, size_t min_params, size_t max_params=0)
void SetDesc (const Anope::string &d)
void ClearSyntax ()
void SetSyntax (const Anope::string &s)
void SendSyntax (CommandSource &)
void SendSyntax (CommandSource &, const Anope::string &syntax)
void AllowUnregistered (bool b)
void RequireUser (bool b)

Private Attributes

Anope::string desc
std::vector< Anope::stringsyntax
bool allow_unregistered
bool require_user

Detailed Description

Every services command is a class, inheriting from Command.

Definition at line 92 of file commands.h.


Constructor & Destructor Documentation

Command::Command ( Module owner,
const Anope::string sname,
size_t  min_params,
size_t  max_params = 0 
) [protected]

Create a new command.

Parameters:
owner The owner of the command
sname The command name
min_params The minimum number of parameters the parser will require to execute this command
max_params The maximum number of parameters the parser will create, after max_params, all will be combined into the last argument. NOTE: If max_params is not set (default), there is no limit to the max number of params.

Definition at line 121 of file command.cpp.

References allow_unregistered, and require_user.

Command::~Command (  )  [virtual]

Definition at line 126 of file command.cpp.


Member Function Documentation

void Command::AllowUnregistered ( bool  b  )  [protected]

Definition at line 166 of file command.cpp.

References allow_unregistered.

bool Command::AllowUnregistered (  )  const
void Command::ClearSyntax (  )  [protected]
virtual void Command::Execute ( CommandSource source,
const std::vector< Anope::string > &  params 
) [pure virtual]

Execute this command.

Parameters:
source The source
params Command parameters

Implemented in CommandBSAssign, CommandBSUnassign, CommandBSBadwords, CommandBSBot, CommandBSBotList, CommandBSSay, CommandBSAct, CommandBSInfo, CommandBSKick, CommandBSSet, CommandBSSetDontKickOps, CommandBSSetDontKickVoices, CommandBSSetFantasy, CommandBSSetGreet, CommandBSSetNoBot, CommandBSSetPrivate, CommandCSAccess, CommandCSLevels, CommandCSAKick, CommandCSBan, CommandCSClone, CommandCSDrop, CommandCSEnforce, CommandEntryMessage, CommandCSStats, CommandCSGStats, CommandCSTop, CommandCSTop10, CommandCSGTop, CommandCSGTop10, CommandCSFlags, CommandCSGetKey, CommandCSInfo, CommandCSInvite, CommandCSKick, CommandCSList, CommandCSLog, CommandCSMode, CommandCSRegister, CommandOSSeen, CommandSeen, CommandCSSet, CommandCSSASet, CommandCSSetAutoOp, CommandCSSetBanType, CommandCSSetChanstats, CommandCSSetDescription, CommandCSSetFounder, CommandCSSetKeepTopic, CommandCSSetPeace, CommandCSSetPersist, CommandCSSetPrivate, CommandCSSetRestricted, CommandCSSetSecure, CommandCSSetSecureFounder, CommandCSSetSecureOps, CommandCSSetSignKick, CommandCSSetSuccessor, CommandCSSASetNoexpire, CommandCSSetMisc, CommandCSStatus, CommandCSSuspend, CommandCSUnSuspend, CommandCSSync, CommandCSTopic, CommandCSUnban, CommandCSUp, CommandCSDown, XOPBase, CommandCSQOP, CommandCSAOP, CommandCSHOP, CommandCSSOP, CommandCSVOP, CommandGLGlobal, CommandHelp, CommandHSDel, CommandHSDelAll, CommandHSGroup, CommandHSList, CommandHSOff, CommandHSOn, CommandHSRequest, CommandHSActivate, CommandHSReject, CommandHSWaiting, CommandHSSet, CommandHSSetAll, CommandMSCancel, CommandMSCheck, CommandMSDel, CommandMSIgnore, CommandMSInfo, CommandMSList, CommandMSRead, CommandMSRSend, CommandMSSend, CommandMSSendAll, CommandMSSet, CommandMSStaff, CommandNSAccess, CommandNSAJoin, CommandNSAList, CommandNSCert, CommandNSDrop, CommandNSGetEMail, CommandNSGetPass, CommandNSGroup, CommandNSUngroup, CommandNSGList, CommandNSIdentify, CommandNSInfo, CommandNSList, CommandNSLogout, CommandNSRecover, CommandNSConfirm, CommandNSRegister, CommandNSResend, CommandNSResetPass, CommandNSSet, CommandNSSASet, CommandNSSetPassword, CommandNSSASetPassword, CommandNSSetAutoOp, CommandNSSASetAutoOp, CommandNSSetChanstats, CommandNSSASetChanstats, CommandNSSetDisplay, CommandNSSASetDisplay, CommandNSSetEmail, CommandNSSASetEmail, CommandNSSetGreet, CommandNSSASetGreet, CommandNSSetHide, CommandNSSASetHide, CommandNSSetKill, CommandNSSASetKill, CommandNSSetLanguage, CommandNSSASetLanguage, CommandNSSetMessage, CommandNSSASetMessage, CommandNSSetPrivate, CommandNSSASetPrivate, CommandNSSetSecure, CommandNSSASetSecure, CommandNSSASetNoexpire, CommandNSSetMisc, CommandNSSASetMisc, CommandNSStatus, CommandNSSuspend, CommandNSUnSuspend, CommandNSUpdate, CommandOSAKill, CommandOSChanKill, CommandOSConfig, CommandOSDefcon, CommandOSDNS, CommandOSForbid, CommandOSIgnore, CommandOSJupe, CommandOSKick, CommandOSKill, CommandOSChanList, CommandOSUserList, CommandOSLogin, CommandOSLogout, CommandOSLogSearch, CommandOSMode, CommandOSUMode, CommandOSModInfo, CommandOSModList, CommandOSModLoad, CommandOSModReLoad, CommandOSModUnLoad, NewsBase, CommandOSLogonNews, CommandOSOperNews, CommandOSRandomNews, CommandOSNOOP, CommandOSOLine, CommandOSOper, CommandOSReload, CommandOSSession, CommandOSException, CommandOSSet, CommandOSQuit, CommandOSRestart, CommandOSShutdown, CommandOSStats, CommandOSSVSNick, CommandOSSVSJoin, CommandOSSVSPart, CommandOSSXLineBase, CommandOSUpdate, and RewriteCommand.

const Anope::string & Command::GetDesc (  )  const

Get the command description

Returns:
The commands description

Definition at line 181 of file command.cpp.

References desc.

bool Command::OnHelp ( CommandSource source,
const Anope::string subcommand 
) [virtual]

Requested when the user is requesting help on this command. Help on this command should be sent to the user.

Parameters:
source The source
subcommand The subcommand the user is requesting help on, or an empty string. (e.g. /ns help set foo bar lol gives a subcommand of "FOO BAR LOL")
Returns:
true if help was provided to the user, false otherwise.

Reimplemented in CommandBSAssign, CommandBSUnassign, CommandBSBadwords, CommandBSBot, CommandBSBotList, CommandBSSay, CommandBSAct, CommandBSInfo, CommandBSKick, CommandBSSet, CommandBSSetDontKickOps, CommandBSSetDontKickVoices, CommandBSSetFantasy, CommandBSSetGreet, CommandBSSetNoBot, CommandBSSetPrivate, CommandCSAccess, CommandCSLevels, CommandCSAKick, CommandCSBan, CommandCSClone, CommandCSDrop, CommandCSEnforce, CommandEntryMessage, CommandCSFlags, CommandCSGetKey, CommandCSInfo, CommandCSInvite, CommandCSKick, CommandCSList, CommandCSLog, CommandCSMode, CommandCSRegister, CommandOSSeen, CommandSeen, CommandCSSet, CommandCSSASet, CommandCSSetAutoOp, CommandCSSetBanType, CommandCSSetChanstats, CommandCSSetDescription, CommandCSSetFounder, CommandCSSetKeepTopic, CommandCSSetPeace, CommandCSSetPersist, CommandCSSetPrivate, CommandCSSetRestricted, CommandCSSetSecure, CommandCSSetSecureFounder, CommandCSSetSecureOps, CommandCSSetSignKick, CommandCSSetSuccessor, CommandCSSASetNoexpire, CommandCSSetMisc, CommandCSStatus, CommandCSSuspend, CommandCSUnSuspend, CommandCSSync, CommandCSTopic, CommandCSUnban, CommandCSUp, CommandCSDown, XOPBase, CommandCSQOP, CommandCSAOP, CommandCSHOP, CommandCSSOP, CommandCSVOP, CommandGLGlobal, CommandHSDel, CommandHSDelAll, CommandHSGroup, CommandHSList, CommandHSOff, CommandHSOn, CommandHSRequest, CommandHSActivate, CommandHSReject, CommandHSWaiting, CommandHSSet, CommandHSSetAll, CommandMSCancel, CommandMSCheck, CommandMSDel, CommandMSIgnore, CommandMSInfo, CommandMSList, CommandMSRead, CommandMSRSend, CommandMSSend, CommandMSSendAll, CommandMSSet, CommandMSStaff, CommandNSAccess, CommandNSAJoin, CommandNSAList, CommandNSCert, CommandNSDrop, CommandNSGetEMail, CommandNSGetPass, CommandNSGroup, CommandNSUngroup, CommandNSGList, CommandNSIdentify, CommandNSInfo, CommandNSList, CommandNSLogout, CommandNSRecover, CommandNSConfirm, CommandNSRegister, CommandNSResend, CommandNSResetPass, CommandNSSet, CommandNSSASet, CommandNSSetPassword, CommandNSSASetPassword, CommandNSSetAutoOp, CommandNSSASetAutoOp, CommandNSSetChanstats, CommandNSSASetChanstats, CommandNSSetDisplay, CommandNSSASetDisplay, CommandNSSetEmail, CommandNSSASetEmail, CommandNSSetGreet, CommandNSSASetGreet, CommandNSSetHide, CommandNSSASetHide, CommandNSSetKill, CommandNSSASetKill, CommandNSSetLanguage, CommandNSSASetLanguage, CommandNSSetMessage, CommandNSSASetMessage, CommandNSSetPrivate, CommandNSSASetPrivate, CommandNSSetSecure, CommandNSSASetSecure, CommandNSSASetNoexpire, CommandNSSetMisc, CommandNSStatus, CommandNSSuspend, CommandNSUnSuspend, CommandNSUpdate, CommandOSAKill, CommandOSChanKill, CommandOSConfig, CommandOSDefcon, CommandOSDNS, CommandOSForbid, CommandOSIgnore, CommandOSJupe, CommandOSKick, CommandOSKill, CommandOSChanList, CommandOSUserList, CommandOSLogin, CommandOSLogout, CommandOSLogSearch, CommandOSMode, CommandOSUMode, CommandOSModInfo, CommandOSModList, CommandOSModLoad, CommandOSModReLoad, CommandOSModUnLoad, NewsBase, CommandOSLogonNews, CommandOSOperNews, CommandOSRandomNews, CommandOSNOOP, CommandOSOLine, CommandOSOper, CommandOSReload, CommandOSSession, CommandOSException, CommandOSSet, CommandOSQuit, CommandOSRestart, CommandOSShutdown, CommandOSStats, CommandOSSVSNick, CommandOSSVSJoin, CommandOSSVSPart, CommandOSSXLineBase, CommandOSSNLine, CommandOSSQLine, CommandOSUpdate, and RewriteCommand.

Definition at line 191 of file command.cpp.

void Command::OnServHelp ( CommandSource source  )  [virtual]

Called when HELP is requsted for the client this command is on.

Parameters:
source The source

Reimplemented in CommandCSSetMisc, CommandNSResend, CommandNSSetMessage, CommandNSSetMisc, and RewriteCommand.

Definition at line 186 of file command.cpp.

References Anope::string::c_str(), CommandSource::command, CommandSource::nc, CommandSource::Reply(), and Language::Translate().

Referenced by CommandNSResend::OnServHelp().

void Command::OnSyntaxError ( CommandSource source,
const Anope::string subcommand 
) [virtual]

Requested when the user provides bad syntax to this command (not enough params, etc).

Parameters:
source The source
subcommand The subcommand the user tried to use

Reimplemented in CommandNSConfirm.

Definition at line 193 of file command.cpp.

References Anope::string::c_str(), CommandSource::command, Config, MORE_INFO, CommandSource::Reply(), SendSyntax(), CommandSource::service, and ServerConfig::UseStrictPrivMsgString.

Referenced by CommandOSException::DoAdd(), NewsBase::DoAdd(), CommandOSIgnore::DoAdd(), CommandOSAKill::DoAdd(), CommandNSCert::DoAdd(), CommandNSAccess::DoAdd(), XOPBase::DoAdd(), CommandBSBot::DoChange(), CommandOSException::DoDel(), NewsBase::DoDel(), CommandOSIgnore::DoDel(), CommandOSAKill::DoDel(), CommandNSCert::DoDel(), CommandNSAccess::DoDel(), XOPBase::DoDel(), CommandBSBot::DoDel(), CommandMSSet::DoLimit(), CommandCSMode::DoLock(), CommandCSFlags::DoModify(), CommandOSException::DoMove(), NewsBase::DoNews(), CommandMSSet::DoNotify(), CommandCSLevels::DoSet(), CommandOSSet::DoSetDebug(), CommandOSSet::DoSetNoExpire(), CommandOSSet::DoSetReadOnly(), CommandOSSet::DoSetSuperAdmin(), XOPBase::DoXop(), CommandOSSXLineBase::Execute(), CommandOSSet::Execute(), CommandOSException::Execute(), CommandOSSession::Execute(), CommandOSOper::Execute(), CommandOSOLine::Execute(), CommandOSNOOP::Execute(), CommandOSLogSearch::Execute(), CommandOSIgnore::Execute(), CommandOSForbid::Execute(), CommandOSDNS::Execute(), CommandOSDefcon::Execute(), CommandOSConfig::Execute(), CommandOSChanKill::Execute(), CommandOSAKill::Execute(), CommandNSSASetNoexpire::Execute(), CommandNSSASet::Execute(), CommandNSSet::Execute(), CommandNSRegister::Execute(), CommandNSLogout::Execute(), CommandNSCert::Execute(), CommandNSAJoin::Execute(), CommandNSAccess::Execute(), CommandMSSet::Execute(), CommandMSRead::Execute(), CommandMSList::Execute(), CommandMSIgnore::Execute(), CommandMSDel::Execute(), CommandHSSetAll::Execute(), CommandHSSet::Execute(), CommandHSRequest::Execute(), CommandCSSuspend::Execute(), CommandCSSASetNoexpire::Execute(), CommandCSSetSignKick::Execute(), CommandCSSetSecureOps::Execute(), CommandCSSetSecureFounder::Execute(), CommandCSSetSecure::Execute(), CommandCSSetRestricted::Execute(), CommandCSSetPrivate::Execute(), CommandCSSetPersist::Execute(), CommandCSSetPeace::Execute(), CommandCSSetKeepTopic::Execute(), CommandCSSetChanstats::Execute(), CommandCSSetAutoOp::Execute(), CommandCSSASet::Execute(), CommandCSSet::Execute(), CommandOSSeen::Execute(), CommandCSMode::Execute(), CommandCSLog::Execute(), CommandCSFlags::Execute(), CommandEntryMessage::Execute(), CommandCSEnforce::Execute(), CommandCSClone::Execute(), CommandCSAKick::Execute(), CommandCSLevels::Execute(), CommandCSAccess::Execute(), CommandBSSetPrivate::Execute(), CommandBSSetNoBot::Execute(), CommandBSSetGreet::Execute(), CommandBSSetFantasy::Execute(), CommandBSSetDontKickVoices::Execute(), CommandBSSetDontKickOps::Execute(), CommandBSSet::Execute(), CommandBSKick::Execute(), CommandBSSay::Execute(), CommandBSBot::Execute(), CommandBSBadwords::Execute(), CommandOSSQLine::OnAdd(), CommandOSSNLine::OnAdd(), CommandOSSXLineBase::OnDel(), CommandNSSetSecure::Run(), CommandNSSetPrivate::Run(), CommandNSSetMessage::Run(), CommandNSSetLanguage::Run(), CommandNSSetKill::Run(), CommandNSSetHide::Run(), CommandNSSetChanstats::Run(), and CommandNSSetAutoOp::Run().

bool Command::RequireUser (  )  const
void Command::RequireUser ( bool  b  )  [protected]

Definition at line 176 of file command.cpp.

References require_user.

void Command::SendSyntax ( CommandSource source  )  [protected]

Definition at line 145 of file command.cpp.

References _, Anope::string::c_str(), CommandSource::command, CommandSource::Reply(), and syntax.

Referenced by CommandCSMode::DoClear(), CommandCSTopic::Execute(), CommandOSSeen::Execute(), CommandCSBan::Execute(), CommandOSUpdate::OnHelp(), CommandOSSQLine::OnHelp(), CommandOSSNLine::OnHelp(), CommandOSSVSPart::OnHelp(), CommandOSSVSJoin::OnHelp(), CommandOSSVSNick::OnHelp(), CommandOSStats::OnHelp(), CommandOSShutdown::OnHelp(), CommandOSRestart::OnHelp(), CommandOSQuit::OnHelp(), CommandOSSet::OnHelp(), CommandOSException::OnHelp(), CommandOSSession::OnHelp(), CommandOSReload::OnHelp(), CommandOSOper::OnHelp(), CommandOSOLine::OnHelp(), CommandOSNOOP::OnHelp(), CommandOSRandomNews::OnHelp(), CommandOSOperNews::OnHelp(), CommandOSLogonNews::OnHelp(), CommandOSModUnLoad::OnHelp(), CommandOSModReLoad::OnHelp(), CommandOSModLoad::OnHelp(), CommandOSModList::OnHelp(), CommandOSModInfo::OnHelp(), CommandOSUMode::OnHelp(), CommandOSMode::OnHelp(), CommandOSLogSearch::OnHelp(), CommandOSLogout::OnHelp(), CommandOSLogin::OnHelp(), CommandOSUserList::OnHelp(), CommandOSChanList::OnHelp(), CommandOSKill::OnHelp(), CommandOSKick::OnHelp(), CommandOSJupe::OnHelp(), CommandOSIgnore::OnHelp(), CommandOSForbid::OnHelp(), CommandOSDNS::OnHelp(), CommandOSDefcon::OnHelp(), CommandOSConfig::OnHelp(), CommandOSChanKill::OnHelp(), CommandOSAKill::OnHelp(), CommandNSUpdate::OnHelp(), CommandNSUnSuspend::OnHelp(), CommandNSSuspend::OnHelp(), CommandNSStatus::OnHelp(), CommandNSSASetNoexpire::OnHelp(), CommandNSSASetSecure::OnHelp(), CommandNSSetSecure::OnHelp(), CommandNSSASetPrivate::OnHelp(), CommandNSSetPrivate::OnHelp(), CommandNSSASetMessage::OnHelp(), CommandNSSetMessage::OnHelp(), CommandNSSASetLanguage::OnHelp(), CommandNSSetLanguage::OnHelp(), CommandNSSASetKill::OnHelp(), CommandNSSetKill::OnHelp(), CommandNSSASetHide::OnHelp(), CommandNSSetHide::OnHelp(), CommandNSSASetGreet::OnHelp(), CommandNSSetGreet::OnHelp(), CommandNSSASetEmail::OnHelp(), CommandNSSetEmail::OnHelp(), CommandNSSASetDisplay::OnHelp(), CommandNSSetDisplay::OnHelp(), CommandNSSASetChanstats::OnHelp(), CommandNSSetChanstats::OnHelp(), CommandNSSASetAutoOp::OnHelp(), CommandNSSetAutoOp::OnHelp(), CommandNSSASetPassword::OnHelp(), CommandNSSetPassword::OnHelp(), CommandNSSASet::OnHelp(), CommandNSSet::OnHelp(), CommandNSResetPass::OnHelp(), CommandNSResend::OnHelp(), CommandNSRegister::OnHelp(), CommandNSConfirm::OnHelp(), CommandNSRecover::OnHelp(), CommandNSLogout::OnHelp(), CommandNSList::OnHelp(), CommandNSInfo::OnHelp(), CommandNSIdentify::OnHelp(), CommandNSUngroup::OnHelp(), CommandNSGroup::OnHelp(), CommandNSGetPass::OnHelp(), CommandNSGetEMail::OnHelp(), CommandNSCert::OnHelp(), CommandNSAList::OnHelp(), CommandNSAJoin::OnHelp(), CommandNSAccess::OnHelp(), CommandMSStaff::OnHelp(), CommandMSSet::OnHelp(), CommandMSSendAll::OnHelp(), CommandMSSend::OnHelp(), CommandMSRSend::OnHelp(), CommandMSRead::OnHelp(), CommandMSList::OnHelp(), CommandMSInfo::OnHelp(), CommandMSIgnore::OnHelp(), CommandMSDel::OnHelp(), CommandMSCheck::OnHelp(), CommandMSCancel::OnHelp(), CommandHSSetAll::OnHelp(), CommandHSSet::OnHelp(), CommandHSWaiting::OnHelp(), CommandHSReject::OnHelp(), CommandHSActivate::OnHelp(), CommandHSRequest::OnHelp(), CommandHSOn::OnHelp(), CommandHSOff::OnHelp(), CommandHSList::OnHelp(), CommandHSGroup::OnHelp(), CommandHSDelAll::OnHelp(), CommandHSDel::OnHelp(), CommandGLGlobal::OnHelp(), CommandCSVOP::OnHelp(), CommandCSSOP::OnHelp(), CommandCSHOP::OnHelp(), CommandCSAOP::OnHelp(), CommandCSQOP::OnHelp(), CommandCSDown::OnHelp(), CommandCSUp::OnHelp(), CommandCSUnban::OnHelp(), CommandCSTopic::OnHelp(), CommandCSSync::OnHelp(), CommandCSUnSuspend::OnHelp(), CommandCSSuspend::OnHelp(), CommandCSStatus::OnHelp(), CommandCSSASetNoexpire::OnHelp(), CommandCSSetSuccessor::OnHelp(), CommandCSSetSignKick::OnHelp(), CommandCSSetSecureOps::OnHelp(), CommandCSSetSecureFounder::OnHelp(), CommandCSSetSecure::OnHelp(), CommandCSSetRestricted::OnHelp(), CommandCSSetPrivate::OnHelp(), CommandCSSetPersist::OnHelp(), CommandCSSetPeace::OnHelp(), CommandCSSetKeepTopic::OnHelp(), CommandCSSetFounder::OnHelp(), CommandCSSetDescription::OnHelp(), CommandCSSetChanstats::OnHelp(), CommandCSSetBanType::OnHelp(), CommandCSSetAutoOp::OnHelp(), CommandCSSASet::OnHelp(), CommandCSSet::OnHelp(), CommandSeen::OnHelp(), CommandOSSeen::OnHelp(), CommandCSRegister::OnHelp(), CommandCSMode::OnHelp(), CommandCSLog::OnHelp(), CommandCSList::OnHelp(), CommandCSKick::OnHelp(), CommandCSInvite::OnHelp(), CommandCSInfo::OnHelp(), CommandCSGetKey::OnHelp(), CommandCSFlags::OnHelp(), CommandEntryMessage::OnHelp(), CommandCSEnforce::OnHelp(), CommandCSDrop::OnHelp(), CommandCSClone::OnHelp(), CommandCSBan::OnHelp(), CommandCSAKick::OnHelp(), CommandCSLevels::OnHelp(), CommandCSAccess::OnHelp(), CommandBSSetPrivate::OnHelp(), CommandBSSetNoBot::OnHelp(), CommandBSSetGreet::OnHelp(), CommandBSSetFantasy::OnHelp(), CommandBSSetDontKickVoices::OnHelp(), CommandBSSetDontKickOps::OnHelp(), CommandBSSet::OnHelp(), CommandBSKick::OnHelp(), CommandBSInfo::OnHelp(), CommandBSAct::OnHelp(), CommandBSSay::OnHelp(), CommandBSBotList::OnHelp(), CommandBSBot::OnHelp(), CommandBSBadwords::OnHelp(), CommandBSUnassign::OnHelp(), CommandBSAssign::OnHelp(), and OnSyntaxError().

void Command::SendSyntax ( CommandSource source,
const Anope::string syntax 
) [protected]
void Command::SetDesc ( const Anope::string d  )  [protected]

Definition at line 130 of file command.cpp.

References desc.

Referenced by CommandBSAct::CommandBSAct(), CommandBSAssign::CommandBSAssign(), CommandBSBadwords::CommandBSBadwords(), CommandBSBot::CommandBSBot(), CommandBSBotList::CommandBSBotList(), CommandBSInfo::CommandBSInfo(), CommandBSKick::CommandBSKick(), CommandBSSay::CommandBSSay(), CommandBSSet::CommandBSSet(), CommandBSSetDontKickOps::CommandBSSetDontKickOps(), CommandBSSetDontKickVoices::CommandBSSetDontKickVoices(), CommandBSSetFantasy::CommandBSSetFantasy(), CommandBSSetGreet::CommandBSSetGreet(), CommandBSSetNoBot::CommandBSSetNoBot(), CommandBSSetPrivate::CommandBSSetPrivate(), CommandBSUnassign::CommandBSUnassign(), CommandCSAccess::CommandCSAccess(), CommandCSAKick::CommandCSAKick(), CommandCSAOP::CommandCSAOP(), CommandCSBan::CommandCSBan(), CommandCSClone::CommandCSClone(), CommandCSDown::CommandCSDown(), CommandCSDrop::CommandCSDrop(), CommandCSEnforce::CommandCSEnforce(), CommandCSFlags::CommandCSFlags(), CommandCSGetKey::CommandCSGetKey(), CommandCSGStats::CommandCSGStats(), CommandCSGTop::CommandCSGTop(), CommandCSGTop10::CommandCSGTop10(), CommandCSHOP::CommandCSHOP(), CommandCSInfo::CommandCSInfo(), CommandCSInvite::CommandCSInvite(), CommandCSKick::CommandCSKick(), CommandCSLevels::CommandCSLevels(), CommandCSList::CommandCSList(), CommandCSLog::CommandCSLog(), CommandCSMode::CommandCSMode(), CommandCSQOP::CommandCSQOP(), CommandCSRegister::CommandCSRegister(), CommandCSSASet::CommandCSSASet(), CommandCSSASetNoexpire::CommandCSSASetNoexpire(), CommandCSSet::CommandCSSet(), CommandCSSetAutoOp::CommandCSSetAutoOp(), CommandCSSetBanType::CommandCSSetBanType(), CommandCSSetChanstats::CommandCSSetChanstats(), CommandCSSetDescription::CommandCSSetDescription(), CommandCSSetFounder::CommandCSSetFounder(), CommandCSSetKeepTopic::CommandCSSetKeepTopic(), CommandCSSetPeace::CommandCSSetPeace(), CommandCSSetPersist::CommandCSSetPersist(), CommandCSSetPrivate::CommandCSSetPrivate(), CommandCSSetRestricted::CommandCSSetRestricted(), CommandCSSetSecure::CommandCSSetSecure(), CommandCSSetSecureFounder::CommandCSSetSecureFounder(), CommandCSSetSecureOps::CommandCSSetSecureOps(), CommandCSSetSignKick::CommandCSSetSignKick(), CommandCSSetSuccessor::CommandCSSetSuccessor(), CommandCSSOP::CommandCSSOP(), CommandCSStats::CommandCSStats(), CommandCSStatus::CommandCSStatus(), CommandCSSuspend::CommandCSSuspend(), CommandCSSync::CommandCSSync(), CommandCSTop::CommandCSTop(), CommandCSTop10::CommandCSTop10(), CommandCSTopic::CommandCSTopic(), CommandCSUnban::CommandCSUnban(), CommandCSUnSuspend::CommandCSUnSuspend(), CommandCSUp::CommandCSUp(), CommandCSVOP::CommandCSVOP(), CommandEntryMessage::CommandEntryMessage(), CommandGLGlobal::CommandGLGlobal(), CommandHelp::CommandHelp(), CommandHSActivate::CommandHSActivate(), CommandHSDel::CommandHSDel(), CommandHSDelAll::CommandHSDelAll(), CommandHSGroup::CommandHSGroup(), CommandHSList::CommandHSList(), CommandHSOff::CommandHSOff(), CommandHSOn::CommandHSOn(), CommandHSReject::CommandHSReject(), CommandHSRequest::CommandHSRequest(), CommandHSSet::CommandHSSet(), CommandHSSetAll::CommandHSSetAll(), CommandHSWaiting::CommandHSWaiting(), CommandMSCancel::CommandMSCancel(), CommandMSCheck::CommandMSCheck(), CommandMSDel::CommandMSDel(), CommandMSIgnore::CommandMSIgnore(), CommandMSInfo::CommandMSInfo(), CommandMSList::CommandMSList(), CommandMSRead::CommandMSRead(), CommandMSRSend::CommandMSRSend(), CommandMSSend::CommandMSSend(), CommandMSSendAll::CommandMSSendAll(), CommandMSSet::CommandMSSet(), CommandMSStaff::CommandMSStaff(), CommandNSAccess::CommandNSAccess(), CommandNSAJoin::CommandNSAJoin(), CommandNSAList::CommandNSAList(), CommandNSCert::CommandNSCert(), CommandNSConfirm::CommandNSConfirm(), CommandNSDrop::CommandNSDrop(), CommandNSGetEMail::CommandNSGetEMail(), CommandNSGetPass::CommandNSGetPass(), CommandNSGList::CommandNSGList(), CommandNSGroup::CommandNSGroup(), CommandNSIdentify::CommandNSIdentify(), CommandNSInfo::CommandNSInfo(), CommandNSList::CommandNSList(), CommandNSLogout::CommandNSLogout(), CommandNSRecover::CommandNSRecover(), CommandNSRegister::CommandNSRegister(), CommandNSResetPass::CommandNSResetPass(), CommandNSSASet::CommandNSSASet(), CommandNSSASetNoexpire::CommandNSSASetNoexpire(), CommandNSSASetPassword::CommandNSSASetPassword(), CommandNSSet::CommandNSSet(), CommandNSSetAutoOp::CommandNSSetAutoOp(), CommandNSSetChanstats::CommandNSSetChanstats(), CommandNSSetDisplay::CommandNSSetDisplay(), CommandNSSetEmail::CommandNSSetEmail(), CommandNSSetGreet::CommandNSSetGreet(), CommandNSSetHide::CommandNSSetHide(), CommandNSSetKill::CommandNSSetKill(), CommandNSSetLanguage::CommandNSSetLanguage(), CommandNSSetMessage::CommandNSSetMessage(), CommandNSSetPassword::CommandNSSetPassword(), CommandNSSetPrivate::CommandNSSetPrivate(), CommandNSSetSecure::CommandNSSetSecure(), CommandNSStatus::CommandNSStatus(), CommandNSSuspend::CommandNSSuspend(), CommandNSUngroup::CommandNSUngroup(), CommandNSUnSuspend::CommandNSUnSuspend(), CommandNSUpdate::CommandNSUpdate(), CommandOSAKill::CommandOSAKill(), CommandOSChanKill::CommandOSChanKill(), CommandOSChanList::CommandOSChanList(), CommandOSConfig::CommandOSConfig(), CommandOSDefcon::CommandOSDefcon(), CommandOSDNS::CommandOSDNS(), CommandOSException::CommandOSException(), CommandOSForbid::CommandOSForbid(), CommandOSIgnore::CommandOSIgnore(), CommandOSJupe::CommandOSJupe(), CommandOSKick::CommandOSKick(), CommandOSKill::CommandOSKill(), CommandOSLogin::CommandOSLogin(), CommandOSLogonNews::CommandOSLogonNews(), CommandOSLogout::CommandOSLogout(), CommandOSLogSearch::CommandOSLogSearch(), CommandOSMode::CommandOSMode(), CommandOSModInfo::CommandOSModInfo(), CommandOSModList::CommandOSModList(), CommandOSModLoad::CommandOSModLoad(), CommandOSModReLoad::CommandOSModReLoad(), CommandOSModUnLoad::CommandOSModUnLoad(), CommandOSNOOP::CommandOSNOOP(), CommandOSOLine::CommandOSOLine(), CommandOSOper::CommandOSOper(), CommandOSOperNews::CommandOSOperNews(), CommandOSQuit::CommandOSQuit(), CommandOSRandomNews::CommandOSRandomNews(), CommandOSReload::CommandOSReload(), CommandOSRestart::CommandOSRestart(), CommandOSSeen::CommandOSSeen(), CommandOSSession::CommandOSSession(), CommandOSSet::CommandOSSet(), CommandOSShutdown::CommandOSShutdown(), CommandOSStats::CommandOSStats(), CommandOSSVSJoin::CommandOSSVSJoin(), CommandOSSVSNick::CommandOSSVSNick(), CommandOSSVSPart::CommandOSSVSPart(), CommandOSSXLineBase::CommandOSSXLineBase(), CommandOSUMode::CommandOSUMode(), CommandOSUpdate::CommandOSUpdate(), CommandOSUserList::CommandOSUserList(), CommandSeen::CommandSeen(), RewriteCommand::OnServHelp(), CommandNSSetMisc::OnServHelp(), and CommandCSSetMisc::OnServHelp().

void Command::SetSyntax ( const Anope::string s  )  [protected]

Definition at line 140 of file command.cpp.

References syntax.

Referenced by CommandBSAct::CommandBSAct(), CommandBSAssign::CommandBSAssign(), CommandBSBadwords::CommandBSBadwords(), CommandBSBot::CommandBSBot(), CommandBSBotList::CommandBSBotList(), CommandBSInfo::CommandBSInfo(), CommandBSKick::CommandBSKick(), CommandBSSay::CommandBSSay(), CommandBSSet::CommandBSSet(), CommandBSSetDontKickOps::CommandBSSetDontKickOps(), CommandBSSetDontKickVoices::CommandBSSetDontKickVoices(), CommandBSSetFantasy::CommandBSSetFantasy(), CommandBSSetGreet::CommandBSSetGreet(), CommandBSSetNoBot::CommandBSSetNoBot(), CommandBSSetPrivate::CommandBSSetPrivate(), CommandBSUnassign::CommandBSUnassign(), CommandCSAccess::CommandCSAccess(), CommandCSAKick::CommandCSAKick(), CommandCSBan::CommandCSBan(), CommandCSClone::CommandCSClone(), CommandCSDown::CommandCSDown(), CommandCSDrop::CommandCSDrop(), CommandCSEnforce::CommandCSEnforce(), CommandCSFlags::CommandCSFlags(), CommandCSGetKey::CommandCSGetKey(), CommandCSGStats::CommandCSGStats(), CommandCSGTop::CommandCSGTop(), CommandCSGTop10::CommandCSGTop10(), CommandCSInfo::CommandCSInfo(), CommandCSInvite::CommandCSInvite(), CommandCSKick::CommandCSKick(), CommandCSLevels::CommandCSLevels(), CommandCSList::CommandCSList(), CommandCSLog::CommandCSLog(), CommandCSMode::CommandCSMode(), CommandCSRegister::CommandCSRegister(), CommandCSSASet::CommandCSSASet(), CommandCSSASetNoexpire::CommandCSSASetNoexpire(), CommandCSSet::CommandCSSet(), CommandCSSetAutoOp::CommandCSSetAutoOp(), CommandCSSetBanType::CommandCSSetBanType(), CommandCSSetChanstats::CommandCSSetChanstats(), CommandCSSetDescription::CommandCSSetDescription(), CommandCSSetFounder::CommandCSSetFounder(), CommandCSSetKeepTopic::CommandCSSetKeepTopic(), CommandCSSetMisc::CommandCSSetMisc(), CommandCSSetPeace::CommandCSSetPeace(), CommandCSSetPersist::CommandCSSetPersist(), CommandCSSetPrivate::CommandCSSetPrivate(), CommandCSSetRestricted::CommandCSSetRestricted(), CommandCSSetSecure::CommandCSSetSecure(), CommandCSSetSecureFounder::CommandCSSetSecureFounder(), CommandCSSetSecureOps::CommandCSSetSecureOps(), CommandCSSetSignKick::CommandCSSetSignKick(), CommandCSSetSuccessor::CommandCSSetSuccessor(), CommandCSStats::CommandCSStats(), CommandCSStatus::CommandCSStatus(), CommandCSSuspend::CommandCSSuspend(), CommandCSSync::CommandCSSync(), CommandCSTop::CommandCSTop(), CommandCSTop10::CommandCSTop10(), CommandCSTopic::CommandCSTopic(), CommandCSUnban::CommandCSUnban(), CommandCSUnSuspend::CommandCSUnSuspend(), CommandCSUp::CommandCSUp(), CommandEntryMessage::CommandEntryMessage(), CommandGLGlobal::CommandGLGlobal(), CommandHSActivate::CommandHSActivate(), CommandHSDel::CommandHSDel(), CommandHSDelAll::CommandHSDelAll(), CommandHSGroup::CommandHSGroup(), CommandHSList::CommandHSList(), CommandHSOff::CommandHSOff(), CommandHSOn::CommandHSOn(), CommandHSRequest::CommandHSRequest(), CommandHSSet::CommandHSSet(), CommandHSSetAll::CommandHSSetAll(), CommandHSWaiting::CommandHSWaiting(), CommandMSCancel::CommandMSCancel(), CommandMSCheck::CommandMSCheck(), CommandMSDel::CommandMSDel(), CommandMSIgnore::CommandMSIgnore(), CommandMSInfo::CommandMSInfo(), CommandMSList::CommandMSList(), CommandMSRead::CommandMSRead(), CommandMSRSend::CommandMSRSend(), CommandMSSend::CommandMSSend(), CommandMSSendAll::CommandMSSendAll(), CommandMSSet::CommandMSSet(), CommandMSStaff::CommandMSStaff(), CommandNSAccess::CommandNSAccess(), CommandNSAJoin::CommandNSAJoin(), CommandNSAList::CommandNSAList(), CommandNSCert::CommandNSCert(), CommandNSConfirm::CommandNSConfirm(), CommandNSGetEMail::CommandNSGetEMail(), CommandNSGetPass::CommandNSGetPass(), CommandNSGroup::CommandNSGroup(), CommandNSIdentify::CommandNSIdentify(), CommandNSInfo::CommandNSInfo(), CommandNSList::CommandNSList(), CommandNSLogout::CommandNSLogout(), CommandNSRecover::CommandNSRecover(), CommandNSRegister::CommandNSRegister(), CommandNSResend::CommandNSResend(), CommandNSResetPass::CommandNSResetPass(), CommandNSSASet::CommandNSSASet(), CommandNSSASetAutoOp::CommandNSSASetAutoOp(), CommandNSSASetChanstats::CommandNSSASetChanstats(), CommandNSSASetDisplay::CommandNSSASetDisplay(), CommandNSSASetEmail::CommandNSSASetEmail(), CommandNSSASetGreet::CommandNSSASetGreet(), CommandNSSASetHide::CommandNSSASetHide(), CommandNSSASetKill::CommandNSSASetKill(), CommandNSSASetLanguage::CommandNSSASetLanguage(), CommandNSSASetMessage::CommandNSSASetMessage(), CommandNSSASetMisc::CommandNSSASetMisc(), CommandNSSASetNoexpire::CommandNSSASetNoexpire(), CommandNSSASetPassword::CommandNSSASetPassword(), CommandNSSASetPrivate::CommandNSSASetPrivate(), CommandNSSASetSecure::CommandNSSASetSecure(), CommandNSSet::CommandNSSet(), CommandNSSetAutoOp::CommandNSSetAutoOp(), CommandNSSetChanstats::CommandNSSetChanstats(), CommandNSSetDisplay::CommandNSSetDisplay(), CommandNSSetEmail::CommandNSSetEmail(), CommandNSSetGreet::CommandNSSetGreet(), CommandNSSetHide::CommandNSSetHide(), CommandNSSetKill::CommandNSSetKill(), CommandNSSetLanguage::CommandNSSetLanguage(), CommandNSSetMessage::CommandNSSetMessage(), CommandNSSetMisc::CommandNSSetMisc(), CommandNSSetPassword::CommandNSSetPassword(), CommandNSSetPrivate::CommandNSSetPrivate(), CommandNSSetSecure::CommandNSSetSecure(), CommandNSStatus::CommandNSStatus(), CommandNSSuspend::CommandNSSuspend(), CommandNSUngroup::CommandNSUngroup(), CommandNSUnSuspend::CommandNSUnSuspend(), CommandNSUpdate::CommandNSUpdate(), CommandOSAKill::CommandOSAKill(), CommandOSChanKill::CommandOSChanKill(), CommandOSChanList::CommandOSChanList(), CommandOSConfig::CommandOSConfig(), CommandOSDefcon::CommandOSDefcon(), CommandOSDNS::CommandOSDNS(), CommandOSException::CommandOSException(), CommandOSForbid::CommandOSForbid(), CommandOSIgnore::CommandOSIgnore(), CommandOSJupe::CommandOSJupe(), CommandOSKick::CommandOSKick(), CommandOSKill::CommandOSKill(), CommandOSLogin::CommandOSLogin(), CommandOSLogout::CommandOSLogout(), CommandOSLogSearch::CommandOSLogSearch(), CommandOSMode::CommandOSMode(), CommandOSModInfo::CommandOSModInfo(), CommandOSModList::CommandOSModList(), CommandOSModLoad::CommandOSModLoad(), CommandOSModReLoad::CommandOSModReLoad(), CommandOSModUnLoad::CommandOSModUnLoad(), CommandOSNOOP::CommandOSNOOP(), CommandOSOLine::CommandOSOLine(), CommandOSOper::CommandOSOper(), CommandOSQuit::CommandOSQuit(), CommandOSReload::CommandOSReload(), CommandOSRestart::CommandOSRestart(), CommandOSSeen::CommandOSSeen(), CommandOSSession::CommandOSSession(), CommandOSSet::CommandOSSet(), CommandOSShutdown::CommandOSShutdown(), CommandOSSNLine::CommandOSSNLine(), CommandOSSQLine::CommandOSSQLine(), CommandOSStats::CommandOSStats(), CommandOSSVSJoin::CommandOSSVSJoin(), CommandOSSVSNick::CommandOSSVSNick(), CommandOSSVSPart::CommandOSSVSPart(), CommandOSUMode::CommandOSUMode(), CommandOSUpdate::CommandOSUpdate(), CommandOSUserList::CommandOSUserList(), CommandSeen::CommandSeen(), NewsBase::NewsBase(), and XOPBase::XOPBase().


Field Documentation

Definition at line 97 of file commands.h.

Referenced by AllowUnregistered(), and Command().

Definition at line 94 of file commands.h.

Referenced by GetDesc(), and SetDesc().

Definition at line 103 of file commands.h.

Definition at line 105 of file commands.h.

Definition at line 108 of file commands.h.

Referenced by CommandOSDefcon::Execute().

bool Command::require_user [private]

Definition at line 99 of file commands.h.

Referenced by Command(), and RequireUser().

std::vector<Anope::string> Command::syntax [private]

Definition at line 95 of file commands.h.

Referenced by ClearSyntax(), SendSyntax(), and SetSyntax().


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