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

#include "cargotype.h"

    32

    33

struct Sorting {

    34

	Listing aircraft;

    35

	Listing roadveh;

    36

	Listing ship;

    37

	Listing train;

    38

};

    39

    40

static Sorting _sorting;

    41

    42

struct vehiclelist_d {

    43

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

    44

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

    45

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

    46

	byte vehicle_type;          // The vehicle type that is sorted

    47

	list_d l;                   // General list struct

    48

};

    49

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(vehiclelist_d));

    50

    51

static bool   _internal_sort_order;     // descending/ascending

    52

    53

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

    54

    55

static VehicleSortListingTypeFunction VehicleNumberSorter;

    56

static VehicleSortListingTypeFunction VehicleNameSorter;

    57

static VehicleSortListingTypeFunction VehicleAgeSorter;

    58

static VehicleSortListingTypeFunction VehicleProfitThisYearSorter;

    59

static VehicleSortListingTypeFunction VehicleProfitLastYearSorter;

    60

static VehicleSortListingTypeFunction VehicleCargoSorter;

    61

static VehicleSortListingTypeFunction VehicleReliabilitySorter;

    62

static VehicleSortListingTypeFunction VehicleMaxSpeedSorter;

    63

static VehicleSortListingTypeFunction VehicleModelSorter;

    64

static VehicleSortListingTypeFunction VehicleValueSorter;

    65

    66

static VehicleSortListingTypeFunction* const _vehicle_sorter[] = {

    67

	&VehicleNumberSorter,

    68

	&VehicleNameSorter,

    69

	&VehicleAgeSorter,

    70

	&VehicleProfitThisYearSorter,

    71

	&VehicleProfitLastYearSorter,

    72

	&VehicleCargoSorter,

    73

	&VehicleReliabilitySorter,

    74

	&VehicleMaxSpeedSorter,

    75

	&VehicleModelSorter,

    76

	&VehicleValueSorter,

    77

};

    78

    79

static const StringID _vehicle_sort_listing[] = {

    80

	STR_SORT_BY_NUMBER,

    81

	STR_SORT_BY_DROPDOWN_NAME,

    82

	STR_SORT_BY_AGE,

    83

	STR_SORT_BY_PROFIT_THIS_YEAR,

    84

	STR_SORT_BY_PROFIT_LAST_YEAR,

    85

	STR_SORT_BY_TOTAL_CAPACITY_PER_CARGOTYPE,

    86

	STR_SORT_BY_RELIABILITY,

    87

	STR_SORT_BY_MAX_SPEED,

    88

	STR_SORT_BY_MODEL,

    89

	STR_SORT_BY_VALUE,

    90

	INVALID_STRING_ID

    91

};

    92

    93

void RebuildVehicleLists()

    94

{

    95

	Window* const *wz;

    96

    97

	FOR_ALL_WINDOWS(wz) {

    98

		Window *w = *wz;

    99

   100

		switch (w->window_class) {

   101

			case WC_TRAINS_LIST:

   102

			case WC_ROADVEH_LIST:

   103

			case WC_SHIPS_LIST:

   104

			case WC_AIRCRAFT_LIST:

   105

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

   106

				SetWindowDirty(w);

   107

				break;

   108

   109

			default: break;

   110

		}

   111

	}

   112

}

   113

   114

void ResortVehicleLists()

   115

{

   116

	Window* const *wz;

   117

   118

	FOR_ALL_WINDOWS(wz) {

   119

		Window *w = *wz;

   120

   121

		switch (w->window_class) {

   122

			case WC_TRAINS_LIST:

   123

			case WC_ROADVEH_LIST:

   124

			case WC_SHIPS_LIST:

   125

			case WC_AIRCRAFT_LIST:

   126

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

   127

				SetWindowDirty(w);

   128

				break;

   129

   130

			default: break;

   131

		}

   132

	}

   133

}

   134

   135

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

   136

{

   137

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

   138

   139

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

   140

   141

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

   142

   143

	vl->l.flags &= ~VL_REBUILD;

   144

	vl->l.flags |= VL_RESORT;

   145

}

   146

   147

static void SortVehicleList(vehiclelist_d *vl)

   148

{

   149

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

   150

   151

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

   152

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

   153

		_vehicle_sorter[vl->l.sort_type]);

   154

   155

	vl->l.resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   156

	vl->l.flags &= ~VL_RESORT;

   157

}

   158

   159

void DepotSortList(Vehicle **v, uint16 length)

   160

{

   161

	_internal_sort_order = 0;

   162

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

   163

}

   164

   165

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

   166

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

   167

{

   168

	SpriteID pal;

   169

   170

	// draw profit-based colored icons

   171

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

   172

		pal = PALETTE_TO_GREY;

   173

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

   174

		pal = PALETTE_TO_RED;

   175

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

   176

		pal = PALETTE_TO_YELLOW;

   177

	} else {

   178

		pal = PALETTE_TO_GREEN;

   179

	}

   180

	DrawSprite(SPR_BLOT, pal, x, y);

   181

}

   182

   183

struct RefitOption {

   184

	CargoID cargo;

   185

	byte subtype;

   186

	uint16 value;

   187

	EngineID engine;

   188

};

   189

   190

struct RefitList {

   191

	uint num_lines;

   192

	RefitOption *items;

   193

};

   194

   195

static RefitList *BuildRefitList(const Vehicle *v)

   196

