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

#include "resize_window_widgets.h"

    31

    32

typedef struct Sorting {

    33

	Listing aircraft;

    34

	Listing roadveh;

    35

	Listing ship;

    36

	Listing train;

    37

} Sorting;

    38

    39

static Sorting _sorting;

    40

    41

typedef struct vehiclelist_d {

    42

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

    43

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

    44

	uint16 length_of_sort_list; // Keeps track of how many vehicle pointers sort list got space for

    45

	byte vehicle_type;          // The vehicle type that is sorted

    46

	list_d l;                   // General list struct

    47

} vehiclelist_d;

    48

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(vehiclelist_d));

    49

    50

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

    51

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

    52

static bool   _internal_sort_order;     // descending/ascending

    53

    54

static RailType _railtype_selected_in_replace_gui;

    55

    56

    57

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

    58

    59

static VehicleSortListingTypeFunction VehicleNumberSorter;

    60

static VehicleSortListingTypeFunction VehicleNameSorter;

    61

static VehicleSortListingTypeFunction VehicleAgeSorter;

    62

static VehicleSortListingTypeFunction VehicleProfitThisYearSorter;

    63

static VehicleSortListingTypeFunction VehicleProfitLastYearSorter;

    64

static VehicleSortListingTypeFunction VehicleCargoSorter;

    65

static VehicleSortListingTypeFunction VehicleReliabilitySorter;

    66

static VehicleSortListingTypeFunction VehicleMaxSpeedSorter;

    67

static VehicleSortListingTypeFunction VehicleModelSorter;

    68

static VehicleSortListingTypeFunction VehicleValueSorter;

    69

    70

static VehicleSortListingTypeFunction* const _vehicle_sorter[] = {

    71

	&VehicleNumberSorter,

    72

	&VehicleNameSorter,

    73

	&VehicleAgeSorter,

    74

	&VehicleProfitThisYearSorter,

    75

	&VehicleProfitLastYearSorter,

    76

	&VehicleCargoSorter,

    77

	&VehicleReliabilitySorter,

    78

	&VehicleMaxSpeedSorter,

    79

	&VehicleModelSorter,

    80

	&VehicleValueSorter,

    81

};

    82

    83

static const StringID _vehicle_sort_listing[] = {

    84

	STR_SORT_BY_NUMBER,

    85

	STR_SORT_BY_DROPDOWN_NAME,

    86

	STR_SORT_BY_AGE,

    87

	STR_SORT_BY_PROFIT_THIS_YEAR,

    88

	STR_SORT_BY_PROFIT_LAST_YEAR,

    89

	STR_SORT_BY_TOTAL_CAPACITY_PER_CARGOTYPE,

    90

	STR_SORT_BY_RELIABILITY,

    91

	STR_SORT_BY_MAX_SPEED,

    92

	STR_SORT_BY_MODEL,

    93

	STR_SORT_BY_VALUE,

    94

	INVALID_STRING_ID

    95

};

    96

    97

static const StringID _rail_types_list[] = {

    98

	STR_RAIL_VEHICLES,

    99

	STR_ELRAIL_VEHICLES,

   100

	STR_MONORAIL_VEHICLES,

   101

	STR_MAGLEV_VEHICLES,

   102

	INVALID_STRING_ID

   103

};

   104

   105

void RebuildVehicleLists(void)

   106

{

   107

	Window *w;

   108

   109

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

   110

		switch (w->window_class) {

   111

		case WC_TRAINS_LIST: case WC_ROADVEH_LIST:

   112

		case WC_SHIPS_LIST:  case WC_AIRCRAFT_LIST:

   113

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

   114

			SetWindowDirty(w);

   115

			break;

   116

		default: break;

   117

		}

   118

}

   119

   120

void ResortVehicleLists(void)

   121

