com.android.tools.lint.helpers

Class DefaultUastParser

java.lang.Object

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

com.android.tools.lint.helpers.DefaultUastParser

public class DefaultUastParser
extends UastParser

Constructor Summary

Constructors

Constructor and Description
DefaultUastParser(Project project, com.intellij.openapi.project.Project p)

Method Summary

Modifier and Type	Method and Description
Location	createLocation(com.intellij.psi.PsiElement element)
Location	createLocation(org.jetbrains.uast.UElement element)
Location	getCallLocation(JavaContext context, org.jetbrains.uast.UCallExpression call, boolean includeReceiver, boolean includeArguments)
JavaEvaluator	getEvaluator() Returns an evaluator which can perform various resolution tasks, evaluate inheritance lookup etc.
java.io.File	getFile(com.intellij.psi.PsiFile file)
java.lang.CharSequence	getFileContents(com.intellij.psi.PsiFile file)
Location	getLocation(JavaContext context, com.intellij.psi.PsiElement element) Returns a Location for the given element
Location	getLocation(JavaContext context, org.jetbrains.uast.UElement element)
Location	getNameLocation(JavaContext context, com.intellij.psi.PsiElement element) Returns a Location for the given node.
Location	getNameLocation(JavaContext context, org.jetbrains.uast.UElement element)
Location	getRangeLocation(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.
Location	getRangeLocation(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).
Location	getRangeLocation(JavaContext context, org.jetbrains.uast.UElement from, int fromDelta, int toDelta)
Location	getRangeLocation(JavaContext context, org.jetbrains.uast.UElement from, int fromDelta, org.jetbrains.uast.UElement to, int toDelta)
org.jetbrains.uast.UastContext	getUastContext() Returns a UastContext which can provide UAST representations for source files
org.jetbrains.uast.UFile	parse(JavaContext context) Parse the file pointed to by the given context.
boolean	prepare(java.util.List<JavaContext> contexts) Prepare to parse the given contexts.

Methods inherited from class com.android.tools.lint.client.api.UastParser

dispose, dispose

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultUastParser

public DefaultUastParser(@Nullable
                         Project project,
                         @NonNull
                         com.intellij.openapi.project.Project p)

Method Detail

prepare

public boolean prepare(@NonNull
                       java.util.List<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

Overrides:

prepare in class UastParser

Parameters:

contexts - a list of contexts to be parsed

Returns:

true if the preparation succeeded; false if there were errors

getEvaluator

@NonNull
public JavaEvaluator getEvaluator()

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

Specified by:

getEvaluator in class UastParser

Returns:

an evaluator

parse

@Nullable
public org.jetbrains.uast.UFile parse(@NonNull
                                                JavaContext context)

Parse the file pointed to by the given context.

Specified by:

parse in class UastParser

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 org.jetbrains.uast.UastContext getUastContext()

Returns a UastContext which can provide UAST representations for source files

Specified by:

getUastContext in class UastParser

getLocation

@NonNull
public Location getLocation(@NonNull
                                     JavaContext context,
                                     @NonNull
                                     com.intellij.psi.PsiElement element)

Returns a Location for the given element

Specified by:

getLocation in class UastParser

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 Location getLocation(@NonNull
                                     JavaContext context,
                                     @NonNull
                                     org.jetbrains.uast.UElement element)

Specified by:

getLocation in class UastParser

getCallLocation

@NonNull
public Location getCallLocation(@NonNull
                                         JavaContext context,
                                         @NonNull
                                         org.jetbrains.uast.UCallExpression call,
                                         boolean includeReceiver,
                                         boolean includeArguments)

Specified by:

getCallLocation in class UastParser

getFile

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

Specified by:

getFile in class UastParser

getFileContents

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

Specified by:

getFileContents in class UastParser

createLocation

@NonNull
public Location createLocation(@NonNull
                                        com.intellij.psi.PsiElement element)

Specified by:

createLocation in class UastParser

createLocation

@NonNull
public Location createLocation(@NonNull
                                        org.jetbrains.uast.UElement element)

Specified by:

createLocation in class UastParser

getRangeLocation

@NonNull
public Location getRangeLocation(@NonNull
                                          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).

Specified by:

getRangeLocation in class UastParser

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 Location getRangeLocation(@NonNull
                                          JavaContext context,
                                          @NonNull
                                          org.jetbrains.uast.UElement from,
                                          int fromDelta,
                                          @NonNull
                                          org.jetbrains.uast.UElement to,
                                          int toDelta)

Specified by:

getRangeLocation in class UastParser

getRangeLocation

@NonNull
public Location getRangeLocation(@NonNull
                                          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.

Specified by:

getRangeLocation in class UastParser

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 Location getRangeLocation(@NonNull
                                          JavaContext context,
                                          @NonNull
                                          org.jetbrains.uast.UElement from,
                                          int fromDelta,
                                          int toDelta)

Specified by:

getRangeLocation in class UastParser

getNameLocation

@NonNull
public Location getNameLocation(@NonNull
                                         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.

Specified by:

getNameLocation in class UastParser

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 Location getNameLocation(@NonNull
                                         JavaContext context,
                                         @NonNull
                                         org.jetbrains.uast.UElement element)

Specified by:

getNameLocation in class UastParser