timetable_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 "command_func.h"
#include "gui.h"
#include "window_gui.h"
#include "window_func.h"
#include "textbuf_gui.h"
#include "strings_func.h"
#include "vehicle_base.h"
#include "string_func.h"
#include "gfx_func.h"
#include "company_func.h"
#include "timer/timer.h"
#include "timer/timer_game_tick.h"
#include "timer/timer_game_economy.h"
#include "timer/timer_window.h"
#include "date_gui.h"
#include "vehicle_gui.h"
#include "settings_type.h"
#include "timetable_cmd.h"
#include "timetable.h"
#include "core/string_consumer.hpp"
 
#include "widgets/timetable_widget.h"
 
#include "table/sprites.h"
#include "table/strings.h"
 
#include "safeguards.h"

struct TimetableArrivalDeparture {
  TimerGameTick::Ticks arrival;   
  TimerGameTick::Ticks departure; 
};

std::pair<StringParameter, StringParameter> GetTimetableParameters(TimerGameTick::Ticks ticks)
{
  switch (_settings_client.gui.timetable_mode) {
    case TimetableMode::Days: return {STR_UNITS_DAYS, ticks / Ticks::DAY_TICKS};
    case TimetableMode::Seconds: return {STR_UNITS_SECONDS, ticks / Ticks::TICKS_PER_SECOND};
    case TimetableMode::Ticks: return {STR_UNITS_TICKS, ticks};
    default:
      NOT_REACHED();
  }
}

static inline TimerGameTick::Ticks TicksPerTimetableUnit()
{
  switch (_settings_client.gui.timetable_mode) {
    case TimetableMode::Days:
      return Ticks::DAY_TICKS;
    case TimetableMode::Seconds:
      return Ticks::TICKS_PER_SECOND;
    case TimetableMode::Ticks:
      return 1;
    default:
      NOT_REACHED();
  }
}

bool VehicleIsAboveLatenessThreshold(TimerGameTick::Ticks ticks, bool round_to_day)
{
  switch (_settings_client.gui.timetable_mode) {
    case TimetableMode::Days:
      return ticks > Ticks::DAY_TICKS;
    case TimetableMode::Seconds:
      return ticks > Ticks::TICKS_PER_SECOND;
    case TimetableMode::Ticks:
      return ticks > (round_to_day ? Ticks::DAY_TICKS : 0);
    default:
      NOT_REACHED();
  }
}

static bool CanDetermineTimeTaken(const Order &order, bool travelling)
{
  /* Current order is conditional */
  if (order.IsType(OT_CONDITIONAL) || order.IsType(OT_IMPLICIT)) return false;
  /* No travel time and we have not already finished travelling */
  if (travelling && !order.IsTravelTimetabled()) return false;
  /* No wait time but we are loading at this timetabled station */
  if (!travelling && !order.IsWaitTimetabled() && order.IsType(OT_GOTO_STATION) &&
      !order.GetNonStopType().Test(OrderNonStopFlag::GoVia)) {
    return false;
  }
 
  return true;
}
 

static void FillTimetableArrivalDepartureTable(const Vehicle *v, VehicleOrderID start, bool travelling, std::vector<TimetableArrivalDeparture> &table, TimerGameTick::Ticks offset)
{
  assert(!table.empty());
  assert(v->GetNumOrders() >= 2);
  assert(start < v->GetNumOrders());
 
  /* Pre-initialize with unknown time */
  for (int i = 0; i < v->GetNumOrders(); ++i) {
    table[i].arrival = table[i].departure = Ticks::INVALID_TICKS;
  }
 
  TimerGameTick::Ticks sum = offset;
  VehicleOrderID i = start;
  auto orders = v->Orders();
 
  /* Cyclically loop over all orders until we reach the current one again.
   * As we may start at the current order, do a post-checking loop */
  do {
    /* Automatic orders don't influence the overall timetable;
     * they just add some untimetabled entries, but the time till
     * the next non-implicit order can still be known. */
    if (!orders[i].IsType(OT_IMPLICIT)) {
      if (travelling || i != start) {
        if (!CanDetermineTimeTaken(orders[i], true)) return;
        sum += orders[i].GetTimetabledTravel();
        table[i].arrival = sum;
      }
 
      if (!CanDetermineTimeTaken(orders[i], false)) return;
      sum += orders[i].GetTimetabledWait();
      table[i].departure = sum;
    }
 
    i = v->orders->GetNext(i);
  } while (i != start);
 
  /* When loading at a scheduled station we still have to treat the
   * travelling part of the first order. */
  if (!travelling) {
    if (!CanDetermineTimeTaken(orders[i], true)) return;
    sum += orders[i].GetTimetabledTravel();
    table[i].arrival = sum;
  }
}
 
struct TimetableWindow : Window {
  int sel_index = -1;
  VehicleTimetableWidgets query_widget{}; 
  const Vehicle *vehicle = nullptr; 
  bool show_expected = true; 
  Scrollbar *vscroll = nullptr; 
  bool set_start_date_all = false; 
  bool change_timetable_all = false; 
 
