1 /*
2  * This file is part of OpenTTD.
3  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6  */
7 
8 /** @file depot_gui.cpp The GUI for depots. */
9 
10 #include "stdafx.h"
11 #include "train.h"
12 #include "roadveh.h"
13 #include "ship.h"
14 #include "aircraft.h"
15 #include "gui.h"
16 #include "textbuf_gui.h"
17 #include "viewport_func.h"
18 #include "command_func.h"
19 #include "depot_base.h"
20 #include "spritecache.h"
21 #include "strings_func.h"
22 #include "vehicle_func.h"
23 #include "company_func.h"
24 #include "tilehighlight_func.h"
25 #include "window_gui.h"
26 #include "vehiclelist.h"
27 #include "order_backup.h"
28 #include "zoom_func.h"
29 
30 #include "widgets/depot_widget.h"
31 
32 #include "table/strings.h"
33 
34 #include "safeguards.h"
35 
36 /*
37  * Since all depot window sizes aren't the same, we need to modify sizes a little.
38  * It's done with the following arrays of widget indexes. Each of them tells if a widget side should be moved and in what direction.
39  * How long they should be moved and for what window types are controlled in ShowDepotWindow()
40  */
41 
42 /** Nested widget definition for train depots. */
43 static const NWidgetPart _nested_train_depot_widgets[] = {
44 	NWidget(NWID_HORIZONTAL),
45 		NWidget(WWT_CLOSEBOX, COLOUR_GREY),
46 		NWidget(NWID_SELECTION, INVALID_COLOUR, WID_D_SHOW_RENAME), // rename button
47 			NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_D_RENAME), SetMinimalSize(12, 14), SetDataTip(SPR_RENAME, STR_DEPOT_RENAME_TOOLTIP),
48 		EndContainer(),
49 		NWidget(WWT_CAPTION, COLOUR_GREY, WID_D_CAPTION), SetDataTip(STR_DEPOT_CAPTION, STR_NULL),
50 		NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_D_LOCATION), SetMinimalSize(12, 14), SetDataTip(SPR_GOTO_LOCATION, STR_NULL),
51 		NWidget(WWT_SHADEBOX, COLOUR_GREY),
52 		NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
53 		NWidget(WWT_STICKYBOX, COLOUR_GREY),
54 	EndContainer(),
55 	NWidget(NWID_HORIZONTAL),
56 		NWidget(NWID_VERTICAL),
57 			NWidget(WWT_MATRIX, COLOUR_GREY, WID_D_MATRIX), SetResize(1, 1), SetScrollbar(WID_D_V_SCROLL),
58 			NWidget(NWID_SELECTION, INVALID_COLOUR, WID_D_SHOW_H_SCROLL),
59 				NWidget(NWID_HSCROLLBAR, COLOUR_GREY, WID_D_H_SCROLL),
60 			EndContainer(),
61 		EndContainer(),
62 		NWidget(NWID_VERTICAL),
63 			NWidget(WWT_IMGBTN, COLOUR_GREY, WID_D_SELL), SetDataTip(0x0, STR_NULL), SetResize(0, 1), SetFill(0, 1),
64 			NWidget(NWID_SELECTION, INVALID_COLOUR, WID_D_SHOW_SELL_CHAIN),
65 				NWidget(WWT_IMGBTN, COLOUR_GREY, WID_D_SELL_CHAIN), SetDataTip(SPR_SELL_CHAIN_TRAIN, STR_DEPOT_DRAG_WHOLE_TRAIN_TO_SELL_TOOLTIP), SetResize(0, 1), SetFill(0, 1),
66 			EndContainer(),
67 			NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_D_SELL_ALL), SetDataTip(0x0, STR_NULL),
68 			NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_D_AUTOREPLACE), SetDataTip(0x0, STR_NULL),
69 		EndContainer(),
70 		NWidget(NWID_VSCROLLBAR, COLOUR_GREY, WID_D_V_SCROLL),
71 	EndContainer(),
72 	NWidget(NWID_HORIZONTAL, NC_EQUALSIZE),
73 		NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_D_BUILD), SetDataTip(0x0, STR_NULL), SetFill(1, 1), SetResize(1, 0),
74 		NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_D_CLONE), SetDataTip(0x0, STR_NULL), SetFill(1, 1), SetResize(1, 0),
75 		NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_D_VEHICLE_LIST), SetDataTip(0x0, STR_NULL), SetFill(0, 1),
76 		NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_D_STOP_ALL), SetDataTip(SPR_FLAG_VEH_STOPPED, STR_NULL), SetFill(0, 1),
77 		NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_D_START_ALL), SetDataTip(SPR_FLAG_VEH_RUNNING, STR_NULL), SetFill(0, 1),
78 		NWidget(WWT_RESIZEBOX, COLOUR_GREY),
79 	EndContainer(),
80 };
81 
82 static WindowDesc _train_depot_desc(
83 	WDP_AUTO, "depot_train", 362, 123,
84 	WC_VEHICLE_DEPOT, WC_NONE,
85 	0,
86 	_nested_train_depot_widgets, lengthof(_nested_train_depot_widgets)
87 );
88 
89 static WindowDesc _road_depot_desc(
90 	WDP_AUTO, "depot_roadveh", 316, 97,
91 	WC_VEHICLE_DEPOT, WC_NONE,
92 	0,
93 	_nested_train_depot_widgets, lengthof(_nested_train_depot_widgets)
94 );
95 
96 static WindowDesc _ship_depot_desc(
97 	WDP_AUTO, "depot_ship", 306, 99,
98 	WC_VEHICLE_DEPOT, WC_NONE,
99 	0,
100 	_nested_train_depot_widgets, lengthof(_nested_train_depot_widgets)
101 );
102 
103 static WindowDesc _aircraft_depot_desc(
104 	WDP_AUTO, "depot_aircraft", 332, 99,
105 	WC_VEHICLE_DEPOT, WC_NONE,
106 	0,
107 	_nested_train_depot_widgets, lengthof(_nested_train_depot_widgets)
108 );
109 
110 extern void DepotSortList(VehicleList *list);
111 
112 /**
113  * This is the Callback method after the cloning attempt of a vehicle
114  * @param result the result of the cloning command
115  * @param tile unused
116  * @param p1 unused
117  * @param p2 unused
118  * @param cmd unused
119  */
CcCloneVehicle(const CommandCost & result,TileIndex tile,uint32 p1,uint32 p2,uint32 cmd)120 void CcCloneVehicle(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2, uint32 cmd)
121 {
122 	if (result.Failed()) return;
123 
124 	const Vehicle *v = Vehicle::Get(_new_vehicle_id);
125 
126 	ShowVehicleViewWindow(v);
127 }
128 
TrainDepotMoveVehicle(const Vehicle * wagon,VehicleID sel,const Vehicle * head)129 static void TrainDepotMoveVehicle(const Vehicle *wagon, VehicleID sel, const Vehicle *head)
130 {
131 	const Vehicle *v = Vehicle::Get(sel);
132 
133 	if (v == wagon) return;
134 
135 	if (wagon == nullptr) {
136 		if (head != nullptr) wagon = head->Last();
137 	} else {
138 		wagon = wagon->Previous();
139 		if (wagon == nullptr) return;
140 	}
141 
142 	if (wagon == v) return;
143 
144 	DoCommandP(v->tile, v->index | (_ctrl_pressed ? 1 : 0) << 20, wagon == nullptr ? INVALID_VEHICLE : wagon->index, CMD_MOVE_RAIL_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_MOVE_VEHICLE));
145 }
146 
147 static VehicleCellSize _base_block_sizes_depot[VEH_COMPANY_END];    ///< Cell size for vehicle images in the depot view.
148 static VehicleCellSize _base_block_sizes_purchase[VEH_COMPANY_END]; ///< Cell size for vehicle images in the purchase list.
149 static uint _consistent_train_width;                                ///< Whether trains of all lengths are consistently scaled. Either TRAININFO_DEFAULT_VEHICLE_WIDTH, VEHICLEINFO_FULL_VEHICLE_WIDTH, or 0.
150 
151 /**
152  * Get the GUI cell size for a vehicle image.
153  * @param type Vehicle type to get the size for.
154  * @param image_type Image type to get size for.
155  * @pre image_type == EIT_IN_DEPOT || image_type == EIT_PURCHASE
156  * @return Cell dimensions for the vehicle and image type.
157  */
GetVehicleImageCellSize(VehicleType type,EngineImageType image_type)158 VehicleCellSize GetVehicleImageCellSize(VehicleType type, EngineImageType image_type)
159 {
160 	switch (image_type) {
161 		case EIT_IN_DEPOT: return _base_block_sizes_depot[type];
162 		case EIT_PURCHASE: return _base_block_sizes_purchase[type];
163 		default: NOT_REACHED();
164 	}
165 }
166 
InitBlocksizeForVehicles(VehicleType type,EngineImageType image_type)167 static void InitBlocksizeForVehicles(VehicleType type, EngineImageType image_type)
168 {
169 	int max_extend_left  = 0;
170 	int max_extend_right = 0;
171 	uint max_height = 0;
172 
173 	for (const Engine *e : Engine::IterateType(type)) {
174 		if (!e->IsEnabled()) continue;
175 
176 		EngineID eid = e->index;
177 		uint x, y;
178 		int x_offs, y_offs;
179 
180 		switch (type) {
181 			default: NOT_REACHED();
182 			case VEH_TRAIN:    GetTrainSpriteSize(   eid, x, y, x_offs, y_offs, image_type); break;
183 			case VEH_ROAD:     GetRoadVehSpriteSize( eid, x, y, x_offs, y_offs, image_type); break;
184 			case VEH_SHIP:     GetShipSpriteSize(    eid, x, y, x_offs, y_offs, image_type); break;
185 			case VEH_AIRCRAFT: GetAircraftSpriteSize(eid, x, y, x_offs, y_offs, image_type); break;
186 		}
187 		if (y > max_height) max_height = y;
188 		if (-x_offs > max_extend_left) max_extend_left = -x_offs;
189 		if ((int)x + x_offs > max_extend_right) max_extend_right = x + x_offs;
190 	}
191 
192 	int min_extend = ScaleGUITrad(16);
193 	int max_extend = ScaleGUITrad(98);
194 
195 	switch (image_type) {
196 		case EIT_IN_DEPOT:
197 			_base_block_sizes_depot[type].height       = std::max<uint>(ScaleGUITrad(GetVehicleHeight(type)), max_height);
198 			_base_block_sizes_depot[type].extend_left  = Clamp(max_extend_left, min_extend, max_extend);
199 			_base_block_sizes_depot[type].extend_right = Clamp(max_extend_right, min_extend, max_extend);
200 			break;
201 		case EIT_PURCHASE:
202 			_base_block_sizes_purchase[type].height       = std::max<uint>(ScaleGUITrad(GetVehicleHeight(type)), max_height);
203 			_base_block_sizes_purchase[type].extend_left  = Clamp(max_extend_left, min_extend, max_extend);
204 			_base_block_sizes_purchase[type].extend_right = Clamp(max_extend_right, min_extend, max_extend);
205 			break;
206 
207 		default: NOT_REACHED();
208 	}
209 }
210 
211 /**
212  * Set the size of the blocks in the window so we can be sure that they are big enough for the vehicle sprites in the current game.
213  * @note Calling this function once for each game is enough.
214  */
InitDepotWindowBlockSizes()215 void InitDepotWindowBlockSizes()
216 {
217 	for (VehicleType vt = VEH_BEGIN; vt < VEH_COMPANY_END; vt++) {
218 		InitBlocksizeForVehicles(vt, EIT_IN_DEPOT);
219 		InitBlocksizeForVehicles(vt, EIT_PURCHASE);
220 	}
221 
222 	_consistent_train_width = TRAININFO_DEFAULT_VEHICLE_WIDTH;
223 	bool first = true;
224 	for (const Engine *e : Engine::IterateType(VEH_TRAIN)) {
225 		if (!e->IsEnabled()) continue;
226 
227 		uint w = TRAININFO_DEFAULT_VEHICLE_WIDTH;
228 		if (e->GetGRF() != nullptr && is_custom_sprite(e->u.rail.image_index)) {
229 			w = e->GetGRF()->traininfo_vehicle_width;
230 			if (w != VEHICLEINFO_FULL_VEHICLE_WIDTH) {
231 				/* Hopeless.
232 				 * This is a NewGRF vehicle that uses TRAININFO_DEFAULT_VEHICLE_WIDTH.
233 				 * If the vehicles are shorter than 8/8 we have fractional lengths, which are not consistent after rounding.
234 				 */
235 				_consistent_train_width = 0;
236 				break;
237 			}
238 		}
239 
240 		if (first) {
241 			_consistent_train_width = w;
242 			first = false;
243 		} else if (w != _consistent_train_width) {
244 			_consistent_train_width = 0;
245 			break;
246 		}
247 	}
248 }
249 
250 static void DepotSellAllConfirmationCallback(Window *w, bool confirmed);
251 const Sprite *GetAircraftSprite(EngineID engine);
252 
253 struct DepotWindow : Window {
254 	VehicleID sel;
255 	VehicleID vehicle_over; ///< Rail vehicle over which another one is dragged, \c INVALID_VEHICLE if none.
256 	VehicleType type;
257 	bool generate_list;
258 	int hovered_widget; ///< Index of the widget being hovered during drag/drop. -1 if no drag is in progress.
259 	VehicleList vehicle_list;
260 	VehicleList wagon_list;
261 	uint unitnumber_digits;
262 	uint num_columns;       ///< Number of columns.
263 	Scrollbar *hscroll;     ///< Only for trains.
264 	Scrollbar *vscroll;
265 
DepotWindowDepotWindow266 	DepotWindow(WindowDesc *desc, TileIndex tile, VehicleType type) : Window(desc)
267 	{
268 		assert(IsCompanyBuildableVehicleType(type)); // ensure that we make the call with a valid type
269 
270 		this->sel = INVALID_VEHICLE;
271 		this->vehicle_over = INVALID_VEHICLE;
272 		this->generate_list = true;
273 		this->hovered_widget = -1;
274 		this->type = type;
275 		this->num_columns = 1; // for non-trains this gets set in FinishInitNested()
276 		this->unitnumber_digits = 2;
277 
278 		this->CreateNestedTree();
279 		this->hscroll = (this->type == VEH_TRAIN ? this->GetScrollbar(WID_D_H_SCROLL) : nullptr);
280 		this->vscroll = this->GetScrollbar(WID_D_V_SCROLL);
281 		/* Don't show 'rename button' of aircraft hangar */
282 		this->GetWidget<NWidgetStacked>(WID_D_SHOW_RENAME)->SetDisplayedPlane(type == VEH_AIRCRAFT ? SZSP_NONE : 0);
283 		/* Only train depots have a horizontal scrollbar and a 'sell chain' button */
284 		if (type == VEH_TRAIN) this->GetWidget<NWidgetCore>(WID_D_MATRIX)->widget_data = 1 << MAT_COL_START;
285 		this->GetWidget<NWidgetStacked>(WID_D_SHOW_H_SCROLL)->SetDisplayedPlane(type == VEH_TRAIN ? 0 : SZSP_HORIZONTAL);
286 		this->GetWidget<NWidgetStacked>(WID_D_SHOW_SELL_CHAIN)->SetDisplayedPlane(type == VEH_TRAIN ? 0 : SZSP_NONE);
287 		this->SetupWidgetData(type);
288 		this->FinishInitNested(tile);
289 
290 		this->owner = GetTileOwner(tile);
291 		OrderBackup::Reset();
292 	}
293 
CloseDepotWindow294 	void Close() override
295 	{
296 		CloseWindowById(WC_BUILD_VEHICLE, this->window_number);
297 		CloseWindowById(GetWindowClassForVehicleType(this->type), VehicleListIdentifier(VL_DEPOT_LIST, this->type, this->owner, this->GetDepotIndex()).Pack(), false);
298 		OrderBackup::Reset(this->window_number);
299 		this->Window::Close();
300 	}
301 
302 	/**
303 	 * Draw a vehicle in the depot window in the box with the top left corner at x,y.
304 	 * @param v     Vehicle to draw.
305 	 * @param left  Left side of the box to draw in.
306 	 * @param right Right side of the box to draw in.
307 	 * @param y     Top of the box to draw in.
308 	 */
DrawVehicleInDepotDepotWindow309 	void DrawVehicleInDepot(const Vehicle *v, int left, int right, int y) const
310 	{
311 		bool free_wagon = false;
312 		int sprite_y = y + (this->resize.step_height - ScaleGUITrad(GetVehicleHeight(v->type))) / 2;
313 
314 		bool rtl = _current_text_dir == TD_RTL;
315 		int image_left  = rtl ? left  + this->count_width  : left  + this->header_width;
316 		int image_right = rtl ? right - this->header_width : right - this->count_width;
317 
318 		switch (v->type) {
319 			case VEH_TRAIN: {
320 				const Train *u = Train::From(v);
321 				free_wagon = u->IsFreeWagon();
322 
323 				uint x_space = free_wagon ?
324 						ScaleGUITrad(_consistent_train_width != 0 ? _consistent_train_width : TRAININFO_DEFAULT_VEHICLE_WIDTH) :
325 						0;
326 
327 				DrawTrainImage(u, image_left + (rtl ? 0 : x_space), image_right - (rtl ? x_space : 0), sprite_y - 1,
328 						this->sel, EIT_IN_DEPOT, free_wagon ? 0 : this->hscroll->GetPosition(), this->vehicle_over);
329 
330 				/* Length of consist in tiles with 1 fractional digit (rounded up) */
331 				SetDParam(0, CeilDiv(u->gcache.cached_total_length * 10, TILE_SIZE));
332 				SetDParam(1, 1);
333 				DrawString(rtl ? left + WD_FRAMERECT_LEFT : right - this->count_width, rtl ? left + this->count_width : right - WD_FRAMERECT_RIGHT, y + (this->resize.step_height - FONT_HEIGHT_SMALL) / 2, STR_TINY_BLACK_DECIMAL, TC_FROMSTRING, SA_RIGHT); // Draw the counter
334 				break;
335 			}
336 
337 			case VEH_ROAD:     DrawRoadVehImage( v, image_left, image_right, sprite_y, this->sel, EIT_IN_DEPOT); break;
338 			case VEH_SHIP:     DrawShipImage(    v, image_left, image_right, sprite_y, this->sel, EIT_IN_DEPOT); break;
339 			case VEH_AIRCRAFT: DrawAircraftImage(v, image_left, image_right, sprite_y, this->sel, EIT_IN_DEPOT); break;
340 			default: NOT_REACHED();
341 		}
342 
343 		uint diff_x, diff_y;
344 		if (v->IsGroundVehicle()) {
345 			/* Arrange unitnumber and flag horizontally */
346 			diff_x = this->flag_width + WD_FRAMERECT_LEFT;
347 			diff_y = (this->resize.step_height - this->flag_height) / 2 - 2;
348 		} else {
349 			/* Arrange unitnumber and flag vertically */
350 			diff_x = WD_FRAMERECT_LEFT;
351 			diff_y = FONT_HEIGHT_NORMAL + WD_PAR_VSEP_NORMAL;
352 		}
353 		int text_left  = rtl ? right - this->header_width - 1 : left + diff_x;
354 		int text_right = rtl ? right - diff_x : left + this->header_width - 1;
355 
356 		if (free_wagon) {
357 			DrawString(text_left, text_right, y + 2, STR_DEPOT_NO_ENGINE);
358 		} else {
359 			DrawSprite((v->vehstatus & VS_STOPPED) ? SPR_FLAG_VEH_STOPPED : SPR_FLAG_VEH_RUNNING, PAL_NONE, rtl ? right - this->flag_width : left + WD_FRAMERECT_LEFT, y + diff_y);
360 
361 			SetDParam(0, v->unitnumber);
362 			DrawString(text_left, text_right, y + 2, (uint16)(v->max_age - DAYS_IN_LEAP_YEAR) >= v->age ? STR_BLACK_COMMA : STR_RED_COMMA);
363 		}
364 	}
365 
DrawWidgetDepotWindow366 	void DrawWidget(const Rect &r, int widget) const override
367 	{
368 		if (widget != WID_D_MATRIX) return;
369 
370 		bool rtl = _current_text_dir == TD_RTL;
371 
372 		/* Set the row and number of boxes in each row based on the number of boxes drawn in the matrix */
373 		const NWidgetCore *wid = this->GetWidget<NWidgetCore>(WID_D_MATRIX);
374 
375 		/* Draw vertical separators at whole tiles.
376 		 * This only works in two cases:
377 		 *  - All vehicles use VEHICLEINFO_FULL_VEHICLE_WIDTH as reference width.
378 		 *  - All vehicles are 8/8. This cannot be checked for NewGRF, so instead we check for "all vehicles are original vehicles".
379 		 */
380 		if (this->type == VEH_TRAIN && _consistent_train_width != 0) {
381 			int w = ScaleGUITrad(2 * _consistent_train_width);
382 			int col = _colour_gradient[wid->colour][4];
383 			int image_left  = rtl ? r.left  + this->count_width  : r.left  + this->header_width;
384 			int image_right = rtl ? r.right - this->header_width : r.right - this->count_width;
385 			int first_line = w + (-this->hscroll->GetPosition()) % w;
386 			if (rtl) {
387 				for (int x = image_right - first_line; x >= image_left; x -= w) {
388 					GfxDrawLine(x, r.top, x, r.bottom, col, 1, 3);
389 				}
390 			} else {
391 				for (int x = image_left + first_line; x <= image_right; x += w) {
392 					GfxDrawLine(x, r.top, x, r.bottom, col, 1, 3);
393 				}
394 			}
395 		}
396 
397 		uint16 rows_in_display = wid->current_y / wid->resize_y;
398 
399 		uint num = this->vscroll->GetPosition() * this->num_columns;
400 		uint maxval = static_cast<uint>(std::min<size_t>(this->vehicle_list.size(), num + (rows_in_display * this->num_columns)));
401 		int y;
402 		for (y = r.top + 1; num < maxval; y += this->resize.step_height) { // Draw the rows
403 			for (uint i = 0; i < this->num_columns && num < maxval; i++, num++) {
404 				/* Draw all vehicles in the current row */
405 				const Vehicle *v = this->vehicle_list[num];
406 				if (this->num_columns == 1) {
407 					this->DrawVehicleInDepot(v, r.left, r.right, y);
408 				} else {
409 					int x = r.left + (rtl ? (this->num_columns - i - 1) : i) * this->resize.step_width;
410 					this->DrawVehicleInDepot(v, x, x + this->resize.step_width - 1, y);
411 				}
412 			}
413 		}
414 
415 		maxval = static_cast<uint>(std::min<size_t>(this->vehicle_list.size() + this->wagon_list.size(), (this->vscroll->GetPosition() * this->num_columns) + (rows_in_display * this->num_columns)));
416 
417 		/* Draw the train wagons without an engine in front. */
418 		for (; num < maxval; num++, y += this->resize.step_height) {
419 			const Vehicle *v = this->wagon_list[num - this->vehicle_list.size()];
420 			this->DrawVehicleInDepot(v, r.left, r.right, y);
421 		}
422 	}
423 
SetStringParametersDepotWindow424 	void SetStringParameters(int widget) const override
425 	{
426 		if (widget != WID_D_CAPTION) return;
427 
428 		SetDParam(0, this->type);
429 		SetDParam(1, this->GetDepotIndex());
430 	}
431 
432 	struct GetDepotVehiclePtData {
433 		const Vehicle *head;
434 		const Vehicle *wagon;
435 	};
436 
437 	enum DepotGUIAction {
438 		MODE_ERROR,
439 		MODE_DRAG_VEHICLE,
440 		MODE_SHOW_VEHICLE,
441 		MODE_START_STOP,
442 	};
443 
GetVehicleFromDepotWndPtDepotWindow444 	DepotGUIAction GetVehicleFromDepotWndPt(int x, int y, const Vehicle **veh, GetDepotVehiclePtData *d) const
445 	{
446 		const NWidgetCore *matrix_widget = this->GetWidget<NWidgetCore>(WID_D_MATRIX);
447 		/* In case of RTL the widgets are swapped as a whole */
448 		if (_current_text_dir == TD_RTL) x = matrix_widget->current_x - x;
449 
450 		uint xt = 0, xm = 0, ym = 0;
451 		if (this->type == VEH_TRAIN) {
452 			xm = x;
453 		} else {
454 			xt = x / this->resize.step_width;
455 			xm = x % this->resize.step_width;
456 			if (xt >= this->num_columns) return MODE_ERROR;
457 		}
458 		ym = y % this->resize.step_height;
459 
460 		uint row = y / this->resize.step_height;
461 		if (row >= this->vscroll->GetCapacity()) return MODE_ERROR;
462 
463 		uint pos = ((row + this->vscroll->GetPosition()) * this->num_columns) + xt;
464 
465 		if (this->vehicle_list.size() + this->wagon_list.size() <= pos) {
466 			/* Clicking on 'line' / 'block' without a vehicle */
467 			if (this->type == VEH_TRAIN) {
468 				/* End the dragging */
469 				d->head  = nullptr;
470 				d->wagon = nullptr;
471 				return MODE_DRAG_VEHICLE;
472 			} else {
473 				return MODE_ERROR; // empty block, so no vehicle is selected
474 			}
475 		}
476 
477 		bool wagon = false;
478 		if (this->vehicle_list.size() > pos) {
479 			*veh = this->vehicle_list[pos];
480 			/* Skip vehicles that are scrolled off the list */
481 			if (this->type == VEH_TRAIN) x += this->hscroll->GetPosition();
482 		} else {
483 			pos -= (uint)this->vehicle_list.size();
484 			*veh = this->wagon_list[pos];
485 			/* free wagons don't have an initial loco. */
486 			x -= ScaleGUITrad(VEHICLEINFO_FULL_VEHICLE_WIDTH);
487 			wagon = true;
488 		}
489 
490 		const Train *v = nullptr;
491 		if (this->type == VEH_TRAIN) {
492 			v = Train::From(*veh);
493 			d->head = d->wagon = v;
494 		}
495 
496 		if (xm <= this->header_width) {
497 			switch (this->type) {
498 				case VEH_TRAIN:
499 					if (wagon) return MODE_ERROR;
500 					FALLTHROUGH;
501 
502 				case VEH_ROAD:
503 					if (xm <= this->flag_width) return MODE_START_STOP;
504 					break;
505 
506 				case VEH_SHIP:
507 				case VEH_AIRCRAFT:
508 					if (xm <= this->flag_width && ym >= (uint)(FONT_HEIGHT_NORMAL + WD_PAR_VSEP_NORMAL)) return MODE_START_STOP;
509 					break;
510 
511 				default: NOT_REACHED();
512 			}
513 			return MODE_SHOW_VEHICLE;
514 		}
515 
516 		if (this->type != VEH_TRAIN) return MODE_DRAG_VEHICLE;
517 
518 		/* Clicking on the counter */
519 		if (xm >= matrix_widget->current_x - this->count_width) return wagon ? MODE_ERROR : MODE_SHOW_VEHICLE;
520 
521 		/* Account for the header */
522 		x -= this->header_width;
523 
524 		/* find the vehicle in this row that was clicked */
525 		for (; v != nullptr; v = v->Next()) {
526 			x -= v->GetDisplayImageWidth();
527 			if (x < 0) break;
528 		}
529 
530 		d->wagon = (v != nullptr ? v->GetFirstEnginePart() : nullptr);
531 
532 		return MODE_DRAG_VEHICLE;
533 	}
534 
535 	/**
536 	 * Handle click in the depot matrix.
537 	 * @param x Horizontal position in the matrix widget in pixels.
538 	 * @param y Vertical position in the matrix widget in pixels.
539 	 */
DepotClickDepotWindow540 	void DepotClick(int x, int y)
541 	{
542 		GetDepotVehiclePtData gdvp = { nullptr, nullptr };
543 		const Vehicle *v = nullptr;
544 		DepotGUIAction mode = this->GetVehicleFromDepotWndPt(x, y, &v, &gdvp);
545 
546 		if (this->type == VEH_TRAIN) v = gdvp.wagon;
547 
548 		switch (mode) {
549 			case MODE_ERROR: // invalid
550 				return;
551 
552 			case MODE_DRAG_VEHICLE: { // start dragging of vehicle
553 				if (v != nullptr && VehicleClicked(v)) return;
554 
555 				VehicleID sel = this->sel;
556 
557 				if (this->type == VEH_TRAIN && sel != INVALID_VEHICLE) {
558 					this->sel = INVALID_VEHICLE;
559 					TrainDepotMoveVehicle(v, sel, gdvp.head);
560 				} else if (v != nullptr) {
561 					SetObjectToPlaceWnd(SPR_CURSOR_MOUSE, PAL_NONE, HT_DRAG, this);
562 					SetMouseCursorVehicle(v, EIT_IN_DEPOT);
563 					_cursor.vehchain = _ctrl_pressed;
564 
565 					this->sel = v->index;
566 					this->SetDirty();
567 				}
568 				break;
569 			}
570 
571 			case MODE_SHOW_VEHICLE: // show info window
572 				ShowVehicleViewWindow(v);
573 				break;
574 
575 			case MODE_START_STOP: // click start/stop flag
576 				StartStopVehicle(v, false);
577 				break;
578 
579 			default: NOT_REACHED();
580 		}
581 	}
582 
583 	/**
584 	 * Function to set up vehicle specific widgets (mainly sprites and strings).
585 	 * Only use this function to if the widget is used for several vehicle types and each has
586 	 * different text/sprites. If the widget is only used for a single vehicle type, or the same
587 	 * text/sprites are used every time, use the nested widget array to initialize the widget.
588 	 */
SetupWidgetDataDepotWindow589 	void SetupWidgetData(VehicleType type)
590 	{
591 		this->GetWidget<NWidgetCore>(WID_D_STOP_ALL)->tool_tip     = STR_DEPOT_MASS_STOP_DEPOT_TRAIN_TOOLTIP + type;
592 		this->GetWidget<NWidgetCore>(WID_D_START_ALL)->tool_tip    = STR_DEPOT_MASS_START_DEPOT_TRAIN_TOOLTIP + type;
593 		this->GetWidget<NWidgetCore>(WID_D_SELL)->tool_tip         = STR_DEPOT_TRAIN_SELL_TOOLTIP + type;
594 		this->GetWidget<NWidgetCore>(WID_D_SELL_ALL)->tool_tip     = STR_DEPOT_SELL_ALL_BUTTON_TRAIN_TOOLTIP + type;
595 
596 		this->GetWidget<NWidgetCore>(WID_D_BUILD)->SetDataTip(STR_DEPOT_TRAIN_NEW_VEHICLES_BUTTON + type, STR_DEPOT_TRAIN_NEW_VEHICLES_TOOLTIP + type);
597 		this->GetWidget<NWidgetCore>(WID_D_CLONE)->SetDataTip(STR_DEPOT_CLONE_TRAIN + type, STR_DEPOT_CLONE_TRAIN_DEPOT_INFO + type);
598 
599 		this->GetWidget<NWidgetCore>(WID_D_LOCATION)->tool_tip     = STR_DEPOT_TRAIN_LOCATION_TOOLTIP + type;
600 		this->GetWidget<NWidgetCore>(WID_D_VEHICLE_LIST)->tool_tip = STR_DEPOT_VEHICLE_ORDER_LIST_TRAIN_TOOLTIP + type;
601 		this->GetWidget<NWidgetCore>(WID_D_AUTOREPLACE)->tool_tip  = STR_DEPOT_AUTOREPLACE_TRAIN_TOOLTIP + type;
602 		this->GetWidget<NWidgetCore>(WID_D_MATRIX)->tool_tip       = STR_DEPOT_TRAIN_LIST_TOOLTIP + this->type;
603 
604 		switch (type) {
605 			default: NOT_REACHED();
606 
607 			case VEH_TRAIN:
608 				this->GetWidget<NWidgetCore>(WID_D_VEHICLE_LIST)->widget_data = STR_TRAIN;
609 
610 				/* Sprites */
611 				this->GetWidget<NWidgetCore>(WID_D_SELL)->widget_data        = SPR_SELL_TRAIN;
612 				this->GetWidget<NWidgetCore>(WID_D_SELL_ALL)->widget_data    = SPR_SELL_ALL_TRAIN;
613 				this->GetWidget<NWidgetCore>(WID_D_AUTOREPLACE)->widget_data = SPR_REPLACE_TRAIN;
614 				break;
615 
616 			case VEH_ROAD:
617 				this->GetWidget<NWidgetCore>(WID_D_VEHICLE_LIST)->widget_data = STR_LORRY;
618 
619 				/* Sprites */
620 				this->GetWidget<NWidgetCore>(WID_D_SELL)->widget_data        = SPR_SELL_ROADVEH;
621 				this->GetWidget<NWidgetCore>(WID_D_SELL_ALL)->widget_data    = SPR_SELL_ALL_ROADVEH;
622 				this->GetWidget<NWidgetCore>(WID_D_AUTOREPLACE)->widget_data = SPR_REPLACE_ROADVEH;
623 				break;
624 
625 			case VEH_SHIP:
626 				this->GetWidget<NWidgetCore>(WID_D_VEHICLE_LIST)->widget_data = STR_SHIP;
627 
628 				/* Sprites */
629 				this->GetWidget<NWidgetCore>(WID_D_SELL)->widget_data        = SPR_SELL_SHIP;
630 				this->GetWidget<NWidgetCore>(WID_D_SELL_ALL)->widget_data    = SPR_SELL_ALL_SHIP;
631 				this->GetWidget<NWidgetCore>(WID_D_AUTOREPLACE)->widget_data = SPR_REPLACE_SHIP;
632 				break;
633 
634 			case VEH_AIRCRAFT:
635 				this->GetWidget<NWidgetCore>(WID_D_VEHICLE_LIST)->widget_data = STR_PLANE;
636 
637 				/* Sprites */
638 				this->GetWidget<NWidgetCore>(WID_D_SELL)->widget_data        = SPR_SELL_AIRCRAFT;
639 				this->GetWidget<NWidgetCore>(WID_D_SELL_ALL)->widget_data    = SPR_SELL_ALL_AIRCRAFT;
640 				this->GetWidget<NWidgetCore>(WID_D_AUTOREPLACE)->widget_data = SPR_REPLACE_AIRCRAFT;
641 				break;
642 		}
643 	}
644 
645 	uint count_width;
646 	uint header_width;
647 	uint flag_width;
648 	uint flag_height;
649 
UpdateWidgetSizeDepotWindow650 	void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
651 	{
652 		switch (widget) {
653 			case WID_D_MATRIX: {
654 				uint min_height = 0;
655 
656 				if (this->type == VEH_TRAIN) {
657 					SetDParamMaxValue(0, 1000, 0, FS_SMALL);
658 					SetDParam(1, 1);
659 					this->count_width = GetStringBoundingBox(STR_TINY_BLACK_DECIMAL).width + WD_FRAMERECT_LEFT + WD_FRAMERECT_RIGHT;
660 				} else {
661 					this->count_width = 0;
662 				}
663 
664 				SetDParamMaxDigits(0, this->unitnumber_digits);
665 				Dimension unumber = GetStringBoundingBox(STR_BLACK_COMMA);
666 				const Sprite *spr = GetSprite(SPR_FLAG_VEH_STOPPED, ST_NORMAL);
667 				this->flag_width  = UnScaleGUI(spr->width) + WD_FRAMERECT_RIGHT;
668 				this->flag_height = UnScaleGUI(spr->height);
669 
670 				if (this->type == VEH_TRAIN || this->type == VEH_ROAD) {
671 					min_height = std::max<uint>(unumber.height + WD_MATRIX_TOP, UnScaleGUI(spr->height));
672 					this->header_width = unumber.width + this->flag_width + WD_FRAMERECT_LEFT;
673 				} else {
674 					min_height = unumber.height + UnScaleGUI(spr->height) + WD_MATRIX_TOP + WD_PAR_VSEP_NORMAL + WD_MATRIX_BOTTOM;
675 					this->header_width = std::max<uint>(unumber.width, this->flag_width) + WD_FRAMERECT_RIGHT;
676 				}
677 				int base_width = this->count_width + this->header_width;
678 
679 				resize->height = std::max<uint>(GetVehicleImageCellSize(this->type, EIT_IN_DEPOT).height, min_height);
680 				if (this->type == VEH_TRAIN) {
681 					resize->width = 1;
682 					size->width = base_width + 2 * ScaleGUITrad(29); // about 2 parts
683 					size->height = resize->height * 6;
684 				} else {
685 					resize->width = base_width + GetVehicleImageCellSize(this->type, EIT_IN_DEPOT).extend_left + GetVehicleImageCellSize(this->type, EIT_IN_DEPOT).extend_right;
686 					size->width = resize->width * (this->type == VEH_ROAD ? 5 : 3);
687 					size->height = resize->height * (this->type == VEH_ROAD ? 5 : 3);
688 				}
689 				fill->width = resize->width;
690 				fill->height = resize->height;
691 				break;
692 			}
693 		}
694 	}
695 
696 	/**
697 	 * Some data on this window has become invalid.
698 	 * @param data Information about the changed data.
699 	 * @param gui_scope Whether the call is done from GUI scope. You may not do everything when not in GUI scope. See #InvalidateWindowData() for details.
700 	 */
OnInvalidateDataDepotWindow701 	void OnInvalidateData(int data = 0, bool gui_scope = true) override
702 	{
703 		this->generate_list = true;
704 	}
705 
OnPaintDepotWindow706 	void OnPaint() override
707 	{
708 		if (this->generate_list) {
709 			/* Generate the vehicle list
710 			 * It's ok to use the wagon pointers for non-trains as they will be ignored */
711 			BuildDepotVehicleList(this->type, this->window_number, &this->vehicle_list, &this->wagon_list);
712 			this->generate_list = false;
713 			DepotSortList(&this->vehicle_list);
714 
715 			uint new_unitnumber_digits = GetUnitNumberDigits(this->vehicle_list);
716 			/* Only increase the size; do not decrease to prevent constant changes */
717 			if (this->unitnumber_digits < new_unitnumber_digits) {
718 				this->unitnumber_digits = new_unitnumber_digits;
719 				this->ReInit();
720 			}
721 		}
722 
723 		/* determine amount of items for scroller */
724 		if (this->type == VEH_TRAIN) {
725 			uint max_width = ScaleGUITrad(VEHICLEINFO_FULL_VEHICLE_WIDTH);
726 			for (uint num = 0; num < this->vehicle_list.size(); num++) {
727 				uint width = 0;
728 				for (const Train *v = Train::From(this->vehicle_list[num]); v != nullptr; v = v->Next()) {
729 					width += v->GetDisplayImageWidth();
730 				}
731 				max_width = std::max(max_width, width);
732 			}
733 			/* Always have 1 empty row, so people can change the setting of the train */
734 			this->vscroll->SetCount((uint)this->vehicle_list.size() + (uint)this->wagon_list.size() + 1);
735 			/* Always make it longer than the longest train, so you can attach vehicles at the end, and also see the next vertical tile separator line */
736 			this->hscroll->SetCount(max_width + ScaleGUITrad(2 * VEHICLEINFO_FULL_VEHICLE_WIDTH + 1));
737 		} else {
738 			this->vscroll->SetCount(CeilDiv((uint)this->vehicle_list.size(), this->num_columns));
739 		}
740 
741 		/* Setup disabled buttons. */
742 		TileIndex tile = this->window_number;
743 		this->SetWidgetsDisabledState(!IsTileOwner(tile, _local_company),
744 			WID_D_STOP_ALL,
745 			WID_D_START_ALL,
746 			WID_D_SELL,
747 			WID_D_SELL_CHAIN,
748 			WID_D_SELL_ALL,
749 			WID_D_BUILD,
750 			WID_D_CLONE,
751 			WID_D_RENAME,
752 			WID_D_AUTOREPLACE,
753 			WIDGET_LIST_END);
754 
755 		this->DrawWidgets();
756 	}
757 
OnClickDepotWindow758 	void OnClick(Point pt, int widget, int click_count) override
759 	{
760 		switch (widget) {
761 			case WID_D_MATRIX: { // List
762 				NWidgetBase *nwi = this->GetWidget<NWidgetBase>(WID_D_MATRIX);
763 				this->DepotClick(pt.x - nwi->pos_x, pt.y - nwi->pos_y);
764 				break;
765 			}
766 
767 			case WID_D_BUILD: // Build vehicle
768 				ResetObjectToPlace();
769 				ShowBuildVehicleWindow(this->window_number, this->type);
770 				break;
771 
772 			case WID_D_CLONE: // Clone button
773 				this->SetWidgetDirty(WID_D_CLONE);
774 				this->ToggleWidgetLoweredState(WID_D_CLONE);
775 
776 				if (this->IsWidgetLowered(WID_D_CLONE)) {
777 					static const CursorID clone_icons[] = {
778 						SPR_CURSOR_CLONE_TRAIN, SPR_CURSOR_CLONE_ROADVEH,
779 						SPR_CURSOR_CLONE_SHIP, SPR_CURSOR_CLONE_AIRPLANE
780 					};
781 
782 					SetObjectToPlaceWnd(clone_icons[this->type], PAL_NONE, HT_VEHICLE, this);
783 				} else {
784 					ResetObjectToPlace();
785 				}
786 				break;
787 
788 			case WID_D_LOCATION:
789 				if (_ctrl_pressed) {
790 					ShowExtraViewportWindow(this->window_number);
791 				} else {
792 					ScrollMainWindowToTile(this->window_number);
793 				}
794 				break;
795 
796 			case WID_D_RENAME: // Rename button
797 				SetDParam(0, this->type);
798 				SetDParam(1, Depot::GetByTile((TileIndex)this->window_number)->index);
799 				ShowQueryString(STR_DEPOT_NAME, STR_DEPOT_RENAME_DEPOT_CAPTION, MAX_LENGTH_DEPOT_NAME_CHARS, this, CS_ALPHANUMERAL, QSF_ENABLE_DEFAULT | QSF_LEN_IN_CHARS);
800 				break;
801 
802 			case WID_D_STOP_ALL:
803 			case WID_D_START_ALL: {
804 				VehicleListIdentifier vli(VL_DEPOT_LIST, this->type, this->owner);
805 				DoCommandP(this->window_number, (widget == WID_D_START_ALL ? (1 << 0) : 0), vli.Pack(), CMD_MASS_START_STOP);
806 				break;
807 			}
808 
809 			case WID_D_SELL_ALL:
810 				/* Only open the confirmation window if there are anything to sell */
811 				if (this->vehicle_list.size() != 0 || this->wagon_list.size() != 0) {
812 					SetDParam(0, this->type);
813 					SetDParam(1, this->GetDepotIndex());
814 					ShowQuery(
815 						STR_DEPOT_CAPTION,
816 						STR_DEPOT_SELL_CONFIRMATION_TEXT,
817 						this,
818 						DepotSellAllConfirmationCallback
819 					);
820 				}
821 				break;
822 
823 			case WID_D_VEHICLE_LIST:
824 				ShowVehicleListWindow(GetTileOwner(this->window_number), this->type, (TileIndex)this->window_number);
825 				break;
826 
827 			case WID_D_AUTOREPLACE:
828 				DoCommandP(this->window_number, this->type, 0, CMD_DEPOT_MASS_AUTOREPLACE);
829 				break;
830 
831 		}
832 	}
833 
OnQueryTextFinishedDepotWindow834 	void OnQueryTextFinished(char *str) override
835 	{
836 		if (str == nullptr) return;
837 
838 		/* Do depot renaming */
839 		DoCommandP(0, this->GetDepotIndex(), 0, CMD_RENAME_DEPOT | CMD_MSG(STR_ERROR_CAN_T_RENAME_DEPOT), nullptr, str);
840 	}
841 
OnRightClickDepotWindow842 	bool OnRightClick(Point pt, int widget) override
843 	{
844 		if (widget != WID_D_MATRIX) return false;
845 
846 		GetDepotVehiclePtData gdvp = { nullptr, nullptr };
847 		const Vehicle *v = nullptr;
848 		NWidgetBase *nwi = this->GetWidget<NWidgetBase>(WID_D_MATRIX);
849 		DepotGUIAction mode = this->GetVehicleFromDepotWndPt(pt.x - nwi->pos_x, pt.y - nwi->pos_y, &v, &gdvp);
850 
851 		if (this->type == VEH_TRAIN) v = gdvp.wagon;
852 
853 		if (v == nullptr || mode != MODE_DRAG_VEHICLE) return false;
854 
855 		CargoArray capacity, loaded;
856 
857 		/* Display info for single (articulated) vehicle, or for whole chain starting with selected vehicle */
858 		bool whole_chain = (this->type == VEH_TRAIN && _ctrl_pressed);
859 
860 		/* loop through vehicle chain and collect cargoes */
861 		uint num = 0;
862 		for (const Vehicle *w = v; w != nullptr; w = w->Next()) {
863 			if (w->cargo_cap > 0 && w->cargo_type < NUM_CARGO) {
864 				capacity[w->cargo_type] += w->cargo_cap;
865 				loaded  [w->cargo_type] += w->cargo.StoredCount();
866 			}
867 
868 			if (w->type == VEH_TRAIN && !w->HasArticulatedPart()) {
869 				num++;
870 				if (!whole_chain) break;
871 			}
872 		}
873 
874 		/* Build tooltipstring */
875 		static char details[1024];
876 		details[0] = '\0';
877 		char *pos = details;
878 
879 		for (CargoID cargo_type = 0; cargo_type < NUM_CARGO; cargo_type++) {
880 			if (capacity[cargo_type] == 0) continue;
881 
882 			SetDParam(0, cargo_type);           // {CARGO} #1
883 			SetDParam(1, loaded[cargo_type]);   // {CARGO} #2
884 			SetDParam(2, cargo_type);           // {SHORTCARGO} #1
885 			SetDParam(3, capacity[cargo_type]); // {SHORTCARGO} #2
886 			pos = GetString(pos, STR_DEPOT_VEHICLE_TOOLTIP_CARGO, lastof(details));
887 		}
888 
889 		/* Show tooltip window */
890 		uint64 args[2];
891 		args[0] = (whole_chain ? num : v->engine_type);
892 		args[1] = (uint64)(size_t)details;
893 		GuiShowTooltips(this, whole_chain ? STR_DEPOT_VEHICLE_TOOLTIP_CHAIN : STR_DEPOT_VEHICLE_TOOLTIP, 2, args, TCC_RIGHT_CLICK);
894 
895 		return true;
896 	}
897 
898 	/**
899 	 * Clones a vehicle
900 	 * @param v the original vehicle to clone
901 	 * @return Always true.
902 	 */
OnVehicleSelectDepotWindow903 	bool OnVehicleSelect(const Vehicle *v) override
904 	{
905 		if (_ctrl_pressed) {
906 			/* Share-clone, do not open new viewport, and keep tool active */
907 			DoCommandP(this->window_number, v->index, 1, CMD_CLONE_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_BUY_TRAIN + v->type), nullptr);
908 		} else {
909 			/* Copy-clone, open viewport for new vehicle, and deselect the tool (assume player wants to changs things on new vehicle) */
910 			if (DoCommandP(this->window_number, v->index, 0, CMD_CLONE_VEHICLE | CMD_MSG(STR_ERROR_CAN_T_BUY_TRAIN + v->type), CcCloneVehicle)) {
911 				ResetObjectToPlace();
912 			}
913 		}
914 
915 		return true;
916 	}
917 
OnPlaceObjectAbortDepotWindow918 	void OnPlaceObjectAbort() override
919 	{
920 		/* abort clone */
921 		this->RaiseWidget(WID_D_CLONE);
922 		this->SetWidgetDirty(WID_D_CLONE);
923 
924 		/* abort drag & drop */
925 		this->sel = INVALID_VEHICLE;
926 		this->vehicle_over = INVALID_VEHICLE;
927 		this->SetWidgetDirty(WID_D_MATRIX);
928 
929 		if (this->hovered_widget != -1) {
930 			this->SetWidgetLoweredState(this->hovered_widget, false);
931 			this->SetWidgetDirty(this->hovered_widget);
932 			this->hovered_widget = -1;
933 		}
934 	}
935 
OnMouseDragDepotWindow936 	void OnMouseDrag(Point pt, int widget) override
937 	{
938 		if (this->sel == INVALID_VEHICLE) return;
939 		if (widget != this->hovered_widget) {
940 			if (this->hovered_widget == WID_D_SELL || this->hovered_widget == WID_D_SELL_CHAIN) {
941 				this->SetWidgetLoweredState(this->hovered_widget, false);
942 				this->SetWidgetDirty(this->hovered_widget);
943 			}
944 			this->hovered_widget = widget;
945 			if (this->hovered_widget == WID_D_SELL || this->hovered_widget == WID_D_SELL_CHAIN) {
946 				this->SetWidgetLoweredState(this->hovered_widget, true);
947 				this->SetWidgetDirty(this->hovered_widget);
948 			}
949 		}
950 		if (this->type != VEH_TRAIN) return;
951 
952 		/* A rail vehicle is dragged.. */
953 		if (widget != WID_D_MATRIX) { // ..outside of the depot matrix.
954 			if (this->vehicle_over != INVALID_VEHICLE) {
955 				this->vehicle_over = INVALID_VEHICLE;
956 				this->SetWidgetDirty(WID_D_MATRIX);
957 			}
958 			return;
959 		}
960 
961 		NWidgetBase *matrix = this->GetWidget<NWidgetBase>(widget);
962 		const Vehicle *v = nullptr;
963 		GetDepotVehiclePtData gdvp = {nullptr, nullptr};
964 
965 		if (this->GetVehicleFromDepotWndPt(pt.x - matrix->pos_x, pt.y - matrix->pos_y, &v, &gdvp) != MODE_DRAG_VEHICLE) return;
966 
967 		VehicleID new_vehicle_over = INVALID_VEHICLE;
968 		if (gdvp.head != nullptr) {
969 			if (gdvp.wagon == nullptr && gdvp.head->Last()->index != this->sel) { // ..at the end of the train.
970 				/* NOTE: As a wagon can't be moved at the begin of a train, head index isn't used to mark a drag-and-drop
971 				 * destination inside a train. This head index is then used to indicate that a wagon is inserted at
972 				 * the end of the train.
973 				 */
974 				new_vehicle_over = gdvp.head->index;
975 			} else if (gdvp.wagon != nullptr && gdvp.head != gdvp.wagon &&
976 					gdvp.wagon->index != this->sel &&
977 					gdvp.wagon->Previous()->index != this->sel) { // ..over an existing wagon.
978 				new_vehicle_over = gdvp.wagon->index;
979 			}
980 		}
981 
982 		if (this->vehicle_over == new_vehicle_over) return;
983 
984 		this->vehicle_over = new_vehicle_over;
985 		this->SetWidgetDirty(widget);
986 	}
987 
OnDragDropDepotWindow988 	void OnDragDrop(Point pt, int widget) override
989 	{
990 		switch (widget) {
991 			case WID_D_MATRIX: {
992 				const Vehicle *v = nullptr;
993 				VehicleID sel = this->sel;
994 
995 				this->sel = INVALID_VEHICLE;
996 				this->SetDirty();
997 
998 				NWidgetBase *nwi = this->GetWidget<NWidgetBase>(WID_D_MATRIX);
999 				if (this->type == VEH_TRAIN) {
1000 					GetDepotVehiclePtData gdvp = { nullptr, nullptr };
1001 
1002 					if (this->GetVehicleFromDepotWndPt(pt.x - nwi->pos_x, pt.y - nwi->pos_y, &v, &gdvp) == MODE_DRAG_VEHICLE && sel != INVALID_VEHICLE) {
1003 						if (gdvp.wagon != nullptr && gdvp.wagon->index == sel && _ctrl_pressed) {
1004 							DoCommandP(Vehicle::Get(sel)->tile, Vehicle::Get(sel)->index, true,
1005 									CMD_REVERSE_TRAIN_DIRECTION | CMD_MSG(STR_ERROR_CAN_T_REVERSE_DIRECTION_RAIL_VEHICLE));
1006 						} else if (gdvp.wagon == nullptr || gdvp.wagon->index != sel) {
1007 							this->vehicle_over = INVALID_VEHICLE;
1008 							TrainDepotMoveVehicle(gdvp.wagon, sel, gdvp.head);
1009 						} else if (gdvp.head != nullptr && gdvp.head->IsFrontEngine()) {
1010 							ShowVehicleViewWindow(gdvp.head);
1011 						}
1012 					}
1013 				} else if (this->GetVehicleFromDepotWndPt(pt.x - nwi->pos_x, pt.y - nwi->pos_y, &v, nullptr) == MODE_DRAG_VEHICLE && v != nullptr && sel == v->index) {
1014 					ShowVehicleViewWindow(v);
1015 				}
1016 				break;
1017 			}
1018 
1019 			case WID_D_SELL: case WID_D_SELL_CHAIN: {
1020 				if (this->IsWidgetDisabled(widget)) return;
1021 				if (this->sel == INVALID_VEHICLE) return;
1022 
1023 				this->HandleButtonClick(widget);
1024 
1025 				const Vehicle *v = Vehicle::Get(this->sel);
1026 				this->sel = INVALID_VEHICLE;
1027 				this->SetDirty();
1028 
1029 				int sell_cmd = (v->type == VEH_TRAIN && (widget == WID_D_SELL_CHAIN || _ctrl_pressed)) ? 1 : 0;
1030 				DoCommandP(v->tile, v->index | sell_cmd << 20 | MAKE_ORDER_BACKUP_FLAG, 0, GetCmdSellVeh(v->type));
1031 				break;
1032 			}
1033 
1034 			default:
1035 				this->sel = INVALID_VEHICLE;
1036 				this->SetDirty();
1037 				break;
1038 		}
1039 		this->hovered_widget = -1;
1040 		_cursor.vehchain = false;
1041 	}
1042 
OnTimeoutDepotWindow1043 	void OnTimeout() override
1044 	{
1045 		if (!this->IsWidgetDisabled(WID_D_SELL)) {
1046 			this->RaiseWidget(WID_D_SELL);
1047 			this->SetWidgetDirty(WID_D_SELL);
1048 		}
1049 		if (this->GetWidget<NWidgetBase>(WID_D_SELL) != nullptr && !this->IsWidgetDisabled(WID_D_SELL_CHAIN)) {
1050 			this->RaiseWidget(WID_D_SELL_CHAIN);
1051 			this->SetWidgetDirty(WID_D_SELL_CHAIN);
1052 		}
1053 	}
1054 
OnResizeDepotWindow1055 	void OnResize() override
1056 	{
1057 		this->vscroll->SetCapacityFromWidget(this, WID_D_MATRIX);
1058 		NWidgetCore *nwi = this->GetWidget<NWidgetCore>(WID_D_MATRIX);
1059 		if (this->type == VEH_TRAIN) {
1060 			this->hscroll->SetCapacity(nwi->current_x - this->header_width - this->count_width);
1061 		} else {
1062 			this->num_columns = nwi->current_x / nwi->resize_x;
1063 		}
1064 	}
1065 
OnCTRLStateChangeDepotWindow1066 	EventState OnCTRLStateChange() override
1067 	{
1068 		if (this->sel != INVALID_VEHICLE) {
1069 			_cursor.vehchain = _ctrl_pressed;
1070 			this->SetWidgetDirty(WID_D_MATRIX);
1071 			return ES_HANDLED;
1072 		}
1073 
1074 		return ES_NOT_HANDLED;
1075 	}
1076 
1077 	/**
1078 	 * Gets the DepotID of the current window.
1079 	 * In the case of airports, this is the station ID.
1080 	 * @return Depot or station ID of this window.
1081 	 */
GetDepotIndexDepotWindow1082 	inline uint16 GetDepotIndex() const
1083 	{
1084 		return (this->type == VEH_AIRCRAFT) ? ::GetStationIndex(this->window_number) : ::GetDepotIndex(this->window_number);
1085 	}
1086 };
1087 
DepotSellAllConfirmationCallback(Window * win,bool confirmed)1088 static void DepotSellAllConfirmationCallback(Window *win, bool confirmed)
1089 {
1090 	if (confirmed) {
1091 		DepotWindow *w = (DepotWindow*)win;
1092 		TileIndex tile = w->window_number;
1093 		byte vehtype = w->type;
1094 		DoCommandP(tile, vehtype, 0, CMD_DEPOT_SELL_ALL_VEHICLES);
1095 	}
1096 }
1097 
1098 /**
1099  * Opens a depot window
1100  * @param tile The tile where the depot/hangar is located
1101  * @param type The type of vehicles in the depot
1102  */
ShowDepotWindow(TileIndex tile,VehicleType type)1103 void ShowDepotWindow(TileIndex tile, VehicleType type)
1104 {
1105 	if (BringWindowToFrontById(WC_VEHICLE_DEPOT, tile) != nullptr) return;
1106 
1107 	WindowDesc *desc;
1108 	switch (type) {
1109 		default: NOT_REACHED();
1110 		case VEH_TRAIN:    desc = &_train_depot_desc;    break;
1111 		case VEH_ROAD:     desc = &_road_depot_desc;     break;
1112 		case VEH_SHIP:     desc = &_ship_depot_desc;     break;
1113 		case VEH_AIRCRAFT: desc = &_aircraft_depot_desc; break;
1114 	}
1115 
1116 	new DepotWindow(desc, tile, type);
1117 }
1118 
1119 /**
1120  * Removes the highlight of a vehicle in a depot window
1121  * @param *v Vehicle to remove all highlights from
1122  */
DeleteDepotHighlightOfVehicle(const Vehicle * v)1123 void DeleteDepotHighlightOfVehicle(const Vehicle *v)
1124 {
1125 	DepotWindow *w;
1126 
1127 	/* If we haven't got any vehicles on the mouse pointer, we haven't got any highlighted in any depots either
1128 	 * If that is the case, we can skip looping though the windows and save time
1129 	 */
1130 	if (_special_mouse_mode != WSM_DRAGDROP) return;
1131 
1132 	w = dynamic_cast<DepotWindow*>(FindWindowById(WC_VEHICLE_DEPOT, v->tile));
1133 	if (w != nullptr) {
1134 		if (w->sel == v->index) ResetObjectToPlace();
1135 	}
1136 }
1137