Lutra/crates/engine/src/state.rs
danny fc8ae6c2e3 M4.4: Git gutter change markers and status colours in tree and tabs
- git.lineChanges {id} -> {ranges: [{kind, startLine, endLine}], version}:
  the buffer against its index blob, line diff with similar (Myers +
  Replace, no Compact) off the lock, CRLF-safe; index texts cached per
  path and dropped on gitChanged (State::emit -> git_lines::observe)
- editor gutter markers for added, modified and deleted lines, queried
  150 ms after edits, on show and on gitChanged, mapped through edits
- vcsStatus store (git.status on projectOpened and gitChanged, no
  polling) colouring file names in the project tree and editor tabs with
  the --lt-vcs-* tokens; contrast also checked on the active tab
- tests: unit and property tests, real-repo engine tests, Vitest
- docs: architecture, parity, gaps, roadmap, ui-parity, ROADMAP

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-25 17:40:30 +01:00

94 lines
3.4 KiB
Rust

//! Workspace state that commands read and change.
use std::collections::{BTreeMap, BTreeSet};
use serde_json::{Map, Value};
use crate::buffers::Buffers;
use crate::cmd::ui::UiCommand;
use crate::journal::Journal;
use crate::settings::Settings;
use crate::workspace::Workspace;
use crate::{EngineConfig, Event, NotificationLevel};
/// Everything the engine knows about the running session.
#[derive(Debug, Default)]
pub struct State {
/// Number of commands that ran to completion, successful or not.
pub commands_run: u64,
/// The open project, if any.
pub project: Option<Workspace>,
/// Open buffers. Empty whenever no project is open.
pub buffers: Buffers,
/// Settings, saved to the config directory when the engine has one.
pub settings: Settings,
/// Whether the OS prefers a dark theme, as the frontend reported it with
/// `theme.systemPreference`; `None` until then.
pub system_dark: Option<bool>,
/// Where the engine stores its files; `None` for an engine without
/// persistence ([`crate::Engine::new`]).
pub config: Option<EngineConfig>,
/// The crash-recovery journal of the open project; `None` without a
/// project or without persistence.
pub journal: Option<Journal>,
/// Ids of the engine's own commands, which UI commands may not take.
pub engine_commands: BTreeSet<&'static str>,
/// UI commands the frontend registered (`ui.registerCommands`), by id.
pub ui_commands: BTreeMap<String, UiCommand>,
/// Running searches (`search.find`).
pub searches: crate::cmd::search::Searches,
/// The symbol index of the open project (`index.status`, `goto.*`).
pub index: crate::cmd::goto::IndexState,
/// Syntax trees and outlines of open PHP buffers (`syntax.outline`).
pub syntax: crate::cmd::syntax::Syntax,
/// PHP and Phpactor (`toolchain.status`).
pub toolchain: crate::cmd::toolchain::Toolchain,
/// Open integrated terminals (`terminal.*`).
pub terminals: crate::cmd::terminal::Terminals,
/// The language server session and its diagnostics (M3.3).
pub lsp: crate::lsp::Lsp,
/// git and the project's repository (`git.*`, M4.1).
pub git: crate::cmd::git::GitState,
/// Cached index texts for `git.lineChanges` (M4.4).
pub git_lines: crate::cmd::git_lines::GitLines,
/// Number of notifications emitted, for their ids.
notifications: u64,
/// Events queued for the host, oldest first.
events: Vec<Event>,
}
impl State {
/// Queues an event for the host.
pub fn emit(&mut self, event: Event) {
crate::cmd::git_lines::observe(&mut self.git_lines, &event);
self.events.push(event);
}
/// Queues an [`Event::Notification`] with a fresh id (`n1`, `n2`…).
pub fn notify(
&mut self,
level: NotificationLevel,
message_key: Option<&str>,
message: Option<String>,
params: Option<Map<String, Value>>,
) {
self.notifications = self.notifications.saturating_add(1);
self.emit(Event::Notification {
id: format!("n{}", self.notifications),
level,
message_key: message_key.map(str::to_string),
message,
params,
});
}
/// Takes the queued events, oldest first.
pub fn take_events(&mut self) -> Vec<Event> {
std::mem::take(&mut self.events)
}
/// Whether a project is open.
pub fn has_project(&self) -> bool {
self.project.is_some()
}
}