#include <tsReportFile.h>

Inheritance diagram for ts::ReportFile< SAFETY >:

Collaboration diagram for ts::ReportFile< SAFETY >:

Public Types
using	MutexType = typename ThreadSafetyMutex<SAFETY>::type

Public Member Functions
	ReportFile (const fs::path &file_name, bool append=false, int max_severity=Severity::Info)
	ReportFile (std::ostream &stream, int max_severity=0)
bool	debug () const
template<class... Args>
void	debug (const UChar *fmt, Args &&... args)
void	debug (const UChar *msg)
template<class... Args>
void	debug (const UString &fmt, Args &&... args)
void	debug (const UString &msg)
Report *	delegateReport (Report *report)
template<class... Args>
void	error (const UChar *fmt, Args &&... args)
void	error (const UChar *msg)
template<class... Args>
void	error (const UString &fmt, Args &&... args)
void	error (const UString &msg)
template<class... Args>
void	fatal (const UChar *fmt, Args &&... args)
void	fatal (const UChar *msg)
template<class... Args>
void	fatal (const UString &fmt, Args &&... args)
void	fatal (const UString &msg)
bool	gotErrors () const
template<class... Args>
void	info (const UChar *fmt, Args &&... args)
void	info (const UChar *msg)
template<class... Args>
void	info (const UString &fmt, Args &&... args)
void	info (const UString &msg)
template<class... Args>
void	log (int severity, const UChar *fmt, Args &&... args)
template<class... Args>
void	log (int severity, const UString &fmt, Args &&... args)
void	log (int severity, const UString &msg)
int	maxSeverity () const
void	raiseMaxSeverity (int level)
UString	reportPrefix () const
void	resetErrors ()
void	setMaxSeverity (int level)
void	setReportPrefix (const UString &prefix)
template<class... Args>
void	severe (const UChar *fmt, Args &&... args)
void	severe (const UChar *msg)
template<class... Args>
void	severe (const UString &fmt, Args &&... args)
void	severe (const UString &msg)
bool	verbose () const
template<class... Args>
void	verbose (const UChar *fmt, Args &&... args)
void	verbose (const UChar *msg)
template<class... Args>
void	verbose (const UString &fmt, Args &&... args)
void	verbose (const UString &msg)
template<class... Args>
void	warning (const UChar *fmt, Args &&... args)
void	warning (const UChar *msg)
template<class... Args>
void	warning (const UString &fmt, Args &&... args)
void	warning (const UString &msg)

Protected Member Functions
virtual void	writeLog (int severity, const UString &message) override

Detailed Description

template<ThreadSafety SAFETY = ThreadSafety::None>
class ts::ReportFile< SAFETY >

A subclass of ts::Report which outputs messages in a text file.

Reentrancy is supported though the template parameter SAFETY.

Template Parameters

SAFETY The required type of thread-safety. None by default.

Member Typedef Documentation

◆ MutexType

template<ThreadSafety SAFETY = ThreadSafety::None>

using ts::ReportFile< SAFETY >::MutexType = typename ThreadSafetyMutex<SAFETY>::type

Generic definition of the mutex for this class.

Constructor & Destructor Documentation

◆ ReportFile() [1/2]

template<ts::ThreadSafety SAFETY>

ts::ReportFile< SAFETY >::ReportFile	(	const fs::path &	file_name,
		bool	append = false,
		int	max_severity = Severity::Info )

Constructor using a named file.

Parameters

[in]	file_name	The name of the file to create. If the file creation fails, a fatal error is generated with an error message on std::cerr. The file will be closed when this object is destroyed.
[in]	append	If true, append the messages at the end of the file. If false (the default), overwrite the file if it already existed.
[in]	max_severity	Maximum debug level to display. None by default.

◆ ReportFile() [2/2]

template<ts::ThreadSafety SAFETY>

ts::ReportFile< SAFETY >::ReportFile	(	std::ostream &	stream,
		int	max_severity = 0 )

Constructor using an open file stream.

Parameters

[in,out]	stream	A reference to an open output file stream to log the messages. The corresponding stream object must remain valid as long as this object exists. Typical valid values are std::cout and std::cerr.
[in]	max_severity	Maximum debug level to display. None by default.

Member Function Documentation

◆ writeLog()

template<ts::ThreadSafety SAFETY>

void ts::ReportFile< SAFETY >::writeLog	(	int	severity,
		const UString &	msg )

overrideprotectedvirtual

Actual message reporting method. The method is called only when a message passed the severity filter. It is not necessary to recheck the maximum severity inside the method. By default, does nothing.

Parameters

[in]	severity	Message severity.
[in]	msg	Message text.

