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