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 "resize_window_widgets.h"

    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

static RailType _railtype_selected_in_replace_gui;

    53

    54

    55

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

    56

    57

static VehicleSortListingTypeFunction VehicleNumberSorter;

    58

static VehicleSortListingTypeFunction VehicleNameSorter;

    59

static VehicleSortListingTypeFunction VehicleAgeSorter;

    60

static VehicleSortListingTypeFunction VehicleProfitThisYearSorter;

    61

static VehicleSortListingTypeFunction VehicleProfitLastYearSorter;

    62

static VehicleSortListingTypeFunction VehicleCargoSorter;

    63

static VehicleSortListingTypeFunction VehicleReliabilitySorter;

    64

static VehicleSortListingTypeFunction VehicleMaxSpeedSorter;

    65

static VehicleSortListingTypeFunction VehicleModelSorter;

    66

static VehicleSortListingTypeFunction VehicleValueSorter;

    67

    68

static VehicleSortListingTypeFunction* const _vehicle_sorter[] = {

    69

	&VehicleNumberSorter,

    70

	&VehicleNameSorter,

    71

	&VehicleAgeSorter,

    72

	&VehicleProfitThisYearSorter,

    73

	&VehicleProfitLastYearSorter,

    74

	&VehicleCargoSorter,

    75

	&VehicleReliabilitySorter,

    76

	&VehicleMaxSpeedSorter,

    77

	&VehicleModelSorter,

    78

	&VehicleValueSorter,

    79

};

    80

    81

static const StringID _vehicle_sort_listing[] = {

    82

	STR_SORT_BY_NUMBER,

    83

	STR_SORT_BY_DROPDOWN_NAME,

    84

	STR_SORT_BY_AGE,

    85

	STR_SORT_BY_PROFIT_THIS_YEAR,

    86

	STR_SORT_BY_PROFIT_LAST_YEAR,

    87

	STR_SORT_BY_TOTAL_CAPACITY_PER_CARGOTYPE,

    88

	STR_SORT_BY_RELIABILITY,

    89

	STR_SORT_BY_MAX_SPEED,

    90

	STR_SORT_BY_MODEL,

    91

	STR_SORT_BY_VALUE,

    92

	INVALID_STRING_ID

    93

};

    94

    95

static const StringID _rail_types_list[] = {

    96

	STR_RAIL_VEHICLES,

    97

	STR_ELRAIL_VEHICLES,

    98

	STR_MONORAIL_VEHICLES,

    99

	STR_MAGLEV_VEHICLES,

   100

	INVALID_STRING_ID

   101

};

   102

   103

void RebuildVehicleLists(void)

   104

{

   105

	Window *w;

   106

   107

	for (w = _windows; w != _last_window; ++w)

   108

		switch (w->window_class) {

   109

		case WC_TRAINS_LIST: case WC_ROADVEH_LIST:

   110

		case WC_SHIPS_LIST:  case WC_AIRCRAFT_LIST:

   111

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

   112

			SetWindowDirty(w);

   113

			break;

   114

		default: break;

   115

		}

   116

}

   117

   118

void ResortVehicleLists(void)

   119

{

   120

	Window *w;

   121

   122

	for (w = _windows; w != _last_window; ++w)

   123

		switch (w->window_class) {

   124

		case WC_TRAINS_LIST: case WC_ROADVEH_LIST:

   125

		case WC_SHIPS_LIST:  case WC_AIRCRAFT_LIST:

   126

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

   127

			SetWindowDirty(w);

   128

			break;

   129

		default: break;

   130

		}

   131

}

   132

   133

static void BuildVehicleList(vehiclelist_d* vl, PlayerID owner, StationID station, OrderID order, uint16 depot_airport_index, uint16 window_type)

   134

{

   135

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

   136

   137

	DEBUG(misc, 1) ("Building vehicle list for player %d station %d...", owner, station);

   138

   139

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

   140

   141

	vl->l.flags &= ~VL_REBUILD;

   142

	vl->l.flags |= VL_RESORT;

   143

}

   144

   145

static void SortVehicleList(vehiclelist_d *vl)

   146

