1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "aircraft.h"

     6

#include "debug.h"

     7

#include "functions.h"

     8

#include "table/sprites.h"

     9

#include "table/strings.h"

    10

#include "window.h"

    11

#include "gui.h"

    12

#include "vehicle.h"

    13

#include "gfx.h"

    14

#include "station.h"

    15

#include "command.h"

    16

#include "engine.h"

    17

#include "player.h"

    18

#include "depot.h"

    19

#include "airport.h"

    20

#include "vehicle_gui.h"

    21

#include "newgrf_engine.h"

    22

#include "date.h"

    23

#include "strings.h"

    24

    25

    26

enum BuildVehicleWidgets {

    27

	BUILD_VEHICLE_WIDGET_CLOSEBOX = 0,

    28

	BUILD_VEHICLE_WIDGET_CAPTION,

    29

	BUILD_VEHICLE_WIDGET_SORT_ASSENDING_DESCENDING,

    30

	BUILD_VEHICLE_WIDGET_SORT_TEXT,

    31

	BUILD_VEHICLE_WIDGET_SORT_DROPDOWN,

    32

	BUILD_VEHICLE_WIDGET_LIST,

    33

	BUILD_VEHICLE_WIDGET_SCROLLBAR,

    34

	BUILD_VEHICLE_WIDGET_PANEL,

    35

	BUILD_VEHICLE_WIDGET_BUILD,

    36

	BUILD_VEHICLE_WIDGET_RENAME,

    37

	BUILD_VEHICLE_WIDGET_RESIZE,

    38

};

    39

    40

static const Widget _build_vehicle_widgets[] = {

    41

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

    42

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

    43

	{ WWT_PUSHTXTBTN,   RESIZE_NONE,    14,     0,    80,    14,    25, STR_SORT_BY,             STR_SORT_ORDER_TIP},

    44

	{      WWT_PANEL,   RESIZE_NONE,    14,    81,   227,    14,    25, 0x0,                     STR_SORT_CRITERIA_TIP},

    45

	{    WWT_TEXTBTN,   RESIZE_NONE,    14,   228,   239,    14,    25, STR_0225,                STR_SORT_CRITERIA_TIP},

    46

	{     WWT_MATRIX, RESIZE_BOTTOM,    14,     0,   227,    26,   121, 0x401,                   STR_A025_AIRCRAFT_SELECTION_LIST },

    47

	{  WWT_SCROLLBAR, RESIZE_BOTTOM,    14,   228,   239,    26,   121, 0x0,                     STR_0190_SCROLL_BAR_SCROLLS_LIST },

    48

	{      WWT_PANEL,     RESIZE_TB,    14,     0,   239,   122,   213, 0x0,                     STR_NULL },

    49

    50

	{ WWT_PUSHTXTBTN,     RESIZE_TB,    14,     0,   114,   214,   225, STR_A006_BUILD_AIRCRAFT, STR_A026_BUILD_THE_HIGHLIGHTED_AIRCRAFT },

    51

	{ WWT_PUSHTXTBTN,     RESIZE_TB,    14,   115,   227,   214,   225, STR_A037_RENAME,         STR_A038_RENAME_AIRCRAFT_TYPE },

    52

	{  WWT_RESIZEBOX,     RESIZE_TB,    14,   228,   239,   214,   225, 0x0,                     STR_RESIZE_BUTTON },

    53

	{   WIDGETS_END},

    54

};

    55

    56

static bool _internal_sort_order; // descending/ascending

    57

static byte _last_sort_criteria = 0;

    58

static bool _last_sort_order = false;

    59

    60

static int CDECL EngineNumberSorter(const void *a, const void *b)

    61

{

    62

	const EngineID va = *(const EngineID*)a;

    63

	const EngineID vb = *(const EngineID*)b;

    64

	int r = va - vb;

    65

    66

	return _internal_sort_order ? -r : r;

    67

}

    68

    69

