SwiftSyntax

Computes a hash value that describes the layout of all C nodes which are passed as opaque values between SwiftSyntaxParser and SwiftSyntax. This should match the value returned by the cNodeLayoutHash function in the SwiftSyntaxParser module.

Concatenates two collections of Trivia into one collection.

Plain token kind value, without an associated String value.

An indicator of whether a Syntax node was found or written in the source.

Enum to exhaustively switch over all different syntax nodes.

Specifies how missing and garbage nodes should be handled when traversing a syntax tree.

The enum describes how the SyntaxVistor should continue after visiting the current node.

Enumerates the kinds of tokens in the Swift language.

A contiguous stretch of a single kind of trivia. The constituent part of a Trivia collection.

An absolute position in a source file as text - the absolute utf8Offset from the start of the file.

AccessPathSyntax represents a collection of one or more AccessPathComponentSyntax nodes. AccessPathSyntax behaves as a regular Swift collection, and has accessors that return new versions of the collection with different children.

AccessorListSyntax represents a collection of one or more AccessorDeclSyntax nodes. AccessorListSyntax behaves as a regular Swift collection, and has accessors that return new versions of the collection with different children.

ArrayElementListSyntax represents a collection of one or more ArrayElementSyntax nodes. ArrayElementListSyntax behaves as a regular Swift collection, and has accessors that return new versions of the collection with different children.

AttributeListSyntax represents a collection of one or more Syntax nodes. AttributeListSyntax behaves as a regular Swift collection, and has accessors that return new versions of the collection with different children.

An @ attribute.

A single argument to an @available argument like *, iOS 10.1, or message: "This has been deprecated".

The availability argument for the _specialize attribute

A argument to an @available attribute that consists of a label and a value, e.g. message: "This has been deprecated".

AvailabilitySpecListSyntax represents a collection of one or more AvailabilityArgumentSyntax nodes. AvailabilitySpecListSyntax behaves as a regular Swift collection, and has accessors that return new versions of the collection with different children.

An argument to @available that restricts the availability on a certain platform to a version, e.g. iOS 10 or swift 3.4.

A collection of arguments for the @_backDeploy attribute

A single platform/version pair in a @_backDeploy attribute, e.g. iOS 10.1.

BackDeployVersionListSyntax represents a collection of one or more BackDeployVersionArgumentSyntax nodes. BackDeployVersionListSyntax behaves as a regular Swift collection, and has accessors that return new versions of the collection with different children.

CaseItemListSyntax represents a collection of one or more CaseItemSyntax nodes. CaseItemListSyntax behaves as a regular Swift collection, and has accessors that return new versions of the collection with different children.

CatchClauseListSyntax represents a collection of one or more CatchClauseSyntax nodes. CatchClauseListSyntax behaves as a regular Swift collection, and has accessors that return new versions of the collection with different children.

CatchItemListSyntax represents a collection of one or more CatchItemSyntax nodes. CatchItemListSyntax behaves as a regular Swift collection, and has accessors that return new versions of the collection with different children.

ClosureCaptureItemListSyntax represents a collection of one or more ClosureCaptureItemSyntax nodes. ClosureCaptureItemListSyntax behaves as a regular Swift collection, and has accessors that return new versions of the collection with different children.

ClosureParamListSyntax represents a collection of one or more ClosureParamSyntax nodes. ClosureParamListSyntax behaves as a regular Swift collection, and has accessors that return new versions of the collection with different children.

CodeBlockItemListSyntax represents a collection of one or more CodeBlockItemSyntax nodes. CodeBlockItemListSyntax behaves as a regular Swift collection, and has accessors that return new versions of the collection with different children.

A CodeBlockItem is any Syntax node that appears on its own line inside a CodeBlock.

CompositionTypeElementListSyntax represents a collection of one or more CompositionTypeElementSyntax nodes. CompositionTypeElementListSyntax behaves as a regular Swift collection, and has accessors that return new versions of the collection with different children.

Edits that are applied simultaneously. That is, the offsets of all edits refer to the original string and are not shifted by previous edits. For example applying

ConditionElementListSyntax represents a collection of one or more ConditionElementSyntax nodes. ConditionElementListSyntax behaves as a regular Swift collection, and has accessors that return new versions of the collection with different children.

A custom @ attribute.

DeclNameArgumentListSyntax represents a collection of one or more DeclNameArgumentSyntax nodes. DeclNameArgumentListSyntax behaves as a regular Swift collection, and has accessors that return new versions of the collection with different children.

The arguments for the ‘@derivative(of:)’ and ‘@transpose(of:)’ attributes: the ‘of:’ label, the original declaration name, and an optional differentiability parameter list.

DictionaryElementListSyntax represents a collection of one or more DictionaryElementSyntax nodes. DictionaryElementListSyntax behaves as a regular Swift collection, and has accessors that return new versions of the collection with different children.