{

   122

	Window *w;

   123

   124

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

   125

		switch (w->window_class) {

   126

		case WC_TRAINS_LIST: case WC_ROADVEH_LIST:

   127

		case WC_SHIPS_LIST:  case WC_AIRCRAFT_LIST:

   128

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

   129

			SetWindowDirty(w);

   130

			break;

   131

		default: break;

   132

		}

   133

}

   134

   135

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

   136

{

   137

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

   138

   139

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

   140

   141

	vl->l.list_length = GenerateVehicleSortList(&vl->sort_list, &vl->length_of_sort_list, vl->vehicle_type, owner, station, order, depot_airport_index, window_type);

   142

   143

	vl->l.flags &= ~VL_REBUILD;

   144

	vl->l.flags |= VL_RESORT;

   145

}

   146

   147

static void SortVehicleList(vehiclelist_d *vl)

   148

{

   149

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

   150

   151

	_internal_sort_order = vl->l.flags & VL_DESC;

   152

	_internal_name_sorter_id = STR_SV_TRAIN_NAME;

   153

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

   154

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

   155

		_vehicle_sorter[vl->l.sort_type]);

   156

   157

	vl->l.resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   158

	vl->l.flags &= ~VL_RESORT;

   159

}

   160

   161

   162

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

   163

void InitializeVehiclesGuiList(void)

   164

{

   165

	_railtype_selected_in_replace_gui = RAILTYPE_RAIL;

   166

}

   167

   168

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

   169

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

   170

{

   171

	uint32 ormod;

   172

   173

	// draw profit-based colored icons

   174

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

   175

		ormod = PALETTE_TO_GREY;

   176

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

   177

		ormod = PALETTE_TO_RED;

   178

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

   179

		ormod = PALETTE_TO_YELLOW;

   180

	} else {

   181

		ormod = PALETTE_TO_GREEN;

   182

	}

   183

	DrawSprite(SPR_BLOT | ormod, x, y);

   184

}

   185

   186

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

   187

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

   188

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

   189

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

   190

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

   191

 */

   192

static CargoID DrawVehicleRefitWindow(const Vehicle *v, int sel)

   193

{

   194

	uint32 cmask = 0;

   195

	CargoID cid, cargo = CT_INVALID;

   196

	int y = 25;

   197

	const Vehicle* u = v;

   198

   199

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

   200

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

   201

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

   202

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

   203

	do {

   204

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

   205

		u = u->next;

   206

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

   207

   208

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

   209

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

   210

		if (HASBIT(cmask, 0)) {

   211

			// vehicle is refittable to this cargo

   212

			byte colour = 16;

   213

			if (sel == 0) {

   214

				cargo = _local_cargo_id_ctype[cid];

   215

				colour = 12;

   216

			}

   217

   218

			sel--;

   219

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

   220

			y += 10;

   221

		}

   222

	}

   223

   224

	return cargo;

   225

}

   226

   227

static void VehicleRefitWndProc(Window *w, WindowEvent *e)

   228

