-
Notifications
You must be signed in to change notification settings - Fork 102
/
Copy pathalchemist-refcard.el
190 lines (163 loc) · 9.97 KB
/
alchemist-refcard.el
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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
;;; alchemist-refcard.el --- Generates a refcard of alchemist functionality
;; Copyright © 2015 Samuel Tonini
;; Author: Samuel Tonini <[email protected]
;; This file is not part of GNU Emacs.
;; 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:
;; Generates a refcard of alchemist functionality
;;; Code:
(require 'cl-lib)
(require 'dash)
(require 'tabulated-list)
;; Tell the byte compiler about autoloaded functions from packages
(eval-when-compile
(declare-function alchemist-mode "alchemist.el")
(declare-function alchemist-version "alchemist.el"))
(defgroup alchemist-refcard nil
"Generate a refcard of alchemist functionality."
:prefix "alchemist-"
:group 'applications)
(defconst alchemist-refcard--buffer-name "*alchemist-refcard*"
"Name of Alchemist-Refcard mode buffer.")
(defconst alchemist-refcard-list-format
[("" 55 t)
("" 35 t)]
"List format.")
(defvar alchemist-refcard-mode-map
(let ((map (make-sparse-keymap)))
(define-key map (kbd "i") 'alchemist-refcard--describe-funtion-at-point)
(define-key map (kbd "q") 'quit-window)
map)
"Keymap for `alchemist-refcard-mode'.")
(defun alchemist-refcard--get-keybinding (function-name)
(let* ((keys (where-is-internal (intern function-name)))
(keys (-map (lambda (k)
(let ((key (format "%s" k)))
(if (string-match-p "menu-bar" key)
nil
k))) keys))
(keys (-remove 'null keys)))
(if keys
(progn
(mapconcat (lambda (k) (key-description k)) keys " , "))
"")))
(defun alchemist-refcard--tabulated-list-entries ()
(alchemist-mode +1) ;; needs to be enabled for fetching current keybindings
(let ((rows (list (alchemist-refcard--build-empty-tabulated-row)
(alchemist-refcard--build-tabulated-refcard-title-row (format "Alchemist Refcard v%s" (alchemist-version)))
(alchemist-refcard--build-empty-tabulated-row)
(alchemist-refcard--build-tabulated-title-row "Mix")
(alchemist-refcard--build-tabulated-row "alchemist-mix")
(alchemist-refcard--build-tabulated-row "alchemist-mix-compile")
(alchemist-refcard--build-tabulated-row "alchemist-mix-run")
(alchemist-refcard--build-empty-tabulated-row)
(alchemist-refcard--build-tabulated-title-row "Testing")
(alchemist-refcard--build-tabulated-row "alchemist-mix-test")
(alchemist-refcard--build-tabulated-row "alchemist-mix-rerun-last-test")
(alchemist-refcard--build-tabulated-row "alchemist-mix-test-file")
(alchemist-refcard--build-tabulated-row "alchemist-mix-test-this-buffer")
(alchemist-refcard--build-tabulated-row "alchemist-mix-test-at-point")
(alchemist-refcard--build-tabulated-row "alchemist-test-toggle-test-report-display")
(alchemist-refcard--build-empty-tabulated-row)
(alchemist-refcard--build-tabulated-title-row "Compilation")
(alchemist-refcard--build-tabulated-row "alchemist-compile")
(alchemist-refcard--build-tabulated-row "alchemist-compile-file")
(alchemist-refcard--build-tabulated-row "alchemist-compile-this-buffer")
(alchemist-refcard--build-empty-tabulated-row)
(alchemist-refcard--build-tabulated-title-row "Execution")
(alchemist-refcard--build-tabulated-row "alchemist-execute")
(alchemist-refcard--build-tabulated-row "alchemist-execute-file")
(alchemist-refcard--build-tabulated-row "alchemist-execute-this-buffer")
(alchemist-refcard--build-empty-tabulated-row)
(alchemist-refcard--build-tabulated-title-row "Documentation Lookup")
(alchemist-refcard--build-tabulated-row "alchemist-help")
(alchemist-refcard--build-tabulated-row "alchemist-help-history")
(alchemist-refcard--build-tabulated-row "alchemist-help-search-at-point")
(alchemist-refcard--build-tabulated-row "alchemist-refcard")
(alchemist-refcard--build-empty-tabulated-row)
(alchemist-refcard--build-tabulated-title-row "Definition Lookup")
(alchemist-refcard--build-tabulated-row "alchemist-goto-definition-at-point")
(alchemist-refcard--build-tabulated-row "alchemist-goto-jump-back")
(alchemist-refcard--build-tabulated-row "alchemist-goto-jump-to-previous-def-symbol")
(alchemist-refcard--build-tabulated-row "alchemist-goto-jump-to-next-def-symbol")
(alchemist-refcard--build-tabulated-row "alchemist-goto-list-symbol-definitions")
(alchemist-refcard--build-empty-tabulated-row)
(alchemist-refcard--build-tabulated-title-row "Project")
(alchemist-refcard--build-tabulated-row "alchemist-project-find-test")
(alchemist-refcard--build-tabulated-row "alchemist-project-toggle-file-and-tests")
(alchemist-refcard--build-tabulated-row "alchemist-project-toggle-file-and-tests-other-window")
(alchemist-refcard--build-tabulated-row "alchemist-project-run-tests-for-current-file")
(alchemist-refcard--build-empty-tabulated-row)
(alchemist-refcard--build-tabulated-title-row "IEx")
(alchemist-refcard--build-tabulated-row "alchemist-iex-run")
(alchemist-refcard--build-tabulated-row "alchemist-iex-project-run")
(alchemist-refcard--build-tabulated-row "alchemist-iex-send-current-line")
(alchemist-refcard--build-tabulated-row "alchemist-iex-send-current-line-and-go")
(alchemist-refcard--build-tabulated-row "alchemist-iex-send-region")
(alchemist-refcard--build-tabulated-row "alchemist-iex-send-region-and-go")
(alchemist-refcard--build-tabulated-row "alchemist-iex-compile-this-buffer")
(alchemist-refcard--build-empty-tabulated-row)
(alchemist-refcard--build-tabulated-title-row "Eval")
(alchemist-refcard--build-tabulated-row "alchemist-eval-current-line")
(alchemist-refcard--build-tabulated-row "alchemist-eval-print-current-line")
(alchemist-refcard--build-tabulated-row "alchemist-eval-quoted-current-line")
(alchemist-refcard--build-tabulated-row "alchemist-eval-print-quoted-current-line")
(alchemist-refcard--build-tabulated-row "alchemist-eval-region")
(alchemist-refcard--build-tabulated-row "alchemist-eval-print-region")
(alchemist-refcard--build-tabulated-row "alchemist-eval-quoted-region")
(alchemist-refcard--build-tabulated-row "alchemist-eval-print-quoted-region")
(alchemist-refcard--build-tabulated-row "alchemist-eval-buffer")
(alchemist-refcard--build-tabulated-row "alchemist-eval-print-buffer")
(alchemist-refcard--build-tabulated-row "alchemist-eval-quoted-buffer")
(alchemist-refcard--build-tabulated-row "alchemist-eval-print-quoted-buffer")
(alchemist-refcard--build-tabulated-row "alchemist-eval-close-popup"))))
(alchemist-mode -1) ;; disable it after getting the current keybindings
rows))
(defun alchemist-refcard--build-empty-tabulated-row ()
(list "" `[,"" ""]))
(defun alchemist-refcard--build-tabulated-row (function-name)
(list function-name `[,function-name
,(propertize (alchemist-refcard--get-keybinding function-name) 'face font-lock-builtin-face)]))
(defun alchemist-refcard--build-tabulated-refcard-title-row (title)
(list "" `[,(propertize title 'face font-lock-variable-name-face) ""]))
(defun alchemist-refcard--build-tabulated-title-row (title)
(list "" `[,(propertize title 'face font-lock-constant-face) ""]))
(defun alchemist-refcard--describe-funtion-at-point ()
(interactive)
(let ((function-name (get-text-property (point) 'tabulated-list-id)))
(when (not (alchemist-utils--empty-string-p function-name))
(describe-function (intern function-name)))))
(defun alchemist-refcard--buffer ()
"Return alchemist-refcard buffer if it exists."
(get-buffer alchemist-refcard--buffer-name))
(define-derived-mode alchemist-refcard-mode tabulated-list-mode "Alchemist"
"Alchemist refcard mode."
(buffer-disable-undo)
(kill-all-local-variables)
(setq truncate-lines t)
(setq mode-name "Alchemist-Refcard")
(setq-local alchemist-test-status-modeline nil)
(use-local-map alchemist-refcard-mode-map)
(setq tabulated-list-format alchemist-refcard-list-format)
(setq tabulated-list-entries 'alchemist-refcard--tabulated-list-entries)
(tabulated-list-print))
;;;###autoload
(defun alchemist-refcard ()
"Generate an Alchemist refcard of all the features."
(interactive)
(let ((buffer-p (alchemist-refcard--buffer))
(buffer (get-buffer-create alchemist-refcard--buffer-name)))
(pop-to-buffer buffer)
(unless buffer-p
(alchemist-refcard-mode))))
(provide 'alchemist-refcard)
;;; alchemist-refcard.el ends here