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
#[doc(hidden)]
#[macro_export]
macro_rules! count {
(@subst $($x:tt)*) => (());
($($rest:expr),*) => (<[()]>::len(&[$($crate::count!(@subst $rest)),*]) as i32);
}
/// Creates a [`JanetTuple`] containing the arguments.
///
/// `tuple!` allows [`JanetTuple`]s to be defined with the same syntax as Rust array
/// expressions. There are 2 forms of this macro:
/// * Create a [`JanetTuple`] containing a given list of elements
/// ```
/// use janetrs::{tuple, Janet};
/// # let _client = janetrs::client::JanetClient::init().unwrap();
///
/// let t = tuple![3, true, "hey"];
///
/// assert_eq!(t[0], &Janet::integer(3));
/// assert_eq!(t[1], &Janet::boolean(true));
/// assert_eq!(t[2], &Janet::from("hey"));
/// ```
/// * Create a [`JanetTuple`] from a given element and size
/// ```
/// use janetrs::{Janet, tuple};
/// # let _client = janetrs::client::JanetClient::init().unwrap();
///
/// let t = tuple!["123"; 3];
///
/// assert_eq!(t[0], &Janet::from("123"));
/// assert_eq!(t[1], &Janet::from("123"));
/// assert_eq!(t[2], &Janet::from("123"));
/// ```
///
/// Note that unlike `vec!` from the Rust standard library, this macro doesn't try to
/// clone the elements passed.
///
/// Also note that this macro builds the tuples converting the passed elements to
/// [`Janet`] using the [`From`] trait, so if you want for a type defined by you to be
/// used in this macro, implement the [`From`] trait to convert from you type to
/// [`Janet`] or transform to [`Janet`] beforehand.
///
/// [`Janet`]: ./types/struct.Janet.html
/// [`JanetTuple`]: ./types/tuple/struct.JanetTuple.html
#[macro_export]
macro_rules! tuple {
($elem:expr; $n:expr) => {$crate::JanetTuple::with_default_elem($crate::Janet::from($elem), $n)};
($($val:expr),* $(,)?) => {{
const LEN: i32 = $crate::count!($($val),*);
$crate::JanetTuple::builder(LEN)
$(.put($crate::Janet::from($val)))*
.finalize()
}};
}
/// Creates a [`JanetArray`] containing the arguments.
///
/// `tuple!` allows [`JanetArray`]s to be defined with the same syntax as Rust array
/// expressions. There are 2 forms of this macro:
/// * Create a [`JanetArray`] containing a given list of elements
/// ```
/// use janetrs::{array, Janet};
/// # let _client = janetrs::client::JanetClient::init().unwrap();
///
/// let arr = array![3, true, "hey"];
///
/// assert_eq!(arr[0], &Janet::integer(3));
/// assert_eq!(arr[1], &Janet::boolean(true));
/// assert_eq!(arr[2], &Janet::from("hey"));
/// ```
/// * Create a [`JanetArray`] from a given element and size
/// ```
/// use janetrs::{Janet, array};
/// # let _client = janetrs::client::JanetClient::init().unwrap();
///
/// let arr = array!["123"; 3];
///
/// assert_eq!(arr[0], &Janet::from("123"));
/// assert_eq!(arr[1], &Janet::from("123"));
/// assert_eq!(arr[2], &Janet::from("123"));
/// ```
///
/// Note that unlike `vec!` from the Rust standard library, this macro doesn't try to
/// clone the elements passed.
///
/// Also note that this macro builds the array converting the passed elements to
/// [`Janet`] using the [`From`] trait, so if you want for a type defined by you to be
/// used in this macro, implement the [`From`] trait to convert from you type to
/// [`Janet`] or transform to [`Janet`] beforehand.
///
/// [`Janet`]: ./types/struct.Janet.html
/// [`JanetArray`]: ./types/tuple/struct.JanetArray.html
#[macro_export]
macro_rules! array {
() => { $crate::JanetArray::new() };
($elem:expr; $n:expr) => {{
let mut arr = $crate::JanetArray::with_capacity($n);
(0..$n).for_each(|_| arr.push($crate::Janet::from($elem)));
arr
}};
($($val:expr),* $(,)?) => {{
const LEN: i32 = $crate::count!($($val),*);
let mut arr = $crate::JanetArray::with_capacity(LEN);
$(arr.push($crate::Janet::from($val));)*
arr
}};
}
/// Creates a [`JanetStruct`] containing the arguments key-value pairs.
///
/// `structs!` allows [`JanetStruct`]s to be defined with a syntax that have key-value
/// pairs as the items of the struct.
///
/// ```
/// use janetrs::{structs, Janet};
/// # let _client = janetrs::client::JanetClient::init().unwrap();
///
/// let st = structs! {
/// 1 => "one",
/// true => 1,
/// };
///
/// assert_eq!(st.len(), 2);
/// assert_eq!(st.get(1), Some(&Janet::from("one")));
/// assert_eq!(st.get(true), Some(&Janet::integer(1)));
/// ```
///
/// Note that this macro builds the struct converting the passed elements to
/// [`Janet`] using the [`From`] trait, so if you want for a type defined by you to be
/// used in this macro, implement the [`From`] trait to convert from you type to
/// [`Janet`] or transform to [`Janet`] beforehand.
///
/// [`Janet`]: ./types/struct.Janet.html
/// [`JanetStruct`]: ./types/tuple/struct.JanetStruct.html
#[macro_export]
macro_rules! structs {
($($key:expr => $value:expr),* $(,)?) => {{
const LEN: i32 = $crate::count!($($key),*);
$crate::JanetStruct::builder(LEN)
$(.put($crate::Janet::from($key), $crate::Janet::from($value)))*
.finalize()
}};
}
/// Creates a [`JanetTable`] containing the arguments key-value pairs.
///
/// `table!` allows [`JanetTable`]s to be defined with a syntax that have key-value
/// pairs as the items of the struct.
///
/// ```
/// use janetrs::{table, Janet};
/// # let _client = janetrs::client::JanetClient::init().unwrap();
///
/// let table = table! {
/// 1 => "one",
/// true => 1,
/// };
///
/// assert_eq!(table.len(), 2);
/// assert_eq!(table.get(1), Some(&Janet::from("one")));
/// assert_eq!(table.get(true), Some(&Janet::integer(1)));
/// ```
///
/// Note that this macro builds the struct converting the passed elements to
/// [`Janet`] using the [`From`] trait, so if you want for a type defined by you to be
/// used in this macro, implement the [`From`] trait to convert from you type to
/// [`Janet`] or transform to [`Janet`] beforehand.
///
/// [`Janet`]: ./types/struct.Janet.html
/// [`JanetTable`]: ./types/tuple/struct.JanetTable.html
#[macro_export]
macro_rules! table {
() => ($crate::JanetTable::new());
($($key:expr => $value:expr),* $(,)?) => {{
const LEN: i32 = $crate::count!($($key),*);
let mut table = $crate::JanetTable::with_capacity(LEN);
$(let _ = table.insert($crate::Janet::from($key), $crate::Janet::from($value));)*
table
}};
}
/// A macro to make life easier creating modules for Janet from Rust.
///
/// ## The syntax:
/// `janet_mod!(<Janet Module Name (string literal)>; <{<Janet Function Name ((string
/// literal))>, <function pointer>, <Janet documentation string (string literal)>},
/// ...>);` ¹ Items inside `<>` means mandatory
/// ² `...` means one or more
///
/// # Examples
/// ```
/// use janetrs::{janet_mod, Janet, janet_fn};
///
/// #[janet_fn(arity(fix(0)))]
/// fn rust_hello(args: &mut [Janet]) -> Janet {
/// println!("Hello from Rust!");
/// Janet::nil()
/// }
///
/// #[janet_fn(arity(fix(0)))]
/// fn hi(args: &mut [Janet]) -> Janet {
/// Janet::from("Hi! My name is GrayJack!")
/// }
///
/// janet_mod!("rust";
/// {"hello", rust_hello, "(rust/hello)\n\nRust say hello"},
/// {"hi", hi, "(rust/hi)\n\nHi! My name is..."}
/// );
/// ```
#[deprecated(since = "0.4.0", note = "use `declare_janet_mod` instead")]
#[macro_export]
macro_rules! janet_mod {
($mod_name:literal; $({$fn_name:literal, $fn:expr, $fn_doc:literal}),* $(,)?) => {
#[no_mangle]
pub unsafe extern "C-unwind" fn _janet_mod_config() -> $crate::lowlevel::JanetBuildConfig {
$crate::lowlevel::JanetBuildConfig {
major: $crate::lowlevel::JANET_VERSION_MAJOR,
minor: $crate::lowlevel::JANET_VERSION_MINOR,
patch: $crate::lowlevel::JANET_VERSION_PATCH,
bits: $crate::lowlevel::JANET_CURRENT_CONFIG_BITS,
}
}
#[no_mangle]
pub unsafe extern "C-unwind" fn _janet_init(env: *mut $crate::lowlevel::JanetTable) {
$crate::lowlevel::janet_cfuns(env, concat!($mod_name, "\0").as_ptr() as *const _, [
$(
$crate::lowlevel::JanetReg {
name: concat!($fn_name, "\0").as_ptr() as *const _,
cfun: Some($fn),
documentation: concat!($fn_doc, "\0").as_ptr() as *const _,
},
)*
$crate::lowlevel::JanetReg {
name: std::ptr::null(),
cfun: None,
documentation: std::ptr::null(),
},
].as_ptr())
}
};
}
/// Causes a panic in the Janet side (exception). Differently of the Rust `panic!` macro,
/// this macro does **not** terminate the current thread. Instead, it sends a error signal
/// with the passed message where the Janet runtime takes care to properly exit.
///
/// # Examples
/// ```ignore
/// use janetrs::jpanic;
/// # let _client = janetrs::client::JanetClient::init().unwrap();
/// jpanic!();
/// jpanic!("this is a terrible mistake!");
/// jpanic!(4); // In simple cases you can use any type that Janet implements From trait
/// jpanic!("this is a {} {message}", "fancy", message = "message");
/// ```
#[cfg(not(feature = "std"))]
#[macro_export]
macro_rules! jpanic {
() => {
$crate::util::_panic($crate::Janet::from("explicit panic"))
};
($msg:expr $(,)?) => {
$crate::util::_panic($crate::Janet::from($msg))
};
($msg:expr, $($arg:tt)+) => {
$crate::util::_panic($crate::Janet::from(::alloc::format!($msg, $($arg)+).as_str()))
};
}
/// Causes a panic in the Janet side (exception). Differently of the Rust `panic!` macro,
/// this macro does **not** terminate the current thread. Instead, it sends a error signal
/// with the passed message where the Janet runtime takes care to properly exit.
///
/// # Examples
/// ```ignore
/// use janetrs::jpanic;
/// # let _client = janetrs::client::JanetClient::init().unwrap();
/// jpanic!();
/// jpanic!("this is a terrible mistake!");
/// jpanic!(4); // In simple cases you can use any type that Janet implements From trait
/// jpanic!("this is a {} {message}", "fancy", message = "message");
/// ```
#[cfg(feature = "std")]
#[macro_export]
macro_rules! jpanic {
() => {
$crate::util::_panic($crate::Janet::from("explicit panic"))
};
($msg:expr $(,)?) => {
$crate::util::_panic($crate::Janet::from($msg))
};
($msg:expr, $($arg:tt)+) => {
$crate::util::_panic($crate::Janet::from(::std::format!($msg, $($arg)+).as_str()))
};
}
/// A macro helper to use the default message when getting the wrong types in the function
/// argument when the situations that are more complex than the ones handled in
/// [`JanetArgs`](crate::JanetArgs), like multiple accepted types.
///
/// # Examples
///
/// ```
/// use janetrs::{bad_slot, janet_fn, Janet, TaggedJanet};
///
/// #[janet_fn(arity(fix(1)))]
/// fn hi(args: &mut [Janet]) -> Janet {
/// match args[1].unwrap() {
/// TaggedJanet::Buffer(name) => println!("Hi, {}", name),
/// TaggedJanet::String(name) => println!("Hi, {}", name),
/// _ => bad_slot!(args, 0, "string|buffer"),
/// }
/// Janet::nil()
/// }
/// ```
#[macro_export]
macro_rules! bad_slot {
($args:ident, $index:expr, $expected:expr) => {
$crate::jpanic!(
"bad slot #{}, expected {}, got {}",
$index,
$expected,
$args[$index].kind()
)
};
}
/// Execute a function ([`JanetCFunction`], Rust function or extern C function) and catch
/// any janet panic that may happen as a [`Result`].
///
/// # Examples
/// ```ignore
/// use janetrs::{jcatch, jpanic, Janet};
///
/// fn panic_fn() {
/// jpanic!("Help!");
/// }
///
/// #[janet_fn]
/// fn test(args: &mut [Janet]) -> Janet {
/// let res = jcatch!(panic_fn());
/// dbg!(res);
/// Janet::nil()
/// }
/// ```
///
/// [`JanetCFunction`]: ./types/struct.JanetCFunction.html
#[crate::cjvg("1.12.2")]
#[macro_export]
macro_rules! jcatch {
($e:expr) => {{
let mut state = $crate::function::JanetTryState::init();
if let Some(signal) = state.signal() {
if matches!(
signal,
$crate::JanetSignal::Ok | $crate::JanetSignal::Yield | $crate::JanetSignal::User9
) {
Ok($e)
} else {
Err(state.payload())
}
} else {
Err($crate::Janet::from("No fiber to run."))
}
}};
}
/// Macro that tries to run a expression, and if it panics in the Rust side, it tries to
/// recover from that and pass the Rust panic string to a Janet Panic.
///
/// This uses the [`catch_unwind`] function, and therefore have the same guarantees as it.
///
/// # Examples
/// ```ignore
/// # #![allow(unconditional_panic)]
/// use janetrs::jtry;
/// # let _client = janetrs::client::JanetClient::init().unwrap();
///
/// let arr = [10; 5];
/// let val_index_2 = jtry!(arr[2]); // Not going to panic
/// let val_index_20 = jtry!(arr[20]); // Index out bounds
/// ```
///
/// [`catch_unwind`]: https://doc.rust-lang.org/std/panic/fn.catch_unwind.html
#[cfg(feature = "std")]
#[cfg_attr(_doc, doc(cfg(feature = "std")))]
#[macro_export]
macro_rules! jtry {
($e:expr) => {{
::std::panic::catch_unwind(|| $e).unwrap_or_else(|err| {
if let Some(err) = err.downcast_ref::<String>() {
$crate::jpanic!("{}", err);
} else {
$crate::jpanic!();
}
})
}};
}
#[cfg(all(test, any(feature = "amalgation", feature = "link-system")))]
mod tests {
// use super::*;
use crate::types::Janet;
#[test]
fn tuple0() -> Result<(), crate::client::Error> {
let _client = crate::client::JanetClient::init()?;
let t = tuple![0, 1, 2, 3, true, "hey"];
assert_eq!(t.len(), 6);
assert_eq!(t[0], &Janet::integer(0));
assert_eq!(t[1], &Janet::integer(1));
assert_eq!(t[2], &Janet::integer(2));
assert_eq!(t[3], &Janet::integer(3));
assert_eq!(t[4], &Janet::boolean(true));
assert_eq!(t[5], &Janet::from("hey"));
Ok(())
}
#[test]
fn tuple1() -> Result<(), crate::client::Error> {
let _client = crate::client::JanetClient::init()?;
let t = tuple!["123"; 3];
assert_eq!(t.len(), 3);
assert_eq!(t[0], &Janet::from("123"));
assert_eq!(t[1], &Janet::from("123"));
assert_eq!(t[2], &Janet::from("123"));
Ok(())
}
#[test]
fn array0() -> Result<(), crate::client::Error> {
let _client = crate::client::JanetClient::init()?;
let arr = array![];
assert!(arr.is_empty());
Ok(())
}
#[test]
fn array1() -> Result<(), crate::client::Error> {
let _client = crate::client::JanetClient::init()?;
let arr = array![0; 5];
assert_eq!(arr.len(), 5);
assert_eq!(arr[0], &Janet::integer(0));
assert_eq!(arr[1], &Janet::integer(0));
assert_eq!(arr[2], &Janet::integer(0));
assert_eq!(arr[3], &Janet::integer(0));
assert_eq!(arr[4], &Janet::integer(0));
Ok(())
}
#[test]
fn array2() -> Result<(), crate::client::Error> {
let _client = crate::client::JanetClient::init()?;
let arr = array![0, 10.0, 15.5, true, "abc"];
assert_eq!(arr.len(), 5);
assert_eq!(arr[0], &Janet::integer(0));
assert_eq!(arr[1], &Janet::number(10.0));
assert_eq!(arr[2], &Janet::number(15.5));
assert_eq!(arr[3], &Janet::boolean(true));
assert_eq!(arr[4], &Janet::from("abc"));
Ok(())
}
#[test]
fn structs() -> Result<(), crate::client::Error> {
let _client = crate::client::JanetClient::init()?;
let st = structs! {
1 => "one",
true => 1,
};
assert_eq!(st.len(), 2);
assert_eq!(st.get(1), Some(&Janet::from("one")));
assert_eq!(st.get(true), Some(&Janet::integer(1)));
Ok(())
}
#[test]
fn table() -> Result<(), crate::client::Error> {
let _client = crate::client::JanetClient::init()?;
let table = table! {};
assert!(table.is_empty());
let table = table! {
1 => "one",
true => 1,
};
assert_eq!(table.len(), 2);
assert_eq!(table.get(1), Some(&Janet::from("one")));
assert_eq!(table.get(true), Some(&Janet::integer(1)));
Ok(())
}
#[test]
fn empty() -> Result<(), crate::client::Error> {
let _client = crate::client::JanetClient::init()?;
let arr = array![];
let tup = tuple![];
let stru = structs! {};
let tab = table! {};
assert!(arr.is_empty());
assert!(tup.is_empty());
assert!(stru.is_empty());
assert!(tab.is_empty());
Ok(())
}
}