--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/src/ai/api/ai_abstractlist.hpp Sat Apr 14 20:17:36 2007 +0000
@@ -0,0 +1,238 @@
+/* $Id$ */
+
+/** @file ai_abstractlist.hpp a linked list which can keep item/value pairs */
+
+#ifndef AI_ABSTRACTLIST_HPP
+#define AI_ABSTRACTLIST_HPP
+
+#include "ai_object.hpp"
+#include <map>
+#include <set>
+
+class AIAbstractListSorter;
+
+/**
+ * Class that creates a linked list which can keep item/value pairs.
+ */
+class AIAbstractList : public AIObject {
+private:
+ AIAbstractListSorter *sorter;
+
+public:
+ typedef std::set<int32> AIItemList; ///< The list of items inside the bucket
+ typedef std::map<int32, AIItemList> AIAbstractListBucket; ///< The bucket list per value
+ typedef std::map<int32, int32> AIAbstractListMap; ///< List per item
+
+ AIAbstractListMap items; ///< The items in the list
+ AIAbstractListBucket buckets; ///< The items in the list, sorted by value
+
+protected:
+ /**
+ * Add a single item to the list.
+ * @param item the item to add. Should be unique, otherwise it is ignored.
+ * @note the value is set to 0 by default.
+ */
+ void AddItem(int32 item);
+
+ /**
+ * Remove a single item from the list.
+ * @param item the item to remove. If not existing, it is ignored.
+ */
+ void RemoveItem(int32 item);
+
+public:
+ /**
+ * The name of the class, needed by several sub-processes.
+ */
+ static const char *GetClassName() { return "AIAbstractList"; }
+
+ /**
+ * Constructor of the AIAbstractList.
+ */
+ AIAbstractList();
+
+ /**
+ * Destructor of the AIAbstractList.
+ */
+ ~AIAbstractList();
+
+ /**
+ * Clear the list, making Count() returning 0 and IsEmpty() returning true.
+ */
+ void Clear();
+
+ /**
+ * Check if an item is in the list.
+ * @param item the item to check for.
+ * @return true if the item is in the list.
+ */
+ bool HasItem(int32 item);
+
+ /**
+ * Go to the beginning of the list.
+ * @return the item value of the first item.
+ */
+ int32 Begin();
+
+ /**
+ * Go to the next item in the list.
+ * @return the item value of the next item.
+ * @note returns 0 if beyond end-of-list. Use HasNext() to check for end-of-list.
+ */
+ int32 Next();
+
+ /**
+ * Check if a list is empty.
+ * @return true if the list is empty.
+ **/
+ bool IsEmpty();
+
+ /**
+ * Check if there is a next element. In other words, if this is true,
+ * Next() will return a valid item.
+ * @return true if there is a next item.
+ */
+ bool HasNext();
+
+ /**
+ * Returns the amount of items in the list.
+ * @return amount of items in the list.
+ */
+ int32 Count();
+
+ /**
+ * Get the value that belongs to this item.
+ * @param item the item to get the value from
+ * @return the value that belongs to this item.
+ */
+ int32 GetValue(int32 item);
+
+ /**
+ * Sort this list by item-value.
+ * @param ascending if true, lowest value is on top, else at bottom.
+ * @note the current item stays at the same place.
+ */
+ void SortByItem(bool ascending);
+
+ /**
+ * Sort this list by the value of the items.
+ * @param ascending if true, lowest value is on top, else at bottom.
+ * @note the current item stays at the same place.
+ */
+ void SortByValue(bool ascending);
+
+ /**
+ * Removes all items with a higher value than 'value'.
+ * @param value the value above which all items are removed.
+ */
+ void RemoveAboveValue(int32 value);
+
+ /**
+ * Removes all items with a lower value than 'value'.
+ * @param value the value below which all items are removed.
+ */
+ void RemoveBelowValue(int32 value);
+
+ /**
+ * Removes all items with a value above start and below end.
+ * @param start the lower bound of the to be removed values (exclusive).
+ * @param end the upper bound of the to be removed valuens (exclusive).
+ */
+ void RemoveBetweenValue(int32 start, int32 end);
+
+ /**
+ * Remove all items with this value.
+ * @param value the value to remove.
+ */
+ void RemoveValue(int32 value);
+
+ /**
+ * Keep all items with a higher value than 'value'.
+ * @param value the value above which all items are kept.
+ */
+ void KeepAboveValue(int32 value);
+
+ /**
+ * Keep all items with a lower value than 'value'.
+ * @param value the value below which all items are kept.
+ */
+ void KeepBelowValue(int32 value);
+
+ /**
+ * Keep all items with a value above start and below end.
+ * @param start the lower bound of the to be kept values (exclusive).
+ * @param end the upper bound of the to be kept values (exclusive).
+ */
+ void KeepBetweenValue(int32 start, int32 end);
+
+ /**
+ * Keep all items with this value.
+ * @param value the value to keep.
+ **/
+ void KeepValue(int32 value);
+
+ /**
+ * The definition how valuators should look.
+ */
+ class Valuator {
+ /* Make this valuator a friend of AIAbstractList, so we can access the private.
+ * Nobody else should ever call Valuate. */
+ friend class AIAbstractList;
+ public:
+ /**
+ * Virtual destructor, needed to make compilers happy.
+ */
+ virtual ~Valuator() {}
+
+ private:
+ virtual int32 Valuate(int32 item) const = 0;
+ };
+
+ /**
+ * Give all items a value defined by the valuator you give.
+ * @note the valuator should be a valid instance.
+ */
+ void Valuate(const AIAbstractList::Valuator &proc);
+};
+
+#ifdef DEFINE_SQUIRREL_CLASS
+namespace SQConvert {
+ /* Allow inner classes/structs to be used as Squirrel parameters */
+ template <> const AIAbstractList::Valuator &GetParam(ForceType<const AIAbstractList::Valuator &>, HSQUIRRELVM vm, int index) { SQUserPointer instance; sq_getinstanceup(vm, index, &instance, 0); return *(AIAbstractList::Valuator *)instance; }
+
+ /* Allow AIAbstractList to be used as Squirrel parameter */
+ template <> AIAbstractList *GetParam(ForceType<AIAbstractList *>, HSQUIRRELVM vm, int index) { SQUserPointer instance; sq_getinstanceup(vm, index, &instance, 0); return (AIAbstractList *)instance; }
+}; // namespace SQConvert
+
+void SQAIAbstractListRegister(Squirrel *engine) {
+ DefSQClass <AIAbstractList> SQAIAbstractList("AIAbstractList");
+ SQAIAbstractList.PreRegister(engine);
+ SQAIAbstractList.AddConstructor(engine);
+
+ SQAIAbstractList.DefSQStaticMethod(engine, &AIAbstractList::GetClassName, "GetClassName", 1, "x");
+
+ SQAIAbstractList.DefSQMethod(engine, &AIAbstractList::Clear, "Clear", 1, "x");
+ SQAIAbstractList.DefSQMethod(engine, &AIAbstractList::HasItem, "HasItem", 2, "xi");
+ SQAIAbstractList.DefSQMethod(engine, &AIAbstractList::Begin, "Begin", 1, "x");
+ SQAIAbstractList.DefSQMethod(engine, &AIAbstractList::Next, "Next", 1, "x");
+ SQAIAbstractList.DefSQMethod(engine, &AIAbstractList::IsEmpty, "IsEmpty", 1, "x");
+ SQAIAbstractList.DefSQMethod(engine, &AIAbstractList::HasNext, "HasNext", 1, "x");
+ SQAIAbstractList.DefSQMethod(engine, &AIAbstractList::Count, "Count", 1, "x");
+ SQAIAbstractList.DefSQMethod(engine, &AIAbstractList::GetValue, "GetValue", 2, "xi");
+ SQAIAbstractList.DefSQMethod(engine, &AIAbstractList::SortByItem, "SortByItem", 2, "xb");
+ SQAIAbstractList.DefSQMethod(engine, &AIAbstractList::SortByValue, "SortByValue", 2, "xb");
+ SQAIAbstractList.DefSQMethod(engine, &AIAbstractList::RemoveAboveValue, "RemoveAboveValue", 2, "xi");
+ SQAIAbstractList.DefSQMethod(engine, &AIAbstractList::RemoveBelowValue, "RemoveBelowValue", 2, "xi");
+ SQAIAbstractList.DefSQMethod(engine, &AIAbstractList::RemoveBetweenValue, "RemoveBetweenValue", 3, "xii");
+ SQAIAbstractList.DefSQMethod(engine, &AIAbstractList::RemoveValue, "RemoveValue", 2, "xi");
+ SQAIAbstractList.DefSQMethod(engine, &AIAbstractList::KeepAboveValue, "KeepAboveValue", 2, "xi");
+ SQAIAbstractList.DefSQMethod(engine, &AIAbstractList::KeepBelowValue, "KeepBelowValue", 2, "xi");
+ SQAIAbstractList.DefSQMethod(engine, &AIAbstractList::KeepBetweenValue, "KeepBetweenValue", 3, "xii");
+ SQAIAbstractList.DefSQMethod(engine, &AIAbstractList::KeepValue, "KeepValue", 2, "xi");
+ SQAIAbstractList.DefSQMethod(engine, &AIAbstractList::Valuate, "Valuate", 2, "xx");
+
+ SQAIAbstractList.PostRegister(engine);
+}
+#endif /* DEFINE_SQUIRREL_CLASS */
+
+#endif /* AI_LIST_HPP */