monolith

public

Star0

Watch0

17 commits 1 branch 0 tags 0 releases1.5 MiB

//! The control protocol. Newline-delimited JSON over a unix socket, one
//! message per line, each carrying the protocol version `v`.
//!
//! Commands also have a word form, `focus left` or `spawn foot`, shared by
//! the CLI and keybindings in the config.

use serde::{Deserialize, Serialize};
use std::fmt;
use std::path::PathBuf;

pub const VERSION: u32 = 1;

/// Where the compositor serving `display` listens.
pub fn socket_path_for(display: &str) -> Option<PathBuf> {
    let dir = std::env::var_os("XDG_RUNTIME_DIR")?;
    Some(PathBuf::from(dir).join(format!("monolith-{display}.sock")))
}

/// Where a client should connect. `$MONOLITH_SOCKET`, else the socket of
/// the compositor serving `$WAYLAND_DISPLAY`.
pub fn socket_path() -> Option<PathBuf> {
    if let Some(p) = std::env::var_os("MONOLITH_SOCKET") {
        return Some(p.into());
    }
    socket_path_for(&std::env::var("WAYLAND_DISPLAY").ok()?)
}

#[derive(Serialize, Deserialize, Clone, Copy, Debug, PartialEq, Eq)]
#[serde(rename_all = "kebab-case")]
pub enum Dir {
    Left,
    Right,
    Up,
    Down,
}

#[derive(Serialize, Deserialize, Clone, Copy, Debug, PartialEq, Eq)]
#[serde(rename_all = "kebab-case")]
pub enum Axis {
    Horizontal,
    Vertical,
}

#[derive(Serialize, Deserialize, Clone, Copy, Debug, PartialEq, Eq, Default)]
#[serde(rename_all = "kebab-case")]
pub enum ExpandScope {
    #[default]
    Window,
    Block,
    All,
}

#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
#[serde(tag = "command", rename_all = "kebab-case", deny_unknown_fields)]
pub enum Command {
    Spawn {
        argv: Vec<String>,
    },
    Close,
    Quit,
    Reload,
    Focus {
        dir: Dir,
    },
    Move {
        dir: Dir,
    },
    MoveBlock {
        dir: Dir,
    },
    Resize {
        axis: Axis,
        delta: f64,
    },
    Expand {
        scope: ExpandScope,
    },
    Flip,
    Float,
    Fullscreen,
    Sticky,
    View {
        tag: String,
    },
    ToggleView {
        tag: String,
    },
    ViewEverywhere {
        tag: String,
    },
    /// Sends the focused window to a tag.
    Tag {
        tag: String,
    },
    ReorderTag {
        tag: String,
        index: usize,
    },
    FocusOutput {
        dir: Dir,
    },
    SendToOutput {
        dir: Dir,
    },
    /// Adds the focused window to a scratchpad.
    Scratchpad {
        name: String,
    },
    Summon {
        name: String,
    },
    Dismiss {
        name: Option<String>,
    },
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ParseError(pub String);

impl fmt::Display for ParseError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str(&self.0)
    }
}

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

