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

static 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

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

   246

{

   247

	switch (e->event) {

   248

		case WE_PAINT: {

   249

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

   250

   251

			SetDParam(0, v->string_id);

   252

			SetDParam(1, v->unitnumber);

   253

			DrawWindowWidgets(w);

   254

   255

   256

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

   257

   258

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

   259

				int32 cost = 0;

   260

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

   261

					case VEH_Train:    cost = CMD_REFIT_RAIL_VEHICLE; break;

   262

					case VEH_Road:     cost = CMD_REFIT_ROAD_VEH;     break;

   263

					case VEH_Ship:     cost = CMD_REFIT_SHIP;         break;

   264

					case VEH_Aircraft: cost = CMD_REFIT_AIRCRAFT;     break;

   265

				}

   266

   267

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

   268

				if (!CmdFailed(cost)) {

   269

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

   270

					SetDParam(1, _returned_refit_capacity);

   271

					SetDParam(2, cost);

   272

					DrawString(1, 137, STR_9840_NEW_CAPACITY_COST_OF_REFIT, 0);

   273

				}

   274

			}

   275

		}	break;

   276

   277

		case WE_CLICK:

   278

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

   279

				case 2: { // listbox

   280

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

   281

					if (y >= 0) {

   282

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

   283

						SetWindowDirty(w);

   284

					}

   285

				} break;

   286

				case 4: // refit button

   287

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

   288

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

   289

						int command = 0;

   290

   291

						switch (v->type) {

   292

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

   293

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

   294

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

   295

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

   296

						}

   297

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

   298

					}

   299

					break;

   300

			}

   301

			break;

   302

	}

   303

}

   304

   305

   306

static const Widget _vehicle_refit_widgets[] = {

   307

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

   308

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

   309

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

   310

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

   311

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

   312

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

   313

	{   WIDGETS_END},

   314

};

   315

   316

static const WindowDesc _vehicle_refit_desc = {

   317

	-1,-1, 240, 170,

   318

	WC_VEHICLE_REFIT,WC_VEHICLE_VIEW,

   319

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS,

   320

	_vehicle_refit_widgets,

   321

	VehicleRefitWndProc,

   322

};

   323

   324

/** Show the refit window for a vehicle

   325

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

   326

*/

   327

void ShowVehicleRefitWindow(const Vehicle *v)

   328

{

   329

	Window *w;

   330

   331

	DeleteWindowById(WC_VEHICLE_REFIT, v->index);

   332

   333

	_alloc_wnd_parent_num = v->index;

   334

	w = AllocateWindowDesc(&_vehicle_refit_desc);

   335

	w->window_number = v->index;

   336

	w->caption_color = v->owner;

   337

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

   338

   339

	switch (v->type) {

   340

		case VEH_Train:

   341

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

   342

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

   343

			break;

   344

		case VEH_Road:

   345

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

   346

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

   347

			break;

   348

		case VEH_Ship:

   349

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

   350

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

   351

			break;

   352

		case VEH_Aircraft:

   353

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

   354

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

   355

			break;

   356

		default: NOT_REACHED();

   357

	}

   358

}

   359

   360

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

   361

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

   362

{

   363

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

   364

	if (callback == CALLBACK_FAILED) return 0;

   365

   366

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

   367

	return 10;

   368

}

   369

   370

   371

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

   372

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

   373

   374

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

   375

{

   376

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

   377

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

   378

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

   379

   380

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

   381

}

   382

   383

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

   384

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

   385

{

   386

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

   387

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

   388

	char buf1[64] = "\0";

   389

	int r;

   390

   391

	if (va->string_id != _internal_name_sorter_id) {

   392

		SetDParam(0, va->string_id);

   393

		GetString(buf1, STR_JUST_STRING);

   394

	}

   395

   396

	if (vb != _last_vehicle) {

   397

		_last_vehicle = vb;

   398

		_bufcache[0] = '\0';

   399

		if (vb->string_id != _internal_name_sorter_id) {

   400

			SetDParam(0, vb->string_id);

   401

			GetString(_bufcache, STR_JUST_STRING);

   402

		}

   403

	}

   404

   405

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

   406

   407

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   408

   409

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

   410

}

   411

   412

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

   413

{

   414

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

   415

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

   416

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

   417

   418

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   419

   420

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

   421

}

   422

   423

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

   424

{

   425

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

   426

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

   427

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

   428

   429

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   430

   431

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

   432

}

   433

   434

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

   435

{

   436

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

   437

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

   438

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

   439

   440

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   441

   442

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

   443

}

   444

   445

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

   446

{

   447

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

   448

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

   449

	const Vehicle* v;

   450

	AcceptedCargo cargoa;

   451

	AcceptedCargo cargob;

   452

	int r = 0;

   453

	int i;

   454

   455

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

   456

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

   457

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

   458

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

   459

   460

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

   461

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

   462

		if (r != 0) break;

   463

	}

   464

   465

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   466

   467

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

   468

}

   469

   470

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

   471

{

   472

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

   473

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

   474

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

   475

   476

	VEHICLEUNITNUMBERSORTER(r, va, vb);

   477

   478

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

   479

}

   480

   481

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

   482

{

   483

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

   484

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

   485

	int max_speed_a = 0xFFFF, max_speed_b = 0xFFFF;

   486