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

    47

#define INVALID_COORD (0x7fffffff)

    48

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

    49

    50

    51

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

    52

const uint32 _veh_build_proc_table[] = {

    53

	CMD_BUILD_RAIL_VEHICLE,

    54

	CMD_BUILD_ROAD_VEH,

    55

	CMD_BUILD_SHIP,

    56

	CMD_BUILD_AIRCRAFT,

    57

};

    58

const uint32 _veh_sell_proc_table[] = {

    59

	CMD_SELL_RAIL_WAGON,

    60

	CMD_SELL_ROAD_VEH,

    61

	CMD_SELL_SHIP,

    62

	CMD_SELL_AIRCRAFT,

    63

};

    64

    65

const uint32 _veh_refit_proc_table[] = {

    66

	CMD_REFIT_RAIL_VEHICLE,

    67

	CMD_REFIT_ROAD_VEH,

    68

	CMD_REFIT_SHIP,

    69

	CMD_REFIT_AIRCRAFT,

    70

};

    71

    72

const uint32 _send_to_depot_proc_table[] = {

    73

	CMD_SEND_TRAIN_TO_DEPOT,

    74

	CMD_SEND_ROADVEH_TO_DEPOT,

    75

	CMD_SEND_SHIP_TO_DEPOT,

    76

	CMD_SEND_AIRCRAFT_TO_HANGAR,

    77

};

    78

    79

    80

enum {

    81

	BLOCKS_FOR_SPECIAL_VEHICLES   = 2, ///< Blocks needed for special vehicles

    82

};

    83

    84

/**

    85

 * Called if a new block is added to the vehicle-pool

    86

 */

    87

static void VehiclePoolNewBlock(uint start_item)

    88

{

    89

	Vehicle *v;

    90

    91

	/* We don't use FOR_ALL here, because FOR_ALL skips invalid items.

    92

	 * TODO - This is just a temporary stage, this will be removed. */

    93

	for (v = GetVehicle(start_item); v != NULL; v = (v->index + 1U < GetVehiclePoolSize()) ? GetVehicle(v->index + 1) : NULL) {

    94

		v->index = start_item++;

    95

		v = new (v) InvalidVehicle();

    96

	}

    97

}

    98

    99

/* Initialize the vehicle-pool */

   100

DEFINE_OLD_POOL(Vehicle, Vehicle, VehiclePoolNewBlock, NULL)

   101

   102

void VehicleServiceInDepot(Vehicle *v)

   103

{

   104

	v->date_of_last_service = _date;

   105

	v->breakdowns_since_last_service = 0;

   106

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

   107

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

   108

}

   109

   110

bool VehicleNeedsService(const Vehicle *v)

   111

{

   112

	if (v->vehstatus & VS_CRASHED)

   113

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

   114

   115

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

   116

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

   117

	}

   118

   119

	return _patches.servint_ispercent ?

   120

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

   121

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

   122

}

   123

   124

StringID VehicleInTheWayErrMsg(const Vehicle* v)

   125

{

   126

	switch (v->type) {

   127

		case VEH_TRAIN:    return STR_8803_TRAIN_IN_THE_WAY;

   128

		case VEH_ROAD:     return STR_9000_ROAD_VEHICLE_IN_THE_WAY;

   129

		case VEH_AIRCRAFT: return STR_A015_AIRCRAFT_IN_THE_WAY;

   130

		default:           return STR_980E_SHIP_IN_THE_WAY;

   131

	}

   132

}

   133

   134

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

   135

{

   136

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

   137

		return NULL;

   138

   139

	_error_message = VehicleInTheWayErrMsg(v);

   140

	return v;

   141

}

   142

   143

bool EnsureNoVehicle(TileIndex tile)

   144

{

   145

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

   146

}

   147

   148

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

   149

{

   150

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

   151

   152

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

   153

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

   154

   155

	_error_message = VehicleInTheWayErrMsg(v);

   156

	return v;

   157

}

   158

   159

   160

bool EnsureNoVehicleOnGround(TileIndex tile)

   161

{

   162

	TileInfo ti;

   163

   164

	ti.tile = tile;

   165

	ti.z = GetTileMaxZ(tile);

   166

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

   167

}

   168

   169

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z)

   170

{

   171

	TileInfo ti;

   172

   173

	ti.tile = tile;

   174

	ti.z = z;

   175

   176

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

   177

}

   178

   179

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

   180

