spandex 0.0.2

A modern LaTeX alternative
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
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

//! This crate contains the parser for spandex.

pub mod ast;
pub mod error;
pub mod parser;
pub mod utils;
pub mod warning;

#[cfg(test)]
mod tests;

use std::fs::File;
use std::io::Read;
use std::path::{Path, PathBuf};

use nom::types::CompleteStr;
use nom_locate::LocatedSpan;

use crate::parser::ast::Ast;
use crate::parser::error::Errors;
use crate::parser::warning::Warnings;

/// This type will allow us to know where we are while we're parsing the content.
pub type Span<'a> = LocatedSpan<CompleteStr<'a>>;

/// A position is a span but without the reference to the complete str.
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
pub struct Position {
    /// The line number of the position.
    pub line: u32,

    /// The column number of the position.
    pub column: usize,

    /// The offset from the beginning of the string.
    pub offset: usize,
}

/// Returns the position of a span.
pub fn position<'a>(span: &Span<'a>) -> Position {
    Position {
        line: span.line,
        column: span.get_utf8_column(),
        offset: span.offset,
    }
}

/// An ast that was successfully parsed.
#[derive(Debug)]
pub struct Parsed {
    /// The parsed ast.
    pub ast: Ast,

    /// The warnings that were produced.
    pub warnings: Warnings,
}

/// Parses a dex file.
pub fn parse<'a, P: AsRef<Path>>(path: P) -> Result<Parsed, Errors> {
    let path = path.as_ref();
    let mut file = File::open(&path).unwrap();
    let mut content = String::new();
    file.read_to_string(&mut content).unwrap();

    let ast = match parser::parse(Span::new(CompleteStr(&content))) {
        Ok((_, ast)) => ast,
        Err(_) => panic!(),
    };

    let errors = ast.errors();
    let warnings = ast.warnings();

    if errors.is_empty() {
        Ok(Parsed {
            ast,
            warnings: Warnings {
                path: PathBuf::from(&path),
                warnings,
                content,
            },
        })
    } else {
        Err(Errors {
            path: PathBuf::from(&path),
            content,
            errors,
        })
    }
}