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
//!# XLFormula Engine
//!XLFormula Engine is a Rust crate for parsing and evaluating Excel formulas. It currently works with f32 types.
//!
//!## Features
//!It supports:
//!
//!* Any numbers, negative and positive, as float or integer
//!* Arithmetic operations +, -, /, *, ^
//!* Logical operations AND(), OR(), NOT(), XOR()
//!* Comparison operations =, >, >=, <, <=, <>
//!* String operation & (concatenation)
//!* Build-in variables TRUE, FALSE
//!* Excel functions ABS(), SUM(), PRODUCT(), AVERAGE(), RIGHT(), LEFT(), IF(), ISBLANK()
//!* Operations on lists of values (one dimensional range)
//!* Add or subtract dates and excel funtion DAYS()
//!* Custom functions with number arguments
//!* Handle blank/null values in calculation
//!* Handle empty/missing parameters of function calls as blank values
//!
//!## Installation
//!
//!Add the corresponding entry to your Cargo.toml dependency list:
//!```toml
//![dependencies]
//!xlformula_engine = "0.1.17"
//!```
//!and add this to your crate root:
//!```rust
//!extern crate xlformula_engine;
//!```
//!
//!## Examples
//!
//!Here are simple examples of parsing an Excel formula string and evaluating to a result:
//!```rust
//!extern crate xlformula_engine;
//!use xlformula_engine::calculate;
//!use xlformula_engine::parse_formula;
//!use xlformula_engine::NoReference;
//!use xlformula_engine::NoCustomFunction;
//!
//!let formula = parse_formula::parse_string_to_formula(&"=1+2", None::<NoCustomFunction>);
//!let result = calculate::calculate_formula(formula, None::<NoReference>);
//!println!("Result is {}", calculate::result_to_string(result));
//!
//!let formula = parse_formula::parse_string_to_formula(&"=(1*(2+3))*2", None::<NoCustomFunction>);
//!let result = calculate::calculate_formula(formula, None::<NoReference>);
//!println!("Result is {}", calculate::result_to_string(result));
//!
//!let formula = parse_formula::parse_string_to_formula(&"=1+3/0", None::<NoCustomFunction>); // error (#DIV/0!)
//!let result = calculate::calculate_formula(formula, None::<NoReference>);
//!println!("Result is {}", calculate::result_to_string(result));
//!```
//!The last string is evaluated to #DIV/0!.
//!
//!Concatenating strings:
//!```rust
//!extern crate xlformula_engine;
//!use xlformula_engine::calculate;
//!use xlformula_engine::parse_formula;
//!use xlformula_engine::NoReference;
//!use xlformula_engine::NoCustomFunction;
//!
//!let formula = parse_formula::parse_string_to_formula(&"=\"Hello \" & \" World!\"", None::<NoCustomFunction>);
//!let result = calculate::calculate_formula(formula, None::<NoReference>);
//!println!("Result is {}", calculate::result_to_string(result));
//!
//!let formula = parse_formula::parse_string_to_formula(&"=1 + \"Hello\"", None::<NoCustomFunction>); // error (#CAST!)
//!let result = calculate::calculate_formula(formula, None::<NoReference>);
//!println!("Result is {}", calculate::result_to_string(result));
//!```
//!Concatenating number and string results in a #CAST! error.
//!
//!Constants ( i.e. a string without '=' ):
//!```rust
//!extern crate xlformula_engine;
//!use xlformula_engine::calculate;
//!use xlformula_engine::parse_formula;
//!use xlformula_engine::NoReference;
//!use xlformula_engine::NoCustomFunction;
//!
//!let formula = parse_formula::parse_string_to_formula(&"1.2", None::<NoCustomFunction>);
//!let result = calculate::calculate_formula(formula, None::<NoReference>);
//!println!("Result is {}", calculate::result_to_string(result));
//!
//!let formula = parse_formula::parse_string_to_formula(&"Hello World", None::<NoCustomFunction>);
//!let result = calculate::calculate_formula(formula, None::<NoReference>);
//!println!("Result is {}", calculate::result_to_string(result));
//!```
//!
//!Excel functions:
//!```rust
//!extern crate xlformula_engine;
//!use xlformula_engine::calculate;
//!use xlformula_engine::parse_formula;
//!use xlformula_engine::NoReference;
//!use xlformula_engine::NoCustomFunction;
//!
//!let formula = parse_formula::parse_string_to_formula(&"=ABS(-1)", None::<NoCustomFunction>);
//!let result = calculate::calculate_formula(formula, None::<NoReference>);
//!println!("Result is {}", calculate::result_to_string(result));
//!
//!let formula = parse_formula::parse_string_to_formula(&"=SUM(1,2,\"3\")", None::<NoCustomFunction>);
//!let result = calculate::calculate_formula(formula, None::<NoReference>);
//!println!("Result is {}", calculate::result_to_string(result));
//!
//!let formula = parse_formula::parse_string_to_formula(&"=PRODUCT(ABS(1),2*1, 3,4*1)", None::<NoCustomFunction>);
//!let result = calculate::calculate_formula(formula, None::<NoReference>);
//!println!("Result is {}", calculate::result_to_string(result));
//!
//!let formula = parse_formula::parse_string_to_formula(&"=RIGHT(\"apple\", 3)", None::<NoCustomFunction>);
//!let result = calculate::calculate_formula(formula, None::<NoReference>);
//!println!("Result is {}", calculate::result_to_string(result));
//!
//!let formula = parse_formula::parse_string_to_formula(&"=LEFT(\"apple\", 3)", None::<NoCustomFunction>);
//!let result = calculate::calculate_formula(formula, None::<NoReference>);
//!println!("Result is {}", calculate::result_to_string(result));
//!
//!let formula = parse_formula::parse_string_to_formula(&"=LEFT(\"apple\")", None::<NoCustomFunction>);
//!let result = calculate::calculate_formula(formula, None::<NoReference>);
//!println!("Result is {}", calculate::result_to_string(result));
//!
//!let formula = parse_formula::parse_string_to_formula(&"=IF(TRUE,1,0)", None::<NoCustomFunction>);
//!let result = calculate::calculate_formula(formula, None::<NoReference>);
//!println!("Result is {}", calculate::result_to_string(result));
//!```
//!
//!Logical expressions:
//!```rust
//!extern crate xlformula_engine;
//!use xlformula_engine::calculate;
//!use xlformula_engine::parse_formula;
//!use xlformula_engine::NoReference;
//!use xlformula_engine::NoCustomFunction;
//!
//!let formula = parse_formula::parse_string_to_formula(&"=2>=1", None::<NoCustomFunction>);
//!let result = calculate::calculate_formula(formula, None::<NoReference>);
//!println!("Result is {}", calculate::result_to_string(result));
//!
//!let formula = parse_formula::parse_string_to_formula(&"=OR(1>1,1<>1)", None::<NoCustomFunction>);
//!let result = calculate::calculate_formula(formula, None::<NoReference>);
//!println!("Result is {}", calculate::result_to_string(result));
//!
//!let formula = parse_formula::parse_string_to_formula(&"=AND(\"test\",\"True\", 1, true) ", None::<NoCustomFunction>);
//!let result = calculate::calculate_formula(formula, None::<NoReference>);
//!println!("Result is {}", calculate::result_to_string(result));
//!```
//!
//!References:
//!```rust
//!extern crate xlformula_engine;
//!use xlformula_engine::calculate;
//!use xlformula_engine::parse_formula;
//!use xlformula_engine::types;
//!use xlformula_engine::NoCustomFunction;
//!
//!let data_function = |s: String| match s.as_str() {
//!"A" => types::Value::Text("=1+B".to_string()),
//!"B" => types::Value::Number(3.0),
//!_ => types::Value::Error(types::Error::Value),
//!};
//!let formula = parse_formula::parse_string_to_formula(&"=A+B", None::<NoCustomFunction>);
//!let result = calculate::calculate_formula(formula, Some(&data_function));
//!println!("Result is {}", calculate::result_to_string(result));
//!```
//!
//!List:
//!```rust
//!extern crate xlformula_engine;
//!use xlformula_engine::calculate;
//!use xlformula_engine::parse_formula;
//!use xlformula_engine::NoReference;
//!use xlformula_engine::NoCustomFunction;
//!
//!let formula = parse_formula::parse_string_to_formula(&"={1,2,3}+{1,2,3}", None::<NoCustomFunction>);
//!let result = calculate::calculate_formula(formula, None::<NoReference>);
//!println!("Result is {}", calculate::result_to_string(result));
//!
//!let formula = parse_formula::parse_string_to_formula(&"=XOR({0,0,0})", None::<NoCustomFunction>);
//!let result = calculate::calculate_formula(formula, None::<NoReference>);
//!println!("Result is {}", calculate::result_to_string(result));
//!
//!let formula = parse_formula::parse_string_to_formula(&"=AVERAGE({1,2,3},1,2,3)", None::<NoCustomFunction>);
//!let result = calculate::calculate_formula(formula, None::<NoReference>);
//!println!("Result is {}", calculate::result_to_string(result));
//!```
//!
//!Date:
//!```rust
//!extern crate xlformula_engine;
//!use xlformula_engine::calculate;
//!use xlformula_engine::parse_formula;
//!use xlformula_engine::types;
//!use chrono::format::ParseError;
//!use chrono::{DateTime, FixedOffset};
//!use xlformula_engine::NoCustomFunction;
//!
//!fn main() -> Result<(), ParseError> {
//!let start: DateTime<FixedOffset> = DateTime::parse_from_rfc3339("2019-03-01T02:00:00.000Z")?;
//!let end: DateTime<FixedOffset> = DateTime::parse_from_rfc3339("2019-08-30T02:00:00.000Z")?;
//!let data_function = |s: String| match s.as_str() {
//!"start" => types::Value::Date(start),
//!"end" => types::Value::Date(end),
//!_ => types::Value::Error(types::Error::Value),
//!};
//!
//!let formula = parse_formula::parse_string_to_formula(&"=DAYS(end, start)", None::<NoCustomFunction>);
//!let result = calculate::calculate_formula(formula, Some(&data_function));
//!println!("Result is {}", calculate::result_to_string(result));
//!
//!let formula = parse_formula::parse_string_to_formula(&"=start+1", None::<NoCustomFunction>);
//!let result = calculate::calculate_formula(formula, Some(&data_function));
//!println!("Result is {}", calculate::result_to_string(result));
//!
//!let formula = parse_formula::parse_string_to_formula(&"=end-3", None::<NoCustomFunction>);
//!let result = calculate::calculate_formula(formula, Some(&data_function));
//!println!("Result is {}", calculate::result_to_string(result));
//! Ok(())
//!}
//!```
//!
//!Custom Function:
//!```rust
//!extern crate xlformula_engine;
//!use xlformula_engine::calculate;
//!use xlformula_engine::parse_formula;
//!use xlformula_engine::types;
//!use xlformula_engine::NoReference;
//!
//!let custom_functions = |s: String, params: Vec<f32>| match s.as_str() {
//!"Increase" => types::Value::Number(params[0] + 1.0),
//!"SimpleSum" => types::Value::Number(params[0] + params[1]),
//!"EqualFive" => types::Value::Number(5.0),
//!_ => types::Value::Error(types::Error::Value),
//!};
//!
//!let formula =
//!parse_formula::parse_string_to_formula(&"=Increase(1)+1", Some(&custom_functions));
//!let result = calculate::calculate_formula(formula, None::<NoReference>);
//!println!("Result is {}", calculate::result_to_string(result));
//!
//!let formula =
//!parse_formula::parse_string_to_formula(&"=EqualFive()+1", Some(&custom_functions));
//!let result = calculate::calculate_formula(formula, None::<NoReference>);
//!println!("Result is {}", calculate::result_to_string(result));
//!
//!let formula =
//!parse_formula::parse_string_to_formula(&"=SimpleSum(1,2)", Some(&custom_functions));
//!let result = calculate::calculate_formula(formula, None::<NoReference>);
//!println!("Result is {}", calculate::result_to_string(result));
//!```
//!
//!Handle blank in calculation:
//!```rust
//!extern crate xlformula_engine;
//!use xlformula_engine::calculate;
//!use xlformula_engine::parse_formula;
//!use xlformula_engine::types;
//!use chrono::format::ParseError;
//!use chrono::{DateTime, FixedOffset};
//!use xlformula_engine::NoReference;
//!use xlformula_engine::NoCustomFunction;
//!
//!let data_function = |s: String| match s.as_str() {
//!"B" => types::Value::Blank,
//!_ => types::Value::Error(types::Error::Value),
//!};
//!
//!let custom_functions = |s: String, params: Vec<f32>| match s.as_str() {
//!"BLANK" => types::Value::Blank,
//!_ => types::Value::Error(types::Error::Value),
//!};
//!
//!let formula = parse_formula::parse_string_to_formula(&"=SUM(B, 1)", None::<NoCustomFunction>);
//!let result = calculate::calculate_formula(formula, Some(&data_function));
//!println!("Result is {}", calculate::result_to_string(result));
//!
//!let formula =
//!parse_formula::parse_string_to_formula(&"=SUM(BLANK(), 1)", Some(&custom_functions));
//!let result = calculate::calculate_formula(formula, None::<NoReference>);
//!println!("Result is {}", calculate::result_to_string(result));
//!
//!//takes list as input
//!let formula = parse_formula::parse_string_to_formula(&"=SUM({B, 1})", None::<NoCustomFunction>);
//!let result = calculate::calculate_formula(formula, Some(&data_function));
//!println!("Result is {}", calculate::result_to_string(result));
//!
//!let formula =
//!parse_formula::parse_string_to_formula(&"=SUM(1, 2, , 3)", None::<NoCustomFunction>);
//!let result = calculate::calculate_formula(formula, None::<NoReference>);
//!println!("Result is {}", calculate::result_to_string(result));
//!```
#[macro_use]
extern crate pest_derive;
/// Evaluates a formula.
pub mod calculate;
/// The Structs and Enums for the calculation.
pub mod types;
/// Parses a string using `pest` and `pest::prec_climber`.
pub mod parse_formula;
pub type NoReference<'a> = &'a fn(String) -> types::Value;
pub type NoCustomFunction<'a> = &'a fn(String, Vec<f32>) -> types::Value;