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

{

   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) {

   147

						break;

   148

					}

   149

				}

   150

			}

   151

		}

   152

	} else {

   153

		const Vehicle *v;

   154

		FOR_ALL_VEHICLES(v) {

   155

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

   156

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

   157

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

   158

					)) {

   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 = 0;

   226

	CargoID cid, cargo = CT_INVALID;

   227

	int y = 25;

   228

	const Vehicle* u = v;

   229

   230

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

   231

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

   232

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

   233

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

   234

	do {

   235

		cmask |= EngInfo(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)) {

   242

			// vehicle is refittable to this cargo

   243

			byte colour = 16;

   244

			if (sel == 0) {

   245

				cargo = _local_cargo_id_ctype[cid];

   246

				colour = 12;

   247

			}

   248

   249

			sel--;

   250

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

   251

			y += 10;

   252

		}

   253

	}

   254

   255

	return cargo;

   256

}

   257

   258

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

   259

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

   260

{

   261

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

   262

	if (callback == CALLBACK_FAILED) return 0;

   263

   264

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

   265

	return 10;

   266

}

   267

   268

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

   269

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

   270

{

   271

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

   272

}

   273

   274

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

   275

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

   276

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

   277

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

   278

*    STR_SV_TRAIN_NAME for trains or STR_SV_AIRCRAFT_NAME for aircraft

   279

*/

   280

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

   281

{

   283

}

   284

   285

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

   286

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

   287

   288

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

   289

{

   292

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

   293

   294

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

   295

}

   296

   297

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

   298

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

   299

{

   302

	char buf1[64] = "\0";

   303

	int r;

   304

   305

	if (va->string_id != _internal_name_sorter_id) {

   306

		SetDParam(0, va->string_id);

   307

		GetString(buf1, STR_JUST_STRING);

   308

	}

   309

   312

		_bufcache[0] = '\0';

   313

		if (vb->string_id != _internal_name_sorter_id) {

   314

			SetDParam(0, vb->string_id);

   315

			GetString(_bufcache, STR_JUST_STRING);

   316

		}

   317

	}

   318

   319

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

   320

   321

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   322

   323

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

   324

}

   325

   326

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

   327

{

   330

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

   331

   332

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   333

   334

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

   335

}

   336

   337

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

   338

{

   341

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

   342

   343

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   344

   345

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

   346

}

   347

   348

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

   349

{

   352

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

   353

   354

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   355

   356

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

   357

}

   358

   359

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

   360

{

   363

	const Vehicle* v;

   364

	AcceptedCargo cargoa;

   365

	AcceptedCargo cargob;

   366

	int r = 0;

   367

	int i;

   368

   369

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

   370

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

   371

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

   372

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

   373

   374

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

   375

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

   376

		if (r != 0) break;

   377

	}

   378

   379

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   380

   381

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

   382

}

   383

   384

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

   385

{

   388

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

   389

   390

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   391

   392

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

   393

}

   394

   395

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

   396

{

   399

	int max_speed_a = 0xFFFF, max_speed_b = 0xFFFF;

   400

	int r;

   401

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

   402

   403

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

   404

		do {

   405

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

   406

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

   407

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

   408

   409

		do {

   410

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

   411

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

   412

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

   413

   414

		r = max_speed_a - max_speed_b;

   415

	} else {

   416

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

   417

	}

   418

   419

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   420

   421

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

   422

}

   423

   424

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

   425

{

   428

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

   429

   430

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   431

   432

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

   433

}

   434

   435

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

   436

{

   439

	const Vehicle *u;

   440

	int valuea = 0, valueb = 0;

   441

	int r;

   442

   443

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

   444

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

   445

   446

	r = valuea - valueb;

   447

   448

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   449

   450

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

   451

}

   452

   453

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

   454

// ENGINE_AVAILABLE is used in ReplaceVehicleWndProc

   455

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

   456

   457

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

   458

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

   459

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

   460

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

   461

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

   462

{

   463

	EngineID j;

   464

	byte colour;

   465

	const Player *p = GetPlayer(_local_player);

   466

   467

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

   468

		EngineID i = GetRailVehAtPosition(j);

   469

		const Engine *e = GetEngine(i);

   470

		const RailVehicleInfo *rvi = RailVehInfo(i);

   471

		const EngineInfo *info = EngInfo(i);

   472

   473

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

   474

   475

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

   476

			continue;

   477

   478

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

   479

   480

   481

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

   482

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

   483

			if ((!IsCompatibleRail(e->railtype, railtype) && show_compatible)

   484

				|| (e->railtype != railtype && !show_compatible)

   485

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