strop-engine 0.42.0

strop editor engine: documents, grammar, services and sessions — no frontend UI dependencies
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
use super::acceptance::{AcceptanceRefusal, AcceptanceTarget};
use super::model::{CompletionDelivery, CompletionPayload, DeliveryScope};
use super::session::{Acceptance, ActivePreview, Candidate, Selection};
use super::worker::{Preparation, PreparationOperation, WorkRefusal};
use crate::editor::Editor;
use strop_core::worker::CancelReason;

impl Editor {
    pub(super) fn completion_prepare_documentation(&mut self) {
        self.completion_refresh_language_owner();
        let Some(session) = &self.completion.session else {
            return;
        };
        let Some((_, Candidate::Language { entry, .. })) = session.selected() else {
            return;
        };
        let Selection::Chosen { key, generation } = &session.selection else {
            return;
        };
        let resolved = session.resolved_item(key).cloned();
        if entry.item.protocol().documentation.is_none()
            && entry.item.protocol().detail.is_none()
            && resolved.as_ref().is_none_or(|item| {
                item.protocol().documentation.is_none() && item.protocol().detail.is_none()
            })
        {
            return;
        }
        let request = match self.worker_ids.allocate() {
            Ok(request) => request,
            Err(error) => {
                self.message = error.message;
                return;
            }
        };
        let preparation = Preparation {
            query: session.query.clone(),
            candidate: key.clone(),
            selection: *generation,
            work: request,
            operation: PreparationOperation::Documentation {
                original: entry.item.clone(),
                resolved,
            },
        };
        if let Some(mailbox) = self.completion.worker.mailbox() {
            mailbox.prepare(request);
        }
        if let Some(session) = &mut self.completion.session {
            session.preparation = Some(request);
        }
        let args = (
            preparation.query.request,
            preparation.scope(),
            preparation.candidate.clone(),
        );
        let result = self.tape.call("completion.documentation", &args, || {
            self.completion
                .worker
                .native()
                .ok_or(WorkRefusal::Closed)?
                .prepare(preparation)
        });
        match result {
            Ok(Ok(())) => {}
            Ok(Err(WorkRefusal::Busy)) => {
                if let Some(session) = &mut self.completion.session {
                    session.preparation = None;
                }
            }
            Ok(Err(error)) => {
                if let Some(session) = &mut self.completion.session {
                    session.preparation = None;
                }
                self.message = error.to_string();
            }
            Err(error) => {
                if let Some(session) = &mut self.completion.session {
                    session.preparation = None;
                }
                self.message = format!("completion documentation diverged: {error}");
            }
        }
    }

    pub(super) fn completion_accept_selected(&mut self) {
        self.completion_prepare_selected(false);
    }

    /// Tab live preview (0059 §6.1): prepare the chosen candidate through the
    /// same validated pipeline, applying it speculatively on delivery. A
    /// candidate still awaiting a required resolve highlights without
    /// previewing.
    pub(super) fn completion_preview_selected(&mut self) {
        self.completion_prepare_selected(true);
    }

