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, 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

void VehicleInTheWayErrMsg(const Vehicle* v)

   106

{

   107

	switch (v->type) {

   108

		case VEH_Train:    _error_message = STR_8803_TRAIN_IN_THE_WAY;        break;

   109

		case VEH_Road:     _error_message = STR_9000_ROAD_VEHICLE_IN_THE_WAY; break;

   110

		case VEH_Aircraft: _error_message = STR_A015_AIRCRAFT_IN_THE_WAY;     break;

   111

		default:           _error_message = STR_980E_SHIP_IN_THE_WAY;         break;

   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

	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 (!IS_INT_INSIDE(ti->z - v->z_pos, 0, 8 + 1)) return NULL;

   135

   136

	VehicleInTheWayErrMsg(v);

   137

	return v;

   138

}

   139

   140

static inline uint Correct_Z(uint tileh)

   141

{

   142

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

   143

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

   144

	return CorrectZ(tileh) ? 8 : 0;

   145

}

   146

   147

uint GetCorrectTileHeight(TileIndex tile)

   148

{

   149

	return Correct_Z(GetTileSlope(tile, NULL));

   150

}

   151

   152

bool EnsureNoVehicleZ(TileIndex tile, byte z)

   153

{

   154

	TileInfo ti;

   155

   156

	ti.tile = tile;

   157

	ti.z = z + GetCorrectTileHeight(tile);

   158

   159

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

   160

}

   161

   162

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z)

   163

{

   164

	TileInfo ti;

   165

   166

	ti.tile = tile;

   167

	ti.z = z;

   168

   169

	return VehicleFromPos(tile, &ti, EnsureNoVehicleProcZ);

   170

}

   171

   172

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

   173

{

   174

	int x1 = TileX(from);

   175

	int y1 = TileY(from);

   176

	int x2 = TileX(to);

   177

	int y2 = TileY(to);

   178

	Vehicle *veh;

   179

   180

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

   181

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

   182

		intswap(x1,x2);

   183

		intswap(y1,y2);

   184

	}

   185

	FOR_ALL_VEHICLES(veh) {

   186

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

   187

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

   188

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

   189

				return veh;

   190

			}

   191

		}

   192

	}

   193

	return NULL;

   194

}

   195

   196

   197

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

   198

   199

void VehiclePositionChanged(Vehicle *v)

   200

{

   201

	int img = v->cur_image;

   202

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

   203

	const Sprite* spr = GetSprite(img);

   204

   205

	pt.x += spr->x_offs;

   206

	pt.y += spr->y_offs;

   207

   208

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

   209

   210

	v->left_coord = pt.x;

   211

	v->top_coord = pt.y;

   212

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

   213

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

   214

}

   215

   216

// Called after load to update coordinates

   217

void AfterLoadVehicles(void)

   218

{

   219

	Vehicle *v;

   220

   221

	FOR_ALL_VEHICLES(v) {

   222

		v->first = NULL;

   223

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

   224

	}

   225

   226

	FOR_ALL_VEHICLES(v) {

   227

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

   228

			TrainConsistChanged(v);

   229

	}

   230

   231

	FOR_ALL_VEHICLES(v) {

   232

		if (v->type != 0) {

   233

			switch (v->type) {

   234

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

   235

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

   236

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

   237

				case VEH_Aircraft:

   238

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

   239

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

   240

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

   241

					}

   242

					break;

   243

				default: break;

   244

			}

   245

   246

			v->left_coord = INVALID_COORD;

   247

			VehiclePositionChanged(v);

   248

		}

   249

	}

   250

}

   251

   252

static Vehicle *InitializeVehicle(Vehicle *v)

   253

{

   254

	VehicleID index = v->index;

   255

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

   256

	v->index = index;

   257

   258

	assert(v->orders == NULL);

   259

   260

	v->left_coord = INVALID_COORD;

   261

	v->first = NULL;

   262

	v->next = NULL;

   263

	v->next_hash = INVALID_VEHICLE;

   264

	v->string_id = 0;

   265

	v->next_shared = NULL;

   266

	v->prev_shared = NULL;

   267

	v->depot_list  = NULL;

   268

	v->random_bits = 0;

   269

	return v;

   270

}

   271

   272

/**

   273

 * Get a value for a vehicle's random_bits.

   274

 * @return A random value from 0 to 255.

   275

 */

   276

byte VehicleRandomBits(void)

   277

{

   278

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

   279

}

   280

   281

Vehicle *ForceAllocateSpecialVehicle(void)

   282

{

   283

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

   284

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

   285

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

   286

	 * BLOCKS_FOR_SPECIAL_VEHICLES times block_size vehicles that may only

   287

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

   288

   289

	Vehicle *v;

   290

   291

	FOR_ALL_VEHICLES(v) {

   292

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

   293

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

   294

			return NULL;

   295

   296

		if (v->type == 0)

   297

			return InitializeVehicle(v);

   298

	}

   299

   300

	return NULL;

   301

}

   302

   303

