1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "debug.h"

     6

#include "functions.h"

     7

#include "player.h"

     8

#include "station.h"

     9

#include "strings.h"

    10

#include "table/sprites.h"

    11

#include "table/strings.h"

    12

#include "vehicle.h"

    13

#include "window.h"

    14

#include "engine.h"

    15

#include "gui.h"

    16

#include "command.h"

    17

#include "gfx.h"

    18

#include "variables.h"

    19

#include "vehicle_gui.h"

    20

#include "viewport.h"

    21

#include "train.h"

    22

#include "newgrf_callbacks.h"

    23

#include "newgrf_engine.h"

    24

#include "newgrf_text.h"

    25

#include "date.h"

    26

#include "ship.h"

    27

#include "aircraft.h"

    28

#include "roadveh.h"

    29

#include "depot.h"

    30

#include "helpers.hpp"

    31

    32

typedef struct Sorting {

    33

	Listing aircraft;

    34

	Listing roadveh;

    35

	Listing ship;

    36

	Listing train;

    37

} Sorting;

    38

    39

static Sorting _sorting;

    40

    41

typedef struct vehiclelist_d {

    42

	const Vehicle** sort_list;  // List of vehicles (sorted)

    43

	Listing *_sorting;          // pointer to the appropiate subcategory of _sorting

    44

	uint16 length_of_sort_list; // Keeps track of how many vehicle pointers sort list got space for

    45

	byte vehicle_type;          // The vehicle type that is sorted

    46

	list_d l;                   // General list struct

    47

} vehiclelist_d;

    48

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(vehiclelist_d));

    49

    50

static bool   _internal_sort_order;     // descending/ascending

    51

    52

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

    53

    54

static VehicleSortListingTypeFunction VehicleNumberSorter;

    55

static VehicleSortListingTypeFunction VehicleNameSorter;

    56

static VehicleSortListingTypeFunction VehicleAgeSorter;

    57

static VehicleSortListingTypeFunction VehicleProfitThisYearSorter;

    58

static VehicleSortListingTypeFunction VehicleProfitLastYearSorter;

    59

static VehicleSortListingTypeFunction VehicleCargoSorter;

    60

static VehicleSortListingTypeFunction VehicleReliabilitySorter;

    61

static VehicleSortListingTypeFunction VehicleMaxSpeedSorter;

    62

static VehicleSortListingTypeFunction VehicleModelSorter;

    63

static VehicleSortListingTypeFunction VehicleValueSorter;

    64

    65

static VehicleSortListingTypeFunction* const _vehicle_sorter[] = {

    66

	&VehicleNumberSorter,

    67

	&VehicleNameSorter,

    68

	&VehicleAgeSorter,

    69

	&VehicleProfitThisYearSorter,

    70

	&VehicleProfitLastYearSorter,

    71

	&VehicleCargoSorter,

    72

	&VehicleReliabilitySorter,

    73

	&VehicleMaxSpeedSorter,

    74

	&VehicleModelSorter,

    75

	&VehicleValueSorter,

    76

};

    77

    78

static const StringID _vehicle_sort_listing[] = {

    79

	STR_SORT_BY_NUMBER,

    80

	STR_SORT_BY_DROPDOWN_NAME,

    81

	STR_SORT_BY_AGE,

    82

	STR_SORT_BY_PROFIT_THIS_YEAR,

    83

	STR_SORT_BY_PROFIT_LAST_YEAR,

    84

	STR_SORT_BY_TOTAL_CAPACITY_PER_CARGOTYPE,

    85

	STR_SORT_BY_RELIABILITY,

    86

	STR_SORT_BY_MAX_SPEED,

    87

	STR_SORT_BY_MODEL,

    88

	STR_SORT_BY_VALUE,

    89

	INVALID_STRING_ID

    90

};

    91

    92

void RebuildVehicleLists(void)

    93

{

    94

	Window* const *wz;

    95

    96

	FOR_ALL_WINDOWS(wz) {

    97

		Window *w = *wz;

    98

    99

		switch (w->window_class) {

   100

			case WC_TRAINS_LIST:

   101

			case WC_ROADVEH_LIST:

   102

			case WC_SHIPS_LIST:

   103

			case WC_AIRCRAFT_LIST:

   104

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

   105

				SetWindowDirty(w);

   106

				break;

   107

   108

			default: break;

   109

		}

   110

	}

   111

}

   112

   113

void ResortVehicleLists(void)

   114

