1

/* $Id$ */

     2

     3

/** @file build_vehicle_gui.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "train.h"

     8

#include "roadveh.h"

     9

#include "ship.h"

    10

#include "aircraft.h"

    11

#include "debug.h"

    12

#include "functions.h"

    13

#include "table/sprites.h"

    14

#include "table/strings.h"

    15

#include "window.h"

    16

#include "gui.h"

    17

#include "vehicle.h"

    18

#include "articulated_vehicles.h"

    19

#include "gfx.h"

    20

#include "station.h"

    21

#include "command.h"

    22

#include "engine.h"

    23

#include "player.h"

    24

#include "depot.h"

    25

#include "airport.h"

    26

#include "vehicle_gui.h"

    27

#include "newgrf_engine.h"

    28

#include "date.h"

    29

#include "strings.h"

    30

#include "cargotype.h"

    31

#include "group.h"

    32

#include "road_map.h"

    33

    34

    35

enum BuildVehicleWidgets {

    36

	BUILD_VEHICLE_WIDGET_CLOSEBOX = 0,

    37

	BUILD_VEHICLE_WIDGET_CAPTION,

    38

	BUILD_VEHICLE_WIDGET_SORT_ASSENDING_DESCENDING,

    39

	BUILD_VEHICLE_WIDGET_SORT_TEXT,

    40

	BUILD_VEHICLE_WIDGET_SORT_DROPDOWN,

    41

	BUILD_VEHICLE_WIDGET_LIST,

    42

	BUILD_VEHICLE_WIDGET_SCROLLBAR,

    43

	BUILD_VEHICLE_WIDGET_PANEL,

    44

	BUILD_VEHICLE_WIDGET_BUILD,

    45

	BUILD_VEHICLE_WIDGET_RENAME,

    46

	BUILD_VEHICLE_WIDGET_RESIZE,

    47

	BUILD_VEHICLE_WIDGET_END

    48

};

    49

    50

static const Widget _build_vehicle_widgets[] = {

    51

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

    52

	{    WWT_CAPTION,  RESIZE_RIGHT,    14,    11,   239,     0,    13, 0x0,                     STR_018C_WINDOW_TITLE_DRAG_THIS },

    53

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

    54

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

    55

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

    56

	{     WWT_MATRIX,     RESIZE_RB,    14,     0,   227,    26,   121, 0x0,                     STR_NULL },

    57

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

    58

	{      WWT_PANEL,    RESIZE_RTB,    14,     0,   239,   122,   243, 0x0,                     STR_NULL },

    59

    60

	{ WWT_PUSHTXTBTN,     RESIZE_TB,    14,     0,   114,   244,   255, 0x0,                     STR_NULL },

    61

	{ WWT_PUSHTXTBTN,    RESIZE_RTB,    14,   115,   227,   244,   255, 0x0,                     STR_NULL },

    62

	{  WWT_RESIZEBOX,   RESIZE_LRTB,    14,   228,   239,   244,   255, 0x0,                     STR_RESIZE_BUTTON },

    63

	{   WIDGETS_END},

    64

};

    65

    66

/* Setup widget strings to fit the different types of vehicles */

    67

static void SetupWindowStrings(Window *w, byte type)

    68

