Review CompilationDatabase.swift

Author: ahoppen

Sources/BuildSystemIntegration/CompilationDatabase.swift

@@ -25,7 +25,7 @@ import func TSCBasic.resolveSymlinks
 /// A single compilation database command.
 ///
 /// See https://clang.llvm.org/docs/JSONCompilationDatabase.html
-package struct CompilationDatabaseCompileCommand: Equatable {
+package struct CompilationDatabaseCompileCommand: Equatable, Codable {
 
   /// The working directory for the compilation.
   package var directory: String
@@ -45,9 +45,40 @@ package struct CompilationDatabaseCompileCommand: Equatable {
     self.commandLine = commandLine
     self.output = output
   }
-}
 
-extension CompilationDatabase.Command {
+  private enum CodingKeys: String, CodingKey {
+    case directory
+    case file
+    case command
+    case arguments
+    case output
+  }
+
+  package init(from decoder: Decoder) throws {
+    let container = try decoder.container(keyedBy: CodingKeys.self)
+    self.directory = try container.decode(String.self, forKey: .directory)
+    self.filename = try container.decode(String.self, forKey: .file)
+    self.output = try container.decodeIfPresent(String.self, forKey: .output)
+    if let arguments = try container.decodeIfPresent([String].self, forKey: .arguments) {
+      self.commandLine = arguments
+    } else if let command = try container.decodeIfPresent(String.self, forKey: .command) {
+      #if os(Windows)
+      self.commandLine = splitWindowsCommandLine(command, initialCommandName: true)
+      #else
+      self.commandLine = splitShellEscapedCommand(command)
+      #endif
+    } else {
+      throw CompilationDatabaseDecodingError.missingCommandOrArguments
+    }
+  }
+
+  package func encode(to encoder: Encoder) throws {
+    var container = encoder.container(keyedBy: CodingKeys.self)
+    try container.encode(directory, forKey: .directory)
+    try container.encode(filename, forKey: .file)
+    try container.encode(commandLine, forKey: .arguments)
+    try container.encodeIfPresent(output, forKey: .output)
+  }
 
   /// The `DocumentURI` for this file. If `filename` is relative and `directory` is
   /// absolute, returns the concatenation. However, if both paths are relative,
@@ -124,9 +155,7 @@ package struct FixedCompilationDatabase: CompilationDatabase, Equatable {
       SourceItem(uri: URI(filePath: directory, isDirectory: true), kind: .directory, generated: false)
     ]
   }
-}
 
