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

void DepotSortList(Vehicle **v, uint16 length)

   162

{

   163

	_internal_sort_order = 0;

   164

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

   165

}

   166

   167

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

   168

void InitializeVehiclesGuiList(void)

   169

{

   170

	_railtype_selected_in_replace_gui = RAILTYPE_RAIL;

   171

}

   172

   173

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

   174

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

   175

{

   176

	uint32 ormod;

   177

   178

	// draw profit-based colored icons

   179

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

   180

		ormod = PALETTE_TO_GREY;

   181

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

   182

		ormod = PALETTE_TO_RED;

   183

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

   184

		ormod = PALETTE_TO_YELLOW;

   185

	} else {

   186

		ormod = PALETTE_TO_GREEN;

   187

	}

   188

	DrawSprite(SPR_BLOT | ormod, x, y);

   189

}

   190

   191

typedef struct RefitOption {

   192

	CargoID cargo;

   193

	byte subtype;

   194

	uint16 value;

   195

	EngineID engine;

   196

} RefitOption;

   197

   198

typedef struct RefitList {

   199

	uint num_lines;

   200

	RefitOption *items;

   201

} RefitList;

   202

   203

static RefitList *BuildRefitList(const Vehicle *v)

   204

{

   205

	uint max_lines = 256;

   206

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

   207

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

   208

	Vehicle *u = (Vehicle*)v;

   209

	uint num_lines = 0;

   210

	uint i;

   211

   212

	do {

   213

		CargoID cid;

   214

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

   215

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

   216

   217

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

   218

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

   219

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

   220

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

   221

   222

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

   223

			if (HASBIT(callbackmask, CBM_CARGO_SUFFIX)) {

   224

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

   225

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

   226

				CargoID temp_cargo = u->cargo_type;

   227

				byte temp_subtype  = u->cargo_subtype;

   228

				byte refit_cyc;

   229

   230

				u->cargo_type = cid;

   231

   232

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

   233

					bool duplicate = false;

   234

					uint16 callback;

   235

   236

					u->cargo_subtype = refit_cyc;

   237

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

   238

   239

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

   240

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

   241

   242

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

   243

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

   244

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

   245

					}

   246

   247

					if (duplicate) continue;

   248

   249

					refit[num_lines].cargo   = cid;

   250

					refit[num_lines].subtype = refit_cyc;

   251

					refit[num_lines].value   = callback;

   252

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

   253

					num_lines++;

   254

				}

   255

   256

				/* Reset the vehicle's cargo type */

   257

				u->cargo_type    = temp_cargo;

   258

				u->cargo_subtype = temp_subtype;

   259

			} else {

   260

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

   261

				bool duplicate = false;

   262

   263

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

   264

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

   265

				}

   266

   267

				if (!duplicate) {

   268

					refit[num_lines].cargo   = cid;

   269

					refit[num_lines].subtype = 0;

   270

					refit[num_lines].value   = CALLBACK_FAILED;

   271

					refit[num_lines].engine  = INVALID_ENGINE;

   272

					num_lines++;

   273

				}

   274

			}

   275

		}

   276

		u = u->next;

   277

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

   278

   279

	list->num_lines = num_lines;

   280

	list->items = refit;

   281

   282

	return list;

   283

}

   284

   285

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

   286

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

   287

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

   288

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

   289

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

   290

 */

   291

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

   292

{

   293

	RefitOption *refit = list->items;

   294

	RefitOption *selected = NULL;

   295

	uint num_lines = list->num_lines;

   296

	uint y = 31;

   297

	uint i;

   298

   299

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

   300

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

   301

		byte colour = 16;

   302

		if (sel == 0) {

   303

			selected = &refit[i];

   304

			colour = 12;

   305

		}

   306

   307

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

   308

			/* Draw the cargo name */

   309

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

   310

   311

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

   312

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

   313

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

   314

			}

   315

			y += delta;

   316

		}

   317

   318

		sel--;

   319

	}

   320

   321

	return selected;

   322

}

   323

   324

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

   325

