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

    31

typedef struct Sorting {

    32

	Listing aircraft;

    33

	Listing roadveh;

    34

	Listing ship;

    35

	Listing train;

    36

} Sorting;

    37

    38

static Sorting _sorting;

    39

    40

typedef struct vehiclelist_d {

    41

	const Vehicle** sort_list;  // List of vehicles (sorted)

    42

	Listing *_sorting;          // pointer to the appropiate subcategory of _sorting

    43

	uint16 length_of_sort_list; // Keeps track of how many vehicle pointers sort list got space for

    44

	byte vehicle_type;          // The vehicle type that is sorted

    45

	list_d l;                   // General list struct

    46

} vehiclelist_d;

    47

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(vehiclelist_d));

    48

    49

static bool   _internal_sort_order;     // descending/ascending

    50

    51

static RailType _railtype_selected_in_replace_gui;

    52

    53

    54

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

    55

    56

static VehicleSortListingTypeFunction VehicleNumberSorter;

    57

static VehicleSortListingTypeFunction VehicleNameSorter;

    58

static VehicleSortListingTypeFunction VehicleAgeSorter;

    59

static VehicleSortListingTypeFunction VehicleProfitThisYearSorter;

    60

static VehicleSortListingTypeFunction VehicleProfitLastYearSorter;

    61

static VehicleSortListingTypeFunction VehicleCargoSorter;

    62

static VehicleSortListingTypeFunction VehicleReliabilitySorter;

    63

static VehicleSortListingTypeFunction VehicleMaxSpeedSorter;

    64

static VehicleSortListingTypeFunction VehicleModelSorter;

    65

static VehicleSortListingTypeFunction VehicleValueSorter;

    66

    67

static VehicleSortListingTypeFunction* const _vehicle_sorter[] = {

    68

	&VehicleNumberSorter,

    69

	&VehicleNameSorter,

    70

	&VehicleAgeSorter,

    71

	&VehicleProfitThisYearSorter,

    72

	&VehicleProfitLastYearSorter,

    73

	&VehicleCargoSorter,

    74

	&VehicleReliabilitySorter,

    75

	&VehicleMaxSpeedSorter,

    76

	&VehicleModelSorter,

    77

	&VehicleValueSorter,

    78

};

    79

    80

static const StringID _vehicle_sort_listing[] = {

    81

	STR_SORT_BY_NUMBER,

    82

	STR_SORT_BY_DROPDOWN_NAME,

    83

	STR_SORT_BY_AGE,

    84

	STR_SORT_BY_PROFIT_THIS_YEAR,

    85

	STR_SORT_BY_PROFIT_LAST_YEAR,

    86

	STR_SORT_BY_TOTAL_CAPACITY_PER_CARGOTYPE,

    87

	STR_SORT_BY_RELIABILITY,

    88

	STR_SORT_BY_MAX_SPEED,

    89

	STR_SORT_BY_MODEL,

    90

	STR_SORT_BY_VALUE,

    91

	INVALID_STRING_ID

    92

};

    93

    94

static const StringID _rail_types_list[] = {

    95

	STR_RAIL_VEHICLES,

    96

	STR_ELRAIL_VEHICLES,

    97

	STR_MONORAIL_VEHICLES,

    98

	STR_MAGLEV_VEHICLES,

    99

	INVALID_STRING_ID

   100

};

   101

   102

void RebuildVehicleLists(void)

   103

{

   104

	Window* const *wz;

   105

   106

	FOR_ALL_WINDOWS(wz) {

   107

		Window *w = *wz;

   108

   109

		switch (w->window_class) {

   110

			case WC_TRAINS_LIST:

   111

			case WC_ROADVEH_LIST:

   112

			case WC_SHIPS_LIST:

   113

			case WC_AIRCRAFT_LIST:

   114

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

   115

				SetWindowDirty(w);

   116

				break;

   117

		}

   118

	}

   119

}

   120

   121

void ResortVehicleLists(void)

   122

{

   123

	Window* const *wz;

   124

   125

	FOR_ALL_WINDOWS(wz) {

   126

		Window *w = *wz;

   127

   128

		switch (w->window_class) {

   129

			case WC_TRAINS_LIST:

   130

			case WC_ROADVEH_LIST:

   131

			case WC_SHIPS_LIST:

   132

			case WC_AIRCRAFT_LIST:

   133

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

   134

				SetWindowDirty(w);

   135

				break;

   136

		}

   137

	}

   138

}

   139

   140

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

   141

