1

/* $Id$ */

     2

     3

/** @file vehicle_gui.cpp The base GUI for all vehicles. */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "debug.h"

     8

#include "player_func.h"

     9

#include "gui.h"

    10

#include "window_gui.h"

    11

#include "textbuf_gui.h"

    12

#include "command_func.h"

    13

#include "variables.h"

    14

#include "vehicle_gui.h"

    15

#include "viewport_func.h"

    16

#include "gfx_func.h"

    17

#include "train.h"

    18

#include "newgrf_callbacks.h"

    19

#include "newgrf_engine.h"

    20

#include "newgrf_text.h"

    21

#include "ship.h"

    22

#include "aircraft.h"

    23

#include "roadveh.h"

    24

#include "depot_base.h"

    25

#include "cargotype.h"

    26

#include "group.h"

    27

#include "group_gui.h"

    28

#include "strings_func.h"

    29

#include "functions.h"

    30

#include "window_func.h"

    31

#include "vehicle_func.h"

    32

#include "autoreplace_gui.h"

    33

#include "core/alloc_func.hpp"

    34

#include "string_func.h"

    35

#include "settings_type.h"

    36

#include "widgets/dropdown_func.h"

    37

#include "order_func.h"

    38

#include "timetable.h"

    39

    40

#include "table/sprites.h"

    41

#include "table/strings.h"

    42

    43

struct vehicledetails_d {

    44

	byte tab;

    45

};

    46

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(vehicledetails_d));

    47

    48

struct refit_d {

    49

	int sel;

    50

	struct RefitOption *cargo;

    51

	struct RefitList *list;

    52

	uint length;

    53

	VehicleOrderID order;

    54

};

    55

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(refit_d));

    56

    57

Sorting _sorting;

    58

static bool   _internal_sort_order;     // descending/ascending

    59

    60

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

    61

    62

static VehicleSortListingTypeFunction VehicleNumberSorter;

    63

static VehicleSortListingTypeFunction VehicleNameSorter;

    64

static VehicleSortListingTypeFunction VehicleAgeSorter;

    65

static VehicleSortListingTypeFunction VehicleProfitThisYearSorter;

    66

static VehicleSortListingTypeFunction VehicleProfitLastYearSorter;

    67

static VehicleSortListingTypeFunction VehicleCargoSorter;

    68

static VehicleSortListingTypeFunction VehicleReliabilitySorter;

    69

static VehicleSortListingTypeFunction VehicleMaxSpeedSorter;

    70

static VehicleSortListingTypeFunction VehicleModelSorter;

    71

static VehicleSortListingTypeFunction VehicleValueSorter;

    72

static VehicleSortListingTypeFunction VehicleLengthSorter;

    73

    74

static VehicleSortListingTypeFunction* const _vehicle_sorter[] = {

    75

	&VehicleNumberSorter,

    76

	&VehicleNameSorter,

    77

	&VehicleAgeSorter,

    78

	&VehicleProfitThisYearSorter,

    79

	&VehicleProfitLastYearSorter,

    80

	&VehicleCargoSorter,

    81

	&VehicleReliabilitySorter,

    82

	&VehicleMaxSpeedSorter,

    83

	&VehicleModelSorter,

    84

	&VehicleValueSorter,

    85

	&VehicleLengthSorter,

    86

};

    87

    88

const StringID _vehicle_sort_listing[] = {

    89

	STR_SORT_BY_NUMBER,

    90

	STR_SORT_BY_DROPDOWN_NAME,

    91

	STR_SORT_BY_AGE,

    92

	STR_SORT_BY_PROFIT_THIS_YEAR,

    93

	STR_SORT_BY_PROFIT_LAST_YEAR,

    94

	STR_SORT_BY_TOTAL_CAPACITY_PER_CARGOTYPE,

    95

	STR_SORT_BY_RELIABILITY,

    96

	STR_SORT_BY_MAX_SPEED,

    97

	STR_SORT_BY_MODEL,

    98

	STR_SORT_BY_VALUE,

    99

	STR_SORT_BY_LENGTH,

   100

	INVALID_STRING_ID

   101

};

   102

   103

/**

   104

 * Set sort list flag for all vehicle list windows

   105

 * @param sl_flag Sort list flag to set

   106

 */

   107

static void SetVehicleListsFlag(SortListFlags sl_flag)

   108