{

   326

	switch (e->event) {

   327

		case WE_PAINT: {

   328

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

   329

   330

			if (v->type == VEH_Train) {

   331

				uint length = CountVehiclesInChain(v);

   332

   333

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

   334

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

   335

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

   336

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

   337

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

   338

					WP(w, refit_d).length = length;

   339

				}

   340

			}

   341

   342

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

   343

   344

			SetDParam(0, v->string_id);

   345

			SetDParam(1, v->unitnumber);

   346

			DrawWindowWidgets(w);

   347

   348

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

   349

   350

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

   351

				int32 cost = 0;

   352

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

   353

					case VEH_Train:    cost = CMD_REFIT_RAIL_VEHICLE; break;

   354

					case VEH_Road:     cost = CMD_REFIT_ROAD_VEH;     break;

   355

					case VEH_Ship:     cost = CMD_REFIT_SHIP;         break;

   356

					case VEH_Aircraft: cost = CMD_REFIT_AIRCRAFT;     break;

   357

				}

   358

   359

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

   360

				if (!CmdFailed(cost)) {

   361

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

   362

					SetDParam(1, _returned_refit_capacity);

   363

					SetDParam(2, cost);

   364

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

   365

				}

   366

			}

   367

		}	break;

   368

   369

		case WE_CLICK:

   370

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

   371

				case 3: { // listbox

   372

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

   373

					if (y >= 0) {

   374

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

   375

						SetWindowDirty(w);

   376

					}

   377

				} break;

   378

				case 6: // refit button

   379

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

   380

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

   381

   382

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

   383

							int command = 0;

   384

   385

							switch (v->type) {

   386

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

   387

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

   388

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

   389

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

   390

							}

   391

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

   392

						} else {

   393

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

   394

						}

   395

					}

   396

					break;

   397

			}

   398

			break;

   399

   400

		case WE_RESIZE:

   401

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

   402

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

   403

			break;

   404

   405

		case WE_DESTROY:

   406

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

   407

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

   408

			break;

   409

	}

   410

}

   411

   412

   413

static const Widget _vehicle_refit_widgets[] = {

   414

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

   415

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

   416

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

   417

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

   418

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

   419

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

   420

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

   421

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

   422

	{   WIDGETS_END},

   423

};

   424

   425

static const WindowDesc _vehicle_refit_desc = {

   426

	-1,-1, 240, 174,

   427

	WC_VEHICLE_REFIT,WC_VEHICLE_VIEW,

   428

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS | WDF_RESIZABLE,

   429

	_vehicle_refit_widgets,

   430

	VehicleRefitWndProc,

   431

};

   432

   433

/** Show the refit window for a vehicle

   434

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

   435

*/

   436

void ShowVehicleRefitWindow(const Vehicle *v, VehicleOrderID order)

   437

{

   438

	Window *w;

   439

   440

	DeleteWindowById(WC_VEHICLE_REFIT, v->index);

   441

   442

	_alloc_wnd_parent_num = v->index;

   443

   444

	w = AllocateWindowDesc(&_vehicle_refit_desc);

   445

	WP(w, refit_d).order = order;

   446

   447

	if (w != NULL) {

   448

		w->window_number = v->index;

   449

		w->caption_color = v->owner;

   450

		w->vscroll.cap = 8;

   451

		w->resize.step_height = 14;

   452

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

   453

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

   454

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

   455

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

   456

   457

		switch (v->type) {

   458

			case VEH_Train:

   459

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

   460

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

   461

				break;

   462

			case VEH_Road:

   463

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

   464

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

   465

				break;

   466

			case VEH_Ship:

   467

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

   468

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

   469

				break;

   470

			case VEH_Aircraft:

   471

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

   472

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

   473

				break;

   474

			default: NOT_REACHED();

   475

		}

   476

	}

   477

}

   478

   479

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

   480

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

   481

{

   482

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

   483

	if (callback == CALLBACK_FAILED) return 0;

   484

   485

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

   486

	return 10;

   487

}