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

	/* Max vehicles: 64000 (512 * 125) */

    83

	VEHICLES_POOL_BLOCK_SIZE_BITS = 9,       /* In bits, so (1 << 9) == 512 */

    84

	VEHICLES_POOL_MAX_BLOCKS      = 125,

    85

    86

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

    87

};

    88

    89

/**

    90

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

    91

 */

    92

static void VehiclePoolNewBlock(uint start_item)

    93

{

    94

	Vehicle *v;

    95

    96

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

    97

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

    98

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

    99

}

   100

   101

/* Initialize the vehicle-pool */

   102

MemoryPool _vehicle_pool = { "Vehicle", VEHICLES_POOL_MAX_BLOCKS, VEHICLES_POOL_BLOCK_SIZE_BITS, sizeof(Vehicle), &VehiclePoolNewBlock, NULL, 0, 0, NULL };

   103

   104

void VehicleServiceInDepot(Vehicle *v)

   105

{

   106

	v->date_of_last_service = _date;

   107

	v->breakdowns_since_last_service = 0;

   108

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

   109

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

   110

}

   111

   112

bool VehicleNeedsService(const Vehicle *v)

   113

{

   114

	if (v->vehstatus & VS_CRASHED)

   115

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

   116

   117

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

   118

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

   119

	}

   120

   121

	return _patches.servint_ispercent ?

   122

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

   123

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

   124

}

   125

   126

StringID VehicleInTheWayErrMsg(const Vehicle* v)

   127

{

   128

	switch (v->type) {

   129

		case VEH_Train:    return STR_8803_TRAIN_IN_THE_WAY;

   130

		case VEH_Road:     return STR_9000_ROAD_VEHICLE_IN_THE_WAY;

   131

		case VEH_Aircraft: return STR_A015_AIRCRAFT_IN_THE_WAY;

   132

		default:           return STR_980E_SHIP_IN_THE_WAY;

   133

	}

   134

}

   135

   136

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

   137

{

   138

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

   139

		return NULL;

   140

   141

	_error_message = VehicleInTheWayErrMsg(v);

   142

	return v;

   143

}

   144

   145

bool EnsureNoVehicle(TileIndex tile)

   146

{

   147

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

   148

}

   149

   150

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

   151

{

   152

	const TileInfo *ti = data;

   153

   154

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

   155

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

   156

   157

	_error_message = VehicleInTheWayErrMsg(v);

   158

	return v;

   159

}

   160

   161

   162

bool EnsureNoVehicleOnGround(TileIndex tile)

   163

{

   164

	TileInfo ti;

   165

   166

	ti.tile = tile;

   167

	ti.z = GetTileMaxZ(tile);

   168

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

   169

}

   170

   171

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z)

   172

{

   173

	TileInfo ti;

   174

   175

	ti.tile = tile;

   176

	ti.z = z;

   177

   178

	return VehicleFromPos(tile, &ti, EnsureNoVehicleProcZ);

   179

}

   180

   181

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

   182

{

   183

	int x1 = TileX(from);

   184

	int y1 = TileY(from);

   185

	int x2 = TileX(to);

   186

	int y2 = TileY(to);

   187

	Vehicle *veh;

   188

   189

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

   190

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

   191

		intswap(x1,x2);

   192

		intswap(y1,y2);

   193

	}

   194

	FOR_ALL_VEHICLES(veh) {

   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(void)

   227

{

   228

	Vehicle *v;

   229

   230

	FOR_ALL_VEHICLES(v) {

   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 (v->subtype == 0 || v->subtype == 2) {

   247

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

   248

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

   249

				}

   250

				break;

   251

			default: break;

   252

		}

   253

   254

		v->left_coord = INVALID_COORD;

   255

		VehiclePositionChanged(v);

   256

	}

   257

}

   258

   259

static Vehicle *InitializeVehicle(Vehicle *v)

   260

{

   261

	VehicleID index = v->index;

   262

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

   263

	v->index = index;

   264

   265

	assert(v->orders == NULL);

   266

   267

	v->left_coord = INVALID_COORD;

   268

	v->first = NULL;

   269

	v->next = NULL;

   270

	v->next_hash = INVALID_VEHICLE;

   271

	v->string_id = 0;

   272

	v->next_shared = NULL;

   273

	v->prev_shared = NULL;

   274

	v->depot_list  = NULL;

   275

	v->random_bits = 0;

   276

	return v;

   277

}

   278

   279

/**

   280

 * Get a value for a vehicle's random_bits.

   281

 * @return A random value from 0 to 255.

   282

 */

   283

byte VehicleRandomBits(void)

   284

{

   285

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

   286

}

   287

   288

Vehicle *ForceAllocateSpecialVehicle(void)

   289

