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 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328
|
//===----------------------------------------------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//
import SwiftSyntax
import SwiftSyntaxBuilder
import SyntaxSupport
import Utils
let triviaPiecesFile = SourceFileSyntax(leadingTrivia: copyrightHeader) {
try! EnumDeclSyntax(
"""
/// A contiguous stretch of a single kind of trivia. The constituent part of
/// a ``Trivia`` collection.
///
/// For example, four spaces would be represented by
/// `.spaces(4)`
///
/// In general, you should deal with the actual Trivia collection instead
/// of individual pieces whenever possible.
public enum TriviaPiece: Sendable
"""
) {
for trivia in TRIVIAS {
if trivia.isCollection {
DeclSyntax(
"""
/// \(trivia.comment)
case \(trivia.enumCaseName)(Int)
"""
)
} else {
DeclSyntax(
"""
/// \(trivia.comment)
case \(trivia.enumCaseName)(String)
"""
)
}
}
}
try! ExtensionDeclSyntax("extension TriviaPiece: TextOutputStreamable") {
try FunctionDeclSyntax(
"""
/// Prints the provided trivia as they would be written in a source file.
///
/// - Parameter stream: The stream to which to print the trivia.
public func write(to target: inout some TextOutputStream)
"""
) {
DeclSyntax(
"""
func printRepeated(_ character: String, count: Int) {
for _ in 0..<count { target.write(character) }
}
"""
)
try SwitchExprSyntax("switch self") {
for trivia in TRIVIAS {
if trivia.isCollection {
let joined = trivia.characters.map { "\($0)" }.joined()
SwitchCaseSyntax("case let .\(trivia.enumCaseName)(count):") {
ExprSyntax("printRepeated(\(literal: joined), count: count)")
}
} else {
SwitchCaseSyntax("case let .\(trivia.enumCaseName)(text):") {
ExprSyntax("target.write(text)")
}
}
}
}
}
}
try! ExtensionDeclSyntax("extension TriviaPiece: CustomDebugStringConvertible") {
try VariableDeclSyntax(
"""
/// Returns a description used by dump.
public var debugDescription: String
"""
) {
try SwitchExprSyntax("switch self") {
for trivia in TRIVIAS {
if trivia.isCollection {
SwitchCaseSyntax("case .\(trivia.enumCaseName)(let data):") {
StmtSyntax(#"return "\#(trivia.enumCaseName)(\(data))""#)
}
} else {
SwitchCaseSyntax("case .\(trivia.enumCaseName)(let name):") {
StmtSyntax(#"return "\#(trivia.enumCaseName)(\(name.debugDescription))""#)
}
}
}
}
}
}
try! ExtensionDeclSyntax(
"""
extension Trivia
"""
) {
for trivia in TRIVIAS {
if trivia.isCollection {
let joined = trivia.characters.map { "\($0)" }.joined()
DeclSyntax(
"""
/// Returns a piece of trivia for some number of \(literal: joined) characters.
public static func \(trivia.enumCaseName)(_ count: Int) -> Trivia {
return [.\(trivia.enumCaseName)(count)]
}
"""
)
DeclSyntax(
"""
/// Gets a piece of trivia for \(literal: joined) characters.
public static var \(trivia.lowerName): Trivia {
return .\(trivia.enumCaseName)(1)
}
"""
)
} else {
DeclSyntax(
"""
/// Returns a piece of trivia for \(trivia.name).
public static func \(trivia.enumCaseName)(_ text: String) -> Trivia {
return [.\(trivia.enumCaseName)(text)]
}
"""
)
}
}
}
DeclSyntax("extension TriviaPiece: Equatable {}")
try! ExtensionDeclSyntax("extension TriviaPiece") {
try VariableDeclSyntax("public var sourceLength: SourceLength") {
try SwitchExprSyntax("switch self") {
for trivia in TRIVIAS {
if trivia.isCollection {
SwitchCaseSyntax("case let .\(trivia.enumCaseName)(count):") {
if trivia.charactersLen != 1 {
StmtSyntax("return SourceLength(utf8Length: count * \(raw: trivia.charactersLen))")
} else {
StmtSyntax("return SourceLength(utf8Length: count)")
}
}
} else {
SwitchCaseSyntax("case let .\(trivia.enumCaseName)(text):") {
StmtSyntax("return SourceLength(of: text)")
}
}
}
}
}
}
try! EnumDeclSyntax(
"""
/// Trivia piece for token RawSyntax.
///
/// In contrast to ``TriviaPiece``, a ``RawTriviaPiece`` does not own the source
/// text of the trivia.
@_spi(RawSyntax)
public enum RawTriviaPiece: Equatable, Sendable
"""
) {
for trivia in TRIVIAS {
if trivia.isCollection {
DeclSyntax("case \(trivia.enumCaseName)(Int)")
} else {
DeclSyntax("case \(trivia.enumCaseName)(SyntaxText)")
}
}
try FunctionDeclSyntax(
"""
static func make(_ piece: TriviaPiece, arena: SyntaxArena) -> RawTriviaPiece
"""
) {
try SwitchExprSyntax("switch piece") {
for trivia in TRIVIAS {
if trivia.isCollection {
SwitchCaseSyntax("case let .\(trivia.enumCaseName)(count):") {
StmtSyntax("return .\(trivia.enumCaseName)(count)")
}
} else {
SwitchCaseSyntax("case let .\(trivia.enumCaseName)(text):") {
StmtSyntax("return .\(trivia.enumCaseName)(arena.intern(text))")
}
}
}
}
}
}
try! ExtensionDeclSyntax("extension TriviaPiece") {
try InitializerDeclSyntax("@_spi(RawSyntax) public init(raw: RawTriviaPiece)") {
try SwitchExprSyntax("switch raw") {
for trivia in TRIVIAS {
if trivia.isCollection {
SwitchCaseSyntax("case let .\(trivia.enumCaseName)(count):") {
ExprSyntax("self = .\(trivia.enumCaseName)(count)")
}
} else {
SwitchCaseSyntax("case let .\(trivia.enumCaseName)(text):") {
ExprSyntax("self = .\(trivia.enumCaseName)(String(syntaxText: text))")
}
}
}
}
}
}
try! ExtensionDeclSyntax("extension RawTriviaPiece") {
try VariableDeclSyntax("public var byteLength: Int") {
try SwitchExprSyntax("switch self") {
for trivia in TRIVIAS {
if trivia.isCollection {
SwitchCaseSyntax("case let .\(trivia.enumCaseName)(count):") {
if trivia.charactersLen != 1 {
StmtSyntax("return count * \(raw: trivia.charactersLen)")
} else {
StmtSyntax("return count")
}
}
} else {
SwitchCaseSyntax("case let .\(trivia.enumCaseName)(text):") {
StmtSyntax("return text.count")
}
}
}
}
}
try VariableDeclSyntax("var storedText: SyntaxText?") {
try SwitchExprSyntax("switch self") {
for trivia in TRIVIAS {
if trivia.isCollection {
SwitchCaseSyntax("case .\(trivia.enumCaseName)(_):") {
StmtSyntax("return nil")
}
} else {
SwitchCaseSyntax("case .\(trivia.enumCaseName)(let text):") {
StmtSyntax("return text")
}
}
}
}
}
}
try! generateIsHelpers(for: "TriviaPiece")
try! generateIsHelpers(for: "RawTriviaPiece")
}
fileprivate func generateIsHelpers(for pieceName: TokenSyntax) throws -> ExtensionDeclSyntax {
return try ExtensionDeclSyntax("extension \(pieceName)") {
DeclSyntax(
"""
/// Returns `true` if this piece is a newline, space or tab.
public var isWhitespace: Bool {
return isSpaceOrTab || isNewline
}
"""
)
try VariableDeclSyntax("public var isNewline: Bool") {
try SwitchExprSyntax("switch self") {
for trivia in TRIVIAS {
if trivia.isNewLine {
SwitchCaseSyntax("case .\(trivia.enumCaseName):") {
StmtSyntax("return true")
}
}
}
SwitchCaseSyntax("default:") {
StmtSyntax("return false")
}
}
}
DeclSyntax(
"""
public var isSpaceOrTab: Bool {
switch self {
case .spaces:
return true
case .tabs:
return true
default:
return false
}
}
"""
)
DeclSyntax(
"""
/// Returns `true` if this piece is a comment.
public var isComment: Bool {
switch self {
case .lineComment, .blockComment, .docLineComment, .docBlockComment:
return true
default:
return false
}
}
"""
)
}
}
|