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 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667
use crate::eval::calc_index;
use crate::plugin::*;
use crate::FuncRegistration;
use crate::{
def_package, ExclusiveRange, InclusiveRange, RhaiResultOf, ERR, INT, INT_BITS, MAX_USIZE_INT,
};
#[cfg(feature = "no_std")]
use std::prelude::v1::*;
use std::{
any::type_name,
cmp::Ordering,
fmt::Debug,
iter::{ExactSizeIterator, FusedIterator},
ops::{Range, RangeInclusive},
vec::IntoIter,
};
#[cfg(not(feature = "no_float"))]
use crate::FLOAT;
#[cfg(feature = "decimal")]
use rust_decimal::Decimal;
#[cfg(not(feature = "unchecked"))]
#[inline(always)]
#[allow(clippy::needless_pass_by_value)]
fn std_add<T>(x: T, y: T) -> Option<T>
where
T: num_traits::CheckedAdd<Output = T>,
{
x.checked_add(&y)
}
#[inline(always)]
#[allow(dead_code)]
#[allow(clippy::unnecessary_wraps, clippy::needless_pass_by_value)]
fn regular_add<T>(x: T, y: T) -> Option<T>
where
T: std::ops::Add<Output = T>,
{
Some(x + y)
}
// Range iterator with step
#[derive(Clone, Hash, Eq, PartialEq)]
pub struct StepRange<T> {
/// Start of the range.
pub from: T,
/// End of the range (exclusive).
pub to: T,
/// Step value.
pub step: T,
/// Increment function.
pub add: fn(T, T) -> Option<T>,
/// Direction of iteration.
/// > 0 = forward, < 0 = backward, 0 = done.
pub dir: i8,
}
impl<T: Debug> Debug for StepRange<T> {
#[cold]
#[inline(never)]
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.debug_tuple(&format!("StepRange<{}>", type_name::<T>()))
.field(&self.from)
.field(&self.to)
.field(&self.step)
.finish()
}
}
impl<T: Copy + PartialOrd> StepRange<T> {
/// Create a new [`StepRange`].
pub fn new(from: T, to: T, step: T, add: fn(T, T) -> Option<T>) -> RhaiResultOf<Self> {
let mut dir = 0;
if let Some(n) = add(from, step) {
#[cfg(not(feature = "unchecked"))]
if n == from {
return Err(ERR::ErrorInFunctionCall(
"range".to_string(),
String::new(),
ERR::ErrorArithmetic("step value cannot be zero".to_string(), Position::NONE)
.into(),
Position::NONE,
)
.into());
}
match from.partial_cmp(&to).unwrap_or(Ordering::Equal) {
Ordering::Less if n > from => dir = 1,
Ordering::Greater if n < from => dir = -1,
_ => (),
}
}
Ok(Self {
from,
to,
step,
add,
dir,
})
}
}
impl<T: Copy + PartialOrd> Iterator for StepRange<T> {
type Item = T;
fn next(&mut self) -> Option<T> {
if self.dir == 0 {
return None;
}
let v = self.from;
self.from = (self.add)(self.from, self.step)?;
match self.dir.cmp(&0) {
Ordering::Greater if self.from >= self.to => self.dir = 0,
Ordering::Less if self.from <= self.to => self.dir = 0,
Ordering::Equal => unreachable!("`dir` != 0"),
_ => (),
}
Some(v)
}
}
impl<T: Copy + PartialOrd> FusedIterator for StepRange<T> {}
/// Bit-field iterator with step.
///
/// Values are the base number and the number of bits to iterate.
#[derive(Debug, Clone, Hash, Eq, PartialEq)]
pub struct BitRange(INT, usize);
impl BitRange {
/// Create a new [`BitRange`].
pub fn new(value: INT, from: INT, len: INT) -> RhaiResultOf<Self> {
let from = calc_index(INT_BITS, from, true, || {
ERR::ErrorBitFieldBounds(INT_BITS, from, Position::NONE).into()
})?;
#[allow(clippy::cast_sign_loss, clippy::cast_possible_truncation)]
let len = if len < 0 {
0
} else if from + (len as usize) > INT_BITS {
INT_BITS - from
} else {
len as usize
};
Ok(Self(value >> from, len))
}
}
impl Iterator for BitRange {
type Item = bool;
fn next(&mut self) -> Option<Self::Item> {
if self.1 == 0 {
None
} else {
let r = (self.0 & 0x0001) != 0;
self.0 >>= 1;
self.1 -= 1;
Some(r)
}
}
#[inline(always)]
fn size_hint(&self) -> (usize, Option<usize>) {
(self.1, Some(self.1))
}
}
impl FusedIterator for BitRange {}
impl ExactSizeIterator for BitRange {
#[inline(always)]
fn len(&self) -> usize {
self.1
}
}
// String iterator over characters.
#[derive(Debug, Clone)]
pub struct CharsStream(IntoIter<char>);
impl CharsStream {
/// Create a new [`CharsStream`].
#[allow(clippy::cast_sign_loss, clippy::cast_possible_truncation)]
pub fn new(string: &str, from: INT, len: INT) -> Self {
if len <= 0 || from > MAX_USIZE_INT {
return Self(Vec::new().into_iter());
}
let len = len.min(MAX_USIZE_INT) as usize;
if from >= 0 {
return Self(
string
.chars()
.skip(from as usize)
.take(len)
.collect::<Vec<_>>()
.into_iter(),
);
}
let abs_from = from.unsigned_abs() as usize;
let num_chars = string.chars().count();
let offset = if num_chars < abs_from {
0
} else {
num_chars - abs_from
};
Self(
string
.chars()
.skip(offset)
.take(len)
.collect::<Vec<_>>()
.into_iter(),
)
}
}
impl Iterator for CharsStream {
type Item = char;
#[inline(always)]
fn next(&mut self) -> Option<Self::Item> {
self.0.next()
}
#[inline(always)]
fn size_hint(&self) -> (usize, Option<usize>) {
self.0.size_hint()
}
}
impl FusedIterator for CharsStream {}
impl ExactSizeIterator for CharsStream {
#[inline(always)]
fn len(&self) -> usize {
self.0.len()
}
}
macro_rules! reg_range {
($lib:ident => $( $arg_type:ty ),*) => {
$({
$lib.set_iterator::<Range<$arg_type>>();
#[export_module]
mod range_function {
/// Return an iterator over the exclusive range of `from..to`.
/// The value `to` is never included.
///
/// # Example
///
/// ```rhai
/// // prints all values from 8 to 17
/// for n in range(8, 18) {
/// print(n);
/// }
/// ```
pub const fn range (from: $arg_type, to: $arg_type) -> Range<$arg_type> {
from..to
}
}
combine_with_exported_module!($lib, stringify!($arg_type), range_function);
$lib.set_iterator::<RangeInclusive<$arg_type>>();
})*
};
($lib:ident |> $( $arg_type:ty ),*) => {
#[cfg(not(feature = "unchecked"))]
reg_range!($lib |> std_add => $( $arg_type ),*);
#[cfg(feature = "unchecked")]
reg_range!($lib |> regular_add => $( $arg_type ),*);
};
($lib:ident |> $add:ident => $( $arg_type:ty ),*) => {
$({
$lib.set_iterator::<StepRange<$arg_type>>();
#[export_module]
mod range_functions {
/// Return an iterator over the exclusive range of `from..to`, each iteration increasing by `step`.
/// The value `to` is never included.
///
/// If `from` > `to` and `step` < 0, iteration goes backwards.
///
/// If `from` > `to` and `step` > 0 or `from` < `to` and `step` < 0, an empty iterator is returned.
///
/// # Example
///
/// ```rhai
/// // prints all values from 8 to 17 in steps of 3
/// for n in range(8, 18, 3) {
/// print(n);
/// }
///
/// // prints all values down from 18 to 9 in steps of -3
/// for n in range(18, 8, -3) {
/// print(n);
/// }
/// ```
#[rhai_fn(name = "range", return_raw)]
pub fn range_from_to_stepped (from: $arg_type, to: $arg_type, step: $arg_type) -> RhaiResultOf<StepRange<$arg_type>> {
StepRange::new(from, to, step, $add)
}
/// Return an iterator over an exclusive range, each iteration increasing by `step`.
///
/// If `range` is reversed and `step` < 0, iteration goes backwards.
///
/// Otherwise, if `range` is empty, an empty iterator is returned.
///
/// # Example
///
/// ```rhai
/// // prints all values from 8 to 17 in steps of 3
/// for n in range(8..18, 3) {
/// print(n);
/// }
///
/// // prints all values down from 18 to 9 in steps of -3
/// for n in range(18..8, -3) {
/// print(n);
/// }
/// ```
#[rhai_fn(name = "range", return_raw)]
pub fn range_stepped (range: std::ops::Range<$arg_type>, step: $arg_type) -> RhaiResultOf<StepRange<$arg_type>> {
StepRange::new(range.start, range.end, step, $add)
}
}
combine_with_exported_module!($lib, stringify!($arg_type), range_functions);
})*
};
}
def_package! {
/// Package of basic range iterators
pub BasicIteratorPackage(lib) {
lib.set_standard_lib(true);
// Register iterators for standard types.
#[cfg(not(feature = "no_index"))]
{
lib.set_iterable::<crate::Array>();
lib.set_iterable::<crate::Blob>();
}
lib.set_iter(TypeId::of::<ImmutableString>(), |value| Box::new(
CharsStream::new(value.cast::<ImmutableString>().as_str(), 0, MAX_USIZE_INT).map(Into::into)
));
// Register iterator types.
lib.set_iterator::<CharsStream>();
lib.set_iterator::<BitRange>();
// Register range functions.
reg_range!(lib => INT);
#[cfg(not(feature = "only_i32"))]
#[cfg(not(feature = "only_i64"))]
{
reg_range!(lib => i8, u8, i16, u16, i32, u32, i64, u64);
#[cfg(not(target_family = "wasm"))]
reg_range!(lib => i128, u128);
}
reg_range!(lib |> INT);
#[cfg(not(feature = "only_i32"))]
#[cfg(not(feature = "only_i64"))]
{
reg_range!(lib |> i8, u8, i16, u16, i32, u32, i64, u64);
#[cfg(not(target_family = "wasm"))]
reg_range!(lib |> i128, u128);
}
#[cfg(not(feature = "no_float"))]
reg_range!(lib |> regular_add => FLOAT);
#[cfg(feature = "decimal")]
reg_range!(lib |> Decimal);
// Register iterator functions
combine_with_exported_module!(lib, "iterator", iterator_functions);
combine_with_exported_module!(lib, "range", range_functions);
}
}
#[export_module]
mod iterator_functions {
/// Return an iterator over an exclusive range of characters in the string.
///
/// # Example
///
/// ```rhai
/// for ch in "hello, world!".chars(2..5) {
/// print(ch);
/// }
/// ```
#[rhai_fn(name = "chars")]
pub fn chars_from_exclusive_range(string: &str, range: ExclusiveRange) -> CharsStream {
let from = INT::max(range.start, 0);
let to = INT::max(range.end, from);
CharsStream::new(string, from, to - from)
}
/// Return an iterator over an inclusive range of characters in the string.
///
/// # Example
///
/// ```rhai
/// for ch in "hello, world!".chars(2..=6) {
/// print(ch);
/// }
/// ```
#[rhai_fn(name = "chars")]
pub fn chars_from_inclusive_range(string: &str, range: InclusiveRange) -> CharsStream {
let from = INT::max(*range.start(), 0);
let to = INT::max(*range.end(), from - 1);
CharsStream::new(string, from, to - from + 1)
}
/// Return an iterator over a portion of characters in the string.
///
/// * If `start` < 0, position counts from the end of the string (`-1` is the last character).
/// * If `start` < -length of string, position counts from the beginning of the string.
/// * If `start` ≥ length of string, an empty iterator is returned.
/// * If `len` ≤ 0, an empty iterator is returned.
/// * If `start` position + `len` ≥ length of string, all characters of the string after the `start` position are iterated.
///
/// # Example
///
/// ```rhai
/// for ch in "hello, world!".chars(2, 4) {
/// print(ch);
/// }
/// ```
#[rhai_fn(name = "chars")]
pub fn chars_from_start_len(string: &str, start: INT, len: INT) -> CharsStream {
CharsStream::new(string, start, len)
}
/// Return an iterator over the characters in the string starting from the `start` position.
///
/// * If `start` < 0, position counts from the end of the string (`-1` is the last character).
/// * If `start` < -length of string, position counts from the beginning of the string.
/// * If `start` ≥ length of string, an empty iterator is returned.
///
/// # Example
///
/// ```rhai
/// for ch in "hello, world!".chars(2) {
/// print(ch);
/// }
/// ```
#[rhai_fn(name = "chars")]
pub fn chars_from_start(string: &str, start: INT) -> CharsStream {
CharsStream::new(string, start, INT::MAX)
}
/// Return an iterator over the characters in the string.
///
/// # Example
///
/// ```rhai
/// for ch in "hello, world!".chars() {
/// print(ch);
/// }
/// ```
#[rhai_fn(name = "chars")]
pub fn chars(string: &str) -> CharsStream {
CharsStream::new(string, 0, INT::MAX)
}
/// Return an iterator over all the characters in the string.
///
/// # Example
///
/// ```rhai
/// for ch in "hello, world!".chars {"
/// print(ch);
/// }
/// ```
#[cfg(not(feature = "no_object"))]
#[rhai_fn(get = "chars")]
pub fn get_chars(string: &str) -> CharsStream {
CharsStream::new(string, 0, INT::MAX)
}
/// Return an iterator over an exclusive range of bits in the number.
///
/// # Example
///
/// ```rhai
/// let x = 123456;
///
/// for bit in x.bits(10..24) {
/// print(bit);
/// }
/// ```
#[rhai_fn(name = "bits", return_raw)]
pub fn bits_from_exclusive_range(value: INT, range: ExclusiveRange) -> RhaiResultOf<BitRange> {
let from = INT::max(range.start, 0);
let to = INT::max(range.end, from);
BitRange::new(value, from, to - from)
}
/// Return an iterator over an inclusive range of bits in the number.
///
/// # Example
///
/// ```rhai
/// let x = 123456;
///
/// for bit in x.bits(10..=23) {
/// print(bit);
/// }
/// ```
#[rhai_fn(name = "bits", return_raw)]
pub fn bits_from_inclusive_range(value: INT, range: InclusiveRange) -> RhaiResultOf<BitRange> {
let from = INT::max(*range.start(), 0);
let to = INT::max(*range.end(), from - 1);
BitRange::new(value, from, to - from + 1)
}
/// Return an iterator over a portion of bits in the number.
///
/// * If `start` < 0, position counts from the MSB (Most Significant Bit)>.
/// * If `len` ≤ 0, an empty iterator is returned.
/// * If `start` position + `len` ≥ length of string, all bits of the number after the `start` position are iterated.
///
/// # Example
///
/// ```rhai
/// let x = 123456;
///
/// for bit in x.bits(10, 8) {
/// print(bit);
/// }
/// ```
#[rhai_fn(name = "bits", return_raw)]
pub fn bits_from_start_and_len(value: INT, from: INT, len: INT) -> RhaiResultOf<BitRange> {
BitRange::new(value, from, len)
}
/// Return an iterator over the bits in the number starting from the specified `start` position.
///
/// If `start` < 0, position counts from the MSB (Most Significant Bit)>.
///
/// # Example
///
/// ```rhai
/// let x = 123456;
///
/// for bit in x.bits(10) {
/// print(bit);
/// }
/// ```
#[rhai_fn(name = "bits", return_raw)]
pub fn bits_from_start(value: INT, from: INT) -> RhaiResultOf<BitRange> {
BitRange::new(value, from, INT::MAX)
}
/// Return an iterator over all the bits in the number.
///
/// # Example
///
/// ```rhai
/// let x = 123456;
///
/// for bit in x.bits() {
/// print(bit);
/// }
/// ```
#[rhai_fn(name = "bits", return_raw)]
pub fn bits(value: INT) -> RhaiResultOf<BitRange> {
BitRange::new(value, 0, INT::MAX)
}
/// Return an iterator over all the bits in the number.
///
/// # Example
///
/// ```rhai
/// let x = 123456;
///
/// for bit in x.bits {
/// print(bit);
/// }
/// ```
#[cfg(not(feature = "no_object"))]
#[rhai_fn(get = "bits", return_raw)]
pub fn get_bits(value: INT) -> RhaiResultOf<BitRange> {
BitRange::new(value, 0, INT::MAX)
}
}
#[export_module]
mod range_functions {
/// Return the start of the exclusive range.
#[rhai_fn(get = "start", name = "start", pure)]
pub fn start(range: &mut ExclusiveRange) -> INT {
range.start
}
/// Return the end of the exclusive range.
#[rhai_fn(get = "end", name = "end", pure)]
pub fn end(range: &mut ExclusiveRange) -> INT {
range.end
}
/// Return `true` if the range is inclusive.
#[rhai_fn(get = "is_inclusive", name = "is_inclusive", pure)]
pub fn is_inclusive(range: &mut ExclusiveRange) -> bool {
let _ = range;
false
}
/// Return `true` if the range is exclusive.
#[rhai_fn(get = "is_exclusive", name = "is_exclusive", pure)]
pub fn is_exclusive(range: &mut ExclusiveRange) -> bool {
let _ = range;
true
}
/// Return true if the range contains no items.
#[rhai_fn(get = "is_empty", name = "is_empty", pure)]
#[allow(unstable_name_collisions)]
pub fn is_empty_exclusive(range: &mut ExclusiveRange) -> bool {
range.is_empty()
}
/// Return `true` if the range contains a specified value.
#[rhai_fn(name = "contains")]
pub fn contains_exclusive(range: &mut ExclusiveRange, value: INT) -> bool {
range.contains(&value)
}
/// Return the start of the inclusive range.
#[rhai_fn(get = "start", name = "start", pure)]
pub fn start_inclusive(range: &mut InclusiveRange) -> INT {
*range.start()
}
/// Return the end of the inclusive range.
#[rhai_fn(get = "end", name = "end", pure)]
pub fn end_inclusive(range: &mut InclusiveRange) -> INT {
*range.end()
}
/// Return `true` if the range is inclusive.
#[rhai_fn(get = "is_inclusive", name = "is_inclusive", pure)]
pub fn is_inclusive_inclusive(range: &mut InclusiveRange) -> bool {
let _ = range;
true
}
/// Return `true` if the range is exclusive.
#[rhai_fn(get = "is_exclusive", name = "is_exclusive", pure)]
pub fn is_exclusive_inclusive(range: &mut InclusiveRange) -> bool {
let _ = range;
false
}
/// Return true if the range contains no items.
#[rhai_fn(get = "is_empty", name = "is_empty", pure)]
pub fn is_empty_inclusive(range: &mut InclusiveRange) -> bool {
range.is_empty()
}
/// Return `true` if the range contains a specified value.
#[rhai_fn(name = "contains")]
pub fn contains_inclusive(range: &mut InclusiveRange, value: INT) -> bool {
range.contains(&value)
}
}