__crt_stdio_stream Class Reference

#include <corecrt_internal_stdio.h>

Collaboration diagram for __crt_stdio_stream:

Public Member Functions
	__crt_stdio_stream () throw ()
	__crt_stdio_stream (FILE *const stream) throw ()
	__crt_stdio_stream (__crt_stdio_stream_data *const stream) throw ()
bool	valid () const throw ()
FILE *	public_stream () const throw ()
bool	is_in_use () const throw ()
bool	try_allocate () throw ()
void	deallocate () throw ()
void	lock () const throw ()
void	unlock () const throw ()
bool	has_any_of (long const flags) const throw ()
bool	has_all_of (long const flags) const throw ()
bool	set_flags (long const flags) const throw ()
bool	unset_flags (long const flags) const throw ()
bool	eof () const throw ()
bool	error () const throw ()
bool	ctrl_z () const throw ()
bool	has_crt_buffer () const throw ()
bool	has_user_buffer () const throw ()
bool	has_temporary_buffer () const throw ()
bool	has_setvbuf_buffer () const throw ()
bool	has_big_buffer () const throw ()
bool	has_any_buffer () const throw ()
int	lowio_handle () const throw ()
bool	is_string_backed () const throw ()
__crt_stdio_stream_data *	operator-> () const throw ()
long	get_flags () const throw ()

Private Attributes
__crt_stdio_stream_data *	_stream

Detailed Description

Definition at line 196 of file corecrt_internal_stdio.h.

Constructor & Destructor Documentation

__crt_stdio_stream() [1/3]

__crt_stdio_stream::__crt_stdio_stream ( ) throw ( )

inline

Definition at line 200 of file corecrt_internal_stdio.h.

        : _stream(nullptr)
    {
    }

__crt_stdio_stream() [2/3]

__crt_stdio_stream::__crt_stdio_stream ( FILE *const  stream ) throw ( )

inlineexplicit

Definition at line 205 of file corecrt_internal_stdio.h.

        : _stream(reinterpret_cast<__crt_stdio_stream_data*>(stream))
    {
    }

__crt_stdio_stream() [3/3]

__crt_stdio_stream::__crt_stdio_stream ( __crt_stdio_stream_data *const  stream ) throw ( )

inlineexplicit

Definition at line 210 of file corecrt_internal_stdio.h.

        : _stream(stream)
    {
    }

Member Function Documentation

ctrl_z()

bool __crt_stdio_stream::ctrl_z ( ) const throw ( )

inline

Definition at line 259 of file corecrt_internal_stdio.h.

{ return has_any_of(_IOCTRLZ); }

deallocate()

void __crt_stdio_stream::deallocate ( ) throw ( )

inline

Definition at line 239 of file corecrt_internal_stdio.h.

    {
        // Note:  We clear all flags intentionally, so that the stream object
        // is "clean" the next time it is allocated.
        _InterlockedExchange(&_stream->_flags, 0);
    }

eof()

bool __crt_stdio_stream::eof ( ) const throw ( )

inline

Definition at line 257 of file corecrt_internal_stdio.h.

{ return has_any_of(_IOEOF);   }

Referenced by feof().

error()

bool __crt_stdio_stream::error ( ) const throw ( )

inline

Definition at line 258 of file corecrt_internal_stdio.h.

{ return has_any_of(_IOERROR); }

Referenced by ferror().

get_flags()

long __crt_stdio_stream::get_flags ( ) const throw ( )

inline

Definition at line 276 of file corecrt_internal_stdio.h.

    {
        return __crt_interlocked_read(&_stream->_flags);
    }

Referenced by has_all_of(), has_any_of(), is_in_use(), and is_string_backed().

has_all_of()

bool __crt_stdio_stream::has_all_of ( long const  flags ) const throw ( )

inline

Definition at line 252 of file corecrt_internal_stdio.h.

{ return (get_flags() & flags) == flags; }

has_any_buffer()

bool __crt_stdio_stream::has_any_buffer ( ) const throw ( )

inline

Definition at line 266 of file corecrt_internal_stdio.h.

{ return has_any_of(_IOBUFFER_CRT | _IOBUFFER_USER | _IOBUFFER_NONE); }

has_any_of()

bool __crt_stdio_stream::has_any_of ( long const  flags ) const throw ( )

inline

Definition at line 251 of file corecrt_internal_stdio.h.

{ return (get_flags() & flags) != 0;     }

Referenced by ctrl_z(), eof(), error(), has_any_buffer(), has_big_buffer(), has_crt_buffer(), has_setvbuf_buffer(), has_temporary_buffer(), and has_user_buffer().

has_big_buffer()

bool __crt_stdio_stream::has_big_buffer ( ) const throw ( )

inline

