Ark::Diagnostics Namespace Reference

Classes
struct	ErrorLocation
struct	LineColorContextCounts
class	Printer
	Source printer for diagnostics. More...
struct	Window

Functions
ARK_API void	makeContext (const ErrorLocation &loc, std::ostream &os, const std::optional< CodeErrorContext > &maybe_context, bool colorize)
	Helper to create a colorized context to report errors to the user.
std::string	makeContextWithNode (const std::string &message, const internal::Node &node, bool colorize=true)
	Helper used by the compiler to generate a colorized context from a node.
ARK_API void	generateWithCode (const CodeError &e, const std::string &code, std::ostream &os=std::cerr, bool colorize=true)
ARK_API void	generate (const CodeError &e, std::ostream &os=std::cerr, bool colorize=true)
	Generate a diagnostic from an error and print it to the standard error output.
void	showFileLocation (std::ostream &os, const ErrorLocation &loc)
void	hintWithContext (std::ostream &os, const std::optional< CodeErrorContext > &maybe_context, const bool colorize, const bool start)
void	helper (std::ostream &os, const std::string &message, const bool colorize, const std::string &filename, const internal::FileSpan &at, const std::optional< CodeErrorContext > &maybe_context=std::nullopt, const std::optional< std::string > &maybe_file_content=std::nullopt)
bool	isPairableChar (const char c)
void	colorizeLine (const std::string &line, LineColorContextCounts &ctx, std::ostream &os)

Function Documentation

colorizeLine()

void Ark::Diagnostics::colorizeLine	(	const std::string &	line,
		LineColorContextCounts &	ctx,
		std::ostream &	os )

Definition at line 20 of file PrettyPrinting.cpp.

References isPairableChar(), Ark::Diagnostics::LineColorContextCounts::open_curly_braces, Ark::Diagnostics::LineColorContextCounts::open_parentheses, and Ark::Diagnostics::LineColorContextCounts::open_square_braces.

Referenced by Ark::Diagnostics::Printer::printLine().

generate()

void Ark::Diagnostics::generate	(	const CodeError &	e,
		std::ostream &	os = std::cerr,
		bool	colorize = true )

Generate a diagnostic from an error and print it to the standard error output.

Parameters

e	code error
os	output stream
colorize	generate colors or not

Definition at line 244 of file Diagnostics.cpp.

References Ark::CodeError::additional_context, Ark::CodeErrorContext::at, Ark::CodeError::context, Ark::CodeErrorContext::filename, and helper().

Referenced by Ark::Welder::computeAST(), Ark::Welder::generateBytecode(), Formatter::run(), and Formatter::runWithString().

generateWithCode()

void Ark::Diagnostics::generateWithCode	(	const CodeError &	e,
		const std::string &	code,
		std::ostream &	os = std::cerr,
		bool	colorize = true )

Definition at line 227 of file Diagnostics.cpp.

References Ark::CodeError::additional_context, Ark::CodeErrorContext::at, Ark::CodeError::context, Ark::CodeErrorContext::filename, and helper().

Referenced by Ark::Welder::computeAST().

helper()

void Ark::Diagnostics::helper	(	std::ostream &	os,
		const std::string &	message,
		const bool	colorize,
		const std::string &	filename,
		const internal::FileSpan &	at,
		const std::optional< CodeErrorContext > &	maybe_context = std::nullopt,
		const std::optional< std::string > &	maybe_file_content = std::nullopt )

Definition at line 194 of file Diagnostics.cpp.

References helper(), makeContext(), and Ark::Utils::splitString().

Referenced by generate(), generateWithCode(), helper(), and makeContextWithNode().

hintWithContext()

void Ark::Diagnostics::hintWithContext	(	std::ostream &	os,
		const std::optional< CodeErrorContext > &	maybe_context,
		const bool	colorize,
		const bool	start )

Definition at line 25 of file Diagnostics.cpp.

References Ark::Diagnostics::Printer::GhostLinePrefix.

Referenced by makeContext().

isPairableChar()

bool Ark::Diagnostics::isPairableChar ( const char c )

nodiscard

Definition at line 15 of file PrettyPrinting.cpp.

Referenced by colorizeLine().

makeContext()

void Ark::Diagnostics::makeContext	(	const ErrorLocation &	loc,
		std::ostream &	os,
		const std::optional< CodeErrorContext > &	maybe_context,
		bool	colorize )

Helper to create a colorized context to report errors to the user.

Parameters

loc	error location
os	stream in which the error will be written
maybe_context	optional context, parent of the error
colorize	generate colors or not

Definition at line 45 of file Diagnostics.cpp.

References Ark::internal::FilePos::column, Ark::Diagnostics::Printer::coversLine(), Ark::Diagnostics::Printer::current(), Ark::Diagnostics::Printer::currentLine(), Ark::Diagnostics::ErrorLocation::end, Ark::Diagnostics::Printer::extendWindow(), Ark::Diagnostics::ErrorLocation::filename, Ark::Diagnostics::Printer::GhostLinePrefix, Ark::Diagnostics::Printer::hasContent(), hintWithContext(), Ark::Diagnostics::Printer::isLastLineOfTarget(), Ark::Diagnostics::Printer::isNextLineTheFirstLineOfTarget(), Ark::Diagnostics::Printer::isTargetLine(), Ark::internal::FilePos::line, Ark::Diagnostics::ErrorLocation::maybe_content, Ark::Diagnostics::ErrorLocation::maybeEndLine(), Ark::Diagnostics::Printer::printLine(), showFileLocation(), Ark::Diagnostics::ErrorLocation::start, and Ark::Diagnostics::ErrorLocation::wholeLineIsError().

Referenced by Ark::VM::backtrace(), helper(), and Ark::internal::Debugger::showContext().

makeContextWithNode()

std::string Ark::Diagnostics::makeContextWithNode	(	const std::string &	message,
		const internal::Node &	node,
		bool	colorize = true )

Helper used by the compiler to generate a colorized context from a node.

Parameters

message	error message to be included in the context
node	AST node with the error
colorize	toggle context colors (default: true)

Returns

std::string

Definition at line 213 of file Diagnostics.cpp.

References Ark::internal::Node::filename(), helper(), and Ark::internal::Node::position().

Referenced by Ark::internal::ASTLowerer::warning().

showFileLocation()

void Ark::Diagnostics::showFileLocation	(	std::ostream &	os,
		const ErrorLocation &	loc )

Definition at line 19 of file Diagnostics.cpp.

References ARK_NO_NAME_FILE, Ark::Diagnostics::ErrorLocation::filename, Ark::internal::FilePos::line, and Ark::Diagnostics::ErrorLocation::start.

Referenced by makeContext().