corecrt_internal_win32_buffer.h File Reference

#include <corecrt_internal.h>

Include dependency graph for corecrt_internal_win32_buffer.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	__crt_win32_buffer_debug_info
class	__crt_win32_buffer_empty_debug_info
struct	__crt_win32_buffer_internal_dynamic_resizing
struct	__crt_win32_buffer_public_dynamic_resizing
struct	__crt_win32_buffer_no_resizing
class	__crt_win32_buffer< Character, ResizePolicy >

Typedefs
template<typename Character >
using	__crt_internal_win32_buffer = __crt_win32_buffer< Character, __crt_win32_buffer_internal_dynamic_resizing >
template<typename Character >
using	__crt_public_win32_buffer = __crt_win32_buffer< Character, __crt_win32_buffer_public_dynamic_resizing >
template<typename Character >
using	__crt_no_alloc_win32_buffer = __crt_win32_buffer< Character, __crt_win32_buffer_no_resizing >

Functions
unsigned int	__acrt_get_utf8_acp_compatibility_codepage ()
template<typename FromChar , typename ToChar , typename CvtFunction , typename ResizePolicy >
errno_t	__acrt_convert_wcs_mbs (FromChar const *const null_terminated_input_string, __crt_win32_buffer< ToChar, ResizePolicy > &win32_buffer, CvtFunction const &cvt_func, _locale_t locale)
template<typename FromChar , typename ToChar , typename CvtFunction , typename ResizePolicy >
errno_t	__acrt_convert_wcs_mbs_cp (FromChar const *const null_terminated_input_string, __crt_win32_buffer< ToChar, ResizePolicy > &win32_buffer, CvtFunction const &cvt_func, unsigned int const code_page)
template<typename ResizePolicy >
errno_t	__acrt_wcs_to_mbs (wchar_t const *const null_terminated_input_string, __crt_win32_buffer< char, ResizePolicy > &win32_buffer, _locale_t locale=nullptr)
template<typename ResizePolicy >
errno_t	__acrt_wcs_to_mbs_cp (wchar_t const *const null_terminated_input_string, __crt_win32_buffer< char, ResizePolicy > &win32_buffer, unsigned int const code_page)
template<typename ResizePolicy >
errno_t	__acrt_mbs_to_wcs (char const *const null_terminated_input_string, __crt_win32_buffer< wchar_t, ResizePolicy > &win32_buffer, _locale_t locale=nullptr)
template<typename ResizePolicy >
errno_t	__acrt_mbs_to_wcs_cp (char const *const null_terminated_input_string, __crt_win32_buffer< wchar_t, ResizePolicy > &win32_buffer, unsigned int const code_page)
template<size_t N>
size_t	__acrt_wcs_to_mbs_array (wchar_t const *const null_terminated_input_string, char(&buffer)[N], _locale_t locale=nullptr)
template<size_t N>
size_t	__acrt_wcs_to_mbs_cp_array (wchar_t const *const null_terminated_input_string, char(&buffer)[N], unsigned int const code_page)
template<size_t N>
size_t	__acrt_mbs_to_wcs_array (char const *const null_terminated_input_string, wchar_t(&buffer)[N], _locale_t locale=nullptr)
template<size_t N>
size_t	__acrt_mbs_to_wcs_cp_array (char const *const null_terminated_input_string, wchar_t(&buffer)[N], unsigned int const code_page)
template<typename ResizePolicy >
errno_t	__acrt_get_current_directory_wide (__crt_win32_buffer< wchar_t, ResizePolicy > &win32_buffer)
template<typename ResizePolicy >
errno_t	__acrt_get_current_directory_narrow_acp_or_utf8 (__crt_win32_buffer< char, ResizePolicy > &win32_buffer)
template<typename ResizePolicy >
errno_t	__acrt_get_full_path_name_wide (wchar_t const *const lpFileName, __crt_win32_buffer< wchar_t, ResizePolicy > &win32_buffer)
template<typename ResizePolicy >
errno_t	__acrt_get_full_path_name_narrow_acp_or_utf8 (char const *const lpFileName, __crt_win32_buffer< char, ResizePolicy > &win32_buffer)

