File: AddSwiftSetting.swift

package info (click to toggle)
swiftlang 6.2.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,856,264 kB
  • sloc: cpp: 9,995,718; ansic: 2,234,019; asm: 1,092,167; python: 313,940; objc: 82,726; f90: 80,126; lisp: 38,373; pascal: 25,580; sh: 20,378; ml: 5,058; perl: 4,751; makefile: 4,725; awk: 3,535; javascript: 3,018; xml: 918; fortran: 664; cs: 573; ruby: 396
file content (162 lines) | stat: -rw-r--r-- 5,058 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2025 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 the list of Swift project authors
//
//===----------------------------------------------------------------------===//

import Basics
import PackageModel
import SwiftParser
import SwiftSyntax
import SwiftSyntaxBuilder
import struct TSCUtility.Version

/// Add a swift setting to a manifest's source code.
public enum AddSwiftSetting {
    /// The set of argument labels that can occur after the "targets"
    /// argument in the Package initializers.
    private static let argumentLabelsAfterSwiftSettings: Set<String> = [
        "linkerSettings",
        "plugins",
    ]

    public static func upcomingFeature(
        to target: String,
        name: String,
        manifest: SourceFileSyntax
    ) throws -> PackageEditResult {
        try self.addToTarget(
            target,
            name: "enableUpcomingFeature",
            value: name,
            firstIntroduced: .v5_8,
            manifest: manifest
        )
    }

    public static func experimentalFeature(
        to target: String,
        name: String,
        manifest: SourceFileSyntax
    ) throws -> PackageEditResult {
        try self.addToTarget(
            target,
            name: "enableExperimentalFeature",
            value: name,
            firstIntroduced: .v5_8,
            manifest: manifest
        )
    }

    public static func languageMode(
        to target: String,
        mode: SwiftLanguageVersion,
        manifest: SourceFileSyntax
    ) throws -> PackageEditResult {
        try self.addToTarget(
            target,
            name: "swiftLanguageMode",
            value: mode,
            firstIntroduced: .v6_0,
            manifest: manifest
        )
    }

    public static func strictMemorySafety(
        to target: String,
        manifest: SourceFileSyntax
    ) throws -> PackageEditResult {
        try self.addToTarget(
            target, name: "strictMemorySafety()",
            value: String?.none,
            firstIntroduced: .v6_2,
            manifest: manifest
        )
    }

    private static func addToTarget(
        _ target: String,
        name: String,
        value: (some ManifestSyntaxRepresentable)?,
        firstIntroduced: ToolsVersion,
        manifest: SourceFileSyntax
    ) throws -> PackageEditResult {
        try manifest.checkManifestAtLeast(firstIntroduced)

        guard let packageCall = manifest.findCall(calleeName: "Package") else {
            throw ManifestEditError.cannotFindPackage
        }

        guard let targetsArgument = packageCall.findArgument(labeled: "targets"),
              let targetArray = targetsArgument.expression.findArrayArgument()
        else {
            throw ManifestEditError.cannotFindTargets
        }

        let targetCall = targetArray
            .elements
            .lazy
            .compactMap {
                $0.expression.as(FunctionCallExprSyntax.self)
            }.first { targetCall in
                if let nameArgument = targetCall.findArgument(labeled: "name"),
                   let nameLiteral = nameArgument.expression.as(StringLiteralExprSyntax.self),
                   nameLiteral.representedLiteralValue == target
                {
                    return true
                }

                return false
            }

        guard let targetCall else {
            throw ManifestEditError.cannotFindTarget(targetName: target)
        }

        if let memberRef = targetCall.calledExpression.as(MemberAccessExprSyntax.self),
           memberRef.declName.baseName.text == "plugin"
        {
            throw ManifestEditError.cannotAddSettingsToPluginTarget
        }

        let newTargetCall = if let value {
            try targetCall.appendingToArrayArgument(
                label: "swiftSettings",
                trailingLabels: self.argumentLabelsAfterSwiftSettings,
                newElement: ".\(raw: name)(\(value.asSyntax()))"
            )
        } else {
            try targetCall.appendingToArrayArgument(
                label: "swiftSettings",
                trailingLabels: self.argumentLabelsAfterSwiftSettings,
                newElement: ".\(raw: name)"
            )
        }

        return PackageEditResult(
            manifestEdits: [
                .replace(targetCall, with: newTargetCall.description),
            ]
        )
    }
}

extension SwiftLanguageVersion: ManifestSyntaxRepresentable {
    func asSyntax() -> ExprSyntax {
        if !Self.supportedSwiftLanguageVersions.contains(self) {
            return ".version(\"\(raw: rawValue)\")"
        }

        if minor == 0 {
            return ".v\(raw: major)"
        }

        return ".v\(raw: major)_\(raw: minor)"
    }
}