1

/* $Id$ */

     2

     3

/** @file road_map.h */

     4

     5

#ifndef ROAD_MAP_H

     6

#define ROAD_MAP_H

     7

     8

#include "macros.h"

     9

#include "rail.h"

    10

#include "road.h"

    11

#include "tile.h"

    12

    13

    14

enum RoadTileType {

    15

	ROAD_TILE_NORMAL,

    16

	ROAD_TILE_CROSSING,

    17

	ROAD_TILE_DEPOT

    18

};

    19

    20

static inline RoadTileType GetRoadTileType(TileIndex t)

    21

	{

    22

	assert(IsTileType(t, MP_ROAD));

    23

	return (RoadTileType)GB(_m[t].m5, 6, 2);

    24

}

    25

    26

static inline bool IsLevelCrossing(TileIndex t)

    27

{

    28

	return GetRoadTileType(t) == ROAD_TILE_CROSSING;

    29

}

    30

    31

static inline bool IsLevelCrossingTile(TileIndex t)

    32

{

    33

	return IsTileType(t, MP_ROAD) && IsLevelCrossing(t);

    34

}

    35

    36

static inline RoadBits GetRoadBits(TileIndex t, RoadType rt)

    37

{

    38

	assert(GetRoadTileType(t) == ROAD_TILE_NORMAL);

    39

	switch (rt) {

    40

		default: NOT_REACHED();

    41

		case ROADTYPE_ROAD: return (RoadBits)GB(_m[t].m4, 0, 4);

    42

		case ROADTYPE_TRAM: return (RoadBits)GB(_m[t].m4, 4, 4);

    43

		case ROADTYPE_HWAY: return (RoadBits)GB(_m[t].m6, 2, 4);

    44

	}

    45

}

    46

    47

static inline RoadBits GetAllRoadBits(TileIndex tile)

    48

{

    49

	return GetRoadBits(tile, ROADTYPE_ROAD) | GetRoadBits(tile, ROADTYPE_TRAM) | GetRoadBits(tile, ROADTYPE_HWAY);

    50

}

    51

    52

static inline void SetRoadBits(TileIndex t, RoadBits r, RoadType rt)

    53

{

    54

	assert(GetRoadTileType(t) == ROAD_TILE_NORMAL); // XXX incomplete

    55

	switch (rt) {

    56

		default: NOT_REACHED();

    57

		case ROADTYPE_ROAD: SB(_m[t].m4, 0, 4, r); break;

    58

		case ROADTYPE_TRAM: SB(_m[t].m4, 4, 4, r); break;

    59

		case ROADTYPE_HWAY: SB(_m[t].m6, 2, 4, r); break;

    60

	}

    61

}

    62

    63

static inline RoadTypes GetRoadTypes(TileIndex t)

    64

{

    65

	if (IsTileType(t, MP_ROAD)) {

    66

		return (RoadTypes)GB(_me[t].m7, 5, 3);

    67

	} else {

    68

		return (RoadTypes)GB(_m[t].m3, 0, 3);

    69

	}

    70

}

    71

    72

static inline void SetRoadTypes(TileIndex t, RoadTypes rt)

    73

{

    74

	if (IsTileType(t, MP_ROAD)) {

    75

		SB(_me[t].m7, 5, 3, rt);

    76

	} else {

    77

		assert(IsTileType(t, MP_STATION) || IsTileType(t, MP_TUNNELBRIDGE));

    78

		SB(_m[t].m3, 0, 2, rt);

    79

	}

    80

}

    81

    82

static inline Owner GetRoadOwner(TileIndex t, RoadType rt)

    83

