1

/* $Id$ */

     2

     3

/** @file rail_cmd.cpp Handling of rail tiles. */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "bridge_map.h"

     8

#include "bridge.h"

     9

#include "cmd_helper.h"

    10

#include "debug.h"

    11

#include "tile_cmd.h"

    12

#include "rail_map.h"

    13

#include "road_map.h"

    14

#include "landscape.h"

    15

#include "town_map.h"

    16

#include "tunnel_map.h"

    17

#include "viewport_func.h"

    18

#include "command_func.h"

    19

#include "pathfind.h"

    20

#include "engine_func.h"

    21

#include "engine_base.h"

    22

#include "town.h"

    23

#include "sprite.h"

    24

#include "depot_base.h"

    25

#include "depot_func.h"

    26

#include "waypoint.h"

    27

#include "rail.h"

    28

#include "newgrf.h"

    29

#include "yapf/yapf.h"

    30

#include "newgrf_engine.h"

    31

#include "newgrf_callbacks.h"

    32

#include "newgrf_station.h"

    33

#include "newgrf_commons.h"

    34

#include "train.h"

    35

#include "variables.h"

    36

#include "autoslope.h"

    37

#include "transparency.h"

    38

#include "water.h"

    39

#include "tunnelbridge_map.h"

    40

#include "window_func.h"

    41

#include "vehicle_func.h"

    42

#include "sound_func.h"

    43

#include "signal_func.h"

    44

#include "tunnelbridge.h"

    45

#include "station_map.h"

    46

#include "water_map.h"

    47

#include "functions.h"

    48

#include "elrail_func.h"

    49

#include "oldpool_func.h"

    50

#include "pbs.h"

    51

#include "core/smallvec_type.hpp"

    52

    53

#include "table/sprites.h"

    54

#include "table/strings.h"

    55

#include "table/railtypes.h"

    56

#include "table/track_land.h"

    57

    58

RailtypeInfo _railtypes[RAILTYPE_END];

    59

    60

assert_compile(sizeof(_original_railtypes) <= sizeof(_railtypes));

    61

    62

/**

    63

 * Initialize rail type information.

    64

 */

    65

void ResetRailTypes()

    66

{

    67

	memset(_railtypes, 0, sizeof(_railtypes));

    68

	memcpy(_railtypes, _original_railtypes, sizeof(_original_railtypes));

    69

}

    70

    71

const byte _track_sloped_sprites[14] = {

    72

	14, 15, 22, 13,

    73

	 0, 21, 17, 12,

    74

	23,  0, 18, 20,

    75

	19, 16

    76

};

    77

    78

    79

/*         4

    80

 *     ---------

    81

 *    |\       /|

    82

 *    | \    1/ |

    83

 *    |  \   /  |

    84

 *    |   \ /   |

    85

 *  16|    \    |32

    86

 *    |   / \2  |

    87

 *    |  /   \  |

    88

 *    | /     \ |

    89

 *    |/       \|

    90

 *     ---------

    91

 *         8

    92

 */

    93

    94

    95

    96

/* MAP2 byte:    abcd???? => Signal On? Same coding as map3lo

    97

 * MAP3LO byte:  abcd???? => Signal Exists?

    98

 *               a and b are for diagonals, upper and left,

    99

 *               one for each direction. (ie a == NE->SW, b ==

   100

 *               SW->NE, or v.v., I don't know. b and c are

   101

 *               similar for lower and right.

   102

 * MAP2 byte:    ????abcd => Type of ground.

   103

 * MAP3LO byte:  ????abcd => Type of rail.

   104

 * MAP5:         00abcdef => rail

   105

 *               01abcdef => rail w/ signals

   106

 *               10uuuuuu => unused

   107

 *               11uuuudd => rail depot

   108

 */

   109

   110

   111

Vehicle *EnsureNoTrainOnTrackProc(Vehicle *v, void *data)

   112

{

   113

	TrackBits rail_bits = *(TrackBits *)data;

   114

   115

	if (v->type != VEH_TRAIN) return NULL;

   116

   117

	if ((v->u.rail.track != rail_bits) && !TracksOverlap(v->u.rail.track | rail_bits)) return NULL;

   118

   119

	_error_message = VehicleInTheWayErrMsg(v);

   120

	return v;

   121

}

   122

   123

