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

    26

Sorting _sorting;

    27

    28

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

    29

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

    30

static bool   _internal_sort_order;     // descending/ascending

    31

    32

static uint16 _player_num_engines[TOTAL_NUM_ENGINES];

    33

static RailType _railtype_selected_in_replace_gui;

    34

    35

    36

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

    37

    38

static VehicleSortListingTypeFunction VehicleUnsortedSorter;

    39

static VehicleSortListingTypeFunction VehicleNumberSorter;

    40

static VehicleSortListingTypeFunction VehicleNameSorter;

    41

static VehicleSortListingTypeFunction VehicleAgeSorter;

    42

static VehicleSortListingTypeFunction VehicleProfitThisYearSorter;

    43

static VehicleSortListingTypeFunction VehicleProfitLastYearSorter;

    44

static VehicleSortListingTypeFunction VehicleCargoSorter;

    45

static VehicleSortListingTypeFunction VehicleReliabilitySorter;

    46

static VehicleSortListingTypeFunction VehicleMaxSpeedSorter;

    47

static VehicleSortListingTypeFunction VehicleModelSorter;

    48

static VehicleSortListingTypeFunction VehicleValueSorter;

    49

    50

static VehicleSortListingTypeFunction* const _vehicle_sorter[] = {

    51

	&VehicleUnsortedSorter,

    52

	&VehicleNumberSorter,

    53

	&VehicleNameSorter,

    54

	&VehicleAgeSorter,

    55

	&VehicleProfitThisYearSorter,

    56

	&VehicleProfitLastYearSorter,

    57

	&VehicleCargoSorter,

    58

	&VehicleReliabilitySorter,

    59

	&VehicleMaxSpeedSorter,

    60

	&VehicleModelSorter,

    61

	&VehicleValueSorter,

    62

};

    63

    64

const StringID _vehicle_sort_listing[] = {

    65

	STR_SORT_BY_UNSORTED,

    66

	STR_SORT_BY_NUMBER,

    67

	STR_SORT_BY_DROPDOWN_NAME,

    68

	STR_SORT_BY_AGE,

    69

	STR_SORT_BY_PROFIT_THIS_YEAR,

    70

	STR_SORT_BY_PROFIT_LAST_YEAR,

    71

	STR_SORT_BY_TOTAL_CAPACITY_PER_CARGOTYPE,

    72

	STR_SORT_BY_RELIABILITY,

    73

	STR_SORT_BY_MAX_SPEED,

    74

	STR_SORT_BY_MODEL,

    75

	STR_SORT_BY_VALUE,

    76

	INVALID_STRING_ID

    77

};

    78

    79

static const StringID _rail_types_list[] = {

    80

	STR_RAIL_VEHICLES,

    81

	STR_ELRAIL_VEHICLES,

    82

	STR_MONORAIL_VEHICLES,

    83

	STR_MAGLEV_VEHICLES,

    84

	INVALID_STRING_ID

    85

};

    86

    87

void RebuildVehicleLists(void)

    88

{

    89

	Window *w;

    90

    91

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

    92

		switch (w->window_class) {

    93

		case WC_TRAINS_LIST: case WC_ROADVEH_LIST:

    94

		case WC_SHIPS_LIST:  case WC_AIRCRAFT_LIST:

    95

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

    96

			SetWindowDirty(w);

    97

			break;

    98

		default: break;

    99

		}

   100

}

   101

   102

void ResortVehicleLists(void)

   103

{

   104

	Window *w;

   105

   106

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

   107

		switch (w->window_class) {

   108

		case WC_TRAINS_LIST: case WC_ROADVEH_LIST:

   109

		case WC_SHIPS_LIST:  case WC_AIRCRAFT_LIST:

   110

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

   111

			SetWindowDirty(w);

   112

			break;

   113

		default: break;

   114

		}

   115

}

   116

   117

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

   118

{

   119

	SortStruct* sort_list;

   120

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

   121

	uint n = 0;

   122

	uint i;

   123

   124

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

   125

   126

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

   127

	if (sort_list == NULL) {

   128

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

   129

	}

   130

   131

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

   132

		owner, station);

   133

   134

	if (station != INVALID_STATION) {

   135

		const Vehicle *v;

   136

		FOR_ALL_VEHICLES(v) {

   137

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

   138

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

   139

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

   140

					)) {

   141

				const Order *order;

   142

   143

				FOR_VEHICLE_ORDERS(v, order) {

   144

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

   145

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

   146

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

   147

						++n;

   148

						break;

   149

					}

   150

				}

   151

			}

   152

		}

   153

	} else {

   154

		const Vehicle *v;

   155

		FOR_ALL_VEHICLES(v) {

   156

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

   157

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

   158

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

   159

					)) {

   160

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

   161

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

   162

				++n;

   163

			}

   164

		}

   165

	}

   166

   167

	free(vl->sort_list);

   168

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

   169

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

   170

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

   171

	}

   172

	vl->list_length = n;

   173

   174

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

   175

	free(sort_list);

   176

   177

	vl->flags &= ~VL_REBUILD;

   178

	vl->flags |= VL_RESORT;

   179

}

   180

   181

void SortVehicleList(vehiclelist_d *vl)

   182

{

   183

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

   184

   185

	_internal_sort_order = vl->flags & VL_DESC;

   186

	_internal_name_sorter_id = STR_SV_TRAIN_NAME;

   187

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

   188

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

   189

		_vehicle_sorter[vl->sort_type]);

   190

   191

	vl->resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   192

	vl->flags &= ~VL_RESORT;

   193

}

   194

   195

   196

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

   197

