summaryrefslogtreecommitdiffhomepage
path: root/include
diff options
context:
space:
mode:
authorYukihiro "Matz" Matsumoto <[email protected]>2015-09-22 00:15:29 +0900
committerYukihiro "Matz" Matsumoto <[email protected]>2015-09-22 00:15:29 +0900
commit73dc32c670f4fcaed0f33477b6fe5d602edcece1 (patch)
treecbb1949c7926deac6de20d46438cf05cb0c78775 /include
parent386a2b8aa1617a967236dab4cfcdd685b04b465f (diff)
downloadmruby-73dc32c670f4fcaed0f33477b6fe5d602edcece1.tar.gz
mruby-73dc32c670f4fcaed0f33477b6fe5d602edcece1.zip
add new functions mrb_gc_register/unregister; close #1411
some routines need to refer mruby objects (e.g. callbacks), in that case you have to protect your objects from garbage collection. the new functions mrb_gc_register() keeps those objects from GC. you have to remove your objects using mrb_gc_unregister() when your C routines use mruby objects any longer, otherwise objects will leak.
Diffstat (limited to 'include')
-rw-r--r--include/mruby.h6
1 files changed, 6 insertions, 0 deletions
diff --git a/include/mruby.h b/include/mruby.h
index dedbd0748..a262a0fbf 100644
--- a/include/mruby.h
+++ b/include/mruby.h
@@ -408,7 +408,13 @@ MRB_API mrb_value mrb_yield(mrb_state *mrb, mrb_value b, mrb_value arg);
MRB_API mrb_value mrb_yield_argv(mrb_state *mrb, mrb_value b, mrb_int argc, const mrb_value *argv);
MRB_API mrb_value mrb_yield_with_class(mrb_state *mrb, mrb_value b, mrb_int argc, const mrb_value *argv, mrb_value self, struct RClass *c);
+/* mrb_gc_protect() leaves the object in the arena */
MRB_API void mrb_gc_protect(mrb_state *mrb, mrb_value obj);
+/* mrb_gc_register() keeps the object from GC. */
+MRB_API void mrb_gc_register(mrb_state *mrb, mrb_value obj);
+/* mrb_gc_unregister() removes the object from GC root. */
+MRB_API void mrb_gc_unregister(mrb_state *mrb, mrb_value obj);
+
MRB_API mrb_value mrb_to_int(mrb_state *mrb, mrb_value val);
#define mrb_int(mrb, val) mrb_fixnum(mrb_to_int(mrb, val))
MRB_API void mrb_check_type(mrb_state *mrb, mrb_value x, enum mrb_vtype t);