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

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* const *wz;

   106

   107

	FOR_ALL_WINDOWS(wz) {

   108

		Window *w = *wz;

   109

   110

		switch (w->window_class) {

   111

			case WC_TRAINS_LIST:

   112

			case WC_ROADVEH_LIST:

   113

			case WC_SHIPS_LIST:

   114

			case WC_AIRCRAFT_LIST:

   115

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

   116

				SetWindowDirty(w);

   117

				break;

   118

		}

   119

	}

   120

}

   121

   122

void ResortVehicleLists(void)

   123

{

   124

	Window* const *wz;

   125

   126

	FOR_ALL_WINDOWS(wz) {

   127

		Window *w = *wz;

   128

   129

		switch (w->window_class) {

   130

			case WC_TRAINS_LIST:

   131

			case WC_ROADVEH_LIST:

   132

			case WC_SHIPS_LIST:

   133

			case WC_AIRCRAFT_LIST:

   134

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

   135

				SetWindowDirty(w);

   136

				break;

   137

		}

   138

	}

   139

}

   140

   141

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

   142

{

   143

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

   144

   145

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

   146

   147

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

   148

   149

	vl->l.flags &= ~VL_REBUILD;

   150

	vl->l.flags |= VL_RESORT;

   151

}

   152

   153

static void SortVehicleList(vehiclelist_d *vl)

   154

{

   155

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

   156

   157

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

   158

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

   159

		_vehicle_sorter[vl->l.sort_type]);

   160

   161

	vl->l.resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   162

	vl->l.flags &= ~VL_RESORT;

   163

}

   164

   165

void DepotSortList(Vehicle **v, uint16 length)

   166

{

   167

	_internal_sort_order = 0;

   168

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

   169

}

   170

   171

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

   172

void InitializeVehiclesGuiList(void)

   173

{

   174

	_railtype_selected_in_replace_gui = RAILTYPE_RAIL;

   175

}

   176

   177

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

   178

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

   179

{

   180

	uint32 ormod;

   181

   182

	// draw profit-based colored icons

   183

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

   184

		ormod = PALETTE_TO_GREY;

   185

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

   186

		ormod = PALETTE_TO_RED;

   187

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

   188

		ormod = PALETTE_TO_YELLOW;

   189

	} else {

   190

		ormod = PALETTE_TO_GREEN;

   191

	}

   192

	DrawSprite(SPR_BLOT | ormod, x, y);

   193

}

   194

   195

typedef struct RefitOption {

   196

	CargoID cargo;

   197

	byte subtype;

   198

	uint16 value;

   199

	EngineID engine;

   200

} RefitOption;

   201

   202

typedef struct RefitList {

   203

	uint num_lines;

   204

	RefitOption *items;

   205

} RefitList;

   206

   207

static RefitList *BuildRefitList(const Vehicle *v)

   208

{

   209

	uint max_lines = 256;

   210

	RefitOption *refit;

   211

	CallocT(&refit, max_lines);

   212

	RefitList *list;

   213

	CallocT(&list, 1);

   214

	Vehicle *u = (Vehicle*)v;

   215

	uint num_lines = 0;

   216

	uint i;

   217

   218

	do {

   219

		CargoID cid;

   220

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

   221

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

   222

   223

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

   224

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

   225

   226

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

   227

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

   228

			CargoID lcid;

   229

   230

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

   231

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

   232

   233

			lcid = _local_cargo_id_ctype[cid];

   234

			if (lcid == CT_INVALID) continue;

   235

   236

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

   237

			if (HASBIT(callbackmask, CBM_CARGO_SUFFIX)) {

   238

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

   239

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

   240

				CargoID temp_cargo = u->cargo_type;

   241

				byte temp_subtype  = u->cargo_subtype;

   242

				byte refit_cyc;

   243

   244

				u->cargo_type = lcid;

   245

   246

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

   247

					bool duplicate = false;

   248

					uint16 callback;

   249

   250

					u->cargo_subtype = refit_cyc;

   251

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

   252

   253

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

   254

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

   255

   256

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

   257

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

   258

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

   259

					}

   260

   261

					if (duplicate) continue;

   262

   263

					refit[num_lines].cargo   = lcid;

   264

					refit[num_lines].subtype = refit_cyc;

   265

					refit[num_lines].value   = callback;

   266

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

   267

					num_lines++;

   268

				}

   269

   270

				/* Reset the vehicle's cargo type */

   271

				u->cargo_type    = temp_cargo;

   272

				u->cargo_subtype = temp_subtype;

   273

			} else {

   274

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

   275

				bool duplicate = false;

   276

   277

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

   278

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

   279

				}

   280

   281

				if (!duplicate) {

   282

					refit[num_lines].cargo   = lcid;

   283

					refit[num_lines].subtype = 0;

   284

					refit[num_lines].value   = CALLBACK_FAILED;

   285

					refit[num_lines].engine  = INVALID_ENGINE;

   286

					num_lines++;

   287

				}

   288

			}

   289

		}

   290

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

   291

   292

	list->num_lines = num_lines;

   293

	list->items = refit;

   294

   295

	return list;

   296

}

   297

   298

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

   299

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

   300

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

   301

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

   302

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

   303

 */

   304

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

   305

