8000 Add a SyntaxVerifier to assert no unknown syntax in a fully parsed tree. by nkcsgexi · Pull Request #40 · swiftlang/swift-syntax · GitHub
[go: up one dir, main page]
Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 15, 2018
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
add a SyntaxVerifier to assert no unknown syntax in a fully parsed tree.
  • Loading branch information
@nkcsgexi
nkcsgexi committed Nov 15, 2018
commit ef680b01d29bda4ffd114bb01ec8bd9c952db37d
42 changes: 42 additions & 0 deletions Sources/SwiftSyntax/SyntaxRewriter.swift.gyb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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] = []
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nitpick: Don't capitalise variable names in Swift


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 {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You could just use optional binding here which get's rid of the force unwrap below

if let unknownNode = UnknownNodes.first {
  throw SyntaxVerifierError.unknownSyntaxFound(node: unknownNode)
}

throw SyntaxVerifierError.unknownSyntaxFound(node: UnknownNodes.first!)
}
}

private override init() {}

public static func verify(_ node: Syntax) throws {
try SyntaxVerifier().verify(node)
}
}
1 change: 1 addition & 0 deletions Tests/SwiftSyntaxTest/ParseFile.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
}())
}
}
7 changes: 5 additions & 2 deletions Tests/SwiftSyntaxTest/SyntaxFactory.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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))
}
}
0