Declare a FileCheck Tool

Author: CodaFi

.gitignore

@@ -40,6 +40,7 @@ playground.xcworkspace
 # Add this line if you want to avoid checking in source code from Swift Package Manager dependencies.
 # Packages/
 .build/
+.swiftpm/
 
 # CocoaPods
 #

Package.swift

@@ -5,13 +5,22 @@ import PackageDescription
 let package = Package(
   name: "FileCheck",
   products: [
+    .executable(name: "filecheck",
+                targets: ["filecheck-tool"]),
     .library(
       name: "FileCheck",
       targets: ["FileCheck"]),
   ],
+  dependencies: [
+    .package(url: "https://github.com/apple/swift-package-manager.git", from: "0.1.0"),
+    .package(url: "https://github.com/onevcat/Rainbow.git", from: "3.0.0"),
+  ],
   targets: [
     .target(
       name: "FileCheck"),
+    .target(
+      name: "filecheck-tool",
+      dependencies: ["FileCheck", "SPMUtility", "Rainbow"]),
     .testTarget(
       name: "FileCheckTests",
       dependencies: ["FileCheck"]),

Sources/FileCheck/CheckString.swift

@@ -133,12 +133,6 @@ struct CheckString {
     }
 
     // Count the number of newlines between the previous match and this one.
-    //	  assert(Buffer.data() !=
-    //				 SM.getMemoryBuffer(SM.FindBufferContainingLoc(
-    //										SMLoc::getFromPointer(Buffer.data())))
-    //					 ->getBufferStart() &&
-    //			 "CHECK-SAME can't be the first check in a file")
-
     if countNewlines(in: buffer).count != 0 {
       diagnose(.error,
                at: self.location,
@@ -166,11 +160,6 @@ struct CheckString {
     }
 
     // Count the number of newlines between the previous match and this one.
-    //	  assert(Buffer.data() !=
-    //				 SM.getMemoryBuffer(SM.FindBufferContainingLoc(
-    //										SMLoc::getFromPointer(Buffer.data())))
-    //					 ->getBufferStart(), "CHECK-NEXT can't be the first check in a file")
-
     let (numNewLines, firstNewLine) = countNewlines(in: buffer)
     if numNewLines == 0 {
       diagnose(.error, at: self.location, with: prefix + "-NEXT: is on the same line as previous match", options: options)

Sources/filecheck-tool/main.swift

@@ -0,0 +1,103 @@
+import Foundation
+import Basic
+import SPMUtility
+import FileCheck
+import Rainbow
+
+func run() -> Int {
+  let cli = ArgumentParser(usage: "FileCheck", overview: "")
+  let binder = ArgumentBinder<FileCheckOptions>()
+  //swiftlint:disable statement_position
+  binder.bind(option:
+    cli.add(option: "--disable-colors", kind: Bool.self,
+            usage: "Disable colorized diagnostics"),
+              to: { if $1 { $0.insert(.disableColors) }
+              else { $0.remove(.disableColors) } })
+  binder.bind(option:
+    cli.add(option: "--use-strict-whitespace",
+            kind: Bool.self,
+            usage: "Do not treat all horizontal whitespace as equivalent"),
+              to: { if $1 { $0.insert(.strictWhitespace) }
+              else { $0.remove(.strictWhitespace) } })
+  binder.bind(option:
+    cli.add(option: "--allow-empty-input", shortName: "-e",
+            kind: Bool.self,
+            usage: """
+                   Allow the input file to be empty. This is useful when \
+                   making checks that some error message does not occur, \
+                   for example.
+                   """),
+              to: { if $1 { $0.insert(.allowEmptyInput) }
+              else { $0.remove(.allowEmptyInput) } })
+  binder.bind(option:
+    cli.add(option: "--match-full-lines",
+            kind: Bool.self,
+            usage: """
+                   Require all positive matches to cover an entire input line. \
+                   Allows leading and trailing whitespace if \
+                   --strict-whitespace is not also used.
+                   """),
+              to: { if $1 { $0.insert(.matchFullLines) }
+              else { $0.remove(.matchFullLines) } })
+  let prefixes =
+    cli.add(option: "--prefixes", kind: [String].self,
+            usage: """
+                   Specifies one or more prefixes to match. By default these \
+                   patterns are prefixed with “CHECK”.
+                   """)
+
+  let inputFile =
+    cli.add(option: "--input-file", shortName: "-i",
+            kind: String.self,
+            usage: "The file to use for checked input. Defaults to stdin.")
+
+  let file =
+    cli.add(positional: "", kind: String.self,
+            usage: "")
+
+  let args = Array(CommandLine.arguments.dropFirst())
+  guard let results = try? cli.parse(args) else {
+    cli.printUsage(on: stderrStream)
+    return -1
+  }
+
+  guard let filePath = results.get(file) else {
+    print("FileCheck error: No input file was provided.")
+    return -1
+  }
+
+  var options = FileCheckOptions()
+  do {
+    try binder.fill(parseResult: results, into: &options)
+  } catch {
+    cli.printUsage(on: stderrStream)
+    return -1
+  }
+  Rainbow.enabled = !options.contains(.disableColors)
+
+  let fileHandle: FileHandle
+  if let input = results.get(inputFile) {
+    guard let handle = FileHandle(forReadingAtPath: input) else {
+      print("FileCheck error: unable to open check file at path \(inputFile).")
+      return -1
+    }
+    fileHandle = handle
+  } else {
+    fileHandle = .standardInput
+  }
+  var checkPrefixes = results.get(prefixes) ?? []
+  checkPrefixes.append("CHECK")
+
+  let matchedAll = fileCheckOutput(of: .stdout,
+                                   withPrefixes: checkPrefixes,
+                                   checkNot: [],
+                                   against: .filePath(filePath),
+                                   options: options) {
+    // FIXME: Better way to stream this data?
+    FileHandle.standardOutput.write(fileHandle.readDataToEndOfFile())
+  }
+
+  return matchedAll ? 0 : -1
+}
+
+exit(Int32(run()))