mirror of
https://github.com/GraphiteEditor/Graphite.git
synced 2026-09-15 22:28:10 +08:00
2e2c4fe180
* Replace parameter passing with getContext and extract destroy functions to module-level exports * Resend layouts from Rust when editor is re-mounted on HMR * Code review
443 lines
16 KiB
Rust
443 lines
16 KiB
Rust
use crate::messages::input_mapper::utility_types::input_keyboard::KeysGroup;
|
|
use crate::messages::layout::utility_types::widget_prelude::*;
|
|
use crate::messages::prelude::*;
|
|
use graphene_std::vector::style::FillChoice;
|
|
use serde_json::Value;
|
|
use std::collections::HashMap;
|
|
|
|
#[derive(ExtractField)]
|
|
pub struct LayoutMessageContext<'a> {
|
|
pub action_input_mapping: &'a dyn Fn(&MessageDiscriminant) -> Option<KeysGroup>,
|
|
}
|
|
|
|
#[derive(Debug, Clone, Default, ExtractField)]
|
|
pub struct LayoutMessageHandler {
|
|
layouts: [Layout; LayoutTarget::_LayoutTargetLength as usize],
|
|
}
|
|
|
|
#[message_handler_data]
|
|
impl MessageHandler<LayoutMessage, LayoutMessageContext<'_>> for LayoutMessageHandler {
|
|
fn process_message(&mut self, message: LayoutMessage, responses: &mut std::collections::VecDeque<Message>, context: LayoutMessageContext) {
|
|
let action_input_mapping = &context.action_input_mapping;
|
|
|
|
match message {
|
|
LayoutMessage::ResendActiveWidget { layout_target, widget_id } => {
|
|
// Find the updated diff based on the specified layout target
|
|
let Some(diff) = Self::get_widget_path(&self.layouts[layout_target as usize], widget_id).map(|(widget, widget_path)| {
|
|
// Create a widget update diff for the relevant id
|
|
let new_value = DiffUpdate::Widget(widget.clone());
|
|
WidgetDiff { widget_path, new_value }
|
|
}) else {
|
|
return;
|
|
};
|
|
// Resend that diff
|
|
self.send_diff(vec![diff], layout_target, responses, action_input_mapping);
|
|
}
|
|
LayoutMessage::ResendAllLayouts => {
|
|
// Collect non-empty layouts and their indices, then clear the stored copies so diffs compute as full re-sends
|
|
let layouts_to_resend: Vec<_> = self
|
|
.layouts
|
|
.iter_mut()
|
|
.enumerate()
|
|
.filter(|(_, layout)| !layout.0.is_empty())
|
|
.map(|(i, layout)| (LayoutTarget::from(i as u8), std::mem::take(layout)))
|
|
.collect();
|
|
|
|
for (layout_target, layout) in layouts_to_resend {
|
|
self.diff_and_send_layout_to_frontend(layout_target, layout, responses, action_input_mapping);
|
|
}
|
|
}
|
|
LayoutMessage::SendLayout { layout, layout_target } => {
|
|
self.diff_and_send_layout_to_frontend(layout_target, layout, responses, action_input_mapping);
|
|
}
|
|
LayoutMessage::DestroyLayout { layout_target } => {
|
|
if let Some(layout) = self.layouts.get_mut(layout_target as usize) {
|
|
*layout = Layout::default();
|
|
}
|
|
}
|
|
LayoutMessage::WidgetValueCommit { layout_target, widget_id, value } => {
|
|
self.handle_widget_callback(layout_target, widget_id, value, WidgetValueAction::Commit, responses);
|
|
}
|
|
LayoutMessage::WidgetValueUpdate { layout_target, widget_id, value } => {
|
|
self.handle_widget_callback(layout_target, widget_id, value, WidgetValueAction::Update, responses);
|
|
}
|
|
}
|
|
}
|
|
|
|
fn actions(&self) -> ActionList {
|
|
actions!(LayoutMessageDiscriminant;)
|
|
}
|
|
}
|
|
|
|
impl LayoutMessageHandler {
|
|
/// Get the widget path for the widget with the specified id
|
|
fn get_widget_path(widget_layout: &Layout, widget_id: WidgetId) -> Option<(&WidgetInstance, Vec<usize>)> {
|
|
let mut stack = widget_layout.0.iter().enumerate().map(|(index, val)| (vec![index], val)).collect::<Vec<_>>();
|
|
while let Some((mut widget_path, layout_group)) = stack.pop() {
|
|
match layout_group {
|
|
// Check if any of the widgets in the current column or row have the correct id
|
|
LayoutGroup::Column(WidgetColumn { widgets }) | LayoutGroup::Row(WidgetRow { widgets }) => {
|
|
for (index, widget) in widgets.iter().enumerate() {
|
|
// Return if this is the correct ID
|
|
if widget.widget_id == widget_id {
|
|
widget_path.push(index);
|
|
return Some((widget, widget_path));
|
|
}
|
|
|
|
if let Widget::PopoverButton(popover) = &*widget.widget {
|
|
stack.extend(
|
|
popover
|
|
.popover_layout
|
|
.0
|
|
.iter()
|
|
.enumerate()
|
|
.map(|(child, val)| ([widget_path.as_slice(), &[index, child]].concat(), val)),
|
|
);
|
|
}
|
|
}
|
|
}
|
|
// A section contains more LayoutGroups which we add to the stack.
|
|
LayoutGroup::Section(WidgetSection { layout, .. }) => {
|
|
stack.extend(layout.0.iter().enumerate().map(|(index, val)| ([widget_path.as_slice(), &[index]].concat(), val)));
|
|
}
|
|
LayoutGroup::Table(WidgetTable { rows, .. }) => {
|
|
for (row_index, row) in rows.iter().enumerate() {
|
|
for (cell_index, cell) in row.iter().enumerate() {
|
|
// Return if this is the correct ID
|
|
if cell.widget_id == widget_id {
|
|
widget_path.push(row_index);
|
|
widget_path.push(cell_index);
|
|
return Some((cell, widget_path));
|
|
}
|
|
|
|
if let Widget::PopoverButton(popover) = &*cell.widget {
|
|
stack.extend(
|
|
popover
|
|
.popover_layout
|
|
.0
|
|
.iter()
|
|
.enumerate()
|
|
.map(|(child, val)| ([widget_path.as_slice(), &[row_index, cell_index, child]].concat(), val)),
|
|
);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
None
|
|
}
|
|
|
|
fn handle_widget_callback(&mut self, layout_target: LayoutTarget, widget_id: WidgetId, value: Value, action: WidgetValueAction, responses: &mut std::collections::VecDeque<Message>) {
|
|
let Some(layout) = self.layouts.get_mut(layout_target as usize) else {
|
|
warn!("handle_widget_callback was called referencing an invalid layout. `widget_id: {widget_id}`, `layout_target: {layout_target:?}`",);
|
|
return;
|
|
};
|
|
|
|
let Some(widget_instance) = layout.iter_mut().find(|widget| widget.widget_id == widget_id) else {
|
|
warn!("handle_widget_callback was called referencing an invalid widget ID, although the layout target was valid. `widget_id: {widget_id}`, `layout_target: {layout_target:?}`",);
|
|
return;
|
|
};
|
|
|
|
match &mut *widget_instance.widget {
|
|
Widget::BreadcrumbTrailButtons(breadcrumb_trail_buttons) => {
|
|
let callback_message = match action {
|
|
WidgetValueAction::Commit => (breadcrumb_trail_buttons.on_commit.callback)(&()),
|
|
WidgetValueAction::Update => {
|
|
let Some(update_value) = value.as_u64() else {
|
|
error!("BreadcrumbTrailButtons update was not of type: u64");
|
|
return;
|
|
};
|
|
(breadcrumb_trail_buttons.on_update.callback)(&update_value)
|
|
}
|
|
};
|
|
responses.add(callback_message);
|
|
}
|
|
Widget::CheckboxInput(checkbox_input) => {
|
|
let callback_message = match action {
|
|
WidgetValueAction::Commit => (checkbox_input.on_commit.callback)(&()),
|
|
WidgetValueAction::Update => {
|
|
let Some(update_value) = value.as_bool() else {
|
|
error!("CheckboxInput update was not of type: bool");
|
|
return;
|
|
};
|
|
checkbox_input.checked = update_value;
|
|
(checkbox_input.on_update.callback)(checkbox_input)
|
|
}
|
|
};
|
|
responses.add(callback_message);
|
|
}
|
|
Widget::ColorInput(color_button) => {
|
|
let callback_message = match action {
|
|
WidgetValueAction::Commit => (color_button.on_commit.callback)(&()),
|
|
WidgetValueAction::Update => {
|
|
let Ok(fill_choice) = serde_json::from_value::<FillChoice>(value) else {
|
|
warn!("ColorInput update was not able to be parsed as FillChoice: {color_button:?}");
|
|
return;
|
|
};
|
|
color_button.value = fill_choice;
|
|
(color_button.on_update.callback)(color_button)
|
|
}
|
|
};
|
|
|
|
responses.add(callback_message);
|
|
}
|
|
Widget::CurveInput(curve_input) => {
|
|
let callback_message = match action {
|
|
WidgetValueAction::Commit => (curve_input.on_commit.callback)(&()),
|
|
WidgetValueAction::Update => {
|
|
let Some(curve) = serde_json::from_value(value).ok() else {
|
|
error!("CurveInput event data could not be deserialized");
|
|
return;
|
|
};
|
|
curve_input.value = curve;
|
|
(curve_input.on_update.callback)(curve_input)
|
|
}
|
|
};
|
|
|
|
responses.add(callback_message);
|
|
}
|
|
Widget::DropdownInput(dropdown_input) => {
|
|
let callback_message = match action {
|
|
WidgetValueAction::Commit => {
|
|
let Some(update_value) = value.as_u64() else {
|
|
error!("DropdownInput commit was not of type `u64`, found {value:?}");
|
|
return;
|
|
};
|
|
let Some(entry) = dropdown_input.entries.iter().flatten().nth(update_value as usize) else {
|
|
error!("DropdownInput commit was not able to find entry for index {update_value}");
|
|
return;
|
|
};
|
|
(entry.on_commit.callback)(&())
|
|
}
|
|
WidgetValueAction::Update => {
|
|
let Some(update_value) = value.as_u64() else {
|
|
error!("DropdownInput update was not of type `u64`, found {value:?}");
|
|
return;
|
|
};
|
|
dropdown_input.selected_index = Some(update_value as u32);
|
|
let Some(entry) = dropdown_input.entries.iter().flatten().nth(update_value as usize) else {
|
|
error!("DropdownInput update was not able to find entry for index {update_value}");
|
|
return;
|
|
};
|
|
(entry.on_update.callback)(&())
|
|
}
|
|
};
|
|
|
|
responses.add(callback_message);
|
|
}
|
|
Widget::IconButton(icon_button) => {
|
|
let callback_message = match action {
|
|
WidgetValueAction::Commit => (icon_button.on_commit.callback)(&()),
|
|
WidgetValueAction::Update => (icon_button.on_update.callback)(icon_button),
|
|
};
|
|
|
|
responses.add(callback_message);
|
|
}
|
|
Widget::ImageButton(image_label) => {
|
|
let callback_message = match action {
|
|
WidgetValueAction::Commit => (image_label.on_commit.callback)(&()),
|
|
WidgetValueAction::Update => (image_label.on_update.callback)(&()),
|
|
};
|
|
|
|
responses.add(callback_message);
|
|
}
|
|
Widget::ImageLabel(_) => {}
|
|
Widget::ShortcutLabel(_) => {}
|
|
Widget::IconLabel(_) => {}
|
|
Widget::NodeCatalog(node_type_input) => match action {
|
|
WidgetValueAction::Commit => {
|
|
let callback_message = (node_type_input.on_commit.callback)(&());
|
|
responses.add(callback_message);
|
|
}
|
|
WidgetValueAction::Update => {
|
|
let callback_message = (node_type_input.on_update.callback)(&value.into());
|
|
responses.add(callback_message);
|
|
}
|
|
},
|
|
Widget::NumberInput(number_input) => match action {
|
|
WidgetValueAction::Commit => {
|
|
let callback_message = (number_input.on_commit.callback)(&());
|
|
responses.add(callback_message);
|
|
}
|
|
WidgetValueAction::Update => match value {
|
|
Value::Number(ref num) => {
|
|
let Some(update_value) = num.as_f64() else {
|
|
error!("NumberInput update was not of type: f64, found {value:?}");
|
|
return;
|
|
};
|
|
number_input.value = Some(update_value);
|
|
let callback_message = (number_input.on_update.callback)(number_input);
|
|
responses.add(callback_message);
|
|
}
|
|
// TODO: This crashes when the cursor is in a text box, such as in the Text node, and the transform node is clicked (https://github.com/GraphiteEditor/Graphite/issues/1761)
|
|
Value::String(str) => match str.as_str() {
|
|
"Increment" => responses.add((number_input.increment_callback_increase.callback)(number_input)),
|
|
"Decrement" => responses.add((number_input.increment_callback_decrease.callback)(number_input)),
|
|
_ => panic!("Invalid string found when updating `NumberInput`"),
|
|
},
|
|
_ => {}
|
|
},
|
|
},
|
|
Widget::ParameterExposeButton(parameter_expose_button) => {
|
|
let callback_message = match action {
|
|
WidgetValueAction::Commit => (parameter_expose_button.on_commit.callback)(&()),
|
|
WidgetValueAction::Update => (parameter_expose_button.on_update.callback)(parameter_expose_button),
|
|
};
|
|
|
|
responses.add(callback_message);
|
|
}
|
|
Widget::ReferencePointInput(reference_point_input) => {
|
|
let callback_message = match action {
|
|
WidgetValueAction::Commit => (reference_point_input.on_commit.callback)(&()),
|
|
WidgetValueAction::Update => {
|
|
let Some(update_value) = value.as_str() else {
|
|
error!("ReferencePointInput update was not of type: u64");
|
|
return;
|
|
};
|
|
reference_point_input.value = update_value.into();
|
|
(reference_point_input.on_update.callback)(reference_point_input)
|
|
}
|
|
};
|
|
|
|
responses.add(callback_message);
|
|
}
|
|
Widget::PopoverButton(_) => {}
|
|
Widget::RadioInput(radio_input) => {
|
|
let Some(update_value) = value.as_u64() else {
|
|
error!("RadioInput update was not of type: u64");
|
|
return;
|
|
};
|
|
radio_input.selected_index = Some(update_value as u32);
|
|
let callback_message = match action {
|
|
WidgetValueAction::Commit => (radio_input.entries[update_value as usize].on_commit.callback)(&()),
|
|
WidgetValueAction::Update => (radio_input.entries[update_value as usize].on_update.callback)(&()),
|
|
};
|
|
|
|
responses.add(callback_message);
|
|
}
|
|
Widget::Separator(_) => {}
|
|
Widget::TextAreaInput(text_area_input) => {
|
|
let callback_message = match action {
|
|
WidgetValueAction::Commit => (text_area_input.on_commit.callback)(&()),
|
|
WidgetValueAction::Update => {
|
|
let Some(update_value) = value.as_str() else {
|
|
error!("TextAreaInput update was not of type: string");
|
|
return;
|
|
};
|
|
text_area_input.value = update_value.into();
|
|
(text_area_input.on_update.callback)(text_area_input)
|
|
}
|
|
};
|
|
|
|
responses.add(callback_message);
|
|
}
|
|
Widget::TextButton(text_button) => {
|
|
let callback_message = match action {
|
|
WidgetValueAction::Commit => (text_button.on_commit.callback)(&()),
|
|
WidgetValueAction::Update => {
|
|
let Some(value_path) = value.as_array() else {
|
|
error!("TextButton update was not of type: array");
|
|
return;
|
|
};
|
|
|
|
// Process the text button click, since no menu is involved if we're given an empty array.
|
|
if value_path.is_empty() {
|
|
(text_button.on_update.callback)(text_button)
|
|
}
|
|
// Process the text button's menu list entry click, since we have a path to the value of the contained menu entry.
|
|
else {
|
|
let mut current_submenu = &text_button.menu_list_children;
|
|
let mut final_entry: Option<&MenuListEntry> = None;
|
|
|
|
// Loop through all menu entry value strings in the path until we reach the final entry (which we store).
|
|
// Otherwise we exit early if we can't traverse the full path.
|
|
for value in value_path.iter().filter_map(|v| v.as_str().map(|s| s.to_string())) {
|
|
let Some(next_entry) = current_submenu.iter().flatten().find(|e| e.value == value) else { return };
|
|
|
|
current_submenu = &next_entry.children;
|
|
final_entry = Some(next_entry);
|
|
}
|
|
|
|
// If we've reached here without returning early, we have a final entry in the path and we should now execute its callback.
|
|
(final_entry.unwrap().on_commit.callback)(&())
|
|
}
|
|
}
|
|
};
|
|
|
|
responses.add(callback_message);
|
|
}
|
|
Widget::TextInput(text_input) => {
|
|
let callback_message = match action {
|
|
WidgetValueAction::Commit => (text_input.on_commit.callback)(&()),
|
|
WidgetValueAction::Update => {
|
|
let Some(update_value) = value.as_str() else {
|
|
error!("TextInput update was not of type: string");
|
|
return;
|
|
};
|
|
text_input.value = update_value.into();
|
|
(text_input.on_update.callback)(text_input)
|
|
}
|
|
};
|
|
|
|
responses.add(callback_message);
|
|
}
|
|
Widget::TextLabel(_) => {}
|
|
Widget::WorkingColorsInput(_) => {}
|
|
};
|
|
}
|
|
|
|
/// Diff the update and send to the frontend where necessary
|
|
fn diff_and_send_layout_to_frontend(
|
|
&mut self,
|
|
layout_target: LayoutTarget,
|
|
mut new_layout: Layout,
|
|
responses: &mut VecDeque<Message>,
|
|
action_input_mapping: &impl Fn(&MessageDiscriminant) -> Option<KeysGroup>,
|
|
) {
|
|
// Step 1: Collect CheckboxId mappings from new layout
|
|
let mut checkbox_map = HashMap::new();
|
|
new_layout.collect_checkbox_ids(layout_target, &mut Vec::new(), &mut checkbox_map);
|
|
|
|
// Step 2: Replace all IDs in new layout with deterministic ones
|
|
new_layout.replace_widget_ids(layout_target, &mut Vec::new(), &checkbox_map);
|
|
|
|
// Step 3: Diff with deterministic IDs
|
|
let mut widget_diffs = Vec::new();
|
|
|
|
self.layouts[layout_target as usize].diff(new_layout, &mut Vec::new(), &mut widget_diffs);
|
|
|
|
// Skip sending if no diff
|
|
if widget_diffs.is_empty() {
|
|
return;
|
|
}
|
|
|
|
// On Mac we need the full MenuBar layout to construct the native menu
|
|
#[cfg(target_os = "macos")]
|
|
if layout_target == LayoutTarget::MenuBar {
|
|
widget_diffs = vec![WidgetDiff {
|
|
widget_path: Vec::new(),
|
|
new_value: DiffUpdate::Layout(self.layouts[LayoutTarget::MenuBar as usize].clone()),
|
|
}];
|
|
}
|
|
|
|
self.send_diff(widget_diffs, layout_target, responses, action_input_mapping);
|
|
}
|
|
|
|
/// Send a diff to the frontend based on the layout target.
|
|
fn send_diff(&self, mut diff: Vec<WidgetDiff>, layout_target: LayoutTarget, responses: &mut VecDeque<Message>, action_input_mapping: &impl Fn(&MessageDiscriminant) -> Option<KeysGroup>) {
|
|
diff.iter_mut().for_each(|diff| diff.new_value.apply_keyboard_shortcut(action_input_mapping));
|
|
|
|
if matches!(layout_target, LayoutTarget::_LayoutTargetLength) {
|
|
panic!("`_LayoutTargetLength` is not a valid `LayoutTarget` and is used for array indexing");
|
|
}
|
|
|
|
responses.add(FrontendMessage::UpdateLayout { layout_target, diff });
|
|
}
|
|
}
|
|
|
|
enum WidgetValueAction {
|
|
Commit,
|
|
Update,
|
|
}
|