stream.c File Reference

Console I/O streams. More...

#include <windef.h>
#include <winbase.h>
#include <winnls.h>
#include <wincon.h>
#include <strsafe.h>
#include "conutils.h"
#include "stream.h"
#include "stream_private.h"

Include dependency graph for stream.c:

Go to the source code of this file.

Macros
#define	UNICODE
#define	_UNICODE
#define	CON_STREAM_SET_MODE(Stream, Mode, CacheCodePage)

Functions
BOOL	ConStreamInitEx (OUT PCON_STREAM Stream, IN PVOID Handle, IN CON_STREAM_MODE Mode, IN UINT CacheCodePage OPTIONAL, IN CON_WRITE_FUNC WriteFunc OPTIONAL)
BOOL	ConStreamInit (OUT PCON_STREAM Stream, IN PVOID Handle, IN CON_STREAM_MODE Mode, IN UINT CacheCodePage OPTIONAL)
BOOL	ConStreamSetMode (IN PCON_STREAM Stream, IN CON_STREAM_MODE Mode, IN UINT CacheCodePage OPTIONAL)
BOOL	ConStreamSetCacheCodePage (IN PCON_STREAM Stream, IN UINT CacheCodePage)
HANDLE	ConStreamGetOSHandle (IN PCON_STREAM Stream)
BOOL	ConStreamSetOSHandle (IN PCON_STREAM Stream, IN HANDLE Handle)

Variables
CON_STREAM	csStdIn
CON_STREAM	csStdOut
CON_STREAM	csStdErr

Detailed Description

Console I/O streams.

Definition in file stream.c.

Macro Definition Documentation

_UNICODE

#define _UNICODE

Definition at line 28 of file stream.c.

CON_STREAM_SET_MODE

#define CON_STREAM_SET_MODE	(		Stream,
			Mode,
			CacheCodePage
	)

Value:

do { \
    (Stream)->Mode = (Mode); \
\
    if ((Mode) == AnsiText)  \
        (Stream)->CodePage = CacheCodePage; /* Possibly assigned */          \
    else if ((Mode) == UTF8Text) \
        (Stream)->CodePage = CP_UTF8;       /* Fixed */                      \
    else /* Mode == Binary, WideText, UTF16Text */                           \
        (Stream)->CodePage = INVALID_CP;    /* Not assigned (meaningless) */ \
} while(0)

Definition at line 111 of file stream.c.

UNICODE

#define UNICODE

NOTE: Experimental! Don't use USE_CRT yet because output to console is a bit broken

Definition at line 27 of file stream.c.

Function Documentation

ConStreamGetOSHandle()

HANDLE ConStreamGetOSHandle

(

IN PCON_STREAM

Stream

)

Definition at line 240 of file stream.c.

{
    /* Parameters validation */
    if (!Stream)
        return INVALID_HANDLE_VALUE;
 
    /*
     * See https://support.microsoft.com/kb/99173
     * for more details.
     */
 
#ifdef USE_CRT
    if (!Stream->fStream)
        return INVALID_HANDLE_VALUE;
 
    return (HANDLE)_get_osfhandle(_fileno(Stream->fStream));
#else
    return Stream->hHandle;
#endif
}

Referenced by _tmain(), BreakHandler(), Cleanup(), cmd_beep(), cmd_start(), CommandColor(), ConClearLine(), ConClearScreen(), ConGetScreenInfo(), Execute(), GetHandle(), Initialize(), InputWait(), and PagePrompt().

ConStreamInit()

BOOL ConStreamInit	(	OUT PCON_STREAM	Stream,
		IN PVOID	Handle,
		IN CON_STREAM_MODE	Mode,
		IN UINT CacheCodePage	OPTIONAL
	)

Definition at line 185 of file stream.c.

{
    return ConStreamInitEx(Stream, Handle, Mode, CacheCodePage, ConWrite);
}

Referenced by _tmain(), and wmain().

ConStreamInitEx()

BOOL ConStreamInitEx	(	OUT PCON_STREAM	Stream,
		IN PVOID	Handle,
		IN CON_STREAM_MODE	Mode,
		IN UINT CacheCodePage	OPTIONAL,
		IN CON_WRITE_FUNC WriteFunc	OPTIONAL
	)

Definition at line 127 of file stream.c.

