Add battery options for powerdevil module (#291)

modules/powerdevil.nix

@@ -16,27 +16,17 @@ let
     sleep = null;
     shutDown = 8;
   };
-in
-{
-  config.assertions = [
-    {
-      assertion = (cfg.powerdevil.autoSuspend.action != autoSuspendActions.nothing || cfg.powerdevil.autoSuspend.idleTimeout == null);
-      message = "Setting programs.plasma.powerdevil.autoSuspend.idleTimeout for autosuspend-action \"nothing\" is not supported.";
-    }
-    {
-      assertion = (cfg.powerdevil.turnOffDisplay.idleTimeout != -1 || cfg.powerdevil.turnOffDisplay.idleTimeoutWhenLocked == null);
-      message = "Setting programs.plasma.powerdevil.turnOffDisplay.idleTimeoutWhenLocked for when idleTimeout is \"never\" is not supported.";
-    }
-  ];
 
-  options = {
-    programs.plasma.powerdevil = {
+  # Since AC and battery allows the same options we create a function here which
+  # can generate the options by just specifying the type (i.e. "AC" or
+  # "battery").
+  createPowerDevilOptions = type: {
     powerButtonAction = lib.mkOption {
       type = with lib.types; nullOr (enum (builtins.attrNames powerButtonActions));
       default = null;
       example = "nothing";
       description = ''
-          The action to perform when the power button is pressed.
+        The action, when on ${type}, to perform when the power button is pressed.
       '';
       apply = action: if (action == null) then null else powerButtonActions."${action}";
     };
@@ -46,7 +36,7 @@ in
         default = null;
         example = "nothing";
         description = ''
-            The action to perform after a certain period of inactivity.
+          The action, when on ${type}, to perform after a certain period of inactivity.
         '';
         apply = action: if (action == null) then null else autoSuspendActions."${action}";
       };
@@ -55,8 +45,8 @@ in
         default = null;
         example = 600;
         description = ''
-            The duration (in seconds) the computer must be idle until the
-            auto-suspend action is executed.
+          The duration (in seconds), when on ${type}, the computer must be idle
+          until the auto-suspend action is executed.
         '';
       };
     };
@@ -66,8 +56,8 @@ in
         default = null;
         example = 300;
         description = ''
-            The duration (in seconds) the computer must be idle (when unlocked)
-            until the display turns off.
+          The duration (in seconds), when on ${type}, the computer must be idle
+          (when unlocked) until the display turns off.
         '';
         apply = timeout:
           if (timeout == null) then null else
@@ -79,8 +69,8 @@ in
         default = null;
         example = 60;
         description = ''
-            The duration (in seconds) the computer must be idle (when locked)
-            until the display turns off.
+          The duration (in seconds), when on ${type}, the computer must be idle
+          (when locked) until the display turns off.
         '';
         apply = timeout:
           if (timeout == null) then null else
@@ -89,20 +79,83 @@ in
           else timeout;
       };
     };
