/**

 * Maps an entity id stored on the map to a GRF file.

 * Entities are objects used ingame (houses, industries, industry tiles) for

 * which we need to correlate the ids from the grf files with the ones in the

 * the savegames themselves.

 * An array of EntityIDMapping structs is saved with the savegame so

 * that those GRFs can be loaded in a different order, or removed safely. The

 * index in the array is the entity's ID stored on the map.

 *

 * The substitute ID is the ID of an original entity that should be used instead

 * if the GRF containing the new entity is not available.

 */

struct EntityIDMapping {

	uint32 grfid;          ///< The GRF ID of the file the entity belongs to

	uint8  entity_id;      ///< The entity ID within the GRF file

	uint8  substitute_id;  ///< The (original) entity ID to use if this GRF is not available

};

class OverrideManagerBase {

protected:

	uint16 *entity_overrides;

	uint32 *grfid_overrides;

	uint16 max_offset;       ///< what is the length of the original entity's array of specs

	uint16 max_new_entities; ///< what is the amount of entities, old and new summed

	uint16 invalid_ID;       ///< ID used to detected invalid entities;

	virtual bool CheckValidNewID(uint16 testid) { return true; }

public:

	EntityIDMapping *mapping_ID; ///< mapping of ids from grf files.  Public out of convenience

	OverrideManagerBase(uint16 offset, uint16 maximum, uint16 invalid);

	virtual ~OverrideManagerBase();

	void ResetOverride();

	void ResetMapping();

	void Add(uint8 local_id, uint32 grfid, uint entity_type);

	virtual uint16 AddEntityID(byte grf_local_id, uint32 grfid, byte substitute_id);

	uint32 GetGRFID(uint16 entity_id) const;

	uint16 GetSubstituteID(uint16 entity_id) const;

	virtual uint16 GetID(uint8 grf_local_id, uint32 grfid) const;

	inline uint16 GetMaxMapping() const { return max_new_entities; }

	inline uint16 GetMaxOffset() const { return max_offset; }

};

struct HouseSpec;

class HouseOverrideManager : public OverrideManagerBase {

public:

	HouseOverrideManager(uint16 offset, uint16 maximum, uint16 invalid) :

			OverrideManagerBase(offset, maximum, invalid) {}

	void SetEntitySpec(const HouseSpec *hs);

};

struct IndustrySpec;

class IndustryOverrideManager : public OverrideManagerBase {

public:

	IndustryOverrideManager(uint16 offset, uint16 maximum, uint16 invalid) :

			OverrideManagerBase(offset, maximum, invalid) {}

	uint16 AddEntityID(byte grf_local_id, uint32 grfid, byte substitute_id) override;

	uint16 GetID(uint8 grf_local_id, uint32 grfid) const override;

	void SetEntitySpec(IndustrySpec *inds);

};

struct IndustryTileSpec;

class IndustryTileOverrideManager : public OverrideManagerBase {

protected:

	virtual bool CheckValidNewID(uint16 testid) { return testid != 0xFF; }

public:

	IndustryTileOverrideManager(uint16 offset, uint16 maximum, uint16 invalid) :

			OverrideManagerBase(offset, maximum, invalid) {}

	void SetEntitySpec(const IndustryTileSpec *indts);

};

struct AirportSpec;

class AirportOverrideManager : public OverrideManagerBase {

public:

	AirportOverrideManager(uint16 offset, uint16 maximum, uint16 invalid) :

			OverrideManagerBase(offset, maximum, invalid) {}

	void SetEntitySpec(AirportSpec *inds);

};

struct AirportTileSpec;

class AirportTileOverrideManager : public OverrideManagerBase {

/*

 * 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_sl.cpp Code handling saving and loading of newgrf config */

#include "../stdafx.h"

#include "../fios.h"

#include "saveload.h"

#include "newgrf_sl.h"

#include "../safeguards.h"

/** Save and load the mapping between a spec and the NewGRF it came from. */

static const SaveLoad _newgrf_mapping_desc[] = {

	SLE_VAR(EntityIDMapping, grfid,         SLE_UINT32),

	SLE_VAR(EntityIDMapping, entity_id,     SLE_UINT8),

	SLE_VAR(EntityIDMapping, substitute_id, SLE_UINT8),

	SLE_END()

};

/**

 * Save a GRF ID + local id -> OpenTTD's id mapping.

 * @param mapping The mapping to save.

 */

void Save_NewGRFMapping(const OverrideManagerBase &mapping)

{

	for (uint i = 0; i < mapping.GetMaxMapping(); i++) {

		SlSetArrayIndex(i);

		SlObject(&mapping.mapping_ID[i], _newgrf_mapping_desc);

	}

}

/**

 * Load a GRF ID + local id -> OpenTTD's id mapping.

 * @param mapping The mapping to load.

 */

void Load_NewGRFMapping(OverrideManagerBase &mapping)

{

	/* Clear the current mapping stored.

	 * This will create the manager if ever it is not yet done */

	mapping.ResetMapping();

	uint max_id = mapping.GetMaxMapping();

	int index;

	while ((index = SlIterateArray()) != -1) {

		if ((uint)index >= max_id) SlErrorCorrupt("Too many NewGRF entity mappings");

		SlObject(&mapping.mapping_ID[index], _newgrf_mapping_desc);

	}

}

static const SaveLoad _grfconfig_desc[] = {

	    SLE_STR(GRFConfig, filename,         SLE_STR,    0x40),

	    SLE_VAR(GRFConfig, ident.grfid,      SLE_UINT32),

	    SLE_ARR(GRFConfig, ident.md5sum,     SLE_UINT8,  16),

	SLE_CONDVAR(GRFConfig, version,          SLE_UINT32, SLV_151, SL_MAX_VERSION),

	    SLE_ARR(GRFConfig, param,            SLE_UINT32, 0x80),

	    SLE_VAR(GRFConfig, num_params,       SLE_UINT8),

	SLE_CONDVAR(GRFConfig, palette,          SLE_UINT8,  SLV_101, SL_MAX_VERSION),

	SLE_END()

};

static void Save_NGRF()

{

	int index = 0;

	for (GRFConfig *c = _grfconfig; c != nullptr; c = c->next) {

		if (HasBit(c->flags, GCF_STATIC)) continue;

		SlSetArrayIndex(index++);

		SlObject(c, _grfconfig_desc);

	}

}