lexical-ui 0.1.3

A Rust port of Lexical's model and headless packages, at parity with the JS implementation.
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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
//! `LexicalBuilder.ts`: `buildEditorFromExtensions` and `LexicalBuilder`,
//! which resolves the extensions' dependency graph, merges their configs
//! in dependency order, and runs their phases: `init` (before the editor
//! exists), `build`, `register` and `afterRegistration`.

use super::extension_rep::{ExtensionRep, StateId};
use super::initial_state_extension::initial_state_extension;
use crate::error::invariant;
use crate::extension_core::{
    AbortController, AnyLexicalExtension, AnyLexicalExtensionArgument, Erased, InitialEditorConfig,
};
use crate::json::{Object, Value};
use crate::merge_register::merge_register;
use crate::ordered::{OrderedMap, OrderedSet};
use crate::{CreateEditorArgs, Editor, LexicalError, NodeClass, Unregister, create_editor};
use std::cell::RefCell;
use std::rc::Rc;

/// `buildEditorFromExtensions(...extensions)`: an editor built from the
/// extensions (with `InitialStateExtension` first) and their dependencies,
/// each configured, built and registered, with its initial state set.
pub fn build_editor_from_extensions(
    extensions: impl IntoIterator<Item = AnyLexicalExtensionArgument>,
) -> Result<LexicalEditorWithDispose, LexicalError> {
    LexicalBuilder::from_extensions(extensions)?.build_editor()
}

/// `LexicalEditorWithDispose`: an editor built from extensions, with the
/// `dispose` that undoes their registration. It dereferences to its
/// [`Editor`]. Dropping it doesn't dispose it (JS's `using` does; call
/// [`dispose`](Self::dispose)).
#[derive(Clone)]
pub struct LexicalEditorWithDispose {
    editor: Editor,
    dispose: Rc<RefCell<Option<Unregister>>>,
}

impl LexicalEditorWithDispose {
    /// `dispose()`: runs every clean-up the extensions' `register` and
    /// `afterRegistration` returned, in the reverse of the order they
    /// registered, then aborts their signal; before all of that it detaches
    /// the root element (`setRootElement(null)`). Only the first call does
    /// anything.
    pub fn dispose(&self) {
        let dispose = self.dispose.borrow_mut().take();
        if let Some(dispose) = dispose {
            dispose();
        }
    }

    /// The editor.
    pub fn editor(&self) -> &Editor {
        &self.editor
    }
}

impl std::ops::Deref for LexicalEditorWithDispose {
    type Target = Editor;

    fn deref(&self) -> &Editor {
        &self.editor
    }
}

/// `LexicalBuilder`: the extensions an editor is built from, by name, with
/// the edges between them. Cloning it shares it.
#[derive(Clone)]
pub struct LexicalBuilder(pub(crate) Rc<BuilderInner>);

pub(crate) struct BuilderInner {
    roots: Vec<AnyLexicalExtensionArgument>,
    extension_name_map: RefCell<OrderedMap<Rc<ExtensionRep>>>,
    /// Per extension, the configs it gives each dependency and peer.
    outgoing_config_edges: RefCell<OrderedMap<OrderedMap<Vec<Erased>>>>,
    incoming_edges: RefCell<OrderedMap<OrderedSet>>,
    conflicts: RefCell<OrderedMap<String>>,
    sorted_extension_reps: RefCell<Option<Vec<Rc<ExtensionRep>>>>,
}

impl BuilderInner {
    /// `extensionNameMap.get(name)`.
    pub(crate) fn extension_rep_by_name(&self, name: &str) -> Option<Rc<ExtensionRep>> {
        self.extension_name_map.borrow().get(name).cloned()
    }

    /// `getExtensionRep(extension)`: the extension's record, an error when
    /// another extension has its name.
    pub(crate) fn get_extension_rep(
        &self,
        extension: &dyn AnyLexicalExtension,
    ) -> Result<Option<Rc<ExtensionRep>>, LexicalError> {
        let Some(rep) = self.extension_rep_by_name(extension.name()) else {
            return Ok(None);
        };
        invariant!(
            same_extension(rep.extension.as_ref(), extension),
            "LexicalBuilder: A registered extension with name {} exists but does not match the given extension",
            extension.name()
        );
        Ok(Some(rep))
    }

