Switch Vec<Key> to KeysGroup newtype

editor/src/messages/input_mapper/input_mapper_message_handler.rs

@@ -1,3 +1,4 @@
+use super::utility_types::input_keyboard::KeysGroup;
 use super::utility_types::misc::Mapping;
 use crate::messages::input_mapper::utility_types::input_keyboard::{self, Key};
 use crate::messages::portfolio::document::utility_types::misc::KeyboardPlatformLayout;
@@ -43,7 +44,7 @@ impl InputMapperMessageHandler {
 		output.replace("Key", "")
 	}
 
-	pub fn action_input_mapping(&self, action_to_find: &MessageDiscriminant, keyboard_platform: KeyboardPlatformLayout) -> Vec<Vec<Key>> {
+	pub fn action_input_mapping(&self, action_to_find: &MessageDiscriminant, keyboard_platform: KeyboardPlatformLayout) -> Vec<KeysGroup> {
 		let key_up = self.mapping.key_up.iter();
 		let key_down = self.mapping.key_down.iter();
 		let double_click = std::iter::once(&self.mapping.double_click);
@@ -92,7 +93,7 @@ impl InputMapperMessageHandler {
 					}
 				});
 
-				keys
+				KeysGroup(keys)
 			})
 			.collect::<Vec<_>>()
 	}

editor/src/messages/input_mapper/utility_types/input_keyboard.rs

@@ -1,3 +1,4 @@
+use crate::messages::portfolio::document::utility_types::misc::KeyboardPlatformLayout;
 use crate::messages::prelude::*;
 
 pub use graphene::DocumentResponse;
