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) v->index = start_item++;

    88

}

    89

    90

/* Initialize the vehicle-pool */

    91

DEFINE_OLD_POOL(Vehicle, Vehicle, VehiclePoolNewBlock, NULL)

    92

    93

void VehicleServiceInDepot(Vehicle *v)

    94

{

    95

	v->date_of_last_service = _date;

    96

	v->breakdowns_since_last_service = 0;

    97

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

    98

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

    99

}

   100

   101

bool VehicleNeedsService(const Vehicle *v)

   102

{

   103

	if (v->vehstatus & VS_CRASHED)

   104

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

   105

   106

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

   107

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

   108

	}

   109

   110

	return _patches.servint_ispercent ?

   111

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

   112

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

   113

}

   114

   115

StringID VehicleInTheWayErrMsg(const Vehicle* v)

   116

{

   117

	switch (v->type) {

   118

		case VEH_Train:    return STR_8803_TRAIN_IN_THE_WAY;

   119

		case VEH_Road:     return STR_9000_ROAD_VEHICLE_IN_THE_WAY;

   120

		case VEH_Aircraft: return STR_A015_AIRCRAFT_IN_THE_WAY;

   121

		default:           return STR_980E_SHIP_IN_THE_WAY;

   122

	}

   123

}

   124

   125

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

   126

{

   127

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

   128

		return NULL;

   129

   130

	_error_message = VehicleInTheWayErrMsg(v);

   131

	return v;

   132

}

   133

   134

bool EnsureNoVehicle(TileIndex tile)

   135

{

   136

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

   137

}

   138

   139

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

   140

{

   141

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

   142

   143

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

   144

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

   145

   146

	_error_message = VehicleInTheWayErrMsg(v);

   147

	return v;

   148

}

   149

   150

   151

bool EnsureNoVehicleOnGround(TileIndex tile)

   152

{

   153

	TileInfo ti;

   154

   155

	ti.tile = tile;

   156

	ti.z = GetTileMaxZ(tile);

   157

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

   158

}

   159

   160

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z)

   161

{

   162

	TileInfo ti;

   163

   164

	ti.tile = tile;

   165

	ti.z = z;

   166

   167

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

   168

}

   169

   170

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

   171

{

   172

	int x1 = TileX(from);

   173

	int y1 = TileY(from);

   174

	int x2 = TileX(to);

   175

	int y2 = TileY(to);

   176

	Vehicle *veh;

   177

   178

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

   179

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

   180

		intswap(x1,x2);

   181

		intswap(y1,y2);

   182

	}

   183

	FOR_ALL_VEHICLES(veh) {

   184

		if ((veh->type == VEH_Train || veh->type == VEH_Road) && (z==0xFF || veh->z_pos == z)) {

   185

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

   186

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

   187

				return veh;

   188

			}

   189

		}

   190

	}

   191

	return NULL;

   192

}

   193

   194

   195

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

   196

   197

void VehiclePositionChanged(Vehicle *v)

   198

{

   199

	int img = v->cur_image;

   200

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

   201

	const Sprite* spr = GetSprite(img);

   202

   203

	pt.x += spr->x_offs;

   204

	pt.y += spr->y_offs;

   205

   206

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

   207

   208

	v->left_coord = pt.x;

   209

	v->top_coord = pt.y;

   210

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

   211

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

   212

}

   213

   214

// Called after load to update coordinates

   215

void AfterLoadVehicles(void)

   216

{

   217

	Vehicle *v;

   218

   219

	FOR_ALL_VEHICLES(v) {

   220

		v->first = NULL;

   221

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

   222

	}

   223

   224

	FOR_ALL_VEHICLES(v) {

   225

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

   226

			TrainConsistChanged(v);

   227

	}

   228

   229

	FOR_ALL_VEHICLES(v) {

   230

		switch (v->type) {

   231

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

   232

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

   233

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

   234

			case VEH_Aircraft:

   235

				if (v->subtype == 0 || v->subtype == 2) {

   236

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

   237

					if (v->next != NULL) v->next->cur_image = v->cur_image;

   238

				}

   239

				break;

   240

			default: break;

   241

		}

   242

   243

		v->left_coord = INVALID_COORD;

   244

		VehiclePositionChanged(v);

   245

	}

   246

}

   247

   248

static Vehicle *InitializeVehicle(Vehicle *v)

   249

{

   250

	VehicleID index = v->index;

   251

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

   252

	v->index = index;

   253

   254

	assert(v->orders == NULL);

   255

   256

	v->left_coord = INVALID_COORD;

   257

	v->first = NULL;

   258

	v->next = NULL;

   259

	v->next_hash = NULL;

   260

	v->string_id = 0;

   261

	v->next_shared = NULL;

   262

	v->prev_shared = NULL;

   263

	v->depot_list  = NULL;

   264

	v->random_bits = 0;

   265

	return v;

   266

}

   267

   268

/**

   269

 * Get a value for a vehicle's random_bits.

   270

 * @return A random value from 0 to 255.

   271

 */

   272

byte VehicleRandomBits(void)

   273

{

   274

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

   275

}

   276

   277

