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

    23

Sorting _sorting;

    24

    25

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

    26

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

    27

static bool   _internal_sort_order;     // descending/ascending

    28

    29

static uint16 _player_num_engines[TOTAL_NUM_ENGINES];

    30

static RailType _railtype_selected_in_replace_gui;

    31

    32

    33

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

    34

    35

static VehicleSortListingTypeFunction VehicleUnsortedSorter;

    36

static VehicleSortListingTypeFunction VehicleNumberSorter;

    37

static VehicleSortListingTypeFunction VehicleNameSorter;

    38

static VehicleSortListingTypeFunction VehicleAgeSorter;

    39

static VehicleSortListingTypeFunction VehicleProfitThisYearSorter;

    40

static VehicleSortListingTypeFunction VehicleProfitLastYearSorter;

    41

static VehicleSortListingTypeFunction VehicleCargoSorter;

    42

static VehicleSortListingTypeFunction VehicleReliabilitySorter;

    43

static VehicleSortListingTypeFunction VehicleMaxSpeedSorter;

    44

    45

static VehicleSortListingTypeFunction* const _vehicle_sorter[] = {

    46

	&VehicleUnsortedSorter,

    47

	&VehicleNumberSorter,

    48

	&VehicleNameSorter,

    49

	&VehicleAgeSorter,

    50

	&VehicleProfitThisYearSorter,

    51

	&VehicleProfitLastYearSorter,

    52

	&VehicleCargoSorter,

    53

	&VehicleReliabilitySorter,

    54

	&VehicleMaxSpeedSorter

    55

};

    56

    57

const StringID _vehicle_sort_listing[] = {

    58

	STR_SORT_BY_UNSORTED,

    59

	STR_SORT_BY_NUMBER,

    60

	STR_SORT_BY_DROPDOWN_NAME,

    61

	STR_SORT_BY_AGE,

    62

	STR_SORT_BY_PROFIT_THIS_YEAR,

    63

	STR_SORT_BY_PROFIT_LAST_YEAR,

    64

	STR_SORT_BY_TOTAL_CAPACITY_PER_CARGOTYPE,

    65

	STR_SORT_BY_RELIABILITY,

    66

	STR_SORT_BY_MAX_SPEED,

    67

	INVALID_STRING_ID

    68

};

    69

    70

static const StringID _rail_types_list[] = {

    71

	STR_RAIL_VEHICLES,

    72

	STR_MONORAIL_VEHICLES,

    73

	STR_MAGLEV_VEHICLES,

    74

	INVALID_STRING_ID

    75

};

    76

    77

void RebuildVehicleLists(void)

    78

{

    79

	Window *w;

    80

    81

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

    82

		switch (w->window_class) {

    83

		case WC_TRAINS_LIST: case WC_ROADVEH_LIST:

    84

		case WC_SHIPS_LIST:  case WC_AIRCRAFT_LIST:

    85

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

    86

			SetWindowDirty(w);

    87

			break;

    88

		default: break;

    89

		}

    90

}

    91

    92

void ResortVehicleLists(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_RESORT;

   101

			SetWindowDirty(w);

   102

			break;

   103

		default: break;

   104

		}

   105

}

   106

   107

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

   108

{

   109

	SortStruct* sort_list;

   110

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

   111

	uint n = 0;

   112

	uint i;

   113

   114

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

   115

   116

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

   117

	if (sort_list == NULL) {

   118

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

   119

	}

   120

   121

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

   122

		owner, station);

   123

   124

	if (station != INVALID_STATION) {

   125

		const Vehicle *v;

   126

		FOR_ALL_VEHICLES(v) {

   127

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

   128

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

   129

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

   130

					)) {

   131

				const Order *order;

   132

   133

				FOR_VEHICLE_ORDERS(v, order) {

   134

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

   135

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

   136

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

   137

						++n;

   138

						break;

   139

					}

   140

				}

   141

			}

   142

		}

   143

	} else {

   144

		const Vehicle *v;

   145

		FOR_ALL_VEHICLES(v) {

   146

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

   147

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

   148

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

   149

					)) {

   150

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

   151

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

   152

				++n;

   153

			}

   154

		}

   155

	}

   156

   157

	free(vl->sort_list);

   158

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

   159

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

   160

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

   161

	}

   162

	vl->list_length = n;

   163

   164

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

   165

	free(sort_list);

   166

   167

	vl->flags &= ~VL_REBUILD;

   168

	vl->flags |= VL_RESORT;

   169

}

   170

   171