{

    84

	if (!IsTileType(t, MP_ROAD)) return GetTileOwner(t);

    85

    86

	switch (GetRoadTileType(t)) {

    87

		default: NOT_REACHED();

    88

		case ROAD_TILE_NORMAL:

    89

			switch (rt) {

    90

				default: NOT_REACHED();

    91

				case ROADTYPE_ROAD: return (Owner)GB( _m[t].m1, 0, 5);

    92

				case ROADTYPE_TRAM: {

    93

					/* Trams don't need OWNER_TOWN, and remapping OWNER_NONE

    94

					 * to OWNER_TOWN makes it use one bit less */

    95

					Owner o = (Owner)GB( _m[t].m5, 0, 4);

    96

					return o == OWNER_TOWN ? OWNER_NONE : o;

    97

				}

    98

				case ROADTYPE_HWAY: return (Owner)GB(_me[t].m7, 0, 5);

    99

			}

   100

		case ROAD_TILE_CROSSING:

   101

			switch (rt) {

   102

				default: NOT_REACHED();

   103

				case ROADTYPE_ROAD: return (Owner)GB( _m[t].m4, 0, 5);

   104

				case ROADTYPE_TRAM: {

   105

					/* Trams don't need OWNER_TOWN, and remapping OWNER_NONE

   106

					 * to OWNER_TOWN makes it use one bit less */

   107

					Owner o = (Owner)GB( _m[t].m5, 0, 4);

   108

					return o == OWNER_TOWN ? OWNER_NONE : o;

   109

				}

   110

				case ROADTYPE_HWAY: return (Owner)GB(_me[t].m7, 0, 5);

   111

			}

   112

		case ROAD_TILE_DEPOT: return GetTileOwner(t);

   113

	}

   114

}

   115

   116

static inline void SetRoadOwner(TileIndex t, RoadType rt, Owner o)

   117

{

   118

	if (!IsTileType(t, MP_ROAD)) return SetTileOwner(t, o);

   119

   120

	switch (GetRoadTileType(t)) {

   121

		default: NOT_REACHED();

   122

		case ROAD_TILE_NORMAL:

   123

			switch (rt) {

   124

				default: NOT_REACHED();

   125

				case ROADTYPE_ROAD: SB( _m[t].m1, 0, 5, o); break;

   126

				case ROADTYPE_TRAM: SB( _m[t].m5, 0, 4, o == OWNER_NONE ? OWNER_TOWN : o); break;

   127

				case ROADTYPE_HWAY: SB(_me[t].m7, 0, 5, o); break;

   128

			}

   129

			break;

   130

		case ROAD_TILE_CROSSING:

   131

			switch (rt) {

   132

				default: NOT_REACHED();

   133

				case ROADTYPE_ROAD: SB( _m[t].m4, 0, 5, o); break;

   134

				/* Trams don't need OWNER_TOWN, and remapping OWNER_NONE

   135

				 * to OWNER_TOWN makes it use one bit less */

   136

				case ROADTYPE_TRAM: SB( _m[t].m5, 0, 4, o == OWNER_NONE ? OWNER_TOWN : o); break;

   137

				case ROADTYPE_HWAY: SB(_me[t].m7, 0, 5, o); break;

   138

			}

   139

			break;

   140

		case ROAD_TILE_DEPOT: return SetTileOwner(t, o);

   141

	}

   142

}

   143

   144

/** Which directions are disallowed ? */

   145

enum DisallowedRoadDirections {

   146

	DRD_NONE,       ///< None of the directions are disallowed

   147

	DRD_SOUTHBOUND, ///< All southbound traffic is disallowed

   148

	DRD_NORTHBOUND, ///< All northbound traffic is disallowed

   149

	DRD_BOTH,       ///< All directions are disallowed

   150

	DRD_END

   151

};

   152

DECLARE_ENUM_AS_BIT_SET(DisallowedRoadDirections);

   153

   154

/**

   155

 * Gets the disallowed directions

   156

 * @param t the tile to get the directions from

   157

 * @return the disallowed directions

   158

 */

   159

static inline DisallowedRoadDirections GetDisallowedRoadDirections(TileIndex t)

   160

{

   161

	assert(GetRoadTileType(t) == ROAD_TILE_NORMAL);

   162

	return (DisallowedRoadDirections)GB(_m[t].m5, 4, 2);

   163

}

   164

   165

/**

   166

 * Sets the disallowed directions

   167

 * @param t   the tile to set the directions for

   168

 * @param drd the disallowed directions

   169

 */

   170