{

   115

	Window* const *wz;

   116

   117

	FOR_ALL_WINDOWS(wz) {

   118

		Window *w = *wz;

   119

   120

		switch (w->window_class) {

   121

			case WC_TRAINS_LIST:

   122

			case WC_ROADVEH_LIST:

   123

			case WC_SHIPS_LIST:

   124

			case WC_AIRCRAFT_LIST:

   125

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

   126

				SetWindowDirty(w);

   127

				break;

   128

   129

			default: break;

   130

		}

   131

	}

   132

}

   133

   134

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

   135

{

   136

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

   137

   138

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

   139

   140

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

   141

   142

	vl->l.flags &= ~VL_REBUILD;

   143

	vl->l.flags |= VL_RESORT;

   144

}

   145

   146

static void SortVehicleList(vehiclelist_d *vl)

   147

{

   148

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

   149

   150

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

   151

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

   152

		_vehicle_sorter[vl->l.sort_type]);

   153

   154

	vl->l.resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   155

	vl->l.flags &= ~VL_RESORT;

   156

}

   157

   158

void DepotSortList(Vehicle **v, uint16 length)

   159

{

   160

	_internal_sort_order = 0;

   161

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

   162

}

   163

   164

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

   165

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

   166

{

   167

	SpriteID pal;

   168

   169

	// draw profit-based colored icons

   170

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

   171

		pal = PALETTE_TO_GREY;

   172

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

   173

		pal = PALETTE_TO_RED;

   174

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

   175

		pal = PALETTE_TO_YELLOW;

   176

	} else {

   177

		pal = PALETTE_TO_GREEN;

   178

	}

   179

	DrawSprite(SPR_BLOT, pal, x, y);

   180

}

   181

   182

typedef struct RefitOption {

   183

	CargoID cargo;

   184

	byte subtype;

   185

	uint16 value;

   186

	EngineID engine;

   187

} RefitOption;

   188

   189

typedef struct RefitList {

   190

	uint num_lines;

   191

	RefitOption *items;

   192

} RefitList;

   193

   194

static RefitList *BuildRefitList(const Vehicle *v)

   195

{

   196

	uint max_lines = 256;

   197

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

   198

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

   199

	Vehicle *u = (Vehicle*)v;

   200

	uint num_lines = 0;

   201

	uint i;

   202

   203

	do {

   204

		CargoID cid;

   205

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

   206

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

   207

   208

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

   209

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

   210

   211

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

   212

		for (cid = 0; cmask != 0 && num_lines < max_lines; cmask >>= 1, cid++) {

   213

			CargoID lcid;

   214

   215

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

   216

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

   217

   218

			lcid = _local_cargo_id_ctype[cid];

   219

			if (lcid == CT_INVALID) continue;

   220

   221

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

   222

			if (HASBIT(callbackmask, CBM_CARGO_SUFFIX)) {

   223

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

   224

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

   225

				CargoID temp_cargo = u->cargo_type;

   226

				byte temp_subtype  = u->cargo_subtype;

   227

				byte refit_cyc;

   228

   229

				u->cargo_type = lcid;

   230

   231

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

   232

					bool duplicate = false;

   233

					uint16 callback;

   234

   235

					u->cargo_subtype = refit_cyc;

   236

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

   237

   238

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

   239

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

   240

   241

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

   242

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

   243

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

   244

					}

   245

   246

					if (duplicate) continue;

   247

   248

					refit[num_lines].cargo   = lcid;

   249

					refit[num_lines].subtype = refit_cyc;

   250

					refit[num_lines].value   = callback;

   251

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

   252

					num_lines++;

   253

				}

   254

   255

				/* Reset the vehicle's cargo type */

   256

				u->cargo_type    = temp_cargo;

   257

				u->cargo_subtype = temp_subtype;

   258

			} else {

   259

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

   260

				bool duplicate = false;

   261

   262

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

   263

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

   264

				}

   265

   266

				if (!duplicate) {

   267

					refit[num_lines].cargo   = lcid;

   268

					refit[num_lines].subtype = 0;

   269

					refit[num_lines].value   = CALLBACK_FAILED;

   270

					refit[num_lines].engine  = INVALID_ENGINE;

   271

					num_lines++;

   272

				}

   273

			}

   274

		}

   275

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

   276

   277

	list->num_lines = num_lines;

   278

	list->items = refit;

   279

   280

	return list;

   281

}

   282

   283

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

   284

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

   285

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

   286

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

   287

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

   288

 */

   289

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

   290

