1

/* $Id$ */

     2

     3

/** @file autoreplace_gui.cpp GUI for autoreplace handling. */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "debug.h"

     8

#include "gui.h"

     9

#include "command_func.h"

    10

#include "variables.h"

    11

#include "vehicle_gui.h"

    12

#include "newgrf_engine.h"

    13

#include "group.h"

    14

#include "rail.h"

    15

#include "strings_func.h"

    16

#include "window_func.h"

    17

#include "vehicle_func.h"

    18

#include "autoreplace_func.h"

    19

#include "gfx_func.h"

    20

#include "player_func.h"

    21

#include "widgets/dropdown_func.h"

    22

#include "engine_func.h"

    23

#include "engine_base.h"

    24

#include "window_gui.h"

    25

#include "engine_gui.h"

    26

    27

#include "table/sprites.h"

    28

#include "table/strings.h"

    29

    31

    32

static const StringID _rail_types_list[] = {

    33

	STR_RAIL_VEHICLES,

    34

	STR_ELRAIL_VEHICLES,

    35

	STR_MONORAIL_VEHICLES,

    36

	STR_MAGLEV_VEHICLES,

    37

	INVALID_STRING_ID

    38

};

    39

    40

enum ReplaceVehicleWindowWidgets {

    41

	RVW_WIDGET_LEFT_MATRIX = 3,

    42

	RVW_WIDGET_LEFT_SCROLLBAR,

    43

	RVW_WIDGET_RIGHT_MATRIX,

    44

	RVW_WIDGET_RIGHT_SCROLLBAR,

    45

	RVW_WIDGET_LEFT_DETAILS,

    46

	RVW_WIDGET_RIGHT_DETAILS,

    47

    48

	/* Button row */

    49

	RVW_WIDGET_START_REPLACE,

    50

	RVW_WIDGET_INFO_TAB,

    51

	RVW_WIDGET_STOP_REPLACE,

    52

	RVW_WIDGET_RESIZE,

    53

    54

	/* Train only widgets */

    55

	RVW_WIDGET_TRAIN_ENGINEWAGON_TOGGLE,

    56

	RVW_WIDGET_TRAIN_FLUFF_LEFT,

    57

	RVW_WIDGET_TRAIN_RAILTYPE_DROPDOWN,

    58

	RVW_WIDGET_TRAIN_FLUFF_RIGHT,

    59

	RVW_WIDGET_TRAIN_WAGONREMOVE_TOGGLE,

    60

};

    61

    62

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

    63

{

    64

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

    65

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

    66

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

    67

    68

	return r;

    69

}

    70

    71

/** Rebuild the left autoreplace list if an engine is removed or added

    72

 * @param e Engine to check if it is removed or added

    73

 * @param id_g The group the engine belongs to

    74

 *  Note: this function only works if it is called either

    75

 *   - when a new vehicle is build, but before it's counted in num_engines

    76

 *   - when a vehicle is deleted and after it's substracted from num_engines

    77

 *   - when not changing the count (used when changing replace orders)

    78

 */

    79

void InvalidateAutoreplaceWindow(EngineID e, GroupID id_g)

    80

{

    81

	Player *p = GetPlayer(_local_player);

    82

	uint num_engines = GetGroupNumEngines(_local_player, id_g, e);

    83

    84

	if (num_engines == 0 || p->num_engines[e] == 0) {

    85

		/* We don't have any of this engine type.

    86

		 * Either we just sold the last one, we build a new one or we stopped replacing it.

    87

		 * In all cases, we need to update the left list */

    88

		InvalidateWindowData(WC_REPLACE_VEHICLE, GetEngine(e)->type, true);

    89

	}

    90

}

    91

    92

/** When an engine is made buildable or is removed from being buildable, add/remove it from the build/autoreplace lists

    93

 * @param type The type of engine

    94

 */

    95

void AddRemoveEngineFromAutoreplaceAndBuildWindows(VehicleType type)

    96

{

    97

	InvalidateWindowData(WC_REPLACE_VEHICLE, type, false); // Update the autoreplace window

    98

	InvalidateWindowClassesData(WC_BUILD_VEHICLE); // The build windows needs updating as well

    99

}

   100

   101

