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

Sorting _sorting;

    32

    33

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

    34

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

    35

static bool   _internal_sort_order;     // descending/ascending

    36

    37

static uint16 _player_num_engines[TOTAL_NUM_ENGINES];

    38

static RailType _railtype_selected_in_replace_gui;

    39

    40

    41

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

    42

    43

static VehicleSortListingTypeFunction VehicleNumberSorter;

    44

static VehicleSortListingTypeFunction VehicleNameSorter;

    45

static VehicleSortListingTypeFunction VehicleAgeSorter;

    46

static VehicleSortListingTypeFunction VehicleProfitThisYearSorter;

    47

static VehicleSortListingTypeFunction VehicleProfitLastYearSorter;

    48

static VehicleSortListingTypeFunction VehicleCargoSorter;

    49

static VehicleSortListingTypeFunction VehicleReliabilitySorter;

    50

static VehicleSortListingTypeFunction VehicleMaxSpeedSorter;

    51

static VehicleSortListingTypeFunction VehicleModelSorter;

    52

static VehicleSortListingTypeFunction VehicleValueSorter;

    53

    54

static VehicleSortListingTypeFunction* const _vehicle_sorter[] = {

    55

	&VehicleNumberSorter,

    56

	&VehicleNameSorter,

    57

	&VehicleAgeSorter,

    58

	&VehicleProfitThisYearSorter,

    59

	&VehicleProfitLastYearSorter,

    60

	&VehicleCargoSorter,

    61

	&VehicleReliabilitySorter,

    62

	&VehicleMaxSpeedSorter,

    63

	&VehicleModelSorter,

    64

	&VehicleValueSorter,

    65

};

    66

    67

static const StringID _vehicle_sort_listing[] = {

    68

	STR_SORT_BY_NUMBER,

    69

	STR_SORT_BY_DROPDOWN_NAME,

    70

	STR_SORT_BY_AGE,

    71

	STR_SORT_BY_PROFIT_THIS_YEAR,

    72

	STR_SORT_BY_PROFIT_LAST_YEAR,

    73

	STR_SORT_BY_TOTAL_CAPACITY_PER_CARGOTYPE,

    74

	STR_SORT_BY_RELIABILITY,

    75

	STR_SORT_BY_MAX_SPEED,

    76

	STR_SORT_BY_MODEL,

    77

	STR_SORT_BY_VALUE,

    78

	INVALID_STRING_ID

    79

};

    80

    81

static const StringID _rail_types_list[] = {

    82

	STR_RAIL_VEHICLES,

    83

	STR_ELRAIL_VEHICLES,

    84

	STR_MONORAIL_VEHICLES,

    85

	STR_MAGLEV_VEHICLES,

    86

	INVALID_STRING_ID

    87

};

    88

    89

void RebuildVehicleLists(void)

    90

{

    91

	Window *w;

    92

    93

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

    94

		switch (w->window_class) {

    95

		case WC_TRAINS_LIST: case WC_ROADVEH_LIST:

    96

		case WC_SHIPS_LIST:  case WC_AIRCRAFT_LIST:

    97

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

    98

			SetWindowDirty(w);

    99

			break;

   100

		default: break;

   101

		}

   102

}

   103

   104

void ResortVehicleLists(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).flags |= VL_RESORT;

   113

			SetWindowDirty(w);

   114

			break;

   115

		default: break;

   116

		}

   117

}

   118

   119

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

   120

{

   121

	const Vehicle** sort_list;

   122

	uint n = 0;

   123

	uint i;

   124

   125

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

   126

   127

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

   128

	if (sort_list == NULL) {

   129

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

   130

	}

   131

   132

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

   133

		owner, station);

   134

   135

	n = GenerateVehicleSortList(sort_list, type, owner, station, order, window_type);

   136

   137

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

   138

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

   139

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

   140

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

   141

	}

   142

	vl->list_length = n;

   143

   144

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

   145

	free((void*)sort_list);

   146

   147

	vl->flags &= ~VL_REBUILD;

   148

	vl->flags |= VL_RESORT;

   149

}

   150

   151

static void SortVehicleList(vehiclelist_d *vl)

   152

{

   153

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

   154

   155

	_internal_sort_order = vl->flags & VL_DESC;

   156

	_internal_name_sorter_id = STR_SV_TRAIN_NAME;

   157

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

   158

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

   159

		_vehicle_sorter[vl->sort_type]);

   160

   161

	vl->resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   162

	vl->flags &= ~VL_RESORT;

   163

}

   164

   165

   166

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

   167

void InitializeVehiclesGuiList(void)

   168

{

   169

	_railtype_selected_in_replace_gui = RAILTYPE_RAIL;

   170

}

   171

   172

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

   173

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

   174

{

   175

	uint32 ormod;

   176

   177

	// draw profit-based colored icons

   178

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

   179

		ormod = PALETTE_TO_GREY;

   180

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

   181

		ormod = PALETTE_TO_RED;

   182

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

   183

		ormod = PALETTE_TO_YELLOW;

   184

	} else {

   185

		ormod = PALETTE_TO_GREEN;

   186

	}

   187

	DrawSprite(SPR_BLOT | ormod, x, y);

   188

}

   189

   190

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

   191

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

   192

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

   193

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

   194

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

   195

 */

   196

CargoID DrawVehicleRefitWindow(const Vehicle *v, int sel)

   197

{

   198

	uint32 cmask = 0;

   199

	CargoID cid, cargo = CT_INVALID;

   200

	int y = 25;

   201

	const Vehicle* u = v;

   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

	do {

   208

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

   209

		u = u->next;

   210

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

   211

   212

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

   213

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

   214

		if (HASBIT(cmask, 0)) {

   215

			// vehicle is refittable to this cargo

   216

			byte colour = 16;

   217

			if (sel == 0) {

   218

				cargo = _local_cargo_id_ctype[cid];

   219

				colour = 12;

   220

			}

   221

   222

			sel--;

   223

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

   224

			y += 10;

   225

		}

   226

	}

   227

   228

	return cargo;

   229

}

   230

   231

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

   232

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

   233

{

   234

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

   235

	if (callback == CALLBACK_FAILED) return 0;

   236

   237

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

   238

	return 10;

   239

}

   240

   241

   242

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

   243

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

   244

   245

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

   246

{

   247

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

   248

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

   249

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

   250

   251

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

   252

}

   253

   254

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

   255

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

   256

{

   257

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

   258

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

   259

	char buf1[64] = "\0";

   260

	int r;

   261

   262

	if (va->string_id != _internal_name_sorter_id) {

   263

		SetDParam(0, va->string_id);

   264

		GetString(buf1, STR_JUST_STRING);

   265

	}

   266

   267

	if (vb != _last_vehicle) {

   268

		_last_vehicle = vb;

   269

		_bufcache[0] = '\0';

   270

		if (vb->string_id != _internal_name_sorter_id) {

   271

			SetDParam(0, vb->string_id);

   272

			GetString(_bufcache, STR_JUST_STRING);

   273

		}

   274

	}

   275

   276

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

   277

   278

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   279

   280

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

   281

}

   282

   283

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

   284

{

   285

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

   286

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

   287

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

   288

   289

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   290

   291

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

   292

}

   293

   294

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

   295

{

   296

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

   297

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

   298

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

   299

   300

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   301

   302

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

   303

}

   304

   305

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

   306

{

   307

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

   308

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

   309

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

   310

   311

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   312

   313

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

   314

}

   315

   316

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

   317

{

   318

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

   319

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

   320

	const Vehicle* v;

   321

	AcceptedCargo cargoa;

   322

	AcceptedCargo cargob;

   323

	int r = 0;

   324

	int i;

   325

   326

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

   327

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

   328

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

   329

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

   330

   331

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

   332

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

   333

		if (r != 0) break;

   334

	}

   335

   336

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   337

   338

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

   339

}

   340

   341

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

   342

{

   343

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

   344

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

   345

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

   346

   347

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   348

   349

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

   350

}

   351

   352

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

   353

{

   354

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

   355

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

   356

	int max_speed_a = 0xFFFF, max_speed_b = 0xFFFF;

   357

	int r;

   358

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

   359

   360

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

   361

		do {

   362

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

   363

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

   364

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

   365

   366

		do {

   367

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

   368

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

   369

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

   370

   371

		r = max_speed_a - max_speed_b;

   372

	} else {

   373

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

   374

	}

   375

   376

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   377

   378

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

   379

}

   380

   381

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

   382

{

   383

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

   384

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

   385

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

   386

   387

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   388

   389

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

   390

}

   391

   392

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

   393

{

   394

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

   395

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

   396

	const Vehicle *u;

   397

	int valuea = 0, valueb = 0;

   398

	int r;

   399

   400

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

   401

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

   402

   403

	r = valuea - valueb;

   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->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

 */

   418

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

   419

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

   420

{

   421

	EngineID j;

   422

	byte colour;

   423

	const Player *p = GetPlayer(_local_player);

   424

   425

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

   426

		EngineID i = GetRailVehAtPosition(j);

   427

		const Engine *e = GetEngine(i);

   428

		const RailVehicleInfo *rvi = RailVehInfo(i);

   429

		const EngineInfo *info = EngInfo(i);

   430

   431

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

   432

   433

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

   434

			continue;

   435

   436

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

   437

   438

   439

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

   440

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

   441

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

   442

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

   443

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

   444

				!HASBIT(e->player_avail, _local_player))

   445

				continue;

   446

#if 0

   447

		} else {

   448

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

   449

			if ( _autoreplace_array[i] != i )

   450

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

   451

#endif

   452

		}

   453

   454

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

   455

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

   456

				colour);

   457

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

   458

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

   459

				PALETTE_CRASH : GetEnginePalette(i, _local_player));

   460

			if ( show_outdated ) {

   461

				SetDParam(0, _player_num_engines[i]);

   462

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

   463

			}

   464

			*y += 14;

   465

		}

   466

		--*sel;

   467

	}

   468

}

   469

   470

   471

static void SetupScrollStuffForReplaceWindow(Window *w)

   472

{

   473

	EngineID selected_id[2] = { INVALID_ENGINE, INVALID_ENGINE };

   474

	const Player* p = GetPlayer(_local_player);

   475

	uint sel[2];

   476

	uint count = 0;

   477

	uint count2 = 0;

   478

	EngineID i;

   479

   480

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

   481

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

   482

   483

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