console.c

Go to the documentation of this file.

/*
 * msvcrt.dll console functions
 *
 * Copyright 2000 Jon Griffiths
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
 *
 * Note: init and free don't need MT locking since they are called at DLL
 * (de)attachment time, which is synchronised for us
 */
 
#include "msvcrt.h"
#include "winnls.h"
#include "wincon.h"
#include "mtdll.h"
#include "wine/debug.h"
 
WINE_DEFAULT_DEBUG_CHANNEL(msvcrt);
 
/* MT */
#define LOCK_CONSOLE   _lock(_CONIO_LOCK)
#define UNLOCK_CONSOLE _unlock(_CONIO_LOCK)
 
static HANDLE MSVCRT_console_in;
static HANDLE MSVCRT_console_out;
static int __MSVCRT_console_buffer = EOF;
static wchar_t __MSVCRT_console_buffer_w = WEOF;
 
/* INTERNAL: Initialise console handles, _CONIO_LOCK must be held */
static HANDLE msvcrt_input_console(void)
{
  if (!MSVCRT_console_in)
  {
    MSVCRT_console_in = CreateFileA("CONIN$", GENERIC_WRITE|GENERIC_READ,
                                    FILE_SHARE_WRITE|FILE_SHARE_READ,
                                    NULL, OPEN_EXISTING, 0, NULL);
    if (MSVCRT_console_in == INVALID_HANDLE_VALUE)
      WARN("Input console handle initialization failed!\n");
  }
  return MSVCRT_console_in;
}
 
static HANDLE msvcrt_output_console(void)
{
  if (!MSVCRT_console_out)
  {
    MSVCRT_console_out = CreateFileA("CONOUT$", GENERIC_WRITE, FILE_SHARE_WRITE,
                                     NULL, OPEN_EXISTING, 0, NULL);
    if (MSVCRT_console_out == INVALID_HANDLE_VALUE)
      WARN("Output console handle initialization failed!\n");
  }
  return MSVCRT_console_out;
}
 
/* INTERNAL: Free console handles */
void msvcrt_free_console(void)
{
  TRACE(":Closing console handles\n");
  CloseHandle(MSVCRT_console_in);
  CloseHandle(MSVCRT_console_out);
}
 
/*********************************************************************
 *      _cputs (MSVCRT.@)
 */
int CDECL _cputs(const char* str)
{
  DWORD count;
  int len, retval = -1;
 
  if (!MSVCRT_CHECK_PMT(str != NULL)) return -1;
  len = strlen(str);
 
  LOCK_CONSOLE;
  if (WriteConsoleA(msvcrt_output_console(), str, len, &count, NULL)
      && count == len)
    retval = 0;
  UNLOCK_CONSOLE;
  return retval;
}
 
/*********************************************************************
 *      _cputws (MSVCRT.@)
 */
int CDECL _cputws(const wchar_t* str)
{
  DWORD count;
  int len, retval = -1;
 
  if (!MSVCRT_CHECK_PMT(str != NULL)) return -1;
  len = wcslen(str);
 
  LOCK_CONSOLE;
  if (WriteConsoleW(msvcrt_output_console(), str, len, &count, NULL)
      && count == len)
    retval = 0;
  UNLOCK_CONSOLE;
  return retval;
}
 
#define NORMAL_CHAR     0
#define ALT_CHAR        1
#define CTRL_CHAR       2
#define SHIFT_CHAR      3
 
