1use crate::parse_json_with_comments;
2use anyhow::{Context, Result};
3use assets::Assets;
4use collections::BTreeMap;
5use gpui::{keymap_matcher::Binding, MutableAppContext};
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 MutableAppContext) {
45 for path in ["keymaps/default.json", "keymaps/vim.json"] {
46 Self::load(path, cx).unwrap();
47 }
48 }
49
50 pub fn load(asset_path: &str, cx: &mut MutableAppContext) -> Result<()> {
51 let content = Assets::get(asset_path).unwrap().data;
52 let content_str = std::str::from_utf8(content.as_ref()).unwrap();
53 parse_json_with_comments::<Self>(content_str)?.add_to_cx(cx)
54 }
55
56 pub fn add_to_cx(self, cx: &mut MutableAppContext) -> Result<()> {
57 for KeymapBlock { context, bindings } in self.0 {
58 let bindings = bindings
59 .into_iter()
60 .filter_map(|(keystroke, action)| {
61 let action = action.0.get();
62
63 // This is a workaround for a limitation in serde: serde-rs/json#497
64 // We want to deserialize the action data as a `RawValue` so that we can
65 // deserialize the action itself dynamically directly from the JSON
66 // string. But `RawValue` currently does not work inside of an untagged enum.
67 if action.starts_with('[') {
68 let ActionWithData(name, data) = serde_json::from_str(action).log_err()?;
69 cx.deserialize_action(&name, Some(data.get()))
70 } else {
71 let name = serde_json::from_str(action).log_err()?;
72 cx.deserialize_action(name, None)
73 }
74 .with_context(|| {
75 format!(
76 "invalid binding value for keystroke {keystroke}, context {context:?}"
77 )
78 })
79 .log_err()
80 .map(|action| Binding::load(&keystroke, action, context.as_deref()))
81 })
82 .collect::<Result<Vec<_>>>()?;
83
84 cx.add_bindings(bindings);
85 }
86 Ok(())
87 }
88}
89
90pub fn keymap_file_json_schema(action_names: &[&'static str]) -> serde_json::Value {
91 let mut root_schema = SchemaSettings::draft07()
92 .with(|settings| settings.option_add_null_type = false)
93 .into_generator()
94 .into_root_schema_for::<KeymapFileContent>();
95
96 let action_schema = Schema::Object(SchemaObject {
97 subschemas: Some(Box::new(SubschemaValidation {
98 one_of: Some(vec![
99 Schema::Object(SchemaObject {
100 instance_type: Some(SingleOrVec::Single(Box::new(InstanceType::String))),
101 enum_values: Some(
102 action_names
103 .iter()
104 .map(|name| Value::String(name.to_string()))
105 .collect(),
106 ),
107 ..Default::default()
108 }),
109 Schema::Object(SchemaObject {
110 instance_type: Some(SingleOrVec::Single(Box::new(InstanceType::Array))),
111 ..Default::default()
112 }),
113 ]),
114 ..Default::default()
115 })),
116 ..Default::default()
117 });
118
119 root_schema
120 .definitions
121 .insert("KeymapAction".to_owned(), action_schema);
122
123 serde_json::to_value(root_schema).unwrap()
124}