Renders diagnostic messages with source context and caret/tilde indicators, similar to clang/rustc output. More...

#include "donner/base/DiagnosticRenderer.h"

Classes
struct	Options
	Options for rendering diagnostics. More...

Static Public Member Functions
static std::string	format (std::string_view source, const ParseDiagnostic &diag, const Options &options)
	Format a single diagnostic against source text.
static std::string	format (std::string_view source, const ParseDiagnostic &diag)
	Format with default options.
static std::string	formatAll (std::string_view source, const ParseWarningSink &sink, const Options &options)
	Format all warnings in a sink against source text.
static std::string	formatAll (std::string_view source, const ParseWarningSink &sink)
	Format all with default options.

Detailed Description

Renders diagnostic messages with source context and caret/tilde indicators, similar to clang/rustc output.

Example output:

error: Unexpected character
  --> test.svg:1:25
   |
 1 | <path d="M 100 100 h 2!" />
   |                         ^

For multi-character ranges, tildes indicate the span:

warning: Invalid paint server value
  --> line 4, col 12
   |
 4 | <path fill="url(#)"/>
   |             ^~~~~~

Class Documentation

struct donner::DiagnosticRenderer::Options

Options for rendering diagnostics.

Collaboration diagram for donner::DiagnosticRenderer::Options:

Class Members
bool	colorize = false	Enable ANSI color codes in the output.
string_view	filename	Optional filename for the header (e.g. "test.svg").

std::string donner::DiagnosticRenderer::format	(	std::string_view	source,
		const ParseDiagnostic &	diag,
		const Options &	options )

static

Format a single diagnostic against source text.

Parameters

source	The original source text that was parsed.
diag	The diagnostic to render.
options	Rendering options.

std::string donner::DiagnosticRenderer::formatAll	(	std::string_view	source,
		const ParseWarningSink &	sink,
		const Options &	options )

static

Format all warnings in a sink against source text.

Parameters

source	The original source text that was parsed.
sink	Warning sink containing diagnostics to render.
options	Rendering options.

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