screen.h File Reference

Console/terminal screen management. More...

#include <wincon.h>

Include dependency graph for screen.h:

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

Go to the source code of this file.

Classes
struct	_CON_SCREEN

Macros
#define	INIT_CON_SCREEN(pStream)   {(pStream)} /* {(pStream), {{}}, {{}}} */
#define	InitializeConScreen(pScreen, pStream)

Typedefs
typedef struct _CON_SCREEN	CON_SCREEN
typedef struct _CON_SCREEN *	PCON_SCREEN

Functions
BOOL	ConGetScreenInfo (IN PCON_SCREEN Screen, OUT PCONSOLE_SCREEN_BUFFER_INFO pcsbi)
VOID	ConClearScreen (IN PCON_SCREEN Screen)

Detailed Description

Console/terminal screen management.

Definition in file screen.h.

Macro Definition Documentation

INIT_CON_SCREEN

#define INIT_CON_SCREEN

(

pStream

)

{(pStream)} /* {(pStream), {{}}, {{}}} */

Definition at line 49 of file screen.h.

InitializeConScreen

#define InitializeConScreen	(		pScreen,
			pStream
	)

Value:

do { \
    (pScreen)->Stream = (pStream);  \
    RtlZeroMemory(&(pScreen)->csbi, sizeof((pScreen)->csbi));   \
    RtlZeroMemory(&(pScreen)->cci , sizeof((pScreen)->cci ));   \
} while (0)

Definition at line 51 of file screen.h.

Typedef Documentation

CON_SCREEN

typedef struct _CON_SCREEN CON_SCREEN

PCON_SCREEN

typedef struct _CON_SCREEN * PCON_SCREEN

Function Documentation

ConClearScreen()

VOID ConClearScreen

(

IN PCON_SCREEN

Screen

)

Definition at line 131 of file screen.c.

{
    HANDLE hOutput;
 
    /* Parameters validation */
    if (!Screen) return;
 
#if 0
    /* Get the size of the visual screen */
    if (!ConGetScreenInfo(Screen, &csbi))
    {
        /* We assume it's a file handle */
        return;
    }
#endif
 
    hOutput = ConStreamGetOSHandle(Screen->Stream);
 
    if (IsConsoleHandle(hOutput))
    {
        CONSOLE_SCREEN_BUFFER_INFO csbi;
        COORD coPos;
        DWORD dwWritten;
 
        GetConsoleScreenBufferInfo(hOutput, &csbi);
 
        coPos.X = 0;
        coPos.Y = 0;
        FillConsoleOutputAttribute(hOutput, csbi.wAttributes,
                                   csbi.dwSize.X * csbi.dwSize.Y,
                                   coPos, &dwWritten);
        FillConsoleOutputCharacterW(hOutput, L' ',
                                    csbi.dwSize.X * csbi.dwSize.Y,
                                    coPos, &dwWritten);
        SetConsoleCursorPosition(hOutput, coPos);
    }
    else if (IsTTYHandle(hOutput))
    {
        /* Clear the full screen and move the cursor to (0,0) */
        ConPuts(Screen->Stream, L"\x1B[2J\x1B[1;1H");
    }
    else
    {
        /* Issue a Form-Feed control */
        WCHAR ch = L'\f';
        CON_STREAM_WRITE(Screen->Stream, &ch, 1);
    }
}

Referenced by cmd_cls(), and PagePrompt().

ConGetScreenInfo()

BOOL ConGetScreenInfo	(	IN PCON_SCREEN	Screen,
		OUT PCONSOLE_SCREEN_BUFFER_INFO	pcsbi
	)

Definition at line 73 of file screen.c.

{
    BOOL Success;
    HANDLE hOutput;
 
    /* Parameters validation */
    if (!Screen || !pcsbi)
        return FALSE;
 
    hOutput = ConStreamGetOSHandle(Screen->Stream);
 
    /* Screen handle must be of TTY type (console or TTY) */
    if (!IsTTYHandle(hOutput))
        return FALSE;
 
    /* Update cached screen information */
    if (IsConsoleHandle(hOutput))
    {
        Success = GetConsoleScreenBufferInfo(hOutput, &Screen->csbi);
    }
    else
    {
#if 0
        /* TODO: Do something adequate for TTYs */
        // FIXME: At the moment we return hardcoded info.
        Screen->csbi.dwSize.X = 80;
        Screen->csbi.dwSize.Y = 25;
 
        // Screen->csbi.dwCursorPosition;
        // Screen->csbi.wAttributes;
        // Screen->csbi.srWindow;
        Screen->csbi.dwMaximumWindowSize = Screen->csbi.dwSize;
#else
        hOutput = CreateFileW(L"CONOUT$", GENERIC_READ|GENERIC_WRITE,
                             FILE_SHARE_READ|FILE_SHARE_WRITE, NULL,
                             OPEN_EXISTING, 0, NULL);
 
        Success = IsConsoleHandle(hOutput) &&
                  GetConsoleScreenBufferInfo(hOutput, &Screen->csbi);
 
        CloseHandle(hOutput);
#endif
    }
 
    if (Success)
    {
        /* Return it to the caller */
        *pcsbi = Screen->csbi;
    }
 
    return Success;
}

Referenced by ConClearScreen(), ConWritePaging(), and PagePrompt().