Provide common functionality for specialized syntax nodes. Extend this protocol to provide common functionality for all syntax nodes.
protocol SyntaxProtocol : CustomDebugStringConvertible, CustomReflectable, CustomStringConvertible, Sendable, TextOutputStreamableimport SwiftSyntaxA library for working with Swift code.
protocol CustomDebugStringConvertibleA type with a customized textual representation suitable for debugging purposes.
protocol CustomReflectableA type that explicitly supplies its own mirror.
protocol CustomStringConvertibleA type with a customized textual representation.
protocol SendableA thread-safe type whose values can be shared across arbitrary concurrent contexts without introducing a risk of data races. Values of the type may have no shared mutable state, or they may protect that state with a lock or by forcing it to only be accessed from a specific actor.
protocol TextOutputStreamableA source of text-streaming operations.
init?(_ node: some SyntaxProtocol) Converts the given specialized node to this type. Returns nil if the conversion is not possible.
static var structure: SyntaxNodeStructure { get }The statically allowed structure of the syntax node.
var _syntaxNode: Syntax { get }Retrieve the generic syntax node that is represented by this node. Do not retrieve this property directly. Use Syntax(self) instead.
class SyntaxArenaA syntax arena owns the memory for all syntax nodes within it.
enum SyntaxEnumEnum to exhaustively switch over all different syntax nodes.
protocol SyntaxHashable : HashableProtocol that provides a common Hashable implementation for all syntax nodes
struct SyntaxIdentifierProvides a stable and unique identity for Syntax nodes.
init?<S>(_ node: S?) where S : SyntaxProtocol Initializes a new instance of the conforming type from a given specialized syntax node.
var customMirror: Mirror { get }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 leadingTrivia: Trivia { get set }The leading trivia of this syntax node.
var leadingTriviaLength: SourceLength { get }The length this node’s leading trivia takes up spelled out in source.
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 range: Range<AbsolutePosition> { get }The range of this node including leading and trailing trivia.
var raw: RawSyntax { get }var root: Syntax { get }The root of the tree in which this node resides.
var syntaxNodeType: any 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 totalLength: SourceLength { get }The length of this node including all of its trivia.
var trailingTrivia: Trivia { get set }The trailing trivia of this syntax node.
var trailingTriviaLength: SourceLength { get }The length this node’s trailing trivia takes up spelled out in source.
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 trimmedDescription: String { get }The description of this node with leading whitespace of the first token and trailing whitespace of the last token removed.
var trimmedLength: SourceLength { get }The length this node takes up spelled out in the source, excluding its leading or trailing trivia.
var trimmedRange: Range<AbsolutePosition> { get }The range of this node excluding leading and trailing trivia.
func ancestorOrSelf<T>(mapping map: (Syntax) -> T?) -> T? Returns this node or the first ancestor that satisfies condition.
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(_: (any MissingNodeSyntax).Type) -> (any 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(_: (any ParenthesizedSyntax).Type) -> (any 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(_: (any WithCodeBlockSyntax).Type) -> (any 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(_: (any WithModifiersSyntax).Type) -> (any 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(_: (any WithAttributesSyntax).Type) -> (any 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(_: (any WithStatementsSyntax).Type) -> (any 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(_: (any EffectSpecifiersSyntax).Type) -> (any 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(_: (any WithTrailingCommaSyntax).Type) -> (any 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(_: (any WithGenericParametersSyntax).Type) -> (any 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(_: (any WithOptionalCodeBlockSyntax).Type) -> (any 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(_: (any FreestandingMacroExpansionSyntax).Type) -> (any 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(_: (any BracedSyntax).Type) -> (any 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(_: (any DeclGroupSyntax).Type) -> (any 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(_: (any NamedDeclSyntax).Type) -> (any 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: (any 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 `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(_: (any MissingNodeSyntax).Type) -> 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(_: (any ParenthesizedSyntax).Type) -> 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(_: (any WithCodeBlockSyntax).Type) -> 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(_: (any WithModifiersSyntax).Type) -> 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(_: (any WithAttributesSyntax).Type) -> 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(_: (any WithStatementsSyntax).Type) -> 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(_: (any EffectSpecifiersSyntax).Type) -> 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(_: (any WithTrailingCommaSyntax).Type) -> 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(_: (any WithGenericParametersSyntax).Type) -> 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(_: (any WithOptionalCodeBlockSyntax).Type) -> 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(_: (any FreestandingMacroExpansionSyntax).Type) -> 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(_: (any BracedSyntax).Type) -> 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(_: (any DeclGroupSyntax).Type) -> 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(_: (any NamedDeclSyntax).Type) -> 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 stream: 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 }var totalByteRange: ByteSourceRange { get }The byte source range of this node including leading and trailing trivia.
var trimmedByteRange: ByteSourceRange { get }The byte source range of this node excluding leading and trailing trivia.
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.
protocol BracedSyntax : SyntaxProtocol/ Automatically generated by generate-swift-syntax / Do not edit directly!
protocol DeclGroupSyntax : DeclSyntaxProtocolprotocol DeclSyntaxProtocol : SyntaxProtocolProtocol to which all DeclSyntax nodes conform.
protocol EffectSpecifiersSyntax : SyntaxProtocolprotocol ExprSyntaxProtocol : SyntaxProtocolProtocol to which all ExprSyntax nodes conform.
protocol FreestandingMacroExpansionSyntax : SyntaxProtocolprotocol MissingNodeSyntax : SyntaxProtocolRepresents a layout node that is missing in the source file.
protocol NamedDeclSyntax : SyntaxProtocolprotocol ParenthesizedSyntax : SyntaxProtocolprotocol PatternSyntaxProtocol : SyntaxProtocolProtocol to which all PatternSyntax nodes conform.
protocol StmtSyntaxProtocol : SyntaxProtocolProtocol to which all StmtSyntax nodes conform.
protocol SyntaxChildChoices : SyntaxProtocolProtocol for the enums nested inside Syntax nodes that enumerate all the possible types a child node might have.
protocol SyntaxCollection : BidirectionalCollection, ExpressibleByArrayLiteral, SyntaxProtocol where Self.Element : SyntaxProtocol, Self.Index == SyntaxChildrenIndexprotocol TypeSyntaxProtocol : SyntaxProtocolProtocol to which all TypeSyntax nodes conform.
protocol WithAttributesSyntax : SyntaxProtocolprotocol WithCodeBlockSyntax : SyntaxProtocolprotocol WithGenericParametersSyntax : SyntaxProtocolSyntax nodes that have generic parameters.
protocol WithModifiersSyntax : SyntaxProtocolprotocol WithOptionalCodeBlockSyntax : SyntaxProtocolprotocol WithStatementsSyntax : SyntaxProtocolprotocol WithTrailingCommaSyntax : SyntaxProtocolprotocol _LeafDeclSyntaxNodeProtocol : DeclSyntaxProtocolProtocol that syntax nodes conform to if they don’t have any semantic subtypes. These are syntax nodes that are not considered base nodes for other syntax types.
protocol _LeafExprSyntaxNodeProtocol : ExprSyntaxProtocolProtocol that syntax nodes conform to if they don’t have any semantic subtypes. These are syntax nodes that are not considered base nodes for other syntax types.
protocol _LeafPatternSyntaxNodeProtocol : PatternSyntaxProtocolProtocol that syntax nodes conform to if they don’t have any semantic subtypes. These are syntax nodes that are not considered base nodes for other syntax types.
protocol _LeafStmtSyntaxNodeProtocol : StmtSyntaxProtocolProtocol that syntax nodes conform to if they don’t have any semantic subtypes. These are syntax nodes that are not considered base nodes for other syntax types.
protocol _LeafSyntaxNodeProtocol : SyntaxProtocolProtocol that syntax nodes conform to if they don’t have any semantic subtypes. These are syntax nodes that are not considered base nodes for other syntax types.
protocol _LeafTypeSyntaxNodeProtocol : TypeSyntaxProtocolProtocol that syntax nodes conform to if they don’t have any semantic subtypes. These are syntax nodes that are not considered base nodes for other syntax types.
import SwiftBasicFormatfunc formatted(using format: BasicFormat = BasicFormat()) -> Syntax Build a syntax node from this Buildable and format it with the given format.
func indented(by indentation: Trivia, indentFirstLine: Bool = false) -> Self Indent this node’s lines by the provided amount.
import SwiftParserA parser for the Swift programming language.
protocol SyntaxParseable : SyntaxProtocolimport SwiftIDEUtilsvar classifications: SyntaxClassifications { get }Sequence of SyntaxClassifiedRanges for this syntax node.
func classification(at position: AbsolutePosition) -> SyntaxClassifiedRange? The SyntaxClassifiedRange for an absolute position.
func classifications(in range: Range<AbsolutePosition>) -> SyntaxClassifications Sequence of SyntaxClassifiedRanges contained in this syntax node within a source range.
func classification(at offset: Int) -> SyntaxClassifiedRange? The SyntaxClassifiedRange for a relative byte offset.
import SwiftSyntaxBuilderSwiftSyntaxBuilder is a tool for generating Swift code in a convenient way using result builders.
init(validating node: Self) throws If node has contains no syntax errors, return node, otherwise throw an error with diagnostics describing the syntax errors.
protocol DeclSyntaxParseable : DeclSyntaxProtocolAdds an initializer that allows the creation of declaration from string interpolations.
protocol HasTrailingCodeBlock : WithCodeBlockSyntaximport SwiftIfConfigvar descriptionWithoutCommentsAndSourceLocations: String { get }func configuredRegions(in configuration: some BuildConfiguration) -> ConfiguredRegions Find all of the #if/#elseif/#else clauses within the given syntax node, indicating their active state. This operation will recurse into all clauses to indicate regions of active / inactive / unparsed code.
func isActive(in configuration: some BuildConfiguration) -> (state: IfConfigRegionState, diagnostics: [Diagnostic]) Determine whether the given syntax node is active within the given build configuration.
func removingInactive(in configuration: some BuildConfiguration) -> (result: Syntax, diagnostics: [Diagnostic]) Produce a copy of this syntax node that removes all syntax regions that are inactive according to the given build configuration, leaving only the code that is active within that build configuration.
func removingInactive(in configuration: some BuildConfiguration, retainFeatureCheckIfConfigs: Bool) -> (result: Syntax, diagnostics: [Diagnostic]) Produce a copy of this syntax node that removes all syntax regions that are inactive according to the given build configuration, leaving only the code that is active within that build configuration.
import SwiftLexicalLookupfunc lookup(_ identifier: Identifier?, with config: LookupConfig = LookupConfig()) -> [LookupResult] Returns all names that for refers to at this syntax node. Optional configuration can be passed as config to customize the lookup behavior.
func lookupCatchNode() -> Syntax? Returns the catch node responsible for handling an error thrown at a particular syntax node.
func lookupLabeledStmts() -> [LabeledStmtSyntax] Returns all labeled statements available at a particular syntax node.
protocol FunctionScopeSyntax : WithGenericParametersScopeSyntax, DeclSyntaxProtocolprotocol IdentifiableSyntax : SyntaxProtocolSyntax node that can be refered to with an identifier.
protocol LookInMembersScopeSyntax : ScopeSyntaxprotocol NominalTypeDeclSyntax : LookInMembersScopeSyntax, WithGenericParametersScopeSyntax, NamedDeclSyntaxprotocol ScopeSyntax : SyntaxProtocolprotocol WithGenericParametersScopeSyntax : ScopeSyntaximport SwiftSyntaxMacrosfunc allMacroLexicalContexts(enclosingSyntax: (Syntax) -> Syntax? = { _ in nil }) -> [Syntax] Return an array of enclosing lexical contexts for the purpose of macros, from the innermost enclosing lexical context (first in the array) to the outermost. If this syntax node itself is a lexical context, it will be the innermost lexical context.
func asMacroLexicalContext() -> Syntax? If this syntax node acts as a lexical context from the perspective of a macro, return a new syntax node based on this node that strips all information that isn’t supposed to be exposed as a lexical context, such as function bodies or the members of types/extensions.
import SwiftSyntaxMacroExpansionfunc expand<Context>(macroSpecs: [String : MacroSpec], contextGenerator: @escaping (Syntax) -> Context, indentationWidth: Trivia? = nil) -> Syntax where Context : MacroExpansionContext Expand all uses of the given set of macros with specifications within this syntax node.
func expand<Context>(macros: [String : any Macro.Type], contextGenerator: @escaping (Syntax) -> Context, indentationWidth: Trivia? = nil) -> Syntax where Context : MacroExpansionContext Expand all uses of the given set of macros within this syntax node.
func expand(macros: [String : any Macro.Type], in context: some MacroExpansionContext, indentationWidth: Trivia? = nil) -> Syntax Expand all uses of the given set of macros within this syntax node.