TextDiagnosticPrinter.h

Go to the documentation of this file.

//===--- TextDiagnosticPrinter.h - Text Diagnostic Client -------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// This is a concrete diagnostic client, which prints the diagnostics to
// standard error.
//
//===----------------------------------------------------------------------===//
 
#ifndef LLVM_CLANG_FRONTEND_TEXTDIAGNOSTICPRINTER_H
#define LLVM_CLANG_FRONTEND_TEXTDIAGNOSTICPRINTER_H
 
#include "clang/Basic/Diagnostic.h"
#include "clang/Basic/LLVM.h"
#include "llvm/ADT/IntrusiveRefCntPtr.h"
#include <memory>
 
namespace clang {
class DiagnosticOptions;
class LangOptions;
class TextDiagnostic;
 
class TextDiagnosticPrinter : public DiagnosticConsumer {
  raw_ostream &OS;
  DiagnosticOptions &DiagOpts;
 
  /// Handle to the currently active text diagnostic emitter.
  std::unique_ptr<TextDiagnostic> TextDiag;
 
  /// A string to prefix to error messages.
  std::string Prefix;
 
  LLVM_PREFERRED_TYPE(bool)
  unsigned OwnsOutputStream : 1;
 
public:
  TextDiagnosticPrinter(raw_ostream &os, DiagnosticOptions &DiagOpts,
                        bool OwnsOutputStream = false);
  ~TextDiagnosticPrinter() override;
 
  /// setPrefix - Set the diagnostic printer prefix string, which will be
  /// printed at the start of any diagnostics. If empty, no prefix string is
  /// used.
  void setPrefix(std::string Value) { Prefix = std::move(Value); }
 
  void BeginSourceFile(const LangOptions &LO, const Preprocessor *PP) override;
  void EndSourceFile() override;
  void HandleDiagnostic(DiagnosticsEngine::Level Level,
                        const Diagnostic &Info) override;
};
 
} // end namespace clang
 
#endif