forked from rubikitch/viewer
-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
viewer.el
383 lines (336 loc) · 12.9 KB
/
viewer.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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
;;; viewer.el --- View-mode extension
;; Copyright (C) 2009,2014,2016 rubikitch
;; Author: rubikitch <rubikitch@ruby-lang.org>
;; Keywords: view, extensions
;; URL: http://github.com/rubikitch/viewer/
;; 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 2, 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.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING. If not, write to
;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
;;; Commentary:
;; Viewer is view-mode extension. View-mode is finger-friendly than
;; normal editing because of many alphabetical commands. Let's use
;; view-mode more to protect our pinky.
;;; Commands:
;;
;; Below are complete command list:
;;
;;
;;; Customizable Options:
;;
;; Below are customizable option list:
;;
;; `view-mode-by-default-regexp'
;; *Regexp of file name to open by `view-mode'.
;; default = nil
;; `viewer-aggressive-minimum-size'
;; *Minimum file size to enable aggressive view-mode.
;; default = 100
;; `viewer-aggressive-writable'
;; *When non-nil, aggressive view-mode buffer is writable.
;; default = t
;; `viewer-modeline-color-unwritable'
;; *Modeline color when file is not writable.
;; default = "tomato"
;; `viewer-modeline-color-view'
;; *Modeline color for `view-mode'.
;; default = "orange"
;; This package provides:
;; * specify files to open by `view-mode' by default.
;; * stay in `view-mode' in unwritable files.
;; * indicate `view-mode' by modeline color.
;; * override default `view-mode-map' for major modes.
;; * open ANY files by `view-mode' for enthusiasts.
;;; Installation:
;; Put viewer.el to your load-path.
;; The load-path is usually ~/elisp/.
;; It's set in your ~/.emacs like this:
;; (add-to-list 'load-path (expand-file-name "~/elisp"))
;;
;; And the following to your ~/.emacs startup file.
;;
;; (require 'viewer)
;; (viewer-stay-in-setup)
;; (setq viewer-modeline-color-unwritable "tomato"
;; viewer-modeline-color-view "orange")
;; (viewer-change-modeline-color-setup)
;;
;; If you want to open any file by `view-mode', add the following:
;; (viewer-aggressive-setup 'force)
;;
;; Note that the command `view-mode' should be bound in easy-to-type
;; key.
;;
;; If you want to open any file matching a regexp, add the following:
;; (setq view-mode-by-default-regexp "/regexp-to-path")
;;
;; No need more.
;;; Customize:
;;
;; All of the above can customize by:
;; M-x customize-group RET viewer RET
;;
;;; Tips:
;; Defining major-mode specific `view-mode' is useful.
;; See `define-overriding-view-mode-map'.
;;
;; [EVAL IT] (describe-function 'define-overriding-view-mode-map)
;;; Bug Report:
;;
;; If you have problem, send a bug report via M-x viewer-send-bug-report.
;; The step is:
;; 0) Setup mail in Emacs, the easiest way is:
;; (setq user-mail-address "your@mail.address")
;; (setq user-full-name "Your Full Name")
;; (setq smtpmail-smtp-server "your.smtp.server.jp")
;; (setq mail-user-agent 'message-user-agent)
;; (setq message-send-mail-function 'message-smtpmail-send-it)
;; 1) Be sure to use the LATEST version of viewer.el.
;; 2) Enable debugger. M-x toggle-debug-on-error or (setq debug-on-error t)
;; 3) Use Lisp version instead of compiled one: (load "viewer.el")
;; 4) Do it!
;; 5) If you got an error, please do not close *Backtrace* buffer.
;; 6) M-x viewer-send-bug-report and M-x insert-buffer *Backtrace*
;; 7) Describe the bug using a precise recipe.
;; 8) Type C-c C-c to send.
;; # If you are a Japanese, please write in Japanese:-)
;;; History:
;; $Log: viewer.el,v $
;; Revision 1.13 2013/03/14 23:37:05 rubikitch
;; Rename obsolete face name: modeline -> mode-line
;;
;; Revision 1.12 2012/12/31 11:38:16 rubikitch
;; viewer-change-modeline-color: fix advice of select-window
;;
;; Revision 1.11 2012/06/25 10:19:18 rubikitch
;; Bugfix: error when edebug.el is not loaded.
;;
;; Revision 1.10 2012/06/19 15:27:53 rubikitch
;; You can exit view-mode if `edebug-active' is non-nil.
;;
;; Revision 1.9 2012/06/12 01:05:53 rubikitch
;; erase warning
;;
;; Revision 1.8 2012/06/12 01:03:40 rubikitch
;; set viewer-stay-in-unless-writable advice for `view-mode'
;;
;; Revision 1.7 2012/01/16 14:46:49 rubikitch
;; viewer-change-modeline-color-setup: Use window-configuration-change-hook
;;
;; Revision 1.6 2010/10/30 12:13:10 rubikitch
;; viewer-install-extension: call only if view-mode is enabled because (view-mode -1) on emacs24 calls it. mystery.
;;
;; Revision 1.5 2010/05/04 08:56:49 rubikitch
;; Added bug report command
;;
;; Revision 1.4 2009/03/11 08:52:12 rubikitch
;; fix bug in `aggressive-view-mode'
;;
;; Revision 1.3 2009/02/19 02:50:02 rubikitch
;; * view-mode by default
;; * update doc
;;
;; Revision 1.2 2009/02/18 23:57:11 rubikitch
;; * Aggressive view-mode
;; * Stay in view-mode
;; * Change mode-line color
;;
;; Revision 1.1 2009/02/18 15:04:14 rubikitch
;; Initial revision
;;
;;; Code:
(defvar viewer-version "$Id: viewer.el,v 1.13 2013/03/14 23:37:05 rubikitch Exp $")
(require 'view)
(eval-when-compile (require 'cl))
;;;; (@* "Overriding view-mode keymap")
(defun define-overriding-view-mode-map-internal (mode-name key-bindings)
(let ((mapsym (intern (concat (symbol-name mode-name) "-view-map")))
(view-mode-sym (intern (concat (symbol-name mode-name) "-view-mode"))))
(eval `(defvar ,mapsym nil))
(eval `(defvar ,view-mode-sym nil))
(let ((map (make-sparse-keymap)))
(loop for (key . command) in key-bindings
do (define-key map (read-kbd-macro key) command))
(set mapsym map)
(setq minor-mode-map-alist
(cons (cons view-mode-sym map)
(delete (assq view-mode-sym minor-mode-map-alist) minor-mode-map-alist)))
nil)))
(defmacro define-overriding-view-mode-map (mode-name &rest key-bindings)
"Define major-mode specific view-mode keymap.
Note that the car of an element of KEY-BINDINGS is `kbd' notation.
For example, to define `view-mode' keys for `emacs-lisp-mode':
(define-overriding-view-mode-map emacs-lisp-mode
(\"C-m\" . find-function)
(\"C-j\" . find-variable))
"
`(define-overriding-view-mode-map-internal ',mode-name ',key-bindings))
(defun viewer-install-extension ()
(when view-mode
(set (make-local-variable (intern (concat (symbol-name major-mode) "-view-mode")))
t)))
(add-hook 'view-mode-hook 'viewer-install-extension)
(defun viewer-uninstall-extension ()
(kill-local-variable (intern (concat (symbol-name major-mode) "-view-mode"))))
(defadvice view-mode-disable (before viewer activate)
(viewer-uninstall-extension))
;;; [2014-10-22 Wed]Emacs 24.4
(defadvice view--disable (before viewer activate)
(viewer-uninstall-extension))
;;;; (@* "View-mode by default")
(defcustom view-mode-by-default-regexp nil
"*Regexp of file name to open by `view-mode'."
:type 'string
:group 'viewer)
(defun view-mode-by-default-setup ()
(when (and buffer-file-name view-mode-by-default-regexp
(string-match view-mode-by-default-regexp buffer-file-name))
(view-mode 1)
(message "view-mode by view-mode-by-default-regexp.")))
(add-hook 'find-file-hook 'view-mode-by-default-setup)
;;;; (@* "Aggressive view-mode")
(defgroup viewer nil
"View-mode extensions"
:group 'view)
(defcustom viewer-aggressive-minimum-size 100
"*Minimum file size to enable aggressive view-mode."
:type 'integer
:group 'viewer)
(defcustom viewer-aggressive-writable t
"*When non-nil, aggressive view-mode buffer is writable."
:type 'boolean
:group 'viewer)
(defadvice find-file-noselect (after switch-to-view-file)
(when (bufferp ad-return-value)
(with-current-buffer ad-return-value
(aggressive-view-mode))))
(defun aggressive-view-mode ()
(when (and buffer-file-name
(> (buffer-size) viewer-aggressive-minimum-size)
(file-regular-p buffer-file-name))
(view-mode 1)
(setq buffer-read-only (not (file-writable-p buffer-file-name)))))
;; (describe-function 'find-file-noselect)
;; (memq 'aggressive-view-mode find-file-hook)
;; (viewer-aggressive-setup nil)
;; (viewer-aggressive-setup t)
;; (viewer-aggressive-setup 'force)
(defun viewer-aggressive-setup (arg)
"Setup aggressive `view-mode'.
When ARG is t, all new files are opened by `view-mode'.
When ARG is 'force, enable `view-mode' even if file buffer is selected.
When ARG is nil, uninstall it."
(case arg
('force
(remove-hook 'find-file-hook 'aggressive-view-mode)
(ad-enable-advice 'find-file-noselect 'after 'switch-to-view-file)
(ad-update 'find-file-noselect))
(nil
(remove-hook 'find-file-hook 'aggressive-view-mode)
(ad-disable-advice 'find-file-noselect 'after 'switch-to-view-file)
(ad-update 'find-file-noselect))
(t
(add-hook 'find-file-hook 'aggressive-view-mode)
(ad-disable-advice 'find-file-noselect 'after 'switch-to-view-file)
(ad-update 'find-file-noselect))))
;;;; (@* "Stay in view-mode")
(defvar view-mode-force-exit nil)
(defmacro viewer-stay-in-unless-writable-advice (f)
`(defadvice ,f (around viewer-stay-in-unless-writable activate)
(if (or view-mode-force-exit
(and (boundp 'edebug-active) edebug-active)
(not (and view-mode
(buffer-file-name)
(not (file-writable-p (buffer-file-name))))))
ad-do-it
(message "File is unwritable, so stay in view-mode."))))
(defun view-mode-force-exit ()
(interactive)
(let ((view-mode-force-exit t)) (view-mode-exit)))
(defun viewer-stay-in-setup ()
"Setup stay-in view-mode.
Stay in `view-mode' when the file is unwritable."
(viewer-stay-in-unless-writable-advice view-mode)
(viewer-stay-in-unless-writable-advice view-mode-exit)
(viewer-stay-in-unless-writable-advice view-mode-disable))
;;;; (@* "Change mode-line color")
(defvar viewer-modeline-color-default (face-background 'mode-line))
(defcustom viewer-modeline-color-unwritable "tomato"
"*Modeline color when file is not writable."
:type 'string
:group 'viewer)
(defcustom viewer-modeline-color-view "orange"
"*Modeline color for `view-mode'."
:type 'string
:group 'viewer)
(defun viewer-change-modeline-color ()
(interactive)
(when (eq (selected-window)
(get-buffer-window (current-buffer)))
(set-face-background
'mode-line
(cond ((and buffer-file-name view-mode
(not (file-writable-p buffer-file-name)))
viewer-modeline-color-unwritable)
(view-mode
viewer-modeline-color-view)
(t
viewer-modeline-color-default)))
;; (force-mode-line-update)
))
(defmacro viewer-change-modeline-color-advice (f)
`(defadvice ,f (after change-mode-line-color activate)
(viewer-change-modeline-color)))
(defun viewer-change-modeline-color-setup ()
"Setup coloring modeline.
See also `viewer-modeline-color-unwritable' and `viewer-modeline-color-view'."
(add-hook 'post-command-hook 'viewer-change-modeline-color))
(defun viewer-change-modeline-color-setup--old ()
"Setup coloring modeline.
See also `viewer-modeline-color-unwritable' and `viewer-modeline-color-view'."
(add-hook 'window-configuration-change-hook 'viewer-change-modeline-color)
(viewer-change-modeline-color-advice toggle-read-only)
(viewer-change-modeline-color-advice view-mode-enable)
(viewer-change-modeline-color-advice view-mode-disable)
(viewer-change-modeline-color-advice other-window)
(defadvice select-window (around change-modeline-color activate)
(let ((curwin (selected-window))
(destwin (ad-get-arg 0)))
ad-do-it
(unless (or (called-interactively-p 'any) (eq curwin destwin))
(viewer-change-modeline-color))))
(viewer-change-modeline-color-advice select-frame)
nil)
;;;; Bug report
(defvar viewer-maintainer-mail-address
(concat "rubiki" "tch@ru" "by-lang.org"))
(defvar viewer-bug-report-salutation
"Describe bug below, using a precise recipe.
When I executed M-x ...
How to send a bug report:
1) Be sure to use the LATEST version of viewer.el.
2) Enable debugger. M-x toggle-debug-on-error or (setq debug-on-error t)
3) Use Lisp version instead of compiled one: (load \"viewer.el\")
4) If you got an error, please paste *Backtrace* buffer.
5) Type C-c C-c to send.
# If you are a Japanese, please write in Japanese:-)")
(defun viewer-send-bug-report ()
(interactive)
(reporter-submit-bug-report
viewer-maintainer-mail-address
"viewer.el"
(apropos-internal "^view" 'boundp)
nil nil
viewer-bug-report-salutation))
(provide 'viewer)
;; How to save (DO NOT REMOVE!!)
;; (emacswiki-post "viewer.el")
;;; viewer.el ends here