Store: moved all the template specialization to its own heaper file, included where it's needed

in the esm store a function is defined in the cpp file to not rely on the knowledge of store.hpp in the header file

apps/openmw/mwclass/creature.cpp

@@ -35,6 +35,7 @@
 #include "../mwworld/localscripts.hpp"
 #include "../mwworld/inventorystore.hpp"
 #include "../mwworld/esmstore.hpp"
+#include "../mwworld/StoreSpecialization.hpp"
 
 #include "../mwrender/renderinginterface.hpp"
 #include "../mwrender/objects.hpp"

apps/openmw/mwclass/npc.cpp

@@ -49,6 +49,7 @@
 #include "../mwworld/cellstore.hpp"
 #include "../mwworld/localscripts.hpp"
 #include "../mwworld/esmstore.hpp"
+#include "../mwworld/StoreSpecialization.hpp"
 
 #include "../mwrender/objects.hpp"
 #include "../mwrender/renderinginterface.hpp"

apps/openmw/mwdialogue/hypertextparser.cpp

@@ -5,6 +5,7 @@
 
 #include "../mwworld/store.hpp"
 #include "../mwworld/esmstore.hpp"
+#include "../mwworld/StoreSpecialization.hpp"
 
 #include "keywordsearch.hpp"
 

apps/openmw/mwmechanics/activespells.cpp

@@ -27,6 +27,7 @@
 #include "../mwworld/esmstore.hpp"
 #include "../mwworld/class.hpp"
 #include "../mwworld/inventorystore.hpp"