void SortVehicleList(vehiclelist_d *vl)

   172

{

   173

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

   174

   175

	_internal_sort_order = vl->flags & VL_DESC;

   176

	_internal_name_sorter_id = STR_SV_TRAIN_NAME;

   177

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

   178

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

   179

		_vehicle_sorter[vl->sort_type]);

   180

   181

	vl->resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   182

	vl->flags &= ~VL_RESORT;

   183

}

   184

   185

   186

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

   187

void InitializeVehiclesGuiList(void)

   188

{

   189

	_railtype_selected_in_replace_gui = RAILTYPE_RAIL;

   190

}

   191

   192

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

   193

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

   194

{

   195

	uint32 ormod;

   196

   197

	// draw profit-based colored icons

   198

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

   199

		ormod = PALETTE_TO_GREY;

   200

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

   201

		ormod = PALETTE_TO_RED;

   202

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

   203

		ormod = PALETTE_TO_YELLOW;

   204

	} else {

   205

		ormod = PALETTE_TO_GREEN;

   206

	}

   207

	DrawSprite(SPR_BLOT | ormod, x, y);

   208

}

   209

   210

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

   211

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

   212

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

   213

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

   214

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

   215

 */

   216

CargoID DrawVehicleRefitWindow(const Vehicle *v, int sel)

   217

{

   218

	uint32 cmask;

   219

	CargoID cid, cargo = CT_INVALID;

   220

	int y = 25;

   221

	const Vehicle* u;

   222

#define show_cargo(ctype) { \

   223

		byte colour = 16; \

   224

		if (sel == 0) { \

   225

			cargo = ctype; \

   226

			colour = 12; \

   227

} \

   228

		sel--; \

   229

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

   230

		y += 10; \

   231

}

   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

		cmask = 0;

   238

		u = v;

   239

		do {

   240

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

   241

			u = u->next;

   242

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

   243

   244

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

   245

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

   246

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

   247

				show_cargo(_local_cargo_id_ctype[cid]);

   248

		}

   249

		return cargo;

   250

}

   251

   252

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

   253

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

   254

{

   255

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

   256

}

   257

   258

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

   259

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

   260

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

   261

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

   262

*    STR_SV_TRAIN_NAME for trains or STR_SV_AIRCRAFT_NAME for aircraft

   263

*/

   264

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

   265

{

   266

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

   267

}

   268

   269

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

   270

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

   271

   272

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

   273

{

   274

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

   275

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

   276

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

   277

   278

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

   279

}

   280

   281

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

   282

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

   283

{

   284

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

   285

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

   286

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

   287

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

   288

	char buf1[64] = "\0";

   289

	int r;

   290

   291

	if (va->string_id != _internal_name_sorter_id) {

   292

		SetDParam(0, va->string_id);

   293

		GetString(buf1, STR_JUST_STRING);

   294

	}

   295

   296

	if (cmp2->index != _last_vehicle_idx) {

   297

		_last_vehicle_idx = cmp2->index;

   298

		_bufcache[0] = '\0';

   299

		if (vb->string_id != _internal_name_sorter_id) {

   300

			SetDParam(0, vb->string_id);

   301

			GetString(_bufcache, STR_JUST_STRING);

   302

		}

   303

	}

   304

   305

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

   306

   307

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   308

   309

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

   310

}

   311

   312

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

   313

{

   314

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

   315

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

   316

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

   317

   318

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   319

   320

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

   321

}

   322

   323

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

   324