{

    69

	switch (type) {

    70

		case VEH_TRAIN:

    71

			w->widget[BUILD_VEHICLE_WIDGET_CAPTION].data    = STR_JUST_STRING;

    72

			w->widget[BUILD_VEHICLE_WIDGET_LIST].tooltips   = STR_8843_TRAIN_VEHICLE_SELECTION;

    73

			w->widget[BUILD_VEHICLE_WIDGET_BUILD].data      = STR_881F_BUILD_VEHICLE;

    74

			w->widget[BUILD_VEHICLE_WIDGET_BUILD].tooltips  = STR_8844_BUILD_THE_HIGHLIGHTED_TRAIN;

    75

			w->widget[BUILD_VEHICLE_WIDGET_RENAME].data     = STR_8820_RENAME;

    76

			w->widget[BUILD_VEHICLE_WIDGET_RENAME].tooltips = STR_8845_RENAME_TRAIN_VEHICLE_TYPE;

    77

			break;

    78

		case VEH_ROAD:

    79

			w->widget[BUILD_VEHICLE_WIDGET_CAPTION].data    = STR_9006_NEW_ROAD_VEHICLES;

    80

			w->widget[BUILD_VEHICLE_WIDGET_LIST].tooltips   = STR_9026_ROAD_VEHICLE_SELECTION;

    81

			w->widget[BUILD_VEHICLE_WIDGET_BUILD].data      = STR_9007_BUILD_VEHICLE;

    82

			w->widget[BUILD_VEHICLE_WIDGET_BUILD].tooltips  = STR_9027_BUILD_THE_HIGHLIGHTED_ROAD;

    83

			w->widget[BUILD_VEHICLE_WIDGET_RENAME].data     = STR_9034_RENAME;

    84

			w->widget[BUILD_VEHICLE_WIDGET_RENAME].tooltips = STR_9035_RENAME_ROAD_VEHICLE_TYPE;

    85

			break;

    86

		case VEH_SHIP:

    87

			w->widget[BUILD_VEHICLE_WIDGET_CAPTION].data    = STR_9808_NEW_SHIPS;

    88

			w->widget[BUILD_VEHICLE_WIDGET_LIST].tooltips   = STR_9825_SHIP_SELECTION_LIST_CLICK;

    89

			w->widget[BUILD_VEHICLE_WIDGET_BUILD].data      = STR_9809_BUILD_SHIP;

    90

			w->widget[BUILD_VEHICLE_WIDGET_BUILD].tooltips  = STR_9826_BUILD_THE_HIGHLIGHTED_SHIP;

    91

			w->widget[BUILD_VEHICLE_WIDGET_RENAME].data     = STR_9836_RENAME;

    92

			w->widget[BUILD_VEHICLE_WIDGET_RENAME].tooltips = STR_9837_RENAME_SHIP_TYPE;

    93

			break;

    94

		case VEH_AIRCRAFT:

    95

			w->widget[BUILD_VEHICLE_WIDGET_CAPTION].data    = STR_A005_NEW_AIRCRAFT;

    96

			w->widget[BUILD_VEHICLE_WIDGET_LIST].tooltips   = STR_A025_AIRCRAFT_SELECTION_LIST;

    97

			w->widget[BUILD_VEHICLE_WIDGET_BUILD].data      = STR_A006_BUILD_AIRCRAFT;

    98

			w->widget[BUILD_VEHICLE_WIDGET_BUILD].tooltips  = STR_A026_BUILD_THE_HIGHLIGHTED_AIRCRAFT;

    99

			w->widget[BUILD_VEHICLE_WIDGET_RENAME].data     = STR_A037_RENAME;

   100

			w->widget[BUILD_VEHICLE_WIDGET_RENAME].tooltips = STR_A038_RENAME_AIRCRAFT_TYPE;

   101

			break;

   102

	}

   103

}

   104

   105

static bool _internal_sort_order; // descending/ascending

   106

   107

static byte _last_sort_criteria[]    = {0, 0, 0, 0};

   108

static bool _last_sort_order[]       = {false, false, false, false};

   109

   110

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

   111

{

   112

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

   113

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

   114

	int r = va - vb;

   115

   116

	return _internal_sort_order ? -r : r;

   117

}

   118

   119

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

   120

{

   121

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

   122

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

   123

	const int r = va - vb;

   124

   125

	if (r == 0) {

   126

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

   127

		return EngineNumberSorter(a, b);

   128

	}

   129

	return _internal_sort_order ? -r : r;

   130

}

   131

   132

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

   133