DifferentiabilityParamListSyntax represents a collection of one or more DifferentiabilityParamSyntax nodes. DifferentiabilityParamListSyntax behaves as a regular Swift collection, and has accessors that return new versions of the collection with different children.

A differentiability parameter: either the “self” identifier, a function parameter name, or a function parameter index.

A clause containing differentiability parameters.

The differentiability parameters.

The arguments for the @differentiable attribute: an optional differentiability kind, an optional differentiability parameter clause, and an optional ‘where’ clause.

A case declaration of a Swift enum. It can have 1 or more EnumCaseElements inside, each declaring a different case of the enum.

A collection of 0 or more EnumCaseElements.

An element of an enum case, containing the name of the case and, optionally, either associated values or an assignment to a raw value.

A Swift enum declaration.

A list of expressions connected by operators. This list is contained by a SequenceExprSyntax.

A function declaration name (e.g. foo(_:_:)).

FunctionParameterListSyntax represents a collection of one or more FunctionParameterSyntax nodes. FunctionParameterListSyntax behaves as a regular Swift collection, and has accessors that return new versions of the collection with different children.

A collection of syntax nodes that occurred in the source code but could not be used to form a valid syntax tree.

GenericArgumentListSyntax represents a collection of one or more GenericArgumentSyntax nodes. GenericArgumentListSyntax behaves as a regular Swift collection, and has accessors that return new versions of the collection with different children.

GenericParameterListSyntax represents a collection of one or more GenericParameterSyntax nodes. GenericParameterListSyntax behaves as a regular Swift collection, and has accessors that return new versions of the collection with different children.

GenericRequirementListSyntax represents a collection of one or more GenericRequirementSyntax nodes. GenericRequirementListSyntax behaves as a regular Swift collection, and has accessors that return new versions of the collection with different children.

IdentifierListSyntax represents a collection of one or more TokenSyntax nodes. IdentifierListSyntax behaves as a regular Swift collection, and has accessors that return new versions of the collection with different children.

IfConfigClauseListSyntax represents a collection of one or more IfConfigClauseSyntax nodes. IfConfigClauseListSyntax behaves as a regular Swift collection, and has accessors that return new versions of the collection with different children.

The arguments for the @_implements attribute of the form Type, methodName(arg1Label:arg2Label:)

Provides a mechanism for the parser to skip regions of an incrementally updated source that was already parsed during a previous parse invocation.

InheritedTypeListSyntax represents a collection of one or more InheritedTypeSyntax nodes. InheritedTypeListSyntax behaves as a regular Swift collection, and has accessors that return new versions of the collection with different children.

A labeled argument for the @_specialize attribute like exported: true

A member declaration of a type consisting of a declaration and an optional semicolon;

MemberDeclListSyntax represents a collection of one or more MemberDeclListItemSyntax nodes. MemberDeclListSyntax behaves as a regular Swift collection, and has accessors that return new versions of the collection with different children.

ModifierListSyntax represents a collection of one or more DeclModifierSyntax nodes. ModifierListSyntax behaves as a regular Swift collection, and has accessors that return new versions of the collection with different children.

MultipleTrailingClosureElementListSyntax represents a collection of one or more MultipleTrailingClosureElementSyntax nodes. MultipleTrailingClosureElementListSyntax behaves as a regular Swift collection, and has accessors that return new versions of the collection with different children.

The argument for the @_dynamic_replacement or @_private attribute of the form for: "function()" or sourceFile: "Src.swift"

NonEmptyTokenListSyntax represents a collection of one or more TokenSyntax nodes. NonEmptyTokenListSyntax behaves as a regular Swift collection, and has accessors that return new versions of the collection with different children.

A piece of an Objective-C selector. Either consisting of just an identifier for a nullary selector, an identifier and a colon for a labeled argument or just a colon for an unlabeled argument

ObjCSelectorSyntax represents a collection of one or more ObjCSelectorPieceSyntax nodes. ObjCSelectorSyntax behaves as a regular Swift collection, and has accessors that return new versions of the collection with different children.

ObjcNameSyntax represents a collection of one or more ObjcNamePieceSyntax nodes. ObjcNameSyntax behaves as a regular Swift collection, and has accessors that return new versions of the collection with different children.

A Swift operator declaration.

A clause to specify precedence group in infix operator declarations, and designated types in any operator declaration.

PatternBindingListSyntax represents a collection of one or more PatternBindingSyntax nodes. PatternBindingListSyntax behaves as a regular Swift collection, and has accessors that return new versions of the collection with different children.

Specifies the precedence of an operator when used in an operation that includes optional chaining.

Specifies how a sequence of operators with the same precedence level are grouped together in the absence of grouping parentheses.

PrecedenceGroupAttributeListSyntax represents a collection of one or more Syntax nodes. PrecedenceGroupAttributeListSyntax behaves as a regular Swift collection, and has accessors that return new versions of the collection with different children.

