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 "gfx.h"

    19

#include "viewport.h"

    20

#include "news.h"

    21

#include "command.h"

    22

#include "saveload.h"

    23

#include "player.h"

    24

#include "engine.h"

    25

#include "sound.h"

    26

#include "debug.h"

    27

#include "vehicle_gui.h"

    28

#include "depot.h"

    29

#include "station.h"

    30

#include "rail.h"

    31

#include "train.h"

    32

#include "aircraft.h"

    33

#include "industry_map.h"

    34

#include "station_map.h"

    35

#include "water_map.h"

    36

#include "network/network.h"

    37

#include "yapf/yapf.h"

    38

#include "date.h"

    39

#include "newgrf_callbacks.h"

    40

#include "newgrf_engine.h"

    41

#include "newgrf_sound.h"

    42

#include "helpers.hpp"

    43

    44

#define INVALID_COORD (-0x8000)

    45

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

    46

    47

    48

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

    49

const uint32 _veh_build_proc_table[] = {

    50

	CMD_BUILD_RAIL_VEHICLE,

    51

	CMD_BUILD_ROAD_VEH,

    52

	CMD_BUILD_SHIP,

    53

	CMD_BUILD_AIRCRAFT,

    54

};

    55

const uint32 _veh_sell_proc_table[] = {

    56

	CMD_SELL_RAIL_WAGON,

    57

	CMD_SELL_ROAD_VEH,

    58

	CMD_SELL_SHIP,

    59

	CMD_SELL_AIRCRAFT,

    60

};

    61

    62

const uint32 _veh_refit_proc_table[] = {

    63

	CMD_REFIT_RAIL_VEHICLE,

    64

	CMD_REFIT_ROAD_VEH,

    65

	CMD_REFIT_SHIP,

    66

	CMD_REFIT_AIRCRAFT,

    67

};

    68

    69

const uint32 _send_to_depot_proc_table[] = {

    70

	CMD_SEND_TRAIN_TO_DEPOT,

    71

	CMD_SEND_ROADVEH_TO_DEPOT,

    72

	CMD_SEND_SHIP_TO_DEPOT,

    73

	CMD_SEND_AIRCRAFT_TO_HANGAR,

    74

};

    75

    76

    77

enum {

    78

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

    79

};

    80

    81

/**

    82

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

    83

 */

    84

static void VehiclePoolNewBlock(uint start_item)

    85

{

    86

	Vehicle *v;

    87

    88

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

    89

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

    90

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

    91

		v->index = start_item++;

    92

		v = new (v) InvalidVehicle();

    93

	}

    94

}

    95

    96

/* Initialize the vehicle-pool */

    97

DEFINE_OLD_POOL(Vehicle, Vehicle, VehiclePoolNewBlock, NULL)

    98

    99

void VehicleServiceInDepot(Vehicle *v)

   100

{

   101

	v->date_of_last_service = _date;

   102

	v->breakdowns_since_last_service = 0;

   103

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

   104

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

   105

}

   106

   107

bool VehicleNeedsService(const Vehicle *v)

   108

{

   109

	if (v->vehstatus & VS_CRASHED)

   110

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

   111

   112

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

   113

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

   114

	}

   115

   116

	return _patches.servint_ispercent ?

   117

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

   118

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

   119

}

   120

   121

StringID VehicleInTheWayErrMsg(const Vehicle* v)

   122

{

   123

	switch (v->type) {

   124

		case VEH_TRAIN:    return STR_8803_TRAIN_IN_THE_WAY;

   125

		case VEH_ROAD:     return STR_9000_ROAD_VEHICLE_IN_THE_WAY;

   126

		case VEH_AIRCRAFT: return STR_A015_AIRCRAFT_IN_THE_WAY;

   127

		default:           return STR_980E_SHIP_IN_THE_WAY;

   128

	}

   129

}

   130

   131

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

   132

{

   133

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

   134

		return NULL;

   135

   136

	_error_message = VehicleInTheWayErrMsg(v);

   137

	return v;

   138

}

   139

   140

bool EnsureNoVehicle(TileIndex tile)

   141

{

   142

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

   143

}

   144

   145

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

   146

{

   147

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

   148

   149

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

   150

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

   151

   152

	_error_message = VehicleInTheWayErrMsg(v);

   153

	return v;

   154

}

   155

   156

   157

