[SwiftCompiler] Use bridged DiagnosticEngine to emit regex literal parsing

WIP

Author: rintaro

SwiftCompilerSources/CMakeLists.txt

@@ -83,6 +83,10 @@ function(add_swift_compiler_modules_library name)
     list(APPEND swift_compile_options "-O" "-cross-module-optimization")
   endif()
 
+  if(SWIFT_ENABLE_EXPERIMENTAL_STRING_PROCESSING)
+    list(APPEND swift_compile_options "-D" "SWIFT_ENABLE_EXPERIMENTAL_STRING_PROCESSING")
+  endif()
+
   get_bootstrapping_path(build_dir ${CMAKE_CURRENT_BINARY_DIR} "${ALS_BOOTSTRAPPING}")
 
   set(sdk_option "")
@@ -251,3 +255,12 @@ else()
 
 endif()
 
+# Configure SwiftPM package.
+
+set(swiftcompiler_source_dir_name "_Sources")
+configure_file(Package.swift.in
+  "${CMAKE_CURRENT_BINARY_DIR}/Package.swift" @ONLY)
+# SwiftPM requires all sources are inside the directory of 'Package.swift'.
+execute_process(COMMAND
+  "${CMAKE_COMMAND}" -E create_symlink
+  "${CMAKE_CURRENT_SOURCE_DIR}/Sources" "${CMAKE_CURRENT_BINARY_DIR}/${swiftcompiler_source_dir_name}")

SwiftCompilerSources/Package.swift

@@ -0,0 +1,68 @@
+// swift-tools-version:5.3
+//===--- Package.swift.in - SwiftCompiler SwiftPM package -----------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2022 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+// NOTE: This 'Package.swift.in' file is for CMake configure_file().
+// Generated 'Package.swift' can be found in
+// '${swift_build_dir}/SwiftCompilerSources/Package.swift'.
+
+
+import PackageDescription
+
+var swiftSettings: [SwiftSetting] = [
+  .unsafeFlags([
+    "-Xfrontend", "-validate-tbd-against-ir=none",
+    "-Xfrontend", "-enable-cxx-interop",
+    // Bridging modules and headers
+    "-Xcc", "-I", "-Xcc", "@SWIFT_SOURCE_DIR@/include",
+    // Generated C headers
+    "-Xcc", "-I", "-Xcc", "@CMAKE_BINARY_DIR@/include",
+    "-cross-module-optimization"
+  ]),
+]
+
+if "@SWIFT_ENABLE_EXPERIMENTAL_STRING_PROCESSING@" == "TRUE" {
+  swiftSettings.append(.define("SWIFT_ENABLE_EXPERIMENTAL_STRING_PROCESSING"))
+}
+
+func getTarget(_ name: String, dependencies: [Target.Dependency]) -> Target {
+  .target(
+    name: name,
+    dependencies: dependencies, 
+    path: "@swiftcompiler_source_dir_name@/\(name)",
+    exclude: ["CMakeLists.txt"],
+    swiftSettings: swiftSettings)
+}
+
+let package = Package(
+  name: "SwiftCompilerSources",
+  platforms: [
+    .macOS("10.9"),
+  ],
+  products: [
+    .library(
+      name: "SwiftCompiler",
+      type: .static,
+      targets: ["Basic", "AST", "Parse", "SIL", "Optimizer"]),
+  ],
+  dependencies: [
+  ],
+  // Note that all modules must be added to LIBSWIFT_MODULES in the top-level
+  // CMakeLists.txt file to get debugging working.
+  targets: [
+    getTarget("Basic", dependencies: []),
+    getTarget("AST", dependencies: ["Basic"]),
+    getTarget("Parse", dependencies: ["Basic", "AST"]),
+    getTarget("SIL", dependencies: ["Basic"]),
+    getTarget("Optimizer", dependencies: ["Basic", "SIL", "Parse"]),
+  ]
+)

SwiftCompilerSources/Package.swift.in

@@ -10,8 +10,6 @@
 
 add_subdirectory(Basic)
 add_subdirectory(AST)
-if(SWIFT_ENABLE_EXPERIMENTAL_STRING_PROCESSING)
-  add_subdirectory(ExperimentalRegex)
-endif()
+add_subdirectory(Parse)
 add_subdirectory(SIL)
 add_subdirectory(Optimizer)