{

   181

	int x1 = TileX(from);

   182

	int y1 = TileY(from);

   183

	int x2 = TileX(to);

   184

	int y2 = TileY(to);

   185

	Vehicle *veh;

   186

   187

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

   188

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

   189

		Swap(x1, x2);

   190

		Swap(y1, y2);

   191

	}

   192

	FOR_ALL_VEHICLES(veh) {

   193

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

   194

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

   195

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

   196

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

   197

				return veh;

   198

			}

   199

		}

   200

	}

   201

	return NULL;

   202

}

   203

   204

   205

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

   206

   207

void VehiclePositionChanged(Vehicle *v)

   208

{

   209

	int img = v->cur_image;

   210

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

   211

	const Sprite* spr = GetSprite(img);

   212

   213

	pt.x += spr->x_offs;

   214

	pt.y += spr->y_offs;

   215

   216

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

   217

   218

	v->left_coord = pt.x;

   219

	v->top_coord = pt.y;

   220

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

   221

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

   222

}

   223

   224

/** Called after load to update coordinates */

   225

void AfterLoadVehicles()

   226

{

   227

	Vehicle *v;

   228

   229

	FOR_ALL_VEHICLES(v) {

   230

		v->UpdateDeltaXY(v->direction);

   231

   232

		v->first = NULL;

   233

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

   234

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

   235

	}

   236

   237

	FOR_ALL_VEHICLES(v) {

   238

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

   239

			TrainConsistChanged(v);

   240

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

   241

			RoadVehUpdateCache(v);

   242

		}

   243

	}

   244

   245

	FOR_ALL_VEHICLES(v) {

   246

		switch (v->type) {

   247

			case VEH_ROAD:

   248

				v->cur_image = GetRoadVehImage(v, v->direction);

   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

				break;

   252

   253

			case VEH_TRAIN: v->cur_image = GetTrainImage(v, v->direction); break;

   254

			case VEH_SHIP: v->cur_image = GetShipImage(v, v->direction); break;

   255

			case VEH_AIRCRAFT:

   256

				if (IsNormalAircraft(v)) {

   257

					v->cur_image = GetAircraftImage(v, 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

static Vehicle *InitializeVehicle(Vehicle *v)

   281

{

   282

	VehicleID index = v->index;

   283

	memset(v, 0, sizeof(Vehicle));

   284

	v->index = index;

   285

   286

	assert(v->orders == NULL);

   287

   288

	v = new (v) InvalidVehicle();

   289

	v->left_coord = INVALID_COORD;

   290

	v->first = NULL;

   291

	v->next = NULL;

   292

	v->next_hash = NULL;

   293

	v->string_id = 0;

   294

	v->next_shared = NULL;

   295

	v->prev_shared = NULL;

   296

	v->depot_list  = NULL;

   297

	v->random_bits = 0;

   298

	v->group_id = DEFAULT_GROUP;

   299

   300

	return v;

   301

}

   302

   303

/**

   304

 * Get a value for a vehicle's random_bits.

   305

 * @return A random value from 0 to 255.

   306

 */

   307

byte VehicleRandomBits()

   308

{

   309

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

   310

}

   311

   312

Vehicle *ForceAllocateSpecialVehicle()

   313

{

   314

	/* This stays a strange story.. there should always be room for special

   315

	 * vehicles (special effects all over the map), but with 65k of vehicles

   316

	 * is this realistic to double-check for that? For now we just reserve

   317

	 * BLOCKS_FOR_SPECIAL_VEHICLES times block_size vehicles that may only

   318

	 * be used for special vehicles.. should work nicely :) */

   319

   320

	Vehicle *v;

   321

   322

	/* We don't use FOR_ALL here, because FOR_ALL skips invalid items.

   323

	 * TODO - This is just a temporary stage, this will be removed. */

   324

	for (v = GetVehicle(0); v != NULL; v = (v->index + 1U < GetVehiclePoolSize()) ? GetVehicle(v->index + 1) : NULL) {

   325

		/* No more room for the special vehicles, return NULL */

   326

		if (v->index >= (1 << Vehicle_POOL_BLOCK_SIZE_BITS) * BLOCKS_FOR_SPECIAL_VEHICLES)

   327

			return NULL;

   328

   329

		if (!IsValidVehicle(v)) return InitializeVehicle(v);

   330

	}

   331

   332

	return NULL;

   333

}

   334

   335

/**

   336

 * finds a free vehicle in the memory or allocates a new one

   337

 * returns a pointer to the first free vehicle or NULL if all vehicles are in use

   338

 * *skip_vehicles is an offset to where in the array we should begin looking

   339

 * this is to avoid looping though the same vehicles more than once after we learned that they are not free

   340

 * this feature is used by AllocateVehicles() since it need to allocate more than one and when

   341

 * another block is added to _Vehicle_pool, since we only do that when we know it's already full

   342

 */

   343

static Vehicle *AllocateSingleVehicle(VehicleID *skip_vehicles)

   344

{

   345

	/* See note by ForceAllocateSpecialVehicle() why we skip the

   346

	 * first blocks */

   347

	Vehicle *v;

   348

	const int offset = (1 << Vehicle_POOL_BLOCK_SIZE_BITS) * BLOCKS_FOR_SPECIAL_VEHICLES;

   349

   350

	/* We don't use FOR_ALL here, because FOR_ALL skips invalid items.

   351

	 * @todo - This is just a temporary stage, this will be removed. */

   352

	if (*skip_vehicles < (_Vehicle_pool.total_items - offset)) { // make sure the offset in the array is not larger than the array itself

   353

		for (v = GetVehicle(offset + *skip_vehicles); v != NULL; v = (v->index + 1U < GetVehiclePoolSize()) ? GetVehicle(v->index + 1) : NULL) {

   354

			(*skip_vehicles)++;

   355

			if (!IsValidVehicle(v)) return InitializeVehicle(v);

   356

		}

   357

	}

   358

   359

	/* Check if we can add a block to the pool */

   360

	if (AddBlockToPool(&_Vehicle_pool))

   361

		return AllocateSingleVehicle(skip_vehicles);

   362

   363

	return NULL;

   364

}

   365

   366

   367

Vehicle *AllocateVehicle()

   368

{

   369

	VehicleID counter = 0;

   370

	return AllocateSingleVehicle(&counter);

   371

}

   372

   373

   374

/** Allocates a lot of vehicles and frees them again

   375

 * @param vl pointer to an array of vehicles to get allocated. Can be NULL if the vehicles aren't needed (makes it test only)

   376

 * @param num number of vehicles to allocate room for

   377

 * @return true if there is room to allocate all the vehicles

   378

 */

   379

bool AllocateVehicles(Vehicle **vl, int num)

   380

{

   381

	int i;

   382

	Vehicle *v;

   383

	VehicleID counter = 0;

   384

   385

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

   386

		v = AllocateSingleVehicle(&counter);

   387

		if (v == NULL) {

   388

			return false;

   389

		}

   390

		if (vl != NULL) {

   391

			vl[i] = v;

   392

		}

   393

	}

   394

   395

	return true;

   396

}

   397

   398

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

   399

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

   400

const int HASH_BITS = 7;

   401

const int HASH_SIZE = 1 << HASH_BITS;

   402

const int HASH_MASK = HASH_SIZE - 1;

   403

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

   404

const int TOTAL_HASH_MASK = TOTAL_HASH_SIZE - 1;

   405

   406

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

   407

 * Profiling results show that 0 is fastest. */

   408

const int HASH_RES = 0;

   409

   410

static Vehicle *_new_vehicle_position_hash[TOTAL_HASH_SIZE];

   411

   412

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

   413

{

   414

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

   415

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

   416

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

   417

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

   418

				void *a = proc(v, data);

   419

				if (a != NULL) return a;

   420

			}

   421

			if (x == xu) break;

   422

		}

   423

		if (y == yu) break;

   424

	}

   425

   426

	return NULL;

   427

}

   428

   429

   430

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

   431

{

   432

	const int COLL_DIST = 6;

   433

   434

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

   435

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

   436

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

   437

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

   438

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

   439

   440

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

   441

}

   442

   443

   444

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

   445

{

   446

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

   447

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

   448

   449

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

   450

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

   451

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

   452

   453

		void *a = proc(v, data);

   454

		if (a != NULL) return a;

   455

	}

   456

   457

	return NULL;

   458

}

   459

   460

static void UpdateNewVehiclePosHash(Vehicle *v, bool remove)

   461

{

   462

	Vehicle **old_hash = v->old_new_hash;

   463

	Vehicle **new_hash;

   464

   465

	if (remove) {

   466

		new_hash = NULL;

   467

	} else {

   468

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

   469

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

   470

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

   471

	}

   472

   473

	if (old_hash == new_hash) return;

   474

   475

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

   476

	if (old_hash != NULL) {

   477

		Vehicle *last = NULL;

   478

		Vehicle *u = *old_hash;

   479

		while (u != v) {

   480

			last = u;

   481

			u = u->next_new_hash;

   482

			assert(u != NULL);

   483

		}

   484

   485

		if (last == NULL) {

   486

			*old_hash = v->next_new_hash;

   487

		} else {

   488

			last->next_new_hash = v->next_new_hash;