File: AddTargetDependency.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (103 lines) | stat: -rw-r--r-- 3,693 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
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2024 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 PackageLoading
import PackageModel
import SwiftParser
import SwiftSyntax
import SwiftSyntaxBuilder

/// Add a target dependency to a manifest's source code.
public struct AddTargetDependency {
    /// The set of argument labels that can occur after the "dependencies"
    /// argument in the various target initializers.
    ///
    /// TODO: Could we generate this from the the PackageDescription module, so
    /// we don't have keep it up-to-date manually?
    private static let argumentLabelsAfterDependencies: Set<String> = [
        "path",
        "exclude",
        "sources",
        "resources",
        "publicHeadersPath",
        "packageAccess",
        "cSettings",
        "cxxSettings",
        "swiftSettings",
        "linkerSettings",
        "plugins",
    ]

    /// Produce the set of source edits needed to add the given target
    /// dependency to the given manifest file.
    public static func addTargetDependency(
        _ dependency: TargetDescription.Dependency,
        targetName: String,
        to manifest: SourceFileSyntax
    ) throws -> PackageEditResult {
        // Make sure we have a suitable tools version in the manifest.
        try manifest.checkEditManifestToolsVersion()

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

        // Dig out the array of targets.
        guard let targetsArgument = packageCall.findArgument(labeled: "targets"),
              let targetArray = targetsArgument.expression.findArrayArgument() else {
            throw ManifestEditError.cannotFindTargets
        }

        // Look for a call whose name is a string literal matching the
        // requested target name.
        func matchesTargetCall(call: FunctionCallExprSyntax) -> Bool {
            guard let nameArgument = call.findArgument(labeled: "name") else {
                return false
            }

            guard let stringLiteral = nameArgument.expression.as(StringLiteralExprSyntax.self),
                let literalValue = stringLiteral.representedLiteralValue else {
                return false
            }

            return literalValue == targetName
        }

        guard let targetCall = FunctionCallExprSyntax.findFirst(in: targetArray, matching: matchesTargetCall) else {
            throw ManifestEditError.cannotFindTarget(targetName: targetName)
        }

        let newTargetCall = try addTargetDependencyLocal(
            dependency, to: targetCall
        )

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

    /// Implementation of adding a target dependency to an existing call.
    static func addTargetDependencyLocal(
        _ dependency: TargetDescription.Dependency,
        to targetCall: FunctionCallExprSyntax
    ) throws -> FunctionCallExprSyntax {
        try targetCall.appendingToArrayArgument(
            label: "dependencies",
            trailingLabels: Self.argumentLabelsAfterDependencies,
            newElement: dependency.asSyntax()
        )
    }
}