-
Notifications
You must be signed in to change notification settings - Fork 14
/
Copy pathparrot.el
237 lines (197 loc) · 8.75 KB
/
parrot.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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
;;; parrot.el --- Party Parrot rotates gracefully in mode-line. -*- lexical-binding: t; -*-
;; Author: Daniel Ting <deep.paren.12@gmail.com>
;; URL: https://github.com/dp12/parrot.git
;; Version: 1.1.1
;; Package-Requires: ((emacs "24.1"))
;; Keywords: party, parrot, rotate, sirocco, kakapo, games
;; 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:
;;
;; A minor mode for displaying party parrot in the modeline and rotating words.
;;
;; To load this file, add (require 'parrot) to your init file. You can display
;; the party parrot in your modeline by adding (parrot-mode).
;;
;; To get the parrot to rotate on new email messages in mu4e, add:
;; (add-hook 'mu4e-index-updated-hook #'parrot-start-animation)
;;
;; This animation code is a heavily modified version of Jacek "TeMPOraL"
;; Zlydach's famous nyan-mode. Check out his original work at
;; https://github.com/TeMPOraL/nyan-mode/.
;;
;; Please see README.md for more documentation, or read it online at
;; https://github.com/dp12/parrot
;;; Code:
(require 'parrot-rotate)
(defconst parrot-directory (file-name-directory (or load-file-name buffer-file-name)))
(defconst parrot-modeline-help-string "mouse-1: Rotate with parrot!")
;; ('v') (*'v') ('V'*) ('v'*)
;; ('v') ('V') ('>') ('^') ('<') ('V') ('v')
(defgroup parrot nil
"Customization group for `parrot-mode'."
:group 'frames)
(defun parrot-refresh ()
"Refresh after option change if loaded."
(when (featurep 'parrot)
(when (bound-and-true-p parrot-mode)
(force-mode-line-update))))
(defcustom parrot-animation-frame-interval 0.045
"Number of seconds between animation frames."
:type 'float
:set (lambda (sym val)
(set-default sym val)
(parrot-refresh)))
(defcustom parrot-click-hook nil
"Hook run after clicking on the parrot."
:type 'hook)
(defvar parrot-animation-timer nil
"Internal timer used for switching animation frames.")
(defvar parrot-rotations 0
"Counter of how many times the parrot has rotated.")
(defun parrot-start-animation ()
"Start the parrot animation."
(interactive)
(setq parrot-rotations 0)
(when (not (and parrot-animate-parrot
parrot-animation-timer))
(setq parrot-animation-timer (run-at-time nil
parrot-animation-frame-interval
#'parrot-switch-anim-frame))
(setq parrot-animate-parrot t)))
(defun parrot-stop-animation ()
"Stop the parrot animation."
(interactive)
(when (and parrot-animate-parrot
parrot-animation-timer)
(cancel-timer parrot-animation-timer)
(setq parrot-animation-timer nil)
(setq parrot-animate-parrot nil)))
(defcustom parrot-minimum-window-width 45
"Determines the minimum width of the window, below which party parrot will not be displayed."
:type 'integer
:set (lambda (sym val)
(set-default sym val)
(parrot-refresh)))
(defcustom parrot-animate-parrot nil
"If non-nil, parrot animation is enabled."
:type '(choice (const :tag "Enabled" t)
(const :tag "Disabled" nil))
:set (lambda (sym val)
(set-default sym val)
(if val
(parrot-start-animation)
(parrot-stop-animation))
(parrot-refresh)))
(defcustom parrot-spaces-before 0
"Spaces of padding before parrot in mode line."
:type 'integer
:set (lambda (sym val)
(set-default sym val)
(parrot-refresh)))
(defcustom parrot-spaces-after 0
"Spaces of padding after parrot in the mode line."
:type 'integer
:set (lambda (sym val)
(set-default sym val)
(parrot-refresh)))
(defcustom parrot-num-rotations 3
"How many times party parrot will rotate."
:type 'integer)
(defvar parrot-frame-list (number-sequence 1 10)
"List of indices for the parrot animation frames.
For example, an animation with a total of ten frames would have a
`parrot-frame-list` of (1 2 3 4 5 6 7 8 9 10)")
(defvar parrot-type nil
"The type of parrot selected, e.g. default or science.")
(defvar parrot-static-image nil
"The image shown when parrot is at rest, i.e. not rotating.")
(defvar parrot-animation-frames nil
"A list of the animation frames for the current parrot.")
(defun parrot-create-frame (parrot id)
"Create image for frame with parrot type PARROT and frame id ID."
(create-image (concat parrot-directory
(format "img/%s/%s-parrot-frame-%d.xpm" parrot parrot id)) 'xpm nil :ascent 'center))
(defun parrot-load-frames (parrot)
"Load the images for the selected PARROT."
(when (image-type-available-p 'xpm)
(setq parrot-static-image (parrot-create-frame parrot 1))
(setq parrot-animation-frames (mapcar (lambda (id)
(parrot-create-frame parrot id))
parrot-frame-list))))
(defun parrot-sequence-length (parrot)
"Return length of the animation sequence for PARROT."
(cond ((string= parrot "default") 10)
((string= parrot "confused") 26)
((string= parrot "emacs") 10)
((string= parrot "nyan") 10)
((string= parrot "rotating") 13)
((string= parrot "science") 10)
((string= parrot "thumbsup") 12)
(t (error (format "Invalid parrot %s" parrot)))))
(defun parrot-set-parrot-type (parrot &optional silent)
"Set the desired PARROT type in the mode line."
(interactive (list (completing-read "Select parrot: "
'(default confused emacs nyan rotating science thumbsup) nil t)))
(setq parrot-frame-list (number-sequence 1 (parrot-sequence-length parrot)))
(setq parrot-type parrot)
(parrot-load-frames parrot)
(unless silent
(run-at-time "0.5 seconds" nil #'parrot-start-animation)
(message (format "%s parrot selected" parrot))))
(defvar parrot-current-frame 0)
(defun parrot-switch-anim-frame ()
"Change to the next frame in the parrot animation.
If the parrot has already rotated for `parrot-num-rotations', the animation will
stop."
(setq parrot-current-frame (% (+ 1 parrot-current-frame) (car (last parrot-frame-list))))
(when (eq parrot-current-frame 0)
(setq parrot-rotations (+ 1 parrot-rotations))
(when (and parrot-num-rotations (>= parrot-rotations parrot-num-rotations))
(parrot-stop-animation)))
(force-mode-line-update))
(defun parrot-get-anim-frame ()
"Get the current animation frame."
(if parrot-animate-parrot
(nth parrot-current-frame parrot-animation-frames)
parrot-static-image))
(defun parrot-add-click-handler (string)
"Add a handler to STRING for animating the parrot when it is clicked."
(propertize string 'keymap `(keymap (mode-line keymap (down-mouse-1 . ,(lambda () (interactive)
(parrot-start-animation)
(run-hooks 'parrot-click-hook)))))))
(defun parrot-create ()
"Generate the party parrot string."
(if (< (window-width) parrot-minimum-window-width)
"" ; disabled for too small windows
(let ((parrot-string (make-string parrot-spaces-before ?\s)))
(setq parrot-string (concat parrot-string (parrot-add-click-handler
(propertize "-" 'display (parrot-get-anim-frame)))
(make-string parrot-spaces-after ?\s)))
(propertize parrot-string 'help-echo parrot-modeline-help-string))))
(defvar parrot-old-cdr-mode-line-position nil)
;;;###autoload
(define-minor-mode parrot-mode
"Use Parrot to show when you're rotating.
You can customize this minor mode, see option `parrot-mode'."
:global t
:require 'parrot
(if parrot-mode
(progn
(unless parrot-type (parrot-set-parrot-type 'default))
(unless parrot-old-cdr-mode-line-position
(setq parrot-old-cdr-mode-line-position (cdr mode-line-position)))
(setcdr mode-line-position (cons '(:eval (list (parrot-create)))
(cdr parrot-old-cdr-mode-line-position))))
(setcdr mode-line-position parrot-old-cdr-mode-line-position)))
(provide 'parrot)
;;; parrot.el ends here