1

/* $Id$ */

     2

     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"

    39

    40

#include "table/sprites.h"

    41

#include "table/strings.h"

    42

    43

struct refit_d {

    44

	int sel;

    45

	struct RefitOption *cargo;

    46

	struct RefitList *list;

    47

	uint length;

    48

	VehicleOrderID order;

    49

};

    50

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(refit_d));

    51

    52

struct Sorting {

    53

	Listing aircraft;

    54

	Listing roadveh;

    55

	Listing ship;

    56

	Listing train;

    57

};

    58

    59

static Sorting _sorting;

    60

    61

static bool   _internal_sort_order;     // descending/ascending

    62

    63

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

    64

    65

static VehicleSortListingTypeFunction VehicleNumberSorter;

    66

static VehicleSortListingTypeFunction VehicleNameSorter;

    67

static VehicleSortListingTypeFunction VehicleAgeSorter;

    68

static VehicleSortListingTypeFunction VehicleProfitThisYearSorter;

    69

static VehicleSortListingTypeFunction VehicleProfitLastYearSorter;

    70

static VehicleSortListingTypeFunction VehicleCargoSorter;

    71

static VehicleSortListingTypeFunction VehicleReliabilitySorter;

    72

static VehicleSortListingTypeFunction VehicleMaxSpeedSorter;

    73

static VehicleSortListingTypeFunction VehicleModelSorter;

    74

static VehicleSortListingTypeFunction VehicleValueSorter;

    75

static VehicleSortListingTypeFunction VehicleLengthSorter;

    76

    77

static VehicleSortListingTypeFunction* const _vehicle_sorter[] = {

    78

	&VehicleNumberSorter,

    79

	&VehicleNameSorter,

    80

	&VehicleAgeSorter,

    81

	&VehicleProfitThisYearSorter,

    82

	&VehicleProfitLastYearSorter,

    83

	&VehicleCargoSorter,

    84

	&VehicleReliabilitySorter,

    85

	&VehicleMaxSpeedSorter,

    86

	&VehicleModelSorter,

    87

	&VehicleValueSorter,

    88

	&VehicleLengthSorter,

    89

};

    90

    91

const StringID _vehicle_sort_listing[] = {

    92

	STR_SORT_BY_NUMBER,

    93

	STR_SORT_BY_DROPDOWN_NAME,

    94

	STR_SORT_BY_AGE,

    95

	STR_SORT_BY_PROFIT_THIS_YEAR,

    96

	STR_SORT_BY_PROFIT_LAST_YEAR,

    97

	STR_SORT_BY_TOTAL_CAPACITY_PER_CARGOTYPE,

    98

	STR_SORT_BY_RELIABILITY,

    99

	STR_SORT_BY_MAX_SPEED,

   100

	STR_SORT_BY_MODEL,

   101

	STR_SORT_BY_VALUE,

   102

	STR_SORT_BY_LENGTH,

   103

	INVALID_STRING_ID

   104

};

   105

   106

/**

   107

 * Set sort list flag for all vehicle list windows

   108

 * @param sl_flag Sort list flag to set

   109

 */

   110

static void SetVehicleListsFlag(SortListFlags sl_flag)

   111

{

   112

	Window* const *wz;

   113

   114

	FOR_ALL_WINDOWS(wz) {

   115

		Window *w = *wz;

   116

   117

		switch (w->window_class) {

   118

			case WC_TRAINS_LIST:

   119

			case WC_ROADVEH_LIST:

   120

			case WC_SHIPS_LIST:

   121

			case WC_AIRCRAFT_LIST:

   122

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

   124

				break;

   125

   126

			default: break;

   127

		}

   128

	}

   129

}

   130

   131

/**

   132

 * Rebuild all vehicle list windows

   133

 */

   134

void RebuildVehicleLists()

   135

{

   136

	SetVehicleListsFlag(VL_REBUILD);

   137

}

   138

   139