    /// `incomingEdges.get(name)`, in the order the edges were added.
    pub(crate) fn incoming_edge_names(&self, name: &str) -> Vec<String> {
        self.incoming_edges
            .borrow()
            .get(name)
            .map(|set| set.iter().map(str::to_owned).collect())
            .unwrap_or_default()
    }
}

/// JS's `===` on two extensions.
fn same_extension(a: &dyn AnyLexicalExtension, b: &dyn AnyLexicalExtension) -> bool {
    std::ptr::addr_eq(
        a as *const dyn AnyLexicalExtension,
        b as *const dyn AnyLexicalExtension,
    )
}

impl LexicalBuilder {
    /// `new LexicalBuilder(roots)`.
    fn new(roots: Vec<AnyLexicalExtensionArgument>) -> Result<Self, LexicalError> {
        let builder = LexicalBuilder(Rc::new(BuilderInner {
            roots: roots.clone(),
            extension_name_map: RefCell::new(OrderedMap::new()),
            outgoing_config_edges: RefCell::new(OrderedMap::new()),
            incoming_edges: RefCell::new(OrderedMap::new()),
            conflicts: RefCell::new(OrderedMap::new()),
            sorted_extension_reps: RefCell::new(None),
        }));
        for extension in &roots {
            builder.add_extension(extension)?;
        }
        Ok(builder)
    }

    /// `LexicalBuilder.fromExtensions(extensions)`: a builder of
    /// `InitialStateExtension` and the extensions.
    pub fn from_extensions(
        extensions: impl IntoIterator<Item = AnyLexicalExtensionArgument>,
    ) -> Result<Self, LexicalError> {
        let mut roots: Vec<AnyLexicalExtensionArgument> = vec![initial_state_extension().into()];
        roots.extend(extensions);
        Self::new(roots)
    }

    /// `LexicalBuilder.maybeFromEditor(editor)`: the builder that built the
    /// editor, if one did.
    pub fn maybe_from_editor(editor: &Editor) -> Option<LexicalBuilder> {
        editor
            .0
            .builder
            .borrow()
            .as_ref()
            .and_then(|b| b.downcast_ref::<LexicalBuilder>().cloned())
    }

    /// `LexicalBuilder.fromEditor(editor)`.
    pub fn from_editor(editor: &Editor) -> Result<LexicalBuilder, LexicalError> {
        Self::maybe_from_editor(editor).ok_or_else(|| {
            LexicalError::new(
                "LexicalBuilder.fromEditor: The given editor was not created with LexicalBuilder",
            )
        })
    }

    /// `constructEditor()`: the editor of the merged configuration, with
    /// every extension built.
    pub fn construct_editor(&self) -> Result<Editor, LexicalError> {
        let config = self.build_create_editor_args()?;
        // `onWarn: err => onWarn(err, editor)`, for the editor made here.
        let warned_editor: Rc<RefCell<Option<std::rc::Weak<crate::editor::EditorInner>>>> =
            Rc::default();
        let on_warn = config.on_warn.map(|on_warn| {
            let warned_editor = warned_editor.clone();
            Rc::new(move |warning: LexicalError| {
                let editor = warned_editor
                    .borrow()
                    .as_ref()
                    .and_then(std::rc::Weak::upgrade)
                    .map(Editor);
                match editor {
                    Some(editor) => on_warn(warning, &editor),
                    None => Err(warning),
                }
            }) as crate::WarningHandler
        });
        let editor = create_editor(CreateEditorArgs {
            // Empty for `undefined`: `createEditor` then takes the parent
            // editor's, or a random one.
            namespace: config.namespace.unwrap_or_default(),
            nodes: config.nodes,
            editable: config.editable,
            on_warn,
            theme: config.theme.unwrap_or_default(),
            parent_editor: config.parent_editor,
            #[cfg(feature = "html")]
            html: config.html,
            #[cfg(feature = "html")]
            dom: config.dom,
            ..Default::default()
        });
        *warned_editor.borrow_mut() = Some(editor.weak());
        *editor.0.builder.borrow_mut() = Some(Rc::new(self.clone()));
        for extension_rep in self.sorted_extension_reps()? {
            extension_rep.build(&editor)?;
        }
        Ok(editor)
    }