{

   147

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

   148

   149

	_internal_sort_order = vl->l.flags & VL_DESC;

   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

/* General Vehicle GUI based procedures that are independent of vehicle types */

   164

void InitializeVehiclesGuiList(void)

   165

{

   166

	_railtype_selected_in_replace_gui = RAILTYPE_RAIL;

   167

}

   168

   169

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

   170

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

   171

{

   172

	uint32 ormod;

   173

   174

	// draw profit-based colored icons

   175

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

   176

		ormod = PALETTE_TO_GREY;

   177

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

   178

		ormod = PALETTE_TO_RED;

   179

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

   180

		ormod = PALETTE_TO_YELLOW;

   181

	} else {

   182

		ormod = PALETTE_TO_GREEN;

   183

	}

   184

	DrawSprite(SPR_BLOT | ormod, x, y);

   185

}

   186

   187

typedef struct RefitOption {

   188

	CargoID cargo;

   189

	byte subtype;

   190

	uint16 value;

   191

	EngineID engine;

   192

} RefitOption;

   193

   194

typedef struct RefitList {

   195

	uint num_lines;

   196

	RefitOption *items;

   197

} RefitList;

   198

   199

static RefitList *BuildRefitList(const Vehicle *v)

   200

{

   201

	uint max_lines = 256;

   202

	RefitOption *refit = calloc(max_lines, sizeof(*refit));

   203

	RefitList *list = calloc(1, sizeof(*list));

   204

	Vehicle *u = (Vehicle*)v;

   205

	uint num_lines = 0;

   206

	uint i;

   207

   208

	do {

   209

		CargoID cid;

   210

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

   211

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

   212

   213

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

   214

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

   215

   216

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

   217

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

   218

			CargoID lcid;

   219

   220

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

   221

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

   222

   223

			lcid = _local_cargo_id_ctype[cid];

   224

			if (lcid == CT_INVALID) continue;

   225

   226

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

   227

			if (HASBIT(callbackmask, CBM_CARGO_SUFFIX)) {

   228

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

   229

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

   230

				CargoID temp_cargo = u->cargo_type;

   231

				byte temp_subtype  = u->cargo_subtype;

   232

				byte refit_cyc;

   233

   234

				u->cargo_type = lcid;

   235

   236

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

   237

					bool duplicate = false;

   238

					uint16 callback;

   239

   240

					u->cargo_subtype = refit_cyc;

   241

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

   242

   243

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

   244

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

   245

   246

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

   247

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

   248

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

   249

					}

   250

   251

					if (duplicate) continue;

   252

   253

					refit[num_lines].cargo   = lcid;

   254

					refit[num_lines].subtype = refit_cyc;

   255

					refit[num_lines].value   = callback;

   256

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

   257

					num_lines++;

   258

				}

   259

   260

				/* Reset the vehicle's cargo type */

   261

				u->cargo_type    = temp_cargo;

   262

				u->cargo_subtype = temp_subtype;

   263

			} else {

   264

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

   265

				bool duplicate = false;

   266

   267

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

   268

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

   269

				}

   270

   271

				if (!duplicate) {

   272

					refit[num_lines].cargo   = lcid;

   273

					refit[num_lines].subtype = 0;

   274

					refit[num_lines].value   = CALLBACK_FAILED;

   275

					refit[num_lines].engine  = INVALID_ENGINE;

   276

					num_lines++;

   277

				}

   278

			}

   279

		}

   280

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

   281

   282

	list->num_lines = num_lines;

   283

	list->items = refit;

   284

   285

	return list;

   286

}

   287

   288

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

   289

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

   290

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

   291

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

   292

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

   293

 */

   294

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

   295

{

   296

	RefitOption *refit = list->items;

   297

	RefitOption *selected = NULL;

   298

	uint num_lines = list->num_lines;

   299

	uint y = 31;

   300

	uint i;

   301

   302

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

   303

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

   304

		byte colour = 16;

   305

		if (sel == 0) {

   306

			selected = &refit[i];

   307

			colour = 12;

   308

		}

   309

   310

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

   311

			/* Draw the cargo name */

   312

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

   313

   314

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

   315

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

   316

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

   317

			}

   318

			y += delta;

   319

		}

   320

   321

		sel--;

   322

	}

   323

   324

	return selected;

   325

}

   326

   327

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

   328

