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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
use std::convert::From;
use crate::{
binding::{class, rstruct, vm},
rubysys::rstruct::rb_cStruct,
types::Value,
AnyException, AnyObject, Array, Class, Exception, Fixnum, Integer, NilClass, Object, Symbol,
VerifiedObject,
};
/// `Struct`, an instance of a class made with Ruby's `Struct.new`.
#[derive(Debug)]
#[repr(C)]
pub struct Struct {
value: Value,
}
impl Struct {
/// Defines an anonymous `Struct` class with the given members (Ruby's
/// `Struct.new(:a, :b)`), or returns the error, such as the
/// `ArgumentError` for a duplicate member.
///
/// # Examples
///
/// ```
/// use rutie::{Fixnum, Object, Struct, VM};
/// # VM::init();
///
/// let point = Struct::define(&["x", "y"]).unwrap();
/// let instance = Struct::new_instance(&point, &[Fixnum::new(1).into(), Fixnum::new(2).into()]).unwrap();
///
/// assert_eq!(instance.get("y").unwrap().try_convert_to::<Fixnum>(), Ok(Fixnum::new(2)));
/// assert!(Struct::define(&["x", "x"]).is_err());
/// ```
pub fn define(members: &[&str]) -> Result<Class, AnyException> {
let members: Vec<Value> = members
.iter()
.map(|name| Symbol::new(name).value())
.collect();
let struct_class = unsafe { rb_cStruct };
vm::protect_value(|| vm::call_method(struct_class, "new", &members))
.map(Class::from)
.map_err(AnyException::from)
}
/// Defines a `Struct` class named `name` inside `outer` (a `Class` or
/// `Module`), like `rb_struct_define_under`, or returns the error for an
/// invalid name.
///
/// # Examples
///
/// ```
/// use rutie::{Class, Module, Object, Struct, VM};
/// # VM::init();
///
/// let geometry = Module::new("Geometry");
/// let point = Struct::define_under(&geometry, "Point", &["x", "y"]).unwrap();
///
/// assert_eq!(point.path().to_str(), "Geometry::Point");
/// assert!(Struct::define_under(&geometry, "lowercase", &["x"]).is_err());
/// ```
pub fn define_under<T: Object>(
outer: &T,
name: &str,
members: &[&str],
) -> Result<Class, AnyException> {
if !Symbol::new(name).is_const_name() {
let message = format!("identifier {} needs to be constant", name);
return Err(AnyException::new("NameError", Some(&message)));
}
let struct_class = Struct::define(members)?;
class::const_set(outer.value(), name, struct_class.value());
Ok(struct_class)
}
/// Creates an instance of the `Struct` class `klass` with `values` for
/// its members, in order (`rb_struct_alloc`). Missing values are `nil`;
/// too many values, or a class that is not a `Struct`, are an error.
///
/// # Examples
///
/// ```
/// use rutie::{Fixnum, Object, Struct, VM};
/// # VM::init();
///
/// let pair = Struct::define(&["left", "right"]).unwrap();
///
/// let partial = Struct::new_instance(&pair, &[Fixnum::new(1).into()]).unwrap();
/// assert!(partial.get("right").unwrap().is_nil());
///
/// let values = [Fixnum::new(1).into(), Fixnum::new(2).into(), Fixnum::new(3).into()];
/// assert!(Struct::new_instance(&pair, &values).is_err());
/// ```
pub fn new_instance(klass: &Class, values: &[AnyObject]) -> Result<Self, AnyException> {
let klass = klass.value();
let values: Array = values.iter().cloned().collect();
let instance = vm::protect_value(|| rstruct::alloc(klass, values.value()))
.map_err(AnyException::from)?;
if class::is_kind_of(instance, unsafe { rb_cStruct }) {
Ok(Struct::from(instance))
} else {
Err(AnyException::new("TypeError", Some("not a Struct class")))
}
}
/// Returns the member names of the `Struct` class `klass` as `Symbol`s
/// (`rb_struct_s_members`), or the `TypeError` if it is not a `Struct`
/// class.
///
/// # Examples
///
/// ```
/// use rutie::{Class, Object, Struct, Symbol, VM};
/// # VM::init();
///
/// let pair = Struct::define(&["left", "right"]).unwrap();
/// let members = Struct::members_of(&pair).unwrap();
///
/// assert_eq!(members.at(1).try_convert_to::<Symbol>(), Ok(Symbol::new("right")));
/// assert!(Struct::members_of(&Class::from_existing("String")).is_err());
/// ```
pub fn members_of(klass: &Class) -> Result<Array, AnyException> {
let klass = klass.value();
vm::protect_value(|| rstruct::class_members(klass))
.map(Array::from)
.map_err(AnyException::from)
}
/// Returns the value of member `name`, or `None` if there is no such
/// member (`rb_struct_getmember`).
///
/// # Examples
///
/// ```
/// use rutie::{Fixnum, Object, Struct, VM};
/// # VM::init();
///
/// let point = VM::eval("Struct.new(:x).new(4)").unwrap().try_convert_to::<Struct>().unwrap();
///
/// assert_eq!(point.get("x").unwrap().try_convert_to::<Fixnum>(), Ok(Fixnum::new(4)));
/// assert!(point.get("z").is_none());
/// ```
pub fn get(&self, name: &str) -> Option<AnyObject> {
let object = self.value();
vm::protect_value(|| rstruct::get_member(object, name))
.map(AnyObject::from)
.ok()
}
/// Returns the value of the member at `index` (from the end when
/// negative), or `None` when out of range (`rb_struct_aref`).
///
/// # Examples
///
/// ```
/// use rutie::{Fixnum, Object, Struct, VM};
/// # VM::init();
///
/// let pair = VM::eval("Struct.new(:a, :b).new(1, 2)").unwrap().try_convert_to::<Struct>().unwrap();
///
/// assert_eq!(pair.at(-1).unwrap().try_convert_to::<Fixnum>(), Ok(Fixnum::new(2)));
/// assert!(pair.at(2).is_none());
/// ```
pub fn at(&self, index: i64) -> Option<AnyObject> {
let (object, index) = (self.value(), Integer::new(index).value());
vm::protect_value(|| rstruct::aref(object, index))
.map(AnyObject::from)
.ok()
}
/// Sets member `name` to `value` (`rb_struct_aset`), or returns the
/// error: a `NameError` for an unknown member, a `FrozenError` for a
/// frozen struct.
///
/// # Examples
///
/// ```
/// use rutie::{Fixnum, Object, Struct, VM};
/// # VM::init();
///
/// let mut point = VM::eval("Struct.new(:x).new(1)").unwrap().try_convert_to::<Struct>().unwrap();
///
/// point.set("x", Fixnum::new(9)).unwrap();
///
/// assert_eq!(point.get("x").unwrap().try_convert_to::<Fixnum>(), Ok(Fixnum::new(9)));
/// assert!(point.set("y", Fixnum::new(1)).is_err());
/// ```
pub fn set<T: Object>(&mut self, name: &str, value: T) -> Result<(), AnyException> {
let (object, name, value) = (self.value(), Symbol::new(name).value(), value.value());
vm::protect_value(|| rstruct::aset(object, name, value))
.map(|_| ())
.map_err(AnyException::from)
}
/// Returns the member names as `Symbol`s (`rb_struct_members`).
///
/// # Examples
///
/// ```
/// use rutie::{Object, Struct, Symbol, VM};
/// # VM::init();
///
/// let pair = VM::eval("Struct.new(:a, :b).new").unwrap().try_convert_to::<Struct>().unwrap();
///
/// assert_eq!(pair.members().at(0).try_convert_to::<Symbol>(), Ok(Symbol::new("a")));
/// ```
pub fn members(&self) -> Array {
Array::from(rstruct::members(self.value()))
}
/// Returns the number of members (`rb_struct_size`).
///
/// # Examples
///
/// ```
/// use rutie::{Object, Struct, VM};
/// # VM::init();
///
/// let pair = VM::eval("Struct.new(:a, :b).new").unwrap().try_convert_to::<Struct>().unwrap();
///
/// assert_eq!(pair.size(), 2);
/// ```
pub fn size(&self) -> usize {
Fixnum::from(rstruct::size(self.value())).to_i64() as usize
}
}
impl From<Value> for Struct {
fn from(value: Value) -> Self {
Struct { value }
}
}
impl Into<Value> for Struct {
fn into(self) -> Value {
self.value
}
}
impl Into<AnyObject> for Struct {
fn into(self) -> AnyObject {
AnyObject::from(self.value)
}
}
impl Object for Struct {
#[inline]
fn value(&self) -> Value {
self.value
}
}
impl VerifiedObject for Struct {
fn is_correct_type<T: Object>(object: &T) -> bool {
class::is_kind_of(object.value(), unsafe { rb_cStruct })
}
fn error_message() -> &'static str {
"Error converting to Struct"
}
}
impl PartialEq for Struct {
fn eq(&self, other: &Self) -> bool {
self.equals(other)
}
}
#[cfg(test)]
mod tests {
use crate::{Class, Fixnum, Module, Object, Struct, Symbol, GC, VM};
#[test]
fn test_struct() {
crate::on_ruby_thread(|| {
let point = Struct::define(&["x", "y"]).unwrap();
let mut instance =
Struct::new_instance(&point, &[Fixnum::new(1).into(), Fixnum::new(2).into()])
.unwrap();
GC::start();
assert_eq!(instance.size(), 2);
assert_eq!(
instance.at(0).unwrap().try_convert_to::<Fixnum>(),
Ok(Fixnum::new(1))
);
assert!(instance.at(-3).is_none());
assert_eq!(
instance.members().at(1).try_convert_to::<Symbol>(),
Ok(Symbol::new("y"))
);
instance.set("x", Fixnum::new(10)).unwrap();
let sum = unsafe { instance.send("x", &[]) };
assert_eq!(sum.try_convert_to::<Fixnum>(), Ok(Fixnum::new(10)));
let mut frozen = instance.dup().freeze();
assert!(frozen.set("x", Fixnum::new(0)).is_err());
let outer = Module::new("RutieStructTest");
let named = Struct::define_under(&outer, "Pair", &["a"]).unwrap();
assert_eq!(named.name().unwrap().to_str(), "RutieStructTest::Pair");
let from_ruby = VM::eval("RutieStructTest::Pair.new(5)")
.unwrap()
.try_convert_to::<Struct>()
.unwrap();
assert_eq!(
from_ruby.get("a").unwrap().try_convert_to::<Fixnum>(),
Ok(Fixnum::new(5))
);
assert!(Struct::new_instance(&Class::from_existing("Object"), &[]).is_err());
assert!(Struct::define(&["x", "x"]).is_err());
assert!(VM::eval("1..2")
.unwrap()
.try_convert_to::<Struct>()
.is_err());
});
}
#[test]
fn test_struct_members_of() {
crate::on_ruby_thread(|| {
let point = Struct::define(&["x", "y"]).unwrap();
GC::start();
let members = Struct::members_of(&point).unwrap();
let names: Vec<String> = members
.into_iter()
.map(|member| member.try_convert_to::<Symbol>().unwrap().to_string())
.collect();
assert_eq!(names, vec!["x", "y"]);
// A class that is not a Struct has no members.
assert!(Struct::members_of(&Class::object()).is_err());
});
}
}