#include <string>
#include <map>
+/** RFC1459 channel modes
+ */
enum ChannelModes {
- CM_TOPICLOCK = 1,
- CM_NOEXTERNAL = 2,
- CM_INVITEONLY = 4,
- CM_MODERATED = 8,
- CM_SECRET = 16,
- CM_PRIVATE = 32
+ CM_TOPICLOCK = 't'-65,
+ CM_NOEXTERNAL = 'n'-65,
+ CM_INVITEONLY = 'i'-65,
+ CM_MODERATED = 'm'-65,
+ CM_SECRET = 's'-65,
+ CM_PRIVATE = 'p'-65,
+ CM_KEY = 'k'-65,
+ CM_LIMIT = 'l'-65
};
class userrec;
virtual ~HostItem() { /* stub */ }
};
-// banlist is inherited from HostList mainly for readability
-// reasons only
-
/** A subclass of HostItem designed to hold channel bans (+b)
*/
class BanItem : public HostItem
{
};
-// same with this...
-
/** A subclass of HostItem designed to hold channel exempts (+e)
*/
class ExemptItem : public HostItem
{
};
-// and this...
-
/** A subclass of HostItem designed to hold channel invites (+I)
*/
class InviteItem : public HostItem
*/
typedef std::vector<InviteItem> InviteList;
+/** A list of users on a channel
+ */
+typedef std::map<userrec*,userrec*> CUList;
+
+/** A list of custom modes parameters on a channel
+ */
+typedef std::map<char,char*> CustomModeList;
+
/** Holds all relevent information for a channel.
* This class represents a channel, and contains its name, modes, time created, topic, topic set time,
* etc, and an instance of the BanList type.
/** The channels name.
*/
char name[CHANMAX]; /* channel name */
- /** Custom modes for the channel.
- * Plugins may use this field in any way they see fit.
+ /** Modes for the channel.
+ * This is not a null terminated string! It is a hash where
+ * each item in it represents if a mode is set. For example
+ * for mode +A, index 0. Use modechar-65 to calculate which
+ * field to check.
*/
- char custom_modes[64]; /* modes handled by modules */
+ char modes[64];
- /** User list (casted to char*'s to stop forward declaration stuff)
- * (chicken and egg scenario!)
+ /** User lists
+ * There are four user lists, one for
+ * all the users, one for the ops, one for
+ * the halfops and another for the voices.
*/
- std::map<char*,char*> internal_userlist;
- std::map<char*,char*> internal_op_userlist;
- std::map<char*,char*> internal_halfop_userlist;
- std::map<char*,char*> internal_voice_userlist;
+ CUList internal_userlist;
+ CUList internal_op_userlist;
+ CUList internal_halfop_userlist;
+ CUList internal_voice_userlist;
/** Parameters for custom modes
*/
- std::map<char,char*> custom_mode_params;
+ CustomModeList custom_mode_params;
/** Channel topic.
* If this is an empty string, no channel topic is set.
*/
- char topic[MAXBUF];
+ char topic[MAXTOPIC];
/** Creation time.
*/
time_t created;
/** Contains a bitmask of the CM_* builtin (RFC) binary mode symbols
*/
- char binarymodes;
+ //char binarymodes;
/** The list of all bans set on the channel.
*/
*/
void SetCustomModeParam(char mode,char* parameter,bool mode_on);
- /** Returns true if a custom mode is set on a channel
+ /** Returns true if a mode is set on a channel
* @param mode The mode character you wish to query
* @return True if the custom mode is set, false if otherwise
*/
- bool IsCustomModeSet(char mode);
+ bool IsModeSet(char mode);
/** Returns the parameter for a custom mode on a channel.
* @param mode The mode character you wish to query
long GetUserCounter();
/** Add a user pointer to the internal reference list
- * @param castuser This should be a pointer to a userrec, casted to char*
+ * @param user The user to add
*
* The data inserted into the reference list is a table as it is
* an arbitary pointer compared to other users by its memory address,
* as this is a very fast 32 or 64 bit integer comparison.
*/
- void AddUser(char* castuser);
- void AddOppedUser(char* castuser);
- void AddHalfoppedUser(char* castuser);
- void AddVoicedUser(char* castuser);
+ void AddUser(userrec* user);
+ void AddOppedUser(userrec* user);
+ void AddHalfoppedUser(userrec* user);
+ void AddVoicedUser(userrec* user);
/** Delete a user pointer to the internal reference list
- * @param castuser This should be a pointer to a userrec, casted to char*
- *
- * The data removed from the reference list is a table as it is
- * an arbitary pointer compared to other users by its memory address,
- * as this is a very fast 32 or 64 bit integer comparison.
+ * @param user The user to delete
+ * @return number of users left on the channel
*/
- void DelUser(char* castuser);
- void DelOppedUser(char* castuser);
- void DelHalfoppedUser(char* castuser);
- void DelVoicedUser(char* castuser);
-
- /** Obrain the internal reference list
- * The internal reference list contains a list of userrec*
- * cast to char*. These are used for rapid comparison to determine
+ unsigned long DelUser(userrec* user);
+ void DelOppedUser(userrec* user);
+ void DelHalfoppedUser(userrec* user);
+ void DelVoicedUser(userrec* user);
+
+ /** Obtain the internal reference list
+ * The internal reference list contains a list of userrec*.
+ * These are used for rapid comparison to determine
* channel membership for PRIVMSG, NOTICE, QUIT, PART etc.
* The resulting pointer to the vector should be considered
* readonly and only modified via AddUser and DelUser.
*
- * @return This function returns a vector of userrec pointers, each of which has been casted to char* to prevent circular references
+ * @return This function returns pointer to a map of userrec pointers (CUList*).
+ */
+ CUList* GetUsers();
+ CUList* GetOppedUsers();
+ CUList* GetHalfoppedUsers();
+ CUList* GetVoicedUsers();
+
+ /** Returns true if the user given is on the given channel.
*/
- std::map<char*,char*> *GetUsers();
- std::map<char*,char*> *GetOppedUsers();
- std::map<char*,char*> *GetHalfoppedUsers();
- std::map<char*,char*> *GetVoicedUsers();
+ bool HasUser(userrec* user);
/** Creates a channel record and initialises it with default values
*/
chanrec();
+ /** Destructor for chanrec
+ */
virtual ~chanrec() { /* stub */ }
};
*/
chanrec *channel;
+ /** Constructor for ucrec
+ */
ucrec() : uc_modes(0), channel(NULL) { /* stub */ }
+
+ /** Destructor for ucrec
+ */
virtual ~ucrec() { /* stub */ }
};
projects / user / henk / code / inspircd.git / blobdiff