1

/* $Id$ */

     2

     3

/** @file vehicle.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "road_map.h"

     8

#include "roadveh.h"

     9

#include "ship.h"

    10

#include "spritecache.h"

    11

#include "table/sprites.h"

    12

#include "table/strings.h"

    13

#include "functions.h"

    14

#include "landscape.h"

    15

#include "map.h"

    16

#include "tile.h"

    17

#include "vehicle.h"

    18

#include "timetable.h"

    19

#include "gfx.h"

    20

#include "viewport.h"

    21

#include "news.h"

    22

#include "command.h"

    23

#include "saveload.h"

    24

#include "player.h"

    25

#include "engine.h"

    26

#include "sound.h"

    27

#include "debug.h"

    28

#include "vehicle_gui.h"

    29

#include "depot.h"

    30

#include "station.h"

    31

#include "rail.h"

    32

#include "train.h"

    33

#include "aircraft.h"

    34

#include "industry_map.h"

    35

#include "station_map.h"

    36

#include "water_map.h"

    37

#include "network/network.h"

    38

#include "yapf/yapf.h"

    39

#include "date.h"

    40

#include "newgrf_callbacks.h"

    41

#include "newgrf_engine.h"

    42

#include "newgrf_sound.h"

    43

#include "helpers.hpp"

    44

#include "group.h"

    45

#include "economy.h"

    46

#include "strings.h"

    47

    48

#define INVALID_COORD (0x7fffffff)

    49

#define GEN_HASH(x, y) ((GB((y), 6, 6) << 6) + GB((x), 7, 6))

    50

    51

    52

/* Tables used in vehicle.h to find the right command for a certain vehicle type */

    53

const uint32 _veh_build_proc_table[] = {

    54

	CMD_BUILD_RAIL_VEHICLE,

    55

	CMD_BUILD_ROAD_VEH,

    56

	CMD_BUILD_SHIP,

    57

	CMD_BUILD_AIRCRAFT,

    58

};

    59

const uint32 _veh_sell_proc_table[] = {

    60

	CMD_SELL_RAIL_WAGON,

    61

	CMD_SELL_ROAD_VEH,

    62

	CMD_SELL_SHIP,

    63

	CMD_SELL_AIRCRAFT,

    64

};

    65

    66

const uint32 _veh_refit_proc_table[] = {

    67

	CMD_REFIT_RAIL_VEHICLE,

    68

	CMD_REFIT_ROAD_VEH,

    69

	CMD_REFIT_SHIP,

    70

	CMD_REFIT_AIRCRAFT,

    71

};

    72

    73

const uint32 _send_to_depot_proc_table[] = {

    74

	CMD_SEND_TRAIN_TO_DEPOT,

    75

	CMD_SEND_ROADVEH_TO_DEPOT,

    76

	CMD_SEND_SHIP_TO_DEPOT,

    77

	CMD_SEND_AIRCRAFT_TO_HANGAR,

    78

};

    79

    80

    81

/* Initialize the vehicle-pool */

    82

DEFINE_OLD_POOL_GENERIC(Vehicle, Vehicle)

    83

    84

void VehicleServiceInDepot(Vehicle *v)

    85

{

    86

	v->date_of_last_service = _date;

    87

	v->breakdowns_since_last_service = 0;

    88

	v->reliability = GetEngine(v->engine_type)->reliability;

    89

	InvalidateWindow(WC_VEHICLE_DETAILS, v->index); // ensure that last service date and reliability are updated

    90

}

    91

    92

bool VehicleNeedsService(const Vehicle *v)

    93

