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

    30

#include "station_map.h"

    31

#include "water_map.h"

    32

#include "network.h"

    33

#include "yapf/yapf.h"

    34

#include "date.h"

    35

    36

#define INVALID_COORD (-0x8000)

    37

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

    38

    39

/*

    40

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

    41

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

    42

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

    43

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

    44

 */

    45

    46

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

    47

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

    48

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

    49

    50

static const uint32 _veh_build_proc_table[] = {

    51

	CMD_BUILD_RAIL_VEHICLE,

    52

	CMD_BUILD_ROAD_VEH,

    53

	CMD_BUILD_SHIP,

    54

	CMD_BUILD_AIRCRAFT,

    55

};

    56

static const uint32 _veh_sell_proc_table[] = {

    57

	CMD_SELL_RAIL_WAGON,

    58

	CMD_SELL_ROAD_VEH,

    59

	CMD_SELL_SHIP,

    60

	CMD_SELL_AIRCRAFT,

    61

};

    62

    63

static const uint32 _veh_refit_proc_table[] = {

    64

	CMD_REFIT_RAIL_VEHICLE,

    65

	CMD_REFIT_ROAD_VEH,

    66

	CMD_REFIT_SHIP,

    67

	CMD_REFIT_AIRCRAFT,

    68

};

    69

    70

    71

enum {

    72

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

    73

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

    74

	VEHICLES_POOL_MAX_BLOCKS      = 125,

    75

    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

	FOR_ALL_VEHICLES_FROM(v, start_item) v->index = start_item++;

    87

}

    88

    89

/* Initialize the vehicle-pool */

    90

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

    91

    92

void VehicleServiceInDepot(Vehicle *v)

    93

{

    94

	v->date_of_last_service = _date;

    95

	v->breakdowns_since_last_service = 0;

    96

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

    97

}

    98

    99

bool VehicleNeedsService(const Vehicle *v)

   100

{

   101

	if (v->vehstatus & VS_CRASHED)

   102

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

   103

   104

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

   105

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

   106

	}

   107

   108

	return _patches.servint_ispercent ?

   109

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

   110

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

   111

}

   112

   113

StringID VehicleInTheWayErrMsg(const Vehicle* v)

   114

{

   115

	switch (v->type) {

   116

		case VEH_Train:    return STR_8803_TRAIN_IN_THE_WAY;

   117

		case VEH_Road:     return STR_9000_ROAD_VEHICLE_IN_THE_WAY;

   118

		case VEH_Aircraft: return STR_A015_AIRCRAFT_IN_THE_WAY;

   119

		default:           return STR_980E_SHIP_IN_THE_WAY;

   120

	}

   121

}

   122

   123

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

   124

{

   125

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

   126

		return NULL;

   127

   128

	_error_message = VehicleInTheWayErrMsg(v);

   129

	return v;

   130

}

   131

   132

bool EnsureNoVehicle(TileIndex tile)

   133

{

   134

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

   135

}

   136

   137

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

   138

{

   139

	const TileInfo *ti = data;

   140

   141

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

   142

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

   143

   144

	_error_message = VehicleInTheWayErrMsg(v);

   145

	return v;

   146

}

   147

   148

   149

bool EnsureNoVehicleOnGround(TileIndex tile)

   150

{

   151

	TileInfo ti;

   152

   153

	ti.tile = tile;

   154

	ti.z = GetTileMaxZ(tile);

   155

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

   156

}

   157

   158

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z)

   159

{

   160

	TileInfo ti;

   161

   162

	ti.tile = tile;

   163

	ti.z = z;

   164

   165

	return VehicleFromPos(tile, &ti, EnsureNoVehicleProcZ);

   166

}

   167

   168

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

   169

{

   170

	int x1 = TileX(from);

   171

	int y1 = TileY(from);

   172

	int x2 = TileX(to);

   173

	int y2 = TileY(to);

   174

	Vehicle *veh;

   175

   176

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

   177

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

   178

		intswap(x1,x2);

   179

		intswap(y1,y2);

   180

	}

   181

	FOR_ALL_VEHICLES(veh) {

   182

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

   183

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

   184

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

   185

				return veh;

   186

			}

   187

		}

   188

	}

   189

	return NULL;

   190

}

   191

   192

   193

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

   194

   195

void VehiclePositionChanged(Vehicle *v)

   196

{

   197

	int img = v->cur_image;

   198

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

   199

	const Sprite* spr = GetSprite(img);

   200

   201

	pt.x += spr->x_offs;

   202

	pt.y += spr->y_offs;

   203

   204

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

   205

   206

	v->left_coord = pt.x;

   207

	v->top_coord = pt.y;

   208

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

   209

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

   210

}

   211

   212

// Called after load to update coordinates

   213

void AfterLoadVehicles(void)

   214

