1use crate::{parse_json_with_comments, Settings};
2use anyhow::{Context, Result};
3use assets::Assets;
4use collections::BTreeMap;
5use gpui::{keymap_matcher::Binding, AppContext};
6use schemars::{
7 gen::{SchemaGenerator, SchemaSettings},
8 schema::{InstanceType, Schema, SchemaObject, SingleOrVec, SubschemaValidation},
9 JsonSchema,
10};
11use serde::Deserialize;
12use serde_json::{value::RawValue, Value};
13use util::ResultExt;
14
15#[derive(Deserialize, Default, Clone, JsonSchema)]
16#[serde(transparent)]
17pub struct KeymapFileContent(Vec<KeymapBlock>);
18
19#[derive(Deserialize, Default, Clone, JsonSchema)]
20pub struct KeymapBlock {
21 #[serde(default)]
22 context: Option<String>,
23 bindings: BTreeMap<String, KeymapAction>,
24}
25
26#[derive(Deserialize, Default, Clone)]
27#[serde(transparent)]
28pub struct KeymapAction(Box<RawValue>);
29
30impl JsonSchema for KeymapAction {
31 fn schema_name() -> String {
32 "KeymapAction".into()
33 }
34
35 fn json_schema(_: &mut SchemaGenerator) -> Schema {
36 Schema::Bool(true)
37 }
38}
39
40#[derive(Deserialize)]
41struct ActionWithData(Box<str>, Box<RawValue>);
42
43impl KeymapFileContent {
44 pub fn load_defaults(cx: &mut AppContext) {
45 for path in ["keymaps/default.json", "keymaps/vim.json"] {
46 Self::load(path, cx).unwrap();
47 }
48
49 if let Some(asset_path) = cx.global::<Settings>().base_keymap.asset_path() {
50 Self::load(asset_path, cx).log_err();
51 }
52 }
53
54 pub fn load(asset_path: &str, cx: &mut AppContext) -> Result<()> {
55 let content = Assets::get(asset_path).unwrap().data;
56 let content_str = std::str::from_utf8(content.as_ref()).unwrap();
57 parse_json_with_comments::<Self>(content_str)?.add_to_cx(cx)
58 }
59
60 pub fn add_to_cx(self, cx: &mut AppContext) -> Result<()> {
61 for KeymapBlock { context, bindings } in self.0 {
62 let bindings = bindings
63 .into_iter()
64 .filter_map(|(keystroke, action)| {
65 let action = action.0.get();
66
67 // This is a workaround for a limitation in serde: serde-rs/json#497
68 // We want to deserialize the action data as a `RawValue` so that we can
69 // deserialize the action itself dynamically directly from the JSON
70 // string. But `RawValue` currently does not work inside of an untagged enum.
71 if action.starts_with('[') {
72 let ActionWithData(name, data) = serde_json::from_str(action).log_err()?;
73 cx.deserialize_action(&name, Some(data.get()))
74 } else {
75 let name = serde_json::from_str(action).log_err()?;
76 cx.deserialize_action(name, None)
77 }
78 .with_context(|| {
79 format!(
80 "invalid binding value for keystroke {keystroke}, context {context:?}"
81 )
82 })
83 .log_err()
84 .map(|action| Binding::load(&keystroke, action, context.as_deref()))
85 })
86 .collect::<Result<Vec<_>>>()?;
87
88 cx.add_bindings(bindings);
89 }
90 Ok(())
91 }
92}
93
94pub fn keymap_file_json_schema(action_names: &[&'static str]) -> serde_json::Value {
95 let mut root_schema = SchemaSettings::draft07()
96 .with(|settings| settings.option_add_null_type = false)
97 .into_generator()
98 .into_root_schema_for::<KeymapFileContent>();
99
100 let action_schema = Schema::Object(SchemaObject {
101 subschemas: Some(Box::new(SubschemaValidation {
102 one_of: Some(vec![
103 Schema::Object(SchemaObject {
104 instance_type: Some(SingleOrVec::Single(Box::new(InstanceType::String))),
105 enum_values: Some(
106 action_names
107 .iter()
108 .map(|name| Value::String(name.to_string()))
109 .collect(),
110 ),
111 ..Default::default()
112 }),
113 Schema::Object(SchemaObject {
114 instance_type: Some(SingleOrVec::Single(Box::new(InstanceType::Array))),
115 ..Default::default()
116 }),
117 ]),
118 ..Default::default()
119 })),
120 ..Default::default()
121 });
122
123 root_schema
124 .definitions
125 .insert("KeymapAction".to_owned(), action_schema);
126
127 serde_json::to_value(root_schema).unwrap()
128}