Vehicle *ForceAllocateSpecialVehicle(void)

   278

{

   279

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

   280

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

   281

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

   282

	 * BLOCKS_FOR_SPECIAL_VEHICLES times block_size vehicles that may only

   283

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

   284

   285

	Vehicle *v;

   286

   287

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

   288

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

   289

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

   290

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

   291

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

   292

			return NULL;

   293

   294

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

   295

	}

   296

   297

	return NULL;

   298

}

   299

   300

/*

   301

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

   302

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

   303

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

   304

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

   305

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

   306

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

   307

 */

   308

static Vehicle *AllocateSingleVehicle(VehicleID *skip_vehicles)

   309

{

   310

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

   311

	 * first blocks */

   312

	Vehicle *v;

   313

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

   314

   315

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

   316

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

   317

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

   318

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

   319

			(*skip_vehicles)++;

   320

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

   321

		}

   322

	}

   323

   324

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

   325

	if (AddBlockToPool(&_Vehicle_pool))

   326

		return AllocateSingleVehicle(skip_vehicles);

   327

   328

	return NULL;

   329

}

   330

   331

   332

Vehicle *AllocateVehicle(void)

   333

{

   334

	VehicleID counter = 0;

   335

	return AllocateSingleVehicle(&counter);

   336

}

   337

   338

   339

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

   340

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

   341

 * @param num number of vehicles to allocate room for

   342

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

   343

 */

   344

bool AllocateVehicles(Vehicle **vl, int num)

   345

{

   346

	int i;

   347

	Vehicle *v;

   348

	VehicleID counter = 0;

   349

   350

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

   351

		v = AllocateSingleVehicle(&counter);

   352

		if (v == NULL) {

   353

			return false;

   354

		}

   355

		if (vl != NULL) {

   356

			vl[i] = v;

   357

		}

   358

	}

   359

   360

	return true;

   361

}

   362

   363

   364

static Vehicle *_vehicle_position_hash[0x1000];

   365

   366

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

   367

{

   368

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

   369

   370

	// The hash area to scan

   371

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

   372

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

   373

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

   374

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

   375

   376

	int x;

   377

	int y;

   378

   379

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

   380

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

   381

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

   382

   383

			while (v != NULL) {

   384

				void* a = proc(v, data);

   385

   386

				if (a != NULL) return a;

   387

				v = v->next_hash;

   388

			}

   389

   390

			if (x == xu) break;

   391

		}

   392

   393

		if (y == yu) break;

   394

	}

   395

	return NULL;

   396

}

   397

   398

   399

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

   400

{

   401

	Vehicle **old_hash, **new_hash;

   402

	int old_x = v->left_coord;

   403

	int old_y = v->top_coord;

   404

   405

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

   406

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

   407

   408

	if (old_hash == new_hash) return;

   409

   410

	/* remove from hash table? */

   411

	if (old_hash != NULL) {

   412

		Vehicle *last = NULL;

   413

		Vehicle *u = *old_hash;

   414

		while (u != v) {

   415

			last = u;

   416

			u = u->next_hash;

   417

			assert(u != NULL);

   418

		}

   419

   420

		if (last == NULL) {

   421

			*old_hash = v->next_hash;

   422

		} else {

   423

			last->next_hash = v->next_hash;

   424

		}

   425

	}

   426

   427

	/* insert into hash table? */

   428

	if (new_hash != NULL) {

   429

		v->next_hash = *new_hash;

   430

		*new_hash = v;

   431

	}

   432

}

   433

   434

void ResetVehiclePosHash(void)

   435

{

   436

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

   437

}

   438

   439

void InitializeVehicles(void)

   440

{

   441

	uint i;

   442

   443

	/* Clean the vehicle pool, and reserve enough blocks

   444

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

   445

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

   446

	CleanPool(&_Vehicle_pool);

   447

	AddBlockToPool(&_Vehicle_pool);

   448

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

   449

		AddBlockToPool(&_Vehicle_pool);

   450

	}

   451

   452

	ResetVehiclePosHash();

   453

}

   454

   455

Vehicle *GetLastVehicleInChain(Vehicle *v)

   456

{

   457

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

   458

	return v;

   459

}

   460

   461

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

   462

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

   463

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

   464

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

   465

 * called by anything but GetFirstVehicleInChain

   466

 */

   467

static Vehicle *GetPrevVehicleInChain_bruteforce(const Vehicle *v)

   468

{

   469

	Vehicle *u;

   470

   471

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

   472

   473

	return NULL;

   474

}

   475

   476

/** Find the previous vehicle in a chain, by using the v->first cache.

   477

 * While this function is fast, it cannot be used in the GetFirstVehicleInChain

   478

 * function, otherwise you'll end up in an infinite loop call

   479

 */

   480

Vehicle *GetPrevVehicleInChain(const Vehicle *v)

   481

{

   482

	Vehicle *u;

   483

	assert(v != NULL);

   484

   485

	u = GetFirstVehicleInChain(v);

   486

   487

	// Check to see if this is the first

   488

	if (v == u) return NULL;

   489

   490

	for (; u->next != v; u = u->next) assert(u->next != NULL);