    fn completion_prepare_selected(&mut self, preview: bool) {
        self.completion_refresh_language_owner();
        let Some(session) = &self.completion.session else {
            return;
        };
        if !session
            .query
            .context
            .still_owns(self, self.completion.settings_generation)
        {
            self.completion_close(CancelReason::Superseded);
            return;
        }
        if !preview && matches!(session.acceptance, Acceptance::Preparing { .. }) {
            return;
        }
        let Some((_, candidate)) = session.selected() else {
            if !preview {
                self.message = "choose a completion before accepting".into();
            }
            return;
        };
        let Selection::Chosen { key, generation } = &session.selection else {
            return;
        };
        let recorded_chars = self.recording_insert.as_ref().map_or(0, |text| {
            text.chars()
                .rev()
                .take(strop_lsp::completion::MAX_FILTER_BYTES)
                .count()
        });
        let operation = match candidate {
            Candidate::Word(word) => PreparationOperation::Word {
                text: word.text.clone(),
                recorded_chars,
            },
            Candidate::Language { entry, suggestions } => {
                if let Some(refusal) = super::acceptance::unsupported_item(&entry.item) {
                    self.message = refusal.to_string();
                    return;
                }
                let resolved = session.resolved_item(key).cloned();
                if suggestions.resolve_required && resolved.is_none() {
                    if preview {
                        // Highlight only until the required resolve lands
                        // (0059 §6.1); completion_choose already requested it.
                        return;
                    }
                    let key = key.clone();
                    if let Some(session) = &mut self.completion.session {
                        session.acceptance = Acceptance::Resolving { candidate: key };
                    }
                    self.completion_resolve_selected();
                    return;
                }
                let Some(primary) = session.query.context.primary() else {
                    return;
                };
                let Some(source) = self.docs.get(primary.source) else {
                    return;
                };
                PreparationOperation::Language {
                    source: source.buf.snapshot(),
                    original: entry.item.clone(),
                    resolved,
                    encoding: suggestions.origin.encoding,
                    resolve_required: suggestions.resolve_required,
                    recorded_chars,
                }
            }
        };
        let work = match self.worker_ids.allocate() {
            Ok(work) => work,
            Err(error) => {
                self.message = error.message;
                return;
            }
        };
        let preparation = Preparation {
            query: session.query.clone(),
            candidate: key.clone(),
            selection: *generation,
            work,
            operation,
        };
        let candidate = key.clone();
        if let Some(mailbox) = self.completion.worker.mailbox() {
            mailbox.prepare(work);
        }
        if let Some(session) = &mut self.completion.session {
            session.preparation = Some(work);
            session.acceptance = Acceptance::Preparing {
                candidate: candidate.clone(),
                work,
                preview,
            };
        }
        let result = self.tape.call(
            "completion.accept.prepare",
            &(preparation.query.request, preparation.scope(), &candidate),
            || {
                self.completion
                    .worker
                    .native()
                    .ok_or(WorkRefusal::Closed)?
                    .prepare(preparation)
            },
        );
        match result {
            Ok(Ok(())) => {}
            Ok(Err(WorkRefusal::Busy)) => {
                if let Some(session) = &mut self.completion.session {
                    session.acceptance = Acceptance::WaitingCapacity {
                        candidate,
                        work,
                        preview,
                    };
                }
            }
            Ok(Err(error)) => {
                if let Some(session) = &mut self.completion.session {
                    session.acceptance = Acceptance::Idle;
                    session.preparation = None;
                }
                self.message = error.to_string();
            }
            Err(error) => {
                if let Some(session) = &mut self.completion.session {
                    session.acceptance = Acceptance::Idle;
                    session.preparation = None;
                }
                self.message = format!("completion acceptance diverged: {error}");
            }
        }
    }

    pub(super) fn completion_apply_prepared(&mut self, delivery: &CompletionDelivery) {
        if !self.completion_owns_delivery(delivery) {
            return;
        }
        let CompletionPayload::Acceptance {
            candidate,
            prepared,
        } = &delivery.payload
        else {
            return;
        };
        let DeliveryScope::Preparation { work, .. } = delivery.scope else {
            return;
        };
        let Some(preview) =
            self.completion
                .session
                .as_ref()
                .and_then(|session| match &session.acceptance {
                    Acceptance::Preparing {
                        candidate: owner,
                        work: request,
                        preview,
                    } if owner == candidate && *request == work => Some(*preview),
                    _ => None,
                })
        else {
            return;
        };
        if let Err(refusal) = prepared {
            if let Some(session) = &mut self.completion.session {
                session.acceptance = Acceptance::Idle;
                session.preparation = None;
            }
            self.message = refusal.to_string();
            return;
        }
        let plan = self.tape.call(
            "completion.accept.take",
            &(delivery.query.request, delivery.scope),
            || {
                self.completion.worker.mailbox().and_then(|mailbox| {
                    mailbox.take_prepared(delivery.query.request, delivery.scope)
                })
            },
        );
        let plan = match plan {
            Ok(Some(plan)) => plan,
            Ok(None) => {
                self.completion_close(CancelReason::Superseded);
                self.message = "prepared completion no longer owns its operation".into();
                return;
            }
            Err(error) => {
                self.completion_close(CancelReason::Superseded);
                self.message = format!("completion acceptance transfer diverged: {error}");
                return;
            }
        };
        let context = &delivery.query.context;
        let target_owned = match plan.target {
            AcceptanceTarget::View { document, revision } => {
                document == context.scope.view && revision == context.view_revision
            }
            AcceptanceTarget::Source { document, revision } => context
                .primary()
                .is_some_and(|primary| primary.source == document && primary.revision == revision),
        };
        if !target_owned || plan.caret_bytes.len() != context.targets.len() {
            self.completion_close(CancelReason::Superseded);
            self.message = "prepared completion differs from its source/selection owner".into();
            return;
        }
        if preview {
            return self.completion_apply_preview(plan, context);
        }
        let collection = match plan.target {
            AcceptanceTarget::Source { document, .. } if document != context.scope.view => {
                let Some(collection) = self.collections.get(&context.scope.view) else {
                    self.completion_close(CancelReason::Superseded);
                    self.message = AcceptanceRefusal::MissingSource.to_string();
                    return;
                };
                let mut excerpts = Vec::with_capacity(context.targets.len());
                for target in &context.targets {
                    let index = collection
                        .excerpts
                        .partition_point(|excerpt| excerpt.view_start <= target.selection.head)
                        .checked_sub(1);
                    let Some(index) =
                        index.filter(|index| collection.excerpts[*index].source == target.source)
                    else {
                        self.completion_close(CancelReason::Superseded);
                        self.message = AcceptanceRefusal::MissingSource.to_string();
                        return;
                    };
                    excerpts.push(index);
                }
                Some(excerpts)
            }
            _ => None,
        };
        let document = plan.target.document();
        let revision = plan.target.revision();
        let outcome = self.apply(
            document,
            revision,
            crate::editor::transact::ChangeSet {
                edits: plan.edits,
                undo_open: true,
            },
        );
        if let Err(error) = outcome {
            if let Some(session) = &mut self.completion.session {
                session.acceptance = Acceptance::Idle;
                session.preparation = None;
            }
            self.message = format!("completion was not applied: {error}");
            return;
        }
        let mut carets = plan.caret_bytes;
        if let Some(indices) = collection {
            let Some(collection) = self.collections.get_mut(&context.scope.view) else {
                unreachable!("source publication retains its owning collection");
            };
            if !collection
                .pending_commit
                .iter()
                .any(|(source, _)| *source == document)
            {
                collection.pending_commit.push((document, revision));
            }
            for (caret, index) in carets.iter_mut().zip(indices) {
                let excerpt = &collection.excerpts[index];
                debug_assert!(
                    excerpt.source == document && *caret >= excerpt.start && *caret <= excerpt.end,
                    "accepted source carets remain in their remapped excerpts"
                );
                *caret = excerpt.view_start + (*caret - excerpt.start);
            }
        }
        if let Some(primary) = carets.first().copied() {
            self.sels_mut().collapse_primary(primary);
            self.sels_mut().set_extras(carets.into_iter().skip(1));
        }
        if let Some(recording) = &mut self.recording_insert {
            for _ in 0..plan.recording.remove_chars {
                recording.pop();
            }
            recording.push_str(&plan.recording.append);
        }
        // 0069 D05: a snippet plan takes over placement — the session
        // selects the first placeholder instead of a bare caret.
        let snippet = plan.snippet;
        self.completion_close(CancelReason::Dismissed);
        self.message.clear();
        if let Some(stops) = snippet {
            self.snippet_enter(stops);
        }
    }

