mirror of
https://github.com/apple/swift.git
synced 2025-12-21 12:14:44 +01:00
107 lines
3.2 KiB
C++
107 lines
3.2 KiB
C++
//===--- PrintingDiagnosticConsumer.h - Print Text Diagnostics --*- C++ -*-===//
|
|
//
|
|
// This source file is part of the Swift.org open source project
|
|
//
|
|
// Copyright (c) 2014 - 2020 Apple Inc. and the Swift project authors
|
|
// Licensed under Apache License v2.0 with Runtime Library Exception
|
|
//
|
|
// See https://swift.org/LICENSE.txt for license information
|
|
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This file defines the PrintingDiagnosticConsumer class, which displays
|
|
// diagnostics as text to a terminal.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef SWIFT_PRINTINGDIAGNOSTICCONSUMER_H
|
|
#define SWIFT_PRINTINGDIAGNOSTICCONSUMER_H
|
|
|
|
#include "swift/AST/DiagnosticConsumer.h"
|
|
#include "swift/Basic/DiagnosticOptions.h"
|
|
#include "swift/Basic/LLVM.h"
|
|
|
|
#include "llvm/ADT/DenseMap.h"
|
|
#include "llvm/Support/raw_ostream.h"
|
|
#include "llvm/Support/Process.h"
|
|
|
|
namespace swift {
|
|
|
|
/// Diagnostic consumer that displays diagnostics to standard error.
|
|
class PrintingDiagnosticConsumer : public DiagnosticConsumer {
|
|
llvm::raw_ostream &Stream;
|
|
bool ForceColors = false;
|
|
bool PrintEducationalNotes = false;
|
|
bool EmitMacroExpansionFiles = false;
|
|
bool DidErrorOccur = false;
|
|
DiagnosticOptions::FormattingStyle FormattingStyle =
|
|
DiagnosticOptions::FormattingStyle::LLVM;
|
|
// Educational notes which are buffered until the consumer is finished
|
|
// constructing a snippet.
|
|
SmallVector<std::string, 1> BufferedEducationalNotes;
|
|
bool SuppressOutput = false;
|
|
|
|
/// swift-syntax rendering
|
|
|
|
/// A queued up source file known to the queued diagnostics.
|
|
using QueuedBuffer = void *;
|
|
|
|
/// The queued diagnostics structure.
|
|
void *queuedDiagnostics = nullptr;
|
|
llvm::DenseMap<unsigned, QueuedBuffer> queuedBuffers;
|
|
|
|
/// Source file syntax nodes cached by { source manager, buffer ID }.
|
|
llvm::DenseMap<std::pair<SourceManager *, unsigned>, void *> sourceFileSyntax;
|
|
|
|
public:
|
|
PrintingDiagnosticConsumer(llvm::raw_ostream &stream = llvm::errs());
|
|
~PrintingDiagnosticConsumer();
|
|
|
|
virtual void handleDiagnostic(SourceManager &SM,
|
|
const DiagnosticInfo &Info) override;
|
|
|
|
virtual bool finishProcessing() override;
|
|
|
|
void flush(bool includeTrailingBreak);
|
|
|
|
virtual void flush() override { flush(false); }
|
|
|
|
void forceColors() {
|
|
ForceColors = true;
|
|
llvm::sys::Process::UseANSIEscapeCodes(true);
|
|
}
|
|
|
|
void setPrintEducationalNotes(bool ShouldPrint) {
|
|
PrintEducationalNotes = ShouldPrint;
|
|
}
|
|
|
|
void setFormattingStyle(DiagnosticOptions::FormattingStyle style) {
|
|
FormattingStyle = style;
|
|
}
|
|
|
|
void setEmitMacroExpansionFiles(bool ShouldEmit) {
|
|
EmitMacroExpansionFiles = ShouldEmit;
|
|
}
|
|
|
|
bool didErrorOccur() {
|
|
return DidErrorOccur;
|
|
}
|
|
|
|
void setSuppressOutput(bool suppressOutput) {
|
|
SuppressOutput = suppressOutput;
|
|
}
|
|
|
|
private:
|
|
/// Retrieve the SourceFileSyntax for the given buffer.
|
|
void *getSourceFileSyntax(SourceManager &SM, unsigned bufferID,
|
|
StringRef displayName);
|
|
|
|
void queueBuffer(SourceManager &sourceMgr, unsigned bufferID);
|
|
void printDiagnostic(SourceManager &SM, const DiagnosticInfo &Info);
|
|
};
|
|
|
|
}
|
|
|
|
#endif
|