rubidium@9723: /* $Id$ */
rubidium@9723: 
rubidium@10455: /** @file map_func.h Functions related to maps. */
rubidium@9723: 
rubidium@9723: #ifndef MAP_FUNC_H
rubidium@9723: #define MAP_FUNC_H
rubidium@9723: 
rubidium@9723: #include "tile_type.h"
rubidium@9723: #include "map_type.h"
rubidium@9723: #include "direction_func.h"
rubidium@9723: 
rubidium@9723: extern uint _map_tile_mask;
rubidium@9723: 
rubidium@9723: /**
rubidium@9723:  * 'Wraps' the given tile to it is within the map. It does
rubidium@9723:  * this by masking the 'high' bits of.
rubidium@9723:  * @param x the tile to 'wrap'
rubidium@9723:  */
rubidium@9723: 
rubidium@9723: #define TILE_MASK(x) ((x) & _map_tile_mask)
rubidium@9723: /**
rubidium@9723:  * Asserts when the tile is outside of the map.
rubidium@9723:  * @param x the tile to check
rubidium@9723:  */
rubidium@9723: #define TILE_ASSERT(x) assert(TILE_MASK(x) == (x));
rubidium@9723: 
rubidium@9723: /**
rubidium@9723:  * Pointer to the tile-array.
rubidium@9723:  *
rubidium@9723:  * This variable points to the tile-array which contains the tiles of
rubidium@9723:  * the map.
rubidium@9723:  */
rubidium@9723: extern Tile *_m;
rubidium@9723: 
rubidium@9723: /**
rubidium@9723:  * Pointer to the extended tile-array.
rubidium@9723:  *
rubidium@9723:  * This variable points to the extended tile-array which contains the tiles
rubidium@9723:  * of the map.
rubidium@9723:  */
rubidium@9723: extern TileExtended *_me;
rubidium@9723: 
rubidium@9723: /**
rubidium@9723:  * Allocate a new map with the given size.
rubidium@9723:  */
rubidium@9723: void AllocateMap(uint size_x, uint size_y);
rubidium@9723: 
rubidium@9723: /**
rubidium@9723:  * Logarithm of the map size along the X side.
rubidium@9723:  * @note try to avoid using this one
rubidium@9723:  * @return 2^"return value" == MapSizeX()
rubidium@9723:  */
rubidium@9723: static inline uint MapLogX()
rubidium@9723: {
rubidium@9723: 	extern uint _map_log_x;
rubidium@9723: 	return _map_log_x;
rubidium@9723: }
rubidium@9723: 
rubidium@9723: /**
rubidium@9724:  * Logarithm of the map size along the y side.
rubidium@9724:  * @note try to avoid using this one
rubidium@9724:  * @return 2^"return value" == MapSizeY()
rubidium@9724:  */
rubidium@9724: static inline uint MapLogY()
rubidium@9724: {
rubidium@9724: 	extern uint _map_log_y;
rubidium@9724: 	return _map_log_y;
rubidium@9724: }
rubidium@9724: 
rubidium@9724: /**
rubidium@9723:  * Get the size of the map along the X
rubidium@9723:  * @return the number of tiles along the X of the map
rubidium@9723:  */
rubidium@9723: static inline uint MapSizeX()
rubidium@9723: {
rubidium@9723: 	extern uint _map_size_x;
rubidium@9723: 	return _map_size_x;
rubidium@9723: }
rubidium@9723: 
rubidium@9723: /**
rubidium@9723:  * Get the size of the map along the Y
rubidium@9723:  * @return the number of tiles along the Y of the map
rubidium@9723:  */
rubidium@9723: static inline uint MapSizeY()
rubidium@9723: {
rubidium@9723: 	extern uint _map_size_y;
rubidium@9723: 	return _map_size_y;
rubidium@9723: }
rubidium@9723: 
rubidium@9723: /**
rubidium@9723:  * Get the size of the map
rubidium@9723:  * @return the number of tiles of the map
rubidium@9723:  */
rubidium@9723: static inline uint MapSize()
rubidium@9723: {
rubidium@9723: 	extern uint _map_size;
rubidium@9723: 	return _map_size;
rubidium@9723: }
rubidium@9723: 
rubidium@9723: /**
rubidium@9723:  * Gets the maximum X coordinate within the map, including MP_VOID
rubidium@9723:  * @return the maximum X coordinate
rubidium@9723:  */
rubidium@9723: static inline uint MapMaxX()
rubidium@9723: {
rubidium@9723: 	return MapSizeX() - 1;
rubidium@9723: }
rubidium@9723: 
rubidium@9723: /**
rubidium@9723:  * Gets the maximum X coordinate within the map, including MP_VOID
rubidium@9723:  * @return the maximum X coordinate
rubidium@9723:  */
rubidium@9723: static inline uint MapMaxY()
rubidium@9723: {
rubidium@9723: 	return MapSizeY() - 1;
rubidium@9723: }
rubidium@9723: 
rubidium@9723: /**
rubidium@9723:  * Scales relative to the number of tiles.
rubidium@9723:  */
rubidium@9723: uint ScaleByMapSize(uint);
rubidium@9723: 
rubidium@9723: /**
rubidium@9723:  * Scale relative to the circumference of the map.
rubidium@9723:  */
rubidium@9723: uint ScaleByMapSize1D(uint);
rubidium@9723: 
rubidium@9723: /**
rubidium@9723:  * An offset value between to tiles.
rubidium@9723:  *
rubidium@9723:  * This value is used fro the difference between
rubidium@9723:  * to tiles. It can be added to a tileindex to get
rubidium@9723:  * the resulting tileindex of the start tile applied
rubidium@9723:  * with this saved difference.
rubidium@9723:  *
rubidium@9723:  * @see TileDiffXY(int, int)
rubidium@9723:  */
rubidium@9723: typedef int32 TileIndexDiff;
rubidium@9723: 
rubidium@9723: /**
rubidium@9723:  * Returns the TileIndex of a coordinate.
rubidium@9723:  *
rubidium@9723:  * @param x The x coordinate of the tile
rubidium@9723:  * @param y The y coordinate of the tile
rubidium@9723:  * @return The TileIndex calculated by the coordinate
rubidium@9723:  */
rubidium@9723: static inline TileIndex TileXY(uint x, uint y)
rubidium@9723: {
rubidium@9723: 	return (y * MapSizeX()) + x;
rubidium@9723: }
rubidium@9723: 
rubidium@9723: /**
rubidium@9723:  * Calculates an offset for the given coordinate(-offset).
rubidium@9723:  *
rubidium@9723:  * This function calculate an offset value which can be added to an
rubidium@9723:  * #TileIndex. The coordinates can be negative.
rubidium@9723:  *
rubidium@9723:  * @param x The offset in x direction
rubidium@9723:  * @param y The offset in y direction
rubidium@9723:  * @return The resulting offset value of the given coordinate
rubidium@9723:  * @see ToTileIndexDiff(TileIndexDiffC)
rubidium@9723:  */
rubidium@9723: static inline TileIndexDiff TileDiffXY(int x, int y)
rubidium@9723: {
rubidium@9723: 	/* Multiplication gives much better optimization on MSVC than shifting.
rubidium@9723: 	 * 0 << shift isn't optimized to 0 properly.
rubidium@9723: 	 * Typically x and y are constants, and then this doesn't result
rubidium@9723: 	 * in any actual multiplication in the assembly code.. */
rubidium@9723: 	return (y * MapSizeX()) + x;
rubidium@9723: }
rubidium@9723: 
rubidium@9723: static inline TileIndex TileVirtXY(uint x, uint y)
rubidium@9723: {
rubidium@9723: 	return (y >> 4 << MapLogX()) + (x >> 4);
rubidium@9723: }
rubidium@9723: 
rubidium@9723: 
rubidium@9723: /**
rubidium@9723:  * Get the X component of a tile
rubidium@9723:  * @param tile the tile to get the X component of
rubidium@9723:  * @return the X component
rubidium@9723:  */
rubidium@9723: static inline uint TileX(TileIndex tile)
rubidium@9723: {
rubidium@9723: 	return tile & MapMaxX();
rubidium@9723: }
rubidium@9723: 
rubidium@9723: /**
rubidium@9723:  * Get the Y component of a tile
rubidium@9723:  * @param tile the tile to get the Y component of
rubidium@9723:  * @return the Y component
rubidium@9723:  */
rubidium@9723: static inline uint TileY(TileIndex tile)
rubidium@9723: {
rubidium@9723: 	return tile >> MapLogX();
rubidium@9723: }
rubidium@9723: 
rubidium@9723: /**
rubidium@9723:  * Return the offset between to tiles from a TileIndexDiffC struct.
rubidium@9723:  *
rubidium@9723:  * This function works like #TileDiffXY(int, int) and returns the
rubidium@9723:  * difference between two tiles.
rubidium@9723:  *
rubidium@9723:  * @param tidc The coordinate of the offset as TileIndexDiffC
rubidium@9723:  * @return The difference between two tiles.
rubidium@9723:  * @see TileDiffXY(int, int)
rubidium@9723:  */
rubidium@9723: static inline TileIndexDiff ToTileIndexDiff(TileIndexDiffC tidc)
rubidium@9723: {
rubidium@9723: 	return (tidc.y << MapLogX()) + tidc.x;
rubidium@9723: }
rubidium@9723: 
rubidium@9723: 
rubidium@9723: #ifndef _DEBUG
rubidium@9723: 	/**
rubidium@9723: 	 * Adds to tiles together.
rubidium@9723: 	 *
rubidium@9723: 	 * @param x One tile
rubidium@9723: 	 * @param y An other tile to add
rubidium@9723: 	 * @return The resulting tile(index)
rubidium@9723: 	 */
rubidium@9723: 	#define TILE_ADD(x,y) ((x) + (y))
rubidium@9723: #else
rubidium@9723: 	extern TileIndex TileAdd(TileIndex tile, TileIndexDiff add,
rubidium@9723: 		const char *exp, const char *file, int line);
rubidium@9723: 	#define TILE_ADD(x, y) (TileAdd((x), (y), #x " + " #y, __FILE__, __LINE__))
rubidium@9723: #endif
rubidium@9723: 
rubidium@9723: /**
rubidium@9723:  * Adds a given offset to a tile.
rubidium@9723:  *
rubidium@9723:  * @param tile The tile to add an offset on it
rubidium@9723:  * @param x The x offset to add to the tile
rubidium@9723:  * @param y The y offset to add to the tile
rubidium@9723:  */
rubidium@9723: #define TILE_ADDXY(tile, x, y) TILE_ADD(tile, TileDiffXY(x, y))
rubidium@9723: 
rubidium@9723: /**
rubidium@9723:  * Adds an offset to a tile and check if we are still on the map.
rubidium@9723:  */
rubidium@9724: TileIndex TileAddWrap(TileIndex tile, int addx, int addy);
rubidium@9723: 
rubidium@9723: /**
rubidium@9723:  * Returns the TileIndexDiffC offset from a DiagDirection.
rubidium@9723:  *
rubidium@9723:  * @param dir The given direction
rubidium@9723:  * @return The offset as TileIndexDiffC value
rubidium@9723:  */
rubidium@9723: static inline TileIndexDiffC TileIndexDiffCByDiagDir(DiagDirection dir)
rubidium@9723: {
rubidium@9723: 	extern const TileIndexDiffC _tileoffs_by_diagdir[DIAGDIR_END];
rubidium@9723: 
rubidium@9723: 	assert(IsValidDiagDirection(dir));
rubidium@9723: 	return _tileoffs_by_diagdir[dir];
rubidium@9723: }
rubidium@9723: 
rubidium@9723: /**
rubidium@9724:  * Returns the TileIndexDiffC offset from a Direction.
rubidium@9724:  *
rubidium@9724:  * @param dir The given direction
rubidium@9724:  * @return The offset as TileIndexDiffC value
rubidium@9724:  */
rubidium@9724: static inline TileIndexDiffC TileIndexDiffCByDir(Direction dir)
rubidium@9724: {
rubidium@9724: 	extern const TileIndexDiffC _tileoffs_by_dir[DIR_END];
rubidium@9724: 
rubidium@9724: 	assert(IsValidDirection(dir));
rubidium@9724: 	return _tileoffs_by_dir[dir];
rubidium@9724: }
rubidium@9724: 
rubidium@9724: /**
rubidium@9723:  * Add a TileIndexDiffC to a TileIndex and returns the new one.
rubidium@9723:  *
rubidium@9723:  * Returns tile + the diff given in diff. If the result tile would end up
rubidium@9723:  * outside of the map, INVALID_TILE is returned instead.
rubidium@9723:  *
rubidium@9723:  * @param tile The base tile to add the offset on
rubidium@9723:  * @param diff The offset to add on the tile
rubidium@9723:  * @return The resulting TileIndex
rubidium@9723:  */
rubidium@9723: static inline TileIndex AddTileIndexDiffCWrap(TileIndex tile, TileIndexDiffC diff)
rubidium@9723: {
rubidium@9723: 	int x = TileX(tile) + diff.x;
rubidium@9723: 	int y = TileY(tile) + diff.y;
rubidium@9723: 	if (x < 0 || y < 0 || x > (int)MapMaxX() || y > (int)MapMaxY())
rubidium@9723: 		return INVALID_TILE;
rubidium@9723: 	else
rubidium@9723: 		return TileXY(x, y);
rubidium@9723: }
rubidium@9723: 
rubidium@9723: /**
rubidium@9723:  * Returns the diff between two tiles
rubidium@9723:  *
rubidium@9723:  * @param tile_a from tile
rubidium@9723:  * @param tile_b to tile
rubidium@9723:  * @return the difference between tila_a and tile_b
rubidium@9723:  */
rubidium@9723: static inline TileIndexDiffC TileIndexToTileIndexDiffC(TileIndex tile_a, TileIndex tile_b)
rubidium@9723: {
rubidium@9723: 	TileIndexDiffC difference;
rubidium@9723: 
rubidium@9723: 	difference.x = TileX(tile_a) - TileX(tile_b);
rubidium@9723: 	difference.y = TileY(tile_a) - TileY(tile_b);
rubidium@9723: 
rubidium@9723: 	return difference;
rubidium@9723: }
rubidium@9723: 
rubidium@9723: /* Functions to calculate distances */
rubidium@9723: uint DistanceManhattan(TileIndex, TileIndex); ///< also known as L1-Norm. Is the shortest distance one could go over diagonal tracks (or roads)
rubidium@9723: uint DistanceSquare(TileIndex, TileIndex); ///< euclidian- or L2-Norm squared
rubidium@9723: uint DistanceMax(TileIndex, TileIndex); ///< also known as L-Infinity-Norm
rubidium@9723: uint DistanceMaxPlusManhattan(TileIndex, TileIndex); ///< Max + Manhattan
rubidium@9723: uint DistanceFromEdge(TileIndex); ///< shortest distance from any edge of the map
rubidium@9723: 
rubidium@9723: /**
rubidium@9723:  * Starts a loop which iterates to a square of tiles
rubidium@9723:  *
rubidium@9723:  * This macro starts 2 nested loops which iterates over a square of tiles.
rubidium@9723:  *
rubidium@9723:  * @param var The name of the variable which contains the current tile
rubidium@9723:  * @param w The width (x-width) of the square
rubidium@9723:  * @param h The heigth (y-width) of the square
rubidium@9723:  * @param tile The start tile of the square
rubidium@9723:  */
rubidium@9723: #define BEGIN_TILE_LOOP(var, w, h, tile)                      \
rubidium@9723: 	{                                                        \
rubidium@9723: 		int h_cur = h;                                         \
rubidium@9723: 		uint var = tile;                                       \
rubidium@9723: 		do {                                                   \
rubidium@9723: 			int w_cur = w;                                       \
rubidium@9723: 			do {
rubidium@9723: /**
rubidium@9723:  * Ends the square-loop used before
rubidium@9723:  *
rubidium@9723:  * @see BEGIN_TILE_LOOP
rubidium@9723:  */
rubidium@9723: #define END_TILE_LOOP(var, w, h, tile)                        \
rubidium@9723: 			} while (++var, --w_cur != 0);                       \
rubidium@9723: 		} while (var += TileDiffXY(0, 1) - (w), --h_cur != 0); \
rubidium@9723: 	}
rubidium@9723: /**
rubidium@9723:  * Convert a DiagDirection to a TileIndexDiff
rubidium@9723:  *
rubidium@9723:  * @param dir The DiagDirection
rubidium@9723:  * @return The resulting TileIndexDiff
rubidium@9723:  * @see TileIndexDiffCByDiagDir
rubidium@9723:  */
rubidium@9723: static inline TileIndexDiff TileOffsByDiagDir(DiagDirection dir)
rubidium@9723: {
rubidium@9723: 	extern const TileIndexDiffC _tileoffs_by_diagdir[DIAGDIR_END];
rubidium@9723: 
rubidium@9723: 	assert(IsValidDiagDirection(dir));
rubidium@9723: 	return ToTileIndexDiff(_tileoffs_by_diagdir[dir]);
rubidium@9723: }
rubidium@9723: 
rubidium@9723: /**
rubidium@9723:  * Convert a Direction to a TileIndexDiff.
rubidium@9723:  *
rubidium@9723:  * @param dir The direction to convert from
rubidium@9723:  * @return The resulting TileIndexDiff
rubidium@9723:  */
rubidium@9723: static inline TileIndexDiff TileOffsByDir(Direction dir)
rubidium@9723: {
rubidium@9723: 	extern const TileIndexDiffC _tileoffs_by_dir[DIR_END];
rubidium@9723: 
rubidium@9723: 	assert(IsValidDirection(dir));
rubidium@9723: 	return ToTileIndexDiff(_tileoffs_by_dir[dir]);
rubidium@9723: }
rubidium@9723: 
rubidium@9723: /**
rubidium@9723:  * Adds a DiagDir to a tile.
rubidium@9723:  *
rubidium@9723:  * @param tile The current tile
rubidium@9723:  * @param dir The direction in which we want to step
rubidium@9723:  * @return the moved tile
rubidium@9723:  */
rubidium@9723: static inline TileIndex TileAddByDiagDir(TileIndex tile, DiagDirection dir)
rubidium@9723: {
rubidium@9723: 	return TILE_ADD(tile, TileOffsByDiagDir(dir));
rubidium@9723: }
rubidium@9723: 
rubidium@9723: /**
rubidium@9723:  * A callback function type for searching tiles.
rubidium@9723:  *
rubidium@9723:  * @param tile The tile to test
rubidium@9723:  * @param data additional data for the callback function to use
rubidium@9723:  * @return A boolean value, depend on the definition of the function.
rubidium@9723:  */
rubidium@9723: typedef bool TestTileOnSearchProc(TileIndex tile, uint32 data);
rubidium@9723: 
rubidium@9723: /**
rubidium@9723:  * Searches for some cirumstances of a tile around a given tile with a helper function.
rubidium@9723:  */
rubidium@9723: bool CircularTileSearch(TileIndex tile, uint size, TestTileOnSearchProc proc, uint32 data);
rubidium@9723: 
rubidium@9723: /**
rubidium@9723:  * Get a random tile out of a given seed.
rubidium@9723:  * @param r the random 'seed'
rubidium@9723:  * @return a valid tile
rubidium@9723:  */
rubidium@9723: static inline TileIndex RandomTileSeed(uint32 r)
rubidium@9723: {
rubidium@9723: 	return TILE_MASK(r);
rubidium@9723: }
rubidium@9723: 
rubidium@9723: /**
rubidium@9723:  * Get a valid random tile.
rubidium@9723:  * @note a define so 'random' gets inserted in the place where it is actually
rubidium@9723:  *       called, thus making the random traces more explicit.
rubidium@9723:  * @return a valid tile
rubidium@9723:  */
rubidium@9723: #define RandomTile() RandomTileSeed(Random())
rubidium@9723: 
rubidium@9723: #endif /* MAP_FUNC_H */