|
428
|
1 ;;; view-less.el --- Minor mode for browsing files with keybindings like `less'
|
|
|
2
|
|
|
3 ;; Copyright (C) 1994, 1995 Tinker Systems and INS Engineering Corp.
|
|
|
4
|
|
|
5 ;; Author: Jonathan Stigelman <stig@hackvan.com>
|
|
|
6 ;; Maintainer: XEmacs Development Team
|
|
|
7 ;; Keywords: wp, unix
|
|
|
8
|
|
|
9 ;; This file is part of XEmacs.
|
|
444
|
10 ;;
|
|
428
|
11 ;; XEmacs is free software; you can redistribute it and/or modify
|
|
|
12 ;; it under the terms of the GNU General Public License as published by
|
|
|
13 ;; the Free Software Foundation; either version 2 of the License, or
|
|
|
14 ;; (at your option) any later version.
|
|
444
|
15 ;;
|
|
428
|
16 ;; XEmacs is distributed in the hope that it will be useful,
|
|
|
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
19 ;; GNU General Public License for more details.
|
|
444
|
20 ;;
|
|
428
|
21 ;; You should have received a copy of the GNU General Public License
|
|
|
22 ;; along with XEmacs; if not, write to the Free Software
|
|
|
23 ;; Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
|
|
|
24
|
|
|
25 ;;; Synched up with: Not in FSF.
|
|
|
26
|
|
|
27 ;;; Commentary:
|
|
|
28
|
|
|
29 ;; This mode is for browsing files without changing them. Keybindings
|
|
|
30 ;; similar to those used by the less(1) program are used.
|
|
|
31 ;;
|
|
|
32 ;; Originally written for v18 by David Gudeman (gudeman@arizona.edu)
|
|
|
33 ;; Mods by Bengt Martensson, to closely resemble less (July 1987)
|
|
|
34 ;;
|
|
444
|
35 ;; If you would like all write-protected files to be visited in view-mode,
|
|
428
|
36 ;; then add the following to your .emacs file:
|
|
|
37 ;;
|
|
|
38 ;; (add-hook 'find-file-hooks 'auto-view-mode)
|
|
|
39
|
|
|
40 ;;; Code:
|
|
|
41
|
|
|
42 (defvar view-search-string ""
|
|
|
43 "Last string searched for with view-search functions.")
|
|
|
44
|
|
|
45 (defvar view-search-arg 1
|
|
|
46 "Argument to last view search.")
|
|
|
47
|
|
|
48 (defvar view-default-lines 10
|
|
|
49 "Default value for the \"d\" and \"u\" commands in view-mode")
|
|
|
50
|
|
|
51 (defvar view-minor-mode nil
|
|
|
52 "Non-nil when view-mode is active. Call `view-mode' to toggle.")
|
|
|
53 (make-variable-buffer-local 'view-minor-mode)
|
|
|
54
|
|
|
55 ;;;###autoload
|
|
|
56 (defvar view-minor-mode-map
|
|
|
57 (let ((map (make-keymap)))
|
|
|
58 (set-keymap-name map 'view-minor-mode-map)
|
|
|
59 (suppress-keymap map)
|
|
|
60 (define-key map "-" 'negative-argument)
|
|
|
61 (define-key map " " 'scroll-up)
|
|
|
62 (define-key map "f" 'scroll-up)
|
|
|
63 (define-key map "b" 'scroll-down)
|
|
|
64 (define-key map 'backspace 'scroll-down)
|
|
|
65 (define-key map 'delete 'scroll-down)
|
|
|
66 (define-key map "\r" 'view-scroll-lines-up)
|
|
|
67 (define-key map "\n" 'view-scroll-lines-up)
|
|
|
68 (define-key map "e" 'view-scroll-lines-up)
|
|
|
69 (define-key map "j" 'view-scroll-lines-up)
|
|
|
70 (define-key map "y" 'view-scroll-lines-down)
|
|
|
71 (define-key map "k" 'view-scroll-lines-down)
|
|
|
72 (define-key map "d" 'view-scroll-some-lines-up)
|
|
|
73 (define-key map "u" 'view-scroll-some-lines-down)
|
|
|
74 (define-key map "r" 'recenter)
|
|
|
75 (define-key map "t" 'toggle-truncate-lines)
|
|
|
76 (define-key map "N" 'view-buffer)
|
|
|
77 (define-key map "E" 'view-file)
|
|
|
78 (define-key map "P" 'view-buffer)
|
|
|
79 (define-key map "!" 'shell-command)
|
|
|
80 (define-key map "|" 'shell-command-on-region)
|
|
|
81 (define-key map "=" 'what-line)
|
|
|
82 (define-key map "?" 'view-search-backward)
|
|
|
83 (define-key map "h" 'view-mode-describe)
|
|
|
84 (define-key map "s" 'view-repeat-search)
|
|
|
85 (define-key map "n" 'view-repeat-search)
|
|
|
86 (define-key map "/" 'view-search-forward)
|
|
|
87 (define-key map "\\" 'view-search-backward)
|
|
|
88 (define-key map "g" 'view-goto-line)
|
|
|
89 (define-key map "G" 'view-last-windowful)
|
|
|
90 (define-key map "%" 'view-goto-percent)
|
|
|
91 (define-key map "p" 'view-goto-percent)
|
|
|
92 (define-key map "m" 'point-to-register)
|
|
|
93 (define-key map "'" 'register-to-point)
|
|
|
94 (define-key map "C" 'view-cleanup-backspaces)
|
|
|
95 (define-key map "\C-c\C-c" 'view-quit)
|
|
|
96 ;; #### - should this use substitute-command-keys?
|
|
|
97 (define-key map "\C-x\C-q" 'view-quit-toggle-ro)
|
|
|
98 (define-key map "q" 'view-quit)
|
|
|
99 map
|
|
|
100 ))
|
|
|
101
|
|
695
|
102 ;;;###autoload
|
|
|
103 (defcustom view-mode-line-string " View"
|
|
|
104 "*String to display in the modeline when View mode is active.
|
|
|
105 Set this to nil if you don't want a modeline indicator."
|
|
|
106 :type '(choice string
|
|
|
107 (const :tag "none" nil)))
|
|
|
108
|
|
|
109 (add-minor-mode 'view-minor-mode
|
|
|
110 'view-mode-line-string
|
|
|
111 view-minor-mode-map)
|
|
428
|
112
|
|
|
113 ;;;###autoload
|
|
|
114 (defvar view-mode-map
|
|
|
115 (let ((map (copy-keymap view-minor-mode-map)))
|
|
|
116 (set-keymap-name map 'view-mode-map)
|
|
|
117 map))
|
|
|
118
|
|
|
119 ;;;###autoload
|
|
444
|
120 (defun view-file (filename &optional other-window-p)
|
|
|
121 "Find FILENAME, enter view mode. With prefix arg OTHER-WINDOW-P, use other window."
|
|
428
|
122 (interactive "fView File: \nP")
|
|
444
|
123 (let ((old-p (get-file-buffer filename))
|
|
428
|
124 (obuf (current-buffer)))
|
|
444
|
125 (if other-window-p
|
|
|
126 (find-file-other-window filename)
|
|
|
127 (find-file filename))
|
|
|
128 (view-mode (if other-window-p nil obuf)
|
|
428
|
129 (if old-p nil 'kill-buffer))
|
|
|
130 nil))
|
|
|
131
|
|
|
132 ;;;###autoload
|
|
444
|
133 (defun view-buffer (buffer &optional other-window-p)
|
|
|
134 "Switch to BUFFER, enter view mode. With prefix arg use other window."
|
|
428
|
135 (interactive "bView Buffer: \nP")
|
|
|
136 (let ((obuf (current-buffer)))
|
|
444
|
137 (if other-window-p
|
|
|
138 (switch-to-buffer-other-window buffer)
|
|
|
139 (switch-to-buffer buffer))
|
|
|
140 (view-mode (if other-window-p nil obuf)
|
|
|
141 (if other-window-p nil 'bury-buffer))))
|
|
428
|
142
|
|
|
143 ;;;###autoload
|
|
444
|
144 (defun view-file-other-window (filename)
|
|
|
145 "Find FILENAME in other window, and enter view mode."
|
|
428
|
146 (interactive "fView File: ")
|
|
444
|
147 (view-file filename t))
|
|
428
|
148
|
|
|
149 ;;;###autoload
|
|
|
150 (defun view-buffer-other-window (buffer)
|
|
|
151 "Switch to BUFFER in another window, and enter view mode."
|
|
|
152 (interactive "bView Buffer: ")
|
|
|
153 (view-buffer buffer t))
|
|
|
154
|
|
|
155 (defun view-brief-help ()
|
|
|
156 (message
|
|
|
157 (substitute-command-keys
|
|
|
158 "\\<view-minor-mode-map>\\[scroll-up] = page forward; \\[scroll-down] = page back; \
|
|
|
159 \\[view-mode-describe] = help; \\[view-quit] = quit.")))
|
|
|
160
|
|
|
161 (defvar view-major-mode)
|
|
|
162 (defvar view-exit-position)
|
|
|
163 (defvar view-prev-buffer)
|
|
|
164 (defvar view-exit-action)
|
|
|
165 (defvar view-old-buffer-read-only)
|
|
|
166
|
|
|
167 ;;;###autoload
|
|
|
168 (defun view-minor-mode (&optional prev-buffer exit-action)
|
|
|
169 "Minor mode for viewing text, with bindings like `less'.
|
|
|
170 Commands are:
|
|
|
171 \\<view-minor-mode-map>
|
|
|
172 0..9 prefix args
|
|
|
173 - prefix minus
|
|
|
174 \\[scroll-up] page forward
|
|
|
175 \\[scroll-down] page back
|
|
|
176 \\[view-scroll-lines-up] scroll prefix-arg lines forward, default 1.
|
|
|
177 \\[view-scroll-lines-down] scroll prefix-arg lines backward, default 1.
|
|
|
178 \\[view-scroll-some-lines-down] scroll prefix-arg lines backward, default 10.
|
|
|
179 \\[view-scroll-some-lines-up] scroll prefix-arg lines forward, default 10.
|
|
|
180 \\[what-line] print line number
|
|
|
181 \\[view-mode-describe] print this help message
|
|
|
182 \\[view-search-forward] regexp search, uses previous string if you just hit RET
|
|
|
183 \\[view-search-backward] as above but searches backward
|
|
|
184 \\[view-repeat-search] repeat last search
|
|
|
185 \\[view-goto-line] goto line prefix-arg, default 1
|
|
|
186 \\[view-last-windowful] goto line prefix-arg, default last line
|
|
|
187 \\[view-goto-percent] goto a position by percentage
|
|
|
188 \\[toggle-truncate-lines] toggle truncate-lines
|
|
|
189 \\[view-file] view another file
|
|
|
190 \\[view-buffer] view another buffer
|
|
|
191 \\[view-cleanup-backspaces] cleanup backspace constructions
|
|
|
192 \\[shell-command] execute a shell command
|
|
|
193 \\[shell-command-on-region]\
|
|
|
194 execute a shell command with the region as input
|
|
|
195 \\[view-quit] exit view-mode, and bury the current buffer.
|
|
|
196
|
|
|
197 If invoked with the optional (prefix) arg non-nil, view-mode cleans up
|
|
|
198 backspace constructions.
|
|
|
199
|
|
|
200 More precisely:
|
|
|
201 \\{view-minor-mode-map}"
|
|
|
202 (interactive)
|
|
|
203
|
|
|
204 (make-local-variable 'view-default-lines)
|
|
|
205 (set (make-local-variable 'view-exit-position) (point))
|
|
|
206 (set (make-local-variable 'view-prev-buffer) prev-buffer)
|
|
|
207 (set (make-local-variable 'view-exit-action) exit-action)
|
|
|
208 (set (make-local-variable 'view-old-buffer-read-only) buffer-read-only)
|
|
|
209 (add-hook (make-local-variable 'change-major-mode-hook)
|
|
|
210 'view-fixup-read-only)
|
|
|
211 (setq view-minor-mode t
|
|
|
212 buffer-read-only t)
|
|
|
213 (view-brief-help))
|
|
|
214
|
|
|
215 ;;;###autoload
|
|
|
216 (defun view-mode (&optional prev-buffer exit-action clean-bs)
|
|
|
217 "View the current buffer using view-minor-mode. This exists to be 99.9%
|
|
|
218 compatible with the implementations of `view-mode' in view.el and older
|
|
|
219 versions of view-less.el."
|
|
|
220 (interactive (list nil 'bury-buffer current-prefix-arg))
|
|
|
221 ;; #### - The first two arguments provide compatibility with view.el (and
|
|
|
222 ;; thus FSFmacs), while the third argument as a prefix argument maintains
|
|
|
223 ;; interactive compatibility with older versions of view-less. --Stig
|
|
|
224 (if clean-bs (cleanup-backspaces))
|
|
|
225 (view-minor-mode prev-buffer exit-action))
|
|
|
226
|
|
|
227 ;;;###autoload
|
|
|
228 (defun view-major-mode (&optional prev-buffer exit-action clean-bs)
|
|
|
229 "View the current buffer using view-mode, as a major mode.
|
|
|
230 This function has a nonstandard name because `view-mode' is wrongly
|
|
|
231 named but is like this for compatibility reasons."
|
|
|
232 ;; #### - The first two arguments provide compatibility with view.el (and
|
|
|
233 ;; thus FSFmacs), while the third argument as a prefix argument maintains
|
|
|
234 ;; interactive compatibility with older versions of view-less. --Stig
|
|
|
235 (interactive (list nil 'bury-buffer current-prefix-arg))
|
|
|
236 (kill-all-local-variables)
|
|
|
237 (use-local-map view-mode-map)
|
|
|
238 (setq major-mode 'view-mode)
|
|
|
239 (set (make-local-variable 'view-exit-position) (point))
|
|
|
240 (set (make-local-variable 'view-prev-buffer) prev-buffer)
|
|
|
241 (set (make-local-variable 'view-exit-action) exit-action)
|
|
|
242 (set (make-local-variable 'view-old-buffer-read-only) buffer-read-only)
|
|
|
243 (set (make-local-variable 'view-major-mode) t)
|
|
|
244 (setq buffer-read-only t)
|
|
|
245 (if clean-bs (cleanup-backspaces))
|
|
|
246 (run-hooks 'view-mode-hook))
|
|
|
247
|
|
|
248 ;;;###autoload
|
|
|
249 (defun auto-view-mode ()
|
|
|
250 "If the file of the current buffer is not writable, call view-mode.
|
|
|
251 This is meant to be added to `find-file-hooks'."
|
|
|
252 (or (file-writable-p buffer-file-name)
|
|
|
253 (view-minor-mode)))
|
|
|
254
|
|
|
255 (defun view-fixup-read-only ()
|
|
|
256 ;; doing M-x normal mode should NOT leave the buffer read-only
|
|
|
257 (and (boundp 'view-old-buffer-read-only)
|
|
|
258 (progn (setq buffer-read-only view-old-buffer-read-only)
|
|
|
259 (kill-local-variable 'view-old-buffer-read-only))))
|
|
|
260
|
|
|
261 (defun view-quit-toggle-ro ()
|
|
|
262 "Exit view mode and execute the global binding of the key that invoked this
|
|
|
263 command. Normally, this will toggle the state of `buffer-read-only', perhaps
|
|
|
264 invoking some version-control mechanism."
|
|
444
|
265 (interactive)
|
|
428
|
266 (setq view-exit-position nil)
|
|
|
267 ;; Kludge so this works as advertised. Stig, why can't you write
|
|
|
268 ;; bug-free code???
|
|
|
269 (let ((buffer-read-only buffer-read-only))
|
|
|
270 (view-quit t))
|
|
|
271 ;; no longer in view-minor-mode, so the keymap has changed...
|
|
|
272 (call-interactively (key-binding (this-command-keys))))
|
|
|
273
|
|
|
274 (defun view-quit (&optional no-exit-action)
|
|
|
275 "Exit view mode. With prefix argument, keep the current buffer selected."
|
|
|
276 (interactive "P")
|
|
|
277 (view-fixup-read-only)
|
|
|
278 (setq view-minor-mode nil)
|
|
|
279 (if view-exit-position (goto-char view-exit-position))
|
|
|
280 (if (and (boundp 'view-major-mode) view-major-mode)
|
|
|
281 (fundamental-mode)
|
|
|
282 (let ((pbuf view-prev-buffer)
|
|
|
283 (exitact view-exit-action))
|
|
|
284 (if no-exit-action
|
|
|
285 nil
|
|
|
286 (if exitact (funcall exitact (current-buffer)))
|
|
|
287 (if pbuf (switch-to-buffer pbuf))))))
|
|
|
288
|
|
|
289 ;; #### - similar to what's in man.el and this ought to be written in C anyway... --Stig
|
|
|
290 (defun cleanup-backspaces ()
|
|
|
291 "Cleanup backspace constructions.
|
|
|
292 _^H and ^H_ sequences are deleted. x^Hx sequences are turned into x for all
|
|
|
293 characters x. ^^H| and |^H^ sequences are turned into ^. +^Ho and o^H+ are
|
|
|
294 turned into (+)."
|
|
|
295 (interactive)
|
|
|
296 (save-excursion
|
|
|
297 (goto-char (point-min))
|
|
|
298 (while (= (following-char) ?\C-h)
|
|
|
299 (delete-char 1))
|
|
|
300 (while (search-forward "\C-h" nil t)
|
|
446
|
301 (backward-char 2)
|
|
428
|
302 (cond ((looking-at "_\C-h\\|\\(.\\)\C-h\\1\\||\C-h\\^")
|
|
|
303 (delete-char 2))
|
|
|
304 ((looking-at ".\C-h_\\|\\^\C-h|")
|
|
|
305 (forward-char 1)
|
|
|
306 (delete-char 2))
|
|
|
307 ((looking-at "+\C-ho\\|o\C-h+")
|
|
|
308 (delete-char 3)
|
|
|
309 (insert "(+)"))
|
|
|
310 ((looking-at "|\C-h-")
|
|
|
311 (delete-char 3)
|
|
|
312 (insert "*"))
|
|
|
313 (t (forward-char 2))))))
|
|
|
314
|
|
|
315 (defun view-cleanup-backspaces ()
|
|
|
316 "Cleanup backspaces and if buffer is currently unmodified, don't flag it
|
|
|
317 as a modified buffer. This works even if the buffer is read-only."
|
|
|
318 (interactive)
|
|
|
319 (let ((buffer-read-only)
|
|
|
320 (buf-mod (buffer-modified-p)))
|
|
|
321 (cleanup-backspaces)
|
|
|
322 ;; #### - THIS IS PROBABLY A REALLY DANGEROUS THING TO DO IN A MINOR MODE!!
|
|
|
323 (set-buffer-modified-p buf-mod)))
|
|
|
324
|
|
|
325 ;;;###autoload
|
|
|
326 (defun toggle-truncate-lines (&optional p)
|
|
|
327 "Toggles the values of truncate-lines.
|
|
|
328 Positive prefix arg sets, negative disables."
|
|
|
329 (interactive "P")
|
|
|
330 (setq truncate-lines (if p
|
|
|
331 (> (prefix-numeric-value p) 0)
|
|
|
332 (not truncate-lines)))
|
|
|
333 (recenter))
|
|
|
334
|
|
|
335 (defun view-scroll-lines-up (p)
|
|
|
336 "Scroll up prefix-arg lines, default 1."
|
|
|
337 (interactive "p")
|
|
|
338 (scroll-up p))
|
|
|
339
|
|
|
340 (defun view-scroll-lines-down (p)
|
|
|
341 "Scroll down prefix-arg lines, default 1."
|
|
|
342 (interactive "p")
|
|
|
343 (scroll-up (- p)))
|
|
|
344
|
|
|
345 (defun view-scroll-some-lines-down (&optional n)
|
|
|
346 "Scroll down prefix-arg lines, default 10, or last argument."
|
|
|
347 (interactive "p")
|
|
|
348 (if (> n 1) (setq view-default-lines n))
|
|
|
349 (scroll-down view-default-lines))
|
|
|
350
|
|
|
351 (defun view-scroll-some-lines-up (&optional n)
|
|
|
352 "Scroll up prefix-arg lines, default 10, or last argument."
|
|
|
353 (interactive "p")
|
|
|
354 (if (> n 1) (setq view-default-lines n))
|
|
|
355 (scroll-up view-default-lines))
|
|
|
356
|
|
|
357 (defun view-goto-line (&optional n)
|
|
|
358 "Goto prefix arg line N. N = 1 by default.."
|
|
|
359 (interactive "p")
|
|
|
360 (goto-line n))
|
|
|
361
|
|
|
362 (defun view-last-windowful (&optional n)
|
|
|
363 "Goto prefix arg line N or the first line of the last windowful in buffer."
|
|
|
364 (interactive "p")
|
|
|
365 (if current-prefix-arg
|
|
|
366 (goto-line n)
|
|
|
367 (end-of-buffer)
|
|
|
368 (recenter -1)
|
|
|
369 (move-to-window-line 0)))
|
|
|
370
|
|
|
371 (defun view-goto-percent (&optional percent)
|
|
|
372 "Set mark and go to a position PERCENT way into the current buffer."
|
|
|
373 (interactive "p")
|
|
|
374 (set-mark-command nil)
|
|
|
375 (goto-char (+ (point-min) (/ (* percent (- (point-max) (point-min))) 100)))
|
|
|
376 (beginning-of-line))
|
|
|
377
|
|
|
378 (defun view-mode-describe ()
|
|
|
379 (interactive)
|
|
|
380 (let ((mode-name "View")
|
|
|
381 (major-mode 'view-mode))
|
|
|
382 (describe-mode)))
|
|
|
383
|
|
|
384 (defun view-search-forward (s p)
|
|
|
385 "Search forward for REGEXP. If regexp is empty, use last search string.
|
|
|
386 With prefix ARG, search forward that many occurrences."
|
|
|
387 (interactive "sView search: \np")
|
|
|
388 (unwind-protect
|
|
444
|
389 (re-search-forward
|
|
428
|
390 (if (string-equal "" s) view-search-string s) nil nil p)
|
|
|
391 (setq view-search-arg p)
|
|
|
392 (or (string-equal "" s)
|
|
|
393 (setq view-search-string s))))
|
|
|
394
|
|
|
395 (defun view-search-backward (s p)
|
|
|
396 "Search backward for REGEXP. If regexp is empty, use last search string.
|
|
|
397 With prefix ARG, search forward that many occurrences."
|
|
|
398 (interactive "sView search backward: \np")
|
|
|
399 (view-search-forward s (- p)))
|
|
|
400
|
|
|
401 (defun view-repeat-search (p)
|
|
|
402 "Repeat last view search command. If a prefix arg is given, use that
|
|
|
403 instead of the previous arg, if the prefix is just a -, then take the
|
|
|
404 negative of the last prefix arg."
|
|
|
405 (interactive "P")
|
|
|
406 (view-search-forward
|
|
|
407 view-search-string
|
|
|
408 (cond ((null p) view-search-arg)
|
|
|
409 ((eq p '-) (- view-search-arg))
|
|
|
410 (t (prefix-numeric-value p)))))
|
|
|
411
|
|
|
412 (provide 'view)
|
|
|
413 (provide 'view-less)
|
|
|
414
|
|
|
415 ;;; view-less.el ends here
|
