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

#include "ship.h"

    27

#include "aircraft.h"

    28

#include "roadveh.h"

    29

#include "depot.h"

    30

    31

Sorting _sorting;

    32

    33

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

    34

static const Vehicle* _last_vehicle; // cached vehicle to hopefully speed up name-sorting

    35

static bool   _internal_sort_order;     // descending/ascending

    36

    37

static uint16 _player_num_engines[TOTAL_NUM_ENGINES];

    38

static RailType _railtype_selected_in_replace_gui;

    39

    40

    41

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

    42

    43

static VehicleSortListingTypeFunction VehicleUnsortedSorter;

    44

static VehicleSortListingTypeFunction VehicleNumberSorter;

    45

static VehicleSortListingTypeFunction VehicleNameSorter;

    46

static VehicleSortListingTypeFunction VehicleAgeSorter;

    47

static VehicleSortListingTypeFunction VehicleProfitThisYearSorter;

    48

static VehicleSortListingTypeFunction VehicleProfitLastYearSorter;

    49

static VehicleSortListingTypeFunction VehicleCargoSorter;

    50

static VehicleSortListingTypeFunction VehicleReliabilitySorter;

    51

static VehicleSortListingTypeFunction VehicleMaxSpeedSorter;

    52

static VehicleSortListingTypeFunction VehicleModelSorter;

    53

static VehicleSortListingTypeFunction VehicleValueSorter;

    54

    55

static VehicleSortListingTypeFunction* const _vehicle_sorter[] = {

    56

	&VehicleUnsortedSorter,

    57

	&VehicleNumberSorter,

    58

	&VehicleNameSorter,

    59

	&VehicleAgeSorter,

    60

	&VehicleProfitThisYearSorter,

    61

	&VehicleProfitLastYearSorter,

    62

	&VehicleCargoSorter,

    63

	&VehicleReliabilitySorter,

    64

	&VehicleMaxSpeedSorter,

    65

	&VehicleModelSorter,

    66

	&VehicleValueSorter,

    67

};

    68

    69

const StringID _vehicle_sort_listing[] = {

    70

	STR_SORT_BY_UNSORTED,

    71

	STR_SORT_BY_NUMBER,

    72

	STR_SORT_BY_DROPDOWN_NAME,

    73

	STR_SORT_BY_AGE,

    74

	STR_SORT_BY_PROFIT_THIS_YEAR,

    75

	STR_SORT_BY_PROFIT_LAST_YEAR,

    76

	STR_SORT_BY_TOTAL_CAPACITY_PER_CARGOTYPE,

    77

	STR_SORT_BY_RELIABILITY,

    78

	STR_SORT_BY_MAX_SPEED,

    79

	STR_SORT_BY_MODEL,

    80

	STR_SORT_BY_VALUE,

    81

	INVALID_STRING_ID

    82

};

    83

    84

static const StringID _rail_types_list[] = {

    85

	STR_RAIL_VEHICLES,

    86

	STR_ELRAIL_VEHICLES,

    87

	STR_MONORAIL_VEHICLES,

    88

	STR_MAGLEV_VEHICLES,

    89

	INVALID_STRING_ID

    90

};

    91

    92

void RebuildVehicleLists(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_REBUILD;

   101

			SetWindowDirty(w);

   102

			break;

   103

		default: break;

   104

		}

   105

}

   106

   107

void ResortVehicleLists(void)

   108

{

   109

	Window *w;

   110

   111

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

   112

		switch (w->window_class) {

   113

		case WC_TRAINS_LIST: case WC_ROADVEH_LIST:

   114

		case WC_SHIPS_LIST:  case WC_AIRCRAFT_LIST:

   115

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

   116

			SetWindowDirty(w);

   117

			break;

   118

		default: break;

   119

		}

   120

}

   121

   122

static void BuildVehicleList(vehiclelist_d* vl, int type, PlayerID owner, StationID station, OrderID order, uint16 window_type)

   123

