Translations update

[openttd/fttd.git] / src / vehicle_gui.cpp

/* $Id$ */

/*
 * This file is part of OpenTTD.
 * 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.
 * 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.
 * 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/>.
 */

/** @file vehicle_gui.cpp The base GUI for all vehicles. */

#include "stdafx.h"
#include "debug.h"
#include "company_func.h"
#include "gui.h"
#include "textbuf_gui.h"
#include "command_func.h"
#include "vehicle_gui_base.h"
#include "viewport_func.h"
#include "newgrf_text.h"
#include "newgrf_debug.h"
#include "roadveh.h"
#include "train.h"
#include "aircraft.h"
#include "group_gui.h"
#include "strings_func.h"
#include "vehicle_func.h"
#include "autoreplace_gui.h"
#include "string.h"
#include "widgets/dropdown_func.h"
#include "timetable.h"
#include "articulated_vehicles.h"
#include "spritecache.h"
#include "core/geometry_func.hpp"
#include "company_base.h"
#include "engine_func.h"
#include "station_base.h"
#include "tilehighlight_func.h"
#include "zoom_func.h"
#include "font.h"


Sorting _sorting;

static GUIVehicleList::SortFunction VehicleNumberSorter;
static GUIVehicleList::SortFunction VehicleNameSorter;
static GUIVehicleList::SortFunction VehicleAgeSorter;
static GUIVehicleList::SortFunction VehicleProfitThisYearSorter;
static GUIVehicleList::SortFunction VehicleProfitLastYearSorter;
static GUIVehicleList::SortFunction VehicleCargoSorter;
static GUIVehicleList::SortFunction VehicleReliabilitySorter;
static GUIVehicleList::SortFunction VehicleMaxSpeedSorter;
static GUIVehicleList::SortFunction VehicleModelSorter;
static GUIVehicleList::SortFunction VehicleValueSorter;
static GUIVehicleList::SortFunction VehicleLengthSorter;
static GUIVehicleList::SortFunction VehicleTimeToLiveSorter;
static GUIVehicleList::SortFunction VehicleTimetableDelaySorter;

GUIVehicleList::SortFunction * const BaseVehicleListWindow::vehicle_sorter_funcs[] = {
        &VehicleNumberSorter,
        &VehicleNameSorter,
        &VehicleAgeSorter,
        &VehicleProfitThisYearSorter,
        &VehicleProfitLastYearSorter,
        &VehicleCargoSorter,
        &VehicleReliabilitySorter,
        &VehicleMaxSpeedSorter,
        &VehicleModelSorter,
        &VehicleValueSorter,
        &VehicleLengthSorter,
        &VehicleTimeToLiveSorter,
        &VehicleTimetableDelaySorter,
};

const StringID BaseVehicleListWindow::vehicle_sorter_names[] = {
        STR_SORT_BY_NUMBER,
        STR_SORT_BY_NAME,
        STR_SORT_BY_AGE,
        STR_SORT_BY_PROFIT_THIS_YEAR,
        STR_SORT_BY_PROFIT_LAST_YEAR,
        STR_SORT_BY_TOTAL_CAPACITY_PER_CARGOTYPE,
        STR_SORT_BY_RELIABILITY,
        STR_SORT_BY_MAX_SPEED,
        STR_SORT_BY_MODEL,
        STR_SORT_BY_VALUE,
        STR_SORT_BY_LENGTH,
        STR_SORT_BY_LIFE_TIME,
        STR_SORT_BY_TIMETABLE_DELAY,
        INVALID_STRING_ID
};

const StringID BaseVehicleListWindow::vehicle_depot_name[] = {
        STR_VEHICLE_LIST_SEND_TRAIN_TO_DEPOT,
        STR_VEHICLE_LIST_SEND_ROAD_VEHICLE_TO_DEPOT,
        STR_VEHICLE_LIST_SEND_SHIP_TO_DEPOT,
        STR_VEHICLE_LIST_SEND_AIRCRAFT_TO_HANGAR
};

/**
 * Get the number of digits the biggest unit number of a set of vehicles has.
 * @param vehicles The list of vehicles.
 * @return The number of digits to allocate space for.
 */
uint GetUnitNumberDigits(VehicleList &vehicles)
{
        uint unitnumber = 0;
        for (const Vehicle **v = vehicles.Begin(); v != vehicles.End(); v++) {
                unitnumber = max<uint>(unitnumber, (*v)->unitnumber);
        }

        if (unitnumber >= 10000) return 5;
        if (unitnumber >=  1000) return 4;
        if (unitnumber >=   100) return 3;

        /*
         * When the smallest unit number is less than 10, it is
         * quite likely that it will expand to become more than
         * 10 quite soon.
         */
        return 2;
}

void BaseVehicleListWindow::BuildVehicleList()
{
        if (!this->vehicles.NeedRebuild()) return;

        DEBUG(misc, 3, "Building vehicle list type %d for company %d given index %d", this->vli.type, this->vli.company, this->vli.index);

        GenerateVehicleSortList(&this->vehicles, this->vli);

        this->unitnumber_digits = GetUnitNumberDigits(this->vehicles);

        this->vehicles.RebuildDone();
        this->vscroll->SetCount(this->vehicles.Length());
}

/**
 * Compute the size for the Action dropdown.
 * @param show_autoreplace If true include the autoreplace item.
 * @param show_group If true include group-related stuff.
 * @return Required size.
 */
Dimension BaseVehicleListWindow::GetActionDropdownSize(bool show_autoreplace, bool show_group)
{
        Dimension d = {0, 0};

        if (show_autoreplace) d = maxdim(d, GetStringBoundingBox(STR_VEHICLE_LIST_REPLACE_VEHICLES));
        d = maxdim(d, GetStringBoundingBox(STR_VEHICLE_LIST_SEND_FOR_SERVICING));
        d = maxdim(d, GetStringBoundingBox(this->vehicle_depot_name[this->vli.vtype]));

        if (show_group) {
                d = maxdim(d, GetStringBoundingBox(STR_GROUP_ADD_SHARED_VEHICLE));
                d = maxdim(d, GetStringBoundingBox(STR_GROUP_REMOVE_ALL_VEHICLES));
        }

        return d;
}

/**
 * Display the Action dropdown window.
 * @param show_autoreplace If true include the autoreplace item.
 * @param show_group If true include group-related stuff.
 * @return Itemlist for dropdown
 */
DropDownList *BaseVehicleListWindow::BuildActionDropdownList(bool show_autoreplace, bool show_group)
{
        DropDownList *list = new DropDownList();

        if (show_autoreplace) *list->Append() = new DropDownListStringItem(STR_VEHICLE_LIST_REPLACE_VEHICLES, ADI_REPLACE, false);
        *list->Append() = new DropDownListStringItem(STR_VEHICLE_LIST_SEND_FOR_SERVICING, ADI_SERVICE, false);
        *list->Append() = new DropDownListStringItem(this->vehicle_depot_name[this->vli.vtype], ADI_DEPOT, false);

        if (show_group) {
                *list->Append() = new DropDownListStringItem(STR_GROUP_ADD_SHARED_VEHICLE, ADI_ADD_SHARED, false);
                *list->Append() = new DropDownListStringItem(STR_GROUP_REMOVE_ALL_VEHICLES, ADI_REMOVE_ALL, false);
        }

        return list;
}

/* cached values for VehicleNameSorter to spare many GetString() calls */
static const Vehicle *_last_vehicle[2] = { NULL, NULL };

void BaseVehicleListWindow::SortVehicleList()
{
        if (this->vehicles.Sort()) return;

        /* invalidate cached values for name sorter - vehicle names could change */
        _last_vehicle[0] = _last_vehicle[1] = NULL;
}

void DepotSortList(VehicleList *list)
{
        if (list->Length() < 2) return;
        QSortT(list->Begin(), list->Length(), &VehicleNumberSorter);
}

/** Maximum number of refit cycles we try, to prevent infinite loops. And we store only a byte anyway */
static const uint MAX_REFIT_CYCLE = 256;

/**
 * Get the best fitting subtype when 'cloning'/'replacing' \a v_from with \a v_for.
 * All articulated parts of both vehicles are tested to find a possibly shared subtype.
 * For \a v_for only vehicle refittable to \a dest_cargo_type are considered.
 * @param v_from the vehicle to match the subtype from
 * @param v_for  the vehicle to get the subtype for
 * @param dest_cargo_type Destination cargo type.
 * @return the best sub type
 */
byte GetBestFittingSubType(Vehicle *v_from, Vehicle *v_for, CargoID dest_cargo_type)
{
        v_from = v_from->GetFirstEnginePart();
        v_for = v_for->GetFirstEnginePart();

        /* Create a list of subtypes used by the various parts of v_for */
        static SmallVector<StringID, 4> subtypes;
        subtypes.Clear();
        for (; v_from != NULL; v_from = v_from->HasArticulatedPart() ? v_from->GetNextArticulatedPart() : NULL) {
                const Engine *e_from = v_from->GetEngine();
                if (!e_from->CanCarryCargo() || !HasBit(e_from->info.callback_mask, CBM_VEHICLE_CARGO_SUFFIX)) continue;
                subtypes.Include(GetCargoSubtypeText(v_from));
        }

        byte ret_refit_cyc = 0;
        bool success = false;
        if (subtypes.Length() > 0) {
                /* Check whether any articulated part is refittable to 'dest_cargo_type' with a subtype listed in 'subtypes' */
                for (Vehicle *v = v_for; v != NULL; v = v->HasArticulatedPart() ? v->GetNextArticulatedPart() : NULL) {
                        const Engine *e = v->GetEngine();
                        if (!e->CanCarryCargo() || !HasBit(e->info.callback_mask, CBM_VEHICLE_CARGO_SUFFIX)) continue;
                        if (!HasBit(e->info.refit_mask, dest_cargo_type) && v->cargo_type != dest_cargo_type) continue;

                        CargoID old_cargo_type = v->cargo_type;
                        byte old_cargo_subtype = v->cargo_subtype;

                        /* Set the 'destination' cargo */
                        v->cargo_type = dest_cargo_type;

                        /* Cycle through the refits */
                        for (uint refit_cyc = 0; refit_cyc < MAX_REFIT_CYCLE; refit_cyc++) {
                                v->cargo_subtype = refit_cyc;

                                /* Make sure we don't pick up anything cached. */
                                v->First()->InvalidateNewGRFCache();
                                v->InvalidateNewGRFCache();

                                StringID subtype = GetCargoSubtypeText(v);
                                if (subtype == STR_EMPTY) break;

                                if (!subtypes.Contains(subtype)) continue;

                                /* We found something matching. */
                                ret_refit_cyc = refit_cyc;
                                success = true;
                                break;
                        }

                        /* Reset the vehicle's cargo type */
                        v->cargo_type    = old_cargo_type;
                        v->cargo_subtype = old_cargo_subtype;

                        /* Make sure we don't taint the vehicle. */
                        v->First()->InvalidateNewGRFCache();
                        v->InvalidateNewGRFCache();

                        if (success) break;
                }
        }

        return ret_refit_cyc;
}

/** Refit cargo window. */
struct RefitWindow : public Window {
        /** Option to refit a vehicle chain */
        struct RefitOption {
                CargoID cargo;    ///< Cargo to refit to
                byte subtype;     ///< Subcargo to use
                StringID string;  ///< GRF-local String to display for the cargo

                /**
                 * Inequality operator for #RefitOption.
                 * @param other Compare to this #RefitOption.
                 * @return True if both #RefitOption are different.
                 */
                inline bool operator != (const RefitOption &other) const
                {
                        return other.cargo != this->cargo || other.string != this->string;
                }

                /**
                 * Equality operator for #RefitOption.
                 * @param other Compare to this #RefitOption.
                 * @return True if both #RefitOption are equal.
                 */
                inline bool operator == (const RefitOption &other) const
                {
                        return other.cargo == this->cargo && other.string == this->string;
                }
        };

        typedef SmallVector<RefitOption, 32> SubtypeList; ///< List of refit subtypes associated to a cargo.

        CargoID sel_cargo;           ///< Selected cargo, or CT_INVALID for none
        byte sel_subcargo;           ///< Selected subcargo
        RefitOption *cargo;          ///< Refit option selected by #sel.
        SubtypeList list[NUM_CARGO]; ///< List of refit subtypes available for each sorted cargo.
        VehicleOrderID order;        ///< If not #INVALID_VEH_ORDER_ID, selection is part of a refit order (rather than execute directly).
        uint information_width;      ///< Width required for correctly displaying all cargoes in the information panel.
        Scrollbar *vscroll;          ///< The main scrollbar.
        Scrollbar *hscroll;          ///< Only used for long vehicles.
        int vehicle_width;           ///< Width of the vehicle being drawn.
        int sprite_left;             ///< Left position of the vehicle sprite.
        int sprite_right;            ///< Right position of the vehicle sprite.
        uint vehicle_margin;         ///< Margin to use while selecting vehicles when the vehicle image is centered.
        int click_x;                 ///< Position of the first click while dragging.
        VehicleID selected_vehicle;  ///< First vehicle in the current selection.
        uint8 num_vehicles;          ///< Number of selected vehicles.
        bool auto_refit;             ///< Select cargo for auto-refitting.
        CargoMask cargo_mask;        ///< Selected cargoes, when auto-refitting.

        /**
         * Collects all (cargo, subcargo) refit options of a vehicle chain.
         */
        void BuildRefitList()
        {
                for (uint i = 0; i < NUM_CARGO; i++) this->list[i].Clear();
                Vehicle *v = Vehicle::Get(this->window_number);

                /* Check only the selected vehicles. */
                VehicleSet vehicles_to_refit;
                GetVehicleSet(vehicles_to_refit, Vehicle::Get(this->selected_vehicle), this->num_vehicles);

                do {
                        if (v->type == VEH_TRAIN && !vehicles_to_refit.Contains(v->index)) continue;
                        const Engine *e = v->GetEngine();
                        uint32 cmask = e->info.refit_mask;
                        byte callback_mask = e->info.callback_mask;

                        /* Skip this engine if it does not carry anything */
                        if (!e->CanCarryCargo()) continue;
                        /* Skip this engine if we build the list for auto-refitting and engine doesn't allow it. */
                        if (this->auto_refit && !HasBit(e->info.misc_flags, EF_AUTO_REFIT)) continue;

                        /* Loop through all cargoes in the refit mask */
                        int current_index = 0;
                        const CargoSpec *cs;
                        FOR_ALL_SORTED_CARGOSPECS(cs) {
                                CargoID cid = cs->Index();
                                /* Skip cargo type if it's not listed */
                                if (!HasBit(cmask, cid)) {
                                        current_index++;
                                        continue;
                                }

                                bool first_vehicle = this->list[current_index].Length() == 0;
                                if (first_vehicle) {
                                        /* Keeping the current subtype is always an option. It also serves as the option in case of no subtypes */
                                        RefitOption *option = this->list[current_index].Append();
                                        option->cargo   = cid;
                                        option->subtype = 0xFF;
                                        option->string  = STR_EMPTY;
                                }

                                /* Check the vehicle's callback mask for cargo suffixes.
                                 * This is not supported for ordered refits, since subtypes only have a meaning
                                 * for a specific vehicle at a specific point in time, which conflicts with shared orders,
                                 * autoreplace, autorenew, clone, order restoration, ... */
                                if (this->order == INVALID_VEH_ORDER_ID && HasBit(callback_mask, CBM_VEHICLE_CARGO_SUFFIX)) {
                                        /* Make a note of the original cargo type. It has to be
                                         * changed to test the cargo & subtype... */
                                        CargoID temp_cargo = v->cargo_type;
                                        byte temp_subtype  = v->cargo_subtype;

                                        v->cargo_type = cid;

                                        for (uint refit_cyc = 0; refit_cyc < MAX_REFIT_CYCLE; refit_cyc++) {
                                                v->cargo_subtype = refit_cyc;

                                                /* Make sure we don't pick up anything cached. */
                                                v->First()->InvalidateNewGRFCache();
                                                v->InvalidateNewGRFCache();

                                                StringID subtype = GetCargoSubtypeText(v);

                                                if (first_vehicle) {
                                                        /* Append new subtype (don't add duplicates though) */
                                                        if (subtype == STR_EMPTY) break;

                                                        RefitOption option;
                                                        option.cargo   = cid;
                                                        option.subtype = refit_cyc;
                                                        option.string  = subtype;
                                                        this->list[current_index].Include(option);
                                                } else {
                                                        /* Intersect the subtypes of earlier vehicles with the subtypes of this vehicle */
                                                        if (subtype == STR_EMPTY) {
                                                                /* No more subtypes for this vehicle, delete all subtypes >= refit_cyc */
                                                                SubtypeList &l = this->list[current_index];
                                                                /* 0xFF item is in front, other subtypes are sorted. So just truncate the list in the right spot */
                                                                for (uint i = 1; i < l.Length(); i++) {
                                                                        if (l[i].subtype >= refit_cyc) {
                                                                                l.Resize(i);
                                                                                break;
                                                                        }
                                                                }
                                                                break;
                                                        } else {
                                                                /* Check whether the subtype matches with the subtype of earlier vehicles. */
                                                                uint pos = 1;
                                                                SubtypeList &l = this->list[current_index];
                                                                while (pos < l.Length() && l[pos].subtype != refit_cyc) pos++;
                                                                if (pos < l.Length() && l[pos].string != subtype) {
                                                                        /* String mismatch, remove item keeping the order */
                                                                        l.ErasePreservingOrder(pos);
                                                                }
                                                        }
                                                }
                                        }

                                        /* Reset the vehicle's cargo type */
                                        v->cargo_type    = temp_cargo;
                                        v->cargo_subtype = temp_subtype;

                                        /* And make sure we haven't tainted the cache */
                                        v->First()->InvalidateNewGRFCache();
                                        v->InvalidateNewGRFCache();
                                }
                                current_index++;
                        }
                } while (v->IsGroundVehicle() && (v = v->Next()) != NULL);
        }

