Split massive CModHandler class/file into multiple parts:

- IdentifierStorage is now a separate handler in VLC - Renamed ModHandler::Incompatibility exception to ModIncompatibility - Extracted ModScope namespace from ModHandler - Extracted ModUtilities namespace from ModHandler - Split CModHandler.cpp on per-class basis - Replaced some direct members with unique_ptr to reduce header includes
2025-12-01 23:12:49 +02:00 · 2023-07-30 20:12:25 +03:00
parent 8ea7e91189
commit 62fddca21e
101 changed files with 1532 additions and 1279 deletions
--- a/lib/modding/IdentifierStorage.h
+++ b/lib/modding/IdentifierStorage.h
@@ -0,0 +1,110 @@
+/*
+ * IdentifierStorage.h, part of VCMI engine
+ *
+ * Authors: listed in file AUTHORS in main folder
+ *
+ * License: GNU General Public License v2.0 or later
+ * Full text of license available in license.txt file, in main folder
+ *
+ */
+#pragma once
+
+VCMI_LIB_NAMESPACE_BEGIN
+
+class JsonNode;
+
+/// class that stores all object identifiers strings and maps them to numeric ID's
+/// if possible, objects ID's should be in format <type>.<name>, camelCase e.g. "creature.grandElf"
+class DLL_LINKAGE CIdentifierStorage
+{
+	enum ELoadingState
+	{
+		LOADING,
+		FINALIZING,
+		FINISHED
+	};
+
+	struct ObjectCallback // entry created on ID request
+	{
+		std::string localScope;  /// scope from which this ID was requested
+		std::string remoteScope; /// scope in which this object must be found
+		std::string type;        /// type, e.g. creature, faction, hero, etc
+		std::string name;        /// string ID
+		std::function<void(si32)> callback;
+		bool optional;
+
+		/// Builds callback from identifier in form "targetMod:type.name"
+		static ObjectCallback fromNameWithType(const std::string & scope, const std::string & fullName, const std::function<void(si32)> & callback, bool optional);
+
+		/// Builds callback from identifier in form "targetMod:name"
+		static ObjectCallback fromNameAndType(const std::string & scope, const std::string & type, const std::string & fullName, const std::function<void(si32)> & callback, bool optional);
+
+	private:
+		ObjectCallback() = default;
+	};
+
+	struct ObjectData // entry created on ID registration
+	{
+		si32 id;
+		std::string scope; /// scope in which this ID located
+
+		bool operator==(const ObjectData & other) const
+		{
+			return id == other.id && scope == other.scope;
+		}
+
+		template <typename Handler> void serialize(Handler &h, const int version)
+		{
+			h & id;
+			h & scope;
+		}
+	};
+
+	std::multimap<std::string, ObjectData> registeredObjects;
+	mutable std::vector<ObjectCallback> scheduledRequests;
+
+	ELoadingState state;
+
+	/// Check if identifier can be valid (camelCase, point as separator)
+	static void checkIdentifier(std::string & ID);
+
+	void requestIdentifier(ObjectCallback callback) const;
+	bool resolveIdentifier(const ObjectCallback & callback) const;
+	std::vector<ObjectData> getPossibleIdentifiers(const ObjectCallback & callback) const;
+
+public:
+	CIdentifierStorage();
+	virtual ~CIdentifierStorage() = default;
+
+	/// request identifier for specific object name.
+	/// Function callback will be called during ID resolution phase of loading
+	void requestIdentifier(const std::string & scope, const std::string & type, const std::string & name, const std::function<void(si32)> & callback) const;
+	///fullName = [remoteScope:]type.name
+	void requestIdentifier(const std::string & scope, const std::string & fullName, const std::function<void(si32)> & callback) const;
+	void requestIdentifier(const std::string & type, const JsonNode & name, const std::function<void(si32)> & callback) const;
+	void requestIdentifier(const JsonNode & name, const std::function<void(si32)> & callback) const;
+
+	/// try to request ID. If ID with such name won't be loaded, callback function will not be called
+	void tryRequestIdentifier(const std::string & scope, const std::string & type, const std::string & name, const std::function<void(si32)> & callback) const;
+	void tryRequestIdentifier(const std::string & type, const JsonNode & name, const std::function<void(si32)> & callback) const;
+
+	/// get identifier immediately. If identifier is not know and not silent call will result in error message
+	std::optional<si32> getIdentifier(const std::string & scope, const std::string & type, const std::string & name, bool silent = false) const;
+	std::optional<si32> getIdentifier(const std::string & type, const JsonNode & name, bool silent = false) const;
+	std::optional<si32> getIdentifier(const JsonNode & name, bool silent = false) const;
+	std::optional<si32> getIdentifier(const std::string & scope, const std::string & fullName, bool silent = false) const;
+
+	/// registers new object
+	void registerObject(const std::string & scope, const std::string & type, const std::string & name, si32 identifier);
+
+	/// called at the very end of loading to check for any missing ID's
+	void finalize();
+
+	template <typename Handler> void serialize(Handler &h, const int version)
+	{
+		h & registeredObjects;
+		h & state;
+	}
+};
+
+VCMI_LIB_NAMESPACE_END