Leaf Projectors #1218

disconcision · 2024-02-20T05:30:10Z

Overview

This PR is intended to start (but not finish) a system for flexible projectional code-editing UI. Right now, the system should be sufficient to serve as the basis for non-splicing livelits, type hold inference UI, hiding parts of code in live views (e.g. function bodies), and at least a basic form of module collapsing. Both inline and block (multiline) GUIs are supported, though there is only a single reference implementation for the latter (TextAreaCore), so some details might not have ended up on the right side of the projector server / projector client divide. I want to support a range of use cases so I'm solicited feedback on the flexibility of the interface.

Getting Started

See the Documentation/Projectors slide in the editor for a functional overview
The module signature for projectors is defined in ProjectorBase.Projector
The core logic is distributed across four modules: ProjectorBase, Projector, ProjectorPerform, and ProjectorView
The first two are divided only to avoid cycles. This induces a similar split of Zipper into ZipperBase
All of the above modules are documented, as are the projector actions definitions in Action.t
The implementations of the actual projectors are in modules suffixed with Core. These currently include FoldCore, InfoCore, CheckboxCore, SliderCore, SliderFCore, and TextAreaCore.

How the projector system interacts with the parent editor

The projector system covers bits of syntax in the parent editor with embedded GUIs. Projectable syntax is currently limited to convex pieces (both tiles and grout). (In the future, this can be ~ straightforwardly relaxed to any segment which is semantically self-contained: any segment which parses, including nullary parses like runs of secondary.)
A projection is created/removed by wrapping/unwrapping the underlying syntax with a new Piece.t type, Projector(Base.projector_kind), which stores a record entry specifying the kind of projector, the syntax itself, and an optional serialized model for internal projector state. Projectors have an associated UUID which is set to that of their wrapped syntax. When their wrapped syntax is transformed, the id for that syntax is reset to the projector id to retain sync. (This is mostly an implementation detail; a convenience to retain an association between a projector and the id-tracked semantic information if its wrapped syntax)
Whenever a projector needs to be seen or respond to a message, its kind is hydrated into a first class projector module of type ProjectorBase.Projector, whose various methods determine all projector-specific logic. Projector views have access to certain information fed to them by their parent editor, including their underlying syntax and static Info entry (later: dynamic info). Views are also provided with callbacks for both local (kind-specific) actions and parent editor requests.
MakeTerm unwraps (removed) projectors as the term is constructed, producing as a side-effect a map of ids to projectors which is used for the view.
For editor view purposes, when a Projector is encountered in code rendering, it is represented as a placeholder string consisting of only whitespace and linebreaks. The projector GUIs are drawn separately (using the projectors map generated above in maketerm) and are absolutely positioned with respect to the parent editor.
For editor move/select/edit actions, projector pieces are handled analogously to single-character monotiles with a fixed mold. This makes them roughly analogous to a hybrid between single-character monotiles and the whitespace piece type: movement/selection/deletion treats them as atomic units, except they have a fixed convex shape.

Caveats and Wontfixes

Currently only convex pieces can be projected, so many terms will have to be wrapped in parens to be e.g. folded. This will be relaxed in a subsequent PR
Projectors are persisted in the syntax, but are not preserved on actions which serialize to text like copy/cut/paste. This will be mitigated in a subsequent PR
Substantial adjustments affecting only one specific projector (that is, requiring more internal logic but not an API change) are probably outside the scope of this PR. I already have enhancement ideas for basically all the individual projectors here, especially Fold, Info, and Slider.
Substantial adjustments to the UI for adding/removing projectors is probably outside the scope of this PR. The keyboard shortcuts and projectors panel are intended to be basic generic invocation mechanisms; I expect that different genres of projectors will have custom invocation stories

Adding a new kind of projector

Create a new core module implementing ProjectorBase.Projector (or copy e.g. FoldCore)
Add an entry for it in Base.projector_kind (used for adding/removing/updating)
Register the core module in Projector.to_module
If you want to expose the projector via a keyboard shortcut, see the existing entry for Fold in Keyboard
If you want to expose the projector in the projector panel bottom bar UI, update ProjectorView.name, ProjectorView.of_name, and ProjectorView.Panel.applicable_projectors
If you want to manually manage the projector as part of the update cycle, see the implementations of the SetIndicated and Remove actions in ProjectorPerform for how to manually add/remove projectors from an editor

Other changes made in this PR

Many editor-specific actions have been relocated from Update to Perform
Statics storage and calculation has been moved to Editor (requiring settings to be piped to many modules)
Adding projectors to Zipper induces a serialization change!
Since the above broke some of the documentation slides (due to eg eval now being a reserved keyword), I updated these, in particular Basic Reference, with new language features

TODO(andrews)

…rily disabled scroll to caret

… disabled for now

…was used only by backpark targets. new 'segment' is now what was previously called 'unselected'

…ind of nasty though may need an alternate approach

src/haz3lweb/view/ProjectorView.re

src/haz3lweb/Keyboard.re

src/haz3lcore/statics/MakeTerm.re

src/haz3lcore/statics/TypBase.re

src/haz3lcore/zipper/Editor.re

src/haz3lcore/zipper/ProjectorBase.re

Negabinary · 2024-07-29T16:09:28Z

src/haz3lcore/zipper/ProjectorBase.re

+/* Projector model and action are serialized so that
+ * they may be used by the Editor without it having
+ * specialized knowledge of projector internals */
+type serialized_model = string;
+type serialized_action = string;


I really like the Cook functor solution and am weighing up whether it might have applications to UI

Negabinary · 2024-07-29T16:19:15Z

src/util/Web.re

@@ -12,3 +16,115 @@ let div_if = (p, ats, ns) => p ? div(~attrs=[ats], ns) : div_empty;
 let span_if = (p, ats, ns) => p ? span(~attrs=[ats], ns) : span([]);

 let unless = (p, a) => p ? Effect.Many([]) : a;
+


personally these feel like view/Widgets.re things to me instead of util/Web.re things

hmm, i forgot about Widgets. maybe we should just combine these modules? do you see a distinction between them? right now i can't just move things to Widgets as it's in web (renegotiating what goes where is likely going to be an ongoing process now that the core/web division is changing)

To me web is just like wrappers around html things and widgets has more hazel-specific logic and styles etc - maybe we move widgets to util/Widgets.re if it can't be in web? (I still find it a little concerning that we need an html definition of a slider in core)

I had some similar issues on my livelits branch. I struggle to see how the projectors can be web (platform) agnostic. So unless they're entirely configured in web I don't know how you'd excise the dependency from core.

@Negabinary i started to move widgets but looking at it the current arrangement makes sense to me. the range and TextArea components i defined in web are intended to be completely independent from hazel logic. all of the textarea logic is just to get and set text area ui state; it could all be in vdom in-principle. otoh current widgets are all related to hazel UI chrome outside the syntax-editor as such. so these modules are disjoint along two different dimensions. admittedly thats not well-reflected in the naming

@7h3kk1d contemplating this resulted in a tweet: https://twitter.com/disconcision/status/1818812875411968085

(via the tangent "what does it mean to be truly view independent?" => "let's take string out of Core" => "let's string out")

src/util/Util.re

Negabinary · 2024-07-29T18:05:47Z

src/haz3lcore/zipper/projectors/TextAreaCore.re

The TextArea has some weird behaviour when you type a speech mark into it.

just to confirm that you're seeing the same weirdness: quote characters get inserted fine in the textarea, but these actions are not reflected in the underlying syntax? (this also means the shape of the textarea doesn't expand for quotes) or are you seeing something above and beyond that?

