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

    21

Sorting _sorting;

    22

    23

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

    24

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

    25

static bool   _internal_sort_order;     // descending/ascending

    26

    27

static uint16 _player_num_engines[256];

    28

static byte _railtype_selected_in_replace_gui;

    29

    30

    31

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

    32

    33

static VehicleSortListingTypeFunction VehicleUnsortedSorter;

    34

static VehicleSortListingTypeFunction VehicleNumberSorter;

    35

static VehicleSortListingTypeFunction VehicleNameSorter;

    36

static VehicleSortListingTypeFunction VehicleAgeSorter;

    37

static VehicleSortListingTypeFunction VehicleProfitThisYearSorter;

    38

static VehicleSortListingTypeFunction VehicleProfitLastYearSorter;

    39

static VehicleSortListingTypeFunction VehicleCargoSorter;

    40

static VehicleSortListingTypeFunction VehicleReliabilitySorter;

    41

static VehicleSortListingTypeFunction VehicleMaxSpeedSorter;

    42

    43

static VehicleSortListingTypeFunction* const _vehicle_sorter[] = {

    44

	&VehicleUnsortedSorter,

    45

	&VehicleNumberSorter,

    46

	&VehicleNameSorter,

    47

	&VehicleAgeSorter,

    48

	&VehicleProfitThisYearSorter,

    49

	&VehicleProfitLastYearSorter,

    50

	&VehicleCargoSorter,

    51

	&VehicleReliabilitySorter,

    52

	&VehicleMaxSpeedSorter

    53

};

    54

    55

const StringID _vehicle_sort_listing[] = {

    56

	STR_SORT_BY_UNSORTED,

    57

	STR_SORT_BY_NUMBER,

    58

	STR_SORT_BY_DROPDOWN_NAME,

    59

	STR_SORT_BY_AGE,

    60

	STR_SORT_BY_PROFIT_THIS_YEAR,

    61

	STR_SORT_BY_PROFIT_LAST_YEAR,

    62

	STR_SORT_BY_TOTAL_CAPACITY_PER_CARGOTYPE,

    63

	STR_SORT_BY_RELIABILITY,

    64

	STR_SORT_BY_MAX_SPEED,

    65

	INVALID_STRING_ID

    66

};

    67

    68

static const StringID _rail_types_list[] = {

    69

	STR_RAIL_VEHICLES,

    70

	STR_MONORAIL_VEHICLES,

    71

	STR_MAGLEV_VEHICLES,

    72

	INVALID_STRING_ID

    73

};

    74

    75

void RebuildVehicleLists(void)

    76

{

    77

	Window *w;

    78

    79

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

    80

		switch (w->window_class) {

    81

		case WC_TRAINS_LIST: case WC_ROADVEH_LIST:

    82

		case WC_SHIPS_LIST:  case WC_AIRCRAFT_LIST:

    83

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

    84

			SetWindowDirty(w);

    85

			break;

    86

		default: break;

    87

		}

    88

}

    89

    90

void ResortVehicleLists(void)

    91

{

    92

	Window *w;

    93

    94

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

    95

		switch (w->window_class) {

    96

		case WC_TRAINS_LIST: case WC_ROADVEH_LIST:

    97

		case WC_SHIPS_LIST:  case WC_AIRCRAFT_LIST:

    98

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

    99

			SetWindowDirty(w);

   100

			break;

   101

		default: break;

   102

		}

   103

}

   104

   105

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

   106

{

   107

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

   108

	int n = 0;

   109

	int i;

   110

   111

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

   112

   113

	/* Create array for sorting */

   114

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

   115

	if (_vehicle_sort == NULL)

   116

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

   117

   118

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

   119

		owner, station);

   120

   121

	if (station != INVALID_STATION) {

   122

		const Vehicle *v;

   123

		FOR_ALL_VEHICLES(v) {

   124

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

   125

				const Order *order;

   126

   127

				FOR_VEHICLE_ORDERS(v, order) {

   128

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

   129

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

   130

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

   131

						++n;

   132

						break;

   133

					}

   134

				}

   135

			}

   136

		}

   137

	} else {

   138

		const Vehicle *v;

   139

		FOR_ALL_VEHICLES(v) {

   140

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

   141

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

   142

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

   143

				++n;

   144

			}

   145

		}

   146

	}

   147

   148

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

   149

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

   150

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

   151

	vl->list_length = n;

   152

   153

	for (i = 0; i < n; ++i)

   154

		vl->sort_list[i] = _vehicle_sort[i];

   155

   156

	vl->flags &= ~VL_REBUILD;

   157

	vl->flags |= VL_RESORT;

   158

}

   159

   160

void SortVehicleList(vehiclelist_d *vl)

   161

{

   162

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

   163

   164

	_internal_sort_order = vl->flags & VL_DESC;

   165

	_internal_name_sorter_id = STR_SV_TRAIN_NAME;

   166

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

   167

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

   168

		_vehicle_sorter[vl->sort_type]);

   169

   170

	vl->resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   171

	vl->flags &= ~VL_RESORT;

   172

}

   173

   174

   175

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

   176

void InitializeVehiclesGuiList(void)

   177

{

   179

}

   180

   181

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

   182

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

   183

{

   184

	uint32 ormod;

   185

   186

	// draw profit-based colored icons

   187

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

   188

		ormod = PALETTE_TO_GREY;

   189

	else if(v->profit_last_year < 0)

   190

		ormod = PALETTE_TO_RED;

   191

	else if(v->profit_last_year < 10000)

   192

		ormod = PALETTE_TO_YELLOW;

   193

	else

   194

		ormod = PALETTE_TO_GREEN;

   195

	DrawSprite(SPR_BLOT | ormod, x, y);

   196

}

   197

   198

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

   199

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

   200

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

   201

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

   202

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

   203

 */

   204

CargoID DrawVehicleRefitWindow(const Vehicle *v, int sel)

   205

{

   206

	uint32 cmask;

   207

	CargoID cid, cargo = CT_INVALID;

   208

	int y = 25;

   209

	const Vehicle* u;

   210

#define show_cargo(ctype) { \

   211

		byte colour = 16; \

   212

		if (sel == 0) { \

   213

			cargo = ctype; \

   214

			colour = 12; \

   215

} \

   216

		sel--; \

   217

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

   218

		y += 10; \

   219

}

   220

   221

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

   222

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

   223

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

   224

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

   225

		cmask = 0;

   226

		u = v;

   227

		do {

   228

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

   229

				cmask |= _engine_refit_masks[u->engine_type];

   230

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

   231

				// rail wagons cant be refitted by default

   232

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

   233

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

   234

			}

   235

			u = u->next;

   236

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

   237

   238

		cmask &= _landscape_global_cargo_mask[_opt_ptr->landscape];

   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

	int r = 0;

   347

	int i;

   348

	uint _cargo_counta[NUM_CARGO];

   349

	uint _cargo_countb[NUM_CARGO];

   350

	memset(_cargo_counta, 0, sizeof(_cargo_counta));

   351

	memset(_cargo_countb, 0, sizeof(_cargo_countb));

   352

   353

	for (v = va; v != NULL; v = v->next)

   354

		_cargo_counta[v->cargo_type] += v->cargo_cap;

   355

   356

	for (v = vb; v != NULL; v = v->next)

   357

		_cargo_countb[v->cargo_type] += v->cargo_cap;

   358

   359

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

   360

		r = _cargo_counta[i] - _cargo_countb[i];

   361

		if (r != 0)

   362

			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->railtype_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, int *selected_id, byte railtype,

   418

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

   419

{

   420

	EngineID i;

   421

	byte colour;

   422

   423

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

   424

		const Engine *e = GetEngine(i);

   425

		const RailVehicleInfo *rvi = RailVehInfo(i);

   426

		const EngineInfo *info = &_engine_info[i];

   427

   428

		if ( _player_num_engines[i] == 0 && show_outdated ) continue;

   429

   430

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

   431

			continue;

   432

   433

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

   434

   435

   436

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

   437

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

   438

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

   439

				!HASBIT(e->player_avail, _local_player))

   440

				continue;

   441

		} /*else {

   442

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

   443

			if ( _autoreplace_array[i] != i )

   444

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

   445

		} */

   446

   447

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

   448

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

   449

				colour);

   450

			DrawTrainEngine(*x + 29, *y + 6, i,

   451

				SPRITE_PALETTE(PLAYER_SPRITE_COLOR(_local_player)));

   452

			if ( show_outdated ) {

   453

				SetDParam(0, _player_num_engines[i]);

   454

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

   455

			}

   456

			*y += 14;

   457

		}

   458

		--*sel;

   459

	}

   460

}

   461

   462

   463

static void SetupScrollStuffForReplaceWindow(Window *w)

   464

{

   465

	byte railtype;

   466

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

   467

	int sel[2];

   468

	int count = 0;

   469

	int count2 = 0;

   470

	EngineID engine_id;

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

   486

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

   487

						count++;