azul_layout/managers/

changeset.rs

//! Text editing changeset system
//!
//! **STATUS:** The core types (`TextChangeset`, `TextOperation`, `TextOp*` structs) are
//! actively used by `window.rs`, `undo_redo.rs`, `event.rs`, and platform code. The
//! `create_*_changeset` free functions are not yet wired into event handling.
//!
//! ## Architecture
//!
//! This module implements a two-phase changeset system for all text editing operations:
//! 1. **Create changesets** (pre-callback): Analyze what would change, don't mutate yet
//! 2. **Apply changesets** (post-callback): Actually mutate state if !preventDefault
//!
//! This pattern enables:
//! - preventDefault support for ALL operations (not just text input)
//! - Undo/redo stack (record changesets before applying)
//! - Validation (check bounds, permissions before mutation)
//! - Inspection (user callbacks can see planned changes)

use azul_core::{
    dom::DomNodeId,
    selection::{OptionSelectionRange, SelectionRange},
    task::Instant,
    window::CursorPosition,
};
use azul_css::AzString;

use crate::managers::selection::ClipboardContent;

/// Unique identifier for a changeset (for undo/redo)
pub type ChangesetId = usize;

/// A text editing changeset that can be inspected before application
#[derive(Debug, Clone)]
#[repr(C)]
pub struct TextChangeset {
    /// Unique ID for undo/redo tracking
    pub id: ChangesetId,
    /// Target DOM node
    pub target: DomNodeId,
    /// The operation to perform
    pub operation: TextOperation,
    /// When this changeset was created
    pub timestamp: Instant,
}

/// Insert text at cursor position
#[derive(Debug, Clone)]
#[repr(C)]
pub struct TextOpInsertText {
    pub text: AzString,
    pub position: CursorPosition,
    pub new_cursor: CursorPosition,
}

/// Delete text in range
#[derive(Debug, Clone)]
#[repr(C)]
pub struct TextOpDeleteText {
    pub range: SelectionRange,
    pub deleted_text: AzString,
    pub new_cursor: CursorPosition,
}

/// Replace text in range with new text
#[derive(Debug, Clone)]
#[repr(C)]
pub struct TextOpReplaceText {
    pub range: SelectionRange,
    pub old_text: AzString,
    pub new_text: AzString,
    pub new_cursor: CursorPosition,
}

/// Set selection to new range
#[derive(Debug, Clone)]
#[repr(C)]
pub struct TextOpSetSelection {
    pub old_range: OptionSelectionRange,
    pub new_range: SelectionRange,
}

/// Extend selection in a direction
#[derive(Debug, Clone)]
#[repr(C)]
pub struct TextOpExtendSelection {
    pub old_range: SelectionRange,
    pub new_range: SelectionRange,
    pub direction: SelectionDirection,
}

/// Clear all selections
#[derive(Debug, Clone)]
#[repr(C)]
pub struct TextOpClearSelection {
    pub old_range: SelectionRange,
}

/// Move cursor to new position
#[derive(Debug, Clone)]
#[repr(C)]
pub struct TextOpMoveCursor {
    pub old_position: CursorPosition,
    pub new_position: CursorPosition,
    pub movement: CursorMovement,
}

/// Copy selection to clipboard (no text change)
#[derive(Debug, Clone)]
#[repr(C)]
pub struct TextOpCopy {
    pub range: SelectionRange,
    pub content: ClipboardContent,
}

/// Cut selection to clipboard (deletes text)
#[derive(Debug, Clone)]
#[repr(C)]
pub struct TextOpCut {
    pub range: SelectionRange,
    pub content: ClipboardContent,
    pub new_cursor: CursorPosition,
}

/// Paste from clipboard (inserts text)
#[derive(Debug, Clone)]
#[repr(C)]
pub struct TextOpPaste {
    pub content: ClipboardContent,
    pub position: CursorPosition,
    pub new_cursor: CursorPosition,
}

/// Select all text in node
#[derive(Debug, Clone)]
#[repr(C)]
pub struct TextOpSelectAll {
    pub old_range: OptionSelectionRange,
    pub new_range: SelectionRange,
}

