1

/* $Id$ */

     2

     3

/** @file road_map.h */

     4

     5

#ifndef ROAD_MAP_H

     6

#define ROAD_MAP_H

     7

     8

#include "track_func.h"

     9

#include "rail_type.h"

    10

#include "town_type.h"

    11

#include "road_func.h"

    12

#include "tile_map.h"

    13

    14

    15

enum RoadTileType {

    16

	ROAD_TILE_NORMAL,

    17

	ROAD_TILE_CROSSING,

    18

	ROAD_TILE_DEPOT

    19

};

    20

    21

static inline RoadTileType GetRoadTileType(TileIndex t)

    22

	{

    23

	assert(IsTileType(t, MP_ROAD));

    24

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

    25

}

    26

    27

static inline bool IsLevelCrossing(TileIndex t)

    28

{

    29

	return GetRoadTileType(t) == ROAD_TILE_CROSSING;

    30

}

    31

    32

static inline bool IsLevelCrossingTile(TileIndex t)

    33

{

    34

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

    35

}

    36

    37

static inline RoadBits GetRoadBits(TileIndex t, RoadType rt)

    38

{

    39

	assert(GetRoadTileType(t) == ROAD_TILE_NORMAL);

    40

	switch (rt) {

    41

		default: NOT_REACHED();

    42

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

    43

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

    44

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

    45

	}

    46

}

    47

    48

static inline RoadBits GetAllRoadBits(TileIndex tile)

    49

{

    50

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

    51

}

    52

    53

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

    54

{

    55

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

    56

	switch (rt) {

    57

		default: NOT_REACHED();

    58

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

    59

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

    60

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

    61

	}

    62

}

    63

    64

static inline RoadTypes GetRoadTypes(TileIndex t)

    65

{

    66

	if (IsTileType(t, MP_ROAD)) {

    67

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

    68

	} else {

    69

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

    70

	}

    71

}

    72

    73

static inline void SetRoadTypes(TileIndex t, RoadTypes rt)

    74

{

    75

	if (IsTileType(t, MP_ROAD)) {

    76

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

    77

	} else {

    78

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

    79

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

    80

	}

    81

}

    82

    83

static inline Owner GetRoadOwner(TileIndex t, RoadType rt)

    84

{

    85

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

    86

    87

	switch (GetRoadTileType(t)) {

    88

		default: NOT_REACHED();

    89

		case ROAD_TILE_NORMAL:

    90

			switch (rt) {

    91

				default: NOT_REACHED();

    92

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

    93

				case ROADTYPE_TRAM: {

    94

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

    95

					 * to OWNER_TOWN makes it use one bit less */

    96

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

    97

					return o == OWNER_TOWN ? OWNER_NONE : o;

    98

				}

    99

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

   100

			}

   101

		case ROAD_TILE_CROSSING:

   102

			switch (rt) {

   103

				default: NOT_REACHED();

   104

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

   105

				case ROADTYPE_TRAM: {

   106

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

   107

					 * to OWNER_TOWN makes it use one bit less */

   108

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

   109

					return o == OWNER_TOWN ? OWNER_NONE : o;

   110

				}

   111

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

   112

			}

   113

		case ROAD_TILE_DEPOT: return GetTileOwner(t);

   114

	}

   115

}

   116

   117

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

   118

{

   119

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

   120

   121

	switch (GetRoadTileType(t)) {

   122

		default: NOT_REACHED();

   123

		case ROAD_TILE_NORMAL:

   124

			switch (rt) {

   125

				default: NOT_REACHED();

   126

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

   127

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

   128

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

   129

			}

   130

			break;

   131

		case ROAD_TILE_CROSSING:

   132

			switch (rt) {

   133

				default: NOT_REACHED();

   134

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

   135

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

   136

				 * to OWNER_TOWN makes it use one bit less */

   137

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

   138

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

   139

			}

   140

			break;

   141

		case ROAD_TILE_DEPOT: return SetTileOwner(t, o);

   142

	}

   143

}

   144

   145

/** Which directions are disallowed ? */

   146

enum DisallowedRoadDirections {

   147

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

   148

	DRD_SOUTHBOUND, ///< All southbound traffic is disallowed

   149

	DRD_NORTHBOUND, ///< All northbound traffic is disallowed

   150

	DRD_BOTH,       ///< All directions are disallowed

   151

	DRD_END

   152

};

   153

DECLARE_ENUM_AS_BIT_SET(DisallowedRoadDirections);

   154

   155

/**

   156

 * Gets the disallowed directions

   157

 * @param t the tile to get the directions from

   158

 * @return the disallowed directions

   159

 */

   160

static inline DisallowedRoadDirections GetDisallowedRoadDirections(TileIndex t)

   161

{

   162

	assert(GetRoadTileType(t) == ROAD_TILE_NORMAL);

   163

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

   164

}

   165

   166

/**

   167

 * Sets the disallowed directions

   168

 * @param t   the tile to set the directions for

   169

 * @param drd the disallowed directions

   170

 */

   171

static inline void SetDisallowedRoadDirections(TileIndex t, DisallowedRoadDirections drd)

   172

{

   173

	assert(GetRoadTileType(t) == ROAD_TILE_NORMAL);

   174

	assert(drd < DRD_END);

   175

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

   176

}

   177

   178

static inline Axis GetCrossingRoadAxis(TileIndex t)

   179

{

   180

	assert(GetRoadTileType(t) == ROAD_TILE_CROSSING);

   181

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

   182

}

   183

   184

