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 (_patches.gotodepot && VehicleHasDepotOrders(v)) return false;

    96

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

    97

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

    98

    99

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

   100

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

   101

	}

   102

   103

	return _patches.servint_ispercent ?

   104

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

   105

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

   106

}

   107

   108

StringID VehicleInTheWayErrMsg(const Vehicle* v)

   109

{

   110

	switch (v->type) {

   111

		case VEH_TRAIN:    return STR_8803_TRAIN_IN_THE_WAY;

   112

		case VEH_ROAD:     return STR_9000_ROAD_VEHICLE_IN_THE_WAY;

   113

		case VEH_AIRCRAFT: return STR_A015_AIRCRAFT_IN_THE_WAY;

   114

		default:           return STR_980E_SHIP_IN_THE_WAY;

   115

	}

   116

}

   117

   118

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

   119

{

   120

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

   121

		return NULL;

   122

   123

	_error_message = VehicleInTheWayErrMsg(v);

   124

	return v;

   125

}

   126

   127

bool EnsureNoVehicle(TileIndex tile)

   128

{

   129

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

   130

}

   131

   132

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

   133

{

   134

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

   135

   136

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

   137

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

   138

   139

	_error_message = VehicleInTheWayErrMsg(v);

   140

	return v;

   141

}

   142

   143

   144

bool EnsureNoVehicleOnGround(TileIndex tile)

   145

{

   146

	TileInfo ti;

   147

   148

	ti.tile = tile;

   149

	ti.z = GetTileMaxZ(tile);

   150

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

   151

}

   152

   153

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z)

   154

{

   155

	TileInfo ti;

   156

   157

	ti.tile = tile;

   158

	ti.z = z;

   159

   160

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

   161

}

   162

   163

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

   164

{

   165

	int x1 = TileX(from);

   166

	int y1 = TileY(from);

   167

	int x2 = TileX(to);

   168

	int y2 = TileY(to);

   169

	Vehicle *veh;

   170

   171

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

   172

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

   173

		Swap(x1, x2);

   174

		Swap(y1, y2);

   175

	}

   176

	FOR_ALL_VEHICLES(veh) {

   177

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

   178

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

   179

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

   180

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

   181

				return veh;

   182

			}

   183

		}

   184

	}

   185

	return NULL;

   186

}

   187

   188

   189

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

   190

   191

void VehiclePositionChanged(Vehicle *v)

   192

{

   193

	int img = v->cur_image;

   194

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

   195

	const Sprite* spr = GetSprite(img);

   196

   197

	pt.x += spr->x_offs;

   198

	pt.y += spr->y_offs;

   199

   200

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

   201

   202

	v->left_coord = pt.x;

   203

	v->top_coord = pt.y;

   204

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

   205

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

   206

}

   207

   208

/** Called after load to update coordinates */

   209

void AfterLoadVehicles()

   210

{

   211

	Vehicle *v;

   212

   213

	FOR_ALL_VEHICLES(v) {

   214

		/* Reinstate the previous pointer */

   215

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

   216

   217

		v->UpdateDeltaXY(v->direction);

   218

   219

		v->fill_percent_te_id = INVALID_TE_ID;

   220

		v->first = NULL;

   221

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

   222

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

   223

   224

		v->cargo.InvalidateCache();

   225

	}

   226

   227

	FOR_ALL_VEHICLES(v) {

   228

		/* Fill the first pointers */

   229

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

   230

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

   231

				u->first = v;

   232

			}

   233

		}

   234

	}

   235

   236

	FOR_ALL_VEHICLES(v) {

   237

		assert(v->first != NULL);

   238

   239

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

   240

			TrainConsistChanged(v);

   241

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

   242

			RoadVehUpdateCache(v);

   243

		}

   244

	}

   245

   246

	FOR_ALL_VEHICLES(v) {

   247

		switch (v->type) {

   248

			case VEH_ROAD:

   249

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

   250

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

   251

				/* FALL THROUGH */

   252

			case VEH_TRAIN:

   253

			case VEH_SHIP:

   254

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

   255

				break;

   256

   257

			case VEH_AIRCRAFT:

   258

				if (IsNormalAircraft(v)) {

   259

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

   260

   261

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

   262

					Vehicle *shadow = v->Next();

   263

					shadow->cur_image = v->cur_image;

   264

   265

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

   266

					if (v->subtype == AIR_HELICOPTER) {

   267

						Vehicle *rotor = shadow->Next();

   268

						rotor->cur_image = GetRotorImage(v);

   269

					}

   270

   271

					UpdateAircraftCache(v);

   272

				}

   273

				break;

   274

			default: break;

   275

		}

   276

   277

		v->left_coord = INVALID_COORD;

   278

		VehiclePositionChanged(v);

   279

	}

   280

}

   281

   282

Vehicle::Vehicle()

   283

{

   284

	this->type               = VEH_INVALID;

   285

	this->left_coord         = INVALID_COORD;

   286

	this->group_id           = DEFAULT_GROUP;

   287

	this->fill_percent_te_id = INVALID_TE_ID;

   288

	this->first              = this;

   289

}

   290

   291