  TimetableWindow(WindowDesc &desc, WindowNumber window_number) :
      Window(desc),
      vehicle(Vehicle::Get(window_number))
  {
    this->CreateNestedTree();
    this->vscroll = this->GetScrollbar(WID_VT_SCROLLBAR);
 
    /* When using wallclock units, we must ensure the client displays timetables in seconds. */
    if (TimerGameEconomy::UsingWallclockUnits()) {
      _settings_client.gui.timetable_mode = TimetableMode::Seconds;
    }
 
    this->UpdateSelectionStates();
    this->FinishInitNested(window_number);
 
    this->owner = this->vehicle->owner;
  }

  static bool BuildArrivalDepartureList(const Vehicle *v, std::vector<TimetableArrivalDeparture> &table)
  {
    assert(v->vehicle_flags.Test(VehicleFlag::TimetableStarted));
 
    bool travelling = (!v->current_order.IsType(OT_LOADING) || v->current_order.GetNonStopType().None());
    TimerGameTick::Ticks start_time = -v->current_order_time;
 
    /* If arrival and departure times are in days, compensate for the current date_fract. */
    if (_settings_client.gui.timetable_mode != TimetableMode::Seconds) start_time += TimerGameEconomy::date_fract;
 
    FillTimetableArrivalDepartureTable(v, v->cur_real_order_index % v->GetNumOrders(), travelling, table, start_time);
 
    return (travelling && v->lateness_counter < 0);
  }
 
  void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
  {
    switch (widget) {
      case WID_VT_ARRIVAL_DEPARTURE_PANEL:
        /* We handle this differently depending on the timetable mode. */
        if (_settings_client.gui.timetable_mode == TimetableMode::Seconds) {
          /* A five-digit number would fit a timetable lasting 2.7 real-world hours, which should be plenty. */
          uint64_t max_digits = GetParamMaxDigits(4, FontSize::Small);
          size.width = std::max(
              GetStringBoundingBox(GetString(STR_TIMETABLE_ARRIVAL_SECONDS_IN_FUTURE, TextColour::Black, max_digits)).width,
              GetStringBoundingBox(GetString(STR_TIMETABLE_DEPARTURE_SECONDS_IN_FUTURE, TextColour::Black, max_digits)).width)
              + WidgetDimensions::scaled.hsep_wide + padding.width;
        } else {
          uint64_t max_value = GetParamMaxValue(TimerGameEconomy::DateAtStartOfYear(EconomyTime::MAX_YEAR).base(), 0, FontSize::Small);
          size.width = std::max(
              GetStringBoundingBox(GetString(STR_TIMETABLE_ARRIVAL_DATE, TextColour::Black, max_value)).width,
              GetStringBoundingBox(GetString(STR_TIMETABLE_DEPARTURE_DATE, TextColour::Black, max_value)).width)
              + WidgetDimensions::scaled.hsep_wide + padding.width;
        }
        [[fallthrough]];
 
      case WID_VT_TIMETABLE_PANEL:
        fill.height = resize.height = GetCharacterHeight(FontSize::Normal);
        size.height = 8 * resize.height + padding.height;
        break;
 
      case WID_VT_SUMMARY_PANEL:
        size.height = 2 * GetCharacterHeight(FontSize::Normal) + padding.height;
        break;
    }
  }
 
  int GetOrderFromTimetableWndPt(int y, [[maybe_unused]] const Vehicle *v)
  {
    int32_t sel = this->vscroll->GetScrolledRowFromWidget(y, this, WID_VT_TIMETABLE_PANEL, WidgetDimensions::scaled.framerect.top);
    if (sel == INT32_MAX) return sel;
    assert(IsInsideBS(sel, 0, v->GetNumOrders() * 2));
    return sel;
  }

