1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "debug.h"

     6

#include "functions.h"

     7

#include "player.h"

     8

#include "station.h"

     9

#include "strings.h"

    10

#include "table/sprites.h"

    11

#include "table/strings.h"

    12

#include "vehicle.h"

    13

#include "window.h"

    14

#include "engine.h"

    15

#include "gui.h"

    16

#include "command.h"

    17

#include "gfx.h"

    18

#include "variables.h"

    19

#include "vehicle_gui.h"

    20

#include "viewport.h"

    21

#include "train.h"

    22

    23

Sorting _sorting;

    24

    25

static uint32 _internal_name_sorter_id; // internal StringID for default vehicle-names

    26

static uint32 _last_vehicle_idx;        // cached index to hopefully speed up name-sorting

    27

static bool   _internal_sort_order;     // descending/ascending

    28

    29

static uint16 _player_num_engines[TOTAL_NUM_ENGINES];

    30

static RailType _railtype_selected_in_replace_gui;

    31

    32

    33

typedef int CDECL VehicleSortListingTypeFunction(const void*, const void*);

    34

    35

static VehicleSortListingTypeFunction VehicleUnsortedSorter;

    36

static VehicleSortListingTypeFunction VehicleNumberSorter;

    37

static VehicleSortListingTypeFunction VehicleNameSorter;

    38

static VehicleSortListingTypeFunction VehicleAgeSorter;

    39

static VehicleSortListingTypeFunction VehicleProfitThisYearSorter;

    40

static VehicleSortListingTypeFunction VehicleProfitLastYearSorter;

    41

static VehicleSortListingTypeFunction VehicleCargoSorter;

    42

static VehicleSortListingTypeFunction VehicleReliabilitySorter;

    43

static VehicleSortListingTypeFunction VehicleMaxSpeedSorter;

    44

    45

static VehicleSortListingTypeFunction* const _vehicle_sorter[] = {

    46

	&VehicleUnsortedSorter,

    47

	&VehicleNumberSorter,

    48

	&VehicleNameSorter,

    49

	&VehicleAgeSorter,

    50

	&VehicleProfitThisYearSorter,

    51

	&VehicleProfitLastYearSorter,

    52

	&VehicleCargoSorter,

    53

	&VehicleReliabilitySorter,

    54

	&VehicleMaxSpeedSorter

    55

};

    56

    57

const StringID _vehicle_sort_listing[] = {

    58

	STR_SORT_BY_UNSORTED,

    59

	STR_SORT_BY_NUMBER,

    60

	STR_SORT_BY_DROPDOWN_NAME,

    61

	STR_SORT_BY_AGE,

    62

	STR_SORT_BY_PROFIT_THIS_YEAR,

    63

	STR_SORT_BY_PROFIT_LAST_YEAR,

    64

	STR_SORT_BY_TOTAL_CAPACITY_PER_CARGOTYPE,

    65

	STR_SORT_BY_RELIABILITY,

    66

	STR_SORT_BY_MAX_SPEED,

    67

	INVALID_STRING_ID

    68

};

    69

    70

static const StringID _rail_types_list[] = {

    71

	STR_RAIL_VEHICLES,

    72

	STR_MONORAIL_VEHICLES,

    73

	STR_MAGLEV_VEHICLES,

    74

	INVALID_STRING_ID

    75

};

    76

    77

void RebuildVehicleLists(void)

    78

{

    79

	Window *w;

    80

    81

	for (w = _windows; w != _last_window; ++w)

    82

		switch (w->window_class) {

    83

		case WC_TRAINS_LIST: case WC_ROADVEH_LIST:

    84

		case WC_SHIPS_LIST:  case WC_AIRCRAFT_LIST:

    85

			WP(w, vehiclelist_d).flags |= VL_REBUILD;

    86

			SetWindowDirty(w);

    87

			break;

    88

		default: break;

    89

		}

    90

}

    91

    92

void ResortVehicleLists(void)

    93

{

    94

	Window *w;

    95

    96

	for (w = _windows; w != _last_window; ++w)

    97

		switch (w->window_class) {

    98

		case WC_TRAINS_LIST: case WC_ROADVEH_LIST:

    99

		case WC_SHIPS_LIST:  case WC_AIRCRAFT_LIST:

   100

			WP(w, vehiclelist_d).flags |= VL_RESORT;

   101

			SetWindowDirty(w);

   102

			break;

   103

		default: break;

   104

		}

   105

}

   106

   107

