Files
swift-mirror/tools/SwiftSyntax/DiagnosticConsumer.swift
Harlan 2cc756414b [SwiftSyntax] Swift Diagnostics API (#11511)
This patch provides an API and Serialization for clang-style diagnostics
from within Swift. Libraries can use this API to pop their own custom
diagnostics that can be serialized to JSON.
2017-12-12 15:55:22 -05:00

25 lines
1019 B
Swift

//===---------- DiagnosticConsumer.swift - Diagnostic Consumer ------------===//
//
// 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 provides the DiagnosticConsumer protocol.
//===----------------------------------------------------------------------===//
/// An object that intends to receive notifications when diagnostics are
/// emitted.
public protocol DiagnosticConsumer {
/// Handle the provided diagnostic which has just been registered with the
/// DiagnosticEngine.
func handle(_ diagnostic: Diagnostic)
/// Finalize the consumption of diagnostics, flushing to disk if necessary.
func finalize()
}