  void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
  {
    switch (data) {
      case VIWD_AUTOREPLACE:
        /* Autoreplace replaced the vehicle */
        this->vehicle = Vehicle::Get(this->window_number);
        break;
 
      case VIWD_REMOVE_ALL_ORDERS:
        /* Removed / replaced all orders (after deleting / sharing) */
        if (this->sel_index == -1) break;
 
        this->CloseChildWindows();
        this->sel_index = -1;
        break;
 
      case VIWD_MODIFY_ORDERS:
        if (!gui_scope) break;
        this->UpdateSelectionStates();
        this->ReInit();
        break;
 
      default: {
        if (gui_scope) break; // only do this once; from command scope
 
        /* Moving an order. If one of these is INVALID_VEH_ORDER_ID, then
         * the order is being created / removed */
        if (this->sel_index == -1) break;
 
        VehicleOrderID from = GB(data, 0, 8);
        VehicleOrderID to   = GB(data, 8, 8);
 
        if (from == to) break; // no need to change anything
 
        /* if from == INVALID_VEH_ORDER_ID, one order was added; if to == INVALID_VEH_ORDER_ID, one order was removed */
        uint old_num_orders = this->vehicle->GetNumOrders() - (uint)(from == INVALID_VEH_ORDER_ID) + (uint)(to == INVALID_VEH_ORDER_ID);
 
        VehicleOrderID selected_order = (this->sel_index + 1) / 2;
        if (selected_order == old_num_orders) selected_order = 0; // when last travel time is selected, it belongs to order 0
 
        bool travel = HasBit(this->sel_index, 0);
 
        if (from != selected_order) {
          /* Moving from preceding order? */
          selected_order -= (int)(from <= selected_order);
          /* Moving to   preceding order? */
          selected_order += (int)(to   <= selected_order);
        } else {
          /* Now we are modifying the selected order */
          if (to == INVALID_VEH_ORDER_ID) {
            /* Deleting selected order */
            this->CloseChildWindows();
            this->sel_index = -1;
            break;
          } else {
            /* Moving selected order */
            selected_order = to;
          }
        }
 
        /* recompute new sel_index */
        this->sel_index = 2 * selected_order - (int)travel;
        /* travel time of first order needs special handling */
        if (this->sel_index == -1) this->sel_index = this->vehicle->GetNumOrders() * 2 - 1;
        break;
      }
    }
  }
 
 
  void OnPaint() override
  {
    const Vehicle *v = this->vehicle;
    int selected = this->sel_index;
 
    this->vscroll->SetCount(v->GetNumOrders() * 2);
 
    if (v->owner == _local_company) {
      bool disable = true;
      if (selected != -1) {
        const Order *order = v->GetOrder(((selected + 1) / 2) % v->GetNumOrders());
        if (selected % 2 != 0) {
          disable = order != nullptr && (order->IsType(OT_CONDITIONAL) || order->IsType(OT_IMPLICIT));
        } else {
          disable = order == nullptr || ((!order->IsType(OT_GOTO_STATION) || order->GetNonStopType().Test(OrderNonStopFlag::GoVia)) && !order->IsType(OT_CONDITIONAL));
        }
      }
      bool disable_speed = disable || selected % 2 == 0 || v->type == VehicleType::Aircraft;
 
      this->SetWidgetDisabledState(WID_VT_CHANGE_TIME, disable);
      this->SetWidgetDisabledState(WID_VT_CLEAR_TIME, disable);
      this->SetWidgetDisabledState(WID_VT_CHANGE_SPEED, disable_speed);
      this->SetWidgetDisabledState(WID_VT_CLEAR_SPEED, disable_speed);
      this->SetWidgetDisabledState(WID_VT_SHARED_ORDER_LIST, !v->IsOrderListShared());
 
      this->SetWidgetDisabledState(WID_VT_START_DATE, v->orders == nullptr);
      this->SetWidgetDisabledState(WID_VT_RESET_LATENESS, v->orders == nullptr);
      this->SetWidgetDisabledState(WID_VT_AUTOFILL, v->orders == nullptr);
    } else {
      this->DisableWidget(WID_VT_START_DATE);
      this->DisableWidget(WID_VT_CHANGE_TIME);
      this->DisableWidget(WID_VT_CLEAR_TIME);
      this->DisableWidget(WID_VT_CHANGE_SPEED);
      this->DisableWidget(WID_VT_CLEAR_SPEED);
      this->DisableWidget(WID_VT_RESET_LATENESS);
      this->DisableWidget(WID_VT_AUTOFILL);
      this->DisableWidget(WID_VT_SHARED_ORDER_LIST);
    }
 
    this->SetWidgetLoweredState(WID_VT_AUTOFILL, v->vehicle_flags.Test(VehicleFlag::AutofillTimetable));
 
    this->DrawWidgets();
  }
 
  std::string GetWidgetString(WidgetID widget, StringID stringid) const override
  {
    switch (widget) {
      case WID_VT_CAPTION: return GetString(STR_TIMETABLE_TITLE, this->vehicle->index);
      case WID_VT_EXPECTED: return GetString(this->show_expected ? STR_TIMETABLE_EXPECTED : STR_TIMETABLE_SCHEDULED);
      default: return this->Window::GetWidgetString(widget, stringid);
    }
  }