/// Text editing operation (what will change)
#[derive(Debug, Clone)]
#[repr(C, u8)]
pub enum TextOperation {
    /// Insert text at cursor position
    InsertText(TextOpInsertText),
    /// Delete text in range
    DeleteText(TextOpDeleteText),
    /// Replace text in range with new text
    ReplaceText(TextOpReplaceText),
    /// Set selection to new range
    SetSelection(TextOpSetSelection),
    /// Extend selection in a direction
    ExtendSelection(TextOpExtendSelection),
    /// Clear all selections
    ClearSelection(TextOpClearSelection),
    /// Move cursor to new position
    MoveCursor(TextOpMoveCursor),
    /// Copy selection to clipboard (no text change)
    Copy(TextOpCopy),
    /// Cut selection to clipboard (deletes text)
    Cut(TextOpCut),
    /// Paste from clipboard (inserts text)
    Paste(TextOpPaste),
    /// Select all text in node
    SelectAll(TextOpSelectAll),
}

/// Re-export from events module
pub use azul_core::events::SelectionDirection;

/// Type of cursor movement
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[repr(C)]
pub enum CursorMovement {
    /// Move left one character
    Left,
    /// Move right one character
    Right,
    /// Move up one line
    Up,
    /// Move down one line
    Down,
    /// Jump to previous word boundary
    WordLeft,
    /// Jump to next word boundary
    WordRight,
    /// Jump to start of line
    LineStart,
    /// Jump to end of line
    LineEnd,
    /// Jump to start of document
    DocumentStart,
    /// Jump to end of document
    DocumentEnd,
    /// Absolute position (not relative)
    Absolute,
}

impl TextChangeset {
    /// Create a new changeset with unique ID
    pub fn new(target: DomNodeId, operation: TextOperation, timestamp: Instant) -> Self {
        use std::sync::atomic::{AtomicUsize, Ordering};
        static CHANGESET_ID_COUNTER: AtomicUsize = AtomicUsize::new(0);

        Self {
            id: CHANGESET_ID_COUNTER.fetch_add(1, Ordering::Relaxed),
            target,
            operation,
            timestamp,
        }
    }

    /// Check if this changeset actually mutates text (vs just selection/cursor)
    pub fn mutates_text(&self) -> bool {
        matches!(
            self.operation,
            TextOperation::InsertText { .. }
                | TextOperation::DeleteText { .. }
                | TextOperation::ReplaceText { .. }
                | TextOperation::Cut { .. }
                | TextOperation::Paste { .. }
        )
    }

    /// Check if this changeset changes selection (including cursor moves)
    pub fn changes_selection(&self) -> bool {
        matches!(
            self.operation,
            TextOperation::SetSelection { .. }
                | TextOperation::ExtendSelection { .. }
                | TextOperation::ClearSelection { .. }
                | TextOperation::MoveCursor { .. }
                | TextOperation::SelectAll { .. }
        )
    }

    /// Check if this changeset involves clipboard
    pub fn uses_clipboard(&self) -> bool {
        matches!(
            self.operation,
            TextOperation::Copy { .. } | TextOperation::Cut { .. } | TextOperation::Paste { .. }
        )
    }

    /// Get the target cursor position after this changeset is applied
    pub fn resulting_cursor_position(&self) -> Option<CursorPosition> {
        match &self.operation {
            TextOperation::InsertText(op) => Some(op.new_cursor),
            TextOperation::DeleteText(op) => Some(op.new_cursor),
            TextOperation::ReplaceText(op) => Some(op.new_cursor),
            TextOperation::Cut(op) => Some(op.new_cursor),
            TextOperation::Paste(op) => Some(op.new_cursor),
            TextOperation::MoveCursor(op) => Some(op.new_position),
            _ => None,
        }
    }

    /// Get the target selection range after this changeset is applied
    pub fn resulting_selection_range(&self) -> Option<SelectionRange> {
        match &self.operation {
            TextOperation::SetSelection(op) => Some(op.new_range),
            TextOperation::ExtendSelection(op) => Some(op.new_range),
            TextOperation::SelectAll(op) => Some(op.new_range),
            _ => None,
        }
    }
}

