__crt_win32_buffer< Character, ResizePolicy > Class Template Reference

#include <corecrt_internal_win32_buffer.h>

Inheritance diagram for __crt_win32_buffer< Character, ResizePolicy >:

Collaboration diagram for __crt_win32_buffer< Character, ResizePolicy >:

Public Types
using	char_type = Character
using	debug_info_type = typename ResizePolicy::debug_info_type

Public Member Functions
	__crt_win32_buffer ()
	__crt_win32_buffer (debug_info_type const &debug_info)
template<size_t N>
	__crt_win32_buffer (Character(&buffer)[N])
template<size_t N>
	__crt_win32_buffer (Character(&buffer)[N], debug_info_type const &debug_info)
	__crt_win32_buffer (Character *const buffer, size_t const buffer_capacity)
	__crt_win32_buffer (Character *const buffer, size_t const buffer_capacity, debug_info_type const &debug_info)
	~__crt_win32_buffer ()
	__crt_win32_buffer (__crt_win32_buffer const &)=delete
__crt_win32_buffer &	operator= (__crt_win32_buffer const &)=delete
	__crt_win32_buffer (__crt_win32_buffer &&)=delete
__crt_win32_buffer &	operator= (__crt_win32_buffer &&)=delete
char_type *	data ()
char_type const *	data () const
size_t	size () const
void	size (size_t new_size)
size_t	capacity () const
void	reset ()
char_type *	detach ()
template<typename Win32Function >
errno_t	call_win32_function (Win32Function const &win32_function)
debug_info_type const &	debug_info () const
errno_t	allocate (size_t requested_size)
void	set_to_nullptr ()

Private Member Functions
void	_reset_no_dealloc ()
void	_deallocate ()

Private Attributes
char_type *const	_initial_string
size_t	_initial_capacity
char_type *	_string
size_t	_capacity
size_t	_size
bool	_is_dynamic

Detailed Description

template<typename Character, typename ResizePolicy>
class __crt_win32_buffer< Character, ResizePolicy >

Definition at line 151 of file corecrt_internal_win32_buffer.h.

Member Typedef Documentation

char_type

template<typename Character , typename ResizePolicy >

using __crt_win32_buffer< Character, ResizePolicy >::char_type = Character

Definition at line 155 of file corecrt_internal_win32_buffer.h.

debug_info_type

template<typename Character , typename ResizePolicy >

using __crt_win32_buffer< Character, ResizePolicy >::debug_info_type = typename ResizePolicy::debug_info_type

Definition at line 156 of file corecrt_internal_win32_buffer.h.

Constructor & Destructor Documentation

__crt_win32_buffer() [1/8]

template<typename Character , typename ResizePolicy >

__crt_win32_buffer< Character, ResizePolicy >::__crt_win32_buffer ( )

inline

Definition at line 158 of file corecrt_internal_win32_buffer.h.

        : debug_info_type(),
          _initial_string(nullptr),
          _initial_capacity(0),
          _string(nullptr),
          _capacity(0),
          _size(0),
          _is_dynamic(false)
 
    {
    }

__crt_win32_buffer() [2/8]

template<typename Character , typename ResizePolicy >

__crt_win32_buffer< Character, ResizePolicy >::__crt_win32_buffer ( debug_info_type const &  debug_info )

inlineexplicit

Definition at line 170 of file corecrt_internal_win32_buffer.h.

        : debug_info_type(debug_info),
          _initial_string(nullptr),
          _initial_capacity(0),
          _string(nullptr),
          _capacity(0),
          _size(0),
          _is_dynamic(false)
 
    {
    }

__crt_win32_buffer() [3/8]

template<typename Character , typename ResizePolicy >

template<size_t N>

__crt_win32_buffer< Character, ResizePolicy >::__crt_win32_buffer ( Character(&)  buffer[N] )

inline

Definition at line 183 of file corecrt_internal_win32_buffer.h.

        : debug_info_type(),
          _initial_string(buffer),
          _initial_capacity(N),
          _string(buffer),
          _capacity(N),
          _size(0),
          _is_dynamic(false)
    {
    }

__crt_win32_buffer() [4/8]

template<typename Character , typename ResizePolicy >

template<size_t N>

__crt_win32_buffer< Character, ResizePolicy >::__crt_win32_buffer ( Character(&)  buffer[N], debug_info_type const &  debug_info  )

inline

Definition at line 195 of file corecrt_internal_win32_buffer.h.

        : debug_info_type(debug_info),
          _initial_string(buffer),
          _initial_capacity(N),
          _string(buffer),
          _capacity(N),
          _size(0),
          _is_dynamic(false)
    {
    }

