mirror of
https://github.com/reactos/reactos.git
synced 2024-07-04 03:34:16 +00:00
f982d77b8a
- Start to doxygenate the library, focusing in great details on the functions of the "outstream" module. - Add a K32LoadStringEx function that expands (K32)LoadString by allowing a LanguageId parameter to be able to load strings from other languages than the current one. - Add "ConResMsg*" helper functions to be able to (format and) print message strings with inserts that come *NOT* from a message table (as usual) *BUT* from resource string tables. Will be helpful for CORE-14265 in particular. [CMD] Fix the call to ConMsgPrintfV().
166 lines
4 KiB
C
166 lines
4 KiB
C
/*
|
|
* PROJECT: ReactOS Console Utilities Library
|
|
* LICENSE: GPL-2.0+ (https://spdx.org/licenses/GPL-2.0+)
|
|
* PURPOSE: Console/terminal paging functionality.
|
|
* COPYRIGHT: Copyright 2017-2018 ReactOS Team
|
|
* Copyright 2017-2018 Hermes Belusca-Maito
|
|
*/
|
|
|
|
/**
|
|
* @file pager.c
|
|
* @ingroup ConUtils
|
|
*
|
|
* @brief Console/terminal paging functionality.
|
|
**/
|
|
|
|
/* FIXME: Temporary HACK before we cleanly support UNICODE functions */
|
|
#define UNICODE
|
|
#define _UNICODE
|
|
|
|
#include <windef.h>
|
|
#include <winbase.h>
|
|
// #include <winnls.h>
|
|
#include <wincon.h> // Console APIs (only if kernel32 support included)
|
|
#include <strsafe.h>
|
|
|
|
#include "conutils.h"
|
|
#include "stream.h"
|
|
#include "screen.h"
|
|
#include "pager.h"
|
|
|
|
// Temporary HACK
|
|
#define CON_STREAM_WRITE ConStreamWrite
|
|
|
|
|
|
|
|
/* Returns TRUE when all the text is displayed, and FALSE if display is stopped */
|
|
BOOL
|
|
ConWritePaging(
|
|
IN PCON_PAGER Pager,
|
|
IN PAGE_PROMPT PagePrompt,
|
|
IN BOOL StartPaging,
|
|
IN PTCHAR szStr,
|
|
IN DWORD len)
|
|
{
|
|
CONSOLE_SCREEN_BUFFER_INFO csbi;
|
|
|
|
/* Used to see how big the screen is */
|
|
DWORD ScreenLines = 0;
|
|
|
|
/* Chars since start of line */
|
|
DWORD CharSL;
|
|
|
|
DWORD from = 0, i = 0;
|
|
|
|
/* Parameters validation */
|
|
if (!Pager)
|
|
return FALSE;
|
|
|
|
/* Reset LineCount and return if no string has been given */
|
|
if (StartPaging == TRUE)
|
|
Pager->LineCount = 0;
|
|
if (szStr == NULL)
|
|
return TRUE;
|
|
|
|
/* Get the size of the visual screen that can be printed to */
|
|
if (!ConGetScreenInfo(Pager->Screen, &csbi))
|
|
{
|
|
/* We assume it's a file handle */
|
|
CON_STREAM_WRITE(Pager->Screen->Stream, szStr, len);
|
|
return TRUE;
|
|
}
|
|
|
|
/*
|
|
* Get the number of lines currently displayed on screen, minus 1
|
|
* to account for the "press any key..." prompt from PagePrompt().
|
|
*/
|
|
ScreenLines = (csbi.srWindow.Bottom - csbi.srWindow.Top);
|
|
CharSL = csbi.dwCursorPosition.X;
|
|
|
|
/* Make sure the user doesn't have the screen too small */
|
|
if (ScreenLines < 4)
|
|
{
|
|
CON_STREAM_WRITE(Pager->Screen->Stream, szStr, len);
|
|
return TRUE;
|
|
}
|
|
|
|
while (i < len)
|
|
{
|
|
/* Search until the end of a line is reached */
|
|
if (szStr[i++] != TEXT('\n') && ++CharSL < csbi.dwSize.X)
|
|
continue;
|
|
|
|
Pager->LineCount++;
|
|
CharSL = 0;
|
|
|
|
if (Pager->LineCount >= ScreenLines)
|
|
{
|
|
CON_STREAM_WRITE(Pager->Screen->Stream, &szStr[from], i-from);
|
|
from = i;
|
|
|
|
/* Prompt the user; give him some values for statistics */
|
|
// FIXME TODO: The prompt proc can also take ScreenLines ??
|
|
if (!PagePrompt(Pager, from, len))
|
|
return FALSE;
|
|
|
|
// TODO: Recalculate 'ScreenLines' in case the user redimensions
|
|
// the window during the prompt.
|
|
|
|
/* Reset the number of lines being printed */
|
|
Pager->LineCount = 0;
|
|
}
|
|
}
|
|
if (i > from)
|
|
CON_STREAM_WRITE(Pager->Screen->Stream, &szStr[from], i-from);
|
|
|
|
return TRUE;
|
|
}
|
|
|
|
BOOL
|
|
ConPutsPaging(
|
|
IN PCON_PAGER Pager,
|
|
IN PAGE_PROMPT PagePrompt,
|
|
IN BOOL StartPaging,
|
|
IN LPTSTR szStr)
|
|
{
|
|
DWORD len;
|
|
|
|
/* Return if no string has been given */
|
|
if (szStr == NULL)
|
|
return TRUE;
|
|
|
|
len = wcslen(szStr);
|
|
return ConWritePaging(Pager, PagePrompt, StartPaging, szStr, len);
|
|
}
|
|
|
|
BOOL
|
|
ConResPagingEx(
|
|
IN PCON_PAGER Pager,
|
|
IN PAGE_PROMPT PagePrompt,
|
|
IN BOOL StartPaging,
|
|
IN HINSTANCE hInstance OPTIONAL,
|
|
IN UINT uID)
|
|
{
|
|
INT Len;
|
|
PWCHAR szStr = NULL;
|
|
|
|
Len = K32LoadStringW(hInstance, uID, (PWSTR)&szStr, 0);
|
|
if (szStr && Len)
|
|
return ConWritePaging(Pager, PagePrompt, StartPaging, szStr, Len);
|
|
else
|
|
return TRUE;
|
|
}
|
|
|
|
BOOL
|
|
ConResPaging(
|
|
IN PCON_PAGER Pager,
|
|
IN PAGE_PROMPT PagePrompt,
|
|
IN BOOL StartPaging,
|
|
IN UINT uID)
|
|
{
|
|
return ConResPagingEx(Pager, PagePrompt, StartPaging,
|
|
NULL /*GetModuleHandleW(NULL)*/, uID);
|
|
}
|
|
|
|
/* EOF */
|