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

    27

#define INVALID_COORD (-0x8000)

    28

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

    29

    30

/*

    31

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

    32

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

    33

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

    34

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

    35

 */

    36

    37

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

    38

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

    39

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

    40

    41

static const uint32 _veh_build_proc_table[] = {

    42

	CMD_BUILD_RAIL_VEHICLE,

    43

	CMD_BUILD_ROAD_VEH,

    44

	CMD_BUILD_SHIP,

    45

	CMD_BUILD_AIRCRAFT,

    46

};

    47

static const uint32 _veh_sell_proc_table[] = {

    48

	CMD_SELL_RAIL_WAGON,

    49

	CMD_SELL_ROAD_VEH,

    50

	CMD_SELL_SHIP,

    51

	CMD_SELL_AIRCRAFT,

    52

};

    53

    54

static const uint32 _veh_refit_proc_table[] = {

    55

	CMD_REFIT_RAIL_VEHICLE,

    56

	0,	// road vehicles can't be refitted

    57

	CMD_REFIT_SHIP,

    58

	CMD_REFIT_AIRCRAFT,

    59

};

    60

    61

    62

enum {

    63

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

    64

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

    65

	VEHICLES_POOL_MAX_BLOCKS      = 125,

    66

    67

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

    68

};

    69

    70

/**

    71

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

    72

 */

    73

static void VehiclePoolNewBlock(uint start_item)

    74

{

    75

	Vehicle *v;

    76

    77

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

    78

}

    79

    80

/* Initialize the vehicle-pool */

    81

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

    82

    83

void VehicleServiceInDepot(Vehicle *v)

    84

{

    85

	v->date_of_last_service = _date;

    86

	v->breakdowns_since_last_service = 0;

    87

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

    88

}

    89

    90

bool VehicleNeedsService(const Vehicle *v)

    91

{

    92

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

    93

		return false;

    94

    95

	if (v->vehstatus & VS_CRASHED)

    96

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

    97

    98

	return _patches.servint_ispercent ?

    99

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

   100

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

   101

}

   102

   103

void VehicleInTheWayErrMsg(const Vehicle* v)

   104

{

   105

	switch (v->type) {

   106

		case VEH_Train:    _error_message = STR_8803_TRAIN_IN_THE_WAY;        break;

   107

		case VEH_Road:     _error_message = STR_9000_ROAD_VEHICLE_IN_THE_WAY; break;

   108

		case VEH_Aircraft: _error_message = STR_A015_AIRCRAFT_IN_THE_WAY;     break;

   109

		default:           _error_message = STR_980E_SHIP_IN_THE_WAY;         break;

   110

	}

   111

}

   112

   113

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

   114

{

   115

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

   116

		return NULL;

   117

   118

	VehicleInTheWayErrMsg(v);

   119

	return v;

   120

}

   121

   122

bool EnsureNoVehicle(TileIndex tile)

   123

{

   124

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

   125

}

   126

   127

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

   128

{

   129

	const TileInfo *ti = data;

   130

   131

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

   132

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

   133

   134

	VehicleInTheWayErrMsg(v);

   135

	return v;

   136

}

   137

   138

static inline uint Correct_Z(uint tileh)

   139

{

   140

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

   141

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

   142

	return CorrectZ(tileh) ? 8 : 0;

   143

}

   144

   145

uint GetCorrectTileHeight(TileIndex tile)

   146

{

   147

	return Correct_Z(GetTileSlope(tile, NULL));

   148

}

   149

   150

bool EnsureNoVehicleZ(TileIndex tile, byte z)

   151

{

   152

	TileInfo ti;

   153

   154

	ti.tile = tile;

   155

	ti.z = z + GetCorrectTileHeight(tile);

   156

   157

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

   158

}

   159

   160

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z)

   161

{

   162

	TileInfo ti;

   163

   164

	ti.tile = tile;

   165

	ti.z = z;

   166

   167

	return VehicleFromPos(tile, &ti, EnsureNoVehicleProcZ);

   168

}

   169

   170

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

   171

