CodeQL library for Swift
codeql/swift-all 2.0.4-dev (changelog, source)
Search

Class Generated::TuplePattern

INTERNAL: Do not reference the Generated::TuplePattern class directly. Use the subclass TuplePattern, where the following predicates are available.

Import path

import codeql.swift.generated.pattern.TuplePattern

Direct supertypes

Indirect supertypes

Known direct subtypes

Predicates

getAPrimaryQlClass

Gets the name of a primary CodeQL class to which this element belongs.

getAnElement

Gets any of the elements of this tuple pattern.

getElement

Gets the indexth element of this tuple pattern (0-based).

getImmediateElement

Gets the indexth element of this tuple pattern (0-based).

getNumberOfElements

Gets the number of elements of this tuple pattern.

Inherited predicates

getEnclosingCallable

Gets the nearest Callable that contains this AST node, if any. This includes (auto)closures, functions, methods, (de)initializers, and accessors.

from AstNode
getEnclosingDecl

Gets the nearest declaration that contains this AST node, if any.

from AstNode
getEnclosingFunction

Gets the nearest function definition that contains this AST node, if any. This includes functions, methods, (de)initializers, and accessors, but not closures.

from AstNode
getEnclosingPattern

Gets the parent pattern of this pattern, if any.

from Pattern
getFile

Gets the primary file where this element occurs.

from Locatable
getFullyUnresolvedfrom Element
getImmediateEnclosingPattern

Gets the parent pattern of this pattern, if any.

from Pattern
getImmediateMatchingExpr

Gets the expression that this top-level pattern is matched against, if any.

from Pattern
getImmediateType

Gets the type of this pattern, if it exists.

from Pattern
getLocation

Gets the location associated with this element in the code, if it exists.

from Locatable
getMatchingExpr

Gets the expression that this pattern is matched against, if any. The expression and the pattern need not be top-level children of a pattern-matching construct, but they must match each other syntactically.

from Pattern
getPrimaryQlClasses

Gets a comma-separated list of the names of the primary CodeQL classes to which this element belongs.

from Element
getResolveStep

Gets the most immediate element that should substitute this element in the explicit AST, if any. Classes can override this to indicate this node should be in the “hidden” AST, mostly reserved for conversions and syntactic sugar nodes like parentheses.

from Element
getType

Gets the type of this pattern, if it exists.

from Pattern
hasLocation

Holds if getLocation() exists.

from Locatable
hasMatchingExpr

Holds if this pattern is matched against an expression.

from Pattern
hasType

Holds if getType() exists.

from Pattern
isUnknown

Holds if this element is unknown.

from Element
resolve

Gets the element that should substitute this element in the explicit AST, applying getResolveStep transitively.

from Element
toString

Gets the string representation of this element.

from Element