azalea/kotlin-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Drop complicated MapAccessors. Deprecate simple cases of Delegates.mapVar and Delegates.mapVal in favor of direct delegation without wrappers.

Browse Source
This commit is contained in:
Ilya Gorbunov
2015-06-19 17:52:35 +03:00
parent d2feefbf3a
commit a6b7857d57
3 changed files with 22 additions and 121 deletions
Download Patch File Download Diff File Expand all files Collapse all files
libraries/stdlib/src/kotlin/properties/Delegation.kt
+22 -2
View File
@@ -54,6 +54,16 @@ public object Delegates {
return ObservableProperty<T>(initial, onChange)
}
/**
* Returns a property delegate for a read/write property that stores its value in a map, using the property name
* as a key.
* @param map the map where the property values are stored.
*/
deprecated("Delegate property to the map itself without creating a wrapper.", ReplaceWith("map"))
public fun mapVar<T>(map: MutableMap<in String, Any?>): ReadWriteProperty<Any?, T> {
return FixedMapVar<Any?, String, T>(map, propertyNameSelector, throwKeyNotFound)
}
/**
* Returns a property delegate for a read/write property that stores its value in a map, using the property name
* as a key.
@@ -61,10 +71,20 @@ public object Delegates {
* @param default the function returning the value of the property for a given object if it's missing from the given map.
*/
public fun mapVar<T>(map: MutableMap<in String, Any?>,
default: (thisRef: Any?, desc: String) -> T = throwKeyNotFound): ReadWriteProperty<Any?, T> {
default: (thisRef: Any?, desc: String) -> T): ReadWriteProperty<Any?, T> {
return FixedMapVar<Any?, String, T>(map, propertyNameSelector, default)
}
/**
* Returns a property delegate for a read-only property that takes its value from a map, using the property name
* as a key.
* @param map the map where the property values are stored.
*/
deprecated("Delegate property to the map itself without creating a wrapper.", ReplaceWith("map"))
public fun mapVal<T>(map: Map<in String, Any?>): ReadOnlyProperty<Any?, T> {
return FixedMapVal<Any?, String, T>(map, propertyNameSelector, throwKeyNotFound)
}
/**
* Returns a property delegate for a read-only property that takes its value from a map, using the property name
* as a key.
@@ -72,7 +92,7 @@ public object Delegates {
* @param default the function returning the value of the property for a given object if it's missing from the given map.
*/
public fun mapVal<T>(map: Map<in String, Any?>,
default: (thisRef: Any?, desc: String) -> T = throwKeyNotFound): ReadOnlyProperty<Any?, T> {
default: (thisRef: Any?, desc: String) -> T): ReadOnlyProperty<Any?, T> {
return FixedMapVal<Any?, String, T>(map, propertyNameSelector, default)
}
}
libraries/stdlib/src/kotlin/properties/MapAccessors.kt
-74
View File
@@ -35,77 +35,3 @@ public fun <V> MutableMap<in String, in V>.get(thisRef: Any?, property: Property
public fun <V> MutableMap<in String, in V>.set(thisRef: Any?, property: PropertyMetadata, value: V) {
this.put(property.name, value)
}
// Map accessors
public interface MapAccessor<KMap, in KAccess, out V>
{
public val map: Map<in KMap, V>
/** Returns `true` if the map contains the specified [key]. */
public fun containsKey(key: KAccess): Boolean
/** Returns the value corresponding to the given [key], or the default value if such a key is not present in the map. */
public fun getOrDefault(key: KAccess): V
public open fun withDefault<V>(default: (KMap) -> V): MapAccessor<KMap, KAccess, V>
}
public interface MutableMapAccessor<KMap, in KAccess, V>: MapAccessor<KMap, KAccess, V> {
public override val map: MutableMap<in KMap, V>
/** Associates the specified [value] with the specified [key] in the map. */
public fun put(key: KAccess, value: V): V?
public override fun <V> withDefault(default: (KMap) -> V): MutableMapAccessor<KMap, KAccess, V>
}
public fun <V> Map<in String, V>.forProperties(): MapAccessor<String, PropertyMetadata, V> = MapAccessorImpl(this, propertyNameSelector)
// todo: inline keyselector into anonymous object
public fun <K, V> Map<in K, V>.forProperties(keySelector: (PropertyMetadata) -> K): MapAccessor<K, PropertyMetadata, V> = MapAccessorImpl(this, keySelector)
public fun <V> MutableMap<in String, V>.forProperties(): MutableMapAccessor<String, PropertyMetadata, V> = MutableMapAccessorImpl(this, propertyNameSelector)
// todo: inline keyselector into anonymous object
public fun <K, V> MutableMap<in K, V>.forProperties(keySelector: (PropertyMetadata) -> K): MutableMapAccessor<K, PropertyMetadata, V> = MutableMapAccessorImpl(this, keySelector)
// extensions to delegate properties to MapAccessors
public fun <K, V> MapAccessor<K, PropertyMetadata, V>.get(thisRef: Any?, property: PropertyMetadata): V = this.getOrDefault(property)
platformName("getVar")
public fun <K, V> MutableMapAccessor<K, PropertyMetadata, in V>.get(thisRef: Any?, property: PropertyMetadata): V = this.getOrDefault(property) as V
public fun <K, V> MutableMapAccessor<K, PropertyMetadata, in V>.set(thisRef: Any?, property: PropertyMetadata, value: V) {
this.put(property, value)
}
// MapAccessor implementations
private open class MapAccessorImpl<KMap, in KAccess, out V>(public override val map: Map<in KMap, V>, public val transform: (KAccess) -> KMap, public val default: (KMap) -> V = { key -> throwKeyNotFound(map, key) })
: MapAccessor<KMap, KAccess, V> {
override fun containsKey(key: KAccess): Boolean = map.containsKey(transform(key))
override fun getOrDefault(key: KAccess): V = transform(key).let { map.getOrElse(it, { default(it) }) }
override fun withDefault<V>(default: (KMap) -> V): MapAccessor<KMap, KAccess, V> = MapAccessorImpl<KMap, KAccess, V>(map as Map<in KMap, V>, transform, default)
}
private class MutableMapAccessorImpl<KMap, in KAccess, V>(public override val map: MutableMap<in KMap, V>, transform: (KAccess) -> KMap, default: (KMap) -> V = { key -> throwKeyNotFound(map, key) })
: MapAccessorImpl<KMap, KAccess, V>(map, transform, default), MutableMapAccessor<KMap, KAccess, V> {
override fun put(key: KAccess, value: V): V? = map.put(transform(key), value)
override fun <V> withDefault(default: (KMap) -> V): MutableMapAccessor<KMap, KAccess, V> = MutableMapAccessorImpl<KMap, KAccess, V>(map as MutableMap<in KMap, V>, transform, default)
}
libraries/stdlib/test/properties/delegation/MapAccessorsTest.kt
-45
View File
@@ -64,48 +64,3 @@ class VarByMapExtensionsTest {
assertEquals(null, d)
}
}
class ValByMapAccessorExtensionsTest {
val map: Map<String, String> = mapOf("a" to "all", "b" to "bar", "c" to "code")
val genericMap = mapOf<String, Any?>("i" to 1, "x" to 1.0)
val mapAccessor = map.forProperties { it.name.take(1) }
val genericMapAccessor = genericMap.forProperties { it.name.take(1) }
val cProperty by mapAccessor
val xProperty by genericMapAccessor
val zNoDefault by genericMapAccessor
val zProperty by genericMapAccessor.withDefault { 1 }
test fun doTest() {
assertEquals("code", cProperty)
assertEquals(1.0, xProperty)
assertEquals(1, zProperty)
fails { zNoDefault }
}
}
class VarByMapAccessorExtensionsTest {
val map = hashMapOf<String, Any?>("xProperty" to 1.0)
val mapAccessor = map.forProperties { it.name + "Property" }
var x: Double by mapAccessor.withDefault { 2.0 }
var z: Int by mapAccessor
var s: String by mapAccessor
test fun doTest() {
assertEquals(1.0, x)
map.remove("xProperty")
assertEquals(2.0, x)
z = 2
assertEquals(2, z)
assertEquals(2, map["zProperty"])
fails { s }
map["sProperty"] = null
s // fails { s } // does not fail due to KT-8135
}
}