1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "road_map.h"

     6

#include "roadveh.h"

     7

#include "ship.h"

     8

#include "spritecache.h"

     9

#include "table/sprites.h"

    10

#include "table/strings.h"

    11

#include "functions.h"

    12

#include "map.h"

    13

#include "tile.h"

    14

#include "vehicle.h"

    15

#include "gfx.h"

    16

#include "viewport.h"

    17

#include "news.h"

    18

#include "command.h"

    19

#include "saveload.h"

    20

#include "player.h"

    21

#include "engine.h"

    22

#include "sound.h"

    23

#include "debug.h"

    24

#include "vehicle_gui.h"

    25

#include "depot.h"

    26

#include "station.h"

    27

#include "rail.h"

    28

#include "train.h"

    29

#include "aircraft.h"

    30

#include "industry_map.h"

    31

#include "station_map.h"

    32

#include "water_map.h"

    33

#include "network/network.h"

    34

#include "yapf/yapf.h"

    35

#include "date.h"

    36

#include "newgrf_callbacks.h"

    37

#include "newgrf_engine.h"

    38

#include "newgrf_sound.h"

    39

#include "helpers.hpp"

    40

    41

#define INVALID_COORD (-0x8000)

    42

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

    43

    44

    45

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

    46

const uint32 _veh_build_proc_table[] = {

    47

	CMD_BUILD_RAIL_VEHICLE,

    48

	CMD_BUILD_ROAD_VEH,

    49

	CMD_BUILD_SHIP,

    50

	CMD_BUILD_AIRCRAFT,

    51

};

    52

const uint32 _veh_sell_proc_table[] = {

    53

	CMD_SELL_RAIL_WAGON,

    54

	CMD_SELL_ROAD_VEH,

    55

	CMD_SELL_SHIP,

    56

	CMD_SELL_AIRCRAFT,

    57

};

    58

    59

const uint32 _veh_refit_proc_table[] = {

    60

	CMD_REFIT_RAIL_VEHICLE,

    61

	CMD_REFIT_ROAD_VEH,

    62

	CMD_REFIT_SHIP,

    63

	CMD_REFIT_AIRCRAFT,

    64

};

    65

    66

const uint32 _send_to_depot_proc_table[] = {

    67

	CMD_SEND_TRAIN_TO_DEPOT,

    68

	CMD_SEND_ROADVEH_TO_DEPOT,

    69

	CMD_SEND_SHIP_TO_DEPOT,

    70

	CMD_SEND_AIRCRAFT_TO_HANGAR,

    71

};

    72

    73

    74

enum {

    75

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

    76

};

    77

    78

/**

    79

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

    80

 */

    81

static void VehiclePoolNewBlock(uint start_item)

    82

{

    83

	Vehicle *v;

    84

    85

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

    86

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

    87

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

    88

		v->index = start_item++;

    89

		v->type  = VEH_INVALID;

    90

	}

    91

}

    92

    93

/* Initialize the vehicle-pool */

    94

DEFINE_OLD_POOL(Vehicle, Vehicle, VehiclePoolNewBlock, NULL)

    95

    96

void VehicleServiceInDepot(Vehicle *v)

    97

{

    98

	v->date_of_last_service = _date;

    99

	v->breakdowns_since_last_service = 0;

   100

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

   101

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

   102

}

   103

   104

bool VehicleNeedsService(const Vehicle *v)

   105

{

   106

	if (v->vehstatus & VS_CRASHED)

   107

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

   108

   109

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

   110

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

   111

	}

   112

   113

	return _patches.servint_ispercent ?

   114

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

   115

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

   116

}

   117

   118

StringID VehicleInTheWayErrMsg(const Vehicle* v)

   119

{

   120

	switch (v->type) {

   121

		case VEH_TRAIN:    return STR_8803_TRAIN_IN_THE_WAY;

   122

		case VEH_ROAD:     return STR_9000_ROAD_VEHICLE_IN_THE_WAY;

   123

		case VEH_AIRCRAFT: return STR_A015_AIRCRAFT_IN_THE_WAY;

   124

		default:           return STR_980E_SHIP_IN_THE_WAY;

   125

	}

   126

}

   127

   128

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

   129