{

   134

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

   135

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

   136

   137

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

   138

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

   139

	int r;

   140

   141

	if (va != last_engine[0]) {

   142

		last_engine[0] = va;

   143

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

   144

	}

   145

   146

	if (vb != last_engine[1]) {

   147

		last_engine[1] = vb;

   148

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

   149

	}

   150

   151

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

   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 EngineReliabilitySorter(const void *a, const void *b)

   161

{

   162

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

   163

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

   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

/* Train sorting functions */

   174

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

   175

{

   176

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

   177

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

   178

	int r = va - vb;

   179

   180

	return _internal_sort_order ? -r : r;

   181

}

   182

   183

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

   184

{

   185

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

   186

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

   187

	int r = va - vb;

   188

   189

	return _internal_sort_order ? -r : r;

   190

}

   191

   192

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

   193

{

   194

	const RailVehicleInfo *rvi_a = RailVehInfo(*(const EngineID*)a);

   195

	const RailVehicleInfo *rvi_b = RailVehInfo(*(const EngineID*)b);

   196

   197

	int va = rvi_a->power << (rvi_a->railveh_type == RAILVEH_MULTIHEAD ? 1 : 0);

   198

	int vb = rvi_b->power << (rvi_b->railveh_type == RAILVEH_MULTIHEAD ? 1 : 0);

   199

	int r = va - vb;

   200

   201

	return _internal_sort_order ? -r : r;

   202

}

   203

   204

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

   205

{

   206

	const RailVehicleInfo *rvi_a = RailVehInfo(*(const EngineID*)a);

   207

	const RailVehicleInfo *rvi_b = RailVehInfo(*(const EngineID*)b);

   208

   209

	int va = rvi_a->running_cost_base * _price.running_rail[rvi_a->running_cost_class] * (rvi_a->railveh_type == RAILVEH_MULTIHEAD ? 2 : 1);

   210

	int vb = rvi_b->running_cost_base * _price.running_rail[rvi_b->running_cost_class] * (rvi_b->railveh_type == RAILVEH_MULTIHEAD ? 2 : 1);

   211

	int r = va - vb;

   212

   213

	return _internal_sort_order ? -r : r;

   214

}

   215

   216

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

   217

{

   218

	const RailVehicleInfo *rvi_a = RailVehInfo(*(const EngineID*)a);

   219

	const RailVehicleInfo *rvi_b = RailVehInfo(*(const EngineID*)b);

   220

   221

	/* Here we are using a few tricks to get the right sort.

   222

		* We want power/running cost, but since we usually got higher running cost than power and we store the result in an int,

   223

		* we will actually calculate cunning cost/power (to make it more than 1).

   224

		* Because of this, the return value have to be reversed as well and we return b - a instead of a - b.

   225

		* Another thing is that both power and running costs should be doubled for multiheaded engines.

   226

		* Since it would be multipling with 2 in both numerator and denumerator, it will even themselves out and we skip checking for multiheaded. */

   227

	int va = (rvi_a->running_cost_base * _price.running_rail[rvi_a->running_cost_class]) / max((uint16)1, rvi_a->power);

   228

	int vb = (rvi_b->running_cost_base * _price.running_rail[rvi_b->running_cost_class]) / max((uint16)1, rvi_b->power);

   229

	int r = vb - va;

   230

   231

	return _internal_sort_order ? -r : r;

   232

}

   233

   234

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

   235

{

   236

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

   237

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

   238

	int r = ListPositionOfEngine(va) - ListPositionOfEngine(vb);

   239

   240

	return _internal_sort_order ? -r : r;

   241

}

   242

   256

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

   257

{

   258

	EngineID va = *(const EngineID*)a;

   259

	EngineID vb = *(const EngineID*)b;

   260

	int val_a = (RailVehInfo(va)->railveh_type == RAILVEH_WAGON ? 1 : 0);

   261

	int val_b = (RailVehInfo(vb)->railveh_type == RAILVEH_WAGON ? 1 : 0);

   262

	int r = val_a - val_b;

   263

   264

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

   265

	if (r == 0) return EngineNumberSorter(a, b);

   266

   267

	return _internal_sort_order ? -r : r;

   268

}

   269

   296

/* Aircraft sorting functions */

   297

   298

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

   299

{

   300

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

   301

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

   302

	int r = va - vb;

   303

   304

	return _internal_sort_order ? -r : r;

   305

}

   306

   307

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

   308

{

   309

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

   310

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

   311

	const int r = va - vb;

   312

   313

	if (r == 0) {

   314

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

   315

		return EngineNumberSorter(a, b);

   316

	}

   317

	return _internal_sort_order ? -r : r;

   318

}

   319

   320

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

   321

{

   322

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

   323

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

   324

	const int r = va - vb;

   325

   326

	if (r == 0) {

   327

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

   328

		return EngineNumberSorter(a, b);

   329

	}

   330

	return _internal_sort_order ? -r : r;

   331

}

   332

   333

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

   334

{

   335

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

   336

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

   337

	const int r = va - vb;

   338

   339

	if (r == 0) {

   340

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

   341

		return EngineNumberSorter(a, b);

   342

	}

   343

	return _internal_sort_order ? -r : r;

   344

}

   345

   347

	/* Trains */

   348

	&TrainEngineNumberSorter,

   349

	&TrainEngineCostSorter,

   350

	&TrainEngineSpeedSorter,

   351

	&TrainEnginePowerSorter,

   352

	&EngineIntroDateSorter,

   353

	&EngineNameSorter,

   354

	&TrainEngineRunningCostSorter,

   355

	&TrainEnginePowerVsRunningCostSorter,

   356

	&EngineReliabilitySorter,

   358

}, {

   359

	/* Road vehicles */

   360

	&EngineNumberSorter,

   361

	&EngineIntroDateSorter,

   362

	&EngineNameSorter,

   363

	&EngineReliabilitySorter,

   365

}, {

   366

	/* Ships */

   367

	&EngineNumberSorter,

   368

	&EngineIntroDateSorter,

   369

	&EngineNameSorter,

   370

	&EngineReliabilitySorter,

   372

}, {

   373

	/* Aircraft */

   374

	&EngineNumberSorter,

   375

	&AircraftEngineCostSorter,

   376

	&AircraftEngineSpeedSorter,

   377

	&EngineIntroDateSorter,

   378

	&EngineNameSorter,

   379

	&AircraftEngineRunningCostSorter,

   380

	&EngineReliabilitySorter,

   381

	&AircraftEngineCargoSorter,

   382

}};

   383

   385

	/* Trains */

   386

	STR_ENGINE_SORT_ENGINE_ID,

   387

	STR_ENGINE_SORT_COST,

   388

	STR_SORT_BY_MAX_SPEED,

   389

	STR_ENGINE_SORT_POWER,

   390

	STR_ENGINE_SORT_INTRO_DATE,

   391

	STR_SORT_BY_DROPDOWN_NAME,

   392

	STR_ENGINE_SORT_RUNNING_COST,

   393

	STR_ENGINE_SORT_POWER_VS_RUNNING_COST,

   394

	STR_SORT_BY_RELIABILITY,

   396

	INVALID_STRING_ID

   397

}, {

   398

	/* Road vehicles */

   399

	STR_ENGINE_SORT_ENGINE_ID,

   400

	STR_ENGINE_SORT_INTRO_DATE,

   401

	STR_SORT_BY_DROPDOWN_NAME,

   402

	STR_SORT_BY_RELIABILITY,

   404

	INVALID_STRING_ID

   405

}, {

   406

	/* Ships */

   407

	STR_ENGINE_SORT_ENGINE_ID,

   408

	STR_ENGINE_SORT_INTRO_DATE,

   409

	STR_SORT_BY_DROPDOWN_NAME,

   410

	STR_SORT_BY_RELIABILITY,

   412

	INVALID_STRING_ID

   413

}, {

   414

	/* Aircraft */

   415

	STR_ENGINE_SORT_ENGINE_ID,

   416

	STR_ENGINE_SORT_COST,

   417

	STR_SORT_BY_MAX_SPEED,

   418

	STR_ENGINE_SORT_INTRO_DATE,

   419

	STR_SORT_BY_DROPDOWN_NAME,

   420

	STR_ENGINE_SORT_RUNNING_COST,

   421

	STR_SORT_BY_RELIABILITY,

   422

	STR_ENGINE_SORT_CARGO_CAPACITY,

   423

	INVALID_STRING_ID

   424

}};

   425

   426

