Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

kde: enable custom decorations and polish code #772

Merged
merged 7 commits into from
Jan 30, 2025
Merged

kde: enable custom decorations and polish code #772

Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9c67936
kde(style): reformat with `nixfmt-rfc-style`
rkuklik Jan 11, 2025
91aa455
kde(refactor): remove top-level `with` and improve imports
rkuklik Jan 11, 2025
0f9fb38
kde(options): add custom window decorations option
rkuklik Jan 11, 2025
085308f
kde(color): centralize color format
rkuklik Jan 11, 2025
1d43263
kde(style): fix formatting width
rkuklik Jan 18, 2025
3c22cd8
kde(fix): conform with stylix conventions
rkuklik Jan 25, 2025
e31cdc9
kde(docs): improve warning with custom decorations
rkuklik Jan 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
202 changes: 125 additions & 77 deletions modules/kde/hm.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,48 +4,67 @@
lib,
...
}:

with config.stylix.fonts;
with config.lib.stylix.colors;

let
cfg = config.stylix.targets.kde;

inherit (config.lib.stylix)
colors
mkEnableTarget
;
inherit (lib)
concatStrings
concatStringsSep
filter
flatten
getExe
isAttrs
isBool
isString
hm
last
listToAttrs
mapAttrsToList
mkIf
mkOption
optional
partition
range
toHexString
types
;
rkuklik marked this conversation as resolved.
Show resolved Hide resolved

formatValue =
value:
if builtins.isBool value then
if value then "true" else "false"
else
builtins.toString value;
if isBool value then if value then "true" else "false" else toString value;

formatSection =
path: data:
let
header = lib.concatStrings (map (p: "[${p}]") path);
header = concatStrings (map (p: "[${p}]") path);
formatChild = name: formatLines (path ++ [ name ]);
children = lib.mapAttrsToList formatChild data;
partitioned = lib.partition builtins.isString children;
children = mapAttrsToList formatChild data;
partitioned = partition isString children;
directChildren = partitioned.right;
indirectChildren = partitioned.wrong;
in
lib.optional (directChildren != [ ]) header
optional (directChildren != [ ]) header
++ directChildren
++ lib.flatten indirectChildren;
++ flatten indirectChildren;

formatLines =
path: data:
if builtins.isAttrs data then
if isAttrs data then
if data ? _immutable then
if builtins.isAttrs data.value then
if isAttrs data.value then
formatSection (path ++ [ "$i" ]) data.value
else
"${lib.last path}[$i]=${formatValue data.value}"
"${last path}[$i]=${formatValue data.value}"
else
formatSection path data
else
"${lib.last path}=${formatValue data}";
"${last path}=${formatValue data}";

formatConfig = data: lib.concatStringsSep "\n" (formatLines [ ] data);
formatConfig = data: concatStringsSep "\n" (formatLines [ ] data);

