├── .gitignore ├── .travis.yml ├── Cargo.toml ├── LICENSE.txt ├── README.md ├── src ├── lib.rs ├── parse.rs ├── random.rs ├── roll.rs └── rouler.pest └── tests └── roller.rs /.gitignore: -------------------------------------------------------------------------------- 1 | target 2 | Cargo.lock 3 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: rust 2 | rust: 3 | - stable 4 | - beta 5 | - nightly 6 | matrix: 7 | allow_failures: 8 | - rust: nightly 9 | fast_finish: true 10 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "rouler" 3 | description = "A container-like system for generating dice rolls" 4 | keywords = ["dice", "roller", "RPG", "game", "gaming"] 5 | version = "0.2.2" 6 | readme = "README.md" 7 | authors = ["jarcane "] 8 | license = "MPL-2.0" 9 | homepage = "https://github.com/jarcane/rouler" 10 | documentation = "https://docs.rs/rouler/" 11 | repository = "https://github.com/jarcane/rouler" 12 | 13 | [dependencies] 14 | pest = "1.0" 15 | pest_derive = "1.0" 16 | lazy_static = "1.0" 17 | rand = "0.5" 18 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | Mozilla Public License Version 2.0 2 | ================================== 3 | 4 | 1. Definitions 5 | -------------- 6 | 7 | 1.1. "Contributor" 8 | means each individual or legal entity that creates, contributes to 9 | the creation of, or owns Covered Software. 10 | 11 | 1.2. "Contributor Version" 12 | means the combination of the Contributions of others (if any) used 13 | by a Contributor and that particular Contributor's Contribution. 14 | 15 | 1.3. "Contribution" 16 | means Covered Software of a particular Contributor. 17 | 18 | 1.4. "Covered Software" 19 | means Source Code Form to which the initial Contributor has attached 20 | the notice in Exhibit A, the Executable Form of such Source Code 21 | Form, and Modifications of such Source Code Form, in each case 22 | including portions thereof. 23 | 24 | 1.5. "Incompatible With Secondary Licenses" 25 | means 26 | 27 | (a) that the initial Contributor has attached the notice described 28 | in Exhibit B to the Covered Software; or 29 | 30 | (b) that the Covered Software was made available under the terms of 31 | version 1.1 or earlier of the License, but not also under the 32 | terms of a Secondary License. 33 | 34 | 1.6. "Executable Form" 35 | means any form of the work other than Source Code Form. 36 | 37 | 1.7. "Larger Work" 38 | means a work that combines Covered Software with other material, in 39 | a separate file or files, that is not Covered Software. 40 | 41 | 1.8. "License" 42 | means this document. 43 | 44 | 1.9. "Licensable" 45 | means having the right to grant, to the maximum extent possible, 46 | whether at the time of the initial grant or subsequently, any and 47 | all of the rights conveyed by this License. 48 | 49 | 1.10. "Modifications" 50 | means any of the following: 51 | 52 | (a) any file in Source Code Form that results from an addition to, 53 | deletion from, or modification of the contents of Covered 54 | Software; or 55 | 56 | (b) any new file in Source Code Form that contains any Covered 57 | Software. 58 | 59 | 1.11. "Patent Claims" of a Contributor 60 | means any patent claim(s), including without limitation, method, 61 | process, and apparatus claims, in any patent Licensable by such 62 | Contributor that would be infringed, but for the grant of the 63 | License, by the making, using, selling, offering for sale, having 64 | made, import, or transfer of either its Contributions or its 65 | Contributor Version. 66 | 67 | 1.12. "Secondary License" 68 | means either the GNU General Public License, Version 2.0, the GNU 69 | Lesser General Public License, Version 2.1, the GNU Affero General 70 | Public License, Version 3.0, or any later versions of those 71 | licenses. 72 | 73 | 1.13. "Source Code Form" 74 | means the form of the work preferred for making modifications. 75 | 76 | 1.14. "You" (or "Your") 77 | means an individual or a legal entity exercising rights under this 78 | License. For legal entities, "You" includes any entity that 79 | controls, is controlled by, or is under common control with You. For 80 | purposes of this definition, "control" means (a) the power, direct 81 | or indirect, to cause the direction or management of such entity, 82 | whether by contract or otherwise, or (b) ownership of more than 83 | fifty percent (50%) of the outstanding shares or beneficial 84 | ownership of such entity. 85 | 86 | 2. License Grants and Conditions 87 | -------------------------------- 88 | 89 | 2.1. Grants 90 | 91 | Each Contributor hereby grants You a world-wide, royalty-free, 92 | non-exclusive license: 93 | 94 | (a) under intellectual property rights (other than patent or trademark) 95 | Licensable by such Contributor to use, reproduce, make available, 96 | modify, display, perform, distribute, and otherwise exploit its 97 | Contributions, either on an unmodified basis, with Modifications, or 98 | as part of a Larger Work; and 99 | 100 | (b) under Patent Claims of such Contributor to make, use, sell, offer 101 | for sale, have made, import, and otherwise transfer either its 102 | Contributions or its Contributor Version. 103 | 104 | 2.2. Effective Date 105 | 106 | The licenses granted in Section 2.1 with respect to any Contribution 107 | become effective for each Contribution on the date the Contributor first 108 | distributes such Contribution. 109 | 110 | 2.3. Limitations on Grant Scope 111 | 112 | The licenses granted in this Section 2 are the only rights granted under 113 | this License. No additional rights or licenses will be implied from the 114 | distribution or licensing of Covered Software under this License. 115 | Notwithstanding Section 2.1(b) above, no patent license is granted by a 116 | Contributor: 117 | 118 | (a) for any code that a Contributor has removed from Covered Software; 119 | or 120 | 121 | (b) for infringements caused by: (i) Your and any other third party's 122 | modifications of Covered Software, or (ii) the combination of its 123 | Contributions with other software (except as part of its Contributor 124 | Version); or 125 | 126 | (c) under Patent Claims infringed by Covered Software in the absence of 127 | its Contributions. 128 | 129 | This License does not grant any rights in the trademarks, service marks, 130 | or logos of any Contributor (except as may be necessary to comply with 131 | the notice requirements in Section 3.4). 132 | 133 | 2.4. Subsequent Licenses 134 | 135 | No Contributor makes additional grants as a result of Your choice to 136 | distribute the Covered Software under a subsequent version of this 137 | License (see Section 10.2) or under the terms of a Secondary License (if 138 | permitted under the terms of Section 3.3). 139 | 140 | 2.5. Representation 141 | 142 | Each Contributor represents that the Contributor believes its 143 | Contributions are its original creation(s) or it has sufficient rights 144 | to grant the rights to its Contributions conveyed by this License. 145 | 146 | 2.6. Fair Use 147 | 148 | This License is not intended to limit any rights You have under 149 | applicable copyright doctrines of fair use, fair dealing, or other 150 | equivalents. 151 | 152 | 2.7. Conditions 153 | 154 | Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted 155 | in Section 2.1. 156 | 157 | 3. Responsibilities 158 | ------------------- 159 | 160 | 3.1. Distribution of Source Form 161 | 162 | All distribution of Covered Software in Source Code Form, including any 163 | Modifications that You create or to which You contribute, must be under 164 | the terms of this License. You must inform recipients that the Source 165 | Code Form of the Covered Software is governed by the terms of this 166 | License, and how they can obtain a copy of this License. You may not 167 | attempt to alter or restrict the recipients' rights in the Source Code 168 | Form. 169 | 170 | 3.2. Distribution of Executable Form 171 | 172 | If You distribute Covered Software in Executable Form then: 173 | 174 | (a) such Covered Software must also be made available in Source Code 175 | Form, as described in Section 3.1, and You must inform recipients of 176 | the Executable Form how they can obtain a copy of such Source Code 177 | Form by reasonable means in a timely manner, at a charge no more 178 | than the cost of distribution to the recipient; and 179 | 180 | (b) You may distribute such Executable Form under the terms of this 181 | License, or sublicense it under different terms, provided that the 182 | license for the Executable Form does not attempt to limit or alter 183 | the recipients' rights in the Source Code Form under this License. 184 | 185 | 3.3. Distribution of a Larger Work 186 | 187 | You may create and distribute a Larger Work under terms of Your choice, 188 | provided that You also comply with the requirements of this License for 189 | the Covered Software. If the Larger Work is a combination of Covered 190 | Software with a work governed by one or more Secondary Licenses, and the 191 | Covered Software is not Incompatible With Secondary Licenses, this 192 | License permits You to additionally distribute such Covered Software 193 | under the terms of such Secondary License(s), so that the recipient of 194 | the Larger Work may, at their option, further distribute the Covered 195 | Software under the terms of either this License or such Secondary 196 | License(s). 197 | 198 | 3.4. Notices 199 | 200 | You may not remove or alter the substance of any license notices 201 | (including copyright notices, patent notices, disclaimers of warranty, 202 | or limitations of liability) contained within the Source Code Form of 203 | the Covered Software, except that You may alter any license notices to 204 | the extent required to remedy known factual inaccuracies. 205 | 206 | 3.5. Application of Additional Terms 207 | 208 | You may choose to offer, and to charge a fee for, warranty, support, 209 | indemnity or liability obligations to one or more recipients of Covered 210 | Software. However, You may do so only on Your own behalf, and not on 211 | behalf of any Contributor. You must make it absolutely clear that any 212 | such warranty, support, indemnity, or liability obligation is offered by 213 | You alone, and You hereby agree to indemnify every Contributor for any 214 | liability incurred by such Contributor as a result of warranty, support, 215 | indemnity or liability terms You offer. You may include additional 216 | disclaimers of warranty and limitations of liability specific to any 217 | jurisdiction. 218 | 219 | 4. Inability to Comply Due to Statute or Regulation 220 | --------------------------------------------------- 221 | 222 | If it is impossible for You to comply with any of the terms of this 223 | License with respect to some or all of the Covered Software due to 224 | statute, judicial order, or regulation then You must: (a) comply with 225 | the terms of this License to the maximum extent possible; and (b) 226 | describe the limitations and the code they affect. Such description must 227 | be placed in a text file included with all distributions of the Covered 228 | Software under this License. Except to the extent prohibited by statute 229 | or regulation, such description must be sufficiently detailed for a 230 | recipient of ordinary skill to be able to understand it. 231 | 232 | 5. Termination 233 | -------------- 234 | 235 | 5.1. The rights granted under this License will terminate automatically 236 | if You fail to comply with any of its terms. However, if You become 237 | compliant, then the rights granted under this License from a particular 238 | Contributor are reinstated (a) provisionally, unless and until such 239 | Contributor explicitly and finally terminates Your grants, and (b) on an 240 | ongoing basis, if such Contributor fails to notify You of the 241 | non-compliance by some reasonable means prior to 60 days after You have 242 | come back into compliance. Moreover, Your grants from a particular 243 | Contributor are reinstated on an ongoing basis if such Contributor 244 | notifies You of the non-compliance by some reasonable means, this is the 245 | first time You have received notice of non-compliance with this License 246 | from such Contributor, and You become compliant prior to 30 days after 247 | Your receipt of the notice. 248 | 249 | 5.2. If You initiate litigation against any entity by asserting a patent 250 | infringement claim (excluding declaratory judgment actions, 251 | counter-claims, and cross-claims) alleging that a Contributor Version 252 | directly or indirectly infringes any patent, then the rights granted to 253 | You by any and all Contributors for the Covered Software under Section 254 | 2.1 of this License shall terminate. 255 | 256 | 5.3. In the event of termination under Sections 5.1 or 5.2 above, all 257 | end user license agreements (excluding distributors and resellers) which 258 | have been validly granted by You or Your distributors under this License 259 | prior to termination shall survive termination. 260 | 261 | ************************************************************************ 262 | * * 263 | * 6. Disclaimer of Warranty * 264 | * ------------------------- * 265 | * * 266 | * Covered Software is provided under this License on an "as is" * 267 | * basis, without warranty of any kind, either expressed, implied, or * 268 | * statutory, including, without limitation, warranties that the * 269 | * Covered Software is free of defects, merchantable, fit for a * 270 | * particular purpose or non-infringing. The entire risk as to the * 271 | * quality and performance of the Covered Software is with You. * 272 | * Should any Covered Software prove defective in any respect, You * 273 | * (not any Contributor) assume the cost of any necessary servicing, * 274 | * repair, or correction. This disclaimer of warranty constitutes an * 275 | * essential part of this License. No use of any Covered Software is * 276 | * authorized under this License except under this disclaimer. * 277 | * * 278 | ************************************************************************ 279 | 280 | ************************************************************************ 281 | * * 282 | * 7. Limitation of Liability * 283 | * -------------------------- * 284 | * * 285 | * Under no circumstances and under no legal theory, whether tort * 286 | * (including negligence), contract, or otherwise, shall any * 287 | * Contributor, or anyone who distributes Covered Software as * 288 | * permitted above, be liable to You for any direct, indirect, * 289 | * special, incidental, or consequential damages of any character * 290 | * including, without limitation, damages for lost profits, loss of * 291 | * goodwill, work stoppage, computer failure or malfunction, or any * 292 | * and all other commercial damages or losses, even if such party * 293 | * shall have been informed of the possibility of such damages. This * 294 | * limitation of liability shall not apply to liability for death or * 295 | * personal injury resulting from such party's negligence to the * 296 | * extent applicable law prohibits such limitation. Some * 297 | * jurisdictions do not allow the exclusion or limitation of * 298 | * incidental or consequential damages, so this exclusion and * 299 | * limitation may not apply to You. * 300 | * * 301 | ************************************************************************ 302 | 303 | 8. Litigation 304 | ------------- 305 | 306 | Any litigation relating to this License may be brought only in the 307 | courts of a jurisdiction where the defendant maintains its principal 308 | place of business and such litigation shall be governed by laws of that 309 | jurisdiction, without reference to its conflict-of-law provisions. 310 | Nothing in this Section shall prevent a party's ability to bring 311 | cross-claims or counter-claims. 312 | 313 | 9. Miscellaneous 314 | ---------------- 315 | 316 | This License represents the complete agreement concerning the subject 317 | matter hereof. If any provision of this License is held to be 318 | unenforceable, such provision shall be reformed only to the extent 319 | necessary to make it enforceable. Any law or regulation which provides 320 | that the language of a contract shall be construed against the drafter 321 | shall not be used to construe this License against a Contributor. 322 | 323 | 10. Versions of the License 324 | --------------------------- 325 | 326 | 10.1. New Versions 327 | 328 | Mozilla Foundation is the license steward. Except as provided in Section 329 | 10.3, no one other than the license steward has the right to modify or 330 | publish new versions of this License. Each version will be given a 331 | distinguishing version number. 332 | 333 | 10.2. Effect of New Versions 334 | 335 | You may distribute the Covered Software under the terms of the version 336 | of the License under which You originally received the Covered Software, 337 | or under the terms of any subsequent version published by the license 338 | steward. 339 | 340 | 10.3. Modified Versions 341 | 342 | If you create software not governed by this License, and you want to 343 | create a new license for such software, you may create and use a 344 | modified version of this License if you rename the license and remove 345 | any references to the name of the license steward (except to note that 346 | such modified license differs from this License). 347 | 348 | 10.4. Distributing Source Code Form that is Incompatible With Secondary 349 | Licenses 350 | 351 | If You choose to distribute Source Code Form that is Incompatible With 352 | Secondary Licenses under the terms of this version of the License, the 353 | notice described in Exhibit B of this License must be attached. 354 | 355 | Exhibit A - Source Code Form License Notice 356 | ------------------------------------------- 357 | 358 | This Source Code Form is subject to the terms of the Mozilla Public 359 | License, v. 2.0. If a copy of the MPL was not distributed with this 360 | file, You can obtain one at http://mozilla.org/MPL/2.0/. 361 | 362 | If it is not possible or desirable to put the notice in a particular 363 | file, then You may include the notice in a location (such as a LICENSE 364 | file in a relevant directory) where a recipient would be likely to look 365 | for such a notice. 366 | 367 | You may add additional accurate notices of copyright ownership. 368 | 369 | Exhibit B - "Incompatible With Secondary Licenses" Notice 370 | --------------------------------------------------------- 371 | 372 | This Source Code Form is "Incompatible With Secondary Licenses", as 373 | defined by the Mozilla Public License, v. 2.0. 374 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # rouler 2 | [![Crates.io](https://img.shields.io/crates/v/rouler.svg)](https://crates.io/crates/rouler) [![docs.rs](https://docs.rs/rouler/badge.svg)](https://docs.rs/rouler/) [![Build Status](https://travis-ci.com/jarcane/rouler.svg?branch=master)](https://app.travis-ci.com/jarcane/rouler) 3 | 4 | A container-like system for generating dice rolls 5 | 6 | ## Usage 7 | 8 | rouler is a Rust library for generating die rolls from convenient little state containers. A die roll can be created and stored and called repeatedly to generate new values. 9 | 10 | This allows easy use and re-use of specific die rolls, and even comparison. 11 | 12 | ```rust 13 | extern crate rouler; 14 | 15 | use rouler::Roller; 16 | 17 | let mut stat = Roller::new("3d6"); 18 | 19 | println!("STR: {}", stat.total()); 20 | println!("DEX: {}", stat.reroll()); 21 | 22 | println!("Last stat roll: {}", stat); 23 | 24 | let att = Roller::new("1d20 + 5"); 25 | let def = Roller::new("1d20 + 2"); 26 | 27 | if att > def { 28 | println!("You struck the monster!"); 29 | } else { 30 | println!("You missed!"); 31 | } 32 | ``` 33 | 34 | ## License 35 | 36 | This Source Code Form is subject to the terms of the Mozilla Public 37 | License, v. 2.0. If a copy of the MPL was not distributed with this 38 | file, You can obtain one at http://mozilla.org/MPL/2.0/. 39 | -------------------------------------------------------------------------------- /src/lib.rs: -------------------------------------------------------------------------------- 1 | // rouler - A container-based system for generating die rolls 2 | // Copyright (C) 2016 by John Berry 3 | // 4 | // This Source Code Form is subject to the terms of the Mozilla Public 5 | // License, v. 2.0. If a copy of the MPL was not distributed with this 6 | // file, You can obtain one at http://mozilla.org/MPL/2.0/. 7 | 8 | #![warn(missing_docs)] 9 | //! # rouler - A container-like system for generating dice rolls 10 | //! 11 | //! [![Crates.io](https://img.shields.io/crates/v/rouler.svg)](https://crates.io/crates/rouler) 12 | //! 13 | //! rouler is a library for handling repeatable dice rolls in a conveniently storable way. 14 | //! At the heart of rouler is the `Roller`, a simple struct that contains both the syntax for a specific 15 | //! dice roll, and the result of the most recent roll. This allows you to store a particular roll 16 | //! type in a variable, that can then be passed around (within the limits of mutable values), and 17 | //! repeated via method calls as needed. It is meant to be useful for CRPGs and tabletop game aids. 18 | //! 19 | //! ## Example usage 20 | //! 21 | //! ``` 22 | //! use rouler::Roller; 23 | //! 24 | //! let mut stat = Roller::new("3d6"); 25 | //! 26 | //! println!("STR: {}", stat.total()); 27 | //! println!("DEX: {}", stat.reroll()); 28 | //! ``` 29 | //! 30 | //! ## The Die Roll Syntax 31 | //! 32 | //! rouler uses parsed strings to define die rolls, according to the following [pest](https://github.com/dragostis/pest/) 33 | //! grammar found in `rouler.pest`, with some additional rules checking: 34 | //! 35 | //! ```rust,ignore 36 | //! number = @{ "-"? ~ ("0" | '1'..'9' ~ '0'..'9'*) } 37 | //! op = _{ plus | minus | times | slash } 38 | //! plus = { "+" } 39 | //! minus = { "-" } 40 | //! times = { "*" } 41 | //! slash = { "/" } 42 | //! 43 | //! dice = _{ number ~ (roll ~ number) } 44 | //! roll = { "d" | "D" } 45 | //! custom_dice = { number ~ roll ~ sides } 46 | //! sides = _{ "[" ~ number ~ ("," ~ number )* ~ "]" } 47 | //! 48 | //! expr = { term ~ (op ~ term)* } 49 | //! term = _{ custom_dice | dice | number | "(" ~ expr ~ ")" } 50 | //! 51 | //! calc = _{ soi ~ expr ~ eoi } 52 | //! 53 | //! whitespace = _{ " " } 54 | //! ``` 55 | //! 56 | //! Largely this should all be familiar basic mathematical notation, the key addition being the `d` operator, 57 | //! which operates according to the standard notation familiar from tabletop RPGs, ie.: 58 | //! 59 | //! `n[d|D]s`, where `n` = the number of dice to roll, and `s` = the number of sides on each die. 60 | //! 61 | //! There are additional constraints checked for in this operator alone as well: neither `n` or `s` can be zero, 62 | //! and `s` cannot be a negative number. `n` is allowed to be negative, but rather than rolling "negative dice", 63 | //! this merely negates the value of the entire roll, such that `-3d6` would generate a value between -3 and -18. 64 | //! 65 | //! Custom dice can also be specified, with arbitrary specific values, such as `1d[2,4,8,16,32,64]`, where the 66 | //! list after the `d` operator represents each face on the specified die (in this case, a backgammon doubling cube). 67 | //! 68 | //! ## Changelog 69 | //! 70 | //! ### 0.2.1 71 | //! * docs update 72 | //! 73 | //! ### 0.2.0 74 | //! * support for better error handling 75 | //! * updated to pest 1.0 grammar 76 | //! * arbitrary die sequences 77 | //! 78 | //! ### 0.1.3 79 | //! * Added Iterator support to Rollers 80 | //! * Better type inference for Roller::new() 81 | //! 82 | //! ### 0.1.2 83 | //! * Documentation fixes 84 | //! 85 | //! ### 0.1.1 86 | //! * Documentation fixes 87 | //! 88 | //! ### 0.1.0 89 | //! * Initial release 90 | //! 91 | #[macro_use] 92 | extern crate pest; 93 | #[macro_use] 94 | extern crate pest_derive; 95 | extern crate rand; 96 | #[macro_use] 97 | extern crate lazy_static; 98 | 99 | mod parse; 100 | mod random; 101 | mod roll; 102 | 103 | pub use roll::{Roller, roll_dice, roll_dice_or_fail, roller_or_fail}; 104 | -------------------------------------------------------------------------------- /src/parse.rs: -------------------------------------------------------------------------------- 1 | // rouler - A container-based system for generating die rolls 2 | // Copyright (C) 2016 by John Berry 3 | // 4 | // This Source Code Form is subject to the terms of the Mozilla Public 5 | // License, v. 2.0. If a copy of the MPL was not distributed with this 6 | // file, You can obtain one at http://mozilla.org/MPL/2.0/. 7 | 8 | use pest::{ 9 | prec_climber::*, 10 | iterators::*, 11 | }; 12 | use random::*; 13 | 14 | lazy_static! { 15 | static ref PREC_CLIMBER: PrecClimber = { 16 | use self::Assoc::*; 17 | use self::Rule::*; 18 | 19 | // Order of precedence: "+-" is less than "*/" is less than "dD" 20 | PrecClimber::new(vec![ 21 | Operator::new(plus, Left) | Operator::new(minus, Left), 22 | Operator::new(times, Left) | Operator::new(slash, Left), 23 | Operator::new(roll, Right), 24 | ]) 25 | }; 26 | } 27 | 28 | #[derive(Parser)] 29 | #[grammar = "rouler.pest"] 30 | pub struct RollParser; 31 | 32 | // Force recompile when parse changes 33 | const _GRAMMAR : &str = include_str!("rouler.pest"); 34 | 35 | pub fn compute(expr: Pairs) -> i64 { 36 | PREC_CLIMBER.climb( 37 | expr, 38 | |pair: Pair| match pair.as_rule() { 39 | Rule::number => pair.as_str().parse::().unwrap(), 40 | Rule::expr => compute(pair.into_inner()), 41 | Rule::custom_dice => { 42 | let mut inner = pair.into_inner(); 43 | // LHS 44 | let num = inner.next().unwrap(); 45 | let lhs = num.as_str().parse::().expect("Did not find a number on LHS!"); 46 | // Operator 47 | let d = inner.next().unwrap().as_str(); 48 | assert!(d == "d" || d == "D"); 49 | // RHS 50 | let mut sides = vec![]; 51 | for s in inner { 52 | // Collect numbers 53 | if s.as_rule() == Rule::number { 54 | sides.push(s.as_str().parse::().expect("Non-number found on RHS!")); 55 | } 56 | }; 57 | lhs.signum() * roll_custom_dice_raw(lhs.abs(), &sides) 58 | }, 59 | _ => unreachable!(), 60 | }, 61 | |lhs: i64, op: Pair, rhs: i64| match op.as_rule() { 62 | Rule::roll => { 63 | if rhs < 1 { 64 | panic!("Sides must be greater than zero") 65 | } else { 66 | match lhs.signum() { 67 | 0 => panic!("Number of sides must not be zero"), 68 | -1 => -roll_dice_raw(lhs.abs(), rhs as u64), 69 | 1 => roll_dice_raw(lhs.abs(), rhs as u64), 70 | _ => unreachable!(), 71 | } 72 | } 73 | }, 74 | Rule::plus => lhs + rhs, 75 | Rule::minus => lhs - rhs, 76 | Rule::times => lhs * rhs, 77 | Rule::slash => lhs / rhs, 78 | _ => unreachable!(), 79 | } 80 | ) 81 | } 82 | -------------------------------------------------------------------------------- /src/random.rs: -------------------------------------------------------------------------------- 1 | // rouler - A container-based system for generating die rolls 2 | // Copyright (C) 2016 by John Berry 3 | // 4 | // This Source Code Form is subject to the terms of the Mozilla Public 5 | // License, v. 2.0. If a copy of the MPL was not distributed with this 6 | // file, You can obtain one at http://mozilla.org/MPL/2.0/. 7 | 8 | use rand::{thread_rng, Rng}; 9 | 10 | pub fn roll_dice_raw(num: i64, sides: u64) -> i64 { 11 | let mut rng = thread_rng(); 12 | 13 | (0..num.abs()).map(|_| rng.gen_range(1, sides as i64 + 1)).sum() 14 | } 15 | 16 | pub fn roll_custom_dice_raw(num: i64, sides: &[u64]) -> i64 { 17 | let mut rng = thread_rng(); 18 | 19 | (0..num.abs()).map(|_| rng.choose(sides).unwrap()).fold(0, |acc, x| acc + *x as i64) 20 | } 21 | -------------------------------------------------------------------------------- /src/roll.rs: -------------------------------------------------------------------------------- 1 | // rouler - A container-based system for generating die rolls 2 | // Copyright (C) 2016 by John Berry 3 | // 4 | // This Source Code Form is subject to the terms of the Mozilla Public 5 | // License, v. 2.0. If a copy of the MPL was not distributed with this 6 | // file, You can obtain one at http://mozilla.org/MPL/2.0/. 7 | 8 | use std::cmp::Ordering; 9 | use std::fmt; 10 | 11 | use parse::*; 12 | use pest::*; 13 | 14 | /// A simple function for throwaway die rolls that do not need to be saved as a 15 | /// `Roller`. Provided for convenience. 16 | /// 17 | /// Takes an input of a `&str` containing syntax for a die roll, returns total. 18 | /// 19 | /// # Panics 20 | /// 21 | /// As `roll_dice` parses its argument, it will thus panic if the given syntax is incorrect. 22 | /// 23 | /// # Examples 24 | /// ``` 25 | /// use rouler::roll_dice; 26 | /// 27 | /// println!("Wizard HP at lvl 9: {}", roll_dice("6d6+6")); 28 | /// ``` 29 | /// 30 | pub fn roll_dice(r: &str) -> i64 { 31 | let parser = RollParser::parse(Rule::calc, r); 32 | compute(parser.expect("Failed to parse roll!")) 33 | } 34 | 35 | /// A function for throwaway die rolls that do not need to be saved as a 36 | /// `Roller`. Provided for convenience. 37 | /// 38 | /// Takes an input of a `&str` containing syntax for a die roll, returns Ok(total) 39 | /// if the input parses successfully, otherwise a `ParsingError`. 40 | /// 41 | /// # Examples 42 | /// ``` 43 | /// use rouler::roll_dice_or_fail; 44 | /// 45 | /// assert!(roll_dice_or_fail("6d6").is_ok()); 46 | /// assert!(roll_dice_or_fail("food4").is_err()) 47 | /// ``` 48 | pub fn roll_dice_or_fail(r: &str) -> Result> { 49 | let parser = RollParser::parse(Rule::calc, r); 50 | parser.map(compute) 51 | } 52 | 53 | /// A function for safely creating a new `Roller` without panicking. 54 | /// 55 | /// Takes a `&str` input and if the syntax parses, returns a Roller wrapped by a Result. 56 | /// Otherwise returns a `ParsingError`. 57 | /// 58 | /// # Examples 59 | /// ``` 60 | /// use rouler::roller_or_fail; 61 | /// 62 | /// 63 | /// ``` 64 | pub fn roller_or_fail<'a>(r: &'a str) -> Result, Error> { 65 | let parser = RollParser::parse(Rule::calc, r); 66 | parser.map(|p| { 67 | Roller { 68 | roll: r, 69 | total: compute(p), 70 | } 71 | }) 72 | } 73 | 74 | /// The `Roller` is the core struct of the library. The basic principle is to provide a reusable 75 | /// container that provides a specific kind of die roll, so that it can be quickly and easily repeated 76 | /// whenever called for. Each container contains the syntax of the roll type it represents, and the 77 | /// value of the last roll it made. Containers are thus self-mutating, but self-contained. 78 | /// 79 | /// The main benefit is thus in code organization, as one can store different types of rolls for 80 | /// easy use later. 81 | #[derive(Debug, Clone, Copy)] 82 | pub struct Roller<'a> { 83 | roll: &'a str, 84 | total: i64, 85 | } 86 | 87 | impl<'a> Roller<'a> { 88 | /// Creates a new `Roller` with the given die roll syntax, and populates the stored total with a first 89 | /// roll of the indicated dice. Because subsequent rerolls mutate the object in order to store the most 90 | /// recent roll, it should be declared with `let mut` if you intend to reroll it. 91 | /// 92 | /// # Panics 93 | /// 94 | /// As a `Roller` rolls itself on creation, it thus triggers the parser, and incorrect syntax will cause 95 | /// a panic. 96 | /// 97 | /// # Examples 98 | /// 99 | /// ``` 100 | /// use rouler::Roller; 101 | /// 102 | /// let mut laser_damage = Roller::new("1d4*10"); 103 | /// 104 | /// println!("Damage, rnd 1: {}", laser_damage.total()); 105 | /// println!("Damage, rnd 2: {}", laser_damage.reroll()); 106 | /// ``` 107 | /// 108 | /// Rollers implement `Eq` and `Ord`, based on their current totals, so die results can be compared 109 | /// directly without having to first call the `total` method: 110 | /// 111 | /// ``` 112 | /// # use rouler::Roller; 113 | /// let att = Roller::new("1d20 + 5"); 114 | /// let def = Roller::new("1d20 + 2"); 115 | /// 116 | /// if att > def { 117 | /// println!("You struck the monster!"); 118 | /// } else { 119 | /// println!("You missed!"); 120 | /// } 121 | /// ``` 122 | /// 123 | /// For convenience's sake, Rollers also implement `Display`, so they are printable: 124 | /// 125 | /// ``` 126 | /// # use rouler::Roller; 127 | /// println!("{}", Roller::new("4d8 + 5")); 128 | /// // => [4d8 + 5: 24] 129 | /// ``` 130 | pub fn new(roll: &'a str) -> Self { 131 | Roller { 132 | roll, 133 | total: roll_dice(roll), 134 | } 135 | } 136 | 137 | /// Rolls the `Roller`'s die roll, stores the value in total, and then returns it. In this way, you can use 138 | /// `Roller::reroll()` in place as a value, rather than needing to call the method seperately. 139 | /// 140 | /// # Examples 141 | /// ``` 142 | /// use rouler::Roller; 143 | /// 144 | /// let mut stat = Roller::new("3d6"); 145 | /// 146 | /// println!("STR (3d6): {}", stat.total()); // => STR (3d6): 14 147 | /// println!("DEX (3d6+1): {}", stat.reroll() + 1); // => DEX (3d6+1): 13 148 | /// 149 | /// println!("{}", stat); // prints [3d6: 12] 150 | /// ``` 151 | pub fn reroll(&mut self) -> i64 { 152 | self.total = roll_dice(self.roll); 153 | 154 | self.total 155 | } 156 | 157 | /// Returns the result of the last roll made by the `Roller`. 158 | pub fn total(&self) -> i64 { 159 | self.total 160 | } 161 | 162 | /// Returns a reference to self for use as an `Iterator`. This allows for iterating infinitely and lazily over 163 | /// successive rolls of the dice. By borrowing as mutable, the state of the internal total is preserved, 164 | /// so that calls to `total()` will remain consistent. 165 | /// 166 | /// # Examples 167 | /// 168 | /// ``` 169 | /// # use rouler::Roller; 170 | /// // Collect multiple results to a vector: 171 | /// let stats = Roller::new("3d6").iter().take(6).collect::>(); 172 | /// ``` 173 | /// 174 | /// *Remember!* Rollers are infinite iterators: *always* use `take()` to avoid infinite loops! 175 | /// This is safe: 176 | /// 177 | /// ``` 178 | /// # use rouler::Roller; 179 | /// // Keep rolling until a result greater than a threshold: 180 | /// assert!(Roller::new("4d6").iter().skip_while(|&x| x < 13).take(1).last().unwrap() >= 13); 181 | /// ``` 182 | /// 183 | /// But this will not terminate: 184 | /// 185 | /// ```rust,ignore 186 | /// assert!(Roller::new("4d6").iter().skip_while(|&x| x < 13).last().unwrap() >= 13); 187 | /// ``` 188 | pub fn iter(&mut self) -> &mut Self { 189 | self.by_ref() 190 | } 191 | } 192 | 193 | impl<'a> Iterator for Roller<'a> { 194 | type Item = i64; 195 | 196 | fn next(&mut self) -> Option { 197 | Some(self.reroll()) 198 | } 199 | } 200 | 201 | impl<'a> PartialEq for Roller<'a> { 202 | fn eq(&self, other: &Roller) -> bool { 203 | self.total == other.total 204 | } 205 | } 206 | 207 | impl<'a> Eq for Roller<'a> {} 208 | 209 | impl<'a> Ord for Roller<'a> { 210 | fn cmp(&self, other: &Roller) -> Ordering { 211 | self.total.cmp(&other.total) 212 | } 213 | } 214 | 215 | impl<'a> PartialOrd for Roller<'a> { 216 | fn partial_cmp(&self, other: &Roller) -> Option { 217 | Some(self.cmp(other)) 218 | } 219 | } 220 | 221 | impl<'a> fmt::Display for Roller<'a> { 222 | fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { 223 | write!(f, "[{}: {}]", self.roll, self.total) 224 | } 225 | } 226 | -------------------------------------------------------------------------------- /src/rouler.pest: -------------------------------------------------------------------------------- 1 | number = @{ "-"? ~ ("0" | '1'..'9' ~ '0'..'9'*) } 2 | 3 | op = _{ plus | minus | times | slash } 4 | plus = { "+" } 5 | minus = { "-" } 6 | times = { "*" } 7 | slash = { "/" } 8 | 9 | dice = _{ number ~ (roll ~ number) } 10 | roll = { "d" | "D" } 11 | custom_dice = { number ~ roll ~ sides } 12 | sides = _{ "[" ~ number ~ ("," ~ number )* ~ "]" } 13 | 14 | expr = { term ~ (op ~ term)* } 15 | term = _{ custom_dice | dice | number | "(" ~ expr ~ ")" } 16 | 17 | calc = _{ soi ~ expr ~ eoi } 18 | 19 | whitespace = _{ " " } 20 | -------------------------------------------------------------------------------- /tests/roller.rs: -------------------------------------------------------------------------------- 1 | // rouler - A container-based system for generating die rolls 2 | // Copyright (C) 2016 by John Berry 3 | // 4 | // This Source Code Form is subject to the terms of the Mozilla Public 5 | // License, v. 2.0. If a copy of the MPL was not distributed with this 6 | // file, You can obtain one at http://mozilla.org/MPL/2.0/. 7 | 8 | extern crate rouler; 9 | 10 | use rouler::*; 11 | 12 | macro_rules! assert_range { 13 | ($begin:expr => $val:expr => $end:expr) => { 14 | assert!(($begin <= $val) && ($val <= $end)) 15 | }; 16 | } 17 | 18 | #[test] 19 | fn roll_dice_within_range() { 20 | for _ in 0..100 { 21 | assert_range!(4 => roll_dice("4d6") => 24); 22 | } 23 | } 24 | 25 | #[test] 26 | fn roller_object_within_range() { 27 | let test_roll = Roller::new("2d6 + 4"); 28 | 29 | assert_range!(6 => test_roll.total() => 16); 30 | } 31 | 32 | #[test] 33 | fn reroll_changes_value() { 34 | let mut test_roll = Roller::new("100d100"); 35 | 36 | assert_ne!(test_roll.total(), test_roll.reroll()) 37 | } 38 | 39 | #[test] 40 | fn roll_custom_dice_within_range() { 41 | for _ in 0..100 { 42 | assert_range!(10 => roll_dice("2d[5, 6, 7]") => 14) 43 | } 44 | } 45 | 46 | #[test] 47 | fn custom_dice_spaces_optional() { 48 | for _ in 0..100 { 49 | assert_range!(10 => roll_dice("2d[5,6,7]") => 14) 50 | } 51 | } 52 | 53 | #[test] 54 | fn negative_dice_negates_roll_value() { 55 | assert_range!(-18 => Roller::new("-3d6").total() => -3); 56 | } 57 | 58 | #[test] 59 | #[should_panic(expected = "not be zero")] 60 | fn num_of_dice_nonzero() { 61 | assert!(Roller::new("0d6").total() == 0); 62 | } 63 | 64 | #[test] 65 | #[should_panic(expected = "greater than zero")] 66 | fn non_zero_sides_disallowed() { 67 | assert!(Roller::new("3d-6").total() < 0); 68 | } 69 | 70 | #[test] 71 | fn d_op_is_case_insensitive() { 72 | assert_range!(1 => Roller::new("1D6").total() => 6); 73 | assert_range!(1 => Roller::new("1d6").total() => 6); 74 | } 75 | 76 | #[test] 77 | #[ignore] 78 | #[should_panic(expected = "no pattern matched")] 79 | fn spaces_not_allowed_in_die_codes() { 80 | assert_range!(1 => Roller::new("1 d 6").total() => 6) 81 | } 82 | 83 | #[test] 84 | fn rollers_are_iterators() { 85 | let mut d20 = Roller::new("1d20"); 86 | let mut roll5 = d20.iter().take(5).collect::>(); 87 | 88 | assert_eq!(5, roll5.len()); 89 | assert_eq!(d20.total(), roll5.pop().unwrap()); 90 | } 91 | --------------------------------------------------------------------------------