2869 lines
113 KiB
Java
2869 lines
113 KiB
Java
/*
|
|
* 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.AnimRes;
|
|
import android.annotation.AnimatorRes;
|
|
import android.annotation.AnyRes;
|
|
import android.annotation.ArrayRes;
|
|
import android.annotation.AttrRes;
|
|
import android.annotation.BoolRes;
|
|
import android.annotation.ColorInt;
|
|
import android.annotation.ColorRes;
|
|
import android.annotation.DimenRes;
|
|
import android.annotation.Discouraged;
|
|
import android.annotation.DrawableRes;
|
|
import android.annotation.FlaggedApi;
|
|
import android.annotation.FontRes;
|
|
import android.annotation.FractionRes;
|
|
import android.annotation.IntegerRes;
|
|
import android.annotation.LayoutRes;
|
|
import android.annotation.NonNull;
|
|
import android.annotation.Nullable;
|
|
import android.annotation.PluralsRes;
|
|
import android.annotation.RawRes;
|
|
import android.annotation.StringRes;
|
|
import android.annotation.StyleRes;
|
|
import android.annotation.StyleableRes;
|
|
import android.annotation.XmlRes;
|
|
import android.app.Application;
|
|
import android.app.ResourcesManager;
|
|
import android.compat.annotation.UnsupportedAppUsage;
|
|
import android.content.Context;
|
|
import android.content.pm.ActivityInfo;
|
|
import android.content.pm.ActivityInfo.Config;
|
|
import android.content.pm.ApplicationInfo;
|
|
import android.content.res.loader.ResourcesLoader;
|
|
import android.graphics.Movie;
|
|
import android.graphics.Typeface;
|
|
import android.graphics.drawable.Drawable;
|
|
import android.graphics.drawable.Drawable.ConstantState;
|
|
import android.graphics.drawable.DrawableInflater;
|
|
import android.os.Build;
|
|
import android.os.Bundle;
|
|
import android.os.SystemClock;
|
|
import android.util.ArrayMap;
|
|
import android.util.ArraySet;
|
|
import android.util.AttributeSet;
|
|
import android.util.DisplayMetrics;
|
|
import android.util.Log;
|
|
import android.util.LongSparseArray;
|
|
import android.util.Pools.SynchronizedPool;
|
|
import android.util.TypedValue;
|
|
import android.view.Display;
|
|
import android.view.DisplayAdjustments;
|
|
import android.view.ViewDebug;
|
|
import android.view.ViewHierarchyEncoder;
|
|
import android.view.WindowManager;
|
|
|
|
import com.android.internal.annotations.GuardedBy;
|
|
import com.android.internal.annotations.VisibleForTesting;
|
|
import com.android.internal.util.ArrayUtils;
|
|
import com.android.internal.util.GrowingArrayUtils;
|
|
import com.android.internal.util.Preconditions;
|
|
import com.android.internal.util.XmlUtils;
|
|
|
|
import org.xmlpull.v1.XmlPullParser;
|
|
import org.xmlpull.v1.XmlPullParserException;
|
|
|
|
import java.io.IOException;
|
|
import java.io.InputStream;
|
|
import java.io.PrintWriter;
|
|
import java.lang.ref.WeakReference;
|
|
import java.util.ArrayList;
|
|
import java.util.Arrays;
|
|
import java.util.Collections;
|
|
import java.util.List;
|
|
import java.util.Set;
|
|
import java.util.WeakHashMap;
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* <p>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()}.</p>
|
|
*
|
|
* <p>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.</p>
|
|
*
|
|
* <p>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.</p>
|
|
*
|
|
* <p>After {@link Build.VERSION_CODES#R}, {@link Resources} must be obtained by
|
|
* {@link android.app.Activity} or {@link android.content.Context} created with
|
|
* {@link android.content.Context#createWindowContext(int, Bundle)}.
|
|
* {@link Application#getResources()} may report wrong values in multi-window or on secondary
|
|
* displays.
|
|
*
|
|
* <p>For more information about using resources, see the documentation about <a
|
|
* href="{@docRoot}guide/topics/resources/index.html">Application Resources</a>.</p>
|
|
*/
|
|
public class Resources {
|
|
/**
|
|
* The {@code null} resource ID. This denotes an invalid resource ID that is returned by the
|
|
* system when a resource is not found or the value is set to {@code @null} in XML.
|
|
*/
|
|
public static final @AnyRes int ID_NULL = 0;
|
|
|
|
static final String TAG = "Resources";
|
|
|
|
private static final Object sSync = new Object();
|
|
private final Object mUpdateLock = new Object();
|
|
|
|
/**
|
|
* Controls whether we should preload resources during zygote init.
|
|
*/
|
|
private static final boolean PRELOAD_RESOURCES = true;
|
|
|
|
// Used by BridgeResources in layoutlib
|
|
@UnsupportedAppUsage
|
|
static Resources mSystem = null;
|
|
|
|
@UnsupportedAppUsage
|
|
private ResourcesImpl mResourcesImpl;
|
|
|
|
// Pool of TypedArrays targeted to this Resources object.
|
|
@UnsupportedAppUsage
|
|
final SynchronizedPool<TypedArray> mTypedArrayPool = new SynchronizedPool<>(5);
|
|
|
|
/** Used to inflate drawable objects from XML. */
|
|
@UnsupportedAppUsage
|
|
private DrawableInflater mDrawableInflater;
|
|
|
|
/** Lock object used to protect access to {@link #mTmpValue}. */
|
|
private final Object mTmpValueLock = new Object();
|
|
|
|
/** Single-item pool used to minimize TypedValue allocations. */
|
|
@UnsupportedAppUsage
|
|
private TypedValue mTmpValue = new TypedValue();
|
|
|
|
@UnsupportedAppUsage
|
|
final ClassLoader mClassLoader;
|
|
|
|
@GuardedBy("mUpdateLock")
|
|
private UpdateCallbacks mCallbacks = null;
|
|
|
|
/**
|
|
* WeakReferences to Themes that were constructed from this Resources object.
|
|
* We keep track of these in case our underlying implementation is changed, in which case
|
|
* the Themes must also get updated ThemeImpls.
|
|
*/
|
|
private final ArrayList<WeakReference<Theme>> mThemeRefs = new ArrayList<>();
|
|
|
|
/**
|
|
* To avoid leaking WeakReferences to garbage collected Themes on the
|
|
* mThemeRefs list, we flush the list of stale references any time the
|
|
* mThemeRefNextFlushSize is reached.
|
|
*/
|
|
private static final int MIN_THEME_REFS_FLUSH_SIZE = 32;
|
|
private static final int MAX_THEME_REFS_FLUSH_SIZE = 512;
|
|
private int mThemeRefsNextFlushSize = MIN_THEME_REFS_FLUSH_SIZE;
|
|
|
|
private int mBaseApkAssetsSize;
|
|
|
|
/** @hide */
|
|
private static final Set<Resources> sResourcesHistory = Collections.synchronizedSet(
|
|
Collections.newSetFromMap(
|
|
new WeakHashMap<>()));
|
|
|
|
/**
|
|
* Returns the most appropriate default theme for the specified target SDK version.
|
|
* <ul>
|
|
* <li>Below API 11: Gingerbread
|
|
* <li>APIs 12 thru 14: Holo
|
|
* <li>APIs 15 thru 23: Device default dark
|
|
* <li>APIs 24 and above: Device default light with dark action bar
|
|
* </ul>
|
|
*
|
|
* @param curTheme The current theme, or 0 if not specified.
|
|
* @param targetSdkVersion The target SDK version.
|
|
* @return A theme resource identifier
|
|
* @hide
|
|
*/
|
|
@UnsupportedAppUsage
|
|
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 != ID_NULL) {
|
|
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.N) {
|
|
return dark;
|
|
}
|
|
return deviceDefault;
|
|
}
|
|
|
|
/**
|
|
* Return a global shared Resources object that provides access to only
|
|
* system resources (no application resources), is not configured for the
|
|
* current screen (can not use dimension units, does not change based on
|
|
* orientation, etc), and is not affected by Runtime Resource Overlay.
|
|
*/
|
|
public static Resources getSystem() {
|
|
synchronized (sSync) {
|
|
Resources ret = mSystem;
|
|
if (ret == null) {
|
|
ret = new Resources();
|
|
mSystem = ret;
|
|
}
|
|
return ret;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* 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);
|
|
}
|
|
|
|
public NotFoundException(String name, Exception cause) {
|
|
super(name, cause);
|
|
}
|
|
}
|
|
|
|
/** @hide */
|
|
public interface UpdateCallbacks extends ResourcesLoader.UpdateCallbacks {
|
|
/**
|
|
* Invoked when a {@link Resources} instance has a {@link ResourcesLoader} added, removed,
|
|
* or reordered.
|
|
*
|
|
* @param resources the instance being updated
|
|
* @param newLoaders the new set of loaders for the instance
|
|
*/
|
|
void onLoadersChanged(@NonNull Resources resources,
|
|
@NonNull List<ResourcesLoader> newLoaders);
|
|
}
|
|
|
|
/**
|
|
* Handler that propagates updates of the {@link Resources} instance to the underlying
|
|
* {@link AssetManager} when the Resources is not registered with a
|
|
* {@link android.app.ResourcesManager}.
|
|
* @hide
|
|
*/
|
|
public class AssetManagerUpdateHandler implements UpdateCallbacks{
|
|
|
|
@Override
|
|
public void onLoadersChanged(@NonNull Resources resources,
|
|
@NonNull List<ResourcesLoader> newLoaders) {
|
|
Preconditions.checkArgument(Resources.this == resources);
|
|
final ResourcesImpl impl = mResourcesImpl;
|
|
impl.clearAllCaches();
|
|
impl.getAssets().setLoaders(newLoaders);
|
|
}
|
|
|
|
@Override
|
|
public void onLoaderUpdated(@NonNull ResourcesLoader loader) {
|
|
final ResourcesImpl impl = mResourcesImpl;
|
|
final AssetManager assets = impl.getAssets();
|
|
if (assets.getLoaders().contains(loader)) {
|
|
impl.clearAllCaches();
|
|
assets.setLoaders(assets.getLoaders());
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Create a new Resources object on top of an existing set of assets in an
|
|
* AssetManager.
|
|
*
|
|
* @deprecated Resources should not be constructed by apps.
|
|
* See {@link android.content.Context#createConfigurationContext(Configuration)}.
|
|
*
|
|
* @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).
|
|
*/
|
|
@Deprecated
|
|
public Resources(AssetManager assets, DisplayMetrics metrics, Configuration config) {
|
|
this(null);
|
|
mResourcesImpl = new ResourcesImpl(assets, metrics, config, new DisplayAdjustments());
|
|
}
|
|
|
|
/**
|
|
* Creates a new Resources object with CompatibilityInfo.
|
|
*
|
|
* @param classLoader class loader for the package used to load custom
|
|
* resource classes, may be {@code null} to use system
|
|
* class loader
|
|
* @hide
|
|
*/
|
|
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
|
|
public Resources(@Nullable ClassLoader classLoader) {
|
|
mClassLoader = classLoader == null ? ClassLoader.getSystemClassLoader() : classLoader;
|
|
sResourcesHistory.add(this);
|
|
ResourcesManager.getInstance().registerAllResourcesReference(this);
|
|
}
|
|
|
|
/**
|
|
* Only for creating the System resources. This is the only constructor that doesn't add
|
|
* Resources itself to the ResourcesManager list of all Resources references.
|
|
*/
|
|
@UnsupportedAppUsage
|
|
private Resources() {
|
|
mClassLoader = ClassLoader.getSystemClassLoader();
|
|
sResourcesHistory.add(this);
|
|
|
|
final DisplayMetrics metrics = new DisplayMetrics();
|
|
metrics.setToDefaults();
|
|
|
|
final Configuration config = new Configuration();
|
|
config.setToDefaults();
|
|
|
|
mResourcesImpl = new ResourcesImpl(AssetManager.getSystem(), metrics, config,
|
|
new DisplayAdjustments());
|
|
}
|
|
|
|
/**
|
|
* Set the underlying implementation (containing all the resources and caches)
|
|
* and updates all Theme implementations as well.
|
|
* @hide
|
|
*/
|
|
@UnsupportedAppUsage
|
|
public void setImpl(ResourcesImpl impl) {
|
|
if (impl == mResourcesImpl) {
|
|
return;
|
|
}
|
|
|
|
mBaseApkAssetsSize = ArrayUtils.size(impl.getAssets().getApkAssets());
|
|
mResourcesImpl = impl;
|
|
|
|
// Rebase the ThemeImpls using the new ResourcesImpl.
|
|
synchronized (mThemeRefs) {
|
|
cleanupThemeReferences();
|
|
final int count = mThemeRefs.size();
|
|
for (int i = 0; i < count; i++) {
|
|
Theme theme = mThemeRefs.get(i).get();
|
|
if (theme != null) {
|
|
theme.rebase(mResourcesImpl);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/** @hide */
|
|
public void setCallbacks(UpdateCallbacks callbacks) {
|
|
if (mCallbacks != null) {
|
|
throw new IllegalStateException("callback already registered");
|
|
}
|
|
|
|
mCallbacks = callbacks;
|
|
}
|
|
|
|
/**
|
|
* @hide
|
|
*/
|
|
@UnsupportedAppUsage
|
|
public ResourcesImpl getImpl() {
|
|
return mResourcesImpl;
|
|
}
|
|
|
|
/**
|
|
* @hide
|
|
*/
|
|
public ClassLoader getClassLoader() {
|
|
return mClassLoader;
|
|
}
|
|
|
|
/**
|
|
* @return the inflater used to create drawable objects
|
|
* @hide Pending API finalization.
|
|
*/
|
|
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
|
|
public final DrawableInflater getDrawableInflater() {
|
|
if (mDrawableInflater == null) {
|
|
mDrawableInflater = new DrawableInflater(this, mClassLoader);
|
|
}
|
|
return mDrawableInflater;
|
|
}
|
|
|
|
/**
|
|
* Used by AnimatorInflater.
|
|
*
|
|
* @hide
|
|
*/
|
|
public ConfigurationBoundResourceCache<Animator> getAnimatorCache() {
|
|
return mResourcesImpl.getAnimatorCache();
|
|
}
|
|
|
|
/**
|
|
* Used by AnimatorInflater.
|
|
*
|
|
* @hide
|
|
*/
|
|
public ConfigurationBoundResourceCache<StateListAnimator> getStateListAnimatorCache() {
|
|
return mResourcesImpl.getStateListAnimatorCache();
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
@NonNull public CharSequence getText(@StringRes int id) throws NotFoundException {
|
|
CharSequence res = mResourcesImpl.getAssets().getResourceText(id);
|
|
if (res != null) {
|
|
return res;
|
|
}
|
|
throw new NotFoundException("String resource ID #0x"
|
|
+ Integer.toHexString(id));
|
|
}
|
|
|
|
/**
|
|
* Return the Typeface value associated with a particular resource ID.
|
|
* {@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 Typeface The Typeface data associated with the resource.
|
|
*/
|
|
@NonNull public Typeface getFont(@FontRes int id) throws NotFoundException {
|
|
final TypedValue value = obtainTempTypedValue();
|
|
try {
|
|
final ResourcesImpl impl = mResourcesImpl;
|
|
impl.getValue(id, value, true);
|
|
Typeface typeface = impl.loadFont(this, value, id);
|
|
if (typeface != null) {
|
|
return typeface;
|
|
}
|
|
} finally {
|
|
releaseTempTypedValue(value);
|
|
}
|
|
throw new NotFoundException("Font resource ID #0x"
|
|
+ Integer.toHexString(id));
|
|
}
|
|
|
|
@NonNull
|
|
Typeface getFont(@NonNull TypedValue value, @FontRes int id) throws NotFoundException {
|
|
return mResourcesImpl.loadFont(this, value, id);
|
|
}
|
|
|
|
/**
|
|
* @hide
|
|
*/
|
|
public void preloadFonts(@ArrayRes int id) {
|
|
final TypedArray array = obtainTypedArray(id);
|
|
try {
|
|
final int size = array.length();
|
|
for (int i = 0; i < size; i++) {
|
|
array.getFont(i);
|
|
}
|
|
} finally {
|
|
array.recycle();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* 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
|
|
* <a href="{@docRoot}guide/topics/resources/string-resource.html#Plurals">String Resources</a>
|
|
* 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.
|
|
*/
|
|
@NonNull
|
|
public CharSequence getQuantityText(@PluralsRes int id, int quantity)
|
|
throws NotFoundException {
|
|
return mResourcesImpl.getQuantityText(id, quantity);
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
@NonNull
|
|
public String getString(@StringRes int id) throws NotFoundException {
|
|
return getText(id).toString();
|
|
}
|
|
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
@NonNull
|
|
public String getString(@StringRes int id, Object... formatArgs) throws NotFoundException {
|
|
final String raw = getString(id);
|
|
return String.format(mResourcesImpl.getConfiguration().getLocales().get(0), 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
|
|
* <a href="{@docRoot}guide/topics/resources/string-resource.html#Plurals">String Resources</a>
|
|
* for more detail.
|
|
*
|
|
* <p>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.
|
|
*/
|
|
@NonNull
|
|
public String getQuantityString(@PluralsRes int id, int quantity, Object... formatArgs)
|
|
throws NotFoundException {
|
|
String raw = getQuantityText(id, quantity).toString();
|
|
return String.format(mResourcesImpl.getConfiguration().getLocales().get(0), 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
|
|
* <a href="{@docRoot}guide/topics/resources/string-resource.html#Plurals">String Resources</a>
|
|
* 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.
|
|
*/
|
|
@NonNull
|
|
public String getQuantityString(@PluralsRes 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(@StringRes int id, CharSequence def) {
|
|
CharSequence res = id != 0 ? mResourcesImpl.getAssets().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.
|
|
*/
|
|
@NonNull
|
|
public CharSequence[] getTextArray(@ArrayRes int id) throws NotFoundException {
|
|
CharSequence[] res = mResourcesImpl.getAssets().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.
|
|
*/
|
|
@NonNull
|
|
public String[] getStringArray(@ArrayRes int id)
|
|
throws NotFoundException {
|
|
String[] res = mResourcesImpl.getAssets().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.
|
|
*/
|
|
@NonNull
|
|
public int[] getIntArray(@ArrayRes int id) throws NotFoundException {
|
|
int[] res = mResourcesImpl.getAssets().getResourceIntArray(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.
|
|
*/
|
|
@NonNull
|
|
public TypedArray obtainTypedArray(@ArrayRes int id) throws NotFoundException {
|
|
final ResourcesImpl impl = mResourcesImpl;
|
|
int len = impl.getAssets().getResourceArraySize(id);
|
|
if (len < 0) {
|
|
throw new NotFoundException("Array resource ID #0x" + Integer.toHexString(id));
|
|
}
|
|
|
|
TypedArray array = TypedArray.obtain(this, len);
|
|
array.mLength = impl.getAssets().getResourceArray(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 to convert to pixels.
|
|
*
|
|
* @throws NotFoundException Throws NotFoundException if the given ID does not exist.
|
|
*
|
|
* @see #getDimensionPixelOffset
|
|
* @see #getDimensionPixelSize
|
|
*/
|
|
public float getDimension(@DimenRes int id) throws NotFoundException {
|
|
final TypedValue value = obtainTempTypedValue();
|
|
try {
|
|
final ResourcesImpl impl = mResourcesImpl;
|
|
impl.getValue(id, value, true);
|
|
if (value.type == TypedValue.TYPE_DIMENSION) {
|
|
return TypedValue.complexToDimension(value.data, impl.getDisplayMetrics());
|
|
}
|
|
throw new NotFoundException("Resource ID #0x" + Integer.toHexString(id)
|
|
+ " type #0x" + Integer.toHexString(value.type) + " is not valid");
|
|
} finally {
|
|
releaseTempTypedValue(value);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* 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(@DimenRes int id) throws NotFoundException {
|
|
final TypedValue value = obtainTempTypedValue();
|
|
try {
|
|
final ResourcesImpl impl = mResourcesImpl;
|
|
impl.getValue(id, value, true);
|
|
if (value.type == TypedValue.TYPE_DIMENSION) {
|
|
return TypedValue.complexToDimensionPixelOffset(value.data,
|
|
impl.getDisplayMetrics());
|
|
}
|
|
throw new NotFoundException("Resource ID #0x" + Integer.toHexString(id)
|
|
+ " type #0x" + Integer.toHexString(value.type) + " is not valid");
|
|
} finally {
|
|
releaseTempTypedValue(value);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* 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(@DimenRes int id) throws NotFoundException {
|
|
final TypedValue value = obtainTempTypedValue();
|
|
try {
|
|
final ResourcesImpl impl = mResourcesImpl;
|
|
impl.getValue(id, value, true);
|
|
if (value.type == TypedValue.TYPE_DIMENSION) {
|
|
return TypedValue.complexToDimensionPixelSize(value.data, impl.getDisplayMetrics());
|
|
}
|
|
throw new NotFoundException("Resource ID #0x" + Integer.toHexString(id)
|
|
+ " type #0x" + Integer.toHexString(value.type) + " is not valid");
|
|
} finally {
|
|
releaseTempTypedValue(value);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* 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(@FractionRes int id, int base, int pbase) {
|
|
final TypedValue value = obtainTempTypedValue();
|
|
try {
|
|
mResourcesImpl.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");
|
|
} finally {
|
|
releaseTempTypedValue(value);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* <p class="note"><strong>Note:</strong> 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 manually resolve the aliased reference
|
|
* by using {@link #getValue(int, TypedValue, boolean)} and passing
|
|
* {@code true} for {@code resolveRefs}. The resulting
|
|
* {@link TypedValue#resourceId} value may be passed to this method.</p>
|
|
*
|
|
* <p class="note"><strong>Note:</strong> To obtain a themed drawable, use
|
|
* {@link android.content.Context#getDrawable(int) Context.getDrawable(int)}
|
|
* or {@link #getDrawable(int, Theme)} passing the desired theme.</p>
|
|
*
|
|
* @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
|
|
public Drawable getDrawable(@DrawableRes 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.
|
|
*/
|
|
public Drawable getDrawable(@DrawableRes int id, @Nullable Theme theme)
|
|
throws NotFoundException {
|
|
return getDrawableForDensity(id, 0, theme);
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* <p class="note"><strong>Note:</strong> 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.</p>
|
|
*
|
|
* @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}. A value of 0 means to use the
|
|
* density returned from {@link #getConfiguration()}.
|
|
* This is equivalent to calling {@link #getDrawable(int)}.
|
|
* @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.
|
|
*/
|
|
@Nullable
|
|
@Deprecated
|
|
public Drawable getDrawableForDensity(@DrawableRes 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}. A value of 0 means to use the
|
|
* density returned from {@link #getConfiguration()}.
|
|
* This is equivalent to calling {@link #getDrawable(int, Theme)}.
|
|
* @param theme The theme used to style the drawable attributes, may be {@code null} if the
|
|
* drawable cannot be decoded.
|
|
* @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(@DrawableRes int id, int density, @Nullable Theme theme) {
|
|
final TypedValue value = obtainTempTypedValue();
|
|
try {
|
|
final ResourcesImpl impl = mResourcesImpl;
|
|
impl.getValueForDensity(id, density, value, true);
|
|
return loadDrawable(value, id, density, theme);
|
|
} finally {
|
|
releaseTempTypedValue(value);
|
|
}
|
|
}
|
|
|
|
@NonNull
|
|
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
|
|
Drawable loadDrawable(@NonNull TypedValue value, int id, int density, @Nullable Theme theme)
|
|
throws NotFoundException {
|
|
return mResourcesImpl.loadDrawable(this, value, id, density, theme);
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @deprecated Prefer {@link android.graphics.drawable.AnimatedImageDrawable}.
|
|
*/
|
|
@Deprecated
|
|
public Movie getMovie(@RawRes int id) throws NotFoundException {
|
|
final InputStream is = openRawResource(id);
|
|
final Movie movie = Movie.decodeStream(is);
|
|
try {
|
|
is.close();
|
|
} catch (IOException e) {
|
|
// No one cares.
|
|
}
|
|
return movie;
|
|
}
|
|
|
|
/**
|
|
* Returns a color integer associated with a particular resource ID. If the
|
|
* resource holds a complex {@link 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 A single color value in the form 0xAARRGGBB.
|
|
* @deprecated Use {@link #getColor(int, Theme)} instead.
|
|
*/
|
|
@ColorInt
|
|
@Deprecated
|
|
public int getColor(@ColorRes int id) throws NotFoundException {
|
|
return getColor(id, null);
|
|
}
|
|
|
|
/**
|
|
* Returns a themed color integer associated with a particular resource ID.
|
|
* If the resource holds a complex {@link 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.
|
|
* @param theme The theme used to style the color attributes, may be
|
|
* {@code null}.
|
|
*
|
|
* @throws NotFoundException Throws NotFoundException if the given ID does
|
|
* not exist.
|
|
*
|
|
* @return A single color value in the form 0xAARRGGBB.
|
|
*/
|
|
@ColorInt
|
|
public int getColor(@ColorRes int id, @Nullable Theme theme) throws NotFoundException {
|
|
final TypedValue value = obtainTempTypedValue();
|
|
try {
|
|
final ResourcesImpl impl = mResourcesImpl;
|
|
impl.getValue(id, value, true);
|
|
if (value.type >= TypedValue.TYPE_FIRST_INT
|
|
&& value.type <= TypedValue.TYPE_LAST_INT) {
|
|
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");
|
|
}
|
|
|
|
final ColorStateList csl = impl.loadColorStateList(this, value, id, theme);
|
|
return csl.getDefaultColor();
|
|
} finally {
|
|
releaseTempTypedValue(value);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns a color state list associated with a particular resource ID. The
|
|
* resource may contain either a single raw color value or a complex
|
|
* {@link 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 A ColorStateList object containing either a single solid color
|
|
* or multiple colors that can be selected based on a state.
|
|
* @deprecated Use {@link #getColorStateList(int, Theme)} instead.
|
|
*/
|
|
@NonNull
|
|
@Deprecated
|
|
public ColorStateList getColorStateList(@ColorRes int id) throws NotFoundException {
|
|
final ColorStateList csl = getColorStateList(id, null);
|
|
if (csl != null && csl.canApplyTheme()) {
|
|
Log.w(TAG, "ColorStateList " + getResourceName(id) + " has "
|
|
+ "unresolved theme attributes! Consider using "
|
|
+ "Resources.getColorStateList(int, Theme) or "
|
|
+ "Context.getColorStateList(int).", new RuntimeException());
|
|
}
|
|
return csl;
|
|
}
|
|
|
|
/**
|
|
* Returns a themed color state list associated with a particular resource
|
|
* ID. The resource may contain either a single raw color value or a
|
|
* complex {@link 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.
|
|
* @param theme The theme used to style the color attributes, may be
|
|
* {@code null}.
|
|
*
|
|
* @throws NotFoundException Throws NotFoundException if the given ID does
|
|
* not exist.
|
|
*
|
|
* @return A themed ColorStateList object containing either a single solid
|
|
* color or multiple colors that can be selected based on a state.
|
|
*/
|
|
@NonNull
|
|
public ColorStateList getColorStateList(@ColorRes int id, @Nullable Theme theme)
|
|
throws NotFoundException {
|
|
final TypedValue value = obtainTempTypedValue();
|
|
try {
|
|
final ResourcesImpl impl = mResourcesImpl;
|
|
impl.getValue(id, value, true);
|
|
return impl.loadColorStateList(this, value, id, theme);
|
|
} finally {
|
|
releaseTempTypedValue(value);
|
|
}
|
|
}
|
|
|
|
@NonNull
|
|
ColorStateList loadColorStateList(@NonNull TypedValue value, int id, @Nullable Theme theme)
|
|
throws NotFoundException {
|
|
return mResourcesImpl.loadColorStateList(this, value, id, theme);
|
|
}
|
|
|
|
/**
|
|
* @hide
|
|
*/
|
|
@NonNull
|
|
public ComplexColor loadComplexColor(@NonNull TypedValue value, int id, @Nullable Theme theme) {
|
|
return mResourcesImpl.loadComplexColor(this, value, id, theme);
|
|
}
|
|
|
|
/**
|
|
* 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(@BoolRes int id) throws NotFoundException {
|
|
final TypedValue value = obtainTempTypedValue();
|
|
try {
|
|
mResourcesImpl.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");
|
|
} finally {
|
|
releaseTempTypedValue(value);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* 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(@IntegerRes int id) throws NotFoundException {
|
|
final TypedValue value = obtainTempTypedValue();
|
|
try {
|
|
mResourcesImpl.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");
|
|
} finally {
|
|
releaseTempTypedValue(value);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
public float getFloat(@DimenRes int id) {
|
|
final TypedValue value = obtainTempTypedValue();
|
|
try {
|
|
mResourcesImpl.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");
|
|
} finally {
|
|
releaseTempTypedValue(value);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* <p>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
|
|
*/
|
|
@NonNull
|
|
public XmlResourceParser getLayout(@LayoutRes 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.
|
|
*
|
|
* <p>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
|
|
*/
|
|
@NonNull
|
|
public XmlResourceParser getAnimation(@AnimatorRes @AnimRes 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.
|
|
*
|
|
* <p>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
|
|
*/
|
|
@NonNull
|
|
public XmlResourceParser getXml(@XmlRes 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 aapt tool.
|
|
*
|
|
* @return InputStream Access to the resource data.
|
|
*
|
|
* @throws NotFoundException Throws NotFoundException if the given ID does not exist.
|
|
*/
|
|
@NonNull
|
|
public InputStream openRawResource(@RawRes int id) throws NotFoundException {
|
|
final TypedValue value = obtainTempTypedValue();
|
|
try {
|
|
return openRawResource(id, value);
|
|
} finally {
|
|
releaseTempTypedValue(value);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns a TypedValue suitable for temporary use. The obtained TypedValue
|
|
* should be released using {@link #releaseTempTypedValue(TypedValue)}.
|
|
*
|
|
* @return a typed value suitable for temporary use
|
|
*/
|
|
private TypedValue obtainTempTypedValue() {
|
|
TypedValue tmpValue = null;
|
|
synchronized (mTmpValueLock) {
|
|
if (mTmpValue != null) {
|
|
tmpValue = mTmpValue;
|
|
mTmpValue = null;
|
|
}
|
|
}
|
|
if (tmpValue == null) {
|
|
return new TypedValue();
|
|
}
|
|
return tmpValue;
|
|
}
|
|
|
|
/**
|
|
* Returns a TypedValue to the pool. After calling this method, the
|
|
* specified TypedValue should no longer be accessed.
|
|
*
|
|
* @param value the typed value to return to the pool
|
|
*/
|
|
private void releaseTempTypedValue(TypedValue value) {
|
|
synchronized (mTmpValueLock) {
|
|
if (mTmpValue == null) {
|
|
mTmpValue = value;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* 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 aapt 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.
|
|
*/
|
|
@NonNull
|
|
public InputStream openRawResource(@RawRes int id, TypedValue value)
|
|
throws NotFoundException {
|
|
return mResourcesImpl.openRawResource(id, value);
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* <p>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 aapt 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(@RawRes int id)
|
|
throws NotFoundException {
|
|
final TypedValue value = obtainTempTypedValue();
|
|
try {
|
|
return mResourcesImpl.openRawResourceFd(id, value);
|
|
} finally {
|
|
releaseTempTypedValue(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(@AnyRes int id, TypedValue outValue, boolean resolveRefs)
|
|
throws NotFoundException {
|
|
mResourcesImpl.getValue(id, outValue, resolveRefs);
|
|
}
|
|
|
|
/**
|
|
* 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(@AnyRes int id, int density, TypedValue outValue,
|
|
boolean resolveRefs) throws NotFoundException {
|
|
mResourcesImpl.getValueForDensity(id, density, outValue, resolveRefs);
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* <p>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.
|
|
*
|
|
*/
|
|
@Discouraged(message = "Use of this function is discouraged because it makes internal calls to "
|
|
+ "`getIdentifier()`, which uses resource reflection. Reflection makes it "
|
|
+ "harder to perform build optimizations and compile-time verification of "
|
|
+ "code. It is much more efficient to retrieve resource values by "
|
|
+ "identifier (e.g. `getValue(R.foo.bar, outValue, true)`) than by name "
|
|
+ "(e.g. `getValue(\"foo\", outvalue, true)`).")
|
|
public void getValue(String name, TypedValue outValue, boolean resolveRefs)
|
|
throws NotFoundException {
|
|
mResourcesImpl.getValue(name, outValue, resolveRefs);
|
|
}
|
|
|
|
|
|
/**
|
|
* Returns the resource ID of the resource that was used to create this AttributeSet.
|
|
*
|
|
* @param set AttributeSet for which we want to find the source.
|
|
* @return The resource ID for the source that is backing the given AttributeSet or
|
|
* {@link Resources#ID_NULL} if the AttributeSet is {@code null}.
|
|
*/
|
|
@AnyRes
|
|
public static int getAttributeSetSourceResId(@Nullable AttributeSet set) {
|
|
return ResourcesImpl.getAttributeSetSourceResId(set);
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* <p>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.
|
|
*
|
|
* <p>You will normally use the {@link #obtainStyledAttributes} APIs to
|
|
* retrieve XML attributes with style and theme information applied.
|
|
*/
|
|
public final class Theme {
|
|
/**
|
|
* To trace parent themes needs to prevent a cycle situation.
|
|
* e.x. A's parent is B, B's parent is C, and C's parent is A.
|
|
*/
|
|
private static final int MAX_NUMBER_OF_TRACING_PARENT_THEME = 100;
|
|
|
|
private final Object mLock = new Object();
|
|
|
|
@GuardedBy("mLock")
|
|
@UnsupportedAppUsage
|
|
private ResourcesImpl.ThemeImpl mThemeImpl;
|
|
|
|
private Theme() {
|
|
}
|
|
|
|
void setImpl(ResourcesImpl.ThemeImpl impl) {
|
|
synchronized (mLock) {
|
|
mThemeImpl = impl;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Place new attribute values into the theme. The style resource
|
|
* specified by <var>resid</var> will be retrieved from this Theme's
|
|
* resources, its values placed into the Theme object.
|
|
*
|
|
* <p>The semantics of this function depends on the <var>force</var>
|
|
* 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) {
|
|
synchronized (mLock) {
|
|
mThemeImpl.applyStyle(resId, force);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Set this theme to hold the same contents as the theme
|
|
* <var>other</var>. 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) {
|
|
synchronized (mLock) {
|
|
synchronized (other.mLock) {
|
|
mThemeImpl.setTo(other.mThemeImpl);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Return a TypedArray holding the values defined by
|
|
* <var>Theme</var> which are listed in <var>attrs</var>.
|
|
*
|
|
* <p>Be sure to call {@link TypedArray#recycle() TypedArray.recycle()} when you are done
|
|
* with the array.
|
|
*
|
|
* @param attrs The desired attributes. These attribute IDs must be sorted in ascending
|
|
* order.
|
|
*
|
|
* @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)
|
|
*/
|
|
@NonNull
|
|
public TypedArray obtainStyledAttributes(@NonNull @StyleableRes int[] attrs) {
|
|
synchronized (mLock) {
|
|
return mThemeImpl.obtainStyledAttributes(this, null, attrs, 0, 0);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Return a TypedArray holding the values defined by the style
|
|
* resource <var>resid</var> which are listed in <var>attrs</var>.
|
|
*
|
|
* <p>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. These attribute IDs must be sorted in
|
|
* ascending order.
|
|
*
|
|
* @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)
|
|
*/
|
|
@NonNull
|
|
public TypedArray obtainStyledAttributes(@StyleRes int resId,
|
|
@NonNull @StyleableRes int[] attrs)
|
|
throws NotFoundException {
|
|
synchronized (mLock) {
|
|
return mThemeImpl.obtainStyledAttributes(this, null, attrs, 0, resId);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Return a TypedArray holding the attribute values in
|
|
* <var>set</var>
|
|
* that are listed in <var>attrs</var>. In addition, if the given
|
|
* AttributeSet specifies a style class (through the "style" attribute),
|
|
* that style will be applied on top of the base attributes it defines.
|
|
*
|
|
* <p>Be sure to call {@link TypedArray#recycle() TypedArray.recycle()} when you are done
|
|
* with the array.
|
|
*
|
|
* <p>When determining the final value of a particular attribute, there
|
|
* are four inputs that come into play:</p>
|
|
*
|
|
* <ol>
|
|
* <li> Any attribute values in the given AttributeSet.
|
|
* <li> The style resource specified in the AttributeSet (named
|
|
* "style").
|
|
* <li> The default style specified by <var>defStyleAttr</var> and
|
|
* <var>defStyleRes</var>
|
|
* <li> The base values in this theme.
|
|
* </ol>
|
|
*
|
|
* <p>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 <code><Button
|
|
* textColor="#ff000000"></code>, then the button's text will
|
|
* <em>always</em> 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. These attribute IDs must be sorted
|
|
* in ascending order.
|
|
* @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[])
|
|
*/
|
|
@NonNull
|
|
public TypedArray obtainStyledAttributes(@Nullable AttributeSet set,
|
|
@NonNull @StyleableRes int[] attrs, @AttrRes int defStyleAttr,
|
|
@StyleRes int defStyleRes) {
|
|
synchronized (mLock) {
|
|
return mThemeImpl.obtainStyledAttributes(this, set, attrs, defStyleAttr,
|
|
defStyleRes);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Retrieve the values for a set of attributes in the Theme. The
|
|
* contents of the typed array are ultimately filled in by
|
|
* {@link Resources#getValue}.
|
|
*
|
|
* @param values The base set of attribute values, must be equal in
|
|
* length to {@code attrs}. All values must be of type
|
|
* {@link TypedValue#TYPE_ATTRIBUTE}.
|
|
* @param attrs The desired attributes to be retrieved. These attribute IDs must be sorted
|
|
* in ascending order.
|
|
* @return Returns a TypedArray holding an array of the attribute
|
|
* values. Be sure to call {@link TypedArray#recycle()}
|
|
* when done with it.
|
|
* @hide
|
|
*/
|
|
@NonNull
|
|
@UnsupportedAppUsage
|
|
public TypedArray resolveAttributes(@NonNull int[] values, @NonNull int[] attrs) {
|
|
synchronized (mLock) {
|
|
return mThemeImpl.resolveAttributes(this, values, attrs);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Retrieve the value of an attribute in the Theme. The contents of
|
|
* <var>outValue</var> 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, <var>outValue</var> 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
|
|
* <var>outValue</var> is valid, else false.
|
|
*/
|
|
public boolean resolveAttribute(int resid, TypedValue outValue, boolean resolveRefs) {
|
|
synchronized (mLock) {
|
|
return mThemeImpl.resolveAttribute(resid, outValue, resolveRefs);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* 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() {
|
|
synchronized (mLock) {
|
|
return mThemeImpl.getAllAttributes();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* 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(@DrawableRes int id) throws NotFoundException {
|
|
return Resources.this.getDrawable(id, this);
|
|
}
|
|
|
|
/**
|
|
* Returns a bit mask of configuration changes that will impact this
|
|
* theme (and thus require completely reloading it).
|
|
*
|
|
* @return a bit mask of configuration changes, as defined by
|
|
* {@link ActivityInfo}
|
|
* @see ActivityInfo
|
|
*/
|
|
public @Config int getChangingConfigurations() {
|
|
synchronized (mLock) {
|
|
return mThemeImpl.getChangingConfigurations();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* 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) {
|
|
synchronized (mLock) {
|
|
mThemeImpl.dump(priority, tag, prefix);
|
|
}
|
|
}
|
|
|
|
// Needed by layoutlib.
|
|
/*package*/ long getNativeTheme() {
|
|
synchronized (mLock) {
|
|
return mThemeImpl.getNativeTheme();
|
|
}
|
|
}
|
|
|
|
/*package*/ int getAppliedStyleResId() {
|
|
synchronized (mLock) {
|
|
return mThemeImpl.getAppliedStyleResId();
|
|
}
|
|
}
|
|
|
|
@StyleRes
|
|
/*package*/ int getParentThemeIdentifier(@StyleRes int resId) {
|
|
synchronized (mLock) {
|
|
return mThemeImpl.getParentThemeIdentifier(resId);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @hide
|
|
*/
|
|
public ThemeKey getKey() {
|
|
synchronized (mLock) {
|
|
return mThemeImpl.getKey();
|
|
}
|
|
}
|
|
|
|
private String getResourceNameFromHexString(String hexString) {
|
|
return getResourceName(Integer.parseInt(hexString, 16));
|
|
}
|
|
|
|
/**
|
|
* Parses {@link #getKey()} 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() {
|
|
synchronized (mLock) {
|
|
return mThemeImpl.getTheme();
|
|
}
|
|
}
|
|
|
|
/** @hide */
|
|
public void encode(@NonNull ViewHierarchyEncoder encoder) {
|
|
encoder.beginObject(this);
|
|
final String[] properties = getTheme();
|
|
for (int i = 0; i < properties.length; i += 2) {
|
|
encoder.addProperty(properties[i], properties[i+1]);
|
|
}
|
|
encoder.endObject();
|
|
}
|
|
|
|
/**
|
|
* Rebases the theme against the parent Resource object's current
|
|
* configuration by re-applying the styles passed to
|
|
* {@link #applyStyle(int, boolean)}.
|
|
*/
|
|
public void rebase() {
|
|
synchronized (mLock) {
|
|
mThemeImpl.rebase();
|
|
}
|
|
}
|
|
|
|
void rebase(ResourcesImpl resImpl) {
|
|
synchronized (mLock) {
|
|
mThemeImpl.rebase(resImpl.mAssets);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns the resource ID for the style specified using {@code style="..."} in the
|
|
* {@link AttributeSet}'s backing XML element or {@link Resources#ID_NULL} otherwise if not
|
|
* specified or otherwise not applicable.
|
|
* <p>
|
|
* Each {@link android.view.View} can have an explicit style specified in the layout file.
|
|
* This style is used first during the {@link android.view.View} attribute resolution, then
|
|
* if an attribute is not defined there the resource system looks at default style and theme
|
|
* as fallbacks.
|
|
*
|
|
* @param set The base set of attribute values.
|
|
*
|
|
* @return The resource ID for the style specified using {@code style="..."} in the
|
|
* {@link AttributeSet}'s backing XML element or {@link Resources#ID_NULL} otherwise
|
|
* if not specified or otherwise not applicable.
|
|
*/
|
|
@StyleRes
|
|
public int getExplicitStyle(@Nullable AttributeSet set) {
|
|
if (set == null) {
|
|
return ID_NULL;
|
|
}
|
|
int styleAttr = set.getStyleAttribute();
|
|
if (styleAttr == ID_NULL) {
|
|
return ID_NULL;
|
|
}
|
|
String styleAttrType = getResources().getResourceTypeName(styleAttr);
|
|
if ("attr".equals(styleAttrType)) {
|
|
TypedValue explicitStyle = new TypedValue();
|
|
boolean resolved = resolveAttribute(styleAttr, explicitStyle, true);
|
|
if (resolved) {
|
|
return explicitStyle.resourceId;
|
|
}
|
|
} else if ("style".equals(styleAttrType)) {
|
|
return styleAttr;
|
|
}
|
|
return ID_NULL;
|
|
}
|
|
|
|
/**
|
|
* Returns the ordered list of resource ID that are considered when resolving attribute
|
|
* values when making an equivalent call to
|
|
* {@link #obtainStyledAttributes(AttributeSet, int[], int, int)} . The list will include
|
|
* a set of explicit styles ({@code explicitStyleRes} and it will include the default styles
|
|
* ({@code defStyleAttr} and {@code defStyleRes}).
|
|
*
|
|
* @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.
|
|
* @param explicitStyleRes A resource identifier of an explicit style resource.
|
|
* @return ordered list of resource ID that are considered when resolving attribute values.
|
|
*/
|
|
@NonNull
|
|
public int[] getAttributeResolutionStack(@AttrRes int defStyleAttr,
|
|
@StyleRes int defStyleRes, @StyleRes int explicitStyleRes) {
|
|
synchronized (mLock) {
|
|
int[] stack = mThemeImpl.getAttributeResolutionStack(
|
|
defStyleAttr, defStyleRes, explicitStyleRes);
|
|
if (stack == null) {
|
|
return new int[0];
|
|
} else {
|
|
return stack;
|
|
}
|
|
}
|
|
}
|
|
|
|
@Override
|
|
public int hashCode() {
|
|
return getKey().hashCode();
|
|
}
|
|
|
|
@Override
|
|
public boolean equals(@Nullable Object o) {
|
|
if (this == o) {
|
|
return true;
|
|
}
|
|
|
|
if (o == null || getClass() != o.getClass() || hashCode() != o.hashCode()) {
|
|
return false;
|
|
}
|
|
|
|
final Theme other = (Theme) o;
|
|
return getKey().equals(other.getKey());
|
|
}
|
|
|
|
@Override
|
|
public String toString() {
|
|
final StringBuilder sb = new StringBuilder();
|
|
sb.append('{');
|
|
int themeResId = getAppliedStyleResId();
|
|
int i = 0;
|
|
sb.append("InheritanceMap=[");
|
|
while (themeResId > 0) {
|
|
if (i > MAX_NUMBER_OF_TRACING_PARENT_THEME) {
|
|
sb.append(",...");
|
|
break;
|
|
}
|
|
|
|
if (i > 0) {
|
|
sb.append(", ");
|
|
}
|
|
sb.append("id=0x").append(Integer.toHexString(themeResId));
|
|
sb.append(getResourcePackageName(themeResId))
|
|
.append(":").append(getResourceTypeName(themeResId))
|
|
.append("/").append(getResourceEntryName(themeResId));
|
|
|
|
i++;
|
|
themeResId = getParentThemeIdentifier(themeResId);
|
|
}
|
|
sb.append("], Themes=").append(Arrays.deepToString(getTheme()));
|
|
sb.append('}');
|
|
return sb.toString();
|
|
}
|
|
}
|
|
|
|
static class ThemeKey implements Cloneable {
|
|
int[] mResId;
|
|
boolean[] mForce;
|
|
int mCount;
|
|
|
|
private int mHashCode = 0;
|
|
|
|
private int findValue(int resId, boolean force) {
|
|
for (int i = 0; i < mCount; ++i) {
|
|
if (mResId[i] == resId && mForce[i] == force) {
|
|
return i;
|
|
}
|
|
}
|
|
return -1;
|
|
}
|
|
|
|
private void moveToLast(int index) {
|
|
if (index < 0 || index >= mCount - 1) {
|
|
return;
|
|
}
|
|
final int id = mResId[index];
|
|
final boolean force = mForce[index];
|
|
System.arraycopy(mResId, index + 1, mResId, index, mCount - index - 1);
|
|
mResId[mCount - 1] = id;
|
|
System.arraycopy(mForce, index + 1, mForce, index, mCount - index - 1);
|
|
mForce[mCount - 1] = force;
|
|
}
|
|
|
|
public void append(int resId, boolean force) {
|
|
if (mResId == null) {
|
|
mResId = new int[4];
|
|
}
|
|
|
|
if (mForce == null) {
|
|
mForce = new boolean[4];
|
|
}
|
|
|
|
// Some apps tend to keep adding same resources over and over, let's protect from it.
|
|
// Note: the order still matters, as the values that come later override the earlier
|
|
// ones.
|
|
final int index = findValue(resId, force);
|
|
if (index >= 0) {
|
|
moveToLast(index);
|
|
} else {
|
|
mResId = GrowingArrayUtils.append(mResId, mCount, resId);
|
|
mForce = GrowingArrayUtils.append(mForce, mCount, force);
|
|
mCount++;
|
|
mHashCode = 31 * (31 * mHashCode + resId) + (force ? 1 : 0);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Sets up this key as a deep copy of another key.
|
|
*
|
|
* @param other the key to deep copy into this key
|
|
*/
|
|
public void setTo(ThemeKey other) {
|
|
mResId = other.mResId == null ? null : other.mResId.clone();
|
|
mForce = other.mForce == null ? null : other.mForce.clone();
|
|
mCount = other.mCount;
|
|
mHashCode = other.mHashCode;
|
|
}
|
|
|
|
@Override
|
|
public int hashCode() {
|
|
return mHashCode;
|
|
}
|
|
|
|
@Override
|
|
public boolean equals(@Nullable Object o) {
|
|
if (this == o) {
|
|
return true;
|
|
}
|
|
|
|
if (o == null || getClass() != o.getClass() || hashCode() != o.hashCode()) {
|
|
return false;
|
|
}
|
|
|
|
final ThemeKey t = (ThemeKey) o;
|
|
if (mCount != t.mCount) {
|
|
return false;
|
|
}
|
|
|
|
final int N = mCount;
|
|
for (int i = 0; i < N; i++) {
|
|
if (mResId[i] != t.mResId[i] || mForce[i] != t.mForce[i]) {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* @return a shallow copy of this key
|
|
*/
|
|
@Override
|
|
public ThemeKey clone() {
|
|
final ThemeKey other = new ThemeKey();
|
|
other.mResId = mResId;
|
|
other.mForce = mForce;
|
|
other.mCount = mCount;
|
|
other.mHashCode = mHashCode;
|
|
return other;
|
|
}
|
|
}
|
|
|
|
static int nextPowerOf2(int number) {
|
|
return number < 2 ? 2 : 1 >> ((int) (Math.log(number - 1) / Math.log(2)) + 1);
|
|
}
|
|
|
|
private void cleanupThemeReferences() {
|
|
// Clean up references to garbage collected themes
|
|
if (mThemeRefs.size() > mThemeRefsNextFlushSize) {
|
|
mThemeRefs.removeIf(ref -> ref.refersTo(null));
|
|
mThemeRefsNextFlushSize = Math.min(Math.max(MIN_THEME_REFS_FLUSH_SIZE,
|
|
nextPowerOf2(mThemeRefs.size())), MAX_THEME_REFS_FLUSH_SIZE);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* 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() {
|
|
Theme theme = new Theme();
|
|
theme.setImpl(mResourcesImpl.newThemeImpl());
|
|
synchronized (mThemeRefs) {
|
|
cleanupThemeReferences();
|
|
mThemeRefs.add(new WeakReference<>(theme));
|
|
}
|
|
return 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. These attribute IDs must be sorted in
|
|
* ascending order.
|
|
* @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, @StyleableRes 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;
|
|
mResourcesImpl.getAssets().retrieveAttributes(parser, attrs, array.mData, array.mIndices);
|
|
|
|
array.mXml = parser;
|
|
|
|
return array;
|
|
}
|
|
|
|
/**
|
|
* Store the newly updated configuration.
|
|
*
|
|
* @deprecated See {@link android.content.Context#createConfigurationContext(Configuration)}.
|
|
*/
|
|
@Deprecated
|
|
public void updateConfiguration(Configuration config, DisplayMetrics metrics) {
|
|
updateConfiguration(config, metrics, null);
|
|
}
|
|
|
|
/**
|
|
* @hide
|
|
*/
|
|
public void updateConfiguration(Configuration config, DisplayMetrics metrics,
|
|
CompatibilityInfo compat) {
|
|
mResourcesImpl.updateConfiguration(config, metrics, compat);
|
|
}
|
|
|
|
/**
|
|
* Update the system resources configuration if they have previously
|
|
* been initialized.
|
|
*
|
|
* @hide
|
|
*/
|
|
@UnsupportedAppUsage
|
|
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());
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns the current display metrics that are in effect for this resource
|
|
* object. The returned object should be treated as read-only.
|
|
*
|
|
* <p>Note that the reported value may be different than the window this application is
|
|
* interested in.</p>
|
|
*
|
|
* <p>The best practices is to obtain metrics from
|
|
* {@link WindowManager#getCurrentWindowMetrics()} for window bounds. The value obtained from
|
|
* this API may be wrong if {@link Context#getResources()} is not from a {@code UiContext}.
|
|
* For example, use the {@link DisplayMetrics} obtained from {@link Application#getResources()}
|
|
* to build {@link android.app.Activity} UI elements especially when the
|
|
* {@link android.app.Activity} is in the multi-window mode or on the secondary {@link Display}.
|
|
* <p/>
|
|
*
|
|
* @return The resource's current display metrics.
|
|
*/
|
|
public DisplayMetrics getDisplayMetrics() {
|
|
return mResourcesImpl.getDisplayMetrics();
|
|
}
|
|
|
|
/** @hide */
|
|
@UnsupportedAppUsage(trackingBug = 176190631)
|
|
public DisplayAdjustments getDisplayAdjustments() {
|
|
return mResourcesImpl.getDisplayAdjustments();
|
|
}
|
|
|
|
/**
|
|
* Return {@code true} if the override display adjustments have been set.
|
|
* @hide
|
|
*/
|
|
public boolean hasOverrideDisplayAdjustments() {
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* 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 mResourcesImpl.getConfiguration();
|
|
}
|
|
|
|
/** @hide */
|
|
public Configuration[] getSizeConfigurations() {
|
|
return mResourcesImpl.getSizeConfigurations();
|
|
}
|
|
|
|
/** @hide */
|
|
public Configuration[] getSizeAndUiModeConfigurations() {
|
|
return mResourcesImpl.getSizeAndUiModeConfigurations();
|
|
}
|
|
|
|
/**
|
|
* Return the compatibility mode information for the application.
|
|
* The returned object should be treated as read-only.
|
|
*
|
|
* @return compatibility info.
|
|
* @hide
|
|
*/
|
|
@UnsupportedAppUsage
|
|
public CompatibilityInfo getCompatibilityInfo() {
|
|
return mResourcesImpl.getCompatibilityInfo();
|
|
}
|
|
|
|
/**
|
|
* This is just for testing.
|
|
* @hide
|
|
*/
|
|
@VisibleForTesting
|
|
@UnsupportedAppUsage
|
|
public void setCompatibilityInfo(CompatibilityInfo ci) {
|
|
if (ci != null) {
|
|
mResourcesImpl.updateConfiguration(null, null, ci);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* <p>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.)
|
|
*/
|
|
@Discouraged(message = "Use of this function is discouraged because resource reflection makes "
|
|
+ "it harder to perform build optimizations and compile-time "
|
|
+ "verification of code. It is much more efficient to retrieve "
|
|
+ "resources by identifier (e.g. `R.foo.bar`) than by name (e.g. "
|
|
+ "`getIdentifier(\"bar\", \"foo\", null)`).")
|
|
public int getIdentifier(String name, String defType, String defPackage) {
|
|
return mResourcesImpl.getIdentifier(name, defType, defPackage);
|
|
}
|
|
|
|
/**
|
|
* Return true if given resource identifier includes a package.
|
|
*
|
|
* @hide
|
|
*/
|
|
public static boolean resourceHasPackage(@AnyRes 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(@AnyRes int resid) throws NotFoundException {
|
|
return mResourcesImpl.getResourceName(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(@AnyRes int resid) throws NotFoundException {
|
|
return mResourcesImpl.getResourcePackageName(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(@AnyRes int resid) throws NotFoundException {
|
|
return mResourcesImpl.getResourceTypeName(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(@AnyRes int resid) throws NotFoundException {
|
|
return mResourcesImpl.getResourceEntryName(resid);
|
|
}
|
|
|
|
/**
|
|
* Return formatted log of the last retrieved resource's resolution path.
|
|
*
|
|
* @return A string holding a formatted log of the steps taken to resolve the last resource.
|
|
*
|
|
* @throws NotFoundException Throws NotFoundException if there hasn't been a resource
|
|
* resolved yet.
|
|
*
|
|
* @hide
|
|
*/
|
|
public String getLastResourceResolution() throws NotFoundException {
|
|
return mResourcesImpl.getLastResourceResolution();
|
|
}
|
|
|
|
/**
|
|
* 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:
|
|
* <ul>
|
|
* <li> {@link TypedValue#TYPE_STRING}:
|
|
* {@link Bundle#putCharSequence Bundle.putCharSequence()}
|
|
* <li> {@link TypedValue#TYPE_INT_BOOLEAN}:
|
|
* {@link Bundle#putCharSequence Bundle.putBoolean()}
|
|
* <li> {@link TypedValue#TYPE_FIRST_INT}-{@link TypedValue#TYPE_LAST_INT}:
|
|
* {@link Bundle#putCharSequence Bundle.putBoolean()}
|
|
* <li> {@link TypedValue#TYPE_FLOAT}:
|
|
* {@link Bundle#putCharSequence Bundle.putFloat()}
|
|
* </ul>
|
|
*
|
|
* @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 mResourcesImpl.getAssets();
|
|
}
|
|
|
|
/**
|
|
* 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() {
|
|
mResourcesImpl.flushLayoutCache();
|
|
}
|
|
|
|
/**
|
|
* Start preloading of resource data using this Resources object. Only
|
|
* for use by the zygote process for loading common system resources.
|
|
* {@hide}
|
|
*/
|
|
public final void startPreloading() {
|
|
mResourcesImpl.startPreloading();
|
|
}
|
|
|
|
/**
|
|
* Called by zygote when it is done preloading resources, to change back
|
|
* to normal Resources operation.
|
|
*/
|
|
public final void finishPreloading() {
|
|
mResourcesImpl.finishPreloading();
|
|
}
|
|
|
|
/**
|
|
* @hide
|
|
*/
|
|
@UnsupportedAppUsage
|
|
public LongSparseArray<ConstantState> getPreloadedDrawables() {
|
|
return mResourcesImpl.getPreloadedDrawables();
|
|
}
|
|
|
|
/**
|
|
* Loads an XML parser for the specified file.
|
|
*
|
|
* @param id the resource identifier for the file
|
|
* @param type the type of resource (used for logging)
|
|
* @return a parser for the specified XML file
|
|
* @throws NotFoundException if the file could not be loaded
|
|
*/
|
|
@NonNull
|
|
@UnsupportedAppUsage
|
|
XmlResourceParser loadXmlResourceParser(@AnyRes int id, @NonNull String type)
|
|
throws NotFoundException {
|
|
final TypedValue value = obtainTempTypedValue();
|
|
try {
|
|
final ResourcesImpl impl = mResourcesImpl;
|
|
impl.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");
|
|
} finally {
|
|
releaseTempTypedValue(value);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Loads an XML parser for the specified file.
|
|
*
|
|
* @param file the path for the XML file to parse
|
|
* @param id the resource identifier for the file
|
|
* @param assetCookie the asset cookie for the file
|
|
* @param type the type of resource (used for logging)
|
|
* @return a parser for the specified XML file
|
|
* @throws NotFoundException if the file could not be loaded
|
|
*/
|
|
@NonNull
|
|
@UnsupportedAppUsage
|
|
XmlResourceParser loadXmlResourceParser(String file, int id, int assetCookie,
|
|
String type) throws NotFoundException {
|
|
return mResourcesImpl.loadXmlResourceParser(file, id, assetCookie, type);
|
|
}
|
|
|
|
/**
|
|
* Called by ConfigurationBoundResourceCacheTest.
|
|
* @hide
|
|
*/
|
|
@VisibleForTesting
|
|
public int calcConfigChanges(Configuration config) {
|
|
return mResourcesImpl.calcConfigChanges(config);
|
|
}
|
|
|
|
/**
|
|
* Obtains styled attributes from the theme, if available, or unstyled
|
|
* resources if the theme is null.
|
|
*
|
|
* @hide
|
|
*/
|
|
public static TypedArray obtainAttributes(
|
|
Resources res, Theme theme, AttributeSet set, int[] attrs) {
|
|
if (theme == null) {
|
|
return res.obtainAttributes(set, attrs);
|
|
}
|
|
return theme.obtainStyledAttributes(set, attrs, 0, 0);
|
|
}
|
|
|
|
private void checkCallbacksRegistered() {
|
|
if (mCallbacks == null) {
|
|
// Fallback to updating the underlying AssetManager if the Resources is not associated
|
|
// with a ResourcesManager.
|
|
mCallbacks = new AssetManagerUpdateHandler();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Retrieves the list of loaders.
|
|
*
|
|
* <p>Loaders are listed in increasing precedence order. A loader will override the resources
|
|
* and assets of loaders listed before itself.
|
|
* @hide
|
|
*/
|
|
@NonNull
|
|
public List<ResourcesLoader> getLoaders() {
|
|
return mResourcesImpl.getAssets().getLoaders();
|
|
}
|
|
|
|
/**
|
|
* Adds a loader to the list of loaders. If the loader is already present in the list, the list
|
|
* will not be modified.
|
|
*
|
|
* <p>This should only be called from the UI thread to avoid lock contention when propagating
|
|
* loader changes.
|
|
*
|
|
* @param loaders the loaders to add
|
|
*/
|
|
public void addLoaders(@NonNull ResourcesLoader... loaders) {
|
|
synchronized (mUpdateLock) {
|
|
checkCallbacksRegistered();
|
|
final List<ResourcesLoader> newLoaders =
|
|
new ArrayList<>(mResourcesImpl.getAssets().getLoaders());
|
|
final ArraySet<ResourcesLoader> loaderSet = new ArraySet<>(newLoaders);
|
|
|
|
for (int i = 0; i < loaders.length; i++) {
|
|
final ResourcesLoader loader = loaders[i];
|
|
if (!loaderSet.contains(loader)) {
|
|
newLoaders.add(loader);
|
|
}
|
|
}
|
|
|
|
if (loaderSet.size() == newLoaders.size()) {
|
|
return;
|
|
}
|
|
|
|
mCallbacks.onLoadersChanged(this, newLoaders);
|
|
for (int i = loaderSet.size(), n = newLoaders.size(); i < n; i++) {
|
|
newLoaders.get(i).registerOnProvidersChangedCallback(this, mCallbacks);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Removes loaders from the list of loaders. If the loader is not present in the list, the list
|
|
* will not be modified.
|
|
*
|
|
* <p>This should only be called from the UI thread to avoid lock contention when propagating
|
|
* loader changes.
|
|
*
|
|
* @param loaders the loaders to remove
|
|
*/
|
|
public void removeLoaders(@NonNull ResourcesLoader... loaders) {
|
|
synchronized (mUpdateLock) {
|
|
checkCallbacksRegistered();
|
|
final ArraySet<ResourcesLoader> removedLoaders = new ArraySet<>(loaders);
|
|
final List<ResourcesLoader> newLoaders = new ArrayList<>();
|
|
final List<ResourcesLoader> oldLoaders = mResourcesImpl.getAssets().getLoaders();
|
|
|
|
for (int i = 0, n = oldLoaders.size(); i < n; i++) {
|
|
final ResourcesLoader loader = oldLoaders.get(i);
|
|
if (!removedLoaders.contains(loader)) {
|
|
newLoaders.add(loader);
|
|
}
|
|
}
|
|
|
|
if (oldLoaders.size() == newLoaders.size()) {
|
|
return;
|
|
}
|
|
|
|
mCallbacks.onLoadersChanged(this, newLoaders);
|
|
for (int i = 0; i < loaders.length; i++) {
|
|
loaders[i].unregisterOnProvidersChangedCallback(this);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Removes all {@link ResourcesLoader ResourcesLoader(s)}.
|
|
*
|
|
* <p>This should only be called from the UI thread to avoid lock contention when propagating
|
|
* loader changes.
|
|
* @hide
|
|
*/
|
|
@VisibleForTesting
|
|
public void clearLoaders() {
|
|
synchronized (mUpdateLock) {
|
|
checkCallbacksRegistered();
|
|
final List<ResourcesLoader> newLoaders = Collections.emptyList();
|
|
final List<ResourcesLoader> oldLoaders = mResourcesImpl.getAssets().getLoaders();
|
|
mCallbacks.onLoadersChanged(this, newLoaders);
|
|
for (ResourcesLoader loader : oldLoaders) {
|
|
loader.unregisterOnProvidersChangedCallback(this);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Load in commonly used resources, so they can be shared across processes.
|
|
*
|
|
* These tend to be a few Kbytes, but are frequently in the 20-40K range, and occasionally even
|
|
* larger.
|
|
* @hide
|
|
*/
|
|
@UnsupportedAppUsage
|
|
public static void preloadResources() {
|
|
try {
|
|
final Resources sysRes = Resources.getSystem();
|
|
sysRes.startPreloading();
|
|
if (PRELOAD_RESOURCES) {
|
|
Log.i(TAG, "Preloading resources...");
|
|
|
|
long startTime = SystemClock.uptimeMillis();
|
|
TypedArray ar = sysRes.obtainTypedArray(
|
|
com.android.internal.R.array.preloaded_drawables);
|
|
int numberOfEntries = preloadDrawables(sysRes, ar);
|
|
ar.recycle();
|
|
Log.i(TAG, "...preloaded " + numberOfEntries + " resources in "
|
|
+ (SystemClock.uptimeMillis() - startTime) + "ms.");
|
|
|
|
startTime = SystemClock.uptimeMillis();
|
|
ar = sysRes.obtainTypedArray(
|
|
com.android.internal.R.array.preloaded_color_state_lists);
|
|
numberOfEntries = preloadColorStateLists(sysRes, ar);
|
|
ar.recycle();
|
|
Log.i(TAG, "...preloaded " + numberOfEntries + " resources in "
|
|
+ (SystemClock.uptimeMillis() - startTime) + "ms.");
|
|
|
|
if (sysRes.getBoolean(
|
|
com.android.internal.R.bool.config_freeformWindowManagement)) {
|
|
startTime = SystemClock.uptimeMillis();
|
|
ar = sysRes.obtainTypedArray(
|
|
com.android.internal.R.array.preloaded_freeform_multi_window_drawables);
|
|
numberOfEntries = preloadDrawables(sysRes, ar);
|
|
ar.recycle();
|
|
Log.i(TAG, "...preloaded " + numberOfEntries + " resource in "
|
|
+ (SystemClock.uptimeMillis() - startTime) + "ms.");
|
|
}
|
|
}
|
|
sysRes.finishPreloading();
|
|
} catch (RuntimeException e) {
|
|
Log.w(TAG, "Failure preloading resources", e);
|
|
}
|
|
}
|
|
|
|
private static int preloadColorStateLists(Resources resources, TypedArray ar) {
|
|
final int numberOfEntries = ar.length();
|
|
for (int i = 0; i < numberOfEntries; i++) {
|
|
int id = ar.getResourceId(i, 0);
|
|
|
|
if (id != 0) {
|
|
if (resources.getColorStateList(id, null) == null) {
|
|
throw new IllegalArgumentException(
|
|
"Unable to find preloaded color resource #0x"
|
|
+ Integer.toHexString(id)
|
|
+ " (" + ar.getString(i) + ")");
|
|
}
|
|
}
|
|
}
|
|
return numberOfEntries;
|
|
}
|
|
|
|
private static int preloadDrawables(Resources resources, TypedArray ar) {
|
|
final int numberOfEntries = ar.length();
|
|
for (int i = 0; i < numberOfEntries; i++) {
|
|
int id = ar.getResourceId(i, 0);
|
|
|
|
if (id != 0) {
|
|
if (resources.getDrawable(id, null) == null) {
|
|
throw new IllegalArgumentException(
|
|
"Unable to find preloaded drawable resource #0x"
|
|
+ Integer.toHexString(id)
|
|
+ " (" + ar.getString(i) + ")");
|
|
}
|
|
}
|
|
}
|
|
return numberOfEntries;
|
|
}
|
|
|
|
/**
|
|
* Clear the cache when the framework resources packages is changed.
|
|
* @hide
|
|
*/
|
|
@VisibleForTesting
|
|
public static void resetPreloadDrawableStateCache() {
|
|
ResourcesImpl.resetDrawableStateCache();
|
|
preloadResources();
|
|
}
|
|
|
|
/** @hide */
|
|
public void dump(PrintWriter pw, String prefix) {
|
|
pw.println(prefix + "class=" + getClass());
|
|
pw.println(prefix + "resourcesImpl");
|
|
final var impl = mResourcesImpl;
|
|
if (impl != null) {
|
|
impl.dump(pw, prefix + " ");
|
|
} else {
|
|
pw.println(prefix + " " + "null");
|
|
}
|
|
}
|
|
|
|
/** @hide */
|
|
public static void dumpHistory(PrintWriter pw, String prefix) {
|
|
pw.println(prefix + "history");
|
|
// Putting into a map keyed on the apk assets to deduplicate resources that are different
|
|
// objects but ultimately represent the same assets
|
|
ArrayMap<List<ApkAssets>, Resources> history = new ArrayMap<>();
|
|
sResourcesHistory.forEach(
|
|
r -> {
|
|
if (r != null) {
|
|
final var impl = r.mResourcesImpl;
|
|
if (impl != null) {
|
|
history.put(Arrays.asList(impl.mAssets.getApkAssets()), r);
|
|
} else {
|
|
history.put(null, r);
|
|
}
|
|
}
|
|
});
|
|
int i = 0;
|
|
for (Resources r : history.values()) {
|
|
pw.println(prefix + i++);
|
|
r.dump(pw, prefix + " ");
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Register the resources paths of a package (e.g. a shared library). This will collect the
|
|
* package resources' paths from its ApplicationInfo and add them to all existing and future
|
|
* contexts while the application is running.
|
|
* A second call with the same uniqueId is a no-op.
|
|
* The paths are not persisted during application restarts. The application is responsible for
|
|
* calling the API again if this happens.
|
|
*
|
|
* @param uniqueId The unique id for the ApplicationInfo object, to detect and ignore repeated
|
|
* API calls.
|
|
* @param appInfo The ApplicationInfo that contains resources paths of the package.
|
|
*/
|
|
@FlaggedApi(android.content.res.Flags.FLAG_REGISTER_RESOURCE_PATHS)
|
|
public static void registerResourcePaths(@NonNull String uniqueId,
|
|
@NonNull ApplicationInfo appInfo) {
|
|
if (Flags.registerResourcePaths()) {
|
|
ResourcesManager.getInstance().registerResourcePaths(uniqueId, appInfo);
|
|
} else {
|
|
throw new UnsupportedOperationException("Flag " + Flags.FLAG_REGISTER_RESOURCE_PATHS
|
|
+ " is disabled.");
|
|
}
|
|
}
|
|
}
|