337 lines
13 KiB
EmacsLisp
337 lines
13 KiB
EmacsLisp
;;; evil-collection-mu4e.el --- Evil bindings for mu4e -*- lexical-binding: t -*-
|
|
|
|
;; Copyright (C) 2015-2018 Joris Engbers
|
|
;; Copyright (C) 2018 Pierre Neidhardt <mail@ambrevar.xyz>
|
|
|
|
;; Author: Joris Engbers <info@jorisengbers.nl>
|
|
;; Maintainer: James Nguyen <james@jojojames.com>
|
|
;; Pierre Neidhardt <mail@ambrevar.xyz>
|
|
;; URL: https://github.com/emacs-evil/evil-collection
|
|
;; Version: 0.0.9
|
|
;; Package-Requires: ((emacs "24.4") (evil "1.2.10"))
|
|
;; Keywords: evil, mu4e, tools
|
|
|
|
;; This file is free software; you can redistribute it and/or modify
|
|
;; it under the terms of the GNU General Public License as published
|
|
;; by the Free Software Foundation; either version 3, or (at your
|
|
;; option) any later version.
|
|
;;
|
|
;; This file is distributed in the hope that it will be useful,
|
|
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
;; GNU General Public License for more details.
|
|
;;
|
|
;; For a full copy of the GNU General Public License
|
|
;; see <http://www.gnu.org/licenses/>.
|
|
|
|
;;; Commentary:
|
|
;; Evil keybindings for mu4e that make sense for Evil users. The following
|
|
;; keybindings are defined:
|
|
;;
|
|
;; General commands:
|
|
;; | Commmand | evil-mu4e | Alternative |
|
|
;; |--------------------------+-----------+-------------|
|
|
;; | Jump to maildir | J | |
|
|
;; | Update | u | |
|
|
;; | Compose message | cc | C |
|
|
;; | Kill update mail process | x | |
|
|
|
|
;; Commands for header-mode and view-mode:
|
|
;; | Command | evil-mu4e | Alternative |
|
|
;; |---------------------------------+-----------+-------------|
|
|
;; | Next message | C-j | |
|
|
;; | Previous message | C-k | |
|
|
;; | Mark the current thread as read | T | |
|
|
;; | Compose message | cc | C |
|
|
;; | Compose edit** | ce | E |
|
|
;; | Compose forward** | cf | F |
|
|
;; | Compose reply | cr | R |
|
|
;; | Change sorting*** | o | O |
|
|
;; | Rerun search | gr | |
|
|
;; | Toggle include related | zr | |
|
|
;; | Toggle threading | zt | |
|
|
;; | Toggle hide cited | za | |
|
|
;; | Skip duplicates | zd | |
|
|
;; | Show log | gl | |
|
|
;; | Select other view | gv | |
|
|
;; | Save attachement(s) | p | |
|
|
;; | Save url | yu | |
|
|
;; | Go to url | gx | |
|
|
;; | Fetch url | gX | |
|
|
;;
|
|
;; - * denotes only in header-mode
|
|
;; - ** denotes Alternative only in header-mode
|
|
;; - *** denotes Alternative only in view-mode
|
|
;;
|
|
;;; Code:
|
|
|
|
(require 'evil-collection)
|
|
(require 'mu4e nil t)
|
|
|
|
(defvar mu4e-mu-version)
|
|
(declare-function evil-collection-mu4e-set-bindings "evil-collection-mu4e")
|
|
(declare-function evil-collection-mu4e-set-state "evil-collection-mu4e")
|
|
(declare-function mu4e-headers-mark-thread "mu4e-headers")
|
|
|
|
(if (version< mu4e-mu-version "1.10")
|
|
(require 'evil-collection-mu4e
|
|
(expand-file-name "modes/mu4e/evil-collection-mu4e-1.8" evil-collection-base-dir))
|
|
|
|
|
|
(defconst evil-collection-mu4e-maps '(mu4e-main-mode-map
|
|
mu4e-headers-mode-map
|
|
mu4e-view-mode-map
|
|
mu4e-compose-mode-map
|
|
mu4e-search-minor-mode-map
|
|
mu4e-thread-mode-map))
|
|
|
|
(defun evil-collection-mu4e-set-state ()
|
|
"Set the appropriate initial state of all mu4e modes."
|
|
(dolist (mode '(mu4e-main-mode
|
|
mu4e-headers-mode
|
|
mu4e-view-mode
|
|
mu4e-org-mode))
|
|
(evil-set-initial-state mode 'normal))
|
|
(evil-set-initial-state 'mu4e-compose-mode 'insert))
|
|
|
|
;; These functions were removed from mu4e 1.12.0, specifically this commit:
|
|
;; https://github.com/djcb/mu/commit/85bfe763362b95935a3967f6585e14b3f9890a70
|
|
(when (version<= "1.12.0" mu4e-mu-version)
|
|
(defun mu4e-compose-goto-top ()
|
|
"Go to the beginning of the message or buffer.
|
|
Go to the beginning of the message or, if already there, go to the
|
|
beginning of the buffer."
|
|
(interactive)
|
|
(let ((old-position (point)))
|
|
(message-goto-body)
|
|
(when (= (point) old-position)
|
|
(goto-char (point-min)))))
|
|
|
|
(defun mu4e-compose-goto-bottom ()
|
|
"Go to the end of the message or buffer.
|
|
Go to the end of the message (before signature) or, if already there, go to the
|
|
end of the buffer."
|
|
(interactive)
|
|
(let ((old-position (point))
|
|
(message-position (save-excursion (message-goto-body) (point))))
|
|
(goto-char (point-max))
|
|
(when (re-search-backward message-signature-separator message-position t)
|
|
(forward-line -1))
|
|
(when (= (point) old-position)
|
|
(goto-char (point-max))))))
|
|
|
|
;; When using org-mu4e, the above leads to an annoying behaviour, because
|
|
;; switching from message body to header activates mu4e-compose-mode, thus
|
|
;; putting the user into insert-state. The below code, together with the hooks
|
|
;; set in evil-collection-mu4e-setup fixes this issue.
|
|
(defun evil-collection-mu4e-org-set-header-to-normal-mode ()
|
|
"Set initial state in `mu4e-compose-mode' to \='normal."
|
|
(evil-set-initial-state 'mu4e-compose-mode 'normal))
|
|
|
|
(defun evil-collection-mu4e-org-set-header-to-insert-mode ()
|
|
"Set initial state in `mu4e-compose-mode' to \='insert."
|
|
(evil-set-initial-state 'mu4e-compose-mode 'insert))
|
|
|
|
(defun evil-collection-mu4e-mark-thread-as-read ()
|
|
(interactive)
|
|
(mu4e-headers-mark-thread nil '(read)))
|
|
|
|
(defvar evil-collection-mu4e-mode-normal-map-bindings
|
|
`((mu4e-main-mode-map
|
|
"J" mu4e~headers-jump-to-maildir
|
|
"j" next-line
|
|
"k" previous-line
|
|
"u" mu4e-update-mail-and-index
|
|
"gr" revert-buffer
|
|
"b" mu4e-search-bookmark
|
|
"B" mu4e-search-bookmark-edit
|
|
"N" mu4e-news
|
|
";" mu4e-context-switch
|
|
"H" mu4e-display-manual
|
|
"C" mu4e-compose-new
|
|
"cc" mu4e-compose-new
|
|
"x" mu4e-kill-update-mail
|
|
"A" mu4e-about
|
|
"f" smtpmail-send-queued-mail
|
|
"m" mu4e--main-toggle-mail-sending-mode
|
|
"s" mu4e-search
|
|
"q" mu4e-quit)
|
|
|
|
(mu4e-headers-mode-map
|
|
"q" mu4e~headers-quit-buffer
|
|
"J" mu4e~headers-jump-to-maildir
|
|
"C" mu4e-compose-new
|
|
"E" mu4e-compose-edit
|
|
"F" mu4e-compose-forward
|
|
"R" mu4e-compose-reply
|
|
"cc" mu4e-compose-new
|
|
"ce" mu4e-compose-edit
|
|
"cf" mu4e-compose-forward
|
|
"cr" mu4e-compose-reply
|
|
"o" mu4e-headers-change-sorting
|
|
"j" mu4e-headers-next
|
|
"k" mu4e-headers-prev
|
|
"gr" mu4e-search-rerun
|
|
"b" mu4e-search-bookmark
|
|
"B" mu4e-search-bookmark-edit
|
|
";" mu4e-context-switch
|
|
,(kbd "RET") mu4e-headers-view-message
|
|
"/" mu4e-search-narrow
|
|
"s" mu4e-search
|
|
"S" mu4e-search-edit
|
|
"x" mu4e-mark-execute-all
|
|
"a" mu4e-headers-action
|
|
"*" mu4e-headers-mark-for-something ; TODO: Don't override evil-seach-word-forward?
|
|
"&" mu4e-headers-mark-custom
|
|
"A" mu4e-headers-mark-for-action
|
|
"m" mu4e-headers-mark-for-move
|
|
"r" mu4e-headers-mark-for-refile
|
|
"D" mu4e-headers-mark-for-delete
|
|
"d" mu4e-headers-mark-for-trash
|
|
"=" mu4e-headers-mark-for-untrash
|
|
"u" mu4e-headers-mark-for-unmark
|
|
"U" mu4e-mark-unmark-all
|
|
"?" mu4e-headers-mark-for-unread
|
|
"!" mu4e-headers-mark-for-read
|
|
"%" mu4e-headers-mark-pattern
|
|
"+" mu4e-headers-mark-for-flag
|
|
"-" mu4e-headers-mark-for-unflag
|
|
"[[" mu4e-headers-prev-unread
|
|
"]]" mu4e-headers-next-unread
|
|
"}" mu4e-headers-next-thread
|
|
"{" mu4e-headers-prev-thread
|
|
"gk" mu4e-headers-prev-unread
|
|
"gj" mu4e-headers-next-unread
|
|
"\C-j" mu4e-headers-next
|
|
"\C-k" mu4e-headers-prev
|
|
"t" mu4e-headers-toggle-property
|
|
"zr" mu4e-headers-toggle-include-related
|
|
"zt" mu4e-headers-toggle-threading
|
|
"zd" mu4e-headers-toggle-skip-duplicates
|
|
"gl" mu4e-show-log
|
|
"gv" mu4e-select-other-view
|
|
"T" evil-collection-mu4e-mark-thread-as-read)
|
|
|
|
(mu4e-compose-mode-map
|
|
"gg" mu4e-compose-goto-top
|
|
"G" mu4e-compose-goto-bottom
|
|
"ZD" message-dont-send
|
|
"ZF" mml-attach-file
|
|
"ZQ" mu4e-message-kill-buffer
|
|
"ZZ" message-send-and-exit)
|
|
|
|
(mu4e-search-minor-mode-map
|
|
"J" mu4e-search-maildir)
|
|
|
|
(mu4e-thread-mode-map
|
|
[S-left] mu4e-thread-goto-root
|
|
[tab] mu4e-thread-fold-toggle
|
|
[C-tab] mu4e-thread-fold-toggle-goto-next
|
|
[backtab] mu4e-thread-fold-toggle-all)
|
|
|
|
(mu4e-view-mode-map
|
|
" " mu4e-view-scroll-up-or-next
|
|
[tab] shr-next-link
|
|
[backtab] shr-previous-link
|
|
"q" mu4e-view-quit
|
|
"gx" mu4e-view-go-to-url
|
|
"gX" mu4e-view-fetch-url
|
|
"C" mu4e-compose-new
|
|
"H" mu4e-view-toggle-html
|
|
;; "E" mu4e-compose-edit
|
|
;; "F" mu4e-compose-forward
|
|
"R" mu4e-compose-reply
|
|
"cc" mu4e-compose-new
|
|
"ce" mu4e-compose-edit
|
|
"cf" mu4e-compose-forward
|
|
"cr" mu4e-compose-reply
|
|
"p" mu4e-view-save-attachments
|
|
"O" mu4e-headers-change-sorting
|
|
"A" mu4e-view-mime-part-action ; Since 1.6, uses gnus view by default
|
|
"a" mu4e-view-action
|
|
"J" mu4e~headers-jump-to-maildir
|
|
"[[" mu4e-view-headers-prev-unread
|
|
"]]" mu4e-view-headers-next-unread
|
|
"gk" mu4e-view-headers-prev-unread
|
|
"gj" mu4e-view-headers-next-unread
|
|
"\C-j" mu4e-view-headers-next
|
|
"\C-k" mu4e-view-headers-prev
|
|
"x" mu4e-view-marked-execute
|
|
"&" mu4e-view-mark-custom
|
|
"*" mu4e-view-mark-for-something ; TODO: Don't override "*".
|
|
"m" mu4e-view-mark-for-move
|
|
"r" mu4e-view-mark-for-refile
|
|
"D" mu4e-view-mark-for-delete
|
|
"d" mu4e-view-mark-for-trash
|
|
"=" mu4e-view-mark-for-untrash
|
|
"u" mu4e-view-unmark
|
|
"U" mu4e-view-unmark-all
|
|
"?" mu4e-view-mark-for-unread
|
|
"!" mu4e-view-mark-for-read
|
|
"%" mu4e-view-mark-pattern
|
|
"+" mu4e-view-mark-for-flag
|
|
"-" mu4e-view-mark-for-unflag
|
|
"zr" mu4e-headers-toggle-include-related
|
|
"zt" mu4e-headers-toggle-threading
|
|
"za" mu4e-view-toggle-hide-cited
|
|
"gl" mu4e-show-log
|
|
"s" mu4e-view-search-edit
|
|
"|" mu4e-view-pipe
|
|
"." mu4e-view-raw-message
|
|
,(kbd "C--") mu4e-headers-split-view-shrink
|
|
,(kbd "C-+") mu4e-headers-split-view-grow
|
|
,@(when evil-want-C-u-scroll
|
|
'("\C-u" evil-scroll-up))))
|
|
"All evil-mu4e bindings for evil normal mode.")
|
|
|
|
(defvar evil-collection-mu4e-mode-visual-map-bindings
|
|
`((mu4e-headers-mode-map
|
|
"*" mu4e-headers-mark-for-something
|
|
"A" mu4e-headers-mark-for-action
|
|
"m" mu4e-headers-mark-for-move
|
|
"r" mu4e-headers-mark-for-refile
|
|
"D" mu4e-headers-mark-for-delete
|
|
"d" mu4e-headers-mark-for-trash
|
|
"=" mu4e-headers-mark-for-untrash
|
|
"u" mu4e-headers-mark-for-unmark
|
|
"?" mu4e-headers-mark-for-unread
|
|
"!" mu4e-headers-mark-for-read
|
|
"+" mu4e-headers-mark-for-flag
|
|
"-" mu4e-headers-mark-for-unflag)
|
|
|
|
(mu4e-compose-mode-map
|
|
"gg" 'mu4e-compose-goto-top
|
|
"G" 'mu4e-compose-goto-bottom))
|
|
"All evil-mu4e bindings for evil visual mode.")
|
|
|
|
(defun evil-collection-mu4e-set-bindings ()
|
|
"Set the bindings."
|
|
;; WARNING: With lexical binding, lambdas from `mapc' and `dolist' become
|
|
;; closures in which we must use `evil-define-key*' instead of
|
|
;; `evil-define-key'.
|
|
(dolist (binding evil-collection-mu4e-mode-normal-map-bindings)
|
|
(apply #'evil-collection-define-key 'normal binding))
|
|
(dolist (binding evil-collection-mu4e-mode-visual-map-bindings)
|
|
(apply #'evil-collection-define-key 'visual binding))
|
|
(evil-set-command-property 'mu4e-compose-goto-bottom :keep-visual t)
|
|
(evil-set-command-property 'mu4e-compose-goto-top :keep-visual t)
|
|
|
|
;; yu
|
|
(evil-collection-define-operator-key 'yank 'mu4e-view-mode-map
|
|
"u" 'mu4e-view-save-url))
|
|
|
|
|
|
|
|
|
|
(defun evil-collection-mu4e-setup ()
|
|
"Initialize evil-mu4e if necessary.
|
|
If `mu4e-main-mode' is in `evil-state-motion-modes', initialization
|
|
is already done earlier."
|
|
(evil-collection-mu4e-set-state)
|
|
(evil-collection-mu4e-set-bindings))
|
|
|
|
(add-hook 'mu4e-thread-mode-hook #'evil-normalize-keymaps)
|
|
|
|
(provide 'evil-collection-mu4e))
|
|
;;; evil-collection-mu4e.el ends here
|