static const struct {unsigned short vk; unsigned char ch[4][2];} enh_map[] = {
    {0x47, {{0xE0, 0x47}, {0x00, 0x97}, {0xE0, 0x77}, {0xE0, 0x47}}},
    {0x48, {{0xE0, 0x48}, {0x00, 0x98}, {0xE0, 0x8D}, {0xE0, 0x48}}},
    {0x49, {{0xE0, 0x49}, {0x00, 0x99}, {0xE0, 0x86}, {0xE0, 0x49}}},
    {0x4B, {{0xE0, 0x4B}, {0x00, 0x9B}, {0xE0, 0x73}, {0xE0, 0x4B}}},
    {0x4D, {{0xE0, 0x4D}, {0x00, 0x9D}, {0xE0, 0x74}, {0xE0, 0x4D}}},
    {0x4F, {{0xE0, 0x4F}, {0x00, 0x9F}, {0xE0, 0x75}, {0xE0, 0x4F}}},
    {0x50, {{0xE0, 0x50}, {0x00, 0xA0}, {0xE0, 0x91}, {0xE0, 0x50}}},
    {0x51, {{0xE0, 0x51}, {0x00, 0xA1}, {0xE0, 0x76}, {0xE0, 0x51}}},
    {0x52, {{0xE0, 0x52}, {0x00, 0xA2}, {0xE0, 0x92}, {0xE0, 0x52}}},
    {0x53, {{0xE0, 0x53}, {0x00, 0xA3}, {0xE0, 0x93}, {0xE0, 0x53}}},
};
 
static BOOL handle_enhanced_keys(INPUT_RECORD *ir, unsigned char *ch1, unsigned char *ch2)
{
    int i;
 
    for (i = 0; i < ARRAY_SIZE(enh_map); i++)
    {
        if (ir->Event.KeyEvent.wVirtualScanCode == enh_map[i].vk)
        {
            unsigned idx;
 
            if (ir->Event.KeyEvent.dwControlKeyState & (LEFT_ALT_PRESSED | RIGHT_ALT_PRESSED))
                idx = ALT_CHAR;
            else if (ir->Event.KeyEvent.dwControlKeyState & (LEFT_CTRL_PRESSED | RIGHT_CTRL_PRESSED) )
                idx = CTRL_CHAR;
            else if (ir->Event.KeyEvent.dwControlKeyState & SHIFT_PRESSED)
                idx = SHIFT_CHAR;
            else
                idx = NORMAL_CHAR;
 
            *ch1 = enh_map[i].ch[idx][0];
            *ch2 = enh_map[i].ch[idx][1];
            return TRUE;
        }
    }
 
    WARN("Unmapped char keyState=%lx vk=%x\n",
            ir->Event.KeyEvent.dwControlKeyState, ir->Event.KeyEvent.wVirtualScanCode);
    return FALSE;
}
 
/*********************************************************************
 *      _getch_nolock (MSVCR80.@)
 */
int CDECL _getch_nolock(void)
{
  int retval = EOF;
 
  if (__MSVCRT_console_buffer != EOF)
  {
    retval = __MSVCRT_console_buffer;
    __MSVCRT_console_buffer = EOF;
  }
  else
  {
    INPUT_RECORD ir;
    DWORD count;
    DWORD mode = 0;
 
    GetConsoleMode(msvcrt_input_console(), &mode);
    if(mode)
      SetConsoleMode(msvcrt_input_console(), 0);
 
    do {
      if (ReadConsoleInputA(msvcrt_input_console(), &ir, 1, &count))
      {
        /* Only interested in ASCII chars */
        if (ir.EventType == KEY_EVENT &&
            ir.Event.KeyEvent.bKeyDown)
        {
            unsigned char ch1, ch2;
 
            if (ir.Event.KeyEvent.uChar.AsciiChar)
            {
                retval = ir.Event.KeyEvent.uChar.AsciiChar;
                break;
            }
 
            if (handle_enhanced_keys(&ir, &ch1, &ch2))
            {
                retval = ch1;
                __MSVCRT_console_buffer = ch2;
                break;
            }
        }
      }
      else
        break;
    } while(1);
    if (mode)
      SetConsoleMode(msvcrt_input_console(), mode);
  }
  return retval;
}
 
/*********************************************************************
 *      _getch (MSVCRT.@)
 */
int CDECL _getch(void)
{
    int ret;
 
    LOCK_CONSOLE;
    ret = _getch_nolock();
    UNLOCK_CONSOLE;
    return ret;
}
 
/*********************************************************************
 *      _getwch_nolock (MSVCR80.@)
 */