/**

   124

 * Tests if a vehicle interacts with the specified track.

   125

 * All track bits interact except parallel TRACK_BIT_HORZ or TRACK_BIT_VERT.

   126

 *

   127

 * @param tile The tile.

   128

 * @param track The track.

   129

 */

   130

static bool EnsureNoTrainOnTrack(TileIndex tile, Track track)

   131

{

   132

	TrackBits rail_bits = TrackToTrackBits(track);

   133

   134

	return !HasVehicleOnPos(tile, &rail_bits, &EnsureNoTrainOnTrackProc);

   135

}

   136

   137

static bool CheckTrackCombination(TileIndex tile, TrackBits to_build, uint flags)

   138

{

   139

	TrackBits current; // The current track layout

   140

	TrackBits future;  // The track layout we want to build

   141

	_error_message = STR_1001_IMPOSSIBLE_TRACK_COMBINATION;

   142

   143

	if (!IsPlainRailTile(tile)) return false;

   144

   145

	/* So, we have a tile with tracks on it (and possibly signals). Let's see

   146

	 * what tracks first */

   147

	current = GetTrackBits(tile);

   148

	future = current | to_build;

   149

   150

	/* Are we really building something new? */

   151

	if (current == future) {

   152

		/* Nothing new is being built */

   153

		_error_message = STR_1007_ALREADY_BUILT;

   154

		return false;

   155

	}

   156

   157

	/* Let's see if we may build this */

   158

	if (flags & DC_NO_RAIL_OVERLAP || HasSignals(tile)) {

   159

		/* If we are not allowed to overlap (flag is on for ai companies or we have

   160

		 * signals on the tile), check that */

   161

		return future == TRACK_BIT_HORZ || future == TRACK_BIT_VERT;

   162

	} else {

   163

		/* Normally, we may overlap and any combination is valid */

   164

		return true;

   165

	}

   166

}

   167

   168

   169

/** Valid TrackBits on a specific (non-steep)-slope without foundation */

   170

static const TrackBits _valid_tracks_without_foundation[15] = {

   171

	TRACK_BIT_ALL,

   172

	TRACK_BIT_RIGHT,

   173

	TRACK_BIT_UPPER,

   174

	TRACK_BIT_X,

   175

   176

	TRACK_BIT_LEFT,

   177

	TRACK_BIT_NONE,

   178

	TRACK_BIT_Y,

   179

	TRACK_BIT_LOWER,

   180

   181

	TRACK_BIT_LOWER,

   182

	TRACK_BIT_Y,

   183

	TRACK_BIT_NONE,

   184

	TRACK_BIT_LEFT,

   185

   186

	TRACK_BIT_X,

   187

	TRACK_BIT_UPPER,

   188

	TRACK_BIT_RIGHT,

   189

};

   190

   191

/** Valid TrackBits on a specific (non-steep)-slope with leveled foundation */

   192

static const TrackBits _valid_tracks_on_leveled_foundation[15] = {

   193

	TRACK_BIT_NONE,

   194

	TRACK_BIT_LEFT,

   195

	TRACK_BIT_LOWER,

   196

	TRACK_BIT_Y | TRACK_BIT_LOWER | TRACK_BIT_LEFT,

   197

   198

	TRACK_BIT_RIGHT,

   199

	TRACK_BIT_ALL,

   200

	TRACK_BIT_X | TRACK_BIT_LOWER | TRACK_BIT_RIGHT,

   201

	TRACK_BIT_ALL,

   202

   203

	TRACK_BIT_UPPER,

   204

	TRACK_BIT_X | TRACK_BIT_UPPER | TRACK_BIT_LEFT,

   205

	TRACK_BIT_ALL,

   206

	TRACK_BIT_ALL,

   207

   208

	TRACK_BIT_Y | TRACK_BIT_UPPER | TRACK_BIT_RIGHT,

   209

	TRACK_BIT_ALL,

   210

	TRACK_BIT_ALL

   211

};

   212

   213

/**

   214

 * Checks if a track combination is valid on a specific slope and returns the needed foundation.

   215

 *

   216

 * @param tileh Tile slope.

   217

 * @param bits  Trackbits.

   218

 * @return Needed foundation or FOUNDATION_INVALID if track/slope combination is not allowed.

   219

 */

   220

Foundation GetRailFoundation(Slope tileh, TrackBits bits)

   221

