1

/* $Id$ */

     2

     3

/** @file road_map.h Map accessors for roads. */

     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 IsNormalRoad(TileIndex t)

    28

{

    29

	return GetRoadTileType(t) == ROAD_TILE_NORMAL;

    30

}

    31

    32

static inline bool IsNormalRoadTile(TileIndex t)

    33

{

    34

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

    35

}

    36

    37

static inline bool IsLevelCrossing(TileIndex t)

    38

{

    39

	return GetRoadTileType(t) == ROAD_TILE_CROSSING;

    40

}

    41

    42

static inline bool IsLevelCrossingTile(TileIndex t)

    43

{

    44

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

    45

}

    46

    47

static inline bool IsRoadDepot(TileIndex t)

    48

{

    49

	return GetRoadTileType(t) == ROAD_TILE_DEPOT;

    50

}

    51

    52

static inline bool IsRoadDepotTile(TileIndex t)

    53

{

    54

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

    55

}

    56

    57

static inline RoadBits GetRoadBits(TileIndex t, RoadType rt)

    58

{

    59

	assert(IsNormalRoad(t));

    60

	switch (rt) {

    61

		default: NOT_REACHED();

    62

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

    63

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

    64

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

    65

	}

    66

}

    67

    68

/**

    69

 * Get all RoadBits set on a tile except from the given RoadType

    70

 *

    71

 * @param t The tile from which we want to get the RoadBits

    72

 * @param rt The RoadType which we exclude from the querry

    73

 * @return all set RoadBits of the tile which are not from the given RoadType

    74

 */

    75

static inline RoadBits GetOtherRoadBits(TileIndex t, RoadType rt)

    76

{

    77

	return ((rt == ROADTYPE_ROAD) ? ROAD_NONE : GetRoadBits(t, ROADTYPE_ROAD)) |

    78

		((rt == ROADTYPE_TRAM) ? ROAD_NONE : GetRoadBits(t, ROADTYPE_TRAM)) |

    79

		((rt == ROADTYPE_HWAY) ? ROAD_NONE : GetRoadBits(t, ROADTYPE_HWAY));

    80

}

    81

    82

/**

    83

 * Get all set RoadBits on the given tile

    84

 *

    85

 * @param tile The tile from which we want to get the RoadBits

    86

 * @return all set RoadBits of the tile

    87

 */

    88

static inline RoadBits GetAllRoadBits(TileIndex tile)

    89

{

    90

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

    91

}

    92

    93

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

    94

{

    95

	assert(IsNormalRoad(t)); // XXX incomplete

    96

	switch (rt) {

    97

		default: NOT_REACHED();

    98

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

    99

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

   100

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

   101

	}

   102

}

   103

   104

static inline RoadTypes GetRoadTypes(TileIndex t)

   105

{

   106

	if (IsTileType(t, MP_ROAD)) {

   107

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

   108

	} else {

   109

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

   110

	}

   111

}

   112

   113

static inline void SetRoadTypes(TileIndex t, RoadTypes rt)

   114

{

   115

	if (IsTileType(t, MP_ROAD)) {

   116

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

   117

	} else {

   118

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

   119

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

   120

	}

   121

}

   122

   123

static inline bool HasTileRoadType(TileIndex t, RoadType rt)

   124

{

   125

	return HasBit(GetRoadTypes(t), rt);

   126

}

   127

   128

static inline Owner GetRoadOwner(TileIndex t, RoadType rt)

   129

{

   130

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

   131

   132

	switch (GetRoadTileType(t)) {

   133

		default: NOT_REACHED();

   134

		case ROAD_TILE_NORMAL:

   135

			switch (rt) {

   136

				default: NOT_REACHED();

   137

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

   138

				case ROADTYPE_TRAM: {

   139

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

   140

					 * to OWNER_TOWN makes it use one bit less */

   141

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

   142

					return o == OWNER_TOWN ? OWNER_NONE : o;

   143

				}

   144

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

   145

			}

   146

		case ROAD_TILE_CROSSING:

   147

			switch (rt) {

   148

				default: NOT_REACHED();

   149

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

   150

				case ROADTYPE_TRAM: {

   151

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

   152

					 * to OWNER_TOWN makes it use one bit less */

   153

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

   154

					return o == OWNER_TOWN ? OWNER_NONE : o;

   155

				}

   156

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

   157

			}

   158

		case ROAD_TILE_DEPOT: return GetTileOwner(t);

   159

	}

   160

}

   161

   162

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

   163

{

   164

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

   165

   166

	switch (GetRoadTileType(t)) {

   167

		default: NOT_REACHED();

   168

		case ROAD_TILE_NORMAL:

   169

			switch (rt) {

   170

				default: NOT_REACHED();

   171

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

   172

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

   173

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

   174

			}

   175

			break;

   176

		case ROAD_TILE_CROSSING:

   177

			switch (rt) {

   178

				default: NOT_REACHED();

   179

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

   180

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

   181

				 * to OWNER_TOWN makes it use one bit less */

   182

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

   183

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

   184

			}

   185

			break;

   186

		case ROAD_TILE_DEPOT: return SetTileOwner(t, o);

   187

	}

   188

}

   189

   190

