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

    34

#include "yapf/yapf.h"

    35

#include "date.h"

    36

#include "newgrf_engine.h"

    37

#include "newgrf_sound.h"

    38

    39

#define INVALID_COORD (-0x8000)

    40

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

    41

    42

/*

    43

 * These command macros are used to call vehicle type specific commands with non type specific commands

    44

 * it should be used like: DoCommandP(x, y, p1, p2, flags, CMD_STARTSTOP_VEH(v->type))

    45

 * that line will start/stop a vehicle nomatter what type it is

    46

 * VEH_Train is used as an offset because the vehicle type values doesn't start with 0

    47

 */

    48

    49

#define CMD_BUILD_VEH(x) _veh_build_proc_table[ x - VEH_Train]

    50

#define CMD_SELL_VEH(x)  _veh_sell_proc_table [ x - VEH_Train]

    51

#define CMD_REFIT_VEH(x) _veh_refit_proc_table[ x - VEH_Train]

    52

    53

static 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

static 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

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

    95

}

    96

    97

/* Initialize the vehicle-pool */

    98

DEFINE_POOL(Vehicle, Vehicle, VehiclePoolNewBlock, NULL)

    99

   100

void VehicleServiceInDepot(Vehicle *v)

   101

{

   102

	v->date_of_last_service = _date;

   103

	v->breakdowns_since_last_service = 0;

   104

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

   105

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

   106

}

   107

   108

bool VehicleNeedsService(const Vehicle *v)

   109

{

   110

	if (v->vehstatus & VS_CRASHED)

   111

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

   112

   113

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

   114

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

   115

	}

   116

   117

	return _patches.servint_ispercent ?

   118

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

   119

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

   120

}

   121

   122

StringID VehicleInTheWayErrMsg(const Vehicle* v)

   123

{

   124

	switch (v->type) {

   125

		case VEH_Train:    return STR_8803_TRAIN_IN_THE_WAY;

   126

		case VEH_Road:     return STR_9000_ROAD_VEHICLE_IN_THE_WAY;

   127

		case VEH_Aircraft: return STR_A015_AIRCRAFT_IN_THE_WAY;

   128

		default:           return STR_980E_SHIP_IN_THE_WAY;

   129

	}

   130

}

   131

   132

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

   133

{

   134

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

   135

		return NULL;

   136

   137

	_error_message = VehicleInTheWayErrMsg(v);

   138

	return v;

   139

}

   140

   141

bool EnsureNoVehicle(TileIndex tile)

   142

{

   143

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

   144

}

   145

   146

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

   147

{

   148

	const TileInfo *ti = data;

   149

   150

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

   151

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

   152

   153

	_error_message = VehicleInTheWayErrMsg(v);

   154

	return v;

   155

}

   156

   157

   158

bool EnsureNoVehicleOnGround(TileIndex tile)

   159

{

   160

	TileInfo ti;

   161

   162

	ti.tile = tile;

   163

	ti.z = GetTileMaxZ(tile);

   164

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

   165

}

   166

   167

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z)

   168

{

   169

	TileInfo ti;

   170

   171

	ti.tile = tile;

   172

	ti.z = z;

   173

   174

	return VehicleFromPos(tile, &ti, EnsureNoVehicleProcZ);

   175

}

   176

   177

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

   178

{

   179

	int x1 = TileX(from);

   180

	int y1 = TileY(from);

   181

	int x2 = TileX(to);

   182

	int y2 = TileY(to);

   183

	Vehicle *veh;

   184

   185

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

   186

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

   187

		intswap(x1,x2);

   188

		intswap(y1,y2);

   189

	}

   190

	FOR_ALL_VEHICLES(veh) {

   191

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

   192

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

   193

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

   194

				return veh;

   195

			}

   196

		}

   197

	}

   198

	return NULL;

   199

}

   200

   201

   202

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

   203

   204

void VehiclePositionChanged(Vehicle *v)

   205

{

   206

	int img = v->cur_image;

   207

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

   208

	const Sprite* spr = GetSprite(img);

   209

   210

	pt.x += spr->x_offs;

   211

	pt.y += spr->y_offs;

   212

   213

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

   214

   215

	v->left_coord = pt.x;

   216

	v->top_coord = pt.y;

   217

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

   218

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

   219

}

   220

   221

// Called after load to update coordinates

   222

void AfterLoadVehicles(void)

   223

{

   224

	Vehicle *v;

   225

   226

	FOR_ALL_VEHICLES(v) {

   227

		v->first = NULL;

   228

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

   229

	}

   230

   231

	FOR_ALL_VEHICLES(v) {

   232

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

   233

			TrainConsistChanged(v);

   234

	}

   235

   236

	FOR_ALL_VEHICLES(v) {

   237

		switch (v->type) {

   238

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

   239

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

   240

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

   241

			case VEH_Aircraft:

   242

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

   243

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

   244

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

   245

				}

   246

				break;

   247

			default: break;

   248

		}

   249

   250

		v->left_coord = INVALID_COORD;

   251

		VehiclePositionChanged(v);

   252

	}

   253

}

   254

   255

static Vehicle *InitializeVehicle(Vehicle *v)

   256

{

   257

	VehicleID index = v->index;

   258

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

   259

	v->index = index;

   260

   261

	assert(v->orders == NULL);

   262

   263

	v->left_coord = INVALID_COORD;

   264

	v->first = NULL;

   265

	v->next = NULL;

   266

	v->next_hash = INVALID_VEHICLE;

   267

	v->string_id = 0;

   268

	v->next_shared = NULL;

   269

	v->prev_shared = NULL;

   270

	v->depot_list  = NULL;

   271

	v->random_bits = 0;

   272

	return v;

   273

}

   274

   275

