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

#include "group.h"

    44

#include "economy.h"

    45

    46

#define INVALID_COORD (-0x8000)

    47

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

    48

    49

    50

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

    51

const uint32 _veh_build_proc_table[] = {

    52

	CMD_BUILD_RAIL_VEHICLE,

    53

	CMD_BUILD_ROAD_VEH,

    54

	CMD_BUILD_SHIP,

    55

	CMD_BUILD_AIRCRAFT,

    56

};

    57

const uint32 _veh_sell_proc_table[] = {

    58

	CMD_SELL_RAIL_WAGON,

    59

	CMD_SELL_ROAD_VEH,

    60

	CMD_SELL_SHIP,

    61

	CMD_SELL_AIRCRAFT,

    62

};

    63

    64

const uint32 _veh_refit_proc_table[] = {

    65

	CMD_REFIT_RAIL_VEHICLE,

    66

	CMD_REFIT_ROAD_VEH,

    67

	CMD_REFIT_SHIP,

    68

	CMD_REFIT_AIRCRAFT,

    69

};

    70

    71

const uint32 _send_to_depot_proc_table[] = {

    72

	CMD_SEND_TRAIN_TO_DEPOT,

    73

	CMD_SEND_ROADVEH_TO_DEPOT,

    74

	CMD_SEND_SHIP_TO_DEPOT,

    75

	CMD_SEND_AIRCRAFT_TO_HANGAR,

    76

};

    77

    78

    79

enum {

    80

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

    81

};

    82

    83

/**

    84

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

    85

 */

    86

static void VehiclePoolNewBlock(uint start_item)

    87

{

    88

	Vehicle *v;

    89

    90

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

    91

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

    92

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

    93

		v->index = start_item++;

    94

		v = new (v) InvalidVehicle();

    95

	}

    96

}

    97

    98

/* Initialize the vehicle-pool */

    99

DEFINE_OLD_POOL(Vehicle, Vehicle, VehiclePoolNewBlock, NULL)

   100

   101

void VehicleServiceInDepot(Vehicle *v)

   102

{

   103

	v->date_of_last_service = _date;

   104

	v->breakdowns_since_last_service = 0;

   105

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

   106

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

   107

}

   108

   109

bool VehicleNeedsService(const Vehicle *v)

   110

{

   111

	if (v->vehstatus & VS_CRASHED)

   112

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

   113

   114

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

   115

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

   116

	}

   117

   118

	return _patches.servint_ispercent ?

   119

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

   120

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

   121

}

   122

   123

StringID VehicleInTheWayErrMsg(const Vehicle* v)

   124

{

   125

	switch (v->type) {

   126

		case VEH_TRAIN:    return STR_8803_TRAIN_IN_THE_WAY;

   127

		case VEH_ROAD:     return STR_9000_ROAD_VEHICLE_IN_THE_WAY;

   128

		case VEH_AIRCRAFT: return STR_A015_AIRCRAFT_IN_THE_WAY;

   129

		default:           return STR_980E_SHIP_IN_THE_WAY;

   130

	}

   131

}

   132

   133

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

   134

{

   135

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

   136

		return NULL;

   137

   138

	_error_message = VehicleInTheWayErrMsg(v);

   139

	return v;

   140

}

   141

   142

bool EnsureNoVehicle(TileIndex tile)

   143

{

   144

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

   145

}

   146

   147

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

   148

{

   149

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

   150

   151

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

   152

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

   153

   154

	_error_message = VehicleInTheWayErrMsg(v);

   155

	return v;

   156

}

   157

   158

   159

bool EnsureNoVehicleOnGround(TileIndex tile)

   160

{

   161

	TileInfo ti;

   162

   163

	ti.tile = tile;

   164

	ti.z = GetTileMaxZ(tile);

   165

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

   166

}

   167

   168

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z)

   169

{

   170

	TileInfo ti;

   171

   172

	ti.tile = tile;

   173

	ti.z = z;

   174

   175

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

   176

}

   177

   178

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

   179

{

   180

	int x1 = TileX(from);

   181

	int y1 = TileY(from);

   182

	int x2 = TileX(to);

   183

	int y2 = TileY(to);

   184

	Vehicle *veh;

   185

   186

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

   187

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

   188

		Swap(x1, x2);

   189

		Swap(y1, y2);

   190

	}

   191

	FOR_ALL_VEHICLES(veh) {

   192

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

   193

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

   194

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

   195

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

   196

				return veh;

   197

			}

   198

		}

   199

	}

   200

	return NULL;

   201

}

   202

   203

   204

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

   205

   206

void VehiclePositionChanged(Vehicle *v)

   207

{

   208

	int img = v->cur_image;

   209

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

   210

	const Sprite* spr = GetSprite(img);

   211

   212

	pt.x += spr->x_offs;

   213

	pt.y += spr->y_offs;

   214

   215

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

   216

   217

	v->left_coord = pt.x;

   218

	v->top_coord = pt.y;

   219

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

   220

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

   221

}

   222

   223

/** Called after load to update coordinates */

   224

void AfterLoadVehicles()

   225

