File: ManifestSyntaxRepresentable.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 (46 lines) | stat: -rw-r--r-- 1,982 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
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2014-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 SwiftSyntax

/// Describes an entity in the package model that can be represented as
/// a syntax node.
protocol ManifestSyntaxRepresentable {
    /// The most specific kind of syntax node that best describes this entity
    /// in the manifest.
    ///
    /// There might be other kinds of syntax nodes that can also represent
    /// the syntax, but this is the one that a canonical manifest will use.
    /// As an example, a package dependency is usually expressed as, e.g.,
    ///     .package(url: "https://github.com/swiftlang/swift-syntax.git", from: "510.0.1")
    ///
    /// However, there could be other forms, e.g., this is also valid:
    ///     Package.Dependency.package(url: "https://github.com/swiftlang/swift-syntax.git", from: "510.0.1")
    associatedtype PreferredSyntax: SyntaxProtocol

    /// Provides a suitable syntax node to describe this entity in the package
    /// model.
    ///
    /// The resulting syntax is a fragment that describes just this entity,
    /// and it's enclosing entity will need to understand how to fit it in.
    /// For example, a `PackageDependency` entity would map to syntax for
    /// something like
    ///     .package(url: "https://github.com/swiftlang/swift-syntax.git", from: "510.0.1")
    func asSyntax() -> PreferredSyntax
}

extension String: ManifestSyntaxRepresentable {
    typealias PreferredSyntax = ExprSyntax

    func asSyntax() -> ExprSyntax { "\(literal: self)" }
}