monolith

public

Star0

Watch0

21 commits 1 branch 0 tags 0 releases1.5 MiB

//! The TOML config. Parsing and validation only, the compositor applies it.

use monolith_ipc::Command;
use regex::Regex;
use serde::Deserialize;
use std::collections::BTreeMap;
use std::fmt;
use std::path::{Path, PathBuf};

pub const DEFAULT: &str = include_str!("../default.toml");

#[derive(Debug, Clone)]
pub struct Config {
    pub general: General,
    pub animation: Animation,
    pub keyboard: Keyboard,
    pub binds: Vec<Bind>,
    pub rules: Vec<Rule>,
    pub startup: Vec<Vec<String>>,
}

#[derive(Deserialize, Debug, Clone, PartialEq)]
#[serde(default, deny_unknown_fields)]
pub struct General {
    /// What `Mod` means in binds.
    #[serde(rename = "mod")]
    pub mod_key: Modifier,
    pub gaps: Gaps,
}

impl Default for General {
    fn default() -> Self {
        Self {
            mod_key: Modifier::Super,
            gaps: Gaps::default(),
        }
    }
}

#[derive(Deserialize, Debug, Clone, Copy, PartialEq)]
#[serde(default, deny_unknown_fields)]
pub struct Gaps {
    pub inner: f64,
    pub outer: f64,
}

impl Default for Gaps {
    fn default() -> Self {
        Self {
            inner: 8.0,
            outer: 8.0,
        }
    }
}

#[derive(Deserialize, Debug, Clone, PartialEq)]
#[serde(default, deny_unknown_fields)]
pub struct Animation {
    pub enabled: bool,
    pub style: AnimationStyle,
    /// Every phase of a planned transition lasts this long.
    pub phase_ms: u64,
    /// A cubic bezier, as in CSS.
    pub curve: [f64; 4],
}

impl Default for Animation {
    fn default() -> Self {
        Self {
            enabled: true,
            style: AnimationStyle::Orthogonal,
            phase_ms: 160,
            curve: [0.45, 0.0, 0.2, 1.0],
        }
    }
}

#[derive(Deserialize, Debug, Clone, Copy, PartialEq, Eq)]
#[serde(rename_all = "lowercase")]
pub enum AnimationStyle {
    Orthogonal,
    Direct,
}

#[derive(Deserialize, Debug, Clone, PartialEq)]
#[serde(default, deny_unknown_fields)]
pub struct Keyboard {
    pub rules: String,
    pub model: String,
    pub layout: String,
    pub variant: String,
    pub options: Option<String>,
    pub repeat_delay: i32,
    pub repeat_rate: i32,
}

impl Default for Keyboard {
    fn default() -> Self {
        Self {
            rules: String::new(),
            model: String::new(),
            layout: String::new(),
            variant: String::new(),
            options: None,
            repeat_delay: 200,
            repeat_rate: 25,
        }
    }
}

#[derive(Deserialize, Debug, Clone, Copy, PartialEq, Eq)]
#[serde(rename_all = "lowercase")]
pub enum Modifier {
    Super,
    Alt,
    Ctrl,
    Shift,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Hash)]
pub struct Mods {
    pub logo: bool,
    pub alt: bool,
    pub ctrl: bool,
    pub shift: bool,
}

impl Mods {
    fn set(&mut self, m: Modifier) {
        match m {
            Modifier::Super => self.logo = true,
            Modifier::Alt => self.alt = true,
            Modifier::Ctrl => self.ctrl = true,
            Modifier::Shift => self.shift = true,
        }
    }
}

#[derive(Debug, Clone, PartialEq)]
pub struct Bind {
    pub mods: Mods,
    /// An xkb keysym name, resolved by the compositor.
    pub key: String,
    pub command: Command,
}

#[derive(Debug, Clone)]
pub struct Rule {
    pub app_id: Option<Regex>,
    pub title: Option<Regex>,
    pub tag: Option<String>,
    pub output: Option<String>,
    pub floating: Option<bool>,
    pub sticky: Option<bool>,
    pub scratchpad: Option<String>,
}

/// Everything the matching rules say about a window, later rules winning.
#[derive(Debug, Clone, Default, PartialEq)]
pub struct Placement {
    pub tag: Option<String>,
    pub output: Option<String>,
    pub floating: Option<bool>,
    pub sticky: Option<bool>,
    pub scratchpad: Option<String>,
}

