vehicle_gui_base.h

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 <http://www.gnu.org/licenses/>.
 */
 
#ifndef VEHICLE_GUI_BASE_H
#define VEHICLE_GUI_BASE_H
 
#include "cargo_type.h"
#include "timer/timer_game_calendar.h"
#include "economy_type.h"
#include "sortlist_type.h"
#include "vehicle_base.h"
#include "vehiclelist.h"
#include "window_gui.h"
#include "dropdown_type.h"
 
typedef GUIList<const Vehicle*, std::nullptr_t, CargoID> GUIVehicleList;
 
struct GUIVehicleGroup {
  VehicleList::const_iterator vehicles_begin;    
  VehicleList::const_iterator vehicles_end;      
 
  GUIVehicleGroup(VehicleList::const_iterator vehicles_begin, VehicleList::const_iterator vehicles_end)
    : vehicles_begin(vehicles_begin), vehicles_end(vehicles_end) {}
 
  std::ptrdiff_t NumVehicles() const
  {
    return std::distance(this->vehicles_begin, this->vehicles_end);
  }
 
  const Vehicle *GetSingleVehicle() const
  {
    assert(this->NumVehicles() == 1);
    return this->vehicles_begin[0];
  }
 
  Money GetDisplayProfitThisYear() const
  {
    return std::accumulate(this->vehicles_begin, this->vehicles_end, (Money)0, [](Money acc, const Vehicle *v) {
      return acc + v->GetDisplayProfitThisYear();
    });
  }
 
  Money GetDisplayProfitLastYear() const
  {
    return std::accumulate(this->vehicles_begin, this->vehicles_end, (Money)0, [](Money acc, const Vehicle *v) {
      return acc + v->GetDisplayProfitLastYear();
    });
  }
 
  TimerGameEconomy::Date GetOldestVehicleAge() const
  {
    const Vehicle *oldest = *std::max_element(this->vehicles_begin, this->vehicles_end, [](const Vehicle *v_a, const Vehicle *v_b) {
      return v_a->economy_age < v_b->economy_age;
    });
    return oldest->economy_age;
  }
};
 
typedef GUIList<GUIVehicleGroup, std::nullptr_t, CargoID> GUIVehicleGroupList;
 
struct BaseVehicleListWindow : public Window {
 
  enum GroupBy : uint8_t {
    GB_NONE,
    GB_SHARED_ORDERS,
 
    GB_END,
  };
 
  GroupBy grouping;                           
  VehicleList vehicles;                       
  GUIVehicleGroupList vehgroups;              
  Listing *sorting;                           
  uint8_t unitnumber_digits;                     
  Scrollbar *vscroll;
  VehicleListIdentifier vli;                  
  VehicleID vehicle_sel;                      
  CargoID cargo_filter_criteria;              
  uint order_arrow_width;                     
  CargoTypes used_cargoes;
 
  typedef GUIVehicleGroupList::SortFunction VehicleGroupSortFunction;
  typedef GUIVehicleList::SortFunction VehicleIndividualSortFunction;
 
  enum ActionDropdownItem {
    ADI_REPLACE,
    ADI_SERVICE,
    ADI_DEPOT,
    ADI_ADD_SHARED,
    ADI_REMOVE_ALL,
    ADI_CREATE_GROUP,
  };
 
  static const StringID vehicle_depot_name[];
  static const std::initializer_list<const StringID> vehicle_group_by_names;
  static const std::initializer_list<const StringID> vehicle_group_none_sorter_names_calendar;
  static const std::initializer_list<const StringID> vehicle_group_none_sorter_names_wallclock;
  static const std::initializer_list<const StringID> vehicle_group_shared_orders_sorter_names_calendar;
  static const std::initializer_list<const StringID> vehicle_group_shared_orders_sorter_names_wallclock;
  static const std::initializer_list<VehicleGroupSortFunction * const> vehicle_group_none_sorter_funcs;
  static const std::initializer_list<VehicleGroupSortFunction * const> vehicle_group_shared_orders_sorter_funcs;
 
  BaseVehicleListWindow(WindowDesc &desc, WindowNumber wno);
 
  void OnInit() override;
 
  void UpdateSortingFromGrouping();
 
  void DrawVehicleListItems(VehicleID selected_vehicle, int line_height, const Rect &r) const;
  void UpdateVehicleGroupBy(GroupBy group_by);
  void SortVehicleList();
  void BuildVehicleList();
  void SetCargoFilter(uint8_t index);
  void SetCargoFilterArray();
  void FilterVehicleList();
  StringID GetCargoFilterLabel(CargoID cid) const;
  DropDownList BuildCargoDropDownList(bool full) const;
  Dimension GetActionDropdownSize(bool show_autoreplace, bool show_group, bool show_create);
  DropDownList BuildActionDropdownList(bool show_autoreplace, bool show_group, bool show_create);
 
  std::span<const StringID> GetVehicleSorterNames();
 
  std::span<VehicleGroupSortFunction * const> GetVehicleSorterFuncs()
  {
    switch (this->grouping) {
      case GB_NONE:
        return vehicle_group_none_sorter_funcs;
      case GB_SHARED_ORDERS:
        return vehicle_group_shared_orders_sorter_funcs;
      default:
        NOT_REACHED();
    }
  }
};
 
struct CargoIconOverlay {
  int left;
  int right;
  CargoID cargo_type;
  uint cargo_cap;
 
  constexpr CargoIconOverlay(int left, int right, CargoID cargo_type, uint cargo_cap)
    : left(left), right(right), cargo_type(cargo_type), cargo_cap(cargo_cap)
  { }
};
 
bool ShowCargoIconOverlay();
void AddCargoIconOverlay(std::vector<CargoIconOverlay> &overlays, int x, int width, const Vehicle *v);
void DrawCargoIconOverlay(int x, int y, CargoID cid);
void DrawCargoIconOverlays(std::span<const CargoIconOverlay> overlays, int y);
 
uint GetVehicleListHeight(VehicleType type, uint divisor = 1);
 
struct Sorting {
  Listing aircraft;
  Listing roadveh;
  Listing ship;
  Listing train;
};
 
extern BaseVehicleListWindow::GroupBy _grouping[VLT_END][VEH_COMPANY_END];
extern Sorting _sorting[BaseVehicleListWindow::GB_END];
 
#endif /* VEHICLE_GUI_BASE_H */