  std::string GetTimetableTravelString(const Order &order, int i, ExtendedTextColour &colour) const
  {
    colour = (i == this->sel_index) ? TextColour::White : TextColour::Black;
 
    if (order.IsType(OT_CONDITIONAL)) {
      return GetString(STR_TIMETABLE_NO_TRAVEL);
    }
 
    if (order.IsType(OT_IMPLICIT)) {
      colour = ExtendedTextColour{(i == this->sel_index) ? TextColour::Silver : TextColour::Grey, ExtendedTextColourFlag::NoShade};
      return GetString(STR_TIMETABLE_NOT_TIMETABLEABLE);
    }
 
    if (order.IsTravelTimetabled()) {
      auto [str, value] = GetTimetableParameters(order.GetTimetabledTravel());
      return order.GetMaxSpeed() != UINT16_MAX
        ? GetString(STR_TIMETABLE_TRAVEL_FOR_SPEED, str, value, PackVelocity(order.GetMaxSpeed(), this->vehicle->type))
        : GetString(STR_TIMETABLE_TRAVEL_FOR, str, value);
    }
 
    if (order.GetTravelTime() > 0) {
      auto [str, value] = GetTimetableParameters(order.GetTravelTime());
      return order.GetMaxSpeed() != UINT16_MAX
        ? GetString(STR_TIMETABLE_TRAVEL_FOR_SPEED_ESTIMATED, str, value, PackVelocity(order.GetMaxSpeed(), this->vehicle->type))
        : GetString(STR_TIMETABLE_TRAVEL_FOR_ESTIMATED, str, value);
    }
 
    return order.GetMaxSpeed() != UINT16_MAX
      ? GetString(STR_TIMETABLE_TRAVEL_NOT_TIMETABLED_SPEED, PackVelocity(order.GetMaxSpeed(), this->vehicle->type))
      : GetString(STR_TIMETABLE_TRAVEL_NOT_TIMETABLED);
  }

  void DrawTimetablePanel(const Rect &r) const
  {
    const Vehicle *v = this->vehicle;
    if (v->GetNumOrders() == 0) return;
    Rect tr = r.Shrink(WidgetDimensions::scaled.framerect);
    int i = this->vscroll->GetPosition();
    VehicleOrderID order_id = (i + 1) / 2;
    bool final_order = false;
    int selected = this->sel_index;
 
    bool rtl = _current_text_dir == TD_RTL;
    int index_column_width = GetStringBoundingBox(GetString(STR_ORDER_INDEX, GetParamMaxValue(v->GetNumOrders(), 2))).width + 2 * GetSpriteSize(rtl ? SPR_ARROW_RIGHT : SPR_ARROW_LEFT).width + WidgetDimensions::scaled.hsep_normal;
    int middle = rtl ? tr.right - index_column_width : tr.left + index_column_width;
 
    auto orders = v->Orders();
    while (true) {
      /* Don't draw anything if it extends past the end of the window. */
      if (!this->vscroll->IsVisible(i)) break;
 
      if (i % 2 == 0) {
        DrawOrderString(v, &orders[order_id], order_id, tr.top, i == selected, true, tr.left, middle, tr.right);
        if (v->orders->GetNext(order_id) == 0) final_order = true;
        order_id = v->orders->GetNext(order_id);
      } else {
        ExtendedTextColour colour;
        std::string string = GetTimetableTravelString(orders[order_id], i, colour);
 
        DrawString(rtl ? tr.left : middle, rtl ? middle : tr.right, tr.top, string, colour);
 
        if (final_order) break;
      }
 
      i++;
      tr.top += GetCharacterHeight(FontSize::Normal);
    }
  }

  void DrawArrivalDeparturePanel(const Rect &r) const
  {
    const Vehicle *v = this->vehicle;
 
    /* Arrival and departure times are handled in an all-or-nothing approach,
     * i.e. are only shown if we can calculate all times.
     * Excluding order lists with only one order makes some things easier. */
    TimerGameTick::Ticks total_time = v->orders != nullptr ? v->orders->GetTimetableDurationIncomplete() : 0;
    if (total_time <= 0 || v->GetNumOrders() <= 1 || !v->vehicle_flags.Test(VehicleFlag::TimetableStarted)) return;
 
    std::vector<TimetableArrivalDeparture> arr_dep(v->GetNumOrders());
    const VehicleOrderID cur_order = v->cur_real_order_index % v->GetNumOrders();
 
    VehicleOrderID early_id = BuildArrivalDepartureList(v, arr_dep) ? cur_order : (VehicleOrderID)INVALID_VEH_ORDER_ID;
    int selected = this->sel_index;
 
    Rect tr = r.Shrink(WidgetDimensions::scaled.framerect);
    bool show_late = this->show_expected && VehicleIsAboveLatenessThreshold(v->lateness_counter, true);
    TimerGameTick::Ticks offset = show_late ? 0 : -v->lateness_counter;
 
    for (int i = this->vscroll->GetPosition(); i / 2 < v->GetNumOrders(); ++i) { // note: i is also incremented in the loop
      /* Don't draw anything if it extends past the end of the window. */
      if (!this->vscroll->IsVisible(i)) break;
 
      /* TextColour::Invalid will skip the colour change. */
      TextColour tc = show_late ? TextColour::Red : TextColour::Invalid;
      if (i % 2 == 0) {
        /* Draw an arrival time. */
        if (arr_dep[i / 2].arrival != Ticks::INVALID_TICKS) {
          /* First set the offset and text colour based on the expected/scheduled mode and some other things. */
          TimerGameTick::Ticks this_offset;
          if (this->show_expected && i / 2 == early_id) {
            /* Show expected arrival. */
            this_offset = 0;
            tc = TextColour::Green;
          } else {
            /* Show scheduled arrival. */
            this_offset = offset;
          }
 
          /* Now actually draw the arrival time. */
          if (_settings_client.gui.timetable_mode == TimetableMode::Seconds) {
            /* Display seconds from now. */
            DrawString(tr,
              GetString(STR_TIMETABLE_ARRIVAL_SECONDS_IN_FUTURE, tc, (arr_dep[i / 2].arrival + offset) / Ticks::TICKS_PER_SECOND),
              i == selected ? TextColour::White : TextColour::Black);
          } else {
            /* Show a date. */
            DrawString(tr,
              GetString(STR_TIMETABLE_ARRIVAL_DATE, tc, TimerGameEconomy::date + (arr_dep[i / 2].arrival + this_offset) / Ticks::DAY_TICKS),
              i == selected ? TextColour::White : TextColour::Black);
          }
        }
      } else {
        /* Draw a departure time. */
        if (arr_dep[i / 2].departure != Ticks::INVALID_TICKS) {
          if (_settings_client.gui.timetable_mode == TimetableMode::Seconds) {
            /* Display seconds from now. */
            DrawString(tr,
              GetString(STR_TIMETABLE_DEPARTURE_SECONDS_IN_FUTURE, tc, (arr_dep[i / 2].departure + offset) / Ticks::TICKS_PER_SECOND),
              i == selected ? TextColour::White : TextColour::Black);
          } else {
            /* Show a date. */
            DrawString(tr,
              GetString(STR_TIMETABLE_DEPARTURE_DATE, tc, TimerGameEconomy::date + (arr_dep[i / 2].departure + offset) / Ticks::DAY_TICKS),
              i == selected ? TextColour::White : TextColour::Black);
          }
        }
      }
      tr.top += GetCharacterHeight(FontSize::Normal);
    }
  }
 
