1

/* $Id$ */

     2

     3

/** @file vehicle_gui.cpp */

     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

    39

#include "table/sprites.h"

    40

#include "table/strings.h"

    41

    42

struct refit_d {

    43

	int sel;

    44

	struct RefitOption *cargo;

    45

	struct RefitList *list;

    46

	uint length;

    47

	VehicleOrderID order;

    48

};

    49

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(refit_d));

    50

    51

struct Sorting {

    52

	Listing aircraft;

    53

	Listing roadveh;

    54

	Listing ship;

    55

	Listing train;

    56

};

    57

    58

static Sorting _sorting;

    59

    60

static bool   _internal_sort_order;     // descending/ascending

    61

    62

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

    63

    64

static VehicleSortListingTypeFunction VehicleNumberSorter;

    65

static VehicleSortListingTypeFunction VehicleNameSorter;

    66

static VehicleSortListingTypeFunction VehicleAgeSorter;

    67

static VehicleSortListingTypeFunction VehicleProfitThisYearSorter;

    68

static VehicleSortListingTypeFunction VehicleProfitLastYearSorter;

    69

static VehicleSortListingTypeFunction VehicleCargoSorter;

    70

static VehicleSortListingTypeFunction VehicleReliabilitySorter;

    71

static VehicleSortListingTypeFunction VehicleMaxSpeedSorter;

    72

static VehicleSortListingTypeFunction VehicleModelSorter;

    73

static VehicleSortListingTypeFunction VehicleValueSorter;

    74

static VehicleSortListingTypeFunction VehicleLengthSorter;

    75

    76

static VehicleSortListingTypeFunction* const _vehicle_sorter[] = {

    77

	&VehicleNumberSorter,

    78

	&VehicleNameSorter,

    79

	&VehicleAgeSorter,

    80

	&VehicleProfitThisYearSorter,

    81

	&VehicleProfitLastYearSorter,

    82

	&VehicleCargoSorter,

    83

	&VehicleReliabilitySorter,

    84

	&VehicleMaxSpeedSorter,

    85

	&VehicleModelSorter,

    86

	&VehicleValueSorter,

    87

	&VehicleLengthSorter,

    88

};

    89

    90

const StringID _vehicle_sort_listing[] = {

    91

	STR_SORT_BY_NUMBER,

    92

	STR_SORT_BY_DROPDOWN_NAME,

    93

	STR_SORT_BY_AGE,

    94

	STR_SORT_BY_PROFIT_THIS_YEAR,

    95

	STR_SORT_BY_PROFIT_LAST_YEAR,

    96

	STR_SORT_BY_TOTAL_CAPACITY_PER_CARGOTYPE,

    97

	STR_SORT_BY_RELIABILITY,

    98

	STR_SORT_BY_MAX_SPEED,

    99

	STR_SORT_BY_MODEL,

   100

	STR_SORT_BY_VALUE,

   101

	STR_SORT_BY_LENGTH,

   102

	INVALID_STRING_ID

   103

};

   104

   105

/**

   106

 * Set sort list flag for all vehicle list windows

   107

 * @param sl_flag Sort list flag to set

   108

 */

   109

static void SetVehicleListsFlag(SortListFlags sl_flag)

   110

{

   111

	Window* const *wz;

   112

   113

	FOR_ALL_WINDOWS(wz) {

   114

		Window *w = *wz;

   115

   116

		switch (w->window_class) {

   117

			case WC_TRAINS_LIST:

   118

			case WC_ROADVEH_LIST:

   119

			case WC_SHIPS_LIST:

   120

			case WC_AIRCRAFT_LIST:

   121

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

   122

				SetWindowDirty(w);

   123

				break;

   124

   125

			default: break;

   126

		}

   127

	}

   128

}

   129

   130

/**

   131

 * Rebuild all vehicle list windows

   132

 */

   133

void RebuildVehicleLists()

   134

{

   135

	SetVehicleListsFlag(VL_REBUILD);

   136

}

   137

   138

