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 uint32 _internal_name_sorter_id; // internal StringID for default vehicle-names

    51

static const Vehicle* _last_vehicle; // cached vehicle to hopefully speed up name-sorting

    52

static bool   _internal_sort_order;     // descending/ascending

    53

    54

static RailType _railtype_selected_in_replace_gui;

    55

    56

    57

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

    58

    59

static VehicleSortListingTypeFunction VehicleNumberSorter;

    60

static VehicleSortListingTypeFunction VehicleNameSorter;

    61

static VehicleSortListingTypeFunction VehicleAgeSorter;

    62

static VehicleSortListingTypeFunction VehicleProfitThisYearSorter;

    63

static VehicleSortListingTypeFunction VehicleProfitLastYearSorter;

    64

static VehicleSortListingTypeFunction VehicleCargoSorter;

    65

static VehicleSortListingTypeFunction VehicleReliabilitySorter;

    66

static VehicleSortListingTypeFunction VehicleMaxSpeedSorter;

    67

static VehicleSortListingTypeFunction VehicleModelSorter;

    68

static VehicleSortListingTypeFunction VehicleValueSorter;

    69

    70

static VehicleSortListingTypeFunction* const _vehicle_sorter[] = {

    71

	&VehicleNumberSorter,

    72

	&VehicleNameSorter,

    73

	&VehicleAgeSorter,

    74

	&VehicleProfitThisYearSorter,

    75

	&VehicleProfitLastYearSorter,

    76

	&VehicleCargoSorter,

    77

	&VehicleReliabilitySorter,

    78

	&VehicleMaxSpeedSorter,

    79

	&VehicleModelSorter,

    80

	&VehicleValueSorter,

    81

};

    82

    83

static const StringID _vehicle_sort_listing[] = {

    84

	STR_SORT_BY_NUMBER,

    85

	STR_SORT_BY_DROPDOWN_NAME,

    86

	STR_SORT_BY_AGE,

    87

	STR_SORT_BY_PROFIT_THIS_YEAR,

    88

	STR_SORT_BY_PROFIT_LAST_YEAR,

    89

	STR_SORT_BY_TOTAL_CAPACITY_PER_CARGOTYPE,

    90

	STR_SORT_BY_RELIABILITY,

    91

	STR_SORT_BY_MAX_SPEED,

    92

	STR_SORT_BY_MODEL,

    93

	STR_SORT_BY_VALUE,

    94

	INVALID_STRING_ID

    95

};

    96

    97

static const StringID _rail_types_list[] = {

    98

	STR_RAIL_VEHICLES,

    99

	STR_ELRAIL_VEHICLES,

   100

	STR_MONORAIL_VEHICLES,

   101

	STR_MAGLEV_VEHICLES,

   102

	INVALID_STRING_ID

   103

};

   104

   105

void RebuildVehicleLists(void)

   106

{

   107

	Window *w;

   108

   109

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

   110

		switch (w->window_class) {

   111

		case WC_TRAINS_LIST: case WC_ROADVEH_LIST:

   112

		case WC_SHIPS_LIST:  case WC_AIRCRAFT_LIST:

   113

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

   114

			SetWindowDirty(w);

   115

			break;

   116

		default: break;

   117

		}

   118

}

   119

   120

void ResortVehicleLists(void)

   121

{

   122

	Window *w;

   123

   124

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

   125

		switch (w->window_class) {

   126

		case WC_TRAINS_LIST: case WC_ROADVEH_LIST:

   127

		case WC_SHIPS_LIST:  case WC_AIRCRAFT_LIST:

   128

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

   129

			SetWindowDirty(w);

   130

			break;

   131

		default: break;

   132

		}

   133

}

   134

   135

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

   136

{

   137

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

   138

   139

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

   140

   141

	vl->l.list_length = GenerateVehicleSortList(&vl->sort_list, &vl->length_of_sort_list, vl->vehicle_type, owner, station, order, depot_airport_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;

   152

	_internal_name_sorter_id = STR_SV_TRAIN_NAME;

   153

	_last_vehicle = NULL; // used for "cache" in namesorting

   154

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

   155

		_vehicle_sorter[vl->l.sort_type]);

   156

   157

	vl->l.resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   158

	vl->l.flags &= ~VL_RESORT;

   159

}

   160

   161

   162

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

   163

void InitializeVehiclesGuiList(void)

   164

{

   165

	_railtype_selected_in_replace_gui = RAILTYPE_RAIL;

   166

}

   167

   168

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

   169

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

   170

{

   171

	uint32 ormod;

   172

   173

	// draw profit-based colored icons

   174

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

   175

		ormod = PALETTE_TO_GREY;

   176

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

   177

		ormod = PALETTE_TO_RED;

   178

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

   179

		ormod = PALETTE_TO_YELLOW;

   180

	} else {

   181

		ormod = PALETTE_TO_GREEN;

   182

	}

   183

	DrawSprite(SPR_BLOT | ormod, x, y);

   184

}

   185

   186

typedef struct RefitOption {

   187

	CargoID cargo;

   188

	byte subtype;

   189

	uint16 value;

   190

	EngineID engine;

   191

} RefitOption;

   192

   193

typedef struct RefitList {

   194

	uint num_lines;

   195

	RefitOption *items;

   196

} RefitList;

   197

   198

static RefitList *BuildRefitList(const Vehicle *v)

   199

