stream.h File Reference

Console I/O streams. More...

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

Go to the source code of this file.

Macros
#define	INVALID_CP   ((UINT)-1)
#define	StdIn   (&csStdIn )
#define	StdOut   (&csStdOut)
#define	StdErr   (&csStdErr)
#define	ConInitStdStreamsAndMode(Mode, CacheCodePage)
#define	ConInitStdStreams()    ConInitStdStreamsAndMode(AnsiText, INVALID_CP)
#define	ConStdStreamsSetCacheCodePage(InputCodePage, OutputCodePage)

Typedefs
typedef enum _CON_STREAM_MODE	CON_STREAM_MODE
typedef enum _CON_STREAM_MODE *	PCON_STREAM_MODE
typedef struct _CON_STREAM	CON_STREAM
typedef struct _CON_STREAM *	PCON_STREAM
typedef INT(__stdcall *	CON_WRITE_FUNC) (IN PCON_STREAM Stream, IN PCTCH szStr, IN DWORD len)

Enumerations
enum	_CON_STREAM_MODE {   Binary = 0 , AnsiText , WideText , UTF16Text ,   UTF8Text }

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.h.

Macro Definition Documentation

ConInitStdStreams

#define ConInitStdStreams

(

)

ConInitStdStreamsAndMode(AnsiText, INVALID_CP)

Definition at line 128 of file stream.h.

ConInitStdStreamsAndMode

#define ConInitStdStreamsAndMode	(		Mode,
			CacheCodePage
	)

Value:

do { \
    ConStreamInit(StdIn , GetStdHandle(STD_INPUT_HANDLE) , (Mode), (CacheCodePage)); \
    ConStreamInit(StdOut, GetStdHandle(STD_OUTPUT_HANDLE), (Mode), (CacheCodePage)); \
    ConStreamInit(StdErr, GetStdHandle(STD_ERROR_HANDLE) , (Mode), (CacheCodePage)); \
} while(0)

Definition at line 114 of file stream.h.

ConStdStreamsSetCacheCodePage

#define ConStdStreamsSetCacheCodePage	(		InputCodePage,
			OutputCodePage
	)

Value:

do { \
    ConStreamSetCacheCodePage(StdIn , (InputCodePage )); \
    ConStreamSetCacheCodePage(StdOut, (OutputCodePage)); \
    ConStreamSetCacheCodePage(StdErr, (OutputCodePage)); \
} while(0)

Definition at line 152 of file stream.h.

INVALID_CP

#define INVALID_CP   ((UINT)-1)

Definition at line 53 of file stream.h.

StdErr

#define StdErr   (&csStdErr)

Definition at line 83 of file stream.h.

StdIn

#define StdIn   (&csStdIn )

Definition at line 81 of file stream.h.

StdOut

#define StdOut   (&csStdOut)

Definition at line 82 of file stream.h.

Typedef Documentation

CON_STREAM

typedef struct _CON_STREAM CON_STREAM

Definition at line 56 of file stream.h.

CON_STREAM_MODE

typedef enum _CON_STREAM_MODE CON_STREAM_MODE

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

CON_WRITE_FUNC

typedef INT(__stdcall * CON_WRITE_FUNC) (IN PCON_STREAM Stream, IN PCTCH szStr, IN DWORD len)

Definition at line 63 of file stream.h.

PCON_STREAM

typedef struct _CON_STREAM * PCON_STREAM

Definition at line 56 of file stream.h.

PCON_STREAM_MODE

typedef enum _CON_STREAM_MODE * PCON_STREAM_MODE

Enumeration Type Documentation

_CON_STREAM_MODE

enum _CON_STREAM_MODE

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

Enumerator
Binary
AnsiText
WideText
UTF16Text
UTF8Text

Definition at line 43 of file stream.h.

{
    Binary = 0, // #define _O_BINARY    0x8000  // file mode is binary (untranslated)
                // #define _O_RAW       _O_BINARY
    AnsiText,   // #define _O_TEXT      0x4000  // file mode is text (translated) -- "ANSI"
    WideText,   // #define _O_WTEXT     0x10000 // file mode is UTF16 with BOM (translated) -- "Unicode" of Windows
    UTF16Text,  // #define _O_U16TEXT   0x20000 // file mode is UTF16   no BOM (translated) --    ""          ""
    UTF8Text,   // #define _O_U8TEXT    0x40000 // file mode is UTF8    no BOM (translated)
} CON_STREAM_MODE, *PCON_STREAM_MODE;

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

extern

Definition at line 61 of file stream.c.

csStdIn

CON_STREAM csStdIn

extern

Definition at line 59 of file stream.c.

csStdOut

CON_STREAM csStdOut

extern

Definition at line 60 of file stream.c.