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

VehicleSortListingTypeFunctions * const _vehicle_sorter[] = {

    27

	&VehicleUnsortedSorter,

    28

	&VehicleNumberSorter,

    29

	&VehicleNameSorter,

    30

	&VehicleAgeSorter,

    31

	&VehicleProfitThisYearSorter,

    32

	&VehicleProfitLastYearSorter,

    33

	&VehicleCargoSorter,

    34

	&VehicleReliabilitySorter,

    35

	&VehicleMaxSpeedSorter

    36

};

    37

    38

const StringID _vehicle_sort_listing[] = {

    39

	STR_SORT_BY_UNSORTED,

    40

	STR_SORT_BY_NUMBER,

    41

	STR_SORT_BY_DROPDOWN_NAME,

    42

	STR_SORT_BY_AGE,

    43

	STR_SORT_BY_PROFIT_THIS_YEAR,

    44

	STR_SORT_BY_PROFIT_LAST_YEAR,

    45

	STR_SORT_BY_TOTAL_CAPACITY_PER_CARGOTYPE,

    46

	STR_SORT_BY_RELIABILITY,

    47

	STR_SORT_BY_MAX_SPEED,

    48

	INVALID_STRING_ID

    49

};

    50

    51

const StringID _rail_types_list[] = {

    52

	STR_RAIL_VEHICLES,

    53

	STR_MONORAIL_VEHICLES,

    54

	STR_MAGLEV_VEHICLES,

    55

	INVALID_STRING_ID

    56

};

    57

    58

void RebuildVehicleLists(void)

    59

{

    60

	Window *w;

    61

    62

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

    63

		switch (w->window_class) {

    64

		case WC_TRAINS_LIST: case WC_ROADVEH_LIST:

    65

		case WC_SHIPS_LIST:  case WC_AIRCRAFT_LIST:

    66

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

    67

			SetWindowDirty(w);

    68

			break;

    69

		default: break;

    70

		}

    71

}

    72

    73

void ResortVehicleLists(void)

    74

{

    75

	Window *w;

    76

    77

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

    78

		switch (w->window_class) {

    79

		case WC_TRAINS_LIST: case WC_ROADVEH_LIST:

    80

		case WC_SHIPS_LIST:  case WC_AIRCRAFT_LIST:

    81

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

    82

			SetWindowDirty(w);

    83

			break;

    84

		default: break;

    85

		}

    86

}

    87

    88

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

    89

{

    90

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

    91

	int n = 0;

    92

	int i;

    93

    94

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

    95

    96

	/* Create array for sorting */

    97

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

    98

	if (_vehicle_sort == NULL)

    99

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

   100

   101

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

   102

		owner, station);

   103

   104

	if (station != -1) {

   105

		const Vehicle *v;

   106

		FOR_ALL_VEHICLES(v) {

   107

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

   108

				const Order *order;

   109

   110

				FOR_VEHICLE_ORDERS(v, order) {

   111

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

   112

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

   113

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

   114

						++n;

   115

						break;

   116

					}

   117

				}

   118

			}

   119

		}

   120

	} else {

   121

		const Vehicle *v;

   122

		FOR_ALL_VEHICLES(v) {

   123

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

   124

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

   125

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

   126

				++n;

   127

			}

   128

		}

   129

	}

   130

   131

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

   132

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

   133

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

   134

	vl->list_length = n;

   135

   136

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

   137

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

   138

   139

	vl->flags &= ~VL_REBUILD;

   140

	vl->flags |= VL_RESORT;

   141

}

   142

   143

void SortVehicleList(vehiclelist_d *vl)

   144

{

   145

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

   146

   147

	_internal_sort_order = vl->flags & VL_DESC;

   148

	_internal_name_sorter_id = STR_SV_TRAIN_NAME;

   149

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

   150

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

   151

		_vehicle_sorter[vl->sort_type]);

   152

   153

	vl->resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   154

	vl->flags &= ~VL_RESORT;

   155

}

   156

   157

   158

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

   159

void InitializeVehiclesGuiList(void)

   160

{

   161

}

   162

   163

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

   164

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

   165

{

   166

	uint32 ormod;

   167

   168

	// draw profit-based colored icons

   169

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

   170

		ormod = PALETTE_TO_GREY;

   171

	else if(v->profit_last_year < 0)

   172

		ormod = PALETTE_TO_RED;

   173

	else if(v->profit_last_year < 10000)

   174

		ormod = PALETTE_TO_YELLOW;

   175

	else

   176

		ormod = PALETTE_TO_GREEN;

   177

	DrawSprite(SPR_BLOT | ormod, x, y);

   178

}

   179

   180

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

   181

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

   182

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

   183

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

   184

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

   185

 */

   186

CargoID DrawVehicleRefitWindow(const Vehicle *v, int sel)

   187

{

   188

	uint32 cmask;

   189

	CargoID cid, cargo = CT_INVALID;

   190

	int y = 25;

   191

	const Vehicle* u;

   192

#define show_cargo(ctype) { \

   193

		byte colour = 16; \

   194

		if (sel == 0) { \

   195

			cargo = ctype; \

   196

			colour = 12; \

   197

} \

   198

		sel--; \

   199

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

   200

		y += 10; \

   201

}

   202

   203

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

   204

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

   205

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

   206

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

   207

		cmask = 0;

   208

		u = v;

   209

		do {

   210

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

   211

				cmask |= _engine_refit_masks[u->engine_type];

   212

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

   213

				// rail wagons cant be refitted by default

   214

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

   215

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

   216

			}

   217

			u = u->next;

   218

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

   219

   220

		cmask &= _landscape_global_cargo_mask[_opt_ptr->landscape];

   221

   222

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

   223

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

   224

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

   225

				show_cargo(_local_cargo_id_ctype[cid]);

   226

		}

   227

		return cargo;

   228

}

   229

   230

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

   231

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

   232