-extension FixedCompilationDatabase {
   /// Loads the compilation database located in `directory`, if any.
   /// - Returns: `nil` if `compile_flags.txt` was not found
   package init?(directory: AbsolutePath, _ fileSystem: FileSystem = localFileSystem) throws {
@@ -173,16 +202,48 @@ extension FixedCompilationDatabase {
 /// ```
 ///
 /// See https://clang.llvm.org/docs/JSONCompilationDatabase.html
-package struct JSONCompilationDatabase: CompilationDatabase, Equatable {
-  var pathToCommands: [DocumentURI: [Int]] = [:]
-  var commands: [CompilationDatabaseCompileCommand] = []
+package struct JSONCompilationDatabase: CompilationDatabase, Equatable, Codable {
+  private var pathToCommands: [DocumentURI: [Int]] = [:]
+  private var commands: [CompilationDatabaseCompileCommand] = []
 
   package init(_ commands: [CompilationDatabaseCompileCommand] = []) {
     for command in commands {
       add(command)
     }
   }
 
+  package init(from decoder: Decoder) throws {
+    var container = try decoder.unkeyedContainer()
+    while !container.isAtEnd {
+      self.add(try container.decode(Command.self))
+    }
+  }
+
+  /// Loads the compilation database located in `directory`, if any.
+  ///
+  /// - Returns: `nil` if `compile_commands.json` was not found
+  package init?(directory: AbsolutePath, _ fileSystem: FileSystem = localFileSystem) throws {
+    let path = directory.appending(component: "compile_commands.json")
+    try self.init(file: path, fileSystem)
+  }
+
+  /// Loads the compilation database from `file`
+  /// - Returns: `nil` if the file does not exist
+  package init?(file: AbsolutePath, _ fileSystem: FileSystem = localFileSystem) throws {
+    guard fileSystem.exists(file) else {
+      return nil
+    }
+    let bytes = try fileSystem.readFileContents(file)
+    try bytes.withUnsafeData { data in
+      self = try JSONDecoder().decode(JSONCompilationDatabase.self, from: data)
+    }
+  }
+
+  package func encode(to encoder: Encoder) throws {
+    var container = encoder.unkeyedContainer()
+    try commands.forEach { try container.encode($0) }
+  }
+
   package subscript(_ uri: DocumentURI) -> [CompilationDatabaseCompileCommand] {
     if let indices = pathToCommands[uri] {
       return indices.map { commands[$0] }
@@ -199,7 +260,7 @@ package struct JSONCompilationDatabase: CompilationDatabase, Equatable {
     }
   }
 
-  package mutating func add(_ command: CompilationDatabaseCompileCommand) {
+  private mutating func add(_ command: CompilationDatabaseCompileCommand) {
     let uri = command.uri
     pathToCommands[uri, default: []].append(commands.count)
 
@@ -216,79 +277,7 @@ package struct JSONCompilationDatabase: CompilationDatabase, Equatable {
   }
 }
 
-extension JSONCompilationDatabase: Codable {
-  package init(from decoder: Decoder) throws {
-    var container = try decoder.unkeyedContainer()
-    while !container.isAtEnd {
-      self.add(try container.decode(Command.self))
-    }
-  }
-
-  package func encode(to encoder: Encoder) throws {
-    var container = encoder.unkeyedContainer()
-    try commands.forEach { try container.encode($0) }
-  }
-}
-
-extension JSONCompilationDatabase {
-  /// Loads the compilation database located in `directory`, if any.
-  ///
-  /// - Returns: `nil` if `compile_commands.json` was not found
-  package init?(directory: AbsolutePath, _ fileSystem: FileSystem = localFileSystem) throws {
-    let path = directory.appending(component: "compile_commands.json")
-    try self.init(file: path, fileSystem)
-  }
-
-  /// Loads the compilation database from `file`
-  /// - Returns: `nil` if the file does not exist
-  package init?(file: AbsolutePath, _ fileSystem: FileSystem = localFileSystem) throws {
-    guard fileSystem.exists(file) else {
-      return nil
-    }
-    let bytes = try fileSystem.readFileContents(file)
-    try bytes.withUnsafeData { data in
-      self = try JSONDecoder().decode(JSONCompilationDatabase.self, from: data)
-    }
-  }
-}
-
 enum CompilationDatabaseDecodingError: Error {
   case missingCommandOrArguments
   case fixedDatabaseDecodingError
 }
-
-extension CompilationDatabase.Command: Codable {
-  private enum CodingKeys: String, CodingKey {
-    case directory
-    case file
-    case command
-    case arguments
-    case output
-  }
-
-  package init(from decoder: Decoder) throws {
-    let container = try decoder.container(keyedBy: CodingKeys.self)
-    self.directory = try container.decode(String.self, forKey: .directory)
-    self.filename = try container.decode(String.self, forKey: .file)
-    self.output = try container.decodeIfPresent(String.self, forKey: .output)
-    if let arguments = try container.decodeIfPresent([String].self, forKey: .arguments) {
-      self.commandLine = arguments
-    } else if let command = try container.decodeIfPresent(String.self, forKey: .command) {
-      #if os(Windows)
-      self.commandLine = splitWindowsCommandLine(command, initialCommandName: true)
-      #else
-      self.commandLine = splitShellEscapedCommand(command)
-      #endif
-    } else {
-      throw CompilationDatabaseDecodingError.missingCommandOrArguments
-    }
-  }
-
-  package func encode(to encoder: Encoder) throws {
-    var container = encoder.container(keyedBy: CodingKeys.self)
-    try container.encode(directory, forKey: .directory)
-    try container.encode(filename, forKey: .file)
-    try container.encode(commandLine, forKey: .arguments)
-    try container.encodeIfPresent(output, forKey: .output)
-  }
-}