/**

   139

 * Resort all vehicle list windows

   140

 */

   141

void ResortVehicleLists()

   142

{

   143

	SetVehicleListsFlag(VL_RESORT);

   144

}

   145

   146

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

   147

{

   148

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

   149

   150

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

   151

   152

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

   153

   154

	vl->l.flags &= ~VL_REBUILD;

   155

	vl->l.flags |= VL_RESORT;

   156

}

   157

   158

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

   159

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

   160

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

   161

   162

void SortVehicleList(vehiclelist_d *vl)

   163

{

   164

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

   165

   166

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

   167

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

   168

   169

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

   170

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

   171

		_vehicle_sorter[vl->l.sort_type]);

   172

   173

	vl->l.resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   174

	vl->l.flags &= ~VL_RESORT;

   175

}

   176

   177

void DepotSortList(Vehicle **v, uint16 length)

   178

{

   179

	_internal_sort_order = 0;

   180

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

   181

}

   182

   183

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

   184

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

   185

{

   186

	SpriteID pal;

   187

   188

	/* draw profit-based colored icons */

   189

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

   190

		pal = PALETTE_TO_GREY;

   191

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

   192

		pal = PALETTE_TO_RED;

   193

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

   194

		pal = PALETTE_TO_YELLOW;

   195

	} else {

   196

		pal = PALETTE_TO_GREEN;

   197

	}

   198

	DrawSprite(SPR_BLOT, pal, x, y);

   199

}

   200

   201

struct RefitOption {

   202

	CargoID cargo;

   203

	byte subtype;

   204

	uint16 value;

   205

	EngineID engine;

   206

};

   207

   208

struct RefitList {

   209

	uint num_lines;

   210

	RefitOption *items;

   211

};

   212

   213

static RefitList *BuildRefitList(const Vehicle *v)

   214

{

   215

	uint max_lines = 256;

   216

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

   217

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

   218

	Vehicle *u = (Vehicle*)v;

   219

	uint num_lines = 0;

   220

	uint i;

   221

   222

	do {

   223

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

   224

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

   225

   226

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

   227

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

   228

   229

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

   230

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

   231

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

   232

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

   233

   234

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

   235

			if (HasBit(callbackmask, CBM_VEHICLE_CARGO_SUFFIX)) {

   236

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

   237

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

   238

				CargoID temp_cargo = u->cargo_type;

   239

				byte temp_subtype  = u->cargo_subtype;

   240

				byte refit_cyc;

   241

   242

				u->cargo_type = cid;

   243

   244

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

   245

					bool duplicate = false;

   246

					uint16 callback;

   247

   248

					u->cargo_subtype = refit_cyc;

   249

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

   250

   251

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

   252

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

   253

   254

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

   255

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

   256

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

   257

					}

   258

   259

					if (duplicate) continue;

   260

   261

					refit[num_lines].cargo   = cid;

   262

					refit[num_lines].subtype = refit_cyc;

   263

					refit[num_lines].value   = callback;

   264

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

   265

					num_lines++;

   266

				}

   267

   268

				/* Reset the vehicle's cargo type */

   269

				u->cargo_type    = temp_cargo;

   270

				u->cargo_subtype = temp_subtype;

   271

			} else {

   272

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

   273

				bool duplicate = false;

   274

   275

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

   276

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

   277

				}

   278

   279

				if (!duplicate) {

   280

					refit[num_lines].cargo   = cid;

   281

					refit[num_lines].subtype = 0;

   282

					refit[num_lines].value   = CALLBACK_FAILED;

   283

					refit[num_lines].engine  = INVALID_ENGINE;

   284

					num_lines++;

   285

				}

   286

			}

   287

		}

   288

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

   289

   290

	list->num_lines = num_lines;

   291

	list->items = refit;

   292

   293

	return list;

   294

}

   295

   296

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

   297

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

   298

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

   299

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

   300

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

   301

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

   302

 * @param delta step height in caller window

   303

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

   304

 */

   305

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

   306