{

   329

	switch (e->event) {

   330

		case WE_PAINT: {

   331

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

   332

   333

			if (v->type == VEH_Train) {

   334

				uint length = CountVehiclesInChain(v);

   335

   336

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

   337

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

   338

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

   339

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

   340

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

   341

					WP(w, refit_d).length = length;

   342

				}

   343

			}

   344

   345

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

   346

   347

			SetDParam(0, v->string_id);

   348

			SetDParam(1, v->unitnumber);

   349

			DrawWindowWidgets(w);

   350

   351

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

   352

   353

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

   354

				int32 cost = 0;

   355

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

   356

					case VEH_Train:    cost = CMD_REFIT_RAIL_VEHICLE; break;

   357

					case VEH_Road:     cost = CMD_REFIT_ROAD_VEH;     break;

   358

					case VEH_Ship:     cost = CMD_REFIT_SHIP;         break;

   359

					case VEH_Aircraft: cost = CMD_REFIT_AIRCRAFT;     break;

   360

				}

   361

   362

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

   363

				if (!CmdFailed(cost)) {

   364

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

   365

					SetDParam(1, _returned_refit_capacity);

   366

					SetDParam(2, cost);

   367

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

   368

				}

   369

			}

   370

		}	break;

   371

   372

		case WE_CLICK:

   373

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

   374

				case 3: { // listbox

   375

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

   376

					if (y >= 0) {

   377

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

   378

						SetWindowDirty(w);

   379

					}

   380

				} break;

   381

				case 6: // refit button

   382

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

   383

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

   384

   385

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

   386

							int command = 0;

   387

   388

							switch (v->type) {

   389

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

   390

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

   391

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

   392

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

   393

							}

   394

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

   395

						} else {

   396

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

   397

						}

   398

					}

   399

					break;

   400

			}

   401

			break;

   402

   403

		case WE_RESIZE:

   404

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

   405

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

   406

			break;

   407

   408

		case WE_DESTROY:

   409

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

   410

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

   411

			break;

   412

	}

   413

}

   414

   415

   416

static const Widget _vehicle_refit_widgets[] = {

   417

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

   418

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

   419

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

   420

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

   421

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

   422

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

   423

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

   424

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

   425

	{   WIDGETS_END},

   426

};

   427

   428

static const WindowDesc _vehicle_refit_desc = {

   429

	WDP_AUTO, WDP_AUTO, 240, 174,

   430

	WC_VEHICLE_REFIT,WC_VEHICLE_VIEW,

   431

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS | WDF_RESIZABLE,

   432

	_vehicle_refit_widgets,

   433

	VehicleRefitWndProc,

   434

};

   435

   436

/** Show the refit window for a vehicle

   437

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

   438

*/

   439

void ShowVehicleRefitWindow(const Vehicle *v, VehicleOrderID order)

   440

{

   441

	Window *w;

   442

   443

	DeleteWindowById(WC_VEHICLE_REFIT, v->index);

   444

   445

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

   446

	WP(w, refit_d).order = order;

   447

   448

	if (w != NULL) {

   449

		w->window_number = v->index;

   450

		w->caption_color = v->owner;

   451

		w->vscroll.cap = 8;

   452

		w->resize.step_height = 14;

   453

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

   454

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

   455

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

   456

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

   457

   458

		switch (v->type) {

   459

			case VEH_Train:

   460

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

   461

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

   462

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

   463

				break;

   464

			case VEH_Road:

   465

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

   466

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

   467

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

   468

				break;

   469

			case VEH_Ship:

   470

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

   471

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

   472

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

   473

				break;

   474

			case VEH_Aircraft:

   475

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

   476

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

   477

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

   478

				break;

   479

			default: NOT_REACHED();

   480

		}

   481

	}

   482

}

   483

   484

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

   485

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