File: AddSetting.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 (172 lines) | stat: -rw-r--r-- 6,277 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
163
164
165
166
167
168
169
170
171
172
//===----------------------------------------------------------------------===//
//
// 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 ArgumentParser
import Basics
import CoreCommands
import Foundation
import PackageGraph
import PackageModel
import PackageModelSyntax
import SwiftParser
import TSCBasic
import TSCUtility
import Workspace

extension SwiftPackageCommand {
    struct AddSetting: SwiftCommand {
        /// The Swift language setting that can be specified on the command line.
        enum SwiftSetting: String, Codable, ExpressibleByArgument, CaseIterable {
            case experimentalFeature
            case upcomingFeature
            case languageMode
            case strictMemorySafety = "StrictMemorySafety"
        }

        package static let configuration = CommandConfiguration(
            abstract: "Add a new setting to the manifest."
        )

        @OptionGroup(visibility: .hidden)
        var globalOptions: GlobalOptions

        @Option(help: "The target to add the setting to.")
        var target: String

        @Option(
            name: .customLong("swift"),
            parsing: .upToNextOption,
            help: "The Swift language setting(s) to add. Supported settings: \(SwiftSetting.allCases.map(\.rawValue).joined(separator: ", "))."
        )
        var _swiftSettings: [String]

        var swiftSettings: [(SwiftSetting, String)] {
            get throws {
                var settings: [(SwiftSetting, String)] = []
                for rawSetting in self._swiftSettings {
                    let (name, value) = rawSetting.spm_split(around: "=")

                    guard let setting = SwiftSetting(rawValue: name) else {
                        throw ValidationError("Unknown Swift language setting: \(name)")
                    }

                    settings.append((setting, value ?? ""))
                }

                return settings
            }
        }

        func run(_ swiftCommandState: SwiftCommandState) throws {
            if !self._swiftSettings.isEmpty {
                try Self.editSwiftSettings(
                    of: self.target,
                    using: swiftCommandState,
                    self.swiftSettings,
                    verbose: !self.globalOptions.logging.quiet
                )
            }
        }

        package static func editSwiftSettings(
            of target: String,
            using swiftCommandState: SwiftCommandState,
            _ settings: [(SwiftSetting, String)],
            verbose: Bool = false
        ) throws {
            let workspace = try swiftCommandState.getActiveWorkspace()
            guard let packagePath = try swiftCommandState.getWorkspaceRoot().packages.first else {
                throw StringError("unknown package")
            }

            try self.applyEdits(
                packagePath: packagePath,
                workspace: workspace,
                target: target,
                swiftSettings: settings
            )
        }

        private static func applyEdits(
            packagePath: Basics.AbsolutePath,
            workspace: Workspace,
            target: String,
            swiftSettings: [(SwiftSetting, String)],
            verbose: Bool = false
        ) throws {
            // Load the manifest file
            let fileSystem = workspace.fileSystem
            let manifestPath = packagePath.appending(component: Manifest.filename)

            for (setting, value) in swiftSettings {
                let manifestContents: ByteString
                do {
                    manifestContents = try fileSystem.readFileContents(manifestPath)
                } catch {
                    throw StringError("cannot find package manifest in \(manifestPath)")
                }

                // Parse the manifest.
                let manifestSyntax = manifestContents.withData { data in
                    data.withUnsafeBytes { buffer in
                        buffer.withMemoryRebound(to: UInt8.self) { buffer in
                            Parser.parse(source: buffer)
                        }
                    }
                }

                let editResult: PackageEditResult

                switch setting {
                case .experimentalFeature:
                    editResult = try AddSwiftSetting.experimentalFeature(
                        to: target,
                        name: value,
                        manifest: manifestSyntax
                    )
                case .upcomingFeature:
                    editResult = try AddSwiftSetting.upcomingFeature(
                        to: target,
                        name: value,
                        manifest: manifestSyntax
                    )
                case .languageMode:
                    guard let mode = SwiftLanguageVersion(string: value) else {
                        throw ValidationError("Unknown Swift language mode: \(value)")
                    }

                    editResult = try AddSwiftSetting.languageMode(
                        to: target,
                        mode: mode,
                        manifest: manifestSyntax
                    )
                case .strictMemorySafety:
                    guard value.isEmpty || value == SwiftSetting.strictMemorySafety.rawValue else {
                        throw ValidationError("'strictMemorySafety' does not support argument '\(value)'")
                    }

                    editResult = try AddSwiftSetting.strictMemorySafety(
                        to: target,
                        manifest: manifestSyntax
                    )
                }

                try editResult.applyEdits(
                    to: fileSystem,
                    manifest: manifestSyntax,
                    manifestPath: manifestPath,
                    verbose: verbose
                )
            }
        }
    }
}