Change return type of Channel::GetUsers() to reference from pointer as it is never...

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

diff --git a/include/channels.h b/include/channels.h
index 628f34f9f995a46bb6dee2b81092f77cbf4c9957..37f0eb431f4ae0dd271736d8d4544875e46c0d92 100644 (file)
--- a/include/channels.h
+++ b/include/channels.h
@@ -166,7 +166,7 @@ class CoreExport Channel : public Extensible, public InviteBase<Channel>
         *
         * @return This function returns pointer to a map of User pointers (CUList*).
         */
-       const UserMembList* GetUsers() const { return &userlist; }
+       const UserMembList& GetUsers() const { return userlist; }
 
        /** Returns true if the user given is on the given channel.
         * @param user The user to look for
@@ -178,11 +178,22 @@ class CoreExport Channel : public Extensible, public InviteBase<Channel>
 
        /** Make src kick user from this channel with the given reason.
         * @param src The source of the kick
-        * @param user The user being kicked (must be on this channel)
+        * @param victimiter Iterator to the user being kicked, must be valid
         * @param reason The reason for the kick
-        * @param srcmemb The membership of the user who does the kick, can be NULL
         */
-       void KickUser(User* src, User* user, const std::string& reason, Membership* srcmemb = NULL);
+       void KickUser(User* src, const UserMembIter& victimiter, const std::string& reason);
+
+       /** Make src kick user from this channel with the given reason.
+        * @param src The source of the kick
+        * @param user The user being kicked
+        * @param reason The reason for the kick
+        */
+       void KickUser(User* src, User* user, const std::string& reason)
+       {
+               UserMembIter it = userlist.find(user);
+               if (it != userlist.end())
+                       KickUser(src, it, reason);
+       }
 
        /** Part a user from this channel with the given reason.
         * If the reason field is NULL, no reason will be sent.
@@ -207,8 +218,9 @@ class CoreExport Channel : public Extensible, public InviteBase<Channel>
         * @param privs Priviliges (prefix mode letters) to give to this user, may be NULL
         * @param bursting True if this join is the result of a netburst (passed to modules in the OnUserJoin hook)
         * @param created_by_local True if this channel was just created by a local user (passed to modules in the OnUserJoin hook)
+        * @return A newly created Membership object, or NULL if the user was already inside the channel or if the user is a server user
         */
-       void ForceJoin(User* user, const std::string* privs = NULL, bool bursting = false, bool created_by_local = false);
+       Membership* ForceJoin(User* user, const std::string* privs = NULL, bool bursting = false, bool created_by_local = false);
 
        /** Write to a channel, from a user, using va_args for text
         * @param user User whos details to prefix the line with
@@ -289,8 +301,9 @@ class CoreExport Channel : public Extensible, public InviteBase<Channel>
 
        /** Spool the NAMES list for this channel to the given user
         * @param user The user to spool the NAMES list to
+        * @param isinside If true, the user is inside the channel, if not then false
         */
-       void UserList(User *user);
+       void UserList(User* user, bool isinside = true);
 
        /** Get the value of a users prefix on this channel.
         * @param user The user to look up