Merge pull request #138 from godot-nim/feat-add-iterators-for-array-k…

…inds

Feat: add iterators for Array kinds

src/gdext/surface/arrayutils.nim

@@ -8,20 +8,37 @@ import gdext/gen/[builtinclasses]
 import std/sequtils
 
 {.push, inline.}
-proc setLen*(arr: var Array; newlen: Natural) =
+proc setLen*(arr: var Array; newlen: int) =
   discard arr.resize(newlen)
-proc setLen*(arr: var TypedArray; newlen: Natural) =
+proc setLen*(arr: var TypedArray; newlen: int) =
   arr.Array.setlen(newlen)
-proc len*(arr: Array): Natural = arr.size
-proc len*(arr: TypedArray): Natural = arr.Array.len
+proc len*(arr: Array): int = arr.size
+proc len*(arr: TypedArray): int = arr.Array.len
+
+proc setLen*(arr: var PackedArray; newlen: int) =
+  discard arr.resize(newlen)
+proc len*(arr: PackedArray): int = arr.size
 {.pop.}
 
 iterator items*(arr: Array): Variant =
   for i in 0..<arr.len: yield arr[i]
+iterator pairs*(arr: Array): (int, Variant) =
+  for i in 0..<arr.len: yield (int i, arr[i])
+
+iterator items*[T](arr: PackedArray[T]): T =
+  for i in 0..<arr.len: yield arr[i]
+iterator pairs*[T](arr: PackedArray[T]): (int, T) =
+  for i in 0..<arr.len: yield (int i, arr[i])
 
-iterator pairs*(arr: Array): (Natural, Variant) =
-  for i in 0..<arr.len: yield (Natural i, arr[i])
+iterator mitems*(arr: var Array): var Variant =
+  for i in 0..<arr.len: yield arr[i]
+iterator mpairs*(arr: var Array): (int, var Variant) =
+  for i in 0..<arr.len: yield (int i, arr[i])
 
+iterator mitems*[T](arr: var PackedArray[T]): var T =
+  for i in 0..<arr.len: yield arr[i]
+iterator mpairs*[T](arr: var PackedArray[T]): (int, var T) =
+  for i in 0..<arr.len: yield (int i, arr[i])
 
 proc typedArray*[T: SomeVariant](arr: Array): TypedArray[T] =
   when T is SomeBuiltins:

testproject/runtime/nim/src/cases/primitives.nim

@@ -34,6 +34,24 @@ runtime: suite "PackedArray":
     let s: seq[byte] = bytes.toSeq
     check s == @[byte 0, 1, 2, 3, 4, 5, 6, 7]
 
+  test "mutable iteration":
+    for b in bytes.mitems:
+      b = 255
+      check b == 255
+
+    for i, b in bytes.mpairs:
+      b = byte i
+      check b == byte i
+
+  test "immutable iteration":
+    for i, b in bytes:
+      check b == byte i
+
+    var i: int
+    for b in bytes:
+      check b == byte i
+      inc i
+
 runtime: suite "String":
   test "to nim-string":
     let gdstr: String = "String"