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 "station.h"

    10

#include "engine.h"

    11

#include "gui.h"

    12

#include "window_gui.h"

    13

#include "textbuf_gui.h"

    14

#include "command_func.h"

    15

#include "variables.h"

    16

#include "vehicle_gui.h"

    17

#include "viewport_func.h"

    18

#include "gfx_func.h"

    19

#include "train.h"

    20

#include "newgrf_callbacks.h"

    21

#include "newgrf_engine.h"

    22

#include "newgrf_text.h"

    23

#include "ship.h"

    24

#include "aircraft.h"

    25

#include "roadveh.h"

    26

#include "depot.h"

    27

#include "cargotype.h"

    28

#include "group.h"

    29

#include "group_gui.h"

    30

#include "strings_func.h"

    31

#include "functions.h"

    32

#include "window_func.h"

    33

#include "vehicle_func.h"

    34

#include "autoreplace_gui.h"

    35

#include "core/alloc_func.hpp"

    36

#include "string_func.h"

    37

#include "settings_type.h"

    38

#include "widgets/dropdown_func.h"

    39

    40

#include "table/sprites.h"

    41

#include "table/strings.h"

    42

    43

struct Sorting {

    44

	Listing aircraft;

    45

	Listing roadveh;

    46

	Listing ship;

    47

	Listing train;

    48

};

    49

    50

static Sorting _sorting;

    51

    52

static bool   _internal_sort_order;     // descending/ascending

    53

    54

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

    55

    56

static VehicleSortListingTypeFunction VehicleNumberSorter;

    57

static VehicleSortListingTypeFunction VehicleNameSorter;

    58

static VehicleSortListingTypeFunction VehicleAgeSorter;

    59

static VehicleSortListingTypeFunction VehicleProfitThisYearSorter;

    60

static VehicleSortListingTypeFunction VehicleProfitLastYearSorter;

    61

static VehicleSortListingTypeFunction VehicleCargoSorter;

    62

static VehicleSortListingTypeFunction VehicleReliabilitySorter;

    63

static VehicleSortListingTypeFunction VehicleMaxSpeedSorter;

    64

static VehicleSortListingTypeFunction VehicleModelSorter;

    65

static VehicleSortListingTypeFunction VehicleValueSorter;

    66

    67

static VehicleSortListingTypeFunction* const _vehicle_sorter[] = {

    68

	&VehicleNumberSorter,

    69

	&VehicleNameSorter,

    70

	&VehicleAgeSorter,

    71

	&VehicleProfitThisYearSorter,

    72

	&VehicleProfitLastYearSorter,

    73

	&VehicleCargoSorter,

    74

	&VehicleReliabilitySorter,

    75

	&VehicleMaxSpeedSorter,

    76

	&VehicleModelSorter,

    77

	&VehicleValueSorter,

    78

};

    79

    80

const StringID _vehicle_sort_listing[] = {

    81

	STR_SORT_BY_NUMBER,

    82

	STR_SORT_BY_DROPDOWN_NAME,

    83

	STR_SORT_BY_AGE,

    84

	STR_SORT_BY_PROFIT_THIS_YEAR,

    85

	STR_SORT_BY_PROFIT_LAST_YEAR,

    86

	STR_SORT_BY_TOTAL_CAPACITY_PER_CARGOTYPE,

    87

	STR_SORT_BY_RELIABILITY,

    88

	STR_SORT_BY_MAX_SPEED,

    89

	STR_SORT_BY_MODEL,

    90

	STR_SORT_BY_VALUE,

    91

	INVALID_STRING_ID

    92

};

    93

    94

void RebuildVehicleLists()

    95

{

    96

	Window* const *wz;

    97

    98

	FOR_ALL_WINDOWS(wz) {

    99

		Window *w = *wz;

   100

   101

		switch (w->window_class) {

   102

			case WC_TRAINS_LIST:

   103

			case WC_ROADVEH_LIST:

   104

			case WC_SHIPS_LIST:

   105

			case WC_AIRCRAFT_LIST:

   106

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

   107

				SetWindowDirty(w);

   108

				break;

   109

   110

			default: break;

   111

		}

   112

	}

   113

}

   114

   115

void ResortVehicleLists()

   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 |= VL_RESORT;

   128

				SetWindowDirty(w);

   129

				break;

   130

   131

			default: break;

   132

		}

   133

	}

   134

}

   135

   136

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

   137

{

   138

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

   139

   140

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

   141

   142

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

   143

   144

	vl->l.flags &= ~VL_REBUILD;

   145

	vl->l.flags |= VL_RESORT;

   146

}

   147

   148

void SortVehicleList(vehiclelist_d *vl)

   149

{

   150

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

   151

   152

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

   153

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

   154

		_vehicle_sorter[vl->l.sort_type]);

   155

   156

	vl->l.resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   157

	vl->l.flags &= ~VL_RESORT;

   158

}

   159

   160

void DepotSortList(Vehicle **v, uint16 length)

   161

{

   162

	_internal_sort_order = 0;

   163

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

   164

}

   165

   166

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

   167

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

   168

{

   169

	SpriteID pal;

   170

   171

	/* draw profit-based colored icons */

   172

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

   173

		pal = PALETTE_TO_GREY;

   175

		pal = PALETTE_TO_RED;

   177

		pal = PALETTE_TO_YELLOW;

   178

	} else {

   179

		pal = PALETTE_TO_GREEN;

   180

	}

   181

	DrawSprite(SPR_BLOT, pal, x, y);

   182

}

   183

   184

struct RefitOption {

   185

	CargoID cargo;

   186

	byte subtype;

   187

	uint16 value;

   188

	EngineID engine;

   189

};

   190

   191

struct RefitList {

   192

	uint num_lines;

   193

	RefitOption *items;

   194

};

   195

   196

static RefitList *BuildRefitList(const Vehicle *v)

   197

{

   198

	uint max_lines = 256;

   199

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

   200

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

   201

	Vehicle *u = (Vehicle*)v;

   202

	uint num_lines = 0;

   203

	uint i;

   204

   205

	do {

   206

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

   207

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

   208

   209

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

   210

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

   211

   212

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

   213

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

   214

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

   215

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

   216

   217

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

   218

			if (HasBit(callbackmask, CBM_VEHICLE_CARGO_SUFFIX)) {

   219

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

   220

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

   221

				CargoID temp_cargo = u->cargo_type;

   222

				byte temp_subtype  = u->cargo_subtype;

   223

				byte refit_cyc;

   224

   225

				u->cargo_type = cid;

   226

   227

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

   228

					bool duplicate = false;

   229

					uint16 callback;

   230

   231

					u->cargo_subtype = refit_cyc;

   232

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

   233

   234

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

   235

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

   236

   237

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

   238

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

   239

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

   240

					}

   241

   242

					if (duplicate) continue;

   243

   244

					refit[num_lines].cargo   = cid;

   245

					refit[num_lines].subtype = refit_cyc;

   246

					refit[num_lines].value   = callback;

   247

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

   248

					num_lines++;

   249

				}

   250

   251

				/* Reset the vehicle's cargo type */

   252

				u->cargo_type    = temp_cargo;

   253

				u->cargo_subtype = temp_subtype;

   254

			} else {

   255

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

   256

				bool duplicate = false;

   257

   258

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

   259

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

   260

				}

   261

   262

				if (!duplicate) {

   263

					refit[num_lines].cargo   = cid;

   264

					refit[num_lines].subtype = 0;

   265

					refit[num_lines].value   = CALLBACK_FAILED;

   266

					refit[num_lines].engine  = INVALID_ENGINE;

   267

					num_lines++;

   268

				}

   269

			}

   270

		}

   271

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

   272

   273

	list->num_lines = num_lines;

   274

	list->items = refit;

   275

   276

	return list;

   277

}

   278

   279

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

   280

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

   281

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

   282

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

   283

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

   284

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

   285

 * @param delta step height in caller window

   286

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

   287

 */

   288

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

   289

