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

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

    90

{

    91

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

    92

    93

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

    94

    95

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

    96

    97

	vl->vehicles.flags &= ~VL_REBUILD;

    98

	vl->vehicles.flags |= VL_RESORT;

    99

}

   100

   101

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

   102

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

   103

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

   104

   105

void SortVehicleList(VehicleListBase *vl)

   106

{

   107

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

   108

   109

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

   110

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

   111

   112

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

   113

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

   114

		_vehicle_sorter[vl->vehicles.sort_type]);

   115

   116

	vl->vehicles.resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   117

	vl->vehicles.flags &= ~VL_RESORT;

   118

}

   119

   120

void DepotSortList(Vehicle **v, uint16 length)

   121

{

   122

	_internal_sort_order = 0;

   123

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

   124

}

   125

   126

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

   127

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

   128

{

   129

	SpriteID pal;

   130

   131

	/* draw profit-based colored icons */

   132

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

   133

		pal = PALETTE_TO_GREY;

   134

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

   135

		pal = PALETTE_TO_RED;

   136

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

   137

		pal = PALETTE_TO_YELLOW;

   138

	} else {

   139

		pal = PALETTE_TO_GREEN;

   140

	}

   141

	DrawSprite(SPR_BLOT, pal, x, y);

   142

}

   143

   144

struct RefitOption {

   145

	CargoID cargo;

   146

	byte subtype;

   147

	uint16 value;

   148

	EngineID engine;

   149

};

   150

   151

struct RefitList {

   152

	uint num_lines;

   153

	RefitOption *items;

   154

};

   155

   156

static RefitList *BuildRefitList(const Vehicle *v)

   157

{

   158

	uint max_lines = 256;

   159

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

   160

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

   161

	Vehicle *u = (Vehicle*)v;

   162

	uint num_lines = 0;

   163

	uint i;

   164

   165

	do {

   166

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

   167

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

   168

   169

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

   170

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

   171

   172

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

   173

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

   174

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

   175

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

   176

   177

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

   178

			if (HasBit(callbackmask, CBM_VEHICLE_CARGO_SUFFIX)) {

   179

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

   180

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

   181

				CargoID temp_cargo = u->cargo_type;

   182

				byte temp_subtype  = u->cargo_subtype;

   183

				byte refit_cyc;

   184

   185

				u->cargo_type = cid;

   186

   187

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

   188

					bool duplicate = false;

   189

					uint16 callback;

   190

   191

					u->cargo_subtype = refit_cyc;

   192

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

   193

   194

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

   195

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

   196

   197

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

   198

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

   199

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

   200

					}

   201

   202

					if (duplicate) continue;

   203

   204

					refit[num_lines].cargo   = cid;

   205

					refit[num_lines].subtype = refit_cyc;

   206

					refit[num_lines].value   = callback;

   207

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

   208

					num_lines++;

   209

				}

   210

   211

				/* Reset the vehicle's cargo type */

   212

				u->cargo_type    = temp_cargo;

   213

				u->cargo_subtype = temp_subtype;

   214

			} else {

   215

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

   216

				bool duplicate = false;

   217

   218

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

   219

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

   220

				}

   221

   222

				if (!duplicate) {

   223

					refit[num_lines].cargo   = cid;

   224

					refit[num_lines].subtype = 0;

   225

					refit[num_lines].value   = CALLBACK_FAILED;

   226

					refit[num_lines].engine  = INVALID_ENGINE;

   227

					num_lines++;

   228

				}

   229

			}

   230

		}

   231

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

   232

   233

	list->num_lines = num_lines;

   234

	list->items = refit;

   235

   236

	return list;

   237

}

   238

   239

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

   240

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

   241

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

   242

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

   243

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

   244

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

   245

 * @param delta step height in caller window

   246

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

   247

 */

   248

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

   249

{

   250

	RefitOption *refit = list->items;

   251

	RefitOption *selected = NULL;

   252

	uint num_lines = list->num_lines;

   253

	uint y = 31;

   254

	uint i;

   255

   256

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

   257

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

   258

		TextColour colour = TC_BLACK;

   259

		if (sel == 0) {

   260

			selected = &refit[i];

   261

			colour = TC_WHITE;

   262

		}

   263

   264

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

   265

			/* Draw the cargo name */

   266

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

   267

   268

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

   269

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

   270

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

   271

			}

   272

			y += delta;

   273

		}

   274

   275

		sel--;

   276

	}

   277

   278

	return selected;

   279

}

   280

   281

struct RefitWindow : public Window {

   282

	int sel;

   283

	RefitOption *cargo;

   284

	RefitList *list;

   285

	uint length;

   286

	VehicleOrderID order;

   287

   288

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

   289

