ftml 1.41.0

Foundation Text Markup Language - a library to render Wikidot text as HTML
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
90
91
92
93
94
95
96
97
98
99
100
101
102

/*
 * parsing/check_step.rs
 *
 * ftml - Library to parse Wikidot text
 * Copyright (C) 2019-2026 Wikijump Team
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

use super::{ExtractedToken, ParseError, ParseErrorKind, Parser, Token};

/// Helper function to assert that the current token matches, then step.
///
/// # Returns
/// The `ExtractedToken` which was checked and stepped over.
///
/// # Panics
/// Since an assert is used, this function will panic
/// if the extracted token does not match the one specified.
///
/// If you want an error to be returned instead, then use `check_step()`.
pub fn assert_step<'r, 't>(
    parser: &mut Parser<'r, 't>,
    token: Token,
) -> Result<&'r ExtractedToken<'t>, ParseError> {
    let current = parser.current();
    assert_eq!(current.token, token, "Opening token isn't {}", token.name());
    parser.step()?;
    Ok(current)
}

/// Helper function to check that the current token matches, then step.
///
/// # Returns
/// The `ExtractedToken` which was checked and stepped over.
/// However, if the current token does *not* match, the given error
/// specified by `kind` is returned instead.
///
/// If you want the function to panic instead, then use `assert_step()`.
pub fn check_step<'r, 't>(
    parser: &mut Parser<'r, 't>,
    token: Token,
    kind: ParseErrorKind,
) -> Result<&'r ExtractedToken<'t>, ParseError> {
    let current = parser.current();
    if current.token != token {
        error!(
            "check_step() failed, expected {}, but got {} (error: {})",
            token.name(),
            current.token.name(),
            kind.name(),
        );
        return Err(parser.make_err(kind));
    }
    parser.step()?;
    Ok(current)
}

#[test]
fn test_assert_step() {
    use crate::data::PageInfo;
    use crate::layout::Layout;
    use crate::settings::{WikitextMode, WikitextSettings};

    let page_info = PageInfo::dummy();
    let settings = WikitextSettings::from_mode(WikitextMode::Page, Layout::Wikidot);
    let tokenization = crate::tokenize("//Apple// banana");
    let mut parser = Parser::new(&tokenization, &page_info, &settings);
    parser.step().expect("cannot step"); // get over the Token::InputStart

    let _ = assert_step(&mut parser, Token::Italics);
}

#[test]
fn test_check_step() {
    use crate::data::PageInfo;
    use crate::layout::Layout;
    use crate::settings::{WikitextMode, WikitextSettings};

    let error_kind = ParseErrorKind::InvalidInclude; // arbitrary
    let page_info = PageInfo::dummy();
    let settings = WikitextSettings::from_mode(WikitextMode::Page, Layout::Wikidot);
    let tokenization = crate::tokenize("//Apple// banana");
    let mut parser = Parser::new(&tokenization, &page_info, &settings);
    parser.step().expect("cannot step"); // get over the Token::InputStart

    let result = check_step(&mut parser, Token::Bold, error_kind);
    let error = result.expect_err("check_step() succeeded when it was supposed to fail");
    assert_eq!(error.token(), Token::Italics);
    assert_eq!(error.kind(), error_kind);
}