i knew about this one but was ignoring it as i don't totally understand how to address it in a principled way. the way regular string literals work in the underyling syntax model is a bit ad-hoc; quotes have special-case behavior relative to all other characters. briefly: inserting a quote must automatically insert a closing quote; otherwise the text serialization of that code state has an ambiguous lexing. but we don't want to prevent someone from just typing an empty string normally. the solution we ended up with is that typing a quote inside a string simply moves the caret to the end of the string. not pretty but in practice seems to work fine. of course ultimately we want escaped characters in strings, but ideally this will all be handled at the core syntax layer.

could add some textarea-projector-specific code that catches keystrokes, suppresses quotes, and the refires the event to the textarea i guess. implementing the string livelit with the DOM textarea is likely more trouble than it's worth, but i wanted to do this as a trial run for embedding non-hazel-native components...

yeah same weirdness! Hazel afaik doesn't have any quote escape mechanism so in terms of the underlying syntax the best thing is probably just to suppress quotes for now if that's straightforward enough

yup, suppressing quotes for now

cyrus-

Looks and feels great overall.

Only bug I can find is that when the projectors panel is disabled you can still click the grayed out button (and it seems to do some sort of folding):

Other notes in addition to a few inline comments in the code:

The copy-and-paste and undo issues you indicate as a wontfix for this PR, which I am okay with for now, but that I don't want to leave hanging too long. What is your plan for those?
The first scratch slide now has a bunch of projectors stuff in it, which should instead be under Documentation.
I was expecting to be able to fold when my cursor was on something like an ap, e.g. in the example above, where it would fold the entire highlighted term, but I guess that's related to the parenthesization issue that we're going to fix later?

cyrus- · 2024-07-31T06:20:38Z

src/util/Web.re

nit: module naming in util is inconsistent, some end in Util and others don't.

I like the pattern matt has now established of importing util modules in Util so you can just refer to them as e.g. Util.Web; I think going forward we should migrate away from Util in the filename.

cyrus- · 2024-07-31T06:25:58Z

src/haz3lweb/dune

- (write-file js-of-ocaml-flags-dev "(:standard)"))
+ (write-file
+  js-of-ocaml-flags-dev
+  "(:standard --debug-info --no-inline --pretty --source-map)"))


does this change the dev experience meaningfully?

not afaict. but it does make the flags the same across all our build targets, and the same as david's setup, so at least it eliminates that potential source of confusion

src/haz3lweb/Keyboard.re

src/haz3lcore/zipper/ProjectorBase.re

cyrus- · 2024-07-31T06:37:01Z

src/haz3lcore/zipper/Selection.re

@@ -2,8 +2,8 @@ open Util;

 [@deriving (show({with_path: false}), sexp, yojson)]
 type buffer =
-  | Unparsed
-  | Parsed;
+  //| Parsed


what's going on here?

This is an artefact of separating the original TyDi implementation from the llm completion stuff. The parsed buffer option is currently meaningless so I just removed it until the LLM stuff is reimplemented

src/haz3lcore/zipper/projectors/CheckboxCore.re

disconcision · 2024-08-01T00:28:25Z

commenting to remind myself about the slider keyboard input focus issue

disconcision · 2024-08-01T00:46:44Z

The copy-and-paste and undo issues you indicate as a wontfix for this PR, which I am okay with for now, but that I don't want to leave hanging too long. What is your plan for those?

I've been hoping inspiration will strike for a simple approach to copy/paste. The options seem to be: Implement some kind of synchronization between an internal (segment) buffer and the browser copy/paste actions. This is probably not too bad, but I'm also just not totally sure if it's going to work seamlessly syntax-wise. Reinserting a segment as a selection should work (it's how pickup/putdown used to work), but i'm wary against since-then baked in assumptions around adding incomplete syntax. At the very least paste has to be able to replace UUIDs. Hopefully not that bad but it's not something I want to get bogged down in atm. The other option is implementing some kind of attributes system, and use those to represent projectors in the text representation. This requires some more planning, and would be natural to implement at the same time as text-based livelit invocation (not currently on my agenda, but would likely do at some point). Ofc this latter option doesnt have the advantage.