{

   200

	uint max_lines = 256;

   201

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

   202

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

   203

	Vehicle *u = (Vehicle*)v;

   204

	uint num_lines = 0;

   205

	uint i;

   206

   207

	do {

   208

		CargoID cid;

   209

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

   210

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

   211

   212

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

   213

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

   214

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

   215

			if (!HASBIT(cmask, 0)) 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 = cid;

   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 == cid && refit[i].value == callback) duplicate = true;

   240

					}

   241

   242

					if (duplicate) continue;

   243

   244

					refit[num_lines].cargo   = cid;

   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 == cid && refit[i].value == CALLBACK_FAILED) duplicate = true;

   260

				}

   261

   262

				if (!duplicate) {

   263

					refit[num_lines].cargo   = cid;

   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

		u = u->next;

   272

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

   273

   274

	list->num_lines = num_lines;

   275

	list->items = refit;

   276

   277

	return list;

   278

}

   279

   280

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

   281

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

   282

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

   283

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

   284

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

   285

 */

   286

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

   287

{

   288

	RefitOption *refit = list->items;

   289

	RefitOption *selected = NULL;

   290

	uint num_lines = list->num_lines;

   291

	uint y = 31;

   292

	uint i;

   293

   294

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

   295

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

   296

		byte colour = 16;

   297

		if (sel == 0) {

   298

			selected = &refit[i];

   299

			colour = 12;

   300

		}

   301

   302

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

   303

			/* Draw the cargo name */

   304

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

   305

   306

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

   307

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

   308

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

   309

			}

   310

			y += delta;

   311

		}

   312

   313

		sel--;

   314

	}

   315

   316

	return selected;

   317

}

   318

   319

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

   320

{

   321

	switch (e->event) {

   322

		case WE_PAINT: {

   323

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

   324

   325

			if (v->type == VEH_Train) {

   326

				uint length = CountVehiclesInChain(v);

   327

   328

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

   329

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

   330

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

   331

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

   332

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

   333

					WP(w, refit_d).length = length;

   334

				}

   335

			}

   336

   337

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

   338

   339

			SetDParam(0, v->string_id);

   340

			SetDParam(1, v->unitnumber);

   341

			DrawWindowWidgets(w);

   342

   343

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

   344

   345

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

   346

				int32 cost = 0;

   347

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

   348

					case VEH_Train:    cost = CMD_REFIT_RAIL_VEHICLE; break;

   349

					case VEH_Road:     cost = CMD_REFIT_ROAD_VEH;     break;

   350

					case VEH_Ship:     cost = CMD_REFIT_SHIP;         break;

   351

					case VEH_Aircraft: cost = CMD_REFIT_AIRCRAFT;     break;

   352

				}

   353

   354

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

   355

				if (!CmdFailed(cost)) {

   356

					SetDParam(0, _cargoc.names_long[WP(w,refit_d).cargo->cargo]);

   357

					SetDParam(1, _returned_refit_capacity);

   358

					SetDParam(2, cost);

   359

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

   360

				}

   361

			}

   362

		}	break;

   363

   364

		case WE_CLICK:

   365

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

   366

				case 3: { // listbox

   367

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

   368

					if (y >= 0) {

   369

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

   370

						SetWindowDirty(w);

   371

					}

   372

				} break;

   373

				case 6: // refit button

   374

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

   375

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

   376

   377

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

   378

							int command = 0;

   379

   380

							switch (v->type) {

   381

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

   382

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

   383

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

   384

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

   385

							}

   386

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

   387

						} else {

   388

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

   389

						}

   390

					}

   391

					break;

   392

			}

   393

			break;

   394

   395

		case WE_RESIZE:

   396

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

   397

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

   398

			break;

   399

   400

		case WE_DESTROY:

   401

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

   402

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

   403

			break;

   404

	}

   405

}

   406

   407

   408

static const Widget _vehicle_refit_widgets[] = {

   409

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

   410

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

   411

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

   412

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

   413

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

   414

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

   415

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

   416

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

   417

	{   WIDGETS_END},

   418

};

   419

   420

static const WindowDesc _vehicle_refit_desc = {

   421

	-1,-1, 240, 174,

   422

	WC_VEHICLE_REFIT,WC_VEHICLE_VIEW,

   423

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS | WDF_RESIZABLE,

   424

	_vehicle_refit_widgets,

   425

	VehicleRefitWndProc,

   426

};

   427

   428

/** Show the refit window for a vehicle

   429

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

   430

*/

   431

void ShowVehicleRefitWindow(const Vehicle *v, VehicleOrderID order)

   432

{

   433

	Window *w;

   434

   435

	DeleteWindowById(WC_VEHICLE_REFIT, v->index);

   436

   437

	_alloc_wnd_parent_num = v->index;

   438

   439

	w = AllocateWindowDesc(&_vehicle_refit_desc);

   440

	WP(w, refit_d).order = order;

   441

   442

	if (w != NULL) {

   443

		w->window_number = v->index;

   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[6].data     = STR_RAIL_REFIT_VEHICLE;

   455

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

   456

				break;

   457

			case VEH_Road:

   458

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

   459

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

   460

				break;

   461

			case VEH_Ship:

   462

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

   463

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

   464

				break;

   465

			case VEH_Aircraft:

   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

int ShowAdditionalText(int x, int y, int 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

	DrawStringTruncated(x, y, GetGRFStringID(GetEngineGRFID(engine), 0xD000 + callback), 16, w);

   481

	return 10;

   482

}

   483

   484

   485

// if the sorting criteria had the same value, sort vehicle by unitnumber

   486

#define VEHICLEUNITNUMBERSORTER(r, a, b) {if (r == 0) {r = a->unitnumber - b->unitnumber;}}

   487