{

   222

	if (bits == TRACK_BIT_NONE) return FOUNDATION_NONE;

   223

   224

	if (IsSteepSlope(tileh)) {

   225

		/* Test for inclined foundations */

   226

		if (bits == TRACK_BIT_X) return FOUNDATION_INCLINED_X;

   227

		if (bits == TRACK_BIT_Y) return FOUNDATION_INCLINED_Y;

   228

   229

		/* Get higher track */

   230

		Corner highest_corner = GetHighestSlopeCorner(tileh);

   231

		TrackBits higher_track = CornerToTrackBits(highest_corner);

   232

   233

		/* Only higher track? */

   234

		if (bits == higher_track) return HalftileFoundation(highest_corner);

   235

   236

		/* Overlap with higher track? */

   237

		if (TracksOverlap(bits | higher_track)) return FOUNDATION_INVALID;

   238

   239

		/* either lower track or both higher and lower track */

   240

		return ((bits & higher_track) != 0 ? FOUNDATION_STEEP_BOTH : FOUNDATION_STEEP_LOWER);

   241

	} else {

   242

		if ((~_valid_tracks_without_foundation[tileh] & bits) == 0) return FOUNDATION_NONE;

   243

   244

		bool valid_on_leveled = ((~_valid_tracks_on_leveled_foundation[tileh] & bits) == 0);

   245

   246

		Corner track_corner;

   247

		switch (bits) {

   248

			case TRACK_BIT_LEFT:  track_corner = CORNER_W; break;

   249

			case TRACK_BIT_LOWER: track_corner = CORNER_S; break;

   250

			case TRACK_BIT_RIGHT: track_corner = CORNER_E; break;

   251

			case TRACK_BIT_UPPER: track_corner = CORNER_N; break;

   252

   253

			case TRACK_BIT_HORZ:

   254

				if (tileh == SLOPE_N) return HalftileFoundation(CORNER_N);

   255

				if (tileh == SLOPE_S) return HalftileFoundation(CORNER_S);

   256

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   257

   258

			case TRACK_BIT_VERT:

   259

				if (tileh == SLOPE_W) return HalftileFoundation(CORNER_W);

   260

				if (tileh == SLOPE_E) return HalftileFoundation(CORNER_E);

   261

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   262

   263

			case TRACK_BIT_X:

   264

				if (IsSlopeWithOneCornerRaised(tileh)) return FOUNDATION_INCLINED_X;

   265

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   266

   267

			case TRACK_BIT_Y:

   268

				if (IsSlopeWithOneCornerRaised(tileh)) return FOUNDATION_INCLINED_Y;

   269

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   270

   271

			default:

   272

				return (valid_on_leveled ? FOUNDATION_LEVELED : FOUNDATION_INVALID);

   273

		}

   274

		/* Single diagonal track */

   275

   276

		/* Track must be at least valid on leveled foundation */

   277

		if (!valid_on_leveled) return FOUNDATION_INVALID;

   278

   279

		/* If slope has three raised corners, build leveled foundation */

   280

		if (IsSlopeWithThreeCornersRaised(tileh)) return FOUNDATION_LEVELED;

   281

   282

		/* If neighboured corners of track_corner are lowered, build halftile foundation */

   283

		if ((tileh & SlopeWithThreeCornersRaised(OppositeCorner(track_corner))) == SlopeWithOneCornerRaised(track_corner)) return HalftileFoundation(track_corner);

   284

   285

		/* else special anti-zig-zag foundation */

   286

		return SpecialRailFoundation(track_corner);

   287

	}

   288

}

   289

   290

   291

/**

   292

 * Tests if a track can be build on a tile.

   293

 *

   294

 * @param tileh Tile slope.

   295

 * @param rail_bits Tracks to build.

   296

 * @param existing Tracks already built.

   297

 * @param tile Tile (used for water test)

   298

 * @return Error message or cost for foundation building.

   299

 */

   300

static CommandCost CheckRailSlope(Slope tileh, TrackBits rail_bits, TrackBits existing, TileIndex tile)

   301

