dlls/kernel32/term.c

   1 /*
   2  * Interface to terminfo and termcap libraries
   3  *
   4  * Copyright 2010 Eric Pouech
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  19  */
  20
  21 #include "config.h"
  22 #include "wine/port.h"
  23
  24 #include <stdarg.h>
  25 #ifdef HAVE_NCURSES_H
  26 # include <ncurses.h>
  27 #elif defined(HAVE_CURSES_H)
  28 # include <curses.h>
  29 #endif
  30 /* avoid redefinition warnings */
  31 #undef KEY_EVENT
  32 #undef MOUSE_MOVED
  33
  34 #include <term.h>
  35
  36 #include <windef.h>
  37 #include <winbase.h>
  38 #include <winnls.h>
  39 #include <wincon.h>
  40 #include "console_private.h"
  41 #include "wine/library.h"
  42 #include "wine/debug.h"
  43
  44 WINE_DEFAULT_DEBUG_CHANNEL(console);
  45
  46 static const int vkkeyscan_table[256] =
  47 {
  48      0,0,0,0,0,0,0,0,8,9,0,0,0,13,0,0,0,0,0,19,145,556,0,0,0,0,0,27,0,0,0,
  49      0,32,305,478,307,308,309,311,222,313,304,312,443,188,189,190,191,48,
  50      49,50,51,52,53,54,55,56,57,442,186,444,187,446,447,306,321,322,323,
  51      324,325,326,327,328,329,330,331,332,333,334,335,336,337,338,339,340,
  52      341,342,343,344,345,346,219,220,221,310,445,192,65,66,67,68,69,70,71,
  53      72,73,74,75,76,77,78,79,80,81,82,83,84,85,86,87,88,89,90,475,476,477,
  54      448,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
  55      0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
  56      0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
  57      0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,400,0,0,0,0,0,0
  58 };
  59
  60 static const int mapvkey_0[256] =
  61 {
  62      0,0,0,0,0,0,0,0,14,15,0,0,0,28,0,0,42,29,56,69,58,0,0,0,0,0,0,1,0,0,
  63      0,0,57,73,81,79,71,75,72,77,80,0,0,0,55,82,83,0,11,2,3,4,5,6,7,8,9,
  64      10,0,0,0,0,0,0,0,30,48,46,32,18,33,34,35,23,36,37,38,50,49,24,25,16,
  65      19,31,20,22,47,17,45,21,44,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,55,78,0,74,
  66      0,53,59,60,61,62,63,64,65,66,67,68,87,88,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
  67      0,0,0,0,0,0,69,70,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
  68      0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,39,13,51,12,52,53,41,0,0,0,0,0,0,0,0,0,
  69      0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,26,43,27,40,76,96,0,0,0,0,0,0,0,0,
  70      0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
  71 };
  72
  73 static inline void init_complex_char(INPUT_RECORD* ir, BOOL down, WORD vk, WORD kc, DWORD cks)
  74 {
  75     ir->EventType                        = KEY_EVENT;
  76     ir->Event.KeyEvent.bKeyDown          = down;
  77     ir->Event.KeyEvent.wRepeatCount      = 1;
  78     ir->Event.KeyEvent.wVirtualScanCode  = vk;
  79     ir->Event.KeyEvent.wVirtualKeyCode   = kc;
  80     ir->Event.KeyEvent.dwControlKeyState = cks;
  81     ir->Event.KeyEvent.uChar.UnicodeChar = 0;
  82 }
  83
  84 /******************************************************************
  85  *              TERM_FillSimpleChar
  86  *
  87  */
  88 unsigned TERM_FillSimpleChar(unsigned real_inchar, INPUT_RECORD* ir)
  89 {
  90     unsigned            vk;
  91     unsigned            inchar;
  92     char                ch;
  93     unsigned            numEvent = 0;
  94     DWORD               cks = 0;
  95
  96     switch (real_inchar)
  97     {
  98     case   9: inchar = real_inchar;
  99         real_inchar = 27; /* so that we don't think key is ctrl- something */
 100         break;
 101     case  13:
 102     case  10: inchar = '\r';
 103         real_inchar = 27; /* Fixme: so that we don't think key is ctrl- something */
 104         break;
 105     case 127: inchar = '\b';
 106         break;
 107     default:
 108         inchar = real_inchar;
 109         break;
 110     }
 111     if ((inchar & ~0xFF) != 0) FIXME("What a char (%u)\n", inchar);
 112     vk = vkkeyscan_table[inchar];
 113     if (vk & 0x0100)
 114         init_complex_char(&ir[numEvent++], 1, 0x2a, 0x10, SHIFT_PRESSED);
 115     if ((vk & 0x0200) || (unsigned char)real_inchar <= 26)
 116         init_complex_char(&ir[numEvent++], 1, 0x1d, 0x11, LEFT_CTRL_PRESSED);
 117     if (vk & 0x0400)
 118         init_complex_char(&ir[numEvent++], 1, 0x38, 0x12, LEFT_ALT_PRESSED);
 119
 120     ir[numEvent].EventType                        = KEY_EVENT;
 121     ir[numEvent].Event.KeyEvent.bKeyDown          = 1;
 122     ir[numEvent].Event.KeyEvent.wRepeatCount      = 1;
 123     ir[numEvent].Event.KeyEvent.dwControlKeyState = cks;
 124     if (vk & 0x0100)
 125         ir[numEvent].Event.KeyEvent.dwControlKeyState |= SHIFT_PRESSED;
 126     if ((vk & 0x0200) || (unsigned char)real_inchar <= 26)
 127         ir[numEvent].Event.KeyEvent.dwControlKeyState |= LEFT_CTRL_PRESSED;
 128     if (vk & 0x0400)
 129         ir[numEvent].Event.KeyEvent.dwControlKeyState |= LEFT_ALT_PRESSED;
 130     ir[numEvent].Event.KeyEvent.wVirtualKeyCode = vk;
 131     ir[numEvent].Event.KeyEvent.wVirtualScanCode = mapvkey_0[vk & 0x00ff]; /* VirtualKeyCodes to ScanCode */
 132
 133     ch = inchar;
 134     MultiByteToWideChar(CP_UNIXCP, 0, &ch, 1, &ir[numEvent].Event.KeyEvent.uChar.UnicodeChar, 1);
 135     ir[numEvent + 1] = ir[numEvent];
 136     ir[numEvent + 1].Event.KeyEvent.bKeyDown = 0;
 137
 138     numEvent += 2;
 139
 140     if (vk & 0x0400)
 141         init_complex_char(&ir[numEvent++], 0, 0x38, 0x12, LEFT_ALT_PRESSED);
 142     if ((vk & 0x0200) || (unsigned char)real_inchar <= 26)
 143         init_complex_char(&ir[numEvent++], 0, 0x1d, 0x11, 0);
 144     if (vk & 0x0100)
 145         init_complex_char(&ir[numEvent++], 0, 0x2a, 0x10, 0);
 146     return numEvent;
 147 }
 148
 149 #if defined(SONAME_LIBCURSES) || defined(SONAME_LIBNCURSES)
 150
 151 #ifdef HAVE_NCURSES_H
 152 # define CURSES_NAME "ncurses"
 153 #else
 154 # define CURSES_NAME "curses"
 155 #endif
 156
 157 static void *nc_handle = NULL;
 158
 159 #define MAKE_FUNCPTR(f) static typeof(f) * p_##f;
 160
 161 MAKE_FUNCPTR(putp)
 162 MAKE_FUNCPTR(setupterm)
 163 MAKE_FUNCPTR(tigetstr)
 164 MAKE_FUNCPTR(tparm)
 165
 166 #undef MAKE_FUNCPTR
 167
 168 /**********************************************************************/
 169
 170 static BOOL TERM_bind_libcurses(void)
 171 {
 172 #ifdef SONAME_LIBNCURSES
 173     static const char ncname[] = SONAME_LIBNCURSES;
 174 #else
 175     static const char ncname[] = SONAME_LIBCURSES;
 176 #endif
 177
 178     if (!(nc_handle = wine_dlopen(ncname, RTLD_NOW, NULL, 0)))
 179     {
 180         WINE_MESSAGE("Wine cannot find the " CURSES_NAME " library (%s).\n",
 181                      ncname);
 182         return FALSE;
 183     }
 184
 185 #define LOAD_FUNCPTR(f)                                      \
 186     if((p_##f = wine_dlsym(nc_handle, #f, NULL, 0)) == NULL) \
 187     {                                                        \
 188         WINE_WARN("Can't find symbol %s\n", #f);             \
 189         goto sym_not_found;                                  \
 190     }
 191
 192     LOAD_FUNCPTR(putp)
 193     LOAD_FUNCPTR(setupterm)
 194     LOAD_FUNCPTR(tigetstr)
 195     LOAD_FUNCPTR(tparm)
 196
 197 #undef LOAD_FUNCPTR
 198
 199     return TRUE;
 200
 201 sym_not_found:
 202     WINE_MESSAGE(
 203       "Wine cannot find certain functions that it needs inside the "
 204        CURSES_NAME "\nlibrary.  To enable Wine to use " CURSES_NAME
 205       " please upgrade your " CURSES_NAME "\nlibraries\n");
 206     wine_dlclose(nc_handle, NULL, 0);
 207     nc_handle = NULL;
 208     return FALSE;
 209 }
 210
 211 #define putp      p_putp
 212 #define setupterm p_setupterm
 213 #define tigetstr  p_tigetstr
 214 #define tparm     p_tparm
 215
 216 struct dbkey_descr
 217 {
 218     enum dbkey_kind {dbk_simple, dbk_complex} kind;
 219     DWORD_PTR   p1;
 220     DWORD_PTR   p2;
 221     DWORD_PTR   p3;
 222 };
 223
 224 struct dbkey_pair
 225 {
 226     const char*         string;
 227     struct dbkey_descr  descr;
 228 };
 229
 230 static struct dbkey_pair TERM_dbkey_init[] = {
 231     {"kcud1", {dbk_complex, 0x50, 0x28, 0}},
 232     {"kcuu1", {dbk_complex, 0x48, 0x26, 0}},
 233     {"kcub1", {dbk_complex, 0x4b, 0x25, 0}},
 234     {"kcuf1", {dbk_complex, 0x4d, 0x27, 0}},
 235     {"khome", {dbk_complex, 0x47, 0x24, 0}},
 236     {"kbs",   {dbk_simple,  0x7f, 0x00, 0}},
 237     {"kf1",   {dbk_complex, 0x3b, 0x70, 0}},
 238     {"kf2",   {dbk_complex, 0x3c, 0x71, 0}},
 239     {"kf3",   {dbk_complex, 0x3d, 0x72, 0}},
 240     {"kf4",   {dbk_complex, 0x3e, 0x73, 0}},
 241     {"kf5",   {dbk_complex, 0x3f, 0x74, 0}},
 242     {"kf6",   {dbk_complex, 0x40, 0x75, 0}},
 243     {"kf7",   {dbk_complex, 0x41, 0x76, 0}},
 244     {"kf8",   {dbk_complex, 0x42, 0x77, 0}},
 245     {"kf9",   {dbk_complex, 0x43, 0x78, 0}},
 246     {"kf10",  {dbk_complex, 0x44, 0x79, 0}},
 247     {"kf11",  {dbk_complex, 0xd9, 0x7a, 0}},
 248     {"kf12",  {dbk_complex, 0xda, 0x7b, 0}},
 249     {"kdch1", {dbk_complex, 0x53, 0x2e, 0}},
 250     {"kich1", {dbk_complex, 0x52, 0x2d, 0}},
 251     {"knp",   {dbk_complex, 0x51, 0x22, 0}},
 252     {"kpp",   {dbk_complex, 0x49, 0x21, 0}},
 253     {"kcbt",  {dbk_simple,  0x09, 0x00, SHIFT_PRESSED}},
 254
 255     {"kend",  {dbk_complex, 0x4f, 0x23, 0}},
 256     /* {"kmous", NULL, }, */
 257     {"kDC",   {dbk_complex, 0x53, 0x2e, SHIFT_PRESSED}},
 258     {"kEND",  {dbk_complex, 0x4f, 0x23, SHIFT_PRESSED}},
 259     {"kHOM",  {dbk_complex, 0x47, 0x24, SHIFT_PRESSED}},
 260     {"kIC",   {dbk_complex, 0x52, 0x2d, SHIFT_PRESSED}},
 261     {"kLFT",  {dbk_complex, 0x4b, 0x25, SHIFT_PRESSED}},
 262     {"kRIT",  {dbk_complex, 0x4d, 0x27, SHIFT_PRESSED}},
 263
 264     /* Still some keys to manage:
 265        KEY_DL           KEY_IL          KEY_EIC         KEY_CLEAR               KEY_EOS
 266        KEY_EOL          KEY_SF          KEY_SR          KEY_STAB                KEY_CTAB
 267        KEY_CATAB        KEY_ENTER       KEY_SRESET      KEY_RESET               KEY_PRINT
 268        KEY_LL           KEY_A1          KEY_A3          KEY_B2                  KEY_C1
 269        KEY_C3           KEY_BEG         KEY_CANCEL      KEY_CLOSE               KEY_COMMAND
 270        KEY_COPY         KEY_CREATE      KEY_EXIT        KEY_FIND                KEY_HELP
 271        KEY_MARK         KEY_MESSAGE     KEY_MOVE        KEY_NEXT                KEY_OPEN
 272        KEY_OPTIONS      KEY_PREVIOUS    KEY_REDO        KEY_REFERENCE           KEY_REFRESH
 273        KEY_REPLACE      KEY_RESTART     KEY_RESUME      KEY_SAVE                KEY_SBEG
 274        KEY_SCANCEL      KEY_SCOMMAND    KEY_SCOPY       KEY_SCREATE             KEY_RESIZE
 275        KEY_SDL          KEY_SELECT      KEY_SEOL        KEY_SEXIT               KEY_SFIND
 276        KEY_SHELP        KEY_SMESSAGE    KEY_SMOVE       KEY_SNEXT               KEY_SOPTIONS
 277        KEY_SPREVIOUS    KEY_SPRINT      KEY_SREDO       KEY_SREPLACE            KEY_SRSUME
 278        KEY_SSAVE        KEY_SSUSPEND    KEY_SUNDO       KEY_SUSPEND             KEY_UNDO
 279     */
 280 };
 281
 282 static struct dbkey_pair*       TERM_dbkey;
 283 static unsigned                 TERM_dbkey_size;
 284 static unsigned                 TERM_dbkey_index;
 285
 286 static BOOL TERM_AddKeyDescr(const char* string, struct dbkey_descr* descr)
 287 {
 288     if (!string) return FALSE;
 289     if (!TERM_dbkey)
 290     {
 291         TERM_dbkey_size = 32;
 292         TERM_dbkey = HeapAlloc(GetProcessHeap(), 0, TERM_dbkey_size * sizeof(struct dbkey_pair));
 293         if (!TERM_dbkey) return FALSE;
 294     }
 295     if (TERM_dbkey_index == TERM_dbkey_size)
 296     {
 297         struct dbkey_pair*      new;
 298
 299         new = HeapReAlloc(GetProcessHeap(), 0, TERM_dbkey, (2 * TERM_dbkey_size) * sizeof(struct dbkey_pair));
 300         if (!new) return FALSE;
 301         TERM_dbkey = new;
 302         TERM_dbkey_size *= 2;
 303     }
 304     TERM_dbkey[TERM_dbkey_index].string = string;
 305     TERM_dbkey[TERM_dbkey_index].descr  = *descr;
 306     TERM_dbkey_index++;
 307     return TRUE;
 308 }
 309
 310 static BOOL TERM_BuildKeyDB(void)
 311 {
 312     unsigned i;
 313     for (i = 0; i < sizeof(TERM_dbkey_init) / sizeof(TERM_dbkey_init[0]); i++)
 314     {
 315         if (!TERM_AddKeyDescr(tigetstr(TERM_dbkey_init[i].string), &TERM_dbkey_init[i].descr))
 316             return FALSE;
 317     }
 318     return TRUE;
 319 }
 320
 321 BOOL TERM_Init(void)
 322 {
 323     if (!TERM_bind_libcurses()) return FALSE;
 324     if (setupterm(NULL, 1 /* really ?? */, NULL) == -1) return FALSE;
 325     TERM_BuildKeyDB();
 326     /* set application key mode */
 327     putp(tigetstr("smkx"));
 328     return TRUE;
 329 }
 330
 331 BOOL TERM_Exit(void)
 332 {
 333     /* put back the cursor key mode */
 334     putp(tigetstr("rmkx"));
 335     return TRUE;
 336 }
 337
 338 /* -1 not found, 0 cannot decide, > 0 found */
 339 int TERM_FillInputRecord(const char* in, size_t len, INPUT_RECORD* ir)
 340 {
 341     unsigned            i;
 342     struct dbkey_descr* found = NULL;
 343
 344     for (i = 0; i < TERM_dbkey_index; i++)
 345     {
 346         if (!memcmp(TERM_dbkey[i].string, in, len))
 347         {
 348             if (len < strlen(TERM_dbkey[i].string)) return 0;
 349             if (found) return 0;
 350             found = &TERM_dbkey[i].descr;
 351         }
 352     }
 353     if (!found) return -1;
 354     switch (found->kind)
 355     {
 356     case dbk_simple:
 357         return TERM_FillSimpleChar(found->p1, ir);
 358     case dbk_complex:
 359         init_complex_char(&ir[0], 1, found->p1, found->p2, ENHANCED_KEY | found->p3);
 360         init_complex_char(&ir[1], 0, found->p1, found->p2, ENHANCED_KEY | found->p3);
 361         return 2;
 362     }
 363     return -1;
 364 }
 365
 366 #else
 367 BOOL     TERM_Init(void) {return FALSE;}
 368 BOOL     TERM_Exit(void) {return FALSE;}
 369 int      TERM_FillInputRecord(const char* in, size_t len, INPUT_RECORD* ir) {return -1;}
 370 #endif