/// Creates a copy changeset from the current selection.
///
/// Extracts the selected text content and creates a `TextChangeset` with a `Copy`
/// operation. Returns `None` if there is no selection or no content to copy.
pub fn create_copy_changeset(
    target: DomNodeId,
    timestamp: Instant,
    layout_window: &crate::window::LayoutWindow,
) -> Option<TextChangeset> {
    // Extract clipboard content from current selection
    let dom_id = &target.dom;
    let content = layout_window.get_selected_content_for_clipboard(dom_id)?;

    // Get selection range for changeset
    let ranges: Vec<azul_core::selection::SelectionRange> = layout_window.text_edit_manager.multi_cursor.as_ref()
        .map(|mc| mc.selections.iter().filter_map(|s| match &s.selection {
            azul_core::selection::Selection::Range(r) => Some(*r),
            _ => None,
        }).collect()).unwrap_or_default();
    let range = ranges.first()?;

    Some(TextChangeset::new(
        target,
        TextOperation::Copy(TextOpCopy {
            range: *range,
            content,
        }),
        timestamp,
    ))
}

/// Creates a cut changeset from the current selection.
///
/// Extracts the selected text content and creates a `TextChangeset` with a `Cut`
/// operation that will delete the selected text after copying it to clipboard.
/// Returns `None` if there is no selection or no content to cut.
pub fn create_cut_changeset(
    target: DomNodeId,
    timestamp: Instant,
    layout_window: &crate::window::LayoutWindow,
) -> Option<TextChangeset> {
    // Extract clipboard content from current selection
    let dom_id = &target.dom;
    let content = layout_window.get_selected_content_for_clipboard(dom_id)?;

    // Get selection range for changeset
    let ranges: Vec<azul_core::selection::SelectionRange> = layout_window.text_edit_manager.multi_cursor.as_ref()
        .map(|mc| mc.selections.iter().filter_map(|s| match &s.selection {
            azul_core::selection::Selection::Range(r) => Some(*r),
            _ => None,
        }).collect()).unwrap_or_default();
    let range = ranges.first()?;

    // The logical cursor will be at the start of the deleted range
    // SelectionManager will map this to physical coordinates
    let new_cursor_position = azul_core::window::CursorPosition::Uninitialized;

    Some(TextChangeset::new(
        target,
        TextOperation::Cut(TextOpCut {
            range: *range,
            content,
            new_cursor: new_cursor_position,
        }),
        timestamp,
    ))
}

/// Creates a paste changeset at the current cursor position.
///
/// Note: The actual clipboard content must be provided by the caller (typically
/// `event_v2.rs`), as clipboard access is platform-specific and not available
/// in the layout engine. This function currently returns `None` and paste
/// operations are initiated from `event_v2.rs` with pre-read clipboard content.
pub fn create_paste_changeset(
    target: DomNodeId,
    timestamp: Instant,
    layout_window: &crate::window::LayoutWindow,
) -> Option<TextChangeset> {
    // Paste is handled by event_v2.rs with clipboard content parameter.
    // This stub exists for API consistency with other changeset creators.
    None
}

/// Creates a select-all changeset for the target node.
///
/// Selects all text content in the target node from the beginning to the end.
/// Returns `None` if the node has no text content.
pub fn create_select_all_changeset(
    target: DomNodeId,
    timestamp: Instant,
    layout_window: &crate::window::LayoutWindow,
) -> Option<TextChangeset> {
    use azul_core::selection::{CursorAffinity, GraphemeClusterId, TextCursor};

    let dom_id = &target.dom;
    let node_id = target.node.into_crate_internal()?;

    // Get current selection (if any) for undo
    let old_range: Option<azul_core::selection::SelectionRange> = layout_window.text_edit_manager.multi_cursor.as_ref()
        .and_then(|mc| mc.selections.iter().find_map(|s| match &s.selection {
            azul_core::selection::Selection::Range(r) => Some(*r),
            _ => None,
        }));

    // Get the text content to determine end position
    let content = layout_window.get_text_before_textinput(*dom_id, node_id);
    let text = layout_window.extract_text_from_inline_content(&content);

    // Create selection range from start to end of text
    let start_cursor = TextCursor {
        cluster_id: GraphemeClusterId {
            source_run: 0,
            start_byte_in_run: 0,
        },
        affinity: CursorAffinity::Leading,
    };

    let end_cursor = TextCursor {
        cluster_id: GraphemeClusterId {
            source_run: 0,
            start_byte_in_run: text.len() as u32,
        },
        affinity: CursorAffinity::Leading,
    };

    let new_range = azul_core::selection::SelectionRange {
        start: start_cursor,
        end: end_cursor,
    };

    Some(TextChangeset::new(
        target,
        TextOperation::SelectAll(TextOpSelectAll {
            old_range: old_range.into(),
            new_range,
        }),
        timestamp,
    ))
}

