com.android.ide.common.symbols

Class SymbolIo

java.lang.Object

com.android.ide.common.symbols.SymbolIo

public final class SymbolIo
extends java.lang.Object

Reads and writes symbol tables to files.

 AAR Format:
  - R.txt in AARs
     - Format is    
     - Contains the resources for this library and all its transitive dependencies.
     - Written using writeForAar()
     - Only read as part of writeSymbolListWithPackageName() as there are corrupt files with
       styleable children not below their parents in the wild.
     - IDs and styleable children don't matter, as this is only used to filtering symbols when
       generating R classes.
  - public.txt in AARs
     - Format is  
     - Contains all the resources from this AAR that are public (missing public.txt means all
       resources should be public)
     - There are no IDs or styleable children here, needs to be merged with R.txt and filtered by
       the public visibility to actually get a full list of public resources from the AAR

 AAPT2 Outputs the following formats:
  - R.txt as output by AAPT2, where ID values matter.
     - Format is    
     - Read using readFromAapt().
     - This is what the R class is generated from.
  - Partial R file format.
     - Format is    
     - Contains only the resources defined in a single source file.
     - Used to push R class generation earlier.

 Internal intermediates:
  - Symbol list with package name. Used to filter down the generated R class for this library in
    the non-namespaced case.
     - Format is   [ [, [...]]], with the first line as the package name.
     - Contains resources from this sub-project and all its transitive dependencies.
     - Read by readSymbolListWithPackageName()
     - Generated from AARs and AAPT2 symbol tables by writeSymbolListWithPackageName()
  - R def format,
     - Used for namespace backward compatibility.
     - Contains only the resources defined in a single library.
     - Has the package name as the first line.
     - May contain internal resource types (e.g. "maybe attributes" defined under declare
       styleable resources).

  All files are written in UTF-8. R files use linux-type line separators, while R.java use system
  line separators.
 

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ANDROID_ATTR_PREFIX

Method Summary

Modifier and Type	Method and Description
static java.io.File	exportToJava(com.android.ide.common.symbols.SymbolTable table, java.io.File directory, boolean finalIds) Exports a symbol table to a java R class source.
static com.android.ide.common.symbols.SymbolTable	readFromAapt(java.io.File file, java.lang.String tablePackage) Loads a symbol table from a symbol file created by aapt.
static com.android.ide.common.symbols.SymbolTable	readFromAaptNoValues(java.io.File file, java.lang.String tablePackage) Loads a symbol table from a symbol file created by aapt, but ignores all the resource values.
static com.android.ide.common.symbols.SymbolTable	readFromPartialRFile(java.io.File file, java.lang.String tablePackage) Loads a symbol table from a partial symbol file created by aapt during compilation.
static com.android.ide.common.symbols.SymbolTable	readFromPublicTxtFile(java.io.File file, java.lang.String tablePackage)
static com.android.ide.common.symbols.SymbolTable	readRDef(java.nio.file.Path file) Loads a symbol table from an partial file.
static com.android.ide.common.symbols.SymbolTable	readSymbolListWithPackageName(java.nio.file.Path file) Loads a symbol table from a synthetic namespaced symbol file.
static void	writeForAar(com.android.ide.common.symbols.SymbolTable table, java.io.File file) Writes a symbol table to a symbol file.
static void	writeForAar(com.android.ide.common.symbols.SymbolTable table, java.nio.file.Path file) Writes a symbol table to a symbol file.
static void	writeRDef(com.android.ide.common.symbols.SymbolTable table, java.nio.file.Path file) Writes a file listing the resources provided by the library.
static void	writeSymbolListWithPackageName(java.nio.file.Path symbolTable, java.nio.file.Path manifest, java.nio.file.Path outputFile) Writes the abridged symbol table with the package name as the first line.
static void	writeSymbolListWithPackageName(java.nio.file.Path symbolTable, java.lang.String packageName, java.nio.file.Path outputFile) Writes the symbol table with the package name as the first line.

Methods inherited from class java.lang.Object

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

Field Detail

ANDROID_ATTR_PREFIX

public static final java.lang.String ANDROID_ATTR_PREFIX

See Also:

Constant Field Values

Method Detail

readFromAapt

@NonNull
public static com.android.ide.common.symbols.SymbolTable readFromAapt(@NonNull
                                                                               java.io.File file,
                                                                               @Nullable
                                                                               java.lang.String tablePackage)
                                                                        throws java.io.IOException

Loads a symbol table from a symbol file created by aapt.

Parameters:

file - the symbol file

tablePackage - the package name associated with the table

Returns:

the table read

Throws:

java.io.IOException - failed to read the table

readFromAaptNoValues

@NonNull
public static com.android.ide.common.symbols.SymbolTable readFromAaptNoValues(@NonNull
                                                                                       java.io.File file,
                                                                                       @Nullable
                                                                                       java.lang.String tablePackage)
                                                                                throws java.io.IOException

Loads a symbol table from a symbol file created by aapt, but ignores all the resource values. It will also ignore any styleable children that are not under their parents.

