com.android.ide.common.resources.usage

Class ResourceUsageModel

java.lang.Object

com.android.ide.common.resources.usage.ResourceUsageModel

public class ResourceUsageModel
extends java.lang.Object

A model for Android resource declarations and usages

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResourceUsageModel.Resource

Constructor Summary

Constructors

Constructor and Description
ResourceUsageModel()

Method Summary

Modifier and Type	Method and Description
ResourceUsageModel.Resource	addDeclaredResource(com.android.resources.ResourceType type, java.lang.String name, java.lang.String value, boolean declared)
ResourceUsageModel.Resource	addResource(com.android.resources.ResourceType type, java.lang.String name, java.lang.String value)
boolean	addResourceToWhitelist(ResourceUsageModel.Resource resource)
protected ResourceUsageModel.Resource	createResource(com.android.resources.ResourceType type, java.lang.String name, int realValue)
protected ResourceUsageModel.Resource	declareResource(com.android.resources.ResourceType type, java.lang.String name, org.w3c.dom.Node node)
java.lang.String	dumpReferences()
java.lang.String	dumpResourceModel()
java.lang.String	dumpWhitelistedResources()
protected java.util.List<ResourceUsageModel.Resource>	findRoots(java.util.List<ResourceUsageModel.Resource> resources)
java.util.List<ResourceUsageModel.Resource>	findUnused()
java.util.List<ResourceUsageModel.Resource>	findUnused(java.util.List<ResourceUsageModel.Resource> resources)
ResourceUsageModel.Resource	getResource(org.w3c.dom.Element element)
ResourceUsageModel.Resource	getResource(org.w3c.dom.Element element, boolean declare)
ResourceUsageModel.Resource	getResource(java.lang.Integer value)
ResourceUsageModel.Resource	getResource(com.android.resources.ResourceType type, java.lang.String name)
static java.lang.String	getResourceFieldName(org.w3c.dom.Element element)
ResourceUsageModel.Resource	getResourceFromFilePath(java.lang.String url)
ResourceUsageModel.Resource	getResourceFromUrl(java.lang.String possibleUrlReference)
java.util.Collection<java.util.Map<java.lang.String,ResourceUsageModel.Resource>>	getResourceMaps()
java.util.List<ResourceUsageModel.Resource>	getResources()
protected boolean	ignoreToolsAttributes() Whether we should ignore tools attribute resource references.
static boolean	isAnalyticsFile(java.io.File file) Returns true if this XML file corresponds to an Analytics configuration file; these contain some attributes read by the library which won't be flagged as used by the application
boolean	isSafeMode() Whether we should attempt to guess resources that should be kept based on looking at the string pool and assuming some of the strings can be used to dynamically construct the resource names.
static boolean	markReachable(ResourceUsageModel.Resource resource) Marks the given resource (if non-null) as reachable, and returns true if this is the first time the resource is marked reachable
void	processToolsAttributes()
protected java.lang.String	readText(java.io.File file)
void	recordManifestUsages(org.w3c.dom.Node node)
void	recordResourceReferences(com.android.resources.ResourceFolderType folderType, org.w3c.dom.Node node, ResourceUsageModel.Resource from) Records resource declarations and usages within an XML resource file
void	recordToolsAttributes(org.w3c.dom.Attr attr)
protected void	referencedString(java.lang.String string)
void	tokenizeCss(ResourceUsageModel.Resource from, java.lang.String css)
void	tokenizeHtml(ResourceUsageModel.Resource from, java.lang.String html)
void	tokenizeJavaCode(java.lang.String s) Adds the resource identifiers found in the given Java source code into the reference map
void	tokenizeJs(ResourceUsageModel.Resource from, java.lang.String js)
void	tokenizeUnknownBinary(ResourceUsageModel.Resource from, java.io.File file) Look through binary/unknown files looking for resource URLs
void	visitBinaryResource(com.android.resources.ResourceFolderType folderType, java.io.File file)
void	visitXmlDocument(java.io.File file, com.android.resources.ResourceFolderType folderType, org.w3c.dom.Document document)

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceUsageModel

public ResourceUsageModel()

Method Detail

getResourceFieldName

public static java.lang.String getResourceFieldName(org.w3c.dom.Element element)

getResource

@Nullable
public ResourceUsageModel.Resource getResource(org.w3c.dom.Element element)

getResource

public ResourceUsageModel.Resource getResource(org.w3c.dom.Element element,
                                               boolean declare)

getResource

@Nullable
public ResourceUsageModel.Resource getResource(@NonNull
                                                         java.lang.Integer value)

getResource

@Nullable
public ResourceUsageModel.Resource getResource(@NonNull
                                                         com.android.resources.ResourceType type,
                                                         @NonNull
                                                         java.lang.String name)

getResourceFromUrl

@Nullable
public ResourceUsageModel.Resource getResourceFromUrl(@NonNull
                                                                java.lang.String possibleUrlReference)

getResourceFromFilePath

@Nullable
public ResourceUsageModel.Resource getResourceFromFilePath(@NonNull
                                                                     java.lang.String url)

