OpenRCT2/src/openrct2/object/ObjectManager.cpp

728 lines
23 KiB
C++

/*****************************************************************************
* Copyright (c) 2014-2020 OpenRCT2 developers
*
* For a complete list of all authors, please refer to contributors.md
* Interested in contributing? Visit https://github.com/OpenRCT2/OpenRCT2
*
* OpenRCT2 is licensed under the GNU General Public License version 3.
*****************************************************************************/
#include "ObjectManager.h"
#include "../Context.h"
#include "../ParkImporter.h"
#include "../core/Console.hpp"
#include "../core/Memory.hpp"
#include "../localisation/StringIds.h"
#include "../util/Util.h"
#include "FootpathItemObject.h"
#include "LargeSceneryObject.h"
#include "Object.h"
#include "ObjectList.h"
#include "ObjectRepository.h"
#include "RideObject.h"
#include "SceneryGroupObject.h"
#include "SmallSceneryObject.h"
#include "WallObject.h"
#include <algorithm>
#include <array>
#include <memory>
#include <mutex>
#include <thread>
#include <unordered_set>
class ObjectManager final : public IObjectManager
{
private:
IObjectRepository& _objectRepository;
std::vector<Object*> _loadedObjects;
std::array<std::vector<ObjectEntryIndex>, RIDE_TYPE_COUNT> _rideTypeToObjectMap;
// Used to return a safe empty vector back from GetAllRideEntries, can be removed when std::span is available
std::vector<ObjectEntryIndex> _nullRideTypeEntries;
public:
explicit ObjectManager(IObjectRepository& objectRepository)
: _objectRepository(objectRepository)
{
_loadedObjects.resize(OBJECT_ENTRY_COUNT);
UpdateSceneryGroupIndexes();
ResetTypeToRideEntryIndexMap();
}
~ObjectManager() override
{
UnloadAll();
}
Object* GetLoadedObject(size_t index) override
{
if (index >= _loadedObjects.size())
{
return nullptr;
}
return _loadedObjects[index];
}
Object* GetLoadedObject(ObjectType objectType, size_t index) override
{
// This is sometimes done deliberately (to avoid boilerplate), so no need to log_warn for this.
if (index == OBJECT_ENTRY_INDEX_NULL)
{
return nullptr;
}
if (index >= static_cast<size_t>(object_entry_group_counts[EnumValue(objectType)]))
{
#ifdef DEBUG
if (index != OBJECT_ENTRY_INDEX_NULL)
{
log_warning("Object index %u exceeds maximum for type %d.", index, objectType);
}
#endif
return nullptr;
}
auto objectIndex = GetIndexFromTypeEntry(objectType, index);
return GetLoadedObject(objectIndex);
}
Object* GetLoadedObject(const ObjectEntryDescriptor& entry) override
{
const ObjectRepositoryItem* ori = _objectRepository.FindObject(entry);
if (ori == nullptr)
return nullptr;
return ori->LoadedObject.get();
}
ObjectEntryIndex GetLoadedObjectEntryIndex(std::string_view identifier) override
{
const auto* obj = GetLoadedObject(ObjectEntryDescriptor(identifier));
if (obj != nullptr)
{
return GetLoadedObjectEntryIndex(obj);
}
return OBJECT_ENTRY_INDEX_NULL;
}
ObjectEntryIndex GetLoadedObjectEntryIndex(const ObjectEntryDescriptor& descriptor) override
{
auto obj = GetLoadedObject(descriptor);
if (obj != nullptr)
{
return GetLoadedObjectEntryIndex(obj);
}
return OBJECT_ENTRY_INDEX_NULL;
}
ObjectEntryIndex GetLoadedObjectEntryIndex(const Object* object) override
{
ObjectEntryIndex result = OBJECT_ENTRY_INDEX_NULL;
size_t index = GetLoadedObjectIndex(object);
if (index != SIZE_MAX)
{
get_type_entry_index(index, nullptr, &result);
}
return result;
}
ObjectList GetLoadedObjects() override
{
ObjectList objectList;
for (auto objectType = ObjectType::Ride; objectType < ObjectType::Count; objectType++)
{
auto maxObjectsOfType = static_cast<ObjectEntryIndex>(object_entry_group_counts[EnumValue(objectType)]);
for (ObjectEntryIndex i = 0; i < maxObjectsOfType; i++)
{
auto obj = GetLoadedObject(objectType, i);
if (obj != nullptr)
{
objectList.SetObject(i, obj->GetDescriptor());
}
}
}
return objectList;
}
Object* LoadObject(std::string_view identifier) override
{
const ObjectRepositoryItem* ori = _objectRepository.FindObject(identifier);
return RepositoryItemToObject(ori);
}
Object* LoadObject(const rct_object_entry* entry) override
{
const ObjectRepositoryItem* ori = _objectRepository.FindObject(entry);
return RepositoryItemToObject(ori);
}
Object* LoadObject(const ObjectEntryDescriptor& descriptor) override
{
const ObjectRepositoryItem* ori = _objectRepository.FindObject(descriptor);
return RepositoryItemToObject(ori);
}
void LoadObjects(const ObjectList& objectList) override
{
// Find all the required objects
auto requiredObjects = GetRequiredObjects(objectList);
// Load the required objects
LoadObjects(requiredObjects);
// Update indices.
UpdateSceneryGroupIndexes();
ResetTypeToRideEntryIndexMap();
}
void UnloadObjects(const std::vector<ObjectEntryDescriptor>& entries) override
{
// TODO there are two performance issues here:
// - FindObject for every entry which is a dictionary lookup
// - GetLoadedObjectIndex for every entry which enumerates _loadedList
size_t numObjectsUnloaded = 0;
for (const auto& descriptor : entries)
{
const auto* ori = _objectRepository.FindObject(descriptor);
if (ori != nullptr)
{
auto* loadedObject = ori->LoadedObject.get();
if (loadedObject != nullptr)
{
UnloadObject(loadedObject);
numObjectsUnloaded++;
}
}
}
if (numObjectsUnloaded > 0)
{
UpdateSceneryGroupIndexes();
ResetTypeToRideEntryIndexMap();
}
}
void UnloadAll() override
{
for (auto* object : _loadedObjects)
{
UnloadObject(object);
}
UpdateSceneryGroupIndexes();
ResetTypeToRideEntryIndexMap();
}
void ResetObjects() override
{
for (auto& loadedObject : _loadedObjects)
{
if (loadedObject != nullptr)
{
loadedObject->Unload();
loadedObject->Load();
}
}
UpdateSceneryGroupIndexes();
ResetTypeToRideEntryIndexMap();
}
std::vector<const ObjectRepositoryItem*> GetPackableObjects() override
{
std::vector<const ObjectRepositoryItem*> objects;
size_t numObjects = _objectRepository.GetNumObjects();
for (size_t i = 0; i < numObjects; i++)
{
const ObjectRepositoryItem* item = &_objectRepository.GetObjects()[i];
if (item->LoadedObject != nullptr && IsObjectCustom(item) && item->LoadedObject->GetLegacyData() != nullptr)
{
objects.push_back(item);
}
}
return objects;
}
static rct_string_id GetObjectSourceGameString(const ObjectSourceGame sourceGame)
{
switch (sourceGame)
{
case ObjectSourceGame::RCT1:
return STR_SCENARIO_CATEGORY_RCT1;
case ObjectSourceGame::AddedAttractions:
return STR_SCENARIO_CATEGORY_RCT1_AA;
case ObjectSourceGame::LoopyLandscapes:
return STR_SCENARIO_CATEGORY_RCT1_LL;
case ObjectSourceGame::RCT2:
return STR_ROLLERCOASTER_TYCOON_2_DROPDOWN;
case ObjectSourceGame::WackyWorlds:
return STR_OBJECT_FILTER_WW;
case ObjectSourceGame::TimeTwister:
return STR_OBJECT_FILTER_TT;
case ObjectSourceGame::OpenRCT2Official:
return STR_OBJECT_FILTER_OPENRCT2_OFFICIAL;
default:
return STR_OBJECT_FILTER_CUSTOM;
}
}
const std::vector<ObjectEntryIndex>& GetAllRideEntries(uint8_t rideType) override
{
if (rideType >= RIDE_TYPE_COUNT)
{
// Return an empty vector
return _nullRideTypeEntries;
}
return _rideTypeToObjectMap[rideType];
}
private:
Object* LoadObject(int32_t slot, std::string_view identifier)
{
const ObjectRepositoryItem* ori = _objectRepository.FindObject(identifier);
return RepositoryItemToObject(ori, slot);
}
Object* RepositoryItemToObject(const ObjectRepositoryItem* ori, std::optional<int32_t> slot = {})
{
if (ori == nullptr)
return nullptr;
Object* loadedObject = ori->LoadedObject.get();
if (loadedObject != nullptr)
return loadedObject;
ObjectType objectType = ori->Type;
if (slot)
{
if (_loadedObjects.size() > static_cast<size_t>(*slot) && _loadedObjects[*slot] != nullptr)
{
// Slot already taken
return nullptr;
}
}
else
{
slot = FindSpareSlot(objectType);
}
if (slot.has_value())
{
auto* object = GetOrLoadObject(ori);
if (object != nullptr)
{
if (_loadedObjects.size() <= static_cast<size_t>(*slot))
{
_loadedObjects.resize(slot.value() + 1);
}
loadedObject = object;
_loadedObjects[slot.value()] = object;
UpdateSceneryGroupIndexes();
ResetTypeToRideEntryIndexMap();
}
}
return loadedObject;
}
std::optional<int32_t> FindSpareSlot(ObjectType objectType)
{
size_t firstIndex = GetIndexFromTypeEntry(objectType, 0);
size_t endIndex = firstIndex + object_entry_group_counts[EnumValue(objectType)];
for (size_t i = firstIndex; i < endIndex; i++)
{
if (_loadedObjects.size() <= i)
{
_loadedObjects.resize(i + 1);
return static_cast<int32_t>(i);
}
if (_loadedObjects[i] == nullptr)
{
return static_cast<int32_t>(i);
}
}
return std::nullopt;
}
size_t GetLoadedObjectIndex(const Object* object)
{
Guard::ArgumentNotNull(object, GUARD_LINE);
auto result = std::numeric_limits<size_t>().max();
auto it = std::find(_loadedObjects.begin(), _loadedObjects.end(), object);
if (it != _loadedObjects.end())
{
result = std::distance(_loadedObjects.begin(), it);
}
return result;
}
void UnloadObject(Object* object)
{
if (object == nullptr)
return;
object->Unload();
// TODO try to prevent doing a repository search
const auto* ori = _objectRepository.FindObject(object->GetDescriptor());
if (ori != nullptr)
{
_objectRepository.UnregisterLoadedObject(ori, object);
}
// Because it's possible to have the same loaded object for multiple
// slots, we have to make sure find and set all of them to nullptr
std::replace(_loadedObjects.begin(), _loadedObjects.end(), object, static_cast<Object*>(nullptr));
}
void UnloadObjectsExcept(const std::vector<Object*>& newLoadedObjects)
{
// Build a hash set for quick checking
auto exceptSet = std::unordered_set<Object*>();
for (auto& object : newLoadedObjects)
{
if (object != nullptr)
{
exceptSet.insert(object);
}
}
// Unload objects that are not in the hash set
size_t totalObjectsLoaded = 0;
size_t numObjectsUnloaded = 0;
for (auto* object : _loadedObjects)
{
if (object == nullptr)
continue;
totalObjectsLoaded++;
if (exceptSet.find(object) == exceptSet.end())
{
UnloadObject(object);
numObjectsUnloaded++;
}
}
log_verbose("%u / %u objects unloaded", numObjectsUnloaded, totalObjectsLoaded);
}
template<typename T> void UpdateSceneryGroupIndexes(Object* object)
{
auto* sceneryEntry = static_cast<T*>(object->GetLegacyData());
sceneryEntry->scenery_tab_id = GetPrimarySceneryGroupEntryIndex(object);
}
void UpdateSceneryGroupIndexes()
{
for (auto* loadedObject : _loadedObjects)
{
// The list can contain unused slots, skip them.
if (loadedObject == nullptr)
continue;
switch (loadedObject->GetObjectType())
{
case ObjectType::SmallScenery:
UpdateSceneryGroupIndexes<SmallSceneryEntry>(loadedObject);
break;
case ObjectType::LargeScenery:
UpdateSceneryGroupIndexes<LargeSceneryEntry>(loadedObject);
break;
case ObjectType::Walls:
UpdateSceneryGroupIndexes<WallSceneryEntry>(loadedObject);
break;
case ObjectType::Banners:
UpdateSceneryGroupIndexes<BannerSceneryEntry>(loadedObject);
break;
case ObjectType::PathBits:
UpdateSceneryGroupIndexes<PathBitEntry>(loadedObject);
break;
case ObjectType::SceneryGroup:
{
auto sgObject = dynamic_cast<SceneryGroupObject*>(loadedObject);
sgObject->UpdateEntryIndexes();
break;
}
default:
// This switch only handles scenery ObjectTypes.
break;
}
}
// HACK Scenery window will lose its tabs after changing the scenery group indexing
// for now just close it, but it will be better to later tell it to invalidate the tabs
window_close_by_class(WC_SCENERY);
}
ObjectEntryIndex GetPrimarySceneryGroupEntryIndex(Object* loadedObject)
{
auto* sceneryObject = dynamic_cast<SceneryObject*>(loadedObject);
const auto& primarySGEntry = sceneryObject->GetPrimarySceneryGroup();
Object* sgObject = GetLoadedObject(primarySGEntry);
auto entryIndex = OBJECT_ENTRY_INDEX_NULL;
if (sgObject != nullptr)
{
entryIndex = GetLoadedObjectEntryIndex(sgObject);
}
return entryIndex;
}
std::vector<const ObjectRepositoryItem*> GetRequiredObjects(const ObjectList& objectList)
{
std::vector<const ObjectRepositoryItem*> requiredObjects;
std::vector<ObjectEntryDescriptor> missingObjects;
for (auto objectType = ObjectType::Ride; objectType < ObjectType::Count; objectType++)
{
auto maxObjectsOfType = static_cast<ObjectEntryIndex>(object_entry_group_counts[EnumValue(objectType)]);
for (ObjectEntryIndex i = 0; i < maxObjectsOfType; i++)
{
const ObjectRepositoryItem* ori = nullptr;
const auto& entry = objectList.GetObject(objectType, i);
if (entry.HasValue())
{
ori = _objectRepository.FindObject(entry);
if (ori == nullptr && entry.GetType() != ObjectType::ScenarioText)
{
missingObjects.push_back(entry);
ReportMissingObject(entry);
}
}
requiredObjects.push_back(ori);
}
}
if (!missingObjects.empty())
{
throw ObjectLoadException(std::move(missingObjects));
}
return requiredObjects;
}
template<typename T, typename TFunc> static void ParallelFor(const std::vector<T>& items, TFunc func)
{
auto partitions = std::thread::hardware_concurrency();
auto partitionSize = (items.size() + (partitions - 1)) / partitions;
std::vector<std::thread> threads;
for (size_t n = 0; n < partitions; n++)
{
auto begin = n * partitionSize;
auto end = std::min(items.size(), begin + partitionSize);
threads.emplace_back(
[func](size_t pbegin, size_t pend) {
for (size_t i = pbegin; i < pend; i++)
{
func(i);
}
},
begin, end);
}
for (auto& t : threads)
{
t.join();
}
}
void LoadObjects(std::vector<const ObjectRepositoryItem*>& requiredObjects)
{
std::vector<Object*> objects;
std::vector<Object*> newLoadedObjects;
std::vector<ObjectEntryDescriptor> badObjects;
objects.resize(OBJECT_ENTRY_COUNT);
newLoadedObjects.reserve(OBJECT_ENTRY_COUNT);
// Read objects
std::mutex commonMutex;
ParallelFor(requiredObjects, [this, &commonMutex, requiredObjects, &objects, &badObjects, &newLoadedObjects](size_t i) {
auto* requiredObject = requiredObjects[i];
Object* object = nullptr;
if (requiredObject != nullptr)
{
auto* loadedObject = requiredObject->LoadedObject.get();
if (loadedObject == nullptr)
{
// Object requires to be loaded, if the object successfully loads it will register it
// as a loaded object otherwise placed into the badObjects list.
auto newObject = _objectRepository.LoadObject(requiredObject);
std::lock_guard<std::mutex> guard(commonMutex);
if (newObject == nullptr)
{
badObjects.push_back(ObjectEntryDescriptor(requiredObject->ObjectEntry));
ReportObjectLoadProblem(&requiredObject->ObjectEntry);
}
else
{
object = newObject.get();
newLoadedObjects.push_back(object);
// Connect the ori to the registered object
_objectRepository.RegisterLoadedObject(requiredObject, std::move(newObject));
}
}
else
{
object = loadedObject;
}
}
objects[i] = object;
});
// Load objects
for (auto* obj : newLoadedObjects)
{
obj->Load();
}
if (!badObjects.empty())
{
// Unload all the new objects we loaded
for (auto* object : newLoadedObjects)
{
UnloadObject(object);
}
throw ObjectLoadException(std::move(badObjects));
}
// Unload objects which are not in the required list.
if (objects.empty())
{
UnloadAll();
}
else
{
UnloadObjectsExcept(objects);
}
_loadedObjects = std::move(objects);
log_verbose("%u / %u new objects loaded", newLoadedObjects.size(), requiredObjects.size());
}
Object* GetOrLoadObject(const ObjectRepositoryItem* ori)
{
auto* loadedObject = ori->LoadedObject.get();
if (loadedObject != nullptr)
return loadedObject;
// Try to load object
auto object = _objectRepository.LoadObject(ori);
if (object != nullptr)
{
loadedObject = object.get();
object->Load();
// Connect the ori to the registered object
_objectRepository.RegisterLoadedObject(ori, std::move(object));
}
return loadedObject;
}
void ResetTypeToRideEntryIndexMap()
{
// Clear all ride objects
for (auto& v : _rideTypeToObjectMap)
{
v.clear();
}
// Build object lists
const auto maxRideObjects = static_cast<size_t>(object_entry_group_counts[EnumValue(ObjectType::Ride)]);
for (size_t i = 0; i < maxRideObjects; i++)
{
auto* rideObject = static_cast<RideObject*>(GetLoadedObject(ObjectType::Ride, i));
if (rideObject == nullptr)
continue;
const auto* entry = static_cast<rct_ride_entry*>(rideObject->GetLegacyData());
if (entry == nullptr)
continue;
for (auto rideType : entry->ride_type)
{
if (rideType < _rideTypeToObjectMap.size())
{
auto& v = _rideTypeToObjectMap[rideType];
v.push_back(static_cast<ObjectEntryIndex>(i));
}
}
}
}
static void ReportMissingObject(const ObjectEntryDescriptor& entry)
{
std::string name(entry.GetName());
Console::Error::WriteLine("[%s] Object not found.", name.c_str());
}
void ReportObjectLoadProblem(const rct_object_entry* entry)
{
utf8 objName[DAT_NAME_LENGTH + 1] = { 0 };
std::copy_n(entry->name, DAT_NAME_LENGTH, objName);
Console::Error::WriteLine("[%s] Object could not be loaded.", objName);
}
static int32_t GetIndexFromTypeEntry(ObjectType objectType, size_t entryIndex)
{
int32_t result = 0;
for (int32_t i = 0; i < EnumValue(objectType); i++)
{
result += object_entry_group_counts[i];
}
result += static_cast<int32_t>(entryIndex);
return result;
}
};
std::unique_ptr<IObjectManager> CreateObjectManager(IObjectRepository& objectRepository)
{
return std::make_unique<ObjectManager>(objectRepository);
}
Object* object_manager_get_loaded_object(const ObjectEntryDescriptor& entry)
{
auto& objectManager = OpenRCT2::GetContext()->GetObjectManager();
Object* loadedObject = objectManager.GetLoadedObject(entry);
return loadedObject;
}
ObjectEntryIndex object_manager_get_loaded_object_entry_index(const Object* loadedObject)
{
auto& objectManager = OpenRCT2::GetContext()->GetObjectManager();
auto entryIndex = objectManager.GetLoadedObjectEntryIndex(loadedObject);
return entryIndex;
}
ObjectEntryIndex object_manager_get_loaded_object_entry_index(const ObjectEntryDescriptor& entry)
{
return object_manager_get_loaded_object_entry_index(object_manager_get_loaded_object(entry));
}
Object* object_manager_load_object(const rct_object_entry* entry)
{
auto& objectManager = OpenRCT2::GetContext()->GetObjectManager();
Object* loadedObject = objectManager.LoadObject(entry);
return loadedObject;
}
void object_manager_unload_objects(const std::vector<ObjectEntryDescriptor>& entries)
{
auto& objectManager = OpenRCT2::GetContext()->GetObjectManager();
objectManager.UnloadObjects(entries);
}
void object_manager_unload_all_objects()
{
auto& objectManager = OpenRCT2::GetContext()->GetObjectManager();
objectManager.UnloadAll();
}
rct_string_id object_manager_get_source_game_string(const ObjectSourceGame sourceGame)
{
return ObjectManager::GetObjectSourceGameString(sourceGame);
}