{

   302

	/* don't allow building on the lower side of a coast */

   303

	if (IsTileType(tile, MP_WATER) || (IsTileType(tile, MP_RAILWAY) && (GetRailGroundType(tile) == RAIL_GROUND_WATER))) {

   304

		if (!IsSteepSlope(tileh) && ((~_valid_tracks_on_leveled_foundation[tileh] & (rail_bits | existing)) != 0)) return_cmd_error(STR_3807_CAN_T_BUILD_ON_WATER);

   305

	}

   306

   307

	Foundation f_new = GetRailFoundation(tileh, rail_bits | existing);

   308

   309

	/* check track/slope combination */

   310

	if ((f_new == FOUNDATION_INVALID) ||

   311

			((f_new != FOUNDATION_NONE) && (!_settings_game.construction.build_on_slopes || _is_old_ai_company))) {

   312

		return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   313

	}

   314

   315

	Foundation f_old = GetRailFoundation(tileh, existing);

   316

	return CommandCost(EXPENSES_CONSTRUCTION, f_new != f_old ? _price.terraform : (Money)0);

   317

}

   318

   319

/* Validate functions for rail building */

   320

static inline bool ValParamTrackOrientation(Track track) {return IsValidTrack(track);}

   321

   322

/** Build a single piece of rail

   323

 * @param tile tile  to build on

   324

 * @param flags operation to perform

   325

 * @param p1 railtype of being built piece (normal, mono, maglev)

   326

 * @param p2 rail track to build

   327

 */

   328

