Mercurial > emacs
annotate lisp/view.el @ 13896:d23e1ac7b432
Doc fixes.
(ff-get-file): Use get-file-buffer to avoid false match.
(ff-switch-to-buffer): Rename arg FILE to BUFFER-OR-NAME.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Sun, 31 Dec 1995 00:10:18 +0000 |
parents | ee453099e188 |
children | 83f275dcd93a |
rev | line source |
---|---|
657
fec3f9a1e3e5
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
584
diff
changeset
|
1 ;;; view.el --- peruse file or buffer without editing. |
fec3f9a1e3e5
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
584
diff
changeset
|
2 |
12856 | 3 ;; Copyright (C) 1985, 1989, 1994, 1995 Free Software Foundation, Inc. |
840
113281b361ec
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
807
diff
changeset
|
4 |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
657
diff
changeset
|
5 ;; Author: K. Shane Hartman |
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
657
diff
changeset
|
6 ;; Maintainer: FSF |
44 | 7 |
8 ;; This file is part of GNU Emacs. | |
9 | |
10 ;; GNU Emacs is free software; you can redistribute it and/or modify | |
11 ;; it under the terms of the GNU General Public License as published by | |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
657
diff
changeset
|
12 ;; the Free Software Foundation; either version 2, or (at your option) |
44 | 13 ;; any later version. |
14 | |
15 ;; GNU Emacs is distributed in the hope that it will be useful, | |
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
18 ;; GNU General Public License for more details. | |
19 | |
20 ;; You should have received a copy of the GNU General Public License | |
21 ;; along with GNU Emacs; see the file COPYING. If not, write to | |
22 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. | |
23 | |
2319
d98c49df2acd
Added or corrected Commentary section
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
931
diff
changeset
|
24 ;;; Commentary: |
d98c49df2acd
Added or corrected Commentary section
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
931
diff
changeset
|
25 |
12856 | 26 ;; This package provides the `view' minor mode documented in the Emacs |
2319
d98c49df2acd
Added or corrected Commentary section
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
931
diff
changeset
|
27 ;; user's manual. |
d98c49df2acd
Added or corrected Commentary section
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
931
diff
changeset
|
28 |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
657
diff
changeset
|
29 ;;; Code: |
44 | 30 |
13167
c378e215f4d0
(view-highlight-face): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
13158
diff
changeset
|
31 ;;;###autoload |
c378e215f4d0
(view-highlight-face): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
13158
diff
changeset
|
32 (defvar view-highlight-face 'highlight |
c378e215f4d0
(view-highlight-face): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
13158
diff
changeset
|
33 "*The overlay face used for highlighting the match found by View mode search.") |
c378e215f4d0
(view-highlight-face): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
13158
diff
changeset
|
34 |
13078
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
35 (defvar view-mode nil "Non-nil if View mode is enabled.") |
12856 | 36 (make-variable-buffer-local 'view-mode) |
37 | |
13078
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
38 (defvar view-mode-auto-exit nil |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
39 "Non-nil means scrolling past the end of buffer exits View mode.") |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
40 (make-variable-buffer-local 'view-mode-auto-exit) |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
41 |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
42 (defvar view-old-buffer-read-only nil) |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
43 (make-variable-buffer-local 'view-old-buffer-read-only) |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
44 (defvar view-old-Helper-return-blurb) |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
45 (make-variable-buffer-local 'view-old-Helper-return-blurb) |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
46 |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
47 (defvar view-scroll-size nil) |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
48 (make-variable-buffer-local 'view-scroll-size) |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
49 |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
50 (defvar view-last-regexp nil) |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
51 (make-variable-buffer-local 'view-last-regexp) |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
52 |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
53 (defvar view-exit-action nil) |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
54 (make-variable-buffer-local 'view-exit-action) |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
55 (defvar view-return-here nil) |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
56 (make-variable-buffer-local 'view-return-here) |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
57 (defvar view-exit-position nil) |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
58 (make-variable-buffer-local 'view-exit-position) |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
59 |
13122
05bae277596e
(View-search-regexp-forward, View-search-regexp-backward):
Richard M. Stallman <rms@gnu.org>
parents:
13078
diff
changeset
|
60 (defvar view-overlay nil |
13167
c378e215f4d0
(view-highlight-face): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
13158
diff
changeset
|
61 "Overlay used to display where a search operation found its match. |
c378e215f4d0
(view-highlight-face): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
13158
diff
changeset
|
62 This is local in each buffer, once it is used.") |
13122
05bae277596e
(View-search-regexp-forward, View-search-regexp-backward):
Richard M. Stallman <rms@gnu.org>
parents:
13078
diff
changeset
|
63 (make-variable-buffer-local 'view-overlay) |
05bae277596e
(View-search-regexp-forward, View-search-regexp-backward):
Richard M. Stallman <rms@gnu.org>
parents:
13078
diff
changeset
|
64 |
12856 | 65 (or (assq 'view-mode minor-mode-alist) |
66 (setq minor-mode-alist | |
67 (cons '(view-mode " View") minor-mode-alist))) | |
68 | |
44 | 69 (defvar view-mode-map nil) |
70 (if view-mode-map | |
71 nil | |
72 (setq view-mode-map (make-keymap)) | |
12856 | 73 (suppress-keymap view-mode-map) |
44 | 74 (define-key view-mode-map "q" 'view-exit) |
75 (define-key view-mode-map "<" 'beginning-of-buffer) | |
76 (define-key view-mode-map ">" 'end-of-buffer) | |
77 (define-key view-mode-map "\ev" 'View-scroll-lines-backward) | |
78 (define-key view-mode-map "\C-v" 'View-scroll-lines-forward) | |
79 (define-key view-mode-map " " 'View-scroll-lines-forward) | |
12856 | 80 (define-key view-mode-map "\C-?" 'View-scroll-lines-backward) |
44 | 81 (define-key view-mode-map "\n" 'View-scroll-one-more-line) |
82 (define-key view-mode-map "\r" 'View-scroll-one-more-line) | |
83 (define-key view-mode-map "z" 'View-scroll-lines-forward-set-scroll-size) | |
84 (define-key view-mode-map "g" 'View-goto-line) | |
85 (define-key view-mode-map "=" 'what-line) | |
86 (define-key view-mode-map "." 'set-mark-command) | |
87 (define-key view-mode-map "'" 'View-back-to-mark) | |
88 (define-key view-mode-map "@" 'View-back-to-mark) | |
89 (define-key view-mode-map "x" 'exchange-point-and-mark) | |
13640
ee453099e188
(view-mode, view-mode-enter): Doc changes.
Richard M. Stallman <rms@gnu.org>
parents:
13639
diff
changeset
|
90 (define-key view-mode-map "h" 'describe-mode) |
ee453099e188
(view-mode, view-mode-enter): Doc changes.
Richard M. Stallman <rms@gnu.org>
parents:
13639
diff
changeset
|
91 (define-key view-mode-map "?" 'describe-mode) |
44 | 92 (define-key view-mode-map "s" 'isearch-forward) |
93 (define-key view-mode-map "r" 'isearch-backward) | |
94 (define-key view-mode-map "/" 'View-search-regexp-forward) | |
95 (define-key view-mode-map "\\" 'View-search-regexp-backward) | |
96 ;; This conflicts with the standard binding of isearch-regexp-forward | |
97 (define-key view-mode-map "\e\C-s" 'View-search-regexp-forward) | |
98 (define-key view-mode-map "\e\C-r" 'View-search-regexp-backward) | |
99 (define-key view-mode-map "n" 'View-search-last-regexp-forward) | |
100 (define-key view-mode-map "p" 'View-search-last-regexp-backward) | |
101 ) | |
102 | |
13078
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
103 (or (assq 'view-mode minor-mode-map-alist) |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
104 (setq minor-mode-map-alist |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
105 (cons (cons 'view-mode view-mode-map) minor-mode-map-alist))) |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
106 |
44 | 107 |
256 | 108 ;;;###autoload |
44 | 109 (defun view-file (file-name) |
110 "View FILE in View mode, returning to previous buffer when done. | |
111 The usual Emacs commands are not available; instead, | |
112 a special set of commands (mostly letters and punctuation) | |
113 are defined for moving around in the buffer. | |
114 Space scrolls forward, Delete scrolls backward. | |
115 For list of all View commands, type ? or h while viewing. | |
116 | |
6330
3badf836d51d
(view-mode): Run view-mode-hook as well as view-hook.
Richard M. Stallman <rms@gnu.org>
parents:
5123
diff
changeset
|
117 This command runs the normal hook `view-mode-hook'." |
44 | 118 (interactive "fView file: ") |
119 (let ((old-buf (current-buffer)) | |
120 (had-a-buf (get-file-buffer file-name)) | |
121 (buf-to-view (find-file-noselect file-name))) | |
12390
598490dfbed5
(view-file-other-window): Re-add missing argument to
Richard M. Stallman <rms@gnu.org>
parents:
9640
diff
changeset
|
122 ;; This used to pass t as second argument, |
598490dfbed5
(view-file-other-window): Re-add missing argument to
Richard M. Stallman <rms@gnu.org>
parents:
9640
diff
changeset
|
123 ;; but then the buffer did not show up in the Buffers menu. |
9640
7f70a4773d5e
(view-file): Do record the buffer switch.
Richard M. Stallman <rms@gnu.org>
parents:
7300
diff
changeset
|
124 (switch-to-buffer buf-to-view had-a-buf) |
13078
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
125 (view-mode-enter old-buf |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
126 (and (not had-a-buf) (not (buffer-modified-p buf-to-view)) |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
127 'kill-buffer)))) |
44 | 128 |
256 | 129 ;;;###autoload |
354 | 130 (defun view-file-other-window (file-name) |
131 "View FILE in View mode in other window. | |
132 Return to previous buffer when done. | |
133 The usual Emacs commands are not available; instead, | |
134 a special set of commands (mostly letters and punctuation) | |
135 are defined for moving around in the buffer. | |
136 Space scrolls forward, Delete scrolls backward. | |
137 For list of all View commands, type ? or h while viewing. | |
138 | |
6330
3badf836d51d
(view-mode): Run view-mode-hook as well as view-hook.
Richard M. Stallman <rms@gnu.org>
parents:
5123
diff
changeset
|
139 This command runs the normal hook `view-mode-hook'." |
354 | 140 (interactive "fView file: ") |
141 (let ((old-arrangement (current-window-configuration)) | |
142 (had-a-buf (get-file-buffer file-name)) | |
143 (buf-to-view (find-file-noselect file-name))) | |
12390
598490dfbed5
(view-file-other-window): Re-add missing argument to
Richard M. Stallman <rms@gnu.org>
parents:
9640
diff
changeset
|
144 (switch-to-buffer-other-window buf-to-view) |
13078
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
145 (view-mode-enter old-arrangement |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
146 (and (not had-a-buf) (not (buffer-modified-p buf-to-view)) |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
147 'kill-buffer)))) |
354 | 148 |
149 ;;;###autoload | |
44 | 150 (defun view-buffer (buffer-name) |
151 "View BUFFER in View mode, returning to previous buffer when done. | |
152 The usual Emacs commands are not available; instead, | |
153 a special set of commands (mostly letters and punctuation) | |
154 are defined for moving around in the buffer. | |
155 Space scrolls forward, Delete scrolls backward. | |
156 For list of all View commands, type ? or h while viewing. | |
157 | |
6330
3badf836d51d
(view-mode): Run view-mode-hook as well as view-hook.
Richard M. Stallman <rms@gnu.org>
parents:
5123
diff
changeset
|
158 This command runs the normal hook `view-mode-hook'." |
44 | 159 (interactive "bView buffer: ") |
160 (let ((old-buf (current-buffer))) | |
161 (switch-to-buffer buffer-name t) | |
13078
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
162 (view-mode-enter old-buf nil))) |
44 | 163 |
256 | 164 ;;;###autoload |
354 | 165 (defun view-buffer-other-window (buffer-name not-return) |
12856 | 166 "View BUFFER in View mode in another window. |
167 Return to previous buffer when done, unless NOT-RETURN is non-nil. | |
4119
7b1b2a8d05f2
Doc fixes; some args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
3450
diff
changeset
|
168 |
7b1b2a8d05f2
Doc fixes; some args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
3450
diff
changeset
|
169 The usual Emacs commands are not available in View mode; instead, |
354 | 170 a special set of commands (mostly letters and punctuation) |
171 are defined for moving around in the buffer. | |
172 Space scrolls forward, Delete scrolls backward. | |
173 For list of all View commands, type ? or h while viewing. | |
174 | |
6330
3badf836d51d
(view-mode): Run view-mode-hook as well as view-hook.
Richard M. Stallman <rms@gnu.org>
parents:
5123
diff
changeset
|
175 This command runs the normal hook `view-mode-hook'." |
2444
5a563f113d6a
(view-buffer-other-window): Remove spurious backslashes from
Roland McGrath <roland@gnu.org>
parents:
2443
diff
changeset
|
176 (interactive "bView buffer:\nP") |
354 | 177 (let ((return-to (and not-return (current-window-configuration)))) |
178 (switch-to-buffer-other-window buffer-name) | |
13078
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
179 (view-mode-enter return-to))) |
354 | 180 |
181 ;;;###autoload | |
13078
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
182 (defun view-mode (&optional arg) |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
183 "Toggle View mode. |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
184 If you use this function to turn on View mode, |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
185 \"exiting\" View mode does nothing except turn View mode off. |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
186 The other way to turn View mode on is by calling |
13640
ee453099e188
(view-mode, view-mode-enter): Doc changes.
Richard M. Stallman <rms@gnu.org>
parents:
13639
diff
changeset
|
187 `view-mode-enter'. |
13078
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
188 |
44 | 189 Letters do not insert themselves. Instead these commands are provided. |
190 Most commands take prefix arguments. Commands dealing with lines | |
191 default to \"scroll size\" lines (initially size of window). | |
192 Search commands default to a repeat count of one. | |
13640
ee453099e188
(view-mode, view-mode-enter): Doc changes.
Richard M. Stallman <rms@gnu.org>
parents:
13639
diff
changeset
|
193 |
44 | 194 M-< or < move to beginning of buffer. |
195 M-> or > move to end of buffer. | |
196 C-v or Space scroll forward lines. | |
197 M-v or DEL scroll backward lines. | |
198 CR or LF scroll forward one line (backward with prefix argument). | |
199 z like Space except set number of lines for further | |
200 scrolling commands to scroll by. | |
201 C-u and Digits provide prefix arguments. `-' denotes negative argument. | |
202 = prints the current line number. | |
203 g goes to line given by prefix argument. | |
204 / or M-C-s searches forward for regular expression | |
205 \\ or M-C-r searches backward for regular expression. | |
206 n searches forward for last regular expression. | |
207 p searches backward for last regular expression. | |
208 C-@ or . set the mark. | |
209 x exchanges point and mark. | |
210 C-s or s do forward incremental search. | |
211 C-r or r do reverse incremental search. | |
212 @ or ' return to mark and pops mark ring. | |
213 Mark ring is pushed at start of every | |
214 successful search and when jump to line to occurs. | |
215 The mark is set on jump to buffer start or end. | |
216 ? or h provide help message (list of commands). | |
13639
50d31efc8e72
(view-mode-enter): Replace Help-helper by help-command
Richard M. Stallman <rms@gnu.org>
parents:
13538
diff
changeset
|
217 \\[help-command] provides help (list of commands or description of a command). |
44 | 218 C-n moves down lines vertically. |
219 C-p moves upward lines vertically. | |
220 C-l recenters the screen. | |
13640
ee453099e188
(view-mode, view-mode-enter): Doc changes.
Richard M. Stallman <rms@gnu.org>
parents:
13639
diff
changeset
|
221 q exit view-mode and return to previous buffer." |
ee453099e188
(view-mode, view-mode-enter): Doc changes.
Richard M. Stallman <rms@gnu.org>
parents:
13639
diff
changeset
|
222 (interactive "P") |
ee453099e188
(view-mode, view-mode-enter): Doc changes.
Richard M. Stallman <rms@gnu.org>
parents:
13639
diff
changeset
|
223 (setq view-mode |
ee453099e188
(view-mode, view-mode-enter): Doc changes.
Richard M. Stallman <rms@gnu.org>
parents:
13639
diff
changeset
|
224 (if (null arg) |
ee453099e188
(view-mode, view-mode-enter): Doc changes.
Richard M. Stallman <rms@gnu.org>
parents:
13639
diff
changeset
|
225 (not view-mode) |
ee453099e188
(view-mode, view-mode-enter): Doc changes.
Richard M. Stallman <rms@gnu.org>
parents:
13639
diff
changeset
|
226 (> (prefix-numeric-value arg) 0))) |
ee453099e188
(view-mode, view-mode-enter): Doc changes.
Richard M. Stallman <rms@gnu.org>
parents:
13639
diff
changeset
|
227 (force-mode-line-update)) |
ee453099e188
(view-mode, view-mode-enter): Doc changes.
Richard M. Stallman <rms@gnu.org>
parents:
13639
diff
changeset
|
228 |
ee453099e188
(view-mode, view-mode-enter): Doc changes.
Richard M. Stallman <rms@gnu.org>
parents:
13639
diff
changeset
|
229 (defun view-mode-enter (&optional prev-buffer action) |
ee453099e188
(view-mode, view-mode-enter): Doc changes.
Richard M. Stallman <rms@gnu.org>
parents:
13639
diff
changeset
|
230 "Enter View mode, a Minor mode for viewing text but not editing it. |
ee453099e188
(view-mode, view-mode-enter): Doc changes.
Richard M. Stallman <rms@gnu.org>
parents:
13639
diff
changeset
|
231 See the function `view-mode' for more details. |
44 | 232 |
13078
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
233 This function runs the normal hook `view-mode-hook'. |
4119
7b1b2a8d05f2
Doc fixes; some args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
3450
diff
changeset
|
234 |
44 | 235 \\{view-mode-map}" |
236 ; Not interactive because dangerous things happen | |
237 ; if you call it without passing a buffer as argument | |
238 ; and they are not easy to fix. | |
239 ; (interactive) | |
240 (setq view-old-buffer-read-only buffer-read-only) | |
241 (setq view-old-Helper-return-blurb | |
242 (and (boundp 'Helper-return-blurb) Helper-return-blurb)) | |
243 | |
13078
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
244 ;; Enable view-exit to make use of the data we just saved |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
245 ;; and to perform the exit action. |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
246 (setq view-mode-auto-exit t) |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
247 |
44 | 248 (setq buffer-read-only t) |
12856 | 249 (setq view-mode t) |
44 | 250 (setq Helper-return-blurb |
251 (format "continue viewing %s" | |
252 (if (buffer-file-name) | |
253 (file-name-nondirectory (buffer-file-name)) | |
254 (buffer-name)))) | |
255 | |
256 (setq view-exit-action action) | |
354 | 257 (setq view-return-here prev-buffer) |
44 | 258 (setq view-exit-position (point-marker)) |
259 | |
260 (beginning-of-line) | |
261 (setq goal-column nil) | |
262 | |
12856 | 263 (run-hooks 'view-mode-hook) |
264 (message | |
265 (substitute-command-keys | |
13640
ee453099e188
(view-mode, view-mode-enter): Doc changes.
Richard M. Stallman <rms@gnu.org>
parents:
13639
diff
changeset
|
266 "Type \\[help-command] for help, \\[describe-mode] for commands, \\[view-exit] to quit."))) |
354 | 267 |
44 | 268 (defun view-exit () |
269 "Exit from view-mode. | |
270 If you viewed an existing buffer, that buffer returns to its previous mode. | |
271 If you viewed a file that was not present in Emacs, its buffer is killed." | |
272 (interactive) | |
13078
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
273 (setq view-mode nil) |
13158
02b3310fc081
(view-exit): Delete view-overlay only if it exists.
Erik Naggum <erik@naggum.no>
parents:
13123
diff
changeset
|
274 (and view-overlay (delete-overlay view-overlay)) |
13078
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
275 (force-mode-line-update) |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
276 (cond (view-mode-auto-exit |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
277 (setq buffer-read-only view-old-buffer-read-only) |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
278 (setq view-mode-auto-exit nil) |
44 | 279 |
13078
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
280 (goto-char view-exit-position) |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
281 (set-marker view-exit-position nil) |
44 | 282 |
13078
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
283 ;; Now do something to the buffer that we were viewing |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
284 ;; (such as kill it). |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
285 (let ((viewed-buffer (current-buffer)) |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
286 (action view-exit-action)) |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
287 (cond |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
288 ((bufferp view-return-here) |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
289 (switch-to-buffer view-return-here)) |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
290 ((window-configuration-p view-return-here) |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
291 (set-window-configuration view-return-here))) |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
292 (if action (funcall action viewed-buffer)))))) |
44 | 293 |
294 (defun view-window-size () (1- (window-height))) | |
295 | |
296 (defun view-scroll-size () | |
297 (min (view-window-size) (or view-scroll-size (view-window-size)))) | |
298 | |
6330
3badf836d51d
(view-mode): Run view-mode-hook as well as view-hook.
Richard M. Stallman <rms@gnu.org>
parents:
5123
diff
changeset
|
299 (defvar view-mode-hook nil |
3badf836d51d
(view-mode): Run view-mode-hook as well as view-hook.
Richard M. Stallman <rms@gnu.org>
parents:
5123
diff
changeset
|
300 "Normal hook run when starting to view a buffer or file.") |
3badf836d51d
(view-mode): Run view-mode-hook as well as view-hook.
Richard M. Stallman <rms@gnu.org>
parents:
5123
diff
changeset
|
301 |
44 | 302 ;(defun view-last-command (&optional who what) |
303 ; (setq view-last-command-entry this-command) | |
304 ; (setq view-last-command who) | |
305 ; (setq view-last-command-argument what)) | |
306 | |
307 ;(defun View-repeat-last-command () | |
308 ; "Repeat last command issued in View mode." | |
309 ; (interactive) | |
310 ; (if (and view-last-command | |
311 ; (eq view-last-command-entry last-command)) | |
312 ; (funcall view-last-command view-last-command-argument)) | |
313 ; (setq this-command view-last-command-entry)) | |
314 | |
12856 | 315 (defun View-goto-line (line) |
4119
7b1b2a8d05f2
Doc fixes; some args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
3450
diff
changeset
|
316 "Move to line LINE in View mode. |
44 | 317 Display is centered at LINE. Sets mark at starting position and pushes |
318 mark ring." | |
319 (interactive "p") | |
320 (push-mark) | |
12856 | 321 (goto-line line) |
44 | 322 (recenter (/ (view-window-size) 2))) |
323 | |
324 (defun View-scroll-lines-forward (&optional lines) | |
325 "Scroll forward in View mode, or exit if end of text is visible. | |
326 No arg means whole window full, or number of lines set by \\[View-scroll-lines-forward-set-scroll-size]. | |
327 Arg is number of lines to scroll." | |
328 (interactive "P") | |
12856 | 329 (setq lines |
330 (if lines (prefix-numeric-value lines) | |
331 (view-scroll-size))) | |
5123
4bf8c101aaef
(View-scroll-lines-forward):
Richard M. Stallman <rms@gnu.org>
parents:
4119
diff
changeset
|
332 (if (and (pos-visible-in-window-p (point-max)) |
4bf8c101aaef
(View-scroll-lines-forward):
Richard M. Stallman <rms@gnu.org>
parents:
4119
diff
changeset
|
333 ;; Allow scrolling backward at the end of the buffer. |
13078
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
334 (> lines 0) |
d7735534db86
(view-mode-enter): Renamed from view-mode. Callers changed.
Richard M. Stallman <rms@gnu.org>
parents:
12857
diff
changeset
|
335 view-mode-auto-exit) |
3450
89cd5536ee81
(View-scroll-lines-forward): If we exit, do nothing else.
Richard M. Stallman <rms@gnu.org>
parents:
2444
diff
changeset
|
336 (view-exit) |
89cd5536ee81
(View-scroll-lines-forward): If we exit, do nothing else.
Richard M. Stallman <rms@gnu.org>
parents:
2444
diff
changeset
|
337 ;; (view-last-command 'View-scroll-lines-forward lines) |
89cd5536ee81
(View-scroll-lines-forward): If we exit, do nothing else.
Richard M. Stallman <rms@gnu.org>
parents:
2444
diff
changeset
|
338 (if (>= lines (view-window-size)) |
89cd5536ee81
(View-scroll-lines-forward): If we exit, do nothing else.
Richard M. Stallman <rms@gnu.org>
parents:
2444
diff
changeset
|
339 (scroll-up nil) |
89cd5536ee81
(View-scroll-lines-forward): If we exit, do nothing else.
Richard M. Stallman <rms@gnu.org>
parents:
2444
diff
changeset
|
340 (if (>= (- lines) (view-window-size)) |
89cd5536ee81
(View-scroll-lines-forward): If we exit, do nothing else.
Richard M. Stallman <rms@gnu.org>
parents:
2444
diff
changeset
|
341 (scroll-down nil) |
89cd5536ee81
(View-scroll-lines-forward): If we exit, do nothing else.
Richard M. Stallman <rms@gnu.org>
parents:
2444
diff
changeset
|
342 (scroll-up lines))) |
89cd5536ee81
(View-scroll-lines-forward): If we exit, do nothing else.
Richard M. Stallman <rms@gnu.org>
parents:
2444
diff
changeset
|
343 (cond ((pos-visible-in-window-p (point-max)) |
89cd5536ee81
(View-scroll-lines-forward): If we exit, do nothing else.
Richard M. Stallman <rms@gnu.org>
parents:
2444
diff
changeset
|
344 (goto-char (point-max)) |
89cd5536ee81
(View-scroll-lines-forward): If we exit, do nothing else.
Richard M. Stallman <rms@gnu.org>
parents:
2444
diff
changeset
|
345 (message (substitute-command-keys |
89cd5536ee81
(View-scroll-lines-forward): If we exit, do nothing else.
Richard M. Stallman <rms@gnu.org>
parents:
2444
diff
changeset
|
346 "End. Type \\[view-exit] to quit viewing.")))) |
89cd5536ee81
(View-scroll-lines-forward): If we exit, do nothing else.
Richard M. Stallman <rms@gnu.org>
parents:
2444
diff
changeset
|
347 (move-to-window-line -1) |
89cd5536ee81
(View-scroll-lines-forward): If we exit, do nothing else.
Richard M. Stallman <rms@gnu.org>
parents:
2444
diff
changeset
|
348 (beginning-of-line))) |
44 | 349 |
350 (defun View-scroll-lines-forward-set-scroll-size (&optional lines) | |
351 "Scroll forward LINES lines in View mode, setting the \"scroll size\". | |
352 This is the number of lines which \\[View-scroll-lines-forward] and \\[View-scroll-lines-backward] scroll by default. | |
353 The absolute value of LINES is used, so this command can be used to scroll | |
354 backwards (but \"scroll size\" is always positive). If LINES is greater than | |
355 window height or omitted, then window height is assumed. If LINES is less | |
356 than window height then scrolling context is provided from previous screen." | |
357 (interactive "P") | |
358 (if (not lines) | |
359 (setq view-scroll-size (view-window-size)) | |
360 (setq lines (prefix-numeric-value lines)) | |
361 (setq view-scroll-size | |
362 (min (if (> lines 0) lines (- lines)) (view-window-size)))) | |
363 (View-scroll-lines-forward lines)) | |
364 | |
365 (defun View-scroll-one-more-line (&optional arg) | |
366 "Scroll one more line up in View mode. | |
367 With ARG scroll one line down." | |
368 (interactive "P") | |
369 (View-scroll-lines-forward (if (not arg) 1 -1))) | |
370 | |
371 (defun View-scroll-lines-backward (&optional lines) | |
372 "Scroll backward in View mode. | |
373 No arg means whole window full, or number of lines set by \\[View-scroll-lines-forward-set-scroll-size]. | |
374 Arg is number of lines to scroll." | |
375 (interactive "P") | |
376 (View-scroll-lines-forward (if lines | |
377 (- (prefix-numeric-value lines)) | |
378 (- (view-scroll-size))))) | |
379 | |
4119
7b1b2a8d05f2
Doc fixes; some args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
3450
diff
changeset
|
380 (defun View-search-regexp-forward (n regexp) |
7b1b2a8d05f2
Doc fixes; some args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
3450
diff
changeset
|
381 "Search forward for Nth occurrence of REGEXP. |
44 | 382 Displays line found at center of window. REGEXP is remembered for |
13168 | 383 searching with \\[View-search-last-regexp-forward] and \\[View-search-last-regexp-backward]. Sets mark at starting position and pushes mark ring. |
384 | |
385 The variable `view-highlight-face' controls the face that is used | |
386 for highlighting the match that is found." | |
44 | 387 (interactive "p\nsSearch forward (regexp): ") |
13122
05bae277596e
(View-search-regexp-forward, View-search-regexp-backward):
Richard M. Stallman <rms@gnu.org>
parents:
13078
diff
changeset
|
388 ;;;(view-last-command 'View-search-last-regexp-forward n) |
13123
e712a11f25a0
Fix typo in prev change.
Richard M. Stallman <rms@gnu.org>
parents:
13122
diff
changeset
|
389 (view-search n (if (equal regexp "") view-last-regexp regexp))) |
44 | 390 |
4119
7b1b2a8d05f2
Doc fixes; some args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
3450
diff
changeset
|
391 (defun View-search-regexp-backward (n regexp) |
7b1b2a8d05f2
Doc fixes; some args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
3450
diff
changeset
|
392 "Search backward from window start for Nth instance of REGEXP. |
44 | 393 Displays line found at center of window. REGEXP is remembered for |
13168 | 394 searching with \\[View-search-last-regexp-forward] and \\[View-search-last-regexp-backward]. Sets mark at starting position and pushes mark ring. |
395 | |
396 The variable `view-highlight-face' controls the face that is used | |
397 for highlighting the match that is found." | |
44 | 398 (interactive "p\nsSearch backward (regexp): ") |
13122
05bae277596e
(View-search-regexp-forward, View-search-regexp-backward):
Richard M. Stallman <rms@gnu.org>
parents:
13078
diff
changeset
|
399 (View-search-regexp-forward (- n) |
05bae277596e
(View-search-regexp-forward, View-search-regexp-backward):
Richard M. Stallman <rms@gnu.org>
parents:
13078
diff
changeset
|
400 (if (equal regexp "") view-last-regexp regexp))) |
44 | 401 |
4119
7b1b2a8d05f2
Doc fixes; some args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
3450
diff
changeset
|
402 (defun View-search-last-regexp-forward (n) |
7b1b2a8d05f2
Doc fixes; some args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
3450
diff
changeset
|
403 "Search forward from window end for Nth instance of last regexp. |
44 | 404 Displays line found at center of window. Sets mark at starting position |
13168 | 405 and pushes mark ring. |
406 | |
407 The variable `view-highlight-face' controls the face that is used | |
408 for highlighting the match that is found." | |
44 | 409 (interactive "p") |
4119
7b1b2a8d05f2
Doc fixes; some args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
3450
diff
changeset
|
410 (View-search-regexp-forward n view-last-regexp)) |
44 | 411 |
4119
7b1b2a8d05f2
Doc fixes; some args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
3450
diff
changeset
|
412 (defun View-search-last-regexp-backward (n) |
7b1b2a8d05f2
Doc fixes; some args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
3450
diff
changeset
|
413 "Search backward from window start for Nth instance of last regexp. |
44 | 414 Displays line found at center of window. Sets mark at starting position and |
13168 | 415 pushes mark ring. |
416 | |
417 The variable `view-highlight-face' controls the face that is used | |
418 for highlighting the match that is found." | |
44 | 419 (interactive "p") |
4119
7b1b2a8d05f2
Doc fixes; some args renamed.
Richard M. Stallman <rms@gnu.org>
parents:
3450
diff
changeset
|
420 (View-search-regexp-backward n view-last-regexp)) |
44 | 421 |
422 (defun View-back-to-mark (&optional ignore) | |
423 "Return to last mark set in View mode, else beginning of file. | |
424 Displays line at center of window. Pops mark ring so successive | |
425 invocations return to earlier marks." | |
426 (interactive) | |
12856 | 427 (goto-char (or (mark t) (point-min))) |
44 | 428 (pop-mark) |
429 (recenter (/ (view-window-size) 2))) | |
430 | |
431 (defun view-search (times regexp) | |
432 (setq view-last-regexp regexp) | |
433 (let (where) | |
434 (save-excursion | |
435 (move-to-window-line (if (< times 0) 0 -1)) | |
436 (if (re-search-forward regexp nil t times) | |
437 (setq where (point)))) | |
438 (if where | |
439 (progn | |
440 (push-mark) | |
441 (goto-char where) | |
13122
05bae277596e
(View-search-regexp-forward, View-search-regexp-backward):
Richard M. Stallman <rms@gnu.org>
parents:
13078
diff
changeset
|
442 (if view-overlay |
05bae277596e
(View-search-regexp-forward, View-search-regexp-backward):
Richard M. Stallman <rms@gnu.org>
parents:
13078
diff
changeset
|
443 (move-overlay view-overlay (match-beginning 0) (match-end 0)) |
05bae277596e
(View-search-regexp-forward, View-search-regexp-backward):
Richard M. Stallman <rms@gnu.org>
parents:
13078
diff
changeset
|
444 (setq view-overlay |
05bae277596e
(View-search-regexp-forward, View-search-regexp-backward):
Richard M. Stallman <rms@gnu.org>
parents:
13078
diff
changeset
|
445 (make-overlay (match-beginning 0) (match-end 0)))) |
13167
c378e215f4d0
(view-highlight-face): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
13158
diff
changeset
|
446 (overlay-put view-overlay 'face view-highlight-face) |
44 | 447 (beginning-of-line) |
448 (recenter (/ (view-window-size) 2))) | |
449 (message "Can't find occurrence %d of %s" times regexp) | |
450 (sit-for 4)))) | |
451 | |
354 | 452 |
584 | 453 (provide 'view) |
454 | |
657
fec3f9a1e3e5
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
584
diff
changeset
|
455 ;;; view.el ends here |