clang-tools 19.0.0git
Public Types | Public Member Functions | List of all members
clang::clangd::StoreDiags Class Reference

StoreDiags collects the diagnostics that can later be reported by clangd. More...

#include <Diagnostics.h>

Inheritance diagram for clang::clangd::StoreDiags:
Inheritance graph
[legend]

Public Types

using DiagFixer = std::function< std::vector< Fix >(DiagnosticsEngine::Level, const clang::Diagnostic &)>
 When passed a main diagnostic, returns fixes to add to it.
 
using LevelAdjuster = std::function< DiagnosticsEngine::Level(DiagnosticsEngine::Level, const clang::Diagnostic &)>
 
using DiagCallback = std::function< void(const clang::Diagnostic &, clangd::Diag &)>
 

Public Member Functions

std::vector< Diagtake (const clang::tidy::ClangTidyContext *Tidy=nullptr)
 
void BeginSourceFile (const LangOptions &Opts, const Preprocessor *PP) override
 
void EndSourceFile () override
 
void HandleDiagnostic (DiagnosticsEngine::Level DiagLevel, const clang::Diagnostic &Info) override
 
void contributeFixes (DiagFixer Fixer)
 If set, possibly adds fixes for diagnostics using Fixer.
 
void setLevelAdjuster (LevelAdjuster Adjuster)
 If set, this allows the client of this class to adjust the level of diagnostics, such as promoting warnings to errors, or ignoring diagnostics.
 
void setDiagCallback (DiagCallback CB)
 Invokes a callback every time a diagnostics is completely formed.
 

Detailed Description

StoreDiags collects the diagnostics that can later be reported by clangd.

It groups all notes for a diagnostic into a single Diag and filters out diagnostics that don't mention the main file (i.e. neither the diag itself nor its notes are in the main file).

Definition at line 138 of file Diagnostics.h.

Member Typedef Documentation

◆ DiagCallback

using clang::clangd::StoreDiags::DiagCallback = std::function<void(const clang::Diagnostic &, clangd::Diag &)>

Definition at line 155 of file Diagnostics.h.

◆ DiagFixer

using clang::clangd::StoreDiags::DiagFixer = std::function<std::vector<Fix>(DiagnosticsEngine::Level, const clang::Diagnostic &)>

When passed a main diagnostic, returns fixes to add to it.

When passed a note diagnostic, returns fixes to replace it with.

Definition at line 151 of file Diagnostics.h.

◆ LevelAdjuster

using clang::clangd::StoreDiags::LevelAdjuster = std::function<DiagnosticsEngine::Level( DiagnosticsEngine::Level, const clang::Diagnostic &)>

Definition at line 153 of file Diagnostics.h.

Member Function Documentation

◆ BeginSourceFile()

void clang::clangd::StoreDiags::BeginSourceFile ( const LangOptions &  Opts,
const Preprocessor *  PP 
)
override

Definition at line 625 of file Diagnostics.cpp.

◆ contributeFixes()

void clang::clangd::StoreDiags::contributeFixes ( DiagFixer  Fixer)
inline

If set, possibly adds fixes for diagnostics using Fixer.

Definition at line 158 of file Diagnostics.h.

Referenced by clang::clangd::ParsedAST::build().

◆ EndSourceFile()

void clang::clangd::StoreDiags::EndSourceFile ( )
override

Definition at line 633 of file Diagnostics.cpp.

◆ HandleDiagnostic()

void clang::clangd::StoreDiags::HandleDiagnostic ( DiagnosticsEngine::Level  DiagLevel,
const clang::Diagnostic &  Info 
)
override

◆ setDiagCallback()

void clang::clangd::StoreDiags::setDiagCallback ( DiagCallback  CB)
inline

Invokes a callback every time a diagnostics is completely formed.

Handler of the callback can also mutate the diagnostic.

Definition at line 165 of file Diagnostics.h.

Referenced by clang::clangd::ParsedAST::build(), and clang::clangd::buildPreamble().

◆ setLevelAdjuster()

void clang::clangd::StoreDiags::setLevelAdjuster ( LevelAdjuster  Adjuster)
inline

If set, this allows the client of this class to adjust the level of diagnostics, such as promoting warnings to errors, or ignoring diagnostics.

Definition at line 162 of file Diagnostics.h.

Referenced by clang::clangd::ParsedAST::build(), and clang::clangd::buildPreamble().

◆ take()

std::vector< Diag > clang::clangd::StoreDiags::take ( const clang::tidy::ClangTidyContext Tidy = nullptr)

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