summaryrefslogtreecommitdiff
path: root/include/ruby/3/core/rfile.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/ruby/3/core/rfile.h')
-rw-r--r--include/ruby/3/core/rfile.h36
1 files changed, 36 insertions, 0 deletions
diff --git a/include/ruby/3/core/rfile.h b/include/ruby/3/core/rfile.h
new file mode 100644
index 0000000000..2b80a96e40
--- /dev/null
+++ b/include/ruby/3/core/rfile.h
@@ -0,0 +1,36 @@
+/** \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 Defines struct ::RFile.
+ */
+#ifndef RUBY3_RFILE_H
+#define RUBY3_RFILE_H
+#include "ruby/3/core/rbasic.h"
+#include "ruby/3/cast.h"
+
+/* rb_io_t is in ruby/io.h. The header file has historically not been included
+ * into ruby/ruby.h. We follow that tradition. */
+struct rb_io_t;
+
+struct RFile {
+ struct RBasic basic;
+ struct rb_io_t *fptr;
+};
+
+#define RFILE(obj) RUBY3_CAST((struct RFile *)(obj))
+#endif /* RUBY3_RFILE_H */