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

    27

    28

#define INVALID_COORD (-0x8000)

    29

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

    30

    31

/*

    32

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

    33

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

    34

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

    35

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

    36

 */

    37

    38

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

    39

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

    40

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

    41

    42

static const uint32 _veh_build_proc_table[] = {

    43

	CMD_BUILD_RAIL_VEHICLE,

    44

	CMD_BUILD_ROAD_VEH,

    45

	CMD_BUILD_SHIP,

    46

	CMD_BUILD_AIRCRAFT,

    47

};

    48

static const uint32 _veh_sell_proc_table[] = {

    49

	CMD_SELL_RAIL_WAGON,

    50

	CMD_SELL_ROAD_VEH,

    51

	CMD_SELL_SHIP,

    52

	CMD_SELL_AIRCRAFT,

    53

};

    54

    55

static const uint32 _veh_refit_proc_table[] = {

    56

	CMD_REFIT_RAIL_VEHICLE,

    57

	0,	// road vehicles can't be refitted

    58

	CMD_REFIT_SHIP,

    59

	CMD_REFIT_AIRCRAFT,

    60

};

    61

    62

    63

enum {

    64

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

    65

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

    66

	VEHICLES_POOL_MAX_BLOCKS      = 125,

    67

    68

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

    69

};

    70

    71

/**

    72

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

    73

 */

    74

static void VehiclePoolNewBlock(uint start_item)

    75

{

    76

	Vehicle *v;

    77

    78

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

    79

}

    80

    81

/* Initialize the vehicle-pool */

    82

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

    83

    84

void VehicleServiceInDepot(Vehicle *v)

    85

{

    86

	v->date_of_last_service = _date;

    87

	v->breakdowns_since_last_service = 0;

    88

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

    89

}

    90

    91

bool VehicleNeedsService(const Vehicle *v)

    92

{

    93

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

    94

		return false;

    95

    96

	if (v->vehstatus & VS_CRASHED)

    97

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

    98

    99

	return _patches.servint_ispercent ?

   100

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

   101

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

   102

}

   103

   104

void VehicleInTheWayErrMsg(const Vehicle* v)

   105

{

   106

	switch (v->type) {

   107

		case VEH_Train:    _error_message = STR_8803_TRAIN_IN_THE_WAY;        break;

   108

		case VEH_Road:     _error_message = STR_9000_ROAD_VEHICLE_IN_THE_WAY; break;

   109

		case VEH_Aircraft: _error_message = STR_A015_AIRCRAFT_IN_THE_WAY;     break;

   110

		default:           _error_message = STR_980E_SHIP_IN_THE_WAY;         break;

   111

	}

   112

}

   113

   114

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

   115

{

   116

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

   117

		return NULL;

   118

   119

	VehicleInTheWayErrMsg(v);

   120

	return v;

   121

}

   122

   123

bool EnsureNoVehicle(TileIndex tile)

   124

{

   125

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

   126

}

   127

   128

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

   129

{

   130

	const TileInfo *ti = data;

   131

   132

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

   133

	if (!IS_INT_INSIDE(ti->z - v->z_pos, 0, 8 + 1)) return NULL;

   134

   135

	VehicleInTheWayErrMsg(v);

   136

	return v;

   137

}

   138

   139

static inline uint Correct_Z(uint tileh)

   140

{

   141

	// needs z correction for slope-type graphics that have the NORTHERN tile lowered

   142

	// 1, 2, 3, 4, 5, 6 and 7

   143

	return CorrectZ(tileh) ? 8 : 0;

   144

}

   145

   146

uint GetCorrectTileHeight(TileIndex tile)

   147

{

   148

	return Correct_Z(GetTileSlope(tile, NULL));

   149

}

   150

   151

bool EnsureNoVehicleZ(TileIndex tile, byte z)

   152

{

   153

	TileInfo ti;

   154

   155

	ti.tile = tile;

   156

	ti.z = z + GetCorrectTileHeight(tile);

   157

   158

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

   159

}

   160

   161

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z)

   162

