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

    22

Sorting _sorting;

    23

    24

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

    25

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

    26

static bool   _internal_sort_order;     // descending/ascending

    27

    28

static uint16 _player_num_engines[TOTAL_NUM_ENGINES];

    29

static RailType _railtype_selected_in_replace_gui;

    30

    31

    32

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

    33

    34

static VehicleSortListingTypeFunction VehicleUnsortedSorter;

    35

static VehicleSortListingTypeFunction VehicleNumberSorter;

    36

static VehicleSortListingTypeFunction VehicleNameSorter;

    37

static VehicleSortListingTypeFunction VehicleAgeSorter;

    38

static VehicleSortListingTypeFunction VehicleProfitThisYearSorter;

    39

static VehicleSortListingTypeFunction VehicleProfitLastYearSorter;

    40

static VehicleSortListingTypeFunction VehicleCargoSorter;

    41

static VehicleSortListingTypeFunction VehicleReliabilitySorter;

    42

static VehicleSortListingTypeFunction VehicleMaxSpeedSorter;

    43

    44

static VehicleSortListingTypeFunction* const _vehicle_sorter[] = {

    45

	&VehicleUnsortedSorter,

    46

	&VehicleNumberSorter,

    47

	&VehicleNameSorter,

    48

	&VehicleAgeSorter,

    49

	&VehicleProfitThisYearSorter,

    50

	&VehicleProfitLastYearSorter,

    51

	&VehicleCargoSorter,

    52

	&VehicleReliabilitySorter,

    53

	&VehicleMaxSpeedSorter

    54

};

    55

    56

const StringID _vehicle_sort_listing[] = {

    57

	STR_SORT_BY_UNSORTED,

    58

	STR_SORT_BY_NUMBER,

    59

	STR_SORT_BY_DROPDOWN_NAME,

    60

	STR_SORT_BY_AGE,

    61

	STR_SORT_BY_PROFIT_THIS_YEAR,

    62

	STR_SORT_BY_PROFIT_LAST_YEAR,

    63

	STR_SORT_BY_TOTAL_CAPACITY_PER_CARGOTYPE,

    64

	STR_SORT_BY_RELIABILITY,

    65

	STR_SORT_BY_MAX_SPEED,

    66

	INVALID_STRING_ID

    67

};

    68

    69

static const StringID _rail_types_list[] = {

    70

	STR_RAIL_VEHICLES,

    71

	STR_MONORAIL_VEHICLES,

    72

	STR_MAGLEV_VEHICLES,

    73

	INVALID_STRING_ID

    74

};

    75

    76

void RebuildVehicleLists(void)

    77

{

    78

	Window *w;

    79

    80

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

    81

		switch (w->window_class) {

    82

		case WC_TRAINS_LIST: case WC_ROADVEH_LIST:

    83

		case WC_SHIPS_LIST:  case WC_AIRCRAFT_LIST:

    84

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

    85

			SetWindowDirty(w);

    86

			break;

    87

		default: break;

    88

		}

    89

}

    90

    91

void ResortVehicleLists(void)

    92

{

    93

	Window *w;

    94

    95

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

    96

		switch (w->window_class) {

    97

		case WC_TRAINS_LIST: case WC_ROADVEH_LIST:

    98

		case WC_SHIPS_LIST:  case WC_AIRCRAFT_LIST:

    99

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

   100

			SetWindowDirty(w);

   101

			break;

   102

		default: break;

   103

		}

   104

}

   105

   106

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

   107

