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

#include "newgrf_engine.h"

    23

    24

Sorting _sorting;

    25

    26

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

    27

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

    28

static bool   _internal_sort_order;     // descending/ascending

    29

    30

static uint16 _player_num_engines[TOTAL_NUM_ENGINES];

    31

static RailType _railtype_selected_in_replace_gui;

    32

    33

    34

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

    35

    36

static VehicleSortListingTypeFunction VehicleUnsortedSorter;

    37

static VehicleSortListingTypeFunction VehicleNumberSorter;

    38

static VehicleSortListingTypeFunction VehicleNameSorter;

    39

static VehicleSortListingTypeFunction VehicleAgeSorter;

    40

static VehicleSortListingTypeFunction VehicleProfitThisYearSorter;

    41

static VehicleSortListingTypeFunction VehicleProfitLastYearSorter;

    42

static VehicleSortListingTypeFunction VehicleCargoSorter;

    43

static VehicleSortListingTypeFunction VehicleReliabilitySorter;

    44

static VehicleSortListingTypeFunction VehicleMaxSpeedSorter;

    45

static VehicleSortListingTypeFunction VehicleModelSorter;

    46

static VehicleSortListingTypeFunction VehicleValueSorter;

    47

    48

static VehicleSortListingTypeFunction* const _vehicle_sorter[] = {

    49

	&VehicleUnsortedSorter,

    50

	&VehicleNumberSorter,

    51

	&VehicleNameSorter,

    52

	&VehicleAgeSorter,

    53

	&VehicleProfitThisYearSorter,

    54

	&VehicleProfitLastYearSorter,

    55

	&VehicleCargoSorter,

    56

	&VehicleReliabilitySorter,

    57

	&VehicleMaxSpeedSorter,

    58

	&VehicleModelSorter,

    59

	&VehicleValueSorter,

    60

};

    61

    62

const StringID _vehicle_sort_listing[] = {

    63

	STR_SORT_BY_UNSORTED,

    64

	STR_SORT_BY_NUMBER,

    65

	STR_SORT_BY_DROPDOWN_NAME,

    66

	STR_SORT_BY_AGE,

    67

	STR_SORT_BY_PROFIT_THIS_YEAR,

    68

	STR_SORT_BY_PROFIT_LAST_YEAR,

    69

	STR_SORT_BY_TOTAL_CAPACITY_PER_CARGOTYPE,

    70

	STR_SORT_BY_RELIABILITY,

    71

	STR_SORT_BY_MAX_SPEED,

    72

	STR_SORT_BY_MODEL,

    73

	STR_SORT_BY_VALUE,

    74

	INVALID_STRING_ID

    75

};

    76

    77

static const StringID _rail_types_list[] = {

    78

	STR_RAIL_VEHICLES,

    79

	STR_MONORAIL_VEHICLES,

    80

	STR_MAGLEV_VEHICLES,

    81

	INVALID_STRING_ID

    82

};

    83

    84

void RebuildVehicleLists(void)

    85

{

    86

	Window *w;

    87

    88

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

    89

		switch (w->window_class) {

    90

		case WC_TRAINS_LIST: case WC_ROADVEH_LIST:

    91

		case WC_SHIPS_LIST:  case WC_AIRCRAFT_LIST:

    92

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

    93

			SetWindowDirty(w);

    94

			break;

    95

		default: break;

    96

		}

    97

}

    98

    99

void ResortVehicleLists(void)

   100

{

   101

	Window *w;

   102

   103

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

   104

		switch (w->window_class) {

   105

		case WC_TRAINS_LIST: case WC_ROADVEH_LIST:

   106

		case WC_SHIPS_LIST:  case WC_AIRCRAFT_LIST:

   107

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

   108

			SetWindowDirty(w);

   109

			break;

   110

		default: break;

   111

		}

   112

}

   113

   114

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

   115

{

   116

	SortStruct* sort_list;

   117

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

   118

	uint n = 0;

   119

	uint i;

   120

   121

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

   122

   123

	sort_list = malloc(GetVehiclePoolSize() * sizeof(sort_list[0]));

   124

	if (sort_list == NULL) {

   125

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

   126

	}

   127

   128

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

   129

		owner, station);

   130

   131

	if (station != INVALID_STATION) {

   132

		const Vehicle *v;

   133

		FOR_ALL_VEHICLES(v) {

   134

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

   135

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

   136

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

   137

					)) {

   138

				const Order *order;

   139

   140

				FOR_VEHICLE_ORDERS(v, order) {

   141

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

   142

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

   143

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

   144

						++n;

   145

						break;

   146

					}

   147

				}

   148

			}

   149

		}

   150

	} else {

   151

		const Vehicle *v;

   152

		FOR_ALL_VEHICLES(v) {

   153

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

   154

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

   155

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

   156

					)) {

   157

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

   158

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

   159

				++n;

   160

			}

   161

		}

   162

	}

   163

   164

	free(vl->sort_list);

   165

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

   166

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

   167

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

   168

	}

   169

	vl->list_length = n;

   170

   171

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

   172

	free(sort_list);

   173

   174

	vl->flags &= ~VL_REBUILD;

   175

	vl->flags |= VL_RESORT;

   176

}

   177

   178

void SortVehicleList(vehiclelist_d *vl)

   179

{

   180

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

   181

   182

	_internal_sort_order = vl->flags & VL_DESC;

   183

	_internal_name_sorter_id = STR_SV_TRAIN_NAME;

   184

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

   185

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

   186

		_vehicle_sorter[vl->sort_type]);

   187

   188

	vl->resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   189

	vl->flags &= ~VL_RESORT;

   190

}

   191

   192

   193

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

   194

void InitializeVehiclesGuiList(void)

   195

