1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "spritecache.h"

     6

#include "table/sprites.h"

     7

#include "table/strings.h"

     8

#include "functions.h"

     9

#include "map.h"

    10

#include "tile.h"

    11

#include "vehicle.h"

    12

#include "gfx.h"

    13

#include "viewport.h"

    14

#include "news.h"

    15

#include "command.h"

    16

#include "saveload.h"

    17

#include "player.h"

    18

#include "engine.h"

    19

#include "sound.h"

    20

#include "debug.h"

    21

#include "vehicle_gui.h"

    22

#include "depot.h"

    23

#include "station.h"

    24

#include "rail.h"

    25

#include "train.h"

    26

#include "industry_map.h"

    27

#include "station_map.h"

    28

    29

#define INVALID_COORD (-0x8000)

    30

#define GEN_HASH(x,y) (((x & 0x1F80)>>7) + ((y & 0xFC0)))

    31

    32

/*

    33

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

    34

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

    35

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

    36

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

    37

 */

    38

    39

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

    40

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

    41

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

    42

    43

static const uint32 _veh_build_proc_table[] = {

    44

	CMD_BUILD_RAIL_VEHICLE,

    45

	CMD_BUILD_ROAD_VEH,

    46

	CMD_BUILD_SHIP,

    47

	CMD_BUILD_AIRCRAFT,

    48

};

    49

static const uint32 _veh_sell_proc_table[] = {

    50

	CMD_SELL_RAIL_WAGON,

    51

	CMD_SELL_ROAD_VEH,

    52

	CMD_SELL_SHIP,

    53

	CMD_SELL_AIRCRAFT,

    54

};

    55

    56

static const uint32 _veh_refit_proc_table[] = {

    57

	CMD_REFIT_RAIL_VEHICLE,

    58

	0,	// road vehicles can't be refitted

    59

	CMD_REFIT_SHIP,

    60

	CMD_REFIT_AIRCRAFT,

    61

};

    62

    63

    64

enum {

    65

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

    66

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

    67

	VEHICLES_POOL_MAX_BLOCKS      = 125,

    68

    69

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

    70

};

    71

    72

/**

    73

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

    74

 */

    75

static void VehiclePoolNewBlock(uint start_item)

    76

{

    77

	Vehicle *v;

    78

    79

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

    80

}

    81

    82

/* Initialize the vehicle-pool */

    83

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

    84

    85

void VehicleServiceInDepot(Vehicle *v)

    86

{

    87

	v->date_of_last_service = _date;

    88

	v->breakdowns_since_last_service = 0;

    89

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

    90

}

    91

    92

bool VehicleNeedsService(const Vehicle *v)

    93

{

    94

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

    95

		return false;

    96

    97

	if (v->vehstatus & VS_CRASHED)

    98

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

    99

   100

	return _patches.servint_ispercent ?

   101

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

   102

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

   103

}

   104

   105

StringID VehicleInTheWayErrMsg(const Vehicle* v)

   106

{

   107

	switch (v->type) {

   108

		case VEH_Train:    return STR_8803_TRAIN_IN_THE_WAY;

   109

		case VEH_Road:     return STR_9000_ROAD_VEHICLE_IN_THE_WAY;

   110

		case VEH_Aircraft: return STR_A015_AIRCRAFT_IN_THE_WAY;

   111

		default:           return STR_980E_SHIP_IN_THE_WAY;

   112

	}

   113

}

   114

   115

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

   116

{

   117

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

   118

		return NULL;

   119

   120

	_error_message = VehicleInTheWayErrMsg(v);

   121

	return v;

   122

}

   123

   124

bool EnsureNoVehicle(TileIndex tile)

   125

{

   126

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

   127

}

   128

   129

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

   130

{

   131

	const TileInfo *ti = data;

   132

   133

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

   134

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

   135

   136

	_error_message = VehicleInTheWayErrMsg(v);

   137

	return v;

   138

}

   139

   140

   141

bool EnsureNoVehicleOnGround(TileIndex tile)

   142

{

   143

	TileInfo ti;

   144

   145

	ti.tile = tile;

   146

	ti.z = GetTileMaxZ(tile);

   147

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

   148

}

   149

   150

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z)

   151

{

   152

	TileInfo ti;

   153

   154

	ti.tile = tile;

   155

	ti.z = z;

   156

   157

	return VehicleFromPos(tile, &ti, EnsureNoVehicleProcZ);

   158

}

   159

   160

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

   161

