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

/*
 * parsing/rule/impls/strikethrough.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/>.
 */

//! Rules for strikethrough.
//!
//! Wikidot had implemented strikethrough using --text--
//! however we also added the more conventional way ~~text~~

use super::prelude::*;

pub const RULE_STRIKETHROUGH_DASH: Rule = Rule {
    name: "strikethrough-dash",
    position: LineRequirement::Any,
    try_consume_fn: dash,
};

pub const RULE_STRIKETHROUGH_TILDE: Rule = Rule {
    name: "strikethrough-tilde",
    position: LineRequirement::Any,
    try_consume_fn: tilde,
};

fn dash<'r, 't>(parser: &mut Parser<'r, 't>) -> ParseResult<'r, 't, Elements<'t>> {
    trace!("Trying to create a double dash strikethrough");
    try_consume_strikethrough(parser, RULE_STRIKETHROUGH_DASH, Token::DoubleDash)
}

fn tilde<'r, 't>(parser: &mut Parser<'r, 't>) -> ParseResult<'r, 't, Elements<'t>> {
    trace!("Trying to create a double tilde strikethrough");
    try_consume_strikethrough(parser, RULE_STRIKETHROUGH_TILDE, Token::DoubleTilde)
}

/// Build a strikethrough with the given rule and token.
fn try_consume_strikethrough<'r, 't>(
    parser: &mut Parser<'r, 't>,
    rule: Rule,
    token: Token,
) -> ParseResult<'r, 't, Elements<'t>> {
    debug!("Trying to create a strikethrough (token {})", token.name());
    assert_step(parser, token)?;
    collect_container(
        parser,
        rule,
        ContainerType::Strikethrough,
        &[ParseCondition::current(token)],
        &[
            ParseCondition::current(Token::ParagraphBreak),
            ParseCondition::token_pair(token, Token::Whitespace),
            ParseCondition::token_pair(Token::Whitespace, token),
        ],
        None,
    )
}