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

#include "train.h"

    22

#include "newgrf_callbacks.h"

    23

#include "newgrf_engine.h"

    24

#include "newgrf_text.h"

    25

#include "date.h"

    26

#include "ship.h"

    27

#include "aircraft.h"

    28

#include "roadveh.h"

    29

#include "depot.h"

    30

    31

typedef struct Sorting {

    32

	Listing aircraft;

    33

	Listing roadveh;

    34

	Listing ship;

    35

	Listing train;

    36

} Sorting;

    37

    38

static Sorting _sorting;

    39

    40

typedef struct vehiclelist_d {

    41

	const Vehicle** sort_list; // list of vehicles (sorted)

    42

	Listing *_sorting;         // pointer to the appropiate subcategory of _sorting

    43

	byte vehicle_type;         // the vehicle type that is sorted

    44

	list_d l;                  // general list struct

    45

} vehiclelist_d;

    46

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(vehiclelist_d));

    47

    48

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

    49

static const Vehicle* _last_vehicle; // cached vehicle to hopefully speed up name-sorting

    50

static bool   _internal_sort_order;     // descending/ascending

    51

    52

static uint16 _player_num_engines[TOTAL_NUM_ENGINES];

    53

static RailType _railtype_selected_in_replace_gui;

    54

    55

    56

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

    57

    58

static VehicleSortListingTypeFunction VehicleNumberSorter;

    59

static VehicleSortListingTypeFunction VehicleNameSorter;

    60

static VehicleSortListingTypeFunction VehicleAgeSorter;

    61

static VehicleSortListingTypeFunction VehicleProfitThisYearSorter;

    62

static VehicleSortListingTypeFunction VehicleProfitLastYearSorter;

    63

static VehicleSortListingTypeFunction VehicleCargoSorter;

    64

static VehicleSortListingTypeFunction VehicleReliabilitySorter;

    65

static VehicleSortListingTypeFunction VehicleMaxSpeedSorter;

    66

static VehicleSortListingTypeFunction VehicleModelSorter;

    67

static VehicleSortListingTypeFunction VehicleValueSorter;

    68

    69

static VehicleSortListingTypeFunction* const _vehicle_sorter[] = {

    70

	&VehicleNumberSorter,

    71

	&VehicleNameSorter,

    72

	&VehicleAgeSorter,

    73

	&VehicleProfitThisYearSorter,

    74

	&VehicleProfitLastYearSorter,

    75

	&VehicleCargoSorter,

    76

	&VehicleReliabilitySorter,

    77

	&VehicleMaxSpeedSorter,

    78

	&VehicleModelSorter,

    79

	&VehicleValueSorter,

    80

};

    81

    82

static const StringID _vehicle_sort_listing[] = {

    83

	STR_SORT_BY_NUMBER,

    84

	STR_SORT_BY_DROPDOWN_NAME,

    85

	STR_SORT_BY_AGE,

    86

	STR_SORT_BY_PROFIT_THIS_YEAR,

    87

	STR_SORT_BY_PROFIT_LAST_YEAR,

    88

	STR_SORT_BY_TOTAL_CAPACITY_PER_CARGOTYPE,

    89

	STR_SORT_BY_RELIABILITY,

    90

	STR_SORT_BY_MAX_SPEED,

    91

	STR_SORT_BY_MODEL,

    92

	STR_SORT_BY_VALUE,

    93

	INVALID_STRING_ID

    94

};

    95

    96

static const StringID _rail_types_list[] = {

    97

	STR_RAIL_VEHICLES,

    98

	STR_ELRAIL_VEHICLES,

    99

	STR_MONORAIL_VEHICLES,

   100

	STR_MAGLEV_VEHICLES,

   101

	INVALID_STRING_ID

   102

};

   103

   104

void RebuildVehicleLists(void)

   105

{

   106

	Window *w;

   107

   108

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

   109

		switch (w->window_class) {

   110

		case WC_TRAINS_LIST: case WC_ROADVEH_LIST:

   111

		case WC_SHIPS_LIST:  case WC_AIRCRAFT_LIST:

   112

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

   113

			SetWindowDirty(w);

   114

			break;

   115

		default: break;

   116

		}

   117

}

   118

   119

void ResortVehicleLists(void)

   120

{

   121

	Window *w;

   122

   123

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

   124

		switch (w->window_class) {

   125

		case WC_TRAINS_LIST: case WC_ROADVEH_LIST:

   126

		case WC_SHIPS_LIST:  case WC_AIRCRAFT_LIST:

   127

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

   128

			SetWindowDirty(w);

   129

			break;

   130

		default: break;

   131

		}

   132

}

   133

   134