{

   172

	int x1 = TileX(from);

   173

	int y1 = TileY(from);

   174

	int x2 = TileX(to);

   175

	int y2 = TileY(to);

   176

	Vehicle *veh;

   177

   178

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

   179

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

   180

		intswap(x1,x2);

   181

		intswap(y1,y2);

   182

	}

   183

	FOR_ALL_VEHICLES(veh) {

   184

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

   185

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

   186

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

   187

				return veh;

   188

			}

   189

		}

   190

	}

   191

	return NULL;

   192

}

   193

   194

   195

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

   196

   197

void VehiclePositionChanged(Vehicle *v)

   198

{

   199

	int img = v->cur_image;

   200

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

   201

	const Sprite* spr = GetSprite(img);

   202

   203

	pt.x += spr->x_offs;

   204

	pt.y += spr->y_offs;

   205

   206

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

   207

   208

	v->left_coord = pt.x;

   209

	v->top_coord = pt.y;

   210

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

   211

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

   212

}

   213

   214

// Called after load to update coordinates

   215

void AfterLoadVehicles(void)

   216

{

   217

	Vehicle *v;

   218

   219

	FOR_ALL_VEHICLES(v) {

   220

		v->first = NULL;

   221

		if (v->type != 0) {

   222

			switch (v->type) {

   223

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

   224

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

   225

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

   226

				case VEH_Aircraft:

   227

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

   228

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

   229

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

   230

					}

   231

					break;

   232

				default: break;

   233

			}

   234

   235

			v->left_coord = INVALID_COORD;

   236

			VehiclePositionChanged(v);

   237

   238

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

   239

				TrainConsistChanged(v);

   240

		}

   241

	}

   242

}

   243

   244

static Vehicle *InitializeVehicle(Vehicle *v)

   245

{

   246

	VehicleID index = v->index;

   247

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

   248

	v->index = index;

   249

   250

	assert(v->orders == NULL);

   251

   252

	v->left_coord = INVALID_COORD;

   253

	v->first = NULL;

   254

	v->next = NULL;

   255

	v->next_hash = INVALID_VEHICLE;

   256

	v->string_id = 0;

   257

	v->next_shared = NULL;

   258

	v->prev_shared = NULL;

   259

	v->depot_list  = NULL;

   260

	v->random_bits = 0;

   261

	return v;

   262

}

   263

   264

/**

   265

 * Get a value for a vehicle's random_bits.

   266

 * @return A random value from 0 to 255.

   267

 */

   268

byte VehicleRandomBits(void)

   269

{

   270

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

   271

}

   272

   273

Vehicle *ForceAllocateSpecialVehicle(void)

   274

{

   275

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

   276

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

   277

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

   278

	 * BLOCKS_FOR_SPECIAL_VEHICLES times block_size vehicles that may only

   279

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

   280

   281

	Vehicle *v;

   282

   283

	FOR_ALL_VEHICLES(v) {

   284

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

   285

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

   286

			return NULL;

   287

   288

		if (v->type == 0)

   289

			return InitializeVehicle(v);

   290

	}

   291

   292

	return NULL;

   293

}

   294

   295

/*

   296

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

   297

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

   298

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

   299

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

   300

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

   301

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

   302

 */

   303

static Vehicle *AllocateSingleVehicle(VehicleID *skip_vehicles)

   304

{

   305

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

   306

	 * first blocks */

   307

	Vehicle *v;

   308

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

   309

   310

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

   311

		FOR_ALL_VEHICLES_FROM(v, offset + *skip_vehicles) {

   312

			(*skip_vehicles)++;

   313

			if (v->type == 0)

   314

				return InitializeVehicle(v);

   315

		}

   316

	}

   317

   318

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

   319

	if (AddBlockToPool(&_vehicle_pool))

   320

		return AllocateSingleVehicle(skip_vehicles);

   321

   322

	return NULL;

   323

}

   324

   325

   326

Vehicle *AllocateVehicle(void)

   327