{

   130

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

   131

		return NULL;

   132

   133

	_error_message = VehicleInTheWayErrMsg(v);

   134

	return v;

   135

}

   136

   137

bool EnsureNoVehicle(TileIndex tile)

   138

{

   139

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

   140

}

   141

   142

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

   143

{

   144

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

   145

   146

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

   147

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

   148

   149

	_error_message = VehicleInTheWayErrMsg(v);

   150

	return v;

   151

}

   152

   153

   154

bool EnsureNoVehicleOnGround(TileIndex tile)

   155

{

   156

	TileInfo ti;

   157

   158

	ti.tile = tile;

   159

	ti.z = GetTileMaxZ(tile);

   160

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

   161

}

   162

   163

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z)

   164

{

   165

	TileInfo ti;

   166

   167

	ti.tile = tile;

   168

	ti.z = z;

   169

   170

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

   171

}

   172

   173

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

   174

{

   175

	int x1 = TileX(from);

   176

	int y1 = TileY(from);

   177

	int x2 = TileX(to);

   178

	int y2 = TileY(to);

   179

	Vehicle *veh;

   180

   181

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

   182

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

   183

		Swap(x1, x2);

   184

		Swap(y1, y2);

   185

	}

   186

	FOR_ALL_VEHICLES(veh) {

   187

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

   188

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

   189

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

   190

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

   191

				return veh;

   192

			}

   193

		}

   194

	}

   195

	return NULL;

   196

}

   197

   198

   199

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

   200

   201

void VehiclePositionChanged(Vehicle *v)

   202

{

   203

	int img = v->cur_image;

   204

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

   205

	const Sprite* spr = GetSprite(img);

   206

   207

	pt.x += spr->x_offs;

   208

	pt.y += spr->y_offs;

   209

   210

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

   211

   212

	v->left_coord = pt.x;

   213

	v->top_coord = pt.y;

   214

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

   215

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

   216

}

   217

   218

// Called after load to update coordinates

   219

void AfterLoadVehicles()

   220

{

   221

	Vehicle *v;

   222

   223

	FOR_ALL_VEHICLES(v) {

   224

		v->first = NULL;

   225

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

   226

	}

   227

   228

	FOR_ALL_VEHICLES(v) {

   229

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

   230

			TrainConsistChanged(v);

   231

	}

   232

   233

	FOR_ALL_VEHICLES(v) {

   234

		switch (v->type) {

   235

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

   236

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

   237

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

   238

			case VEH_AIRCRAFT:

   239

				if (IsNormalAircraft(v)) {

   240

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

   241

   242

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

   243

					Vehicle *shadow = v->next;

   244

					shadow->cur_image = v->cur_image;

   245

   246

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

   247

					if (v->subtype == AIR_HELICOPTER) {

   248

						Vehicle *rotor = shadow->next;

   249

						rotor->cur_image = GetRotorImage(v);

   250

					}

   251

				}

   252

				break;

   253

			default: break;

   254

		}

   255

   256

		v->left_coord = INVALID_COORD;

   257

		VehiclePositionChanged(v);

   258

	}

   259

}

   260

   261

static Vehicle *InitializeVehicle(Vehicle *v)

   262

{

   263

	VehicleID index = v->index;

   264

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

   265

	v->index = index;

   266

   267

	assert(v->orders == NULL);

   268

   269

	v->type = VEH_INVALID;

   270

	v->left_coord = INVALID_COORD;

   271

	v->first = NULL;

   272

	v->next = NULL;

   273

	v->next_hash = NULL;

   274

	v->string_id = 0;

   275

	v->next_shared = NULL;

   276

	v->prev_shared = NULL;

   277

	v->depot_list  = NULL;

   278

	v->random_bits = 0;

   279

	return v;

   280

}

   281

   282

/**

   283

 * Get a value for a vehicle's random_bits.

   284

 * @return A random value from 0 to 255.

   285

 */

   286

byte VehicleRandomBits()

   287

{

   288

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

   289

}

   290

   291

Vehicle *ForceAllocateSpecialVehicle()

   292

{

   293

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

   294

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

   295

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

   296

	 * BLOCKS_FOR_SPECIAL_VEHICLES times block_size vehicles that may only

   297

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

   298

   299

	Vehicle *v;

   300

   301

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

   302

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

   303

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

   304

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

   305

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

   306

			return NULL;

   307

   308

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

   309

	}

   310

   311

	return NULL;

   312

}

   313

   314