…on keyboard actions. supress textarea DOM undo/redo for now. don't record projector focus etc actions in history.

disconcision · 2024-08-01T19:59:38Z

@cyrus- et al: all issues addressed I think. function applications don't try to project now (greyed-out toggle should be in-sync).

Ability to project terms which aren't single tiles will follow in a self-contained PR
Better Undo/Redo will follow at some point. I'll create an issue for now. Current state is: it works sensibly, but causes textarea to lose caret position
Copy/Paste will follow at some point. I'll create an issue for now

cyrus- · 2024-08-04T03:54:12Z

@disconcision tab-completing let/if/etc. doesn't work still, what's the issue there?

Also we talked about connecting error marks with the lines so it doesn't look like there are multiple errors, did you decide against that or just not done?

disconcision · 2024-08-04T03:57:22Z

@disconcision tab-completing let/if/etc. doesn't work still, what's the issue there?

Also we talked about connecting error marks with the lines so it doesn't look like there are multiple errors, did you decide against that or just not done?

planning to fix both just taking longer than id like

… next line

disconcision · 2024-08-05T04:37:10Z

@cyrus- all issues addressed. in particular, tab completions of definitions is fixed, and error holes now have child lines.

cyrus- · 2024-08-05T04:53:39Z

odd decoration on the end here:

disconcision · 2024-08-05T15:18:49Z

@cyrus- technically that's already there for the term decorations, you just can't see if because the term shards are opaque. I looked briefly but I don't really know how to address it in the current approach to line drawing

cyrus- · 2024-08-05T19:25:33Z

@disconcision maybe make the error shards opaque as well to avoid the issue for now and @dm0n3y can take a look in the next revision of the decorations?

disconcision · 2024-08-06T16:36:04Z

@cyrus- i've addressed the error hole thing in summer-refresh; tedious to replicate here as the css is completely different. i've made the background color of the error holes the same color as the code background + the red overlay, so it looks the same. the cost is that this means we need to either move the error holes behind selections or it looks super funky. but that's not a huge issue i think

disconcision added 19 commits February 14, 2024 22:17

projectors init. added projectors to zipper, laid out some infra

5ce3a18

projector notes

597c983

leaf projectors view kind of working... broken caret somehow. tempora…

b8ecc4d

…rily disabled scroll to caret

revert jsutil

ab9ce05

resolved view layer scroll exn bug. lingering exn for indicated deco;…

0e81a22

… disabled for now

consistency of unselected use between init and next

43e55aa

can now fold when not at start of term

9eddee0

cleanup

9fc2c8c

cleanup. removed previous (selected) segment from editor meta, which …

cd37968

…was used only by backpark targets. new 'segment' is now what was previously called 'unselected'

unthread projectors from Code.view

6dc7793

unthread projectors from measured

384f3bd

re-enable indicated deco

0b0127d

projector subsegmentation now follows proper parse order

c12e18f

projectors: failed movement experiments

3f0a332

projectors: movement working for convex terms in middle of segment. k…

d0385ab

…ind of nasty though may need an alternate approach

deco for folds

2997c02

fold cleanup

ccbe090

fold cleanup

c5997d1

marginally better projection movement behavior

b37fcd5

cyrus- changed the title ~~Leaf Projectors WIP~~ Leaf Projectors Mar 1, 2024

cyrus- added the in-development for PRs that remain in development label Mar 1, 2024

cyrus- mentioned this pull request Mar 1, 2024

code folding #1113

Closed

disconcision added 7 commits March 5, 2024 21:32

note

4be1020

improved movement for convex terms

97056ca

Merge branch 'dev' of github.com:hazelgrove/hazel into projectors

0eb8d9e

skipTo logic for movement

ee16647

basic selectability for leaf projectors

f4d10f1

cleanup

a08e621

Merge branch 'dev' of github.com:hazelgrove/hazel into projectors

7e39389

disconcision mentioned this pull request Apr 30, 2024

Structural copy/paste #1300

Open