Reimplemented from ts::Report.

◆ setMaxSeverity()

void ts::Report::setMaxSeverity ( int level )

inherited

Set maximum severity level. Messages with higher severities are not reported.

Parameters

[in] level Set report to that level.

◆ raiseMaxSeverity()

void ts::Report::raiseMaxSeverity ( int level )

inherited

Raise maximum severity level. The severity can only be increased (more verbose, more debug), never decreased.

Parameters

[in] level Set report at least to that level.

◆ maxSeverity()

int ts::Report::maxSeverity ( ) const

inlineinherited

Get maximum severity level.

Returns: Current maximum debug level.

◆ gotErrors()

bool ts::Report::gotErrors ( ) const

inlineinherited

Check if errors (or worse) were reported through this object. Errors which were reported through delegated reports are ignored.

Returns: True if errors (or worse) were reported through this object.

◆ resetErrors()

void ts::Report::resetErrors ( )

inlineinherited

Reset the error indicator.

See also: gotErrors()

◆ setReportPrefix()

void ts::Report::setReportPrefix ( const UString & prefix )

inlineinherited

Set the prefix to display before each message.

Parameters

[in] prefix The prefix to prepend to all messages.

◆ reportPrefix()

UString ts::Report::reportPrefix ( ) const

inlineinherited

Get the current prefix to display.

Returns: The current prefix to display.

◆ delegateReport()

Report * ts::Report::delegateReport ( Report * report )

inherited

Delegate message logging to another report object.

Parameters

[in] report New report object to which messages are delegated. Use nullptr to remove the delegation and return to normal logging.

Returns: Previous delegate report, return a null pointer if there was no previous delegate.

◆ debug() [1/5]

bool ts::Report::debug ( ) const

inlineinherited

Check if debugging is active.

Returns: True if current reporting level is Debug or higher.

◆ debug() [2/5]

void ts::Report::debug ( const UChar * msg )

inlineinherited

Report a debug message.

Parameters

[in] msg Message line.

◆ debug() [3/5]

void ts::Report::debug ( const UString & msg )

inlineinherited

Report a debug message.

Parameters

[in] msg Message line.

◆ debug() [4/5]

template<class... Args>

void ts::Report::debug	(	const UChar *	fmt,
		Args &&...	args )

inlineinherited

Report a debug message with a printf-like interface.

Parameters