/// Creates a delete changeset for the current selection or single character.
///
/// If there is an active selection, deletes the entire selection.
/// If there is only a cursor (no selection), deletes a single character:
/// - `forward = true` (Delete key): deletes the character after the cursor
/// - `forward = false` (Backspace): deletes the character before the cursor
///
/// Returns `None` if there is nothing to delete (e.g., cursor at document boundary).
pub fn create_delete_selection_changeset(
    target: DomNodeId,
    forward: bool,
    timestamp: Instant,
    layout_window: &crate::window::LayoutWindow,
) -> Option<TextChangeset> {
    use azul_core::selection::{CursorAffinity, GraphemeClusterId, TextCursor};

    let dom_id = &target.dom;
    let node_id = target.node.into_crate_internal()?;

    // Get current selection/cursor
    let ranges: Vec<azul_core::selection::SelectionRange> = layout_window.text_edit_manager.multi_cursor.as_ref()
        .map(|mc| mc.selections.iter().filter_map(|s| match &s.selection {
            azul_core::selection::Selection::Range(r) => Some(*r),
            _ => None,
        }).collect()).unwrap_or_default();
    let cursor = layout_window.text_edit_manager.get_primary_cursor();

    // Determine what to delete
    let (delete_range, deleted_text) = if let Some(range) = ranges.first() {
        // Selection exists - delete the selection
        let content = layout_window.get_text_before_textinput(*dom_id, node_id);
        let text = layout_window.extract_text_from_inline_content(&content);

        // Extract the text in the range
        // For now, simplified: delete entire selection
        // TODO: Actually extract text between range.start and range.end
        let deleted = String::new(); // Placeholder

        (*range, deleted)
    } else if let Some(cursor_pos) = cursor {
        // No selection - delete one character
        let content = layout_window.get_text_before_textinput(*dom_id, node_id);
        let text = layout_window.extract_text_from_inline_content(&content);

        let byte_pos = cursor_pos.cluster_id.start_byte_in_run as usize;

        let (range, deleted) = if forward {
            // Delete key - delete character after cursor
            if byte_pos >= text.len() {
                return None; // At end, nothing to delete
            }
            // Delete one character forward
            let end_pos = (byte_pos + 1).min(text.len());
            let deleted = text[byte_pos..end_pos].to_string();

            let range = azul_core::selection::SelectionRange {
                start: cursor_pos,
                end: TextCursor {
                    cluster_id: GraphemeClusterId {
                        source_run: cursor_pos.cluster_id.source_run,
                        start_byte_in_run: end_pos as u32,
                    },
                    affinity: CursorAffinity::Leading,
                },
            };
            (range, deleted)
        } else {
            // Backspace - delete character before cursor
            if byte_pos == 0 {
                return None; // At start, nothing to delete
            }
            // Delete one character backward
            let start_pos = byte_pos.saturating_sub(1);
            let deleted = text[start_pos..byte_pos].to_string();

            let range = azul_core::selection::SelectionRange {
                start: TextCursor {
                    cluster_id: GraphemeClusterId {
                        source_run: cursor_pos.cluster_id.source_run,
                        start_byte_in_run: start_pos as u32,
                    },
                    affinity: CursorAffinity::Leading,
                },
                end: cursor_pos,
            };
            (range, deleted)
        };

        (range, deleted)
    } else {
        return None; // No cursor or selection
    };

    // New cursor position after deletion (at start of deleted range)
    let new_cursor = azul_core::window::CursorPosition::Uninitialized;

    Some(TextChangeset::new(
        target,
        TextOperation::DeleteText(TextOpDeleteText {
            range: delete_range,
            deleted_text: deleted_text.into(),
            new_cursor,
        }),
        timestamp,
    ))
}