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

	Window* const *wz;

    98

    99

	FOR_ALL_WINDOWS(wz) {

   100

		Window *w = *wz;

   101

   102

		switch (w->window_class) {

   103

			case WC_TRAINS_LIST:

   104

			case WC_ROADVEH_LIST:

   105

			case WC_SHIPS_LIST:

   106

			case WC_AIRCRAFT_LIST:

   107

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

   108

				SetWindowDirty(w);

   109

				break;

   110

   111

			default: break;

   112

		}

   113

	}

   114

}

   115

   116

void ResortVehicleLists()

   117

{

   118

	Window* const *wz;

   119

   120

	FOR_ALL_WINDOWS(wz) {

   121

		Window *w = *wz;

   122

   123

		switch (w->window_class) {

   124

			case WC_TRAINS_LIST:

   125

			case WC_ROADVEH_LIST:

   126

			case WC_SHIPS_LIST:

   127

			case WC_AIRCRAFT_LIST:

   128

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

   129

				SetWindowDirty(w);

   130

				break;

   131

   132

			default: break;

   133

		}

   134

	}

   135

}

   136

   137

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

   138

{

   139

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

   140

   141

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

   142

   143

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

   144

   145

	vl->l.flags &= ~VL_REBUILD;

   146

	vl->l.flags |= VL_RESORT;

   147

}

   148

   149

static void SortVehicleList(vehiclelist_d *vl)

   150

{

   151

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

   152

   153

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

   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

void DepotSortList(Vehicle **v, uint16 length)

   162

{

   163

	_internal_sort_order = 0;

   164

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

   165

}

   166

   167

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

   168

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

   169

{

   170

	SpriteID pal;

   171

   172

	/* draw profit-based colored icons */

   173

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

   174

		pal = PALETTE_TO_GREY;

   175

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

   176

		pal = PALETTE_TO_RED;

   177

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

   178

		pal = PALETTE_TO_YELLOW;

   179

	} else {

   180

		pal = PALETTE_TO_GREEN;

   181

	}

   182

	DrawSprite(SPR_BLOT, pal, x, y);

   183

}

   184

   185

struct RefitOption {

   186

	CargoID cargo;

   187

	byte subtype;

   188

	uint16 value;

   189

	EngineID engine;

   190

};

   191

   192

struct RefitList {

   193

	uint num_lines;

   194

	RefitOption *items;

   195

};

   196

   197

static RefitList *BuildRefitList(const Vehicle *v)

   198

{

   199

	uint max_lines = 256;

   200

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

   201

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

   202

	Vehicle *u = (Vehicle*)v;

   203

	uint num_lines = 0;

   204

	uint i;

   205

   206

	do {

   207

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

   208

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

   209

   210

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

   211

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

   212

   213

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

   214

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

   215

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

   216

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

   217

   218

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

   219

			if (HASBIT(callbackmask, CBM_CARGO_SUFFIX)) {

   220

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

   221

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

   222

				CargoID temp_cargo = u->cargo_type;

   223

				byte temp_subtype  = u->cargo_subtype;

   224

				byte refit_cyc;

   225

   226

				u->cargo_type = cid;

   227

   228

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

   229

					bool duplicate = false;

   230

					uint16 callback;

   231

   232

					u->cargo_subtype = refit_cyc;

   233

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

   234

   235

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

   236

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

   237

   238

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

   239

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

   240

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

   241

					}

   242

   243

					if (duplicate) continue;

   244

   245

					refit[num_lines].cargo   = cid;

   246

					refit[num_lines].subtype = refit_cyc;

   247

					refit[num_lines].value   = callback;

   248

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

   249

					num_lines++;

   250

				}

   251

   252

				/* Reset the vehicle's cargo type */

   253

				u->cargo_type    = temp_cargo;

   254

				u->cargo_subtype = temp_subtype;

   255

			} else {

   256

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

   257

				bool duplicate = false;

   258

   259

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

   260

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

   261

				}

   262

   263

				if (!duplicate) {

   264

					refit[num_lines].cargo   = cid;

   265

					refit[num_lines].subtype = 0;

   266

					refit[num_lines].value   = CALLBACK_FAILED;

   267

					refit[num_lines].engine  = INVALID_ENGINE;

   268

					num_lines++;

   269

				}

   270

			}

   271

		}

   272

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

   273

   274

	list->num_lines = num_lines;

   275

	list->items = refit;

   276

   277

	return list;

   278

}

   279

   280

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

   281

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

   282

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

   283

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

   284

 * @param pos position of the selected item in caller widow

   285

 * @param rows number of rows(capacity) in caller window

   286

 * @param delta step height in caller window

   287

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

   288

 */

   289

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

   290