{

    94

	if (v->vehstatus & (VS_STOPPED | VS_CRASHED))       return false;

    95

	if (v->current_order.type != OT_GOTO_DEPOT || !(v->current_order.flags & OF_PART_OF_ORDERS)) { // Don't interfere with a depot visit by the order list

    96

		if (_patches.gotodepot && VehicleHasDepotOrders(v)) return false;

    97

		if (v->current_order.type == OT_LOADING)            return false;

    98

		if (v->current_order.type == OT_GOTO_DEPOT && v->current_order.flags & OF_HALT_IN_DEPOT) return false;

    99

	}

   100

   101

	if (_patches.no_servicing_if_no_breakdowns && _opt.diff.vehicle_breakdowns == 0) {

   102

		return EngineHasReplacementForPlayer(GetPlayer(v->owner), v->engine_type, v->group_id);  /* Vehicles set for autoreplacing needs to go to a depot even if breakdowns are turned off */

   103

	}

   104

   105

	return _patches.servint_ispercent ?

   106

		(v->reliability < GetEngine(v->engine_type)->reliability * (100 - v->service_interval) / 100) :

   107

		(v->date_of_last_service + v->service_interval < _date);

   108

}

   109

   110

StringID VehicleInTheWayErrMsg(const Vehicle* v)

   111

{

   112

	switch (v->type) {

   113

		case VEH_TRAIN:    return STR_8803_TRAIN_IN_THE_WAY;

   114

		case VEH_ROAD:     return STR_9000_ROAD_VEHICLE_IN_THE_WAY;

   115

		case VEH_AIRCRAFT: return STR_A015_AIRCRAFT_IN_THE_WAY;

   116

		default:           return STR_980E_SHIP_IN_THE_WAY;

   117

	}

   118

}

   119

   120

static void *EnsureNoVehicleProc(Vehicle *v, void *data)

   121

{

   123

		return NULL;

   124

   125

	_error_message = VehicleInTheWayErrMsg(v);

   126

	return v;

   127

}

   128

   129

bool EnsureNoVehicle(TileIndex tile)

   130

{

   131

	return VehicleFromPos(tile, &tile, EnsureNoVehicleProc) == NULL;

   132

}

   133

   134

static void *EnsureNoVehicleProcZ(Vehicle *v, void *data)

   135

{

   136

	const TileInfo *ti = (const TileInfo*)data;

   137

   139

	if (v->z_pos > ti->z) return NULL;

   140

   141

	_error_message = VehicleInTheWayErrMsg(v);

   142

	return v;

   143

}

   144

   145

   146

bool EnsureNoVehicleOnGround(TileIndex tile)

   147

{

   148

	TileInfo ti;

   149

   150

	ti.tile = tile;

   151

	ti.z = GetTileMaxZ(tile);

   152

	return VehicleFromPos(tile, &ti, EnsureNoVehicleProcZ) == NULL;

   153

}

   154

   155

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z)

   156

{

   157

	TileInfo ti;

   158

   159

	ti.tile = tile;

   160

	ti.z = z;

   161

   162

	return (Vehicle*)VehicleFromPos(tile, &ti, EnsureNoVehicleProcZ);

   163

}

   164

   165

Vehicle *FindVehicleBetween(TileIndex from, TileIndex to, byte z, bool without_crashed)

   166

{

   167

	int x1 = TileX(from);

   168

	int y1 = TileY(from);

   169

	int x2 = TileX(to);

   170

	int y2 = TileY(to);

   171

	Vehicle *veh;

   172

   173

	/* Make sure x1 < x2 or y1 < y2 */

   174

	if (x1 > x2 || y1 > y2) {

   175

		Swap(x1, x2);

   176

		Swap(y1, y2);

   177

	}

   178

	FOR_ALL_VEHICLES(veh) {

   179

		if (without_crashed && (veh->vehstatus & VS_CRASHED) != 0) continue;

   180

		if ((veh->type == VEH_TRAIN || veh->type == VEH_ROAD) && (z == 0xFF || veh->z_pos == z)) {

   181

			if ((veh->x_pos >> 4) >= x1 && (veh->x_pos >> 4) <= x2 &&

   182

					(veh->y_pos >> 4) >= y1 && (veh->y_pos >> 4) <= y2) {

   183

				return veh;

   184

			}

   185

		}

   186

	}

   187

	return NULL;

   188

}

   189

   190

   191

static void UpdateVehiclePosHash(Vehicle* v, int x, int y);

   192

   193

void VehiclePositionChanged(Vehicle *v)

   194

