summaryrefslogtreecommitdiff
path: root/include/ruby/impl/intern/struct.h
diff options
context:
space:
mode:
author卜部昌平 <shyouhei@ruby-lang.org>2020-05-04 15:26:12 +0900
committer卜部昌平 <shyouhei@ruby-lang.org>2020-05-11 09:24:08 +0900
commitdca234a5dc9d5bb39c906d833c43305ce95508fb (patch)
treeaeecc73da2a3f9e6d2417fc9fd57e80ff0d2540a /include/ruby/impl/intern/struct.h
parentc89c3801b985916b6fb6726aab966d28371dfaaa (diff)
mv include/ruby/{3,impl}
Devs do not love "3".
Notes
Notes: Merged: https://github.com/ruby/ruby/pull/3079
Diffstat (limited to 'include/ruby/impl/intern/struct.h')
-rw-r--r--include/ruby/impl/intern/struct.h47
1 files changed, 47 insertions, 0 deletions
diff --git a/include/ruby/impl/intern/struct.h b/include/ruby/impl/intern/struct.h
new file mode 100644
index 0000000000..cf99d15747
--- /dev/null
+++ b/include/ruby/impl/intern/struct.h
@@ -0,0 +1,47 @@
+#ifndef RUBY3_INTERN_STRUCT_H /*-*-C++-*-vi:se ft=cpp:*/
+#define RUBY3_INTERN_STRUCT_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 `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 Public APIs related to ::rb_cStruct.
+ */
+#include "ruby/3/dllexport.h"
+#include "ruby/3/intern/vm.h" /* rb_alloc_func_t */
+#include "ruby/3/value.h"
+
+RUBY3_SYMBOL_EXPORT_BEGIN()
+
+/* struct.c */
+VALUE rb_struct_new(VALUE, ...);
+VALUE rb_struct_define(const char*, ...);
+VALUE rb_struct_define_under(VALUE, const char*, ...);
+VALUE rb_struct_alloc(VALUE, VALUE);
+VALUE rb_struct_initialize(VALUE, VALUE);
+VALUE rb_struct_aref(VALUE, VALUE);
+VALUE rb_struct_aset(VALUE, VALUE, VALUE);
+VALUE rb_struct_getmember(VALUE, ID);
+VALUE rb_struct_s_members(VALUE);
+VALUE rb_struct_members(VALUE);
+VALUE rb_struct_size(VALUE s);
+VALUE rb_struct_alloc_noinit(VALUE);
+VALUE rb_struct_define_without_accessor(const char *, VALUE, rb_alloc_func_t, ...);
+VALUE rb_struct_define_without_accessor_under(VALUE outer, const char *class_name, VALUE super, rb_alloc_func_t alloc, ...);
+
+RUBY3_SYMBOL_EXPORT_END()
+
+#endif /* RUBY3_INTERN_STRUCT_H */