  std::string GetTimetableTotalTimeString(TimerGameTick::Ticks total_time) const
  {
    auto [str, value] = GetTimetableParameters(total_time);
    if (!this->vehicle->orders->IsCompleteTimetable()) return GetString(STR_TIMETABLE_TOTAL_TIME_INCOMPLETE, str, value);
    if (total_time % TicksPerTimetableUnit() == 0) return GetString(STR_TIMETABLE_TOTAL_TIME, str, value);
    return GetString(STR_TIMETABLE_APPROX_TIME, str, value);
  }

  void DrawSummaryPanel(const Rect &r) const
  {
    const Vehicle *v = this->vehicle;
    Rect tr = r.Shrink(WidgetDimensions::scaled.framerect);
 
    TimerGameTick::Ticks total_time = v->orders != nullptr ? v->orders->GetTimetableDurationIncomplete() : 0;
    if (total_time != 0) {
      DrawString(tr, GetTimetableTotalTimeString(total_time));
    }
    tr.top += GetCharacterHeight(FontSize::Normal);
 
    /* Draw the lateness display, or indicate that the timetable has not started yet. */
    if (v->timetable_start != 0) {
      /* We are running towards the first station so we can start the
       * timetable at the given time. */
      if (_settings_client.gui.timetable_mode == TimetableMode::Seconds) {
        /* Real time units use seconds relative to now. */
        DrawString(tr, GetString(STR_TIMETABLE_STATUS_START_IN_SECONDS, static_cast<TimerGameTick::Ticks>(v->timetable_start - TimerGameTick::counter) / Ticks::TICKS_PER_SECOND));
      } else {
        /* Other units use dates. */
        DrawString(tr, GetString(STR_TIMETABLE_STATUS_START_AT_DATE, STR_JUST_DATE_TINY, GetDateFromStartTick(v->timetable_start)));
      }
    } else if (!v->vehicle_flags.Test(VehicleFlag::TimetableStarted)) {
      /* We aren't running on a timetable yet. */
      DrawString(tr, STR_TIMETABLE_STATUS_NOT_STARTED);
    } else if (!VehicleIsAboveLatenessThreshold(abs(v->lateness_counter), false)) {
      /* We are on time. */
      DrawString(tr, STR_TIMETABLE_STATUS_ON_TIME);
    } else {
      /* We are late. */
      auto [str, value] = GetTimetableParameters(abs(v->lateness_counter));
      DrawString(tr, GetString(v->lateness_counter < 0 ? STR_TIMETABLE_STATUS_EARLY : STR_TIMETABLE_STATUS_LATE, str, value));
    }
  }
 
  void DrawWidget(const Rect &r, WidgetID widget) const override
  {
    switch (widget) {
      case WID_VT_TIMETABLE_PANEL: {
        this->DrawTimetablePanel(r);
        break;
      }
 
      case WID_VT_ARRIVAL_DEPARTURE_PANEL: {
        this->DrawArrivalDeparturePanel(r);
        break;
      }
 
      case WID_VT_SUMMARY_PANEL: {
        this->DrawSummaryPanel(r);
        break;
      }
    }
  }
 
