Giant PR making demo crate kinda presentable #52

e-matteson · 2019-10-19T23:45:20Z

Split out the CoreEditor, implement mode-style and menu-style keymaps, and implement a proper callstack for the concatenative language.

Instead of automatically treating everything in a CommandGroup as 1 undo group. We'll need more flexibility in undos when implementing a fancier call stack. feat: replace commandgroup with metacommand

Instead of returning it from get_content(). Should be fairly static, and this simplifies things.

This could lead to their unused undo stacks growing really big...

And move the `Keymaps` manager into another file.

Instead of requiring it to be 'static.

justinpombrio

Yay, modes and menus! And a call stack! And Engine/Server separation!

justinpombrio · 2019-10-19T23:48:36Z

demo/src/core_editor.rs

+lazy_static! {
+    pub static ref LANG_SET: LanguageSet = LanguageSet::new();
+    pub static ref NOTE_SETS: GrowOnlyMap<LanguageName, NotationSet> = GrowOnlyMap::new();
+}


These should be (i) made in main, and (ii) probably put in a struct

Made in main, not in a struct for now

justinpombrio · 2019-10-19T23:52:29Z

demo/src/core_editor.rs

+    }
+}
+
+pub struct Core<'l> {


wait no, Engine!

justinpombrio · 2019-10-20T20:23:24Z

demo/src/data/example_keymaps.rs

+use crate::keymaps::{FilterRule, TextKeymapFactory, TreeKeymapFactory};
+use crate::prog::{Prog, Value, Word};
+
+pub fn make_node_map<'l>(lang: &Language) -> TreeKeymapFactory<'l> {


These 4 functions could use doc strings

justinpombrio · 2019-10-20T20:31:06Z

demo/src/data/example_pane_notation.rs

+    };
+
+    let divider = PaneNotation::Fill {
+        ch: '=',


Might be impressive & pretty to use a unicode character here. Some possibilities:
░▒▓
═ // this is not an equal sign
▄▅▆▇█

Characters don't work well anyways because there's no DynWidth option for the text in the status bar. Maybe we should reverse the background instead.

And PaneNotations don't really support applying a Style to a whole Pane right now, so I'm leaving this as-is until those pretty changes shake out.

justinpombrio · 2019-10-20T20:57:55Z

demo/src/error.rs

+    // Note: we can't use the inner DocError as the error source because it
+    // contains a non-static lifetime.
+    #[error("doc error: {0}")]
+    DocExec(DocError<'l>),


As discussed, we should eliminate lifetime parameters on error messages:

Eliminate lifetime parameter on ServerError, EngineError, DocError.

Delete the replace error in DocError

Instead of docs having a replace command, have a "insert fresh node with no children" command.

Change how keyhints are created to accommodate this.

Removed the lifetime parameter from errors. We need to keep the Replace command though, for implementing undo. Because of that, and because the Doc doesn't have access to the language set and notation sets needed to create a new node, I'd rather continue to have the Engine create new nodes and pass them to the Doc in a Replace command. The Doc won't be able to give back a rejected node to the Engine, but that doesn't matter.

justinpombrio · 2019-10-21T01:56:15Z

demo/src/server.rs

+        let tree_context = if doc.in_tree_mode() {
+            Some(FilterContext {
+                required_sort: doc.self_sort(),
+                self_arity: doc.self_arity_type(),
+                parent_arity: doc.parent_arity_type(),
+            })
+        } else {
+            None
+        };


Consider putting this in its own method. get_tree_context()

justinpombrio · 2019-10-21T01:57:03Z

demo/src/server.rs

+    fn next_event(&mut self, keymap: &FilteredKeymap) -> Result<Prog<'l>, ServerError<'l>> {
+        match self.frontend.next_event() {
+            Some(Ok(Event::KeyEvent(Key::Ctrl('c')))) => Err(ServerError::KeyboardInterrupt),
+            Some(Ok(Event::KeyEvent(key))) => self
+                .keymap_manager
+                .lookup(key, keymap)
+                .ok_or_else(|| ServerError::UnknownKey(key)),
+            Some(Err(err)) => Err(err.into()),
+            _ => Err(ServerError::UnknownEvent),
+        }
+    }


Should probably inline this. As a bonus, it will make the borrow checker happy about the FilteredKeymap struct change.

justinpombrio · 2019-10-21T01:58:23Z

demo/src/server.rs

+        Ok(ed)
+    }
+
+    pub fn run(&mut self) -> Result<(), ServerError<'l>> {


Could use comments. (Regular comments, not doc comments.)

justinpombrio · 2019-10-21T02:00:58Z

demo/src/server.rs

+    fn update_key_hints(&mut self, keymap: &FilteredKeymap) -> Result<(), ServerError<'l>> {
+        let lang_name = self.engine.lang_name_of(&DocLabel::KeyHints)?;
+
+        let mut dict_node = self.engine.new_node("dict", lang_name)?;


Rename:

dict -> keymap

entry -> binding

justinpombrio · 2019-10-21T02:08:16Z

demo/src/server.rs

+        }
+    }
+
+    fn update_key_hints(&mut self, keymap: &FilteredKeymap) -> Result<(), ServerError<'l>> {


For the future: make a "Virtual Doc" that implements PrettyDocument, b.c. ASTs have a terrible API for this use case, as demonstrated in this method's code. (Add a TODO.)

By removing the Ast<'l> stored in of DocError's variants.

