Ruby: include/ruby/internal/intern/process.h Source File

Ruby 3.4.7p58 (2025-10-08 revision 7a5688e2a27668e48f8d6ff4af5b2208b98a2f5e)

process.h
Go to the documentation of this file.
1#ifndef RBIMPL_INTERN_PROCESS_H /*-*-C++-*-vi:se ft=cpp:*/
2#define RBIMPL_INTERN_PROCESS_H
23#include "ruby/internal/attr/nonnull.h"
24#include "ruby/internal/attr/noreturn.h"
25#include "ruby/internal/config.h" /* rb_pid_t is defined here. */
26#include "ruby/internal/dllexport.h"
27#include "ruby/internal/value.h"
28
29 RBIMPL_SYMBOL_EXPORT_BEGIN()
30
31/* process.c */
32
33
40 VALUE rb_process_status_wait(rb_pid_t pid, int flags);
41
49void rb_last_status_set(int status, rb_pid_t pid);
50
58 VALUE rb_last_status_get(void);
59
60 RBIMPL_ATTR_NONNULL(())
70int rb_proc_exec(const char *cmd);
71
72 RBIMPL_ATTR_NORETURN()
180 VALUE rb_f_exec(int argc, const VALUE *argv);
181
199rb_pid_t rb_waitpid(rb_pid_t pid, int *status, int flags);
200
209void rb_syswait(rb_pid_t pid);
210
230rb_pid_t rb_spawn(int argc, const VALUE *argv);
231
249rb_pid_t rb_spawn_err(int argc, const VALUE *argv, char *errbuf, size_t buflen);
250
262 VALUE rb_proc_times(VALUE _);
263
278 VALUE rb_detach_process(rb_pid_t pid);
279
280 RBIMPL_SYMBOL_EXPORT_END()
281
282#endif /* RBIMPL_INTERN_PROCESS_H */
dllexport.h
Tweaking visibility of C variables/functions.
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
rb_proc_exec
int rb_proc_exec(const char *cmd)
Executes a shell command.
Definition process.c:1801
rb_last_status_get
VALUE rb_last_status_get(void)
Queries the "last status", or the $?.
Definition process.c:611
rb_waitpid
rb_pid_t rb_waitpid(rb_pid_t pid, int *status, int flags)
Waits for a process, with releasing GVL.
Definition process.c:1271
rb_spawn_err
rb_pid_t rb_spawn_err(int argc, const VALUE *argv, char *errbuf, size_t buflen)
Identical to rb_spawn(), except you can additionally know the detailed situation in case of abnormal ...
Definition process.c:4716
rb_syswait
void rb_syswait(rb_pid_t pid)
This is a shorthand of rb_waitpid without status and flags.
Definition process.c:4587
rb_f_exec
VALUE rb_f_exec(int argc, const VALUE *argv)
Replaces the current process by running the given external command.
Definition process.c:3020
rb_spawn
rb_pid_t rb_spawn(int argc, const VALUE *argv)
Identical to rb_f_exec(), except it spawns a child process instead of replacing the current one.
Definition process.c:4722
rb_process_status_wait
VALUE rb_process_status_wait(rb_pid_t pid, int flags)
Wait for the specified process to terminate, reap it, and return its status.
Definition process.c:1198
rb_last_status_set
void rb_last_status_set(int status, rb_pid_t pid)
Sets the "last status", or the $?.
Definition process.c:682
rb_detach_process
VALUE rb_detach_process(rb_pid_t pid)
"Detaches" a subprocess.
Definition process.c:1555
nonnull.h
Defines RBIMPL_ATTR_NONNULL.
RBIMPL_ATTR_NONNULL
#define RBIMPL_ATTR_NONNULL(list)
Wraps (or simulates) __attribute__((nonnull))
Definition nonnull.h:30
noreturn.h
Defines RBIMPL_ATTR_NORETURN.
RBIMPL_ATTR_NORETURN
#define RBIMPL_ATTR_NORETURN()
Wraps (or simulates) [[noreturn]]
Definition noreturn.h:38
_
#define _(args)
This was a transition path from K&R to ANSI.
Definition stdarg.h:35
value.h
Defines VALUE and ID.
VALUE
uintptr_t VALUE
Type that represents a Ruby object.
Definition value.h:40