{

   195

	int img = v->cur_image;

   196

	Point pt = RemapCoords(v->x_pos + v->x_offs, v->y_pos + v->y_offs, v->z_pos);

   197

	const Sprite* spr = GetSprite(img);

   198

   199

	pt.x += spr->x_offs;

   200

	pt.y += spr->y_offs;

   201

   202

	UpdateVehiclePosHash(v, pt.x, pt.y);

   203

   204

	v->left_coord = pt.x;

   205

	v->top_coord = pt.y;

   206

	v->right_coord = pt.x + spr->width + 2;

   207

	v->bottom_coord = pt.y + spr->height + 2;

   208

}

   209

   210

/** Called after load to update coordinates */

   211

void AfterLoadVehicles()

   212

{

   213

	Vehicle *v;

   214

   215

	FOR_ALL_VEHICLES(v) {

   216

		/* Reinstate the previous pointer */

   217

		if (v->Next() != NULL) v->Next()->previous = v;

   218

   219

		v->UpdateDeltaXY(v->direction);

   220

   221

		v->fill_percent_te_id = INVALID_TE_ID;

   222

		v->first = NULL;

   223

		if (v->type == VEH_TRAIN) v->u.rail.first_engine = INVALID_ENGINE;

   224

		if (v->type == VEH_ROAD)  v->u.road.first_engine = INVALID_ENGINE;

   225

   226

		v->cargo.InvalidateCache();

   227

	}

   228

   229

	FOR_ALL_VEHICLES(v) {

   230

		/* Fill the first pointers */

   231

		if (v->Previous() == NULL) {

   232

			for (Vehicle *u = v; u != NULL; u = u->Next()) {

   233

				u->first = v;

   234

			}

   235

		}

   236

	}

   237

   238

	FOR_ALL_VEHICLES(v) {

   239

		assert(v->first != NULL);

   240

   241

		if (v->type == VEH_TRAIN && (IsFrontEngine(v) || IsFreeWagon(v))) {

   242

			TrainConsistChanged(v);

   243

		} else if (v->type == VEH_ROAD && IsRoadVehFront(v)) {

   244

			RoadVehUpdateCache(v);

   245

		}

   246

	}

   247

   248

	FOR_ALL_VEHICLES(v) {

   249

		switch (v->type) {

   250

			case VEH_ROAD:

   251

				v->u.road.roadtype = HASBIT(EngInfo(v->engine_type)->misc_flags, EF_ROAD_TRAM) ? ROADTYPE_TRAM : ROADTYPE_ROAD;

   252

				v->u.road.compatible_roadtypes = RoadTypeToRoadTypes(v->u.road.roadtype);

   253

				/* FALL THROUGH */

   254

			case VEH_TRAIN:

   255

			case VEH_SHIP:

   256

				v->cur_image = v->GetImage(v->direction);

   257

				break;

   258

   259

			case VEH_AIRCRAFT:

   260

				if (IsNormalAircraft(v)) {

   261

					v->cur_image = v->GetImage(v->direction);

   262

   263

					/* The plane's shadow will have the same image as the plane */

   264

					Vehicle *shadow = v->Next();

   265

					shadow->cur_image = v->cur_image;

   266

   267

					/* In the case of a helicopter we will update the rotor sprites */

   268

					if (v->subtype == AIR_HELICOPTER) {

   269

						Vehicle *rotor = shadow->Next();

   270

						rotor->cur_image = GetRotorImage(v);

   271

					}

   272

   273

					UpdateAircraftCache(v);

   274

				}

   275

				break;

   276

			default: break;

   277

		}

   278

   279

		v->left_coord = INVALID_COORD;

   280

		VehiclePositionChanged(v);

   281

	}

   282

}

   283

   284

Vehicle::Vehicle()

   285

{

   286

	this->type               = VEH_INVALID;

   287

	this->left_coord         = INVALID_COORD;

   288

	this->group_id           = DEFAULT_GROUP;

   289

	this->fill_percent_te_id = INVALID_TE_ID;

   290

	this->first              = this;

   291

}

   292

   293

