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

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

   109

	int n = 0;

   110

	int 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

	DrawSprite(SPR_BLOT | ormod, x, y);

   197

}

   198

   199

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

   200

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

   201

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

   202

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

   203

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

   204

 */

   205

CargoID DrawVehicleRefitWindow(const Vehicle *v, int sel)

   206

{

   207

	uint32 cmask;

   208

	CargoID cid, cargo = CT_INVALID;

   209

	int y = 25;

   210

	const Vehicle* u;

   211

#define show_cargo(ctype) { \

   212

		byte colour = 16; \

   213

		if (sel == 0) { \

   214

			cargo = ctype; \

   215

			colour = 12; \

   216

} \

   217

		sel--; \

   218

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

   219

		y += 10; \

   220

}

   221

   222

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

   223

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

   224

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

   225

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

   226

		cmask = 0;

   227

		u = v;

   228

		do {

   229

			if (_engine_refit_masks[u->engine_type] != 0) { // newgrf custom refit mask

   230

				cmask |= _engine_refit_masks[u->engine_type];

   231

			} else if (u->cargo_cap != 0) {

   232

				// rail wagons cant be refitted by default

   233

				if (v->type != VEH_Train || !(RailVehInfo(u->engine_type)->flags & RVI_WAGON))

   234

					cmask |= _default_refitmasks[v->type - VEH_Train];

   235

			}

   236

			u = u->next;

   237

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

   238

   239

		cmask &= _landscape_global_cargo_mask[_opt_ptr->landscape];

   240

   241

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

   242

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

   243

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

   244

				show_cargo(_local_cargo_id_ctype[cid]);

   245

		}

   246

		return cargo;

   247

}

   248

   249

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

   250

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

   251

{

   252

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

   253

}

   254

   255

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

   256

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

   257

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

   258

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

   259

*    STR_SV_TRAIN_NAME for trains or STR_SV_AIRCRAFT_NAME for aircraft

   260

*/

   261

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

   262

{

   263

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

   264

}

   265

   266

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

   267

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

   268

   269

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

   270

{

   271

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

   272

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

   273

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

   274

   275

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

   276

}

   277

   278

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

   279

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

   280

{

   281

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

   282

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

   283

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

   284

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

   285

	char buf1[64] = "\0";

   286

	int r;

   287

   288

	if (va->string_id != _internal_name_sorter_id) {

   289

		SetDParam(0, va->string_id);

   290

		GetString(buf1, STR_JUST_STRING);

   291

	}

   292

   293

	if ( cmp2->index != _last_vehicle_idx) {

   294

		_last_vehicle_idx = cmp2->index;

   295

		_bufcache[0] = '\0';

   296

		if (vb->string_id != _internal_name_sorter_id) {

   297

			SetDParam(0, vb->string_id);

   298

			GetString(_bufcache, STR_JUST_STRING);

   299

		}

   300

	}

   301

   302

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

   303

   304

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   305

   306

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

   307

}

   308

   309

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

   310

{

   311

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

   312

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

   313

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

   314

   315

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   316

   317

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

   318

}

   319

   320

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

   321

{

   322

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

   323

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

   324

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

   325

   326

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   327

   328

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

   329

}

   330

   331

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

   332

{

   333

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

   334

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

   335

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

   336

   337

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   338

   339

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

   340

}

   341

   342

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

   343

{

   344

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

   345

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

   346

	const Vehicle* v;

   347

	AcceptedCargo cargoa;

   348

	AcceptedCargo cargob;

   349

	int r = 0;

   350

	int i;

   351

   352

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

   353

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

   354

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

   355

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

   356

   357

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

   358

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

   359

		if (r != 0) break;

   360

	}

   361

   362

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   363

   364

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

   365

}

   366

   367

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

   368

{

   369

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

   370

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

   371

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

   372

   373

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   374

   375

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

   376

}

   377

   378

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

   379

{

   380

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

   381

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

   382

	int max_speed_a = 0xFFFF, max_speed_b = 0xFFFF;

   383

	int r;

   384

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

   385

   386

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

   387

		do {

   388

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

   389

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

   390

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

   391

   392

		do {

   393

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

   394

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

   395

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

   396

   397

		r = max_speed_a - max_speed_b;

   398

	} else {

   399

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

   400

	}

   401

   402

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   403

   404

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

   405

}

   406

   407

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

   408

// ENGINE_AVAILABLE is used in ReplaceVehicleWndProc

   409

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

   410

   411

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

   412

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

   413

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

   414

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

   415

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

   416

{

   417

	EngineID i;

   418

	byte colour;

   419

	const Player *p = GetPlayer(_local_player);

   420

   421

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

   422

		const Engine *e = GetEngine(i);

   423

		const RailVehicleInfo *rvi = RailVehInfo(i);

   424

		const EngineInfo *info = &_engine_info[i];

   425

   426

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

   427

   428

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

   429

			continue;

   430

   431

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

   432

   433

   434

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

   435

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

   436

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

   437

				!HASBIT(e->player_avail, _local_player))

   438

				continue;

   439

		} /*else {

   440

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

   441

			if ( _autoreplace_array[i] != i )

   442

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

   443

		} */

   444

   445

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

   446

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

   447

				colour);

   448

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

   449

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

   450

				PALETTE_CRASH : SPRITE_PALETTE(PLAYER_SPRITE_COLOR(_local_player)));

   451

			if ( show_outdated ) {

   452

				SetDParam(0, _player_num_engines[i]);

   453

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

   454

			}

   455

			*y += 14;

   456

		}

   457

		--*sel;

   458

	}

   459

}

   460

   461

   462

static void SetupScrollStuffForReplaceWindow(Window *w)

   463

{

   464

	RailType railtype;

   465

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

   466

	int sel[2];

   467

	int count = 0;

   468

	int count2 = 0;

   469

	EngineID engine_id;

   470

	const Player *p = GetPlayer(_local_player);

   471

   472

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

   473

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

   474

   475

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

   476

		case VEH_Train: {

   477

			railtype = _railtype_selected_in_replace_gui;

   478

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

   479

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

   480

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

   481

				const Engine *e = GetEngine(engine_id);

   482

				const EngineInfo *info = &_engine_info[engine_id];

   483

   484

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

   485

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

   486

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