group_gui.cpp

Go to the documentation of this file.

/*
 * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */
 
#include "stdafx.h"
#include "textbuf_gui.h"
#include "command_func.h"
#include "vehicle_gui.h"
#include "vehicle_base.h"
#include "string_func.h"
#include "strings_func.h"
#include "window_func.h"
#include "vehicle_func.h"
#include "autoreplace_gui.h"
#include "company_func.h"
#include "dropdown_func.h"
#include "tilehighlight_func.h"
#include "vehicle_gui_base.h"
#include "core/geometry_func.hpp"
#include "company_base.h"
#include "company_gui.h"
#include "gui.h"
#include "group_cmd.h"
#include "group_gui.h"
#include "vehicle_cmd.h"
#include "gfx_func.h"
 
#include "widgets/group_widget.h"
 
#include "table/sprites.h"
#include "table/strings.h"
 
#include "safeguards.h"
 
static constexpr std::initializer_list<NWidgetPart> _nested_group_widgets = {
  NWidget(NWID_HORIZONTAL), // Window header
    NWidget(WWT_CLOSEBOX, COLOUR_GREY),
    NWidget(WWT_CAPTION, COLOUR_GREY, WID_GL_CAPTION),
    NWidget(WWT_SHADEBOX, COLOUR_GREY),
    NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
    NWidget(WWT_STICKYBOX, COLOUR_GREY),
  EndContainer(),
  NWidget(NWID_HORIZONTAL),
    /* left part */
    NWidget(NWID_VERTICAL, NWidContainerFlag::BigFirst),
      NWidget(WWT_PANEL, COLOUR_GREY, WID_GL_ALL_VEHICLES), SetFill(1, 0), EndContainer(),
      NWidget(WWT_PANEL, COLOUR_GREY, WID_GL_DEFAULT_VEHICLES), SetFill(1, 0), EndContainer(),
      NWidget(NWID_HORIZONTAL),
        NWidget(WWT_MATRIX, COLOUR_GREY, WID_GL_LIST_GROUP), SetMatrixDataTip(1, 0, STR_GROUPS_CLICK_ON_GROUP_FOR_TOOLTIP),
            SetFill(1, 0), SetResize(0, 1), SetScrollbar(WID_GL_LIST_GROUP_SCROLLBAR),
        NWidget(NWID_VSCROLLBAR, COLOUR_GREY, WID_GL_LIST_GROUP_SCROLLBAR),
      EndContainer(),
      NWidget(WWT_PANEL, COLOUR_GREY, WID_GL_INFO), SetFill(1, 1), SetMinimalTextLines(3, WidgetDimensions::unscaled.framerect.Vertical()), EndContainer(),
      NWidget(NWID_HORIZONTAL),
        NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_GL_CREATE_GROUP),
            SetToolTip(STR_GROUP_CREATE_TOOLTIP),
        NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_GL_DELETE_GROUP),
            SetToolTip(STR_GROUP_DELETE_TOOLTIP),
        NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_GL_RENAME_GROUP),
            SetToolTip(STR_GROUP_RENAME_TOOLTIP),
        NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_GL_LIVERY_GROUP),
            SetToolTip(STR_GROUP_LIVERY_TOOLTIP),
        NWidget(WWT_PANEL, COLOUR_GREY), SetFill(1, 0), EndContainer(),
        NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_GL_REPLACE_PROTECTION),
            SetToolTip(STR_GROUP_REPLACE_PROTECTION_TOOLTIP),
      EndContainer(),
    EndContainer(),
    /* right part */
    NWidget(NWID_VERTICAL),
      NWidget(NWID_HORIZONTAL),
        NWidget(NWID_VERTICAL, NWidContainerFlag::EqualSize),
          NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_GL_GROUP_BY_ORDER), SetFill(1, 1), SetMinimalSize(0, 12), SetStringTip(STR_STATION_VIEW_GROUP, STR_TOOLTIP_GROUP_ORDER),
          NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_GL_SORT_BY_ORDER), SetFill(1, 1), SetMinimalSize(0, 12), SetStringTip(STR_BUTTON_SORT_BY, STR_TOOLTIP_SORT_ORDER),
        EndContainer(),
        NWidget(NWID_VERTICAL, NWidContainerFlag::EqualSize),
          NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_GL_GROUP_BY_DROPDOWN), SetFill(1, 1), SetMinimalSize(0, 12), SetToolTip(STR_TOOLTIP_GROUP_ORDER),
          NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_GL_SORT_BY_DROPDOWN), SetFill(1, 1), SetMinimalSize(0, 12), SetToolTip(STR_TOOLTIP_SORT_CRITERIA),
        EndContainer(),
        NWidget(NWID_VERTICAL, NWidContainerFlag::EqualSize),
          NWidget(WWT_PANEL, COLOUR_GREY), SetMinimalTextLines(1, WidgetDimensions::unscaled.framerect.Vertical()), SetFill(0, 1), SetResize(1, 0), EndContainer(),
          NWidget(NWID_HORIZONTAL),
            NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_GL_FILTER_BY_CARGO), SetMinimalSize(0, 12), SetFill(0, 1), SetToolTip(STR_TOOLTIP_FILTER_CRITERIA),
            NWidget(WWT_PANEL, COLOUR_GREY), SetMinimalSize(0, 12), SetFill(0, 1), SetResize(1, 0), EndContainer(),
          EndContainer(),
        EndContainer(),
      EndContainer(),
      NWidget(NWID_HORIZONTAL),
        NWidget(WWT_MATRIX, COLOUR_GREY, WID_GL_LIST_VEHICLE), SetMinimalSize(248, 0), SetMatrixDataTip(1, 0), SetResize(1, 1), SetFill(1, 0), SetScrollbar(WID_GL_LIST_VEHICLE_SCROLLBAR),
        NWidget(NWID_VSCROLLBAR, COLOUR_GREY, WID_GL_LIST_VEHICLE_SCROLLBAR),
      EndContainer(),
      NWidget(WWT_PANEL, COLOUR_GREY), SetMinimalSize(1, 0), SetFill(1, 1), SetResize(1, 0), EndContainer(),
      NWidget(NWID_HORIZONTAL),
        NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_GL_AVAILABLE_VEHICLES), SetMinimalSize(106, 12),
            SetToolTip(STR_VEHICLE_LIST_AVAILABLE_ENGINES_TOOLTIP),
        NWidget(WWT_PANEL, COLOUR_GREY), SetMinimalSize(0, 12), SetFill(1, 0), SetResize(1, 0), EndContainer(),
        NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_GL_MANAGE_VEHICLES_DROPDOWN), SetMinimalSize(118, 12),
            SetStringTip(STR_VEHICLE_LIST_MANAGE_LIST, STR_VEHICLE_LIST_MANAGE_LIST_TOOLTIP),
        NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_GL_STOP_ALL), SetAspect(WidgetDimensions::ASPECT_VEHICLE_FLAG),
            SetSpriteTip(SPR_FLAG_VEH_STOPPED, STR_VEHICLE_LIST_MASS_STOP_LIST_TOOLTIP),
        NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_GL_START_ALL), SetAspect(WidgetDimensions::ASPECT_VEHICLE_FLAG),
            SetSpriteTip(SPR_FLAG_VEH_RUNNING, STR_VEHICLE_LIST_MASS_START_LIST_TOOLTIP),
        NWidget(WWT_RESIZEBOX, COLOUR_GREY),
      EndContainer(),
    EndContainer(),
  EndContainer(),
};
 
static void SortGUIGroupList(std::vector<GUIGroupListItem> &list)
{
  /* Sort the groups by their name */
  std::array<std::pair<const Group *, std::string>, 2> last_group{};
 
  std::ranges::sort(list, [&last_group](const GUIGroupListItem &a, const GUIGroupListItem &b) -> bool {
    if (a.group != last_group[0].first) {
      last_group[0] = {a.group, GetString(STR_GROUP_NAME, a.group->index)};
    }
 
    if (b.group != last_group[1].first) {
      last_group[1] = {b.group, GetString(STR_GROUP_NAME, b.group->index)};
    }
 
    int r = StrNaturalCompare(last_group[0].second, last_group[1].second); // Sort by name (natural sorting).
    if (r == 0) return a.group->number < b.group->number;
    return r < 0;
  });
}
 
static void GuiGroupListAddChildren(GUIGroupList &list, GUIGroupListItem &item, bool fold, uint8_t indent = 1)
{
  if (fold && item.group->folded) {
    Group::Get(item.group->index)->folded = !item.group->children.empty();
    return;
  }
 
  if (item.group->children.empty()) return;
 
  std::vector<GUIGroupListItem> sublist;
  for (const GroupID &group : item.group->children) {
    sublist.emplace_back(Group::Get(group), indent);
  }
  SortGUIGroupList(sublist);
 
  for (const GUIGroupListItem &subitem : sublist) {
    GuiGroupListAddChildren(list, list.emplace_back(subitem), fold, indent + 1);
  }
}
 
void BuildGuiGroupList(GUIGroupList &list, bool fold, Owner owner, VehicleType veh_type)
{
  /* Make a temporary list of parent groups */
  std::vector<GUIGroupListItem> sublist;
  for (const Group *g : Group::Iterate()) {
    if (g->parent != GroupID::Invalid()) continue;
    if (g->owner != owner) continue;
    if (g->vehicle_type != veh_type) continue;
    sublist.emplace_back(g, 0);
  }
  SortGUIGroupList(sublist);
 
  /* Now add each parent group, and its children if necessary, to the list. */
  for (auto &item : sublist) {
    GuiGroupListAddChildren(list, list.emplace_back(item), fold);
  }
 
  if (list.empty()) return;
 
  /* Hierarchy is complete, traverse in reverse to find where indentation levels continue. */
  uint16_t level_mask = 0;
  for (auto it = std::rbegin(list); std::next(it) != std::rend(list); ++it) {
    auto next_it = std::next(it);
    AssignBit(level_mask, it->indent, it->indent <= next_it->indent);
    next_it->level_mask = level_mask;
  }
}
 
/* Columns in the group list */
enum VehicleGroupColumns : uint8_t {
  VGC_FOLD,          
  VGC_NAME,          
  VGC_PROTECT,       
  VGC_AUTOREPLACE,   
  VGC_PROFIT,        
  VGC_NUMBER,        
 
  VGC_END
};
DECLARE_INCREMENT_DECREMENT_OPERATORS(VehicleGroupColumns);
 
class VehicleGroupWindow : public BaseVehicleListWindow {
private:
  GroupID group_sel = GroupID::Invalid(); 
  GroupID group_rename = GroupID::Invalid(); 
  GroupID group_over = GroupID::Invalid(); 
  GroupID group_confirm = GroupID::Invalid(); 
  GUIGroupList groups{}; 
  uint tiny_step_height = 0; 
  Scrollbar *group_sb = nullptr;
 
  std::array<Dimension, VGC_END> column_size{}; 
  std::array<Rect, VGC_END> column_rects{};
  bool last_overlay_state = false;
 
  void BuildGroupList(Owner owner)
  {
    if (!this->groups.NeedRebuild()) return;
 
    this->groups.clear();
 
    BuildGuiGroupList(this->groups, true, owner, this->vli.vtype);
 
    this->groups.RebuildDone();
  }
 
  uint ComputeGroupInfoSize()
  {
    this->column_size[VGC_FOLD] = maxdim(GetScaledSpriteSize(SPR_CIRCLE_FOLDED), GetScaledSpriteSize(SPR_CIRCLE_UNFOLDED));
    this->tiny_step_height = this->column_size[VGC_FOLD].height;
 
    this->column_size[VGC_NAME] = maxdim(GetStringBoundingBox(STR_GROUP_DEFAULT_TRAINS + this->vli.vtype), GetStringBoundingBox(STR_GROUP_ALL_TRAINS + this->vli.vtype));
    this->column_size[VGC_NAME].width = std::max(170u, this->column_size[VGC_NAME].width) + WidgetDimensions::scaled.hsep_indent;
    this->tiny_step_height = std::max(this->tiny_step_height, this->column_size[VGC_NAME].height);
 
    this->column_size[VGC_PROTECT] = GetScaledSpriteSize(SPR_GROUP_REPLACE_PROTECT);
    this->tiny_step_height = std::max(this->tiny_step_height, this->column_size[VGC_PROTECT].height);
 
    this->column_size[VGC_AUTOREPLACE] = GetScaledSpriteSize(SPR_GROUP_REPLACE_ACTIVE);
    this->tiny_step_height = std::max(this->tiny_step_height, this->column_size[VGC_AUTOREPLACE].height);
 
    this->column_size[VGC_PROFIT].width = 0;
    this->column_size[VGC_PROFIT].height = 0;
    static const SpriteID profit_sprites[] = {SPR_PROFIT_NA, SPR_PROFIT_NEGATIVE, SPR_PROFIT_SOME, SPR_PROFIT_LOT};
    for (const auto &profit_sprite : profit_sprites) {
      Dimension d = GetScaledSpriteSize(profit_sprite);
      this->column_size[VGC_PROFIT] = maxdim(this->column_size[VGC_PROFIT], d);
    }
    this->tiny_step_height = std::max(this->tiny_step_height, this->column_size[VGC_PROFIT].height);
 
    int num_vehicle = GetGroupNumVehicle(this->vli.company, ALL_GROUP, this->vli.vtype);
    uint64_t max_value = GetParamMaxValue(num_vehicle, 3, FS_SMALL);
    this->column_size[VGC_NUMBER] = GetStringBoundingBox(GetString(STR_GROUP_COUNT_WITH_SUBGROUP, max_value, max_value));
    this->tiny_step_height = std::max(this->tiny_step_height, this->column_size[VGC_NUMBER].height);
 
    this->tiny_step_height += WidgetDimensions::scaled.framerect.Vertical();
 
    return WidgetDimensions::scaled.framerect.left +
      this->column_size[VGC_FOLD].width + WidgetDimensions::scaled.hsep_normal +
      this->column_size[VGC_NAME].width + WidgetDimensions::scaled.hsep_wide +
      this->column_size[VGC_PROTECT].width + WidgetDimensions::scaled.hsep_normal +
      this->column_size[VGC_AUTOREPLACE].width + WidgetDimensions::scaled.hsep_normal +
      this->column_size[VGC_PROFIT].width + WidgetDimensions::scaled.hsep_normal +
      this->column_size[VGC_NUMBER].width +
      WidgetDimensions::scaled.framerect.right;
  }
 
  void UpdateColumnRects()
  {
    bool rtl = _current_text_dir == TD_RTL;
    Rect r = this->GetWidget<NWidgetCore>(WID_GL_LIST_GROUP)->GetCurrentRect().Shrink(WidgetDimensions::scaled.framerect);
 
    /* Place columns before VGC_NAME from start to end. */
    for (VehicleGroupColumns lc{}; lc != VGC_NAME; ++lc) {
      this->column_rects[lc] = r.WithWidth(this->column_size[lc].width, rtl);
      r = r.Indent(this->column_size[lc].width + WidgetDimensions::scaled.hsep_normal, rtl);
    }
    /* Place columns after VGC_NAME from end to start. */
    for (VehicleGroupColumns lc{VGC_END - 1}; lc != VGC_NAME; --lc) {
      this->column_rects[lc] = r.WithWidth(this->column_size[lc].width, !rtl);
      r = r.Indent(this->column_size[lc].width + WidgetDimensions::scaled.hsep_normal, !rtl);
    }
    /* Name column fills remaining space. */
    this->column_rects[VGC_NAME] = r;
  }
 
  std::string GetGroupNameString(GroupID g_id) const
  {
    if (IsAllGroupID(g_id)) return GetString(STR_GROUP_ALL_TRAINS + this->vli.vtype);
    if (IsDefaultGroupID(g_id)) return GetString(STR_GROUP_DEFAULT_TRAINS + this->vli.vtype);
    return GetString(STR_GROUP_NAME, g_id);
  }
 
  SpriteID GetGroupProfitSpriteID(GroupID g_id) const
  {
    uint num_vehicle_min_age = GetGroupNumVehicleMinAge(this->vli.company, g_id, this->vli.vtype);
    if (num_vehicle_min_age == 0) return SPR_PROFIT_NA;
 
    Money profit_last_year_min_age = GetGroupProfitLastYearMinAge(this->vli.company, g_id, this->vli.vtype);
    if (profit_last_year_min_age < 0) return SPR_PROFIT_NEGATIVE;
    if (profit_last_year_min_age < VEHICLE_PROFIT_THRESHOLD * num_vehicle_min_age) return SPR_PROFIT_SOME;
    return SPR_PROFIT_LOT;
  }
 
  void DrawGroupInfo(Rect r, GroupID g_id, uint16_t level_mask = 0, uint8_t indent = 0, bool protection = false, bool has_children = false) const
  {
    /* Highlight the group if a vehicle is dragged over it */
    if (g_id == this->group_over) {
      GfxFillRect(r.Shrink(WidgetDimensions::scaled.bevel), GetColourGradient(COLOUR_GREY, SHADE_LIGHTEST));
    }
 
    if (g_id == NEW_GROUP) return;
 
    /* draw the selected group in white, else we draw it in black */
    TextColour colour = g_id == this->vli.ToGroupID() ? TC_WHITE : TC_BLACK;
    const GroupStatistics &stats = GroupStatistics::Get(this->vli.company, g_id, this->vli.vtype);
    bool rtl = _current_text_dir == TD_RTL;
 
    const int offset = (rtl ? -(int)this->column_size[VGC_FOLD].width : (int)this->column_size[VGC_FOLD].width) / 2;
    const int level_width = rtl ? -WidgetDimensions::scaled.hsep_indent : WidgetDimensions::scaled.hsep_indent;
    const PixelColour linecolour = GetColourGradient(COLOUR_ORANGE, SHADE_NORMAL);
 
    r = r.Shrink(WidgetDimensions::scaled.framerect, RectPadding::zero);
    if (indent > 0) {
      /* Draw tree continuation lines. */
      int tx = (rtl ? r.right : r.left) + offset;
      for (uint lvl = 1; lvl <= indent; ++lvl) {
        if (HasBit(level_mask, lvl)) GfxDrawLine(tx, r.top, tx, r.bottom, linecolour, WidgetDimensions::scaled.fullbevel.top);
        if (lvl < indent) tx += level_width;
      }
      /* Draw our node in the tree. */
      int ycentre = CentreBounds(r.top, r.bottom, WidgetDimensions::scaled.fullbevel.top);
      if (!HasBit(level_mask, indent)) GfxDrawLine(tx, r.top, tx, ycentre, linecolour, WidgetDimensions::scaled.fullbevel.top);
      GfxDrawLine(tx, ycentre, tx + offset - (rtl ? -1 : 1), ycentre, linecolour, WidgetDimensions::scaled.fullbevel.top);
    }
 
    /* draw fold / unfold button */
    if (has_children) {
      DrawSpriteIgnorePadding(Group::Get(g_id)->folded ? SPR_CIRCLE_FOLDED : SPR_CIRCLE_UNFOLDED, PAL_NONE, r.WithX(this->column_rects[VGC_FOLD]).Translate(indent * level_width, 0), SA_CENTER);
    }
 
    /* draw group name */
    DrawString(r.WithX(this->column_rects[VGC_NAME]).Indent(indent * WidgetDimensions::scaled.hsep_indent, rtl).CentreToHeight(this->column_size[VGC_NAME].height), this->GetGroupNameString(g_id), colour);
 
    /* draw autoreplace protection */
    if (protection) {
      DrawSpriteIgnorePadding(SPR_GROUP_REPLACE_PROTECT, PAL_NONE, r.WithX(this->column_rects[VGC_PROTECT]), SA_CENTER);
    }
 
    /* draw autoreplace status */
    if (stats.autoreplace_defined) {
      DrawSpriteIgnorePadding(SPR_GROUP_REPLACE_ACTIVE, stats.autoreplace_finished ? PALETTE_CRASH : PAL_NONE, r.WithX(this->column_rects[VGC_AUTOREPLACE]), SA_CENTER);
    }
 
    /* draw the profit icon */
    DrawSpriteIgnorePadding(this->GetGroupProfitSpriteID(g_id), PAL_NONE, r.WithX(this->column_rects[VGC_PROFIT]), SA_CENTER);
 
    /* draw the number of vehicles of the group */
    int num_vehicle_with_subgroups = GetGroupNumVehicle(this->vli.company, g_id, this->vli.vtype);
    int num_vehicle = GroupStatistics::Get(this->vli.company, g_id, this->vli.vtype).num_vehicle;
    if (IsAllGroupID(g_id) || IsDefaultGroupID(g_id) || num_vehicle_with_subgroups == num_vehicle) {
      DrawString(r.WithX(this->column_rects[VGC_NUMBER]).CentreToHeight(this->column_size[VGC_NUMBER].height), GetString(STR_JUST_COMMA, num_vehicle), colour, SA_RIGHT | SA_FORCE, false, FS_SMALL);
    } else {
      DrawString(r.WithX(this->column_rects[VGC_NUMBER]).CentreToHeight(this->column_size[VGC_NUMBER].height), GetString(STR_GROUP_COUNT_WITH_SUBGROUP, num_vehicle, num_vehicle_with_subgroups - num_vehicle), colour, SA_RIGHT | SA_FORCE);
    }
  }
 
  void DirtyHighlightedGroupWidget()
  {
    if (this->group_over == GroupID::Invalid()) return;
 
    if (IsAllGroupID(this->group_over)) {
      this->SetWidgetDirty(WID_GL_ALL_VEHICLES);
    } else if (IsDefaultGroupID(this->group_over)) {
      this->SetWidgetDirty(WID_GL_DEFAULT_VEHICLES);
    } else {
      this->SetWidgetDirty(WID_GL_LIST_GROUP);
    }
  }
 
public:
  VehicleGroupWindow(WindowDesc &desc, WindowNumber window_number, const VehicleListIdentifier &vli) : BaseVehicleListWindow(desc, vli)
  {
    this->CreateNestedTree();
 
    this->vscroll = this->GetScrollbar(WID_GL_LIST_VEHICLE_SCROLLBAR);
    this->group_sb = this->GetScrollbar(WID_GL_LIST_GROUP_SCROLLBAR);
 
    this->vli.SetIndex(ALL_GROUP);
 
    this->groups.ForceRebuild();
    this->groups.NeedResort();
    this->BuildGroupList(vli.company);
    this->group_sb->SetCount(this->groups.size());
 
    this->GetWidget<NWidgetCore>(WID_GL_CAPTION)->SetString(STR_VEHICLE_LIST_TRAIN_CAPTION + this->vli.vtype);
    this->GetWidget<NWidgetCore>(WID_GL_LIST_VEHICLE)->SetToolTip(STR_VEHICLE_LIST_TRAIN_LIST_TOOLTIP + this->vli.vtype);
 
    this->GetWidget<NWidgetCore>(WID_GL_CREATE_GROUP)->SetSprite(SPR_GROUP_CREATE_TRAIN + this->vli.vtype);
    this->GetWidget<NWidgetCore>(WID_GL_RENAME_GROUP)->SetSprite(SPR_GROUP_RENAME_TRAIN + this->vli.vtype);
    this->GetWidget<NWidgetCore>(WID_GL_DELETE_GROUP)->SetSprite(SPR_GROUP_DELETE_TRAIN + this->vli.vtype);
    this->GetWidget<NWidgetCore>(WID_GL_LIVERY_GROUP)->SetSprite(SPR_GROUP_LIVERY_TRAIN + this->vli.vtype);
    this->GetWidget<NWidgetCore>(WID_GL_REPLACE_PROTECTION)->SetSprite(SPR_GROUP_REPLACE_OFF_TRAIN + this->vli.vtype);
 
    this->FinishInitNested(window_number);
    this->owner = vli.company;
 
    this->BuildVehicleList();
    this->SortVehicleList();
  }
 
  ~VehicleGroupWindow()
  {
    *this->sorting = this->vehgroups.GetListing();
  }
 
  void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
  {
    switch (widget) {
      case WID_GL_LIST_GROUP:
        size.width = this->ComputeGroupInfoSize();
        fill.height = resize.height = this->tiny_step_height;
        break;
 
      case WID_GL_ALL_VEHICLES:
      case WID_GL_DEFAULT_VEHICLES:
        size.width = this->ComputeGroupInfoSize();
        size.height = this->tiny_step_height;
        break;
 
      case WID_GL_INFO: {
        uint left_side = 0;
        for (const StringID &label : {STR_GROUP_PROFIT_THIS_PERIOD, STR_GROUP_PROFIT_THIS_YEAR, STR_GROUP_PROFIT_LAST_PERIOD, STR_GROUP_PROFIT_LAST_YEAR, STR_GROUP_OCCUPANCY}) {
          left_side = std::max(left_side, GetStringBoundingBox(label).width);
        }
 
        /* Guestimate that 12 digits is reasonable*/
        uint right_side = std::max(
          GetStringBoundingBox(GetString(STR_GROUP_OCCUPANCY_VALUE, GetParamMaxDigits(3))).width,
          GetStringBoundingBox(GetString(STR_JUST_CURRENCY_LONG, GetParamMaxDigits(12))).width
        );
 
        size.width = left_side + WidgetDimensions::scaled.hsep_wide + right_side + padding.width;
        break;
      }
 
      case WID_GL_SORT_BY_ORDER: {
        Dimension d = GetStringBoundingBox(this->GetWidget<NWidgetCore>(widget)->GetString());
        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_GL_LIST_VEHICLE:
        this->ComputeGroupInfoSize();
        fill.height = resize.height = GetVehicleListHeight(this->vli.vtype, this->tiny_step_height);
        size.height = 4 * resize.height;
        break;
 
      case WID_GL_GROUP_BY_DROPDOWN:
        size.width = GetStringListWidth(this->vehicle_group_by_names) + padding.width;
        break;
 
      case WID_GL_SORT_BY_DROPDOWN:
        size.width = GetStringListWidth(this->vehicle_group_none_sorter_names_calendar);
        size.width = std::max(size.width, GetStringListWidth(this->vehicle_group_none_sorter_names_wallclock));
        size.width = std::max(size.width, GetStringListWidth(this->vehicle_group_shared_orders_sorter_names_calendar));
        size.width = std::max(size.width, GetStringListWidth(this->vehicle_group_shared_orders_sorter_names_wallclock));
        size.width += padding.width;
        break;
 
      case WID_GL_FILTER_BY_CARGO:
        size.width = std::max(size.width, GetDropDownListDimension(this->BuildCargoDropDownList(true)).width + padding.width);
        break;
 
      case WID_GL_MANAGE_VEHICLES_DROPDOWN: {
        Dimension d = this->GetActionDropdownSize(true, true, true);
        d.height += padding.height;
        d.width  += padding.width;
        size = maxdim(size, d);
        break;
      }
    }
  }
 
  void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
  {
    if (data == 0) {
      /* This needs to be done in command-scope to enforce rebuilding before resorting invalid data */
      this->vehgroups.ForceRebuild();
      this->groups.ForceRebuild();
    } else {
      this->vehgroups.ForceResort();
      this->groups.ForceResort();
    }
 
    /* Process ID-invalidation in command-scope as well */
    if (this->group_rename != GroupID::Invalid() && !Group::IsValidID(this->group_rename)) {
      CloseWindowByClass(WC_QUERY_STRING);
      this->group_rename = GroupID::Invalid();
    }
 
    GroupID group = this->vli.ToGroupID();
    if (!(IsAllGroupID(group) || IsDefaultGroupID(group) || Group::IsValidID(group))) {
      this->vli.SetIndex(ALL_GROUP);
      this->CloseChildWindows(WC_DROPDOWN_MENU);
    }
    this->SetDirty();
  }
 
  std::string GetWidgetString(WidgetID widget, StringID stringid) const override
  {
    switch (widget) {
      case WID_GL_FILTER_BY_CARGO:
        return GetString(this->GetCargoFilterLabel(this->cargo_filter_criteria));
 
      case WID_GL_AVAILABLE_VEHICLES:
        return GetString(STR_VEHICLE_LIST_AVAILABLE_TRAINS + this->vli.vtype);
 
      case WID_GL_CAPTION:
        /* If selected_group == DEFAULT_GROUP || ALL_GROUP, draw the standard caption
         * We list all vehicles or ungrouped vehicles */
        if (IsDefaultGroupID(this->vli.ToGroupID()) || IsAllGroupID(this->vli.ToGroupID())) {
          return GetString(stringid, STR_COMPANY_NAME, this->vli.company, this->vehicles.size(), this->vehicles.size());
        } else {
          uint num_vehicle = GetGroupNumVehicle(this->vli.company, this->vli.ToGroupID(), this->vli.vtype);
 
          return GetString(stringid, STR_GROUP_NAME, this->vli.ToGroupID(), num_vehicle, num_vehicle);
        }
 
      default:
        return this->Window::GetWidgetString(widget, stringid);
    }
  }
 
  void OnPaint() override
  {
    /* If we select the all vehicles, this->list will contain all vehicles of the owner
     * else this->list will contain all vehicles which belong to the selected group */
    this->BuildVehicleList();
    this->SortVehicleList();
 
    this->BuildGroupList(this->owner);
 
    this->group_sb->SetCount(this->groups.size());
    this->vscroll->SetCount(this->vehgroups.size());
 
    /* The drop down menu is out, *but* it may not be used, retract it. */
    if (this->vehicles.empty() && this->IsWidgetLowered(WID_GL_MANAGE_VEHICLES_DROPDOWN)) {
      this->RaiseWidget(WID_GL_MANAGE_VEHICLES_DROPDOWN);
      this->CloseChildWindows(WC_DROPDOWN_MENU);
    }
 
    /* Disable all lists management button when the list is empty */
    this->SetWidgetsDisabledState(this->vehicles.empty() || _local_company != this->vli.company,
        WID_GL_STOP_ALL,
        WID_GL_START_ALL,
        WID_GL_MANAGE_VEHICLES_DROPDOWN);
 
    /* Disable the group specific function when we select the default group or all vehicles */
    GroupID group = this->vli.ToGroupID();
    this->SetWidgetsDisabledState(IsDefaultGroupID(group) || IsAllGroupID(group) || _local_company != this->vli.company,
        WID_GL_DELETE_GROUP,
        WID_GL_RENAME_GROUP,
        WID_GL_LIVERY_GROUP,
        WID_GL_REPLACE_PROTECTION);
 
    /* Disable remaining buttons for non-local companies
     * Needed while changing _local_company, eg. by cheats
     * All procedures (eg. move vehicle to another group)
     *  verify, whether you are the owner of the vehicle,
     *  so it doesn't have to be disabled
     */
    this->SetWidgetsDisabledState(_local_company != this->vli.company,
        WID_GL_CREATE_GROUP,
        WID_GL_AVAILABLE_VEHICLES);
 
    /* If not a default group and the group has replace protection, show an enabled replace sprite. */
    uint16_t protect_sprite = SPR_GROUP_REPLACE_OFF_TRAIN;
    if (!IsDefaultGroupID(group) && !IsAllGroupID(group) && Group::Get(group)->flags.Test(GroupFlag::ReplaceProtection)) protect_sprite = SPR_GROUP_REPLACE_ON_TRAIN;
    this->GetWidget<NWidgetCore>(WID_GL_REPLACE_PROTECTION)->SetSprite(protect_sprite + this->vli.vtype);
 
    /* Set text of "group by" dropdown widget. */
    this->GetWidget<NWidgetCore>(WID_GL_GROUP_BY_DROPDOWN)->SetString(std::data(this->vehicle_group_by_names)[this->grouping]);
 
    /* Set text of "sort by" dropdown widget. */
    this->GetWidget<NWidgetCore>(WID_GL_SORT_BY_DROPDOWN)->SetString(this->GetVehicleSorterNames()[this->vehgroups.SortType()]);
 
    this->DrawWidgets();
  }
 
  void DrawWidget(const Rect &r, WidgetID widget) const override
  {
    switch (widget) {
      case WID_GL_ALL_VEHICLES:
        DrawGroupInfo(r, ALL_GROUP);
        break;
 
      case WID_GL_DEFAULT_VEHICLES:
        DrawGroupInfo(r, DEFAULT_GROUP);
        break;
 
      case WID_GL_INFO: {
        Money this_year = 0;
        Money last_year = 0;
        uint64_t occupancy = 0;
 
        for (const Vehicle * const v : this->vehicles) {
          assert(v->owner == this->owner);
 
          this_year += v->GetDisplayProfitThisYear();
          last_year += v->GetDisplayProfitLastYear();
          occupancy += v->trip_occupancy;
        }
 
        Rect tr = r.Shrink(WidgetDimensions::scaled.framerect);
 
        DrawString(tr, TimerGameEconomy::UsingWallclockUnits() ? STR_GROUP_PROFIT_THIS_PERIOD : STR_GROUP_PROFIT_THIS_YEAR, TC_BLACK);
        DrawString(tr, GetString(STR_JUST_CURRENCY_LONG, this_year), TC_BLACK, SA_RIGHT);
 
        tr.top += GetCharacterHeight(FS_NORMAL);
        DrawString(tr, TimerGameEconomy::UsingWallclockUnits() ? STR_GROUP_PROFIT_LAST_PERIOD : STR_GROUP_PROFIT_LAST_YEAR, TC_BLACK);
        DrawString(tr, GetString(STR_JUST_CURRENCY_LONG, last_year), TC_BLACK, SA_RIGHT);
 
        tr.top += GetCharacterHeight(FS_NORMAL);
        DrawString(tr, STR_GROUP_OCCUPANCY, TC_BLACK);
        const size_t vehicle_count = this->vehicles.size();
        if (vehicle_count > 0) {
          DrawString(tr, GetString(STR_GROUP_OCCUPANCY_VALUE, occupancy / vehicle_count), TC_BLACK, SA_RIGHT);
        }
 
        break;
      }
 
      case WID_GL_LIST_GROUP: {
        Rect row = r.WithHeight(this->tiny_step_height);
 
        auto [first, last] = this->group_sb->GetVisibleRangeIterators(this->groups);
        for (auto it = first; it != last; ++it) {
          const Group *g = it->group;
          assert(g->owner == this->owner);
 
          DrawGroupInfo(row, g->index, it->level_mask, it->indent, g->flags.Test(GroupFlag::ReplaceProtection), g->folded || (std::next(it) != std::end(this->groups) && std::next(it)->indent > it->indent));
          row = row.Translate(0, this->tiny_step_height);
        }
        if ((uint)this->group_sb->GetPosition() + this->group_sb->GetCapacity() > this->groups.size()) {
          DrawGroupInfo(row, NEW_GROUP);
        }
        break;
      }
 
      case WID_GL_SORT_BY_ORDER:
        this->DrawSortButtonState(WID_GL_SORT_BY_ORDER, this->vehgroups.IsDescSortOrder() ? SBS_DOWN : SBS_UP);
        break;
 
      case WID_GL_LIST_VEHICLE:
        if (this->vli.ToGroupID() != ALL_GROUP && this->grouping == GB_NONE) {
          /* Mark vehicles which are in sub-groups (only if we are not using shared order coalescing) */
          Rect mr = r.WithHeight(this->resize.step_height);
          auto [first, last] = this->vscroll->GetVisibleRangeIterators(this->vehgroups);
          for (auto it = first; it != last; ++it) {
            const Vehicle *v = it->GetSingleVehicle();
            if (v->group_id != this->vli.ToGroupID()) {
              GfxFillRect(mr.Shrink(WidgetDimensions::scaled.bevel), GetColourGradient(COLOUR_GREY, SHADE_DARK), FILLRECT_CHECKER);
            }
            mr = mr.Translate(0, this->resize.step_height);
          }
        }
 
        this->DrawVehicleListItems(this->vehicle_sel, this->resize.step_height, r);
        break;
    }
  }
 
  static void DeleteGroupCallback(Window *win, bool confirmed)
  {
    if (confirmed) {
      VehicleGroupWindow *w = (VehicleGroupWindow*)win;
      w->vli.SetIndex(ALL_GROUP);
      Command<CMD_DELETE_GROUP>::Post(STR_ERROR_GROUP_CAN_T_DELETE, w->group_confirm);
    }
  }
 
  void OnMouseLoop() override
  {
    if (last_overlay_state != ShowCargoIconOverlay()) {
      last_overlay_state = ShowCargoIconOverlay();
      this->SetDirty();
    }
  }
 
  void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
  {
    switch (widget) {
      case WID_GL_SORT_BY_ORDER: // Flip sorting method ascending/descending
        this->vehgroups.ToggleSortOrder();
        this->SetDirty();
        break;
 
      case WID_GL_GROUP_BY_DROPDOWN: // Select grouping option dropdown menu
        ShowDropDownMenu(this, this->vehicle_group_by_names, this->grouping, WID_GL_GROUP_BY_DROPDOWN, 0, 0);
        return;
 
      case WID_GL_SORT_BY_DROPDOWN: // Select sorting criteria dropdown menu
        ShowDropDownMenu(this, this->GetVehicleSorterNames(), this->vehgroups.SortType(),  WID_GL_SORT_BY_DROPDOWN, 0, (this->vli.vtype == VEH_TRAIN || this->vli.vtype == VEH_ROAD) ? 0 : (1 << 10));
        return;
 
      case WID_GL_FILTER_BY_CARGO: // Select filtering criteria dropdown menu
        ShowDropDownList(this, this->BuildCargoDropDownList(false), this->cargo_filter_criteria, widget);
        break;
 
      case WID_GL_ALL_VEHICLES: // All vehicles button
        if (!IsAllGroupID(this->vli.ToGroupID())) {
          this->vli.SetIndex(ALL_GROUP);
          this->vehgroups.ForceRebuild();
          this->SetDirty();
        }
        break;
 
      case WID_GL_DEFAULT_VEHICLES: // Ungrouped vehicles button
        if (!IsDefaultGroupID(this->vli.ToGroupID())) {
          this->vli.SetIndex(DEFAULT_GROUP);
          this->vehgroups.ForceRebuild();
          this->SetDirty();
        }
        break;
 
      case WID_GL_LIST_GROUP: { // Matrix Group
        auto it = this->group_sb->GetScrolledItemFromWidget(this->groups, pt.y, this, WID_GL_LIST_GROUP);
        if (it == this->groups.end()) return;
 
        if (it->group->folded || (std::next(it) != std::end(this->groups) && std::next(it)->indent > it->indent)) {
          /* The group has children, check if the user clicked the fold / unfold button. */
          bool rtl = _current_text_dir == TD_RTL;
          Rect r = this->GetWidget<NWidgetCore>(widget)->GetCurrentRect().Shrink(WidgetDimensions::scaled.framerect, RectPadding::zero);
          r = r.Indent(it->indent * WidgetDimensions::scaled.hsep_indent, rtl).WithWidth(this->column_size[VGC_FOLD].width, rtl);
          if (click_count > 1 || r.Contains(pt)) {
 
            GroupID g = this->vli.ToGroupID();
            if (!IsAllGroupID(g) && !IsDefaultGroupID(g)) {
              do {
                g = Group::Get(g)->parent;
                if (g == it->group->index) {
                  this->vli.SetIndex(g);
                  break;
                }
              } while (g != GroupID::Invalid());
            }
 
            Group::Get(it->group->index)->folded = !it->group->folded;
            this->groups.ForceRebuild();
 
            this->SetDirty();
            break;
          }
        }
 
        this->vli.SetIndex(it->group->index);
        this->group_sel = it->group->index;
 
        SetObjectToPlaceWnd(SPR_CURSOR_MOUSE, PAL_NONE, HT_DRAG, this);
 
        this->vehgroups.ForceRebuild();
        this->SetDirty();
        break;
      }
 
      case WID_GL_LIST_VEHICLE: { // Matrix Vehicle
        auto it = this->vscroll->GetScrolledItemFromWidget(this->vehgroups, pt.y, this, WID_GL_LIST_VEHICLE);
        if (it == this->vehgroups.end()) return; // click out of list bound
 
        const GUIVehicleGroup &vehgroup = *it;
 
        const Vehicle *v = nullptr;
 
        switch (this->grouping) {
          case GB_NONE: {
            const Vehicle *v2 = vehgroup.GetSingleVehicle();
            if (VehicleClicked(v2)) break;
            v = v2;
            break;
          }
 
          case GB_SHARED_ORDERS: {
            assert(vehgroup.NumVehicles() > 0);
            v = vehgroup.vehicles_begin[0];
            /*
             * No VehicleClicked(v) support for now, because don't want
             * to enable any contextual actions except perhaps clicking/ctrl-clicking to clone orders.
             */
            break;
          }
 
          default:
            NOT_REACHED();
        }
        if (v) {
          if (_ctrl_pressed && this->grouping == GB_SHARED_ORDERS) {
            ShowOrdersWindow(v);
          } else {
            this->vehicle_sel = v->index;
 
            if (_ctrl_pressed && this->grouping == GB_NONE) {
              /*
               * It only makes sense to select a group if not using shared orders
               * since two vehicles sharing orders can be from different groups.
               */
              this->SelectGroup(v->group_id);
            }
 
            SetObjectToPlaceWnd(SPR_CURSOR_MOUSE, PAL_NONE, HT_DRAG, this);
            SetMouseCursorVehicle(v, EIT_IN_LIST);
            _cursor.vehchain = true;
 
            this->SetDirty();
          }
        }
 
        break;
      }
 
      case WID_GL_CREATE_GROUP: { // Create a new group
        Command<CMD_CREATE_GROUP>::Post(STR_ERROR_GROUP_CAN_T_CREATE, CcCreateGroup, this->vli.vtype, this->vli.ToGroupID());
        break;
      }
 
      case WID_GL_DELETE_GROUP: { // Delete the selected group
        this->group_confirm = this->vli.ToGroupID();
        ShowQuery(
          GetEncodedString(STR_QUERY_GROUP_DELETE_CAPTION),
          GetEncodedString(STR_GROUP_DELETE_QUERY_TEXT),
          this, DeleteGroupCallback);
        break;
      }
 
      case WID_GL_RENAME_GROUP: // Rename the selected roup
        this->ShowRenameGroupWindow(this->vli.ToGroupID(), false);
        break;
 
      case WID_GL_LIVERY_GROUP: // Set group livery
        ShowCompanyLiveryWindow(this->owner, this->vli.ToGroupID());
        break;
 
      case WID_GL_AVAILABLE_VEHICLES:
        ShowBuildVehicleWindow(INVALID_TILE, this->vli.vtype);
        break;
 
      case WID_GL_MANAGE_VEHICLES_DROPDOWN: {
        ShowDropDownList(this, this->BuildActionDropdownList(true, Group::IsValidID(this->vli.ToGroupID()), IsDefaultGroupID(this->vli.ToGroupID())), -1, WID_GL_MANAGE_VEHICLES_DROPDOWN);
        break;
      }
 
      case WID_GL_START_ALL:
      case WID_GL_STOP_ALL: { // Start/stop all vehicles of the list
        Command<CMD_MASS_START_STOP>::Post(TileIndex{}, widget == WID_GL_START_ALL, true, this->vli);
        break;
      }
 
      case WID_GL_REPLACE_PROTECTION: {
        const Group *g = Group::GetIfValid(this->vli.ToGroupID());
        if (g != nullptr) {
          Command<CMD_SET_GROUP_FLAG>::Post(this->vli.ToGroupID(), GroupFlag::ReplaceProtection, !g->flags.Test(GroupFlag::ReplaceProtection), _ctrl_pressed);
        }
        break;
      }
    }
  }
 
  void OnDragDrop_Group(Point pt, WidgetID widget)
  {
    const Group *g = Group::Get(this->group_sel);
 
    switch (widget) {
      case WID_GL_ALL_VEHICLES: // All vehicles
      case WID_GL_DEFAULT_VEHICLES: // Ungrouped vehicles
        if (g->parent != GroupID::Invalid()) {
          Command<CMD_ALTER_GROUP>::Post(STR_ERROR_GROUP_CAN_T_SET_PARENT, AlterGroupMode::SetParent, this->group_sel, GroupID::Invalid(), {});
        }
 
        this->group_sel = GroupID::Invalid();
        this->group_over = GroupID::Invalid();
        this->SetDirty();
        break;
 
      case WID_GL_LIST_GROUP: { // Matrix group
        auto it = this->group_sb->GetScrolledItemFromWidget(this->groups, pt.y, this, WID_GL_LIST_GROUP);
        GroupID new_g = it == this->groups.end() ? GroupID::Invalid() : it->group->index;
 
        if (this->group_sel != new_g && g->parent != new_g) {
          Command<CMD_ALTER_GROUP>::Post(STR_ERROR_GROUP_CAN_T_SET_PARENT, AlterGroupMode::SetParent, this->group_sel, new_g, {});
        }
 
        this->group_sel = GroupID::Invalid();
        this->group_over = GroupID::Invalid();
        this->SetDirty();
        break;
      }
    }
  }
 
  void OnDragDrop_Vehicle(Point pt, WidgetID widget)
  {
    switch (widget) {
      case WID_GL_DEFAULT_VEHICLES: // Ungrouped vehicles
        Command<CMD_ADD_VEHICLE_GROUP>::Post(STR_ERROR_GROUP_CAN_T_ADD_VEHICLE, DEFAULT_GROUP, this->vehicle_sel, _ctrl_pressed || this->grouping == GB_SHARED_ORDERS, VehicleListIdentifier{});
 
        this->vehicle_sel = VehicleID::Invalid();
        this->group_over = GroupID::Invalid();
 
        this->SetDirty();
        break;
 
      case WID_GL_LIST_GROUP: { // Matrix group
        const VehicleID vindex = this->vehicle_sel;
        this->vehicle_sel = VehicleID::Invalid();
        this->group_over = GroupID::Invalid();
        this->SetDirty();
 
        auto it = this->group_sb->GetScrolledItemFromWidget(this->groups, pt.y, this, WID_GL_LIST_GROUP);
        GroupID new_g = it == this->groups.end() ? NEW_GROUP : it->group->index;
 
        Command<CMD_ADD_VEHICLE_GROUP>::Post(STR_ERROR_GROUP_CAN_T_ADD_VEHICLE, new_g == NEW_GROUP ? CcAddVehicleNewGroup : nullptr, new_g, vindex, _ctrl_pressed || this->grouping == GB_SHARED_ORDERS, VehicleListIdentifier{});
        break;
      }
 
      case WID_GL_LIST_VEHICLE: { // Matrix vehicle
        const VehicleID vindex = this->vehicle_sel;
        this->vehicle_sel = VehicleID::Invalid();
        this->group_over = GroupID::Invalid();
        this->SetDirty();
 
        auto it = this->vscroll->GetScrolledItemFromWidget(this->vehgroups, pt.y, this, WID_GL_LIST_VEHICLE);
        if (it == this->vehgroups.end()) return; // click out of list bound
 
        const GUIVehicleGroup &vehgroup = *it;
        switch (this->grouping) {
          case GB_NONE: {
            const Vehicle *v = vehgroup.GetSingleVehicle();
            if (!VehicleClicked(v) && vindex == v->index) {
              ShowVehicleViewWindow(v);
            }
            break;
          }
 
          case GB_SHARED_ORDERS: {
            if (!VehicleClicked(vehgroup)) {
              const Vehicle *v = vehgroup.vehicles_begin[0];
              if (vindex == v->index) {
                if (vehgroup.NumVehicles() == 1) {
                  ShowVehicleViewWindow(v);
                } else {
                  ShowVehicleListWindow(v);
                }
              }
            }
            break;
          }
 
          default:
            NOT_REACHED();
        }
        break;
      }
    }
  }
 
  void OnDragDrop(Point pt, WidgetID widget) override
  {
    if (this->vehicle_sel != VehicleID::Invalid()) OnDragDrop_Vehicle(pt, widget);
    if (this->group_sel != GroupID::Invalid()) OnDragDrop_Group(pt, widget);
 
    _cursor.vehchain = false;
  }
 
  void OnQueryTextFinished(std::optional<std::string> str) override
  {
    if (str.has_value()) Command<CMD_ALTER_GROUP>::Post(STR_ERROR_GROUP_CAN_T_RENAME, AlterGroupMode::Rename, this->group_rename, GroupID::Invalid(), *str);
    this->group_rename = GroupID::Invalid();
  }
 
  void OnResize() override
  {
    this->group_sb->SetCapacityFromWidget(this, WID_GL_LIST_GROUP);
    this->vscroll->SetCapacityFromWidget(this, WID_GL_LIST_VEHICLE);
    this->UpdateColumnRects();
  }
 
  void OnDropdownSelect(WidgetID widget, int index, int) override
  {
    switch (widget) {
      case WID_GL_GROUP_BY_DROPDOWN:
        this->UpdateVehicleGroupBy(static_cast<GroupBy>(index));
        break;
 
      case WID_GL_SORT_BY_DROPDOWN:
        this->vehgroups.SetSortType(index);
        break;
 
      case WID_GL_FILTER_BY_CARGO: // Select a cargo filter criteria
        this->SetCargoFilter(index);
        break;
 
      case WID_GL_MANAGE_VEHICLES_DROPDOWN:
        assert(!this->vehicles.empty());
 
        switch (index) {
          case ADI_REPLACE: // Replace window
            ShowReplaceGroupVehicleWindow(this->vli.ToGroupID(), this->vli.vtype);
            break;
          case ADI_SERVICE: // Send for servicing
          case ADI_DEPOT: { // Send to Depots
            Command<CMD_SEND_VEHICLE_TO_DEPOT>::Post(GetCmdSendToDepotMsg(this->vli.vtype), VehicleID::Invalid(), (index == ADI_SERVICE ? DepotCommandFlag::Service : DepotCommandFlags{}) | DepotCommandFlag::MassSend, this->vli);
            break;
          }
 
          case ADI_CREATE_GROUP: // Create group
            Command<CMD_ADD_VEHICLE_GROUP>::Post(CcAddVehicleNewGroup, NEW_GROUP, VehicleID::Invalid(), false, this->vli);
            break;
 
          case ADI_ADD_SHARED: // Add shared Vehicles
            assert(Group::IsValidID(this->vli.ToGroupID()));
 
            Command<CMD_ADD_SHARED_VEHICLE_GROUP>::Post(STR_ERROR_GROUP_CAN_T_ADD_SHARED_VEHICLE, this->vli.ToGroupID(), this->vli.vtype);
            break;
          case ADI_REMOVE_ALL: // Remove all Vehicles from the selected group
            assert(Group::IsValidID(this->vli.ToGroupID()));
 
            Command<CMD_REMOVE_ALL_VEHICLES_GROUP>::Post(STR_ERROR_GROUP_CAN_T_REMOVE_ALL_VEHICLES, this->vli.ToGroupID());
            break;
          default: NOT_REACHED();
        }
        break;
 
      default: NOT_REACHED();
    }
 
    this->SetDirty();
  }
 
  void OnGameTick() override
  {
    if (this->groups.NeedResort() || this->vehgroups.NeedResort()) {
      this->SetDirty();
    }
  }
 
  void OnPlaceObjectAbort() override
  {
    /* abort drag & drop */
    this->vehicle_sel = VehicleID::Invalid();
    this->DirtyHighlightedGroupWidget();
    this->group_sel = GroupID::Invalid();
    this->group_over = GroupID::Invalid();
    this->SetWidgetDirty(WID_GL_LIST_VEHICLE);
  }
 
  void OnMouseDrag(Point pt, WidgetID widget) override
  {
    if (this->vehicle_sel == VehicleID::Invalid() && this->group_sel == GroupID::Invalid()) return;
 
    /* A vehicle is dragged over... */
    GroupID new_group_over = GroupID::Invalid();
    switch (widget) {
      case WID_GL_DEFAULT_VEHICLES: // ... the 'default' group.
        new_group_over = DEFAULT_GROUP;
        break;
 
      case WID_GL_LIST_GROUP: { // ... the list of custom groups.
        auto it = this->group_sb->GetScrolledItemFromWidget(this->groups, pt.y, this, WID_GL_LIST_GROUP);
        new_group_over = it == this->groups.end() ? NEW_GROUP : it->group->index;
        break;
      }
    }
 
    /* Do not highlight when dragging over the current group */
    if (this->vehicle_sel != VehicleID::Invalid()) {
      if (Vehicle::Get(vehicle_sel)->group_id == new_group_over) new_group_over = GroupID::Invalid();
    } else if (this->group_sel != GroupID::Invalid()) {
      if (this->group_sel == new_group_over || Group::Get(this->group_sel)->parent == new_group_over) new_group_over = GroupID::Invalid();
    }
 
    /* Mark widgets as dirty if the group changed. */
    if (new_group_over != this->group_over) {
      this->DirtyHighlightedGroupWidget();
      this->group_over = new_group_over;
      this->DirtyHighlightedGroupWidget();
    }
  }
 
  void ShowRenameGroupWindow(GroupID group, bool empty)
  {
    assert(Group::IsValidID(group));
    this->group_rename = group;
 
    /* Show empty query for new groups */
    std::string str;
    if (!empty) str = GetString(STR_GROUP_NAME, group);
 
    ShowQueryString(str, STR_GROUP_RENAME_CAPTION, MAX_LENGTH_GROUP_NAME_CHARS, this, CS_ALPHANUMERAL, {QueryStringFlag::EnableDefault, QueryStringFlag::LengthIsInChars});
  }
 
  void UnselectVehicle(VehicleID vehicle)
  {
    if (this->vehicle_sel == vehicle) ResetObjectToPlace();
  }
 
  void SelectGroup(const GroupID g_id)
  {
    if (g_id == GroupID::Invalid() || g_id == this->vli.ToGroupID()) return;
 
    this->vli.SetIndex(g_id);
    if (g_id != ALL_GROUP && g_id != DEFAULT_GROUP) {
      const Group *g = Group::Get(g_id);
 
      auto found = std::ranges::find(this->groups, g, &GUIGroupListItem::group);
      if (found == std::end(this->groups)) {
        /* The group's branch is maybe collapsed, so try to expand it. */
        for (auto pg = Group::GetIfValid(g->parent); pg != nullptr; pg = Group::GetIfValid(pg->parent)) {
          pg->folded = false;
        }
        this->groups.ForceRebuild();
        this->BuildGroupList(this->owner);
        this->group_sb->SetCount(this->groups.size());
        found = std::ranges::find(this->groups, g, &GUIGroupListItem::group);
      }
      if (found != std::end(this->groups)) this->group_sb->ScrollTowards(std::distance(std::begin(this->groups), found));
    }
    this->vehgroups.ForceRebuild();
    this->SetDirty();
  }
 
};
 
static WindowDesc _vehicle_group_desc[] = {
  {
    WDP_AUTO, "list_groups_train", 525, 246,
    WC_TRAINS_LIST, WC_NONE,
    {},
    _nested_group_widgets
  },
  {
    WDP_AUTO, "list_groups_roadveh", 460, 246,
    WC_ROADVEH_LIST, WC_NONE,
    {},
    _nested_group_widgets
  },
  {
    WDP_AUTO, "list_groups_ship", 460, 246,
    WC_SHIPS_LIST, WC_NONE,
    {},
    _nested_group_widgets
  },
  {
    WDP_AUTO, "list_groups_aircraft", 460, 246,
    WC_AIRCRAFT_LIST, WC_NONE,
    {},
    _nested_group_widgets
  },
};
 
template <bool Tneed_existing_window>
static void ShowCompanyGroupInternal(CompanyID company, VehicleType vehicle_type, GroupID group)
{
  if (!Company::IsValidID(company)) return;
 
  assert(vehicle_type < std::size(_vehicle_group_desc));
  VehicleListIdentifier vli(VL_GROUP_LIST, vehicle_type, company);
  VehicleGroupWindow *w = AllocateWindowDescFront<VehicleGroupWindow, Tneed_existing_window>(_vehicle_group_desc[vehicle_type], vli.ToWindowNumber(), vli);
  if (w != nullptr) w->SelectGroup(group);
}
 
void ShowCompanyGroup(CompanyID company, VehicleType vehicle_type, GroupID group)
{
  ShowCompanyGroupInternal<false>(company, vehicle_type, group);
}
 
void ShowCompanyGroupForVehicle(const Vehicle *v)
{
  ShowCompanyGroupInternal<true>(v->owner, v->type, v->group_id);
}
 
static inline VehicleGroupWindow *FindVehicleGroupWindow(VehicleType vt, Owner owner)
{
  return dynamic_cast<VehicleGroupWindow *>(FindWindowById(GetWindowClassForVehicleType(vt), VehicleListIdentifier(VL_GROUP_LIST, vt, owner).ToWindowNumber()));
}
 
static void CcCreateGroup(GroupID gid, VehicleType veh_type)
{
  VehicleGroupWindow *w = FindVehicleGroupWindow(veh_type, _current_company);
  if (w != nullptr) w->ShowRenameGroupWindow(gid, true);
}
 
void CcCreateGroup(Commands, const CommandCost &result, GroupID new_group, VehicleType vt, GroupID)
{
  if (result.Failed()) return;
 
  assert(vt <= VEH_AIRCRAFT);
  CcCreateGroup(new_group, vt);
}
 
void CcAddVehicleNewGroup(Commands, const CommandCost &result, GroupID new_group, GroupID, VehicleID, bool, const VehicleListIdentifier &)
{
  if (result.Failed()) return;
 
  const Group *g = Group::Get(new_group);
  CcCreateGroup(new_group, g->vehicle_type);
}
 
void DeleteGroupHighlightOfVehicle(const Vehicle *v)
{
  /* If we haven't got any vehicles on the mouse pointer, we haven't got any highlighted in any group windows either
   * If that is the case, we can skip looping though the windows and save time
   */
  if (_special_mouse_mode != WSM_DRAGDROP) return;
 
  VehicleGroupWindow *w = FindVehicleGroupWindow(v->type, v->owner);
  if (w != nullptr) w->UnselectVehicle(v->index);
}