1

/* $Id$ */

     2

     3

/** @file vehicle_gui.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "debug.h"

     8

#include "functions.h"

     9

#include "player.h"

    10

#include "station.h"

    11

#include "strings.h"

    12

#include "table/sprites.h"

    13

#include "table/strings.h"

    14

#include "vehicle.h"

    15

#include "window.h"

    16

#include "engine.h"

    17

#include "gui.h"

    18

#include "command.h"

    19

#include "gfx.h"

    20

#include "variables.h"

    21

#include "vehicle_gui.h"

    22

#include "viewport.h"

    23

#include "train.h"

    24

#include "newgrf_callbacks.h"

    25

#include "newgrf_engine.h"

    26

#include "newgrf_text.h"

    27

#include "date.h"

    28

#include "ship.h"

    29

#include "aircraft.h"

    30

#include "roadveh.h"

    31

#include "depot.h"

    32

#include "helpers.hpp"

    33

#include "cargotype.h"

    34

#include "group.h"

    35

    36

struct Sorting {

    37

	Listing aircraft;

    38

	Listing roadveh;

    39

	Listing ship;

    40

	Listing train;

    41

};

    42

    43

static Sorting _sorting;

    44

    45

static bool   _internal_sort_order;     // descending/ascending

    46

    47

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

    48

    49

static VehicleSortListingTypeFunction VehicleNumberSorter;

    50

static VehicleSortListingTypeFunction VehicleNameSorter;

    51

static VehicleSortListingTypeFunction VehicleAgeSorter;

    52

static VehicleSortListingTypeFunction VehicleProfitThisYearSorter;

    53

static VehicleSortListingTypeFunction VehicleProfitLastYearSorter;

    54

static VehicleSortListingTypeFunction VehicleCargoSorter;

    55

static VehicleSortListingTypeFunction VehicleReliabilitySorter;

    56

static VehicleSortListingTypeFunction VehicleMaxSpeedSorter;

    57

static VehicleSortListingTypeFunction VehicleModelSorter;

    58

static VehicleSortListingTypeFunction VehicleValueSorter;

    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

};

    72

    73

const StringID _vehicle_sort_listing[] = {

    74

	STR_SORT_BY_NUMBER,

    75

	STR_SORT_BY_DROPDOWN_NAME,

    76

	STR_SORT_BY_AGE,

    77

	STR_SORT_BY_PROFIT_THIS_YEAR,

    78

	STR_SORT_BY_PROFIT_LAST_YEAR,

    79

	STR_SORT_BY_TOTAL_CAPACITY_PER_CARGOTYPE,

    80

	STR_SORT_BY_RELIABILITY,

    81

	STR_SORT_BY_MAX_SPEED,

    82

	STR_SORT_BY_MODEL,

    83

	STR_SORT_BY_VALUE,

    84

	INVALID_STRING_ID

    85

};

    86

    87

void RebuildVehicleLists()

    88

{

    89

	Window* const *wz;

    90

    91

	FOR_ALL_WINDOWS(wz) {

    92

		Window *w = *wz;

    93

    94

		switch (w->window_class) {

    95

			case WC_TRAINS_LIST:

    96

			case WC_ROADVEH_LIST:

    97

			case WC_SHIPS_LIST:

    98

			case WC_AIRCRAFT_LIST:

    99

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

   100

				SetWindowDirty(w);

   101

				break;

   102

   103

			default: break;

   104

		}

   105

	}

   106

}

   107

   108

void ResortVehicleLists()

   109

{

   110

	Window* const *wz;

   111

   112

	FOR_ALL_WINDOWS(wz) {

   113

		Window *w = *wz;

   114

   115

		switch (w->window_class) {

   116

			case WC_TRAINS_LIST:

   117

			case WC_ROADVEH_LIST:

   118

			case WC_SHIPS_LIST:

   119

			case WC_AIRCRAFT_LIST:

   120

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

   121

				SetWindowDirty(w);

   122

				break;

   123

   124

			default: break;

   125

		}

   126

	}

   127

}

   128

   129

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

   130

{

   131

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

   132

   133

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

   134

   135

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

   136

   137

	vl->l.flags &= ~VL_REBUILD;

   138

	vl->l.flags |= VL_RESORT;

   139

}

   140

   141

void SortVehicleList(vehiclelist_d *vl)

   142

{

   143

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

   144

   145

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

   146

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

   147

		_vehicle_sorter[vl->l.sort_type]);

   148

   149

	vl->l.resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   150

	vl->l.flags &= ~VL_RESORT;

   151

}

   152

   153

void DepotSortList(Vehicle **v, uint16 length)

   154

{

   155

	_internal_sort_order = 0;

   156

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

   157

}

   158

   159

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

   160

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

   161

{

   162

	SpriteID pal;

   163

   164

	/* draw profit-based colored icons */

   165

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

   166

		pal = PALETTE_TO_GREY;

   167

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

   168

		pal = PALETTE_TO_RED;

   169

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

   170

		pal = PALETTE_TO_YELLOW;

   171

	} else {

   172

		pal = PALETTE_TO_GREEN;

   173

	}

   174

	DrawSprite(SPR_BLOT, pal, x, y);

   175

}

   176

   177