{

   124

	const Vehicle** sort_list;

   125

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

   126

	uint n = 0;

   127

	uint i;

   128

   129

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

   130

   131

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

   132

	if (sort_list == NULL) {

   133

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

   134

	}

   135

   136

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

   137

		owner, station);

   138

   139

	switch (window_type) {

   140

		case VLW_STATION_LIST: {

   141

			const Vehicle *v;

   142

			FOR_ALL_VEHICLES(v) {

   143

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

   144

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

   145

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

   146

					const Order *order;

   147

   148

					FOR_VEHICLE_ORDERS(v, order) {

   149

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

   150

							sort_list[n++] = v;

   151

							break;

   152

						}

   153

					}

   154

				}

   155

			}

   156

		} break;

   157

   158

		case VLW_SHARED_ORDERS: {

   159

			Vehicle *v;

   160

			FOR_ALL_VEHICLES(v) {

   161

				/* Find a vehicle with the order in question */

   162

				if (v != NULL && v->orders != NULL && v->orders->index == order) break;

   163

			}

   164

   165

			if (v != NULL && v->orders != NULL && v->orders->index == order) {

   166

				/* Only try to make the list if we found a vehicle using the order in question */

   167

				for (v = GetFirstVehicleFromSharedList(v); v != NULL; v = v->next_shared) {

   168

					sort_list[n++] = v;

   169

				}

   170

			}

   171

		} break;

   172

   173

		case VLW_STANDARD: {

   174

			const Vehicle *v;

   175

			FOR_ALL_VEHICLES(v) {

   176

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

   177

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

   178

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

   179

					sort_list[n++] = v;

   180

				}

   181

			}

   182

		} break;

   183

   184

		default: NOT_REACHED(); break;

   185

	}

   186

   187

	free((void*)vl->sort_list);

   188

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

   189

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

   190

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

   191

	}

   192

	vl->list_length = n;

   193

   194

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

   195

	free((void*)sort_list);

   196

   197

	vl->flags &= ~VL_REBUILD;

   198

	vl->flags |= VL_RESORT;

   199

}

   200

   201

static void SortVehicleList(vehiclelist_d *vl)

   202

{

   203

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

   204

   205

	_internal_sort_order = vl->flags & VL_DESC;

   206

	_internal_name_sorter_id = STR_SV_TRAIN_NAME;

   207

	_last_vehicle = NULL; // used for "cache" in namesorting

   208

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

   209

		_vehicle_sorter[vl->sort_type]);

   210

   211

	vl->resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   212

	vl->flags &= ~VL_RESORT;

   213

}

   214

   215

   216

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

   217

void InitializeVehiclesGuiList(void)

   218

{

   219

	_railtype_selected_in_replace_gui = RAILTYPE_RAIL;

   220

}

   221

   222

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

   223

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

   224

{

   225

	uint32 ormod;

   226

   227

	// draw profit-based colored icons

   228

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

   229

		ormod = PALETTE_TO_GREY;

   230

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

   231

		ormod = PALETTE_TO_RED;

   232

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

   233

		ormod = PALETTE_TO_YELLOW;

   234

	} else {

   235

		ormod = PALETTE_TO_GREEN;

   236

	}

   237

	DrawSprite(SPR_BLOT | ormod, x, y);

   238

}

   239

   240

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

   241

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

   242

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

   243

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

   244

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

   245

 */

   246

CargoID DrawVehicleRefitWindow(const Vehicle *v, int sel)

   247

{

   248

	uint32 cmask = 0;

   249

	CargoID cid, cargo = CT_INVALID;

   250

	int y = 25;

   251

	const Vehicle* u = v;

   252

   253

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

   254

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

   255

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

   256

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

   257

	do {

   258

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

   259

		u = u->next;

   260

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

   261

   262

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

   263

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

   264

		if (HASBIT(cmask, 0)) {

   265

			// vehicle is refittable to this cargo

   266

			byte colour = 16;

   267

			if (sel == 0) {

   268

				cargo = _local_cargo_id_ctype[cid];

   269

				colour = 12;

   270

			}

   271

   272

			sel--;

   273

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

   274

			y += 10;

   275

		}

   276

	}

   277

   278

	return cargo;

   279

}

   280

   281

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

   282

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

   283

{

   284

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

   285

	if (callback == CALLBACK_FAILED) return 0;

   286

   287

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

   288

	return 10;

   289

}

   290

   291

   292

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

   293

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

   294

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

   295

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

   296

