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

Sorting _sorting;

    44

static bool   _internal_sort_order;     // descending/ascending

    45

    46

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

    47

    48

static VehicleSortListingTypeFunction VehicleNumberSorter;

    49

static VehicleSortListingTypeFunction VehicleNameSorter;

    50

static VehicleSortListingTypeFunction VehicleAgeSorter;

    51

static VehicleSortListingTypeFunction VehicleProfitThisYearSorter;

    52

static VehicleSortListingTypeFunction VehicleProfitLastYearSorter;

    53

static VehicleSortListingTypeFunction VehicleCargoSorter;

    54

static VehicleSortListingTypeFunction VehicleReliabilitySorter;

    55

static VehicleSortListingTypeFunction VehicleMaxSpeedSorter;

    56

static VehicleSortListingTypeFunction VehicleModelSorter;

    57

static VehicleSortListingTypeFunction VehicleValueSorter;

    58

static VehicleSortListingTypeFunction VehicleLengthSorter;

    59

    60

static VehicleSortListingTypeFunction* const _vehicle_sorter[] = {

    61

	&VehicleNumberSorter,

    62

	&VehicleNameSorter,

    63

	&VehicleAgeSorter,

    64

	&VehicleProfitThisYearSorter,

    65

	&VehicleProfitLastYearSorter,

    66

	&VehicleCargoSorter,

    67

	&VehicleReliabilitySorter,

    68

	&VehicleMaxSpeedSorter,

    69

	&VehicleModelSorter,

    70

	&VehicleValueSorter,

    71

	&VehicleLengthSorter,

    72

};

    73

    74

const StringID _vehicle_sort_listing[] = {

    75

	STR_SORT_BY_NUMBER,

    76

	STR_SORT_BY_DROPDOWN_NAME,

    77

	STR_SORT_BY_AGE,

    78

	STR_SORT_BY_PROFIT_THIS_YEAR,

    79

	STR_SORT_BY_PROFIT_LAST_YEAR,

    80

	STR_SORT_BY_TOTAL_CAPACITY_PER_CARGOTYPE,

    81

	STR_SORT_BY_RELIABILITY,

    82

	STR_SORT_BY_MAX_SPEED,

    83

	STR_SORT_BY_MODEL,

    84

	STR_SORT_BY_VALUE,

    85

	STR_SORT_BY_LENGTH,

    86

	INVALID_STRING_ID

    87

};

    88

    89

/**

    90

 * Set sort list flag for all vehicle list windows

    91

 * @param sl_flag Sort list flag to set

    92

 */

    93

static void SetVehicleListsFlag(SortListFlags sl_flag)

    94

{

    95

	Window* const *wz;

    96

    97

	FOR_ALL_WINDOWS(wz) {

    98

		Window *w = *wz;

    99

   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

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

   106

				w->SetDirty();

   107

				break;

   108

   109

			default: break;

   110

		}

   111

	}

   112

}

   113

   114

/**

   115

 * Rebuild all vehicle list windows

   116

 */

   117

void RebuildVehicleLists()

   118

{

   119

	SetVehicleListsFlag(VL_REBUILD);

   120

}

   121

   122

/**

   123

 * Resort all vehicle list windows

   124

 */

   125

void ResortVehicleLists()

   126

{

   127

	SetVehicleListsFlag(VL_RESORT);

   128

}

   129

   130

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

   131

{

   132

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

   133

   134

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

   135

   136

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

   137

   138

	vl->vehicles.flags &= ~VL_REBUILD;

   139

	vl->vehicles.flags |= VL_RESORT;

   140

}

   141

   142

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

   143

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

   144

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

   145

   146

void SortVehicleList(VehicleListBase *vl)

   147

