Clang Project

clang_source_code/include/clang/Frontend/TextDiagnosticPrinter.h
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
22namespace clang {
23class DiagnosticOptions;
24class LangOptions;
25class TextDiagnostic;
26
27class TextDiagnosticPrinter : public DiagnosticConsumer {
28  raw_ostream &OS;
29  IntrusiveRefCntPtr<DiagnosticOptionsDiagOpts;
30
31  /// Handle to the currently active text diagnostic emitter.
32  std::unique_ptr<TextDiagnosticTextDiag;
33
34  /// A string to prefix to error messages.
35  std::string Prefix;
36
37  unsigned OwnsOutputStream : 1;
38
39public:
40  TextDiagnosticPrinter(raw_ostream &osDiagnosticOptions *diags,
41                        bool OwnsOutputStream = false);
42  ~TextDiagnosticPrinter() override;
43
44  /// setPrefix - Set the diagnostic printer prefix string, which will be
45  /// printed at the start of any diagnostics. If empty, no prefix string is
46  /// used.
47  void setPrefix(std::string Value) { Prefix = std::move(Value); }
48
49  void BeginSourceFile(const LangOptions &LOconst Preprocessor *PP) override;
50  void EndSourceFile() override;
51  void HandleDiagnostic(DiagnosticsEngine::Level Level,
52                        const Diagnostic &Info) override;
53};
54
55// end namespace clang
56
57#endif
58
clang::TextDiagnosticPrinter::OS
clang::TextDiagnosticPrinter::DiagOpts
clang::TextDiagnosticPrinter::TextDiag
clang::TextDiagnosticPrinter::Prefix
clang::TextDiagnosticPrinter::OwnsOutputStream
clang::TextDiagnosticPrinter::setPrefix
clang::TextDiagnosticPrinter::BeginSourceFile
clang::TextDiagnosticPrinter::EndSourceFile
clang::TextDiagnosticPrinter::HandleDiagnostic