pager.h File Reference

Console/terminal paging functionality. More...

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

Go to the source code of this file.

Classes
struct	_CON_PAGER

Macros
#define	CON_PAGER_EXPAND_TABS   (1 << 0)
#define	CON_PAGER_EXPAND_FF   (1 << 1)
#define	CON_PAGER_CACHE_INCOMPLETE_LINE   (1 << 2)
#define	INIT_CON_PAGER(pScreen)   {(pScreen), 0}
#define	InitializeConPager(pPager, pScreen)

Typedefs
typedef IN PCTCH	line
typedef IN PCTCH IN DWORD	cch
typedef struct _CON_PAGER	CON_PAGER
typedef struct _CON_PAGER *	PCON_PAGER
typedef BOOL(__stdcall *	PAGE_PROMPT) (IN PCON_PAGER Pager, IN DWORD Done, IN DWORD Total)

Functions
typedef	BOOL (__stdcall *CON_PAGER_LINE_FN)(IN OUT struct _CON_PAGER *Pager
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)

Detailed Description

Console/terminal paging functionality.

Definition in file pager.h.

Macro Definition Documentation

CON_PAGER_CACHE_INCOMPLETE_LINE

#define CON_PAGER_CACHE_INCOMPLETE_LINE   (1 << 2)

Definition at line 43 of file pager.h.

CON_PAGER_EXPAND_FF

#define CON_PAGER_EXPAND_FF   (1 << 1)

Definition at line 41 of file pager.h.

CON_PAGER_EXPAND_TABS

#define CON_PAGER_EXPAND_TABS   (1 << 0)

Definition at line 40 of file pager.h.

INIT_CON_PAGER

#define INIT_CON_PAGER

(

pScreen

)

{(pScreen), 0}

Definition at line 73 of file pager.h.

InitializeConPager

#define InitializeConPager	(		pPager,
			pScreen
	)

Value:

do { \
    ZeroMemory((pPager), sizeof(*(pPager))); \
    (pPager)->Screen = (pScreen);            \
} while (0)

Definition at line 75 of file pager.h.

Typedef Documentation

cch

_In_ UINT _In_ UINT cch

Definition at line 36 of file pager.h.

CON_PAGER

typedef struct _CON_PAGER CON_PAGER

line

typedef IN PCTCH line

Definition at line 36 of file pager.h.

PAGE_PROMPT

typedef BOOL(__stdcall * PAGE_PROMPT) (IN PCON_PAGER Pager, IN DWORD Done, IN DWORD Total)

Definition at line 83 of file pager.h.

PCON_PAGER

typedef struct _CON_PAGER * PCON_PAGER

Function Documentation

BOOL()

typedef BOOL

(

__stdcall *

CON_PAGER_LINE_FN

)

ConPutsPaging()

BOOL ConPutsPaging	(	IN PCON_PAGER	Pager,
		IN PAGE_PROMPT	PagePrompt,
		IN BOOL	StartPaging,
		IN PCTSTR	szStr
	)

Definition at line 646 of file pager.c.

{
    DWORD len;

    /* Return if no string has been given */
    if (szStr == NULL)
        return TRUE;

    len = wcslen(szStr);
    return ConWritePaging(Pager, PagePrompt, StartPaging, szStr, len);
}

ConResPaging()

BOOL ConResPaging	(	IN PCON_PAGER	Pager,
		IN PAGE_PROMPT	PagePrompt,
		IN BOOL	StartPaging,
		IN UINT	uID
	)

Definition at line 681 of file pager.c.

{
    return ConResPagingEx(Pager, PagePrompt, StartPaging,
                          NULL /*GetModuleHandleW(NULL)*/, uID);
}

Referenced by ConOutResPaging().

ConResPagingEx()

BOOL ConResPagingEx	(	IN PCON_PAGER	Pager,
		IN PAGE_PROMPT	PagePrompt,
		IN BOOL	StartPaging,
		IN HINSTANCE hInstance	OPTIONAL,
		IN UINT	uID
	)

Definition at line 663 of file pager.c.

{
    INT Len;
    PCWSTR szStr = NULL;

    Len = K32LoadStringW(hInstance, uID, (PWSTR)&szStr, 0);
    if (szStr && Len)
        return ConWritePaging(Pager, PagePrompt, StartPaging, szStr, Len);
    else
        return TRUE;
}

Referenced by ConResPaging().

ConWritePaging()

BOOL ConWritePaging	(	IN PCON_PAGER	Pager,
		IN PAGE_PROMPT	PagePrompt,
		IN BOOL	StartPaging,
		IN PCTCH	szStr,
		IN DWORD	len
	)

Definition at line 549 of file pager.c.

{
    CONSOLE_SCREEN_BUFFER_INFO csbi;
    BOOL bIsConsole;

    /* Parameters validation */
    if (!Pager)
        return FALSE;

    /* Get the size of the visual screen that can be printed to */
    bIsConsole = ConGetScreenInfo(Pager->Screen, &csbi);
    if (bIsConsole)
    {
        /* Calculate the console screen extent */
        Pager->PageColumns = csbi.dwSize.X;
        Pager->PageRows = csbi.srWindow.Bottom - csbi.srWindow.Top + 1;
    }
    else
    {
        /* We assume it's a file handle */
        Pager->PageColumns = 0;
        Pager->PageRows = 0;
    }

    if (StartPaging)
    {
        if (bIsConsole && (Pager->PageRows >= 2))
        {
            /* Reset to display one page by default */
            Pager->ScrollRows = Pager->PageRows - 1;
        }
        else
        {
            /* File output, or single line: all lines are displayed at once; reset to a default value */
            Pager->ScrollRows = 0;
        }

        /* Reset the internal data buffer */
        Pager->CachedLine = NULL;
        Pager->cchCachedLine = 0;

        /* Reset the paging state */
        Pager->CurrentLine = NULL;
        Pager->ichCurr = 0;
        Pager->iEndLine = 0;
        Pager->nSpacePending = 0;
        Pager->iColumn = 0;
        Pager->iLine = 0;
        Pager->lineno = 0;
    }

    /* Reset the reading index in the user-provided source buffer */
    Pager->ich = 0;

    /* Run the pager even when the user-provided source buffer is
     * empty, in case we need to flush any remaining cached line. */
    if (!Pager->CachedLine)
    {
        /* No cached line, bail out now */
        if (len == 0 || szStr == NULL)
            return TRUE;
    }

    while (ConPagerWorker(Pager, szStr, len))
    {
        /* Prompt the user only when we display to a console and the screen
         * is not too small: at least one line for the actual paged text and
         * one line for the prompt. */
        if (bIsConsole && (Pager->PageRows >= 2))
        {
            /* Reset to display one page by default */
            Pager->ScrollRows = Pager->PageRows - 1;

            /* Prompt the user; give him some values for statistics */
            // FIXME: Doesn't reflect what's currently being displayed.
            if (!PagePrompt(Pager, Pager->ich, len))
                return FALSE;
        }

        /* If we display to a console, recalculate its screen extent
         * in case the user has redimensioned it during the prompt. */
        if (bIsConsole && ConGetScreenInfo(Pager->Screen, &csbi))
        {
            Pager->PageColumns = csbi.dwSize.X;
            Pager->PageRows = csbi.srWindow.Bottom - csbi.srWindow.Top + 1;
        }
    }

    return TRUE;
}

Referenced by ConPrintfVPaging(), ConPutsPaging(), ConResPagingEx(), and wmain().