Parameters:

file - the symbol file

tablePackage - the package name associated with the table

Returns:

the table read

Throws:

java.io.IOException - failed to read the table

readFromPartialRFile

@NonNull
public static com.android.ide.common.symbols.SymbolTable readFromPartialRFile(@NonNull
                                                                                       java.io.File file,
                                                                                       @Nullable
                                                                                       java.lang.String tablePackage)
                                                                                throws java.io.IOException

Loads a symbol table from a partial symbol file created by aapt during compilation.

Parameters:

file - the partial symbol file

tablePackage - the package name associated with the table

Returns:

the table read

Throws:

java.io.IOException - failed to read the table

readFromPublicTxtFile

@NonNull
public static com.android.ide.common.symbols.SymbolTable readFromPublicTxtFile(@NonNull
                                                                                        java.io.File file,
                                                                                        @Nullable
                                                                                        java.lang.String tablePackage)
                                                                                 throws java.io.IOException

Throws:

java.io.IOException

readSymbolListWithPackageName

@NonNull
public static com.android.ide.common.symbols.SymbolTable readSymbolListWithPackageName(@NonNull
                                                                                                java.nio.file.Path file)
                                                                                         throws java.io.IOException

Loads a symbol table from a synthetic namespaced symbol file.

See writeSymbolListWithPackageName(Path, Path, Path) for format details.

Parameters:

file - the symbol file

Returns:

the table read

Throws:

java.io.IOException - failed to read the table

readRDef

@NonNull
public static com.android.ide.common.symbols.SymbolTable readRDef(@NonNull
                                                                           java.nio.file.Path file)
                                                                    throws java.io.IOException

Loads a symbol table from an partial file.

Parameters:

file - the symbol file

Returns:

the table read

Throws:

java.io.IOException - failed to read the table

writeForAar

public static void writeForAar(@NonNull
                               com.android.ide.common.symbols.SymbolTable table,
                               @NonNull
                               java.io.File file)
                        throws java.io.IOException

Writes a symbol table to a symbol file.

Parameters:

table - the table

file - the file where the table should be written

Throws:

java.io.IOException - I/O error

writeForAar

public static void writeForAar(@NonNull
                               com.android.ide.common.symbols.SymbolTable table,
                               @NonNull
                               java.nio.file.Path file)
                        throws java.io.IOException

Writes a symbol table to a symbol file.

Parameters:

table - the table

file - the file where the table should be written

Throws:

java.io.IOException - I/O error

writeRDef

public static void writeRDef(@NonNull
                             com.android.ide.common.symbols.SymbolTable table,
                             @NonNull
                             java.nio.file.Path file)
                      throws java.io.IOException

Writes a file listing the resources provided by the library.

This uses the symbol list with package name format of "<type> <name>[ <child>[ <child>[ ...]]]" .

Throws:

java.io.IOException

writeSymbolListWithPackageName

public static void writeSymbolListWithPackageName(@NonNull
                                                  java.nio.file.Path symbolTable,
                                                  @NonNull
                                                  java.nio.file.Path manifest,
                                                  @NonNull
                                                  java.nio.file.Path outputFile)
                                           throws java.io.IOException

Writes the abridged symbol table with the package name as the first line.

This collapses the styleable children so the subsequent lines have the format "<type> <canonical_name>[ <child>[ <child>[ ...]]]"

Parameters:

symbolTable - The R.txt file. If it does not exist, the result will be a file containing only the package name

manifest - The AndroidManifest.xml file for this library. The package name is extracted and written as the first line of the output.

outputFile - The file to write the result to.

Throws:

java.io.IOException

writeSymbolListWithPackageName

public static void writeSymbolListWithPackageName(@NonNull
                                                  java.nio.file.Path symbolTable,
                                                  @Nullable
                                                  java.lang.String packageName,
                                                  @NonNull
                                                  java.nio.file.Path outputFile)
                                           throws java.io.IOException

Writes the symbol table with the package name as the first line.

This collapses the styleable children so the subsequent lines have the format "<type> <canonical_name>[ <child>[ <child>[ ...]]]"

Parameters:

symbolTable - The R.txt file. If it does not exist, the result will be a file containing only the package name

packageName - The package name for the module. If not null, it will be written as the first line of output.

outputFile - The file to write the result to.

Throws:

java.io.IOException

exportToJava

@NonNull
public static java.io.File exportToJava(@NonNull
                                                 com.android.ide.common.symbols.SymbolTable table,
                                                 @NonNull
                                                 java.io.File directory,
                                                 boolean finalIds)

Exports a symbol table to a java R class source. This method will create the source file and any necessary directories. For example, if the package is a.b and the class name is RR, this method will generate a file called RR.java in directory directory/a/b creating directories a and b if necessary.

Parameters:

table - the table to export

directory - the directory where the R source should be generated

finalIds - should the generated IDs be final?

Returns:

the generated file

Throws:

java.io.UncheckedIOException - failed to generate the source