static inline bool IsRoadOwner(TileIndex t, RoadType rt, Owner o)

   191

{

   192

	assert(HasTileRoadType(t, rt));

   193

	return (GetRoadOwner(t, rt) == o);

   194

}

   195

   196

/** Checks if given tile has town owned road

   197

 * @param t tile to check

   198

 * @return true iff tile has road and the road is owned by a town

   199

 * @pre IsTileType(t, MP_ROAD)

   200

 */

   201

static inline bool HasTownOwnedRoad(TileIndex t)

   202

{

   203

	assert(IsTileType(t, MP_ROAD));

   204

	return HasTileRoadType(t, ROADTYPE_ROAD) && IsRoadOwner(t, ROADTYPE_ROAD, OWNER_TOWN);

   205

}

   206

   207

/** Which directions are disallowed ? */

   208

enum DisallowedRoadDirections {

   209

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

   210

	DRD_SOUTHBOUND, ///< All southbound traffic is disallowed

   211

	DRD_NORTHBOUND, ///< All northbound traffic is disallowed

   212

	DRD_BOTH,       ///< All directions are disallowed

   213

	DRD_END

   214

};

   215

DECLARE_ENUM_AS_BIT_SET(DisallowedRoadDirections);

   216

   217

/**

   218

 * Gets the disallowed directions

   219

 * @param t the tile to get the directions from

   220

 * @return the disallowed directions

   221

 */

   222

static inline DisallowedRoadDirections GetDisallowedRoadDirections(TileIndex t)

   223

{

   224

	assert(IsNormalRoad(t));

   225

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

   226

}

   227

   228

/**

   229

 * Sets the disallowed directions

   230

 * @param t   the tile to set the directions for

   231

 * @param drd the disallowed directions

   232

 */

   233

static inline void SetDisallowedRoadDirections(TileIndex t, DisallowedRoadDirections drd)

   234

{

   235

	assert(IsNormalRoad(t));

   236

	assert(drd < DRD_END);

   237

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

   238

}

   239

   240

static inline Axis GetCrossingRoadAxis(TileIndex t)

   241

{

   242

	assert(IsLevelCrossing(t));

   243

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

   244

}

   245

   246

static inline Axis GetCrossingRailAxis(TileIndex t)

   247

{

   248

	assert(IsLevelCrossing(t));

   249

	return OtherAxis((Axis)GetCrossingRoadAxis(t));

   250

}

   251

   252

static inline RoadBits GetCrossingRoadBits(TileIndex tile)

   253

{

   254

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

   255

}

   256

   257

static inline Track GetCrossingRailTrack(TileIndex tile)

   258

{

   259

	return AxisToTrack(GetCrossingRailAxis(tile));

   260

}

   261

   262

static inline TrackBits GetCrossingRailBits(TileIndex tile)

   263

{

   264

	return AxisToTrackBits(GetCrossingRailAxis(tile));

   265

}

   266

   267

   268

/**

   269

 * Get the reservation state of the rail crossing

   270

 * @pre IsLevelCrossingTile(t)

   271

 * @param t the crossing tile

   272

 * @return reservation state

   273

 */

   274

static inline bool GetCrossingReservation(TileIndex t)

   275

{

   276

	assert(IsLevelCrossingTile(t));

   277

	return HasBit(_m[t].m5, 4);

   278

}

   279

   280

/**

   281

 * Set the reservation state of the rail crossing

   282

 * @note Works for both waypoints and rail depots

   283

 * @pre IsLevelCrossingTile(t)

   284

 * @param t the crossing tile

   285

 * @param b the reservation state

   286

 */

   287

static inline void SetCrossingReservation(TileIndex t, bool b)

   288

{

   289

	assert(IsLevelCrossingTile(t));

   290

	SB(_m[t].m5, 4, 1, b ? 1 : 0);

   291

}

   292

   293

/**

   294

 * Get the reserved track bits for a rail crossing

   295

 * @pre IsLevelCrossingTile(t)

   296

 * @param t the tile

   297

 * @return reserved track bits

   298

 */

   299

static inline TrackBits GetRailCrossingReservation(TileIndex t)

   300

{

   301

	return GetCrossingReservation(t) ? GetCrossingRailBits(t) : TRACK_BIT_NONE;

   302

}

   303

   304

static inline bool IsCrossingBarred(TileIndex t)

   305

{

   306

	assert(IsLevelCrossing(t));

   307

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

   308

}

   309

   310

static inline void SetCrossingBarred(TileIndex t, bool barred)

   311

{

   312

	assert(IsLevelCrossing(t));

   313

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

   314

}

   315

   316

static inline void UnbarCrossing(TileIndex t)

   317