/**

   294

 * Get a value for a vehicle's random_bits.

   295

 * @return A random value from 0 to 255.

   296

 */

   297

byte VehicleRandomBits()

   298

{

   299

	return GB(Random(), 0, 8);

   300

}

   301

   302

   303

/* static */ bool Vehicle::AllocateList(Vehicle **vl, int num)

   304

{

   305

	uint counter = _Vehicle_pool.first_free_index;

   306

   307

	for (int i = 0; i != num; i++) {

   308

		Vehicle *v = AllocateRaw(counter);

   309

   310

		if (v == NULL) return false;

   311

		v = new (v) InvalidVehicle();

   312

   313

		if (vl != NULL) {

   314

			vl[i] = v;

   315

		}

   316

		counter++;

   317

	}

   318

   319

	return true;

   320

}

   321

   322

/* Size of the hash, 6 = 64 x 64, 7 = 128 x 128. Larger sizes will (in theory) reduce hash

   323

 * lookup times at the expense of memory usage. */

   324

const int HASH_BITS = 7;

   325

const int HASH_SIZE = 1 << HASH_BITS;

   326

const int HASH_MASK = HASH_SIZE - 1;

   327

const int TOTAL_HASH_SIZE = 1 << (HASH_BITS * 2);

   328

const int TOTAL_HASH_MASK = TOTAL_HASH_SIZE - 1;

   329

   330

/* Resolution of the hash, 0 = 1*1 tile, 1 = 2*2 tiles, 2 = 4*4 tiles, etc.

   331

 * Profiling results show that 0 is fastest. */

   332

const int HASH_RES = 0;

   333

   334

static Vehicle *_new_vehicle_position_hash[TOTAL_HASH_SIZE];

   335

   336

static void *VehicleFromHash(int xl, int yl, int xu, int yu, void *data, VehicleFromPosProc *proc)

   337

{

   338

	for (int y = yl; ; y = (y + (1 << HASH_BITS)) & (HASH_MASK << HASH_BITS)) {

   339

		for (int x = xl; ; x = (x + 1) & HASH_MASK) {

   340

			Vehicle *v = _new_vehicle_position_hash[(x + y) & TOTAL_HASH_MASK];

   341

			for (; v != NULL; v = v->next_new_hash) {

   342

				void *a = proc(v, data);

   343

				if (a != NULL) return a;

   344

			}

   345

			if (x == xu) break;

   346

		}

   347

		if (y == yu) break;

   348

	}

   349

   350

	return NULL;

   351

}

   352

   353

   354

void *VehicleFromPosXY(int x, int y, void *data, VehicleFromPosProc *proc)

   355

{

   356

	const int COLL_DIST = 6;

   357

   358

	/* Hash area to scan is from xl,yl to xu,yu */

   359

	int xl = GB((x - COLL_DIST) / TILE_SIZE, HASH_RES, HASH_BITS);

   360

	int xu = GB((x + COLL_DIST) / TILE_SIZE, HASH_RES, HASH_BITS);

   361

	int yl = GB((y - COLL_DIST) / TILE_SIZE, HASH_RES, HASH_BITS) << HASH_BITS;

   362

	int yu = GB((y + COLL_DIST) / TILE_SIZE, HASH_RES, HASH_BITS) << HASH_BITS;

   363

   364

	return VehicleFromHash(xl, yl, xu, yu, data, proc);

   365

}

   366

   367

   368

void *VehicleFromPos(TileIndex tile, void *data, VehicleFromPosProc *proc)

   369

{

   370

	int x = GB(TileX(tile), HASH_RES, HASH_BITS);

   371

	int y = GB(TileY(tile), HASH_RES, HASH_BITS) << HASH_BITS;

   372

   373

	Vehicle *v = _new_vehicle_position_hash[(x + y) & TOTAL_HASH_MASK];

   374

	for (; v != NULL; v = v->next_new_hash) {

   375

		if (v->tile != tile) continue;

   376

   377

		void *a = proc(v, data);

   378

		if (a != NULL) return a;

   379

	}

   380

   381

	return NULL;

   382

}

   383

   384