impl Command {
    /// Parses the word form, as in `["move-block", "left"]`.
    pub fn parse<S: AsRef<str>>(words: &[S]) -> Result<Self, ParseError> {
        let words: Vec<&str> = words.iter().map(AsRef::as_ref).collect();
        let Some((&name, args)) = words.split_first() else {
            return Err(ParseError("empty command".into()));
        };
        let err = |m: &str| ParseError(format!("{name}: {m}"));
        let one = || match args {
            [a] => Ok(a.to_string()),
            _ => Err(err("takes exactly one argument")),
        };
        let none = |c: Command| {
            if args.is_empty() {
                Ok(c)
            } else {
                Err(err("takes no arguments"))
            }
        };
        let dir = || -> Result<Dir, ParseError> {
            match one()?.as_str() {
                "left" | "h" => Ok(Dir::Left),
                "right" | "l" => Ok(Dir::Right),
                "up" | "k" => Ok(Dir::Up),
                "down" | "j" => Ok(Dir::Down),
                d => Err(err(&format!("unknown direction {d}"))),
            }
        };
        Ok(match name {
            "spawn" if !args.is_empty() => Command::Spawn {
                argv: args.iter().map(|a| a.to_string()).collect(),
            },
            "spawn" => return Err(err("needs a program")),
            "close" => none(Command::Close)?,
            "quit" => none(Command::Quit)?,
            "reload" => none(Command::Reload)?,
            "flip" => none(Command::Flip)?,
            "float" => none(Command::Float)?,
            "fullscreen" => none(Command::Fullscreen)?,
            "sticky" => none(Command::Sticky)?,
            "focus" => Command::Focus { dir: dir()? },
            "move" => Command::Move { dir: dir()? },
            "move-block" => Command::MoveBlock { dir: dir()? },
            "focus-output" => Command::FocusOutput { dir: dir()? },
            "send-to-output" => Command::SendToOutput { dir: dir()? },
            "resize" => {
                let [axis, delta] = args else {
                    return Err(err("takes an axis and a delta"));
                };
                let axis = match *axis {
                    "horizontal" | "h" => Axis::Horizontal,
                    "vertical" | "v" => Axis::Vertical,
                    a => return Err(err(&format!("unknown axis {a}"))),
                };
                let delta = delta
                    .parse()
                    .map_err(|_| err(&format!("bad delta {delta}")))?;
                Command::Resize { axis, delta }
            }
            "expand" => Command::Expand {
                scope: match args {
                    [] | ["window"] => ExpandScope::Window,
                    ["block"] => ExpandScope::Block,
                    ["all"] => ExpandScope::All,
                    _ => return Err(err("takes window, block or all")),
                },
            },
            "view" => Command::View { tag: one()? },
            "toggle-view" => Command::ToggleView { tag: one()? },
            "view-everywhere" => Command::ViewEverywhere { tag: one()? },
            "tag" => Command::Tag { tag: one()? },
            "reorder-tag" => {
                let [tag, index] = args else {
                    return Err(err("takes a tag and an index"));
                };
                let index = index
                    .parse()
                    .map_err(|_| err(&format!("bad index {index}")))?;
                Command::ReorderTag {
                    tag: tag.to_string(),
                    index,
                }
            }
            "scratchpad" => Command::Scratchpad { name: one()? },
            "summon" => Command::Summon { name: one()? },
            "dismiss" => Command::Dismiss {
                name: match args {
                    [] => None,
                    [n] => Some(n.to_string()),
                    _ => return Err(err("takes at most one name")),
                },
            },
            _ => return Err(ParseError(format!("unknown command {name}"))),
        })
    }
}

#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
#[serde(rename_all = "kebab-case")]
pub enum Request {
    Run(Command),
    Get(Query),
    /// Streams a `State` event after every change until the client hangs up.
    Subscribe {},
}

#[derive(Serialize, Deserialize, Clone, Copy, Debug, PartialEq, Eq)]
#[serde(rename_all = "kebab-case")]
pub enum Query {
    State,
    Version,
}

#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
pub struct Envelope<T> {
    pub v: u32,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub id: Option<u64>,
    #[serde(flatten)]
    pub body: T,
}

impl<T> Envelope<T> {
    pub fn new(id: Option<u64>, body: T) -> Self {
        Self {
            v: VERSION,
            id,
            body,
        }
    }
}

#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
#[serde(rename_all = "kebab-case")]
pub enum Reply {
    Ok(Option<Answer>),
    Error(String),
    Event(State),
}

#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
#[serde(rename_all = "kebab-case")]
pub enum Answer {
    State(State),
    Version(String),
}

#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Default)]
pub struct State {
    pub tags: Vec<Tag>,
    pub outputs: Vec<Output>,
    pub windows: Vec<Window>,
}

#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
pub struct Tag {
    pub name: String,
    pub urgent: bool,
}

#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
pub struct Output {
    pub name: String,
    /// x, y, width, height in logical pixels.
    pub area: [f64; 4],
    pub viewed: Vec<String>,
    pub active: bool,
}

#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
pub struct Window {
    pub id: u64,
    pub app_id: String,
    pub title: String,
    pub tag: String,
    pub output: Option<String>,
    pub floating: bool,
    pub fullscreen: bool,
    pub sticky: bool,
    pub scratchpad: Option<String>,
    pub visible: bool,
    pub focused: bool,
}

