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 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

static inline RoadBits GetAllRoadBits(TileIndex tile)

    69

{

    70

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

    71

}

    72

    73

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

    74

{

    75

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

    76

	switch (rt) {

    77

		default: NOT_REACHED();

    78

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

    79

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

    80

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

    81

	}

    82

}

    83

    84

static inline RoadTypes GetRoadTypes(TileIndex t)

    85

{

    86

	if (IsTileType(t, MP_ROAD)) {

    87

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

    88

	} else {

    89

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

    90

	}

    91

}

    92

    93

static inline void SetRoadTypes(TileIndex t, RoadTypes rt)

    94

{

    95

	if (IsTileType(t, MP_ROAD)) {

    96

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

    97

	} else {

    98

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

    99

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

   100

	}

   101

}

   102

   103

static inline bool HasTileRoadType(TileIndex t, RoadType rt)

   104

{

   105

	return HasBit(GetRoadTypes(t), rt);

   106

}

   107

   108

static inline Owner GetRoadOwner(TileIndex t, RoadType rt)

   109

{

   110

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

   111

   112

	switch (GetRoadTileType(t)) {

   113

		default: NOT_REACHED();

   114

		case ROAD_TILE_NORMAL:

   115

			switch (rt) {

   116

				default: NOT_REACHED();

   117

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

   118

				case ROADTYPE_TRAM: {

   119

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

   120

					 * to OWNER_TOWN makes it use one bit less */

   121

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

   122

					return o == OWNER_TOWN ? OWNER_NONE : o;

   123

				}

   124

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

   125

			}

   126

		case ROAD_TILE_CROSSING:

   127

			switch (rt) {

   128

				default: NOT_REACHED();

   129

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

   130

				case ROADTYPE_TRAM: {

   131

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

   132

					 * to OWNER_TOWN makes it use one bit less */

   133

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

   134

					return o == OWNER_TOWN ? OWNER_NONE : o;

   135

				}

   136

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

   137

			}

   138

		case ROAD_TILE_DEPOT: return GetTileOwner(t);

   139

	}

   140

}

   141

   142

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

   143

{

   144

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

   145

   146

	switch (GetRoadTileType(t)) {

   147

		default: NOT_REACHED();

   148

		case ROAD_TILE_NORMAL:

   149

			switch (rt) {

   150

				default: NOT_REACHED();

   151

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

   152

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

   153

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

   154

			}

   155

			break;

   156

		case ROAD_TILE_CROSSING:

   157

			switch (rt) {

   158

				default: NOT_REACHED();

   159

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

   160

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

   161

				 * to OWNER_TOWN makes it use one bit less */

   162

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

   163

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

   164

			}

   165

			break;

   166

		case ROAD_TILE_DEPOT: return SetTileOwner(t, o);

   167

	}

   168

}

   169

   170

/** Which directions are disallowed ? */

   171

enum DisallowedRoadDirections {

   172

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

   173

	DRD_SOUTHBOUND, ///< All southbound traffic is disallowed

   174

	DRD_NORTHBOUND, ///< All northbound traffic is disallowed

   175

	DRD_BOTH,       ///< All directions are disallowed

   176

	DRD_END

   177

};

   178

DECLARE_ENUM_AS_BIT_SET(DisallowedRoadDirections);

   179

   180

/**

   181

 * Gets the disallowed directions

   182

 * @param t the tile to get the directions from

   183

 * @return the disallowed directions

   184

 */

   185

static inline DisallowedRoadDirections GetDisallowedRoadDirections(TileIndex t)

   186

{

   187

	assert(IsNormalRoad(t));

   188

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

   189

}

   190

   191

/**

   192

 * Sets the disallowed directions

   193

 * @param t   the tile to set the directions for

   194

 * @param drd the disallowed directions

   195

 */

   196

static inline void SetDisallowedRoadDirections(TileIndex t, DisallowedRoadDirections drd)

   197

{

   198

	assert(IsNormalRoad(t));

   199

	assert(drd < DRD_END);

   200

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

   201

}

   202

   203

static inline Axis GetCrossingRoadAxis(TileIndex t)

   204

{

   205

	assert(IsLevelCrossing(t));

   206

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

   207

}

   208

   209

static inline Axis GetCrossingRailAxis(TileIndex t)

   210

{

   211

	assert(IsLevelCrossing(t));

   212

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

   213

}

   214

   215

static inline RoadBits GetCrossingRoadBits(TileIndex tile)

   216

{

   217

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

   218

}

   219

   220

static inline Track GetCrossingRailTrack(TileIndex tile)

   221

{

   222

	return AxisToTrack(GetCrossingRailAxis(tile));

   223

}

   224

   225

static inline TrackBits GetCrossingRailBits(TileIndex tile)

   226

{

   227

	return AxisToTrackBits(GetCrossingRailAxis(tile));

   228

}

   229

   230

static inline bool IsCrossingBarred(TileIndex t)

   231

