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 "core/mem_func.hpp"

    35

#include "core/sort_func.hpp"

    36

#include "string_func.h"

    37

#include "settings_type.h"

    38

#include "widgets/dropdown_func.h"

    39

#include "order_func.h"

    40

#include "timetable.h"

    41

#include "vehiclelist.h"

    42

    43

#include "table/sprites.h"

    44

#include "table/strings.h"

    45

    46

Sorting _sorting;

    47

    48

static GUIVehicleList::SortFunction VehicleNumberSorter;

    49

static GUIVehicleList::SortFunction VehicleNameSorter;

    50

static GUIVehicleList::SortFunction VehicleAgeSorter;

    51

static GUIVehicleList::SortFunction VehicleProfitThisYearSorter;

    52

static GUIVehicleList::SortFunction VehicleProfitLastYearSorter;

    53

static GUIVehicleList::SortFunction VehicleCargoSorter;

    54

static GUIVehicleList::SortFunction VehicleReliabilitySorter;

    55

static GUIVehicleList::SortFunction VehicleMaxSpeedSorter;

    56

static GUIVehicleList::SortFunction VehicleModelSorter;

    57

static GUIVehicleList::SortFunction VehicleValueSorter;

    58

static GUIVehicleList::SortFunction VehicleLengthSorter;

    59

    60

GUIVehicleList::SortFunction* const VehicleListBase::vehicle_sorter_funcs[] = {

    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 VehicleListBase::vehicle_sorter_names[] = {

    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

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

    90

{

    91

	if (!vl->vehicles.NeedRebuild()) return;

    92

    93

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

    94

    95

	GenerateVehicleSortList(&vl->vehicles, vl->vehicle_type, owner, index, window_type);

    96

    97

	vl->vehicles.RebuildDone();

    98

}

    99

   100

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

   101

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

   102

   103

void SortVehicleList(VehicleListBase *vl)

   104

{

   105

	if (vl->vehicles.Sort()) return;

   106

   107

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

   108

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

   109

}

   110

   111

void DepotSortList(VehicleList *list)

   112

{

   113

	if (list->Length() < 2) return;

   114

	QSortT(list->Begin(), list->Length(), &VehicleNumberSorter);

   115

}

   116

   117

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

   118

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

   119

{

   120

	SpriteID pal;

   121

   122

	/* draw profit-based colored icons */

   123

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

   124

		pal = PALETTE_TO_GREY;

   125

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

   126

		pal = PALETTE_TO_RED;

   127

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

   128

		pal = PALETTE_TO_YELLOW;

   129

	} else {

   130

		pal = PALETTE_TO_GREEN;

   131

	}

   132

	DrawSprite(SPR_BLOT, pal, x, y);

   133

}

   134

   135

struct RefitOption {

   136

	CargoID cargo;

   137

	byte subtype;

   138

	uint16 value;

   139

	EngineID engine;

   140

};

   141

   142

struct RefitList {

   143

	uint num_lines;

   144

	RefitOption *items;

   145

};

   146

   147

static RefitList *BuildRefitList(const Vehicle *v)

   148

{

   149

	uint max_lines = 256;

   150

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

   151

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

   152

	Vehicle *u = (Vehicle*)v;

   153

	uint num_lines = 0;

   154

	uint i;

   155

   156

	do {

   157

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

   158

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

   159

   160

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

   161

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

   162

   163

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

   164

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

   165

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

   166

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

   167

   168

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

   169

			if (HasBit(callbackmask, CBM_VEHICLE_CARGO_SUFFIX)) {

   170

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

   171

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

   172

				CargoID temp_cargo = u->cargo_type;

   173

				byte temp_subtype  = u->cargo_subtype;

   174

				byte refit_cyc;

   175

   176

				u->cargo_type = cid;

   177

   178

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

   179

					bool duplicate = false;

   180

					uint16 callback;

   181

   182

					u->cargo_subtype = refit_cyc;

   183

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

   184

   185

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

   186

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

   187

   188

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

   189

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

   190

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

   191

					}

   192

   193

					if (duplicate) continue;

   194

   195

					refit[num_lines].cargo   = cid;

   196

					refit[num_lines].subtype = refit_cyc;

   197

					refit[num_lines].value   = callback;

   198

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

   199

					num_lines++;

   200

				}

   201

   202

				/* Reset the vehicle's cargo type */

   203

				u->cargo_type    = temp_cargo;

   204

				u->cargo_subtype = temp_subtype;

   205

			} else {

   206

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

   207

				bool duplicate = false;

   208

   209

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

   210

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

   211

				}

   212

   213

				if (!duplicate) {

   214

					refit[num_lines].cargo   = cid;

   215

					refit[num_lines].subtype = 0;

   216

					refit[num_lines].value   = CALLBACK_FAILED;

   217

					refit[num_lines].engine  = INVALID_ENGINE;

   218

					num_lines++;

   219

				}

   220

			}

   221

		}

   222

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

   223

   224

	list->num_lines = num_lines;

   225

	list->items = refit;

   226

   227

	return list;

   228

}

   229

   230

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

   231

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

   232

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

   233

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

   234

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

   235

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

   236

 * @param delta step height in caller window

   237

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

   238

 */

   239

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

   240

{

   241

	RefitOption *refit = list->items;

   242

	RefitOption *selected = NULL;

   243

	uint num_lines = list->num_lines;

   244

	uint y = 31;

   245

	uint i;

   246

   247

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

   248

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

   249

		TextColour colour = TC_BLACK;

   250

		if (sel == 0) {

   251

			selected = &refit[i];

   252

			colour = TC_WHITE;

   253

		}

   254

   255

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

   256

			/* Draw the cargo name */

   257

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

   258

   259

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

   260

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

   261

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

   262

			}

   263

			y += delta;

   264

		}

   265

   266

		sel--;

   267

	}

   268

   269

	return selected;

   270

}

   271

   272