Negabinary reviewed Jul 29, 2024

View reviewed changes

cyrus- requested changes Jul 31, 2024

View reviewed changes

dhexp merge fixes

2889248

hazelgrove deleted a comment from cyrus- Aug 1, 2024

minor PR comment fixes

e59e082

disconcision added 3 commits July 31, 2024 22:22

supress quote entry in string projector. clean up scratch slides

59ba1ee

fix DOM state sync bug for projectors. fix projector outline showing …

c3535b4

…on keyboard actions. supress textarea DOM undo/redo for now. don't record projector focus etc actions in history.

don't attempt to project non-convex things. rm printlns

96e10c4

disconcision added 2 commits August 2, 2024 22:14

Merge branch 'dev' of github.com:hazelgrove/hazel into projectors

e2887dc

fix issue with copy blanking out projectors

81e7050

disconcision added 3 commits August 4, 2024 22:43

fix completion bug

7ec5641

child lines for error decos

fffb4a0

fix bug with clicking at the end of the line triggering a jump to the…

9048d6d

… next line

cyrus- approved these changes Aug 7, 2024

View reviewed changes

cyrus- merged commit 5cb2cf2 into dev Aug 7, 2024
2 checks passed

cyrus- deleted the projectors branch August 7, 2024 21:15

disconcision removed the in-development for PRs that remain in development label Aug 7, 2024

This was referenced Aug 7, 2024

Projectors are not preserved under copy/paste #1359

Open

Textarea projector loses caret position on Undo/Redo #1360

Open

Make undo/redo skip movement #724

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Leaf Projectors #1218

Leaf Projectors #1218

disconcision commented Feb 20, 2024 •

edited

Loading

Negabinary Jul 29, 2024

Negabinary Jul 29, 2024

disconcision Jul 29, 2024

Negabinary Jul 30, 2024

7h3kk1d Jul 30, 2024

disconcision Aug 1, 2024

disconcision Aug 1, 2024

disconcision Aug 1, 2024

Negabinary Jul 29, 2024

disconcision Jul 29, 2024

Negabinary Jul 30, 2024

disconcision Aug 1, 2024

cyrus- left a comment •

edited

Loading

cyrus- Jul 31, 2024

disconcision Jul 31, 2024

cyrus- Jul 31, 2024

disconcision Aug 1, 2024

cyrus- Jul 31, 2024

disconcision Aug 1, 2024

disconcision commented Aug 1, 2024

disconcision commented Aug 1, 2024

disconcision commented Aug 1, 2024

cyrus- commented Aug 4, 2024

disconcision commented Aug 4, 2024

disconcision commented Aug 5, 2024

cyrus- commented Aug 5, 2024

disconcision commented Aug 5, 2024

cyrus- commented Aug 5, 2024

disconcision commented Aug 6, 2024

		@@ -12,3 +16,115 @@ let div_if = (p, ats, ns) => p ? div(~attrs=[ats], ns) : div_empty;
		let span_if = (p, ats, ns) => p ? span(~attrs=[ats], ns) : span([]);

		let unless = (p, a) => p ? Effect.Many([]) : a;

Leaf Projectors #1218

Leaf Projectors #1218

Conversation

disconcision commented Feb 20, 2024 • edited Loading

Overview

Getting Started

How the projector system interacts with the parent editor

Caveats and Wontfixes

Adding a new kind of projector

Other changes made in this PR

TODO(andrews)

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

cyrus- left a comment • edited Loading

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

disconcision commented Aug 1, 2024

disconcision commented Aug 1, 2024

disconcision commented Aug 1, 2024

cyrus- commented Aug 4, 2024

disconcision commented Aug 4, 2024

disconcision commented Aug 5, 2024

cyrus- commented Aug 5, 2024

disconcision commented Aug 5, 2024

cyrus- commented Aug 5, 2024

disconcision commented Aug 6, 2024

disconcision commented Feb 20, 2024 •

edited

Loading

cyrus- left a comment •

edited

Loading