__crt_win32_buffer() [5/8]

template<typename Character , typename ResizePolicy >

__crt_win32_buffer< Character, ResizePolicy >::__crt_win32_buffer ( Character *const  buffer, size_t const  buffer_capacity  )

inline

Definition at line 206 of file corecrt_internal_win32_buffer.h.

        : debug_info_type(),
          _initial_string(buffer),
          _initial_capacity(buffer_capacity),
          _string(buffer),
          _capacity(buffer_capacity),
          _size(0),
          _is_dynamic(false)
    {
    }

__crt_win32_buffer() [6/8]

template<typename Character , typename ResizePolicy >

__crt_win32_buffer< Character, ResizePolicy >::__crt_win32_buffer ( Character *const  buffer, size_t const  buffer_capacity, debug_info_type const &  debug_info  )

inline

Definition at line 220 of file corecrt_internal_win32_buffer.h.

        : debug_info_type(debug_info),
          _initial_string(buffer),
          _initial_capacity(buffer_capacity),
          _string(buffer),
          _capacity(buffer_capacity),
          _size(0),
          _is_dynamic(false)
    {
    }

~__crt_win32_buffer()

template<typename Character , typename ResizePolicy >

__crt_win32_buffer< Character, ResizePolicy >::~__crt_win32_buffer ( )

inline

Definition at line 235 of file corecrt_internal_win32_buffer.h.

    {
        _deallocate();
    }

__crt_win32_buffer() [7/8]

template<typename Character , typename ResizePolicy >

__crt_win32_buffer< Character, ResizePolicy >::__crt_win32_buffer ( __crt_win32_buffer< Character, ResizePolicy > const &  )

delete

__crt_win32_buffer() [8/8]

template<typename Character , typename ResizePolicy >

__crt_win32_buffer< Character, ResizePolicy >::__crt_win32_buffer ( __crt_win32_buffer< Character, ResizePolicy > &&  )

delete

Member Function Documentation

_deallocate()

template<typename Character , typename ResizePolicy >

void __crt_win32_buffer< Character, ResizePolicy >::_deallocate ( )

inlineprivate

Definition at line 382 of file corecrt_internal_win32_buffer.h.

    {
        if (_is_dynamic) {
            ResizePolicy::deallocate(_string, debug_info());
            _is_dynamic = false;
        }
    }

Referenced by __crt_win32_buffer< Character, ResizePolicy >::allocate(), __crt_win32_buffer< Character, ResizePolicy >::reset(), __crt_win32_buffer< Character, ResizePolicy >::set_to_nullptr(), and __crt_win32_buffer< Character, ResizePolicy >::~__crt_win32_buffer().

_reset_no_dealloc()

template<typename Character , typename ResizePolicy >

void __crt_win32_buffer< Character, ResizePolicy >::_reset_no_dealloc ( )

inlineprivate

Definition at line 375 of file corecrt_internal_win32_buffer.h.

    {
        _string = _initial_string;
        _capacity = _initial_capacity;
        _size = 0;
    }

Referenced by __crt_win32_buffer< Character, ResizePolicy >::detach(), and __crt_win32_buffer< Character, ResizePolicy >::reset().

allocate()

template<typename Character , typename ResizePolicy >

errno_t __crt_win32_buffer< Character, ResizePolicy >::allocate ( size_t  requested_size )

inline

Definition at line 344 of file corecrt_internal_win32_buffer.h.

    {
        _deallocate();
 
        errno_t err = ResizePolicy::allocate(
            reinterpret_cast<void **>(&_string),
            requested_size * sizeof(Character),
            debug_info()
            );
 
        if (err) {
            _is_dynamic = false;
            _capacity = 0;
            return err;
        }
 
        _is_dynamic = true;
        _capacity = requested_size;
        return 0;
    }

Referenced by __acrt_convert_wcs_mbs(), __acrt_convert_wcs_mbs_cp(), and __crt_win32_buffer< Character, ResizePolicy >::call_win32_function().

call_win32_function()

template<typename Character , typename ResizePolicy >

template<typename Win32Function >

errno_t __crt_win32_buffer< Character, ResizePolicy >::call_win32_function ( Win32Function const &  win32_function )

inline