wchar_t CDECL _getwch_nolock(void)
{
    wchar_t retval = WEOF;
 
    if (__MSVCRT_console_buffer_w != WEOF)
    {
        retval = __MSVCRT_console_buffer_w;
        __MSVCRT_console_buffer_w = WEOF;
    }
    else
    {
        INPUT_RECORD ir;
        DWORD count;
        DWORD mode = 0;
 
        GetConsoleMode(msvcrt_input_console(), &mode);
        if(mode)
            SetConsoleMode(msvcrt_input_console(), 0);
 
        do {
            if (ReadConsoleInputW(msvcrt_input_console(), &ir, 1, &count))
            {
                /* Only interested in ASCII chars */
                if (ir.EventType == KEY_EVENT &&
                        ir.Event.KeyEvent.bKeyDown)
                {
                    unsigned char ch1, ch2;
 
                    if (ir.Event.KeyEvent.uChar.UnicodeChar)
                    {
                        retval = ir.Event.KeyEvent.uChar.UnicodeChar;
                        break;
                    }
 
                    if (handle_enhanced_keys(&ir, &ch1, &ch2))
                    {
                        retval = ch1;
                        __MSVCRT_console_buffer_w = ch2;
                        break;
                    }
                }
            }
            else
                break;
        } while(1);
        if (mode)
            SetConsoleMode(msvcrt_input_console(), mode);
    }
    return retval;
}
 
/*********************************************************************
 *              _getwch (MSVCRT.@)
 */
wchar_t CDECL _getwch(void)
{
    wchar_t ret;
 
    LOCK_CONSOLE;
    ret = _getwch_nolock();
    UNLOCK_CONSOLE;
    return ret;
}
 
/*********************************************************************
 *      _putch_nolock (MSVCR80.@)
 */
int CDECL _putch_nolock(int c)
{
  DWORD count;
  if (WriteConsoleA(msvcrt_output_console(), &c, 1, &count, NULL) && count == 1)
    return c;
  return EOF;
}
 
/*********************************************************************
 *      _putch (MSVCRT.@)
 */
int CDECL _putch(int c)
{
    LOCK_CONSOLE;
    c = _putch_nolock(c);
    UNLOCK_CONSOLE;
    return c;
}
 
/*********************************************************************
 *      _putwch_nolock (MSVCR80.@)
 */
wchar_t CDECL _putwch_nolock(wchar_t c)
{
    DWORD count;
    if (WriteConsoleW(msvcrt_output_console(), &c, 1, &count, NULL) && count==1)
        return c;
    return WEOF;
}
 
/*********************************************************************
 *      _putwch (MSVCRT.@)
 */
wchar_t CDECL _putwch(wchar_t c)
{
    LOCK_CONSOLE;
    c = _putwch_nolock(c);
    UNLOCK_CONSOLE;
    return c;
}
 
/*********************************************************************
 *      _getche_nolock (MSVCR80.@)
 */
int CDECL _getche_nolock(void)
{
  int retval;
  retval = _getch_nolock();
  if (retval != EOF)
    retval = _putch_nolock(retval);
  return retval;
}
 
/*********************************************************************
 *      _getche (MSVCRT.@)
 */
int CDECL _getche(void)
{
    int ret;
 
    LOCK_CONSOLE;
    ret = _getche_nolock();
    UNLOCK_CONSOLE;
    return ret;
}
 
/*********************************************************************
 *              _getwche_nolock (MSVCR80.@)
 */
wchar_t CDECL _getwche_nolock(void)
{
    wchar_t wch;
    wch = _getch_nolock();
    if (wch == WEOF)
        return wch;
    return _putwch_nolock(wch);
}
 
/*********************************************************************
 *              _getwche (MSVCRT.@)
 */
wchar_t CDECL _getwche(void)
{
    wchar_t ret;
 
    LOCK_CONSOLE;
    ret = _getwche_nolock();
    UNLOCK_CONSOLE;
    return ret;
}
 
