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 RailType _railtype_selected_in_replace_gui;

    53

    54

    55

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

    56

    57

static VehicleSortListingTypeFunction VehicleNumberSorter;

    58

static VehicleSortListingTypeFunction VehicleNameSorter;

    59

static VehicleSortListingTypeFunction VehicleAgeSorter;

    60

static VehicleSortListingTypeFunction VehicleProfitThisYearSorter;

    61

static VehicleSortListingTypeFunction VehicleProfitLastYearSorter;

    62

static VehicleSortListingTypeFunction VehicleCargoSorter;

    63

static VehicleSortListingTypeFunction VehicleReliabilitySorter;

    64

static VehicleSortListingTypeFunction VehicleMaxSpeedSorter;

    65

static VehicleSortListingTypeFunction VehicleModelSorter;

    66

static VehicleSortListingTypeFunction VehicleValueSorter;

    67

    68

static VehicleSortListingTypeFunction* const _vehicle_sorter[] = {

    69

	&VehicleNumberSorter,

    70

	&VehicleNameSorter,

    71

	&VehicleAgeSorter,

    72

	&VehicleProfitThisYearSorter,

    73

	&VehicleProfitLastYearSorter,

    74

	&VehicleCargoSorter,

    75

	&VehicleReliabilitySorter,

    76

	&VehicleMaxSpeedSorter,

    77

	&VehicleModelSorter,

    78

	&VehicleValueSorter,

    79

};

    80

    81

static const StringID _vehicle_sort_listing[] = {

    82

	STR_SORT_BY_NUMBER,

    83

	STR_SORT_BY_DROPDOWN_NAME,

    84

	STR_SORT_BY_AGE,

    85

	STR_SORT_BY_PROFIT_THIS_YEAR,

    86

	STR_SORT_BY_PROFIT_LAST_YEAR,

    87

	STR_SORT_BY_TOTAL_CAPACITY_PER_CARGOTYPE,

    88

	STR_SORT_BY_RELIABILITY,

    89

	STR_SORT_BY_MAX_SPEED,

    90

	STR_SORT_BY_MODEL,

    91

	STR_SORT_BY_VALUE,

    92

	INVALID_STRING_ID

    93

};

    94

    95

static const StringID _rail_types_list[] = {

    96

	STR_RAIL_VEHICLES,

    97

	STR_ELRAIL_VEHICLES,

    98

	STR_MONORAIL_VEHICLES,

    99

	STR_MAGLEV_VEHICLES,

   100

	INVALID_STRING_ID

   101

};

   102

   103

void RebuildVehicleLists(void)

   104

{

   105

	Window *w;

   106

   107

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

   108

		switch (w->window_class) {

   109

		case WC_TRAINS_LIST: case WC_ROADVEH_LIST:

   110

		case WC_SHIPS_LIST:  case WC_AIRCRAFT_LIST:

   111

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

   112

			SetWindowDirty(w);

   113

			break;

   114

		default: break;

   115

		}

   116

}

   117

   118

void ResortVehicleLists(void)

   119

{

   120

	Window *w;

   121

   122

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

   123

		switch (w->window_class) {

   124

		case WC_TRAINS_LIST: case WC_ROADVEH_LIST:

   125

		case WC_SHIPS_LIST:  case WC_AIRCRAFT_LIST:

   126

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

   127

			SetWindowDirty(w);

   128

			break;

   129

		default: break;

   130

		}

   131

}

   132

   133

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

   134

{

   135

	const Vehicle** sort_list;

   136

	uint n = 0;

   137

	uint i;

   138

   139

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

   140

   141

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

   142

	if (sort_list == NULL) {

   143

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

   144

	}

   145

   146

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

   147

		owner, station);

   148

   149

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

   150

   151

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

   152

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

   153

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

   154

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

   155

	}

   156

	vl->l.list_length = n;

   157

   158

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

   159

	free((void*)sort_list);

   160

   161

	vl->l.flags &= ~VL_REBUILD;

   162

	vl->l.flags |= VL_RESORT;

   163

}

   164

   165

static void SortVehicleList(vehiclelist_d *vl)

   166

{

   167

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

   168

   169

	_internal_sort_order = vl->l.flags & VL_DESC;

   170

	_internal_name_sorter_id = STR_SV_TRAIN_NAME;

   171

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

   172

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

   173

		_vehicle_sorter[vl->l.sort_type]);

   174

   175

	vl->l.resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   176

	vl->l.flags &= ~VL_RESORT;

   177

}

   178

   179

   180

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

   181

void InitializeVehiclesGuiList(void)

   182

{

   183

	_railtype_selected_in_replace_gui = RAILTYPE_RAIL;

   184

}

   185

   186

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

   187

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

   188

{

   189

	uint32 ormod;

   190

   191

	// draw profit-based colored icons

   192

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

   193

		ormod = PALETTE_TO_GREY;

   194

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

   195

		ormod = PALETTE_TO_RED;

   196

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

   197

		ormod = PALETTE_TO_YELLOW;

   198

	} else {

   199

		ormod = PALETTE_TO_GREEN;

   200

	}

   201

	DrawSprite(SPR_BLOT | ormod, x, y);

   202

}

   203

   204

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

   205

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

   206

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

   207

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

   208

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

   209

 */

   210