1	//! The control protocol. Newline-delimited JSON over a unix socket, one
2	//! message per line, each carrying the protocol version `v`.
3	//!
4	//! Commands also have a word form, `focus left` or `spawn foot`, shared by
5	//! the CLI and keybindings in the config.
6
7	use serde::{Deserialize, Serialize};
8	use std::fmt;
9	use std::path::PathBuf;
10
11	pub const VERSION: u32 = 1;
12
13	/// Where the compositor serving `display` listens.
14	pub fn socket_path_for(display: &str) -> Option<PathBuf> {
15	let dir = std::env::var_os("XDG_RUNTIME_DIR")?;
16	Some(PathBuf::from(dir).join(format!("monolith-{display}.sock")))
17	}
18
19	/// Where a client should connect. `$MONOLITH_SOCKET`, else the socket of
20	/// the compositor serving `$WAYLAND_DISPLAY`.
21	pub fn socket_path() -> Option<PathBuf> {
22	if let Some(p) = std::env::var_os("MONOLITH_SOCKET") {
23	return Some(p.into());
24	}
25	socket_path_for(&std::env::var("WAYLAND_DISPLAY").ok()?)
26	}
27
28	#[derive(Serialize, Deserialize, Clone, Copy, Debug, PartialEq, Eq)]
29	#[serde(rename_all = "kebab-case")]
30	pub enum Dir {
31	Left,
32	Right,
33	Up,
34	Down,
35	}
36
37	#[derive(Serialize, Deserialize, Clone, Copy, Debug, PartialEq, Eq)]
38	#[serde(rename_all = "kebab-case")]
39	pub enum Axis {
40	Horizontal,
41	Vertical,
42	}
43
44	#[derive(Serialize, Deserialize, Clone, Copy, Debug, PartialEq, Eq, Default)]
45	#[serde(rename_all = "kebab-case")]
46	pub enum ExpandScope {
47	#[default]
48	Window,
49	Block,
50	All,
51	}
52
53	#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
54	#[serde(tag = "command", rename_all = "kebab-case", deny_unknown_fields)]
55	pub enum Command {
56	Spawn {
57	argv: Vec<String>,
58	},
59	Close,
60	Quit,
61	Reload,
62	Focus {
63	dir: Dir,
64	},
65	Move {
66	dir: Dir,
67	},
68	MoveBlock {
69	dir: Dir,
70	},
71	Resize {
72	axis: Axis,
73	delta: f64,
74	},
75	Expand {
76	scope: ExpandScope,
77	},
78	Flip,
79	Float,
80	Fullscreen,
81	Sticky,
82	View {
83	tag: String,
84	},
85	ToggleView {
86	tag: String,
87	},
88	ViewEverywhere {
89	tag: String,
90	},
91	/// Sends the focused window to a tag.
92	Tag {
93	tag: String,
94	},
95	ReorderTag {
96	tag: String,
97	index: usize,
98	},
99	FocusOutput {
100	dir: Dir,
101	},
102	SendToOutput {
103	dir: Dir,
104	},
105	/// Adds the focused window to a scratchpad.
106	Scratchpad {
107	name: String,
108	},
109	Summon {
110	name: String,
111	},
112	Dismiss {
113	name: Option<String>,
114	},
115	}
116
117	#[derive(Debug, Clone, PartialEq, Eq)]
118	pub struct ParseError(pub String);
119
120	impl fmt::Display for ParseError {
121	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
122	f.write_str(&self.0)
123	}
124	}
125
126	impl std::error::Error for ParseError {}
127
128	impl Command {
129	/// Parses the word form, as in `["move-block", "left"]`.
130	pub fn parse<S: AsRef<str>>(words: &[S]) -> Result<Self, ParseError> {
131	let words: Vec<&str> = words.iter().map(AsRef::as_ref).collect();
132	let Some((&name, args)) = words.split_first() else {
133	return Err(ParseError("empty command".into()));
134	};
135	let err = \|m: &str\| ParseError(format!("{name}: {m}"));
136	let one = \|\| match args {
137	[a] => Ok(a.to_string()),
138	_ => Err(err("takes exactly one argument")),
139	};
140	let none = \|c: Command\| {
141	if args.is_empty() {
142	Ok(c)
143	} else {
144	Err(err("takes no arguments"))
145	}
146	};
147	let dir = \|\| -> Result<Dir, ParseError> {
148	match one()?.as_str() {
149	"left" \| "h" => Ok(Dir::Left),
150	"right" \| "l" => Ok(Dir::Right),
151	"up" \| "k" => Ok(Dir::Up),
152	"down" \| "j" => Ok(Dir::Down),
153	d => Err(err(&format!("unknown direction {d}"))),
154	}
155	};
156	Ok(match name {
157	"spawn" if !args.is_empty() => Command::Spawn {
158	argv: args.iter().map(\|a\| a.to_string()).collect(),
159	},
160	"spawn" => return Err(err("needs a program")),
161	"close" => none(Command::Close)?,
162	"quit" => none(Command::Quit)?,
163	"reload" => none(Command::Reload)?,
164	"flip" => none(Command::Flip)?,
165	"float" => none(Command::Float)?,
166	"fullscreen" => none(Command::Fullscreen)?,
167	"sticky" => none(Command::Sticky)?,
168	"focus" => Command::Focus { dir: dir()? },
169	"move" => Command::Move { dir: dir()? },
170	"move-block" => Command::MoveBlock { dir: dir()? },
171	"focus-output" => Command::FocusOutput { dir: dir()? },
172	"send-to-output" => Command::SendToOutput { dir: dir()? },
173	"resize" => {
174	let [axis, delta] = args else {
175	return Err(err("takes an axis and a delta"));
176	};
177	let axis = match *axis {
178	"horizontal" \| "h" => Axis::Horizontal,
179	"vertical" \| "v" => Axis::Vertical,
180	a => return Err(err(&format!("unknown axis {a}"))),
181	};
182	let delta = delta
183	.parse()
184	.map_err(\|_\| err(&format!("bad delta {delta}")))?;
185	Command::Resize { axis, delta }
186	}
187	"expand" => Command::Expand {
188	scope: match args {
189	[] \| ["window"] => ExpandScope::Window,
190	["block"] => ExpandScope::Block,
191	["all"] => ExpandScope::All,
192	_ => return Err(err("takes window, block or all")),
193	},
194	},
195	"view" => Command::View { tag: one()? },
196	"toggle-view" => Command::ToggleView { tag: one()? },
197	"view-everywhere" => Command::ViewEverywhere { tag: one()? },
198	"tag" => Command::Tag { tag: one()? },
199	"reorder-tag" => {
200	let [tag, index] = args else {
201	return Err(err("takes a tag and an index"));
202	};
203	let index = index
204	.parse()
205	.map_err(\|_\| err(&format!("bad index {index}")))?;
206	Command::ReorderTag {
207	tag: tag.to_string(),
208	index,
209	}
210	}
211	"scratchpad" => Command::Scratchpad { name: one()? },
212	"summon" => Command::Summon { name: one()? },
213	"dismiss" => Command::Dismiss {
214	name: match args {
215	[] => None,
216	[n] => Some(n.to_string()),
217	_ => return Err(err("takes at most one name")),
218	},
219	},
220	_ => return Err(ParseError(format!("unknown command {name}"))),
221	})
222	}
223	}
224
225	#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
226	#[serde(rename_all = "kebab-case")]
227	pub enum Request {
228	Run(Command),
229	Get(Query),
230	/// Streams a `State` event after every change until the client hangs up.
231	Subscribe {},
232	}
233
234	#[derive(Serialize, Deserialize, Clone, Copy, Debug, PartialEq, Eq)]
235	#[serde(rename_all = "kebab-case")]
236	pub enum Query {
237	State,
238	Version,
239	}
240
241	#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
242	pub struct Envelope<T> {
243	pub v: u32,
244	#[serde(default, skip_serializing_if = "Option::is_none")]
245	pub id: Option<u64>,
246	#[serde(flatten)]
247	pub body: T,
248	}
249
250	impl<T> Envelope<T> {
251	pub fn new(id: Option<u64>, body: T) -> Self {
252	Self {
253	v: VERSION,
254	id,
255	body,
256	}
257	}
258	}
259
260	#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
261	#[serde(rename_all = "kebab-case")]
262	pub enum Reply {
263	Ok(Option<Answer>),
264	Error(String),
265	Event(State),
266	}
267
268	#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
269	#[serde(rename_all = "kebab-case")]
270	pub enum Answer {
271	State(State),
272	Version(String),
273	}
274
275	#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Default)]
276	pub struct State {
277	pub tags: Vec<Tag>,
278	pub outputs: Vec<Output>,
279	pub windows: Vec<Window>,
280	}
281
282	#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
283	pub struct Tag {
284	pub name: String,
285	pub urgent: bool,
286	}
287
288	#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
289	pub struct Output {
290	pub name: String,
291	/// x, y, width, height in logical pixels.
292	pub area: [f64; 4],
293	pub viewed: Vec<String>,
294	pub active: bool,
295	}
296
297	#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
298	pub struct Window {
299	pub id: u64,
300	pub app_id: String,
301	pub title: String,
302	pub tag: String,
303	pub output: Option<String>,
304	pub floating: bool,
305	pub fullscreen: bool,
306	pub sticky: bool,
307	pub scratchpad: Option<String>,
308	pub visible: bool,
309	pub focused: bool,
310	}