sf_error_registry.h

Go to the documentation of this file.

 
#ifndef SF_ERROR_REGISTRY_H
#define SF_ERROR_REGISTRY_H
 
#include "../../api/sfsf.h"
#include "../core/sf_wrappers.h"
 
#include <list>

typedef enum
{
    CONFLICT_SPELL_ID = 0,
    CONFLICT_SPELL_EFFECT_ID,
    CONFLICT_BUILDING_ID,
    CONFLICT_CAMPAIGN_FOLDER,
    CONFLICT_CAMPAIGN_NAME,
    CONFLICT_CAMPAIGN_AVATAR_TYPE,
    CONFLICT_DOMAIN_COUNT
} ConflictDomain;

typedef enum
{
    MOD_TYPE_FRAMEWORK = 0, 
    MOD_TYPE_CORE,          
    MOD_TYPE_EXTERNAL,      
} ModType;

typedef struct
{
    SFMod *mod;
    ModType type;
} RegisteredMod;

const char *get_mod_type_label(ModType type);

void append_mod_error(SFMod *mod, const char *format, ...) LOG_PRINTF_FMT(2, 3);

void report_mod_error(SFMod *mod, const char *format, ...) LOG_PRINTF_FMT(2, 3);

void report_mod_warning(SFMod *mod, const char *format, ...) LOG_PRINTF_FMT(2, 3);

void report_mod_warning(SFMod *mod, DebugLevel level, const char *format, ...) LOG_PRINTF_FMT(3, 4);

void clear_mod_errors(SFMod *mod);

bool claim_numeric_id(ConflictDomain domain, uint32_t id, SFMod *mod,
                      uint32_t vanilla_max, const char *id_label);

bool claim_string_id(ConflictDomain domain, const char *key, SFMod *mod,
                     const char *id_label);

void reset_conflict_domain(ConflictDomain domain);

void register_mod_for_listing(SFMod *mod, ModType type);

const std::list<RegisteredMod> &get_registered_mods();

#endif // SF_ERROR_REGISTRY_H