LCOV - code coverage report
Current view: top level - src - keycode.cpp (source / functions) Hit Total Coverage
Test: report Lines: 187 212 88.2 %
Date: 2015-07-11 18:23:49 Functions: 10 14 71.4 %

          Line data    Source code
       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           4 : class UnknownKeycode : public BaseException
      28             : {
      29             : public:
      30           4 :         UnknownKeycode(const char *s) :
      31           4 :                 BaseException(s) {};
      32             : };
      33             : 
      34             : #define CHECKKEY(x){if(strcmp(name, #x)==0) return irr::x;}
      35             : 
      36          45 : irr::EKEY_CODE keyname_to_keycode(const char *name)
      37             : {
      38          45 :         CHECKKEY(KEY_LBUTTON)
      39          45 :         CHECKKEY(KEY_RBUTTON)
      40          45 :         CHECKKEY(KEY_CANCEL)
      41          44 :         CHECKKEY(KEY_MBUTTON)
      42          44 :         CHECKKEY(KEY_XBUTTON1)
      43          44 :         CHECKKEY(KEY_XBUTTON2)
      44          44 :         CHECKKEY(KEY_BACK)
      45          44 :         CHECKKEY(KEY_TAB)
      46          44 :         CHECKKEY(KEY_CLEAR)
      47          44 :         CHECKKEY(KEY_RETURN)
      48          44 :         CHECKKEY(KEY_SHIFT)
      49          44 :         CHECKKEY(KEY_CONTROL)
      50          44 :         CHECKKEY(KEY_MENU)
      51          44 :         CHECKKEY(KEY_PAUSE)
      52          44 :         CHECKKEY(KEY_CAPITAL)
      53          44 :         CHECKKEY(KEY_KANA)
      54          44 :         CHECKKEY(KEY_HANGUEL)
      55          44 :         CHECKKEY(KEY_HANGUL)
      56          44 :         CHECKKEY(KEY_JUNJA)
      57          44 :         CHECKKEY(KEY_FINAL)
      58          44 :         CHECKKEY(KEY_HANJA)
      59          44 :         CHECKKEY(KEY_KANJI)
      60          44 :         CHECKKEY(KEY_ESCAPE)
      61          43 :         CHECKKEY(KEY_CONVERT)
      62          43 :         CHECKKEY(KEY_NONCONVERT)
      63          43 :         CHECKKEY(KEY_ACCEPT)
      64          43 :         CHECKKEY(KEY_MODECHANGE)
      65          43 :         CHECKKEY(KEY_SPACE)
      66          42 :         CHECKKEY(KEY_PRIOR)
      67          41 :         CHECKKEY(KEY_NEXT)
      68          40 :         CHECKKEY(KEY_END)
      69          39 :         CHECKKEY(KEY_HOME)
      70          38 :         CHECKKEY(KEY_LEFT)
      71          38 :         CHECKKEY(KEY_UP)
      72          38 :         CHECKKEY(KEY_RIGHT)
      73          38 :         CHECKKEY(KEY_DOWN)
      74          38 :         CHECKKEY(KEY_SELECT)
      75          38 :         CHECKKEY(KEY_PRINT)
      76          38 :         CHECKKEY(KEY_EXECUT)
      77          38 :         CHECKKEY(KEY_SNAPSHOT)
      78          38 :         CHECKKEY(KEY_INSERT)
      79          38 :         CHECKKEY(KEY_DELETE)
      80          38 :         CHECKKEY(KEY_HELP)
      81          38 :         CHECKKEY(KEY_KEY_0)
      82          37 :         CHECKKEY(KEY_KEY_1)
      83          36 :         CHECKKEY(KEY_KEY_2)
      84          35 :         CHECKKEY(KEY_KEY_3)
      85          34 :         CHECKKEY(KEY_KEY_4)
      86          33 :         CHECKKEY(KEY_KEY_5)
      87          32 :         CHECKKEY(KEY_KEY_6)
      88          31 :         CHECKKEY(KEY_KEY_7)
      89          30 :         CHECKKEY(KEY_KEY_8)
      90          29 :         CHECKKEY(KEY_KEY_9)
      91          28 :         CHECKKEY(KEY_KEY_A)
      92          27 :         CHECKKEY(KEY_KEY_B)
      93          27 :         CHECKKEY(KEY_KEY_C)
      94          27 :         CHECKKEY(KEY_KEY_D)
      95          26 :         CHECKKEY(KEY_KEY_E)
      96          25 :         CHECKKEY(KEY_KEY_F)
      97          25 :         CHECKKEY(KEY_KEY_G)
      98          25 :         CHECKKEY(KEY_KEY_H)
      99          24 :         CHECKKEY(KEY_KEY_I)
     100          23 :         CHECKKEY(KEY_KEY_J)
     101          22 :         CHECKKEY(KEY_KEY_K)
     102          21 :         CHECKKEY(KEY_KEY_L)
     103          21 :         CHECKKEY(KEY_KEY_M)
     104          21 :         CHECKKEY(KEY_KEY_N)
     105          21 :         CHECKKEY(KEY_KEY_O)
     106          21 :         CHECKKEY(KEY_KEY_P)
     107          20 :         CHECKKEY(KEY_KEY_Q)
     108          19 :         CHECKKEY(KEY_KEY_R)
     109          18 :         CHECKKEY(KEY_KEY_S)
     110          17 :         CHECKKEY(KEY_KEY_T)
     111          16 :         CHECKKEY(KEY_KEY_U)
     112          16 :         CHECKKEY(KEY_KEY_V)
     113          16 :         CHECKKEY(KEY_KEY_W)
     114          15 :         CHECKKEY(KEY_KEY_X)
     115          15 :         CHECKKEY(KEY_KEY_Y)
     116          15 :         CHECKKEY(KEY_KEY_Z)
     117          15 :         CHECKKEY(KEY_LWIN)
     118          15 :         CHECKKEY(KEY_RWIN)
     119          15 :         CHECKKEY(KEY_APPS)
     120          15 :         CHECKKEY(KEY_SLEEP)
     121          15 :         CHECKKEY(KEY_NUMPAD0)
     122          15 :         CHECKKEY(KEY_NUMPAD1)
     123          15 :         CHECKKEY(KEY_NUMPAD2)
     124          15 :         CHECKKEY(KEY_NUMPAD3)
     125          15 :         CHECKKEY(KEY_NUMPAD4)
     126          15 :         CHECKKEY(KEY_NUMPAD5)
     127          15 :         CHECKKEY(KEY_NUMPAD6)
     128          15 :         CHECKKEY(KEY_NUMPAD7)
     129          15 :         CHECKKEY(KEY_NUMPAD8)
     130          15 :         CHECKKEY(KEY_NUMPAD9)
     131          15 :         CHECKKEY(KEY_MULTIPLY)
     132          15 :         CHECKKEY(KEY_ADD)
     133          15 :         CHECKKEY(KEY_SEPARATOR)
     134          15 :         CHECKKEY(KEY_SUBTRACT)
     135          15 :         CHECKKEY(KEY_DECIMAL)
     136          15 :         CHECKKEY(KEY_DIVIDE)
     137          15 :         CHECKKEY(KEY_F1)
     138          14 :         CHECKKEY(KEY_F2)
     139          13 :         CHECKKEY(KEY_F3)
     140          12 :         CHECKKEY(KEY_F4)
     141          12 :         CHECKKEY(KEY_F5)
     142          11 :         CHECKKEY(KEY_F6)
     143          10 :         CHECKKEY(KEY_F7)
     144           9 :         CHECKKEY(KEY_F8)
     145           8 :         CHECKKEY(KEY_F9)
     146           7 :         CHECKKEY(KEY_F10)
     147           6 :         CHECKKEY(KEY_F11)
     148           6 :         CHECKKEY(KEY_F12)
     149           5 :         CHECKKEY(KEY_F13)
     150           5 :         CHECKKEY(KEY_F14)
     151           5 :         CHECKKEY(KEY_F15)
     152           5 :         CHECKKEY(KEY_F16)
     153           5 :         CHECKKEY(KEY_F17)
     154           5 :         CHECKKEY(KEY_F18)
     155           5 :         CHECKKEY(KEY_F19)
     156           5 :         CHECKKEY(KEY_F20)
     157           5 :         CHECKKEY(KEY_F21)
     158           5 :         CHECKKEY(KEY_F22)
     159           5 :         CHECKKEY(KEY_F23)
     160           5 :         CHECKKEY(KEY_F24)
     161           5 :         CHECKKEY(KEY_NUMLOCK)
     162           5 :         CHECKKEY(KEY_SCROLL)
     163           5 :         CHECKKEY(KEY_LSHIFT)
     164           4 :         CHECKKEY(KEY_RSHIFT)
     165           4 :         CHECKKEY(KEY_LCONTROL)
     166           4 :         CHECKKEY(KEY_RCONTROL)
     167           4 :         CHECKKEY(KEY_LMENU)
     168           4 :         CHECKKEY(KEY_RMENU)
     169           4 :         CHECKKEY(KEY_PLUS)
     170           4 :         CHECKKEY(KEY_COMMA)
     171           4 :         CHECKKEY(KEY_MINUS)
     172           4 :         CHECKKEY(KEY_PERIOD)
     173           4 :         CHECKKEY(KEY_ATTN)
     174           4 :         CHECKKEY(KEY_CRSEL)
     175           4 :         CHECKKEY(KEY_EXSEL)
     176           4 :         CHECKKEY(KEY_EREOF)
     177           4 :         CHECKKEY(KEY_PLAY)
     178           4 :         CHECKKEY(KEY_ZOOM)
     179           4 :         CHECKKEY(KEY_PA1)
     180           4 :         CHECKKEY(KEY_OEM_CLEAR)
     181             : 
     182           4 :         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          66 : KeyPress::KeyPress() :
     253             :         Key(irr::KEY_KEY_CODES_COUNT),
     254          66 :         Char(L'\0')
     255          66 : {}
     256             : 
     257          45 : KeyPress::KeyPress(const char *name)
     258             : {
     259          45 :         if (strlen(name) > 4) {
     260             :                 try {
     261          41 :                         Key = keyname_to_keycode(name);
     262          41 :                         m_name = name;
     263          41 :                         if (strlen(name) > 8 && strncmp(name, "KEY_KEY_", 8) == 0) {
     264          23 :                                 int chars_read = mbtowc(&Char, name + 8, 1);
     265             : 
     266          23 :                                 FATAL_ERROR_IF(chars_read != 1, "Unexpected multibyte character");
     267             :                         } else
     268          18 :                                 Char = L'\0';
     269          41 :                         return;
     270           0 :                 } catch (UnknownKeycode &e) {};
     271             :         } else {
     272             :                 // see if we can set it up as a KEY_KEY_something
     273           4 :                 m_name = "KEY_KEY_";
     274           4 :                 m_name += name;
     275             :                 try {
     276           4 :                         Key = keyname_to_keycode(m_name.c_str());
     277           0 :                         int chars_read = mbtowc(&Char, name, 1);
     278             : 
     279           0 :                         FATAL_ERROR_IF(chars_read != 1, "Unexpected multibyte character");
     280           0 :                         return;
     281           4 :                 } catch (UnknownKeycode &e) {};
     282             :         }
     283             : 
     284             :         // it's not a (known) key, just take the first char and use that
     285             : 
     286           4 :         Key = irr::KEY_KEY_CODES_COUNT;
     287             : 
     288           4 :         int mbtowc_ret = mbtowc(&Char, name, 1);
     289           4 :         FATAL_ERROR_IF(mbtowc_ret != 1, "Unexpected multibyte character");
     290           4 :         m_name = name[0];
     291             : }
     292             : 
     293         256 : KeyPress::KeyPress(const irr::SEvent::SKeyInput &in, bool prefer_character)
     294             : {
     295         256 :         Key = in.Key;
     296         256 :         Char = in.Char;
     297             : 
     298         256 :         if(prefer_character){
     299           0 :                 m_name.resize(MB_CUR_MAX+1, '\0');
     300           0 :                 int written = wctomb(&m_name[0], Char);
     301           0 :                 if(written > 0){
     302           0 :                         infostream<<"KeyPress: Preferring character for "<<m_name<<std::endl;
     303           0 :                         Key = irr::KEY_KEY_CODES_COUNT;
     304           0 :                         return;
     305             :                 }
     306             :         }
     307             : 
     308         256 :         if (valid_kcode(Key)) {
     309         256 :                 m_name = KeyNames[Key];
     310             :         } else {
     311           0 :                 m_name.resize(MB_CUR_MAX+1, '\0');
     312           0 :                 int written = wctomb(&m_name[0], Char);
     313           0 :                 if(written < 0){
     314           0 :                         std::string hexstr = hex_encode((const char*)&Char, sizeof(Char));
     315           0 :                         errorstream<<"KeyPress: Unexpected multibyte character "<<hexstr<<std::endl;
     316             :                 }
     317             :         }
     318             : }
     319             : 
     320           0 : const char *KeyPress::sym() const
     321             : {
     322           0 :         if (Key && Key < irr::KEY_KEY_CODES_COUNT)
     323           0 :                 return KeyNames[Key];
     324             :         else {
     325           0 :                 return m_name.c_str();
     326             :         }
     327             : }
     328             : 
     329           0 : const char *KeyPress::name() const
     330             : {
     331           0 :         if (Key && Key < irr::KEY_KEY_CODES_COUNT)
     332           0 :                 return KeyNamesLang[Key];
     333             :         else {
     334           0 :                 return m_name.c_str();
     335             :         }
     336             : }
     337             : 
     338           1 : const KeyPress EscapeKey("KEY_ESCAPE");
     339           1 : const KeyPress CancelKey("KEY_CANCEL");
     340           2 : const KeyPress NumberKey[] = {
     341             :         KeyPress("KEY_KEY_0"), KeyPress("KEY_KEY_1"), KeyPress("KEY_KEY_2"),
     342             :         KeyPress("KEY_KEY_3"), KeyPress("KEY_KEY_4"), KeyPress("KEY_KEY_5"),
     343             :         KeyPress("KEY_KEY_6"), KeyPress("KEY_KEY_7"), KeyPress("KEY_KEY_8"),
     344           1 :         KeyPress("KEY_KEY_9")};
     345             : 
     346             : /*
     347             :         Key config
     348             : */
     349             : 
     350             : // A simple cache for quicker lookup
     351           1 : std::map<std::string, KeyPress> g_key_setting_cache;
     352             : 
     353        1199 : KeyPress getKeySetting(const char *settingname)
     354             : {
     355        1199 :         std::map<std::string, KeyPress>::iterator n;
     356        1199 :         n = g_key_setting_cache.find(settingname);
     357        1199 :         if(n != g_key_setting_cache.end())
     358        1166 :                 return n->second;
     359          33 :         g_key_setting_cache[settingname] = g_settings->get(settingname).c_str();
     360          33 :         return g_key_setting_cache.find(settingname)->second;
     361             : }
     362             : 
     363           0 : void clearKeyCache()
     364             : {
     365           0 :         g_key_setting_cache.clear();
     366           3 : }

Generated by: LCOV version 1.11