src/keycode.cpp

   1 /*
   2 Minetest
   3 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #include "keycode.h"
  21 #include "exceptions.h"
  22 #include "settings.h"
  23 #include "log.h"
  24 #include "debug.h"
  25 #include "util/hex.h"
  26
  27 class UnknownKeycode : public BaseException
  28 {
  29 public:
  30         UnknownKeycode(const char *s) :
  31                 BaseException(s) {};
  32 };
  33
  34 #define CHECKKEY(x){if(strcmp(name, #x)==0) return irr::x;}
  35
  36 irr::EKEY_CODE keyname_to_keycode(const char *name)
  37 {
  38         CHECKKEY(KEY_LBUTTON)
  39         CHECKKEY(KEY_RBUTTON)
  40         CHECKKEY(KEY_CANCEL)
  41         CHECKKEY(KEY_MBUTTON)
  42         CHECKKEY(KEY_XBUTTON1)
  43         CHECKKEY(KEY_XBUTTON2)
  44         CHECKKEY(KEY_BACK)
  45         CHECKKEY(KEY_TAB)
  46         CHECKKEY(KEY_CLEAR)
  47         CHECKKEY(KEY_RETURN)
  48         CHECKKEY(KEY_SHIFT)
  49         CHECKKEY(KEY_CONTROL)
  50         CHECKKEY(KEY_MENU)
  51         CHECKKEY(KEY_PAUSE)
  52         CHECKKEY(KEY_CAPITAL)
  53         CHECKKEY(KEY_KANA)
  54         CHECKKEY(KEY_HANGUEL)
  55         CHECKKEY(KEY_HANGUL)
  56         CHECKKEY(KEY_JUNJA)
  57         CHECKKEY(KEY_FINAL)
  58         CHECKKEY(KEY_HANJA)
  59         CHECKKEY(KEY_KANJI)
  60         CHECKKEY(KEY_ESCAPE)
  61         CHECKKEY(KEY_CONVERT)
  62         CHECKKEY(KEY_NONCONVERT)
  63         CHECKKEY(KEY_ACCEPT)
  64         CHECKKEY(KEY_MODECHANGE)
  65         CHECKKEY(KEY_SPACE)
  66         CHECKKEY(KEY_PRIOR)
  67         CHECKKEY(KEY_NEXT)
  68         CHECKKEY(KEY_END)
  69         CHECKKEY(KEY_HOME)
  70         CHECKKEY(KEY_LEFT)
  71         CHECKKEY(KEY_UP)
  72         CHECKKEY(KEY_RIGHT)
  73         CHECKKEY(KEY_DOWN)
  74         CHECKKEY(KEY_SELECT)
  75         CHECKKEY(KEY_PRINT)
  76         CHECKKEY(KEY_EXECUT)
  77         CHECKKEY(KEY_SNAPSHOT)
  78         CHECKKEY(KEY_INSERT)
  79         CHECKKEY(KEY_DELETE)
  80         CHECKKEY(KEY_HELP)
  81         CHECKKEY(KEY_KEY_0)
  82         CHECKKEY(KEY_KEY_1)
  83         CHECKKEY(KEY_KEY_2)
  84         CHECKKEY(KEY_KEY_3)
  85         CHECKKEY(KEY_KEY_4)
  86         CHECKKEY(KEY_KEY_5)
  87         CHECKKEY(KEY_KEY_6)
  88         CHECKKEY(KEY_KEY_7)
  89         CHECKKEY(KEY_KEY_8)
  90         CHECKKEY(KEY_KEY_9)
  91         CHECKKEY(KEY_KEY_A)
  92         CHECKKEY(KEY_KEY_B)
  93         CHECKKEY(KEY_KEY_C)
  94         CHECKKEY(KEY_KEY_D)
  95         CHECKKEY(KEY_KEY_E)
  96         CHECKKEY(KEY_KEY_F)
  97         CHECKKEY(KEY_KEY_G)
  98         CHECKKEY(KEY_KEY_H)
  99         CHECKKEY(KEY_KEY_I)
 100         CHECKKEY(KEY_KEY_J)
 101         CHECKKEY(KEY_KEY_K)
 102         CHECKKEY(KEY_KEY_L)
 103         CHECKKEY(KEY_KEY_M)
 104         CHECKKEY(KEY_KEY_N)
 105         CHECKKEY(KEY_KEY_O)
 106         CHECKKEY(KEY_KEY_P)
 107         CHECKKEY(KEY_KEY_Q)
 108         CHECKKEY(KEY_KEY_R)
 109         CHECKKEY(KEY_KEY_S)
 110         CHECKKEY(KEY_KEY_T)
 111         CHECKKEY(KEY_KEY_U)
 112         CHECKKEY(KEY_KEY_V)
 113         CHECKKEY(KEY_KEY_W)
 114         CHECKKEY(KEY_KEY_X)
 115         CHECKKEY(KEY_KEY_Y)
 116         CHECKKEY(KEY_KEY_Z)
 117         CHECKKEY(KEY_LWIN)
 118         CHECKKEY(KEY_RWIN)
 119         CHECKKEY(KEY_APPS)
 120         CHECKKEY(KEY_SLEEP)
 121         CHECKKEY(KEY_NUMPAD0)
 122         CHECKKEY(KEY_NUMPAD1)
 123         CHECKKEY(KEY_NUMPAD2)
 124         CHECKKEY(KEY_NUMPAD3)
 125         CHECKKEY(KEY_NUMPAD4)
 126         CHECKKEY(KEY_NUMPAD5)
 127         CHECKKEY(KEY_NUMPAD6)
 128         CHECKKEY(KEY_NUMPAD7)
 129         CHECKKEY(KEY_NUMPAD8)
 130         CHECKKEY(KEY_NUMPAD9)
 131         CHECKKEY(KEY_MULTIPLY)
 132         CHECKKEY(KEY_ADD)
 133         CHECKKEY(KEY_SEPARATOR)
 134         CHECKKEY(KEY_SUBTRACT)
 135         CHECKKEY(KEY_DECIMAL)
 136         CHECKKEY(KEY_DIVIDE)
 137         CHECKKEY(KEY_F1)
 138         CHECKKEY(KEY_F2)
 139         CHECKKEY(KEY_F3)
 140         CHECKKEY(KEY_F4)
 141         CHECKKEY(KEY_F5)
 142         CHECKKEY(KEY_F6)
 143         CHECKKEY(KEY_F7)
 144         CHECKKEY(KEY_F8)
 145         CHECKKEY(KEY_F9)
 146         CHECKKEY(KEY_F10)
 147         CHECKKEY(KEY_F11)
 148         CHECKKEY(KEY_F12)
 149         CHECKKEY(KEY_F13)
 150         CHECKKEY(KEY_F14)
 151         CHECKKEY(KEY_F15)
 152         CHECKKEY(KEY_F16)
 153         CHECKKEY(KEY_F17)
 154         CHECKKEY(KEY_F18)
 155         CHECKKEY(KEY_F19)
 156         CHECKKEY(KEY_F20)
 157         CHECKKEY(KEY_F21)
 158         CHECKKEY(KEY_F22)
 159         CHECKKEY(KEY_F23)
 160         CHECKKEY(KEY_F24)
 161         CHECKKEY(KEY_NUMLOCK)
 162         CHECKKEY(KEY_SCROLL)
 163         CHECKKEY(KEY_LSHIFT)
 164         CHECKKEY(KEY_RSHIFT)
 165         CHECKKEY(KEY_LCONTROL)
 166         CHECKKEY(KEY_RCONTROL)
 167         CHECKKEY(KEY_LMENU)
 168         CHECKKEY(KEY_RMENU)
 169         CHECKKEY(KEY_PLUS)
 170         CHECKKEY(KEY_COMMA)
 171         CHECKKEY(KEY_MINUS)
 172         CHECKKEY(KEY_PERIOD)
 173         CHECKKEY(KEY_ATTN)
 174         CHECKKEY(KEY_CRSEL)
 175         CHECKKEY(KEY_EXSEL)
 176         CHECKKEY(KEY_EREOF)
 177         CHECKKEY(KEY_PLAY)
 178         CHECKKEY(KEY_ZOOM)
 179         CHECKKEY(KEY_PA1)
 180         CHECKKEY(KEY_OEM_CLEAR)
 181
 182         throw UnknownKeycode(name);
 183 }
 184
 185 static const char *KeyNames[] =
 186 { "-", "KEY_LBUTTON", "KEY_RBUTTON", "KEY_CANCEL", "KEY_MBUTTON", "KEY_XBUTTON1",
 187                 "KEY_XBUTTON2", "-", "KEY_BACK", "KEY_TAB", "-", "-", "KEY_CLEAR", "KEY_RETURN", "-",
 188                 "-", "KEY_SHIFT", "KEY_CONTROL", "KEY_MENU", "KEY_PAUSE", "KEY_CAPITAL", "KEY_KANA", "-",
 189                 "KEY_JUNJA", "KEY_FINAL", "KEY_KANJI", "-", "KEY_ESCAPE", "KEY_CONVERT", "KEY_NONCONVERT",
 190                 "KEY_ACCEPT", "KEY_MODECHANGE", "KEY_SPACE", "KEY_PRIOR", "KEY_NEXT", "KEY_END",
 191                 "KEY_HOME", "KEY_LEFT", "KEY_UP", "KEY_RIGHT", "KEY_DOWN", "KEY_SELECT", "KEY_PRINT",
 192                 "KEY_EXECUTE", "KEY_SNAPSHOT", "KEY_INSERT", "KEY_DELETE", "KEY_HELP", "KEY_KEY_0",
 193                 "KEY_KEY_1", "KEY_KEY_2", "KEY_KEY_3", "KEY_KEY_4", "KEY_KEY_5",
 194                 "KEY_KEY_6", "KEY_KEY_7", "KEY_KEY_8", "KEY_KEY_9", "-", "-", "-", "-",
 195                 "-", "-", "-", "KEY_KEY_A", "KEY_KEY_B", "KEY_KEY_C", "KEY_KEY_D",
 196                 "KEY_KEY_E", "KEY_KEY_F", "KEY_KEY_G", "KEY_KEY_H", "KEY_KEY_I",
 197                 "KEY_KEY_J", "KEY_KEY_K", "KEY_KEY_L", "KEY_KEY_M", "KEY_KEY_N",
 198                 "KEY_KEY_O", "KEY_KEY_P", "KEY_KEY_Q", "KEY_KEY_R", "KEY_KEY_S",
 199                 "KEY_KEY_T", "KEY_KEY_U", "KEY_KEY_V", "KEY_KEY_W", "KEY_KEY_X",
 200                 "KEY_KEY_Y", "KEY_KEY_Z", "KEY_LWIN", "KEY_RWIN", "KEY_APPS", "-",
 201                 "KEY_SLEEP", "KEY_NUMPAD0", "KEY_NUMPAD1", "KEY_NUMPAD2", "KEY_NUMPAD3",
 202                 "KEY_NUMPAD4", "KEY_NUMPAD5", "KEY_NUMPAD6", "KEY_NUMPAD7",
 203                 "KEY_NUMPAD8", "KEY_NUMPAD9", "KEY_MULTIPLY", "KEY_ADD", "KEY_SEPERATOR",
 204                 "KEY_SUBTRACT", "KEY_DECIMAL", "KEY_DIVIDE", "KEY_F1", "KEY_F2", "KEY_F3",
 205                 "KEY_F4", "KEY_F5", "KEY_F6", "KEY_F7", "KEY_F8", "KEY_F9", "KEY_F10",
 206                 "KEY_F11", "KEY_F12", "KEY_F13", "KEY_F14", "KEY_F15", "KEY_F16",
 207                 "KEY_F17", "KEY_F18", "KEY_F19", "KEY_F20", "KEY_F21", "KEY_F22",
 208                 "KEY_F23", "KEY_F24", "-", "-", "-", "-", "-", "-", "-", "-",
 209                 "KEY_NUMLOCK", "KEY_SCROLL", "-", "-", "-", "-", "-", "-", "-", "-", "-",
 210                 "-", "-", "-", "-", "-", "KEY_LSHIFT", "KEY_RSHIFT", "KEY_LCONTROL",
 211                 "KEY_RCONTROL", "KEY_LMENU", "KEY_RMENU", "-", "-", "-", "-", "-",
 212                 "-", "-", "-", "-", "-", "-", "-", "-", "-", "-", "-", "-", "-", "-",
 213                 "-", "-", "KEY_PLUS", "KEY_COMMA", "KEY_MINUS", "KEY_PERIOD", "-", "-", "-", "-", "-",
 214                 "-", "-", "-", "-", "-", "-", "-", "-", "-", "-", "-", "-", "-", "-",
 215                 "-", "-", "-", "-", "-", "-", "-", "-", "-", "-", "-", "-", "-", "-",
 216                 "-", "-", "-", "-", "-", "-", "-", "-", "-", "-", "-", "-", "-", "-",
 217                 "-", "-", "-", "-", "-", "-", "-", "-", "KEY_ATTN", "KEY_CRSEL", "KEY_EXSEL",
 218                 "KEY_EREOF", "KEY_PLAY", "KEY_ZOOM", "KEY_PA1", "KEY_OEM_CLEAR", "-" };
 219
 220 #define N_(text) text
 221
 222 static const char *KeyNamesLang[] =
 223         { "-", N_("Left Button"), N_("Right Button"), N_("Cancel"), N_("Middle Button"), N_("X Button 1"),
 224                         N_("X Button 2"), "-", N_("Back"), N_("Tab"), "-", "-", N_("Clear"), N_("Return"), "-",
 225                         "-", N_("Shift"), N_("Control"), N_("Menu"), N_("Pause"), N_("Capital"), N_("Kana"), "-",
 226                         N_("Junja"), N_("Final"), N_("Kanji"), "-", N_("Escape"), N_("Convert"), N_("Nonconvert"),
 227                         N_("Accept"), N_("Mode Change"), N_("Space"), N_("Prior"), N_("Next"), N_("End"), N_("Home"),
 228                         N_("Left"), N_("Up"), N_("Right"), N_("Down"), N_("Select"), N_("Print"), N_("Execute"),
 229                         N_("Snapshot"), N_("Insert"), N_("Delete"), N_("Help"), "0", "1", "2", "3", "4", "5",
 230                         "6", "7", "8", "9", "-", "-", "-", "-", "-", "-", "-", "A", "B", "C",
 231                         "D", "E", "F", "G", "H", "I", "J", "K", "L", "M", "N", "O", "P", "Q",
 232                         "R", "S", "T", "U", "V", "W", "X", "Y", "Z", N_("Left Windows"),
 233                         N_("Right Windows"), N_("Apps"), "-", N_("Sleep"), N_("Numpad 0"), N_("Numpad 1"),
 234                         N_("Numpad 2"), N_("Numpad 3"), N_("Numpad 4"), N_("Numpad 5"), N_("Numpad 6"), N_("Numpad 7"),
 235                         N_("Numpad 8"), N_("Numpad 9"), N_("Numpad *"), N_("Numpad +"), N_("Numpad /"), N_("Numpad -"),
 236                         "Numpad .", "Numpad /", "F1", "F2", "F3", "F4", "F5", "F6", "F7", "F8",
 237                         "F9", "F10", "F11", "F12", "F13", "F14", "F15", "F16", "F17", "F18",
 238                         "F19", "F20", "F21", "F22", "F23", "F24", "-", "-", "-", "-", "-", "-",
 239                         "-", "-", N_("Num Lock"), N_("Scroll Lock"), "-", "-", "-", "-", "-", "-", "-",
 240                         "-", "-", "-", "-", "-", "-", "-", N_("Left Shift"), N_("Right Shift"),
 241                         N_("Left Control"), N_("Right Control"), N_("Left Menu"), N_("Right Menu"), "-", "-",
 242                         "-", "-", "-", "-", "-", "-", "-", "-", "-", "-", "-", "-", "-", "-",
 243                         "-", "-", "-", "-", "-", N_("Plus"), N_("Comma"), N_("Minus"), N_("Period"), "-", "-",
 244                         "-", "-", "-", "-", "-", "-", "-", "-", "-", "-", "-", "-", "-", "-",
 245                         "-", "-", "-", "-", "-", "-", "-", "-", "-", "-", "-", "-", "-", "-",
 246                         "-", "-", "-", "-", "-", "-", "-", "-", "-", "-", "-", "-", "-", "-",
 247                         "-", "-", "-", "-", "-", "-", "-", "-", "-", "-", "-", N_("Attn"), N_("CrSel"),
 248                         N_("ExSel"), N_("Erase OEF"), N_("Play"), N_("Zoom"), N_("PA1"), N_("OEM Clear"), "-" };
 249
 250 #undef N_
 251
 252 KeyPress::KeyPress() :
 253         Key(irr::KEY_KEY_CODES_COUNT),
 254         Char(L'\0')
 255 {}
 256
 257 KeyPress::KeyPress(const char *name)
 258 {
 259         if (name[0] == 0) {
 260                 Key = irr::KEY_KEY_CODES_COUNT;
 261                 Char = L'\0';
 262                 return;
 263         } else if (strlen(name) > 4) {
 264                 try {
 265                         Key = keyname_to_keycode(name);
 266                         m_name = name;
 267                         if (strlen(name) > 8 && strncmp(name, "KEY_KEY_", 8) == 0) {
 268                                 int chars_read = mbtowc(&Char, name + 8, 1);
 269
 270                                 FATAL_ERROR_IF(chars_read != 1, "Unexpected multibyte character");
 271                         } else
 272                                 Char = L'\0';
 273                         return;
 274                 } catch (UnknownKeycode &e) {};
 275         } else {
 276                 // see if we can set it up as a KEY_KEY_something
 277                 m_name = "KEY_KEY_";
 278                 m_name += name;
 279                 try {
 280                         Key = keyname_to_keycode(m_name.c_str());
 281                         int chars_read = mbtowc(&Char, name, 1);
 282
 283                         FATAL_ERROR_IF(chars_read != 1, "Unexpected multibyte character");
 284                         return;
 285                 } catch (UnknownKeycode &e) {};
 286         }
 287
 288         // it's not a (known) key, just take the first char and use that
 289
 290         Key = irr::KEY_KEY_CODES_COUNT;
 291
 292         int mbtowc_ret = mbtowc(&Char, name, 1);
 293         FATAL_ERROR_IF(mbtowc_ret != 1, "Unexpected multibyte character");
 294         m_name = name[0];
 295 }
 296
 297 KeyPress::KeyPress(const irr::SEvent::SKeyInput &in, bool prefer_character)
 298 {
 299         Key = in.Key;
 300         Char = in.Char;
 301
 302         if(prefer_character){
 303                 m_name.resize(MB_CUR_MAX+1, '\0');
 304                 int written = wctomb(&m_name[0], Char);
 305                 if(written > 0){
 306                         infostream<<"KeyPress: Preferring character for "<<m_name<<std::endl;
 307                         Key = irr::KEY_KEY_CODES_COUNT;
 308                         return;
 309                 }
 310         }
 311
 312         if (valid_kcode(Key)) {
 313                 m_name = KeyNames[Key];
 314         } else {
 315                 m_name.resize(MB_CUR_MAX+1, '\0');
 316                 int written = wctomb(&m_name[0], Char);
 317                 if(written < 0){
 318                         std::string hexstr = hex_encode((const char*)&Char, sizeof(Char));
 319                         errorstream<<"KeyPress: Unexpected multibyte character "<<hexstr<<std::endl;
 320                 }
 321         }
 322 }
 323
 324 const char *KeyPress::sym() const
 325 {
 326         if (Key && Key < irr::KEY_KEY_CODES_COUNT)
 327                 return KeyNames[Key];
 328         else {
 329                 return m_name.c_str();
 330         }
 331 }
 332
 333 const char *KeyPress::name() const
 334 {
 335         if (Key && Key < irr::KEY_KEY_CODES_COUNT)
 336                 return KeyNamesLang[Key];
 337         else {
 338                 return m_name.c_str();
 339         }
 340 }
 341
 342 const KeyPress EscapeKey("KEY_ESCAPE");
 343 const KeyPress CancelKey("KEY_CANCEL");
 344 const KeyPress NumberKey[] = {
 345         KeyPress("KEY_KEY_0"), KeyPress("KEY_KEY_1"), KeyPress("KEY_KEY_2"),
 346         KeyPress("KEY_KEY_3"), KeyPress("KEY_KEY_4"), KeyPress("KEY_KEY_5"),
 347         KeyPress("KEY_KEY_6"), KeyPress("KEY_KEY_7"), KeyPress("KEY_KEY_8"),
 348         KeyPress("KEY_KEY_9")};
 349
 350 /*
 351         Key config
 352 */
 353
 354 // A simple cache for quicker lookup
 355 std::map<std::string, KeyPress> g_key_setting_cache;
 356
 357 KeyPress getKeySetting(const char *settingname)
 358 {
 359         std::map<std::string, KeyPress>::iterator n;
 360         n = g_key_setting_cache.find(settingname);
 361         if(n != g_key_setting_cache.end())
 362                 return n->second;
 363         g_key_setting_cache[settingname] = g_settings->get(settingname).c_str();
 364         return g_key_setting_cache.find(settingname)->second;
 365 }
 366
 367 void clearKeyCache()
 368 {
 369         g_key_setting_cache.clear();
 370 }