aboutsummaryrefslogtreecommitdiff
path: root/.config/emacs/lisp/evil-collection/modes/eat/evil-collection-eat.el
blob: b5a6262554c0104f9f0a2ccd8a63363975214a42 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
;;; evil-collection-eat.el --- Bindings for `eat' -*- lexical-binding: t -*-

;; Copyright (C) 2024 James Cherti

;; Maintainer: James Cherti <https://www.jamescherti.com/contact/>
;; Author: James Cherti <https://www.jamescherti.com/contact/>
;; Based on evil-collection-vterm.el by James Nguyen and Pierre Neidhardt
;; URL: https://github.com/emacs-evil/evil-collection
;; Version: 0.0.1
;; Package-Requires: ((emacs "26.3"))
;; Keywords: evil, eat, tools

;; This program 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 of the License, or
;; (at your option) any later version.

;; This program 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.

;; You should have received a copy of the GNU General Public License
;; along with this program.  If not, see <http://www.gnu.org/licenses/>.

;;; Commentary:
;; This package provides `evil-mode' keybindings for `eat'.

;;; Code:
(require 'evil-collection)
(require 'eat nil t)

(defconst evil-collection-eat-maps '(eat-mode-map
                                     eat-line-mode-map
                                     eat-semi-char-mode-map
                                     eat-char-mode-map
                                     eat-eshell-semi-char-mode-map
                                     eat-eshell-char-mode-map))

;; The map symbols below are only referenced inside quoted lists in this
;; file, so the byte-compiler does not actually require these declarations.
;; Defining them keeps certain linters happy.
(defvar eat-line-mode-map)
(defvar eat-semi-char-mode-map)
(defvar eat-char-mode-map)
(defvar eat-eshell-semi-char-mode-map)
(defvar eat-eshell-char-mode-map)

(defvar-local evil-collection-eat-send-escape-to-eat-p nil
  "Track whether or not we send ESC to `eat' or `emacs'.")

(defun evil-collection-eat-toggle-send-escape ()
  "Toggle the destination of the ESC key between `eat' and `emacs'.
This adjustment is necessary for programs that utilize ESC, such as Vim or an
SSH-accessed Emacs that also uses `evil-mode'."
  (interactive)
  (if evil-collection-eat-send-escape-to-eat-p
      (evil-collection-define-key 'insert 'eat-mode-map (kbd "<escape>")
        (lookup-key evil-insert-state-map (kbd "<escape>")))
    (evil-collection-define-key 'insert 'eat-mode-map
      (kbd "<escape>") 'eat-self-input))
  (setq evil-collection-eat-send-escape-to-eat-p
        (not evil-collection-eat-send-escape-to-eat-p))
  (message (format "Sending ESC to %s."
                   (if evil-collection-eat-send-escape-to-eat-p
                       "eat"
                     "emacs"))))

;;;###autoload
(defun evil-collection-eat-setup ()
  "Set up `evil' bindings for `eat'."
  (evil-set-initial-state 'eat-mode 'insert)

  (let* ((submit evil-collection-repl-submit-state)
         (newline-state (if (eq submit 'normal) 'insert 'normal)))
    (evil-collection-define-key submit 'eat-line-mode-map
      (kbd "RET") 'eat-line-send-input
      (kbd "\C-m") 'eat-line-send-input
      [return] 'eat-line-send-input)
    (evil-collection-define-key newline-state 'eat-line-mode-map
      (kbd "RET") #'newline
      (kbd "\C-m") #'newline
      [return] #'newline))

  (evil-collection-define-key '(normal insert) 'eat-mode-map
    (kbd "C-c C-z") 'evil-collection-eat-toggle-send-escape)

  ;; `Evil' has some "C-" bindings in insert state that shadow the `eat' terminal
  ;; bindings. Do not send "C-c" (prefix key) nor "C-h" (help prefix) as raw input.
  (evil-collection-define-key 'insert 'eat-mode-map
    (kbd "C-a") 'eat-self-input
    (kbd "C-b") 'eat-self-input
    (kbd "C-d") 'eat-self-input
    (kbd "C-e") 'eat-self-input
    (kbd "C-f") 'eat-self-input
    (kbd "C-k") 'eat-self-input
    (kbd "C-l") 'eat-self-input
    (kbd "C-n") 'eat-self-input
    (kbd "C-o") 'eat-self-input
    (kbd "C-p") 'eat-self-input
    (kbd "C-q") 'eat-self-input
    (kbd "C-r") 'eat-self-input
    (kbd "C-s") 'eat-self-input
    (kbd "C-t") 'eat-self-input
    (kbd "C-u") 'eat-self-input
    (kbd "C-v") 'eat-self-input
    (kbd "C-w") 'eat-self-input
    (kbd "C-y") 'eat-self-input
    (kbd "C-z") 'eat-self-input
    (kbd "<delete>") 'eat-self-input)

  ;; Paste bindings: in a terminal, "paste before/after" is meaningless because
  ;; the cursor position is controlled by the running program. Bind both `p'
  ;; and `P' to `eat-yank' so the kill-ring is sent as terminal input.
  (dolist (map '(eat-semi-char-mode-map
                 eat-char-mode-map
                 eat-eshell-semi-char-mode-map
                 eat-eshell-char-mode-map))
    (evil-collection-define-key 'normal map
      (kbd "p") 'eat-yank
      (kbd "P") 'eat-yank)))

(provide 'evil-collection-eat)
;;; evil-collection-eat.el ends here