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, KeybindingKeystroke, Keystroke,
7 NoAction, SharedString,
8};
9use schemars::{JsonSchema, json_schema};
10use serde::Deserialize;
11use serde_json::{Value, json};
12use std::borrow::Cow;
13use std::{any::TypeId, fmt::Write, rc::Rc, sync::Arc, sync::LazyLock};
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 // if trying to replace a keybinding that is not user-defined, treat it as an add operation
612 match operation {
613 KeybindUpdateOperation::Replace {
614 target_keybind_source: target_source,
615 source,
616 ..
617 } if target_source != KeybindSource::User => {
618 operation = KeybindUpdateOperation::Add(source);
619 }
620 _ => {}
621 }
622
623 // Sanity check that keymap contents are valid, even though we only use it for Replace.
624 // We don't want to modify the file if it's invalid.
625 let keymap = Self::parse(&keymap_contents).context("Failed to parse keymap")?;
626
627 if let KeybindUpdateOperation::Replace { source, target, .. } = operation {
628 let mut found_index = None;
629 let target_action_value = target
630 .action_value()
631 .context("Failed to generate target action JSON value")?;
632 let source_action_value = source
633 .action_value()
634 .context("Failed to generate source action JSON value")?;
635 'sections: for (index, section) in keymap.sections().enumerate() {
636 if section.context != target.context.unwrap_or("") {
637 continue;
638 }
639 if section.use_key_equivalents != target.use_key_equivalents {
640 continue;
641 }
642 let Some(bindings) = §ion.bindings else {
643 continue;
644 };
645 for (keystrokes, action) in bindings {
646 let Ok(keystrokes) = keystrokes
647 .split_whitespace()
648 .map(Keystroke::parse)
649 .collect::<Result<Vec<_>, _>>()
650 else {
651 continue;
652 };
653 if keystrokes.len() != target.keystrokes.len()
654 || !keystrokes
655 .iter()
656 .zip(target.keystrokes)
657 .all(|(a, b)| a.should_match(b))
658 {
659 continue;
660 }
661 if action.0 != target_action_value {
662 continue;
663 }
664 found_index = Some(index);
665 break 'sections;
666 }
667 }
668
669 if let Some(index) = found_index {
670 if target.context == source.context {
671 // if we are only changing the keybinding (common case)
672 // not the context, etc. Then just update the binding in place
673
674 let (replace_range, replace_value) =
675 replace_top_level_array_value_in_json_text(
676 &keymap_contents,
677 &["bindings", &target.keystrokes_unparsed()],
678 Some(&source_action_value),
679 Some(&source.keystrokes_unparsed()),
680 index,
681 tab_size,
682 )
683 .context("Failed to replace keybinding")?;
684 keymap_contents.replace_range(replace_range, &replace_value);
685
686 return Ok(keymap_contents);
687 } else if keymap.0[index]
688 .bindings
689 .as_ref()
690 .map_or(true, |bindings| bindings.len() == 1)
691 {
692 // if we are replacing the only binding in the section,
693 // just update the section in place, updating the context
694 // and the binding
695
696 let (replace_range, replace_value) =
697 replace_top_level_array_value_in_json_text(
698 &keymap_contents,
699 &["bindings", &target.keystrokes_unparsed()],
700 Some(&source_action_value),
701 Some(&source.keystrokes_unparsed()),
702 index,
703 tab_size,
704 )
705 .context("Failed to replace keybinding")?;
706 keymap_contents.replace_range(replace_range, &replace_value);
707
708 let (replace_range, replace_value) =
709 replace_top_level_array_value_in_json_text(
710 &keymap_contents,
711 &["context"],
712 source.context.map(Into::into).as_ref(),
713 None,
714 index,
715 tab_size,
716 )
717 .context("Failed to replace keybinding")?;
718 keymap_contents.replace_range(replace_range, &replace_value);
719 return Ok(keymap_contents);
720 } else {
721 // if we are replacing one of multiple bindings in a section
722 // with a context change, remove the existing binding from the
723 // section, then treat this operation as an add operation of the
724 // new binding with the updated context.
725
726 let (replace_range, replace_value) =
727 replace_top_level_array_value_in_json_text(
728 &keymap_contents,
729 &["bindings", &target.keystrokes_unparsed()],
730 None,
731 None,
732 index,
733 tab_size,
734 )
735 .context("Failed to replace keybinding")?;
736 keymap_contents.replace_range(replace_range, &replace_value);
737 operation = KeybindUpdateOperation::Add(source);
738 }
739 } else {
740 log::warn!(
741 "Failed to find keybinding to update `{:?} -> {}` creating new binding for `{:?} -> {}` instead",
742 target.keystrokes,
743 target_action_value,
744 source.keystrokes,
745 source_action_value,
746 );
747 operation = KeybindUpdateOperation::Add(source);
748 }
749 }
750
751 if let KeybindUpdateOperation::Add(keybinding) = operation {
752 let mut value = serde_json::Map::with_capacity(4);
753 if let Some(context) = keybinding.context {
754 value.insert("context".to_string(), context.into());
755 }
756 if keybinding.use_key_equivalents {
757 value.insert("use_key_equivalents".to_string(), true.into());
758 }
759
760 value.insert("bindings".to_string(), {
761 let mut bindings = serde_json::Map::new();
762 let action = keybinding.action_value()?;
763 bindings.insert(keybinding.keystrokes_unparsed(), action);
764 bindings.into()
765 });
766
767 let (replace_range, replace_value) = append_top_level_array_value_in_json_text(
768 &keymap_contents,
769 &value.into(),
770 tab_size,
771 )?;
772 keymap_contents.replace_range(replace_range, &replace_value);
773 }
774 return Ok(keymap_contents);
775 }
776}
777
778pub enum KeybindUpdateOperation<'a> {
779 Replace {
780 /// Describes the keybind to create
781 source: KeybindUpdateTarget<'a>,
782 /// Describes the keybind to remove
783 target: KeybindUpdateTarget<'a>,
784 target_keybind_source: KeybindSource,
785 },
786 Add(KeybindUpdateTarget<'a>),
787}
788
789pub struct KeybindUpdateTarget<'a> {
790 pub context: Option<&'a str>,
791 pub keystrokes: &'a [KeybindingKeystroke],
792 pub action_name: &'a str,
793 pub use_key_equivalents: bool,
794 pub input: Option<&'a str>,
795}
796
797impl<'a> KeybindUpdateTarget<'a> {
798 fn action_value(&self) -> Result<Value> {
799 let action_name: Value = self.action_name.into();
800 let value = match self.input {
801 Some(input) => {
802 let input = serde_json::from_str::<Value>(input)
803 .context("Failed to parse action input as JSON")?;
804 serde_json::json!([action_name, input])
805 }
806 None => action_name,
807 };
808 return Ok(value);
809 }
810
811 fn keystrokes_unparsed(&self) -> String {
812 let mut keystrokes = String::with_capacity(self.keystrokes.len() * 8);
813 for keystroke in self.keystrokes {
814 keystrokes.push_str(&keystroke.inner.unparse());
815 keystrokes.push(' ');
816 }
817 keystrokes.pop();
818 keystrokes
819 }
820}
821
822#[derive(Clone, Copy, PartialEq, Eq)]
823pub enum KeybindSource {
824 User,
825 Default,
826 Base,
827 Vim,
828}
829
830impl KeybindSource {
831 const BASE: KeyBindingMetaIndex = KeyBindingMetaIndex(0);
832 const DEFAULT: KeyBindingMetaIndex = KeyBindingMetaIndex(1);
833 const VIM: KeyBindingMetaIndex = KeyBindingMetaIndex(2);
834 const USER: KeyBindingMetaIndex = KeyBindingMetaIndex(3);
835
836 pub fn name(&self) -> &'static str {
837 match self {
838 KeybindSource::User => "User",
839 KeybindSource::Default => "Default",
840 KeybindSource::Base => "Base",
841 KeybindSource::Vim => "Vim",
842 }
843 }
844
845 pub fn meta(&self) -> KeyBindingMetaIndex {
846 match self {
847 KeybindSource::User => Self::USER,
848 KeybindSource::Default => Self::DEFAULT,
849 KeybindSource::Base => Self::BASE,
850 KeybindSource::Vim => Self::VIM,
851 }
852 }
853
854 pub fn from_meta(index: KeyBindingMetaIndex) -> Self {
855 match index {
856 Self::USER => KeybindSource::User,
857 Self::BASE => KeybindSource::Base,
858 Self::DEFAULT => KeybindSource::Default,
859 Self::VIM => KeybindSource::Vim,
860 _ => unreachable!(),
861 }
862 }
863}
864
865impl From<KeyBindingMetaIndex> for KeybindSource {
866 fn from(index: KeyBindingMetaIndex) -> Self {
867 Self::from_meta(index)
868 }
869}
870
871impl From<KeybindSource> for KeyBindingMetaIndex {
872 fn from(source: KeybindSource) -> Self {
873 return source.meta();
874 }
875}
876
877#[cfg(test)]
878mod tests {
879 use unindent::Unindent;
880
881 use crate::{
882 KeybindSource, KeymapFile,
883 keymap_file::{KeybindUpdateOperation, KeybindUpdateTarget},
884 };
885
886 #[test]
887 fn can_deserialize_keymap_with_trailing_comma() {
888 let json = indoc::indoc! {"[
889 // Standard macOS bindings
890 {
891 \"bindings\": {
892 \"up\": \"menu::SelectPrevious\",
893 },
894 },
895 ]
896 "
897 };
898 KeymapFile::parse(json).unwrap();
899 }
900
901 #[test]
902 fn keymap_update() {
903 use gpui::Keystroke;
904
905 zlog::init_test();
906 #[track_caller]
907 fn check_keymap_update(
908 input: impl ToString,
909 operation: KeybindUpdateOperation,
910 expected: impl ToString,
911 ) {
912 let result = KeymapFile::update_keybinding(operation, input.to_string(), 4)
913 .expect("Update succeeded");
914 pretty_assertions::assert_eq!(expected.to_string(), result);
915 }
916
917 #[track_caller]
918 fn parse_keystrokes(keystrokes: &str) -> Vec<Keystroke> {
919 return keystrokes
920 .split(' ')
921 .map(|s| Keystroke::parse(s).expect("Keystrokes valid"))
922 .collect();
923 }
924
925 check_keymap_update(
926 "[]",
927 KeybindUpdateOperation::Add(KeybindUpdateTarget {
928 keystrokes: &parse_keystrokes("ctrl-a"),
929 action_name: "zed::SomeAction",
930 context: None,
931 use_key_equivalents: false,
932 input: None,
933 }),
934 r#"[
935 {
936 "bindings": {
937 "ctrl-a": "zed::SomeAction"
938 }
939 }
940 ]"#
941 .unindent(),
942 );
943
944 check_keymap_update(
945 r#"[
946 {
947 "bindings": {
948 "ctrl-a": "zed::SomeAction"
949 }
950 }
951 ]"#
952 .unindent(),
953 KeybindUpdateOperation::Add(KeybindUpdateTarget {
954 keystrokes: &parse_keystrokes("ctrl-b"),
955 action_name: "zed::SomeOtherAction",
956 context: None,
957 use_key_equivalents: false,
958 input: None,
959 }),
960 r#"[
961 {
962 "bindings": {
963 "ctrl-a": "zed::SomeAction"
964 }
965 },
966 {
967 "bindings": {
968 "ctrl-b": "zed::SomeOtherAction"
969 }
970 }
971 ]"#
972 .unindent(),
973 );
974
975 check_keymap_update(
976 r#"[
977 {
978 "bindings": {
979 "ctrl-a": "zed::SomeAction"
980 }
981 }
982 ]"#
983 .unindent(),
984 KeybindUpdateOperation::Add(KeybindUpdateTarget {
985 keystrokes: &parse_keystrokes("ctrl-b"),
986 action_name: "zed::SomeOtherAction",
987 context: None,
988 use_key_equivalents: false,
989 input: Some(r#"{"foo": "bar"}"#),
990 }),
991 r#"[
992 {
993 "bindings": {
994 "ctrl-a": "zed::SomeAction"
995 }
996 },
997 {
998 "bindings": {
999 "ctrl-b": [
1000 "zed::SomeOtherAction",
1001 {
1002 "foo": "bar"
1003 }
1004 ]
1005 }
1006 }
1007 ]"#
1008 .unindent(),
1009 );
1010
1011 check_keymap_update(
1012 r#"[
1013 {
1014 "bindings": {
1015 "ctrl-a": "zed::SomeAction"
1016 }
1017 }
1018 ]"#
1019 .unindent(),
1020 KeybindUpdateOperation::Add(KeybindUpdateTarget {
1021 keystrokes: &parse_keystrokes("ctrl-b"),
1022 action_name: "zed::SomeOtherAction",
1023 context: Some("Zed > Editor && some_condition = true"),
1024 use_key_equivalents: true,
1025 input: Some(r#"{"foo": "bar"}"#),
1026 }),
1027 r#"[
1028 {
1029 "bindings": {
1030 "ctrl-a": "zed::SomeAction"
1031 }
1032 },
1033 {
1034 "context": "Zed > Editor && some_condition = true",
1035 "use_key_equivalents": true,
1036 "bindings": {
1037 "ctrl-b": [
1038 "zed::SomeOtherAction",
1039 {
1040 "foo": "bar"
1041 }
1042 ]
1043 }
1044 }
1045 ]"#
1046 .unindent(),
1047 );
1048
1049 check_keymap_update(
1050 r#"[
1051 {
1052 "bindings": {
1053 "ctrl-a": "zed::SomeAction"
1054 }
1055 }
1056 ]"#
1057 .unindent(),
1058 KeybindUpdateOperation::Replace {
1059 target: KeybindUpdateTarget {
1060 keystrokes: &parse_keystrokes("ctrl-a"),
1061 action_name: "zed::SomeAction",
1062 context: None,
1063 use_key_equivalents: false,
1064 input: None,
1065 },
1066 source: KeybindUpdateTarget {
1067 keystrokes: &parse_keystrokes("ctrl-b"),
1068 action_name: "zed::SomeOtherAction",
1069 context: None,
1070 use_key_equivalents: false,
1071 input: Some(r#"{"foo": "bar"}"#),
1072 },
1073 target_keybind_source: KeybindSource::Base,
1074 },
1075 r#"[
1076 {
1077 "bindings": {
1078 "ctrl-a": "zed::SomeAction"
1079 }
1080 },
1081 {
1082 "bindings": {
1083 "ctrl-b": [
1084 "zed::SomeOtherAction",
1085 {
1086 "foo": "bar"
1087 }
1088 ]
1089 }
1090 }
1091 ]"#
1092 .unindent(),
1093 );
1094
1095 check_keymap_update(
1096 r#"[
1097 {
1098 "bindings": {
1099 "a": "zed::SomeAction"
1100 }
1101 }
1102 ]"#
1103 .unindent(),
1104 KeybindUpdateOperation::Replace {
1105 target: KeybindUpdateTarget {
1106 keystrokes: &parse_keystrokes("a"),
1107 action_name: "zed::SomeAction",
1108 context: None,
1109 use_key_equivalents: false,
1110 input: None,
1111 },
1112 source: KeybindUpdateTarget {
1113 keystrokes: &parse_keystrokes("ctrl-b"),
1114 action_name: "zed::SomeOtherAction",
1115 context: None,
1116 use_key_equivalents: false,
1117 input: Some(r#"{"foo": "bar"}"#),
1118 },
1119 target_keybind_source: KeybindSource::User,
1120 },
1121 r#"[
1122 {
1123 "bindings": {
1124 "ctrl-b": [
1125 "zed::SomeOtherAction",
1126 {
1127 "foo": "bar"
1128 }
1129 ]
1130 }
1131 }
1132 ]"#
1133 .unindent(),
1134 );
1135
1136 check_keymap_update(
1137 r#"[
1138 {
1139 "bindings": {
1140 "ctrl-a": "zed::SomeAction"
1141 }
1142 }
1143 ]"#
1144 .unindent(),
1145 KeybindUpdateOperation::Replace {
1146 target: KeybindUpdateTarget {
1147 keystrokes: &parse_keystrokes("ctrl-a"),
1148 action_name: "zed::SomeNonexistentAction",
1149 context: None,
1150 use_key_equivalents: false,
1151 input: None,
1152 },
1153 source: KeybindUpdateTarget {
1154 keystrokes: &parse_keystrokes("ctrl-b"),
1155 action_name: "zed::SomeOtherAction",
1156 context: None,
1157 use_key_equivalents: false,
1158 input: None,
1159 },
1160 target_keybind_source: KeybindSource::User,
1161 },
1162 r#"[
1163 {
1164 "bindings": {
1165 "ctrl-a": "zed::SomeAction"
1166 }
1167 },
1168 {
1169 "bindings": {
1170 "ctrl-b": "zed::SomeOtherAction"
1171 }
1172 }
1173 ]"#
1174 .unindent(),
1175 );
1176
1177 check_keymap_update(
1178 r#"[
1179 {
1180 "bindings": {
1181 // some comment
1182 "ctrl-a": "zed::SomeAction"
1183 // some other comment
1184 }
1185 }
1186 ]"#
1187 .unindent(),
1188 KeybindUpdateOperation::Replace {
1189 target: KeybindUpdateTarget {
1190 keystrokes: &parse_keystrokes("ctrl-a"),
1191 action_name: "zed::SomeAction",
1192 context: None,
1193 use_key_equivalents: false,
1194 input: None,
1195 },
1196 source: KeybindUpdateTarget {
1197 keystrokes: &parse_keystrokes("ctrl-b"),
1198 action_name: "zed::SomeOtherAction",
1199 context: None,
1200 use_key_equivalents: false,
1201 input: Some(r#"{"foo": "bar"}"#),
1202 },
1203 target_keybind_source: KeybindSource::User,
1204 },
1205 r#"[
1206 {
1207 "bindings": {
1208 // some comment
1209 "ctrl-b": [
1210 "zed::SomeOtherAction",
1211 {
1212 "foo": "bar"
1213 }
1214 ]
1215 // some other comment
1216 }
1217 }
1218 ]"#
1219 .unindent(),
1220 );
1221
1222 check_keymap_update(
1223 r#"[
1224 {
1225 "context": "SomeContext",
1226 "bindings": {
1227 "a": "foo::bar",
1228 "b": "baz::qux",
1229 }
1230 }
1231 ]"#
1232 .unindent(),
1233 KeybindUpdateOperation::Replace {
1234 target: KeybindUpdateTarget {
1235 keystrokes: &parse_keystrokes("a"),
1236 action_name: "foo::bar",
1237 context: Some("SomeContext"),
1238 use_key_equivalents: false,
1239 input: None,
1240 },
1241 source: KeybindUpdateTarget {
1242 keystrokes: &parse_keystrokes("c"),
1243 action_name: "foo::baz",
1244 context: Some("SomeOtherContext"),
1245 use_key_equivalents: false,
1246 input: None,
1247 },
1248 target_keybind_source: KeybindSource::User,
1249 },
1250 r#"[
1251 {
1252 "context": "SomeContext",
1253 "bindings": {
1254 "b": "baz::qux",
1255 }
1256 },
1257 {
1258 "context": "SomeOtherContext",
1259 "bindings": {
1260 "c": "foo::baz"
1261 }
1262 }
1263 ]"#
1264 .unindent(),
1265 );
1266
1267 check_keymap_update(
1268 r#"[
1269 {
1270 "context": "SomeContext",
1271 "bindings": {
1272 "a": "foo::bar",
1273 }
1274 }
1275 ]"#
1276 .unindent(),
1277 KeybindUpdateOperation::Replace {
1278 target: KeybindUpdateTarget {
1279 keystrokes: &parse_keystrokes("a"),
1280 action_name: "foo::bar",
1281 context: Some("SomeContext"),
1282 use_key_equivalents: false,
1283 input: None,
1284 },
1285 source: KeybindUpdateTarget {
1286 keystrokes: &parse_keystrokes("c"),
1287 action_name: "foo::baz",
1288 context: Some("SomeOtherContext"),
1289 use_key_equivalents: false,
1290 input: None,
1291 },
1292 target_keybind_source: KeybindSource::User,
1293 },
1294 r#"[
1295 {
1296 "context": "SomeOtherContext",
1297 "bindings": {
1298 "c": "foo::baz",
1299 }
1300 }
1301 ]"#
1302 .unindent(),
1303 );
1304 }
1305}