Merge pull request swiftlang#40 from nkcsgexi/verifier

Add a SyntaxVerifier to assert no unknown syntax in a fully parsed tree.

Author: nkcsgexi

Sources/SwiftSyntax/SyntaxRewriter.swift.gyb

@@ -256,3 +256,45 @@ extension Syntax {
     data.raw.accept(RawSyntaxVisitor(visitor, self))
   }
 }
+
+public enum SyntaxVerifierError: Error, CustomStringConvertible {
+  case unknownSyntaxFound(node: Syntax)
+
+  public var description: String {
+    switch self {
+      case .unknownSyntaxFound(let node):
+        return "unknown syntax node for \"\(node)\""
+    }
+  }
+}
+
+public class SyntaxVerifier: SyntaxVisitor {
+
+  var UnknownNodes: [Syntax] = []
+
+  override public func shouldVisit(_ node: SyntaxKind) -> Bool {
+    return node.isUnknown
+  }
+
+  override public func shouldVisit(_ node: TokenKind) -> Bool {
+    return false
+  }
+
+  override public func visitPre(_ node: Syntax) {
+    assert(node.isUnknown)
+    UnknownNodes.append(node)
+  }
+
+  private func verify(_ node: Syntax) throws {
+    node.walk(self)
+    if !UnknownNodes.isEmpty {
+      throw SyntaxVerifierError.unknownSyntaxFound(node: UnknownNodes.first!)
+    }
+  }
+
+  private override init() {}
+
+  public static func verify(_ node: Syntax) throws {
+    try SyntaxVerifier().verify(node)
+  }
+}

Tests/SwiftSyntaxTest/ParseFile.swift

@@ -30,6 +30,7 @@ public class ParseFileTestCase: XCTestCase {
       let fileContents = try String(contentsOf: currentFile)
       let parsed = try SyntaxTreeParser.parse(currentFile)
       XCTAssertEqual("\(parsed)", fileContents)
+      try SyntaxVerifier.verify(parsed)
     }())
   }
 }

Tests/SwiftSyntaxTest/SyntaxFactory.swift

@@ -120,7 +120,10 @@ public class SyntaxFactoryAPITestCase: XCTestCase {
   public func testUnknownSyntax() {
     let expr = SyntaxFactory.makeStringLiteralExpr("Hello, world!")
     XCTAssertFalse(expr.isUnknown)
-    XCTAssertTrue(SyntaxFactory.makeUnknownSyntax(
-      tokens: [SyntaxFactory.makeLeftBraceToken()]).isUnknown)
+    let unknown = SyntaxFactory.makeUnknownSyntax(
+      tokens: [SyntaxFactory.makeLeftBraceToken()])
+    XCTAssertTrue(unknown.isUnknown)
+    XCTAssertNoThrow(try SyntaxVerifier.verify(expr))
+    XCTAssertThrowsError(try SyntaxVerifier.verify(unknown))
   }
 }