bool EnsureNoVehicleOnGround(TileIndex tile)

   158

{

   159

	TileInfo ti;

   160

   161

	ti.tile = tile;

   162

	ti.z = GetTileMaxZ(tile);

   163

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

   164

}

   165

   166

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z)

   167

{

   168

	TileInfo ti;

   169

   170

	ti.tile = tile;

   171

	ti.z = z;

   172

   173

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

   174

}

   175

   176

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

   177

{

   178

	int x1 = TileX(from);

   179

	int y1 = TileY(from);

   180

	int x2 = TileX(to);

   181

	int y2 = TileY(to);

   182

	Vehicle *veh;

   183

   184

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

   185

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

   186

		Swap(x1, x2);

   187

		Swap(y1, y2);

   188

	}

   189

	FOR_ALL_VEHICLES(veh) {

   190

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

   191

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

   192

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

   193

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

   194

				return veh;

   195

			}

   196

		}

   197

	}

   198

	return NULL;

   199

}

   200

   201

   202

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

   203

   204

void VehiclePositionChanged(Vehicle *v)

   205

{

   206

	int img = v->cur_image;

   207

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

   208

	const Sprite* spr = GetSprite(img);

   209

   210

	pt.x += spr->x_offs;

   211

	pt.y += spr->y_offs;

   212

   213

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

   214

   215

	v->left_coord = pt.x;

   216

	v->top_coord = pt.y;

   217

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

   218

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

   219

}

   220

   221

/** Called after load to update coordinates */

   222

void AfterLoadVehicles()

   223

{

   224

	Vehicle *v;

   225

   226

	FOR_ALL_VEHICLES(v) {

   227

		v->UpdateDeltaXY(v->direction);

   228

   229

		v->first = NULL;

   230

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

   231

	}

   232

   233

	FOR_ALL_VEHICLES(v) {

   234

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

   235

			TrainConsistChanged(v);

   236

	}

   237

   238

	FOR_ALL_VEHICLES(v) {

   239

		switch (v->type) {

   240

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

   241

			case VEH_ROAD: v->cur_image = GetRoadVehImage(v, v->direction); break;

   242

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

   243

			case VEH_AIRCRAFT:

   244

				if (IsNormalAircraft(v)) {

   245

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

   246

   247

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

   248

					Vehicle *shadow = v->next;

   249

					shadow->cur_image = v->cur_image;

   250

   251

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

   252

					if (v->subtype == AIR_HELICOPTER) {

   253

						Vehicle *rotor = shadow->next;

   254

						rotor->cur_image = GetRotorImage(v);

   255

					}

   256

   257

					UpdateAircraftCache(v);

   258

				}

   259

				break;

   260

			default: break;

   261

		}

   262

   263

		v->left_coord = INVALID_COORD;

   264

		VehiclePositionChanged(v);

   265

	}

   266

}

   267

   268

static Vehicle *InitializeVehicle(Vehicle *v)

   269

{

   270

	VehicleID index = v->index;

   271

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

   272

	v->index = index;

   273

   274

	assert(v->orders == NULL);

   275

   276

	v = new (v) InvalidVehicle();

   277

	v->left_coord = INVALID_COORD;

   278

	v->first = NULL;

   279

	v->next = NULL;

   280

	v->next_hash = NULL;

   281

	v->string_id = 0;

   282

	v->next_shared = NULL;

   283

	v->prev_shared = NULL;

   284

	v->depot_list  = NULL;

   285

	v->random_bits = 0;

   286

	return v;

   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

Vehicle *ForceAllocateSpecialVehicle()

   299

{

   300

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

   301

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

   302

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

   303

	 * BLOCKS_FOR_SPECIAL_VEHICLES times block_size vehicles that may only

   304

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

   305

   306

	Vehicle *v;

   307

   308

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

   309

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

   310

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

   311

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

   312

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

   313

			return NULL;

   314

   315

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

   316

	}

   317

   318

	return NULL;

   319

}

   320

   321

/**

   322

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

   323

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

   324

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

   325

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

   326

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

   327

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

   328

 */

   329

static Vehicle *AllocateSingleVehicle(VehicleID *skip_vehicles)

   330

