hyprland 0.3.13

A unoffical rust wrapper for hyprland's IPC
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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
use derive_more::{Constructor, Display as MDisplay};
use std::fmt::Display as FDisplay;
use strum::{Display as SDisplay, EnumProperty};

use crate::shared::*;

/// Reload hyprland config
pub mod reload {
    use super::*;
    /// Reload hyprland config
    pub fn call() -> crate::Result<()> {
        write_to_socket_sync(
            get_socket_path(SocketType::Command),
            command!(Empty, "reload"),
        )?;
        Ok(())
    }
    /// Reload hyprland config (async)
    pub async fn call_async() -> crate::Result<()> {
        write_to_socket(
            get_socket_path(SocketType::Command),
            command!(Empty, "reload"),
        )
        .await?;
        Ok(())
    }
}
/// Enter kill mode (similar to xkill)
pub mod kill {
    use super::*;
    /// Enter kill mode (similar to xkill)
    pub fn call() -> crate::Result<()> {
        write_to_socket_sync(
            get_socket_path(SocketType::Command),
            command!(Empty, "kill"),
        )?;
        Ok(())
    }
    /// Enter kill mode (similar to xkill) (async)
    pub async fn call_async() -> crate::Result<()> {
        write_to_socket(
            get_socket_path(SocketType::Command),
            command!(Empty, "kill"),
        )
        .await?;
        Ok(())
    }
}

/// Set the cursor theme
pub mod set_cursor {
    use super::*;
    /// Set the cursor theme
    pub fn call<Str: FDisplay>(theme: Str, size: u16) -> crate::Result<()> {
        write_to_socket_sync(
            get_socket_path(SocketType::Command),
            command!(Empty, "setcursor {theme} {size}"),
        )?;
        Ok(())
    }
    /// Set the cursor theme (async)
    pub async fn call_async<Str: FDisplay>(theme: Str, size: u16) -> crate::Result<()> {
        write_to_socket(
            get_socket_path(SocketType::Command),
            command!(Empty, "setcursor {theme} {size}"),
        )
        .await?;
        Ok(())
    }
}

/// Stuff related to managing virtual outputs/displays
pub mod output {
    use super::*;
    /// Output backend types
    #[derive(SDisplay)]
    pub enum OutputBackends {
        /// The wayland output backend
        #[strum(serialize = "wayland")]
        Wayland,
        /// The x11 output backend
        #[strum(serialize = "x11")]
        X11,
        /// The headless output backend
        #[strum(serialize = "headless")]
        Headless,
        /// Let Hyprland decide the backend type
        #[strum(serialize = "auto")]
        Auto,
    }

    /// Create virtual displays
    pub fn create(backend: OutputBackends) -> crate::Result<()> {
        write_to_socket_sync(
            get_socket_path(SocketType::Command),
            command!(Empty, "output create {backend}"),
        )?;
        Ok(())
    }
    /// Remove virtual displays
    pub fn remove<Str: FDisplay>(name: Str) -> crate::Result<()> {
        write_to_socket_sync(
            get_socket_path(SocketType::Command),
            command!(Empty, "output remove {name}"),
        )?;
        Ok(())
    }
}

/// Switch the xkb layout index for a keyboard
pub mod switch_xkb_layout {
    use super::*;
    /// The types of Cmds used by [switch_xkb_layout]
    #[derive(MDisplay)]
    pub enum SwitchXKBLayoutCmdTypes {
        /// Next input
        #[display(fmt = "next")]
        Next,
        /// Previous inout
        #[display(fmt = "prev")]
        Previous,
        /// Set to a specific input id
        #[display(fmt = "{}", "_0")]
        Id(u8),
    }

    /// Switch the xkb layout index for a keyboard
    pub fn call<Str: FDisplay>(device: Str, cmd: SwitchXKBLayoutCmdTypes) -> crate::Result<()> {
        write_to_socket_sync(
            get_socket_path(SocketType::Command),
            command!(Empty, "switchxkblayout {device} {cmd}"),
        )?;
        Ok(())
    }
    /// Switch the xkb layout index for a keyboard
    pub async fn call_async<Str: FDisplay>(
        device: Str,
        cmd: SwitchXKBLayoutCmdTypes,
    ) -> crate::Result<()> {
        write_to_socket(
            get_socket_path(SocketType::Command),
            command!(Empty, "switchxkblayout {device} {cmd}"),
        )
        .await?;
        Ok(())
    }
}