{

   163

	TileInfo ti;

   164

   165

	ti.tile = tile;

   166

	ti.z = z;

   167

   168

	return VehicleFromPos(tile, &ti, EnsureNoVehicleProcZ);

   169

}

   170

   171

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

   172

{

   173

	int x1 = TileX(from);

   174

	int y1 = TileY(from);

   175

	int x2 = TileX(to);

   176

	int y2 = TileY(to);

   177

	Vehicle *veh;

   178

   179

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

   180

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

   181

		intswap(x1,x2);

   182

		intswap(y1,y2);

   183

	}

   184

	FOR_ALL_VEHICLES(veh) {

   185

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

   186

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

   187

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

   188

				return veh;

   189

			}

   190

		}

   191

	}

   192

	return NULL;

   193

}

   194

   195

   196

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

   197

   198

void VehiclePositionChanged(Vehicle *v)

   199

{

   200

	int img = v->cur_image;

   201

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

   202

	const Sprite* spr = GetSprite(img);

   203

   204

	pt.x += spr->x_offs;

   205

	pt.y += spr->y_offs;

   206

   207

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

   208

   209

	v->left_coord = pt.x;

   210

	v->top_coord = pt.y;

   211

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

   212

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

   213

}

   214

   215

// Called after load to update coordinates

   216

void AfterLoadVehicles(void)

   217

{

   218

	Vehicle *v;

   219

   220

	FOR_ALL_VEHICLES(v) {

   221

		v->first = NULL;

   222

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

   223

	}

   224

   225

	FOR_ALL_VEHICLES(v) {

   226

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

   227

			TrainConsistChanged(v);

   228

	}

   229

   230

	FOR_ALL_VEHICLES(v) {

   231

		if (v->type != 0) {

   232

			switch (v->type) {

   233

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

   234

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

   235

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

   236

				case VEH_Aircraft:

   237

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

   238

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

   239

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

   240

					}

   241

					break;

   242

				default: break;

   243

			}

   244

   245

			v->left_coord = INVALID_COORD;

   246

			VehiclePositionChanged(v);

   247

		}

   248

	}

   249

}

   250

   251

static Vehicle *InitializeVehicle(Vehicle *v)

   252

{

   253

	VehicleID index = v->index;

   254

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

   255

	v->index = index;

   256

   257

	assert(v->orders == NULL);

   258

   259

	v->left_coord = INVALID_COORD;

   260

	v->first = NULL;

   261

	v->next = NULL;

   262

	v->next_hash = INVALID_VEHICLE;

   263

	v->string_id = 0;

   264

	v->next_shared = NULL;

   265

	v->prev_shared = NULL;

   266

	v->depot_list  = NULL;

   267

	v->random_bits = 0;

   268

	return v;

   269

}

   270

   271

/**

   272

 * Get a value for a vehicle's random_bits.

   273

 * @return A random value from 0 to 255.

   274

 */

   275

byte VehicleRandomBits(void)

   276

{

   277

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

   278

}

   279

   280

Vehicle *ForceAllocateSpecialVehicle(void)

   281

{

   282

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

   283

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

   284

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

   285

	 * BLOCKS_FOR_SPECIAL_VEHICLES times block_size vehicles that may only

   286

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

   287

   288

	Vehicle *v;

   289

   290

	FOR_ALL_VEHICLES(v) {

   291

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

   292

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

   293

			return NULL;

   294

   295

		if (v->type == 0)

   296

			return InitializeVehicle(v);

   297

	}

   298

   299

	return NULL;

   300

}

   301

   302

/*

   303

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

   304

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

   305

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

   306

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

   307

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

   308

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

   309

 */

   310

static Vehicle *AllocateSingleVehicle(VehicleID *skip_vehicles)

   311

