/* * Copyright (C) 2006 The Android Open Source Project * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package android.content.res; import android.animation.Animator; import android.animation.StateListAnimator; import android.annotation.NonNull; import android.util.Pools.SynchronizedPool; import android.view.ViewDebug; import com.android.internal.util.XmlUtils; import org.xmlpull.v1.XmlPullParser; import org.xmlpull.v1.XmlPullParserException; import android.annotation.Nullable; import android.content.pm.ActivityInfo; import android.graphics.Movie; import android.graphics.drawable.Drawable; import android.graphics.drawable.ColorDrawable; import android.graphics.drawable.Drawable.ConstantState; import android.os.Build; import android.os.Bundle; import android.os.IBinder; import android.os.Trace; import android.util.ArrayMap; import android.util.AttributeSet; import android.util.DisplayMetrics; import android.util.Log; import android.util.Slog; import android.util.TypedValue; import android.util.LongSparseArray; import java.io.IOException; import java.io.InputStream; import java.lang.ref.WeakReference; import java.util.Locale; import libcore.icu.NativePluralRules; /** * Class for accessing an application's resources. This sits on top of the * asset manager of the application (accessible through {@link #getAssets}) and * provides a high-level API for getting typed data from the assets. * *

The Android resource system keeps track of all non-code assets associated with an * application. You can use this class to access your application's resources. You can generally * acquire the {@link android.content.res.Resources} instance associated with your application * with {@link android.content.Context#getResources getResources()}.

* *

The Android SDK tools compile your application's resources into the application binary * at build time. To use a resource, you must install it correctly in the source tree (inside * your project's {@code res/} directory) and build your application. As part of the build * process, the SDK tools generate symbols for each resource, which you can use in your application * code to access the resources.

* *

Using application resources makes it easy to update various characteristics of your * application without modifying code, and—by providing sets of alternative * resources—enables you to optimize your application for a variety of device configurations * (such as for different languages and screen sizes). This is an important aspect of developing * Android applications that are compatible on different types of devices.

* *

For more information about using resources, see the documentation about Application Resources.

*/ public class Resources { static final String TAG = "Resources"; private static final boolean DEBUG_LOAD = false; private static final boolean DEBUG_CONFIG = false; private static final boolean TRACE_FOR_PRELOAD = false; private static final boolean TRACE_FOR_MISS_PRELOAD = false; private static final int LAYOUT_DIR_CONFIG = ActivityInfo.activityInfoConfigToNative( ActivityInfo.CONFIG_LAYOUT_DIRECTION); private static final int ID_OTHER = 0x01000004; private static final Object sSync = new Object(); // Information about preloaded resources. Note that they are not // protected by a lock, because while preloading in zygote we are all // single-threaded, and after that these are immutable. private static final LongSparseArray[] sPreloadedDrawables; private static final LongSparseArray sPreloadedColorDrawables = new LongSparseArray(); private static final LongSparseArray sPreloadedColorStateLists = new LongSparseArray(); // Pool of TypedArrays targeted to this Resources object. final SynchronizedPool mTypedArrayPool = new SynchronizedPool(5); // Used by BridgeResources in layoutlib static Resources mSystem = null; private static boolean sPreloaded; private static int sPreloadedDensity; // These are protected by mAccessLock. private final Object mAccessLock = new Object(); private final Configuration mTmpConfig = new Configuration(); private final ArrayMap>> mDrawableCache = new ArrayMap>>(); private final ArrayMap>> mColorDrawableCache = new ArrayMap>>(); private final LongSparseArray> mColorStateListCache = new LongSparseArray>(); private final ConfigurationBoundResourceCache mAnimatorCache = new ConfigurationBoundResourceCache(this); private final ConfigurationBoundResourceCache mStateListAnimatorCache = new ConfigurationBoundResourceCache(this); private TypedValue mTmpValue = new TypedValue(); private boolean mPreloading; private TypedArray mCachedStyledAttributes = null; private int mLastCachedXmlBlockIndex = -1; private final int[] mCachedXmlBlockIds = { 0, 0, 0, 0 }; private final XmlBlock[] mCachedXmlBlocks = new XmlBlock[4]; final AssetManager mAssets; final DisplayMetrics mMetrics = new DisplayMetrics(); private final Configuration mConfiguration = new Configuration(); private NativePluralRules mPluralRule; private CompatibilityInfo mCompatibilityInfo = CompatibilityInfo.DEFAULT_COMPATIBILITY_INFO; @SuppressWarnings("unused") private WeakReference mToken; static { sPreloadedDrawables = new LongSparseArray[2]; sPreloadedDrawables[0] = new LongSparseArray(); sPreloadedDrawables[1] = new LongSparseArray(); } /** * Returns the most appropriate default theme for the specified target SDK version. *
    *
  • Below API 11: Gingerbread *
  • APIs 11 thru 14: Holo *
  • APIs 14 thru XX: Device default dark *
  • API XX and above: Device default light with dark action bar *
* * @param curTheme The current theme, or 0 if not specified. * @param targetSdkVersion The target SDK version. * @return A theme resource identifier * @hide */ public static int selectDefaultTheme(int curTheme, int targetSdkVersion) { return selectSystemTheme(curTheme, targetSdkVersion, com.android.internal.R.style.Theme, com.android.internal.R.style.Theme_Holo, com.android.internal.R.style.Theme_DeviceDefault, com.android.internal.R.style.Theme_DeviceDefault_Light_DarkActionBar); } /** @hide */ public static int selectSystemTheme(int curTheme, int targetSdkVersion, int orig, int holo, int dark, int deviceDefault) { if (curTheme != 0) { return curTheme; } if (targetSdkVersion < Build.VERSION_CODES.HONEYCOMB) { return orig; } if (targetSdkVersion < Build.VERSION_CODES.ICE_CREAM_SANDWICH) { return holo; } if (targetSdkVersion < Build.VERSION_CODES.CUR_DEVELOPMENT) { return dark; } return deviceDefault; } /** * Used by AnimatorInflater. * * @hide */ public ConfigurationBoundResourceCache getAnimatorCache() { return mAnimatorCache; } /** * Used by AnimatorInflater. * * @hide */ public ConfigurationBoundResourceCache getStateListAnimatorCache() { return mStateListAnimatorCache; } /** * This exception is thrown by the resource APIs when a requested resource * can not be found. */ public static class NotFoundException extends RuntimeException { public NotFoundException() { } public NotFoundException(String name) { super(name); } } /** * Create a new Resources object on top of an existing set of assets in an * AssetManager. * * @param assets Previously created AssetManager. * @param metrics Current display metrics to consider when * selecting/computing resource values. * @param config Desired device configuration to consider when * selecting/computing resource values (optional). */ public Resources(AssetManager assets, DisplayMetrics metrics, Configuration config) { this(assets, metrics, config, CompatibilityInfo.DEFAULT_COMPATIBILITY_INFO, null); } /** * Creates a new Resources object with CompatibilityInfo. * * @param assets Previously created AssetManager. * @param metrics Current display metrics to consider when * selecting/computing resource values. * @param config Desired device configuration to consider when * selecting/computing resource values (optional). * @param compatInfo this resource's compatibility info. Must not be null. * @param token The Activity token for determining stack affiliation. Usually null. * @hide */ public Resources(AssetManager assets, DisplayMetrics metrics, Configuration config, CompatibilityInfo compatInfo, IBinder token) { mAssets = assets; mMetrics.setToDefaults(); if (compatInfo != null) { mCompatibilityInfo = compatInfo; } mToken = new WeakReference(token); updateConfiguration(config, metrics); assets.ensureStringBlocks(); } /** * Return a global shared Resources object that provides access to only * system resources (no application resources), and is not configured for * the current screen (can not use dimension units, does not change based * on orientation, etc). */ public static Resources getSystem() { synchronized (sSync) { Resources ret = mSystem; if (ret == null) { ret = new Resources(); mSystem = ret; } return ret; } } /** * Return the string value associated with a particular resource ID. The * returned object will be a String if this is a plain string; it will be * some other type of CharSequence if it is styled. * {@more} * * @param id The desired resource identifier, as generated by the aapt * tool. This integer encodes the package, type, and resource * entry. The value 0 is an invalid identifier. * * @throws NotFoundException Throws NotFoundException if the given ID does not exist. * * @return CharSequence The string data associated with the resource, plus * possibly styled text information. */ public CharSequence getText(int id) throws NotFoundException { CharSequence res = mAssets.getResourceText(id); if (res != null) { return res; } throw new NotFoundException("String resource ID #0x" + Integer.toHexString(id)); } /** * Returns the character sequence necessary for grammatically correct pluralization * of the given resource ID for the given quantity. * Note that the character sequence is selected based solely on grammatical necessity, * and that such rules differ between languages. Do not assume you know which string * will be returned for a given quantity. See * String Resources * for more detail. * * @param id The desired resource identifier, as generated by the aapt * tool. This integer encodes the package, type, and resource * entry. The value 0 is an invalid identifier. * @param quantity The number used to get the correct string for the current language's * plural rules. * * @throws NotFoundException Throws NotFoundException if the given ID does not exist. * * @return CharSequence The string data associated with the resource, plus * possibly styled text information. */ public CharSequence getQuantityText(int id, int quantity) throws NotFoundException { NativePluralRules rule = getPluralRule(); CharSequence res = mAssets.getResourceBagText(id, attrForQuantityCode(rule.quantityForInt(quantity))); if (res != null) { return res; } res = mAssets.getResourceBagText(id, ID_OTHER); if (res != null) { return res; } throw new NotFoundException("Plural resource ID #0x" + Integer.toHexString(id) + " quantity=" + quantity + " item=" + stringForQuantityCode(rule.quantityForInt(quantity))); } private NativePluralRules getPluralRule() { synchronized (sSync) { if (mPluralRule == null) { mPluralRule = NativePluralRules.forLocale(mConfiguration.locale); } return mPluralRule; } } private static int attrForQuantityCode(int quantityCode) { switch (quantityCode) { case NativePluralRules.ZERO: return 0x01000005; case NativePluralRules.ONE: return 0x01000006; case NativePluralRules.TWO: return 0x01000007; case NativePluralRules.FEW: return 0x01000008; case NativePluralRules.MANY: return 0x01000009; default: return ID_OTHER; } } private static String stringForQuantityCode(int quantityCode) { switch (quantityCode) { case NativePluralRules.ZERO: return "zero"; case NativePluralRules.ONE: return "one"; case NativePluralRules.TWO: return "two"; case NativePluralRules.FEW: return "few"; case NativePluralRules.MANY: return "many"; default: return "other"; } } /** * Return the string value associated with a particular resource ID. It * will be stripped of any styled text information. * {@more} * * @param id The desired resource identifier, as generated by the aapt * tool. This integer encodes the package, type, and resource * entry. The value 0 is an invalid identifier. * * @throws NotFoundException Throws NotFoundException if the given ID does not exist. * * @return String The string data associated with the resource, * stripped of styled text information. */ public String getString(int id) throws NotFoundException { CharSequence res = getText(id); if (res != null) { return res.toString(); } throw new NotFoundException("String resource ID #0x" + Integer.toHexString(id)); } /** * Return the string value associated with a particular resource ID, * substituting the format arguments as defined in {@link java.util.Formatter} * and {@link java.lang.String#format}. It will be stripped of any styled text * information. * {@more} * * @param id The desired resource identifier, as generated by the aapt * tool. This integer encodes the package, type, and resource * entry. The value 0 is an invalid identifier. * * @param formatArgs The format arguments that will be used for substitution. * * @throws NotFoundException Throws NotFoundException if the given ID does not exist. * * @return String The string data associated with the resource, * stripped of styled text information. */ public String getString(int id, Object... formatArgs) throws NotFoundException { String raw = getString(id); return String.format(mConfiguration.locale, raw, formatArgs); } /** * Formats the string necessary for grammatically correct pluralization * of the given resource ID for the given quantity, using the given arguments. * Note that the string is selected based solely on grammatical necessity, * and that such rules differ between languages. Do not assume you know which string * will be returned for a given quantity. See * String Resources * for more detail. * *

Substitution of format arguments works as if using * {@link java.util.Formatter} and {@link java.lang.String#format}. * The resulting string will be stripped of any styled text information. * * @param id The desired resource identifier, as generated by the aapt * tool. This integer encodes the package, type, and resource * entry. The value 0 is an invalid identifier. * @param quantity The number used to get the correct string for the current language's * plural rules. * @param formatArgs The format arguments that will be used for substitution. * * @throws NotFoundException Throws NotFoundException if the given ID does not exist. * * @return String The string data associated with the resource, * stripped of styled text information. */ public String getQuantityString(int id, int quantity, Object... formatArgs) throws NotFoundException { String raw = getQuantityText(id, quantity).toString(); return String.format(mConfiguration.locale, raw, formatArgs); } /** * Returns the string necessary for grammatically correct pluralization * of the given resource ID for the given quantity. * Note that the string is selected based solely on grammatical necessity, * and that such rules differ between languages. Do not assume you know which string * will be returned for a given quantity. See * String Resources * for more detail. * * @param id The desired resource identifier, as generated by the aapt * tool. This integer encodes the package, type, and resource * entry. The value 0 is an invalid identifier. * @param quantity The number used to get the correct string for the current language's * plural rules. * * @throws NotFoundException Throws NotFoundException if the given ID does not exist. * * @return String The string data associated with the resource, * stripped of styled text information. */ public String getQuantityString(int id, int quantity) throws NotFoundException { return getQuantityText(id, quantity).toString(); } /** * Return the string value associated with a particular resource ID. The * returned object will be a String if this is a plain string; it will be * some other type of CharSequence if it is styled. * * @param id The desired resource identifier, as generated by the aapt * tool. This integer encodes the package, type, and resource * entry. The value 0 is an invalid identifier. * * @param def The default CharSequence to return. * * @return CharSequence The string data associated with the resource, plus * possibly styled text information, or def if id is 0 or not found. */ public CharSequence getText(int id, CharSequence def) { CharSequence res = id != 0 ? mAssets.getResourceText(id) : null; return res != null ? res : def; } /** * Return the styled text array associated with a particular resource ID. * * @param id The desired resource identifier, as generated by the aapt * tool. This integer encodes the package, type, and resource * entry. The value 0 is an invalid identifier. * * @throws NotFoundException Throws NotFoundException if the given ID does not exist. * * @return The styled text array associated with the resource. */ public CharSequence[] getTextArray(int id) throws NotFoundException { CharSequence[] res = mAssets.getResourceTextArray(id); if (res != null) { return res; } throw new NotFoundException("Text array resource ID #0x" + Integer.toHexString(id)); } /** * Return the string array associated with a particular resource ID. * * @param id The desired resource identifier, as generated by the aapt * tool. This integer encodes the package, type, and resource * entry. The value 0 is an invalid identifier. * * @throws NotFoundException Throws NotFoundException if the given ID does not exist. * * @return The string array associated with the resource. */ public String[] getStringArray(int id) throws NotFoundException { String[] res = mAssets.getResourceStringArray(id); if (res != null) { return res; } throw new NotFoundException("String array resource ID #0x" + Integer.toHexString(id)); } /** * Return the int array associated with a particular resource ID. * * @param id The desired resource identifier, as generated by the aapt * tool. This integer encodes the package, type, and resource * entry. The value 0 is an invalid identifier. * * @throws NotFoundException Throws NotFoundException if the given ID does not exist. * * @return The int array associated with the resource. */ public int[] getIntArray(int id) throws NotFoundException { int[] res = mAssets.getArrayIntResource(id); if (res != null) { return res; } throw new NotFoundException("Int array resource ID #0x" + Integer.toHexString(id)); } /** * Return an array of heterogeneous values. * * @param id The desired resource identifier, as generated by the aapt * tool. This integer encodes the package, type, and resource * entry. The value 0 is an invalid identifier. * * @throws NotFoundException Throws NotFoundException if the given ID does not exist. * * @return Returns a TypedArray holding an array of the array values. * Be sure to call {@link TypedArray#recycle() TypedArray.recycle()} * when done with it. */ public TypedArray obtainTypedArray(int id) throws NotFoundException { int len = mAssets.getArraySize(id); if (len < 0) { throw new NotFoundException("Array resource ID #0x" + Integer.toHexString(id)); } TypedArray array = TypedArray.obtain(this, len); array.mLength = mAssets.retrieveArray(id, array.mData); array.mIndices[0] = 0; return array; } /** * Retrieve a dimensional for a particular resource ID. Unit * conversions are based on the current {@link DisplayMetrics} associated * with the resources. * * @param id The desired resource identifier, as generated by the aapt * tool. This integer encodes the package, type, and resource * entry. The value 0 is an invalid identifier. * * @return Resource dimension value multiplied by the appropriate * metric. * * @throws NotFoundException Throws NotFoundException if the given ID does not exist. * * @see #getDimensionPixelOffset * @see #getDimensionPixelSize */ public float getDimension(int id) throws NotFoundException { synchronized (mAccessLock) { TypedValue value = mTmpValue; if (value == null) { mTmpValue = value = new TypedValue(); } getValue(id, value, true); if (value.type == TypedValue.TYPE_DIMENSION) { return TypedValue.complexToDimension(value.data, mMetrics); } throw new NotFoundException( "Resource ID #0x" + Integer.toHexString(id) + " type #0x" + Integer.toHexString(value.type) + " is not valid"); } } /** * Retrieve a dimensional for a particular resource ID for use * as an offset in raw pixels. This is the same as * {@link #getDimension}, except the returned value is converted to * integer pixels for you. An offset conversion involves simply * truncating the base value to an integer. * * @param id The desired resource identifier, as generated by the aapt * tool. This integer encodes the package, type, and resource * entry. The value 0 is an invalid identifier. * * @return Resource dimension value multiplied by the appropriate * metric and truncated to integer pixels. * * @throws NotFoundException Throws NotFoundException if the given ID does not exist. * * @see #getDimension * @see #getDimensionPixelSize */ public int getDimensionPixelOffset(int id) throws NotFoundException { synchronized (mAccessLock) { TypedValue value = mTmpValue; if (value == null) { mTmpValue = value = new TypedValue(); } getValue(id, value, true); if (value.type == TypedValue.TYPE_DIMENSION) { return TypedValue.complexToDimensionPixelOffset( value.data, mMetrics); } throw new NotFoundException( "Resource ID #0x" + Integer.toHexString(id) + " type #0x" + Integer.toHexString(value.type) + " is not valid"); } } /** * Retrieve a dimensional for a particular resource ID for use * as a size in raw pixels. This is the same as * {@link #getDimension}, except the returned value is converted to * integer pixels for use as a size. A size conversion involves * rounding the base value, and ensuring that a non-zero base value * is at least one pixel in size. * * @param id The desired resource identifier, as generated by the aapt * tool. This integer encodes the package, type, and resource * entry. The value 0 is an invalid identifier. * * @return Resource dimension value multiplied by the appropriate * metric and truncated to integer pixels. * * @throws NotFoundException Throws NotFoundException if the given ID does not exist. * * @see #getDimension * @see #getDimensionPixelOffset */ public int getDimensionPixelSize(int id) throws NotFoundException { synchronized (mAccessLock) { TypedValue value = mTmpValue; if (value == null) { mTmpValue = value = new TypedValue(); } getValue(id, value, true); if (value.type == TypedValue.TYPE_DIMENSION) { return TypedValue.complexToDimensionPixelSize( value.data, mMetrics); } throw new NotFoundException( "Resource ID #0x" + Integer.toHexString(id) + " type #0x" + Integer.toHexString(value.type) + " is not valid"); } } /** * Retrieve a fractional unit for a particular resource ID. * * @param id The desired resource identifier, as generated by the aapt * tool. This integer encodes the package, type, and resource * entry. The value 0 is an invalid identifier. * @param base The base value of this fraction. In other words, a * standard fraction is multiplied by this value. * @param pbase The parent base value of this fraction. In other * words, a parent fraction (nn%p) is multiplied by this * value. * * @return Attribute fractional value multiplied by the appropriate * base value. * * @throws NotFoundException Throws NotFoundException if the given ID does not exist. */ public float getFraction(int id, int base, int pbase) { synchronized (mAccessLock) { TypedValue value = mTmpValue; if (value == null) { mTmpValue = value = new TypedValue(); } getValue(id, value, true); if (value.type == TypedValue.TYPE_FRACTION) { return TypedValue.complexToFraction(value.data, base, pbase); } throw new NotFoundException( "Resource ID #0x" + Integer.toHexString(id) + " type #0x" + Integer.toHexString(value.type) + " is not valid"); } } /** * Return a drawable object associated with a particular resource ID. * Various types of objects will be returned depending on the underlying * resource -- for example, a solid color, PNG image, scalable image, etc. * The Drawable API hides these implementation details. * *

Note: Prior to * {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, this function * would not correctly retrieve the final configuration density when * the resource ID passed here is an alias to another Drawable resource. * This means that if the density configuration of the alias resource * is different than the actual resource, the density of the returned * Drawable would be incorrect, resulting in bad scaling. To work * around this, you can instead retrieve the Drawable through * {@link TypedArray#getDrawable TypedArray.getDrawable}. Use * {@link android.content.Context#obtainStyledAttributes(int[]) * Context.obtainStyledAttributes} with * an array containing the resource ID of interest to create the TypedArray.

* *

Note: To obtain a themed drawable, use * {@link android.content.Context#getDrawable(int) Context.getDrawable(int)} * or {@link #getDrawable(int, Theme)} passing the desired theme.

* * @param id The desired resource identifier, as generated by the aapt * tool. This integer encodes the package, type, and resource * entry. The value 0 is an invalid identifier. * @return Drawable An object that can be used to draw this resource. * @throws NotFoundException Throws NotFoundException if the given ID does * not exist. * @see #getDrawable(int, Theme) * @deprecated Use {@link #getDrawable(int, Theme)} instead. */ @Deprecated @Nullable public Drawable getDrawable(int id) throws NotFoundException { final Drawable d = getDrawable(id, null); if (d != null && d.canApplyTheme()) { Log.w(TAG, "Drawable " + getResourceName(id) + " has unresolved theme " + "attributes! Consider using Resources.getDrawable(int, Theme) or " + "Context.getDrawable(int).", new RuntimeException()); } return d; } /** * Return a drawable object associated with a particular resource ID and * styled for the specified theme. Various types of objects will be * returned depending on the underlying resource -- for example, a solid * color, PNG image, scalable image, etc. * * @param id The desired resource identifier, as generated by the aapt * tool. This integer encodes the package, type, and resource * entry. The value 0 is an invalid identifier. * @param theme The theme used to style the drawable attributes, may be {@code null}. * @return Drawable An object that can be used to draw this resource. * @throws NotFoundException Throws NotFoundException if the given ID does * not exist. */ @Nullable public Drawable getDrawable(int id, @Nullable Theme theme) throws NotFoundException { TypedValue value; synchronized (mAccessLock) { value = mTmpValue; if (value == null) { value = new TypedValue(); } else { mTmpValue = null; } getValue(id, value, true); } final Drawable res = loadDrawable(value, id, theme); synchronized (mAccessLock) { if (mTmpValue == null) { mTmpValue = value; } } return res; } /** * Return a drawable object associated with a particular resource ID for the * given screen density in DPI. This will set the drawable's density to be * the device's density multiplied by the ratio of actual drawable density * to requested density. This allows the drawable to be scaled up to the * correct size if needed. Various types of objects will be returned * depending on the underlying resource -- for example, a solid color, PNG * image, scalable image, etc. The Drawable API hides these implementation * details. * *

Note: To obtain a themed drawable, use * {@link android.content.Context#getDrawable(int) Context.getDrawable(int)} * or {@link #getDrawableForDensity(int, int, Theme)} passing the desired * theme.

* * @param id The desired resource identifier, as generated by the aapt tool. * This integer encodes the package, type, and resource entry. * The value 0 is an invalid identifier. * @param density the desired screen density indicated by the resource as * found in {@link DisplayMetrics}. * @return Drawable An object that can be used to draw this resource. * @throws NotFoundException Throws NotFoundException if the given ID does * not exist. * @see #getDrawableForDensity(int, int, Theme) * @deprecated Use {@link #getDrawableForDensity(int, int, Theme)} instead. */ @Deprecated @Nullable public Drawable getDrawableForDensity(int id, int density) throws NotFoundException { return getDrawableForDensity(id, density, null); } /** * Return a drawable object associated with a particular resource ID for the * given screen density in DPI and styled for the specified theme. * * @param id The desired resource identifier, as generated by the aapt tool. * This integer encodes the package, type, and resource entry. * The value 0 is an invalid identifier. * @param density The desired screen density indicated by the resource as * found in {@link DisplayMetrics}. * @param theme The theme used to style the drawable attributes, may be {@code null}. * @return Drawable An object that can be used to draw this resource. * @throws NotFoundException Throws NotFoundException if the given ID does * not exist. */ @Nullable public Drawable getDrawableForDensity(int id, int density, @Nullable Theme theme) { TypedValue value; synchronized (mAccessLock) { value = mTmpValue; if (value == null) { value = new TypedValue(); } else { mTmpValue = null; } getValueForDensity(id, density, value, true); /* * Pretend the requested density is actually the display density. If * the drawable returned is not the requested density, then force it * to be scaled later by dividing its density by the ratio of * requested density to actual device density. Drawables that have * undefined density or no density don't need to be handled here. */ if (value.density > 0 && value.density != TypedValue.DENSITY_NONE) { if (value.density == density) { value.density = mMetrics.densityDpi; } else { value.density = (value.density * mMetrics.densityDpi) / density; } } } final Drawable res = loadDrawable(value, id, theme); synchronized (mAccessLock) { if (mTmpValue == null) { mTmpValue = value; } } return res; } /** * Return a movie object associated with the particular resource ID. * @param id The desired resource identifier, as generated by the aapt * tool. This integer encodes the package, type, and resource * entry. The value 0 is an invalid identifier. * @throws NotFoundException Throws NotFoundException if the given ID does not exist. * */ public Movie getMovie(int id) throws NotFoundException { InputStream is = openRawResource(id); Movie movie = Movie.decodeStream(is); try { is.close(); } catch (java.io.IOException e) { // don't care, since the return value is valid } return movie; } /** * Return a color integer associated with a particular resource ID. * If the resource holds a complex * {@link android.content.res.ColorStateList}, then the default color from * the set is returned. * * @param id The desired resource identifier, as generated by the aapt * tool. This integer encodes the package, type, and resource * entry. The value 0 is an invalid identifier. * * @throws NotFoundException Throws NotFoundException if the given ID does not exist. * * @return Returns a single color value in the form 0xAARRGGBB. */ public int getColor(int id) throws NotFoundException { TypedValue value; synchronized (mAccessLock) { value = mTmpValue; if (value == null) { value = new TypedValue(); } getValue(id, value, true); if (value.type >= TypedValue.TYPE_FIRST_INT && value.type <= TypedValue.TYPE_LAST_INT) { mTmpValue = value; return value.data; } else if (value.type != TypedValue.TYPE_STRING) { throw new NotFoundException( "Resource ID #0x" + Integer.toHexString(id) + " type #0x" + Integer.toHexString(value.type) + " is not valid"); } mTmpValue = null; } ColorStateList csl = loadColorStateList(value, id); synchronized (mAccessLock) { if (mTmpValue == null) { mTmpValue = value; } } return csl.getDefaultColor(); } /** * Return a color state list associated with a particular resource ID. The * resource may contain either a single raw color value, or a complex * {@link android.content.res.ColorStateList} holding multiple possible colors. * * @param id The desired resource identifier of a {@link ColorStateList}, * as generated by the aapt tool. This integer encodes the package, type, and resource * entry. The value 0 is an invalid identifier. * * @throws NotFoundException Throws NotFoundException if the given ID does not exist. * * @return Returns a ColorStateList object containing either a single * solid color or multiple colors that can be selected based on a state. */ public ColorStateList getColorStateList(int id) throws NotFoundException { TypedValue value; synchronized (mAccessLock) { value = mTmpValue; if (value == null) { value = new TypedValue(); } else { mTmpValue = null; } getValue(id, value, true); } ColorStateList res = loadColorStateList(value, id); synchronized (mAccessLock) { if (mTmpValue == null) { mTmpValue = value; } } return res; } /** * Return a boolean associated with a particular resource ID. This can be * used with any integral resource value, and will return true if it is * non-zero. * * @param id The desired resource identifier, as generated by the aapt * tool. This integer encodes the package, type, and resource * entry. The value 0 is an invalid identifier. * * @throws NotFoundException Throws NotFoundException if the given ID does not exist. * * @return Returns the boolean value contained in the resource. */ public boolean getBoolean(int id) throws NotFoundException { synchronized (mAccessLock) { TypedValue value = mTmpValue; if (value == null) { mTmpValue = value = new TypedValue(); } getValue(id, value, true); if (value.type >= TypedValue.TYPE_FIRST_INT && value.type <= TypedValue.TYPE_LAST_INT) { return value.data != 0; } throw new NotFoundException( "Resource ID #0x" + Integer.toHexString(id) + " type #0x" + Integer.toHexString(value.type) + " is not valid"); } } /** * Return an integer associated with a particular resource ID. * * @param id The desired resource identifier, as generated by the aapt * tool. This integer encodes the package, type, and resource * entry. The value 0 is an invalid identifier. * * @throws NotFoundException Throws NotFoundException if the given ID does not exist. * * @return Returns the integer value contained in the resource. */ public int getInteger(int id) throws NotFoundException { synchronized (mAccessLock) { TypedValue value = mTmpValue; if (value == null) { mTmpValue = value = new TypedValue(); } getValue(id, value, true); if (value.type >= TypedValue.TYPE_FIRST_INT && value.type <= TypedValue.TYPE_LAST_INT) { return value.data; } throw new NotFoundException( "Resource ID #0x" + Integer.toHexString(id) + " type #0x" + Integer.toHexString(value.type) + " is not valid"); } } /** * Retrieve a floating-point value for a particular resource ID. * * @param id The desired resource identifier, as generated by the aapt * tool. This integer encodes the package, type, and resource * entry. The value 0 is an invalid identifier. * * @return Returns the floating-point value contained in the resource. * * @throws NotFoundException Throws NotFoundException if the given ID does * not exist or is not a floating-point value. * @hide Pending API council approval. */ public float getFloat(int id) { synchronized (mAccessLock) { TypedValue value = mTmpValue; if (value == null) { mTmpValue = value = new TypedValue(); } getValue(id, value, true); if (value.type == TypedValue.TYPE_FLOAT) { return value.getFloat(); } throw new NotFoundException("Resource ID #0x" + Integer.toHexString(id) + " type #0x" + Integer.toHexString(value.type) + " is not valid"); } } /** * Return an XmlResourceParser through which you can read a view layout * description for the given resource ID. This parser has limited * functionality -- in particular, you can't change its input, and only * the high-level events are available. * *

This function is really a simple wrapper for calling * {@link #getXml} with a layout resource. * * @param id The desired resource identifier, as generated by the aapt * tool. This integer encodes the package, type, and resource * entry. The value 0 is an invalid identifier. * * @throws NotFoundException Throws NotFoundException if the given ID does not exist. * * @return A new parser object through which you can read * the XML data. * * @see #getXml */ public XmlResourceParser getLayout(int id) throws NotFoundException { return loadXmlResourceParser(id, "layout"); } /** * Return an XmlResourceParser through which you can read an animation * description for the given resource ID. This parser has limited * functionality -- in particular, you can't change its input, and only * the high-level events are available. * *

This function is really a simple wrapper for calling * {@link #getXml} with an animation resource. * * @param id The desired resource identifier, as generated by the aapt * tool. This integer encodes the package, type, and resource * entry. The value 0 is an invalid identifier. * * @throws NotFoundException Throws NotFoundException if the given ID does not exist. * * @return A new parser object through which you can read * the XML data. * * @see #getXml */ public XmlResourceParser getAnimation(int id) throws NotFoundException { return loadXmlResourceParser(id, "anim"); } /** * Return an XmlResourceParser through which you can read a generic XML * resource for the given resource ID. * *

The XmlPullParser implementation returned here has some limited * functionality. In particular, you can't change its input, and only * high-level parsing events are available (since the document was * pre-parsed for you at build time, which involved merging text and * stripping comments). * * @param id The desired resource identifier, as generated by the aapt * tool. This integer encodes the package, type, and resource * entry. The value 0 is an invalid identifier. * * @throws NotFoundException Throws NotFoundException if the given ID does not exist. * * @return A new parser object through which you can read * the XML data. * * @see android.util.AttributeSet */ public XmlResourceParser getXml(int id) throws NotFoundException { return loadXmlResourceParser(id, "xml"); } /** * Open a data stream for reading a raw resource. This can only be used * with resources whose value is the name of an asset files -- that is, it can be * used to open drawable, sound, and raw resources; it will fail on string * and color resources. * * @param id The resource identifier to open, as generated by the appt * tool. * * @return InputStream Access to the resource data. * * @throws NotFoundException Throws NotFoundException if the given ID does not exist. * */ public InputStream openRawResource(int id) throws NotFoundException { TypedValue value; synchronized (mAccessLock) { value = mTmpValue; if (value == null) { value = new TypedValue(); } else { mTmpValue = null; } } InputStream res = openRawResource(id, value); synchronized (mAccessLock) { if (mTmpValue == null) { mTmpValue = value; } } return res; } /** * Open a data stream for reading a raw resource. This can only be used * with resources whose value is the name of an asset file -- that is, it can be * used to open drawable, sound, and raw resources; it will fail on string * and color resources. * * @param id The resource identifier to open, as generated by the appt tool. * @param value The TypedValue object to hold the resource information. * * @return InputStream Access to the resource data. * * @throws NotFoundException Throws NotFoundException if the given ID does not exist. */ public InputStream openRawResource(int id, TypedValue value) throws NotFoundException { getValue(id, value, true); try { return mAssets.openNonAsset(value.assetCookie, value.string.toString(), AssetManager.ACCESS_STREAMING); } catch (Exception e) { NotFoundException rnf = new NotFoundException("File " + value.string.toString() + " from drawable resource ID #0x" + Integer.toHexString(id)); rnf.initCause(e); throw rnf; } } /** * Open a file descriptor for reading a raw resource. This can only be used * with resources whose value is the name of an asset files -- that is, it can be * used to open drawable, sound, and raw resources; it will fail on string * and color resources. * *

This function only works for resources that are stored in the package * as uncompressed data, which typically includes things like mp3 files * and png images. * * @param id The resource identifier to open, as generated by the appt * tool. * * @return AssetFileDescriptor A new file descriptor you can use to read * the resource. This includes the file descriptor itself, as well as the * offset and length of data where the resource appears in the file. A * null is returned if the file exists but is compressed. * * @throws NotFoundException Throws NotFoundException if the given ID does not exist. * */ public AssetFileDescriptor openRawResourceFd(int id) throws NotFoundException { TypedValue value; synchronized (mAccessLock) { value = mTmpValue; if (value == null) { value = new TypedValue(); } else { mTmpValue = null; } getValue(id, value, true); } try { return mAssets.openNonAssetFd( value.assetCookie, value.string.toString()); } catch (Exception e) { NotFoundException rnf = new NotFoundException( "File " + value.string.toString() + " from drawable resource ID #0x" + Integer.toHexString(id)); rnf.initCause(e); throw rnf; } finally { synchronized (mAccessLock) { if (mTmpValue == null) { mTmpValue = value; } } } } /** * Return the raw data associated with a particular resource ID. * * @param id The desired resource identifier, as generated by the aapt * tool. This integer encodes the package, type, and resource * entry. The value 0 is an invalid identifier. * @param outValue Object in which to place the resource data. * @param resolveRefs If true, a resource that is a reference to another * resource will be followed so that you receive the * actual final resource data. If false, the TypedValue * will be filled in with the reference itself. * * @throws NotFoundException Throws NotFoundException if the given ID does not exist. * */ public void getValue(int id, TypedValue outValue, boolean resolveRefs) throws NotFoundException { boolean found = mAssets.getResourceValue(id, 0, outValue, resolveRefs); if (found) { return; } throw new NotFoundException("Resource ID #0x" + Integer.toHexString(id)); } /** * Get the raw value associated with a resource with associated density. * * @param id resource identifier * @param density density in DPI * @param resolveRefs If true, a resource that is a reference to another * resource will be followed so that you receive the actual final * resource data. If false, the TypedValue will be filled in with * the reference itself. * @throws NotFoundException Throws NotFoundException if the given ID does * not exist. * @see #getValue(String, TypedValue, boolean) */ public void getValueForDensity(int id, int density, TypedValue outValue, boolean resolveRefs) throws NotFoundException { boolean found = mAssets.getResourceValue(id, density, outValue, resolveRefs); if (found) { return; } throw new NotFoundException("Resource ID #0x" + Integer.toHexString(id)); } /** * Return the raw data associated with a particular resource ID. * See getIdentifier() for information on how names are mapped to resource * IDs, and getString(int) for information on how string resources are * retrieved. * *

Note: use of this function is discouraged. It is much more * efficient to retrieve resources by identifier than by name. * * @param name The name of the desired resource. This is passed to * getIdentifier() with a default type of "string". * @param outValue Object in which to place the resource data. * @param resolveRefs If true, a resource that is a reference to another * resource will be followed so that you receive the * actual final resource data. If false, the TypedValue * will be filled in with the reference itself. * * @throws NotFoundException Throws NotFoundException if the given ID does not exist. * */ public void getValue(String name, TypedValue outValue, boolean resolveRefs) throws NotFoundException { int id = getIdentifier(name, "string", null); if (id != 0) { getValue(id, outValue, resolveRefs); return; } throw new NotFoundException("String resource name " + name); } /** * This class holds the current attribute values for a particular theme. * In other words, a Theme is a set of values for resource attributes; * these are used in conjunction with {@link TypedArray} * to resolve the final value for an attribute. * *

The Theme's attributes come into play in two ways: (1) a styled * attribute can explicit reference a value in the theme through the * "?themeAttribute" syntax; (2) if no value has been defined for a * particular styled attribute, as a last resort we will try to find that * attribute's value in the Theme. * *

You will normally use the {@link #obtainStyledAttributes} APIs to * retrieve XML attributes with style and theme information applied. */ public final class Theme { /** * Place new attribute values into the theme. The style resource * specified by resid will be retrieved from this Theme's * resources, its values placed into the Theme object. * *

The semantics of this function depends on the force * argument: If false, only values that are not already defined in * the theme will be copied from the system resource; otherwise, if * any of the style's attributes are already defined in the theme, the * current values in the theme will be overwritten. * * @param resId The resource ID of a style resource from which to * obtain attribute values. * @param force If true, values in the style resource will always be * used in the theme; otherwise, they will only be used * if not already defined in the theme. */ public void applyStyle(int resId, boolean force) { AssetManager.applyThemeStyle(mTheme, resId, force); mThemeResId = resId; mKey += Integer.toHexString(resId) + (force ? "! " : " "); } /** * Set this theme to hold the same contents as the theme * other. If both of these themes are from the same * Resources object, they will be identical after this function * returns. If they are from different Resources, only the resources * they have in common will be set in this theme. * * @param other The existing Theme to copy from. */ public void setTo(Theme other) { AssetManager.copyTheme(mTheme, other.mTheme); mThemeResId = other.mThemeResId; mKey = other.mKey; } /** * Return a TypedArray holding the values defined by * Theme which are listed in attrs. * *

Be sure to call {@link TypedArray#recycle() TypedArray.recycle()} when you are done * with the array. * * @param attrs The desired attributes. * * @throws NotFoundException Throws NotFoundException if the given ID does not exist. * * @return Returns a TypedArray holding an array of the attribute values. * Be sure to call {@link TypedArray#recycle() TypedArray.recycle()} * when done with it. * * @see Resources#obtainAttributes * @see #obtainStyledAttributes(int, int[]) * @see #obtainStyledAttributes(AttributeSet, int[], int, int) */ public TypedArray obtainStyledAttributes(int[] attrs) { final int len = attrs.length; final TypedArray array = TypedArray.obtain(Resources.this, len); array.mTheme = this; AssetManager.applyStyle(mTheme, 0, 0, 0, attrs, array.mData, array.mIndices); return array; } /** * Return a TypedArray holding the values defined by the style * resource resid which are listed in attrs. * *

Be sure to call {@link TypedArray#recycle() TypedArray.recycle()} when you are done * with the array. * * @param resid The desired style resource. * @param attrs The desired attributes in the style. * * @throws NotFoundException Throws NotFoundException if the given ID does not exist. * * @return Returns a TypedArray holding an array of the attribute values. * Be sure to call {@link TypedArray#recycle() TypedArray.recycle()} * when done with it. * * @see Resources#obtainAttributes * @see #obtainStyledAttributes(int[]) * @see #obtainStyledAttributes(AttributeSet, int[], int, int) */ public TypedArray obtainStyledAttributes(int resid, int[] attrs) throws NotFoundException { final int len = attrs.length; final TypedArray array = TypedArray.obtain(Resources.this, len); array.mTheme = this; if (false) { int[] data = array.mData; System.out.println("**********************************************************"); System.out.println("**********************************************************"); System.out.println("**********************************************************"); System.out.println("Attributes:"); String s = " Attrs:"; int i; for (i=0; iBe sure to call {@link TypedArray#recycle() TypedArray.recycle()} when you are done * with the array. * *

When determining the final value of a particular attribute, there * are four inputs that come into play:

* *
    *
  1. Any attribute values in the given AttributeSet. *
  2. The style resource specified in the AttributeSet (named * "style"). *
  3. The default style specified by defStyleAttr and * defStyleRes *
  4. The base values in this theme. *
* *

Each of these inputs is considered in-order, with the first listed * taking precedence over the following ones. In other words, if in the * AttributeSet you have supplied <Button * textColor="#ff000000">, then the button's text will * always be black, regardless of what is specified in any of * the styles. * * @param set The base set of attribute values. May be null. * @param attrs The desired attributes to be retrieved. * @param defStyleAttr An attribute in the current theme that contains a * reference to a style resource that supplies * defaults values for the TypedArray. Can be * 0 to not look for defaults. * @param defStyleRes A resource identifier of a style resource that * supplies default values for the TypedArray, * used only if defStyleAttr is 0 or can not be found * in the theme. Can be 0 to not look for defaults. * * @return Returns a TypedArray holding an array of the attribute values. * Be sure to call {@link TypedArray#recycle() TypedArray.recycle()} * when done with it. * * @see Resources#obtainAttributes * @see #obtainStyledAttributes(int[]) * @see #obtainStyledAttributes(int, int[]) */ public TypedArray obtainStyledAttributes(AttributeSet set, int[] attrs, int defStyleAttr, int defStyleRes) { final int len = attrs.length; final TypedArray array = TypedArray.obtain(Resources.this, len); // XXX note that for now we only work with compiled XML files. // To support generic XML files we will need to manually parse // out the attributes from the XML file (applying type information // contained in the resources and such). final XmlBlock.Parser parser = (XmlBlock.Parser)set; AssetManager.applyStyle(mTheme, defStyleAttr, defStyleRes, parser != null ? parser.mParseState : 0, attrs, array.mData, array.mIndices); array.mTheme = this; array.mXml = parser; if (false) { int[] data = array.mData; System.out.println("Attributes:"); String s = " Attrs:"; int i; for (i=0; ioutValue are ultimately filled in by * {@link Resources#getValue}. * * @param resid The resource identifier of the desired theme * attribute. * @param outValue Filled in with the ultimate resource value supplied * by the attribute. * @param resolveRefs If true, resource references will be walked; if * false, outValue may be a * TYPE_REFERENCE. In either case, it will never * be a TYPE_ATTRIBUTE. * * @return boolean Returns true if the attribute was found and * outValue is valid, else false. */ public boolean resolveAttribute(int resid, TypedValue outValue, boolean resolveRefs) { boolean got = mAssets.getThemeValue(mTheme, resid, outValue, resolveRefs); if (false) { System.out.println( "resolveAttribute #" + Integer.toHexString(resid) + " got=" + got + ", type=0x" + Integer.toHexString(outValue.type) + ", data=0x" + Integer.toHexString(outValue.data)); } return got; } /** * Gets all of the attribute ids associated with this {@link Theme}. For debugging only. * * @return The int array containing attribute ids associated with this {@link Theme}. * @hide */ public int[] getAllAttributes() { return mAssets.getStyleAttributes(getAppliedStyleResId()); } /** * Returns the resources to which this theme belongs. * * @return Resources to which this theme belongs. */ public Resources getResources() { return Resources.this; } /** * Return a drawable object associated with a particular resource ID * and styled for the Theme. * * @param id The desired resource identifier, as generated by the aapt * tool. This integer encodes the package, type, and resource * entry. The value 0 is an invalid identifier. * @return Drawable An object that can be used to draw this resource. * @throws NotFoundException Throws NotFoundException if the given ID * does not exist. */ public Drawable getDrawable(int id) throws NotFoundException { return Resources.this.getDrawable(id, this); } /** * Print contents of this theme out to the log. For debugging only. * * @param priority The log priority to use. * @param tag The log tag to use. * @param prefix Text to prefix each line printed. */ public void dump(int priority, String tag, String prefix) { AssetManager.dumpTheme(mTheme, priority, tag, prefix); } @Override protected void finalize() throws Throwable { super.finalize(); mAssets.releaseTheme(mTheme); } /*package*/ Theme() { mAssets = Resources.this.mAssets; mTheme = mAssets.createTheme(); } @SuppressWarnings("hiding") private final AssetManager mAssets; private final long mTheme; /** Resource identifier for the theme. */ private int mThemeResId = 0; /** Unique key for the series of styles applied to this theme. */ private String mKey = ""; // Needed by layoutlib. /*package*/ long getNativeTheme() { return mTheme; } /*package*/ int getAppliedStyleResId() { return mThemeResId; } /*package*/ String getKey() { return mKey; } private String getResourceNameFromHexString(String hexString) { return getResourceName(Integer.parseInt(hexString, 16)); } /** * Parses {@link #mKey} and returns a String array that holds pairs of adjacent Theme data: * resource name followed by whether or not it was forced, as specified by * {@link #applyStyle(int, boolean)}. * * @hide */ @ViewDebug.ExportedProperty(category = "theme", hasAdjacentMapping = true) public String[] getTheme() { String[] themeData = mKey.split(" "); String[] themes = new String[themeData.length * 2]; String theme; boolean forced; for (int i = 0, j = themeData.length - 1; i < themes.length; i += 2, --j) { theme = themeData[j]; forced = theme.endsWith("!"); themes[i] = forced ? getResourceNameFromHexString(theme.substring(0, theme.length() - 1)) : getResourceNameFromHexString(theme); themes[i + 1] = forced ? "forced" : "not forced"; } return themes; } } /** * Generate a new Theme object for this set of Resources. It initially * starts out empty. * * @return Theme The newly created Theme container. */ public final Theme newTheme() { return new Theme(); } /** * Retrieve a set of basic attribute values from an AttributeSet, not * performing styling of them using a theme and/or style resources. * * @param set The current attribute values to retrieve. * @param attrs The specific attributes to be retrieved. * @return Returns a TypedArray holding an array of the attribute values. * Be sure to call {@link TypedArray#recycle() TypedArray.recycle()} * when done with it. * * @see Theme#obtainStyledAttributes(AttributeSet, int[], int, int) */ public TypedArray obtainAttributes(AttributeSet set, int[] attrs) { int len = attrs.length; TypedArray array = TypedArray.obtain(this, len); // XXX note that for now we only work with compiled XML files. // To support generic XML files we will need to manually parse // out the attributes from the XML file (applying type information // contained in the resources and such). XmlBlock.Parser parser = (XmlBlock.Parser)set; mAssets.retrieveAttributes(parser.mParseState, attrs, array.mData, array.mIndices); array.mXml = parser; return array; } /** * Store the newly updated configuration. */ public void updateConfiguration(Configuration config, DisplayMetrics metrics) { updateConfiguration(config, metrics, null); } /** * @hide */ public void updateConfiguration(Configuration config, DisplayMetrics metrics, CompatibilityInfo compat) { synchronized (mAccessLock) { if (false) { Slog.i(TAG, "**** Updating config of " + this + ": old config is " + mConfiguration + " old compat is " + mCompatibilityInfo); Slog.i(TAG, "**** Updating config of " + this + ": new config is " + config + " new compat is " + compat); } if (compat != null) { mCompatibilityInfo = compat; } if (metrics != null) { mMetrics.setTo(metrics); } // NOTE: We should re-arrange this code to create a Display // with the CompatibilityInfo that is used everywhere we deal // with the display in relation to this app, rather than // doing the conversion here. This impl should be okay because // we make sure to return a compatible display in the places // where there are public APIs to retrieve the display... but // it would be cleaner and more maintainble to just be // consistently dealing with a compatible display everywhere in // the framework. mCompatibilityInfo.applyToDisplayMetrics(mMetrics); int configChanges = calcConfigChanges(config); if (mConfiguration.locale == null) { mConfiguration.locale = Locale.getDefault(); mConfiguration.setLayoutDirection(mConfiguration.locale); } if (mConfiguration.densityDpi != Configuration.DENSITY_DPI_UNDEFINED) { mMetrics.densityDpi = mConfiguration.densityDpi; mMetrics.density = mConfiguration.densityDpi * DisplayMetrics.DENSITY_DEFAULT_SCALE; } mMetrics.scaledDensity = mMetrics.density * mConfiguration.fontScale; String locale = null; if (mConfiguration.locale != null) { locale = adjustLanguageTag(mConfiguration.locale.toLanguageTag()); } int width, height; if (mMetrics.widthPixels >= mMetrics.heightPixels) { width = mMetrics.widthPixels; height = mMetrics.heightPixels; } else { //noinspection SuspiciousNameCombination width = mMetrics.heightPixels; //noinspection SuspiciousNameCombination height = mMetrics.widthPixels; } int keyboardHidden = mConfiguration.keyboardHidden; if (keyboardHidden == Configuration.KEYBOARDHIDDEN_NO && mConfiguration.hardKeyboardHidden == Configuration.HARDKEYBOARDHIDDEN_YES) { keyboardHidden = Configuration.KEYBOARDHIDDEN_SOFT; } mAssets.setConfiguration(mConfiguration.mcc, mConfiguration.mnc, locale, mConfiguration.orientation, mConfiguration.touchscreen, mConfiguration.densityDpi, mConfiguration.keyboard, keyboardHidden, mConfiguration.navigation, width, height, mConfiguration.smallestScreenWidthDp, mConfiguration.screenWidthDp, mConfiguration.screenHeightDp, mConfiguration.screenLayout, mConfiguration.uiMode, Build.VERSION.RESOURCES_SDK_INT); if (DEBUG_CONFIG) { Slog.i(TAG, "**** Updating config of " + this + ": final config is " + mConfiguration + " final compat is " + mCompatibilityInfo); } clearDrawableCachesLocked(mDrawableCache, configChanges); clearDrawableCachesLocked(mColorDrawableCache, configChanges); mAnimatorCache.onConfigurationChange(configChanges); mStateListAnimatorCache.onConfigurationChange(configChanges); mColorStateListCache.clear(); flushLayoutCache(); } synchronized (sSync) { if (mPluralRule != null) { mPluralRule = NativePluralRules.forLocale(config.locale); } } } /** * Called by ConfigurationBoundResourceCacheTest via reflection. */ private int calcConfigChanges(Configuration config) { int configChanges = 0xfffffff; if (config != null) { mTmpConfig.setTo(config); int density = config.densityDpi; if (density == Configuration.DENSITY_DPI_UNDEFINED) { density = mMetrics.noncompatDensityDpi; } mCompatibilityInfo.applyToConfiguration(density, mTmpConfig); if (mTmpConfig.locale == null) { mTmpConfig.locale = Locale.getDefault(); mTmpConfig.setLayoutDirection(mTmpConfig.locale); } configChanges = mConfiguration.updateFrom(mTmpConfig); configChanges = ActivityInfo.activityInfoConfigToNative(configChanges); } return configChanges; } private void clearDrawableCachesLocked( ArrayMap>> caches, int configChanges) { final int N = caches.size(); for (int i = 0; i < N; i++) { clearDrawableCacheLocked(caches.valueAt(i), configChanges); } } private void clearDrawableCacheLocked( LongSparseArray> cache, int configChanges) { if (DEBUG_CONFIG) { Log.d(TAG, "Cleaning up drawables config changes: 0x" + Integer.toHexString(configChanges)); } final int N = cache.size(); for (int i = 0; i < N; i++) { final WeakReference ref = cache.valueAt(i); if (ref != null) { final ConstantState cs = ref.get(); if (cs != null) { if (Configuration.needNewResources( configChanges, cs.getChangingConfigurations())) { if (DEBUG_CONFIG) { Log.d(TAG, "FLUSHING #0x" + Long.toHexString(cache.keyAt(i)) + " / " + cs + " with changes: 0x" + Integer.toHexString(cs.getChangingConfigurations())); } cache.setValueAt(i, null); } else if (DEBUG_CONFIG) { Log.d(TAG, "(Keeping #0x" + Long.toHexString(cache.keyAt(i)) + " / " + cs + " with changes: 0x" + Integer.toHexString(cs.getChangingConfigurations()) + ")"); } } } } } /** * {@code Locale.toLanguageTag} will transform the obsolete (and deprecated) * language codes "in", "ji" and "iw" to "id", "yi" and "he" respectively. * * All released versions of android prior to "L" used the deprecated language * tags, so we will need to support them for backwards compatibility. * * Note that this conversion needs to take place *after* the call to * {@code toLanguageTag} because that will convert all the deprecated codes to * the new ones, even if they're set manually. */ private static String adjustLanguageTag(String languageTag) { final int separator = languageTag.indexOf('-'); final String language; final String remainder; if (separator == -1) { language = languageTag; remainder = ""; } else { language = languageTag.substring(0, separator); remainder = languageTag.substring(separator); } return Locale.adjustLanguageCode(language) + remainder; } /** * Update the system resources configuration if they have previously * been initialized. * * @hide */ public static void updateSystemConfiguration(Configuration config, DisplayMetrics metrics, CompatibilityInfo compat) { if (mSystem != null) { mSystem.updateConfiguration(config, metrics, compat); //Log.i(TAG, "Updated system resources " + mSystem // + ": " + mSystem.getConfiguration()); } } /** * Return the current display metrics that are in effect for this resource * object. The returned object should be treated as read-only. * * @return The resource's current display metrics. */ public DisplayMetrics getDisplayMetrics() { if (DEBUG_CONFIG) Slog.v(TAG, "Returning DisplayMetrics: " + mMetrics.widthPixels + "x" + mMetrics.heightPixels + " " + mMetrics.density); return mMetrics; } /** * Return the current configuration that is in effect for this resource * object. The returned object should be treated as read-only. * * @return The resource's current configuration. */ public Configuration getConfiguration() { return mConfiguration; } /** * Return the compatibility mode information for the application. * The returned object should be treated as read-only. * * @return compatibility info. * @hide */ public CompatibilityInfo getCompatibilityInfo() { return mCompatibilityInfo; } /** * This is just for testing. * @hide */ public void setCompatibilityInfo(CompatibilityInfo ci) { if (ci != null) { mCompatibilityInfo = ci; updateConfiguration(mConfiguration, mMetrics); } } /** * Return a resource identifier for the given resource name. A fully * qualified resource name is of the form "package:type/entry". The first * two components (package and type) are optional if defType and * defPackage, respectively, are specified here. * *

Note: use of this function is discouraged. It is much more * efficient to retrieve resources by identifier than by name. * * @param name The name of the desired resource. * @param defType Optional default resource type to find, if "type/" is * not included in the name. Can be null to require an * explicit type. * @param defPackage Optional default package to find, if "package:" is * not included in the name. Can be null to require an * explicit package. * * @return int The associated resource identifier. Returns 0 if no such * resource was found. (0 is not a valid resource ID.) */ public int getIdentifier(String name, String defType, String defPackage) { if (name == null) { throw new NullPointerException("name is null"); } try { return Integer.parseInt(name); } catch (Exception e) { // Ignore } return mAssets.getResourceIdentifier(name, defType, defPackage); } /** * Return true if given resource identifier includes a package. * * @hide */ public static boolean resourceHasPackage(int resid) { return (resid >>> 24) != 0; } /** * Return the full name for a given resource identifier. This name is * a single string of the form "package:type/entry". * * @param resid The resource identifier whose name is to be retrieved. * * @return A string holding the name of the resource. * * @throws NotFoundException Throws NotFoundException if the given ID does not exist. * * @see #getResourcePackageName * @see #getResourceTypeName * @see #getResourceEntryName */ public String getResourceName(int resid) throws NotFoundException { String str = mAssets.getResourceName(resid); if (str != null) return str; throw new NotFoundException("Unable to find resource ID #0x" + Integer.toHexString(resid)); } /** * Return the package name for a given resource identifier. * * @param resid The resource identifier whose package name is to be * retrieved. * * @return A string holding the package name of the resource. * * @throws NotFoundException Throws NotFoundException if the given ID does not exist. * * @see #getResourceName */ public String getResourcePackageName(int resid) throws NotFoundException { String str = mAssets.getResourcePackageName(resid); if (str != null) return str; throw new NotFoundException("Unable to find resource ID #0x" + Integer.toHexString(resid)); } /** * Return the type name for a given resource identifier. * * @param resid The resource identifier whose type name is to be * retrieved. * * @return A string holding the type name of the resource. * * @throws NotFoundException Throws NotFoundException if the given ID does not exist. * * @see #getResourceName */ public String getResourceTypeName(int resid) throws NotFoundException { String str = mAssets.getResourceTypeName(resid); if (str != null) return str; throw new NotFoundException("Unable to find resource ID #0x" + Integer.toHexString(resid)); } /** * Return the entry name for a given resource identifier. * * @param resid The resource identifier whose entry name is to be * retrieved. * * @return A string holding the entry name of the resource. * * @throws NotFoundException Throws NotFoundException if the given ID does not exist. * * @see #getResourceName */ public String getResourceEntryName(int resid) throws NotFoundException { String str = mAssets.getResourceEntryName(resid); if (str != null) return str; throw new NotFoundException("Unable to find resource ID #0x" + Integer.toHexString(resid)); } /** * Parse a series of {@link android.R.styleable#Extra <extra>} tags from * an XML file. You call this when you are at the parent tag of the * extra tags, and it will return once all of the child tags have been parsed. * This will call {@link #parseBundleExtra} for each extra tag encountered. * * @param parser The parser from which to retrieve the extras. * @param outBundle A Bundle in which to place all parsed extras. * @throws XmlPullParserException * @throws IOException */ public void parseBundleExtras(XmlResourceParser parser, Bundle outBundle) throws XmlPullParserException, IOException { int outerDepth = parser.getDepth(); int type; while ((type=parser.next()) != XmlPullParser.END_DOCUMENT && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) { if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) { continue; } String nodeName = parser.getName(); if (nodeName.equals("extra")) { parseBundleExtra("extra", parser, outBundle); XmlUtils.skipCurrentTag(parser); } else { XmlUtils.skipCurrentTag(parser); } } } /** * Parse a name/value pair out of an XML tag holding that data. The * AttributeSet must be holding the data defined by * {@link android.R.styleable#Extra}. The following value types are supported: *

    *
  • {@link TypedValue#TYPE_STRING}: * {@link Bundle#putCharSequence Bundle.putCharSequence()} *
  • {@link TypedValue#TYPE_INT_BOOLEAN}: * {@link Bundle#putCharSequence Bundle.putBoolean()} *
  • {@link TypedValue#TYPE_FIRST_INT}-{@link TypedValue#TYPE_LAST_INT}: * {@link Bundle#putCharSequence Bundle.putBoolean()} *
  • {@link TypedValue#TYPE_FLOAT}: * {@link Bundle#putCharSequence Bundle.putFloat()} *
* * @param tagName The name of the tag these attributes come from; this is * only used for reporting error messages. * @param attrs The attributes from which to retrieve the name/value pair. * @param outBundle The Bundle in which to place the parsed value. * @throws XmlPullParserException If the attributes are not valid. */ public void parseBundleExtra(String tagName, AttributeSet attrs, Bundle outBundle) throws XmlPullParserException { TypedArray sa = obtainAttributes(attrs, com.android.internal.R.styleable.Extra); String name = sa.getString( com.android.internal.R.styleable.Extra_name); if (name == null) { sa.recycle(); throw new XmlPullParserException("<" + tagName + "> requires an android:name attribute at " + attrs.getPositionDescription()); } TypedValue v = sa.peekValue( com.android.internal.R.styleable.Extra_value); if (v != null) { if (v.type == TypedValue.TYPE_STRING) { CharSequence cs = v.coerceToString(); outBundle.putCharSequence(name, cs); } else if (v.type == TypedValue.TYPE_INT_BOOLEAN) { outBundle.putBoolean(name, v.data != 0); } else if (v.type >= TypedValue.TYPE_FIRST_INT && v.type <= TypedValue.TYPE_LAST_INT) { outBundle.putInt(name, v.data); } else if (v.type == TypedValue.TYPE_FLOAT) { outBundle.putFloat(name, v.getFloat()); } else { sa.recycle(); throw new XmlPullParserException("<" + tagName + "> only supports string, integer, float, color, and boolean at " + attrs.getPositionDescription()); } } else { sa.recycle(); throw new XmlPullParserException("<" + tagName + "> requires an android:value or android:resource attribute at " + attrs.getPositionDescription()); } sa.recycle(); } /** * Retrieve underlying AssetManager storage for these resources. */ public final AssetManager getAssets() { return mAssets; } /** * Call this to remove all cached loaded layout resources from the * Resources object. Only intended for use with performance testing * tools. */ public final void flushLayoutCache() { synchronized (mCachedXmlBlockIds) { // First see if this block is in our cache. final int num = mCachedXmlBlockIds.length; for (int i=0; i getPreloadedDrawables() { return sPreloadedDrawables[0]; } private boolean verifyPreloadConfig(int changingConfigurations, int allowVarying, int resourceId, String name) { // We allow preloading of resources even if they vary by font scale (which // doesn't impact resource selection) or density (which we handle specially by // simply turning off all preloading), as well as any other configs specified // by the caller. if (((changingConfigurations&~(ActivityInfo.CONFIG_FONT_SCALE | ActivityInfo.CONFIG_DENSITY)) & ~allowVarying) != 0) { String resName; try { resName = getResourceName(resourceId); } catch (NotFoundException e) { resName = "?"; } // This should never happen in production, so we should log a // warning even if we're not debugging. Log.w(TAG, "Preloaded " + name + " resource #0x" + Integer.toHexString(resourceId) + " (" + resName + ") that varies with configuration!!"); return false; } if (TRACE_FOR_PRELOAD) { String resName; try { resName = getResourceName(resourceId); } catch (NotFoundException e) { resName = "?"; } Log.w(TAG, "Preloading " + name + " resource #0x" + Integer.toHexString(resourceId) + " (" + resName + ")"); } return true; } /*package*/ Drawable loadDrawable(TypedValue value, int id, Theme theme) throws NotFoundException { if (TRACE_FOR_PRELOAD) { // Log only framework resources if ((id >>> 24) == 0x1) { final String name = getResourceName(id); if (name != null) { Log.d("PreloadDrawable", name); } } } final boolean isColorDrawable; final ArrayMap>> caches; final long key; if (value.type >= TypedValue.TYPE_FIRST_COLOR_INT && value.type <= TypedValue.TYPE_LAST_COLOR_INT) { isColorDrawable = true; caches = mColorDrawableCache; key = value.data; } else { isColorDrawable = false; caches = mDrawableCache; key = (((long) value.assetCookie) << 32) | value.data; } // First, check whether we have a cached version of this drawable // that was inflated against the specified theme. if (!mPreloading) { final Drawable cachedDrawable = getCachedDrawable(caches, key, theme); if (cachedDrawable != null) { return cachedDrawable; } } // Next, check preloaded drawables. These are unthemed but may have // themeable attributes. final ConstantState cs; if (isColorDrawable) { cs = sPreloadedColorDrawables.get(key); } else { cs = sPreloadedDrawables[mConfiguration.getLayoutDirection()].get(key); } final Drawable dr; if (cs != null) { final Drawable clonedDr = cs.newDrawable(this); if (theme != null) { dr = clonedDr.mutate(); dr.applyTheme(theme); dr.clearMutated(); } else { dr = clonedDr; } } else if (isColorDrawable) { dr = new ColorDrawable(value.data); } else { dr = loadDrawableForCookie(value, id, theme); } // If we were able to obtain a drawable, store it in the appropriate // cache (either preload or themed). if (dr != null) { dr.setChangingConfigurations(value.changingConfigurations); cacheDrawable(value, theme, isColorDrawable, caches, key, dr); } return dr; } private void cacheDrawable(TypedValue value, Theme theme, boolean isColorDrawable, ArrayMap>> caches, long key, Drawable dr) { final ConstantState cs = dr.getConstantState(); if (cs == null) { return; } if (mPreloading) { // Preloaded drawables never have a theme, but may be themeable. final int changingConfigs = cs.getChangingConfigurations(); if (isColorDrawable) { if (verifyPreloadConfig(changingConfigs, 0, value.resourceId, "drawable")) { sPreloadedColorDrawables.put(key, cs); } } else { if (verifyPreloadConfig( changingConfigs, LAYOUT_DIR_CONFIG, value.resourceId, "drawable")) { if ((changingConfigs & LAYOUT_DIR_CONFIG) == 0) { // If this resource does not vary based on layout direction, // we can put it in all of the preload maps. sPreloadedDrawables[0].put(key, cs); sPreloadedDrawables[1].put(key, cs); } else { // Otherwise, only in the layout dir we loaded it for. sPreloadedDrawables[mConfiguration.getLayoutDirection()].put(key, cs); } } } } else { synchronized (mAccessLock) { final String themeKey = theme == null ? "" : theme.mKey; LongSparseArray> themedCache = caches.get(themeKey); if (themedCache == null) { themedCache = new LongSparseArray>(1); caches.put(themeKey, themedCache); } themedCache.put(key, new WeakReference(cs)); } } } /** * Loads a drawable from XML or resources stream. */ private Drawable loadDrawableForCookie(TypedValue value, int id, Theme theme) { if (value.string == null) { throw new NotFoundException("Resource \"" + getResourceName(id) + "\" (" + Integer.toHexString(id) + ") is not a Drawable (color or path): " + value); } final String file = value.string.toString(); if (TRACE_FOR_MISS_PRELOAD) { // Log only framework resources if ((id >>> 24) == 0x1) { final String name = getResourceName(id); if (name != null) { Log.d(TAG, "Loading framework drawable #" + Integer.toHexString(id) + ": " + name + " at " + file); } } } if (DEBUG_LOAD) { Log.v(TAG, "Loading drawable for cookie " + value.assetCookie + ": " + file); } final Drawable dr; Trace.traceBegin(Trace.TRACE_TAG_RESOURCES, file); try { if (file.endsWith(".xml")) { final XmlResourceParser rp = loadXmlResourceParser( file, id, value.assetCookie, "drawable"); dr = Drawable.createFromXml(this, rp, theme); rp.close(); } else { final InputStream is = mAssets.openNonAsset( value.assetCookie, file, AssetManager.ACCESS_STREAMING); dr = Drawable.createFromResourceStream(this, value, is, file, null); is.close(); } } catch (Exception e) { Trace.traceEnd(Trace.TRACE_TAG_RESOURCES); final NotFoundException rnf = new NotFoundException( "File " + file + " from drawable resource ID #0x" + Integer.toHexString(id)); rnf.initCause(e); throw rnf; } Trace.traceEnd(Trace.TRACE_TAG_RESOURCES); return dr; } private Drawable getCachedDrawable( ArrayMap>> caches, long key, Theme theme) { synchronized (mAccessLock) { final String themeKey = theme != null ? theme.mKey : ""; final LongSparseArray> themedCache = caches.get(themeKey); if (themedCache != null) { final Drawable themedDrawable = getCachedDrawableLocked(themedCache, key); if (themedDrawable != null) { return themedDrawable; } } // No cached drawable, we'll need to create a new one. return null; } } private ConstantState getConstantStateLocked( LongSparseArray> drawableCache, long key) { final WeakReference wr = drawableCache.get(key); if (wr != null) { // we have the key final ConstantState entry = wr.get(); if (entry != null) { //Log.i(TAG, "Returning cached drawable @ #" + // Integer.toHexString(((Integer)key).intValue()) // + " in " + this + ": " + entry); return entry; } else { // our entry has been purged drawableCache.delete(key); } } return null; } private Drawable getCachedDrawableLocked( LongSparseArray> drawableCache, long key) { final ConstantState entry = getConstantStateLocked(drawableCache, key); if (entry != null) { return entry.newDrawable(this); } return null; } /*package*/ ColorStateList loadColorStateList(TypedValue value, int id) throws NotFoundException { if (TRACE_FOR_PRELOAD) { // Log only framework resources if ((id >>> 24) == 0x1) { final String name = getResourceName(id); if (name != null) android.util.Log.d("PreloadColorStateList", name); } } final long key = (((long) value.assetCookie) << 32) | value.data; ColorStateList csl; if (value.type >= TypedValue.TYPE_FIRST_COLOR_INT && value.type <= TypedValue.TYPE_LAST_COLOR_INT) { csl = sPreloadedColorStateLists.get(key); if (csl != null) { return csl; } csl = ColorStateList.valueOf(value.data); if (mPreloading) { if (verifyPreloadConfig(value.changingConfigurations, 0, value.resourceId, "color")) { sPreloadedColorStateLists.put(key, csl); } } return csl; } csl = getCachedColorStateList(key); if (csl != null) { return csl; } csl = sPreloadedColorStateLists.get(key); if (csl != null) { return csl; } if (value.string == null) { throw new NotFoundException( "Resource is not a ColorStateList (color or path): " + value); } final String file = value.string.toString(); if (file.endsWith(".xml")) { Trace.traceBegin(Trace.TRACE_TAG_RESOURCES, file); try { final XmlResourceParser rp = loadXmlResourceParser( file, id, value.assetCookie, "colorstatelist"); csl = ColorStateList.createFromXml(this, rp); rp.close(); } catch (Exception e) { Trace.traceEnd(Trace.TRACE_TAG_RESOURCES); NotFoundException rnf = new NotFoundException( "File " + file + " from color state list resource ID #0x" + Integer.toHexString(id)); rnf.initCause(e); throw rnf; } Trace.traceEnd(Trace.TRACE_TAG_RESOURCES); } else { throw new NotFoundException( "File " + file + " from drawable resource ID #0x" + Integer.toHexString(id) + ": .xml extension required"); } if (csl != null) { if (mPreloading) { if (verifyPreloadConfig(value.changingConfigurations, 0, value.resourceId, "color")) { sPreloadedColorStateLists.put(key, csl); } } else { synchronized (mAccessLock) { //Log.i(TAG, "Saving cached color state list @ #" + // Integer.toHexString(key.intValue()) // + " in " + this + ": " + csl); mColorStateListCache.put(key, new WeakReference(csl)); } } } return csl; } private ColorStateList getCachedColorStateList(long key) { synchronized (mAccessLock) { WeakReference wr = mColorStateListCache.get(key); if (wr != null) { // we have the key ColorStateList entry = wr.get(); if (entry != null) { //Log.i(TAG, "Returning cached color state list @ #" + // Integer.toHexString(((Integer)key).intValue()) // + " in " + this + ": " + entry); return entry; } else { // our entry has been purged mColorStateListCache.delete(key); } } } return null; } /*package*/ XmlResourceParser loadXmlResourceParser(int id, String type) throws NotFoundException { synchronized (mAccessLock) { TypedValue value = mTmpValue; if (value == null) { mTmpValue = value = new TypedValue(); } getValue(id, value, true); if (value.type == TypedValue.TYPE_STRING) { return loadXmlResourceParser(value.string.toString(), id, value.assetCookie, type); } throw new NotFoundException( "Resource ID #0x" + Integer.toHexString(id) + " type #0x" + Integer.toHexString(value.type) + " is not valid"); } } /*package*/ XmlResourceParser loadXmlResourceParser(String file, int id, int assetCookie, String type) throws NotFoundException { if (id != 0) { try { // These may be compiled... synchronized (mCachedXmlBlockIds) { // First see if this block is in our cache. final int num = mCachedXmlBlockIds.length; for (int i=0; i