{

   109

	Window* const *wz;

   110

   111

	FOR_ALL_WINDOWS(wz) {

   112

		Window *w = *wz;

   113

   114

		switch (w->window_class) {

   115

			case WC_TRAINS_LIST:

   116

			case WC_ROADVEH_LIST:

   117

			case WC_SHIPS_LIST:

   118

			case WC_AIRCRAFT_LIST:

   119

				dynamic_cast<VehicleListBase*>(w)->vehicles.flags |= sl_flag;

   120

				w->SetDirty();

   121

				break;

   122

   123

			default: break;

   124

		}

   125

	}

   126

}

   127

   128

/**

   129

 * Rebuild all vehicle list windows

   130

 */

   131

void RebuildVehicleLists()

   132

{

   133

	SetVehicleListsFlag(VL_REBUILD);

   134

}

   135

   136

/**

   137

 * Resort all vehicle list windows

   138

 */

   139

void ResortVehicleLists()

   140

{

   141

	SetVehicleListsFlag(VL_RESORT);

   142

}

   143

   144

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

   145

{

   146

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

   147

   148

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

   149

   150

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

   151

   152

	vl->vehicles.flags &= ~VL_REBUILD;

   153

	vl->vehicles.flags |= VL_RESORT;

   154

}

   155

   156

/* cached values for VehicleNameSorter to spare many GetString() calls */

   157

static const Vehicle *_last_vehicle[2] = { NULL, NULL };

   158

static char           _last_name[2][64] = { "", "" };

   159

   160

void SortVehicleList(VehicleListBase *vl)

   161

{

   162

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

   163

   164

	/* invalidate cached values for name sorter - vehicle names could change */

   165

	_last_vehicle[0] = _last_vehicle[1] = NULL;

   166

   167

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

   168

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

   169

		_vehicle_sorter[vl->vehicles.sort_type]);

   170

   171

	vl->vehicles.resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   172

	vl->vehicles.flags &= ~VL_RESORT;

   173

}

   174

   175

void DepotSortList(Vehicle **v, uint16 length)

   176

{

   177

	_internal_sort_order = 0;

   178

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

   179

}

   180

   181

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

   182

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

   183

{

   184

	SpriteID pal;

   185

   186

	/* draw profit-based colored icons */

   187

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

   188

		pal = PALETTE_TO_GREY;

   189

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

   190

		pal = PALETTE_TO_RED;

   191

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

   192

		pal = PALETTE_TO_YELLOW;

   193

	} else {

   194

		pal = PALETTE_TO_GREEN;

   195

	}

   196

	DrawSprite(SPR_BLOT, pal, x, y);

   197

}

   198

   199

struct RefitOption {

   200

	CargoID cargo;

   201

	byte subtype;

   202

	uint16 value;

   203

	EngineID engine;

   204

};

   205

   206

struct RefitList {

   207

	uint num_lines;

   208

	RefitOption *items;

   209

};

   210

   211

static RefitList *BuildRefitList(const Vehicle *v)

   212

{

   213

	uint max_lines = 256;

   214

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

   215

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

   216

	Vehicle *u = (Vehicle*)v;

   217

	uint num_lines = 0;

   218

	uint i;

   219

   220

	do {

   221

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

   222

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

   223

   224

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

   225

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

   226

   227

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

   228

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

   229

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

   230

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

   231

   232

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

   233

			if (HasBit(callbackmask, CBM_VEHICLE_CARGO_SUFFIX)) {

   234

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

   235

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

   236

				CargoID temp_cargo = u->cargo_type;

   237

				byte temp_subtype  = u->cargo_subtype;

   238

				byte refit_cyc;

   239

   240

				u->cargo_type = cid;

   241

   242

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

   243

					bool duplicate = false;

   244

					uint16 callback;

   245

   246

					u->cargo_subtype = refit_cyc;

   247

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

   248

   249

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

   250

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

   251

   252

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

   253

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

   254

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

   255

					}

   256

   257

					if (duplicate) continue;

   258

   259

					refit[num_lines].cargo   = cid;

   260

					refit[num_lines].subtype = refit_cyc;

   261

					refit[num_lines].value   = callback;

   262

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

   263

					num_lines++;

   264

				}

   265

   266

				/* Reset the vehicle's cargo type */

   267

				u->cargo_type    = temp_cargo;

   268

				u->cargo_subtype = temp_subtype;

   269

			} else {

   270

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

   271

				bool duplicate = false;

   272

   273

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

   274

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

   275

				}

   276

   277

				if (!duplicate) {

   278

					refit[num_lines].cargo   = cid;

   279

					refit[num_lines].subtype = 0;

   280

					refit[num_lines].value   = CALLBACK_FAILED;

   281

					refit[num_lines].engine  = INVALID_ENGINE;

   282

					num_lines++;

   283

				}

   284

			}

   285

		}

   286

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

   287

   288

	list->num_lines = num_lines;

   289

	list->items = refit;

   290

   291

	return list;

   292

}

   293

   294

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

   295

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

   296

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

   297

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

   298

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

   299

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

   300

 * @param delta step height in caller window

   301

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

   302

 */

   303

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

   304