Typedef Documentation

__crt_internal_win32_buffer

template<typename Character >

using __crt_internal_win32_buffer = __crt_win32_buffer<Character, __crt_win32_buffer_internal_dynamic_resizing>

Definition at line 399 of file corecrt_internal_win32_buffer.h.

__crt_no_alloc_win32_buffer

template<typename Character >

using __crt_no_alloc_win32_buffer = __crt_win32_buffer<Character, __crt_win32_buffer_no_resizing>

Definition at line 405 of file corecrt_internal_win32_buffer.h.

__crt_public_win32_buffer

template<typename Character >

using __crt_public_win32_buffer = __crt_win32_buffer<Character, __crt_win32_buffer_public_dynamic_resizing>

Definition at line 402 of file corecrt_internal_win32_buffer.h.

Function Documentation

__acrt_convert_wcs_mbs()

template<typename FromChar , typename ToChar , typename CvtFunction , typename ResizePolicy >

errno_t __acrt_convert_wcs_mbs	(	FromChar const *const	null_terminated_input_string,
		__crt_win32_buffer< ToChar, ResizePolicy > &	win32_buffer,
		CvtFunction const &	cvt_func,
		_locale_t	locale
	)

Definition at line 448 of file corecrt_internal_win32_buffer.h.

{
    // Common code path for conversions using mbstowcs and wcstombs.
    if (null_terminated_input_string == nullptr) {
        win32_buffer.set_to_nullptr();
        return 0;
    }
 
    // No empty string special case - mbstowcs/wcstombs handles them.
    size_t const required_size = cvt_func(nullptr, null_terminated_input_string, 0, locale);
 
    if (required_size == static_cast<size_t>(-1)) {
        return errno;
    }
 
    size_t const required_size_plus_null_terminator = required_size + 1;
 
    if (required_size_plus_null_terminator > win32_buffer.capacity()) {
        errno_t const alloc_err = win32_buffer.allocate(required_size_plus_null_terminator);
        if (alloc_err != 0) {
            return alloc_err;
        }
    }
 
    size_t const chars_converted = cvt_func(win32_buffer.data(), null_terminated_input_string, win32_buffer.capacity(), locale);
    if (chars_converted == static_cast<size_t>(-1) || chars_converted == win32_buffer.capacity()) {
        // check for error or if output is not null terminated
        return errno;
    }
 
    win32_buffer.size(chars_converted);
    return 0;
}

Referenced by __acrt_mbs_to_wcs(), and __acrt_wcs_to_mbs().

__acrt_convert_wcs_mbs_cp()

template<typename FromChar , typename ToChar , typename CvtFunction , typename ResizePolicy >

errno_t __acrt_convert_wcs_mbs_cp	(	FromChar const *const	null_terminated_input_string,
		__crt_win32_buffer< ToChar, ResizePolicy > &	win32_buffer,
		CvtFunction const &	cvt_func,
		unsigned int const	code_page
	)

Definition at line 488 of file corecrt_internal_win32_buffer.h.

{
    // Common code path for conversions using MultiByteToWideChar and WideCharToMultiByte with null terminated inputs.
    if (null_terminated_input_string == nullptr) {
        win32_buffer.set_to_nullptr();
        return 0;
    }
 
    // Special Case: Empty strings are not valid input to MultiByteToWideChar/WideCharToMultiByte
    if (null_terminated_input_string[0] == '\0') {
        if (win32_buffer.capacity() == 0) {
            errno_t alloc_err = win32_buffer.allocate(1);
            if (alloc_err != 0) {
                return alloc_err;
            }
        }
 
        win32_buffer.data()[0] = '\0';
        win32_buffer.size(0);
        return 0;
    }
 
    size_t const required_size_plus_null_terminator = cvt_func(
        code_page,
        null_terminated_input_string,
        nullptr,
        0
        );
 
    if (required_size_plus_null_terminator == 0) {
        __acrt_errno_map_os_error(::GetLastError());
        return errno;
    }
 
    if (required_size_plus_null_terminator > win32_buffer.capacity()) {
        errno_t alloc_err = win32_buffer.allocate(required_size_plus_null_terminator);
        if (alloc_err != 0) {
            return alloc_err;
        }
    }
 
    size_t const chars_converted_plus_null_terminator = cvt_func(
        code_page,
        null_terminated_input_string,
        win32_buffer.data(),
        win32_buffer.capacity()
        );
 
    if (chars_converted_plus_null_terminator == 0) {
        __acrt_errno_map_os_error(::GetLastError());
        return errno;
    }
 
    win32_buffer.size(chars_converted_plus_null_terminator - 1); // size does not include the null terminator
    return 0;
}

