Rename _MatchingEngine module to _RegexParser (#42081)

rxwei · web-flow · commit dd7610f2d2b1 · 2022-03-31T11:13:18.000-07:00
As the _MatchingEngine module no longer contains the matching engine, this patch renames this module to describe its role more accurately. Because this module primarily contains the AST and the regex parsing logic, I propose we rename it to "_RegexParser".

Also renames the ExperimentalRegex module in SwiftCompilerSources to _RegexParser for consistency. This would prevent errors if sources in _RegexParser used qualified lookup with the module name.
diff --git a/SwiftCompilerSources/Package.swift b/SwiftCompilerSources/Package.swift
@@ -11,7 +11,7 @@ let package = Package(
     .library(
       name: "Swift",
       type: .static,
-      targets: ["SIL", "Optimizer", "ExperimentalRegex"]),
+      targets: ["SIL", "Optimizer", "_RegexParser"]),
   ],
   dependencies: [
   ],
@@ -26,15 +26,15 @@ let package = Package(
           "-cross-module-optimization"
         ])]),
     .target(
-      name: "ExperimentalRegex",
+      name: "_RegexParser",
       dependencies: [],
       swiftSettings: [SwiftSetting.unsafeFlags([
           "-I", "../include/swift",
           "-cross-module-optimization"
         ])]),
     .target(
       name: "Optimizer",
-      dependencies: ["SIL", "ExperimentalRegex"],
+      dependencies: ["SIL", "_RegexParser"],
       swiftSettings: [SwiftSetting.unsafeFlags([
           "-I", "../include/swift",
           "-cross-module-optimization"
diff --git a/SwiftCompilerSources/Sources/CMakeLists.txt b/SwiftCompilerSources/Sources/CMakeLists.txt
@@ -11,7 +11,7 @@
 add_subdirectory(Basic)
 add_subdirectory(AST)
 if(SWIFT_ENABLE_EXPERIMENTAL_STRING_PROCESSING)
-  add_subdirectory(ExperimentalRegex)
+  add_subdirectory(_RegexParser)
 endif()
 add_subdirectory(SIL)
 add_subdirectory(Optimizer)
diff --git a/SwiftCompilerSources/Sources/Optimizer/CMakeLists.txt b/SwiftCompilerSources/Sources/Optimizer/CMakeLists.txt
@@ -9,7 +9,7 @@
 set(dependencies)
 list(APPEND dependencies Basic SIL)
 if(SWIFT_ENABLE_EXPERIMENTAL_STRING_PROCESSING)
-  list(APPEND dependencies ExperimentalRegex)
+  list(APPEND dependencies _RegexParser)
 endif()
 
 add_swift_compiler_module(Optimizer DEPENDS ${dependencies})
diff --git a/SwiftCompilerSources/Sources/Optimizer/PassManager/PassRegistration.swift b/SwiftCompilerSources/Sources/Optimizer/PassManager/PassRegistration.swift
@@ -13,16 +13,16 @@
 import SIL
 import OptimizerBridging
 
-#if canImport(ExperimentalRegex)
-import ExperimentalRegex
+#if canImport(_RegexParser)
+import _RegexParser
 #endif
 
 @_cdecl("initializeSwiftModules")
 public func initializeSwiftModules() {
   registerSILClasses()
   registerSwiftPasses()
 
-  #if canImport(ExperimentalRegex)
+  #if canImport(_RegexParser)
   registerRegexParser()
   #endif
 }
diff --git a/SwiftCompilerSources/Sources/_RegexParser/CMakeLists.txt b/SwiftCompilerSources/Sources/_RegexParser/CMakeLists.txt
@@ -6,16 +6,15 @@
 # See http://swift.org/LICENSE.txt for license information
 # See http://swift.org/CONTRIBUTORS.txt for Swift project authors
 
-file(GLOB_RECURSE _LIBSWIFT_EXPERIMENTAL_REGEX_SOURCES
-  "${EXPERIMENTAL_STRING_PROCESSING_SOURCE_DIR}/Sources/_MatchingEngine/*.swift")
-set(LIBSWIFT_EXPERIMENTAL_REGEX_SOURCES)
-foreach(source ${_LIBSWIFT_EXPERIMENTAL_REGEX_SOURCES})
+file(GLOB_RECURSE _LIBSWIFT_REGEX_PARSER_SOURCES
+  "${EXPERIMENTAL_STRING_PROCESSING_SOURCE_DIR}/Sources/_RegexParser/*.swift")
+set(LIBSWIFT_REGEX_PARSER_SOURCES)
+foreach(source ${_LIBSWIFT_REGEX_PARSER_SOURCES})
   file(TO_CMAKE_PATH "${source}" source)
-  list(APPEND LIBSWIFT_EXPERIMENTAL_REGEX_SOURCES ${source})
+  list(APPEND LIBSWIFT_REGEX_PARSER_SOURCES ${source})
 endforeach()
-message(STATUS "Using Experimental String Processing library for libswift ExperimentalRegex (${EXPERIMENTAL_STRING_PROCESSING_SOURCE_DIR}).")
+message(STATUS "Using Experimental String Processing library for libswift _RegexParser (${EXPERIMENTAL_STRING_PROCESSING_SOURCE_DIR}).")
 
-add_swift_compiler_module(ExperimentalRegex
-  "${LIBSWIFT_EXPERIMENTAL_REGEX_SOURCES}"
+add_swift_compiler_module(_RegexParser
+  "${LIBSWIFT_REGEX_PARSER_SOURCES}"
   Regex.swift)
-
diff --git a/SwiftCompilerSources/Sources/_RegexParser/Regex.swift b/SwiftCompilerSources/Sources/_RegexParser/Regex.swift
@@ -1,4 +1,4 @@
-import ExperimentalRegexBridging
+import _RegexParserBridging
 
 public func registerRegexParser() {
   Parser_registerRegexLiteralParsingFn(libswiftParseRegexLiteral)
diff --git a/include/swift/Parse/RegexParserBridging.h b/include/swift/Parse/RegexParserBridging.h
@@ -1,5 +1,18 @@
-#ifndef EXPERIMENTAL_REGEX_BRIDGING
-#define EXPERIMENTAL_REGEX_BRIDGING
+//===-- RegexParserBridging.h --- Regex parser interface -*- C++ -*-===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2017 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
+//
+//===----------------------------------------------------------------------===//
+
+
+#ifndef REGEX_PARSER_BRIDGING
+#define REGEX_PARSER_BRIDGING
 
 #include <stdbool.h>
 
@@ -46,4 +59,4 @@ void Parser_registerRegexLiteralParsingFn(RegexLiteralParsingFn fn);
 } // extern "C"
 #endif
 
-#endif // EXPERIMENTAL_REGEX_BRIDGING
+#endif // REGEX_PARSER_BRIDGING
diff --git a/include/swift/module.modulemap b/include/swift/module.modulemap
@@ -19,7 +19,7 @@ module OptimizerBridging {
   export *
 }
 
-module ExperimentalRegexBridging {
-  header "Parse/ExperimentalRegexBridging.h"
+module _RegexParserBridging {
+  header "Parse/RegexParserBridging.h"
   export *
 }
diff --git a/lib/Parse/Lexer.cpp b/lib/Parse/Lexer.cpp
@@ -20,7 +20,7 @@
 #include "swift/AST/Identifier.h"
 #include "swift/Basic/LangOptions.h"
 #include "swift/Basic/SourceManager.h"
-#include "swift/Parse/ExperimentalRegexBridging.h"
+#include "swift/Parse/RegexParserBridging.h"
 #include "swift/Syntax/Trivia.h"
 #include "llvm/Support/Compiler.h"
 #include "llvm/Support/MathExtras.h"
@@ -34,7 +34,7 @@
 #include <limits>
 
 // Regex lexing delivered via libSwift.
-#include "swift/Parse/ExperimentalRegexBridging.h"
+#include "swift/Parse/RegexParserBridging.h"
 static RegexLiteralLexingFn regexLiteralLexingFn = nullptr;
 void Parser_registerRegexLiteralLexingFn(RegexLiteralLexingFn fn) {
   regexLiteralLexingFn = fn;
diff --git a/lib/Parse/ParseRegex.cpp b/lib/Parse/ParseRegex.cpp
@@ -21,7 +21,7 @@
 #include "swift/Syntax/SyntaxKind.h"
 
 // Regex parser delivered via Swift modules.
-#include "swift/Parse/ExperimentalRegexBridging.h"
+#include "swift/Parse/RegexParserBridging.h"
 static RegexLiteralParsingFn regexLiteralParsingFn = nullptr;
 void Parser_registerRegexLiteralParsingFn(RegexLiteralParsingFn fn) {
   regexLiteralParsingFn = fn;
diff --git a/stdlib/public/CMakeLists.txt b/stdlib/public/CMakeLists.txt
@@ -139,7 +139,7 @@ if(SWIFT_BUILD_STDLIB)
   endif()
 
   if(SWIFT_ENABLE_EXPERIMENTAL_STRING_PROCESSING)
-    add_subdirectory(MatchingEngine)
+    add_subdirectory(RegexParser)
     add_subdirectory(StringProcessing)
     add_subdirectory(RegexBuilder)
   endif()
diff --git a/stdlib/public/RegexBuilder/CMakeLists.txt b/stdlib/public/RegexBuilder/CMakeLists.txt
@@ -12,7 +12,7 @@
 
 set(swift_regex_builder_link_libraries
   swiftCore
-  swift_MatchingEngine
+  swift_RegexParser
   swift_StringProcessing)
 
 file(GLOB_RECURSE _REGEX_BUILDER_SOURCES
diff --git a/stdlib/public/RegexParser/CMakeLists.txt b/stdlib/public/RegexParser/CMakeLists.txt
@@ -14,15 +14,15 @@ set(swift_matching_engine_link_libraries
   swiftCore)
 
 file(GLOB_RECURSE _MATCHING_ENGINE_SOURCES
-  "${EXPERIMENTAL_STRING_PROCESSING_SOURCE_DIR}/Sources/_MatchingEngine/*.swift")
+  "${EXPERIMENTAL_STRING_PROCESSING_SOURCE_DIR}/Sources/_RegexParser/*.swift")
 set(MATCHING_ENGINE_SOURCES)
 foreach(source ${_MATCHING_ENGINE_SOURCES})
   file(TO_CMAKE_PATH "${source}" source)
   list(APPEND MATCHING_ENGINE_SOURCES ${source})
 endforeach()
-message(STATUS "Using Experimental String Processing library for _MatchingEngine (${EXPERIMENTAL_STRING_PROCESSING_SOURCE_DIR}).")
+message(STATUS "Using Experimental String Processing library for _RegexParser (${EXPERIMENTAL_STRING_PROCESSING_SOURCE_DIR}).")
 
-add_swift_target_library(swift_MatchingEngine ${SWIFT_STDLIB_LIBRARY_BUILD_TYPES} IS_STDLIB
+add_swift_target_library(swift_RegexParser ${SWIFT_STDLIB_LIBRARY_BUILD_TYPES} IS_STDLIB
   "${MATCHING_ENGINE_SOURCES}"
 
   SWIFT_MODULE_DEPENDS_LINUX Glibc
@@ -35,7 +35,7 @@ add_swift_target_library(swift_MatchingEngine ${SWIFT_STDLIB_LIBRARY_BUILD_TYPES
   LINK_LIBRARIES ${swift_matching_engine_link_libraries}
 
   C_COMPILE_FLAGS
-    -Dswift_MatchingEngine_EXPORTS
+    -Dswift_RegexParser_EXPORTS
   SWIFT_COMPILE_FLAGS
     ${SWIFT_STANDARD_LIBRARY_SWIFT_FLAGS}
   LINK_FLAGS "${SWIFT_RUNTIME_SWIFT_LINK_FLAGS}"
diff --git a/stdlib/public/StringProcessing/CMakeLists.txt b/stdlib/public/StringProcessing/CMakeLists.txt
@@ -12,7 +12,7 @@
 
 set(swift_string_processing_link_libraries
   swiftCore
-  swift_MatchingEngine)
+  swift_RegexParser)
 
 file(GLOB_RECURSE _STRING_PROCESSING_SOURCES
   "${EXPERIMENTAL_STRING_PROCESSING_SOURCE_DIR}/Sources/_StringProcessing/*.swift"
@@ -44,6 +44,6 @@ add_swift_target_library(swift_StringProcessing ${SWIFT_STDLIB_LIBRARY_BUILD_TYP
     -Xfrontend -enable-experimental-pairwise-build-block
   LINK_FLAGS "${SWIFT_RUNTIME_SWIFT_LINK_FLAGS}"
 
-  SWIFT_MODULE_DEPENDS _MatchingEngine
+  SWIFT_MODULE_DEPENDS _RegexParser
   INSTALL_IN_COMPONENT stdlib
 )

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import ExperimentalRegexBridging`
	`1`	`+import _RegexParserBridging`
`2`	`2`
`3`	`3`	`public func registerRegexParser() {`
`4`	`4`	`Parser_registerRegexLiteralParsingFn(libswiftParseRegexLiteral)`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ module OptimizerBridging {`
`19`	`19`	`export *`
`20`	`20`	`}`
`21`	`21`
`22`		`-module ExperimentalRegexBridging {`
`23`		`- header "Parse/ExperimentalRegexBridging.h"`
	`22`	`+module _RegexParserBridging {`
	`23`	`+ header "Parse/RegexParserBridging.h"`
`24`	`24`	`export *`
`25`	`25`	`}`