All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.robolectric.internal.bytecode.ShadowMap Maven / Gradle / Ivy

The newest version!
package org.robolectric.internal.bytecode;

import com.google.common.collect.ArrayListMultimap;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableListMultimap;
import com.google.common.collect.ImmutableMap;
import java.lang.reflect.InvocationTargetException;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.robolectric.annotation.Implements;
import org.robolectric.internal.ShadowProvider;
import org.robolectric.sandbox.ShadowMatcher;
import org.robolectric.shadow.api.ShadowPicker;
import org.robolectric.util.Logger;

/**
 * Maps from instrumented class to shadow class.
 *
 * 

We deal with class names rather than actual classes here, since a ShadowMap is built outside * of any sandboxes, but instrumented and shadowed classes must be loaded through a {@link * SandboxClassLoader}. We don't want to try to resolve those classes outside of a sandbox. * *

Once constructed, instances are immutable. */ @SuppressWarnings("NewApi") public class ShadowMap { static final ShadowMap EMPTY = new ShadowMap(ImmutableListMultimap.of(), ImmutableMap.of()); private final ImmutableListMultimap defaultShadows; private final ImmutableMap overriddenShadows; private final ImmutableMap shadowPickers; public static ShadowMap createFromShadowProviders(List sortedProviders) { final ArrayListMultimap shadowMap = ArrayListMultimap.create(); final Map shadowPickerMap = new HashMap<>(); // These are sorted in descending order (higher priority providers are first). for (ShadowProvider provider : sortedProviders) { Logger.debug("Shadow provider: " + provider.getClass().getName()); for (Map.Entry entry : provider.getShadows()) { shadowMap.put(entry.getKey(), entry.getValue()); } provider.getShadowPickerMap().forEach(shadowPickerMap::putIfAbsent); } return new ShadowMap( ImmutableListMultimap.copyOf(shadowMap), Collections.emptyMap(), ImmutableMap.copyOf(shadowPickerMap)); } ShadowMap( ImmutableListMultimap defaultShadows, Map overriddenShadows) { this(defaultShadows, overriddenShadows, Collections.emptyMap()); } private ShadowMap( ImmutableListMultimap defaultShadows, Map overriddenShadows, Map shadowPickers) { this.defaultShadows = ImmutableListMultimap.copyOf(defaultShadows); this.overriddenShadows = ImmutableMap.copyOf(overriddenShadows); this.shadowPickers = ImmutableMap.copyOf(shadowPickers); } public boolean hasShadowPicker(MutableClass mutableClass) { return shadowPickers.containsKey(mutableClass.getName()); } public ShadowInfo getShadowInfo(Class clazz, ShadowMatcher shadowMatcher) { String instrumentedClassName = clazz.getName(); ShadowInfo shadowInfo = overriddenShadows.get(instrumentedClassName); String shadowPickerClassName = null; if (shadowInfo != null && shadowInfo.hasShadowPicker()) { shadowPickerClassName = shadowInfo.getShadowPickerClass().getName(); } else if (shadowInfo == null) { shadowPickerClassName = shadowPickers.get(instrumentedClassName); } if (shadowPickerClassName != null) { shadowInfo = pickShadow(instrumentedClassName, clazz, shadowPickerClassName); } else if (shadowInfo == null) { try { final ImmutableList shadowNames = defaultShadows.get(clazz.getCanonicalName()); for (String shadowName : shadowNames) { if (shadowName != null) { Class shadowClass = clazz.getClassLoader().loadClass(shadowName); shadowInfo = obtainShadowInfo(shadowClass); if (!shadowInfo.shadowedClassName.equals(instrumentedClassName)) { // somehow we got the wrong shadow class? shadowInfo = null; } if (shadowInfo != null && shadowMatcher.matches(shadowInfo)) { return shadowInfo; } } } } catch (ClassNotFoundException | IncompatibleClassChangeError e) { return null; } } if (shadowInfo != null && !shadowMatcher.matches(shadowInfo)) { return null; } return shadowInfo; } private ShadowInfo pickShadow( String instrumentedClassName, Class clazz, String shadowPickerClassName) { ClassLoader sandboxClassLoader = clazz.getClassLoader(); try { Class> shadowPickerClass = (Class>) sandboxClassLoader.loadClass(shadowPickerClassName); ShadowPicker shadowPicker = shadowPickerClass.getDeclaredConstructor().newInstance(); Class selectedShadowClass = shadowPicker.pickShadowClass(); if (selectedShadowClass == null) { return obtainShadowInfo(Object.class, true); } ShadowInfo shadowInfo = obtainShadowInfo(selectedShadowClass); if (!shadowInfo.shadowedClassName.equals(instrumentedClassName)) { throw new IllegalArgumentException( "Implemented class for " + selectedShadowClass.getName() + " (" + shadowInfo.shadowedClassName + ") != " + instrumentedClassName); } return shadowInfo; } catch (ClassNotFoundException | NoSuchMethodException | InvocationTargetException | IllegalAccessException | InstantiationException e) { throw new RuntimeException("Failed to resolve shadow picker for " + instrumentedClassName, e); } } public static ShadowInfo obtainShadowInfo(Class clazz) { return obtainShadowInfo(clazz, false); } static ShadowInfo obtainShadowInfo(Class clazz, boolean mayBeNonShadow) { Implements annotation = clazz.getAnnotation(Implements.class); if (annotation == null) { if (mayBeNonShadow) { return null; } else { throw new IllegalArgumentException(clazz + " is not annotated with @Implements"); } } String className = annotation.className(); if (className.isEmpty()) { className = annotation.value().getName(); } return new ShadowInfo(className, clazz.getName(), annotation); } @SuppressWarnings("ReferenceEquality") public Set getInvalidatedClasses(ShadowMap previous) { if (this == previous && shadowPickers.isEmpty()) return Collections.emptySet(); Map invalidated = new HashMap<>(overriddenShadows); for (Map.Entry entry : previous.overriddenShadows.entrySet()) { String className = entry.getKey(); ShadowInfo previousConfig = entry.getValue(); ShadowInfo currentConfig = invalidated.get(className); if (currentConfig == null) { invalidated.put(className, previousConfig); } else if (previousConfig.equals(currentConfig)) { invalidated.remove(className); } } return invalidated.keySet(); } /** * @deprecated do not use */ @Deprecated public static String convertToShadowName(String className) { String shadowClassName = "org.robolectric.shadows.Shadow" + className.substring(className.lastIndexOf(".") + 1); shadowClassName = shadowClassName.replaceAll("\\$", "\\$Shadow"); return shadowClassName; } public Builder newBuilder() { return new Builder(this); } @Override public boolean equals(Object o) { if (this == o) return true; if (!(o instanceof ShadowMap)) return false; ShadowMap shadowMap = (ShadowMap) o; if (!overriddenShadows.equals(shadowMap.overriddenShadows)) return false; return true; } @Override public int hashCode() { return overriddenShadows.hashCode(); } public static class Builder { private final ImmutableListMultimap defaultShadows; private final Map overriddenShadows; private final Map shadowPickers; public Builder() { defaultShadows = ImmutableListMultimap.of(); overriddenShadows = new HashMap<>(); shadowPickers = new HashMap<>(); } public Builder(ShadowMap shadowMap) { this.defaultShadows = shadowMap.defaultShadows; this.overriddenShadows = new HashMap<>(shadowMap.overriddenShadows); this.shadowPickers = new HashMap<>(shadowMap.shadowPickers); } public Builder addShadowClasses(Class... shadowClasses) { for (Class shadowClass : shadowClasses) { addShadowClass(shadowClass); } return this; } Builder addShadowClass(Class shadowClass) { addShadowInfo(obtainShadowInfo(shadowClass)); return this; } Builder addShadowClass( String realClassName, String shadowClassName, boolean callThroughByDefault, boolean callNativeMethodsByDefault, boolean looseSignatures) { addShadowInfo( new ShadowInfo( realClassName, shadowClassName, callThroughByDefault, callNativeMethodsByDefault, looseSignatures, -1, -1, null)); return this; } private void addShadowInfo(ShadowInfo shadowInfo) { overriddenShadows.put(shadowInfo.shadowedClassName, shadowInfo); if (shadowInfo.hasShadowPicker()) { shadowPickers.put( shadowInfo.shadowedClassName, shadowInfo.getShadowPickerClass().getName()); } } public ShadowMap build() { return new ShadowMap(defaultShadows, overriddenShadows, shadowPickers); } } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy