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
121
122
123
124
125
126
127
128
129
130
131
132
133

/*
 * wasm/parsing.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::page_info::PageInfo;
use super::prelude::*;
use super::settings::WikitextSettings;
use super::tokenizer::Tokenization;
use crate::Tokenization as RustTokenization;
use crate::parsing::{ParseError as RustParseError, ParseOutcome as RustParseOutcome};
use crate::tree::SyntaxTree as RustSyntaxTree;
use crate::utf16::Utf16IndexMap;
use std::sync::Arc;

#[wasm_bindgen]
#[derive(Debug, Clone)]
pub struct ParseOutcome {
    inner: Arc<RustParseOutcome<RustSyntaxTree<'static>>>,
}

#[wasm_bindgen]
impl ParseOutcome {
    #[wasm_bindgen]
    pub fn copy(&self) -> ParseOutcome {
        ParseOutcome {
            inner: Arc::clone(&self.inner),
        }
    }

    #[wasm_bindgen]
    pub fn syntax_tree(&self) -> SyntaxTree {
        let tree = self.inner.value().clone();

        SyntaxTree {
            inner: Arc::new(tree),
        }
    }

    #[wasm_bindgen]
    pub fn errors(&self) -> Result<JsValue, JsValue> {
        rust_to_js!(self.inner.errors())
    }
}

#[wasm_bindgen]
#[derive(Debug, Clone)]
pub struct SyntaxTree {
    inner: Arc<RustSyntaxTree<'static>>,
}

#[wasm_bindgen]
impl SyntaxTree {
    #[inline]
    pub(crate) fn get(&self) -> &RustSyntaxTree<'static> {
        &self.inner
    }

    #[wasm_bindgen]
    pub fn copy(&self) -> SyntaxTree {
        SyntaxTree {
            inner: Arc::clone(&self.inner),
        }
    }

    #[wasm_bindgen]
    pub fn data(&self) -> Result<JsValue, JsValue> {
        rust_to_js!(*self.inner)
    }
}

// Exported functions

#[wasm_bindgen]
pub fn parse(
    tokens: Tokenization,
    page_info: PageInfo,
    settings: WikitextSettings,
) -> Result<ParseOutcome, JsValue> {
    // Borrow and perform parsing
    let tokenization = tokens.get();
    let page_info = page_info.get();
    let settings = settings.get();
    let (syntax_tree, errors) = crate::parse(tokenization, page_info, settings).into();

    // Deep-clone AST to make it owned, so it can be
    // safely passed to JS, where it will live for an unknown time.
    let syntax_tree = syntax_tree.to_owned();

    // Convert errors to use UTF-16 indices
    let errors = convert_errors_utf16(tokenization, errors);

    // Create inner wrapper
    let inner = Arc::new(RustParseOutcome::new(syntax_tree, errors));

    Ok(ParseOutcome { inner })
}

// Utility functions

fn convert_errors_utf16(
    tokenization: &RustTokenization,
    errors: Vec<RustParseError>,
) -> Vec<RustParseError> {
    // As an optimization, we can avoid the (relatively expensive) Utf16IndexMap creation
    // if we know there are no errors to map indices of.
    if errors.is_empty() {
        return errors;
    }

    let full_text = tokenization.full_text().inner();
    let utf16_map = Utf16IndexMap::new(full_text);

    errors
        .into_iter()
        .map(|err| err.to_utf16_indices(&utf16_map))
        .collect()
}