[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ debug() [5/5]

template<class... Args>

void ts::Report::debug	(	const UString &	fmt,
		Args &&...	args )

inlineinherited

Report a debug message with a printf-like interface.

Parameters

[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ verbose() [1/5]

bool ts::Report::verbose ( ) const

inlineinherited

Check if verbose reporting is active.

Returns: True if current reporting level is Verbose or higher.

◆ verbose() [2/5]

void ts::Report::verbose ( const UChar * msg )

inlineinherited

Report a verbose message.

Parameters

[in] msg Message line.

◆ verbose() [3/5]

void ts::Report::verbose ( const UString & msg )

inlineinherited

Report a verbose message.

Parameters

[in] msg Message line.

◆ verbose() [4/5]

template<class... Args>

void ts::Report::verbose	(	const UChar *	fmt,
		Args &&...	args )

inlineinherited

Report a verbose message with a printf-like interface.

Parameters

[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ verbose() [5/5]

template<class... Args>

void ts::Report::verbose	(	const UString &	fmt,
		Args &&...	args )

inlineinherited

Report a verbose message with a printf-like interface.

Parameters

[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ log() [1/3]

void ts::Report::log	(	int	severity,
		const UString &	msg )

inherited

Report a message with an explicit severity.

Parameters

[in]	severity	Message severity.
[in]	msg	Message line.

◆ log() [2/3]

template<class... Args>

void ts::Report::log	(	int	severity,
		const UChar *	fmt,
		Args &&...	args )

inlineinherited

Report a message with an explicit severity and a printf-like interface.

Parameters

[in]	severity	Message severity.
[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ log() [3/3]

template<class... Args>

void ts::Report::log	(	int	severity,
		const UString &	fmt,
		Args &&...	args )

inlineinherited

Report a message with an explicit severity and a printf-like interface.

Parameters

[in]	severity	Message severity.
[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ fatal() [1/4]

void ts::Report::fatal ( const UChar * msg )

inlineinherited

Report a fatal error message.

Parameters

[in] msg Message line.

◆ fatal() [2/4]

void ts::Report::fatal ( const UString & msg )

inlineinherited

Report a fatal error message.

Parameters

[in] msg Message line.

◆ fatal() [3/4]

template<class... Args>

void ts::Report::fatal	(	const UChar *	fmt,
		Args &&...	args )

inlineinherited

Report a fatal error message with a printf-like interface.

Parameters

[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ fatal() [4/4]

template<class... Args>

void ts::Report::fatal	(	const UString &	fmt,
		Args &&...	args )

inlineinherited

Report a fatal error message with a printf-like interface.

Parameters

[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ severe() [1/4]

void ts::Report::severe ( const UChar * msg )

inlineinherited

Report a severe error message.

Parameters

[in] msg Message line.

◆ severe() [2/4]

void ts::Report::severe ( const UString & msg )

inlineinherited

Report a severe error message.

Parameters

[in] msg Message line.

◆ severe() [3/4]

template<class... Args>

void ts::Report::severe	(	const UChar *	fmt,
		Args &&...	args )

inlineinherited

Report a severe error message with a printf-like interface.

Parameters

[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ severe() [4/4]

template<class... Args>

void ts::Report::severe	(	const UString &	fmt,
		Args &&...	args )

inlineinherited

Report a severe error message with a printf-like interface.

Parameters

[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ error() [1/4]

void ts::Report::error ( const UChar * msg )

inlineinherited

Report an error message.

Parameters

[in] msg Message line.

◆ error() [2/4]

void ts::Report::error ( const UString & msg )

inlineinherited

Report an error message.

Parameters

[in] msg Message line.

◆ error() [3/4]

template<class... Args>

void ts::Report::error	(	const UChar *	fmt,
		Args &&...	args )

inlineinherited

Report an error message with a printf-like interface.

Parameters

[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ error() [4/4]

template<class... Args>

void ts::Report::error	(	const UString &	fmt,
		Args &&...	args )

inlineinherited

Report an error message with a printf-like interface.

Parameters

[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ warning() [1/4]

void ts::Report::warning ( const UChar * msg )

inlineinherited

Report a warning error message.

Parameters

[in] msg Message line.

◆ warning() [2/4]

void ts::Report::warning ( const UString & msg )

inlineinherited

Report a warning error message.

Parameters

[in] msg Message line.

◆ warning() [3/4]

template<class... Args>

void ts::Report::warning	(	const UChar *	fmt,
		Args &&...	args )

inlineinherited

Report a warning message with a printf-like interface.

Parameters

[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ warning() [4/4]

template<class... Args>

void ts::Report::warning	(	const UString &	fmt,
		Args &&...	args )

inlineinherited

Report a warning message with a printf-like interface.

Parameters

[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ info() [1/4]

void ts::Report::info ( const UChar * msg )

inlineinherited

Report an informational message.

Parameters

[in] msg Message line.

◆ info() [2/4]

void ts::Report::info ( const UString & msg )

inlineinherited

Report an informational message.

Parameters

[in] msg Message line.

◆ info() [3/4]

template<class... Args>

void ts::Report::info	(	const UChar *	fmt,
		Args &&...	args )

inlineinherited

Report an informational message with a printf-like interface.

Parameters

[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ info() [4/4]

template<class... Args>

void ts::Report::info	(	const UString &	fmt,
		Args &&...	args )

inlineinherited

Report an informational message with a printf-like interface.

Parameters

[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

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

tsReportFile.h

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ MutexType

Constructor & Destructor Documentation

◆ ReportFile() [1/2]

◆ ReportFile() [2/2]

Member Function Documentation

◆ writeLog()

◆ setMaxSeverity()

◆ raiseMaxSeverity()

◆ maxSeverity()

◆ gotErrors()

◆ resetErrors()

◆ setReportPrefix()

◆ reportPrefix()

◆ delegateReport()

◆ debug() [1/5]

◆ debug() [2/5]

◆ debug() [3/5]

◆ debug() [4/5]

◆ debug() [5/5]

◆ verbose() [1/5]

◆ verbose() [2/5]

◆ verbose() [3/5]

◆ verbose() [4/5]

◆ verbose() [5/5]

◆ log() [1/3]

◆ log() [2/3]

◆ log() [3/3]

◆ fatal() [1/4]

◆ fatal() [2/4]

◆ fatal() [3/4]

◆ fatal() [4/4]

◆ severe() [1/4]

◆ severe() [2/4]

◆ severe() [3/4]

◆ severe() [4/4]

◆ error() [1/4]

◆ error() [2/4]

◆ error() [3/4]

◆ error() [4/4]

◆ warning() [1/4]

◆ warning() [2/4]

◆ warning() [3/4]

◆ warning() [4/4]

◆ info() [1/4]

◆ info() [2/4]

◆ info() [3/4]

◆ info() [4/4]