com.android.builder.symbols

Class SymbolUtils

java.lang.Object

com.android.builder.symbols.SymbolUtils

public final class SymbolUtils
extends java.lang.Object

Helper methods related to Symbols and resource processing.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SymbolUtils.SymbolTableGenerationMode

Constructor Summary

Constructors

Constructor and Description
SymbolUtils()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	canonicalizeValueResourceName(java.lang.String name) Updates the value resource name to mimic aapt's behaviour - replaces all dots and colons with underscores.
static java.util.List<java.lang.String>	generateMainDexKeepRules(com.android.ide.common.xml.ManifestData manifest, java.io.File mergedResources) Generates keep rules based on the nodes declared in the manifest file.
static java.util.List<java.lang.String>	generateMinifyKeepRules(com.android.ide.common.xml.ManifestData manifest, java.io.File mergedResources) Generates keep rules based on the nodes declared in the manifest file.
static void	generateRTxt(SymbolTable table, java.io.File directory) Creates and writes a symbol table into an R.txt file in a given directory.
static java.lang.String	getPackageNameFromManifest(java.io.File manifestFile) Pulls out the package name from the given android manifest.
static java.lang.String	getPackageNameFromManifest(com.android.ide.common.xml.ManifestData manifest) Pulls out the package name from the given parsed android manifest.
static java.util.Set<SymbolTable>	loadDependenciesSymbolTables(java.util.Set<java.io.File> libraries, java.lang.String mainPackageName) Load symbol tables of each library on which the main library/application depends on.
static com.android.ide.common.xml.ManifestData	parseManifest(java.io.File manifestFile)
static void	processLibraryMainSymbolTable(SymbolTable librarySymbols, java.util.Set<java.io.File> libraries, java.lang.String mainPackageName, java.io.File manifestFile, java.io.File sourceOut, java.io.File symbolsOut, java.io.File proguardOut, java.io.File mergedResources, SymbolTable platformSymbols, boolean disableMergeInLib) Processes the symbol table and generates necessary files: R.txt, R.java and proguard rules (aapt_rules.txt).

Methods inherited from class java.lang.Object

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

Constructor Detail

SymbolUtils

public SymbolUtils()

Method Detail

processLibraryMainSymbolTable

public static void processLibraryMainSymbolTable(@NonNull
                                                 SymbolTable librarySymbols,
                                                 @NonNull
                                                 java.util.Set<java.io.File> libraries,
                                                 @Nullable
                                                 java.lang.String mainPackageName,
                                                 @NonNull
                                                 java.io.File manifestFile,
                                                 @NonNull
                                                 java.io.File sourceOut,
                                                 @NonNull
                                                 java.io.File symbolsOut,
                                                 @Nullable
                                                 java.io.File proguardOut,
                                                 @Nullable
                                                 java.io.File mergedResources,
                                                 @NonNull
                                                 SymbolTable platformSymbols,
                                                 boolean disableMergeInLib)
                                          throws java.io.IOException

Processes the symbol table and generates necessary files: R.txt, R.java and proguard rules (aapt_rules.txt). Afterwards generates R.java for all libraries the main library depends on.

Parameters:

librarySymbols - table with symbols of resources for the library.

libraries - libraries which this library depends on

mainPackageName - package name of this library

manifestFile - manifest file

sourceOut - directory to contain R.java

symbolsOut - directory to contain R.txt

proguardOut - directory to contain proguard rules

mergedResources - directory containing merged resources

Throws:

java.io.IOException

loadDependenciesSymbolTables

@NonNull
public static java.util.Set<SymbolTable> loadDependenciesSymbolTables(@NonNull
                                                                               java.util.Set<java.io.File> libraries,
                                                                               @NonNull
                                                                               java.lang.String mainPackageName)
                                                                        throws java.io.IOException

Load symbol tables of each library on which the main library/application depends on.

Parameters:

libraries - libraries which the main library/application depends on

mainPackageName - package name of the main library/application

Returns:

a set of of symbol table for each library

Throws:

java.io.IOException

getPackageNameFromManifest

@NonNull
public static java.lang.String getPackageNameFromManifest(@NonNull
                                                                   java.io.File manifestFile)
                                                            throws java.io.IOException

Pulls out the package name from the given android manifest.

Parameters:

manifestFile - manifest file of the library

Returns:

package name held in the manifest

Throws:

java.io.IOException - if there is a problem reading the manifest or if the manifest does not contain a package name

getPackageNameFromManifest

@NonNull
public static java.lang.String getPackageNameFromManifest(@NonNull
                                                                   com.android.ide.common.xml.ManifestData manifest)

Pulls out the package name from the given parsed android manifest.

Parameters:

manifest - the parsed manifest of the library

Returns:

package name held in the manifest

generateMinifyKeepRules

public static java.util.List<java.lang.String> generateMinifyKeepRules(@NonNull
                                                                       com.android.ide.common.xml.ManifestData manifest,
                                                                       @Nullable
                                                                       java.io.File mergedResources)
                                                                throws java.io.IOException

Generates keep rules based on the nodes declared in the manifest file.

Used in the new resource processing, since aapt is not used in processing libraries' resources and the aapt_rules.txt file and its rules are required by minify.

Goes through all application, instrumentation, activity, service, provider and receiver keep class data in the manifest, generates keep rules for each of them and returns them as a list.

For examples refer to SymbolUtilsTest.java.

Parameters:

manifest - containing keep class data

Throws:

java.io.IOException

generateMainDexKeepRules

public static java.util.List<java.lang.String> generateMainDexKeepRules(@NonNull
                                                                        com.android.ide.common.xml.ManifestData manifest,
                                                                        @Nullable
                                                                        java.io.File mergedResources)
                                                                 throws java.io.IOException

Generates keep rules based on the nodes declared in the manifest file.

When AAPT2 is enabled, this method is called to generate manifest_keep.txt file for Dex. Goes through all application, instrumentation, activity, service, provider and receiver nodes and generates keep rules for each of them, as long as the node doesn't declare it belongs to a private process. Returns the keep rules as a list.

For examples refer to SymbolUtilsTest.java.

Parameters:

manifest - containing keep class data

Throws:

java.io.IOException

generateRTxt

public static void generateRTxt(@NonNull
                                SymbolTable table,
                                @NonNull
                                java.io.File directory)

Creates and writes a symbol table into an R.txt file in a given directory.

Parameters:

table - the table

directory - the directory where the table should be written

parseManifest

public static com.android.ide.common.xml.ManifestData parseManifest(@NonNull
                                                                    java.io.File manifestFile)
                                                             throws java.io.IOException

Throws:

java.io.IOException

canonicalizeValueResourceName

@NonNull
public static java.lang.String canonicalizeValueResourceName(@NonNull
                                                                      java.lang.String name)

Updates the value resource name to mimic aapt's behaviour - replaces all dots and colons with underscores.

If the name contains whitespaces or other illegal characters, they are not checked in this method, but caught in the Symbol constructor call to Symbol.validateSymbol(java.lang.String, com.android.resources.ResourceType).

Parameters:

name - the resource name to be updated

Returns:

a valid resource name