1

/* $Id$ */

     2

     3

/** @file build_vehicle_gui.cpp GUI for building vehicles. */

     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 "gui.h"

    13

#include "articulated_vehicles.h"

    14

#include "textbuf_gui.h"

    15

#include "command_func.h"

    16

#include "player_func.h"

    17

#include "airport.h"

    18

#include "vehicle_gui.h"

    19

#include "newgrf_engine.h"

    20

#include "cargotype.h"

    21

#include "group.h"

    22

#include "road_map.h"

    23

#include "strings_func.h"

    24

#include "window_func.h"

    25

#include "date_func.h"

    26

#include "vehicle_func.h"

    27

#include "settings_type.h"

    28

#include "gfx_func.h"

    29

#include "widgets/dropdown_func.h"

    30

#include "string_func.h"

    31

#include "window_gui.h"

    32

#include "engine_gui.h"

    33

    34

#include "table/sprites.h"

    35

#include "table/strings.h"

    36

    37

enum BuildVehicleWidgets {

    38

	BUILD_VEHICLE_WIDGET_CLOSEBOX = 0,

    39

	BUILD_VEHICLE_WIDGET_CAPTION,

    40

	BUILD_VEHICLE_WIDGET_SORT_ASSENDING_DESCENDING,

    41

	BUILD_VEHICLE_WIDGET_SORT_DROPDOWN,

    42

	BUILD_VEHICLE_WIDGET_LIST,

    43

	BUILD_VEHICLE_WIDGET_SCROLLBAR,

    44

	BUILD_VEHICLE_WIDGET_PANEL,

    45

	BUILD_VEHICLE_WIDGET_BUILD,

    46

	BUILD_VEHICLE_WIDGET_RENAME,

    47

	BUILD_VEHICLE_WIDGET_RESIZE,

    48

	BUILD_VEHICLE_WIDGET_END

    49

};

    50

    51

static const Widget _build_vehicle_widgets[] = {

    52

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

    53

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

    54

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

    55

	{   WWT_DROPDOWN,  RESIZE_RIGHT,    14,    81,   239,    14,    25, 0x0,                     STR_SORT_CRITERIA_TIP},

    56

	{     WWT_MATRIX,     RESIZE_RB,    14,     0,   227,    26,    39, 0x101,                   STR_NULL },

    57

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

    58

	{      WWT_PANEL,    RESIZE_RTB,    14,     0,   239,    40,   161, 0x0,                     STR_NULL },

    59

    60

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

    61

	{ WWT_PUSHTXTBTN,    RESIZE_RTB,    14,   115,   227,   162,   173, 0x0,                     STR_NULL },

    62

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

    63

	{   WIDGETS_END},

    64

};

    65

    66

static bool _internal_sort_order; // descending/ascending

    67

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

    68

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

    69

    70

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

    71

{

    72

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

    73

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

    74

	int r = va - vb;

    75

    76

	return _internal_sort_order ? -r : r;

    77

}

    78

    79

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

    80

{

    81

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

    82

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

    83

	const int r = va - vb;

    84

    85

	if (r == 0) {

    86

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

    87

		return EngineNumberSorter(a, b);

    88

	}

    89

	return _internal_sort_order ? -r : r;

    90

}

    91

    92

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

    93

{

    94

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

    95

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

    96

    97

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

    98

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

    99

	int r;

   100

   101

	if (va != last_engine[0]) {

   102

		last_engine[0] = va;

   103

		SetDParam(0, va);

   104

		GetString(last_name[0], STR_ENGINE_NAME, lastof(last_name[0]));

   105

	}

   106

   107

	if (vb != last_engine[1]) {

   108

		last_engine[1] = vb;

   109

		SetDParam(0, vb);

   110

		GetString(last_name[1], STR_ENGINE_NAME, lastof(last_name[1]));

   111

	}

   112

   113

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

   114

   115

	if (r == 0) {

   116

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

   117

		return EngineNumberSorter(a, b);

   118

	}

   119

	return _internal_sort_order ? -r : r;

   120

}

   121

   122

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

   123