static inline RoadBits GetCrossingRoadBits(TileIndex tile)

   185

{

   186

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

   187

}

   188

   189

static inline TrackBits GetCrossingRailBits(TileIndex tile)

   190

{

   191

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

   192

}

   193

   194

static inline bool IsCrossingBarred(TileIndex t)

   195

{

   196

	assert(GetRoadTileType(t) == ROAD_TILE_CROSSING);

   197

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

   198

}

   199

   200

static inline void SetCrossingBarred(TileIndex t, bool barred)

   201

{

   202

	assert(GetRoadTileType(t) == ROAD_TILE_CROSSING);

   203

	SB(_m[t].m4, 5, 1, barred);

   204

}

   205

   206

static inline void UnbarCrossing(TileIndex t)

   207

{

   208

	SetCrossingBarred(t, false);

   209

}

   210

   211

static inline void BarCrossing(TileIndex t)

   212

{

   213

	SetCrossingBarred(t, true);

   214

}

   215

   216

#define IsOnDesert IsOnSnow

   217

static inline bool IsOnSnow(TileIndex t)

   218

{

   219

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

   220

}

   221

   222

#define ToggleDesert ToggleSnow

   223

static inline void ToggleSnow(TileIndex t)

   224

{

   225

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

   226

}

   227

   228

   229

enum Roadside {

   230

	ROADSIDE_BARREN           = 0,

   231

	ROADSIDE_GRASS            = 1,

   232

	ROADSIDE_PAVED            = 2,

   233

	ROADSIDE_STREET_LIGHTS    = 3,

   234

	ROADSIDE_TREES            = 5,

   235

	ROADSIDE_GRASS_ROAD_WORKS = 6,

   236

	ROADSIDE_PAVED_ROAD_WORKS = 7

   237

};

   238

   239

static inline Roadside GetRoadside(TileIndex tile)

   240

{

   241

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

   242

}

   243

   244

static inline void SetRoadside(TileIndex tile, Roadside s)

   245

{

   246

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

   247

}

   248

   249

static inline bool HasRoadWorks(TileIndex t)

   250

{

   251

	return GetRoadside(t) >= ROADSIDE_GRASS_ROAD_WORKS;

   252

}

   253

   254

static inline bool IncreaseRoadWorksCounter(TileIndex t)

   255

{

   256

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

   257

   258

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

   259

}

   260

   261

static inline void StartRoadWorks(TileIndex t)

   262

{

   263

	assert(!HasRoadWorks(t));

   264

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

   265

	switch (GetRoadside(t)) {

   266

		case ROADSIDE_BARREN:

   267

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

   268

		default:              SetRoadside(t, ROADSIDE_PAVED_ROAD_WORKS); break;

   269

	}

   270

}

   271

   272

static inline void TerminateRoadWorks(TileIndex t)

   273

{

   274

	assert(HasRoadWorks(t));

   275

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

   276

	/* Stop the counter */

   277

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

   278

}

   279

   280

   281

static inline DiagDirection GetRoadDepotDirection(TileIndex t)

   282

{

   283

	assert(GetRoadTileType(t) == ROAD_TILE_DEPOT);

   284

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

   285

}

   286

   287

   288

/**

   289

 * Returns the RoadBits on an arbitrary tile

   290

 * Special behaviour:

   291

 * - road depots: entrance is treated as road piece

   292

 * - road tunnels: entrance is treated as road piece

   293

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

   294

 * - bridge middle parts: bridge itself is ignored

   295

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

   296

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

   297

 * @return the road bits of the given tile

   298

 */

   299

RoadBits GetAnyRoadBits(TileIndex tile, RoadType rt);

   300

   301

/**

   302

 * Get the accessible track bits for the given tile.

   303

 * Special behaviour:

   304

 *  - road depots: no track bits

   305

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

   306

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

   307

 * @return the track bits for the given tile

   308

 */

   309

TrackBits GetAnyRoadTrackBits(TileIndex tile, RoadType rt);

   310

   311

/**

   312

 * Return if the tile is a valid tile for a crossing.

   313

 *

   314

 * @note function is overloaded

   315

 * @param tile the curent tile

   316

 * @param ax the axis of the road over the rail

   317

 * @return true if it is a valid tile

   318

 */

   319

bool IsPossibleCrossing(const TileIndex tile, Axis ax);

   320

   321

   322

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

   323

{

   324

	SetTileType(t, MP_ROAD);

   325

	SetTileOwner(t, road);

   326

	_m[t].m2 = town;

   327

	_m[t].m3 = 0;

   328

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

   329

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

   330

	SetRoadOwner(t, ROADTYPE_TRAM, tram);

   331

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

   332

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

   333

}

   334

   335

   336

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

   337

{

   338

	SetTileType(t, MP_ROAD);

   339

	SetTileOwner(t, rail);

   340

	_m[t].m2 = town;

   341

	_m[t].m3 = rat;

   342

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

   343

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

   344

	SetRoadOwner(t, ROADTYPE_TRAM, tram);

   345

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

   346

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

   347

}

   348

   349

   350

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

   351

{

   352

	SetTileType(t, MP_ROAD);

   353

	SetTileOwner(t, owner);

   354

	_m[t].m2 = 0;

   355

	_m[t].m3 = 0;

   356

	_m[t].m4 = 0;

   357

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

   358

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

   359

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

   360

}

   361

   362

#endif /* ROAD_MAP_H */