keymap_parser 1.0.0-rc.7

A Rust library to parse declarative key mapping configurations with support for sequences, key groups, and multiple formats like YAML and TOML.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

//! # Keymap Parser
//!
//! This crate provides functionality for parsing keymaps from strings.
//! It defines the structures for representing keys, modifiers, and key combinations,
//! and provides a parser for converting strings into these structures.
//!
//! # Examples
//!
//! Parse a keymap string into a `Node`:
//! ```
//! use keymap_parser::{parse, Node, Key, Modifier};
//!
//! let input = "ctrl-alt-f";
//! let node = parse(input).unwrap();
//!
//! assert_eq!(node, Node::new(Modifier::Ctrl | Modifier::Alt, Key::Char('f')));
//! ```
//! Parse a sequence of keymap strings into a `Vec<Node>`:
//! ```
//! use keymap_parser::{parse_seq, Node, Key};
//!
//! let input = "g g";
//! let nodes = parse_seq(&input).unwrap();
//!
//! assert_eq!(nodes, vec![
//!     Node::from(Key::Char('g')),
//!     Node::from(Key::Char('g')),
//! ]);
//! ```
pub mod node;
pub mod parser;

pub use node::{Key, Modifier, Modifiers, Node};
pub use parser::{parse, parse_seq};