tron@3101: /* $Id$ */
tron@3101: 
tron@3101: #ifndef RAIL_MAP_H
tron@3101: #define RAIL_MAP_H
tron@3101: 
tron@3239: #include "direction.h"
tron@3101: #include "tile.h"
tron@3239: 
tron@3239: 
tron@3239: typedef enum RailTileType {
tron@3239: 	RAIL_TYPE_NORMAL         = 0x0,
tron@3239: 	RAIL_TYPE_SIGNALS        = 0x40,
tron@3239: 	RAIL_TYPE_UNUSED         = 0x80, /* XXX: Maybe this could become waypoints? */
tron@3239: 	RAIL_TYPE_DEPOT_WAYPOINT = 0xC0, /* Is really depots and waypoints... */
tron@3239: 	RAIL_TILE_TYPE_MASK      = 0xC0
tron@3239: } RailTileType;
tron@3239: 
tron@3239: static inline RailTileType GetRailTileType(TileIndex t)
tron@3239: {
tron@3239: 	assert(IsTileType(t, MP_RAILWAY));
tron@3239: 	return _m[t].m5 & RAIL_TILE_TYPE_MASK;
tron@3239: }
tron@3239: 
tron@3239: 
tron@3239: /** These specify the subtype when the main rail type is
tron@3239:  * RAIL_TYPE_DEPOT_WAYPOINT */
tron@3239: typedef enum RailTileSubtypes {
tron@3239: 	RAIL_SUBTYPE_DEPOT    = 0x00,
tron@3239: 	RAIL_SUBTYPE_WAYPOINT = 0x04,
tron@3239: 	RAIL_SUBTYPE_MASK     = 0x3C
tron@3239: } RailTileSubtype;
tron@3239: 
tron@3239: 
tron@3239: typedef enum RailTypes {
celestar@3355: 	RAILTYPE_RAIL     = 0,
celestar@3355: 	RAILTYPE_ELECTRIC = 1,
celestar@3355: 	RAILTYPE_MONO     = 2,
celestar@3355: 	RAILTYPE_MAGLEV   = 3,
tron@3239: 	RAILTYPE_END,
tron@3239: 	INVALID_RAILTYPE = 0xFF
tron@3239: } RailType;
tron@3239: 
celestar@3355: typedef byte RailTypeMask;
celestar@3355: 
tron@3239: static inline RailType GetRailType(TileIndex t)
tron@3239: {
tron@3239: 	return (RailType)GB(_m[t].m3, 0, 4);
tron@3239: }
tron@3239: 
tron@3242: // TODO remove this by moving to the same bits as GetRailType()
tron@3242: static inline RailType GetRailTypeCrossing(TileIndex t)
tron@3242: {
tron@3242: 	return (RailType)GB(_m[t].m4, 0, 4);
tron@3242: }
tron@3242: 
tron@3242: static inline RailType GetRailTypeOnBridge(TileIndex t)
tron@3242: {
tron@3242: 	return (RailType)GB(_m[t].m3, 4, 4);
tron@3242: }
tron@3242: 
tron@3242: static inline void SetRailType(TileIndex t, RailType r)
tron@3242: {
tron@3242: 	SB(_m[t].m3, 0, 4, r);
tron@3242: }
tron@3242: 
tron@3242: // TODO remove this by moving to the same bits as SetRailType()
tron@3242: static inline void SetRailTypeCrossing(TileIndex t, RailType r)
tron@3242: {
tron@3242: 	SB(_m[t].m4, 0, 4, r);
tron@3242: }
tron@3242: 
tron@3242: static inline void SetRailTypeOnBridge(TileIndex t, RailType r)
tron@3242: {
tron@3242: 	SB(_m[t].m3, 4, 4, r);
tron@3242: }
tron@3242: 
tron@3239: 
tron@3239: /** These are used to specify a single track.
tron@3239:  * Can be translated to a trackbit with TrackToTrackbit */
tron@3239: typedef enum Track {
tron@3239: 	TRACK_X     = 0,
tron@3239: 	TRACK_Y     = 1,
tron@3239: 	TRACK_UPPER = 2,
tron@3239: 	TRACK_LOWER = 3,
tron@3239: 	TRACK_LEFT  = 4,
tron@3239: 	TRACK_RIGHT = 5,
tron@3239: 	TRACK_END,
tron@3239: 	INVALID_TRACK = 0xFF
tron@3239: } Track;
tron@3239: 
tron@3239: 
tron@3239: /** Bitfield corresponding to Track */
tron@3239: typedef enum TrackBits {
tron@3239: 	TRACK_BIT_X     = 1U << TRACK_X,
tron@3239: 	TRACK_BIT_Y     = 1U << TRACK_Y,
tron@3239: 	TRACK_BIT_UPPER = 1U << TRACK_UPPER,
tron@3239: 	TRACK_BIT_LOWER = 1U << TRACK_LOWER,
tron@3239: 	TRACK_BIT_LEFT  = 1U << TRACK_LEFT,
tron@3239: 	TRACK_BIT_RIGHT = 1U << TRACK_RIGHT,
tron@3258: 	TRACK_BIT_CROSS = TRACK_BIT_X     | TRACK_BIT_Y,
tron@3258: 	TRACK_BIT_HORZ  = TRACK_BIT_UPPER | TRACK_BIT_LOWER,
tron@3258: 	TRACK_BIT_VERT  = TRACK_BIT_LEFT  | TRACK_BIT_RIGHT,
tron@3258: 	TRACK_BIT_3WAY_NE = TRACK_BIT_X | TRACK_BIT_UPPER | TRACK_BIT_RIGHT,
tron@3258: 	TRACK_BIT_3WAY_SE = TRACK_BIT_Y | TRACK_BIT_LOWER | TRACK_BIT_RIGHT,
tron@3258: 	TRACK_BIT_3WAY_SW = TRACK_BIT_X | TRACK_BIT_LOWER | TRACK_BIT_LEFT,
tron@3258: 	TRACK_BIT_3WAY_NW = TRACK_BIT_Y | TRACK_BIT_UPPER | TRACK_BIT_LEFT,
tron@3258: 	TRACK_BIT_ALL   = TRACK_BIT_CROSS | TRACK_BIT_HORZ | TRACK_BIT_VERT,
tron@3239: 	TRACK_BIT_MASK  = 0x3FU
tron@3239: } TrackBits;
tron@3101: 
tron@3267: static inline TrackBits GetTrackBits(TileIndex tile)
tron@3267: {
tron@3267: 	return (TrackBits)GB(_m[tile].m5, 0, 6);
tron@3267: }
tron@3267: 
tron@3273: static inline void SetTrackBits(TileIndex t, TrackBits b)
tron@3273: {
tron@3273: 	SB(_m[t].m5, 0, 6, b);
tron@3273: }
tron@3273: 
tron@3101: 
tron@3185: static inline DiagDirection GetRailDepotDirection(TileIndex t)
tron@3185: {
tron@3185: 	return (DiagDirection)GB(_m[t].m5, 0, 2);
tron@3185: }
tron@3185: 
celestar@3453: static inline Track GetRailWaypointTrack(TileIndex t)
celestar@3448: {
celestar@3448: 	return HASBIT(_m[t].m5, 0) ? TRACK_Y : TRACK_X;
celestar@3448: }
tron@3185: 
tron@3101: static inline TrackBits GetRailWaypointBits(TileIndex t)
tron@3101: {
tron@3239: 	return _m[t].m5 & 1 ? TRACK_BIT_Y : TRACK_BIT_X;
tron@3101: }
tron@3101: 
celestar@3448: static inline void SetCustomWaypointSprite(TileIndex t)
celestar@3448: {
celestar@3448: 	SETBIT(_m[t].m3, 4);
celestar@3448: }
celestar@3448: 
celestar@3448: static inline void ClearCustomWaypointSprite(TileIndex t)
celestar@3448: {
celestar@3448: 	CLRBIT(_m[t].m3, 4);
celestar@3448: }
celestar@3448: 
tron@3101: 
tron@3238: typedef enum SignalType {
tron@3238: 	SIGTYPE_NORMAL  = 0, // normal signal
tron@3238: 	SIGTYPE_ENTRY   = 1, // presignal block entry
tron@3238: 	SIGTYPE_EXIT    = 2, // presignal block exit
tron@3238: 	SIGTYPE_COMBO   = 3  // presignal inter-block
tron@3238: } SignalType;
tron@3238: 
tron@3238: static inline SignalType GetSignalType(TileIndex t)
tron@3238: {
tron@3238: 	assert(GetRailTileType(t) == RAIL_TYPE_SIGNALS);
tron@3238: 	return (SignalType)GB(_m[t].m4, 0, 2);
tron@3238: }
tron@3238: 
tron@3238: static inline void SetSignalType(TileIndex t, SignalType s)
tron@3238: {
tron@3238: 	assert(GetRailTileType(t) == RAIL_TYPE_SIGNALS);
tron@3238: 	SB(_m[t].m4, 0, 2, s);
tron@3238: }
tron@3238: 
tron@3238: 
tron@3237: typedef enum SignalVariant {
tron@3237: 	SIG_ELECTRIC  = 0,
tron@3237: 	SIG_SEMAPHORE = 1
tron@3237: } SignalVariant;
tron@3237: 
tron@3237: static inline SignalVariant GetSignalVariant(TileIndex t)
tron@3237: {
tron@3237: 	return (SignalVariant)GB(_m[t].m4, 2, 1);
tron@3237: }
tron@3237: 
tron@3237: static inline void SetSignalVariant(TileIndex t, SignalVariant v)
tron@3237: {
tron@3237: 	SB(_m[t].m4, 2, 1, v);
tron@3237: }
tron@3237: 
tron@3237: 
tron@3101: static inline void MakeRailNormal(TileIndex t, Owner o, TrackBits b, RailType r)
tron@3101: {
tron@3101: 	SetTileType(t, MP_RAILWAY);
tron@3101: 	SetTileOwner(t, o);
tron@3101: 	_m[t].m2 = 0;
tron@3101: 	_m[t].m3 = r;
tron@3101: 	_m[t].m4 = 0;
tron@3101: 	_m[t].m5 = RAIL_TYPE_NORMAL | b;
tron@3101: }
tron@3101: 
tron@3101: 
tron@3101: static inline void MakeRailDepot(TileIndex t, Owner o, DiagDirection d, RailType r)
tron@3101: {
tron@3101: 	SetTileType(t, MP_RAILWAY);
tron@3101: 	SetTileOwner(t, o);
tron@3101: 	_m[t].m2 = 0;
tron@3101: 	_m[t].m3 = r;
tron@3101: 	_m[t].m4 = 0;
tron@3101: 	_m[t].m5 = RAIL_TYPE_DEPOT_WAYPOINT | RAIL_SUBTYPE_DEPOT | d;
tron@3101: }
tron@3101: 
tron@3101: 
tron@3101: static inline void MakeRailWaypoint(TileIndex t, Owner o, Axis a, RailType r, uint index)
tron@3101: {
tron@3101: 	SetTileType(t, MP_RAILWAY);
tron@3101: 	SetTileOwner(t, o);
tron@3101: 	_m[t].m2 = index;
tron@3101: 	_m[t].m3 = r;
tron@3101: 	_m[t].m4 = 0;
tron@3101: 	_m[t].m5 = RAIL_TYPE_DEPOT_WAYPOINT | RAIL_SUBTYPE_WAYPOINT | a;
tron@3101: }
tron@3101: 
tron@3101: #endif