picker_gui.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 PICKER_GUI_H
#define PICKER_GUI_H
 
#include "newgrf_badge.h"
#include "querystring_gui.h"
#include "sortlist_type.h"
#include "stringfilter_type.h"
#include "strings_type.h"
#include "timer/timer.h"
#include "timer/timer_game_calendar.h"
#include "timer/timer_window.h"
#include "window_gui.h"
#include "window_type.h"
 
struct PickerItem {
  uint32_t grfid;
  uint16_t local_id;
  int class_index;
  int index;
 
  inline auto operator<=>(const PickerItem &other) const
  {
    if (auto cmp = this->grfid <=> other.grfid; cmp != 0) return cmp;
    return this->local_id <=> other.local_id;
  }
};
 
class PickerCallbacks {
public:
  explicit PickerCallbacks(const std::string &ini_group);
  virtual ~PickerCallbacks();
 
  virtual void Close(int) { }
 
  virtual GrfSpecFeature GetFeature() const = 0;
  virtual bool IsActive() const = 0;
  virtual bool HasClassChoice() const = 0;
 
  /* Class callbacks */
  virtual StringID GetClassTooltip() const = 0;
  virtual int GetClassCount() const = 0;
  virtual int GetSelectedClass() const = 0;
  virtual void SetSelectedClass(int id) const = 0;
  virtual StringID GetClassName(int id) const = 0;
 
  /* Type callbacks */
  virtual StringID GetTypeTooltip() const = 0;
  virtual int GetTypeCount(int cls_id) const = 0;
 
  virtual int GetSelectedType() const = 0;
  virtual void SetSelectedType(int id) const = 0;
  virtual PickerItem GetPickerItem(int cls_id, int id) const = 0;
  virtual StringID GetTypeName(int cls_id, int id) const = 0;
  virtual std::span<const BadgeID> GetTypeBadges(int cls_id, int id) const = 0;
  virtual bool IsTypeAvailable(int cls_id, int id) const = 0;
  virtual void DrawType(int x, int y, int cls_id, int id) const = 0;
 
  virtual void FillUsedItems(std::set<PickerItem> &items) = 0;
  virtual std::set<PickerItem> UpdateSavedItems(const std::set<PickerItem> &src) = 0;
 
  Listing class_last_sorting = { false, 0 }; 
  Filtering class_last_filtering = { false, 0 }; 
 
  Listing type_last_sorting = { false, 0 }; 
  Filtering type_last_filtering = { false, 0 }; 
 
  const std::string ini_group; 
  uint8_t mode = 0; 
 
  std::set<PickerItem> used; 
  std::set<PickerItem> saved; 
};
 
template <typename T>
class PickerCallbacksNewGRFClass : public PickerCallbacks {
public:
  explicit PickerCallbacksNewGRFClass(const std::string &ini_group) : PickerCallbacks(ini_group) {}
 
  inline typename T::index_type GetClassIndex(int cls_id) const { return static_cast<typename T::index_type>(cls_id); }
  inline const T *GetClass(int cls_id) const { return T::Get(this->GetClassIndex(cls_id)); }
  inline const typename T::spec_type *GetSpec(int cls_id, int id) const { return this->GetClass(cls_id)->GetSpec(id); }
 
  bool HasClassChoice() const override { return T::GetUIClassCount() > 1; }
 
  int GetClassCount() const override { return T::GetClassCount(); }
  int GetTypeCount(int cls_id) const override { return this->GetClass(cls_id)->GetSpecCount(); }
 
  PickerItem GetPickerItem(const typename T::spec_type *spec, int cls_id = -1, int id = -1) const
  {
    if (spec == nullptr) return {0, 0, cls_id, id};
    return {spec->grf_prop.grfid, spec->grf_prop.local_id, spec->class_index, spec->index};
  }
 
  PickerItem GetPickerItem(int cls_id, int id) const override
  {
    return GetPickerItem(GetClass(cls_id)->GetSpec(id), cls_id, id);
  }
 
