Merge pull request #200 from dylansturg/faster_context_parsing

Use string based SourceLocationConverter init because it's faster.

Author: allevato

Sources/SwiftFormat/SwiftFormatter.swift

@@ -58,7 +58,8 @@ public final class SwiftFormatter {
       throw SwiftFormatError.isDirectory
     }
     let sourceFile = try SyntaxParser.parse(url)
-    try format(syntax: sourceFile, assumingFileURL: url, to: &outputStream)
+    let source = try String(contentsOf: url, encoding: .utf8)
+    try format(syntax: sourceFile, assumingFileURL: url, source: source, to: &outputStream)
   }
 
   /// Formats the given Swift source code and writes the result to an output stream.
@@ -75,11 +76,13 @@ public final class SwiftFormatter {
     source: String, assumingFileURL url: URL?, to outputStream: inout Output
   ) throws {
     let sourceFile = try SyntaxParser.parse(source: source)
-    try format(syntax: sourceFile, assumingFileURL: url, to: &outputStream)
+    try format(syntax: sourceFile, assumingFileURL: url, source: source, to: &outputStream)
   }
 
   /// Formats the given Swift syntax tree and writes the result to an output stream.
   ///
+  /// - Note: The formatter may be faster using the source text, if it's available.
+  ///
   /// - Parameters:
   ///   - syntax: The Swift syntax tree to be converted to source code and formatted.
   ///   - url: A file URL denoting the filename/path that should be assumed for this syntax tree,
@@ -90,6 +93,13 @@ public final class SwiftFormatter {
   /// - Throws: If an unrecoverable error occurs when formatting the code.
   public func format<Output: TextOutputStream>(
     syntax: SourceFileSyntax, assumingFileURL url: URL?, to outputStream: inout Output
+  ) throws {
+    try format(syntax: syntax, assumingFileURL: url, source: nil, to: &outputStream)
+  }
+
+  private func format<Output: TextOutputStream>(
+    syntax: SourceFileSyntax, assumingFileURL url: URL?, source: String?,
+    to outputStream: inout Output
   ) throws {
     if let position = firstInvalidSyntaxPosition(in: Syntax(syntax)) {
       throw SwiftFormatError.fileContainsInvalidSyntax(position: position)
@@ -98,7 +108,7 @@ public final class SwiftFormatter {
     let assumedURL = url ?? URL(fileURLWithPath: "source")
     let context = Context(
       configuration: configuration, diagnosticEngine: diagnosticEngine, fileURL: assumedURL,
-      sourceFileSyntax: syntax)
+      sourceFileSyntax: syntax, source: source)
     let pipeline = FormatPipeline(context: context)
     let transformedSyntax = pipeline.visit(Syntax(syntax))
 

Sources/SwiftFormat/SwiftLinter.swift

@@ -54,7 +54,8 @@ public final class SwiftLinter {
       throw SwiftFormatError.isDirectory
     }
     let sourceFile = try SyntaxParser.parse(url)
-    try lint(syntax: sourceFile, assumingFileURL: url)
+    let source = try String(contentsOf: url, encoding: .utf8)
+    try lint(syntax: sourceFile, assumingFileURL: url, source: source)
   }
 
   /// Lints the given Swift source code.
@@ -65,23 +66,29 @@ public final class SwiftLinter {
   /// - Throws: If an unrecoverable error occurs when formatting the code.
   public func lint(source: String, assumingFileURL url: URL) throws {
     let sourceFile = try SyntaxParser.parse(source: source)
-    try lint(syntax: sourceFile, assumingFileURL: url)
+    try lint(syntax: sourceFile, assumingFileURL: url, source: source)
   }
 
   /// Lints the given Swift syntax tree.
   ///
+  /// - Note: The linter may be faster using the source text, if it's available.
+  ///
   /// - Parameters:
   ///   - syntax: The Swift syntax tree to be converted to be linted.
   ///   - url: A file URL denoting the filename/path that should be assumed for this syntax tree.
   /// - Throws: If an unrecoverable error occurs when formatting the code.
   public func lint(syntax: SourceFileSyntax, assumingFileURL url: URL) throws {
+    try lint(syntax: syntax, assumingFileURL: url, source: nil)
+  }
+
+  private func lint(syntax: SourceFileSyntax, assumingFileURL url: URL, source: String?) throws {
     if let position = firstInvalidSyntaxPosition(in: Syntax(syntax)) {
       throw SwiftFormatError.fileContainsInvalidSyntax(position: position)
     }
-    
+
     let context = Context(
       configuration: configuration, diagnosticEngine: diagnosticEngine, fileURL: url,
-      sourceFileSyntax: syntax)
+      sourceFileSyntax: syntax, source: source)
     let pipeline = LintPipeline(context: context)
     pipeline.walk(Syntax(syntax))
 

Sources/SwiftFormatCore/Context.swift

@@ -57,14 +57,16 @@ public class Context {
     configuration: Configuration,
     diagnosticEngine: DiagnosticEngine?,
     fileURL: URL,
-    sourceFileSyntax: SourceFileSyntax
+    sourceFileSyntax: SourceFileSyntax,
+    source: String? = nil
   ) {
     self.configuration = configuration
     self.diagnosticEngine = diagnosticEngine
     self.fileURL = fileURL
     self.importsXCTest = .notDetermined
-    self.sourceLocationConverter = SourceLocationConverter(
-      file: fileURL.path, tree: sourceFileSyntax)
+    self.sourceLocationConverter =
+      source.map { SourceLocationConverter(file: fileURL.path, source: $0) }
+      ?? SourceLocationConverter(file: fileURL.path, tree: sourceFileSyntax)
     self.ruleMask = RuleMask(
       syntaxNode: Syntax(sourceFileSyntax),
       sourceLocationConverter: sourceLocationConverter