/* * This file is part of OpenTTD. * OpenTTD 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. * OpenTTD 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 OpenTTD. If not, see . */ /** @file script_list.cpp Implementation of ScriptList. */ #include "../../stdafx.h" #include "script_controller.hpp" #include "script_list.hpp" #include "../../debug.h" #include "../../script/squirrel.hpp" #include "../../safeguards.h" /** * Base class for any ScriptList sorter. */ class ScriptListSorter { protected: ScriptList *list; ///< The list that's being sorted. bool has_no_more_items; ///< Whether we have more items to iterate over. std::optional item_next{}; ///< The next item we will show, or std::nullopt if there are no more items to iterate over. public: /** * Virtual dtor, needed to mute warnings. */ virtual ~ScriptListSorter() = default; /** * Get the first item of the sorter. */ virtual std::optional Begin() = 0; /** * Stop iterating a sorter. */ virtual void End() = 0; /** * Get the next item of the sorter. */ virtual std::optional Next() = 0; /** * See if the sorter has reached the end. */ bool IsEnd() { return this->list->items.empty() || this->has_no_more_items; } /** * Callback from the list if an item gets removed. */ virtual void Remove(SQInteger item) = 0; /** * Attach the sorter to a new list. This assumes the content of the old list has been moved to * the new list, too, so that we don't have to invalidate any iterators. Note that std::swap * doesn't invalidate iterators on lists and maps, so that should be safe. * @param target New list to attach to. */ virtual void Retarget(ScriptList *new_list) { this->list = new_list; } }; /** * Sort by value, ascending. */ class ScriptListSorterValueAscending : public ScriptListSorter { private: ScriptList::ScriptListSet::iterator value_iter; ///< The iterator over the value/item pairs in the set. public: /** * Create a new sorter. * @param list The list to sort. */ ScriptListSorterValueAscending(ScriptList *list) { this->list = list; this->End(); } std::optional Begin() override { if (this->list->values.empty()) { this->item_next = std::nullopt; return std::nullopt; } this->has_no_more_items = false; this->value_iter = this->list->values.begin(); this->item_next = this->value_iter->second; std::optional item_current = this->item_next; this->FindNext(); return item_current; } void End() override { this->item_next = std::nullopt; this->has_no_more_items = true; } /** * Find the next item, and store that information. */ void FindNext() { this->item_next = std::nullopt; if (this->value_iter == this->list->values.end()) { this->has_no_more_items = true; return; } ++this->value_iter; if (this->value_iter != this->list->values.end()) this->item_next = this->value_iter->second; } std::optional Next() override { if (this->IsEnd()) return std::nullopt; std::optional item_current = this->item_next; this->FindNext(); return item_current; } void Remove(SQInteger item) override { if (this->IsEnd()) return; /* If we remove the 'next' item, skip to the next */ if (item == this->item_next) { this->FindNext(); return; } } }; /** * Sort by value, descending. */ class ScriptListSorterValueDescending : public ScriptListSorter { private: /* Note: We cannot use reverse_iterator. * The iterators must only be invalidated when the element they are pointing to is removed. * This only holds for forward iterators. */ ScriptList::ScriptListSet::iterator value_iter; ///< The iterator over the value/item pairs in the set. public: /** * Create a new sorter. * @param list The list to sort. */ ScriptListSorterValueDescending(ScriptList *list) { this->list = list; this->End(); } std::optional Begin() override { if (this->list->values.empty()) { this->item_next = std::nullopt; return std::nullopt; } this->has_no_more_items = false; this->value_iter = this->list->values.end(); --this->value_iter; this->item_next = this->value_iter->second; std::optional item_current = this->item_next; this->FindNext(); return item_current; } void End() override { this->item_next = std::nullopt; this->has_no_more_items = true; } /** * Find the next item, and store that information. */ void FindNext() { this->item_next = std::nullopt; if (this->value_iter == this->list->values.end()) { this->has_no_more_items = true; return; } if (this->value_iter == this->list->values.begin()) { /* Use 'end' as marker for 'beyond begin' */ this->value_iter = this->list->values.end(); } else { --this->value_iter; } if (this->value_iter != this->list->values.end()) this->item_next = this->value_iter->second; } std::optional Next() override { if (this->IsEnd()) return std::nullopt; std::optional item_current = this->item_next; this->FindNext(); return item_current; } void Remove(SQInteger item) override { if (this->IsEnd()) return; /* If we remove the 'next' item, skip to the next */ if (item == this->item_next) { this->FindNext(); return; } } }; /** * Sort by item, ascending. */ class ScriptListSorterItemAscending : public ScriptListSorter { private: ScriptList::ScriptListMap::iterator item_iter; ///< The iterator over the items in the map. public: /** * Create a new sorter. * @param list The list to sort. */ ScriptListSorterItemAscending(ScriptList *list) { this->list = list; this->End(); } std::optional Begin() override { if (this->list->items.empty()) { this->item_next = std::nullopt; return std::nullopt; } this->has_no_more_items = false; this->item_iter = this->list->items.begin(); this->item_next = this->item_iter->first; std::optional item_current = this->item_next; this->FindNext(); return item_current; } void End() override { this->item_next = std::nullopt; this->has_no_more_items = true; } /** * Find the next item, and store that information. */ void FindNext() { this->item_next = std::nullopt; if (this->item_iter == this->list->items.end()) { this->has_no_more_items = true; return; } ++this->item_iter; if (this->item_iter != this->list->items.end()) this->item_next = this->item_iter->first; } std::optional Next() override { if (this->IsEnd()) return std::nullopt; std::optional item_current = this->item_next; this->FindNext(); return item_current; } void Remove(SQInteger item) override { if (this->IsEnd()) return; /* If we remove the 'next' item, skip to the next */ if (item == this->item_next) { this->FindNext(); return; } } }; /** * Sort by item, descending. */ class ScriptListSorterItemDescending : public ScriptListSorter { private: /* Note: We cannot use reverse_iterator. * The iterators must only be invalidated when the element they are pointing to is removed. * This only holds for forward iterators. */ ScriptList::ScriptListMap::iterator item_iter; ///< The iterator over the items in the map. public: /** * Create a new sorter. * @param list The list to sort. */ ScriptListSorterItemDescending(ScriptList *list) { this->list = list; this->End(); } std::optional Begin() override { if (this->list->items.empty()) { this->item_next = std::nullopt; return std::nullopt; } this->has_no_more_items = false; this->item_iter = this->list->items.end(); --this->item_iter; this->item_next = this->item_iter->first; std::optional item_current = this->item_next; this->FindNext(); return item_current; } void End() override { this->item_next = std::nullopt; this->has_no_more_items = true; } /** * Find the next item, and store that information. */ void FindNext() { this->item_next = std::nullopt; if (this->item_iter == this->list->items.end()) { this->has_no_more_items = true; return; } if (this->item_iter == this->list->items.begin()) { /* Use 'end' as marker for 'beyond begin' */ this->item_iter = this->list->items.end(); } else { --this->item_iter; } if (this->item_iter != this->list->items.end()) this->item_next = this->item_iter->first; } std::optional Next() override { if (this->IsEnd()) return std::nullopt; std::optional item_current = this->item_next; this->FindNext(); return item_current; } void Remove(SQInteger item) override { if (this->IsEnd()) return; /* If we remove the 'next' item, skip to the next */ if (item == this->item_next) { this->FindNext(); return; } } }; bool ScriptList::SaveObject(HSQUIRRELVM vm) { sq_pushstring(vm, "List"); sq_newarray(vm, 0); sq_pushinteger(vm, this->sorter_type); sq_arrayappend(vm, -2); sq_pushbool(vm, this->sort_ascending ? SQTrue : SQFalse); sq_arrayappend(vm, -2); sq_newtable(vm); for (const auto &item : this->items) { sq_pushinteger(vm, item.first); sq_pushinteger(vm, item.second); sq_rawset(vm, -3); } sq_arrayappend(vm, -2); return true; } bool ScriptList::LoadObject(HSQUIRRELVM vm) { if (sq_gettype(vm, -1) != OT_ARRAY) return false; sq_pushnull(vm); if (SQ_FAILED(sq_next(vm, -2))) return false; if (sq_gettype(vm, -1) != OT_INTEGER) return false; SQInteger type; sq_getinteger(vm, -1, &type); sq_pop(vm, 2); if (SQ_FAILED(sq_next(vm, -2))) return false; if (sq_gettype(vm, -1) != OT_BOOL) return false; SQBool order; sq_getbool(vm, -1, &order); sq_pop(vm, 2); if (SQ_FAILED(sq_next(vm, -2))) return false; if (sq_gettype(vm, -1) != OT_TABLE) return false; sq_pushnull(vm); while (SQ_SUCCEEDED(sq_next(vm, -2))) { if (sq_gettype(vm, -2) != OT_INTEGER && sq_gettype(vm, -1) != OT_INTEGER) return false; SQInteger key, value; sq_getinteger(vm, -2, &key); sq_getinteger(vm, -1, &value); this->AddItem(key, value); sq_pop(vm, 2); } sq_pop(vm, 3); if (SQ_SUCCEEDED(sq_next(vm, -2))) return false; sq_pop(vm, 1); this->Sort(static_cast(type), order == SQTrue); return true; } ScriptObject *ScriptList::CloneObject() { ScriptList *clone = new ScriptList(); clone->CopyList(this); return clone; } void ScriptList::CopyList(const ScriptList *list) { this->Sort(list->sorter_type, list->sort_ascending); this->items = list->items; this->values = list->values; } ScriptList::ScriptList() { /* Default sorter */ this->sorter = std::make_unique(this); this->sorter_type = SORT_BY_VALUE; this->sort_ascending = false; this->initialized = false; this->modifications = 0; } ScriptList::~ScriptList() { } bool ScriptList::HasItem(SQInteger item) { return this->items.count(item) == 1; } void ScriptList::Clear() { this->modifications++; this->items.clear(); this->values.clear(); this->sorter->End(); } void ScriptList::AddItem(SQInteger item, SQInteger value) { this->modifications++; if (this->HasItem(item)) return; this->items[item] = value; this->values.emplace(value, item); } void ScriptList::RemoveItem(SQInteger item) { this->modifications++; auto item_iter = this->items.find(item); if (item_iter == this->items.end()) return; SQInteger value = item_iter->second; this->sorter->Remove(item); auto value_iter = this->values.find({value, item}); assert(value_iter != this->values.end()); this->values.erase(value_iter); this->items.erase(item_iter); } SQInteger ScriptList::Begin() { this->initialized = true; return this->sorter->Begin().value_or(0); } SQInteger ScriptList::Next() { if (!this->initialized) { Debug(script, 0, "Next() is invalid as Begin() is never called"); return 0; } return this->sorter->Next().value_or(0); } bool ScriptList::IsEmpty() { return this->items.empty(); } bool ScriptList::IsEnd() { if (!this->initialized) { Debug(script, 0, "IsEnd() is invalid as Begin() is never called"); return true; } return this->sorter->IsEnd(); } SQInteger ScriptList::Count() { return this->items.size(); } SQInteger ScriptList::GetValue(SQInteger item) { auto item_iter = this->items.find(item); return item_iter == this->items.end() ? 0 : item_iter->second; } bool ScriptList::SetValue(SQInteger item, SQInteger value) { this->modifications++; auto item_iter = this->items.find(item); if (item_iter == this->items.end()) return false; SQInteger value_old = item_iter->second; if (value_old == value) return true; this->sorter->Remove(item); auto value_iter = this->values.find({value_old, item}); assert(value_iter != this->values.end()); this->values.erase(value_iter); item_iter->second = value; this->values.emplace(value, item); return true; } void ScriptList::Sort(SorterType sorter, bool ascending) { this->modifications++; if (sorter != SORT_BY_VALUE && sorter != SORT_BY_ITEM) return; if (sorter == this->sorter_type && ascending == this->sort_ascending) return; switch (sorter) { case SORT_BY_ITEM: if (ascending) { this->sorter = std::make_unique(this); } else { this->sorter = std::make_unique(this); } break; case SORT_BY_VALUE: if (ascending) { this->sorter = std::make_unique(this); } else { this->sorter = std::make_unique(this); } break; default: NOT_REACHED(); } this->sorter_type = sorter; this->sort_ascending = ascending; this->initialized = false; } void ScriptList::AddList(ScriptList *list) { if (list == this) return; if (this->IsEmpty()) { /* If this is empty, we can just take the items of the other list as is. */ this->items = list->items; this->values = list->values; this->modifications++; } else { for (const auto &item : list->items) { this->AddItem(item.first); this->SetValue(item.first, item.second); } } } void ScriptList::SwapList(ScriptList *list) { if (list == this) return; this->items.swap(list->items); this->values.swap(list->values); std::swap(this->sorter, list->sorter); std::swap(this->sorter_type, list->sorter_type); std::swap(this->sort_ascending, list->sort_ascending); std::swap(this->initialized, list->initialized); std::swap(this->modifications, list->modifications); this->sorter->Retarget(this); list->sorter->Retarget(list); } void ScriptList::RemoveAboveValue(SQInteger value) { this->RemoveItems([&](const SQInteger &, const SQInteger &v) { return v > value; }); } void ScriptList::RemoveBelowValue(SQInteger value) { this->RemoveItems([&](const SQInteger &, const SQInteger &v) { return v < value; }); } void ScriptList::RemoveBetweenValue(SQInteger start, SQInteger end) { this->RemoveItems([&](const SQInteger &, const SQInteger &v) { return v > start && v < end; }); } void ScriptList::RemoveValue(SQInteger value) { this->RemoveItems([&](const SQInteger &, const SQInteger &v) { return v == value; }); } void ScriptList::RemoveTop(SQInteger count) { this->modifications++; if (!this->sort_ascending) { this->Sort(this->sorter_type, !this->sort_ascending); this->RemoveBottom(count); this->Sort(this->sorter_type, !this->sort_ascending); return; } switch (this->sorter_type) { default: NOT_REACHED(); case SORT_BY_VALUE: for (auto iter = this->values.begin(); iter != this->values.end(); iter = this->values.begin()) { if (--count < 0) return; this->RemoveItem(iter->second); } break; case SORT_BY_ITEM: for (auto iter = this->items.begin(); iter != this->items.end(); iter = this->items.begin()) { if (--count < 0) return; this->RemoveItem(iter->first); } break; } } void ScriptList::RemoveBottom(SQInteger count) { this->modifications++; if (!this->sort_ascending) { this->Sort(this->sorter_type, !this->sort_ascending); this->RemoveTop(count); this->Sort(this->sorter_type, !this->sort_ascending); return; } switch (this->sorter_type) { default: NOT_REACHED(); case SORT_BY_VALUE: for (auto iter = this->values.rbegin(); iter != this->values.rend(); iter = this->values.rbegin()) { if (--count < 0) return; this->RemoveItem(iter->second); } break; case SORT_BY_ITEM: for (auto iter = this->items.rbegin(); iter != this->items.rend(); iter = this->items.rbegin()) { if (--count < 0) return; this->RemoveItem(iter->first); } break; } } void ScriptList::RemoveList(ScriptList *list) { if (list == this) { this->Clear(); return; } this->RemoveItems([&](const SQInteger &k, const SQInteger &) { return list->HasItem(k); }); } void ScriptList::KeepAboveValue(SQInteger value) { this->RemoveItems([&](const SQInteger &, const SQInteger &v) { return v <= value; }); } void ScriptList::KeepBelowValue(SQInteger value) { this->RemoveItems([&](const SQInteger &, const SQInteger &v) { return v >= value; }); } void ScriptList::KeepBetweenValue(SQInteger start, SQInteger end) { this->RemoveItems([&](const SQInteger &, const SQInteger &v) { return v <= start && v >= end; }); } void ScriptList::KeepValue(SQInteger value) { this->RemoveItems([&](const SQInteger &, const SQInteger &v) { return v != value; }); } void ScriptList::KeepTop(SQInteger count) { this->modifications++; this->RemoveBottom(this->Count() - count); } void ScriptList::KeepBottom(SQInteger count) { this->modifications++; this->RemoveTop(this->Count() - count); } void ScriptList::KeepList(ScriptList *list) { if (list == this) return; this->RemoveItems([&](const SQInteger &k, const SQInteger &) { return !list->HasItem(k); }); } SQInteger ScriptList::_get(HSQUIRRELVM vm) { if (sq_gettype(vm, 2) != OT_INTEGER) return SQ_ERROR; SQInteger idx; sq_getinteger(vm, 2, &idx); auto item_iter = this->items.find(idx); if (item_iter == this->items.end()) return SQ_ERROR; sq_pushinteger(vm, item_iter->second); return 1; } SQInteger ScriptList::_set(HSQUIRRELVM vm) { if (sq_gettype(vm, 2) != OT_INTEGER) return SQ_ERROR; SQInteger idx; sq_getinteger(vm, 2, &idx); /* Retrieve the return value */ SQInteger val; switch (sq_gettype(vm, 3)) { case OT_NULL: this->RemoveItem(idx); return 0; case OT_BOOL: { SQBool v; sq_getbool(vm, 3, &v); val = v ? 1 : 0; break; } case OT_INTEGER: sq_getinteger(vm, 3, &val); break; default: return sq_throwerror(vm, "you can only assign integers to this list"); } if (!this->HasItem(idx)) { this->AddItem(idx, val); return 0; } this->SetValue(idx, val); return 0; } SQInteger ScriptList::_nexti(HSQUIRRELVM vm) { if (sq_gettype(vm, 2) == OT_NULL) { if (this->IsEmpty()) { sq_pushnull(vm); return 1; } sq_pushinteger(vm, this->Begin()); return 1; } SQInteger idx; sq_getinteger(vm, 2, &idx); SQInteger val = this->Next(); if (this->IsEnd()) { sq_pushnull(vm); return 1; } sq_pushinteger(vm, val); return 1; } SQInteger ScriptList::Valuate(HSQUIRRELVM vm) { this->modifications++; /* The first parameter is the instance of ScriptList. */ int nparam = sq_gettop(vm) - 1; if (nparam < 1) { return sq_throwerror(vm, "You need to give at least a Valuator as parameter to ScriptList::Valuate"); } /* Make sure the valuator function is really a function, and not any * other type. It's parameter 2 for us, but for the user it's the * first parameter they give. */ SQObjectType valuator_type = sq_gettype(vm, 2); if (valuator_type != OT_CLOSURE && valuator_type != OT_NATIVECLOSURE) { return sq_throwerror(vm, "parameter 1 has an invalid type (expected function)"); } /* Don't allow docommand from a Valuator, as we can't resume in * mid C++-code. */ ScriptObject::DisableDoCommandScope disabler{}; /* Limit the total number of ops that can be consumed by a valuate operation */ SQOpsLimiter limiter(vm, MAX_VALUATE_OPS, "valuator function"); /* Push the function to call */ sq_push(vm, 2); auto begin = this->items.begin(); if (disabler.GetOriginalValue() && this->resume_item.has_value()) { begin = this->items.lower_bound(this->resume_item.value()); } for (const auto &[item, _] : std::ranges::subrange(begin, this->items.end())) { if (disabler.GetOriginalValue() && item != this->resume_item && ScriptController::GetOpsTillSuspend() < 0) { this->resume_item = item; /* Pop the valuator function. */ sq_poptop(vm); sq_pushbool(vm, SQTrue); return 1; } /* Check for changing of items. */ int previous_modification_count = this->modifications; /* Push the root table as instance object, this is what squirrel does for meta-functions. */ sq_pushroottable(vm); /* Push all arguments for the valuator function. */ sq_pushinteger(vm, item); for (int i = 0; i < nparam - 1; i++) { sq_push(vm, i + 3); } /* Call the function. Squirrel pops all parameters and pushes the return value. */ if (SQ_FAILED(sq_call(vm, nparam + 1, SQTrue, SQFalse))) { return SQ_ERROR; } /* Retrieve the return value */ SQInteger value; switch (sq_gettype(vm, -1)) { case OT_INTEGER: { sq_getinteger(vm, -1, &value); break; } case OT_BOOL: { SQBool v; sq_getbool(vm, -1, &v); value = v ? 1 : 0; break; } default: { /* Pop the valuator function and the return value. */ sq_pop(vm, 2); return sq_throwerror(vm, "return value of valuator is not valid (not integer/bool)"); } } /* Was something changed? */ if (previous_modification_count != this->modifications) { /* Pop the valuator function and the return value. */ sq_pop(vm, 2); return sq_throwerror(vm, "modifying valuated list outside of valuator function"); } this->SetValue(item, value); /* Pop the return value. */ sq_poptop(vm); Squirrel::DecreaseOps(vm, 5); } /* Pop the valuator function from the squirrel stack. */ sq_poptop(vm); this->resume_item.reset(); sq_pushbool(vm, SQFalse); return 1; }