/* * Copyright (C) 2008 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 com.android.SdkConstants; import com.android.ide.common.rendering.api.ArrayResourceValue; import com.android.ide.common.rendering.api.LayoutLog; import com.android.ide.common.rendering.api.LayoutlibCallback; import com.android.ide.common.rendering.api.ResourceValue; import com.android.layoutlib.bridge.Bridge; import com.android.layoutlib.bridge.BridgeConstants; import com.android.layoutlib.bridge.android.BridgeContext; import com.android.layoutlib.bridge.android.BridgeXmlBlockParser; import com.android.layoutlib.bridge.impl.ParserFactory; import com.android.layoutlib.bridge.impl.ResourceHelper; import com.android.ninepatch.NinePatch; import com.android.resources.ResourceType; import com.android.util.Pair; import org.xmlpull.v1.XmlPullParser; import org.xmlpull.v1.XmlPullParserException; import android.annotation.NonNull; import android.annotation.Nullable; import android.graphics.drawable.Drawable; import android.util.AttributeSet; import android.util.DisplayMetrics; import android.util.TypedValue; import android.view.ViewGroup.LayoutParams; import java.io.File; import java.io.FileInputStream; import java.io.FileNotFoundException; import java.io.InputStream; import java.util.Iterator; /** * */ public final class BridgeResources extends Resources { private BridgeContext mContext; private LayoutlibCallback mLayoutlibCallback; private boolean[] mPlatformResourceFlag = new boolean[1]; private TypedValue mTmpValue = new TypedValue(); /** * Simpler wrapper around FileInputStream. This is used when the input stream represent * not a normal bitmap but a nine patch. * This is useful when the InputStream is created in a method but used in another that needs * to know whether this is 9-patch or not, such as BitmapFactory. */ public class NinePatchInputStream extends FileInputStream { private boolean mFakeMarkSupport = true; public NinePatchInputStream(File file) throws FileNotFoundException { super(file); } @Override public boolean markSupported() { if (mFakeMarkSupport) { // this is needed so that BitmapFactory doesn't wrap this in a BufferedInputStream. return true; } return super.markSupported(); } public void disableFakeMarkSupport() { // disable fake mark support so that in case codec actually try to use them // we don't lie to them. mFakeMarkSupport = false; } } /** * This initializes the static field {@link Resources#mSystem} which is used * by methods who get global resources using {@link Resources#getSystem()}. *

* They will end up using our bridge resources. *

* {@link Bridge} calls this method after setting up a new bridge. */ public static Resources initSystem(BridgeContext context, AssetManager assets, DisplayMetrics metrics, Configuration config, LayoutlibCallback layoutlibCallback) { return Resources.mSystem = new BridgeResources(context, assets, metrics, config, layoutlibCallback); } /** * Disposes the static {@link Resources#mSystem} to make sure we don't leave objects * around that would prevent us from unloading the library. */ public static void disposeSystem() { if (Resources.mSystem instanceof BridgeResources) { ((BridgeResources)(Resources.mSystem)).mContext = null; ((BridgeResources)(Resources.mSystem)).mLayoutlibCallback = null; } Resources.mSystem = null; } private BridgeResources(BridgeContext context, AssetManager assets, DisplayMetrics metrics, Configuration config, LayoutlibCallback layoutlibCallback) { super(assets, metrics, config); mContext = context; mLayoutlibCallback = layoutlibCallback; } public BridgeTypedArray newTypeArray(int numEntries, boolean platformFile) { return new BridgeTypedArray(this, mContext, numEntries, platformFile); } private Pair getResourceValue(int id, boolean[] platformResFlag_out) { // first get the String related to this id in the framework Pair resourceInfo = Bridge.resolveResourceId(id); if (resourceInfo != null) { platformResFlag_out[0] = true; String attributeName = resourceInfo.getSecond(); return Pair.of(attributeName, mContext.getRenderResources().getFrameworkResource( resourceInfo.getFirst(), attributeName)); } // didn't find a match in the framework? look in the project. if (mLayoutlibCallback != null) { resourceInfo = mLayoutlibCallback.resolveResourceId(id); if (resourceInfo != null) { platformResFlag_out[0] = false; String attributeName = resourceInfo.getSecond(); return Pair.of(attributeName, mContext.getRenderResources().getProjectResource( resourceInfo.getFirst(), attributeName)); } } return null; } @Override public Drawable getDrawable(int id, Theme theme) { Pair value = getResourceValue(id, mPlatformResourceFlag); if (value != null) { return ResourceHelper.getDrawable(value.getSecond(), mContext, theme); } // id was not found or not resolved. Throw a NotFoundException. throwException(id); // this is not used since the method above always throws return null; } @Override public int getColor(int id, Theme theme) throws NotFoundException { Pair value = getResourceValue(id, mPlatformResourceFlag); if (value != null) { ResourceValue resourceValue = value.getSecond(); try { return ResourceHelper.getColor(resourceValue.getValue()); } catch (NumberFormatException e) { // Check if the value passed is a file. If it is, mostly likely, user is referencing // a color state list from a place where they should reference only a pure color. String message; if (new File(resourceValue.getValue()).isFile()) { String resource = (resourceValue.isFramework() ? "@android:" : "@") + "color/" + resourceValue.getName(); message = "Hexadecimal color expected, found Color State List for " + resource; } else { message = e.getMessage(); } Bridge.getLog().error(LayoutLog.TAG_RESOURCES_FORMAT, message, e, null); return 0; } } // Suppress possible NPE. getColorStateList will never return null, it will instead // throw an exception, but intelliJ can't figure that out //noinspection ConstantConditions return getColorStateList(id, theme).getDefaultColor(); } @Override public ColorStateList getColorStateList(int id, Theme theme) throws NotFoundException { Pair resValue = getResourceValue(id, mPlatformResourceFlag); if (resValue != null) { ColorStateList stateList = ResourceHelper.getColorStateList(resValue.getSecond(), mContext); if (stateList != null) { return stateList.obtainForTheme(theme); } } // id was not found or not resolved. Throw a NotFoundException. throwException(id); // this is not used since the method above always throws return null; } @Override public CharSequence getText(int id) throws NotFoundException { Pair value = getResourceValue(id, mPlatformResourceFlag); if (value != null) { ResourceValue resValue = value.getSecond(); assert resValue != null; if (resValue != null) { String v = resValue.getValue(); if (v != null) { return v; } } } // id was not found or not resolved. Throw a NotFoundException. throwException(id); // this is not used since the method above always throws return null; } @Override public CharSequence[] getTextArray(int id) throws NotFoundException { ResourceValue resValue = getArrayResourceValue(id); if (resValue == null) { // Error already logged by getArrayResourceValue. return new CharSequence[0]; } else if (!(resValue instanceof ArrayResourceValue)) { return new CharSequence[]{ resolveReference(resValue.getValue(), resValue.isFramework())}; } ArrayResourceValue arv = ((ArrayResourceValue) resValue); return fillValues(arv, new CharSequence[arv.getElementCount()]); } @Override public String[] getStringArray(int id) throws NotFoundException { ResourceValue resValue = getArrayResourceValue(id); if (resValue == null) { // Error already logged by getArrayResourceValue. return new String[0]; } else if (!(resValue instanceof ArrayResourceValue)) { return new String[]{ resolveReference(resValue.getValue(), resValue.isFramework())}; } ArrayResourceValue arv = ((ArrayResourceValue) resValue); return fillValues(arv, new String[arv.getElementCount()]); } /** * Resolve each element in resValue and copy them to {@code values}. The values copied are * always Strings. The ideal signature for the method should be <T super String>, but java * generics don't support it. */ private T[] fillValues(ArrayResourceValue resValue, T[] values) { int i = 0; for (Iterator iterator = resValue.iterator(); iterator.hasNext(); i++) { @SuppressWarnings("unchecked") T s = (T) resolveReference(iterator.next(), resValue.isFramework()); values[i] = s; } return values; } @Override public int[] getIntArray(int id) throws NotFoundException { ResourceValue rv = getArrayResourceValue(id); if (rv == null) { // Error already logged by getArrayResourceValue. return new int[0]; } else if (!(rv instanceof ArrayResourceValue)) { // This is an older IDE that can only give us the first element of the array. String firstValue = resolveReference(rv.getValue(), rv.isFramework()); try { return new int[]{getInt(firstValue)}; } catch (NumberFormatException e) { Bridge.getLog().error(LayoutLog.TAG_RESOURCES_FORMAT, "Integer resource array contains non-integer value: " + firstValue, null); return new int[1]; } } ArrayResourceValue resValue = ((ArrayResourceValue) rv); int[] values = new int[resValue.getElementCount()]; int i = 0; for (Iterator iterator = resValue.iterator(); iterator.hasNext(); i++) { String element = resolveReference(iterator.next(), resValue.isFramework()); try { values[i] = getInt(element); } catch (NumberFormatException e) { Bridge.getLog().error(LayoutLog.TAG_RESOURCES_FORMAT, "Integer resource array contains non-integer value: " + element, null); } } return values; } /** * Try to find the ArrayResourceValue for the given id. *

* If the ResourceValue found is not of type {@link ResourceType#ARRAY}, the method logs an * error and return null. However, if the ResourceValue found has type {@code * ResourceType.ARRAY}, but the value is not an instance of {@link ArrayResourceValue}, the * method returns the ResourceValue. This happens on older versions of the IDE, which did not * parse the array resources properly. *

* @throws NotFoundException if no resource if found */ @Nullable private ResourceValue getArrayResourceValue(int id) throws NotFoundException { Pair v = getResourceValue(id, mPlatformResourceFlag); if (v != null) { ResourceValue resValue = v.getSecond(); assert resValue != null; if (resValue != null) { final ResourceType type = resValue.getResourceType(); if (type != ResourceType.ARRAY) { Bridge.getLog().error(LayoutLog.TAG_RESOURCES_RESOLVE, String.format( "Resource with id 0x%1$X is not an array resource, but %2$s", id, type == null ? "null" : type.getDisplayName()), null); return null; } if (!(resValue instanceof ArrayResourceValue)) { Bridge.getLog().warning(LayoutLog.TAG_UNSUPPORTED, "Obtaining resource arrays via getTextArray, getStringArray or getIntArray is not fully supported in this version of the IDE.", null); } return resValue; } } // id was not found or not resolved. Throw a NotFoundException. throwException(id); // this is not used since the method above always throws return null; } @NonNull private String resolveReference(@NonNull String ref, boolean forceFrameworkOnly) { if (ref.startsWith(SdkConstants.PREFIX_RESOURCE_REF) || ref.startsWith (SdkConstants.PREFIX_THEME_REF)) { ResourceValue rv = mContext.getRenderResources().findResValue(ref, forceFrameworkOnly); rv = mContext.getRenderResources().resolveResValue(rv); if (rv != null) { return rv.getValue(); } else { Bridge.getLog().error(LayoutLog.TAG_RESOURCES_RESOLVE, "Unable to resolve resource " + ref, null); } } // Not a reference. return ref; } @Override public XmlResourceParser getLayout(int id) throws NotFoundException { Pair v = getResourceValue(id, mPlatformResourceFlag); if (v != null) { ResourceValue value = v.getSecond(); XmlPullParser parser = null; try { // check if the current parser can provide us with a custom parser. if (mPlatformResourceFlag[0] == false) { parser = mLayoutlibCallback.getParser(value); } // create a new one manually if needed. if (parser == null) { File xml = new File(value.getValue()); if (xml.isFile()) { // we need to create a pull parser around the layout XML file, and then // give that to our XmlBlockParser parser = ParserFactory.create(xml); } } if (parser != null) { return new BridgeXmlBlockParser(parser, mContext, mPlatformResourceFlag[0]); } } catch (XmlPullParserException e) { Bridge.getLog().error(LayoutLog.TAG_BROKEN, "Failed to configure parser for " + value.getValue(), e, null /*data*/); // we'll return null below. } catch (FileNotFoundException e) { // this shouldn't happen since we check above. } } // id was not found or not resolved. Throw a NotFoundException. throwException(id); // this is not used since the method above always throws return null; } @Override public XmlResourceParser getAnimation(int id) throws NotFoundException { Pair v = getResourceValue(id, mPlatformResourceFlag); if (v != null) { ResourceValue value = v.getSecond(); XmlPullParser parser = null; try { File xml = new File(value.getValue()); if (xml.isFile()) { // we need to create a pull parser around the layout XML file, and then // give that to our XmlBlockParser parser = ParserFactory.create(xml); return new BridgeXmlBlockParser(parser, mContext, mPlatformResourceFlag[0]); } } catch (XmlPullParserException e) { Bridge.getLog().error(LayoutLog.TAG_BROKEN, "Failed to configure parser for " + value.getValue(), e, null /*data*/); // we'll return null below. } catch (FileNotFoundException e) { // this shouldn't happen since we check above. } } // id was not found or not resolved. Throw a NotFoundException. throwException(id); // this is not used since the method above always throws return null; } @Override public TypedArray obtainAttributes(AttributeSet set, int[] attrs) { return mContext.obtainStyledAttributes(set, attrs); } @Override public TypedArray obtainTypedArray(int id) throws NotFoundException { throw new UnsupportedOperationException(); } @Override public float getDimension(int id) throws NotFoundException { Pair value = getResourceValue(id, mPlatformResourceFlag); if (value != null) { ResourceValue resValue = value.getSecond(); assert resValue != null; if (resValue != null) { String v = resValue.getValue(); if (v != null) { if (v.equals(BridgeConstants.MATCH_PARENT) || v.equals(BridgeConstants.FILL_PARENT)) { return LayoutParams.MATCH_PARENT; } else if (v.equals(BridgeConstants.WRAP_CONTENT)) { return LayoutParams.WRAP_CONTENT; } if (ResourceHelper.parseFloatAttribute( value.getFirst(), v, mTmpValue, true /*requireUnit*/) && mTmpValue.type == TypedValue.TYPE_DIMENSION) { return mTmpValue.getDimension(getDisplayMetrics()); } } } } // id was not found or not resolved. Throw a NotFoundException. throwException(id); // this is not used since the method above always throws return 0; } @Override public int getDimensionPixelOffset(int id) throws NotFoundException { Pair value = getResourceValue(id, mPlatformResourceFlag); if (value != null) { ResourceValue resValue = value.getSecond(); assert resValue != null; if (resValue != null) { String v = resValue.getValue(); if (v != null) { if (ResourceHelper.parseFloatAttribute( value.getFirst(), v, mTmpValue, true /*requireUnit*/) && mTmpValue.type == TypedValue.TYPE_DIMENSION) { return TypedValue.complexToDimensionPixelOffset(mTmpValue.data, getDisplayMetrics()); } } } } // id was not found or not resolved. Throw a NotFoundException. throwException(id); // this is not used since the method above always throws return 0; } @Override public int getDimensionPixelSize(int id) throws NotFoundException { Pair value = getResourceValue(id, mPlatformResourceFlag); if (value != null) { ResourceValue resValue = value.getSecond(); assert resValue != null; if (resValue != null) { String v = resValue.getValue(); if (v != null) { if (ResourceHelper.parseFloatAttribute( value.getFirst(), v, mTmpValue, true /*requireUnit*/) && mTmpValue.type == TypedValue.TYPE_DIMENSION) { return TypedValue.complexToDimensionPixelSize(mTmpValue.data, getDisplayMetrics()); } } } } // id was not found or not resolved. Throw a NotFoundException. throwException(id); // this is not used since the method above always throws return 0; } @Override public int getInteger(int id) throws NotFoundException { Pair value = getResourceValue(id, mPlatformResourceFlag); if (value != null) { ResourceValue resValue = value.getSecond(); assert resValue != null; if (resValue != null) { String v = resValue.getValue(); if (v != null) { try { return getInt(v); } catch (NumberFormatException e) { // return exception below } } } } // id was not found or not resolved. Throw a NotFoundException. throwException(id); // this is not used since the method above always throws return 0; } @Override public boolean getBoolean(int id) throws NotFoundException { Pair value = getResourceValue(id, mPlatformResourceFlag); if (value != null) { ResourceValue resValue = value.getSecond(); assert resValue != null; if (resValue != null) { String v = resValue.getValue(); if (v != null) { return Boolean.parseBoolean(v); } } } // id was not found or not resolved. Throw a NotFoundException. throwException(id); // this is not used since the method above always throws return false; } @Override public String getResourceEntryName(int resid) throws NotFoundException { throw new UnsupportedOperationException(); } @Override public String getResourceName(int resid) throws NotFoundException { throw new UnsupportedOperationException(); } @Override public String getResourceTypeName(int resid) throws NotFoundException { throw new UnsupportedOperationException(); } @Override public String getString(int id, Object... formatArgs) throws NotFoundException { String s = getString(id); if (s != null) { return String.format(s, formatArgs); } // id was not found or not resolved. Throw a NotFoundException. throwException(id); // this is not used since the method above always throws return null; } @Override public String getString(int id) throws NotFoundException { Pair value = getResourceValue(id, mPlatformResourceFlag); if (value != null && value.getSecond().getValue() != null) { return value.getSecond().getValue(); } // id was not found or not resolved. Throw a NotFoundException. throwException(id); // this is not used since the method above always throws return null; } @Override public void getValue(int id, TypedValue outValue, boolean resolveRefs) throws NotFoundException { Pair value = getResourceValue(id, mPlatformResourceFlag); if (value != null) { String v = value.getSecond().getValue(); if (v != null) { if (ResourceHelper.parseFloatAttribute(value.getFirst(), v, outValue, false /*requireUnit*/)) { return; } // else it's a string outValue.type = TypedValue.TYPE_STRING; outValue.string = v; return; } } // id was not found or not resolved. Throw a NotFoundException. throwException(id); } @Override public void getValue(String name, TypedValue outValue, boolean resolveRefs) throws NotFoundException { throw new UnsupportedOperationException(); } @Override public XmlResourceParser getXml(int id) throws NotFoundException { Pair value = getResourceValue(id, mPlatformResourceFlag); if (value != null) { String v = value.getSecond().getValue(); if (v != null) { // check this is a file File f = new File(v); if (f.isFile()) { try { XmlPullParser parser = ParserFactory.create(f); return new BridgeXmlBlockParser(parser, mContext, mPlatformResourceFlag[0]); } catch (XmlPullParserException e) { NotFoundException newE = new NotFoundException(); newE.initCause(e); throw newE; } catch (FileNotFoundException e) { NotFoundException newE = new NotFoundException(); newE.initCause(e); throw newE; } } } } // id was not found or not resolved. Throw a NotFoundException. throwException(id); // this is not used since the method above always throws return null; } @Override public XmlResourceParser loadXmlResourceParser(String file, int id, int assetCookie, String type) throws NotFoundException { // even though we know the XML file to load directly, we still need to resolve the // id so that we can know if it's a platform or project resource. // (mPlatformResouceFlag will get the result and will be used later). getResourceValue(id, mPlatformResourceFlag); File f = new File(file); try { XmlPullParser parser = ParserFactory.create(f); return new BridgeXmlBlockParser(parser, mContext, mPlatformResourceFlag[0]); } catch (XmlPullParserException e) { NotFoundException newE = new NotFoundException(); newE.initCause(e); throw newE; } catch (FileNotFoundException e) { NotFoundException newE = new NotFoundException(); newE.initCause(e); throw newE; } } @Override public InputStream openRawResource(int id) throws NotFoundException { Pair value = getResourceValue(id, mPlatformResourceFlag); if (value != null) { String path = value.getSecond().getValue(); if (path != null) { // check this is a file File f = new File(path); if (f.isFile()) { try { // if it's a nine-patch return a custom input stream so that // other methods (mainly bitmap factory) can detect it's a 9-patch // and actually load it as a 9-patch instead of a normal bitmap if (path.toLowerCase().endsWith(NinePatch.EXTENSION_9PATCH)) { return new NinePatchInputStream(f); } return new FileInputStream(f); } catch (FileNotFoundException e) { NotFoundException newE = new NotFoundException(); newE.initCause(e); throw newE; } } } } // id was not found or not resolved. Throw a NotFoundException. throwException(id); // this is not used since the method above always throws return null; } @Override public InputStream openRawResource(int id, TypedValue value) throws NotFoundException { getValue(id, value, true); String path = value.string.toString(); File f = new File(path); if (f.isFile()) { try { // if it's a nine-patch return a custom input stream so that // other methods (mainly bitmap factory) can detect it's a 9-patch // and actually load it as a 9-patch instead of a normal bitmap if (path.toLowerCase().endsWith(NinePatch.EXTENSION_9PATCH)) { return new NinePatchInputStream(f); } return new FileInputStream(f); } catch (FileNotFoundException e) { NotFoundException exception = new NotFoundException(); exception.initCause(e); throw exception; } } throw new NotFoundException(); } @Override public AssetFileDescriptor openRawResourceFd(int id) throws NotFoundException { throw new UnsupportedOperationException(); } /** * Builds and throws a {@link Resources.NotFoundException} based on a resource id and a resource type. * @param id the id of the resource * @throws NotFoundException */ private void throwException(int id) throws NotFoundException { // first get the String related to this id in the framework Pair resourceInfo = Bridge.resolveResourceId(id); // if the name is unknown in the framework, get it from the custom view loader. if (resourceInfo == null && mLayoutlibCallback != null) { resourceInfo = mLayoutlibCallback.resolveResourceId(id); } String message; if (resourceInfo != null) { message = String.format( "Could not find %1$s resource matching value 0x%2$X (resolved name: %3$s) in current configuration.", resourceInfo.getFirst(), id, resourceInfo.getSecond()); } else { message = String.format( "Could not resolve resource value: 0x%1$X.", id); } throw new NotFoundException(message); } private int getInt(String v) throws NumberFormatException { int radix = 10; if (v.startsWith("0x")) { v = v.substring(2); radix = 16; } else if (v.startsWith("0")) { radix = 8; } return Integer.parseInt(v, radix); } }