Incorporated Craig's friendlier SQL class (documentation to come later)

[user/henk/code/inspircd.git] / include / channels.h

diff --git a/include/channels.h b/include/channels.h
index 7df2d665e76ec494e76a5632e45a1e9a3edb44ef..dd6d3b585b64752421af91dbcd82a65e3eb98e08 100644 (file)
--- a/include/channels.h
+++ b/include/channels.h
@@ -2,7 +2,7 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  Inspire is copyright (C) 2002-2004 ChatSpike-Dev.
+ *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
  *                       E-mail:
  *                <brain@chatspike.net>
  *               <Craig@chatspike.net>
@@ -14,14 +14,15 @@
  * ---------------------------------------------------
  */
 
+#ifndef __CHANNELS_H__
+#define __CHANNELS_H__
+
 #include "inspircd_config.h"
 #include "base.h"
 #include <time.h>
 #include <vector>
 #include <string>
-
-#ifndef __CHANNELS_H__
-#define __CHANNELS_H__
+#include <map>
 
 #define CM_TOPICLOCK 1
 #define CM_NOEXTERNAL 2
@@ -30,6 +31,8 @@
 #define CM_SECRET 16
 #define CM_PRIVATE 32
 
+class userrec;
+
 /** Holds an entry for a ban list, exemption list, or invite list.
  * This class contains a single element in a channel list, such as a banlist.
  */
@@ -112,7 +115,7 @@ class chanrec : public Extensible
        /** User list (casted to char*'s to stop forward declaration stuff)
         * (chicken and egg scenario!)
         */
-       std::vector<char*> internal_userlist;
+       std::map<char*,char*> internal_userlist;
        
        /** Channel topic.
         * If this is an empty string, no channel topic is set.
@@ -149,22 +152,33 @@ class chanrec : public Extensible
        BanList bans;
        
        /** Sets or unsets a custom mode in the channels info
+        * @param mode The mode character to set or unset
+        * @param mode_on True if you want to set the mode or false if you want to remove it
         */
        void SetCustomMode(char mode,bool mode_on);
 
        /** Sets or unsets the parameters for a custom mode in a channels info
+        * @param mode The mode character to set or unset
+        * @param parameter The parameter string to associate with this mode character
+        * @param mode_on True if you want to set the mode or false if you want to remove it
         */
        void SetCustomModeParam(char mode,char* parameter,bool mode_on);
  
        /** Returns true if a custom 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);
 
        /** Returns the parameter for a custom mode on a channel.
+         * @param mode The mode character you wish to query
+         *
          * For example if "+L #foo" is set, and you pass this method
          * 'L', it will return '#foo'. If the mode is not set on the
          * channel, or the mode has no parameters associated with it,
          * it will return an empty string.
+         *
+         * @return The parameter for this mode is returned, or an empty string
          */
        std::string GetModeParameter(char mode);
 
@@ -172,10 +186,14 @@ class chanrec : public Extensible
         * This returns the channel reference counter, which is initialized
         * to 0 when the channel is created and incremented/decremented
         * upon joins, parts quits and kicks.
+        *
+        * @return The number of users on this channel
         */
        long GetUserCounter();
 
        /** Add a user pointer to the internal reference list
+        * @param castuser This should be a pointer to a userrec, casted to char*
+        *
         * 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.
@@ -183,6 +201,8 @@ class chanrec : public Extensible
        void AddUser(char* castuser);
 
         /** 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.
@@ -195,8 +215,10 @@ class chanrec : public Extensible
         * 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
         */
-       std::vector<char*> *GetUsers();
+       std::map<char*,char*> *GetUsers();
 
        /** Creates a channel record and initialises it with default values
         */
@@ -236,5 +258,10 @@ class ucrec : public classbase
        virtual ~ucrec() { /* stub */ }
 };
 
+chanrec* add_channel(userrec *user, const char* cn, const char* key, bool override);
+chanrec* del_channel(userrec *user, const char* cname, const char* reason, bool local);
+void kick_channel(userrec *src,userrec *user, chanrec *Ptr, char* reason);
+void server_kick_channel(userrec* user, chanrec* Ptr, char* reason, bool triggerevents);
+
 #endif