com.android.tools.lint.client.api

Class UastParser

java.lang.Object

com.android.tools.lint.client.api.UastParser

@Beta
public abstract class UastParser
extends java.lang.Object

A wrapper for a UAST parser. This allows tools integrating lint to map directly to builtin services, such as already-parsed data structures in Java editors.

NOTE: This is not public or final API; if you rely on this be prepared to adjust your code for the next tools release.

Constructor Summary

Constructors

Constructor and Description
UastParser()

Method Summary

Modifier and Type	Method and Description
abstract com.android.tools.lint.detector.api.Location	createLocation(com.intellij.psi.PsiElement element)
abstract com.android.tools.lint.detector.api.Location	createLocation(org.jetbrains.uast.UElement element)
void	dispose() Dispose any remaining data structures held for all contexts.
void	dispose(com.android.tools.lint.detector.api.JavaContext context, org.jetbrains.uast.UFile compilationUnit) Dispose any data structures held for the given context.
abstract com.android.tools.lint.detector.api.Location	getCallLocation(com.android.tools.lint.detector.api.JavaContext context, org.jetbrains.uast.UCallExpression call, boolean includeReceiver, boolean includeArguments)
abstract JavaEvaluator	getEvaluator() Returns an evaluator which can perform various resolution tasks, evaluate inheritance lookup etc.
abstract java.io.File	getFile(com.intellij.psi.PsiFile file)
abstract java.lang.CharSequence	getFileContents(com.intellij.psi.PsiFile file)
abstract com.android.tools.lint.detector.api.Location	getLocation(com.android.tools.lint.detector.api.JavaContext context, com.intellij.psi.PsiElement element) Returns a Location for the given element
abstract com.android.tools.lint.detector.api.Location	getLocation(com.android.tools.lint.detector.api.JavaContext context, org.jetbrains.uast.UElement element)
abstract com.android.tools.lint.detector.api.Location	getNameLocation(com.android.tools.lint.detector.api.JavaContext context, com.intellij.psi.PsiElement element) Returns a Location for the given node.
abstract com.android.tools.lint.detector.api.Location	getNameLocation(com.android.tools.lint.detector.api.JavaContext context, org.jetbrains.uast.UElement element)
abstract com.android.tools.lint.detector.api.Location	getRangeLocation(com.android.tools.lint.detector.api.JavaContext context, com.intellij.psi.PsiElement from, int fromDelta, int toDelta) Like getRangeLocation(JavaContext, PsiElement, int, PsiElement, int) but both offsets are relative to the starting offset of the given node.
abstract com.android.tools.lint.detector.api.Location	getRangeLocation(com.android.tools.lint.detector.api.JavaContext context, com.intellij.psi.PsiElement from, int fromDelta, com.intellij.psi.PsiElement to, int toDelta) Returns a Location for the given node range (from the starting offset of the first node to the ending offset of the second node).
abstract com.android.tools.lint.detector.api.Location	getRangeLocation(com.android.tools.lint.detector.api.JavaContext context, org.jetbrains.uast.UElement from, int fromDelta, int toDelta)
abstract com.android.tools.lint.detector.api.Location	getRangeLocation(com.android.tools.lint.detector.api.JavaContext context, org.jetbrains.uast.UElement from, int fromDelta, org.jetbrains.uast.UElement to, int toDelta)
abstract org.jetbrains.uast.UastContext	getUastContext() Returns a UastContext which can provide UAST representations for source files
abstract org.jetbrains.uast.UFile	parse(com.android.tools.lint.detector.api.JavaContext context) Parse the file pointed to by the given context.
boolean	prepare(java.util.List<? extends com.android.tools.lint.detector.api.JavaContext> contexts) Prepare to parse the given contexts.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UastParser

public UastParser()

Method Detail

prepare

public boolean prepare(@NonNull
                       java.util.List<? extends com.android.tools.lint.detector.api.JavaContext> contexts)

Prepare to parse the given contexts. This method will be called before a series of parse(JavaContext) calls, which allows some parsers to do up front global computation in case they want to more efficiently process multiple files at the same time. This allows a single type-attribution pass for example, which is a lot more efficient than performing global type analysis over and over again for each individual file

Parameters:

contexts - a list of contexts to be parsed

Returns:

true if the preparation succeeded; false if there were errors

getEvaluator

@NonNull
public abstract JavaEvaluator getEvaluator()

Returns an evaluator which can perform various resolution tasks, evaluate inheritance lookup etc.

Returns:

an evaluator

parse

@Nullable
public abstract org.jetbrains.uast.UFile parse(@NonNull
                                                         com.android.tools.lint.detector.api.JavaContext context)

Parse the file pointed to by the given context.

Parameters:

context - the context pointing to the file to be parsed, typically via Context.getContents() but the file handle ( Context.file can also be used to map to an existing editor buffer in the surrounding tool, etc)

Returns:

the compilation unit node for the file

getUastContext

@Nullable
public abstract org.jetbrains.uast.UastContext getUastContext()

Returns a UastContext which can provide UAST representations for source files

getLocation

