console.h File Reference

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

Go to the source code of this file.

Macros
#define	ConOutPuts(szStr)    ConPuts(StdOut, (szStr))
#define	ConErrPuts(szStr)    ConPuts(StdErr, (szStr))
#define	ConOutResPuts(uID)    ConResPuts(StdOut, (uID))
#define	ConErrResPuts(uID)    ConResPuts(StdErr, (uID))
#define	ConOutPrintf(szStr, ...)    ConPrintf(StdOut, (szStr), ##__VA_ARGS__)
#define	ConErrPrintf(szStr, ...)    ConPrintf(StdErr, (szStr), ##__VA_ARGS__)
#define	ConOutResPrintf(uID, ...)    ConResPrintf(StdOut, (uID), ##__VA_ARGS__)
#define	ConErrResPrintf(uID, ...)    ConResPrintf(StdErr, (uID), ##__VA_ARGS__)
#define	ConOutFormatMessage(MessageId, ...)    ConFormatMessage(StdOut, (MessageId), ##__VA_ARGS__)
#define	ConErrFormatMessage(MessageId, ...)    ConFormatMessage(StdErr, (MessageId), ##__VA_ARGS__)
#define	ConGetTextWidth   ConGetTextWidthA

Functions
VOID	ConInDisable (VOID)
VOID	ConInEnable (VOID)
VOID	ConInFlush (VOID)
VOID	ConInKey (PINPUT_RECORD)
VOID	ConInString (LPTSTR, DWORD)
VOID	ConOutChar (TCHAR)
VOID	ConErrChar (TCHAR)
VOID __cdecl	ConFormatMessage (PCON_STREAM Stream, DWORD MessageId,...)
BOOL	ConPrintfVPaging (PCON_PAGER Pager, BOOL StartPaging, LPTSTR szFormat, va_list arg_ptr)
BOOL __cdecl	ConOutPrintfPaging (BOOL StartPaging, LPTSTR szFormat,...)
VOID	ConOutResPaging (BOOL StartPaging, UINT resID)
SHORT	GetCursorX (VOID)
SHORT	GetCursorY (VOID)
VOID	GetCursorXY (PSHORT, PSHORT)
VOID	SetCursorXY (SHORT, SHORT)
VOID	GetScreenSize (PSHORT, PSHORT)
VOID	SetCursorType (BOOL, BOOL)
BOOL	ConSetTitle (IN LPCTSTR lpConsoleTitle)
SIZE_T	ConGetTextWidthA (PCSTR pszText)
SIZE_T	ConGetTextWidthW (PCWSTR pszText)

Variables
UINT	InputCodePage
UINT	OutputCodePage
CON_SCREEN	StdOutScreen
CON_PAGER	StdOutPager

Macro Definition Documentation

ConErrFormatMessage

#define ConErrFormatMessage	(		MessageId,
			...
	)		ConFormatMessage(StdErr, (MessageId), ##__VA_ARGS__)

Definition at line 56 of file console.h.

ConErrPrintf

#define ConErrPrintf	(		szStr,
			...
	)		ConPrintf(StdErr, (szStr), ##__VA_ARGS__)

Definition at line 44 of file console.h.

ConErrPuts

#define ConErrPuts

(

szStr

)

ConPuts(StdErr, (szStr))

Definition at line 32 of file console.h.

ConErrResPrintf

#define ConErrResPrintf	(		uID,
			...
	)		ConResPrintf(StdErr, (uID), ##__VA_ARGS__)

Definition at line 50 of file console.h.

ConErrResPuts

#define ConErrResPuts

(

uID

)

ConResPuts(StdErr, (uID))

Definition at line 38 of file console.h.

ConGetTextWidth

#define ConGetTextWidth   ConGetTextWidthA

Definition at line 105 of file console.h.

ConOutFormatMessage

#define ConOutFormatMessage	(		MessageId,
			...
	)		ConFormatMessage(StdOut, (MessageId), ##__VA_ARGS__)

Definition at line 53 of file console.h.

ConOutPrintf

#define ConOutPrintf	(		szStr,
			...
	)		ConPrintf(StdOut, (szStr), ##__VA_ARGS__)

Definition at line 41 of file console.h.

ConOutPuts

#define ConOutPuts

(

szStr

)

ConPuts(StdOut, (szStr))

Definition at line 29 of file console.h.

ConOutResPrintf

#define ConOutResPrintf	(		uID,
			...
	)		ConResPrintf(StdOut, (uID), ##__VA_ARGS__)

Definition at line 47 of file console.h.

ConOutResPuts

#define ConOutResPuts

(

uID

)

ConResPuts(StdOut, (uID))

Definition at line 35 of file console.h.

Function Documentation

ConErrChar()

VOID ConErrChar

(

TCHAR

)

ConFormatMessage()

VOID __cdecl ConFormatMessage	(	PCON_STREAM	Stream,
		DWORD	MessageId,
			...
	)

Definition at line 215 of file util.c.

{
    INT Len;
    va_list arg_ptr;
 
    va_start(arg_ptr, MessageId);
    Len = ConMsgPrintfV(Stream,
                        FORMAT_MESSAGE_FROM_SYSTEM,
                        NULL,
                        MessageId,
                        LANG_USER_DEFAULT,
                        &arg_ptr);
    va_end(arg_ptr);
 
    if (Len <= 0)
        ConResPrintf(Stream, STRING_CONSOLE_ERROR, MessageId);
}

ConGetTextWidthA()

SIZE_T ConGetTextWidthA

(

PCSTR

pszText

)

Definition at line 354 of file console.c.

{
    int cchMax;
    PWSTR pszWide;
    SIZE_T cxWidth;
 
    cchMax = MultiByteToWideChar(OutputCodePage, 0, pszText, -1, NULL, 0);
    pszWide = cmd_alloc(cchMax * sizeof(WCHAR));
    MultiByteToWideChar(OutputCodePage, 0, pszText, -1, pszWide, cchMax);
    cxWidth = ConGetTextWidthW(pszWide);
    cmd_free(pszWide);
    return cxWidth;
}

ConGetTextWidthW()

SIZE_T ConGetTextWidthW

(

PCWSTR

pszText

)

Definition at line 336 of file console.c.

{
    SIZE_T ich, cxWidth;
 
    if (!IsCJKCodePage(OutputCodePage))
        return _tcslen(pszText);
 
    for (ich = cxWidth = 0; pszText[ich]; ++ich)
    {
        if (IS_FULL_WIDTH(pszText[ich]))
            cxWidth += 2;
        else
            ++cxWidth;
    }
 
    return cxWidth;
}

Referenced by ConGetTextWidthA().

ConInDisable()

VOID ConInDisable

(

VOID

)

Definition at line 36 of file console.c.

{
    HANDLE hInput = GetStdHandle(STD_INPUT_HANDLE);
    DWORD dwMode;
 
    GetConsoleMode(hInput, &dwMode);
    dwMode &= ~ENABLE_PROCESSED_INPUT;
    SetConsoleMode(hInput, dwMode);
}

Referenced by FilePromptYN(), FilePromptYNA(), and PagePrompt().

ConInEnable()

VOID ConInEnable

(

VOID

)

Definition at line 46 of file console.c.

{
    HANDLE hInput = GetStdHandle(STD_INPUT_HANDLE);
    DWORD dwMode;
 
    GetConsoleMode(hInput, &dwMode);
    dwMode |= ENABLE_PROCESSED_INPUT;
    SetConsoleMode(hInput, dwMode);
}

Referenced by FilePromptYN(), FilePromptYNA(), and PagePrompt().

ConInFlush()

VOID ConInFlush

(

VOID

)

Definition at line 56 of file console.c.

{
    FlushConsoleInputBuffer(GetStdHandle(STD_INPUT_HANDLE));
}

Referenced by CommandChoice().

ConInKey()

VOID ConInKey

(

PINPUT_RECORD

lpBuffer

)

Definition at line 61 of file console.c.

{
    HANDLE hInput = GetStdHandle(STD_INPUT_HANDLE);
    DWORD  dwRead;
 
    if (hInput == INVALID_HANDLE_VALUE)
        WARN ("Invalid input handle!!!\n");
 
    do
    {
        ReadConsoleInput(hInput, lpBuffer, 1, &dwRead);
        if (lpBuffer->EventType == KEY_EVENT &&
            lpBuffer->Event.KeyEvent.bKeyDown)
        {
            break;
        }
    }
    while (TRUE);
}

Referenced by CommandChoice(), FilePromptYN(), FilePromptYNA(), PagePrompt(), and ReadCommand().

ConInString()

VOID ConInString	(	LPTSTR	lpInput,
		DWORD	dwLength
	)

Definition at line 172 of file util.c.

{
    DWORD dwOldMode;
    DWORD dwRead = 0;
    HANDLE hFile;
 
    LPTSTR p;
    PCHAR pBuf;
 
#ifdef _UNICODE
    pBuf = (PCHAR)malloc(dwLength - 1);
#else
    pBuf = lpInput;
#endif
    ZeroMemory(lpInput, dwLength * sizeof(TCHAR));
    hFile = GetStdHandle(STD_INPUT_HANDLE);
    GetConsoleMode(hFile, &dwOldMode);
 
    SetConsoleMode(hFile, ENABLE_PROCESSED_INPUT | ENABLE_LINE_INPUT | ENABLE_ECHO_INPUT);
 
    ReadFile(hFile, (PVOID)pBuf, dwLength - 1, &dwRead, NULL);
 
#ifdef _UNICODE
    MultiByteToWideChar(GetConsoleCP(), 0, pBuf, dwRead, lpInput, dwLength - 1);
    free(pBuf);
#endif
    for (p = lpInput; *p; p++)
    {
        if (*p == _T('\r')) // Terminate at the carriage-return.
        {
            *p = _T('\0');
            break;
        }
    }
 
    SetConsoleMode(hFile, dwOldMode);
}

Referenced by FilePromptYNA().

ConOutChar()

VOID ConOutChar

(

TCHAR

c

)

Definition at line 233 of file util.c.

{
    ConWrite(StdOut, &c, 1);
}

ConOutPrintfPaging()

BOOL __cdecl ConOutPrintfPaging	(	BOOL	StartPaging,
		LPTSTR	szFormat,
			...
	)

ConOutResPaging()

VOID ConOutResPaging	(	BOOL	StartPaging,
		UINT	resID
	)

Definition at line 178 of file console.c.

{
    ConResPaging(&StdOutPager, PagePrompt, StartPaging, resID);
}

Referenced by cmd_beep(), cmd_call(), cmd_chdir(), cmd_cls(), cmd_copy(), cmd_ctty(), cmd_date(), cmd_for(), cmd_goto(), cmd_if(), cmd_mkdir(), cmd_move(), cmd_path(), cmd_pause(), cmd_prompt(), cmd_rename(), cmd_rmdir(), cmd_set(), cmd_shift(), cmd_start(), cmd_time(), cmd_title(), cmd_type(), cmd_ver(), cmd_verify(), cmd_vol(), CommandAlias(), CommandAssoc(), CommandChoice(), CommandColor(), CommandDelay(), CommandDelete(), CommandEcho(), CommandExit(), CommandFree(), CommandMemory(), CommandRem(), CommandScreen(), DirHelp(), and Initialize().

ConPrintfVPaging()

BOOL ConPrintfVPaging	(	PCON_PAGER	Pager,
		BOOL	StartPaging,
		LPTSTR	szFormat,
		va_list	arg_ptr
	)

ConSetTitle()

BOOL ConSetTitle

(

IN LPCTSTR

lpConsoleTitle

)

GetCursorX()

SHORT GetCursorX

(

VOID

)

Definition at line 206 of file console.c.

{
    CONSOLE_SCREEN_BUFFER_INFO csbi;
 
    GetConsoleScreenBufferInfo(GetStdHandle(STD_OUTPUT_HANDLE), &csbi);
    return csbi.dwCursorPosition.X;
}

Referenced by ReadCommand().

GetCursorXY()

VOID GetCursorXY	(	PSHORT	x,
		PSHORT	y
	)

Definition at line 196 of file console.c.

{
    CONSOLE_SCREEN_BUFFER_INFO csbi;
 
    GetConsoleScreenBufferInfo(GetStdHandle(STD_OUTPUT_HANDLE), &csbi);
 
    *x = csbi.dwCursorPosition.X;
    *y = csbi.dwCursorPosition.Y;
}

Referenced by ReadCommand().

GetCursorY()

SHORT GetCursorY

(

VOID

)

Definition at line 214 of file console.c.

{
    CONSOLE_SCREEN_BUFFER_INFO csbi;
 
    GetConsoleScreenBufferInfo(GetStdHandle(STD_OUTPUT_HANDLE), &csbi);
    return csbi.dwCursorPosition.Y;
}

Referenced by PagePrompt(), PrintPrompt(), and ReadCommand().

GetScreenSize()

VOID GetScreenSize	(	PSHORT	maxx,
		PSHORT	maxy
	)

Definition at line 232 of file console.c.

{
    CONSOLE_SCREEN_BUFFER_INFO csbi;
 
    if (!GetConsoleScreenBufferInfo(GetStdHandle(STD_OUTPUT_HANDLE), &csbi))
    {
        csbi.dwSize.X = 80;
        csbi.dwSize.Y = 25;
    }
 
    if (maxx) *maxx = csbi.dwSize.X;
    if (maxy) *maxy = csbi.dwSize.Y;
}

Referenced by CommandScreen(), DirPrintWideList(), and PagePrompt().

SetCursorType()

VOID SetCursorType	(	BOOL	bInsert,
		BOOL	bVisible
	)

Definition at line 222 of file console.c.

{
    CONSOLE_CURSOR_INFO cci;
 
    cci.dwSize = bInsert ? 10 : 99;
    cci.bVisible = bVisible;
 
    SetConsoleCursorInfo(GetStdHandle(STD_OUTPUT_HANDLE), &cci);
}

Referenced by ReadCommand().

SetCursorXY()

VOID SetCursorXY	(	SHORT	x,
		SHORT	y
	)

Definition at line 187 of file console.c.

{
    COORD coPos;
 
    coPos.X = x;
    coPos.Y = y;
    SetConsoleCursorPosition(GetStdHandle(STD_OUTPUT_HANDLE), coPos);
}

Referenced by ClearCommandLine(), CommandScreen(), PagePrompt(), and ReadCommand().

Variable Documentation

InputCodePage

UINT InputCodePage

extern

Definition at line 25 of file console.c.

Referenced by _tmain(), cmd_start(), ConInString(), Execute(), and ReadCommand().

OutputCodePage

UINT OutputCodePage

extern

Definition at line 26 of file console.c.

Referenced by _tmain(), BatchGetString(), cmd_start(), CmdTrace(), ConGetTextWidthA(), ConGetTextWidthW(), DirPrintWideList(), Execute(), FileGetString(), and Initialize().

StdOutPager

CON_PAGER StdOutPager

extern

Definition at line 30 of file console.c.

Referenced by ConOutPrintfPaging(), ConOutResPaging(), and DirPrintf().

StdOutScreen

CON_SCREEN StdOutScreen

extern

Definition at line 30 of file attrib.c.

Referenced by cmd_cls().