{

   162

	int x1 = TileX(from);

   163

	int y1 = TileY(from);

   164

	int x2 = TileX(to);

   165

	int y2 = TileY(to);

   166

	Vehicle *veh;

   167

   168

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

   169

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

   170

		intswap(x1,x2);

   171

		intswap(y1,y2);

   172

	}

   173

	FOR_ALL_VEHICLES(veh) {

   174

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

   175

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

   176

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

   177

				return veh;

   178

			}

   179

		}

   180

	}

   181

	return NULL;

   182

}

   183

   184

   185

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

   186

   187

void VehiclePositionChanged(Vehicle *v)

   188

{

   189

	int img = v->cur_image;

   190

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

   191

	const Sprite* spr = GetSprite(img);

   192

   193

	pt.x += spr->x_offs;

   194

	pt.y += spr->y_offs;

   195

   196

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

   197

   198

	v->left_coord = pt.x;

   199

	v->top_coord = pt.y;

   200

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

   201

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

   202

}

   203

   204

// Called after load to update coordinates

   205

void AfterLoadVehicles(void)

   206

{

   207

	Vehicle *v;

   208

   209

	FOR_ALL_VEHICLES(v) {

   210

		v->first = NULL;

   211

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

   212

	}

   213

   214

	FOR_ALL_VEHICLES(v) {

   215

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

   216

			TrainConsistChanged(v);

   217

	}

   218

   219

	FOR_ALL_VEHICLES(v) {

   220

		if (v->type != 0) {

   221

			switch (v->type) {

   222

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

   223

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

   224

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

   225

				case VEH_Aircraft:

   226

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

   227

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

   228

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

   229

					}

   230

					break;

   231

				default: break;

   232

			}

   233

   234

			v->left_coord = INVALID_COORD;

   235

			VehiclePositionChanged(v);

   236

		}

   237

	}

   238

}

   239

   240

static Vehicle *InitializeVehicle(Vehicle *v)

   241

{

   242

	VehicleID index = v->index;

   243

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

   244

	v->index = index;

   245

   246

	assert(v->orders == NULL);

   247

   248

	v->left_coord = INVALID_COORD;

   249

	v->first = NULL;

   250

	v->next = NULL;

   251

	v->next_hash = INVALID_VEHICLE;

   252

	v->string_id = 0;

   253

	v->next_shared = NULL;

   254

	v->prev_shared = NULL;

   255

	v->depot_list  = NULL;

   256

	v->random_bits = 0;

   257

	return v;

   258

}

   259

   260

/**

   261

 * Get a value for a vehicle's random_bits.

   262

 * @return A random value from 0 to 255.

   263

 */

   264

byte VehicleRandomBits(void)

   265

{

   266

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

   267

}

   268

   269

Vehicle *ForceAllocateSpecialVehicle(void)

   270

{

   271

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

   272

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

   273

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

   274

	 * BLOCKS_FOR_SPECIAL_VEHICLES times block_size vehicles that may only

   275

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

   276

   277

	Vehicle *v;

   278

   279

	FOR_ALL_VEHICLES(v) {

   280

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

   281

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

   282

			return NULL;

   283

   284

		if (v->type == 0)

   285

			return InitializeVehicle(v);

   286

	}

   287

   288

	return NULL;

   289

}

   290

   291

/*

   292

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

   293

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

   294

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

   295

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

   296

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

   297

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

   298

 */

   299

static Vehicle *AllocateSingleVehicle(VehicleID *skip_vehicles)

   300

{

   301

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

   302

	 * first blocks */

   303

	Vehicle *v;

   304

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

   305

   306

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

   307

		FOR_ALL_VEHICLES_FROM(v, offset + *skip_vehicles) {

   308

			(*skip_vehicles)++;

   309

			if (v->type == 0)

   310

				return InitializeVehicle(v);

   311

		}

   312

	}

   313

   314

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

   315

	if (AddBlockToPool(&_vehicle_pool))

   316

		return AllocateSingleVehicle(skip_vehicles);

   317

   318

	return NULL;

   319

}

   320

   321

   322

Vehicle *AllocateVehicle(void)

   323

{

   324

	VehicleID counter = 0;

   325

	return AllocateSingleVehicle(&counter);

   326

}

   327

   328

   329

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

   330

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

   331

* @param num number of vehicles to allocate room for

   332

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

   333