void BuildVehicleList(vehiclelist_d* vl, int type, PlayerID owner, StationID station)

   108

{

   109

	uint subtype = (type != VEH_Aircraft) ? Train_Front : 2;

   110

	uint n = 0;

   111

	uint i;

   112

   113

	if (!(vl->flags & VL_REBUILD)) return;

   114

   115

	/* Create array for sorting */

   116

	_vehicle_sort = realloc(_vehicle_sort, GetVehiclePoolSize() * sizeof(_vehicle_sort[0]));

   117

	if (_vehicle_sort == NULL)

   118

		error("Could not allocate memory for the vehicle-sorting-list");

   119

   120

	DEBUG(misc, 1) ("Building vehicle list for player %d station %d...",

   121

		owner, station);

   122

   123

	if (station != INVALID_STATION) {

   124

		const Vehicle *v;

   125

		FOR_ALL_VEHICLES(v) {

   126

			if (v->type == type && (

   127

				(type == VEH_Train && IsFrontEngine(v)) ||

   128

				(type != VEH_Train && v->subtype <= subtype))) {

   129

				const Order *order;

   130

   131

				FOR_VEHICLE_ORDERS(v, order) {

   132

					if (order->type == OT_GOTO_STATION && order->station == station) {

   133

						_vehicle_sort[n].index = v->index;

   134

						_vehicle_sort[n].owner = v->owner;

   135

						++n;

   136

						break;

   137

					}

   138

				}

   139

			}

   140

		}

   141

	} else {

   142

		const Vehicle *v;

   143

		FOR_ALL_VEHICLES(v) {

   144

			if (v->type == type && v->owner == owner && (

   145

				(type == VEH_Train && IsFrontEngine(v)) ||

   146

				(type != VEH_Train && v->subtype <= subtype))) {

   147

				_vehicle_sort[n].index = v->index;

   148

				_vehicle_sort[n].owner = v->owner;

   149

				++n;

   150

			}

   151

		}

   152

	}

   153

   154

	free(vl->sort_list);

   155

	vl->sort_list = malloc(n * sizeof(vl->sort_list[0]));

   156

	if (n != 0 && vl->sort_list == NULL)

   157

		error("Could not allocate memory for the vehicle-sorting-list");

   158

	vl->list_length = n;

   159

   160

	for (i = 0; i < n; ++i) vl->sort_list[i] = _vehicle_sort[i];

   161

   162

	vl->flags &= ~VL_REBUILD;

   163

	vl->flags |= VL_RESORT;

   164

}

   165

   166

void SortVehicleList(vehiclelist_d *vl)

   167

{

   168

	if (!(vl->flags & VL_RESORT)) return;

   169

   170

	_internal_sort_order = vl->flags & VL_DESC;

   171

	_internal_name_sorter_id = STR_SV_TRAIN_NAME;

   172

	_last_vehicle_idx = 0; // used for "cache" in namesorting

   173

	qsort(vl->sort_list, vl->list_length, sizeof(vl->sort_list[0]),

   174

		_vehicle_sorter[vl->sort_type]);

   175

   176

	vl->resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   177

	vl->flags &= ~VL_RESORT;

   178

}

   179

   180

   181

/* General Vehicle GUI based procedures that are independent of vehicle types */

   182

void InitializeVehiclesGuiList(void)

   183

{

   184

	_railtype_selected_in_replace_gui = RAILTYPE_RAIL;

   185

}

   186

   187

// draw the vehicle profit button in the vehicle list window.

   188

void DrawVehicleProfitButton(const Vehicle *v, int x, int y)

   189

{

   190

	uint32 ormod;

   191

   192

	// draw profit-based colored icons

   193

	if (v->age <= 365 * 2) {

   194

		ormod = PALETTE_TO_GREY;

   195

	} else if (v->profit_last_year < 0) {

   196

		ormod = PALETTE_TO_RED;

   197

	} else if (v->profit_last_year < 10000) {

   198

		ormod = PALETTE_TO_YELLOW;

   199

	} else {

   200

		ormod = PALETTE_TO_GREEN;

   201

	}

   202

	DrawSprite(SPR_BLOT | ormod, x, y);

   203

}

   204

   205