*    STR_SV_TRAIN_NAME for trains or STR_SV_AIRCRAFT_NAME for aircraft

   297

*/

   298

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

   299

{

   300

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

   301

}

   302

   303

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

   304

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

   305

   306

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

   307

{

   308

	const Vehicle* va = *(const Vehicle**)a;

   309

	const Vehicle* vb = *(const Vehicle**)b;

   310

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

   311

   312

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

   313

}

   314

   315

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

   316

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

   317

{

   318

	const Vehicle* va = *(const Vehicle**)a;

   319

	const Vehicle* vb = *(const Vehicle**)b;

   320

	char buf1[64] = "\0";

   321

	int r;

   322

   323

	if (va->string_id != _internal_name_sorter_id) {

   324

		SetDParam(0, va->string_id);

   325

		GetString(buf1, STR_JUST_STRING);

   326

	}

   327

   328

	if (vb != _last_vehicle) {

   329

		_last_vehicle = vb;

   330

		_bufcache[0] = '\0';

   331

		if (vb->string_id != _internal_name_sorter_id) {

   332

			SetDParam(0, vb->string_id);

   333

			GetString(_bufcache, STR_JUST_STRING);

   334

		}

   335

	}

   336

   337

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

   338

   339

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   340

   341

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

   342

}

   343

   344

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

   345

{

   346

	const Vehicle* va = *(const Vehicle**)a;

   347

	const Vehicle* vb = *(const Vehicle**)b;

   348

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

   349

   350

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   351

   352

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

   353

}

   354

   355

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

   356

{

   357

	const Vehicle* va = *(const Vehicle**)a;

   358

	const Vehicle* vb = *(const Vehicle**)b;

   359

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

   360

   361

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   362

   363

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

   364

}

   365

   366

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

   367

{

   368

	const Vehicle* va = *(const Vehicle**)a;

   369

	const Vehicle* vb = *(const Vehicle**)b;

   370

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

   371

   372

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   373

   374

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

   375

}

   376

   377

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

   378

{

   379

	const Vehicle* va = *(const Vehicle**)a;

   380

	const Vehicle* vb = *(const Vehicle**)b;

   381

	const Vehicle* v;

   382

	AcceptedCargo cargoa;

   383

	AcceptedCargo cargob;

   384

	int r = 0;

   385

	int i;

   386

   387

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

   388

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

   389

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

   390

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

   391

   392

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

   393

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

   394

		if (r != 0) break;

   395

	}

   396

   397

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   398

   399

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

   400

}

   401

   402

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

   403

{

   404

	const Vehicle* va = *(const Vehicle**)a;

   405

	const Vehicle* vb = *(const Vehicle**)b;

   406

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

   407

   408

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   409

   410

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

   411

}

   412

   413

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

   414

{

   415

	const Vehicle* va = *(const Vehicle**)a;

   416

	const Vehicle* vb = *(const Vehicle**)b;

   417

	int max_speed_a = 0xFFFF, max_speed_b = 0xFFFF;

   418

	int r;

   419

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

   420

   421

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

   422

		do {

   423

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

   424

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

   425

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

   426

   427

		do {

   428

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

   429

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

   430

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

   431

   432

		r = max_speed_a - max_speed_b;

   433

	} else {

   434

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

   435

	}

   436

   437

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   438

   439

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

   440

}

   441

   442

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

   443

{

   444

	const Vehicle* va = *(const Vehicle**)a;

   445

	const Vehicle* vb = *(const Vehicle**)b;

   446

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

   447

   448

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   449

   450

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

   451

}

   452

   453

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

   454

{

   455

	const Vehicle* va = *(const Vehicle**)a;

   456

	const Vehicle* vb = *(const Vehicle**)b;

   457

	const Vehicle *u;

   458

	int valuea = 0, valueb = 0;

   459

	int r;

   460

   461

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

   462

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

   463

   464

	r = valuea - valueb;

   465

   466

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   467

   468

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

   469

}

   470

   471

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

   472

// ENGINE_AVAILABLE is used in ReplaceVehicleWndProc

   473

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

   474

   475

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

   476

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

   477

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

   478

 */

   479

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

   480

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

   481

{

   482

	EngineID j;

   483

	byte colour;

   484

	const Player *p = GetPlayer(_local_player);