blob: 66fc14e51181e1a7c42610c2f918db5e389d2265 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
|
#ifndef RBIMPL_GC_H /*-*-C++-*-vi:se ft=cpp:*/
#define RBIMPL_GC_H
/**
* @file
* @author Ruby developers <ruby-core@ruby-lang.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.
*/
#include "ruby/internal/dllexport.h"
#include "ruby/internal/value.h"
RBIMPL_SYMBOL_EXPORT_BEGIN()
/**
* 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 that should
* not be moved.
*
* See also: rb_gc_register_address()
*/
void rb_gc_register_mark_object(VALUE object);
RBIMPL_SYMBOL_EXPORT_END()
#endif /* RBIMPL_GC_H */
|