Leftover from the old implementation of keymap filtering. If we want them again someday for something else, we can re-add them.

e-matteson added 30 commits October 19, 2019 19:40

feat: require undo groups to be manually ended

f5c6af7

Instead of automatically treating everything in a CommandGroup as 1 undo group. We'll need more flexibility in undos when implementing a fancier call stack. feat: replace commandgroup with metacommand

demo: separate Values from Words

cb4c11f

demo: add a basic call stack

57c6c9f

demo: draft CoreEditor, split off from demo editor struct

22f3e9d

refactor: move Sort getters to Doc

9241c9b

refactor: split Error into CoreError and ShellError

dd76e22

feat: store cursor vis & scroll strategy in PaneNotation

cf6b3c6

Instead of returning it from get_content(). Should be fairly static, and this simplifies things.

feat: make DocLabel hashable

1b19c67

demo: use DocLabel instead of DocName

8b29143

feat: add UnknownDocLabel to CoreError

6b13f74

demo: edit keyhints & messages Docs instead of replacing w/ new Docs

3e61f5a

This could lead to their unused undo stacks growing really big...

refactor: rename msg() to show_message()

10ee4ea

demo: don't hardcode pane notation in Core

98696b2

refactor: make all Core fields private, rename lang_name_of()

8095014

refactor: clean up Core and Docs

29930dc

feat: add ArityType

af9f5da

feat: add ArityType getters to Doc

b772d76

demo: separate keymaps into Modes and Menus

60886df

demo: move keymap-related fields to separate struct

b006428

feat: use Kmap enum to store filtered keys, not an entire keymap

5221cf3

And move the `Keymaps` manager into another file.

fix: filtering of Any Sort in keymaps

b35fd56

refactor: move hardcoded keymaps and langs into data module

b06f2c5

feat: don't hardcode language choices in CoreEditor

0e21635

refactor: move ShellEditor to new file

4ba11d8

feat: parametrize CoreEditor over language lifetime

e5f65f3

Instead of requiring it to be 'static.

refactor: remove useless wrapper method

3c45c00

refactor: split keymap stuff into multiple files

f73b842

refactor: rename Kmap -> Keymap

5c6cf37

refactor: rename KmapFilter -> FilterRule

6db40dc

refactor: rename TreeKmapFactory -> TreeKeymapFactory

a45846f

feat: quote programs, not individual words

7e131c7

e-matteson requested a review from justinpombrio October 19, 2019 23:45

e-matteson added 8 commits October 19, 2019 19:52

refactor: remove uneccesary lifetime annotations

d7f5d47

feat: derive Error trait, remove type param from PaneError

ad35876

refactor: rename terminal::Error to TermError

90c1c17

feat: make core editor generic over frontend

fbba6e5

refactor: rename "core editor" to "engine"

903fab1

feat: add type alias for GrowOnlyMap of NotationSets

e9755b2

feat: don't use lazy_static to store language and notation sets

9933da1

refactor: rename "shell editor" to "server"

e6fceba

justinpombrio requested changes Oct 21, 2019

View reviewed changes

justinpombrio and others added 11 commits October 20, 2019 22:56

chore: fix for latest Rust

deb9a3a

feat: impl Display for Key, move all termion uses to terminal module

73252d9

doc: comment example keymaps

b41f433

refactor: rename keymap stuff

648ed36

refactor: rename inactivate() -> deactivate()

736a595

feat: adjust keymap error handling

efcfcbe

refactor: inline next_event(), outline get_tree_context()

92c7931

refactor: rename some Words, remove unused AnySort

19bf205

feat: construct program from Vec, not slice

87e12c4

fix: don't pop and discard a Value if it has the wrong type

3db26f9

feat: remove language lifetime parameter from errors

d906926

By removing the Ast<'l> stored in of DocError's variants.

e-matteson mentioned this pull request Oct 26, 2019

Make a "Virtual Doc" for things like keyhints #58

Open

e-matteson added 3 commits October 26, 2019 14:45

refactor: remove unused Sort-related Words and methods

7791823

Leftover from the old implementation of keymap filtering. If we want them again someday for something else, we can re-add them.

doc: explain run()

8dec0d1

doc: fix links

caeb309

e-matteson requested a review from justinpombrio October 26, 2019 19:26

justinpombrio approved these changes Oct 26, 2019

View reviewed changes

justinpombrio merged commit a813e70 into master Oct 26, 2019

justinpombrio deleted the split-core-editor branch February 23, 2020 21:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Giant PR making demo crate kinda presentable #52

Giant PR making demo crate kinda presentable #52

e-matteson commented Oct 19, 2019

justinpombrio left a comment

justinpombrio Oct 19, 2019

e-matteson Oct 21, 2019

justinpombrio Oct 19, 2019

justinpombrio Oct 20, 2019

justinpombrio Oct 20, 2019

justinpombrio Oct 20, 2019

e-matteson Oct 21, 2019

e-matteson Oct 26, 2019

justinpombrio Oct 20, 2019

e-matteson Oct 26, 2019

justinpombrio Oct 21, 2019

justinpombrio Oct 21, 2019

justinpombrio Oct 21, 2019

justinpombrio Oct 21, 2019

justinpombrio Oct 21, 2019

Giant PR making demo crate kinda presentable #52

Giant PR making demo crate kinda presentable #52

Conversation

e-matteson commented Oct 19, 2019

justinpombrio left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment