-// include the common header files
-
-#include <string>
-#include <deque>
-#include <vector>
-
-class InspIRCd;
-
-/** The CullItem class holds a user and their quitmessage,
- * and is used internally by the CullList class to compile
- * a list of users which are to be culled when a long
- * operation (such as a netsplit) has completed.
- */
-class CoreExport CullItem : public classbase
-{
- private:
- /** Holds a pointer to the user,
- * must be valid and can be a local or remote user.
- */
- User* user;
- /** Holds the quit reason to use for this user.
- */
- std::string reason;
- /** Holds the quit reason opers see, if different from users
- */
- std::string oper_reason;
- /** Silent items dont generate an snotice.
- */
- bool silent;
- public:
- /** Constrcutor.
- * Initializes the CullItem with a user pointer
- * and their quit reason
- * @param u The user to add
- * @param r The quit reason of the added user
- * @param ro The quit reason to show to opers only
- */
- CullItem(User* u, std::string &r, const char* ro = "");
- /** Constrcutor.
- * Initializes the CullItem with a user pointer
- * and their quit reason
- * @param u The user to add
- * @param r The quit reason of the added user
- * @param ro The quit reason to show to opers only
- */
- CullItem(User* u, const char* r, const char* ro = "");
-
- /** Make the quit silent a module is dealing with
- * displaying this users quit, so we shouldn't
- * send anything out.
- */
- void MakeSilent();
-
- /** Returns true if the quit for this user has been set
- * to silent.
- */
- bool IsSilent();
-
- /** Destructor
- */
- ~CullItem();
-
- /** Returns a pointer to the user
- */
- User* GetUser();
- /** Returns the user's quit reason
- */
- std::string& GetReason();
- /** Returns oper reason
- */
- std::string& GetOperReason();
-};
-
-/** The CullList class can be used by modules, and is used
- * by the core, to compile large lists of users in preperation
- * to quitting them all at once. This is faster than quitting
- * them within the loop, as the loops become tighter with
- * little or no comparisons within them. The CullList class
- * operates by allowing the programmer to push users onto
- * the list, each with a seperate quit reason, and then, once
- * the list is complete, call a method to flush the list,
- * quitting all the users upon it. A CullList may hold local
- * or remote users, but it may only hold each user once. If
- * you attempt to add the same user twice, then the second
- * attempt will be ignored.