1

/* $Id$ */

     2

     3

/** @file vehicle_gui.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "debug.h"

     8

#include "functions.h"

     9

#include "player.h"

    10

#include "station.h"

    11

#include "strings.h"

    12

#include "table/sprites.h"

    13

#include "table/strings.h"

    14

#include "vehicle.h"

    15

#include "window.h"

    16

#include "engine.h"

    17

#include "gui.h"

    18

#include "command.h"

    19

#include "gfx.h"

    20

#include "variables.h"

    21

#include "vehicle_gui.h"

    22

#include "viewport.h"

    23

#include "train.h"

    24

#include "newgrf_callbacks.h"

    25

#include "newgrf_engine.h"

    26

#include "newgrf_text.h"

    27

#include "date.h"

    28

#include "ship.h"

    29

#include "aircraft.h"

    30

#include "roadveh.h"

    31

#include "depot.h"

    32

#include "helpers.hpp"

    33

#include "cargotype.h"

    34

    35

struct Sorting {

    36

	Listing aircraft;

    37

	Listing roadveh;

    38

	Listing ship;

    39

	Listing train;

    40

};

    41

    42

static Sorting _sorting;

    43

    44

struct vehiclelist_d {

    45

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

    46

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

    47

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

    48

	byte vehicle_type;          // The vehicle type that is sorted

    49

	list_d l;                   // General list struct

    50

};

    51

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(vehiclelist_d));

    52

    53

static bool   _internal_sort_order;     // descending/ascending

    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

void RebuildVehicleLists()

    96

{

    97

	BaseWindow *w = NULL;

    98

    99

	FOR_ALL_WINDOWS(w) {

   100

		switch (w->window_class) {

   101

			case WC_TRAINS_LIST:

   102

			case WC_ROADVEH_LIST:

   103

			case WC_SHIPS_LIST:

   104

			case WC_AIRCRAFT_LIST:

   105

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

   106

				w->SetDirty();

   107

				break;

   108

   109

			default: break;

   110

		}

   111

	}

   112

}

   113

   114

void ResortVehicleLists()

   115

{

   116

	BaseWindow *w = NULL;

   117

   118

	FOR_ALL_WINDOWS(w) {

   119

   120

		switch (w->window_class) {

   121

			case WC_TRAINS_LIST:

   122

			case WC_ROADVEH_LIST:

   123

			case WC_SHIPS_LIST:

   124

			case WC_AIRCRAFT_LIST:

   125

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

   126

				w->SetDirty();

   127

				break;

   128

   129

			default: break;

   130

		}

   131

	}

   132

}

   133

   134

static void BuildVehicleList(vehiclelist_d* vl, PlayerID owner, uint16 index, uint16 window_type)

   135

{

   136

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

   137

   138

	DEBUG(misc, 3, "Building vehicle list for player %d at station %d", owner, index);

   139

   140

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

   141

   142

	vl->l.flags &= ~VL_REBUILD;

   143

	vl->l.flags |= VL_RESORT;

   144

}

   145

   146

static void SortVehicleList(vehiclelist_d *vl)

   147

{

   148

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

   149

   150

	_internal_sort_order = (vl->l.flags & VL_DESC) != 0;

   151

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

   152

		_vehicle_sorter[vl->l.sort_type]);

   153

   154

	vl->l.resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   155

	vl->l.flags &= ~VL_RESORT;

   156

}

   157

   158

void DepotSortList(Vehicle **v, uint16 length)

   159

{

   160

	_internal_sort_order = 0;

   161

	qsort((void*)v, length, sizeof(v[0]), _vehicle_sorter[0]);

   162

}

   163

   164

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

   165

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

   166

{

   167

	SpriteID pal;

   168

   169

	/* draw profit-based colored icons */

   170

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

   171

		pal = PALETTE_TO_GREY;

   172

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

   173

		pal = PALETTE_TO_RED;

   174

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

   175

		pal = PALETTE_TO_YELLOW;

   176

	} else {

   177

		pal = PALETTE_TO_GREEN;

   178

	}

   179

	DrawSprite(SPR_BLOT, pal, x, y);

   180

}

   181

   182

