#include <ProgressNCurses.h>

Inheritance diagram for SourceXtractor::ProgressNCurses:

[legend]

Collaboration diagram for SourceXtractor::ProgressNCurses:

[legend]

Classes
class	Dashboard

Public Member Functions
virtual	~ProgressNCurses ()
	ProgressNCurses ()
void	handleMessage (const std::list< ProgressInfo > &info) override
void	handleMessage (const bool &done) override
Public Member Functions inherited from SourceXtractor::ProgressReporter
virtual	~ProgressReporter ()=default
	ProgressReporter ()=default
virtual void	handleMessage (const std::list< ProgressInfo > &message)=0
virtual void	handleMessage (const bool &message)=0
Public Member Functions inherited from SourceXtractor::Observer< std::list< ProgressInfo > >
virtual	~Observer ()=default
Public Member Functions inherited from SourceXtractor::Observer< bool >
virtual	~Observer ()=default

Static Public Member Functions
static bool	isTerminalCapable ()

Protected Attributes
std::unique_ptr< Dashboard >	m_dashboard

Detailed Description

This concrete implementation of ProgressReporter uses a progress bar on the bottom of the terminal to report the progress. std::cerr is used, as std::cout could have been used for the output catalog. It uses a separate thread, and refreshes the content every second. It relies on raw ANSI escape codes, instead of ncurses, to avoid introducing an extra dependency.

See also: https://en.wikipedia.org/wiki/ANSI_escape_code

Definition at line 40 of file ProgressNCurses.h.

Constructor & Destructor Documentation

◆ ~ProgressNCurses()

SourceXtractor::ProgressNCurses::~ProgressNCurses ( )

virtualdefault

◆ ProgressNCurses()

SourceXtractor::ProgressNCurses::ProgressNCurses ( )

Definition at line 887 of file ProgressNCurses.cpp.

References m_dashboard, and SourceXtractor::make_unique().

Here is the call graph for this function:

Member Function Documentation

◆ handleMessage() [1/2]

void SourceXtractor::ProgressNCurses::handleMessage ( const bool & done )

overridevirtual

Give the printing thread a chance to exit.

Implements SourceXtractor::Observer< bool >.

Definition at line 902 of file ProgressNCurses.cpp.

References m_dashboard.

◆ handleMessage() [2/2]

void SourceXtractor::ProgressNCurses::handleMessage ( const std::list< ProgressInfo > & info )

overridevirtual

This class intercepts the first call to update to decide on the size of the bottom block, and start the thread.

Implements SourceXtractor::Observer< std::list< ProgressInfo > >.

Definition at line 897 of file ProgressNCurses.cpp.

References m_dashboard.

◆ isTerminalCapable()

bool SourceXtractor::ProgressNCurses::isTerminalCapable ( )

static

Returns: true if the attached terminal has the required capabilities to render the progress bar

Definition at line 893 of file ProgressNCurses.cpp.

Referenced by SourceXtractor::ProgressReporterFactory::createProgressMediator().

Member Data Documentation

◆ m_dashboard

std::unique_ptr<Dashboard> SourceXtractor::ProgressNCurses::m_dashboard

protected

Definition at line 64 of file ProgressNCurses.h.

Referenced by handleMessage(), handleMessage(), and ProgressNCurses().

The documentation for this class was generated from the following files:

SEMain/SEMain/ProgressNCurses.h
SEMain/src/lib/ProgressNCurses.cpp

Classes

Public Member Functions

Static Public Member Functions

Protected Attributes