static int CDECL EngineIntroDateSorter(const void *a, const void *b)

    70

{

    71

	const int va = GetEngine(*(const EngineID*)a)->intro_date;

    72

	const int vb = GetEngine(*(const EngineID*)b)->intro_date;

    73

	const int r = va - vb;

    74

    75

	if (r == 0) {

    76

		/* Use EngineID to sort instead since we want consistent sorting */

    77

		return EngineNumberSorter(a, b);

    78

	}

    79

	return _internal_sort_order ? -r : r;

    80

}

    81

    82

static int CDECL EngineNameSorter(const void *a, const void *b)

    83

{

    84

	static EngineID last_engine[2] = { INVALID_ENGINE, INVALID_ENGINE };

    85

	static char     last_name[2][64] = { "\0", "\0" };

    86

    87

	const EngineID va = *(const EngineID*)a;

    88

	const EngineID vb = *(const EngineID*)b;

    89

	int r;

    90

    91

	if (va != last_engine[0]) {

    92

		last_engine[0] = va;

    93

		GetString(last_name[0], GetCustomEngineName(va), lastof(last_name[0]));

    94

	}

    95

    96

	if (vb != last_engine[1]) {

    97

		last_engine[1] = vb;

    98

		GetString(last_name[1], GetCustomEngineName(vb), lastof(last_name[1]));

    99

	}

   100

   101

	r = strcmp(last_name[0], last_name[1]); // sort by name

   102

   103

	if (r == 0) {

   104

		/* Use EngineID to sort instead since we want consistent sorting */

   105

		return EngineNumberSorter(a, b);

   106

	}

   107

	return _internal_sort_order ? -r : r;

   108

}

   109

   110

static int CDECL EngineReliabilitySorter(const void *a, const void *b)

   111

{

   112

	const int va = GetEngine(*(const EngineID*)a)->reliability;

   113

	const int vb = GetEngine(*(const EngineID*)b)->reliability;

   114

	const int r = va - vb;

   115

   116

	if (r == 0) {

   117

		/* Use EngineID to sort instead since we want consistent sorting */

   118

		return EngineNumberSorter(a, b);

   119

	}

   120

	return _internal_sort_order ? -r : r;

   121

}

   122

   123

/* Aircraft sorting functions */

   124

   125

static int CDECL AircraftEngineCostSorter(const void *a, const void *b)

   126

{

   127

	const int va = AircraftVehInfo(*(const EngineID*)a)->base_cost;

   128

	const int vb = AircraftVehInfo(*(const EngineID*)b)->base_cost;

   129

	int r = va - vb;

   130

   131

	return _internal_sort_order ? -r : r;

   132

}

   133

   134

static int CDECL AircraftEngineSpeedSorter(const void *a, const void *b)

   135

{

   136

	const int va = AircraftVehInfo(*(const EngineID*)a)->max_speed;

   137

	const int vb = AircraftVehInfo(*(const EngineID*)b)->max_speed;

   138

	const int r = va - vb;

   139

   140

	if (r == 0) {

   141

		/* Use EngineID to sort instead since we want consistent sorting */

   142

		return EngineNumberSorter(a, b);

   143

	}

   144

	return _internal_sort_order ? -r : r;

   145

}

   146

   147

static int CDECL AircraftEngineRunningCostSorter(const void *a, const void *b)

   148

{

   149

	const int va = AircraftVehInfo(*(const EngineID*)a)->running_cost;

   150

	const int vb = AircraftVehInfo(*(const EngineID*)b)->running_cost;

   151

	const int r = va - vb;

   152

   153

	if (r == 0) {

   154

		/* Use EngineID to sort instead since we want consistent sorting */

   155

		return EngineNumberSorter(a, b);

   156

	}

   157

	return _internal_sort_order ? -r : r;

   158

}

   159

   160

static int CDECL AircraftEngineCargoSorter(const void *a, const void *b)

   161

