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

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

    46

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

    47

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

    48

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

    49

 */

    50

    51

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

    52

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

    53

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

    54

    55

static const uint32 _veh_build_proc_table[] = {

    56

	CMD_BUILD_RAIL_VEHICLE,

    57

	CMD_BUILD_ROAD_VEH,

    58

	CMD_BUILD_SHIP,

    59

	CMD_BUILD_AIRCRAFT,

    60

};

    61

static const uint32 _veh_sell_proc_table[] = {

    62

	CMD_SELL_RAIL_WAGON,

    63

	CMD_SELL_ROAD_VEH,

    64

	CMD_SELL_SHIP,

    65

	CMD_SELL_AIRCRAFT,

    66

};

    67

    68

static const uint32 _veh_refit_proc_table[] = {

    69

	CMD_REFIT_RAIL_VEHICLE,

    70

	CMD_REFIT_ROAD_VEH,

    71

	CMD_REFIT_SHIP,

    72

	CMD_REFIT_AIRCRAFT,

    73

};

    74

    75

const uint32 _send_to_depot_proc_table[] = {

    76

	CMD_SEND_TRAIN_TO_DEPOT,

    77

	CMD_SEND_ROADVEH_TO_DEPOT,

    78

	CMD_SEND_SHIP_TO_DEPOT,

    79

	CMD_SEND_AIRCRAFT_TO_HANGAR,

    80

};

    81

    82

    83

enum {

    84

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

    85

};

    86

    87

/**

    88

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

    89

 */

    90

static void VehiclePoolNewBlock(uint start_item)

    91

{

    92

	Vehicle *v;

    93

    94

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

    95

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

    96

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

    97

}

    98

    99

/* Initialize the vehicle-pool */

   100

DEFINE_OLD_POOL(Vehicle, Vehicle, VehiclePoolNewBlock, NULL)

   101

   102

void VehicleServiceInDepot(Vehicle *v)

   103

{

   104

	v->date_of_last_service = _date;

   105

	v->breakdowns_since_last_service = 0;

   106

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

   107

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

   108

}

   109

   110

bool VehicleNeedsService(const Vehicle *v)

   111

{

   112

	if (v->vehstatus & VS_CRASHED)

   113

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

   114

   115

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

   116

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

   117

	}

   118

   119

	return _patches.servint_ispercent ?

   120

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

   121

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

   122

}

   123

   124

StringID VehicleInTheWayErrMsg(const Vehicle* v)

   125

{

   126

	switch (v->type) {

   127

		case VEH_Train:    return STR_8803_TRAIN_IN_THE_WAY;

   128

		case VEH_Road:     return STR_9000_ROAD_VEHICLE_IN_THE_WAY;

   129

		case VEH_Aircraft: return STR_A015_AIRCRAFT_IN_THE_WAY;

   130

		default:           return STR_980E_SHIP_IN_THE_WAY;

   131

	}

   132

}

   133

   134

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

   135

{

   136

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

   137

		return NULL;

   138

   139

	_error_message = VehicleInTheWayErrMsg(v);

   140

	return v;

   141

}

   142

   143

bool EnsureNoVehicle(TileIndex tile)

   144

{

   145

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

   146

}

   147

   148

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

   149

{

   150

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

   151

   152

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

   153

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

   154

   155

	_error_message = VehicleInTheWayErrMsg(v);

   156

	return v;

   157

}

   158

   159

   160

bool EnsureNoVehicleOnGround(TileIndex tile)

   161

{

   162

	TileInfo ti;

   163

   164

	ti.tile = tile;

   165

	ti.z = GetTileMaxZ(tile);

   166

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

   167

}

   168

   169

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z)

   170

{

   171

	TileInfo ti;

   172

   173

	ti.tile = tile;

   174

	ti.z = z;

   175

   176

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

   177

}

   178

   179

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

   180

{

   181

	int x1 = TileX(from);

   182

	int y1 = TileY(from);

   183

	int x2 = TileX(to);

   184

	int y2 = TileY(to);

   185

	Vehicle *veh;

   186

   187

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

   188

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

   189

		intswap(x1,x2);

   190

		intswap(y1,y2);

   191

	}

   192

	FOR_ALL_VEHICLES(veh) {

   193

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

   194

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

   195

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

   196

				return veh;

   197

			}

   198

		}

   199

	}

   200

	return NULL;

   201

}

   202

   203

   204

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

   205

   206

void VehiclePositionChanged(Vehicle *v)

   207

{

   208

	int img = v->cur_image;

   209

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

   210

	const Sprite* spr = GetSprite(img);

   211

   212

	pt.x += spr->x_offs;

   213

	pt.y += spr->y_offs;

   214

   215

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

   216

   217

	v->left_coord = pt.x;

   218

	v->top_coord = pt.y;

   219

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

   220

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

   221

}

   222

   223

// Called after load to update coordinates

   224

void AfterLoadVehicles(void)

   225

{

   226

	Vehicle *v;

   227

   228

	FOR_ALL_VEHICLES(v) {

   229

		v->first = NULL;

   230

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

   231

	}

   232

   233

	FOR_ALL_VEHICLES(v) {

   234

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

   235

			TrainConsistChanged(v);

   236

	}

   237

   238

	FOR_ALL_VEHICLES(v) {

   239

		switch (v->type) {

   240

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

   241

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

   242

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

   243

			case VEH_Aircraft:

   244

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

   245

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

   246

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

   247

				}

   248

				break;

   249

			default: break;

   250

		}

   251

   252

		v->left_coord = INVALID_COORD;

   253

		VehiclePositionChanged(v);

   254

	}

   255

}

   256

   257

static Vehicle *InitializeVehicle(Vehicle *v)

   258

{

   259

	VehicleID index = v->index;

   260

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

   261

	v->index = index;

   262

   263

	assert(v->orders == NULL);

   264

   265

	v->left_coord = INVALID_COORD;

   266

	v->first = NULL;

   267

	v->next = NULL;

   268

	v->next_hash = NULL;

   269

	v->string_id = 0;

   270

	v->next_shared = NULL;

   271

	v->prev_shared = NULL;

   272

	v->depot_list  = NULL;

   273

	v->random_bits = 0;

   274

	return v;

   275

}

   276

   277

/**

   278

 * Get a value for a vehicle's random_bits.

   279

 * @return A random value from 0 to 255.

   280

 */

   281

byte VehicleRandomBits(void)

   282

{

   283

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

   284

}

   285

   286

Vehicle *ForceAllocateSpecialVehicle(void)

   287

{

   288

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

   289

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

   290

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

   291

	 * BLOCKS_FOR_SPECIAL_VEHICLES times block_size vehicles that may only

   292

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

   293

   294

	Vehicle *v;

   295

   296

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

   297

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

   298

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

   299

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

   300

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

   301

			return NULL;

   302

   303

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

   304

	}

   305

   306

	return NULL;

   307

}

   308

   309

/*

   310

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

   311

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

   312

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

   313

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

   314

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

   315

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

   316

 */

   317

static Vehicle *AllocateSingleVehicle(VehicleID *skip_vehicles)

   318

{

   319

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

   320

	 * first blocks */

   321

	Vehicle *v;

   322

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

   323

   324

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

   325

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

   326

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

   327

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

   328

			(*skip_vehicles)++;

   329

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

   330

		}

   331

	}

   332

   333

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

   334

	if (AddBlockToPool(&_Vehicle_pool))

   335

		return AllocateSingleVehicle(skip_vehicles);

   336

   337

	return NULL;

   338

}

   339

   340

   341

Vehicle *AllocateVehicle(void)

   342

{

   343

	VehicleID counter = 0;

   344

	return AllocateSingleVehicle(&counter);

   345

}

   346

   347

   348

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

   349

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

   350

 * @param num number of vehicles to allocate room for

   351

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

   352

 */

   353

bool AllocateVehicles(Vehicle **vl, int num)

   354

{

   355

	int i;

   356

	Vehicle *v;

   357

	VehicleID counter = 0;

   358

   359

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

   360

		v = AllocateSingleVehicle(&counter);

   361

		if (v == NULL) {

   362

			return false;

   363

		}

   364

		if (vl != NULL) {

   365

			vl[i] = v;

   366

		}

   367

	}

   368

   369

	return true;

   370

}

   371

   372

   373

static Vehicle *_vehicle_position_hash[0x1000];

   374

   375

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

   376

{

   377

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

   378

   379

	// The hash area to scan

   380

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

   381

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

   382

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

   383

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

   384

   385

	int x;

   386

	int y;

   387

   388

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

   389

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

   390

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

   391

   392

			while (v != NULL) {

   393

				void* a = proc(v, data);

   394

   395

				if (a != NULL) return a;

   396

				v = v->next_hash;

   397

			}

   398

   399

			if (x == xu) break;

   400

		}

   401

   402

		if (y == yu) break;

   403

	}

   404

	return NULL;

   405

}

   406

   407

   408

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

   409

{

   410

	Vehicle **old_hash, **new_hash;

   411

	int old_x = v->left_coord;

   412

	int old_y = v->top_coord;

   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

		Vehicle *u = *old_hash;

   423

		while (u != v) {

   424

			last = u;

   425

			u = u->next_hash;

   426

			assert(u != NULL);

   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;

   440

	}

   441

}

   442

   443

void ResetVehiclePosHash(void)

   444

{

   445

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

   446

}

   447

   448

void InitializeVehicles(void)

   449

{

   450

	uint i;

   451

   452

	/* Clean the vehicle pool, and reserve enough blocks

   453

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

   454

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

   455

	CleanPool(&_Vehicle_pool);

   456

	AddBlockToPool(&_Vehicle_pool);

   457

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

   458

		AddBlockToPool(&_Vehicle_pool);

   459

	}

   460

   461

	ResetVehiclePosHash();

   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

{