mirror of
https://github.com/storytold/gridcraft.git
synced 2026-10-25 11:16:49 -06:00
Pranav
6ead1fb519
* Engine: undo groups make several commands one undo step
Session::grouped(label, f) runs f as one undo step on the active
document. On success the group leaves exactly one undo entry holding the
workbook from before the group; on error it restores the workbook,
selection, undo and redo stacks as they were and returns the error.
group_begin, group_end and group_rollback do the same across separate
calls, for an action that runs one step per call.
While a group is open on a document, undoable commands on it add no
undo steps of their own, so a long group neither grows the history nor
pushes older entries past the undo limit, and Undo and Redo are
disabled there. Groups nest: the outermost one makes the step, and a
failing inner group rolls back only its own changes. Closing a document
drops its groups, and a command that panics drops the groups it opened.
history.list reports whether a group is open.
Insert Copied Cells folds its nested steps into one undo step by
counting revisions; inside a group the nested steps push no entries, so
it now leaves the history alone there instead of removing entries from
before the group.
* Engine: a recording buffer of top-level commands, apart from the journal
A macro recorder needs more than a journal index: the journal is
trimmed past 10,000 entries, it also holds the commands that other
commands run (so playback would run them twice), and it keeps no
selection, which relative references need.
Session now tracks how deeply execute calls are nested. While recording,
a buffer (record.rs) keeps each successful, journaled top-level call with
the document uid, the active sheet (index and name) and the selection it
ran in, then its id and parameters without secrets, as the journal
stores them. Queries, failed commands and the command that starts
recording are not kept. The buffer holds up to 100,000 steps and counts
any it drops. Session::start_recording, stop_recording, is_recording and
depth are the interface.
Automate › Record Actions keeps recording through the journal as before.
* Engine: document trust for workbooks opened from files
Active content such as macros must not run only because a workbook was
opened. DocState gets a trust state: Local for workbooks made in the
session (new workbooks and samples) and FromFile for anything opened
with file.open. Active content in a FromFile workbook asks before it
runs. A second window on a workbook shares its trust.
The clipboard carries the trust of its source document. Pasting
formulas, formats (conditional formats hold formulas) or validation
from a FromFile workbook into another workbook makes that workbook
FromFile too; pasting values, column widths or notes carries nothing
active and changes nothing. Sheet moves and copies stay inside one
workbook, so its trust is unchanged. document.inspect reports the trust.
* Engine: workbook data in chunked hidden names (cmd/stash.rs)
GridCraft keeps workbook data in hidden defined names so it travels
inside the xlsx file. The existing items write one name holding one
string literal, which past Excel's 255-character literal and
8,192-character formula limits gives a file Excel does not accept.
cmd/stash.rs stores an item `key` as hidden workbook-scope names
_gc_<key>_0, _gc_<key>_1, ..., each a formula of string literals of at
most 255 characters (UTF-16 units, as Excel counts them) joined with &,
at most 8,192 characters per name. Reading concatenates the chunks in
order and stops at a gap; it also accepts the older single _sc_<key>
name. Names are matched case-insensitively and only at workbook scope.
Keys are limited to letters, digits, _ and ., items to 4,194,304
characters, and junk around or inside the literals, duplicate or
out-of-order chunks, non-JSON and over-deep JSON all read safely.
keys(prefix) lists the stored items that start with a prefix.
Custom views, scripts, the watch list and scenarios keep their current
storage; nothing reads or writes the new names yet.
docs/architecture.md describes the engine building blocks added in this
series: undo groups, the recording buffer, document trust and this
storage.
* Engine: a linked paste of values from a file carries the file's trust
A linked paste writes formulas even when it pastes values, but the values exception skipped the trust update, so a Local workbook stayed Local after linking to a FromFile one. The exception now applies only to unlinked pastes.
* Engine: a stash item with only later chunks reads as missing and falls back to the legacy name
With chunk _gc_k_2 but no _gc_k_0, get returned Some("") and never looked at _sc_k. It now takes the legacy path unless chunk 0 exists.
* Engine: a command that runs its own undo groups makes one undo step for itself
execute treated any change in the group epoch as 'the group owns the step'. A command that edited outside its own group, or whose group rolled back before it edited, left that edit with no undo step or only part of it. Now only a group that was open before the command (or is still open after) owns the step; a command that opened and closed its own groups replaces their steps with one entry for the command.
* Engine: a full undo history keeps one step per command that runs its own undo groups
When the history held 100 steps, group_end pushed its step and dropped the oldest one at once,
so execute's collapse compared against a length that no longer matched. A command that was one
group kept the group's step and added its own, losing two old steps. After test.editThenGroup,
the second Undo brought back the intermediate state after the outside edit.
The history limit now applies after the outermost command has collapsed its steps, and when a
group ends outside any command. A document with an open group is trimmed when the group ends.
* Engine: pasting only formats from a file leaves the destination's trust alone
Paste Special › Formats copies cell styles and merged areas. It copies no conditional formats,
formulas or validation, so it carries nothing that runs. It still marked the destination
FromFile: copying a formula cell from an opened file and pasting its formats into a new workbook
made that workbook ask before running its own active content.
Formats pastes now count as passive, like values, column widths and notes. The comment and
docs/architecture.md no longer say that pasted formats carry trust.
* Engine: a command keeps its group's name only for a group it ended itself
The record of the last group step (document, history length, epoch) outlived the Undo of that
step. A later command that opened and closed its own groups at the same history length, after
rolling one back, passed the epoch check (the record's epoch merely differed from the one the
command started with) and took the name of the nested edit it had made instead of its own.
The step must now come from a group ended during the command (an epoch past the command's
starting one), and a rollback drops a record of a step it truncated away.
* Engine: a group rolled back inside a command keeps the redo history
A command that changed the workbook cleared the redo history even when an open group owned
its step. When the group was then rolled back inside the same command (the debugger's Stop
with Undo Changes), the rollback put the redo history back and the command's bookkeeping cleared
it again. Now only a command that makes a step of its own clears the redo history; a group
clears it when it ends as a step, and a rollback restores it.
* Engine: a visible name of the item shape is not workbook data
The item store read, listed and removed every workbook-scope name of the `_gc_<key>_<n>` shape,
visible or not, so saving an item removed a person's own visible name that happened to look like
one. Items are the hidden names the store writes; a legacy `_sc_<key>` name still reads. A visible
`_gc_` name is left alone by every operation, and writing an item that would need that name is
refused before anything changes: a hidden name beside it with the same name is the one an xlsx
file drops, so the item would be lost on save.
* Engine: a command keeps its group's name only for a step that is exactly the group's
The record of the last group step held the document, the history length and a group epoch, and a command reused the group's label when the lengths matched and the epoch was newer. A direct edit after the group (no nested command, so the length still matches) then left the step named after the group alone.
The record now holds the workbook the group's step led to (a weak reference, so it keeps nothing alive). A command keeps the group's name only when the one entry it added starts from the command's own starting workbook and ends at its result, which is provenance by identity rather than by position: an entry a nested command made, a step of an earlier command undone since, and a group step the command edited past all name the step after the command. A later group that rolled back changes nothing, and the rollback no longer needs to clear the record.
* Engine: the recording buffer is bounded in bytes and keeps the start of a recording
The buffer kept at most 100,000 steps but each step keeps its full parameters, and a file.open step holds the whole file as base64, so a recording of a few opens of a large workbook kept tens of MB alive. Like the journal, the buffer now also stops at 64 MB of steps serialized as JSON. A step that does not fit is counted as dropped, and once a step is dropped every later one is too, so what the buffer holds is always how the recording began, never a sequence with gaps.
* Docs: the architecture revision row carries the date the change lands; document trust beside script trust
The header and the revision row said 2026-10-11, older than the row above them. The document trust paragraph now says how DocState::trust (provenance) differs from DocState::scripts_trusted (per-session consent for stored scripts, #2178).
* Engine: writing a stash item checks for a clashing visible name in one pass over the names
The check ran once per chunk, each a scan of every defined name: an item of many chunks in a workbook with thousands of names compared every pair. One pass now parses each visible workbook-scope name and refuses when it is a chunk of this key below the chunk count. The behaviour and its test are unchanged.
* Engine: a command's changes after ending a group, or before opening one it leaves open, are not lost or a step of their own
Two boundaries of the group rules were wrong. A command that ended a group open before it was treated as grouped whatever it did next: with an unchanged group (no step) its later edit had no undo entry at all, and with nested edits after the end the entry was the nested command's. The group's step now stays the group's, and the command makes one step of its own, under its name, for what changed after the end, from the workbook the group ended at.
A command that edited and then opened a group it leaves open (a debugger's start) left its nested entries in the history, so one Undo after the group ended brought back a state from inside the command. Such a group now takes the command's start as its own, and its step covers the command's earlier edits.
The record of where the last group ended now holds the workbook and selection it ended at, the history length then and whether it made a step; it lives until the outermost command finishes. A rollback records where it ended too, unless the document is back exactly where the last recorded step left it.
* Engine: the undo steps made inside a command are bounded while it runs
The history limit is applied once the outermost command has finished, so the lengths its bookkeeping compares stay true (round 3). That left the steps nested commands make unbounded until then: a script of up to 100,000 steps, or a subtotal with a step per group, kept every one of them alive, each with the cells it retains, and before this branch every push trimmed the history at once.
Each nested command now bounds the steps made since the latest mark on its document to the undo limit and byte budget, dropping the oldest of them. The marks are the starts of the running commands, the starts of the open groups and the end of the last group: the positions a command or group collapses its steps by when it finishes, so nothing before them moves. What the bound drops is only what the final trim would drop.
* Engine: a grouped action that closes its document succeeds
Session::grouped ended its group after the action, and when the action had closed the group's document (file.close, or file.open taking the place of an untouched new workbook) the group had gone with it, so the action was reported as failed although it had done what it was asked. A group that is gone because its document is gone now counts as ended; a group ended by someone else while the document is open is still an error.
* Docs: undo groups at a command's boundaries, and the bound on steps made inside a command
* Engine: a linked paste carries the file's trust whatever it pastes
Paste Link writes a formula into every cell whatever `what` says, so a linked
paste of formats from a file now makes the destination FromFile as a paste of
formulas does. Column widths and notes write no cells, linked or not, and
still carry nothing. Regression test for the three kinds.
* Engine: a stash chunk number with leading zeros names someone else's name
`_gc_watch_00` parsed as chunk 0, so a hidden one was read as the item's first
chunk and a visible one stopped `_gc_watch_0` from being written. Only the
chunk number as `set` writes it counts now. Regression test.
* Engine: a command that panics leaves the undo history as it found it
The panic guard restored the workbook and selection but not the history, so
a nested edit made before the panic left a no-op undo step and the redo
history it had cleared stayed lost. The guard now truncates the steps made
during the command and puts the redo history back. Regression test, and the
architecture note says what the guard restores.
* Engine: a headless call that fails for want of a file is not recorded
file.open with no file succeeds by queuing a dialog, which execute_headless
turns into an error for callers with no UI; the recording kept the step.
Recorder::truncate forgets it and keeps the byte count right. Regression test.
* Engine: a later stash chunk on its own is not a listed item
stash::keys reported a key that get read as missing, because only a later
chunk of it existed. keys now counts chunk 0 and legacy names only, as get
does. Regression assertions in the hostile-names test.
* Tests: a linked paste of column widths or notes copies its metadata and no cell
The source now carries a note and a column width, and the test checks that
the destination received them while its trust stays Local and no cell is
written.
* Engine: the panic guard restores entries a nested Undo removed
Truncating the undo history to its length at the command's start cannot
bring back an entry that a nested edit.undo popped. The guard now keeps the
undo and redo history as they were and puts both back. The regression test
gains the undo-then-panic case.
* Engine: a group a panicking command ended keeps its step
A group open before a command and ended or rolled back inside it lost its
undo step when the command then panicked: the restored history held no entry
for the group's changes, so Undo skipped the state before the group. The
panic path now pushes the outermost such group's step from its start to the
restored workbook. The group stays ended, because its token went with the
command. Regression test for a group ended and one rolled back.
* Docs: list every paste that carries a file's trust
The architecture note named formulas and validation only; it now lists the
Paste Special kinds and linked pastes that write formulas, and the kinds that
carry nothing.
* Engine: a grouped action that panics is rolled back before the panic goes on
Session::grouped ran its action without a panic guard, so a caller outside
a command that caught the panic found the group still open: Undo and Redo
disabled, the partial edits kept, and the next grouped action nested in the
abandoned group. The group is now rolled back and the panic resumed.
Regression test.
* Engine: the recorder counts a dropped step without serializing it
Once a step has been dropped, or the step count is full, push serialized
each later step only to count it; a file.open step holds a whole file. The
checks that need no size come first.
* Engine: a failed command rolls back the undo groups it opened
A command that opened an undo group and then returned an error (a `?`
between `group_begin` and `group_end`) left the group open for good:
Undo and Redo refused with "finish or stop the running action first",
later edits made no undo steps, and nothing could stop the group.
`execute` now rolls back every group a failed command opened, as
`group_rollback` does, restoring the workbook, selection, undo and
redo history to where each group began. Only a command that succeeds
keeps a group it opened, which is what a debugger's start needs.
`Session::abort_groups(doc)` and the menu-less command
`automate.stopAction` roll back the groups left open on a document,
for a debugger the person abandons or a caller that dropped its
token. The command is not undoable and works while a group is open,
and the Undo refusal now names it.
* Engine: the recorder skips a call that only opened a dialog
A menu-style call with no parameters, such as `file.open`,
`data.fromTextCsv` or `home.formatCells` with `{}`, only queues its
dialog and succeeds. The recorder kept it as a step with empty
parameters, and then kept the dialog's confirming call as well, so
playing the recording back ran the command twice, or failed on the
empty step when played back headless. Only `execute_headless` took
the step back, and only for the open and save-as dialogs.
`execute` now compares the queued UI requests before and after a
top-level command and does not record one that queued a dialog. The
special case in `execute_headless` goes (it keeps turning a missing
file into an error), and with it `Recorder::truncate`, which had no
other caller.
* Engine: stash items keep characters XML can't carry
The xlsx writer drops characters XML 1.0 can't carry: controls other
than tab, line feed and carriage return, and U+FFFE and U+FFFF. A
stash item holding one lost it on save without a warning, and so did
a JSON item, since serde_json leaves U+FFFE and U+FFFF unescaped: a
stored macro parameter changed silently.
`chunk_formulas` now writes each such character, and the marker
itself, as the noncharacter U+FDD0 followed by four hex digits, and
`get` turns them back for `_gc_` items. A marker that isn't followed
by four hex digits naming a character is read as it is. An escape
counts as five units against the 255-unit literal limit and is never
split across literals, and the guard on the stored size allows the
longest item even when every character is escaped. Legacy `_sc_`
items are read unchanged.
* Engine: list stash items in one pass over the names
Each `stash::get` looks at every defined name, so listing the items
with `keys` and then reading each with `get` took time quadratic in
the number of names. A file with 20,000 hidden `_gc_macro_<i>_0`
names took about ten seconds in a debug build, and the macro list
reads its items this way from data that comes from the file.
`stash::items(wb, prefix)` now groups the names by item in one pass
and returns each item's text by key, and `keys` lists from the same
pass. Both return at most `MAX_ITEMS` (10,000) items, the first keys
in sorted order, so a file with any number of hidden names can't make
a listing unbounded. A test counts the names each listing looks at.
* Engine: the name commands leave GridCraft's data names alone
`formulas.defineName {"name": "_gc_macro_1_0"}` replaced the hidden
chunk of a stored item with a visible name: the item vanished from
`stash::get` and `stash::keys`, and its other chunks stayed behind as
orphan hidden names. `formulas.deleteName` could remove chunks the
same way, and `formulas.createFromSelection` with `replace` could
replace one from a cell label. `stash::set` refused a clash with a
visible name, but nothing guarded the other direction.
Defining, renaming or deleting a name that `stash::item_key`
recognises (`_gc_<key>_<n>` and legacy `_sc_<key>`) is now refused
with an error that names `force: true`, which lets the call go ahead.
Create from Selection lists such labels in `skipped` unless `force`
is true. The params docs of the three commands say so.
* Engine: queries take no copy of the undo history
`execute` copied the document's undo and redo history on every call,
so a panic could put it back: up to 100 entries per stack, each with
a label and a selection. Queries paid for it too, although no query
runs a command or changes the history, and front ends and agents run
queries all the time.
The copy is now skipped for queries (commands that neither journal
nor make undo steps). A test runs every query, with empty and with
typical parameters, and checks the history is unchanged, so a query
that ever changes it fails there. Commands that can change the
history, nested ones included, still take the copy: a nested command
that panics is restored at its own level, and the outer command can
carry on, so relying on the outermost copy would weaken that restore.
* Engine: a document's maker says where its content came from
`Trust` defaulted to `Local`, and `DocState::new` set it, so a
document was trusted unless its maker remembered to mark it. Every
current path that reads a file goes through `file.open`, which marks
it `FromFile`, but a later way of building a document from bytes
(recovery, templates, a new import) would have come out trusted by
omission.
`DocState::new` now takes the `Trust`, and `Trust` has no default.
New workbooks and samples pass `Local`, `file.open` passes
`FromFile`, a new window passes the trust of its workbook, and the
tests that build documents from bytes pass `FromFile`.
* Engine: the name commands refuse only names that hold GridCraft's data
The guard refused any name of the stash's shape, so a visible name a person
had defined, such as _gc_rate_0, could not be edited or deleted from Name
Manager, which cannot pass force. It now refuses a name only when the
workbook holds a hidden workbook-scope item under it; a visible name of the
shape is the person's own, as the stash itself treats it. The test covers
such a name. The query comment says what the copy skip relies on: a query
runs nothing that changes the history.
* UI: the toolbar's Undo and Redo follow the commands' own availability
The ribbon enabled them from the history lengths alone, so while an undo
group was open on the document (an action spanning several calls) a click
ran edit.undo and got its refusal. The buttons now ask cmd::can_undo and
cmd::can_redo, the undo list is empty while a group is open, and the two
buttons carry a name and their enabled state for assistive technology. A UI
test opens a group, clicks both and checks the history and their state.
* Engine: the name commands use the stash's own rule for what holds its data
The guard asked for a hidden name, but the stash reads a legacy _sc_<key>
name whether it is hidden or not, so a visible one could be removed or
replaced without force. stash::holds_item is the one rule (item_of), shared
by the guard; the test covers a visible legacy name.
* Docs: the panic guard's note says what happens to a group the command ended
It keeps a step from the group's start to the restored workbook, so Undo
still returns to the state before the group; the note said the history came
back exactly.
925 lines
41 KiB
Rust
925 lines
41 KiB
Rust
//! The GridCraft engine façade.
|
||
//!
|
||
//! Every user-visible action is a command with a stable id (`cell.set`, `home.bold`,
|
||
//! `data.sortAscending`…) and JSON parameters. The egui UI, the CLI, the control channel and MCP
|
||
//! all go through [`Session::execute`], so every action is scriptable and journaled.
|
||
#![deny(clippy::unwrap_used, clippy::expect_used, clippy::panic, clippy::unimplemented, clippy::todo, clippy::unreachable)]
|
||
#![forbid(unsafe_code)]
|
||
|
||
pub mod catalog;
|
||
pub mod cf;
|
||
mod chart_svg;
|
||
mod clip_html;
|
||
pub mod cmd;
|
||
pub mod display;
|
||
pub mod fill;
|
||
pub mod io;
|
||
pub mod links;
|
||
pub mod outline;
|
||
pub mod paper;
|
||
pub mod pivot;
|
||
pub mod pivot_calc;
|
||
pub mod record;
|
||
pub mod sample;
|
||
pub mod selection;
|
||
pub mod tables;
|
||
|
||
use std::sync::Arc;
|
||
|
||
use gridcraft_calc::Calc;
|
||
use gridcraft_core::{CellRef, RangeRef};
|
||
use gridcraft_model::Workbook;
|
||
use serde::Serialize;
|
||
use serde_json::Value as Json;
|
||
|
||
pub use cmd::{CommandInfo, CommandSpec, command_specs, find_command, register_test_command};
|
||
pub use gridcraft_calc as calc;
|
||
pub use gridcraft_core as core;
|
||
pub use gridcraft_formula as formula;
|
||
pub use gridcraft_model as model;
|
||
pub use gridcraft_numfmt as numfmt;
|
||
pub use selection::Selection;
|
||
|
||
#[derive(Debug, thiserror::Error)]
|
||
pub enum EngineError {
|
||
#[error("unknown command `{0}`")]
|
||
UnknownCommand(String),
|
||
#[error("command `{0}` is not available right now: {1}")]
|
||
Disabled(String, String),
|
||
#[error("invalid parameters for `{cmd}`: {msg}")]
|
||
BadParams { cmd: String, msg: String },
|
||
#[error("no workbook open")]
|
||
NoDocument,
|
||
#[error("{0}")]
|
||
Other(String),
|
||
#[error("internal error in `{0}` (the workbook was kept as it was): {1}")]
|
||
Internal(String, String),
|
||
}
|
||
|
||
pub type Result<T> = std::result::Result<T, EngineError>;
|
||
|
||
#[derive(Clone, Debug)]
|
||
pub struct HistoryEntry {
|
||
pub label: String,
|
||
pub wb: Arc<Workbook>,
|
||
pub selection: Selection,
|
||
/// Estimate of storage this snapshot retains beyond the next workbook version.
|
||
pub retained_bytes: usize,
|
||
}
|
||
|
||
/// An undo group opened with [`Session::group_begin`]. Hand it back to [`Session::group_end`]
|
||
/// (keep the changes as one undo step) or [`Session::group_rollback`] (undo them all).
|
||
#[derive(Debug, PartialEq, Eq)]
|
||
#[must_use = "an undo group stays open until it is ended or rolled back"]
|
||
pub struct GroupToken {
|
||
id: u64,
|
||
doc: u64,
|
||
}
|
||
|
||
impl GroupToken {
|
||
/// The uid of the document the group belongs to.
|
||
pub fn doc(&self) -> u64 {
|
||
self.doc
|
||
}
|
||
}
|
||
|
||
/// An open undo group: what runs on `doc` until it ends becomes one undo step.
|
||
#[derive(Clone, Debug)]
|
||
struct OpenGroup {
|
||
id: u64,
|
||
doc: u64,
|
||
label: String,
|
||
/// Undo depth when the group began; the group's own steps are cut back to it.
|
||
start: usize,
|
||
wb: Arc<Workbook>,
|
||
selection: Selection,
|
||
/// The redo stack when the group began (a rollback puts it back).
|
||
redo: Vec<HistoryEntry>,
|
||
}
|
||
|
||
/// Where the last [`Session::group_end`] or [`Session::group_rollback`] left its document: the
|
||
/// workbook and selection it ended at, the undo length then, and whether it made a step. A
|
||
/// command that ended the group tells its own later changes from the group's step by it, and
|
||
/// keeps the group's name only when the group's step is exactly its own (the entry holds the
|
||
/// workbook the step started from). Dropped when the outermost command finishes, so it keeps no
|
||
/// workbook alive between commands.
|
||
#[derive(Debug)]
|
||
struct GroupStep {
|
||
doc: u64,
|
||
after: Arc<Workbook>,
|
||
selection: Selection,
|
||
len: usize,
|
||
stepped: bool,
|
||
}
|
||
|
||
/// The clipboard: a block of cells (with formulas and styles) or marching-ants reference.
|
||
#[derive(Clone, Debug)]
|
||
pub struct Clipboard {
|
||
/// Source workbook snapshot, sheet and range.
|
||
pub wb: Arc<Workbook>,
|
||
pub sheet: usize,
|
||
pub range: RangeRef,
|
||
/// The range as copied, before whole rows/columns were trimmed to the used range
|
||
/// (Insert Copied Cells inserts whole lines for a row or column copy).
|
||
pub selected: RangeRef,
|
||
pub cut: bool,
|
||
/// Document uid of the source (a cut only moves within the same workbook).
|
||
pub doc_uid: u64,
|
||
/// Plain text (tab-separated) for the system clipboard.
|
||
pub text: String,
|
||
/// A multi-area copy: the areas as selected (for the marquee). `wb` then holds them slid
|
||
/// together into one block at `range`. Empty for a single-range copy.
|
||
pub areas: Vec<RangeRef>,
|
||
/// Trust of the source document: pasting content from a file someone else made carries it.
|
||
pub trust: Trust,
|
||
}
|
||
|
||
/// Whether a document's active content (macros) may run without asking the person first. There
|
||
/// is no default: whoever makes a document says where it came from ([`DocState::new`]), so a new
|
||
/// way of building one from bytes can't come out trusted by omission.
|
||
#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize)]
|
||
#[serde(rename_all = "camelCase")]
|
||
pub enum Trust {
|
||
/// Made in this session: a new workbook or a sample.
|
||
Local,
|
||
/// Opened from a file, or holding content pasted from one: active content asks before it
|
||
/// runs.
|
||
FromFile,
|
||
}
|
||
|
||
impl Trust {
|
||
/// Whether active content may run without asking.
|
||
pub fn allows_code(self) -> bool {
|
||
self == Trust::Local
|
||
}
|
||
|
||
/// The trust of a document after it receives content from a document with trust `source`:
|
||
/// content from an untrusted file leaves the receiver untrusted.
|
||
pub fn receive(self, source: Trust) -> Trust {
|
||
if source == Trust::FromFile { Trust::FromFile } else { self }
|
||
}
|
||
}
|
||
|
||
/// In-cell edit mode as shown in the status bar.
|
||
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Serialize)]
|
||
pub enum Mode {
|
||
#[default]
|
||
Ready,
|
||
Enter,
|
||
Edit,
|
||
Point,
|
||
}
|
||
|
||
#[derive(Clone, Debug)]
|
||
pub struct DocState {
|
||
pub wb: Arc<Workbook>,
|
||
pub calc: Calc,
|
||
pub selection: Selection,
|
||
pub undo: Vec<HistoryEntry>,
|
||
pub redo: Vec<HistoryEntry>,
|
||
pub path: Option<String>,
|
||
pub saved: Arc<Workbook>,
|
||
pub revision: u64,
|
||
pub uid: u64,
|
||
pub title: String,
|
||
/// Per-sheet selection memory.
|
||
pub sheet_selections: Vec<Selection>,
|
||
/// Allow Edit Ranges unlocked with their password in this session: (sheet name, title).
|
||
pub unlocked_ranges: Vec<(String, String)>,
|
||
/// The format `path`'s content was recognised as when its extension doesn't name one (an
|
||
/// XLSX called `budget.dat`): Save writes it back in that format.
|
||
pub content_kind: Option<io::FileKind>,
|
||
/// Whether the scripts stored in this workbook may run (`automate.runScript`). A workbook
|
||
/// that arrives already carrying scripts (opened from a file) starts untrusted until the
|
||
/// user trusts it in this session (`automate.trustScripts`); one with no scripts starts
|
||
/// trusted, since any script it gains later was written here.
|
||
pub scripts_trusted: bool,
|
||
/// Where the workbook's content came from: whether its active content may run without
|
||
/// asking. Unlike `scripts_trusted`, this is provenance, not consent: it is set when the
|
||
/// workbook is opened from a file, carried by content pasted from such a workbook, and never
|
||
/// changed by a trust decision.
|
||
pub trust: Trust,
|
||
}
|
||
|
||
static NEXT_UID: std::sync::atomic::AtomicU64 = std::sync::atomic::AtomicU64::new(1);
|
||
const UNDO_LIMIT: usize = 100;
|
||
/// Past this many entries the journal drops its oldest half.
|
||
const JOURNAL_MAX_ENTRIES: usize = 10_000;
|
||
/// Past this many bytes (entries serialized as JSON) the journal drops its oldest entries until
|
||
/// it is under half. Entries keep their full params so they replay (recorded scripts,
|
||
/// `engine.journal`), and a `file.open` holds the whole file as base64: without a size cap a
|
||
/// few opens of a large workbook keep tens of MB alive.
|
||
pub(crate) const JOURNAL_MAX_BYTES: usize = 64 * 1024 * 1024;
|
||
const UNDO_BYTES_LIMIT: usize = 128 * 1024 * 1024;
|
||
|
||
fn history_retained_bytes(older: &Workbook, newer: &Workbook) -> usize {
|
||
let mut bytes = std::mem::size_of::<Workbook>();
|
||
for (index, sheet) in older.sheets.iter().enumerate() {
|
||
// Moving or inserting sheets must not charge unchanged sheets at a new index.
|
||
if newer.sheets.iter().any(|next| Arc::ptr_eq(sheet, next)) {
|
||
continue;
|
||
}
|
||
bytes = bytes.saturating_add(std::mem::size_of::<gridcraft_model::Sheet>());
|
||
let empty = gridcraft_model::CellStore::new();
|
||
let next = newer.sheets.get(index).map_or(&empty, |next| &next.cells);
|
||
bytes = bytes.saturating_add(sheet.cells.retained_bytes_against(next));
|
||
}
|
||
bytes
|
||
}
|
||
|
||
fn push_history(history: &mut Vec<HistoryEntry>, label: String, wb: Arc<Workbook>, next: &Workbook, selection: Selection) {
|
||
push_history_with_budget(history, label, wb, next, selection, UNDO_BYTES_LIMIT);
|
||
}
|
||
|
||
fn push_history_with_budget(
|
||
history: &mut Vec<HistoryEntry>,
|
||
label: String,
|
||
wb: Arc<Workbook>,
|
||
next: &Workbook,
|
||
selection: Selection,
|
||
byte_budget: usize,
|
||
) {
|
||
push_entry(history, label, wb, next, selection);
|
||
trim_to_budget(history, byte_budget);
|
||
}
|
||
|
||
/// Adds a step without applying the limits: inside a command they wait for the outermost
|
||
/// command to collapse its steps (see [`Session::trim_history`]).
|
||
fn push_entry(history: &mut Vec<HistoryEntry>, label: String, wb: Arc<Workbook>, next: &Workbook, selection: Selection) {
|
||
let retained_bytes = history_retained_bytes(&wb, next);
|
||
history.push(HistoryEntry { label, wb, selection, retained_bytes });
|
||
}
|
||
|
||
/// Drops the oldest steps past [`UNDO_LIMIT`] or `byte_budget`, always keeping the latest one
|
||
/// (even if that one edit exceeds the budget).
|
||
fn trim_to_budget(history: &mut Vec<HistoryEntry>, byte_budget: usize) {
|
||
let mut total = history.iter().fold(0usize, |sum, entry| sum.saturating_add(entry.retained_bytes));
|
||
while history.len() > 1 && (history.len() > UNDO_LIMIT || total > byte_budget) {
|
||
total = total.saturating_sub(history.remove(0).retained_bytes);
|
||
}
|
||
}
|
||
|
||
impl DocState {
|
||
/// A document for `wb`, which came from where `trust` says: [`Trust::FromFile`] for anything
|
||
/// read from bytes (a file, a download, a recovery copy), [`Trust::Local`] only for a workbook
|
||
/// made in this session.
|
||
pub fn new(mut wb: Workbook, path: Option<String>, title: String, trust: Trust) -> DocState {
|
||
let mut calc = Calc::new();
|
||
calc.recalc_all(&mut wb);
|
||
let scripts_trusted = !cmd::extra::has_scripts(&wb);
|
||
let wb = Arc::new(wb);
|
||
let sel = Selection::at(wb.active().map(|s| s.view_active).unwrap_or_default());
|
||
DocState {
|
||
saved: wb.clone(),
|
||
wb,
|
||
calc,
|
||
selection: sel,
|
||
undo: vec![],
|
||
redo: vec![],
|
||
path,
|
||
revision: 1,
|
||
uid: NEXT_UID.fetch_add(1, std::sync::atomic::Ordering::Relaxed),
|
||
title,
|
||
sheet_selections: vec![],
|
||
unlocked_ranges: vec![],
|
||
content_kind: None,
|
||
scripts_trusted,
|
||
trust,
|
||
}
|
||
}
|
||
pub fn is_dirty(&self) -> bool {
|
||
!Arc::ptr_eq(&self.wb, &self.saved)
|
||
}
|
||
pub fn sheet_index(&self) -> usize {
|
||
self.wb.active_sheet
|
||
}
|
||
/// Records the view state that is saved with the file (`sheetView topLeftCell`, the active
|
||
/// cell): the first visible cell of the scrolling area per sheet index in `tops`, and the
|
||
/// active sheet's active cell. View state never makes the workbook dirty.
|
||
pub fn store_view(&mut self, tops: &[(usize, CellRef)]) {
|
||
let active = self.selection.active;
|
||
let si = self.wb.active_sheet;
|
||
let changed = tops.iter().any(|(i, c)| self.wb.sheets.get(*i).is_some_and(|sh| sh.view_top_left != *c))
|
||
|| self.wb.sheets.get(si).is_some_and(|sh| sh.view_active != active);
|
||
if !changed {
|
||
return;
|
||
}
|
||
let dirty = self.is_dirty();
|
||
let wb = Arc::make_mut(&mut self.wb);
|
||
for (i, c) in tops {
|
||
if let Some(sh) = wb.sheets.get_mut(*i)
|
||
&& sh.view_top_left != *c
|
||
{
|
||
Arc::make_mut(sh).view_top_left = *c;
|
||
}
|
||
}
|
||
if let Some(sh) = wb.sheets.get_mut(si)
|
||
&& sh.view_active != active
|
||
{
|
||
Arc::make_mut(sh).view_active = active;
|
||
}
|
||
if !dirty {
|
||
self.saved = self.wb.clone();
|
||
}
|
||
}
|
||
pub fn display_title(&self) -> String {
|
||
self.path
|
||
.as_deref()
|
||
.and_then(|p| std::path::Path::new(p).file_name())
|
||
.map(|n| n.to_string_lossy().to_string())
|
||
.unwrap_or_else(|| self.title.clone())
|
||
}
|
||
}
|
||
|
||
/// Engine-side preferences.
|
||
#[derive(Clone, Debug, Serialize, serde::Deserialize)]
|
||
#[serde(default, rename_all = "camelCase")]
|
||
pub struct Prefs {
|
||
/// After pressing Enter, move the selection: "down", "right", "up", "left", "none".
|
||
pub enter_direction: String,
|
||
pub autocomplete: bool,
|
||
pub user_name: String,
|
||
pub default_font: String,
|
||
pub default_font_size: f32,
|
||
pub sheets_in_new_workbook: usize,
|
||
pub r1c1: bool,
|
||
/// Words added with Add to Dictionary.
|
||
pub user_dictionary: Vec<String>,
|
||
/// View › Show › Formula Bar (an application option in Excel, not saved in the file).
|
||
pub formula_bar: bool,
|
||
}
|
||
|
||
impl Default for Prefs {
|
||
fn default() -> Self {
|
||
Prefs {
|
||
enter_direction: "down".into(),
|
||
autocomplete: true,
|
||
user_name: "GridCraft User".into(),
|
||
default_font: gridcraft_model::DEFAULT_FONT.into(),
|
||
default_font_size: gridcraft_model::DEFAULT_FONT_SIZE,
|
||
sheets_in_new_workbook: 1,
|
||
r1c1: false,
|
||
user_dictionary: vec![],
|
||
formula_bar: true,
|
||
}
|
||
}
|
||
}
|
||
|
||
/// Requests from commands to the UI (open a dialog, show a message…).
|
||
#[derive(Clone, Debug, PartialEq, Serialize)]
|
||
pub enum UiRequest {
|
||
Dialog(String, Json),
|
||
Message(String),
|
||
/// Start editing the active cell (F2) with optional initial text.
|
||
EditCell(Option<String>),
|
||
OpenUrl(String),
|
||
}
|
||
|
||
/// Width in points of one line of text drawn in a cell font, measured by a front end that has
|
||
/// the font the grid draws with. With `exact` false the front end may answer with a cheaper
|
||
/// measure that is never narrower (AutoFit asks for it on columns with many distinct values).
|
||
/// Commands call it while they run, so a front end must not run commands while holding a lock
|
||
/// the measure takes (egui's: see `theme::cell_text_width` in the UI crate).
|
||
pub type TextWidth = Arc<dyn Fn(&str, &model::Font, bool) -> f32 + Send + Sync>;
|
||
|
||
#[derive(Default)]
|
||
pub struct Session {
|
||
docs: Vec<DocState>,
|
||
active: usize,
|
||
pub clipboard: Option<Clipboard>,
|
||
pub prefs: Prefs,
|
||
pub mode: Mode,
|
||
/// Commands run so far, without their passwords ([`cmd::journal_params`]).
|
||
pub journal: Vec<(String, Json)>,
|
||
/// Serialized size of each journal entry, measured once when it is pushed, and their sum.
|
||
journal_sizes: Vec<usize>,
|
||
journal_bytes: usize,
|
||
pub ui_requests: Vec<UiRequest>,
|
||
/// Format painter source style (sticky when double-clicked).
|
||
pub format_painter: Option<(Arc<Workbook>, usize, RangeRef, bool)>,
|
||
/// Find state (last search).
|
||
pub last_find: Option<Json>,
|
||
/// View › Show › Ruler is off (rulers in Page Layout view; an application option).
|
||
pub hide_ruler: bool,
|
||
/// Journal position where Automate › Record Actions started.
|
||
pub recording: Option<usize>,
|
||
/// The recording buffer while a recorder runs ([`Session::start_recording`]): top-level
|
||
/// commands with the place they ran in, kept apart from the journal.
|
||
pub recorder: Option<record::Recorder>,
|
||
/// How many `execute` calls are running (0 between top-level commands).
|
||
depth: u32,
|
||
/// Windows hidden with View › Hide.
|
||
pub hidden_windows: Vec<usize>,
|
||
/// Draw tab tool: "" (select), "pen" or "eraser"; pen colour and width.
|
||
pub draw_tool: String,
|
||
pub draw_color: String,
|
||
pub draw_width: f32,
|
||
/// Review › Show Comments: the Comments pane is open.
|
||
pub comments_pane: bool,
|
||
/// Review › Notes › Show All Notes: every note is displayed. An application display setting
|
||
/// (like Excel's comment indicator option), so it's not saved in the file.
|
||
pub show_all_notes: bool,
|
||
/// Open undo groups, innermost last.
|
||
groups: Vec<OpenGroup>,
|
||
next_group: u64,
|
||
/// Counts group begins and ends, so `execute` can tell that a command opened or closed one.
|
||
group_epoch: u64,
|
||
/// Where the last group ended, so `execute` can tell a command's own changes from its group's.
|
||
group_step: Option<GroupStep>,
|
||
/// For each running command, innermost last: its document and that document's undo length
|
||
/// when it began. Steps before that length are not touched while the command runs (see
|
||
/// [`Session::bound_tail`]).
|
||
marks: Vec<(u64, usize)>,
|
||
/// Measures cell text for AutoFit Column Width. Without it (CLI, MCP) AutoFit uses
|
||
/// [`cmd::format::approx_text_width`].
|
||
pub text_width: Option<TextWidth>,
|
||
}
|
||
|
||
impl Session {
|
||
pub fn new() -> Session {
|
||
Session::default()
|
||
}
|
||
pub fn documents(&self) -> &[DocState] {
|
||
&self.docs
|
||
}
|
||
pub fn active_index(&self) -> usize {
|
||
self.active
|
||
}
|
||
pub fn set_active(&mut self, i: usize) {
|
||
if i < self.docs.len() {
|
||
self.active = i;
|
||
}
|
||
}
|
||
pub fn active(&self) -> Option<&DocState> {
|
||
self.docs.get(self.active)
|
||
}
|
||
pub fn active_mut(&mut self) -> Option<&mut DocState> {
|
||
self.docs.get_mut(self.active)
|
||
}
|
||
pub fn doc(&self) -> Result<&DocState> {
|
||
self.active().ok_or(EngineError::NoDocument)
|
||
}
|
||
pub fn doc_mut(&mut self) -> Result<&mut DocState> {
|
||
self.active_mut().ok_or(EngineError::NoDocument)
|
||
}
|
||
pub fn add_document(&mut self, d: DocState) -> usize {
|
||
self.docs.push(d);
|
||
self.active = self.docs.len() - 1;
|
||
self.active
|
||
}
|
||
pub fn close_document(&mut self, i: usize) {
|
||
if i < self.docs.len() {
|
||
let d = self.docs.remove(i);
|
||
self.groups.retain(|g| g.doc != d.uid);
|
||
if self.active >= self.docs.len() {
|
||
self.active = self.docs.len().saturating_sub(1);
|
||
}
|
||
}
|
||
}
|
||
/// A new blank workbook titled `BookN`.
|
||
pub fn new_workbook(&mut self) -> usize {
|
||
let n = (1..).find(|n| !self.docs.iter().any(|d| d.title == format!("Book{n}") && d.path.is_none())).unwrap_or(1);
|
||
let mut wb = Workbook::new();
|
||
for _ in 1..self.prefs.sheets_in_new_workbook.clamp(1, 255) {
|
||
let name = wb.next_sheet_name();
|
||
wb.sheets.push(Arc::new(gridcraft_model::Sheet::new(name)));
|
||
}
|
||
self.add_document(DocState::new(wb, None, format!("Book{n}"), Trust::Local))
|
||
}
|
||
|
||
/// Journals a command, then trims the oldest entries past either cap. A recording in progress
|
||
/// keeps pointing at the same entry (the steps the trim dropped are lost).
|
||
fn push_journal(&mut self, id: &str, params: Json) {
|
||
let size = |e: &(String, Json)| serde_json::to_vec(e).map_or(0, |v| v.len());
|
||
// `journal` is public: if it was changed from outside, measure it again.
|
||
if self.journal_sizes.len() != self.journal.len() {
|
||
self.journal_sizes = self.journal.iter().map(size).collect();
|
||
self.journal_bytes = self.journal_sizes.iter().sum();
|
||
}
|
||
let entry = (id.to_string(), params);
|
||
let entry_size = size(&entry);
|
||
self.journal.push(entry);
|
||
self.journal_sizes.push(entry_size);
|
||
self.journal_bytes = self.journal_bytes.saturating_add(entry_size);
|
||
let len = self.journal.len();
|
||
let mut n = if len > JOURNAL_MAX_ENTRIES { len - JOURNAL_MAX_ENTRIES / 2 } else { 0 };
|
||
let mut kept = self.journal_bytes.saturating_sub(self.journal_sizes.iter().take(n).sum());
|
||
if self.journal_bytes > JOURNAL_MAX_BYTES {
|
||
// The newest entry stays even when it is larger than the cap on its own.
|
||
while kept > JOURNAL_MAX_BYTES / 2 && n + 1 < len {
|
||
kept = kept.saturating_sub(self.journal_sizes.get(n).copied().unwrap_or(0));
|
||
n += 1;
|
||
}
|
||
}
|
||
if n > 0 {
|
||
self.journal.drain(..n);
|
||
self.journal_sizes.drain(..n);
|
||
self.journal_bytes = kept;
|
||
self.recording = self.recording.map(|r| r.saturating_sub(n));
|
||
}
|
||
}
|
||
|
||
pub fn commands(&self) -> Vec<CommandInfo> {
|
||
command_specs().iter().map(|c| c.info(self)).collect()
|
||
}
|
||
|
||
/// Runs a command by id. Undoable commands record a history step when the workbook changed,
|
||
/// unless an undo group is open on the document (the group then makes the step).
|
||
/// Panics inside commands are caught and reported; the workbook is restored.
|
||
pub fn execute(&mut self, id: &str, params: Json) -> Result<Json> {
|
||
let spec = find_command(id).ok_or_else(|| EngineError::UnknownCommand(id.to_string()))?;
|
||
if let Err(why) = (spec.enabled)(self) {
|
||
return Err(EngineError::Disabled(id.to_string(), why));
|
||
}
|
||
let before = self.active().map(|d| (d.uid, d.wb.clone(), d.selection.clone()));
|
||
let params = if params.is_null() { Json::Object(Default::default()) } else { params };
|
||
let (first_group, group_epoch) = (self.next_group, self.group_epoch);
|
||
// Whether a group was open on the document before the command, and how long its history was.
|
||
let start = before.as_ref().and_then(|(uid, ..)| self.docs.iter().find(|d| d.uid == *uid).map(|d| (self.in_group(*uid), d.undo.len())));
|
||
// A command that panics leaves the history as it found it: the steps commands nested in it
|
||
// made or undid, and the redo history they cleared, come back. A length is not enough,
|
||
// because a nested `edit.undo` removes entries. A query runs nothing that changes the
|
||
// history (`every_query_leaves_the_history_alone` runs each one), so it needs no
|
||
// copy; front ends run queries all the time.
|
||
let query = !spec.journal && !spec.undoable;
|
||
let history_before = before.as_ref().filter(|_| !query).and_then(|(uid, ..)| {
|
||
#[cfg(test)]
|
||
tests::HISTORY_COPIES.with(|n| n.set(n.get().saturating_add(1)));
|
||
self.docs.iter().find(|d| d.uid == *uid).map(|d| (d.undo.clone(), d.redo.clone()))
|
||
});
|
||
// The groups open on the document before the command (usually none), for the same reason.
|
||
let groups_before: Vec<(u64, String, Arc<Workbook>, Selection)> = match &before {
|
||
Some((uid, ..)) => {
|
||
self.groups.iter().filter(|g| g.doc == *uid).map(|g| (g.id, g.label.clone(), g.wb.clone(), g.selection.clone())).collect()
|
||
}
|
||
None => Vec::new(),
|
||
};
|
||
// The recorder keeps top-level calls with the place they ran in.
|
||
let place = (self.depth == 0 && self.recorder.is_some()).then(|| match self.active() {
|
||
Some(d) => (d.uid, d.wb.active_sheet, d.wb.active().map(|sh| sh.name.clone()).unwrap_or_default(), d.selection.clone()),
|
||
None => (0, 0, String::new(), Selection::default()),
|
||
});
|
||
let doc_uid = before.as_ref().map(|(uid, ..)| *uid);
|
||
let requests_before = self.ui_requests.len();
|
||
let marked = doc_uid.zip(start).map(|(uid, (_, len))| (uid, len));
|
||
self.marks.extend(marked);
|
||
self.depth = self.depth.saturating_add(1);
|
||
let result = std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| (spec.run)(self, ¶ms)));
|
||
self.depth = self.depth.saturating_sub(1);
|
||
if marked.is_some() {
|
||
self.marks.pop();
|
||
}
|
||
let result = match result {
|
||
Ok(r) => r,
|
||
Err(p) => {
|
||
let msg =
|
||
p.downcast_ref::<&str>().map(|s| s.to_string()).or_else(|| p.downcast_ref::<String>().cloned()).unwrap_or_else(|| "panic".into());
|
||
// Restore the workbook and its history as they were, and drop the undo groups the
|
||
// command opened.
|
||
self.groups.retain(|g| g.id < first_group);
|
||
let group_open = before.as_ref().is_some_and(|(uid, ..)| self.groups.iter().any(|g| g.doc == *uid));
|
||
if let Some((uid, wb, sel)) = &before
|
||
&& let Some(d) = self.docs.iter_mut().find(|d| d.uid == *uid)
|
||
{
|
||
d.wb = wb.clone();
|
||
d.selection = sel.clone();
|
||
if let Some((undo, redo)) = history_before {
|
||
d.undo = undo;
|
||
d.redo = redo;
|
||
}
|
||
// A group open before the command and ended or rolled back inside it stays
|
||
// ended (its token went with the command), and keeps a step from its start to
|
||
// the restored workbook, so Undo still returns to the state before the group.
|
||
if !group_open
|
||
&& let Some((_, label, wb, selection)) = groups_before.into_iter().min_by_key(|g| g.0)
|
||
&& !Arc::ptr_eq(&wb, &d.wb)
|
||
{
|
||
push_entry(&mut d.undo, label, wb, &d.wb, selection);
|
||
d.redo.clear();
|
||
}
|
||
d.calc.rebuild(&d.wb);
|
||
}
|
||
if self.depth == 0 {
|
||
self.trim_history();
|
||
self.group_step = None;
|
||
}
|
||
return Err(EngineError::Internal(id.to_string(), msg));
|
||
}
|
||
};
|
||
// A command that fails leaves none of its own undo groups open (a `?` between
|
||
// `group_begin` and `group_end`): each is rolled back as `group_rollback` does. Only a
|
||
// command that succeeds keeps a group it opened (a debugger's start).
|
||
if result.is_err() {
|
||
self.rollback_groups_from(first_group);
|
||
}
|
||
if spec.journal && result.is_ok() {
|
||
// A command that started recording is not part of the recording; one that stopped it
|
||
// finds no recorder. A menu-style call that only opened a dialog (`file.open` with no
|
||
// file, `home.formatCells` with no style) is not recorded either: the dialog's own
|
||
// call is, so playing the recording back runs the command once, with its parameters.
|
||
let opened_dialog = self.ui_requests.get(requests_before..).is_some_and(|new| new.iter().any(|q| matches!(q, UiRequest::Dialog(..))));
|
||
if let Some((doc, sheet, sheet_name, selection)) = place.filter(|_| !opened_dialog)
|
||
&& let Some(rec) = self.recorder.as_mut()
|
||
{
|
||
rec.push(record::RecordedStep { doc, sheet, sheet_name, selection, id: id.to_string(), params: cmd::journal_params(¶ms) });
|
||
}
|
||
self.push_journal(id, cmd::journal_params(¶ms));
|
||
}
|
||
// Inside an undo group the group owns the step. A command that ended a group open before
|
||
// it leaves the group its step and makes one of its own for what it changed after the end.
|
||
// A command that opened and closed its own groups makes one step of its own, which
|
||
// replaces the steps those groups made.
|
||
let epoch_changed = self.group_epoch != group_epoch;
|
||
let in_group_now = before.as_ref().is_some_and(|(uid, ..)| self.in_group(*uid));
|
||
let was_open = start.is_some_and(|(was_open, _)| was_open);
|
||
if spec.undoable
|
||
&& let Some((uid, wb, sel)) = before
|
||
&& let Some(d) = self.docs.iter_mut().find(|d| d.uid == uid)
|
||
&& !Arc::ptr_eq(&d.wb, &wb)
|
||
{
|
||
let label = spec.label.trim_end_matches('…').to_string();
|
||
if in_group_now {
|
||
// A group this command opened and left open (a debugger's start) takes the
|
||
// command's start as its own, so what the command changed before opening it is
|
||
// part of the group's step and not a step of its own.
|
||
if !was_open
|
||
&& let Some((_, len)) = start
|
||
&& let Some(g) = self.groups.iter_mut().filter(|g| g.doc == uid && g.id >= first_group).min_by_key(|g| g.id)
|
||
{
|
||
g.start = len;
|
||
g.wb = wb;
|
||
g.selection = sel;
|
||
}
|
||
} else if epoch_changed && was_open {
|
||
// The group it ended made its step; changes after the end, whether direct or by
|
||
// nested commands, are the command's own step from where the group ended.
|
||
if let Some(step) = self.group_step.as_ref().filter(|g| g.doc == uid)
|
||
&& (d.undo.len() > step.len || !Arc::ptr_eq(&step.after, &d.wb))
|
||
{
|
||
d.undo.truncate(step.len);
|
||
push_entry(&mut d.undo, label, step.after.clone(), &d.wb, step.selection.clone());
|
||
d.redo.clear();
|
||
}
|
||
} else {
|
||
let mut label = label;
|
||
if epoch_changed && let Some((_, len)) = start {
|
||
// A command whose only step is its group's keeps that name ("Run Macro: Totals").
|
||
// That is so only when the one entry the command added is a group's step from
|
||
// the command's own start to its own result: an entry a nested command made,
|
||
// a group step of an earlier command (undone since), or a group's step that
|
||
// the command edited past all name the step after the command instead.
|
||
if d.undo.len() == len + 1
|
||
&& let Some(last) = d.undo.last()
|
||
&& Arc::ptr_eq(&last.wb, &wb)
|
||
&& self.group_step.as_ref().is_some_and(|g| g.doc == uid && g.stepped && Arc::ptr_eq(&g.after, &d.wb))
|
||
{
|
||
label = last.label.clone();
|
||
}
|
||
d.undo.truncate(len);
|
||
}
|
||
push_entry(&mut d.undo, label, wb, &d.wb, sel);
|
||
d.redo.clear();
|
||
}
|
||
// Inside a group the redo history waits for the group: `group_end` clears it when the
|
||
// group becomes a step, and `group_rollback` puts it back as it was.
|
||
d.revision += 1;
|
||
}
|
||
// The history limit applies once the outermost command has collapsed its steps, so the
|
||
// lengths it compared stay true. Meanwhile the steps made inside it are bounded on their own.
|
||
if self.depth == 0 {
|
||
self.trim_history();
|
||
self.group_step = None;
|
||
} else if let Some(uid) = doc_uid {
|
||
self.bound_tail(uid);
|
||
}
|
||
result
|
||
}
|
||
|
||
/// Runs `f` as one undo step labelled `label` on the active document: whatever commands `f`
|
||
/// runs, one Undo brings back the workbook as it was before. If `f` fails, every change it made
|
||
/// is rolled back and its error is returned. Groups nest; the outermost one makes the step.
|
||
pub fn grouped<R>(&mut self, label: &str, f: impl FnOnce(&mut Session) -> Result<R>) -> Result<R> {
|
||
let token = self.group_begin(label)?;
|
||
let doc = token.doc();
|
||
// A panic in `f` rolls the group back before it goes on, so a caller that catches it
|
||
// (outside `execute`, which drops a command's groups itself) finds no group left open.
|
||
match std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| f(self))) {
|
||
Ok(Ok(r)) => match self.group_end(token) {
|
||
Ok(_) => Ok(r),
|
||
// `f` closed the group's document (`file.close`, or `file.open` taking the place of
|
||
// an untouched new workbook), and the group went with it: nothing is left to undo.
|
||
Err(_) if !self.docs.iter().any(|d| d.uid == doc) => Ok(r),
|
||
Err(e) => Err(e),
|
||
},
|
||
Ok(Err(e)) => {
|
||
// The error from `f` is the one to report. A rollback fails only when the group
|
||
// has already ended, and then there is nothing left to undo.
|
||
let _ = self.group_rollback(token);
|
||
Err(e)
|
||
}
|
||
Err(panic) => {
|
||
let _ = self.group_rollback(token);
|
||
std::panic::resume_unwind(panic)
|
||
}
|
||
}
|
||
}
|
||
|
||
/// Opens an undo group on the active document that can span several calls (for example a
|
||
/// debugger that runs one step per call). Until [`Session::group_end`] or
|
||
/// [`Session::group_rollback`], undoable commands on that document add no undo steps of their
|
||
/// own, and Undo and Redo are unavailable there.
|
||
pub fn group_begin(&mut self, label: &str) -> Result<GroupToken> {
|
||
let d = self.doc()?;
|
||
let g = OpenGroup {
|
||
id: self.next_group,
|
||
doc: d.uid,
|
||
label: label.trim_end_matches('…').to_string(),
|
||
start: d.undo.len(),
|
||
wb: d.wb.clone(),
|
||
selection: d.selection.clone(),
|
||
redo: d.redo.clone(),
|
||
};
|
||
let token = GroupToken { id: g.id, doc: g.doc };
|
||
self.next_group = self.next_group.saturating_add(1);
|
||
self.group_epoch = self.group_epoch.wrapping_add(1);
|
||
self.groups.push(g);
|
||
Ok(token)
|
||
}
|
||
|
||
/// Ends an undo group. If the workbook changed, the group becomes one undo step, unless it is
|
||
/// nested in another open group on the same document, which then owns the step. Groups opened
|
||
/// inside it and still open end with it. Returns whether the workbook changed.
|
||
pub fn group_end(&mut self, token: GroupToken) -> Result<bool> {
|
||
let g = self.take_group(&token)?;
|
||
let outer = self.in_group(g.doc);
|
||
let Some(d) = self.docs.iter_mut().find(|d| d.uid == g.doc) else { return Ok(false) };
|
||
// Steps pushed directly while the group was open fold into the group's step.
|
||
d.undo.truncate(g.start);
|
||
let changed = !Arc::ptr_eq(&d.wb, &g.wb);
|
||
if changed && !outer {
|
||
push_entry(&mut d.undo, g.label, g.wb, &d.wb, g.selection);
|
||
d.redo.clear();
|
||
d.revision += 1;
|
||
}
|
||
if !outer {
|
||
self.group_step =
|
||
Some(GroupStep { doc: g.doc, after: d.wb.clone(), selection: d.selection.clone(), len: d.undo.len(), stepped: changed });
|
||
}
|
||
// Inside a command, the outermost command applies the history limit when it finishes.
|
||
if self.depth == 0 {
|
||
self.trim_history();
|
||
}
|
||
Ok(changed)
|
||
}
|
||
|
||
/// Stops the running action on the document with uid `doc`: every undo group open on it is
|
||
/// rolled back as [`Session::group_rollback`] does, putting back the workbook, selection, undo
|
||
/// and redo history as they were when the outermost one began. Their tokens are then spent
|
||
/// (ending or rolling one back reports that it has already ended). Returns whether a group
|
||
/// was open. `automate.stopAction` runs it on the active document.
|
||
pub fn abort_groups(&mut self, doc: u64) -> bool {
|
||
let Some(id) = self.groups.iter().filter(|g| g.doc == doc).map(|g| g.id).min() else { return false };
|
||
// Rolling back the outermost group ends the ones opened inside it.
|
||
self.group_rollback(GroupToken { id, doc }).is_ok()
|
||
}
|
||
|
||
/// Rolls back every open undo group numbered `first` or later (the groups a failed command
|
||
/// opened), outermost first on each document.
|
||
fn rollback_groups_from(&mut self, first: u64) {
|
||
let opened: Vec<(u64, u64)> = self.groups.iter().filter(|g| g.id >= first).map(|g| (g.id, g.doc)).collect();
|
||
for (id, doc) in opened {
|
||
// A group inside one rolled back before it is already gone.
|
||
if self.groups.iter().any(|g| g.id == id) {
|
||
let _ = self.group_rollback(GroupToken { id, doc });
|
||
}
|
||
}
|
||
}
|
||
|
||
/// Bounds the undo steps pushed while a command runs (a script of many steps, a subtotal per
|
||
/// group): at most [`UNDO_LIMIT`] of them within [`UNDO_BYTES_LIMIT`], dropping the oldest.
|
||
/// Only steps after the latest mark go: a running command's start, an open group's start and
|
||
/// the end of the last group are positions the command or group collapses its steps by when
|
||
/// it finishes, so what is before them stays as it is until [`Session::trim_history`].
|
||
fn bound_tail(&mut self, uid: u64) {
|
||
let Some(d) = self.docs.iter_mut().find(|d| d.uid == uid) else { return };
|
||
let marks = self.marks.iter().filter(|(doc, _)| *doc == uid).map(|(_, len)| *len);
|
||
let groups = self.groups.iter().filter(|g| g.doc == uid).map(|g| g.start);
|
||
let step = self.group_step.as_ref().filter(|g| g.doc == uid).map(|g| g.len);
|
||
let mark = marks.chain(groups).chain(step).max().unwrap_or(0).min(d.undo.len());
|
||
let mut bytes = d.undo.iter().skip(mark).fold(0usize, |sum, e| sum.saturating_add(e.retained_bytes));
|
||
while d.undo.len() > mark + 1 && (d.undo.len() - mark > UNDO_LIMIT || bytes > UNDO_BYTES_LIMIT) {
|
||
bytes = bytes.saturating_sub(d.undo.remove(mark).retained_bytes);
|
||
}
|
||
}
|
||
|
||
/// Drops the oldest undo steps past [`UNDO_LIMIT`] or [`UNDO_BYTES_LIMIT`]. A document with
|
||
/// an open group waits for the group to end, because the group remembers where its steps start.
|
||
fn trim_history(&mut self) {
|
||
let groups = &self.groups;
|
||
for d in self.docs.iter_mut().filter(|d| !groups.iter().any(|g| g.doc == d.uid)) {
|
||
trim_to_budget(&mut d.undo, UNDO_BYTES_LIMIT);
|
||
}
|
||
}
|
||
|
||
/// Ends an undo group by putting back the workbook, selection, undo and redo history as they
|
||
/// were when it began.
|
||
pub fn group_rollback(&mut self, token: GroupToken) -> Result<()> {
|
||
let g = self.take_group(&token)?;
|
||
let Some(d) = self.docs.iter_mut().find(|d| d.uid == g.doc) else { return Ok(()) };
|
||
if !Arc::ptr_eq(&d.wb, &g.wb) {
|
||
d.wb = g.wb;
|
||
d.calc.rebuild(&d.wb);
|
||
}
|
||
d.selection = g.selection;
|
||
d.undo.truncate(g.start);
|
||
d.redo = g.redo;
|
||
d.revision += 1;
|
||
// The record of the last group step stays when the document is back exactly where that
|
||
// step left it (this group began there); otherwise the rollback is where the group ended.
|
||
let kept = self.group_step.as_ref().is_some_and(|st| st.doc == g.doc && st.len == g.start && Arc::ptr_eq(&st.after, &d.wb));
|
||
if !kept && !self.groups.iter().any(|o| o.doc == g.doc) {
|
||
self.group_step = Some(GroupStep { doc: g.doc, after: d.wb.clone(), selection: d.selection.clone(), len: g.start, stepped: false });
|
||
}
|
||
Ok(())
|
||
}
|
||
|
||
/// Starts recording top-level commands into an empty buffer, replacing any recording in
|
||
/// progress. Queries, failed commands and commands run by other commands are not recorded.
|
||
pub fn start_recording(&mut self) {
|
||
self.recorder = Some(record::Recorder::default());
|
||
}
|
||
|
||
/// Stops recording and returns what was recorded (`None` when nothing was recording).
|
||
pub fn stop_recording(&mut self) -> Option<record::Recorder> {
|
||
self.recorder.take()
|
||
}
|
||
|
||
/// Whether the recording buffer is collecting commands.
|
||
pub fn is_recording(&self) -> bool {
|
||
self.recorder.is_some()
|
||
}
|
||
|
||
/// How many commands are running: 0 between top-level commands, 1 inside one, 2 inside a
|
||
/// command run by a command, and so on.
|
||
pub fn depth(&self) -> u32 {
|
||
self.depth
|
||
}
|
||
|
||
/// Whether an undo group is open on the document with this uid.
|
||
pub fn in_group(&self, doc: u64) -> bool {
|
||
self.groups.iter().any(|g| g.doc == doc)
|
||
}
|
||
|
||
/// Removes the token's group and any group on the same document opened after it.
|
||
fn take_group(&mut self, token: &GroupToken) -> Result<OpenGroup> {
|
||
let ended = || EngineError::Other("That undo group has already ended.".into());
|
||
let at = self.groups.iter().position(|g| g.id == token.id).ok_or_else(ended)?;
|
||
let mut later = self.groups.split_off(at).into_iter();
|
||
let g = later.next().ok_or_else(ended)?;
|
||
self.groups.extend(later.filter(|o| o.doc != g.doc));
|
||
self.group_epoch = self.group_epoch.wrapping_add(1);
|
||
Ok(g)
|
||
}
|
||
|
||
pub fn run(&mut self, id: &str, params: Json) -> std::result::Result<Json, String> {
|
||
self.execute(id, params).map_err(|e| e.to_string())
|
||
}
|
||
|
||
pub fn take_ui_requests(&mut self) -> Vec<UiRequest> {
|
||
std::mem::take(&mut self.ui_requests)
|
||
}
|
||
|
||
/// Runs a command for a caller with no UI (MCP, CLI): queued UI requests are dropped, and a command that only
|
||
/// queued a file dialog because it got no file (`file.open`, `file.saveAs`, `file.save` on a workbook with no
|
||
/// file yet, `data.getData`) is an error instead of a silent success.
|
||
pub fn execute_headless(&mut self, id: &str, params: Json) -> Result<Json> {
|
||
let r = self.execute(id, params);
|
||
let requests = self.take_ui_requests();
|
||
let asked_for_file = requests.iter().any(|q| matches!(q, UiRequest::Dialog(name, _) if name == "open" || name == "saveAs"));
|
||
// A call that only opened a dialog is not recorded (see `execute`), so the recording
|
||
// has no step to take back here.
|
||
if r.is_ok() && asked_for_file {
|
||
let what = match id {
|
||
"file.open" => "`path` or `base64`",
|
||
"data.getData" | "data.fromTextCsv" => "`path` or `text`",
|
||
_ => "`path`",
|
||
};
|
||
let msg = format!("missing {what}: programmatic calls never open dialogs");
|
||
return Err(EngineError::BadParams { cmd: id.to_string(), msg });
|
||
}
|
||
r
|
||
}
|
||
}
|
||
|
||
/// Convenience: the active workbook's active sheet.
|
||
pub fn active_sheet(s: &Session) -> Option<&gridcraft_model::Sheet> {
|
||
s.active().and_then(|d| d.wb.active())
|
||
}
|
||
|
||
pub fn cell(r: u32, c: u32) -> CellRef {
|
||
CellRef::new(r, c)
|
||
}
|
||
|
||
#[cfg(test)]
|
||
mod tests;
|