{

   328

	VehicleID counter = 0;

   329

	return AllocateSingleVehicle(&counter);

   330

}

   331

   332

   333

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

   334

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

   335

* @param num number of vehicles to allocate room for

   336

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

   337

*/

   338

bool AllocateVehicles(Vehicle **vl, int num)

   339

{

   340

	int i;

   341

	Vehicle *v;

   342

	VehicleID counter = 0;

   343

   344

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

   345

		v = AllocateSingleVehicle(&counter);

   346

		if (v == NULL) {

   347

			return false;

   348

		}

   349

		if (vl != NULL) {

   350

			vl[i] = v;

   351

		}

   352

	}

   353

   354

	return true;

   355

}

   356

   357

   358

static VehicleID _vehicle_position_hash[0x1000];

   359

   360

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

   361

{

   362

	int x,y,x2,y2;

   363

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

   364

   365

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

   366

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

   367

   368

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

   369

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

   370

   371

	for (;;) {

   372

		int xb = x;

   373

		for (;;) {

   374

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

   375

			while (veh != INVALID_VEHICLE) {

   376

				Vehicle *v = GetVehicle(veh);

   377

				void *a;

   378

   379

				a = proc(v, data);

   380

				if (a != NULL) return a;

   381

				veh = v->next_hash;

   382

			}

   383

   384

			if (x == x2)

   385

				break;

   386

   387

			x = (x + 1) & 0x3F;

   388

		}

   389

		x = xb;

   390

   391

		if (y == y2)

   392

			break;

   393

   394

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

   395

	}

   396

	return NULL;

   397

}

   398

   399

   400

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

   401

{

   402

	VehicleID *old_hash, *new_hash;

   403

	int old_x = v->left_coord;

   404

	int old_y = v->top_coord;

   405

	Vehicle *u;

   406

   407

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

   408

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

   409

   410

	if (old_hash == new_hash) return;

   411

   412

	/* remove from hash table? */

   413

	if (old_hash != NULL) {

   414

		Vehicle *last = NULL;

   415

		VehicleID idx = *old_hash;

   416

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

   417

			idx = u->next_hash;

   418

			assert(idx != INVALID_VEHICLE);

   419

			last = u;

   420

		}

   421

   422

		if (last == NULL) {

   423

			*old_hash = v->next_hash;

   424

		} else {

   425

			last->next_hash = v->next_hash;

   426

		}

   427

	}

   428

   429

	/* insert into hash table? */

   430

	if (new_hash != NULL) {

   431

		v->next_hash = *new_hash;

   432

		*new_hash = v->index;

   433

	}

   434

}

   435

   436

void InitializeVehicles(void)

   437

{

   438

	int i;

   439

   440

	/* Clean the vehicle pool, and reserve enough blocks

   441

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

   442

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

   443

	CleanPool(&_vehicle_pool);

   444

	AddBlockToPool(&_vehicle_pool);

   445

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

   446

		AddBlockToPool(&_vehicle_pool);

   447

   448

	// clear it...

   449

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

   450

}

   451

   452

Vehicle *GetLastVehicleInChain(Vehicle *v)

   453

{

   454

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

   455

	return v;

   456

}

   457

   458

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

   459

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

   460

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

   461

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

   462

 * called by anything but GetFirstVehicleInChain

   463

 */

   464

static Vehicle *GetPrevVehicleInChain_bruteforce(const Vehicle *v)

   465

{

   466

	Vehicle *u;

   467

   468

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

   469

   470

	return NULL;

   471

}

   472

   473

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

   474

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

   475

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

   476

 */

   477

Vehicle *GetPrevVehicleInChain(const Vehicle *v)

   478

{

   479

	Vehicle *u;

   480

	assert(v != NULL);

   481

   482

	u = GetFirstVehicleInChain(v);

   483

   484

 	// Check to see if this is the first

   485

	if (v == u) return NULL;

   486

   487

	do {

   488

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

   489

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

   490

   491

	return NULL;

   492

}

   493

   494

/** Finds the first vehicle in a chain.

   495

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

   496

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