/**

   292

 * Get a value for a vehicle's random_bits.

   293

 * @return A random value from 0 to 255.

   294

 */

   295

byte VehicleRandomBits()

   296

{

   297

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

   298

}

   299

   300

   301

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

   302

{

   303

	uint counter = _Vehicle_pool.first_free_index;

   304

   305

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

   306

		Vehicle *v = AllocateRaw(counter);

   307

   308

		if (v == NULL) return false;

   309

		v = new (v) InvalidVehicle();

   310

   311

		if (vl != NULL) {

   312

			vl[i] = v;

   313

		}

   314

		counter++;

   315

	}

   316

   317

	return true;

   318

}

   319

   320

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

   321

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

   322

const int HASH_BITS = 7;

   323

const int HASH_SIZE = 1 << HASH_BITS;

   324

const int HASH_MASK = HASH_SIZE - 1;

   325

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

   326

const int TOTAL_HASH_MASK = TOTAL_HASH_SIZE - 1;

   327

   328

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

   329

 * Profiling results show that 0 is fastest. */

   330

const int HASH_RES = 0;

   331

   332

static Vehicle *_new_vehicle_position_hash[TOTAL_HASH_SIZE];

   333

   334

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

   335

{

   336

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

   337

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

   338

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

   339

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

   340

				void *a = proc(v, data);

   341

				if (a != NULL) return a;

   342

			}

   343

			if (x == xu) break;

   344

		}

   345

		if (y == yu) break;

   346

	}

   347

   348

	return NULL;

   349

}

   350

   351

   352

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

   353

{

   354

	const int COLL_DIST = 6;

   355

   356

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

   357

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

   358

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

   359

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

   360

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

   361

   362

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

   363

}

   364

   365

   366

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

   367

{

   368

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

   369

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

   370

   371

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

   372

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

   373

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

   374

   375

		void *a = proc(v, data);

   376

		if (a != NULL) return a;

   377

	}

   378

   379

	return NULL;

   380

}

   381

   382

static void UpdateNewVehiclePosHash(Vehicle *v, bool remove)

   383

{

   384

	Vehicle **old_hash = v->old_new_hash;

   385

	Vehicle **new_hash;

   386

   387

	if (remove) {

   388

		new_hash = NULL;

   389

	} else {

   390

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

   391

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

   392

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

   393

	}

   394

   395

	if (old_hash == new_hash) return;

   396

   397

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

   398

	if (old_hash != NULL) {

   399

		Vehicle *last = NULL;

   400

		Vehicle *u = *old_hash;

   401

		while (u != v) {

   402

			last = u;

   403

			u = u->next_new_hash;

   404

			assert(u != NULL);

   405

		}

   406

   407

		if (last == NULL) {

   408

			*old_hash = v->next_new_hash;

   409

		} else {

   410

			last->next_new_hash = v->next_new_hash;

   411

		}

   412

	}

   413

   414

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

   415

	if (new_hash != NULL) {

   416

		v->next_new_hash = *new_hash;

   417

		*new_hash = v;

   418

		assert(v != v->next_new_hash);

   419

	}

   420

   421

	/* Remember current hash position */

   422

	v->old_new_hash = new_hash;

   423

}

   424

   425

static Vehicle *_vehicle_position_hash[0x1000];

   426

   427

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

   428

{

   429

	UpdateNewVehiclePosHash(v, x == INVALID_COORD);

   430

   431

	Vehicle **old_hash, **new_hash;

   432

	int old_x = v->left_coord;

   433

	int old_y = v->top_coord;

   434

   435

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

   436

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

   437

   438

	if (old_hash == new_hash) return;

   439

   440

	/* remove from hash table? */

   441

	if (old_hash != NULL) {

   442

		Vehicle *last = NULL;

   443

		Vehicle *u = *old_hash;

   444

		while (u != v) {

   445

			last = u;

   446

			u = u->next_hash;

   447

			assert(u != NULL);

   448

		}

   449

   450

		if (last == NULL) {

   451

			*old_hash = v->next_hash;

   452

		} else {

   453

			last->next_hash = v->next_hash;

   454

		}

   455

	}

   456

   457

	/* insert into hash table? */

   458

	if (new_hash != NULL) {

   459

		v->next_hash = *new_hash;

   460

		*new_hash = v;

   461

	}

   462

}

   463

   464

void ResetVehiclePosHash()

   465

{

   466

	Vehicle *v;

   467

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

   468

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

   469

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

   470

}

   471

   472

void InitializeVehicles()

   473

{

   474

	_Vehicle_pool.CleanPool();

   475

	_Vehicle_pool.AddBlockToPool();

   476

   477

	ResetVehiclePosHash();

   478

}

   479

   480

Vehicle *GetLastVehicleInChain(Vehicle *v)

   481

{

   482

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

   483

	return v;

   484

}

   485

   486

uint CountVehiclesInChain(const Vehicle* v)

   487

{

   488

	uint count = 0;

   489

	do count++; while ((v = v->Next()) != NULL);