SwiftCompilerSources/Sources/CMakeLists.txt

@@ -6,13 +6,11 @@
 # See http://swift.org/LICENSE.txt for license information
 # See http://swift.org/CONTRIBUTORS.txt for Swift project authors
 
-set(dependencies)
-list(APPEND dependencies Basic SIL)
-if(SWIFT_ENABLE_EXPERIMENTAL_STRING_PROCESSING)
-  list(APPEND dependencies ExperimentalRegex)
-endif()
-
-add_swift_compiler_module(Optimizer DEPENDS ${dependencies})
+add_swift_compiler_module(Optimizer
+  DEPENDS
+    Basic
+    SIL
+    Parse)
 
 add_subdirectory(Analysis)
 add_subdirectory(DataStructures)

SwiftCompilerSources/Sources/ExperimentalRegex/CMakeLists.txt

@@ -11,18 +11,15 @@
 //===----------------------------------------------------------------------===//
 
 import SIL
+import Parse
 import OptimizerBridging
 
-#if canImport(ExperimentalRegex)
-import ExperimentalRegex
-#endif
-
 @_cdecl("initializeSwiftModules")
 public func initializeSwiftModules() {
   registerSILClasses()
   registerSwiftPasses()
 
-  #if canImport(ExperimentalRegex)
+  #if SWIFT_ENABLE_EXPERIMENTAL_STRING_PROCESSING
   registerRegexParser()
   #endif
 }

SwiftCompilerSources/Sources/ExperimentalRegex/Regex.swift

@@ -0,0 +1,28 @@
+# This source file is part of the Swift.org open source project
+#
+# Copyright (c) 2014 - 2021 Apple Inc. and the Swift project authors
+# Licensed under Apache License v2.0 with Runtime Library Exception
+#
+# See http://swift.org/LICENSE.txt for license information
+# See http://swift.org/CONTRIBUTORS.txt for Swift project authors
+
+set(LIBSWIFT_EXPERIMENTAL_REGEX_SOURCES)
+
+if(SWIFT_ENABLE_EXPERIMENTAL_STRING_PROCESSING)
+  file(GLOB_RECURSE _LIBSWIFT_EXPERIMENTAL_REGEX_SOURCES
+    "${EXPERIMENTAL_STRING_PROCESSING_SOURCE_DIR}/Sources/_MatchingEngine/*.swift")
+  foreach(source ${_LIBSWIFT_EXPERIMENTAL_REGEX_SOURCES})
+    file(TO_CMAKE_PATH "${source}" source)
+    list(APPEND LIBSWIFT_EXPERIMENTAL_REGEX_SOURCES ${source})
+  endforeach()
+  message(STATUS "Using Experimental String Processing library for libswift ExperimentalRegex (${EXPERIMENTAL_STRING_PROCESSING_SOURCE_DIR}).")
+endif()
+
+add_swift_compiler_module(Parse
+  DEPENDS
+    Basic
+    AST
+  SOURCES
+    "${LIBSWIFT_EXPERIMENTAL_REGEX_SOURCES}"
+    Regex.swift)
+

SwiftCompilerSources/Sources/Optimizer/CMakeLists.txt

