From fb3e713fc26c71605bc61ae6bf779c1dd0daff83 Mon Sep 17 00:00:00 2001
From: Bart Bakker <bart@thesoftwarecraft.com>
Date: Wed, 2 Jun 2021 22:42:23 +0200
Subject: [PATCH] htop: fix preserving the order of meters

Pass meters for formatting in a list of attrsets so that ordering can be
preserved. In addition provide some mode-specific functions to create these
attrsets, to make for a bit nicer config.

This fixes #2060.
---
 modules/programs/htop.nix                     | 66 ++++++++++++-------
 .../programs/htop/example-settings.nix        | 20 +++---
 2 files changed, 49 insertions(+), 37 deletions(-)

diff --git a/modules/programs/htop.nix b/modules/programs/htop.nix
index b04366b1253d..1edd0f7ab61d 100644
--- a/modules/programs/htop.nix
+++ b/modules/programs/htop.nix
@@ -10,10 +10,14 @@ let
     let v' = if isBool v then (if v then "1" else "0") else toString v;
     in "${n}=${v'}";
 
-  formatMeters = side: meters: {
-    "${side}_meters" = mapAttrsToList (x: _: x) meters;
-    "${side}_meter_modes" = mapAttrsToList (_: y: y) meters;
-  };
+  formatMeters = side: meters:
+    let
+      warn' = warn "htop: meters should be passed as a list";
+      meters' = if isList meters then meters else warn' [ meters ];
+    in {
+      "${side}_meters" = concatMap (mapAttrsToList (x: _: x)) meters';
+      "${side}_meter_modes" = concatMap (mapAttrsToList (_: y: y)) meters';
+    };
   leftMeters = formatMeters "left";
   rightMeters = formatMeters "right";
 
@@ -80,6 +84,14 @@ let
     LED = 4;
   };
 
+  # Utilities for constructing meters
+  meter = mode: name: { ${name} = mode; };
+  bar = meter modes.Bar;
+  text = meter modes.Text;
+  graph = meter modes.Graph;
+  led = meter modes.LED;
+  blank = text "Blank";
+
   # Mapping from names to defaults
   meters = {
     Clock = 2;
@@ -231,15 +243,17 @@ in {
         tree_view = false;
         update_process_names = false;
         vim_mode = false;
-      } // (leftMeters {
-        AllCPUs = modes.Bar;
-        Memory = modes.Bar;
-        Swap = modes.Bar;
-      }) // (rightMeters {
-        Tasks = modes.Text;
-        LoadAverage = modes.Text;
-        Uptime = modes.Text;
-      });
+      } // (leftMeters [
+        (bar "AllCPUs2")
+        (bar "Memory")
+        (bar "Swap")
+        (text "Zram")
+      ]) // (rightMeters [
+        (text "Tasks")
+        (text "LoadAverage")
+        (text "Uptime")
+        (text "Systemd")
+      ]);
       example = literalExample ''
         {
           color_scheme = 6;
@@ -262,17 +276,17 @@ in {
           highlight_base_name = 1;
           highlight_megabytes = 1;
           highlight_threads = 1;
-        } // (with config.lib.htop; leftMeters {
-          AllCPUs2 = modes.Bar;
-          Memory = modes.Bar;
-          Swap = modes.Bar;
-          Zram = modes.Text;
-        }) // (with config.lib.htop; rightMeters {
-          Tasks = modes.Text;
-          LoadAverage = modes.Text;
-          Uptime = modes.Text;
-          Systemd = modes.Text;
-        })
+        } // (with config.lib.htop; leftMeters [
+          (bar "AllCPUs2")
+          (bar "Memory")
+          (bar "Swap")
+          (text "Zram")
+        ]) // (with config.lib.htop; rightMeters [
+          (text "Tasks")
+          (text "LoadAverage")
+          (text "Uptime")
+          (text "Systemd")
+        ]);
       '';
       description = ''
         Configuration options to add to
@@ -576,7 +590,9 @@ in {
   };
 
   config = mkIf cfg.enable {
-    lib.htop = { inherit fields modes leftMeters rightMeters; };
+    lib.htop = {
+      inherit fields modes leftMeters rightMeters bar text graph led blank;
+    };
 
     home.packages = [ pkgs.htop ];
 
diff --git a/tests/modules/programs/htop/example-settings.nix b/tests/modules/programs/htop/example-settings.nix
index 94cd7676981b..66698c844e34 100644
--- a/tests/modules/programs/htop/example-settings.nix
+++ b/tests/modules/programs/htop/example-settings.nix
@@ -27,18 +27,14 @@ with lib;
       highlight_megabytes = 1;
       highlight_threads = 1;
     } // (with config.lib.htop;
-      leftMeters {
-        AllCPUs2 = modes.Bar;
-        Memory = modes.Bar;
-        Swap = modes.Bar;
-        Zram = modes.Text;
-      }) // (with config.lib.htop;
-        rightMeters {
-          Tasks = modes.Text;
-          LoadAverage = modes.Text;
-          Uptime = modes.Text;
-          Systemd = modes.Text;
-        });
+      leftMeters [ (bar "AllCPUs2") (bar "Memory") (bar "Swap") (text "Zram") ])
+      // (with config.lib.htop;
+        rightMeters [
+          (text "Tasks")
+          (text "LoadAverage")
+          (text "Uptime")
+          (text "Systemd")
+        ]);
 
     nmt.script = ''
       assertFileExists home-files/.config/htop/htoprc