{

   291

	RefitOption *refit = list->items;

   292

	RefitOption *selected = NULL;

   293

	uint num_lines = list->num_lines;

   294

	uint y = 31;

   295

	uint i;

   296

   297

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

   298

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

   299

		byte colour = 16;

   300

		if (sel == 0) {

   301

			selected = &refit[i];

   302

			colour = 12;

   303

		}

   304

   305

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

   306

			/* Draw the cargo name */

   307

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

   308

   309

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

   310

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

   311

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

   312

			}

   313

			y += delta;

   314

		}

   315

   316

		sel--;

   317

	}

   318

   319

	return selected;

   320

}

   321

   322

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

   323

{

   324

	switch (e->event) {

   325

		case WE_PAINT: {

   326

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

   327

   328

			if (v->type == VEH_TRAIN) {

   329

				uint length = CountVehiclesInChain(v);

   330

   331

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

   332

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

   333

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

   334

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

   335

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

   336

					WP(w, refit_d).length = length;

   337

				}

   338

			}

   339

   340

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

   341

   342

			SetDParam(0, v->string_id);

   343

			SetDParam(1, v->unitnumber);

   344

			DrawWindowWidgets(w);

   345

   346

			WP(w, refit_d).cargo = DrawVehicleRefitWindow(WP(w, refit_d).list, WP(w, refit_d).sel, w->vscroll.pos, w->vscroll.cap, w->resize.step_height);

   347

   348

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

   349

				int32 cost;

   350

   351

				cost = DoCommand(v->tile, v->index, WP(w, refit_d).cargo->cargo | WP(w, refit_d).cargo->subtype << 8,

   352

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

   353

   354

				if (!CmdFailed(cost)) {

   355

					SetDParam(0, WP(w, refit_d).cargo->cargo);

   356

					SetDParam(1, _returned_refit_capacity);

   357

					SetDParam(2, cost);

   358

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

   359

				}

   360

			}

   361

		} break;

   362

   363

		case WE_CLICK:

   364

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

   365

				case 3: { // listbox

   366

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

   367

					if (y >= 0) {

   368

						WP(w, refit_d).sel = (y / (int)w->resize.step_height) + w->vscroll.pos;

   369

						SetWindowDirty(w);

   370

					}

   371

				} break;

   372

				case 6: // refit button

   373

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

   374

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

   375

   376

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

   377

							int command = 0;

   378

   379

							switch (v->type) {

   381

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

   382

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

   383

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

   384

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

   385

							}

   386

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

   387

						} else {

   388

							if (DoCommandP(v->tile, v->index, WP(w, refit_d).cargo->cargo | WP(w, refit_d).cargo->subtype << 8 | WP(w, refit_d).order << 16, NULL, CMD_ORDER_REFIT)) DeleteWindow(w);

   389

						}

   390

					}

   391

					break;

   392

			}

   393

			break;

   394

   395

		case WE_RESIZE:

   396

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

   397

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

   398

			break;

   399

   400

		case WE_DESTROY:

   401

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

   402

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

   403

			break;

   404

	}

   405

}

   406

   407

   408

static const Widget _vehicle_refit_widgets[] = {

   409

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

   410

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

   411

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

   412

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

   413

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

   414

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

   415

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

   416

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

   417

	{   WIDGETS_END},

   418

};

   419

   420

static const WindowDesc _vehicle_refit_desc = {

   421

	WDP_AUTO, WDP_AUTO, 240, 174,

   422

	WC_VEHICLE_REFIT, WC_VEHICLE_VIEW,

   423

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS | WDF_RESIZABLE,

   424

	_vehicle_refit_widgets,

   425

	VehicleRefitWndProc,

   426

};

   427

   428

/** Show the refit window for a vehicle

   429

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

   430

* @param order of the vehicle ( ? )

   431

*/

   432

void ShowVehicleRefitWindow(const Vehicle *v, VehicleOrderID order)

   433

{

   434

	Window *w;

   435

   436

	DeleteWindowById(WC_VEHICLE_REFIT, v->index);

   437

   438

	w = AllocateWindowDescFront(&_vehicle_refit_desc, v->index);

   439

	WP(w, refit_d).order = order;

   440

   441

	if (w != NULL) {

   442

		w->caption_color = v->owner;

   443

		w->vscroll.cap = 8;

   444

		w->resize.step_height = 14;

   445

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

   446

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

   447

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

   448

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

   449

   450

		switch (v->type) {

   451

			case VEH_TRAIN:

   452

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

   453

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

   454

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

   455

				break;

   456

			case VEH_ROAD:

   457

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

   458

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

   459

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

   460

				break;

   461

			case VEH_SHIP:

   462

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

   463

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

   464

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

   465

				break;

   466

			case VEH_AIRCRAFT:

   467

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

   468

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

   469

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

   470

				break;

   471

			default: NOT_REACHED();

   472

		}

   473

	}

   474

}

   475

   476

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

   477

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

   478

{

   479

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

   480

	if (callback == CALLBACK_FAILED) return 0;

   481

   482

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