{

   307

	RefitOption *refit = list->items;

   308

	RefitOption *selected = NULL;

   309

	uint num_lines = list->num_lines;

   310

	uint y = 31;

   311

	uint i;

   312

   313

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

   314

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

   315

		TextColour colour = TC_BLACK;

   316

		if (sel == 0) {

   317

			selected = &refit[i];

   318

			colour = TC_WHITE;

   319

		}

   320

   321

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

   322

			/* Draw the cargo name */

   323

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

   324

   325

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

   326

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

   327

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

   328

			}

   329

			y += delta;

   330

		}

   331

   332

		sel--;

   333

	}

   334

   335

	return selected;

   336

}

   337

   338

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

   339

{

   340

	switch (e->event) {

   341

		case WE_PAINT: {

   342

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

   343

   344

			if (v->type == VEH_TRAIN) {

   345

				uint length = CountVehiclesInChain(v);

   346

   347

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

   348

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

   349

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

   350

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

   351

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

   352

					WP(w, refit_d).length = length;

   353

				}

   354

			}

   355

   356

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

   357

   358

			SetDParam(0, v->index);

   359

			DrawWindowWidgets(w);

   360

   361

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

   362

   363

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

   364

				CommandCost cost;

   365

   366

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

   367

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

   368

   369

				if (CmdSucceeded(cost)) {

   370

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

   371

					SetDParam(1, _returned_refit_capacity);

   372

					SetDParam(2, cost.GetCost());

   373

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

   374

				}

   375

			}

   376

		} break;

   377

   378

		case WE_CLICK:

   379

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

   380

				case 3: { // listbox

   381

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

   382

					if (y >= 0) {

   383

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

   384

						SetWindowDirty(w);

   385

					}

   386

				} break;

   387

				case 6: // refit button

   388

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

   389

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

   390

   391

						if (WP(w, refit_d).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, WP(w, refit_d).cargo->cargo | WP(w, refit_d).cargo->subtype << 8, NULL, command)) DeleteWindow(w);

   402

						} else {

   403

							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)) DeleteWindow(w);

   404

						}

   405

					}

   406

					break;

   407

			}

   408

			break;

   409

   410

		case WE_RESIZE:

   411

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

   412

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

   413

			break;

   414

   415

		case WE_DESTROY:

   416

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

   417

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

   418

			break;

   419

	}

   420

}

   421

   422

   423

static const Widget _vehicle_refit_widgets[] = {

   424

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

   425

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

   426

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

   427

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

   428

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

   429

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

   430

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

   431

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

   432

	{   WIDGETS_END},

   433

};

   434

   435

static const WindowDesc _vehicle_refit_desc = {

   436

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

   437

	WC_VEHICLE_REFIT, WC_VEHICLE_VIEW,

   438

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS | WDF_RESIZABLE,

   439

	_vehicle_refit_widgets,

   440

	VehicleRefitWndProc,

   441

};

   442

   443

/** Show the refit window for a vehicle

   444

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

   445

* @param order of the vehicle ( ? )

   446

*/

   447

void ShowVehicleRefitWindow(const Vehicle *v, VehicleOrderID order)

   448

{

   449

	Window *w;

   450

   451

	DeleteWindowById(WC_VEHICLE_REFIT, v->index);

   452

   453

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

   454

	WP(w, refit_d).order = order;

   455

   456

	if (w != NULL) {

   457

		w->caption_color = v->owner;

   458

		w->vscroll.cap = 8;

   459

		w->resize.step_height = 14;

   460

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

   461

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

   462

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

   463

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

   464

   465

		switch (v->type) {

   466

			case VEH_TRAIN:

   467

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

   468

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

   469

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

   470

				break;

   471

			case VEH_ROAD:

   472

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

   473

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

   474

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

   475

				break;

   476

			case VEH_SHIP:

   477

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

   478

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

   479

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

   480

				break;

   481

			case VEH_AIRCRAFT:

   482