Ruby: include/ruby/io.h Source File

Ruby 3.3.5p100 (2024-09-03 revision ef084cc8f4958c1b6e4ead99136631bef6d8ddba)

io.h
Go to the documentation of this file.
1#ifndef RUBY_IO_H /*-*-C++-*-vi:se ft=cpp:*/
2#define RUBY_IO_H 1
13#include "ruby/internal/config.h"
14
15#include <stdio.h>
16#include "ruby/encoding.h"
17
18#if defined(HAVE_STDIO_EXT_H)
19#include <stdio_ext.h>
20#endif
21
22#include <errno.h>
23
25#if defined(HAVE_POLL)
26# ifdef _AIX
27# define reqevents events
28# define rtnevents revents
29# endif
30# include <poll.h>
31# ifdef _AIX
32# undef reqevents
33# undef rtnevents
34# undef events
35# undef revents
36# endif
37# define RB_WAITFD_IN POLLIN
38# if defined(POLLPRI)
39# define RB_WAITFD_PRI POLLPRI
40# else
41# define RB_WAITFD_PRI 0
42# endif
43# define RB_WAITFD_OUT POLLOUT
44#else
45# define RB_WAITFD_IN 0x001
46# define RB_WAITFD_PRI 0x002
47# define RB_WAITFD_OUT 0x004
48#endif
51#include "ruby/internal/attr/const.h"
52#include "ruby/internal/attr/packed_struct.h"
53#include "ruby/internal/attr/pure.h"
54#include "ruby/internal/attr/noreturn.h"
55#include "ruby/internal/dllexport.h"
56#include "ruby/internal/value.h"
57
58// IO#wait, IO#wait_readable, IO#wait_writable, IO#wait_priority are defined by this implementation.
59#define RUBY_IO_WAIT_METHODS
60
61// Used as the default timeout argument to `rb_io_wait` to use the `IO#timeout` value.
62#define RUBY_IO_TIMEOUT_DEFAULT Qnil
63
64 RBIMPL_SYMBOL_EXPORT_BEGIN()
65
66struct stat;
67struct timeval;
68
72 RUBY_EXTERN VALUE rb_eIOTimeoutError;
73
81enum rb_io_event {
82 RUBY_IO_READABLE = RB_WAITFD_IN,
83 RUBY_IO_WRITABLE = RB_WAITFD_OUT,
84 RUBY_IO_PRIORITY = RB_WAITFD_PRI,
85};
86
87typedef enum rb_io_event rb_io_event_t;
88
93RBIMPL_ATTR_PACKED_STRUCT_UNALIGNED_BEGIN()
94struct rb_io_internal_buffer {
95
97 char *ptr; /* off + len <= capa */
98
100 int off;
101
103 int len;
104
106 int capa;
107} RBIMPL_ATTR_PACKED_STRUCT_UNALIGNED_END();
108
110 typedef struct rb_io_internal_buffer rb_io_buffer_t;
111
113/*
114 * enc enc2 read action write action
115 * NULL NULL force_encoding(default_external) write the byte sequence of str
116 * e1 NULL force_encoding(e1) convert str.encoding to e1
117 * e1 e2 convert from e2 to e1 convert str.encoding to e2
118 */
119 struct rb_io_encoding {
121 rb_encoding *enc;
123 rb_encoding *enc2;
129 int ecflags;
137 VALUE ecopts;
138};
139
140#ifndef HAVE_RB_IO_T
141#define HAVE_RB_IO_T 1
143 struct rb_io {
145 RBIMPL_ATTR_DEPRECATED(("with no replacement"))
146 VALUE self;
147
149 RBIMPL_ATTR_DEPRECATED(("with no replacement"))
150 FILE *stdio_file;
151
153 RBIMPL_ATTR_DEPRECATED(("rb_io_descriptor"))
154 int fd;
155
157 RBIMPL_ATTR_DEPRECATED(("rb_io_mode"))
158 int mode;
159
161 RBIMPL_ATTR_DEPRECATED(("with no replacement"))
162 rb_pid_t pid;
163
165 RBIMPL_ATTR_DEPRECATED(("with no replacement"))
166 int lineno;
167
169 RBIMPL_ATTR_DEPRECATED(("rb_io_path"))
170 VALUE pathv;
171
173 RBIMPL_ATTR_DEPRECATED(("with no replacement"))
174 void (*finalize)(struct rb_io*,int);
175
177 RBIMPL_ATTR_DEPRECATED(("with no replacement"))
178 rb_io_buffer_t wbuf;
179
184 RBIMPL_ATTR_DEPRECATED(("with no replacement"))
185 rb_io_buffer_t rbuf;
186
192 RBIMPL_ATTR_DEPRECATED(("rb_io_get_write_io"))
193 VALUE tied_io_for_writing;
194
195 RBIMPL_ATTR_DEPRECATED(("with no replacement"))
196 struct rb_io_encoding encs;
199 RBIMPL_ATTR_DEPRECATED(("with no replacement"))
200 rb_econv_t *readconv;
201
206 RBIMPL_ATTR_DEPRECATED(("with no replacement"))
207 rb_io_buffer_t cbuf;
208
210 RBIMPL_ATTR_DEPRECATED(("with no replacement"))
211 rb_econv_t *writeconv;
212
219 RBIMPL_ATTR_DEPRECATED(("with no replacement"))
220 VALUE writeconv_asciicompat;
221
223 RBIMPL_ATTR_DEPRECATED(("with no replacement"))
224 int writeconv_initialized;
225
230 RBIMPL_ATTR_DEPRECATED(("with no replacement"))
231 int writeconv_pre_ecflags;
232
237 RBIMPL_ATTR_DEPRECATED(("with no replacement"))
238 VALUE writeconv_pre_ecopts;
239
247 RBIMPL_ATTR_DEPRECATED(("with no replacement"))
248 VALUE write_lock;
249
253 RBIMPL_ATTR_DEPRECATED(("rb_io_timeout/rb_io_set_timeout"))
254 VALUE timeout;
255};
256#endif
257
258typedef struct rb_io rb_io_t;
259
261 typedef struct rb_io_encoding rb_io_enc_t;
262
270#define FMODE_READABLE 0x00000001
271
273#define FMODE_WRITABLE 0x00000002
274
276#define FMODE_READWRITE (FMODE_READABLE|FMODE_WRITABLE)
277
287#define FMODE_BINMODE 0x00000004
288
294#define FMODE_SYNC 0x00000008
295
300#define FMODE_TTY 0x00000010
301
308#define FMODE_DUPLEX 0x00000020
309
315#define FMODE_APPEND 0x00000040
316
323#define FMODE_CREATE 0x00000080
324/* #define FMODE_NOREVLOOKUP 0x00000100 */
325
331#define FMODE_EXCL 0x00000400
332
337#define FMODE_TRUNC 0x00000800
338
351#define FMODE_TEXTMODE 0x00001000
360#define FMODE_EXTERNAL 0x00010000
361
362/* #define FMODE_SIGNAL_ON_EPIPE 0x00020000 */
363
368#define FMODE_SETENC_BY_BOM 0x00100000
369/* #define FMODE_UNIX 0x00200000 */
370/* #define FMODE_INET 0x00400000 */
371/* #define FMODE_INET6 0x00800000 */
372
378 VALUE rb_io_open_descriptor(VALUE klass, int descriptor, int mode, VALUE path, VALUE timeout, struct rb_io_encoding *encoding);
379
385 VALUE rb_io_closed_p(VALUE io);
386
396#define RB_IO_POINTER(obj,fp) rb_io_check_closed((fp) = RFILE(rb_io_taint_check(obj))->fptr)
397
402#define GetOpenFile RB_IO_POINTER
403
417#define RB_IO_OPEN(obj, fp) do {\
418 (fp) = rb_io_make_open_file(obj);\
419} while (0)
420
425#define MakeOpenFile RB_IO_OPEN
426
438 rb_io_t *rb_io_make_open_file(VALUE obj);
439
495 FILE *rb_io_stdio_file(rb_io_t *fptr);
496
511 FILE *rb_fdopen(int fd, const char *modestr);
512
528int rb_io_modestr_fmode(const char *modestr);
529
543int rb_io_modestr_oflags(const char *modestr);
544
545 RBIMPL_ATTR_CONST()
553int rb_io_oflags_fmode(int oflags);
554
566void rb_io_check_writable(rb_io_t *fptr);
567
569void rb_io_check_readable(rb_io_t *fptr);
570
589void rb_io_check_char_readable(rb_io_t *fptr);
590
599void rb_io_check_byte_readable(rb_io_t *fptr);
600
610int rb_io_fptr_finalize(rb_io_t *fptr);
611
621void rb_io_synchronized(rb_io_t *fptr);
622
630void rb_io_check_initialized(rb_io_t *fptr);
631
639void rb_io_check_closed(rb_io_t *fptr);
640
651 VALUE rb_io_get_io(VALUE io);
652
665 VALUE rb_io_check_io(VALUE io);
666
690 VALUE rb_io_get_write_io(VALUE io);
691
707 VALUE rb_io_set_write_io(VALUE io, VALUE w);
708
743void rb_io_set_nonblock(rb_io_t *fptr);
744
749 VALUE rb_io_path(VALUE io);
750
758int rb_io_descriptor(VALUE io);
759
764int rb_io_mode(VALUE io);
765
783int rb_io_extract_encoding_option(VALUE opt, rb_encoding **enc_p, rb_encoding **enc2_p, int *fmode_p);
784
852void rb_io_extract_modeenc(VALUE *vmode_p, VALUE *vperm_p, VALUE opthash, int *oflags_p, int *fmode_p, rb_io_enc_t *convconfig_p);
853
854/* :TODO: can this function be __attribute__((warn_unused_result)) or not? */
870ssize_t rb_io_bufwrite(VALUE io, const void *buf, size_t size);
871
872//RBIMPL_ATTR_DEPRECATED(("use rb_io_maybe_wait_readable"))
882int rb_io_wait_readable(int fd);
883
884//RBIMPL_ATTR_DEPRECATED(("use rb_io_maybe_wait_writable"))
893int rb_io_wait_writable(int fd);
894
895//RBIMPL_ATTR_DEPRECATED(("use rb_io_wait"))
910int rb_wait_for_single_fd(int fd, int events, struct timeval *tv);
911
919 VALUE rb_io_timeout(VALUE io);
920
929 VALUE rb_io_set_timeout(VALUE io, VALUE timeout);
930
950 VALUE rb_io_wait(VALUE io, VALUE events, VALUE timeout);
951
982 VALUE rb_io_maybe_wait(int error, VALUE io, VALUE events, VALUE timeout);
983
998int rb_io_maybe_wait_readable(int error, VALUE io, VALUE timeout);
999
1014int rb_io_maybe_wait_writable(int error, VALUE io, VALUE timeout);
1015
1017/* compatibility for ruby 1.8 and older */
1018#define rb_io_mode_flags(modestr) [<"rb_io_mode_flags() is obsolete; use rb_io_modestr_fmode()">]
1019#define rb_io_modenum_flags(oflags) [<"rb_io_modenum_flags() is obsolete; use rb_io_oflags_fmode()">]
1031 VALUE rb_io_taint_check(VALUE obj);
1032
1033 RBIMPL_ATTR_NORETURN()
1040void rb_eof_error(void);
1041
1049void rb_io_read_check(rb_io_t *fptr);
1050
1051 RBIMPL_ATTR_PURE()
1060int rb_io_read_pending(rb_io_t *fptr);
1061
1068 VALUE rb_stat_new(const struct stat *st);
1069
1070/* gc.c */
1071
1072 RBIMPL_SYMBOL_EXPORT_END()
1073
1074#endif /* RUBY_IO_H */
const.h
Defines RBIMPL_ATTR_CONST.
RBIMPL_ATTR_CONST
#define RBIMPL_ATTR_CONST()
Wraps (or simulates) __attribute__((const))
Definition const.h:36
RBIMPL_ATTR_DEPRECATED
#define RBIMPL_ATTR_DEPRECATED(msg)
Wraps (or simulates) [[deprecated]]
Definition deprecated.h:64
dllexport.h
Tweaking visibility of C variables/functions.
RUBY_EXTERN
#define RUBY_EXTERN
Declaration of externally visible global variables.
Definition dllexport.h:45
RBIMPL_SYMBOL_EXPORT_END
#define RBIMPL_SYMBOL_EXPORT_END()
Counterpart of RBIMPL_SYMBOL_EXPORT_BEGIN.
Definition dllexport.h:74
RBIMPL_SYMBOL_EXPORT_BEGIN
#define RBIMPL_SYMBOL_EXPORT_BEGIN()
Shortcut macro equivalent to RUBY_SYMBOL_EXPORT_BEGIN extern "C" {.
Definition dllexport.h:65
encoding.h
Encoding relates APIs.
rb_io_modestr_fmode
int rb_io_modestr_fmode(const char *modestr)
Maps a file mode string (that rb_file_open() takes) into a mixture of FMODE_ flags.
Definition io.c:6394
rb_io_get_io
VALUE rb_io_get_io(VALUE io)
Identical to rb_io_check_io(), except it raises exceptions on conversion failures.
Definition io.c:792
rb_io_timeout
VALUE rb_io_timeout(VALUE io)
Get the timeout associated with the specified io object.
Definition io.c:838
rb_io_taint_check
VALUE rb_io_taint_check(VALUE obj)
Definition io.c:762
rb_io_read_check
void rb_io_read_check(rb_io_t *fptr)
Blocks until there is a pending read in the passed IO.
Definition io.c:1049
rb_io_modestr_oflags
int rb_io_modestr_oflags(const char *modestr)
Identical to rb_io_modestr_fmode(), except it returns a mixture of O_ flags.
Definition io.c:6527
rb_io_mode
int rb_io_mode(VALUE io)
Get the mode of the IO.
Definition io.c:2883
rb_io_event
rb_io_event
Type of events that an IO can wait.
Definition io.h:81
RUBY_IO_READABLE
@ RUBY_IO_READABLE
IO::READABLE
Definition io.h:82
RUBY_IO_PRIORITY
@ RUBY_IO_PRIORITY
IO::PRIORITY
Definition io.h:84
RUBY_IO_WRITABLE
@ RUBY_IO_WRITABLE
IO::WRITABLE
Definition io.h:83
rb_io_check_byte_readable
void rb_io_check_byte_readable(rb_io_t *fptr)
Asserts that an IO is opened for byte-based reading.
Definition io.c:995
rb_io_check_readable
void rb_io_check_readable(rb_io_t *fptr)
Just another name of rb_io_check_byte_readable.
Definition io.c:1004
rb_io_extract_encoding_option
int rb_io_extract_encoding_option(VALUE opt, rb_encoding **enc_p, rb_encoding **enc2_p, int *fmode_p)
This function breaks down the option hash that IO#initialize takes into components.
Definition io.c:6676
rb_io_oflags_fmode
int rb_io_oflags_fmode(int oflags)
Converts an oflags (that rb_io_modestr_oflags() returns) to a fmode (that rb_io_mode_flags() returns)...
Definition io.c:6451
rb_wait_for_single_fd
int rb_wait_for_single_fd(int fd, int events, struct timeval *tv)
Blocks until the passed file descriptor is ready for the passed events.
Definition io.c:1560
rb_fdopen
FILE * rb_fdopen(int fd, const char *modestr)
Identical to rb_io_stdio_file(), except it takes file descriptors instead of Ruby's IO.
Definition io.c:7007
rb_io_descriptor
int rb_io_descriptor(VALUE io)
Returns an integer representing the numeric file descriptor for io.
Definition io.c:2863
rb_io_stdio_file
FILE * rb_io_stdio_file(rb_io_t *fptr)
Finds or creates a stdio's file structure from a Ruby's one.
Definition io.c:9301
rb_io_maybe_wait_readable
int rb_io_maybe_wait_readable(int error, VALUE io, VALUE timeout)
Blocks until the passed IO is ready for reading, if that makes sense for the passed errno.
Definition io.c:1619
rb_io_maybe_wait
VALUE rb_io_maybe_wait(int error, VALUE io, VALUE events, VALUE timeout)
Identical to rb_io_wait() except it additionally takes previous errno.
Definition io.c:1578
rb_eIOTimeoutError
VALUE rb_eIOTimeoutError
Indicates that a timeout has occurred while performing an IO operation.
Definition io.c:179
rb_io_path
VALUE rb_io_path(VALUE io)
Returns the path for the given IO.
Definition io.c:2937
rb_io_check_initialized
void rb_io_check_initialized(rb_io_t *fptr)
Asserts that the passed IO is initialised.
Definition io.c:769
rb_io_check_io
VALUE rb_io_check_io(VALUE io)
Try converting an object to its IO representation using its to_io method, if any.
Definition io.c:798
rb_io_closed_p
VALUE rb_io_closed_p(VALUE io)
Returns whether or not the underlying IO is closed.
Definition io.c:5793
rb_io_set_timeout
VALUE rb_io_set_timeout(VALUE io, VALUE timeout)
Set the timeout associated with the specified io object.
Definition io.c:867
rb_io_bufwrite
ssize_t rb_io_bufwrite(VALUE io, const void *buf, size_t size)
Buffered write to the passed IO.
Definition io.c:1982
rb_io_check_char_readable
void rb_io_check_char_readable(rb_io_t *fptr)
Asserts that an IO is opened for character-based reading.
Definition io.c:976
rb_io_read_pending
int rb_io_read_pending(rb_io_t *fptr)
Queries if the passed IO has any pending reads.
Definition io.c:1040
rb_io_get_write_io
VALUE rb_io_get_write_io(VALUE io)
Queries the tied IO for writing.
Definition io.c:804
rb_io_set_nonblock
void rb_io_set_nonblock(rb_io_t *fptr)
Instructs the OS to put its internal file structure into "nonblocking mode".
Definition io.c:3389
rb_io_extract_modeenc
void rb_io_extract_modeenc(VALUE *vmode_p, VALUE *vperm_p, VALUE opthash, int *oflags_p, int *fmode_p, rb_io_enc_t *convconfig_p)
This function can be seen as an extended version of rb_io_extract_encoding_option() that not only con...
Definition io.c:6801
rb_io_wait_writable
int rb_io_wait_writable(int fd)
Blocks until the passed file descriptor gets writable.
Definition io.c:1517
rb_io_open_descriptor
VALUE rb_io_open_descriptor(VALUE klass, int descriptor, int mode, VALUE path, VALUE timeout, struct rb_io_encoding *encoding)
Allocate a new IO object, with the given file descriptor.
Definition io.c:9188
rb_io_set_write_io
VALUE rb_io_set_write_io(VALUE io, VALUE w)
Assigns the tied IO for writing.
Definition io.c:815
rb_io_check_writable
void rb_io_check_writable(rb_io_t *fptr)
Asserts that an IO is opened for writing.
Definition io.c:1028
rb_io_maybe_wait_writable
int rb_io_maybe_wait_writable(int error, VALUE io, VALUE timeout)
Blocks until the passed IO is ready for writing, if that makes sense for the passed errno.
Definition io.c:1632
rb_io_check_closed
void rb_io_check_closed(rb_io_t *fptr)
This badly named function asserts that the passed IO is open.
Definition io.c:777
rb_eof_error
void rb_eof_error(void)
Utility function to raise rb_eEOFError.
Definition io.c:756
rb_io_wait_readable
int rb_io_wait_readable(int fd)
Blocks until the passed file descriptor gets readable.
Definition io.c:1483
rb_io_synchronized
void rb_io_synchronized(rb_io_t *fptr)
Sets FMODE_SYNC.
Definition io.c:7287
rb_io_wait
VALUE rb_io_wait(VALUE io, VALUE events, VALUE timeout)
Blocks until the passed IO is ready for the passed events.
Definition io.c:1422
noreturn.h
Defines RBIMPL_ATTR_NORETURN.
RBIMPL_ATTR_NORETURN
#define RBIMPL_ATTR_NORETURN()
Wraps (or simulates) [[noreturn]]
Definition noreturn.h:38
packed_struct.h
Defines RBIMPL_ATTR_PACKED_STRUCT_BEGIN, RBIMPL_ATTR_PACKED_STRUCT_END, RBIMPL_ATTR_PACKED_STRUCT_UNA...
pure.h
Defines RBIMPL_ATTR_PURE.
RBIMPL_ATTR_PURE
#define RBIMPL_ATTR_PURE()
Wraps (or simulates) __attribute__((pure))
Definition pure.h:33
__sFILE
Definition vsnprintf.c:160
OnigEncodingTypeST
Definition onigmo.h:160
rb_econv_t
Definition transcode.c:130
rb_io_encoding
Decomposed encoding flags (e.g.
Definition io.h:119
rb_io_encoding::ecflags
int ecflags
Flags.
Definition io.h:129
rb_io_encoding::ecopts
VALUE ecopts
Flags as Ruby hash.
Definition io.h:137
rb_io_encoding::enc2
rb_encoding * enc2
External encoding.
Definition io.h:123
rb_io_encoding::enc
rb_encoding * enc
Internal encoding.
Definition io.h:121
rb_io_internal_buffer
IO buffers.
Definition io.h:94
rb_io_internal_buffer::ptr
char * ptr
Pointer to the underlying memory region, of at least capa bytes.
Definition io.h:97
rb_io_internal_buffer::off
int off
Offset inside of ptr.
Definition io.h:100
rb_io_internal_buffer::len
int len
Length of the buffer.
Definition io.h:103
rb_io_internal_buffer::capa
int capa
Designed capacity of the buffer.
Definition io.h:106
rb_io
Ruby's IO, metadata and buffers.
Definition io.h:143
rb_io::mode
int mode
mode flags: FMODE_XXXs
Definition io.h:158
rb_io::wbuf
rb_io_buffer_t wbuf
Write buffer.
Definition io.h:178
rb_io::finalize
void(* finalize)(struct rb_io *, int)
finalize proc
Definition io.h:174
rb_io::readconv
rb_econv_t * readconv
Encoding converter used when reading from this IO.
Definition io.h:200
rb_io::writeconv
rb_econv_t * writeconv
Encoding converter used when writing to this IO.
Definition io.h:211
rb_io::encs
struct rb_io_encoding encs
Decomposed encoding flags.
Definition io.h:196
rb_io::self
VALUE self
The IO's Ruby level counterpart.
Definition io.h:146
rb_io::write_lock
VALUE write_lock
This is a Ruby level mutex.
Definition io.h:248
rb_io::timeout
VALUE timeout
The timeout associated with this IO when performing blocking operations.
Definition io.h:254
rb_io::stdio_file
FILE * stdio_file
stdio ptr for read/write, if available.
Definition io.h:150
rb_io::writeconv_pre_ecopts
VALUE writeconv_pre_ecopts
Value of ::rb_io_t::rb_io_enc_t::ecopts stored right before initialising rb_io_t::writeconv.
Definition io.h:238
rb_io::tied_io_for_writing
VALUE tied_io_for_writing
Duplex IO object, if set.
Definition io.h:193
rb_io::writeconv_initialized
int writeconv_initialized
Whether rb_io_t::writeconv is already set up.
Definition io.h:224
rb_io::fd
int fd
file descriptor.
Definition io.h:154
rb_io::rbuf
rb_io_buffer_t rbuf
(Byte) read buffer.
Definition io.h:185
rb_io::lineno
int lineno
number of lines read
Definition io.h:166
rb_io::writeconv_asciicompat
VALUE writeconv_asciicompat
This is, when set, an instance of rb_cString which holds the "common" encoding.
Definition io.h:220
rb_io::cbuf
rb_io_buffer_t cbuf
rb_io_ungetc() destination.
Definition io.h:207
rb_io::pid
rb_pid_t pid
child's pid (for pipes)
Definition io.h:162
rb_io::writeconv_pre_ecflags
int writeconv_pre_ecflags
Value of ::rb_io_t::rb_io_enc_t::ecflags stored right before initialising rb_io_t::writeconv.
Definition io.h:231
rb_io::pathv
VALUE pathv
pathname for file
Definition io.h:170
timeval
Definition missing.h:63
value.h
Defines VALUE and ID.
VALUE
uintptr_t VALUE
Type that represents a Ruby object.
Definition value.h:40