{

   306

	RefitOption *refit = list->items;

   307

	RefitOption *selected = NULL;

   308

	uint num_lines = list->num_lines;

   309

	uint y = 31;

   310

	uint i;

   311

   312

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

   313

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

   314

		byte colour = 16;

   315

		if (sel == 0) {

   316

			selected = &refit[i];

   317

			colour = 12;

   318

		}

   319

   320

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

   321

			/* Draw the cargo name */

   322

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

   323

   324

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

   325

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

   326

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

   327

			}

   328

			y += delta;

   329

		}

   330

   331

		sel--;

   332

	}

   333

   334

	return selected;

   335

}

   336

   337

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

   338

{

   339

	switch (e->event) {

   340

		case WE_PAINT: {

   341

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

   342

   343

			if (v->type == VEH_Train) {

   344

				uint length = CountVehiclesInChain(v);

   345

   346

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

   347

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

   348

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

   349

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

   350

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

   351

					WP(w, refit_d).length = length;

   352

				}

   353

			}

   354

   355

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

   356

   357

			SetDParam(0, v->string_id);

   358

			SetDParam(1, v->unitnumber);

   359

			DrawWindowWidgets(w);

   360

   361

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

   362

   363

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

   364

				int32 cost = 0;

   365

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

   366

					case VEH_Train:    cost = CMD_REFIT_RAIL_VEHICLE; break;

   367

					case VEH_Road:     cost = CMD_REFIT_ROAD_VEH;     break;

   368

					case VEH_Ship:     cost = CMD_REFIT_SHIP;         break;

   369

					case VEH_Aircraft: cost = CMD_REFIT_AIRCRAFT;     break;

   370

				}

   371

   372

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

   373

				if (!CmdFailed(cost)) {

   374

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

   375

					SetDParam(1, _returned_refit_capacity);

   376

					SetDParam(2, cost);

   377

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

   378

				}

   379

			}

   380

		}	break;

   381

   382

		case WE_CLICK:

   383

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

   384

				case 3: { // listbox

   385

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

   386

					if (y >= 0) {

   387

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

   388

						SetWindowDirty(w);

   389

					}

   390

				} break;

   391

				case 6: // refit button

   392

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

   393

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

   394

   395

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

   396

							int command = 0;

   397

   398

							switch (v->type) {

   399

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

   400

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

   401

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

   402

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

   403

							}

   404

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

   405

						} else {

   406

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

   407

						}

   408

					}

   409

					break;

   410

			}

   411

			break;

   412

   413

		case WE_RESIZE:

   414

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

   415

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

   416

			break;

   417

   418

		case WE_DESTROY:

   419

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

   420

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

   421

			break;

   422

	}

   423

}

   424

   425

   426

static const Widget _vehicle_refit_widgets[] = {

   427

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

   428

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

   429

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

   430

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

   431

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

   432

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

   433

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

   434

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

   435

	{   WIDGETS_END},

   436

};

   437

   438

static const WindowDesc _vehicle_refit_desc = {

   439

	WDP_AUTO, WDP_AUTO, 240, 174,

   440

	WC_VEHICLE_REFIT,WC_VEHICLE_VIEW,

   441

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS | WDF_RESIZABLE,

   442

	_vehicle_refit_widgets,

   443

	VehicleRefitWndProc,

   444

};

   445

   446

/** Show the refit window for a vehicle

   447

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

   448

*/

   449

void ShowVehicleRefitWindow(const Vehicle *v, VehicleOrderID order)

   450

{

   451

	Window *w;

   452

   453

	DeleteWindowById(WC_VEHICLE_REFIT, v->index);

   454

   455

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

   456

	WP(w, refit_d).order = order;

   457

   458

	if (w != NULL) {

   459

		w->caption_color = v->owner;

   460

		w->vscroll.cap = 8;

   461

		w->resize.step_height = 14;

   462

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

   463

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

   464

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

   465

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

   466

   467

		switch (v->type) {

   468

			case VEH_Train:

   469

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

   470

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

   471

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

   472

				break;

   473

			case VEH_Road:

   474

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

   475

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

   476

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

   477

				break;

   478

			case VEH_Ship:

   479

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

   480

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

   481

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

   482

				break;

   483

			case VEH_Aircraft:

   484

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

   485