{

   229

	switch (e->event) {

   230

		case WE_PAINT: {

   231

			const Vehicle *v = GetVehicle(w->window_number);

   232

   233

			SetDParam(0, v->string_id);

   234

			SetDParam(1, v->unitnumber);

   235

			DrawWindowWidgets(w);

   236

   237

   238

			WP(w,refit_d).cargo = DrawVehicleRefitWindow(v, WP(w, refit_d).sel);

   239

   240

			if (WP(w,refit_d).cargo != CT_INVALID) {

   241

				int32 cost = 0;

   242

				switch (GetVehicle(w->window_number)->type) {

   243

					case VEH_Train:    cost = CMD_REFIT_RAIL_VEHICLE; break;

   244

					case VEH_Road:     cost = CMD_REFIT_ROAD_VEH;     break;

   245

					case VEH_Ship:     cost = CMD_REFIT_SHIP;         break;

   246

					case VEH_Aircraft: cost = CMD_REFIT_AIRCRAFT;     break;

   247

				}

   248

   249

				cost = DoCommand(v->tile, v->index, WP(w,refit_d).cargo, DC_QUERY_COST, cost);

   250

				if (!CmdFailed(cost)) {

   251

					SetDParam(0, _cargoc.names_long[WP(w,refit_d).cargo]);

   252

					SetDParam(1, _returned_refit_capacity);

   253

					SetDParam(2, cost);

   254

					DrawString(1, 137, STR_9840_NEW_CAPACITY_COST_OF_REFIT, 0);

   255

				}

   256

			}

   257

		}	break;

   258

   259

		case WE_CLICK:

   260

			switch (e->we.click.widget) {

   261

				case 2: { // listbox

   262

					int y = e->we.click.pt.y - 25;

   263

					if (y >= 0) {

   264

						WP(w,refit_d).sel = y / 10;

   265

						SetWindowDirty(w);

   266

					}

   267

				} break;

   268

				case 4: // refit button

   269

					if (WP(w,refit_d).cargo != CT_INVALID) {

   270

						const Vehicle *v = GetVehicle(w->window_number);

   271

						int command = 0;

   272

   273

						switch (v->type) {

   274

							case VEH_Train:    command = CMD_REFIT_RAIL_VEHICLE | CMD_MSG(STR_RAIL_CAN_T_REFIT_VEHICLE);  break;

   275

							case VEH_Road:     command = CMD_REFIT_ROAD_VEH     | CMD_MSG(STR_REFIT_ROAD_VEHICLE_CAN_T);  break;

   276

							case VEH_Ship:     command = CMD_REFIT_SHIP         | CMD_MSG(STR_9841_CAN_T_REFIT_SHIP);     break;

   277

							case VEH_Aircraft: command = CMD_REFIT_AIRCRAFT     | CMD_MSG(STR_A042_CAN_T_REFIT_AIRCRAFT); break;

   278

						}

   279

						if (DoCommandP(v->tile, v->index, WP(w,refit_d).cargo, NULL, command)) DeleteWindow(w);

   280

					}

   281

					break;

   282

			}

   283

			break;

   284

	}

   285

}

   286

   287

   288

static const Widget _vehicle_refit_widgets[] = {

   289

	{   WWT_CLOSEBOX,   RESIZE_NONE,    14,     0,    10,     0,    13, STR_00C5,                            STR_018B_CLOSE_WINDOW},

   290

	{    WWT_CAPTION,   RESIZE_NONE,    14,    11,   239,     0,    13, STR_983B_REFIT,                      STR_018C_WINDOW_TITLE_DRAG_THIS},

   291

	{     WWT_IMGBTN,   RESIZE_NONE,    14,     0,   239,    14,   135, 0x0,                                 STR_983D_SELECT_TYPE_OF_CARGO_FOR},

   292

	{     WWT_IMGBTN,   RESIZE_NONE,    14,     0,   239,   136,   157, 0x0,                                 STR_NULL},

   293

	{ WWT_PUSHTXTBTN,   RESIZE_NONE,    14,     0,   239,   158,   169, 0x0,                                 STR_NULL},

   294

	{      WWT_LABEL,   RESIZE_NONE,     0,     0,   239,    13,    26, STR_983F_SELECT_CARGO_TYPE_TO_CARRY, STR_NULL},

   295

	{   WIDGETS_END},

   296

};

   297

   298

static const WindowDesc _vehicle_refit_desc = {

   299

	-1,-1, 240, 170,

   300

	WC_VEHICLE_REFIT,WC_VEHICLE_VIEW,

   301

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS,

   302

	_vehicle_refit_widgets,

   303

	VehicleRefitWndProc,

   304

};

   305

   306

/** Show the refit window for a vehicle

   307

* @param *v The vehicle to show the refit window for

   308

*/

   309

void ShowVehicleRefitWindow(const Vehicle *v)

   310