        /**
         * Refresh scrollbar after selection changed
         */
        void RefreshScrollbar()
        {
                uint scroll_row = 0;
                uint row = 0;

                for (uint i = 0; i < NUM_CARGO; i++) {
                        for (uint j = 0; j < this->list[i].Length(); j++) {
                                const RefitOption &refit = this->list[i][j];

                                /* Hide subtypes if sel_cargo does not match */
                                if (this->sel_cargo != i && refit.subtype != 0xFF) continue;

                                if (this->sel_cargo == i && this->sel_subcargo == j) scroll_row = row;

                                row++;
                        }
                }

                this->vscroll->SetCount(row);
                if (scroll_row < row) this->vscroll->ScrollTowards(scroll_row);
        }

        /**
         * Select a row.
         * @param click_row Clicked row
         * @return Selected cargo id
         */
        CargoID SetSelection(uint click_row)
        {
                uint row = 0;

                for (uint i = 0; i < NUM_CARGO; i++) {
                        for (uint j = 0; j < this->list[i].Length(); j++) {
                                const RefitOption &refit = this->list[i][j];

                                /* Hide subtypes if sel_cargo does not match */
                                if (this->sel_cargo != i && refit.subtype != 0xFF) continue;

                                if (row == click_row) {
                                        this->sel_cargo = i;
                                        this->sel_subcargo = j;
                                        return refit.cargo;
                                }

                                row++;
                        }
                }

                this->sel_cargo = CT_INVALID;
                this->sel_subcargo = 0;
                return CT_INVALID;
        }

        /**
         * Gets the #RefitOption placed in the selected index.
         * @return Pointer to the #RefitOption currently in use.
         */
        RefitOption *GetRefitOption()
        {
                if (this->sel_cargo == CT_INVALID) return NULL;

                SubtypeList &l = this->list[this->sel_cargo];
                if (this->sel_subcargo >= l.Length()) return NULL;

                return &l[this->sel_subcargo];
        }

        RefitWindow (const WindowDesc *desc, const Vehicle *v, VehicleOrderID order,
                        bool auto_refit, CargoMask cargo_mask = 0) :
                Window (desc),
                sel_cargo (CT_INVALID), sel_subcargo (0), cargo (NULL),
                order (order), information_width (0),
                vscroll (NULL), hscroll (NULL), vehicle_width (0),
                sprite_left (0), sprite_right (0), vehicle_margin (0),
                click_x (0), selected_vehicle (0), num_vehicles (0),
                auto_refit (auto_refit), cargo_mask (cargo_mask)
        {
                assert (!auto_refit || (order != INVALID_VEH_ORDER_ID));

                memset (this->list, 0, sizeof(this->list));

                this->CreateNestedTree();

                this->vscroll = this->GetScrollbar(WID_VR_SCROLLBAR);
                this->hscroll = (v->IsGroundVehicle() ? this->GetScrollbar(WID_VR_HSCROLLBAR) : NULL);
                this->GetWidget<NWidgetCore>(WID_VR_SELECT_HEADER)->tool_tip = STR_REFIT_TRAIN_LIST_TOOLTIP + v->type;
                this->GetWidget<NWidgetCore>(WID_VR_MATRIX)->tool_tip        = STR_REFIT_TRAIN_LIST_TOOLTIP + v->type;
                NWidgetCore *nwi = this->GetWidget<NWidgetCore>(WID_VR_REFIT);
                nwi->widget_data = STR_REFIT_TRAIN_REFIT_BUTTON + v->type;
                nwi->tool_tip    = STR_REFIT_TRAIN_REFIT_TOOLTIP + v->type;
                this->GetWidget<NWidgetStacked>(WID_VR_SHOW_HSCROLLBAR)->SetDisplayedPlane(v->IsGroundVehicle() ? 0 : SZSP_HORIZONTAL);
                this->GetWidget<NWidgetCore>(WID_VR_VEHICLE_PANEL_DISPLAY)->tool_tip = (v->type == VEH_TRAIN) ? STR_REFIT_SELECT_VEHICLES_TOOLTIP : STR_NULL;

                this->InitNested(v->index);
                this->owner = v->owner;

                this->SetWidgetDisabledState (WID_VR_REFIT, !auto_refit && (this->sel_cargo == CT_INVALID));
        }

        virtual void OnInit()
        {
                if (this->cargo != NULL) {
                        /* Store the RefitOption currently in use. */
                        RefitOption current_refit_option = *(this->cargo);

                        /* Rebuild the refit list */
                        this->BuildRefitList();
                        this->sel_cargo = CT_INVALID;
                        this->sel_subcargo = 0;
                        this->cargo = NULL;
                        for (uint i = 0; this->cargo == NULL && i < NUM_CARGO; i++) {
                                for (uint j = 0; j < list[i].Length(); j++) {
                                        if (list[i][j] == current_refit_option) {
                                                this->sel_cargo = i;
                                                this->sel_subcargo = j;
                                                this->cargo = &list[i][j];
                                                break;
                                        }
                                }
                        }

                        this->SetWidgetDisabledState (WID_VR_REFIT, !this->auto_refit && (this->sel_cargo == CT_INVALID));
                        this->RefreshScrollbar();
                } else {
                        /* Rebuild the refit list */
                        this->OnInvalidateData(VIWD_CONSIST_CHANGED);
                }
        }

        void OnPaint (BlitArea *dpi) OVERRIDE
        {
                /* Determine amount of items for scroller. */
                if (this->hscroll != NULL) this->hscroll->SetCount(this->vehicle_width);

                /* Calculate sprite position. */
                NWidgetCore *vehicle_panel_display = this->GetWidget<NWidgetCore>(WID_VR_VEHICLE_PANEL_DISPLAY);
                int sprite_width = max(0, ((int)vehicle_panel_display->current_x - this->vehicle_width) / 2);
                this->sprite_left = vehicle_panel_display->pos_x;
                this->sprite_right = vehicle_panel_display->pos_x + vehicle_panel_display->current_x - 1;
                if (_current_text_dir == TD_RTL) {
                        this->sprite_right -= sprite_width;
                        this->vehicle_margin = vehicle_panel_display->current_x - sprite_right;
                } else {
                        this->sprite_left += sprite_width;
                        this->vehicle_margin = sprite_left;
                }

                this->DrawWidgets (dpi);
        }

        virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
        {
                switch (widget) {
                        case WID_VR_MATRIX:
                                resize->height = WD_MATRIX_TOP + FONT_HEIGHT_NORMAL + WD_MATRIX_BOTTOM;
                                size->height = resize->height * 8;
                                break;

                        case WID_VR_VEHICLE_PANEL_DISPLAY:
                                size->height = ScaleGUITrad(GetVehicleHeight(Vehicle::Get(this->window_number)->type));
                                break;

                        case WID_VR_INFO:
                                size->width = WD_FRAMERECT_LEFT + this->information_width + WD_FRAMERECT_RIGHT;
                                break;

                        case WID_VR_CLEAR:
                                if (!auto_refit) {
                                        size->width = 0;
                                        resize->width = 0;
                                        fill->width = 0;
                                }
                                break;
                }
        }

        virtual void SetStringParameters(int widget) const
        {
                if (widget == WID_VR_CAPTION) SetDParam(0, Vehicle::Get(this->window_number)->index);
        }

        /**
         * Gets the #StringID to use for displaying capacity.
         * @param Cargo and cargo subtype to check for capacity.
         * @return INVALID_STRING_ID if there is no capacity. StringID to use in any other case.
         * @post String parameters have been set.
         */
        StringID GetCapacityString(RefitOption *option) const
        {
                assert(_current_company == _local_company);
                Vehicle *v = Vehicle::Get(this->window_number);
                CommandCost cost = DoCommand(v->tile, this->selected_vehicle, option->cargo | (int)this->auto_refit << 6 | option->subtype << 8 |
                                this->num_vehicles << 16, DC_QUERY_COST, CMD_REFIT_VEHICLE);

                if (cost.Failed()) return INVALID_STRING_ID;

                SetDParam(0, option->cargo);
                SetDParam(1, _returned_refit_capacity);

                Money money = cost.GetCost();
                if (_returned_mail_refit_capacity > 0) {
                        SetDParam(2, CT_MAIL);
                        SetDParam(3, _returned_mail_refit_capacity);
                        if (this->order != INVALID_VEH_ORDER_ID) {
                                /* No predictable cost */
                                return STR_PURCHASE_INFO_AIRCRAFT_CAPACITY;
                        } else if (money <= 0) {
                                SetDParam(4, -money);
                                return STR_REFIT_NEW_CAPACITY_INCOME_FROM_AIRCRAFT_REFIT;
                        } else {
                                SetDParam(4, money);
                                return STR_REFIT_NEW_CAPACITY_COST_OF_AIRCRAFT_REFIT;
                        }
                } else {
                        if (this->order != INVALID_VEH_ORDER_ID) {
                                /* No predictable cost */
                                SetDParam(2, STR_EMPTY);
                                return STR_PURCHASE_INFO_CAPACITY;
                        } else if (money <= 0) {
                                SetDParam(2, -money);
                                return STR_REFIT_NEW_CAPACITY_INCOME_FROM_REFIT;
                        } else {
                                SetDParam(2, money);
                                return STR_REFIT_NEW_CAPACITY_COST_OF_REFIT;
                        }
                }
        }

        /**
         * Draw the list of available refit options for a consist and highlight the selected refit option (if any).
         * @param dpi Area to draw on.
         * @param r Rectangle of the matrix widget.
         */
        void DrawRefitWidget (BlitArea *dpi, const Rect &r) const
        {
                const SubtypeList *list = this->list;
                CargoID sel_cargo = this->sel_cargo;
                uint pos   = this->vscroll->GetPosition();
                uint limit = pos + this->vscroll->GetCapacity();
                uint delta = this->resize.step_height;

                uint y = r.top + WD_MATRIX_TOP;
                uint current = 0;

                SpriteID spr1, spr2;
                if (this->auto_refit) {
                        spr1 = SPR_BOX_EMPTY;
                        spr2 = SPR_BOX_CHECKED;
                } else {
                        spr1 = SPR_CIRCLE_FOLDED;
                        spr2 = SPR_CIRCLE_UNFOLDED;
                }
                uint iconwidth = max (GetSpriteSize(spr1).width, GetSpriteSize(spr2).width);
                uint iconheight = GetSpriteSize(spr1).height;
                int linecolour = _colour_gradient[COLOUR_ORANGE][4];

                bool rtl = _current_text_dir == TD_RTL;

                int iconleft   = rtl ? r.right - WD_MATRIX_RIGHT - iconwidth     : r.left + WD_MATRIX_LEFT;
                int iconcenter = rtl ? r.right - WD_MATRIX_RIGHT - iconwidth / 2 : r.left + WD_MATRIX_LEFT + iconwidth / 2;
                int iconinner  = rtl ? r.right - WD_MATRIX_RIGHT - iconwidth     : r.left + WD_MATRIX_LEFT + iconwidth;

                int textleft   = r.left  + WD_MATRIX_LEFT  + (rtl ? 0 : iconwidth + 4);
                int textright  = r.right - WD_MATRIX_RIGHT - (rtl ? iconwidth + 4 : 0);

                /* Draw the list of subtypes for each cargo, and find the selected refit option (by its position). */
                for (uint i = 0; current < limit && i < NUM_CARGO; i++) {
                        for (uint j = 0; current < limit && j < list[i].Length(); j++) {
                                const RefitOption &refit = list[i][j];

                                /* Hide subtypes if sel_cargo does not match */
                                if (sel_cargo != i && refit.subtype != 0xFF) continue;

                                /* Refit options with a position smaller than pos don't have to be drawn. */
                                if (current < pos) {
                                        current++;
                                        continue;
                                }

                                if (this->auto_refit) {
                                        assert (list[i].Length() == 1);
                                        assert (refit.subtype == 0xFF);
                                        /* Draw checkbox */
                                        DrawSprite (dpi, HasBit (this->cargo_mask, refit.cargo) ? SPR_BOX_CHECKED : SPR_BOX_EMPTY, PAL_NONE, iconleft, y + (FONT_HEIGHT_NORMAL - iconheight) / 2);
                                } else if (list[i].Length() > 1) {
                                        if (refit.subtype != 0xFF) {
                                                /* Draw tree lines */
                                                int ycenter = y + FONT_HEIGHT_NORMAL / 2;
                                                GfxDrawLine (dpi, iconcenter, y - WD_MATRIX_TOP, iconcenter, j == list[i].Length() - 1 ? ycenter : y - WD_MATRIX_TOP + delta - 1, linecolour);
                                                GfxDrawLine (dpi, iconcenter, ycenter, iconinner, ycenter, linecolour);
                                        } else {
                                                /* Draw expand/collapse icon */
                                                DrawSprite (dpi, sel_cargo == i ? SPR_CIRCLE_UNFOLDED : SPR_CIRCLE_FOLDED, PAL_NONE, iconleft, y + (FONT_HEIGHT_NORMAL - iconheight) / 2);
                                        }
                                }

                                TextColour colour = (sel_cargo == i && this->sel_subcargo == j) ? TC_WHITE : TC_BLACK;
                                /* Get the cargo name. */
                                SetDParam(0, CargoSpec::Get(refit.cargo)->name);
                                SetDParam(1, refit.string);
                                DrawString (dpi, textleft, textright, y, STR_JUST_STRING_STRING, colour);

                                y += delta;
                                current++;
                        }
                }
        }

        void DrawWidget (BlitArea *dpi, const Rect &r, int widget) const OVERRIDE
        {
                switch (widget) {
                        case WID_VR_VEHICLE_PANEL_DISPLAY: {
                                Vehicle *v = Vehicle::Get(this->window_number);
                                DrawVehicleImage (v, dpi, this->sprite_left + WD_FRAMERECT_LEFT, this->sprite_right - WD_FRAMERECT_RIGHT,
                                        r.top + WD_FRAMERECT_TOP, EIT_IN_DETAILS, this->hscroll != NULL ? this->hscroll->GetPosition() : 0);

                                /* Highlight selected vehicles. */
                                if (this->order != INVALID_VEH_ORDER_ID) break;
                                int x = 0;
                                switch (v->type) {
                                        case VEH_TRAIN: {
                                                VehicleSet vehicles_to_refit;
                                                GetVehicleSet(vehicles_to_refit, Vehicle::Get(this->selected_vehicle), this->num_vehicles);

                                                int left = INT32_MIN;
                                                int width = 0;

                                                for (Train *u = Train::From(v); u != NULL; u = u->Next()) {
                                                        /* Start checking. */
                                                        if (vehicles_to_refit.Contains(u->index) && left == INT32_MIN) {
                                                                left = x - this->hscroll->GetPosition() + r.left + this->vehicle_margin;
                                                                width = 0;
                                                        }

                                                        /* Draw a selection. */
                                                        if ((!vehicles_to_refit.Contains(u->index) || u->Next() == NULL) && left != INT32_MIN) {
                                                                if (u->Next() == NULL && vehicles_to_refit.Contains(u->index)) {
                                                                        int current_width = u->GetDisplayImageWidth();
                                                                        width += current_width;
                                                                        x += current_width;
                                                                }

                                                                int right = Clamp(left + width, 0, r.right);
                                                                left = max(0, left);

                                                                if (_current_text_dir == TD_RTL) {
                                                                        right = this->GetWidget<NWidgetCore>(WID_VR_VEHICLE_PANEL_DISPLAY)->current_x - left;
                                                                        left = right - width;
                                                                }

                                                                if (left != right) {
                                                                        DrawFrameRect (dpi, left, r.top + WD_FRAMERECT_TOP, right, r.top + WD_FRAMERECT_TOP + ScaleGUITrad(14) - 1, COLOUR_WHITE, FR_BORDERONLY);
                                                                }

                                                                left = INT32_MIN;
                                                        }

                                                        int current_width = u->GetDisplayImageWidth();
                                                        width += current_width;
                                                        x += current_width;
                                                }
                                                break;
                                        }

                                        default: break;
                                }
                                break;
                        }

                        case WID_VR_MATRIX:
                                this->DrawRefitWidget (dpi, r);
                                break;

                        case WID_VR_INFO:
                                if (this->cargo != NULL) {
                                        StringID string = this->GetCapacityString(this->cargo);
                                        if (string != INVALID_STRING_ID) {
                                                DrawStringMultiLine (dpi, r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT,
                                                                r.top + WD_FRAMERECT_TOP, r.bottom - WD_FRAMERECT_BOTTOM, string);
                                        }
                                }
                                break;
                }
        }

        /* Get the width of the current vehicle in pixels. */
        int GetVehicleWidth (void) const;

        /**
         * Some data on this window has become invalid.
         * @param data Information about the changed data.
         * @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.
         */
        virtual void OnInvalidateData(int data = 0, bool gui_scope = true)
        {
                switch (data) {
                        case VIWD_AUTOREPLACE: // Autoreplace replaced the vehicle; selected_vehicle became invalid.
                        case VIWD_CONSIST_CHANGED: { // The consist has changed; rebuild the entire list.
                                /* Clear the selection. */
                                Vehicle *v = Vehicle::Get(this->window_number);
                                this->selected_vehicle = v->index;
                                this->num_vehicles = UINT8_MAX;
                                /* FALL THROUGH */
                        }

                        case 2: { // The vehicle selection has changed; rebuild the entire list.
                                if (!gui_scope) break;
                                this->BuildRefitList();

                                /* The vehicle width has changed too. */
                                this->vehicle_width = this->GetVehicleWidth();
                                uint max_width = 0;

                                /* Check the width of all cargo information strings. */
                                for (uint i = 0; i < NUM_CARGO; i++) {
                                        for (uint j = 0; j < this->list[i].Length(); j++) {
                                                StringID string = this->GetCapacityString(&list[i][j]);
                                                if (string != INVALID_STRING_ID) {
                                                        Dimension dim = GetStringBoundingBox(string);
                                                        max_width = max(dim.width, max_width);
                                                }
                                        }
                                }

                                if (this->information_width < max_width) {
                                        this->information_width = max_width;
                                        this->ReInit();
                                }
                                /* FALL THROUGH */
                        }

                        case 1: // A new cargo has been selected.
                                if (!gui_scope) break;
                                this->cargo = GetRefitOption();
                                this->RefreshScrollbar();
                                break;
                }
        }

