OpenMW/apps/openmw/mwworld/worldmodel.hpp

#ifndef GAME_MWWORLD_WORLDMODEL_H
#define GAME_MWWORLD_WORLDMODEL_H

#include <list>
#include <map>
#include <string>
#include <unordered_map>
#include <variant>

#include <components/esm/util.hpp>
#include <components/misc/algorithm.hpp>

#include "cellstore.hpp"
#include "ptr.hpp"

namespace ESM
{
    class ESMReader;
    class ESMWriter;
    class ReadersCache;
    struct Cell;
}

namespace ESM4
{
    struct Cell;
}

namespace Loading
{
    class Listener;
}

namespace MWWorld
{
    class ESMStore;

    /// \brief Cell container
    class WorldModel
    {
        typedef std::vector<std::pair<ESM::RefId, CellStore*>> IdCache;
        const MWWorld::ESMStore& mStore;
        ESM::ReadersCache& mReaders;
        mutable std::unordered_map<ESM::RefId, CellStore> mCells;
        mutable std::map<std::string, CellStore*, Misc::StringUtils::CiComp> mInteriors;

        mutable std::map<ESM::ExteriorCellIndex, CellStore*> mExteriors;
        IdCache mIdCache;
        std::size_t mIdCacheIndex = 0;
        std::unordered_map<ESM::RefNum, Ptr> mPtrIndex;
        std::size_t mPtrIndexUpdateCounter = 0;
        ESM::RefNum mLastGeneratedRefnum;

        CellStore& getCellStore(const ESM::Cell* cell);
        CellStore* getInteriorOrNull(std::string_view name);
        Ptr getPtrAndCache(const ESM::RefId& name, CellStore& cellStore);

        void writeCell(ESM::ESMWriter& writer, CellStore& cell) const;

    public:
        explicit WorldModel(const MWWorld::ESMStore& store, ESM::ReadersCache& reader);

        WorldModel(const WorldModel&) = delete;
        WorldModel& operator=(const WorldModel&) = delete;

        void clear();

        CellStore& getExterior(ESM::ExteriorCellIndex cellIndex);
        CellStore& getInterior(std::string_view name);
        CellStore& getCell(std::string_view name); // interior or named exterior
        CellStore& getCell(const ESM::RefId& Id);

        // Returns the cell that is in the same worldspace as `cellInSameWorldSpace`
        // (in case of nullptr - default exterior worldspace) and contains given position.
        // Interiors are single-cell worldspaces, so in case of an interior it just returns
        // the same cell.
        CellStore& getCellByPosition(const osg::Vec3f& pos, CellStore* cellInSameWorldSpace = nullptr);

        void registerPtr(const MWWorld::Ptr& ptr);
        void deregisterPtr(const MWWorld::Ptr& ptr);
        ESM::RefNum getLastGeneratedRefNum() const { return mLastGeneratedRefnum; }
        void setLastGeneratedRefNum(ESM::RefNum v) { mLastGeneratedRefnum = v; }
        size_t getPtrIndexUpdateCounter() const { return mPtrIndexUpdateCounter; }
        const std::unordered_map<ESM::RefNum, Ptr>& getAllPtrs() const { return mPtrIndex; }

        Ptr getPtr(const ESM::RefNum& refNum) const;

        Ptr getPtr(const ESM::RefId& name, CellStore& cellStore);
        Ptr getPtr(const ESM::RefId& name);

        template <typename Fn>
        void forEachLoadedCellStore(Fn&& fn)
        {
            for (auto& [_, store] : mCells)
                fn(store);
        }

        /// Get all Ptrs referencing \a name in exterior cells
        /// @note Due to the current implementation of getPtr this only supports one Ptr per cell.
        /// @note name must be lower case
        void getExteriorPtrs(const ESM::RefId& name, std::vector<MWWorld::Ptr>& out);

        std::vector<MWWorld::Ptr> getAll(const ESM::RefId& id);

        int countSavedGameRecords() const;

        void write(ESM::ESMWriter& writer, Loading::Listener& progress) const;

        bool readRecord(ESM::ESMReader& reader, uint32_t type, const std::map<int, int>& contentFileMap);
    };
}

#endif