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

    23

#include "newgrf_engine.h"

    24

#include "newgrf_text.h"

    25

#include "date.h"

    26

    27

Sorting _sorting;

    28

    29

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

    30

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

    31

static bool   _internal_sort_order;     // descending/ascending

    32

    33

static uint16 _player_num_engines[TOTAL_NUM_ENGINES];

    34

static RailType _railtype_selected_in_replace_gui;

    35

    36

    37

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

    38

    39

static VehicleSortListingTypeFunction VehicleUnsortedSorter;

    40

static VehicleSortListingTypeFunction VehicleNumberSorter;

    41

static VehicleSortListingTypeFunction VehicleNameSorter;

    42

static VehicleSortListingTypeFunction VehicleAgeSorter;

    43

static VehicleSortListingTypeFunction VehicleProfitThisYearSorter;

    44

static VehicleSortListingTypeFunction VehicleProfitLastYearSorter;

    45

static VehicleSortListingTypeFunction VehicleCargoSorter;

    46

static VehicleSortListingTypeFunction VehicleReliabilitySorter;

    47

static VehicleSortListingTypeFunction VehicleMaxSpeedSorter;

    48

static VehicleSortListingTypeFunction VehicleModelSorter;

    49

static VehicleSortListingTypeFunction VehicleValueSorter;

    50

    51

static VehicleSortListingTypeFunction* const _vehicle_sorter[] = {

    52

	&VehicleUnsortedSorter,

    53

	&VehicleNumberSorter,

    54

	&VehicleNameSorter,

    55

	&VehicleAgeSorter,

    56

	&VehicleProfitThisYearSorter,

    57

	&VehicleProfitLastYearSorter,

    58

	&VehicleCargoSorter,

    59

	&VehicleReliabilitySorter,

    60

	&VehicleMaxSpeedSorter,

    61

	&VehicleModelSorter,

    62

	&VehicleValueSorter,

    63

};

    64

    65

const StringID _vehicle_sort_listing[] = {

    66

	STR_SORT_BY_UNSORTED,

    67

	STR_SORT_BY_NUMBER,

    68

	STR_SORT_BY_DROPDOWN_NAME,

    69

	STR_SORT_BY_AGE,

    70

	STR_SORT_BY_PROFIT_THIS_YEAR,

    71

	STR_SORT_BY_PROFIT_LAST_YEAR,

    72

	STR_SORT_BY_TOTAL_CAPACITY_PER_CARGOTYPE,

    73

	STR_SORT_BY_RELIABILITY,

    74

	STR_SORT_BY_MAX_SPEED,

    75

	STR_SORT_BY_MODEL,

    76

	STR_SORT_BY_VALUE,

    77

	INVALID_STRING_ID

    78

};

    79

    80

static const StringID _rail_types_list[] = {

    81

	STR_RAIL_VEHICLES,

    82

	STR_ELRAIL_VEHICLES,

    83

	STR_MONORAIL_VEHICLES,

    84

	STR_MAGLEV_VEHICLES,

    85

	INVALID_STRING_ID

    86

};

    87

    88

void RebuildVehicleLists(void)

    89

{

    90

	Window *w;

    91

    92

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

    93

		switch (w->window_class) {

    94

		case WC_TRAINS_LIST: case WC_ROADVEH_LIST:

    95

		case WC_SHIPS_LIST:  case WC_AIRCRAFT_LIST:

    96

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

    97

			SetWindowDirty(w);

    98

			break;

    99

		default: break;

   100

		}

   101

}

   102

   103

void ResortVehicleLists(void)

   104

{

   105

	Window *w;

   106

   107

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

   108

		switch (w->window_class) {

   109

		case WC_TRAINS_LIST: case WC_ROADVEH_LIST:

   110

		case WC_SHIPS_LIST:  case WC_AIRCRAFT_LIST:

   111

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

   112

			SetWindowDirty(w);

   113

			break;

   114

		default: break;

   115

		}

   116

}

   117

   118

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

   119