/// Creates a error that Hyprland will display
pub mod set_error {
    use super::*;
    /// Creates a error that Hyprland will display
    pub fn call(color: Color, msg: String) -> crate::Result<()> {
        write_to_socket_sync(
            get_socket_path(SocketType::Command),
            command!(Empty, "seterror {color} {msg}"),
        )?;
        Ok(())
    }
    /// Creates a error that Hyprland will display (async)
    pub async fn call_async(color: Color, msg: String) -> crate::Result<()> {
        write_to_socket(
            get_socket_path(SocketType::Command),
            command!(Empty, "seterror {color} {msg}"),
        )
        .await?;
        Ok(())
    }
}

/// Creates a notification with Hyprland
pub mod notify {
    use super::*;
    use std::time::Duration;

    #[allow(missing_docs)]
    #[derive(Copy, Clone)]
    #[repr(i8)]
    pub enum Icon {
        NoIcon = -1,
        Warning = 0,
        Info = 1,
        Hint = 2,
        Error = 3,
        Confused = 4,
        Ok = 5,
    }
    /// Creates a notification with Hyprland
    pub fn call(icon: Icon, time: Duration, color: Color, msg: String) -> crate::Result<()> {
        write_to_socket_sync(
            get_socket_path(SocketType::Command),
            command!(
                Empty,
                "notify {} {} {color} {msg}",
                icon as i8,
                time.as_millis()
            ),
        )?;
        Ok(())
    }
    /// Creates a error that Hyprland will display (async)
    pub async fn call_async(
        icon: Icon,
        time: Duration,
        color: Color,
        msg: String,
    ) -> crate::Result<()> {
        write_to_socket(
            get_socket_path(SocketType::Command),
            command!(
                Empty,
                "notify {} {} {color} {msg}",
                icon as i8,
                time.as_millis()
            ),
        )
        .await?;
        Ok(())
    }
}

/// A 8-bit color with a alpha channel
#[derive(Copy, Clone, MDisplay, Constructor)]
#[display(fmt = "rgba({:02x}{:02x}{:02x}{:02x})", "_0", "_1", "_2", "_3")]
pub struct Color(u8, u8, u8, u8);

/// Provides things to setting props
pub mod set_prop {
    use super::*;