static inline void SetDisallowedRoadDirections(TileIndex t, DisallowedRoadDirections drd)

   171

{

   172

	assert(GetRoadTileType(t) == ROAD_TILE_NORMAL);

   173

	assert(drd < DRD_END);

   174

	SB(_m[t].m5, 4, 2, drd);

   175

}

   176

   177

static inline Axis GetCrossingRoadAxis(TileIndex t)

   178

{

   179

	assert(GetRoadTileType(t) == ROAD_TILE_CROSSING);

   180

	return (Axis)GB(_m[t].m4, 6, 1);

   181

}

   182

   183

static inline RoadBits GetCrossingRoadBits(TileIndex tile)

   184

{

   185

	return GetCrossingRoadAxis(tile) == AXIS_X ? ROAD_X : ROAD_Y;

   186

}

   187

   188

static inline TrackBits GetCrossingRailBits(TileIndex tile)

   189

{

   190

	return AxisToTrackBits(OtherAxis(GetCrossingRoadAxis(tile)));

   191

}

   192

   193

   194

static inline void UnbarCrossing(TileIndex t)

   195

{

   196

	assert(GetRoadTileType(t) == ROAD_TILE_CROSSING);

   197

	ClrBit(_m[t].m4, 5);

   198

}

   199

   200

static inline void BarCrossing(TileIndex t)

   201

{

   202

	assert(GetRoadTileType(t) == ROAD_TILE_CROSSING);

   204

}

   205

   206

static inline bool IsCrossingBarred(TileIndex t)

   207

{

   208

	assert(GetRoadTileType(t) == ROAD_TILE_CROSSING);

   209

	return HasBit(_m[t].m4, 5);

   210

}

   211

   212

#define IsOnDesert IsOnSnow

   213

static inline bool IsOnSnow(TileIndex t)

   214

{

   215

	return HasBit(_m[t].m3, 7);

   216

}

   217

   218

#define ToggleDesert ToggleSnow

   219

static inline void ToggleSnow(TileIndex t)

   220

{

   221

	TOGGLEBIT(_m[t].m3, 7);

   222

}

   223

   224

   225

enum Roadside {

   226

	ROADSIDE_BARREN           = 0,

   227

	ROADSIDE_GRASS            = 1,

   228

	ROADSIDE_PAVED            = 2,

   229

	ROADSIDE_STREET_LIGHTS    = 3,

   230

	ROADSIDE_TREES            = 5,

   231

	ROADSIDE_GRASS_ROAD_WORKS = 6,

   232

	ROADSIDE_PAVED_ROAD_WORKS = 7

   233

};

   234

   235

static inline Roadside GetRoadside(TileIndex tile)

   236

{

   237

	return (Roadside)GB(_m[tile].m3, 4, 3);

   238

}

   239

   240

static inline void SetRoadside(TileIndex tile, Roadside s)

   241

{

   242

	SB(_m[tile].m3, 4, 3, s);

   243

}

   244

   245

static inline bool HasRoadWorks(TileIndex t)

   246

{

   247

	return GetRoadside(t) >= ROADSIDE_GRASS_ROAD_WORKS;

   248

}

   249

   250

static inline bool IncreaseRoadWorksCounter(TileIndex t)

   251

{

   252

	AB(_m[t].m3, 0, 4, 1);

   253

   254

	return GB(_m[t].m3, 0, 4) == 15;

   255

}

   256

   257

static inline void StartRoadWorks(TileIndex t)

   258

{

   259

	assert(!HasRoadWorks(t));

   260

	/* Remove any trees or lamps in case or roadwork */

   261

	switch (GetRoadside(t)) {

   262

		case ROADSIDE_BARREN:

   263

		case ROADSIDE_GRASS:  SetRoadside(t, ROADSIDE_GRASS_ROAD_WORKS); break;

   264

		default:              SetRoadside(t, ROADSIDE_PAVED_ROAD_WORKS); break;

   265

	}

   266

}

   267

   268

static inline void TerminateRoadWorks(TileIndex t)

   269