{

   232

	assert(IsLevelCrossing(t));

   233

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

   234

}

   235

   236

static inline void SetCrossingBarred(TileIndex t, bool barred)

   237

{

   238

	assert(IsLevelCrossing(t));

   239

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

   240

}

   241

   242

static inline void UnbarCrossing(TileIndex t)

   243

{

   244

	SetCrossingBarred(t, false);

   245

}

   246

   247

static inline void BarCrossing(TileIndex t)

   248

{

   249

	SetCrossingBarred(t, true);

   250

}

   251

   252

#define IsOnDesert IsOnSnow

   253

static inline bool IsOnSnow(TileIndex t)

   254

{

   255

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

   256

}

   257

   258

#define ToggleDesert ToggleSnow

   259

static inline void ToggleSnow(TileIndex t)

   260

{

   261

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

   262

}

   263

   264

   265

enum Roadside {

   266

	ROADSIDE_BARREN           = 0,

   267

	ROADSIDE_GRASS            = 1,

   268

	ROADSIDE_PAVED            = 2,

   269

	ROADSIDE_STREET_LIGHTS    = 3,

   270

	ROADSIDE_TREES            = 5,

   271

	ROADSIDE_GRASS_ROAD_WORKS = 6,

   272

	ROADSIDE_PAVED_ROAD_WORKS = 7

   273

};

   274

   275

static inline Roadside GetRoadside(TileIndex tile)

   276

{

   277

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

   278

}

   279

   280

static inline void SetRoadside(TileIndex tile, Roadside s)

   281

{

   282

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

   283

}

   284

   285

static inline bool HasRoadWorks(TileIndex t)

   286

{

   287

	return GetRoadside(t) >= ROADSIDE_GRASS_ROAD_WORKS;

   288

}

   289

   290

static inline bool IncreaseRoadWorksCounter(TileIndex t)

   291

{

   292

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

   293

   294

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

   295

}

   296

   297

static inline void StartRoadWorks(TileIndex t)

   298

{

   299

	assert(!HasRoadWorks(t));

   300

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

   301

	switch (GetRoadside(t)) {

   302

		case ROADSIDE_BARREN:

   303

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

   304

		default:              SetRoadside(t, ROADSIDE_PAVED_ROAD_WORKS); break;

   305

	}

   306

}

   307

   308

static inline void TerminateRoadWorks(TileIndex t)

   309

{

   310

	assert(HasRoadWorks(t));

   311

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

   312

	/* Stop the counter */

   313

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

   314

}

   315

   316

   317

static inline DiagDirection GetRoadDepotDirection(TileIndex t)

   318

{

   319

	assert(IsRoadDepot(t));

   320

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

   321

}

   322

   323

   324

/**

   325

 * Returns the RoadBits on an arbitrary tile

   326

 * Special behaviour:

   327

 * - road depots: entrance is treated as road piece

   328

 * - road tunnels: entrance is treated as road piece

   329

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

   330

 * - bridge middle parts: bridge itself is ignored

   331

 *

   332

 * If straight_tunnel_bridge_entrance is set a ROAD_X or ROAD_Y

   333

 * for bridge ramps and tunnel entrances is returned depending

   334

 * on the orientation of the tunnel or bridge.

   335

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

   336

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

   337

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

   338

 * @return the road bits of the given tile

   339

 */

   340

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

   341

   342

/**

   343

 * Get the accessible track bits for the given tile.

   344

 * Special behaviour:

   345

 *  - road depots: no track bits

   346

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

   347

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

   348

 * @return the track bits for the given tile

   349

 */

   350

TrackBits GetAnyRoadTrackBits(TileIndex tile, RoadType rt);

   351

   352

/**

   353

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

   354

 *

   355

 * @note function is overloaded

   356

 * @param tile the curent tile

   357

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

   358

 * @return true if it is a valid tile

   359

 */

   360

bool IsPossibleCrossing(const TileIndex tile, Axis ax);

   361

   362

   363

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

   364

{

   365

	SetTileType(t, MP_ROAD);

   366

	SetTileOwner(t, road);

   367

	_m[t].m2 = town;

   368

	_m[t].m3 = 0;

   369

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

   370

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

   371

	SetRoadOwner(t, ROADTYPE_TRAM, tram);

   372

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

   373

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

   374

}

   375

   376

   377

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

   378

{

   379

	SetTileType(t, MP_ROAD);

   380

	SetTileOwner(t, rail);

   381

	_m[t].m2 = town;

   382

	_m[t].m3 = rat;

   383

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

   384

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

   385

	SetRoadOwner(t, ROADTYPE_TRAM, tram);

   386

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

   387

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

   388

}

   389

   390

   391

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

   392

{

   393

	SetTileType(t, MP_ROAD);

   394

	SetTileOwner(t, owner);

   395

	_m[t].m2 = 0;

   396

	_m[t].m3 = 0;

   397

	_m[t].m4 = 0;

   398

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

   399

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

   400

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

   401

}

   402

   403

#endif /* ROAD_MAP_H */