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
//! //! ## Quickstart //! //! Add `evalexpr` as dependency to your `Cargo.toml`: //! //! ```toml //! [dependencies] //! evalexpr = "5" //! ``` //! //! Add the `extern crate` definition to your `main.rs` or `lib.rs`: //! //! ```rust //! extern crate evalexpr; //! ``` //! //! Then you can use `evalexpr` to **evaluate expressions** like this: //! //! ```rust //! use evalexpr::*; //! //! assert_eq!(eval("1 + 2 + 3"), Ok(Value::from(6))); //! // `eval` returns a variant of the `Value` enum, //! // while `eval_[type]` returns the respective type directly. //! // Both can be used interchangeably. //! assert_eq!(eval_int("1 + 2 + 3"), Ok(6)); //! assert_eq!(eval("1 - 2 * 3"), Ok(Value::from(-5))); //! assert_eq!(eval("1.0 + 2 * 3"), Ok(Value::from(7.0))); //! assert_eq!(eval("true && 4 > 2"), Ok(Value::from(true))); //! ``` //! //! You can **chain** expressions and **assign** to variables like this: //! //! ```rust //! use evalexpr::*; //! //! let mut context = HashMapContext::new(); //! // Assign 5 to a like this //! assert_eq!(eval_empty_with_context_mut("a = 5", &mut context), Ok(EMPTY_VALUE)); //! // The HashMapContext is type safe, so this will fail now //! assert_eq!(eval_empty_with_context_mut("a = 5.0", &mut context), Err(EvalexprError::expected_int(Value::from(5.0)))); //! // We can check which value the context stores for a like this //! assert_eq!(context.get_value("a"), Some(&Value::from(5))); //! // And use the value in another expression like this //! assert_eq!(eval_int_with_context_mut("a = a + 2; a", &mut context), Ok(7)); //! ``` //! //! And you can use **variables** and **functions** in expressions like this: //! //! ```rust //! use evalexpr::*; //! use evalexpr::error::expect_number; //! //! let mut context = HashMapContext::new(); //! context.set_value("five".into(), 5.into()).unwrap(); // Do proper error handling here //! context.set_value("twelve".into(), 12.into()).unwrap(); // Do proper error handling here //! context.set_function("f".into(), Function::new(Some(1) /* argument amount */, Box::new(|arguments| { //! if let Value::Int(int) = arguments[0] { //! Ok(Value::Int(int / 2)) //! } else if let Value::Float(float) = arguments[0] { //! Ok(Value::Float(float / 2.0)) //! } else { //! Err(EvalexprError::expected_number(arguments[0].clone())) //! } //! }))).unwrap(); // Do proper error handling here //! context.set_function("avg".into(), Function::new(Some(2) /* argument amount */, Box::new(|arguments| { //! expect_number(&arguments[0])?; //! expect_number(&arguments[1])?; //! //! if let (Value::Int(a), Value::Int(b)) = (&arguments[0], &arguments[1]) { //! Ok(Value::Int((a + b) / 2)) //! } else { //! Ok(Value::Float((arguments[0].as_number()? + arguments[1].as_number()?) / 2.0)) //! } //! }))).unwrap(); // Do proper error handling here //! //! assert_eq!(eval_with_context("five + 8 > f(twelve)", &context), Ok(Value::from(true))); //! // `eval_with_context` returns a variant of the `Value` enum, //! // while `eval_[type]_with_context` returns the respective type directly. //! // Both can be used interchangeably. //! assert_eq!(eval_boolean_with_context("five + 8 > f(twelve)", &context), Ok(true)); //! assert_eq!(eval_with_context("avg(2, 4) == 3", &context), Ok(Value::from(true))); //! ``` //! //! You can also **precompile** expressions like this: //! //! ```rust //! use evalexpr::*; //! //! let precompiled = build_operator_tree("a * b - c > 5").unwrap(); // Do proper error handling here //! //! let mut context = HashMapContext::new(); //! context.set_value("a".into(), 6.into()).unwrap(); // Do proper error handling here //! context.set_value("b".into(), 2.into()).unwrap(); // Do proper error handling here //! context.set_value("c".into(), 3.into()).unwrap(); // Do proper error handling here //! assert_eq!(precompiled.eval_with_context(&context), Ok(Value::from(true))); //! //! context.set_value("c".into(), 8.into()).unwrap(); // Do proper error handling here //! assert_eq!(precompiled.eval_with_context(&context), Ok(Value::from(false))); //! // `Node::eval_with_context` returns a variant of the `Value` enum, //! // while `Node::eval_[type]_with_context` returns the respective type directly. //! // Both can be used interchangeably. //! assert_eq!(precompiled.eval_boolean_with_context(&context), Ok(false)); //! ``` //! //! ## Features //! //! ### Operators //! //! This crate offers a set of binary and unary operators for building expressions. //! Operators have a precedence to determine their order of evaluation. //! The precedence should resemble that of most common programming languages, especially Rust. //! The precedence of variables and values is 200, and the precedence of function literals is 190. //! //! Supported binary operators: //! //! | Operator | Precedence | Description | //! |----------|------------|-------------| //! | ^ | 120 | Exponentiation | //! | * | 100 | Product | //! | / | 100 | Division | //! | % | 100 | Modulo | //! | + | 95 | Sum or String Concatenation | //! | - | 95 | Difference | //! | < | 80 | Lower than | //! | \> | 80 | Greater than | //! | <= | 80 | Lower than or equal | //! | \>= | 80 | Greater than or equal | //! | == | 80 | Equal | //! | != | 80 | Not equal | //! | && | 75 | Logical and | //! | || | 70 | Logical or | //! | = | 50 | Assignment | //! | , | 40 | Aggregation | //! | ; | 0 | Expression Chaining | //! //! Supported unary operators: //! //! | Operator | Precedence | Description | //! |----------|------------|-------------| //! | - | 110 | Negation | //! | ! | 110 | Logical not | //! //! #### The Aggregation Operator //! //! The aggregation operator aggregates two values into a tuple. //! If one of the values is a tuple already, the resulting tuple will be flattened. //! Example: //! //! ```rust //! use evalexpr::*; //! //! assert_eq!(eval("1, 2, 3"), Ok(Value::from(vec![Value::from(1), Value::from(2), Value::from(3)]))); //! ``` //! //! #### The Assignment Operator //! //! This crate features the assignment operator, that allows expressions to store their result in a variable in the expression context. //! If an expression uses the assignment operator, it must be evaluated with a mutable context. //! Note that assignments are type safe, meaning if an identifier is assigned a value of a type once, it cannot be assigned a value of another type. //! //! ```rust //! use evalexpr::*; //! //! let mut context = HashMapContext::new(); //! assert_eq!(eval_with_context("a = 5", &context), Err(EvalexprError::ContextNotManipulable)); //! assert_eq!(eval_empty_with_context_mut("a = 5", &mut context), Ok(EMPTY_VALUE)); //! assert_eq!(eval_empty_with_context_mut("a = 5.0", &mut context), Err(EvalexprError::expected_int(5.0.into()))); //! assert_eq!(eval_int_with_context("a", &context), Ok(5)); //! assert_eq!(context.get_value("a"), Some(5.into()).as_ref()); //! ``` //! //! #### The Expression Chaining Operator //! //! The expression chaining operator works as one would expect from programming languages that use the semicolon to end statements, like `Rust`, `C` or `Java`. //! It has the special feature that it returns the value of the last expression in the expression chain. //! If the last expression is terminated by a semicolon as well, then `Value::Empty` is returned. //! Expression chaining is useful together with assignment to create small scripts. //! //! ```rust //! use evalexpr::*; //! //! let mut context = HashMapContext::new(); //! assert_eq!(eval("1;2;3;4;"), Ok(Value::Empty)); //! assert_eq!(eval("1;2;3;4"), Ok(4.into())); //! //! // Initialization of variables via script. //! assert_eq!(eval_empty_with_context_mut("hp = 1; max_hp = 5; heal_amount = 3;", &mut context), Ok(EMPTY_VALUE)); //! // Precompile healing script. //! let healing_script = build_operator_tree("hp = min(hp + heal_amount, max_hp); hp").unwrap(); // Do proper error handling here //! // Execute precompiled healing script. //! assert_eq!(healing_script.eval_int_with_context_mut(&mut context), Ok(4)); //! assert_eq!(healing_script.eval_int_with_context_mut(&mut context), Ok(5)); //! ``` //! //! ### Builtin Functions //! //! This crate offers a set of builtin functions. //! //! | Identifier | Argument Amount | Argument Types | Description | //! |------------|-----------------|----------------|-------------| //! | `min` | >= 1 | Numeric | Returns the minimum of the arguments | //! | `max` | >= 1 | Numeric | Returns the maximum of the arguments | //! | `len` | 1 | String | Returns the character length of a string | //! | `str::regex_matches` | 2 | String, String | Returns true if the first argument matches the regex in the second argument | //! | `str::regex_replace` | 3 | String, String, String | Returns the first argument with all matches of the regex in the second argument replaced by the third argument | //! | `str::to_lowercase` | 1 | String | Returns the lower-case version of the string | //! | `str::to_uppercase` | 1 | String | Returns the upper-case version of the string | //! | `str::trim` | 1 | String | Strips whitespace from the start and the end of the string | //! //! The `min` and `max` functions can deal with a mixture of integer and floating point arguments. //! If the maximum or minimum is an integer, then an integer is returned. //! Otherwise, a float is returned. //! //! The regex functions require the feature flag `regex_support`. //! //! ### Values //! //! Operators take values as arguments and produce values as results. //! Values can be boolean, integer or floating point numbers, strings, tuples or the empty type. //! Values are denoted as displayed in the following table. //! //! | Value type | Example | //! |------------|---------| //! | `Value::String` | `"abc"`, `""`, `"a\"b\\c"` | //! | `Value::Boolean` | `true`, `false` | //! | `Value::Int` | `3`, `-9`, `0`, `135412` | //! | `Value::Float` | `3.`, `.35`, `1.00`, `0.5`, `123.554` | //! | `Value::Tuple` | `(3, 55.0, false, ())`, `(1, 2)` | //! | `Value::Empty` | `()` | //! //! Integers are internally represented as `i64`, and floating point numbers are represented as `f64`. //! Tuples are represented as `Vec<Value>` and empty values are not stored, but represented by rust's unit type `()` where necessary. //! //! There exist type aliases for some of the types. //! They include `IntType`, `FloatType`, `TupleType` and `EmptyType`. //! //! Values can be constructed either directly or using the `From` trait. //! Values can be decomposed using the `Value::as_[type]` methods. //! The type of a value can be checked using the `Value::is_[type]` methods. //! //! **Examples for constructing a value:** //! //! | Code | Result | //! |------|--------| //! | `Value::from(4)` | `Value::Int(4)` | //! | `Value::from(4.4)` | `Value::Float(4.4)` | //! | `Value::from(true)` | `Value::Boolean(true)` | //! | `Value::from(vec![Value::from(3)])` | `Value::Tuple(vec![Value::Int(3)])` | //! //! **Examples for deconstructing a value:** //! //! | Code | Result | //! |------|--------| //! | `Value::from(4).as_int()` | `Ok(4)` | //! | `Value::from(4.4).as_float()` | `Ok(4.4)` | //! | `Value::from(true).as_int()` | `Err(Error::ExpectedInt {actual: Value::Boolean(true)})` | //! //! Operators that take numbers as arguments can either take integers or floating point numbers. //! If one of the arguments is a floating point number, all others are converted to floating point numbers as well, and the resulting value is a floating point number as well. //! Otherwise, the result is an integer. //! An exception to this is the exponentiation operator that always returns a floating point number. //! //! Values have a precedence of 200. //! //! ### Variables //! //! This crate allows to compile parameterizable formulas by using variables. //! A variable is a literal in the formula, that does not contain whitespace or can be parsed as value. //! The user needs to provide bindings to the variables for evaluation. //! This is done with the `Context` trait. //! Two structs implementing this trait are predefined. //! There is `EmptyContext`, that returns `None` for each request, and `HashMapContext`, that stores mappings from literals to variables in a hash map. //! //! Variables do not have fixed types in the expression itself, but are typed by the context. //! The `Context` trait contains a function that takes a string literal and returns a `Value` enum. //! The variant of this enum decides the type on evaluation. //! //! Variables have a precedence of 200. //! //! ### User-Defined Functions //! //! This crate also allows to define arbitrary functions to be used in parsed expressions. //! A function is defined as a `Function` instance. //! It contains two properties, the `argument_amount` and the `function`. //! The `function` is a boxed `Fn(&[Value]) -> EvalexprResult<Value, Error>`. //! The `argument_amount` determines the length of the slice that is passed to `function` if it is `Some(_)`, otherwise the function is defined to take an arbitrary amount of arguments. //! It is verified on execution by the crate and does not need to be verified by the `function`. //! //! Functions with no arguments are not allowed. //! Use variables instead. //! //! Be aware that functions need to verify the types of values that are passed to them. //! The `error` module contains some shortcuts for verification, and error types for passing a wrong value type. //! Also, most numeric functions need to differentiate between being called with integers or floating point numbers, and act accordingly. //! //! Functions are identified by literals, like variables as well. //! A literal identifies a function, if it is followed by an opening brace `(`, another literal, or a value. //! //! Same as variables, function bindings are provided by the user via a `Context`. //! Functions have a precedence of 190. //! //! ### Examplary variables and functions in expressions: //! //! | Expression | Valid? | Explanation | //! |------------|--------|-------------| //! | `a` | yes | | //! | `abc` | yes | | //! | `a<b` | no | Expression is interpreted as variable `a`, operator `<` and variable `b` | //! | `a b` | no | Expression is interpreted as function `a` applied to argument `b` | //! | `123` | no | Expression is interpreted as `Value::Int` | //! | `true` | no | Expression is interpreted as `Value::Bool` | //! | `.34` | no | Expression is interpreted as `Value::Float` | //! //! ### [Serde](https://serde.rs) //! //! To use this crate with serde, the `serde_support` feature flag has to be set. //! This can be done like this in the `Cargo.toml`: //! //! ```toml //! [dependencies] //! evalexpr = {version = "5", features = ["serde_support"]} //! ``` //! //! This crate implements `serde::de::Deserialize` for its type `Node` that represents a parsed expression tree. //! The implementation expects a [serde `string`](https://serde.rs/data-model.html) as input. //! Example parsing with [ron format](docs.rs/ron): //! //! ```rust //! # #[cfg(feature = "serde_support")] { //! extern crate ron; //! use evalexpr::*; //! //! let mut context = HashMapContext::new(); //! context.set_value("five".into(), 5.into()).unwrap(); // Do proper error handling here //! //! // In ron format, strings are surrounded by " //! let serialized_free = "\"five * five\""; //! match ron::de::from_str::<Node>(serialized_free) { //! Ok(free) => assert_eq!(free.eval_with_context(&context), Ok(Value::from(25))), //! Err(error) => { //! () // Handle error //! }, //! } //! # } //! ``` //! //! With `serde`, expressions can be integrated into arbitrarily complex data. //! //! The crate also implements `Serialize` and `Deserialize` for the `HashMapContext`. //! But note that only the variables get serialized, not the functions. //! //! ## License //! //! This crate is primarily distributed under the terms of the MIT license. //! See [LICENSE](LICENSE) for details. //! #![warn(missing_docs)] #[cfg(feature = "regex_support")] extern crate regex; #[cfg(test)] extern crate ron; #[cfg(feature = "serde_support")] extern crate serde; #[cfg(feature = "serde_support")] #[macro_use] extern crate serde_derive; pub use context::{Context, EmptyContext, HashMapContext}; pub use error::{EvalexprError, EvalexprResult}; pub use function::Function; pub use interface::*; pub use tree::Node; pub use value::{ value_type::ValueType, EmptyType, FloatType, IntType, TupleType, Value, EMPTY_VALUE, }; mod context; pub mod error; #[cfg(feature = "serde_support")] mod feature_serde; mod function; mod interface; mod operator; mod token; mod tree; mod value; // Exports