{

   270

	assert(HasRoadWorks(t));

   271

	SetRoadside(t, (Roadside)(GetRoadside(t) - ROADSIDE_GRASS_ROAD_WORKS + ROADSIDE_GRASS));

   272

	/* Stop the counter */

   273

	SB(_m[t].m3, 0, 4, 0);

   274

}

   275

   276

   277

static inline DiagDirection GetRoadDepotDirection(TileIndex t)

   278

{

   279

	assert(GetRoadTileType(t) == ROAD_TILE_DEPOT);

   280

	return (DiagDirection)GB(_m[t].m5, 0, 2);

   281

}

   282

   283

   284

/**

   285

 * Returns the RoadBits on an arbitrary tile

   286

 * Special behaviour:

   287

 * - road depots: entrance is treated as road piece

   288

 * - road tunnels: entrance is treated as road piece

   289

 * - bridge ramps: start of the ramp is treated as road piece

   290

 * - bridge middle parts: bridge itself is ignored

   291

 * @param tile the tile to get the road bits for

   292

 * @param rt   the road type to get the road bits form

   293

 * @return the road bits of the given tile

   294

 */

   295

RoadBits GetAnyRoadBits(TileIndex tile, RoadType rt);

   296

   297

/**

   298

 * Get the accessible track bits for the given tile.

   299

 * Special behaviour:

   300

 *  - road depots: no track bits

   301

 *  - non-drive-through stations: no track bits

   302

 * @param tile the tile to get the track bits for

   303

 * @return the track bits for the given tile

   304

 */

   305

TrackBits GetAnyRoadTrackBits(TileIndex tile, RoadType rt);

   306

   307

   308

static inline void MakeRoadNormal(TileIndex t, RoadBits bits, RoadTypes rot, TownID town, Owner road, Owner tram, Owner hway)

   309

{

   310

	SetTileType(t, MP_ROAD);

   311

	SetTileOwner(t, road);

   312

	_m[t].m2 = town;

   313

	_m[t].m3 = 0;

   314

	_m[t].m4 = (HasBit(rot, ROADTYPE_TRAM) ? bits : 0) << 4 | (HasBit(rot, ROADTYPE_ROAD) ? bits : 0);

   315

	_m[t].m5 = ROAD_TILE_NORMAL << 6;

   316

	SetRoadOwner(t, ROADTYPE_TRAM, tram);

   317

	SB(_m[t].m6, 2, 4, HasBit(rot, ROADTYPE_HWAY) ? bits : 0);

   318

	_me[t].m7 = rot << 5 | hway;

   319

}

   320

   321

   322

static inline void MakeRoadCrossing(TileIndex t, Owner road, Owner tram, Owner hway, Owner rail, Axis roaddir, RailType rat, RoadTypes rot, uint town)

   323

{

   324

	SetTileType(t, MP_ROAD);

   325

	SetTileOwner(t, rail);

   326

	_m[t].m2 = town;

   327

	_m[t].m3 = rat;

   328

	_m[t].m4 = roaddir << 6 | road;

   329

	_m[t].m5 = ROAD_TILE_CROSSING << 6;

   330

	SetRoadOwner(t, ROADTYPE_TRAM, tram);

   331

	SB(_m[t].m6, 2, 4, 0);

   332

	_me[t].m7 = rot << 5 | hway;

   333

}

   334

   335

   336

static inline void MakeRoadDepot(TileIndex t, Owner owner, DiagDirection dir, RoadType rt)

   337

{

   338

	SetTileType(t, MP_ROAD);

   339

	SetTileOwner(t, owner);

   340

	_m[t].m2 = 0;

   341

	_m[t].m3 = 0;

   342

	_m[t].m4 = 0;

   343

	_m[t].m5 = ROAD_TILE_DEPOT << 6 | dir;

   344

	SB(_m[t].m6, 2, 4, 0);

   345

	_me[t].m7 = RoadTypeToRoadTypes(rt) << 5;

   346

}

   347

   348

#endif /* ROAD_MAP_H */