#[derive(Debug)]
pub enum Error {
    Io(PathBuf, std::io::Error),
    Toml(toml::de::Error),
    Bind(String, String),
    Regex(String, regex::Error),
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Error::Io(p, e) => write!(f, "{}: {e}", p.display()),
            Error::Toml(e) => write!(f, "{e}"),
            Error::Bind(k, e) => write!(f, "bind {k:?}: {e}"),
            Error::Regex(r, e) => write!(f, "rule pattern {r:?}: {e}"),
        }
    }
}

impl std::error::Error for Error {}

#[derive(Deserialize)]
#[serde(deny_unknown_fields)]
struct Raw {
    #[serde(default)]
    startup: Vec<Vec<String>>,
    #[serde(default)]
    general: General,
    #[serde(default)]
    keyboard: Keyboard,
    #[serde(default)]
    animation: Animation,
    #[serde(default)]
    binds: BTreeMap<String, Words>,
    #[serde(default)]
    rules: Vec<RawRule>,
}

#[derive(Deserialize)]
#[serde(untagged)]
enum Words {
    Line(String),
    List(Vec<String>),
}

#[derive(Deserialize)]
#[serde(deny_unknown_fields)]
struct RawRule {
    app_id: Option<String>,
    title: Option<String>,
    tag: Option<String>,
    output: Option<String>,
    floating: Option<bool>,
    sticky: Option<bool>,
    scratchpad: Option<String>,
}

impl Config {
    /// `$MONOLITH_CONFIG`, else `$XDG_CONFIG_HOME/monolith/config.toml`.
    pub fn path() -> Option<PathBuf> {
        if let Some(p) = std::env::var_os("MONOLITH_CONFIG") {
            return Some(p.into());
        }
        let base = std::env::var_os("XDG_CONFIG_HOME")
            .map(PathBuf::from)
            .or_else(|| std::env::var_os("HOME").map(|h| PathBuf::from(h).join(".config")))?;
        Some(base.join("monolith/config.toml"))
    }

    /// Loads `path`, or the built-in default when it does not exist.
    pub fn load(path: Option<&Path>) -> Result<Self, Error> {
        match path {
            Some(p) => match std::fs::read_to_string(p) {
                Ok(text) => Self::parse(&text),
                Err(e) if e.kind() == std::io::ErrorKind::NotFound => Self::parse(DEFAULT),
                Err(e) => Err(Error::Io(p.to_owned(), e)),
            },
            None => Self::parse(DEFAULT),
        }
    }

    pub fn parse(text: &str) -> Result<Self, Error> {
        let raw: Raw = toml::from_str(text).map_err(Error::Toml)?;
        let mod_key = raw.general.mod_key;
        let binds = raw
            .binds
            .into_iter()
            .map(|(combo, words)| parse_bind(&combo, words, mod_key))
            .collect::<Result<_, _>>()?;
        let regex = |p: Option<String>| {
            p.map(|p| Regex::new(&p).map_err(|e| Error::Regex(p, e)))
                .transpose()
        };
        let rules = raw
            .rules
            .into_iter()
            .map(|r| {
                Ok(Rule {
                    app_id: regex(r.app_id)?,
                    title: regex(r.title)?,
                    tag: r.tag,
                    output: r.output,
                    floating: r.floating,
                    sticky: r.sticky,
                    scratchpad: r.scratchpad,
                })
            })
            .collect::<Result<_, Error>>()?;
        Ok(Self {
            general: raw.general,
            animation: raw.animation,
            keyboard: raw.keyboard,
            binds,
            rules,
            startup: raw.startup,
        })
    }

    pub fn placement(&self, app_id: &str, title: &str) -> Placement {
        let mut p = Placement::default();
        let hit = |re: &Option<Regex>, s: &str| re.as_ref().is_none_or(|re| re.is_match(s));
        for r in &self.rules {
            if !hit(&r.app_id, app_id) || !hit(&r.title, title) {
                continue;
            }
            p.tag = r.tag.clone().or(p.tag);
            p.output = r.output.clone().or(p.output);
            p.floating = r.floating.or(p.floating);
            p.sticky = r.sticky.or(p.sticky);
            p.scratchpad = r.scratchpad.clone().or(p.scratchpad);
        }
        p
    }
}

