gets.cpp File Reference

#include <corecrt_internal_stdio.h>
#include <corecrt_internal_securecrt.h>

Include dependency graph for gets.cpp:

Go to the source code of this file.

Functions
template<typename Character >
	_Success_ (return !=nullptr) static Character *__cdecl common_gets(_Out_writes_z_(result_size_in_characters) Character *const result
_In_ size_t const _In_ bool const return_early_if_eof_is_first	throw ()
char *__cdecl	gets_s (char *const result, size_t const result_size_in_characters)
wchar_t *__cdecl	_getws_s (wchar_t *const result, size_t const result_size_in_characters)
char *__cdecl	gets (char *const result)
wchar_t *__cdecl	_getws (wchar_t *const result)

Variables
_In_ size_t const	result_size_in_characters

Function Documentation

_getws()

wchar_t *__cdecl _getws

(

wchar_t *const

result

)

Definition at line 146 of file gets.cpp.

{
    return common_gets(result, _CRT_UNBOUNDED_BUFFER_SIZE, true);
}

_getws_s()

wchar_t *__cdecl _getws_s	(	wchar_t *const	result,
		size_t const	result_size_in_characters
	)

Definition at line 129 of file gets.cpp.

{
    return common_gets(result, result_size_in_characters, false);
}

_Success_()

template<typename Character >

_Success_

(

return !

= nullptr

)

const

gets()

char *__cdecl gets

(

char *const

result

)

Definition at line 141 of file gets.cpp.

{
    return common_gets(result, _CRT_UNBOUNDED_BUFFER_SIZE, true);
}

Referenced by cd(), cmdscanner(), confirm(), delete(), do_chmod(), domacro(), doproxy(), getit(), macdef(), main(), makedir(), mdelete(), mget(), mls(), modtime(), mput(), put(), quote(), removedir(), renamefile(), setnmap(), setpeer(), site(), sizecmd(), and user().

gets_s()

char *__cdecl gets_s	(	char *const	result,
		size_t const	result_size_in_characters
	)

Definition at line 124 of file gets.cpp.

{
    return common_gets(result, result_size_in_characters, false);
}

throw()

_In_ size_t const _In_ bool const return_early_if_eof_is_first throw

(

)

Definition at line 37 of file gets.cpp.

{
    typedef __acrt_stdio_char_traits<Character> stdio_traits;
 
    _VALIDATE_RETURN(result != nullptr,             EINVAL, nullptr);
    _VALIDATE_RETURN(result_size_in_characters > 0, EINVAL, nullptr);
 
    Character* return_value = result;
 
    _lock_file(stdin);
    __try
    {
        if (!stdio_traits::validate_stream_is_ansi_if_required(stdin))
        {
            return_value = nullptr;
            __leave;
        }
 
        // Special case:  if the first character is EOF, treat it specially if
        // we were asked to do so:
        typename stdio_traits::int_type c = stdio_traits::getc_nolock(stdin);
        if (c == stdio_traits::eof)
        {
            return_value = nullptr;
            if (return_early_if_eof_is_first)
                __leave;
        }
 
        // For the insecure version, we do no buffer size check and no debug fill:
        if (result_size_in_characters == _CRT_UNBOUNDED_BUFFER_SIZE)
        {
#pragma warning(push)
#pragma warning(disable:__WARNING_POTENTIAL_BUFFER_OVERFLOW_HIGH_PRIORITY) // 26015 - knowingly unsafe
            Character* result_it = result;
            while (c != '\n' && c != stdio_traits::eof)
            {
                *result_it++ = static_cast<Character>(c);
                c = stdio_traits::getc_nolock(stdin);
            }
            *result_it = '\0';
#pragma warning(pop)
        }
        // For the secure version, we track the buffer size.  If we run out of
        // buffer space, we still read in the rest of the current line until we
        // reach '\n' or EOF, but we discard the characters and reset the buffer
        // to be zero-filled.
        else
        {
            size_t available = result_size_in_characters;
 
            Character* result_it = result;
            while (c != '\n' && c != stdio_traits::eof)
            {
                if (available > 0)
                {
                    --available;
                    *result_it++ = static_cast<Character>(c);
                }
 
                c = stdio_traits::getc_nolock(stdin);
            }
 
            // If we ran out of space, clear the buffer and return failure:
            if (available == 0)
            {
                _RESET_STRING(result, result_size_in_characters);
                _RETURN_BUFFER_TOO_SMALL_ERROR(result, result_size_in_characters, nullptr);
            }
 
            *result_it = '\0';
            _FILL_STRING(result, result_size_in_characters, result_size_in_characters - available + 1);
        }
    }
    __finally
    {
        _unlock_file(stdin);
    }
    __endtry
 
    return return_value;
}

Variable Documentation

result_size_in_characters

_In_ size_t const result_size_in_characters

Definition at line 35 of file gets.cpp.

Referenced by _getws_s(), gets_s(), and throw().