/** Draw the list of available refit options for a consist.

   206

 * Draw the list and highlight the selected refit option (if any)

   207

 * @param *v first vehicle in consist to get the refit-options of

   208

 * @param sel selected refit cargo-type in the window

   209

 * @return the cargo type that is hightlighted, CT_INVALID if none

   210

 */

   211

CargoID DrawVehicleRefitWindow(const Vehicle *v, int sel)

   212

{

   213

	uint32 cmask;

   214

	CargoID cid, cargo = CT_INVALID;

   215

	int y = 25;

   216

	const Vehicle* u;

   217

#define show_cargo(ctype) { \

   218

		byte colour = 16; \

   219

		if (sel == 0) { \

   220

			cargo = ctype; \

   221

			colour = 12; \

   222

} \

   223

		sel--; \

   224

		DrawString(6, y, _cargoc.names_s[ctype], colour); \

   225

		y += 10; \

   226

}

   227

   228

		/* Check if vehicle has custom refit or normal ones, and get its bitmasked value.

   229

		 * If its a train, 'or' this with the refit masks of the wagons. Now just 'and'

   230

		 * it with the bitmask of available cargo on the current landscape, and

   231

		 * where the bits are set: those are available */

   232

		cmask = 0;

   233

		u = v;

   234

		do {

   235

			cmask |= _engine_info[u->engine_type].refit_mask;

   236

			u = u->next;

   237

		} while (v->type == VEH_Train && u != NULL);

   238

   239

		/* Check which cargo has been selected from the refit window and draw list */

   240

		for (cid = 0; cmask != 0; cmask >>= 1, cid++) {

   241

			if (HASBIT(cmask, 0)) // vehicle is refittable to this cargo

   242

				show_cargo(_local_cargo_id_ctype[cid]);

   243

		}

   244

		return cargo;

   245

}

   246

   247

/************ Sorter functions *****************/

   248

int CDECL GeneralOwnerSorter(const void *a, const void *b)

   249

{

   250

	return (*(const SortStruct*)a).owner - (*(const SortStruct*)b).owner;

   251

}

   252

   253

/* Variables you need to set before calling this function!

   254

* 1. (byte)_internal_sort_type:					sorting criteria to sort on

   255

* 2. (bool)_internal_sort_order:				sorting order, descending/ascending

   256

* 3. (uint32)_internal_name_sorter_id:	default StringID of the vehicle when no name is set. eg

   257

*    STR_SV_TRAIN_NAME for trains or STR_SV_AIRCRAFT_NAME for aircraft

   258

*/

   259

static int CDECL VehicleUnsortedSorter(const void *a, const void *b)

   260

{

   261

	return ((const SortStruct*)a)->index - ((const SortStruct*)b)->index;

   262

}

   263

   264

// if the sorting criteria had the same value, sort vehicle by unitnumber

   265

#define VEHICLEUNITNUMBERSORTER(r, a, b) {if (r == 0) {r = a->unitnumber - b->unitnumber;}}

   266

   267

static int CDECL VehicleNumberSorter(const void *a, const void *b)

   268

{

   269

	const Vehicle *va = GetVehicle((*(const SortStruct*)a).index);

   270

	const Vehicle *vb = GetVehicle((*(const SortStruct*)b).index);

   271

	int r = va->unitnumber - vb->unitnumber;

   272

   273

	return (_internal_sort_order & 1) ? -r : r;

   274

}

   275

   276

static char _bufcache[64];	// used together with _last_vehicle_idx to hopefully speed up stringsorting

   277

static int CDECL VehicleNameSorter(const void *a, const void *b)

   278

{

   279

	const SortStruct *cmp1 = (const SortStruct*)a;

   280

	const SortStruct *cmp2 = (const SortStruct*)b;

   281

	const Vehicle *va = GetVehicle(cmp1->index);

   282

	const Vehicle *vb = GetVehicle(cmp2->index);

   283

	char buf1[64] = "\0";

   284

	int r;

   285

   286

	if (va->string_id != _internal_name_sorter_id) {

   287

		SetDParam(0, va->string_id);

   288

		GetString(buf1, STR_JUST_STRING);

   289

	}

   290

   291

	if (cmp2->index != _last_vehicle_idx) {

   292

		_last_vehicle_idx = cmp2->index;

   293

		_bufcache[0] = '\0';

   294

		if (vb->string_id != _internal_name_sorter_id) {

   295

			SetDParam(0, vb->string_id);

   296

			GetString(_bufcache, STR_JUST_STRING);

   297

		}

   298

	}

   299

   300

	r =  strcmp(buf1, _bufcache);	// sort by name

   301

   302

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   303

   304

	return (_internal_sort_order & 1) ? -r : r;

   305

}

   306

   307

