figcraft/crates/engine/src/prefs.rs

use super::{Arc, BTreeMap, Deserialize, Document, NodeId, Serialize, Value, cmd, live, online, plugins};

/// The smallest and largest interface size, relative to the system's display scale (1.0 is the
/// system's own size).
pub const UI_SCALE_MIN: f64 = 0.75;

pub const UI_SCALE_MAX: f64 = 3.0;

/// `scale` kept between [`UI_SCALE_MIN`] and [`UI_SCALE_MAX`]; not a finite number: `None`.
pub fn clamp_ui_scale(scale: f64) -> Option<f64> {
    scale.is_finite().then(|| scale.clamp(UI_SCALE_MIN, UI_SCALE_MAX))
}

/// Reads the saved interface size. Anything but a number reads as 1 (the system's size) and a
/// number out of range is clamped, so a settings file edited by hand never costs the other
/// preferences.
fn read_ui_scale<'de, D: serde::Deserializer<'de>>(d: D) -> std::result::Result<f64, D::Error> {
    Ok(Value::deserialize(d)?.as_f64().and_then(clamp_ui_scale).unwrap_or(1.0))
}

/// App-wide preferences that commands read (nudge amounts, behaviours).
#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
#[serde(default)]
pub struct Prefs {
    pub nudge_small: f64,
    pub nudge_big: f64,
    pub keep_tool: bool,
    pub rename_duplicates: bool,
    pub highlight_on_hover: bool,
    pub number_keys_opacity: bool,
    pub show_dimensions: bool,
    /// "system" by default; an explicit "light" or "dark" choice stays saved.
    pub theme: String,
    /// The widths of the main window's left and right panels (the interface keeps them within its
    /// limits; other windows have their own while they are open).
    pub panel_widths: (f32, f32),
    /// The height asked for the main window's pages list, dragged at its lower edge (`None`: a
    /// share of the panel; the interface keeps it within its limits).
    pub pages_height: Option<f32>,
    /// The interface language: a language code ("en", "es", "pt-BR") or "system" (the OS or browser
    /// language). Languages without a catalog show English.
    pub language: String,
    /// The name comments are signed with (and whose comments count as yours).
    pub user_name: String,
    /// Reduce motion: the interface's own animations are off (the system's setting turns them off
    /// too). Prototype transitions still play.
    pub reduce_motion: bool,
    /// How large the whole interface is drawn, relative to the system's display scale: 1.0 is the
    /// system's own size, 1.25 a quarter larger (kept between [`UI_SCALE_MIN`] and
    /// [`UI_SCALE_MAX`]). The canvas zoom is separate.
    #[serde(deserialize_with = "read_ui_scale")]
    pub ui_scale: f64,
    /// Files that have a path are saved by themselves a few seconds after they change (the app's
    /// timer; off: only File ▸ Save writes them).
    pub auto_save: bool,
    /// The desktop app starts on the Home screen instead of in a new file.
    pub start_on_home: bool,
    /// `figcraft://` invite links open this app (`collab.registerLinks`); `None`: on for installed
    /// builds, off for development builds.
    pub invite_links: Option<bool>,
    /// Installed plugins (Plugins menu), in menu order.
    #[serde(serialize_with = "plugins::persisted")]
    pub plugins: Vec<plugins::InstalledPlugin>,
    /// Plugins' own settings (`setting_set`), by plugin id, then key: JSON values, capped per
    /// plugin.
    #[serde(skip_serializing_if = "BTreeMap::is_empty")]
    pub plugin_settings: BTreeMap<String, BTreeMap<String, Value>>,
    /// The plugin directory browsed last (`ws://host:port/`, never with a key).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub plugin_directory: Option<String>,
    /// The server files are shared through online (Share ▸ Online, join codes; Publish to server
    /// suggests it too): `wss://host/`, never with a key. [`live::DEFAULT_SERVER`] unless the user
    /// chose another; empty: online sharing is off (saved as empty, so it stays off).
    pub publish_server: String,
    /// Recently opened or saved files, newest first (File ▸ Open recent; at most
    /// [`cmd::file::MAX_RECENT`]).
    pub recent_files: Vec<String>,
    /// The files you put on a server without its key, with their owner tokens (passwords: see
    /// [`online`]), most recently opened first, at most [`online::MAX_ONLINE_FILES`].
    #[serde(skip_serializing_if = "Vec::is_empty", deserialize_with = "online::read")]
    pub online_files: Vec<online::OnlineFile>,
    /// The Getting started tips on the home screen were closed (Help ▸ Getting started shows them
    /// again).
    pub getting_started_dismissed: bool,
    /// A prototype's Open link — to a website or to the mail app — that the viewer's own click,
    /// press, drag or key fired opens without first telling them that it leaves the prototype
    /// (the notice's "Don't show this again"; `proto.linkNotice` shows it again). A link a delay
    /// or the pointer passing over a layer fired still shows the notice (#1096).
    pub link_notice_skipped: bool,
    /// How each home screen section shows its files, by section id (`"recents"`): `"grid"` (cards
    /// with the picture each file carries) or `"list"` (a table). Missing: the grid.
    #[serde(skip_serializing_if = "BTreeMap::is_empty")]
    pub home_views: BTreeMap<String, String>,
    /// What the home screen's recent files are ordered by: `"modified"`, `"name"` or `"created"`.
    pub home_sort: String,
    /// Which way: `"desc"` (newest first, Z to A) or `"asc"`.
    pub home_order: String,
    /// The View menu's toggles turned on or off (rulers, pixel grid, snapping…), by command id:
    /// files opened or made later start with them. Missing: the toggle's default.
    #[serde(skip_serializing_if = "BTreeMap::is_empty")]
    pub view: BTreeMap<String, bool>,
    /// Recently run actions (the Actions palette's Recents), newest first, at most
    /// [`MAX_RECENT_ACTIONS`]. Entries are `command:<id>`, `plugin:<plugin>/<command>` or
    /// `widget:<plugin>`.
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub recent_actions: Vec<String>,
}

