Merge pull request #325 from ahoppen/pr/remove-diagnosticengine

Remove `DiagnosticEngine`

Author: ahoppen

Changelog.md

@@ -8,6 +8,7 @@ Note: This is in reverse chronological order, so newer entries are added to the
 * The `SwiftSyntaxParser` type and a few related types now live in their own module (also named `SwiftSyntaxParser`). This allows using `SwiftSyntax` for code generation purposes without having a compatible `_InternalSwiftSyntaxParser.dylib` around. 
 
   `import SwiftSyntaxParser` where necessary.
+* `DiagnosticEngine` has been removed. Instead, `SyntaxParser` takes a closure through which it emits parser diagnostics. Depending on your needs, use the closure to handle the diagnostics or write + hook up your own diagnostics engine.
 
 ## Swift 5.3
 

Sources/SwiftSyntax/DiagnosticConsumer.swift

@@ -12,6 +12,8 @@
 // This file provides the Diagnostic, Note, and FixIt types.
 //===----------------------------------------------------------------------===//
 
+import SwiftSyntax
+
 /// A FixIt represents a change to source code in order to "correct" a
 /// diagnostic.
 public enum FixIt: Codable, CustomDebugStringConvertible {
@@ -117,7 +119,7 @@ public struct Note: Codable {
   }
 
   /// Converts this Note to a Diagnostic for serialization.
-  func asDiagnostic() -> Diagnostic {
+  public func asDiagnostic() -> Diagnostic {
     return Diagnostic(message: message, location: location, notes: [],
                       highlights: highlights, fixIts: fixIts)
   }

Sources/SwiftSyntax/DiagnosticEngine.swift

@@ -58,16 +58,16 @@ public enum SyntaxParser {
   ///   - source: The source string to parse.
   ///   - parseTransition: Optional mechanism for incremental re-parsing.
   ///   - filenameForDiagnostics: Optional file name used for SourceLocation.
-  ///   - diagnosticEngine: Optional diagnotic engine to where the parser will
-  ///       emit diagnostics
+  ///   - diagnosticHandler: Optional callback that will be called for all
+  ///       diagnostics the parser emits
   /// - Returns: A top-level Syntax node representing the contents of the tree,
   ///            if the parse was successful.
   /// - Throws: `ParserError`
   public static func parse(
     source: String,
     parseTransition: IncrementalParseTransition? = nil,
     filenameForDiagnostics: String = "",
-    diagnosticEngine: DiagnosticEngine? = nil
+    diagnosticHandler: ((Diagnostic) -> Void)? = nil
   ) throws -> SourceFileSyntax {
     guard nodeHashVerifyResult && cnodeLayoutHashVerifyResult else {
       throw ParserError.parserCompatibilityCheckFailed
@@ -79,7 +79,7 @@ public enum SyntaxParser {
     utf8Source.makeContiguousUTF8()
 
     let rawSyntax = parseRaw(utf8Source, parseTransition, filenameForDiagnostics,
-                             diagnosticEngine)
+                             diagnosticHandler)
 
     let base = _SyntaxParserInterop.nodeFromRetainedOpaqueRawSyntax(rawSyntax)
     guard let file = base.as(SourceFileSyntax.self) else {
@@ -92,27 +92,27 @@ public enum SyntaxParser {
   ///
   /// - Parameters:
   ///   - url: The file URL to parse.
-  ///   - diagnosticEngine: Optional diagnotic engine to where the parser will
-  ///       emit diagnostics
+  ///   - diagnosticHandler: Optional callback that will be called for all
+  ///       diagnostics the parser emits
   /// - Returns: A top-level Syntax node representing the contents of the tree,
   ///            if the parse was successful.
   /// - Throws: `ParserError`
   public static func parse(_ url: URL,
-      diagnosticEngine: DiagnosticEngine? = nil) throws -> SourceFileSyntax {
+      diagnosticHandler: ((Diagnostic) -> Void)? = nil) throws -> SourceFileSyntax {
     // Avoid using `String(contentsOf:)` because it creates a wrapped NSString.
     let fileData = try Data(contentsOf: url)
     let source = fileData.withUnsafeBytes { buf in
       return String(decoding: buf.bindMemory(to: UInt8.self), as: UTF8.self)
     }
     return try parse(source: source, filenameForDiagnostics: url.path,
-                     diagnosticEngine: diagnosticEngine)
+                     diagnosticHandler: diagnosticHandler)
   }
 
   private static func parseRaw(
     _ source: String,
     _ parseTransition: IncrementalParseTransition?,
     _ filenameForDiagnostics: String,
-    _ diagnosticEngine: DiagnosticEngine?
+    _ diagnosticHandler: ((Diagnostic) -> Void)?
   ) -> CClientNode {
     precondition(source.isContiguousUTF8)
     let c_parser = swiftparse_parser_create()
@@ -144,18 +144,15 @@ public enum SyntaxParser {
     var pendingNotes: [Note] = []
     defer {
       // Consume the pending diagnostic if  present
-      if let diagnosticEngine = diagnosticEngine {
+      if let diagnosticHandler = diagnosticHandler {
         if let pendingDiag = pendingDiag {
-          diagnosticEngine.diagnose(Diagnostic(pendingDiag, pendingNotes))
+          diagnosticHandler(Diagnostic(pendingDiag, pendingNotes))
         }
       }
     }
     // Set up diagnostics consumer if requested by the caller.
-    if let diagnosticEngine = diagnosticEngine {
-      // If requested, we should set up a source location converter to calculate
-      // line and column.
-      let converter = diagnosticEngine.needsLineColumn ?
-        SourceLocationConverter(file: filenameForDiagnostics, source: source) : nil
+    if let diagnosticHandler = diagnosticHandler {
+      let converter = SourceLocationConverter(file: filenameForDiagnostics, source: source)
       let diagHandler = { (diag: CDiagnostic!) in
         // If the coming diagnostic is a note, we cache the pending note
         if swiftparse_diagnostic_get_severity(diag) ==
@@ -164,7 +161,7 @@ public enum SyntaxParser {
         } else {
           // Cosume the pending diagnostic
           if let pendingDiag = pendingDiag {
-            diagnosticEngine.diagnose(Diagnostic(pendingDiag, pendingNotes))
+            diagnosticHandler(Diagnostic(pendingDiag, pendingNotes))
             // Clear pending notes
             pendingNotes = []
           }