src/hotkeys.cpp

   1 /* $Id$ */
   2
   3 /*
   4  * This file is part of OpenTTD.
   5  * 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.
   6  * 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.
   7  * 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/>.
   8  */
   9
  10 /** @file hotkeys.cpp Implementation of hotkey related functions */
  11
  12 #include "stdafx.h"
  13 #include "openttd.h"
  14 #include "hotkeys.h"
  15 #include "ini_type.h"
  16 #include "string_func.h"
  17 #include "window_gui.h"
  18
  19 char *_hotkeys_file;
  20
  21 /**
  22  * List of all HotkeyLists.
  23  * This is a pointer to ensure initialisation order with the various static HotkeyList instances.
  24  */
  25 static SmallVector<HotkeyList*, 16> *_hotkey_lists = NULL;
  26
  27 /** String representation of a keycode */
  28 struct KeycodeNames {
  29         const char *name;       ///< Name of the keycode
  30         WindowKeyCodes keycode; ///< The keycode
  31 };
  32
  33 /** Array of non-standard keycodes that can be used in the hotkeys config file. */
  34 static const KeycodeNames _keycode_to_name[] = {
  35         {"SHIFT", WKC_SHIFT},
  36         {"CTRL", WKC_CTRL},
  37         {"ALT", WKC_ALT},
  38         {"META", WKC_META},
  39         {"GLOBAL", WKC_GLOBAL_HOTKEY},
  40         {"ESC", WKC_ESC},
  41         {"DEL", WKC_DELETE},
  42         {"RETURN", WKC_RETURN},
  43         {"BACKQUOTE", WKC_BACKQUOTE},
  44         {"F1", WKC_F1},
  45         {"F2", WKC_F2},
  46         {"F3", WKC_F3},
  47         {"F4", WKC_F4},
  48         {"F5", WKC_F5},
  49         {"F6", WKC_F6},
  50         {"F7", WKC_F7},
  51         {"F8", WKC_F8},
  52         {"F9", WKC_F9},
  53         {"F10", WKC_F10},
  54         {"F11", WKC_F11},
  55         {"F12", WKC_F12},
  56         {"PAUSE", WKC_PAUSE},
  57         {"COMMA", WKC_COMMA},
  58         {"NUM_PLUS", WKC_NUM_PLUS},
  59         {"NUM_MINUS", WKC_NUM_MINUS},
  60         {"=", WKC_EQUALS},
  61         {"-", WKC_MINUS},
  62 };
  63
  64 /**
  65  * Try to parse a single part of a keycode.
  66  * @param start Start of the string to parse.
  67  * @param end End of the string to parse.
  68  * @return A keycode if a match is found or 0.
  69  */
  70 static uint16 ParseCode(const char *start, const char *end)
  71 {
  72         assert(start <= end);
  73         while (start < end && *start == ' ') start++;
  74         while (end > start && *end == ' ') end--;
  75         for (uint i = 0; i < lengthof(_keycode_to_name); i++) {
  76                 if (strlen(_keycode_to_name[i].name) == (size_t)(end - start) && strncasecmp(start, _keycode_to_name[i].name, end - start) == 0) {
  77                         return _keycode_to_name[i].keycode;
  78                 }
  79         }
  80         if (end - start == 1) {
  81                 if (*start >= 'a' && *start <= 'z') return *start - ('a'-'A');
  82                 /* Ignore invalid keycodes */
  83                 if (*(const uint8 *)start < 128) return *start;
  84         }
  85         return 0;
  86 }
  87
  88 /**
  89  * Parse a string representation of a keycode.
  90  * @param start Start of the input.
  91  * @param end End of the input.
  92  * @return A valid keycode or 0.
  93  */
  94 static uint16 ParseKeycode(const char *start, const char *end)
  95 {
  96         assert(start <= end);
  97         uint16 keycode = 0;
  98         for (;;) {
  99                 const char *cur = start;
 100                 while (*cur != '+' && cur != end) cur++;
 101                 uint16 code = ParseCode(start, cur);
 102                 if (code == 0) return 0;
 103                 if (code & WKC_SPECIAL_KEYS) {
 104                         /* Some completely wrong keycode we don't support. */
 105                         if (code & ~WKC_SPECIAL_KEYS) return 0;
 106                         keycode |= code;
 107                 } else {
 108                         /* Ignore the code if it has more then 1 letter. */
 109                         if (keycode & ~WKC_SPECIAL_KEYS) return 0;
 110                         keycode |= code;
 111                 }
 112                 if (cur == end) break;
 113                 assert(cur < end);
 114                 start = cur + 1;
 115         }
 116         return keycode;
 117 }
 118
 119 /**
 120  * Parse a string to the keycodes it represents
 121  * @param hotkey The hotkey object to add the keycodes to
 122  * @param value The string to parse
 123  */
 124 static void ParseHotkeys(Hotkey *hotkey, const char *value)
 125 {
 126         const char *start = value;
 127         while (*start != '\0') {
 128                 const char *end = start;
 129                 while (*end != '\0' && *end != ',') end++;
 130                 uint16 keycode = ParseKeycode(start, end);
 131                 if (keycode != 0) hotkey->AddKeycode(keycode);
 132                 start = (*end == ',') ? end + 1: end;
 133         }
 134 }
 135
 136 /**
 137  * Convert a hotkey to it's string representation so it can be written to the
 138  * config file. Separate parts of the keycode (like "CTRL" and "F1" are split
 139  * by a '+'.
 140  * @param keycode The keycode to convert to a string.
 141  * @return A string representation of this keycode.
 142  * @note The return value is a static buffer, strdup the result before calling
 143  *  this function again.
 144  */
 145 static const char *KeycodeToString(uint16 keycode)
 146 {
 147         static char buf[32];
 148         buf[0] = '\0';
 149         bool first = true;
 150         if (keycode & WKC_GLOBAL_HOTKEY) {
 151                 strecat(buf, "GLOBAL", lastof(buf));
 152                 first = false;
 153         }
 154         if (keycode & WKC_SHIFT) {
 155                 if (!first) strecat(buf, "+", lastof(buf));
 156                 strecat(buf, "SHIFT", lastof(buf));
 157                 first = false;
 158         }
 159         if (keycode & WKC_CTRL) {
 160                 if (!first) strecat(buf, "+", lastof(buf));
 161                 strecat(buf, "CTRL", lastof(buf));
 162                 first = false;
 163         }
 164         if (keycode & WKC_ALT) {
 165                 if (!first) strecat(buf, "+", lastof(buf));
 166                 strecat(buf, "ALT", lastof(buf));
 167                 first = false;
 168         }
 169         if (keycode & WKC_META) {
 170                 if (!first) strecat(buf, "+", lastof(buf));
 171                 strecat(buf, "META", lastof(buf));
 172                 first = false;
 173         }
 174         if (!first) strecat(buf, "+", lastof(buf));
 175         keycode = keycode & ~WKC_SPECIAL_KEYS;
 176
 177         for (uint i = 0; i < lengthof(_keycode_to_name); i++) {
 178                 if (_keycode_to_name[i].keycode == keycode) {
 179                         strecat(buf, _keycode_to_name[i].name, lastof(buf));
 180                         return buf;
 181                 }
 182         }
 183         assert(keycode < 128);
 184         char key[2];
 185         key[0] = keycode;
 186         key[1] = '\0';
 187         strecat(buf, key, lastof(buf));
 188         return buf;
 189 }
 190
 191 /**
 192  * Convert all keycodes attached to a hotkey to a single string. If multiple
 193  * keycodes are attached to the hotkey they are split by a comma.
 194  * @param hotkey The keycodes of this hotkey need to be converted to a string.
 195  * @return A string representation of all keycodes.
 196  * @note The return value is a static buffer, strdup the result before calling
 197  *  this function again.
 198  */
 199 const char *SaveKeycodes(const Hotkey *hotkey)
 200 {
 201         static char buf[128];
 202         buf[0] = '\0';
 203         for (uint i = 0; i < hotkey->keycodes.Length(); i++) {
 204                 const char *str = KeycodeToString(hotkey->keycodes[i]);
 205                 if (i > 0) strecat(buf, ",", lastof(buf));
 206                 strecat(buf, str, lastof(buf));
 207         }
 208         return buf;
 209 }
 210
 211 /**
 212  * Create a new Hotkey object with a single default keycode.
 213  * @param default_keycode The default keycode for this hotkey.
 214  * @param name The name of this hotkey.
 215  * @param num Number of this hotkey, should be unique within the hotkey list.
 216  */
 217 Hotkey::Hotkey(uint16 default_keycode, const char *name, int num) :
 218         name(name),
 219         num(num)
 220 {
 221         if (default_keycode != 0) this->AddKeycode(default_keycode);
 222 }
 223
 224 /**
 225  * Create a new Hotkey object with multiple default keycodes.
 226  * @param default_keycodes An array of default keycodes terminated with 0.
 227  * @param name The name of this hotkey.
 228  * @param num Number of this hotkey, should be unique within the hotkey list.
 229  */
 230 Hotkey::Hotkey(const uint16 *default_keycodes, const char *name, int num) :
 231         name(name),
 232         num(num)
 233 {
 234         const uint16 *keycode = default_keycodes;
 235         while (*keycode != 0) {
 236                 this->AddKeycode(*keycode);
 237                 keycode++;
 238         }
 239 }
 240
 241 /**
 242  * Add a keycode to this hotkey, from now that keycode will be matched
 243  * in addition to any previously added keycodes.
 244  * @param keycode The keycode to add.
 245  */
 246 void Hotkey::AddKeycode(uint16 keycode)
 247 {
 248         this->keycodes.Include(keycode);
 249 }
 250
 251 HotkeyList::HotkeyList(const char *ini_group, Hotkey *items, GlobalHotkeyHandlerFunc global_hotkey_handler) :
 252         global_hotkey_handler(global_hotkey_handler), ini_group(ini_group), items(items)
 253 {
 254         if (_hotkey_lists == NULL) _hotkey_lists = new SmallVector<HotkeyList*, 16>();
 255         *_hotkey_lists->Append() = this;
 256 }
 257
 258 HotkeyList::~HotkeyList()
 259 {
 260         _hotkey_lists->Erase(_hotkey_lists->Find(this));
 261 }
 262
 263 /**
 264  * Load HotkeyList from IniFile.
 265  * @param ini IniFile to load from.
 266  */
 267 void HotkeyList::Load(IniFile *ini)
 268 {
 269         IniGroup *group = ini->GetGroup(this->ini_group);
 270         for (Hotkey *hotkey = this->items; hotkey->name != NULL; ++hotkey) {
 271                 IniItem *item = group->GetItem(hotkey->name, false);
 272                 if (item != NULL) {
 273                         hotkey->keycodes.Clear();
 274                         if (item->value != NULL) ParseHotkeys(hotkey, item->value);
 275                 }
 276         }
 277 }
 278
 279 /**
 280  * Save HotkeyList to IniFile.
 281  * @param ini IniFile to save to.
 282  */
 283 void HotkeyList::Save(IniFile *ini) const
 284 {
 285         IniGroup *group = ini->GetGroup(this->ini_group);
 286         for (const Hotkey *hotkey = this->items; hotkey->name != NULL; ++hotkey) {
 287                 IniItem *item = group->GetItem(hotkey->name, true);
 288                 item->SetValue(SaveKeycodes(hotkey));
 289         }
 290 }
 291
 292 /**
 293  * Check if a keycode is bound to something.
 294  * @param keycode The keycode that was pressed
 295  * @param global_only Limit the search to hotkeys defined as 'global'.
 296  * @return The number of the matching hotkey or -1.
 297  */
 298 int HotkeyList::CheckMatch(uint16 keycode, bool global_only) const
 299 {
 300         for (const Hotkey *list = this->items; list->name != NULL; ++list) {
 301                 if (list->keycodes.Contains(keycode | WKC_GLOBAL_HOTKEY) || (!global_only && list->keycodes.Contains(keycode))) {
 302                         return list->num;
 303                 }
 304         }
 305         return -1;
 306 }
 307
 308
 309 static void SaveLoadHotkeys(bool save)
 310 {
 311         IniFile *ini = new IniFile();
 312         ini->LoadFromDisk(_hotkeys_file, BASE_DIR);
 313
 314         for (HotkeyList **list = _hotkey_lists->Begin(); list != _hotkey_lists->End(); ++list) {
 315                 if (save) {
 316                         (*list)->Save(ini);
 317                 } else {
 318                         (*list)->Load(ini);
 319                 }
 320         }
 321
 322         if (save) ini->SaveToDisk(_hotkeys_file);
 323         delete ini;
 324 }
 325
 326
 327 /** Load the hotkeys from the config file */
 328 void LoadHotkeysFromConfig()
 329 {
 330         SaveLoadHotkeys(false);
 331 }
 332
 333 /** Save the hotkeys to the config file */
 334 void SaveHotkeysToConfig()
 335 {
 336         SaveLoadHotkeys(true);
 337 }
 338
 339 void HandleGlobalHotkeys(WChar key, uint16 keycode)
 340 {
 341         for (HotkeyList **list = _hotkey_lists->Begin(); list != _hotkey_lists->End(); ++list) {
 342                 if ((*list)->global_hotkey_handler == NULL) continue;
 343
 344                 int hotkey = (*list)->CheckMatch(keycode, true);
 345                 if (hotkey >= 0 && ((*list)->global_hotkey_handler(hotkey) == ES_HANDLED)) return;
 346         }
 347 }
 348