perspective_viewer/components/form/
code_editor.rs

1// ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
2// ┃ ██████ ██████ ██████       █      █      █      █      █ █▄  ▀███ █       ┃
3// ┃ ▄▄▄▄▄█ █▄▄▄▄▄ ▄▄▄▄▄█  ▀▀▀▀▀█▀▀▀▀▀ █ ▀▀▀▀▀█ ████████▌▐███ ███▄  ▀█ █ ▀▀▀▀▀ ┃
4// ┃ █▀▀▀▀▀ █▀▀▀▀▀ █▀██▀▀ ▄▄▄▄▄ █ ▄▄▄▄▄█ ▄▄▄▄▄█ ████████▌▐███ █████▄   █ ▄▄▄▄▄ ┃
5// ┃ █      ██████ █  ▀█▄       █ ██████      █      ███▌▐███ ███████▄ █       ┃
6// ┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┫
7// ┃ Copyright (c) 2017, the Perspective Authors.                              ┃
8// ┃ ╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌ ┃
9// ┃ This file is part of the Perspective library, distributed under the terms ┃
10// ┃ of the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0). ┃
11// ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
12
13use std::rc::Rc;
14
15use perspective_client::ExprValidationError;
16use wasm_bindgen::JsCast;
17use web_sys::*;
18use yew::prelude::*;
19
20use crate::components::form::highlight::highlight;
21use crate::components::function_dropdown::{FunctionDropDownElement, FunctionDropDownPortal};
22use crate::components::style::LocalStyle;
23use crate::css;
24use crate::exprtk::{Cursor, tokenize};
25use crate::utils::*;
26
27#[derive(Properties, PartialEq)]
28pub struct CodeEditorProps {
29    pub expr: Rc<String>,
30    pub oninput: Callback<Rc<String>>,
31    pub onsave: Callback<()>,
32    pub disabled: bool,
33
34    #[prop_or_default]
35    pub autofocus: bool,
36
37    #[prop_or_default]
38    pub wordwrap: bool,
39
40    #[prop_or_default]
41    pub autosuggest: bool,
42
43    #[prop_or_default]
44    pub select_all: Subscriber<()>,
45
46    #[prop_or_default]
47    pub error: Option<ExprValidationError>,
48
49    /// Selected theme name, threaded for PortalModal consumers.
50    #[prop_or_default]
51    pub theme: String,
52}
53
54/// A syntax-highlighted text editor component.
55#[function_component(CodeEditor)]
56pub fn code_editor(props: &CodeEditorProps) -> Html {
57    let select_all = use_state_eq(|| false);
58    let caret_position = use_state_eq(|| 0_u32);
59    let scroll_offset = use_state_eq(|| (0, 0));
60    let textarea_ref = use_node_ref();
61    let content_ref = use_node_ref();
62    let lineno_ref = use_node_ref();
63    let filter_dropdown = use_memo((), |_| FunctionDropDownElement::default());
64    let mut cursor = Cursor::new(&props.error);
65    let terms = tokenize(&props.expr)
66        .into_iter()
67        .map(|token| highlight(&mut cursor, token, *caret_position))
68        .collect::<Html>();
69
70    let onkeydown = use_callback((caret_position.setter(), props.onsave.clone()), on_keydown);
71    let oninput = use_callback(props.oninput.clone(), |event, deps| {
72        on_input_callback(event, deps)
73    });
74
75    let onscroll = use_callback((scroll_offset.setter(), textarea_ref.clone()), |_, deps| {
76        on_scroll(&deps.0, &deps.1)
77    });
78
79    let autofocus = props.autofocus;
80    use_effect_with((props.expr.clone(), textarea_ref.clone()), {
81        move |(expr, textarea_ref)| {
82            let elem = textarea_ref.cast::<web_sys::HtmlTextAreaElement>().unwrap();
83            if autofocus {
84                elem.focus().unwrap();
85            }
86
87            if **expr != elem.value() {
88                elem.set_value(&format!("{expr}"));
89                elem.set_scroll_top(0);
90                elem.set_scroll_left(0);
91                elem.set_caret_position(0).unwrap();
92            }
93        }
94    });
95
96    // select_all.set(props.select_all);
97    use_effect_with((select_all.setter(), props.select_all.clone()), {
98        move |(select_all, props_select_all)| {
99            clone!(select_all);
100            let sub = props_select_all.add_listener(move |()| select_all.set(true));
101            move || drop(sub)
102        }
103    });
104
105    // select_all.set(props.select_all);
106    use_effect_with((select_all, textarea_ref.clone()), {
107        move |(select_all, textarea_ref)| {
108            let elem = textarea_ref.cast::<web_sys::HtmlTextAreaElement>().unwrap();
109            if **select_all {
110                elem.focus().unwrap();
111                elem.select_all().unwrap();
112            }
113
114            select_all.set(false);
115        }
116    });
117
118    // ????
119    let autofocus = props.autofocus;
120    use_effect_with((props.error.clone(), textarea_ref.clone()), {
121        move |(_, textarea_ref)| {
122            if autofocus {
123                let elem = textarea_ref.cast::<web_sys::HtmlTextAreaElement>().unwrap();
124                elem.focus().unwrap();
125            }
126        }
127    });
128
129    // Sync scrolling between textarea and formatted HTML
130    use_effect_with(
131        (scroll_offset, content_ref.clone(), lineno_ref.clone()),
132        |deps| scroll_sync(&deps.0, &deps.1, &deps.2),
133    );
134
135    let portal_dropdown = filter_dropdown.clone();
136
137    // Blur if this element is not in the tree
138    use_effect_with(filter_dropdown.clone(), |filter_dropdown| {
139        clone!(filter_dropdown);
140        move || filter_dropdown.hide().unwrap()
141    });
142
143    // Show autocomplete
144    use_effect_with(
145        (
146            props.autosuggest,
147            filter_dropdown,
148            cursor.auto.clone(),
149            cursor.noderef.clone(),
150        ),
151        |deps| {
152            if deps.0 {
153                autocomplete(&deps.1, &deps.2, &deps.3)
154            }
155        },
156    );
157
158    let error_line = props.error.as_ref().map(|x| x.line);
159    let line_numbers = cursor
160        .map_rows(|x| html!(
161            <span
162                class={if Some(x) == error_line {"line_number error_highlight"} else {"line_number"}}
163            >
164                { x + 1 }
165            </span>
166        ))
167        .collect::<Html>();
168
169    let class = if props.wordwrap {
170        "wordwrap scrollable"
171    } else {
172        "scrollable"
173    };
174    clone!(props.disabled);
175    html! {
176        <>
177            <LocalStyle href={css!("form/code-editor")} />
178            <div id="editor" {class}>
179                <div id="line_numbers" ref={lineno_ref}>{ line_numbers }</div>
180                <div id="editor-inner" {class}>
181                    <textarea
182                        {disabled}
183                        id="textarea_editable"
184                        class="scrollable"
185                        ref={textarea_ref}
186                        spellcheck="false"
187                        {oninput}
188                        {onscroll}
189                        {onkeydown}
190                    />
191                    <div id="editor-height-sizer" />
192                    <pre id="content" ref={content_ref}>
193                        { terms }
194                        { {
195                        // A linebreak which pushs a textarea into scroll overflow
196                        // may not necessarily do so in the `<pre>`, because there is
197                        // no cursor when the last line has no content, so add
198                        // some space here to make sure overlfow is in sync
199                        // with the text area.
200                        " "
201                    } }
202                    </pre>
203                </div>
204            </div>
205            <FunctionDropDownPortal
206                element={(*portal_dropdown).clone()}
207                theme={props.theme.clone()}
208            />
209        </>
210    }
211}
212
213/// Capture the input (for re-parse) and caret position whenever the input
214/// text changes.
215fn on_input_callback(
216    event: InputEvent,
217    // position: &UseStateSetter<u32>,
218    oninput: &Callback<Rc<String>>,
219) {
220    let elem = event
221        .target()
222        .unwrap()
223        .unchecked_into::<web_sys::HtmlTextAreaElement>();
224
225    oninput.emit(elem.value().into());
226    // position.set(elem.get_caret_position().unwrap_or_default());
227}
228
229/// Overide for special non-character commands e.g. shift+enter
230fn on_keydown(event: KeyboardEvent, deps: &(UseStateSetter<u32>, Callback<()>)) {
231    let elem = event
232        .target()
233        .unwrap()
234        .unchecked_into::<web_sys::HtmlTextAreaElement>();
235
236    deps.0.set(elem.get_caret_position().unwrap_or_default());
237    if event.shift_key() && event.key_code() == 13 {
238        event.prevent_default();
239        deps.1.emit(())
240    }
241
242    // handle the tab key press
243    if event.key() == "Tab" {
244        event.prevent_default();
245
246        let caret_pos = elem.selection_start().unwrap().unwrap_or_default() as usize;
247
248        let mut initial_text = elem.value();
249
250        initial_text.insert(caret_pos, '\t');
251
252        elem.set_value(&initial_text);
253
254        let input_event = web_sys::InputEvent::new("input").unwrap();
255        let _ = elem.dispatch_event(&input_event).unwrap();
256
257        // place caret after inserted tab
258        let new_caret_pos = (caret_pos + 1) as u32;
259        let _ = elem.set_selection_range(new_caret_pos, new_caret_pos);
260
261        elem.focus().unwrap();
262    }
263}
264
265/// Scrolling callback
266fn on_scroll(scroll: &UseStateSetter<(i32, i32)>, editable: &NodeRef) {
267    let div = editable.cast::<HtmlElement>().unwrap();
268    scroll.set((div.scroll_top(), div.scroll_left()));
269}
270
271/// Scrolling sync
272fn scroll_sync(scroll: &UseStateHandle<(i32, i32)>, div: &NodeRef, lineno: &NodeRef) {
273    if let Some(div) = div.cast::<HtmlElement>() {
274        div.set_scroll_top(scroll.0);
275        div.set_scroll_left(scroll.1);
276    }
277
278    if let Some(div) = lineno.cast::<HtmlElement>() {
279        div.set_scroll_top(scroll.0);
280    }
281}
282
283/// Autocomplete
284/// TODO this should use a portal
285fn autocomplete(
286    filter_dropdown: &Rc<FunctionDropDownElement>,
287    token: &Option<String>,
288    target: &NodeRef,
289) {
290    if let Some(x) = token {
291        let elem = target.cast::<HtmlElement>().unwrap();
292        if elem.is_connected() {
293            filter_dropdown
294                .autocomplete(x.clone(), elem, Callback::from(|_| ()))
295                .unwrap();
296        } else {
297            filter_dropdown.hide().unwrap();
298        }
299    } else {
300        filter_dropdown.hide().unwrap();
301    }
302}
perspective_viewer/components/form/code_editor.rs

perspective_viewer/components/form/
code_editor.rs
