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

    13

#include "articulated_vehicles.h"

    14

#include "textbuf_gui.h"

    15

#include "station.h"

    16

#include "command_func.h"

    17

#include "engine.h"

    18

#include "player_func.h"

    19

#include "depot.h"

    20

#include "airport.h"

    21

#include "vehicle_gui.h"

    22

#include "newgrf_engine.h"

    23

#include "cargotype.h"

    24

#include "group.h"

    25

#include "road_map.h"

    26

#include "strings_func.h"

    27

#include "window_func.h"

    28

#include "date_func.h"

    29

#include "vehicle_func.h"

    30

#include "settings_type.h"

    31

#include "gfx_func.h"

    32

#include "widgets/dropdown_func.h"

    33

    34

#include "table/sprites.h"

    35

#include "table/strings.h"

    36

    37

struct buildvehicle_d {

    38

	VehicleType vehicle_type;

    39

	union {

    40

		RailTypeByte railtype;

    41

		AirportFTAClass::Flags flags;

    42

		RoadTypes roadtypes;

    43

	} filter;

    44

	byte sel_index;  ///< deprecated value, used for 'unified' ship and road

    45

	bool descending_sort_order;

    46

	byte sort_criteria;

    47

	bool regenerate_list;

    48

	EngineID sel_engine;

    49

	EngineID rename_engine;

    50

	EngineList eng_list;

    51

};

    52

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(buildvehicle_d));

    53

    54

enum BuildVehicleWidgets {

    55

	BUILD_VEHICLE_WIDGET_CLOSEBOX = 0,

    56

	BUILD_VEHICLE_WIDGET_CAPTION,

    57

	BUILD_VEHICLE_WIDGET_SORT_ASSENDING_DESCENDING,

    58

	BUILD_VEHICLE_WIDGET_SORT_DROPDOWN,

    59

	BUILD_VEHICLE_WIDGET_LIST,

    60

	BUILD_VEHICLE_WIDGET_SCROLLBAR,

    61

	BUILD_VEHICLE_WIDGET_PANEL,

    62

	BUILD_VEHICLE_WIDGET_BUILD,

    63

	BUILD_VEHICLE_WIDGET_RENAME,

    64

	BUILD_VEHICLE_WIDGET_RESIZE,

    65

	BUILD_VEHICLE_WIDGET_END

    66

};

    67

    68

static const Widget _build_vehicle_widgets[] = {

    69

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

    70

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

    71

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

    72

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

    73

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

    74

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

    75

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

    76

    77

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

    78

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

    79

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

    80

	{   WIDGETS_END},

    81

};

    82

    83

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

    85

{

    86

	switch (type) {

    89

		case VEH_TRAIN:

    90

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

    91

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

    92

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

    93

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

    94

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

    95

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

    96

			break;

    98

		case VEH_ROAD:

    99

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

   100

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

   101

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

   102

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

   103

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

   104

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

   105

			break;

   107

		case VEH_SHIP:

   108

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

   109

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

   110

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

   111

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

   112

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

   113

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

   114

			break;

   116

		case VEH_AIRCRAFT:

   117

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

   118

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

   119

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

   120

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

   121

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

   122

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

   123

			break;

   124

	}

   125

}

   126

   127

static bool _internal_sort_order; // descending/ascending

   128

   129

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

   130

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

   131

   132

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

   133

{

   134

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

   135

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

   136

	int r = va - vb;

   137

   138

	return _internal_sort_order ? -r : r;

   139

}

   140

   141

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

   142

{

   143

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

   144

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

   145

	const int r = va - vb;

   146

   147

	if (r == 0) {

   148

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

   149

		return EngineNumberSorter(a, b);

   150

	}

   151

	return _internal_sort_order ? -r : r;

   152

}

   153

   154

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

   155

