mirror of
https://github.com/apple/swift.git
synced 2025-12-14 20:36:38 +01:00
235242e8b3
The diagnostics formatter from swift-syntax previously only handled fully-formed diagnostics anchored at a particular syntax node. Therefore, the compiler would fall back to the existing LLVM-based diagnostic formatter for diagnostics that had no source location. Adopt new API in the swift-syntax diagnostics formatter that renders a diagnostic message without requiring source location information, so that we consistently use the swift-syntax formatter when it is selected (which is the default).
82 lines
3.1 KiB
C++
82 lines
3.1 KiB
C++
//===--- DiagnosticBridge.h - Diagnostic Bridge to SwiftSyntax --*- C++ -*-===//
|
|
//
|
|
// This source file is part of the Swift.org open source project
|
|
//
|
|
// Copyright (c) 2014 - 2017 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 declares the DiagnosticBridge class, which bridges to swift-syntax
|
|
// for diagnostics printing.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef SWIFT_BASIC_DIAGNOSTICBRIDGE_H
|
|
#define SWIFT_BASIC_DIAGNOSTICBRIDGE_H
|
|
|
|
#include "swift/AST/DiagnosticConsumer.h"
|
|
#include "swift/Basic/SourceManager.h"
|
|
#include "llvm/ADT/DenseMap.h"
|
|
#include "llvm/Support/raw_ostream.h"
|
|
|
|
namespace swift {
|
|
/// Declare the bridge between swift-syntax and swift-frontend for diagnostics
|
|
/// handling. The methods in this class should only be called when
|
|
/// `SWIFT_BUILD_SWIFT_SYNTAX` is defined as they are otherwise undefined.
|
|
class DiagnosticBridge {
|
|
/// A queued up source file known to the queued diagnostics.
|
|
using QueuedBuffer = void *;
|
|
|
|
/// Per-frontend state maintained on the Swift side.
|
|
void *perFrontendState = nullptr;
|
|
|
|
/// 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:
|
|
/// Enqueue diagnostics.
|
|
void enqueueDiagnostic(SourceManager &SM, const DiagnosticInfo &Info,
|
|
unsigned innermostBufferID);
|
|
|
|
/// Emit a single diagnostic without location information.
|
|
void emitDiagnosticWithoutLocation(
|
|
const DiagnosticInfo &Info, llvm::raw_ostream &out, bool forceColors);
|
|
|
|
/// Flush all enqueued diagnostics.
|
|
void flush(llvm::raw_ostream &OS, bool includeTrailingBreak,
|
|
bool forceColors);
|
|
|
|
/// Retrieve the stack of source buffers from the provided location out to
|
|
/// a physical source file, with source buffer IDs for each step along the way
|
|
/// due to (e.g.) macro expansions or generated code.
|
|
///
|
|
/// The resulting vector will always contain valid source locations. If the
|
|
/// initial location is invalid, the result will be empty.
|
|
static SmallVector<unsigned, 1> getSourceBufferStack(SourceManager &sourceMgr,
|
|
SourceLoc loc);
|
|
|
|
/// Print the category footnotes as part of teardown.
|
|
void printCategoryFootnotes(llvm::raw_ostream &os, bool forceColors);
|
|
|
|
DiagnosticBridge() = default;
|
|
~DiagnosticBridge();
|
|
|
|
private:
|
|
/// Retrieve the SourceFileSyntax for the given buffer.
|
|
void *getSourceFileSyntax(SourceManager &SM, unsigned bufferID,
|
|
StringRef displayName);
|
|
|
|
void queueBuffer(SourceManager &sourceMgr, unsigned bufferID);
|
|
};
|
|
} // namespace swift
|
|
|
|
#endif
|