blob: 69ff6193d8d1a967526682c25125e0fd21e5ca0b (plain
#ifndef RBIMPL_GC_H /*-*-C++-*-vi:se ft=cpp:*/
* @author Ruby developers <firstname.lastname@example.org>
* @copyright This file is a part of the programming language Ruby.
* Permission is hereby granted, to either redistribute and/or
* modify this file, provided that the conditions mentioned in the
* file COPYING are met. Consult the file for details.
* @warning Symbols prefixed with either `RBIMPL` or `rbimpl` are
* implementation details. Don't take them as canon. They could
* rapidly appear then vanish. The name (path) of this header file
* is also an implementation detail. Do not expect it to persist
* at the place it is now. Developers are free to move it anywhere
* anytime at will.
* @note To ruby-core: remember that this header can be possibly
* recursively included from extension libraries written in C++.
* Do not expect for instance `__VA_ARGS__` is always available.
* We assume C99 for ruby itself but we don't assume languages of
* extension libraries. They could be written in C++98.
* @brief Registering values to the GC.
* Inform the garbage collector that `valptr` points to a live Ruby object that
* should not be moved. Note that extensions should use this API on global
* constants instead of assuming constants defined in Ruby are always alive.
* Ruby code can remove global constants.
void rb_gc_register_address(VALUE *valptr);
* An alias for `rb_gc_register_address()`.
void rb_global_variable(VALUE *);
* Inform the garbage collector that a pointer previously passed to
* `rb_gc_register_address()` no longer points to a live Ruby object.
void rb_gc_unregister_address(VALUE *valptr);
* Inform the garbage collector that `object` is a live Ruby object. Note that
* the garbage collector is free to move `object` and so it is not correct to
* save `object` into a C global constant and assume that it will always refer
* to the same Ruby object.
* See also: rb_gc_register_address()
void rb_gc_register_mark_object(VALUE object);
#endif /* RBIMPL_GC_H */