{

   124

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

   125

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

   126

	const int r = va - vb;

   127

   128

	if (r == 0) {

   129

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

   130

		return EngineNumberSorter(a, b);

   131

	}

   132

	return _internal_sort_order ? -r : r;

   133

}

   134

   135

/* Train sorting functions */

   136

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

   137

{

   138

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

   139

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

   140

	int r = va - vb;

   141

   142

	return _internal_sort_order ? -r : r;

   143

}

   144

   145

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

   146

{

   147

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

   148

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

   149

	int r = va - vb;

   150

   151

	return _internal_sort_order ? -r : r;

   152

}

   153

   154

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

   155

{

   156

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

   157

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

   158

   159

	int va = rvi_a->power;

   160

	int vb = rvi_b->power;

   161

	int r = va - vb;

   162

   163

	return _internal_sort_order ? -r : r;

   164

}

   165

   166

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

   167

{

   168

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

   169

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

   170

   171

	Money va = rvi_a->running_cost * GetPriceByIndex(rvi_a->running_cost_class) * (rvi_a->railveh_type == RAILVEH_MULTIHEAD ? 2 : 1);

   172

	Money vb = rvi_b->running_cost * GetPriceByIndex(rvi_b->running_cost_class) * (rvi_b->railveh_type == RAILVEH_MULTIHEAD ? 2 : 1);

   173

	int r = ClampToI32(va - vb);

   174

   175

	return _internal_sort_order ? -r : r;

   176

}

   177

   178

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

   179

{

   180

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

   181

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

   182

   183

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

   184

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

   185

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

   186

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

   187

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

   188

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

   189

	Money va = (rvi_a->running_cost * GetPriceByIndex(rvi_a->running_cost_class)) / max(1U, (uint)rvi_a->power);

   190

	Money vb = (rvi_b->running_cost * GetPriceByIndex(rvi_b->running_cost_class)) / max(1U, (uint)rvi_b->power);

   191

	int r = ClampToI32(vb - va);

   192

   193

	return _internal_sort_order ? -r : r;

   194

}

   195

   196

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

   197

{

   198

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

   199

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

   200

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

   201

   202

	return _internal_sort_order ? -r : r;

   203

}

   204

   205

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

   206

{

   207

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

   208

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

   209

	int r = va - vb;

   210

   211

	if (r == 0) {

   212

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

   213

		return EngineNumberSorter(a, b);

   214

	}

   215

	return _internal_sort_order ? -r : r;

   216

}

   217

   218

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

   219

{

   220

	EngineID va = *(const EngineID*)a;

   221

	EngineID vb = *(const EngineID*)b;

   222

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

   223

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

   224

	int r = val_a - val_b;

   225

   226

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

   227

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

   228

   229

	return _internal_sort_order ? -r : r;

   230

}

   231

   232

/* Road vehicle sorting functions */

   233

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

   234

{

   235

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

   236

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

   237

	int r = va - vb;

   238

   239

	return _internal_sort_order ? -r : r;

   240

}

   241

   242

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

   243

{

   244

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

   245

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

   246

	int r = va - vb;

   247

   248

	return _internal_sort_order ? -r : r;

   249

}

   250

   251

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

   252

{

   253

	const RoadVehicleInfo *rvi_a = RoadVehInfo(*(const EngineID*)a);

   254

	const RoadVehicleInfo *rvi_b = RoadVehInfo(*(const EngineID*)b);

   255

   256

	Money va = rvi_a->running_cost * GetPriceByIndex(rvi_a->running_cost_class);

   257

	Money vb = rvi_b->running_cost * GetPriceByIndex(rvi_b->running_cost_class);

   258

	int r = ClampToI32(va - vb);

   259

   260

	if (r == 0) {

   261

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

   262

		return EngineNumberSorter(a, b);

   263

	}

   264

	return _internal_sort_order ? -r : r;

   265

}

   266

   267

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

   268