Referenced by __acrt_mbs_to_wcs_cp(), and __acrt_wcs_to_mbs_cp().

__acrt_get_current_directory_narrow_acp_or_utf8()

template<typename ResizePolicy >

errno_t __acrt_get_current_directory_narrow_acp_or_utf8

(

__crt_win32_buffer< char, ResizePolicy > &

win32_buffer

)

Definition at line 723 of file corecrt_internal_win32_buffer.h.

{
    wchar_t default_buffer_space[_MAX_PATH];
    __crt_internal_win32_buffer<wchar_t> wide_buffer(default_buffer_space);
 
    errno_t const err = __acrt_get_current_directory_wide(wide_buffer);
 
    if (err != 0) {
        return err;
    }
 
    return __acrt_wcs_to_mbs_cp(
        wide_buffer.data(),
        win32_buffer,
        __acrt_get_utf8_acp_compatibility_codepage()
        );
}

__acrt_get_current_directory_wide()

template<typename ResizePolicy >

errno_t __acrt_get_current_directory_wide

(

__crt_win32_buffer< wchar_t, ResizePolicy > &

win32_buffer

)

Definition at line 712 of file corecrt_internal_win32_buffer.h.

{
    return win32_buffer.call_win32_function([](wchar_t * buffer, DWORD buffer_length)
    {
        return ::GetCurrentDirectoryW(buffer_length, buffer);
    });
}

Referenced by __acrt_get_current_directory_narrow_acp_or_utf8().

__acrt_get_full_path_name_narrow_acp_or_utf8()

template<typename ResizePolicy >

errno_t __acrt_get_full_path_name_narrow_acp_or_utf8	(	char const *const	lpFileName,
		__crt_win32_buffer< char, ResizePolicy > &	win32_buffer
	)

Definition at line 761 of file corecrt_internal_win32_buffer.h.

{
    wchar_t default_buffer_space[_MAX_PATH];
    __crt_internal_win32_buffer<wchar_t> wide_buffer(default_buffer_space);
 
    wchar_t default_file_name_space[_MAX_PATH];
    __crt_internal_win32_buffer<wchar_t> wide_file_name(default_file_name_space);
 
    unsigned int const code_page = __acrt_get_utf8_acp_compatibility_codepage();
 
    errno_t const cvt_err = __acrt_mbs_to_wcs_cp(
        lpFileName,
        wide_file_name,
        code_page
        );
 
    if (cvt_err != 0)
    {
        return cvt_err;
    }
 
    errno_t const err = __acrt_get_full_path_name_wide(wide_file_name.data(), wide_buffer);
 
    if (err != 0)
    {
        return err;
    }
 
    return __acrt_wcs_to_mbs_cp(
        wide_buffer.data(),
        win32_buffer,
        code_page
        );
}

__acrt_get_full_path_name_wide()

template<typename ResizePolicy >

errno_t __acrt_get_full_path_name_wide	(	wchar_t const *const	lpFileName,
		__crt_win32_buffer< wchar_t, ResizePolicy > &	win32_buffer
	)

Definition at line 744 of file corecrt_internal_win32_buffer.h.

{
    return win32_buffer.call_win32_function([lpFileName](wchar_t * buffer, DWORD buffer_length)
    {
        return ::GetFullPathNameW(
            lpFileName,
            buffer_length,
            buffer,
            nullptr
        );
    });
}

