From 0586bed5adc3ddb5f9579c98c6a830c46475d03a Mon Sep 17 00:00:00 2001
From: Pedro Alves <pta2002@pta2002.com>
Date: Tue, 5 Jan 2021 16:11:56 +0000
Subject: [PATCH] Add support for mappings

---
 .gitignore                      |   2 +-
 .tmp                            |   1 -
 example.nix                     |   6 +-
 flake.nix                       |   2 +
 nixvim.nix                      | 107 +++++++++++++++++++++++++++++++-
 plugins/helpers.nix             |  24 +++++++
 plugins/statuslines/airline.nix |  14 ++---
 7 files changed, 142 insertions(+), 14 deletions(-)
 delete mode 120000 .tmp

diff --git a/.gitignore b/.gitignore
index 3018b3a6..d36977dc 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1 +1 @@
-.tmp/
+.tmp
diff --git a/.tmp b/.tmp
deleted file mode 120000
index 40b0361a..00000000
--- a/.tmp
+++ /dev/null
@@ -1 +0,0 @@
-/nix/store/r2p2qi63zznjdf0gjif7v8qmsm5g72d7-nixos-system-nixos-21.03.20201227.2f47650
\ No newline at end of file
diff --git a/example.nix b/example.nix
index 319178de..0b451061 100644
--- a/example.nix
+++ b/example.nix
@@ -10,7 +10,7 @@
       # Equivalent to nnoremap ; :
       ";" = ":";
       # Equivalent to nmap <silent> <buffer> <leader>gg <cmd>Man<CR>
-      "<leader>gg" = { silent = true; buffer = true; remap = false; action = "<cmd>Man<CR>"
+      "<leader>gg" = { silent = true; remap = false; action = "<cmd>Man<CR>"
       # Etc...
     };
 
@@ -25,12 +25,12 @@
     options = {
       tabstop = 4;
       shiftwidth = 4;
-      noexpandtab = true;
+      expandtab = false;
 
       mouse = "a";
 
       # etc...
-    }
+    };
 
     # Of course, we can still use comfy vimscript:
     extraConfigVim = builtins.readFile ./init.vim;
diff --git a/flake.nix b/flake.nix
index 170ff892..d136b55b 100644
--- a/flake.nix
+++ b/flake.nix
@@ -37,6 +37,8 @@
 
             options.number = true;
 
+            maps.normalVisualOp."ç" = ":";
+
             plugins.airline = {
               enable = true;
               powerline = true;
diff --git a/nixvim.nix b/nixvim.nix
index bba63534..a9b81979 100644
--- a/nixvim.nix
+++ b/nixvim.nix
@@ -22,6 +22,55 @@ let
     };
   };
 
+  mapOption = types.oneOf [ types.str (types.submodule {
+    silent = mkOption {
+      type = types.bool;
+      description = "Whether this mapping should be silent. Equivalent to adding <silent> to a map.";
+      default = false;
+    };
+
+    nowait = mkOption {
+      type = types.bool;
+      description = "Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.";
+      default = false;
+    };
+
+    script = mkOption {
+      type = types.bool;
+      description = "Equivalent to adding <script> to a map.";
+      default = false;
+    };
+
+    expr = mkOption {
+      type = types.bool;
+      description = "Means that the action is actually an expression. Equivalent to adding <expr> to a map.";
+      default = false;
+    };
+
+    unique = mkOption {
+      type = types.bool;
+      description = "Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.";
+      default = false;
+    };
+
+    noremap = mkOption {
+      type = types.bool;
+      description = "Whether to use the 'noremap' variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.";
+      default = true;
+    };
+
+    action = mkOption {
+      type = types.str;
+      description = "The action to execute.";
+    };
+  }) ];
+
+  mapOptions = mode: mkOption {
+    description = "Mappings for ${mode} mode";
+    type = types.attrsOf mapOption;
+    default = {};
+  };
+  
   helpers = import ./plugins/helpers.nix { lib = lib; };
 in
 {
@@ -74,6 +123,41 @@ in
         default = {};
         description = "Global variables";
       };
