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
use std::{
fmt,
ops::Deref,
os::raw::{c_long, c_longlong, c_ulong, c_ulonglong},
};
use rb_sys::{
rb_ll2inum, rb_num2ll, rb_num2long, rb_num2ull, rb_num2ulong, rb_ull2inum, ruby_fl_type,
ruby_value_type, VALUE,
};
use crate::{
debug_assert_value,
error::{protect, Error},
exception,
integer::{Integer, IntegerType},
try_convert::TryConvert,
value::{private, Fixnum, NonZeroValue, ReprValue, Value, QNIL},
};
/// A Value pointer to a RBignum struct, Ruby's internal representation of
/// large integers.
///
/// See also [`Integer`].
///
/// 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 RBignum(NonZeroValue);
impl RBignum {
/// Return `Some(RBignum)` if `val` is a `RBignum`, `None` otherwise.
///
/// # Examples
///
/// ```
/// use magnus::{eval, RBignum};
/// # let _cleanup = unsafe { magnus::embed::init() };
///
/// assert!(RBignum::from_value(eval("9223372036854775807").unwrap()).is_some());
/// // too small
/// assert!(RBignum::from_value(eval("0").unwrap()).is_none());
/// // not an int
/// assert!(RBignum::from_value(eval("1.23").unwrap()).is_none());
/// ```
#[inline]
pub fn from_value(val: Value) -> Option<Self> {
unsafe {
(val.rb_type() == ruby_value_type::RUBY_T_BIGNUM)
.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 `RBignum` from an `i64.`
///
/// Returns `Ok(RBignum)` if `n` is large enough to require a bignum,
/// otherwise returns `Err(Fixnum)`.
///
/// # Examples
///
/// ```
/// use magnus::{eval, RBignum};
/// # let _cleanup = unsafe { magnus::embed::init() };
///
/// assert!(RBignum::from_i64(4611686018427387904).is_ok());
/// assert!(RBignum::from_i64(-4611686018427387905).is_ok());
/// // too small
/// assert!(RBignum::from_i64(0).is_err());
/// ```
pub fn from_i64(n: i64) -> Result<Self, Fixnum> {
unsafe {
let val = Value::new(rb_ll2inum(n));
RBignum::from_value(val)
.ok_or_else(|| Fixnum::from_rb_value_unchecked(val.as_rb_value()))
}
}
/// Create a new `RBignum` from an `u64.`
///
/// Returns `Ok(RBignum)` if `n` is large enough to require a bignum,
/// otherwise returns `Err(Fixnum)`.
///
/// # Examples
///
/// ```
/// use magnus::{eval, RBignum};
/// # let _cleanup = unsafe { magnus::embed::init() };
///
/// assert!(RBignum::from_u64(4611686018427387904).is_ok());
/// // too small
/// assert!(RBignum::from_u64(0).is_err());
/// ```
pub fn from_u64(n: u64) -> Result<Self, Fixnum> {
unsafe {
let val = Value::new(rb_ull2inum(n));
RBignum::from_value(val)
.ok_or_else(|| Fixnum::from_rb_value_unchecked(val.as_rb_value()))
}
}
fn is_negative(self) -> bool {
debug_assert_value!(self);
unsafe {
let r_basic = self.r_basic_unchecked();
r_basic.as_ref().flags & (ruby_fl_type::RUBY_FL_USER1 as VALUE) == 0
}
}
/// Create a new `RBignum` from a `i32.`
///
/// This will only succeed on a 32 bit system. On a 64 bit system bignum
/// will always be out of range.
#[doc(hidden)]
pub fn to_i32(self) -> Result<i32, Error> {
debug_assert_value!(self);
let mut res = 0;
protect(|| {
res = unsafe { rb_num2long(self.as_rb_value()) };
QNIL
})?;
if res > i32::MAX as c_long {
return Err(Error::new(
exception::range_error(),
"bignum too big to convert into `i32`",
));
}
Ok(res as i32)
}
/// Convert `self` to an `i64`. Returns `Err` if `self` is out of range for
/// `i64`.
///
/// # Examples
///
/// ```
/// use magnus::{eval, RBignum};
/// # let _cleanup = unsafe { magnus::embed::init() };
///
/// assert_eq!(eval::<RBignum>("4611686018427387904").unwrap().to_i64().unwrap(), 4611686018427387904);
/// assert_eq!(eval::<RBignum>("-4611686018427387905").unwrap().to_i64().unwrap(), -4611686018427387905);
/// assert!(eval::<RBignum>("9223372036854775808").unwrap().to_i64().is_err());
/// assert!(eval::<RBignum>("-9223372036854775809").unwrap().to_i64().is_err());
/// ```
pub fn to_i64(self) -> Result<i64, Error> {
debug_assert_value!(self);
let mut res = 0;
protect(|| {
res = unsafe { rb_num2ll(self.as_rb_value()) };
QNIL
})?;
Ok(res)
}
/// Convert `self` to an `isize`. Returns `Err` if `self` is out of range
/// for `isize`.
///
/// # Examples
///
/// ```
/// use magnus::{eval, RBignum};
/// # let _cleanup = unsafe { magnus::embed::init() };
///
/// assert_eq!(eval::<RBignum>("4611686018427387904").unwrap().to_isize().unwrap(), 4611686018427387904);
/// assert_eq!(eval::<RBignum>("-4611686018427387905").unwrap().to_isize().unwrap(), -4611686018427387905);
/// ```
pub fn to_isize(self) -> Result<isize, Error> {
debug_assert_value!(self);
let mut res = 0;
protect(|| {
res = unsafe { rb_num2ll(self.as_rb_value()) };
QNIL
})?;
if res > isize::MAX as c_longlong {
return Err(Error::new(
exception::range_error(),
"bignum too big to convert into `isize`",
));
}
Ok(res as isize)
}
/// Create a new `RBignum` from a `u32.`
///
/// This will only succeed on a 32 bit system. On a 64 bit system bignum
/// will always be out of range.
#[doc(hidden)]
pub fn to_u32(self) -> Result<u32, Error> {
debug_assert_value!(self);
if self.is_negative() {
return Err(Error::new(
exception::range_error(),
"can't convert negative integer to unsigned",
));
}
let mut res = 0;
protect(|| {
res = unsafe { rb_num2ulong(self.as_rb_value()) };
QNIL
})?;
if res > u32::MAX as c_ulong {
return Err(Error::new(
exception::range_error(),
"bignum too big to convert into `u32`",
));
}
Ok(res as u32)
}
/// Convert `self` to a `u64`. Returns `Err` if `self` is negative or out
/// of range for `u64`.
///
/// # Examples
///
/// ```
/// use magnus::{eval, RBignum};
/// # let _cleanup = unsafe { magnus::embed::init() };
///
/// assert_eq!(eval::<RBignum>("4611686018427387904").unwrap().to_u64().unwrap(), 4611686018427387904);
/// assert!(eval::<RBignum>("18446744073709551616").unwrap().to_u64().is_err());
/// ```
pub fn to_u64(self) -> Result<u64, Error> {
debug_assert_value!(self);
if self.is_negative() {
return Err(Error::new(
exception::range_error(),
"can't convert negative integer to unsigned",
));
}
let mut res = 0;
protect(|| {
res = unsafe { rb_num2ull(self.as_rb_value()) };
QNIL
})?;
Ok(res)
}
/// Convert `self` to a `usize`. Returns `Err` if `self` is negative or out
/// of range for `usize`.
///
/// # Examples
///
/// ```
/// use magnus::{eval, RBignum};
/// # let _cleanup = unsafe { magnus::embed::init() };
///
/// assert_eq!(eval::<RBignum>("4611686018427387904").unwrap().to_usize().unwrap(), 4611686018427387904);
/// assert!(eval::<RBignum>("18446744073709551616").unwrap().to_usize().is_err());
/// ```
pub fn to_usize(self) -> Result<usize, Error> {
debug_assert_value!(self);
if self.is_negative() {
return Err(Error::new(
exception::range_error(),
"can't convert negative integer to unsigned",
));
}
let mut res = 0;
protect(|| {
res = unsafe { rb_num2ull(self.as_rb_value()) };
QNIL
})?;
if res > usize::MAX as c_ulonglong {
return Err(Error::new(
exception::range_error(),
"bignum too big to convert into `usize`",
));
}
Ok(res as usize)
}
}
impl Deref for RBignum {
type Target = Value;
fn deref(&self) -> &Self::Target {
self.0.get_ref()
}
}
impl fmt::Display for RBignum {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "{}", unsafe { self.to_s_infallible() })
}
}
impl fmt::Debug for RBignum {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "{}", self.inspect())
}
}
impl From<RBignum> for Value {
fn from(val: RBignum) -> Self {
*val
}
}
unsafe impl private::ReprValue for RBignum {
fn to_value(self) -> Value {
*self
}
unsafe fn from_value_unchecked(val: Value) -> Self {
Self(NonZeroValue::new_unchecked(val))
}
}
impl ReprValue for RBignum {}
impl TryConvert for RBignum {
fn try_convert(val: Value) -> Result<Self, Error> {
match val.try_convert::<Integer>()?.integer_type() {
IntegerType::Fixnum(_) => Err(Error::new(
exception::range_error(),
"integer to small for bignum",
)),
IntegerType::Bignum(big) => Ok(big),
}
}
}