struct RefitOption {

   183

	CargoID cargo;

   184

	byte subtype;

   185

	uint16 value;

   186

	EngineID engine;

   187

};

   188

   189

struct RefitList {

   190

	uint num_lines;

   191

	RefitOption *items;

   192

};

   193

   194

static RefitList *BuildRefitList(const Vehicle *v)

   195

{

   196

	uint max_lines = 256;

   197

	RefitOption *refit = CallocT<RefitOption>(max_lines);

   198

	RefitList *list = CallocT<RefitList>(1);

   199

	Vehicle *u = (Vehicle*)v;

   200

	uint num_lines = 0;

   201

	uint i;

   202

   203

	do {

   204

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

   205

		byte callbackmask = EngInfo(u->engine_type)->callbackmask;

   206

   207

		/* Skip this engine if it has no capacity */

   208

		if (u->cargo_cap == 0) continue;

   209

   210

		/* Loop through all cargos in the refit mask */

   211

		for (CargoID cid = 0; cid < NUM_CARGO && num_lines < max_lines; cid++) {

   212

			/* Skip cargo type if it's not listed */

   213

			if (!HASBIT(cmask, cid)) continue;

   214

   215

			/* Check the vehicle's callback mask for cargo suffixes */

   216

			if (HASBIT(callbackmask, CBM_CARGO_SUFFIX)) {

   217

				/* Make a note of the original cargo type. It has to be

   218

				 * changed to test the cargo & subtype... */

   219

				CargoID temp_cargo = u->cargo_type;

   220

				byte temp_subtype  = u->cargo_subtype;

   221

				byte refit_cyc;

   222

   223

				u->cargo_type = cid;

   224

   225

				for (refit_cyc = 0; refit_cyc < 16 && num_lines < max_lines; refit_cyc++) {

   226

					bool duplicate = false;

   227

					uint16 callback;

   228

   229

					u->cargo_subtype = refit_cyc;

   230

					callback = GetVehicleCallback(CBID_VEHICLE_CARGO_SUFFIX, 0, 0, u->engine_type, u);

   231

   232

					if (callback == 0xFF) callback = CALLBACK_FAILED;

   233

					if (refit_cyc != 0 && callback == CALLBACK_FAILED) break;

   234

   235

					/* Check if this cargo and subtype combination are listed */

   236

					for (i = 0; i < num_lines && !duplicate; i++) {

   237

						if (refit[i].cargo == cid && refit[i].value == callback) duplicate = true;

   238

					}

   239

   240

					if (duplicate) continue;

   241

   242

					refit[num_lines].cargo   = cid;

   243

					refit[num_lines].subtype = refit_cyc;

   244

					refit[num_lines].value   = callback;

   245

					refit[num_lines].engine  = u->engine_type;

   246

					num_lines++;

   247

				}

   248

   249

				/* Reset the vehicle's cargo type */

   250

				u->cargo_type    = temp_cargo;

   251

				u->cargo_subtype = temp_subtype;

   252

			} else {

   253

				/* No cargo suffix callback -- use no subtype */

   254

				bool duplicate = false;

   255

   256

				for (i = 0; i < num_lines && !duplicate; i++) {

   257

					if (refit[i].cargo == cid && refit[i].value == CALLBACK_FAILED) duplicate = true;

   258

				}

   259

   260

				if (!duplicate) {

   261

					refit[num_lines].cargo   = cid;

   262

					refit[num_lines].subtype = 0;

   263

					refit[num_lines].value   = CALLBACK_FAILED;

   264

					refit[num_lines].engine  = INVALID_ENGINE;

   265

					num_lines++;

   266

				}

   267

			}

   268

		}

   269

	} while (v->type == VEH_TRAIN && (u = u->next) != NULL && num_lines < max_lines);

   270

   271

	list->num_lines = num_lines;

   272

	list->items = refit;

   273

   274

	return list;

   275

}

   276

   277

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

   278

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

   280

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

   284

 * @return the refit option that is hightlighted, NULL if none

   285

 */

   286