{

   142

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

   143

   144

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

   145

   146

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

   147

   148

	vl->l.flags &= ~VL_REBUILD;

   149

	vl->l.flags |= VL_RESORT;

   150

}

   151

   152

static void SortVehicleList(vehiclelist_d *vl)

   153

{

   154

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

   155

   156

	_internal_sort_order = vl->l.flags & VL_DESC;

   157

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

   158

		_vehicle_sorter[vl->l.sort_type]);

   159

   160

	vl->l.resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   161

	vl->l.flags &= ~VL_RESORT;

   162

}

   163

   164

void DepotSortList(Vehicle **v, uint16 length)

   165

{

   166

	_internal_sort_order = 0;

   167

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

   168

}

   169

   170

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

   171

void InitializeVehiclesGuiList(void)

   172

{

   173

	_railtype_selected_in_replace_gui = RAILTYPE_RAIL;

   174

}

   175

   176

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

   177

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

   178

{

   179

	uint32 ormod;

   180

   181

	// draw profit-based colored icons

   182

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

   183

		ormod = PALETTE_TO_GREY;

   184

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

   185

		ormod = PALETTE_TO_RED;

   186

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

   187

		ormod = PALETTE_TO_YELLOW;

   188

	} else {

   189

		ormod = PALETTE_TO_GREEN;

   190

	}

   191

	DrawSprite(SPR_BLOT | ormod, x, y);

   192

}

   193

   194

typedef struct RefitOption {

   195

	CargoID cargo;

   196

	byte subtype;

   197

	uint16 value;

   198

	EngineID engine;

   199

} RefitOption;

   200

   201

typedef struct RefitList {

   202

	uint num_lines;

   203

	RefitOption *items;

   204

} RefitList;

   205

   206

static RefitList *BuildRefitList(const Vehicle *v)

   207

{

   208

	uint max_lines = 256;

   209

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

   210

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

   211

	Vehicle *u = (Vehicle*)v;

   212

	uint num_lines = 0;

   213

	uint i;

   214

   215

	do {

   216

		CargoID cid;

   217

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

   218

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

   219

   220

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

   221

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

   222

   223

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

   224

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

   225

			CargoID lcid;

   226

   227

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

   228

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

   229

   230

			lcid = _local_cargo_id_ctype[cid];

   231

			if (lcid == CT_INVALID) continue;

   232

   233

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

   234

			if (HASBIT(callbackmask, CBM_CARGO_SUFFIX)) {

   235

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

   236

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

   237

				CargoID temp_cargo = u->cargo_type;

   238

				byte temp_subtype  = u->cargo_subtype;

   239

				byte refit_cyc;

   240

   241

				u->cargo_type = lcid;

   242

   243

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

   244

					bool duplicate = false;

   245

					uint16 callback;

   246

   247

					u->cargo_subtype = refit_cyc;

   248

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

   249

   250

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

   251

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

   252

   253

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

   254

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

   255

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

   256

					}

   257

   258

					if (duplicate) continue;

   259

   260

					refit[num_lines].cargo   = lcid;

   261

					refit[num_lines].subtype = refit_cyc;

   262

					refit[num_lines].value   = callback;

   263

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

   264

					num_lines++;

   265

				}

   266

   267

				/* Reset the vehicle's cargo type */

   268

				u->cargo_type    = temp_cargo;

   269

				u->cargo_subtype = temp_subtype;

   270

			} else {

   271

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

   272

				bool duplicate = false;

   273

   274

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

   275

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

   276

				}

   277

   278

				if (!duplicate) {

   279

					refit[num_lines].cargo   = lcid;

   280

					refit[num_lines].subtype = 0;

   281

					refit[num_lines].value   = CALLBACK_FAILED;

   282

					refit[num_lines].engine  = INVALID_ENGINE;

   283

					num_lines++;

   284

				}

   285

			}

   286

		}

   287

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

   288

   289

	list->num_lines = num_lines;

   290

	list->items = refit;

   291

   292

	return list;

   293

}

   294

   295

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

   296

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

   297

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

   298

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

   299

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

   300

 */

   301

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

   302