{

   233

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

   234

}

   235

   236

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

   237

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

   238

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

   239

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

   240

*    STR_SV_TRAIN_NAME for trains or STR_SV_AIRCRAFT_NAME for aircraft

   241

*/

   242

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

   243

{

   244

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

   245

}

   246

   247

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

   248

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

   249

   250

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

   251

{

   252

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

   253

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

   254

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

   255

   256

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

   257

}

   258

   259

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

   260

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

   261

{

   262

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

   263

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

   264

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

   265

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

   266

	char buf1[64] = "\0";

   267

	int r;

   268

   269

	if (va->string_id != _internal_name_sorter_id) {

   270

		SetDParam(0, va->string_id);

   271

		GetString(buf1, STR_JUST_STRING);

   272

	}

   273

   274

	if ( cmp2->index != _last_vehicle_idx) {

   275

		_last_vehicle_idx = cmp2->index;

   276

		_bufcache[0] = '\0';

   277

		if (vb->string_id != _internal_name_sorter_id) {

   278

			SetDParam(0, vb->string_id);

   279

			GetString(_bufcache, STR_JUST_STRING);

   280

		}

   281

	}

   282

   283

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

   284

   285

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   286

   287

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

   288

}

   289

   290

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

   291

{

   292

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

   293

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

   294

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

   295

   296

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   297

   298

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

   299

}

   300

   301

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

   302

{

   303

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

   304

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

   305

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

   306

   307

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   308

   309

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

   310

}

   311

   312

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

   313

{

   314

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

   315

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

   316

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

   317

   318

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   319

   320

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

   321

}

   322

   323

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

   324

{

   325

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

   326

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

   327

	const Vehicle *v;

   328

	int r = 0;

   329

	int i;

   330

	uint _cargo_counta[NUM_CARGO];

   331

	uint _cargo_countb[NUM_CARGO];

   332

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

   333

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

   334

   335

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

   336

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

   337

   338

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

   339

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

   340

   341

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

   342

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

   343

		if (r != 0)

   344

			break;

   345

	}

   346

   347

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   348

   349

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

   350

}

   351

   352

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

   353

{

   354

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

   355

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

   356

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

   357

   358

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   359

   360

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

   361

}

   362

   363

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

   364

{

   365

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

   366

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

   367

	int max_speed_a = 0xFFFF, max_speed_b = 0xFFFF;

   368

	int r;

   369

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

   370

   371

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

   372

		do {

   373

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

   374

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

   375

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

   376

   377

		do {

   378

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

   379

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

   380

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

   381

   382

		r = max_speed_a - max_speed_b;

   383

	} else {

   384

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

   385

	}

   386

   387

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   388

   389

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

   390

}

   391

   392

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

   393

// ENGINE_AVAILABLE is used in ReplaceVehicleWndProc

   394

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

   395

   396

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

   397

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

   398

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

   399

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

   400

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

   401

{

   402

	int i;

   403

	byte colour;

   404

   405

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

   406

		const Engine *e = GetEngine(i);

   407

		const RailVehicleInfo *rvi = RailVehInfo(i);

   408

		const EngineInfo *info = &_engine_info[i];

   409

   410

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

   411

   412

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

   413

			continue;

   414

   415

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

   416

   417

   418

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

   419

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

   420

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

   421

				!HASBIT(e->player_avail, _local_player))

   422

				continue;

   423

		} /*else {

   424

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

   425

			if ( _autoreplace_array[i] != i )

   426

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

   427

		} */

   428

   429

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

   430

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

   431

				colour);

   432

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

   433

				SPRITE_PALETTE(PLAYER_SPRITE_COLOR(_local_player)));

   434

			if ( show_outdated ) {

   435

				SetDParam(0, _player_num_engines[i]);

   436

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

   437

			}

   438

			*y += 14;

   439

		}

   440

		--*sel;

   441

	}

   442

}

   443

   444

   445

static void SetupScrollStuffForReplaceWindow(Window *w)

   446

{

   447

	byte railtype;

   448

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

   449

	int sel[2];

   450

	int count = 0;

   451

	int count2 = 0;

   452

	int engine_id;

   453

   454

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

   455

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

   456

   457

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

   458

		case VEH_Train: {

   459

			railtype = _railtype_selected_in_replace_gui;

   460

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

   461

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

   462

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

   463

				const Engine *e = GetEngine(engine_id);

   464

				const EngineInfo *info = &_engine_info[engine_id];

   465

   466

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

   467

					if ( _player_num_engines[engine_id] ) {

   468

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

   469

						count++;

   470

						sel[0]--;

   471

					}

   472

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

   473

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

   474

						count2++;

   475

						sel[1]--;

   476

					}

   477

				}

   478

			}

   479

			break;

   480

		}

   481

		case VEH_Road: {

   482

			int num = NUM_ROAD_ENGINES;

   483

			Engine *e = GetEngine(ROAD_ENGINES_INDEX);

   484

			byte cargo;

   485

			EngineInfo *info;

   486

			engine_id = ROAD_ENGINES_INDEX;

   487

   488

			do {