CargoID DrawVehicleRefitWindow(const Vehicle *v, int sel)

   211

{

   212

	uint32 cmask = 0;

   213

	CargoID cid, cargo = CT_INVALID;

   214

	int y = 25;

   215

	const Vehicle* u = v;

   216

   217

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

   218

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

   219

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

   220

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

   221

	do {

   222

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

   223

		u = u->next;

   224

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

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

   229

			// vehicle is refittable to this cargo

   230

			byte colour = 16;

   231

			if (sel == 0) {

   232

				cargo = _local_cargo_id_ctype[cid];

   233

				colour = 12;

   234

			}

   235

   236

			sel--;

   237

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

   238

			y += 10;

   239

		}

   240

	}

   241

   242

	return cargo;

   243

}

   244

   245

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

   246

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

   247

{

   248

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

   249

	if (callback == CALLBACK_FAILED) return 0;

   250

   251

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

   252

	return 10;

   253

}

   254

   255

   256

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

   257

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

   258

   259

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

   260

{

   261

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

   262

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

   263

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

   264

   265

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

   266

}

   267

   268

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

   269

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

   270

{

   271

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

   272

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

   273

	char buf1[64] = "\0";

   274

	int r;

   275

   276

	if (va->string_id != _internal_name_sorter_id) {

   277

		SetDParam(0, va->string_id);

   278

		GetString(buf1, STR_JUST_STRING);

   279

	}

   280

   281

	if (vb != _last_vehicle) {

   282

		_last_vehicle = vb;

   283

		_bufcache[0] = '\0';

   284

		if (vb->string_id != _internal_name_sorter_id) {

   285

			SetDParam(0, vb->string_id);

   286

			GetString(_bufcache, STR_JUST_STRING);

   287

		}

   288

	}

   289

   290

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

   291

   292

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   293

   294

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

   295

}

   296

   297

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

   298

{

   299

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

   300

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

   301

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

   302

   303

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   304

   305

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

   306

}

   307

   308

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

   309

{

   310

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

   311

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

   312

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

   313

   314

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   315

   316

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

   317

}

   318

   319

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

   320

{

   321

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

   322

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

   323

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

   324

   325

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   326

   327

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

   328

}

   329

   330

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

   331

{

   332

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

   333

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

   334

	const Vehicle* v;

   335

	AcceptedCargo cargoa;

   336

	AcceptedCargo cargob;

   337

	int r = 0;

   338

	int i;

   339

   340

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

   341

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

   342

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

   343

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

   344

   345

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

   346

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

   347

		if (r != 0) break;

   348

	}

   349

   350

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   351

   352

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

   353

}

   354

   355

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

   356

{

   357

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

   358

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

   359

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

   360

   361

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   362

   363

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

   364

}

   365

   366

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

   367

{

   368

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

   369

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

   370

	int max_speed_a = 0xFFFF, max_speed_b = 0xFFFF;

   371

	int r;

   372

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

   373

   374

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

   375

		do {

   376

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

   377

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

   378

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

   379

   380

		do {

   381

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

   382

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

   383

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

   384

   385

		r = max_speed_a - max_speed_b;

   386

	} else {

   387

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

   388

	}

   389

   390

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   391

   392

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

   393

}

   394

   395

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

   396

{

   397

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

   398

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

   399

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

   400

   401

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   402

   403

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

   404

}

   405

   406

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

   407

{

   408

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

   409

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

   410

	const Vehicle *u;

   411

	int valuea = 0, valueb = 0;

   412

	int r;

   413

   414

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

   415

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

   416

   417

	r = valuea - valueb;

   418

   419

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   420

   421

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

   422

}

   423

   424

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

   425

// ENGINE_AVAILABLE is used in ReplaceVehicleWndProc

   426

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

   427

   428

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

   429

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

   430

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

   431

 */

   432

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

   433

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

   434

{

   435

	EngineID j;

   436

	byte colour;

   437

	const Player *p = GetPlayer(_local_player);

   438

   439

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

   440

		EngineID i = GetRailVehAtPosition(j);

   441

		const Engine *e = GetEngine(i);

   442

		const RailVehicleInfo *rvi = RailVehInfo(i);

   443

		const EngineInfo *info = EngInfo(i);

   444

   445

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

   446

   447

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

   448

			continue;

   449

   450

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

   451

   452

   453

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

   454

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

   455

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

   456

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

   457

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

   458

				!HASBIT(e->player_avail, _local_player))

   459

				continue;

   460

#if 0

   461

		} else {

   462

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

   463

			if ( _autoreplace_array[i] != i )

   464

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

   465

#endif

   466

		}

   467

   468

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

   469

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

   470

				colour);

   471

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

   472

			DrawTrainEngine(*x + 29, *y + 6, i, (p->num_engines[i] == 0 && show_outdated) ?

   473

				PALETTE_CRASH : GetEnginePalette(i, _local_player));

   474

			if ( show_outdated ) {

   475

				SetDParam(0, p->num_engines[i]);

   476

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

   477

			}

   478

			*y += 14;

   479

		}

   480

		--*sel;

   481

	}

   482

}

   483