static int CDECL VehicleAgeSorter(const void *a, const void *b)

   308

{

   309

	const Vehicle *va = GetVehicle((*(const SortStruct*)a).index);

   310

	const Vehicle *vb = GetVehicle((*(const SortStruct*)b).index);

   311

	int r = va->age - vb->age;

   312

   313

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   314

   315

	return (_internal_sort_order & 1) ? -r : r;

   316

}

   317

   318

static int CDECL VehicleProfitThisYearSorter(const void *a, const void *b)

   319

{

   320

	const Vehicle *va = GetVehicle((*(const SortStruct*)a).index);

   321

	const Vehicle *vb = GetVehicle((*(const SortStruct*)b).index);

   322

	int r = va->profit_this_year - vb->profit_this_year;

   323

   324

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   325

   326

	return (_internal_sort_order & 1) ? -r : r;

   327

}

   328

   329

static int CDECL VehicleProfitLastYearSorter(const void *a, const void *b)

   330

{

   331

	const Vehicle *va = GetVehicle((*(const SortStruct*)a).index);

   332

	const Vehicle *vb = GetVehicle((*(const SortStruct*)b).index);

   333

	int r = va->profit_last_year - vb->profit_last_year;

   334

   335

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   336

   337

	return (_internal_sort_order & 1) ? -r : r;

   338

}

   339

   340

static int CDECL VehicleCargoSorter(const void *a, const void *b)

   341

{

   342

	const Vehicle* va = GetVehicle(((const SortStruct*)a)->index);

   343

	const Vehicle* vb = GetVehicle(((const SortStruct*)b)->index);

   344

	const Vehicle* v;

   345

	AcceptedCargo cargoa;

   346

	AcceptedCargo cargob;

   347

	int r = 0;

   348

	int i;

   349

   350

	memset(cargoa, 0, sizeof(cargoa));

   351

	memset(cargob, 0, sizeof(cargob));

   352

	for (v = va; v != NULL; v = v->next) cargoa[v->cargo_type] += v->cargo_cap;

   353

	for (v = vb; v != NULL; v = v->next) cargob[v->cargo_type] += v->cargo_cap;

   354

   355

	for (i = 0; i < NUM_CARGO; i++) {

   356

		r = cargoa[i] - cargob[i];

   357

		if (r != 0) break;

   358

	}

   359

   360

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   361

   362

	return (_internal_sort_order & 1) ? -r : r;

   363

}

   364

   365

static int CDECL VehicleReliabilitySorter(const void *a, const void *b)

   366

{

   367

	const Vehicle *va = GetVehicle((*(const SortStruct*)a).index);

   368

	const Vehicle *vb = GetVehicle((*(const SortStruct*)b).index);

   369

	int r = va->reliability - vb->reliability;

   370

   371

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   372

   373

	return (_internal_sort_order & 1) ? -r : r;

   374

}

   375

   376

static int CDECL VehicleMaxSpeedSorter(const void *a, const void *b)

   377

