#include <ui_message.h>

Inheritance diagram for ui_message_handlert:

Collaboration diagram for ui_message_handlert:

Public Types
enum class	uit { PLAIN , XML_UI , JSON_UI }

Public Member Functions
	ui_message_handlert (const class cmdlinet &, const std::string &program)

	ui_message_handlert (message_handlert &)

	ui_message_handlert (ui_message_handlert &&)=default

virtual	~ui_message_handlert ()

virtual uit	get_ui () const

virtual void	flush (unsigned level) override

virtual json_stream_arrayt &	get_json_stream ()

void	print (unsigned level, const structured_datat &data) override

Public Member Functions inherited from message_handlert
	message_handlert ()

virtual	~message_handlert ()

void	set_verbosity (unsigned _verbosity)

unsigned	get_verbosity () const

std::size_t	get_message_count (unsigned level) const

Static Public Member Functions
static bool	is_sgr_style_command (unsigned c)
	Returns true iff `c` is a Select Graphic Rendition (SGR) parameter value used by messaget for terminal styling – 0..4 (reset/bold/ faint/italic/underline) and 31..36 / 91..96 (foreground colours and their bright variants).

Protected Member Functions
	ui_message_handlert (message_handlert *, uit, const std::string &program, const bool always_flush, timestampert::clockt clock_type)

virtual void	print (unsigned level, const std::string &message) override

virtual void	print (unsigned level, const std::string &message, const source_locationt &location) override

virtual void	print (unsigned level, const xmlt &data) override

virtual void	print (unsigned level, const jsont &data) override

virtual void	xml_ui_msg (const std::string &type, const std::string &msg, const source_locationt &location)

virtual void	json_ui_msg (const std::string &type, const std::string &msg, const source_locationt &location)

virtual void	ui_msg (const std::string &type, const std::string &msg, const source_locationt &location)

const char *	level_string (unsigned level)

std::string	command (unsigned c) const override
	Create an ECMA-48 SGR (Select Graphic Rendition) command.

Protected Attributes
std::unique_ptr< console_message_handlert >	console_message_handler

message_handlert *	message_handler

uit	_ui

const bool	always_flush

std::unique_ptr< const timestampert >	time

std::ostream &	out

std::unique_ptr< json_stream_arrayt >	json_stream

Protected Attributes inherited from message_handlert
unsigned	verbosity

std::vector< std::size_t >	message_count

Detailed Description

Definition at line 21 of file ui_message.h.

Member Enumeration Documentation

◆ uit

enum class ui_message_handlert::uit

strong

Enumerator
PLAIN
XML_UI
JSON_UI

Definition at line 24 of file ui_message.h.

Constructor & Destructor Documentation

◆ ui_message_handlert() [1/4]

ui_message_handlert::ui_message_handlert	(	const class cmdlinet &	cmdline,
		const std::string &	program
	)

Definition at line 66 of file ui_message.cpp.

◆ ui_message_handlert() [2/4]

ui_message_handlert::ui_message_handlert ( message_handlert & message_handler )

explicit

Definition at line 93 of file ui_message.cpp.

◆ ui_message_handlert() [3/4]

ui_message_handlert::ui_message_handlert ( ui_message_handlert && )

default

◆ ~ui_message_handlert()

ui_message_handlert::~ui_message_handlert ( )

virtual

Definition at line 99 of file ui_message.cpp.

◆ ui_message_handlert() [4/4]

ui_message_handlert::ui_message_handlert	(	message_handlert *	_message_handler,
		uit	__ui,
		const std::string &	program,
		const bool	always_flush,
		timestampert::clockt	clock_type
	)

protected

Definition at line 23 of file ui_message.cpp.

Member Function Documentation

◆ command()

std::string ui_message_handlert::command ( unsigned ) const

overrideprotectedvirtual

Create an ECMA-48 SGR (Select Graphic Rendition) command.

The default behavior is no action.

Reimplemented from message_handlert.

Definition at line 120 of file ui_message.cpp.

◆ flush()

void ui_message_handlert::flush ( unsigned level )

overridevirtual

Implements message_handlert.

Definition at line 356 of file ui_message.cpp.

◆ get_json_stream()

virtual json_stream_arrayt & ui_message_handlert::get_json_stream ( )

inlinevirtual

Definition at line 40 of file ui_message.h.

◆ get_ui()

virtual uit ui_message_handlert::get_ui ( ) const

inlinevirtual

Definition at line 33 of file ui_message.h.