/**

   140

 * Resort all vehicle list windows

   141

 */

   142

void ResortVehicleLists()

   143

{

   144

	SetVehicleListsFlag(VL_RESORT);

   145

}

   146

   147

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

   148

{

   149

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

   150

   151

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

   152

   153

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

   154

   155

	vl->l.flags &= ~VL_REBUILD;

   156

	vl->l.flags |= VL_RESORT;

   157

}

   158

   159

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

   160

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

   161

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

   162

   163

void SortVehicleList(vehiclelist_d *vl)

   164

{

   165

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

   166

   167

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

   168

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

   169

   170

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

   171

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

   172

		_vehicle_sorter[vl->l.sort_type]);

   173

   174

	vl->l.resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   175

	vl->l.flags &= ~VL_RESORT;

   176

}

   177

   178

void DepotSortList(Vehicle **v, uint16 length)

   179

{

   180

	_internal_sort_order = 0;

   181

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

   182

}

   183

   184

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

   185

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

   186

{

   187

	SpriteID pal;

   188

   189

	/* draw profit-based colored icons */

   190

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

   191

		pal = PALETTE_TO_GREY;

   192

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

   193

		pal = PALETTE_TO_RED;

   194

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

   195

		pal = PALETTE_TO_YELLOW;

   196

	} else {

   197

		pal = PALETTE_TO_GREEN;

   198

	}

   199

	DrawSprite(SPR_BLOT, pal, x, y);

   200

}

   201

   202

struct RefitOption {

   203

	CargoID cargo;

   204

	byte subtype;

   205

	uint16 value;

   206

	EngineID engine;

   207

};

   208

   209

struct RefitList {

   210

	uint num_lines;

   211

	RefitOption *items;

   212

};

   213

   214

static RefitList *BuildRefitList(const Vehicle *v)

   215

{

   216

	uint max_lines = 256;

   217

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

   218

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

   219

	Vehicle *u = (Vehicle*)v;

   220

	uint num_lines = 0;

   221

	uint i;

   222

   223

	do {

   224

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

   225

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

   226

   227

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

   228

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

   229

   230

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

   231

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

   232

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

   233

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

   234

   235

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

   236

			if (HasBit(callbackmask, CBM_VEHICLE_CARGO_SUFFIX)) {

   237

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

   238

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

   239

				CargoID temp_cargo = u->cargo_type;

   240

				byte temp_subtype  = u->cargo_subtype;

   241

				byte refit_cyc;

   242

   243

				u->cargo_type = cid;

   244

   245

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

   246

					bool duplicate = false;

   247

					uint16 callback;

   248

   249

					u->cargo_subtype = refit_cyc;

   250

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

   251

   252

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

   253

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

   254

   255

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

   256

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

   257

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

   258

					}

   259

   260

					if (duplicate) continue;

   261

   262

					refit[num_lines].cargo   = cid;

   263

					refit[num_lines].subtype = refit_cyc;

   264

					refit[num_lines].value   = callback;

   265

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

   266

					num_lines++;

   267

				}

   268

   269

				/* Reset the vehicle's cargo type */

   270

				u->cargo_type    = temp_cargo;

   271

				u->cargo_subtype = temp_subtype;

   272

			} else {

   273

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

   274

				bool duplicate = false;

   275

   276

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

   277

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

   278

				}

   279

   280

				if (!duplicate) {

   281

					refit[num_lines].cargo   = cid;

   282

					refit[num_lines].subtype = 0;

   283

					refit[num_lines].value   = CALLBACK_FAILED;

   284

					refit[num_lines].engine  = INVALID_ENGINE;

   285

					num_lines++;

   286

				}

   287

			}

   288

		}

   289

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

   290

   291

	list->num_lines = num_lines;

   292

	list->items = refit;

   293

   294

	return list;

   295

}

   296

   297

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

   298

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

   299

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

   300

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

   301

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

   302

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

   303

 * @param delta step height in caller window

   304

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

   305

 */

   306

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

   307