{

   120

	SortStruct* sort_list;

   121

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

   122

	uint n = 0;

   123

	uint i;

   124

   125

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

   126

   127

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

   128

	if (sort_list == NULL) {

   129

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

   130

	}

   131

   132

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

   133

		owner, station);

   134

   135

	if (station != INVALID_STATION) {

   136

		const Vehicle *v;

   137

		FOR_ALL_VEHICLES(v) {

   138

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

   139

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

   140

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

   141

					)) {

   142

				const Order *order;

   143

   144

				FOR_VEHICLE_ORDERS(v, order) {

   145

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

   146

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

   147

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

   148

						++n;

   149

						break;

   150

					}

   151

				}

   152

			}

   153

		}

   154

	} else {

   155

		const Vehicle *v;

   156

		FOR_ALL_VEHICLES(v) {

   157

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

   158

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

   159

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

   160

					)) {

   161

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

   162

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

   163

				++n;

   164

			}

   165

		}

   166

	}

   167

   168

	free(vl->sort_list);

   169

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

   170

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

   171

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

   172

	}

   173

	vl->list_length = n;

   174

   175

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

   176

	free(sort_list);

   177

   178

	vl->flags &= ~VL_REBUILD;

   179

	vl->flags |= VL_RESORT;

   180

}

   181

   182

void SortVehicleList(vehiclelist_d *vl)

   183

{

   184

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

   185

   186

	_internal_sort_order = vl->flags & VL_DESC;

   187

	_internal_name_sorter_id = STR_SV_TRAIN_NAME;

   188

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

   189

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

   190

		_vehicle_sorter[vl->sort_type]);

   191

   192

	vl->resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   193

	vl->flags &= ~VL_RESORT;

   194

}

   195

   196

   197

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

   198

void InitializeVehiclesGuiList(void)

   199

{

   200

	_railtype_selected_in_replace_gui = RAILTYPE_RAIL;

   201

}

   202

   203

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

   204

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

   205

{

   206

	uint32 ormod;

   207

   208

	// draw profit-based colored icons

   209

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

   210

		ormod = PALETTE_TO_GREY;

   211

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

   212

		ormod = PALETTE_TO_RED;

   213

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

   214

		ormod = PALETTE_TO_YELLOW;

   215

	} else {

   216

		ormod = PALETTE_TO_GREEN;

   217

	}

   218

	DrawSprite(SPR_BLOT | ormod, x, y);

   219

}

   220

   221

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

   222

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

   223

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

   224

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

   225

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

   226

 */

   227

CargoID DrawVehicleRefitWindow(const Vehicle *v, int sel)

   228

{

   229

	uint32 cmask = 0;

   230

	CargoID cid, cargo = CT_INVALID;

   231

	int y = 25;

   232

	const Vehicle* u = v;

   233

   234

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

   235

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

   236

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

   237

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

   238

	do {

   239

		cmask |= EngInfo(u->engine_type)->refit_mask;

   240

		u = u->next;

   241

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

   242

   243

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

   244

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

   245

		if (HASBIT(cmask, 0)) {

   246

			// vehicle is refittable to this cargo

   247

			byte colour = 16;

   248

			if (sel == 0) {

   249

				cargo = _local_cargo_id_ctype[cid];

   250

				colour = 12;

   251

			}

   252

   253

			sel--;

   254

			DrawString(6, y, _cargoc.names_s[_local_cargo_id_ctype[cid]], colour);

   255

			y += 10;

   256

		}

   257

	}

   258

   259

	return cargo;

   260

}

   261

   262

/* Display additional text from NewGRF in the purchase information window */

   263

int ShowAdditionalText(int x, int y, int w, EngineID engine)

   264

{

   265

	uint16 callback = GetVehicleCallback(CBID_VEHICLE_ADDITIONAL_TEXT, 0, 0, engine, NULL);

   266

	if (callback == CALLBACK_FAILED) return 0;

   267

   268

	DrawStringTruncated(x, y, GetGRFStringID(GetEngineGRFID(engine), 0xD000 + callback), 16, w);

   269

	return 10;

   270

}

   271

   272

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

   273

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

   274

