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

    95

		return false; // Crashed vehicles don't need service anymore

    96

    97

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

    98

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

    99

	}

   100

   101

	return _patches.servint_ispercent ?

   102

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

   103

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

   104

}

   105

   106

StringID VehicleInTheWayErrMsg(const Vehicle* v)

   107

{

   108

	switch (v->type) {

   109

		case VEH_TRAIN:    return STR_8803_TRAIN_IN_THE_WAY;

   110

		case VEH_ROAD:     return STR_9000_ROAD_VEHICLE_IN_THE_WAY;

   111

		case VEH_AIRCRAFT: return STR_A015_AIRCRAFT_IN_THE_WAY;

   112

		default:           return STR_980E_SHIP_IN_THE_WAY;

   113

	}

   114

}

   115

   116

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

   117

{

   118

	if (v->tile != *(const TileIndex*)data || v->type == VEH_DISASTER)

   119

		return NULL;

   120

   121

	_error_message = VehicleInTheWayErrMsg(v);

   122

	return v;

   123

}

   124

   125

bool EnsureNoVehicle(TileIndex tile)

   126

{

   127

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

   128

}

   129

   130

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

   131

{

   132

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

   133

   134

	if (v->tile != ti->tile || v->type == VEH_DISASTER) return NULL;

   135

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

   136

   137

	_error_message = VehicleInTheWayErrMsg(v);

   138

	return v;

   139

}

   140

   141

   142

bool EnsureNoVehicleOnGround(TileIndex tile)

   143

{

   144

	TileInfo ti;

   145

   146

	ti.tile = tile;

   147

	ti.z = GetTileMaxZ(tile);

   148

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

   149

}

   150

   151

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z)

   152

{

   153

	TileInfo ti;

   154

   155

	ti.tile = tile;

   156

	ti.z = z;

   157

   158

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

   159

}

   160

   161

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

   162

{

   163

	int x1 = TileX(from);

   164

	int y1 = TileY(from);

   165

	int x2 = TileX(to);

   166

	int y2 = TileY(to);

   167

	Vehicle *veh;

   168

   169

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

   170

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

   171

		Swap(x1, x2);

   172

		Swap(y1, y2);

   173

	}

   174

	FOR_ALL_VEHICLES(veh) {

   175

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

   176

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

   177

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

   178

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

   179

				return veh;

   180

			}

   181

		}

   182

	}

   183

	return NULL;

   184

}

   185

   186

   187

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

   188

   189

void VehiclePositionChanged(Vehicle *v)

   190

{

   191

	int img = v->cur_image;

   192

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

   193

	const Sprite* spr = GetSprite(img);

   194

   195

	pt.x += spr->x_offs;

   196

	pt.y += spr->y_offs;

   197

   198

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

   199

   200

	v->left_coord = pt.x;

   201

	v->top_coord = pt.y;

   202

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

   203

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

   204

}

   205

   206

/** Called after load to update coordinates */

   207

void AfterLoadVehicles()

   208

{

   209

	Vehicle *v;

   210

   211

	FOR_ALL_VEHICLES(v) {

   212

		v->UpdateDeltaXY(v->direction);

   213

   214

		v->fill_percent_te_id = INVALID_TE_ID;

   215

		v->first = NULL;

   216

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

   217

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

   218

   219

		v->cargo.InvalidateCache();

   220

	}

   221

   222

	FOR_ALL_VEHICLES(v) {

   223

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

   224

			TrainConsistChanged(v);

   225

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

   226

			RoadVehUpdateCache(v);

   227

		}

   228

	}

   229

   230

	FOR_ALL_VEHICLES(v) {

   231

		switch (v->type) {

   232

			case VEH_ROAD:

   233

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

   234

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

   235

				/* FALL THROUGH */

   236

			case VEH_TRAIN:

   237

			case VEH_SHIP:

   238

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

   239

				break;

   240

   241

			case VEH_AIRCRAFT:

   242

				if (IsNormalAircraft(v)) {

   243

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

   244

   245

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

   246

					Vehicle *shadow = v->next;

   247

					shadow->cur_image = v->cur_image;

   248

   249

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

   250

					if (v->subtype == AIR_HELICOPTER) {

   251

						Vehicle *rotor = shadow->next;

   252

						rotor->cur_image = GetRotorImage(v);

   253

					}

   254

   255

					UpdateAircraftCache(v);

   256

				}

   257

				break;

   258

			default: break;

   259

		}

   260

   261

		v->left_coord = INVALID_COORD;

   262

		VehiclePositionChanged(v);

   263

	}

   264

}

   265

   266

Vehicle::Vehicle()

   267

{

   268

	this->type               = VEH_INVALID;

   269

	this->left_coord         = INVALID_COORD;

   270

	this->group_id           = DEFAULT_GROUP;

   271

	this->fill_percent_te_id = INVALID_TE_ID;

   272

}

   273

   274

/**

   275

 * Get a value for a vehicle's random_bits.

   276

 * @return A random value from 0 to 255.

   277

 */

   278

byte VehicleRandomBits()

   279

{

   280

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

   281

}

   282

   283

   284

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

   285

