hotkeys.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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */

 
#ifndef HOTKEYS_H
#define HOTKEYS_H
 
#include "core/enum_type.hpp"
#include "gfx_type.h"
#include "window_type.h"
#include "string_type.h"

struct Hotkey {
  Hotkey(uint16_t default_keycode, const std::string &name, int num);
  Hotkey(const std::vector<uint16_t> &default_keycodes, const std::string &name, int num);

  template <typename EnumType> requires is_scoped_enum_v<EnumType>
  Hotkey(uint16_t default_keycode, const std::string &name, EnumType num) : Hotkey(default_keycode, name, to_underlying(num)) {}

  template <typename EnumType> requires is_scoped_enum_v<EnumType>
  Hotkey(const std::vector<uint16_t> &default_keycodes, const std::string &name, EnumType num) : Hotkey(default_keycodes, name, to_underlying(num)) {}
 
  void AddKeycode(uint16_t keycode);
 
  const std::string name;
  int num;
  std::set<uint16_t> keycodes;
};
 
struct IniFile;

struct HotkeyList {
  typedef EventState (*GlobalHotkeyHandlerFunc)(int hotkey);
 
  HotkeyList(const std::string &ini_group, const std::vector<Hotkey> &items, GlobalHotkeyHandlerFunc global_hotkey_handler = nullptr);
  ~HotkeyList();
 
  void Load(const IniFile &ini);
  void Save(IniFile &ini) const;
 
  int CheckMatch(uint16_t keycode, bool global_only = false) const;
 
  GlobalHotkeyHandlerFunc global_hotkey_handler;
private:
  const std::string ini_group;
  std::vector<Hotkey> items;

  HotkeyList(const HotkeyList &other);
};
 
bool IsQuitKey(uint16_t keycode);
 
void LoadHotkeysFromConfig();
void SaveHotkeysToConfig();
 
void HandleGlobalHotkeys(char32_t key, uint16_t keycode);
 
static constexpr int SPECIAL_HOTKEY_BIT = 30; 

inline bool IsSpecialHotkey(const int &hotkey)
{
  return HasBit(hotkey, SPECIAL_HOTKEY_BIT);
}

enum class SpecialListHotkeys : int {
  PreviousItem = 1 << SPECIAL_HOTKEY_BIT, 
  NextItem, 
  FirstItem, 
  LastItem, 
};

template<class ItemType, class ListType>
std::tuple<size_t, size_t> GetListIndexStep(SpecialListHotkeys hotkey, const ListType &list, const ItemType &current_item)
{
  /* Don't use -1, because how % is implemented for negative numbers. */
  size_t step_back = list.size() - 1;
  auto get_relative_index_step = [list, current_item](size_t step) -> std::tuple<size_t, size_t> {
    size_t index = std::distance(list.begin(), std::ranges::find(list, current_item));
    return {(index + step) % list.size(), step};
  };
 
  switch (hotkey) {
    default: NOT_REACHED();
    case SpecialListHotkeys::FirstItem:
      return {0, 1};
 
    case SpecialListHotkeys::LastItem:
      return {list.size() - 1, step_back};
 
    case SpecialListHotkeys::PreviousItem:
      return get_relative_index_step(step_back);
 
    case SpecialListHotkeys::NextItem:
      return get_relative_index_step(1);
  }
}
 
#endif /* HOTKEYS_H */