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

	}

   109

}

   110

   111

void ResortVehicleLists(void)

   112

{

   113

	Window* const *wz;

   114

   115

	FOR_ALL_WINDOWS(wz) {

   116

		Window *w = *wz;

   117

   118

		switch (w->window_class) {

   119

			case WC_TRAINS_LIST:

   120

			case WC_ROADVEH_LIST:

   121

			case WC_SHIPS_LIST:

   122

			case WC_AIRCRAFT_LIST:

   123

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

   124

				SetWindowDirty(w);

   125

				break;

   126

		}

   127

	}

   128

}

   129

   130

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

   131

{

   132

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

   133

   134

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

   135

   136

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

   137

   138

	vl->l.flags &= ~VL_REBUILD;

   139

	vl->l.flags |= VL_RESORT;

   140

}

   141

   142

static void SortVehicleList(vehiclelist_d *vl)

   143

{

   144

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

   145

   146

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

   147

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

   148

		_vehicle_sorter[vl->l.sort_type]);

   149

   150

	vl->l.resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   151

	vl->l.flags &= ~VL_RESORT;

   152

}

   153

   154

void DepotSortList(Vehicle **v, uint16 length)

   155

{

   156

	_internal_sort_order = 0;

   157

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

   158

}

   159

   160

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

   161

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

   162

{

   163

	SpriteID pal;

   164

   165

	// draw profit-based colored icons

   166

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

   167

		pal = PALETTE_TO_GREY;

   168

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

   169

		pal = PALETTE_TO_RED;

   170

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

   171

		pal = PALETTE_TO_YELLOW;

   172

	} else {

   173

		pal = PALETTE_TO_GREEN;

   174

	}

   175

	DrawSprite(SPR_BLOT, pal, x, y);

   176

}

   177

   178

typedef struct RefitOption {

   179

	CargoID cargo;

   180

	byte subtype;

   181

	uint16 value;

   182

	EngineID engine;

   183

} RefitOption;

   184

   185

typedef struct RefitList {

   186

	uint num_lines;

   187

	RefitOption *items;

   188

} RefitList;

   189

   190

static RefitList *BuildRefitList(const Vehicle *v)

   191