{

   286

	uint counter = _Vehicle_pool.first_free_index;

   287

   288

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

   289

		Vehicle *v = AllocateRaw(counter);

   290

   291

		if (v == NULL) return false;

   292

		v = new (v) InvalidVehicle();

   293

   294

		if (vl != NULL) {

   295

			vl[i] = v;

   296

		}

   297

		counter++;

   298

	}

   299

   300

	return true;

   301

}

   302

   303

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

   304

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

   305

const int HASH_BITS = 7;

   306

const int HASH_SIZE = 1 << HASH_BITS;

   307

const int HASH_MASK = HASH_SIZE - 1;

   308

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

   309

const int TOTAL_HASH_MASK = TOTAL_HASH_SIZE - 1;

   310

   311

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

   312

 * Profiling results show that 0 is fastest. */

   313

const int HASH_RES = 0;

   314

   315

static Vehicle *_new_vehicle_position_hash[TOTAL_HASH_SIZE];

   316

   317

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

   318

{

   319

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

   320

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

   321

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

   322

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

   323

				void *a = proc(v, data);

   324

				if (a != NULL) return a;

   325

			}

   326

			if (x == xu) break;

   327

		}

   328

		if (y == yu) break;

   329

	}

   330

   331

	return NULL;

   332

}

   333

   334

   335

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

   336

{

   337

	const int COLL_DIST = 6;

   338

   339

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

   340

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

   341

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

   342

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

   343

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

   344

   345

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

   346

}

   347

   348

   349

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

   350

{

   351

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

   352

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

   353

   354

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

   355

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

   356

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

   357

   358

		void *a = proc(v, data);

   359

		if (a != NULL) return a;

   360

	}

   361

   362

	return NULL;

   363

}

   364

   365

static void UpdateNewVehiclePosHash(Vehicle *v, bool remove)

   366

{

   367

	Vehicle **old_hash = v->old_new_hash;

   368

	Vehicle **new_hash;

   369

   370

	if (remove) {

   371

		new_hash = NULL;

   372

	} else {

   373

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

   374

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

   375

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

   376

	}

   377

   378

	if (old_hash == new_hash) return;

   379

   380

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

   381

	if (old_hash != NULL) {

   382

		Vehicle *last = NULL;

   383

		Vehicle *u = *old_hash;

   384

		while (u != v) {

   385

			last = u;

   386

			u = u->next_new_hash;

   387

			assert(u != NULL);

   388

		}

   389

   390

		if (last == NULL) {

   391

			*old_hash = v->next_new_hash;

   392

		} else {

   393

			last->next_new_hash = v->next_new_hash;

   394

		}

   395

	}

   396

   397

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

   398

	if (new_hash != NULL) {

   399

		v->next_new_hash = *new_hash;

   400

		*new_hash = v;

   401

		assert(v != v->next_new_hash);

   402

	}

   403

   404

	/* Remember current hash position */

   405

	v->old_new_hash = new_hash;

   406

}

   407

   408

static Vehicle *_vehicle_position_hash[0x1000];

   409

   410

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

   411

{

   412

	UpdateNewVehiclePosHash(v, x == INVALID_COORD);

   413

   414

	Vehicle **old_hash, **new_hash;

   415

	int old_x = v->left_coord;

   416

	int old_y = v->top_coord;

   417

   418

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

   419

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

   420

   421

	if (old_hash == new_hash) return;

   422

   423

	/* remove from hash table? */

   424

	if (old_hash != NULL) {

   425

		Vehicle *last = NULL;

   426

		Vehicle *u = *old_hash;

   427

		while (u != v) {

   428

			last = u;

   429

			u = u->next_hash;

   430

			assert(u != NULL);

   431

		}

   432

   433

		if (last == NULL) {

   434

			*old_hash = v->next_hash;

   435

		} else {

   436

			last->next_hash = v->next_hash;

   437

		}

   438

	}

   439

   440

	/* insert into hash table? */

   441

	if (new_hash != NULL) {

   442

		v->next_hash = *new_hash;

   443

		*new_hash = v;

   444

	}

   445

}

   446

   447

void ResetVehiclePosHash()

   448

{

   449

	Vehicle *v;

   450

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

   451

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

   452

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

   453

}

   454

   455

void InitializeVehicles()

   456

{

   457

	_Vehicle_pool.CleanPool();

   458

	_Vehicle_pool.AddBlockToPool();

   459

   460

	ResetVehiclePosHash();

   461

}

   462

   463

Vehicle *GetLastVehicleInChain(Vehicle *v)

   464

{

   465

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

   466

	return v;

   467

}

   468

   469

/** Finds the previous vehicle in a chain, by a brute force search.

   470

 * This old function is REALLY slow because it searches through all vehicles to

   471

 * find the previous vehicle, but if v->first has not been set, then this function

   472

 * will need to be used to find the previous one. This function should never be

   473

 * called by anything but GetFirstVehicleInChain

   474

 */

   475

static Vehicle *GetPrevVehicleInChain_bruteforce(const Vehicle *v)

   476

{

   477

	Vehicle *u;

   478

   479

	FOR_ALL_VEHICLES(u) if (u->type == v->type && u->next == v) return u;

   480

   481

	return NULL;

   482

}

   483

   484

/** Find the previous vehicle in a chain, by using the v->first cache.

   485

 * While this function is fast, it cannot be used in the GetFirstVehicleInChain

   486

 * function, otherwise you'll end up in an infinite loop call

   487

 */

   488

Vehicle *GetPrevVehicleInChain(const Vehicle *v)

   489

{