{

   312

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

   313

	 * first blocks */

   314

	Vehicle *v;

   315

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

   316

   317

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

   318

		FOR_ALL_VEHICLES_FROM(v, offset + *skip_vehicles) {

   319

			(*skip_vehicles)++;

   320

			if (v->type == 0)

   321

				return InitializeVehicle(v);

   322

		}

   323

	}

   324

   325

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

   326

	if (AddBlockToPool(&_vehicle_pool))

   327

		return AllocateSingleVehicle(skip_vehicles);

   328

   329

	return NULL;

   330

}

   331

   332

   333

Vehicle *AllocateVehicle(void)

   334

{

   335

	VehicleID counter = 0;

   336

	return AllocateSingleVehicle(&counter);

   337

}

   338

   339

   340

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

   341

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

   342

* @param num number of vehicles to allocate room for

   343

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

   344

*/

   345

bool AllocateVehicles(Vehicle **vl, int num)

   346

{

   347

	int i;

   348

	Vehicle *v;

   349

	VehicleID counter = 0;

   350

   351

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

   352

		v = AllocateSingleVehicle(&counter);

   353

		if (v == NULL) {

   354

			return false;

   355

		}

   356

		if (vl != NULL) {

   357

			vl[i] = v;

   358

		}

   359

	}

   360

   361

	return true;

   362

}

   363

   364

   365

static VehicleID _vehicle_position_hash[0x1000];

   366

   367

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

   368

{

   369

	int x,y,x2,y2;

   370

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

   371

   372

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

   373

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

   374

   375

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

   376

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

   377

   378

	for (;;) {

   379

		int xb = x;

   380

		for (;;) {

   381

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

   382

			while (veh != INVALID_VEHICLE) {

   383

				Vehicle *v = GetVehicle(veh);

   384

				void *a;

   385

   386

				a = proc(v, data);

   387

				if (a != NULL) return a;

   388

				veh = v->next_hash;

   389

			}

   390

   391

			if (x == x2)

   392

				break;

   393

   394

			x = (x + 1) & 0x3F;

   395

		}

   396

		x = xb;

   397

   398

		if (y == y2)

   399

			break;

   400

   401

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

   402

	}

   403

	return NULL;

   404

}

   405

   406

   407

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

   408

{

   409

	VehicleID *old_hash, *new_hash;

   410

	int old_x = v->left_coord;

   411

	int old_y = v->top_coord;

   412

	Vehicle *u;

   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

		VehicleID idx = *old_hash;

   423

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

   424

			idx = u->next_hash;

   425

			assert(idx != INVALID_VEHICLE);

   426

			last = u;

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

   440

	}

   441

}

   442

   443

void InitializeVehicles(void)

   444

{

   445

	int i;

   446

   447

	/* Clean the vehicle pool, and reserve enough blocks

   448

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

   449

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

   450

	CleanPool(&_vehicle_pool);

   451

	AddBlockToPool(&_vehicle_pool);

   452

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

   453

		AddBlockToPool(&_vehicle_pool);

   454

   455

	// clear it...

   456

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

   457

}

   458

   459

Vehicle *GetLastVehicleInChain(Vehicle *v)

   460

{

   461

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

   462

	return v;

   463

}

   464

   465

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

   466

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

   467

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

   468

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

   469

 * called by anything but GetFirstVehicleInChain

   470

 */

   471

static Vehicle *GetPrevVehicleInChain_bruteforce(const Vehicle *v)

   472

{

   473

	Vehicle *u;

   474

   475

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

   476

   477

	return NULL;

   478

}

   479

   480

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

   481

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

   482

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

   483

 */

   484

Vehicle *GetPrevVehicleInChain(const Vehicle *v)

   485

{

   486

	Vehicle *u;

   487

	assert(v != NULL);

   488

   489

	u = GetFirstVehicleInChain(v);

   490

   491

 	// Check to see if this is the first

   492

	if (v == u) return NULL;

   493

   494

	do {

   495

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

   496

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