rutie 0.12.1

The tie between Ruby and Rust.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218

use crate::rubysys::{
    constant::{
        FL_USER_1, FL_USER_3, FL_USER_4, FL_USER_5, FL_USER_6, FL_USER_7, FL_USER_8, FL_USER_9,
        FL_USHIFT,
    },
    libc::size_t,
    types::{c_int, c_long, InternalValue, RBasic, Value},
};

use std::mem;

#[cfg_attr(rutie_dllimport, link(name = "rutie_ruby"))]
extern "C" {
    // VALUE
    // rb_ary_concat(VALUE x, VALUE y)
    pub fn rb_ary_concat(array: Value, other_array: Value) -> Value;
    // VALUE
    // rb_ary_dup(VALUE ary)
    pub fn rb_ary_dup(array: Value) -> Value;
    // VALUE
    // rb_ary_freeze(VALUE ary)
    pub fn rb_ary_freeze(array: Value) -> Value;
    // VALUE
    // rb_ary_aref(int argc, const VALUE *argv, VALUE ary)
    pub fn rb_ary_aref(argc: c_int, argv: *const Value, array: Value) -> Value;
    // VALUE
    // rb_ary_assoc(VALUE ary, VALUE key)
    pub fn rb_ary_assoc(array: Value, key: Value) -> Value;
    // VALUE
    // rb_ary_clear(VALUE ary)
    pub fn rb_ary_clear(array: Value) -> Value;
    // VALUE
    // rb_ary_cmp(VALUE ary1, VALUE ary2)
    pub fn rb_ary_cmp(array: Value, other: Value) -> Value;
    // VALUE
    // rb_ary_delete(VALUE ary, VALUE item)
    pub fn rb_ary_delete(array: Value, item: Value) -> Value;
    // VALUE
    // rb_ary_delete_at(VALUE ary, long pos)
    pub fn rb_ary_delete_at(array: Value, position: c_long) -> Value;
    // VALUE
    // rb_ary_includes(VALUE ary, VALUE item)
    pub fn rb_ary_includes(array: Value, item: Value) -> Value;
    // VALUE
    // rb_ary_plus(VALUE x, VALUE y)
    pub fn rb_ary_plus(array: Value, other: Value) -> Value;
    // VALUE
    // rb_ary_rassoc(VALUE ary, VALUE value)
    pub fn rb_ary_rassoc(array: Value, value: Value) -> Value;
    // VALUE
    // rb_ary_replace(VALUE copy, VALUE orig)
    pub fn rb_ary_replace(copy: Value, original: Value) -> Value;
    // VALUE
    // rb_ary_resize(VALUE ary, long len)
    pub fn rb_ary_resize(array: Value, len: c_long) -> Value;
    // VALUE
    // rb_ary_rotate(VALUE ary, long cnt)
    pub fn rb_ary_rotate(array: Value, count: c_long) -> Value;
    // VALUE
    // rb_ary_subseq(VALUE ary, long beg, long len)
    //
    // `Qnil` when out of range.
    pub fn rb_ary_subseq(array: Value, begin: c_long, len: c_long) -> Value;
    // VALUE
    // rb_ary_to_ary(VALUE obj)
    pub fn rb_ary_to_ary(object: Value) -> Value;
    // VALUE
    // rb_check_array_type(VALUE ary)
    pub fn rb_check_array_type(object: Value) -> Value;
    // VALUE
    // rb_ary_entry(VALUE ary, long offset)
    pub fn rb_ary_entry(array: Value, offset: c_long) -> Value;
    // VALUE
    // rb_ary_join(VALUE ary, VALUE sep)
    pub fn rb_ary_join(array: Value, separator: Value) -> Value;
    // VALUE
    // rb_ary_new(void)
    pub fn rb_ary_new() -> Value;
    // VALUE
    // rb_ary_new_from_values(long n, const VALUE *elts)
    pub fn rb_ary_new_from_values(count: c_long, elements: *const Value) -> Value;
    // VALUE
    // rb_ary_new_capa(long capa)
    pub fn rb_ary_new_capa(capacity: c_long) -> Value;
    // VALUE
    // rb_ary_pop(VALUE ary)
    pub fn rb_ary_pop(array: Value) -> Value;
    // VALUE
    // rb_ary_push(VALUE ary, VALUE item)
    pub fn rb_ary_push(array: Value, item: Value) -> Value;
    // VALUE
    // rb_ary_reverse(VALUE ary)
    pub fn rb_ary_reverse(array: Value) -> Value;
    // VALUE
    // rb_ary_shift(VALUE ary)
    pub fn rb_ary_shift(array: Value) -> Value;
    // VALUE
    // rb_ary_sort_bang(VALUE ary)
    pub fn rb_ary_sort_bang(array: Value) -> Value;
    // VALUE
    // rb_ary_sort(VALUE ary)
    pub fn rb_ary_sort(array: Value) -> Value;
    // void
    // rb_ary_store(VALUE ary, long idx, VALUE val)
    pub fn rb_ary_store(array: Value, index: c_long, item: Value);
    // VALUE
    // rb_ary_to_s(VALUE ary)
    pub fn rb_ary_to_s(array: Value) -> Value;
    // VALUE
    // rb_ary_unshift(VALUE ary, VALUE item)
    pub fn rb_ary_unshift(array: Value, item: Value) -> Value;
    // VALUE
    // rb_ary_hidden_new(long capa)
    //
    // An empty array with room for `capa` elements and no class, invisible
    // to `ObjectSpace` (`rb_ary_tmp_new`). For C-level buffers only: it
    // must never reach Ruby code.
    #[cfg(ruby_gte_3_2)]
    pub fn rb_ary_hidden_new(capacity: c_long) -> Value;
}

// #[link_name = "ruby_rarray_flags"]
#[derive(Debug, PartialEq)]
#[repr(C)]
enum RArrayEmbed {
    Flag = FL_USER_1,
    // Ruby 3.2 (`USE_RVARGC`) embeds longer arrays and widens the mask.
    #[cfg(not(ruby_gte_3_2))]
    LenMask = FL_USER_4 | FL_USER_3,
    #[cfg(ruby_gte_3_2)]
    LenMask = FL_USER_9 | FL_USER_8 | FL_USER_7 | FL_USER_6 | FL_USER_5 | FL_USER_4 | FL_USER_3,
    LenShift = FL_USHIFT + 3,
}

#[repr(C)]
struct RArrayAs {
    heap: RArrayHeap,
}

#[repr(C)]
struct RArrayHeap {
    len: c_long,
    // Really, this is a union but value is the largest item.
    value: InternalValue,
    ptr: InternalValue,
}

#[repr(C)]
struct RArray {
    basic: RBasic,
    as_: RArrayAs,
}

pub unsafe fn rb_ary_len(value: Value) -> c_long {
    let rarray: *const RArray = value.value as *const RArray;
    let flags = (*rarray).basic.flags;

    if flags & (RArrayEmbed::Flag as size_t) == 0 {
        (*rarray).as_.heap.len
    } else {
        ((flags as i64 >> RArrayEmbed::LenShift as i64)
            & (RArrayEmbed::LenMask as i64 >> RArrayEmbed::LenShift as i64)) as c_long
    }
}

#[cfg(test)]
mod tests {
    use super::rb_ary_len;
    use crate::{Array, Fixnum, Object, VM};

    // A hidden array has no class, and holds what is pushed onto it.
    #[cfg(ruby_gte_3_2)]
    #[test]
    fn test_ary_hidden_new() {
        use super::{rb_ary_hidden_new, rb_ary_push, RBasic};

        crate::on_ruby_thread(|| unsafe {
            let array = rb_ary_hidden_new(4);

            assert_eq!((*(array.value as *const RBasic)).klass, 0);
            assert_eq!(rb_ary_len(array), 0);

            rb_ary_push(array, Fixnum::new(7).value());

            assert_eq!(rb_ary_len(array), 1);
        });
    }

    // Arrays across the embedded/heap boundary (3 elements on Ruby 3.1,
    // the slot size on 3.2), made in several ways, including shared slices.
    #[test]
    fn test_direct_rarray_len() {
        crate::on_ruby_thread(|| {
            let arrays = VM::eval(
                "(0..200).flat_map do |n|
                   a = Array.new(n) { |i| i }
                   grown = []; n.times { |i| grown << i }
                   [a, a.dup, grown, ([nil] + a)[1..], a.first(n), a.frozen? ? a : a.dup.freeze]
                 end",
            )
            .unwrap();
            let arrays = Array::from(arrays.value());

            for i in 0..arrays.length() {
                let array = arrays.at(i as i64);
                let length = unsafe { array.send("length", &[]) };
                let expected = length.try_convert_to::<Fixnum>().unwrap().to_i64();

                assert_eq!(
                    unsafe { rb_ary_len(array.value()) } as i64,
                    expected,
                    "array #{}",
                    i
                );
            }
        });
    }
}