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
// pest. The Elegant Parser // Copyright (C) 2017 Dragoș Tiselice // // This Source Code Form is subject to the terms of the Mozilla Public // License, v. 2.0. If a copy of the MPL was not distributed with this // file, You can obtain one at http://mozilla.org/MPL/2.0/. //! # pest. The Elegant Parser //! //! pest is a [PEG](https://en.wikipedia.org/wiki/Parsing_expression_grammar) parser built with //! *simplicity* and *speed* in mind. //! //! ## Input & Parser //! //! pest works mainly through two `trait`s: `Input` & `Parser`. `Input` defines the capabilities of //! an input source, while `Parser` provides an interface to the parsing functionality. Since //! `Parser` is a `trait`, parsing needs to be defined either though the `#[derive(Parser)]` //! attribute, or manually through the [`Position API`](inputs/struct.Position.html). The use of the //! `derive` is highly encouraged since this is the only way you can make use of pest's PEG //! grammar, while manual parser definition can be used where highly specific or efficient parsing //! is required. //! //! ## `#[derive(Parser)]` //! //! pest comes with a procedural macro crate--`pest_derive`--which needs to be included in //! `Cargo.toml` in order to enable the `derive`. //! //! ```toml //! pest_derive = "*" //! ``` //! //! ## `.pest` files //! //! Grammar definitions reside in custom `.pest` files located in the `src` directory. Their path is //! relative to `src` and is specified between the `derive` attribute and an empty `struct` that //! `Parser` will be derived on. //! //! Because of a limitation in procedural macros, there is no way for Cargo to know that a module //! needs to be recompiled based on the file that the procedural macro is opening. This leads to the //! case where modifying a `.pest` file without touching the file where the `derive` is does not //! recompile it if it already has a working binary in the cache. To avoid this issue, the grammar //! file can be included in a dummy `const` definition while debugging. //! //! ```ignore //! #[cfg(debug_assertions)] //! const _GRAMMAR: &'static str = include_str!("path/to/my_grammar.pest"); // relative to this file //! //! #[derive(Parser)] //! #[grammar = "path/to/my_grammar.pest"] // relative to src //! struct MyParser; //! ``` //! //! The grammar of `.pest` files is documented in the //! [`pest_derive` crate](https://docs.rs/pest_derive/#Grammar). #![doc(html_root_url = "https://docs.rs/pest")] use std::fmt::Debug; use std::hash::Hash; mod error; pub mod inputs; pub mod iterators; mod macros; mod parser; mod parser_state; pub mod prec_climber; mod token; /// A `trait` which parser rules must implement. /// /// This trait is set up so that any struct that implements all of its required traits will /// automatically implement this trait as well. /// /// This is essentially a [trait alias](https://github.com/rust-lang/rfcs/pull/1733). When trait /// aliases are implemented, this may be replaced by one. pub trait RuleType: Copy + Debug + Eq + Hash + Ord {} impl<T: Copy + Debug + Eq + Hash + Ord> RuleType for T {} pub use error::Error; pub use parser::Parser; pub use parser_state::{state, ParserState}; pub use token::Token;