    /// `buildEditor()`.
    pub fn build_editor(&self) -> Result<LexicalEditorWithDispose, LexicalError> {
        let editor = self.construct_editor()?;
        let unregister = self.register_editor(&editor)?;
        // `mergeRegister(this.registerEditor(editor), () =>
        // editor.setRootElement(null))`, which runs in reverse: the root
        // element is detached first, while the extensions still listen.
        let weak = editor.weak();
        let dispose = merge_register(vec![
            unregister,
            Box::new(move || {
                if let Some(editor) = weak.upgrade().map(Editor) {
                    // Only a headless editor's guard can refuse, and it
                    // allows `None`.
                    let _ = editor.set_root_element(None);
                }
            }),
        ]);
        Ok(LexicalEditorWithDispose {
            editor,
            dispose: Rc::new(RefCell::new(Some(dispose))),
        })
    }

    /// `hasExtensionByName(name)`.
    pub fn has_extension_by_name(&self, name: &str) -> bool {
        self.0.extension_name_map.borrow().contains(name)
    }

    /// `addEdge(from, to, configs)`: an extension's configs for another
    /// are kept in the order they were seen, even when it reaches the
    /// other more than once.
    fn add_edge(&self, from_extension_name: &str, to_extension_name: &str, configs: Vec<Erased>) {
        {
            let mut outgoing_edges = self.0.outgoing_config_edges.borrow_mut();
            if let Some(outgoing) = outgoing_edges.get_mut(from_extension_name) {
                if let Some(existing) = outgoing.get_mut(to_extension_name) {
                    existing.extend(configs);
                } else {
                    outgoing.set(to_extension_name, configs);
                }
            } else {
                let mut outgoing = OrderedMap::new();
                outgoing.set(to_extension_name, configs);
                outgoing_edges.set(from_extension_name, outgoing);
            }
        }
        let mut incoming_edges = self.0.incoming_edges.borrow_mut();
        if let Some(incoming) = incoming_edges.get_mut(to_extension_name) {
            incoming.add(from_extension_name);
        } else {
            let mut incoming = OrderedSet::new();
            incoming.add(from_extension_name);
            incoming_edges.set(to_extension_name, incoming);
        }
    }

    /// `addExtension(arg)`: adds the extension, unless it is there, then
    /// its dependencies and the edges to them and to its peers.
    pub fn add_extension(&self, arg: &AnyLexicalExtensionArgument) -> Result<(), LexicalError> {
        invariant!(
            self.0.sorted_extension_reps.borrow().is_none(),
            "LexicalBuilder: addExtension called after finalization"
        );
        let extension = &arg.extension;
        let name = extension.name();
        let existing = self.0.extension_rep_by_name(name);
        invariant!(
            existing
                .as_ref()
                .is_none_or(|rep| same_extension(rep.extension.as_ref(), extension.as_ref())),
            "LexicalBuilder: Multiple extensions registered with name {}, names must be unique",
            name
        );
        if existing.is_some() {
            return Ok(());
        }
        let extension_rep = ExtensionRep::new(Rc::downgrade(&self.0), extension.clone());
        self.0
            .extension_name_map
            .borrow_mut()
            .set(name, extension_rep);
        let has_conflict = self.0.conflicts.borrow().get(name).cloned();
        if let Some(has_conflict) = has_conflict {
            return Err(LexicalError::new(format!(
                "LexicalBuilder: extension {name} conflicts with {has_conflict}"
            )));
        }
        for conflict in extension.conflicts_with() {
            invariant!(
                !self.0.extension_name_map.borrow().contains(conflict),
                "LexicalBuilder: extension {} conflicts with {}",
                name,
                conflict
            );
            self.0.conflicts.borrow_mut().set(conflict, name.to_owned());
        }
        for dep in extension.dependencies() {
            self.add_edge(name, dep.extension.name(), dep.configs.clone());
            self.add_extension(dep)?;
        }
        for peer in extension.peer_dependencies() {
            self.add_edge(name, peer.name(), peer.config.iter().cloned().collect());
        }
        Ok(())
    }

    fn visit(
        &self,
        rep: &Rc<ExtensionRep>,
        from_extension_name: Option<&str>,
        sorted: &mut Vec<Rc<ExtensionRep>>,
    ) -> Result<(), LexicalError> {
        let mark = rep.id();
        if mark == StateId::Permanent {
            return Ok(());
        }
        let extension_name = rep.extension.name().to_owned();
        invariant!(
            mark == StateId::Unmarked,
            "LexicalBuilder: Circular dependency detected for Extension {} from {}",
            extension_name,
            from_extension_name.unwrap_or("[unknown]")
        );
        rep.set_id(StateId::Temporary);
        let to_names: Vec<String> = self
            .0
            .outgoing_config_edges
            .borrow()
            .get(&extension_name)
            .map(|edges| edges.keys().map(str::to_owned).collect())
            .unwrap_or_default();
        for to_extension_name in to_names {
            // None for an optional peer dependency.
            if let Some(to_rep) = self.0.extension_rep_by_name(&to_extension_name) {
                self.visit(&to_rep, Some(&extension_name), sorted)?;
            }
        }
        rep.set_id(StateId::Permanent);
        sorted.push(rep.clone());
        Ok(())
    }

    /// `sortedExtensionReps()`: the extensions in dependency order (a
    /// depth-first topological sort, dependencies and peers first), with
    /// each one's configs from its dependents in that order, then from the
    /// roots.
    pub(crate) fn sorted_extension_reps(&self) -> Result<Vec<Rc<ExtensionRep>>, LexicalError> {
        if let Some(sorted) = self.0.sorted_extension_reps.borrow().clone() {
            return Ok(sorted);
        }
        let mut sorted_extension_reps = Vec::new();
        let reps: Vec<Rc<ExtensionRep>> = self
            .0
            .extension_name_map
            .borrow()
            .values()
            .cloned()
            .collect();
        for rep in &reps {
            if rep.id() == StateId::Unmarked {
                self.visit(rep, None, &mut sorted_extension_reps)?;
            }
        }
        for rep in &sorted_extension_reps {
            let edges: Vec<(String, Vec<Erased>)> = self
                .0
                .outgoing_config_edges
                .borrow()
                .get(rep.extension.name())
                .map(|edges| {
                    edges
                        .iter()
                        .map(|(k, v)| (k.to_owned(), v.clone()))
                        .collect()
                })
                .unwrap_or_default();
            for (to_extension_name, configs) in edges {
                if let Some(to_rep) = self.0.extension_rep_by_name(&to_extension_name) {
                    for config in &configs {
                        to_rep.add_config(config);
                    }
                }
            }
        }
        for root in &self.0.roots {
            if !root.configs.is_empty() {
                let to_rep = self.0.extension_rep_by_name(root.extension.name());
                let Some(to_rep) = to_rep else {
                    return Err(LexicalError::new(format!(
                        "LexicalBuilder: Expecting existing ExtensionRep for {}",
                        root.extension.name()
                    )));
                };
                for config in &root.configs {
                    to_rep.add_config(config);
                }
            }
        }
        *self.0.sorted_extension_reps.borrow_mut() = Some(sorted_extension_reps.clone());
        Ok(sorted_extension_reps)
    }

    /// `registerEditor(editor)`: registers every extension, then runs every
    /// `afterRegistration`, and returns the clean-up of all of it.
    pub fn register_editor(&self, editor: &Editor) -> Result<Unregister, LexicalError> {
        let extension_reps = self.sorted_extension_reps()?;
        let controller = AbortController::new();
        let signal = controller.signal();
        let mut cleanups: Vec<Unregister> = vec![Box::new(move || controller.abort())];
        for extension_rep in &extension_reps {
            cleanups.push(extension_rep.register(editor, signal.clone())?);
        }
        for extension_rep in &extension_reps {
            if let Some(cleanup) = extension_rep.after_registration(editor)? {
                cleanups.push(cleanup);
            }
        }
        Ok(merge_register(cleanups))
    }

