Remove the Kiwi links from the readme.

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

diff --git a/include/listmode.h b/include/listmode.h
index 94af1d524f366541fc5fd5a04b70a6e46bb8b8ae..510604e6e84e411bf1c579d1beade30815024013 100644 (file)
--- a/include/listmode.h
+++ b/include/listmode.h
@@ -1,7 +1,9 @@
 /*
  * InspIRCd -- Internet Relay Chat Daemon
  *
- *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2018 B00mX0r <b00mx0r@aureus.pw>
+ *   Copyright (C) 2013-2014 Attila Molnar <attilamolnar@hush.com>
+ *   Copyright (C) 2013, 2017-2019 Sadie Powell <sadie@witchery.services>
  *
  * This file is part of InspIRCd.  InspIRCd is free software: you can
  * redistribute it and/or modify it under the terms of the GNU General Public
@@ -63,6 +65,9 @@ class CoreExport ListModeBase : public ModeHandler
         */
        typedef std::vector<ListLimit> limitlist;
 
+       /** The default maximum list size. */
+       static const unsigned int DEFAULT_LIST_SIZE = 100;
+
        /** Finds the limit of modes that can be placed on the given channel name according to the config
         * @param channame The channel name to find the limit for
         * @return The maximum number of modes of this type that we allow to be set on the given channel name
@@ -83,20 +88,21 @@ class CoreExport ListModeBase : public ModeHandler
        /** Numeric to use when outputting the list
         */
        unsigned int listnumeric;
+
        /** Numeric to indicate end of list
         */
        unsigned int endoflistnumeric;
+
        /** String to send for end of list
         */
        std::string endofliststring;
+
        /** Automatically tidy up entries
         */
        bool tidy;
-       /** Config tag to check for max items per channel
-        */
-       std::string configtag;
-       /** Limits on a per-channel basis read from the tag
-        * specified in ListModeBase::configtag
+
+       /** Limits on a per-channel basis read from the \<listmode>
+        * config tag.
         */
        limitlist chanlimits;
 
@@ -113,9 +119,11 @@ class CoreExport ListModeBase : public ModeHandler
         * @param lnum List numeric
         * @param eolnum End of list numeric
         * @param autotidy Automatically tidy list entries on add
-        * @param ctag Configuration tag to get limits from
         */
-       ListModeBase(Module* Creator, const std::string& Name, char modechar, const std::string &eolstr, unsigned int lnum, unsigned int eolnum, bool autotidy, const std::string &ctag = "banlist");
+       ListModeBase(Module* Creator, const std::string& Name, char modechar, const std::string& eolstr, unsigned int lnum, unsigned int eolnum, bool autotidy);
+
+       /** Determines whether some channels have longer lists than others. */
+       bool HasVariableLength() const { return chanlimits.size() > 1; }
 
        /** Get limit of this mode on a channel
         * @param channel The channel to inspect
@@ -123,6 +131,10 @@ class CoreExport ListModeBase : public ModeHandler
         */
        unsigned int GetLimit(Channel* channel);
 
+       /** Gets the lower list limit for this listmode.
+        */
+       unsigned int GetLowerLimit();
+
        /** Retrieves the list of all modes set on the given channel
         * @param channel Channel to get the list from
         * @return A list with all modes of this type set on the given channel, can be NULL
@@ -134,7 +146,7 @@ class CoreExport ListModeBase : public ModeHandler
         * @param user The user to send the list to
         * @param channel The channel the user is requesting the list for
         */
-       virtual void DisplayList(User* user, Channel* channel);
+       void DisplayList(User* user, Channel* channel) CXX11_OVERRIDE;
 
        /** Tell a user that a list contains no elements.
         * Sends 'eolnum' numeric with text 'eolstr', unless overridden (see constructor)
@@ -142,7 +154,7 @@ class CoreExport ListModeBase : public ModeHandler
         * @param channel The channel that has the empty list
         * See mode.h
         */
-       virtual void DisplayEmptyList(User* user, Channel* channel);
+       void DisplayEmptyList(User* user, Channel* channel) CXX11_OVERRIDE;
 
        /** Remove all instances of the mode from a channel.
         * Populates the given modestack with modes that remove every instance of
@@ -151,7 +163,7 @@ class CoreExport ListModeBase : public ModeHandler
         * @param channel The channel to remove all instances of the mode from
         * @param changelist Mode change list to populate with the removal of this mode
         */
-       virtual void RemoveMode(Channel* channel, Modes::ChangeList& changelist);
+       void RemoveMode(Channel* channel, Modes::ChangeList& changelist) CXX11_OVERRIDE;
 
        /** Perform a rehash of this mode's configuration data
         */
@@ -160,7 +172,7 @@ class CoreExport ListModeBase : public ModeHandler
        /** Handle the list mode.
         * See mode.h
         */
-       virtual ModeAction OnModeChange(User* source, User*, Channel* channel, std::string &parameter, bool adding);
+       ModeAction OnModeChange(User* source, User*, Channel* channel, std::string &parameter, bool adding) CXX11_OVERRIDE;
 
        /** Validate parameters.
         * Overridden by implementing module.
@@ -171,6 +183,15 @@ class CoreExport ListModeBase : public ModeHandler
         */
        virtual bool ValidateParam(User* user, Channel* channel, std::string& parameter);
 
+       /** In the event that the mode should be given a parameter, and no parameter was provided, this method is called.
+        * This allows you to give special information to the user, or handle this any way you like.
+        * @param user The user issuing the mode change
+        * @param dest For user mode changes, the target of the mode. For channel mode changes, NULL.
+        * @param channel For channel mode changes, the target of the mode. For user mode changes, NULL.
+        * See mode.h
+        */
+       virtual void OnParameterMissing(User* user, User* dest, Channel* channel) CXX11_OVERRIDE;
+
        /** Tell the user the list is too long.
         * Overridden by implementing module.
         * @param source Source user adding the parameter