{

   318

	SetCrossingBarred(t, false);

   319

}

   320

   321

static inline void BarCrossing(TileIndex t)

   322

{

   323

	SetCrossingBarred(t, true);

   324

}

   325

   326

#define IsOnDesert IsOnSnow

   327

static inline bool IsOnSnow(TileIndex t)

   328

{

   329

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

   330

}

   331

   332

#define ToggleDesert ToggleSnow

   333

static inline void ToggleSnow(TileIndex t)

   334

{

   335

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

   336

}

   337

   338

   339

enum Roadside {

   340

	ROADSIDE_BARREN           = 0,

   341

	ROADSIDE_GRASS            = 1,

   342

	ROADSIDE_PAVED            = 2,

   343

	ROADSIDE_STREET_LIGHTS    = 3,

   344

	ROADSIDE_TREES            = 5,

   345

	ROADSIDE_GRASS_ROAD_WORKS = 6,

   346

	ROADSIDE_PAVED_ROAD_WORKS = 7

   347

};

   348

   349

static inline Roadside GetRoadside(TileIndex tile)

   350

{

   351

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

   352

}

   353

   354

static inline void SetRoadside(TileIndex tile, Roadside s)

   355

{

   356

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

   357

}

   358

   359

static inline bool HasRoadWorks(TileIndex t)

   360

{

   361

	return GetRoadside(t) >= ROADSIDE_GRASS_ROAD_WORKS;

   362

}

   363

   364

static inline bool IncreaseRoadWorksCounter(TileIndex t)

   365

{

   366

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

   367

   368

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

   369

}

   370

   371

static inline void StartRoadWorks(TileIndex t)

   372

{

   373

	assert(!HasRoadWorks(t));

   374

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

   375

	switch (GetRoadside(t)) {

   376

		case ROADSIDE_BARREN:

   377

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

   378

		default:              SetRoadside(t, ROADSIDE_PAVED_ROAD_WORKS); break;

   379

	}

   380

}

   381

   382

static inline void TerminateRoadWorks(TileIndex t)

   383

{

   384

	assert(HasRoadWorks(t));

   385

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

   386

	/* Stop the counter */

   387

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

   388

}

   389

   390

   391

static inline DiagDirection GetRoadDepotDirection(TileIndex t)

   392

{

   393

	assert(IsRoadDepot(t));

   394

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

   395

}

   396

   397

   398

/**

   399

 * Returns the RoadBits on an arbitrary tile

   400

 * Special behaviour:

   401

 * - road depots: entrance is treated as road piece

   402

 * - road tunnels: entrance is treated as road piece

   403

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

   404

 * - bridge middle parts: bridge itself is ignored

   405

 *

   406

 * If straight_tunnel_bridge_entrance is set a ROAD_X or ROAD_Y

   407

 * for bridge ramps and tunnel entrances is returned depending

   408

 * on the orientation of the tunnel or bridge.

   409

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

   410

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

   411

 * @param stbe whether to return straight road bits for tunnels/bridges.

   412

 * @return the road bits of the given tile

   413

 */

   414

RoadBits GetAnyRoadBits(TileIndex tile, RoadType rt, bool straight_tunnel_bridge_entrance = false);

   415

   416

/**

   417

 * Get the accessible track bits for the given tile.

   418

 * Special behaviour:

   419

 *  - road depots: no track bits

   420

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

   421

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

   422

 * @return the track bits for the given tile

   423

 */

   424

TrackBits GetAnyRoadTrackBits(TileIndex tile, RoadType rt);

   425

   426

/**

   427

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

   428

 *

   429

 * @note function is overloaded

   430

 * @param tile the curent tile

   431

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

   432

 * @return true if it is a valid tile

   433

 */

   434

bool IsPossibleCrossing(const TileIndex tile, Axis ax);

   435

   436

   437

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

   438

{

   439

	SetTileType(t, MP_ROAD);

   440

	SetTileOwner(t, road);

   441

	_m[t].m2 = town;

   442

	_m[t].m3 = 0;

   443

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

   444

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

   445

	SetRoadOwner(t, ROADTYPE_TRAM, tram);

   446

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

   447

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

   448

}

   449

   450

   451

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

   452

{

   453

	SetTileType(t, MP_ROAD);

   454

	SetTileOwner(t, rail);

   455

	_m[t].m2 = town;

   456

	_m[t].m3 = rat;

   457

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

   458

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

   459

	SetRoadOwner(t, ROADTYPE_TRAM, tram);

   460

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

   461

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

   462

}

   463

   464

   465

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

   466

{

   467

	SetTileType(t, MP_ROAD);

   468

	SetTileOwner(t, owner);

   469

	_m[t].m2 = town;

   470

	_m[t].m3 = 0;

   471

	_m[t].m4 = 0;

   472

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

   473

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

   474

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

   475

}

   476

   477

#endif /* ROAD_MAP_H */