clang  19.0.0git
TextDiagnosticPrinter.h
Go to the documentation of this file.
1 //===--- TextDiagnosticPrinter.h - Text Diagnostic Client -------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This is a concrete diagnostic client, which prints the diagnostics to
10 // standard error.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef LLVM_CLANG_FRONTEND_TEXTDIAGNOSTICPRINTER_H
15 #define LLVM_CLANG_FRONTEND_TEXTDIAGNOSTICPRINTER_H
16 
17 #include "clang/Basic/Diagnostic.h"
18 #include "clang/Basic/LLVM.h"
19 #include "llvm/ADT/IntrusiveRefCntPtr.h"
20 #include <memory>
21 
22 namespace clang {
23 class DiagnosticOptions;
24 class LangOptions;
25 class TextDiagnostic;
26 
28  raw_ostream &OS;
30 
31  /// Handle to the currently active text diagnostic emitter.
32  std::unique_ptr<TextDiagnostic> TextDiag;
33 
34  /// A string to prefix to error messages.
35  std::string Prefix;
36 
37  LLVM_PREFERRED_TYPE(bool)
38  unsigned OwnsOutputStream : 1;
39 
40 public:
41  TextDiagnosticPrinter(raw_ostream &os, DiagnosticOptions *diags,
42  bool OwnsOutputStream = false);
43  ~TextDiagnosticPrinter() override;
44 
45  /// setPrefix - Set the diagnostic printer prefix string, which will be
46  /// printed at the start of any diagnostics. If empty, no prefix string is
47  /// used.
48  void setPrefix(std::string Value) { Prefix = std::move(Value); }
49 
50  void BeginSourceFile(const LangOptions &LO, const Preprocessor *PP) override;
51  void EndSourceFile() override;
53  const Diagnostic &Info) override;
54 };
55 
56 } // end namespace clang
57 
58 #endif
Defines the Diagnostic-related interfaces.
Forward-declares and imports various common LLVM datatypes that clang wants to use unqualified.
Abstract interface, implemented by clients of the front-end, which formats and prints fully processed...
Definition: Diagnostic.h:1751
Options for controlling the compiler diagnostics engine.
A little helper class (which is basically a smart pointer that forwards info from DiagnosticsEngine) ...
Definition: Diagnostic.h:1577
Level
The level of the diagnostic, after it has been through mapping.
Definition: Diagnostic.h:196
Keeps track of the various options that can be enabled, which controls the dialect of C or C++ that i...
Definition: LangOptions.h:482
Engages in a tight little dance with the lexer to efficiently preprocess tokens.
Definition: Preprocessor.h:128
void BeginSourceFile(const LangOptions &LO, const Preprocessor *PP) override
Callback to inform the diagnostic client that processing of a source file is beginning.
void EndSourceFile() override
Callback to inform the diagnostic client that processing of a source file has ended.
void setPrefix(std::string Value)
setPrefix - Set the diagnostic printer prefix string, which will be printed at the start of any diagn...
void HandleDiagnostic(DiagnosticsEngine::Level Level, const Diagnostic &Info) override
Handle this diagnostic, reporting it to the user or capturing it to a log as needed.
TextDiagnosticPrinter(raw_ostream &os, DiagnosticOptions *diags, bool OwnsOutputStream=false)
The JSON file list parser is used to communicate input to InstallAPI.