Ruby: eval_jump.c Source File

Ruby 3.0.5p211 (2022-11-24 revision ba5cf0f7c52d4d35cc6a173c89eda98ceffa2dcf)

eval_jump.c
Go to the documentation of this file.
1/* -*-c-*- */
2/*
3 * from eval.c
4 */
5
6#include "eval_intern.h"
7
8/* exit */
9
10void
11rb_call_end_proc(VALUE data)
12{
13 rb_proc_call(data, rb_ary_new());
14}
15
16/*
17 * call-seq:
18 * at_exit { block } -> proc
19 *
20 * Converts _block_ to a +Proc+ object (and therefore
21 * binds it at the point of call) and registers it for execution when
22 * the program exits. If multiple handlers are registered, they are
23 * executed in reverse order of registration.
24 *
25 * def do_at_exit(str1)
26 * at_exit { print str1 }
27 * end
28 * at_exit { puts "cruel world" }
29 * do_at_exit("goodbye ")
30 * exit
31 *
32 * <em>produces:</em>
33 *
34 * goodbye cruel world
35 */
36
37static VALUE
38rb_f_at_exit(VALUE _)
39{
40 VALUE proc;
41
42 if (!rb_block_given_p()) {
43 rb_raise(rb_eArgError, "called without a block");
44 }
45 proc = rb_block_proc();
46 rb_set_end_proc(rb_call_end_proc, proc);
47 return proc;
48}
49
50 struct end_proc_data {
51 void (*func) ();
52 VALUE data;
53 struct end_proc_data *next;
54};
55
56static struct end_proc_data *end_procs, *ephemeral_end_procs;
57
58void
59rb_set_end_proc(void (*func)(VALUE), VALUE data)
60{
61 struct end_proc_data *link = ALLOC(struct end_proc_data);
62 struct end_proc_data **list;
63 rb_thread_t *th = GET_THREAD();
64
65 if (th->top_wrapper) {
66 list = &ephemeral_end_procs;
67 }
68 else {
69 list = &end_procs;
70 }
71 link->next = *list;
72 link->func = func;
73 link->data = data;
74 *list = link;
75}
76
77void
78rb_mark_end_proc(void)
79{
80 struct end_proc_data *link;
81
82 link = end_procs;
83 while (link) {
84 rb_gc_mark(link->data);
85 link = link->next;
86 }
87 link = ephemeral_end_procs;
88 while (link) {
89 rb_gc_mark(link->data);
90 link = link->next;
91 }
92}
93
94static void
95exec_end_procs_chain(struct end_proc_data *volatile *procs, VALUE *errp)
96{
97 struct end_proc_data volatile endproc;
98 struct end_proc_data *link;
99 VALUE errinfo = *errp;
100
101 while ((link = *procs) != 0) {
102 *procs = link->next;
103 endproc = *link;
104 xfree(link);
105 (*endproc.func) (endproc.data);
106 *errp = errinfo;
107 }
108}
109
110static void
111rb_ec_exec_end_proc(rb_execution_context_t * ec)
112{
113 enum ruby_tag_type state;
114 volatile VALUE errinfo = ec->errinfo;
115
116 EC_PUSH_TAG(ec);
117 if ((state = EC_EXEC_TAG()) == TAG_NONE) {
118 again:
119 exec_end_procs_chain(&ephemeral_end_procs, &ec->errinfo);
120 exec_end_procs_chain(&end_procs, &ec->errinfo);
121 }
122 else {
123 EC_TMPPOP_TAG();
124 error_handle(ec, state);
125 if (!NIL_P(ec->errinfo)) errinfo = ec->errinfo;
126 EC_REPUSH_TAG();
127 goto again;
128 }
129 EC_POP_TAG();
130
131 ec->errinfo = errinfo;
132}
133
134void
135Init_jump(void)
136{
137 rb_define_global_function("at_exit", rb_f_at_exit, 0);
138}
rb_ary_new
VALUE rb_ary_new(void)
Definition: array.c:749
rb_define_global_function
#define rb_define_global_function(mid, func, arity)
Defines rb_mKernel #mid.
Definition: cxxanyargs.hpp:678
eval_intern.h
EC_EXEC_TAG
#define EC_EXEC_TAG()
Definition: eval_intern.h:193
EC_PUSH_TAG
#define EC_PUSH_TAG(ec)
Definition: eval_intern.h:130
EC_POP_TAG
#define EC_POP_TAG()
Definition: eval_intern.h:138
EC_REPUSH_TAG
#define EC_REPUSH_TAG()
Definition: eval_intern.h:145
EC_TMPPOP_TAG
#define EC_TMPPOP_TAG()
Definition: eval_intern.h:142
rb_mark_end_proc
void rb_mark_end_proc(void)
Definition: eval_jump.c:78
rb_set_end_proc
void rb_set_end_proc(void(*func)(VALUE), VALUE data)
Definition: eval_jump.c:59
rb_call_end_proc
void rb_call_end_proc(VALUE data)
Definition: eval_jump.c:11
Init_jump
void Init_jump(void)
Definition: eval_jump.c:135
rb_gc_mark
void rb_gc_mark(VALUE ptr)
Definition: gc.c:6112
rb_block_given_p
int rb_block_given_p(void)
Determines if the current method is given a block.
Definition: eval.c:935
rb_raise
void rb_raise(VALUE exc, const char *fmt,...)
Definition: error.c:2917
rb_eArgError
VALUE rb_eArgError
Definition: error.c:1058
rb_block_proc
VALUE rb_block_proc(void)
Definition: proc.c:826
rb_proc_call
VALUE rb_proc_call(VALUE, VALUE)
Definition: proc.c:981
NIL_P
#define NIL_P
Definition: special_consts.h:46
_
#define _(args)
Definition: stdarg.h:31
end_proc_data
Definition: eval_jump.c:50
end_proc_data::data
VALUE data
Definition: eval_jump.c:52
end_proc_data::func
void(* func)()
Definition: eval_jump.c:51
end_proc_data::next
struct end_proc_data * next
Definition: eval_jump.c:53
rb_execution_context_struct
Definition: vm_core.h:854
rb_execution_context_struct::errinfo
VALUE errinfo
Definition: vm_core.h:889
rb_thread_struct
Definition: vm_core.h:935
rb_thread_struct::top_wrapper
VALUE top_wrapper
Definition: vm_core.h:950
state
Definition: blast.c:41
ALLOC
#define ALLOC(size)
Definition: unzip.c:112
VALUE
unsigned long VALUE
Definition: value.h:38
TAG_NONE
#define TAG_NONE
Definition: vm_core.h:198
ruby_tag_type
ruby_tag_type
Definition: vm_core.h:185
link
int link(const char *, const char *)
Definition: win32.c:4987
xfree
#define xfree
Definition: xmalloc.h:49