static void BuildVehicleList(vehiclelist_d* vl, PlayerID owner, StationID station, OrderID order, uint16 window_type)

   135

{

   136

	const Vehicle** sort_list;

   137

	uint n = 0;

   138

	uint i;

   139

   140

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

   141

   142

	sort_list = malloc(GetVehicleArraySize() * sizeof(sort_list[0]));

   143

	if (sort_list == NULL) {

   144

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

   145

	}

   146

   147

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

   148

		owner, station);

   149

   150

	n = GenerateVehicleSortList(sort_list, vl->vehicle_type, owner, station, order, window_type);

   151

   152

	free((void*)vl->sort_list);

   153

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

   154

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

   155

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

   156

	}

   157

	vl->l.list_length = n;

   158

   159

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

   160

	free((void*)sort_list);

   161

   162

	vl->l.flags &= ~VL_REBUILD;

   163

	vl->l.flags |= VL_RESORT;

   164

}

   165

   166

static void SortVehicleList(vehiclelist_d *vl)

   167

{

   168

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

   169

   170

	_internal_sort_order = vl->l.flags & VL_DESC;

   171

	_internal_name_sorter_id = STR_SV_TRAIN_NAME;

   172

	_last_vehicle = NULL; // used for "cache" in namesorting

   173

	qsort((void*)vl->sort_list, vl->l.list_length, sizeof(vl->sort_list[0]),

   174

		_vehicle_sorter[vl->l.sort_type]);

   175

   176

	vl->l.resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   177

	vl->l.flags &= ~VL_RESORT;

   178

}

   179

   180

   181

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

   182

void InitializeVehiclesGuiList(void)

   183

{

   184

	_railtype_selected_in_replace_gui = RAILTYPE_RAIL;

   185

}

   186

   187

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

   188

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

   189

{

   190

	uint32 ormod;

   191

   192

	// draw profit-based colored icons

   193

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

   194

		ormod = PALETTE_TO_GREY;

   195

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

   196

		ormod = PALETTE_TO_RED;

   197

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

   198

		ormod = PALETTE_TO_YELLOW;

   199

	} else {

   200

		ormod = PALETTE_TO_GREEN;

   201

	}

   202

	DrawSprite(SPR_BLOT | ormod, x, y);

   203

}

   204

   205

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

   206

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

   207

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

   208

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

   209

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

   210

 */

   211

CargoID DrawVehicleRefitWindow(const Vehicle *v, int sel)

   212

{

   213

	uint32 cmask = 0;

   214

	CargoID cid, cargo = CT_INVALID;

   215

	int y = 25;

   216

	const Vehicle* u = v;

   217

   218

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

   219

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

   220

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

   221

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

   222

	do {

   223

		cmask |= EngInfo(u->engine_type)->refit_mask;

   224

		u = u->next;

   225

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

   226

   227

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

   228

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

   229

		if (HASBIT(cmask, 0)) {

   230

			// vehicle is refittable to this cargo

   231

			byte colour = 16;

   232

			if (sel == 0) {

   233

				cargo = _local_cargo_id_ctype[cid];

   234

				colour = 12;

   235

			}

   236

   237

			sel--;

   238

			DrawString(6, y, _cargoc.names_s[_local_cargo_id_ctype[cid]], colour);

   239

			y += 10;

   240

		}

   241

	}

   242

   243

	return cargo;

   244

}

   245

   246

/* Display additional text from NewGRF in the purchase information window */

   247

int ShowAdditionalText(int x, int y, int w, EngineID engine)

   248

{

   249

	uint16 callback = GetVehicleCallback(CBID_VEHICLE_ADDITIONAL_TEXT, 0, 0, engine, NULL);

   250

	if (callback == CALLBACK_FAILED) return 0;

   251

   252

	DrawStringTruncated(x, y, GetGRFStringID(GetEngineGRFID(engine), 0xD000 + callback), 16, w);

   253

	return 10;

   254

}

   255

   256

   257

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

   258

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

   259

   260

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

   261

{

   262

	const Vehicle* va = *(const Vehicle**)a;

   263

	const Vehicle* vb = *(const Vehicle**)b;

   264

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

   265

   266

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

   267

}

   268

   269

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

   270

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

   271

