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

    15

#include "tile.h"

    16

#include "vehicle.h"

    17

#include "gfx.h"

    18

#include "viewport.h"

    19

#include "news.h"

    20

#include "command.h"

    21

#include "saveload.h"

    22

#include "player.h"

    23

#include "engine.h"

    24

#include "sound.h"

    25

#include "debug.h"

    26

#include "vehicle_gui.h"

    27

#include "depot.h"

    28

#include "station.h"

    29

#include "rail.h"

    30

#include "train.h"

    31

#include "aircraft.h"

    32

#include "industry_map.h"

    33

#include "station_map.h"

    34

#include "water_map.h"

    35

#include "network/network.h"

    36

#include "yapf/yapf.h"

    37

#include "date.h"

    38

#include "newgrf_callbacks.h"

    39

#include "newgrf_engine.h"

    40

#include "newgrf_sound.h"

    41

#include "helpers.hpp"

    42

    43

#define INVALID_COORD (-0x8000)

    44

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

    45

    46

    47

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

    48

const uint32 _veh_build_proc_table[] = {

    49

	CMD_BUILD_RAIL_VEHICLE,

    50

	CMD_BUILD_ROAD_VEH,

    51

	CMD_BUILD_SHIP,

    52

	CMD_BUILD_AIRCRAFT,

    53

};

    54

const uint32 _veh_sell_proc_table[] = {

    55

	CMD_SELL_RAIL_WAGON,

    56

	CMD_SELL_ROAD_VEH,

    57

	CMD_SELL_SHIP,

    58

	CMD_SELL_AIRCRAFT,

    59

};

    60

    61

const uint32 _veh_refit_proc_table[] = {

    62

	CMD_REFIT_RAIL_VEHICLE,

    63

	CMD_REFIT_ROAD_VEH,

    64

	CMD_REFIT_SHIP,

    65

	CMD_REFIT_AIRCRAFT,

    66

};

    67

    68

const uint32 _send_to_depot_proc_table[] = {

    69

	CMD_SEND_TRAIN_TO_DEPOT,

    70

	CMD_SEND_ROADVEH_TO_DEPOT,

    71

	CMD_SEND_SHIP_TO_DEPOT,

    72

	CMD_SEND_AIRCRAFT_TO_HANGAR,

    73

};

    74

    75

    76

enum {

    77

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

    78

};

    79

    80

/**

    81

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

    82

 */

    83

static void VehiclePoolNewBlock(uint start_item)

    84

{

    85

	Vehicle *v;

    86

    87

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

    88

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

    89

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

    90

		v->index = start_item++;

    91

		v->type  = VEH_INVALID;

    92

	}

    93

}

    94

    95

/* Initialize the vehicle-pool */

    96

DEFINE_OLD_POOL(Vehicle, Vehicle, VehiclePoolNewBlock, NULL)

    97

    98

void VehicleServiceInDepot(Vehicle *v)

    99

{

   100

	v->date_of_last_service = _date;

   101

	v->breakdowns_since_last_service = 0;

   102

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

   103

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

   104

}

   105

   106

bool VehicleNeedsService(const Vehicle *v)

   107

{

   108

	if (v->vehstatus & VS_CRASHED)

   109

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

   110

   111

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

   112

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

   113

	}

   114

   115

	return _patches.servint_ispercent ?

   116

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

   117

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

   118

}

   119

   120

StringID VehicleInTheWayErrMsg(const Vehicle* v)

   121

{

   122

	switch (v->type) {

   123

		case VEH_TRAIN:    return STR_8803_TRAIN_IN_THE_WAY;

   124

		case VEH_ROAD:     return STR_9000_ROAD_VEHICLE_IN_THE_WAY;

   125

		case VEH_AIRCRAFT: return STR_A015_AIRCRAFT_IN_THE_WAY;

   126

		default:           return STR_980E_SHIP_IN_THE_WAY;

   127

	}

   128

}

   129

   130

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

   131

{

   132

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

   133

		return NULL;

   134

   135

	_error_message = VehicleInTheWayErrMsg(v);

   136

	return v;

   137

}

   138

   139

bool EnsureNoVehicle(TileIndex tile)

   140

{

   141

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

   142

}

   143

   144

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

   145

{

   146

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

   147

   148

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

   149

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

   150

   151

	_error_message = VehicleInTheWayErrMsg(v);

   152

	return v;

   153

}

   154

   155

   156

bool EnsureNoVehicleOnGround(TileIndex tile)

   157

{

   158

	TileInfo ti;

   159

   160

	ti.tile = tile;

   161

	ti.z = GetTileMaxZ(tile);

   162

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

   163

}

   164

   165

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z)

   166

{

   167

	TileInfo ti;

   168

   169

	ti.tile = tile;

   170

	ti.z = z;

   171

   172

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

   173

}

   174

   175

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

   176

{

   177

	int x1 = TileX(from);

   178

	int y1 = TileY(from);

   179

	int x2 = TileX(to);

   180

	int y2 = TileY(to);

   181

	Vehicle *veh;

   182

   183

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

   184

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

   185

		Swap(x1, x2);

   186

		Swap(y1, y2);

   187

	}

   188

	FOR_ALL_VEHICLES(veh) {

   189

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

   190

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

   191

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

   192

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

   193

				return veh;

   194

			}

   195

		}

   196

	}

   197

	return NULL;

   198

}

   199

   200

   201

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

   202

   203

void VehiclePositionChanged(Vehicle *v)

   204

{

   205

	int img = v->cur_image;

   206

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

   207

	const Sprite* spr = GetSprite(img);

   208

   209

	pt.x += spr->x_offs;

   210

	pt.y += spr->y_offs;

   211

   212

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

   213

   214

	v->left_coord = pt.x;

   215

	v->top_coord = pt.y;

   216

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

   217

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

   218

}

   219

   220

/** Called after load to update coordinates */

   221

void AfterLoadVehicles()

   222

{

   223

	Vehicle *v;

   224

   225

	FOR_ALL_VEHICLES(v) {

   226

		v->first = NULL;

   227

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

   228

	}

   229

   230

	FOR_ALL_VEHICLES(v) {

   231

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

   232

			TrainConsistChanged(v);

   233

	}

   234

   235

	FOR_ALL_VEHICLES(v) {

   236

		switch (v->type) {

   237

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

   238

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

   239

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

   240

			case VEH_AIRCRAFT:

   241

				if (IsNormalAircraft(v)) {

   242

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

   243

   244

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

   245

					Vehicle *shadow = v->next;

   246

					shadow->cur_image = v->cur_image;

   247

   248

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

   249

					if (v->subtype == AIR_HELICOPTER) {

   250

						Vehicle *rotor = shadow->next;

   251

						rotor->cur_image = GetRotorImage(v);

   252

					}

   253

				}

   254

				break;

   255

			default: break;

   256

		}

   257

   258

		v->left_coord = INVALID_COORD;

   259

		VehiclePositionChanged(v);

   260

	}

   261

}

   262

   263

static Vehicle *InitializeVehicle(Vehicle *v)

   264

{

   265

	VehicleID index = v->index;

   266

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

   267

	v->index = index;

   268

   269

	assert(v->orders == NULL);

   270

   271

	v->type = VEH_INVALID;

   272

	v->left_coord = INVALID_COORD;

   273

	v->first = NULL;

   274

	v->next = NULL;

   275

	v->next_hash = NULL;

   276

	v->string_id = 0;

   277

	v->next_shared = NULL;

   278

	v->prev_shared = NULL;

   279

	v->depot_list  = NULL;

   280

	v->random_bits = 0;

   281

	return v;

   282

}

   283

   284

/**

   285

 * Get a value for a vehicle's random_bits.

   286

 * @return A random value from 0 to 255.

   287

 */

   288

byte VehicleRandomBits()

   289

{

   290

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

   291

}

   292

   293

Vehicle *ForceAllocateSpecialVehicle()

   294

{

   295

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

   296

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

   297

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

   298

	 * BLOCKS_FOR_SPECIAL_VEHICLES times block_size vehicles that may only

   299

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

   300

   301

	Vehicle *v;

   302

   303

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

   304

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

   305

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

   306

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

   307

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

   308

			return NULL;

   309

   310

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

   311

	}

   312

   313

	return NULL;

   314

}

   315

   316