/// Recently run actions kept for the Actions palette (newest first).
pub const MAX_RECENT_ACTIONS: usize = 5;

impl Default for Prefs {
    fn default() -> Self {
        Self {
            nudge_small: 1.0,
            nudge_big: 10.0,
            keep_tool: false,
            rename_duplicates: false,
            highlight_on_hover: true,
            number_keys_opacity: true,
            show_dimensions: true,
            theme: "system".into(),
            panel_widths: (240.0, 240.0),
            pages_height: None,
            language: "system".into(),
            user_name: cmd::comment::DEFAULT_AUTHOR.into(),
            reduce_motion: false,
            ui_scale: 1.0,
            auto_save: false,
            start_on_home: false,
            invite_links: None,
            plugins: Vec::new(),
            plugin_settings: BTreeMap::new(),
            plugin_directory: None,
            publish_server: live::DEFAULT_SERVER.into(),
            recent_files: Vec::new(),
            online_files: Vec::new(),
            getting_started_dismissed: false,
            link_notice_skipped: false,
            home_views: BTreeMap::new(),
            home_sort: "modified".into(),
            home_order: "desc".into(),
            view: BTreeMap::new(),
            recent_actions: Vec::new(),
        }
    }
}

/// A request from a command to the UI (open a dialog or panel, show a message). Programmatic
/// callers ignore them.
#[derive(Clone, Debug, PartialEq, Serialize)]
pub struct UiRequest {
    pub kind: String,
    pub data: Value,
}

/// Clipboard contents (internal; the UI mirrors to the system clipboard).
#[derive(Clone, Debug, Default)]
pub struct Clipboard {
    /// Copied subtrees: (root, nodes) in z-order.
    pub nodes: Vec<(NodeId, Vec<figcraft_doc::Node>)>,
    pub images: std::collections::BTreeMap<String, figcraft_doc::ImageData>,
    /// Copied properties (Copy properties / Paste properties).
    pub props: Option<Value>,
    /// A copied fill or stroke row (`fill.copy`, `stroke.copy`): whether it's a fill, and the paint.
    pub paint: Option<(bool, figcraft_color::Paint)>,
    /// The stroke settings (`weight`, alignment, sides…) copied with a stroke's paint.
    pub stroke: Option<figcraft_doc::StrokeProps>,
    /// The image data the copied paint names, carried so a paste into another file has it.
    pub paint_images: std::collections::BTreeMap<String, figcraft_doc::ImageData>,
    /// The file the copied paint came from: a pattern's node id only means anything there.
    pub paint_source_doc: u64,
    /// A copied effect row (`effect.copy`).
    pub effect: Option<figcraft_doc::Effect>,
    /// The page-space bounds of the copied selection.
    pub bounds: Option<figcraft_geom::Rect>,
    pub source_doc: u64,
    /// Copied component/set roots, excluding cuts and originals discarded by undo (ids are reused).
    pub copied_components: std::collections::BTreeSet<NodeId>,
    /// Monotonic generation of the copied layers (contents, images, bounds and source). A UI
    /// clipboard mirror records it, so a later programmatic copy that never touched the system
    /// clipboard is not mistaken for the user's own copy just because the text still matches.
    pub layers_generation: u64,
    /// The document copied from (pastes into other files follow its mains) and its file path.
    pub source: Option<Arc<Document>>,
    pub source_path: Option<String>,
}