TokenSyntax
A Syntax node representing a single token.
struct TokenSyntax
A Syntax node representing a single token.
struct TokenSyntax
import SwiftSyntax
A library for working with Swift code.
struct Trivia
Trivia represent pieces of the source code that are not relevant to represent its semantic structure.
enum TokenKind
Enumerates the kinds of tokens in the Swift language.
struct TokenSequence
Sequence of tokens that are part of the provided Syntax node.
enum SourcePresence
An indicator of whether a Syntax node was found or written in the source.
protocol Copyable
A type whose values can be implicitly or explicitly copied.
protocol CustomDebugStringConvertible
A type with a customized textual representation suitable for debugging purposes.
protocol CustomReflectable
A type that explicitly supplies its own mirror.
protocol CustomStringConvertible
A type with a customized textual representation.
protocol Equatable
A type that can be compared for value equality.
protocol Escapable
protocol Hashable : Equatable
A type that can be hashed into a Hasher
to produce an integer hash value.
protocol Sendable
protocol SyntaxHashable : Hashable
Protocol that provides a common Hashable implementation for all syntax nodes
protocol SyntaxProtocol : CustomDebugStringConvertible, CustomReflectable, CustomStringConvertible, Sendable, TextOutputStreamable
Provide common functionality for specialized syntax nodes. Extend this protocol to provide common functionality for all syntax nodes.
protocol TextOutputStreamable
A source of text-streaming operations.
init?<S>(_ node: S) where S : SyntaxProtocol
If node
is a token, return the TokenSyntax
that represents it. Otherwise, return nil
.
init(_ kind: TokenKind, leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence)
Construct a new token with the given kind
, leadingTrivia
, trailingTrivia
and presence
.
static var structure: SyntaxNodeStructure { get }
A token by itself has no structure, so we represent its structure by an empty layout node.
static func arrowToken(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func atSignToken(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func backslashToken(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func backtickToken(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func binaryOperator(_ text: String, leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func colonToken(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func commaToken(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func dollarIdentifier(_ text: String, leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func ellipsisToken(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func endOfFileToken(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func equalToken(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func exclamationMarkToken(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func floatLiteral(_ text: String, leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func identifier(_ text: String, leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func infixQuestionMarkToken(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func integerLiteral(_ text: String, leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func keyword(_ value: Keyword, leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func leftAngleToken(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func leftBraceToken(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func leftParenToken(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func leftSquareToken(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func multilineStringQuoteToken(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func periodToken(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func postfixOperator(_ text: String, leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func postfixQuestionMarkToken(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func poundAvailableToken(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func poundElseToken(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func poundElseifToken(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func poundEndifToken(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func poundIfToken(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func poundSourceLocationToken(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func poundToken(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func poundUnavailableToken(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func prefixAmpersandToken(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func prefixOperator(_ text: String, leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func rawStringPoundDelimiter(_ text: String, leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func regexLiteralPattern(_ text: String, leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func regexPoundDelimiter(_ text: String, leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func regexSlashToken(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func rightAngleToken(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func rightBraceToken(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func rightParenToken(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func rightSquareToken(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func semicolonToken(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func shebang(_ text: String, leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func singleQuoteToken(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func stringQuoteToken(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func stringSegment(_ text: String, leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func unknown(_ text: String, leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func wildcardToken(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
let _syntaxNode: Syntax
The Syntax
node that provides the underlying data.
var customMirror: Mirror { get }
A custom mirror that shows the token properties in a simpler form, making the debug output of the token easier to read.
var identifier: Identifier? { get }
An identifier created from self
.
var isEditorPlaceholder: Bool { get }
Whether the token text is an editor placeholder or not.
var leadingTrivia: Trivia { get set }
The leading trivia (spaces, newlines, etc.) associated with this token.
var leadingTriviaLength: SourceLength { get }
The length this node’s leading trivia takes up spelled out in source.
var presence: SourcePresence { get set }
Whether the token is present or missing.
var rawText: SyntaxText { get }
var rawTokenKind: RawTokenKind { get }
var text: String { get }
The text of the token as written in the source code, without any trivia.
var tokenDiagnostic: TokenDiagnostic? { get }
If the token has a lexical error, the type of the error.
var tokenKind: TokenKind { get set }
The kind of token this node represents.
var tokenView: RawSyntaxTokenView { get }
The RawSyntaxTokenView
of this token that allows accessing raw properties of the token.
var totalLength: SourceLength { get }
The length of this node including all of its trivia.
var trailingTrivia: Trivia { get set }
The trailing trivia (spaces, newlines, etc.) associated with this token.
var trailingTriviaLength: SourceLength { get }
The length this node’s trailing trivia takes up spelled out in source.
var trimmedLength: SourceLength { get }
The length this node takes up spelled out in the source, excluding its leading or trailing trivia.
static func eof(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func extendedRegexDelimiter(_ text: String, leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func floatingLiteral(_ text: String, leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func leftSquareBracketToken(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func poundAvailableKeyword(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func poundElseKeyword(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func poundElseifKeyword(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func poundEndifKeyword(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func poundIfKeyword(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func poundSourceLocationKeyword(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func poundUnavailableKeyword(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func rawStringDelimiter(_ text: String, leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
static func rightSquareBracketToken(leadingTrivia: Trivia = [], trailingTrivia: Trivia = [], presence: SourcePresence = .present) -> TokenSyntax
func `as`<S>(_ syntaxType: S.Type) -> S? where S : SyntaxProtocol
Attempts to cast the current leaf syntax node to a different specified type.
func cast<S>(_ syntaxType: S.Type) -> S where S : SyntaxProtocol
Force-casts the current leaf syntax node to a different specified type.
func `is`<S>(_ syntaxType: S.Type) -> Bool where S : SyntaxProtocol
Checks if the current leaf syntax node can be cast to a different specified type.
init?<S>(_ node: S?) where S : SyntaxProtocol
Initializes a new instance of the conforming type from a given specialized syntax node.
var debugDescription: String { get }
A simple description of this node (ie. its type).
var description: String { get }
A source-accurate description of this node.
var detached: Self { get }
Return this subtree with this node as the root, ie. detach this node from its parent.
var endPosition: AbsolutePosition { get }
The end position of this node, including its trivia.
var endPositionBeforeTrailingTrivia: AbsolutePosition { get }
The end position of this node’s content, before any trailing trivia.
var hasError: Bool { get }
Whether the tree contained by this layout has any
var hasMaximumNestingLevelOverflow: Bool { get }
var hasParent: Bool { get }
Whether or not this node has a parent.
var hasSequenceExpr: Bool { get }
Whether this tree contains a missing token or unexpected node.
var hasWarning: Bool { get }
Whether the tree contained by this layout has any tokens with a TokenDiagnostic
of severity warning
.
var id: SyntaxIdentifier { get }
Returns a value representing the unique identity of the node.
var keyPathInParent: AnyKeyPath? { get }
var kind: SyntaxKind { get }
The kind of the syntax node, e.g. if it is a functionDecl
.
var parent: Syntax? { get }
The parent of this syntax node, or nil
if this node is the root.
var position: AbsolutePosition { get }
The absolute position of the starting point of this node. If the first token is with leading trivia, the position points to the start of the leading trivia.
var positionAfterSkippingLeadingTrivia: AbsolutePosition { get }
The absolute position of the starting point of this node, skipping any leading trivia attached to the first token syntax.
var raw: RawSyntax { get }
var root: Syntax { get }
The root of the tree in which this node resides.
var syntaxNodeType: SyntaxProtocol.Type { get }
The dynamic metatype of the concrete node.
var syntaxTextBytes: [UInt8] { get }
Retrieve the syntax text as an array of bytes that models the input source even in the presence of invalid UTF-8.
var totalByteRange: ByteSourceRange { get }
The byte source range of this node including leading and trailing trivia.
var trimmed: Self { get }
A copy of this node without the leading trivia of the first token in the node and the trailing trivia of the last token in the node.
var trimmedByteRange: ByteSourceRange { get }
The byte source range of this node excluding leading and trailing trivia.
var trimmedDescription: String { get }
The description of this node with leading whitespace of the first token and trailing whitespace of the last token removed.
static func != (lhs: Self, rhs: Self) -> Bool
Returns a Boolean value indicating whether two values are not equal.
static func == (lhs: Self, rhs: Self) -> Bool
func `as`<S>(_ syntaxType: S.Type) -> S? where S : SyntaxProtocol
Attempts to cast the current syntax node to a given specialized syntax type.
func asProtocol(_: MissingNodeSyntax.Protocol) -> MissingNodeSyntax?
Return the non-type erased version of this syntax node if it conforms to MissingNodeSyntax
. Otherwise return nil
. Note that this will incur an existential conversion.
func asProtocol(_: ParenthesizedSyntax.Protocol) -> ParenthesizedSyntax?
Return the non-type erased version of this syntax node if it conforms to ParenthesizedSyntax
. Otherwise return nil
. Note that this will incur an existential conversion.
func asProtocol(_: WithCodeBlockSyntax.Protocol) -> WithCodeBlockSyntax?
Return the non-type erased version of this syntax node if it conforms to WithCodeBlockSyntax
. Otherwise return nil
. Note that this will incur an existential conversion.
func asProtocol(_: WithModifiersSyntax.Protocol) -> WithModifiersSyntax?
Return the non-type erased version of this syntax node if it conforms to WithModifiersSyntax
. Otherwise return nil
. Note that this will incur an existential conversion.
func asProtocol(_: WithAttributesSyntax.Protocol) -> WithAttributesSyntax?
Return the non-type erased version of this syntax node if it conforms to WithAttributesSyntax
. Otherwise return nil
. Note that this will incur an existential conversion.
func asProtocol(_: WithStatementsSyntax.Protocol) -> WithStatementsSyntax?
Return the non-type erased version of this syntax node if it conforms to WithStatementsSyntax
. Otherwise return nil
. Note that this will incur an existential conversion.
func asProtocol(_: EffectSpecifiersSyntax.Protocol) -> EffectSpecifiersSyntax?
Return the non-type erased version of this syntax node if it conforms to EffectSpecifiersSyntax
. Otherwise return nil
. Note that this will incur an existential conversion.
func asProtocol(_: WithTrailingCommaSyntax.Protocol) -> WithTrailingCommaSyntax?
Return the non-type erased version of this syntax node if it conforms to WithTrailingCommaSyntax
. Otherwise return nil
. Note that this will incur an existential conversion.
func asProtocol(_: WithGenericParametersSyntax.Protocol) -> WithGenericParametersSyntax?
Return the non-type erased version of this syntax node if it conforms to WithGenericParametersSyntax
. Otherwise return nil
. Note that this will incur an existential conversion.
func asProtocol(_: WithOptionalCodeBlockSyntax.Protocol) -> WithOptionalCodeBlockSyntax?
Return the non-type erased version of this syntax node if it conforms to WithOptionalCodeBlockSyntax
. Otherwise return nil
. Note that this will incur an existential conversion.
func asProtocol(_: FreestandingMacroExpansionSyntax.Protocol) -> FreestandingMacroExpansionSyntax?
Return the non-type erased version of this syntax node if it conforms to FreestandingMacroExpansionSyntax
. Otherwise return nil
. Note that this will incur an existential conversion.
func asProtocol(_: BracedSyntax.Protocol) -> BracedSyntax?
Return the non-type erased version of this syntax node if it conforms to BracedSyntax
. Otherwise return nil
. Note that this will incur an existential conversion.
func asProtocol(_: DeclGroupSyntax.Protocol) -> DeclGroupSyntax?
Return the non-type erased version of this syntax node if it conforms to DeclGroupSyntax
. Otherwise return nil
. Note that this will incur an existential conversion.
func asProtocol(_: NamedDeclSyntax.Protocol) -> NamedDeclSyntax?
Return the non-type erased version of this syntax node if it conforms to NamedDeclSyntax
. Otherwise return nil
. Note that this will incur an existential conversion.
func cast<S>(_ syntaxType: S.Type) -> S where S : SyntaxProtocol
Force-casts the current syntax node to a given specialized syntax type.
func children(viewMode: SyntaxTreeViewMode) -> SyntaxChildren
A sequence over the children of this node.
func debugDescription(includeTrivia: Bool = false, converter: SourceLocationConverter? = nil, mark: SyntaxProtocol? = nil, indentString: String = "") -> String
Returns a summarized dump of this node.
func endLocation(converter: SourceLocationConverter, afterTrailingTrivia: Bool = false) -> SourceLocation
The ending location, in the provided file, of this Syntax node.
func firstToken(viewMode: SyntaxTreeViewMode) -> TokenSyntax?
Returns the first token node that is part of this syntax node.
func hash(into hasher: inout Hasher)
func `is`<S>(_ syntaxType: S.Type) -> Bool where S : SyntaxProtocol
Checks if the current syntax node can be cast to a given specialized syntax type.
func isProtocol(_: MissingNodeSyntax.Protocol) -> Bool
Check whether the non-type erased version of this syntax node conforms to MissingNodeSyntax
. Note that this will incur an existential conversion.
func isProtocol(_: ParenthesizedSyntax.Protocol) -> Bool
Check whether the non-type erased version of this syntax node conforms to ParenthesizedSyntax
. Note that this will incur an existential conversion.
func isProtocol(_: WithCodeBlockSyntax.Protocol) -> Bool
Check whether the non-type erased version of this syntax node conforms to WithCodeBlockSyntax
. Note that this will incur an existential conversion.
func isProtocol(_: WithModifiersSyntax.Protocol) -> Bool
Check whether the non-type erased version of this syntax node conforms to WithModifiersSyntax
. Note that this will incur an existential conversion.
func isProtocol(_: WithAttributesSyntax.Protocol) -> Bool
Check whether the non-type erased version of this syntax node conforms to WithAttributesSyntax
. Note that this will incur an existential conversion.
func isProtocol(_: WithStatementsSyntax.Protocol) -> Bool
Check whether the non-type erased version of this syntax node conforms to WithStatementsSyntax
. Note that this will incur an existential conversion.
func isProtocol(_: EffectSpecifiersSyntax.Protocol) -> Bool
Check whether the non-type erased version of this syntax node conforms to EffectSpecifiersSyntax
. Note that this will incur an existential conversion.
func isProtocol(_: WithTrailingCommaSyntax.Protocol) -> Bool
Check whether the non-type erased version of this syntax node conforms to WithTrailingCommaSyntax
. Note that this will incur an existential conversion.
func isProtocol(_: WithGenericParametersSyntax.Protocol) -> Bool
Check whether the non-type erased version of this syntax node conforms to WithGenericParametersSyntax
. Note that this will incur an existential conversion.
func isProtocol(_: WithOptionalCodeBlockSyntax.Protocol) -> Bool
Check whether the non-type erased version of this syntax node conforms to WithOptionalCodeBlockSyntax
. Note that this will incur an existential conversion.
func isProtocol(_: FreestandingMacroExpansionSyntax.Protocol) -> Bool
Check whether the non-type erased version of this syntax node conforms to FreestandingMacroExpansionSyntax
. Note that this will incur an existential conversion.
func isProtocol(_: BracedSyntax.Protocol) -> Bool
Check whether the non-type erased version of this syntax node conforms to BracedSyntax
. Note that this will incur an existential conversion.
func isProtocol(_: DeclGroupSyntax.Protocol) -> Bool
Check whether the non-type erased version of this syntax node conforms to DeclGroupSyntax
. Note that this will incur an existential conversion.
func isProtocol(_: NamedDeclSyntax.Protocol) -> Bool
Check whether the non-type erased version of this syntax node conforms to NamedDeclSyntax
. Note that this will incur an existential conversion.
func lastToken(viewMode: SyntaxTreeViewMode) -> TokenSyntax?
Returns the last token node that is part of this syntax node.
func nextToken(viewMode: SyntaxTreeViewMode) -> TokenSyntax?
Recursively walks through the tree to find the next token semantically after this node.
func node(at syntaxIdentifier: SyntaxIdentifier) -> Syntax?
If the node with the given syntaxIdentifier
is a (recursive) child of this node, return the node with that identifier.
func previousToken(viewMode: SyntaxTreeViewMode) -> TokenSyntax?
Recursively walks through the tree to find the token semantically before this node.
func sourceRange(converter: SourceLocationConverter, afterLeadingTrivia: Bool = true, afterTrailingTrivia: Bool = false) -> SourceRange
The source range, in the provided file, of this Syntax node.
func startLocation(converter: SourceLocationConverter, afterLeadingTrivia: Bool = true) -> SourceLocation
The starting location, in the provided file, of this Syntax node.
func token(at position: AbsolutePosition) -> TokenSyntax?
Find the syntax token at the given absolute position within this syntax node or any of its children.
func tokens(viewMode: SyntaxTreeViewMode) -> TokenSequence
Sequence of tokens that are part of this Syntax node.
func trimmed(matching filter: (TriviaPiece) -> Bool) -> Self
A copy of this node with pieces that match matching
trimmed from the leading trivia of the first token and trailing trivia of the last token.
func trimmedDescription(matching filter: (TriviaPiece) -> Bool) -> String
The description of this node with pieces that match matching
removed from the leading trivia of the first token and trailing trivia of the last token.
func with<T>(_ keyPath: WritableKeyPath<Self, T>, _ value: T) -> Self
Returns a new syntax node that has the child at keyPath
replaced by value
.
func write<Target>(to target: inout Target) where Target : TextOutputStream
Prints the raw value of this node to the provided stream.
var byteRange: ByteSourceRange { get }
var byteSize: Int { get }
The textual byte length of this node including leading and trailing trivia.
var byteSizeAfterTrimmingTrivia: Int { get }
The textual byte length of this node excluding leading and trailing trivia.
var contentLength: SourceLength { get }
var firstToken: TokenSyntax? { get }
var index: SyntaxChildrenIndex { get }
The index of this node in a SyntaxChildren
collection.
var isImplicit: Bool { get }
When isImplicit is true, the syntax node doesn’t include any underlying tokens, e.g. an empty CodeBlockItemList.
var lastToken: TokenSyntax? { get }
var nextToken: TokenSyntax? { get }
var previousToken: TokenSyntax? { get }
func `as`(_ syntaxType: Syntax.Type) -> Syntax?
Attempts to upcast the current syntax node to Syntax
node.
func `as`(_ syntaxType: Self.Type) -> Self?
Casts the current syntax node to its own type.
func cast(_ syntaxType: Syntax.Type) -> Syntax
Force-cast the current syntax node to Syntax
node..
func cast(_ syntaxType: Self.Type) -> Self
Force-casts the current syntax node to its own type.
func detach() -> Self
func `is`(_ syntaxType: Syntax.Type) -> Bool
Checks if the current syntax node can be upcast to Syntax
node.
func `is`(_ syntaxType: Self.Type) -> Bool
Checks if the current syntax node can be cast to its own type.
import SwiftBasicFormat
var indentationOfLine: Trivia { get }
Returns the indentation of the line this token occurs on
import SwiftIDEUtils
var tokenClassification: SyntaxClassifiedRange { get }
The SyntaxClassifiedRange
for the token text, excluding trivia.
import SwiftSyntaxBuilder
SwiftSyntaxBuilder is a tool for generating Swift code in a convenient way using result builders.
protocol ExpressibleByExtendedGraphemeClusterLiteral : ExpressibleByUnicodeScalarLiteral
A type that can be initialized with a string literal containing a single extended grapheme cluster.
protocol ExpressibleByStringInterpolation : ExpressibleByStringLiteral
A type that can be initialized by string interpolation with a string literal that includes expressions.
protocol ExpressibleByStringLiteral : ExpressibleByExtendedGraphemeClusterLiteral
A type that can be initialized with a string literal.
protocol ExpressibleByUnicodeScalarLiteral
A type that can be initialized with a string literal containing a single Unicode scalar value.
protocol SyntaxExpressibleByStringInterpolation : ExpressibleByStringInterpolation where Self.StringInterpolation == SyntaxStringInterpolation
Syntax nodes that can be formed by a string interpolation involve source code and interpolated syntax nodes.
init(stringInterpolation: SyntaxStringInterpolation)
init(extendedGraphemeClusterLiteral value: Self.StringLiteralType)
init(stringLiteral value: String)
init(unicodeScalarLiteral value: Self.ExtendedGraphemeClusterLiteralType)