{

   378

	const Vehicle *va = GetVehicle((*(const SortStruct*)a).index);

   379

	const Vehicle *vb = GetVehicle((*(const SortStruct*)b).index);

   380

	int max_speed_a = 0xFFFF, max_speed_b = 0xFFFF;

   381

	int r;

   382

	const Vehicle *ua = va, *ub = vb;

   383

   384

	if (va->type == VEH_Train && vb->type == VEH_Train) {

   385

		do {

   386

			if (RailVehInfo(ua->engine_type)->max_speed != 0)

   387

				max_speed_a = min(max_speed_a, RailVehInfo(ua->engine_type)->max_speed);

   388

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

   389

   390

		do {

   391

			if (RailVehInfo(ub->engine_type)->max_speed != 0)

   392

				max_speed_b = min(max_speed_b, RailVehInfo(ub->engine_type)->max_speed);

   393

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

   394

   395

		r = max_speed_a - max_speed_b;

   396

	} else {

   397

		r = va->max_speed - vb->max_speed;

   398

	}

   399

   400

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   401

   402

	return (_internal_sort_order & 1) ? -r : r;

   403

}

   404

   405

// this define is to match engine.c, but engine.c keeps it to itself

   406

// ENGINE_AVAILABLE is used in ReplaceVehicleWndProc

   407

#define ENGINE_AVAILABLE ((e->flags & 1 && HASBIT(info->climates, _opt.landscape)) || HASBIT(e->player_avail, _local_player))

   408

   409

/*  if show_outdated is selected, it do not sort psudo engines properly but it draws all engines

   410

 *	if used compined with show_cars set to false, it will work as intended. Replace window do it like that

   411

 *  this was a big hack even before show_outdated was added. Stupid newgrf :p										*/

   413

	uint8 lines_drawn, bool is_engine, bool show_cars, bool show_outdated)

   414

{

   415

	EngineID i;

   416

	byte colour;

   417

	const Player *p = GetPlayer(_local_player);

   418

   419

	for (i = 0; i < NUM_TRAIN_ENGINES; i++) {

   420

		const Engine *e = GetEngine(i);

   421

		const RailVehicleInfo *rvi = RailVehInfo(i);

   422

		const EngineInfo *info = &_engine_info[i];

   423

   424

		if (!EngineHasReplacement(p, i) && _player_num_engines[i] == 0 && show_outdated) continue;

   425

   426

		if (rvi->power == 0 && !show_cars)   // disables display of cars (works since they do not have power)

   427

			continue;

   428

   429

		if (*sel == 0) *selected_id = i;

   430

   431

   432

		colour = *sel == 0 ? 0xC : 0x10;

   433

		if (!(ENGINE_AVAILABLE && show_outdated && RailVehInfo(i)->power && e->railtype == railtype)) {

   434

			if (e->railtype != railtype || !(rvi->flags & RVI_WAGON) != is_engine ||

   435

				!HASBIT(e->player_avail, _local_player))

   436

				continue;

   437

		} /*else {

   438

		// TODO find a nice red colour for vehicles being replaced

   439

			if ( _autoreplace_array[i] != i )

   440

				colour = *sel == 0 ? 0x44 : 0x45;

   441

		} */

   442

   443

		if (IS_INT_INSIDE(--*pos, -lines_drawn, 0)) {

   444

			DrawString(*x + 59, *y + 2, GetCustomEngineName(i),

   445

				colour);

   446

			// show_outdated is true only for left side, which is where we show old replacements

   447

			DrawTrainEngine(*x + 29, *y + 6, i, (_player_num_engines[i] == 0 && show_outdated) ?

   448

				PALETTE_CRASH : SPRITE_PALETTE(PLAYER_SPRITE_COLOR(_local_player)));

   449

			if ( show_outdated ) {

   450

				SetDParam(0, _player_num_engines[i]);

   451

				DrawStringRightAligned(213, *y+5, STR_TINY_BLACK, 0);

   452

			}

   453

			*y += 14;

   454

		}

   455

		--*sel;

   456

	}

   457

}

   458

   459

   460

static void SetupScrollStuffForReplaceWindow(Window *w)

   461

{

   462

	RailType railtype;

   464

	int sel[2];

   465

	int count = 0;

   466

	int count2 = 0;

   467

	EngineID engine_id;

   468

	const Player *p = GetPlayer(_local_player);

   469

   470

	sel[0] = WP(w,replaceveh_d).sel_index[0];

   471

	sel[1] = WP(w,replaceveh_d).sel_index[1];

   472

   473

	switch (WP(w,replaceveh_d).vehicletype) {

   474

		case VEH_Train: {

   475

			railtype = _railtype_selected_in_replace_gui;

   476

			w->widget[13].color = _player_colors[_local_player];	// sets the colour of that art thing

   477

			w->widget[16].color = _player_colors[_local_player];	// sets the colour of that art thing

   478

			for (engine_id = 0; engine_id < NUM_TRAIN_ENGINES; engine_id++) {

   479

				const Engine *e = GetEngine(engine_id);

   480

				const EngineInfo *info = &_engine_info[engine_id];

   481

   482

				if (ENGINE_AVAILABLE && RailVehInfo(engine_id)->power && e->railtype == railtype) {

   483

					if (_player_num_engines[engine_id] > 0 || EngineHasReplacement(p, engine_id)) {

   484

						if (sel[0] == 0) selected_id[0] = engine_id;

   485

						count++;