/** Get the default cargo type for an engine

   102

 * @param engine the EngineID to get the cargo for

   103

 * @return the cargo type carried by the engine (CT_INVALID if engine got no cargo capacity)

   104

 */

   105

static CargoID EngineCargo(EngineID engine)

   106

{

   107

	if (engine == INVALID_ENGINE) return CT_INVALID; // surely INVALID_ENGINE can't carry anything but CT_INVALID

   108

   109

	switch (GetEngine(engine)->type) {

   110

		default: NOT_REACHED();

   111

		case VEH_TRAIN:

   112

			if (RailVehInfo(engine)->capacity == 0) return CT_INVALID; // no capacity -> can't carry cargo

   113

			return RailVehInfo(engine)->cargo_type;

   114

		case VEH_ROAD:       return RoadVehInfo(engine)->cargo_type;

   115

		case VEH_SHIP:       return ShipVehInfo(engine)->cargo_type;

   116

		case VEH_AIRCRAFT:   return CT_PASSENGERS; // all planes are build with passengers by default

   117

	}

   118

}

   119

   120

/** Figure out if two engines got at least one type of cargo in common (refitting if needed)

   121

 * @param engine_a one of the EngineIDs

   122

 * @param engine_b the other EngineID

   123

 * @return true if they can both carry the same type of cargo (or at least one of them got no capacity at all)

   124

 */

   125

static bool EnginesGotCargoInCommon(EngineID engine_a, EngineID engine_b)

   126

{

   127

	CargoID a = EngineCargo(engine_a);

   128

	CargoID b = EngineCargo(engine_b);

   129

   130

	 /* we should always be able to refit to/from locomotives without capacity

   131

	  * Because of that, CT_INVALID shoudl always return true */

   132

	if (a == CT_INVALID || b == CT_INVALID || a == b) return true; // they carry no ro the same type by default

   133

	if (EngInfo(engine_a)->refit_mask & EngInfo(engine_b)->refit_mask) return true; // both can refit to the same

   134

	if (CanRefitTo(engine_a, b) || CanRefitTo(engine_b, a)) return true; // one can refit to what the other one carries

   135

	return false;

   136

}

   137

   138

/**

   139

 * Window for the autoreplacing of vehicles.

   140

 */

   141

class ReplaceVehicleWindow : public Window {

   142

	byte sel_index[2];

   143

	EngineID sel_engine[2];

   144

	uint16 count[2];

   145

	bool wagon_btnstate; ///< true means engine is selected

   147

	bool update_left;

   148

	bool update_right;

   149

	bool init_lists;

   150

	GroupID sel_group;

   151

	static RailType sel_railtype;

   152

   153

	/** Figure out if an engine should be added to a list

   154

	 * @param e The EngineID

   155

	 * @param draw_left If true, then the left list is drawn (the engines specific to the railtype you selected)

   156

	 * @param show_engines if truem then locomotives are drawn, else wagons (never both)

   157

	 * @return true if the engine should be in the list (based on this check)

   158

	 */

   159

	bool GenerateReplaceRailList(EngineID e, bool draw_left, bool show_engines)

   160

	{

   161

		const RailVehicleInfo *rvi = RailVehInfo(e);

   162

   163

		/* Ensure that the wagon/engine selection fits the engine. */

   164

		if ((rvi->railveh_type == RAILVEH_WAGON) == show_engines) return false;

   165

   166

		if (draw_left && show_engines) {

   167

			/* Ensure that the railtype is specific to the selected one */

   168

			if (rvi->railtype != this->sel_railtype) return false;

   169

		} else {

   170

			/* Ensure that it's a compatible railtype to the selected one (like electric <-> diesel)

   171

			 * The vehicle do not have to have power on the railtype in question, only able to drive (pulled if needed) */

   172

			if (!IsCompatibleRail(rvi->railtype, this->sel_railtype)) return false;

   173

		}

   174

		return true;

   175

	}

   176

   177

   178

	/** Generate a list

   179

	 * @param w Window, that contains the list

   180

	 * @param draw_left true if generating the left list, otherwise false

   181

	 */

   182

	void GenerateReplaceVehList(Window *w, bool draw_left)

   183

	{

   184

		EngineID selected_engine = INVALID_ENGINE;

   185

		VehicleType type = (VehicleType)this->window_number;

   186

		byte i = draw_left ? 0 : 1;

   187

   190

   191

		const Engine *e;

   192

		FOR_ALL_ENGINES_OF_TYPE(e, type) {

   193

			EngineID eid = e->index;

   194

			if (type == VEH_TRAIN && !GenerateReplaceRailList(eid, draw_left, this->wagon_btnstate)) continue; // special rules for trains

   195

   196

			if (draw_left) {

   197

				const GroupID selected_group = this->sel_group;

   198

				const uint num_engines = GetGroupNumEngines(_local_player, selected_group, eid);

   199

   200

				/* Skip drawing the engines we don't have any of and haven't set for replacement */

   201

				if (num_engines == 0 && EngineReplacementForPlayer(GetPlayer(_local_player), eid, selected_group) == INVALID_ENGINE) continue;

   202

			} else {

   203

				/* This is for engines we can replace to and they should depend on what we selected to replace from */

   204

				if (!IsEngineBuildable(eid, type, _local_player)) continue; // we need to be able to build the engine

   205

				if (!EnginesGotCargoInCommon(eid, this->sel_engine[0])) continue; // the engines needs to be able to carry the same cargo

   206

   207

				/* Road vehicles can't be replaced by trams and vice-versa */

   208

				if (type == VEH_ROAD && HasBit(EngInfo(this->sel_engine[0])->misc_flags, EF_ROAD_TRAM) != HasBit(e->info.misc_flags, EF_ROAD_TRAM)) continue;

   209

				if (eid == this->sel_engine[0]) continue; // we can't replace an engine into itself (that would be autorenew)

   210

			}

   211

   213

			if (eid == this->sel_engine[i]) selected_engine = eid; // The selected engine is still in the list

   214

		}

   215

		this->sel_engine[i] = selected_engine; // update which engine we selected (the same or none, if it's not in the list anymore)

   216

		if (type == VEH_TRAIN) EngList_Sort(list, &TrainEngineNumberSorter);

   217

	}

   218

   219

	/** Generate the lists */

   220

	void GenerateLists()

   221

	{

   222

		EngineID e = this->sel_engine[0];

   223

   224

		if (this->update_left == true) {

   225

			/* We need to rebuild the left list */

   226

			GenerateReplaceVehList(this, true);

   229

				this->sel_engine[0] = this->list[0][0];

   230

			}

   231

		}

   232

   233

		if (this->update_right || e != this->sel_engine[0]) {

   234

			/* Either we got a request to rebuild the right list or the left list selected a different engine */

   235

			if (this->sel_engine[0] == INVALID_ENGINE) {

   236

				/* Always empty the right list when nothing is selected in the left list */

   238

				this->sel_engine[1] = INVALID_ENGINE;

   239

			} else {

   240

				GenerateReplaceVehList(this, false);

   243

					this->sel_engine[1] = this->list[1][0];

   244

				}

   245

			}

   246

		}

   247

		/* Reset the flags about needed updates */

   248

		this->update_left  = false;

   249

		this->update_right = false;

   250

		this->init_lists   = false;

   251

	}

   252

   253

public:

   254

	ReplaceVehicleWindow(const WindowDesc *desc, VehicleType vehicletype, GroupID id_g) : Window(desc, vehicletype)

   255

	{

   256

		this->wagon_btnstate = true; // start with locomotives (all other vehicles will not read this bool)

   257

		this->update_left   = true;

   258

		this->update_right  = true;

   259

		this->init_lists    = true;

   260

		this->sel_engine[0] = INVALID_ENGINE;

   261

		this->sel_engine[1] = INVALID_ENGINE;

   262

   263

		this->resize.step_height = GetVehicleListHeight(vehicletype);

   264

		this->vscroll.cap = this->resize.step_height == 14 ? 8 : 4;

   265

   266

		Widget *widget = this->widget;

   267

		widget[RVW_WIDGET_LEFT_MATRIX].data = widget[RVW_WIDGET_RIGHT_MATRIX].data = (this->vscroll.cap << 8) + 1;

   268

   269

		if (vehicletype == VEH_TRAIN) {

   270

			this->wagon_btnstate = true;

   271

			/* The train window is bigger so we will move some of the widgets to fit the new size.

   272

			* We will start by moving the resize button to the lower right corner.                 */

   273

			widget[RVW_WIDGET_RESIZE].top         = widget[RVW_WIDGET_TRAIN_ENGINEWAGON_TOGGLE].top;

   274

			widget[RVW_WIDGET_RESIZE].bottom      = widget[RVW_WIDGET_TRAIN_ENGINEWAGON_TOGGLE].bottom;

   275

			widget[RVW_WIDGET_STOP_REPLACE].right = widget[RVW_WIDGET_RESIZE].right;

   276

   277

			/* The detail panel is one line taller for trains so we will move some of the widgets one line (10 pixels) down. */

   278

			widget[RVW_WIDGET_LEFT_DETAILS].bottom  += 10;

   279

			widget[RVW_WIDGET_RIGHT_DETAILS].bottom += 10;

   280

			for (int i = RVW_WIDGET_START_REPLACE; i < RVW_WIDGET_RESIZE; i++) {

   281

				widget[i].top    += 10;

   282

				widget[i].bottom += 10;

   283

			}

   284

		} else {

   285

			/* Since it's not a train we will hide the train only widgets. */

   286

			this->SetWidgetsHiddenState(true,

   287

									RVW_WIDGET_TRAIN_ENGINEWAGON_TOGGLE,

   288

									RVW_WIDGET_TRAIN_FLUFF_LEFT,

   289

									RVW_WIDGET_TRAIN_RAILTYPE_DROPDOWN,

   290

									RVW_WIDGET_TRAIN_FLUFF_RIGHT,

   291

									RVW_WIDGET_TRAIN_WAGONREMOVE_TOGGLE,

   292

									WIDGET_LIST_END);

   293

		}

   294

   295

		ResizeWindow(this, 0, this->resize.step_height * this->vscroll.cap);

   296

   297

		/* Set the minimum window size to the current window size */

   298

		this->resize.width  = this->width;

   299

		this->resize.height = this->height;

   300

   301

		this->caption_color = _local_player;

   302

		this->sel_group = id_g;

   303

		this->vscroll2.cap = this->vscroll.cap;   // these two are always the same

   304

   305

		this->FindWindowPlacementAndResize(desc);

   306

	}

   307

   308

	virtual void OnPaint()

   309

	{

   310

		static const StringID _vehicle_type_names[] = {

   311

			STR_019F_TRAIN,

   312

			STR_019C_ROAD_VEHICLE,

   313

			STR_019E_SHIP,

   314

			STR_019D_AIRCRAFT

   315

		};

   316

   317

		if (this->update_left || this->update_right) this->GenerateLists();

   318

   319

		Player *p = GetPlayer(_local_player);

   320

		EngineID selected_id[2];

   321

		const GroupID selected_group = this->sel_group;

   322

   323

		selected_id[0] = this->sel_engine[0];

   324

		selected_id[1] = this->sel_engine[1];

   325

   326

		/* Disable the "Start Replacing" button if:

   327

		 *    Either list is empty

   328

		 * or The selected replacement engine has a replacement (to prevent loops)

   329

		 * or The right list (new replacement) has the existing replacement vehicle selected */

   330

		this->SetWidgetDisabledState(RVW_WIDGET_START_REPLACE,

   331

										selected_id[0] == INVALID_ENGINE ||

   332

										selected_id[1] == INVALID_ENGINE ||

   333

										EngineReplacementForPlayer(p, selected_id[1], selected_group) != INVALID_ENGINE ||

   334

										EngineReplacementForPlayer(p, selected_id[0], selected_group) == selected_id[1]);

   335

   336

		/* Disable the "Stop Replacing" button if:

   337

		 *   The left list (existing vehicle) is empty

   338

		 *   or The selected vehicle has no replacement set up */

   339

		this->SetWidgetDisabledState(RVW_WIDGET_STOP_REPLACE,

   340

										selected_id[0] == INVALID_ENGINE ||

   341

										!EngineHasReplacementForPlayer(p, selected_id[0], selected_group));

   342

   343

		/* now the actual drawing of the window itself takes place */

   344

		SetDParam(0, _vehicle_type_names[this->window_number]);

   345

   346

		if (this->window_number == VEH_TRAIN) {

   347

			/* set on/off for renew_keep_length */

   348

			SetDParam(1, p->renew_keep_length ? STR_CONFIG_PATCHES_ON : STR_CONFIG_PATCHES_OFF);

   349

   350

			/* set wagon/engine button */

   351

			SetDParam(2, this->wagon_btnstate ? STR_ENGINES : STR_WAGONS);

   352

   353

			/* sets the colour of that art thing */

   354

			this->widget[RVW_WIDGET_TRAIN_FLUFF_LEFT].color  = _player_colors[_local_player];

   355

			this->widget[RVW_WIDGET_TRAIN_FLUFF_RIGHT].color = _player_colors[_local_player];

   356

		}

   357

   358

		if (this->window_number == VEH_TRAIN) {

   359

			/* Show the selected railtype in the pulldown menu */

   360

			this->widget[RVW_WIDGET_TRAIN_RAILTYPE_DROPDOWN].data = _rail_types_list[sel_railtype];

   361

		}

   362

   363

		this->DrawWidgets();

   364

   365

		/* sets up the string for the vehicle that is being replaced to */

   366

		if (selected_id[0] != INVALID_ENGINE) {

   367

			if (!EngineHasReplacementForPlayer(p, selected_id[0], selected_group)) {

   368

				SetDParam(0, STR_NOT_REPLACING);

   369

			} else {

   370

				SetDParam(0, STR_ENGINE_NAME);

   371

				SetDParam(1, EngineReplacementForPlayer(p, selected_id[0], selected_group));

   372

			}

   373

		} else {

   374

			SetDParam(0, STR_NOT_REPLACING_VEHICLE_SELECTED);

   375

		}

   376

   377

		DrawString(145, this->widget[RVW_WIDGET_INFO_TAB].top + 1, STR_02BD, TC_BLACK);

   378

   379

		/* Draw the lists */

   380

		for (byte i = 0; i < 2; i++) {

   381

			uint widget     = (i == 0) ? RVW_WIDGET_LEFT_MATRIX : RVW_WIDGET_RIGHT_MATRIX;

   383

			EngineID start  = i == 0 ? this->vscroll.pos : this->vscroll2.pos; // what is the offset for the start (scrolling)

   385

   386

			/* Do the actual drawing */

   387

			DrawEngineList((VehicleType)this->window_number, this->widget[widget].left + 2, this->widget[widget].top + 1, list, start, end, this->sel_engine[i], i == 0 ? this->widget[RVW_WIDGET_LEFT_MATRIX].right - 2 : 0, selected_group);

   388

   389

			/* Also draw the details if an engine is selected */

   390

			if (this->sel_engine[i] != INVALID_ENGINE) {

   391

				const Widget *wi = &this->widget[i == 0 ? RVW_WIDGET_LEFT_DETAILS : RVW_WIDGET_RIGHT_DETAILS];

   392

				int text_end = DrawVehiclePurchaseInfo(wi->left + 2, wi->top + 1, wi->right - wi->left - 2, this->sel_engine[i]);

   393

   394

				if (text_end > wi->bottom) {

   395

					this->SetDirty();

   396

					ResizeWindowForWidget(this, i == 0 ? RVW_WIDGET_LEFT_DETAILS : RVW_WIDGET_RIGHT_DETAILS, 0, text_end - wi->bottom);

   397

					this->SetDirty();

   398

				}

   399

			}

   400

		}

   401

	}

   402

   403

	virtual void OnClick(Point pt, int widget)

   404

	{

   405

		switch (widget) {

   406

			case RVW_WIDGET_TRAIN_ENGINEWAGON_TOGGLE:

   407

				this->wagon_btnstate = !(this->wagon_btnstate);

   408

				this->update_left = true;

   409

				this->init_lists  = true;

   410

				this->SetDirty();

   411

				break;

   412

   413

			case RVW_WIDGET_TRAIN_RAILTYPE_DROPDOWN: /* Railtype selection dropdown menu */

   414

				ShowDropDownMenu(this, _rail_types_list, sel_railtype, RVW_WIDGET_TRAIN_RAILTYPE_DROPDOWN, 0, ~GetPlayer(_local_player)->avail_railtypes);

   415

				break;

   416

   417

			case RVW_WIDGET_TRAIN_WAGONREMOVE_TOGGLE: /* toggle renew_keep_length */

   418

				DoCommandP(0, 5, GetPlayer(_local_player)->renew_keep_length ? 0 : 1, NULL, CMD_SET_AUTOREPLACE);

   419

				break;

   420

   421

			case RVW_WIDGET_START_REPLACE: { /* Start replacing */

   422

				EngineID veh_from = this->sel_engine[0];

   423

				EngineID veh_to = this->sel_engine[1];

   424

				DoCommandP(0, 3 + (this->sel_group << 16) , veh_from + (veh_to << 16), NULL, CMD_SET_AUTOREPLACE);

   425

			} break;

   426

   427

			case RVW_WIDGET_STOP_REPLACE: { /* Stop replacing */

   428

				EngineID veh_from = this->sel_engine[0];

   429

				DoCommandP(0, 3 + (this->sel_group << 16), veh_from + (INVALID_ENGINE << 16), NULL, CMD_SET_AUTOREPLACE);

   430

			} break;

   431

   432

			case RVW_WIDGET_LEFT_MATRIX:

   433

			case RVW_WIDGET_RIGHT_MATRIX: {

   434

				uint i = (pt.y - 14) / this->resize.step_height;

   435

				uint16 click_scroll_pos = widget == RVW_WIDGET_LEFT_MATRIX ? this->vscroll.pos : this->vscroll2.pos;

   436

				uint16 click_scroll_cap = widget == RVW_WIDGET_LEFT_MATRIX ? this->vscroll.cap : this->vscroll2.cap;

   437

				byte click_side         = widget == RVW_WIDGET_LEFT_MATRIX ? 0 : 1;

   439

   440

				if (i < click_scroll_cap) {

   441

					i += click_scroll_pos;

   442

					EngineID e = engine_count > i ? this->list[click_side][i] : INVALID_ENGINE;

   443

					if (e == this->sel_engine[click_side]) break; // we clicked the one we already selected

   444

					this->sel_engine[click_side] = e;

   445

					if (click_side == 0) {

   446

						this->update_right = true;

   447

						this->init_lists   = true;

   448

					}

   449

					this->SetDirty();

   450

					}

   451

				break;

   452

				}

   453

		}

   454

	}

   455

   456

	virtual void OnDropdownSelect(int widget, int index)

   457

	{

   458

		RailType temp = (RailType)index;

   459

		if (temp == sel_railtype) return; // we didn't select a new one. No need to change anything

   460

		sel_railtype = temp;

   461

		/* Reset scrollbar positions */

   462

		this->vscroll.pos  = 0;

   463

		this->vscroll2.pos = 0;

   464

		/* Rebuild the lists */

   465

		this->update_left  = true;

   466

		this->update_right = true;

   467

		this->init_lists   = true;

   468

		this->SetDirty();

   469

	}

   470

   471

	virtual void OnResize(Point new_size, Point delta) {

   472

		this->vscroll.cap  += delta.y / (int)this->resize.step_height;

   473

		this->vscroll2.cap += delta.y / (int)this->resize.step_height;

   474

   475

		Widget *widget = this->widget;

   476

   477

		widget[RVW_WIDGET_LEFT_MATRIX].data = widget[RVW_WIDGET_RIGHT_MATRIX].data = (this->vscroll2.cap << 8) + 1;

   478

   479

		if (delta.x != 0) {

   480

			/* We changed the width of the window so we have to resize the lists.

   481

				* Because ResizeButtons() makes each widget the same size it can't be used on the lists

   482

				* because then the lists would have the same size as the scrollbars.

   483

				* Instead we use it on the detail panels.

   484

				* Afterwards we use the new location of the detail panels (the middle of the window)

   485

				* to place the lists.

   486

				* This way the lists will have equal size while keeping the width of the scrollbars unchanged. */

   487

			ResizeButtons(this, RVW_WIDGET_LEFT_DETAILS, RVW_WIDGET_RIGHT_DETAILS);

   488

			widget[RVW_WIDGET_RIGHT_MATRIX].left    = widget[RVW_WIDGET_RIGHT_DETAILS].left;

   489

			widget[RVW_WIDGET_LEFT_SCROLLBAR].right = widget[RVW_WIDGET_LEFT_DETAILS].right;