struct RefitOption {

   178

	CargoID cargo;

   179

	byte subtype;

   180

	uint16 value;

   181

	EngineID engine;

   182

};

   183

   184

struct RefitList {

   185

	uint num_lines;

   186

	RefitOption *items;

   187

};

   188

   189

static RefitList *BuildRefitList(const Vehicle *v)

   190

{

   191

	uint max_lines = 256;

   192

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

   193

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

   194

	Vehicle *u = (Vehicle*)v;

   195

	uint num_lines = 0;

   196

	uint i;

   197

   198

	do {

   199

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

   200

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

   201

   202

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

   203

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

   204

   205

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

   206

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

   207

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

   208

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

   209

   210

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

   211

			if (HASBIT(callbackmask, CBM_CARGO_SUFFIX)) {

   212

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

   213

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

   214

				CargoID temp_cargo = u->cargo_type;

   215

				byte temp_subtype  = u->cargo_subtype;

   216

				byte refit_cyc;

   217

   218

				u->cargo_type = cid;

   219

   220

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

   221

					bool duplicate = false;

   222

					uint16 callback;

   223

   224

					u->cargo_subtype = refit_cyc;

   225

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

   226

   227

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

   228

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

   229

   230

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

   231

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

   232

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

   233

					}

   234

   235

					if (duplicate) continue;

   236

   237

					refit[num_lines].cargo   = cid;

   238

					refit[num_lines].subtype = refit_cyc;

   239

					refit[num_lines].value   = callback;

   240

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

   241

					num_lines++;

   242

				}

   243

   244

				/* Reset the vehicle's cargo type */

   245

				u->cargo_type    = temp_cargo;

   246

				u->cargo_subtype = temp_subtype;

   247

			} else {

   248

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

   249

				bool duplicate = false;

   250

   251

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

   252

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

   253

				}

   254

   255

				if (!duplicate) {

   256

					refit[num_lines].cargo   = cid;

   257

					refit[num_lines].subtype = 0;

   258

					refit[num_lines].value   = CALLBACK_FAILED;

   259

					refit[num_lines].engine  = INVALID_ENGINE;

   260

					num_lines++;

   261

				}

   262

			}

   263

		}

   264

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

   265

   266

	list->num_lines = num_lines;

   267

	list->items = refit;

   268

   269

	return list;

   270

}

   271

   272

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

   273

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

   274

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

   275

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

   276

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

   277

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

   278

 * @param delta step height in caller window

   279

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

   280

 */

   281

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

   282

{

   283

	RefitOption *refit = list->items;

   284

	RefitOption *selected = NULL;

   285

	uint num_lines = list->num_lines;

   286

	uint y = 31;

   287

	uint i;

   288

   289

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

   290

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

   291

		byte colour = 16;

   292

		if (sel == 0) {

   293

			selected = &refit[i];

   294

			colour = 12;

   295

		}

   296

   297

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

   298

			/* Draw the cargo name */

   299

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

   300

   301

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

   302

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

   303

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

   304

			}

   305

			y += delta;

   306

		}

   307

   308

		sel--;

   309

	}

   310

   311

	return selected;

   312

}

   313

   314

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

   315

{

   316

	switch (e->event) {

   317

		case WE_PAINT: {

   318

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

   319

   320

			if (v->type == VEH_TRAIN) {

   321

				uint length = CountVehiclesInChain(v);

   322

   323

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

   324

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

   325

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

   326

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

   327

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

   328

					WP(w, refit_d).length = length;

   329

				}

   330

			}

   331

   332

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

   333

   334

			SetDParam(0, v->string_id);

   335

			SetDParam(1, v->unitnumber);

   336

			DrawWindowWidgets(w);

   337

   338

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

   339

   340

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

   342

   343

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

   344

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

   345

   347

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

   348

					SetDParam(1, _returned_refit_capacity);

   349

					SetDParam(2, cost);

   350

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

   351

				}

   352

			}

   353

		} break;

   354

   355

		case WE_CLICK:

   356

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

   357

				case 3: { // listbox

   358

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

   359

					if (y >= 0) {

   360

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

   361

						SetWindowDirty(w);

   362

					}

   363

				} break;

   364

				case 6: // refit button

   365

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

   366

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

   367

   368

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

   369

							int command = 0;

   370

   371

							switch (v->type) {

   372

								default: NOT_REACHED();

   373

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

   374

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

   375

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

   376

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

   377

							}

   378

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

   379

						} else {

   380

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

   381

						}

   382

					}

   383

					break;

   384

			}

   385

			break;

   386

   387

		case WE_RESIZE:

   388

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

   389

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

   390

			break;

   391

   392

		case WE_DESTROY:

   393

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

   394

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

   395

			break;

   396

	}

   397

}

   398

   399

   400

static const Widget _vehicle_refit_widgets[] = {

   401

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

   402

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

   403

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

   404

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

   405

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

   406

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

   407

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

   408

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

   409

	{   WIDGETS_END},

   410

};

   411

   412

static const WindowDesc _vehicle_refit_desc = {

   413

	WDP_AUTO, WDP_AUTO, 240, 174,

   414

	WC_VEHICLE_REFIT, WC_VEHICLE_VIEW,

   415

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS | WDF_RESIZABLE,

   416

	_vehicle_refit_widgets,

   417

	VehicleRefitWndProc,

   418

};

   419

   420

/** Show the refit window for a vehicle

   421

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

   422

* @param order of the vehicle ( ? )

   423

*/

   424

void ShowVehicleRefitWindow(const Vehicle *v, VehicleOrderID order)

   425

{

   426

	Window *w;

   427

   428

	DeleteWindowById(WC_VEHICLE_REFIT, v->index);

   429

   430

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

   431

	WP(w, refit_d).order = order;

   432

   433

	if (w != NULL) {

   434

		w->caption_color = v->owner;

   435

		w->vscroll.cap = 8;

   436

		w->resize.step_height = 14;

   437

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

   438

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

   439

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

   440

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

   441

   442

		switch (v->type) {

   443

			case VEH_TRAIN:

   444

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

   445

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

   446

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

   447

				break;

   448

			case VEH_ROAD:

   449

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

   450

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

   451

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

   452

				break;

   453

			case VEH_SHIP:

   454

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

   455

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

   456

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

   457

				break;

   458

			case VEH_AIRCRAFT:

   459

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

   460

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

   461

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

   462

				break;

   463

			default: NOT_REACHED();

   464

		}

   465

	}

   466

}

   467

   468

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

   469

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

   470

{

   471

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

   472

	if (callback == CALLBACK_FAILED) return 0;

   473

   474

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

   475

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

   476

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

   477

}

   478

   479

/** Count the number of bits that are set in a mask */

   480

static uint CountBits(uint32 mask)

   481

{

   482

	uint c = 0;