/*********************************************************************
 *      _cgets (MSVCRT.@)
 */
char* CDECL _cgets(char* str)
{
  char *buf = str + 2;
  DWORD got;
  DWORD conmode = 0;
 
  TRACE("(%p)\n", str);
  str[1] = 0; /* Length */
  LOCK_CONSOLE;
  GetConsoleMode(msvcrt_input_console(), &conmode);
  SetConsoleMode(msvcrt_input_console(), ENABLE_LINE_INPUT|ENABLE_ECHO_INPUT|ENABLE_PROCESSED_INPUT);
 
  if(ReadConsoleA(msvcrt_input_console(), buf, str[0], &got, NULL)) {
    if(buf[got-2] == '\r') {
      buf[got-2] = 0;
      str[1] = got-2;
    }
    else if(got == 1 && buf[got-1] == '\n') {
      buf[0] = 0;
      str[1] = 0;
    }
    else if(got == str[0] && buf[got-1] == '\r') {
      buf[got-1] = 0;
      str[1] = got-1;
    }
    else
      str[1] = got;
  }
  else
    buf = NULL;
  SetConsoleMode(msvcrt_input_console(), conmode);
  UNLOCK_CONSOLE;
  return buf;
}
 
/*********************************************************************
 *      _ungetch_nolock (MSVCRT.@)
 */
int CDECL _ungetch_nolock(int c)
{
  int retval = EOF;
  if (c != EOF && __MSVCRT_console_buffer == EOF)
    retval = __MSVCRT_console_buffer = c;
  return retval;
}
 
/*********************************************************************
 *      _ungetch (MSVCRT.@)
 */
int CDECL _ungetch(int c)
{
    LOCK_CONSOLE;
    c = _ungetch_nolock(c);
    UNLOCK_CONSOLE;
    return c;
}
 
/*********************************************************************
 *              _ungetwch_nolock (MSVCR80.@)
 */
wchar_t CDECL _ungetwch_nolock(wchar_t c)
{
    wchar_t retval = WEOF;
    if (c != WEOF && __MSVCRT_console_buffer_w == WEOF)
        retval = __MSVCRT_console_buffer_w = c;
    return retval;
}
 
/*********************************************************************
 *              _ungetwch (MSVCRT.@)
 */
wchar_t CDECL _ungetwch(wchar_t c)
{
    LOCK_CONSOLE;
    c = _ungetwch_nolock(c);
    UNLOCK_CONSOLE;
    return c;
}
 
/*********************************************************************
 *      _kbhit (MSVCRT.@)
 */
int CDECL _kbhit(void)
{
  int retval = 0;
 
  LOCK_CONSOLE;
  if (__MSVCRT_console_buffer != EOF)
    retval = 1;
  else
  {
    /* FIXME: There has to be a faster way than this in Win32.. */
    INPUT_RECORD *ir = NULL;
    DWORD count = 0, i;
 
    GetNumberOfConsoleInputEvents(msvcrt_input_console(), &count);
 
    if (count && (ir = malloc(count * sizeof(INPUT_RECORD))) &&
        PeekConsoleInputA(msvcrt_input_console(), ir, count, &count))
      for(i = 0; i < count; i++)
      {
        if (ir[i].EventType == KEY_EVENT &&
            ir[i].Event.KeyEvent.bKeyDown &&
            ir[i].Event.KeyEvent.uChar.AsciiChar)
        {
          retval = 1;
          break;
        }
      }
    free(ir);
  }
  UNLOCK_CONSOLE;
  return retval;
}
 
static int puts_clbk_console_a(void *ctx, int len, const char *str)
{
    LOCK_CONSOLE;
    if(!WriteConsoleA(msvcrt_output_console(), str, len, NULL, NULL))
        len = -1;
    UNLOCK_CONSOLE;
    return len;
}
 
static int puts_clbk_console_w(void *ctx, int len, const wchar_t *str)
{
    LOCK_CONSOLE;
    if(!WriteConsoleW(msvcrt_output_console(), str, len, NULL, NULL))
        len = -1;
    UNLOCK_CONSOLE;
    return len;
}
 
