lbnf 0.1.0

A crate for parsing LBNF grammar
Documentation 
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

#![doc = include_str!("../README.md")]
#![warn(
    clippy::all,
    clippy::pedantic,
    clippy::nursery,
    clippy::cargo,
    clippy::perf,
    missing_docs
)]
#![allow(clippy::multiple_crate_versions)]

/// The structure of LBNF grammar.
pub mod grammar;

mod display;

#[cfg(test)]
mod proptests;

use crate::grammar::Grammar;

use lalrpop_util::{lexer::Token, ParseError};

#[macro_use]
extern crate lalrpop_util;

lalrpop_mod!(
    #[allow(clippy::all)]
    #[allow(clippy::pedantic)]
    #[allow(clippy::nursery)]
    #[allow(clippy::perf)]
    #[allow(unused)]
    lbnf
);

/// Parse the given string as LBNF grammar.
/// Returns [`Grammar`] if the provided grammar is valid.
///
/// # Errors
///
/// Will return `Err` if the provided grammar fails to parse.
///
/// # Examples
///
/// ```rust
/// use lbnf::parse;
///
/// let grammar = r#"
///    EAdd.  Exp ::= Exp "+" Exp ;
///    EInt.  Exp ::= Integer     ;
/// "#;
/// assert!(parse(grammar).is_ok());
/// ```
pub fn parse(input: &str) -> Result<Grammar, ParseError<usize, Token<'_>, &str>> {
    lbnf::GrammarParser::new().parse(input)
}