*/

   334

bool AllocateVehicles(Vehicle **vl, int num)

   335

{

   336

	int i;

   337

	Vehicle *v;

   338

	VehicleID counter = 0;

   339

   340

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

   341

		v = AllocateSingleVehicle(&counter);

   342

		if (v == NULL) {

   343

			return false;

   344

		}

   345

		if (vl != NULL) {

   346

			vl[i] = v;

   347

		}

   348

	}

   349

   350

	return true;

   351

}

   352

   353

   354

static VehicleID _vehicle_position_hash[0x1000];

   355

   356

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

   357

{

   358

	int x,y,x2,y2;

   359

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

   360

   361

	x2 = ((pt.x + 104) & 0x1F80) >> 7;

   362

	x  = ((pt.x - 174) & 0x1F80) >> 7;

   363

   364

	y2 = ((pt.y + 56) & 0xFC0);

   365

	y  = ((pt.y - 294) & 0xFC0);

   366

   367

	for (;;) {

   368

		int xb = x;

   369

		for (;;) {

   370

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

   371

			while (veh != INVALID_VEHICLE) {

   372

				Vehicle *v = GetVehicle(veh);

   373

				void *a;

   374

   375

				a = proc(v, data);

   376

				if (a != NULL) return a;

   377

				veh = v->next_hash;

   378

			}

   379

   380

			if (x == x2)

   381

				break;

   382

   383

			x = (x + 1) & 0x3F;

   384

		}

   385

		x = xb;

   386

   387

		if (y == y2)

   388

			break;

   389

   390

		y = (y + 0x40) & ((0x3F) << 6);

   391

	}

   392

	return NULL;

   393

}

   394

   395

   396

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

   397

{

   398

	VehicleID *old_hash, *new_hash;

   399

	int old_x = v->left_coord;

   400

	int old_y = v->top_coord;

   401

	Vehicle *u;

   402

   403

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

   404

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

   405

   406

	if (old_hash == new_hash) return;

   407

   408

	/* remove from hash table? */

   409

	if (old_hash != NULL) {

   410

		Vehicle *last = NULL;

   411

		VehicleID idx = *old_hash;

   412

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

   413

			idx = u->next_hash;

   414

			assert(idx != INVALID_VEHICLE);

   415

			last = u;

   416

		}

   417

   418

		if (last == NULL) {

   419

			*old_hash = v->next_hash;

   420

		} else {

   421

			last->next_hash = v->next_hash;

   422

		}

   423

	}

   424

   425

	/* insert into hash table? */

   426

	if (new_hash != NULL) {

   427

		v->next_hash = *new_hash;

   428

		*new_hash = v->index;

   429

	}

   430

}

   431

   432

void InitializeVehicles(void)

   433

{

   434

	int i;

   435

   436

	/* Clean the vehicle pool, and reserve enough blocks

   437

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

   438

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

   439

	CleanPool(&_vehicle_pool);

   440

	AddBlockToPool(&_vehicle_pool);

   441

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

   442

		AddBlockToPool(&_vehicle_pool);

   443

   444

	// clear it...

   445

	memset(_vehicle_position_hash, -1, sizeof(_vehicle_position_hash));

   446

}

   447

   448

Vehicle *GetLastVehicleInChain(Vehicle *v)

   449

{

   450

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

   451

	return v;

   452

}

   453

   454

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

   455

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

   456

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

   457

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

   458

 * called by anything but GetFirstVehicleInChain

   459

 */

   460

static Vehicle *GetPrevVehicleInChain_bruteforce(const Vehicle *v)

   461

{

   462

	Vehicle *u;

   463

   464

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

   465

   466

	return NULL;

   467

}

   468

   469

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

   470

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

   471

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

   472

 */

   473

Vehicle *GetPrevVehicleInChain(const Vehicle *v)

   474

{

   475

	Vehicle *u;

   476

	assert(v != NULL);

   477

   478

	u = GetFirstVehicleInChain(v);

   479

   480

 	// Check to see if this is the first

   481

	if (v == u) return NULL;

   482

   483

	do {

   484

		if (u->next == v) return u;

   485

	} while ( ( u = u->next) != NULL);

   486

   487

	return NULL;

   488

}

   489

   490

/** Finds the first vehicle in a chain.

   491

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

   492

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

   493

 */

   494

Vehicle *GetFirstVehicleInChain(const Vehicle *v)

   495

{