/* Draw rail wagon specific details */

   427

static int DrawRailWagonPurchaseInfo(int x, int y, EngineID engine_number, const RailVehicleInfo *rvi)

   428

{

   429

	/* Purchase cost */

   430

	SetDParam(0, (GetEngineProperty(engine_number, 0x17, rvi->base_cost) * _price.build_railwagon) >> 8);

   431

	DrawString(x, y, STR_PURCHASE_INFO_COST, 0);

   432

	y += 10;

   433

   434

	/* Wagon weight - (including cargo) */

   435

	uint weight = GetEngineProperty(engine_number, 0x16, rvi->weight);

   436

	SetDParam(0, weight);

   437

	SetDParam(1, (GetCargo(rvi->cargo_type)->weight * GetEngineProperty(engine_number, 0x14, rvi->capacity) >> 4) + weight);

   438

	DrawString(x, y, STR_PURCHASE_INFO_WEIGHT_CWEIGHT, 0);

   439

	y += 10;

   440

   441

	/* Wagon speed limit, displayed if above zero */

   442

	if (_patches.wagon_speed_limits) {

   443

		uint max_speed = GetEngineProperty(engine_number, 0x09, rvi->max_speed);

   444

		if (max_speed > 0) {

   445

			SetDParam(0, max_speed * 10 / 16);

   446

			DrawString(x, y, STR_PURCHASE_INFO_SPEED, 0);

   447

			y += 10;

   448

		}

   449

	}

   450

	return y;

   451

}

   452

   453

