6f7074d21d
* rofi: migrate to rasi configuration format The Xresources configuration format is deprecated in Rofi. For example, using Rofi from unstable (1.6.1 as of now) you get the following warnings when starting the application: ``` (process:9272): Rofi-WARNING **: 01:38:48.596: The old Xresources based configuration format is deprecated. (process:9272): Rofi-WARNING **: 01:38:48.596: Please upgrade: rofi -upgrade-config. `````` So this commit migrates it for its new configuration format, called rasi instead. This new implementation uses attrsets manipulation instead of using strings, making the code clearer and also fixing some bugs found during the way. To make sure everything is right, I also created some tests. If someone wants to validate if the generated config is correct, just run in terminal: ``` $ rofi -dump-config ``` And rofi will dump the current configuration file, including all unsetted options. * docs: document programs.rofi.extraConfig changes * rofi: add thiagokokada as maintainer * rofi: add toRasi function
363 lines
9.3 KiB
Nix
363 lines
9.3 KiB
Nix
{ config, lib, pkgs, ... }:
|
|
|
|
with lib;
|
|
with builtins;
|
|
|
|
let
|
|
|
|
cfg = config.programs.rofi;
|
|
|
|
colorOption = description:
|
|
mkOption {
|
|
type = types.str;
|
|
description = description;
|
|
};
|
|
|
|
rowColorSubmodule = types.submodule {
|
|
options = {
|
|
background = colorOption "Background color";
|
|
foreground = colorOption "Foreground color";
|
|
backgroundAlt = colorOption "Alternative background color";
|
|
highlight = mkOption {
|
|
type = types.submodule {
|
|
options = {
|
|
background = colorOption "Highlight background color";
|
|
foreground = colorOption "Highlight foreground color";
|
|
};
|
|
};
|
|
description = "Color settings for highlighted row.";
|
|
};
|
|
};
|
|
};
|
|
|
|
windowColorSubmodule = types.submodule {
|
|
options = {
|
|
background = colorOption "Window background color";
|
|
border = colorOption "Window border color";
|
|
separator = colorOption "Separator color";
|
|
};
|
|
};
|
|
|
|
colorsSubmodule = types.submodule {
|
|
options = {
|
|
window = mkOption {
|
|
default = null;
|
|
type = windowColorSubmodule;
|
|
description = "Window color settings.";
|
|
};
|
|
rows = mkOption {
|
|
default = null;
|
|
type = types.submodule {
|
|
options = {
|
|
normal = mkOption {
|
|
default = null;
|
|
type = types.nullOr rowColorSubmodule;
|
|
description = "Normal row color settings.";
|
|
};
|
|
active = mkOption {
|
|
default = null;
|
|
type = types.nullOr rowColorSubmodule;
|
|
description = "Active row color settings.";
|
|
};
|
|
urgent = mkOption {
|
|
default = null;
|
|
type = types.nullOr rowColorSubmodule;
|
|
description = "Urgent row color settings.";
|
|
};
|
|
};
|
|
};
|
|
description = "Rows color settings.";
|
|
};
|
|
};
|
|
};
|
|
|
|
windowColorsToString = window:
|
|
concatStringsSep ", " (with window; [ background border separator ]);
|
|
|
|
rowColorsToString = row:
|
|
concatStringsSep ", " (with row; [
|
|
background
|
|
foreground
|
|
backgroundAlt
|
|
highlight.background
|
|
highlight.foreground
|
|
]);
|
|
|
|
mkColorScheme = colors:
|
|
if colors != null then
|
|
with colors; {
|
|
color-window =
|
|
if (window != null) then (windowColorsToString window) else null;
|
|
color-normal = if (rows != null && rows.normal != null) then
|
|
(rowColorsToString rows.normal)
|
|
else
|
|
null;
|
|
color-active = if (rows != null && rows.active != null) then
|
|
(rowColorsToString rows.active)
|
|
else
|
|
null;
|
|
color-urgent = if (rows != null && rows.active != null) then
|
|
(rowColorsToString rows.urgent)
|
|
else
|
|
null;
|
|
}
|
|
else
|
|
{ };
|
|
|
|
mkValueString = value:
|
|
if isBool value then
|
|
if value then "true" else "false"
|
|
else if isInt value then
|
|
toString value
|
|
else
|
|
''"${toString value}"'';
|
|
|
|
mkKeyValue = name: value: "${name}: ${mkValueString value};";
|
|
|
|
toRasi = section: config:
|
|
let
|
|
# Remove null values so the resulting config does not have empty lines
|
|
configStr = generators.toKeyValue { inherit mkKeyValue; }
|
|
(attrsets.filterAttrs (m: v: v != null) config);
|
|
in ''
|
|
${section} {
|
|
${configStr}}
|
|
'';
|
|
|
|
locationsMap = {
|
|
center = 0;
|
|
top-left = 1;
|
|
top = 2;
|
|
top-right = 3;
|
|
right = 4;
|
|
bottom-right = 5;
|
|
bottom = 6;
|
|
bottom-left = 7;
|
|
left = 8;
|
|
};
|
|
|
|
themeName = if (cfg.theme == null) then
|
|
null
|
|
else if (isString cfg.theme) then
|
|
cfg.theme
|
|
else
|
|
removeSuffix ".rasi" (baseNameOf cfg.theme);
|
|
|
|
themePath = if (isString cfg.theme) then null else cfg.theme;
|
|
|
|
in {
|
|
options.programs.rofi = {
|
|
enable = mkEnableOption
|
|
"Rofi: A window switcher, application launcher and dmenu replacement";
|
|
|
|
package = mkOption {
|
|
default = pkgs.rofi;
|
|
type = types.package;
|
|
description = ''
|
|
Package providing the <command>rofi</command> binary.
|
|
'';
|
|
example = literalExample ''
|
|
pkgs.rofi.override { plugins = [ pkgs.rofi-emoji ]; };
|
|
'';
|
|
};
|
|
|
|
width = mkOption {
|
|
default = null;
|
|
type = types.nullOr types.int;
|
|
description = "Window width";
|
|
example = 100;
|
|
};
|
|
|
|
lines = mkOption {
|
|
default = null;
|
|
type = types.nullOr types.int;
|
|
description = "Number of lines";
|
|
example = 10;
|
|
};
|
|
|
|
borderWidth = mkOption {
|
|
default = null;
|
|
type = types.nullOr types.int;
|
|
description = "Border width";
|
|
example = 1;
|
|
};
|
|
|
|
rowHeight = mkOption {
|
|
default = null;
|
|
type = types.nullOr types.int;
|
|
description = "Row height (in chars)";
|
|
example = 1;
|
|
};
|
|
|
|
padding = mkOption {
|
|
default = null;
|
|
type = types.nullOr types.int;
|
|
description = "Padding";
|
|
example = 400;
|
|
};
|
|
|
|
font = mkOption {
|
|
default = null;
|
|
type = types.nullOr types.str;
|
|
example = "Droid Sans Mono 14";
|
|
description = "Font to use.";
|
|
};
|
|
|
|
scrollbar = mkOption {
|
|
default = null;
|
|
type = types.nullOr types.bool;
|
|
description = "Whether to show a scrollbar.";
|
|
};
|
|
|
|
terminal = mkOption {
|
|
default = null;
|
|
type = types.nullOr types.str;
|
|
description = ''
|
|
Path to the terminal which will be used to run console applications
|
|
'';
|
|
example = "\${pkgs.gnome3.gnome_terminal}/bin/gnome-terminal";
|
|
};
|
|
|
|
separator = mkOption {
|
|
default = null;
|
|
type = types.nullOr (types.enum [ "none" "dash" "solid" ]);
|
|
description = "Separator style";
|
|
example = "solid";
|
|
};
|
|
|
|
cycle = mkOption {
|
|
default = null;
|
|
type = types.nullOr types.bool;
|
|
description = "Whether to cycle through the results list.";
|
|
};
|
|
|
|
fullscreen = mkOption {
|
|
default = null;
|
|
type = types.nullOr types.bool;
|
|
description = "Whether to run rofi fullscreen.";
|
|
};
|
|
|
|
location = mkOption {
|
|
default = "center";
|
|
type = types.enum (attrNames locationsMap);
|
|
description = "The location rofi appears on the screen.";
|
|
};
|
|
|
|
xoffset = mkOption {
|
|
default = 0;
|
|
type = types.int;
|
|
description = ''
|
|
Offset in the x-axis in pixels relative to the chosen location.
|
|
'';
|
|
};
|
|
|
|
yoffset = mkOption {
|
|
default = 0;
|
|
type = types.int;
|
|
description = ''
|
|
Offset in the y-axis in pixels relative to the chosen location.
|
|
'';
|
|
};
|
|
|
|
colors = mkOption {
|
|
default = null;
|
|
type = types.nullOr colorsSubmodule;
|
|
description = ''
|
|
Color scheme settings. Colors can be specified in CSS color
|
|
formats. This option may become deprecated in the future and
|
|
therefore the <varname>programs.rofi.theme</varname> option
|
|
should be used whenever possible.
|
|
'';
|
|
example = literalExample ''
|
|
colors = {
|
|
window = {
|
|
background = "argb:583a4c54";
|
|
border = "argb:582a373e";
|
|
separator = "#c3c6c8";
|
|
};
|
|
|
|
rows = {
|
|
normal = {
|
|
background = "argb:58455a64";
|
|
foreground = "#fafbfc";
|
|
backgroundAlt = "argb:58455a64";
|
|
highlight = {
|
|
background = "#00bcd4";
|
|
foreground = "#fafbfc";
|
|
};
|
|
};
|
|
};
|
|
};
|
|
'';
|
|
};
|
|
|
|
theme = mkOption {
|
|
default = null;
|
|
type = with types; nullOr (either str path);
|
|
example = "Arc";
|
|
description = ''
|
|
Name of theme or path to theme file in rasi format. Available
|
|
named themes can be viewed using the
|
|
<command>rofi-theme-selector</command> tool.
|
|
'';
|
|
};
|
|
|
|
configPath = mkOption {
|
|
default = "${config.xdg.configHome}/rofi/config.rasi";
|
|
defaultText = "$XDG_CONFIG_HOME/rofi/config.rasi";
|
|
type = types.str;
|
|
description = "Path where to put generated configuration file.";
|
|
};
|
|
|
|
extraConfig = mkOption {
|
|
default = { };
|
|
example = literalExample ''
|
|
{
|
|
modi = "drun,emoji,ssh";
|
|
kb-primary-paste = "Control+V,Shift+Insert";
|
|
kb-secondary-paste = "Control+v,Insert";
|
|
}
|
|
'';
|
|
type = with types; attrsOf (oneOf [ int str bool ]);
|
|
description = "Additional configuration to add.";
|
|
};
|
|
|
|
};
|
|
|
|
config = mkIf cfg.enable {
|
|
assertions = [{
|
|
assertion = cfg.theme == null || cfg.colors == null;
|
|
message = ''
|
|
Cannot use the rofi options 'theme' and 'colors' simultaneously.
|
|
'';
|
|
}];
|
|
|
|
home.packages = [ cfg.package ];
|
|
|
|
home.file."${cfg.configPath}".text = toRasi "configuration" ({
|
|
width = cfg.width;
|
|
lines = cfg.lines;
|
|
font = cfg.font;
|
|
bw = cfg.borderWidth;
|
|
eh = cfg.rowHeight;
|
|
padding = cfg.padding;
|
|
separator-style = cfg.separator;
|
|
hide-scrollbar =
|
|
if (cfg.scrollbar != null) then (!cfg.scrollbar) else null;
|
|
terminal = cfg.terminal;
|
|
cycle = cfg.cycle;
|
|
fullscreen = cfg.fullscreen;
|
|
location = (getAttr cfg.location locationsMap);
|
|
xoffset = cfg.xoffset;
|
|
yoffset = cfg.yoffset;
|
|
theme = themeName;
|
|
} // (mkColorScheme cfg.colors) // cfg.extraConfig);
|
|
|
|
xdg.dataFile = mkIf (themePath != null) {
|
|
"rofi/themes/${themeName}.rasi".source = themePath;
|
|
};
|
|
};
|
|
|
|
meta.maintainers = with maintainers; [ thiagokokada ];
|
|
}
|