21c700d14b
`nix-doc-munge` can't handle these, which is understandable as I can barely handle them either. There are a few infelicities here: the current processor can't handle multiple terms to one description in a description list so they get comma-separated in one case, and one case that should ideally render as a `<figure>` with a `<figcaption>` in HTML is reduced to a paragraph with some `<strong>` text. (Which, in fairness, is how it rendered in practice with the DocBook anyway.) The docs generator has since been updated to handle figures, but we can't use it until moving off DocBook output.
305 lines
10 KiB
Nix
305 lines
10 KiB
Nix
{ config, lib, pkgs, ... }:
|
|
|
|
with lib;
|
|
|
|
let
|
|
|
|
cfg = config.programs.qutebrowser;
|
|
|
|
formatLine = o: n: v:
|
|
let
|
|
formatValue = v:
|
|
if builtins.isNull v then
|
|
"None"
|
|
else if builtins.isBool v then
|
|
(if v then "True" else "False")
|
|
else if builtins.isString v then
|
|
''"${v}"''
|
|
else if builtins.isList v then
|
|
"[${concatStringsSep ", " (map formatValue v)}]"
|
|
else
|
|
builtins.toString v;
|
|
in if builtins.isAttrs v then
|
|
concatStringsSep "\n" (mapAttrsToList (formatLine "${o}${n}.") v)
|
|
else
|
|
"${o}${n} = ${formatValue v}";
|
|
|
|
formatDictLine = o: n: v: ''${o}['${n}'] = "${v}"'';
|
|
|
|
formatKeyBindings = m: b:
|
|
let
|
|
formatKeyBinding = m: k: c:
|
|
''config.bind("${k}", "${escape [ ''"'' ] c}", mode="${m}")'';
|
|
in concatStringsSep "\n" (mapAttrsToList (formatKeyBinding m) b);
|
|
|
|
formatQuickmarks = n: s: "${n} ${s}";
|
|
|
|
in {
|
|
options.programs.qutebrowser = {
|
|
enable = mkEnableOption "qutebrowser";
|
|
|
|
package = mkOption {
|
|
type = types.package;
|
|
default = pkgs.qutebrowser;
|
|
defaultText = literalExpression "pkgs.qutebrowser";
|
|
description = "Qutebrowser package to install.";
|
|
};
|
|
|
|
aliases = mkOption {
|
|
type = types.attrsOf types.str;
|
|
default = { };
|
|
description = ''
|
|
Aliases for commands.
|
|
'';
|
|
};
|
|
|
|
loadAutoconfig = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description = ''
|
|
Load settings configured via the GUI.
|
|
'';
|
|
};
|
|
|
|
searchEngines = mkOption {
|
|
type = types.attrsOf types.str;
|
|
default = { };
|
|
description = ''
|
|
Search engines that can be used via the address bar. Maps a search
|
|
engine name (such as <literal>DEFAULT</literal>, or
|
|
<literal>ddg</literal>) to a URL with a <literal>{}</literal>
|
|
placeholder. The placeholder will be replaced by the search term, use
|
|
<literal>{{</literal> and <literal>}}</literal> for literal
|
|
<literal>{/}</literal> signs. The search engine named
|
|
<literal>DEFAULT</literal> is used when
|
|
<literal>url.auto_search</literal> is turned on and something else than
|
|
a URL was entered to be opened. Other search engines can be used by
|
|
prepending the search engine name to the search term, for example
|
|
<literal>:open google qutebrowser</literal>.
|
|
'';
|
|
example = literalExpression ''
|
|
{
|
|
w = "https://en.wikipedia.org/wiki/Special:Search?search={}&go=Go&ns0=1";
|
|
aw = "https://wiki.archlinux.org/?search={}";
|
|
nw = "https://nixos.wiki/index.php?search={}";
|
|
g = "https://www.google.com/search?hl=en&q={}";
|
|
}
|
|
'';
|
|
};
|
|
|
|
settings = mkOption {
|
|
type = types.attrsOf types.anything;
|
|
default = { };
|
|
description = ''
|
|
Options to add to qutebrowser <filename>config.py</filename> file.
|
|
See <link xlink:href="https://qutebrowser.org/doc/help/settings.html"/>
|
|
for options.
|
|
'';
|
|
example = literalExpression ''
|
|
{
|
|
colors = {
|
|
hints = {
|
|
bg = "#000000";
|
|
fg = "#ffffff";
|
|
};
|
|
tabs.bar.bg = "#000000";
|
|
};
|
|
tabs.tabs_are_windows = true;
|
|
}
|
|
'';
|
|
};
|
|
|
|
keyMappings = mkOption {
|
|
type = types.attrsOf types.str;
|
|
default = { };
|
|
description = ''
|
|
This setting can be used to map keys to other keys. When the key used
|
|
as dictionary-key is pressed, the binding for the key used as
|
|
dictionary-value is invoked instead. This is useful for global
|
|
remappings of keys, for example to map Ctrl-[ to Escape. Note that when
|
|
a key is bound (via <literal>bindings.default</literal> or
|
|
<literal>bindings.commands</literal>), the mapping is ignored.
|
|
'';
|
|
};
|
|
|
|
enableDefaultBindings = mkOption {
|
|
type = types.bool;
|
|
default = true;
|
|
description = ''
|
|
Disable to prevent loading default key bindings.
|
|
'';
|
|
};
|
|
|
|
keyBindings = mkOption {
|
|
type = with types; attrsOf (attrsOf (separatedString " ;; "));
|
|
default = { };
|
|
description = lib.mdDoc ''
|
|
Key bindings mapping keys to commands in different modes. This setting
|
|
is a dictionary containing mode names and dictionaries mapping keys to
|
|
commands: `{mode: {key: command}}` If you want to map
|
|
a key to another key, check the `keyMappings` setting
|
|
instead. For modifiers, you can use either `-` or
|
|
`+` as delimiters, and these names:
|
|
|
|
Control
|
|
: `Control`, `Ctrl`
|
|
|
|
Meta
|
|
: `Meta`, `Windows`, `Mod4`
|
|
|
|
Alt
|
|
: `Alt`, `Mod1`
|
|
|
|
Shift
|
|
: `Shift`
|
|
|
|
For simple keys (no `<>`-signs), a capital
|
|
letter means the key is pressed with Shift. For special keys (with
|
|
`<>`-signs), you need to explicitly add
|
|
`Shift-` to match a key pressed with shift. If you
|
|
want a binding to do nothing, bind it to the `nop`
|
|
command. If you want a default binding to be passed through to the
|
|
website, bind it to null. Note that some commands which are only useful
|
|
for bindings (but not used interactively) are hidden from the command
|
|
completion. See `:help` for a full list of available
|
|
commands. The following modes are available:
|
|
|
|
`normal`
|
|
: Default mode, where most commands are invoked.
|
|
|
|
`insert`
|
|
: Entered when an input field is focused on a website, or by
|
|
pressing `i` in normal mode. Passes through almost all keypresses
|
|
to the website, but has some bindings like
|
|
`<Ctrl-e>` to open an external editor.
|
|
Note that single keys can't be bound in this mode.
|
|
|
|
`hint`
|
|
: Entered when `f` is pressed to select links with the keyboard. Note
|
|
that single keys can't be bound in this mode.
|
|
|
|
`passthrough`
|
|
: Similar to insert mode, but passes through all keypresses except
|
|
`<Escape>` to leave the mode. It might be
|
|
useful to bind `<Escape>` to some other
|
|
key in this mode if you want to be able to send an Escape key to
|
|
the website as well. Note that single keys can't be bound in this
|
|
mode.
|
|
|
|
`command`
|
|
: Entered when pressing the `:` key in order to enter a command. Note
|
|
that single keys can't be bound in this mode.
|
|
|
|
`prompt`
|
|
: Entered when there's a prompt to display, like for download
|
|
locations or when invoked from JavaScript.
|
|
|
|
`yesno`
|
|
: Entered when there's a yes/no prompt displayed.
|
|
|
|
`caret`
|
|
: Entered when pressing the `v` mode, used to select text using the
|
|
keyboard.
|
|
|
|
`register`
|
|
: Entered when qutebrowser is waiting for a register name/key for
|
|
commands like `:set-mark`.
|
|
'';
|
|
example = literalExpression ''
|
|
{
|
|
normal = {
|
|
"<Ctrl-v>" = "spawn mpv {url}";
|
|
",p" = "spawn --userscript qute-pass";
|
|
",l" = '''config-cycle spellcheck.languages ["en-GB"] ["en-US"]''';
|
|
"<F1>" = mkMerge [
|
|
"config-cycle tabs.show never always"
|
|
"config-cycle statusbar.show in-mode always"
|
|
"config-cycle scrolling.bar never always"
|
|
];
|
|
};
|
|
prompt = {
|
|
"<Ctrl-y>" = "prompt-yes";
|
|
};
|
|
}
|
|
'';
|
|
};
|
|
|
|
quickmarks = mkOption {
|
|
type = types.attrsOf types.str;
|
|
default = { };
|
|
description = ''
|
|
Quickmarks to add to qutebrowser's <filename>quickmarks</filename> file.
|
|
Note that when Home Manager manages your quickmarks, you cannot edit them at runtime.
|
|
'';
|
|
example = literalExpression ''
|
|
{
|
|
nixpkgs = "https://github.com/NixOS/nixpkgs";
|
|
home-manager = "https://github.com/nix-community/home-manager";
|
|
}
|
|
'';
|
|
};
|
|
|
|
extraConfig = mkOption {
|
|
type = types.lines;
|
|
default = "";
|
|
description = ''
|
|
Extra lines added to qutebrowser <filename>config.py</filename> file.
|
|
'';
|
|
};
|
|
};
|
|
|
|
config = let
|
|
qutebrowserConfig = concatStringsSep "\n" ([
|
|
(if cfg.loadAutoconfig then
|
|
"config.load_autoconfig()"
|
|
else
|
|
"config.load_autoconfig(False)")
|
|
] ++ mapAttrsToList (formatLine "c.") cfg.settings
|
|
++ mapAttrsToList (formatDictLine "c.aliases") cfg.aliases
|
|
++ mapAttrsToList (formatDictLine "c.url.searchengines") cfg.searchEngines
|
|
++ mapAttrsToList (formatDictLine "c.bindings.key_mappings")
|
|
cfg.keyMappings
|
|
++ optional (!cfg.enableDefaultBindings) "c.bindings.default = {}"
|
|
++ mapAttrsToList formatKeyBindings cfg.keyBindings
|
|
++ optional (cfg.extraConfig != "") cfg.extraConfig);
|
|
|
|
quickmarksFile = optionals (cfg.quickmarks != { }) concatStringsSep "\n"
|
|
((mapAttrsToList formatQuickmarks cfg.quickmarks));
|
|
in mkIf cfg.enable {
|
|
home.packages = [ cfg.package ];
|
|
|
|
home.file.".qutebrowser/config.py" =
|
|
mkIf pkgs.stdenv.hostPlatform.isDarwin { text = qutebrowserConfig; };
|
|
|
|
home.file.".qutebrowser/quickmarks" =
|
|
mkIf (cfg.quickmarks != { } && pkgs.stdenv.hostPlatform.isDarwin) {
|
|
text = quickmarksFile;
|
|
};
|
|
|
|
xdg.configFile."qutebrowser/config.py" =
|
|
mkIf pkgs.stdenv.hostPlatform.isLinux {
|
|
text = qutebrowserConfig;
|
|
onChange = ''
|
|
hash="$(echo -n "$USER" | md5sum | cut -d' ' -f1)"
|
|
socket="''${XDG_RUNTIME_DIR:-/run/user/$UID}/qutebrowser/ipc-$hash"
|
|
if [[ -S $socket ]]; then
|
|
command=${
|
|
escapeShellArg (builtins.toJSON {
|
|
args = [ ":config-source" ];
|
|
target_arg = null;
|
|
protocol_version = 1;
|
|
})
|
|
}
|
|
echo "$command" | ${pkgs.socat}/bin/socat -lf /dev/null - UNIX-CONNECT:"$socket"
|
|
fi
|
|
unset hash socket command
|
|
'';
|
|
};
|
|
|
|
xdg.configFile."qutebrowser/quickmarks" =
|
|
mkIf (cfg.quickmarks != { } && pkgs.stdenv.hostPlatform.isLinux) {
|
|
text = quickmarksFile;
|
|
};
|
|
};
|
|
}
|