{

   275

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

   276

}

   277

   278

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

   279

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

   280

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

   281

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

   282

*    STR_SV_TRAIN_NAME for trains or STR_SV_AIRCRAFT_NAME for aircraft

   283

*/

   284

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

   285

{

   286

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

   287

}

   288

   289

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

   290

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

   291

   292

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

   293

{

   294

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

   295

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

   296

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

   297

   298

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

   299

}

   300

   301

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

   302

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

   303

{

   304

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

   305

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

   306

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

   307

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

   308

	char buf1[64] = "\0";

   309

	int r;

   310

   311

	if (va->string_id != _internal_name_sorter_id) {

   312

		SetDParam(0, va->string_id);

   313

		GetString(buf1, STR_JUST_STRING);

   314

	}

   315

   316

	if (cmp2->index != _last_vehicle_idx) {

   317

		_last_vehicle_idx = cmp2->index;

   318

		_bufcache[0] = '\0';

   319

		if (vb->string_id != _internal_name_sorter_id) {

   320

			SetDParam(0, vb->string_id);

   321

			GetString(_bufcache, STR_JUST_STRING);

   322

		}

   323

	}

   324

   325

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

   326

   327

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   328

   329

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

   330

}

   331

   332

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

   333

{

   334

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

   335

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

   336

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

   337

   338

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   339

   340

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

   341

}

   342

   343

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

   344

{

   345

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

   346

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

   347

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

   348

   349

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   350

   351

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

   352

}

   353

   354

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

   355

{

   356

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

   357

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

   358

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

   359

   360

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   361

   362

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

   363

}

   364

   365

static int CDECL VehicleCargoSorter(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

	const Vehicle* v;

   370

	AcceptedCargo cargoa;

   371

	AcceptedCargo cargob;

   372

	int r = 0;

   373

	int i;

   374

   375

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

   376

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

   377

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

   378

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

   379

   380

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

   381

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

   382

		if (r != 0) break;

   383

	}

   384

   385

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   386

   387

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

   388

}

   389

   390

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

   391

{

   392

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

   393

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

   394

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

   395

   396

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   397

   398

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

   399

}

   400

   401

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

   402

{

   403

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

   404

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

   405

	int max_speed_a = 0xFFFF, max_speed_b = 0xFFFF;

   406

	int r;

   407

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

   408

   409

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

   410

		do {

   411

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

   412

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

   413

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

   414

   415

		do {

   416

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

   417

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

   418

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

   419

   420

		r = max_speed_a - max_speed_b;

   421

	} else {

   422

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

   423

	}

   424

   425

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   426

   427

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

   428

}

   429

   430

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

   431

{

   432

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

   433

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

   434

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

   435

   436

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   437

   438

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

   439

}

   440

   441

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

   442

{

   443

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

   444

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

   445

	const Vehicle *u;

   446

	int valuea = 0, valueb = 0;

   447

	int r;

   448

   449

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

   450

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

   451

   452

	r = valuea - valueb;

   453

   454

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   455

   456

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

   457

}

   458

   459

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

   460

// ENGINE_AVAILABLE is used in ReplaceVehicleWndProc

   461

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

   462

   463

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

   464

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

   465

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

   466

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

   467

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

   468

{

   469

	EngineID j;

   470

	byte colour;

   471

	const Player *p = GetPlayer(_local_player);

   472

   473

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

   474

		EngineID i = GetRailVehAtPosition(j);

   475

		const Engine *e = GetEngine(i);

   476

		const RailVehicleInfo *rvi = RailVehInfo(i);

   477

		const EngineInfo *info = EngInfo(i);

   478

   479

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

   480

   481

		if ((rvi->power == 0 && !show_cars) || (rvi->power != 0 && show_cars))  // show wagons or engines (works since wagons do not have power)

   482

			continue;

   483

   484

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

   485