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::{
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(
403 keystrokes,
404 action,
405 context,
406 key_equivalents,
407 action_input_string.map(SharedString::from),
408 ) {
409 Ok(key_binding) => key_binding,
410 Err(InvalidKeystrokeError { keystroke }) => {
411 return Err(format!(
412 "invalid keystroke {}. {}",
413 MarkdownInlineCode(&format!("\"{}\"", &keystroke)),
414 KEYSTROKE_PARSE_EXPECTED_MESSAGE
415 ));
416 }
417 };
418
419 if let Some(validator) = KEY_BINDING_VALIDATORS.get(&key_binding.action().type_id()) {
420 match validator.validate(&key_binding) {
421 Ok(()) => Ok(key_binding),
422 Err(error) => Err(error.0),
423 }
424 } else {
425 Ok(key_binding)
426 }
427 }
428
429 pub fn generate_json_schema_for_registered_actions(cx: &mut App) -> Value {
430 let mut generator = schemars::generate::SchemaSettings::draft07().into_generator();
431
432 let action_schemas = cx.action_schemas(&mut generator);
433 let deprecations = cx.deprecated_actions_to_preferred_actions();
434 let deprecation_messages = cx.action_deprecation_messages();
435 KeymapFile::generate_json_schema(
436 generator,
437 action_schemas,
438 deprecations,
439 deprecation_messages,
440 )
441 }
442
443 fn generate_json_schema(
444 mut generator: schemars::SchemaGenerator,
445 action_schemas: Vec<(&'static str, Option<schemars::Schema>)>,
446 deprecations: &HashMap<&'static str, &'static str>,
447 deprecation_messages: &HashMap<&'static str, &'static str>,
448 ) -> serde_json::Value {
449 fn add_deprecation(schema: &mut schemars::Schema, message: String) {
450 schema.insert(
451 // deprecationMessage is not part of the JSON Schema spec, but
452 // json-language-server recognizes it.
453 "deprecationMessage".to_string(),
454 Value::String(message),
455 );
456 }
457
458 fn add_deprecation_preferred_name(schema: &mut schemars::Schema, new_name: &str) {
459 add_deprecation(schema, format!("Deprecated, use {new_name}"));
460 }
461
462 fn add_description(schema: &mut schemars::Schema, description: String) {
463 schema.insert("description".to_string(), Value::String(description));
464 }
465
466 let empty_object = json_schema!({
467 "type": "object"
468 });
469
470 // This is a workaround for a json-language-server issue where it matches the first
471 // alternative that matches the value's shape and uses that for documentation.
472 //
473 // In the case of the array validations, it would even provide an error saying that the name
474 // must match the name of the first alternative.
475 let mut plain_action = json_schema!({
476 "type": "string",
477 "const": ""
478 });
479 let no_action_message = "No action named this.";
480 add_description(&mut plain_action, no_action_message.to_owned());
481 add_deprecation(&mut plain_action, no_action_message.to_owned());
482
483 let mut matches_action_name = json_schema!({
484 "const": ""
485 });
486 let no_action_message_input = "No action named this that takes input.";
487 add_description(&mut matches_action_name, no_action_message_input.to_owned());
488 add_deprecation(&mut matches_action_name, no_action_message_input.to_owned());
489
490 let action_with_input = json_schema!({
491 "type": "array",
492 "items": [
493 matches_action_name,
494 true
495 ],
496 "minItems": 2,
497 "maxItems": 2
498 });
499 let mut keymap_action_alternatives = vec![plain_action, action_with_input];
500
501 for (name, action_schema) in action_schemas.into_iter() {
502 let description = action_schema.as_ref().and_then(|schema| {
503 schema
504 .as_object()
505 .and_then(|obj| obj.get("description"))
506 .and_then(|v| v.as_str())
507 .map(|s| s.to_string())
508 });
509
510 let deprecation = if name == NoAction.name() {
511 Some("null")
512 } else {
513 deprecations.get(name).copied()
514 };
515
516 // Add an alternative for plain action names.
517 let mut plain_action = json_schema!({
518 "type": "string",
519 "const": name
520 });
521 if let Some(message) = deprecation_messages.get(name) {
522 add_deprecation(&mut plain_action, message.to_string());
523 } else if let Some(new_name) = deprecation {
524 add_deprecation_preferred_name(&mut plain_action, new_name);
525 }
526 if let Some(desc) = description.clone() {
527 add_description(&mut plain_action, desc);
528 }
529 keymap_action_alternatives.push(plain_action);
530
531 // Add an alternative for actions with data specified as a [name, data] array.
532 //
533 // When a struct with no deserializable fields is added by deriving `Action`, an empty
534 // object schema is produced. The action should be invoked without data in this case.
535 if let Some(schema) = action_schema {
536 if schema != empty_object {
537 let mut matches_action_name = json_schema!({
538 "const": name
539 });
540 if let Some(desc) = description.clone() {
541 add_description(&mut matches_action_name, desc);
542 }
543 if let Some(message) = deprecation_messages.get(name) {
544 add_deprecation(&mut matches_action_name, message.to_string());
545 } else if let Some(new_name) = deprecation {
546 add_deprecation_preferred_name(&mut matches_action_name, new_name);
547 }
548 let action_with_input = json_schema!({
549 "type": "array",
550 "items": [matches_action_name, schema],
551 "minItems": 2,
552 "maxItems": 2
553 });
554 keymap_action_alternatives.push(action_with_input);
555 }
556 }
557 }
558
559 // Placing null first causes json-language-server to default assuming actions should be
560 // null, so place it last.
561 keymap_action_alternatives.push(json_schema!({
562 "type": "null"
563 }));
564
565 // The `KeymapSection` schema will reference the `KeymapAction` schema by name, so setting
566 // the definition of `KeymapAction` results in the full action schema being used.
567 generator.definitions_mut().insert(
568 KeymapAction::schema_name().to_string(),
569 json!({
570 "oneOf": keymap_action_alternatives
571 }),
572 );
573
574 generator.root_schema_for::<KeymapFile>().to_value()
575 }
576
577 pub fn sections(&self) -> impl DoubleEndedIterator<Item = &KeymapSection> {
578 self.0.iter()
579 }
580
581 pub async fn load_keymap_file(fs: &Arc<dyn Fs>) -> Result<String> {
582 match fs.load(paths::keymap_file()).await {
583 result @ Ok(_) => result,
584 Err(err) => {
585 if let Some(e) = err.downcast_ref::<std::io::Error>() {
586 if e.kind() == std::io::ErrorKind::NotFound {
587 return Ok(crate::initial_keymap_content().to_string());
588 }
589 }
590 Err(err)
591 }
592 }
593 }
594
595 pub fn update_keybinding<'a>(
596 mut operation: KeybindUpdateOperation<'a>,
597 mut keymap_contents: String,
598 tab_size: usize,
599 ) -> Result<String> {
600 // if trying to replace a keybinding that is not user-defined, treat it as an add operation
601 match operation {
602 KeybindUpdateOperation::Replace {
603 target_source,
604 source,
605 ..
606 } if target_source != KeybindSource::User => {
607 operation = KeybindUpdateOperation::Add(source);
608 }
609 _ => {}
610 }
611
612 // Sanity check that keymap contents are valid, even though we only use it for Replace.
613 // We don't want to modify the file if it's invalid.
614 let keymap = Self::parse(&keymap_contents).context("Failed to parse keymap")?;
615
616 if let KeybindUpdateOperation::Replace { source, target, .. } = operation {
617 let mut found_index = None;
618 let target_action_value = target
619 .action_value()
620 .context("Failed to generate target action JSON value")?;
621 let source_action_value = source
622 .action_value()
623 .context("Failed to generate source action JSON value")?;
624 'sections: for (index, section) in keymap.sections().enumerate() {
625 if section.context != target.context.unwrap_or("") {
626 continue;
627 }
628 if section.use_key_equivalents != target.use_key_equivalents {
629 continue;
630 }
631 let Some(bindings) = §ion.bindings else {
632 continue;
633 };
634 for (keystrokes, action) in bindings {
635 let Ok(keystrokes) = keystrokes
636 .split_whitespace()
637 .map(Keystroke::parse)
638 .collect::<Result<Vec<_>, _>>()
639 else {
640 continue;
641 };
642 if keystrokes != target.keystrokes {
643 continue;
644 }
645 if action.0 != target_action_value {
646 continue;
647 }
648 found_index = Some(index);
649 break 'sections;
650 }
651 }
652
653 if let Some(index) = found_index {
654 let (replace_range, replace_value) = replace_top_level_array_value_in_json_text(
655 &keymap_contents,
656 &["bindings", &target.keystrokes_unparsed()],
657 Some(&source_action_value),
658 Some(&source.keystrokes_unparsed()),
659 index,
660 tab_size,
661 )
662 .context("Failed to replace keybinding")?;
663 keymap_contents.replace_range(replace_range, &replace_value);
664
665 return Ok(keymap_contents);
666 } else {
667 log::warn!(
668 "Failed to find keybinding to update `{:?} -> {}` creating new binding for `{:?} -> {}` instead",
669 target.keystrokes,
670 target_action_value,
671 source.keystrokes,
672 source_action_value,
673 );
674 operation = KeybindUpdateOperation::Add(source);
675 }
676 }
677
678 if let KeybindUpdateOperation::Add(keybinding) = operation {
679 let mut value = serde_json::Map::with_capacity(4);
680 if let Some(context) = keybinding.context {
681 value.insert("context".to_string(), context.into());
682 }
683 if keybinding.use_key_equivalents {
684 value.insert("use_key_equivalents".to_string(), true.into());
685 }
686
687 value.insert("bindings".to_string(), {
688 let mut bindings = serde_json::Map::new();
689 let action = keybinding.action_value()?;
690 bindings.insert(keybinding.keystrokes_unparsed(), action);
691 bindings.into()
692 });
693
694 let (replace_range, replace_value) = append_top_level_array_value_in_json_text(
695 &keymap_contents,
696 &value.into(),
697 tab_size,
698 )?;
699 keymap_contents.replace_range(replace_range, &replace_value);
700 }
701 return Ok(keymap_contents);
702 }
703}
704
705pub enum KeybindUpdateOperation<'a> {
706 Replace {
707 /// Describes the keybind to create
708 source: KeybindUpdateTarget<'a>,
709 /// Describes the keybind to remove
710 target: KeybindUpdateTarget<'a>,
711 target_source: KeybindSource,
712 },
713 Add(KeybindUpdateTarget<'a>),
714}
715
716pub struct KeybindUpdateTarget<'a> {
717 pub context: Option<&'a str>,
718 pub keystrokes: &'a [Keystroke],
719 pub action_name: &'a str,
720 pub use_key_equivalents: bool,
721 pub input: Option<&'a str>,
722}
723
724impl<'a> KeybindUpdateTarget<'a> {
725 fn action_value(&self) -> Result<Value> {
726 let action_name: Value = self.action_name.into();
727 let value = match self.input {
728 Some(input) => {
729 let input = serde_json::from_str::<Value>(input)
730 .context("Failed to parse action input as JSON")?;
731 serde_json::json!([action_name, input])
732 }
733 None => action_name,
734 };
735 return Ok(value);
736 }
737
738 fn keystrokes_unparsed(&self) -> String {
739 let mut keystrokes = String::with_capacity(self.keystrokes.len() * 8);
740 for keystroke in self.keystrokes {
741 keystrokes.push_str(&keystroke.unparse());
742 keystrokes.push(' ');
743 }
744 keystrokes.pop();
745 keystrokes
746 }
747}
748
749#[derive(Clone, Copy, PartialEq, Eq)]
750pub enum KeybindSource {
751 User,
752 Default,
753 Base,
754 Vim,
755}
756
757impl KeybindSource {
758 const BASE: KeyBindingMetaIndex = KeyBindingMetaIndex(0);
759 const DEFAULT: KeyBindingMetaIndex = KeyBindingMetaIndex(1);
760 const VIM: KeyBindingMetaIndex = KeyBindingMetaIndex(2);
761 const USER: KeyBindingMetaIndex = KeyBindingMetaIndex(3);
762
763 pub fn name(&self) -> &'static str {
764 match self {
765 KeybindSource::User => "User",
766 KeybindSource::Default => "Default",
767 KeybindSource::Base => "Base",
768 KeybindSource::Vim => "Vim",
769 }
770 }
771
772 pub fn meta(&self) -> KeyBindingMetaIndex {
773 match self {
774 KeybindSource::User => Self::USER,
775 KeybindSource::Default => Self::DEFAULT,
776 KeybindSource::Base => Self::BASE,
777 KeybindSource::Vim => Self::VIM,
778 }
779 }
780
781 pub fn from_meta(index: KeyBindingMetaIndex) -> Self {
782 match index {
783 _ if index == Self::USER => KeybindSource::User,
784 _ if index == Self::USER => KeybindSource::Base,
785 _ if index == Self::DEFAULT => KeybindSource::Default,
786 _ if index == Self::VIM => KeybindSource::Vim,
787 _ => unreachable!(),
788 }
789 }
790}
791
792impl From<KeyBindingMetaIndex> for KeybindSource {
793 fn from(index: KeyBindingMetaIndex) -> Self {
794 Self::from_meta(index)
795 }
796}
797
798impl From<KeybindSource> for KeyBindingMetaIndex {
799 fn from(source: KeybindSource) -> Self {
800 return source.meta();
801 }
802}
803
804#[cfg(test)]
805mod tests {
806 use unindent::Unindent;
807
808 use crate::{
809 KeybindSource, KeymapFile,
810 keymap_file::{KeybindUpdateOperation, KeybindUpdateTarget},
811 };
812
813 #[test]
814 fn can_deserialize_keymap_with_trailing_comma() {
815 let json = indoc::indoc! {"[
816 // Standard macOS bindings
817 {
818 \"bindings\": {
819 \"up\": \"menu::SelectPrevious\",
820 },
821 },
822 ]
823 "
824 };
825 KeymapFile::parse(json).unwrap();
826 }
827
828 #[test]
829 fn keymap_update() {
830 use gpui::Keystroke;
831
832 zlog::init_test();
833 #[track_caller]
834 fn check_keymap_update(
835 input: impl ToString,
836 operation: KeybindUpdateOperation,
837 expected: impl ToString,
838 ) {
839 let result = KeymapFile::update_keybinding(operation, input.to_string(), 4)
840 .expect("Update succeeded");
841 pretty_assertions::assert_eq!(expected.to_string(), result);
842 }
843
844 #[track_caller]
845 fn parse_keystrokes(keystrokes: &str) -> Vec<Keystroke> {
846 return keystrokes
847 .split(' ')
848 .map(|s| Keystroke::parse(s).expect("Keystrokes valid"))
849 .collect();
850 }
851
852 check_keymap_update(
853 "[]",
854 KeybindUpdateOperation::Add(KeybindUpdateTarget {
855 keystrokes: &parse_keystrokes("ctrl-a"),
856 action_name: "zed::SomeAction",
857 context: None,
858 use_key_equivalents: false,
859 input: None,
860 }),
861 r#"[
862 {
863 "bindings": {
864 "ctrl-a": "zed::SomeAction"
865 }
866 }
867 ]"#
868 .unindent(),
869 );
870
871 check_keymap_update(
872 r#"[
873 {
874 "bindings": {
875 "ctrl-a": "zed::SomeAction"
876 }
877 }
878 ]"#
879 .unindent(),
880 KeybindUpdateOperation::Add(KeybindUpdateTarget {
881 keystrokes: &parse_keystrokes("ctrl-b"),
882 action_name: "zed::SomeOtherAction",
883 context: None,
884 use_key_equivalents: false,
885 input: None,
886 }),
887 r#"[
888 {
889 "bindings": {
890 "ctrl-a": "zed::SomeAction"
891 }
892 },
893 {
894 "bindings": {
895 "ctrl-b": "zed::SomeOtherAction"
896 }
897 }
898 ]"#
899 .unindent(),
900 );
901
902 check_keymap_update(
903 r#"[
904 {
905 "bindings": {
906 "ctrl-a": "zed::SomeAction"
907 }
908 }
909 ]"#
910 .unindent(),
911 KeybindUpdateOperation::Add(KeybindUpdateTarget {
912 keystrokes: &parse_keystrokes("ctrl-b"),
913 action_name: "zed::SomeOtherAction",
914 context: None,
915 use_key_equivalents: false,
916 input: Some(r#"{"foo": "bar"}"#),
917 }),
918 r#"[
919 {
920 "bindings": {
921 "ctrl-a": "zed::SomeAction"
922 }
923 },
924 {
925 "bindings": {
926 "ctrl-b": [
927 "zed::SomeOtherAction",
928 {
929 "foo": "bar"
930 }
931 ]
932 }
933 }
934 ]"#
935 .unindent(),
936 );
937
938 check_keymap_update(
939 r#"[
940 {
941 "bindings": {
942 "ctrl-a": "zed::SomeAction"
943 }
944 }
945 ]"#
946 .unindent(),
947 KeybindUpdateOperation::Add(KeybindUpdateTarget {
948 keystrokes: &parse_keystrokes("ctrl-b"),
949 action_name: "zed::SomeOtherAction",
950 context: Some("Zed > Editor && some_condition = true"),
951 use_key_equivalents: true,
952 input: Some(r#"{"foo": "bar"}"#),
953 }),
954 r#"[
955 {
956 "bindings": {
957 "ctrl-a": "zed::SomeAction"
958 }
959 },
960 {
961 "context": "Zed > Editor && some_condition = true",
962 "use_key_equivalents": true,
963 "bindings": {
964 "ctrl-b": [
965 "zed::SomeOtherAction",
966 {
967 "foo": "bar"
968 }
969 ]
970 }
971 }
972 ]"#
973 .unindent(),
974 );
975
976 check_keymap_update(
977 r#"[
978 {
979 "bindings": {
980 "ctrl-a": "zed::SomeAction"
981 }
982 }
983 ]"#
984 .unindent(),
985 KeybindUpdateOperation::Replace {
986 target: KeybindUpdateTarget {
987 keystrokes: &parse_keystrokes("ctrl-a"),
988 action_name: "zed::SomeAction",
989 context: None,
990 use_key_equivalents: false,
991 input: None,
992 },
993 source: KeybindUpdateTarget {
994 keystrokes: &parse_keystrokes("ctrl-b"),
995 action_name: "zed::SomeOtherAction",
996 context: None,
997 use_key_equivalents: false,
998 input: Some(r#"{"foo": "bar"}"#),
999 },
1000 target_source: KeybindSource::Base,
1001 },
1002 r#"[
1003 {
1004 "bindings": {
1005 "ctrl-a": "zed::SomeAction"
1006 }
1007 },
1008 {
1009 "bindings": {
1010 "ctrl-b": [
1011 "zed::SomeOtherAction",
1012 {
1013 "foo": "bar"
1014 }
1015 ]
1016 }
1017 }
1018 ]"#
1019 .unindent(),
1020 );
1021
1022 check_keymap_update(
1023 r#"[
1024 {
1025 "bindings": {
1026 "ctrl-a": "zed::SomeAction"
1027 }
1028 }
1029 ]"#
1030 .unindent(),
1031 KeybindUpdateOperation::Replace {
1032 target: KeybindUpdateTarget {
1033 keystrokes: &parse_keystrokes("ctrl-a"),
1034 action_name: "zed::SomeAction",
1035 context: None,
1036 use_key_equivalents: false,
1037 input: None,
1038 },
1039 source: KeybindUpdateTarget {
1040 keystrokes: &parse_keystrokes("ctrl-b"),
1041 action_name: "zed::SomeOtherAction",
1042 context: None,
1043 use_key_equivalents: false,
1044 input: Some(r#"{"foo": "bar"}"#),
1045 },
1046 target_source: KeybindSource::User,
1047 },
1048 r#"[
1049 {
1050 "bindings": {
1051 "ctrl-b": [
1052 "zed::SomeOtherAction",
1053 {
1054 "foo": "bar"
1055 }
1056 ]
1057 }
1058 }
1059 ]"#
1060 .unindent(),
1061 );
1062
1063 check_keymap_update(
1064 r#"[
1065 {
1066 "bindings": {
1067 "ctrl-a": "zed::SomeAction"
1068 }
1069 }
1070 ]"#
1071 .unindent(),
1072 KeybindUpdateOperation::Replace {
1073 target: KeybindUpdateTarget {
1074 keystrokes: &parse_keystrokes("ctrl-a"),
1075 action_name: "zed::SomeNonexistentAction",
1076 context: None,
1077 use_key_equivalents: false,
1078 input: None,
1079 },
1080 source: KeybindUpdateTarget {
1081 keystrokes: &parse_keystrokes("ctrl-b"),
1082 action_name: "zed::SomeOtherAction",
1083 context: None,
1084 use_key_equivalents: false,
1085 input: None,
1086 },
1087 target_source: KeybindSource::User,
1088 },
1089 r#"[
1090 {
1091 "bindings": {
1092 "ctrl-a": "zed::SomeAction"
1093 }
1094 },
1095 {
1096 "bindings": {
1097 "ctrl-b": "zed::SomeOtherAction"
1098 }
1099 }
1100 ]"#
1101 .unindent(),
1102 );
1103
1104 check_keymap_update(
1105 r#"[
1106 {
1107 "bindings": {
1108 // some comment
1109 "ctrl-a": "zed::SomeAction"
1110 // some other comment
1111 }
1112 }
1113 ]"#
1114 .unindent(),
1115 KeybindUpdateOperation::Replace {
1116 target: KeybindUpdateTarget {
1117 keystrokes: &parse_keystrokes("ctrl-a"),
1118 action_name: "zed::SomeAction",
1119 context: None,
1120 use_key_equivalents: false,
1121 input: None,
1122 },
1123 source: KeybindUpdateTarget {
1124 keystrokes: &parse_keystrokes("ctrl-b"),
1125 action_name: "zed::SomeOtherAction",
1126 context: None,
1127 use_key_equivalents: false,
1128 input: Some(r#"{"foo": "bar"}"#),
1129 },
1130 target_source: KeybindSource::User,
1131 },
1132 r#"[
1133 {
1134 "bindings": {
1135 // some comment
1136 "ctrl-b": [
1137 "zed::SomeOtherAction",
1138 {
1139 "foo": "bar"
1140 }
1141 ]
1142 // some other comment
1143 }
1144 }
1145 ]"#
1146 .unindent(),
1147 );
1148 }
1149}