Merge pull request #976 from CodaFi/locavore

Bridge Parser Diagnostics into the C++ Diagnostic Engine

Author: CodaFi

Sources/SwiftCompilerSupport/ConsistencyCheck.swift

@@ -34,12 +34,16 @@ extension Syntax {
 ///   - flags: Flags that indicate what checks should be performed.
 ///       0x01: Perform round-trip checking.
 ///       0x02: Check for parser diagnostics.
+///   - hookCtx: A caller-provided context parameter to be passed back in the diagnostic hook.
+///   - diagnosticHook: A callback invoked once per diagnostic emitted by the parser.
 /// - Returns: 0 if all requested consistency checks passed, nonzero otherwise.
 @_cdecl("swift_parser_consistencyCheck")
 @_spi(SwiftCompiler)
 public func _parserConsistencyCheck(
   bufferPtr: UnsafePointer<UInt8>, bufferLength: Int,
-  filename: UnsafePointer<UInt8>, flags: CUnsignedInt
+  filename: UnsafePointer<UInt8>, flags: CUnsignedInt,
+  hookCtx: OpaquePointer,
+  diagnosticHook: @convention(c) (Int, UnsafePointer<Int8>, OpaquePointer) -> Void
 ) -> CInt {
   let buffer = UnsafeBufferPointer<UInt8>(
     start: bufferPtr, count: bufferLength)
@@ -62,7 +66,6 @@ public func _parserConsistencyCheck(
       var anyDiags = false
 
       let sourceFile = Syntax(raw: rawSourceFile.raw).as(SourceFileSyntax.self)!
-
       let diags = ParseDiagnosticsGenerator.diagnostics(
         for: sourceFile)
       for diag in diags {
@@ -73,7 +76,9 @@ public func _parserConsistencyCheck(
           continue
         }
 
-        print("\(String(cString: filename)): error: \(diag.debugDescription)")
+        diag.message.withCString { diagText in
+          diagnosticHook(diag.position.utf8Offset, diagText, hookCtx)
+        }
         anyDiags = true
       }
 

Sources/SwiftCompilerSupport/SwiftCompilerSupport.h

@@ -32,6 +32,10 @@ enum SwiftConsistencyCheckFlags {
   SCC_FoldSequences = 0x04,
 };
 
+/// A callback function that is called once per emitted diagnostic with a
+/// byte offset and message text.
+typedef void (*swift_parser_diagnostic_hook_t)(ptrdiff_t off, const char *text, void *ctx);
+
 /// Entry point for the Swift compiler to use for consistency checking.
 ///
 /// - Parameters:
@@ -40,10 +44,13 @@ enum SwiftConsistencyCheckFlags {
 ///   - filename: The name of the source file, which is used only for diagnostics
 ///   - flags: Flags that indicate what checks should be performed.
 ///       0x01: Perform round-trip checking.
+///   - hookCtx: A caller-provided context parameter to be passed back in the diagnostic hook.
+///   - diagnosticHook: A callback invoked once per diagnostic emitted by the parser.
 /// - Returns: 0 if all requested consistency checks passed, nonzero otherwise.
 int swift_parser_consistencyCheck(
   const char *buffer, ptrdiff_t bufferLength, const char *filename,
-  unsigned int flags);
+  unsigned int flags,
+  void *hookCtx, swift_parser_diagnostic_hook_t hook);
 
 #ifdef __cplusplus
 }