Class to encapsulate the logic for formatting and printing a textual diagnostic message. More...

#include <TextDiagnostic.h>

Inheritance diagram for clang::TextDiagnostic:

Collaboration diagram for clang::TextDiagnostic:

Public Member Functions
	TextDiagnostic (raw_ostream &OS, const LangOptions &LangOpts, DiagnosticOptions *DiagOpts)
virtual	~TextDiagnostic ()
Static Public Member Functions
static void	printDiagnosticLevel (raw_ostream &OS, DiagnosticsEngine::Level Level, bool ShowColors, bool CLFallbackMode=false)
	Print the diagonstic level to a raw_ostream.
static void	printDiagnosticMessage (raw_ostream &OS, bool IsSupplemental, StringRef Message, unsigned CurrentColumn, unsigned Columns, bool ShowColors)
	Pretty-print a diagnostic message to a raw_ostream.
Protected Member Functions
void	emitDiagnosticMessage (SourceLocation Loc, PresumedLoc PLoc, DiagnosticsEngine::Level Level, StringRef Message, ArrayRef< CharSourceRange > Ranges, const SourceManager *SM, DiagOrStoredDiag D) override
void	emitDiagnosticLoc (SourceLocation Loc, PresumedLoc PLoc, DiagnosticsEngine::Level Level, ArrayRef< CharSourceRange > Ranges, const SourceManager &SM) override
	Print out the file/line/column information and include trace.
void	emitCodeContext (SourceLocation Loc, DiagnosticsEngine::Level Level, SmallVectorImpl< CharSourceRange > &Ranges, ArrayRef< FixItHint > Hints, const SourceManager &SM) override
void	emitIncludeLocation (SourceLocation Loc, PresumedLoc PLoc, const SourceManager &SM) override
void	emitImportLocation (SourceLocation Loc, PresumedLoc PLoc, StringRef ModuleName, const SourceManager &SM) override
void	emitBuildingModuleLocation (SourceLocation Loc, PresumedLoc PLoc, StringRef ModuleName, const SourceManager &SM) override

Detailed Description

Class to encapsulate the logic for formatting and printing a textual diagnostic message.

This class provides an interface for building and emitting a textual diagnostic, including all of the macro backtraces, caret diagnostics, FixIt Hints, and code snippets. In the presence of macros this involves a recursive process, synthesizing notes for each macro expansion.

The purpose of this class is to isolate the implementation of printing beautiful text diagnostics from any particular interfaces. The Clang DiagnosticClient is implemented through this class as is diagnostic printing coming out of libclang.

Definition at line 35 of file TextDiagnostic.h.

Constructor & Destructor Documentation

TextDiagnostic::TextDiagnostic	(	raw_ostream &	OS,
		const LangOptions &	LangOpts,
		DiagnosticOptions *	DiagOpts
	)

Definition at line 666 of file TextDiagnostic.cpp.

TextDiagnostic::~TextDiagnostic ( ) [virtual]

Definition at line 671 of file TextDiagnostic.cpp.

Member Function Documentation

void TextDiagnostic::emitBuildingModuleLocation	(	SourceLocation	Loc,
		PresumedLoc	PLoc,
		StringRef	ModuleName,
		const SourceManager &	SM
	)		`[override, protected, virtual]`

Implements clang::DiagnosticRenderer.

Definition at line 894 of file TextDiagnostic.cpp.

References clang::DiagnosticRenderer::DiagOpts, clang::PresumedLoc::getFilename(), and clang::PresumedLoc::getLine().

void clang::TextDiagnostic::emitCodeContext	(	SourceLocation	Loc,
		DiagnosticsEngine::Level	Level,
		SmallVectorImpl< CharSourceRange > &	Ranges,
		ArrayRef< FixItHint >	Hints,
		const SourceManager &	SM
	)		`[inline, override, protected, virtual]`

Implements clang::DiagnosticRenderer.

Definition at line 90 of file TextDiagnostic.h.

void TextDiagnostic::emitDiagnosticLoc	(	SourceLocation	Loc,
		PresumedLoc	PLoc,
		DiagnosticsEngine::Level	Level,
		ArrayRef< CharSourceRange >	Ranges,
		const SourceManager &	SM
	)		`[override, protected, virtual]`

Print out the file/line/column information and include trace.

This method handlen the emission of the diagnostic location information. This includes extracting as much location information as is present for the diagnostic and printing it, as well as any include stack or source ranges necessary.

Implements clang::DiagnosticRenderer.

Definition at line 772 of file TextDiagnostic.cpp.

