clang::tooling::Diagnostic Struct Reference

Represents the diagnostic with the level of severity and possible fixes to be applied. More...

#include "clang/Tooling/Core/Diagnostic.h"

Public Types
enum	Level { Remark = DiagnosticsEngine::Remark , Warning = DiagnosticsEngine::Warning , Error = DiagnosticsEngine::Error }

Public Member Functions
	Diagnostic ()=default
	Diagnostic (llvm::StringRef DiagnosticName, Level DiagLevel, StringRef BuildDirectory)
	Diagnostic (llvm::StringRef DiagnosticName, const DiagnosticMessage &Message, const SmallVector< DiagnosticMessage, 1 > &Notes, Level DiagLevel, llvm::StringRef BuildDirectory)

Public Attributes
std::string	DiagnosticName
	Name identifying the Diagnostic.
DiagnosticMessage	Message
	Message associated to the diagnostic.
SmallVector< DiagnosticMessage, 1 >	Notes
	Potential notes about the diagnostic.
Level	DiagLevel
	Diagnostic level. Can indicate either an error or a warning.
std::string	BuildDirectory
	A build directory of the diagnostic source file.

Detailed Description

Represents the diagnostic with the level of severity and possible fixes to be applied.

Definition at line 68 of file Diagnostic.h.

Member Enumeration Documentation

Level

enum clang::tooling::Diagnostic::Level

Enumerator
Remark
Warning
Error

Definition at line 69 of file Diagnostic.h.

Constructor & Destructor Documentation

Diagnostic() [1/3]

clang::tooling::Diagnostic::Diagnostic ( )

default

References BuildDirectory, DiagLevel, DiagnosticName, Message, and Notes.

Diagnostic() [2/3]

clang::tooling::Diagnostic::Diagnostic	(	llvm::StringRef	DiagnosticName,
		Diagnostic::Level	DiagLevel,
		StringRef	BuildDirectory )

Definition at line 48 of file Diagnostic.cpp.

References BuildDirectory, DiagLevel, and DiagnosticName.

Diagnostic() [3/3]

clang::tooling::Diagnostic::Diagnostic	(	llvm::StringRef	DiagnosticName,
		const DiagnosticMessage &	Message,
		const SmallVector< DiagnosticMessage, 1 > &	Notes,
		Level	DiagLevel,
		llvm::StringRef	BuildDirectory )

Definition at line 53 of file Diagnostic.cpp.

References BuildDirectory, DiagLevel, DiagnosticName, Message, and Notes.

Member Data Documentation

BuildDirectory

std::string clang::tooling::Diagnostic::BuildDirectory

A build directory of the diagnostic source file.

It's an absolute path which is directory field of the source file in compilation database. If users don't specify the compilation database directory, it is the current directory where clang-tidy runs.

Note: it is empty in unittest.

Definition at line 103 of file Diagnostic.h.

Referenced by Diagnostic(), Diagnostic(), and Diagnostic().

DiagLevel

Level clang::tooling::Diagnostic::DiagLevel

Diagnostic level. Can indicate either an error or a warning.

Definition at line 94 of file Diagnostic.h.

Referenced by Diagnostic(), Diagnostic(), and Diagnostic().

DiagnosticName

std::string clang::tooling::Diagnostic::DiagnosticName

Name identifying the Diagnostic.

Definition at line 85 of file Diagnostic.h.

Referenced by Diagnostic(), Diagnostic(), and Diagnostic().

Message

DiagnosticMessage clang::tooling::Diagnostic::Message

Message associated to the diagnostic.

Definition at line 88 of file Diagnostic.h.

Referenced by Diagnostic(), Diagnostic(), and clang::tooling::selectFirstFix().

Notes

SmallVector<DiagnosticMessage, 1> clang::tooling::Diagnostic::Notes

Potential notes about the diagnostic.

Definition at line 91 of file Diagnostic.h.

Referenced by Diagnostic(), Diagnostic(), and clang::tooling::selectFirstFix().

---

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

• include/clang/Tooling/Core/Diagnostic.h
• lib/Tooling/Core/Diagnostic.cpp