{

   108

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

   109

	uint n = 0;

   110

	uint i;

   111

   112

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

   113

   114

	/* Create array for sorting */

   115

	_vehicle_sort = realloc(_vehicle_sort, GetVehiclePoolSize() * sizeof(_vehicle_sort[0]));

   116

	if (_vehicle_sort == NULL)

   117

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

   118

   119

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

   120

		owner, station);

   121

   122

	if (station != INVALID_STATION) {

   123

		const Vehicle *v;

   124

		FOR_ALL_VEHICLES(v) {

   125

			if (v->type == type && v->subtype <= subtype) {

   126

				const Order *order;

   127

   128

				FOR_VEHICLE_ORDERS(v, order) {

   129

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

   130

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

   131

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

   132

						++n;

   133

						break;

   134

					}

   135

				}

   136

			}

   137

		}

   138

	} else {

   139

		const Vehicle *v;

   140

		FOR_ALL_VEHICLES(v) {

   141

			if (v->type == type && v->subtype <= subtype && v->owner == owner) {

   142

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

   143

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

   144

				++n;

   145

			}

   146

		}

   147

	}

   148

   149

	free(vl->sort_list);

   150

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

   151

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

   152

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

   153

	vl->list_length = n;

   154

   155

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

   156

   157

	vl->flags &= ~VL_REBUILD;

   158

	vl->flags |= VL_RESORT;

   159

}

   160

   161

void SortVehicleList(vehiclelist_d *vl)

   162

{

   163

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

   164

   165

	_internal_sort_order = vl->flags & VL_DESC;

   166

	_internal_name_sorter_id = STR_SV_TRAIN_NAME;

   167

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

   168

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

   169

		_vehicle_sorter[vl->sort_type]);

   170

   171

	vl->resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   172

	vl->flags &= ~VL_RESORT;

   173

}

   174

   175

   176

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

   177

void InitializeVehiclesGuiList(void)

   178

{

   179

	_railtype_selected_in_replace_gui = RAILTYPE_RAIL;

   180

}

   181

   182

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

   183

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

   184

{

   185

	uint32 ormod;

   186

   187

	// draw profit-based colored icons

   188

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

   189

		ormod = PALETTE_TO_GREY;

   190

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

   191

		ormod = PALETTE_TO_RED;

   192

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

   193

		ormod = PALETTE_TO_YELLOW;

   194

	} else {

   195

		ormod = PALETTE_TO_GREEN;

   196

	}

   197

	DrawSprite(SPR_BLOT | ormod, x, y);

   198

}

   199

   200

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

   201

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

   202

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

   203

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

   204

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

   205

 */

   206

CargoID DrawVehicleRefitWindow(const Vehicle *v, int sel)

   207

{

   208

	uint32 cmask;

   209

	CargoID cid, cargo = CT_INVALID;

   210

	int y = 25;

   211

	const Vehicle* u;

   212

#define show_cargo(ctype) { \

   213

		byte colour = 16; \

   214

		if (sel == 0) { \

   215

			cargo = ctype; \

   216

			colour = 12; \

   217

} \

   218

		sel--; \

   219

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

   220

		y += 10; \

   221

}

   222

   223

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

   224

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

   225

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

   226

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

   227

		cmask = 0;

   228

		u = v;

   229

		do {

   230

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

   231

			u = u->next;

   232

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

   233

   234

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

   235

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

   236

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

   237

				show_cargo(_local_cargo_id_ctype[cid]);

   238

		}

   239

		return cargo;

   240

}

   241

   242

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

   243

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

   244

{

   245

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

   246

}

   247

   248

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

   249

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

   250

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

   251

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

   252

*    STR_SV_TRAIN_NAME for trains or STR_SV_AIRCRAFT_NAME for aircraft

   253

*/

   254

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

   255

{

   256

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

   257

}

   258

   259

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

   260

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

   261

   262

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

   263

{

   264

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

   265

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

   266

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

   267

   268

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

   269

}

   270

   271

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

   272

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

   273

{

   274

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

   275

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

   276

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

   277

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

   278

	char buf1[64] = "\0";

   279

	int r;

   280

   281

	if (va->string_id != _internal_name_sorter_id) {

   282

		SetDParam(0, va->string_id);

   283

		GetString(buf1, STR_JUST_STRING);

   284

	}

   285

   286

	if (cmp2->index != _last_vehicle_idx) {

   287

		_last_vehicle_idx = cmp2->index;

   288

		_bufcache[0] = '\0';

   289

		if (vb->string_id != _internal_name_sorter_id) {

   290

			SetDParam(0, vb->string_id);

   291

			GetString(_bufcache, STR_JUST_STRING);

   292

		}

   293

	}

   294

   295

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

   296

   297

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   298

   299

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

   300

}

   301

   302

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

   303

{

   304

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

   305

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

   306

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

   307

   308

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   309

   310

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

   311

}

   312

   313

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

   314

{

   315

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

   316

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

   317

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

   318

   319

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   320

   321

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

   322

}

   323

   324

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

   325

{

   326

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

   327

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

   328

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

   329

   330

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   331

   332

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

   333

}

   334

   335

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

   336

{

   337

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

   338

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

   339

	const Vehicle* v;

   340

	AcceptedCargo cargoa;

   341

	AcceptedCargo cargob;

   342

	int r = 0;

   343

	int i;

   344

   345

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

   346

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

   347

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

   348

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

   349

   350

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

   351

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

   352

		if (r != 0) break;

   353

	}

   354

   355

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   356

   357

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

   358

}

   359

   360

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

   361

{

   362

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

   363

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

   364

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

   365

   366

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   367

   368

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

   369

}

   370

   371

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

   372

{

   373

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

   374

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

   375

	int max_speed_a = 0xFFFF, max_speed_b = 0xFFFF;

   376

	int r;

   377

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

   378

   379

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

   380

		do {

   381

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

   382

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

   383

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

   384

   385

		do {

   386

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

   387

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

   388

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

   389

   390

		r = max_speed_a - max_speed_b;

   391

	} else {

   392

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

   393

	}

   394

   395

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   396

   397

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

   398

}

   399

   400

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

   401

// ENGINE_AVAILABLE is used in ReplaceVehicleWndProc

   402

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

   403

   404

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

   405

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

   406

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

   407

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

   408

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

   409

{

   410

	EngineID i;

   411

	byte colour;

   412

	const Player *p = GetPlayer(_local_player);

   413

   414

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

   415

		const Engine *e = GetEngine(i);

   416

		const RailVehicleInfo *rvi = RailVehInfo(i);

   417

		const EngineInfo *info = &_engine_info[i];

   418

   419

		if (p->engine_replacement[i] == INVALID_ENGINE && _player_num_engines[i] == 0 && show_outdated) continue;

   420

   421

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

   422

			continue;

   423

   424

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

   425

   426

   427

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

   428

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

   429

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

   430

				!HASBIT(e->player_avail, _local_player))

   431

				continue;

   432

		} /*else {

   433

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

   434

			if ( _autoreplace_array[i] != i )

   435

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

   436

		} */

   437

   438

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

   439

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

   440

				colour);

   441

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

   442

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

   443

				PALETTE_CRASH : SPRITE_PALETTE(PLAYER_SPRITE_COLOR(_local_player)));

   444

			if ( show_outdated ) {

   445

				SetDParam(0, _player_num_engines[i]);

   446

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

   447

			}

   448

			*y += 14;

   449

		}

   450

		--*sel;

   451

	}

   452

}

   453

   454

   455

static void SetupScrollStuffForReplaceWindow(Window *w)

   456

{

   457

	RailType railtype;

   458

	int selected_id[2] = {-1,-1};

   459

	int sel[2];

   460

	int count = 0;

   461

	int count2 = 0;

   462

	EngineID engine_id;

   463

	const Player *p = GetPlayer(_local_player);

   464

   465

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

   466

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

   467

   468

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

   469

		case VEH_Train: {

   470

			railtype = _railtype_selected_in_replace_gui;

   471

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

   472

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

   473

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

   474

				const Engine *e = GetEngine(engine_id);

   475

				const EngineInfo *info = &_engine_info[engine_id];

   476

   477

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

   478

					if (_player_num_engines[engine_id] > 0 || p->engine_replacement[engine_id] != INVALID_ENGINE) {

   479

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

   480

						count++;

   481

						sel[0]--;

   482

					}

   483

					if (HASBIT(e->player_avail, _local_player)) {

   484

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

   485

						count2++;

   486