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	INIT_CON_PAGER(pScreen)   {(pScreen), 0}
#define	InitializeConPager(pPager, pScreen)

Typedefs
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
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

INIT_CON_PAGER

#define INIT_CON_PAGER

(

pScreen

)

{(pScreen), 0}

Definition at line 44 of file pager.h.

InitializeConPager

#define InitializeConPager	(		pPager,
			pScreen
	)

Value:

do { \
    (pPager)->Screen = (pScreen);   \
    (pPager)->LineCount = 0;        \
} while (0)

Definition at line 46 of file pager.h.

Typedef Documentation

CON_PAGER

typedef struct _CON_PAGER CON_PAGER

PAGE_PROMPT

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

Definition at line 53 of file pager.h.

PCON_PAGER

typedef struct _CON_PAGER * PCON_PAGER

Function Documentation

ConPutsPaging()

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

Definition at line 120 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);
}

Referenced by wmain().

ConResPaging()

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

Definition at line 155 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 137 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 38 of file pager.c.

{
    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;
}

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