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 "strings.h"

     9

#include "table/sprites.h"

    10

#include "table/strings.h"

    11

#include "vehicle.h"

    12

#include "window.h"

    13

#include "engine.h"

    14

#include "gui.h"

    15

#include "command.h"

    16

#include "gfx.h"

    17

#include "variables.h"

    18

#include "vehicle_gui.h"

    19

    20

Sorting _sorting;

    21

    22

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

    23

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

    24

static bool   _internal_sort_order;     // descending/ascending

    25

    26

static uint16 _player_num_engines[256];

    27

static byte _railtype_selected_in_replace_gui;

    28

    29

VehicleSortListingTypeFunctions * const _vehicle_sorter[] = {

    30

	&VehicleUnsortedSorter,

    31

	&VehicleNumberSorter,

    32

	&VehicleNameSorter,

    33

	&VehicleAgeSorter,

    34

	&VehicleProfitThisYearSorter,

    35

	&VehicleProfitLastYearSorter,

    36

	&VehicleCargoSorter,

    37

	&VehicleReliabilitySorter,

    38

	&VehicleMaxSpeedSorter

    39

};

    40

    41

const StringID _vehicle_sort_listing[] = {

    42

	STR_SORT_BY_UNSORTED,

    43

	STR_SORT_BY_NUMBER,

    44

	STR_SORT_BY_DROPDOWN_NAME,

    45

	STR_SORT_BY_AGE,

    46

	STR_SORT_BY_PROFIT_THIS_YEAR,

    47

	STR_SORT_BY_PROFIT_LAST_YEAR,

    48

	STR_SORT_BY_TOTAL_CAPACITY_PER_CARGOTYPE,

    49

	STR_SORT_BY_RELIABILITY,

    50

	STR_SORT_BY_MAX_SPEED,

    51

	INVALID_STRING_ID

    52

};

    53

    54

const StringID _rail_types_list[] = {

    55

	STR_RAIL_VEHICLES,

    56

	STR_MONORAIL_VEHICLES,

    57

	STR_MAGLEV_VEHICLES,

    58

	INVALID_STRING_ID

    59

};

    60

    61

void RebuildVehicleLists(void)

    62

{

    63

	Window *w;

    64

    65

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

    66

		switch (w->window_class) {

    67

		case WC_TRAINS_LIST: case WC_ROADVEH_LIST:

    68

		case WC_SHIPS_LIST:  case WC_AIRCRAFT_LIST:

    69

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

    70

			SetWindowDirty(w);

    71

			break;

    72

		default: break;

    73

		}

    74

}

    75

    76

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

    85

			SetWindowDirty(w);

    86

			break;

    87

		default: break;

    88

		}

    89

}

    90

    91

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

    92

{

    93

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

    94

	int n = 0;

    95

	int i;

    96

    97

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

    98

    99

	/* Create array for sorting */

   100

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

   101

	if (_vehicle_sort == NULL)

   102

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

   103

   104

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

   105

		owner, station);

   106

   107

	if (station != -1) {

   108

		const Vehicle *v;

   109

		FOR_ALL_VEHICLES(v) {

   110

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

   111

				const Order *order;

   112

   113

				FOR_VEHICLE_ORDERS(v, order) {

   114

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

   115

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

   116

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

   117

						++n;

   118

						break;

   119

					}

   120

				}

   121

			}

   122

		}

   123

	} else {

   124

		const Vehicle *v;

   125

		FOR_ALL_VEHICLES(v) {

   126

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

   127

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

   128

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

   129

				++n;

   130

			}

   131

		}

   132

	}

   133

   134

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

   135

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

   136

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

   137

	vl->list_length = n;

   138

   139

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

   140

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

   141

   142

	vl->flags &= ~VL_REBUILD;

   143

	vl->flags |= VL_RESORT;

   144

}

   145

   146

void SortVehicleList(vehiclelist_d *vl)

   147

{

   148

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

   149

   150

	_internal_sort_order = vl->flags & VL_DESC;

   151

	_internal_name_sorter_id = STR_SV_TRAIN_NAME;

   152

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

   153

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

   154

		_vehicle_sorter[vl->sort_type]);

   155

   156

	vl->resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   157

	vl->flags &= ~VL_RESORT;

   158

}

   159

   160

   161

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

   162

void InitializeVehiclesGuiList(void)

   163

{

   164

	_railtype_selected_in_replace_gui = 0;

   165

}

   166

   167

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

   168

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

   169

{

   170

	uint32 ormod;

   171

   172

	// draw profit-based colored icons

   173

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

   174

		ormod = PALETTE_TO_GREY;

   175

	else if(v->profit_last_year < 0)

   176

		ormod = PALETTE_TO_RED;

   177

	else if(v->profit_last_year < 10000)

   178

		ormod = PALETTE_TO_YELLOW;

   179

	else

   180

		ormod = PALETTE_TO_GREEN;

   181

	DrawSprite(SPR_BLOT | ormod, x, y);

   182

}

   183

   184

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

   185

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

   186

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

   187

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

   188

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

   189

 */

   190

CargoID DrawVehicleRefitWindow(const Vehicle *v, int sel)

   191