Referenced by __acrt_get_full_path_name_narrow_acp_or_utf8().

__acrt_get_utf8_acp_compatibility_codepage()

unsigned int __acrt_get_utf8_acp_compatibility_codepage ( )

inline

Definition at line 422 of file corecrt_internal_win32_buffer.h.

{
    _LocaleUpdate locale_update(nullptr);
    unsigned int const current_code_page = locale_update.GetLocaleT()->locinfo->_public._locale_lc_codepage;
 
    if (current_code_page == CP_UTF8) {
        return CP_UTF8;
    }
 
    bool const use_oem_code_page = !__acrt_AreFileApisANSI();
 
    if (use_oem_code_page) {
        return CP_OEMCP;
    }
 
    return CP_ACP;
}

Referenced by __acrt_CreateProcessA(), __acrt_get_current_directory_narrow_acp_or_utf8(), __acrt_get_full_path_name_narrow_acp_or_utf8(), __acrt_GetModuleFileNameA(), __acrt_LoadLibraryExA(), __acrt_SetCurrentDirectoryA(), __acrt_SetEnvironmentVariableA(), _access_s(), _chmod(), _findfirst32(), _findfirst32i64(), _findfirst64(), _findfirst64i32(), _findnext32(), _findnext32i64(), _findnext64(), _findnext64i32(), _mkdir(), _rmdir(), _sopen_nolock(), common_stat(), get_file_name(), get_wide(), remove(), rename(), and tzset_env_copy_to_tzname().

__acrt_mbs_to_wcs()

template<typename ResizePolicy >

errno_t __acrt_mbs_to_wcs	(	char const *const	null_terminated_input_string,
		__crt_win32_buffer< wchar_t, ResizePolicy > &	win32_buffer,
		_locale_t	locale = nullptr
	)

Definition at line 602 of file corecrt_internal_win32_buffer.h.

{
    _BEGIN_SECURE_CRT_DEPRECATION_DISABLE
        return __acrt_convert_wcs_mbs(
            null_terminated_input_string,
            win32_buffer,
            _mbstowcs_l,
            locale
            );
    _END_SECURE_CRT_DEPRECATION_DISABLE
}

Referenced by __acrt_mbs_to_wcs_array().

__acrt_mbs_to_wcs_array()

template<size_t N>

size_t __acrt_mbs_to_wcs_array	(	char const *const	null_terminated_input_string,
		wchar_t(&)	buffer[N],
		_locale_t	locale = nullptr
	)

Definition at line 682 of file corecrt_internal_win32_buffer.h.

{
    __crt_no_alloc_win32_buffer<wchar_t> win32_buffer(buffer);
    if (__acrt_mbs_to_wcs(null_terminated_input_string, win32_buffer, locale) != 0) {
        return 0;
    }
 
    return win32_buffer.size();
}

__acrt_mbs_to_wcs_cp()

template<typename ResizePolicy >

errno_t __acrt_mbs_to_wcs_cp	(	char const *const	null_terminated_input_string,
		__crt_win32_buffer< wchar_t, ResizePolicy > &	win32_buffer,
		unsigned int const	code_page
	)

Definition at line 619 of file corecrt_internal_win32_buffer.h.

{
    auto const mbs_to_wcs = [](
        unsigned int const code_page,
        char const * const null_terminated_input_string,
        wchar_t * const    buffer,
        size_t const       buffer_size)
    {
        // Return value includes null terminator.
        return __acrt_MultiByteToWideChar(
            code_page,
            MB_PRECOMPOSED | MB_ERR_INVALID_CHARS,
            null_terminated_input_string,
            -1,
            buffer,
            static_cast<int>(buffer_size)
            );
    };
 
    return __acrt_convert_wcs_mbs_cp(
        null_terminated_input_string,
        win32_buffer,
        mbs_to_wcs,
        code_page
        );
}