/*

   315

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

   316

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

   317

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

   318

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

   319

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

   320

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

   321

 */

   322

static Vehicle *AllocateSingleVehicle(VehicleID *skip_vehicles)

   323

{

   324

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

   325

	 * first blocks */

   326

	Vehicle *v;

   327

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

   328

   329

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

   330

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

   331

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

   332

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

   333

			(*skip_vehicles)++;

   334

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

   335

		}

   336

	}

   337

   338

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

   339

	if (AddBlockToPool(&_Vehicle_pool))

   340

		return AllocateSingleVehicle(skip_vehicles);

   341

   342

	return NULL;

   343

}

   344

   345

   346

Vehicle *AllocateVehicle()

   347

{

   348

	VehicleID counter = 0;

   349

	return AllocateSingleVehicle(&counter);

   350

}

   351

   352

   353

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

   354

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

   355

 * @param num number of vehicles to allocate room for

   356

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

   357

 */

   358

bool AllocateVehicles(Vehicle **vl, int num)

   359

{

   360

	int i;

   361

	Vehicle *v;

   362

	VehicleID counter = 0;

   363

   364

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

   365

		v = AllocateSingleVehicle(&counter);

   366

		if (v == NULL) {

   367

			return false;

   368

		}

   369

		if (vl != NULL) {

   370

			vl[i] = v;

   371

		}

   372

	}

   373

   374

	return true;

   375

}

   376

   377

   378

static Vehicle *_vehicle_position_hash[0x1000];

   379

   380

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

   381

{

   382

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

   383

   384

	// The hash area to scan

   385

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

   386

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

   387

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

   388

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

   389

   390

	int x;

   391

	int y;

   392

   393

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

   394

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

   395

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

   396

   397

			while (v != NULL) {

   398

				void* a = proc(v, data);

   399

   400

				if (a != NULL) return a;

   401

				v = v->next_hash;

   402

			}

   403

   404

			if (x == xu) break;

   405

		}

   406

   407

		if (y == yu) break;

   408

	}

   409

	return NULL;

   410

}

   411

   412

   413

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

   414

{

   415

	Vehicle **old_hash, **new_hash;

   416

	int old_x = v->left_coord;

   417

	int old_y = v->top_coord;

   418

   419

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

   420

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

   421

   422

	if (old_hash == new_hash) return;

   423

   424

	/* remove from hash table? */

   425

	if (old_hash != NULL) {

   426

		Vehicle *last = NULL;

   427

		Vehicle *u = *old_hash;

   428

		while (u != v) {

   429

			last = u;

   430

			u = u->next_hash;

   431

			assert(u != NULL);

   432

		}

   433

   434

		if (last == NULL) {

   435

			*old_hash = v->next_hash;

   436

		} else {

   437

			last->next_hash = v->next_hash;

   438

		}

   439

	}

   440

   441

	/* insert into hash table? */

   442

	if (new_hash != NULL) {

   443

		v->next_hash = *new_hash;

   444

		*new_hash = v;

   445

	}

   446

}

   447

   448

void ResetVehiclePosHash()

   449

{

   450

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

   451

}

   452

   453

void InitializeVehicles()

   454

{

   455

	uint i;

   456

   457

	/* Clean the vehicle pool, and reserve enough blocks

   458

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

   459

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

   460

	CleanPool(&_Vehicle_pool);

   461

	AddBlockToPool(&_Vehicle_pool);

   462

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

   463

		AddBlockToPool(&_Vehicle_pool);

   464

	}

   465

   466

	ResetVehiclePosHash();

   467

}

   468

   469

Vehicle *GetLastVehicleInChain(Vehicle *v)

   470

{

   471

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

   472

	return v;

   473

}

   474

   475

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

   476

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

   477

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

   478

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

   479

 * called by anything but GetFirstVehicleInChain

   480

 */

   481

static Vehicle *GetPrevVehicleInChain_bruteforce(const Vehicle *v)

   482

{

   483

	Vehicle *u;

   484

   485

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

   486

   487

	return NULL;

   488

}

   489