use crate::messages::debug::utility_types::MessageLoggingVerbosity; use crate::messages::dialog::DialogMessageData; use crate::messages::portfolio::document::node_graph::document_node_definitions; use crate::messages::prelude::*; #[derive(Debug, Default)] pub struct Dispatcher { buffered_queue: Option>>, message_queues: Vec>, pub responses: Vec, pub message_handlers: DispatcherMessageHandlers, } #[derive(Debug, Default)] pub struct DispatcherMessageHandlers { broadcast_message_handler: BroadcastMessageHandler, debug_message_handler: DebugMessageHandler, dialog_message_handler: DialogMessageHandler, globals_message_handler: GlobalsMessageHandler, input_preprocessor_message_handler: InputPreprocessorMessageHandler, key_mapping_message_handler: KeyMappingMessageHandler, layout_message_handler: LayoutMessageHandler, pub portfolio_message_handler: PortfolioMessageHandler, preferences_message_handler: PreferencesMessageHandler, tool_message_handler: ToolMessageHandler, workspace_message_handler: WorkspaceMessageHandler, } /// For optimization, these are messages guaranteed to be redundant when repeated. /// The last occurrence of the message in the message queue is sufficient to ensure correct behavior. /// In addition, these messages do not change any state in the backend (aside from caches). const SIDE_EFFECT_FREE_MESSAGES: &[MessageDiscriminant] = &[ MessageDiscriminant::Portfolio(PortfolioMessageDiscriminant::Document(DocumentMessageDiscriminant::NodeGraph(NodeGraphMessageDiscriminant::SendGraph))), MessageDiscriminant::Portfolio(PortfolioMessageDiscriminant::Document(DocumentMessageDiscriminant::PropertiesPanel( PropertiesPanelMessageDiscriminant::Refresh, ))), MessageDiscriminant::Portfolio(PortfolioMessageDiscriminant::Document(DocumentMessageDiscriminant::DocumentStructureChanged)), MessageDiscriminant::Portfolio(PortfolioMessageDiscriminant::Document(DocumentMessageDiscriminant::Overlays(OverlaysMessageDiscriminant::Draw))), MessageDiscriminant::Portfolio(PortfolioMessageDiscriminant::Document(DocumentMessageDiscriminant::RenderRulers)), MessageDiscriminant::Portfolio(PortfolioMessageDiscriminant::Document(DocumentMessageDiscriminant::RenderScrollbars)), MessageDiscriminant::Frontend(FrontendMessageDiscriminant::UpdateDocumentLayerStructure), MessageDiscriminant::Frontend(FrontendMessageDiscriminant::TriggerFontLoad), ]; const DEBUG_MESSAGE_BLOCK_LIST: &[MessageDiscriminant] = &[ MessageDiscriminant::Broadcast(BroadcastMessageDiscriminant::TriggerEvent(BroadcastEventDiscriminant::AnimationFrame)), MessageDiscriminant::InputPreprocessor(InputPreprocessorMessageDiscriminant::FrameTimeAdvance), ]; // TODO: Find a way to combine these with the list above. We use strings for now since these are the standard variant names used by multiple messages. But having these also type-checked would be best. const DEBUG_MESSAGE_ENDING_BLOCK_LIST: &[&str] = &["PointerMove", "PointerOutsideViewport", "Overlays", "Draw"]; impl Dispatcher { pub fn new() -> Self { Self::default() } // If the deepest queues (higher index in queues list) are now empty (after being popped from) then remove them fn cleanup_queues(&mut self, leave_last: bool) { while self.message_queues.last().filter(|queue| queue.is_empty()).is_some() { if leave_last && self.message_queues.len() == 1 { break; } self.message_queues.pop(); } } pub fn handle_message>(&mut self, message: T) { self.message_queues.push(VecDeque::from_iter([message.into()])); while let Some(message) = self.message_queues.last_mut().and_then(VecDeque::pop_front) { // Do not buffer the EndBuffer message if !matches!(message, Message::EndBuffer(_)) { if let Some(buffered_queue) = &mut self.buffered_queue { // Store each message in a deque so that its children are added before future messages let mut message_deque = VecDeque::new(); message_deque.push_back(message); buffered_queue.push(message_deque); continue; } } // Skip processing of this message if it will be processed later (at the end of the shallowest level queue) if SIDE_EFFECT_FREE_MESSAGES.contains(&message.to_discriminant()) { let already_in_queue = self.message_queues.first().filter(|queue| queue.contains(&message)).is_some(); if already_in_queue { self.log_deferred_message(&message, &self.message_queues, self.message_handlers.debug_message_handler.message_logging_verbosity); self.cleanup_queues(false); continue; } else if self.message_queues.len() > 1 { self.log_deferred_message(&message, &self.message_queues, self.message_handlers.debug_message_handler.message_logging_verbosity); self.cleanup_queues(true); self.message_queues[0].add(message); continue; } } // Print the message at a verbosity level of `log` self.log_message(&message, &self.message_queues, self.message_handlers.debug_message_handler.message_logging_verbosity); // Create a new queue for the child messages let mut queue = VecDeque::new(); // Process the action by forwarding it to the relevant message handler, or saving the FrontendMessage to be sent to the frontend match message { Message::StartBuffer => { self.buffered_queue = Some(std::mem::take(&mut self.message_queues)); } Message::EndBuffer(render_metadata) => { // The buffered vec is added before the metadata messages, because the end of the vec is processed first if let Some(buffered_queue) = self.buffered_queue.take() { self.message_queues.extend(buffered_queue); }; let graphene_std::renderer::RenderMetadata { footprints, click_targets, clip_targets, } = render_metadata; let mut update_upstream_transform = VecDeque::new(); update_upstream_transform.push_back(DocumentMessage::UpdateUpstreamTransforms { upstream_transforms: footprints }.into()); self.message_queues.push(update_upstream_transform); let mut update_click_targets = VecDeque::new(); update_click_targets.push_back(DocumentMessage::UpdateClickTargets { click_targets }.into()); update_click_targets.push_back(DocumentMessage::UpdateClipTargets { clip_targets }.into()); self.message_queues.push(update_click_targets); } Message::NoOp => {} Message::Init => { // Load persistent data from the browser database queue.add(FrontendMessage::TriggerLoadAutoSaveDocuments); queue.add(FrontendMessage::TriggerLoadPreferences); // Display the menu bar at the top of the window queue.add(MenuBarMessage::SendLayout); // Send the information for tooltips and categories for each node/input. queue.add(FrontendMessage::SendUIMetadata { input_type_descriptions: Vec::new(), node_descriptions: document_node_definitions::collect_node_descriptions(), node_types: document_node_definitions::collect_node_types(), }); } Message::Batched(messages) => { messages.iter().for_each(|message| self.handle_message(message.to_owned())); } Message::Broadcast(message) => self.message_handlers.broadcast_message_handler.process_message(message, &mut queue, ()), Message::Debug(message) => { self.message_handlers.debug_message_handler.process_message(message, &mut queue, ()); } Message::Dialog(message) => { let data = DialogMessageData { portfolio: &self.message_handlers.portfolio_message_handler, preferences: &self.message_handlers.preferences_message_handler, }; self.message_handlers.dialog_message_handler.process_message(message, &mut queue, data); } Message::Frontend(message) => { // Handle these messages immediately by returning early if let FrontendMessage::TriggerFontLoad { .. } = message { self.responses.push(message); self.cleanup_queues(false); // Return early to avoid running the code after the match block return; } else { // `FrontendMessage`s are saved and will be sent to the frontend after the message queue is done being processed self.responses.push(message); } } Message::Globals(message) => { self.message_handlers.globals_message_handler.process_message(message, &mut queue, ()); } Message::InputPreprocessor(message) => { let keyboard_platform = GLOBAL_PLATFORM.get().copied().unwrap_or_default().as_keyboard_platform_layout(); self.message_handlers .input_preprocessor_message_handler .process_message(message, &mut queue, InputPreprocessorMessageData { keyboard_platform }); } Message::KeyMapping(message) => { let input = &self.message_handlers.input_preprocessor_message_handler; let actions = self.collect_actions(); self.message_handlers .key_mapping_message_handler .process_message(message, &mut queue, KeyMappingMessageData { input, actions }); } Message::Layout(message) => { let action_input_mapping = &|action_to_find: &MessageDiscriminant| self.message_handlers.key_mapping_message_handler.action_input_mapping(action_to_find); self.message_handlers.layout_message_handler.process_message(message, &mut queue, action_input_mapping); } Message::Portfolio(message) => { let ipp = &self.message_handlers.input_preprocessor_message_handler; let preferences = &self.message_handlers.preferences_message_handler; let current_tool = &self.message_handlers.tool_message_handler.tool_state.tool_data.active_tool_type; self.message_handlers .portfolio_message_handler .process_message(message, &mut queue, PortfolioMessageData { ipp, preferences, current_tool }); } Message::Preferences(message) => { self.message_handlers.preferences_message_handler.process_message(message, &mut queue, ()); } Message::Tool(message) => { let document_id = self.message_handlers.portfolio_message_handler.active_document_id().unwrap(); if let Some(document) = self.message_handlers.portfolio_message_handler.documents.get_mut(&document_id) { let data = ToolMessageData { document_id, document, input: &self.message_handlers.input_preprocessor_message_handler, persistent_data: &self.message_handlers.portfolio_message_handler.persistent_data, node_graph: &self.message_handlers.portfolio_message_handler.executor, }; self.message_handlers.tool_message_handler.process_message(message, &mut queue, data); } else { warn!("Called ToolMessage without an active document.\nGot {message:?}"); } } Message::Workspace(message) => { self.message_handlers.workspace_message_handler.process_message(message, &mut queue, ()); } } // If there are child messages, append the queue to the list of queues if !queue.is_empty() { self.message_queues.push(queue); } self.cleanup_queues(false); } } pub fn collect_actions(&self) -> ActionList { // TODO: Reduce the number of heap allocations let mut list = Vec::new(); list.extend(self.message_handlers.dialog_message_handler.actions()); list.extend(self.message_handlers.input_preprocessor_message_handler.actions()); list.extend(self.message_handlers.key_mapping_message_handler.actions()); list.extend(self.message_handlers.debug_message_handler.actions()); if let Some(document) = self.message_handlers.portfolio_message_handler.active_document() { if !document.graph_view_overlay_open { list.extend(self.message_handlers.tool_message_handler.actions()); } } list.extend(self.message_handlers.portfolio_message_handler.actions()); list } pub fn poll_node_graph_evaluation(&mut self, responses: &mut VecDeque) -> Result<(), String> { self.message_handlers.portfolio_message_handler.poll_node_graph_evaluation(responses) } /// Create the tree structure for logging the messages as a tree fn create_indents(queues: &[VecDeque]) -> String { String::from_iter(queues.iter().enumerate().skip(1).map(|(index, queue)| { if index == queues.len() - 1 { if queue.is_empty() { "└── " } else { "├── " } } else if queue.is_empty() { " " } else { "│ " } })) } /// Logs a message that is about to be executed, /// either as a tree with a discriminant or the entire payload (depending on settings) fn log_message(&self, message: &Message, queues: &[VecDeque], message_logging_verbosity: MessageLoggingVerbosity) { let discriminant = MessageDiscriminant::from(message); let is_blocked = DEBUG_MESSAGE_BLOCK_LIST.iter().any(|&blocked_discriminant| discriminant == blocked_discriminant) || DEBUG_MESSAGE_ENDING_BLOCK_LIST.iter().any(|blocked_name| discriminant.local_name().ends_with(blocked_name)); if !is_blocked { match message_logging_verbosity { MessageLoggingVerbosity::Off => {} MessageLoggingVerbosity::Names => { info!("{}{:?}", Self::create_indents(queues), message.to_discriminant()); } MessageLoggingVerbosity::Contents => { if !(matches!(message, Message::InputPreprocessor(_))) { info!("Message: {}{:?}", Self::create_indents(queues), message); } } } } } /// Logs into the tree that the message is in the side effect free messages and its execution will be deferred fn log_deferred_message(&self, message: &Message, queues: &[VecDeque], message_logging_verbosity: MessageLoggingVerbosity) { if let MessageLoggingVerbosity::Names = message_logging_verbosity { info!("{}Deferred \"{:?}\" because it's a SIDE_EFFECT_FREE_MESSAGE", Self::create_indents(queues), message.to_discriminant()); } } } #[cfg(test)] mod test { use crate::application::Editor; use crate::messages::portfolio::document::utility_types::clipboards::Clipboard; use crate::messages::portfolio::document::utility_types::document_metadata::LayerNodeIdentifier; use crate::messages::prelude::*; use crate::test_utils::EditorTestUtils; use graphene_core::raster::color::Color; fn init_logger() { let _ = env_logger::builder().is_test(true).try_init(); } /// Create an editor with three layers /// 1. A red rectangle /// 2. A blue shape /// 3. A green ellipse fn create_editor_with_three_layers() -> Editor { init_logger(); let mut editor = Editor::create(); editor.new_document(); editor.select_primary_color(Color::RED); editor.draw_rect(100., 200., 300., 400.); editor.select_primary_color(Color::BLUE); editor.draw_polygon(10., 1200., 1300., 400.); editor.select_primary_color(Color::GREEN); editor.draw_ellipse(104., 1200., 1300., 400.); editor } // TODO: Fix text #[ignore] #[test] /// - create rect, shape and ellipse /// - copy /// - paste /// - assert that ellipse was copied fn copy_paste_single_layer() { let mut editor = create_editor_with_three_layers(); let document_before_copy = editor.dispatcher.message_handlers.portfolio_message_handler.active_document().unwrap().clone(); editor.handle_message(PortfolioMessage::Copy { clipboard: Clipboard::Internal }); editor.handle_message(PortfolioMessage::PasteIntoFolder { clipboard: Clipboard::Internal, parent: LayerNodeIdentifier::ROOT_PARENT, insert_index: 0, }); let document_after_copy = editor.dispatcher.message_handlers.portfolio_message_handler.active_document().unwrap().clone(); let layers_before_copy = document_before_copy.metadata().all_layers().collect::>(); let layers_after_copy = document_after_copy.metadata().all_layers().collect::>(); assert_eq!(layers_before_copy.len(), 3); assert_eq!(layers_after_copy.len(), 4); // Existing layers are unaffected for i in 0..=2 { assert_eq!(layers_before_copy[i], layers_after_copy[i + 1]); } } // TODO: Fix text #[ignore] #[test] #[cfg_attr(miri, ignore)] /// - create rect, shape and ellipse /// - select shape /// - copy /// - paste /// - assert that shape was copied fn copy_paste_single_layer_from_middle() { let mut editor = create_editor_with_three_layers(); let document_before_copy = editor.dispatcher.message_handlers.portfolio_message_handler.active_document().unwrap().clone(); let shape_id = document_before_copy.metadata().all_layers().nth(1).unwrap(); editor.handle_message(NodeGraphMessage::SelectedNodesSet { nodes: vec![shape_id.to_node()] }); editor.handle_message(PortfolioMessage::Copy { clipboard: Clipboard::Internal }); editor.handle_message(PortfolioMessage::PasteIntoFolder { clipboard: Clipboard::Internal, parent: LayerNodeIdentifier::ROOT_PARENT, insert_index: 0, }); let document_after_copy = editor.dispatcher.message_handlers.portfolio_message_handler.active_document().unwrap().clone(); let layers_before_copy = document_before_copy.metadata().all_layers().collect::>(); let layers_after_copy = document_after_copy.metadata().all_layers().collect::>(); assert_eq!(layers_before_copy.len(), 3); assert_eq!(layers_after_copy.len(), 4); // Existing layers are unaffected for i in 0..=2 { assert_eq!(layers_before_copy[i], layers_after_copy[i + 1]); } } // TODO: Fix text #[ignore] #[test] #[cfg_attr(miri, ignore)] /// - create rect, shape and ellipse /// - select ellipse and rect /// - copy /// - delete /// - create another rect /// - paste /// - paste fn copy_paste_deleted_layers() { let mut editor = create_editor_with_three_layers(); let document_before_copy = editor.dispatcher.message_handlers.portfolio_message_handler.active_document().unwrap().clone(); let mut layers = document_before_copy.metadata().all_layers(); let rect_id = layers.next().expect("rectangle"); let shape_id = layers.next().expect("shape"); let ellipse_id = layers.next().expect("ellipse"); editor.handle_message(NodeGraphMessage::SelectedNodesSet { nodes: vec![rect_id.to_node(), ellipse_id.to_node()], }); editor.handle_message(PortfolioMessage::Copy { clipboard: Clipboard::Internal }); editor.handle_message(NodeGraphMessage::DeleteSelectedNodes { delete_children: true }); editor.draw_rect(0., 800., 12., 200.); editor.handle_message(PortfolioMessage::PasteIntoFolder { clipboard: Clipboard::Internal, parent: LayerNodeIdentifier::ROOT_PARENT, insert_index: 0, }); editor.handle_message(PortfolioMessage::PasteIntoFolder { clipboard: Clipboard::Internal, parent: LayerNodeIdentifier::ROOT_PARENT, insert_index: 0, }); let document_after_copy = editor.dispatcher.message_handlers.portfolio_message_handler.active_document().unwrap().clone(); let layers_before_copy = document_before_copy.metadata().all_layers().collect::>(); let layers_after_copy = document_after_copy.metadata().all_layers().collect::>(); assert_eq!(layers_before_copy.len(), 3); assert_eq!(layers_after_copy.len(), 6); println!("{:?} {:?}", layers_after_copy, layers_before_copy); assert_eq!(layers_after_copy[5], shape_id); } #[tokio::test] /// This test will fail when you make changes to the underlying serialization format for a document. async fn check_if_demo_art_opens() { use crate::messages::layout::utility_types::widget_prelude::*; let print_problem_to_terminal_on_failure = |value: &String| { println!(); println!("-------------------------------------------------"); println!("Failed test due to receiving a DisplayDialogError while loading a Graphite demo file."); println!(); println!("DisplayDialogError details:"); println!(); println!("Description: {value}"); println!("-------------------------------------------------"); println!(); panic!() }; init_logger(); let mut editor = Editor::create(); // UNCOMMENT THIS FOR RUNNING UNDER MIRI // // let files = [ // include_str!("../../demo-artwork/changing-seasons.graphite"), // include_str!("../../demo-artwork/isometric-fountain.graphite"), // include_str!("../../demo-artwork/painted-dreams.graphite"), // include_str!("../../demo-artwork/procedural-string-lights.graphite"), // include_str!("../../demo-artwork/red-dress.graphite"), // include_str!("../../demo-artwork/valley-of-spires.graphite"), // ]; // for (id, document_serialized_content) in files.iter().enumerate() { // let document_name = format!("document {id}"); for (document_name, _, file_name) in crate::messages::dialog::simple_dialogs::ARTWORK { let document_serialized_content = std::fs::read_to_string(format!("../demo-artwork/{file_name}")).unwrap(); assert_eq!( document_serialized_content.lines().count(), 1, "Demo artwork '{document_name}' has more than 1 line (remember to open and re-save it in Graphite)", ); let responses = editor.handle_message(PortfolioMessage::OpenDocumentFile { document_name: document_name.into(), document_serialized_content, }); // Check if the graph renders let portfolio = &mut editor.dispatcher.message_handlers.portfolio_message_handler; portfolio .executor .submit_node_graph_evaluation(portfolio.documents.get_mut(&portfolio.active_document_id.unwrap()).unwrap(), glam::UVec2::ONE, true) .expect("submit_node_graph_evaluation failed"); crate::node_graph_executor::run_node_graph().await; let mut messages = VecDeque::new(); editor.poll_node_graph_evaluation(&mut messages).expect("Graph should render"); for response in responses { // Check for the existence of the file format incompatibility warning dialog after opening the test file if let FrontendMessage::UpdateDialogColumn1 { layout_target: _, diff } = response { if let DiffUpdate::SubLayout(sub_layout) = &diff[0].new_value { if let LayoutGroup::Row { widgets } = &sub_layout[0] { if let Widget::TextLabel(TextLabel { value, .. }) = &widgets[0].widget { print_problem_to_terminal_on_failure(value); } } } } } } } }