{

   325

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

   326

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

   327

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

   328

   329

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   330

   331

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

   332

}

   333

   334

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

   335

{

   336

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

   337

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

   338

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

   339

   340

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   341

   342

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

   343

}

   344

   345

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

   346

{

   347

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

   348

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

   349

	const Vehicle* v;

   350

	AcceptedCargo cargoa;

   351

	AcceptedCargo cargob;

   352

	int r = 0;

   353

	int i;

   354

   355

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

   356

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

   357

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

   358

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

   359

   360

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

   361

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

   362

		if (r != 0) break;

   363

	}

   364

   365

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   366

   367

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

   368

}

   369

   370

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

   371

{

   372

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

   373

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

   374

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

   375

   376

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   377

   378

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

   379

}

   380

   381

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

   382

{

   383

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

   384

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

   385

	int max_speed_a = 0xFFFF, max_speed_b = 0xFFFF;

   386

	int r;

   387

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

   388

   389

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

   390

		do {

   391

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

   392

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

   393

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

   394

   395

		do {

   396

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

   397

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

   398

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

   399

   400

		r = max_speed_a - max_speed_b;

   401

	} else {

   402

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

   403

	}

   404

   405

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   406

   407

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

   408

}

   409

   410

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

   411

// ENGINE_AVAILABLE is used in ReplaceVehicleWndProc

   412

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

   413

   414

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

   415

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

   416

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

   417

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

   418

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

   419

{

   420

	EngineID i;

   421

	byte colour;

   422

	const Player *p = GetPlayer(_local_player);

   423

   424

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

   425

		const Engine *e = GetEngine(i);

   426

		const RailVehicleInfo *rvi = RailVehInfo(i);

   427

		const EngineInfo *info = &_engine_info[i];

   428

   429

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

   430

   431

		if (rvi->power == 0 && !show_cars)   // disables display of cars (works since they do not have power)

   432

			continue;

   433

   434

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

   435

   436

   437

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

   438

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

   439

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

   440

				!HASBIT(e->player_avail, _local_player))

   441

				continue;

   442

		} /*else {

   443

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

   444

			if ( _autoreplace_array[i] != i )

   445

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

   446

		} */

   447

   448

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

   449

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

   450

				colour);

   451

			// show_outdated is true only for left side, which is where we show old replacements

   452

			DrawTrainEngine(*x + 29, *y + 6, i, (_player_num_engines[i] == 0 && show_outdated) ?

   453

				PALETTE_CRASH : SPRITE_PALETTE(PLAYER_SPRITE_COLOR(_local_player)));

   454

			if ( show_outdated ) {

   455

				SetDParam(0, _player_num_engines[i]);

   456

				DrawStringRightAligned(213, *y+5, STR_TINY_BLACK, 0);

   457

			}

   458

			*y += 14;

   459

		}

   460

		--*sel;

   461

	}

   462

}

   463

   464

   465

static void SetupScrollStuffForReplaceWindow(Window *w)

   466

{

   467

	RailType railtype;

   468

	EngineID selected_id[2] = { INVALID_ENGINE, INVALID_ENGINE };

   469

	int sel[2];

   470

	int count = 0;

   471

	int count2 = 0;

   472

	EngineID engine_id;

   473

	const Player *p = GetPlayer(_local_player);

   474

   475

	sel[0] = WP(w,replaceveh_d).sel_index[0];

   476

	sel[1] = WP(w,replaceveh_d).sel_index[1];

   477

   478

	switch (WP(w,replaceveh_d).vehicletype) {

   479

		case VEH_Train: {

   480

			railtype = _railtype_selected_in_replace_gui;

   481

			w->widget[13].color = _player_colors[_local_player];	// sets the colour of that art thing

   482

			w->widget[16].color = _player_colors[_local_player];	// sets the colour of that art thing

   483

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

   484

				const Engine *e = GetEngine(engine_id);

   485

				const EngineInfo *info = &_engine_info[engine_id];