fn parse_bind(combo: &str, words: Words, mod_key: Modifier) -> Result<Bind, Error> {
    let bad = |m: String| Error::Bind(combo.to_owned(), m);
    let parts: Vec<&str> = combo.split('+').map(str::trim).collect();
    let Some((&key, mods)) = parts.split_last().filter(|(k, _)| !k.is_empty()) else {
        return Err(bad("no key".into()));
    };
    let mut set = Mods::default();
    for m in mods {
        let m = match m.to_ascii_lowercase().as_str() {
            "mod" => mod_key,
            "super" | "logo" | "win" => Modifier::Super,
            "alt" => Modifier::Alt,
            "ctrl" | "control" => Modifier::Ctrl,
            "shift" => Modifier::Shift,
            other => return Err(bad(format!("unknown modifier {other}"))),
        };
        set.set(m);
    }
    let words: Vec<String> = match words {
        Words::Line(s) => s.split_whitespace().map(str::to_owned).collect(),
        Words::List(v) => v,
    };
    let command = Command::parse(&words).map_err(|e| bad(e.0))?;
    Ok(Bind {
        mods: set,
        key: key.to_owned(),
        command,
    })
}

#[cfg(test)]
mod tests {
    #[test]
    fn the_default_config_parses() {
        let c = super::Config::parse(super::DEFAULT).unwrap();
        assert!(c.binds.len() > 40);
    }
}

