vcmi/lib/bonuses/Updaters.h

/*
 * Updaters.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 "Bonus.h"
#include "../serializer/Serializeable.h"

VCMI_LIB_NAMESPACE_BEGIN

class AggregateLimiter;
class CCreatureTypeLimiter;
class HasAnotherBonusLimiter;
class TerrainLimiter;
class CreatureLevelLimiter;
class FactionLimiter;
class CreatureAlignmentLimiter;
class OppositeSideLimiter;
class RankRangeLimiter;
class UnitOnHexLimiter;

// observers for updating bonuses based on certain events (e.g. hero gaining level)

class DLL_LINKAGE IUpdater : public Serializeable
{
public:
	virtual ~IUpdater() = default;

	virtual std::shared_ptr<Bonus> createUpdatedBonus(const std::shared_ptr<Bonus> & b, const CBonusSystemNode & context) const;
	virtual std::string toString() const;
	virtual JsonNode toJsonNode() const;

	template <typename Handler> void serialize(Handler & h)
	{
	}
};

class DLL_LINKAGE GrowsWithLevelUpdater : public IUpdater
{
public:
	int valPer20 = 0;
	int stepSize = 1;

	GrowsWithLevelUpdater() = default;
	GrowsWithLevelUpdater(int valPer20, int stepSize = 1);

	template <typename Handler> void serialize(Handler & h)
	{
		h & static_cast<IUpdater &>(*this);
		h & valPer20;
		h & stepSize;
	}

	std::shared_ptr<Bonus> createUpdatedBonus(const std::shared_ptr<Bonus> & b, const CBonusSystemNode & context) const override;
	std::string toString() const override;
	JsonNode toJsonNode() const override;
};

class DLL_LINKAGE TimesHeroLevelUpdater : public IUpdater
{
	int stepSize = 1;
public:
	TimesHeroLevelUpdater() = default;
	TimesHeroLevelUpdater(int stepSize)
		: stepSize(stepSize)
	{
		assert(stepSize > 0);
	}

	template <typename Handler> void serialize(Handler & h)
	{
		h & static_cast<IUpdater &>(*this);
		if (h.hasFeature(Handler::Version::UNIVERSITY_CONFIG))
			h & stepSize;
	}

	std::shared_ptr<Bonus> createUpdatedBonus(const std::shared_ptr<Bonus> & b, const CBonusSystemNode & context) const override;
	std::string toString() const override;
	JsonNode toJsonNode() const override;
};

class DLL_LINKAGE TimesStackSizeUpdater : public IUpdater
{
	std::shared_ptr<Bonus> apply(const std::shared_ptr<Bonus> & b, int count) const;

	int minimum = std::numeric_limits<int>::min();
	int maximum = std::numeric_limits<int>::max();
	int stepSize = 1;
	int stepValue = 1;
public:
	TimesStackSizeUpdater() = default;
	TimesStackSizeUpdater(int minimum, int maximum, int stepSize, int stepValue)
		: minimum(minimum)
		, maximum(maximum)
		, stepSize(stepSize)
		, stepValue(stepValue)
	{}

	std::shared_ptr<Bonus> createUpdatedBonus(const std::shared_ptr<Bonus> & b, const CBonusSystemNode & context) const override;
	std::string toString() const override;
	JsonNode toJsonNode() const override;

	template <typename Handler> void serialize(Handler & h)
	{
		h & static_cast<IUpdater &>(*this);
		h & minimum;
		h & maximum;
		h & stepSize;
	}
};

class DLL_LINKAGE TimesArmySizeUpdater : public IUpdater
{
public:
	int minimum = std::numeric_limits<int>::min();
	int maximum = std::numeric_limits<int>::max();
	int stepSize = 1;
	int filteredLevel = -1;
	CreatureID filteredCreature;
	FactionID filteredFaction;
	TimesArmySizeUpdater() = default;

	std::shared_ptr<Bonus> createUpdatedBonus(const std::shared_ptr<Bonus> & b, const CBonusSystemNode & context) const override;
	std::string toString() const override;
	JsonNode toJsonNode() const override;

	template <typename Handler> void serialize(Handler & h)
	{
		h & static_cast<IUpdater &>(*this);
		h & minimum;
		h & maximum;
		h & stepSize;
		h & filteredLevel;
		h & filteredCreature;
		h & filteredFaction;
	}
};

class DLL_LINKAGE TimesStackLevelUpdater : public IUpdater
{
	std::shared_ptr<Bonus> apply(const std::shared_ptr<Bonus> & b, int level) const;

public:
	std::shared_ptr<Bonus> createUpdatedBonus(const std::shared_ptr<Bonus> & b, const CBonusSystemNode & context) const override;
	std::string toString() const override;
	JsonNode toJsonNode() const override;
};

class DLL_LINKAGE DivideStackLevelUpdater : public IUpdater
{
	std::shared_ptr<Bonus> apply(const std::shared_ptr<Bonus> & b, int level) const;

public:
	std::shared_ptr<Bonus> createUpdatedBonus(const std::shared_ptr<Bonus> & b, const CBonusSystemNode & context) const override;
	std::string toString() const override;
	JsonNode toJsonNode() const override;
};

class DLL_LINKAGE TimesHeroLevelDivideStackLevelUpdater : public TimesHeroLevelUpdater
{
	std::shared_ptr<DivideStackLevelUpdater> divideStackLevel;
public:
	template <typename Handler> void serialize(Handler & h)
	{
		h & static_cast<TimesHeroLevelUpdater &>(*this);
		h & divideStackLevel;
	}

	TimesHeroLevelDivideStackLevelUpdater()
		: divideStackLevel(std::make_shared<DivideStackLevelUpdater>())
	{}

	std::shared_ptr<Bonus> createUpdatedBonus(const std::shared_ptr<Bonus> & b, const CBonusSystemNode & context) const override;
	std::string toString() const override;
	JsonNode toJsonNode() const override;
};

class DLL_LINKAGE OwnerUpdater : public IUpdater
{
public:
	std::shared_ptr<Bonus> createUpdatedBonus(const std::shared_ptr<Bonus>& b, const CBonusSystemNode& context) const override;
	std::string toString() const override;
	JsonNode toJsonNode() const override;
};

class DLL_LINKAGE CompositeUpdater : public IUpdater
{
public:
	std::vector<TUpdaterPtr> updaters;

	std::shared_ptr<Bonus> createUpdatedBonus(const std::shared_ptr<Bonus>& b, const CBonusSystemNode& context) const override;
	std::string toString() const override;
	JsonNode toJsonNode() const override;

	template <typename Handler> void serialize(Handler & h)
	{
		h & updaters;
	}
};

VCMI_LIB_NAMESPACE_END