static RefitOption *DrawVehicleRefitWindow(const RefitList *list, int sel, uint pos, uint rows, uint delta)

   287

{

   288

	RefitOption *refit = list->items;

   289

	RefitOption *selected = NULL;

   290

	uint num_lines = list->num_lines;

   291

	uint y = 31;

   292

	uint i;

   293

   294

	/* Draw the list, and find the selected cargo (by its position in list) */

   295

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

   296

		byte colour = 16;

   297

		if (sel == 0) {

   298

			selected = &refit[i];

   299

			colour = 12;

   300

		}

   301

   302

		if (i >= pos && i < pos + rows) {

   303

			/* Draw the cargo name */

   304

			int last_x = DrawString(2, y, GetCargo(refit[i].cargo)->name, colour);

   305

   306

			/* If the callback succeeded, draw the cargo suffix */

   307

			if (refit[i].value != CALLBACK_FAILED) {

   308

				DrawString(last_x + 1, y, GetGRFStringID(GetEngineGRFID(refit[i].engine), 0xD000 + refit[i].value), colour);

   309

			}

   310

			y += delta;

   311

		}

   312

   313

		sel--;

   314

	}

   315

   316

	return selected;

   317

}

   318

   319

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

   320

{

   321

	switch (e->event) {

   322

		case WE_PAINT: {

   323

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

   324

   325

			if (v->type == VEH_TRAIN) {

   326

				uint length = CountVehiclesInChain(v);

   327

   328

				if (length != WP(w, refit_d).length) {

   329

					/* Consist length has changed, so rebuild the refit list */

   330

					free(WP(w, refit_d).list->items);

   331

					free(WP(w, refit_d).list);

   332

					WP(w, refit_d).list = BuildRefitList(v);

   333

					WP(w, refit_d).length = length;

   334

				}

   335

			}

   336

   337

			SetVScrollCount(w, WP(w, refit_d).list->num_lines);

   338

   339

			SetDParam(0, v->string_id);

   340

			SetDParam(1, v->unitnumber);

   341

			w->DrawWidgets();

   342

   344

   346

				int32 cost;

   347

   349

								 DC_QUERY_COST, GetCmdRefitVeh(GetVehicle(w->window_number)->type));

   350

   351

				if (!CmdFailed(cost)) {

   353

					SetDParam(1, _returned_refit_capacity);

   354

					SetDParam(2, cost);

   355

					DrawString(2, w->widget[5].top + 1, STR_9840_NEW_CAPACITY_COST_OF_REFIT, 0);

   356

				}

   357

			}

   359

   360

		case WE_CLICK:

   361

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

   362

				case 3: { // listbox

   363

					int y = e->we.click.pt.y - w->widget[3].top;

   364

					if (y >= 0) {

   366

						w->SetDirty();

   367

					}

   368

				} break;

   369

				case 6: // refit button

   371

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

   372

   373

						if (WP(w, refit_d).order == INVALID_VEH_ORDER_ID) {

   374

							int command = 0;

   375

   376

							switch (v->type) {

   377

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

   378

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

   379

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

   380

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

   381

							}

   383

						} else {

   385

						}

   386

					}

   387

					break;

   388

			}

   389

			break;

   390

   391

		case WE_RESIZE:

   392

			w->vscroll.cap += e->we.sizing.diff.y / (int)w->resize.step_height;

   393

			w->widget[3].data = (w->vscroll.cap << 8) + 1;

   394

			break;

   395

   396

		case WE_DESTROY:

   397

			free(WP(w, refit_d).list->items);

   398

			free(WP(w, refit_d).list);

   399

			break;

   400

	}

   401

}

   402

   403

   404