{

   192

	uint max_lines = 256;

   193

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

   194

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

   195

	Vehicle *u = (Vehicle*)v;

   196

	uint num_lines = 0;

   197

	uint i;

   198

   199

	do {

   200

		CargoID cid;

   201

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

   202

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

   203

   204

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

   205

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

   206

   207

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

   208

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

   209

			CargoID lcid;

   210

   211

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

   212

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

   213

   214

			lcid = _local_cargo_id_ctype[cid];

   215

			if (lcid == CT_INVALID) continue;

   216

   217

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

   218

			if (HASBIT(callbackmask, CBM_CARGO_SUFFIX)) {

   219

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

   220

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

   221

				CargoID temp_cargo = u->cargo_type;

   222

				byte temp_subtype  = u->cargo_subtype;

   223

				byte refit_cyc;

   224

   225

				u->cargo_type = lcid;

   226

   227

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

   228

					bool duplicate = false;

   229

					uint16 callback;

   230

   231

					u->cargo_subtype = refit_cyc;

   232

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

   233

   234

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

   235

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

   236

   237

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

   238

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

   239

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

   240

					}

   241

   242

					if (duplicate) continue;

   243

   244

					refit[num_lines].cargo   = lcid;

   245

					refit[num_lines].subtype = refit_cyc;

   246

					refit[num_lines].value   = callback;

   247

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

   248

					num_lines++;

   249

				}

   250

   251

				/* Reset the vehicle's cargo type */

   252

				u->cargo_type    = temp_cargo;

   253

				u->cargo_subtype = temp_subtype;

   254

			} else {

   255

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

   256

				bool duplicate = false;

   257

   258

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

   259

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

   260

				}

   261

   262

				if (!duplicate) {

   263

					refit[num_lines].cargo   = lcid;

   264

					refit[num_lines].subtype = 0;

   265

					refit[num_lines].value   = CALLBACK_FAILED;

   266

					refit[num_lines].engine  = INVALID_ENGINE;

   267

					num_lines++;

   268

				}

   269

			}

   270

		}

   271

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

   272

   273

	list->num_lines = num_lines;

   274

	list->items = refit;

   275

   276

	return list;

   277

}

   278

   279

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

   280

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

   281

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

   282

 * @param sel selected refit cargo-type in the 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

		byte colour = 16;

   296

		if (sel == 0) {

   297

			selected = &refit[i];

   298

			colour = 12;

   299

		}

   300

   301

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

   302

			/* Draw the cargo name */

   303

			int last_x = DrawString(2, y, _cargoc.names_s[refit[i].cargo], 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->string_id);

   339

			SetDParam(1, v->unitnumber);

   340

			DrawWindowWidgets(w);

   341

   342

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

   343

   344

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

   345

				int32 cost = 0;

   346

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

   347

					case VEH_Train:    cost = CMD_REFIT_RAIL_VEHICLE; break;

   348

					case VEH_Road:     cost = CMD_REFIT_ROAD_VEH;     break;

   349

					case VEH_Ship:     cost = CMD_REFIT_SHIP;         break;

   350

					case VEH_Aircraft: cost = CMD_REFIT_AIRCRAFT;     break;

   351

				}

   352

   353

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

   354

				if (!CmdFailed(cost)) {

   355

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

   356

					SetDParam(1, _returned_refit_capacity);

   357

					SetDParam(2, cost);

   358

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

   359

				}

   360

			}

   361

		}	break;

   362

   363

		case WE_CLICK:

   364

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

   365

				case 3: { // listbox

   366

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

   367

					if (y >= 0) {

   368

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

   369

						SetWindowDirty(w);

   370

					}

   371

				} break;

   372

				case 6: // refit button

   373

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

   374

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

   375

   376

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

   377

							int command = 0;

   378

   379

							switch (v->type) {

   380

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

   381

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

   382

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

   383

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

   384

							}

   385

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

   386

						} else {

   387

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

   388

						}

   389

					}

   390

					break;

   391

			}

   392

			break;

   393

   394

		case WE_RESIZE:

   395

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

   396

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

   397

			break;

   398

   399

		case WE_DESTROY:

   400

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

   401

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

   402

			break;

   403

	}

   404

}

   405

   406

   407

static const Widget _vehicle_refit_widgets[] = {

   408

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

   409

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

   410

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

   411

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

   412

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

   413

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

   414

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

   415

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

   416

	{   WIDGETS_END},

   417

};

   418

   419

static const WindowDesc _vehicle_refit_desc = {

   420

	WDP_AUTO, WDP_AUTO, 240, 174,

   421

	WC_VEHICLE_REFIT,WC_VEHICLE_VIEW,

   422

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS | WDF_RESIZABLE,

   423

	_vehicle_refit_widgets,

   424

	VehicleRefitWndProc,

   425

};

   426

   427

/** Show the refit window for a vehicle

   428

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

   429

*/

   430

void ShowVehicleRefitWindow(const Vehicle *v, VehicleOrderID order)

   431

{

   432

	Window *w;

   433

   434

	DeleteWindowById(WC_VEHICLE_REFIT, v->index);

   435

   436

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

   437

	WP(w, refit_d).order = order;

   438

   439

	if (w != NULL) {

   440

		w->caption_color = v->owner;

   441

		w->vscroll.cap = 8;

   442

		w->resize.step_height = 14;

   443

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

   444

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

   445

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

   446

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

   447

   448

		switch (v->type) {

   449

			case VEH_Train:

   450

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

   451

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

   452

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

   453

				break;

   454

			case VEH_Road:

   455

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

   456

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

   457

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

   458

				break;

   459

			case VEH_Ship:

   460

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

   461

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

   462

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

   463

				break;

   464

			case VEH_Aircraft:

   465

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

   466

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

   467

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

   468

				break;

   469

			default: NOT_REACHED();

   470

		}

   471

	}

   472

}

   473

   474

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

   475

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

   476

{

   477

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

   478

	if (callback == CALLBACK_FAILED) return 0;

   479

   480

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

   481

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

   482

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

   483

}

   484

   485