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