{

   272

	const Vehicle* va = *(const Vehicle**)a;

   273

	const Vehicle* vb = *(const Vehicle**)b;

   274

	char buf1[64] = "\0";

   275

	int r;

   276

   277

	if (va->string_id != _internal_name_sorter_id) {

   278

		SetDParam(0, va->string_id);

   279

		GetString(buf1, STR_JUST_STRING);

   280

	}

   281

   282

	if (vb != _last_vehicle) {

   283

		_last_vehicle = vb;

   284

		_bufcache[0] = '\0';

   285

		if (vb->string_id != _internal_name_sorter_id) {

   286

			SetDParam(0, vb->string_id);

   287

			GetString(_bufcache, STR_JUST_STRING);

   288

		}

   289

	}

   290

   291

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

   292

   293

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   294

   295

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

   296

}

   297

   298

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

   299

{

   300

	const Vehicle* va = *(const Vehicle**)a;

   301

	const Vehicle* vb = *(const Vehicle**)b;

   302

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

   303

   304

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   305

   306

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

   307

}

   308

   309

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

   310

{

   311

	const Vehicle* va = *(const Vehicle**)a;

   312

	const Vehicle* vb = *(const Vehicle**)b;

   313

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

   314

   315

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   316

   317

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

   318

}

   319

   320

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

   321

{

   322

	const Vehicle* va = *(const Vehicle**)a;

   323

	const Vehicle* vb = *(const Vehicle**)b;

   324

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

   325

   326

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   327

   328

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

   329

}

   330

   331

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

   332

{

   333

	const Vehicle* va = *(const Vehicle**)a;

   334

	const Vehicle* vb = *(const Vehicle**)b;

   335

	const Vehicle* v;

   336

	AcceptedCargo cargoa;

   337

	AcceptedCargo cargob;

   338

	int r = 0;

   339

	int i;

   340

   341

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

   342

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

   343

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

   344

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

   345

   346

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

   347

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

   348

		if (r != 0) break;

   349

	}

   350

   351

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   352

   353

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

   354

}

   355

   356

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

   357

{

   358

	const Vehicle* va = *(const Vehicle**)a;

   359

	const Vehicle* vb = *(const Vehicle**)b;

   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

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

   368

{

   369

	const Vehicle* va = *(const Vehicle**)a;

   370

	const Vehicle* vb = *(const Vehicle**)b;

   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

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

   397

{

   398

	const Vehicle* va = *(const Vehicle**)a;

   399

	const Vehicle* vb = *(const Vehicle**)b;

   400

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

   401

   402

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   403

   404

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

   405

}

   406

   407

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

   408

{

   409

	const Vehicle* va = *(const Vehicle**)a;

   410

	const Vehicle* vb = *(const Vehicle**)b;

   411

	const Vehicle *u;

   412

	int valuea = 0, valueb = 0;

   413

	int r;

   414

   415

	for (u = va; u != NULL; u = u->next) valuea += u->value;

   416

	for (u = vb; u != NULL; u = u->next) valueb += u->value;

   417

   418

	r = valuea - valueb;

   419

   420

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   421

   422

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

   423

}

   424

   425

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

   426

// ENGINE_AVAILABLE is used in ReplaceVehicleWndProc

   427

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

   428

   429

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

   430

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

   431

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

   432

 */

   433

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

   434

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

   435

{

   436

	EngineID j;

   437

	byte colour;

   438

	const Player *p = GetPlayer(_local_player);

   439

   440

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

   441

		EngineID i = GetRailVehAtPosition(j);

   442

		const Engine *e = GetEngine(i);

   443

		const RailVehicleInfo *rvi = RailVehInfo(i);

   444

		const EngineInfo *info = EngInfo(i);

   445

   446

		if (!EngineHasReplacementForPlayer(p, i) && _player_num_engines[i] == 0 && show_outdated) continue;

   447

   448

		if ((rvi->power == 0 && !show_cars) || (rvi->power != 0 && show_cars))  // show wagons or engines (works since wagons do not have power)

   449

			continue;

   450

   451

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

   452

   453

   454

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

   455

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

   456

			if ((!IsCompatibleRail(e->railtype, railtype) && show_compatible)

   457

				|| (e->railtype != railtype && !show_compatible)

   458

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

   459

				!HASBIT(e->player_avail, _local_player))

   460

				continue;

   461

#if 0

   462

		} else {

   463

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

   464

			if ( _autoreplace_array[i] != i )

   465

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

   466

#endif

   467

		}

   468

   469

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

   470

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

   471

				colour);

   472

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

   473

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

   474

				PALETTE_CRASH : GetEnginePalette(i, _local_player));

   475

			if ( show_outdated ) {

   476

				SetDParam(0, _player_num_engines[i]);

   477

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

   478

			}

   479

			*y += 14;

   480

		}

   481

		--*sel;

   482

	}

   483

}