◆ is_sgr_style_command()

bool ui_message_handlert::is_sgr_style_command ( unsigned c )

static

Returns true iff c is a Select Graphic Rendition (SGR) parameter value used by messaget for terminal styling – 0..4 (reset/bold/ faint/italic/underline) and 31..36 / 91..96 (foreground colours and their bright variants).

The values listed here are kept in lock-step with the corresponding messaget::commandt constants in message.h / message.cpp; if a new styling command is added there, it should be added here too so it is suppressed on the structured UIs.

Definition at line 147 of file ui_message.cpp.

◆ json_ui_msg()

void ui_message_handlert::json_ui_msg	(	const std::string &	type,
		const std::string &	msg,
		const source_locationt &	location
	)

protectedvirtual

Definition at line 337 of file ui_message.cpp.

◆ level_string()

const char * ui_message_handlert::level_string ( unsigned level )

protected

Definition at line 174 of file ui_message.cpp.

◆ print() [1/5]

void ui_message_handlert::print	(	unsigned	level,
		const jsont &	data
	)

overrideprotectedvirtual

Implements message_handlert.

Definition at line 239 of file ui_message.cpp.

◆ print() [2/5]

void ui_message_handlert::print	(	unsigned	level,
		const std::string &	message
	)

overrideprotectedvirtual

Implements message_handlert.

Definition at line 184 of file ui_message.cpp.

◆ print() [3/5]

void ui_message_handlert::print	(	unsigned	level,
		const std::string &	message,
		const source_locationt &	location
	)

overrideprotectedvirtual

Reimplemented from message_handlert.

Definition at line 262 of file ui_message.cpp.

◆ print() [4/5]

void ui_message_handlert::print	(	unsigned	level,
		const structured_datat &	data
	)

overridevirtual

Reimplemented from message_handlert.

Definition at line 370 of file ui_message.cpp.

◆ print() [5/5]

void ui_message_handlert::print	(	unsigned	level,
		const xmlt &	data
	)

overrideprotectedvirtual

Implements message_handlert.

Definition at line 217 of file ui_message.cpp.

◆ ui_msg()

void ui_message_handlert::ui_msg	(	const std::string &	type,
		const std::string &	msg,
		const source_locationt &	location
	)

protectedvirtual

Definition at line 295 of file ui_message.cpp.

◆ xml_ui_msg()

void ui_message_handlert::xml_ui_msg	(	const std::string &	type,
		const std::string &	msg,
		const source_locationt &	location
	)

protectedvirtual

Definition at line 315 of file ui_message.cpp.

Member Data Documentation

◆ _ui

uit ui_message_handlert::_ui

protected

Definition at line 50 of file ui_message.h.

◆ always_flush

const bool ui_message_handlert::always_flush

protected

Definition at line 51 of file ui_message.h.

◆ console_message_handler

std::unique_ptr<console_message_handlert> ui_message_handlert::console_message_handler

protected

Definition at line 48 of file ui_message.h.

◆ json_stream

std::unique_ptr<json_stream_arrayt> ui_message_handlert::json_stream

protected

Definition at line 54 of file ui_message.h.

◆ message_handler

message_handlert* ui_message_handlert::message_handler

protected

Definition at line 49 of file ui_message.h.

◆ out

std::ostream& ui_message_handlert::out

protected

Definition at line 53 of file ui_message.h.

◆ time

std::unique_ptr<const timestampert> ui_message_handlert::time

protected

Definition at line 52 of file ui_message.h.

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

/home/runner/work/cbmc/cbmc/src/util/ui_message.h
/home/runner/work/cbmc/cbmc/src/util/ui_message.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ uit

Constructor & Destructor Documentation

◆ ui_message_handlert() [1/4]

◆ ui_message_handlert() [2/4]

◆ ui_message_handlert() [3/4]

◆ ~ui_message_handlert()

◆ ui_message_handlert() [4/4]

Member Function Documentation

◆ command()

◆ flush()

◆ get_json_stream()

◆ get_ui()

◆ is_sgr_style_command()

◆ json_ui_msg()

◆ level_string()

◆ print() [1/5]

◆ print() [2/5]

◆ print() [3/5]

◆ print() [4/5]

◆ print() [5/5]

◆ ui_msg()

◆ xml_ui_msg()

Member Data Documentation

◆ _ui

◆ always_flush

◆ console_message_handler

◆ json_stream

◆ message_handler

◆ out

◆ time