static const OldWidget _vehicle_refit_widgets[] = {

   405

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

   406

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

   407

	{    WWT_TEXTBTN,   RESIZE_NONE,    14,     0,   239,    14,    27, STR_983F_SELECT_CARGO_TYPE_TO_CARRY, STR_983D_SELECT_TYPE_OF_CARGO_FOR},

   408

	{     WWT_MATRIX, RESIZE_BOTTOM,    14,     0,   227,    28,   139, 0x801,                               STR_EMPTY},

   409

	{  WWT_SCROLLBAR, RESIZE_BOTTOM,    14,   228,   239,    28,   139, 0x0,                                 STR_0190_SCROLL_BAR_SCROLLS_LIST},

   410

	{      WWT_PANEL,     RESIZE_TB,    14,     0,   239,   140,   161, 0x0,                                 STR_NULL},

   411

	{ WWT_PUSHTXTBTN,     RESIZE_TB,    14,     0,   227,   162,   173, 0x0,                                 STR_NULL},

   412

	{  WWT_RESIZEBOX,     RESIZE_TB,    14,   228,   239,   162,   173, 0x0,                                 STR_RESIZE_BUTTON},

   413

	{   WIDGETS_END},

   414

};

   415

   416

static const WindowDesc _vehicle_refit_desc = {

   417

	WDP_AUTO, WDP_AUTO, 240, 174,

   419

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS | WDF_RESIZABLE,

   420

	_vehicle_refit_widgets,

   421

	VehicleRefitWndProc,

   422

};

   423

   424

/** Show the refit window for a vehicle

   425

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

   427

*/

   428

void ShowVehicleRefitWindow(const Vehicle *v, VehicleOrderID order)

   429

{

   430

	BaseWindow *w;

   431

   432

	DeleteWindowById(WC_VEHICLE_REFIT, v->index);

   433

   434

	w = BaseWindow::AllocateFront(&_vehicle_refit_desc, v->index);

   435

	WP(w, refit_d).order = order;

   436

   437

	if (w != NULL) {

   438

		w->caption_color = v->owner;

   439

		w->vscroll.cap = 8;

   440

		w->resize.step_height = 14;

   441

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

   442

		WP(w, refit_d).list = BuildRefitList(v);

   443

		if (v->type == VEH_TRAIN) WP(w, refit_d).length = CountVehiclesInChain(v);

   444

		SetVScrollCount(w, WP(w, refit_d).list->num_lines);

   445

   446

		switch (v->type) {

   447

			case VEH_TRAIN:

   448

				w->widget[3].tooltips = STR_RAIL_SELECT_TYPE_OF_CARGO_FOR;

   449

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

   450

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

   451

				break;

   452

			case VEH_ROAD:

   453

				w->widget[3].tooltips = STR_ROAD_SELECT_TYPE_OF_CARGO_FOR;

   454

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

   455

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

   456

				break;

   457

			case VEH_SHIP:

   458

				w->widget[3].tooltips = STR_983D_SELECT_TYPE_OF_CARGO_FOR;

   459

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

   460

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

   461

				break;

   462

			case VEH_AIRCRAFT:

   463

				w->widget[3].tooltips = STR_A03E_SELECT_TYPE_OF_CARGO_FOR;

   464

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

   465

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

   466

				break;

   467

			default: NOT_REACHED();

   468

		}

   469

	}

   470

}

   471

   472

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

   473

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

   474

{

   475

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

   476

	if (callback == CALLBACK_FAILED) return 0;

   477

   478

	/* STR_02BD is used to start the string with {BLACK} */

   479

	SetDParam(0, GetGRFStringID(GetEngineGRFID(engine), 0xD000 + callback));

   480

	return DrawStringMultiLine(x, y, STR_02BD, w);

   481

}