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

struct Sorting {

    58

	Listing aircraft;

    59

	Listing roadveh;

    60

	Listing ship;

    61

	Listing train;

    62

};

    63

    64

static Sorting _sorting;

    65

    66

static bool   _internal_sort_order;     // descending/ascending

    67

    68

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

    69

    70

static VehicleSortListingTypeFunction VehicleNumberSorter;

    71

static VehicleSortListingTypeFunction VehicleNameSorter;

    72

static VehicleSortListingTypeFunction VehicleAgeSorter;

    73

static VehicleSortListingTypeFunction VehicleProfitThisYearSorter;

    74

static VehicleSortListingTypeFunction VehicleProfitLastYearSorter;

    75

static VehicleSortListingTypeFunction VehicleCargoSorter;

    76

static VehicleSortListingTypeFunction VehicleReliabilitySorter;

    77

static VehicleSortListingTypeFunction VehicleMaxSpeedSorter;

    78

static VehicleSortListingTypeFunction VehicleModelSorter;

    79

static VehicleSortListingTypeFunction VehicleValueSorter;

    80

static VehicleSortListingTypeFunction VehicleLengthSorter;

    81

    82

static VehicleSortListingTypeFunction* const _vehicle_sorter[] = {

    83

	&VehicleNumberSorter,

    84

	&VehicleNameSorter,

    85

	&VehicleAgeSorter,

    86

	&VehicleProfitThisYearSorter,

    87

	&VehicleProfitLastYearSorter,

    88

	&VehicleCargoSorter,

    89

	&VehicleReliabilitySorter,

    90

	&VehicleMaxSpeedSorter,

    91

	&VehicleModelSorter,

    92

	&VehicleValueSorter,

    93

	&VehicleLengthSorter,

    94

};

    95

    96

const StringID _vehicle_sort_listing[] = {

    97

	STR_SORT_BY_NUMBER,

    98

	STR_SORT_BY_DROPDOWN_NAME,

    99

	STR_SORT_BY_AGE,

   100

	STR_SORT_BY_PROFIT_THIS_YEAR,

   101

	STR_SORT_BY_PROFIT_LAST_YEAR,

   102

	STR_SORT_BY_TOTAL_CAPACITY_PER_CARGOTYPE,

   103

	STR_SORT_BY_RELIABILITY,

   104

	STR_SORT_BY_MAX_SPEED,

   105

	STR_SORT_BY_MODEL,

   106

	STR_SORT_BY_VALUE,

   107

	STR_SORT_BY_LENGTH,

   108

	INVALID_STRING_ID

   109

};

   110

   111

/**

   112

 * Set sort list flag for all vehicle list windows

   113

 * @param sl_flag Sort list flag to set

   114

 */

   115

static void SetVehicleListsFlag(SortListFlags sl_flag)

   116

{

   117

	Window* const *wz;

   118

   119

	FOR_ALL_WINDOWS(wz) {

   120

		Window *w = *wz;

   121

   122

		switch (w->window_class) {

   123

			case WC_TRAINS_LIST:

   124

			case WC_ROADVEH_LIST:

   125

			case WC_SHIPS_LIST:

   126

			case WC_AIRCRAFT_LIST:

   127

				WP(w, vehiclelist_d).l.flags |= sl_flag;

   128

				w->SetDirty();

   129

				break;

   130

   131

			default: break;

   132

		}

   133

	}

   134

}

   135

   136

/**

   137

 * Rebuild all vehicle list windows

   138

 */

   139

void RebuildVehicleLists()

   140

{

   141

	SetVehicleListsFlag(VL_REBUILD);

   142

}

   143

   144

/**

   145

 * Resort all vehicle list windows

   146

 */

   147

void ResortVehicleLists()

   148

{

   149

	SetVehicleListsFlag(VL_RESORT);

   150

}

   151

   152

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

   153

{

   154

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

   155

   156

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

   157

   158

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

   159

   160

	vl->l.flags &= ~VL_REBUILD;

   161

	vl->l.flags |= VL_RESORT;

   162

}

   163

   164

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

   165

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

   166

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

   167

   168

void SortVehicleList(vehiclelist_d *vl)

   169

{

   170

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

   171

   172

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

   173

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

   174

   175

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

   176

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

   177

		_vehicle_sorter[vl->l.sort_type]);

   178

   179

	vl->l.resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   180

	vl->l.flags &= ~VL_RESORT;

   181

}

   182

   183

void DepotSortList(Vehicle **v, uint16 length)

   184

{

   185

	_internal_sort_order = 0;

   186

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

   187

}

   188

   189

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

   190

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

   191

{

   192

	SpriteID pal;

   193

   194

	/* draw profit-based colored icons */

   195

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

   196

		pal = PALETTE_TO_GREY;

   197

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

   198

		pal = PALETTE_TO_RED;

   199

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

   200

		pal = PALETTE_TO_YELLOW;

   201

	} else {

   202

		pal = PALETTE_TO_GREEN;

   203

	}

   204

	DrawSprite(SPR_BLOT, pal, x, y);

   205

}

   206

   207

struct RefitOption {

   208

	CargoID cargo;

   209

	byte subtype;

   210

	uint16 value;

   211

	EngineID engine;

   212

};

   213

   214

struct RefitList {

   215

	uint num_lines;

   216

	RefitOption *items;

   217

};

   218

   219

static RefitList *BuildRefitList(const Vehicle *v)

   220

