9926c2d · helix · git.iko.soy

git.iko.soy/helix

Remove Keymap(KeyTrie) and simply use KeyTrie.

commit9926c2d292712f38615cc2cb0ca75c1e8ef3bed9 authorgibbz00 <gabrielhansson00@gmail.com> dateSat 3 Jun 2023, 11:29 (3 years ago) parentb856368

4 files changed+29−61

compare with master

unifiedsplit

helix-term/src/config.rs+7−8 helix-term/src/keymap.rs+15−45 helix-term/src/keymap/default.rs+5−5 helix-term/src/keymap/macros.rs+2−3

helix-term/src/config.rs+7−8

@@ -1,5 +1,5 @@

11use crate::keymap;

2−use crate::keymap::{merge_keys, Keymap};

2+use crate::keymap::{merge_keys, KeyTrie};

33use helix_loader::merge_toml_values;

44use helix_view::document::Mode;

55use serde::Deserialize;

@@ -12,7 +12,7 @@ use toml::de::Error as TomlError;

1212#[derive(Debug, Clone, PartialEq)]

1313pub struct Config {

1414 pub theme: Option<String>,

15− pub keys: HashMap<Mode, Keymap>,

15+ pub keys: HashMap<Mode, KeyTrie>,

1616 pub editor: helix_view::editor::Config,

1717}

1818

