/*
 * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */

/** @file station_type.h Types related to stations. */

#ifndef STATION_TYPE_H
#define STATION_TYPE_H

#include "core/pool_type.hpp"
#include "tilearea_type.h"

using StationID = PoolID<uint16_t, struct StationIDTag, 64000, 0xFFFF>;
static constexpr StationID NEW_STATION{0xFFFD};
static constexpr StationID ADJACENT_STATION{0xFFFE};

using RoadStopID = PoolID<uint16_t, struct RoadStopIDTag, 64000, 0xFFFF>;

struct BaseStation;
struct Station;
struct RoadStop;
struct StationSpec;
struct Waypoint;

/** Station types */
enum class StationType : uint8_t {
	Rail, ///< Railways/train station.
	Airport, ///< Airports and heliports, excluding the ones on oil rigs.
	Truck, ///< Road stop for trucks.
	Bus, ///< Road stop for busses.
	Oilrig, ///< Heliport on an oil rig.
	Dock, ///< Ship port.
	Buoy, ///< Waypoint for ships.
	RailWaypoint, ///< Waypoint for trains.
	RoadWaypoint, ///< Waypoint for trucks and busses.
	End, ///< End marker.
};

/** Types of RoadStops */
enum class RoadStopType : uint8_t {
	Bus, ///< A standard stop for buses
	Truck, ///< A standard stop for trucks
	End, ///< End of valid types
};

/** The facilities a station might be having */
enum class StationFacility : uint8_t {
	Train     = 0, ///< Station with train station
	TruckStop = 1, ///< Station with truck stops
	BusStop   = 2, ///< Station with bus stops
	Airport   = 3, ///< Station with an airport
	Dock      = 4, ///< Station with a dock
	Waypoint  = 7, ///< Station is a waypoint
};

/** Bitset of \c StationFacility elements. */
using StationFacilities = EnumBitSet<StationFacility, uint8_t>;

/** Fake 'facility' to allow toggling display of recently-removed station signs. */
static constexpr StationFacility STATION_FACILITY_GHOST{6};

/** The vehicles that may have visited a station */
enum class StationVehicleType : uint8_t {
	Train = 1, ///< Station has seen a train
	Bus = 2, ///< Station has seen a bus
	Truck = 3, ///< Station has seen a truck
	Aircraft = 4, ///< Station has seen an aircraft
	Ship = 5, ///< Station has seen a ship

	Waypoint = 6, ///< Station is a waypoint (Save load conversion and NewGRF only!)
};

/** Bitset of \c StationVehicleType elements. */
using StationVehicleTypes = EnumBitSet<StationVehicleType, uint8_t>;

/** Randomisation triggers for stations and roadstops */
enum class StationRandomTrigger : uint8_t {
	NewCargo, ///< Trigger station on new cargo arrival.
	CargoTaken, ///< Trigger station when cargo is completely taken.
	VehicleArrives, ///< Trigger platform when train arrives.
	VehicleDeparts, ///< Trigger platform when train leaves.
	VehicleLoads, ///< Trigger platform when train loads/unloads.
	PathReservation, ///< Trigger platform when train reserves path.
};

/** Bitset of \c StationRandomTrigger elements. */
using StationRandomTriggers = EnumBitSet<StationRandomTrigger, uint8_t>;

/** Animation triggers for stations and roadstops. */
enum class StationAnimationTrigger : uint8_t {
	Built, ///< Trigger tile when built.
	NewCargo, ///< Trigger station on new cargo arrival.
	CargoTaken, ///< Trigger station when cargo is completely taken.
	VehicleArrives, ///< Trigger platform when train arrives.
	VehicleDeparts, ///< Trigger platform when train leaves.
	VehicleLoads, ///< Trigger platform when train loads/unloads.
	AcceptanceTick, ///< Trigger station every 250 ticks.
	TileLoop, ///< Trigger in the periodic tile loop.
	PathReservation, ///< Trigger platform when train reserves path.
	End, ///< End marker.
};

/** Bitset of \c StationAnimationTrigger elements. */
using StationAnimationTriggers = EnumBitSet<StationAnimationTrigger, uint16_t>;

/** Animation triggers for airport tiles */
enum class AirportAnimationTrigger : uint8_t {
	Built, ///< Triggered when the airport is built (for all tiles at the same time).
	TileLoop, ///< Triggered in the periodic tile loop.
	NewCargo, ///< Triggered when new cargo arrives at the station (for all tiles at the same time).
	CargoTaken, ///< Triggered when a cargo type is completely removed from the station (for all tiles at the same time).
	AcceptanceTick, ///< Triggered every 250 ticks (for all tiles at the same time).
	AirplaneTouchdown, ///< Triggered when an airplane (not a helicopter) touches down at the airport (for single tile).
};

/** Bitset of \c AirportAnimationTrigger elements. */
using AirportAnimationTriggers = EnumBitSet<AirportAnimationTrigger, uint8_t>;

/* The different catchment area sizes. */
static constexpr uint CA_NONE = 0; ///< Catchment when the station has no facilities
static constexpr uint CA_BUS = 3; ///< Catchment for bus stops with "modified catchment" enabled
static constexpr uint CA_TRUCK = 3; ///< Catchment for truck stops with "modified catchment" enabled
static constexpr uint CA_TRAIN = 4; ///< Catchment for train stations with "modified catchment" enabled
static constexpr uint CA_DOCK = 5; ///< Catchment for docks with "modified catchment" enabled

static constexpr uint CA_UNMODIFIED = 4; ///< Catchment for all stations with "modified catchment" disabled

static constexpr uint MAX_CATCHMENT = 10; ///< Maximum catchment for airports with "modified catchment" enabled

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

struct StationCompare {
	bool operator() (const Station *lhs, const Station *rhs) const;
};

/** List of stations */
typedef std::set<Station *, StationCompare> StationList;

/**
 * Structure contains cached list of stations nearby. The list
 * is created upon first call to GetStations()
 */
class StationFinder : TileArea {
	StationList stations; ///< List of stations nearby
public:
	/**
	 * Constructs StationFinder
	 * @param area the area to search from
	 */
	StationFinder(const TileArea &area) : TileArea(area) {}
	const StationList &GetStations();
};

#endif /* STATION_TYPE_H */