{

   290

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

   291

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

   292

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

   293

	 * BLOCKS_FOR_SPECIAL_VEHICLES times block_size vehicles that may only

   294

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

   295

   296

	Vehicle *v;

   297

   298

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

   299

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

   300

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

   301

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

   302

		if (v->index >= (1 << _vehicle_pool.block_size_bits) * BLOCKS_FOR_SPECIAL_VEHICLES)

   303

			return NULL;

   304

   305

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

   306

	}

   307

   308

	return NULL;

   309

}

   310

   311

/*

   312

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

   313

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

   314

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

   315

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

   316

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

   317

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

   318

 */

   319

static Vehicle *AllocateSingleVehicle(VehicleID *skip_vehicles)

   320

{

   321

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

   322

	 * first blocks */

   323

	Vehicle *v;

   324

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

   325

   326

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

   327

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

   328

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

   329

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

   330

			(*skip_vehicles)++;

   331

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

   332

		}

   333

	}

   334

   335

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

   336

	if (AddBlockToPool(&_vehicle_pool))

   337

		return AllocateSingleVehicle(skip_vehicles);

   338

   339

	return NULL;

   340

}

   341

   342

   343

Vehicle *AllocateVehicle(void)

   344

{

   345

	VehicleID counter = 0;

   346

	return AllocateSingleVehicle(&counter);

   347

}

   348

   349

   350

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

   351

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

   352

 * @param num number of vehicles to allocate room for

   353

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

   354

 */

   355

bool AllocateVehicles(Vehicle **vl, int num)

   356

{

   357

	int i;

   358

	Vehicle *v;

   359

	VehicleID counter = 0;

   360

   361

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

   362

		v = AllocateSingleVehicle(&counter);

   363

		if (v == NULL) {

   364

			return false;

   365

		}

   366

		if (vl != NULL) {

   367

			vl[i] = v;

   368

		}

   369

	}

   370

   371

	return true;

   372

}

   373

   374

   375

static VehicleID _vehicle_position_hash[0x1000];

   376

   377

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

   378

{

   379

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

   380

   381

	// The hash area to scan

   382

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

   383

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

   384

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

   385

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

   386

   387

	int x;

   388

	int y;

   389

   390

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

   391

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

   392

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

   393

   394

			while (veh != INVALID_VEHICLE) {

   395

				Vehicle *v = GetVehicle(veh);

   396

				void* a = proc(v, data);

   397

   398

				if (a != NULL) return a;

   399

				veh = v->next_hash;

   400

			}

   401

   402

			if (x == xu) break;

   403

		}

   404

   405

		if (y == yu) break;

   406

	}

   407

	return NULL;

   408

}

   409

   410

   411

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

   412

{

   413

	VehicleID *old_hash, *new_hash;

   414

	int old_x = v->left_coord;

   415

	int old_y = v->top_coord;

   416

	Vehicle *u;

   417

   418

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

   419

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

   420

   421

	if (old_hash == new_hash) return;

   422

   423

	/* remove from hash table? */

   424

	if (old_hash != NULL) {

   425

		Vehicle *last = NULL;

   426

		VehicleID idx = *old_hash;

   427

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

   428

			idx = u->next_hash;

   429

			assert(idx != INVALID_VEHICLE);

   430

			last = u;

   431

		}

   432

   433

		if (last == NULL) {

   434

			*old_hash = v->next_hash;

   435

		} else {

   436

			last->next_hash = v->next_hash;

   437

		}

   438

	}

   439

   440

	/* insert into hash table? */

   441

	if (new_hash != NULL) {

   442

		v->next_hash = *new_hash;

   443

		*new_hash = v->index;

   444

	}

   445

}

   446

   447

void InitializeVehicles(void)

   448

{

   449

	uint i;

   450

   451

	/* Clean the vehicle pool, and reserve enough blocks

   452

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

   453

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

   454

	CleanPool(&_vehicle_pool);

   455

	AddBlockToPool(&_vehicle_pool);

   456

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

   457

		AddBlockToPool(&_vehicle_pool);

   458

   459

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

   460

		_vehicle_position_hash[i] = INVALID_VEHICLE;

   461

	}

   462

}

   463

   464

Vehicle *GetLastVehicleInChain(Vehicle *v)

   465

{

   466

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

   467

	return v;

   468

}

   469

   470

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

   471

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

   472

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

   473

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

   474

 * called by anything but GetFirstVehicleInChain

   475

 */

   476

static Vehicle *GetPrevVehicleInChain_bruteforce(const Vehicle *v)

   477

{

   478

	Vehicle *u;

   479

   480

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

   481

   482

	return NULL;

   483

}

   484

   485

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

   486

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

   487

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

   488

 */

   489

Vehicle *GetPrevVehicleInChain(const Vehicle *v)

   490

{

   491

	Vehicle *u;

   492

	assert(v != NULL);