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"

    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

    49

    50

static VehicleSortListingTypeFunction VehicleNumberSorter;

    51

static VehicleSortListingTypeFunction VehicleNameSorter;

    52

static VehicleSortListingTypeFunction VehicleAgeSorter;

    53

static VehicleSortListingTypeFunction VehicleProfitThisYearSorter;

    54

static VehicleSortListingTypeFunction VehicleProfitLastYearSorter;

    55

static VehicleSortListingTypeFunction VehicleCargoSorter;

    56

static VehicleSortListingTypeFunction VehicleReliabilitySorter;

    57

static VehicleSortListingTypeFunction VehicleMaxSpeedSorter;

    58

static VehicleSortListingTypeFunction VehicleModelSorter;

    59

static VehicleSortListingTypeFunction VehicleValueSorter;

    60

static VehicleSortListingTypeFunction VehicleLengthSorter;

    61

    62

static VehicleSortListingTypeFunction* const _vehicle_sorter[] = {

    63

	&VehicleNumberSorter,

    64

	&VehicleNameSorter,

    65

	&VehicleAgeSorter,

    66

	&VehicleProfitThisYearSorter,

    67

	&VehicleProfitLastYearSorter,

    68

	&VehicleCargoSorter,

    69

	&VehicleReliabilitySorter,

    70

	&VehicleMaxSpeedSorter,

    71

	&VehicleModelSorter,

    72

	&VehicleValueSorter,

    73

	&VehicleLengthSorter,

    74

};

    75

    76

const StringID _vehicle_sort_listing[] = {

    77

	STR_SORT_BY_NUMBER,

    78

	STR_SORT_BY_DROPDOWN_NAME,

    79

	STR_SORT_BY_AGE,

    80

	STR_SORT_BY_PROFIT_THIS_YEAR,

    81

	STR_SORT_BY_PROFIT_LAST_YEAR,

    82

	STR_SORT_BY_TOTAL_CAPACITY_PER_CARGOTYPE,

    83

	STR_SORT_BY_RELIABILITY,

    84

	STR_SORT_BY_MAX_SPEED,

    85

	STR_SORT_BY_MODEL,

    86

	STR_SORT_BY_VALUE,

    87

	STR_SORT_BY_LENGTH,

    88

	INVALID_STRING_ID

    89

};

    90

    91

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

    92

{

    94

    95

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

    96

    97

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

    98

   100

}

   101

   102

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

   103

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

   104

   105

void SortVehicleList(VehicleListBase *vl)

   106

{

   108

   109

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

   110

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

   111

}

   112

   113

void DepotSortList(VehicleList *list)

   114

{

   115

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

   117

}

   118

   119

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

   120

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

   121

{

   122

	SpriteID pal;

   123

   124

	/* draw profit-based colored icons */

   125

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

   126

		pal = PALETTE_TO_GREY;

   127

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

   128

		pal = PALETTE_TO_RED;

   129

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

   130

		pal = PALETTE_TO_YELLOW;

   131

	} else {

   132

		pal = PALETTE_TO_GREEN;

   133

	}

   134

	DrawSprite(SPR_BLOT, pal, x, y);

   135

}

   136

   137

struct RefitOption {

   138

	CargoID cargo;

   139

	byte subtype;

   140

	uint16 value;

   141

	EngineID engine;

   142

};

   143

   144

struct RefitList {

   145

	uint num_lines;

   146

	RefitOption *items;

   147

};

   148

   149

static RefitList *BuildRefitList(const Vehicle *v)

   150

{

   151

	uint max_lines = 256;

   152

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

   153

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

   154

	Vehicle *u = (Vehicle*)v;

   155

	uint num_lines = 0;

   156

	uint i;

   157

   158

	do {

   159

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

   160

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

   161

   162

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

   163

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

   164

   165

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

   166

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

   167

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

   168

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

   169

   170

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

   171

			if (HasBit(callbackmask, CBM_VEHICLE_CARGO_SUFFIX)) {

   172

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

   173

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

   174

				CargoID temp_cargo = u->cargo_type;

   175

				byte temp_subtype  = u->cargo_subtype;

   176

				byte refit_cyc;

   177

   178

				u->cargo_type = cid;

   179

   180

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

   181

					bool duplicate = false;

   182

					uint16 callback;

   183

   184

					u->cargo_subtype = refit_cyc;

   185

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

   186

   187

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

   188

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

   189

   190

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

   191

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

   192

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

   193

					}

   194

   195

					if (duplicate) continue;

   196

   197

					refit[num_lines].cargo   = cid;

   198

					refit[num_lines].subtype = refit_cyc;

   199

					refit[num_lines].value   = callback;

   200

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

   201

					num_lines++;

   202

				}

   203

   204

				/* Reset the vehicle's cargo type */

   205

				u->cargo_type    = temp_cargo;

   206

				u->cargo_subtype = temp_subtype;

   207

			} else {

   208

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

   209

				bool duplicate = false;

   210

   211

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

   212

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

   213

				}

   214

   215

				if (!duplicate) {

   216

					refit[num_lines].cargo   = cid;

   217

					refit[num_lines].subtype = 0;

   218

					refit[num_lines].value   = CALLBACK_FAILED;

   219

					refit[num_lines].engine  = INVALID_ENGINE;

   220

					num_lines++;

   221

				}

   222

			}

   223

		}

   224

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

   225

   226

	list->num_lines = num_lines;

   227

	list->items = refit;

   228

   229

	return list;

   230

}

   231

   232

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

   233

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

   234

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

   235

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

   236

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

   237

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

   238

 * @param delta step height in caller window

   239

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

   240

 */

   241

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

   242