static void UpdateNewVehiclePosHash(Vehicle *v, bool remove)

   385

{

   386

	Vehicle **old_hash = v->old_new_hash;

   387

	Vehicle **new_hash;

   388

   389

	if (remove) {

   390

		new_hash = NULL;

   391

	} else {

   392

		int x = GB(TileX(v->tile), HASH_RES, HASH_BITS);

   393

		int y = GB(TileY(v->tile), HASH_RES, HASH_BITS) << HASH_BITS;

   394

		new_hash = &_new_vehicle_position_hash[(x + y) & TOTAL_HASH_MASK];

   395

	}

   396

   397

	if (old_hash == new_hash) return;

   398

   399

	/* Remove from the old position in the hash table */

   400

	if (old_hash != NULL) {

   401

		Vehicle *last = NULL;

   402

		Vehicle *u = *old_hash;

   403

		while (u != v) {

   404

			last = u;

   405

			u = u->next_new_hash;

   406

			assert(u != NULL);

   407

		}

   408

   409

		if (last == NULL) {

   410

			*old_hash = v->next_new_hash;

   411

		} else {

   412

			last->next_new_hash = v->next_new_hash;

   413

		}

   414

	}

   415

   416

	/* Insert vehicle at beginning of the new position in the hash table */

   417

	if (new_hash != NULL) {

   418

		v->next_new_hash = *new_hash;

   419

		*new_hash = v;

   420

		assert(v != v->next_new_hash);

   421

	}

   422

   423

	/* Remember current hash position */

   424

	v->old_new_hash = new_hash;

   425

}

   426

   427

static Vehicle *_vehicle_position_hash[0x1000];

   428

   429

static void UpdateVehiclePosHash(Vehicle* v, int x, int y)

   430

{

   431

	UpdateNewVehiclePosHash(v, x == INVALID_COORD);

   432

   433

	Vehicle **old_hash, **new_hash;

   434

	int old_x = v->left_coord;

   435

	int old_y = v->top_coord;

   436

   437

	new_hash = (x == INVALID_COORD) ? NULL : &_vehicle_position_hash[GEN_HASH(x, y)];

   438

	old_hash = (old_x == INVALID_COORD) ? NULL : &_vehicle_position_hash[GEN_HASH(old_x, old_y)];

   439

   440

	if (old_hash == new_hash) return;

   441

   442

	/* remove from hash table? */

   443

	if (old_hash != NULL) {

   444

		Vehicle *last = NULL;

   445

		Vehicle *u = *old_hash;

   446

		while (u != v) {

   447

			last = u;

   448

			u = u->next_hash;

   449

			assert(u != NULL);

   450

		}

   451

   452

		if (last == NULL) {

   453

			*old_hash = v->next_hash;

   454

		} else {

   455

			last->next_hash = v->next_hash;

   456

		}

   457

	}

   458

   459

	/* insert into hash table? */

   460

	if (new_hash != NULL) {

   461

		v->next_hash = *new_hash;

   462

		*new_hash = v;

   463

	}

   464

}

   465

   466

void ResetVehiclePosHash()

   467

{

   468

	Vehicle *v;

   469

	FOR_ALL_VEHICLES(v) { v->old_new_hash = NULL; }

   470

	memset(_vehicle_position_hash, 0, sizeof(_vehicle_position_hash));

   471

	memset(_new_vehicle_position_hash, 0, sizeof(_new_vehicle_position_hash));

   472

}

   473

   474

void InitializeVehicles()

   475

{

   476

	_Vehicle_pool.CleanPool();

   477

	_Vehicle_pool.AddBlockToPool();

   478

   479

	ResetVehiclePosHash();

   480

}

   481

   482

Vehicle *GetLastVehicleInChain(Vehicle *v)

   483

{

   484

	while (v->Next() != NULL) v = v->Next();

   485

	return v;

   486

}

   487

   488

uint CountVehiclesInChain(const Vehicle* v)

   489

{