@NonNull
public abstract com.android.tools.lint.detector.api.Location getLocation(@NonNull
                                                                                  com.android.tools.lint.detector.api.JavaContext context,
                                                                                  @NonNull
                                                                                  com.intellij.psi.PsiElement element)

Returns a Location for the given element

Parameters:

context - information about the file being parsed

element - the element to create a location for

Returns:

a location for the given node

getLocation

@NonNull
public abstract com.android.tools.lint.detector.api.Location getLocation(@NonNull
                                                                                  com.android.tools.lint.detector.api.JavaContext context,
                                                                                  @NonNull
                                                                                  org.jetbrains.uast.UElement element)

getCallLocation

@NonNull
public abstract com.android.tools.lint.detector.api.Location getCallLocation(@NonNull
                                                                                      com.android.tools.lint.detector.api.JavaContext context,
                                                                                      @NonNull
                                                                                      org.jetbrains.uast.UCallExpression call,
                                                                                      boolean includeReceiver,
                                                                                      boolean includeArguments)

getFile

@Nullable
public abstract java.io.File getFile(@NonNull
                                               com.intellij.psi.PsiFile file)

getFileContents

@NonNull
public abstract java.lang.CharSequence getFileContents(@NonNull
                                                                com.intellij.psi.PsiFile file)

createLocation

@NonNull
public abstract com.android.tools.lint.detector.api.Location createLocation(@NonNull
                                                                                     com.intellij.psi.PsiElement element)

createLocation

@NonNull
public abstract com.android.tools.lint.detector.api.Location createLocation(@NonNull
                                                                                     org.jetbrains.uast.UElement element)

getRangeLocation

@NonNull
public abstract com.android.tools.lint.detector.api.Location getRangeLocation(@NonNull
                                                                                       com.android.tools.lint.detector.api.JavaContext context,
                                                                                       @NonNull
                                                                                       com.intellij.psi.PsiElement from,
                                                                                       int fromDelta,
                                                                                       @NonNull
                                                                                       com.intellij.psi.PsiElement to,
                                                                                       int toDelta)

Returns a Location for the given node range (from the starting offset of the first node to the ending offset of the second node).

Parameters:

context - information about the file being parsed

from - the AST node to get a starting location from

fromDelta - Offset delta to apply to the starting offset

to - the AST node to get a ending location from

toDelta - Offset delta to apply to the ending offset

Returns:

a location for the given node

getRangeLocation

@NonNull
public abstract com.android.tools.lint.detector.api.Location getRangeLocation(@NonNull
                                                                                       com.android.tools.lint.detector.api.JavaContext context,
                                                                                       @NonNull
                                                                                       org.jetbrains.uast.UElement from,
                                                                                       int fromDelta,
                                                                                       @NonNull
                                                                                       org.jetbrains.uast.UElement to,
                                                                                       int toDelta)

getRangeLocation

@NonNull
public abstract com.android.tools.lint.detector.api.Location getRangeLocation(@NonNull
                                                                                       com.android.tools.lint.detector.api.JavaContext context,
                                                                                       @NonNull
                                                                                       com.intellij.psi.PsiElement from,
                                                                                       int fromDelta,
                                                                                       int toDelta)

Like getRangeLocation(JavaContext, PsiElement, int, PsiElement, int) but both offsets are relative to the starting offset of the given node. This is sometimes more convenient than operating relative to the ending offset when you have a fixed range in mind.

Parameters:

context - information about the file being parsed

from - the AST node to get a starting location from

fromDelta - Offset delta to apply to the starting offset

toDelta - Offset delta to apply to the starting offset

Returns:

a location for the given node

getRangeLocation

@NonNull
public abstract com.android.tools.lint.detector.api.Location getRangeLocation(@NonNull
                                                                                       com.android.tools.lint.detector.api.JavaContext context,
                                                                                       @NonNull
                                                                                       org.jetbrains.uast.UElement from,
                                                                                       int fromDelta,
                                                                                       int toDelta)

getNameLocation

@NonNull
public abstract com.android.tools.lint.detector.api.Location getNameLocation(@NonNull
                                                                                      com.android.tools.lint.detector.api.JavaContext context,
                                                                                      @NonNull
                                                                                      com.intellij.psi.PsiElement element)

Returns a Location for the given node. This attempts to pick a shorter location range than the entire node; for a class or method for example, it picks the name node (if found). For statement constructs such as a switch statement it will highlight the keyword, etc.

Parameters:

context - information about the file being parsed

element - the node to create a location for

Returns:

a location for the given node

getNameLocation

@NonNull
public abstract com.android.tools.lint.detector.api.Location getNameLocation(@NonNull
                                                                                      com.android.tools.lint.detector.api.JavaContext context,
                                                                                      @NonNull
                                                                                      org.jetbrains.uast.UElement element)

dispose

public void dispose(@NonNull
                    com.android.tools.lint.detector.api.JavaContext context,
                    @NonNull
                    org.jetbrains.uast.UFile compilationUnit)

Dispose any data structures held for the given context.

Parameters:

context - information about the file previously parsed

compilationUnit - the compilation unit being disposed

dispose

public void dispose()

Dispose any remaining data structures held for all contexts. Typically frees up any resources allocated by prepare(List)