Commit | Line | Data |
---|---|---|
e8af40ee | 1 | ;;; view.el --- peruse file or buffer without editing |
d501f516 | 2 | |
fd78d527 | 3 | ;; Copyright (C) 1985, 1989, 1994, 1995, 1997, 2000, 2001 |
d1ed8492 | 4 | ;; Free Software Foundation, Inc. |
eea8d4ef | 5 | |
e5167999 | 6 | ;; Author: K. Shane Hartman |
1036798c | 7 | ;; Maintainer: Inge Frick <inge@nada.kth.se> |
284b3043 | 8 | ;; Keywords: files |
e6211d55 RS |
9 | |
10 | ;; This file is part of GNU Emacs. | |
11 | ||
12 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
13 | ;; it under the terms of the GNU General Public License as published by | |
e5167999 | 14 | ;; the Free Software Foundation; either version 2, or (at your option) |
e6211d55 RS |
15 | ;; any later version. |
16 | ||
17 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
18 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
19 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
20 | ;; GNU General Public License for more details. | |
21 | ||
22 | ;; You should have received a copy of the GNU General Public License | |
b578f267 EN |
23 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
24 | ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
25 | ;; Boston, MA 02111-1307, USA. | |
e6211d55 | 26 | |
c91c4e6d ER |
27 | ;;; Commentary: |
28 | ||
bab0c3c1 | 29 | ;; This package provides the `view' minor mode documented in the Emacs |
c91c4e6d | 30 | ;; user's manual. |
ab7782fc | 31 | ;; View mode entry and exit is done through the functions view-mode-enter |
66d3a2b5 | 32 | ;; and view-mode-exit. Use these functions to enter or exit view-mode from |
ab7782fc | 33 | ;; emacs lisp programs. |
66d3a2b5 | 34 | ;; We use both view- and View- as prefix for symbols. View- is used as |
cae55197 | 35 | ;; prefix for commands that have a key binding. view- is used for commands |
66d3a2b5 | 36 | ;; without key binding. The purpose of this is to make it easier for a |
ab7782fc RS |
37 | ;; user to use command name completion. |
38 | ||
39 | ;;; Suggested key bindings: | |
40 | ;; | |
41 | ;; (define-key ctl-x-4-map "v" 'view-file-other-window) ; ^x4v | |
42 | ;; (define-key ctl-x-5-map "v" 'view-file-other-frame) ; ^x5v | |
43 | ;; | |
44 | ;; You could also bind view-file, view-buffer, view-buffer-other-window and | |
45 | ;; view-buffer-other-frame to keys. | |
c91c4e6d | 46 | |
e5167999 | 47 | ;;; Code: |
e6211d55 | 48 | |
cae55197 KH |
49 | (defgroup view nil |
50 | "Peruse file or buffer without editing." | |
51 | :link '(function-link view-mode) | |
52 | :link '(custom-manual "(emacs)Misc File Ops") | |
53 | :group 'wp | |
54 | :group 'editing) | |
55 | ||
56 | (defcustom view-read-only nil | |
57 | "*Non-nil means buffers visiting files read-only, do it in view mode." | |
58 | :type 'boolean | |
59 | :group 'view) | |
60 | ||
61 | (defcustom view-highlight-face 'highlight | |
62 | "*The face used for highlighting the match found by View mode search." | |
63 | :type 'face | |
64 | :group 'view) | |
82380f84 | 65 | |
66d3a2b5 | 66 | ;; `view-mode-auto-exit' is replaced by the following option variable which |
ab7782fc | 67 | ;; only says if scrolling past buffer end should leave view mode or not, it |
e51f616f | 68 | ;; doesn't say if leaving view mode should restore windows or not. The latter |
ab7782fc | 69 | ;; is now controlled by the presence of a value in `view-return-to-alist'. |
cae55197 | 70 | (defcustom view-scroll-auto-exit nil |
ab7782fc RS |
71 | "*Non-nil means scrolling past the end of buffer exits View mode. |
72 | nil means attempting to scroll past the end of the buffer, | |
cae55197 KH |
73 | only rings the bell and gives a message on how to leave." |
74 | :type 'boolean | |
75 | :group 'view) | |
ab7782fc | 76 | |
cae55197 | 77 | (defcustom view-try-extend-at-buffer-end nil |
66d3a2b5 RS |
78 | "*Non-nil means try load more of file when reaching end of buffer. |
79 | This variable is mainly intended to be temporarily set to non-nil by | |
80 | the F command in view-mode, but you can set it to t if you want the action | |
cae55197 KH |
81 | for all scroll commands in view mode." |
82 | :type 'boolean | |
83 | :group 'view) | |
ab7782fc | 84 | |
cae55197 KH |
85 | (defcustom view-remove-frame-by-deleting nil |
86 | "*Determine how View mode removes a frame no longer needed. | |
87 | If nil, make an icon of the frame. If non-nil, delete the frame." | |
88 | :type 'boolean | |
89 | :group 'view) | |
ab7782fc | 90 | |
cae55197 | 91 | (defcustom view-exits-all-viewing-windows nil |
66d3a2b5 RS |
92 | "*Non-nil means restore all windows used to view buffer. |
93 | Commands that restore windows when finished viewing a buffer, apply to all | |
94 | windows that display the buffer and have restore information in | |
cae55197 | 95 | `view-return-to-alist'. |
d9855810 | 96 | If `view-exits-all-viewing-windows' is nil, only the selected window is |
cae55197 KH |
97 | considered for restoring." |
98 | :type 'boolean | |
99 | :group 'view) | |
ab7782fc | 100 | |
0093dc5a | 101 | ;;;###autoload |
cae55197 KH |
102 | (defvar view-mode nil |
103 | "Non-nil if View mode is enabled. | |
104 | Don't change this variable directly, you must change it by one of the | |
105 | functions that enable or disable view mode.") | |
0093dc5a | 106 | ;;;###autoload |
bab0c3c1 KH |
107 | (make-variable-buffer-local 'view-mode) |
108 | ||
cae55197 KH |
109 | (defcustom view-mode-hook nil |
110 | "Normal hook run when starting to view a buffer or file." | |
111 | :type 'hook | |
112 | :group 'view) | |
c88daaef RS |
113 | |
114 | (defvar view-old-buffer-read-only nil) | |
115 | (make-variable-buffer-local 'view-old-buffer-read-only) | |
ab7782fc | 116 | |
c88daaef RS |
117 | (defvar view-old-Helper-return-blurb) |
118 | (make-variable-buffer-local 'view-old-Helper-return-blurb) | |
119 | ||
ab7782fc RS |
120 | (defvar view-page-size nil |
121 | "Default number of lines to scroll by View page commands. | |
122 | If nil then the local value of this is initially set to window size.") | |
123 | (make-variable-buffer-local 'view-page-size) | |
c88daaef | 124 | |
ab7782fc RS |
125 | (defvar view-half-page-size nil |
126 | "Default number of lines to scroll by View half page commands. | |
127 | If nil then the local value of this is initially set to half window size.") | |
128 | (make-variable-buffer-local 'view-half-page-size) | |
c88daaef | 129 | |
ab7782fc RS |
130 | (defvar view-last-regexp nil) |
131 | (make-variable-buffer-local 'view-last-regexp) ; Global is better??? | |
132 | ||
133 | (defvar view-return-to-alist nil | |
66d3a2b5 RS |
134 | "What to do with used windows and where to go when finished viewing buffer. |
135 | This is local in each buffer being viewed. | |
d9855810 RS |
136 | It is added to by `view-mode-enter' when starting to view a buffer and |
137 | subtracted from by `view-mode-exit' when finished viewing the buffer. | |
66d3a2b5 RS |
138 | |
139 | See RETURN-TO-ALIST argument of function `view-mode-exit' for the format of | |
e51f616f | 140 | `view-return-to-alist'.") |
ab7782fc RS |
141 | (make-variable-buffer-local 'view-return-to-alist) |
142 | ||
143 | (defvar view-exit-action nil | |
66d3a2b5 RS |
144 | "nil or a function with one argument (a buffer) called when finished viewing. |
145 | This is local in each buffer being viewed. | |
ab7782fc RS |
146 | The \\[view-file] and \\[view-file-other-window] commands may set this to |
147 | `kill-buffer'.") | |
c88daaef | 148 | (make-variable-buffer-local 'view-exit-action) |
c88daaef | 149 | |
1a552841 RS |
150 | (defvar view-no-disable-on-exit nil |
151 | "If non-nil, View mode \"exit\" commands don't actually disable View mode. | |
152 | Instead, these commands just switch buffers or windows. | |
153 | This is set in certain buffers by specialized features such as help commands | |
154 | that use View mode automatically.") | |
155 | ||
4fe11426 | 156 | (defvar view-overlay nil |
82380f84 RS |
157 | "Overlay used to display where a search operation found its match. |
158 | This is local in each buffer, once it is used.") | |
4fe11426 RS |
159 | (make-variable-buffer-local 'view-overlay) |
160 | ||
fd78d527 GM |
161 | (unless (assq 'view-mode minor-mode-alist) |
162 | (setq minor-mode-alist | |
163 | (cons (list 'view-mode | |
164 | (propertize " View" | |
165 | 'local-map mode-line-minor-mode-keymap | |
166 | 'help-echo "mouse-3: minor mode menu")) | |
167 | minor-mode-alist))) | |
bab0c3c1 | 168 | |
ab7782fc | 169 | ;; Define keymap inside defvar to make it easier to load changes. |
cae55197 | 170 | ;; Some redundant "less"-like key bindings below have been commented out. |
ab7782fc RS |
171 | (defvar view-mode-map |
172 | (let ((map (make-sparse-keymap))) | |
173 | (define-key map "C" 'View-kill-and-leave) | |
174 | (define-key map "c" 'View-leave) | |
175 | (define-key map "Q" 'View-quit-all) | |
176 | (define-key map "E" 'View-exit-and-edit) | |
177 | ; (define-key map "v" 'View-exit) | |
178 | (define-key map "e" 'View-exit) | |
179 | (define-key map "q" 'View-quit) | |
180 | ; (define-key map "N" 'View-search-last-regexp-backward) | |
181 | (define-key map "p" 'View-search-last-regexp-backward) | |
182 | (define-key map "n" 'View-search-last-regexp-forward) | |
183 | ; (define-key map "?" 'View-search-regexp-backward) ; Less does this. | |
184 | (define-key map "\\" 'View-search-regexp-backward) | |
185 | (define-key map "/" 'View-search-regexp-forward) | |
186 | (define-key map "r" 'isearch-backward) | |
187 | (define-key map "s" 'isearch-forward) | |
188 | (define-key map "m" 'point-to-register) | |
189 | (define-key map "'" 'register-to-point) | |
190 | (define-key map "x" 'exchange-point-and-mark) | |
d1ed8492 | 191 | (define-key map "@" 'View-back-to-mark) |
ab7782fc RS |
192 | (define-key map "." 'set-mark-command) |
193 | (define-key map "%" 'View-goto-percent) | |
194 | ; (define-key map "G" 'View-goto-line-last) | |
195 | (define-key map "g" 'View-goto-line) | |
196 | (define-key map "=" 'what-line) | |
197 | (define-key map "F" 'View-revert-buffer-scroll-page-forward) | |
198 | ; (define-key map "k" 'View-scroll-line-backward) | |
199 | (define-key map "y" 'View-scroll-line-backward) | |
200 | ; (define-key map "j" 'View-scroll-line-forward) | |
201 | (define-key map "\n" 'View-scroll-line-forward) | |
202 | (define-key map "\r" 'View-scroll-line-forward) | |
203 | (define-key map "u" 'View-scroll-half-page-backward) | |
204 | (define-key map "d" 'View-scroll-half-page-forward) | |
205 | (define-key map "z" 'View-scroll-page-forward-set-page-size) | |
206 | (define-key map "w" 'View-scroll-page-backward-set-page-size) | |
207 | ; (define-key map "b" 'View-scroll-page-backward) | |
208 | (define-key map "\C-?" 'View-scroll-page-backward) | |
209 | ; (define-key map "f" 'View-scroll-page-forward) | |
210 | (define-key map " " 'View-scroll-page-forward) | |
211 | (define-key map "o" 'View-scroll-to-buffer-end) | |
212 | (define-key map ">" 'end-of-buffer) | |
213 | (define-key map "<" 'beginning-of-buffer) | |
214 | (define-key map "-" 'negative-argument) | |
215 | (define-key map "9" 'digit-argument) | |
216 | (define-key map "8" 'digit-argument) | |
217 | (define-key map "7" 'digit-argument) | |
218 | (define-key map "6" 'digit-argument) | |
219 | (define-key map "5" 'digit-argument) | |
220 | (define-key map "4" 'digit-argument) | |
221 | (define-key map "3" 'digit-argument) | |
222 | (define-key map "2" 'digit-argument) | |
223 | (define-key map "1" 'digit-argument) | |
224 | (define-key map "0" 'digit-argument) | |
225 | (define-key map "H" 'describe-mode) | |
d1ed8492 | 226 | (define-key map "?" 'describe-mode) ; Maybe do as less instead? See above. |
ab7782fc RS |
227 | (define-key map "h" 'describe-mode) |
228 | map)) | |
e6211d55 | 229 | |
c88daaef RS |
230 | (or (assq 'view-mode minor-mode-map-alist) |
231 | (setq minor-mode-map-alist | |
232 | (cons (cons 'view-mode view-mode-map) minor-mode-map-alist))) | |
233 | ||
ab7782fc | 234 | ;;; Commands that enter or exit view mode. |
e6211d55 | 235 | |
7229064d | 236 | ;;;###autoload |
d1ed8492 | 237 | (defun view-file (file) |
e6211d55 | 238 | "View FILE in View mode, returning to previous buffer when done. |
ab7782fc | 239 | Emacs commands editing the buffer contents are not available; instead, |
e6211d55 RS |
240 | a special set of commands (mostly letters and punctuation) |
241 | are defined for moving around in the buffer. | |
242 | Space scrolls forward, Delete scrolls backward. | |
ab7782fc | 243 | For list of all View commands, type H or h while viewing. |
e6211d55 | 244 | |
bd0d2c58 | 245 | This command runs the normal hook `view-mode-hook'." |
e6211d55 | 246 | (interactive "fView file: ") |
d1ed8492 GM |
247 | (let ((had-a-buf (get-file-buffer file))) |
248 | (view-buffer (find-file-noselect file) | |
ab7782fc | 249 | (and (not had-a-buf) 'kill-buffer)))) |
e6211d55 | 250 | |
b82fef5c | 251 | ;;;###autoload |
d1ed8492 | 252 | (defun view-file-other-window (file) |
ab7782fc RS |
253 | "View FILE in View mode in another window. |
254 | Return that window to its previous buffer when done. | |
255 | Emacs commands editing the buffer contents are not available; instead, | |
b82fef5c JB |
256 | a special set of commands (mostly letters and punctuation) |
257 | are defined for moving around in the buffer. | |
258 | Space scrolls forward, Delete scrolls backward. | |
ab7782fc | 259 | For list of all View commands, type H or h while viewing. |
b82fef5c | 260 | |
bd0d2c58 | 261 | This command runs the normal hook `view-mode-hook'." |
ab7782fc | 262 | (interactive "fIn other window view file: ") |
d1ed8492 GM |
263 | (let ((had-a-buf (get-file-buffer file))) |
264 | (view-buffer-other-window (find-file-noselect file) nil | |
ab7782fc | 265 | (and (not had-a-buf) 'kill-buffer)))) |
b82fef5c | 266 | |
7229064d | 267 | ;;;###autoload |
d1ed8492 | 268 | (defun view-file-other-frame (file) |
ab7782fc RS |
269 | "View FILE in View mode in another frame. |
270 | Maybe delete other frame and/or return to previous buffer when done. | |
271 | Emacs commands editing the buffer contents are not available; instead, | |
e6211d55 RS |
272 | a special set of commands (mostly letters and punctuation) |
273 | are defined for moving around in the buffer. | |
274 | Space scrolls forward, Delete scrolls backward. | |
ab7782fc | 275 | For list of all View commands, type H or h while viewing. |
e6211d55 | 276 | |
bd0d2c58 | 277 | This command runs the normal hook `view-mode-hook'." |
ab7782fc | 278 | (interactive "fIn other frame view file: ") |
d1ed8492 GM |
279 | (let ((had-a-buf (get-file-buffer file))) |
280 | (view-buffer-other-frame (find-file-noselect file) nil | |
ab7782fc RS |
281 | (and (not had-a-buf) 'kill-buffer)))) |
282 | ||
283 | ||
284 | ;;;###autoload | |
d1ed8492 | 285 | (defun view-buffer (buffer &optional exit-action) |
ab7782fc RS |
286 | "View BUFFER in View mode, returning to previous buffer when done. |
287 | Emacs commands editing the buffer contents are not available; instead, | |
288 | a special set of commands (mostly letters and punctuation) | |
289 | are defined for moving around in the buffer. | |
290 | Space scrolls forward, Delete scrolls backward. | |
291 | For list of all View commands, type H or h while viewing. | |
292 | ||
293 | This command runs the normal hook `view-mode-hook'. | |
294 | ||
295 | Optional argument EXIT-ACTION is either nil or a function with buffer as | |
e51f616f | 296 | argument. This function is called when finished viewing buffer. |
ab7782fc RS |
297 | Use this argument instead of explicitly setting `view-exit-action'." |
298 | ||
e6211d55 | 299 | (interactive "bView buffer: ") |
ab7782fc | 300 | (let ((undo-window (list (window-buffer) (window-start) (window-point)))) |
d1ed8492 | 301 | (switch-to-buffer buffer) |
ab7782fc RS |
302 | (view-mode-enter (cons (selected-window) (cons nil undo-window)) |
303 | exit-action))) | |
e6211d55 | 304 | |
b82fef5c | 305 | ;;;###autoload |
d1ed8492 | 306 | (defun view-buffer-other-window (buffer &optional not-return exit-action) |
bab0c3c1 | 307 | "View BUFFER in View mode in another window. |
ab7782fc RS |
308 | Return to previous buffer when done, unless optional NOT-RETURN is non-nil. |
309 | Emacs commands editing the buffer contents are not available; instead, | |
310 | a special set of commands (mostly letters and punctuation) | |
311 | are defined for moving around in the buffer. | |
312 | Space scrolls forward, Delete scrolls backward. | |
313 | For list of all View commands, type H or h while viewing. | |
314 | ||
315 | This command runs the normal hook `view-mode-hook'. | |
316 | ||
317 | Optional argument EXIT-ACTION is either nil or a function with buffer as | |
e51f616f | 318 | argument. This function is called when finished viewing buffer. |
ab7782fc RS |
319 | Use this argument instead of explicitly setting `view-exit-action'." |
320 | (interactive "bIn other window view buffer:\nP") | |
321 | (let* ((win ; This window will be selected by | |
322 | (get-lru-window)) ; switch-to-buffer-other-window below. | |
323 | (return-to | |
324 | (and (not not-return) | |
325 | (cons (selected-window) | |
326 | (if (eq win (selected-window)) | |
327 | t ; Has to make new window. | |
d1ed8492 | 328 | (list |
ab7782fc RS |
329 | (window-buffer win) ; Other windows old buffer. |
330 | (window-start win) | |
331 | (window-point win))))))) | |
d1ed8492 | 332 | (switch-to-buffer-other-window buffer) |
ab7782fc RS |
333 | (view-mode-enter (and return-to (cons (selected-window) return-to)) |
334 | exit-action))) | |
5c05f569 | 335 | |
ab7782fc | 336 | ;;;###autoload |
d1ed8492 | 337 | (defun view-buffer-other-frame (buffer &optional not-return exit-action) |
ab7782fc RS |
338 | "View BUFFER in View mode in another frame. |
339 | Return to previous buffer when done, unless optional NOT-RETURN is non-nil. | |
340 | Emacs commands editing the buffer contents are not available; instead, | |
b82fef5c JB |
341 | a special set of commands (mostly letters and punctuation) |
342 | are defined for moving around in the buffer. | |
343 | Space scrolls forward, Delete scrolls backward. | |
ab7782fc | 344 | For list of all View commands, type H or h while viewing. |
b82fef5c | 345 | |
ab7782fc RS |
346 | This command runs the normal hook `view-mode-hook'. |
347 | ||
348 | Optional argument EXIT-ACTION is either nil or a function with buffer as | |
e51f616f | 349 | argument. This function is called when finished viewing buffer. |
ab7782fc RS |
350 | Use this argument instead of explicitly setting `view-exit-action'." |
351 | (interactive "bView buffer in other frame: \nP") | |
352 | (let ((return-to | |
353 | (and (not not-return) (cons (selected-window) t)))) ; Old window. | |
d1ed8492 | 354 | (switch-to-buffer-other-frame buffer) |
ab7782fc RS |
355 | (view-mode-enter (and return-to (cons (selected-window) return-to)) |
356 | exit-action))) | |
b82fef5c | 357 | |
7229064d | 358 | ;;;###autoload |
c88daaef | 359 | (defun view-mode (&optional arg) |
ab7782fc | 360 | ;; In the following documentation string we have to use some explicit key |
e51f616f | 361 | ;; bindings instead of using the \\[] construction. The reason for this |
ab7782fc RS |
362 | ;; is that most commands have more than one key binding. |
363 | "Toggle View mode, a minor mode for viewing text but not editing it. | |
d1ed8492 | 364 | With ARG, turn View mode on iff ARG is positive. |
ab7782fc RS |
365 | |
366 | Emacs commands that do not change the buffer contents are available as usual. | |
e51f616f | 367 | Kill commands insert text in kill buffers but do not delete. Other commands |
ab7782fc RS |
368 | \(among them most letters and punctuation) beep and tell that the buffer is |
369 | read-only. | |
370 | \\<view-mode-map> | |
371 | The following additional commands are provided. Most commands take prefix | |
372 | arguments. Page commands default to \"page size\" lines which is almost a whole | |
373 | window full, or number of lines set by \\[View-scroll-page-forward-set-page-size] or \\[View-scroll-page-backward-set-page-size]. Half page commands default to | |
374 | and set \"half page size\" lines which initially is half a window full. Search | |
375 | commands default to a repeat count of one. | |
376 | ||
377 | H, h, ? This message. | |
378 | Digits provide prefix arguments. | |
379 | \\[negative-argument] negative prefix argument. | |
380 | \\[beginning-of-buffer] move to the beginning of buffer. | |
381 | > move to the end of buffer. | |
382 | \\[View-scroll-to-buffer-end] scroll so that buffer end is at last line of window. | |
d1ed8492 GM |
383 | SPC scroll forward \"page size\" lines. |
384 | With prefix scroll forward prefix lines. | |
385 | DEL scroll backward \"page size\" lines. | |
386 | With prefix scroll backward prefix lines. | |
387 | \\[View-scroll-page-forward-set-page-size] like \\[View-scroll-page-forward] but with prefix sets \"page size\" to prefix. | |
388 | \\[View-scroll-page-backward-set-page-size] like \\[View-scroll-page-backward] but with prefix sets \"page size\" to prefix. | |
389 | \\[View-scroll-half-page-forward] scroll forward \"half page size\" lines. With prefix, sets | |
390 | \"half page size\" to prefix lines and scrolls forward that much. | |
391 | \\[View-scroll-half-page-backward] scroll backward \"half page size\" lines. With prefix, sets | |
392 | \"half page size\" to prefix lines and scrolls backward that much. | |
393 | RET, LFD scroll forward one line. With prefix scroll forward prefix line(s). | |
394 | y scroll backward one line. With prefix scroll backward prefix line(s). | |
ab7782fc RS |
395 | \\[View-revert-buffer-scroll-page-forward] revert-buffer if necessary and scroll forward. |
396 | Use this to view a changing file. | |
397 | \\[what-line] prints the current line number. | |
398 | \\[View-goto-percent] goes prefix argument (default 100) percent into buffer. | |
399 | \\[View-goto-line] goes to line given by prefix argument (default first line). | |
400 | . set the mark. | |
401 | x exchanges point and mark. | |
402 | \\[View-back-to-mark] return to mark and pops mark ring. | |
403 | Mark ring is pushed at start of every successful search and when | |
e51f616f | 404 | jump to line occurs. The mark is set on jump to buffer start or end. |
ab7782fc RS |
405 | \\[point-to-register] save current position in character register. |
406 | ' go to position saved in character register. | |
407 | s do forward incremental search. | |
408 | r do reverse incremental search. | |
409 | \\[View-search-regexp-forward] searches forward for regular expression, starting after current page. | |
410 | ! and @ have a special meaning at the beginning of the regexp. | |
e51f616f | 411 | ! means search for a line with no match for regexp. @ means start |
ab7782fc RS |
412 | search at beginning (end for backward search) of buffer. |
413 | \\ searches backward for regular expression, starting before current page. | |
414 | \\[View-search-last-regexp-forward] searches forward for last regular expression. | |
415 | p searches backward for last regular expression. | |
416 | \\[View-quit] quit View mode, trying to restore window and buffer to previous state. | |
417 | \\[View-quit] is the normal way to leave view mode. | |
e51f616f | 418 | \\[View-exit] exit View mode but stay in current buffer. Use this if you started |
ab7782fc RS |
419 | viewing a buffer (file) and find out you want to edit it. |
420 | \\[View-exit-and-edit] exit View mode and make the current buffer editable. | |
421 | \\[View-quit-all] quit View mode, trying to restore windows and buffer to previous state. | |
422 | \\[View-leave] quit View mode and maybe switch buffers, but don't kill this buffer. | |
423 | \\[View-kill-and-leave] quit View mode, kill current buffer and go back to other buffer. | |
424 | ||
e51f616f | 425 | The effect of \\[View-leave] , \\[View-quit] and \\[View-kill-and-leave] depends on how view-mode was entered. If it was |
d1ed8492 GM |
426 | entered by view-file, view-file-other-window or view-file-other-frame |
427 | \(\\[view-file], \\[view-file-other-window], \\[view-file-other-frame] or the dired mode v command), then \\[View-quit] will | |
428 | try to kill the current buffer. If view-mode was entered from another buffer | |
429 | as is done by View-buffer, View-buffer-other-window, View-buffer-other frame, | |
430 | View-file, View-file-other-window or View-file-other-frame then \\[View-leave] , \\[View-quit] and \\[View-kill-and-leave] | |
431 | will return to that buffer. | |
ab7782fc RS |
432 | |
433 | Entry to view-mode runs the normal hook `view-mode-hook'." | |
bc15ba42 | 434 | (interactive "P") |
cae55197 KH |
435 | (unless (and arg ; Do nothing if already OK. |
436 | (if (> (prefix-numeric-value arg) 0) view-mode (not view-mode))) | |
437 | (if view-mode (view-mode-disable) | |
438 | (view-mode-enable)))) | |
e51f616f RS |
439 | |
440 | (defun view-mode-enable () | |
441 | "Turn on View mode." | |
8b7037d9 RS |
442 | ;; Always leave view mode before changing major mode. |
443 | ;; This is to guarantee that the buffer-read-only variable is restored. | |
8b7037d9 | 444 | (add-hook 'change-major-mode-hook 'view-mode-disable nil t) |
e51f616f RS |
445 | (setq view-mode t |
446 | view-page-size (view-page-size-default view-page-size) | |
447 | view-half-page-size (or view-half-page-size (/ (view-window-size) 2)) | |
448 | view-old-buffer-read-only buffer-read-only | |
449 | buffer-read-only t | |
450 | view-old-Helper-return-blurb (and (boundp 'Helper-return-blurb) | |
451 | Helper-return-blurb) | |
452 | Helper-return-blurb | |
453 | (format "continue viewing %s" | |
454 | (if (buffer-file-name) | |
455 | (file-name-nondirectory (buffer-file-name)) | |
456 | (buffer-name)))) | |
19b7f6c9 | 457 | (force-mode-line-update) |
e51f616f RS |
458 | (run-hooks 'view-mode-hook)) |
459 | ||
460 | (defun view-mode-disable () | |
461 | "Turn off View mode." | |
8b7037d9 | 462 | (remove-hook 'change-major-mode-hook 'view-mode-disable t) |
e51f616f | 463 | (and view-overlay (delete-overlay view-overlay)) |
19b7f6c9 | 464 | (force-mode-line-update) |
b75c9917 RS |
465 | ;; Calling toggle-read-only while View mode is enabled |
466 | ;; sets view-read-only to t as a buffer-local variable | |
467 | ;; after exiting View mode. That arranges that the next toggle-read-only | |
468 | ;; will reenable View mode. | |
469 | ;; Cancelling View mode in any other way should cancel that, too, | |
470 | ;; so that View mode stays off if toggle-read-only is called. | |
471 | (if (local-variable-p 'view-read-only) | |
472 | (kill-local-variable 'view-read-only)) | |
e51f616f | 473 | (setq view-mode nil |
bf551cf7 KH |
474 | Helper-return-blurb view-old-Helper-return-blurb) |
475 | (if buffer-read-only | |
476 | (setq buffer-read-only view-old-buffer-read-only))) | |
ab7782fc RS |
477 | |
478 | ;;;###autoload | |
479 | (defun view-mode-enter (&optional return-to exit-action) "\ | |
480 | Enter View mode and set up exit from view mode depending on optional arguments. | |
481 | If RETURN-TO is non-nil it is added as an element to the buffer local alist | |
7f9fcc0f | 482 | `view-return-to-alist'. |
e51f616f RS |
483 | Save EXIT-ACTION in buffer local variable `view-exit-action'. |
484 | It should be either nil or a function that takes a buffer as argument. | |
66d3a2b5 | 485 | This function will be called by `view-mode-exit'. |
e51f616f | 486 | |
ab7782fc | 487 | RETURN-TO is either nil, meaning do nothing when exiting view mode, or |
66d3a2b5 | 488 | it has the format (WINDOW OLD-WINDOW . OLD-BUF-INFO). |
e51f616f RS |
489 | WINDOW is a window used for viewing. |
490 | OLD-WINDOW is nil or the window to select after viewing. | |
491 | OLD-BUF-INFO tells what to do with WINDOW when exiting. It is one of: | |
ab7782fc | 492 | 1) nil Do nothing. |
e51f616f RS |
493 | 2) t Delete WINDOW or, if it is the only window, its frame. |
494 | 3) (OLD-BUFF START POINT) Display buffer OLD-BUFF with displayed text | |
495 | starting at START and point at POINT in WINDOW. | |
d1ed8492 | 496 | 4) quit-window Do `quit-window' in WINDOW. |
ab7782fc | 497 | |
66d3a2b5 | 498 | For list of all View commands, type H or h while viewing. |
ab7782fc RS |
499 | |
500 | This function runs the normal hook `view-mode-hook'." | |
501 | (if return-to | |
502 | (let ((entry (assq (car return-to) view-return-to-alist))) | |
503 | (if entry (setcdr entry (cdr return-to)) | |
504 | (setq view-return-to-alist (cons return-to view-return-to-alist))))) | |
cae55197 KH |
505 | (if exit-action (setq view-exit-action exit-action)) |
506 | (unless view-mode ; Do nothing if already in view mode. | |
e51f616f | 507 | (view-mode-enable) |
ab7782fc RS |
508 | (force-mode-line-update) |
509 | (message "%s" | |
510 | (substitute-command-keys "\ | |
1f5f6db6 | 511 | View mode: type \\[help-command] for help, \\[describe-mode] for commands, \\[View-quit] to quit.")))) |
ab7782fc RS |
512 | |
513 | (defun view-mode-exit (&optional return-to-alist exit-action all-win) | |
7f9fcc0f | 514 | "Exit View mode in various ways, depending on optional arguments. |
cae55197 | 515 | RETURN-TO-ALIST, EXIT-ACTION and ALL-WIN determine what to do after exit. |
ab7782fc RS |
516 | EXIT-ACTION is nil or a function that is called with current buffer as |
517 | argument. | |
66d3a2b5 RS |
518 | RETURN-TO-ALIST is an alist that for some of the windows displaying the |
519 | current buffer, associate information on what to do with those windows. | |
520 | If ALL-WIN or the variable `view-exits-all-viewing-windows' is non-nil, | |
521 | then all windows on RETURN-TO-ALIST are restored to their old state. | |
522 | Otherwise only the selected window is affected (if it is on RETURN-TO-ALIST). | |
523 | ||
524 | Elements of RETURN-TO-ALIST have the format (WINDOW OLD-WINDOW . OLD-BUF-INFO). | |
525 | WINDOW is a window displaying the current buffer. | |
526 | OLD-WINDOW is nil or a window to select after viewing. | |
527 | OLD-BUF-INFO is information on what to do with WINDOW and is one of: | |
ab7782fc | 528 | 1) nil Do nothing. |
d1ed8492 | 529 | 2) t Delete WINDOW and, if it is the only window, its frame. |
e51f616f RS |
530 | 3) (OLD-BUF START POINT) Display buffer OLD-BUF with displayed text |
531 | starting at START and point at POINT in WINDOW. | |
d1ed8492 | 532 | 4) quit-window Do `quit-window' in WINDOW. |
66d3a2b5 | 533 | |
e51f616f RS |
534 | If one of the WINDOW in RETURN-TO-ALIST is the selected window and the |
535 | corresponding OLD-WINDOW is a live window, then select OLD-WINDOW." | |
66d3a2b5 RS |
536 | (setq all-win |
537 | (and return-to-alist (or all-win view-exits-all-viewing-windows))) | |
ab7782fc RS |
538 | (if view-mode ; Only do something if in view mode. |
539 | (let* ((buffer (current-buffer)) | |
d1ed8492 | 540 | window notlost |
ab7782fc | 541 | (sel-old (assq (selected-window) return-to-alist)) |
66d3a2b5 RS |
542 | (alist (cond |
543 | (all-win ; Try to restore all windows. | |
544 | (append return-to-alist nil)) ; Copy. | |
545 | (sel-old ; Only selected window. | |
546 | (list sel-old)))) | |
547 | (old-window (if sel-old (car (cdr sel-old))))) | |
548 | (if all-win ; Follow chains of old-windows. | |
549 | (let ((c (length alist)) a) | |
550 | (while (and (> c 0) ; Safety if mutually refering windows. | |
551 | (or (not (window-live-p old-window)) | |
552 | (eq buffer (window-buffer old-window))) | |
553 | (setq a (assq old-window alist))) | |
554 | (setq c (1- c)) | |
555 | (setq old-window (car (cdr a)))) | |
556 | (if (or (zerop c) (not (window-live-p old-window))) | |
557 | (setq old-window (selected-window))))) | |
1a552841 RS |
558 | (or view-no-disable-on-exit |
559 | (view-mode-disable)) | |
ab7782fc | 560 | (while alist ; Restore windows with info. |
d1ed8492 | 561 | (setq notlost nil) |
ab7782fc RS |
562 | (if (and (window-live-p (setq window (car (car alist)))) |
563 | (eq buffer (window-buffer window))) | |
564 | (let ((frame (window-frame window)) | |
565 | (old-buf-info (cdr (cdr (car alist))))) | |
566 | (if all-win (select-window window)) | |
567 | (cond | |
568 | ((and (consp old-buf-info) ; Case 3. | |
569 | (buffer-live-p (car old-buf-info))) | |
570 | (set-window-buffer window (car old-buf-info)) ; old-buf | |
571 | (set-window-start window (car (cdr old-buf-info))) | |
572 | (set-window-point window (car (cdr (cdr old-buf-info))))) | |
d9855810 | 573 | ((eq old-buf-info 'quit-window) |
d1ed8492 | 574 | (quit-window)) ; Case 4. |
ab7782fc RS |
575 | ((not (eq old-buf-info t)) nil) ; Not case 2, do nothing. |
576 | ((not (one-window-p t)) (delete-window)) | |
66d3a2b5 RS |
577 | ((not (eq frame (next-frame))) |
578 | ;; Not the only frame, so can safely be removed. | |
579 | (if view-remove-frame-by-deleting | |
580 | (delete-frame frame) | |
d1ed8492 | 581 | (setq notlost t) ; Keep the window. See below. |
66d3a2b5 | 582 | (iconify-frame frame)))))) |
d1ed8492 GM |
583 | ;; If a frame is removed by iconifying it, then the window is not |
584 | ;; really lost. In this case we keep the entry in | |
585 | ;; view-return-to-alist so that if the user deiconifies the frame | |
586 | ;; and then press q, then the frame is iconified again. | |
587 | (unless notlost | |
588 | (setq view-return-to-alist | |
589 | (delete (car alist) view-return-to-alist))) | |
ab7782fc | 590 | (setq alist (cdr alist))) |
ab7782fc RS |
591 | (if (window-live-p old-window) ; still existing window |
592 | (select-window old-window)) | |
cae55197 KH |
593 | (when exit-action |
594 | (setq view-exit-action nil) | |
595 | (funcall exit-action buffer)) | |
ab7782fc RS |
596 | (force-mode-line-update)))) |
597 | ||
598 | (defun View-exit () | |
599 | "Exit View mode but stay in current buffer." | |
e6211d55 | 600 | (interactive) |
ab7782fc | 601 | (view-mode-exit)) |
e6211d55 | 602 | |
0093dc5a | 603 | ;;;###autoload |
ab7782fc RS |
604 | (defun View-exit-and-edit () |
605 | "Exit View mode and make the current buffer editable." | |
606 | (interactive) | |
72b5cb89 KH |
607 | (let ((view-old-buffer-read-only nil) |
608 | (view-no-disable-on-exit nil)) | |
66d3a2b5 | 609 | (view-mode-exit))) |
ab7782fc RS |
610 | |
611 | (defun View-leave () | |
612 | "Quit View mode and maybe switch buffers, but don't kill this buffer." | |
613 | (interactive) | |
614 | (view-mode-exit view-return-to-alist)) | |
615 | ||
616 | (defun View-quit () | |
617 | "Quit View mode, trying to restore window and buffer to previous state. | |
e51f616f | 618 | Maybe kill this buffer. Try to restore selected window to previous state |
ab7782fc RS |
619 | and go to previous buffer or window." |
620 | (interactive) | |
621 | (view-mode-exit view-return-to-alist view-exit-action)) | |
622 | ||
623 | (defun View-quit-all () | |
e51f616f RS |
624 | "Quit View mode, trying to restore windows and buffers to previous state. |
625 | Maybe kill current buffer. Try to restore all windows viewing buffer to | |
ab7782fc RS |
626 | previous state and go to previous buffer or window." |
627 | (interactive) | |
628 | (view-mode-exit view-return-to-alist view-exit-action t)) | |
629 | ||
630 | (defun View-kill-and-leave () | |
631 | "Quit View mode, kill current buffer and return to previous buffer." | |
632 | (interactive) | |
633 | (view-mode-exit view-return-to-alist (or view-exit-action 'kill-buffer) t)) | |
634 | ||
635 | ||
636 | ;;; Some help routines. | |
637 | ||
638 | (defun view-window-size () | |
639 | ;; Window height excluding mode line. | |
640 | (1- (window-height))) | |
bd0d2c58 | 641 | |
e6211d55 RS |
642 | ;(defun view-last-command (&optional who what) |
643 | ; (setq view-last-command-entry this-command) | |
644 | ; (setq view-last-command who) | |
645 | ; (setq view-last-command-argument what)) | |
646 | ||
647 | ;(defun View-repeat-last-command () | |
648 | ; "Repeat last command issued in View mode." | |
649 | ; (interactive) | |
650 | ; (if (and view-last-command | |
651 | ; (eq view-last-command-entry last-command)) | |
652 | ; (funcall view-last-command view-last-command-argument)) | |
653 | ; (setq this-command view-last-command-entry)) | |
654 | ||
ab7782fc RS |
655 | (defun view-recenter () |
656 | ;; Center point in window. | |
657 | (recenter (/ (view-window-size) 2))) | |
658 | ||
659 | (defun view-page-size-default (lines) | |
660 | ;; Get page size. | |
661 | (let ((default (- (view-window-size) next-screen-context-lines))) | |
662 | (if (or (null lines) (zerop (setq lines (prefix-numeric-value lines)))) | |
663 | default | |
664 | (min (abs lines) default)))) | |
665 | ||
666 | (defun view-set-half-page-size-default (lines) | |
667 | ;; Get and maybe set half page size. | |
668 | (if (not lines) view-half-page-size | |
669 | (setq view-half-page-size | |
670 | (if (zerop (setq lines (prefix-numeric-value lines))) | |
671 | (/ (view-window-size) 2) | |
672 | (view-page-size-default lines))))) | |
673 | ||
674 | ||
675 | ;;; Commands for moving around in the buffer. | |
676 | ||
677 | (defun View-goto-percent (&optional percent) | |
678 | "Move to end (or prefix PERCENT) of buffer in View mode. | |
679 | Display is centered at point. | |
e51f616f | 680 | Also set the mark at the position where point was." |
ab7782fc RS |
681 | (interactive "P") |
682 | (push-mark) | |
683 | (goto-char | |
684 | (if percent | |
685 | (+ (point-min) | |
686 | (floor (* (- (point-max) (point-min)) 0.01 | |
687 | (max 0 (min 100 (prefix-numeric-value percent)))))) | |
688 | (point-max))) | |
689 | (view-recenter)) | |
690 | ||
691 | ;(defun View-goto-line-last (&optional line) | |
692 | ;"Move to last (or prefix LINE) line in View mode. | |
693 | ;Display is centered at LINE. | |
694 | ;Sets mark at starting position and pushes mark ring." | |
695 | ; (interactive "P") | |
696 | ; (push-mark) | |
697 | ; (if line (goto-line (prefix-numeric-value line)) | |
698 | ; (goto-char (point-max)) | |
699 | ; (beginning-of-line)) | |
700 | ; (view-recenter)) | |
701 | ||
702 | (defun View-goto-line (&optional line) | |
703 | "Move to first (or prefix LINE) line in View mode. | |
704 | Display is centered at LINE. | |
e51f616f | 705 | Also set the mark at the position where point was." |
e6211d55 RS |
706 | (interactive "p") |
707 | (push-mark) | |
bab0c3c1 | 708 | (goto-line line) |
ab7782fc | 709 | (view-recenter)) |
e6211d55 | 710 | |
ab7782fc RS |
711 | (defun View-scroll-to-buffer-end () |
712 | "Scroll backward or forward so that buffer end is at last line of window." | |
713 | (interactive) | |
714 | (let ((p (if (pos-visible-in-window-p (point-max)) (point)))) | |
715 | (goto-char (point-max)) | |
716 | (recenter -1) | |
717 | (and p (goto-char p)))) | |
718 | ||
719 | (defun view-scroll-lines (lines backward default maxdefault) | |
720 | ;; This function does the job for all the scrolling commands. | |
e51f616f RS |
721 | ;; Scroll forward LINES lines. If BACKWARD is true scroll backwards. |
722 | ;; If LINES is negative scroll in the other direction. If LINES is 0 or nil, | |
723 | ;; scroll DEFAULT lines. If MAXDEFAULT is true then scroll no more than a | |
ab7782fc RS |
724 | ;; window full. |
725 | (if (or (null lines) (zerop (setq lines (prefix-numeric-value lines)))) | |
726 | (setq lines default)) | |
cae55197 KH |
727 | (when (< lines 0) |
728 | (setq backward (not backward)) (setq lines (- lines))) | |
ab7782fc RS |
729 | (setq default (view-page-size-default nil)) ; Max scrolled at a time. |
730 | (if maxdefault (setq lines (min lines default))) | |
731 | (cond | |
732 | (backward (scroll-down lines)) | |
733 | ((view-really-at-end) | |
734 | (if view-scroll-auto-exit (View-quit) | |
735 | (ding) | |
736 | (view-end-message))) | |
737 | (t (while (> lines default) | |
738 | (scroll-up default) | |
739 | (setq lines (- lines default)) | |
740 | (if (view-really-at-end) (setq lines 0))) | |
741 | (scroll-up lines) | |
742 | (if (view-really-at-end) (view-end-message)) | |
743 | (move-to-window-line -1) | |
744 | (beginning-of-line)))) | |
745 | ||
746 | (defun view-really-at-end () | |
e51f616f | 747 | ;; Return true if buffer end visible. Maybe revert buffer and test. |
ab7782fc RS |
748 | (and (pos-visible-in-window-p (point-max)) |
749 | (let ((buf (current-buffer)) | |
750 | (bufname (buffer-name)) | |
751 | (file (buffer-file-name))) | |
69576401 AS |
752 | (or (not view-try-extend-at-buffer-end) |
753 | (null file) | |
754 | (verify-visited-file-modtime buf) | |
755 | (not (file-exists-p file)) | |
756 | (when (buffer-modified-p buf) | |
757 | (setq file (file-name-nondirectory file)) | |
758 | (not (yes-or-no-p | |
759 | (format | |
760 | "File %s changed on disk. Discard your edits%s? " | |
761 | file | |
762 | (if (string= bufname file) "" | |
763 | (concat " in " bufname)))))) | |
764 | (progn | |
765 | (revert-buffer t t t) | |
766 | (pos-visible-in-window-p (point-max))))))) | |
ab7782fc RS |
767 | |
768 | (defun view-end-message () | |
769 | ;; Tell that we are at end of buffer. | |
770 | (goto-char (point-max)) | |
19d73313 RS |
771 | (if view-return-to-alist |
772 | (message "End of buffer. Type %s to quit viewing." | |
773 | (substitute-command-keys | |
774 | (if view-scroll-auto-exit "\\[View-scroll-page-forward]" | |
775 | "\\[View-quit]"))) | |
776 | (message "End of buffer"))) | |
ab7782fc RS |
777 | |
778 | (defun View-scroll-page-forward (&optional lines) | |
779 | "Scroll \"page size\" or prefix LINES lines forward in View mode. | |
e51f616f | 780 | Exit if end of text is visible and `view-scroll-auto-exit' is non-nil. |
ab7782fc RS |
781 | \"page size\" is whole window full, or number of lines set by |
782 | \\[View-scroll-page-forward-set-page-size] or | |
783 | \\[View-scroll-page-backward-set-page-size]. | |
784 | If LINES is more than a window-full, only the last window-full is shown." | |
e6211d55 | 785 | (interactive "P") |
ab7782fc RS |
786 | (view-scroll-lines lines nil view-page-size nil)) |
787 | ||
d1ed8492 | 788 | (defun View-scroll-page-backward (&optional lines) |
ab7782fc | 789 | "Scroll \"page size\" or prefix LINES lines backward in View mode. |
e51f616f | 790 | See also `View-scroll-page-forward'." |
e6211d55 | 791 | (interactive "P") |
ab7782fc RS |
792 | (view-scroll-lines lines t view-page-size nil)) |
793 | ||
794 | (defun View-scroll-page-forward-set-page-size (&optional lines) | |
e51f616f | 795 | "Scroll forward LINES lines in View mode, setting the \"page size\". |
ab7782fc | 796 | This is the number of lines which \\[View-scroll-page-forward] and |
66d3a2b5 RS |
797 | \\[View-scroll-page-backward] scroll by default. |
798 | If LINES is omitted or = 0, sets \"page size\" to window height and | |
799 | scrolls forward that much, otherwise scrolls forward LINES lines and sets | |
800 | \"page size\" to the minimum of window height and the absolute value of LINES. | |
e51f616f | 801 | See also `View-scroll-page-forward'." |
e6211d55 | 802 | (interactive "P") |
ab7782fc RS |
803 | (view-scroll-lines lines nil |
804 | (setq view-page-size (view-page-size-default lines)) | |
805 | nil)) | |
e6211d55 | 806 | |
ab7782fc RS |
807 | (defun View-scroll-page-backward-set-page-size (&optional lines) |
808 | "Scroll backward prefix LINES lines in View mode, setting the \"page size\". | |
e51f616f | 809 | See also `View-scroll-page-forward-set-page-size'." |
e6211d55 | 810 | (interactive "P") |
ab7782fc RS |
811 | (view-scroll-lines lines t |
812 | (setq view-page-size (view-page-size-default lines)) | |
813 | nil)) | |
814 | ||
815 | (defun View-scroll-line-forward (&optional lines) | |
816 | "Scroll forward one line (or prefix LINES lines) in View mode. | |
e51f616f | 817 | See also `View-scroll-page-forward,' but note that scrolling is limited |
ab7782fc RS |
818 | to minimum of LINES and one window-full." |
819 | (interactive "P") | |
820 | (view-scroll-lines lines nil 1 t)) | |
821 | ||
822 | (defun View-scroll-line-backward (&optional lines) | |
823 | "Scroll backward one line (or prefix LINES lines) in View mode. | |
e51f616f | 824 | See also `View-scroll-line-forward'." |
ab7782fc RS |
825 | (interactive "P") |
826 | (view-scroll-lines lines t 1 t)) | |
827 | ||
828 | (defun View-scroll-half-page-forward (&optional lines) | |
e51f616f | 829 | "Scroll forward a \"half page\" (or prefix LINES) lines in View mode. |
ab7782fc RS |
830 | If LINES is not omitted, the \"half page size\" is set to the minimum of |
831 | window height and the absolute value of LINES. | |
832 | LINES=0 resets \"half page size\" to half window height." | |
833 | (interactive "P") | |
834 | (view-scroll-lines lines nil (view-set-half-page-size-default lines) t)) | |
835 | ||
836 | (defun View-scroll-half-page-backward (&optional lines) | |
e51f616f RS |
837 | "Scroll backward a \"half page\" (or prefix LINES) lines in View mode. |
838 | See also `View-scroll-half-page-forward'." | |
ab7782fc RS |
839 | (interactive "P") |
840 | (view-scroll-lines lines t (view-set-half-page-size-default lines) t)) | |
841 | ||
e51f616f RS |
842 | (defun View-revert-buffer-scroll-page-forward (&optional lines) |
843 | "Scroll forward, reverting buffer if needed, in View mode. | |
ab7782fc RS |
844 | If buffer has not been changed and the corresponding file is newer, first |
845 | revert the buffer, then scroll. | |
846 | This command is useful if you are viewing a changing file. | |
e51f616f RS |
847 | |
848 | The prefix argument LINES says how many lines to scroll. | |
849 | If you don't specify a prefix argument, it uses the number of lines set by | |
ab7782fc RS |
850 | \\[View-scroll-page-forward-set-page-size] or |
851 | \\[View-scroll-page-backward-set-page-size]. | |
852 | If LINES is more than a window-full, only the last window-full is shown." | |
853 | (interactive "P") | |
5d9b78b7 | 854 | (let ((view-scroll-auto-exit nil) |
ab7782fc RS |
855 | (view-try-extend-at-buffer-end t)) |
856 | (view-scroll-lines lines nil view-page-size nil))) | |
857 | ||
858 | (defun View-back-to-mark (&optional ignore) | |
859 | "Return to last mark set in View mode, else beginning of file. | |
e51f616f RS |
860 | Display that line at the center of the window. |
861 | This command pops the mark ring, so that successive | |
ab7782fc RS |
862 | invocations return to earlier marks." |
863 | (interactive) | |
864 | (goto-char (or (mark t) (point-min))) | |
865 | (pop-mark) | |
866 | (view-recenter)) | |
867 | ||
5c05f569 | 868 | (defun View-search-regexp-forward (n regexp) |
ab7782fc | 869 | "Search forward for first (or prefix Nth) occurrence of REGEXP in View mode. |
66d3a2b5 RS |
870 | |
871 | Displays line found at center of window. Sets mark at starting position and | |
872 | pushes mark ring. | |
873 | ||
874 | Characters @ and ! are special at the beginning of REGEXP. They modify | |
875 | the search rather than become part of the pattern searched for. | |
876 | @ means search all the buffer i.e. start search at the beginning of buffer. | |
877 | ! means search for a line that contains no match for the pattern. | |
878 | If REGEXP is empty or only consist of these control characters, then | |
879 | an earlier remembered REGEXP is used, otherwise REGEXP is remembered | |
880 | for use by later search commands. | |
5534818b RS |
881 | |
882 | The variable `view-highlight-face' controls the face that is used | |
883 | for highlighting the match that is found." | |
d1ed8492 | 884 | (interactive "p\nsSearch forward (regexp): ") |
ab7782fc | 885 | (view-search n regexp)) |
e6211d55 | 886 | |
5c05f569 | 887 | (defun View-search-regexp-backward (n regexp) |
ab7782fc | 888 | "Search backward for first (or prefix Nth) occurrence of REGEXP in View mode. |
66d3a2b5 RS |
889 | |
890 | Displays line found at center of window. Sets mark at starting position and | |
891 | pushes mark ring. | |
892 | ||
893 | Characters @ and ! are special at the beginning of REGEXP. They modify | |
894 | the search rather than become part of the pattern searched for. | |
895 | @ means search all the buffer i.e. start search at the end of buffer. | |
896 | ! means search for a line that contains no match for the pattern. | |
897 | If REGEXP is empty or only consist of these control characters, then | |
898 | an earlier remembered REGEXP is used, otherwise REGEXP is remembered | |
899 | for use by later search commands. | |
5534818b RS |
900 | |
901 | The variable `view-highlight-face' controls the face that is used | |
902 | for highlighting the match that is found." | |
e6211d55 | 903 | (interactive "p\nsSearch backward (regexp): ") |
ab7782fc | 904 | (view-search (- n) regexp)) |
e6211d55 | 905 | |
ab7782fc RS |
906 | (defun View-search-last-regexp-forward (n) "\ |
907 | Search forward for first (or prefix Nth) instance of last regexp in View mode. | |
908 | Displays line found at center of window. Sets mark at starting position and | |
909 | pushes mark ring. | |
5534818b RS |
910 | |
911 | The variable `view-highlight-face' controls the face that is used | |
912 | for highlighting the match that is found." | |
e6211d55 | 913 | (interactive "p") |
ab7782fc | 914 | (view-search n nil)) |
e6211d55 | 915 | |
ab7782fc RS |
916 | (defun View-search-last-regexp-backward (n) "\ |
917 | Search backward for first (or prefix Nth) instance of last regexp in View mode. | |
e6211d55 | 918 | Displays line found at center of window. Sets mark at starting position and |
5534818b RS |
919 | pushes mark ring. |
920 | ||
921 | The variable `view-highlight-face' controls the face that is used | |
922 | for highlighting the match that is found." | |
e6211d55 | 923 | (interactive "p") |
ab7782fc | 924 | (view-search (- n) nil)) |
e6211d55 | 925 | |
e6211d55 | 926 | (defun view-search (times regexp) |
66d3a2b5 | 927 | ;; This function does the job for all the View-search- commands. |
cae55197 KH |
928 | ;; Search for the TIMESt match for REGEXP. If TIMES is negative |
929 | ;; search backwards. If REGEXP is nil use `view-last-regexp'. | |
930 | ;; Charcters "!" and "@" have a special meaning at the beginning of | |
931 | ;; REGEXP and are removed from REGEXP before the search "!" means | |
932 | ;; search for lines with no match for REGEXP. "@" means search in | |
933 | ;; the whole buffer, don't start searching from the present point. | |
ab7782fc RS |
934 | (let (where no end ln) |
935 | (cond | |
936 | ((and regexp (> (length regexp) 0) | |
937 | (or (not (memq (string-to-char regexp) '(?! ?@))) | |
938 | (progn | |
939 | (if (member (substring regexp 0 2) '("!@" "@!")) | |
940 | (setq end t no t ln 2) | |
941 | (setq no (not (setq end (eq ?@ (string-to-char regexp)))) | |
942 | ln 1)) | |
943 | (> (length (setq regexp (substring regexp ln))) 0)))) | |
944 | (setq view-last-regexp (if no (list regexp) regexp))) | |
945 | ((consp view-last-regexp) | |
946 | (setq regexp (car view-last-regexp)) | |
cae55197 | 947 | (unless (setq no (not no)) (setq view-last-regexp regexp))) |
ab7782fc RS |
948 | (view-last-regexp (setq regexp view-last-regexp) |
949 | (if no (setq view-last-regexp (list regexp)))) | |
950 | (t (error "No previous View-mode search"))) | |
e6211d55 | 951 | (save-excursion |
ab7782fc RS |
952 | (if end (goto-char (if (< times 0) (point-max) (point-min))) |
953 | (move-to-window-line (if (< times 0) 0 -1))) | |
954 | (if (if no (view-search-no-match-lines times regexp) | |
955 | (re-search-forward regexp nil t times)) | |
e6211d55 RS |
956 | (setq where (point)))) |
957 | (if where | |
958 | (progn | |
959 | (push-mark) | |
960 | (goto-char where) | |
4fe11426 RS |
961 | (if view-overlay |
962 | (move-overlay view-overlay (match-beginning 0) (match-end 0)) | |
963 | (setq view-overlay | |
964 | (make-overlay (match-beginning 0) (match-end 0)))) | |
82380f84 | 965 | (overlay-put view-overlay 'face view-highlight-face) |
e6211d55 | 966 | (beginning-of-line) |
ab7782fc RS |
967 | (view-recenter)) |
968 | (message "Can't find occurrence %d of %s%s" | |
969 | times (if no "no " "") regexp) | |
e6211d55 RS |
970 | (sit-for 4)))) |
971 | ||
ab7782fc RS |
972 | (defun view-search-no-match-lines (times regexp) |
973 | ;; Search for the TIMESt occurrence of line with no match for REGEXP. | |
974 | (let ((back (and (< times 0) (setq times (- times)) -1)) | |
975 | n) | |
976 | (while (> times 0) | |
977 | (save-excursion (beginning-of-line (if back (- times) (1+ times))) | |
978 | (setq n (point))) | |
979 | (setq times | |
980 | (cond | |
981 | ((< (count-lines (point) n) times) -1) ; Not enough lines. | |
982 | ((or (null (re-search-forward regexp nil t back)) | |
983 | (if back (and (< (match-end 0) n) | |
984 | (> (count-lines (match-end 0) n) 1)) | |
985 | (and (< n (match-beginning 0)) | |
986 | (> (count-lines n (match-beginning 0)) 1)))) | |
987 | 0) ; No match within lines. | |
988 | (back (count-lines (max n (match-beginning 0)) (match-end 0))) | |
989 | (t (count-lines (match-beginning 0) (min n (match-end 0)))))) | |
990 | (goto-char n)) | |
991 | (and (zerop times) (looking-at "^.*$")))) | |
992 | ||
993 | ||
49116ac0 JB |
994 | (provide 'view) |
995 | ||
d501f516 | 996 | ;;; view.el ends here |