ouch/inspircd
2
0
Fork 0
mirror of https://github.com/inspircd/inspircd.git synced 2025-03-10 02:59:01 -04:00
Code Issues Packages Projects Releases Wiki Activity

Comments

Browse Source 
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@4144 e03df62e-2008-0410-955e-edbf42e46eb7
This commit is contained in:
brain 2006-07-07 20:50:25 +00:00
parent eedeab3ded
commit 53e8c67c58
1 changed files with 62 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
include/mode.h
View File

@ -29,34 +29,92 @@
#include "channels.h"
#include "ctables.h"
/**
* This enum contains a set of bitmasks which
* are used to compress the 'standard' usermodes
* +isw into a bitfield for fast checking.
*/
enum UserModeBits {
UM_INVISIBLE = 1,
UM_SERVERNOTICE = 2,
UM_WALLOPS = 4
};
/**
* Holds the values for different type of modes
* that can exist, USER or CHANNEL type.
*/
enum ModeType {
MODETYPE_USER = 0,
MODETYPE_CHANNEL = 1
};
/**
* Holds mode actions - modes can be allowed or denied.
*/
enum ModeAction {
MODEACTION_DENY = 0, /* Drop the mode change, AND a parameter if its a parameterized mode */
MODEACTION_ALLOW = 1 /* Allow the mode */
};
/**
* Used to mask off the mode types in the mode handler
* array. Used in a simple two instruction hashing function
* "(modeletter - 65) OR mask"
*/
enum ModeMasks {
MASK_USER = 128, /* A user mode */
MASK_CHANNEL = 0 /* A channel mode */
};
/** Each mode is implemented by ONE ModeHandler class.
* You must derive ModeHandler and add the child class to
* the list of modes handled by the ircd, using
* ModeParser::AddMode. When the mode you implement is
* set by a user, the virtual function OnModeChange is
* called. If you specify a value greater than 0 for
* parameters_on or parameters_off, then when the mode is
* set or unset respectively, std::string &parameter will
* contain the parameter given by the user, else it will
* contain an empty string. You may alter this parameter
* string, and if you alter it to an empty string, and your
* mode is expected to have a parameter, then this is
* equivalent to returning MODEACTION_DENY.
*/
class ModeHandler
{
/**
* The mode letter you're implementing.
*/
char mode;
/**
* Number of parameters when being set
*/
int n_params_on;
/**
* Number of parameters when being unset
*/
int n_params_off;
/**
* Mode is a 'list' mode. The behaviour
* of your mode is now set entirely within
* the class as of the 1.1 api, rather than
* inside the mode parser as in the 1.0 api,
* so the only use of this value (along with
* IsListMode()) is for the core to determine
* wether your module can produce 'lists' or not
* (e.g. banlists, etc)
*/
bool list;
/**
* The mode type, either MODETYPE_USER or
* MODETYPE_CHANNEL.
*/
ModeType m_type;
/**
* True if the mode requires oper status
* to set.
*/
bool oper;
public:
@ -99,11 +157,13 @@ class ModeParser
* Mode handlers for each mode, to access a handler subtract
* 65 from the ascii value of the mode letter.
* The upper bit of the value indicates if its a usermode
* or a channel mode, so we have 255 of them not 64.
* or a channel mode, so we have 256 of them not 64.
*/
ModeHandler* modehandlers[256];
/**
* Mode watcher classes
* Mode watcher classes arranged in the same way as the
* mode handlers, except for instead of having 256 of them
* we have 256 lists of them.
*/
std::vector<ModeWatcher*> modewatchers[256];