{

   162

	const int va = AircraftVehInfo(*(const EngineID*)a)->passenger_capacity;

   163

	const int vb = AircraftVehInfo(*(const EngineID*)b)->passenger_capacity;

   164

	const int r = va - vb;

   165

   166

	if (r == 0) {

   167

		/* Use EngineID to sort instead since we want consistent sorting */

   168

		return EngineNumberSorter(a, b);

   169

	}

   170

	return _internal_sort_order ? -r : r;

   171

}

   172

   173

static EngList_SortTypeFunction * const _aircraft_sorter[] = {

   174

	&EngineNumberSorter,

   175

	&AircraftEngineCostSorter,

   176

	&AircraftEngineSpeedSorter,

   177

	&EngineIntroDateSorter,

   178

	&EngineNameSorter,

   179

	&AircraftEngineRunningCostSorter,

   180

	&EngineReliabilitySorter,

   181

	&AircraftEngineCargoSorter,

   182

};

   183

   184

static const StringID _aircraft_sort_listing[] = {

   185

	STR_ENGINE_SORT_ENGINE_ID,

   186

	STR_ENGINE_SORT_COST,

   187

	STR_SORT_BY_MAX_SPEED,

   188

	STR_ENGINE_SORT_INTRO_DATE,

   189

	STR_SORT_BY_DROPDOWN_NAME,

   190

	STR_ENGINE_SORT_RUNNING_COST,

   191

	STR_SORT_BY_RELIABILITY,

   192

	STR_ENGINE_SORT_CARGO_CAPACITY,

   193

	INVALID_STRING_ID

   194

};

   195

   196

   197

/**

   198

* Draw the purchase info details of an aircraft at a given location.

   199

 * @param x,y location where to draw the info

   200

 * @param engine_number the engine of which to draw the info of

   201

 */

   202

void DrawAircraftPurchaseInfo(int x, int y, uint w, EngineID engine_number)

   203

{

   204

	const AircraftVehicleInfo *avi = AircraftVehInfo(engine_number);

   205

	const Engine *e = GetEngine(engine_number);

   206

	CargoID cargo;

   207

	YearMonthDay ymd;

   208

	ConvertDateToYMD(e->intro_date, &ymd);

   209

   210

	/* Purchase cost - Max speed */

   211

	SetDParam(0, avi->base_cost * (_price.aircraft_base>>3)>>5);

   212

	SetDParam(1, avi->max_speed * 128 / 10);

   213

	DrawString(x, y, STR_PURCHASE_INFO_COST_SPEED, 0);

   214

	y += 10;

   215

   216

	/* Cargo capacity */

   217

	cargo = FindFirstRefittableCargo(engine_number);

   218

	if (cargo == CT_INVALID || cargo == CT_PASSENGERS) {

   219

		SetDParam(0, avi->passenger_capacity);

   220

		SetDParam(1, avi->mail_capacity);

   221

		DrawString(x, y, STR_PURCHASE_INFO_AIRCRAFT_CAPACITY, 0);

   222

	} else {

   223

		/* Note, if the default capacity is selected by the refit capacity

   224

		* callback, then the capacity shown is likely to be incorrect. */

   225

		SetDParam(0, cargo);

   226

		SetDParam(1, AircraftDefaultCargoCapacity(cargo, engine_number));

   227

		SetDParam(2, STR_9842_REFITTABLE);

   228

		DrawString(x, y, STR_PURCHASE_INFO_CAPACITY, 0);

   229

	}

   230

	y += 10;

   231

   232

	/* Running cost */

   233

	SetDParam(0, avi->running_cost * _price.aircraft_running >> 8);

   234

	DrawString(x, y, STR_PURCHASE_INFO_RUNNINGCOST, 0);

   235

	y += 10;

   236

   237

	/* Design date - Life length */

   238

	SetDParam(0, ymd.year);

   239

	SetDParam(1, e->lifelength);

   240

	DrawString(x, y, STR_PURCHASE_INFO_DESIGNED_LIFE, 0);

   241

	y += 10;

   242

   243

	/* Reliability */

   244

	SetDParam(0, e->reliability * 100 >> 16);

   245

	DrawString(x, y, STR_PURCHASE_INFO_RELIABILITY, 0);

   246

	y += 10;

   247

   248

	/* Additional text from NewGRF */

   249

	y += ShowAdditionalText(x, y, w, engine_number);

   250

	y += ShowRefitOptionsList(x, y, w, engine_number);

   251

}

   252

   253