# Marking a setting as immutable should prevent it being overwritten
# through the system settings menu.
Expand All @@ -57,8 +76,8 @@ let
# PascalCase is the standard naming for color scheme files. Schemes named
# in kebab-case will load when selected manually, but don't work with a
# look and feel package.
colorschemeSlug = lib.concatStrings (
builtins.filter builtins.isString (builtins.split "[^a-zA-Z]" scheme)
colorschemeSlug = concatStrings (
filter isString (builtins.split "[^a-zA-Z]" colors.scheme)
);

colorEffect = {
Expand All @@ -70,52 +89,76 @@ let
IntensityAmount = 0;
};

colors = {
BackgroundNormal = "${base00-rgb-r},${base00-rgb-g},${base00-rgb-b}";
BackgroundAlternate = "${base01-rgb-r},${base01-rgb-g},${base01-rgb-b}";
DecorationFocus = "${base0D-rgb-r},${base0D-rgb-g},${base0D-rgb-b}";
DecorationHover = "${base0D-rgb-r},${base0D-rgb-g},${base0D-rgb-b}";
ForegroundNormal = "${base05-rgb-r},${base05-rgb-g},${base05-rgb-b}";
ForegroundActive = "${base05-rgb-r},${base05-rgb-g},${base05-rgb-b}";
ForegroundInactive = "${base05-rgb-r},${base05-rgb-g},${base05-rgb-b}";
ForegroundLink = "${base05-rgb-r},${base05-rgb-g},${base05-rgb-b}";
ForegroundVisited = "${base05-rgb-r},${base05-rgb-g},${base05-rgb-b}";
ForegroundNegative = "${base08-rgb-r},${base08-rgb-g},${base08-rgb-b}";
ForegroundNeutral = "${base0D-rgb-r},${base0D-rgb-g},${base0D-rgb-b}";
ForegroundPositive = "${base0B-rgb-r},${base0B-rgb-g},${base0B-rgb-b}";
mkColorTriple =
name:
concatStringsSep "," (
map (color: colors."${name}-rgb-${color}") [
"r"
"g"
"b"
]
);

mkColorMapping =
num:
let
hex = "base0${toHexString num}";
in
{
name = hex;
value = mkColorTriple hex;
};

colors' = listToAttrs (map mkColorMapping (range 0 15));

kdecolors = with colors'; {
BackgroundNormal = base00;
BackgroundAlternate = base01;
DecorationFocus = base0D;
DecorationHover = base0D;
ForegroundNormal = base05;
ForegroundActive = base05;
ForegroundInactive = base05;
ForegroundLink = base05;
ForegroundVisited = base05;
ForegroundNegative = base08;
ForegroundNeutral = base0D;
ForegroundPositive = base0B;
};

colorscheme = {
General = {
ColorScheme = colorschemeSlug;
Name = scheme;
Name = colors.scheme;
};

"ColorEffects:Disabled" = colorEffect;
"ColorEffects:Inactive" = colorEffect;

"Colors:Window" = colors;
"Colors:View" = colors;
"Colors:Button" = colors;
"Colors:Tooltip" = colors;
"Colors:Complementary" = colors;
"Colors:Selection" = colors // {
BackgroundNormal = "${base0D-rgb-r},${base0D-rgb-g},${base0D-rgb-b}";
BackgroundAlternate = "${base0D-rgb-r},${base0D-rgb-g},${base0D-rgb-b}";
ForegroundNormal = "${base00-rgb-r},${base00-rgb-g},${base00-rgb-b}";
ForegroundActive = "${base00-rgb-r},${base00-rgb-g},${base00-rgb-b}";
ForegroundInactive = "${base00-rgb-r},${base00-rgb-g},${base00-rgb-b}";
ForegroundLink = "${base00-rgb-r},${base00-rgb-g},${base00-rgb-b}";
ForegroundVisited = "${base00-rgb-r},${base00-rgb-g},${base00-rgb-b}";
};

WM = {
activeBlend = "${base0A-rgb-r},${base0A-rgb-g},${base0A-rgb-b}";
activeBackground = "${base00-rgb-r},${base00-rgb-g},${base00-rgb-b}";
activeForeground = "${base05-rgb-r},${base05-rgb-g},${base05-rgb-b}";
inactiveBlend = "${base03-rgb-r},${base03-rgb-g},${base03-rgb-b}";
inactiveBackground = "${base00-rgb-r},${base00-rgb-g},${base00-rgb-b}";
inactiveForeground = "${base05-rgb-r},${base05-rgb-g},${base05-rgb-b}";
"Colors:Window" = kdecolors;
"Colors:View" = kdecolors;
"Colors:Button" = kdecolors;
"Colors:Tooltip" = kdecolors;
"Colors:Complementary" = kdecolors;
"Colors:Selection" =
kdecolors
// (with colors'; {
BackgroundNormal = base0D;
BackgroundAlternate = base0D;
ForegroundNormal = base00;
ForegroundActive = base00;
ForegroundInactive = base00;
ForegroundLink = base00;
ForegroundVisited = base00;
});

WM = with colors'; {
activeBlend = base0A;
activeBackground = base00;
activeForeground = base05;
inactiveBlend = base03;
inactiveBackground = base00;
inactiveForeground = base05;
};
};

Expand All @@ -138,7 +181,7 @@ let
};

