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

#include "cargotype.h"

    41

    42

#define INVALID_COORD (-0x8000)

    43

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

    44

    45

    46

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

    47

const uint32 _veh_build_proc_table[] = {

    48

	CMD_BUILD_RAIL_VEHICLE,

    49

	CMD_BUILD_ROAD_VEH,

    50

	CMD_BUILD_SHIP,

    51

	CMD_BUILD_AIRCRAFT,

    52

};

    53

const uint32 _veh_sell_proc_table[] = {

    54

	CMD_SELL_RAIL_WAGON,

    55

	CMD_SELL_ROAD_VEH,

    56

	CMD_SELL_SHIP,

    57

	CMD_SELL_AIRCRAFT,

    58

};

    59

    60

const uint32 _veh_refit_proc_table[] = {

    61

	CMD_REFIT_RAIL_VEHICLE,

    62

	CMD_REFIT_ROAD_VEH,

    63

	CMD_REFIT_SHIP,

    64

	CMD_REFIT_AIRCRAFT,

    65

};

    66

    67

const uint32 _send_to_depot_proc_table[] = {

    68

	CMD_SEND_TRAIN_TO_DEPOT,

    69

	CMD_SEND_ROADVEH_TO_DEPOT,

    70

	CMD_SEND_SHIP_TO_DEPOT,

    71

	CMD_SEND_AIRCRAFT_TO_HANGAR,

    72

};

    73

    74

    75

enum {

    76

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

    77

};

    78

    79

/**

    80

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

    81

 */

    82

static void VehiclePoolNewBlock(uint start_item)

    83

{

    84

	Vehicle *v;

    85

    86

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

    87

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

    88

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

    89

		v->index = start_item++;

    91

	}

    92

}

    93

    94

/* Initialize the vehicle-pool */

    95

DEFINE_OLD_POOL(Vehicle, Vehicle, VehiclePoolNewBlock, NULL)

    96

    97

void VehicleServiceInDepot(Vehicle *v)

    98

{

    99

	v->date_of_last_service = _date;

   100

	v->breakdowns_since_last_service = 0;

   101

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

   102

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

   103

}

   104

   105

bool VehicleNeedsService(const Vehicle *v)

   106

{

   107

	if (v->vehstatus & VS_CRASHED)

   108

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

   109

   110

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

   111

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

   112

	}

   113

   114

	return _patches.servint_ispercent ?

   115

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

   116

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

   117

}

   118

   119

StringID VehicleInTheWayErrMsg(const Vehicle* v)

   120

{

   121

	switch (v->type) {

   125

		default:           return STR_980E_SHIP_IN_THE_WAY;

   126

	}

   127

}

   128

   129

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

   130

{

   132

		return NULL;

   133

   134

	_error_message = VehicleInTheWayErrMsg(v);

   135

	return v;

   136

}

   137

   138

bool EnsureNoVehicle(TileIndex tile)

   139

{

   140

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

   141

}

   142

   143

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

   144

{

   145

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

   146

   148

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

   149

   150

	_error_message = VehicleInTheWayErrMsg(v);

   151

	return v;

   152

}

   153

   154

   155

bool EnsureNoVehicleOnGround(TileIndex tile)

   156

{

   157

	TileInfo ti;

   158

   159

	ti.tile = tile;

   160

	ti.z = GetTileMaxZ(tile);

   161

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

   162

}

   163

   164

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z)

   165

{

   166

	TileInfo ti;

   167

   168

	ti.tile = tile;

   169

	ti.z = z;

   170

   171

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

   172

}

   173

   174

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

   175

{

   176

	int x1 = TileX(from);

   177

	int y1 = TileY(from);

   178

	int x2 = TileX(to);

   179

	int y2 = TileY(to);

   180

	Vehicle *veh;

   181

   182

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

   183

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

   184

		Swap(x1, x2);

   185

		Swap(y1, y2);

   186

	}

   187

	FOR_ALL_VEHICLES(veh) {

   188

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

   190

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

   191

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

   192

				return veh;

   193

			}

   194

		}

   195

	}

   196

	return NULL;

   197

}

   198

   199

   200

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

   201

   202

void VehiclePositionChanged(Vehicle *v)

   203

{

   204

	int img = v->cur_image;

   205

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

   206

	const Sprite* spr = GetSprite(img);

   207

   208

	pt.x += spr->x_offs;

   209

	pt.y += spr->y_offs;

   210

   211

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

   212

   213

	v->left_coord = pt.x;

   214

	v->top_coord = pt.y;

   215

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

   216

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

   217

}

   218

   219

// Called after load to update coordinates

   220

void AfterLoadVehicles()

   221

{

   222

	Vehicle *v;

   223

   224

	FOR_ALL_VEHICLES(v) {

   225

		v->first = NULL;

   227

	}

   228

   229

	FOR_ALL_VEHICLES(v) {

   231

			TrainConsistChanged(v);

   232

	}

   233

   234

	FOR_ALL_VEHICLES(v) {

   235

		switch (v->type) {

   240

				if (IsNormalAircraft(v)) {

   241

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

   242

   243

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

   244

					Vehicle *shadow = v->next;

   245

					shadow->cur_image = v->cur_image;

   246

   247

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

   248

					if (v->subtype == AIR_HELICOPTER) {

   249

						Vehicle *rotor = shadow->next;

   250

						rotor->cur_image = GetRotorImage(v);

   251

					}

   252

				}

   253

				break;

   254

			default: break;

   255

		}

   256

   257

		v->left_coord = INVALID_COORD;

   258

		VehiclePositionChanged(v);

   259

	}

   260

}

   261

   262