@@ -20,7 +20,7 @@ pub struct Config {

2020#[serde(deny_unknown_fields)]

2121pub struct ConfigRaw {

2222 pub theme: Option<String>,

23− pub keys: Option<HashMap<Mode, Keymap>>,

23+ pub keys: Option<HashMap<Mode, KeyTrie>>,

2424 pub editor: Option<toml::Value>,

2525}

2626

@@ -138,7 +138,6 @@ mod tests {

138138 #[test]

139139 fn parsing_keymaps_config_file() {

140140 use crate::keymap;

141− use crate::keymap::Keymap;

142141 use helix_core::hashmap;

143142 use helix_view::document::Mode;

144143

@@ -155,13 +154,13 @@ mod tests {

155154 merge_keys(

156155 &mut keys,

157156 hashmap! {

158− Mode::Insert => Keymap::new(keymap!({ "Insert mode"

157+ Mode::Insert => keymap!({ "Insert mode"

159158 "y" => move_line_down,

160159 "S-C-a" => delete_selection,

161− })),

162− Mode::Normal => Keymap::new(keymap!({ "Normal mode"

160+ }),

161+ Mode::Normal => keymap!({ "Normal mode"

163162 "A-F12" => move_next_word_end,

164− })),

163+ }),

165164 },

166165 );

167166

helix-term/src/keymap.rs+15−45

@@ -269,41 +269,11 @@ pub enum KeymapResult {

269269 Cancelled(Vec<KeyEvent>),

270270}

271271

272−#[derive(Debug, Clone, PartialEq, Deserialize)]

273−#[serde(transparent)]

274−pub struct Keymap(KeyTrie);

275−

276272/// A map of command names to keybinds that will execute the command.

277273pub type ReverseKeymap = HashMap<String, Vec<Vec<KeyEvent>>>;

278274

279−impl Keymap {

280− pub fn new(root: KeyTrie) -> Self {

281− Keymap(root)

282− }

283−}

284−

285−impl Deref for Keymap {

286− type Target = KeyTrie;

287−

288− fn deref(&self) -> &Self::Target {

289− &self.0

290− }

291−}

292−

293−impl DerefMut for Keymap {

294− fn deref_mut(&mut self) -> &mut Self::Target {

295− &mut self.0

296− }

297−}

298−

299−impl Default for Keymap {

300− fn default() -> Self {

301− Self(KeyTrie::Node(KeyTrieNode::default()))

302− }

303−}

304−

305275pub struct Keymaps {

306− pub map: Box<dyn DynAccess<HashMap<Mode, Keymap>>>,

276+ pub map: Box<dyn DynAccess<HashMap<Mode, KeyTrie>>>,

307277 /// Stores pending keys waiting for the next key. This is relative to a

308278 /// sticky node if one is in use.

309279 state: Vec<KeyEvent>,

@@ -312,7 +282,7 @@ pub struct Keymaps {

312282}

313283

314284impl Keymaps {

315− pub fn new(map: Box<dyn DynAccess<HashMap<Mode, Keymap>>>) -> Self {

285+ pub fn new(map: Box<dyn DynAccess<HashMap<Mode, KeyTrie>>>) -> Self {

316286 Self {

317287 map,

318288 state: Vec::new(),

@@ -320,7 +290,7 @@ impl Keymaps {

320290 }

321291 }

322292

323− pub fn map(&self) -> DynGuard<HashMap<Mode, Keymap>> {

293+ pub fn map(&self) -> DynGuard<HashMap<Mode, KeyTrie>> {

324294 self.map.load()

325295 }

326296

@@ -352,7 +322,7 @@ impl Keymaps {

352322 let first = self.state.get(0).unwrap_or(&key);

353323 let trie_node = match self.sticky {

354324 Some(ref trie) => Cow::Owned(KeyTrie::Node(trie.clone())),

355− None => Cow::Borrowed(&keymap.0),

325+ None => Cow::Borrowed(keymap),

356326 };

357327

358328 let trie = match trie_node.search(&[*first]) {

@@ -395,9 +365,13 @@ impl Default for Keymaps {

395365}

396366

397367/// Merge default config keys with user overwritten keys for custom user config.

398−pub fn merge_keys(dst: &mut HashMap<Mode, Keymap>, mut delta: HashMap<Mode, Keymap>) {

368+pub fn merge_keys(dst: &mut HashMap<Mode, KeyTrie>, mut delta: HashMap<Mode, KeyTrie>) {

399369 for (mode, keys) in dst {

400− keys.merge_nodes(delta.remove(mode).unwrap_or_default().0)

370+ keys.merge_nodes(

371+ delta

372+ .remove(mode)

373+ .unwrap_or_else(|| KeyTrie::Node(KeyTrieNode::default())),

374+ )

401375 }

402376}

403377

@@ -426,8 +400,7 @@ mod tests {

426400 #[test]

427401 fn merge_partial_keys() {

428402 let keymap = hashmap! {

429− Mode::Normal => Keymap::new(

430− keymap!({ "Normal mode"

403+ Mode::Normal => keymap!({ "Normal mode"

431404 "i" => normal_mode,

432405 "无" => insert_mode,

433406 "z" => jump_backward,

@@ -436,7 +409,6 @@ mod tests {

436409 "g" => delete_char_forward,

437410 },

438411 })

439− )

440412 };

441413 let mut merged_keyamp = default();

442414 merge_keys(&mut merged_keyamp, keymap.clone());

@@ -501,8 +473,7 @@ mod tests {

501473 #[test]

502474 fn order_should_be_set() {

503475 let keymap = hashmap! {

504− Mode::Normal => Keymap::new(

505− keymap!({ "Normal mode"

476+ Mode::Normal => keymap!({ "Normal mode"

506477 "space" => { ""

507478 "s" => { ""

508479 "v" => vsplit,

@@ -510,7 +481,6 @@ mod tests {

510481 },

511482 },

512483 })

513− )

514484 };

515485 let mut merged_keyamp = default();

516486 merge_keys(&mut merged_keyamp, keymap.clone());

@@ -553,7 +523,7 @@ mod tests {

553523 },

554524 "j" | "k" => move_line_down,

555525 });

556− let keymap = Keymap::new(normal_mode);

526+ let keymap = normal_mode;

557527 let mut reverse_map = keymap.reverse_map();

558528

559529 // sort keybindings in order to have consistent tests

@@ -601,7 +571,7 @@ mod tests {

601571 modifiers: KeyModifiers::NONE,

602572 };

603573

604− let expectation = Keymap::new(KeyTrie::Node(KeyTrieNode::new(

574+ let expectation = KeyTrie::Node(KeyTrieNode::new(

605575 "",

606576 hashmap! {

607577 key => KeyTrie::Sequence(vec!{

@@ -618,7 +588,7 @@ mod tests {

618588 })

619589 },

620590 vec![key],

621− )));

591+ ));

622592

623593 assert_eq!(toml::from_str(keys), Ok(expectation));

624594 }

helix-term/src/keymap/default.rs+5−5

@@ -1,10 +1,10 @@

11use std::collections::HashMap;

33use super::macros::keymap;

4−use super::{Keymap, Mode};

4+use super::{KeyTrie, Mode};

55use helix_core::hashmap;

7−pub fn default() -> HashMap<Mode, Keymap> {

7+pub fn default() -> HashMap<Mode, KeyTrie> {

88 let normal = keymap!({ "Normal mode"

99 "h" | "left" => move_char_left,

1010 "j" | "down" => move_visual_line_down,

@@ -380,8 +380,8 @@ pub fn default() -> HashMap<Mode, Keymap> {

380380 "end" => goto_line_end_newline,

381381 });

382382 hashmap!(

383− Mode::Normal => Keymap::new(normal),

384− Mode::Select => Keymap::new(select),

385− Mode::Insert => Keymap::new(insert),

383+ Mode::Normal => normal,

384+ Mode::Select => select,

385+ Mode::Insert => insert,

386386 )

387387}

helix-term/src/keymap/macros.rs+2−3

@@ -62,12 +62,11 @@ macro_rules! alt {

6262 };

6363}

6464

65−/// Macro for defining the root of a `Keymap` object. Example:

65+/// Macro for defining a `KeyTrie`. Example:

6666///

6767/// ```

6868/// # use helix_core::hashmap;

6969/// # use helix_term::keymap;

70−/// # use helix_term::keymap::Keymap;

7170/// let normal_mode = keymap!({ "Normal mode"

7271/// "i" => insert_mode,

7372/// "g" => { "Goto"

@@ -76,7 +75,7 @@ macro_rules! alt {

7675/// },

7776/// "j" | "down" => move_line_down,

7877/// });

79−/// let keymap = Keymap::new(normal_mode);

78+/// let keymap = normal_mode;

8079/// ```

8180#[macro_export]

8281macro_rules! keymap {