1

/* $Id$ */

     2

     3

/** @file vehicle_gui.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "debug.h"

     9

#include "station.h"

    10

#include "table/sprites.h"

    11

#include "table/strings.h"

    12

#include "engine.h"

    13

#include "gui.h"

    14

#include "window_gui.h"

    15

#include "textbuf_gui.h"

    16

#include "command_func.h"

    17

#include "variables.h"

    18

#include "vehicle_gui.h"

    19

#include "viewport_func.h"

    20

#include "gfx_func.h"

    21

#include "train.h"

    22

#include "newgrf_callbacks.h"

    23

#include "newgrf_engine.h"

    24

#include "newgrf_text.h"

    25

#include "ship.h"

    26

#include "aircraft.h"

    27

#include "roadveh.h"

    28

#include "depot.h"

    29

#include "cargotype.h"

    30

#include "group.h"

    31

#include "group_gui.h"

    32

#include "strings_func.h"

    33

#include "functions.h"

    34

#include "window_func.h"

    35

#include "vehicle_func.h"

    36

#include "autoreplace_gui.h"

    37

#include "core/alloc_func.hpp"

    38

#include "string_func.h"

    39

    40

struct Sorting {

    41

	Listing aircraft;

    42

	Listing roadveh;

    43

	Listing ship;

    44

	Listing train;

    45

};

    46

    47

static Sorting _sorting;

    48

    49

static bool   _internal_sort_order;     // descending/ascending

    50

    51

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

    52

    53

static VehicleSortListingTypeFunction VehicleNumberSorter;

    54

static VehicleSortListingTypeFunction VehicleNameSorter;

    55

static VehicleSortListingTypeFunction VehicleAgeSorter;

    56

static VehicleSortListingTypeFunction VehicleProfitThisYearSorter;

    57

static VehicleSortListingTypeFunction VehicleProfitLastYearSorter;

    58

static VehicleSortListingTypeFunction VehicleCargoSorter;

    59

static VehicleSortListingTypeFunction VehicleReliabilitySorter;

    60

static VehicleSortListingTypeFunction VehicleMaxSpeedSorter;

    61

static VehicleSortListingTypeFunction VehicleModelSorter;

    62

static VehicleSortListingTypeFunction VehicleValueSorter;

    63

    64

static VehicleSortListingTypeFunction* const _vehicle_sorter[] = {

    65

	&VehicleNumberSorter,

    66

	&VehicleNameSorter,

    67

	&VehicleAgeSorter,

    68

	&VehicleProfitThisYearSorter,

    69

	&VehicleProfitLastYearSorter,

    70

	&VehicleCargoSorter,

    71

	&VehicleReliabilitySorter,

    72

	&VehicleMaxSpeedSorter,

    73

	&VehicleModelSorter,

    74

	&VehicleValueSorter,

    75

};

    76

    77

const StringID _vehicle_sort_listing[] = {

    78

	STR_SORT_BY_NUMBER,

    79

	STR_SORT_BY_DROPDOWN_NAME,

    80

	STR_SORT_BY_AGE,

    81

	STR_SORT_BY_PROFIT_THIS_YEAR,

    82

	STR_SORT_BY_PROFIT_LAST_YEAR,

    83

	STR_SORT_BY_TOTAL_CAPACITY_PER_CARGOTYPE,

    84

	STR_SORT_BY_RELIABILITY,

    85

	STR_SORT_BY_MAX_SPEED,

    86

	STR_SORT_BY_MODEL,

    87

	STR_SORT_BY_VALUE,

    88

	INVALID_STRING_ID

    89

};

    90

    91

void RebuildVehicleLists()

    92

{

    93

	Window* const *wz;

    94

    95

	FOR_ALL_WINDOWS(wz) {

    96

		Window *w = *wz;

    97

    98

		switch (w->window_class) {

    99

			case WC_TRAINS_LIST:

   100

			case WC_ROADVEH_LIST:

   101

			case WC_SHIPS_LIST:

   102

			case WC_AIRCRAFT_LIST:

   103

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

   104

				SetWindowDirty(w);

   105

				break;

   106

   107

			default: break;

   108

		}

   109

	}

   110

}

   111

   112

void ResortVehicleLists()

   113

{

   114

	Window* const *wz;

   115

   116

	FOR_ALL_WINDOWS(wz) {

   117

		Window *w = *wz;

   118

   119

		switch (w->window_class) {

   120

			case WC_TRAINS_LIST:

   121

			case WC_ROADVEH_LIST:

   122

			case WC_SHIPS_LIST:

   123

			case WC_AIRCRAFT_LIST:

   124

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

   125

				SetWindowDirty(w);

   126

				break;

   127

   128

			default: break;

   129

		}

   130

	}

   131

}

   132

   133

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

   134

{

   135

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

   136

   137

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

   138

   139

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

   140

   141

	vl->l.flags &= ~VL_REBUILD;

   142

	vl->l.flags |= VL_RESORT;

   143

}

   144

   145

void SortVehicleList(vehiclelist_d *vl)

   146

{

   147

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

   148

   149

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

   150

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

   151

		_vehicle_sorter[vl->l.sort_type]);

   152

   153

	vl->l.resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   154

	vl->l.flags &= ~VL_RESORT;

   155

}

   156

   157

void DepotSortList(Vehicle **v, uint16 length)

   158

{

   159

	_internal_sort_order = 0;

   160

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

   161

}

   162

   163

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

   164

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

   165

{

   166

	SpriteID pal;

   167

   168

	/* draw profit-based colored icons */

   169

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

   170

		pal = PALETTE_TO_GREY;

   171

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

   172

		pal = PALETTE_TO_RED;

   173

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

   174

		pal = PALETTE_TO_YELLOW;

   175

	} else {

   176

		pal = PALETTE_TO_GREEN;

   177

	}

   178

	DrawSprite(SPR_BLOT, pal, x, y);

   179

}

   180

   181

struct RefitOption {

   182

	CargoID cargo;

   183

	byte subtype;

   184

	uint16 value;

   185

	EngineID engine;

   186

};

   187

   188

struct RefitList {

   189

	uint num_lines;

   190

	RefitOption *items;

   191

};

   192

   193

static RefitList *BuildRefitList(const Vehicle *v)

   194

{

   195

	uint max_lines = 256;

   196

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

   197

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

   198

	Vehicle *u = (Vehicle*)v;

   199

	uint num_lines = 0;

   200

	uint i;

   201

   202

	do {

   203

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

   204

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

   205

   206

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

   207

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

   208

   209

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

   210

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

   211

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

   212

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

   213

   214

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

   215

			if (HasBit(callbackmask, CBM_VEHICLE_CARGO_SUFFIX)) {

   216

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

   217

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

   218

				CargoID temp_cargo = u->cargo_type;

   219

				byte temp_subtype  = u->cargo_subtype;

   220

				byte refit_cyc;

   221

   222

				u->cargo_type = cid;

   223

   224

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

   225

					bool duplicate = false;

   226

					uint16 callback;

   227

   228

					u->cargo_subtype = refit_cyc;

   229

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

   230

   231

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

   232

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

   233

   234

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

   235

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

   236

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

   237

					}

   238

   239

					if (duplicate) continue;

   240

   241

					refit[num_lines].cargo   = cid;

   242

					refit[num_lines].subtype = refit_cyc;

   243

					refit[num_lines].value   = callback;

   244

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

   245

					num_lines++;

   246

				}

   247

   248

				/* Reset the vehicle's cargo type */

   249

				u->cargo_type    = temp_cargo;

   250

				u->cargo_subtype = temp_subtype;

   251

			} else {

   252

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

   253

				bool duplicate = false;

   254

   255

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

   256

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

   257

				}

   258

   259

				if (!duplicate) {

   260

					refit[num_lines].cargo   = cid;

   261

					refit[num_lines].subtype = 0;

   262

					refit[num_lines].value   = CALLBACK_FAILED;

   263

					refit[num_lines].engine  = INVALID_ENGINE;

   264

					num_lines++;

   265

				}

   266

			}

   267

		}

   268

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

   269

   270

	list->num_lines = num_lines;

   271

	list->items = refit;

   272

   273

	return list;

   274

}

   275

   276

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

   277

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

   278

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

   279

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

   280

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

   281

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

   282

 * @param delta step height in caller window

   283

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

   284

 */

   285

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

   286

