rename ref.modify -> ref.access

Author: timbertson

kklib/include/kklib/ref.h

@@ -84,7 +84,7 @@ static inline kk_unit_t kk_ref_set_borrow(kk_ref_t r, kk_box_t value, kk_context
 }
 
 // In Koka we can constrain the argument of f to be a local-scope reference.
-static inline kk_box_t kk_ref_modify(kk_ref_t r, kk_function_t f, kk_context_t* ctx) {
+static inline kk_box_t kk_ref_access(kk_ref_t r, kk_function_t f, kk_context_t* ctx) {
   return kk_function_call(kk_box_t,(kk_function_t,kk_ref_t,kk_context_t*),f,(f,r,ctx),ctx);
 }
 

lib/std/core/types.kk

@@ -355,13 +355,22 @@ pub inline extern ref/(!) : forall<h,a,e> ( ref : ref<h,a>) -> <read<h>|e> a wit
   cs inline "#1.Value"
   js inline "#1.value"
 
-// Modify the value of a reference.
-// This is especially useful when the reference contains a vector, because
+// Access the value of a reference, by evaluating a function with the reference as a local-var.
+// Assigning to this var within the block using `:=` will modify the underlying reference.
+//
+// e.g. `counter.access(fn(i) { i := i + 1 })`
+//
+// This function is especially useful when the reference contains a vector, because
 // getting the vector into a local variable and then setting it back into the reference later
 // would mean that we hold on to a copy (and we can't update the vector in place then!).
 // In contrast, this function passes the ownership to the given function.
+pub inline extern access : forall<h,a,b,e> ( ref : ref<h,a>, f : forall<s> local-var<s,a> -> <local<s>|e> b) -> <read<h>,write<h>|e> b with(hdiv<h,a,e>)
+  c  "kk_ref_access"
+  js inline "((#2)(#1))"
+
+// Deprecated: alias for `access`
 pub inline extern modify : forall<h,a,b,e> ( ref : ref<h,a>, f : forall<s> local-var<s,a> -> <local<s>|e> b) -> <read<h>,write<h>|e> b with(hdiv<h,a,e>)
-  c  "kk_ref_modify"
+  c  "kk_ref_access"
   js inline "((#2)(#1))"
 
 // If a heap effect is unobservable, the heap effect can be erased by using the `run` fun.

test/lib/ref-modify.kk test/lib/ref-access.kktest/lib/ref-modify.kk renamed to test/lib/ref-access.kk

@@ -1,7 +1,7 @@
 fun main() {
     val r = ref(0)
-    r.modify fn(l) {
+    r.access fn(l) {
         l := 1
     }
     (!r).println
-}
+}