{

   308

	RefitOption *refit = list->items;

   309

	RefitOption *selected = NULL;

   310

	uint num_lines = list->num_lines;

   311

	uint y = 31;

   312

	uint i;

   313

   314

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

   315

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

   316

		TextColour colour = TC_BLACK;

   317

		if (sel == 0) {

   318

			selected = &refit[i];

   319

			colour = TC_WHITE;

   320

		}

   321

   322

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

   323

			/* Draw the cargo name */

   324

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

   325

   326

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

   327

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

   328

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

   329

			}

   330

			y += delta;

   331

		}

   332

   333

		sel--;

   334

	}

   335

   336

	return selected;

   337

}

   338

   339

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

   340

{

   341

	switch (e->event) {

   342

		case WE_PAINT: {

   343

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

   344

   345

			if (v->type == VEH_TRAIN) {

   346

				uint length = CountVehiclesInChain(v);

   347

   348

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

   349

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

   350

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

   351

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

   352

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

   353

					WP(w, refit_d).length = length;

   354

				}

   355

			}

   356

   357

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

   358

   359

			SetDParam(0, v->index);

   360

			DrawWindowWidgets(w);

   361

   362

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

   363

   364

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

   365

				CommandCost cost;

   366

   367

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

   368

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

   369

   370

				if (CmdSucceeded(cost)) {

   371

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

   372

					SetDParam(1, _returned_refit_capacity);

   373

					SetDParam(2, cost.GetCost());

   374

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

   375

				}

   376

			}

   377

		} break;

   378

   379

		case WE_CLICK:

   380

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

   381

				case 3: { // listbox

   382

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

   383

					if (y >= 0) {

   384

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

   386

					}

   387

				} break;

   388

				case 6: // refit button

   389

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

   390

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

   391

   392

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

   393

							int command = 0;

   394

   395

							switch (v->type) {

   396

								default: NOT_REACHED();

   397

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

   398

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

   399

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

   400

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

   401

							}

   403

						} else {

   405

						}

   406

					}

   407

					break;

   408

			}

   409

			break;

   410

   411

		case WE_RESIZE:

   412

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

   413

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

   414

			break;

   415

   416

		case WE_DESTROY:

   417

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

   418

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

   419

			break;

   420

	}

   421

}

   422

   423

   424

static const Widget _vehicle_refit_widgets[] = {

   425

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

   426

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

   427

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

   428

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

   429

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

   430

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

   431

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

   432

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

   433

	{   WIDGETS_END},

   434

};

   435

   436

static const WindowDesc _vehicle_refit_desc = {

   437

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

   438

	WC_VEHICLE_REFIT, WC_VEHICLE_VIEW,

   439

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS | WDF_RESIZABLE,

   440

	_vehicle_refit_widgets,

   441

	VehicleRefitWndProc,

   442

};

   443

   444

/** Show the refit window for a vehicle

   445

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

   446

* @param order of the vehicle ( ? )

   447

*/

   448

void ShowVehicleRefitWindow(const Vehicle *v, VehicleOrderID order)

   449

{

   450

	Window *w;

   451

   452

	DeleteWindowById(WC_VEHICLE_REFIT, v->index);

   453

   454

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

   455

	WP(w, refit_d).order = order;

   456

   457

	if (w != NULL) {

   458

		w->caption_color = v->owner;

   459

		w->vscroll.cap = 8;

   460

		w->resize.step_height = 14;

   461

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

   462

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

   463

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

   464

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

   465

   466

		switch (v->type) {

   467

			case VEH_TRAIN:

   468

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

   469

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

   470

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

   471

				break;

   472

			case VEH_ROAD:

   473

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

   474

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

   475

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

   476

				break;

   477

			case VEH_SHIP:

   478

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

   479

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

   480

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

   481

				break;

   482

			case VEH_AIRCRAFT: