├── CHANGELOG.org ├── LICENSE ├── Makefile ├── README.org ├── VERSION ├── fnl ├── minor-mode.fnl └── minor-mode │ ├── map.fnl │ ├── nvim.fnl │ ├── strings.fnl │ └── trace.fnl └── lua └── minor-mode.lua /CHANGELOG.org: -------------------------------------------------------------------------------- 1 | * Unreleased 2 | 3 | ... 4 | 5 | * v0.3.0 6 | 7 | ** Features 8 | - Soft deprecation of =define/3= in favor of =define-minor-mode/3= 9 | - Add more documentation for =define-minor-mode/3= 10 | 11 | * v0.2.0 12 | 13 | ** Features 14 | - Additional error handling for function based keybindings 15 | 16 | ** Fixes 17 | - Fix error that occurred when disabling minor modes 18 | 19 | * v0.1.0 20 | - added =define/3= function 21 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Mozilla Public License Version 2.0 2 | ================================== 3 | 4 | 1. Definitions 5 | -------------- 6 | 7 | 1.1. "Contributor" 8 | means each individual or legal entity that creates, contributes to 9 | the creation of, or owns Covered Software. 10 | 11 | 1.2. "Contributor Version" 12 | means the combination of the Contributions of others (if any) used 13 | by a Contributor and that particular Contributor's Contribution. 14 | 15 | 1.3. "Contribution" 16 | means Covered Software of a particular Contributor. 17 | 18 | 1.4. "Covered Software" 19 | means Source Code Form to which the initial Contributor has attached 20 | the notice in Exhibit A, the Executable Form of such Source Code 21 | Form, and Modifications of such Source Code Form, in each case 22 | including portions thereof. 23 | 24 | 1.5. "Incompatible With Secondary Licenses" 25 | means 26 | 27 | (a) that the initial Contributor has attached the notice described 28 | in Exhibit B to the Covered Software; or 29 | 30 | (b) that the Covered Software was made available under the terms of 31 | version 1.1 or earlier of the License, but not also under the 32 | terms of a Secondary License. 33 | 34 | 1.6. "Executable Form" 35 | means any form of the work other than Source Code Form. 36 | 37 | 1.7. "Larger Work" 38 | means a work that combines Covered Software with other material, in 39 | a separate file or files, that is not Covered Software. 40 | 41 | 1.8. "License" 42 | means this document. 43 | 44 | 1.9. "Licensable" 45 | means having the right to grant, to the maximum extent possible, 46 | whether at the time of the initial grant or subsequently, any and 47 | all of the rights conveyed by this License. 48 | 49 | 1.10. "Modifications" 50 | means any of the following: 51 | 52 | (a) any file in Source Code Form that results from an addition to, 53 | deletion from, or modification of the contents of Covered 54 | Software; or 55 | 56 | (b) any new file in Source Code Form that contains any Covered 57 | Software. 58 | 59 | 1.11. "Patent Claims" of a Contributor 60 | means any patent claim(s), including without limitation, method, 61 | process, and apparatus claims, in any patent Licensable by such 62 | Contributor that would be infringed, but for the grant of the 63 | License, by the making, using, selling, offering for sale, having 64 | made, import, or transfer of either its Contributions or its 65 | Contributor Version. 66 | 67 | 1.12. "Secondary License" 68 | means either the GNU General Public License, Version 2.0, the GNU 69 | Lesser General Public License, Version 2.1, the GNU Affero General 70 | Public License, Version 3.0, or any later versions of those 71 | licenses. 72 | 73 | 1.13. "Source Code Form" 74 | means the form of the work preferred for making modifications. 75 | 76 | 1.14. "You" (or "Your") 77 | means an individual or a legal entity exercising rights under this 78 | License. For legal entities, "You" includes any entity that 79 | controls, is controlled by, or is under common control with You. For 80 | purposes of this definition, "control" means (a) the power, direct 81 | or indirect, to cause the direction or management of such entity, 82 | whether by contract or otherwise, or (b) ownership of more than 83 | fifty percent (50%) of the outstanding shares or beneficial 84 | ownership of such entity. 85 | 86 | 2. License Grants and Conditions 87 | -------------------------------- 88 | 89 | 2.1. Grants 90 | 91 | Each Contributor hereby grants You a world-wide, royalty-free, 92 | non-exclusive license: 93 | 94 | (a) under intellectual property rights (other than patent or trademark) 95 | Licensable by such Contributor to use, reproduce, make available, 96 | modify, display, perform, distribute, and otherwise exploit its 97 | Contributions, either on an unmodified basis, with Modifications, or 98 | as part of a Larger Work; and 99 | 100 | (b) under Patent Claims of such Contributor to make, use, sell, offer 101 | for sale, have made, import, and otherwise transfer either its 102 | Contributions or its Contributor Version. 103 | 104 | 2.2. Effective Date 105 | 106 | The licenses granted in Section 2.1 with respect to any Contribution 107 | become effective for each Contribution on the date the Contributor first 108 | distributes such Contribution. 109 | 110 | 2.3. Limitations on Grant Scope 111 | 112 | The licenses granted in this Section 2 are the only rights granted under 113 | this License. No additional rights or licenses will be implied from the 114 | distribution or licensing of Covered Software under this License. 115 | Notwithstanding Section 2.1(b) above, no patent license is granted by a 116 | Contributor: 117 | 118 | (a) for any code that a Contributor has removed from Covered Software; 119 | or 120 | 121 | (b) for infringements caused by: (i) Your and any other third party's 122 | modifications of Covered Software, or (ii) the combination of its 123 | Contributions with other software (except as part of its Contributor 124 | Version); or 125 | 126 | (c) under Patent Claims infringed by Covered Software in the absence of 127 | its Contributions. 128 | 129 | This License does not grant any rights in the trademarks, service marks, 130 | or logos of any Contributor (except as may be necessary to comply with 131 | the notice requirements in Section 3.4). 132 | 133 | 2.4. Subsequent Licenses 134 | 135 | No Contributor makes additional grants as a result of Your choice to 136 | distribute the Covered Software under a subsequent version of this 137 | License (see Section 10.2) or under the terms of a Secondary License (if 138 | permitted under the terms of Section 3.3). 139 | 140 | 2.5. Representation 141 | 142 | Each Contributor represents that the Contributor believes its 143 | Contributions are its original creation(s) or it has sufficient rights 144 | to grant the rights to its Contributions conveyed by this License. 145 | 146 | 2.6. Fair Use 147 | 148 | This License is not intended to limit any rights You have under 149 | applicable copyright doctrines of fair use, fair dealing, or other 150 | equivalents. 151 | 152 | 2.7. Conditions 153 | 154 | Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted 155 | in Section 2.1. 156 | 157 | 3. Responsibilities 158 | ------------------- 159 | 160 | 3.1. Distribution of Source Form 161 | 162 | All distribution of Covered Software in Source Code Form, including any 163 | Modifications that You create or to which You contribute, must be under 164 | the terms of this License. You must inform recipients that the Source 165 | Code Form of the Covered Software is governed by the terms of this 166 | License, and how they can obtain a copy of this License. You may not 167 | attempt to alter or restrict the recipients' rights in the Source Code 168 | Form. 169 | 170 | 3.2. Distribution of Executable Form 171 | 172 | If You distribute Covered Software in Executable Form then: 173 | 174 | (a) such Covered Software must also be made available in Source Code 175 | Form, as described in Section 3.1, and You must inform recipients of 176 | the Executable Form how they can obtain a copy of such Source Code 177 | Form by reasonable means in a timely manner, at a charge no more 178 | than the cost of distribution to the recipient; and 179 | 180 | (b) You may distribute such Executable Form under the terms of this 181 | License, or sublicense it under different terms, provided that the 182 | license for the Executable Form does not attempt to limit or alter 183 | the recipients' rights in the Source Code Form under this License. 184 | 185 | 3.3. Distribution of a Larger Work 186 | 187 | You may create and distribute a Larger Work under terms of Your choice, 188 | provided that You also comply with the requirements of this License for 189 | the Covered Software. If the Larger Work is a combination of Covered 190 | Software with a work governed by one or more Secondary Licenses, and the 191 | Covered Software is not Incompatible With Secondary Licenses, this 192 | License permits You to additionally distribute such Covered Software 193 | under the terms of such Secondary License(s), so that the recipient of 194 | the Larger Work may, at their option, further distribute the Covered 195 | Software under the terms of either this License or such Secondary 196 | License(s). 197 | 198 | 3.4. Notices 199 | 200 | You may not remove or alter the substance of any license notices 201 | (including copyright notices, patent notices, disclaimers of warranty, 202 | or limitations of liability) contained within the Source Code Form of 203 | the Covered Software, except that You may alter any license notices to 204 | the extent required to remedy known factual inaccuracies. 205 | 206 | 3.5. Application of Additional Terms 207 | 208 | You may choose to offer, and to charge a fee for, warranty, support, 209 | indemnity or liability obligations to one or more recipients of Covered 210 | Software. However, You may do so only on Your own behalf, and not on 211 | behalf of any Contributor. You must make it absolutely clear that any 212 | such warranty, support, indemnity, or liability obligation is offered by 213 | You alone, and You hereby agree to indemnify every Contributor for any 214 | liability incurred by such Contributor as a result of warranty, support, 215 | indemnity or liability terms You offer. You may include additional 216 | disclaimers of warranty and limitations of liability specific to any 217 | jurisdiction. 218 | 219 | 4. Inability to Comply Due to Statute or Regulation 220 | --------------------------------------------------- 221 | 222 | If it is impossible for You to comply with any of the terms of this 223 | License with respect to some or all of the Covered Software due to 224 | statute, judicial order, or regulation then You must: (a) comply with 225 | the terms of this License to the maximum extent possible; and (b) 226 | describe the limitations and the code they affect. Such description must 227 | be placed in a text file included with all distributions of the Covered 228 | Software under this License. Except to the extent prohibited by statute 229 | or regulation, such description must be sufficiently detailed for a 230 | recipient of ordinary skill to be able to understand it. 231 | 232 | 5. Termination 233 | -------------- 234 | 235 | 5.1. The rights granted under this License will terminate automatically 236 | if You fail to comply with any of its terms. However, if You become 237 | compliant, then the rights granted under this License from a particular 238 | Contributor are reinstated (a) provisionally, unless and until such 239 | Contributor explicitly and finally terminates Your grants, and (b) on an 240 | ongoing basis, if such Contributor fails to notify You of the 241 | non-compliance by some reasonable means prior to 60 days after You have 242 | come back into compliance. Moreover, Your grants from a particular 243 | Contributor are reinstated on an ongoing basis if such Contributor 244 | notifies You of the non-compliance by some reasonable means, this is the 245 | first time You have received notice of non-compliance with this License 246 | from such Contributor, and You become compliant prior to 30 days after 247 | Your receipt of the notice. 248 | 249 | 5.2. If You initiate litigation against any entity by asserting a patent 250 | infringement claim (excluding declaratory judgment actions, 251 | counter-claims, and cross-claims) alleging that a Contributor Version 252 | directly or indirectly infringes any patent, then the rights granted to 253 | You by any and all Contributors for the Covered Software under Section 254 | 2.1 of this License shall terminate. 255 | 256 | 5.3. In the event of termination under Sections 5.1 or 5.2 above, all 257 | end user license agreements (excluding distributors and resellers) which 258 | have been validly granted by You or Your distributors under this License 259 | prior to termination shall survive termination. 260 | 261 | ************************************************************************ 262 | * * 263 | * 6. Disclaimer of Warranty * 264 | * ------------------------- * 265 | * * 266 | * Covered Software is provided under this License on an "as is" * 267 | * basis, without warranty of any kind, either expressed, implied, or * 268 | * statutory, including, without limitation, warranties that the * 269 | * Covered Software is free of defects, merchantable, fit for a * 270 | * particular purpose or non-infringing. The entire risk as to the * 271 | * quality and performance of the Covered Software is with You. * 272 | * Should any Covered Software prove defective in any respect, You * 273 | * (not any Contributor) assume the cost of any necessary servicing, * 274 | * repair, or correction. This disclaimer of warranty constitutes an * 275 | * essential part of this License. No use of any Covered Software is * 276 | * authorized under this License except under this disclaimer. * 277 | * * 278 | ************************************************************************ 279 | 280 | ************************************************************************ 281 | * * 282 | * 7. Limitation of Liability * 283 | * -------------------------- * 284 | * * 285 | * Under no circumstances and under no legal theory, whether tort * 286 | * (including negligence), contract, or otherwise, shall any * 287 | * Contributor, or anyone who distributes Covered Software as * 288 | * permitted above, be liable to You for any direct, indirect, * 289 | * special, incidental, or consequential damages of any character * 290 | * including, without limitation, damages for lost profits, loss of * 291 | * goodwill, work stoppage, computer failure or malfunction, or any * 292 | * and all other commercial damages or losses, even if such party * 293 | * shall have been informed of the possibility of such damages. This * 294 | * limitation of liability shall not apply to liability for death or * 295 | * personal injury resulting from such party's negligence to the * 296 | * extent applicable law prohibits such limitation. Some * 297 | * jurisdictions do not allow the exclusion or limitation of * 298 | * incidental or consequential damages, so this exclusion and * 299 | * limitation may not apply to You. * 300 | * * 301 | ************************************************************************ 302 | 303 | 8. Litigation 304 | ------------- 305 | 306 | Any litigation relating to this License may be brought only in the 307 | courts of a jurisdiction where the defendant maintains its principal 308 | place of business and such litigation shall be governed by laws of that 309 | jurisdiction, without reference to its conflict-of-law provisions. 310 | Nothing in this Section shall prevent a party's ability to bring 311 | cross-claims or counter-claims. 312 | 313 | 9. Miscellaneous 314 | ---------------- 315 | 316 | This License represents the complete agreement concerning the subject 317 | matter hereof. If any provision of this License is held to be 318 | unenforceable, such provision shall be reformed only to the extent 319 | necessary to make it enforceable. Any law or regulation which provides 320 | that the language of a contract shall be construed against the drafter 321 | shall not be used to construe this License against a Contributor. 322 | 323 | 10. Versions of the License 324 | --------------------------- 325 | 326 | 10.1. New Versions 327 | 328 | Mozilla Foundation is the license steward. Except as provided in Section 329 | 10.3, no one other than the license steward has the right to modify or 330 | publish new versions of this License. Each version will be given a 331 | distinguishing version number. 332 | 333 | 10.2. Effect of New Versions 334 | 335 | You may distribute the Covered Software under the terms of the version 336 | of the License under which You originally received the Covered Software, 337 | or under the terms of any subsequent version published by the license 338 | steward. 339 | 340 | 10.3. Modified Versions 341 | 342 | If you create software not governed by this License, and you want to 343 | create a new license for such software, you may create and use a 344 | modified version of this License if you rename the license and remove 345 | any references to the name of the license steward (except to note that 346 | such modified license differs from this License). 347 | 348 | 10.4. Distributing Source Code Form that is Incompatible With Secondary 349 | Licenses 350 | 351 | If You choose to distribute Source Code Form that is Incompatible With 352 | Secondary Licenses under the terms of this version of the License, the 353 | notice described in Exhibit B of this License must be attached. 354 | 355 | Exhibit A - Source Code Form License Notice 356 | ------------------------------------------- 357 | 358 | This Source Code Form is subject to the terms of the Mozilla Public 359 | License, v. 2.0. If a copy of the MPL was not distributed with this 360 | file, You can obtain one at http://mozilla.org/MPL/2.0/. 361 | 362 | If it is not possible or desirable to put the notice in a particular 363 | file, then You may include the notice in a location (such as a LICENSE 364 | file in a relevant directory) where a recipient would be likely to look 365 | for such a notice. 366 | 367 | You may add additional accurate notices of copyright ownership. 368 | 369 | Exhibit B - "Incompatible With Secondary Licenses" Notice 370 | --------------------------------------------------------- 371 | 372 | This Source Code Form is "Incompatible With Secondary Licenses", as 373 | defined by the Mozilla Public License, v. 2.0. 374 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | MAKEFLAGS=-j 10 2 | 3 | fennel_paths := fnl/?.fnl 4 | lua_paths := lua/?.lua /usr/share/nvim/runtime/lua/?.lua 5 | 6 | FNL_FLAGS = 7 | FNL = fennel 8 | FNL += $(patsubst %, --add-fennel-path %, $(fennel_paths)) 9 | FNL += $(patsubst %, --add-package-path %, $(lua_paths)) 10 | FNL += $(FNL_FLAGS) 11 | FNL += --require-as-include 12 | FNL += --compile 13 | 14 | lua_files := $(patsubst fnl/%.fnl, lua/%.lua, $(wildcard fnl/*.fnl)) 15 | lua_files := $(filter-out %-macro.lua, $(lua_files)) 16 | 17 | reset := \e[0;0m 18 | blue := \e[1;34m 19 | 20 | all:: $(dir lua_files) $(lua_files) 21 | 22 | @PHONY: 23 | clean:: 24 | rm -rf $(lua_files) 25 | 26 | lua/%.lua:: fnl/%.fnl 27 | mkdir -p $(dir $@) 28 | if ! $(FNL) $< > $@; then rm $@; fi 29 | sed -i -E '/debug.traceback = fennel.traceback/d' $@ 30 | 31 | % :: 32 | @echo $@ 33 | -------------------------------------------------------------------------------- /README.org: -------------------------------------------------------------------------------- 1 | * Nvim-minor-mode 2 | 3 | This package adds similar functionality as Emacs's minor modes. 4 | 5 | ** Minor modes 6 | 7 | Within the definition of this package a minor mode is a set of keymaps that 8 | are enabled with some command, and can be disabled using the same command. 9 | 10 | They're useful for functionality that you don't necessarily always want to be 11 | active. 12 | 13 | ** Installation 14 | 15 | Use whatever package manager you like: 16 | 17 | #+begin_src vim 18 | Plug 'Dkendal/nvim-minor-mode' 19 | #+end_src 20 | 21 | #+begin_src lua 22 | use { 'Dkendal/nvim-minor-mode' } 23 | #+end_src 24 | 25 | ** Usage 26 | 27 | Minor modes can be defined using the =define_minor_mode= function. 28 | 29 | Say I wanted to defined a "lisp" minor mode. While I could write a new plugin 30 | and define it for all filetypes that are a lisp, I could instead define a 31 | minor mode and enable it as desired while editing files. 32 | 33 | #+begin_src lua 34 | local define_minor_mode = require('minor-mode').define_minor_mode 35 | 36 | define_minor_mode('lisp', [[ 37 | Minor modes for lisps to navigate sexps. Replaces some normal movement 38 | keybindings. 39 | ]], { 40 | command = 'LispMode', 41 | keymap = { 42 | { 43 | 'n', 44 | 'j', 45 | function() 46 | vim.fn.search('(') 47 | end, 48 | { silent = true } 49 | }, 50 | 51 | { 52 | 'n', 53 | 'k', 54 | function() 55 | vim.fn.search('(', 'b') 56 | end, 57 | { silent = true } 58 | } 59 | } 60 | }) 61 | #+end_src 62 | 63 | The second argument, =LispMode=, will be used to define a new command. 64 | 65 | #+begin_src vim 66 | :LispMode 67 | #+end_src 68 | 69 | Calling it again will remove all the keymaps. 70 | 71 | ** Types 72 | 73 | #+begin_example 74 | vim-expr :: string 75 | 76 | command-name :: string 77 | 78 | A valid vim command name. 79 | 80 | mode :: "n" | "v" | "x" | ... | "!" "" 81 | 82 | See [map-overview] or [nvim_set_keymap] 83 | 84 | minor-mode-name :: string 85 | 86 | lhs :: string 87 | 88 | rhs :: vim-expr | function 89 | 90 | Standard right hand side of a keybinding, but can also be a lua function. 91 | 92 | mapping-opts :: { 93 | nowait = boolean, 94 | silent = boolean, 95 | script = boolean, 96 | expr = boolean, 97 | unique = boolean, 98 | noremap = boolean, 99 | } 100 | 101 | See the definition of {opts} for [nvim_set_keymap]. 102 | 103 | mapping :: { mode lhs, rhs, mapping-opts || null } 104 | 105 | Same arguments as [nvim_set_keymap], except rhs may also be a lua function. 106 | 107 | keymap :: { mapping } 108 | #+end_example 109 | 110 | 111 | ** API 112 | All top level API functions should treat kebab-case methods and 113 | underscore_case functions interchangeably for fennel and lua use, 114 | respectively. 115 | 116 | *** =define_minor_mode(mode :: minor-mode-name, doc :: string, minor-mode-opts)= 117 | 118 | Defines a new minor mode whose name is =mode= (a string). It defines a Vim 119 | command named after =opts.command= to toggle the minor mode, standard Vim 120 | command naming rules apply (:h :user-cmd-ambiguous). Provide a short 121 | explanation of what the minor mode is in =doc-string= - this value isn't 122 | exposed anywhere at the moment. 123 | 124 | =minor-mode-opts= is a map, key values are defined below: 125 | 126 | **** =:command= =command-name= 127 | 128 | **** =:keymap= =keymap= 129 | 130 | An array of key bindings that will be activated with the minor mode. Key 131 | bindings are the same as arguments to =nvim_set_keymap= (:h nvim_set_keymap()) 132 | 133 | Here's an example keymap: 134 | 135 | #+begin_src lua 136 | { 137 | keymap = { 138 | { 'n', '', ':echo \"down\"', { silent = true } }, 139 | { 'n', '', ':echo \"up\"', { silent = true } } } 140 | } 141 | } 142 | #+end_src 143 | 144 | ** Caveats 145 | 146 | This plugin uses buffer local keymaps, if you already have a buffer local 147 | keymap present, or overwrite it with another while a minor mode is active and 148 | then disable said minor mode, the keymap will be removed. 149 | 150 | ** Related 151 | 152 | - https://github.com/kana/vim-submode 153 | - https://www.gnu.org/software/emacs/manual/html_node/elisp/Defining-Minor-Modes.html 154 | 155 | ** Liscence 156 | 157 | MPL-2.0 158 | -------------------------------------------------------------------------------- /VERSION: -------------------------------------------------------------------------------- 1 | 0.3.0 2 | -------------------------------------------------------------------------------- /fnl/minor-mode.fnl: -------------------------------------------------------------------------------- 1 | (set debug.traceback fennel.traceback) 2 | 3 | (local nvim (require :minor-mode.nvim)) 4 | (local {: bmap} (require :minor-mode.map)) 5 | (local {: quote-expr : rtc} (require :minor-mode.strings)) 6 | (local {: trace-module} (require :minor-mode.trace)) 7 | 8 | (local api vim.api) 9 | (local ex vim.cmd) 10 | (local luv vim.loop) 11 | (local pack table.pack) 12 | 13 | ;; TODO move file 14 | (fn pack [...] 15 | "Lua 5.2 table pack" 16 | (values [...] (select "#" ...))) 17 | 18 | (local M {}) 19 | 20 | (local keymaps {}) 21 | (local minor-modes-enabled {}) 22 | 23 | ;; FIXME make this useful for modeline or galaxyline 24 | (fn enabled-list [] 25 | (icollect [mode-name bit-status (pairs minor-modes-enabled)] 26 | (when (= bit-status 1) 27 | mode-name))) 28 | 29 | (fn enable [mode-name] 30 | "Activate minor mode" 31 | (tset minor-modes-enabled mode-name true) 32 | (local keymap (. keymaps mode-name)) 33 | (each [_ map (ipairs keymap)] 34 | (bmap (unpack map)))) 35 | 36 | (fn disable [mode-name] 37 | "Disable minor-mode keymap" 38 | (tset minor-modes-enabled mode-name false) 39 | (local keymap (. keymaps mode-name)) 40 | (each [_ [mode lhs] (ipairs keymap)] 41 | (nvim.buf_del_keymap 0 mode lhs))) 42 | 43 | (fn toggle [mode-name] 44 | "Toggle a minor mode, enable or disable will be called conditionaly" 45 | (if (. minor-modes-enabled mode-name) 46 | (disable mode-name) 47 | (enable mode-name)) 48 | (print (.. mode-name " " (tostring (. minor-modes-enabled mode-name))))) 49 | 50 | (fn define-minor-mode [mode doc-string opts] 51 | " 52 | define mode doc minor-mode-opts 53 | 54 | Defines a new minor mode whose name is `mode` (a string). It defines a vim 55 | command named after `opts.command` to toggle the minor mode, standard vim 56 | command naming rules apply (:h :user-cmd-ambiguous). Provide a short 57 | explanation of what the minor mode is in `doc-string` - this value isn't 58 | exposed anywhere at the moment. 59 | 60 | `minor-mode-opts` is a map, key values are defined below: 61 | 62 | :command command-name 63 | 64 | :keymap keymap 65 | 66 | An array of key bindings that will be actived with the minor mode. Key 67 | bindings are the same as arguments to nvim_set_keymap (:h nvim_set_keymap()) 68 | 69 | Here's an example keymap: 70 | 71 | ```lua 72 | { 73 | keymap = { 74 | { 'n', '', ':echo \"down\"', { silent = true } }, 75 | { 'n', '', ':echo \"up\"', { silent = true } } } 76 | } 77 | ``` 78 | " 79 | (local {: command : keymap} opts) 80 | ;; Option validation 81 | (assert (-> command (type) (= :string)) 82 | (.. "expected table entry 'command' to be a string, got: " 83 | (type command))) 84 | (assert (-> keymap (type) (= :table)) 85 | (.. "expected table entry 'keymap' to be a table, got: " 86 | (type keymap))) 87 | ;; Define command to toggle the new minor mode 88 | (local lua-expr (.. "require('minor-mode').toggle(" (quote-expr mode) ")")) 89 | (ex (.. "command! " command " :lua " lua-expr :)) 90 | ;; Add state entries 91 | (tset minor-modes-enabled mode false) 92 | (tset keymaps mode keymap)) 93 | 94 | (fn define [mode command keymap] 95 | " 96 | define mode command keymap 97 | 98 | Deprecated, use define-minor-mode 99 | " 100 | (print "define is deprecated, use define-minor-mode instead") 101 | (define-minor-mode mode "" {: command : keymap})) 102 | 103 | (local exports {: define 104 | : define-minor-mode 105 | :define_minor_mode define-minor-mode 106 | : disable 107 | : enable 108 | : toggle}) 109 | 110 | (trace-module exports) 111 | 112 | -------------------------------------------------------------------------------- /fnl/minor-mode/map.fnl: -------------------------------------------------------------------------------- 1 | ;; Everything related to key mapping 2 | 3 | (local nvim (require :minor-mode.nvim)) 4 | (local {: quote-expr : rtc} (require :minor-mode.strings)) 5 | 6 | (local M {}) 7 | 8 | (macro get-module-name [ast] 9 | " 10 | Return the name of the module, as it would be required. 11 | 12 | For example if the current file is fnl/foo/bar/.fnl the return value is 'foo.bar' 13 | 14 | The parameter [ast] is required to extract the filename from the call site. 15 | " 16 | (-> (getmetatable ast) (. :filename) (: :match "fnl/(.*).fnl") 17 | (: :gsub "/" "."))) 18 | 19 | ;; TODO replace with a function to trigger callback and trace calls 20 | (set M.callbacks {}) 21 | 22 | (fn __index [tbl lhs] 23 | "Handle missing function handlers for keymaps" 24 | (local stack (debug.traceback)) 25 | (error (.. "No function handler was defined for the key binding " 26 | (quote-expr lhs) stack))) 27 | 28 | (setmetatable M.callbacks {: __index}) 29 | 30 | (local __module (get-module-name {})) 31 | 32 | (fn M.bmap [mode lhs rhs ?opts] 33 | " 34 | Define a new buffer local map 35 | rhs may be a vim expression as a string, or a function callback. 36 | " 37 | (var rhs_ rhs) 38 | (when (= (type rhs) :function) 39 | (local key (rtc lhs)) 40 | ;; TODO maybe this should be nested under the mode name? 41 | (tset M.callbacks key rhs) 42 | (var lua-expr (.. "require(" (quote-expr __module) ").callbacks[" 43 | (quote-expr key) "]()")) 44 | (set rhs_ (.. "lua " lua-expr :))) 45 | (nvim.buf_set_keymap 0 mode lhs rhs_ (or ?opts {}))) 46 | 47 | M 48 | 49 | -------------------------------------------------------------------------------- /fnl/minor-mode/nvim.fnl: -------------------------------------------------------------------------------- 1 | ;; Convenience API for neovim functions 2 | ;; 3 | ;; Methods like: 4 | ;; 5 | ;; vim.api.nvim_buf_set_keymap() 6 | ;; 7 | ;; can be called like: 8 | ;; 9 | ;; nvim.buf_set_keymap() 10 | (setmetatable {} {:__index #(. vim.api (.. :nvim_ $2))}) 11 | -------------------------------------------------------------------------------- /fnl/minor-mode/strings.fnl: -------------------------------------------------------------------------------- 1 | (local M {}) 2 | 3 | (local nvim (require :minor-mode.nvim)) 4 | 5 | (fn M.quote-expr [expr] 6 | "Surround expr with double quotes, and escape any double quotes." 7 | (.. "\"" (string.gsub expr "\"" "\\\"") "\"")) 8 | 9 | (fn M.rtc [code] 10 | "Replace termcodes" 11 | (nvim.replace_termcodes code true true true)) 12 | 13 | M 14 | -------------------------------------------------------------------------------- /fnl/minor-mode/trace.fnl: -------------------------------------------------------------------------------- 1 | (local M {}) 2 | 3 | (fn M.trace-fn [func] 4 | "Add a stacktrace to the function on error" 5 | (fn [...] 6 | (local args [...]) 7 | 8 | (fn wrapped-func [] 9 | (func (unpack args))) 10 | 11 | (match [(xpcall wrapped-func debug.traceback)] 12 | [false err] (error err) 13 | [true value] value))) 14 | 15 | (fn M.trace-module [module] 16 | " 17 | Return a new metatable in the place of module. All functions on module are 18 | wrapped with a traceback error handler 19 | " 20 | (fn __index [self key] 21 | (match (. module key) 22 | (where func (-> (type func) (= :function))) (M.trace-fn func) 23 | value value)) 24 | 25 | (setmetatable {} {: __index})) 26 | 27 | M 28 | -------------------------------------------------------------------------------- /lua/minor-mode.lua: -------------------------------------------------------------------------------- 1 | package.preload["minor-mode.trace"] = package.preload["minor-mode.trace"] or function(...) 2 | local M = {} 3 | M["trace-fn"] = function(func) 4 | local function _7_(...) 5 | local args = {...} 6 | local function wrapped_func() 7 | return func(unpack(args)) 8 | end 9 | local _8_ = {xpcall(wrapped_func, debug.traceback)} 10 | if ((type(_8_) == "table") and ((_8_)[1] == false) and (nil ~= (_8_)[2])) then 11 | local err = (_8_)[2] 12 | return error(err) 13 | elseif ((type(_8_) == "table") and ((_8_)[1] == true) and (nil ~= (_8_)[2])) then 14 | local value = (_8_)[2] 15 | return value 16 | end 17 | end 18 | return _7_ 19 | end 20 | M["trace-module"] = function(module) 21 | local function __index(self, key) 22 | local _10_ = module[key] 23 | local function _11_() 24 | local func = _10_ 25 | return (type(func) == "function") 26 | end 27 | if ((nil ~= _10_) and _11_()) then 28 | local func = _10_ 29 | return M["trace-fn"](func) 30 | elseif (nil ~= _10_) then 31 | local value = _10_ 32 | return value 33 | end 34 | end 35 | return setmetatable({}, {__index = __index}) 36 | end 37 | return M 38 | end 39 | package.preload["minor-mode.strings"] = package.preload["minor-mode.strings"] or function(...) 40 | local M = {} 41 | local nvim = require("minor-mode.nvim") 42 | M["quote-expr"] = function(expr) 43 | return ("\"" .. string.gsub(expr, "\"", "\\\"") .. "\"") 44 | end 45 | M.rtc = function(code) 46 | return nvim.replace_termcodes(code, true, true, true) 47 | end 48 | return M 49 | end 50 | package.preload["minor-mode.map"] = package.preload["minor-mode.map"] or function(...) 51 | local nvim = require("minor-mode.nvim") 52 | local _local_3_ = require("minor-mode.strings") 53 | local quote_expr = _local_3_["quote-expr"] 54 | local rtc = _local_3_["rtc"] 55 | local M = {} 56 | M.callbacks = {} 57 | local function __index(tbl, lhs) 58 | local stack = debug.traceback() 59 | return error(("No function handler was defined for the key binding " .. quote_expr(lhs) .. stack)) 60 | end 61 | setmetatable(M.callbacks, {__index = __index}) 62 | local __module = "minor-mode.map" 63 | M.bmap = function(mode, lhs, rhs, _3fopts) 64 | local rhs_ = rhs 65 | if (type(rhs) == "function") then 66 | local key = rtc(lhs) 67 | do end (M.callbacks)[key] = rhs 68 | local lua_expr = ("require(" .. quote_expr(__module) .. ").callbacks[" .. quote_expr(key) .. "]()") 69 | rhs_ = ("lua " .. lua_expr .. "") 70 | end 71 | return nvim.buf_set_keymap(0, mode, lhs, rhs_, (_3fopts or {})) 72 | end 73 | return M 74 | end 75 | package.preload["minor-mode.nvim"] = package.preload["minor-mode.nvim"] or function(...) 76 | local function _1_(_241, _242) 77 | return vim.api[("nvim_" .. _242)] 78 | end 79 | return setmetatable({}, {__index = _1_}) 80 | end 81 | local nvim = require("minor-mode.nvim") 82 | local _local_2_ = require("minor-mode.map") 83 | local bmap = _local_2_["bmap"] 84 | local _local_5_ = require("minor-mode.strings") 85 | local quote_expr = _local_5_["quote-expr"] 86 | local rtc = _local_5_["rtc"] 87 | local _local_6_ = require("minor-mode.trace") 88 | local trace_module = _local_6_["trace-module"] 89 | local api = vim.api 90 | local ex = vim.cmd 91 | local luv = vim.loop 92 | local pack = table.pack 93 | local function pack0(...) 94 | return {...}, select("#", ...) 95 | end 96 | local M = {} 97 | local keymaps = {} 98 | local minor_modes_enabled = {} 99 | local function enabled_list() 100 | local tbl_12_auto = {} 101 | for mode_name, bit_status in pairs(minor_modes_enabled) do 102 | local _13_ 103 | if (bit_status == 1) then 104 | _13_ = mode_name 105 | else 106 | _13_ = nil 107 | end 108 | tbl_12_auto[(#tbl_12_auto + 1)] = _13_ 109 | end 110 | return tbl_12_auto 111 | end 112 | local function enable(mode_name) 113 | minor_modes_enabled[mode_name] = true 114 | local keymap = keymaps[mode_name] 115 | for _, map in ipairs(keymap) do 116 | bmap(unpack(map)) 117 | end 118 | return nil 119 | end 120 | local function disable(mode_name) 121 | minor_modes_enabled[mode_name] = false 122 | local keymap = keymaps[mode_name] 123 | for _, _15_ in ipairs(keymap) do 124 | local _each_16_ = _15_ 125 | local mode = _each_16_[1] 126 | local lhs = _each_16_[2] 127 | nvim.buf_del_keymap(0, mode, lhs) 128 | end 129 | return nil 130 | end 131 | local function toggle(mode_name) 132 | if minor_modes_enabled[mode_name] then 133 | disable(mode_name) 134 | else 135 | enable(mode_name) 136 | end 137 | return print((mode_name .. " " .. tostring(minor_modes_enabled[mode_name]))) 138 | end 139 | local function define_minor_mode(mode, doc_string, opts) 140 | local _local_18_ = opts 141 | local command = _local_18_["command"] 142 | local keymap = _local_18_["keymap"] 143 | assert((type(command) == "string"), ("expected table entry 'command' to be a string, got: " .. type(command))) 144 | assert((type(keymap) == "table"), ("expected table entry 'keymap' to be a table, got: " .. type(keymap))) 145 | local lua_expr = ("require('minor-mode').toggle(" .. quote_expr(mode) .. ")") 146 | ex(("command! " .. command .. " :lua " .. lua_expr .. "")) 147 | do end (minor_modes_enabled)[mode] = false 148 | keymaps[mode] = keymap 149 | return nil 150 | end 151 | local function define(mode, command, keymap) 152 | print("define is deprecated, use define-minor-mode instead") 153 | return define_minor_mode(mode, "", {command = command, keymap = keymap}) 154 | end 155 | local exports = {["define-minor-mode"] = define_minor_mode, define = define, define_minor_mode = define_minor_mode, disable = disable, enable = enable, toggle = toggle} 156 | return trace_module(exports) 157 | --------------------------------------------------------------------------------