struct RefitWindow : public Window {

   273

	int sel;

   274

	RefitOption *cargo;

   275

	RefitList *list;

   276

	uint length;

   277

	VehicleOrderID order;

   278

   279

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

   280

	{

   281

		this->caption_color = v->owner;

   282

		this->vscroll.cap = 8;

   283

		this->resize.step_height = 14;

   284

   285

		this->order = order;

   286

		this->sel  = -1;

   287

		this->list = BuildRefitList(v);

   288

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

   289

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

   290

   291

		switch (v->type) {

   292

			case VEH_TRAIN:

   293

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

   294

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

   295

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

   296

				break;

   297

   298

			case VEH_ROAD:

   299

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

   300

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

   301

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

   302

				break;

   303

   304

			case VEH_SHIP:

   305

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

   306

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

   307

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

   308

				break;

   309

   310

			case VEH_AIRCRAFT:

   311

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

   312

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

   313

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

   314

				break;

   315

   316

			default: NOT_REACHED();

   317

		}

   318

   319

		this->FindWindowPlacementAndResize(desc);

   320

	}

   321

   322

	~RefitWindow()

   323

	{

   324

		free(this->list->items);

   325

		free(this->list);

   326

	}

   327

   328

	virtual void OnPaint()

   329

	{

   330

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

   331

   332

		if (v->type == VEH_TRAIN) {

   333

			uint length = CountVehiclesInChain(v);

   334

   335

			if (length != this->length) {

   336

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

   337

				free(this->list->items);

   338

				free(this->list);

   339

				this->list = BuildRefitList(v);

   340

				this->length = length;

   341

			}

   342

		}

   343

   344

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

   345

   346

		SetDParam(0, v->index);

   347

		this->DrawWidgets();

   348

   349

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

   350

   351

		if (this->cargo != NULL) {

   352

			CommandCost cost;

   353

   354

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

   355

							 DC_QUERY_COST, GetCmdRefitVeh(v->type));

   356

   357

			if (CmdSucceeded(cost)) {

   358

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

   359

				SetDParam(1, _returned_refit_capacity);

   360

				SetDParam(2, cost.GetCost());

   361

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

   362

			}

   363

		}

   364

	}

   365

   366

	virtual void OnClick(Point pt, int widget)

   367

	{

   368

		switch (widget) {

   369

			case 3: { // listbox

   370

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

   371

				if (y >= 0) {

   372

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

   373

					this->SetDirty();

   374

				}

   375

				break;

   376

			}

   377

   378

			case 6: // refit button

   379

				if (this->cargo != NULL) {

   380

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

   381

   382

					if (this->order == INVALID_VEH_ORDER_ID) {

   383

						int command = 0;

   384

   385

						switch (v->type) {

   386

							default: NOT_REACHED();

   387

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

   388

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

   389

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

   390

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

   391

						}

   392

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

   393

					} else {

   394

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

   395

					}

   396

				}

   397

				break;

   398

		}

   399

	}

   400

   401

	virtual void OnResize(Point new_size, Point delta)

   402

	{

   403

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

   404

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

   405

	}

   406

};

   407

   408

   409

static const Widget _vehicle_refit_widgets[] = {

   410

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

   411

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

   412

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

   413

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

   414

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

   415

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

   416

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

   417

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

   418

	{   WIDGETS_END},

   419

};

   420

   421

static const WindowDesc _vehicle_refit_desc = {

   422

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

   423

	WC_VEHICLE_REFIT, WC_VEHICLE_VIEW,

   424

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS | WDF_RESIZABLE,

   425

	_vehicle_refit_widgets,

   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

	DeleteWindowById(WC_VEHICLE_REFIT, v->index);

   435

	new RefitWindow(&_vehicle_refit_desc, v, order);

   436

}

   437

   438

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

   439

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

   440

{

   441

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

   442

	if (callback == CALLBACK_FAILED) return 0;

   443

   444

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

   445

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

   446

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

   447

}

   448

   449

/** Display list of cargo types of the engine, for the purchase information window */

   450

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

   451

{

   452

	/* List of cargo types of this engine */

   453

	uint32 cmask = EngInfo(engine)->refit_mask;

   454

	/* List of cargo types available in this climate */

   455

	uint32 lmask = _cargo_mask;

   456

	char *b = _userstring;

   457

   458

	/* Draw nothing if the engine is not refittable */

   459

	if (CountBits(cmask) <= 1) return 0;

   460

   461

	b = InlineString(b, STR_PURCHASE_INFO_REFITTABLE_TO);

   462

   463

	if (cmask == lmask) {

   464

		/* Engine can be refitted to all types in this climate */

   465

		b = InlineString(b, STR_PURCHASE_INFO_ALL_TYPES);

   466

	} else {

   467

		/* Check if we are able to refit to more cargo types and unable to. If

   468

		 * so, invert the cargo types to list those that we can't refit to. */

   469

		if (CountBits(cmask ^ lmask) < CountBits(cmask)) {

   470

			cmask ^= lmask;

   471

			b = InlineString(b, STR_PURCHASE_INFO_ALL_BUT);

   472

		}

   473

   474

		bool first = true;

   475

   476

		/* Add each cargo type to the list */

   477

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

   478

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

   479

   480

			if (b >= lastof(_userstring) - (2 + 2 * 4)) break; // ", " and two calls to Utf8Encode()

   481

   482

			if (!first) b = strecpy(b, ", ", lastof(_userstring));

   483

			first = false;