2023-07-30 19:12:25 +02:00
|
|
|
/*
|
|
|
|
* 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
|
|
|
|
{
|
2023-08-25 20:42:20 +02:00
|
|
|
enum class ELoadingState
|
2023-07-30 19:12:25 +02:00
|
|
|
{
|
|
|
|
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;
|
2024-01-08 21:32:10 +02:00
|
|
|
bool dynamicType;
|
2023-07-30 19:12:25 +02:00
|
|
|
|
|
|
|
/// 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;
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
std::multimap<std::string, ObjectData> registeredObjects;
|
|
|
|
mutable std::vector<ObjectCallback> scheduledRequests;
|
|
|
|
|
2023-08-25 20:42:20 +02:00
|
|
|
ELoadingState state = ELoadingState::LOADING;
|
2023-07-30 19:12:25 +02:00
|
|
|
|
2023-09-23 18:26:15 +02:00
|
|
|
/// Helper method that dumps all registered identifier into log file
|
|
|
|
void debugDumpIdentifiers();
|
|
|
|
|
2023-07-30 19:12:25 +02:00
|
|
|
/// 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;
|
|
|
|
|
2024-01-07 15:14:07 +02:00
|
|
|
void showIdentifierResolutionErrorDetails(const ObjectCallback & callback) const;
|
|
|
|
std::optional<si32> getIdentifierImpl(const ObjectCallback & callback, bool silent) const;
|
2023-07-30 19:12:25 +02:00
|
|
|
public:
|
2023-08-25 21:36:00 +02:00
|
|
|
CIdentifierStorage();
|
2023-07-30 19:12:25 +02:00
|
|
|
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;
|
|
|
|
|
2024-08-28 21:33:56 +02:00
|
|
|
void requestIdentifierOptional(const std::string & type, const JsonNode & name, const std::function<void(si32)> & callback) const;
|
|
|
|
|
2023-07-30 19:12:25 +02:00
|
|
|
/// 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();
|
|
|
|
};
|
|
|
|
|
|
|
|
VCMI_LIB_NAMESPACE_END
|