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 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521
//! Types and functions for working with Ruby blocks and Procs.
use std::{fmt, mem::forget, ops::Deref, os::raw::c_int};
use rb_sys::{
rb_block_given_p, rb_block_proc, rb_data_typed_object_wrap, rb_obj_is_proc, rb_proc_arity,
rb_proc_call, rb_proc_lambda_p, rb_proc_new, rb_yield, rb_yield_splat, rb_yield_values2, VALUE,
};
use crate::{
enumerator::Enumerator,
error::{ensure, protect, Error},
exception, memoize,
method::{Block, BlockReturn},
object::Object,
r_array::RArray,
r_typed_data::{DataType, DataTypeFunctions},
try_convert::{ArgList, RArrayArgList, TryConvert},
value::{private, NonZeroValue, ReprValue, Value},
};
/// Wrapper type for a Value known to be an instance of Ruby’s Proc class.
///
/// All [`Value`] methods should be available on this type through [`Deref`],
/// but some may be missed by this documentation.
#[derive(Clone, Copy)]
#[repr(transparent)]
pub struct Proc(NonZeroValue);
impl Proc {
/// Return `Some(Proc)` if `val` is a `Proc`, `None` otherwise.
#[inline]
pub fn from_value(val: Value) -> Option<Self> {
unsafe {
Value::new(rb_obj_is_proc(val.as_rb_value()))
.to_bool()
.then(|| Self(NonZeroValue::new_unchecked(val)))
}
}
#[inline]
pub(crate) unsafe fn from_rb_value_unchecked(val: VALUE) -> Self {
Self(NonZeroValue::new_unchecked(Value::new(val)))
}
/// Create a new `Proc`.
///
/// As `block` is a function pointer, only functions and closures that do
/// not capture any variables are permitted. For more flexibility (at the
/// cost of allocating) see [`from_fn`](Proc::from_fn).
///
/// # Examples
///
/// ```
/// use magnus::{block::Proc, eval};
/// # let _cleanup = unsafe { magnus::embed::init() };
///
/// let proc = Proc::new(|args, _block| {
/// let acc = args.get(0).unwrap().try_convert::<i64>()?;
/// let i = args.get(1).unwrap().try_convert::<i64>()?;
/// Ok(acc + i)
/// });
///
/// let res: bool = eval!("proc.call(1, 2) == 3", proc).unwrap();
/// assert!(res);
///
/// let res: bool = eval!("[1, 2, 3, 4, 5].inject(&proc) == 15", proc).unwrap();
/// assert!(res);
/// ```
pub fn new<R>(block: fn(&[Value], Option<Proc>) -> R) -> Self
where
R: BlockReturn,
{
unsafe extern "C" fn call<R>(
_yielded_arg: VALUE,
callback_arg: VALUE,
argc: c_int,
argv: *const VALUE,
blockarg: VALUE,
) -> VALUE
where
R: BlockReturn,
{
let func = std::mem::transmute::<VALUE, fn(&[Value], Option<Proc>) -> R>(callback_arg);
Block::new(func)
.call_handle_error(argc, argv as *const Value, Value::new(blockarg))
.as_rb_value()
}
let call_func =
call::<R> as unsafe extern "C" fn(VALUE, VALUE, c_int, *const VALUE, VALUE) -> VALUE;
#[cfg(ruby_lt_2_7)]
let call_func: unsafe extern "C" fn() -> VALUE = unsafe { std::mem::transmute(call_func) };
unsafe {
#[allow(clippy::fn_to_numeric_cast)]
Proc::from_rb_value_unchecked(rb_proc_new(Some(call_func), block as VALUE))
}
}
/// Create a new `Proc`.
///
/// See also [`Proc::new`], which is more efficient when `block` is a
/// function or closure that does not capture any variables.
///
/// # Examples
///
/// ```
/// use magnus::{block::Proc, eval};
/// # let _cleanup = unsafe { magnus::embed::init() };
///
/// let proc = Proc::from_fn(|args, _block| {
/// let acc = args.get(0).unwrap().try_convert::<i64>()?;
/// let i = args.get(1).unwrap().try_convert::<i64>()?;
/// Ok(acc + i)
/// });
///
/// let res: bool = eval!("proc.call(1, 2) == 3", proc).unwrap();
/// assert!(res);
///
/// let res: bool = eval!("[1, 2, 3, 4, 5].inject(&proc) == 15", proc).unwrap();
/// assert!(res);
/// ```
pub fn from_fn<F, R>(block: F) -> Self
where
F: 'static + Send + FnMut(&[Value], Option<Proc>) -> R,
R: BlockReturn,
{
unsafe extern "C" fn call<F, R>(
_yielded_arg: VALUE,
callback_arg: VALUE,
argc: c_int,
argv: *const VALUE,
blockarg: VALUE,
) -> VALUE
where
F: FnMut(&[Value], Option<Proc>) -> R,
R: BlockReturn,
{
let closure = &mut *(callback_arg as *mut F);
Block::new(closure)
.call_handle_error(argc, argv as *const Value, Value::new(blockarg))
.as_rb_value()
}
let (closure, keepalive) = wrap_closure(block);
let call_func =
call::<F, R> as unsafe extern "C" fn(VALUE, VALUE, c_int, *const VALUE, VALUE) -> VALUE;
#[cfg(ruby_lt_2_7)]
let call_func: unsafe extern "C" fn() -> VALUE = unsafe { std::mem::transmute(call_func) };
let proc = unsafe {
Proc::from_rb_value_unchecked(rb_proc_new(Some(call_func), closure as VALUE))
};
// ivar without @ prefix is invisible from Ruby
proc.ivar_set("__rust_closure", keepalive).unwrap();
proc
}
/// Call the proc with `args`.
///
/// Returns `Ok(T)` if the proc runs without error and the return value
/// converts into a `T`, or returns `Err` if the proc raises or the
/// conversion fails.
pub fn call<A, T>(self, args: A) -> Result<T, Error>
where
A: RArrayArgList,
T: TryConvert,
{
let args = args.into_array_arg_list();
unsafe {
protect(|| Value::new(rb_proc_call(self.as_rb_value(), args.as_rb_value())))
.and_then(|v| v.try_convert())
}
}
/// Returns the number of arguments `self` takes.
///
/// If `self` takes no arguments, returns `0`.
/// If `self` takes only required arguments, returns the number of required
/// arguments.
/// If `self` is a lambda and has optional arguments, or is not a lambda
/// and takes a splat argument, returns `-n-1`, where `n` is the number of
/// required arguments.
/// If `self` is not a lambda, and takes a finite number of optional
/// arguments, returns the number of required arguments.
/// Keyword arguments are considered as a single additional argument, that
/// argument being required if any keyword argument is required.
///
/// # Examples
///
/// ```
/// use magnus::{block::Proc, eval};
/// # let _cleanup = unsafe { magnus::embed::init() };
///
/// let proc = eval::<Proc>("proc {nil}", ).unwrap();
/// assert_eq!(proc.arity(), 0);
///
/// let proc = eval::<Proc>("proc {|a| a + 1}", ).unwrap();
/// assert_eq!(proc.arity(), 1);
///
/// let proc = eval::<Proc>("proc {|a, b| a + b}", ).unwrap();
/// assert_eq!(proc.arity(), 2);
///
/// let proc = eval::<Proc>("proc {|*args| args.sum}", ).unwrap();
/// assert_eq!(proc.arity(), -1);
/// ```
pub fn arity(self) -> i64 {
unsafe { rb_proc_arity(self.as_rb_value()) as i64 }
}
/// Returns whether or not `self` is a lambda.
///
/// # Examples
///
/// ```
/// use magnus::{block::Proc, eval};
/// # let _cleanup = unsafe { magnus::embed::init() };
///
/// let proc = eval::<Proc>("proc {|a, b| a + b}", ).unwrap();
/// assert!(!proc.is_lambda());
///
/// let proc = eval::<Proc>("lambda {|a, b| a + b}", ).unwrap();
/// assert!(proc.is_lambda());
/// ```
pub fn is_lambda(self) -> bool {
unsafe { Value::new(rb_proc_lambda_p(self.as_rb_value())).to_bool() }
}
}
impl Deref for Proc {
type Target = Value;
fn deref(&self) -> &Self::Target {
self.0.get_ref()
}
}
impl fmt::Display for Proc {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "{}", unsafe { self.to_s_infallible() })
}
}
impl fmt::Debug for Proc {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "{}", self.inspect())
}
}
impl From<Proc> for Value {
fn from(val: Proc) -> Self {
*val
}
}
impl Object for Proc {}
unsafe impl private::ReprValue for Proc {
fn to_value(self) -> Value {
*self
}
unsafe fn from_value_unchecked(val: Value) -> Self {
Self(NonZeroValue::new_unchecked(val))
}
}
impl ReprValue for Proc {}
impl TryConvert for Proc {
fn try_convert(val: Value) -> Result<Self, Error> {
if let Some(p) = Proc::from_value(val) {
return Ok(p);
}
let p_val: Value = match val.funcall("to_proc", ()) {
Ok(v) => v,
Err(_) => {
return Err(Error::new(
exception::type_error(),
format!("no implicit conversion of {} into Proc", unsafe {
val.classname()
},),
))
}
};
Proc::from_value(val).ok_or_else(|| {
Error::new(
exception::type_error(),
format!(
"can't convert {0} to Proc ({0}#to_proc gives {1})",
unsafe { val.classname() },
unsafe { p_val.classname() },
),
)
})
}
}
/// Wrap a closure in a Ruby object with no class.
///
/// This effectivly makes the closure's lifetime managed by Ruby. It will be
/// dropped when the returned `Value` is garbage collected.
fn wrap_closure<F, R>(func: F) -> (*mut F, Value)
where
F: FnMut(&[Value], Option<Proc>) -> R,
R: BlockReturn,
{
struct Closure();
impl DataTypeFunctions for Closure {}
let data_type = memoize!(DataType: {
let mut builder = DataType::builder::<Closure>("rust closure");
builder.free_immediately();
builder.build()
});
let boxed = Box::new(func);
let ptr = Box::into_raw(boxed);
let value = unsafe {
Value::new(rb_data_typed_object_wrap(
0, // using 0 for the class will hide the object from ObjectSpace
ptr as *mut _,
data_type.as_rb_data_type() as *const _,
))
};
(ptr, value)
}
/// Returns whether a Ruby block has been supplied to the current method.
pub fn block_given() -> bool {
unsafe { rb_block_given_p() != 0 }
}
/// Returns the block given to the current method as a [`Proc`] instance.
pub fn block_proc() -> Result<Proc, Error> {
let val = unsafe { protect(|| Value::new(rb_block_proc()))? };
Ok(Proc::from_value(val).unwrap())
}
/// Yields a value to the block given to the current method.
///
/// **Note:** A method using `yield_value` converted to an Enumerator with
/// `to_enum`/[`Value::enumeratorize`] will result in a non-functional
/// Enumerator. See [`Yield`] for an alternative.
pub fn yield_value<T, U>(val: T) -> Result<U, Error>
where
T: Into<Value>,
U: TryConvert,
{
let val = val.into();
unsafe { protect(|| Value::new(rb_yield(val.as_rb_value()))).and_then(|v| v.try_convert()) }
}
/// Yields multiple values to the block given to the current method.
///
/// **Note:** A method using `yield_values` converted to an Enumerator with
/// `to_enum`/[`Value::enumeratorize`] will result in a non-functional
/// Enumerator. See [`YieldValues`] for an alternative.
pub fn yield_values<T, U>(vals: T) -> Result<U, Error>
where
T: ArgList,
U: TryConvert,
{
let vals = vals.into_arg_list();
let slice = vals.as_ref();
unsafe {
protect(|| {
Value::new(rb_yield_values2(
slice.len() as c_int,
slice.as_ptr() as *const VALUE,
))
})
.and_then(|v| v.try_convert())
}
}
/// Yields a Ruby Array to the block given to the current method.
///
/// **Note:** A method using `yield_splat` converted to an Enumerator with
/// `to_enum`/[`Value::enumeratorize`] will result in a non-functional
/// Enumerator. See [`YieldSplat`] for an alternative.
pub fn yield_splat<T>(vals: RArray) -> Result<T, Error>
where
T: TryConvert,
{
unsafe {
protect(|| Value::new(rb_yield_splat(vals.as_rb_value()))).and_then(|v| v.try_convert())
}
}
// Our regular implementation of `yield` breaks yielding methods being
// converted to Enumerators because of the protect call not being compatible
// with the fibers used in Ruby itself to impliment `Enumerator#next`.
// We have to use protect in `yield` because otherwise Ruby code can
// `break`/`return` through Rust code and break Rust invariants.
// This gives up using `protect` by instead using `ensure`, not exposing the
// `yield` call to user code, and maintaining the invariants ourselves. As it
// can still be `brake`/`return`ed though it can't be public as it's only safe
// to call as the last thing in one of our method wrappers (where the raise
// would normally go). Returning an iterator from a method will trigger this.
pub(crate) unsafe fn do_yield_iter<I, T>(mut iter: I)
where
I: Iterator<Item = T>,
T: Into<Value>,
{
let ptr = &mut iter as *mut I;
forget(iter); // we're going to drop this ourself;
// ensure runs the first closure, but yield may raise, so the first
// closure might never reach the end, so wouldn't drop. The second
// closure is always run, and always after the first, so we do the
// drop there
ensure(
|| {
for val in &mut *ptr {
rb_yield(val.into().as_rb_value());
}
Value::default()
},
|| {
ptr.drop_in_place();
},
);
}
// see do_yield_iter
pub(crate) unsafe fn do_yield_values_iter<I, T>(mut iter: I)
where
I: Iterator<Item = T>,
T: ArgList,
{
let ptr = &mut iter as *mut I;
forget(iter);
ensure(
|| {
for val in &mut *ptr {
let vals = val.into_arg_list();
let slice = vals.as_ref();
rb_yield_values2(slice.len() as c_int, slice.as_ptr() as *const VALUE);
}
Value::default()
},
|| {
ptr.drop_in_place();
},
);
}
// see do_yield_iter
pub(crate) unsafe fn do_yield_splat_iter<I>(mut iter: I)
where
I: Iterator<Item = RArray>,
{
let ptr = &mut iter as *mut I;
forget(iter);
ensure(
|| {
for val in &mut *ptr {
rb_yield_splat(val.as_rb_value());
}
Value::default()
},
|| {
ptr.drop_in_place();
},
);
}
/// Helper type for functions that either yield a single value to a block or
/// return an Enumerator.
///
/// `I` must implement `Iterator<Item = T>`, where `T` implements `Into<Value>`.
///
/// # Examples
///
/// ```
/// use magnus::{block::{block_given, Yield}, Value};
///
/// fn count_to_3(rb_self: Value) -> Yield<impl Iterator<Item = u8>> {
/// if block_given() {
/// Yield::Iter((1..=3).into_iter())
/// } else {
/// Yield::Enumerator(rb_self.enumeratorize("count_to_3", ()))
/// }
/// }
/// ```
/// Could be called from Ruby like:
/// ``` text
/// a = []
/// count_to_3 {|i| a << i} #=> nil
/// a #=> [1,2,3]
/// enumerator = count_to_3
/// enumerator.next #=> 1
/// enumerator.next #=> 2
/// ```
pub enum Yield<I> {
/// Yields `I::Item` to given block.
Iter(I),
/// Returns `Enumerator` from the method.
Enumerator(Enumerator),
}
/// Helper type for functions that either yield multiple values to a block or
/// return an Enumerator.
///
/// `I` must implement `Iterator<Item = T>`, where `T` implements [`ArgList`].
pub enum YieldValues<I> {
/// Yields `I::Item` to given block.
Iter(I),
/// Returns `Enumerator` from the method.
Enumerator(Enumerator),
}
/// Helper type for functions that either yield an array to a block or
/// return an Enumerator.
///
/// `I` must implement `Iterator<Item = RArray>`.
pub enum YieldSplat<I> {
/// Yields `I::Item` to given block.
Iter(I),
/// Returns `Enumerator` from the method.
Enumerator(Enumerator),
}