{

   197

	uint max_lines = 256;

   198

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

   199

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

   200

	Vehicle *u = (Vehicle*)v;

   201

	uint num_lines = 0;

   202

	uint i;

   203

   204

	do {

   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 (CargoID cid = 0; cid < NUM_CARGO && num_lines < max_lines; cid++) {

   213

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

   214

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

   215

   216

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

   217

			if (HASBIT(callbackmask, CBM_CARGO_SUFFIX)) {

   218

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

   219

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

   220

				CargoID temp_cargo = u->cargo_type;

   221

				byte temp_subtype  = u->cargo_subtype;

   222

				byte refit_cyc;

   223

   224

				u->cargo_type = cid;

   225

   226

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

   227

					bool duplicate = false;

   228

					uint16 callback;

   229

   230

					u->cargo_subtype = refit_cyc;

   231

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

   232

   233

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

   234

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

   235

   236

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

   237

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

   238

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

   239

					}

   240

   241

					if (duplicate) continue;

   242

   243

					refit[num_lines].cargo   = cid;

   244

					refit[num_lines].subtype = refit_cyc;

   245

					refit[num_lines].value   = callback;

   246

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

   247

					num_lines++;

   248

				}

   249

   250

				/* Reset the vehicle's cargo type */

   251

				u->cargo_type    = temp_cargo;

   252

				u->cargo_subtype = temp_subtype;

   253

			} else {

   254

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

   255

				bool duplicate = false;

   256

   257

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

   258

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

   259

				}

   260

   261

				if (!duplicate) {

   262

					refit[num_lines].cargo   = cid;

   263

					refit[num_lines].subtype = 0;

   264

					refit[num_lines].value   = CALLBACK_FAILED;

   265

					refit[num_lines].engine  = INVALID_ENGINE;

   266

					num_lines++;

   267

				}

   268

			}

   269

		}

   270

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

   271

   272

	list->num_lines = num_lines;

   273

	list->items = refit;

   274

   275

	return list;

   276

}

   277

   278

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

   279

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

   280

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

   281

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

   282

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

   283

 */

   284

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

   285

{

   286

	RefitOption *refit = list->items;

   287

	RefitOption *selected = NULL;

   288

	uint num_lines = list->num_lines;

   289

	uint y = 31;

   290

	uint i;

   291

   292

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

   293

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

   294

		byte colour = 16;

   295

		if (sel == 0) {

   296

			selected = &refit[i];

   297

			colour = 12;

   298

		}

   299

   300

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

   301

			/* Draw the cargo name */

   302

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

   303

   304

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

   305

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

   306

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

   307

			}

   308

			y += delta;

   309

		}

   310

   311

		sel--;

   312

	}

   313

   314

	return selected;

   315

}

   316

   317

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

   318

{

   319

	switch (e->event) {

   320

		case WE_PAINT: {

   321

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

   322

   323

			if (v->type == VEH_TRAIN) {

   324

				uint length = CountVehiclesInChain(v);

   325

   326

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

   327

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

   328

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

   329

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

   330

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

   331

					WP(w, refit_d).length = length;

   332

				}

   333

			}

   334

   335

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

   336

   337

			SetDParam(0, v->string_id);

   338

			SetDParam(1, v->unitnumber);

   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

				int32 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 (!CmdFailed(cost)) {

   350

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

   351

					SetDParam(1, _returned_refit_capacity);

   352

					SetDParam(2, cost);

   353

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

   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

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

   376

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

   377

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

   378

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

   379

							}

   380

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

   381

						} else {

   382

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

   383

						}

   384

					}

   385

					break;

   386

			}

   387

			break;

   388

   389

		case WE_RESIZE:

   390

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

   391

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

   392

			break;

   393

   394

		case WE_DESTROY:

   395

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

   396

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

   397

			break;

   398

	}

   399

}

   400

   401

   402

static const Widget _vehicle_refit_widgets[] = {

   403

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

   404

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

   405

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

   406

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

   407

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

   408

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

   409

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

   410

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

   411

	{   WIDGETS_END},

   412

};

   413

   414

static const WindowDesc _vehicle_refit_desc = {

   415

	WDP_AUTO, WDP_AUTO, 240, 174,

   416

	WC_VEHICLE_REFIT,WC_VEHICLE_VIEW,

   417

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS | WDF_RESIZABLE,

   418

	_vehicle_refit_widgets,

   419

	VehicleRefitWndProc,

   420

};

   421

   422

/** Show the refit window for a vehicle

   423

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

   424

*/

   425

void ShowVehicleRefitWindow(const Vehicle *v, VehicleOrderID order)

   426

{

   427

	Window *w;

   428

   429

	DeleteWindowById(WC_VEHICLE_REFIT, v->index);

   430

   431

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

   432

	WP(w, refit_d).order = order;

   433

   434

	if (w != NULL) {

   435

		w->caption_color = v->owner;

   436

		w->vscroll.cap = 8;

   437

		w->resize.step_height = 14;

   438

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

   439

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

   440

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

   441

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

   442

   443

		switch (v->type) {

   444

			case VEH_TRAIN:

   445

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

   446

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

   447

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

   448

				break;

   449

			case VEH_ROAD:

   450

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

   451

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

   452

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

   453

				break;

   454

			case VEH_SHIP:

   455

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

   456

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

   457

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

   458

				break;

   459

			case VEH_AIRCRAFT:

   460

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

   461

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

   462

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

   463

				break;

   464

			default: NOT_REACHED();

   465

		}

   466

	}

   467

}

   468

   469

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

   470

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

   471

{

   472

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

   473

	if (callback == CALLBACK_FAILED) return 0;

   474

   475

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

   476

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

   477

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

   478

}

   479

   480

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

   481

static uint CountBits(uint32 mask)

   482

{