  std::set<PickerItem> UpdateSavedItems(const std::set<PickerItem> &src) override
  {
    if (src.empty()) return {};
 
    std::set<PickerItem> dst;
    for (const auto &item : src) {
      const auto *spec = T::GetByGrf(item.grfid, item.local_id);
      if (spec == nullptr) {
        dst.insert({item.grfid, item.local_id, -1, -1});
      } else {
        dst.insert(GetPickerItem(spec));
      }
    }
    return dst;
  }
};
 
struct PickerFilterData : StringFilter {
  const PickerCallbacks *callbacks; 
  std::optional<BadgeTextFilter> btf;
};
 
using PickerClassList = GUIList<int, std::nullptr_t, PickerFilterData &>; 
using PickerTypeList = GUIList<PickerItem, std::nullptr_t, PickerFilterData &>; 
 
class PickerWindow : public PickerWindowBase {
public:
  enum PickerFilterModes : uint8_t {
    PFM_ALL = 0, 
    PFM_USED = 1, 
    PFM_SAVED = 2, 
  };
 
  enum class PickerInvalidation : uint8_t {
    Class, 
    Type, 
    Position, 
    Validate, 
  };
  using PickerInvalidations = EnumBitSet<PickerInvalidation, uint8_t>;
 
  static constexpr PickerInvalidations PICKER_INVALIDATION_ALL{PickerInvalidation::Class, PickerInvalidation::Type, PickerInvalidation::Position, PickerInvalidation::Validate};
 
  static const int PREVIEW_WIDTH = 64; 
  static const int PREVIEW_HEIGHT = 48; 
  static const int PREVIEW_LEFT = 31; 
  static const int PREVIEW_BOTTOM = 31; 
 
  static const uint EDITBOX_MAX_SIZE = 16; 
 
  bool has_class_picker = false; 
  bool has_type_picker = false; 
 
  PickerWindow(WindowDesc &desc, Window *parent, int window_number, PickerCallbacks &callbacks);
  void OnInit() override;
  void Close(int data = 0) override;
  void UpdateWidgetSize(WidgetID widget, Dimension &size, const Dimension &padding, Dimension &fill, Dimension &resize) override;
  void DrawWidget(const Rect &r, WidgetID widget) const override;
  void OnResize() override;
  void OnClick(Point pt, WidgetID widget, int click_count) override;
  void OnInvalidateData(int data = 0, bool gui_scope = true) override;
  EventState OnHotkey(int hotkey) override;
  void OnEditboxChanged(WidgetID wid) override;
 
  enum PickerClassWindowHotkeys : int32_t {
    PCWHK_FOCUS_FILTER_BOX, 
  };
 
  void InvalidateData(PickerInvalidations data) { this->Window::InvalidateData(data.base()); }
 
protected:
  void ConstructWindow();
 
  PickerCallbacks &callbacks;
 
private:
  PickerClassList classes; 
  PickerFilterData class_string_filter;
  QueryString class_editbox; 
 
  void BuildPickerClassList();
  void EnsureSelectedClassIsValid();
  void EnsureSelectedClassIsVisible();
 
  PickerTypeList types; 
  PickerFilterData type_string_filter;
  QueryString type_editbox; 
 
  void RefreshUsedTypeList();
  void BuildPickerTypeList();
  void EnsureSelectedTypeIsValid();
  void EnsureSelectedTypeIsVisible();
 
  GUIBadgeClasses badge_classes;
 
  IntervalTimer<TimerGameCalendar> yearly_interval = {{TimerGameCalendar::YEAR, TimerGameCalendar::Priority::NONE}, [this](auto) {
    this->SetDirty();
  }};
 
  IntervalTimer<TimerWindow> refresh_interval = {std::chrono::seconds(3), [this](auto) {
    RefreshUsedTypeList();
  }};
};
 
class NWidgetBase;
std::unique_ptr<NWidgetBase> MakePickerClassWidgets();
std::unique_ptr<NWidgetBase> MakePickerTypeWidgets();
 
#endif /* PICKER_GUI_H */