void InitializeVehiclesGuiList(void)

   198

{

   199

	_railtype_selected_in_replace_gui = RAILTYPE_RAIL;

   200

}

   201

   202

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

   203

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

   204

{

   205

	uint32 ormod;

   206

   207

	// draw profit-based colored icons

   208

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

   209

		ormod = PALETTE_TO_GREY;

   210

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

   211

		ormod = PALETTE_TO_RED;

   212

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

   213

		ormod = PALETTE_TO_YELLOW;

   214

	} else {

   215

		ormod = PALETTE_TO_GREEN;

   216

	}

   217

	DrawSprite(SPR_BLOT | ormod, x, y);

   218

}

   219

   220

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

   221

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

   222

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

   223

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

   224

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

   225

 */

   226

CargoID DrawVehicleRefitWindow(const Vehicle *v, int sel)

   227

{

   228

	uint32 cmask = 0;

   229

	CargoID cid, cargo = CT_INVALID;

   230

	int y = 25;

   231

	const Vehicle* u = v;

   232

   233

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

   234

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

   235

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

   236

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

   237

	do {

   238

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

   239

		u = u->next;

   240

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

   241

   242

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

   243

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

   244

		if (HASBIT(cmask, 0)) {

   245

			// vehicle is refittable to this cargo

   246

			byte colour = 16;

   247

			if (sel == 0) {

   248

				cargo = _local_cargo_id_ctype[cid];

   249

				colour = 12;

   250

			}

   251

   252

			sel--;

   253

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

   254

			y += 10;

   255

		}

   256

	}

   257

   258

	return cargo;

   259

}

   260

   261

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

   262

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

   263

{

   264

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

   265

	if (callback == CALLBACK_FAILED) return 0;

   266

   267

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

   268

	return 10;

   269

}

   270

   271

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

   272

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

   273

{

   274

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

   275

}

   276

   277

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

   278

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

   279

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

   280

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

   281

*    STR_SV_TRAIN_NAME for trains or STR_SV_AIRCRAFT_NAME for aircraft

   282

*/

   283

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

   284

{

   285

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

   286

}

   287

   288

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

   289

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

   290

   291

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

   292

{

   293

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

   294

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

   295

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

   296

   297

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

   298

}

   299

   300

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

   301

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

   302

{

   303

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

   304

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

   305

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

   306

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

   307

	char buf1[64] = "\0";

   308

	int r;

   309

   310

	if (va->string_id != _internal_name_sorter_id) {

   311

		SetDParam(0, va->string_id);

   312

		GetString(buf1, STR_JUST_STRING);

   313

	}

   314

   315

	if (cmp2->index != _last_vehicle_idx) {

   316

		_last_vehicle_idx = cmp2->index;

   317

		_bufcache[0] = '\0';

   318

		if (vb->string_id != _internal_name_sorter_id) {

   319

			SetDParam(0, vb->string_id);

   320

			GetString(_bufcache, STR_JUST_STRING);

   321

		}

   322

	}

   323

   324

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

   325

   326

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   327

   328

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

   329

}

   330

   331

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

   332

{

   333

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

   334

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

   335

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

   336

   337

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   338

   339

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

   340

}

   341

   342

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

   343

{

   344

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

   345

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

   346

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

   347

   348

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   349

   350

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

   351

}

   352

   353

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

   354

{

   355

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

   356

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

   357

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

   358

   359

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   360

   361

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

   362

}

   363

   364

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

   365

{

   366

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

   367

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

   368

	const Vehicle* v;

   369

	AcceptedCargo cargoa;

   370

	AcceptedCargo cargob;

   371

	int r = 0;

   372

	int i;

   373

   374

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

   375

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

   376

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

   377

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

   378

   379

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

   380

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

   381

		if (r != 0) break;

   382

	}

   383

   384

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   385

   386

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

   387

}

   388

   389

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

   390

{

   391

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

   392

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

   393

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

   394

   395

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   396

   397

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

   398

}

   399

   400

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

   401

{

   402

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

   403

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

   404

	int max_speed_a = 0xFFFF, max_speed_b = 0xFFFF;

   405

	int r;

   406

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

   407

   408

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

   409

		do {

   410

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

   411

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

   412

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

   413

   414

		do {

   415

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

   416

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

   417

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

   418

   419

		r = max_speed_a - max_speed_b;

   420

	} else {

   421

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

   422

	}

   423

   424

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   425

   426

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

   427

}

   428

   429

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

   430

{

   431

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

   432

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

   433

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

   434

   435

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   436

   437

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

   438

}

   439

   440

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

   441

{

   442

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

   443

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

   444

	const Vehicle *u;

   445

	int valuea = 0, valueb = 0;

   446

	int r;

   447

   448

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

   449

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

   450

   451

	r = valuea - valueb;

   452

   453

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   454

   455

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

   456

}

   457

   458

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

   459

// ENGINE_AVAILABLE is used in ReplaceVehicleWndProc

   460

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

   461

   462

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

   463

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

   464

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

   465

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

   466

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

   467

{

   468

	EngineID j;

   469

	byte colour;

   470

	const Player *p = GetPlayer(_local_player);

   471

   472

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

   473

		EngineID i = GetRailVehAtPosition(j);

   474

		const Engine *e = GetEngine(i);

   475

		const RailVehicleInfo *rvi = RailVehInfo(i);

   476

		const EngineInfo *info = EngInfo(i);

   477

   478

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

   479

   480

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

   481

			continue;

   482

   483

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

   484

   485