#if _MSVCR_VER<=120
/*********************************************************************
 *      _vcprintf_l (MSVCRT.@)
 */
int CDECL _vcprintf_l(const char* format, _locale_t locale, va_list valist)
{
    return pf_printf_a(puts_clbk_console_a, NULL, format, locale, 0, arg_clbk_valist, NULL, &valist);
}
#endif
 
/*********************************************************************
 *      _vcprintf (MSVCRT.@)
 */
int CDECL _vcprintf(const char* format, va_list valist)
{
    return pf_printf_a(puts_clbk_console_a, NULL, format, NULL, 0, arg_clbk_valist, NULL, &valist);
}
 
#if _MSVCR_VER<=120
/*********************************************************************
 *      _cprintf_l (MSVCRT.@)
 */
int WINAPIV _cprintf_l(const char* format, _locale_t locale, ...)
{
    int retval;
    va_list valist;
 
    va_start(valist, locale);
    retval = _vcprintf_l(format, locale, valist);
    va_end(valist);
 
    return retval;
}
#endif
 
/*********************************************************************
 *      _cprintf (MSVCRT.@)
 */
int WINAPIV _cprintf(const char* format, ...)
{
  int retval;
  va_list valist;
 
  va_start( valist, format );
  retval = _vcprintf(format, valist);
  va_end(valist);
 
  return retval;
}
 
#if _MSVCR_VER<=120
/*********************************************************************
 *      _vcwprintf_l (MSVCRT.@)
 */
int CDECL _vcwprintf_l(const wchar_t* format, _locale_t locale, va_list valist)
{
    return pf_printf_w(puts_clbk_console_w, NULL, format, locale, 0, arg_clbk_valist, NULL, &valist);
}
 
/*********************************************************************
 *      _vcwprintf (MSVCRT.@)
 */
int CDECL _vcwprintf(const wchar_t* format, va_list valist)
{
    return pf_printf_w(puts_clbk_console_w, NULL, format, NULL, 0, arg_clbk_valist, NULL, &valist);
}
 
/*********************************************************************
 *      _cwprintf_l (MSVCRT.@)
 */
int WINAPIV _cwprintf_l(const wchar_t* format, _locale_t locale, ...)
{
    int retval;
    va_list valist;
 
    va_start(valist, locale);
    retval = _vcwprintf_l(format, locale, valist);
    va_end(valist);
 
    return retval;
}
 
/*********************************************************************
 *      _cwprintf (MSVCRT.@)
 */
int WINAPIV _cwprintf(const wchar_t* format, ...)
{
  int retval;
  va_list valist;
 
  va_start( valist, format );
  retval = _vcwprintf(format, valist);
  va_end(valist);
 
  return retval;
}
#endif
 
#if _MSVCR_VER>=140
 
/*********************************************************************
 *      __conio_common_vcprintf (UCRTBASE.@)
 */
int CDECL __conio_common_vcprintf(unsigned __int64 options, const char* format,
                                        _locale_t locale, va_list valist)
{
    if (options & ~UCRTBASE_PRINTF_MASK)
        FIXME("options %#I64x not handled\n", options);
    return pf_printf_a(puts_clbk_console_a, NULL, format, locale,
             options & UCRTBASE_PRINTF_MASK, arg_clbk_valist, NULL, &valist);
}
 
/*********************************************************************
 *      __conio_common_vcwprintf (UCRTBASE.@)
 */
int CDECL __conio_common_vcwprintf(unsigned __int64 options, const wchar_t* format,
                                         _locale_t locale, va_list valist)
{
    if (options & ~UCRTBASE_PRINTF_MASK)
        FIXME("options %#I64x not handled\n", options);
    return pf_printf_w(puts_clbk_console_w, NULL, format, locale,
             options & UCRTBASE_PRINTF_MASK, arg_clbk_valist, NULL, &valist);
}
 
#endif /* _MSVCR_VER>=140 */