    /// Tab live preview commit (0059 §6.1): apply the validated plan inside
    /// the current insert undo unit with no acceptance side effects — no
    /// recording update, no pending_commit, no session close. The exact
    /// inverse rides along so the revert replays inside the same unit.
    /// Collection excerpt (source) targets stay acceptance-only; the
    /// highlight remains.
    fn completion_apply_preview(
        &mut self,
        plan: super::acceptance::CompletionAcceptancePlan,
        _context: &super::context::CompletionContext,
    ) {
        let AcceptanceTarget::View { document, .. } = plan.target else {
            if let Some(session) = &mut self.completion.session {
                session.acceptance = Acceptance::Idle;
                session.preparation = None;
            }
            return;
        };
        // Capture the pre-apply text of every edit range and translate each
        // inverse range into the post-apply snapshot. The plan's ranges refer
        // to one shared pre-apply snapshot, are sorted and non-overlapping.
        let mut sorted: Vec<&strop_core::Replacement> = plan.edits.iter().collect();
        sorted.sort_by_key(|edit| (edit.range.start.get(), edit.range.end.get()));
        let mut inverse = Vec::with_capacity(sorted.len());
        {
            let Some(document_ref) = self.docs.get(document) else {
                return;
            };
            let mut shift: isize = 0;
            for edit in sorted {
                let old_text = document_ref.buf.slice_string(edit.range);
                let start = edit.range.start.get() as isize + shift;
                let start = usize::try_from(start).unwrap_or(0);
                inverse.push(strop_core::Replacement {
                    range: strop_core::Range::charwise(start, start + edit.text.len()),
                    text: old_text,
                });
                shift += edit.text.len() as isize
                    - (edit.range.end.get() - edit.range.start.get()) as isize;
            }
        }
        let outcome = self.apply(
            document,
            plan.target.revision(),
            crate::editor::transact::ChangeSet {
                edits: plan.edits,
                // The insert session stays one undo unit (0059 §6.1).
                undo_open: true,
            },
        );
        let committed = match outcome {
            Ok(committed) => committed,
            Err(error) => {
                if let Some(session) = &mut self.completion.session {
                    session.acceptance = Acceptance::Idle;
                    session.preparation = None;
                }
                self.message = format!("completion preview was not applied: {error}");
                return;
            }
        };
        let carets = plan.caret_bytes;
        if let Some(primary) = carets.first().copied() {
            self.sels_mut().collapse_primary(primary);
            self.sels_mut().set_extras(carets.into_iter().skip(1));
        }
        if let Some(session) = &mut self.completion.session {
            session.preview = Some(ActivePreview {
                document,
                revision: committed.revision,
                inverse,
            });
            session.acceptance = Acceptance::Idle;
            session.preparation = None;
        }
    }
}