{

   303

	RefitOption *refit = list->items;

   304

	RefitOption *selected = NULL;

   305

	uint num_lines = list->num_lines;

   306

	uint y = 31;

   307

	uint i;

   308

   309

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

   310

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

   311

		byte colour = 16;

   312

		if (sel == 0) {

   313

			selected = &refit[i];

   314

			colour = 12;

   315

		}

   316

   317

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

   318

			/* Draw the cargo name */

   319

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

   320

   321

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

   322

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

   323

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

   324

			}

   325

			y += delta;

   326

		}

   327

   328

		sel--;

   329

	}

   330

   331

	return selected;

   332

}

   333

   334

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

   335

{

   336

	switch (e->event) {

   337

		case WE_PAINT: {

   338

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

   339

   340

			if (v->type == VEH_Train) {

   341

				uint length = CountVehiclesInChain(v);

   342

   343

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

   344

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

   345

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

   346

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

   347

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

   348

					WP(w, refit_d).length = length;

   349

				}

   350

			}

   351

   352

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

   353

   354

			SetDParam(0, v->string_id);

   355

			SetDParam(1, v->unitnumber);

   356

			DrawWindowWidgets(w);

   357

   358

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

   359

   360

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

   361

				int32 cost = 0;

   362

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

   363

					case VEH_Train:    cost = CMD_REFIT_RAIL_VEHICLE; break;

   364

					case VEH_Road:     cost = CMD_REFIT_ROAD_VEH;     break;

   365

					case VEH_Ship:     cost = CMD_REFIT_SHIP;         break;

   366

					case VEH_Aircraft: cost = CMD_REFIT_AIRCRAFT;     break;

   367

				}

   368

   369

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

   370

				if (!CmdFailed(cost)) {

   371

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

   372

					SetDParam(1, _returned_refit_capacity);

   373

					SetDParam(2, cost);

   374

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

   375

				}

   376

			}

   377

		}	break;

   378

   379

		case WE_CLICK:

   380

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

   381

				case 3: { // listbox

   382

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

   383

					if (y >= 0) {

   384

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

   385

						SetWindowDirty(w);

   386

					}

   387

				} break;

   388

				case 6: // refit button

   389

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

   390

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

   391

   392

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

   393

							int command = 0;

   394

   395

							switch (v->type) {

   396

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

   397

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

   398

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

   399

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

   400

							}

   401

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

   402

						} else {

   403

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

   404

						}

   405

					}

   406

					break;

   407

			}

   408

			break;

   409

   410

		case WE_RESIZE:

   411

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

   412

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

   413

			break;

   414

   415

		case WE_DESTROY:

   416

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

   417

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

   418

			break;

   419

	}

   420

}

   421

   422

   423

static const Widget _vehicle_refit_widgets[] = {

   424

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

   425

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

   426

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

   427

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

   428

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

   429

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

   430

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

   431

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

   432

	{   WIDGETS_END},

   433

};

   434

   435

static const WindowDesc _vehicle_refit_desc = {

   436

	WDP_AUTO, WDP_AUTO, 240, 174,

   437

	WC_VEHICLE_REFIT,WC_VEHICLE_VIEW,

   438

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS | WDF_RESIZABLE,

   439

	_vehicle_refit_widgets,

   440

	VehicleRefitWndProc,

   441

};

   442

   443

/** Show the refit window for a vehicle

   444

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

   445

*/

   446

void ShowVehicleRefitWindow(const Vehicle *v, VehicleOrderID order)

   447

{

   448

	Window *w;

   449

   450

	DeleteWindowById(WC_VEHICLE_REFIT, v->index);

   451

   452

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

   453

	WP(w, refit_d).order = order;

   454

   455

	if (w != NULL) {

   456

		w->caption_color = v->owner;

   457

		w->vscroll.cap = 8;

   458

		w->resize.step_height = 14;

   459

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

   460

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

   461

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

   462

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

   463

   464

		switch (v->type) {

   465

			case VEH_Train:

   466

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

   467

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

   468

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

   469

				break;

   470

			case VEH_Road:

   471

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

   472

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

   473

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

   474

				break;

   475

			case VEH_Ship:

   476

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

   477

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

   478

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

   479

				break;

   480

			case VEH_Aircraft:

   481

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

   482

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

   483

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

   484

				break;

   485

			default: NOT_REACHED();