cgets.cpp File Reference

#include <conio.h>
#include <corecrt_internal_securecrt.h>
#include <stdlib.h>

Include dependency graph for cgets.cpp:

Go to the source code of this file.

Functions
errno_t __cdecl	_cgets_s (char *const source_string, size_t const size_in_bytes, size_t *const size_read)
char *__cdecl	_cgets (_Inout_z_ char *const string)

Variables
intptr_t	__dcrt_lowio_console_input_handle
wchar_t	__console_wchar_buffer
int	__console_wchar_buffer_used

Function Documentation

_cgets()

char *__cdecl _cgets

(

_Inout_z_ char *const

string

)

Definition at line 110 of file cgets.cpp.

{
    _VALIDATE_CLEAR_OSSERR_RETURN(string != nullptr, EINVAL, nullptr);
    _VALIDATE_CLEAR_OSSERR_RETURN(string[0] > 0,     EINVAL, nullptr);
 
    size_t const size_in_bytes = static_cast<size_t>(string[0]);
 
    size_t size_read = 0;
    // warning 26018: Potential overflow of null terminated buffer using expression string+2
    // Suppressing warning since _cgets is purposefully unsafe.
#pragma warning(suppress:__WARNING_POTENTIAL_BUFFER_OVERFLOW_NULLTERMINATED)
    errno_t const result = _cgets_s(string + 2, size_in_bytes, &size_read);
 
    // warning 26018: Potential overflow of null terminated buffer using expression string[1]
    // Suppressing warning since _cgets is purposefully unsafe.
#pragma warning(suppress:__WARNING_POTENTIAL_BUFFER_OVERFLOW_NULLTERMINATED)
    string[1] = static_cast<char>(size_read);
 
    return result == 0 ? string + 2 : nullptr;
}

_cgets_s()

errno_t __cdecl _cgets_s	(	char *const	source_string,
		size_t const	size_in_bytes,
		size_t *const	size_read
	)

Definition at line 30 of file cgets.cpp.

{
    _VALIDATE_CLEAR_OSSERR_RETURN_ERRCODE(source_string != nullptr, EINVAL);
    _VALIDATE_CLEAR_OSSERR_RETURN_ERRCODE(size_in_bytes > 0,        EINVAL);
    _RESET_STRING(source_string, size_in_bytes);
 
    _VALIDATE_CLEAR_OSSERR_RETURN_ERRCODE(size_read != nullptr, EINVAL);
 
    errno_t error  = 0;
    char*   string = source_string;
 
    __acrt_lock(__acrt_conio_lock);
    __try
    {
        // The implementation of cgets is slightly tricky. The reason being,
        // the code page for console is different from the CRT code page.
        // What this means is the program may interpret character
        // differently from it's acctual value. To fix this, what we really
        // want to do is read the input as unicode string and then convert
        // it to proper MBCS representation.
        //
        // This fix this we are really converting from Unicode to MBCS.
        // This adds performance problem as we may endup doing this
        // character by character. The basic problem here is that we have
        // no way to know how many UNICODE characters will be needed to fit
        // them in given size of MBCS buffer. To fix this issue we will be
        // converting one Unicode character at a time to MBCS. This makes
        // this slow, but then this is already console input,
        *size_read = 0;
 
        size_t available = size_in_bytes - 1;
        do
        {
            wchar_t wchar_buff[2];
            size_t sizeRead = 0;
 
            error = _cgetws_s(wchar_buff, _countof(wchar_buff), &sizeRead);
            if (error != 0)
                break;
 
            if (wchar_buff[0] == '\0')
                break;
 
            int size_converted = 0;
            errno_t const wctomb_result = wctomb_s(&size_converted, string, available, wchar_buff[0]);
            if (wctomb_result != 0)
            {
                // Put the wide character back in the buffer so that the
                // unutilized wide character is still in the stream:
                __console_wchar_buffer = wchar_buff[0];
                __console_wchar_buffer_used = 1;
                break;
            }
 
            string     += size_converted;
            *size_read += size_converted;
            available  -= size_converted;
        }
        while (available > 0);
    }
    __finally
    {
        __acrt_unlock(__acrt_conio_lock);
    }
    __endtry
 
    *string++ = '\0';
 
    if (error != 0)
        errno = error;
 
    return error;
}

Referenced by _cgets().

Variable Documentation

__console_wchar_buffer

wchar_t __console_wchar_buffer

extern

Definition at line 18 of file cgetws.cpp.

Referenced by _cgets_s(), and _cgetws_s().

__console_wchar_buffer_used

int __console_wchar_buffer_used

extern

Definition at line 19 of file cgetws.cpp.

Referenced by _cgets_s(), and _cgetws_s().

__dcrt_lowio_console_input_handle

intptr_t __dcrt_lowio_console_input_handle

extern

Definition at line 232 of file getch.cpp.