lookAndFeelDefaults = {
kwinrc."org.kde.kdecoration2".library = "org.kde.breeze";
kwinrc."org.kde.kdecoration2".library = cfg.decorations;
plasmarc.Theme.name = "default";

kdeglobals = {
Expand All @@ -161,6 +204,7 @@ let
lookAndFeelMetadata = builtins.toJSON lookAndFeelMetadata;
lookAndFeelDefaults = formatConfig lookAndFeelDefaults;
}
# bash
rkuklik marked this conversation as resolved.
Show resolved Hide resolved
''
write_text() {
mkdir --parents "$(dirname "$2")"
Expand Down Expand Up @@ -212,7 +256,7 @@ let
kdeglobals = {
KDE.LookAndFeelPackage = makeImmutable "stylix";

General = rec {
General = with config.stylix.fonts; rec {
font = makeImmutable "${sansSerif.name},${toString sizes.applications},-1,5,50,0,0,0,0,0";
fixed = makeImmutable "${monospace.name},${toString sizes.terminal},-1,5,50,0,0,0,0,0";
desktopFont = makeImmutable "${sansSerif.name},${toString sizes.desktop},-1,5,50,0,0,0,0,0";
Expand Down Expand Up @@ -251,49 +295,53 @@ let
# might be installed, and look there. The ideal solution would require
# changes to KDE to make it possible to update the wallpaper through
# config files alone.
activator = pkgs.writeShellScriptBin "stylix-set-kde-wallpaper" ''
activator' = pkgs.writeShellScriptBin "stylix-activate-kde" ''
trueNAHO marked this conversation as resolved.
Show resolved Hide resolved
set -eu
global_path() {
get_exe() {
for directory in /run/current-system/sw/bin /usr/bin /bin; do
if [[ -f "$directory/$1" ]]; then
printf '%s\n' "$directory/$1"
return 0
fi
done

echo "Skipping `$1`: command not found"
return 1
}

if wallpaper_image="$(global_path plasma-apply-wallpaperimage)"; then
if wallpaper_image="$(get_exe plasma-apply-wallpaperimage)"; then
"$wallpaper_image" "${themePackage}/share/wallpapers/stylix"
else
echo "Skipping plasma-apply-wallpaperimage: command not found"
fi

if look_and_feel="$(global_path plasma-apply-lookandfeel)"; then
if look_and_feel="$(get_exe plasma-apply-lookandfeel)"; then
"$look_and_feel" --apply stylix
else
echo "Skipping plasma-apply-lookandfeel: command not found"
fi
'';

activateDocs = "https://stylix.danth.me/options/hm.html#stylixtargetskdeservice";
activator = getExe activator';
in
{
options.stylix.targets.kde.enable = config.lib.stylix.mkEnableTarget "KDE" true;
options.stylix.targets.kde = {
enable = mkEnableTarget "KDE" true;
rkuklik marked this conversation as resolved.
Show resolved Hide resolved
decorations = mkOption {
type = types.str;
default = "org.kde.breeze";
description =
let
url = "https://nix-community.github.io/plasma-manager/options.xhtml#opt-programs.plasma.workspace.windowDecorations.library";
in
"Custom border decorations. See [plasma-manager docs](${url}).";
rkuklik marked this conversation as resolved.
Show resolved Hide resolved
};
};

config =
lib.mkIf
(config.stylix.enable && cfg.enable && pkgs.stdenv.hostPlatform.isLinux)
mkIf (config.stylix.enable && cfg.enable && pkgs.stdenv.hostPlatform.isLinux)
{
home = {
packages = [ themePackage ];

# This activation entry will run the theme activator when the homeConfiguration is activated
# Note: This only works in an already running Plasma session.
activation.stylixLookAndFeel = lib.hm.dag.entryAfter [ "writeBoundary" ] ''
${lib.getExe activator} || verboseEcho \
"KDE theme setting failed. See `${activateDocs}`"
activation.stylixLookAndFeel = hm.dag.entryAfter [ "writeBoundary" ] ''
${activator} || verboseEcho \
"Stylix KDE theme setting failed. Note that it only works in an already running Plasma session."
rkuklik marked this conversation as resolved.
Show resolved Hide resolved
'';
};

Expand All @@ -305,7 +353,7 @@ in
configFile."autostart/stylix-activator.desktop".text = ''
[Desktop Entry]
Type=Application
Exec=${lib.getExe activator}
Exec=${activator}
Name=Stylix Activator
X-KDE-AutostartScript=true
'';
Expand Down
Loading