Definition at line 303 of file corecrt_internal_win32_buffer.h.

    {   // Suitable for more Win32 calls, where a size is returned
        // if there is not enough space.
 
        size_t const required_size = win32_function(_string, static_cast<DWORD>(_capacity));
        if (required_size == 0) {
            __acrt_errno_map_os_error(GetLastError());
            return errno;
        }
 
        if (required_size <= _capacity) {
            // Had enough space, data was written, save size and return
            _size = required_size;
            return 0;
        }
 
        size_t const required_size_plus_null_terminator = required_size + 1;
 
        errno_t const alloc_err = allocate(required_size_plus_null_terminator);
        if (alloc_err)
        {
            return alloc_err;
        }
 
        // Upon success, return value is number of characters written, minus the null terminator.
        size_t const required_size2 = win32_function(_string, static_cast<DWORD>(_capacity));
        if (required_size2 == 0) {
            __acrt_errno_map_os_error(GetLastError());
            return errno;
        }
 
        // Capacity should be large enough at this point.
        _size = required_size2;
        return 0;
    }

Referenced by __acrt_get_current_directory_wide(), and __acrt_get_full_path_name_wide().

capacity()

template<typename Character , typename ResizePolicy >

size_t __crt_win32_buffer< Character, ResizePolicy >::capacity ( ) const

inline

Definition at line 266 of file corecrt_internal_win32_buffer.h.

    {
        return _capacity;
    }

Referenced by __acrt_convert_wcs_mbs(), and __acrt_convert_wcs_mbs_cp().

data() [1/2]

template<typename Character , typename ResizePolicy >

char_type * __crt_win32_buffer< Character, ResizePolicy >::data ( )

inline

Definition at line 246 of file corecrt_internal_win32_buffer.h.

    {
        return _string;
    }

Referenced by __acrt_convert_wcs_mbs(), __acrt_convert_wcs_mbs_cp(), __acrt_CreateProcessA(), __acrt_get_current_directory_narrow_acp_or_utf8(), __acrt_get_full_path_name_narrow_acp_or_utf8(), __acrt_LoadLibraryExA(), __acrt_SetCurrentDirectoryA(), __acrt_SetEnvironmentVariableA(), _access_s(), _chmod(), _mkdir(), _rmdir(), _sopen_nolock(), _Success_(), common_stat(), remove(), and rename().

data() [2/2]

template<typename Character , typename ResizePolicy >

char_type const * __crt_win32_buffer< Character, ResizePolicy >::data ( ) const

inline

Definition at line 251 of file corecrt_internal_win32_buffer.h.

    {
        return _string;
    }

debug_info()

template<typename Character , typename ResizePolicy >

debug_info_type const & __crt_win32_buffer< Character, ResizePolicy >::debug_info ( ) const

inline

Definition at line 339 of file corecrt_internal_win32_buffer.h.

    {
        return static_cast<debug_info_type const&>(*this);
    }

Referenced by __crt_win32_buffer< Character, ResizePolicy >::_deallocate(), __crt_win32_buffer< Character, ResizePolicy >::allocate(), and __crt_win32_buffer< Character, ResizePolicy >::detach().

detach()

template<typename Character , typename ResizePolicy >

char_type * __crt_win32_buffer< Character, ResizePolicy >::detach ( )

inline

Definition at line 277 of file corecrt_internal_win32_buffer.h.

    {
        if (_string == nullptr || _size == 0) {
            return nullptr;
        }
 
        char_type * return_val{};
 
        if (!_is_dynamic && _size > 0) {
            // This pointer needs to live longer than the stack buffer
            // Allocate + Copy
            ResizePolicy::allocate(
                reinterpret_cast<void **>(&return_val),
                _size * sizeof(Character),
                debug_info()
                );
            memcpy_s(return_val, _size, _string, _capacity);
        } else {
            return_val = _string;
        }
 
        _reset_no_dealloc();
        return return_val;
    }

operator=() [1/2]

template<typename Character , typename ResizePolicy >

__crt_win32_buffer & __crt_win32_buffer< Character, ResizePolicy >::operator= ( __crt_win32_buffer< Character, ResizePolicy > &&  )

delete

operator=() [2/2]

template<typename Character , typename ResizePolicy >

__crt_win32_buffer & __crt_win32_buffer< Character, ResizePolicy >::operator= ( __crt_win32_buffer< Character, ResizePolicy > const &  )

delete

reset()

template<typename Character , typename ResizePolicy >

void __crt_win32_buffer< Character, ResizePolicy >::reset ( )

inline

Definition at line 271 of file corecrt_internal_win32_buffer.h.

    {
        _deallocate();
        _reset_no_dealloc();
    }

set_to_nullptr()

template<typename Character , typename ResizePolicy >