{
    /* Parameters validation */
    if (!Stream || !Handle || (Mode > UTF8Text))
        return FALSE;
 
#ifdef USE_CRT
 
    Stream->fStream = (FILE*)Handle;
 
#else
 
    if ((HANDLE)Handle == INVALID_HANDLE_VALUE)
        return FALSE;
 
    /*
     * As the user calls us by giving us an existing handle to attach on,
     * it is not our duty to close it if we are called again. The user
     * is responsible for having opened those handles, and is responsible
     * for closing them!
     */
#if 0
    /* Attempt to close the handle of the old stream */
    if (/* Stream->IsInitialized && */ Stream->hHandle &&
        Stream->hHandle != INVALID_HANDLE_VALUE)
    {
        CloseHandle(Stream->hHandle);
    }
#endif
 
    /* Initialize the stream critical section if not already done */
    if (!Stream->IsInitialized)
    {
        InitializeCriticalSection/*AndSpinCount*/(&Stream->Lock /* , 4000 */);
        Stream->IsInitialized = TRUE;
    }
 
    Stream->hHandle   = (HANDLE)Handle;
    Stream->IsConsole = IsConsoleHandle(Stream->hHandle);
 
#endif /* defined(USE_CRT) */
 
    /* Set the correct file translation mode */
    CON_STREAM_SET_MODE(Stream, Mode, CacheCodePage);
 
    /* Use the default 'ConWrite' helper if nothing is specified */
    Stream->WriteFunc = (WriteFunc ? WriteFunc : ConWrite);
 
    return TRUE;
}

Referenced by ConStreamInit().

ConStreamSetCacheCodePage()

BOOL ConStreamSetCacheCodePage	(	IN PCON_STREAM	Stream,
		IN UINT	CacheCodePage
	)

Definition at line 215 of file stream.c.

{
#ifdef USE_CRT
// FIXME!
#warning The ConStreamSetCacheCodePage function does not make much sense with the CRT!
#else
    CON_STREAM_MODE Mode;
 
    /* Parameters validation */
    if (!Stream)
        return FALSE;
 
    /*
     * Keep the original stream mode but set the correct file code page
     * (will be reset only if Mode == AnsiText).
     */
    Mode = Stream->Mode;
    CON_STREAM_SET_MODE(Stream, Mode, CacheCodePage);
#endif
    return TRUE;
}

ConStreamSetMode()

BOOL ConStreamSetMode	(	IN PCON_STREAM	Stream,
		IN CON_STREAM_MODE	Mode,
		IN UINT CacheCodePage	OPTIONAL
	)

Definition at line 195 of file stream.c.

{
    /* Parameters validation */
    if (!Stream || (Mode > UTF8Text))
        return FALSE;
 
#ifdef USE_CRT
    if (!Stream->fStream)
        return FALSE;
#endif
 
    /* Set the correct file translation mode */
    CON_STREAM_SET_MODE(Stream, Mode, CacheCodePage);
    return TRUE;
}

Referenced by Initialize().

ConStreamSetOSHandle()

BOOL ConStreamSetOSHandle	(	IN PCON_STREAM	Stream,
		IN HANDLE	Handle
	)

Definition at line 263 of file stream.c.

{
    /* Parameters validation */
    if (!Stream)
        return FALSE;
 
    /*
     * See https://support.microsoft.com/kb/99173
     * for more details.
     */
 
#ifdef USE_CRT
    if (!Stream->fStream)
        return FALSE;
 
    int fdOut = _open_osfhandle((intptr_t)Handle, _O_TEXT /* FIXME! */);
    FILE* fpOut = _fdopen(fdOut, "w");
    *Stream->fStream = *fpOut;
 
    return TRUE;
#else
    /* Flush the stream and reset its handle */
    if (Stream->hHandle != INVALID_HANDLE_VALUE)
        FlushFileBuffers(Stream->hHandle);
 
    Stream->hHandle   = Handle;
    Stream->IsConsole = IsConsoleHandle(Stream->hHandle);
 
    // NOTE: Mode reset??
 
    return TRUE;
#endif
}

Referenced by SetHandle(), and wmain().

Variable Documentation

csStdErr

CON_STREAM csStdErr

Definition at line 61 of file stream.c.

csStdIn

CON_STREAM csStdIn

Definition at line 59 of file stream.c.

csStdOut

CON_STREAM csStdOut

Definition at line 60 of file stream.c.