	{

   290

		this->caption_color = v->owner;

   291

		this->vscroll.cap = 8;

   292

		this->resize.step_height = 14;

   293

   294

		this->order = order;

   295

		this->sel  = -1;

   296

		this->list = BuildRefitList(v);

   297

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

   298

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

   299

   300

		switch (v->type) {

   301

			case VEH_TRAIN:

   302

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

   303

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

   304

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

   305

				break;

   306

   307

			case VEH_ROAD:

   308

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

   309

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

   310

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

   311

				break;

   312

   313

			case VEH_SHIP:

   314

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

   315

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

   316

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

   317

				break;

   318

   319

			case VEH_AIRCRAFT:

   320

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

   321

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

   322

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

   323

				break;

   324

   325

			default: NOT_REACHED();

   326

		}

   327

   328

		this->FindWindowPlacementAndResize(desc);

   329

	}

   330

   331

	~RefitWindow()

   332

	{

   333

		free(this->list->items);

   334

		free(this->list);

   335

	}

   336

   337

	virtual void OnPaint()

   338

	{

   339

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

   340

   341

		if (v->type == VEH_TRAIN) {

   342

			uint length = CountVehiclesInChain(v);

   343

   344

			if (length != this->length) {

   345

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

   346

				free(this->list->items);

   347

				free(this->list);

   348

				this->list = BuildRefitList(v);

   349

				this->length = length;

   350

			}

   351

		}

   352

   353

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

   354

   355

		SetDParam(0, v->index);

   356

		this->DrawWidgets();

   357

   358

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

   359

   360

		if (this->cargo != NULL) {

   361

			CommandCost cost;

   362

   363

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

   364

							 DC_QUERY_COST, GetCmdRefitVeh(v->type));

   365

   366

			if (CmdSucceeded(cost)) {

   367

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

   368

				SetDParam(1, _returned_refit_capacity);

   369

				SetDParam(2, cost.GetCost());

   370

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

   371

			}

   372

		}

   373

	}

   374

   375

	virtual void OnClick(Point pt, int widget)

   376

	{

   377

		switch (widget) {

   378

			case 3: { // listbox

   379

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

   380

				if (y >= 0) {

   381

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

   382

					this->SetDirty();

   383

				}

   384

				break;

   385

			}

   386

   387

			case 6: // refit button

   388

				if (this->cargo != NULL) {

   389

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

   390

   391

					if (this->order == INVALID_VEH_ORDER_ID) {

   392

						int command = 0;

   393

   394

						switch (v->type) {

   395

							default: NOT_REACHED();

   396

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

   397

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

   398

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

   399

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

   400

						}

   401

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

   402

					} else {

   403

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

   404

					}

   405

				}

   406

				break;

   407

		}

   408

	}

   409

   410

	virtual void OnResize(Point new_size, Point delta)

   411

	{

   412

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

   413

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

   414

	}

   415

};

   416

   417

   418

static const Widget _vehicle_refit_widgets[] = {

   419

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

   420

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

   421

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

   422

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

   423

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

   424

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

   425

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

   426

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

   427

	{   WIDGETS_END},

   428

};

   429

   430

static const WindowDesc _vehicle_refit_desc = {

   431

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

   432

	WC_VEHICLE_REFIT, WC_VEHICLE_VIEW,

   433

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS | WDF_RESIZABLE,

   434

	_vehicle_refit_widgets,

   435

	NULL

   436

};

   437

   438

/** Show the refit window for a vehicle

   439

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

   440

* @param order of the vehicle ( ? )

   441

*/

   442

void ShowVehicleRefitWindow(const Vehicle *v, VehicleOrderID order)

   443

{

   444

	DeleteWindowById(WC_VEHICLE_REFIT, v->index);

   445

	new RefitWindow(&_vehicle_refit_desc, v, order);

   446

}

   447

   448

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

   449

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

   450

{

   451

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

   452

	if (callback == CALLBACK_FAILED) return 0;

   453

   454

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

   455

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

   456

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

   457

}

   458

   459

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

   460

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

   461

{

   462

	/* List of cargo types of this engine */

   463

	uint32 cmask = EngInfo(engine)->refit_mask;

   464

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

   465

	uint32 lmask = _cargo_mask;

   466

	char *b = _userstring;

   467

   468

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

   469

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

   470

   471

	b = InlineString(b, STR_PURCHASE_INFO_REFITTABLE_TO);

   472

   473

	if (cmask == lmask) {

   474

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

   475

		b = InlineString(b, STR_PURCHASE_INFO_ALL_TYPES);

   476

	} else {

   477

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

   478

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

   479

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

   480

			cmask ^= lmask;

   481

			b = InlineString(b, STR_PURCHASE_INFO_ALL_BUT);

   482

		}

   483

   484

		bool first = true;