/*

   304

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

   305

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

   306

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

   307

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

   308

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

   309

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

   310

 */

   311

static Vehicle *AllocateSingleVehicle(VehicleID *skip_vehicles)

   312

{

   313

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

   314

	 * first blocks */

   315

	Vehicle *v;

   316

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

   317

   318

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

   319

		FOR_ALL_VEHICLES_FROM(v, offset + *skip_vehicles) {

   320

			(*skip_vehicles)++;

   321

			if (v->type == 0)

   322

				return InitializeVehicle(v);

   323

		}

   324

	}

   325

   326

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

   327

	if (AddBlockToPool(&_vehicle_pool))

   328

		return AllocateSingleVehicle(skip_vehicles);

   329

   330

	return NULL;

   331

}

   332

   333

   334

Vehicle *AllocateVehicle(void)

   335

{

   336

	VehicleID counter = 0;

   337

	return AllocateSingleVehicle(&counter);

   338

}

   339

   340

   341

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

   342

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

   343

* @param num number of vehicles to allocate room for

   344

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

   345

*/

   346

bool AllocateVehicles(Vehicle **vl, int num)

   347

{

   348

	int i;

   349

	Vehicle *v;

   350

	VehicleID counter = 0;

   351

   352

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

   353

		v = AllocateSingleVehicle(&counter);

   354

		if (v == NULL) {

   355

			return false;

   356

		}

   357

		if (vl != NULL) {

   358

			vl[i] = v;

   359

		}

   360

	}

   361

   362

	return true;

   363

}

   364

   365

   366

static VehicleID _vehicle_position_hash[0x1000];

   367

   368

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

   369

{

   370

	int x,y,x2,y2;

   371

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

   372

   373

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

   374

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

   375

   376

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

   377

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

   378

   379

	for (;;) {

   380

		int xb = x;

   381

		for (;;) {

   382

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

   383

			while (veh != INVALID_VEHICLE) {

   384

				Vehicle *v = GetVehicle(veh);

   385

				void *a;

   386

   387

				a = proc(v, data);

   388

				if (a != NULL) return a;

   389

				veh = v->next_hash;

   390

			}

   391

   392

			if (x == x2)

   393

				break;

   394

   395

			x = (x + 1) & 0x3F;

   396

		}

   397

		x = xb;

   398

   399

		if (y == y2)

   400

			break;

   401

   402

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

   403

	}

   404

	return NULL;

   405

}

   406

   407

   408

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

   409

{

   410

	VehicleID *old_hash, *new_hash;

   411

	int old_x = v->left_coord;

   412

	int old_y = v->top_coord;

   413

	Vehicle *u;

   414

   415

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

   416

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

   417

   418

	if (old_hash == new_hash) return;

   419

   420

	/* remove from hash table? */

   421

	if (old_hash != NULL) {

   422

		Vehicle *last = NULL;

   423

		VehicleID idx = *old_hash;

   424

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

   425

			idx = u->next_hash;

   426

			assert(idx != INVALID_VEHICLE);

   427

			last = u;

   428

		}

   429

   430

		if (last == NULL) {

   431

			*old_hash = v->next_hash;

   432

		} else {

   433

			last->next_hash = v->next_hash;

   434

		}

   435

	}

   436

   437

	/* insert into hash table? */

   438

	if (new_hash != NULL) {

   439

		v->next_hash = *new_hash;

   440

		*new_hash = v->index;

   441

	}

   442

}

   443

   444

void InitializeVehicles(void)

   445

{

   446

	int i;

   447

   448

	/* Clean the vehicle pool, and reserve enough blocks

   449

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

   450

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

   451

	CleanPool(&_vehicle_pool);

   452

	AddBlockToPool(&_vehicle_pool);

   453

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

   454

		AddBlockToPool(&_vehicle_pool);

   455

   456

	// clear it...

   457

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

   458

}

   459

   460

Vehicle *GetLastVehicleInChain(Vehicle *v)

   461

{

   462

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

   463

	return v;

   464

}

   465

   466

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

   467

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

   468

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

   469

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

   470

 * called by anything but GetFirstVehicleInChain

   471

 */

   472

static Vehicle *GetPrevVehicleInChain_bruteforce(const Vehicle *v)

   473

{

   474

	Vehicle *u;

   475

   476

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

   477

   478

	return NULL;

   479

}

   480

   481

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

   482

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

   483

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

   484

 */

   485

Vehicle *GetPrevVehicleInChain(const Vehicle *v)

   486

{

   487

	Vehicle *u;

   488

	assert(v != NULL);

   489

   490

	u = GetFirstVehicleInChain(v);

   491

   492

 	// Check to see if this is the first

   493

	if (v == u) return NULL;

   494

   495

	do {

   496

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