static Vehicle *InitializeVehicle(Vehicle *v)

   263

{

   264

	VehicleID index = v->index;

   265

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

   266

	v->index = index;

   267

   268

	assert(v->orders == NULL);

   269

   271

	v->left_coord = INVALID_COORD;

   272

	v->first = NULL;

   273

	v->next = NULL;

   274

	v->next_hash = NULL;

   275

	v->string_id = 0;

   276

	v->next_shared = NULL;

   277

	v->prev_shared = NULL;

   278

	v->depot_list  = NULL;

   279

	v->random_bits = 0;

   280

	return v;

   281

}

   282

   283

/**

   284

 * Get a value for a vehicle's random_bits.

   285

 * @return A random value from 0 to 255.

   286

 */

   287

byte VehicleRandomBits()

   288

{

   289

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

   290

}

   291

   292

Vehicle *ForceAllocateSpecialVehicle()

   293

{

   294

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

   295

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

   296

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

   297

	 * BLOCKS_FOR_SPECIAL_VEHICLES times block_size vehicles that may only

   298

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

   299

   300

	Vehicle *v;

   301

   302

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

   303

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

   304

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

   305

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

   306

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

   307

			return NULL;

   308

   309

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

   310

	}

   311

   312

	return NULL;

   313

}

   314

   315

/*

   316

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

   317

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

   318

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

   319

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

   320

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

   321

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

   322

 */

   323

static Vehicle *AllocateSingleVehicle(VehicleID *skip_vehicles)

   324

{

   325

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

   326

	 * first blocks */

   327

	Vehicle *v;

   328

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

   329

   330

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

   331

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

   332

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

   333

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

   334

			(*skip_vehicles)++;

   335

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

   336

		}

   337

	}

   338

   339

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

   340

	if (AddBlockToPool(&_Vehicle_pool))

   341

		return AllocateSingleVehicle(skip_vehicles);

   342

   343

	return NULL;

   344

}

   345

   346

   347

Vehicle *AllocateVehicle()

   348

{

   349

	VehicleID counter = 0;

   350

	return AllocateSingleVehicle(&counter);

   351

}

   352

   353

   354

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

   355

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

   356

 * @param num number of vehicles to allocate room for

   357

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

   358

 */

   359

bool AllocateVehicles(Vehicle **vl, int num)

   360

{

   361

	int i;

   362

	Vehicle *v;

   363

	VehicleID counter = 0;

   364

   365

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

   366

		v = AllocateSingleVehicle(&counter);

   367

		if (v == NULL) {

   368

			return false;

   369

		}

   370

		if (vl != NULL) {

   371

			vl[i] = v;

   372

		}

   373

	}

   374

   375

	return true;

   376

}

   377

   378

   379

static Vehicle *_vehicle_position_hash[0x1000];

   380

   381

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

   382

{

   383

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

   384

   385

	// The hash area to scan

   386

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

   387

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

   388

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

   389

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

   390

   391

	int x;

   392

	int y;

   393

   394

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

   395

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

   396

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

   397

   398

			while (v != NULL) {

   399

				void* a = proc(v, data);

   400

   401

				if (a != NULL) return a;

   402

				v = v->next_hash;

   403

			}

   404

   405

			if (x == xu) break;

   406

		}

   407

   408

		if (y == yu) break;

   409

	}

   410

	return NULL;

   411

}

   412

   413

   414

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

   415

{

   416

	Vehicle **old_hash, **new_hash;

   417

	int old_x = v->left_coord;

   418

	int old_y = v->top_coord;

   419

   420

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

   421

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

   422

   423

	if (old_hash == new_hash) return;

   424

   425

	/* remove from hash table? */

   426

	if (old_hash != NULL) {

   427

		Vehicle *last = NULL;

   428

		Vehicle *u = *old_hash;

   429

		while (u != v) {

   430

			last = u;

   431

			u = u->next_hash;

   432

			assert(u != NULL);

   433

		}

   434

   435

		if (last == NULL) {

   436

			*old_hash = v->next_hash;

   437

		} else {

   438

			last->next_hash = v->next_hash;

   439

		}

   440

	}

   441

   442

	/* insert into hash table? */

   443

	if (new_hash != NULL) {

   444

		v->next_hash = *new_hash;

   445

		*new_hash = v;

   446

	}

   447

}

   448

   449

void ResetVehiclePosHash()

   450

{

   451

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

   452

}

   453

   454

void InitializeVehicles()

   455

{

   456

	uint i;

   457

   458

	/* Clean the vehicle pool, and reserve enough blocks

   459

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

   460

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

   461

	CleanPool(&_Vehicle_pool);

   462

	AddBlockToPool(&_Vehicle_pool);

   463

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

   464

		AddBlockToPool(&_Vehicle_pool);

   465

	}

   466

   467

	ResetVehiclePosHash();

   468

}

   469

   470

Vehicle *GetLastVehicleInChain(Vehicle *v)

   471

{

   472

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

   473

	return v;

   474

}

   475

   476

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

   477

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

   478

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

   479

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

   480

 * called by anything but GetFirstVehicleInChain

   481

 */

   482

static Vehicle *GetPrevVehicleInChain_bruteforce(const Vehicle *v)

   483

{

   484

	Vehicle *u;

   485

   487

   488

	return NULL;

   489

}