{

   148

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

   149

   150

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

   151

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

   152

   153

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

   154

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

   155

		_vehicle_sorter[vl->vehicles.sort_type]);

   156

   157

	vl->vehicles.resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   158

	vl->vehicles.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->GetDisplayProfitLastYear() < 0) {

   176

		pal = PALETTE_TO_RED;

   177

	} else if (v->GetDisplayProfitLastYear() < 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_VEHICLE_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

		TextColour colour = TC_BLACK;

   300

		if (sel == 0) {

   301

			selected = &refit[i];

   302

			colour = TC_WHITE;

   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

struct RefitWindow : public Window {

   323

	int sel;

   324

	RefitOption *cargo;

   325

	RefitList *list;

   326

	uint length;

   327

	VehicleOrderID order;

   328

   329

	RefitWindow(const WindowDesc *desc, const Vehicle *v, VehicleOrderID order) : Window(desc, v->index)

   330

	{

   331

		this->caption_color = v->owner;

   332

		this->vscroll.cap = 8;

   333

		this->resize.step_height = 14;

   334

   335

		this->order = order;

   336

		this->sel  = -1;

   337

		this->list = BuildRefitList(v);

   338

		if (v->type == VEH_TRAIN) this->length = CountVehiclesInChain(v);

   339

		SetVScrollCount(this, this->list->num_lines);

   340

   341

		switch (v->type) {

   342

			case VEH_TRAIN:

   343

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

   344

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

   345

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

   346

				break;

   347

   348

			case VEH_ROAD:

   349

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

   350

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

   351

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

   352

				break;

   353

   354

			case VEH_SHIP:

   355

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

   356

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

   357

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

   358

				break;

   359

   360

			case VEH_AIRCRAFT:

   361

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

   362

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

   363

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

   364

				break;

   365

   366

			default: NOT_REACHED();

   367

		}

   368

   369

		this->FindWindowPlacementAndResize(desc);

   370

	}

   371

   372

	~RefitWindow()

   373

	{

   374

		free(this->list->items);

   375

		free(this->list);

   376

	}

   377

   378

	virtual void OnPaint()

   379

	{

   380

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

   381

   382

		if (v->type == VEH_TRAIN) {

   383

			uint length = CountVehiclesInChain(v);

   384

   385

			if (length != this->length) {

   386

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

   387

				free(this->list->items);

   388

				free(this->list);

   389

				this->list = BuildRefitList(v);

   390

				this->length = length;

   391

			}

   392

		}

   393

   394

		SetVScrollCount(this, this->list->num_lines);

   395

   396

		SetDParam(0, v->index);

   397

		this->DrawWidgets();

   398

   399

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

   400

   401

		if (this->cargo != NULL) {

   402

			CommandCost cost;

   403

   404

			cost = DoCommand(v->tile, v->index, this->cargo->cargo | this->cargo->subtype << 8,

   405

							 DC_QUERY_COST, GetCmdRefitVeh(v->type));

   406

   407

			if (CmdSucceeded(cost)) {

   408

				SetDParam(0, this->cargo->cargo);

   409

				SetDParam(1, _returned_refit_capacity);

   410

				SetDParam(2, cost.GetCost());

   411

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

   412

			}

   413

		}

   414

	}

   415

   416

	virtual void OnClick(Point pt, int widget)

   417

	{

   418

		switch (widget) {

   419

			case 3: { // listbox

   420

				int y = pt.y - this->widget[3].top;

   421

				if (y >= 0) {

   422

					this->sel = (y / (int)this->resize.step_height) + this->vscroll.pos;

   423

					this->SetDirty();

   424

				}

   425

				break;

   426

			}

   427

   428

			case 6: // refit button

   429

				if (this->cargo != NULL) {

   430

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

   431

   432

					if (this->order == INVALID_VEH_ORDER_ID) {

   433

						int command = 0;

   434

   435

						switch (v->type) {

   436

							default: NOT_REACHED();

   437

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

   438

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

   439

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

   440

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

   441

						}

   442

						if (DoCommandP(v->tile, v->index, this->cargo->cargo | this->cargo->subtype << 8, NULL, command)) delete this;

   443

					} else {

   444

						if (DoCommandP(v->tile, v->index, this->cargo->cargo | this->cargo->subtype << 8 | this->order << 16, NULL, CMD_ORDER_REFIT)) delete this;

   445

					}

   446

				}

   447

				break;

   448

		}

   449

	}

   450

   451

	virtual void OnResize(Point new_size, Point delta)

   452

	{

   453

		this->vscroll.cap += delta.y / (int)this->resize.step_height;

   454

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

   455

	}

   456

};

   457

   458

   459

static const Widget _vehicle_refit_widgets[] = {

   460

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

   461

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

   462

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

   463

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

   464

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

   465

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

   466

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

   467

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

   468

	{   WIDGETS_END},

   469

};

   470

   471

static const WindowDesc _vehicle_refit_desc = {

   472

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

   473

	WC_VEHICLE_REFIT, WC_VEHICLE_VIEW,

   474

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS | WDF_RESIZABLE,

   475

	_vehicle_refit_widgets,

   476

	NULL

   477

};

   478

   479

/** Show the refit window for a vehicle

   480

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

   481

* @param order of the vehicle ( ? )

   482

*/

   483

void ShowVehicleRefitWindow(const Vehicle *v, VehicleOrderID order)

   484