summaryrefslogtreecommitdiff
path: root/include/ruby/3/gc.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/ruby/3/gc.h')
-rw-r--r--include/ruby/3/gc.h35
1 files changed, 35 insertions, 0 deletions
diff --git a/include/ruby/3/gc.h b/include/ruby/3/gc.h
new file mode 100644
index 0000000000..e6c66e73ea
--- /dev/null
+++ b/include/ruby/3/gc.h
@@ -0,0 +1,35 @@
+/** \noop-*-C++-*-vi:ft=cpp
+ * @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 `RUBY3` or `ruby3` 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.
+ */
+#ifndef RUBY3_GC_H
+#define RUBY3_GC_H
+#include "ruby/3/dllexport.h"
+#include "ruby/3/value.h"
+
+RUBY3_SYMBOL_EXPORT_BEGIN()
+
+void rb_global_variable(VALUE*);
+void rb_gc_register_mark_object(VALUE);
+void rb_gc_register_address(VALUE*);
+void rb_gc_unregister_address(VALUE*);
+
+RUBY3_SYMBOL_EXPORT_END()
+
+#endif /* RUBY3_GC_H */