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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

/*
 * parsing/rule/mapping.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::{Rule, impls::*};
use crate::parsing::token::{ExtractedToken, Token};
use enum_map::EnumMap;
use std::sync::LazyLock;

/// Mapping of all tokens to the rules they possibly correspond with.
///
/// This is the first tokens that could consistute the given rule,
/// in order of precedence.
///
/// An empty list means that this is a special token that shouldn't be used
/// in this manner. It will of course fall back to interpreting this token
/// as text, but will also produce an error for the user.
pub static RULE_MAP: LazyLock<EnumMap<Token, Vec<Rule>>> = LazyLock::new(|| {
    enum_map! {
        // Symbols
        Token::LeftBracket => vec![RULE_LINK_SINGLE, RULE_TEXT],
        Token::LeftBracketAnchor => vec![RULE_LINK_ANCHOR],
        Token::LeftBracketStar => vec![RULE_LINK_SINGLE_NEW_TAB],
        Token::RightBracket => vec![RULE_TEXT],
        Token::LeftBlock => vec![RULE_BLOCK],
        Token::LeftBlockEnd => vec![],
        Token::LeftBlockAnchor => vec![RULE_ANCHOR],
        Token::LeftBlockStar => vec![RULE_BLOCK_STAR],
        Token::RightBlock => vec![],
        Token::LeftParentheses => vec![RULE_BIBCITE, RULE_TEXT],
        Token::RightParentheses => vec![RULE_BIBCITE, RULE_TEXT],
        Token::LeftMath => vec![RULE_MATH],
        Token::RightMath => vec![],
        Token::DoubleDash => vec![RULE_STRIKETHROUGH_DASH, RULE_DASH],
        Token::TripleDash => vec![RULE_HORIZONTAL_RULE],
        Token::DoubleTilde => vec![RULE_STRIKETHROUGH_TILDE],
        Token::LeftDoubleAngle => vec![RULE_DOUBLE_ANGLE],
        Token::ClearFloatBoth => vec![RULE_CLEAR_FLOAT],
        Token::ClearFloatLeft => vec![RULE_CLEAR_FLOAT],
        Token::ClearFloatRight => vec![RULE_CLEAR_FLOAT],
        Token::Pipe => vec![RULE_TEXT],
        Token::Equals => vec![RULE_CENTER, RULE_TEXT],
        Token::Colon => vec![RULE_DEFINITION_LIST, RULE_TEXT],
        Token::Underscore => vec![RULE_UNDERSCORE_LINE_BREAK, RULE_TEXT],
        Token::Quote => vec![RULE_BLOCKQUOTE, RULE_DOUBLE_ANGLE, RULE_TEXT],
        Token::Heading => vec![RULE_HEADER, RULE_TEXT],
        Token::Whitespace => vec![RULE_UNDERSCORE_LINE_BREAK, RULE_LIST, RULE_TEXT],

        // Formatting
        Token::Bold => vec![RULE_BOLD],
        Token::Italics => vec![RULE_ITALICS],
        Token::Underline => vec![RULE_UNDERLINE],
        Token::Superscript => vec![RULE_SUPERSCRIPT],
        Token::Subscript => vec![RULE_SUBSCRIPT],
        Token::LeftMonospace => vec![RULE_MONOSPACE],
        Token::RightMonospace => vec![],
        Token::Color => vec![RULE_COLOR],
        Token::Raw => vec![RULE_RAW],
        Token::LeftRaw => vec![RULE_RAW],
        Token::RightRaw => vec![],

        // Lists
        Token::BulletItem => vec![RULE_LIST, RULE_TEXT],
        Token::NumberedItem => vec![RULE_LIST, RULE_TEXT],

        // Links
        Token::LeftLink => vec![RULE_LINK_TRIPLE],
        Token::LeftLinkStar => vec![RULE_LINK_TRIPLE_NEW_TAB],
        Token::RightLink => vec![],

        // Tables
        Token::TableColumn => vec![RULE_TABLE],
        Token::TableColumnRight => vec![RULE_TABLE],
        Token::TableColumnCenter => vec![RULE_TABLE],
        Token::TableColumnTitle => vec![RULE_TABLE],

        // Text components
        Token::Identifier => vec![RULE_TEXT],
        Token::Email => vec![RULE_EMAIL],
        Token::Url => vec![RULE_URL],
        Token::Variable => vec![RULE_VARIABLE, RULE_TEXT],
        Token::DoubleQuote => vec![RULE_TEXT],
        Token::EscapedDoubleQuote => vec![RULE_TEXT],
        Token::EscapedBackslash => vec![RULE_TEXT],

        // Input boundaries
        Token::LineBreak => vec![RULE_BLOCK_SKIP_NEWLINE, RULE_DEFINITION_LIST_SKIP_NEWLINE, RULE_LINE_BREAK],
        Token::ParagraphBreak => vec![RULE_LINE_BREAK_PARAGRAPH],
        Token::InputStart => vec![RULE_NULL],
        Token::InputEnd => vec![RULE_NULL],

        // Miscellaneous
        Token::LeftComment => vec![RULE_COMMENT],
        Token::RightComment => vec![],

        // Fallback
        Token::Other => vec![RULE_TEXT],
    }
});

#[inline]
pub fn get_rules_for_token(current: &ExtractedToken) -> &'static [Rule] {
    &RULE_MAP[current.token]
}