command/keyboard-layout: use flags.zig, cleanup

doc/riverctl.1.scd

@@ -334,10 +334,11 @@ A complete list may be found in _/usr/include/linux/input-event-codes.h_
 *list-input-configs*
 	List all input configurations.
 
-*keyboard-layout* _layout_ [-variant _variant_] [-model _model_] [-options _options_] [-rules _rules_]
+*keyboard-layout* [-rules _rules_] [-model _model_] [-variant _variant_] \
-	Set the XKB layout for all keyboards. All values other than the layout
+[-options _options_] _layout_
-	name are optional. XKB will fill in unspecified values based on
+	Set the XKB layout for all keyboards. Defaults from libxkbcommon are used
-	heuristics and the environment. Duplicate flags are not allowed.
+	for everything left unspecified. See *xkeyboard-config*(7) for
+	possible values and more information.
 
 *keyboard-group-create* _group_name_
 	Create a keyboard group. A keyboard group collects multiple keyboards in

river/Config.zig

@@ -135,11 +135,7 @@ pub fn deinit(self: *Self) void {
     self.modes.deinit(util.gpa);
 
     if (self.keyboard_layout) |kl| {
-        if (kl.rules) |s| util.gpa.free(mem.span(s));
+        util.free_xkb_rule_names(kl);
-        if (kl.model) |s| util.gpa.free(mem.span(s));
-        if (kl.layout) |s| util.gpa.free(mem.span(s));
-        if (kl.variant) |s| util.gpa.free(mem.span(s));
-        if (kl.options) |s| util.gpa.free(mem.span(s));
     }
 
     {

river/command/keyboard.zig

@@ -18,6 +18,7 @@ const std = @import("std");
 const mem = std.mem;
 
 const xkb = @import("xkbcommon");
+const flags = @import("flags");
 
 const server = &@import("../main.zig").server;
 const util = @import("../util.zig");
@@ -30,55 +31,38 @@ pub fn keyboardLayout(
     args: []const [:0]const u8,
     _: *?[]const u8,
 ) Error!void {
-    if (args.len < 2) return Error.NotEnoughArguments;
+    const result = flags.parser([:0]const u8, &.{
-    if (args.len % 2 != 0) return Error.InvalidValue;
+        .{ .name = "-rules", .kind = .arg },
-
+        .{ .name = "-model", .kind = .arg },
-    // Do not carry over any previous keyboard layout configuration, always
+        .{ .name = "-variant", .kind = .arg },
-    // start fresh.
+        .{ .name = "-options", .kind = .arg },
-    if (server.config.keyboard_layout) |kl| {
+    }).parse(args[1..]) catch {
-        if (kl.rules) |s| util.gpa.free(mem.span(s));
+        return error.InvalidValue;
-        if (kl.model) |s| util.gpa.free(mem.span(s));
-        if (kl.layout) |s| util.gpa.free(mem.span(s));
-        if (kl.variant) |s| util.gpa.free(mem.span(s));
-        if (kl.options) |s| util.gpa.free(mem.span(s));
-    }
-
-    server.config.keyboard_layout = xkb.RuleNames{
-        .layout = try util.gpa.dupeZ(u8, args[1]),
-        .rules = null,
-        .model = null,
-        .variant = null,
-        .options = null,
     };
+    if (result.args.len < 1) return Error.NotEnoughArguments;
+    if (result.args.len > 1) return Error.TooManyArguments;
 
-    // TODO[zig]: this can be solved more elegantly with an inline for loop, but
+    const new_layout = xkb.RuleNames{
-    //            on version 0.9.1 that crashes the compiler.
+        .layout = try util.gpa.dupeZ(u8, result.args[0]),
-    var i: usize = 2;
+        .rules = if (result.flags.@"-rules") |s| try util.gpa.dupeZ(u8, s) else null,
-    while (i < args.len - 1) : (i += 2) {
+        .model = if (result.flags.@"-model") |s| try util.gpa.dupeZ(u8, s) else null,
-        if (mem.eql(u8, args[i], "-variant")) {
+        .variant = if (result.flags.@"-variant") |s| try util.gpa.dupeZ(u8, s) else null,
-            // Do not allow duplicate flags.
+        .options = if (result.flags.@"-options") |s| try util.gpa.dupeZ(u8, s) else null,
-            if (server.config.keyboard_layout.?.variant != null) return error.InvalidValue;
+    };
-            server.config.keyboard_layout.?.variant = try util.gpa.dupeZ(u8, args[i + 1]);
+    errdefer util.free_xkb_rule_names(new_layout);
-        } else if (mem.eql(u8, args[i], "-model")) {
-            if (server.config.keyboard_layout.?.model != null) return error.InvalidValue;
-            server.config.keyboard_layout.?.model = try util.gpa.dupeZ(u8, args[i + 1]);
-        } else if (mem.eql(u8, args[i], "-options")) {
-            if (server.config.keyboard_layout.?.options != null) return error.InvalidValue;
-            server.config.keyboard_layout.?.options = try util.gpa.dupeZ(u8, args[i + 1]);
-        } else if (mem.eql(u8, args[i], "-rules")) {
-            if (server.config.keyboard_layout.?.rules != null) return error.InvalidValue;
-            server.config.keyboard_layout.?.rules = try util.gpa.dupeZ(u8, args[i + 1]);
-        } else {
-            return error.InvalidValue;
-        }
-    }
 
     const context = xkb.Context.new(.no_flags) orelse return error.OutOfMemory;
     defer context.unref();
 
-    const keymap = xkb.Keymap.newFromNames(context, &server.config.keyboard_layout.?, .no_flags) orelse return error.InvalidValue;
+    const keymap = xkb.Keymap.newFromNames(context, &new_layout, .no_flags) orelse return error.InvalidValue;
     defer keymap.unref();
 
+    // Wait until after successfully creating the keymap to save the new layout options.
+    // Otherwise we may store invalid layout options which could cause keyboards to become
+    // unusable.
+    if (server.config.keyboard_layout) |old_layout| util.free_xkb_rule_names(old_layout);
+    server.config.keyboard_layout = new_layout;
+
     var it = server.input_manager.devices.iterator(.forward);
     while (it.next()) |device| {
         if (device.wlr_device.type != .keyboard) continue;

river/util.zig

@@ -17,6 +17,8 @@
 const std = @import("std");
 const os = std.os;
 
+const xkb = @import("xkbcommon");
+
 const c = @import("c.zig");
 
 /// The global general-purpose allocator used throughout river's code
@@ -33,3 +35,9 @@ pub fn post_fork_pre_execve() void {
     };
     os.sigaction(os.SIG.PIPE, &sig_dfl, null);
 }
+
+pub fn free_xkb_rule_names(rule_names: xkb.RuleNames) void {
+    inline for (std.meta.fields(xkb.RuleNames)) |field| {
+        if (@field(rule_names, field.name)) |s| gpa.free(std.mem.span(s));
+    }
+}