CommandCost CmdBuildSingleRail(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   329

{

   330

	Slope tileh;

   331

	RailType railtype = (RailType)p1;

   332

	Track track = (Track)p2;

   333

	TrackBits trackbit;

   334

	CommandCost cost(EXPENSES_CONSTRUCTION);

   335

	CommandCost ret;

   336

   337

	if (!ValParamRailtype(railtype) || !ValParamTrackOrientation(track)) return CMD_ERROR;

   338

   339

	tileh = GetTileSlope(tile, NULL);

   340

	trackbit = TrackToTrackBits(track);

   341

   342

	switch (GetTileType(tile)) {

   343

		case MP_RAILWAY:

   344

			if (!CheckTrackCombination(tile, trackbit, flags) ||

   345

					!EnsureNoTrainOnTrack(tile, track)) {

   346

				return CMD_ERROR;

   347

			}

   348

			if (!IsTileOwner(tile, _current_company) ||

   349

					!IsCompatibleRail(GetRailType(tile), railtype)) {

   350

				/* Get detailed error message */

   351

				return DoCommand(tile, 0, 0, flags, CMD_LANDSCAPE_CLEAR);

   352

			}

   353

   354

			ret = CheckRailSlope(tileh, trackbit, GetTrackBits(tile), tile);

   355

			if (CmdFailed(ret)) return ret;

   356

			cost.AddCost(ret);

   357

   358

			/* If the rail types don't match, try to convert only if engines of

   359

			 * the new rail type are not powered on the present rail type and engines of

   360

			 * the present rail type are powered on the new rail type. */

   361

			if (GetRailType(tile) != railtype && !HasPowerOnRail(railtype, GetRailType(tile))) {

   362

				if (HasPowerOnRail(GetRailType(tile), railtype)) {

   363

					ret = DoCommand(tile, tile, railtype, flags, CMD_CONVERT_RAIL);

   364

					if (CmdFailed(ret)) return ret;

   365

					cost.AddCost(ret);

   366

				} else {

   367

					return CMD_ERROR;

   368

				}

   369

			}

   370

   371

			if (flags & DC_EXEC) {

   372

				SetRailGroundType(tile, RAIL_GROUND_BARREN);

   373

				SetTrackBits(tile, GetTrackBits(tile) | trackbit);

   374

			}

   375

			break;

   376

   377

		case MP_ROAD:

   378

#define M(x) (1 << (x))

   379

			/* Level crossings may only be built on these slopes */

   380

			if (!HasBit(M(SLOPE_SEN) | M(SLOPE_ENW) | M(SLOPE_NWS) | M(SLOPE_NS) | M(SLOPE_WSE) | M(SLOPE_EW) | M(SLOPE_FLAT), tileh)) {

   381

				return_cmd_error(STR_1000_LAND_SLOPED_IN_WRONG_DIRECTION);

   382

			}

   383

#undef M

   384

   385

			if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   386

   387

			if (IsNormalRoad(tile)) {

   388

				if (HasRoadWorks(tile)) return_cmd_error(STR_ROAD_WORKS_IN_PROGRESS);

   389

   390

				if (GetDisallowedRoadDirections(tile) != DRD_NONE) return_cmd_error(STR_ERR_CROSSING_ON_ONEWAY_ROAD);

   391

   392

				RoadTypes roadtypes = GetRoadTypes(tile);

   393

				RoadBits road = GetRoadBits(tile, ROADTYPE_ROAD);

   394

				RoadBits tram = GetRoadBits(tile, ROADTYPE_TRAM);

   395

				switch (roadtypes) {

   396

					default: break;

   397

					case ROADTYPES_TRAM:

   398

						/* Tram crossings must always have road. */

   399

						if (flags & DC_EXEC) SetRoadOwner(tile, ROADTYPE_ROAD, _current_company);

   400

						roadtypes |= ROADTYPES_ROAD;

   401

						break;

   402

   403

					case ROADTYPES_ROADTRAM: if (road == tram) break;

   404

						/* FALL THROUGH */

   405

					case ROADTYPES_ROADHWAY: // Road and highway are incompatible in this case

   406

					case ROADTYPES_TRAMHWAY: // Tram and highway are incompatible in this case

   407

					case ROADTYPES_ALL:      // Also incompatible

   408

						return CMD_ERROR;

   409

				}

   410

   411

				road |= tram | GetRoadBits(tile, ROADTYPE_HWAY);

   412

   413

				if ((track == TRACK_X && road == ROAD_Y) ||

   414

						(track == TRACK_Y && road == ROAD_X)) {

   415

					if (flags & DC_EXEC) {

   416

						MakeRoadCrossing(tile, GetRoadOwner(tile, ROADTYPE_ROAD), GetRoadOwner(tile, ROADTYPE_TRAM), GetRoadOwner(tile, ROADTYPE_HWAY), _current_company, (track == TRACK_X ? AXIS_Y : AXIS_X), railtype, roadtypes, GetTownIndex(tile));

   417

						UpdateLevelCrossing(tile, false);

   418

					}

   419

					break;

   420

				}

   421

			}

   422

   423

			if (IsLevelCrossing(tile) && GetCrossingRailBits(tile) == trackbit) {

   424

				return_cmd_error(STR_1007_ALREADY_BUILT);

   425

			}

   426

			/* FALLTHROUGH */

   427

   428

		default:

   429

			/* Will there be flat water on the lower halftile? */

   430

			bool water_ground = IsTileType(tile, MP_WATER) && IsSlopeWithOneCornerRaised(tileh);

   431

   432

			ret = CheckRailSlope(tileh, trackbit, TRACK_BIT_NONE, tile);

   433

			if (CmdFailed(ret)) return ret;

   434

			cost.AddCost(ret);

   435

   436

			ret = DoCommand(tile, 0, 0, flags, CMD_LANDSCAPE_CLEAR);

   437

			if (CmdFailed(ret)) return ret;

   438

			cost.AddCost(ret);

   439

   440

			if (water_ground) {

   441

				cost.AddCost(-_price.clear_water);

   442

				cost.AddCost(_price.clear_roughland);

   443

			}

   444

   445

			if (flags & DC_EXEC) {

   446

				MakeRailNormal(tile, _current_company, trackbit, railtype);

   447

				if (water_ground) SetRailGroundType(tile, RAIL_GROUND_WATER);

   448

			}

   449

			break;

   450

	}

   451

   452

	if (flags & DC_EXEC) {

   453

		MarkTileDirtyByTile(tile);

   454

		AddTrackToSignalBuffer(tile, track, _current_company);

   455

		YapfNotifyTrackLayoutChange(tile, track);

   456

	}

   457

   458

	return cost.AddCost(RailBuildCost(railtype));

   459

}

   460

   461

/** Remove a single piece of track

   462

 * @param tile tile to remove track from

   463

 * @param flags operation to perform

   464

 * @param p1 unused

   465

 * @param p2 rail orientation

   466

 */

   467

CommandCost CmdRemoveSingleRail(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   468

{

   469

	Track track = (Track)p2;

   470

	TrackBits trackbit;

   471

	CommandCost cost(EXPENSES_CONSTRUCTION, _price.remove_rail );

   472

	bool crossing = false;

   473

   474

	if (!ValParamTrackOrientation((Track)p2)) return CMD_ERROR;

   475

	trackbit = TrackToTrackBits(track);

   476

   477

	/* Need to read tile owner now because it may change when the rail is removed

   478

	 * Also, in case of floods, _current_company != owner

   479

	 * There may be invalid tiletype even in exec run (when removing long track),

   480

	 * so do not call GetTileOwner(tile) in any case here */

   481

	Owner owner = INVALID_OWNER;

   482

   483

	Vehicle *v = NULL;

   484