{

   290

	RefitOption *refit = list->items;

   291

	RefitOption *selected = NULL;

   292

	uint num_lines = list->num_lines;

   293

	uint y = 31;

   294

	uint i;

   295

   296

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

   297

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

   298

		TextColour colour = TC_BLACK;

   299

		if (sel == 0) {

   300

			selected = &refit[i];

   301

			colour = TC_WHITE;

   302

		}

   303

   304

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

   305

			/* Draw the cargo name */

   306

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

   307

   308

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

   309

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

   310

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

   311

			}

   312

			y += delta;

   313

		}

   314

   315

		sel--;

   316

	}

   317

   318

	return selected;

   319

}

   320

   321

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

   322

{

   323

	switch (e->event) {

   324

		case WE_PAINT: {

   325

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

   326

   327

			if (v->type == VEH_TRAIN) {

   328

				uint length = CountVehiclesInChain(v);

   329

   330

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

   331

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

   332

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

   333

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

   334

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

   335

					WP(w, refit_d).length = length;

   336

				}

   337

			}

   338

   339

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

   340

   341

			SetDParam(0, v->index);

   342

			DrawWindowWidgets(w);

   343

   344

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

   345

   346

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

   347

				CommandCost cost;

   348

   349

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

   350

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

   351

   352

				if (CmdSucceeded(cost)) {

   353

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

   354

					SetDParam(1, _returned_refit_capacity);

   355

					SetDParam(2, cost.GetCost());

   356

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

   357

				}

   358

			}

   359

		} break;

   360

   361

		case WE_CLICK:

   362

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

   363

				case 3: { // listbox

   364

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

   365

					if (y >= 0) {

   366

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

   367

						SetWindowDirty(w);

   368

					}

   369

				} break;

   370

				case 6: // refit button

   371

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

   372

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

   373

   374

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

   375

							int command = 0;

   376

   377

							switch (v->type) {

   378

								default: NOT_REACHED();

   379

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

   380

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

   381

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

   382

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

   383

							}

   384

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

   385

						} else {

   386

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

   387

						}

   388

					}

   389

					break;

   390

			}

   391

			break;

   392

   393

		case WE_RESIZE:

   394

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

   395

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

   396

			break;

   397

   398

		case WE_DESTROY:

   399

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

   400

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

   401

			break;

   402

	}

   403

}

   404

   405

   406

static const Widget _vehicle_refit_widgets[] = {

   407

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

   408

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

   409

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

   410

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

   411

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

   412

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

   413

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

   414

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

   415

	{   WIDGETS_END},

   416

};

   417

   418

static const WindowDesc _vehicle_refit_desc = {

   419

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

   420

	WC_VEHICLE_REFIT, WC_VEHICLE_VIEW,

   421

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS | WDF_RESIZABLE,

   422

	_vehicle_refit_widgets,

   423

	VehicleRefitWndProc,

   424

};

   425

   426

/** Show the refit window for a vehicle

   427

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

   428

* @param order of the vehicle ( ? )

   429

*/

   430

void ShowVehicleRefitWindow(const Vehicle *v, VehicleOrderID order)

   431

{

   432

	Window *w;

   433

   434

	DeleteWindowById(WC_VEHICLE_REFIT, v->index);

   435

   436

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

   437

	WP(w, refit_d).order = order;

   438

   439

	if (w != NULL) {

   440

		w->caption_color = v->owner;

   441

		w->vscroll.cap = 8;

   442

		w->resize.step_height = 14;

   443

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

   444

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

   445

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

   446

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

   447

   448

		switch (v->type) {

   449

			case VEH_TRAIN:

   450

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

   451

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

   452

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

   453

				break;

   454

			case VEH_ROAD:

   455

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

   456

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

   457

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

   458

				break;

   459

			case VEH_SHIP:

   460

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

   461

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

   462

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

   463

				break;

   464

			case VEH_AIRCRAFT:

   465

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

   466

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

   467

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

   468

				break;

   469

			default: NOT_REACHED();

   470

		}

   471

	}

   472

}

   473

   474

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

   475

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

   476

{

   477

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

   478

	if (callback == CALLBACK_FAILED) return 0;

   479

   480

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

   481

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