1	//! The TOML config. Parsing and validation only, the compositor applies it.
2
3	use monolith_ipc::Command;
4	use regex::Regex;
5	use serde::Deserialize;
6	use std::collections::BTreeMap;
7	use std::fmt;
8	use std::path::{Path, PathBuf};
9
10	pub const DEFAULT: &str = include_str!("../default.toml");
11
12	#[derive(Debug, Clone)]
13	pub struct Config {
14	pub general: General,
15	pub animation: Animation,
16	pub keyboard: Keyboard,
17	pub binds: Vec<Bind>,
18	pub rules: Vec<Rule>,
19	pub startup: Vec<Vec<String>>,
20	}
21
22	#[derive(Deserialize, Debug, Clone, PartialEq)]
23	#[serde(default, deny_unknown_fields)]
24	pub struct General {
25	/// What `Mod` means in binds.
26	#[serde(rename = "mod")]
27	pub mod_key: Modifier,
28	pub gaps: Gaps,
29	}
30
31	impl Default for General {
32	fn default() -> Self {
33	Self {
34	mod_key: Modifier::Super,
35	gaps: Gaps::default(),
36	}
37	}
38	}
39
40	#[derive(Deserialize, Debug, Clone, Copy, PartialEq)]
41	#[serde(default, deny_unknown_fields)]
42	pub struct Gaps {
43	pub inner: f64,
44	pub outer: f64,
45	}
46
47	impl Default for Gaps {
48	fn default() -> Self {
49	Self {
50	inner: 8.0,
51	outer: 8.0,
52	}
53	}
54	}
55
56	#[derive(Deserialize, Debug, Clone, PartialEq)]
57	#[serde(default, deny_unknown_fields)]
58	pub struct Animation {
59	pub enabled: bool,
60	pub style: AnimationStyle,
61	/// Every phase of a planned transition lasts this long.
62	pub phase_ms: u64,
63	/// A cubic bezier, as in CSS.
64	pub curve: [f64; 4],
65	}
66
67	impl Default for Animation {
68	fn default() -> Self {
69	Self {
70	enabled: true,
71	style: AnimationStyle::Orthogonal,
72	phase_ms: 160,
73	curve: [0.45, 0.0, 0.2, 1.0],
74	}
75	}
76	}
77
78	#[derive(Deserialize, Debug, Clone, Copy, PartialEq, Eq)]
79	#[serde(rename_all = "lowercase")]
80	pub enum AnimationStyle {
81	Orthogonal,
82	Direct,
83	}
84
85	#[derive(Deserialize, Debug, Clone, PartialEq)]
86	#[serde(default, deny_unknown_fields)]
87	pub struct Keyboard {
88	pub rules: String,
89	pub model: String,
90	pub layout: String,
91	pub variant: String,
92	pub options: Option<String>,
93	pub repeat_delay: i32,
94	pub repeat_rate: i32,
95	}
96
97	impl Default for Keyboard {
98	fn default() -> Self {
99	Self {
100	rules: String::new(),
101	model: String::new(),
102	layout: String::new(),
103	variant: String::new(),
104	options: None,
105	repeat_delay: 200,
106	repeat_rate: 25,
107	}
108	}
109	}
110
111	#[derive(Deserialize, Debug, Clone, Copy, PartialEq, Eq)]
112	#[serde(rename_all = "lowercase")]
113	pub enum Modifier {
114	Super,
115	Alt,
116	Ctrl,
117	Shift,
118	}
119
120	#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Hash)]
121	pub struct Mods {
122	pub logo: bool,
123	pub alt: bool,
124	pub ctrl: bool,
125	pub shift: bool,
126	}
127
128	impl Mods {
129	fn set(&mut self, m: Modifier) {
130	match m {
131	Modifier::Super => self.logo = true,
132	Modifier::Alt => self.alt = true,
133	Modifier::Ctrl => self.ctrl = true,
134	Modifier::Shift => self.shift = true,
135	}
136	}
137	}
138
139	#[derive(Debug, Clone, PartialEq)]
140	pub struct Bind {
141	pub mods: Mods,
142	/// An xkb keysym name, resolved by the compositor.
143	pub key: String,
144	pub command: Command,
145	}
146
147	#[derive(Debug, Clone)]
148	pub struct Rule {
149	pub app_id: Option<Regex>,
150	pub title: Option<Regex>,
151	pub tag: Option<String>,
152	pub output: Option<String>,
153	pub floating: Option<bool>,
154	pub sticky: Option<bool>,
155	pub scratchpad: Option<String>,
156	}
157
158	/// Everything the matching rules say about a window, later rules winning.
159	#[derive(Debug, Clone, Default, PartialEq)]
160	pub struct Placement {
161	pub tag: Option<String>,
162	pub output: Option<String>,
163	pub floating: Option<bool>,
164	pub sticky: Option<bool>,
165	pub scratchpad: Option<String>,
166	}
167
168	#[derive(Debug)]
169	pub enum Error {
170	Io(PathBuf, std::io::Error),
171	Toml(toml::de::Error),
172	Bind(String, String),
173	Regex(String, regex::Error),
174	}
175
176	impl fmt::Display for Error {
177	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
178	match self {
179	Error::Io(p, e) => write!(f, "{}: {e}", p.display()),
180	Error::Toml(e) => write!(f, "{e}"),
181	Error::Bind(k, e) => write!(f, "bind {k:?}: {e}"),
182	Error::Regex(r, e) => write!(f, "rule pattern {r:?}: {e}"),
183	}
184	}
185	}
186
187	impl std::error::Error for Error {}
188
189	#[derive(Deserialize)]
190	#[serde(deny_unknown_fields)]
191	struct Raw {
192	#[serde(default)]
193	startup: Vec<Vec<String>>,
194	#[serde(default)]
195	general: General,
196	#[serde(default)]
197	keyboard: Keyboard,
198	#[serde(default)]
199	animation: Animation,
200	#[serde(default)]
201	binds: BTreeMap<String, Words>,
202	#[serde(default)]
203	rules: Vec<RawRule>,
204	}
205
206	#[derive(Deserialize)]
207	#[serde(untagged)]
208	enum Words {
209	Line(String),
210	List(Vec<String>),
211	}
212
213	#[derive(Deserialize)]
214	#[serde(deny_unknown_fields)]
215	struct RawRule {
216	app_id: Option<String>,
217	title: Option<String>,
218	tag: Option<String>,
219	output: Option<String>,
220	floating: Option<bool>,
221	sticky: Option<bool>,
222	scratchpad: Option<String>,
223	}
224
225	impl Config {
226	/// `$MONOLITH_CONFIG`, else `$XDG_CONFIG_HOME/monolith/config.toml`.
227	pub fn path() -> Option<PathBuf> {
228	if let Some(p) = std::env::var_os("MONOLITH_CONFIG") {
229	return Some(p.into());
230	}
231	let base = std::env::var_os("XDG_CONFIG_HOME")
232	.map(PathBuf::from)
233	.or_else(\|\| std::env::var_os("HOME").map(\|h\| PathBuf::from(h).join(".config")))?;
234	Some(base.join("monolith/config.toml"))
235	}
236
237	/// Loads `path`, or the built-in default when it does not exist.
238	pub fn load(path: Option<&Path>) -> Result<Self, Error> {
239	match path {
240	Some(p) => match std::fs::read_to_string(p) {
241	Ok(text) => Self::parse(&text),
242	Err(e) if e.kind() == std::io::ErrorKind::NotFound => Self::parse(DEFAULT),
243	Err(e) => Err(Error::Io(p.to_owned(), e)),
244	},
245	None => Self::parse(DEFAULT),
246	}
247	}
248
249	pub fn parse(text: &str) -> Result<Self, Error> {
250	let raw: Raw = toml::from_str(text).map_err(Error::Toml)?;
251	let mod_key = raw.general.mod_key;
252	let binds = raw
253	.binds
254	.into_iter()
255	.map(\|(combo, words)\| parse_bind(&combo, words, mod_key))
256	.collect::<Result<_, _>>()?;
257	let regex = \|p: Option<String>\| {
258	p.map(\|p\| Regex::new(&p).map_err(\|e\| Error::Regex(p, e)))
259	.transpose()
260	};
261	let rules = raw
262	.rules
263	.into_iter()
264	.map(\|r\| {
265	Ok(Rule {
266	app_id: regex(r.app_id)?,
267	title: regex(r.title)?,
268	tag: r.tag,
269	output: r.output,
270	floating: r.floating,
271	sticky: r.sticky,
272	scratchpad: r.scratchpad,
273	})
274	})
275	.collect::<Result<_, Error>>()?;
276	Ok(Self {
277	general: raw.general,
278	animation: raw.animation,
279	keyboard: raw.keyboard,
280	binds,
281	rules,
282	startup: raw.startup,
283	})
284	}
285
286	pub fn placement(&self, app_id: &str, title: &str) -> Placement {
287	let mut p = Placement::default();
288	let hit = \|re: &Option<Regex>, s: &str\| re.as_ref().is_none_or(\|re\| re.is_match(s));
289	for r in &self.rules {
290	if !hit(&r.app_id, app_id) \|\| !hit(&r.title, title) {
291	continue;
292	}
293	p.tag = r.tag.clone().or(p.tag);
294	p.output = r.output.clone().or(p.output);
295	p.floating = r.floating.or(p.floating);
296	p.sticky = r.sticky.or(p.sticky);
297	p.scratchpad = r.scratchpad.clone().or(p.scratchpad);
298	}
299	p
300	}
301	}
302
303	fn parse_bind(combo: &str, words: Words, mod_key: Modifier) -> Result<Bind, Error> {
304	let bad = \|m: String\| Error::Bind(combo.to_owned(), m);
305	let parts: Vec<&str> = combo.split('+').map(str::trim).collect();
306	let Some((&key, mods)) = parts.split_last().filter(\|(k, _)\| !k.is_empty()) else {
307	return Err(bad("no key".into()));
308	};
309	let mut set = Mods::default();
310	for m in mods {
311	let m = match m.to_ascii_lowercase().as_str() {
312	"mod" => mod_key,
313	"super" \| "logo" \| "win" => Modifier::Super,
314	"alt" => Modifier::Alt,
315	"ctrl" \| "control" => Modifier::Ctrl,
316	"shift" => Modifier::Shift,
317	other => return Err(bad(format!("unknown modifier {other}"))),
318	};
319	set.set(m);
320	}
321	let words: Vec<String> = match words {
322	Words::Line(s) => s.split_whitespace().map(str::to_owned).collect(),
323	Words::List(v) => v,
324	};
325	let command = Command::parse(&words).map_err(\|e\| bad(e.0))?;
326	Ok(Bind {
327	mods: set,
328	key: key.to_owned(),
329	command,
330	})
331	}
332
333	#[cfg(test)]
334	mod tests {
335	#[test]
336	fn the_default_config_parses() {
337	let c = super::Config::parse(super::DEFAULT).unwrap();
338	assert!(c.binds.len() > 40);
339	}
340	}