{

   331

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

   332

	 * first blocks */

   333

	Vehicle *v;

   334

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

   335

   336

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

   337

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

   338

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

   339

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

   340

			(*skip_vehicles)++;

   341

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

   342

		}

   343

	}

   344

   345

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

   346

	if (AddBlockToPool(&_Vehicle_pool))

   347

		return AllocateSingleVehicle(skip_vehicles);

   348

   349

	return NULL;

   350

}

   351

   352

   353

Vehicle *AllocateVehicle()

   354

{

   355

	VehicleID counter = 0;

   356

	return AllocateSingleVehicle(&counter);

   357

}

   358

   359

   360

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

   361

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

   362

 * @param num number of vehicles to allocate room for

   363

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

   364

 */

   365

bool AllocateVehicles(Vehicle **vl, int num)

   366

{

   367

	int i;

   368

	Vehicle *v;

   369

	VehicleID counter = 0;

   370

   371

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

   372

		v = AllocateSingleVehicle(&counter);

   373

		if (v == NULL) {

   374

			return false;

   375

		}

   376

		if (vl != NULL) {

   377

			vl[i] = v;

   378

		}

   379

	}

   380

   381

	return true;

   382

}

   383

   384

   385

static Vehicle *_vehicle_position_hash[0x1000];

   386

   387

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

   388

{

   389

	Point pt = RemapCoords(TileX(tile) * TILE_SIZE, TileY(tile) * TILE_SIZE, 0);

   390

   391

	/* The hash area to scan */

   392

	const int xl = GB(pt.x - 174, 7, 6);

   393

	const int xu = GB(pt.x + 104, 7, 6);

   394

	const int yl = GB(pt.y - 294, 6, 6) << 6;

   395

	const int yu = GB(pt.y +  56, 6, 6) << 6;

   396

   397

	int x;

   398

	int y;

   399

   400

	for (y = yl;; y = (y + (1 << 6)) & (0x3F << 6)) {

   401

		for (x = xl;; x = (x + 1) & 0x3F) {

   402

			Vehicle *v = _vehicle_position_hash[(x + y) & 0xFFFF];

   403

   404

			while (v != NULL) {

   405

				void* a = proc(v, data);

   406

   407

				if (a != NULL) return a;

   408

				v = v->next_hash;

   409

			}

   410

   411

			if (x == xu) break;

   412

		}

   413

   414

		if (y == yu) break;

   415

	}

   416

	return NULL;

   417

}

   418

   419

   420

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

   421

{

   422

	Vehicle **old_hash, **new_hash;

   423

	int old_x = v->left_coord;

   424

	int old_y = v->top_coord;

   425

   426

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

   427

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

   428

   429

	if (old_hash == new_hash) return;

   430

   431

	/* remove from hash table? */

   432

	if (old_hash != NULL) {

   433

		Vehicle *last = NULL;

   434

		Vehicle *u = *old_hash;

   435

		while (u != v) {

   436

			last = u;

   437

			u = u->next_hash;

   438

			assert(u != NULL);

   439

		}

   440

   441

		if (last == NULL) {

   442

			*old_hash = v->next_hash;

   443

		} else {

   444

			last->next_hash = v->next_hash;

   445

		}

   446

	}

   447

   448

	/* insert into hash table? */

   449

	if (new_hash != NULL) {

   450

		v->next_hash = *new_hash;

   451

		*new_hash = v;

   452

	}

   453

}

   454

   455

void ResetVehiclePosHash()

   456

{

   457

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

   458

}

   459

   460

void InitializeVehicles()

   461

{

   462

	uint i;

   463

   464

	/* Clean the vehicle pool, and reserve enough blocks

   465

	 *  for the special vehicles, plus one for all the other

   466

	 *  vehicles (which is increased on-the-fly) */

   467

	CleanPool(&_Vehicle_pool);

   468

	AddBlockToPool(&_Vehicle_pool);

   469

	for (i = 0; i < BLOCKS_FOR_SPECIAL_VEHICLES; i++) {

   470

		AddBlockToPool(&_Vehicle_pool);

   471

	}

   472

   473

	ResetVehiclePosHash();

   474

}

   475

   476

Vehicle *GetLastVehicleInChain(Vehicle *v)

   477

{

   478

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

   479

	return v;

   480

}

   481

   482

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

   483

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

   484

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

   485

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

   486

 * called by anything but GetFirstVehicleInChain

   487

 */

   488

static Vehicle *GetPrevVehicleInChain_bruteforce(const Vehicle *v)