    fn l(b: bool) -> &'static str {
        if b {
            "lock"
        } else {
            ""
        }
    }

    /// Type that represents a prop
    #[derive(EnumProperty, MDisplay)]
    pub enum PropType {
        /// The animation style
        #[display(fmt = "animationstyle {}", "_0")]
        AnimationStyle(String),
        /// The roundness
        #[display(fmt = "rounding {} {}", "_0", "l(*_1)")]
        Rounding(
            i64,
            /// locked
            bool,
        ),
        /// Force no blur
        #[display(fmt = "forcenoblur {} {}", "*_0 as u8", "l(*_1)")]
        ForceNoBlur(
            bool,
            /// locked
            bool,
        ),
        /// Force opaque
        #[display(fmt = "forceopaque {} {}", "*_0 as u8", "l(*_1)")]
        ForceOpaque(
            bool,
            /// locked
            bool,
        ),
        /// Force opaque overriden
        #[display(fmt = "forceopaqueoverriden {} {}", "*_0 as u8", "l(*_1)")]
        ForceOpaqueOverriden(
            bool,
            /// locked
            bool,
        ),
        /// Force allow input
        #[display(fmt = "forceallowsinput {} {}", "*_0 as u8", "l(*_1)")]
        ForceAllowsInput(
            bool,
            /// locked
            bool,
        ),
        /// Force no animations
        #[display(fmt = "forcenoanims {} {}", "*_0 as u8", "l(*_1)")]
        ForceNoAnims(
            bool,
            /// locked
            bool,
        ),
        /// Force no border
        #[display(fmt = "forcenoborder {} {}", "*_0 as u8", "l(*_1)")]
        ForceNoBorder(
            bool,
            /// locked
            bool,
        ),
        /// Force no shadow
        #[display(fmt = "forcenoshadow {} {}", "*_0 as u8", "l(*_1)")]
        ForceNoShadow(
            bool,
            /// locked
            bool,
        ),
        /// Allow for windoe dancing?
        #[display(fmt = "windowdancecompat {} {}", "*_0 as u8", "l(*_1)")]
        WindowDanceCompat(
            bool,
            /// locked
            bool,
        ),
        /// Allow for overstepping max size
        #[display(fmt = "nomaxsize {} {}", "*_0 as u8", "l(*_1)")]
        NoMaxSize(
            bool,
            /// locked
            bool,
        ),
        /// Dim around?
        #[display(fmt = "dimaround {} {}", "*_0 as u8", "l(*_1)")]
        DimAround(
            bool,
            /// locked
            bool,
        ),
        /// Makes the next setting be override instead of multiply
        #[display(fmt = "alphaoverride {} {}", "*_0 as u8", "l(*_1)")]
        AlphaOverride(
            bool,
            /// locked
            bool,
        ),
        /// The alpha
        #[display(fmt = "alpha {} {}", "_0", "l(*_1)")]
        Alpha(
            f32,
            /// locked
            bool,
        ),
        /// Makes the next setting be override instead of multiply
        #[display(fmt = "alphainactiveoverride {} {}", "*_0 as u8", "l(*_1)")]
        AlphaInactiveOverride(
            bool,
            /// locked
            bool,
        ),
        /// The alpha for inactive
        #[display(fmt = "alphainactive {} {}", "_0", "l(*_1)")]
        AlphaInactive(
            f32,
            /// locked
            bool,
        ),
        /// The active border color
        #[display(fmt = "alphabordercolor {} {}", "_0", "l(*_1)")]
        ActiveBorderColor(
            Color,
            /// locked
            bool,
        ),
        /// The inactive border color
        #[display(fmt = "inalphabordercolor {} {}", "_0", "l(*_1)")]
        InactiveBorderColor(
            Color,
            /// locked
            bool,
        ),
    }

    /// Sets a window prob
    pub fn call(ident: String, prop: PropType, lock: bool) -> crate::Result<()> {
        write_to_socket_sync(
            get_socket_path(SocketType::Command),
            command!(
                Empty,
                "setprop {ident} {prop} {}",
                if lock { "lock" } else { "" }
            ),
        )?;
        Ok(())
    }
    /// Sets a window prob (async)
    pub async fn call_async(ident: String, prop: PropType, lock: bool) -> crate::Result<()> {
        write_to_socket(
            get_socket_path(SocketType::Command),
            command!(
                Empty,
                "setprop {ident} {prop} {}",
                if lock { "lock" } else { "" }
            ),
        )
        .await?;
        Ok(())
    }
}

/// Provides functions for communication with plugin system
pub mod plugin {
    use super::*;
    use std::path::Path;

    /// Loads a plugin, by path
    pub fn load(path: &Path) -> crate::Result<()> {
        write_to_socket_sync(
            get_socket_path(SocketType::Command),
            command!(Empty, "plugin load {}", path.display()),
        )?;
        Ok(())
    }
    /// Loads a plugin, by path (async)
    pub async fn load_async(path: &Path) -> crate::Result<()> {
        write_to_socket(
            get_socket_path(SocketType::Command),
            command!(Empty, "plugin load {}", path.display()),
        )
        .await?;
        Ok(())
    }
    /// Returns a list of all plugins
    pub fn list() -> crate::Result<String> {
        write_to_socket_sync(
            get_socket_path(SocketType::Command),
            command!(Empty, "plugin list"),
        )
    }
    /// Returns a list of all plugins (async)
    pub async fn list_async() -> crate::Result<String> {
        write_to_socket(
            get_socket_path(SocketType::Command),
            command!(Empty, "plugin list"),
        )
        .await
    }
}