/**

   317

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

   318

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

   319

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

   320

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

   321

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

   322

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

   323

 */

   324

static Vehicle *AllocateSingleVehicle(VehicleID *skip_vehicles)

   325

{

   326

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

   327

	 * first blocks */

   328

	Vehicle *v;

   329

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

   330

   331

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

   332

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

   333

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

   334

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

   335

			(*skip_vehicles)++;

   336

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

   337

		}

   338

	}

   339

   340

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

   341

	if (AddBlockToPool(&_Vehicle_pool))

   342

		return AllocateSingleVehicle(skip_vehicles);

   343

   344

	return NULL;

   345

}

   346

   347

   348

Vehicle *AllocateVehicle()

   349

{

   350

	VehicleID counter = 0;

   351

	return AllocateSingleVehicle(&counter);

   352

}

   353

   354

   355

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

   356

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

   357

 * @param num number of vehicles to allocate room for

   358

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

   359

 */

   360

bool AllocateVehicles(Vehicle **vl, int num)

   361

{

   362

	int i;

   363

	Vehicle *v;

   364

	VehicleID counter = 0;

   365

   366

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

   367

		v = AllocateSingleVehicle(&counter);

   368

		if (v == NULL) {

   369

			return false;

   370

		}

   371

		if (vl != NULL) {

   372

			vl[i] = v;

   373

		}

   374

	}

   375

   376

	return true;

   377

}

   378

   379

   380

static Vehicle *_vehicle_position_hash[0x1000];

   381

   382

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

   383

{

   384

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

   385

   386

	/* The hash area to scan */

   387

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

   388

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

   389

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

   390

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

   391

   392

	int x;

   393

	int y;

   394

   395

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

   396

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

   397

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

   398

   399

			while (v != NULL) {

   400

				void* a = proc(v, data);

   401

   402

				if (a != NULL) return a;

   403

				v = v->next_hash;

   404

			}

   405

   406

			if (x == xu) break;

   407

		}

   408

   409

		if (y == yu) break;

   410

	}

   411

	return NULL;

   412

}

   413

   414

   415

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

   416

{

   417

	Vehicle **old_hash, **new_hash;

   418

	int old_x = v->left_coord;

   419

	int old_y = v->top_coord;

   420

   421

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

   422

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

   423

   424

	if (old_hash == new_hash) return;

   425

   426

	/* remove from hash table? */

   427

	if (old_hash != NULL) {

   428

		Vehicle *last = NULL;

   429

		Vehicle *u = *old_hash;

   430

		while (u != v) {

   431

			last = u;

   432

			u = u->next_hash;

   433

			assert(u != NULL);

   434

		}

   435

   436

		if (last == NULL) {

   437

			*old_hash = v->next_hash;

   438

		} else {

   439

			last->next_hash = v->next_hash;

   440

		}

   441

	}

   442

   443

	/* insert into hash table? */

   444

	if (new_hash != NULL) {

   445

		v->next_hash = *new_hash;

   446

		*new_hash = v;

   447

	}

   448

}

   449

   450

void ResetVehiclePosHash()

   451

{

   452

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

   453

}

   454

   455

void InitializeVehicles()

   456

{

   457

	uint i;

   458

   459

	/* Clean the vehicle pool, and reserve enough blocks

   460

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

   461

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

   462

	CleanPool(&_Vehicle_pool);

   463

	AddBlockToPool(&_Vehicle_pool);

   464

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

   465

		AddBlockToPool(&_Vehicle_pool);

   466

	}

   467

   468

	ResetVehiclePosHash();

   469

}

   470

   471

Vehicle *GetLastVehicleInChain(Vehicle *v)

   472

{

   473

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

   474

	return v;

   475

}

   476

   477

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

   478

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

   479

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

   480

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

   481

 * called by anything but GetFirstVehicleInChain

   482

 */

   483

static Vehicle *GetPrevVehicleInChain_bruteforce(const Vehicle *v)

   484

{

   485

	Vehicle *u;

   486

   487

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

   488