first cut of the collection methods in the standard library in http://confluence.jetbrains.net/display/JET/Standard+Library along with a little testlib to test them. Still a few TODO things and tidy up (and am sure a few more methods could be very handy too) but its getting Kool :)

2011-12-18 07:17:38 +00:00
parent 55ba7c0fde
commit d122929b4b
8 changed files with 272 additions and 10 deletions
@@ -11,7 +11,7 @@ val Collection<*>.empty : Boolean
    get() = isEmpty()

 /** Returns a new ArrayList with a variable number of initial elements */
-fun arrayList<T>(vararg values: T) : ArrayList<T> {
+inline fun arrayList<T>(vararg values: T) : ArrayList<T> {
  val answer = ArrayList<T>()
  for (v in values)
    answer.add(v)
@@ -19,7 +19,7 @@ fun arrayList<T>(vararg values: T) : ArrayList<T> {
 }

 /** Returns a new HashSet with a variable number of initial elements */
-fun hashSet<T>(vararg values: T) : HashSet<T> {
+inline fun hashSet<T>(vararg values: T) : HashSet<T> {
  val answer = HashSet<T>()
  for (v in values)
    answer.add(v)
@@ -46,7 +46,7 @@ protected fun <T,R> Set<T>.create(defaultSize: Int? = null) : Set<R> {


 /** Returns true if any elements in the collection match the given predicate */
-fun <T> java.lang.Iterable<T>.any(predicate: fun(T): Boolean) : Boolean {
+inline fun <T> java.lang.Iterable<T>.any(predicate: fun(T): Boolean) : Boolean {
  for (elem in this) {
    if (predicate(elem)) {
      return true
@@ -56,7 +56,7 @@ fun <T> java.lang.Iterable<T>.any(predicate: fun(T): Boolean) : Boolean {
 }

 /** Returns true if all elements in the collection match the given predicate */
-fun <T> java.lang.Iterable<T>.all(predicate: fun(T): Boolean) : Boolean {
+inline fun <T> java.lang.Iterable<T>.all(predicate: fun(T): Boolean) : Boolean {
  for (elem in this) {
    if (!predicate(elem)) {
      return false
@@ -66,7 +66,7 @@ fun <T> java.lang.Iterable<T>.all(predicate: fun(T): Boolean) : Boolean {
 }

 /** Returns the first item in the collection which matches the given predicate or null if none matched */
-fun <T> java.lang.Iterable<T>.find(predicate: fun(T): Boolean) : T? {
+inline fun <T> java.lang.Iterable<T>.find(predicate: fun(T): Boolean) : T? {
  for (elem in this) {
    if (predicate(elem))
      return elem
@@ -77,7 +77,7 @@ fun <T> java.lang.Iterable<T>.find(predicate: fun(T): Boolean) : T? {
 /** Returns a new collection containing all elements in this collection which match the given predicate */
 // TODO using: Collection<T> for the return type - I wonder if this exact type could be
 // deduced somewhat from the This.Type; e.g. returning Set on a Set, Array on Array etc
-fun <T> java.lang.Iterable<T>.filter(predicate: fun(T): Boolean) : Collection<T> {
+inline fun <T> java.lang.Iterable<T>.filter(predicate: fun(T): Boolean) : Collection<T> {
  val result = this.create<T,T>()
  for (elem in this) {
    if (predicate(elem))
@@ -86,8 +86,47 @@ fun <T> java.lang.Iterable<T>.filter(predicate: fun(T): Boolean) : Collection<T>
  return result
 }

+/**
+  * Returns the result of transforming each item in the collection to a one or more values which
+  * are concatenated together into a single collection
+  */
+// TODO should use Iterable instead of Collection in transform?
+inline fun <T, out R> java.lang.Iterable<T>.flatMap(transform: fun(T): Collection<R>) : Collection<R> {
+  val result = this.create<T,R>()
+  for (elem in this) {
+    val coll = transform(elem)
+    if (coll != null) {
+      for (r in coll) {
+        result.add(r)
+      }
+    }
+  }
+  return result
+}
+
+/** Performs the given operation on each element inside the collection */
+inline fun <T> java.lang.Iterable<T>.foreach(operation: fun(element: T) : Unit) {
+  for (elem in this)
+    operation(elem)
+}
+
+/** Creates a String from all the elements in the collection, using the seperator between them and using the given prefix and postfix if supplied */
+inline fun <T> java.lang.Iterable<T>.join(separator: String, prefix: String = "", postfix: String = "") : String {
+  val buffer = StringBuilder(prefix)
+  var first = true
+  for (elem in this) {
+    if (first)
+      first = false
+    else
+      buffer.append(separator)
+    buffer.append(elem)
+  }
+  buffer.append(postfix)
+  return buffer.toString().sure()
+}
+
 /** Returns a new collection containing the results of applying the given function to each element in this collection */
-fun <T, R> java.lang.Iterable<T>.map(transform : fun(T) : R) : Collection<R> {
+inline fun <T, R> java.lang.Iterable<T>.map(transform : fun(T) : R) : Collection<R> {
  val result = this.create<T,R>()
  for (item in this)
    result.add(transform(item))
@@ -95,9 +134,91 @@ fun <T, R> java.lang.Iterable<T>.map(transform : fun(T) : R) : Collection<R> {
 }

 /** Returns a new collection containing the results of applying the given function to each element in this collection */
-fun <T, R> java.util.Collection<T>.map(transform : fun(T) : R) : Collection<R> {
+inline fun <T, R> java.util.Collection<T>.map(transform : fun(T) : R) : Collection<R> {
  val result = this.create<T,R>(this.size)
  for (item in this)
    result.add(transform(item))
  return result
-}
+}
+
+inline fun <in T: java.lang.Comparable<T>> java.lang.Iterable<T>.sort() : List<T> {
+  val answer = this.toList()
+  answer.sort()
+  return answer
+}
+
+inline fun <in T: java.lang.Comparable<T>> java.lang.Iterable<T>.sort(comparator: java.util.Comparator<T>) : List<T> {
+  val answer = this.toList()
+  answer.sort(comparator)
+  return answer
+}
+
+/**
+  TODO figure out necessary variance/generics ninja stuff... :)
+inline fun <in T> java.lang.Iterable<T>.sort(transform: fun(T) : java.lang.Comparable<*>) : List<T> {
+  val answer = this.toList()
+  val comparator = java.util.Comparator<T>() {
+    fun compare(o1: T, o2: T): Int {
+      val v1 = transform(o1)
+      val v2 = transform(o2)
+      if (v1 == v2) {
+        return 0
+      } else {
+        return v1.compareTo(v2)
+      }
+    }
+  }
+  answer.sort(comparator)
+  return answer
+}
+*/
+
+inline fun <T> java.lang.Iterable<T>.toList() : List<T> {
+  if (this is List<T>)
+    return this
+  else {
+    val list = ArrayList<T>()
+    for (elem in this)
+      list.add(elem)
+    return list
+  }
+}
+
+inline fun <T> java.util.Collection<T>.toArray() : Array<T> {
+  if (this is Array<T>)
+    return this
+  else {
+    val answer = Array<T>(this.size)
+    var idx = 0
+    for (elem in this)
+      answer[idx++] = elem
+    return answer as Array<T>
+  }
+}
+
+
+// List APIs
+
+inline fun <in T: java.lang.Comparable<T>> List<T>.sort() : Unit {
+  Collections.sort(this)
+}
+
+inline fun <in T: java.lang.Comparable<T>> List<T>.sort(comparator: java.util.Comparator<T>) : Unit {
+  Collections.sort(this, comparator)
+}
+
+val <T> List<T>.head : T?
+    get() = this.get(0)
+
+val <T> List<T>.first : T?
+    get() = this.head
+
+val <T> List<T>.tail : T?
+    get() {
+      val s = this.size
+      return if (s > 0) this.get(s - 1) else null
+
+    }
+val <T> List<T>.last : T?
+  get() = this.tail
+
@@ -44,7 +44,7 @@ fun fails(block: fun() : Any) {
 }

 fun todo(block: fun(): Any) {
-  // Ignore the code :)
+  println("TODO at " + Exception().getStackTrace()?.get(1))
 }

 /*
@@ -0,0 +1,34 @@
+namespace test.apicheck
+
+import java.util.*
+
+trait Traversable<T> {
+
+  /** Returns true if any elements in the collection match the given predicate */
+  fun any(predicate: fun(T): Boolean) : Boolean
+
+  /** Returns true if all elements in the collection match the given predicate */
+  fun all(predicate: fun(T): Boolean) : Boolean
+
+  /** Returns the first item in the collection which matches the given predicate or null if none matched */
+  fun find(predicate: fun(T): Boolean) : T?
+
+  /** Returns a new collection containing all elements in this collection which match the given predicate */
+  // TODO using: Collection<T> for the return type - I wonder if this exact type could be
+  // deduced somewhat from the This.Type; e.g. returning Set on a Set, Array on Array etc
+  fun filter(predicate: fun(T): Boolean) : Collection<T>
+
+  /** Performs the given operation on each element inside the collection */
+  fun foreach(operation: fun(element: T) : Unit)
+
+  /** Returns a new collection containing the results of applying the given function to each element in this collection */
+  fun <T, R> java.lang.Iterable<T>.map(transform : fun(T) : R) : Collection<R>
+}
+
+/**
+TODO try use delegation here to make sure we implement all the methods in the Traversable API
+
+class ListImpl<T>(coll: ArrayList<out T>) : Traversable<T> by coll {
+}
+
+*/
@@ -51,6 +51,38 @@ class CollectionTest() : TestSupport() {
    assertEquals("foo", f)
  }

+  fun testFlatMap() {
+    /**
+      TODO compiler bug
+      we should be able to remove the explicit type on the function
+      http://youtrack.jetbrains.net/issue/KT-849
+    */
+    // TODO there should be a neater way to do this :)
+
+    val characters = arrayList('f', 'o', 'o', 'b', 'a', 'r')
+    /*
+    val characters = data.flatMap<String,Character>{
+      Arrays.asList((it as java.lang.String).toCharArray()) as Collection<Character>
+    }
+    */
+    todo {
+      println("Got list of characters ${characters}")
+      val text = characters.join("")
+      assertEquals("foobar", text)
+    }
+  }
+
+  fun testForeach() {
+    var count = 0
+    val x = data.foreach{ count += it.length }
+    assertEquals(6, count)
+  }
+
+  fun testJoin() {
+    val text = data.join("-", "<", ">")
+    assertEquals("<foo-bar>", text)
+  }
+
  fun testMap() {
    /**
      TODO compiler bug
@@ -65,4 +97,27 @@ class CollectionTest() : TestSupport() {
    assertEquals(arrayList(3, 3), lengths)
  }

+  fun testSort() {
+    val coll: List<String> = arrayList("foo", "bar", "abc")
+
+    // TODO fixme
+    // Some sort of in/out variance thing - or an issue with Java interop?
+    //coll.sort()
+    todo {
+      assertEquals(3, coll.size)
+      assertEquals(arrayList("abc", "bar", "foo"), coll)
+
+    }
+  }
+
+  fun testToArray() {
+    val arr = data.toArray()
+    println("Got array ${arr}")
+    todo {
+      assert {
+        arr is Array<String>
+      }
+    }
+  }
+
 }
@@ -0,0 +1,29 @@
+namespace test.collections
+
+import std.test.*
+
+// TODO can we avoid importing all this stuff by default I wonder?
+// e.g. making println and the collection builder methods public by default?
+import std.io.*
+import std.util.*
+import java.util.*
+
+class ListTest() : TestSupport() {
+  val data = arrayList("foo", "bar")
+
+  fun testHeadAndTail() {
+    val h = data.head
+    assertEquals("foo", h)
+
+    val t = data.tail
+    assertEquals("bar", t)
+  }
+
+  fun testFirstAndLast() {
+    val h = data.first
+    assertEquals("foo", h)
+
+    val t = data.last
+    assertEquals("bar", t)
+  }
+}
@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="JAVA_MODULE" version="4">
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/src" isTestSource="false" />
+      <sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="module" module-name="Stdlib" exported="" />
+    <orderEntry type="module-library" exported="">
+      <library>
+        <CLASSES>
+          <root url="jar://$MODULE_DIR$/lib/junit-4.9.jar!/" />
+        </CLASSES>
+        <JAVADOC />
+        <SOURCES />
+      </library>
+    </orderEntry>
+  </component>
+</module>
+