mirror of
https://github.com/reactos/reactos.git
synced 2025-04-30 19:19:00 +00:00
f74a3f6e29
- Shorten the names of the flags: CON_PAGER_FLAG_*** --> CON_PAGER_***. - Reorder few members in the CON_PAGER pager structure where they make sense. - ScreenColumns, ScreenRows --> PageColumns, PageRows: keeping the open possibility for having a pager controlling a region of different size than the screen. - Add doxygen documentation for ConWritePaging().
120 lines
2.6 KiB
C
120 lines
2.6 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-2021 Hermes Belusca-Maito
|
|
* Copyright 2021 Katayama Hirofumi MZ
|
|
*/
|
|
|
|
/**
|
|
* @file pager.h
|
|
* @ingroup ConUtils
|
|
*
|
|
* @brief Console/terminal paging functionality.
|
|
**/
|
|
|
|
#ifndef __PAGER_H__
|
|
#define __PAGER_H__
|
|
|
|
#pragma once
|
|
|
|
#ifndef _UNICODE
|
|
#error The ConUtils library at the moment only supports compilation with _UNICODE defined!
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
// #include <wincon.h>
|
|
|
|
struct _CON_PAGER;
|
|
|
|
typedef BOOL
|
|
(__stdcall *CON_PAGER_LINE_FN)(
|
|
IN OUT struct _CON_PAGER *Pager,
|
|
IN PCTCH line,
|
|
IN DWORD cch);
|
|
|
|
/* Flags for CON_PAGER */
|
|
#define CON_PAGER_DONT_OUTPUT (1 << 0)
|
|
#define CON_PAGER_EXPAND_TABS (1 << 1)
|
|
#define CON_PAGER_EXPAND_FF (1 << 2)
|
|
|
|
typedef struct _CON_PAGER
|
|
{
|
|
/* Console screen properties */
|
|
PCON_SCREEN Screen;
|
|
DWORD PageColumns;
|
|
DWORD PageRows;
|
|
|
|
/* Paging parameters */
|
|
CON_PAGER_LINE_FN PagerLine; /* The line function */
|
|
DWORD dwFlags; /* The CON_PAGER_... flags */
|
|
LONG nTabWidth;
|
|
DWORD ScrollRows;
|
|
|
|
/* Data buffer */
|
|
PCTCH TextBuff; /* The text buffer */
|
|
DWORD cch; /* The total number of characters */
|
|
|
|
/* Paging state */
|
|
DWORD ich; /* The current index of character */
|
|
DWORD nSpacePending; /* Pending spaces for TAB expansion */
|
|
DWORD iColumn; /* The current index of column */
|
|
DWORD iLine; /* The physical output line count of screen */
|
|
DWORD lineno; /* The logical line number */
|
|
} CON_PAGER, *PCON_PAGER;
|
|
|
|
#define INIT_CON_PAGER(pScreen) {(pScreen), 0}
|
|
|
|
#define InitializeConPager(pPager, pScreen) \
|
|
do { \
|
|
ZeroMemory((pPager), sizeof(*(pPager))); \
|
|
(pPager)->Screen = (pScreen); \
|
|
} while (0)
|
|
|
|
|
|
typedef BOOL
|
|
(__stdcall *PAGE_PROMPT)(
|
|
IN PCON_PAGER Pager,
|
|
IN DWORD Done,
|
|
IN DWORD Total);
|
|
|
|
BOOL
|
|
ConWritePaging(
|
|
IN PCON_PAGER Pager,
|
|
IN PAGE_PROMPT PagePrompt,
|
|
IN BOOL StartPaging,
|
|
IN PCTCH szStr,
|
|
IN DWORD len);
|
|
|
|
BOOL
|
|
ConPutsPaging(
|
|
IN PCON_PAGER Pager,
|
|
IN PAGE_PROMPT PagePrompt,
|
|
IN BOOL StartPaging,
|
|
IN PCTSTR szStr);
|
|
|
|
BOOL
|
|
ConResPagingEx(
|
|
IN PCON_PAGER Pager,
|
|
IN PAGE_PROMPT PagePrompt,
|
|
IN BOOL StartPaging,
|
|
IN HINSTANCE hInstance OPTIONAL,
|
|
IN UINT uID);
|
|
|
|
BOOL
|
|
ConResPaging(
|
|
IN PCON_PAGER Pager,
|
|
IN PAGE_PROMPT PagePrompt,
|
|
IN BOOL StartPaging,
|
|
IN UINT uID);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __PAGER_H__ */
|
|
|
|
/* EOF */
|