kotovalexarian-likes-github/ruby--ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
Code Releases Activity

Add compaction notes for class/module creation C APIs

Browse source
This commit is contained in:
Alan Wu 2020-11-25 16:35:40 -05:00 committed by Aaron Patterson
parent 646131448e
commit 216e6605a4
Notes: git 2021-01-27 09:24:33 +09:00 
Merged: https://github.com/ruby/ruby/pull/3885
2 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
class.c
View file

@ -791,6 +791,7 @@ rb_define_class(const char *name, VALUE super)
* *
* \note if a class named \a name is already defined and its superclass is * \note if a class named \a name is already defined and its superclass is
* \a super, the function just returns the defined class. * \a super, the function just returns the defined class.
* \note the compaction GC does not move classes returned by this function.
*/ */
VALUE VALUE
rb_define_class_under(VALUE outer, const char *name, VALUE super) rb_define_class_under(VALUE outer, const char *name, VALUE super)
@ -814,6 +815,7 @@ rb_define_class_under(VALUE outer, const char *name, VALUE super)
* *
* \note if a class named \a name is already defined and its superclass is * \note if a class named \a name is already defined and its superclass is
* \a super, the function just returns the defined class. * \a super, the function just returns the defined class.
* \note the compaction GC does not move classes returned by this function.
*/ */
VALUE VALUE
rb_define_class_id_under(VALUE outer, ID id, VALUE super) rb_define_class_id_under(VALUE outer, ID id, VALUE super)
@ -866,6 +868,9 @@ rb_define_module_id(ID id)
return rb_module_new(); return rb_module_new();
} }
/*!
* \note the compaction GC does not move modules returned by this function.
*/
VALUE VALUE
rb_define_module(const char *name) rb_define_module(const char *name)
{ {
@ -890,6 +895,9 @@ rb_define_module(const char *name)
return module; return module;
} }
/*!
* \note the compaction GC does not move modules returned by this function.
*/
VALUE VALUE
rb_define_module_under(VALUE outer, const char *name) rb_define_module_under(VALUE outer, const char *name)
{ {

4
include/ruby/internal/module.h
View file

@ -25,6 +25,10 @@
RBIMPL_SYMBOL_EXPORT_BEGIN() RBIMPL_SYMBOL_EXPORT_BEGIN()
/**
* GC compaction note: class and modules returned by these four functions
* do not move.
*/
VALUE rb_define_class(const char*,VALUE); VALUE rb_define_class(const char*,VALUE);
VALUE rb_define_module(const char*); VALUE rb_define_module(const char*);
VALUE rb_define_class_under(VALUE, const char*, VALUE); VALUE rb_define_class_under(VALUE, const char*, VALUE);