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

enum {

    82

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

    83

};

    84

    85

/**

    86

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

    87

 */

    88

static void VehiclePoolNewBlock(uint start_item)

    89

{

    90

	Vehicle *v;

    91

    92

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

    93

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

    94

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

    95

		v->index = start_item++;

    96

		v = new (v) InvalidVehicle();

    97

	}

    98

}

    99

   100

/* Initialize the vehicle-pool */

   101

DEFINE_OLD_POOL(Vehicle, Vehicle, VehiclePoolNewBlock, NULL)

   102

   103

void VehicleServiceInDepot(Vehicle *v)

   104

{

   105

	v->date_of_last_service = _date;

   106

	v->breakdowns_since_last_service = 0;

   107

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

   108

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

   109

}

   110

   111

bool VehicleNeedsService(const Vehicle *v)

   112

{

   113

	if (v->vehstatus & VS_CRASHED)

   114

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

   115

   116

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

   117

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

   118

	}

   119

   120

	return _patches.servint_ispercent ?

   121

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

   122

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

   123

}

   124

   125

StringID VehicleInTheWayErrMsg(const Vehicle* v)

   126

{

   127

	switch (v->type) {

   128

		case VEH_TRAIN:    return STR_8803_TRAIN_IN_THE_WAY;

   129

		case VEH_ROAD:     return STR_9000_ROAD_VEHICLE_IN_THE_WAY;

   130

		case VEH_AIRCRAFT: return STR_A015_AIRCRAFT_IN_THE_WAY;

   131

		default:           return STR_980E_SHIP_IN_THE_WAY;

   132

	}

   133

}

   134

   135

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

   136

{

   137

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

   138

		return NULL;

   139

   140

	_error_message = VehicleInTheWayErrMsg(v);

   141

	return v;

   142

}

   143

   144

bool EnsureNoVehicle(TileIndex tile)

   145

{

   146

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

   147

}

   148

   149

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

   150

{

   151

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

   152

   153

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

   154

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

   155

   156

	_error_message = VehicleInTheWayErrMsg(v);

   157

	return v;

   158

}

   159

   160

   161

bool EnsureNoVehicleOnGround(TileIndex tile)

   162

{

   163

	TileInfo ti;

   164

   165

	ti.tile = tile;

   166

	ti.z = GetTileMaxZ(tile);

   167

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

   168

}

   169

   170

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z)

   171

{

   172

	TileInfo ti;

   173

   174

	ti.tile = tile;

   175

	ti.z = z;

   176

   177

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

   178

}

   179

   180

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

   181

{

   182

	int x1 = TileX(from);

   183

	int y1 = TileY(from);

   184

	int x2 = TileX(to);

   185

	int y2 = TileY(to);

   186

	Vehicle *veh;

   187

   188

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

   189

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

   190

		Swap(x1, x2);

   191

		Swap(y1, y2);

   192

	}

   193

	FOR_ALL_VEHICLES(veh) {

   194

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

   195

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

   196

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

   197

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

   198

				return veh;

   199

			}

   200

		}

   201

	}

   202

	return NULL;

   203

}

   204

   205

   206

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

   207

   208

void VehiclePositionChanged(Vehicle *v)

   209

{

   210

	int img = v->cur_image;

   211

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

   212

	const Sprite* spr = GetSprite(img);

   213

   214

	pt.x += spr->x_offs;

   215

	pt.y += spr->y_offs;

   216

   217

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

   218

   219

	v->left_coord = pt.x;

   220

	v->top_coord = pt.y;

   221

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

   222

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

   223

}

   224

   225

/** Called after load to update coordinates */

   226

void AfterLoadVehicles()

   227

{

   228

	Vehicle *v;

   229

   230

	FOR_ALL_VEHICLES(v) {

   231

		v->UpdateDeltaXY(v->direction);

   232

   233

		v->fill_percent_te_id = INVALID_TE_ID;

   234

		v->first = NULL;

   235

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

   236

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

   237

   238

		v->cargo.InvalidateCache();

   239

	}

   240

   241

	FOR_ALL_VEHICLES(v) {

   242

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

   243

			TrainConsistChanged(v);

   244

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

   245

			RoadVehUpdateCache(v);

   246

		}

   247

	}

   248

   249

	FOR_ALL_VEHICLES(v) {

   250

		switch (v->type) {

   251

			case VEH_ROAD:

   252

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

   253

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

   258

				break;

   259

   260

			case VEH_AIRCRAFT:

   261

				if (IsNormalAircraft(v)) {

   263

   264

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

   265

					Vehicle *shadow = v->next;

   266

					shadow->cur_image = v->cur_image;

   267

   268

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

   269

					if (v->subtype == AIR_HELICOPTER) {

   270

						Vehicle *rotor = shadow->next;

   271

						rotor->cur_image = GetRotorImage(v);

   272

					}

   273

   274

					UpdateAircraftCache(v);

   275

				}

   276

				break;

   277

			default: break;

   278

		}

   279

   280

		v->left_coord = INVALID_COORD;

   281

		VehiclePositionChanged(v);

   282

	}

   283

}

   284

   285

static Vehicle *InitializeVehicle(Vehicle *v)

   286

{

   287

	VehicleID index = v->index;

   288

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

   289

	v->index = index;

   290

   291

	assert(v->orders == NULL);

   292

   293

	v = new (v) InvalidVehicle();

   294

	v->left_coord = INVALID_COORD;

   295

	v->first = NULL;

   296

	v->next = NULL;

   297

	v->next_hash = NULL;

   298

	v->string_id = 0;

   299

	v->next_shared = NULL;

   300

	v->prev_shared = NULL;

   301

	v->depot_list  = NULL;

   302

	v->random_bits = 0;

   303

	v->group_id = DEFAULT_GROUP;

   304

	v->fill_percent_te_id = INVALID_TE_ID;

   305

   306

	return v;

   307

}

   308

   309

/**

   310

 * Get a value for a vehicle's random_bits.

   311

 * @return A random value from 0 to 255.

   312

 */

   313

byte VehicleRandomBits()

   314

{

   315

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

   316

}

   317

   318

Vehicle *ForceAllocateSpecialVehicle()

   319

{

   320

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

   321

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

   322

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

   323

	 * BLOCKS_FOR_SPECIAL_VEHICLES times block_size vehicles that may only

   324

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

   325

   326

	Vehicle *v;

   327

   328

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

   329

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

   330

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

   331

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

   332

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

   333

			return NULL;

   334

   335

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

   336

	}

   337

   338

	return NULL;

   339

}

   340

   341

/**

   342

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

   343

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

   344

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

   345

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

   346

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

   347

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

   348

 */

   349

static Vehicle *AllocateSingleVehicle(VehicleID *skip_vehicles)

   350

{

   351

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

   352

	 * first blocks */

   353

	Vehicle *v;

   354

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

   355

   356

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

   357

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

   358

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

   359

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

   360

			(*skip_vehicles)++;

   361

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

   362

		}

   363

	}

   364

   365

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

   366

	if (AddBlockToPool(&_Vehicle_pool))

   367

		return AllocateSingleVehicle(skip_vehicles);

   368

   369

	return NULL;

   370

}

   371

   372

   373

Vehicle *AllocateVehicle()

   374

{

   375

	VehicleID counter = 0;

   376

	return AllocateSingleVehicle(&counter);

   377

}

   378

   379

   380

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

   381

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

   382

 * @param num number of vehicles to allocate room for

   383

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

   384

 */

   385

bool AllocateVehicles(Vehicle **vl, int num)

   386

{

   387

	int i;

   388

	Vehicle *v;

   389

	VehicleID counter = 0;

   390

   391

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

   392

		v = AllocateSingleVehicle(&counter);

   393

		if (v == NULL) {

   394

			return false;

   395

		}

   396

		if (vl != NULL) {

   397

			vl[i] = v;

   398

		}

   399

	}

   400

   401

	return true;

   402

}

   403

   404

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

   405

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

   406

const int HASH_BITS = 7;

   407

const int HASH_SIZE = 1 << HASH_BITS;

   408

const int HASH_MASK = HASH_SIZE - 1;

   409

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

   410

const int TOTAL_HASH_MASK = TOTAL_HASH_SIZE - 1;

   411

   412

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

   413

 * Profiling results show that 0 is fastest. */

   414

const int HASH_RES = 0;

   415

   416

static Vehicle *_new_vehicle_position_hash[TOTAL_HASH_SIZE];

   417

   418

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

   419

{

   420

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

   421

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

   422

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

   423

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

   424

				void *a = proc(v, data);

   425

				if (a != NULL) return a;

   426

			}

   427

			if (x == xu) break;

   428

		}

   429

		if (y == yu) break;

   430

	}

   431

   432

	return NULL;

   433

}

   434

   435

   436

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

   437

{

   438

	const int COLL_DIST = 6;

   439

   440

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

   441

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

   442

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

   443

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

   444

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

   445

   446

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

   447

}

   448

   449

   450

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

   451

{

   452

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

   453

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

   454

   455

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

   456

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

   457

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

   458

   459

		void *a = proc(v, data);

   460

		if (a != NULL) return a;

   461

	}

   462

   463

	return NULL;

   464

}

   465

   466

static void UpdateNewVehiclePosHash(Vehicle *v, bool remove)

   467

{

   468

	Vehicle **old_hash = v->old_new_hash;

   469

	Vehicle **new_hash;

   470

   471

	if (remove) {

   472

		new_hash = NULL;

   473

	} else {

   474

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

   475

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

   476

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

   477

	}

   478

   479

	if (old_hash == new_hash) return;

   480

   481

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

   482

	if (old_hash != NULL) {

   483

		Vehicle *last = NULL;

   484

		Vehicle *u = *old_hash;

   485

		while (u != v) {

   486

			last = u;

   487

			u = u->next_new_hash;