{

   243

	RefitOption *refit = list->items;

   244

	RefitOption *selected = NULL;

   245

	uint num_lines = list->num_lines;

   246

	uint y = 31;

   247

	uint i;

   248

   249

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

   250

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

   251

		TextColour colour = TC_BLACK;

   252

		if (sel == 0) {

   253

			selected = &refit[i];

   254

			colour = TC_WHITE;

   255

		}

   256

   257

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

   258

			/* Draw the cargo name */

   259

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

   260

   261

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

   262

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

   263

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

   264

			}

   265

			y += delta;

   266

		}

   267

   268

		sel--;

   269

	}

   270

   271

	return selected;

   272

}

   273

   274

struct RefitWindow : public Window {

   275

	int sel;

   276

	RefitOption *cargo;

   277

	RefitList *list;

   278

	uint length;

   279

	VehicleOrderID order;

   280

   281

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

   282

	{

   283

		this->caption_color = v->owner;

   284

		this->vscroll.cap = 8;

   285

		this->resize.step_height = 14;

   286

   287

		this->order = order;

   288

		this->sel  = -1;

   289

		this->list = BuildRefitList(v);

   290

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

   291

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

   292

   293

		switch (v->type) {

   294

			case VEH_TRAIN:

   295

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

   296

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

   297

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

   298

				break;

   299

   300

			case VEH_ROAD:

   301

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

   302

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

   303

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

   304

				break;

   305

   306

			case VEH_SHIP:

   307

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

   308

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

   309

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

   310

				break;

   311

   312

			case VEH_AIRCRAFT:

   313

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

   314

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

   315

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

   316

				break;

   317

   318

			default: NOT_REACHED();

   319

		}

   320

   321

		this->FindWindowPlacementAndResize(desc);

   322

	}

   323

   324

	~RefitWindow()

   325

	{

   326

		free(this->list->items);

   327

		free(this->list);

   328

	}

   329

   330

	virtual void OnPaint()

   331

	{

   332

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

   333

   334

		if (v->type == VEH_TRAIN) {

   335

			uint length = CountVehiclesInChain(v);

   336

   337

			if (length != this->length) {

   338

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

   339

				free(this->list->items);

   340

				free(this->list);

   341

				this->list = BuildRefitList(v);

   342

				this->length = length;

   343

			}

   344

		}

   345

   346

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

   347

   348

		SetDParam(0, v->index);

   349

		this->DrawWidgets();

   350

   351

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

   352

   353

		if (this->cargo != NULL) {

   354

			CommandCost cost;

   355

   356

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

   357

							 DC_QUERY_COST, GetCmdRefitVeh(v->type));

   358

   359

			if (CmdSucceeded(cost)) {

   360

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

   361

				SetDParam(1, _returned_refit_capacity);

   362

				SetDParam(2, cost.GetCost());

   363

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

   364

			}

   365

		}

   366

	}

   367

   368

	virtual void OnClick(Point pt, int widget)

   369

	{

   370

		switch (widget) {

   371

			case 3: { // listbox

   372

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

   373

				if (y >= 0) {

   374

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

   375

					this->SetDirty();

   376

				}

   377

				break;

   378

			}

   379

   380

			case 6: // refit button

   381

				if (this->cargo != NULL) {

   382

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

   383

   384

					if (this->order == INVALID_VEH_ORDER_ID) {

   385

						int command = 0;

   386

   387

						switch (v->type) {

   388

							default: NOT_REACHED();

   389

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

   390

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

   391

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

   392

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

   393

						}

   394

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

   395

					} else {

   396

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

   397

					}

   398

				}

   399

				break;

   400

		}

   401

	}

   402

   403

	virtual void OnResize(Point new_size, Point delta)

   404

	{

   405

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

   406

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

   407

	}

   408

};

   409

   410

   411

static const Widget _vehicle_refit_widgets[] = {

   412

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

   413

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

   414

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

   415

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

   416

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

   417

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

   418

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

   419

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

   420

	{   WIDGETS_END},

   421

};

   422

   423

static const WindowDesc _vehicle_refit_desc = {

   424

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

   425

	WC_VEHICLE_REFIT, WC_VEHICLE_VIEW,

   426

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS | WDF_RESIZABLE,

   427

	_vehicle_refit_widgets,

   428

};

   429

   430

/** Show the refit window for a vehicle

   431

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

   432

* @param order of the vehicle ( ? )

   433

*/

   434

void ShowVehicleRefitWindow(const Vehicle *v, VehicleOrderID order)

   435

{

   436

	DeleteWindowById(WC_VEHICLE_REFIT, v->index);

   437

	new RefitWindow(&_vehicle_refit_desc, v, order);

   438

}

   439

   440

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

   441

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

   442

{

   443

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

   444

	if (callback == CALLBACK_FAILED) return 0;

   445

   446

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

   447

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

   448

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

   449

}

   450

   451

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

   452

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

   453

{

   454

	/* List of cargo types of this engine */

   455

	uint32 cmask = EngInfo(engine)->refit_mask;

   456

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

   457

	uint32 lmask = _cargo_mask;

   458

	char *b = _userstring;

   459

   460

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

   461

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

   462

   463

	b = InlineString(b, STR_PURCHASE_INFO_REFITTABLE_TO);

   464

   465

	if (cmask == lmask) {

   466

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

   467

		b = InlineString(b, STR_PURCHASE_INFO_ALL_TYPES);

   468

	} else {

   469

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

   470

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

   471

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

   472

			cmask ^= lmask;

   473

			b = InlineString(b, STR_PURCHASE_INFO_ALL_BUT);

   474

		}

   475

   476

		bool first = true;

   477

   478

		/* Add each cargo type to the list */

   479

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

   480

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

   481

   482

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

   483

   484

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