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

   215

		v->UpdateDeltaXY(v->direction);

   216

   217

		v->fill_percent_te_id = INVALID_TE_ID;

   218

		v->first = NULL;

   219

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

   220

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

   221

   222

		v->cargo.InvalidateCache();

   223

	}

   224

   225

	FOR_ALL_VEHICLES(v) {

   237

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

   238

			TrainConsistChanged(v);

   239

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

   240

			RoadVehUpdateCache(v);

   241

		}

   242

	}

   243

   244

	FOR_ALL_VEHICLES(v) {

   245

		switch (v->type) {

   246

			case VEH_ROAD:

   247

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

   248

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

   249

				/* FALL THROUGH */

   250

			case VEH_TRAIN:

   251

			case VEH_SHIP:

   252

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

   253

				break;

   254

   255

			case VEH_AIRCRAFT:

   256

				if (IsNormalAircraft(v)) {

   257

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

   258

   259

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

   260

					Vehicle *shadow = v->Next();

   261

					shadow->cur_image = v->cur_image;

   262

   263

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

   264

					if (v->subtype == AIR_HELICOPTER) {

   265

						Vehicle *rotor = shadow->Next();

   266

						rotor->cur_image = GetRotorImage(v);

   267

					}

   268

   269

					UpdateAircraftCache(v);

   270

				}

   271

				break;

   272

			default: break;

   273

		}

   274

   275

		v->left_coord = INVALID_COORD;

   276

		VehiclePositionChanged(v);

   277

	}

   278

}

   279

   280

Vehicle::Vehicle()

   281

{

   282

	this->type               = VEH_INVALID;

   283

	this->left_coord         = INVALID_COORD;

   284

	this->group_id           = DEFAULT_GROUP;

   285

	this->fill_percent_te_id = INVALID_TE_ID;

   287

}

   288

   289

/**

   290

 * Get a value for a vehicle's random_bits.

   291

 * @return A random value from 0 to 255.

   292

 */

   293

byte VehicleRandomBits()

   294

{

   295

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

   296

}

   297

   298

   299

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

   300

{

   301

	uint counter = _Vehicle_pool.first_free_index;

   302

   303

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

   304

		Vehicle *v = AllocateRaw(counter);

   305

   306

		if (v == NULL) return false;

   307

		v = new (v) InvalidVehicle();

   308

   309

		if (vl != NULL) {

   310

			vl[i] = v;

   311

		}

   312

		counter++;

   313

	}

   314

   315

	return true;

   316

}

   317

   318

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

   319

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

   320

const int HASH_BITS = 7;

   321

const int HASH_SIZE = 1 << HASH_BITS;

   322

const int HASH_MASK = HASH_SIZE - 1;

   323

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

   324

const int TOTAL_HASH_MASK = TOTAL_HASH_SIZE - 1;

   325

   326

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

   327

 * Profiling results show that 0 is fastest. */

   328

const int HASH_RES = 0;

   329

   330

static Vehicle *_new_vehicle_position_hash[TOTAL_HASH_SIZE];

   331

   332

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

   333

{

   334

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

   335

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

   336

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

   337

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

   338

				void *a = proc(v, data);

   339

				if (a != NULL) return a;

   340

			}

   341

			if (x == xu) break;

   342

		}

   343

		if (y == yu) break;

   344

	}

   345

   346

	return NULL;

   347

}

   348

   349

   350

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

   351

{

   352

	const int COLL_DIST = 6;

   353

   354

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

   355

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

   356

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

   357

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

   358

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

   359

   360

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

   361

}

   362

   363

   364

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

   365

{

   366

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

   367

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

   368

   369

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

   370

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

   371

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

   372

   373

		void *a = proc(v, data);

   374

		if (a != NULL) return a;

   375

	}

   376

   377

	return NULL;

   378

}

   379

   380

static void UpdateNewVehiclePosHash(Vehicle *v, bool remove)

   381

{

   382

	Vehicle **old_hash = v->old_new_hash;

   383

	Vehicle **new_hash;

   384

   385

	if (remove) {

   386

		new_hash = NULL;

   387

	} else {

   388

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

   389

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

   390

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

   391

	}

   392

   393

	if (old_hash == new_hash) return;

   394

   395

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

   396

	if (old_hash != NULL) {

   397

		Vehicle *last = NULL;

   398

		Vehicle *u = *old_hash;

   399

		while (u != v) {

   400

			last = u;

   401

			u = u->next_new_hash;

   402

			assert(u != NULL);

   403

		}

   404

   405

		if (last == NULL) {

   406

			*old_hash = v->next_new_hash;

   407

		} else {

   408

			last->next_new_hash = v->next_new_hash;

   409

		}

   410

	}

   411

   412

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

   413

	if (new_hash != NULL) {

   414

		v->next_new_hash = *new_hash;

   415

		*new_hash = v;

   416

		assert(v != v->next_new_hash);

   417

	}

   418

   419

	/* Remember current hash position */

   420

	v->old_new_hash = new_hash;

   421

}

   422

   423

static Vehicle *_vehicle_position_hash[0x1000];

   424

   425

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

   426

{

   427

	UpdateNewVehiclePosHash(v, x == INVALID_COORD);

   428

   429

	Vehicle **old_hash, **new_hash;

   430

	int old_x = v->left_coord;

   431

	int old_y = v->top_coord;

   432

   433

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

   434

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

   435

   436

	if (old_hash == new_hash) return;

   437

   438

	/* remove from hash table? */

   439

	if (old_hash != NULL) {

   440

		Vehicle *last = NULL;

   441

		Vehicle *u = *old_hash;

   442

		while (u != v) {

   443

			last = u;

   444

			u = u->next_hash;

   445

			assert(u != NULL);

   446

		}

   447

   448

		if (last == NULL) {

   449

			*old_hash = v->next_hash;

   450

		} else {

   451

			last->next_hash = v->next_hash;

   452

		}

   453

	}

   454

   455

	/* insert into hash table? */

   456

	if (new_hash != NULL) {

   457

		v->next_hash = *new_hash;

   458

		*new_hash = v;

   459

	}

   460

}

   461

   462

void ResetVehiclePosHash()

   463

{

   464

	Vehicle *v;

   465

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

   466

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

   467

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

   468

}

   469

   470

void InitializeVehicles()

   471

{

   472

	_Vehicle_pool.CleanPool();

   473

	_Vehicle_pool.AddBlockToPool();

   474

   475

	ResetVehiclePosHash();

   476

}

   477

   478

Vehicle *GetLastVehicleInChain(Vehicle *v)

   479

{

   480

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

   481

	return v;

   482

}

   483

   484

uint CountVehiclesInChain(const Vehicle* v)

   485

{

   486

	uint count = 0;

   487

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

   488

	return count;

   489

}