Referenced by __acrt_CreateProcessA(), __acrt_get_full_path_name_narrow_acp_or_utf8(), __acrt_LoadLibraryExA(), __acrt_mbs_to_wcs_cp_array(), __acrt_SetCurrentDirectoryA(), __acrt_SetEnvironmentVariableA(), _access_s(), _chmod(), _mkdir(), _rmdir(), _sopen_nolock(), common_stat(), get_wide(), remove(), and rename().

__acrt_mbs_to_wcs_cp_array()

template<size_t N>

size_t __acrt_mbs_to_wcs_cp_array	(	char const *const	null_terminated_input_string,
		wchar_t(&)	buffer[N],
		unsigned int const	code_page
	)

Definition at line 697 of file corecrt_internal_win32_buffer.h.

{
    __crt_no_alloc_win32_buffer<wchar_t> win32_buffer(buffer);
    if (__acrt_mbs_to_wcs_cp(null_terminated_input_string, win32_buffer, code_page) != 0) {
        return 0;
    }
 
    return win32_buffer.size();
}

__acrt_wcs_to_mbs()

template<typename ResizePolicy >

errno_t __acrt_wcs_to_mbs	(	wchar_t const *const	null_terminated_input_string,
		__crt_win32_buffer< char, ResizePolicy > &	win32_buffer,
		_locale_t	locale = nullptr
	)

Definition at line 551 of file corecrt_internal_win32_buffer.h.

{
    _BEGIN_SECURE_CRT_DEPRECATION_DISABLE
        return __acrt_convert_wcs_mbs(
            null_terminated_input_string,
            win32_buffer,
            _wcstombs_l,
            locale
            );
    _END_SECURE_CRT_DEPRECATION_DISABLE
}

Referenced by __acrt_wcs_to_mbs_array().

__acrt_wcs_to_mbs_array()

template<size_t N>

size_t __acrt_wcs_to_mbs_array	(	wchar_t const *const	null_terminated_input_string,
		char(&)	buffer[N],
		_locale_t	locale = nullptr
	)

Definition at line 652 of file corecrt_internal_win32_buffer.h.

{
    __crt_no_alloc_win32_buffer<char> win32_buffer(buffer);
    if (__acrt_wcs_to_mbs(null_terminated_input_string, win32_buffer, locale) != 0) {
        return 0;
    }
 
    return win32_buffer.size();
}

__acrt_wcs_to_mbs_cp()

template<typename ResizePolicy >

errno_t __acrt_wcs_to_mbs_cp	(	wchar_t const *const	null_terminated_input_string,
		__crt_win32_buffer< char, ResizePolicy > &	win32_buffer,
		unsigned int const	code_page
	)

Definition at line 568 of file corecrt_internal_win32_buffer.h.

{
    auto const wcs_to_mbs = [](
        unsigned int const    code_page,
        wchar_t const * const null_terminated_input_string,
        char * const          buffer,
        size_t const          buffer_size)
    {
        // Return value includes null terminator.
        return __acrt_WideCharToMultiByte(
            code_page,
            0,
            null_terminated_input_string,
            -1,
            buffer,
            static_cast<int>(buffer_size),
            nullptr,
            nullptr
            );
    };
 
    return __acrt_convert_wcs_mbs_cp(
        null_terminated_input_string,
        win32_buffer,
        wcs_to_mbs,
        code_page
        );
}

Referenced by __acrt_get_current_directory_narrow_acp_or_utf8(), __acrt_get_full_path_name_narrow_acp_or_utf8(), __acrt_GetModuleFileNameA(), __acrt_wcs_to_mbs_cp_array(), and get_file_name().

__acrt_wcs_to_mbs_cp_array()

template<size_t N>

size_t __acrt_wcs_to_mbs_cp_array	(	wchar_t const *const	null_terminated_input_string,
		char(&)	buffer[N],
		unsigned int const	code_page
	)

Definition at line 667 of file corecrt_internal_win32_buffer.h.

{
    __crt_no_alloc_win32_buffer<char> win32_buffer(buffer);
    if (__acrt_wcs_to_mbs_cp(null_terminated_input_string, win32_buffer, code_page) != 0) {
        return 0;
    }
 
    return win32_buffer.size();
}

Referenced by _getch_nolock().