parsley 0.10.0

//! A Scheme parsing and evaluation framework.
//!
//! # Example
//! ```
//! use parsley::run;
//!
//! assert_eq!(
//!     run("(null? '())").unwrap(),
//!     run("#t").unwrap()
//! );
//!
//! assert_eq!(
//!     run("(* (+ 3 4 5) (- 5 2))").unwrap(),
//!     run("36").unwrap()
//! );
//!
//! let expr = r#"
//! (define (sqr x) (* x x))
//! (define (sum-of-squares x y) (+ (sqr x) (sqr y)))
//! (sum-of-squares 3 4)
//! "#;
//! assert_eq!(
//!     run(expr).unwrap(),
//!     run("25").unwrap()
//! );
//! ```

#![deny(clippy::pedantic)]

#[macro_use]
mod sexp;

mod cont;
mod ctx;
mod env;
mod errors;
mod primitives;
mod proc;
mod utils;

use self::cont::Cont;
pub use self::ctx::Context;
use self::env::{Env, Ns};
pub use self::errors::Error;
use self::errors::SyntaxError;
pub use self::primitives::Num;
use self::primitives::Primitive;
pub use self::proc::utils as proc_utils;
use self::proc::{Func, Proc};
pub use self::sexp::SExp;

/// A shorthand Result type.
pub type Result = ::std::result::Result<SExp, Error>;

/// Run a code snippet in the [base context](./struct.Context.html#method.base).
///
/// # Example
/// ```
/// use parsley::prelude::*;
///
/// assert!(run("x").is_err());
/// assert!(run("null").is_ok());
/// assert_eq!(run("null").unwrap(), SExp::Null);
/// ```
///
/// # Errors
/// An error will be returned if the provided program is invalid or cannot terminate.
pub fn run(code: &str) -> Result {
    Context::base().run(code)
}

/// Quick access to the important stuff.
pub mod prelude {
    pub use super::{eval, run, sexp, Context, SExp};
}