{

   215

	Vehicle *v;

   216

   217

	FOR_ALL_VEHICLES(v) {

   218

		v->first = NULL;

   219

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

   220

	}

   221

   222

	FOR_ALL_VEHICLES(v) {

   223

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

   224

			TrainConsistChanged(v);

   225

	}

   226

   227

	FOR_ALL_VEHICLES(v) {

   228

		if (v->type != 0) {

   229

			switch (v->type) {

   230

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

   231

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

   232

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

   233

				case VEH_Aircraft:

   234

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

   235

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

   236

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

   237

					}

   238

					break;

   239

				default: break;

   240

			}

   241

   242

			v->left_coord = INVALID_COORD;

   243

			VehiclePositionChanged(v);

   244

		}

   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 = INVALID_VEHICLE;

   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

	FOR_ALL_VEHICLES(v) {

   288

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

   289

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

   290

			return NULL;

   291

   292

		if (v->type == 0)

   293

			return InitializeVehicle(v);

   294

	}

   295

   296

	return NULL;

   297

}

   298

   299

/*

   300

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

   301

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

   302

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

   303

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

   304

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

   305

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

   306

 */

   307

static Vehicle *AllocateSingleVehicle(VehicleID *skip_vehicles)

   308

{

   309

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

   310

	 * first blocks */

   311

	Vehicle *v;

   312

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

   313

   314

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

   315

		FOR_ALL_VEHICLES_FROM(v, offset + *skip_vehicles) {

   316

			(*skip_vehicles)++;

   317

			if (v->type == 0)

   318

				return InitializeVehicle(v);

   319

		}

   320

	}

   321

   322

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

   323

	if (AddBlockToPool(&_vehicle_pool))

   324

		return AllocateSingleVehicle(skip_vehicles);

   325

   326

	return NULL;

   327

}

   328

   329

   330

Vehicle *AllocateVehicle(void)

   331

{

   332

	VehicleID counter = 0;

   333

	return AllocateSingleVehicle(&counter);

   334

}

   335

   336

   337

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

   338

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

   339

* @param num number of vehicles to allocate room for

   340

*	returns true if there is room to allocate all the vehicles

   341

*/

   342

bool AllocateVehicles(Vehicle **vl, int num)

   343

{

   344

	int i;

   345

	Vehicle *v;

   346

	VehicleID counter = 0;

   347

   348

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

   349

		v = AllocateSingleVehicle(&counter);

   350

		if (v == NULL) {

   351

			return false;

   352

		}

   353

		if (vl != NULL) {

   354

			vl[i] = v;

   355

		}

   356

	}

   357

   358

	return true;

   359

}

   360

   361

   362

static VehicleID _vehicle_position_hash[0x1000];

   363

   364

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

   365

{

   366

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

   367

   368

	// The hash area to scan

   369

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

   370

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

   371

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

   372

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

   373

   374

	int x;

   375

	int y;

   376

   377

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

   378

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

   379

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

   380

   381

			while (veh != INVALID_VEHICLE) {

   382

				Vehicle *v = GetVehicle(veh);

   383

				void* a = proc(v, data);

   384

   385

				if (a != NULL) return a;

   386

				veh = v->next_hash;

   387

			}

   388

   389

			if (x == xu) break;

   390

		}

   391

   392

		if (y == yu) break;

   393

	}

   394

	return NULL;

   395

}

   396

   397

   398

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

   399

{

   400

	VehicleID *old_hash, *new_hash;

   401

	int old_x = v->left_coord;

   402

	int old_y = v->top_coord;

   403

	Vehicle *u;

   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

		VehicleID idx = *old_hash;

   414

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

   415

			idx = u->next_hash;

   416

			assert(idx != INVALID_VEHICLE);

   417

			last = u;

   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->index;

   431

	}

   432

}

   433

   434

void InitializeVehicles(void)

   435

{

   436

	uint i;

   437

   438

	/* Clean the vehicle pool, and reserve enough blocks

   439

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

   440

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

   441

	CleanPool(&_vehicle_pool);

   442

	AddBlockToPool(&_vehicle_pool);

   443

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

   444

		AddBlockToPool(&_vehicle_pool);

   445

   446

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

   447

		_vehicle_position_hash[i] = INVALID_VEHICLE;

   448

	}

   449

}

   450

   451

Vehicle *GetLastVehicleInChain(Vehicle *v)

   452

{

   453

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

   454

	return v;

   455

}

   456

   457

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

   458

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

   459

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

   460

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

   461

 * called by anything but GetFirstVehicleInChain

   462

 */

   463

static Vehicle *GetPrevVehicleInChain_bruteforce(const Vehicle *v)

   464

{

   465

	Vehicle *u;

   466

   467

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

   468

   469

	return NULL;

   470

}

   471

   472

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

   473

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

   474

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

   475

 */

   476

Vehicle *GetPrevVehicleInChain(const Vehicle *v)

   477

{

   478

	Vehicle *u;

   479

	assert(v != NULL);

   480

   481

	u = GetFirstVehicleInChain(v);

   482

   483

	// Check to see if this is the first

   484

	if (v == u) return NULL;

   485

   486

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

   487

   488

	return u;

   489

}

   490

   491

/** Finds the first vehicle in a chain.

   492

 * This function reads out the v->first cache. Should the cache be dirty,

   493

 * it determines the first vehicle in a chain, and updates the cache.