References clang::DiagnosticOptions::Clang, clang::DiagnosticRenderer::DiagOpts, clang::PresumedLoc::getColumn(), clang::SourceManager::getColumnNumber(), clang::SourceManager::getDecomposedLoc(), clang::SourceManager::getExpansionLoc(), clang::SourceManager::getExpansionRange(), clang::SourceManager::getFileEntryForID(), clang::SourceManager::getFileID(), clang::PresumedLoc::getFilename(), clang::PresumedLoc::getLine(), clang::SourceManager::getLineNumber(), clang::FileEntry::getName(), clang::FileEntry::isInPCH(), clang::FileID::isInvalid(), clang::PresumedLoc::isInvalid(), clang::SourceLocation::isMacroID(), clang::FileEntry::isValid(), clang::DiagnosticRenderer::LangOpts, clang::Lexer::MeasureTokenLength(), clang::DiagnosticOptions::Msvc, savedColor, and clang::DiagnosticOptions::Vi.

Referenced by emitDiagnosticMessage().

void TextDiagnostic::emitDiagnosticMessage	(	SourceLocation	Loc,
		PresumedLoc	PLoc,
		DiagnosticsEngine::Level	Level,
		StringRef	Message,
		ArrayRef< CharSourceRange >	Ranges,
		const SourceManager *	SM,
		DiagOrStoredDiag	D
	)		`[override, protected, virtual]`

Implements clang::DiagnosticRenderer.

Definition at line 674 of file TextDiagnostic.cpp.

References clang::DiagnosticRenderer::DiagOpts, emitDiagnosticLoc(), clang::SourceLocation::isValid(), clang::DiagnosticsEngine::Note, printDiagnosticLevel(), and printDiagnosticMessage().

void TextDiagnostic::emitImportLocation	(	SourceLocation	Loc,
		PresumedLoc	PLoc,
		StringRef	ModuleName,
		const SourceManager &	SM
	)		`[override, protected, virtual]`

Implements clang::DiagnosticRenderer.

Definition at line 884 of file TextDiagnostic.cpp.

References clang::DiagnosticRenderer::DiagOpts, clang::PresumedLoc::getFilename(), and clang::PresumedLoc::getLine().

void TextDiagnostic::emitIncludeLocation	(	SourceLocation	Loc,
		PresumedLoc	PLoc,
		const SourceManager &	SM
	)		`[override, protected, virtual]`

Implements clang::DiagnosticRenderer.

Definition at line 874 of file TextDiagnostic.cpp.

References clang::DiagnosticRenderer::DiagOpts, clang::PresumedLoc::getFilename(), and clang::PresumedLoc::getLine().

void TextDiagnostic::printDiagnosticLevel	(	raw_ostream &	OS,
		DiagnosticsEngine::Level	Level,
		bool	ShowColors,
		bool	CLFallbackMode = `false`
	)		`[static]`

Print the diagonstic level to a raw_ostream.

This is a static helper that handles colorizing the level and formatting it into an arbitrary output stream. This is used internally by the TextDiagnostic emission code, but it can also be used directly by consumers that don't have a source manager or other state that the full TextDiagnostic logic requires.

Definition at line 699 of file TextDiagnostic.cpp.

References clang::DiagnosticsEngine::Error, errorColor, clang::DiagnosticsEngine::Fatal, fatalColor, clang::DiagnosticsEngine::Ignored, clang::DiagnosticsEngine::Note, noteColor, clang::DiagnosticsEngine::Remark, remarkColor, clang::DiagnosticsEngine::Warning, and warningColor.

Referenced by emitDiagnosticMessage(), and clang::TextDiagnosticPrinter::HandleDiagnostic().

void TextDiagnostic::printDiagnosticMessage	(	raw_ostream &	OS,
		bool	IsSupplemental,
		StringRef	Message,
		unsigned	CurrentColumn,
		unsigned	Columns,
		bool	ShowColors
	)		`[static]`

Pretty-print a diagnostic message to a raw_ostream.

This is a static helper to handle the line wrapping, colorizing, and rendering of a diagnostic message to a particular ostream. It is publicly visible so that clients which do not have sufficient state to build a complete TextDiagnostic object can still get consistent formatting of their diagnostic messages.

Parameters:

OS	Where the message is printed
IsSupplemental	true if this is a continuation note diagnostic
Message	The text actually printed
CurrentColumn	The starting column of the first line, accounting for any prefix.
Columns	The number of columns to use in line-wrapping, 0 disables all line-wrapping.
ShowColors	Enable colorizing of the message.

Definition at line 740 of file TextDiagnostic.cpp.

References applyTemplateHighlighting(), printWordWrapped(), and savedColor.

Referenced by emitDiagnosticMessage(), and clang::TextDiagnosticPrinter::HandleDiagnostic().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation