Remove the Kiwi links from the readme.

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

diff --git a/include/cull_list.h b/include/cull_list.h
index 2a0b895f2c8e0964d30a1a9d56ae6c0620f43c44..d29b7b267c21a9fcc5629bbb58222e0f214f8480 100644 (file)
--- a/include/cull_list.h
+++ b/include/cull_list.h
@@ -1,74 +1,69 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
- * See: http://wiki.inspircd.org/Credits
+ *   Copyright (C) 2013, 2017 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2012 Robby <robby@chatbelgie.be>
+ *   Copyright (C) 2011 jackmcbarn <jackmcbarn@inspircd.org>
+ *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ *   Copyright (C) 2005, 2010 Craig Edwards <brain@inspircd.org>
  *
- * This program is free but copyrighted software; see
- *            the file COPYING for details.
+ * 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
+ * License as published by the Free Software Foundation, version 2.
  *
- * ---------------------------------------------------
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#ifndef __CULLLIST_H__
-#define __CULLLIST_H__
 
-/** The CullList class is used by the core to create lists of users
- * prior to actually quitting (and deleting the objects) all at once.
- * 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.
- *
- * NOTE: Don't use this outside core, use the QuitUser method like everyone else!
+#pragma once
+
+/**
+ * The CullList class is used to delete objects at the end of the main loop to
+ * avoid problems with references to deleted pointers if an object were deleted
+ * during execution.
  */
-class CoreExport CullList : public classbase
+class CoreExport CullList
 {
- private:
-       /** Creator of this CullList
+       std::vector<classbase*> list;
+       std::vector<LocalUser*> SQlist;
+
+ public:
+       /** Adds an item to the cull list
         */
-       InspIRCd* ServerInstance;
+       void AddItem(classbase* item) { list.push_back(item); }
+       void AddSQItem(LocalUser* item) { SQlist.push_back(item); }
 
-       /** Holds a list of users being quit.
-        * See the information for CullItem for
-        * more information.
+       /** Applies the cull list (deletes the contents)
         */
-       std::vector<User *> list;
+       void Apply();
+};
 
+/** Represents an action which is executable by an action list */
+class CoreExport ActionBase : public classbase
+{
  public:
-       /** Constructor.
-        * @param Instance Creator of this CullList object
-        */
-       CullList(InspIRCd* Instance);
+        /** Executes this action. */
+       virtual void Call() = 0;
+};
 
-       /** Adds a user to the cull list for later
-        * removal via QUIT.
-        * @param user The user to add
-        * @param reason The quit reason of the user being added
-        * @param o_reason The quit reason to show only to opers
-        */
-       void AddItem(User* user);
+class CoreExport ActionList
+{
+       std::vector<ActionBase*> list;
 
-       /* Turn an item into a silent item (don't send out QUIT for this user)
+ public:
+       /** Adds an item to the list
         */
-       void MakeSilent(User* user);
+       void AddAction(ActionBase* item) { list.push_back(item); }
 
-       /** Applies the cull list, quitting all the users
-        * on the list with their quit reasons all at once.
-        * This is a very fast operation compared to
-        * iterating the user list and comparing each one,
-        * especially if there are multiple comparisons
-        * to be done, or recursion.
+       /** Runs the items
         */
-       void Apply();
-};
-
-#endif
+       void Run();
 
+};