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

/** Which directions are disallowed ? */

   197

enum DisallowedRoadDirections {

   198

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

   199

	DRD_SOUTHBOUND, ///< All southbound traffic is disallowed

   200

	DRD_NORTHBOUND, ///< All northbound traffic is disallowed

   201

	DRD_BOTH,       ///< All directions are disallowed

   202

	DRD_END

   203

};

   204

DECLARE_ENUM_AS_BIT_SET(DisallowedRoadDirections);

   205

   206

/**

   207

 * Gets the disallowed directions

   208

 * @param t the tile to get the directions from

   209

 * @return the disallowed directions

   210

 */

   211

static inline DisallowedRoadDirections GetDisallowedRoadDirections(TileIndex t)

   212

{

   213

	assert(IsNormalRoad(t));

   214

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

   215

}

   216

   217

/**

   218

 * Sets the disallowed directions

   219

 * @param t   the tile to set the directions for

   220

 * @param drd the disallowed directions

   221

 */

   222

static inline void SetDisallowedRoadDirections(TileIndex t, DisallowedRoadDirections drd)

   223

{

   224

	assert(IsNormalRoad(t));

   225

	assert(drd < DRD_END);

   226

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

   227

}

   228

   229

static inline Axis GetCrossingRoadAxis(TileIndex t)

   230

{

   231

	assert(IsLevelCrossing(t));

   232

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

   233

}

   234

   235

static inline Axis GetCrossingRailAxis(TileIndex t)

   236

{

   237

	assert(IsLevelCrossing(t));

   238

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

   239

}

   240

   241

static inline RoadBits GetCrossingRoadBits(TileIndex tile)

   242

{

   243

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

   244

}

   245

   246

static inline Track GetCrossingRailTrack(TileIndex tile)

   247

{

   248

	return AxisToTrack(GetCrossingRailAxis(tile));

   249

}

   250

   251

static inline TrackBits GetCrossingRailBits(TileIndex tile)

   252

{

   253

	return AxisToTrackBits(GetCrossingRailAxis(tile));

   254

}

   255

   256

static inline bool IsCrossingBarred(TileIndex t)

   257

{

   258

	assert(IsLevelCrossing(t));

   259

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

   260

}

   261

   262

static inline void SetCrossingBarred(TileIndex t, bool barred)

   263

{

   264

	assert(IsLevelCrossing(t));

   265

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

   266

}

   267

   268

static inline void UnbarCrossing(TileIndex t)

   269

{

   270

	SetCrossingBarred(t, false);

   271

}

   272

   273

static inline void BarCrossing(TileIndex t)

   274

{

   275

	SetCrossingBarred(t, true);

   276

}

   277

   278

#define IsOnDesert IsOnSnow

   279

static inline bool IsOnSnow(TileIndex t)

   280

{

   281

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

   282

}

   283

   284

#define ToggleDesert ToggleSnow

   285

static inline void ToggleSnow(TileIndex t)

   286

{

   287

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

   288

}

   289

   290

   291

enum Roadside {

   292

	ROADSIDE_BARREN           = 0,

   293

	ROADSIDE_GRASS            = 1,

   294

	ROADSIDE_PAVED            = 2,

   295

	ROADSIDE_STREET_LIGHTS    = 3,

   296

	ROADSIDE_TREES            = 5,

   297

	ROADSIDE_GRASS_ROAD_WORKS = 6,

   298

	ROADSIDE_PAVED_ROAD_WORKS = 7

   299

};

   300

   301

static inline Roadside GetRoadside(TileIndex tile)

   302

{

   303

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

   304

}

   305

   306

static inline void SetRoadside(TileIndex tile, Roadside s)

   307

{

   308

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

   309

}

   310

   311

static inline bool HasRoadWorks(TileIndex t)

   312

{

   313

	return GetRoadside(t) >= ROADSIDE_GRASS_ROAD_WORKS;

   314

}

   315

   316

static inline bool IncreaseRoadWorksCounter(TileIndex t)

   317

{

   318

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

   319

   320

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

   321

}

   322

   323

static inline void StartRoadWorks(TileIndex t)

   324

{

   325

	assert(!HasRoadWorks(t));

   326

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

   327

	switch (GetRoadside(t)) {

   328

		case ROADSIDE_BARREN:

   329

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

   330

		default:              SetRoadside(t, ROADSIDE_PAVED_ROAD_WORKS); break;

   331

	}

   332

}

   333

   334

static inline void TerminateRoadWorks(TileIndex t)

   335

{

   336

	assert(HasRoadWorks(t));

   337

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

   338

	/* Stop the counter */

   339

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

   340

}

   341

   342

   343

static inline DiagDirection GetRoadDepotDirection(TileIndex t)

   344

{

   345

	assert(IsRoadDepot(t));

   346

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

   347

}

   348

   349

   350

/**

   351

 * Returns the RoadBits on an arbitrary tile

   352

 * Special behaviour:

   353

 * - road depots: entrance is treated as road piece

   354

 * - road tunnels: entrance is treated as road piece

   355

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

   356

 * - bridge middle parts: bridge itself is ignored

   357

 *

   358

 * If straight_tunnel_bridge_entrance is set a ROAD_X or ROAD_Y

   359

 * for bridge ramps and tunnel entrances is returned depending

   360

 * on the orientation of the tunnel or bridge.

   361

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

   362

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

   363

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

   364

 * @return the road bits of the given tile

   365

 */

   366

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

   367

   368

/**

   369

 * Get the accessible track bits for the given tile.

   370

 * Special behaviour:

   371

 *  - road depots: no track bits

   372

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

   373

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

   374

 * @return the track bits for the given tile

   375

 */

   376

TrackBits GetAnyRoadTrackBits(TileIndex tile, RoadType rt);

   377

   378

/**

   379

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

   380

 *

   381

 * @note function is overloaded

   382

 * @param tile the curent tile

   383

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

   384

 * @return true if it is a valid tile

   385

 */

   386

bool IsPossibleCrossing(const TileIndex tile, Axis ax);

   387

   388

   389

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

   390

{

   391

	SetTileType(t, MP_ROAD);

   392

	SetTileOwner(t, road);

   393

	_m[t].m2 = town;

   394

	_m[t].m3 = 0;

   395

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

   396

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

   397

	SetRoadOwner(t, ROADTYPE_TRAM, tram);

   398

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

   399

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

   400

}

   401

   402

   403

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

   404

{

   405

	SetTileType(t, MP_ROAD);

   406

	SetTileOwner(t, rail);

   407

	_m[t].m2 = town;

   408

	_m[t].m3 = rat;

   409

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

   410

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

   411

	SetRoadOwner(t, ROADTYPE_TRAM, tram);

   412

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

   413

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

   414

}

   415

   416

   417

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

   418

{

   419

	SetTileType(t, MP_ROAD);

   420

	SetTileOwner(t, owner);

   421

	_m[t].m2 = 0;

   422

	_m[t].m3 = 0;

   423

	_m[t].m4 = 0;

   424

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

   425

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

   426

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

   427

}

   428

   429

#endif /* ROAD_MAP_H */