Compiler message notification

Compiler message logging and error registration. More...

Collaboration diagram for Compiler message notification:

Data Structures
struct	event_t
	an event handle TODO: make this and segment_t opaque More...
struct	segment_t
	a segment inside an event More...
struct	event_builder_t
	an event builder handles adding additional information to an event More...
struct	notify_rules_t
	a set of rules for filtering notifications More...

Functions
CT_NODISCARD CT_NOTIFY_API logger_t *	logger_new (arena_t *arena)
	create a new logger More...
CT_NODISCARD CT_NOTIFY_API typevec_t *	logger_get_events (const logger_t *logs)
	get the events from the logger More...
CT_NODISCARD CT_NOTIFY_API bool	logger_has_errors (const logger_t *logs, notify_rules_t rules)
	check if the logger has any fatal errors More...
CT_NOTIFY_API void	logger_reset (logger_t *logs)
	reset the loggers messages More...
CT_NODISCARD CT_NOTIFY_API arena_t *	logger_get_arena (const logger_t *logs)
CT_NOTIFY_API event_builder_t	msg_notify (INOUT_NOTNULL logger_t *logs, const diagnostic_t *diagnostic, const node_t *node, STA_FORMAT_STRING const char *fmt,...)
	notify the logger of a new message More...
CT_NOTIFY_API event_builder_t	msg_vnotify (INOUT_NOTNULL logger_t *logs, const diagnostic_t *diagnostic, const node_t *node, const char *fmt, va_list args)
	notify the logger of a new message More...
CT_NOTIFY_API void	msg_append (event_builder_t builder, const node_t *node, STA_FORMAT_STRING const char *fmt,...)
	append additional information to a message More...
CT_NOTIFY_API void	msg_vappend (event_builder_t builder, const node_t *node, const char *fmt, va_list args)
	append additional information to a message More...
CT_NOTIFY_API void	msg_note (event_builder_t builder, STA_FORMAT_STRING const char *fmt,...)
	add a note to an existing message More...
CT_NOTIFY_API void	msg_vnote (event_builder_t builder, const char *fmt, va_list args)
	add a note to an existing message More...
enum	severity_t { eSeverityTotal }
	the default severity of a diagnostic More...
STA_RET_STRING CT_CONSTFN CT_NOTIFY_API const char *	severity_string (severity_t severity)
	get the name of a severity More...

Detailed Description

Compiler message logging and error registration.

Enumeration Type Documentation

severity_t

enum severity_t

the default severity of a diagnostic

Enumerator
eSeverityTotal

Definition at line 17 of file diagnostic.h.

Function Documentation

logger_get_arena()

CT_NODISCARD CT_NOTIFY_API arena_t* logger_get_arena

(

const logger_t *

logs

)

Definition at line 97 of file notify.c.

logger_get_events()

CT_NODISCARD CT_NOTIFY_API typevec_t* logger_get_events

(

const logger_t *

logs

)

get the events from the logger

Parameters

logs	the logger

Returns

the events

Definition at line 36 of file notify.c.

logger_has_errors()

CT_NODISCARD CT_NOTIFY_API bool logger_has_errors	(	const logger_t *	logs,
		notify_rules_t	rules
	)

check if the logger has any fatal errors

Parameters

logs	the logger
rules	the rules to use

Returns

true if the logger has fatal errors

Definition at line 44 of file notify.c.

logger_new()

CT_NODISCARD CT_NOTIFY_API logger_t* logger_new

(

arena_t *

arena

)

create a new logger

Returns

the new logger

Definition at line 21 of file notify.c.

logger_reset()

CT_NOTIFY_API void logger_reset

(

logger_t *

logs

)

reset the loggers messages

Warning

this invalidates the events returned by logger_get_events

Parameters

logs	the logger

Definition at line 89 of file notify.c.

msg_append()

CT_NOTIFY_API void msg_append	(	event_builder_t	builder,
		const node_t *	node,
		STA_FORMAT_STRING const char *	fmt,
			...
	)

append additional information to a message

Parameters

builder	the event builder to append to
node	the node to attach to the message
fmt	the format string
...	the format arguments

msg_note()

CT_NOTIFY_API void msg_note	(	event_builder_t	builder,
		STA_FORMAT_STRING const char *	fmt,
			...
	)

add a note to an existing message

Parameters

builder	the event builder to append to
fmt	the format string
...	the format arguments

msg_notify()

CT_NOTIFY_API event_builder_t msg_notify	(	INOUT_NOTNULL logger_t *	logs,
		const diagnostic_t *	diagnostic,
		const node_t *	node,
		STA_FORMAT_STRING const char *	fmt,
			...
	)

notify the logger of a new message

Warning

adding a new message invalidates all previous events handles

Parameters

logs	the logger
diagnostic	the diagnostic to use
node	the node to attach to the message
fmt	the format string
...	the format arguments

Returns

the new event builder

msg_vappend()

CT_NOTIFY_API void msg_vappend	(	event_builder_t	builder,
		const node_t *	node,
		const char *	fmt,
		va_list	args
	)

append additional information to a message

Parameters

builder	the event builder to append to
node	the node to attach to the message
fmt	the format string
args	the format arguments

Definition at line 158 of file notify.c.

msg_vnote()

CT_NOTIFY_API void msg_vnote	(	event_builder_t	builder,
		const char *	fmt,
		va_list	args
	)

add a note to an existing message

Parameters

builder	the event builder to append to
fmt	the format string
args	the format arguments

Definition at line 193 of file notify.c.

msg_vnotify()

CT_NOTIFY_API event_builder_t msg_vnotify	(	INOUT_NOTNULL logger_t *	logs,
		const diagnostic_t *	diagnostic,
		const node_t *	node,
		const char *	fmt,
		va_list	args
	)

notify the logger of a new message

Parameters

logs	the logger
diagnostic	the diagnostic to use
node	the node to attach to the message
fmt	the format string
args	the format arguments

Returns

the new event

severity_string()

STA_RET_STRING CT_CONSTFN CT_NOTIFY_API const char* severity_string

(

severity_t

severity

)

get the name of a severity

Parameters

severity

the severity to get the name of

Returns

the name of severity

Definition at line 216 of file notify.c.