progress.h File Reference

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

Go to the source code of this file.

Classes
struct	_PROGRESSBAR

Typedefs
typedef IN BOOLEAN	AlwaysUpdate
typedef IN BOOLEAN OUT PSTR	Buffer = Buffer
typedef IN BOOLEAN OUT PSTR IN SIZE_T	cchBufferSize
typedef struct _PROGRESSBAR	PROGRESSBAR
typedef struct _PROGRESSBAR *	PPROGRESSBAR

Functions
typedef	BOOLEAN (NTAPI *PUPDATE_PROGRESS)(IN struct _PROGRESSBAR *Bar
PPROGRESSBAR	CreateProgressBarEx (IN SHORT Left, IN SHORT Top, IN SHORT Right, IN SHORT Bottom, IN SHORT TextTop, IN SHORT TextRight, IN BOOLEAN DoubleEdge, IN SHORT ProgressColour, IN ULONG StepCount, IN PCSTR DescriptionText OPTIONAL, IN PCSTR ProgressFormatText OPTIONAL, IN PUPDATE_PROGRESS UpdateProgressProc OPTIONAL)
PPROGRESSBAR	CreateProgressBar (IN SHORT Left, IN SHORT Top, IN SHORT Right, IN SHORT Bottom, IN SHORT TextTop, IN SHORT TextRight, IN BOOLEAN DoubleEdge, IN PCSTR DescriptionText OPTIONAL)
VOID	DestroyProgressBar (IN OUT PPROGRESSBAR Bar)
VOID	ProgressSetStepCount (IN PPROGRESSBAR Bar, IN ULONG StepCount)
VOID	ProgressNextStep (IN PPROGRESSBAR Bar)
VOID	ProgressSetStep (IN PPROGRESSBAR Bar, IN ULONG Step)

Typedef Documentation

AlwaysUpdate

typedef IN BOOLEAN AlwaysUpdate

Definition at line 34 of file progress.h.

Buffer

_Must_inspect_result_ _In_ WDFREQUEST _In_ size_t _Outptr_result_bytebuffer_ Length PVOID * Buffer = Buffer

Definition at line 34 of file progress.h.

cchBufferSize

typedef IN BOOLEAN OUT PSTR IN SIZE_T cchBufferSize

Definition at line 34 of file progress.h.

PPROGRESSBAR

typedef struct _PROGRESSBAR * PPROGRESSBAR

PROGRESSBAR

typedef struct _PROGRESSBAR PROGRESSBAR

Function Documentation

BOOLEAN()

typedef BOOLEAN

(

NTAPI *

PUPDATE_PROGRESS

)

CreateProgressBar()

PPROGRESSBAR CreateProgressBar	(	IN SHORT	Left,
		IN SHORT	Top,
		IN SHORT	Right,
		IN SHORT	Bottom,
		IN SHORT	TextTop,
		IN SHORT	TextRight,
		IN BOOLEAN	DoubleEdge,
		IN PCSTR DescriptionText	OPTIONAL
	)

Definition at line 317 of file progress.c.

{
    /* Call the Ex variant of the function */
    return CreateProgressBarEx(Left, Top, Right, Bottom,
                               TextTop, TextRight,
                               DoubleEdge,
                               FOREGROUND_YELLOW | BACKGROUND_BLUE,
                               0,
                               DescriptionText,
                               "%-3lu%%",
                               UpdateProgressPercentage);
}

Referenced by DoChkdsk(), DoFormat(), and FileCopyPage().

CreateProgressBarEx()

PPROGRESSBAR CreateProgressBarEx	(	IN SHORT	Left,
		IN SHORT	Top,
		IN SHORT	Right,
		IN SHORT	Bottom,
		IN SHORT	TextTop,
		IN SHORT	TextRight,
		IN BOOLEAN	DoubleEdge,
		IN SHORT	ProgressColour,
		IN ULONG	StepCount,
		IN PCSTR DescriptionText	OPTIONAL,
		IN PCSTR ProgressFormatText	OPTIONAL,
		IN PUPDATE_PROGRESS UpdateProgressProc	OPTIONAL
	)

Definition at line 272 of file progress.c.

{
    PPROGRESSBAR Bar;

    Bar = (PPROGRESSBAR)RtlAllocateHeap(ProcessHeap,
                                        0,
                                        sizeof(PROGRESSBAR));
    if (Bar == NULL)
        return NULL;

    Bar->Left = Left;
    Bar->Top = Top;
    Bar->Right = Right;
    Bar->Bottom = Bottom;
    Bar->TextTop = TextTop;
    Bar->TextRight = TextRight;

    Bar->Width = Bar->Right - Bar->Left + 1;

    Bar->DoubleEdge = DoubleEdge;
    Bar->ProgressColour = ProgressColour;
    Bar->DescriptionText = DescriptionText;
    Bar->ProgressFormatText = ProgressFormatText;

    Bar->UpdateProgressProc = UpdateProgressProc;

    /* Reset the progress bar counts and initially draw it */
    ProgressSetStepCount(Bar, StepCount);

    return Bar;
}

Referenced by CreateProgressBar(), and ProgressCountdown().

DestroyProgressBar()

VOID DestroyProgressBar

(

IN OUT PPROGRESSBAR

Bar

)

Definition at line 339 of file progress.c.

{
    RtlFreeHeap(ProcessHeap, 0, Bar);
}

Referenced by DoChkdsk(), DoFormat(), FileCopyPage(), and ProgressCountdown().

ProgressNextStep()

VOID ProgressNextStep

(

IN PPROGRESSBAR

Bar

)

Definition at line 361 of file progress.c.

{
    ProgressSetStep(Bar, Bar->CurrentStep + 1);
}

Referenced by FileCopyCallback().

ProgressSetStep()

VOID ProgressSetStep	(	IN PPROGRESSBAR	Bar,
		IN ULONG	Step
	)

Definition at line 368 of file progress.c.

{
    COORD coPos;
    DWORD Written;
    ULONG NewPos;
    CHAR TextBuffer[256];

    if (Step > Bar->StepCount)
        return;

    Bar->CurrentStep = Step;

    /* Update the progress and redraw it if it has changed */
    if (Bar->UpdateProgressProc &&
        Bar->UpdateProgressProc(Bar, FALSE, TextBuffer, ARRAYSIZE(TextBuffer)))
    {
        coPos.X = Bar->Left + (Bar->Width - (USHORT)strlen(TextBuffer) + 1) / 2;
        coPos.Y = Bar->Top;
        WriteConsoleOutputCharacterA(StdOutput,
                                     TextBuffer,
                                     strlen(TextBuffer),
                                     coPos,
                                     &Written);
    }

    /* Calculate the bar position */
    NewPos = (((Bar->Width - 2) * 2 * Bar->CurrentStep + (Bar->StepCount / 2)) / Bar->StepCount);

    /* Redraw the bar if it has changed */
    if (Bar->Pos != NewPos)
    {
        Bar->Pos = NewPos;

        for (coPos.Y = Bar->Top + 2; coPos.Y <= Bar->Bottom - 1; coPos.Y++)
        {
            coPos.X = Bar->Left + 1;
            FillConsoleOutputCharacterA(StdOutput,
                                        CharBlock,
                                        Bar->Pos / 2,
                                        coPos,
                                        &Written);
            coPos.X += Bar->Pos / 2;

            if (NewPos & 1)
            {
                FillConsoleOutputCharacterA(StdOutput,
                                            CharHalfBlock,
                                            1,
                                            coPos,
                                            &Written);
                coPos.X++;
            }

            if (coPos.X <= Bar->Right - 1)
            {
                FillConsoleOutputCharacterA(StdOutput,
                                            ' ',
                                            Bar->Right - coPos.X,
                                            coPos,
                                            &Written);
            }
        }
    }
}

Referenced by FormatCallback(), ProgressCountdown(), ProgressNextStep(), and SetupUpdateMemoryInfo().

ProgressSetStepCount()

VOID ProgressSetStepCount	(	IN PPROGRESSBAR	Bar,
		IN ULONG	StepCount
	)

Definition at line 347 of file progress.c.

{
    Bar->CurrentStep = 0;
    Bar->StepCount = StepCount;

    Bar->Progress = 0;
    Bar->Pos = 0;

    DrawProgressBar(Bar);
}

Referenced by CreateProgressBarEx(), DoChkdsk(), DoFormat(), FileCopyCallback(), ProgressCountdown(), and SetupUpdateMemoryInfo().