/*
 * This file is part of OpenTTD.
 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
 */

/** @file town_type.h Types related to towns. */

#ifndef TOWN_TYPE_H
#define TOWN_TYPE_H

#include "core/enum_type.hpp"
#include "core/pool_type.hpp"

using TownID = PoolID<uint16_t, struct TownIDTag, 64000, 0xFFFF>;

struct Town;

/** Supported initial town sizes */
enum TownSize : uint8_t {
	TSZ_SMALL,  ///< Small town.
	TSZ_MEDIUM, ///< Medium town.
	TSZ_LARGE,  ///< Large town.
	TSZ_RANDOM, ///< Random size, bigger than small, smaller than large.

	TSZ_END,    ///< Number of available town sizes.
};
DECLARE_ENUM_AS_ADDABLE(TownSize)

/* These refer to the maximums, so Appalling is -1000 to -400
 * MAXIMUM RATINGS BOUNDARIES */
static constexpr int RATING_MINIMUM = -1000;
static constexpr int RATING_APPALLING = -400;
static constexpr int RATING_VERYPOOR = -200;
static constexpr int RATING_POOR = 0;
static constexpr int RATING_MEDIOCRE = 200;
static constexpr int RATING_GOOD = 400;
static constexpr int RATING_VERYGOOD = 600;
static constexpr int RATING_EXCELLENT = 800;
static constexpr int RATING_OUTSTANDING = 1000; ///< OUTSTANDING

static constexpr int RATING_MAXIMUM = RATING_OUTSTANDING;

static constexpr int RATING_INITIAL = 500; ///< initial rating

/* RATINGS AFFECTING NUMBERS */
static constexpr int RATING_TREE_DOWN_STEP = -35;
static constexpr int RATING_TREE_MINIMUM = RATING_MINIMUM;
static constexpr int RATING_TREE_UP_STEP = 7;
static constexpr int RATING_TREE_MAXIMUM = 220;

static constexpr int RATING_GROWTH_UP_STEP =  5; ///< when a town grows, all companies have rating increased a bit ...
static constexpr int RATING_GROWTH_MAXIMUM = RATING_MEDIOCRE; ///< ... up to RATING_MEDIOCRE
static constexpr int RATING_STATION_UP_STEP = 12; ///< when a town grows, company gains reputation for all well serviced stations ...
static constexpr int RATING_STATION_DOWN_STEP = -15; ///< ... but loses for badly serviced stations

static constexpr int RATING_TUNNEL_BRIDGE_UP_STEP = 50; ///< rating increase for improving a town-owned bridge
static constexpr int RATING_TUNNEL_BRIDGE_DOWN_STEP = -250; ///< penalty for removing town owned tunnel or bridge
static constexpr int RATING_TUNNEL_BRIDGE_MINIMUM = 0; ///< minimum rating after removing tunnel or bridge
static constexpr int RATING_TUNNEL_BRIDGE_NEEDED_LENIENT = 144; ///< rating needed, "Lenient" difficulty settings
static constexpr int RATING_TUNNEL_BRIDGE_NEEDED_NEUTRAL = 208; ///< "Neutral"
static constexpr int RATING_TUNNEL_BRIDGE_NEEDED_HOSTILE = 400; ///< "Hostile"
static constexpr int RATING_TUNNEL_BRIDGE_NEEDED_PERMISSIVE = RATING_MINIMUM; ///< "Permissive" (local authority disabled)

static constexpr int RATING_ROAD_DOWN_STEP_INNER = -50; ///< removing a roadpiece in the middle
static constexpr int RATING_ROAD_DOWN_STEP_EDGE  = -18; ///< removing a roadpiece at the edge
static constexpr int RATING_ROAD_MINIMUM = -100; ///< minimum rating after removing town owned road
static constexpr int RATING_ROAD_NEEDED_LENIENT = 16; ///< rating needed, "Lenient" difficulty settings
static constexpr int RATING_ROAD_NEEDED_NEUTRAL = 64; ///< "Neutral"
static constexpr int RATING_ROAD_NEEDED_HOSTILE = 112; ///< "Hostile"
static constexpr int RATING_ROAD_NEEDED_PERMISSIVE = RATING_MINIMUM; ///< "Permissive" (local authority disabled)

static constexpr int RATING_HOUSE_MINIMUM  = RATING_MINIMUM;

static constexpr int RATING_BRIBE_UP_STEP = 200;
static constexpr int RATING_BRIBE_MAXIMUM = 800;
static constexpr int RATING_BRIBE_DOWN_TO = -50; // XXX SHOULD BE SOMETHING LOWER?

/** Town Layouts. It needs to be 8bits, because we save and load it as such */
enum TownLayout : uint8_t {
	TL_BEGIN = 0,
	TL_ORIGINAL = 0,     ///< Original algorithm (min. 1 distance between roads)
	TL_BETTER_ROADS,     ///< Extended original algorithm (min. 2 distance between roads)
	TL_2X2_GRID,         ///< Geometric 2x2 grid algorithm
	TL_3X3_GRID,         ///< Geometric 3x3 grid algorithm

	TL_RANDOM,           ///< Random town layout

	NUM_TLS,             ///< Number of town layouts
};
DECLARE_ENUM_AS_ADDABLE(TownLayout)

/** Options for growing towns. */
enum class TownExpandMode : uint8_t {
	Buildings, ///< Allow town to place buildings.
	Roads, ///< Allow town to place roads.
};

using TownExpandModes = EnumBitSet<TownExpandMode, uint8_t>;

/** Town founding setting values. It needs to be 8bits, because we save and load it as such */
enum TownFounding : uint8_t {
	TF_BEGIN = 0,     ///< Used for iterations and limit testing
	TF_FORBIDDEN = 0, ///< Forbidden
	TF_ALLOWED,       ///< Allowed
	TF_CUSTOM_LAYOUT, ///< Allowed, with custom town layout
	TF_END,           ///< Used for iterations and limit testing
};

/** Town cargo generation modes */
enum TownCargoGenMode : uint8_t {
	TCGM_BEGIN = 0,
	TCGM_ORIGINAL = 0,  ///< Original algorithm (quadratic cargo by population)
	TCGM_BITCOUNT,      ///< Bit-counted algorithm (normal distribution from individual house population)
	TCGM_END,
};

static const uint MAX_LENGTH_TOWN_NAME_CHARS = 32; ///< The maximum length of a town name in characters including '\0'

/** Store the maximum and actually transported cargo amount for the current and the last month. */
template <typename Tstorage>
struct TransportedCargoStat {
	Tstorage old_max = 0; ///< Maximum amount last month
	Tstorage new_max = 0; ///< Maximum amount this month
	Tstorage old_act = 0; ///< Actually transported last month
	Tstorage new_act = 0; ///< Actually transported this month

	/** Update stats for a new month. */
	void NewMonth()
	{
		this->old_max = this->new_max; this->new_max = 0;
		this->old_act = this->new_act; this->new_act = 0;
	}
};

#endif /* TOWN_TYPE_H */
