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

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

   121

		owner, station);

   122

   123

	if (station != INVALID_STATION) {

   124

		const Vehicle *v;

   125

		FOR_ALL_VEHICLES(v) {

   126

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

   127

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

   128

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

   129

				const Order *order;

   130

   131

				FOR_VEHICLE_ORDERS(v, order) {

   132

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

   133

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

   134

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

   135

						++n;

   136

						break;

   137

					}

   138

				}

   139

			}

   140

		}

   141

	} else {

   142

		const Vehicle *v;

   143

		FOR_ALL_VEHICLES(v) {

   144

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

   145

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

   146

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

   147

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

   148

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

   149

				++n;

   150

			}

   151

		}

   152

	}

   153

   154

	free(vl->sort_list);

   155

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

   156

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

   157

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

   158

	vl->list_length = n;

   159

   160

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

   161

	free(sort_list);

   162

   163

	vl->flags &= ~VL_REBUILD;

   164

	vl->flags |= VL_RESORT;

   165

}

   166

   167

void SortVehicleList(vehiclelist_d *vl)

   168

{

   169

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

   170

   171

	_internal_sort_order = vl->flags & VL_DESC;

   172

	_internal_name_sorter_id = STR_SV_TRAIN_NAME;

   173

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

   174

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

   175

		_vehicle_sorter[vl->sort_type]);

   176

   177

	vl->resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   178

	vl->flags &= ~VL_RESORT;

   179

}

   180

   181

   182

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

   183

void InitializeVehiclesGuiList(void)

   184

{

   185

	_railtype_selected_in_replace_gui = RAILTYPE_RAIL;

   186

}

   187

   188

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

   189

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

   190

{

   191

	uint32 ormod;

   192

   193

	// draw profit-based colored icons

   194

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

   195

		ormod = PALETTE_TO_GREY;

   196

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

   197

		ormod = PALETTE_TO_RED;

   198

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

   199

		ormod = PALETTE_TO_YELLOW;

   200

	} else {

   201

		ormod = PALETTE_TO_GREEN;

   202

	}

   203

	DrawSprite(SPR_BLOT | ormod, x, y);

   204

}

   205

   206

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

   207

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

   208

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

   209

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

   210

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

   211

 */

   212

CargoID DrawVehicleRefitWindow(const Vehicle *v, int sel)

   213

{

   214

	uint32 cmask;

   215

	CargoID cid, cargo = CT_INVALID;

   216

	int y = 25;

   217

	const Vehicle* u;

   218

#define show_cargo(ctype) { \

   219

		byte colour = 16; \

   220

		if (sel == 0) { \

   221

			cargo = ctype; \

   222

			colour = 12; \

   223

} \

   224

		sel--; \

   225

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

   226

		y += 10; \

   227

}

   228

   229

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

   230

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

   231

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

   232

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

   233

		cmask = 0;

   234

		u = v;

   235

		do {

   236

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

   237

			u = u->next;

   238

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

   239

   240

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

   241

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

   242

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

   243

				show_cargo(_local_cargo_id_ctype[cid]);

   244

		}

   245

		return cargo;

   246

}

   247

   248

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

   249

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

   250

{

   251

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

   252

}

   253

   254

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

   255

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

   256

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

   257

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

   258

*    STR_SV_TRAIN_NAME for trains or STR_SV_AIRCRAFT_NAME for aircraft

   259

*/

   260

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

   261

{

   262

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

   263

}

   264

   265

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

   266

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

   267

   268

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

   269

{

   270

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

   271

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

   272

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

   273

   274

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

   275

}

   276

   277

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

   278

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

   279

{

   280

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

   281

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

   282

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

   283

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

   284

	char buf1[64] = "\0";

   285

	int r;

   286

   287

	if (va->string_id != _internal_name_sorter_id) {

   288

		SetDParam(0, va->string_id);

   289

		GetString(buf1, STR_JUST_STRING);

   290

	}

   291

   292

	if (cmp2->index != _last_vehicle_idx) {

   293

		_last_vehicle_idx = cmp2->index;

   294

		_bufcache[0] = '\0';

   295

		if (vb->string_id != _internal_name_sorter_id) {

   296

			SetDParam(0, vb->string_id);

   297

			GetString(_bufcache, STR_JUST_STRING);

   298

		}

   299

	}

   300

   301

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

   302

   303

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   304

   305

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

   306

}

   307

   308

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

   309

