]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/channels.h
Removed chanrec::binarymodes - insp wont compile atm do not use :p
[user/henk/code/inspircd.git] / include / channels.h
index 03c636d9bba91a990dc5bce16a065a20be2c5ca9..a6568cb1e8198ffd25ccd286725cf7d427b09b32 100644 (file)
 #include <string>
 #include <map>
 
-#define CM_TOPICLOCK 1
-#define CM_NOEXTERNAL 2
-#define CM_INVITEONLY 4
-#define CM_MODERATED 8
-#define CM_SECRET 16
-#define CM_PRIVATE 32
+enum ChannelModes {
+       CM_TOPICLOCK = 1,
+       CM_NOEXTERNAL = 2,
+       CM_INVITEONLY = 4,
+       CM_MODERATED = 8,
+       CM_SECRET = 16,
+       CM_PRIVATE = 32
+};
 
 class userrec;
 
@@ -72,19 +74,6 @@ class InviteItem : public HostItem
 {
 };
 
-
-/** Holds a custom parameter to a module-defined channel mode
-  * e.g. for +L this would hold the channel name.
-  */
-
-class ModeParameter : public classbase
-{
- public:
-       char mode;
-       char parameter[MAXBUF];
-       char channel[CHANMAX];
-};
-
 /** Holds a complete ban list
  */
 typedef std::vector<BanItem>   BanList;
@@ -97,6 +86,16 @@ typedef std::vector<ExemptItem>      ExemptList;
  */
 typedef std::vector<InviteItem>        InviteList;
 
+class userrec;
+
+/** 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.
@@ -110,24 +109,26 @@ class chanrec : public Extensible
        /** Custom modes for the channel.
         * Plugins may use this field in any way they see fit.
         */
-       char custom_modes[MAXMODES];     /* modes handled by modules */
+       char custom_modes[64];     /* modes handled by modules */
 
-       /** 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::vector<ModeParameter> 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;
@@ -152,7 +153,7 @@ class chanrec : public Extensible
        
        /** Contains a bitmask of the CM_* builtin (RFC) binary mode symbols
         */
-       char binarymodes;
+       //char binarymodes;
        
        /** The list of all bans set on the channel.
         */
@@ -199,42 +200,41 @@ class chanrec : public Extensible
        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);
+       unsigned long DelUser(userrec* user);
+       void DelOppedUser(userrec* user);
+       void DelHalfoppedUser(userrec* user);
+       void DelVoicedUser(userrec* user);
 
        /** 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
+        * 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*).
         */
-       std::map<char*,char*> *GetUsers();
-       std::map<char*,char*> *GetOppedUsers();
-       std::map<char*,char*> *GetHalfoppedUsers();
-       std::map<char*,char*> *GetVoicedUsers();
+       CUList* GetUsers();
+       CUList* GetOppedUsers();
+       CUList* GetHalfoppedUsers();
+       CUList* GetVoicedUsers();
+
+       bool HasUser(userrec* user);
 
        /** Creates a channel record and initialises it with default values
         */
@@ -243,14 +243,13 @@ class chanrec : public Extensible
        virtual ~chanrec() { /* stub */ }
 };
 
-/* used to hold a channel and a users modes on that channel, e.g. +v, +h, +o
+/** used to hold a channel and a users modes on that channel, e.g. +v, +h, +o
  * needs to come AFTER struct chanrec */
-
-#define UCMODE_OP      1
-#define UCMODE_VOICE   2
-#define UCMODE_HOP     4
-#define UCMODE_PROTECT 8
-#define UCMODE_FOUNDER 16
+enum UserChannelModes {
+       UCMODE_OP      = 1,
+       UCMODE_VOICE   = 2,
+       UCMODE_HOP     = 4
+};
  
 /** Holds a user's modes on a channel
  * This class associates a users privilages with a channel by creating a pointer link between