{

   269

	int va = RoadVehInfo(*(const EngineID*)a)->capacity;

   270

	int vb = RoadVehInfo(*(const EngineID*)b)->capacity;

   271

	int r = va - vb;

   272

   273

	if (r == 0) {

   274

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

   275

		return EngineNumberSorter(a, b);

   276

	}

   277

	return _internal_sort_order ? -r : r;

   278

}

   279

   280

/* Road vehicle sorting functions */

   281

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

   282

{

   283

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

   284

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

   285

	int r = va - vb;

   286

   287

	return _internal_sort_order ? -r : r;

   288

}

   289

   290

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

   291

{

   292

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

   293

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

   294

	int r = va - vb;

   295

   296

	return _internal_sort_order ? -r : r;

   297

}

   298

   299

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

   300

{

   301

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

   302

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

   303

	const int r = va - vb;

   304

   305

	if (r == 0) {

   306

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

   307

		return EngineNumberSorter(a, b);

   308

	}

   309

	return _internal_sort_order ? -r : r;

   310

}

   311

   312

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

   313

{

   314

	int va = ShipVehInfo(*(const EngineID*)a)->capacity;

   315

	int vb = ShipVehInfo(*(const EngineID*)b)->capacity;

   316

	int r = va - vb;

   317

   318

	if (r == 0) {

   319

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

   320

		return EngineNumberSorter(a, b);

   321

	}

   322

	return _internal_sort_order ? -r : r;

   323

}

   324

   325

/* Aircraft sorting functions */

   326

   327

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

   328

{

   329

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

   330

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

   331

	int r = va - vb;

   332

   333

	return _internal_sort_order ? -r : r;

   334

}

   335

   336

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

   337

{

   338

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

   339

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

   340

	const int r = va - vb;

   341

   342

	if (r == 0) {

   343

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

   344

		return EngineNumberSorter(a, b);

   345

	}

   346

	return _internal_sort_order ? -r : r;

   347

}

   348

   349

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

   350

{

   351

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

   352

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

   353

	const int r = va - vb;

   354

   355

	if (r == 0) {

   356

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

   357

		return EngineNumberSorter(a, b);

   358

	}

   359

	return _internal_sort_order ? -r : r;

   360

}

   361

   362

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

   363

{

   364

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

   365

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

   366

	int r = va - vb;

   367

   368

	if (r == 0) {

   369

		/* The planes has the same passenger capacity. Check mail capacity instead */

   370

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

   371

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

   372

		r = va - vb;

   373

   374

		if (r == 0) {

   375

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

   376

			return EngineNumberSorter(a, b);

   377

		}

   378

	}

   379

	return _internal_sort_order ? -r : r;

   380

}

   381

   382

static EngList_SortTypeFunction * const _sorter[][10] = {{

   383

	/* Trains */

   384

	&TrainEngineNumberSorter,

   385

	&TrainEngineCostSorter,

   386

	&TrainEngineSpeedSorter,

   387

	&TrainEnginePowerSorter,

   388

	&EngineIntroDateSorter,

   389

	&EngineNameSorter,

   390

	&TrainEngineRunningCostSorter,

   391

	&TrainEnginePowerVsRunningCostSorter,

   392

	&EngineReliabilitySorter,

   393

	&TrainEngineCapacitySorter,

   394

}, {

   395

	/* Road vehicles */

   396

	&EngineNumberSorter,

   397

	&RoadVehEngineCostSorter,

   398

	&RoadVehEngineSpeedSorter,

   399

	&EngineIntroDateSorter,

   400

	&EngineNameSorter,

   401

	&RoadVehEngineRunningCostSorter,

   402

	&EngineReliabilitySorter,

   403

	&RoadVehEngineCapacitySorter,

   404

}, {

   405

	/* Ships */

   406

	&EngineNumberSorter,

   407

	&ShipEngineCostSorter,

   408

	&ShipEngineSpeedSorter,

   409

	&EngineIntroDateSorter,

   410

	&EngineNameSorter,

   411

	&ShipEngineRunningCostSorter,

   412

	&EngineReliabilitySorter,

   413

	&ShipEngineCapacitySorter,

   414

}, {

   415

	/* Aircraft */

   416

	&EngineNumberSorter,

   417

	&AircraftEngineCostSorter,

   418

	&AircraftEngineSpeedSorter,

   419

	&EngineIntroDateSorter,

   420

	&EngineNameSorter,

   421

	&AircraftEngineRunningCostSorter,

   422

	&EngineReliabilitySorter,

   423

	&AircraftEngineCargoSorter,

   424

}};

   425

   426