/**

   276

 * Get a value for a vehicle's random_bits.

   277

 * @return A random value from 0 to 255.

   278

 */

   279

byte VehicleRandomBits(void)

   280

{

   281

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

   282

}

   283

   284

Vehicle *ForceAllocateSpecialVehicle(void)

   285

{

   286

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

   287

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

   288

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

   289

	 * BLOCKS_FOR_SPECIAL_VEHICLES times block_size vehicles that may only

   290

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

   291

   292

	Vehicle *v;

   293

   294

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

   295

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

   296

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

   297

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

   298

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

   299

			return NULL;

   300

   301

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

   302

	}

   303

   304

	return NULL;

   305

}

   306

   307

/*

   308

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

   309

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

   310

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

   311

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

   312

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

   313

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

   314

 */

   315

static Vehicle *AllocateSingleVehicle(VehicleID *skip_vehicles)

   316

{

   317

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

   318

	 * first blocks */

   319

	Vehicle *v;

   320

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

   321

   322

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

   323

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

   324

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

   325

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

   326

			(*skip_vehicles)++;

   327

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

   328

		}

   329

	}

   330

   331

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

   332

	if (AddBlockToPool(&_Vehicle_pool))

   333

		return AllocateSingleVehicle(skip_vehicles);

   334

   335

	return NULL;

   336

}

   337

   338

   339

Vehicle *AllocateVehicle(void)

   340

{

   341

	VehicleID counter = 0;

   342

	return AllocateSingleVehicle(&counter);

   343

}

   344

   345

   346

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

   347

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

   348

 * @param num number of vehicles to allocate room for

   349

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

   350

 */

   351

bool AllocateVehicles(Vehicle **vl, int num)

   352

{

   353

	int i;

   354

	Vehicle *v;

   355

	VehicleID counter = 0;

   356

   357

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

   358

		v = AllocateSingleVehicle(&counter);

   359

		if (v == NULL) {

   360

			return false;

   361

		}

   362

		if (vl != NULL) {

   363

			vl[i] = v;

   364

		}

   365

	}

   366

   367

	return true;

   368

}

   369

   370

   371

static VehicleID _vehicle_position_hash[0x1000];

   372

   373

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

   374

{

   375

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

   376

   377

	// The hash area to scan

   378

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

   379

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

   380

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

   381

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

   382

   383

	int x;

   384

	int y;

   385

   386

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

   387

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

   388

			VehicleID veh = _vehicle_position_hash[(x + y) & 0xFFFF];

   389

   390

			while (veh != INVALID_VEHICLE) {

   391

				Vehicle *v = GetVehicle(veh);

   392

				void* a = proc(v, data);

   393

   394

				if (a != NULL) return a;

   395

				veh = v->next_hash;

   396

			}

   397

   398

			if (x == xu) break;

   399

		}

   400

   401

		if (y == yu) break;

   402

	}

   403

	return NULL;

   404

}

   405

   406

   407

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

   408

{

   409

	VehicleID *old_hash, *new_hash;

   410

	int old_x = v->left_coord;

   411

	int old_y = v->top_coord;

   412

	Vehicle *u;

   413

   414

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

   415

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

   416

   417

	if (old_hash == new_hash) return;

   418

   419

	/* remove from hash table? */

   420

	if (old_hash != NULL) {

   421

		Vehicle *last = NULL;

   422

		VehicleID idx = *old_hash;

   423

		while ((u = GetVehicle(idx)) != v) {

   424

			idx = u->next_hash;

   425

			assert(idx != INVALID_VEHICLE);

   426

			last = u;

   427

		}

   428

   429

		if (last == NULL) {

   430

			*old_hash = v->next_hash;

   431

		} else {

   432

			last->next_hash = v->next_hash;

   433

		}

   434

	}

   435

   436

	/* insert into hash table? */

   437

	if (new_hash != NULL) {

   438

		v->next_hash = *new_hash;

   439

		*new_hash = v->index;

   440

	}

   441

}

   442

   443

void InitializeVehicles(void)

   444

{

   445

	uint i;

   446

   447

	/* Clean the vehicle pool, and reserve enough blocks

   448

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

   449

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

   450

	CleanPool(&_Vehicle_pool);

   451

	AddBlockToPool(&_Vehicle_pool);

   452

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

   453

		AddBlockToPool(&_Vehicle_pool);

   454

   455

	for (i = 0; i < lengthof(_vehicle_position_hash); i++) {

   456

		_vehicle_position_hash[i] = INVALID_VEHICLE;

   457

	}

   458

}

   459

   460

Vehicle *GetLastVehicleInChain(Vehicle *v)

   461

{

   462

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

   463

	return v;

   464

}

   465

   466

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

   467

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

   468

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

   469

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

   470

 * called by anything but GetFirstVehicleInChain

   471

 */

   472

static Vehicle *GetPrevVehicleInChain_bruteforce(const Vehicle *v)

   473

{

   474

	Vehicle *u;

   475

   476

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

   477

   478

	return NULL;

   479

}

   480

   481

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

   482

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

   483

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

   484

 */

   485

Vehicle *GetPrevVehicleInChain(const Vehicle *v)

   486

{

   487

	Vehicle *u;

   488

	assert(v != NULL);

   489

   490

	u = GetFirstVehicleInChain(v);

   491