{

   196

	_railtype_selected_in_replace_gui = RAILTYPE_RAIL;

   197

}

   198

   199

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

   200

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

   201

{

   202

	uint32 ormod;

   203

   204

	// draw profit-based colored icons

   205

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

   206

		ormod = PALETTE_TO_GREY;

   207

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

   208

		ormod = PALETTE_TO_RED;

   209

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

   210

		ormod = PALETTE_TO_YELLOW;

   211

	} else {

   212

		ormod = PALETTE_TO_GREEN;

   213

	}

   214

	DrawSprite(SPR_BLOT | ormod, x, y);

   215

}

   216

   217

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

   218

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

   219

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

   220

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

   221

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

   222

 */

   223

CargoID DrawVehicleRefitWindow(const Vehicle *v, int sel)

   224

{

   225

	uint32 cmask;

   226

	CargoID cid, cargo = CT_INVALID;

   227

	int y = 25;

   228

	const Vehicle* u;

   229

#define show_cargo(ctype) { \

   230

		byte colour = 16; \

   231

		if (sel == 0) { \

   232

			cargo = ctype; \

   233

			colour = 12; \

   234

} \

   235

		sel--; \

   236

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

   237

		y += 10; \

   238

}

   239

   240

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

   241

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

   242

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

   243

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

   244

		cmask = 0;

   245

		u = v;

   246

		do {

   247

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

   248

			u = u->next;

   249

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

   250

   251

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

   252

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

   253

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

   254

				show_cargo(_local_cargo_id_ctype[cid]);

   255

		}

   256

		return cargo;

   257

}

   258

   259

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

   260

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

   261

{

   262

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

   263

}

   264

   265

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

   266

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

   267

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

   268

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

   269

*    STR_SV_TRAIN_NAME for trains or STR_SV_AIRCRAFT_NAME for aircraft

   270

*/

   271

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

   272

{

   273

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

   274

}

   275

   276

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

   277

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

   278

   279

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

   280

{

   281

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

   282

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

   283

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

   284

   285

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

   286

}

   287

   288

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

   289

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

   290

{

   291

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

   292

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

   293

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

   294

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

   295

	char buf1[64] = "\0";

   296

	int r;

   297

   298

	if (va->string_id != _internal_name_sorter_id) {

   299

		SetDParam(0, va->string_id);

   300

		GetString(buf1, STR_JUST_STRING);

   301

	}

   302

   303

	if (cmp2->index != _last_vehicle_idx) {

   304

		_last_vehicle_idx = cmp2->index;

   305

		_bufcache[0] = '\0';

   306

		if (vb->string_id != _internal_name_sorter_id) {

   307

			SetDParam(0, vb->string_id);

   308

			GetString(_bufcache, STR_JUST_STRING);

   309

		}

   310

	}

   311

   312

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

   313

   314

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   315

   316

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

   317

}

   318

   319

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

   320

{

   321

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

   322

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

   323

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

   324

   325

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   326

   327

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

   328

}

   329

   330

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

   331

{

   332

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

   333

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

   334

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

   335

   336

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   337

   338

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

   339

}

   340

   341

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

   342

{

   343

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

   344

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

   345

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

   346

   347

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   348

   349

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

   350

}

   351

   352

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

   353

{

   354

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

   355

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

   356

	const Vehicle* v;

   357

	AcceptedCargo cargoa;

   358

	AcceptedCargo cargob;

   359

	int r = 0;

   360

	int i;

   361

   362

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

   363

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

   364

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

   365

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

   366

   367

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

   368

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

   369

		if (r != 0) break;

   370

	}

   371

   372

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   373

   374

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

   375

}

   376

   377

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

   378

{

   379

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

   380

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

   381

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

   382

   383

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   384

   385

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

   386

}

   387

   388

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

   389

{

   390

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

   391

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

   392

	int max_speed_a = 0xFFFF, max_speed_b = 0xFFFF;

   393

	int r;

   394

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

   395

   396

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

   397

		do {

   398

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

   399

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

   400

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

   401

   402

		do {

   403

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

   404

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

   405

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

   406

   407

		r = max_speed_a - max_speed_b;

   408

	} else {

   409

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

   410

	}

   411

   412

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   413

   414

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

   415

}

   416

   417

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

   418

{

   419

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

   420

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

   421

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

   422

   423

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   424

   425

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

   426

}

   427

   428

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

   429

{

   430

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

   431

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

   432

	const Vehicle *u;

   433

	int valuea = 0, valueb = 0;

   434

	int r;

   435

   436

	for (u = va; u != NULL; u = u->next) valuea += u->value;

   437

	for (u = vb; u != NULL; u = u->next) valueb += u->value;

   438

   439

	r = valuea - valueb;

   440

   441

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   442

   443

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

   444

}

   445

   446

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

   447

// ENGINE_AVAILABLE is used in ReplaceVehicleWndProc

   448

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

   449

   450

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

   451

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

   452

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

   453

static void train_engine_drawing_loop(int *x, int *y, int *pos, int *sel, EngineID *selected_id, RailType railtype,

   454

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

   455

{

   456

	EngineID i;

   457

	byte colour;

   458

	const Player *p = GetPlayer(_local_player);

   459

   460

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

   461

		const Engine *e = GetEngine(i);

   462

		const RailVehicleInfo *rvi = RailVehInfo(i);

   463

		const EngineInfo *info = &_engine_info[i];

   464

   465

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

   466

   468

			continue;

   469

   470

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

   471

   472

   473

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

   474

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

   475

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

   476

				!HASBIT(e->player_avail, _local_player))

   477

				continue;

   478

		} /*else {

   479

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

   480

			if ( _autoreplace_array[i] != i )

   481

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

   482

		} */

   483

   484

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

   485

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

   486

				colour);