{

   156

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

   157

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

   158

   159

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

   160

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

   161

	int r;

   162

   163

	if (va != last_engine[0]) {

   164

		last_engine[0] = va;

   165

		SetDParam(0, va);

   166

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

   167

	}

   168

   169

	if (vb != last_engine[1]) {

   170

		last_engine[1] = vb;

   171

		SetDParam(0, vb);

   172

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

   173

	}

   174

   175

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

   176

   177

	if (r == 0) {

   178

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

   179

		return EngineNumberSorter(a, b);

   180

	}

   181

	return _internal_sort_order ? -r : r;

   182

}

   183

   184

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

   185

{

   186

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

   187

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

   188

	const int r = va - vb;

   189

   190

	if (r == 0) {

   191

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

   192

		return EngineNumberSorter(a, b);

   193

	}

   194

	return _internal_sort_order ? -r : r;

   195

}

   196

   197

/* Train sorting functions */

   198

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

   199

{

   200

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

   201

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

   202

	int r = va - vb;

   203

   204

	return _internal_sort_order ? -r : r;

   205

}

   206

   207

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

   208

{

   209

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

   210

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

   211

	int r = va - vb;

   212

   213

	return _internal_sort_order ? -r : r;

   214

}

   215

   216

static int CDECL TrainEnginePowerSorter(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

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

   222

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

   223

	int r = va - vb;

   224

   225

	return _internal_sort_order ? -r : r;

   226

}

   227

   228

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

   229

{

   230

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

   231

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

   232

   233

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

   234

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

   235

	int r = ClampToI32(va - vb);

   236

   237

	return _internal_sort_order ? -r : r;

   238

}

   239

   240

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

   241

{

   242

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

   243

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

   244

   245

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

   246

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

   247

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

   248

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

   249

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

   250

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

   251

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

   252

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

   253

	int r = ClampToI32(vb - va);

   254

   255

	return _internal_sort_order ? -r : r;

   256

}

   257

   258

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

   259

{

   260

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

   261

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

   262

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

   263

   264

	return _internal_sort_order ? -r : r;

   265

}

   266

   267

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

   268