{

   287

	RefitOption *refit = list->items;

   288

	RefitOption *selected = NULL;

   289

	uint num_lines = list->num_lines;

   290

	uint y = 31;

   291

	uint i;

   292

   293

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

   294

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

   295

		TextColour colour = TC_BLACK;

   296

		if (sel == 0) {

   297

			selected = &refit[i];

   298

			colour = TC_WHITE;

   299

		}

   300

   301

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

   302

			/* Draw the cargo name */

   303

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

   304

   305

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

   306

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

   307

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

   308

			}

   309

			y += delta;

   310

		}

   311

   312

		sel--;

   313

	}

   314

   315

	return selected;

   316

}

   317

   318

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

   319

{

   320

	switch (e->event) {

   321

		case WE_PAINT: {

   322

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

   323

   324

			if (v->type == VEH_TRAIN) {

   325

				uint length = CountVehiclesInChain(v);

   326

   327

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

   328

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

   329

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

   330

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

   331

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

   332

					WP(w, refit_d).length = length;

   333

				}

   334

			}

   335

   336

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

   337

   338

			SetDParam(0, v->index);

   339

			DrawWindowWidgets(w);

   340

   341

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

   342

   343

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

   344

				CommandCost cost;

   345

   346

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

   347

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

   348

   349

				if (CmdSucceeded(cost)) {

   350

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

   351

					SetDParam(1, _returned_refit_capacity);

   352

					SetDParam(2, cost.GetCost());

   353

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

   354

				}

   355

			}

   356

		} break;

   357

   358

		case WE_CLICK:

   359

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

   360

				case 3: { // listbox

   361

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

   362

					if (y >= 0) {

   363

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

   364

						SetWindowDirty(w);

   365

					}

   366

				} break;

   367

				case 6: // refit button

   368

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

   369

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

   370

   371

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

   372

							int command = 0;

   373

   374

							switch (v->type) {

   375

								default: NOT_REACHED();

   376

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

   377

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

   378

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

   379

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

   380

							}

   381

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

   382

						} else {

   383

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

   384

						}

   385

					}

   386

					break;

   387

			}

   388

			break;

   389

   390

		case WE_RESIZE:

   391

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

   392

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

   393

			break;

   394

   395

		case WE_DESTROY:

   396

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

   397

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

   398

			break;

   399

	}

   400

}

   401

   402

   403

static const Widget _vehicle_refit_widgets[] = {

   404

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

   405

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

   406

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

   407

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

   408

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

   409

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

   410

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

   411

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

   412

	{   WIDGETS_END},

   413

};

   414

   415

static const WindowDesc _vehicle_refit_desc = {

   416

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

   417

	WC_VEHICLE_REFIT, WC_VEHICLE_VIEW,

   418

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS | WDF_RESIZABLE,

   419

	_vehicle_refit_widgets,

   420

	VehicleRefitWndProc,

   421

};

   422

   423

/** Show the refit window for a vehicle

   424

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

   425

* @param order of the vehicle ( ? )

   426

*/

   427

void ShowVehicleRefitWindow(const Vehicle *v, VehicleOrderID order)

   428

{

   429

	Window *w;

   430

   431

	DeleteWindowById(WC_VEHICLE_REFIT, v->index);

   432

   433

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

   434

	WP(w, refit_d).order = order;

   435

   436

	if (w != NULL) {

   437

		w->caption_color = v->owner;

   438

		w->vscroll.cap = 8;

   439

		w->resize.step_height = 14;

   440

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

   441

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

   442

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

   443

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

   444

   445

		switch (v->type) {

   446

			case VEH_TRAIN:

   447

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

   448

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

   449

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

   450

				break;

   451

			case VEH_ROAD:

   452

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

   453

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

   454

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

   455

				break;

   456

			case VEH_SHIP:

   457

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

   458

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

   459

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

   460

				break;

   461

			case VEH_AIRCRAFT:

   462

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

   463

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

   464

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

   465

				break;

   466

			default: NOT_REACHED();

   467

		}

   468

	}

   469

}

   470

   471

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

   472

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

   473

{

   474

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

   475

	if (callback == CALLBACK_FAILED) return 0;

   476

   477

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

   478

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

   479

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

   480

}

   481