rust_widgets 2.9.3

// SPDX-FileCopyrightText: Copyright (c) 2026 Mike Li/Mikewolfli/Wei Li(mikewolfli@163.com)
// SPDX-License-Identifier: MIT

//! CodeEditor widget — a self-contained, Zed-class source code editor model.
//!
//! # Scope boundary
//!
//! This widget deliberately implements the *whole editor surface that a single
//! widget can own*: text storage on a line index, a cursor with anchor/selection
//! (including multiple carets), an undo/redo history, viewport scrolling (line
//! and column axes), soft line wrapping, folding, multi-buffer tabs, bracket
//! matching, indent guides, in-editor find/replace with a visible find bar,
//! autocomplete, context menus, auto-pairing, line commands, configurable
//! tabs/spaces, whitespace/ruler overlays, and the input plumbing (keyboard,
//! IME, mouse, touch, wheel) for all of it.
//!
//! Everything that a real editor product would load as a *plugin crate* is
//! intentionally **not** in here, because it cannot be owned by one widget:
//!
//! | Concern | Where it belongs |
//! |---------|------------------|
//! | Tree-sitter grammar / real incremental parsing | `plugin: syntax` crate |
//! | Syntax highlight themes & semantic tokens | `plugin: theme` crate |
//! | LSP client (completion, hover, diagnostics, goto) | `plugin: lsp` crate |
//! | DAP / terminal / language REPLs | `plugin: debug` crate |
//! | Multiplayer (CRDT), collaboration | `plugin: collab` crate |
//! | File-system, workspace, VCS integration | host application |
//!
//! The widget therefore exposes *extension hooks* rather than pretending to be
//! those systems: [`SyntaxHighlighter`] (pluggable tokenizer, defaulting to a
//! keyword/string/comment/`fn`-name lexer), [`CompletionSource`] (pluggable
//! completion-provider, defaulting to document identifiers), and
//! [`DiagnosticMarker`] (host/LSP-pushed inline diagnostics).
//!
//! # Host integration: the clipboard
//!
//! The context menu's `paste` row reflects whether the clipboard holds text, and
//! that fact is **cached**, not read when the menu opens
//! ([`CodeEditor::clipboard_has_text`]). The platform clipboard is a machine-global
//! resource whose handle is exclusive, so a read can block or fail and would let a
//! transient failure disable a row for a reason the user cannot see. A host should
//! call [`CodeEditor::set_clipboard_has_text`] from the platform's clipboard-change
//! notification (or [`CodeEditor::invalidate_clipboard_has_text`] on focus regain);
//! with no host wiring the editor probes once and caches the answer.
//!
//! # Module layout
//!
//! The implementation is split into focused submodules; this file only declares
//! them and re-exports their public interface (principle.md #8). The submodules
//! are private, so their names are written as code spans rather than intra-doc
//! links (a link to a private item is a rustdoc error).
//!
//! | Module | Responsibility |
//! |--------|----------------|
//! | `types` | Positions, cursor, markers, tokens, palette, config, find/completion/menu state |
//! | `syntax` | Built-in lexer, [`LanguageId`], [`SyntaxHighlighter`] plugin seam |
//! | `buffer` | Line-indexed document model, tabs, folds, splice primitive |
//! | `coords` | Document ↔ screen coordinate map (`B3`/`B4`) |
//! | `grid` | Char index ↔ grid column ↔ byte offset (wide chars, tabs) |
//! | `multicursor` | Multiple carets: add/merge, occurrence selection, edit projection |
//! | `pairs` | Auto-pairing, bracket/quote skip-over and smart backspace |
//! | `editor` | The [`CodeEditor`] widget: state, construction, shared helpers; commands in `editor/*` |
//! | `input` | Keyboard/IME/pointer/wheel translation layer |
//! | `render` | The `Draw` entry point, metrics and hit-testing; paint helpers in `render/*` |
//! | `tests` | Behavioural test-suite |
//!
//! # Rust design notes (principle.md #28..#34)
//!
//! * No trait objects on the hot path: highlighting is a plain `enum` dispatch
//!   plus a tiny [`SyntaxHighlighter`] trait for the pluggable case.
//! * All state is owned; no manual allocation, no `unsafe`.
//! * Configuration is a Builder-style type ([`CodeEditorConfig`]) rather than a
//!   varargs setter cluster.
//! * Invalid configuration is rejected through `Result`, never silently ignored.
//!
//! # Device profiles
//!
//! Touch targets (find-bar buttons, completion rows, context-menu rows,
//! scrollbar hit area) are all >= 28 logical pixels so tablet/mobile remain
//! usable; triple-tap selects a line for touch devices while triple-click keeps
//! the desktop behaviour.

mod buffer;
mod coords;
mod editor;
mod grid;
mod input;
mod multicursor;
mod pairs;
mod palette;
mod range_command;
mod render;
mod syntax;
mod types;

#[cfg(test)]
mod tests;

#[cfg(test)]
mod tests_batch1;

#[cfg(test)]
mod tests_batch4;

#[cfg(test)]
mod tests_batch5;

#[cfg(test)]
mod tests_batch6;

#[cfg(test)]
mod tests_batch7;

pub use editor::CodeEditor;
pub use multicursor::MultiCursor;
pub use palette::{CommandPalette, PaletteEntry};
pub use syntax::{BuiltinHighlighter, LanguageId, LineState, SyntaxHighlighter};
pub use types::{
    CaretStyle, CodeEditorConfig, CompletionItem, CompletionSource, CompletionState,
    ContextMenuState, Cursor, DiagnosticMarker, DocumentCompletions, DocumentScale,
    DocumentWordIndex, EditRejection, EditorBuffer, ExtraSelection, FindBarAction, FindState,
    FoldRegion, LineEnding, MarkerSeverity, MenuItem, ReadOnlySpan, SearchMatch, SearchOptions,
    SyntaxPalette, TextChange, TextPosition, TokenKind, TokenSpan, ViewportSnapshot, VisualLine,
    DEFAULT_FONT_FAMILY, DEFAULT_FONT_SIZE, DEFAULT_LINE_HEIGHT_RATIO, DEFAULT_TAB_WIDTH,
    MAX_COMPLETIONS, MIN_TOUCH_TARGET, SCALE_REDUCED_LINES, SCALE_VIEW_ONLY_LINES,
};

/// The `markers` property's record schema, re-exported so the capability table can name it
/// (the `types` module itself stays private).
pub(crate) use types::DIAGNOSTIC_MARKER_SCHEMA;