{

   192

	uint32 cmask;

   193

	CargoID cid, cargo = CT_INVALID;

   194

	int y = 25;

   195

	const Vehicle* u;

   196

#define show_cargo(ctype) { \

   197

		byte colour = 16; \

   198

		if (sel == 0) { \

   199

			cargo = ctype; \

   200

			colour = 12; \

   201

} \

   202

		sel--; \

   203

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

   204

		y += 10; \

   205

}

   206

   207

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

   208

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

   209

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

   210

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

   211

		cmask = 0;

   212

		u = v;

   213

		do {

   214

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

   215

				cmask |= _engine_refit_masks[u->engine_type];

   216

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

   217

				// rail wagons cant be refitted by default

   218

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

   219

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

   220

			}

   221

			u = u->next;

   222

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

   223

   224

		cmask &= _landscape_global_cargo_mask[_opt_ptr->landscape];

   225

   226

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

   227

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

   228

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

   229

				show_cargo(_local_cargo_id_ctype[cid]);

   230

		}

   231

		return cargo;

   232

}

   233

   234

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

   235

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

   236

{

   237

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

   238

}

   239

   240

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

   241

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

   242

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

   243

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

   244

*    STR_SV_TRAIN_NAME for trains or STR_SV_AIRCRAFT_NAME for aircraft

   245

*/

   246

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

   247

{

   248

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

   249

}

   250

   251

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

   252

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

   253

   254

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

   255

{

   256

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

   257

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

   258

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

   259

   260

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

   261

}

   262

   263

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

   264

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

   265

{

   266

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

   267

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

   268

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

   269

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

   270

	char buf1[64] = "\0";

   271

	int r;

   272

   273

	if (va->string_id != _internal_name_sorter_id) {

   274

		SetDParam(0, va->string_id);

   275

		GetString(buf1, STR_JUST_STRING);

   276

	}

   277

   278

	if ( cmp2->index != _last_vehicle_idx) {

   279

		_last_vehicle_idx = cmp2->index;

   280

		_bufcache[0] = '\0';

   281

		if (vb->string_id != _internal_name_sorter_id) {

   282

			SetDParam(0, vb->string_id);

   283

			GetString(_bufcache, STR_JUST_STRING);

   284

		}

   285

	}

   286

   287

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

   288

   289

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   290

   291

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

   292

}

   293

   294

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

   295

{

   296

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

   297

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

   298

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

   299

   300

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   301

   302

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

   303

}

   304

   305

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

   306

{

   307

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

   308

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

   309

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

   310

   311

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   312

   313

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

   314

}

   315

   316

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

   317

{

   318

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

   319

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

   320

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

   321

   322

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   323

   324

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

   325

}

   326

   327

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

   328

{

   329

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

   330

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

   331

	const Vehicle *v;

   332

	int r = 0;

   333

	int i;

   334

	uint _cargo_counta[NUM_CARGO];

   335

	uint _cargo_countb[NUM_CARGO];

   336

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

   337

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

   338

   339

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

   340

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

   341

   342

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

   343

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

   344

   345

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

   346

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

   347

		if (r != 0)

   348

			break;

   349

	}

   350

   351

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   352

   353

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

   354

}

   355

   356

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

   357

{

   358

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

   359

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

   360

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

   361

   362

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   363

   364

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

   365

}

   366

   367

int CDECL VehicleMaxSpeedSorter(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 max_speed_a = 0xFFFF, max_speed_b = 0xFFFF;

   372

	int r;

   373

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

   374

   375

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

   376

		do {

   377

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

   378

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

   379

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

   380

   381

		do {

   382

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

   383

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

   384

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

   385

   386

		r = max_speed_a - max_speed_b;

   387

	} else {

   388

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

   389

	}

   390

   391

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   392

   393

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

   394

}

   395

   396

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

   397

// ENGINE_AVAILABLE is used in ReplaceVehicleWndProc

   398

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

   399

   400

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

   401

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

   402

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

   403

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

   404

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

   405

{

   406

	int i;

   407

	byte colour;

   408

   409

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

   410

		const Engine *e = GetEngine(i);

   411

		const RailVehicleInfo *rvi = RailVehInfo(i);

   412

		const EngineInfo *info = &_engine_info[i];

   413

   414

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

   415

   416

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

   417

			continue;

   418

   419

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

   420

   421

   422

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

   423

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

   424

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

   425

				!HASBIT(e->player_avail, _local_player))

   426

				continue;

   427

		} /*else {

   428

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

   429

			if ( _autoreplace_array[i] != i )

   430

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

   431

		} */

   432

   433

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

   434

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

   435

				colour);

   436

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

   437

				SPRITE_PALETTE(PLAYER_SPRITE_COLOR(_local_player)));

   438

			if ( show_outdated ) {

   439

				SetDParam(0, _player_num_engines[i]);

   440

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

   441

			}

   442

			*y += 14;

   443

		}

   444

		--*sel;

   445

	}

   446

}

   447

   448

   449

static void SetupScrollStuffForReplaceWindow(Window *w)

   450

{

   451

	byte railtype;

   452

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

   453

	int sel[2];

   454

	int count = 0;

   455

	int count2 = 0;

   456

	int engine_id;

   457

   458

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

   459

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

   460

   461

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

   462

		case VEH_Train: {

   463

			railtype = _railtype_selected_in_replace_gui;

   464

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

   465

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

   466

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

   467

				const Engine *e = GetEngine(engine_id);

   468

				const EngineInfo *info = &_engine_info[engine_id];

   469

   470

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

   471

					if ( _player_num_engines[engine_id] ) {

   472

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

   473

						count++;

   474

						sel[0]--;

   475

					}

   476

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

   477

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

   478

						count2++;

   479

						sel[1]--;

   480

					}

   481

				}

   482

			}

   483

			break;

   484

		}

   485

		case VEH_Road: {

   486

			int num = NUM_ROAD_ENGINES;

   487

			Engine *e = GetEngine(ROAD_ENGINES_INDEX);

   488

			byte cargo;