Definition at line 265 of file corecrt_internal_stdio.h.

{ return has_any_of(_IOBUFFER_CRT | _IOBUFFER_USER);                  }

has_crt_buffer()

bool __crt_stdio_stream::has_crt_buffer ( ) const throw ( )

inline

Definition at line 261 of file corecrt_internal_stdio.h.

{ return has_any_of(_IOBUFFER_CRT);                                   }

has_setvbuf_buffer()

bool __crt_stdio_stream::has_setvbuf_buffer ( ) const throw ( )

inline

Definition at line 264 of file corecrt_internal_stdio.h.

{ return has_any_of(_IOBUFFER_SETVBUF);                               }

has_temporary_buffer()

bool __crt_stdio_stream::has_temporary_buffer ( ) const throw ( )

inline

Definition at line 263 of file corecrt_internal_stdio.h.

{ return has_any_of(_IOBUFFER_STBUF);                                 }

has_user_buffer()

bool __crt_stdio_stream::has_user_buffer ( ) const throw ( )

inline

Definition at line 262 of file corecrt_internal_stdio.h.

{ return has_any_of(_IOBUFFER_USER);                                  }

is_in_use()

bool __crt_stdio_stream::is_in_use ( ) const throw ( )

inline

Definition at line 222 of file corecrt_internal_stdio.h.

    {
        return (get_flags() & _IOALLOCATED) != 0;
    }

is_string_backed()

bool __crt_stdio_stream::is_string_backed ( ) const throw ( )

inline

Definition at line 272 of file corecrt_internal_stdio.h.

{ return (get_flags() & _IOSTRING) != 0; }

Referenced by __crt_stdio_output::stream_output_adapter< Character >::write_character_without_count_update(), and __crt_stdio_output::stream_output_adapter< Character >::write_string().

lock()

void __crt_stdio_stream::lock ( ) const throw ( )

inline

Definition at line 248 of file corecrt_internal_stdio.h.

{ _lock_file  (public_stream()); }

lowio_handle()

int __crt_stdio_stream::lowio_handle ( ) const throw ( )

inline

Definition at line 270 of file corecrt_internal_stdio.h.

{ return __crt_interlocked_read(&_stream->_file); }

operator->()

__crt_stdio_stream_data * __crt_stdio_stream::operator-> ( ) const throw ( )

inline

Definition at line 274 of file corecrt_internal_stdio.h.

{ return _stream; }

public_stream()

FILE * __crt_stdio_stream::public_stream ( ) const throw ( )

inline

Definition at line 216 of file corecrt_internal_stdio.h.

{ return &_stream->_public_file; }

Referenced by _Success_(), __crt_stdio_input::stream_input_adapter< Character >::get(), lock(), __crt_stdio_input::stream_input_adapter< Character >::unget(), unlock(), __crt_stdio_input::stream_input_adapter< Character >::validate(), __crt_stdio_output::stream_output_adapter< Character >::validate(), and __crt_stdio_output::stream_output_adapter< Character >::write_character_without_count_update().

set_flags()

bool __crt_stdio_stream::set_flags ( long const  flags ) const throw ( )

inline

Definition at line 254 of file corecrt_internal_stdio.h.

{ return (_InterlockedOr(&_stream->_flags,   flags) & flags) != 0; }

Referenced by _Success_().

try_allocate()

bool __crt_stdio_stream::try_allocate ( ) throw ( )

inline

Definition at line 232 of file corecrt_internal_stdio.h.

    {
        return (_InterlockedOr(&_stream->_flags, _IOALLOCATED) & _IOALLOCATED) == 0;
    }

unlock()

void __crt_stdio_stream::unlock ( ) const throw ( )

inline

Definition at line 249 of file corecrt_internal_stdio.h.

{ _unlock_file(public_stream()); }

Referenced by _Success_().

unset_flags()

bool __crt_stdio_stream::unset_flags ( long const  flags ) const throw ( )

inline

Definition at line 255 of file corecrt_internal_stdio.h.

{ return (_InterlockedAnd(&_stream->_flags, ~flags) & flags) != 0; }

valid()

bool __crt_stdio_stream::valid ( ) const throw ( )

inline

Definition at line 215 of file corecrt_internal_stdio.h.

{ return _stream != nullptr;     }

Referenced by _Success_(), __crt_stdio_input::stream_input_adapter< Character >::validate(), and __crt_stdio_output::stream_output_adapter< Character >::validate().

Member Data Documentation

_stream

__crt_stdio_stream_data* __crt_stdio_stream::_stream

private

Definition at line 283 of file corecrt_internal_stdio.h.

Referenced by deallocate(), get_flags(), lowio_handle(), operator->(), public_stream(), set_flags(), try_allocate(), unset_flags(), and valid().

---

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

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