{

   311

	Window *w;

   312

   313

	DeleteWindowById(WC_VEHICLE_REFIT, v->index);

   314

   315

	_alloc_wnd_parent_num = v->index;

   316

	w = AllocateWindowDesc(&_vehicle_refit_desc);

   317

	w->window_number = v->index;

   318

	w->caption_color = v->owner;

   319

	WP(w,refit_d).sel = -1;

   320

   321

	switch (v->type) {

   322

		case VEH_Train:

   323

			w->widget[4].data     = STR_RAIL_REFIT_VEHICLE;

   324

			w->widget[4].tooltips = STR_RAIL_REFIT_TO_CARRY_HIGHLIGHTED;

   325

			break;

   326

		case VEH_Road:

   327

			w->widget[4].data     = STR_REFIT_ROAD_VEHICLE;

   328

			w->widget[4].tooltips = STR_REFIT_ROAD_VEHICLE_TO_CARRY_HIGHLIGHTED;

   329

			break;

   330

		case VEH_Ship:

   331

			w->widget[4].data     = STR_983C_REFIT_SHIP;

   332

			w->widget[4].tooltips = STR_983E_REFIT_SHIP_TO_CARRY_HIGHLIGHTED;

   333

			break;

   334

		case VEH_Aircraft:

   335

			w->widget[4].data     = STR_A03D_REFIT_AIRCRAFT;

   336

			w->widget[4].tooltips = STR_A03F_REFIT_AIRCRAFT_TO_CARRY;

   337

			break;

   338

		default: NOT_REACHED();

   339

	}

   340

}

   341

   342

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

   343

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

   344

{

   345

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

   346

	if (callback == CALLBACK_FAILED) return 0;

   347

   348

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

   349

	return 10;

   350

}

   351

   352

   353

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

   354

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

   355

   356

static int CDECL VehicleNumberSorter(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->unitnumber - vb->unitnumber;

   361

   362

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

   363

}

   364

   365

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

   366

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

   367

{

   368

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

   369

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

   370

	char buf1[64] = "\0";

   371

	int r;

   372

   373

	if (va->string_id != _internal_name_sorter_id) {

   374

		SetDParam(0, va->string_id);

   375

		GetString(buf1, STR_JUST_STRING);

   376

	}

   377

   378

	if (vb != _last_vehicle) {

   379

		_last_vehicle = vb;

   380

		_bufcache[0] = '\0';

   381

		if (vb->string_id != _internal_name_sorter_id) {

   382

			SetDParam(0, vb->string_id);

   383

			GetString(_bufcache, STR_JUST_STRING);

   384

		}

   385

	}

   386

   387

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

   388

   389

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   390

   391

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

   392

}

   393

   394

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

   395

{

   396

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

   397

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

   398

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

   399

   400

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   401

   402

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

   403

}

   404

   405

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

   406

{

   407

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

   408

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

   409

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

   410

   411

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   412

   413

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

   414

}

   415

   416

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

   417

{

   418

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

   419

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

   420

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

   421

   422

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   423

   424

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

   425

}

   426

   427

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

   428

{

   429

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

   430

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

   431

	const Vehicle* v;

   432

	AcceptedCargo cargoa;

   433

	AcceptedCargo cargob;

   434

	int r = 0;

   435

	int i;

   436

   437

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

   438

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

   439

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

   440

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

   441

   442

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

   443

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

   444

		if (r != 0) break;

   445

	}

   446

   447

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   448

   449

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

   450

}

   451

   452

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

   453

{

   454

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

   455

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

   456

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

   457

   458

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   459

   460

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

   461

}

   462

   463

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

   464

{

   465

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

   466

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

   467

	int max_speed_a = 0xFFFF, max_speed_b = 0xFFFF;

   468

	int r;

   469

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

   470

   471

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

   472

		do {

   473

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

   474

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

   475

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

   476

   477

		do {

   478

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

   479

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

   480

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

   481

   482

		r = max_speed_a - max_speed_b;

   483

	} else {

   484

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

   485

	}

   486