  static inline std::tuple<VehicleOrderID, ModifyTimetableFlags> PackTimetableArgs(const Vehicle *v, uint selected, bool speed)
  {
    uint order_number = (selected + 1) / 2;
    ModifyTimetableFlags mtf = (selected % 2 != 0) ? (speed ? MTF_TRAVEL_SPEED : MTF_TRAVEL_TIME) : MTF_WAIT_TIME;
 
    if (order_number >= v->GetNumOrders()) order_number = 0;
 
    return { order_number, mtf };
  }
 
  void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
  {
    const Vehicle *v = this->vehicle;
 
    switch (widget) {
      case WID_VT_ORDER_VIEW: // Order view button
        ShowOrdersWindow(v);
        break;
 
      case WID_VT_TIMETABLE_PANEL: { // Main panel.
        int selected = GetOrderFromTimetableWndPt(pt.y, v);
 
        this->CloseChildWindows();
        this->sel_index = (selected == INT32_MAX || selected == this->sel_index) ? -1 : selected;
        break;
      }
 
      case WID_VT_START_DATE: // Change the date that the timetable starts.
        if (_settings_client.gui.timetable_mode == TimetableMode::Seconds) {
          this->query_widget = WID_VT_START_DATE;
          this->change_timetable_all = _ctrl_pressed;
          ShowQueryString({}, STR_TIMETABLE_START_SECONDS_QUERY, 6, this, CS_NUMERAL, QueryStringFlag::AcceptUnchanged);
        } else {
          ShowSetDateWindow(this, v->index.base(), TimerGameEconomy::date, TimerGameEconomy::year, TimerGameEconomy::year + MAX_TIMETABLE_START_YEARS,
            [ctrl=_ctrl_pressed](const Window *w, TimerGameEconomy::Date date) {
              Command<Commands::SetTimetableStart>::Post(STR_ERROR_CAN_T_TIMETABLE_VEHICLE, w->window_number, ctrl, GetStartTickFromDate(date));
            }
          );
        }
        break;
 
      case WID_VT_CHANGE_TIME: { // "Wait For" button.
        this->query_widget = WID_VT_CHANGE_TIME;
        int selected = this->sel_index;
        VehicleOrderID real = (selected + 1) / 2;
 
        if (real >= v->GetNumOrders()) real = 0;
 
        const Order *order = v->GetOrder(real);
        std::string current;
 
        if (order != nullptr) {
          uint time = (selected % 2 != 0) ? order->GetTravelTime() : order->GetWaitTime();
          time /= TicksPerTimetableUnit();
 
          if (time != 0) {
            current = GetString(STR_JUST_INT, time);
          }
        }
 
        this->change_timetable_all = _ctrl_pressed && (order != nullptr);
        ShowQueryString(current, STR_TIMETABLE_CHANGE_TIME_QUERY, 31, this, CS_NUMERAL, QueryStringFlag::AcceptUnchanged);
        break;
      }
 
      case WID_VT_CHANGE_SPEED: { // Change max speed button.
        this->query_widget = WID_VT_CHANGE_SPEED;
        int selected = this->sel_index;
        VehicleOrderID real = (selected + 1) / 2;
 
        if (real >= v->GetNumOrders()) real = 0;
 
        std::string current;
        const Order *order = v->GetOrder(real);
        if (order != nullptr) {
          if (order->GetMaxSpeed() != UINT16_MAX) {
            current = GetString(STR_JUST_INT, ConvertKmhishSpeedToDisplaySpeed(order->GetMaxSpeed(), v->type));
          }
        }
 
        this->change_timetable_all = _ctrl_pressed && (order != nullptr);
        ShowQueryString(current, STR_TIMETABLE_CHANGE_SPEED_QUERY, 31, this, CS_NUMERAL, {});
        break;
      }
 
      case WID_VT_CLEAR_TIME: { // Clear waiting time.
        auto [order_id, mtf] = PackTimetableArgs(v, this->sel_index, false);
        if (_ctrl_pressed) {
          Command<Commands::ChangeTimetableBulk>::Post(STR_ERROR_CAN_T_TIMETABLE_VEHICLE, v->index, mtf, 0);
        } else {
          Command<Commands::ChangeTimetable>::Post(STR_ERROR_CAN_T_TIMETABLE_VEHICLE, v->index, order_id, mtf, 0);
        }
        break;
      }
 
      case WID_VT_CLEAR_SPEED: { // Clear max speed button.
        auto [order_id, mtf] = PackTimetableArgs(v, this->sel_index, true);
        if (_ctrl_pressed) {
          Command<Commands::ChangeTimetableBulk>::Post(STR_ERROR_CAN_T_TIMETABLE_VEHICLE, v->index, mtf, UINT16_MAX);
        } else {
          Command<Commands::ChangeTimetable>::Post(STR_ERROR_CAN_T_TIMETABLE_VEHICLE, v->index, order_id, mtf, UINT16_MAX);
        }
        break;
      }
 
      case WID_VT_RESET_LATENESS: // Reset the vehicle's late counter.
        Command<Commands::SetVehicleOnTime>::Post(STR_ERROR_CAN_T_TIMETABLE_VEHICLE, v->index, _ctrl_pressed);
        break;
 
      case WID_VT_AUTOFILL: { // Autofill the timetable.
        Command<Commands::AutofillTimetable>::Post(STR_ERROR_CAN_T_TIMETABLE_VEHICLE, v->index, !v->vehicle_flags.Test(VehicleFlag::AutofillTimetable), _ctrl_pressed);
        break;
      }
 
      case WID_VT_EXPECTED:
        this->show_expected = !this->show_expected;
        break;
 
      case WID_VT_SHARED_ORDER_LIST:
        ShowVehicleListWindow(v);
        break;
    }
 
    this->SetDirty();
  }
 