{

   226

	Vehicle *v;

   227

   228

	FOR_ALL_VEHICLES(v) {

   229

		v->UpdateDeltaXY(v->direction);

   230

   231

		v->first = NULL;

   232

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

   233

	}

   234

   235

	FOR_ALL_VEHICLES(v) {

   236

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

   237

			TrainConsistChanged(v);

   238

	}

   239

   240

	FOR_ALL_VEHICLES(v) {

   241

		switch (v->type) {

   242

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

   243

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

   244

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

   245

			case VEH_AIRCRAFT:

   246

				if (IsNormalAircraft(v)) {

   247

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

   248

   249

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

   250

					Vehicle *shadow = v->next;

   251

					shadow->cur_image = v->cur_image;

   252

   253

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

   254

					if (v->subtype == AIR_HELICOPTER) {

   255

						Vehicle *rotor = shadow->next;

   256

						rotor->cur_image = GetRotorImage(v);

   257

					}

   258

   259

					UpdateAircraftCache(v);

   260

				}

   261

				break;

   262

			default: break;

   263

		}

   264

   265

		v->left_coord = INVALID_COORD;

   266

		VehiclePositionChanged(v);

   267

	}

   268

}

   269

   270

static Vehicle *InitializeVehicle(Vehicle *v)

   271

{

   272

	VehicleID index = v->index;

   273

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

   274

	v->index = index;

   275

   276

	assert(v->orders == NULL);

   277

   278

	v = new (v) InvalidVehicle();

   279

	v->left_coord = INVALID_COORD;

   280

	v->first = NULL;

   281

	v->next = NULL;

   282

	v->next_hash = NULL;

   283

	v->string_id = 0;

   284

	v->next_shared = NULL;

   285

	v->prev_shared = NULL;

   286

	v->depot_list  = NULL;

   287

	v->random_bits = 0;

   288

	v->group_id = DEFAULT_GROUP;

   289

   290

	return v;

   291

}

   292

   293

/**

   294

 * Get a value for a vehicle's random_bits.

   295

 * @return A random value from 0 to 255.

   296

 */

   297

byte VehicleRandomBits()

   298

{

   299

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

   300

}

   301

   302

Vehicle *ForceAllocateSpecialVehicle()

   303

{

   304

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

   305

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

   306

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

   307

	 * BLOCKS_FOR_SPECIAL_VEHICLES times block_size vehicles that may only

   308

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

   309

   310

	Vehicle *v;

   311

   312

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

   313

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

   314

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

   315

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

   316

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

   317

			return NULL;

   318

   319

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

   320

	}

   321

   322

	return NULL;

   323

}

   324

   325

/**

   326

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

   327

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

   328

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

   329

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

   330

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

   331

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

   332

 */

   333

static Vehicle *AllocateSingleVehicle(VehicleID *skip_vehicles)

   334

{

   335

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

   336

	 * first blocks */

   337

	Vehicle *v;

   338

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

   339

   340

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

   341

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

   342

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

   343

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

   344

			(*skip_vehicles)++;

   345

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

   346

		}

   347

	}

   348

   349

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

   350

	if (AddBlockToPool(&_Vehicle_pool))

   351

		return AllocateSingleVehicle(skip_vehicles);

   352

   353

	return NULL;

   354

}

   355

   356

   357

Vehicle *AllocateVehicle()

   358

{

   359

	VehicleID counter = 0;

   360

	return AllocateSingleVehicle(&counter);

   361

}

   362

   363

   364

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

   365

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

   366

 * @param num number of vehicles to allocate room for

   367

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

   368

 */

   369

bool AllocateVehicles(Vehicle **vl, int num)

   370

{

   371

	int i;

   372

	Vehicle *v;

   373

	VehicleID counter = 0;

   374

   375

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

   376

		v = AllocateSingleVehicle(&counter);

   377

		if (v == NULL) {

   378

			return false;

   379

		}

   380

		if (vl != NULL) {

   381

			vl[i] = v;

   382

		}

   383

	}

   384

   385

	return true;

   386

}

   387

   388

   389

static Vehicle *_vehicle_position_hash[0x1000];

   390

   391

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

   392

{

   393

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

   394

   395

	/* The hash area to scan */

   396

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

   397

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

   398

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

   399

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

   400

   401

	int x;

   402

	int y;

   403

   404

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

   405

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

   406

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

   407

   408

			while (v != NULL) {

   409

				void* a = proc(v, data);

   410

   411

				if (a != NULL) return a;

   412

				v = v->next_hash;

   413

			}

   414

   415

			if (x == xu) break;

   416

		}

   417

   418

		if (y == yu) break;

   419

	}

   420

	return NULL;

   421

}

   422

   423

   424

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

   425

{

   426

	Vehicle **old_hash, **new_hash;

   427

	int old_x = v->left_coord;

   428

	int old_y = v->top_coord;

   429

   430

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

   431

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

   432

   433

	if (old_hash == new_hash) return;

   434

   435

	/* remove from hash table? */

   436

	if (old_hash != NULL) {

   437

		Vehicle *last = NULL;

   438

		Vehicle *u = *old_hash;

   439

		while (u != v) {

   440

			last = u;

   441

			u = u->next_hash;

   442

			assert(u != NULL);

   443

		}

   444

   445

		if (last == NULL) {

   446

			*old_hash = v->next_hash;

   447

		} else {

   448

			last->next_hash = v->next_hash;

   449

		}

   450

	}

   451

   452

	/* insert into hash table? */

   453

	if (new_hash != NULL) {

   454

		v->next_hash = *new_hash;

   455

		*new_hash = v;

   456

	}

   457

}

   458

   459

void ResetVehiclePosHash()

   460

{

   461

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

   462

}

   463

   464

void InitializeVehicles()

   465

{

   466

	uint i;

   467

   468

	/* Clean the vehicle pool, and reserve enough blocks

   469

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

   470

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

   471

	CleanPool(&_Vehicle_pool);

   472

	AddBlockToPool(&_Vehicle_pool);

   473

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

   474

		AddBlockToPool(&_Vehicle_pool);

   475

	}

   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

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

   487

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

   488

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