/* $Id$ */

/*

 * 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 newgrf_airporttiles.h NewGRF handling of airport tiles. */

#ifndef NEWGRF_AIRPORTTILES_H

#define NEWGRF_AIRPORTTILES_H

#include "airport.h"

#include "station_map.h"

#include "newgrf_commons.h"

/** Animation triggers for airport tiles */

enum AirpAnimationTrigger {

	AAT_BUILT,               ///< Triggered when the airport it build (for all tiles at the same time)

	AAT_TILELOOP,            ///< Triggered in the periodic tile loop

	AAT_STATION_NEW_CARGO,   ///< Triggered when new cargo arrives at the station (for all tiles at the same time)

	AAT_STATION_CARGO_TAKEN, ///< Triggered when a cargo type is completely removed from the station (for all tiles at the same time)

	AAT_STATION_250_ticks,   ///< Triggered every 250 ticks (for all tiles at the same time)

};

/**

 * Defines the data structure of each indivudual tile of an airport.

 */

struct AirportTileSpec {

	uint16 animation_info;                ///< Information about the animation (is it looping, how many loops etc)

	uint8 animation_speed;                ///< The speed of the animation

	StringID name;                        ///< Tile Subname string, land information on this tile will give you "AirportName (TileSubname)"

	uint8 callback_flags;                 ///< Flags telling which grf callback is set

	uint8 animation_triggers;             ///< When to start the animation

	uint8 animation_special_flags;        ///< Extra flags to influence the animation

	bool enabled;                         ///< entity still available (by default true). newgrf can disable it, though

	GRFFileProps grf_prop;                ///< properties related the the grf file

 * Extract the resolution from the given string and store

 * it in the 'res' parameter.

 * @param res variable to store the resolution in.

 * @param s   the string to decompose.

 */

static void ParseResolution(Dimension *res, const char *s)

{

	const char *t = strchr(s, 'x');

	if (t == NULL) {

		ShowInfoF("Invalid resolution '%s'", s);

		return;

	}

	res->width  = max(strtoul(s, NULL, 0), 64UL);

	res->height = max(strtoul(t + 1, NULL, 0), 64UL);

}

static void InitializeDynamicVariables()

{

	/* Dynamic stuff needs to be initialized somewhere... */

	_engine_mngr.ResetToDefaultMapping();

	_house_mngr.ResetMapping();

	_industry_mngr.ResetMapping();

	_industile_mngr.ResetMapping();

}

/** Unitializes drivers, frees allocated memory, cleans pools, ...

 * Generally, prepares the game for shutting down

 */

static void ShutdownGame()

{

	IConsoleFree();

	if (_network_available) NetworkShutDown(); // Shut down the network and close any open connections

	DriverFactoryBase::ShutdownDrivers();

	UnInitWindowSystem();

	/* stop the AI */

	AI::Uninitialize(false);

	/* Uninitialize airport state machines */

	UnInitializeAirports();

	/* Uninitialize variables that are allocated dynamically */

	GamelogReset();

		if (_settings_game.economy.station_noise_level) {

			SetWindowDirty(WC_TOWN_VIEW, st->town->index);

		}

	}

	return cost;

}

/**

 * Remove an airport

 * @param tile TileIndex been queried

 * @param flags operation to perform

 * @return cost or failure of operation

 */

static CommandCost RemoveAirport(TileIndex tile, DoCommandFlag flags)

{

	Station *st = Station::GetByTile(tile);

	if (_current_company != OWNER_WATER && !CheckOwnership(st->owner)) {

		return CMD_ERROR;

	}

	tile = st->airport.tile;

	CommandCost cost(EXPENSES_CONSTRUCTION);

	const Aircraft *a;

	FOR_ALL_AIRCRAFT(a) {

		if (!a->IsNormalAircraft()) continue;

		if (a->targetairport == st->index && a->state != FLYING) return CMD_ERROR;

	}

	TILE_AREA_LOOP(tile_cur, st->airport) {

		if (!st->TileBelongsToAirport(tile_cur)) continue;

		ret.SetGlobalErrorMessage();

		if (ret.Failed()) return ret;

		cost.AddCost(_price[PR_CLEAR_STATION_AIRPORT]);

		if (flags & DC_EXEC) {

			DeleteAnimatedTile(tile_cur);

			DoClearSquare(tile_cur);

		}

	}

	if (flags & DC_EXEC) {

		for (uint i = 0; i < as->nof_depots; ++i) {

			DeleteWindowById(

				WC_VEHICLE_DEPOT, st->GetHangarTile(i)

			);

		}

		/* Go get the final noise level, that is base noise minus factor from distance to town center.

		 * And as for construction, always remove it, even if the setting is not set, in order to avoid the

		 * need of recalculation */

		Town *nearest = AirportGetNearestTown(as, tile);

		nearest->noise_reached -= GetAirportNoiseLevelForTown(as, nearest->xy, tile);

		st->airport.Clear();

		st->facilities &= ~FACIL_AIRPORT;

		SetWindowWidgetDirty(WC_STATION_VIEW, st->index, SVW_PLANES);

		if (_settings_game.economy.station_noise_level) {

			SetWindowDirty(WC_TOWN_VIEW, st->town->index);

		}

		st->UpdateVirtCoord();

		st->RecomputeIndustriesNear();

		DeleteStationIfEmpty(st);

	}

	return cost;

}

/**

 * Tests whether the company's vehicles have this station in orders

 * When company == INVALID_COMPANY, then check all vehicles

 * @param station station ID

 * @param company company ID, INVALID_COMPANY to disable the check

 */