1
0
Fork 0
mirror of https://github.com/nix-community/home-manager synced 2024-11-27 05:29:46 +01:00
home-manager/modules/services/xcape.nix
Robert Helgesson 5f433eb164
Move platform check into modules
Before, loading a module would be guarded by an optional platform
condition. This made it possible to avoid loading and evaluating a
module if it did not support the host platform.

Unfortunately, this made it impossible to share a single configuration
between GNU/Linux and Darwin hosts, which some wish to do.

This removes the conditional load and instead inserts host platform
assertions in the modules that are platform specific.

Fixes #1906
2021-07-18 20:43:22 +02:00

81 lines
2.3 KiB
Nix

{ config, lib, pkgs, ... }:
with lib;
let
cfg = config.services.xcape;
in {
meta.maintainers = [ maintainers.nickhu ];
options = {
services.xcape = {
enable = mkEnableOption "xcape";
timeout = mkOption {
type = types.nullOr types.int;
default = null;
example = 500;
description = ''
If you hold a key longer than this timeout, xcape will not
generate a key event. Default is 500 ms.
'';
};
mapExpression = mkOption {
type = types.attrsOf types.str;
default = { };
example = {
Shift_L = "Escape";
Control_L = "Control_L|O";
};
description = ''
The value has the grammar <literal>Key[|OtherKey]</literal>.
</para>
<para>
The list of key names is found in the header file
<filename>X11/keysymdef.h</filename> (remove the
<literal>XK_</literal> prefix). Note that due to limitations
of X11 shifted keys must be specified as a shift key
followed by the key to be pressed rather than the actual
name of the character. For example to generate "{" the
expression <literal>Shift_L|bracketleft</literal> could be
used (assuming that you have a key with "{" above "[").
</para>
<para>
You can also specify keys in decimal (prefix #), octal (#0),
or hexadecimal (#0x). They will be interpreted as keycodes
unless no corresponding key name is found.
'';
};
};
};
config = mkIf cfg.enable {
assertions = [
(lib.hm.assertions.assertPlatform "services.xcape" pkgs
lib.platforms.linux)
];
systemd.user.services.xcape = {
Unit = {
Description = "xcape";
After = [ "graphical-session-pre.target" ];
PartOf = [ "graphical-session.target" ];
};
Service = {
Type = "forking";
ExecStart = "${pkgs.xcape}/bin/xcape"
+ optionalString (cfg.timeout != null) " -t ${toString cfg.timeout}"
+ optionalString (cfg.mapExpression != { }) " -e '${
builtins.concatStringsSep ";"
(attrsets.mapAttrsToList (n: v: "${n}=${v}") cfg.mapExpression)
}'";
};
Install = { WantedBy = [ "graphical-session.target" ]; };
};
};
}