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, Keystroke, NoAction, SharedString,
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::ResultExt as _;
14use util::{
15 asset_str,
16 markdown::{MarkdownEscaped, MarkdownInlineCode, MarkdownString},
17};
18
19use crate::{
20 SettingsAssets, append_top_level_array_value_in_json_text, parse_json_with_comments,
21 replace_top_level_array_value_in_json_text,
22};
23
24pub trait KeyBindingValidator: Send + Sync {
25 fn action_type_id(&self) -> TypeId;
26 fn validate(&self, binding: &KeyBinding) -> Result<(), MarkdownString>;
27}
28
29pub struct KeyBindingValidatorRegistration(pub fn() -> Box<dyn KeyBindingValidator>);
30
31inventory::collect!(KeyBindingValidatorRegistration);
32
33pub(crate) static KEY_BINDING_VALIDATORS: LazyLock<BTreeMap<TypeId, Box<dyn KeyBindingValidator>>> =
34 LazyLock::new(|| {
35 let mut validators = BTreeMap::new();
36 for validator_registration in inventory::iter::<KeyBindingValidatorRegistration> {
37 let validator = validator_registration.0();
38 validators.insert(validator.action_type_id(), validator);
39 }
40 validators
41 });
42
43// Note that the doc comments on these are shown by json-language-server when editing the keymap, so
44// they should be considered user-facing documentation. Documentation is not handled well with
45// schemars-0.8 - when there are newlines, it is rendered as plaintext (see
46// https://github.com/GREsau/schemars/issues/38#issuecomment-2282883519). So for now these docs
47// avoid newlines.
48//
49// TODO: Update to schemars-1.0 once it's released, and add more docs as newlines would be
50// supported. Tracking issue is https://github.com/GREsau/schemars/issues/112.
51
52/// Keymap configuration consisting of sections. Each section may have a context predicate which
53/// determines whether its bindings are used.
54#[derive(Debug, Deserialize, Default, Clone, JsonSchema)]
55#[serde(transparent)]
56pub struct KeymapFile(Vec<KeymapSection>);
57
58/// Keymap section which binds keystrokes to actions.
59#[derive(Debug, Deserialize, Default, Clone, JsonSchema)]
60pub struct KeymapSection {
61 /// Determines when these bindings are active. When just a name is provided, like `Editor` or
62 /// `Workspace`, the bindings will be active in that context. Boolean expressions like `X && Y`,
63 /// `X || Y`, `!X` are also supported. Some more complex logic including checking OS and the
64 /// current file extension are also supported - see [the
65 /// documentation](https://zed.dev/docs/key-bindings#contexts) for more details.
66 #[serde(default)]
67 pub context: String,
68 /// This option enables specifying keys based on their position on a QWERTY keyboard, by using
69 /// position-equivalent mappings for some non-QWERTY keyboards. This is currently only supported
70 /// on macOS. See the documentation for more details.
71 #[serde(default)]
72 use_key_equivalents: bool,
73 /// This keymap section's bindings, as a JSON object mapping keystrokes to actions. The
74 /// keystrokes key is a string representing a sequence of keystrokes to type, where the
75 /// keystrokes are separated by whitespace. Each keystroke is a sequence of modifiers (`ctrl`,
76 /// `alt`, `shift`, `fn`, `cmd`, `super`, or `win`) followed by a key, separated by `-`. The
77 /// order of bindings does matter. When the same keystrokes are bound at the same context depth,
78 /// the binding that occurs later in the file is preferred. For displaying keystrokes in the UI,
79 /// the later binding for the same action is preferred.
80 #[serde(default)]
81 bindings: Option<IndexMap<String, KeymapAction>>,
82 #[serde(flatten)]
83 unrecognized_fields: IndexMap<String, Value>,
84 // This struct intentionally uses permissive types for its fields, rather than validating during
85 // deserialization. The purpose of this is to allow loading the portion of the keymap that doesn't
86 // have errors. The downside of this is that the errors are not reported with line+column info.
87 // Unfortunately the implementations of the `Spanned` types for preserving this information are
88 // highly inconvenient (`serde_spanned`) and in some cases don't work at all here
89 // (`json_spanned_>value`). Serde should really have builtin support for this.
90}
91
92impl KeymapSection {
93 pub fn bindings(&self) -> impl DoubleEndedIterator<Item = (&String, &KeymapAction)> {
94 self.bindings.iter().flatten()
95 }
96}
97
98/// Keymap action as a JSON value, since it can either be null for no action, or the name of the
99/// action, or an array of the name of the action and the action input.
100///
101/// Unlike the other json types involved in keymaps (including actions), this doc-comment will not
102/// be included in the generated JSON schema, as it manually defines its `JsonSchema` impl. The
103/// actual schema used for it is automatically generated in `KeymapFile::generate_json_schema`.
104#[derive(Debug, Deserialize, Default, Clone)]
105#[serde(transparent)]
106pub struct KeymapAction(Value);
107
108impl std::fmt::Display for KeymapAction {
109 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
110 match &self.0 {
111 Value::String(s) => write!(f, "{}", s),
112 Value::Array(arr) => {
113 let strings: Vec<String> = arr.iter().map(|v| v.to_string()).collect();
114 write!(f, "{}", strings.join(", "))
115 }
116 _ => write!(f, "{}", self.0),
117 }
118 }
119}
120
121impl JsonSchema for KeymapAction {
122 /// This is used when generating the JSON schema for the `KeymapAction` type, so that it can
123 /// reference the keymap action schema.
124 fn schema_name() -> Cow<'static, str> {
125 "KeymapAction".into()
126 }
127
128 /// This schema will be replaced with the full action schema in
129 /// `KeymapFile::generate_json_schema`.
130 fn json_schema(_: &mut schemars::SchemaGenerator) -> schemars::Schema {
131 json_schema!(true)
132 }
133}
134
135#[derive(Debug)]
136#[must_use]
137pub enum KeymapFileLoadResult {
138 Success {
139 key_bindings: Vec<KeyBinding>,
140 },
141 SomeFailedToLoad {
142 key_bindings: Vec<KeyBinding>,
143 error_message: MarkdownString,
144 },
145 JsonParseFailure {
146 error: anyhow::Error,
147 },
148}
149
150impl KeymapFile {
151 pub fn parse(content: &str) -> anyhow::Result<Self> {
152 parse_json_with_comments::<Self>(content)
153 }
154
155 pub fn load_asset(
156 asset_path: &str,
157 source: Option<KeybindSource>,
158 cx: &App,
159 ) -> anyhow::Result<Vec<KeyBinding>> {
160 match Self::load(asset_str::<SettingsAssets>(asset_path).as_ref(), cx) {
161 KeymapFileLoadResult::Success { mut key_bindings } => match source {
162 Some(source) => Ok({
163 for key_binding in &mut key_bindings {
164 key_binding.set_meta(source.meta());
165 }
166 key_bindings
167 }),
168 None => Ok(key_bindings),
169 },
170 KeymapFileLoadResult::SomeFailedToLoad { error_message, .. } => {
171 anyhow::bail!("Error loading built-in keymap \"{asset_path}\": {error_message}",)
172 }
173 KeymapFileLoadResult::JsonParseFailure { error } => {
174 anyhow::bail!("JSON parse error in built-in keymap \"{asset_path}\": {error}")
175 }
176 }
177 }
178
179 #[cfg(feature = "test-support")]
180 pub fn load_asset_allow_partial_failure(
181 asset_path: &str,
182 cx: &App,
183 ) -> anyhow::Result<Vec<KeyBinding>> {
184 match Self::load(asset_str::<SettingsAssets>(asset_path).as_ref(), cx) {
185 KeymapFileLoadResult::SomeFailedToLoad {
186 key_bindings,
187 error_message,
188 ..
189 } if key_bindings.is_empty() => {
190 anyhow::bail!("Error loading built-in keymap \"{asset_path}\": {error_message}",)
191 }
192 KeymapFileLoadResult::Success { key_bindings, .. }
193 | KeymapFileLoadResult::SomeFailedToLoad { key_bindings, .. } => Ok(key_bindings),
194 KeymapFileLoadResult::JsonParseFailure { error } => {
195 anyhow::bail!("JSON parse error in built-in keymap \"{asset_path}\": {error}")
196 }
197 }
198 }
199
200 #[cfg(feature = "test-support")]
201 pub fn load_panic_on_failure(content: &str, cx: &App) -> Vec<KeyBinding> {
202 match Self::load(content, cx) {
203 KeymapFileLoadResult::Success { key_bindings, .. } => key_bindings,
204 KeymapFileLoadResult::SomeFailedToLoad { error_message, .. } => {
205 panic!("{error_message}");
206 }
207 KeymapFileLoadResult::JsonParseFailure { error } => {
208 panic!("JSON parse error: {error}");
209 }
210 }
211 }
212
213 pub fn load(content: &str, cx: &App) -> KeymapFileLoadResult {
214 let key_equivalents =
215 crate::key_equivalents::get_key_equivalents(cx.keyboard_layout().id());
216
217 if content.is_empty() {
218 return KeymapFileLoadResult::Success {
219 key_bindings: Vec::new(),
220 };
221 }
222 let keymap_file = match Self::parse(content) {
223 Ok(keymap_file) => keymap_file,
224 Err(error) => {
225 return KeymapFileLoadResult::JsonParseFailure { error };
226 }
227 };
228
229 // Accumulate errors in order to support partial load of user keymap in the presence of
230 // errors in context and binding parsing.
231 let mut errors = Vec::new();
232 let mut key_bindings = Vec::new();
233
234 for KeymapSection {
235 context,
236 use_key_equivalents,
237 bindings,
238 unrecognized_fields,
239 } in keymap_file.0.iter()
240 {
241 let context_predicate: Option<Rc<KeyBindingContextPredicate>> = if context.is_empty() {
242 None
243 } else {
244 match KeyBindingContextPredicate::parse(context) {
245 Ok(context_predicate) => Some(context_predicate.into()),
246 Err(err) => {
247 // Leading space is to separate from the message indicating which section
248 // the error occurred in.
249 errors.push((
250 context,
251 format!(" Parse error in section `context` field: {}", err),
252 ));
253 continue;
254 }
255 }
256 };
257
258 let key_equivalents = if *use_key_equivalents {
259 key_equivalents.as_ref()
260 } else {
261 None
262 };
263
264 let mut section_errors = String::new();
265
266 if !unrecognized_fields.is_empty() {
267 write!(
268 section_errors,
269 "\n\n - Unrecognized fields: {}",
270 MarkdownInlineCode(&format!("{:?}", unrecognized_fields.keys()))
271 )
272 .unwrap();
273 }
274
275 if let Some(bindings) = bindings {
276 for (keystrokes, action) in bindings {
277 let result = Self::load_keybinding(
278 keystrokes,
279 action,
280 context_predicate.clone(),
281 key_equivalents,
282 cx,
283 );
284 match result {
285 Ok(key_binding) => {
286 key_bindings.push(key_binding);
287 }
288 Err(err) => {
289 let mut lines = err.lines();
290 let mut indented_err = lines.next().unwrap().to_string();
291 for line in lines {
292 indented_err.push_str(" ");
293 indented_err.push_str(line);
294 indented_err.push_str("\n");
295 }
296 write!(
297 section_errors,
298 "\n\n- In binding {}, {indented_err}",
299 MarkdownInlineCode(&format!("\"{}\"", keystrokes))
300 )
301 .unwrap();
302 }
303 }
304 }
305 }
306
307 if !section_errors.is_empty() {
308 errors.push((context, section_errors))
309 }
310 }
311
312 if errors.is_empty() {
313 KeymapFileLoadResult::Success { key_bindings }
314 } else {
315 let mut error_message = "Errors in user keymap file.\n".to_owned();
316 for (context, section_errors) in errors {
317 if context.is_empty() {
318 let _ = write!(error_message, "\n\nIn section without context predicate:");
319 } else {
320 let _ = write!(
321 error_message,
322 "\n\nIn section with {}:",
323 MarkdownInlineCode(&format!("context = \"{}\"", context))
324 );
325 }
326 let _ = write!(error_message, "{section_errors}");
327 }
328 KeymapFileLoadResult::SomeFailedToLoad {
329 key_bindings,
330 error_message: MarkdownString(error_message),
331 }
332 }
333 }
334
335 fn load_keybinding(
336 keystrokes: &str,
337 action: &KeymapAction,
338 context: Option<Rc<KeyBindingContextPredicate>>,
339 key_equivalents: Option<&HashMap<char, char>>,
340 cx: &App,
341 ) -> std::result::Result<KeyBinding, String> {
342 let (build_result, action_input_string) = match &action.0 {
343 Value::Array(items) => {
344 if items.len() != 2 {
345 return Err(format!(
346 "expected two-element array of `[name, input]`. \
347 Instead found {}.",
348 MarkdownInlineCode(&action.0.to_string())
349 ));
350 }
351 let serde_json::Value::String(ref name) = items[0] else {
352 return Err(format!(
353 "expected two-element array of `[name, input]`, \
354 but the first element is not a string in {}.",
355 MarkdownInlineCode(&action.0.to_string())
356 ));
357 };
358 let action_input = items[1].clone();
359 let action_input_string = action_input.to_string();
360 (
361 cx.build_action(&name, Some(action_input)),
362 Some(action_input_string),
363 )
364 }
365 Value::String(name) => (cx.build_action(&name, None), None),
366 Value::Null => (Ok(NoAction.boxed_clone()), None),
367 _ => {
368 return Err(format!(
369 "expected two-element array of `[name, input]`. \
370 Instead found {}.",
371 MarkdownInlineCode(&action.0.to_string())
372 ));
373 }
374 };
375
376 let action = match build_result {
377 Ok(action) => action,
378 Err(ActionBuildError::NotFound { name }) => {
379 return Err(format!(
380 "didn't find an action named {}.",
381 MarkdownInlineCode(&format!("\"{}\"", &name))
382 ));
383 }
384 Err(ActionBuildError::BuildError { name, error }) => match action_input_string {
385 Some(action_input_string) => {
386 return Err(format!(
387 "can't build {} action from input value {}: {}",
388 MarkdownInlineCode(&format!("\"{}\"", &name)),
389 MarkdownInlineCode(&action_input_string),
390 MarkdownEscaped(&error.to_string())
391 ));
392 }
393 None => {
394 return Err(format!(
395 "can't build {} action - it requires input data via [name, input]: {}",
396 MarkdownInlineCode(&format!("\"{}\"", &name)),
397 MarkdownEscaped(&error.to_string())
398 ));
399 }
400 },
401 };
402
403 let key_binding = match KeyBinding::load(
404 keystrokes,
405 action,
406 context,
407 key_equivalents,
408 action_input_string.map(SharedString::from),
409 ) {
410 Ok(key_binding) => key_binding,
411 Err(InvalidKeystrokeError { keystroke }) => {
412 return Err(format!(
413 "invalid keystroke {}. {}",
414 MarkdownInlineCode(&format!("\"{}\"", &keystroke)),
415 KEYSTROKE_PARSE_EXPECTED_MESSAGE
416 ));
417 }
418 };
419
420 if let Some(validator) = KEY_BINDING_VALIDATORS.get(&key_binding.action().type_id()) {
421 match validator.validate(&key_binding) {
422 Ok(()) => Ok(key_binding),
423 Err(error) => Err(error.0),
424 }
425 } else {
426 Ok(key_binding)
427 }
428 }
429
430 /// Creates a JSON schema generator, suitable for generating json schemas
431 /// for actions
432 pub fn action_schema_generator() -> schemars::SchemaGenerator {
433 schemars::generate::SchemaSettings::draft2019_09().into_generator()
434 }
435
436 pub fn generate_json_schema_for_registered_actions(cx: &mut App) -> Value {
437 // instead of using DefaultDenyUnknownFields, actions typically use
438 // `#[serde(deny_unknown_fields)]` so that these cases are reported as parse failures. This
439 // is because the rest of the keymap will still load in these cases, whereas other settings
440 // files would not.
441 let mut generator = Self::action_schema_generator();
442
443 let action_schemas = cx.action_schemas(&mut generator);
444 let deprecations = cx.deprecated_actions_to_preferred_actions();
445 let deprecation_messages = cx.action_deprecation_messages();
446 KeymapFile::generate_json_schema(
447 generator,
448 action_schemas,
449 deprecations,
450 deprecation_messages,
451 )
452 }
453
454 fn generate_json_schema(
455 mut generator: schemars::SchemaGenerator,
456 action_schemas: Vec<(&'static str, Option<schemars::Schema>)>,
457 deprecations: &HashMap<&'static str, &'static str>,
458 deprecation_messages: &HashMap<&'static str, &'static str>,
459 ) -> serde_json::Value {
460 fn add_deprecation(schema: &mut schemars::Schema, message: String) {
461 schema.insert(
462 // deprecationMessage is not part of the JSON Schema spec, but
463 // json-language-server recognizes it.
464 "deprecationMessage".to_string(),
465 Value::String(message),
466 );
467 }
468
469 fn add_deprecation_preferred_name(schema: &mut schemars::Schema, new_name: &str) {
470 add_deprecation(schema, format!("Deprecated, use {new_name}"));
471 }
472
473 fn add_description(schema: &mut schemars::Schema, description: String) {
474 schema.insert("description".to_string(), Value::String(description));
475 }
476
477 let empty_object = json_schema!({
478 "type": "object"
479 });
480
481 // This is a workaround for a json-language-server issue where it matches the first
482 // alternative that matches the value's shape and uses that for documentation.
483 //
484 // In the case of the array validations, it would even provide an error saying that the name
485 // must match the name of the first alternative.
486 let mut plain_action = json_schema!({
487 "type": "string",
488 "const": ""
489 });
490 let no_action_message = "No action named this.";
491 add_description(&mut plain_action, no_action_message.to_owned());
492 add_deprecation(&mut plain_action, no_action_message.to_owned());
493
494 let mut matches_action_name = json_schema!({
495 "const": ""
496 });
497 let no_action_message_input = "No action named this that takes input.";
498 add_description(&mut matches_action_name, no_action_message_input.to_owned());
499 add_deprecation(&mut matches_action_name, no_action_message_input.to_owned());
500
501 let action_with_input = json_schema!({
502 "type": "array",
503 "items": [
504 matches_action_name,
505 true
506 ],
507 "minItems": 2,
508 "maxItems": 2
509 });
510 let mut keymap_action_alternatives = vec![plain_action, action_with_input];
511
512 for (name, action_schema) in action_schemas.into_iter() {
513 let description = action_schema.as_ref().and_then(|schema| {
514 schema
515 .as_object()
516 .and_then(|obj| obj.get("description"))
517 .and_then(|v| v.as_str())
518 .map(|s| s.to_string())
519 });
520
521 let deprecation = if name == NoAction.name() {
522 Some("null")
523 } else {
524 deprecations.get(name).copied()
525 };
526
527 // Add an alternative for plain action names.
528 let mut plain_action = json_schema!({
529 "type": "string",
530 "const": name
531 });
532 if let Some(message) = deprecation_messages.get(name) {
533 add_deprecation(&mut plain_action, message.to_string());
534 } else if let Some(new_name) = deprecation {
535 add_deprecation_preferred_name(&mut plain_action, new_name);
536 }
537 if let Some(desc) = description.clone() {
538 add_description(&mut plain_action, desc);
539 }
540 keymap_action_alternatives.push(plain_action);
541
542 // Add an alternative for actions with data specified as a [name, data] array.
543 //
544 // When a struct with no deserializable fields is added by deriving `Action`, an empty
545 // object schema is produced. The action should be invoked without data in this case.
546 if let Some(schema) = action_schema {
547 if schema != empty_object {
548 let mut matches_action_name = json_schema!({
549 "const": name
550 });
551 if let Some(desc) = description.clone() {
552 add_description(&mut matches_action_name, desc);
553 }
554 if let Some(message) = deprecation_messages.get(name) {
555 add_deprecation(&mut matches_action_name, message.to_string());
556 } else if let Some(new_name) = deprecation {
557 add_deprecation_preferred_name(&mut matches_action_name, new_name);
558 }
559 let action_with_input = json_schema!({
560 "type": "array",
561 "items": [matches_action_name, schema],
562 "minItems": 2,
563 "maxItems": 2
564 });
565 keymap_action_alternatives.push(action_with_input);
566 }
567 }
568 }
569
570 // Placing null first causes json-language-server to default assuming actions should be
571 // null, so place it last.
572 keymap_action_alternatives.push(json_schema!({
573 "type": "null"
574 }));
575
576 // The `KeymapSection` schema will reference the `KeymapAction` schema by name, so setting
577 // the definition of `KeymapAction` results in the full action schema being used.
578 generator.definitions_mut().insert(
579 KeymapAction::schema_name().to_string(),
580 json!({
581 "oneOf": keymap_action_alternatives
582 }),
583 );
584
585 generator.root_schema_for::<KeymapFile>().to_value()
586 }
587
588 pub fn sections(&self) -> impl DoubleEndedIterator<Item = &KeymapSection> {
589 self.0.iter()
590 }
591
592 pub async fn load_keymap_file(fs: &Arc<dyn Fs>) -> Result<String> {
593 match fs.load(paths::keymap_file()).await {
594 result @ Ok(_) => result,
595 Err(err) => {
596 if let Some(e) = err.downcast_ref::<std::io::Error>() {
597 if e.kind() == std::io::ErrorKind::NotFound {
598 return Ok(crate::initial_keymap_content().to_string());
599 }
600 }
601 Err(err)
602 }
603 }
604 }
605
606 pub fn update_keybinding<'a>(
607 mut operation: KeybindUpdateOperation<'a>,
608 mut keymap_contents: String,
609 tab_size: usize,
610 ) -> Result<String> {
611 match operation {
612 // if trying to replace a keybinding that is not user-defined, treat it as an add operation
613 KeybindUpdateOperation::Replace {
614 target_keybind_source: target_source,
615 source,
616 target,
617 } if target_source != KeybindSource::User => {
618 operation = KeybindUpdateOperation::Add {
619 source,
620 from: Some(target),
621 };
622 }
623 // if trying to remove a keybinding that is not user-defined, treat it as creating a binding
624 // that binds it to `zed::NoAction`
625 KeybindUpdateOperation::Remove {
626 target,
627 target_keybind_source,
628 } if target_keybind_source != KeybindSource::User => {
629 let mut source = target.clone();
630 source.action_name = gpui::NoAction.name();
631 source.action_arguments.take();
632 operation = KeybindUpdateOperation::Add {
633 source,
634 from: Some(target),
635 };
636 }
637 _ => {}
638 }
639
640 // Sanity check that keymap contents are valid, even though we only use it for Replace.
641 // We don't want to modify the file if it's invalid.
642 let keymap = Self::parse(&keymap_contents).context("Failed to parse keymap")?;
643
644 if let KeybindUpdateOperation::Remove { target, .. } = operation {
645 let target_action_value = target
646 .action_value()
647 .context("Failed to generate target action JSON value")?;
648 let Some((index, keystrokes_str)) =
649 find_binding(&keymap, &target, &target_action_value)
650 else {
651 anyhow::bail!("Failed to find keybinding to remove");
652 };
653 let is_only_binding = keymap.0[index]
654 .bindings
655 .as_ref()
656 .map_or(true, |bindings| bindings.len() == 1);
657 let key_path: &[&str] = if is_only_binding {
658 &[]
659 } else {
660 &["bindings", keystrokes_str]
661 };
662 let (replace_range, replace_value) = replace_top_level_array_value_in_json_text(
663 &keymap_contents,
664 key_path,
665 None,
666 None,
667 index,
668 tab_size,
669 )
670 .context("Failed to remove keybinding")?;
671 keymap_contents.replace_range(replace_range, &replace_value);
672 return Ok(keymap_contents);
673 }
674
675 if let KeybindUpdateOperation::Replace { source, target, .. } = operation {
676 let target_action_value = target
677 .action_value()
678 .context("Failed to generate target action JSON value")?;
679 let source_action_value = source
680 .action_value()
681 .context("Failed to generate source action JSON value")?;
682
683 if let Some((index, keystrokes_str)) =
684 find_binding(&keymap, &target, &target_action_value)
685 {
686 if target.context == source.context {
687 // if we are only changing the keybinding (common case)
688 // not the context, etc. Then just update the binding in place
689
690 let (replace_range, replace_value) =
691 replace_top_level_array_value_in_json_text(
692 &keymap_contents,
693 &["bindings", keystrokes_str],
694 Some(&source_action_value),
695 Some(&source.keystrokes_unparsed()),
696 index,
697 tab_size,
698 )
699 .context("Failed to replace keybinding")?;
700 keymap_contents.replace_range(replace_range, &replace_value);
701
702 return Ok(keymap_contents);
703 } else if keymap.0[index]
704 .bindings
705 .as_ref()
706 .map_or(true, |bindings| bindings.len() == 1)
707 {
708 // if we are replacing the only binding in the section,
709 // just update the section in place, updating the context
710 // and the binding
711
712 let (replace_range, replace_value) =
713 replace_top_level_array_value_in_json_text(
714 &keymap_contents,
715 &["bindings", keystrokes_str],
716 Some(&source_action_value),
717 Some(&source.keystrokes_unparsed()),
718 index,
719 tab_size,
720 )
721 .context("Failed to replace keybinding")?;
722 keymap_contents.replace_range(replace_range, &replace_value);
723
724 let (replace_range, replace_value) =
725 replace_top_level_array_value_in_json_text(
726 &keymap_contents,
727 &["context"],
728 source.context.map(Into::into).as_ref(),
729 None,
730 index,
731 tab_size,
732 )
733 .context("Failed to replace keybinding")?;
734 keymap_contents.replace_range(replace_range, &replace_value);
735 return Ok(keymap_contents);
736 } else {
737 // if we are replacing one of multiple bindings in a section
738 // with a context change, remove the existing binding from the
739 // section, then treat this operation as an add operation of the
740 // new binding with the updated context.
741
742 let (replace_range, replace_value) =
743 replace_top_level_array_value_in_json_text(
744 &keymap_contents,
745 &["bindings", keystrokes_str],
746 None,
747 None,
748 index,
749 tab_size,
750 )
751 .context("Failed to replace keybinding")?;
752 keymap_contents.replace_range(replace_range, &replace_value);
753 operation = KeybindUpdateOperation::Add {
754 source,
755 from: Some(target),
756 };
757 }
758 } else {
759 log::warn!(
760 "Failed to find keybinding to update `{:?} -> {}` creating new binding for `{:?} -> {}` instead",
761 target.keystrokes,
762 target_action_value,
763 source.keystrokes,
764 source_action_value,
765 );
766 operation = KeybindUpdateOperation::Add {
767 source,
768 from: Some(target),
769 };
770 }
771 }
772
773 if let KeybindUpdateOperation::Add {
774 source: keybinding,
775 from,
776 } = operation
777 {
778 let mut value = serde_json::Map::with_capacity(4);
779 if let Some(context) = keybinding.context {
780 value.insert("context".to_string(), context.into());
781 }
782 let use_key_equivalents = from.and_then(|from| {
783 let action_value = from.action_value().context("Failed to serialize action value. `use_key_equivalents` on new keybinding may be incorrect.").log_err()?;
784 let (index, _) = find_binding(&keymap, &from, &action_value)?;
785 Some(keymap.0[index].use_key_equivalents)
786 }).unwrap_or(false);
787 if use_key_equivalents {
788 value.insert("use_key_equivalents".to_string(), true.into());
789 }
790
791 value.insert("bindings".to_string(), {
792 let mut bindings = serde_json::Map::new();
793 let action = keybinding.action_value()?;
794 bindings.insert(keybinding.keystrokes_unparsed(), action);
795 bindings.into()
796 });
797
798 let (replace_range, replace_value) = append_top_level_array_value_in_json_text(
799 &keymap_contents,
800 &value.into(),
801 tab_size,
802 )?;
803 keymap_contents.replace_range(replace_range, &replace_value);
804 }
805 return Ok(keymap_contents);
806
807 fn find_binding<'a, 'b>(
808 keymap: &'b KeymapFile,
809 target: &KeybindUpdateTarget<'a>,
810 target_action_value: &Value,
811 ) -> Option<(usize, &'b str)> {
812 let target_context_parsed =
813 KeyBindingContextPredicate::parse(target.context.unwrap_or("")).ok();
814 for (index, section) in keymap.sections().enumerate() {
815 let section_context_parsed =
816 KeyBindingContextPredicate::parse(§ion.context).ok();
817 if section_context_parsed != target_context_parsed {
818 continue;
819 }
820 let Some(bindings) = §ion.bindings else {
821 continue;
822 };
823 for (keystrokes_str, action) in bindings {
824 let Ok(keystrokes) = keystrokes_str
825 .split_whitespace()
826 .map(Keystroke::parse)
827 .collect::<Result<Vec<_>, _>>()
828 else {
829 continue;
830 };
831 if keystrokes.len() != target.keystrokes.len()
832 || !keystrokes
833 .iter()
834 .zip(target.keystrokes)
835 .all(|(a, b)| a.should_match(b))
836 {
837 continue;
838 }
839 if &action.0 != target_action_value {
840 continue;
841 }
842 return Some((index, &keystrokes_str));
843 }
844 }
845 None
846 }
847 }
848}
849
850pub enum KeybindUpdateOperation<'a> {
851 Replace {
852 /// Describes the keybind to create
853 source: KeybindUpdateTarget<'a>,
854 /// Describes the keybind to remove
855 target: KeybindUpdateTarget<'a>,
856 target_keybind_source: KeybindSource,
857 },
858 Add {
859 source: KeybindUpdateTarget<'a>,
860 from: Option<KeybindUpdateTarget<'a>>,
861 },
862 Remove {
863 target: KeybindUpdateTarget<'a>,
864 target_keybind_source: KeybindSource,
865 },
866}
867
868impl<'a> KeybindUpdateOperation<'a> {
869 pub fn add(source: KeybindUpdateTarget<'a>) -> Self {
870 Self::Add { source, from: None }
871 }
872}
873
874#[derive(Debug, Clone)]
875pub struct KeybindUpdateTarget<'a> {
876 pub context: Option<&'a str>,
877 pub keystrokes: &'a [Keystroke],
878 pub action_name: &'a str,
879 pub action_arguments: Option<&'a str>,
880}
881
882impl<'a> KeybindUpdateTarget<'a> {
883 fn action_value(&self) -> Result<Value> {
884 let action_name: Value = self.action_name.into();
885 let value = match self.action_arguments {
886 Some(args) => {
887 let args = serde_json::from_str::<Value>(args)
888 .context("Failed to parse action arguments as JSON")?;
889 serde_json::json!([action_name, args])
890 }
891 None => action_name,
892 };
893 return Ok(value);
894 }
895
896 fn keystrokes_unparsed(&self) -> String {
897 let mut keystrokes = String::with_capacity(self.keystrokes.len() * 8);
898 for keystroke in self.keystrokes {
899 keystrokes.push_str(&keystroke.unparse());
900 keystrokes.push(' ');
901 }
902 keystrokes.pop();
903 keystrokes
904 }
905}
906
907#[derive(Clone, Copy, PartialEq, Eq)]
908pub enum KeybindSource {
909 User,
910 Default,
911 Base,
912 Vim,
913}
914
915impl KeybindSource {
916 const BASE: KeyBindingMetaIndex = KeyBindingMetaIndex(0);
917 const DEFAULT: KeyBindingMetaIndex = KeyBindingMetaIndex(1);
918 const VIM: KeyBindingMetaIndex = KeyBindingMetaIndex(2);
919 const USER: KeyBindingMetaIndex = KeyBindingMetaIndex(3);
920
921 pub fn name(&self) -> &'static str {
922 match self {
923 KeybindSource::User => "User",
924 KeybindSource::Default => "Default",
925 KeybindSource::Base => "Base",
926 KeybindSource::Vim => "Vim",
927 }
928 }
929
930 pub fn meta(&self) -> KeyBindingMetaIndex {
931 match self {
932 KeybindSource::User => Self::USER,
933 KeybindSource::Default => Self::DEFAULT,
934 KeybindSource::Base => Self::BASE,
935 KeybindSource::Vim => Self::VIM,
936 }
937 }
938
939 pub fn from_meta(index: KeyBindingMetaIndex) -> Self {
940 match index {
941 Self::USER => KeybindSource::User,
942 Self::BASE => KeybindSource::Base,
943 Self::DEFAULT => KeybindSource::Default,
944 Self::VIM => KeybindSource::Vim,
945 _ => unreachable!(),
946 }
947 }
948}
949
950impl From<KeyBindingMetaIndex> for KeybindSource {
951 fn from(index: KeyBindingMetaIndex) -> Self {
952 Self::from_meta(index)
953 }
954}
955
956impl From<KeybindSource> for KeyBindingMetaIndex {
957 fn from(source: KeybindSource) -> Self {
958 return source.meta();
959 }
960}
961
962#[cfg(test)]
963mod tests {
964 use gpui::Keystroke;
965 use unindent::Unindent;
966
967 use crate::{
968 KeybindSource, KeymapFile,
969 keymap_file::{KeybindUpdateOperation, KeybindUpdateTarget},
970 };
971
972 #[test]
973 fn can_deserialize_keymap_with_trailing_comma() {
974 let json = indoc::indoc! {"[
975 // Standard macOS bindings
976 {
977 \"bindings\": {
978 \"up\": \"menu::SelectPrevious\",
979 },
980 },
981 ]
982 "
983 };
984 KeymapFile::parse(json).unwrap();
985 }
986
987 #[track_caller]
988 fn check_keymap_update(
989 input: impl ToString,
990 operation: KeybindUpdateOperation,
991 expected: impl ToString,
992 ) {
993 let result = KeymapFile::update_keybinding(operation, input.to_string(), 4)
994 .expect("Update succeeded");
995 pretty_assertions::assert_eq!(expected.to_string(), result);
996 }
997
998 #[track_caller]
999 fn parse_keystrokes(keystrokes: &str) -> Vec<Keystroke> {
1000 return keystrokes
1001 .split(' ')
1002 .map(|s| Keystroke::parse(s).expect("Keystrokes valid"))
1003 .collect();
1004 }
1005
1006 #[test]
1007 fn keymap_update() {
1008 zlog::init_test();
1009
1010 check_keymap_update(
1011 "[]",
1012 KeybindUpdateOperation::add(KeybindUpdateTarget {
1013 keystrokes: &parse_keystrokes("ctrl-a"),
1014 action_name: "zed::SomeAction",
1015 context: None,
1016 action_arguments: None,
1017 }),
1018 r#"[
1019 {
1020 "bindings": {
1021 "ctrl-a": "zed::SomeAction"
1022 }
1023 }
1024 ]"#
1025 .unindent(),
1026 );
1027
1028 check_keymap_update(
1029 r#"[
1030 {
1031 "bindings": {
1032 "ctrl-a": "zed::SomeAction"
1033 }
1034 }
1035 ]"#
1036 .unindent(),
1037 KeybindUpdateOperation::add(KeybindUpdateTarget {
1038 keystrokes: &parse_keystrokes("ctrl-b"),
1039 action_name: "zed::SomeOtherAction",
1040 context: None,
1041 action_arguments: None,
1042 }),
1043 r#"[
1044 {
1045 "bindings": {
1046 "ctrl-a": "zed::SomeAction"
1047 }
1048 },
1049 {
1050 "bindings": {
1051 "ctrl-b": "zed::SomeOtherAction"
1052 }
1053 }
1054 ]"#
1055 .unindent(),
1056 );
1057
1058 check_keymap_update(
1059 r#"[
1060 {
1061 "bindings": {
1062 "ctrl-a": "zed::SomeAction"
1063 }
1064 }
1065 ]"#
1066 .unindent(),
1067 KeybindUpdateOperation::add(KeybindUpdateTarget {
1068 keystrokes: &parse_keystrokes("ctrl-b"),
1069 action_name: "zed::SomeOtherAction",
1070 context: None,
1071 action_arguments: Some(r#"{"foo": "bar"}"#),
1072 }),
1073 r#"[
1074 {
1075 "bindings": {
1076 "ctrl-a": "zed::SomeAction"
1077 }
1078 },
1079 {
1080 "bindings": {
1081 "ctrl-b": [
1082 "zed::SomeOtherAction",
1083 {
1084 "foo": "bar"
1085 }
1086 ]
1087 }
1088 }
1089 ]"#
1090 .unindent(),
1091 );
1092
1093 check_keymap_update(
1094 r#"[
1095 {
1096 "bindings": {
1097 "ctrl-a": "zed::SomeAction"
1098 }
1099 }
1100 ]"#
1101 .unindent(),
1102 KeybindUpdateOperation::add(KeybindUpdateTarget {
1103 keystrokes: &parse_keystrokes("ctrl-b"),
1104 action_name: "zed::SomeOtherAction",
1105 context: Some("Zed > Editor && some_condition = true"),
1106 action_arguments: Some(r#"{"foo": "bar"}"#),
1107 }),
1108 r#"[
1109 {
1110 "bindings": {
1111 "ctrl-a": "zed::SomeAction"
1112 }
1113 },
1114 {
1115 "context": "Zed > Editor && some_condition = true",
1116 "bindings": {
1117 "ctrl-b": [
1118 "zed::SomeOtherAction",
1119 {
1120 "foo": "bar"
1121 }
1122 ]
1123 }
1124 }
1125 ]"#
1126 .unindent(),
1127 );
1128
1129 check_keymap_update(
1130 r#"[
1131 {
1132 "bindings": {
1133 "ctrl-a": "zed::SomeAction"
1134 }
1135 }
1136 ]"#
1137 .unindent(),
1138 KeybindUpdateOperation::Replace {
1139 target: KeybindUpdateTarget {
1140 keystrokes: &parse_keystrokes("ctrl-a"),
1141 action_name: "zed::SomeAction",
1142 context: None,
1143 action_arguments: None,
1144 },
1145 source: KeybindUpdateTarget {
1146 keystrokes: &parse_keystrokes("ctrl-b"),
1147 action_name: "zed::SomeOtherAction",
1148 context: None,
1149 action_arguments: Some(r#"{"foo": "bar"}"#),
1150 },
1151 target_keybind_source: KeybindSource::Base,
1152 },
1153 r#"[
1154 {
1155 "bindings": {
1156 "ctrl-a": "zed::SomeAction"
1157 }
1158 },
1159 {
1160 "bindings": {
1161 "ctrl-b": [
1162 "zed::SomeOtherAction",
1163 {
1164 "foo": "bar"
1165 }
1166 ]
1167 }
1168 }
1169 ]"#
1170 .unindent(),
1171 );
1172
1173 check_keymap_update(
1174 r#"[
1175 {
1176 "bindings": {
1177 "a": "zed::SomeAction"
1178 }
1179 }
1180 ]"#
1181 .unindent(),
1182 KeybindUpdateOperation::Replace {
1183 target: KeybindUpdateTarget {
1184 keystrokes: &parse_keystrokes("a"),
1185 action_name: "zed::SomeAction",
1186 context: None,
1187 action_arguments: None,
1188 },
1189 source: KeybindUpdateTarget {
1190 keystrokes: &parse_keystrokes("ctrl-b"),
1191 action_name: "zed::SomeOtherAction",
1192 context: None,
1193 action_arguments: Some(r#"{"foo": "bar"}"#),
1194 },
1195 target_keybind_source: KeybindSource::User,
1196 },
1197 r#"[
1198 {
1199 "bindings": {
1200 "ctrl-b": [
1201 "zed::SomeOtherAction",
1202 {
1203 "foo": "bar"
1204 }
1205 ]
1206 }
1207 }
1208 ]"#
1209 .unindent(),
1210 );
1211
1212 check_keymap_update(
1213 r#"[
1214 {
1215 "bindings": {
1216 "ctrl-a": "zed::SomeAction"
1217 }
1218 }
1219 ]"#
1220 .unindent(),
1221 KeybindUpdateOperation::Replace {
1222 target: KeybindUpdateTarget {
1223 keystrokes: &parse_keystrokes("ctrl-a"),
1224 action_name: "zed::SomeNonexistentAction",
1225 context: None,
1226 action_arguments: None,
1227 },
1228 source: KeybindUpdateTarget {
1229 keystrokes: &parse_keystrokes("ctrl-b"),
1230 action_name: "zed::SomeOtherAction",
1231 context: None,
1232 action_arguments: None,
1233 },
1234 target_keybind_source: KeybindSource::User,
1235 },
1236 r#"[
1237 {
1238 "bindings": {
1239 "ctrl-a": "zed::SomeAction"
1240 }
1241 },
1242 {
1243 "bindings": {
1244 "ctrl-b": "zed::SomeOtherAction"
1245 }
1246 }
1247 ]"#
1248 .unindent(),
1249 );
1250
1251 check_keymap_update(
1252 r#"[
1253 {
1254 "bindings": {
1255 // some comment
1256 "ctrl-a": "zed::SomeAction"
1257 // some other comment
1258 }
1259 }
1260 ]"#
1261 .unindent(),
1262 KeybindUpdateOperation::Replace {
1263 target: KeybindUpdateTarget {
1264 keystrokes: &parse_keystrokes("ctrl-a"),
1265 action_name: "zed::SomeAction",
1266 context: None,
1267 action_arguments: None,
1268 },
1269 source: KeybindUpdateTarget {
1270 keystrokes: &parse_keystrokes("ctrl-b"),
1271 action_name: "zed::SomeOtherAction",
1272 context: None,
1273 action_arguments: Some(r#"{"foo": "bar"}"#),
1274 },
1275 target_keybind_source: KeybindSource::User,
1276 },
1277 r#"[
1278 {
1279 "bindings": {
1280 // some comment
1281 "ctrl-b": [
1282 "zed::SomeOtherAction",
1283 {
1284 "foo": "bar"
1285 }
1286 ]
1287 // some other comment
1288 }
1289 }
1290 ]"#
1291 .unindent(),
1292 );
1293
1294 check_keymap_update(
1295 r#"[
1296 {
1297 "context": "SomeContext",
1298 "bindings": {
1299 "a": "foo::bar",
1300 "b": "baz::qux",
1301 }
1302 }
1303 ]"#
1304 .unindent(),
1305 KeybindUpdateOperation::Replace {
1306 target: KeybindUpdateTarget {
1307 keystrokes: &parse_keystrokes("a"),
1308 action_name: "foo::bar",
1309 context: Some("SomeContext"),
1310 action_arguments: None,
1311 },
1312 source: KeybindUpdateTarget {
1313 keystrokes: &parse_keystrokes("c"),
1314 action_name: "foo::baz",
1315 context: Some("SomeOtherContext"),
1316 action_arguments: None,
1317 },
1318 target_keybind_source: KeybindSource::User,
1319 },
1320 r#"[
1321 {
1322 "context": "SomeContext",
1323 "bindings": {
1324 "b": "baz::qux",
1325 }
1326 },
1327 {
1328 "context": "SomeOtherContext",
1329 "bindings": {
1330 "c": "foo::baz"
1331 }
1332 }
1333 ]"#
1334 .unindent(),
1335 );
1336
1337 check_keymap_update(
1338 r#"[
1339 {
1340 "context": "SomeContext",
1341 "bindings": {
1342 "a": "foo::bar",
1343 }
1344 }
1345 ]"#
1346 .unindent(),
1347 KeybindUpdateOperation::Replace {
1348 target: KeybindUpdateTarget {
1349 keystrokes: &parse_keystrokes("a"),
1350 action_name: "foo::bar",
1351 context: Some("SomeContext"),
1352 action_arguments: None,
1353 },
1354 source: KeybindUpdateTarget {
1355 keystrokes: &parse_keystrokes("c"),
1356 action_name: "foo::baz",
1357 context: Some("SomeOtherContext"),
1358 action_arguments: None,
1359 },
1360 target_keybind_source: KeybindSource::User,
1361 },
1362 r#"[
1363 {
1364 "context": "SomeOtherContext",
1365 "bindings": {
1366 "c": "foo::baz",
1367 }
1368 }
1369 ]"#
1370 .unindent(),
1371 );
1372
1373 check_keymap_update(
1374 r#"[
1375 {
1376 "context": "SomeContext",
1377 "bindings": {
1378 "a": "foo::bar",
1379 "c": "foo::baz",
1380 }
1381 },
1382 ]"#
1383 .unindent(),
1384 KeybindUpdateOperation::Remove {
1385 target: KeybindUpdateTarget {
1386 context: Some("SomeContext"),
1387 keystrokes: &parse_keystrokes("a"),
1388 action_name: "foo::bar",
1389 action_arguments: None,
1390 },
1391 target_keybind_source: KeybindSource::User,
1392 },
1393 r#"[
1394 {
1395 "context": "SomeContext",
1396 "bindings": {
1397 "c": "foo::baz",
1398 }
1399 },
1400 ]"#
1401 .unindent(),
1402 );
1403
1404 check_keymap_update(
1405 r#"[
1406 {
1407 "context": "SomeContext",
1408 "bindings": {
1409 "a": ["foo::bar", true],
1410 "c": "foo::baz",
1411 }
1412 },
1413 ]"#
1414 .unindent(),
1415 KeybindUpdateOperation::Remove {
1416 target: KeybindUpdateTarget {
1417 context: Some("SomeContext"),
1418 keystrokes: &parse_keystrokes("a"),
1419 action_name: "foo::bar",
1420 action_arguments: Some("true"),
1421 },
1422 target_keybind_source: KeybindSource::User,
1423 },
1424 r#"[
1425 {
1426 "context": "SomeContext",
1427 "bindings": {
1428 "c": "foo::baz",
1429 }
1430 },
1431 ]"#
1432 .unindent(),
1433 );
1434
1435 check_keymap_update(
1436 r#"[
1437 {
1438 "context": "SomeContext",
1439 "bindings": {
1440 "b": "foo::baz",
1441 }
1442 },
1443 {
1444 "context": "SomeContext",
1445 "bindings": {
1446 "a": ["foo::bar", true],
1447 }
1448 },
1449 {
1450 "context": "SomeContext",
1451 "bindings": {
1452 "c": "foo::baz",
1453 }
1454 },
1455 ]"#
1456 .unindent(),
1457 KeybindUpdateOperation::Remove {
1458 target: KeybindUpdateTarget {
1459 context: Some("SomeContext"),
1460 keystrokes: &parse_keystrokes("a"),
1461 action_name: "foo::bar",
1462 action_arguments: Some("true"),
1463 },
1464 target_keybind_source: KeybindSource::User,
1465 },
1466 r#"[
1467 {
1468 "context": "SomeContext",
1469 "bindings": {
1470 "b": "foo::baz",
1471 }
1472 },
1473 {
1474 "context": "SomeContext",
1475 "bindings": {
1476 "c": "foo::baz",
1477 }
1478 },
1479 ]"#
1480 .unindent(),
1481 );
1482 }
1483
1484 #[test]
1485 fn test_append() {
1486 check_keymap_update(
1487 r#"[
1488 {
1489 "context": "SomeOtherContext",
1490 "use_key_equivalents": true,
1491 "bindings": {
1492 "b": "foo::bar",
1493 }
1494 },
1495 ]"#
1496 .unindent(),
1497 KeybindUpdateOperation::Add {
1498 source: KeybindUpdateTarget {
1499 context: Some("SomeContext"),
1500 keystrokes: &parse_keystrokes("a"),
1501 action_name: "foo::baz",
1502 action_arguments: Some("true"),
1503 },
1504 from: Some(KeybindUpdateTarget {
1505 context: Some("SomeOtherContext"),
1506 keystrokes: &parse_keystrokes("b"),
1507 action_name: "foo::bar",
1508 action_arguments: None,
1509 }),
1510 },
1511 r#"[
1512 {
1513 "context": "SomeOtherContext",
1514 "use_key_equivalents": true,
1515 "bindings": {
1516 "b": "foo::bar",
1517 }
1518 },
1519 {
1520 "context": "SomeContext",
1521 "use_key_equivalents": true,
1522 "bindings": {
1523 "a": [
1524 "foo::baz",
1525 true
1526 ]
1527 }
1528 }
1529 ]"#
1530 .unindent(),
1531 );
1532 }
1533}