{

   221

	uint max_lines = 256;

   222

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

   223

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

   224

	Vehicle *u = (Vehicle*)v;

   225

	uint num_lines = 0;

   226

	uint i;

   227

   228

	do {

   229

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

   230

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

   231

   232

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

   233

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

   234

   235

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

   236

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

   237

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

   238

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

   239

   240

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

   241

			if (HasBit(callbackmask, CBM_VEHICLE_CARGO_SUFFIX)) {

   242

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

   243

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

   244

				CargoID temp_cargo = u->cargo_type;

   245

				byte temp_subtype  = u->cargo_subtype;

   246

				byte refit_cyc;

   247

   248

				u->cargo_type = cid;

   249

   250

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

   251

					bool duplicate = false;

   252

					uint16 callback;

   253

   254

					u->cargo_subtype = refit_cyc;

   255

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

   256

   257

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

   258

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

   259

   260

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

   261

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

   262

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

   263

					}

   264

   265

					if (duplicate) continue;

   266

   267

					refit[num_lines].cargo   = cid;

   268

					refit[num_lines].subtype = refit_cyc;

   269

					refit[num_lines].value   = callback;

   270

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

   271

					num_lines++;

   272

				}

   273

   274

				/* Reset the vehicle's cargo type */

   275

				u->cargo_type    = temp_cargo;

   276

				u->cargo_subtype = temp_subtype;

   277

			} else {

   278

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

   279

				bool duplicate = false;

   280

   281

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

   282

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

   283

				}

   284

   285

				if (!duplicate) {

   286

					refit[num_lines].cargo   = cid;

   287

					refit[num_lines].subtype = 0;

   288

					refit[num_lines].value   = CALLBACK_FAILED;

   289

					refit[num_lines].engine  = INVALID_ENGINE;

   290

					num_lines++;

   291

				}

   292

			}

   293

		}

   294

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

   295

   296

	list->num_lines = num_lines;

   297

	list->items = refit;

   298

   299

	return list;

   300

}

   301

   302

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

   303

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

   304

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

   305

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

   306

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

   307

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

   308

 * @param delta step height in caller window

   309

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

   310

 */

   311

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

   312

{

   313

	RefitOption *refit = list->items;

   314

	RefitOption *selected = NULL;

   315

	uint num_lines = list->num_lines;

   316

	uint y = 31;

   317

	uint i;

   318

   319

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

   320

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

   321

		TextColour colour = TC_BLACK;

   322

		if (sel == 0) {

   323

			selected = &refit[i];

   324

			colour = TC_WHITE;

   325

		}

   326

   327

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

   328

			/* Draw the cargo name */

   329

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

   330

   331

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

   332

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

   333

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

   334

			}

   335

			y += delta;

   336

		}

   337

   338

		sel--;

   339

	}

   340

   341

	return selected;

   342

}

   343

   344

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

   345

{

   346

	switch (e->event) {

   347

		case WE_PAINT: {

   348

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

   349

   350

			if (v->type == VEH_TRAIN) {

   351

				uint length = CountVehiclesInChain(v);

   352

   353

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

   354

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

   355

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

   356

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

   357

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

   358

					WP(w, refit_d).length = length;

   359

				}

   360

			}

   361

   362

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

   363

   364

			SetDParam(0, v->index);

   365

			DrawWindowWidgets(w);

   366

   367

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

   368

   369

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

   370

				CommandCost cost;

   371

   372

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

   373

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

   374

   375

				if (CmdSucceeded(cost)) {

   376

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

   377

					SetDParam(1, _returned_refit_capacity);

   378

					SetDParam(2, cost.GetCost());

   379

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

   380

				}

   381

			}

   382

		} break;

   383

   384

		case WE_CLICK:

   385

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

   386

				case 3: { // listbox

   387

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

   388

					if (y >= 0) {

   389

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

   390

						w->SetDirty();

   391

					}

   392

				} break;

   393

				case 6: // refit button

   394

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

   395

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

   396

   397

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

   398

							int command = 0;

   399

   400

							switch (v->type) {

   401

								default: NOT_REACHED();

   402

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

   403

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

   404

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

   405

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

   406

							}

   407

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

   408

						} else {

   409

							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;

   410

						}

   411

					}

   412

					break;

   413

			}

   414

			break;

   415

   416

		case WE_RESIZE:

   417

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

   418

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

   419

			break;

   420

   421

		case WE_DESTROY:

   422

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

   423

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

   424

			break;

   425

	}

   426

}

   427

   428

   429

static const Widget _vehicle_refit_widgets[] = {

   430

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

   431

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

   432

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

   433

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

   434

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

   435

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

   436

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

   437

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

   438

	{   WIDGETS_END},

   439

};

   440

   441

static const WindowDesc _vehicle_refit_desc = {

   442

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

   443

	WC_VEHICLE_REFIT, WC_VEHICLE_VIEW,

   444

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS | WDF_RESIZABLE,

   445

	_vehicle_refit_widgets,

   446

	VehicleRefitWndProc,

   447

};

   448

   449

/** Show the refit window for a vehicle

   450

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

   451

* @param order of the vehicle ( ? )

   452

*/

   453

void ShowVehicleRefitWindow(const Vehicle *v, VehicleOrderID order)

   454

{

   455

	Window *w;

   456

   457

	DeleteWindowById(WC_VEHICLE_REFIT, v->index);

   458

   459

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

   460

	WP(w, refit_d).order = order;

   461

   462

	if (w != NULL) {

   463

		w->caption_color = v->owner;

   464

		w->vscroll.cap = 8;

   465

		w->resize.step_height = 14;

   466

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

   467

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

   468

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

   469

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

   470

   471

		switch (v->type) {

   472

			case VEH_TRAIN:

   473

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

   474

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

   475

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

   476

				break;

   477

			case VEH_ROAD:

   478

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

   479

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

   480

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

   481

				break;

   482