void __crt_win32_buffer< Character, ResizePolicy >::set_to_nullptr ( )

inline

Definition at line 365 of file corecrt_internal_win32_buffer.h.

    {
        _deallocate();
 
        _string = nullptr;
        _capacity = 0;
        _size = 0;
    }

Referenced by __acrt_convert_wcs_mbs(), and __acrt_convert_wcs_mbs_cp().

size() [1/2]

template<typename Character , typename ResizePolicy >

size_t __crt_win32_buffer< Character, ResizePolicy >::size ( ) const

inline

Definition at line 256 of file corecrt_internal_win32_buffer.h.

    {
        return _size;
    }

Referenced by __acrt_convert_wcs_mbs(), __acrt_convert_wcs_mbs_cp(), __acrt_GetModuleFileNameA(), __acrt_mbs_to_wcs_array(), __acrt_mbs_to_wcs_cp_array(), __acrt_wcs_to_mbs_array(), and __acrt_wcs_to_mbs_cp_array().

size() [2/2]

template<typename Character , typename ResizePolicy >

void __crt_win32_buffer< Character, ResizePolicy >::size ( size_t  new_size )

inline

Definition at line 261 of file corecrt_internal_win32_buffer.h.

    {
        _size = new_size;
    }

Member Data Documentation

_capacity

template<typename Character , typename ResizePolicy >

size_t __crt_win32_buffer< Character, ResizePolicy >::_capacity

private

Definition at line 393 of file corecrt_internal_win32_buffer.h.

Referenced by __crt_win32_buffer< Character, ResizePolicy >::_reset_no_dealloc(), __crt_win32_buffer< Character, ResizePolicy >::allocate(), __crt_win32_buffer< Character, ResizePolicy >::call_win32_function(), __crt_win32_buffer< Character, ResizePolicy >::capacity(), __crt_win32_buffer< Character, ResizePolicy >::detach(), and __crt_win32_buffer< Character, ResizePolicy >::set_to_nullptr().

_initial_capacity

template<typename Character , typename ResizePolicy >

size_t __crt_win32_buffer< Character, ResizePolicy >::_initial_capacity

private

Definition at line 391 of file corecrt_internal_win32_buffer.h.

Referenced by __crt_win32_buffer< Character, ResizePolicy >::_reset_no_dealloc().

_initial_string

template<typename Character , typename ResizePolicy >

char_type* const __crt_win32_buffer< Character, ResizePolicy >::_initial_string

private

Definition at line 390 of file corecrt_internal_win32_buffer.h.

Referenced by __crt_win32_buffer< Character, ResizePolicy >::_reset_no_dealloc().

_is_dynamic

template<typename Character , typename ResizePolicy >

bool __crt_win32_buffer< Character, ResizePolicy >::_is_dynamic

private

Definition at line 395 of file corecrt_internal_win32_buffer.h.

Referenced by __crt_win32_buffer< Character, ResizePolicy >::_deallocate(), __crt_win32_buffer< Character, ResizePolicy >::allocate(), and __crt_win32_buffer< Character, ResizePolicy >::detach().

_size

template<typename Character , typename ResizePolicy >

size_t __crt_win32_buffer< Character, ResizePolicy >::_size

private

Definition at line 394 of file corecrt_internal_win32_buffer.h.

Referenced by __crt_win32_buffer< Character, ResizePolicy >::_reset_no_dealloc(), __crt_win32_buffer< Character, ResizePolicy >::call_win32_function(), __crt_win32_buffer< Character, ResizePolicy >::detach(), __crt_win32_buffer< Character, ResizePolicy >::set_to_nullptr(), and __crt_win32_buffer< Character, ResizePolicy >::size().

_string

template<typename Character , typename ResizePolicy >

char_type* __crt_win32_buffer< Character, ResizePolicy >::_string

private

Definition at line 392 of file corecrt_internal_win32_buffer.h.

Referenced by __crt_win32_buffer< Character, ResizePolicy >::_deallocate(), __crt_win32_buffer< Character, ResizePolicy >::_reset_no_dealloc(), __crt_win32_buffer< Character, ResizePolicy >::allocate(), __crt_win32_buffer< Character, ResizePolicy >::call_win32_function(), __crt_win32_buffer< Character, ResizePolicy >::data(), __crt_win32_buffer< Character, ResizePolicy >::detach(), and __crt_win32_buffer< Character, ResizePolicy >::set_to_nullptr().

---

The documentation for this class was generated from the following file:

• sdk/lib/ucrt/inc/corecrt_internal_win32_buffer.h