+    dimDisplay = {
+      enable = lib.mkOption {
+        type = with lib.types; nullOr bool;
+        default = null;
+        example = false;
+        description = "Enable or disable screen dimming.";
+      };
+      idleTimeOut = lib.mkOption {
+        type = with lib.types; nullOr (ints.between 20 600000);
+        default = null;
+        example = 300;
+        description = ''
+          The duration (in seconds), when on ${type}, the computer must be idle
+          until the display starts dimming.
+        '';
+      };
+    };
+  };
+
+  # By the same logic as createPowerDevilOptions, we can generate the
+  # configuration. cfgSectName is here the name of the section in powerdevilrc,
+  # while optionsName is the name of the "namespace" where we should draw the
+  # options from (i.e. powerdevil.AC or powerdevil.battery).
+  createPowerDevilConfig = cfgSectName: optionsName: {
+    "${cfgSectName}/SuspendAndShutdown" = {
+      PowerButtonAction = cfg.powerdevil.${optionsName}.powerButtonAction;
+      AutoSuspendAction = cfg.powerdevil.${optionsName}.autoSuspend.action;
+      AutoSuspendIdleTimeoutSec = cfg.powerdevil.${optionsName}.autoSuspend.idleTimeout;
+    };
+    "${cfgSectName}/Display" = {
+      TurnOffDisplayIdleTimeoutSec = cfg.powerdevil.${optionsName}.turnOffDisplay.idleTimeout;
+      TurnOffDisplayIdleTimeoutWhenLockedSec = cfg.powerdevil.${optionsName}.turnOffDisplay.idleTimeoutWhenLocked;
+      DimDisplayWhenIdle =
+        if (cfg.powerdevil.${optionsName}.dimDisplay.enable != null) then
+          cfg.powerdevil.${optionsName}.dimDisplay.enable
+        else if (cfg.powerdevil.${optionsName}.dimDisplay.idleTimeOut != null) then
+          true
+        else
+          null;
+      DimDisplayIdleTimeoutSec = cfg.powerdevil.${optionsName}.dimDisplay.idleTimeOut;
+    };
+  };
+in
+{
+  imports = [
+    (lib.mkRenamedOptionModule [ "programs" "plasma" "powerdevil" "powerButtonAction" ] [ "programs" "plasma" "powerdevil" "AC" "powerButtonAction" ])
+    (lib.mkRenamedOptionModule [ "programs" "plasma" "powerdevil" "autoSuspend" ] [ "programs" "plasma" "powerdevil" "AC" "autoSuspend" ])
+    (lib.mkRenamedOptionModule [ "programs" "plasma" "powerdevil" "turnOffDisplay" ] [ "programs" "plasma" "powerdevil" "AC" "turnOffDisplay" ])
+  ];
+
+  config.assertions =
+    let
+      createAssertions = type: [
+        {
+          assertion = (cfg.powerdevil.${type}.autoSuspend.action != autoSuspendActions.nothing || cfg.powerdevil.${type}.autoSuspend.idleTimeout == null);
+          message = "Setting programs.plasma.powerdevil.${type}.autoSuspend.idleTimeout for autosuspend-action \"nothing\" is not supported.";
+        }
+        {
+          assertion = (cfg.powerdevil.${type}.turnOffDisplay.idleTimeout != -1 || cfg.powerdevil.${type}.turnOffDisplay.idleTimeoutWhenLocked == null);
+          message = "Setting programs.plasma.powerdevil.${type}.turnOffDisplay.idleTimeoutWhenLocked for idleTimeout \"never\" is not supported.";
+        }
+        {
+          assertion = (cfg.powerdevil.${type}.dimDisplay.enable != false || cfg.powerdevil.${type}.dimDisplay.idleTimeOut == null);
+          message = "Cannot set programs.plasma.powerdevil.${type}.dimDisplay.idleTimeOut when programs.plasma.powerdevil.${type}.dimDisplay.enable is disabled.";
+        }
+      ];
+    in
+    (createAssertions "AC") ++ (createAssertions "battery");
+
+  options = {
+    programs.plasma.powerdevil = {
+      AC = (createPowerDevilOptions "AC");
+      battery = (createPowerDevilOptions "battery");
     };
   };
 
   config.programs.plasma.configFile = lib.mkIf cfg.enable {
-    powerdevilrc = lib.filterAttrs (k: v: v != null) {
-      "AC/SuspendAndShutdown" = {
-        PowerButtonAction = cfg.powerdevil.powerButtonAction;
-        AutoSuspendAction = cfg.powerdevil.autoSuspend.action;
-        AutoSuspendIdleTimeoutSec = cfg.powerdevil.autoSuspend.idleTimeout;
-      };
-      "AC/Display" = {
-        TurnOffDisplayIdleTimeoutSec = cfg.powerdevil.turnOffDisplay.idleTimeout;
-        TurnOffDisplayIdleTimeoutWhenLockedSec = cfg.powerdevil.turnOffDisplay.idleTimeoutWhenLocked;
-      };
-    };
+    powerdevilrc = lib.filterAttrs (k: v: v != null) ((createPowerDevilConfig "AC" "AC") // (createPowerDevilConfig "Battery" "battery"));
   };
 }