1use anyhow::{Context as _, Result};
2use collections::{BTreeMap, HashMap, IndexMap};
3use fs::Fs;
4use gpui::{
5 Action, ActionBuildError, App, InvalidKeystrokeError, KEYSTROKE_PARSE_EXPECTED_MESSAGE,
6 KeyBinding, KeyBindingContextPredicate, KeyBindingMetaIndex, NoAction,
7};
8use schemars::{JsonSchema, json_schema};
9use serde::Deserialize;
10use serde_json::{Value, json};
11use std::borrow::Cow;
12use std::{any::TypeId, fmt::Write, rc::Rc, sync::Arc, sync::LazyLock};
13use util::{
14 asset_str,
15 markdown::{MarkdownEscaped, MarkdownInlineCode, MarkdownString},
16};
17
18use crate::{
19 SettingsAssets, append_top_level_array_value_in_json_text, parse_json_with_comments,
20 replace_top_level_array_value_in_json_text,
21};
22
23pub trait KeyBindingValidator: Send + Sync {
24 fn action_type_id(&self) -> TypeId;
25 fn validate(&self, binding: &KeyBinding) -> Result<(), MarkdownString>;
26}
27
28pub struct KeyBindingValidatorRegistration(pub fn() -> Box<dyn KeyBindingValidator>);
29
30inventory::collect!(KeyBindingValidatorRegistration);
31
32pub(crate) static KEY_BINDING_VALIDATORS: LazyLock<BTreeMap<TypeId, Box<dyn KeyBindingValidator>>> =
33 LazyLock::new(|| {
34 let mut validators = BTreeMap::new();
35 for validator_registration in inventory::iter::<KeyBindingValidatorRegistration> {
36 let validator = validator_registration.0();
37 validators.insert(validator.action_type_id(), validator);
38 }
39 validators
40 });
41
42// Note that the doc comments on these are shown by json-language-server when editing the keymap, so
43// they should be considered user-facing documentation. Documentation is not handled well with
44// schemars-0.8 - when there are newlines, it is rendered as plaintext (see
45// https://github.com/GREsau/schemars/issues/38#issuecomment-2282883519). So for now these docs
46// avoid newlines.
47//
48// TODO: Update to schemars-1.0 once it's released, and add more docs as newlines would be
49// supported. Tracking issue is https://github.com/GREsau/schemars/issues/112.
50
51/// Keymap configuration consisting of sections. Each section may have a context predicate which
52/// determines whether its bindings are used.
53#[derive(Debug, Deserialize, Default, Clone, JsonSchema)]
54#[serde(transparent)]
55pub struct KeymapFile(Vec<KeymapSection>);
56
57/// Keymap section which binds keystrokes to actions.
58#[derive(Debug, Deserialize, Default, Clone, JsonSchema)]
59pub struct KeymapSection {
60 /// Determines when these bindings are active. When just a name is provided, like `Editor` or
61 /// `Workspace`, the bindings will be active in that context. Boolean expressions like `X && Y`,
62 /// `X || Y`, `!X` are also supported. Some more complex logic including checking OS and the
63 /// current file extension are also supported - see [the
64 /// documentation](https://zed.dev/docs/key-bindings#contexts) for more details.
65 #[serde(default)]
66 context: String,
67 /// This option enables specifying keys based on their position on a QWERTY keyboard, by using
68 /// position-equivalent mappings for some non-QWERTY keyboards. This is currently only supported
69 /// on macOS. See the documentation for more details.
70 #[serde(default)]
71 use_key_equivalents: bool,
72 /// This keymap section's bindings, as a JSON object mapping keystrokes to actions. The
73 /// keystrokes key is a string representing a sequence of keystrokes to type, where the
74 /// keystrokes are separated by whitespace. Each keystroke is a sequence of modifiers (`ctrl`,
75 /// `alt`, `shift`, `fn`, `cmd`, `super`, or `win`) followed by a key, separated by `-`. The
76 /// order of bindings does matter. When the same keystrokes are bound at the same context depth,
77 /// the binding that occurs later in the file is preferred. For displaying keystrokes in the UI,
78 /// the later binding for the same action is preferred.
79 #[serde(default)]
80 bindings: Option<IndexMap<String, KeymapAction>>,
81 #[serde(flatten)]
82 unrecognized_fields: IndexMap<String, Value>,
83 // This struct intentionally uses permissive types for its fields, rather than validating during
84 // deserialization. The purpose of this is to allow loading the portion of the keymap that doesn't
85 // have errors. The downside of this is that the errors are not reported with line+column info.
86 // Unfortunately the implementations of the `Spanned` types for preserving this information are
87 // highly inconvenient (`serde_spanned`) and in some cases don't work at all here
88 // (`json_spanned_>value`). Serde should really have builtin support for this.
89}
90
91impl KeymapSection {
92 pub fn bindings(&self) -> impl DoubleEndedIterator<Item = (&String, &KeymapAction)> {
93 self.bindings.iter().flatten()
94 }
95}
96
97/// Keymap action as a JSON value, since it can either be null for no action, or the name of the
98/// action, or an array of the name of the action and the action input.
99///
100/// Unlike the other json types involved in keymaps (including actions), this doc-comment will not
101/// be included in the generated JSON schema, as it manually defines its `JsonSchema` impl. The
102/// actual schema used for it is automatically generated in `KeymapFile::generate_json_schema`.
103#[derive(Debug, Deserialize, Default, Clone)]
104#[serde(transparent)]
105pub struct KeymapAction(Value);
106
107impl std::fmt::Display for KeymapAction {
108 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
109 match &self.0 {
110 Value::String(s) => write!(f, "{}", s),
111 Value::Array(arr) => {
112 let strings: Vec<String> = arr.iter().map(|v| v.to_string()).collect();
113 write!(f, "{}", strings.join(", "))
114 }
115 _ => write!(f, "{}", self.0),
116 }
117 }
118}
119
120impl JsonSchema for KeymapAction {
121 /// This is used when generating the JSON schema for the `KeymapAction` type, so that it can
122 /// reference the keymap action schema.
123 fn schema_name() -> Cow<'static, str> {
124 "KeymapAction".into()
125 }
126
127 /// This schema will be replaced with the full action schema in
128 /// `KeymapFile::generate_json_schema`.
129 fn json_schema(_: &mut schemars::SchemaGenerator) -> schemars::Schema {
130 json_schema!(true)
131 }
132}
133
134#[derive(Debug)]
135#[must_use]
136pub enum KeymapFileLoadResult {
137 Success {
138 key_bindings: Vec<KeyBinding>,
139 },
140 SomeFailedToLoad {
141 key_bindings: Vec<KeyBinding>,
142 error_message: MarkdownString,
143 },
144 JsonParseFailure {
145 error: anyhow::Error,
146 },
147}
148
149impl KeymapFile {
150 pub fn parse(content: &str) -> anyhow::Result<Self> {
151 parse_json_with_comments::<Self>(content)
152 }
153
154 pub fn load_asset(
155 asset_path: &str,
156 source: Option<KeybindSource>,
157 cx: &App,
158 ) -> anyhow::Result<Vec<KeyBinding>> {
159 match Self::load(asset_str::<SettingsAssets>(asset_path).as_ref(), cx) {
160 KeymapFileLoadResult::Success { mut key_bindings } => match source {
161 Some(source) => Ok({
162 for key_binding in &mut key_bindings {
163 key_binding.set_meta(source.meta());
164 }
165 key_bindings
166 }),
167 None => Ok(key_bindings),
168 },
169 KeymapFileLoadResult::SomeFailedToLoad { error_message, .. } => {
170 anyhow::bail!("Error loading built-in keymap \"{asset_path}\": {error_message}",)
171 }
172 KeymapFileLoadResult::JsonParseFailure { error } => {
173 anyhow::bail!("JSON parse error in built-in keymap \"{asset_path}\": {error}")
174 }
175 }
176 }
177
178 #[cfg(feature = "test-support")]
179 pub fn load_asset_allow_partial_failure(
180 asset_path: &str,
181 cx: &App,
182 ) -> anyhow::Result<Vec<KeyBinding>> {
183 match Self::load(asset_str::<SettingsAssets>(asset_path).as_ref(), cx) {
184 KeymapFileLoadResult::SomeFailedToLoad {
185 key_bindings,
186 error_message,
187 ..
188 } if key_bindings.is_empty() => {
189 anyhow::bail!("Error loading built-in keymap \"{asset_path}\": {error_message}",)
190 }
191 KeymapFileLoadResult::Success { key_bindings, .. }
192 | KeymapFileLoadResult::SomeFailedToLoad { key_bindings, .. } => Ok(key_bindings),
193 KeymapFileLoadResult::JsonParseFailure { error } => {
194 anyhow::bail!("JSON parse error in built-in keymap \"{asset_path}\": {error}")
195 }
196 }
197 }
198
199 #[cfg(feature = "test-support")]
200 pub fn load_panic_on_failure(content: &str, cx: &App) -> Vec<KeyBinding> {
201 match Self::load(content, cx) {
202 KeymapFileLoadResult::Success { key_bindings, .. } => key_bindings,
203 KeymapFileLoadResult::SomeFailedToLoad { error_message, .. } => {
204 panic!("{error_message}");
205 }
206 KeymapFileLoadResult::JsonParseFailure { error } => {
207 panic!("JSON parse error: {error}");
208 }
209 }
210 }
211
212 pub fn load(content: &str, cx: &App) -> KeymapFileLoadResult {
213 let key_equivalents =
214 crate::key_equivalents::get_key_equivalents(cx.keyboard_layout().id());
215
216 if content.is_empty() {
217 return KeymapFileLoadResult::Success {
218 key_bindings: Vec::new(),
219 };
220 }
221 let keymap_file = match Self::parse(content) {
222 Ok(keymap_file) => keymap_file,
223 Err(error) => {
224 return KeymapFileLoadResult::JsonParseFailure { error };
225 }
226 };
227
228 // Accumulate errors in order to support partial load of user keymap in the presence of
229 // errors in context and binding parsing.
230 let mut errors = Vec::new();
231 let mut key_bindings = Vec::new();
232
233 for KeymapSection {
234 context,
235 use_key_equivalents,
236 bindings,
237 unrecognized_fields,
238 } in keymap_file.0.iter()
239 {
240 let context_predicate: Option<Rc<KeyBindingContextPredicate>> = if context.is_empty() {
241 None
242 } else {
243 match KeyBindingContextPredicate::parse(context) {
244 Ok(context_predicate) => Some(context_predicate.into()),
245 Err(err) => {
246 // Leading space is to separate from the message indicating which section
247 // the error occurred in.
248 errors.push((
249 context,
250 format!(" Parse error in section `context` field: {}", err),
251 ));
252 continue;
253 }
254 }
255 };
256
257 let key_equivalents = if *use_key_equivalents {
258 key_equivalents.as_ref()
259 } else {
260 None
261 };
262
263 let mut section_errors = String::new();
264
265 if !unrecognized_fields.is_empty() {
266 write!(
267 section_errors,
268 "\n\n - Unrecognized fields: {}",
269 MarkdownInlineCode(&format!("{:?}", unrecognized_fields.keys()))
270 )
271 .unwrap();
272 }
273
274 if let Some(bindings) = bindings {
275 for (keystrokes, action) in bindings {
276 let result = Self::load_keybinding(
277 keystrokes,
278 action,
279 context_predicate.clone(),
280 key_equivalents,
281 cx,
282 );
283 match result {
284 Ok(key_binding) => {
285 key_bindings.push(key_binding);
286 }
287 Err(err) => {
288 let mut lines = err.lines();
289 let mut indented_err = lines.next().unwrap().to_string();
290 for line in lines {
291 indented_err.push_str(" ");
292 indented_err.push_str(line);
293 indented_err.push_str("\n");
294 }
295 write!(
296 section_errors,
297 "\n\n- In binding {}, {indented_err}",
298 MarkdownInlineCode(&format!("\"{}\"", keystrokes))
299 )
300 .unwrap();
301 }
302 }
303 }
304 }
305
306 if !section_errors.is_empty() {
307 errors.push((context, section_errors))
308 }
309 }
310
311 if errors.is_empty() {
312 KeymapFileLoadResult::Success { key_bindings }
313 } else {
314 let mut error_message = "Errors in user keymap file.\n".to_owned();
315 for (context, section_errors) in errors {
316 if context.is_empty() {
317 let _ = write!(error_message, "\n\nIn section without context predicate:");
318 } else {
319 let _ = write!(
320 error_message,
321 "\n\nIn section with {}:",
322 MarkdownInlineCode(&format!("context = \"{}\"", context))
323 );
324 }
325 let _ = write!(error_message, "{section_errors}");
326 }
327 KeymapFileLoadResult::SomeFailedToLoad {
328 key_bindings,
329 error_message: MarkdownString(error_message),
330 }
331 }
332 }
333
334 fn load_keybinding(
335 keystrokes: &str,
336 action: &KeymapAction,
337 context: Option<Rc<KeyBindingContextPredicate>>,
338 key_equivalents: Option<&HashMap<char, char>>,
339 cx: &App,
340 ) -> std::result::Result<KeyBinding, String> {
341 let (build_result, action_input_string) = match &action.0 {
342 Value::Array(items) => {
343 if items.len() != 2 {
344 return Err(format!(
345 "expected two-element array of `[name, input]`. \
346 Instead found {}.",
347 MarkdownInlineCode(&action.0.to_string())
348 ));
349 }
350 let serde_json::Value::String(ref name) = items[0] else {
351 return Err(format!(
352 "expected two-element array of `[name, input]`, \
353 but the first element is not a string in {}.",
354 MarkdownInlineCode(&action.0.to_string())
355 ));
356 };
357 let action_input = items[1].clone();
358 let action_input_string = action_input.to_string();
359 (
360 cx.build_action(&name, Some(action_input)),
361 Some(action_input_string),
362 )
363 }
364 Value::String(name) => (cx.build_action(&name, None), None),
365 Value::Null => (Ok(NoAction.boxed_clone()), None),
366 _ => {
367 return Err(format!(
368 "expected two-element array of `[name, input]`. \
369 Instead found {}.",
370 MarkdownInlineCode(&action.0.to_string())
371 ));
372 }
373 };
374
375 let action = match build_result {
376 Ok(action) => action,
377 Err(ActionBuildError::NotFound { name }) => {
378 return Err(format!(
379 "didn't find an action named {}.",
380 MarkdownInlineCode(&format!("\"{}\"", &name))
381 ));
382 }
383 Err(ActionBuildError::BuildError { name, error }) => match action_input_string {
384 Some(action_input_string) => {
385 return Err(format!(
386 "can't build {} action from input value {}: {}",
387 MarkdownInlineCode(&format!("\"{}\"", &name)),
388 MarkdownInlineCode(&action_input_string),
389 MarkdownEscaped(&error.to_string())
390 ));
391 }
392 None => {
393 return Err(format!(
394 "can't build {} action - it requires input data via [name, input]: {}",
395 MarkdownInlineCode(&format!("\"{}\"", &name)),
396 MarkdownEscaped(&error.to_string())
397 ));
398 }
399 },
400 };
401
402 let key_binding = match KeyBinding::load(keystrokes, action, context, key_equivalents) {
403 Ok(key_binding) => key_binding,
404 Err(InvalidKeystrokeError { keystroke }) => {
405 return Err(format!(
406 "invalid keystroke {}. {}",
407 MarkdownInlineCode(&format!("\"{}\"", &keystroke)),
408 KEYSTROKE_PARSE_EXPECTED_MESSAGE
409 ));
410 }
411 };
412
413 if let Some(validator) = KEY_BINDING_VALIDATORS.get(&key_binding.action().type_id()) {
414 match validator.validate(&key_binding) {
415 Ok(()) => Ok(key_binding),
416 Err(error) => Err(error.0),
417 }
418 } else {
419 Ok(key_binding)
420 }
421 }
422
423 pub fn generate_json_schema_for_registered_actions(cx: &mut App) -> Value {
424 let mut generator = schemars::generate::SchemaSettings::draft07().into_generator();
425
426 let action_schemas = cx.action_schemas(&mut generator);
427 let deprecations = cx.deprecated_actions_to_preferred_actions();
428 let deprecation_messages = cx.action_deprecation_messages();
429 KeymapFile::generate_json_schema(
430 generator,
431 action_schemas,
432 deprecations,
433 deprecation_messages,
434 )
435 }
436
437 fn generate_json_schema(
438 mut generator: schemars::SchemaGenerator,
439 action_schemas: Vec<(&'static str, Option<schemars::Schema>)>,
440 deprecations: &HashMap<&'static str, &'static str>,
441 deprecation_messages: &HashMap<&'static str, &'static str>,
442 ) -> serde_json::Value {
443 fn add_deprecation(schema: &mut schemars::Schema, message: String) {
444 schema.insert(
445 // deprecationMessage is not part of the JSON Schema spec, but
446 // json-language-server recognizes it.
447 "deprecationMessage".to_string(),
448 Value::String(message),
449 );
450 }
451
452 fn add_deprecation_preferred_name(schema: &mut schemars::Schema, new_name: &str) {
453 add_deprecation(schema, format!("Deprecated, use {new_name}"));
454 }
455
456 fn add_description(schema: &mut schemars::Schema, description: String) {
457 schema.insert("description".to_string(), Value::String(description));
458 }
459
460 let empty_object = json_schema!({
461 "type": "object"
462 });
463
464 // This is a workaround for a json-language-server issue where it matches the first
465 // alternative that matches the value's shape and uses that for documentation.
466 //
467 // In the case of the array validations, it would even provide an error saying that the name
468 // must match the name of the first alternative.
469 let mut plain_action = json_schema!({
470 "type": "string",
471 "const": ""
472 });
473 let no_action_message = "No action named this.";
474 add_description(&mut plain_action, no_action_message.to_owned());
475 add_deprecation(&mut plain_action, no_action_message.to_owned());
476
477 let mut matches_action_name = json_schema!({
478 "const": ""
479 });
480 let no_action_message_input = "No action named this that takes input.";
481 add_description(&mut matches_action_name, no_action_message_input.to_owned());
482 add_deprecation(&mut matches_action_name, no_action_message_input.to_owned());
483
484 let action_with_input = json_schema!({
485 "type": "array",
486 "items": [
487 matches_action_name,
488 true
489 ],
490 "minItems": 2,
491 "maxItems": 2
492 });
493 let mut keymap_action_alternatives = vec![plain_action, action_with_input];
494
495 for (name, action_schema) in action_schemas.into_iter() {
496 let description = action_schema.as_ref().and_then(|schema| {
497 schema
498 .as_object()
499 .and_then(|obj| obj.get("description"))
500 .and_then(|v| v.as_str())
501 .map(|s| s.to_string())
502 });
503
504 let deprecation = if name == NoAction.name() {
505 Some("null")
506 } else {
507 deprecations.get(name).copied()
508 };
509
510 // Add an alternative for plain action names.
511 let mut plain_action = json_schema!({
512 "type": "string",
513 "const": name
514 });
515 if let Some(message) = deprecation_messages.get(name) {
516 add_deprecation(&mut plain_action, message.to_string());
517 } else if let Some(new_name) = deprecation {
518 add_deprecation_preferred_name(&mut plain_action, new_name);
519 }
520 if let Some(desc) = description.clone() {
521 add_description(&mut plain_action, desc);
522 }
523 keymap_action_alternatives.push(plain_action);
524
525 // Add an alternative for actions with data specified as a [name, data] array.
526 //
527 // When a struct with no deserializable fields is added by deriving `Action`, an empty
528 // object schema is produced. The action should be invoked without data in this case.
529 if let Some(schema) = action_schema {
530 if schema != empty_object {
531 let mut matches_action_name = json_schema!({
532 "const": name
533 });
534 if let Some(desc) = description.clone() {
535 add_description(&mut matches_action_name, desc);
536 }
537 if let Some(message) = deprecation_messages.get(name) {
538 add_deprecation(&mut matches_action_name, message.to_string());
539 } else if let Some(new_name) = deprecation {
540 add_deprecation_preferred_name(&mut matches_action_name, new_name);
541 }
542 let action_with_input = json_schema!({
543 "type": "array",
544 "items": [matches_action_name, schema],
545 "minItems": 2,
546 "maxItems": 2
547 });
548 keymap_action_alternatives.push(action_with_input);
549 }
550 }
551 }
552
553 // Placing null first causes json-language-server to default assuming actions should be
554 // null, so place it last.
555 keymap_action_alternatives.push(json_schema!({
556 "type": "null"
557 }));
558
559 // The `KeymapSection` schema will reference the `KeymapAction` schema by name, so setting
560 // the definition of `KeymapAction` results in the full action schema being used.
561 generator.definitions_mut().insert(
562 KeymapAction::schema_name().to_string(),
563 json!({
564 "oneOf": keymap_action_alternatives
565 }),
566 );
567
568 generator.root_schema_for::<KeymapFile>().to_value()
569 }
570
571 pub fn sections(&self) -> impl DoubleEndedIterator<Item = &KeymapSection> {
572 self.0.iter()
573 }
574
575 pub async fn load_keymap_file(fs: &Arc<dyn Fs>) -> Result<String> {
576 match fs.load(paths::keymap_file()).await {
577 result @ Ok(_) => result,
578 Err(err) => {
579 if let Some(e) = err.downcast_ref::<std::io::Error>() {
580 if e.kind() == std::io::ErrorKind::NotFound {
581 return Ok(crate::initial_keymap_content().to_string());
582 }
583 }
584 Err(err)
585 }
586 }
587 }
588
589 pub fn update_keybinding<'a>(
590 mut operation: KeybindUpdateOperation<'a>,
591 mut keymap_contents: String,
592 tab_size: usize,
593 ) -> Result<String> {
594 // if trying to replace a keybinding that is not user-defined, treat it as an add operation
595 match operation {
596 KeybindUpdateOperation::Replace {
597 target_source,
598 source,
599 ..
600 } if target_source != KeybindSource::User => {
601 operation = KeybindUpdateOperation::Add(source);
602 }
603 _ => {}
604 }
605
606 // Sanity check that keymap contents are valid, even though we only use it for Replace.
607 // We don't want to modify the file if it's invalid.
608 let keymap = Self::parse(&keymap_contents).context("Failed to parse keymap")?;
609
610 if let KeybindUpdateOperation::Replace { source, target, .. } = operation {
611 let mut found_index = None;
612 let target_action_value = target
613 .action_value()
614 .context("Failed to generate target action JSON value")?;
615 let source_action_value = source
616 .action_value()
617 .context("Failed to generate source action JSON value")?;
618 'sections: for (index, section) in keymap.sections().enumerate() {
619 if section.context != target.context.unwrap_or("") {
620 continue;
621 }
622 if section.use_key_equivalents != target.use_key_equivalents {
623 continue;
624 }
625 let Some(bindings) = §ion.bindings else {
626 continue;
627 };
628 for (keystrokes, action) in bindings {
629 if keystrokes != target.keystrokes {
630 continue;
631 }
632 if action.0 != target_action_value {
633 continue;
634 }
635 found_index = Some(index);
636 break 'sections;
637 }
638 }
639
640 if let Some(index) = found_index {
641 let (replace_range, replace_value) = replace_top_level_array_value_in_json_text(
642 &keymap_contents,
643 &["bindings", target.keystrokes],
644 Some(&source_action_value),
645 Some(source.keystrokes),
646 index,
647 tab_size,
648 )
649 .context("Failed to replace keybinding")?;
650 keymap_contents.replace_range(replace_range, &replace_value);
651
652 return Ok(keymap_contents);
653 } else {
654 log::warn!(
655 "Failed to find keybinding to update `{:?} -> {}` creating new binding for `{:?} -> {}` instead",
656 target.keystrokes,
657 target_action_value,
658 source.keystrokes,
659 source_action_value,
660 );
661 operation = KeybindUpdateOperation::Add(source);
662 }
663 }
664
665 if let KeybindUpdateOperation::Add(keybinding) = operation {
666 let mut value = serde_json::Map::with_capacity(4);
667 if let Some(context) = keybinding.context {
668 value.insert("context".to_string(), context.into());
669 }
670 if keybinding.use_key_equivalents {
671 value.insert("use_key_equivalents".to_string(), true.into());
672 }
673
674 value.insert("bindings".to_string(), {
675 let mut bindings = serde_json::Map::new();
676 let action = keybinding.action_value()?;
677 bindings.insert(keybinding.keystrokes.into(), action);
678 bindings.into()
679 });
680
681 let (replace_range, replace_value) = append_top_level_array_value_in_json_text(
682 &keymap_contents,
683 &value.into(),
684 tab_size,
685 )?;
686 keymap_contents.replace_range(replace_range, &replace_value);
687 }
688 return Ok(keymap_contents);
689 }
690}
691
692pub enum KeybindUpdateOperation<'a> {
693 Replace {
694 /// Describes the keybind to create
695 source: KeybindUpdateTarget<'a>,
696 /// Describes the keybind to remove
697 target: KeybindUpdateTarget<'a>,
698 target_source: KeybindSource,
699 },
700 Add(KeybindUpdateTarget<'a>),
701}
702
703pub struct KeybindUpdateTarget<'a> {
704 context: Option<&'a str>,
705 keystrokes: &'a str,
706 action_name: &'a str,
707 use_key_equivalents: bool,
708 input: Option<&'a str>,
709}
710
711impl<'a> KeybindUpdateTarget<'a> {
712 fn action_value(&self) -> Result<Value> {
713 let action_name: Value = self.action_name.into();
714 let value = match self.input {
715 Some(input) => {
716 let input = serde_json::from_str::<Value>(input)
717 .context("Failed to parse action input as JSON")?;
718 serde_json::json!([action_name, input])
719 }
720 None => action_name,
721 };
722 return Ok(value);
723 }
724}
725
726#[derive(Clone, Copy, PartialEq, Eq)]
727pub enum KeybindSource {
728 User,
729 Default,
730 Base,
731 Vim,
732}
733
734impl KeybindSource {
735 const BASE: KeyBindingMetaIndex = KeyBindingMetaIndex(0);
736 const DEFAULT: KeyBindingMetaIndex = KeyBindingMetaIndex(1);
737 const VIM: KeyBindingMetaIndex = KeyBindingMetaIndex(2);
738 const USER: KeyBindingMetaIndex = KeyBindingMetaIndex(3);
739
740 pub fn name(&self) -> &'static str {
741 match self {
742 KeybindSource::User => "User",
743 KeybindSource::Default => "Default",
744 KeybindSource::Base => "Base",
745 KeybindSource::Vim => "Vim",
746 }
747 }
748
749 pub fn meta(&self) -> KeyBindingMetaIndex {
750 match self {
751 KeybindSource::User => Self::USER,
752 KeybindSource::Default => Self::DEFAULT,
753 KeybindSource::Base => Self::BASE,
754 KeybindSource::Vim => Self::VIM,
755 }
756 }
757
758 pub fn from_meta(index: KeyBindingMetaIndex) -> Self {
759 match index {
760 _ if index == Self::USER => KeybindSource::User,
761 _ if index == Self::USER => KeybindSource::Base,
762 _ if index == Self::DEFAULT => KeybindSource::Default,
763 _ if index == Self::VIM => KeybindSource::Vim,
764 _ => unreachable!(),
765 }
766 }
767}
768
769impl From<KeyBindingMetaIndex> for KeybindSource {
770 fn from(index: KeyBindingMetaIndex) -> Self {
771 Self::from_meta(index)
772 }
773}
774
775impl From<KeybindSource> for KeyBindingMetaIndex {
776 fn from(source: KeybindSource) -> Self {
777 return source.meta();
778 }
779}
780
781#[cfg(test)]
782mod tests {
783 use unindent::Unindent;
784
785 use crate::{
786 KeybindSource, KeymapFile,
787 keymap_file::{KeybindUpdateOperation, KeybindUpdateTarget},
788 };
789
790 #[test]
791 fn can_deserialize_keymap_with_trailing_comma() {
792 let json = indoc::indoc! {"[
793 // Standard macOS bindings
794 {
795 \"bindings\": {
796 \"up\": \"menu::SelectPrevious\",
797 },
798 },
799 ]
800 "
801 };
802 KeymapFile::parse(json).unwrap();
803 }
804
805 #[test]
806 fn keymap_update() {
807 zlog::init_test();
808 #[track_caller]
809 fn check_keymap_update(
810 input: impl ToString,
811 operation: KeybindUpdateOperation,
812 expected: impl ToString,
813 ) {
814 let result = KeymapFile::update_keybinding(operation, input.to_string(), 4)
815 .expect("Update succeeded");
816 pretty_assertions::assert_eq!(expected.to_string(), result);
817 }
818
819 check_keymap_update(
820 "[]",
821 KeybindUpdateOperation::Add(KeybindUpdateTarget {
822 keystrokes: "ctrl-a",
823 action_name: "zed::SomeAction",
824 context: None,
825 use_key_equivalents: false,
826 input: None,
827 }),
828 r#"[
829 {
830 "bindings": {
831 "ctrl-a": "zed::SomeAction"
832 }
833 }
834 ]"#
835 .unindent(),
836 );
837
838 check_keymap_update(
839 r#"[
840 {
841 "bindings": {
842 "ctrl-a": "zed::SomeAction"
843 }
844 }
845 ]"#
846 .unindent(),
847 KeybindUpdateOperation::Add(KeybindUpdateTarget {
848 keystrokes: "ctrl-b",
849 action_name: "zed::SomeOtherAction",
850 context: None,
851 use_key_equivalents: false,
852 input: None,
853 }),
854 r#"[
855 {
856 "bindings": {
857 "ctrl-a": "zed::SomeAction"
858 }
859 },
860 {
861 "bindings": {
862 "ctrl-b": "zed::SomeOtherAction"
863 }
864 }
865 ]"#
866 .unindent(),
867 );
868
869 check_keymap_update(
870 r#"[
871 {
872 "bindings": {
873 "ctrl-a": "zed::SomeAction"
874 }
875 }
876 ]"#
877 .unindent(),
878 KeybindUpdateOperation::Add(KeybindUpdateTarget {
879 keystrokes: "ctrl-b",
880 action_name: "zed::SomeOtherAction",
881 context: None,
882 use_key_equivalents: false,
883 input: Some(r#"{"foo": "bar"}"#),
884 }),
885 r#"[
886 {
887 "bindings": {
888 "ctrl-a": "zed::SomeAction"
889 }
890 },
891 {
892 "bindings": {
893 "ctrl-b": [
894 "zed::SomeOtherAction",
895 {
896 "foo": "bar"
897 }
898 ]
899 }
900 }
901 ]"#
902 .unindent(),
903 );
904
905 check_keymap_update(
906 r#"[
907 {
908 "bindings": {
909 "ctrl-a": "zed::SomeAction"
910 }
911 }
912 ]"#
913 .unindent(),
914 KeybindUpdateOperation::Add(KeybindUpdateTarget {
915 keystrokes: "ctrl-b",
916 action_name: "zed::SomeOtherAction",
917 context: Some("Zed > Editor && some_condition = true"),
918 use_key_equivalents: true,
919 input: Some(r#"{"foo": "bar"}"#),
920 }),
921 r#"[
922 {
923 "bindings": {
924 "ctrl-a": "zed::SomeAction"
925 }
926 },
927 {
928 "context": "Zed > Editor && some_condition = true",
929 "use_key_equivalents": true,
930 "bindings": {
931 "ctrl-b": [
932 "zed::SomeOtherAction",
933 {
934 "foo": "bar"
935 }
936 ]
937 }
938 }
939 ]"#
940 .unindent(),
941 );
942
943 check_keymap_update(
944 r#"[
945 {
946 "bindings": {
947 "ctrl-a": "zed::SomeAction"
948 }
949 }
950 ]"#
951 .unindent(),
952 KeybindUpdateOperation::Replace {
953 target: KeybindUpdateTarget {
954 keystrokes: "ctrl-a",
955 action_name: "zed::SomeAction",
956 context: None,
957 use_key_equivalents: false,
958 input: None,
959 },
960 source: KeybindUpdateTarget {
961 keystrokes: "ctrl-b",
962 action_name: "zed::SomeOtherAction",
963 context: None,
964 use_key_equivalents: false,
965 input: Some(r#"{"foo": "bar"}"#),
966 },
967 target_source: KeybindSource::Base,
968 },
969 r#"[
970 {
971 "bindings": {
972 "ctrl-a": "zed::SomeAction"
973 }
974 },
975 {
976 "bindings": {
977 "ctrl-b": [
978 "zed::SomeOtherAction",
979 {
980 "foo": "bar"
981 }
982 ]
983 }
984 }
985 ]"#
986 .unindent(),
987 );
988
989 check_keymap_update(
990 r#"[
991 {
992 "bindings": {
993 "ctrl-a": "zed::SomeAction"
994 }
995 }
996 ]"#
997 .unindent(),
998 KeybindUpdateOperation::Replace {
999 target: KeybindUpdateTarget {
1000 keystrokes: "ctrl-a",
1001 action_name: "zed::SomeAction",
1002 context: None,
1003 use_key_equivalents: false,
1004 input: None,
1005 },
1006 source: KeybindUpdateTarget {
1007 keystrokes: "ctrl-b",
1008 action_name: "zed::SomeOtherAction",
1009 context: None,
1010 use_key_equivalents: false,
1011 input: Some(r#"{"foo": "bar"}"#),
1012 },
1013 target_source: KeybindSource::User,
1014 },
1015 r#"[
1016 {
1017 "bindings": {
1018 "ctrl-b": [
1019 "zed::SomeOtherAction",
1020 {
1021 "foo": "bar"
1022 }
1023 ]
1024 }
1025 }
1026 ]"#
1027 .unindent(),
1028 );
1029
1030 check_keymap_update(
1031 r#"[
1032 {
1033 "bindings": {
1034 "ctrl-a": "zed::SomeAction"
1035 }
1036 }
1037 ]"#
1038 .unindent(),
1039 KeybindUpdateOperation::Replace {
1040 target: KeybindUpdateTarget {
1041 keystrokes: "ctrl-a",
1042 action_name: "zed::SomeNonexistentAction",
1043 context: None,
1044 use_key_equivalents: false,
1045 input: None,
1046 },
1047 source: KeybindUpdateTarget {
1048 keystrokes: "ctrl-b",
1049 action_name: "zed::SomeOtherAction",
1050 context: None,
1051 use_key_equivalents: false,
1052 input: None,
1053 },
1054 target_source: KeybindSource::User,
1055 },
1056 r#"[
1057 {
1058 "bindings": {
1059 "ctrl-a": "zed::SomeAction"
1060 }
1061 },
1062 {
1063 "bindings": {
1064 "ctrl-b": "zed::SomeOtherAction"
1065 }
1066 }
1067 ]"#
1068 .unindent(),
1069 );
1070
1071 check_keymap_update(
1072 r#"[
1073 {
1074 "bindings": {
1075 // some comment
1076 "ctrl-a": "zed::SomeAction"
1077 // some other comment
1078 }
1079 }
1080 ]"#
1081 .unindent(),
1082 KeybindUpdateOperation::Replace {
1083 target: KeybindUpdateTarget {
1084 keystrokes: "ctrl-a",
1085 action_name: "zed::SomeAction",
1086 context: None,
1087 use_key_equivalents: false,
1088 input: None,
1089 },
1090 source: KeybindUpdateTarget {
1091 keystrokes: "ctrl-b",
1092 action_name: "zed::SomeOtherAction",
1093 context: None,
1094 use_key_equivalents: false,
1095 input: Some(r#"{"foo": "bar"}"#),
1096 },
1097 target_source: KeybindSource::User,
1098 },
1099 r#"[
1100 {
1101 "bindings": {
1102 // some comment
1103 "ctrl-b": [
1104 "zed::SomeOtherAction",
1105 {
1106 "foo": "bar"
1107 }
1108 ]
1109 // some other comment
1110 }
1111 }
1112 ]"#
1113 .unindent(),
1114 );
1115 }
1116}