@@ -0,0 +1,89 @@
+//===--- Regex.swift - Regex compilation bridging layer -------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2022 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+//
+// Bridging layer between 'string-processing' module and the compiler
+//
+//===----------------------------------------------------------------------===//
+
+#if SWIFT_ENABLE_EXPERIMENTAL_STRING_PROCESSING
+
+// FIXME: Currenly, 'swift-experimental-string-processing' sources are compiled
+// with this file. Ideally, it should be built as an independent module, so it
+// can be imported in this file.
+
+// import _MatchingEngine
+import ParseBridging
+import AST
+import Basic
+
+public func registerRegexParser() {
+  Parser_registerRegexLiteralParsingFn(libswiftParseRegexLiteral)
+  Parser_registerRegexLiteralLexingFn(bridgingLexRegexLiteral)
+}
+
+func bridgingLexRegexLiteral(
+  _ curPtrPtr: UnsafeMutablePointer<UnsafePointer<CChar>?>,
+  _ bufferEndPtr: UnsafePointer<CChar>,
+  _ bridgedDiagEngine: BridgedDiagnosticEngine) -> Bool {
+
+  var errOut: UnsafePointer<CChar>? = nil;
+  let completelyErroneous = libswiftLexRegexLiteral(curPtrPtr, bufferEndPtr, &errOut);
+
+  // NOTE: Temporary diagnostics.
+  if let errCString = errOut {
+    let errStr = String(cString: errCString);
+
+    let diagEngine = DiagnosticEngine(bridged: bridgedDiagEngine)
+    let loc = SourceLoc(pointer: curPtrPtr.pointee)
+    diagEngine.diagnose(loc, .regex_literal_parsing_error, [errStr],
+                        highlight: nil, fixIts: [])
+  }
+
+  return completelyErroneous;
+}
+
+// -- Prototype pseudo implementation --
+#if PROTOTYPE_IMPL
+func bridgingLexRegexLiteral(
+  _ curPtrPtr: UnsafeMutablePointer<UnsafePointer<CChar>?>?,
+  _ bufferEndPtr: UnsafePointer<CChar>?,
+  _ bridgedDiagEngine: BridgedDiagnosticEngine) {
+
+  let source = Source(curPtrPtr, buffferEndPointer)
+  let lexer = RegexLexer(source)
+
+  let pos: SourcePosition? = lexer.lex()
+
+  let completelyErroneous: Bool
+  if let pos = pos {
+    completelyErroneous = false
+    curPtrPtr = pos.pointer
+  } else {
+    completelyErroneous = true
+  }
+
+  let diagEngine = DiagnosticEngine(bridged: bridgedDiagEngine)
+  for diagnostic in lexer.diagnostics {
+    let loc = getSourceLoc(diagnostic.sourceLocation)
+    switch diagnostic {
+      case .someError(let arg):
+        diagEngine.diagnose(loc, .regex_lex_some_error, [arg])
+      case .otherWarning:
+        diagEngine.diagnose(loc, .regex_lex_other_warning, [])
+    }
+  }
+
+  return completelyErroneous;
+}
+#endif
+
+#endif // SWIFT_ENABLE_EXPERIMENTAL_STRING_PROCESSING

SwiftCompilerSources/Sources/Optimizer/PassManager/PassRegistration.swift

@@ -0,0 +1,33 @@
+//===--- _MatchingEnginge_stubs.swift -------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2022 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+//
+// Only provides stub functions for Package.swift builds which doesn't know
+// where the "string-processing" sources exist.
+// NOTE: This file is not used in CMake builds.
+
+func libswiftLexRegexLiteral(
+  _ curPtrPtr: UnsafeMutablePointer<UnsafePointer<CChar>?>?,
+  _ bufferEndPtr: UnsafePointer<CChar>?,
+  _ errOut: UnsafeMutablePointer<UnsafePointer<CChar>?>?
+) -> /*CompletelyErroneous*/ CBool {
+  fatalError("not implemented")
+}
+
+func libswiftParseRegexLiteral(
+  _ inputPtr: UnsafePointer<CChar>?,
+  _ errOut: UnsafeMutablePointer<UnsafePointer<CChar>?>?,
+  _ versionOut: UnsafeMutablePointer<CUnsignedInt>?,
+  _ captureStructureOut: UnsafeMutableRawPointer?,
+  _ captureStructureSize: CUnsignedInt
+) {
+  fatalError("not implemented")
+}

SwiftCompilerSources/Sources/Parse/CMakeLists.txt

@@ -0,0 +1,25 @@
+module BasicBridging {
+  header "swift/Basic/BasicBridging.h"
+  header "swift/Basic/BridgedSwiftObject.h"
+  export *
+}
+
+module ASTBridging {
+  header "swift/AST/ASTBridging.h"
+  export *
+}
+
+module SILBridging {
+  header "swift/SIL/SILBridging.h"
+  export *
+}
+
+module OptimizerBridging {
+  header "swift/SILOptimizer/OptimizerBridging.h"
+  export *
+}
+
+module ParseBridging {
+  header "swift/Parse/ParseBridging.h"
+  export *
+}