static const StringID _sort_listing[][11] = {{

   427

	/* Trains */

   428

	STR_ENGINE_SORT_ENGINE_ID,

   429

	STR_ENGINE_SORT_COST,

   430

	STR_SORT_BY_MAX_SPEED,

   431

	STR_ENGINE_SORT_POWER,

   432

	STR_ENGINE_SORT_INTRO_DATE,

   433

	STR_SORT_BY_DROPDOWN_NAME,

   434

	STR_ENGINE_SORT_RUNNING_COST,

   435

	STR_ENGINE_SORT_POWER_VS_RUNNING_COST,

   436

	STR_SORT_BY_RELIABILITY,

   437

	STR_ENGINE_SORT_CARGO_CAPACITY,

   438

	INVALID_STRING_ID

   439

}, {

   440

	/* Road vehicles */

   441

	STR_ENGINE_SORT_ENGINE_ID,

   442

	STR_ENGINE_SORT_COST,

   443

	STR_SORT_BY_MAX_SPEED,

   444

	STR_ENGINE_SORT_INTRO_DATE,

   445

	STR_SORT_BY_DROPDOWN_NAME,

   446

	STR_ENGINE_SORT_RUNNING_COST,

   447

	STR_SORT_BY_RELIABILITY,

   448

	STR_ENGINE_SORT_CARGO_CAPACITY,

   449

	INVALID_STRING_ID

   450

}, {

   451

	/* Ships */

   452

	STR_ENGINE_SORT_ENGINE_ID,

   453

	STR_ENGINE_SORT_COST,

   454

	STR_SORT_BY_MAX_SPEED,

   455

	STR_ENGINE_SORT_INTRO_DATE,

   456

	STR_SORT_BY_DROPDOWN_NAME,

   457

	STR_ENGINE_SORT_RUNNING_COST,

   458

	STR_SORT_BY_RELIABILITY,

   459

	STR_ENGINE_SORT_CARGO_CAPACITY,

   460

	INVALID_STRING_ID

   461

}, {

   462

	/* Aircraft */

   463

	STR_ENGINE_SORT_ENGINE_ID,

   464

	STR_ENGINE_SORT_COST,

   465

	STR_SORT_BY_MAX_SPEED,

   466

	STR_ENGINE_SORT_INTRO_DATE,

   467

	STR_SORT_BY_DROPDOWN_NAME,

   468

	STR_ENGINE_SORT_RUNNING_COST,

   469

	STR_SORT_BY_RELIABILITY,

   470

	STR_ENGINE_SORT_CARGO_CAPACITY,

   471

	INVALID_STRING_ID

   472

}};

   473

   474

static int DrawCargoCapacityInfo(int x, int y, EngineID engine, VehicleType type, bool refittable)

   475

{

   476

	uint16 *cap = GetCapacityOfArticulatedParts(engine, type);

   477

   478

	for (uint c = 0; c < NUM_CARGO; c++) {

   479

		if (cap[c] == 0) continue;

   480

   481

		SetDParam(0, c);

   482

		SetDParam(1, cap[c]);

   483

		SetDParam(2, refittable ? STR_9842_REFITTABLE : STR_EMPTY);

   484

		DrawString(x, y, STR_PURCHASE_INFO_CAPACITY, TC_FROMSTRING);

   485

		y += 10;

   486

   487

		/* Only show as refittable once */

   488

		refittable = false;

   489

	}

   490

   491

	return y;

   492

}

   493

   494

/* Draw rail wagon specific details */

   495

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

   496

{

   497