/* Draw locomotive specific details */

   454

static int DrawRailEnginePurchaseInfo(int x, int y, EngineID engine_number, const RailVehicleInfo *rvi)

   455

{

   456

	int multihead = (rvi->railveh_type == RAILVEH_MULTIHEAD ? 1 : 0);

   457

	uint weight = GetEngineProperty(engine_number, 0x16, rvi->weight);

   458

   459

	/* Purchase Cost - Engine weight */

   460

	SetDParam(0, GetEngineProperty(engine_number, 0x17, rvi->base_cost) * (_price.build_railvehicle >> 3) >> 5);

   461

	SetDParam(1, weight << multihead);

   462

	DrawString(x, y, STR_PURCHASE_INFO_COST_WEIGHT, 0);

   463

	y += 10;

   464

   465

	/* Max speed - Engine power */

   466

	SetDParam(0, GetEngineProperty(engine_number, 0x09, rvi->max_speed) * 10 / 16);

   467

	SetDParam(1, GetEngineProperty(engine_number, 0x0B, rvi->power) << multihead);

   468

	DrawString(x, y, STR_PURCHASE_INFO_SPEED_POWER, 0);

   469

	y += 10;

   470

   471

	/* Max tractive effort - not applicable if old acceleration or maglev */

   472

	if (_patches.realistic_acceleration && rvi->railtype != RAILTYPE_MAGLEV) {

   473

		SetDParam(0, ((weight << multihead) * 10 * GetEngineProperty(engine_number, 0x1F, rvi->tractive_effort)) / 256);

   474

		DrawString(x, y, STR_PURCHASE_INFO_MAX_TE, 0);

   475

		y += 10;

   476

	}

   477

   478

	/* Running cost */

   479

	SetDParam(0, (GetEngineProperty(engine_number, 0x0D, rvi->running_cost_base) * _price.running_rail[rvi->running_cost_class] >> 8) << multihead);

   480

	DrawString(x, y, STR_PURCHASE_INFO_RUNNINGCOST, 0);

   481

	y += 10;

   482

   483

	/* Powered wagons power - Powered wagons extra weight */

   484

	if (rvi->pow_wag_power != 0) {

   485

		SetDParam(0, rvi->pow_wag_power);

   486

		SetDParam(1, rvi->pow_wag_weight);

   487

		DrawString(x, y, STR_PURCHASE_INFO_PWAGPOWER_PWAGWEIGHT, 0);

   488

		y += 10;

   489

	};

   490

   491

	return y;

   492

}

   493

   494

/* Draw road vehicle specific details */

   495

static int DrawRoadVehPurchaseInfo(int x, int y, EngineID engine_number, const RoadVehicleInfo *rvi)

   496

{

   497

	bool refittable = (_engine_info[engine_number].refit_mask != 0);

   498