KtPsiUtil¶

An element that wraps a base expression, such as a parenthesized or annotated expression.

If element is a property accessor, returns its owning property; otherwise returns element unchanged.

Returns true if block contains a variable declaration named varName.

Returns true if whenExpression has exactly one else branch.

Recursively unwraps parentheses, labels, and annotations from the given expression.

Recursively unwraps parentheses and labels (and annotations unless keepAnnotations is true) from the given expression, returning the innermost wrapped expression.

Unwraps a single layer of parentheses, label, or annotation from the given expression.

Unwraps a single layer of parentheses or label (and annotation unless keepAnnotations is true) from the given expression.

Returns the first direct child of element with the given node type, or null if there is none.

Returns the subset of unreachableElements that are not contained within any other element of the set.

If ktParameter is a primary-constructor val/var property parameter, returns the class or object that declares it; otherwise returns null.

Returns the enclosing element of type aClass for which block is a direct body (an if branch, a when entry, a lambda body, or a try/catch body), or null otherwise.

Returns the innermost element that scopes declaration as a local declaration (a block, parameter, and so on), or null if the declaration is not local. See getEnclosingElementForLocalDeclaration with skipParameters.

Returns the innermost element that scopes declaration as a local declaration, or null if it is not local. When skipParameters is true, type and value parameters delegate to their owning declaration.

Returns the last statement of expression if it is a block, otherwise expression itself.

Returns the last direct child of root whose type is one of elementTypes, or null if there is none.

Deparenthesizes expression and, if it is a block, recurses into the block's last statement (respecting statementFilter), returning the innermost "result" expression.

Returns the last (rightmost) simple-name reference of the given qualified importedReference, or null.

Returns the last statement of the given block, or null if the block is null or empty.

Returns the text of element, or null if element is null.

Returns the operation token of expression (for example, PLUS), or null if unavailable.

Returns the outermost class that lexically encloses (and includes) the given class.

Starting from classOrObject, this repeatedly ascends to the enclosing class and returns the last one reached — the top of the class-nesting chain.

The walk stops as soon as a declaration has no enclosing class; in particular:

• a top-level class is returned unchanged;
• a nested or inner class resolves to the top-level class that contains it;
• a local class (declared inside a code block) is returned unchanged, and the walk never crosses out of a local class into its surrounding block — so a class nested inside a local class resolves to that local class rather than to any top-level declaration. Note: a class declared inside a companion { } block (which is invalid code) is treated as nested directly in the class that owns the block. Example:

class Top {
    class Nested

    fun build() {
        class Local {
            inner class InsideLocal
        }
    }
}

For these declarations, getOutermostClassOrObject(nested) returns top, while calls for local and insideLocal both return local. The search does not cross the local-class boundary.

Return

the outermost enclosing class; never null — at minimum classOrObject itself

Parameters

• classOrObject: the class to start the search from

Traverses root and its subtree, collecting the outermost elements that satisfy predicate without descending into a match. Returns the first or last match in depth-first traversal order, as selected by first, or null if there is none. If root matches, it is the only result.

Example:

class First {
    class Nested
}
class Second

Given the containing file, the following searches return First and Second, respectively:

KtElement firstClass = getOutermostDescendantElement(file, true, element -> element instanceof KtClass);
KtElement lastClass = getOutermostDescendantElement(file, false, element -> element instanceof KtClass);

Nested is not considered because the traversal does not descend into First after it matches.

Returns the outermost ancestor of element that is still a direct child of upperBound, or null. When strict is false, element itself is considered.

Returns the dot-separated package name of the file containing element, or null if unavailable.

Returns the nearest enclosing call-like expression that expression is an operand or argument of, looking through parentheses, casts, argument lists, lambdas, and labels, or null if there is none.

Example:

consume((value as String))
consume(left + right)

For the first statement, calling this method on the value expression returns the consume(...) call because casts and parentheses are skipped. For the second statement, calling it on left returns the nearer binary expression left + right rather than the outer consume(...) call.

Returns the previous leaf if it is the identifier word (skipping whitespace and comments), or null.

Returns the script this declaration is a top-level member of, or null if it is not in a script.

Returns the text of element, or an empty string if element is null.

Returns the topmost ancestor of element (or the enclosing file) whose type is one of parentTypes, or null if there is none.

Returns true if declaration has no body expression. This is a syntactic check; it does not inspect the abstract modifier or determine whether the declaration is semantically abstract.

Returns true if element is an assignment (= or an augmented assignment such as +=).

Returns true if condition is a boolean literal (true or false).

Returns true if expression is a cast, whether safe (as?) or unsafe (as).

Returns true if owner is syntactically annotated with @Deprecated (by short name only).

Returns true if condition is the boolean literal false.

Returns true if element is a comment or is inside a KDoc comment.

isComment does not recognize elements inside a comment. KDoc tokens cannot be added to the general comment token set because the parser ignores every token in that set.

Returns true if binaryExpression is an in or !in membership check.

Returns true if functionLiteral's enclosing lambda expression carries a label.

Returns true if element is a label reference expression.

Returns true if expression is on the left-hand side (the receiver) of a qualified ./?. expression.

Returns true if declaration is local (declared inside a function body or other local scope).

Returns true if binaryExpression is a !in (not-in) membership check.

Returns true if expression (after deparenthesizing) is the null literal.

Returns true if element is a plain assignment (=), excluding augmented assignments.

Returns true if declaration has a PSI form supported by unused-variable cleanup: a property can be removed and a destructuring entry can be replaced with _. This is a syntactic classification; it does not determine whether the declaration is unused or whether removing it preserves behavior.

Returns true if expression is a safe cast (as?).

Returns true if namedDeclaration is a top-level declaration of a script.

Returns true if nameExpression is the selector of a qualified expression or qualified user type.

Returns true if element appears in a statement position (its parent is a statement container).

Returns true if container is an element whose children are statements (a block, control-structure body, or when entry).

Returns true if classOrObject is an interface.

Returns true if condition is the boolean literal true.

Returns true if expression is an unsafe cast (as).

Returns the previous leaf before element, skipping whitespace and comments, or null.

Like deparenthesize, but returns expression itself if there is nothing to unwrap.

Returns name as a Name, or the special "no name provided" name if name is null.

Returns the first preceding sibling of element not matched by elementsToSkip, or null.

Returns the first following sibling of element that is neither whitespace nor a comment, or null.

Removes surrounding backticks from a backtick-quoted identifier, returning quoted unchanged if it has none.

Like unquoteIdentifier, but also handles a leading $ field-reference prefix.

Dispatches each direct KtElement child of the given element to the visitor.