/*
 * 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 waypoint_base.h Base of waypoints. */

#ifndef WAYPOINT_BASE_H
#define WAYPOINT_BASE_H

#include "base_station_base.h"

/**
 * Flags for Waypoint::waypoint_flags.
 */
enum WaypointFlags : uint8_t {
	WPF_ROAD                    = 0, ///< This is a road waypoint
};

/** Representation of a waypoint. */
struct Waypoint final : SpecializedStation<Waypoint, true> {
	uint16_t town_cn = 0; ///< The N-1th waypoint for this town (consecutive number)
	uint16_t waypoint_flags{}; ///< Waypoint flags, see WaypointFlags
	TileArea road_waypoint_area{}; ///< Tile area the road waypoint part covers

	/**
	 * Create a waypoint at the given tile.
	 * @param index The index within the station pool.
	 * @param tile The location of the waypoint.
	 */
	Waypoint(StationID index, TileIndex tile = INVALID_TILE) : SpecializedStation<Waypoint, true>(index, tile) { }
	~Waypoint() override;

	void UpdateVirtCoord() override;

	void MoveSign(TileIndex new_xy) override;

	inline bool TileBelongsToRailStation(TileIndex tile) const override
	{
		return IsRailWaypointTile(tile) && GetStationIndex(tile) == this->index;
	}

	uint32_t GetNewGRFVariable(const struct ResolverObject &object, uint8_t variable, uint8_t parameter, bool &available) const override;

	TileArea GetTileArea(StationType type) const override;

	uint GetPlatformLength(TileIndex, DiagDirection) const override
	{
		return 1;
	}

	uint GetPlatformLength(TileIndex) const override
	{
		return 1;
	}

	/**
	 * Is this a single tile waypoint?
	 * @return true if it is.
	 */
	inline bool IsSingleTile() const
	{
		return this->facilities.Test(StationFacility::Train) && this->train_station.w == 1 && this->train_station.h == 1;
	}

	/**
	 * Is the "type" of waypoint the same as the given waypoint,
	 * i.e. are both a rail waypoint or are both a buoy?
	 * @param wp The waypoint to compare to.
	 * @return true iff their types are equal.
	 */
	inline bool IsOfType(const Waypoint *wp) const
	{
		return this->string_id == wp->string_id;
	}
};

#endif /* WAYPOINT_BASE_H */