+#include "../mwworld/StoreSpecialization.hpp"
 
 namespace
 {

apps/openmw/mwmechanics/aicombat.cpp

@@ -14,6 +14,8 @@
 
 #include "../mwworld/class.hpp"
 #include "../mwworld/esmstore.hpp"
+#include "../mwworld/StoreSpecialization.hpp"
+
 
 #include "../mwbase/environment.hpp"
 #include "../mwbase/dialoguemanager.hpp"

apps/openmw/mwmechanics/aicombataction.cpp

@@ -12,6 +12,7 @@
 #include "../mwworld/inventorystore.hpp"
 #include "../mwworld/actionequip.hpp"
 #include "../mwworld/cellstore.hpp"
+#include "../mwworld/StoreSpecialization.hpp"
 
 #include "actorutil.hpp"
 #include "npcstats.hpp"

apps/openmw/mwmechanics/aiwander.cpp

@@ -17,6 +17,7 @@
 #include "../mwworld/class.hpp"
 #include "../mwworld/esmstore.hpp"
 #include "../mwworld/cellstore.hpp"
+#include "../mwworld/StoreSpecialization.hpp"
 
 #include "../mwphysics/collisiontype.hpp"
 

apps/openmw/mwmechanics/alchemy.cpp

@@ -21,6 +21,7 @@
 #include "../mwworld/containerstore.hpp"
 #include "../mwworld/class.hpp"
 #include "../mwworld/cellstore.hpp"
+#include "../mwworld/StoreSpecialization.hpp"
 
 #include "magiceffects.hpp"
 #include "creaturestats.hpp"

apps/openmw/mwmechanics/autocalcspell.cpp

@@ -3,6 +3,7 @@
 #include <limits>
 
 #include "../mwworld/esmstore.hpp"
+#include "../mwworld/StoreSpecialization.hpp"
 
 #include "../mwbase/world.hpp"
 #include "../mwbase/environment.hpp"

apps/openmw/mwmechanics/enchanting.cpp

@@ -7,6 +7,7 @@
 #include "../mwworld/class.hpp"
 #include "../mwworld/containerstore.hpp"
 #include "../mwworld/esmstore.hpp"
+#include "../mwworld/StoreSpecialization.hpp"
 
 #include "../mwbase/world.hpp"
 #include "../mwbase/environment.hpp"

apps/openmw/mwmechanics/mechanicsmanagerimp.cpp

@@ -14,6 +14,7 @@
 #include "../mwworld/class.hpp"
 #include "../mwworld/player.hpp"
 #include "../mwworld/ptr.hpp"
+#include "../mwworld/StoreSpecialization.hpp"
 
 #include "../mwbase/environment.hpp"
 #include "../mwbase/statemanager.hpp"

apps/openmw/mwmechanics/npcstats.cpp

@@ -11,6 +11,7 @@
 #include <components/misc/strings/format.hpp>
 
 #include "../mwworld/esmstore.hpp"
+#include "../mwworld/StoreSpecialization.hpp"
 
 #include "../mwbase/environment.hpp"
 #include "../mwbase/world.hpp"

apps/openmw/mwmechanics/pathgrid.cpp

@@ -5,6 +5,7 @@
 
 #include "../mwworld/cellstore.hpp"
 #include "../mwworld/esmstore.hpp"
+#include "../mwworld/StoreSpecialization.hpp"
 
 namespace
 {

apps/openmw/mwmechanics/spellcasting.cpp

@@ -18,6 +18,7 @@
 #include "../mwworld/cellstore.hpp"
 #include "../mwworld/esmstore.hpp"
 #include "../mwworld/inventorystore.hpp"
+#include "../mwworld/StoreSpecialization.hpp"
 
 #include "../mwrender/animation.hpp"
 

apps/openmw/mwmechanics/spelleffects.cpp

@@ -29,6 +29,7 @@
 #include "../mwworld/esmstore.hpp"
 #include "../mwworld/inventorystore.hpp"
 #include "../mwworld/player.hpp"
+#include "../mwworld/StoreSpecialization.hpp"
 
 namespace
 {

apps/openmw/mwmechanics/spellpriority.cpp

@@ -13,6 +13,7 @@
 #include "../mwworld/esmstore.hpp"
 #include "../mwworld/inventorystore.hpp"
 #include "../mwworld/cellstore.hpp"
+#include "../mwworld/StoreSpecialization.hpp"
 
 #include "creaturestats.hpp"
 #include "spellresistance.hpp"

apps/openmw/mwmechanics/spellresistance.cpp

@@ -7,6 +7,7 @@
 
 #include "../mwworld/class.hpp"
 #include "../mwworld/esmstore.hpp"
+#include "../mwworld/StoreSpecialization.hpp"
 
 #include "creaturestats.hpp"
 #include "spellutil.hpp"

apps/openmw/mwmechanics/spellutil.cpp

@@ -7,6 +7,8 @@
 
 #include "../mwworld/class.hpp"
 #include "../mwworld/esmstore.hpp"
+#include "../mwworld/StoreSpecialization.hpp"
+
 
 #include "actorutil.hpp"
 #include "creaturestats.hpp"

apps/openmw/mwrender/pathgrid.cpp

@@ -19,6 +19,7 @@
 #include "../mwworld/cellstore.hpp"
 #include "../mwworld/esmstore.hpp"
 #include "../mwmechanics/pathfinding.hpp"
+#include "../mwworld/StoreSpecialization.hpp"
 
 #include "vismask.hpp"
 

apps/openmw/mwrender/terrainstorage.cpp

@@ -3,6 +3,7 @@
 #include "../mwbase/world.hpp"
 #include "../mwbase/environment.hpp"
 #include "../mwworld/esmstore.hpp"
+#include "../mwworld/StoreSpecialization.hpp"
 
 #include "landmanager.hpp"
 

apps/openmw/mwscript/guiextensions.cpp

@@ -7,6 +7,7 @@
 #include <components/interpreter/opcodes.hpp>
 
 #include "../mwworld/esmstore.hpp"
+#include "../mwworld/StoreSpecialization.hpp"
 
 #include "../mwbase/environment.hpp"
 #include "../mwbase/windowmanager.hpp"

apps/openmw/mwworld/StoreSpecialization.hpp

@@ -0,0 +1,285 @@
+#pragma once
+namespace MWWorld
+{
+
+    class StoreBase;
+    template<typename T> class Store;
+    template<typename T> class IndexedStore;
+
+template <>
+    class Store<ESM::LandTexture> : public StoreBase
+    {
+        // For multiple ESM/ESP files we need one list per file.
+        typedef std::vector<ESM::LandTexture> LandTextureList;
+        std::vector<LandTextureList> mStatic;
+
+    public:
+        Store();
+
+        typedef std::vector<ESM::LandTexture>::const_iterator iterator;
+
+        // Must be threadsafe! Called from terrain background loading threads.
+        // Not a big deal here, since ESM::LandTexture can never be modified or inserted/erased
+        const ESM::LandTexture *search(size_t index, size_t plugin) const;
+        const ESM::LandTexture *find(size_t index, size_t plugin) const;
+
+        void resize(size_t num) { mStatic.resize(num); }
+
+        size_t getSize() const override;
+        size_t getSize(size_t plugin) const;
+
+        RecordId load(ESM::ESMReader &esm) override;
+
+        iterator begin(size_t plugin) const;
+        iterator end(size_t plugin) const;
+    };
+
+    template <>
+    class Store<ESM::Land> : public StoreBase
+    {
+        struct SpatialComparator
+        {
+            using is_transparent = void;
+
+            bool operator()(const ESM::Land& x, const ESM::Land& y) const
+            {
+                return std::tie(x.mX, x.mY) < std::tie(y.mX, y.mY);
+            }
+            bool operator()(const ESM::Land& x, const std::pair<int, int>& y) const
+            {
+                return std::tie(x.mX, x.mY) < std::tie(y.first, y.second);
+            }
+            bool operator()(const std::pair<int, int>& x, const ESM::Land& y) const
+            {
+                return std::tie(x.first, x.second) < std::tie(y.mX, y.mY);
+            }
+        };
+        using Statics = std::set<ESM::Land, SpatialComparator>;
+        Statics mStatic;
+
+    public:
+        typedef typename Statics::iterator iterator;
+
+        virtual ~Store();
+
+        size_t getSize() const override;
+        iterator begin() const;
+        iterator end() const;
+
+        // Must be threadsafe! Called from terrain background loading threads.
+        // Not a big deal here, since ESM::Land can never be modified or inserted/erased
+        const ESM::Land *search(int x, int y) const;
+        const ESM::Land *find(int x, int y) const;
+
+        RecordId load(ESM::ESMReader &esm) override;
+        void setUp() override;
+    private:
+        bool mBuilt = false;
+    };
+
+    template <>
+    class Store<ESM::Cell> : public StoreBase
+    {
+        struct DynamicExtCmp
+        {
+            bool operator()(const std::pair<int, int> &left, const std::pair<int, int> &right) const {
+                if (left.first == right.first && left.second == right.second)
+                    return false;
+
+                if (left.first == right.first)
+                    return left.second > right.second;
+
+                // Exterior cells are listed in descending, row-major order,
+                // this is a workaround for an ambiguous chargen_plank reference in the vanilla game.
+                // there is one at -22,16 and one at -2,-9, the latter should be used.
+                return left.first > right.first;
+            }
+        };
+
+        typedef std::unordered_map<std::string, ESM::Cell, Misc::StringUtils::CiHash, Misc::StringUtils::CiEqual> DynamicInt;
+        typedef std::map<std::pair<int, int>, ESM::Cell, DynamicExtCmp>    DynamicExt;
+
+        DynamicInt      mInt;
+        DynamicExt      mExt;
+
+        std::vector<ESM::Cell *>    mSharedInt;
+        std::vector<ESM::Cell *>    mSharedExt;
+
+        DynamicInt mDynamicInt;
+        DynamicExt mDynamicExt;
+
+        const ESM::Cell *search(const ESM::Cell &cell) const;
+        void handleMovedCellRefs(ESM::ESMReader& esm, ESM::Cell* cell);
+
+    public:
+        typedef SharedIterator<ESM::Cell> iterator;
+
+        const ESM::Cell *search(const std::string &id) const;
+        const ESM::Cell *search(int x, int y) const;
+        const ESM::Cell *searchStatic(int x, int y) const;
+        const ESM::Cell *searchOrCreate(int x, int y);
+
+        const ESM::Cell *find(const std::string &id) const;
+        const ESM::Cell *find(int x, int y) const;
+
+        void clearDynamic() override;
+        void setUp() override;
+
+        RecordId load(ESM::ESMReader &esm) override;
+
+        iterator intBegin() const;
+        iterator intEnd() const;
+        iterator extBegin() const;
+        iterator extEnd() const;
+
+        // Return the northernmost cell in the easternmost column.
+        const ESM::Cell *searchExtByName(const std::string &id) const;
+
+        // Return the northernmost cell in the easternmost column.
+        const ESM::Cell *searchExtByRegion(const std::string &id) const;
+
+        size_t getSize() const override;
+        size_t getExtSize() const;
+        size_t getIntSize() const;
+
+        void listIdentifier(std::vector<std::string> &list) const override;
+
+        ESM::Cell *insert(const ESM::Cell &cell);
+
+        bool erase(const ESM::Cell &cell);
+        bool erase(const std::string &id);
+
+        bool erase(int x, int y);
+    };
+
+    template <>
+    class Store<ESM::Pathgrid> : public StoreBase
+    {
+    private:
+        typedef std::unordered_map<std::string, ESM::Pathgrid, Misc::StringUtils::CiHash, Misc::StringUtils::CiEqual> Interior;
+        typedef std::map<std::pair<int, int>, ESM::Pathgrid> Exterior;
+
+        Interior mInt;
+        Exterior mExt;
+
+        Store<ESM::Cell>* mCells;
+
+    public:
+
+        Store();
+
+        void setCells(Store<ESM::Cell>& cells);
+        RecordId load(ESM::ESMReader &esm) override;
+        size_t getSize() const override;
+
+        void setUp() override;
+
+        const ESM::Pathgrid *search(int x, int y) const;
+        const ESM::Pathgrid *search(const std::string& name) const;
+        const ESM::Pathgrid *find(int x, int y) const;
+        const ESM::Pathgrid* find(const std::string& name) const;
+        const ESM::Pathgrid *search(const ESM::Cell &cell) const;
+        const ESM::Pathgrid *find(const ESM::Cell &cell) const;
+    };
+
+
+    template <>
+    class Store<ESM::Skill> : public IndexedStore<ESM::Skill>
+    {
+    public:
+        Store();
+    };
+
+    template <>
+    class Store<ESM::MagicEffect> : public IndexedStore<ESM::MagicEffect>
+    {
+    public:
+        Store();
+    };
+
+    template <>
+    class Store<ESM::Attribute> : public IndexedStore<ESM::Attribute>
+    {
+        std::vector<ESM::Attribute> mStatic;
+
+    public:
+        typedef std::vector<ESM::Attribute>::const_iterator iterator;
+
+        Store();
+
+        const ESM::Attribute *search(size_t index) const;
+
+        // calls `search` and throws an exception if not found
+        const ESM::Attribute *find(size_t index) const;
+
+        void setUp();
+
+        size_t getSize() const;
+        iterator begin() const;
+        iterator end() const;
+    };
+
+    template <>
+    class Store<ESM::WeaponType> : public StoreBase
+    {
+        std::map<int, ESM::WeaponType> mStatic;
+
+    public:
+        typedef std::map<int, ESM::WeaponType>::const_iterator iterator;
+
+        Store();
+
+        const ESM::WeaponType *search(const int id) const;
+
+        // calls `search` and throws an exception if not found
+        const ESM::WeaponType *find(const int id) const;
+
+        RecordId load(ESM::ESMReader &esm) override { return RecordId({}, false); }
+
+        ESM::WeaponType* insert(const ESM::WeaponType &weaponType);
+
+        void setUp() override;
+
+        size_t getSize() const override;
+        iterator begin() const;
+        iterator end() const;
+    };
+
+    template <>
+    class Store<ESM::Dialogue> : public StoreBase
+    {
+        typedef std::unordered_map<std::string, ESM::Dialogue, Misc::StringUtils::CiHash, Misc::StringUtils::CiEqual> Static;
+        Static mStatic;
+        /// @par mShared usually preserves the record order as it came from the content files (this
+        /// is relevant for the spell autocalc code and selection order
+        /// for heads/hairs in the character creation)
+        /// @warning ESM::Dialogue Store currently implements a sorted order for unknown reasons.
+        std::vector<ESM::Dialogue*> mShared;
+
+        mutable bool mKeywordSearchModFlag;
+        mutable MWDialogue::KeywordSearch<std::string, int /*unused*/> mKeywordSearch;
+
+    public:
+        Store();
+
+        typedef SharedIterator<ESM::Dialogue> iterator;
+
+        void setUp() override;
+
+        const ESM::Dialogue *search(const std::string &id) const;
+        const ESM::Dialogue *find(const std::string &id) const;
+
+        iterator begin() const;
+        iterator end() const;
+
+        size_t getSize() const override;
+
+        bool eraseStatic(const std::string &id) override;
+
+        RecordId load(ESM::ESMReader &esm) override;
+
+        void listIdentifier(std::vector<std::string> &list) const override;
+
+        const MWDialogue::KeywordSearch<std::string, int>& getDialogIdKeywordSearch() const;
+    };
+}

apps/openmw/mwworld/cells.cpp

@@ -15,6 +15,7 @@
 #include "esmstore.hpp"
 #include "containerstore.hpp"
 #include "cellstore.hpp"
+#include "StoreSpecialization.hpp"
 
 namespace
 {

apps/openmw/mwworld/class.cpp

@@ -8,6 +8,7 @@
 #include "../mwbase/windowmanager.hpp"
 #include "../mwbase/world.hpp"
 #include "../mwworld/esmstore.hpp"
+#include "../mwworld/StoreSpecialization.hpp"
 
 #include "ptr.hpp"
 #include "nullaction.hpp"

apps/openmw/mwworld/esmstore.cpp

@@ -13,6 +13,7 @@
 #include <components/esmloader/load.hpp>
 
 #include "../mwmechanics/spelllist.hpp"
+#include "StoreSpecialization.hpp"
 
 namespace
 {
@@ -292,6 +293,14 @@ namespace MWWorld
     {
     }
 
+    void ESMStore::clearDynamic()
+    {
+        for (std::map<int, StoreBase *>::iterator it = mStores.begin(); it != mStores.end(); ++it)
+            it->second->clearDynamic();
+
+        movePlayerRecord();
+    }
+
 static bool isCacheableRecord(int id)
 {
     if (id == ESM::REC_ACTI || id == ESM::REC_ALCH || id == ESM::REC_APPA || id == ESM::REC_ARMO ||

apps/openmw/mwworld/esmstore.hpp

@@ -4,7 +4,9 @@
 #include <memory>
 #include <stdexcept>
 #include <unordered_map>
+#include <map>
 
+#include <components/misc/stringops.hpp>
 #include <components/esm/luascripts.hpp>
 #include "store.hpp"
 
@@ -21,6 +23,7 @@ namespace MWMechanics
 namespace ESM
 {
     class ReadersCache;
+    struct Dialogue;
 }
 
 namespace MWWorld
@@ -95,13 +98,7 @@ namespace MWWorld
         ESMStore();
         ~ESMStore();
 
-        void clearDynamic ()
+        void clearDynamic();
-        {
-            for (std::map<int, StoreBase *>::iterator it = mStores.begin(); it != mStores.end(); ++it)
-                it->second->clearDynamic();
-
-            movePlayerRecord();
-        }
 
         void movePlayerRecord();
 

apps/openmw/mwworld/projectilemanager.cpp

@@ -30,6 +30,7 @@
 #include "../mwworld/class.hpp"
 #include "../mwworld/esmstore.hpp"
 #include "../mwworld/inventorystore.hpp"
+#include "../mwworld/StoreSpecialization.hpp"
 
 #include "../mwbase/soundmanager.hpp"
 #include "../mwbase/world.hpp"

apps/openmw/mwworld/scene.cpp

@@ -43,6 +43,7 @@
 #include "cellpreloader.hpp"
 #include "worldimp.hpp"
 #include "cellutils.hpp"
+#include "StoreSpecialization.hpp"
 
 namespace
 {

apps/openmw/mwworld/store.cpp

@@ -8,6 +8,7 @@
 
 #include <components/loadinglistener/loadinglistener.hpp>
 #include <components/misc/rng.hpp>
+#include "StoreSpecialization.hpp"
 
 #include <iterator>
 #include <stdexcept>

apps/openmw/mwworld/worldimp.cpp

@@ -86,6 +86,7 @@
 #include "contentloader.hpp"
 #include "esmloader.hpp"
 #include "cellutils.hpp"
+#include "StoreSpecialization.hpp"
 
 namespace MWWorld
 {