{

   310

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

   311

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

   312

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

   313

   314

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   315

   316

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

   317

}

   318

   319

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

   320

{

   321

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

   322

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

   323

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

   324

   325

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   326

   327

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

   328

}

   329

   330

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

   331

{

   332

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

   333

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

   334

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

   335

   336

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   337

   338

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

   339

}

   340

   341

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

   342

{

   343

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

   344

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

   345

	const Vehicle* v;

   346

	AcceptedCargo cargoa;

   347

	AcceptedCargo cargob;

   348

	int r = 0;

   349

	int i;

   350

   351

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

   352

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

   353

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

   354

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

   355

   356

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

   357

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

   358

		if (r != 0) break;

   359

	}

   360

   361

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   362

   363

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

   364

}

   365

   366

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

   367

{

   368

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

   369

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

   370

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

   371

   372

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   373

   374

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

   375

}

   376

   377

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

   378

{

   379

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

   380

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

   381

	int max_speed_a = 0xFFFF, max_speed_b = 0xFFFF;

   382

	int r;

   383

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

   384

   385

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

   386

		do {

   387

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

   388

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

   389

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

   390

   391

		do {

   392

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

   393

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

   394

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

   395

   396

		r = max_speed_a - max_speed_b;

   397

	} else {

   398

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

   399

	}

   400

   401

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   402

   403

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

   404

}

   405

   406

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

   407

// ENGINE_AVAILABLE is used in ReplaceVehicleWndProc

   408

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

   409

   410

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

   411

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

   412

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

   413

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

   414

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

   415

{

   416

	EngineID i;

   417

	byte colour;

   418

	const Player *p = GetPlayer(_local_player);

   419

   420

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

   421

		const Engine *e = GetEngine(i);

   422

		const RailVehicleInfo *rvi = RailVehInfo(i);

   423

		const EngineInfo *info = &_engine_info[i];

   424

   425

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

   426

   427

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

   428

			continue;

   429

   430

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

   431

   432

   433

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

   434

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

   435

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

   436

				!HASBIT(e->player_avail, _local_player))

   437

				continue;

   438

		} /*else {

   439

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

   440

			if ( _autoreplace_array[i] != i )

   441

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

   442

		} */

   443

   444

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

   445

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

   446

				colour);

   447

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

   448

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

   449

				PALETTE_CRASH : SPRITE_PALETTE(PLAYER_SPRITE_COLOR(_local_player)));

   450

			if ( show_outdated ) {

   451

				SetDParam(0, _player_num_engines[i]);

   452

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

   453

			}

   454

			*y += 14;

   455

		}

   456

		--*sel;

   457

	}

   458

}

   459

   460

   461

static void SetupScrollStuffForReplaceWindow(Window *w)

   462

{

   463

	RailType railtype;

   464

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

   465

	int sel[2];

   466

	int count = 0;

   467

	int count2 = 0;

   468

	EngineID engine_id;

   469

	const Player *p = GetPlayer(_local_player);

   470

   471

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

   472

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

   473

   474

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

   475

		case VEH_Train: {

   476

			railtype = _railtype_selected_in_replace_gui;

   477

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

   478

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

   479

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

   480

				const Engine *e = GetEngine(engine_id);

   481

				const EngineInfo *info = &_engine_info[engine_id];

   482

   483

				if (ENGINE_AVAILABLE && RailVehInfo(engine_id)->power && e->railtype == railtype) {

   484

					if (_player_num_engines[engine_id] > 0 || EngineHasReplacementForPlayer(p, engine_id)) {

   485

						if (sel[0] == 0) selected_id[0] = engine_id;