void DrawAircraftImage(const Vehicle *v, int x, int y, VehicleID selection)

   254

{

   255

	PalSpriteID pal = (v->vehstatus & VS_CRASHED) ? PALETTE_CRASH : GetVehiclePalette(v);

   256

	DrawSprite(GetAircraftImage(v, DIR_W) | pal, x + 25, y + 10);

   257

	if (v->subtype == 0) {

   258

		SpriteID rotor_sprite = GetCustomRotorSprite(v, true);

   259

		if (rotor_sprite == 0) rotor_sprite = SPR_ROTOR_STOPPED;

   260

		DrawSprite(rotor_sprite, x + 25, y + 5);

   261

	}

   262

	if (v->index == selection) {

   263

		DrawFrameRect(x - 1, y - 1, x + 58, y + 21, 0xF, FR_BORDERONLY);

   264

	}

   265

}

   266

   267

void CcBuildAircraft(bool success, TileIndex tile, uint32 p1, uint32 p2)

   268

{

   269

	if (success) {

   270

		const Vehicle *v = GetVehicle(_new_vehicle_id);

   271

   272

		if (v->tile == _backup_orders_tile) {

   273

			_backup_orders_tile = 0;

   274

			RestoreVehicleOrders(v, _backup_orders_data);

   275

		}

   276

		ShowAircraftViewWindow(v);

   277

	}

   278

}

   279

   280

static void GenerateBuildAircraftList(Window *w)

   281

{

   282

	EngineID eid, sel_id;

   283

	buildvehicle_d *bv = &WP(w, buildvehicle_d);

   284

   285

	EngList_RemoveAll(&bv->eng_list);

   286

   287

	/* Make list of all available planes.

   288

	 * Also check to see if the previously selected plane is still available,

   289

	 * and if not, reset selection to INVALID_ENGINE. This could be the case

   290

	 * when planes become obsolete and are removed */

   291

	sel_id = INVALID_ENGINE;

   292

	for (eid = AIRCRAFT_ENGINES_INDEX; eid < AIRCRAFT_ENGINES_INDEX + NUM_AIRCRAFT_ENGINES; eid++) {

   293

		if (IsEngineBuildable(eid, VEH_Aircraft, _local_player)) {

   294

			const AircraftVehicleInfo *avi = AircraftVehInfo(eid);

   295

			switch (bv->filter.acc_planes) {

   296

				case HELICOPTERS_ONLY:

   297

					if (avi->subtype != 0) continue; // if not helicopter

   298

					break;

   299

   300

				case AIRCRAFT_ONLY:

   301

					if (avi->subtype == 0) continue; // if helicopter

   302

					break;

   303

   304

				case ALL: break;

   305

			}

   306

			EngList_Add(&bv->eng_list, eid);

   307

   308

			if (eid == bv->sel_engine) sel_id = eid;

   309

		}

   310

	}

   311

   312

	bv->sel_engine = sel_id;

   313

}

   314

   315

static void GenerateBuildList(Window *w)

   316

{

   317

	buildvehicle_d *bv = &WP(w, buildvehicle_d);

   318

   319

	switch (bv->vehicle_type) {

   320

		case VEH_Aircraft:

   321

			GenerateBuildAircraftList(w);

   322

			_internal_sort_order = bv->descending_sort_order;

   323

			EngList_Sort(&bv->eng_list, _aircraft_sorter[bv->sort_criteria]);

   324

			break;

   325

   326

		default: NOT_REACHED();

   327

	}

   328

}

   329

   330

static void DrawBuildAircraftWindow(Window *w)

   331

{

   332

	const buildvehicle_d *bv = &WP(w, buildvehicle_d);

   333

   334

	SetWindowWidgetDisabledState(w, BUILD_VEHICLE_WIDGET_BUILD, w->window_number == 0);

   335

   336

	SetVScrollCount(w, EngList_Count(&bv->eng_list));

   337

	DrawWindowWidgets(w);

   338

   339

	{

   340

		int x = 2;

   341

		int y = 27;

   342

		EngineID selected_id = bv->sel_engine;

   343

		EngineID eid = w->vscroll.pos;

   344

		uint16 max = min(w->vscroll.pos + w->vscroll.cap, EngList_Count(&bv->eng_list));

   345

   346

		for (; eid < max; eid++) {

   347

			const EngineID engine = bv->eng_list[eid];

   348

   349

			DrawString(x + 62, y + 7, GetCustomEngineName(engine), engine == selected_id ? 0xC : 0x10);

   350

			DrawAircraftEngine(x + 29, y + 10, engine, GetEnginePalette(engine, _local_player));

   351

			y += 24;

   352

		}

   353

   354

		if (selected_id != INVALID_ENGINE) {

   355

			const Widget *wi = &w->widget[BUILD_VEHICLE_WIDGET_PANEL];

   356

			DrawAircraftPurchaseInfo(x, wi->top + 1, wi->right - wi->left - 2, selected_id);

   357

		}

   358

	}

   359

	DrawString(85, 15, _aircraft_sort_listing[bv->sort_criteria], 0x10);

   360

	DoDrawString(bv->descending_sort_order ? DOWNARROW : UPARROW, 69, 15, 0x10);

   361

}

   362

   363

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

   364

{

   365

	buildvehicle_d *bv = &WP(w, buildvehicle_d);

   366

   367

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

   368

		case BUILD_VEHICLE_WIDGET_SORT_ASSENDING_DESCENDING:

   369

			bv->descending_sort_order ^= true;

   370

			_last_sort_order = bv->descending_sort_order;

   371

			GenerateBuildList(w);

   372

			SetWindowDirty(w);

   373

			break;

   374

   375

		case BUILD_VEHICLE_WIDGET_LIST: {

   376

			uint i = (e->we.click.pt.y - 26) / 24 + w->vscroll.pos;

   377

			uint num_items = EngList_Count(&bv->eng_list);

   378

			bv->sel_engine = (i < num_items) ? bv->eng_list[i] : INVALID_ENGINE;

   379

			SetWindowDirty(w);

   380

			break;

   381

		}

   382

   383

		case BUILD_VEHICLE_WIDGET_SORT_TEXT: case BUILD_VEHICLE_WIDGET_SORT_DROPDOWN:/* Select sorting criteria dropdown menu */

   384

			ShowDropDownMenu(w, _aircraft_sort_listing, bv->sort_criteria, BUILD_VEHICLE_WIDGET_SORT_DROPDOWN, 0, 0);

   385

			return;

   386

   387

		case BUILD_VEHICLE_WIDGET_BUILD: {

   388

			EngineID sel_eng = bv->sel_engine;

   389

			if (sel_eng != INVALID_ENGINE) {

   390

				DoCommandP(w->window_number, sel_eng, 0, CcBuildAircraft, CMD_BUILD_AIRCRAFT | CMD_MSG(STR_A008_CAN_T_BUILD_AIRCRAFT));

   391

			}

   392

			break;

   393

		}

   394

   395

		case BUILD_VEHICLE_WIDGET_RENAME: {

   396

			EngineID sel_eng = bv->sel_engine;

   397

			if (sel_eng != INVALID_ENGINE) {

   398

				bv->rename_engine = sel_eng;

   399

				ShowQueryString(GetCustomEngineName(sel_eng), STR_A039_RENAME_AIRCRAFT_TYPE, 31, 160, w->window_class, w->window_number, CS_ALPHANUMERAL);

   400

			}

   401

			break;

   402

		}

   403

	}

   404

}

   405

   406

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

   407

{

   408

	buildvehicle_d *bv = &WP(w, buildvehicle_d);

   409

   410

	switch (e->event) {

   411

		case WE_INVALIDATE_DATA:

   412

			GenerateBuildList(w);

   413

			break;

   414

   415

		case WE_DESTROY:

   416

			EngList_Destroy(&bv->eng_list);

   417

			break;

   418

   419

		case WE_PAINT:

   420

			DrawBuildAircraftWindow(w);

   421

			break;

   422

   423

		case WE_CLICK:

   424

			BuildAircraftClickEvent(w, e);

   425

			break;

   426

   427

		case WE_ON_EDIT_TEXT: {

   428

			if (e->we.edittext.str[0] != '\0') {

   429

				_cmd_text = e->we.edittext.str;

   430

				DoCommandP(0, bv->rename_engine, 0, NULL, CMD_RENAME_ENGINE | CMD_MSG(STR_A03A_CAN_T_RENAME_AIRCRAFT_TYPE));

   431

			}

   432

			break;

   433

		}

   434

   435

		case WE_DROPDOWN_SELECT: /* we have selected a dropdown item in the list */

   436

			if (bv->sort_criteria != e->we.dropdown.index) {

   437

				bv->sort_criteria = _last_sort_criteria = e->we.dropdown.index;

   438

				GenerateBuildList(w);

   439

			}

   440

			SetWindowDirty(w);

   441

			break;

   442

   443

		case WE_RESIZE:

   444

			w->vscroll.cap += e->we.sizing.diff.y / 24;

   445

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

   446

			break;

   447

	}

   448

}

   449

   450

static const WindowDesc _build_vehicle_desc = {

   451

	WDP_AUTO, WDP_AUTO, 240, 226,

   452

	WC_BUILD_VEHICLE,0,

   453

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS | WDF_RESIZABLE,

   454

	_build_vehicle_widgets,

   455

	NewAircraftWndProc

   456

};

   457

   458

void ShowBuildVehicleWindow(TileIndex tile, byte type)

   459

{

   460

	buildvehicle_d *bv;

   461

	Window *w;

   462

   463

	DeleteWindowById(WC_BUILD_VEHICLE, tile);

   464

	w = AllocateWindowDescFront(&_build_vehicle_desc, tile);

   465

	if (w == NULL) return;

   466

   467

	w->caption_color = (tile != 0) ? GetTileOwner(tile) : _local_player;

   468

	w->resize.step_height = GetVehicleListHeight(type);

   469

	w->vscroll.cap = 4;

   470

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

   471

   472

	bv = &WP(w, buildvehicle_d);

   473

	EngList_Create(&bv->eng_list);

   474

	bv->sel_engine            = INVALID_ENGINE;

   475

	bv->sort_criteria         = _last_sort_criteria;

   476

	bv->descending_sort_order = _last_sort_order;

   477

   478

	bv->vehicle_type = type;

   479

   480

	switch (type) {

   481

		case VEH_Aircraft: {

   482

			byte acc_planes = (tile == 0) ? ALL : GetAirport(GetStationByTile(tile)->airport_type)->acc_planes;

   483

			bv->filter.acc_planes = acc_planes;

   484

			break;

   485

		}

   486

		default: NOT_REACHED();

   487

	}

   488

   489

	GenerateBuildList(w);

   490

	/* Select the first plane in the list as default when opening the window */

   491

	if (EngList_Count(&bv->eng_list) > 0) bv->sel_engine = bv->eng_list[0];

   492

}