  void OnQueryTextFinished(std::optional<std::string> str) override
  {
    if (!str.has_value()) return;
 
    const Vehicle *v = this->vehicle;
    uint64_t val = ParseInteger<uint64_t>(*str, 10, true).value_or(0);
    auto [order_id, mtf] = PackTimetableArgs(v, this->sel_index, query_widget == WID_VT_CHANGE_SPEED);
 
    switch (query_widget) {
      case WID_VT_CHANGE_SPEED: {
        val = ConvertDisplaySpeedToKmhishSpeed(val, v->type);
 
        if (this->change_timetable_all) {
          Command<Commands::ChangeTimetableBulk>::Post(STR_ERROR_CAN_T_TIMETABLE_VEHICLE, v->index, mtf, ClampTo<uint16_t>(val));
        } else {
          Command<Commands::ChangeTimetable>::Post(STR_ERROR_CAN_T_TIMETABLE_VEHICLE, v->index, order_id, mtf, ClampTo<uint16_t>(val));
        }
        break;
      }
 
      case WID_VT_CHANGE_TIME:
        val *= TicksPerTimetableUnit();
 
        if (this->change_timetable_all) {
          Command<Commands::ChangeTimetableBulk>::Post(STR_ERROR_CAN_T_TIMETABLE_VEHICLE, v->index, mtf, ClampTo<uint16_t>(val));
        } else {
          Command<Commands::ChangeTimetable>::Post(STR_ERROR_CAN_T_TIMETABLE_VEHICLE, v->index, order_id, mtf, ClampTo<uint16_t>(val));
        }
        break;
 
      case WID_VT_START_DATE: {
        TimerGameTick::TickCounter start_tick = TimerGameTick::counter + (val * Ticks::TICKS_PER_SECOND);
        Command<Commands::SetTimetableStart>::Post(STR_ERROR_CAN_T_TIMETABLE_VEHICLE, v->index, this->change_timetable_all, start_tick);
        break;
      }
 
      default:
        NOT_REACHED();
    }
  }
 
  void OnResize() override
  {
    /* Update the scroll bar */
    this->vscroll->SetCapacityFromWidget(this, WID_VT_TIMETABLE_PANEL, WidgetDimensions::scaled.framerect.Vertical());
  }

  void UpdateSelectionStates()
  {
    this->GetWidget<NWidgetStacked>(WID_VT_ARRIVAL_DEPARTURE_SELECTION)->SetDisplayedPlane(_settings_client.gui.timetable_arrival_departure ? 0 : SZSP_NONE);
    this->GetWidget<NWidgetStacked>(WID_VT_EXPECTED_SELECTION)->SetDisplayedPlane(_settings_client.gui.timetable_arrival_departure ? 0 : 1);
  }

  const IntervalTimer<TimerGameTick> redraw_interval = { { TimerGameTick::Priority::None, Ticks::TICKS_PER_SECOND }, [this](auto) {
    if (_settings_client.gui.timetable_mode == TimetableMode::Seconds) {
      this->SetDirty();
    }
  }};
};
 
static constexpr std::initializer_list<NWidgetPart> _nested_timetable_widgets = {
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_CLOSEBOX, Colours::Grey),
    NWidget(WWT_CAPTION, Colours::Grey, WID_VT_CAPTION),
    NWidget(WWT_PUSHTXTBTN, Colours::Grey, WID_VT_ORDER_VIEW), SetMinimalSize(61, 14), SetStringTip(STR_TIMETABLE_ORDER_VIEW, STR_TIMETABLE_ORDER_VIEW_TOOLTIP),
    NWidget(WWT_SHADEBOX, Colours::Grey),
    NWidget(WWT_DEFSIZEBOX, Colours::Grey),
    NWidget(WWT_STICKYBOX, Colours::Grey),
  EndContainer(),
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_PANEL, Colours::Grey, WID_VT_TIMETABLE_PANEL), SetMinimalSize(388, 82), SetResize(1, 10), SetToolTip(STR_TIMETABLE_TOOLTIP), SetScrollbar(WID_VT_SCROLLBAR), EndContainer(),
    NWidget(NWID_SELECTION, Colours::Invalid, WID_VT_ARRIVAL_DEPARTURE_SELECTION),
      NWidget(WWT_PANEL, Colours::Grey, WID_VT_ARRIVAL_DEPARTURE_PANEL), SetMinimalSize(110, 0), SetFill(0, 1), SetToolTip(STR_TIMETABLE_TOOLTIP), SetScrollbar(WID_VT_SCROLLBAR), EndContainer(),
    EndContainer(),
    NWidget(NWID_VSCROLLBAR, Colours::Grey, WID_VT_SCROLLBAR),
  EndContainer(),
  NWidget(WWT_PANEL, Colours::Grey, WID_VT_SUMMARY_PANEL), SetMinimalSize(400, 22), SetResize(1, 0), EndContainer(),
  NWidget(NWID_HORIZONTAL),
    NWidget(NWID_HORIZONTAL, NWidContainerFlag::EqualSize),
      NWidget(NWID_VERTICAL, NWidContainerFlag::EqualSize),
        NWidget(WWT_PUSHTXTBTN, Colours::Grey, WID_VT_CHANGE_TIME), SetResize(1, 0), SetFill(1, 1), SetStringTip(STR_TIMETABLE_CHANGE_TIME, STR_TIMETABLE_WAIT_TIME_TOOLTIP),
        NWidget(WWT_PUSHTXTBTN, Colours::Grey, WID_VT_CLEAR_TIME), SetResize(1, 0), SetFill(1, 1), SetStringTip(STR_TIMETABLE_CLEAR_TIME, STR_TIMETABLE_CLEAR_TIME_TOOLTIP),
      EndContainer(),
      NWidget(NWID_VERTICAL, NWidContainerFlag::EqualSize),
        NWidget(WWT_PUSHTXTBTN, Colours::Grey, WID_VT_CHANGE_SPEED), SetResize(1, 0), SetFill(1, 1), SetStringTip(STR_TIMETABLE_CHANGE_SPEED, STR_TIMETABLE_CHANGE_SPEED_TOOLTIP),
        NWidget(WWT_PUSHTXTBTN, Colours::Grey, WID_VT_CLEAR_SPEED), SetResize(1, 0), SetFill(1, 1), SetStringTip(STR_TIMETABLE_CLEAR_SPEED, STR_TIMETABLE_CLEAR_SPEED_TOOLTIP),
      EndContainer(),
      NWidget(NWID_VERTICAL, NWidContainerFlag::EqualSize),
        NWidget(WWT_PUSHTXTBTN, Colours::Grey, WID_VT_START_DATE), SetResize(1, 0), SetFill(1, 1), SetStringTip(STR_TIMETABLE_START, STR_TIMETABLE_START_TOOLTIP),
        NWidget(WWT_PUSHTXTBTN, Colours::Grey, WID_VT_RESET_LATENESS), SetResize(1, 0), SetFill(1, 1), SetStringTip(STR_TIMETABLE_RESET_LATENESS, STR_TIMETABLE_RESET_LATENESS_TOOLTIP),
      EndContainer(),
      NWidget(NWID_VERTICAL, NWidContainerFlag::EqualSize),
        NWidget(WWT_PUSHTXTBTN, Colours::Grey, WID_VT_AUTOFILL), SetResize(1, 0), SetFill(1, 1), SetStringTip(STR_TIMETABLE_AUTOFILL, STR_TIMETABLE_AUTOFILL_TOOLTIP),
        NWidget(NWID_SELECTION, Colours::Invalid, WID_VT_EXPECTED_SELECTION),
          NWidget(WWT_PUSHTXTBTN, Colours::Grey, WID_VT_EXPECTED), SetResize(1, 0), SetFill(1, 1), SetToolTip(STR_TIMETABLE_EXPECTED_TOOLTIP),
          NWidget(WWT_PANEL, Colours::Grey), SetResize(1, 0), SetFill(1, 1), EndContainer(),
        EndContainer(),
      EndContainer(),
    EndContainer(),
    NWidget(NWID_VERTICAL, NWidContainerFlag::EqualSize),
      NWidget(WWT_PUSHIMGBTN, Colours::Grey, WID_VT_SHARED_ORDER_LIST), SetFill(0, 1), SetSpriteTip(SPR_SHARED_ORDERS_ICON, STR_ORDERS_VEH_WITH_SHARED_ORDERS_LIST_TOOLTIP),
      NWidget(WWT_RESIZEBOX, Colours::Grey), SetFill(0, 1),
    EndContainer(),
  EndContainer(),
};

static WindowDesc _timetable_desc(
  WindowPosition::Automatic, "view_vehicle_timetable", 400, 130,
  WindowClass::VehicleTimetable, WindowClass::VehicleView,
  WindowDefaultFlag::Construction,
  _nested_timetable_widgets
);

void ShowTimetableWindow(const Vehicle *v)
{
  CloseWindowById(WindowClass::VehicleDetails, v->index, false);
  CloseWindowById(WindowClass::VehicleOrders, v->index, false);
  AllocateWindowDescFront<TimetableWindow>(_timetable_desc, v->index);
}