`template struct diagnostic<Level,Id> generically encapsulates a type of diagnostic. More...

#include <diagnostic.h>

Inheritance diagram for diagnostic< Level, Id >:

Public Types
using	base = cloner< diagnostic_base, diagnostic< Level, Id >>
	Base class.

Public Types inherited from diagnostic_base
using	ptr = std::shared_ptr< diagnostic_base >
	Type of pointer to `diagnostic_base`

Public Member Functions
	diagnostic (std::string const &severity_name)
	Explicitly construct given a severity name. More...

severity	level () const
	Get the severity level of this diagnostic.

unsigned	id () const
	Get the causal identifier of this diagnostic.

Public Member Functions inherited from cloner< diagnostic_base, diagnostic< Level, Id > >
diagnostic_base *	clone () const override
	Clone the base `B` object on the heap.

	cloner (Args...args)
	All purpose constructor.

Public Member Functions inherited from diagnostic_base
	diagnostic_base (std::string const &severity_name, severity level, unsigned id, bool in_code_only=false)
	Constructor. More...

	diagnostic_base (diagnostic_base const &src)
	Copy constructor.

void	queue () const
	Globally enqueue a copy of this `diagnostic_base` for deferred action.

unsigned	encode () const
	Get the reason-code of the diagnostic. More...

	operator unsigned () const
	Explicitly cast the object to its reason-code.

bool	gagged () const
	Say whether this diagnostic is suppressed.

std::string	text () const
	Get the text of the diagnostic.

	operator std::string () const
	Explicitly cast the object to its textual representation.

template<typename T >
diagnostic_base &	operator<< (T const &obj)
	Insert an arbitrary object into the diagnostic. More...

diagnostic_base &	operator<< (defer)
	Queue the diagnostic for deferred action. More...

diagnostic_base &	operator<< (emit)
	Emit the diagnostic. More...

Static Public Member Functions
static unsigned	code ()
	Get the reason-code of this diagnostic's type.

static size_t	discard ()
	Forget all queued diagnostics of this type.

static size_t	flush ()
	Emit all deferred diagnostics of this type.

Static Public Member Functions inherited from diagnostic_base
static size_t	deferred ()
	Count the diagnostics enqueued for deferred action.

static size_t	discard (unsigned reason)
	Discard any queued diagnostics that match a reason-code, returning the number discarded. More...

static size_t	discard (severity level)
	Discard any queued diagnostics that match a severity, returning the number discarded. More...

static void	discard_all ()
	Discard all queued diagnostics.

static size_t	flush (unsigned reason)
	Emit all queued diagnostics that match a reason-code.

static size_t	flush (severity level)
	Emit all queued diagnostics that match a severity.

static void	flush_all ()
	Emit any queued diagnostics.

static void	epilogue ()
	Write summary diagnostics on `cerr` at exit. More...

static int	exitcode ()
	Convert the internal exit status to an exit code for `exit()`. More...

Static Public Attributes
static const severity	_severity_ = Level
	The severity level of this diagnostic type.

static const unsigned	_id_ = Id
	The causal identifier of this diagnostic type.

Additional Inherited Members
Protected Member Functions inherited from diagnostic_base
virtual void	count () const
	Increment global counts appropriately for the runtime type.

void	despatch () const throw (unsigned)
	Emit the diagnostic.

Static Protected Member Functions inherited from diagnostic_base
static unsigned	code (severity level, unsigned id)
	Get the reason-code that encodes a causal identifier and severity. More...

Protected Attributes inherited from diagnostic_base
bool	_gagged
	Is the diagnostic suppressed?

std::stringstream	_text
	The text of the diagnostic.

Static Protected Attributes inherited from diagnostic_base
static std::list< ptr >	_queue_
	Queue of deferred diagnostics. More...

static unsigned	_infos_
	Global count of informational diagnostics.

static unsigned	_warnings_
	Global count of warning diagnostics.

static unsigned	_errors_
	Global count of error diagnostics.

static unsigned	_abends_
	Global count of fatal error diagnostics.

static unsigned	_error_directives_generated_
	Global count of `error` directives output.

static unsigned	_error_directives_operative_
	Global count of operative `error` directives output.

Detailed Description

`template struct diagnostic<Level,Id> generically encapsulates a type of diagnostic.

Template Parameters

Level	The severity of the diagnostic type.
Id	The causal identifier of diagnostic type.

Definition at line 386 of file diagnostic.h.

Constructor & Destructor Documentation

template<severity Level, unsigned Id>

diagnostic< Level, Id >::diagnostic ( std::string const & severity_name )

inlineexplicit

Explicitly construct given a severity name.

Parameters

severity_name Severity name of the diagnostic to be constructed.

Definition at line 401 of file diagnostic.h.

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