markReachable

public static boolean markReachable(@Nullable
                                    ResourceUsageModel.Resource resource)

Marks the given resource (if non-null) as reachable, and returns true if this is the first time the resource is marked reachable

recordManifestUsages

public void recordManifestUsages(org.w3c.dom.Node node)

findUnused

public java.util.List<ResourceUsageModel.Resource> findUnused()

dumpWhitelistedResources

public java.lang.String dumpWhitelistedResources()

dumpReferences

public java.lang.String dumpReferences()

dumpResourceModel

public java.lang.String dumpResourceModel()

findUnused

public java.util.List<ResourceUsageModel.Resource> findUnused(java.util.List<ResourceUsageModel.Resource> resources)

findRoots

@NonNull
protected java.util.List<ResourceUsageModel.Resource> findRoots(@NonNull
                                                                         java.util.List<ResourceUsageModel.Resource> resources)

addDeclaredResource

@NonNull
public ResourceUsageModel.Resource addDeclaredResource(@NonNull
                                                                com.android.resources.ResourceType type,
                                                                @NonNull
                                                                java.lang.String name,
                                                                @Nullable
                                                                java.lang.String value,
                                                                boolean declared)

addResourceToWhitelist

public boolean addResourceToWhitelist(@Nullable
                                      ResourceUsageModel.Resource resource)

addResource

@NonNull
public ResourceUsageModel.Resource addResource(@NonNull
                                                        com.android.resources.ResourceType type,
                                                        @NonNull
                                                        java.lang.String name,
                                                        @Nullable
                                                        java.lang.String value)

createResource

@NonNull
protected ResourceUsageModel.Resource createResource(@NonNull
                                                              com.android.resources.ResourceType type,
                                                              @NonNull
                                                              java.lang.String name,
                                                              int realValue)

isSafeMode

public boolean isSafeMode()

Whether we should attempt to guess resources that should be kept based on looking at the string pool and assuming some of the strings can be used to dynamically construct the resource names. Can be turned off via tools:shrinkMode="strict".

processToolsAttributes

public void processToolsAttributes()

recordToolsAttributes

public void recordToolsAttributes(@Nullable
                                  org.w3c.dom.Attr attr)

declareResource

protected ResourceUsageModel.Resource declareResource(com.android.resources.ResourceType type,
                                                      java.lang.String name,
                                                      org.w3c.dom.Node node)

readText

@NonNull
protected java.lang.String readText(@NonNull
                                             java.io.File file)

visitBinaryResource

public void visitBinaryResource(@Nullable
                                com.android.resources.ResourceFolderType folderType,
                                @NonNull
                                java.io.File file)

visitXmlDocument

public void visitXmlDocument(@NonNull
                             java.io.File file,
                             @Nullable
                             com.android.resources.ResourceFolderType folderType,
                             @NonNull
                             org.w3c.dom.Document document)

isAnalyticsFile

public static boolean isAnalyticsFile(java.io.File file)

Returns true if this XML file corresponds to an Analytics configuration file; these contain some attributes read by the library which won't be flagged as used by the application

Parameters:

file - the file in question

Returns:

true if the file represents an analytics file

ignoreToolsAttributes

protected boolean ignoreToolsAttributes()

Whether we should ignore tools attribute resource references.

For example, for resource shrinking we want to ignore tools attributes, whereas for resource refactoring on the source code we do not.

Returns:

whether tools attributes should be ignored

recordResourceReferences

public void recordResourceReferences(@NonNull
                                     com.android.resources.ResourceFolderType folderType,
                                     @NonNull
                                     org.w3c.dom.Node node,
                                     @Nullable
                                     ResourceUsageModel.Resource from)

Records resource declarations and usages within an XML resource file

Parameters:

folderType - the type of resource file

node - the root node to start the recursive search from

from - a referencing context, if any.

tokenizeHtml

public void tokenizeHtml(@Nullable
                         ResourceUsageModel.Resource from,
                         @NonNull
                         java.lang.String html)

tokenizeJs

public void tokenizeJs(@Nullable
                       ResourceUsageModel.Resource from,
                       @NonNull
                       java.lang.String js)

tokenizeCss

public void tokenizeCss(@Nullable
                        ResourceUsageModel.Resource from,
                        @NonNull
                        java.lang.String css)

tokenizeUnknownBinary

public void tokenizeUnknownBinary(@Nullable
                                  ResourceUsageModel.Resource from,
                                  @NonNull
                                  java.io.File file)

Look through binary/unknown files looking for resource URLs

tokenizeJavaCode

public void tokenizeJavaCode(@NonNull
                             java.lang.String s)

Adds the resource identifiers found in the given Java source code into the reference map

referencedString

protected void referencedString(@NonNull
                                java.lang.String string)

getResources

public java.util.List<ResourceUsageModel.Resource> getResources()

getResourceMaps

@NonNull
public java.util.Collection<java.util.Map<java.lang.String,ResourceUsageModel.Resource>> getResourceMaps()