+
+      maps = mkOption {
+        type = types.submodule {
+          options = {
+            normal = mapOptions "normal";
+            insert = mapOptions "insert";
+            select = mapOptions "select";
+            visual = mapOptions "visual and select";
+            terminal = mapOptions "terminal";
+            normalVisualOp = mapOptions "normal, visual, select and operator-pending (same as plain 'map')";
+
+            visualOnly = mapOptions "visual only";
+            operator = mapOptions "operator-pending";
+            insertCommand = mapOptions "insert and command-line";
+            lang = mapOptions "insert, command-line and lang-arg";
+            command = mapOptions "command-line";
+          };
+        };
+        default = {};
+        description = ''
+          Custom keybindings for any mode.
+
+          For plain maps (e.g. just 'map' or 'remap') use maps.normalVisualOp.
+        '';
+
+        example = ''
+          maps = {
+            normalVisualOp.";" = ":"; # Same as noremap ; :
+            normal."<leader>m" = {
+              silent = true;
+              action = "<cmd>make<CR>";
+            }; # Same as nnoremap <leader>m <silent> <cmd>make<CR>
+          };
+        '';
+      };
     };
   };
 
@@ -95,6 +179,20 @@ in
     wrappedNeovim = pkgs.wrapNeovimUnstable cfg.package (neovimConfig // {
       wrapperArgs = lib.escapeShellArgs neovimConfig.wrapperArgs;
     });
+
+    mappings =
+      (helpers.genMaps ""  cfg.maps.normalVisualOp) ++
+      (helpers.genMaps "n" cfg.maps.normal) ++
+      (helpers.genMaps "i" cfg.maps.insert) ++
+      (helpers.genMaps "v" cfg.maps.visual) ++
+      (helpers.genMaps "x" cfg.maps.visualOnly) ++
+      (helpers.genMaps "s" cfg.maps.select) ++
+      (helpers.genMaps "t" cfg.maps.terminal) ++
+      (helpers.genMaps "o" cfg.maps.operator) ++
+      (helpers.genMaps "l" cfg.maps.lang) ++
+      (helpers.genMaps "!" cfg.maps.insertCommand) ++
+      (helpers.genMaps "c" cfg.maps.command);
+
   in mkIf cfg.enable {
     environment.systemPackages = [ wrappedNeovim ];
     programs.nixvim = {
@@ -104,7 +202,6 @@ in
           ${cfg.extraConfigLua}
           EOF
         '' + cfg.extraConfigVim + (optionalString (cfg.colorscheme != "") ''
-
           colorscheme ${cfg.colorscheme}
         '');
         packages.nixvim = {
@@ -143,6 +240,14 @@ in
           end
         end
         -- }}}
+      '' + optionalString (mappings != []) ''
+        -- Set up keybinds {{{
+        local __nixvim_binds = ${helpers.toLuaObject mappings}
+
+        for i, map in ipairs(__nixvim_binds) do
+          vim.api.nvim_set_keymap(map.mode, map.key, map.action, map.config)
+        end
+        -- }}}
       '';
     };
 
diff --git a/plugins/helpers.nix b/plugins/helpers.nix
index b0dfcd43..c2a54dd5 100644
--- a/plugins/helpers.nix
+++ b/plugins/helpers.nix
@@ -27,4 +27,28 @@ rec {
     else if isNull args then
       "nil"
     else "";
+
+  # Generates maps for a lua config
+  genMaps = mode: maps: let
+    normalized = builtins.mapAttrs (key: action:
+      if builtins.isString action then
+        {
+          silent = false;
+          expr = false;
+          unique = false;
+          noremap = true;
+          script = false;
+          nowait = false;
+          action = action;
+        }
+      else action) maps;
+  in builtins.attrValues (builtins.mapAttrs (key: action:
+    {
+      action = action.action;
+      config = lib.filterAttrs (_: v: v) {
+        inherit (action) silent expr unique noremap script nowait;
+      };
+      key = key;
+      mode = mode;
+    }) normalized);
 }
diff --git a/plugins/statuslines/airline.nix b/plugins/statuslines/airline.nix
index f58b75e4..696c4b9d 100644
--- a/plugins/statuslines/airline.nix
+++ b/plugins/statuslines/airline.nix
@@ -30,14 +30,12 @@ in {
       sections = mkOption {
         default = null;
         type = with types; nullOr (submodule {
-          options = {
-            a = sectionOption;
-            b = sectionOption;
-            c = sectionOption;
-            x = sectionOption;
-            y = sectionOption;
-            z = sectionOption;
-          };
+          a = sectionOption;
+          b = sectionOption;
+          c = sectionOption;
+          x = sectionOption;
+          y = sectionOption;
+          z = sectionOption;
         });
       };