SwiftLint/Source/SwiftLintCore/Extensions/NSRegularExpression+SwiftLint.swift

import Foundation
import SourceKittenFramework

private let regexCacheLock = NSLock()
nonisolated(unsafe) private var regexCache = [RegexCacheKey: NSRegularExpression]()

public struct RegularExpression: Hashable, Comparable, ExpressibleByStringLiteral, Sendable {
    public let regex: NSRegularExpression

    public init(pattern: String, options: NSRegularExpression.Options? = nil) throws {
        regex = try .cached(pattern: pattern, options: options)
    }

    public init(stringLiteral value: String) {
        // swiftlint:disable:next force_try
        try! self.init(pattern: value)
    }

    package var pattern: String { regex.pattern }

    var numberOfCaptureGroups: Int { regex.numberOfCaptureGroups }

    public static func < (lhs: Self, rhs: Self) -> Bool {
        lhs.pattern < rhs.pattern
    }

    /// Creates a `RegularExpression` from a pattern and options.
    ///
    /// - Parameters:
    ///   - pattern: The pattern to compile into a regular expression.
    ///   - options: The options to use when compiling the regular expression.
    ///   - ruleID: The identifier of the rule that is using this regular expression in its configuration.
    /// - Returns: A `RegularExpression` instance.
    public static func from(pattern: String,
                            options: NSRegularExpression.Options? = nil,
                            for ruleID: String) throws(Issue) -> Self {
        do {
            return try Self(pattern: pattern, options: options)
        } catch {
            throw .invalidRegexPattern(ruleID: ruleID, pattern: pattern)
        }
    }
}

private struct RegexCacheKey: Hashable {
    let pattern: String
    let options: NSRegularExpression.Options

    func hash(into hasher: inout Hasher) {
        hasher.combine(pattern)
        hasher.combine(options.rawValue)
    }
}

public extension NSRegularExpression {
    static func cached(pattern: String, options: Options? = nil) throws -> NSRegularExpression {
        let options = options ?? [.anchorsMatchLines, .dotMatchesLineSeparators]
        let key = RegexCacheKey(pattern: pattern, options: options)
        regexCacheLock.lock()
        defer { regexCacheLock.unlock() }
        if let result = regexCache[key] {
            return result
        }

        let result = try NSRegularExpression(pattern: pattern, options: options)
        regexCache[key] = result
        return result
    }

    func matches(in stringView: StringView,
                 options: NSRegularExpression.MatchingOptions = []) -> [NSTextCheckingResult] {
        matches(in: stringView.string, options: options, range: stringView.range)
    }

    func matches(in stringView: StringView,
                 options: NSRegularExpression.MatchingOptions = [],
                 range: NSRange) -> [NSTextCheckingResult] {
        matches(in: stringView.string, options: options, range: range)
    }

    func matches(in file: SwiftLintFile,
                 options: NSRegularExpression.MatchingOptions = []) -> [NSTextCheckingResult] {
        matches(in: file.stringView.string, options: options, range: file.stringView.range)
    }
}