{

   269

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

   270

	int vb = RailVehInfo(*(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

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

   281

{

   282

	EngineID va = *(const EngineID*)a;

   283

	EngineID vb = *(const EngineID*)b;

   284

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

   285

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

   286

	int r = val_a - val_b;

   287

   288

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

   289

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

   290

   291

	return _internal_sort_order ? -r : r;

   292

}

   293

   294

/* Road vehicle sorting functions */

   295

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

   296

{

   297

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

   298

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

   299

	int r = va - vb;

   300

   301

	return _internal_sort_order ? -r : r;

   302

}

   303

   304

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

   305

{

   306

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

   307

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

   308

	int r = va - vb;

   309

   310

	return _internal_sort_order ? -r : r;

   311

}

   312

   313

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

   314

{

   315

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

   316

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

   317

	const int r = va - vb;

   318

   319

	if (r == 0) {

   320

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

   321

		return EngineNumberSorter(a, b);

   322

	}

   323

	return _internal_sort_order ? -r : r;

   324

}

   325

   326

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

   327

{

   328

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

   329

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

   330

	int r = va - vb;

   331

   332

	if (r == 0) {

   333

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

   334

		return EngineNumberSorter(a, b);

   335

	}

   336

	return _internal_sort_order ? -r : r;

   337

}

   338

   339

/* Road vehicle sorting functions */

   340

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

   341

{

   342

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

   343

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

   344

	int r = va - vb;

   345

   346

	return _internal_sort_order ? -r : r;

   347

}

   348

   349

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

   350

{

   351

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

   352

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

   353

	int r = va - vb;

   354

   355

	return _internal_sort_order ? -r : r;

   356

}

   357

   358

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

   359

{

   360

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

   361

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

   362

	const int r = va - vb;

   363

   364

	if (r == 0) {

   365

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

   366

		return EngineNumberSorter(a, b);

   367

	}

   368

	return _internal_sort_order ? -r : r;

   369

}

   370

   371

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

   372

{

   373

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

   374

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

   375

	int r = va - vb;

   376

   377

	if (r == 0) {

   378

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

   379

		return EngineNumberSorter(a, b);

   380

	}

   381

	return _internal_sort_order ? -r : r;

   382

}

   383

   384

/* Aircraft sorting functions */

   385

   386

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

   387

{

   388

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

   389

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

   390

	int r = va - vb;

   391

   392

	return _internal_sort_order ? -r : r;

   393

}

   394

   395

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

   396

{

   397

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

   398

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

   399

	const int r = va - vb;

   400

   401

	if (r == 0) {

   402

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

   403

		return EngineNumberSorter(a, b);

   404

	}

   405

	return _internal_sort_order ? -r : r;

   406

}

   407

   408

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

   409

{

   410

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

   411

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

   412

	const int r = va - vb;

   413

   414

	if (r == 0) {

   415

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

   416

		return EngineNumberSorter(a, b);

   417

	}

   418

	return _internal_sort_order ? -r : r;

   419

}

   420

   421

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

   422

{

   423

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

   424

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

   425

	int r = va - vb;

   426

   427

	if (r == 0) {

   428

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

   429

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

   430

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

   431

		r = va - vb;

   432

   433

		if (r == 0) {

   434

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

   435

			return EngineNumberSorter(a, b);

   436

		}

   437

	}

   438

	return _internal_sort_order ? -r : r;

   439

}

   440

   441

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

   442

	/* Trains */

   443

	&TrainEngineNumberSorter,

   444

	&TrainEngineCostSorter,

   445

	&TrainEngineSpeedSorter,

   446

	&TrainEnginePowerSorter,

   447

	&EngineIntroDateSorter,

   448

	&EngineNameSorter,

   449

	&TrainEngineRunningCostSorter,

   450

	&TrainEnginePowerVsRunningCostSorter,

   451

	&EngineReliabilitySorter,

   452

	&TrainEngineCapacitySorter,

   453

}, {

   454

	/* Road vehicles */

   455

	&EngineNumberSorter,

   456

	&RoadVehEngineCostSorter,

   457

	&RoadVehEngineSpeedSorter,

   458

	&EngineIntroDateSorter,

   459

	&EngineNameSorter,

   460

	&RoadVehEngineRunningCostSorter,

   461

	&EngineReliabilitySorter,

   462

	&RoadVehEngineCapacitySorter,

   463

}, {

   464

	/* Ships */

   465

	&EngineNumberSorter,

   466

	&ShipEngineCostSorter,

   467

	&ShipEngineSpeedSorter,

   468

	&EngineIntroDateSorter,

   469

	&EngineNameSorter,

   470

	&ShipEngineRunningCostSorter,

   471

	&EngineReliabilitySorter,

   472

	&ShipEngineCapacitySorter,

   473

}, {

   474

	/* Aircraft */

   475

	&EngineNumberSorter,

   476

	&AircraftEngineCostSorter,

   477

	&AircraftEngineSpeedSorter,

   478

	&EngineIntroDateSorter,

   479

	&EngineNameSorter,

   480

	&AircraftEngineRunningCostSorter,

   481

	&EngineReliabilitySorter,

   482

	&AircraftEngineCargoSorter,

   483

}};

   484

   485

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

   486

	/* Trains */

   487

	STR_ENGINE_SORT_ENGINE_ID,

   488

	STR_ENGINE_SORT_COST,

   489

	STR_SORT_BY_MAX_SPEED,

   490

	STR_ENGINE_SORT_POWER,

   491

	STR_ENGINE_SORT_INTRO_DATE,

   492

	STR_SORT_BY_DROPDOWN_NAME,

   493

	STR_ENGINE_SORT_RUNNING_COST,

   494

	STR_ENGINE_SORT_POWER_VS_RUNNING_COST,

   495

	STR_SORT_BY_RELIABILITY,

   496

	STR_ENGINE_SORT_CARGO_CAPACITY,

   497

	INVALID_STRING_ID