    /// `buildCreateEditorArgs()`: the editor configuration the extensions
    /// contribute, merged in dependency order (the last `parentEditor` and
    /// `$initialEditorState` win, nodes are added once, themes are merged
    /// deeply), after every extension's `init` has seen it.
    pub fn build_create_editor_args(&self) -> Result<InitialEditorConfig, LexicalError> {
        let mut config = InitialEditorConfig::default();
        let mut nodes: Vec<NodeClass> = Vec::new();
        // The extension that replaced each node type.
        let mut replaced_nodes: Vec<(&'static str, String)> = Vec::new();
        let mut theme = Value::Object(Object::new());
        let extension_reps = self.sorted_extension_reps()?;
        for extension_rep in &extension_reps {
            let extension = &extension_rep.extension;
            if let Some(parent_editor) = extension.parent_editor() {
                config.parent_editor = Some(parent_editor.clone());
            }
            if let Some(initial_editor_state) = extension.initial_editor_state() {
                config.initial_editor_state = Some(initial_editor_state.clone());
            }
            if let Some(editable) = extension.editable() {
                config.editable = Some(editable);
            }
            if let Some(namespace) = extension.namespace() {
                config.namespace = Some(namespace.to_owned());
            }
            if let Some(on_warn) = extension.on_warn() {
                config.on_warn = Some(on_warn.clone());
            }
            for node in extension.nodes() {
                if node.replacement.is_some() {
                    if let Some((_, conflict)) =
                        replaced_nodes.iter().find(|(t, _)| *t == node.node_type())
                    {
                        return Err(LexicalError::new(format!(
                            "LexicalBuilder: Extension {} can not register replacement for node {} because {} already did",
                            extension.name(),
                            node.class_name,
                            conflict
                        )));
                    }
                    replaced_nodes.push((node.node_type(), extension.name().to_owned()));
                    nodes.push(node.clone());
                } else if !nodes.iter().any(|n| {
                    // `nodes.add(node)`: a `Set` of classes, so another class
                    // of the same type is added (and registered last).
                    n.replacement.is_none()
                        && n.node_type() == node.node_type()
                        && n.class_name == node.class_name
                }) {
                    nodes.push(node.clone());
                }
            }
            // `htmlExport.set(k, v)` and `Object.assign(htmlImport, ...)`:
            // a later extension's entry replaces an earlier one's in place.
            #[cfg(feature = "html")]
            {
                let html = extension.html();
                for (k, v) in &html.export {
                    match config.html.export.iter_mut().find(|(key, _)| key == k) {
                        Some(entry) => entry.1 = v.clone(),
                        None => config.html.export.push((k, v.clone())),
                    }
                }
                for (k, v) in &html.import {
                    match config.html.import.iter_mut().find(|(key, _)| key == k) {
                        Some(entry) => entry.1 = v.clone(),
                        None => config.html.import.push((k.clone(), v.clone())),
                    }
                }
            }
            if let Some(extension_theme) = extension.theme() {
                theme = deep_theme_merge_in_place(theme, Value::Object(extension_theme.clone()));
            }
        }
        if let Value::Object(theme) = theme
            && !theme.is_empty()
        {
            config.theme = Some(theme);
        }
        config.nodes = nodes;
        for extension_rep in &extension_reps {
            extension_rep.init(&mut config)?;
        }
        Ok(config)
    }
}

/// Keys `deepThemeMergeInPlace` never merges, which in JS would reach the
/// prototype chain.
const UNSAFE_KEYS: [&str; 3] = ["__proto__", "constructor", "prototype"];

/// `deepThemeMergeInPlace(a, b)` (`internal/deepThemeMergeInPlace.ts`): when
/// both are objects, `a` with each key of `b` merged into it in turn
/// (but the unsafe keys); otherwise `b`. (JS merges into an array `a` too,
/// as properties a theme's JSON never shows.)
pub(crate) fn deep_theme_merge_in_place(a: Value, b: Value) -> Value {
    match (a, b) {
        (Value::Object(mut a), Value::Object(b)) => {
            for (k, v) in b.iter() {
                if UNSAFE_KEYS.contains(&k) {
                    continue;
                }
                let merged = deep_theme_merge_in_place(
                    a.get(k).cloned().unwrap_or(Value::Undefined),
                    v.clone(),
                );
                a.insert(k, merged);
            }
            Value::Object(a)
        }
        (_, b) => b,
    }
}