{

   305

	RefitOption *refit = list->items;

   306

	RefitOption *selected = NULL;

   307

	uint num_lines = list->num_lines;

   308

	uint y = 31;

   309

	uint i;

   310

   311

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

   312

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

   313

		TextColour colour = TC_BLACK;

   314

		if (sel == 0) {

   315

			selected = &refit[i];

   316

			colour = TC_WHITE;

   317

		}

   318

   319

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

   320

			/* Draw the cargo name */

   321

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

   322

   323

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

   324

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

   325

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

   326

			}

   327

			y += delta;

   328

		}

   329

   330

		sel--;

   331

	}

   332

   333

	return selected;

   334

}

   335

   336

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

   337

{

   338

	switch (e->event) {

   339

		case WE_PAINT: {

   340

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

   341

   342

			if (v->type == VEH_TRAIN) {

   343

				uint length = CountVehiclesInChain(v);

   344

   345

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

   346

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

   347

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

   348

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

   349

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

   350

					WP(w, refit_d).length = length;

   351

				}

   352

			}

   353

   354

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

   355

   356

			SetDParam(0, v->index);

   357

			DrawWindowWidgets(w);

   358

   359

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

   360

   361

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

   362

				CommandCost cost;

   363

   364

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

   365

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

   366

   367

				if (CmdSucceeded(cost)) {

   368

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

   369

					SetDParam(1, _returned_refit_capacity);

   370

					SetDParam(2, cost.GetCost());

   371

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

   372

				}

   373

			}

   374

		} break;

   375

   376

		case WE_CLICK:

   377

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

   378

				case 3: { // listbox

   379

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

   380

					if (y >= 0) {

   381

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

   382

						w->SetDirty();

   383

					}

   384

				} break;

   385

				case 6: // refit button

   386

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

   387

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

   388

   389

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

   390

							int command = 0;

   391

   392

							switch (v->type) {

   393

								default: NOT_REACHED();

   394

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

   395

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

   396

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

   397

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

   398

							}

   399

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

   400

						} else {

   401

							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)) delete w;

   402

						}

   403

					}

   404

					break;

   405

			}

   406

			break;

   407

   408

		case WE_RESIZE:

   409

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

   410

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

   411

			break;

   412

   413

		case WE_DESTROY:

   414

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

   415

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

   416

			break;

   417

	}

   418

}

   419

   420

   421

static const Widget _vehicle_refit_widgets[] = {

   422

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

   423

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

   424

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

   425

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

   426

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

   427

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

   428

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

   429

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

   430

	{   WIDGETS_END},

   431

};

   432

   433

static const WindowDesc _vehicle_refit_desc = {

   434

	WDP_AUTO, WDP_AUTO, 240, 174, 240, 174,

   435

	WC_VEHICLE_REFIT, WC_VEHICLE_VIEW,

   436

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS | WDF_RESIZABLE,

   437

	_vehicle_refit_widgets,

   438

	VehicleRefitWndProc,

   439

};

   440

   441

/** Show the refit window for a vehicle

   442

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

   443

* @param order of the vehicle ( ? )

   444

*/

   445

void ShowVehicleRefitWindow(const Vehicle *v, VehicleOrderID order)

   446

{

   447

	Window *w;

   448

   449

	DeleteWindowById(WC_VEHICLE_REFIT, v->index);

   450

   451

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

   452

	WP(w, refit_d).order = order;

   453

   454

	if (w != NULL) {

   455

		w->caption_color = v->owner;

   456

		w->vscroll.cap = 8;

   457

		w->resize.step_height = 14;

   458

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

   459

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

   460

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

   461

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

   462

   463

		switch (v->type) {

   464

			case VEH_TRAIN:

   465

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

   466

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

   467

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

   468

				break;

   469

			case VEH_ROAD:

   470

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

   471

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

   472

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

   473

				break;

   474

			case VEH_SHIP:

   475

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

   476

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

   477

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

   478

				break;

   479

			case VEH_AIRCRAFT:

   480

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

   481

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