output.cpp File Reference

#include <corecrt_internal_stdio_output.h>

Include dependency graph for output.cpp:

Go to the source code of this file.

Functions
template<template< typename, typename > class Base, typename Character >
static int __cdecl	common_vfprintf (unsigned __int64 const options, FILE *const stream, Character const *const format, __crt_cached_ptd_host &ptd, va_list const arglist) throw ()
int __cdecl	__stdio_common_vfprintf (unsigned __int64 const options, FILE *const stream, char const *const format, _locale_t const locale, va_list const arglist)
int __cdecl	__stdio_common_vfwprintf (unsigned __int64 const options, FILE *const stream, wchar_t const *const format, _locale_t const locale, va_list const arglist)
int __cdecl	__stdio_common_vfprintf_s (unsigned __int64 const options, FILE *const stream, char const *const format, _locale_t const locale, va_list const arglist)
int __cdecl	__stdio_common_vfwprintf_s (unsigned __int64 const options, FILE *const stream, wchar_t const *const format, _locale_t const locale, va_list const arglist)
int __cdecl	__stdio_common_vfprintf_p (unsigned __int64 const options, FILE *const stream, char const *const format, _locale_t const locale, va_list const arglist)
int __cdecl	__stdio_common_vfwprintf_p (unsigned __int64 const options, FILE *const stream, wchar_t const *const format, _locale_t const locale, va_list const arglist)
template<template< typename, typename > class Base, typename Character >
	_Success_ (return >=0) static int __cdecl common_vsprintf(unsigned __int64 const options
	_Out_writes_z_ (buffer_count) Character *const buffer
size_t const Character const *const __crt_cached_ptd_host va_list const arglist	throw ()
int __cdecl	__stdio_common_vsprintf (unsigned __int64 const options, char *const buffer, size_t const buffer_count, char const *const format, _locale_t const locale, va_list const arglist)
int __cdecl	__stdio_common_vswprintf (unsigned __int64 const options, wchar_t *const buffer, size_t const buffer_count, wchar_t const *const format, _locale_t const locale, va_list const arglist)
template<typename Character >
	_Success_ (return >=0) static int __cdecl common_vsprintf_s(unsigned __int64 const options
int __cdecl	__stdio_common_vsprintf_s (unsigned __int64 const options, char *const buffer, size_t const buffer_count, char const *const format, _locale_t const locale, va_list const arglist)
int __cdecl	__stdio_common_vswprintf_s (unsigned __int64 const options, wchar_t *const buffer, size_t const buffer_count, wchar_t const *const format, _locale_t const locale, va_list const arglist)
int __cdecl	__stdio_common_vsnprintf_s (unsigned __int64 const options, char *const buffer, size_t const buffer_count, size_t const max_count, char const *const format, _locale_t const locale, va_list const arglist)
int __cdecl	__stdio_common_vsnwprintf_s (unsigned __int64 const options, wchar_t *const buffer, size_t const buffer_count, size_t const max_count, wchar_t const *const format, _locale_t const locale, va_list const arglist)
int __cdecl	__stdio_common_vsprintf_p (unsigned __int64 const options, char *const buffer, size_t const buffer_count, char const *const format, _locale_t const locale, va_list const arglist)
int __cdecl	__stdio_common_vswprintf_p (unsigned __int64 const options, wchar_t *const buffer, size_t const buffer_count, wchar_t const *const format, _locale_t const locale, va_list const arglist)

Variables
size_t const	buffer_count
size_t const Character const *const	format
size_t const Character const *const __crt_cached_ptd_host &	ptd
size_t const size_t const	max_count

Function Documentation

__stdio_common_vfprintf()

int __cdecl __stdio_common_vfprintf	(	unsigned __int64 const	options,
		FILE *const	stream,
		char const *const	format,
		_locale_t const	locale,
		va_list const	arglist
	)

Definition at line 52 of file output.cpp.

{
    __crt_cached_ptd_host ptd(locale);
    return common_vfprintf<standard_base>(options, stream, format, ptd, arglist);
}

Referenced by vfprintf_wrapper().

__stdio_common_vfprintf_p()

int __cdecl __stdio_common_vfprintf_p	(	unsigned __int64 const	options,
		FILE *const	stream,
		char const *const	format,
		_locale_t const	locale,
		va_list const	arglist
	)

Definition at line 100 of file output.cpp.

{
    __crt_cached_ptd_host ptd(locale);
    return common_vfprintf<positional_parameter_base>(options, stream, format, ptd, arglist);
}

__stdio_common_vfprintf_s()

int __cdecl __stdio_common_vfprintf_s	(	unsigned __int64 const	options,
		FILE *const	stream,
		char const *const	format,
		_locale_t const	locale,
		va_list const	arglist
	)

Definition at line 76 of file output.cpp.

{
    __crt_cached_ptd_host ptd(locale);
    return common_vfprintf<format_validation_base>(options, stream, format, ptd, arglist);
}

__stdio_common_vfwprintf()

int __cdecl __stdio_common_vfwprintf	(	unsigned __int64 const	options,
		FILE *const	stream,
		wchar_t const *const	format,
		_locale_t const	locale,
		va_list const	arglist
	)

Definition at line 64 of file output.cpp.

{
    __crt_cached_ptd_host ptd(locale);
    return common_vfprintf<standard_base>(options, stream, format, ptd, arglist);
}

Referenced by vfwprintf_wrapper().

__stdio_common_vfwprintf_p()

int __cdecl __stdio_common_vfwprintf_p	(	unsigned __int64 const	options,
		FILE *const	stream,
		wchar_t const *const	format,
		_locale_t const	locale,
		va_list const	arglist
	)

Definition at line 112 of file output.cpp.

{
    __crt_cached_ptd_host ptd(locale);
    return common_vfprintf<positional_parameter_base>(options, stream, format, ptd, arglist);
}

__stdio_common_vfwprintf_s()

int __cdecl __stdio_common_vfwprintf_s	(	unsigned __int64 const	options,
		FILE *const	stream,
		wchar_t const *const	format,
		_locale_t const	locale,
		va_list const	arglist
	)

Definition at line 88 of file output.cpp.

{
    __crt_cached_ptd_host ptd(locale);
    return common_vfprintf<format_validation_base>(options, stream, format, ptd, arglist);
}

__stdio_common_vsnprintf_s()

int __cdecl __stdio_common_vsnprintf_s	(	unsigned __int64 const	options,
		char *const	buffer,
		size_t const	buffer_count,
		size_t const	max_count,
		char const *const	format,
		_locale_t const	locale,
		va_list const	arglist
	)

Definition at line 393 of file output.cpp.

{
    __crt_cached_ptd_host ptd(locale);
    return common_vsnprintf_s(options, buffer, buffer_count, max_count, format, ptd, arglist);
}

Referenced by _vsnprintf_s_wrapper().

__stdio_common_vsnwprintf_s()

int __cdecl __stdio_common_vsnwprintf_s	(	unsigned __int64 const	options,
		wchar_t *const	buffer,
		size_t const	buffer_count,
		size_t const	max_count,
		wchar_t const *const	format,
		_locale_t const	locale,
		va_list const	arglist
	)

Definition at line 407 of file output.cpp.

{
    __crt_cached_ptd_host ptd(locale);
    return common_vsnprintf_s(options, buffer, buffer_count, max_count, format, ptd, arglist);
}

Referenced by _VCrtDbgReportW(), and _vsnwprintf_s_wrapper().

__stdio_common_vsprintf()

int __cdecl __stdio_common_vsprintf	(	unsigned __int64 const	options,
		char *const	buffer,
		size_t const	buffer_count,
		char const *const	format,
		_locale_t const	locale,
		va_list const	arglist
	)

Definition at line 233 of file output.cpp.

{
    __crt_cached_ptd_host ptd(locale);
    return common_vsprintf<standard_base>(options, buffer, buffer_count, format, ptd, arglist);
}

Referenced by vsprintf_wrapper().

__stdio_common_vsprintf_p()

int __cdecl __stdio_common_vsprintf_p	(	unsigned __int64 const	options,
		char *const	buffer,
		size_t const	buffer_count,
		char const *const	format,
		_locale_t const	locale,
		va_list const	arglist
	)

Definition at line 421 of file output.cpp.

{
    __crt_cached_ptd_host ptd(locale);
    return common_vsprintf<positional_parameter_base>(options, buffer, buffer_count, format, ptd, arglist);
}

__stdio_common_vsprintf_s()

int __cdecl __stdio_common_vsprintf_s	(	unsigned __int64 const	options,
		char *const	buffer,
		size_t const	buffer_count,
		char const *const	format,
		_locale_t const	locale,
		va_list const	arglist
	)

Definition at line 292 of file output.cpp.

{
    __crt_cached_ptd_host ptd(locale);
    return common_vsprintf_s(options, buffer, buffer_count, format, ptd, arglist);
}

__stdio_common_vswprintf()

int __cdecl __stdio_common_vswprintf	(	unsigned __int64 const	options,
		wchar_t *const	buffer,
		size_t const	buffer_count,
		wchar_t const *const	format,
		_locale_t const	locale,
		va_list const	arglist
	)

Definition at line 246 of file output.cpp.

{
    __crt_cached_ptd_host ptd(locale);
    return common_vsprintf<standard_base>(options, buffer, buffer_count, format, ptd, arglist);
}

Referenced by vswprintf_wrapper().

__stdio_common_vswprintf_p()

int __cdecl __stdio_common_vswprintf_p	(	unsigned __int64 const	options,
		wchar_t *const	buffer,
		size_t const	buffer_count,
		wchar_t const *const	format,
		_locale_t const	locale,
		va_list const	arglist
	)

Definition at line 434 of file output.cpp.

{
    __crt_cached_ptd_host ptd(locale);
    return common_vsprintf<positional_parameter_base>(options, buffer, buffer_count, format, ptd, arglist);
}

__stdio_common_vswprintf_s()

int __cdecl __stdio_common_vswprintf_s	(	unsigned __int64 const	options,
		wchar_t *const	buffer,
		size_t const	buffer_count,
		wchar_t const *const	format,
		_locale_t const	locale,
		va_list const	arglist
	)

Definition at line 305 of file output.cpp.

{
    __crt_cached_ptd_host ptd(locale);
    return common_vsprintf_s(options, buffer, buffer_count, format, ptd, arglist);
}

_Out_writes_z_()

_Out_writes_z_

(

buffer_count

)

const

_Success_() [1/2]

template<template< typename, typename > class Base, typename Character >

_Success_

(

return >=

0

)

const

_Success_() [2/2]

template<typename Character >

_Success_

(

return >=

0

)

const

common_vfprintf()

template<template< typename, typename > class Base, typename Character >

static int __cdecl common_vfprintf ( unsigned __int64 const  options, FILE *const  stream, Character const *const  format, __crt_cached_ptd_host &  ptd, va_list const  arglist  ) throw ( )

static

Definition at line 20 of file output.cpp.

{
    typedef output_processor<
        Character,
        stream_output_adapter<Character>,
        Base<Character, stream_output_adapter<Character>>
    > processor_type;
 
    _UCRT_VALIDATE_RETURN(ptd, stream != nullptr, EINVAL, -1);
    _UCRT_VALIDATE_RETURN(ptd, format != nullptr, EINVAL, -1);
 
    return __acrt_lock_stream_and_call(stream, [&]() -> int
    {
        __acrt_stdio_temporary_buffering_guard const buffering(stream, ptd);
 
        processor_type processor(
            stream_output_adapter<Character>(stream),
            options,
            format,
            ptd,
            arglist);
 
        return processor.process();
    });
}

throw()

size_t const Character const *const __crt_cached_ptd_host va_list const arglist throw

(

)

Definition at line 136 of file output.cpp.

{
    typedef __acrt_stdio_char_traits<Character> char_traits;
 
    typedef output_processor<
        Character,
        string_output_adapter<Character>,
        Base<Character, string_output_adapter<Character>>
    > processor_type;
 
    _UCRT_VALIDATE_RETURN(ptd, format != nullptr,                      EINVAL, -1);
    _UCRT_VALIDATE_RETURN(ptd, buffer_count == 0 || buffer != nullptr, EINVAL, -1);
 
    string_output_adapter_context<Character> context{};
    context._buffer         = buffer;
    context._buffer_count   = buffer_count;
    context._buffer_used    = 0;
 
    // For the C Standard snprintf functions, we continue formatting even after
    // the buffer is full so that we can return the number of characters that
    // are required to complete the format operation.  For all other sprintf
    // functions that have a buffer count, if no buffer was provided then we
    // do the same.
    context._continue_count =
        (options & _CRT_INTERNAL_PRINTF_STANDARD_SNPRINTF_BEHAVIOR) != 0 ||
        buffer == nullptr;
 
    processor_type processor(
        string_output_adapter<Character>(&context),
        options,
        format,
        ptd,
        arglist);
 
    int const result = processor.process();
 
    if (buffer == nullptr)
    {
        return result;
    }
 
    // Otherwise, we formatted data into the buffer and need to terminate it:
    if (options & _CRT_INTERNAL_PRINTF_LEGACY_VSPRINTF_NULL_TERMINATION)
    {
        if (buffer_count == 0 && result != 0)
        {
            return -1;
        }
        else if (context._buffer_used != buffer_count)
        {
            buffer[context._buffer_used] = '\0';
        }
        else if (result >= 0 && static_cast<size_t>(result) > buffer_count)
        {
            return -1;
        }
    }
    else if (options & _CRT_INTERNAL_PRINTF_STANDARD_SNPRINTF_BEHAVIOR)
    {
        if (buffer_count == 0)
        {
            // No-op
        }
        else if (result < 0)
        {
            buffer[0] = '\0';
        }
        else if (context._buffer_used == buffer_count)
        {
            buffer[buffer_count - 1] = '\0';
        }
        else
        {
            buffer[context._buffer_used] = '\0';
        }
    }
    else
    {
        if (buffer_count == 0)
        {
            return -1;
        }
        else if (context._buffer_used == buffer_count)
        {
            buffer[buffer_count - 1] = '\0';
            return -2;
        }
        else
        {
            buffer[context._buffer_used] = '\0';
        }
    }
 
#pragma warning(suppress:__WARNING_POSTCONDITION_NULLTERMINATION_VIOLATION) // 26036 needs work
    return result;
}

Variable Documentation

buffer_count

size_t const buffer_count

Definition at line 132 of file output.cpp.

Referenced by __stdio_common_vsnprintf_s(), __stdio_common_vsnwprintf_s(), __stdio_common_vsprintf(), __stdio_common_vsprintf_p(), __stdio_common_vsprintf_s(), __stdio_common_vswprintf(), __stdio_common_vswprintf_p(), __stdio_common_vswprintf_s(), _Success_(), and throw().

format

size_t const size_t const Character const* const format

Definition at line 133 of file output.cpp.

max_count

size_t const size_t const max_count

Definition at line 324 of file output.cpp.

Referenced by __stdio_common_vsnprintf_s(), and __stdio_common_vsnwprintf_s().

ptd

size_t const size_t const Character const* const __crt_cached_ptd_host& ptd

Definition at line 134 of file output.cpp.

Referenced by __stdio_common_vfprintf(), __stdio_common_vfprintf_p(), __stdio_common_vfprintf_s(), __stdio_common_vfwprintf(), __stdio_common_vfwprintf_p(), __stdio_common_vfwprintf_s(), __stdio_common_vsnprintf_s(), __stdio_common_vsnwprintf_s(), __stdio_common_vsprintf(), __stdio_common_vsprintf_p(), __stdio_common_vsprintf_s(), __stdio_common_vswprintf(), __stdio_common_vswprintf_p(), __stdio_common_vswprintf_s(), _Success_(), common_vfprintf(), and throw().