@@ -276,9 +277,42 @@ impl fmt::Display for Key {
 pub const NUMBER_OF_KEYS: usize = Key::NumKeys as usize;
 
 /// Only `Key`s that exist on a physical keyboard should be used.
-#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
+#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
 pub struct KeysGroup(pub Vec<Key>);
 
+impl KeysGroup {
+	pub fn keys_text_shortcut(&self, keyboard_platform: KeyboardPlatformLayout) -> String {
+		const JOINER_MARK: &str = "+";
+
+		let mut joined = self
+			.0
+			.iter()
+			.map(|key| {
+				let key_string = key.to_string();
+
+				if keyboard_platform == KeyboardPlatformLayout::Mac {
+					match key_string.as_str() {
+						"Command" => "⌘".to_string(),
+						"Control" => "⌃".to_string(),
+						"Alt" => "⌥".to_string(),
+						"Shift" => "⇧".to_string(),
+						_ => key_string + JOINER_MARK,
+					}
+				} else {
+					key_string + JOINER_MARK
+				}
+			})
+			.collect::<String>();
+
+		// Truncate to cut the joining character off the end if it's present
+		if joined.ends_with(JOINER_MARK) {
+			joined.truncate(joined.len() - JOINER_MARK.len());
+		}
+
+		joined
+	}
+}
+
 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
 pub enum MouseMotion {
 	None,

editor/src/messages/input_mapper/utility_types/misc.rs

@@ -1,5 +1,6 @@
+use super::input_keyboard::KeysGroup;
 use crate::messages::input_mapper::default_mapping::default_mapping;
-use crate::messages::input_mapper::utility_types::input_keyboard::{Key, KeyStates, NUMBER_OF_KEYS};
+use crate::messages::input_mapper::utility_types::input_keyboard::{KeyStates, NUMBER_OF_KEYS};
 use crate::messages::portfolio::document::utility_types::misc::KeyboardPlatformLayout;
 use crate::messages::prelude::*;
 
@@ -90,24 +91,24 @@ pub struct MappingEntry {
 	pub platform_layout: Option<KeyboardPlatformLayout>,
 }
 
-#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
+#[derive(Debug, Clone, Eq, PartialEq, Serialize, Deserialize)]
 pub enum ActionKeys {
 	Action(MessageDiscriminant),
 	#[serde(rename = "keys")]
-	Keys(Vec<Key>),
+	Keys(KeysGroup),
 }
 
 impl ActionKeys {
-	pub fn to_keys(&mut self, action_input_mapping: &impl Fn(&MessageDiscriminant) -> Vec<Vec<Key>>) {
+	pub fn to_keys(&mut self, action_input_mapping: &impl Fn(&MessageDiscriminant) -> Vec<KeysGroup>) {
 		match self {
 			ActionKeys::Action(action) => {
 				if let Some(keys) = action_input_mapping(action).get_mut(0) {
-					let mut taken_keys = Vec::new();
+					let mut taken_keys = KeysGroup::default();
 					std::mem::swap(keys, &mut taken_keys);
 
 					*self = ActionKeys::Keys(taken_keys);
 				} else {
-					*self = ActionKeys::Keys(Vec::new());
+					*self = ActionKeys::Keys(KeysGroup::default());
 				}
 			}
 			ActionKeys::Keys(keys) => {
@@ -116,33 +117,3 @@ impl ActionKeys {
 		}
 	}
 }
-
-pub fn keys_text_shortcut(keys: &[Key], keyboard_platform: KeyboardPlatformLayout) -> String {
-	const JOINER_MARK: &str = "+";
-
-	let mut joined = keys
-		.iter()
-		.map(|key| {
-			let key_string = key.to_string();
-
-			if keyboard_platform == KeyboardPlatformLayout::Mac {
-				match key_string.as_str() {
-					"Command" => "⌘".to_string(),
-					"Control" => "⌃".to_string(),
-					"Alt" => "⌥".to_string(),
-					"Shift" => "⇧".to_string(),
-					_ => key_string + JOINER_MARK,
-				}
-			} else {
-				key_string + JOINER_MARK
-			}
-		})
-		.collect::<String>();
-
-	// Truncate to cut the joining character off the end if it's present
-	if joined.ends_with(JOINER_MARK) {
-		joined.truncate(joined.len() - JOINER_MARK.len());
-	}
-
-	joined
-}

editor/src/messages/layout/layout_message_handler.rs

@@ -1,5 +1,5 @@
 use super::utility_types::misc::LayoutTarget;
-use crate::messages::input_mapper::utility_types::input_keyboard::Key;
+use crate::messages::input_mapper::utility_types::input_keyboard::KeysGroup;
 use crate::messages::layout::utility_types::layout_widget::Layout;
 use crate::messages::layout::utility_types::layout_widget::Widget;
 use crate::messages::portfolio::document::utility_types::misc::KeyboardPlatformLayout;
@@ -14,7 +14,7 @@ pub struct LayoutMessageHandler {
 	layouts: [Layout; LayoutTarget::LayoutTargetLength as usize],
 }
 
-impl<F: Fn(&MessageDiscriminant) -> Vec<Vec<Key>>> MessageHandler<LayoutMessage, (F, KeyboardPlatformLayout)> for LayoutMessageHandler {
+impl<F: Fn(&MessageDiscriminant) -> Vec<KeysGroup>> MessageHandler<LayoutMessage, (F, KeyboardPlatformLayout)> for LayoutMessageHandler {
 	#[remain::check]
 	fn process_message(&mut self, message: LayoutMessage, data: (F, KeyboardPlatformLayout), responses: &mut std::collections::VecDeque<Message>) {
 		let (action_input_mapping, keyboard_platform) = data;
@@ -156,7 +156,7 @@ impl LayoutMessageHandler {
 		&self,
 		layout_target: LayoutTarget,
 		responses: &mut VecDeque<Message>,
-		action_input_mapping: &impl Fn(&MessageDiscriminant) -> Vec<Vec<Key>>,
+		action_input_mapping: &impl Fn(&MessageDiscriminant) -> Vec<KeysGroup>,
 		keyboard_platform: KeyboardPlatformLayout,
 	) {
 		let layout = &self.layouts[layout_target as usize];

editor/src/messages/layout/utility_types/layout_widget.rs

@@ -3,8 +3,8 @@ use super::widgets::input_widgets::*;
 use super::widgets::label_widgets::*;
 use super::widgets::menu_widgets::MenuLayout;
 use crate::application::generate_uuid;
-use crate::messages::input_mapper::utility_types::input_keyboard::Key;
+use crate::messages::input_mapper::utility_types::input_keyboard::KeysGroup;
-use crate::messages::input_mapper::utility_types::misc::{keys_text_shortcut, ActionKeys};
+use crate::messages::input_mapper::utility_types::misc::ActionKeys;
 use crate::messages::layout::utility_types::misc::LayoutTarget;
 use crate::messages::portfolio::document::utility_types::misc::KeyboardPlatformLayout;
 use crate::messages::prelude::*;
@@ -35,14 +35,14 @@ pub enum Layout {
 }
 
 impl Layout {
-	pub fn unwrap_widget_layout(self, action_input_mapping: &impl Fn(&MessageDiscriminant) -> Vec<Vec<Key>>, keyboard_platform: KeyboardPlatformLayout) -> WidgetLayout {
+	pub fn unwrap_widget_layout(self, action_input_mapping: &impl Fn(&MessageDiscriminant) -> Vec<KeysGroup>, keyboard_platform: KeyboardPlatformLayout) -> WidgetLayout {
 		if let Layout::WidgetLayout(mut widget_layout) = self {
 			// Function used multiple times later in this code block to convert `ActionKeys::Action` to `ActionKeys::Keys` and append its shortcut to the tooltip
 			let apply_shortcut_to_tooltip = |tooltip_shortcut: &mut ActionKeys, tooltip: &mut String| {
 				tooltip_shortcut.to_keys(action_input_mapping);
 
 				if let ActionKeys::Keys(keys) = tooltip_shortcut {
-					let shortcut_text = keys_text_shortcut(keys, keyboard_platform);
+					let shortcut_text = keys.keys_text_shortcut(keyboard_platform);
 
 					if !shortcut_text.is_empty() {
 						if !tooltip.is_empty() {
@@ -90,7 +90,7 @@ impl Layout {
 		}
 	}
 
-	pub fn unwrap_menu_layout(self, action_input_mapping: &impl Fn(&MessageDiscriminant) -> Vec<Vec<Key>>, _keyboard_platform: KeyboardPlatformLayout) -> MenuLayout {
+	pub fn unwrap_menu_layout(self, action_input_mapping: &impl Fn(&MessageDiscriminant) -> Vec<KeysGroup>, _keyboard_platform: KeyboardPlatformLayout) -> MenuLayout {
 		if let Layout::MenuLayout(mut menu_layout) = self {
 			for menu_column in &mut menu_layout.layout {
 				menu_column.children.fill_in_shortcut_actions_with_keys(action_input_mapping);

editor/src/messages/layout/utility_types/widgets/menu_widgets.rs

@@ -1,4 +1,4 @@
-use crate::messages::input_mapper::utility_types::input_keyboard::Key;
+use crate::messages::input_mapper::utility_types::input_keyboard::KeysGroup;
 use crate::messages::input_mapper::utility_types::misc::ActionKeys;
 use crate::messages::layout::utility_types::layout_widget::WidgetHolder;
 use crate::messages::layout::utility_types::layout_widget::{Widget, WidgetCallback};
@@ -16,7 +16,7 @@ impl MenuEntryGroups {
 		Self(Vec::new())
 	}
 
-	pub fn fill_in_shortcut_actions_with_keys(&mut self, action_input_mapping: &impl Fn(&MessageDiscriminant) -> Vec<Vec<Key>>) {
+	pub fn fill_in_shortcut_actions_with_keys(&mut self, action_input_mapping: &impl Fn(&MessageDiscriminant) -> Vec<KeysGroup>) {
 		let entries = self.0.iter_mut().flatten();
 
 		for entry in entries {