{

   291

	RefitOption *refit = list->items;

   292

	RefitOption *selected = NULL;

   293

	uint num_lines = list->num_lines;

   294

	uint y = 31;

   295

	uint i;

   296

   297

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

   298

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

   299

		byte colour = 16;

   300

		if (sel == 0) {

   301

			selected = &refit[i];

   302

			colour = 12;

   303

		}

   304

   305

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

   306

			/* Draw the cargo name */

   307

			int last_x = DrawString(2, y, _cargoc.names_s[refit[i].cargo], colour);

   308

   309

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

   310

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

   311

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

   312

			}

   313

			y += delta;

   314

		}

   315

   316

		sel--;

   317

	}

   318

   319

	return selected;

   320

}

   321

   322

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

   323

{

   324

	switch (e->event) {

   325

		case WE_PAINT: {

   326

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

   327

   328

			if (v->type == VEH_Train) {

   329

				uint length = CountVehiclesInChain(v);

   330

   331

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

   332

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

   333

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

   334

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

   335

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

   336

					WP(w, refit_d).length = length;

   337

				}

   338

			}

   339

   340

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

   341

   342

			SetDParam(0, v->string_id);

   343

			SetDParam(1, v->unitnumber);

   344

			DrawWindowWidgets(w);

   345

   346

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

   347

   348

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

   349

				int32 cost = 0;

   350

				switch (GetVehicle(w->window_number)->type) {

   351

					case VEH_Train:    cost = CMD_REFIT_RAIL_VEHICLE; break;

   352

					case VEH_Road:     cost = CMD_REFIT_ROAD_VEH;     break;

   353

					case VEH_Ship:     cost = CMD_REFIT_SHIP;         break;

   354

					case VEH_Aircraft: cost = CMD_REFIT_AIRCRAFT;     break;

   355

				}

   356

   357

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

   358

				if (!CmdFailed(cost)) {

   359

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

   360

					SetDParam(1, _returned_refit_capacity);

   361

					SetDParam(2, cost);

   362

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

   363

				}

   364

			}

   365

		}	break;

   366

   367

		case WE_CLICK:

   368

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

   369

				case 3: { // listbox

   370

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

   371

					if (y >= 0) {

   372

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

   373

						SetWindowDirty(w);

   374

					}

   375

				} break;

   376

				case 6: // refit button

   377

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

   378

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

   379

   380

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

   381

							int command = 0;

   382

   383

							switch (v->type) {

   384

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

   385

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

   386

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

   387

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

   388

							}

   389

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

   390

						} else {

   391

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

   392

						}

   393

					}

   394

					break;

   395

			}

   396

			break;

   397

   398

		case WE_RESIZE:

   399

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

   400

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

   401

			break;

   402

   403

		case WE_DESTROY:

   404

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

   405

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

   406

			break;

   407

	}

   408

}

   409

   410

   411

static const Widget _vehicle_refit_widgets[] = {

   412

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

   413

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

   414

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

   415

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

   416

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

   417

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

   418

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

   419

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

   420

	{   WIDGETS_END},

   421

};

   422

   423

static const WindowDesc _vehicle_refit_desc = {

   424

	WDP_AUTO, WDP_AUTO, 240, 174,

   425

	WC_VEHICLE_REFIT,WC_VEHICLE_VIEW,

   426

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS | WDF_RESIZABLE,

   427

	_vehicle_refit_widgets,

   428

	VehicleRefitWndProc,

   429

};

   430

   431

/** Show the refit window for a vehicle

   432

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

   433

*/

   434

void ShowVehicleRefitWindow(const Vehicle *v, VehicleOrderID order)

   435

{

   436

	Window *w;

   437

   438

	DeleteWindowById(WC_VEHICLE_REFIT, v->index);

   439

   440

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

   441

	WP(w, refit_d).order = order;

   442

   443

	if (w != NULL) {

   444

		w->caption_color = v->owner;

   445

		w->vscroll.cap = 8;

   446

		w->resize.step_height = 14;

   447

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

   448

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

   449

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

   450

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

   451

   452

		switch (v->type) {

   453

			case VEH_Train:

   454

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

   455

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

   456

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

   457

				break;

   458

			case VEH_Road:

   459

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

   460

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

   461

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

   462

				break;

   463

			case VEH_Ship:

   464

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

   465

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

   466

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

   467

				break;

   468

			case VEH_Aircraft:

   469

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

   470

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

   471

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

   472

				break;

   473

			default: NOT_REACHED();

   474

		}

   475

	}

   476

}

   477

   478

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

   479

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

   480

{

   481

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

   482

	if (callback == CALLBACK_FAILED) return 0;

   483

   484

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

   485