        int GetClickPosition(int click_x)
        {
                const NWidgetCore *matrix_widget = this->GetWidget<NWidgetCore>(WID_VR_VEHICLE_PANEL_DISPLAY);
                if (_current_text_dir == TD_RTL) click_x = matrix_widget->current_x - click_x;
                click_x -= this->vehicle_margin;
                if (this->hscroll != NULL) click_x += this->hscroll->GetPosition();

                return click_x;
        }

        void SetSelectedVehicles(int drag_x)
        {
                drag_x = GetClickPosition(drag_x);

                int left_x  = min(this->click_x, drag_x);
                int right_x = max(this->click_x, drag_x);
                this->num_vehicles = 0;

                Vehicle *v = Vehicle::Get(this->window_number);
                /* Find the vehicle part that was clicked. */
                switch (v->type) {
                        case VEH_TRAIN: {
                                /* Don't select anything if we are not clicking in the vehicle. */
                                if (left_x >= 0) {
                                        const Train *u = Train::From(v);
                                        bool start_counting = false;
                                        for (; u != NULL; u = u->Next()) {
                                                int current_width = u->GetDisplayImageWidth();
                                                left_x  -= current_width;
                                                right_x -= current_width;

                                                if (left_x < 0 && !start_counting) {
                                                        this->selected_vehicle = u->index;
                                                        start_counting = true;

                                                        /* Count the first vehicle, even if articulated part */
                                                        this->num_vehicles++;
                                                } else if (start_counting && !u->IsArticulatedPart()) {
                                                        /* Do not count articulated parts */
                                                        this->num_vehicles++;
                                                }

                                                if (right_x < 0) break;
                                        }
                                }

                                /* If the selection is not correct, clear it. */
                                if (this->num_vehicles != 0) {
                                        if (_ctrl_pressed) this->num_vehicles = UINT8_MAX;
                                        break;
                                }
                                /* FALL THROUGH */
                        }

                        default:
                                /* Clear the selection. */
                                this->selected_vehicle = v->index;
                                this->num_vehicles = UINT8_MAX;
                                break;
                }
        }

        virtual void OnClick(Point pt, int widget, int click_count)
        {
                switch (widget) {
                        case WID_VR_VEHICLE_PANEL_DISPLAY: { // Vehicle image.
                                if (this->order != INVALID_VEH_ORDER_ID) break;
                                NWidgetBase *nwi = this->GetWidget<NWidgetBase>(WID_VR_VEHICLE_PANEL_DISPLAY);
                                this->click_x = GetClickPosition(pt.x - nwi->pos_x);
                                this->SetSelectedVehicles(pt.x - nwi->pos_x);
                                this->SetWidgetDirty(WID_VR_VEHICLE_PANEL_DISPLAY);
                                if (!_ctrl_pressed) {
                                        SetPointerMode (POINTER_DRAG, this, SPR_CURSOR_MOUSE);
                                } else {
                                        /* The vehicle selection has changed. */
                                        this->InvalidateData(2);
                                }
                                break;
                        }

                        case WID_VR_MATRIX: { // listbox
                                uint row = this->vscroll->GetScrolledRowFromWidget (pt.y, this, WID_VR_MATRIX);
                                CargoID c = this->SetSelection(row);

                                if (this->auto_refit) {
                                        if (c != CT_INVALID) {
                                                const NWidgetBase *wid = this->GetWidget<NWidgetBase> (WID_VR_MATRIX);
                                                uint offset = pt.x - wid->pos_x;
                                                uint width = max (GetSpriteSize(SPR_BOX_EMPTY).width, GetSpriteSize(SPR_BOX_CHECKED).width) + 5;
                                                if (_current_text_dir == TD_RTL ? offset > wid->current_x - width : offset < width) {
                                                        ToggleBit (this->cargo_mask, c);
                                                }
                                        }
                                        this->InvalidateData (1);
                                        break;
                                }

                                /* not auto-refit */
                                this->SetWidgetDisabledState(WID_VR_REFIT, this->sel_cargo == CT_INVALID);
                                this->InvalidateData(1);

                                if (click_count == 1) break;
                                /* FALL THROUGH */
                        }

                        case WID_VR_REFIT: // refit button
                                if (this->auto_refit) {
                                        const Vehicle *v = Vehicle::Get(this->window_number);
                                        if (DoCommandP(v->tile, v->index | this->order << 24, this->cargo_mask, CMD_ORDER_REFIT)) this->Delete();
                                } else if (this->cargo != NULL) {
                                        const Vehicle *v = Vehicle::Get(this->window_number);

                                        if (this->order == INVALID_VEH_ORDER_ID) {
                                                bool delete_window = this->selected_vehicle == v->index && this->num_vehicles == UINT8_MAX;
                                                if (DoCommandP(v->tile, this->selected_vehicle, this->cargo->cargo | this->cargo->subtype << 8 | this->num_vehicles << 16, CMD_REFIT_VEHICLE) && delete_window) this->Delete();
                                        } else {
                                                if (DoCommandP(v->tile, v->index | this->order << 24, 1 << this->cargo->cargo, CMD_ORDER_REFIT)) this->Delete();
                                        }
                                }
                                break;

                        case WID_VR_CLEAR: // clear button
                                assert (this->auto_refit);
                                this->cargo_mask = 0;
                                this->InvalidateData (1);
                                break;
                }
        }

        virtual void OnMouseDrag(Point pt, int widget)
        {
                switch (widget) {
                        case WID_VR_VEHICLE_PANEL_DISPLAY: { // Vehicle image.
                                if (this->order != INVALID_VEH_ORDER_ID) break;
                                NWidgetBase *nwi = this->GetWidget<NWidgetBase>(WID_VR_VEHICLE_PANEL_DISPLAY);
                                this->SetSelectedVehicles(pt.x - nwi->pos_x);
                                this->SetWidgetDirty(WID_VR_VEHICLE_PANEL_DISPLAY);
                                break;
                        }
                }
        }

        virtual void OnDragDrop(Point pt, int widget)
        {
                switch (widget) {
                        case WID_VR_VEHICLE_PANEL_DISPLAY: { // Vehicle image.
                                if (this->order != INVALID_VEH_ORDER_ID) break;
                                NWidgetBase *nwi = this->GetWidget<NWidgetBase>(WID_VR_VEHICLE_PANEL_DISPLAY);
                                this->SetSelectedVehicles(pt.x - nwi->pos_x);
                                this->InvalidateData(2);
                                break;
                        }
                }
        }

        virtual void OnResize()
        {
                this->vehicle_width = this->GetVehicleWidth();
                this->vscroll->SetCapacityFromWidget(this, WID_VR_MATRIX);
                if (this->hscroll != NULL) this->hscroll->SetCapacityFromWidget(this, WID_VR_VEHICLE_PANEL_DISPLAY);
        }
};

/**
 * Get the width of a vehicle (part) in pixels.
 * @param v Vehicle to get the width for.
 * @return Width of the vehicle.
 */
static int GetSingleVehicleWidth (const Vehicle *v, EngineImageType image_type)
{
        switch (v->type) {
                case VEH_TRAIN:
                        return Train::From(v)->GetDisplayImageWidth();

                case VEH_ROAD:
                        return RoadVehicle::From(v)->GetDisplayImageWidth();

                default:
                        bool rtl = _current_text_dir == TD_RTL;
                        VehicleSpriteSeq seq;
                        v->GetImage (rtl ? DIR_E : DIR_W, image_type, &seq);
                        Rect rec;
                        seq.GetBounds(&rec);
                        return UnScaleGUI (rec.right - rec.left + 1);
        }
}

/**
 * Get the width of the vehicle (including all parts of the consist) in pixels.
 * @return Width of the vehicle.
 */
int RefitWindow::GetVehicleWidth (void) const
{
        const Vehicle *v = Vehicle::Get (this->window_number);

        if (v->type == VEH_TRAIN || v->type == VEH_ROAD) {
                int vehicle_width = 0;
                for (const Vehicle *u = v; u != NULL; u = u->Next()) {
                        vehicle_width += GetSingleVehicleWidth (u, EIT_IN_DETAILS);
                }
                return vehicle_width;
        } else {
                return GetSingleVehicleWidth (v, EIT_IN_DETAILS);
        }
}

static const NWidgetPart _nested_vehicle_refit_widgets[] = {
        NWidget(NWID_HORIZONTAL),
                NWidget(WWT_CLOSEBOX, COLOUR_GREY),
                NWidget(WWT_CAPTION, COLOUR_GREY, WID_VR_CAPTION), SetDataTip(STR_REFIT_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
                NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
        EndContainer(),
        /* Vehicle display + scrollbar. */
        NWidget(NWID_VERTICAL),
                NWidget(WWT_PANEL, COLOUR_GREY, WID_VR_VEHICLE_PANEL_DISPLAY), SetMinimalSize(228, 14), SetResize(1, 0), SetScrollbar(WID_VR_HSCROLLBAR), EndContainer(),
                NWidget(NWID_SELECTION, INVALID_COLOUR, WID_VR_SHOW_HSCROLLBAR),
                        NWidget(NWID_HSCROLLBAR, COLOUR_GREY, WID_VR_HSCROLLBAR),
                EndContainer(),
        EndContainer(),
        NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_VR_SELECT_HEADER), SetDataTip(STR_REFIT_TITLE, STR_NULL), SetResize(1, 0),
        /* Matrix + scrollbar. */
        NWidget(NWID_HORIZONTAL),
                NWidget(WWT_MATRIX, COLOUR_GREY, WID_VR_MATRIX), SetMinimalSize(228, 112), SetResize(1, 14), SetFill(1, 1), SetMatrixDataTip(1, 0, STR_NULL), SetScrollbar(WID_VR_SCROLLBAR),
                NWidget(NWID_VSCROLLBAR, COLOUR_GREY, WID_VR_SCROLLBAR),
        EndContainer(),
        NWidget(WWT_PANEL, COLOUR_GREY, WID_VR_INFO), SetMinimalTextLines(2, WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM), SetResize(1, 0), EndContainer(),
        NWidget(NWID_HORIZONTAL),
                NWidget(NWID_HORIZONTAL, NC_EQUALSIZE),
                        NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_VR_CLEAR), SetDataTip(STR_REFIT_CLEAR, STR_REFIT_CLEAR_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
                        NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_VR_REFIT), SetFill(1, 0), SetResize(1, 0),
                EndContainer(),
                NWidget(WWT_RESIZEBOX, COLOUR_GREY),
        EndContainer(),
};

static WindowDesc::Prefs _vehicle_refit_prefs ("view_vehicle_refit");

static const WindowDesc _vehicle_refit_desc(
        WDP_AUTO, 240, 174,
        WC_VEHICLE_REFIT, WC_VEHICLE_VIEW,
        WDF_CONSTRUCTION,
        _nested_vehicle_refit_widgets, lengthof(_nested_vehicle_refit_widgets),
        &_vehicle_refit_prefs
);

/**
 * Show the refit window for a vehicle
 * @param parent the parent window of the refit window
 * @param *v The vehicle to show the refit window for
 * @param order of the vehicle to assign refit to, or INVALID_VEH_ORDER_ID to refit the vehicle now
 * @param auto_refit Choose cargo for auto-refitting
 * @param mask Initial cargo mask of allowed refits for auto-refitting
 */
void ShowVehicleRefitWindow (Window *parent, const Vehicle *v,
        VehicleOrderID order, bool auto_refit, CargoMask mask)
{
        DeleteWindowById(WC_VEHICLE_REFIT, v->index);
        RefitWindow *w = new RefitWindow (&_vehicle_refit_desc, v, order,
                        auto_refit, mask);
        w->parent = parent;
}

/** Display list of cargo types of the engine, for the purchase information window */
uint ShowRefitOptionsList (BlitArea *dpi, int left, int right, int y, EngineID engine)
{
        /* List of cargo types of this engine */
        uint32 cmask = GetUnionOfArticulatedRefitMasks(engine, false);
        /* List of cargo types available in this climate */
        uint32 lmask = _cargo_mask;

        /* Draw nothing if the engine is not refittable */
        if (HasAtMostOneBit(cmask)) return y;

        if (cmask == lmask) {
                /* Engine can be refitted to all types in this climate */
                SetDParam(0, STR_PURCHASE_INFO_ALL_TYPES);
        } else {
                /* Check if we are able to refit to more cargo types and unable to. If
                 * so, invert the cargo types to list those that we can't refit to. */
                if (CountBits(cmask ^ lmask) < CountBits(cmask) && CountBits(cmask ^ lmask) <= 7) {
                        cmask ^= lmask;
                        SetDParam(0, STR_PURCHASE_INFO_ALL_BUT);
                } else {
                        SetDParam(0, STR_JUST_CARGO_LIST);
                }
                SetDParam(1, cmask);
        }

        return DrawStringMultiLine (dpi, left, right, y, INT32_MAX, STR_PURCHASE_INFO_REFITTABLE_TO);
}

/** Get the cargo subtype text from NewGRF for the vehicle details window. */
StringID GetCargoSubtypeText(const Vehicle *v)
{
        if (HasBit(EngInfo(v->engine_type)->callback_mask, CBM_VEHICLE_CARGO_SUFFIX)) {
                uint16 cb = GetVehicleCallback(CBID_VEHICLE_CARGO_SUFFIX, 0, 0, v->engine_type, v);
                if (cb != CALLBACK_FAILED) {
                        if (cb > 0x400) ErrorUnknownCallbackResult(v->GetGRFID(), CBID_VEHICLE_CARGO_SUFFIX, cb);
                        if (cb >= 0x400 || (v->GetGRF()->grf_version < 8 && cb == 0xFF)) cb = CALLBACK_FAILED;
                }
                if (cb != CALLBACK_FAILED) {
                        return GetGRFStringID(v->GetGRFID(), 0xD000 + cb);
                }
        }
        return STR_EMPTY;
}

/** Sort vehicles by their number */
static int CDECL VehicleNumberSorter(const Vehicle * const *a, const Vehicle * const *b)
{
        return (*a)->unitnumber - (*b)->unitnumber;
}

/** Sort vehicles by their name */
static int CDECL VehicleNameSorter(const Vehicle * const *a, const Vehicle * const *b)
{
        static char last_name[2][64];

        if (*a != _last_vehicle[0]) {
                _last_vehicle[0] = *a;
                SetDParam(0, (*a)->index);
                GetString (last_name[0], STR_VEHICLE_NAME);
        }

        if (*b != _last_vehicle[1]) {
                _last_vehicle[1] = *b;
                SetDParam(0, (*b)->index);
                GetString (last_name[1], STR_VEHICLE_NAME);
        }

        int r = strnatcmp(last_name[0], last_name[1]); // Sort by name (natural sorting).
        return (r != 0) ? r : VehicleNumberSorter(a, b);
}

/** Sort vehicles by their age */
static int CDECL VehicleAgeSorter(const Vehicle * const *a, const Vehicle * const *b)
{
        int r = (*a)->age - (*b)->age;
        return (r != 0) ? r : VehicleNumberSorter(a, b);
}

/** Sort vehicles by this year profit */
static int CDECL VehicleProfitThisYearSorter(const Vehicle * const *a, const Vehicle * const *b)
{
        int r = ClampToI32((*a)->GetDisplayProfitThisYear() - (*b)->GetDisplayProfitThisYear());
        return (r != 0) ? r : VehicleNumberSorter(a, b);
}

/** Sort vehicles by last year profit */
static int CDECL VehicleProfitLastYearSorter(const Vehicle * const *a, const Vehicle * const *b)
{
        int r = ClampToI32((*a)->GetDisplayProfitLastYear() - (*b)->GetDisplayProfitLastYear());
        return (r != 0) ? r : VehicleNumberSorter(a, b);
}

/** Sort vehicles by their cargo */
static int CDECL VehicleCargoSorter(const Vehicle * const *a, const Vehicle * const *b)
{
        const Vehicle *v;
        CargoArray diff;

        /* Append the cargo of the connected waggons */
        for (v = *a; v != NULL; v = v->Next()) diff[v->cargo_type] += v->cargo_cap;
        for (v = *b; v != NULL; v = v->Next()) diff[v->cargo_type] -= v->cargo_cap;

        int r = 0;
        for (CargoID i = 0; i < NUM_CARGO; i++) {
                r = diff[i];
                if (r != 0) break;
        }

        return (r != 0) ? r : VehicleNumberSorter(a, b);
}

/** Sort vehicles by their reliability */
static int CDECL VehicleReliabilitySorter(const Vehicle * const *a, const Vehicle * const *b)
{
        int r = (*a)->reliability - (*b)->reliability;
        return (r != 0) ? r : VehicleNumberSorter(a, b);
}

/** Sort vehicles by their max speed */
static int CDECL VehicleMaxSpeedSorter(const Vehicle * const *a, const Vehicle * const *b)
{
        int r = (*a)->vcache.cached_max_speed - (*b)->vcache.cached_max_speed;
        return (r != 0) ? r : VehicleNumberSorter(a, b);
}

/** Sort vehicles by model */
static int CDECL VehicleModelSorter(const Vehicle * const *a, const Vehicle * const *b)
{
        int r = (*a)->engine_type - (*b)->engine_type;
        return (r != 0) ? r : VehicleNumberSorter(a, b);
}

/** Sort vehicles by their value */
static int CDECL VehicleValueSorter(const Vehicle * const *a, const Vehicle * const *b)
{
        const Vehicle *u;
        Money diff = 0;

        for (u = *a; u != NULL; u = u->Next()) diff += u->value;
        for (u = *b; u != NULL; u = u->Next()) diff -= u->value;

        int r = ClampToI32(diff);
        return (r != 0) ? r : VehicleNumberSorter(a, b);
}

/** Sort vehicles by their length */
static int CDECL VehicleLengthSorter(const Vehicle * const *a, const Vehicle * const *b)
{
        int r = GroundVehicleBase::From(*a)->gcache.cached_total_length - GroundVehicleBase::From(*b)->gcache.cached_total_length;
        return (r != 0) ? r : VehicleNumberSorter(a, b);
}

/** Sort vehicles by the time they can still live */
static int CDECL VehicleTimeToLiveSorter(const Vehicle * const *a, const Vehicle * const *b)
{
        int r = ClampToI32(((*a)->max_age - (*a)->age) - ((*b)->max_age - (*b)->age));
        return (r != 0) ? r : VehicleNumberSorter(a, b);
}

/** Sort vehicles by the timetable delay */
static int CDECL VehicleTimetableDelaySorter(const Vehicle * const *a, const Vehicle * const *b)
{
        int r = (*a)->lateness_counter - (*b)->lateness_counter;
        return (r != 0) ? r : VehicleNumberSorter(a, b);
}

void InitializeGUI()
{
        MemSetT(&_sorting, 0);
}

/**
 * Assign a vehicle window a new vehicle
 * @param window_class WindowClass to search for
 * @param from_index the old vehicle ID
 * @param to_index the new vehicle ID
 */
static inline void ChangeVehicleWindow(WindowClass window_class, VehicleID from_index, VehicleID to_index)
{
        Window *w = FindWindowById(window_class, from_index);
        if (w != NULL) {
                /* Update window_number */
                w->window_number = to_index;
                if (w->viewport != NULL) w->viewport->follow_vehicle = to_index;

                /* Update vehicle drag data */
                if (_thd.window_class == window_class && _thd.window_number == (WindowNumber)from_index) {
                        _thd.window_number = to_index;
                }

                /* Notify the window. */
                w->InvalidateData(VIWD_AUTOREPLACE, false);
        }
}

/**
 * Report a change in vehicle IDs (due to autoreplace) to affected vehicle windows.
 * @param from_index the old vehicle ID
 * @param to_index the new vehicle ID
 */
void ChangeVehicleViewWindow(VehicleID from_index, VehicleID to_index)
{
        ChangeVehicleWindow(WC_VEHICLE_VIEW,      from_index, to_index);
        ChangeVehicleWindow(WC_VEHICLE_ORDERS,    from_index, to_index);
        ChangeVehicleWindow(WC_VEHICLE_REFIT,     from_index, to_index);
        ChangeVehicleWindow(WC_VEHICLE_DETAILS,   from_index, to_index);
        ChangeVehicleWindow(WC_VEHICLE_TIMETABLE, from_index, to_index);
}

static const NWidgetPart _nested_vehicle_list[] = {
        NWidget(NWID_HORIZONTAL),
                NWidget(WWT_CLOSEBOX, COLOUR_GREY),
                NWidget(WWT_CAPTION, COLOUR_GREY, WID_VL_CAPTION),
                NWidget(WWT_SHADEBOX, COLOUR_GREY),
                NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
                NWidget(WWT_STICKYBOX, COLOUR_GREY),
        EndContainer(),

        NWidget(NWID_HORIZONTAL),
                NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_VL_SORT_ORDER), SetMinimalSize(81, 12), SetFill(0, 1), SetDataTip(STR_BUTTON_SORT_BY, STR_TOOLTIP_SORT_ORDER),
                NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_VL_SORT_BY_PULLDOWN), SetMinimalSize(167, 12), SetFill(0, 1), SetDataTip(0x0, STR_TOOLTIP_SORT_CRITERIA),
                NWidget(WWT_PANEL, COLOUR_GREY), SetMinimalSize(12, 12), SetFill(1, 1), SetResize(1, 0),
                EndContainer(),
        EndContainer(),

        NWidget(NWID_HORIZONTAL),
                NWidget(WWT_MATRIX, COLOUR_GREY, WID_VL_LIST), SetMinimalSize(248, 0), SetFill(1, 0), SetResize(1, 1), SetMatrixDataTip(1, 0, STR_NULL), SetScrollbar(WID_VL_SCROLLBAR),
                NWidget(NWID_VSCROLLBAR, COLOUR_GREY, WID_VL_SCROLLBAR),
        EndContainer(),

        NWidget(NWID_HORIZONTAL),
                NWidget(NWID_SELECTION, INVALID_COLOUR, WID_VL_HIDE_BUTTONS),
                        NWidget(NWID_HORIZONTAL),
                                NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_VL_AVAILABLE_VEHICLES), SetMinimalSize(106, 12), SetFill(0, 1),
                                                                SetDataTip(STR_BLACK_STRING, STR_VEHICLE_LIST_AVAILABLE_ENGINES_TOOLTIP),
                                NWidget(WWT_PANEL, COLOUR_GREY), SetMinimalSize(0, 12), SetResize(1, 0), SetFill(1, 1), EndContainer(),
                                NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_VL_MANAGE_VEHICLES_DROPDOWN), SetMinimalSize(118, 12), SetFill(0, 1),
                                                                SetDataTip(STR_VEHICLE_LIST_MANAGE_LIST, STR_VEHICLE_LIST_MANAGE_LIST_TOOLTIP),
                                NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_VL_STOP_ALL), SetMinimalSize(12, 12), SetFill(0, 1),
                                                                SetDataTip(SPR_FLAG_VEH_STOPPED, STR_VEHICLE_LIST_MASS_STOP_LIST_TOOLTIP),
                                NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_VL_START_ALL), SetMinimalSize(12, 12), SetFill(0, 1),
                                                                SetDataTip(SPR_FLAG_VEH_RUNNING, STR_VEHICLE_LIST_MASS_START_LIST_TOOLTIP),
                        EndContainer(),
                        /* Widget to be shown for other companies hiding the previous 5 widgets. */
                        NWidget(WWT_PANEL, COLOUR_GREY), SetFill(1, 1), SetResize(1, 0), EndContainer(),
                EndContainer(),
                NWidget(WWT_RESIZEBOX, COLOUR_GREY),
        EndContainer(),
};

static void DrawSmallOrderList (const Vehicle *v, BlitArea *dpi,
        int left, int right, int y, VehicleOrderID start = 0)
{
        const Order *order = v->GetOrder(start);
        if (order == NULL) return;

        bool rtl = _current_text_dir == TD_RTL;
        int l_offset = rtl ? 0 : ScaleGUITrad(6);
        int r_offset = rtl ? ScaleGUITrad(6) : 0;
        int i = 0;
        VehicleOrderID oid = start;

        do {
                if (oid == v->cur_real_order_index) DrawString (dpi, left, right, y, STR_TINY_RIGHT_ARROW, TC_BLACK);

                if (order->IsType(OT_GOTO_STATION)) {
                        SetDParam(0, order->GetDestination());
                        DrawString (dpi, left + l_offset, right - r_offset, y, STR_TINY_BLACK_STATION);

                        y += FONT_HEIGHT_SMALL;
                        if (++i == 4) break;
                }

                oid++;
                order = order->next;
                if (order == NULL) {
                        order = v->orders.list->GetFirstOrder();
                        oid = 0;
                }
        } while (oid != start);
}

/**
 * Draws an image of a vehicle chain
 * @param v         Front vehicle
 * @param dpi       The area to draw on
 * @param left      The minimum horizontal position
 * @param right     The maximum horizontal position
 * @param y         Vertical position to draw at
 * @param image_type Draw this image type
 * @param skip      Number of pixels to skip at the front (for scrolling)
 * @param selection Selected vehicle to draw a frame around
 */
void DrawVehicleImage (const Vehicle *v, BlitArea *dpi, int left, int right,
        int y, EngineImageType image_type, int skip, VehicleID selection)
{
        switch (v->type) {
                case VEH_TRAIN:    DrawTrainImage (Train::From(v), dpi, left, right, y, selection, true, image_type, skip); break;
                case VEH_ROAD:     DrawRoadVehImage  (v, dpi, left, right, y, selection, image_type, skip); break;
                case VEH_SHIP:     DrawShipImage     (v, dpi, left, right, y, selection, image_type); break;
                case VEH_AIRCRAFT: DrawAircraftImage (v, dpi, left, right, y, selection, image_type); break;
                default: NOT_REACHED();
        }
}

/**
 * Get the height of a vehicle in the vehicle list GUIs.
 * @param type    the vehicle type to look at
 * @param divisor the resulting height must be dividable by this
 * @return the height
 */
uint GetVehicleListHeight(VehicleType type, uint divisor)
{
        /* Name + vehicle + profit */
        uint base = ScaleGUITrad(GetVehicleHeight(type)) + 2 * FONT_HEIGHT_SMALL;
        /* Drawing of the 4 small orders + profit*/
        if (type >= VEH_SHIP) base = max(base, 5U * FONT_HEIGHT_SMALL);

        if (divisor == 1) return base;

        /* Make sure the height is dividable by divisor */
        uint rem = base % divisor;
        return base + (rem == 0 ? 0 : divisor - rem);
}

/**
 * Draw all the vehicle list items.
 * @param dpi              The area to draw on.
 * @param selected_vehicle The vehicle that is to be highlighted.
 * @param line_height      Height of a single item line.
 * @param r                Rectangle with edge positions of the matrix widget.
 */
void BaseVehicleListWindow::DrawVehicleListItems (BlitArea *dpi,
        VehicleID selected_vehicle, int line_height, const Rect &r) const
{
        int left = r.left + WD_MATRIX_LEFT;
        int right = r.right - WD_MATRIX_RIGHT;
        int width = right - left;
        bool rtl = _current_text_dir == TD_RTL;

        int text_offset = max<int>(GetSpriteSize(SPR_PROFIT_LOT).width, GetDigitWidth() * this->unitnumber_digits) + WD_FRAMERECT_RIGHT;
        int text_left  = left  + (rtl ?           0 : text_offset);
        int text_right = right - (rtl ? text_offset :           0);

        bool show_orderlist = this->vli.vtype >= VEH_SHIP;
        int orderlist_left  = left  + (rtl ? 0 : max(ScaleGUITrad(100) + text_offset, width / 2));
        int orderlist_right = right - (rtl ? max(ScaleGUITrad(100) + text_offset, width / 2) : 0);

        int image_left  = (rtl && show_orderlist) ? orderlist_right : text_left;
        int image_right = (!rtl && show_orderlist) ? orderlist_left : text_right;

        int vehicle_button_x = rtl ? right - GetSpriteSize(SPR_PROFIT_LOT).width : left;

        int y = r.top;
        uint max = min(this->vscroll->GetPosition() + this->vscroll->GetCapacity(), this->vehicles.Length());
        for (uint i = this->vscroll->GetPosition(); i < max; ++i) {
                const Vehicle *v = this->vehicles[i];
                StringID str;

                SetDParam(0, v->GetDisplayProfitThisYear());
                SetDParam(1, v->GetDisplayProfitLastYear());

                DrawVehicleImage (v, dpi, image_left, image_right, y + FONT_HEIGHT_SMALL - 1, EIT_IN_LIST, 0, selected_vehicle);
                DrawString (dpi, text_left, text_right, y + line_height - FONT_HEIGHT_SMALL - WD_FRAMERECT_BOTTOM - 1, STR_VEHICLE_LIST_PROFIT_THIS_YEAR_LAST_YEAR);

                if (v->name != NULL) {
                        /* The vehicle got a name so we will print it */
                        SetDParam(0, v->index);
                        DrawString (dpi, text_left, text_right, y, STR_TINY_BLACK_VEHICLE);
                } else if (v->group_id != DEFAULT_GROUP) {
                        /* The vehicle has no name, but is member of a group, so print group name */
                        SetDParam(0, v->group_id);
                        DrawString (dpi, text_left, text_right, y, STR_TINY_GROUP, TC_BLACK);
                }

                if (show_orderlist) DrawSmallOrderList (v, dpi, orderlist_left, orderlist_right, y, v->cur_real_order_index);

                if (v->IsChainInDepot()) {
                        str = STR_BLUE_COMMA;
                } else {
                        str = (v->age > v->max_age - DAYS_IN_LEAP_YEAR) ? STR_RED_COMMA : STR_BLACK_COMMA;
                }

                SetDParam(0, v->unitnumber);
                DrawString (dpi, left, right, y + 2, str);

                /* Draw profit-based coloured icons. */
                DrawSprite (dpi,
                                (v->age <= VEHICLE_PROFIT_MIN_AGE) ? SPR_PROFIT_NA :
                                        (v->GetDisplayProfitLastYear() < 0) ? SPR_PROFIT_NEGATIVE :
                                        (v->GetDisplayProfitLastYear() < VEHICLE_PROFIT_THRESHOLD) ?
                                                SPR_PROFIT_SOME : SPR_PROFIT_LOT,
                                PAL_NONE, vehicle_button_x,
                                y + FONT_HEIGHT_NORMAL + 3);

                y += line_height;
        }
}

/**
 * Window for the (old) vehicle listing.
 *
 * bitmask for w->window_number
 * 0-7 CompanyID (owner)
 * 8-10 window type (use flags in vehicle_gui.h)
 * 11-15 vehicle type (using VEH_, but can be compressed to fewer bytes if needed)
 * 16-31 StationID or OrderID depending on window type (bit 8-10)
 */
struct VehicleListWindow : public BaseVehicleListWindow {
private:
        /** Enumeration of planes of the button row at the bottom. */
        enum ButtonPlanes {
                BP_SHOW_BUTTONS, ///< Show the buttons.
                BP_HIDE_BUTTONS, ///< Show the empty panel.
        };

public:
        VehicleListWindow (const WindowDesc *desc, WindowNumber window_number) : BaseVehicleListWindow(desc, window_number)
        {
                /* Set up sorting. Make the window-specific _sorting variable
                 * point to the correct global _sorting struct so we are freed
                 * from having conditionals during window operation */
                switch (this->vli.vtype) {
                        case VEH_TRAIN:    this->sorting = &_sorting.train; break;
                        case VEH_ROAD:     this->sorting = &_sorting.roadveh; break;
                        case VEH_SHIP:     this->sorting = &_sorting.ship; break;
                        case VEH_AIRCRAFT: this->sorting = &_sorting.aircraft; break;
                        default: NOT_REACHED();
                }

                this->CreateNestedTree();

                this->vscroll = this->GetScrollbar(WID_VL_SCROLLBAR);

                this->vehicles.SetListing(*this->sorting);
                this->vehicles.ForceRebuild();
                this->vehicles.NeedResort();
                this->BuildVehicleList();
                this->SortVehicleList();

                /* Set up the window widgets */
                this->GetWidget<NWidgetCore>(WID_VL_LIST)->tool_tip = STR_VEHICLE_LIST_TRAIN_LIST_TOOLTIP + this->vli.vtype;

                if (this->vli.type == VL_SHARED_ORDERS) {
                        this->GetWidget<NWidgetCore>(WID_VL_CAPTION)->widget_data = STR_VEHICLE_LIST_SHARED_ORDERS_LIST_CAPTION;
                } else {
                        this->GetWidget<NWidgetCore>(WID_VL_CAPTION)->widget_data = STR_VEHICLE_LIST_TRAIN_CAPTION + this->vli.vtype;
                }

                this->InitNested(window_number);
                if (this->vli.company != OWNER_NONE) this->owner = this->vli.company;
        }

        void OnDelete (void) FINAL_OVERRIDE
        {
                *this->sorting = this->vehicles.GetListing();
        }

        virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
        {
                switch (widget) {
                        case WID_VL_LIST:
                                resize->height = GetVehicleListHeight(this->vli.vtype, 1);

                                switch (this->vli.vtype) {
                                        case VEH_TRAIN:
                                        case VEH_ROAD:
                                                size->height = 6 * resize->height;
                                                break;
                                        case VEH_SHIP:
                                        case VEH_AIRCRAFT:
                                                size->height = 4 * resize->height;
                                                break;
                                        default: NOT_REACHED();
                                }
                                break;

                        case WID_VL_SORT_ORDER: {
                                Dimension d = GetStringBoundingBox(this->GetWidget<NWidgetCore>(widget)->widget_data);
                                d.width += padding.width + Window::SortButtonWidth() * 2; // Doubled since the string is centred and it also looks better.
                                d.height += padding.height;
                                *size = maxdim(*size, d);
                                break;
                        }

                        case WID_VL_MANAGE_VEHICLES_DROPDOWN: {
                                Dimension d = this->GetActionDropdownSize(this->vli.type == VL_STANDARD, false);
                                d.height += padding.height;
                                d.width  += padding.width;
                                *size = maxdim(*size, d);
                                break;
                        }
                }
        }

        virtual void SetStringParameters(int widget) const
        {
                switch (widget) {
                        case WID_VL_AVAILABLE_VEHICLES:
                                SetDParam(0, STR_VEHICLE_LIST_AVAILABLE_TRAINS + this->vli.vtype);
                                break;

                        case WID_VL_CAPTION: {
                                switch (this->vli.type) {
                                        case VL_SHARED_ORDERS: // Shared Orders
                                                if (this->vehicles.Length() == 0) {
                                                        /* We can't open this window without vehicles using this order
                                                         * and we should close the window when deleting the order. */
                                                        NOT_REACHED();
                                                }
                                                SetDParam(0, this->vscroll->GetCount());
                                                break;

                                        case VL_STANDARD: // Company Name
                                                SetDParam(0, STR_COMPANY_NAME);
                                                SetDParam(1, this->vli.index);
                                                SetDParam(3, this->vscroll->GetCount());
                                                break;

                                        case VL_STATION_LIST: // Station/Waypoint Name
                                                SetDParam(0, BaseStation::Get(this->vli.index)->IsWaypoint() ? STR_WAYPOINT_NAME : STR_STATION_NAME);
                                                SetDParam(1, this->vli.index);
                                                SetDParam(3, this->vscroll->GetCount());
                                                break;

                                        case VL_DEPOT_LIST:
                                                SetDParam(0, STR_DEPOT_CAPTION);
                                                SetDParam(1, this->vli.vtype);
                                                SetDParam(2, this->vli.index);
                                                SetDParam(3, this->vscroll->GetCount());
                                                break;
                                        default: NOT_REACHED();
                                }
                                break;
                        }
                }
        }

        void DrawWidget (BlitArea *dpi, const Rect &r, int widget) const OVERRIDE
        {
                switch (widget) {
                        case WID_VL_SORT_ORDER:
                                /* draw arrow pointing up/down for ascending/descending sorting */
                                this->DrawSortButtonState (dpi, widget, this->vehicles.IsDescSortOrder() ? SBS_DOWN : SBS_UP);
                                break;

                        case WID_VL_LIST:
                                this->DrawVehicleListItems (dpi, INVALID_VEHICLE, this->resize.step_height, r);
                                break;
                }
        }

        void OnPaint (BlitArea *dpi) OVERRIDE
        {
                this->BuildVehicleList();
                this->SortVehicleList();

                if (this->vehicles.Length() == 0 && this->IsWidgetLowered(WID_VL_MANAGE_VEHICLES_DROPDOWN)) {
                        HideDropDownMenu(this);
                }

                /* Hide the widgets that we will not use in this window
                 * Some windows contains actions only fit for the owner */
                int plane_to_show = (this->owner == _local_company) ? BP_SHOW_BUTTONS : BP_HIDE_BUTTONS;
                NWidgetStacked *nwi = this->GetWidget<NWidgetStacked>(WID_VL_HIDE_BUTTONS);
                if (plane_to_show != nwi->shown_plane) {
                        nwi->SetDisplayedPlane(plane_to_show);
                        nwi->SetDirty(this);
                }
                if (this->owner == _local_company) {
                        this->SetWidgetDisabledState(WID_VL_AVAILABLE_VEHICLES, this->vli.type != VL_STANDARD);
                        this->SetWidgetsDisabledState(this->vehicles.Length() == 0,
                                WID_VL_MANAGE_VEHICLES_DROPDOWN,
                                WID_VL_STOP_ALL,
                                WID_VL_START_ALL,
                                WIDGET_LIST_END);
                }

                /* Set text of sort by dropdown widget. */
                this->GetWidget<NWidgetCore>(WID_VL_SORT_BY_PULLDOWN)->widget_data = this->vehicle_sorter_names[this->vehicles.SortType()];

                this->DrawWidgets (dpi);
        }

        virtual void OnClick(Point pt, int widget, int click_count)
        {
                switch (widget) {
                        case WID_VL_SORT_ORDER: // Flip sorting method ascending/descending
                                this->vehicles.ToggleSortOrder();
                                this->SetDirty();
                                break;

                        case WID_VL_SORT_BY_PULLDOWN:// Select sorting criteria dropdown menu
                                ShowDropDownMenu(this, this->vehicle_sorter_names, this->vehicles.SortType(), WID_VL_SORT_BY_PULLDOWN, 0,
                                                (this->vli.vtype == VEH_TRAIN || this->vli.vtype == VEH_ROAD) ? 0 : (1 << 10));
                                return;

                        case WID_VL_LIST: { // Matrix to show vehicles
                                uint id_v = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_VL_LIST);
                                if (id_v >= this->vehicles.Length()) return; // click out of list bound

                                const Vehicle *v = this->vehicles[id_v];
                                if (!VehicleClicked(v)) ShowVehicleViewWindow(v);
                                break;
                        }

                        case WID_VL_AVAILABLE_VEHICLES:
                                ShowBuildVehicleWindow(INVALID_TILE, this->vli.vtype);
                                break;

                        case WID_VL_MANAGE_VEHICLES_DROPDOWN: {
                                DropDownList *list = this->BuildActionDropdownList(VehicleListIdentifier::UnPack(this->window_number).type == VL_STANDARD, false);
                                ShowDropDownList(this, list, 0, WID_VL_MANAGE_VEHICLES_DROPDOWN);
                                break;
                        }

                        case WID_VL_STOP_ALL:
                        case WID_VL_START_ALL:
                                DoCommandP(0, (1 << 1) | (widget == WID_VL_START_ALL ? (1 << 0) : 0), this->window_number, CMD_MASS_START_STOP);
                                break;
                }
        }

        virtual void OnDropdownSelect(int widget, int index)
        {
                switch (widget) {
                        case WID_VL_SORT_BY_PULLDOWN:
                                this->vehicles.SetSortType(index);
                                break;
                        case WID_VL_MANAGE_VEHICLES_DROPDOWN:
                                assert(this->vehicles.Length() != 0);

                                switch (index) {
                                        case ADI_REPLACE: // Replace window
                                                ShowReplaceGroupVehicleWindow(ALL_GROUP, this->vli.vtype);
                                                break;
                                        case ADI_SERVICE: // Send for servicing
                                        case ADI_DEPOT: // Send to Depots
                                                DoCommandP(0, DEPOT_MASS_SEND | (index == ADI_SERVICE ? DEPOT_SERVICE : (DepotCommand)0), this->window_number, CMD_SEND_VEHICLE_TO_DEPOT);
                                                break;

                                        default: NOT_REACHED();
                                }
                                break;
                        default: NOT_REACHED();
                }
                this->SetDirty();
        }

        virtual void OnTick()
        {
                if (_pause_mode != PM_UNPAUSED) return;
                if (this->vehicles.NeedResort()) {
                        StationID station = (this->vli.type == VL_STATION_LIST) ? this->vli.index : INVALID_STATION;

                        DEBUG(misc, 3, "Periodic resort %d list company %d at station %d", this->vli.vtype, this->owner, station);
                        this->SetDirty();
                }
        }

        virtual void OnResize()
        {
                this->vscroll->SetCapacityFromWidget(this, WID_VL_LIST);
        }

        /**
         * Some data on this window has become invalid.
         * @param data Information about the changed data.
         * @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.
         */
        virtual void OnInvalidateData(int data = 0, bool gui_scope = true)
        {
                if (!gui_scope && HasBit(data, 31) && this->vli.type == VL_SHARED_ORDERS) {
                        /* Needs to be done in command-scope, so everything stays valid */
                        this->vli.index = GB(data, 0, 20);
                        this->window_number = this->vli.Pack();
                        this->vehicles.ForceRebuild();
                        return;
                }

                if (data == 0) {
                        /* This needs to be done in command-scope to enforce rebuilding before resorting invalid data */
                        this->vehicles.ForceRebuild();
                } else {
                        this->vehicles.ForceResort();
                }
        }
};

static WindowDesc::Prefs _vehicle_list_other_prefs ("list_vehicles");

static WindowDesc::Prefs _vehicle_list_train_prefs ("list_vehicles_train");

static const WindowDesc _vehicle_list_train_desc(
        WDP_AUTO, 325, 246,
        WC_TRAINS_LIST, WC_NONE,
        0,
        _nested_vehicle_list, lengthof(_nested_vehicle_list),
        &_vehicle_list_train_prefs
);

static const WindowDesc _vehicle_list_roadveh_desc(
        WDP_AUTO, 260, 246,
        WC_ROADVEH_LIST, WC_NONE,
        0,
        _nested_vehicle_list, lengthof(_nested_vehicle_list),
        &_vehicle_list_other_prefs
);

static const WindowDesc _vehicle_list_ship_desc(
        WDP_AUTO, 260, 246,
        WC_SHIPS_LIST, WC_NONE,
        0,
        _nested_vehicle_list, lengthof(_nested_vehicle_list),
        &_vehicle_list_other_prefs
);

static const WindowDesc _vehicle_list_aircraft_desc(
        WDP_AUTO, 260, 246,
        WC_AIRCRAFT_LIST, WC_NONE,
        0,
        _nested_vehicle_list, lengthof(_nested_vehicle_list),
        &_vehicle_list_other_prefs
);

static void ShowVehicleListWindowLocal(CompanyID company, VehicleListType vlt, VehicleType vehicle_type, uint32 unique_number)
{
        static const WindowDesc *const descs[VEH_COMPANY_END] = {
                &_vehicle_list_train_desc,      // VEH_TRAIN
                &_vehicle_list_roadveh_desc,    // VEH_ROAD
                &_vehicle_list_ship_desc,       // VEH_SHIP
                &_vehicle_list_aircraft_desc,   // VEH_AIRCRAFT
        };

        if (!Company::IsValidID(company) && company != OWNER_NONE) return;

        WindowNumber num = VehicleListIdentifier(vlt, vehicle_type, company, unique_number).Pack();
        AllocateWindowDescFront<VehicleListWindow> (descs[vehicle_type], num);
}

void ShowVehicleListWindow(CompanyID company, VehicleType vehicle_type)
{
        /* If _settings_client.gui.advanced_vehicle_list > 1, display the Advanced list
         * if _settings_client.gui.advanced_vehicle_list == 1, display Advanced list only for local company
         * if _ctrl_pressed, do the opposite action (Advanced list x Normal list)
         */

        if ((_settings_client.gui.advanced_vehicle_list > (uint)(company != _local_company)) != _ctrl_pressed) {
                ShowCompanyGroup(company, vehicle_type);
        } else {
                ShowVehicleListWindowLocal(company, VL_STANDARD, vehicle_type, company);
        }
}

void ShowVehicleListWindow(const Vehicle *v)
{
        ShowVehicleListWindowLocal(v->owner, VL_SHARED_ORDERS, v->type, v->FirstShared()->index);
}

void ShowVehicleListWindow(CompanyID company, VehicleType vehicle_type, StationID station)
{
        ShowVehicleListWindowLocal(company, VL_STATION_LIST, vehicle_type, station);
}

void ShowVehicleListWindow(CompanyID company, VehicleType vehicle_type, TileIndex depot_tile)
{
        uint16 depot_airport_index;

        if (vehicle_type == VEH_AIRCRAFT) {
                depot_airport_index = GetStationIndex(depot_tile);
        } else {
                depot_airport_index = GetDepotIndex(depot_tile);
        }
        ShowVehicleListWindowLocal(company, VL_DEPOT_LIST, vehicle_type, depot_airport_index);
}


/* Unified vehicle GUI - Vehicle Details Window */

assert_compile(WID_VD_DETAILS_CARGO_CARRIED    == WID_VD_DETAILS_CARGO_CARRIED + TDW_TAB_CARGO   );
assert_compile(WID_VD_DETAILS_TRAIN_VEHICLES   == WID_VD_DETAILS_CARGO_CARRIED + TDW_TAB_INFO    );
assert_compile(WID_VD_DETAILS_CAPACITY_OF_EACH == WID_VD_DETAILS_CARGO_CARRIED + TDW_TAB_CAPACITY);
assert_compile(WID_VD_DETAILS_TOTAL_CARGO      == WID_VD_DETAILS_CARGO_CARRIED + TDW_TAB_TOTALS  );

/** Vehicle details widgets (other than train). */
static const NWidgetPart _nested_nontrain_vehicle_details_widgets[] = {
        NWidget(NWID_HORIZONTAL),
                NWidget(WWT_CLOSEBOX, COLOUR_GREY),
                NWidget(WWT_CAPTION, COLOUR_GREY, WID_VD_CAPTION), SetDataTip(STR_VEHICLE_DETAILS_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
                NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_VD_RENAME_VEHICLE), SetMinimalSize(40, 0), SetMinimalTextLines(1, WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM + 2), SetDataTip(STR_VEHICLE_NAME_BUTTON, STR_NULL /* filled in later */),
                NWidget(WWT_SHADEBOX, COLOUR_GREY),
                NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
                NWidget(WWT_STICKYBOX, COLOUR_GREY),
        EndContainer(),
        NWidget(WWT_PANEL, COLOUR_GREY, WID_VD_TOP_DETAILS), SetMinimalSize(405, 42), SetResize(1, 0), EndContainer(),
        NWidget(WWT_PANEL, COLOUR_GREY, WID_VD_MIDDLE_DETAILS), SetMinimalSize(405, 45), SetResize(1, 0), EndContainer(),
        NWidget(NWID_HORIZONTAL),
                NWidget(WWT_PUSHARROWBTN, COLOUR_GREY, WID_VD_DECREASE_SERVICING_INTERVAL), SetFill(0, 1),
                                SetDataTip(AWV_DECREASE, STR_VEHICLE_DETAILS_DECREASE_SERVICING_INTERVAL_TOOLTIP),
                NWidget(WWT_PUSHARROWBTN, COLOUR_GREY, WID_VD_INCREASE_SERVICING_INTERVAL), SetFill(0, 1),
                                SetDataTip(AWV_INCREASE, STR_VEHICLE_DETAILS_INCREASE_SERVICING_INTERVAL_TOOLTIP),
                NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_VD_SERVICE_INTERVAL_DROPDOWN), SetFill(0, 1),
                                SetDataTip(STR_EMPTY, STR_SERVICE_INTERVAL_DROPDOWN_TOOLTIP),
                NWidget(WWT_PANEL, COLOUR_GREY, WID_VD_SERVICING_INTERVAL), SetFill(1, 1), SetResize(1, 0), EndContainer(),
                NWidget(WWT_RESIZEBOX, COLOUR_GREY),
        EndContainer(),
};

/** Train details widgets. */
static const NWidgetPart _nested_train_vehicle_details_widgets[] = {
        NWidget(NWID_HORIZONTAL),
                NWidget(WWT_CLOSEBOX, COLOUR_GREY),
                NWidget(WWT_CAPTION, COLOUR_GREY, WID_VD_CAPTION), SetDataTip(STR_VEHICLE_DETAILS_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
                NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_VD_RENAME_VEHICLE), SetMinimalSize(40, 0), SetMinimalTextLines(1, WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM + 2), SetDataTip(STR_VEHICLE_NAME_BUTTON, STR_NULL /* filled in later */),
                NWidget(WWT_SHADEBOX, COLOUR_GREY),
                NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
                NWidget(WWT_STICKYBOX, COLOUR_GREY),
        EndContainer(),
        NWidget(WWT_PANEL, COLOUR_GREY, WID_VD_TOP_DETAILS), SetResize(1, 0), SetMinimalSize(405, 42), EndContainer(),
        NWidget(NWID_HORIZONTAL),
                NWidget(WWT_MATRIX, COLOUR_GREY, WID_VD_MATRIX), SetResize(1, 1), SetMinimalSize(393, 45), SetMatrixDataTip(1, 0, STR_NULL), SetFill(1, 0), SetScrollbar(WID_VD_SCROLLBAR),
                NWidget(NWID_VSCROLLBAR, COLOUR_GREY, WID_VD_SCROLLBAR),
        EndContainer(),
        NWidget(NWID_HORIZONTAL),
                NWidget(WWT_PUSHARROWBTN, COLOUR_GREY, WID_VD_DECREASE_SERVICING_INTERVAL), SetFill(0, 1),
                                SetDataTip(AWV_DECREASE, STR_VEHICLE_DETAILS_DECREASE_SERVICING_INTERVAL_TOOLTIP),
                NWidget(WWT_PUSHARROWBTN, COLOUR_GREY, WID_VD_INCREASE_SERVICING_INTERVAL), SetFill(0, 1),
                                SetDataTip(AWV_INCREASE, STR_VEHICLE_DETAILS_DECREASE_SERVICING_INTERVAL_TOOLTIP),
                NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_VD_SERVICE_INTERVAL_DROPDOWN), SetFill(0, 1),
                                SetDataTip(STR_EMPTY, STR_SERVICE_INTERVAL_DROPDOWN_TOOLTIP),
                NWidget(WWT_PANEL, COLOUR_GREY, WID_VD_SERVICING_INTERVAL), SetFill(1, 1), SetResize(1, 0), EndContainer(),
        EndContainer(),
        NWidget(NWID_HORIZONTAL),
                NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_VD_DETAILS_CARGO_CARRIED), SetMinimalSize(96, 12),
                                SetDataTip(STR_VEHICLE_DETAIL_TAB_CARGO, STR_VEHICLE_DETAILS_TRAIN_CARGO_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
                NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_VD_DETAILS_TRAIN_VEHICLES), SetMinimalSize(99, 12),
                                SetDataTip(STR_VEHICLE_DETAIL_TAB_INFORMATION, STR_VEHICLE_DETAILS_TRAIN_INFORMATION_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
                NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_VD_DETAILS_CAPACITY_OF_EACH), SetMinimalSize(99, 12),
                                SetDataTip(STR_VEHICLE_DETAIL_TAB_CAPACITIES, STR_VEHICLE_DETAILS_TRAIN_CAPACITIES_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
                NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_VD_DETAILS_TOTAL_CARGO), SetMinimalSize(99, 12),
                                SetDataTip(STR_VEHICLE_DETAIL_TAB_TOTAL_CARGO, STR_VEHICLE_DETAILS_TRAIN_TOTAL_CARGO_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
                NWidget(WWT_RESIZEBOX, COLOUR_GREY),
        EndContainer(),
};


extern int GetTrainDetailsWndVScroll(VehicleID veh_id, TrainDetailsWindowTabs det_tab);
extern void DrawTrainDetails (const Train *v, BlitArea *dpi, int left, int right, int y, int vscroll_pos, uint16 vscroll_cap, TrainDetailsWindowTabs det_tab);
extern void DrawRoadVehDetails (const Vehicle *v, BlitArea *dpi, int left, int right, int y);
extern void DrawShipDetails (const Vehicle *v, BlitArea *dpi, int left, int right, int y);
extern void DrawAircraftDetails (const Aircraft *v, BlitArea *dpi, int left, int right, int y);

static StringID _service_interval_dropdown[] = {
        STR_VEHICLE_DETAILS_DEFAULT,
        STR_VEHICLE_DETAILS_DAYS,
        STR_VEHICLE_DETAILS_PERCENT,
        INVALID_STRING_ID,
};

/** Class for managing the vehicle details window. */
struct VehicleDetailsWindow : Window {
        TrainDetailsWindowTabs tab; ///< For train vehicles: which tab is displayed.
        Scrollbar *vscroll;

        /** Initialize a newly created vehicle details window */
        VehicleDetailsWindow (const WindowDesc *desc, WindowNumber window_number) :
                Window (desc), tab (TDW_TAB_CARGO), vscroll (NULL)
        {
                const Vehicle *v = Vehicle::Get(window_number);

                this->CreateNestedTree();
                this->vscroll = (v->type == VEH_TRAIN ? this->GetScrollbar(WID_VD_SCROLLBAR) : NULL);
                this->InitNested(window_number);

                this->GetWidget<NWidgetCore>(WID_VD_RENAME_VEHICLE)->tool_tip = STR_VEHICLE_DETAILS_TRAIN_RENAME + v->type;

                this->owner = v->owner;
        }

        /**
         * Some data on this window has become invalid.
         * @param data Information about the changed data.
         * @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.
         */
        virtual void OnInvalidateData(int data = 0, bool gui_scope = true)
        {
                if (data == VIWD_AUTOREPLACE) {
                        /* Autoreplace replaced the vehicle.
                         * Nothing to do for this window. */
                        return;
                }
                if (!gui_scope) return;
                const Vehicle *v = Vehicle::Get(this->window_number);
                if (v->type == VEH_ROAD) {
                        const NWidgetBase *nwid_info = this->GetWidget<NWidgetBase>(WID_VD_MIDDLE_DETAILS);
                        uint aimed_height = this->GetRoadVehDetailsHeight(v);
                        /* If the number of articulated parts changes, the size of the window must change too. */
                        if (aimed_height != nwid_info->current_y) {
                                this->ReInit();
                        }
                }
        }

        /**
         * Gets the desired height for the road vehicle details panel.
         * @param v Road vehicle being shown.
         * @return Desired height in pixels.
         */
        uint GetRoadVehDetailsHeight(const Vehicle *v)
        {
                uint desired_height;
                if (v->HasArticulatedPart()) {
                        /* An articulated RV has its text drawn under the sprite instead of after it, hence 15 pixels extra. */
                        desired_height = WD_FRAMERECT_TOP + ScaleGUITrad(15) + 3 * FONT_HEIGHT_NORMAL + 2 + WD_FRAMERECT_BOTTOM;
                        /* Add space for the cargo amount for each part. */
                        for (const Vehicle *u = v; u != NULL; u = u->Next()) {
                                if (u->cargo_cap != 0) desired_height += FONT_HEIGHT_NORMAL + 1;
                        }
                } else {
                        desired_height = WD_FRAMERECT_TOP + 4 * FONT_HEIGHT_NORMAL + 3 + WD_FRAMERECT_BOTTOM;
                }
                return desired_height;
        }

        virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
        {
                switch (widget) {
                        case WID_VD_TOP_DETAILS: {
                                Dimension dim = { 0, 0 };
                                size->height = WD_FRAMERECT_TOP + 4 * FONT_HEIGHT_NORMAL + WD_FRAMERECT_BOTTOM;

                                for (uint i = 0; i < 4; i++) SetDParamMaxValue(i, INT16_MAX);
                                static const StringID info_strings[] = {
                                        STR_VEHICLE_INFO_MAX_SPEED,
                                        STR_VEHICLE_INFO_WEIGHT_POWER_MAX_SPEED,
                                        STR_VEHICLE_INFO_WEIGHT_POWER_MAX_SPEED_MAX_TE,
                                        STR_VEHICLE_INFO_PROFIT_THIS_YEAR_LAST_YEAR,
                                        STR_VEHICLE_INFO_RELIABILITY_BREAKDOWNS
                                };
                                for (uint i = 0; i < lengthof(info_strings); i++) {
                                        dim = maxdim(dim, GetStringBoundingBox(info_strings[i]));
                                }
                                SetDParam(0, STR_VEHICLE_INFO_AGE);
                                dim = maxdim(dim, GetStringBoundingBox(STR_VEHICLE_INFO_AGE_RUNNING_COST_YR));
                                size->width = dim.width + WD_FRAMERECT_LEFT + WD_FRAMERECT_RIGHT;
                                break;
                        }

                        case WID_VD_MIDDLE_DETAILS: {
                                const Vehicle *v = Vehicle::Get(this->window_number);
                                switch (v->type) {
                                        case VEH_ROAD:
                                                size->height = this->GetRoadVehDetailsHeight(v);
                                                break;

                                        case VEH_SHIP:
                                                size->height = WD_FRAMERECT_TOP + 4 * FONT_HEIGHT_NORMAL + 3 + WD_FRAMERECT_BOTTOM;
                                                break;

                                        case VEH_AIRCRAFT:
                                                size->height = WD_FRAMERECT_TOP + 5 * FONT_HEIGHT_NORMAL + 4 + WD_FRAMERECT_BOTTOM;
                                                break;

                                        default:
                                                NOT_REACHED(); // Train uses WID_VD_MATRIX instead.
                                }
                                break;
                        }

                        case WID_VD_MATRIX:
                                resize->height = max(ScaleGUITrad(14), WD_MATRIX_TOP + FONT_HEIGHT_NORMAL + WD_MATRIX_BOTTOM);
                                size->height = 4 * resize->height;
                                break;

                        case WID_VD_SERVICE_INTERVAL_DROPDOWN: {
                                StringID *strs = _service_interval_dropdown;
                                while (*strs != INVALID_STRING_ID) {
                                        *size = maxdim(*size, GetStringBoundingBox(*strs++));
                                }
                                size->width += padding.width;
                                size->height = FONT_HEIGHT_NORMAL + WD_DROPDOWNTEXT_TOP + WD_DROPDOWNTEXT_BOTTOM;
                                break;
                        }

                        case WID_VD_SERVICING_INTERVAL:
                                SetDParamMaxValue(0, MAX_SERVINT_DAYS); // Roughly the maximum interval
                                SetDParamMaxValue(1, MAX_YEAR * DAYS_IN_YEAR); // Roughly the maximum year
                                size->width = max(GetStringBoundingBox(STR_VEHICLE_DETAILS_SERVICING_INTERVAL_PERCENT).width, GetStringBoundingBox(STR_VEHICLE_DETAILS_SERVICING_INTERVAL_DAYS).width) + WD_FRAMERECT_LEFT + WD_FRAMERECT_RIGHT;
                                size->height = WD_FRAMERECT_TOP + FONT_HEIGHT_NORMAL + WD_FRAMERECT_BOTTOM;
                                break;
                }
        }

        /** Checks whether service interval is enabled for the vehicle. */
        static bool IsVehicleServiceIntervalEnabled(const VehicleType vehicle_type, CompanyID company_id)
        {
                const VehicleDefaultSettings *vds = &Company::Get(company_id)->settings.vehicle;
                switch (vehicle_type) {
                        default: NOT_REACHED();
                        case VEH_TRAIN:    return vds->servint_trains   != 0;
                        case VEH_ROAD:     return vds->servint_roadveh  != 0;
                        case VEH_SHIP:     return vds->servint_ships    != 0;
                        case VEH_AIRCRAFT: return vds->servint_aircraft != 0;
                }
        }

        /**
         * Draw the details for the given vehicle at the position of the Details windows
         *
         * @param v     current vehicle
         * @param dpi   The area to draw on
         * @param left  The left most coordinate to draw
         * @param right The right most coordinate to draw
         * @param y     The y coordinate
         * @param vscroll_pos Position of scrollbar (train only)
         * @param vscroll_cap Number of lines currently displayed (train only)
         * @param det_tab Selected details tab (train only)
         */
        static void DrawVehicleDetails (const Vehicle *v, BlitArea *dpi, int left, int right, int y, int vscroll_pos, uint vscroll_cap, TrainDetailsWindowTabs det_tab)
        {
                switch (v->type) {
                        case VEH_TRAIN:    DrawTrainDetails (Train::From(v), dpi, left, right, y, vscroll_pos, vscroll_cap, det_tab); break;
                        case VEH_ROAD:     DrawRoadVehDetails (v, dpi, left, right, y); break;
                        case VEH_SHIP:     DrawShipDetails (v, dpi, left, right, y); break;
                        case VEH_AIRCRAFT: DrawAircraftDetails (Aircraft::From(v), dpi, left, right, y); break;
                        default: NOT_REACHED();
                }
        }

        virtual void SetStringParameters(int widget) const
        {
                if (widget == WID_VD_CAPTION) SetDParam(0, Vehicle::Get(this->window_number)->index);
        }

        void DrawWidget (BlitArea *dpi, const Rect &r, int widget) const OVERRIDE
        {
                const Vehicle *v = Vehicle::Get(this->window_number);

                switch (widget) {
                        case WID_VD_TOP_DETAILS: {
                                int y = r.top + WD_FRAMERECT_TOP;

                                /* Draw running cost */
                                SetDParam(1, v->age / DAYS_IN_LEAP_YEAR);
                                SetDParam(0, (v->age + DAYS_IN_YEAR < v->max_age) ? STR_VEHICLE_INFO_AGE : STR_VEHICLE_INFO_AGE_RED);
                                SetDParam(2, v->max_age / DAYS_IN_LEAP_YEAR);
                                SetDParam(3, v->GetDisplayRunningCost());
                                DrawString (dpi, r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, STR_VEHICLE_INFO_AGE_RUNNING_COST_YR);
                                y += FONT_HEIGHT_NORMAL;

                                /* Draw max speed */
                                StringID string;
                                if (v->type == VEH_TRAIN ||
                                                (v->type == VEH_ROAD && _settings_game.vehicle.roadveh_acceleration_model != AM_ORIGINAL)) {
                                        const GroundVehicleCache *gcache = &GroundVehicleBase::From(v)->gcache;
                                        SetDParam(2, v->GetDisplayMaxSpeed());
                                        SetDParam(1, gcache->cached_power);
                                        SetDParam(0, gcache->cached_weight);
                                        SetDParam(3, gcache->cached_max_te / 1000);
                                        if (v->type == VEH_TRAIN && (_settings_game.vehicle.train_acceleration_model == AM_ORIGINAL ||
                                                        GetRailTypeInfo(Train::From(v)->railtype)->acceleration_type == 2)) {
                                                string = STR_VEHICLE_INFO_WEIGHT_POWER_MAX_SPEED;
                                        } else {
                                                string = STR_VEHICLE_INFO_WEIGHT_POWER_MAX_SPEED_MAX_TE;
                                        }
                                } else {
                                        SetDParam(0, v->GetDisplayMaxSpeed());
                                        if (v->type == VEH_AIRCRAFT && Aircraft::From(v)->GetRange() > 0) {
                                                SetDParam(1, Aircraft::From(v)->GetRange());
                                                string = STR_VEHICLE_INFO_MAX_SPEED_RANGE;
                                        } else {
                                                string = STR_VEHICLE_INFO_MAX_SPEED;
                                        }
                                }
                                DrawString (dpi, r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, string);
                                y += FONT_HEIGHT_NORMAL;

                                /* Draw profit */
                                SetDParam(0, v->GetDisplayProfitThisYear());
                                SetDParam(1, v->GetDisplayProfitLastYear());
                                DrawString (dpi, r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, STR_VEHICLE_INFO_PROFIT_THIS_YEAR_LAST_YEAR);
                                y += FONT_HEIGHT_NORMAL;

                                /* Draw breakdown & reliability */
                                SetDParam(0, ToPercent16(v->reliability));
                                SetDParam(1, v->breakdowns_since_last_service);
                                DrawString (dpi, r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, STR_VEHICLE_INFO_RELIABILITY_BREAKDOWNS);
                                break;
                        }

                        case WID_VD_MATRIX:
                                /* For trains only. */
                                DrawVehicleDetails (v, dpi, r.left + WD_MATRIX_LEFT, r.right - WD_MATRIX_RIGHT, r.top + WD_MATRIX_TOP, this->vscroll->GetPosition(), this->vscroll->GetCapacity(), this->tab);
                                break;

                        case WID_VD_MIDDLE_DETAILS: {
                                /* For other vehicles, at the place of the matrix. */
                                bool rtl = _current_text_dir == TD_RTL;
                                uint sprite_width = GetSingleVehicleWidth(v, EIT_IN_DETAILS) + WD_FRAMERECT_LEFT + WD_FRAMERECT_RIGHT;

                                uint text_left  = r.left  + (rtl ? 0 : sprite_width);
                                uint text_right = r.right - (rtl ? sprite_width : 0);

                                /* Articulated road vehicles use a complete line. */
                                if (v->type == VEH_ROAD && v->HasArticulatedPart()) {
                                        DrawVehicleImage (v, dpi, r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, r.top + WD_FRAMERECT_TOP, EIT_IN_DETAILS);
                                } else {
                                        uint sprite_left  = rtl ? text_right : r.left;
                                        uint sprite_right = rtl ? r.right : text_left;

                                        DrawVehicleImage (v, dpi, sprite_left + WD_FRAMERECT_LEFT, sprite_right - WD_FRAMERECT_RIGHT, r.top + WD_FRAMERECT_TOP, EIT_IN_DETAILS);
                                }
                                DrawVehicleDetails (v, dpi, text_left + WD_FRAMERECT_LEFT, text_right - WD_FRAMERECT_RIGHT, r.top + WD_FRAMERECT_TOP, 0, 0, this->tab);
                                break;
                        }

                        case WID_VD_SERVICING_INTERVAL:
                                /* Draw service interval text */
                                SetDParam(0, v->GetServiceInterval());
                                SetDParam(1, v->date_of_last_service);
                                DrawString (dpi, r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, r.top + (r.bottom - r.top + 1 - FONT_HEIGHT_NORMAL) / 2,
                                                v->ServiceIntervalIsPercent() ? STR_VEHICLE_DETAILS_SERVICING_INTERVAL_PERCENT : STR_VEHICLE_DETAILS_SERVICING_INTERVAL_DAYS);
                                break;
                }
        }

        /** Repaint vehicle details window. */
        void OnPaint (BlitArea *dpi) OVERRIDE
        {
                const Vehicle *v = Vehicle::Get(this->window_number);

                this->SetWidgetDisabledState(WID_VD_RENAME_VEHICLE, v->owner != _local_company);

                if (v->type == VEH_TRAIN) {
                        this->DisableWidget(this->tab + WID_VD_DETAILS_CARGO_CARRIED);
                        this->vscroll->SetCount(GetTrainDetailsWndVScroll(v->index, this->tab));
                }

                /* Disable service-scroller when interval is set to disabled */
                this->SetWidgetsDisabledState(!IsVehicleServiceIntervalEnabled(v->type, v->owner),
                        WID_VD_INCREASE_SERVICING_INTERVAL,
                        WID_VD_DECREASE_SERVICING_INTERVAL,
                        WIDGET_LIST_END);

                StringID str = v->ServiceIntervalIsCustom() ?
                        (v->ServiceIntervalIsPercent() ? STR_VEHICLE_DETAILS_PERCENT : STR_VEHICLE_DETAILS_DAYS) :
                        STR_VEHICLE_DETAILS_DEFAULT;
                this->GetWidget<NWidgetCore>(WID_VD_SERVICE_INTERVAL_DROPDOWN)->widget_data = str;

                this->DrawWidgets (dpi);
        }

        virtual void OnClick(Point pt, int widget, int click_count)
        {
                switch (widget) {
                        case WID_VD_RENAME_VEHICLE: { // rename
                                const Vehicle *v = Vehicle::Get(this->window_number);
                                SetDParam(0, v->index);
                                ShowQueryString(STR_VEHICLE_NAME, STR_QUERY_RENAME_TRAIN_CAPTION + v->type,
                                                MAX_LENGTH_VEHICLE_NAME_CHARS, this, CS_ALPHANUMERAL, QSF_ENABLE_DEFAULT | QSF_LEN_IN_CHARS);
                                break;
                        }

                        case WID_VD_INCREASE_SERVICING_INTERVAL:   // increase int
                        case WID_VD_DECREASE_SERVICING_INTERVAL: { // decrease int
                                int mod = _ctrl_pressed ? 5 : 10;
                                const Vehicle *v = Vehicle::Get(this->window_number);

                                mod = (widget == WID_VD_DECREASE_SERVICING_INTERVAL) ? -mod : mod;
                                mod = GetServiceIntervalClamped(mod + v->GetServiceInterval(), v->ServiceIntervalIsPercent());
                                if (mod == v->GetServiceInterval()) return;

                                DoCommandP(v->tile, v->index, mod | (1 << 16) | (v->ServiceIntervalIsPercent() << 17), CMD_CHANGE_SERVICE_INT);
                                break;
                        }

                        case WID_VD_SERVICE_INTERVAL_DROPDOWN: {
                                const Vehicle *v = Vehicle::Get(this->window_number);
                                ShowDropDownMenu(this, _service_interval_dropdown, v->ServiceIntervalIsCustom() ? (v->ServiceIntervalIsPercent() ? 2 : 1) : 0, widget, 0, 0);
                                break;
                        }

                        case WID_VD_DETAILS_CARGO_CARRIED:
                        case WID_VD_DETAILS_TRAIN_VEHICLES:
                        case WID_VD_DETAILS_CAPACITY_OF_EACH:
                        case WID_VD_DETAILS_TOTAL_CARGO:
                                this->SetWidgetsDisabledState(false,
                                        WID_VD_DETAILS_CARGO_CARRIED,
                                        WID_VD_DETAILS_TRAIN_VEHICLES,
                                        WID_VD_DETAILS_CAPACITY_OF_EACH,
                                        WID_VD_DETAILS_TOTAL_CARGO,
                                        widget,
                                        WIDGET_LIST_END);

                                this->tab = (TrainDetailsWindowTabs)(widget - WID_VD_DETAILS_CARGO_CARRIED);
                                this->SetDirty();
                                break;
                }
        }

        virtual void OnDropdownSelect(int widget, int index)
        {
                switch (widget) {
                        case WID_VD_SERVICE_INTERVAL_DROPDOWN: {
                                const Vehicle *v = Vehicle::Get(this->window_number);
                                bool iscustom = index != 0;
                                bool ispercent = iscustom ? (index == 2) : Company::Get(v->owner)->settings.vehicle.servint_ispercent;
                                uint16 interval = GetServiceIntervalClamped(v->GetServiceInterval(), ispercent);
                                DoCommandP(v->tile, v->index, interval | (iscustom << 16) | (ispercent << 17), CMD_CHANGE_SERVICE_INT);
                                break;
                        }
                }
        }

        virtual void OnQueryTextFinished(char *str)
        {
                if (str == NULL) return;

                DoCommandP(0, this->window_number, 0, CMD_RENAME_VEHICLE, str);
        }

        virtual void OnResize()
        {
                NWidgetCore *nwi = this->GetWidget<NWidgetCore>(WID_VD_MATRIX);
                if (nwi != NULL) {
                        this->vscroll->SetCapacityFromWidget(this, WID_VD_MATRIX);
                }
        }
};

/** Vehicle details window preferences. */
static WindowDesc::Prefs _train_vehicle_details_prefs ("view_vehicle_details_train");

/** Vehicle details window descriptor. */
static const WindowDesc _train_vehicle_details_desc(
        WDP_AUTO, 405, 178,
        WC_VEHICLE_DETAILS, WC_VEHICLE_VIEW,
        0,
        _nested_train_vehicle_details_widgets, lengthof(_nested_train_vehicle_details_widgets),
        &_train_vehicle_details_prefs
);

/** Vehicle details window preferences for other vehicles than a train. */
static WindowDesc::Prefs _nontrain_vehicle_details_prefs ("view_vehicle_details");

/** Vehicle details window descriptor for other vehicles than a train. */
static const WindowDesc _nontrain_vehicle_details_desc(
        WDP_AUTO, 405, 113,
        WC_VEHICLE_DETAILS, WC_VEHICLE_VIEW,
        0,
        _nested_nontrain_vehicle_details_widgets, lengthof(_nested_nontrain_vehicle_details_widgets),
        &_nontrain_vehicle_details_prefs
);

/** Shows the vehicle details window of the given vehicle. */
static void ShowVehicleDetailsWindow(const Vehicle *v)
{
        DeleteWindowById(WC_VEHICLE_ORDERS, v->index, false);
        DeleteWindowById(WC_VEHICLE_TIMETABLE, v->index, false);
        AllocateWindowDescFront<VehicleDetailsWindow>((v->type == VEH_TRAIN) ? &_train_vehicle_details_desc : &_nontrain_vehicle_details_desc, v->index);
}


/* Unified vehicle GUI - Vehicle View Window */

/** Vehicle view widgets. */
static const NWidgetPart _nested_vehicle_view_widgets[] = {
        NWidget(NWID_HORIZONTAL),
                NWidget(WWT_CLOSEBOX, COLOUR_GREY),
                NWidget(WWT_CAPTION, COLOUR_GREY, WID_VV_CAPTION), SetDataTip(STR_VEHICLE_VIEW_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
                NWidget(WWT_DEBUGBOX, COLOUR_GREY),
                NWidget(WWT_SHADEBOX, COLOUR_GREY),
                NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
                NWidget(WWT_STICKYBOX, COLOUR_GREY),
        EndContainer(),
        NWidget(NWID_HORIZONTAL),
                NWidget(WWT_PANEL, COLOUR_GREY),
                        NWidget(WWT_INSET, COLOUR_GREY), SetPadding(2, 2, 2, 2),
                                NWidget(NWID_VIEWPORT, INVALID_COLOUR, WID_VV_VIEWPORT), SetMinimalSize(226, 84), SetResize(1, 1), SetPadding(1, 1, 1, 1),
                        EndContainer(),
                EndContainer(),
                NWidget(NWID_VERTICAL),
                        NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_VV_CENTER_MAIN_VIEW), SetMinimalSize(18, 18), SetDataTip(SPR_CENTRE_VIEW_VEHICLE, 0x0 /* filled later */),
                        NWidget(NWID_SELECTION, INVALID_COLOUR, WID_VV_SELECT_DEPOT_CLONE),
                                NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_VV_GOTO_DEPOT), SetMinimalSize(18, 18), SetDataTip(0x0 /* filled later */, 0x0 /* filled later */),
                                NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_VV_CLONE), SetMinimalSize(18, 18), SetDataTip(0x0 /* filled later */, 0x0 /* filled later */),
                        EndContainer(),
                        /* For trains only, 'ignore signal' button. */
                        NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_VV_FORCE_PROCEED), SetMinimalSize(18, 18),
                                                                                        SetDataTip(SPR_IGNORE_SIGNALS, STR_VEHICLE_VIEW_TRAIN_IGNORE_SIGNAL_TOOLTIP),
                        NWidget(NWID_SELECTION, INVALID_COLOUR, WID_VV_SELECT_REFIT_TURN),
                                NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_VV_REFIT), SetMinimalSize(18, 18), SetDataTip(SPR_REFIT_VEHICLE, 0x0 /* filled later */),
                                NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_VV_TURN_AROUND), SetMinimalSize(18, 18),
                                                                                                SetDataTip(SPR_FORCE_VEHICLE_TURN, STR_VEHICLE_VIEW_ROAD_VEHICLE_REVERSE_TOOLTIP),
                        EndContainer(),
                        NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_VV_SHOW_ORDERS), SetMinimalSize(18, 18), SetDataTip(SPR_SHOW_ORDERS, 0x0 /* filled later */),
                        NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_VV_SHOW_DETAILS), SetMinimalSize(18, 18), SetDataTip(SPR_SHOW_VEHICLE_DETAILS, 0x0 /* filled later */),
                        NWidget(WWT_PANEL, COLOUR_GREY), SetMinimalSize(18, 0), SetResize(0, 1), EndContainer(),
                EndContainer(),
        EndContainer(),
        NWidget(NWID_HORIZONTAL),
                NWidget(WWT_PUSHBTN, COLOUR_GREY, WID_VV_START_STOP), SetMinimalTextLines(1, WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM + 2), SetResize(1, 0), SetFill(1, 0),
                NWidget(WWT_RESIZEBOX, COLOUR_GREY),
        EndContainer(),
};

/** Vehicle view window preferences for all vehicles but trains. */
static WindowDesc::Prefs _vehicle_view_prefs ("view_vehicle");

/** Vehicle view window descriptor for all vehicles but trains. */
static const WindowDesc _vehicle_view_desc(
        WDP_AUTO, 250, 116,
        WC_VEHICLE_VIEW, WC_NONE,
        0,
        _nested_vehicle_view_widgets, lengthof(_nested_vehicle_view_widgets),
        &_vehicle_view_prefs
);

/** Vehicle view window preferences for trains. */
static WindowDesc::Prefs _train_view_prefs ("view_vehicle_train");

/**
 * Vehicle view window descriptor for trains. Only minimum_height and
 *  default_height are different for train view.
 */
static const WindowDesc _train_view_desc(
        WDP_AUTO, 250, 134,
        WC_VEHICLE_VIEW, WC_NONE,
        0,
        _nested_vehicle_view_widgets, lengthof(_nested_vehicle_view_widgets),
        &_train_view_prefs
);


/* Just to make sure, nobody has changed the vehicle type constants, as we are
         using them for array indexing in a number of places here. */
assert_compile(VEH_TRAIN == 0);
assert_compile(VEH_ROAD == 1);
assert_compile(VEH_SHIP == 2);
assert_compile(VEH_AIRCRAFT == 3);

/** Zoom levels for vehicle views indexed by vehicle type. */
static const ZoomLevel _vehicle_view_zoom_levels[] = {
        ZOOM_LVL_TRAIN,
        ZOOM_LVL_ROADVEH,
        ZOOM_LVL_SHIP,
        ZOOM_LVL_AIRCRAFT,
};

/* Constants for geometry of vehicle view viewport */
static const int VV_INITIAL_VIEWPORT_WIDTH = 226;
static const int VV_INITIAL_VIEWPORT_HEIGHT = 84;
static const int VV_INITIAL_VIEWPORT_HEIGHT_TRAIN = 102;

/** Error strings when starting/stopping a vehicle indexed by vehicle type. */
static const StringID _vehicle_string_startstop_table[4] = {
        STR_ERROR_CAN_T_STOP_START_TRAIN,
        STR_ERROR_CAN_T_STOP_START_ROAD_VEHICLE,
        STR_ERROR_CAN_T_STOP_START_SHIP,
        STR_ERROR_CAN_T_STOP_START_AIRCRAFT,
};

/**
 * This is the Callback method after attempting to start/stop a vehicle
 * @param result the result of the start/stop command
 * @param tile unused
 * @param p1 vehicle ID
 * @param p2 unused
 */
void CcStartStopVehicle(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2)
{
        if (result.Failed()) return;

        if (p2 == 0) return;

        const Vehicle *v = Vehicle::GetIfValid(p1);
        if (v == NULL || !v->IsPrimaryVehicle() || v->owner != _local_company) return;

        StringID msg = (v->vehstatus & VS_STOPPED) ? STR_VEHICLE_COMMAND_STOPPED : STR_VEHICLE_COMMAND_STARTED;
        Point pt = RemapCoords(v->x_pos, v->y_pos, v->z_pos);
        AddTextEffect(msg, pt.x, pt.y, DAY_TICKS, TE_RISING);
}

/**
 * Executes #CMD_START_STOP_VEHICLE for given vehicle.
 * @param v Vehicle to start/stop
 * @param texteffect Should a texteffect be shown?
 */
void StartStopVehicle(const Vehicle *v, bool texteffect)
{
        assert(v->IsPrimaryVehicle());
        DoCommandP(v->tile, v->index, texteffect ? 1 : 0, CMD_START_STOP_VEHICLE);
}

/** Checks whether the vehicle may be refitted at the moment.*/
static bool IsVehicleRefitable(const Vehicle *v)
{
        if (!v->IsStoppedInDepot()) return false;

        do {
                if (IsEngineRefittable(v->engine_type)) return true;
        } while (v->IsGroundVehicle() && (v = v->Next()) != NULL);

        return false;
}

/** Window manager class for viewing a vehicle. */
struct VehicleViewWindow : Window {
private:
        /** Display planes available in the vehicle view window. */
        enum PlaneSelections {
                SEL_DC_GOTO_DEPOT,  ///< Display 'goto depot' button in #WID_VV_SELECT_DEPOT_CLONE stacked widget.
                SEL_DC_CLONE,       ///< Display 'clone vehicle' button in #WID_VV_SELECT_DEPOT_CLONE stacked widget.

                SEL_RT_REFIT,       ///< Display 'refit' button in #WID_VV_SELECT_REFIT_TURN stacked widget.
                SEL_RT_TURN_AROUND, ///< Display 'turn around' button in #WID_VV_SELECT_REFIT_TURN stacked widget.

                SEL_DC_BASEPLANE = SEL_DC_GOTO_DEPOT, ///< First plane of the #WID_VV_SELECT_DEPOT_CLONE stacked widget.
                SEL_RT_BASEPLANE = SEL_RT_REFIT,      ///< First plane of the #WID_VV_SELECT_REFIT_TURN stacked widget.
        };

        /**
         * Display a plane in the window.
         * @param plane Plane to show.
         */
        void SelectPlane(PlaneSelections plane)
        {
                switch (plane) {
                        case SEL_DC_GOTO_DEPOT:
                        case SEL_DC_CLONE:
                                this->GetWidget<NWidgetStacked>(WID_VV_SELECT_DEPOT_CLONE)->SetDisplayedPlane(plane - SEL_DC_BASEPLANE);
                                break;

                        case SEL_RT_REFIT:
                        case SEL_RT_TURN_AROUND:
                                this->GetWidget<NWidgetStacked>(WID_VV_SELECT_REFIT_TURN)->SetDisplayedPlane(plane - SEL_RT_BASEPLANE);
                                break;

                        default:
                                NOT_REACHED();
                }
        }

public:
        VehicleViewWindow (const WindowDesc *desc, WindowNumber window_number) : Window(desc)
        {
                this->CreateNestedTree();

                /* Sprites for the 'send to depot' button indexed by vehicle type. */
                static const SpriteID vehicle_view_goto_depot_sprites[] = {
                        SPR_SEND_TRAIN_TODEPOT,
                        SPR_SEND_ROADVEH_TODEPOT,
                        SPR_SEND_SHIP_TODEPOT,
                        SPR_SEND_AIRCRAFT_TODEPOT,
                };
                const Vehicle *v = Vehicle::Get(window_number);
                this->GetWidget<NWidgetCore>(WID_VV_GOTO_DEPOT)->widget_data = vehicle_view_goto_depot_sprites[v->type];

                /* Sprites for the 'clone vehicle' button indexed by vehicle type. */
                static const SpriteID vehicle_view_clone_sprites[] = {
                        SPR_CLONE_TRAIN,
                        SPR_CLONE_ROADVEH,
                        SPR_CLONE_SHIP,
                        SPR_CLONE_AIRCRAFT,
                };
                this->GetWidget<NWidgetCore>(WID_VV_CLONE)->widget_data = vehicle_view_clone_sprites[v->type];

                switch (v->type) {
                        case VEH_TRAIN:
                                this->GetWidget<NWidgetCore>(WID_VV_TURN_AROUND)->tool_tip = STR_VEHICLE_VIEW_TRAIN_REVERSE_TOOLTIP;
                                break;

                        case VEH_ROAD:
                                break;

                        case VEH_SHIP:
                        case VEH_AIRCRAFT:
                                this->SelectPlane(SEL_RT_REFIT);
                                break;

                        default: NOT_REACHED();
                }
                this->InitNested(window_number);
                this->owner = v->owner;
                this->GetWidget<NWidgetViewport>(WID_VV_VIEWPORT)->InitializeViewport(this, this->window_number | (1 << 31), _vehicle_view_zoom_levels[v->type]);

                this->GetWidget<NWidgetCore>(WID_VV_START_STOP)->tool_tip       = STR_VEHICLE_VIEW_TRAIN_STATE_START_STOP_TOOLTIP + v->type;
                this->GetWidget<NWidgetCore>(WID_VV_CENTER_MAIN_VIEW)->tool_tip = STR_VEHICLE_VIEW_TRAIN_LOCATION_TOOLTIP + v->type;
                this->GetWidget<NWidgetCore>(WID_VV_REFIT)->tool_tip            = STR_VEHICLE_VIEW_TRAIN_REFIT_TOOLTIP + v->type;
                this->GetWidget<NWidgetCore>(WID_VV_GOTO_DEPOT)->tool_tip       = STR_VEHICLE_VIEW_TRAIN_SEND_TO_DEPOT_TOOLTIP + v->type;
                this->GetWidget<NWidgetCore>(WID_VV_SHOW_ORDERS)->tool_tip      = STR_VEHICLE_VIEW_TRAIN_ORDERS_TOOLTIP + v->type;
                this->GetWidget<NWidgetCore>(WID_VV_SHOW_DETAILS)->tool_tip     = STR_VEHICLE_VIEW_TRAIN_SHOW_DETAILS_TOOLTIP + v->type;
                this->GetWidget<NWidgetCore>(WID_VV_CLONE)->tool_tip            = STR_VEHICLE_VIEW_CLONE_TRAIN_INFO + v->type;
        }

        void OnDelete (void) FINAL_OVERRIDE
        {
                DeleteWindowById(WC_VEHICLE_ORDERS, this->window_number, false);
                DeleteWindowById(WC_VEHICLE_REFIT, this->window_number, false);
                DeleteWindowById(WC_VEHICLE_DETAILS, this->window_number, false);
                DeleteWindowById(WC_VEHICLE_TIMETABLE, this->window_number, false);
        }

        virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
        {
                const Vehicle *v = Vehicle::Get(this->window_number);
                switch (widget) {
                        case WID_VV_START_STOP:
                                size->height = max(size->height, max(GetSpriteSize(SPR_FLAG_VEH_STOPPED).height, GetSpriteSize(SPR_FLAG_VEH_RUNNING).height) + WD_IMGBTN_TOP + WD_IMGBTN_BOTTOM);
                                break;

                        case WID_VV_FORCE_PROCEED:
                                if (v->type != VEH_TRAIN) {
                                        size->height = 0;
                                        size->width = 0;
                                }
                                break;

                        case WID_VV_VIEWPORT:
                                size->width = VV_INITIAL_VIEWPORT_WIDTH;
                                size->height = (v->type == VEH_TRAIN) ? VV_INITIAL_VIEWPORT_HEIGHT_TRAIN : VV_INITIAL_VIEWPORT_HEIGHT;
                                break;
                }
        }

        void OnPaint (BlitArea *dpi) OVERRIDE
        {
                const Vehicle *v = Vehicle::Get(this->window_number);
                bool is_localcompany = v->owner == _local_company;
                bool refitable_and_stopped_in_depot = IsVehicleRefitable(v);

                this->SetWidgetDisabledState(WID_VV_GOTO_DEPOT, !is_localcompany);
                this->SetWidgetDisabledState(WID_VV_REFIT, !refitable_and_stopped_in_depot || !is_localcompany);
                this->SetWidgetDisabledState(WID_VV_CLONE, !is_localcompany);

                if (v->type == VEH_TRAIN) {
                        this->SetWidgetLoweredState(WID_VV_FORCE_PROCEED, Train::From(v)->force_proceed == TFP_SIGNAL);
                        this->SetWidgetDisabledState(WID_VV_FORCE_PROCEED, !is_localcompany);
                        this->SetWidgetDisabledState(WID_VV_TURN_AROUND, !is_localcompany);
                }

                this->DrawWidgets (dpi);
        }

        virtual void SetStringParameters(int widget) const
        {
                if (widget != WID_VV_CAPTION) return;

                const Vehicle *v = Vehicle::Get(this->window_number);
                SetDParam(0, v->index);
        }

        void DrawWidget (BlitArea *dpi, const Rect &r, int widget) const OVERRIDE
        {
                if (widget != WID_VV_START_STOP) return;

                const Vehicle *v = Vehicle::Get(this->window_number);
                StringID str;
                if (v->vehstatus & VS_CRASHED) {
                        str = STR_VEHICLE_STATUS_CRASHED;
                } else if (v->type != VEH_AIRCRAFT && v->breakdown_ctr == 1) { // check for aircraft necessary?
                        str = STR_VEHICLE_STATUS_BROKEN_DOWN;
                } else if (v->vehstatus & VS_STOPPED) {
                        if (v->type == VEH_TRAIN) {
                                if (v->cur_speed == 0) {
                                        if (Train::From(v)->gcache.cached_power == 0) {
                                                str = STR_VEHICLE_STATUS_TRAIN_NO_POWER;
                                        } else {
                                                str = STR_VEHICLE_STATUS_STOPPED;
                                        }
                                } else {
                                        SetDParam(0, v->GetDisplaySpeed());
                                        str = STR_VEHICLE_STATUS_TRAIN_STOPPING_VEL;
                                }
                        } else { // no train
                                str = STR_VEHICLE_STATUS_STOPPED;
                        }
                } else if (v->type == VEH_TRAIN && HasBit(Train::From(v)->flags, VRF_TRAIN_STUCK) && !v->current_order.IsType(OT_LOADING)) {
                        str = STR_VEHICLE_STATUS_TRAIN_STUCK;
                } else if (v->type == VEH_AIRCRAFT && HasBit(Aircraft::From(v)->flags, VAF_DEST_TOO_FAR) && !v->current_order.IsType(OT_LOADING)) {
                        str = STR_VEHICLE_STATUS_AIRCRAFT_TOO_FAR;
                } else { // vehicle is in a "normal" state, show current order
                        switch (v->current_order.GetType()) {
                                case OT_GOTO_STATION: {
                                        SetDParam(0, v->current_order.GetDestination());
                                        SetDParam(1, v->GetDisplaySpeed());
                                        str = STR_VEHICLE_STATUS_HEADING_FOR_STATION_VEL;
                                        break;
                                }

                                case OT_GOTO_DEPOT: {
                                        SetDParam(0, v->type);
                                        SetDParam(1, v->current_order.GetDestination());
                                        SetDParam(2, v->GetDisplaySpeed());
                                        if (v->current_order.GetDepotActionType() & ODATFB_NEAREST_DEPOT) {
                                                /* This case *only* happens when multiple nearest depot orders
                                                 * follow each other (including an order list only one order: a
                                                 * nearest depot order) and there are no reachable depots.
                                                 * It is primarily to guard for the case that there is no
                                                 * depot with index 0, which would be used as fallback for
                                                 * evaluating the string in the status bar. */
                                                str = STR_EMPTY;
                                        } else if (v->current_order.GetDepotActionType() & ODATFB_HALT) {
                                                str = STR_VEHICLE_STATUS_HEADING_FOR_DEPOT_VEL;
                                        } else {
                                                str = STR_VEHICLE_STATUS_HEADING_FOR_DEPOT_SERVICE_VEL;
                                        }
                                        break;
                                }

                                case OT_LOADING:
                                        str = STR_VEHICLE_STATUS_LOADING_UNLOADING;
                                        break;

                                case OT_GOTO_WAYPOINT: {
                                        assert(v->type == VEH_TRAIN || v->type == VEH_SHIP);
                                        SetDParam(0, v->current_order.GetDestination());
                                        str = STR_VEHICLE_STATUS_HEADING_FOR_WAYPOINT_VEL;
                                        SetDParam(1, v->GetDisplaySpeed());
                                        break;
                                }

                                case OT_LEAVESTATION:
                                        if (v->type != VEH_AIRCRAFT) {
                                                str = STR_VEHICLE_STATUS_LEAVING;
                                                break;
                                        }
                                        /* FALL THROUGH, if aircraft. Does this even happen? */

                                default:
                                        if (v->GetNumManualOrders() == 0) {
                                                str = STR_VEHICLE_STATUS_NO_ORDERS_VEL;
                                                SetDParam(0, v->GetDisplaySpeed());
                                        } else {
                                                str = STR_EMPTY;
                                        }
                                        break;
                        }
                }

                /* Draw the flag plus orders. */
                bool rtl = (_current_text_dir == TD_RTL);
                uint text_offset = max(GetSpriteSize(SPR_FLAG_VEH_STOPPED).width, GetSpriteSize(SPR_FLAG_VEH_RUNNING).width) + WD_IMGBTN_LEFT + WD_IMGBTN_RIGHT;
                int text_left = r.left + (rtl ? (uint)WD_FRAMERECT_LEFT : text_offset);
                int text_right = r.right - (rtl ? text_offset : (uint)WD_FRAMERECT_RIGHT);
                int image_left = (rtl ? text_right + 1 : r.left) + WD_IMGBTN_LEFT;
                int image = ((v->vehstatus & VS_STOPPED) != 0) ? SPR_FLAG_VEH_STOPPED : SPR_FLAG_VEH_RUNNING;
                int lowered = this->IsWidgetLowered(WID_VV_START_STOP) ? 1 : 0;
                DrawSprite (dpi, image, PAL_NONE, image_left + lowered, r.top + WD_IMGBTN_TOP + lowered);
                DrawString (dpi, text_left + lowered, text_right + lowered, r.top + WD_FRAMERECT_TOP + lowered, str, TC_FROMSTRING, SA_HOR_CENTER);
        }

        virtual void OnClick(Point pt, int widget, int click_count)
        {
                const Vehicle *v = Vehicle::Get(this->window_number);

                switch (widget) {
                        case WID_VV_START_STOP: // start stop
                                if (_ctrl_pressed) {
                                        /* Scroll to current order destination */
                                        TileIndex tile = v->current_order.GetLocation(v);
                                        if (tile != INVALID_TILE) ScrollMainWindowToTile(tile);
                                } else {
                                        /* Start/Stop */
                                        StartStopVehicle(v, false);
                                }
                                break;
                        case WID_VV_CENTER_MAIN_VIEW: {// center main view
                                const Window *mainwindow = FindWindowById(WC_MAIN_WINDOW, 0);
                                /* code to allow the main window to 'follow' the vehicle if the ctrl key is pressed */
                                if (_ctrl_pressed && mainwindow->viewport->zoom <= ZOOM_LVL_OUT_4X) {
                                        mainwindow->viewport->follow_vehicle = v->index;
                                } else {
                                        ScrollMainWindowTo(v->x_pos, v->y_pos, v->z_pos);
                                }
                                break;
                        }

                        case WID_VV_GOTO_DEPOT: // goto hangar
                                DoCommandP(v->tile, v->index | (_ctrl_pressed ? DEPOT_SERVICE : 0U), 0, CMD_SEND_VEHICLE_TO_DEPOT);
                                break;
                        case WID_VV_REFIT: // refit
                                ShowVehicleRefitWindow (this, v);
                                break;
                        case WID_VV_SHOW_ORDERS: // show orders
                                if (_ctrl_pressed) {
                                        ShowTimetableWindow(v);
                                } else {
                                        ShowOrdersWindow(v);
                                }
                                break;
                        case WID_VV_SHOW_DETAILS: // show details
                                ShowVehicleDetailsWindow(v);
                                break;
                        case WID_VV_CLONE: // clone vehicle
                                /* Suppress the vehicle GUI when share-cloning.
                                 * There is no point to it except for starting the vehicle.
                                 * For starting the vehicle the player has to open the depot GUI, which is
                                 * most likely already open, but is also visible in the vehicle viewport. */
                                DoCommandP(v->tile, v->index, _ctrl_pressed ? (1 | (1 << 31)) : 0, CMD_CLONE_VEHICLE);
                                break;
                        case WID_VV_TURN_AROUND: // turn around
                                assert(v->IsGroundVehicle());
                                if (v->type == VEH_TRAIN) {
                                        DoCommandP(v->tile, v->index, 0, CMD_REVERSE_TRAIN_DIRECTION);
                                } else {
                                        DoCommandP(v->tile, v->index, 0, CMD_TURN_ROADVEH);
                                }
                                break;
                        case WID_VV_FORCE_PROCEED: // force proceed
                                assert(v->type == VEH_TRAIN);
                                DoCommandP(v->tile, v->index, 0, CMD_FORCE_TRAIN_PROCEED);
                                break;
                }
        }

        virtual void OnResize()
        {
                if (this->viewport != NULL) {
                        NWidgetViewport *nvp = this->GetWidget<NWidgetViewport>(WID_VV_VIEWPORT);
                        nvp->UpdateViewportCoordinates(this);
                }
        }

        virtual void OnTick()
        {
                const Vehicle *v = Vehicle::Get(this->window_number);
                bool veh_stopped = v->IsStoppedInDepot();

                /* Widget WID_VV_GOTO_DEPOT must be hidden if the vehicle is already stopped in depot.
                 * Widget WID_VV_CLONE_VEH should then be shown, since cloning is allowed only while in depot and stopped.
                 */
                PlaneSelections plane = veh_stopped ? SEL_DC_CLONE : SEL_DC_GOTO_DEPOT;
                NWidgetStacked *nwi = this->GetWidget<NWidgetStacked>(WID_VV_SELECT_DEPOT_CLONE); // Selection widget 'send to depot' / 'clone'.
                if (nwi->shown_plane + SEL_DC_BASEPLANE != plane) {
                        this->SelectPlane(plane);
                        this->SetWidgetDirty(WID_VV_SELECT_DEPOT_CLONE);
                }
                /* The same system applies to widget WID_VV_REFIT_VEH and VVW_WIDGET_TURN_AROUND.*/
                if (v->IsGroundVehicle()) {
                        PlaneSelections plane = veh_stopped ? SEL_RT_REFIT : SEL_RT_TURN_AROUND;
                        NWidgetStacked *nwi = this->GetWidget<NWidgetStacked>(WID_VV_SELECT_REFIT_TURN);
                        if (nwi->shown_plane + SEL_RT_BASEPLANE != plane) {
                                this->SelectPlane(plane);
                                this->SetWidgetDirty(WID_VV_SELECT_REFIT_TURN);
                        }
                }
        }

        /**
         * Some data on this window has become invalid.
         * @param data Information about the changed data.
         * @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.
         */
        virtual void OnInvalidateData(int data = 0, bool gui_scope = true)
        {
                if (data == VIWD_AUTOREPLACE) {
                        /* Autoreplace replaced the vehicle.
                         * Nothing to do for this window. */
                        return;
                }
        }

        virtual bool IsNewGRFInspectable() const
        {
                return ::IsNewGRFInspectable(GetGrfSpecFeature(Vehicle::Get(this->window_number)->type), this->window_number);
        }

        virtual void ShowNewGRFInspectWindow() const
        {
                ::ShowNewGRFInspectWindow(GetGrfSpecFeature(Vehicle::Get(this->window_number)->type), this->window_number);
        }
};


/** Shows the vehicle view window of the given vehicle. */
void ShowVehicleViewWindow(const Vehicle *v)
{
        AllocateWindowDescFront<VehicleViewWindow>((v->type == VEH_TRAIN) ? &_train_view_desc : &_vehicle_view_desc, v->index);
}

/**
 * Dispatch a "vehicle selected" event if any window waits for it.
 * @param v selected vehicle;
 * @return did any window accept vehicle selection?
 */
bool VehicleClicked(const Vehicle *v)
{
        assert(v != NULL);
        if (_pointer_mode < POINTER_VEHICLE) return false;

        v = v->First();
        if (!v->IsPrimaryVehicle()) return false;

        return _thd.GetCallbackWnd()->OnVehicleSelect(v);
}

void StopGlobalFollowVehicle(const Vehicle *v)
{
        Window *w = FindWindowById(WC_MAIN_WINDOW, 0);
        if (w != NULL && w->viewport->follow_vehicle == v->index) {
                ScrollMainWindowTo(v->x_pos, v->y_pos, v->z_pos, true); // lock the main view on the vehicle's last position
                w->viewport->follow_vehicle = INVALID_VEHICLE;
        }
}


/**
 * Callback for building a vehicle
 * @param result The result of the command.
 * @param tile   The tile the command was executed on.
 * @param p1 Additional data for the command (for the #CommandProc)
 * @param p2 Additional data for the command (for the #CommandProc)
 */
void CcBuildVehicle(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2)
{
        if (result.Failed()) return;

        if (!IsRailDepotTile(tile) || RailVehInfo(p1)->railveh_type != RAILVEH_WAGON) {
                /* not a wagon */
                const Vehicle *v = Vehicle::Get(_new_vehicle_id);
                ShowVehicleViewWindow(v);
                return;
        }

        /* find a locomotive in the depot. */
        const Vehicle *found = NULL;
        const Train *t;
        FOR_ALL_TRAINS(t) {
                if (t->IsFrontEngine() && t->tile == tile && t->IsStoppedInDepot()) {
                        if (found != NULL) return; // must be exactly one.
                        found = t;
                }
        }

        /* if we found a loco, */
        if (found != NULL) {
                found = found->Last();
                /* put the new wagon at the end of the loco. */
                DoCommandP(0, _new_vehicle_id | (1 << 31), found->index, CMD_MOVE_RAIL_VEHICLE);
                InvalidateWindowClassesData(WC_TRAINS_LIST, 0);
        }
}

/**
 * Get the error string to show for building a vehicle
 * @param tile   The tile the command was executed on.
 * @param p1 Additional data for the command (for the #CommandProc)
 * @param p2 Additional data for the command (for the #CommandProc)
 * @param text Unused
 */
StringID GetErrBuildVehicle (TileIndex tile, uint32 p1, uint32 p2, const char *text)
{
        return GetErrBuildVeh(Engine::Get(GB(p1, 0, 16))->type);
}

/**
 * Get the error string to show for building a vehicle
 * @param tile   The tile the command was executed on.
 * @param p1 Additional data for the command (for the #CommandProc)
 * @param p2 Additional data for the command (for the #CommandProc)
 * @param text Unused
 */
StringID GetErrSellVehicle (TileIndex tile, uint32 p1, uint32 p2, const char *text)
{
        return GetErrSellVeh(Vehicle::Get(GB(p1, 0, 20)));
}

/**
 * Get the error string to show for refitting a vehicle
 * @param tile   The tile the command was executed on.
 * @param p1 Additional data for the command (for the #CommandProc)
 * @param p2 Additional data for the command (for the #CommandProc)
 * @param text Unused
 */
StringID GetErrRefitVehicle (TileIndex tile, uint32 p1, uint32 p2, const char *text)
{
        return GetErrRefitVeh(Vehicle::Get(p1));
}

/**
 * Get the error string to show for cloning a vehicle
 * @param tile   The tile the command was executed on.
 * @param p1 Additional data for the command (for the #CommandProc)
 * @param p2 Additional data for the command (for the #CommandProc)
 * @param text Unused
 */
StringID GetErrCloneVehicle (TileIndex tile, uint32 p1, uint32 p2, const char *text)
{
        return GetErrBuildVeh(Vehicle::Get(p1));
}

/**
 * Get the error string to show for renaming a vehicle
 * @param tile   The tile the command was executed on.
 * @param p1 Additional data for the command (for the #CommandProc)
 * @param p2 Additional data for the command (for the #CommandProc)
 * @param text Unused
 */
StringID GetErrRenameVehicle (TileIndex tile, uint32 p1, uint32 p2, const char *text)
{
        return STR_ERROR_CAN_T_RENAME_TRAIN + Vehicle::Get(p1)->type;
}

/**
 * Get the error string to show for starting/stopping a vehicle
 * @param tile   The tile the command was executed on.
 * @param p1 Additional data for the command (for the #CommandProc)
 * @param p2 Additional data for the command (for the #CommandProc)
 * @param text Unused
 */
StringID GetErrStartStopVehicle (TileIndex tile, uint32 p1, uint32 p2, const char *text)
{
        return _vehicle_string_startstop_table[Vehicle::Get(p1)->type];
}

/**
 * Get the error string to show for sending a vehicle to the depot
 * @param tile   The tile the command was executed on.
 * @param p1 Additional data for the command (for the #CommandProc)
 * @param p2 Additional data for the command (for the #CommandProc)
 * @param text Unused
 */
StringID GetErrSendVehicleToDepot (TileIndex tile, uint32 p1, uint32 p2, const char *text)
{
        VehicleType type;

        if (p1 & DEPOT_MASS_SEND) {
                /* Mass goto depot requested */
                VehicleListIdentifier vli;
                if (!vli.UnpackIfValid(p2)) return 0;
                type = vli.vtype;
        } else {
                type = Vehicle::Get(GB(p1, 0, 20))->type;
        }

        return GetErrSendToDepot(type);
}

/**
 * Get the error string to show for reversing a train
 * @param tile   The tile the command was executed on.
 * @param p1 Additional data for the command (for the #CommandProc)
 * @param p2 Additional data for the command (for the #CommandProc)
 * @param text Unused
 */
StringID GetErrReverseTrain (TileIndex tile, uint32 p1, uint32 p2, const char *text)
{
        return p2 ? STR_ERROR_CAN_T_REVERSE_DIRECTION_RAIL_VEHICLE : STR_ERROR_CAN_T_REVERSE_DIRECTION_TRAIN;
}


/**
 * Set the mouse cursor to look like a vehicle.
 * @param v Vehicle
 * @param image_type Type of vehicle image to use.
 */
void SetMouseCursorVehicle(const Vehicle *v, EngineImageType image_type)
{
        bool rtl = _current_text_dir == TD_RTL;

        _cursor.sprite_count = 0;
        int total_width = 0;
        for (;;) {
                PaletteID pal = (v->vehstatus & VS_CRASHED) ? PALETTE_CRASH : GetVehiclePalette(v);
                VehicleSpriteSeq seq;
                v->GetImage(rtl ? DIR_E : DIR_W, image_type, &seq);
                if (_cursor.sprite_count + seq.count > lengthof(_cursor.sprite_seq)) break;

                for (uint i = 0; i < seq.count; ++i) {
                        PaletteID pal2 = (v->vehstatus & VS_CRASHED) || !seq.seq[i].pal ? pal : seq.seq[i].pal;
                        _cursor.sprite_seq[_cursor.sprite_count].sprite = seq.seq[i].sprite;
                        _cursor.sprite_seq[_cursor.sprite_count].pal = pal2;
                        _cursor.sprite_seq[_cursor.sprite_count].pos = rtl ? -total_width : total_width;
                        _cursor.sprite_count++;
                }

                total_width += GetSingleVehicleWidth(v, image_type);
                if (total_width >= 2 * (int)VEHICLEINFO_FULL_VEHICLE_WIDTH) break;

                v = v->Next();
                if ((v == NULL) || !v->IsArticulatedPart()) break;
        }

        int offs = ((int)VEHICLEINFO_FULL_VEHICLE_WIDTH - total_width) / 2;
        if (rtl) offs = -offs;
        for (uint i = 0; i < _cursor.sprite_count; ++i) {
                _cursor.sprite_seq[i].pos += offs;
        }

        UpdateCursorSize();
}