File: AvailabilityNodes.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 (181 lines) | stat: -rw-r--r-- 5,826 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
173
174
175
176
177
178
179
180
181
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2023 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//

public let AVAILABILITY_NODES: [Node] = [
  Node(
    kind: .availabilityArgument,
    base: .syntax,
    nameForDiagnostics: "availability argument",
    documentation:
      "A single argument to an `@available` argument like `*`, `iOS 10.1`, or `message: \"This has been deprecated\"`.",
    traits: ["WithTrailingComma"],
    children: [
      Child(
        name: "argument",
        deprecatedName: "entry",
        kind: .nodeChoices(choices: [
          Child(
            name: "token",
            kind: .token(
              choices: [.token(.binaryOperator), .token(.identifier)],
              requiresLeadingSpace: false,
              requiresTrailingSpace: false
            )
          ),
          Child(
            name: "availabilityVersionRestriction",
            kind: .node(kind: .platformVersion)
          ),
          Child(
            name: "availabilityLabeledArgument",
            kind: .node(kind: .availabilityLabeledArgument)
          ),
        ]),
        documentation: "The actual argument."
      ),
      Child(
        name: "trailingComma",
        kind: .token(choices: [.token(.comma)]),
        documentation: "A trailing comma if the argument is followed by another argument.",
        isOptional: true
      ),
    ]
  ),

  Node(
    kind: .availabilityLabeledArgument,
    base: .syntax,
    nameForDiagnostics: "availability argument",
    documentation:
      "An argument to an `@available` attribute that consists of a label and a value, e.g. `message: \"This has been deprecated\"`.",
    children: [
      Child(
        name: "label",
        kind: .token(choices: [
          .keyword(.message),
          .keyword(.renamed),
          .keyword(.introduced),
          .keyword(.obsoleted),
          .keyword(.deprecated),
        ]),
        nameForDiagnostics: "label",
        documentation: "The label of the argument."
      ),
      Child(
        name: "colon",
        kind: .token(choices: [.token(.colon)]),
        documentation: "The colon separating label and value."
      ),
      Child(
        name: "value",
        kind: .nodeChoices(choices: [
          Child(
            name: "string",
            kind: .node(kind: .simpleStringLiteralExpr)
          ),
          Child(
            name: "version",
            kind: .node(kind: .versionTuple)
          ),
        ]),
        nameForDiagnostics: "value",
        documentation: "The value of this labeled argument."
      ),
    ]
  ),

  Node(
    kind: .availabilityArgumentList,
    base: .syntaxCollection,
    nameForDiagnostics: "'@availability' arguments",
    elementChoices: [.availabilityArgument]
  ),

  Node(
    kind: .platformVersion,
    base: .syntax,
    nameForDiagnostics: "version restriction",
    documentation:
      "An argument to `@available` that restricts the availability on a certain platform to a version, e.g. `iOS 10` or `swift 3.4`.",
    children: [
      Child(
        name: "platform",
        kind: .token(choices: [.token(.identifier)]),
        nameForDiagnostics: "platform",
        documentation:
          "The name of the OS on which the availability should be restricted or 'swift' if the availability should be restricted based on a Swift version."
      ),
      Child(
        name: "version",
        kind: .node(kind: .versionTuple),
        nameForDiagnostics: "version",
        documentation: """
          The version of this platform.

          This parameter is optional because a custom platform alias can be specified using the `-define-availability` 
          argument to the Swift compiler. For example, when passing `-define-availability "_iOS8Aligned:macOS 10.10, iOS 8.0"`
          to the Swift compiler, then `@available(_iOS8Aligned, *)` is interpreted as `@available(macOS 10.10, iOS 8.0, *)`.
          """,
        isOptional: true
      ),
    ]
  ),

  Node(
    kind: .versionComponent,
    base: .syntax,
    nameForDiagnostics: nil,
    documentation: "An element to represent a single component in a version, like `.1`.",
    children: [
      Child(
        name: "period",
        kind: .token(choices: [.token(.period)]),
        documentation: "The period of this version component."
      ),
      Child(
        name: "number",
        kind: .token(choices: [.token(.integerLiteral)]),
        documentation: "The version number of this component."
      ),
    ]
  ),

  Node(
    kind: .versionComponentList,
    base: .syntaxCollection,
    nameForDiagnostics: nil,
    elementChoices: [.versionComponent]
  ),

  Node(
    kind: .versionTuple,
    base: .syntax,
    nameForDiagnostics: "version tuple",
    documentation:
      "A version number like `1.2.0`. Only the first version component is required. There might be an arbitrary number of following components.",
    parserFunction: "parseVersionTuple",
    children: [
      Child(
        name: "major",
        kind: .token(choices: [.token(.integerLiteral)]),
        documentation: "The major version."
      ),
      Child(
        name: "components",
        kind: .collection(kind: .versionComponentList, collectionElementName: "VersionComponent"),
        documentation:
          "Any version components that are not the major version . For example, for `1.2.0`, this will contain `.2.0`."
      ),
    ]
  ),

]