Initial SwiftExtract version - a reusable Swift analysis module

Package.swift

@@ -43,6 +43,11 @@ let package = Package(
       targets: ["SwiftJavaConfigurationShared"]
     ),
 
+    .library(
+      name: "SwiftExtractConfigurationShared",
+      targets: ["SwiftExtractConfigurationShared"]
+    ),
+
     .library(
       name: "JavaUtil",
       targets: ["JavaUtil"]
@@ -108,6 +113,16 @@ let package = Package(
       targets: ["SwiftRuntimeFunctions"]
     ),
 
+    .library(
+      name: "SwiftExtract",
+      targets: ["SwiftExtract"]
+    ),
+
+    .library(
+      name: "CodePrinting",
+      targets: ["CodePrinting"]
+    ),
+
     .library(
       name: "JExtractSwiftLib",
       targets: ["JExtractSwiftLib"]
@@ -271,7 +286,14 @@ let package = Package(
     ),
 
     .target(
-      name: "SwiftJavaConfigurationShared"
+      name: "SwiftJavaConfigurationShared",
+      dependencies: [
+        "SwiftExtractConfigurationShared"
+      ]
+    ),
+
+    .target(
+      name: "SwiftExtractConfigurationShared"
     ),
 
     .target(
@@ -336,6 +358,33 @@ let package = Package(
       ]
     ),
 
+    .target(
+      name: "SwiftExtract",
+      dependencies: [
+        .product(name: "SwiftBasicFormat", package: "swift-syntax"),
+        .product(name: "SwiftIfConfig", package: "swift-syntax"),
+        .product(name: "SwiftLexicalLookup", package: "swift-syntax"),
+        .product(name: "SwiftParser", package: "swift-syntax"),
+        .product(name: "SwiftSyntax", package: "swift-syntax"),
+        .product(name: "SwiftSyntaxBuilder", package: "swift-syntax"),
+        .product(name: "Logging", package: "swift-log"),
+        "SwiftExtractConfigurationShared",
+      ],
+      path: "Sources/SwiftExtract",
+      resources: [
+        // Holds the `dummy.json` placeholder so SwiftPM emits a `Bundle.module`
+        // for this target. The real `static-build-config.json` is generated at
+        // build time by the `_StaticBuildConfigPlugin` build tool below.
+        .process("Resources")
+      ],
+      swiftSettings: [
+        .swiftLanguageMode(.v5)
+      ],
+      plugins: [
+        .plugin(name: "_StaticBuildConfigPlugin")
+      ]
+    ),
+
     .target(
       name: "JExtractSwiftLib",
       dependencies: [
@@ -347,19 +396,14 @@ let package = Package(
         .product(name: "ArgumentParser", package: "swift-argument-parser"),
         .product(name: "OrderedCollections", package: "swift-collections"),
         .product(name: "SwiftJavaJNICore", package: "swift-java-jni-core"),
+        "SwiftExtract",
         "SwiftJavaShared",
         "SwiftJavaConfigurationShared",
         "CodePrinting",
       ],
-      resources: [
-        .process("Resources")
-      ],
       swiftSettings: [
         .swiftLanguageMode(.v5),
         .enableUpcomingFeature("BareSlashRegexLiterals"),
-      ],
-      plugins: [
-        .plugin(name: "_StaticBuildConfigPlugin")
       ]
     ),
 
@@ -435,13 +479,30 @@ let package = Package(
       name: "JExtractSwiftTests",
       dependencies: [
         "JExtractSwiftLib",
+        "SwiftExtract",
         "CodePrinting",
       ],
       swiftSettings: [
         .swiftLanguageMode(.v5)
       ]
     ),
 
+    .testTarget(
+      name: "SwiftExtractTests",
+      dependencies: [
+        "SwiftExtract",
+        .product(name: "SwiftSyntax", package: "swift-syntax"),
+        .product(name: "SwiftParser", package: "swift-syntax"),
+      ]
+    ),
+
+    .testTarget(
+      name: "CodePrintingTests",
+      dependencies: [
+        "CodePrinting"
+      ]
+    ),
+
     .testTarget(
       name: "SwiftRuntimeFunctionsTests",
       dependencies: [

Plugins/PluginsShared/SwiftExtractConfigurationShared

@@ -0,0 +1 @@
+../../Sources/SwiftExtractConfigurationShared

Sources/CodePrinting/CodePrinter.swift

@@ -21,11 +21,23 @@ import Foundation
 // ==== -----------------------------------------------------------------------
 // MARK: CodePrinter
 
-public struct CodePrinter {
+public struct CodePrinter: Sendable {
   public var contents: String = ""
 
   public var verbose: Bool = false
 
+  /// When true, terminators of `.sloc` append a `// function @ file:line`
+  /// trailer to each line. Useful for debugging the generator. Downstream targets that compare
+  /// generated output against goldens can flip this off to get a clean
+  /// terminator equivalent to `.newLine`.
+  public var emitSourceLocations: Bool = true
+
+  /// Token used to start an inline comment. Defaults to `//` for Swift- and
+  /// Java-style output. Hash-comment languages can flip this to `.hash` so
+  /// source-location trailers, `printSeparator` banners, and echo-mode
+  /// headers render with the right comment lead.
+  public var inlineCommentStyle: InlineCommentStyle = .slashSlash
+
   public var indentationDepth: Int = 0 {
     didSet {
       indentationText = String(repeating: indentationPart, count: indentationDepth)
@@ -49,12 +61,16 @@ public struct CodePrinter {
   }
 
   public var mode: PrintMode
-  public enum PrintMode {
+  public enum PrintMode: Sendable {
     case accumulateAll
     case flushToFileOnWrite
   }
-  public init(mode: PrintMode = .flushToFileOnWrite) {
+  public init(
+    mode: PrintMode = .flushToFileOnWrite,
+    inlineCommentStyle: InlineCommentStyle = .slashSlash
+  ) {
     self.mode = mode
+    self.inlineCommentStyle = inlineCommentStyle
   }
 
   public mutating func append(_ text: String) {
@@ -167,7 +183,11 @@ public struct CodePrinter {
     }
 
     if terminator == .sloc {
-      append(" // \(function) @ \(file):\(line)\n")
+      if emitSourceLocations {
+        append(" \(inlineCommentStyle.rawValue) \(function) @ \(file):\(line)\n")
+      } else {
+        append("\n")
+      }
       atNewline = true
     } else {
       append(terminator.rawValue)
@@ -181,11 +201,12 @@ public struct CodePrinter {
 
   public mutating func printSeparator(_ text: String) {
     assert(!text.contains(where: \.isNewline))
+    let lead = inlineCommentStyle.rawValue
     print(
       """
 
-      // ==== --------------------------------------------------
-      // \(text)
+      \(lead) ==== --------------------------------------------------
+      \(lead) \(text)
 
       """
     )
@@ -215,10 +236,22 @@ public struct CodePrinter {
   }
 }
 
+// ==== -----------------------------------------------------------------------
+// MARK: InlineCommentStyle
+
+/// Inline comment lead used by `CodePrinter` for source-location trailers,
+/// `printSeparator` banners, and echo-mode headers. Swift, Java, and other
+/// `//`-comment languages use `.slashSlash`; hash-comment languages use
+/// `.hash`.
+public enum InlineCommentStyle: String, Sendable {
+  case slashSlash = "//"
+  case hash = "#"
+}
+
 // ==== -----------------------------------------------------------------------
 // MARK: PrinterTerminator
 
-public enum PrinterTerminator: String {
+public enum PrinterTerminator: String, Sendable {
   case newLine = "\n"
   case space = " "
   case commaSpace = ", "
@@ -285,19 +318,20 @@ extension CodePrinter {
       // if we're accumulating everything, we don't want to finalize/flush
       // any contents; let's mark that this is where a write would have
       // happened though:
-      print("// ^^^^ Contents of: \(outputDirectory)\(PATH_SEPARATOR)\(filename)")
+      print("\(inlineCommentStyle.rawValue) ^^^^ Contents of: \(outputDirectory)\(PATH_SEPARATOR)\(filename)")
       return nil
     }
 
     let contents = finalize()
     if outputDirectory == "-" {
+      let lead = inlineCommentStyle.rawValue
       print(
-        "// ==== ---------------------------------------------------------------------------------------------------"
+        "\(lead) ==== ---------------------------------------------------------------------------------------------------"
       )
       if let javaPackagePath {
-        print("// \(javaPackagePath)\(PATH_SEPARATOR)\(filename)")
+        print("\(lead) \(javaPackagePath)\(PATH_SEPARATOR)\(filename)")
       } else {
-        print("// \(filename)")
+        print("\(lead) \(filename)")
       }
       print(contents)
       return nil

Sources/JExtractSwiftLib/Common/JavaTypeAnnotations.swift

@@ -12,6 +12,7 @@
 //
 //===----------------------------------------------------------------------===//
 
+import SwiftExtract
 import SwiftJavaConfigurationShared
 import SwiftJavaJNICore
 

Sources/JExtractSwiftLib/Configuration+SwiftExtract.swift

@@ -0,0 +1,25 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2024-2026 Apple Inc. and the Swift.org project authors
+// Licensed under Apache License v2.0
+//
+// See LICENSE.txt for license information
+// See CONTRIBUTORS.txt for the list of Swift.org project authors
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+//===----------------------------------------------------------------------===//
+
+import SwiftExtract
+import SwiftJavaConfigurationShared
+
+/// `Configuration` already exposes every property the analysis layer needs
+/// (`swiftModule`, `swiftFilterInclude`, `effectiveMinimumInputAccessLevelMode`,
+/// `logLevel`, …) — `LogLevel` and `AccessLevelMode` are the same enums on
+/// both sides, both pulled in from `SwiftExtractConfigurationShared`. The
+/// protocol extension on `SwiftExtractConfiguration` defaults
+/// `availableImportModules` and `allowUnresolvedTypeReferences`, so this
+/// conformance is empty.
+extension Configuration: SwiftExtractConfiguration {}

Sources/JExtractSwiftLib/Convenience/JavaType+Extensions.swift

@@ -12,6 +12,7 @@
 //
 //===----------------------------------------------------------------------===//
 
+import SwiftExtract
 import SwiftJavaJNICore
 
 extension JavaType {

Sources/JExtractSwiftLib/Convenience/String+Extensions.swift → Sources/JExtractSwiftLib/Convenience/String+JNIExtensions.swift

@@ -15,34 +15,7 @@
 import SwiftJavaJNICore
 
 extension String {
-
-  var firstCharacterUppercased: String {
-    guard let f = first else {
-      return self
-    }
-
-    return "\(f.uppercased())\(String(dropFirst()))"
-  }
-
-  var firstCharacterLowercased: String {
-    guard let f = first else {
-      return self
-    }
-
-    return "\(f.lowercased())\(String(dropFirst()))"
-  }
-
-  /// Returns whether the string is of the format `isX`
-  var hasJavaBooleanNamingConvention: Bool {
-    guard self.hasPrefix("is"), self.count > 2 else {
-      return false
-    }
-
-    let thirdCharacterIndex = self.index(self.startIndex, offsetBy: 2)
-    return self[thirdCharacterIndex].isUppercase
-  }
-
-  /// Returns a version of the string correctly escaped for a JNI
+  /// Returns a version of the string correctly escaped for a JNI identifier
   var escapedJNIIdentifier: String {
     self.map {
       if $0 == "_" {
@@ -66,15 +39,6 @@ extension String {
     .joined()
   }
 
-  /// If the string ends with `.swift`, return it without that suffix;
-  /// otherwise return self unchanged
-  func dropSwiftFileSuffix() -> String {
-    if hasSuffix(".swift") {
-      return String(dropLast(".swift".count))
-    }
-    return self
-  }
-
   /// Looks up self as a SwiftJava wrapped class name and converts it
   /// into a `JavaType.class` if it exists in `lookupTable`.
   func parseJavaClassFromSwiftJavaName(in lookupTable: [String: String]) -> JavaType? {
@@ -87,14 +51,6 @@ extension String {
 
     return .class(package: javaPackageName, name: javaClassName)
   }
-
-  /// Unescapes the name if it is surrounded by backticks.
-  var unescapedSwiftName: String {
-    if count >= 2 && hasPrefix("`") && hasSuffix("`") {
-      return String(dropFirst().dropLast())
-    }
-    return self
-  }
 }
 
 extension Array where Element == String {