A Swift precedencegroup declaration.

PrecedenceGroupNameListSyntax represents a collection of one or more PrecedenceGroupNameElementSyntax nodes. PrecedenceGroupNameListSyntax behaves as a regular Swift collection, and has accessors that return new versions of the collection with different children.

Specify the new precedence group’s relation to existing precedence groups.

PrimaryAssociatedTypeListSyntax represents a collection of one or more PrimaryAssociatedTypeSyntax nodes. PrimaryAssociatedTypeListSyntax behaves as a regular Swift collection, and has accessors that return new versions of the collection with different children.

An optionally qualified function declaration name (e.g. +(_:_:), A.B.C.foo(_:_:)).

Reverse sequence of tokens that are part of the provided Syntax node.

The length a syntax node spans in the source code. From any AbsolutePosition you reach a node’s end location by adding its UTF-8 length.

Represents a source location in a Swift file.

Represents a start and end location in a Swift file.

A collection of arguments for the @_specialize attribute

StringLiteralSegmentsSyntax represents a collection of one or more Syntax nodes. StringLiteralSegmentsSyntax behaves as a regular Swift collection, and has accessors that return new versions of the collection with different children.

SwitchCaseListSyntax represents a collection of one or more Syntax nodes. SwitchCaseListSyntax behaves as a regular Swift collection, and has accessors that return new versions of the collection with different children.

A Syntax node represents a tree of nodes with tokens at the leaves. Each node has accessors for its known children, and allows efficient iteration over the children through its children property.

Collection that contains the present child Syntax nodes of the given node.

An index in a syntax children collection.

The data for an index in a syntax children collection that is not the end index. See SyntaxChildrenIndex for the representation of the end index.

Provides a sequence of SyntaxClassifiedRanges for a syntax node.

Represents a source range that is associated with a syntax classification.

Provides a stable and unique identity for Syntax nodes.

Represents a node from the syntax tree.

A labeled argument for the @_specialize attribute with a function decl value like target: myFunc(_:)

TokenListSyntax represents a collection of one or more TokenSyntax nodes. TokenListSyntax behaves as a regular Swift collection, and has accessors that return new versions of the collection with different children.

Sequence of tokens that are part of the provided Syntax node.

A Syntax node representing a single token.

A collection of leading or trailing trivia. This is the main data structure for thinking about trivia.

TupleExprElementListSyntax represents a collection of one or more TupleExprElementSyntax nodes. TupleExprElementListSyntax behaves as a regular Swift collection, and has accessors that return new versions of the collection with different children.

TuplePatternElementListSyntax represents a collection of one or more TuplePatternElementSyntax nodes. TuplePatternElementListSyntax behaves as a regular Swift collection, and has accessors that return new versions of the collection with different children.

TupleTypeElementListSyntax represents a collection of one or more TupleTypeElementSyntax nodes. TupleTypeElementListSyntax behaves as a regular Swift collection, and has accessors that return new versions of the collection with different children.

A wrapper around a raw Syntax layout.

A version number of the form major.minor.patch in which the minor and patch part may be omitted.

An implementation of IncrementalParseReusedNodeDelegate that just collects the range and re-used node into an array.

Keeps track of a previously parsed syntax tree and the source edits that occurred since it was created.

Converts AbsolutePositions of syntax nodes to SourceLocations, and vice-versa. The AbsolutePositions must be originating from nodes that are part of the same tree that was used to initialize this class.

A SyntaxVisitor that can visit the nodes as generic Syntax values.

Verifier to check that there are no unknown syntax nodes in the tree.

Protocol to which all DeclSyntax nodes conform. Extension point to add common methods to all DeclSyntax nodes. DO NOT CONFORM TO THIS PROTOCOL YOURSELF!

Protocol to which all ExprSyntax nodes conform. Extension point to add common methods to all ExprSyntax nodes. DO NOT CONFORM TO THIS PROTOCOL YOURSELF!

Accepts the re-used Syntax nodes that IncrementalParseTransition determined they should be re-used for a parse invocation.

Protocol to which all PatternSyntax nodes conform. Extension point to add common methods to all PatternSyntax nodes. DO NOT CONFORM TO THIS PROTOCOL YOURSELF!

Protocol to which all StmtSyntax nodes conform. Extension point to add common methods to all StmtSyntax nodes. DO NOT CONFORM TO THIS PROTOCOL YOURSELF!

Protocol that provides a common Hashable implementation for all syntax nodes

Provide common functionality for specialized syntax nodes. Extend this protocol to provide common functionality for all syntax nodes. DO NOT CONFORM TO THIS PROTOCOL YOURSELF!

Protocol to which all TypeSyntax nodes conform. Extension point to add common methods to all TypeSyntax nodes. DO NOT CONFORM TO THIS PROTOCOL YOURSELF!