mirror of
https://github.com/vcmi/vcmi.git
synced 2024-12-14 10:12:59 +02:00
6056d385ed
This should fix rather common problem with mods, where two unrelated mods accidentally use same file name for a config file, leading to very unclear conflict since this result in a file override. Now all config files referenced in mod.json are loaded specifically from filesystem of mod that referenced it. In other words, it is no longer possible for one mod to override config from another mod. As a side effect, this allows mods to use shorter directory layout, e.g. `config/modName/xxx.json` can now be safely replaced with `config/ xxx.json` without fear of broken mod if there is another mod with same path to config. Similarly, now all mods can use `config/translation/ language.json` scheme for translation files Since this is no longer a problem, I've also simplified directory layout of our built-in 'vcmi' mod, by moving all files from `config/vcmi` directory directly to `config` directory. - Overrides for miscellaneous configs like mainmenu.json should works as before - Images / animations (png's or def's) work as before (and may still result in confict) - Rebalance mods work as before and can modify another mod via standard `modName:objectName` syntax
86 lines
3.6 KiB
C++
86 lines
3.6 KiB
C++
/*
|
|
* JsonUtils.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
|
|
|
|
#include "JsonNode.h"
|
|
|
|
VCMI_LIB_NAMESPACE_BEGIN
|
|
|
|
namespace JsonUtils
|
|
{
|
|
/**
|
|
* @brief recursively merges source into dest, replacing identical fields
|
|
* struct : recursively calls this function
|
|
* arrays : each entry will be merged recursively
|
|
* values : value in source will replace value in dest
|
|
* null : if value in source is present but set to null it will delete entry in dest
|
|
* @note this function will destroy data in source
|
|
*/
|
|
DLL_LINKAGE void merge(JsonNode & dest, JsonNode & source, bool ignoreOverride = false, bool copyMeta = false);
|
|
|
|
/**
|
|
* @brief recursively merges source into dest, replacing identical fields
|
|
* struct : recursively calls this function
|
|
* arrays : each entry will be merged recursively
|
|
* values : value in source will replace value in dest
|
|
* null : if value in source is present but set to null it will delete entry in dest
|
|
* @note this function will preserve data stored in source by creating copy
|
|
*/
|
|
DLL_LINKAGE void mergeCopy(JsonNode & dest, JsonNode source, bool ignoreOverride = false, bool copyMeta = false);
|
|
|
|
/** @brief recursively merges descendant into copy of base node
|
|
* Result emulates inheritance semantic
|
|
*/
|
|
DLL_LINKAGE void inherit(JsonNode & descendant, const JsonNode & base);
|
|
|
|
/**
|
|
* @brief generate one Json structure from multiple files
|
|
* @param files - list of filenames with parts of json structure
|
|
*/
|
|
DLL_LINKAGE JsonNode assembleFromFiles(const JsonNode & files);
|
|
DLL_LINKAGE JsonNode assembleFromFiles(const JsonNode & files, bool & isValid);
|
|
DLL_LINKAGE JsonNode assembleFromFiles(const std::vector<std::string> & files);
|
|
DLL_LINKAGE JsonNode assembleFromFiles(const std::vector<std::string> & files, std::string modName, bool & isValid);
|
|
|
|
/// This version loads all files with same name (overridden by mods)
|
|
DLL_LINKAGE JsonNode assembleFromFiles(const std::string & filename);
|
|
|
|
/**
|
|
* @brief removes all nodes that are identical to default entry in schema
|
|
* @param node - JsonNode to minimize
|
|
* @param schemaName - name of schema to use
|
|
* @note for minimizing data must be valid against given schema
|
|
*/
|
|
DLL_LINKAGE void minimize(JsonNode & node, const std::string & schemaName);
|
|
/// opposed to minimize, adds all missing, required entries that have default value
|
|
DLL_LINKAGE void maximize(JsonNode & node, const std::string & schemaName);
|
|
|
|
/**
|
|
* @brief validate node against specified schema
|
|
* @param node - JsonNode to check
|
|
* @param schemaName - name of schema to use
|
|
* @param dataName - some way to identify data (printed in console in case of errors)
|
|
* @returns true if data in node fully compliant with schema
|
|
*/
|
|
DLL_LINKAGE bool validate(const JsonNode & node, const std::string & schemaName, const std::string & dataName);
|
|
|
|
/// get schema by json URI: vcmi:<name of file in schemas directory>#<entry in file, optional>
|
|
/// example: schema "vcmi:settings" is used to check user settings
|
|
DLL_LINKAGE const JsonNode & getSchema(const std::string & URI);
|
|
|
|
/// detects potential conflicts - json entries present in both nodes
|
|
/// returns JsonNode that contains list of conflicting keys
|
|
/// For each conflict - list of conflicting mods and list of conflicting json values
|
|
/// result[pathToKey][modID] -> node that was conflicting
|
|
DLL_LINKAGE void detectConflicts(JsonNode & result, const JsonNode & left, const JsonNode & right, const std::string & keyName);
|
|
}
|
|
|
|
VCMI_LIB_NAMESPACE_END
|