Commit | Line | Data |
---|---|---|
c88ab9ce ER |
1 | ;;; simple.el --- basic editing commands for Emacs |
2 | ||
c6db81aa | 3 | ;; Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1996, 1997, 1998, 1999, |
0a487199 | 4 | ;; 2000, 2001, 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc. |
2076c87c | 5 | |
30764597 PJ |
6 | ;; Maintainer: FSF |
7 | ;; Keywords: internal | |
8 | ||
2076c87c JB |
9 | ;; This file is part of GNU Emacs. |
10 | ||
11 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
12 | ;; it under the terms of the GNU General Public License as published by | |
3a801d0c | 13 | ;; the Free Software Foundation; either version 2, or (at your option) |
2076c87c JB |
14 | ;; any later version. |
15 | ||
16 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
17 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 | ;; GNU General Public License for more details. | |
20 | ||
21 | ;; You should have received a copy of the GNU General Public License | |
b578f267 | 22 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
086add15 LK |
23 | ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
24 | ;; Boston, MA 02110-1301, USA. | |
2076c87c | 25 | |
d9ecc911 ER |
26 | ;;; Commentary: |
27 | ||
28 | ;; A grab-bag of basic Emacs commands not specifically related to some | |
29 | ;; major mode or to file-handling. | |
30 | ||
3a801d0c | 31 | ;;; Code: |
2076c87c | 32 | |
d01a33cf | 33 | (eval-when-compile |
a339f909 | 34 | (autoload 'widget-convert "wid-edit") |
cc76a58c | 35 | (autoload 'shell-mode "shell")) |
d01a33cf | 36 | |
ca60ee11 JB |
37 | (defvar compilation-current-error) |
38 | ||
7fcce20f RS |
39 | (defcustom idle-update-delay 0.5 |
40 | "*Idle time delay before updating various things on the screen. | |
41 | Various Emacs features that update auxiliary information when point moves | |
42 | wait this many seconds after Emacs becomes idle before doing an update." | |
43 | :type 'number | |
44 | :group 'display | |
45 | :version "22.1") | |
d01a33cf | 46 | |
69c1dd37 | 47 | (defgroup killing nil |
c9f0110e | 48 | "Killing and yanking commands." |
69c1dd37 RS |
49 | :group 'editing) |
50 | ||
69c1dd37 RS |
51 | (defgroup paren-matching nil |
52 | "Highlight (un)matching of parens and expressions." | |
69c1dd37 RS |
53 | :group 'matching) |
54 | ||
7979163c JL |
55 | (defun get-next-valid-buffer (list &optional buffer visible-ok frame) |
56 | "Search LIST for a valid buffer to display in FRAME. | |
a74f9094 KL |
57 | Return nil when all buffers in LIST are undesirable for display, |
58 | otherwise return the first suitable buffer in LIST. | |
59 | ||
60 | Buffers not visible in windows are preferred to visible buffers, | |
61 | unless VISIBLE-OK is non-nil. | |
62 | If the optional argument FRAME is nil, it defaults to the selected frame. | |
7979163c | 63 | If BUFFER is non-nil, ignore occurrences of that buffer in LIST." |
a74f9094 KL |
64 | ;; This logic is more or less copied from other-buffer. |
65 | (setq frame (or frame (selected-frame))) | |
66 | (let ((pred (frame-parameter frame 'buffer-predicate)) | |
67 | found buf) | |
68 | (while (and (not found) list) | |
69 | (setq buf (car list)) | |
70 | (if (and (not (eq buffer buf)) | |
71 | (buffer-live-p buf) | |
72 | (or (null pred) (funcall pred buf)) | |
73 | (not (eq (aref (buffer-name buf) 0) ?\s)) | |
74 | (or visible-ok (null (get-buffer-window buf 'visible)))) | |
75 | (setq found buf) | |
76 | (setq list (cdr list)))) | |
77 | (car list))) | |
78 | ||
7979163c JL |
79 | (defun last-buffer (&optional buffer visible-ok frame) |
80 | "Return the last non-hidden displayable buffer in the buffer list. | |
a74f9094 KL |
81 | If BUFFER is non-nil, last-buffer will ignore that buffer. |
82 | Buffers not visible in windows are preferred to visible buffers, | |
83 | unless optional argument VISIBLE-OK is non-nil. | |
84 | If the optional third argument FRAME is non-nil, use that frame's | |
85 | buffer list instead of the selected frame's buffer list. | |
86 | If no other buffer exists, the buffer `*scratch*' is returned." | |
87 | (setq frame (or frame (selected-frame))) | |
88 | (or (get-next-valid-buffer (frame-parameter frame 'buried-buffer-list) | |
89 | buffer visible-ok frame) | |
90 | (get-next-valid-buffer (nreverse (buffer-list frame)) | |
91 | buffer visible-ok frame) | |
92 | (progn | |
93 | (set-buffer-major-mode (get-buffer-create "*scratch*")) | |
94 | (get-buffer "*scratch*")))) | |
95 | ||
f54b0d85 RS |
96 | (defun next-buffer () |
97 | "Switch to the next buffer in cyclic order." | |
98 | (interactive) | |
a74f9094 KL |
99 | (let ((buffer (current-buffer)) |
100 | (bbl (frame-parameter nil 'buried-buffer-list))) | |
101 | (switch-to-buffer (other-buffer buffer t)) | |
102 | (bury-buffer buffer) | |
103 | (set-frame-parameter nil 'buried-buffer-list | |
104 | (cons buffer (delq buffer bbl))))) | |
105 | ||
106 | (defun previous-buffer () | |
f54b0d85 RS |
107 | "Switch to the previous buffer in cyclic order." |
108 | (interactive) | |
a74f9094 KL |
109 | (let ((buffer (last-buffer (current-buffer) t)) |
110 | (bbl (frame-parameter nil 'buried-buffer-list))) | |
111 | (switch-to-buffer buffer) | |
112 | ;; Clean up buried-buffer-list up to and including the chosen buffer. | |
113 | (while (and bbl (not (eq (car bbl) buffer))) | |
114 | (setq bbl (cdr bbl))) | |
115 | (set-frame-parameter nil 'buried-buffer-list bbl))) | |
116 | ||
ee9c5954 | 117 | \f |
50f007fb | 118 | ;;; next-error support framework |
bbf41690 RS |
119 | |
120 | (defgroup next-error nil | |
f33321ad | 121 | "`next-error' support framework." |
bbf41690 | 122 | :group 'compilation |
bf247b6e | 123 | :version "22.1") |
bbf41690 RS |
124 | |
125 | (defface next-error | |
126 | '((t (:inherit region))) | |
127 | "Face used to highlight next error locus." | |
128 | :group 'next-error | |
bf247b6e | 129 | :version "22.1") |
bbf41690 | 130 | |
7408ee97 | 131 | (defcustom next-error-highlight 0.5 |
bbf41690 | 132 | "*Highlighting of locations in selected source buffers. |
f33321ad | 133 | If number, highlight the locus in `next-error' face for given time in seconds. |
6d3c944b | 134 | If t, highlight the locus indefinitely until some other locus replaces it. |
bbf41690 RS |
135 | If nil, don't highlight the locus in the source buffer. |
136 | If `fringe-arrow', indicate the locus by the fringe arrow." | |
6d3c944b | 137 | :type '(choice (number :tag "Highlight for specified time") |
c81b29e6 | 138 | (const :tag "Semipermanent highlighting" t) |
bbf41690 | 139 | (const :tag "No highlighting" nil) |
6d3c944b | 140 | (const :tag "Fringe arrow" fringe-arrow)) |
bbf41690 | 141 | :group 'next-error |
bf247b6e | 142 | :version "22.1") |
bbf41690 | 143 | |
7408ee97 RS |
144 | (defcustom next-error-highlight-no-select 0.5 |
145 | "*Highlighting of locations in `next-error-no-select'. | |
f33321ad | 146 | If number, highlight the locus in `next-error' face for given time in seconds. |
6d3c944b | 147 | If t, highlight the locus indefinitely until some other locus replaces it. |
bbf41690 RS |
148 | If nil, don't highlight the locus in the source buffer. |
149 | If `fringe-arrow', indicate the locus by the fringe arrow." | |
6d3c944b | 150 | :type '(choice (number :tag "Highlight for specified time") |
c81b29e6 | 151 | (const :tag "Semipermanent highlighting" t) |
bbf41690 | 152 | (const :tag "No highlighting" nil) |
6d3c944b | 153 | (const :tag "Fringe arrow" fringe-arrow)) |
bbf41690 | 154 | :group 'next-error |
bf247b6e | 155 | :version "22.1") |
bbf41690 | 156 | |
d634a3a2 JL |
157 | (defcustom next-error-hook nil |
158 | "*List of hook functions run by `next-error' after visiting source file." | |
159 | :type 'hook | |
160 | :group 'next-error) | |
161 | ||
814c3037 JL |
162 | (defvar next-error-highlight-timer nil) |
163 | ||
9c9b00d6 | 164 | (defvar next-error-overlay-arrow-position nil) |
c29d24ea | 165 | (put 'next-error-overlay-arrow-position 'overlay-arrow-string "=>") |
9c9b00d6 JL |
166 | (add-to-list 'overlay-arrow-variable-list 'next-error-overlay-arrow-position) |
167 | ||
50f007fb | 168 | (defvar next-error-last-buffer nil |
f33321ad | 169 | "The most recent `next-error' buffer. |
50f007fb KS |
170 | A buffer becomes most recent when its compilation, grep, or |
171 | similar mode is started, or when it is used with \\[next-error] | |
172 | or \\[compile-goto-error].") | |
173 | ||
174 | (defvar next-error-function nil | |
e462ab77 SM |
175 | "Function to use to find the next error in the current buffer. |
176 | The function is called with 2 parameters: | |
177 | ARG is an integer specifying by how many errors to move. | |
178 | RESET is a boolean which, if non-nil, says to go back to the beginning | |
179 | of the errors before moving. | |
180 | Major modes providing compile-like functionality should set this variable | |
181 | to indicate to `next-error' that this is a candidate buffer and how | |
182 | to navigate in it.") | |
50f007fb KS |
183 | |
184 | (make-variable-buffer-local 'next-error-function) | |
185 | ||
f1e2a033 | 186 | (defsubst next-error-buffer-p (buffer |
e967cd11 | 187 | &optional avoid-current |
f1e2a033 | 188 | extra-test-inclusive |
5f9e0ca5 | 189 | extra-test-exclusive) |
f33321ad | 190 | "Test if BUFFER is a `next-error' capable buffer. |
e967cd11 RS |
191 | |
192 | If AVOID-CURRENT is non-nil, treat the current buffer | |
193 | as an absolute last resort only. | |
194 | ||
195 | The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer | |
196 | that normally would not qualify. If it returns t, the buffer | |
197 | in question is treated as usable. | |
198 | ||
7979163c | 199 | The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer |
01ba9662 | 200 | that would normally be considered usable. If it returns nil, |
e967cd11 RS |
201 | that buffer is rejected." |
202 | (and (buffer-name buffer) ;First make sure it's live. | |
203 | (not (and avoid-current (eq buffer (current-buffer)))) | |
204 | (with-current-buffer buffer | |
205 | (if next-error-function ; This is the normal test. | |
206 | ;; Optionally reject some buffers. | |
207 | (if extra-test-exclusive | |
208 | (funcall extra-test-exclusive) | |
209 | t) | |
210 | ;; Optionally accept some other buffers. | |
211 | (and extra-test-inclusive | |
212 | (funcall extra-test-inclusive)))))) | |
213 | ||
214 | (defun next-error-find-buffer (&optional avoid-current | |
f1e2a033 | 215 | extra-test-inclusive |
5f9e0ca5 | 216 | extra-test-exclusive) |
f33321ad | 217 | "Return a `next-error' capable buffer. |
7979163c | 218 | |
e967cd11 RS |
219 | If AVOID-CURRENT is non-nil, treat the current buffer |
220 | as an absolute last resort only. | |
221 | ||
01ba9662 | 222 | The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer |
e967cd11 RS |
223 | that normally would not qualify. If it returns t, the buffer |
224 | in question is treated as usable. | |
225 | ||
7979163c | 226 | The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer |
e967cd11 RS |
227 | that would normally be considered usable. If it returns nil, |
228 | that buffer is rejected." | |
03e75c7e JL |
229 | (or |
230 | ;; 1. If one window on the selected frame displays such buffer, return it. | |
231 | (let ((window-buffers | |
232 | (delete-dups | |
233 | (delq nil (mapcar (lambda (w) | |
234 | (if (next-error-buffer-p | |
e967cd11 RS |
235 | (window-buffer w) |
236 | avoid-current | |
f1e2a033 | 237 | extra-test-inclusive extra-test-exclusive) |
03e75c7e JL |
238 | (window-buffer w))) |
239 | (window-list)))))) | |
03e75c7e JL |
240 | (if (eq (length window-buffers) 1) |
241 | (car window-buffers))) | |
e967cd11 | 242 | ;; 2. If next-error-last-buffer is an acceptable buffer, use that. |
03e75c7e | 243 | (if (and next-error-last-buffer |
e967cd11 | 244 | (next-error-buffer-p next-error-last-buffer avoid-current |
f1e2a033 | 245 | extra-test-inclusive extra-test-exclusive)) |
e967cd11 RS |
246 | next-error-last-buffer) |
247 | ;; 3. If the current buffer is acceptable, choose it. | |
248 | (if (next-error-buffer-p (current-buffer) avoid-current | |
249 | extra-test-inclusive extra-test-exclusive) | |
03e75c7e | 250 | (current-buffer)) |
e967cd11 | 251 | ;; 4. Look for any acceptable buffer. |
03e75c7e JL |
252 | (let ((buffers (buffer-list))) |
253 | (while (and buffers | |
e967cd11 RS |
254 | (not (next-error-buffer-p |
255 | (car buffers) avoid-current | |
256 | extra-test-inclusive extra-test-exclusive))) | |
03e75c7e | 257 | (setq buffers (cdr buffers))) |
e967cd11 RS |
258 | (car buffers)) |
259 | ;; 5. Use the current buffer as a last resort if it qualifies, | |
260 | ;; even despite AVOID-CURRENT. | |
261 | (and avoid-current | |
262 | (next-error-buffer-p (current-buffer) nil | |
263 | extra-test-inclusive extra-test-exclusive) | |
264 | (progn | |
ee4dc5d9 | 265 | (message "This is the only buffer with error message locations") |
e967cd11 RS |
266 | (current-buffer))) |
267 | ;; 6. Give up. | |
ee4dc5d9 | 268 | (error "No buffers contain error message locations"))) |
50f007fb | 269 | |
310abb0b | 270 | (defun next-error (&optional arg reset) |
f33321ad | 271 | "Visit next `next-error' message and corresponding source code. |
50f007fb KS |
272 | |
273 | If all the error messages parsed so far have been processed already, | |
274 | the message buffer is checked for new ones. | |
275 | ||
e462ab77 | 276 | A prefix ARG specifies how many error messages to move; |
50f007fb KS |
277 | negative means move back to previous error messages. |
278 | Just \\[universal-argument] as a prefix means reparse the error message buffer | |
279 | and start at the first error. | |
280 | ||
e249a6d8 | 281 | The RESET argument specifies that we should restart from the beginning. |
50f007fb KS |
282 | |
283 | \\[next-error] normally uses the most recently started | |
284 | compilation, grep, or occur buffer. It can also operate on any | |
285 | buffer with output from the \\[compile], \\[grep] commands, or, | |
286 | more generally, on any buffer in Compilation mode or with | |
287 | Compilation Minor mode enabled, or any buffer in which | |
03e75c7e JL |
288 | `next-error-function' is bound to an appropriate function. |
289 | To specify use of a particular buffer for error messages, type | |
290 | \\[next-error] in that buffer when it is the only one displayed | |
291 | in the current frame. | |
50f007fb | 292 | |
d634a3a2 JL |
293 | Once \\[next-error] has chosen the buffer for error messages, it |
294 | runs `next-error-hook' with `run-hooks', and stays with that buffer | |
295 | until you use it in some other buffer which uses Compilation mode | |
296 | or Compilation Minor mode. | |
50f007fb KS |
297 | |
298 | See variables `compilation-parse-errors-function' and | |
299 | \`compilation-error-regexp-alist' for customization ideas." | |
300 | (interactive "P") | |
e462ab77 | 301 | (if (consp arg) (setq reset t arg nil)) |
50f007fb KS |
302 | (when (setq next-error-last-buffer (next-error-find-buffer)) |
303 | ;; we know here that next-error-function is a valid symbol we can funcall | |
304 | (with-current-buffer next-error-last-buffer | |
d634a3a2 JL |
305 | (funcall next-error-function (prefix-numeric-value arg) reset) |
306 | (run-hooks 'next-error-hook)))) | |
50f007fb | 307 | |
56ab610b RS |
308 | (defun next-error-internal () |
309 | "Visit the source code corresponding to the `next-error' message at point." | |
310 | (setq next-error-last-buffer (current-buffer)) | |
311 | ;; we know here that next-error-function is a valid symbol we can funcall | |
312 | (with-current-buffer next-error-last-buffer | |
313 | (funcall next-error-function 0 nil) | |
314 | (run-hooks 'next-error-hook))) | |
315 | ||
50f007fb KS |
316 | (defalias 'goto-next-locus 'next-error) |
317 | (defalias 'next-match 'next-error) | |
318 | ||
310abb0b | 319 | (defun previous-error (&optional n) |
f33321ad | 320 | "Visit previous `next-error' message and corresponding source code. |
50f007fb KS |
321 | |
322 | Prefix arg N says how many error messages to move backwards (or | |
323 | forwards, if negative). | |
324 | ||
325 | This operates on the output from the \\[compile] and \\[grep] commands." | |
326 | (interactive "p") | |
310abb0b | 327 | (next-error (- (or n 1)))) |
50f007fb | 328 | |
310abb0b | 329 | (defun first-error (&optional n) |
50f007fb KS |
330 | "Restart at the first error. |
331 | Visit corresponding source code. | |
332 | With prefix arg N, visit the source code of the Nth error. | |
333 | This operates on the output from the \\[compile] command, for instance." | |
334 | (interactive "p") | |
335 | (next-error n t)) | |
336 | ||
310abb0b | 337 | (defun next-error-no-select (&optional n) |
f33321ad | 338 | "Move point to the next error in the `next-error' buffer and highlight match. |
50f007fb KS |
339 | Prefix arg N says how many error messages to move forwards (or |
340 | backwards, if negative). | |
341 | Finds and highlights the source line like \\[next-error], but does not | |
342 | select the source buffer." | |
343 | (interactive "p") | |
ee9c5954 JL |
344 | (let ((next-error-highlight next-error-highlight-no-select)) |
345 | (next-error n)) | |
50f007fb KS |
346 | (pop-to-buffer next-error-last-buffer)) |
347 | ||
310abb0b | 348 | (defun previous-error-no-select (&optional n) |
f33321ad | 349 | "Move point to the previous error in the `next-error' buffer and highlight match. |
50f007fb KS |
350 | Prefix arg N says how many error messages to move backwards (or |
351 | forwards, if negative). | |
352 | Finds and highlights the source line like \\[previous-error], but does not | |
353 | select the source buffer." | |
354 | (interactive "p") | |
310abb0b | 355 | (next-error-no-select (- (or n 1)))) |
50f007fb | 356 | |
282d6eae EZ |
357 | ;;; Internal variable for `next-error-follow-mode-post-command-hook'. |
358 | (defvar next-error-follow-last-line nil) | |
359 | ||
2a223f35 | 360 | (define-minor-mode next-error-follow-minor-mode |
282d6eae | 361 | "Minor mode for compilation, occur and diff modes. |
2a223f35 EZ |
362 | When turned on, cursor motion in the compilation, grep, occur or diff |
363 | buffer causes automatic display of the corresponding source code | |
364 | location." | |
ed8e0f0a | 365 | :group 'next-error :init-value nil :lighter " Fol" |
8a98a6c2 | 366 | (if (not next-error-follow-minor-mode) |
282d6eae EZ |
367 | (remove-hook 'post-command-hook 'next-error-follow-mode-post-command-hook t) |
368 | (add-hook 'post-command-hook 'next-error-follow-mode-post-command-hook nil t) | |
e56dd5c6 | 369 | (make-local-variable 'next-error-follow-last-line))) |
282d6eae EZ |
370 | |
371 | ;;; Used as a `post-command-hook' by `next-error-follow-mode' | |
372 | ;;; for the *Compilation* *grep* and *Occur* buffers. | |
373 | (defun next-error-follow-mode-post-command-hook () | |
374 | (unless (equal next-error-follow-last-line (line-number-at-pos)) | |
375 | (setq next-error-follow-last-line (line-number-at-pos)) | |
376 | (condition-case nil | |
377 | (let ((compilation-context-lines nil)) | |
378 | (setq compilation-current-error (point)) | |
379 | (next-error-no-select 0)) | |
380 | (error t)))) | |
381 | ||
ee9c5954 | 382 | \f |
50f007fb KS |
383 | ;;; |
384 | ||
93be67de KH |
385 | (defun fundamental-mode () |
386 | "Major mode not specialized for anything in particular. | |
387 | Other major modes are defined by comparison with this one." | |
388 | (interactive) | |
e174f8db | 389 | (kill-all-local-variables) |
52167727 LK |
390 | (unless delay-mode-hooks |
391 | (run-hooks 'after-change-major-mode-hook))) | |
eaae8106 | 392 | |
93be67de KH |
393 | ;; Making and deleting lines. |
394 | ||
4ea0018b CY |
395 | (defvar hard-newline (propertize "\n" 'hard t 'rear-nonsticky '(hard))) |
396 | ||
30bb9754 | 397 | (defun newline (&optional arg) |
d133d835 | 398 | "Insert a newline, and move to left margin of the new line if it's blank. |
058d4999 DL |
399 | If `use-hard-newlines' is non-nil, the newline is marked with the |
400 | text-property `hard'. | |
76c64e24 | 401 | With ARG, insert that many newlines. |
058d4999 | 402 | Call `auto-fill-function' if the current column number is greater |
6688f85f | 403 | than the value of `fill-column' and ARG is nil." |
30bb9754 | 404 | (interactive "*P") |
4c4cbf11 | 405 | (barf-if-buffer-read-only) |
30bb9754 BG |
406 | ;; Inserting a newline at the end of a line produces better redisplay in |
407 | ;; try_window_id than inserting at the beginning of a line, and the textual | |
408 | ;; result is the same. So, if we're at beginning of line, pretend to be at | |
409 | ;; the end of the previous line. | |
1e722f9f | 410 | (let ((flag (and (not (bobp)) |
30bb9754 | 411 | (bolp) |
1cd24721 RS |
412 | ;; Make sure no functions want to be told about |
413 | ;; the range of the changes. | |
1cd24721 RS |
414 | (not after-change-functions) |
415 | (not before-change-functions) | |
fd977703 RS |
416 | ;; Make sure there are no markers here. |
417 | (not (buffer-has-markers-at (1- (point)))) | |
2f047f6c | 418 | (not (buffer-has-markers-at (point))) |
1cd24721 RS |
419 | ;; Make sure no text properties want to know |
420 | ;; where the change was. | |
421 | (not (get-char-property (1- (point)) 'modification-hooks)) | |
422 | (not (get-char-property (1- (point)) 'insert-behind-hooks)) | |
423 | (or (eobp) | |
424 | (not (get-char-property (point) 'insert-in-front-hooks))) | |
31a5333f MB |
425 | ;; Make sure the newline before point isn't intangible. |
426 | (not (get-char-property (1- (point)) 'intangible)) | |
427 | ;; Make sure the newline before point isn't read-only. | |
428 | (not (get-char-property (1- (point)) 'read-only)) | |
429 | ;; Make sure the newline before point isn't invisible. | |
430 | (not (get-char-property (1- (point)) 'invisible)) | |
431 | ;; Make sure the newline before point has the same | |
432 | ;; properties as the char before it (if any). | |
1e722f9f | 433 | (< (or (previous-property-change (point)) -2) |
d133d835 RS |
434 | (- (point) 2)))) |
435 | (was-page-start (and (bolp) | |
436 | (looking-at page-delimiter))) | |
437 | (beforepos (point))) | |
30bb9754 BG |
438 | (if flag (backward-char 1)) |
439 | ;; Call self-insert so that auto-fill, abbrev expansion etc. happens. | |
440 | ;; Set last-command-char to tell self-insert what to insert. | |
441 | (let ((last-command-char ?\n) | |
442 | ;; Don't auto-fill if we have a numeric argument. | |
3954fff9 RS |
443 | ;; Also not if flag is true (it would fill wrong line); |
444 | ;; there is no need to since we're at BOL. | |
445 | (auto-fill-function (if (or arg flag) nil auto-fill-function))) | |
4cc9d0dc RS |
446 | (unwind-protect |
447 | (self-insert-command (prefix-numeric-value arg)) | |
448 | ;; If we get an error in self-insert-command, put point at right place. | |
449 | (if flag (forward-char 1)))) | |
2f047f6c KH |
450 | ;; Even if we did *not* get an error, keep that forward-char; |
451 | ;; all further processing should apply to the newline that the user | |
452 | ;; thinks he inserted. | |
453 | ||
30bb9754 BG |
454 | ;; Mark the newline(s) `hard'. |
455 | (if use-hard-newlines | |
2f047f6c | 456 | (set-hard-newline-properties |
55741b46 | 457 | (- (point) (if arg (prefix-numeric-value arg) 1)) (point))) |
d133d835 RS |
458 | ;; If the newline leaves the previous line blank, |
459 | ;; and we have a left margin, delete that from the blank line. | |
460 | (or flag | |
461 | (save-excursion | |
462 | (goto-char beforepos) | |
463 | (beginning-of-line) | |
464 | (and (looking-at "[ \t]$") | |
465 | (> (current-left-margin) 0) | |
466 | (delete-region (point) (progn (end-of-line) (point)))))) | |
d133d835 RS |
467 | ;; Indent the line after the newline, except in one case: |
468 | ;; when we added the newline at the beginning of a line | |
469 | ;; which starts a page. | |
470 | (or was-page-start | |
471 | (move-to-left-margin nil t))) | |
30bb9754 BG |
472 | nil) |
473 | ||
55741b46 RS |
474 | (defun set-hard-newline-properties (from to) |
475 | (let ((sticky (get-text-property from 'rear-nonsticky))) | |
476 | (put-text-property from to 'hard 't) | |
477 | ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list | |
478 | (if (and (listp sticky) (not (memq 'hard sticky))) | |
479 | (put-text-property from (point) 'rear-nonsticky | |
480 | (cons 'hard sticky))))) | |
eaae8106 | 481 | |
e249a6d8 | 482 | (defun open-line (n) |
ff1fbe3e | 483 | "Insert a newline and leave point before it. |
f33321ad JB |
484 | If there is a fill prefix and/or a `left-margin', insert them |
485 | on the new line if the line would have been blank. | |
616ed245 | 486 | With arg N, insert N newlines." |
2076c87c | 487 | (interactive "*p") |
616ed245 | 488 | (let* ((do-fill-prefix (and fill-prefix (bolp))) |
3db1e3b5 | 489 | (do-left-margin (and (bolp) (> (current-left-margin) 0))) |
207d7545 GM |
490 | (loc (point)) |
491 | ;; Don't expand an abbrev before point. | |
492 | (abbrev-mode nil)) | |
e249a6d8 | 493 | (newline n) |
d133d835 | 494 | (goto-char loc) |
e249a6d8 | 495 | (while (> n 0) |
d133d835 RS |
496 | (cond ((bolp) |
497 | (if do-left-margin (indent-to (current-left-margin))) | |
498 | (if do-fill-prefix (insert-and-inherit fill-prefix)))) | |
499 | (forward-line 1) | |
e249a6d8 | 500 | (setq n (1- n))) |
d133d835 RS |
501 | (goto-char loc) |
502 | (end-of-line))) | |
2076c87c | 503 | |
da7d231b KS |
504 | (defun split-line (&optional arg) |
505 | "Split current line, moving portion beyond point vertically down. | |
506 | If the current line starts with `fill-prefix', insert it on the new | |
f33321ad | 507 | line as well. With prefix ARG, don't insert `fill-prefix' on new line. |
da7d231b | 508 | |
e249a6d8 | 509 | When called from Lisp code, ARG may be a prefix string to copy." |
da7d231b | 510 | (interactive "*P") |
2076c87c | 511 | (skip-chars-forward " \t") |
d77bbdc9 RS |
512 | (let* ((col (current-column)) |
513 | (pos (point)) | |
514 | ;; What prefix should we check for (nil means don't). | |
515 | (prefix (cond ((stringp arg) arg) | |
516 | (arg nil) | |
517 | (t fill-prefix))) | |
518 | ;; Does this line start with it? | |
519 | (have-prfx (and prefix | |
520 | (save-excursion | |
521 | (beginning-of-line) | |
522 | (looking-at (regexp-quote prefix)))))) | |
28191e20 | 523 | (newline 1) |
d77bbdc9 | 524 | (if have-prfx (insert-and-inherit prefix)) |
2076c87c JB |
525 | (indent-to col 0) |
526 | (goto-char pos))) | |
527 | ||
2076c87c JB |
528 | (defun delete-indentation (&optional arg) |
529 | "Join this line to previous and fix up whitespace at join. | |
ccc58657 | 530 | If there is a fill prefix, delete it from the beginning of this line. |
2076c87c JB |
531 | With argument, join this line to following line." |
532 | (interactive "*P") | |
533 | (beginning-of-line) | |
534 | (if arg (forward-line 1)) | |
535 | (if (eq (preceding-char) ?\n) | |
536 | (progn | |
537 | (delete-region (point) (1- (point))) | |
ccc58657 RS |
538 | ;; If the second line started with the fill prefix, |
539 | ;; delete the prefix. | |
540 | (if (and fill-prefix | |
01b8e020 | 541 | (<= (+ (point) (length fill-prefix)) (point-max)) |
ccc58657 RS |
542 | (string= fill-prefix |
543 | (buffer-substring (point) | |
544 | (+ (point) (length fill-prefix))))) | |
545 | (delete-region (point) (+ (point) (length fill-prefix)))) | |
2076c87c JB |
546 | (fixup-whitespace)))) |
547 | ||
fc025090 | 548 | (defalias 'join-line #'delete-indentation) ; easier to find |
eaae8106 | 549 | |
2076c87c JB |
550 | (defun delete-blank-lines () |
551 | "On blank line, delete all surrounding blank lines, leaving just one. | |
552 | On isolated blank line, delete that one. | |
6d30d416 | 553 | On nonblank line, delete any immediately following blank lines." |
2076c87c JB |
554 | (interactive "*") |
555 | (let (thisblank singleblank) | |
556 | (save-excursion | |
557 | (beginning-of-line) | |
558 | (setq thisblank (looking-at "[ \t]*$")) | |
70e14c01 | 559 | ;; Set singleblank if there is just one blank line here. |
2076c87c JB |
560 | (setq singleblank |
561 | (and thisblank | |
562 | (not (looking-at "[ \t]*\n[ \t]*$")) | |
563 | (or (bobp) | |
564 | (progn (forward-line -1) | |
565 | (not (looking-at "[ \t]*$"))))))) | |
70e14c01 | 566 | ;; Delete preceding blank lines, and this one too if it's the only one. |
2076c87c JB |
567 | (if thisblank |
568 | (progn | |
569 | (beginning-of-line) | |
570 | (if singleblank (forward-line 1)) | |
571 | (delete-region (point) | |
572 | (if (re-search-backward "[^ \t\n]" nil t) | |
573 | (progn (forward-line 1) (point)) | |
574 | (point-min))))) | |
70e14c01 JB |
575 | ;; Delete following blank lines, unless the current line is blank |
576 | ;; and there are no following blank lines. | |
2076c87c JB |
577 | (if (not (and thisblank singleblank)) |
578 | (save-excursion | |
579 | (end-of-line) | |
580 | (forward-line 1) | |
581 | (delete-region (point) | |
582 | (if (re-search-forward "[^ \t\n]" nil t) | |
583 | (progn (beginning-of-line) (point)) | |
70e14c01 JB |
584 | (point-max))))) |
585 | ;; Handle the special case where point is followed by newline and eob. | |
586 | ;; Delete the line, leaving point at eob. | |
587 | (if (looking-at "^[ \t]*\n\\'") | |
588 | (delete-region (point) (point-max))))) | |
2076c87c | 589 | |
eaae8106 SS |
590 | (defun delete-trailing-whitespace () |
591 | "Delete all the trailing whitespace across the current buffer. | |
592 | All whitespace after the last non-whitespace character in a line is deleted. | |
103db06c RS |
593 | This respects narrowing, created by \\[narrow-to-region] and friends. |
594 | A formfeed is not considered whitespace by this function." | |
eaae8106 SS |
595 | (interactive "*") |
596 | (save-match-data | |
597 | (save-excursion | |
598 | (goto-char (point-min)) | |
5c9b3fac MB |
599 | (while (re-search-forward "\\s-$" nil t) |
600 | (skip-syntax-backward "-" (save-excursion (forward-line 0) (point))) | |
3a768251 | 601 | ;; Don't delete formfeeds, even if they are considered whitespace. |
661aa5c7 GM |
602 | (save-match-data |
603 | (if (looking-at ".*\f") | |
604 | (goto-char (match-end 0)))) | |
7981d89f | 605 | (delete-region (point) (match-end 0)))))) |
eaae8106 | 606 | |
2076c87c JB |
607 | (defun newline-and-indent () |
608 | "Insert a newline, then indent according to major mode. | |
ff1fbe3e | 609 | Indentation is done using the value of `indent-line-function'. |
2076c87c | 610 | In programming language modes, this is the same as TAB. |
ff1fbe3e | 611 | In some text modes, where TAB inserts a tab, this command indents to the |
eed5698b | 612 | column specified by the function `current-left-margin'." |
2076c87c | 613 | (interactive "*") |
5ff4ba3d | 614 | (delete-horizontal-space t) |
46947372 | 615 | (newline) |
2076c87c JB |
616 | (indent-according-to-mode)) |
617 | ||
618 | (defun reindent-then-newline-and-indent () | |
619 | "Reindent current line, insert newline, then indent the new line. | |
620 | Indentation of both lines is done according to the current major mode, | |
ff1fbe3e | 621 | which means calling the current value of `indent-line-function'. |
2076c87c JB |
622 | In programming language modes, this is the same as TAB. |
623 | In some text modes, where TAB inserts a tab, this indents to the | |
eed5698b | 624 | column specified by the function `current-left-margin'." |
2076c87c | 625 | (interactive "*") |
e1e04350 SM |
626 | (let ((pos (point))) |
627 | ;; Be careful to insert the newline before indenting the line. | |
628 | ;; Otherwise, the indentation might be wrong. | |
629 | (newline) | |
630 | (save-excursion | |
631 | (goto-char pos) | |
fd2c4cd8 SM |
632 | (indent-according-to-mode) |
633 | (delete-horizontal-space t)) | |
e1e04350 | 634 | (indent-according-to-mode))) |
eaae8106 | 635 | |
93be67de KH |
636 | (defun quoted-insert (arg) |
637 | "Read next input character and insert it. | |
638 | This is useful for inserting control characters. | |
2076c87c | 639 | |
93be67de KH |
640 | If the first character you type after this command is an octal digit, |
641 | you should type a sequence of octal digits which specify a character code. | |
642 | Any nondigit terminates the sequence. If the terminator is a RET, | |
643 | it is discarded; any other terminator is used itself as input. | |
644 | The variable `read-quoted-char-radix' specifies the radix for this feature; | |
645 | set it to 10 or 16 to use decimal or hex instead of octal. | |
dff7d67f | 646 | |
93be67de KH |
647 | In overwrite mode, this function inserts the character anyway, and |
648 | does not handle octal digits specially. This means that if you use | |
649 | overwrite as your normal editing mode, you can use this function to | |
650 | insert characters when necessary. | |
dff7d67f | 651 | |
93be67de KH |
652 | In binary overwrite mode, this function does overwrite, and octal |
653 | digits are interpreted as a character code. This is intended to be | |
654 | useful for editing binary files." | |
655 | (interactive "*p") | |
1f57934c | 656 | (let* ((char (let (translation-table-for-input input-method-function) |
940fe486 DL |
657 | (if (or (not overwrite-mode) |
658 | (eq overwrite-mode 'overwrite-mode-binary)) | |
659 | (read-quoted-char) | |
660 | (read-char))))) | |
93be67de KH |
661 | ;; Assume character codes 0240 - 0377 stand for characters in some |
662 | ;; single-byte character set, and convert them to Emacs | |
663 | ;; characters. | |
664 | (if (and enable-multibyte-characters | |
665 | (>= char ?\240) | |
666 | (<= char ?\377)) | |
667 | (setq char (unibyte-char-to-multibyte char))) | |
668 | (if (> arg 0) | |
669 | (if (eq overwrite-mode 'overwrite-mode-binary) | |
670 | (delete-char arg))) | |
671 | (while (> arg 0) | |
672 | (insert-and-inherit char) | |
673 | (setq arg (1- arg))))) | |
eaae8106 | 674 | |
b82d844f | 675 | (defun forward-to-indentation (&optional arg) |
93be67de KH |
676 | "Move forward ARG lines and position at first nonblank character." |
677 | (interactive "p") | |
b82d844f | 678 | (forward-line (or arg 1)) |
93be67de | 679 | (skip-chars-forward " \t")) |
cc2b2b6c | 680 | |
b82d844f | 681 | (defun backward-to-indentation (&optional arg) |
93be67de KH |
682 | "Move backward ARG lines and position at first nonblank character." |
683 | (interactive "p") | |
b82d844f | 684 | (forward-line (- (or arg 1))) |
93be67de | 685 | (skip-chars-forward " \t")) |
2076c87c | 686 | |
93be67de KH |
687 | (defun back-to-indentation () |
688 | "Move point to the first non-whitespace character on this line." | |
689 | (interactive) | |
690 | (beginning-of-line 1) | |
1e96c007 | 691 | (skip-syntax-forward " " (line-end-position)) |
b9863466 RS |
692 | ;; Move back over chars that have whitespace syntax but have the p flag. |
693 | (backward-prefix-chars)) | |
93be67de KH |
694 | |
695 | (defun fixup-whitespace () | |
696 | "Fixup white space between objects around point. | |
697 | Leave one space or none, according to the context." | |
698 | (interactive "*") | |
699 | (save-excursion | |
700 | (delete-horizontal-space) | |
701 | (if (or (looking-at "^\\|\\s)") | |
702 | (save-excursion (forward-char -1) | |
703 | (looking-at "$\\|\\s(\\|\\s'"))) | |
704 | nil | |
f33321ad | 705 | (insert ?\s)))) |
93be67de | 706 | |
5ff4ba3d MB |
707 | (defun delete-horizontal-space (&optional backward-only) |
708 | "Delete all spaces and tabs around point. | |
709 | If BACKWARD-ONLY is non-nil, only delete spaces before point." | |
93be67de | 710 | (interactive "*") |
9ab59a1a MB |
711 | (let ((orig-pos (point))) |
712 | (delete-region | |
713 | (if backward-only | |
714 | orig-pos | |
715 | (progn | |
716 | (skip-chars-forward " \t") | |
717 | (constrain-to-field nil orig-pos t))) | |
5ff4ba3d | 718 | (progn |
9ab59a1a MB |
719 | (skip-chars-backward " \t") |
720 | (constrain-to-field nil orig-pos))))) | |
93be67de | 721 | |
68c16b59 | 722 | (defun just-one-space (&optional n) |
56abefac RS |
723 | "Delete all spaces and tabs around point, leaving one space (or N spaces)." |
724 | (interactive "*p") | |
9ab59a1a MB |
725 | (let ((orig-pos (point))) |
726 | (skip-chars-backward " \t") | |
727 | (constrain-to-field nil orig-pos) | |
68c16b59 | 728 | (dotimes (i (or n 1)) |
f33321ad | 729 | (if (= (following-char) ?\s) |
56abefac | 730 | (forward-char 1) |
f33321ad | 731 | (insert ?\s))) |
9ab59a1a MB |
732 | (delete-region |
733 | (point) | |
734 | (progn | |
735 | (skip-chars-forward " \t") | |
736 | (constrain-to-field nil orig-pos t))))) | |
2d88b556 | 737 | \f |
2076c87c JB |
738 | (defun beginning-of-buffer (&optional arg) |
739 | "Move point to the beginning of the buffer; leave mark at previous position. | |
a416e7ef KS |
740 | With \\[universal-argument] prefix, do not set mark at previous position. |
741 | With numeric arg N, put point N/10 of the way from the beginning. | |
c66587fe RS |
742 | |
743 | If the buffer is narrowed, this command uses the beginning and size | |
744 | of the accessible part of the buffer. | |
ff1fbe3e RS |
745 | |
746 | Don't use this command in Lisp programs! | |
2076c87c JB |
747 | \(goto-char (point-min)) is faster and avoids clobbering the mark." |
748 | (interactive "P") | |
24199fe7 | 749 | (or (consp arg) |
705a5933 JL |
750 | (and transient-mark-mode mark-active) |
751 | (push-mark)) | |
c66587fe | 752 | (let ((size (- (point-max) (point-min)))) |
a416e7ef | 753 | (goto-char (if (and arg (not (consp arg))) |
c66587fe RS |
754 | (+ (point-min) |
755 | (if (> size 10000) | |
756 | ;; Avoid overflow for large buffer sizes! | |
757 | (* (prefix-numeric-value arg) | |
758 | (/ size 10)) | |
759 | (/ (+ 10 (* size (prefix-numeric-value arg))) 10))) | |
760 | (point-min)))) | |
2076c87c JB |
761 | (if arg (forward-line 1))) |
762 | ||
763 | (defun end-of-buffer (&optional arg) | |
764 | "Move point to the end of the buffer; leave mark at previous position. | |
a416e7ef KS |
765 | With \\[universal-argument] prefix, do not set mark at previous position. |
766 | With numeric arg N, put point N/10 of the way from the end. | |
c66587fe RS |
767 | |
768 | If the buffer is narrowed, this command uses the beginning and size | |
769 | of the accessible part of the buffer. | |
ff1fbe3e RS |
770 | |
771 | Don't use this command in Lisp programs! | |
2076c87c JB |
772 | \(goto-char (point-max)) is faster and avoids clobbering the mark." |
773 | (interactive "P") | |
24199fe7 | 774 | (or (consp arg) |
705a5933 JL |
775 | (and transient-mark-mode mark-active) |
776 | (push-mark)) | |
c66587fe | 777 | (let ((size (- (point-max) (point-min)))) |
a416e7ef | 778 | (goto-char (if (and arg (not (consp arg))) |
c66587fe RS |
779 | (- (point-max) |
780 | (if (> size 10000) | |
781 | ;; Avoid overflow for large buffer sizes! | |
782 | (* (prefix-numeric-value arg) | |
783 | (/ size 10)) | |
784 | (/ (* size (prefix-numeric-value arg)) 10))) | |
785 | (point-max)))) | |
3a801d0c ER |
786 | ;; If we went to a place in the middle of the buffer, |
787 | ;; adjust it to the beginning of a line. | |
314808dc | 788 | (cond (arg (forward-line 1)) |
919f2812 | 789 | ((> (point) (window-end nil t)) |
314808dc GM |
790 | ;; If the end of the buffer is not already on the screen, |
791 | ;; then scroll specially to put it near, but not at, the bottom. | |
792 | (overlay-recenter (point)) | |
793 | (recenter -3)))) | |
2076c87c JB |
794 | |
795 | (defun mark-whole-buffer () | |
70e14c01 JB |
796 | "Put point at beginning and mark at end of buffer. |
797 | You probably should not use this function in Lisp programs; | |
798 | it is usually a mistake for a Lisp function to use any subroutine | |
799 | that uses or sets the mark." | |
2076c87c JB |
800 | (interactive) |
801 | (push-mark (point)) | |
fd0f4056 | 802 | (push-mark (point-max) nil t) |
2076c87c | 803 | (goto-char (point-min))) |
2d88b556 | 804 | \f |
eaae8106 | 805 | |
93be67de KH |
806 | ;; Counting lines, one way or another. |
807 | ||
00a369ac RS |
808 | (defun goto-line (arg &optional buffer) |
809 | "Goto line ARG, counting from line 1 at beginning of buffer. | |
09ad1a5b EZ |
810 | Normally, move point in the current buffer. |
811 | With just \\[universal-argument] as argument, move point in the most recently | |
812 | displayed other buffer, and switch to it. When called from Lisp code, | |
813 | the optional argument BUFFER specifies a buffer to switch to. | |
00a369ac RS |
814 | |
815 | If there's a number in the buffer at point, it is the default for ARG." | |
816 | (interactive | |
817 | (if (and current-prefix-arg (not (consp current-prefix-arg))) | |
818 | (list (prefix-numeric-value current-prefix-arg)) | |
819 | ;; Look for a default, a number in the buffer at point. | |
820 | (let* ((default | |
821 | (save-excursion | |
822 | (skip-chars-backward "0-9") | |
823 | (if (looking-at "[0-9]") | |
824 | (buffer-substring-no-properties | |
825 | (point) | |
826 | (progn (skip-chars-forward "0-9") | |
827 | (point)))))) | |
828 | ;; Decide if we're switching buffers. | |
829 | (buffer | |
830 | (if (consp current-prefix-arg) | |
831 | (other-buffer (current-buffer) t))) | |
832 | (buffer-prompt | |
833 | (if buffer | |
834 | (concat " in " (buffer-name buffer)) | |
835 | ""))) | |
836 | ;; Read the argument, offering that number (if any) as default. | |
837 | (list (read-from-minibuffer (format (if default "Goto line%s (%s): " | |
838 | "Goto line%s: ") | |
839 | buffer-prompt | |
840 | default) | |
841 | nil nil t | |
842 | 'minibuffer-history | |
843 | default) | |
844 | buffer)))) | |
845 | ;; Switch to the desired buffer, one way or another. | |
846 | (if buffer | |
847 | (let ((window (get-buffer-window buffer))) | |
848 | (if window (select-window window) | |
849 | (switch-to-buffer-other-window buffer)))) | |
850 | ;; Move to the specified line number in that buffer. | |
93be67de KH |
851 | (save-restriction |
852 | (widen) | |
853 | (goto-char 1) | |
854 | (if (eq selective-display t) | |
855 | (re-search-forward "[\n\C-m]" nil 'end (1- arg)) | |
f38c52df | 856 | (forward-line (1- arg))))) |
2076c87c JB |
857 | |
858 | (defun count-lines-region (start end) | |
eb8c3be9 | 859 | "Print number of lines and characters in the region." |
2076c87c JB |
860 | (interactive "r") |
861 | (message "Region has %d lines, %d characters" | |
862 | (count-lines start end) (- end start))) | |
863 | ||
864 | (defun what-line () | |
2578be76 | 865 | "Print the current buffer line number and narrowed line number of point." |
2076c87c | 866 | (interactive) |
c6db81aa | 867 | (let ((start (point-min)) |
4109ce02 | 868 | (n (line-number-at-pos))) |
f076870a KS |
869 | (if (= start 1) |
870 | (message "Line %d" n) | |
871 | (save-excursion | |
872 | (save-restriction | |
873 | (widen) | |
8e5d85ff | 874 | (message "line %d (narrowed line %d)" |
4109ce02 | 875 | (+ n (line-number-at-pos start) -1) n)))))) |
2578be76 | 876 | |
2076c87c JB |
877 | (defun count-lines (start end) |
878 | "Return number of lines between START and END. | |
879 | This is usually the number of newlines between them, | |
ff1fbe3e | 880 | but can be one more if START is not equal to END |
2076c87c | 881 | and the greater of them is not at the start of a line." |
e406700d RS |
882 | (save-excursion |
883 | (save-restriction | |
884 | (narrow-to-region start end) | |
885 | (goto-char (point-min)) | |
886 | (if (eq selective-display t) | |
887 | (save-match-data | |
dde92ca6 RS |
888 | (let ((done 0)) |
889 | (while (re-search-forward "[\n\C-m]" nil t 40) | |
890 | (setq done (+ 40 done))) | |
891 | (while (re-search-forward "[\n\C-m]" nil t 1) | |
892 | (setq done (+ 1 done))) | |
043efc41 RS |
893 | (goto-char (point-max)) |
894 | (if (and (/= start end) | |
895 | (not (bolp))) | |
896 | (1+ done) | |
e406700d RS |
897 | done))) |
898 | (- (buffer-size) (forward-line (buffer-size))))))) | |
eaae8106 | 899 | |
4109ce02 | 900 | (defun line-number-at-pos (&optional pos) |
f076870a | 901 | "Return (narrowed) buffer line number at position POS. |
79ffb765 RS |
902 | If POS is nil, use current buffer location. |
903 | Counting starts at (point-min), so the value refers | |
904 | to the contents of the accessible portion of the buffer." | |
f076870a KS |
905 | (let ((opoint (or pos (point))) start) |
906 | (save-excursion | |
907 | (goto-char (point-min)) | |
908 | (setq start (point)) | |
909 | (goto-char opoint) | |
910 | (forward-line 0) | |
911 | (1+ (count-lines start (point)))))) | |
912 | ||
d5d99b80 KH |
913 | (defun what-cursor-position (&optional detail) |
914 | "Print info on cursor position (on screen and within buffer). | |
e38dff0c | 915 | Also describe the character after point, and give its character code |
c6fcc518 KH |
916 | in octal, decimal and hex. |
917 | ||
918 | For a non-ASCII multibyte character, also give its encoding in the | |
919 | buffer's selected coding system if the coding system encodes the | |
920 | character safely. If the character is encoded into one byte, that | |
921 | code is shown in hex. If the character is encoded into more than one | |
922 | byte, just \"...\" is shown. | |
e5a902cf | 923 | |
24dad5d5 | 924 | In addition, with prefix argument, show details about that character |
0b69eec5 | 925 | in *Help* buffer. See also the command `describe-char'." |
d5d99b80 | 926 | (interactive "P") |
2076c87c JB |
927 | (let* ((char (following-char)) |
928 | (beg (point-min)) | |
929 | (end (point-max)) | |
930 | (pos (point)) | |
931 | (total (buffer-size)) | |
932 | (percent (if (> total 50000) | |
933 | ;; Avoid overflow from multiplying by 100! | |
934 | (/ (+ (/ total 200) (1- pos)) (max (/ total 100) 1)) | |
935 | (/ (+ (/ total 2) (* 100 (1- pos))) (max total 1)))) | |
936 | (hscroll (if (= (window-hscroll) 0) | |
937 | "" | |
938 | (format " Hscroll=%d" (window-hscroll)))) | |
939 | (col (current-column))) | |
940 | (if (= pos end) | |
941 | (if (or (/= beg 1) (/= end (1+ total))) | |
a17a79c0 | 942 | (message "point=%d of %d (%d%%) <%d-%d> column=%d%s" |
2076c87c | 943 | pos total percent beg end col hscroll) |
a17a79c0 | 944 | (message "point=%d of %d (EOB) column=%d%s" |
63219d53 | 945 | pos total col hscroll)) |
c6fcc518 | 946 | (let ((coding buffer-file-coding-system) |
a41b50ca | 947 | encoded encoding-msg display-prop under-display) |
c6fcc518 KH |
948 | (if (or (not coding) |
949 | (eq (coding-system-type coding) t)) | |
950 | (setq coding default-buffer-file-coding-system)) | |
28fd4883 KH |
951 | (if (not (char-valid-p char)) |
952 | (setq encoding-msg | |
a17a79c0 | 953 | (format "(%d, #o%o, #x%x, invalid)" char char char)) |
a41b50ca KH |
954 | ;; Check if the character is displayed with some `display' |
955 | ;; text property. In that case, set under-display to the | |
956 | ;; buffer substring covered by that property. | |
957 | (setq display-prop (get-text-property pos 'display)) | |
958 | (if display-prop | |
959 | (let ((to (or (next-single-property-change pos 'display) | |
960 | (point-max)))) | |
961 | (if (< to (+ pos 4)) | |
962 | (setq under-display "") | |
963 | (setq under-display "..." | |
964 | to (+ pos 4))) | |
965 | (setq under-display | |
966 | (concat (buffer-substring-no-properties pos to) | |
967 | under-display))) | |
968 | (setq encoded (and (>= char 128) (encode-coding-char char coding)))) | |
28fd4883 | 969 | (setq encoding-msg |
a41b50ca KH |
970 | (if display-prop |
971 | (if (not (stringp display-prop)) | |
a17a79c0 | 972 | (format "(%d, #o%o, #x%x, part of display \"%s\")" |
a41b50ca | 973 | char char char under-display) |
a17a79c0 | 974 | (format "(%d, #o%o, #x%x, part of display \"%s\"->\"%s\")" |
a41b50ca KH |
975 | char char char under-display display-prop)) |
976 | (if encoded | |
a17a79c0 | 977 | (format "(%d, #o%o, #x%x, file %s)" |
a41b50ca KH |
978 | char char char |
979 | (if (> (length encoded) 1) | |
980 | "..." | |
981 | (encoded-string-description encoded coding))) | |
a17a79c0 | 982 | (format "(%d, #o%o, #x%x)" char char char))))) |
e5e89e48 | 983 | (if detail |
24dad5d5 | 984 | ;; We show the detailed information about CHAR. |
0b69eec5 | 985 | (describe-char (point))) |
24dad5d5 | 986 | (if (or (/= beg 1) (/= end (1+ total))) |
a17a79c0 | 987 | (message "Char: %s %s point=%d of %d (%d%%) <%d-%d> column=%d%s" |
e5a902cf KH |
988 | (if (< char 256) |
989 | (single-key-description char) | |
f0d16a7f | 990 | (buffer-substring-no-properties (point) (1+ (point)))) |
24dad5d5 | 991 | encoding-msg pos total percent beg end col hscroll) |
a17a79c0 | 992 | (message "Char: %s %s point=%d of %d (%d%%) column=%d%s" |
a41b50ca KH |
993 | (if enable-multibyte-characters |
994 | (if (< char 128) | |
995 | (single-key-description char) | |
996 | (buffer-substring-no-properties (point) (1+ (point)))) | |
997 | (single-key-description char)) | |
24dad5d5 | 998 | encoding-msg pos total percent col hscroll)))))) |
2d88b556 | 999 | \f |
71a05b36 RS |
1000 | ;; Initialize read-expression-map. It is defined at C level. |
1001 | (let ((m (make-sparse-keymap))) | |
1002 | (define-key m "\M-\t" 'lisp-complete-symbol) | |
1003 | (set-keymap-parent m minibuffer-local-map) | |
1004 | (setq read-expression-map m)) | |
854c16c5 | 1005 | |
8570b0ca RM |
1006 | (defvar read-expression-history nil) |
1007 | ||
b49df39d | 1008 | (defcustom eval-expression-print-level 4 |
2f7e1f5a | 1009 | "Value for `print-level' while printing value in `eval-expression'. |
d26b26dc | 1010 | A value of nil means no limit." |
b49df39d | 1011 | :group 'lisp |
058d4999 | 1012 | :type '(choice (const :tag "No Limit" nil) integer) |
b49df39d RS |
1013 | :version "21.1") |
1014 | ||
1015 | (defcustom eval-expression-print-length 12 | |
2f7e1f5a | 1016 | "Value for `print-length' while printing value in `eval-expression'. |
d26b26dc | 1017 | A value of nil means no limit." |
b49df39d | 1018 | :group 'lisp |
058d4999 | 1019 | :type '(choice (const :tag "No Limit" nil) integer) |
b49df39d RS |
1020 | :version "21.1") |
1021 | ||
1022 | (defcustom eval-expression-debug-on-error t | |
2f7e1f5a | 1023 | "If non-nil set `debug-on-error' to t in `eval-expression'. |
ed8bcabe | 1024 | If nil, don't change the value of `debug-on-error'." |
b49df39d RS |
1025 | :group 'lisp |
1026 | :type 'boolean | |
1027 | :version "21.1") | |
1028 | ||
fa219ebd JL |
1029 | (defun eval-expression-print-format (value) |
1030 | "Format VALUE as a result of evaluated expression. | |
1031 | Return a formatted string which is displayed in the echo area | |
1032 | in addition to the value printed by prin1 in functions which | |
1033 | display the result of expression evaluation." | |
1034 | (if (and (integerp value) | |
c9f0110e | 1035 | (or (not (memq this-command '(eval-last-sexp eval-print-last-sexp))) |
fa219ebd | 1036 | (eq this-command last-command) |
56abefac | 1037 | (if (boundp 'edebug-active) edebug-active))) |
fa219ebd | 1038 | (let ((char-string |
9bb25ed3 | 1039 | (if (or (if (boundp 'edebug-active) edebug-active) |
c9f0110e | 1040 | (memq this-command '(eval-last-sexp eval-print-last-sexp))) |
fa219ebd JL |
1041 | (prin1-char value)))) |
1042 | (if char-string | |
1b5fd09e SM |
1043 | (format " (#o%o, #x%x, %s)" value value char-string) |
1044 | (format " (#o%o, #x%x)" value value))))) | |
fa219ebd | 1045 | |
8570b0ca | 1046 | ;; We define this, rather than making `eval' interactive, |
ac052b48 | 1047 | ;; for the sake of completion of names like eval-region, eval-buffer. |
ecb7ad00 RS |
1048 | (defun eval-expression (eval-expression-arg |
1049 | &optional eval-expression-insert-value) | |
a6a1ee53 EZ |
1050 | "Evaluate EVAL-EXPRESSION-ARG and print value in the echo area. |
1051 | Value is also consed on to front of the variable `values'. | |
1052 | Optional argument EVAL-EXPRESSION-INSERT-VALUE, if non-nil, means | |
1053 | insert the result into the current buffer instead of printing it in | |
b4f73994 RS |
1054 | the echo area. |
1055 | ||
1056 | If `eval-expression-debug-on-error' is non-nil, which is the default, | |
1057 | this command arranges for all errors to enter the debugger." | |
adca5fa6 | 1058 | (interactive |
b387ef9a RS |
1059 | (list (read-from-minibuffer "Eval: " |
1060 | nil read-expression-map t | |
ecb7ad00 RS |
1061 | 'read-expression-history) |
1062 | current-prefix-arg)) | |
eaae8106 | 1063 | |
ed8bcabe GM |
1064 | (if (null eval-expression-debug-on-error) |
1065 | (setq values (cons (eval eval-expression-arg) values)) | |
1066 | (let ((old-value (make-symbol "t")) new-value) | |
1067 | ;; Bind debug-on-error to something unique so that we can | |
1068 | ;; detect when evaled code changes it. | |
1069 | (let ((debug-on-error old-value)) | |
1070 | (setq values (cons (eval eval-expression-arg) values)) | |
1071 | (setq new-value debug-on-error)) | |
1072 | ;; If evaled code has changed the value of debug-on-error, | |
1073 | ;; propagate that change to the global binding. | |
1074 | (unless (eq old-value new-value) | |
1075 | (setq debug-on-error new-value)))) | |
eaae8106 | 1076 | |
b49df39d RS |
1077 | (let ((print-length eval-expression-print-length) |
1078 | (print-level eval-expression-print-level)) | |
b82d844f RS |
1079 | (if eval-expression-insert-value |
1080 | (with-no-warnings | |
683e7415 RS |
1081 | (let ((standard-output (current-buffer))) |
1082 | (eval-last-sexp-print-value (car values)))) | |
fa219ebd JL |
1083 | (prog1 |
1084 | (prin1 (car values) t) | |
1085 | (let ((str (eval-expression-print-format (car values)))) | |
1086 | (if str (princ str t))))))) | |
2076c87c JB |
1087 | |
1088 | (defun edit-and-eval-command (prompt command) | |
1089 | "Prompting with PROMPT, let user edit COMMAND and eval result. | |
1090 | COMMAND is a Lisp expression. Let user edit that expression in | |
1091 | the minibuffer, then read and evaluate the result." | |
9f4b6084 | 1092 | (let ((command |
11178a06 LT |
1093 | (let ((print-level nil) |
1094 | (minibuffer-history-sexp-flag (1+ (minibuffer-depth)))) | |
1095 | (unwind-protect | |
1096 | (read-from-minibuffer prompt | |
1097 | (prin1-to-string command) | |
1098 | read-expression-map t | |
1099 | 'command-history) | |
1100 | ;; If command was added to command-history as a string, | |
1101 | ;; get rid of that. We want only evaluable expressions there. | |
1102 | (if (stringp (car command-history)) | |
1103 | (setq command-history (cdr command-history))))))) | |
5d6c83ae KH |
1104 | |
1105 | ;; If command to be redone does not match front of history, | |
1106 | ;; add it to the history. | |
1107 | (or (equal command (car command-history)) | |
1108 | (setq command-history (cons command command-history))) | |
2076c87c JB |
1109 | (eval command))) |
1110 | ||
ebb61177 | 1111 | (defun repeat-complex-command (arg) |
2076c87c JB |
1112 | "Edit and re-evaluate last complex command, or ARGth from last. |
1113 | A complex command is one which used the minibuffer. | |
1114 | The command is placed in the minibuffer as a Lisp form for editing. | |
1115 | The result is executed, repeating the command as changed. | |
1116 | If the command has been changed or is not the most recent previous command | |
1117 | it is added to the front of the command history. | |
eb6e9899 RS |
1118 | You can use the minibuffer history commands \\<minibuffer-local-map>\\[next-history-element] and \\[previous-history-element] |
1119 | to get different commands to edit and resubmit." | |
2076c87c | 1120 | (interactive "p") |
ba343182 | 1121 | (let ((elt (nth (1- arg) command-history)) |
2076c87c JB |
1122 | newcmd) |
1123 | (if elt | |
854c16c5 | 1124 | (progn |
eab22e27 | 1125 | (setq newcmd |
74ae5fab RS |
1126 | (let ((print-level nil) |
1127 | (minibuffer-history-position arg) | |
99ea24de | 1128 | (minibuffer-history-sexp-flag (1+ (minibuffer-depth)))) |
9f4b6084 MR |
1129 | (unwind-protect |
1130 | (read-from-minibuffer | |
1131 | "Redo: " (prin1-to-string elt) read-expression-map t | |
1132 | (cons 'command-history arg)) | |
1133 | ||
1134 | ;; If command was added to command-history as a | |
1135 | ;; string, get rid of that. We want only | |
1136 | ;; evaluable expressions there. | |
1137 | (if (stringp (car command-history)) | |
1138 | (setq command-history (cdr command-history)))))) | |
db16f109 RS |
1139 | |
1140 | ;; If command to be redone does not match front of history, | |
1141 | ;; add it to the history. | |
1142 | (or (equal newcmd (car command-history)) | |
1143 | (setq command-history (cons newcmd command-history))) | |
2076c87c | 1144 | (eval newcmd)) |
536b728a RS |
1145 | (if command-history |
1146 | (error "Argument %d is beyond length of command history" arg) | |
1147 | (error "There are no previous complex commands to repeat"))))) | |
2d88b556 | 1148 | \f |
854c16c5 RS |
1149 | (defvar minibuffer-history nil |
1150 | "Default minibuffer history list. | |
1151 | This is used for all minibuffer input | |
1152 | except when an alternate history list is specified.") | |
1153 | (defvar minibuffer-history-sexp-flag nil | |
2c6a2254 RS |
1154 | "Control whether history list elements are expressions or strings. |
1155 | If the value of this variable equals current minibuffer depth, | |
1156 | they are expressions; otherwise they are strings. | |
7979163c | 1157 | \(That convention is designed to do the right thing for |
2c6a2254 | 1158 | recursive uses of the minibuffer.)") |
e91f80c4 | 1159 | (setq minibuffer-history-variable 'minibuffer-history) |
535c8bdb | 1160 | (setq minibuffer-history-position nil) ;; Defvar is in C code. |
854c16c5 | 1161 | (defvar minibuffer-history-search-history nil) |
e91f80c4 | 1162 | |
93cee14b RS |
1163 | (defvar minibuffer-text-before-history nil |
1164 | "Text that was in this minibuffer before any history commands. | |
1165 | This is nil if there have not yet been any history commands | |
1166 | in this use of the minibuffer.") | |
1167 | ||
1168 | (add-hook 'minibuffer-setup-hook 'minibuffer-history-initialize) | |
1169 | ||
1170 | (defun minibuffer-history-initialize () | |
1171 | (setq minibuffer-text-before-history nil)) | |
1172 | ||
6e7d0ff7 MB |
1173 | (defun minibuffer-avoid-prompt (new old) |
1174 | "A point-motion hook for the minibuffer, that moves point out of the prompt." | |
1175 | (constrain-to-field nil (point-max))) | |
1176 | ||
6e30a99a RS |
1177 | (defcustom minibuffer-history-case-insensitive-variables nil |
1178 | "*Minibuffer history variables for which matching should ignore case. | |
1179 | If a history variable is a member of this list, then the | |
1180 | \\[previous-matching-history-element] and \\[next-matching-history-element]\ | |
1181 | commands ignore case when searching it, regardless of `case-fold-search'." | |
1182 | :type '(repeat variable) | |
1183 | :group 'minibuffer) | |
1184 | ||
e91f80c4 | 1185 | (defun previous-matching-history-element (regexp n) |
854c16c5 RS |
1186 | "Find the previous history element that matches REGEXP. |
1187 | \(Previous history elements refer to earlier actions.) | |
1188 | With prefix argument N, search for Nth previous match. | |
5c2010f0 | 1189 | If N is negative, find the next or Nth next match. |
9889af08 EZ |
1190 | Normally, history elements are matched case-insensitively if |
1191 | `case-fold-search' is non-nil, but an uppercase letter in REGEXP | |
1192 | makes the search case-sensitive. | |
6e30a99a | 1193 | See also `minibuffer-history-case-insensitive-variables'." |
854c16c5 | 1194 | (interactive |
c1172a19 | 1195 | (let* ((enable-recursive-minibuffers t) |
c1172a19 RS |
1196 | (regexp (read-from-minibuffer "Previous element matching (regexp): " |
1197 | nil | |
1198 | minibuffer-local-map | |
1199 | nil | |
5794c45d RS |
1200 | 'minibuffer-history-search-history |
1201 | (car minibuffer-history-search-history)))) | |
c1172a19 RS |
1202 | ;; Use the last regexp specified, by default, if input is empty. |
1203 | (list (if (string= regexp "") | |
a8e96cea KH |
1204 | (if minibuffer-history-search-history |
1205 | (car minibuffer-history-search-history) | |
1206 | (error "No previous history search regexp")) | |
c1172a19 | 1207 | regexp) |
854c16c5 | 1208 | (prefix-numeric-value current-prefix-arg)))) |
e276a14a MB |
1209 | (unless (zerop n) |
1210 | (if (and (zerop minibuffer-history-position) | |
1211 | (null minibuffer-text-before-history)) | |
efaac2e6 | 1212 | (setq minibuffer-text-before-history |
6d74d713 | 1213 | (minibuffer-contents-no-properties))) |
e276a14a MB |
1214 | (let ((history (symbol-value minibuffer-history-variable)) |
1215 | (case-fold-search | |
1216 | (if (isearch-no-upper-case-p regexp t) ; assume isearch.el is dumped | |
1217 | ;; On some systems, ignore case for file names. | |
1218 | (if (memq minibuffer-history-variable | |
1219 | minibuffer-history-case-insensitive-variables) | |
1220 | t | |
1221 | ;; Respect the user's setting for case-fold-search: | |
1222 | case-fold-search) | |
1223 | nil)) | |
1224 | prevpos | |
1225 | match-string | |
1226 | match-offset | |
1227 | (pos minibuffer-history-position)) | |
1228 | (while (/= n 0) | |
1229 | (setq prevpos pos) | |
1230 | (setq pos (min (max 1 (+ pos (if (< n 0) -1 1))) (length history))) | |
1231 | (when (= pos prevpos) | |
e91f80c4 | 1232 | (error (if (= pos 1) |
ccc58657 RS |
1233 | "No later matching history item" |
1234 | "No earlier matching history item"))) | |
e276a14a MB |
1235 | (setq match-string |
1236 | (if (eq minibuffer-history-sexp-flag (minibuffer-depth)) | |
7908d27c | 1237 | (let ((print-level nil)) |
e276a14a MB |
1238 | (prin1-to-string (nth (1- pos) history))) |
1239 | (nth (1- pos) history))) | |
1240 | (setq match-offset | |
1241 | (if (< n 0) | |
1242 | (and (string-match regexp match-string) | |
1243 | (match-end 0)) | |
1244 | (and (string-match (concat ".*\\(" regexp "\\)") match-string) | |
1245 | (match-beginning 1)))) | |
1246 | (when match-offset | |
1247 | (setq n (+ n (if (< n 0) 1 -1))))) | |
1248 | (setq minibuffer-history-position pos) | |
1249 | (goto-char (point-max)) | |
efaac2e6 | 1250 | (delete-minibuffer-contents) |
e276a14a | 1251 | (insert match-string) |
6d74d713 | 1252 | (goto-char (+ (minibuffer-prompt-end) match-offset)))) |
e1e04350 SM |
1253 | (if (memq (car (car command-history)) '(previous-matching-history-element |
1254 | next-matching-history-element)) | |
854c16c5 | 1255 | (setq command-history (cdr command-history)))) |
e91f80c4 | 1256 | |
e91f80c4 | 1257 | (defun next-matching-history-element (regexp n) |
854c16c5 RS |
1258 | "Find the next history element that matches REGEXP. |
1259 | \(The next history element refers to a more recent action.) | |
1260 | With prefix argument N, search for Nth next match. | |
5c2010f0 | 1261 | If N is negative, find the previous or Nth previous match. |
9889af08 EZ |
1262 | Normally, history elements are matched case-insensitively if |
1263 | `case-fold-search' is non-nil, but an uppercase letter in REGEXP | |
1264 | makes the search case-sensitive." | |
854c16c5 | 1265 | (interactive |
c1172a19 | 1266 | (let* ((enable-recursive-minibuffers t) |
c1172a19 RS |
1267 | (regexp (read-from-minibuffer "Next element matching (regexp): " |
1268 | nil | |
1269 | minibuffer-local-map | |
1270 | nil | |
e967cd11 RS |
1271 | 'minibuffer-history-search-history |
1272 | (car minibuffer-history-search-history)))) | |
c1172a19 RS |
1273 | ;; Use the last regexp specified, by default, if input is empty. |
1274 | (list (if (string= regexp "") | |
e967cd11 RS |
1275 | (if minibuffer-history-search-history |
1276 | (car minibuffer-history-search-history) | |
1277 | (error "No previous history search regexp")) | |
c1172a19 | 1278 | regexp) |
854c16c5 | 1279 | (prefix-numeric-value current-prefix-arg)))) |
e91f80c4 | 1280 | (previous-matching-history-element regexp (- n))) |
2076c87c | 1281 | |
8dc3ba7d MB |
1282 | (defvar minibuffer-temporary-goal-position nil) |
1283 | ||
ebb61177 | 1284 | (defun next-history-element (n) |
1459a43b RS |
1285 | "Puts next element of the minibuffer history in the minibuffer. |
1286 | With argument N, it uses the Nth following element." | |
2076c87c | 1287 | (interactive "p") |
0818b15e | 1288 | (or (zerop n) |
93cee14b RS |
1289 | (let ((narg (- minibuffer-history-position n)) |
1290 | (minimum (if minibuffer-default -1 0)) | |
068c712c | 1291 | elt minibuffer-returned-to-present) |
93cee14b RS |
1292 | (if (and (zerop minibuffer-history-position) |
1293 | (null minibuffer-text-before-history)) | |
efaac2e6 MB |
1294 | (setq minibuffer-text-before-history |
1295 | (minibuffer-contents-no-properties))) | |
93cee14b | 1296 | (if (< narg minimum) |
81091543 RS |
1297 | (if minibuffer-default |
1298 | (error "End of history; no next item") | |
1299 | (error "End of history; no default available"))) | |
93cee14b RS |
1300 | (if (> narg (length (symbol-value minibuffer-history-variable))) |
1301 | (error "Beginning of history; no preceding item")) | |
e1e04350 SM |
1302 | (unless (memq last-command '(next-history-element |
1303 | previous-history-element)) | |
efaac2e6 | 1304 | (let ((prompt-end (minibuffer-prompt-end))) |
8dc3ba7d MB |
1305 | (set (make-local-variable 'minibuffer-temporary-goal-position) |
1306 | (cond ((<= (point) prompt-end) prompt-end) | |
1307 | ((eobp) nil) | |
1308 | (t (point)))))) | |
a4d1159b | 1309 | (goto-char (point-max)) |
efaac2e6 | 1310 | (delete-minibuffer-contents) |
93cee14b RS |
1311 | (setq minibuffer-history-position narg) |
1312 | (cond ((= narg -1) | |
1313 | (setq elt minibuffer-default)) | |
1314 | ((= narg 0) | |
54c548db | 1315 | (setq elt (or minibuffer-text-before-history "")) |
068c712c | 1316 | (setq minibuffer-returned-to-present t) |
93cee14b RS |
1317 | (setq minibuffer-text-before-history nil)) |
1318 | (t (setq elt (nth (1- minibuffer-history-position) | |
1319 | (symbol-value minibuffer-history-variable))))) | |
1320 | (insert | |
068c712c KH |
1321 | (if (and (eq minibuffer-history-sexp-flag (minibuffer-depth)) |
1322 | (not minibuffer-returned-to-present)) | |
93cee14b RS |
1323 | (let ((print-level nil)) |
1324 | (prin1-to-string elt)) | |
1325 | elt)) | |
8dc3ba7d | 1326 | (goto-char (or minibuffer-temporary-goal-position (point-max)))))) |
2076c87c | 1327 | |
ebb61177 | 1328 | (defun previous-history-element (n) |
1459a43b RS |
1329 | "Puts previous element of the minibuffer history in the minibuffer. |
1330 | With argument N, it uses the Nth previous element." | |
2076c87c | 1331 | (interactive "p") |
2c5e21c1 | 1332 | (next-history-element (- n))) |
d0678801 RM |
1333 | |
1334 | (defun next-complete-history-element (n) | |
a4d1159b GM |
1335 | "Get next history element which completes the minibuffer before the point. |
1336 | The contents of the minibuffer after the point are deleted, and replaced | |
1337 | by the new completion." | |
d0678801 | 1338 | (interactive "p") |
b5e6f936 RM |
1339 | (let ((point-at-start (point))) |
1340 | (next-matching-history-element | |
a4d1159b | 1341 | (concat |
efaac2e6 | 1342 | "^" (regexp-quote (buffer-substring (minibuffer-prompt-end) (point)))) |
a4d1159b | 1343 | n) |
b5e6f936 RM |
1344 | ;; next-matching-history-element always puts us at (point-min). |
1345 | ;; Move to the position we were at before changing the buffer contents. | |
1346 | ;; This is still sensical, because the text before point has not changed. | |
1347 | (goto-char point-at-start))) | |
d0678801 RM |
1348 | |
1349 | (defun previous-complete-history-element (n) | |
1f6fcec3 | 1350 | "\ |
a4d1159b GM |
1351 | Get previous history element which completes the minibuffer before the point. |
1352 | The contents of the minibuffer after the point are deleted, and replaced | |
1353 | by the new completion." | |
d0678801 RM |
1354 | (interactive "p") |
1355 | (next-complete-history-element (- n))) | |
a4d1159b | 1356 | |
efaac2e6 | 1357 | ;; For compatibility with the old subr of the same name. |
a4d1159b GM |
1358 | (defun minibuffer-prompt-width () |
1359 | "Return the display width of the minibuffer prompt. | |
f33321ad | 1360 | Return 0 if current buffer is not a minibuffer." |
a4d1159b GM |
1361 | ;; Return the width of everything before the field at the end of |
1362 | ;; the buffer; this should be 0 for normal buffers. | |
efaac2e6 | 1363 | (1- (minibuffer-prompt-end))) |
2d88b556 | 1364 | \f |
2076c87c | 1365 | ;Put this on C-x u, so we can force that rather than C-_ into startup msg |
e462e42f | 1366 | (defalias 'advertised-undo 'undo) |
2076c87c | 1367 | |
1e96c007 | 1368 | (defconst undo-equiv-table (make-hash-table :test 'eq :weakness t) |
713c9020 RS |
1369 | "Table mapping redo records to the corresponding undo one. |
1370 | A redo record for undo-in-region maps to t. | |
1371 | A redo record for ordinary undo maps to the following (earlier) undo.") | |
1e96c007 SM |
1372 | |
1373 | (defvar undo-in-region nil | |
1374 | "Non-nil if `pending-undo-list' is not just a tail of `buffer-undo-list'.") | |
1375 | ||
1376 | (defvar undo-no-redo nil | |
1377 | "If t, `undo' doesn't go through redo entries.") | |
1378 | ||
a7fe694c RS |
1379 | (defvar pending-undo-list nil |
1380 | "Within a run of consecutive undo commands, list remaining to be undone. | |
8ac28be5 | 1381 | If t, we undid all the way to the end of it.") |
a7fe694c | 1382 | |
2076c87c JB |
1383 | (defun undo (&optional arg) |
1384 | "Undo some previous changes. | |
1385 | Repeat this command to undo more changes. | |
65627aad RS |
1386 | A numeric argument serves as a repeat count. |
1387 | ||
3c1b77ca | 1388 | In Transient Mark mode when the mark is active, only undo changes within |
1e96c007 | 1389 | the current region. Similarly, when not in Transient Mark mode, just \\[universal-argument] |
3c1b77ca | 1390 | as an argument limits undo to changes within the current region." |
65627aad | 1391 | (interactive "*P") |
2e033693 RS |
1392 | ;; Make last-command indicate for the next command that this was an undo. |
1393 | ;; That way, another undo will undo more. | |
1394 | ;; If we get to the end of the undo history and get an error, | |
1395 | ;; another undo command will find the undo history empty | |
1396 | ;; and will get another error. To begin undoing the undos, | |
1397 | ;; you must type some other command. | |
b553cffa | 1398 | (let ((modified (buffer-modified-p)) |
cb3b2ec0 RS |
1399 | (recent-save (recent-auto-save-p)) |
1400 | message) | |
2c6a2254 RS |
1401 | ;; If we get an error in undo-start, |
1402 | ;; the next command should not be a "consecutive undo". | |
1403 | ;; So set `this-command' to something other than `undo'. | |
1404 | (setq this-command 'undo-start) | |
1405 | ||
e967cd11 | 1406 | (unless (and (eq last-command 'undo) |
a7fe694c RS |
1407 | (or (eq pending-undo-list t) |
1408 | ;; If something (a timer or filter?) changed the buffer | |
1409 | ;; since the previous command, don't continue the undo seq. | |
1410 | (let ((list buffer-undo-list)) | |
1411 | (while (eq (car list) nil) | |
1412 | (setq list (cdr list))) | |
1413 | ;; If the last undo record made was made by undo | |
1414 | ;; it shows nothing else happened in between. | |
1415 | (gethash list undo-equiv-table)))) | |
1e96c007 SM |
1416 | (setq undo-in-region |
1417 | (if transient-mark-mode mark-active (and arg (not (numberp arg))))) | |
1418 | (if undo-in-region | |
3c1b77ca MB |
1419 | (undo-start (region-beginning) (region-end)) |
1420 | (undo-start)) | |
1421 | ;; get rid of initial undo boundary | |
1422 | (undo-more 1)) | |
9a1120ea | 1423 | ;; If we got this far, the next command should be a consecutive undo. |
2c6a2254 | 1424 | (setq this-command 'undo) |
1e96c007 SM |
1425 | ;; Check to see whether we're hitting a redo record, and if |
1426 | ;; so, ask the user whether she wants to skip the redo/undo pair. | |
1427 | (let ((equiv (gethash pending-undo-list undo-equiv-table))) | |
1428 | (or (eq (selected-window) (minibuffer-window)) | |
cb3b2ec0 RS |
1429 | (setq message (if undo-in-region |
1430 | (if equiv "Redo in region!" "Undo in region!") | |
1431 | (if equiv "Redo!" "Undo!")))) | |
0047373b | 1432 | (when (and (consp equiv) undo-no-redo) |
1e96c007 SM |
1433 | ;; The equiv entry might point to another redo record if we have done |
1434 | ;; undo-redo-undo-redo-... so skip to the very last equiv. | |
1435 | (while (let ((next (gethash equiv undo-equiv-table))) | |
1436 | (if next (setq equiv next)))) | |
1437 | (setq pending-undo-list equiv))) | |
3c1b77ca MB |
1438 | (undo-more |
1439 | (if (or transient-mark-mode (numberp arg)) | |
1440 | (prefix-numeric-value arg) | |
1441 | 1)) | |
1e96c007 | 1442 | ;; Record the fact that the just-generated undo records come from an |
713c9020 RS |
1443 | ;; undo operation--that is, they are redo records. |
1444 | ;; In the ordinary case (not within a region), map the redo | |
1445 | ;; record to the following undos. | |
1e96c007 | 1446 | ;; I don't know how to do that in the undo-in-region case. |
713c9020 RS |
1447 | (puthash buffer-undo-list |
1448 | (if undo-in-region t pending-undo-list) | |
1449 | undo-equiv-table) | |
2512c9f0 RS |
1450 | ;; Don't specify a position in the undo record for the undo command. |
1451 | ;; Instead, undoing this should move point to where the change is. | |
1452 | (let ((tail buffer-undo-list) | |
003550c5 GM |
1453 | (prev nil)) |
1454 | (while (car tail) | |
1455 | (when (integerp (car tail)) | |
1456 | (let ((pos (car tail))) | |
1e96c007 SM |
1457 | (if prev |
1458 | (setcdr prev (cdr tail)) | |
1459 | (setq buffer-undo-list (cdr tail))) | |
003550c5 GM |
1460 | (setq tail (cdr tail)) |
1461 | (while (car tail) | |
1462 | (if (eq pos (car tail)) | |
1463 | (if prev | |
1464 | (setcdr prev (cdr tail)) | |
1465 | (setq buffer-undo-list (cdr tail))) | |
1466 | (setq prev tail)) | |
1467 | (setq tail (cdr tail))) | |
1468 | (setq tail nil))) | |
1469 | (setq prev tail tail (cdr tail)))) | |
e967cd11 RS |
1470 | ;; Record what the current undo list says, |
1471 | ;; so the next command can tell if the buffer was modified in between. | |
2076c87c | 1472 | (and modified (not (buffer-modified-p)) |
cb3b2ec0 RS |
1473 | (delete-auto-save-file-if-necessary recent-save)) |
1474 | ;; Display a message announcing success. | |
1475 | (if message | |
1476 | (message message)))) | |
2076c87c | 1477 | |
e967cd11 RS |
1478 | (defun buffer-disable-undo (&optional buffer) |
1479 | "Make BUFFER stop keeping undo information. | |
1480 | No argument or nil as argument means do this for the current buffer." | |
1481 | (interactive) | |
0d808a63 | 1482 | (with-current-buffer (if buffer (get-buffer buffer) (current-buffer)) |
d020fce0 | 1483 | (setq buffer-undo-list t))) |
e967cd11 | 1484 | |
1e96c007 SM |
1485 | (defun undo-only (&optional arg) |
1486 | "Undo some previous changes. | |
1487 | Repeat this command to undo more changes. | |
1488 | A numeric argument serves as a repeat count. | |
1489 | Contrary to `undo', this will not redo a previous undo." | |
1490 | (interactive "*p") | |
1491 | (let ((undo-no-redo t)) (undo arg))) | |
1e96c007 | 1492 | |
52d1110d RS |
1493 | (defvar undo-in-progress nil |
1494 | "Non-nil while performing an undo. | |
1495 | Some change-hooks test this variable to do something different.") | |
1496 | ||
8ac28be5 | 1497 | (defun undo-more (n) |
2076c87c | 1498 | "Undo back N undo-boundaries beyond what was already undone recently. |
ff1fbe3e RS |
1499 | Call `undo-start' to get ready to undo recent changes, |
1500 | then call `undo-more' one or more times to undo them." | |
a7fe694c | 1501 | (or (listp pending-undo-list) |
8ac28be5 | 1502 | (error (concat "No further undo information" |
00fa4024 | 1503 | (and undo-in-region " for region")))) |
52d1110d | 1504 | (let ((undo-in-progress t)) |
8ac28be5 | 1505 | (setq pending-undo-list (primitive-undo n pending-undo-list)) |
a7fe694c RS |
1506 | (if (null pending-undo-list) |
1507 | (setq pending-undo-list t)))) | |
2076c87c | 1508 | |
65627aad RS |
1509 | ;; Deep copy of a list |
1510 | (defun undo-copy-list (list) | |
1511 | "Make a copy of undo list LIST." | |
1512 | (mapcar 'undo-copy-list-1 list)) | |
1513 | ||
1514 | (defun undo-copy-list-1 (elt) | |
1515 | (if (consp elt) | |
1516 | (cons (car elt) (undo-copy-list-1 (cdr elt))) | |
1517 | elt)) | |
1518 | ||
1519 | (defun undo-start (&optional beg end) | |
1520 | "Set `pending-undo-list' to the front of the undo list. | |
1521 | The next call to `undo-more' will undo the most recently made change. | |
1522 | If BEG and END are specified, then only undo elements | |
1523 | that apply to text between BEG and END are used; other undo elements | |
1524 | are ignored. If BEG and END are nil, all undo elements are used." | |
1525 | (if (eq buffer-undo-list t) | |
1526 | (error "No undo information in this buffer")) | |
1e722f9f | 1527 | (setq pending-undo-list |
65627aad RS |
1528 | (if (and beg end (not (= beg end))) |
1529 | (undo-make-selective-list (min beg end) (max beg end)) | |
1530 | buffer-undo-list))) | |
1531 | ||
1532 | (defvar undo-adjusted-markers) | |
1533 | ||
1534 | (defun undo-make-selective-list (start end) | |
1535 | "Return a list of undo elements for the region START to END. | |
1536 | The elements come from `buffer-undo-list', but we keep only | |
1537 | the elements inside this region, and discard those outside this region. | |
1538 | If we find an element that crosses an edge of this region, | |
1539 | we stop and ignore all further elements." | |
1540 | (let ((undo-list-copy (undo-copy-list buffer-undo-list)) | |
1541 | (undo-list (list nil)) | |
1542 | undo-adjusted-markers | |
1543 | some-rejected | |
1544 | undo-elt undo-elt temp-undo-list delta) | |
1545 | (while undo-list-copy | |
1546 | (setq undo-elt (car undo-list-copy)) | |
1547 | (let ((keep-this | |
1548 | (cond ((and (consp undo-elt) (eq (car undo-elt) t)) | |
1549 | ;; This is a "was unmodified" element. | |
1550 | ;; Keep it if we have kept everything thus far. | |
1551 | (not some-rejected)) | |
1552 | (t | |
1553 | (undo-elt-in-region undo-elt start end))))) | |
1554 | (if keep-this | |
1555 | (progn | |
1556 | (setq end (+ end (cdr (undo-delta undo-elt)))) | |
1557 | ;; Don't put two nils together in the list | |
1558 | (if (not (and (eq (car undo-list) nil) | |
1559 | (eq undo-elt nil))) | |
1560 | (setq undo-list (cons undo-elt undo-list)))) | |
1561 | (if (undo-elt-crosses-region undo-elt start end) | |
1562 | (setq undo-list-copy nil) | |
1563 | (setq some-rejected t) | |
1564 | (setq temp-undo-list (cdr undo-list-copy)) | |
1565 | (setq delta (undo-delta undo-elt)) | |
1566 | ||
1567 | (when (/= (cdr delta) 0) | |
1568 | (let ((position (car delta)) | |
1569 | (offset (cdr delta))) | |
1570 | ||
e1e04350 SM |
1571 | ;; Loop down the earlier events adjusting their buffer |
1572 | ;; positions to reflect the fact that a change to the buffer | |
1573 | ;; isn't being undone. We only need to process those element | |
1574 | ;; types which undo-elt-in-region will return as being in | |
1575 | ;; the region since only those types can ever get into the | |
1576 | ;; output | |
65627aad RS |
1577 | |
1578 | (while temp-undo-list | |
1579 | (setq undo-elt (car temp-undo-list)) | |
1580 | (cond ((integerp undo-elt) | |
1581 | (if (>= undo-elt position) | |
1582 | (setcar temp-undo-list (- undo-elt offset)))) | |
1583 | ((atom undo-elt) nil) | |
1584 | ((stringp (car undo-elt)) | |
1585 | ;; (TEXT . POSITION) | |
1586 | (let ((text-pos (abs (cdr undo-elt))) | |
1587 | (point-at-end (< (cdr undo-elt) 0 ))) | |
1588 | (if (>= text-pos position) | |
1e722f9f | 1589 | (setcdr undo-elt (* (if point-at-end -1 1) |
65627aad RS |
1590 | (- text-pos offset)))))) |
1591 | ((integerp (car undo-elt)) | |
1592 | ;; (BEGIN . END) | |
1593 | (when (>= (car undo-elt) position) | |
1594 | (setcar undo-elt (- (car undo-elt) offset)) | |
1595 | (setcdr undo-elt (- (cdr undo-elt) offset)))) | |
1596 | ((null (car undo-elt)) | |
1597 | ;; (nil PROPERTY VALUE BEG . END) | |
1598 | (let ((tail (nthcdr 3 undo-elt))) | |
1599 | (when (>= (car tail) position) | |
1600 | (setcar tail (- (car tail) offset)) | |
1601 | (setcdr tail (- (cdr tail) offset)))))) | |
1602 | (setq temp-undo-list (cdr temp-undo-list)))))))) | |
1603 | (setq undo-list-copy (cdr undo-list-copy))) | |
1604 | (nreverse undo-list))) | |
1605 | ||
1606 | (defun undo-elt-in-region (undo-elt start end) | |
1607 | "Determine whether UNDO-ELT falls inside the region START ... END. | |
1608 | If it crosses the edge, we return nil." | |
1609 | (cond ((integerp undo-elt) | |
1610 | (and (>= undo-elt start) | |
12a93712 | 1611 | (<= undo-elt end))) |
65627aad RS |
1612 | ((eq undo-elt nil) |
1613 | t) | |
1614 | ((atom undo-elt) | |
1615 | nil) | |
1616 | ((stringp (car undo-elt)) | |
1617 | ;; (TEXT . POSITION) | |
1618 | (and (>= (abs (cdr undo-elt)) start) | |
1619 | (< (abs (cdr undo-elt)) end))) | |
1620 | ((and (consp undo-elt) (markerp (car undo-elt))) | |
1621 | ;; This is a marker-adjustment element (MARKER . ADJUSTMENT). | |
1622 | ;; See if MARKER is inside the region. | |
1623 | (let ((alist-elt (assq (car undo-elt) undo-adjusted-markers))) | |
1624 | (unless alist-elt | |
1625 | (setq alist-elt (cons (car undo-elt) | |
1626 | (marker-position (car undo-elt)))) | |
1627 | (setq undo-adjusted-markers | |
1628 | (cons alist-elt undo-adjusted-markers))) | |
1629 | (and (cdr alist-elt) | |
1630 | (>= (cdr alist-elt) start) | |
12a93712 | 1631 | (<= (cdr alist-elt) end)))) |
65627aad RS |
1632 | ((null (car undo-elt)) |
1633 | ;; (nil PROPERTY VALUE BEG . END) | |
1634 | (let ((tail (nthcdr 3 undo-elt))) | |
1635 | (and (>= (car tail) start) | |
12a93712 | 1636 | (<= (cdr tail) end)))) |
65627aad RS |
1637 | ((integerp (car undo-elt)) |
1638 | ;; (BEGIN . END) | |
1639 | (and (>= (car undo-elt) start) | |
12a93712 | 1640 | (<= (cdr undo-elt) end))))) |
65627aad RS |
1641 | |
1642 | (defun undo-elt-crosses-region (undo-elt start end) | |
1643 | "Test whether UNDO-ELT crosses one edge of that region START ... END. | |
1644 | This assumes we have already decided that UNDO-ELT | |
1645 | is not *inside* the region START...END." | |
1646 | (cond ((atom undo-elt) nil) | |
1647 | ((null (car undo-elt)) | |
1648 | ;; (nil PROPERTY VALUE BEG . END) | |
1649 | (let ((tail (nthcdr 3 undo-elt))) | |
1f8a132d RS |
1650 | (and (< (car tail) end) |
1651 | (> (cdr tail) start)))) | |
65627aad RS |
1652 | ((integerp (car undo-elt)) |
1653 | ;; (BEGIN . END) | |
1f8a132d RS |
1654 | (and (< (car undo-elt) end) |
1655 | (> (cdr undo-elt) start))))) | |
65627aad RS |
1656 | |
1657 | ;; Return the first affected buffer position and the delta for an undo element | |
1658 | ;; delta is defined as the change in subsequent buffer positions if we *did* | |
1659 | ;; the undo. | |
1660 | (defun undo-delta (undo-elt) | |
1661 | (if (consp undo-elt) | |
1662 | (cond ((stringp (car undo-elt)) | |
1663 | ;; (TEXT . POSITION) | |
1664 | (cons (abs (cdr undo-elt)) (length (car undo-elt)))) | |
1665 | ((integerp (car undo-elt)) | |
1666 | ;; (BEGIN . END) | |
1667 | (cons (car undo-elt) (- (car undo-elt) (cdr undo-elt)))) | |
1668 | (t | |
1669 | '(0 . 0))) | |
1670 | '(0 . 0))) | |
b6e8e8e5 | 1671 | |
1223933d | 1672 | (defcustom undo-ask-before-discard nil |
28cb725d LT |
1673 | "If non-nil ask about discarding undo info for the current command. |
1674 | Normally, Emacs discards the undo info for the current command if | |
1675 | it exceeds `undo-outer-limit'. But if you set this option | |
1676 | non-nil, it asks in the echo area whether to discard the info. | |
a3545af4 | 1677 | If you answer no, there is a slight risk that Emacs might crash, so |
28cb725d LT |
1678 | only do it if you really want to undo the command. |
1679 | ||
1680 | This option is mainly intended for debugging. You have to be | |
1681 | careful if you use it for other purposes. Garbage collection is | |
1682 | inhibited while the question is asked, meaning that Emacs might | |
1683 | leak memory. So you should make sure that you do not wait | |
1684 | excessively long before answering the question." | |
1685 | :type 'boolean | |
1686 | :group 'undo | |
bf247b6e | 1687 | :version "22.1") |
28cb725d | 1688 | |
a1a801de RS |
1689 | (defvar undo-extra-outer-limit nil |
1690 | "If non-nil, an extra level of size that's ok in an undo item. | |
1691 | We don't ask the user about truncating the undo list until the | |
28cb725d LT |
1692 | current item gets bigger than this amount. |
1693 | ||
1694 | This variable only matters if `undo-ask-before-discard' is non-nil.") | |
a1a801de RS |
1695 | (make-variable-buffer-local 'undo-extra-outer-limit) |
1696 | ||
28cb725d LT |
1697 | ;; When the first undo batch in an undo list is longer than |
1698 | ;; undo-outer-limit, this function gets called to warn the user that | |
1699 | ;; the undo info for the current command was discarded. Garbage | |
1700 | ;; collection is inhibited around the call, so it had better not do a | |
1701 | ;; lot of consing. | |
b6e8e8e5 RS |
1702 | (setq undo-outer-limit-function 'undo-outer-limit-truncate) |
1703 | (defun undo-outer-limit-truncate (size) | |
28cb725d LT |
1704 | (if undo-ask-before-discard |
1705 | (when (or (null undo-extra-outer-limit) | |
1706 | (> size undo-extra-outer-limit)) | |
1707 | ;; Don't ask the question again unless it gets even bigger. | |
1708 | ;; This applies, in particular, if the user quits from the question. | |
1709 | ;; Such a quit quits out of GC, but something else will call GC | |
1710 | ;; again momentarily. It will call this function again, | |
1711 | ;; but we don't want to ask the question again. | |
1712 | (setq undo-extra-outer-limit (+ size 50000)) | |
1713 | (if (let (use-dialog-box track-mouse executing-kbd-macro ) | |
d5aa078b | 1714 | (yes-or-no-p (format "Buffer `%s' undo info is %d bytes long; discard it? " |
28cb725d LT |
1715 | (buffer-name) size))) |
1716 | (progn (setq buffer-undo-list nil) | |
1717 | (setq undo-extra-outer-limit nil) | |
1718 | t) | |
1719 | nil)) | |
1720 | (display-warning '(undo discard-info) | |
1721 | (concat | |
d5aa078b | 1722 | (format "Buffer `%s' undo info was %d bytes long.\n" |
28cb725d LT |
1723 | (buffer-name) size) |
1724 | "The undo info was discarded because it exceeded \ | |
1725 | `undo-outer-limit'. | |
1726 | ||
1727 | This is normal if you executed a command that made a huge change | |
1728 | to the buffer. In that case, to prevent similar problems in the | |
1729 | future, set `undo-outer-limit' to a value that is large enough to | |
1730 | cover the maximum size of normal changes you expect a single | |
1731 | command to make, but not so large that it might exceed the | |
1732 | maximum memory allotted to Emacs. | |
1733 | ||
1734 | If you did not execute any such command, the situation is | |
1735 | probably due to a bug and you should report it. | |
1736 | ||
1737 | You can disable the popping up of this buffer by adding the entry | |
1738 | \(undo discard-info) to the user option `warning-suppress-types'.\n") | |
1739 | :warning) | |
1740 | (setq buffer-undo-list nil) | |
1741 | t)) | |
e1e04350 | 1742 | \f |
009ef402 RS |
1743 | (defvar shell-command-history nil |
1744 | "History list for some commands that read shell commands.") | |
1745 | ||
59fc41e5 RS |
1746 | (defvar shell-command-switch "-c" |
1747 | "Switch used to have the shell execute its command line argument.") | |
1748 | ||
cc039f78 KH |
1749 | (defvar shell-command-default-error-buffer nil |
1750 | "*Buffer name for `shell-command' and `shell-command-on-region' error output. | |
637fff82 | 1751 | This buffer is used when `shell-command' or `shell-command-on-region' |
cc039f78 KH |
1752 | is run interactively. A value of nil means that output to stderr and |
1753 | stdout will be intermixed in the output stream.") | |
1754 | ||
1755 | (defun shell-command (command &optional output-buffer error-buffer) | |
2076c87c | 1756 | "Execute string COMMAND in inferior shell; display output, if any. |
0b3f96d4 | 1757 | With prefix argument, insert the COMMAND's output at point. |
d382f610 | 1758 | |
2076c87c | 1759 | If COMMAND ends in ampersand, execute it asynchronously. |
d382f610 | 1760 | The output appears in the buffer `*Async Shell Command*'. |
bcad4985 | 1761 | That buffer is in shell mode. |
d382f610 | 1762 | |
939ac10c GM |
1763 | Otherwise, COMMAND is executed synchronously. The output appears in |
1764 | the buffer `*Shell Command Output*'. If the output is short enough to | |
1765 | display in the echo area (which is determined by the variables | |
1766 | `resize-mini-windows' and `max-mini-window-height'), it is shown | |
1767 | there, but it is nonetheless available in buffer `*Shell Command | |
e1e04350 | 1768 | Output*' even though that buffer is not automatically displayed. |
d0d74413 | 1769 | |
07f458c1 RS |
1770 | To specify a coding system for converting non-ASCII characters |
1771 | in the shell command output, use \\[universal-coding-system-argument] | |
1772 | before this command. | |
1773 | ||
1774 | Noninteractive callers can specify coding systems by binding | |
1775 | `coding-system-for-read' and `coding-system-for-write'. | |
1776 | ||
d0d74413 RS |
1777 | The optional second argument OUTPUT-BUFFER, if non-nil, |
1778 | says to put the output in some other buffer. | |
1779 | If OUTPUT-BUFFER is a buffer or buffer name, put the output there. | |
1780 | If OUTPUT-BUFFER is not a buffer and not nil, | |
1781 | insert output in current buffer. (This cannot be done asynchronously.) | |
cc039f78 KH |
1782 | In either case, the output is inserted after point (leaving mark after it). |
1783 | ||
2e033693 RS |
1784 | If the command terminates without error, but generates output, |
1785 | and you did not specify \"insert it in the current buffer\", | |
1786 | the output can be displayed in the echo area or in its buffer. | |
1787 | If the output is short enough to display in the echo area | |
1788 | \(determined by the variable `max-mini-window-height' if | |
1789 | `resize-mini-windows' is non-nil), it is shown there. Otherwise, | |
1790 | the buffer containing the output is displayed. | |
1791 | ||
1792 | If there is output and an error, and you did not specify \"insert it | |
1793 | in the current buffer\", a message about the error goes at the end | |
1794 | of the output. | |
1795 | ||
1796 | If there is no output, or if output is inserted in the current buffer, | |
1797 | then `*Shell Command Output*' is deleted. | |
1798 | ||
cc039f78 KH |
1799 | If the optional third argument ERROR-BUFFER is non-nil, it is a buffer |
1800 | or buffer name to which to direct the command's standard error output. | |
1801 | If it is nil, error output is mingled with regular output. | |
1802 | In an interactive call, the variable `shell-command-default-error-buffer' | |
1803 | specifies the value of ERROR-BUFFER." | |
1804 | ||
aa00b92d RS |
1805 | (interactive (list (read-from-minibuffer "Shell command: " |
1806 | nil nil nil 'shell-command-history) | |
cc039f78 KH |
1807 | current-prefix-arg |
1808 | shell-command-default-error-buffer)) | |
c7edd03c KH |
1809 | ;; Look for a handler in case default-directory is a remote file name. |
1810 | (let ((handler | |
1811 | (find-file-name-handler (directory-file-name default-directory) | |
1812 | 'shell-command))) | |
1813 | (if handler | |
cc039f78 | 1814 | (funcall handler 'shell-command command output-buffer error-buffer) |
c7edd03c KH |
1815 | (if (and output-buffer |
1816 | (not (or (bufferp output-buffer) (stringp output-buffer)))) | |
2e033693 | 1817 | ;; Output goes in current buffer. |
cc039f78 | 1818 | (let ((error-file |
1e722f9f | 1819 | (if error-buffer |
b005abd5 | 1820 | (make-temp-file |
171a45d9 EZ |
1821 | (expand-file-name "scor" |
1822 | (or small-temporary-file-directory | |
1823 | temporary-file-directory))) | |
cc039f78 KH |
1824 | nil))) |
1825 | (barf-if-buffer-read-only) | |
63437623 | 1826 | (push-mark nil t) |
cc039f78 KH |
1827 | ;; We do not use -f for csh; we will not support broken use of |
1828 | ;; .cshrcs. Even the BSD csh manual says to use | |
1829 | ;; "if ($?prompt) exit" before things which are not useful | |
1830 | ;; non-interactively. Besides, if someone wants their other | |
1831 | ;; aliases for shell commands then they can still have them. | |
1e722f9f | 1832 | (call-process shell-file-name nil |
cc039f78 KH |
1833 | (if error-file |
1834 | (list t error-file) | |
1835 | t) | |
1836 | nil shell-command-switch command) | |
1837 | (when (and error-file (file-exists-p error-file)) | |
1838 | (if (< 0 (nth 7 (file-attributes error-file))) | |
1839 | (with-current-buffer (get-buffer-create error-buffer) | |
1840 | (let ((pos-from-end (- (point-max) (point)))) | |
1841 | (or (bobp) | |
1842 | (insert "\f\n")) | |
1843 | ;; Do no formatting while reading error file, | |
1844 | ;; because that can run a shell command, and we | |
1845 | ;; don't want that to cause an infinite recursion. | |
1846 | (format-insert-file error-file nil) | |
1847 | ;; Put point after the inserted errors. | |
1848 | (goto-char (- (point-max) pos-from-end))) | |
1849 | (display-buffer (current-buffer)))) | |
1850 | (delete-file error-file)) | |
1851 | ;; This is like exchange-point-and-mark, but doesn't | |
1852 | ;; activate the mark. It is cleaner to avoid activation, | |
1853 | ;; even though the command loop would deactivate the mark | |
1854 | ;; because we inserted text. | |
1855 | (goto-char (prog1 (mark t) | |
1856 | (set-marker (mark-marker) (point) | |
1857 | (current-buffer))))) | |
2e033693 | 1858 | ;; Output goes in a separate buffer. |
c7edd03c KH |
1859 | ;; Preserve the match data in case called from a program. |
1860 | (save-match-data | |
aab5d2c5 | 1861 | (if (string-match "[ \t]*&[ \t]*\\'" command) |
c7edd03c KH |
1862 | ;; Command ending with ampersand means asynchronous. |
1863 | (let ((buffer (get-buffer-create | |
1864 | (or output-buffer "*Async Shell Command*"))) | |
1865 | (directory default-directory) | |
1866 | proc) | |
1867 | ;; Remove the ampersand. | |
1868 | (setq command (substring command 0 (match-beginning 0))) | |
1869 | ;; If will kill a process, query first. | |
1870 | (setq proc (get-buffer-process buffer)) | |
1871 | (if proc | |
1872 | (if (yes-or-no-p "A command is running. Kill it? ") | |
1873 | (kill-process proc) | |
1874 | (error "Shell command in progress"))) | |
1e96c007 | 1875 | (with-current-buffer buffer |
c7edd03c KH |
1876 | (setq buffer-read-only nil) |
1877 | (erase-buffer) | |
1878 | (display-buffer buffer) | |
1879 | (setq default-directory directory) | |
1e722f9f | 1880 | (setq proc (start-process "Shell" buffer shell-file-name |
c7edd03c KH |
1881 | shell-command-switch command)) |
1882 | (setq mode-line-process '(":%s")) | |
c2020c27 | 1883 | (require 'shell) (shell-mode) |
c7edd03c KH |
1884 | (set-process-sentinel proc 'shell-command-sentinel) |
1885 | )) | |
cc039f78 KH |
1886 | (shell-command-on-region (point) (point) command |
1887 | output-buffer nil error-buffer))))))) | |
eaae8106 | 1888 | |
f69aad2b MB |
1889 | (defun display-message-or-buffer (message |
1890 | &optional buffer-name not-this-window frame) | |
1891 | "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer. | |
1892 | MESSAGE may be either a string or a buffer. | |
1893 | ||
1894 | A buffer is displayed using `display-buffer' if MESSAGE is too long for | |
939ac10c GM |
1895 | the maximum height of the echo area, as defined by `max-mini-window-height' |
1896 | if `resize-mini-windows' is non-nil. | |
f69aad2b | 1897 | |
2a3f00bf MB |
1898 | Returns either the string shown in the echo area, or when a pop-up |
1899 | buffer is used, the window used to display it. | |
1900 | ||
f69aad2b MB |
1901 | If MESSAGE is a string, then the optional argument BUFFER-NAME is the |
1902 | name of the buffer used to display it in the case where a pop-up buffer | |
1903 | is used, defaulting to `*Message*'. In the case where MESSAGE is a | |
1904 | string and it is displayed in the echo area, it is not specified whether | |
1905 | the contents are inserted into the buffer anyway. | |
1906 | ||
1907 | Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer', | |
1908 | and only used if a buffer is displayed." | |
aca2d9bb EZ |
1909 | (cond ((and (stringp message) |
1910 | (not (string-match "\n" message)) | |
1911 | (<= (length message) (frame-width))) | |
f69aad2b MB |
1912 | ;; Trivial case where we can use the echo area |
1913 | (message "%s" message)) | |
1914 | ((and (stringp message) | |
aca2d9bb EZ |
1915 | (= (string-match "\n" message) (1- (length message))) |
1916 | (<= (1- (length message)) (frame-width))) | |
f69aad2b MB |
1917 | ;; Trivial case where we can just remove single trailing newline |
1918 | (message "%s" (substring message 0 (1- (length message))))) | |
1919 | (t | |
1920 | ;; General case | |
1921 | (with-current-buffer | |
1922 | (if (bufferp message) | |
1923 | message | |
1924 | (get-buffer-create (or buffer-name "*Message*"))) | |
1925 | ||
1926 | (unless (bufferp message) | |
1927 | (erase-buffer) | |
1928 | (insert message)) | |
1929 | ||
1930 | (let ((lines | |
1931 | (if (= (buffer-size) 0) | |
1932 | 0 | |
62ffcd76 | 1933 | (count-screen-lines nil nil nil (minibuffer-window))))) |
4f017185 RS |
1934 | (cond ((= lines 0)) |
1935 | ((and (or (<= lines 1) | |
aab5d2c5 RS |
1936 | (<= lines |
1937 | (if resize-mini-windows | |
1938 | (cond ((floatp max-mini-window-height) | |
1939 | (* (frame-height) | |
1940 | max-mini-window-height)) | |
1941 | ((integerp max-mini-window-height) | |
1942 | max-mini-window-height) | |
1943 | (t | |
1944 | 1)) | |
1945 | 1))) | |
1946 | ;; Don't use the echo area if the output buffer is | |
1947 | ;; already dispayed in the selected frame. | |
61b80ebf | 1948 | (not (get-buffer-window (current-buffer)))) |
f69aad2b MB |
1949 | ;; Echo area |
1950 | (goto-char (point-max)) | |
1951 | (when (bolp) | |
1952 | (backward-char 1)) | |
1953 | (message "%s" (buffer-substring (point-min) (point)))) | |
1954 | (t | |
1955 | ;; Buffer | |
1956 | (goto-char (point-min)) | |
31252c00 MB |
1957 | (display-buffer (current-buffer) |
1958 | not-this-window frame)))))))) | |
f69aad2b MB |
1959 | |
1960 | ||
2076c87c JB |
1961 | ;; We have a sentinel to prevent insertion of a termination message |
1962 | ;; in the buffer itself. | |
1963 | (defun shell-command-sentinel (process signal) | |
bcad4985 | 1964 | (if (memq (process-status process) '(exit signal)) |
1e722f9f | 1965 | (message "%s: %s." |
bcad4985 KH |
1966 | (car (cdr (cdr (process-command process)))) |
1967 | (substring signal 0 -1)))) | |
2076c87c | 1968 | |
d0d74413 | 1969 | (defun shell-command-on-region (start end command |
cce1c318 | 1970 | &optional output-buffer replace |
63619f42 | 1971 | error-buffer display-error-buffer) |
2076c87c JB |
1972 | "Execute string COMMAND in inferior shell with region as input. |
1973 | Normally display output (if any) in temp buffer `*Shell Command Output*'; | |
a0184aeb DL |
1974 | Prefix arg means replace the region with it. Return the exit code of |
1975 | COMMAND. | |
56c0450e | 1976 | |
07f458c1 RS |
1977 | To specify a coding system for converting non-ASCII characters |
1978 | in the input and output to the shell command, use \\[universal-coding-system-argument] | |
1979 | before this command. By default, the input (from the current buffer) | |
1980 | is encoded in the same coding system that will be used to save the file, | |
1981 | `buffer-file-coding-system'. If the output is going to replace the region, | |
1982 | then it is decoded from that same coding system. | |
1983 | ||
63619f42 RS |
1984 | The noninteractive arguments are START, END, COMMAND, |
1985 | OUTPUT-BUFFER, REPLACE, ERROR-BUFFER, and DISPLAY-ERROR-BUFFER. | |
1986 | Noninteractive callers can specify coding systems by binding | |
1987 | `coding-system-for-read' and `coding-system-for-write'. | |
2076c87c | 1988 | |
2e033693 RS |
1989 | If the command generates output, the output may be displayed |
1990 | in the echo area or in a buffer. | |
1991 | If the output is short enough to display in the echo area | |
1992 | \(determined by the variable `max-mini-window-height' if | |
1993 | `resize-mini-windows' is non-nil), it is shown there. Otherwise | |
1994 | it is displayed in the buffer `*Shell Command Output*'. The output | |
1995 | is available in that buffer in both cases. | |
1996 | ||
1997 | If there is output and an error, a message about the error | |
1998 | appears at the end of the output. | |
1999 | ||
2000 | If there is no output, or if output is inserted in the current buffer, | |
2001 | then `*Shell Command Output*' is deleted. | |
d0d74413 | 2002 | |
56c0450e RS |
2003 | If the optional fourth argument OUTPUT-BUFFER is non-nil, |
2004 | that says to put the output in some other buffer. | |
d0d74413 RS |
2005 | If OUTPUT-BUFFER is a buffer or buffer name, put the output there. |
2006 | If OUTPUT-BUFFER is not a buffer and not nil, | |
2007 | insert output in the current buffer. | |
cce1c318 RS |
2008 | In either case, the output is inserted after point (leaving mark after it). |
2009 | ||
8923a211 RS |
2010 | If REPLACE, the optional fifth argument, is non-nil, that means insert |
2011 | the output in place of text from START to END, putting point and mark | |
2012 | around it. | |
2013 | ||
b735c991 | 2014 | If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer |
cce1c318 | 2015 | or buffer name to which to direct the command's standard error output. |
7fd47839 | 2016 | If it is nil, error output is mingled with regular output. |
63619f42 RS |
2017 | If DISPLAY-ERROR-BUFFER is non-nil, display the error buffer if there |
2018 | were any errors. (This is always t, interactively.) | |
cc039f78 KH |
2019 | In an interactive call, the variable `shell-command-default-error-buffer' |
2020 | specifies the value of ERROR-BUFFER." | |
195ce311 RS |
2021 | (interactive (let (string) |
2022 | (unless (mark) | |
2023 | (error "The mark is not set now, so there is no region")) | |
2024 | ;; Do this before calling region-beginning | |
2025 | ;; and region-end, in case subprocess output | |
2026 | ;; relocates them while we are in the minibuffer. | |
2027 | (setq string (read-from-minibuffer "Shell command on region: " | |
2028 | nil nil nil | |
2029 | 'shell-command-history)) | |
2b03c506 RS |
2030 | ;; call-interactively recognizes region-beginning and |
2031 | ;; region-end specially, leaving them in the history. | |
2032 | (list (region-beginning) (region-end) | |
cae49185 RS |
2033 | string |
2034 | current-prefix-arg | |
7fd47839 | 2035 | current-prefix-arg |
63619f42 RS |
2036 | shell-command-default-error-buffer |
2037 | t))) | |
cce1c318 | 2038 | (let ((error-file |
171a45d9 | 2039 | (if error-buffer |
b005abd5 | 2040 | (make-temp-file |
171a45d9 EZ |
2041 | (expand-file-name "scor" |
2042 | (or small-temporary-file-directory | |
2043 | temporary-file-directory))) | |
a0184aeb DL |
2044 | nil)) |
2045 | exit-status) | |
7fd47839 RS |
2046 | (if (or replace |
2047 | (and output-buffer | |
748d6ca4 | 2048 | (not (or (bufferp output-buffer) (stringp output-buffer))))) |
7fd47839 RS |
2049 | ;; Replace specified region with output from command. |
2050 | (let ((swap (and replace (< start end)))) | |
2051 | ;; Don't muck with mark unless REPLACE says we should. | |
2052 | (goto-char start) | |
30883773 | 2053 | (and replace (push-mark (point) 'nomsg)) |
a0184aeb DL |
2054 | (setq exit-status |
2055 | (call-process-region start end shell-file-name t | |
2056 | (if error-file | |
2057 | (list t error-file) | |
2058 | t) | |
2059 | nil shell-command-switch command)) | |
e1e04350 SM |
2060 | ;; It is rude to delete a buffer which the command is not using. |
2061 | ;; (let ((shell-buffer (get-buffer "*Shell Command Output*"))) | |
2062 | ;; (and shell-buffer (not (eq shell-buffer (current-buffer))) | |
2063 | ;; (kill-buffer shell-buffer))) | |
7fd47839 RS |
2064 | ;; Don't muck with mark unless REPLACE says we should. |
2065 | (and replace swap (exchange-point-and-mark))) | |
2066 | ;; No prefix argument: put the output in a temp buffer, | |
2067 | ;; replacing its entire contents. | |
2068 | (let ((buffer (get-buffer-create | |
d4bbcbb4 | 2069 | (or output-buffer "*Shell Command Output*")))) |
7fd47839 RS |
2070 | (unwind-protect |
2071 | (if (eq buffer (current-buffer)) | |
2072 | ;; If the input is the same buffer as the output, | |
2073 | ;; delete everything but the specified region, | |
2074 | ;; then replace that region with the output. | |
2075 | (progn (setq buffer-read-only nil) | |
2076 | (delete-region (max start end) (point-max)) | |
2077 | (delete-region (point-min) (min start end)) | |
2078 | (setq exit-status | |
2079 | (call-process-region (point-min) (point-max) | |
1e722f9f | 2080 | shell-file-name t |
7fd47839 RS |
2081 | (if error-file |
2082 | (list t error-file) | |
2083 | t) | |
a0184aeb DL |
2084 | nil shell-command-switch |
2085 | command))) | |
2086 | ;; Clear the output buffer, then run the command with | |
2087 | ;; output there. | |
c2e303c8 GM |
2088 | (let ((directory default-directory)) |
2089 | (save-excursion | |
2090 | (set-buffer buffer) | |
2091 | (setq buffer-read-only nil) | |
2092 | (if (not output-buffer) | |
2093 | (setq default-directory directory)) | |
2094 | (erase-buffer))) | |
7fd47839 RS |
2095 | (setq exit-status |
2096 | (call-process-region start end shell-file-name nil | |
2097 | (if error-file | |
2098 | (list buffer error-file) | |
2099 | buffer) | |
a0184aeb | 2100 | nil shell-command-switch command))) |
2e033693 | 2101 | ;; Report the output. |
9a98fa64 | 2102 | (with-current-buffer buffer |
f1180544 | 2103 | (setq mode-line-process |
d4bbcbb4 AS |
2104 | (cond ((null exit-status) |
2105 | " - Error") | |
2106 | ((stringp exit-status) | |
2107 | (format " - Signal [%s]" exit-status)) | |
2108 | ((not (equal 0 exit-status)) | |
2109 | (format " - Exit [%d]" exit-status))))) | |
f69aad2b MB |
2110 | (if (with-current-buffer buffer (> (point-max) (point-min))) |
2111 | ;; There's some output, display it | |
9a98fa64 | 2112 | (display-message-or-buffer buffer) |
f69aad2b | 2113 | ;; No output; error? |
94ddbe6d RS |
2114 | (let ((output |
2115 | (if (and error-file | |
2116 | (< 0 (nth 7 (file-attributes error-file)))) | |
2117 | "some error output" | |
2118 | "no output"))) | |
d4bbcbb4 AS |
2119 | (cond ((null exit-status) |
2120 | (message "(Shell command failed with error)")) | |
2121 | ((equal 0 exit-status) | |
2122 | (message "(Shell command succeeded with %s)" | |
2123 | output)) | |
2124 | ((stringp exit-status) | |
2125 | (message "(Shell command killed by signal %s)" | |
2126 | exit-status)) | |
2127 | (t | |
2128 | (message "(Shell command failed with code %d and %s)" | |
2129 | exit-status output)))) | |
e1e04350 SM |
2130 | ;; Don't kill: there might be useful info in the undo-log. |
2131 | ;; (kill-buffer buffer) | |
2132 | )))) | |
f69aad2b | 2133 | |
cc039f78 KH |
2134 | (when (and error-file (file-exists-p error-file)) |
2135 | (if (< 0 (nth 7 (file-attributes error-file))) | |
2136 | (with-current-buffer (get-buffer-create error-buffer) | |
2137 | (let ((pos-from-end (- (point-max) (point)))) | |
2138 | (or (bobp) | |
2139 | (insert "\f\n")) | |
2140 | ;; Do no formatting while reading error file, | |
2141 | ;; because that can run a shell command, and we | |
2142 | ;; don't want that to cause an infinite recursion. | |
2143 | (format-insert-file error-file nil) | |
2144 | ;; Put point after the inserted errors. | |
2145 | (goto-char (- (point-max) pos-from-end))) | |
63619f42 RS |
2146 | (and display-error-buffer |
2147 | (display-buffer (current-buffer))))) | |
cc039f78 | 2148 | (delete-file error-file)) |
a0184aeb | 2149 | exit-status)) |
1e722f9f | 2150 | |
d589bd99 RS |
2151 | (defun shell-command-to-string (command) |
2152 | "Execute shell command COMMAND and return its output as a string." | |
2153 | (with-output-to-string | |
17cc9013 RS |
2154 | (with-current-buffer |
2155 | standard-output | |
2156 | (call-process shell-file-name nil t nil shell-command-switch command)))) | |
0457dd55 KG |
2157 | |
2158 | (defun process-file (program &optional infile buffer display &rest args) | |
2159 | "Process files synchronously in a separate process. | |
2160 | Similar to `call-process', but may invoke a file handler based on | |
2161 | `default-directory'. The current working directory of the | |
2162 | subprocess is `default-directory'. | |
2163 | ||
2164 | File names in INFILE and BUFFER are handled normally, but file | |
2165 | names in ARGS should be relative to `default-directory', as they | |
2166 | are passed to the process verbatim. \(This is a difference to | |
2167 | `call-process' which does not support file handlers for INFILE | |
2168 | and BUFFER.\) | |
2169 | ||
2170 | Some file handlers might not support all variants, for example | |
2171 | they might behave as if DISPLAY was nil, regardless of the actual | |
2172 | value passed." | |
2173 | (let ((fh (find-file-name-handler default-directory 'process-file)) | |
2174 | lc stderr-file) | |
2175 | (unwind-protect | |
2176 | (if fh (apply fh 'process-file program infile buffer display args) | |
8de40f9f | 2177 | (when infile (setq lc (file-local-copy infile))) |
0457dd55 | 2178 | (setq stderr-file (when (and (consp buffer) (stringp (cadr buffer))) |
85af630d KG |
2179 | (make-temp-file "emacs"))) |
2180 | (prog1 | |
2181 | (apply 'call-process program | |
2182 | (or lc infile) | |
2183 | (if stderr-file (list (car buffer) stderr-file) buffer) | |
2184 | display args) | |
2185 | (when stderr-file (copy-file stderr-file (cadr buffer))))) | |
0457dd55 KG |
2186 | (when stderr-file (delete-file stderr-file)) |
2187 | (when lc (delete-file lc))))) | |
2188 | ||
2189 | ||
2d88b556 | 2190 | \f |
1b43f83f | 2191 | (defvar universal-argument-map |
69d4c3c4 KH |
2192 | (let ((map (make-sparse-keymap))) |
2193 | (define-key map [t] 'universal-argument-other-key) | |
b9ff190d | 2194 | (define-key map (vector meta-prefix-char t) 'universal-argument-other-key) |
69d4c3c4 KH |
2195 | (define-key map [switch-frame] nil) |
2196 | (define-key map [?\C-u] 'universal-argument-more) | |
2197 | (define-key map [?-] 'universal-argument-minus) | |
2198 | (define-key map [?0] 'digit-argument) | |
2199 | (define-key map [?1] 'digit-argument) | |
2200 | (define-key map [?2] 'digit-argument) | |
2201 | (define-key map [?3] 'digit-argument) | |
2202 | (define-key map [?4] 'digit-argument) | |
2203 | (define-key map [?5] 'digit-argument) | |
2204 | (define-key map [?6] 'digit-argument) | |
2205 | (define-key map [?7] 'digit-argument) | |
2206 | (define-key map [?8] 'digit-argument) | |
2207 | (define-key map [?9] 'digit-argument) | |
bd7acc8d GM |
2208 | (define-key map [kp-0] 'digit-argument) |
2209 | (define-key map [kp-1] 'digit-argument) | |
2210 | (define-key map [kp-2] 'digit-argument) | |
2211 | (define-key map [kp-3] 'digit-argument) | |
2212 | (define-key map [kp-4] 'digit-argument) | |
2213 | (define-key map [kp-5] 'digit-argument) | |
2214 | (define-key map [kp-6] 'digit-argument) | |
2215 | (define-key map [kp-7] 'digit-argument) | |
2216 | (define-key map [kp-8] 'digit-argument) | |
2217 | (define-key map [kp-9] 'digit-argument) | |
2218 | (define-key map [kp-subtract] 'universal-argument-minus) | |
69d4c3c4 KH |
2219 | map) |
2220 | "Keymap used while processing \\[universal-argument].") | |
2221 | ||
0de84e16 RS |
2222 | (defvar universal-argument-num-events nil |
2223 | "Number of argument-specifying events read by `universal-argument'. | |
2224 | `universal-argument-other-key' uses this to discard those events | |
2225 | from (this-command-keys), and reread only the final command.") | |
2226 | ||
6904b34b EZ |
2227 | (defvar overriding-map-is-bound nil |
2228 | "Non-nil when `overriding-terminal-local-map' is `universal-argument-map'.") | |
2229 | ||
2230 | (defvar saved-overriding-map nil | |
2231 | "The saved value of `overriding-terminal-local-map'. | |
2232 | That variable gets restored to this value on exiting \"universal | |
2233 | argument mode\".") | |
2234 | ||
2235 | (defun ensure-overriding-map-is-bound () | |
2236 | "Check `overriding-terminal-local-map' is `universal-argument-map'." | |
2237 | (unless overriding-map-is-bound | |
2238 | (setq saved-overriding-map overriding-terminal-local-map) | |
2239 | (setq overriding-terminal-local-map universal-argument-map) | |
2240 | (setq overriding-map-is-bound t))) | |
2241 | ||
2242 | (defun restore-overriding-map () | |
2243 | "Restore `overriding-terminal-local-map' to its saved value." | |
2244 | (setq overriding-terminal-local-map saved-overriding-map) | |
2245 | (setq overriding-map-is-bound nil)) | |
2246 | ||
e8d1a377 KH |
2247 | (defun universal-argument () |
2248 | "Begin a numeric argument for the following command. | |
2249 | Digits or minus sign following \\[universal-argument] make up the numeric argument. | |
2250 | \\[universal-argument] following the digits or minus sign ends the argument. | |
2251 | \\[universal-argument] without digits or minus sign provides 4 as argument. | |
2252 | Repeating \\[universal-argument] without digits or minus sign | |
0565d307 RS |
2253 | multiplies the argument by 4 each time. |
2254 | For some commands, just \\[universal-argument] by itself serves as a flag | |
a697fc62 RS |
2255 | which is different in effect from any particular numeric argument. |
2256 | These commands include \\[set-mark-command] and \\[start-kbd-macro]." | |
69d4c3c4 KH |
2257 | (interactive) |
2258 | (setq prefix-arg (list 4)) | |
0de84e16 | 2259 | (setq universal-argument-num-events (length (this-command-keys))) |
6904b34b | 2260 | (ensure-overriding-map-is-bound)) |
e8d1a377 | 2261 | |
69d4c3c4 KH |
2262 | ;; A subsequent C-u means to multiply the factor by 4 if we've typed |
2263 | ;; nothing but C-u's; otherwise it means to terminate the prefix arg. | |
2264 | (defun universal-argument-more (arg) | |
e8d1a377 | 2265 | (interactive "P") |
69d4c3c4 KH |
2266 | (if (consp arg) |
2267 | (setq prefix-arg (list (* 4 (car arg)))) | |
1cd24721 RS |
2268 | (if (eq arg '-) |
2269 | (setq prefix-arg (list -4)) | |
2270 | (setq prefix-arg arg) | |
6904b34b | 2271 | (restore-overriding-map))) |
0de84e16 | 2272 | (setq universal-argument-num-events (length (this-command-keys)))) |
e8d1a377 KH |
2273 | |
2274 | (defun negative-argument (arg) | |
2275 | "Begin a negative numeric argument for the next command. | |
2276 | \\[universal-argument] following digits or minus sign ends the argument." | |
2277 | (interactive "P") | |
69d4c3c4 KH |
2278 | (cond ((integerp arg) |
2279 | (setq prefix-arg (- arg))) | |
2280 | ((eq arg '-) | |
2281 | (setq prefix-arg nil)) | |
2282 | (t | |
b9ff190d | 2283 | (setq prefix-arg '-))) |
0de84e16 | 2284 | (setq universal-argument-num-events (length (this-command-keys))) |
6904b34b | 2285 | (ensure-overriding-map-is-bound)) |
69d4c3c4 KH |
2286 | |
2287 | (defun digit-argument (arg) | |
2288 | "Part of the numeric argument for the next command. | |
2289 | \\[universal-argument] following digits or minus sign ends the argument." | |
2290 | (interactive "P") | |
bd7acc8d GM |
2291 | (let* ((char (if (integerp last-command-char) |
2292 | last-command-char | |
2293 | (get last-command-char 'ascii-character))) | |
2294 | (digit (- (logand char ?\177) ?0))) | |
69d4c3c4 KH |
2295 | (cond ((integerp arg) |
2296 | (setq prefix-arg (+ (* arg 10) | |
2297 | (if (< arg 0) (- digit) digit)))) | |
2298 | ((eq arg '-) | |
2299 | ;; Treat -0 as just -, so that -01 will work. | |
2300 | (setq prefix-arg (if (zerop digit) '- (- digit)))) | |
2301 | (t | |
b9ff190d | 2302 | (setq prefix-arg digit)))) |
0de84e16 | 2303 | (setq universal-argument-num-events (length (this-command-keys))) |
6904b34b | 2304 | (ensure-overriding-map-is-bound)) |
69d4c3c4 KH |
2305 | |
2306 | ;; For backward compatibility, minus with no modifiers is an ordinary | |
2307 | ;; command if digits have already been entered. | |
2308 | (defun universal-argument-minus (arg) | |
2309 | (interactive "P") | |
2310 | (if (integerp arg) | |
2311 | (universal-argument-other-key arg) | |
2312 | (negative-argument arg))) | |
2313 | ||
2314 | ;; Anything else terminates the argument and is left in the queue to be | |
2315 | ;; executed as a command. | |
2316 | (defun universal-argument-other-key (arg) | |
2317 | (interactive "P") | |
2318 | (setq prefix-arg arg) | |
0de84e16 RS |
2319 | (let* ((key (this-command-keys)) |
2320 | (keylist (listify-key-sequence key))) | |
2321 | (setq unread-command-events | |
06697cdb RS |
2322 | (append (nthcdr universal-argument-num-events keylist) |
2323 | unread-command-events))) | |
f0ef2555 | 2324 | (reset-this-command-lengths) |
6904b34b | 2325 | (restore-overriding-map)) |
2d88b556 | 2326 | \f |
7fcce20f RS |
2327 | (defvar buffer-substring-filters nil |
2328 | "List of filter functions for `filter-buffer-substring'. | |
2329 | Each function must accept a single argument, a string, and return | |
2330 | a string. The buffer substring is passed to the first function | |
2331 | in the list, and the return value of each function is passed to | |
2332 | the next. The return value of the last function is used as the | |
2333 | return value of `filter-buffer-substring'. | |
2334 | ||
2335 | If this variable is nil, no filtering is performed.") | |
2336 | ||
398c9ffb | 2337 | (defun filter-buffer-substring (beg end &optional delete noprops) |
7fcce20f RS |
2338 | "Return the buffer substring between BEG and END, after filtering. |
2339 | The buffer substring is passed through each of the filter | |
2340 | functions in `buffer-substring-filters', and the value from the | |
2341 | last filter function is returned. If `buffer-substring-filters' | |
2342 | is nil, the buffer substring is returned unaltered. | |
2343 | ||
2344 | If DELETE is non-nil, the text between BEG and END is deleted | |
2345 | from the buffer. | |
2346 | ||
398c9ffb KS |
2347 | If NOPROPS is non-nil, final string returned does not include |
2348 | text properties, while the string passed to the filters still | |
2349 | includes text properties from the buffer text. | |
2350 | ||
2cd16d74 | 2351 | Point is temporarily set to BEG before calling |
7fcce20f RS |
2352 | `buffer-substring-filters', in case the functions need to know |
2353 | where the text came from. | |
2354 | ||
398c9ffb KS |
2355 | This function should be used instead of `buffer-substring', |
2356 | `buffer-substring-no-properties', or `delete-and-extract-region' | |
2357 | when you want to allow filtering to take place. For example, | |
2358 | major or minor modes can use `buffer-substring-filters' to | |
2359 | extract characters that are special to a buffer, and should not | |
2360 | be copied into other buffers." | |
2361 | (cond | |
2362 | ((or delete buffer-substring-filters) | |
2363 | (save-excursion | |
2364 | (goto-char beg) | |
2365 | (let ((string (if delete (delete-and-extract-region beg end) | |
2366 | (buffer-substring beg end)))) | |
2367 | (dolist (filter buffer-substring-filters) | |
2368 | (setq string (funcall filter string))) | |
2369 | (if noprops | |
2370 | (set-text-properties 0 (length string) nil string)) | |
2371 | string))) | |
2372 | (noprops | |
2373 | (buffer-substring-no-properties beg end)) | |
2374 | (t | |
2375 | (buffer-substring beg end)))) | |
2376 | ||
7fcce20f | 2377 | |
93be67de | 2378 | ;;;; Window system cut and paste hooks. |
70e14c01 JB |
2379 | |
2380 | (defvar interprogram-cut-function nil | |
2381 | "Function to call to make a killed region available to other programs. | |
2382 | ||
2383 | Most window systems provide some sort of facility for cutting and | |
9f112a3d RS |
2384 | pasting text between the windows of different programs. |
2385 | This variable holds a function that Emacs calls whenever text | |
2386 | is put in the kill ring, to make the new kill available to other | |
70e14c01 JB |
2387 | programs. |
2388 | ||
9f112a3d RS |
2389 | The function takes one or two arguments. |
2390 | The first argument, TEXT, is a string containing | |
2391 | the text which should be made available. | |
8e5d85ff LT |
2392 | The second, optional, argument PUSH, has the same meaning as the |
2393 | similar argument to `x-set-cut-buffer', which see.") | |
70e14c01 JB |
2394 | |
2395 | (defvar interprogram-paste-function nil | |
2396 | "Function to call to get text cut from other programs. | |
2397 | ||
2398 | Most window systems provide some sort of facility for cutting and | |
9f112a3d RS |
2399 | pasting text between the windows of different programs. |
2400 | This variable holds a function that Emacs calls to obtain | |
70e14c01 JB |
2401 | text that other programs have provided for pasting. |
2402 | ||
2403 | The function should be called with no arguments. If the function | |
2404 | returns nil, then no other program has provided such text, and the top | |
2405 | of the Emacs kill ring should be used. If the function returns a | |
8e5d85ff LT |
2406 | string, then the caller of the function \(usually `current-kill') |
2407 | should put this string in the kill ring as the latest kill. | |
daa37602 JB |
2408 | |
2409 | Note that the function should return a string only if a program other | |
2410 | than Emacs has provided a string for pasting; if Emacs provided the | |
2411 | most recent string, the function should return nil. If it is | |
2412 | difficult to tell whether Emacs or some other program provided the | |
2413 | current string, it is probably good enough to return nil if the string | |
2414 | is equal (according to `string=') to the last text Emacs provided.") | |
2d88b556 | 2415 | \f |
70e14c01 | 2416 | |
eaae8106 | 2417 | |
70e14c01 | 2418 | ;;;; The kill ring data structure. |
2076c87c JB |
2419 | |
2420 | (defvar kill-ring nil | |
70e14c01 JB |
2421 | "List of killed text sequences. |
2422 | Since the kill ring is supposed to interact nicely with cut-and-paste | |
2423 | facilities offered by window systems, use of this variable should | |
2424 | interact nicely with `interprogram-cut-function' and | |
2425 | `interprogram-paste-function'. The functions `kill-new', | |
2426 | `kill-append', and `current-kill' are supposed to implement this | |
2427 | interaction; you may want to use them instead of manipulating the kill | |
2428 | ring directly.") | |
2076c87c | 2429 | |
bffa4d92 | 2430 | (defcustom kill-ring-max 60 |
69c1dd37 RS |
2431 | "*Maximum length of kill ring before oldest elements are thrown away." |
2432 | :type 'integer | |
2433 | :group 'killing) | |
2076c87c JB |
2434 | |
2435 | (defvar kill-ring-yank-pointer nil | |
2436 | "The tail of the kill ring whose car is the last thing yanked.") | |
2437 | ||
be5936a7 | 2438 | (defun kill-new (string &optional replace yank-handler) |
70e14c01 | 2439 | "Make STRING the latest kill in the kill ring. |
3e505153 | 2440 | Set `kill-ring-yank-pointer' to point to it. |
f914dc91 KH |
2441 | If `interprogram-cut-function' is non-nil, apply it to STRING. |
2442 | Optional second argument REPLACE non-nil means that STRING will replace | |
be5936a7 KS |
2443 | the front of the kill ring, rather than being added to the list. |
2444 | ||
2445 | Optional third arguments YANK-HANDLER controls how the STRING is later | |
f1180544 | 2446 | inserted into a buffer; see `insert-for-yank' for details. |
2a262563 | 2447 | When a yank handler is specified, STRING must be non-empty (the yank |
8e5d85ff | 2448 | handler, if non-nil, is stored as a `yank-handler' text property on STRING). |
2a262563 KS |
2449 | |
2450 | When the yank handler has a non-nil PARAM element, the original STRING | |
2451 | argument is not used by `insert-for-yank'. However, since Lisp code | |
f33321ad | 2452 | may access and use elements from the kill ring directly, the STRING |
2a262563 KS |
2453 | argument should still be a \"useful\" string for such uses." |
2454 | (if (> (length string) 0) | |
f1180544 | 2455 | (if yank-handler |
7e46b7bf LT |
2456 | (put-text-property 0 (length string) |
2457 | 'yank-handler yank-handler string)) | |
2a262563 | 2458 | (if yank-handler |
f1180544 | 2459 | (signal 'args-out-of-range |
2a262563 KS |
2460 | (list string "yank-handler specified for empty string")))) |
2461 | (if (fboundp 'menu-bar-update-yank-menu) | |
2462 | (menu-bar-update-yank-menu string (and replace (car kill-ring)))) | |
ab7e20d5 | 2463 | (if (and replace kill-ring) |
f914dc91 | 2464 | (setcar kill-ring string) |
1b5fd09e | 2465 | (push string kill-ring) |
f914dc91 KH |
2466 | (if (> (length kill-ring) kill-ring-max) |
2467 | (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil))) | |
70e14c01 JB |
2468 | (setq kill-ring-yank-pointer kill-ring) |
2469 | (if interprogram-cut-function | |
657a33ab | 2470 | (funcall interprogram-cut-function string (not replace)))) |
70e14c01 | 2471 | |
be5936a7 | 2472 | (defun kill-append (string before-p &optional yank-handler) |
70e14c01 JB |
2473 | "Append STRING to the end of the latest kill in the kill ring. |
2474 | If BEFORE-P is non-nil, prepend STRING to the kill. | |
8e5d85ff LT |
2475 | Optional third argument YANK-HANDLER, if non-nil, specifies the |
2476 | yank-handler text property to be set on the combined kill ring | |
2477 | string. If the specified yank-handler arg differs from the | |
2478 | yank-handler property of the latest kill string, this function | |
2479 | adds the combined string to the kill ring as a new element, | |
2480 | instead of replacing the last kill with it. | |
be5936a7 KS |
2481 | If `interprogram-cut-function' is set, pass the resulting kill to it." |
2482 | (let* ((cur (car kill-ring))) | |
2483 | (kill-new (if before-p (concat string cur) (concat cur string)) | |
2484 | (or (= (length cur) 0) | |
2485 | (equal yank-handler (get-text-property 0 'yank-handler cur))) | |
2486 | yank-handler))) | |
70e14c01 JB |
2487 | |
2488 | (defun current-kill (n &optional do-not-move) | |
2489 | "Rotate the yanking point by N places, and then return that kill. | |
2490 | If N is zero, `interprogram-paste-function' is set, and calling it | |
2491 | returns a string, then that string is added to the front of the | |
2492 | kill ring and returned as the latest kill. | |
1e722f9f | 2493 | If optional arg DO-NOT-MOVE is non-nil, then don't actually move the |
70e14c01 JB |
2494 | yanking point; just return the Nth kill forward." |
2495 | (let ((interprogram-paste (and (= n 0) | |
2496 | interprogram-paste-function | |
2497 | (funcall interprogram-paste-function)))) | |
2498 | (if interprogram-paste | |
2499 | (progn | |
2500 | ;; Disable the interprogram cut function when we add the new | |
2501 | ;; text to the kill ring, so Emacs doesn't try to own the | |
2502 | ;; selection, with identical text. | |
2503 | (let ((interprogram-cut-function nil)) | |
2504 | (kill-new interprogram-paste)) | |
2505 | interprogram-paste) | |
2506 | (or kill-ring (error "Kill ring is empty")) | |
47096a67 PE |
2507 | (let ((ARGth-kill-element |
2508 | (nthcdr (mod (- n (length kill-ring-yank-pointer)) | |
2509 | (length kill-ring)) | |
2510 | kill-ring))) | |
70e14c01 JB |
2511 | (or do-not-move |
2512 | (setq kill-ring-yank-pointer ARGth-kill-element)) | |
2513 | (car ARGth-kill-element))))) | |
c88ab9ce | 2514 | |
c88ab9ce | 2515 | |
eaae8106 | 2516 | |
70e14c01 | 2517 | ;;;; Commands for manipulating the kill ring. |
c88ab9ce | 2518 | |
69c1dd37 RS |
2519 | (defcustom kill-read-only-ok nil |
2520 | "*Non-nil means don't signal an error for killing read-only text." | |
2521 | :type 'boolean | |
2522 | :group 'killing) | |
e6291fe1 | 2523 | |
3a5da8a8 RS |
2524 | (put 'text-read-only 'error-conditions |
2525 | '(text-read-only buffer-read-only error)) | |
2526 | (put 'text-read-only 'error-message "Text is read-only") | |
2527 | ||
be5936a7 | 2528 | (defun kill-region (beg end &optional yank-handler) |
66e9b2b2 RS |
2529 | "Kill (\"cut\") text between point and mark. |
2530 | This deletes the text from the buffer and saves it in the kill ring. | |
2076c87c | 2531 | The command \\[yank] can retrieve it from there. |
81558867 EZ |
2532 | \(If you want to kill and then yank immediately, use \\[kill-ring-save].) |
2533 | ||
2534 | If you want to append the killed region to the last killed text, | |
2535 | use \\[append-next-kill] before \\[kill-region]. | |
2536 | ||
2aa7a8bf JB |
2537 | If the buffer is read-only, Emacs will beep and refrain from deleting |
2538 | the text, but put the text in the kill ring anyway. This means that | |
2539 | you can use the killing commands to copy text from a read-only buffer. | |
2076c87c JB |
2540 | |
2541 | This is the primitive for programs to kill text (as opposed to deleting it). | |
c15dc81f | 2542 | Supply two arguments, character positions indicating the stretch of text |
2076c87c JB |
2543 | to be killed. |
2544 | Any command that calls this function is a \"kill command\". | |
2545 | If the previous command was also a kill command, | |
2546 | the text killed this time appends to the text killed last time | |
be5936a7 KS |
2547 | to make one entry in the kill ring. |
2548 | ||
8e5d85ff LT |
2549 | In Lisp code, optional third arg YANK-HANDLER, if non-nil, |
2550 | specifies the yank-handler text property to be set on the killed | |
2551 | text. See `insert-for-yank'." | |
214a3db0 RS |
2552 | ;; Pass point first, then mark, because the order matters |
2553 | ;; when calling kill-append. | |
2554 | (interactive (list (point) (mark))) | |
f39d6be0 RS |
2555 | (unless (and beg end) |
2556 | (error "The mark is not set now, so there is no region")) | |
ccd19b9f | 2557 | (condition-case nil |
7fcce20f | 2558 | (let ((string (filter-buffer-substring beg end t))) |
a1eb02bd SM |
2559 | (when string ;STRING is nil if BEG = END |
2560 | ;; Add that string to the kill ring, one way or another. | |
2561 | (if (eq last-command 'kill-region) | |
be5936a7 KS |
2562 | (kill-append string (< end beg) yank-handler) |
2563 | (kill-new string nil yank-handler))) | |
8a7cda9b | 2564 | (when (or string (eq last-command 'kill-region)) |
8e5d85ff LT |
2565 | (setq this-command 'kill-region)) |
2566 | nil) | |
ccd19b9f KH |
2567 | ((buffer-read-only text-read-only) |
2568 | ;; The code above failed because the buffer, or some of the characters | |
2569 | ;; in the region, are read-only. | |
2570 | ;; We should beep, in case the user just isn't aware of this. | |
2571 | ;; However, there's no harm in putting | |
2572 | ;; the region's text in the kill ring, anyway. | |
2573 | (copy-region-as-kill beg end) | |
cb3e1b4c RS |
2574 | ;; Set this-command now, so it will be set even if we get an error. |
2575 | (setq this-command 'kill-region) | |
2576 | ;; This should barf, if appropriate, and give us the correct error. | |
ccd19b9f | 2577 | (if kill-read-only-ok |
8e5d85ff | 2578 | (progn (message "Read only text copied to kill ring") nil) |
ccd19b9f KH |
2579 | ;; Signal an error if the buffer is read-only. |
2580 | (barf-if-buffer-read-only) | |
2581 | ;; If the buffer isn't read-only, the text is. | |
2582 | (signal 'text-read-only (list (current-buffer))))))) | |
2076c87c | 2583 | |
a382890a KH |
2584 | ;; copy-region-as-kill no longer sets this-command, because it's confusing |
2585 | ;; to get two copies of the text when the user accidentally types M-w and | |
2586 | ;; then corrects it with the intended C-w. | |
2076c87c JB |
2587 | (defun copy-region-as-kill (beg end) |
2588 | "Save the region as if killed, but don't kill it. | |
0e264847 | 2589 | In Transient Mark mode, deactivate the mark. |
46947372 JB |
2590 | If `interprogram-cut-function' is non-nil, also save the text for a window |
2591 | system cut and paste." | |
2076c87c JB |
2592 | (interactive "r") |
2593 | (if (eq last-command 'kill-region) | |
7fcce20f RS |
2594 | (kill-append (filter-buffer-substring beg end) (< end beg)) |
2595 | (kill-new (filter-buffer-substring beg end))) | |
1e722f9f | 2596 | (if transient-mark-mode |
5c7319b6 | 2597 | (setq deactivate-mark t)) |
2076c87c JB |
2598 | nil) |
2599 | ||
2600 | (defun kill-ring-save (beg end) | |
0964e562 | 2601 | "Save the region as if killed, but don't kill it. |
0e264847 | 2602 | In Transient Mark mode, deactivate the mark. |
0964e562 | 2603 | If `interprogram-cut-function' is non-nil, also save the text for a window |
0e264847 RS |
2604 | system cut and paste. |
2605 | ||
81558867 EZ |
2606 | If you want to append the killed line to the last killed text, |
2607 | use \\[append-next-kill] before \\[kill-ring-save]. | |
2608 | ||
0e264847 RS |
2609 | This command is similar to `copy-region-as-kill', except that it gives |
2610 | visual feedback indicating the extent of the region being copied." | |
2076c87c JB |
2611 | (interactive "r") |
2612 | (copy-region-as-kill beg end) | |
bbf41690 RS |
2613 | ;; This use of interactive-p is correct |
2614 | ;; because the code it controls just gives the user visual feedback. | |
3a801d0c | 2615 | (if (interactive-p) |
66050f10 RS |
2616 | (let ((other-end (if (= (point) beg) end beg)) |
2617 | (opoint (point)) | |
2618 | ;; Inhibit quitting so we can make a quit here | |
2619 | ;; look like a C-g typed as a command. | |
2620 | (inhibit-quit t)) | |
2621 | (if (pos-visible-in-window-p other-end (selected-window)) | |
977e2654 KS |
2622 | (unless (and transient-mark-mode |
2623 | (face-background 'region)) | |
66050f10 RS |
2624 | ;; Swap point and mark. |
2625 | (set-marker (mark-marker) (point) (current-buffer)) | |
2626 | (goto-char other-end) | |
e4ef3e92 | 2627 | (sit-for blink-matching-delay) |
66050f10 RS |
2628 | ;; Swap back. |
2629 | (set-marker (mark-marker) other-end (current-buffer)) | |
2630 | (goto-char opoint) | |
2631 | ;; If user quit, deactivate the mark | |
2632 | ;; as C-g would as a command. | |
e4e593ae | 2633 | (and quit-flag mark-active |
fcadf1c7 | 2634 | (deactivate-mark))) |
66050f10 RS |
2635 | (let* ((killed-text (current-kill 0)) |
2636 | (message-len (min (length killed-text) 40))) | |
2637 | (if (= (point) beg) | |
2638 | ;; Don't say "killed"; that is misleading. | |
2639 | (message "Saved text until \"%s\"" | |
2640 | (substring killed-text (- message-len))) | |
2641 | (message "Saved text from \"%s\"" | |
2642 | (substring killed-text 0 message-len)))))))) | |
2076c87c | 2643 | |
c75d4986 KH |
2644 | (defun append-next-kill (&optional interactive) |
2645 | "Cause following command, if it kills, to append to previous kill. | |
2646 | The argument is used for internal purposes; do not supply one." | |
2647 | (interactive "p") | |
2648 | ;; We don't use (interactive-p), since that breaks kbd macros. | |
2649 | (if interactive | |
2076c87c JB |
2650 | (progn |
2651 | (setq this-command 'kill-region) | |
2652 | (message "If the next command is a kill, it will append")) | |
2653 | (setq last-command 'kill-region))) | |
cfb4f123 | 2654 | \f |
93be67de | 2655 | ;; Yanking. |
2076c87c | 2656 | |
cfb4f123 RS |
2657 | ;; This is actually used in subr.el but defcustom does not work there. |
2658 | (defcustom yank-excluded-properties | |
be5936a7 | 2659 | '(read-only invisible intangible field mouse-face help-echo local-map keymap |
7408ee97 | 2660 | yank-handler follow-link fontified) |
c6ff5a4c LT |
2661 | "*Text properties to discard when yanking. |
2662 | The value should be a list of text properties to discard or t, | |
2663 | which means to discard all text properties." | |
cfb4f123 | 2664 | :type '(choice (const :tag "All" t) (repeat symbol)) |
c9f0110e | 2665 | :group 'killing |
bf247b6e | 2666 | :version "22.1") |
cfb4f123 | 2667 | |
120de5bd | 2668 | (defvar yank-window-start nil) |
be5936a7 | 2669 | (defvar yank-undo-function nil |
44f5a7b2 KS |
2670 | "If non-nil, function used by `yank-pop' to delete last stretch of yanked text. |
2671 | Function is called with two parameters, START and END corresponding to | |
2672 | the value of the mark and point; it is guaranteed that START <= END. | |
2673 | Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.") | |
120de5bd | 2674 | |
8e5d85ff | 2675 | (defun yank-pop (&optional arg) |
ff1fbe3e RS |
2676 | "Replace just-yanked stretch of killed text with a different stretch. |
2677 | This command is allowed only immediately after a `yank' or a `yank-pop'. | |
2076c87c | 2678 | At such a time, the region contains a stretch of reinserted |
ff1fbe3e | 2679 | previously-killed text. `yank-pop' deletes that text and inserts in its |
2076c87c JB |
2680 | place a different stretch of killed text. |
2681 | ||
2682 | With no argument, the previous kill is inserted. | |
ff1fbe3e RS |
2683 | With argument N, insert the Nth previous kill. |
2684 | If N is negative, this is a more recent kill. | |
2076c87c JB |
2685 | |
2686 | The sequence of kills wraps around, so that after the oldest one | |
a0e8eaa3 EZ |
2687 | comes the newest one. |
2688 | ||
2689 | When this command inserts killed text into the buffer, it honors | |
2690 | `yank-excluded-properties' and `yank-handler' as described in the | |
2691 | doc string for `insert-for-yank-1', which see." | |
2076c87c JB |
2692 | (interactive "*p") |
2693 | (if (not (eq last-command 'yank)) | |
2694 | (error "Previous command was not a yank")) | |
2695 | (setq this-command 'yank) | |
8e5d85ff | 2696 | (unless arg (setq arg 1)) |
3a5da8a8 RS |
2697 | (let ((inhibit-read-only t) |
2698 | (before (< (point) (mark t)))) | |
8254897f KS |
2699 | (if before |
2700 | (funcall (or yank-undo-function 'delete-region) (point) (mark t)) | |
2701 | (funcall (or yank-undo-function 'delete-region) (mark t) (point))) | |
be5936a7 | 2702 | (setq yank-undo-function nil) |
fd0f4056 | 2703 | (set-marker (mark-marker) (point) (current-buffer)) |
cfb4f123 | 2704 | (insert-for-yank (current-kill arg)) |
120de5bd RS |
2705 | ;; Set the window start back where it was in the yank command, |
2706 | ;; if possible. | |
2707 | (set-window-start (selected-window) yank-window-start t) | |
fd0f4056 RS |
2708 | (if before |
2709 | ;; This is like exchange-point-and-mark, but doesn't activate the mark. | |
2710 | ;; It is cleaner to avoid activation, even though the command | |
2711 | ;; loop would deactivate the mark because we inserted text. | |
2712 | (goto-char (prog1 (mark t) | |
2713 | (set-marker (mark-marker) (point) (current-buffer)))))) | |
0964e562 | 2714 | nil) |
2076c87c JB |
2715 | |
2716 | (defun yank (&optional arg) | |
f894e671 | 2717 | "Reinsert (\"paste\") the last stretch of killed text. |
2076c87c | 2718 | More precisely, reinsert the stretch of killed text most recently |
ff1fbe3e | 2719 | killed OR yanked. Put point at end, and set mark at beginning. |
d99f8496 | 2720 | With just \\[universal-argument] as argument, same but put point at beginning (and mark at end). |
ff1fbe3e | 2721 | With argument N, reinsert the Nth most recently killed stretch of killed |
2076c87c | 2722 | text. |
a0e8eaa3 EZ |
2723 | |
2724 | When this command inserts killed text into the buffer, it honors | |
2725 | `yank-excluded-properties' and `yank-handler' as described in the | |
2726 | doc string for `insert-for-yank-1', which see. | |
2727 | ||
a9b9303c | 2728 | See also the command `yank-pop' (\\[yank-pop])." |
2076c87c | 2729 | (interactive "*P") |
120de5bd | 2730 | (setq yank-window-start (window-start)) |
456c617c RS |
2731 | ;; If we don't get all the way thru, make last-command indicate that |
2732 | ;; for the following command. | |
2733 | (setq this-command t) | |
2076c87c | 2734 | (push-mark (point)) |
cfb4f123 RS |
2735 | (insert-for-yank (current-kill (cond |
2736 | ((listp arg) 0) | |
8e5d85ff | 2737 | ((eq arg '-) -2) |
cfb4f123 | 2738 | (t (1- arg))))) |
2076c87c | 2739 | (if (consp arg) |
fd0f4056 RS |
2740 | ;; This is like exchange-point-and-mark, but doesn't activate the mark. |
2741 | ;; It is cleaner to avoid activation, even though the command | |
2742 | ;; loop would deactivate the mark because we inserted text. | |
2743 | (goto-char (prog1 (mark t) | |
2744 | (set-marker (mark-marker) (point) (current-buffer))))) | |
456c617c | 2745 | ;; If we do get all the way thru, make this-command indicate that. |
be5936a7 KS |
2746 | (if (eq this-command t) |
2747 | (setq this-command 'yank)) | |
0964e562 | 2748 | nil) |
70e14c01 JB |
2749 | |
2750 | (defun rotate-yank-pointer (arg) | |
2751 | "Rotate the yanking point in the kill ring. | |
2752 | With argument, rotate that many kills forward (or backward, if negative)." | |
2753 | (interactive "p") | |
2754 | (current-kill arg)) | |
2d88b556 | 2755 | \f |
93be67de KH |
2756 | ;; Some kill commands. |
2757 | ||
2758 | ;; Internal subroutine of delete-char | |
2759 | (defun kill-forward-chars (arg) | |
2760 | (if (listp arg) (setq arg (car arg))) | |
2761 | (if (eq arg '-) (setq arg -1)) | |
2762 | (kill-region (point) (forward-point arg))) | |
2763 | ||
2764 | ;; Internal subroutine of backward-delete-char | |
2765 | (defun kill-backward-chars (arg) | |
2766 | (if (listp arg) (setq arg (car arg))) | |
2767 | (if (eq arg '-) (setq arg -1)) | |
2768 | (kill-region (point) (forward-point (- arg)))) | |
2769 | ||
2770 | (defcustom backward-delete-char-untabify-method 'untabify | |
2771 | "*The method for untabifying when deleting backward. | |
1e722f9f SS |
2772 | Can be `untabify' -- turn a tab to many spaces, then delete one space; |
2773 | `hungry' -- delete all whitespace, both tabs and spaces; | |
2774 | `all' -- delete all whitespace, including tabs, spaces and newlines; | |
93be67de | 2775 | nil -- just delete one character." |
1e722f9f | 2776 | :type '(choice (const untabify) (const hungry) (const all) (const nil)) |
03167a34 | 2777 | :version "20.3" |
93be67de KH |
2778 | :group 'killing) |
2779 | ||
2780 | (defun backward-delete-char-untabify (arg &optional killp) | |
2781 | "Delete characters backward, changing tabs into spaces. | |
2782 | The exact behavior depends on `backward-delete-char-untabify-method'. | |
2783 | Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil. | |
2784 | Interactively, ARG is the prefix arg (default 1) | |
2785 | and KILLP is t if a prefix arg was specified." | |
2786 | (interactive "*p\nP") | |
2787 | (when (eq backward-delete-char-untabify-method 'untabify) | |
2788 | (let ((count arg)) | |
2789 | (save-excursion | |
2790 | (while (and (> count 0) (not (bobp))) | |
2791 | (if (= (preceding-char) ?\t) | |
2792 | (let ((col (current-column))) | |
2793 | (forward-char -1) | |
2794 | (setq col (- col (current-column))) | |
f33321ad | 2795 | (insert-char ?\s col) |
93be67de KH |
2796 | (delete-char 1))) |
2797 | (forward-char -1) | |
2798 | (setq count (1- count)))))) | |
2799 | (delete-backward-char | |
1e722f9f SS |
2800 | (let ((skip (cond ((eq backward-delete-char-untabify-method 'hungry) " \t") |
2801 | ((eq backward-delete-char-untabify-method 'all) | |
2802 | " \t\n\r")))) | |
2803 | (if skip | |
2804 | (let ((wh (- (point) (save-excursion (skip-chars-backward skip) | |
93be67de KH |
2805 | (point))))) |
2806 | (+ arg (if (zerop wh) 0 (1- wh)))) | |
1e722f9f | 2807 | arg)) |
93be67de KH |
2808 | killp)) |
2809 | ||
2810 | (defun zap-to-char (arg char) | |
2811 | "Kill up to and including ARG'th occurrence of CHAR. | |
2812 | Case is ignored if `case-fold-search' is non-nil in the current buffer. | |
2813 | Goes backward if ARG is negative; error if CHAR not found." | |
e761e42c | 2814 | (interactive "p\ncZap to char: ") |
ea9fc1bd KH |
2815 | (if (char-table-p translation-table-for-input) |
2816 | (setq char (or (aref translation-table-for-input char) char))) | |
93be67de KH |
2817 | (kill-region (point) (progn |
2818 | (search-forward (char-to-string char) nil nil arg) | |
2819 | ; (goto-char (if (> arg 0) (1- (point)) (1+ (point)))) | |
2820 | (point)))) | |
eaae8106 | 2821 | |
93be67de KH |
2822 | ;; kill-line and its subroutines. |
2823 | ||
2824 | (defcustom kill-whole-line nil | |
2825 | "*If non-nil, `kill-line' with no arg at beg of line kills the whole line." | |
2826 | :type 'boolean | |
2827 | :group 'killing) | |
2828 | ||
2829 | (defun kill-line (&optional arg) | |
2830 | "Kill the rest of the current line; if no nonblanks there, kill thru newline. | |
2831 | With prefix argument, kill that many lines from point. | |
2832 | Negative arguments kill lines backward. | |
8be7408c | 2833 | With zero argument, kills the text before point on the current line. |
93be67de KH |
2834 | |
2835 | When calling from a program, nil means \"no arg\", | |
2836 | a number counts as a prefix arg. | |
2837 | ||
2838 | To kill a whole line, when point is not at the beginning, type \ | |
2839 | \\[beginning-of-line] \\[kill-line] \\[kill-line]. | |
2840 | ||
2841 | If `kill-whole-line' is non-nil, then this command kills the whole line | |
2842 | including its terminating newline, when used at the beginning of a line | |
2843 | with no argument. As a consequence, you can always kill a whole line | |
d3f22784 EZ |
2844 | by typing \\[beginning-of-line] \\[kill-line]. |
2845 | ||
81558867 EZ |
2846 | If you want to append the killed line to the last killed text, |
2847 | use \\[append-next-kill] before \\[kill-line]. | |
2848 | ||
d3f22784 EZ |
2849 | If the buffer is read-only, Emacs will beep and refrain from deleting |
2850 | the line, but put the line in the kill ring anyway. This means that | |
1a534b89 RS |
2851 | you can use this command to copy text from a read-only buffer. |
2852 | \(If the variable `kill-read-only-ok' is non-nil, then this won't | |
2853 | even beep.)" | |
e761e42c | 2854 | (interactive "P") |
93be67de KH |
2855 | (kill-region (point) |
2856 | ;; It is better to move point to the other end of the kill | |
2857 | ;; before killing. That way, in a read-only buffer, point | |
2858 | ;; moves across the text that is copied to the kill ring. | |
2859 | ;; The choice has no effect on undo now that undo records | |
2860 | ;; the value of point from before the command was run. | |
2861 | (progn | |
2862 | (if arg | |
2863 | (forward-visible-line (prefix-numeric-value arg)) | |
2864 | (if (eobp) | |
2865 | (signal 'end-of-buffer nil)) | |
5560dc5d RS |
2866 | (let ((end |
2867 | (save-excursion | |
2868 | (end-of-visible-line) (point)))) | |
2869 | (if (or (save-excursion | |
2c6a2254 RS |
2870 | ;; If trailing whitespace is visible, |
2871 | ;; don't treat it as nothing. | |
2872 | (unless show-trailing-whitespace | |
2873 | (skip-chars-forward " \t" end)) | |
5560dc5d RS |
2874 | (= (point) end)) |
2875 | (and kill-whole-line (bolp))) | |
2876 | (forward-visible-line 1) | |
2877 | (goto-char end)))) | |
93be67de KH |
2878 | (point)))) |
2879 | ||
348de80b KG |
2880 | (defun kill-whole-line (&optional arg) |
2881 | "Kill current line. | |
6c770e38 LT |
2882 | With prefix arg, kill that many lines starting from the current line. |
2883 | If arg is negative, kill backward. Also kill the preceding newline. | |
01ba9662 | 2884 | \(This is meant to make \\[repeat] work well with negative arguments.\) |
348de80b | 2885 | If arg is zero, kill current line but exclude the trailing newline." |
f8b0f284 | 2886 | (interactive "p") |
6c770e38 LT |
2887 | (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp))) |
2888 | (signal 'end-of-buffer nil)) | |
2889 | (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp))) | |
2890 | (signal 'beginning-of-buffer nil)) | |
2891 | (unless (eq last-command 'kill-region) | |
2892 | (kill-new "") | |
2893 | (setq last-command 'kill-region)) | |
348de80b | 2894 | (cond ((zerop arg) |
6c770e38 LT |
2895 | ;; We need to kill in two steps, because the previous command |
2896 | ;; could have been a kill command, in which case the text | |
2897 | ;; before point needs to be prepended to the current kill | |
2898 | ;; ring entry and the text after point appended. Also, we | |
2899 | ;; need to use save-excursion to avoid copying the same text | |
2900 | ;; twice to the kill ring in read-only buffers. | |
2901 | (save-excursion | |
2902 | (kill-region (point) (progn (forward-visible-line 0) (point)))) | |
348de80b KG |
2903 | (kill-region (point) (progn (end-of-visible-line) (point)))) |
2904 | ((< arg 0) | |
6c770e38 LT |
2905 | (save-excursion |
2906 | (kill-region (point) (progn (end-of-visible-line) (point)))) | |
2907 | (kill-region (point) | |
2908 | (progn (forward-visible-line (1+ arg)) | |
2909 | (unless (bobp) (backward-char)) | |
2910 | (point)))) | |
348de80b | 2911 | (t |
6c770e38 LT |
2912 | (save-excursion |
2913 | (kill-region (point) (progn (forward-visible-line 0) (point)))) | |
2914 | (kill-region (point) | |
2915 | (progn (forward-visible-line arg) (point)))))) | |
12a93712 | 2916 | |
93be67de KH |
2917 | (defun forward-visible-line (arg) |
2918 | "Move forward by ARG lines, ignoring currently invisible newlines only. | |
2919 | If ARG is negative, move backward -ARG lines. | |
2920 | If ARG is zero, move to the beginning of the current line." | |
2921 | (condition-case nil | |
2922 | (if (> arg 0) | |
12a93712 RS |
2923 | (progn |
2924 | (while (> arg 0) | |
93be67de | 2925 | (or (zerop (forward-line 1)) |
12a93712 RS |
2926 | (signal 'end-of-buffer nil)) |
2927 | ;; If the newline we just skipped is invisible, | |
2928 | ;; don't count it. | |
2929 | (let ((prop | |
2930 | (get-char-property (1- (point)) 'invisible))) | |
2931 | (if (if (eq buffer-invisibility-spec t) | |
2932 | prop | |
2933 | (or (memq prop buffer-invisibility-spec) | |
2934 | (assq prop buffer-invisibility-spec))) | |
2935 | (setq arg (1+ arg)))) | |
2936 | (setq arg (1- arg))) | |
2937 | ;; If invisible text follows, and it is a number of complete lines, | |
2938 | ;; skip it. | |
2939 | (let ((opoint (point))) | |
2940 | (while (and (not (eobp)) | |
2941 | (let ((prop | |
2942 | (get-char-property (point) 'invisible))) | |
2943 | (if (eq buffer-invisibility-spec t) | |
2944 | prop | |
2945 | (or (memq prop buffer-invisibility-spec) | |
2946 | (assq prop buffer-invisibility-spec))))) | |
2947 | (goto-char | |
2948 | (if (get-text-property (point) 'invisible) | |
2949 | (or (next-single-property-change (point) 'invisible) | |
2950 | (point-max)) | |
2951 | (next-overlay-change (point))))) | |
2952 | (unless (bolp) | |
2953 | (goto-char opoint)))) | |
93be67de | 2954 | (let ((first t)) |
f5fd8833 JB |
2955 | (while (or first (<= arg 0)) |
2956 | (if first | |
93be67de KH |
2957 | (beginning-of-line) |
2958 | (or (zerop (forward-line -1)) | |
2959 | (signal 'beginning-of-buffer nil))) | |
12a93712 RS |
2960 | ;; If the newline we just moved to is invisible, |
2961 | ;; don't count it. | |
2962 | (unless (bobp) | |
2963 | (let ((prop | |
2964 | (get-char-property (1- (point)) 'invisible))) | |
f5fd8833 JB |
2965 | (unless (if (eq buffer-invisibility-spec t) |
2966 | prop | |
2967 | (or (memq prop buffer-invisibility-spec) | |
2968 | (assq prop buffer-invisibility-spec))) | |
2969 | (setq arg (1+ arg))))) | |
2970 | (setq first nil)) | |
12a93712 RS |
2971 | ;; If invisible text follows, and it is a number of complete lines, |
2972 | ;; skip it. | |
2973 | (let ((opoint (point))) | |
93be67de KH |
2974 | (while (and (not (bobp)) |
2975 | (let ((prop | |
2976 | (get-char-property (1- (point)) 'invisible))) | |
2977 | (if (eq buffer-invisibility-spec t) | |
2978 | prop | |
2979 | (or (memq prop buffer-invisibility-spec) | |
2980 | (assq prop buffer-invisibility-spec))))) | |
2981 | (goto-char | |
2982 | (if (get-text-property (1- (point)) 'invisible) | |
2983 | (or (previous-single-property-change (point) 'invisible) | |
2984 | (point-min)) | |
12a93712 RS |
2985 | (previous-overlay-change (point))))) |
2986 | (unless (bolp) | |
2987 | (goto-char opoint))))) | |
93be67de KH |
2988 | ((beginning-of-buffer end-of-buffer) |
2989 | nil))) | |
70e14c01 | 2990 | |
93be67de KH |
2991 | (defun end-of-visible-line () |
2992 | "Move to end of current visible line." | |
2993 | (end-of-line) | |
2994 | ;; If the following character is currently invisible, | |
2995 | ;; skip all characters with that same `invisible' property value, | |
2996 | ;; then find the next newline. | |
2997 | (while (and (not (eobp)) | |
5560dc5d RS |
2998 | (save-excursion |
2999 | (skip-chars-forward "^\n") | |
3000 | (let ((prop | |
3001 | (get-char-property (point) 'invisible))) | |
3002 | (if (eq buffer-invisibility-spec t) | |
3003 | prop | |
3004 | (or (memq prop buffer-invisibility-spec) | |
3005 | (assq prop buffer-invisibility-spec)))))) | |
3006 | (skip-chars-forward "^\n") | |
93be67de KH |
3007 | (if (get-text-property (point) 'invisible) |
3008 | (goto-char (next-single-property-change (point) 'invisible)) | |
3009 | (goto-char (next-overlay-change (point)))) | |
3010 | (end-of-line))) | |
2d88b556 | 3011 | \f |
2076c87c JB |
3012 | (defun insert-buffer (buffer) |
3013 | "Insert after point the contents of BUFFER. | |
3014 | Puts mark after the inserted text. | |
6cb6e7a2 GM |
3015 | BUFFER may be a buffer or a buffer name. |
3016 | ||
3017 | This function is meant for the user to run interactively. | |
1e96c007 | 3018 | Don't call it from programs: use `insert-buffer-substring' instead!" |
c3d4f949 | 3019 | (interactive |
a3e7c391 FP |
3020 | (list |
3021 | (progn | |
3022 | (barf-if-buffer-read-only) | |
3023 | (read-buffer "Insert buffer: " | |
3024 | (if (eq (selected-window) (next-window (selected-window))) | |
3025 | (other-buffer (current-buffer)) | |
3026 | (window-buffer (next-window (selected-window)))) | |
3027 | t)))) | |
1e96c007 SM |
3028 | (push-mark |
3029 | (save-excursion | |
3030 | (insert-buffer-substring (get-buffer buffer)) | |
3031 | (point))) | |
1537a263 | 3032 | nil) |
2076c87c JB |
3033 | |
3034 | (defun append-to-buffer (buffer start end) | |
3035 | "Append to specified buffer the text of the region. | |
3036 | It is inserted into that buffer before its point. | |
3037 | ||
3038 | When calling from a program, give three arguments: | |
3039 | BUFFER (or buffer name), START and END. | |
3040 | START and END specify the portion of the current buffer to be copied." | |
70e14c01 | 3041 | (interactive |
5d771766 | 3042 | (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t)) |
23efee2c | 3043 | (region-beginning) (region-end))) |
2076c87c JB |
3044 | (let ((oldbuf (current-buffer))) |
3045 | (save-excursion | |
c069a480 GM |
3046 | (let* ((append-to (get-buffer-create buffer)) |
3047 | (windows (get-buffer-window-list append-to t t)) | |
3048 | point) | |
3049 | (set-buffer append-to) | |
3050 | (setq point (point)) | |
3051 | (barf-if-buffer-read-only) | |
3052 | (insert-buffer-substring oldbuf start end) | |
3053 | (dolist (window windows) | |
3054 | (when (= (window-point window) point) | |
3055 | (set-window-point window (point)))))))) | |
2076c87c JB |
3056 | |
3057 | (defun prepend-to-buffer (buffer start end) | |
3058 | "Prepend to specified buffer the text of the region. | |
3059 | It is inserted into that buffer after its point. | |
3060 | ||
3061 | When calling from a program, give three arguments: | |
3062 | BUFFER (or buffer name), START and END. | |
3063 | START and END specify the portion of the current buffer to be copied." | |
3064 | (interactive "BPrepend to buffer: \nr") | |
3065 | (let ((oldbuf (current-buffer))) | |
3066 | (save-excursion | |
3067 | (set-buffer (get-buffer-create buffer)) | |
74399eac | 3068 | (barf-if-buffer-read-only) |
2076c87c JB |
3069 | (save-excursion |
3070 | (insert-buffer-substring oldbuf start end))))) | |
3071 | ||
3072 | (defun copy-to-buffer (buffer start end) | |
3073 | "Copy to specified buffer the text of the region. | |
3074 | It is inserted into that buffer, replacing existing text there. | |
3075 | ||
3076 | When calling from a program, give three arguments: | |
3077 | BUFFER (or buffer name), START and END. | |
3078 | START and END specify the portion of the current buffer to be copied." | |
3079 | (interactive "BCopy to buffer: \nr") | |
3080 | (let ((oldbuf (current-buffer))) | |
1b5fd09e | 3081 | (with-current-buffer (get-buffer-create buffer) |
74399eac | 3082 | (barf-if-buffer-read-only) |
2076c87c JB |
3083 | (erase-buffer) |
3084 | (save-excursion | |
3085 | (insert-buffer-substring oldbuf start end))))) | |
2d88b556 | 3086 | \f |
62d1c1fc RM |
3087 | (put 'mark-inactive 'error-conditions '(mark-inactive error)) |
3088 | (put 'mark-inactive 'error-message "The mark is not active now") | |
3089 | ||
0251bafb RS |
3090 | (defvar activate-mark-hook nil |
3091 | "Hook run when the mark becomes active. | |
3092 | It is also run at the end of a command, if the mark is active and | |
3093 | it is possible that the region may have changed") | |
3094 | ||
3095 | (defvar deactivate-mark-hook nil | |
3096 | "Hook run when the mark becomes inactive.") | |
3097 | ||
af39530e | 3098 | (defun mark (&optional force) |
f00239cf RS |
3099 | "Return this buffer's mark value as integer, or nil if never set. |
3100 | ||
3101 | In Transient Mark mode, this function signals an error if | |
3102 | the mark is not active. However, if `mark-even-if-inactive' is non-nil, | |
3103 | or the argument FORCE is non-nil, it disregards whether the mark | |
3104 | is active, and returns an integer or nil in the usual way. | |
af39530e | 3105 | |
2076c87c JB |
3106 | If you are using this in an editing command, you are most likely making |
3107 | a mistake; see the documentation of `set-mark'." | |
0e3a7b14 | 3108 | (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive) |
af39530e | 3109 | (marker-position (mark-marker)) |
62d1c1fc | 3110 | (signal 'mark-inactive nil))) |
2076c87c | 3111 | |
19d35374 RM |
3112 | ;; Many places set mark-active directly, and several of them failed to also |
3113 | ;; run deactivate-mark-hook. This shorthand should simplify. | |
3114 | (defsubst deactivate-mark () | |
3115 | "Deactivate the mark by setting `mark-active' to nil. | |
fcadf1c7 | 3116 | \(That makes a difference only in Transient Mark mode.) |
19d35374 | 3117 | Also runs the hook `deactivate-mark-hook'." |
868c2f49 KS |
3118 | (cond |
3119 | ((eq transient-mark-mode 'lambda) | |
3120 | (setq transient-mark-mode nil)) | |
3121 | (transient-mark-mode | |
3122 | (setq mark-active nil) | |
3123 | (run-hooks 'deactivate-mark-hook)))) | |
19d35374 | 3124 | |
2076c87c JB |
3125 | (defun set-mark (pos) |
3126 | "Set this buffer's mark to POS. Don't use this function! | |
3127 | That is to say, don't use this function unless you want | |
3128 | the user to see that the mark has moved, and you want the previous | |
3129 | mark position to be lost. | |
3130 | ||
3131 | Normally, when a new mark is set, the old one should go on the stack. | |
f59006cb | 3132 | This is why most applications should use `push-mark', not `set-mark'. |
2076c87c | 3133 | |
ff1fbe3e | 3134 | Novice Emacs Lisp programmers often try to use the mark for the wrong |
2076c87c JB |
3135 | purposes. The mark saves a location for the user's convenience. |
3136 | Most editing commands should not alter the mark. | |
3137 | To remember a location for internal use in the Lisp program, | |
3138 | store it in a Lisp variable. Example: | |
3139 | ||
3140 | (let ((beg (point))) (forward-line 1) (delete-region beg (point)))." | |
3141 | ||
fcadf1c7 RS |
3142 | (if pos |
3143 | (progn | |
3144 | (setq mark-active t) | |
3145 | (run-hooks 'activate-mark-hook) | |
3146 | (set-marker (mark-marker) pos (current-buffer))) | |
24c22852 RS |
3147 | ;; Normally we never clear mark-active except in Transient Mark mode. |
3148 | ;; But when we actually clear out the mark value too, | |
3149 | ;; we must clear mark-active in any mode. | |
3150 | (setq mark-active nil) | |
3151 | (run-hooks 'deactivate-mark-hook) | |
3152 | (set-marker (mark-marker) nil))) | |
2076c87c JB |
3153 | |
3154 | (defvar mark-ring nil | |
e55e2267 | 3155 | "The list of former marks of the current buffer, most recent first.") |
2076c87c | 3156 | (make-variable-buffer-local 'mark-ring) |
e55e2267 | 3157 | (put 'mark-ring 'permanent-local t) |
2076c87c | 3158 | |
69c1dd37 RS |
3159 | (defcustom mark-ring-max 16 |
3160 | "*Maximum size of mark ring. Start discarding off end if gets this big." | |
3161 | :type 'integer | |
3162 | :group 'editing-basics) | |
2076c87c | 3163 | |
dc029f0b RM |
3164 | (defvar global-mark-ring nil |
3165 | "The list of saved global marks, most recent first.") | |
3166 | ||
69c1dd37 | 3167 | (defcustom global-mark-ring-max 16 |
dc029f0b | 3168 | "*Maximum size of global mark ring. \ |
69c1dd37 RS |
3169 | Start discarding off end if gets this big." |
3170 | :type 'integer | |
3171 | :group 'editing-basics) | |
dc029f0b | 3172 | |
868c2f49 KS |
3173 | (defun pop-to-mark-command () |
3174 | "Jump to mark, and pop a new position for mark off the ring | |
3175 | \(does not affect global mark ring\)." | |
3176 | (interactive) | |
3177 | (if (null (mark t)) | |
3178 | (error "No mark set in this buffer") | |
868c2f49 KS |
3179 | (goto-char (mark t)) |
3180 | (pop-mark))) | |
3181 | ||
d00ffe21 | 3182 | (defun push-mark-command (arg &optional nomsg) |
868c2f49 | 3183 | "Set mark at where point is. |
d00ffe21 KS |
3184 | If no prefix arg and mark is already set there, just activate it. |
3185 | Display `Mark set' unless the optional second arg NOMSG is non-nil." | |
868c2f49 KS |
3186 | (interactive "P") |
3187 | (let ((mark (marker-position (mark-marker)))) | |
3188 | (if (or arg (null mark) (/= mark (point))) | |
d00ffe21 | 3189 | (push-mark nil nomsg t) |
868c2f49 | 3190 | (setq mark-active t) |
0251bafb | 3191 | (run-hooks 'activate-mark-hook) |
d00ffe21 KS |
3192 | (unless nomsg |
3193 | (message "Mark activated"))))) | |
868c2f49 | 3194 | |
6a936796 RS |
3195 | (defcustom set-mark-command-repeat-pop nil |
3196 | "*Non-nil means that repeating \\[set-mark-command] after popping will pop. | |
3197 | This means that if you type C-u \\[set-mark-command] \\[set-mark-command] | |
3198 | will pop twice." | |
3199 | :type 'boolean | |
3200 | :group 'editing) | |
3201 | ||
2076c87c JB |
3202 | (defun set-mark-command (arg) |
3203 | "Set mark at where point is, or jump to mark. | |
66ef2df9 KS |
3204 | With no prefix argument, set mark, and push old mark position on local |
3205 | mark ring; also push mark on global mark ring if last mark was set in | |
3206 | another buffer. Immediately repeating the command activates | |
3207 | `transient-mark-mode' temporarily. | |
3208 | ||
3209 | With argument, e.g. \\[universal-argument] \\[set-mark-command], \ | |
3210 | jump to mark, and pop a new position | |
3211 | for mark off the local mark ring \(this does not affect the global | |
3212 | mark ring\). Use \\[pop-global-mark] to jump to a mark off the global | |
3213 | mark ring \(see `pop-global-mark'\). | |
18c5df40 | 3214 | |
2ef0a47e RS |
3215 | If `set-mark-command-repeat-pop' is non-nil, repeating |
3216 | the \\[set-mark-command] command with no prefix pops the next position | |
3217 | off the local (or global) mark ring and jumps there. | |
66ef2df9 KS |
3218 | |
3219 | With a double \\[universal-argument] prefix argument, e.g. \\[universal-argument] \ | |
3220 | \\[universal-argument] \\[set-mark-command], unconditionally | |
3221 | set mark where point is. | |
2076c87c | 3222 | |
7cb42362 RS |
3223 | Setting the mark also sets the \"region\", which is the closest |
3224 | equivalent in Emacs to what some editors call the \"selection\". | |
3225 | ||
ff1fbe3e | 3226 | Novice Emacs Lisp programmers often try to use the mark for the wrong |
2076c87c JB |
3227 | purposes. See the documentation of `set-mark' for more information." |
3228 | (interactive "P") | |
868c2f49 KS |
3229 | (if (eq transient-mark-mode 'lambda) |
3230 | (setq transient-mark-mode nil)) | |
3231 | (cond | |
18c5df40 KS |
3232 | ((and (consp arg) (> (prefix-numeric-value arg) 4)) |
3233 | (push-mark-command nil)) | |
868c2f49 | 3234 | ((not (eq this-command 'set-mark-command)) |
1841f9e3 KS |
3235 | (if arg |
3236 | (pop-to-mark-command) | |
3237 | (push-mark-command t))) | |
6a936796 RS |
3238 | ((and set-mark-command-repeat-pop |
3239 | (eq last-command 'pop-to-mark-command)) | |
66ef2df9 KS |
3240 | (setq this-command 'pop-to-mark-command) |
3241 | (pop-to-mark-command)) | |
6a936796 RS |
3242 | ((and set-mark-command-repeat-pop |
3243 | (eq last-command 'pop-global-mark) | |
3244 | (not arg)) | |
66ef2df9 KS |
3245 | (setq this-command 'pop-global-mark) |
3246 | (pop-global-mark)) | |
868c2f49 | 3247 | (arg |
1841f9e3 | 3248 | (setq this-command 'pop-to-mark-command) |
868c2f49 KS |
3249 | (pop-to-mark-command)) |
3250 | ((and (eq last-command 'set-mark-command) | |
3251 | mark-active (null transient-mark-mode)) | |
3252 | (setq transient-mark-mode 'lambda) | |
3253 | (message "Transient-mark-mode temporarily enabled")) | |
3254 | (t | |
3255 | (push-mark-command nil)))) | |
2076c87c | 3256 | |
fd0f4056 | 3257 | (defun push-mark (&optional location nomsg activate) |
2076c87c | 3258 | "Set mark at LOCATION (point, by default) and push old mark on mark ring. |
f1382a3d RM |
3259 | If the last global mark pushed was not in the current buffer, |
3260 | also push LOCATION on the global mark ring. | |
fd0f4056 | 3261 | Display `Mark set' unless the optional second arg NOMSG is non-nil. |
8cdc660f | 3262 | In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil. |
2076c87c | 3263 | |
ff1fbe3e | 3264 | Novice Emacs Lisp programmers often try to use the mark for the wrong |
9a1277dd RS |
3265 | purposes. See the documentation of `set-mark' for more information. |
3266 | ||
3267 | In Transient Mark mode, this does not activate the mark." | |
1a0d0b6a | 3268 | (unless (null (mark t)) |
2076c87c | 3269 | (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring)) |
1a0d0b6a JPW |
3270 | (when (> (length mark-ring) mark-ring-max) |
3271 | (move-marker (car (nthcdr mark-ring-max mark-ring)) nil) | |
3272 | (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil))) | |
9a1277dd | 3273 | (set-marker (mark-marker) (or location (point)) (current-buffer)) |
dc029f0b | 3274 | ;; Now push the mark on the global mark ring. |
f1382a3d | 3275 | (if (and global-mark-ring |
e08d3f7c | 3276 | (eq (marker-buffer (car global-mark-ring)) (current-buffer))) |
f1382a3d RM |
3277 | ;; The last global mark pushed was in this same buffer. |
3278 | ;; Don't push another one. | |
3279 | nil | |
3280 | (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring)) | |
1a0d0b6a JPW |
3281 | (when (> (length global-mark-ring) global-mark-ring-max) |
3282 | (move-marker (car (nthcdr global-mark-ring-max global-mark-ring)) nil) | |
3283 | (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil))) | |
efcf38c7 | 3284 | (or nomsg executing-kbd-macro (> (minibuffer-depth) 0) |
2076c87c | 3285 | (message "Mark set")) |
8cdc660f RS |
3286 | (if (or activate (not transient-mark-mode)) |
3287 | (set-mark (mark t))) | |
2076c87c JB |
3288 | nil) |
3289 | ||
3290 | (defun pop-mark () | |
3291 | "Pop off mark ring into the buffer's actual mark. | |
3292 | Does not set point. Does nothing if mark ring is empty." | |
1a0d0b6a JPW |
3293 | (when mark-ring |
3294 | (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker))))) | |
3295 | (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer)) | |
1a0d0b6a JPW |
3296 | (move-marker (car mark-ring) nil) |
3297 | (if (null (mark t)) (ding)) | |
0137bae6 JL |
3298 | (setq mark-ring (cdr mark-ring))) |
3299 | (deactivate-mark)) | |
2076c87c | 3300 | |
e462e42f | 3301 | (defalias 'exchange-dot-and-mark 'exchange-point-and-mark) |
868c2f49 | 3302 | (defun exchange-point-and-mark (&optional arg) |
af39530e RS |
3303 | "Put the mark where point is now, and point where the mark is now. |
3304 | This command works even when the mark is not active, | |
868c2f49 KS |
3305 | and it reactivates the mark. |
3306 | With prefix arg, `transient-mark-mode' is enabled temporarily." | |
3307 | (interactive "P") | |
3308 | (if arg | |
f1180544 | 3309 | (if mark-active |
868c2f49 KS |
3310 | (if (null transient-mark-mode) |
3311 | (setq transient-mark-mode 'lambda)) | |
3312 | (setq arg nil))) | |
3313 | (unless arg | |
3314 | (let ((omark (mark t))) | |
3315 | (if (null omark) | |
3316 | (error "No mark set in this buffer")) | |
3317 | (set-mark (point)) | |
3318 | (goto-char omark) | |
3319 | nil))) | |
e23c2c21 | 3320 | |
6710df48 | 3321 | (define-minor-mode transient-mark-mode |
e23c2c21 | 3322 | "Toggle Transient Mark mode. |
b411b5fa | 3323 | With arg, turn Transient Mark mode on if arg is positive, off otherwise. |
e23c2c21 | 3324 | |
5dd1220d RS |
3325 | In Transient Mark mode, when the mark is active, the region is highlighted. |
3326 | Changing the buffer \"deactivates\" the mark. | |
3327 | So do certain other operations that set the mark | |
3328 | but whose main purpose is something else--for example, | |
cfa70244 EZ |
3329 | incremental search, \\[beginning-of-buffer], and \\[end-of-buffer]. |
3330 | ||
8e843bc4 EZ |
3331 | You can also deactivate the mark by typing \\[keyboard-quit] or |
3332 | \\[keyboard-escape-quit]. | |
1465c66b | 3333 | |
cfa70244 EZ |
3334 | Many commands change their behavior when Transient Mark mode is in effect |
3335 | and the mark is active, by acting on the region instead of their usual | |
4c5f7215 | 3336 | default part of the buffer's text. Examples of such commands include |
705a5933 JL |
3337 | \\[comment-dwim], \\[flush-lines], \\[keep-lines], \ |
3338 | \\[query-replace], \\[query-replace-regexp], \\[ispell], and \\[undo]. | |
3339 | Invoke \\[apropos-documentation] and type \"transient\" or | |
3340 | \"mark.*active\" at the prompt, to see the documentation of | |
3341 | commands which are sensitive to the Transient Mark mode." | |
dfd8ca69 | 3342 | :global t :group 'editing-basics) |
dc029f0b | 3343 | |
d0c4882d RS |
3344 | (defvar widen-automatically t |
3345 | "Non-nil means it is ok for commands to call `widen' when they want to. | |
3346 | Some commands will do this in order to go to positions outside | |
3347 | the current accessible part of the buffer. | |
3348 | ||
3349 | If `widen-automatically' is nil, these commands will do something else | |
3350 | as a fallback, and won't change the buffer bounds.") | |
3351 | ||
dc029f0b RM |
3352 | (defun pop-global-mark () |
3353 | "Pop off global mark ring and jump to the top location." | |
3354 | (interactive) | |
52b6d445 RS |
3355 | ;; Pop entries which refer to non-existent buffers. |
3356 | (while (and global-mark-ring (not (marker-buffer (car global-mark-ring)))) | |
3357 | (setq global-mark-ring (cdr global-mark-ring))) | |
dc029f0b RM |
3358 | (or global-mark-ring |
3359 | (error "No global mark set")) | |
3360 | (let* ((marker (car global-mark-ring)) | |
3361 | (buffer (marker-buffer marker)) | |
3362 | (position (marker-position marker))) | |
34c31301 RS |
3363 | (setq global-mark-ring (nconc (cdr global-mark-ring) |
3364 | (list (car global-mark-ring)))) | |
dc029f0b RM |
3365 | (set-buffer buffer) |
3366 | (or (and (>= position (point-min)) | |
3367 | (<= position (point-max))) | |
d0c4882d | 3368 | (if widen-automatically |
60aee8b2 RS |
3369 | (widen) |
3370 | (error "Global mark position is outside accessible part of buffer"))) | |
dc029f0b RM |
3371 | (goto-char position) |
3372 | (switch-to-buffer buffer))) | |
2d88b556 | 3373 | \f |
95791033 | 3374 | (defcustom next-line-add-newlines nil |
69c1dd37 RS |
3375 | "*If non-nil, `next-line' inserts newline to avoid `end of buffer' error." |
3376 | :type 'boolean | |
e1d6e383 | 3377 | :version "21.1" |
69c1dd37 | 3378 | :group 'editing-basics) |
38ebcf29 | 3379 | |
295f6616 | 3380 | (defun next-line (&optional arg try-vscroll) |
2076c87c | 3381 | "Move cursor vertically down ARG lines. |
295f6616 | 3382 | Interactively, vscroll tall lines if `auto-window-vscroll' is enabled. |
2076c87c JB |
3383 | If there is no character in the target line exactly under the current column, |
3384 | the cursor is positioned after the character in that line which spans this | |
3385 | column, or at the end of the line if it is not long enough. | |
38ebcf29 | 3386 | If there is no line in the buffer after this one, behavior depends on the |
1a2c3941 RS |
3387 | value of `next-line-add-newlines'. If non-nil, it inserts a newline character |
3388 | to create a line, and moves the cursor to that line. Otherwise it moves the | |
e47d38f6 | 3389 | cursor to the end of the buffer. |
2076c87c JB |
3390 | |
3391 | The command \\[set-goal-column] can be used to create | |
85969cb1 RS |
3392 | a semipermanent goal column for this command. |
3393 | Then instead of trying to move exactly vertically (or as close as possible), | |
3394 | this command moves to the specified goal column (or as close as possible). | |
3395 | The goal column is stored in the variable `goal-column', which is nil | |
3396 | when there is no goal column. | |
2076c87c JB |
3397 | |
3398 | If you are thinking of using this in a Lisp program, consider | |
3399 | using `forward-line' instead. It is usually easier to use | |
3400 | and more reliable (no dependence on goal column, etc.)." | |
295f6616 | 3401 | (interactive "p\np") |
b82d844f | 3402 | (or arg (setq arg 1)) |
028922cf | 3403 | (if (and next-line-add-newlines (= arg 1)) |
207d7545 GM |
3404 | (if (save-excursion (end-of-line) (eobp)) |
3405 | ;; When adding a newline, don't expand an abbrev. | |
3406 | (let ((abbrev-mode nil)) | |
24886813 | 3407 | (end-of-line) |
15575807 | 3408 | (insert (if use-hard-newlines hard-newline "\n"))) |
295f6616 | 3409 | (line-move arg nil nil try-vscroll)) |
1a2c3941 RS |
3410 | (if (interactive-p) |
3411 | (condition-case nil | |
295f6616 | 3412 | (line-move arg nil nil try-vscroll) |
1a2c3941 | 3413 | ((beginning-of-buffer end-of-buffer) (ding))) |
295f6616 | 3414 | (line-move arg nil nil try-vscroll))) |
2076c87c JB |
3415 | nil) |
3416 | ||
295f6616 | 3417 | (defun previous-line (&optional arg try-vscroll) |
2076c87c | 3418 | "Move cursor vertically up ARG lines. |
295f6616 | 3419 | Interactively, vscroll tall lines if `auto-window-vscroll' is enabled. |
2076c87c JB |
3420 | If there is no character in the target line exactly over the current column, |
3421 | the cursor is positioned after the character in that line which spans this | |
3422 | column, or at the end of the line if it is not long enough. | |
3423 | ||
3424 | The command \\[set-goal-column] can be used to create | |
85969cb1 RS |
3425 | a semipermanent goal column for this command. |
3426 | Then instead of trying to move exactly vertically (or as close as possible), | |
3427 | this command moves to the specified goal column (or as close as possible). | |
3428 | The goal column is stored in the variable `goal-column', which is nil | |
3429 | when there is no goal column. | |
2076c87c JB |
3430 | |
3431 | If you are thinking of using this in a Lisp program, consider using | |
c2e8a012 | 3432 | `forward-line' with a negative argument instead. It is usually easier |
2076c87c | 3433 | to use and more reliable (no dependence on goal column, etc.)." |
295f6616 | 3434 | (interactive "p\np") |
b82d844f | 3435 | (or arg (setq arg 1)) |
1a2c3941 RS |
3436 | (if (interactive-p) |
3437 | (condition-case nil | |
295f6616 | 3438 | (line-move (- arg) nil nil try-vscroll) |
1a2c3941 | 3439 | ((beginning-of-buffer end-of-buffer) (ding))) |
295f6616 | 3440 | (line-move (- arg) nil nil try-vscroll)) |
2076c87c | 3441 | nil) |
eaae8106 | 3442 | |
69c1dd37 | 3443 | (defcustom track-eol nil |
2076c87c JB |
3444 | "*Non-nil means vertical motion starting at end of line keeps to ends of lines. |
3445 | This means moving to the end of each line moved onto. | |
69c1dd37 RS |
3446 | The beginning of a blank line does not count as the end of a line." |
3447 | :type 'boolean | |
3448 | :group 'editing-basics) | |
3449 | ||
3450 | (defcustom goal-column nil | |
3451 | "*Semipermanent goal column for vertical motion, as set by \\[set-goal-column], or nil." | |
3452 | :type '(choice integer | |
3453 | (const :tag "None" nil)) | |
3454 | :group 'editing-basics) | |
912c6728 | 3455 | (make-variable-buffer-local 'goal-column) |
2076c87c JB |
3456 | |
3457 | (defvar temporary-goal-column 0 | |
3458 | "Current goal column for vertical motion. | |
3459 | It is the column where point was | |
3460 | at the start of current run of vertical motion commands. | |
c637ae6f | 3461 | When the `track-eol' feature is doing its job, the value is 9999.") |
2076c87c | 3462 | |
bbf41690 | 3463 | (defcustom line-move-ignore-invisible t |
098fc1fb | 3464 | "*Non-nil means \\[next-line] and \\[previous-line] ignore invisible lines. |
69c1dd37 RS |
3465 | Outline mode sets this." |
3466 | :type 'boolean | |
3467 | :group 'editing-basics) | |
098fc1fb | 3468 | |
bbf41690 | 3469 | (defun line-move-invisible-p (pos) |
af894fc9 RS |
3470 | "Return non-nil if the character after POS is currently invisible." |
3471 | (let ((prop | |
3472 | (get-char-property pos 'invisible))) | |
3473 | (if (eq buffer-invisibility-spec t) | |
3474 | prop | |
3475 | (or (memq prop buffer-invisibility-spec) | |
3476 | (assq prop buffer-invisibility-spec))))) | |
3477 | ||
b704b1f0 KS |
3478 | ;; Returns non-nil if partial move was done. |
3479 | (defun line-move-partial (arg noerror to-end) | |
3480 | (if (< arg 0) | |
3481 | ;; Move backward (up). | |
3482 | ;; If already vscrolled, reduce vscroll | |
3483 | (let ((vs (window-vscroll nil t))) | |
3484 | (when (> vs (frame-char-height)) | |
3485 | (set-window-vscroll nil (- vs (frame-char-height)) t))) | |
3486 | ||
3487 | ;; Move forward (down). | |
e437f99a KS |
3488 | (let* ((lh (window-line-height -1)) |
3489 | (vpos (nth 1 lh)) | |
3490 | (ypos (nth 2 lh)) | |
3491 | (rbot (nth 3 lh)) | |
3492 | ppos py vs) | |
3493 | (when (or (null lh) | |
3494 | (>= rbot (frame-char-height)) | |
3495 | (<= ypos (- (frame-char-height)))) | |
3496 | (unless lh | |
0e7a5039 KS |
3497 | (let ((wend (pos-visible-in-window-p t nil t))) |
3498 | (setq rbot (nth 3 wend) | |
3499 | vpos (nth 5 wend)))) | |
e437f99a KS |
3500 | (cond |
3501 | ;; If last line of window is fully visible, move forward. | |
3502 | ((or (null rbot) (= rbot 0)) | |
3503 | nil) | |
3504 | ;; If cursor is not in the bottom scroll margin, move forward. | |
3505 | ((and (> vpos 0) | |
95f5a37f KS |
3506 | (< (setq py |
3507 | (or (nth 1 (window-line-height)) | |
3508 | (let ((ppos (posn-at-point))) | |
3509 | (cdr (or (posn-actual-col-row ppos) | |
3510 | (posn-col-row ppos)))))) | |
e437f99a KS |
3511 | (min (- (window-text-height) scroll-margin 1) (1- vpos)))) |
3512 | nil) | |
3513 | ;; When already vscrolled, we vscroll some more if we can, | |
3514 | ;; or clear vscroll and move forward at end of tall image. | |
3515 | ((> (setq vs (window-vscroll nil t)) 0) | |
3516 | (when (> rbot 0) | |
3517 | (set-window-vscroll nil (+ vs (min rbot (frame-char-height))) t))) | |
3518 | ;; If cursor just entered the bottom scroll margin, move forward, | |
3519 | ;; but also vscroll one line so redisplay wont recenter. | |
3520 | ((and (> vpos 0) | |
3521 | (= py (min (- (window-text-height) scroll-margin 1) | |
3522 | (1- vpos)))) | |
3523 | (set-window-vscroll nil (frame-char-height) t) | |
3524 | (line-move-1 arg noerror to-end) | |
3525 | t) | |
3526 | ;; If there are lines above the last line, scroll-up one line. | |
3527 | ((> vpos 0) | |
3528 | (scroll-up 1) | |
3529 | t) | |
3530 | ;; Finally, start vscroll. | |
3531 | (t | |
3532 | (set-window-vscroll nil (frame-char-height) t))))))) | |
b704b1f0 KS |
3533 | |
3534 | ||
03ceda9e RS |
3535 | ;; This is like line-move-1 except that it also performs |
3536 | ;; vertical scrolling of tall images if appropriate. | |
3537 | ;; That is not really a clean thing to do, since it mixes | |
3538 | ;; scrolling with cursor motion. But so far we don't have | |
3539 | ;; a cleaner solution to the problem of making C-n do something | |
3540 | ;; useful given a tall image. | |
ed02c1db | 3541 | (defun line-move (arg &optional noerror to-end try-vscroll) |
b704b1f0 KS |
3542 | (unless (and auto-window-vscroll try-vscroll |
3543 | ;; Only vscroll for single line moves | |
3544 | (= (abs arg) 1) | |
3545 | ;; But don't vscroll in a keyboard macro. | |
3546 | (not defining-kbd-macro) | |
3547 | (not executing-kbd-macro) | |
3548 | (line-move-partial arg noerror to-end)) | |
3549 | (set-window-vscroll nil 0 t) | |
16c2f92f KS |
3550 | (line-move-1 arg noerror to-end))) |
3551 | ||
8c745744 RS |
3552 | ;; This is the guts of next-line and previous-line. |
3553 | ;; Arg says how many lines to move. | |
bbf41690 | 3554 | ;; The value is t if we can move the specified number of lines. |
16c2f92f | 3555 | (defun line-move-1 (arg &optional noerror to-end) |
2596511d RS |
3556 | ;; Don't run any point-motion hooks, and disregard intangibility, |
3557 | ;; for intermediate positions. | |
3558 | (let ((inhibit-point-motion-hooks t) | |
3559 | (opoint (point)) | |
fef11f15 | 3560 | (orig-arg arg)) |
2596511d RS |
3561 | (unwind-protect |
3562 | (progn | |
41d22ee0 | 3563 | (if (not (memq last-command '(next-line previous-line))) |
2596511d RS |
3564 | (setq temporary-goal-column |
3565 | (if (and track-eol (eolp) | |
3566 | ;; Don't count beg of empty line as end of line | |
3567 | ;; unless we just did explicit end-of-line. | |
ab9623c2 | 3568 | (or (not (bolp)) (eq last-command 'move-end-of-line))) |
2596511d RS |
3569 | 9999 |
3570 | (current-column)))) | |
bbf41690 | 3571 | |
2596511d RS |
3572 | (if (and (not (integerp selective-display)) |
3573 | (not line-move-ignore-invisible)) | |
3574 | ;; Use just newline characters. | |
e9cd25fe | 3575 | ;; Set ARG to 0 if we move as many lines as requested. |
2596511d RS |
3576 | (or (if (> arg 0) |
3577 | (progn (if (> arg 1) (forward-line (1- arg))) | |
3578 | ;; This way of moving forward ARG lines | |
3579 | ;; verifies that we have a newline after the last one. | |
3580 | ;; It doesn't get confused by intangible text. | |
3581 | (end-of-line) | |
e9cd25fe RS |
3582 | (if (zerop (forward-line 1)) |
3583 | (setq arg 0))) | |
2596511d | 3584 | (and (zerop (forward-line arg)) |
e9cd25fe RS |
3585 | (bolp) |
3586 | (setq arg 0))) | |
bbf41690 RS |
3587 | (unless noerror |
3588 | (signal (if (< arg 0) | |
3589 | 'beginning-of-buffer | |
3590 | 'end-of-buffer) | |
3591 | nil))) | |
2596511d | 3592 | ;; Move by arg lines, but ignore invisible ones. |
fef11f15 | 3593 | (let (done line-end) |
bbf41690 RS |
3594 | (while (and (> arg 0) (not done)) |
3595 | ;; If the following character is currently invisible, | |
3596 | ;; skip all characters with that same `invisible' property value. | |
3597 | (while (and (not (eobp)) (line-move-invisible-p (point))) | |
3598 | (goto-char (next-char-property-change (point)))) | |
fef11f15 CY |
3599 | ;; Move a line. |
3600 | ;; We don't use `end-of-line', since we want to escape | |
3601 | ;; from field boundaries ocurring exactly at point. | |
3602 | (let ((inhibit-field-text-motion t)) | |
3603 | (setq line-end (line-end-position))) | |
3604 | (goto-char (constrain-to-field line-end (point) t t)) | |
e9ab825f | 3605 | ;; If there's no invisibility here, move over the newline. |
3e43ae87 KS |
3606 | (cond |
3607 | ((eobp) | |
3608 | (if (not noerror) | |
3609 | (signal 'end-of-buffer nil) | |
3610 | (setq done t))) | |
3611 | ((and (> arg 1) ;; Use vertical-motion for last move | |
3612 | (not (integerp selective-display)) | |
3613 | (not (line-move-invisible-p (point)))) | |
3614 | ;; We avoid vertical-motion when possible | |
3615 | ;; because that has to fontify. | |
3616 | (forward-line 1)) | |
3617 | ;; Otherwise move a more sophisticated way. | |
3618 | ((zerop (vertical-motion 1)) | |
3619 | (if (not noerror) | |
3620 | (signal 'end-of-buffer nil) | |
3621 | (setq done t)))) | |
bbf41690 RS |
3622 | (unless done |
3623 | (setq arg (1- arg)))) | |
22c8bff1 | 3624 | ;; The logic of this is the same as the loop above, |
e9ab825f | 3625 | ;; it just goes in the other direction. |
bbf41690 | 3626 | (while (and (< arg 0) (not done)) |
ac6701ea CY |
3627 | ;; For completely consistency with the forward-motion |
3628 | ;; case, we should call beginning-of-line here. | |
3629 | ;; However, if point is inside a field and on a | |
3630 | ;; continued line, the call to (vertical-motion -1) | |
3631 | ;; below won't move us back far enough; then we return | |
3632 | ;; to the same column in line-move-finish, and point | |
3633 | ;; gets stuck -- cyd | |
3634 | (forward-line 0) | |
3e43ae87 KS |
3635 | (cond |
3636 | ((bobp) | |
3637 | (if (not noerror) | |
3638 | (signal 'beginning-of-buffer nil) | |
3639 | (setq done t))) | |
3640 | ((and (< arg -1) ;; Use vertical-motion for last move | |
3641 | (not (integerp selective-display)) | |
3642 | (not (line-move-invisible-p (1- (point))))) | |
3643 | (forward-line -1)) | |
3644 | ((zerop (vertical-motion -1)) | |
3645 | (if (not noerror) | |
3646 | (signal 'beginning-of-buffer nil) | |
3647 | (setq done t)))) | |
bbf41690 RS |
3648 | (unless done |
3649 | (setq arg (1+ arg)) | |
3650 | (while (and ;; Don't move over previous invis lines | |
3651 | ;; if our target is the middle of this line. | |
3652 | (or (zerop (or goal-column temporary-goal-column)) | |
3653 | (< arg 0)) | |
3654 | (not (bobp)) (line-move-invisible-p (1- (point)))) | |
3655 | (goto-char (previous-char-property-change (point)))))))) | |
3656 | ;; This is the value the function returns. | |
3657 | (= arg 0)) | |
af894fc9 | 3658 | |
e9cd25fe RS |
3659 | (cond ((> arg 0) |
3660 | ;; If we did not move down as far as desired, | |
3661 | ;; at least go to end of line. | |
3662 | (end-of-line)) | |
3663 | ((< arg 0) | |
f9872a6b JL |
3664 | ;; If we did not move up as far as desired, |
3665 | ;; at least go to beginning of line. | |
e9cd25fe RS |
3666 | (beginning-of-line)) |
3667 | (t | |
20782abb | 3668 | (line-move-finish (or goal-column temporary-goal-column) |
fef11f15 | 3669 | opoint (> orig-arg 0))))))) |
2076c87c | 3670 | |
20782abb | 3671 | (defun line-move-finish (column opoint forward) |
af894fc9 RS |
3672 | (let ((repeat t)) |
3673 | (while repeat | |
3674 | ;; Set REPEAT to t to repeat the whole thing. | |
3675 | (setq repeat nil) | |
3676 | ||
1f980920 | 3677 | (let (new |
963355a4 | 3678 | (old (point)) |
af894fc9 | 3679 | (line-beg (save-excursion (beginning-of-line) (point))) |
1f980920 RS |
3680 | (line-end |
3681 | ;; Compute the end of the line | |
20782abb | 3682 | ;; ignoring effectively invisible newlines. |
bbf41690 | 3683 | (save-excursion |
a5b4a6a0 RS |
3684 | ;; Like end-of-line but ignores fields. |
3685 | (skip-chars-forward "^\n") | |
20782abb RS |
3686 | (while (and (not (eobp)) (line-move-invisible-p (point))) |
3687 | (goto-char (next-char-property-change (point))) | |
a5b4a6a0 | 3688 | (skip-chars-forward "^\n")) |
bbf41690 | 3689 | (point)))) |
1f980920 RS |
3690 | |
3691 | ;; Move to the desired column. | |
3692 | (line-move-to-column column) | |
963355a4 CY |
3693 | |
3694 | ;; Corner case: suppose we start out in a field boundary in | |
3695 | ;; the middle of a continued line. When we get to | |
3696 | ;; line-move-finish, point is at the start of a new *screen* | |
3697 | ;; line but the same text line; then line-move-to-column would | |
3698 | ;; move us backwards. Test using C-n with point on the "x" in | |
3699 | ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y)) | |
3700 | (and forward | |
3701 | (< (point) old) | |
3702 | (goto-char old)) | |
3703 | ||
1f980920 | 3704 | (setq new (point)) |
af894fc9 RS |
3705 | |
3706 | ;; Process intangibility within a line. | |
594a1605 CY |
3707 | ;; With inhibit-point-motion-hooks bound to nil, a call to |
3708 | ;; goto-char moves point past intangible text. | |
3709 | ||
3710 | ;; However, inhibit-point-motion-hooks controls both the | |
3711 | ;; intangibility and the point-entered/point-left hooks. The | |
3712 | ;; following hack avoids calling the point-* hooks | |
3713 | ;; unnecessarily. Note that we move *forward* past intangible | |
3714 | ;; text when the initial and final points are the same. | |
d584e29d | 3715 | (goto-char new) |
9036363b CY |
3716 | (let ((inhibit-point-motion-hooks nil)) |
3717 | (goto-char new) | |
3718 | ||
3719 | ;; If intangibility moves us to a different (later) place | |
3720 | ;; in the same line, use that as the destination. | |
3721 | (if (<= (point) line-end) | |
1f980920 | 3722 | (setq new (point)) |
9036363b CY |
3723 | ;; If that position is "too late", |
3724 | ;; try the previous allowable position. | |
3725 | ;; See if it is ok. | |
3726 | (backward-char) | |
3727 | (if (if forward | |
3728 | ;; If going forward, don't accept the previous | |
3729 | ;; allowable position if it is before the target line. | |
3730 | (< line-beg (point)) | |
3731 | ;; If going backward, don't accept the previous | |
3732 | ;; allowable position if it is still after the target line. | |
3733 | (<= (point) line-end)) | |
3734 | (setq new (point)) | |
3735 | ;; As a last resort, use the end of the line. | |
3736 | (setq new line-end)))) | |
af894fc9 RS |
3737 | |
3738 | ;; Now move to the updated destination, processing fields | |
3739 | ;; as well as intangibility. | |
3740 | (goto-char opoint) | |
3741 | (let ((inhibit-point-motion-hooks nil)) | |
3742 | (goto-char | |
e94e78cc CY |
3743 | ;; Ignore field boundaries if the initial and final |
3744 | ;; positions have the same `field' property, even if the | |
3745 | ;; fields are non-contiguous. This seems to be "nicer" | |
3746 | ;; behavior in many situations. | |
3747 | (if (eq (get-char-property new 'field) | |
3748 | (get-char-property opoint 'field)) | |
3749 | new | |
3750 | (constrain-to-field new opoint t t | |
3751 | 'inhibit-line-move-field-capture)))) | |
af894fc9 | 3752 | |
1f980920 | 3753 | ;; If all this moved us to a different line, |
af894fc9 RS |
3754 | ;; retry everything within that new line. |
3755 | (when (or (< (point) line-beg) (> (point) line-end)) | |
3756 | ;; Repeat the intangibility and field processing. | |
3757 | (setq repeat t)))))) | |
3758 | ||
3759 | (defun line-move-to-column (col) | |
3760 | "Try to find column COL, considering invisibility. | |
3761 | This function works only in certain cases, | |
3762 | because what we really need is for `move-to-column' | |
3763 | and `current-column' to be able to ignore invisible text." | |
a615252b RS |
3764 | (if (zerop col) |
3765 | (beginning-of-line) | |
095f9ae4 | 3766 | (move-to-column col)) |
af894fc9 RS |
3767 | |
3768 | (when (and line-move-ignore-invisible | |
bbf41690 | 3769 | (not (bolp)) (line-move-invisible-p (1- (point)))) |
af894fc9 RS |
3770 | (let ((normal-location (point)) |
3771 | (normal-column (current-column))) | |
3772 | ;; If the following character is currently invisible, | |
3773 | ;; skip all characters with that same `invisible' property value. | |
3774 | (while (and (not (eobp)) | |
bbf41690 | 3775 | (line-move-invisible-p (point))) |
af894fc9 RS |
3776 | (goto-char (next-char-property-change (point)))) |
3777 | ;; Have we advanced to a larger column position? | |
3778 | (if (> (current-column) normal-column) | |
3779 | ;; We have made some progress towards the desired column. | |
3780 | ;; See if we can make any further progress. | |
3781 | (line-move-to-column (+ (current-column) (- col normal-column))) | |
3782 | ;; Otherwise, go to the place we originally found | |
3783 | ;; and move back over invisible text. | |
3784 | ;; that will get us to the same place on the screen | |
3785 | ;; but with a more reasonable buffer position. | |
3786 | (goto-char normal-location) | |
3787 | (let ((line-beg (save-excursion (beginning-of-line) (point)))) | |
bbf41690 | 3788 | (while (and (not (bolp)) (line-move-invisible-p (1- (point)))) |
af894fc9 RS |
3789 | (goto-char (previous-char-property-change (point) line-beg)))))))) |
3790 | ||
bbf41690 | 3791 | (defun move-end-of-line (arg) |
f00239cf RS |
3792 | "Move point to end of current line as displayed. |
3793 | \(If there's an image in the line, this disregards newlines | |
3794 | which are part of the text that the image rests on.) | |
3795 | ||
bbf41690 RS |
3796 | With argument ARG not nil or 1, move forward ARG - 1 lines first. |
3797 | If point reaches the beginning or end of buffer, it stops there. | |
f00239cf | 3798 | To ignore intangibility, bind `inhibit-point-motion-hooks' to t." |
bbf41690 RS |
3799 | (interactive "p") |
3800 | (or arg (setq arg 1)) | |
3801 | (let (done) | |
3802 | (while (not done) | |
3803 | (let ((newpos | |
3804 | (save-excursion | |
3805 | (let ((goal-column 0)) | |
3806 | (and (line-move arg t) | |
3807 | (not (bobp)) | |
3808 | (progn | |
3809 | (while (and (not (bobp)) (line-move-invisible-p (1- (point)))) | |
3810 | (goto-char (previous-char-property-change (point)))) | |
3811 | (backward-char 1))) | |
3812 | (point))))) | |
3813 | (goto-char newpos) | |
3814 | (if (and (> (point) newpos) | |
3815 | (eq (preceding-char) ?\n)) | |
3816 | (backward-char 1) | |
3817 | (if (and (> (point) newpos) (not (eobp)) | |
3818 | (not (eq (following-char) ?\n))) | |
3819 | ;; If we skipped something intangible | |
3820 | ;; and now we're not really at eol, | |
3821 | ;; keep going. | |
3822 | (setq arg 1) | |
3823 | (setq done t))))))) | |
3824 | ||
0cbb497c | 3825 | (defun move-beginning-of-line (arg) |
f00239cf RS |
3826 | "Move point to beginning of current line as displayed. |
3827 | \(If there's an image in the line, this disregards newlines | |
3828 | which are part of the text that the image rests on.) | |
3829 | ||
0cbb497c KS |
3830 | With argument ARG not nil or 1, move forward ARG - 1 lines first. |
3831 | If point reaches the beginning or end of buffer, it stops there. | |
f00239cf | 3832 | To ignore intangibility, bind `inhibit-point-motion-hooks' to t." |
0cbb497c KS |
3833 | (interactive "p") |
3834 | (or arg (setq arg 1)) | |
398c9ffb | 3835 | |
ad47c4a0 RS |
3836 | (let ((orig (point)) |
3837 | start first-vis first-vis-field-value) | |
1fffd65f RS |
3838 | |
3839 | ;; Move by lines, if ARG is not 1 (the default). | |
3840 | (if (/= arg 1) | |
3841 | (line-move (1- arg) t)) | |
3842 | ||
3843 | ;; Move to beginning-of-line, ignoring fields and invisibles. | |
3844 | (skip-chars-backward "^\n") | |
3845 | (while (and (not (bobp)) (line-move-invisible-p (1- (point)))) | |
621a4cc8 | 3846 | (goto-char (previous-char-property-change (point))) |
1fffd65f | 3847 | (skip-chars-backward "^\n")) |
ad47c4a0 RS |
3848 | (setq start (point)) |
3849 | ||
3850 | ;; Now find first visible char in the line | |
3851 | (while (and (not (eobp)) (line-move-invisible-p (point))) | |
3852 | (goto-char (next-char-property-change (point)))) | |
3853 | (setq first-vis (point)) | |
3854 | ||
3855 | ;; See if fields would stop us from reaching FIRST-VIS. | |
3856 | (setq first-vis-field-value | |
3857 | (constrain-to-field first-vis orig (/= arg 1) t nil)) | |
3858 | ||
3859 | (goto-char (if (/= first-vis-field-value first-vis) | |
3860 | ;; If yes, obey them. | |
3861 | first-vis-field-value | |
3862 | ;; Otherwise, move to START with attention to fields. | |
3863 | ;; (It is possible that fields never matter in this case.) | |
3864 | (constrain-to-field (point) orig | |
3865 | (/= arg 1) t nil))))) | |
0cbb497c KS |
3866 | |
3867 | ||
d5ab2033 JB |
3868 | ;;; Many people have said they rarely use this feature, and often type |
3869 | ;;; it by accident. Maybe it shouldn't even be on a key. | |
3870 | (put 'set-goal-column 'disabled t) | |
2076c87c JB |
3871 | |
3872 | (defun set-goal-column (arg) | |
3873 | "Set the current horizontal position as a goal for \\[next-line] and \\[previous-line]. | |
3874 | Those commands will move to this position in the line moved to | |
3875 | rather than trying to keep the same horizontal position. | |
3876 | With a non-nil argument, clears out the goal column | |
912c6728 RS |
3877 | so that \\[next-line] and \\[previous-line] resume vertical motion. |
3878 | The goal column is stored in the variable `goal-column'." | |
2076c87c JB |
3879 | (interactive "P") |
3880 | (if arg | |
3881 | (progn | |
3882 | (setq goal-column nil) | |
3883 | (message "No goal column")) | |
3884 | (setq goal-column (current-column)) | |
8a26c165 DG |
3885 | ;; The older method below can be erroneous if `set-goal-column' is bound |
3886 | ;; to a sequence containing % | |
3887 | ;;(message (substitute-command-keys | |
3888 | ;;"Goal column %d (use \\[set-goal-column] with an arg to unset it)") | |
3889 | ;;goal-column) | |
3890 | (message "%s" | |
63219d53 | 3891 | (concat |
8a26c165 DG |
3892 | (format "Goal column %d " goal-column) |
3893 | (substitute-command-keys | |
3894 | "(use \\[set-goal-column] with an arg to unset it)"))) | |
63219d53 | 3895 | |
8a26c165 | 3896 | ) |
2076c87c | 3897 | nil) |
2d88b556 | 3898 | \f |
7492f5a6 RS |
3899 | |
3900 | (defun scroll-other-window-down (lines) | |
e47d38f6 RS |
3901 | "Scroll the \"other window\" down. |
3902 | For more details, see the documentation for `scroll-other-window'." | |
7492f5a6 RS |
3903 | (interactive "P") |
3904 | (scroll-other-window | |
3905 | ;; Just invert the argument's meaning. | |
3906 | ;; We can do that without knowing which window it will be. | |
3907 | (if (eq lines '-) nil | |
3908 | (if (null lines) '- | |
3909 | (- (prefix-numeric-value lines)))))) | |
3aef9604 RS |
3910 | |
3911 | (defun beginning-of-buffer-other-window (arg) | |
3912 | "Move point to the beginning of the buffer in the other window. | |
3913 | Leave mark at previous position. | |
3914 | With arg N, put point N/10 of the way from the true beginning." | |
3915 | (interactive "P") | |
3916 | (let ((orig-window (selected-window)) | |
3917 | (window (other-window-for-scrolling))) | |
3918 | ;; We use unwind-protect rather than save-window-excursion | |
3919 | ;; because the latter would preserve the things we want to change. | |
3920 | (unwind-protect | |
3921 | (progn | |
3922 | (select-window window) | |
3923 | ;; Set point and mark in that window's buffer. | |
bbf41690 RS |
3924 | (with-no-warnings |
3925 | (beginning-of-buffer arg)) | |
3aef9604 RS |
3926 | ;; Set point accordingly. |
3927 | (recenter '(t))) | |
3928 | (select-window orig-window)))) | |
3929 | ||
3930 | (defun end-of-buffer-other-window (arg) | |
3931 | "Move point to the end of the buffer in the other window. | |
3932 | Leave mark at previous position. | |
3933 | With arg N, put point N/10 of the way from the true end." | |
3934 | (interactive "P") | |
3935 | ;; See beginning-of-buffer-other-window for comments. | |
3936 | (let ((orig-window (selected-window)) | |
3937 | (window (other-window-for-scrolling))) | |
3938 | (unwind-protect | |
3939 | (progn | |
3940 | (select-window window) | |
bbf41690 RS |
3941 | (with-no-warnings |
3942 | (end-of-buffer arg)) | |
3aef9604 RS |
3943 | (recenter '(t))) |
3944 | (select-window orig-window)))) | |
2d88b556 | 3945 | \f |
2076c87c JB |
3946 | (defun transpose-chars (arg) |
3947 | "Interchange characters around point, moving forward one character. | |
3948 | With prefix arg ARG, effect is to take character before point | |
3949 | and drag it forward past ARG other characters (backward if ARG negative). | |
3950 | If no argument and at end of line, the previous two chars are exchanged." | |
3951 | (interactive "*P") | |
3952 | (and (null arg) (eolp) (forward-char -1)) | |
3953 | (transpose-subr 'forward-char (prefix-numeric-value arg))) | |
3954 | ||
3955 | (defun transpose-words (arg) | |
3956 | "Interchange words around point, leaving point at end of them. | |
3957 | With prefix arg ARG, effect is to take word before or around point | |
3958 | and drag it forward past ARG other words (backward if ARG negative). | |
3959 | If ARG is zero, the words around or after point and around or after mark | |
3960 | are interchanged." | |
41d22ee0 | 3961 | ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'. |
2076c87c JB |
3962 | (interactive "*p") |
3963 | (transpose-subr 'forward-word arg)) | |
3964 | ||
3965 | (defun transpose-sexps (arg) | |
3966 | "Like \\[transpose-words] but applies to sexps. | |
3967 | Does not work on a sexp that point is in the middle of | |
3968 | if it is a list or string." | |
3969 | (interactive "*p") | |
41d22ee0 SM |
3970 | (transpose-subr |
3971 | (lambda (arg) | |
3972 | ;; Here we should try to simulate the behavior of | |
3973 | ;; (cons (progn (forward-sexp x) (point)) | |
3974 | ;; (progn (forward-sexp (- x)) (point))) | |
3975 | ;; Except that we don't want to rely on the second forward-sexp | |
3976 | ;; putting us back to where we want to be, since forward-sexp-function | |
3977 | ;; might do funny things like infix-precedence. | |
3978 | (if (if (> arg 0) | |
3979 | (looking-at "\\sw\\|\\s_") | |
3980 | (and (not (bobp)) | |
3981 | (save-excursion (forward-char -1) (looking-at "\\sw\\|\\s_")))) | |
3982 | ;; Jumping over a symbol. We might be inside it, mind you. | |
3983 | (progn (funcall (if (> arg 0) | |
3984 | 'skip-syntax-backward 'skip-syntax-forward) | |
3985 | "w_") | |
3986 | (cons (save-excursion (forward-sexp arg) (point)) (point))) | |
3987 | ;; Otherwise, we're between sexps. Take a step back before jumping | |
3988 | ;; to make sure we'll obey the same precedence no matter which direction | |
3989 | ;; we're going. | |
3990 | (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .") | |
3991 | (cons (save-excursion (forward-sexp arg) (point)) | |
3992 | (progn (while (or (forward-comment (if (> arg 0) 1 -1)) | |
3993 | (not (zerop (funcall (if (> arg 0) | |
3994 | 'skip-syntax-forward | |
3995 | 'skip-syntax-backward) | |
3996 | "."))))) | |
3997 | (point))))) | |
3998 | arg 'special)) | |
2076c87c JB |
3999 | |
4000 | (defun transpose-lines (arg) | |
4001 | "Exchange current line and previous line, leaving point after both. | |
4002 | With argument ARG, takes previous line and moves it past ARG lines. | |
4003 | With argument 0, interchanges line point is in with line mark is in." | |
4004 | (interactive "*p") | |
4005 | (transpose-subr (function | |
4006 | (lambda (arg) | |
d3f4ef3f | 4007 | (if (> arg 0) |
2076c87c | 4008 | (progn |
d3f4ef3f AS |
4009 | ;; Move forward over ARG lines, |
4010 | ;; but create newlines if necessary. | |
4011 | (setq arg (forward-line arg)) | |
4012 | (if (/= (preceding-char) ?\n) | |
4013 | (setq arg (1+ arg))) | |
4014 | (if (> arg 0) | |
4015 | (newline arg))) | |
2076c87c JB |
4016 | (forward-line arg)))) |
4017 | arg)) | |
4018 | ||
e1e04350 SM |
4019 | (defun transpose-subr (mover arg &optional special) |
4020 | (let ((aux (if special mover | |
4021 | (lambda (x) | |
4022 | (cons (progn (funcall mover x) (point)) | |
4023 | (progn (funcall mover (- x)) (point)))))) | |
4024 | pos1 pos2) | |
4025 | (cond | |
4026 | ((= arg 0) | |
4027 | (save-excursion | |
4028 | (setq pos1 (funcall aux 1)) | |
4029 | (goto-char (mark)) | |
4030 | (setq pos2 (funcall aux 1)) | |
4031 | (transpose-subr-1 pos1 pos2)) | |
4032 | (exchange-point-and-mark)) | |
4033 | ((> arg 0) | |
4034 | (setq pos1 (funcall aux -1)) | |
4035 | (setq pos2 (funcall aux arg)) | |
4036 | (transpose-subr-1 pos1 pos2) | |
4037 | (goto-char (car pos2))) | |
4038 | (t | |
4039 | (setq pos1 (funcall aux -1)) | |
4040 | (goto-char (car pos1)) | |
4041 | (setq pos2 (funcall aux arg)) | |
4042 | (transpose-subr-1 pos1 pos2))))) | |
4043 | ||
4044 | (defun transpose-subr-1 (pos1 pos2) | |
4045 | (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1)))) | |
4046 | (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2)))) | |
4047 | (when (> (car pos1) (car pos2)) | |
4048 | (let ((swap pos1)) | |
4049 | (setq pos1 pos2 pos2 swap))) | |
4050 | (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose")) | |
dc7d7552 RS |
4051 | (atomic-change-group |
4052 | (let (word2) | |
1e96c007 SM |
4053 | ;; FIXME: We first delete the two pieces of text, so markers that |
4054 | ;; used to point to after the text end up pointing to before it :-( | |
dc7d7552 RS |
4055 | (setq word2 (delete-and-extract-region (car pos2) (cdr pos2))) |
4056 | (goto-char (car pos2)) | |
4057 | (insert (delete-and-extract-region (car pos1) (cdr pos1))) | |
4058 | (goto-char (car pos1)) | |
4059 | (insert word2)))) | |
2d88b556 | 4060 | \f |
b82d844f | 4061 | (defun backward-word (&optional arg) |
b7e91b0c | 4062 | "Move backward until encountering the beginning of a word. |
20ecc110 | 4063 | With argument, do this that many times." |
9e50756b | 4064 | (interactive "p") |
b82d844f | 4065 | (forward-word (- (or arg 1)))) |
2076c87c | 4066 | |
a1a801de | 4067 | (defun mark-word (&optional arg allow-extend) |
705a5933 JL |
4068 | "Set mark ARG words away from point. |
4069 | The place mark goes is the same place \\[forward-word] would | |
4070 | move to with the same argument. | |
a1a801de | 4071 | Interactively, if this command is repeated |
771069f8 | 4072 | or (in Transient Mark mode) if the mark is active, |
705a5933 | 4073 | it marks the next ARG words after the ones already marked." |
a1a801de RS |
4074 | (interactive "P\np") |
4075 | (cond ((and allow-extend | |
4076 | (or (and (eq last-command this-command) (mark t)) | |
4077 | (and transient-mark-mode mark-active))) | |
705a5933 JL |
4078 | (setq arg (if arg (prefix-numeric-value arg) |
4079 | (if (< (mark) (point)) -1 1))) | |
cad113ae KG |
4080 | (set-mark |
4081 | (save-excursion | |
4082 | (goto-char (mark)) | |
4083 | (forward-word arg) | |
4084 | (point)))) | |
4085 | (t | |
4086 | (push-mark | |
4087 | (save-excursion | |
705a5933 | 4088 | (forward-word (prefix-numeric-value arg)) |
cad113ae KG |
4089 | (point)) |
4090 | nil t)))) | |
2076c87c JB |
4091 | |
4092 | (defun kill-word (arg) | |
4093 | "Kill characters forward until encountering the end of a word. | |
4094 | With argument, do this that many times." | |
e761e42c | 4095 | (interactive "p") |
89ee2bf6 | 4096 | (kill-region (point) (progn (forward-word arg) (point)))) |
2076c87c JB |
4097 | |
4098 | (defun backward-kill-word (arg) | |
4099 | "Kill characters backward until encountering the end of a word. | |
4100 | With argument, do this that many times." | |
e761e42c | 4101 | (interactive "p") |
2076c87c | 4102 | (kill-word (- arg))) |
d7c64071 | 4103 | |
0f7df535 RS |
4104 | (defun current-word (&optional strict really-word) |
4105 | "Return the symbol or word that point is on (or a nearby one) as a string. | |
4106 | The return value includes no text properties. | |
1e8c5ac4 | 4107 | If optional arg STRICT is non-nil, return nil unless point is within |
0fa19a57 RS |
4108 | or adjacent to a symbol or word. In all cases the value can be nil |
4109 | if there is no word nearby. | |
0f7df535 RS |
4110 | The function, belying its name, normally finds a symbol. |
4111 | If optional arg REALLY-WORD is non-nil, it finds just a word." | |
d7c64071 | 4112 | (save-excursion |
0f7df535 | 4113 | (let* ((oldpoint (point)) (start (point)) (end (point)) |
81d17173 | 4114 | (syntaxes (if really-word "w" "w_")) |
0f7df535 RS |
4115 | (not-syntaxes (concat "^" syntaxes))) |
4116 | (skip-syntax-backward syntaxes) (setq start (point)) | |
d7c64071 | 4117 | (goto-char oldpoint) |
0f7df535 RS |
4118 | (skip-syntax-forward syntaxes) (setq end (point)) |
4119 | (when (and (eq start oldpoint) (eq end oldpoint) | |
4120 | ;; Point is neither within nor adjacent to a word. | |
4121 | (not strict)) | |
4122 | ;; Look for preceding word in same line. | |
4123 | (skip-syntax-backward not-syntaxes | |
4124 | (save-excursion (beginning-of-line) | |
4125 | (point))) | |
4126 | (if (bolp) | |
4127 | ;; No preceding word in same line. | |
4128 | ;; Look for following word in same line. | |
4129 | (progn | |
4130 | (skip-syntax-forward not-syntaxes | |
4131 | (save-excursion (end-of-line) | |
4132 | (point))) | |
4133 | (setq start (point)) | |
4134 | (skip-syntax-forward syntaxes) | |
4135 | (setq end (point))) | |
4136 | (setq end (point)) | |
4137 | (skip-syntax-backward syntaxes) | |
4138 | (setq start (point)))) | |
4139 | ;; If we found something nonempty, return it as a string. | |
4140 | (unless (= start end) | |
020db25f | 4141 | (buffer-substring-no-properties start end))))) |
2d88b556 | 4142 | \f |
69c1dd37 | 4143 | (defcustom fill-prefix nil |
e1e04350 | 4144 | "*String for filling to insert at front of new line, or nil for none." |
69c1dd37 RS |
4145 | :type '(choice (const :tag "None" nil) |
4146 | string) | |
4147 | :group 'fill) | |
2076c87c | 4148 | (make-variable-buffer-local 'fill-prefix) |
631c8020 | 4149 | ;;;###autoload(put 'fill-prefix 'safe-local-variable 'string-or-null-p) |
2076c87c | 4150 | |
69c1dd37 RS |
4151 | (defcustom auto-fill-inhibit-regexp nil |
4152 | "*Regexp to match lines which should not be auto-filled." | |
4153 | :type '(choice (const :tag "None" nil) | |
4154 | regexp) | |
4155 | :group 'fill) | |
2076c87c | 4156 | |
58dd38f1 | 4157 | (defvar comment-line-break-function 'comment-indent-new-line |
b3ac9fa9 RS |
4158 | "*Mode-specific function which line breaks and continues a comment. |
4159 | ||
4160 | This function is only called during auto-filling of a comment section. | |
4161 | The function should take a single optional argument, which is a flag | |
cc4cb0f5 | 4162 | indicating whether it should use soft newlines.") |
b3ac9fa9 | 4163 | |
dbe524b6 | 4164 | ;; This function is used as the auto-fill-function of a buffer |
e2504204 KH |
4165 | ;; when Auto-Fill mode is enabled. |
4166 | ;; It returns t if it really did any work. | |
dbe524b6 RS |
4167 | ;; (Actually some major modes use a different auto-fill function, |
4168 | ;; but this one is the default one.) | |
2076c87c | 4169 | (defun do-auto-fill () |
621a3f62 | 4170 | (let (fc justify give-up |
a0170800 | 4171 | (fill-prefix fill-prefix)) |
c18465c4 | 4172 | (if (or (not (setq justify (current-justification))) |
8f066a20 RS |
4173 | (null (setq fc (current-fill-column))) |
4174 | (and (eq justify 'left) | |
4175 | (<= (current-column) fc)) | |
621a3f62 SM |
4176 | (and auto-fill-inhibit-regexp |
4177 | (save-excursion (beginning-of-line) | |
eed5698b RS |
4178 | (looking-at auto-fill-inhibit-regexp)))) |
4179 | nil ;; Auto-filling not required | |
3db1e3b5 BG |
4180 | (if (memq justify '(full center right)) |
4181 | (save-excursion (unjustify-current-line))) | |
a0170800 RS |
4182 | |
4183 | ;; Choose a fill-prefix automatically. | |
e1e04350 SM |
4184 | (when (and adaptive-fill-mode |
4185 | (or (null fill-prefix) (string= fill-prefix ""))) | |
4186 | (let ((prefix | |
4187 | (fill-context-prefix | |
4188 | (save-excursion (backward-paragraph 1) (point)) | |
4189 | (save-excursion (forward-paragraph 1) (point))))) | |
4190 | (and prefix (not (equal prefix "")) | |
4191 | ;; Use auto-indentation rather than a guessed empty prefix. | |
0e53a373 | 4192 | (not (and fill-indent-according-to-mode |
d99f8496 | 4193 | (string-match "\\`[ \t]*\\'" prefix))) |
e1e04350 | 4194 | (setq fill-prefix prefix)))) |
f1180544 | 4195 | |
eed5698b | 4196 | (while (and (not give-up) (> (current-column) fc)) |
e47d38f6 | 4197 | ;; Determine where to split the line. |
db893d00 RS |
4198 | (let* (after-prefix |
4199 | (fill-point | |
621a3f62 SM |
4200 | (save-excursion |
4201 | (beginning-of-line) | |
4202 | (setq after-prefix (point)) | |
4203 | (and fill-prefix | |
4204 | (looking-at (regexp-quote fill-prefix)) | |
4205 | (setq after-prefix (match-end 0))) | |
4206 | (move-to-column (1+ fc)) | |
4207 | (fill-move-to-break-point after-prefix) | |
4208 | (point)))) | |
db893d00 RS |
4209 | |
4210 | ;; See whether the place we found is any good. | |
e47d38f6 RS |
4211 | (if (save-excursion |
4212 | (goto-char fill-point) | |
41d22ee0 SM |
4213 | (or (bolp) |
4214 | ;; There is no use breaking at end of line. | |
4215 | (save-excursion (skip-chars-forward " ") (eolp)) | |
4216 | ;; It is futile to split at the end of the prefix | |
4217 | ;; since we would just insert the prefix again. | |
4218 | (and after-prefix (<= (point) after-prefix)) | |
4219 | ;; Don't split right after a comment starter | |
4220 | ;; since we would just make another comment starter. | |
4221 | (and comment-start-skip | |
4222 | (let ((limit (point))) | |
4223 | (beginning-of-line) | |
4224 | (and (re-search-forward comment-start-skip | |
4225 | limit t) | |
4226 | (eq (point) limit)))))) | |
4227 | ;; No good place to break => stop trying. | |
4228 | (setq give-up t) | |
4229 | ;; Ok, we have a useful place to break the line. Do it. | |
4230 | (let ((prev-column (current-column))) | |
4231 | ;; If point is at the fill-point, do not `save-excursion'. | |
4232 | ;; Otherwise, if a comment prefix or fill-prefix is inserted, | |
4233 | ;; point will end up before it rather than after it. | |
4234 | (if (save-excursion | |
4235 | (skip-chars-backward " \t") | |
4236 | (= (point) fill-point)) | |
4237 | (funcall comment-line-break-function t) | |
4238 | (save-excursion | |
4239 | (goto-char fill-point) | |
4240 | (funcall comment-line-break-function t))) | |
4241 | ;; Now do justification, if required | |
4242 | (if (not (eq justify 'left)) | |
e47d38f6 | 4243 | (save-excursion |
e1e04350 SM |
4244 | (end-of-line 0) |
4245 | (justify-current-line justify nil t))) | |
41d22ee0 SM |
4246 | ;; If making the new line didn't reduce the hpos of |
4247 | ;; the end of the line, then give up now; | |
4248 | ;; trying again will not help. | |
4249 | (if (>= (current-column) prev-column) | |
4250 | (setq give-up t)))))) | |
24ebf92e | 4251 | ;; Justify last line. |
e2504204 | 4252 | (justify-current-line justify t t) |
1e722f9f | 4253 | t))) |
2076c87c | 4254 | |
24ebf92e RS |
4255 | (defvar normal-auto-fill-function 'do-auto-fill |
4256 | "The function to use for `auto-fill-function' if Auto Fill mode is turned on. | |
4257 | Some major modes set this.") | |
4258 | ||
c75505b4 | 4259 | (put 'auto-fill-function :minor-mode-function 'auto-fill-mode) |
d99f8496 SM |
4260 | ;; FIXME: turn into a proper minor mode. |
4261 | ;; Add a global minor mode version of it. | |
d7465b15 | 4262 | (defun auto-fill-mode (&optional arg) |
24ebf92e RS |
4263 | "Toggle Auto Fill mode. |
4264 | With arg, turn Auto Fill mode on if and only if arg is positive. | |
4265 | In Auto Fill mode, inserting a space at a column beyond `current-fill-column' | |
4266 | automatically breaks the line at a previous space. | |
4267 | ||
4268 | The value of `normal-auto-fill-function' specifies the function to use | |
4269 | for `auto-fill-function' when turning Auto Fill mode on." | |
d7465b15 RS |
4270 | (interactive "P") |
4271 | (prog1 (setq auto-fill-function | |
4272 | (if (if (null arg) | |
4273 | (not auto-fill-function) | |
4274 | (> (prefix-numeric-value arg) 0)) | |
24ebf92e | 4275 | normal-auto-fill-function |
d7465b15 | 4276 | nil)) |
7911ecc8 | 4277 | (force-mode-line-update))) |
d7465b15 RS |
4278 | |
4279 | ;; This holds a document string used to document auto-fill-mode. | |
4280 | (defun auto-fill-function () | |
4281 | "Automatically break line at a previous space, in insertion of text." | |
4282 | nil) | |
4283 | ||
4284 | (defun turn-on-auto-fill () | |
4285 | "Unconditionally turn on Auto Fill mode." | |
4286 | (auto-fill-mode 1)) | |
3a99c819 GM |
4287 | |
4288 | (defun turn-off-auto-fill () | |
4289 | "Unconditionally turn off Auto Fill mode." | |
4290 | (auto-fill-mode -1)) | |
4291 | ||
7cbf1dc1 | 4292 | (custom-add-option 'text-mode-hook 'turn-on-auto-fill) |
d7465b15 RS |
4293 | |
4294 | (defun set-fill-column (arg) | |
4cc0ea11 | 4295 | "Set `fill-column' to specified argument. |
923efb99 | 4296 | Use \\[universal-argument] followed by a number to specify a column. |
4cc0ea11 | 4297 | Just \\[universal-argument] as argument means to use the current column." |
d7465b15 | 4298 | (interactive "P") |
f4520363 RS |
4299 | (if (consp arg) |
4300 | (setq arg (current-column))) | |
4301 | (if (not (integerp arg)) | |
4302 | ;; Disallow missing argument; it's probably a typo for C-x C-f. | |
f33321ad | 4303 | (error "set-fill-column requires an explicit argument") |
f4520363 RS |
4304 | (message "Fill column set to %d (was %d)" arg fill-column) |
4305 | (setq fill-column arg))) | |
2d88b556 | 4306 | \f |
2076c87c | 4307 | (defun set-selective-display (arg) |
ff1fbe3e RS |
4308 | "Set `selective-display' to ARG; clear it if no arg. |
4309 | When the value of `selective-display' is a number > 0, | |
4310 | lines whose indentation is >= that value are not displayed. | |
4311 | The variable `selective-display' has a separate value for each buffer." | |
2076c87c JB |
4312 | (interactive "P") |
4313 | (if (eq selective-display t) | |
4314 | (error "selective-display already in use for marked lines")) | |
c88ab9ce ER |
4315 | (let ((current-vpos |
4316 | (save-restriction | |
4317 | (narrow-to-region (point-min) (point)) | |
4318 | (goto-char (window-start)) | |
4319 | (vertical-motion (window-height))))) | |
4320 | (setq selective-display | |
4321 | (and arg (prefix-numeric-value arg))) | |
4322 | (recenter current-vpos)) | |
2076c87c JB |
4323 | (set-window-start (selected-window) (window-start (selected-window))) |
4324 | (princ "selective-display set to " t) | |
4325 | (prin1 selective-display t) | |
4326 | (princ "." t)) | |
4327 | ||
40a64816 RS |
4328 | (defvaralias 'indicate-unused-lines 'indicate-empty-lines) |
4329 | (defvaralias 'default-indicate-unused-lines 'default-indicate-empty-lines) | |
4330 | ||
b3228584 | 4331 | (defun toggle-truncate-lines (&optional arg) |
215f50ce | 4332 | "Toggle whether to fold or truncate long lines for the current buffer. |
46cdfe8f RS |
4333 | With arg, truncate long lines iff arg is positive. |
4334 | Note that in side-by-side windows, truncation is always enabled." | |
0bb64d76 PA |
4335 | (interactive "P") |
4336 | (setq truncate-lines | |
4337 | (if (null arg) | |
4338 | (not truncate-lines) | |
46cdfe8f RS |
4339 | (> (prefix-numeric-value arg) 0))) |
4340 | (force-mode-line-update) | |
4f017185 RS |
4341 | (unless truncate-lines |
4342 | (let ((buffer (current-buffer))) | |
4343 | (walk-windows (lambda (window) | |
4344 | (if (eq buffer (window-buffer window)) | |
4345 | (set-window-hscroll window 0))) | |
4346 | nil t))) | |
46cdfe8f RS |
4347 | (message "Truncate long lines %s" |
4348 | (if truncate-lines "enabled" "disabled"))) | |
0bb64d76 | 4349 | |
4f8f7f9f | 4350 | (defvar overwrite-mode-textual " Ovwrt" |
b6a22db0 | 4351 | "The string displayed in the mode line when in overwrite mode.") |
4f8f7f9f | 4352 | (defvar overwrite-mode-binary " Bin Ovwrt" |
b6a22db0 JB |
4353 | "The string displayed in the mode line when in binary overwrite mode.") |
4354 | ||
2076c87c JB |
4355 | (defun overwrite-mode (arg) |
4356 | "Toggle overwrite mode. | |
4357 | With arg, turn overwrite mode on iff arg is positive. | |
4358 | In overwrite mode, printing characters typed in replace existing text | |
b6a22db0 JB |
4359 | on a one-for-one basis, rather than pushing it to the right. At the |
4360 | end of a line, such characters extend the line. Before a tab, | |
4361 | such characters insert until the tab is filled in. | |
4362 | \\[quoted-insert] still inserts characters in overwrite mode; this | |
4363 | is supposed to make it easier to insert characters when necessary." | |
4364 | (interactive "P") | |
4365 | (setq overwrite-mode | |
4366 | (if (if (null arg) (not overwrite-mode) | |
4367 | (> (prefix-numeric-value arg) 0)) | |
4368 | 'overwrite-mode-textual)) | |
4369 | (force-mode-line-update)) | |
4370 | ||
4371 | (defun binary-overwrite-mode (arg) | |
4372 | "Toggle binary overwrite mode. | |
4373 | With arg, turn binary overwrite mode on iff arg is positive. | |
4374 | In binary overwrite mode, printing characters typed in replace | |
4375 | existing text. Newlines are not treated specially, so typing at the | |
4376 | end of a line joins the line to the next, with the typed character | |
4377 | between them. Typing before a tab character simply replaces the tab | |
4378 | with the character typed. | |
4379 | \\[quoted-insert] replaces the text at the cursor, just as ordinary | |
4380 | typing characters do. | |
4381 | ||
4382 | Note that binary overwrite mode is not its own minor mode; it is a | |
f33321ad | 4383 | specialization of overwrite mode, entered by setting the |
b6a22db0 | 4384 | `overwrite-mode' variable to `overwrite-mode-binary'." |
2076c87c JB |
4385 | (interactive "P") |
4386 | (setq overwrite-mode | |
b6a22db0 | 4387 | (if (if (null arg) |
a61099dd | 4388 | (not (eq overwrite-mode 'overwrite-mode-binary)) |
b6a22db0 JB |
4389 | (> (prefix-numeric-value arg) 0)) |
4390 | 'overwrite-mode-binary)) | |
4391 | (force-mode-line-update)) | |
eaae8106 | 4392 | |
6710df48 | 4393 | (define-minor-mode line-number-mode |
a61099dd RS |
4394 | "Toggle Line Number mode. |
4395 | With arg, turn Line Number mode on iff arg is positive. | |
4396 | When Line Number mode is enabled, the line number appears | |
8dc9e2ef KH |
4397 | in the mode line. |
4398 | ||
32f2f98e EZ |
4399 | Line numbers do not appear for very large buffers and buffers |
4400 | with very long lines; see variables `line-number-display-limit' | |
4401 | and `line-number-display-limit-width'." | |
efeb22bf | 4402 | :init-value t :global t :group 'mode-line) |
bcad4985 | 4403 | |
6710df48 | 4404 | (define-minor-mode column-number-mode |
bcad4985 KH |
4405 | "Toggle Column Number mode. |
4406 | With arg, turn Column Number mode on iff arg is positive. | |
4407 | When Column Number mode is enabled, the column number appears | |
4408 | in the mode line." | |
efeb22bf | 4409 | :global t :group 'mode-line) |
cf045f9a LK |
4410 | |
4411 | (define-minor-mode size-indication-mode | |
4412 | "Toggle Size Indication mode. | |
4413 | With arg, turn Size Indication mode on iff arg is positive. When | |
4414 | Size Indication mode is enabled, the size of the accessible part | |
4415 | of the buffer appears in the mode line." | |
efeb22bf | 4416 | :global t :group 'mode-line) |
2d88b556 | 4417 | \f |
4b384a8f | 4418 | (defgroup paren-blinking nil |
020db25f | 4419 | "Blinking matching of parens and expressions." |
4b384a8f SM |
4420 | :prefix "blink-matching-" |
4421 | :group 'paren-matching) | |
4422 | ||
69c1dd37 RS |
4423 | (defcustom blink-matching-paren t |
4424 | "*Non-nil means show matching open-paren when close-paren is inserted." | |
4425 | :type 'boolean | |
4b384a8f | 4426 | :group 'paren-blinking) |
2076c87c | 4427 | |
69c1dd37 | 4428 | (defcustom blink-matching-paren-on-screen t |
29fc44dd | 4429 | "*Non-nil means show matching open-paren when it is on screen. |
4b384a8f | 4430 | If nil, means don't show it (but the open-paren can still be shown |
92aa8a33 LT |
4431 | when it is off screen). |
4432 | ||
9cb370a9 | 4433 | This variable has no effect if `blink-matching-paren' is nil. |
a9f72e5f | 4434 | \(In that case, the open-paren is never shown.) |
9cb370a9 | 4435 | It is also ignored if `show-paren-mode' is enabled." |
69c1dd37 | 4436 | :type 'boolean |
4b384a8f | 4437 | :group 'paren-blinking) |
29fc44dd | 4438 | |
4b384a8f | 4439 | (defcustom blink-matching-paren-distance (* 25 1024) |
66d44a36 EZ |
4440 | "*If non-nil, maximum distance to search backwards for matching open-paren. |
4441 | If nil, search stops at the beginning of the accessible portion of the buffer." | |
4442 | :type '(choice (const nil) integer) | |
4b384a8f | 4443 | :group 'paren-blinking) |
2076c87c | 4444 | |
69c1dd37 | 4445 | (defcustom blink-matching-delay 1 |
4b384a8f SM |
4446 | "*Time in seconds to delay after showing a matching paren." |
4447 | :type 'number | |
4448 | :group 'paren-blinking) | |
72dddf8b | 4449 | |
69c1dd37 | 4450 | (defcustom blink-matching-paren-dont-ignore-comments nil |
ab6b3b16 RS |
4451 | "*nil means `blink-matching-paren' ignores comments. |
4452 | More precisely, when looking for the matching parenthesis, | |
4453 | it skips the contents of comments that end before point." | |
69c1dd37 | 4454 | :type 'boolean |
4b384a8f | 4455 | :group 'paren-blinking) |
903b7f65 | 4456 | |
2076c87c JB |
4457 | (defun blink-matching-open () |
4458 | "Move cursor momentarily to the beginning of the sexp before point." | |
4459 | (interactive) | |
c448d316 | 4460 | (when (and (> (point) (point-min)) |
1d0e3fc8 RS |
4461 | blink-matching-paren |
4462 | ;; Verify an even number of quoting characters precede the close. | |
4463 | (= 1 (logand 1 (- (point) | |
4464 | (save-excursion | |
4465 | (forward-char -1) | |
4466 | (skip-syntax-backward "/\\") | |
4467 | (point)))))) | |
4468 | (let* ((oldpos (point)) | |
4469 | blinkpos | |
4470 | message-log-max ; Don't log messages about paren matching. | |
4471 | matching-paren | |
4472 | open-paren-line-string) | |
4473 | (save-excursion | |
4474 | (save-restriction | |
4475 | (if blink-matching-paren-distance | |
4476 | (narrow-to-region (max (point-min) | |
4477 | (- (point) blink-matching-paren-distance)) | |
4478 | oldpos)) | |
4479 | (condition-case () | |
4480 | (let ((parse-sexp-ignore-comments | |
4481 | (and parse-sexp-ignore-comments | |
4482 | (not blink-matching-paren-dont-ignore-comments)))) | |
4483 | (setq blinkpos (scan-sexps oldpos -1))) | |
4484 | (error nil))) | |
4485 | (and blinkpos | |
4486 | ;; Not syntax '$'. | |
4487 | (not (eq (syntax-class (syntax-after blinkpos)) 8)) | |
4488 | (setq matching-paren | |
4489 | (let ((syntax (syntax-after blinkpos))) | |
4490 | (and (consp syntax) | |
4491 | (eq (syntax-class syntax) 4) | |
4492 | (cdr syntax))))) | |
4493 | (cond | |
1c4b7278 SM |
4494 | ((not (or (eq matching-paren (char-before oldpos)) |
4495 | ;; The cdr might hold a new paren-class info rather than | |
4496 | ;; a matching-char info, in which case the two CDRs | |
4497 | ;; should match. | |
9c03d478 | 4498 | (eq matching-paren (cdr (syntax-after (1- oldpos)))))) |
1d0e3fc8 RS |
4499 | (message "Mismatched parentheses")) |
4500 | ((not blinkpos) | |
4501 | (if (not blink-matching-paren-distance) | |
4502 | (message "Unmatched parenthesis"))) | |
4503 | ((pos-visible-in-window-p blinkpos) | |
4504 | ;; Matching open within window, temporarily move to blinkpos but only | |
4505 | ;; if `blink-matching-paren-on-screen' is non-nil. | |
92aa8a33 LT |
4506 | (and blink-matching-paren-on-screen |
4507 | (not show-paren-mode) | |
4508 | (save-excursion | |
4509 | (goto-char blinkpos) | |
4510 | (sit-for blink-matching-delay)))) | |
1d0e3fc8 RS |
4511 | (t |
4512 | (save-excursion | |
4513 | (goto-char blinkpos) | |
4514 | (setq open-paren-line-string | |
4515 | ;; Show what precedes the open in its line, if anything. | |
4516 | (if (save-excursion | |
4517 | (skip-chars-backward " \t") | |
4518 | (not (bolp))) | |
4519 | (buffer-substring (line-beginning-position) | |
4520 | (1+ blinkpos)) | |
4521 | ;; Show what follows the open in its line, if anything. | |
4522 | (if (save-excursion | |
4523 | (forward-char 1) | |
4524 | (skip-chars-forward " \t") | |
4525 | (not (eolp))) | |
4526 | (buffer-substring blinkpos | |
4527 | (line-end-position)) | |
4528 | ;; Otherwise show the previous nonblank line, | |
4529 | ;; if there is one. | |
4530 | (if (save-excursion | |
4531 | (skip-chars-backward "\n \t") | |
4532 | (not (bobp))) | |
4533 | (concat | |
4534 | (buffer-substring (progn | |
267935b9 | 4535 | (skip-chars-backward "\n \t") |
1d0e3fc8 RS |
4536 | (line-beginning-position)) |
4537 | (progn (end-of-line) | |
4538 | (skip-chars-backward " \t") | |
4539 | (point))) | |
4540 | ;; Replace the newline and other whitespace with `...'. | |
4541 | "..." | |
4542 | (buffer-substring blinkpos (1+ blinkpos))) | |
4543 | ;; There is nothing to show except the char itself. | |
4544 | (buffer-substring blinkpos (1+ blinkpos))))))) | |
4545 | (message "Matches %s" | |
4546 | (substring-no-properties open-paren-line-string)))))))) | |
2076c87c JB |
4547 | |
4548 | ;Turned off because it makes dbx bomb out. | |
4549 | (setq blink-paren-function 'blink-matching-open) | |
2d88b556 | 4550 | \f |
9a1277dd RS |
4551 | ;; This executes C-g typed while Emacs is waiting for a command. |
4552 | ;; Quitting out of a program does not go through here; | |
4553 | ;; that happens in the QUIT macro at the C code level. | |
2076c87c | 4554 | (defun keyboard-quit () |
d5dae4e1 | 4555 | "Signal a `quit' condition. |
af39530e RS |
4556 | During execution of Lisp code, this character causes a quit directly. |
4557 | At top-level, as an editor command, this simply beeps." | |
2076c87c | 4558 | (interactive) |
19d35374 | 4559 | (deactivate-mark) |
8a7644e9 KS |
4560 | (if (fboundp 'kmacro-keyboard-quit) |
4561 | (kmacro-keyboard-quit)) | |
f5e13057 | 4562 | (setq defining-kbd-macro nil) |
2076c87c JB |
4563 | (signal 'quit nil)) |
4564 | ||
1c6c6fde RS |
4565 | (defvar buffer-quit-function nil |
4566 | "Function to call to \"quit\" the current buffer, or nil if none. | |
4567 | \\[keyboard-escape-quit] calls this function when its more local actions | |
4568 | \(such as cancelling a prefix argument, minibuffer or region) do not apply.") | |
4569 | ||
c66587fe RS |
4570 | (defun keyboard-escape-quit () |
4571 | "Exit the current \"mode\" (in a generalized sense of the word). | |
4572 | This command can exit an interactive command such as `query-replace', | |
4573 | can clear out a prefix argument or a region, | |
4574 | can get out of the minibuffer or other recursive edit, | |
1c6c6fde RS |
4575 | cancel the use of the current buffer (for special-purpose buffers), |
4576 | or go back to just one window (by deleting all but the selected window)." | |
c66587fe RS |
4577 | (interactive) |
4578 | (cond ((eq last-command 'mode-exited) nil) | |
4579 | ((> (minibuffer-depth) 0) | |
4580 | (abort-recursive-edit)) | |
4581 | (current-prefix-arg | |
4582 | nil) | |
705a5933 | 4583 | ((and transient-mark-mode mark-active) |
c66587fe | 4584 | (deactivate-mark)) |
1b657835 RS |
4585 | ((> (recursion-depth) 0) |
4586 | (exit-recursive-edit)) | |
1c6c6fde RS |
4587 | (buffer-quit-function |
4588 | (funcall buffer-quit-function)) | |
c66587fe | 4589 | ((not (one-window-p t)) |
1b657835 RS |
4590 | (delete-other-windows)) |
4591 | ((string-match "^ \\*" (buffer-name (current-buffer))) | |
4592 | (bury-buffer)))) | |
c66587fe | 4593 | |
2d88b556 RS |
4594 | (defun play-sound-file (file &optional volume device) |
4595 | "Play sound stored in FILE. | |
4596 | VOLUME and DEVICE correspond to the keywords of the sound | |
4597 | specification for `play-sound'." | |
4598 | (interactive "fPlay sound file: ") | |
4599 | (let ((sound (list :file file))) | |
4600 | (if volume | |
4601 | (plist-put sound :volume volume)) | |
4602 | (if device | |
4603 | (plist-put sound :device device)) | |
4604 | (push 'sound sound) | |
4605 | (play-sound sound))) | |
4606 | ||
56abefac | 4607 | \f |
7683b5c2 DL |
4608 | (defcustom read-mail-command 'rmail |
4609 | "*Your preference for a mail reading package. | |
9023837e DL |
4610 | This is used by some keybindings which support reading mail. |
4611 | See also `mail-user-agent' concerning sending mail." | |
7683b5c2 DL |
4612 | :type '(choice (function-item rmail) |
4613 | (function-item gnus) | |
4614 | (function-item mh-rmail) | |
4615 | (function :tag "Other")) | |
4616 | :version "21.1" | |
4617 | :group 'mail) | |
4618 | ||
69c1dd37 | 4619 | (defcustom mail-user-agent 'sendmail-user-agent |
a31ca314 | 4620 | "*Your preference for a mail composition package. |
9023837e | 4621 | Various Emacs Lisp packages (e.g. Reporter) require you to compose an |
a31ca314 RS |
4622 | outgoing email message. This variable lets you specify which |
4623 | mail-sending package you prefer. | |
4624 | ||
4625 | Valid values include: | |
4626 | ||
9023837e DL |
4627 | `sendmail-user-agent' -- use the default Emacs Mail package. |
4628 | See Info node `(emacs)Sending Mail'. | |
4629 | `mh-e-user-agent' -- use the Emacs interface to the MH mail system. | |
4630 | See Info node `(mh-e)'. | |
4631 | `message-user-agent' -- use the Gnus Message package. | |
4632 | See Info node `(message)'. | |
4633 | `gnus-user-agent' -- like `message-user-agent', but with Gnus | |
4634 | paraphernalia, particularly the Gcc: header for | |
4635 | archiving. | |
a31ca314 RS |
4636 | |
4637 | Additional valid symbols may be available; check with the author of | |
15d0c9b1 DL |
4638 | your package for details. The function should return non-nil if it |
4639 | succeeds. | |
9023837e DL |
4640 | |
4641 | See also `read-mail-command' concerning reading mail." | |
69c1dd37 RS |
4642 | :type '(radio (function-item :tag "Default Emacs mail" |
4643 | :format "%t\n" | |
4644 | sendmail-user-agent) | |
4645 | (function-item :tag "Emacs interface to MH" | |
4646 | :format "%t\n" | |
4647 | mh-e-user-agent) | |
9023837e | 4648 | (function-item :tag "Gnus Message package" |
69c1dd37 RS |
4649 | :format "%t\n" |
4650 | message-user-agent) | |
9023837e DL |
4651 | (function-item :tag "Gnus Message with full Gnus features" |
4652 | :format "%t\n" | |
4653 | gnus-user-agent) | |
69c1dd37 RS |
4654 | (function :tag "Other")) |
4655 | :group 'mail) | |
a31ca314 | 4656 | |
a31ca314 | 4657 | (define-mail-user-agent 'sendmail-user-agent |
34fbcdf3 | 4658 | 'sendmail-user-agent-compose |
a31ca314 RS |
4659 | 'mail-send-and-exit) |
4660 | ||
360b5483 RS |
4661 | (defun rfc822-goto-eoh () |
4662 | ;; Go to header delimiter line in a mail message, following RFC822 rules | |
4663 | (goto-char (point-min)) | |
e1e04350 SM |
4664 | (when (re-search-forward |
4665 | "^\\([:\n]\\|[^: \t\n]+[ \t\n]\\)" nil 'move) | |
4666 | (goto-char (match-beginning 0)))) | |
360b5483 | 4667 | |
34fbcdf3 RS |
4668 | (defun sendmail-user-agent-compose (&optional to subject other-headers continue |
4669 | switch-function yank-action | |
4670 | send-actions) | |
4671 | (if switch-function | |
4672 | (let ((special-display-buffer-names nil) | |
4673 | (special-display-regexps nil) | |
4674 | (same-window-buffer-names nil) | |
4675 | (same-window-regexps nil)) | |
4676 | (funcall switch-function "*mail*"))) | |
9462bf2c RS |
4677 | (let ((cc (cdr (assoc-string "cc" other-headers t))) |
4678 | (in-reply-to (cdr (assoc-string "in-reply-to" other-headers t))) | |
4679 | (body (cdr (assoc-string "body" other-headers t)))) | |
a9267c2c CY |
4680 | (or (mail continue to subject in-reply-to cc yank-action send-actions) |
4681 | continue | |
4682 | (error "Message aborted")) | |
34fbcdf3 | 4683 | (save-excursion |
360b5483 | 4684 | (rfc822-goto-eoh) |
34fbcdf3 | 4685 | (while other-headers |
0740c738 GM |
4686 | (unless (member-ignore-case (car (car other-headers)) |
4687 | '("in-reply-to" "cc" "body")) | |
34fbcdf3 | 4688 | (insert (car (car other-headers)) ": " |
15575807 CY |
4689 | (cdr (car other-headers)) |
4690 | (if use-hard-newlines hard-newline "\n"))) | |
34fbcdf3 | 4691 | (setq other-headers (cdr other-headers))) |
0740c738 GM |
4692 | (when body |
4693 | (forward-line 1) | |
4694 | (insert body)) | |
34fbcdf3 RS |
4695 | t))) |
4696 | ||
d0008a00 RS |
4697 | (defun compose-mail (&optional to subject other-headers continue |
4698 | switch-function yank-action send-actions) | |
4699 | "Start composing a mail message to send. | |
4700 | This uses the user's chosen mail composition package | |
4701 | as selected with the variable `mail-user-agent'. | |
4702 | The optional arguments TO and SUBJECT specify recipients | |
4703 | and the initial Subject field, respectively. | |
4704 | ||
4705 | OTHER-HEADERS is an alist specifying additional | |
4706 | header fields. Elements look like (HEADER . VALUE) where both | |
4707 | HEADER and VALUE are strings. | |
4708 | ||
4709 | CONTINUE, if non-nil, says to continue editing a message already | |
4710 | being composed. | |
4711 | ||
4712 | SWITCH-FUNCTION, if non-nil, is a function to use to | |
4713 | switch to and display the buffer used for mail composition. | |
4714 | ||
4715 | YANK-ACTION, if non-nil, is an action to perform, if and when necessary, | |
06720de2 RS |
4716 | to insert the raw text of the message being replied to. |
4717 | It has the form (FUNCTION . ARGS). The user agent will apply | |
4718 | FUNCTION to ARGS, to insert the raw text of the original message. | |
4719 | \(The user agent will also run `mail-citation-hook', *after* the | |
4720 | original text has been inserted in this way.) | |
d0008a00 RS |
4721 | |
4722 | SEND-ACTIONS is a list of actions to call when the message is sent. | |
4723 | Each action has the form (FUNCTION . ARGS)." | |
b5f019be RS |
4724 | (interactive |
4725 | (list nil nil nil current-prefix-arg)) | |
d0008a00 RS |
4726 | (let ((function (get mail-user-agent 'composefunc))) |
4727 | (funcall function to subject other-headers continue | |
4728 | switch-function yank-action send-actions))) | |
b5f019be RS |
4729 | |
4730 | (defun compose-mail-other-window (&optional to subject other-headers continue | |
4731 | yank-action send-actions) | |
4732 | "Like \\[compose-mail], but edit the outgoing message in another window." | |
4733 | (interactive | |
4734 | (list nil nil nil current-prefix-arg)) | |
4735 | (compose-mail to subject other-headers continue | |
4736 | 'switch-to-buffer-other-window yank-action send-actions)) | |
4737 | ||
4738 | ||
4739 | (defun compose-mail-other-frame (&optional to subject other-headers continue | |
4740 | yank-action send-actions) | |
4741 | "Like \\[compose-mail], but edit the outgoing message in another frame." | |
4742 | (interactive | |
4743 | (list nil nil nil current-prefix-arg)) | |
4744 | (compose-mail to subject other-headers continue | |
4745 | 'switch-to-buffer-other-frame yank-action send-actions)) | |
56abefac | 4746 | \f |
610c1c68 RS |
4747 | (defvar set-variable-value-history nil |
4748 | "History of values entered with `set-variable'.") | |
4749 | ||
d6281b4e | 4750 | (defun set-variable (variable value &optional make-local) |
610c1c68 | 4751 | "Set VARIABLE to VALUE. VALUE is a Lisp object. |
d6281b4e RS |
4752 | VARIABLE should be a user option variable name, a Lisp variable |
4753 | meant to be customized by users. You should enter VALUE in Lisp syntax, | |
4754 | so if you want VALUE to be a string, you must surround it with doublequotes. | |
610c1c68 RS |
4755 | VALUE is used literally, not evaluated. |
4756 | ||
4757 | If VARIABLE has a `variable-interactive' property, that is used as if | |
4758 | it were the arg to `interactive' (which see) to interactively read VALUE. | |
4759 | ||
4760 | If VARIABLE has been defined with `defcustom', then the type information | |
16236388 RS |
4761 | in the definition is used to check that VALUE is valid. |
4762 | ||
4763 | With a prefix argument, set VARIABLE to VALUE buffer-locally." | |
e9dfb72e RS |
4764 | (interactive |
4765 | (let* ((default-var (variable-at-point)) | |
7fd0ef0d JL |
4766 | (var (if (user-variable-p default-var) |
4767 | (read-variable (format "Set variable (default %s): " default-var) | |
4768 | default-var) | |
4769 | (read-variable "Set variable: "))) | |
7dcd2d16 AS |
4770 | (minibuffer-help-form '(describe-variable var)) |
4771 | (prop (get var 'variable-interactive)) | |
0684376b JB |
4772 | (obsolete (car (get var 'byte-obsolete-variable))) |
4773 | (prompt (format "Set %s %s to value: " var | |
7dcd2d16 | 4774 | (cond ((local-variable-p var) |
0684376b | 4775 | "(buffer-local)") |
7dcd2d16 AS |
4776 | ((or current-prefix-arg |
4777 | (local-variable-if-set-p var)) | |
0684376b JB |
4778 | "buffer-locally") |
4779 | (t "globally")))) | |
4780 | (val (progn | |
4781 | (when obsolete | |
4782 | (message (concat "`%S' is obsolete; " | |
4783 | (if (symbolp obsolete) "use `%S' instead" "%s")) | |
4784 | var obsolete) | |
4785 | (sit-for 3)) | |
4786 | (if prop | |
4787 | ;; Use VAR's `variable-interactive' property | |
4788 | ;; as an interactive spec for prompting. | |
4789 | (call-interactively `(lambda (arg) | |
4790 | (interactive ,prop) | |
4791 | arg)) | |
4792 | (read | |
4793 | (read-string prompt nil | |
7fd0ef0d JL |
4794 | 'set-variable-value-history |
4795 | (format "%S" (symbol-value var)))))))) | |
7dcd2d16 | 4796 | (list var val current-prefix-arg))) |
610c1c68 | 4797 | |
d6281b4e RS |
4798 | (and (custom-variable-p variable) |
4799 | (not (get variable 'custom-type)) | |
4800 | (custom-load-symbol variable)) | |
4801 | (let ((type (get variable 'custom-type))) | |
610c1c68 RS |
4802 | (when type |
4803 | ;; Match with custom type. | |
36755dd9 | 4804 | (require 'cus-edit) |
610c1c68 | 4805 | (setq type (widget-convert type)) |
d6281b4e | 4806 | (unless (widget-apply type :match value) |
1e722f9f | 4807 | (error "Value `%S' does not match type %S of %S" |
d6281b4e | 4808 | value (car type) variable)))) |
16236388 RS |
4809 | |
4810 | (if make-local | |
d6281b4e | 4811 | (make-local-variable variable)) |
f1180544 | 4812 | |
d6281b4e | 4813 | (set variable value) |
a2aef080 GM |
4814 | |
4815 | ;; Force a thorough redisplay for the case that the variable | |
4816 | ;; has an effect on the display, like `tab-width' has. | |
4817 | (force-mode-line-update)) | |
56abefac | 4818 | \f |
e8a700bf RS |
4819 | ;; Define the major mode for lists of completions. |
4820 | ||
98b45886 RS |
4821 | (defvar completion-list-mode-map nil |
4822 | "Local map for completion list buffers.") | |
ac29eb79 | 4823 | (or completion-list-mode-map |
e8a700bf RS |
4824 | (let ((map (make-sparse-keymap))) |
4825 | (define-key map [mouse-2] 'mouse-choose-completion) | |
771069f8 | 4826 | (define-key map [follow-link] 'mouse-face) |
eaf76065 | 4827 | (define-key map [down-mouse-2] nil) |
80298193 | 4828 | (define-key map "\C-m" 'choose-completion) |
1c6c6fde | 4829 | (define-key map "\e\e\e" 'delete-completion-window) |
dde69dbe RS |
4830 | (define-key map [left] 'previous-completion) |
4831 | (define-key map [right] 'next-completion) | |
ac29eb79 | 4832 | (setq completion-list-mode-map map))) |
e8a700bf RS |
4833 | |
4834 | ;; Completion mode is suitable only for specially formatted data. | |
ac29eb79 | 4835 | (put 'completion-list-mode 'mode-class 'special) |
e8a700bf | 4836 | |
98b45886 RS |
4837 | (defvar completion-reference-buffer nil |
4838 | "Record the buffer that was current when the completion list was requested. | |
4839 | This is a local variable in the completion list buffer. | |
ec39964e | 4840 | Initial value is nil to avoid some compiler warnings.") |
3819736b | 4841 | |
83434bda RS |
4842 | (defvar completion-no-auto-exit nil |
4843 | "Non-nil means `choose-completion-string' should never exit the minibuffer. | |
4844 | This also applies to other functions such as `choose-completion' | |
4845 | and `mouse-choose-completion'.") | |
4846 | ||
98b45886 RS |
4847 | (defvar completion-base-size nil |
4848 | "Number of chars at beginning of minibuffer not involved in completion. | |
4849 | This is a local variable in the completion list buffer | |
4850 | but it talks about the buffer in `completion-reference-buffer'. | |
4851 | If this is nil, it means to compare text to determine which part | |
4852 | of the tail end of the buffer's text is involved in completion.") | |
f6b293e3 | 4853 | |
1c6c6fde RS |
4854 | (defun delete-completion-window () |
4855 | "Delete the completion list window. | |
4856 | Go to the window from which completion was requested." | |
4857 | (interactive) | |
4858 | (let ((buf completion-reference-buffer)) | |
ddb2b181 RS |
4859 | (if (one-window-p t) |
4860 | (if (window-dedicated-p (selected-window)) | |
4861 | (delete-frame (selected-frame))) | |
4862 | (delete-window (selected-window)) | |
4863 | (if (get-buffer-window buf) | |
4864 | (select-window (get-buffer-window buf)))))) | |
1c6c6fde | 4865 | |
dde69dbe RS |
4866 | (defun previous-completion (n) |
4867 | "Move to the previous item in the completion list." | |
4868 | (interactive "p") | |
4869 | (next-completion (- n))) | |
4870 | ||
4871 | (defun next-completion (n) | |
4872 | "Move to the next item in the completion list. | |
1f238ac2 | 4873 | With prefix argument N, move N items (negative N means move backward)." |
dde69dbe | 4874 | (interactive "p") |
58dd38f1 SM |
4875 | (let ((beg (point-min)) (end (point-max))) |
4876 | (while (and (> n 0) (not (eobp))) | |
dde69dbe | 4877 | ;; If in a completion, move to the end of it. |
58dd38f1 SM |
4878 | (when (get-text-property (point) 'mouse-face) |
4879 | (goto-char (next-single-property-change (point) 'mouse-face nil end))) | |
dde69dbe | 4880 | ;; Move to start of next one. |
58dd38f1 SM |
4881 | (unless (get-text-property (point) 'mouse-face) |
4882 | (goto-char (next-single-property-change (point) 'mouse-face nil end))) | |
4883 | (setq n (1- n))) | |
4884 | (while (and (< n 0) (not (bobp))) | |
4885 | (let ((prop (get-text-property (1- (point)) 'mouse-face))) | |
4886 | ;; If in a completion, move to the start of it. | |
4887 | (when (and prop (eq prop (get-text-property (point) 'mouse-face))) | |
b61a81c2 | 4888 | (goto-char (previous-single-property-change |
58dd38f1 SM |
4889 | (point) 'mouse-face nil beg))) |
4890 | ;; Move to end of the previous completion. | |
4891 | (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face)) | |
4892 | (goto-char (previous-single-property-change | |
4893 | (point) 'mouse-face nil beg))) | |
4894 | ;; Move to the start of that one. | |
4895 | (goto-char (previous-single-property-change | |
4896 | (point) 'mouse-face nil beg)) | |
4897 | (setq n (1+ n)))))) | |
dde69dbe | 4898 | |
80298193 RS |
4899 | (defun choose-completion () |
4900 | "Choose the completion that point is in or next to." | |
4901 | (interactive) | |
f6b293e3 RS |
4902 | (let (beg end completion (buffer completion-reference-buffer) |
4903 | (base-size completion-base-size)) | |
6096f362 RS |
4904 | (if (and (not (eobp)) (get-text-property (point) 'mouse-face)) |
4905 | (setq end (point) beg (1+ (point)))) | |
4906 | (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face)) | |
3f299281 | 4907 | (setq end (1- (point)) beg (point))) |
6096f362 RS |
4908 | (if (null beg) |
4909 | (error "No completion here")) | |
4910 | (setq beg (previous-single-property-change beg 'mouse-face)) | |
88dd3c24 | 4911 | (setq end (or (next-single-property-change end 'mouse-face) (point-max))) |
6cdd0211 | 4912 | (setq completion (buffer-substring-no-properties beg end)) |
ab63960f RS |
4913 | (let ((owindow (selected-window))) |
4914 | (if (and (one-window-p t 'selected-frame) | |
4915 | (window-dedicated-p (selected-window))) | |
4916 | ;; This is a special buffer's frame | |
4917 | (iconify-frame (selected-frame)) | |
4918 | (or (window-dedicated-p (selected-window)) | |
4919 | (bury-buffer))) | |
4920 | (select-window owindow)) | |
f6b293e3 | 4921 | (choose-completion-string completion buffer base-size))) |
80298193 RS |
4922 | |
4923 | ;; Delete the longest partial match for STRING | |
4924 | ;; that can be found before POINT. | |
4925 | (defun choose-completion-delete-max-match (string) | |
4926 | (let ((opoint (point)) | |
f0bfada7 RS |
4927 | len) |
4928 | ;; Try moving back by the length of the string. | |
4929 | (goto-char (max (- (point) (length string)) | |
4930 | (minibuffer-prompt-end))) | |
4931 | ;; See how far back we were actually able to move. That is the | |
4932 | ;; upper bound on how much we can match and delete. | |
4933 | (setq len (- opoint (point))) | |
61bbf6fe RS |
4934 | (if completion-ignore-case |
4935 | (setq string (downcase string))) | |
80298193 | 4936 | (while (and (> len 0) |
f0bfada7 | 4937 | (let ((tail (buffer-substring (point) opoint))) |
61bbf6fe RS |
4938 | (if completion-ignore-case |
4939 | (setq tail (downcase tail))) | |
80298193 RS |
4940 | (not (string= tail (substring string 0 len))))) |
4941 | (setq len (1- len)) | |
4942 | (forward-char 1)) | |
4943 | (delete-char len))) | |
4944 | ||
ba36181b | 4945 | (defvar choose-completion-string-functions nil |
bbbbb15b KS |
4946 | "Functions that may override the normal insertion of a completion choice. |
4947 | These functions are called in order with four arguments: | |
4948 | CHOICE - the string to insert in the buffer, | |
4949 | BUFFER - the buffer in which the choice should be inserted, | |
89a6cfe3 | 4950 | MINI-P - non-nil iff BUFFER is a minibuffer, and |
12829a07 RS |
4951 | BASE-SIZE - the number of characters in BUFFER before |
4952 | the string being completed. | |
4953 | ||
bbbbb15b KS |
4954 | If a function in the list returns non-nil, that function is supposed |
4955 | to have inserted the CHOICE in the BUFFER, and possibly exited | |
12829a07 | 4956 | the minibuffer; no further functions will be called. |
ba36181b | 4957 | |
12829a07 RS |
4958 | If all functions in the list return nil, that means to use |
4959 | the default method of inserting the completion in BUFFER.") | |
74d0290b | 4960 | |
f6b293e3 | 4961 | (defun choose-completion-string (choice &optional buffer base-size) |
12829a07 RS |
4962 | "Switch to BUFFER and insert the completion choice CHOICE. |
4963 | BASE-SIZE, if non-nil, says how many characters of BUFFER's text | |
e36aeef9 RS |
4964 | to keep. If it is nil, we call `choose-completion-delete-max-match' |
4965 | to decide what to delete." | |
12829a07 RS |
4966 | |
4967 | ;; If BUFFER is the minibuffer, exit the minibuffer | |
4968 | ;; unless it is reading a file name and CHOICE is a directory, | |
4969 | ;; or completion-no-auto-exit is non-nil. | |
4970 | ||
1a0d0b6a JPW |
4971 | (let* ((buffer (or buffer completion-reference-buffer)) |
4972 | (mini-p (minibufferp buffer))) | |
cf52ad58 RS |
4973 | ;; If BUFFER is a minibuffer, barf unless it's the currently |
4974 | ;; active minibuffer. | |
f436a90a | 4975 | (if (and mini-p |
45486731 RS |
4976 | (or (not (active-minibuffer-window)) |
4977 | (not (equal buffer | |
4978 | (window-buffer (active-minibuffer-window)))))) | |
cf52ad58 | 4979 | (error "Minibuffer is not active for completion") |
17aa3385 KS |
4980 | ;; Set buffer so buffer-local choose-completion-string-functions works. |
4981 | (set-buffer buffer) | |
f1180544 | 4982 | (unless (run-hook-with-args-until-success |
d99f8496 SM |
4983 | 'choose-completion-string-functions |
4984 | choice buffer mini-p base-size) | |
4985 | ;; Insert the completion into the buffer where it was requested. | |
bbbbb15b KS |
4986 | (if base-size |
4987 | (delete-region (+ base-size (if mini-p | |
4988 | (minibuffer-prompt-end) | |
4989 | (point-min))) | |
4990 | (point)) | |
4991 | (choose-completion-delete-max-match choice)) | |
4992 | (insert choice) | |
4993 | (remove-text-properties (- (point) (length choice)) (point) | |
4994 | '(mouse-face nil)) | |
4995 | ;; Update point in the window that BUFFER is showing in. | |
4996 | (let ((window (get-buffer-window buffer t))) | |
4997 | (set-window-point window (point))) | |
4998 | ;; If completing for the minibuffer, exit it with this choice. | |
4999 | (and (not completion-no-auto-exit) | |
5000 | (equal buffer (window-buffer (minibuffer-window))) | |
5001 | minibuffer-completion-table | |
5002 | ;; If this is reading a file name, and the file name chosen | |
5003 | ;; is a directory, don't exit the minibuffer. | |
5004 | (if (and (eq minibuffer-completion-table 'read-file-name-internal) | |
5005 | (file-directory-p (field-string (point-max)))) | |
5006 | (let ((mini (active-minibuffer-window))) | |
5007 | (select-window mini) | |
5008 | (when minibuffer-auto-raise | |
5009 | (raise-frame (window-frame mini)))) | |
5010 | (exit-minibuffer))))))) | |
80298193 | 5011 | |
ac29eb79 | 5012 | (defun completion-list-mode () |
e8a700bf | 5013 | "Major mode for buffers showing lists of possible completions. |
80298193 RS |
5014 | Type \\<completion-list-mode-map>\\[choose-completion] in the completion list\ |
5015 | to select the completion near point. | |
5016 | Use \\<completion-list-mode-map>\\[mouse-choose-completion] to select one\ | |
5017 | with the mouse." | |
e8a700bf RS |
5018 | (interactive) |
5019 | (kill-all-local-variables) | |
ac29eb79 RS |
5020 | (use-local-map completion-list-mode-map) |
5021 | (setq mode-name "Completion List") | |
5022 | (setq major-mode 'completion-list-mode) | |
f6b293e3 RS |
5023 | (make-local-variable 'completion-base-size) |
5024 | (setq completion-base-size nil) | |
b2777913 | 5025 | (run-mode-hooks 'completion-list-mode-hook)) |
e8a700bf | 5026 | |
c8d6d636 GM |
5027 | (defun completion-list-mode-finish () |
5028 | "Finish setup of the completions buffer. | |
5029 | Called from `temp-buffer-show-hook'." | |
5030 | (when (eq major-mode 'completion-list-mode) | |
5031 | (toggle-read-only 1))) | |
5032 | ||
5033 | (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish) | |
5034 | ||
747a0e2f RS |
5035 | (defvar completion-setup-hook nil |
5036 | "Normal hook run at the end of setting up a completion list buffer. | |
5037 | When this hook is run, the current buffer is the one in which the | |
5038 | command to display the completion list buffer was run. | |
f5fab556 | 5039 | The completion list buffer is available as the value of `standard-output'. |
63219d53 | 5040 | The common prefix substring for completion may be available as the |
f5fab556 MY |
5041 | value of `completion-common-substring'. See also `display-completion-list'.") |
5042 | ||
5043 | ||
5044 | ;; Variables and faces used in `completion-setup-function'. | |
747a0e2f | 5045 | |
d0fd0916 JPW |
5046 | (defcustom completion-show-help t |
5047 | "Non-nil means show help message in *Completions* buffer." | |
5048 | :type 'boolean | |
5049 | :version "22.1" | |
5050 | :group 'completion) | |
5051 | ||
6a4940b2 | 5052 | (defface completions-first-difference |
abcdd45a MY |
5053 | '((t (:inherit bold))) |
5054 | "Face put on the first uncommon character in completions in *Completions* buffer." | |
5055 | :group 'completion) | |
5056 | ||
6a4940b2 | 5057 | (defface completions-common-part |
abcdd45a | 5058 | '((t (:inherit default))) |
e4ef3e92 JL |
5059 | "Face put on the common prefix substring in completions in *Completions* buffer. |
5060 | The idea of `completions-common-part' is that you can use it to | |
5061 | make the common parts less visible than normal, so that the rest | |
5062 | of the differing parts is, by contrast, slightly highlighted." | |
abcdd45a | 5063 | :group 'completion) |
6096f362 | 5064 | |
abaf2e77 EZ |
5065 | ;; This is for packages that need to bind it to a non-default regexp |
5066 | ;; in order to make the first-differing character highlight work | |
5067 | ;; to their liking | |
5068 | (defvar completion-root-regexp "^/" | |
5069 | "Regexp to use in `completion-setup-function' to find the root directory.") | |
5070 | ||
f5fab556 MY |
5071 | (defvar completion-common-substring nil |
5072 | "Common prefix substring to use in `completion-setup-function' to put faces. | |
5073 | The value is set by `display-completion-list' during running `completion-setup-hook'. | |
5074 | ||
6cdd0211 JL |
5075 | To put faces `completions-first-difference' and `completions-common-part' |
5076 | in the `*Completions*' buffer, the common prefix substring in completions | |
5077 | is needed as a hint. (The minibuffer is a special case. The content | |
5078 | of the minibuffer before point is always the common substring.)") | |
f5fab556 MY |
5079 | |
5080 | ;; This function goes in completion-setup-hook, so that it is called | |
5081 | ;; after the text of the completion list buffer is written. | |
e8a700bf | 5082 | (defun completion-setup-function () |
1b5fd09e | 5083 | (let* ((mainbuf (current-buffer)) |
6cdd0211 JL |
5084 | (mbuf-contents (minibuffer-completion-contents)) |
5085 | common-string-length) | |
621a3f62 SM |
5086 | ;; When reading a file name in the minibuffer, |
5087 | ;; set default-directory in the minibuffer | |
5088 | ;; so it will get copied into the completion list buffer. | |
5089 | (if minibuffer-completing-file-name | |
5090 | (with-current-buffer mainbuf | |
5091 | (setq default-directory (file-name-directory mbuf-contents)))) | |
5092 | (with-current-buffer standard-output | |
3819736b | 5093 | (completion-list-mode) |
1b5fd09e | 5094 | (set (make-local-variable 'completion-reference-buffer) mainbuf) |
b8386753 | 5095 | (setq completion-base-size |
6cdd0211 JL |
5096 | (cond |
5097 | ((and (symbolp minibuffer-completion-table) | |
5098 | (get minibuffer-completion-table 'completion-base-size-function)) | |
5099 | ;; To compute base size, a function can use the global value of | |
5100 | ;; completion-common-substring or minibuffer-completion-contents. | |
5101 | (with-current-buffer mainbuf | |
5102 | (funcall (get minibuffer-completion-table | |
5103 | 'completion-base-size-function)))) | |
5104 | (minibuffer-completing-file-name | |
5105 | ;; For file name completion, use the number of chars before | |
5106 | ;; the start of the file name component at point. | |
5107 | (with-current-buffer mainbuf | |
5108 | (save-excursion | |
5109 | (skip-chars-backward completion-root-regexp) | |
5110 | (- (point) (minibuffer-prompt-end))))) | |
5111 | ;; Otherwise, in minibuffer, the base size is 0. | |
5112 | ((minibufferp mainbuf) 0))) | |
5113 | (setq common-string-length | |
5114 | (cond | |
5115 | (completion-common-substring | |
5116 | (length completion-common-substring)) | |
5117 | (completion-base-size | |
5118 | (- (length mbuf-contents) completion-base-size)))) | |
621a3f62 | 5119 | ;; Put faces on first uncommon characters and common parts. |
6cdd0211 | 5120 | (when (and (integerp common-string-length) (>= common-string-length 0)) |
1b5fd09e SM |
5121 | (let ((element-start (point-min)) |
5122 | (maxp (point-max)) | |
5123 | element-common-end) | |
5124 | (while (and (setq element-start | |
5125 | (next-single-property-change | |
5126 | element-start 'mouse-face)) | |
5127 | (< (setq element-common-end | |
5128 | (+ element-start common-string-length)) | |
5129 | maxp)) | |
a0bd072b | 5130 | (when (get-char-property element-start 'mouse-face) |
6cdd0211 JL |
5131 | (if (and (> common-string-length 0) |
5132 | (get-char-property (1- element-common-end) 'mouse-face)) | |
a0bd072b JL |
5133 | (put-text-property element-start element-common-end |
5134 | 'font-lock-face 'completions-common-part)) | |
5135 | (if (get-char-property element-common-end 'mouse-face) | |
5136 | (put-text-property element-common-end (1+ element-common-end) | |
5137 | 'font-lock-face 'completions-first-difference)))))) | |
d0fd0916 JPW |
5138 | ;; Maybe insert help string. |
5139 | (when completion-show-help | |
5140 | (goto-char (point-min)) | |
5141 | (if (display-mouse-p) | |
5142 | (insert (substitute-command-keys | |
5143 | "Click \\[mouse-choose-completion] on a completion to select it.\n"))) | |
5144 | (insert (substitute-command-keys | |
5145 | "In this buffer, type \\[choose-completion] to \ | |
5146 | select the completion near point.\n\n")))))) | |
c88ab9ce | 5147 | |
e8a700bf | 5148 | (add-hook 'completion-setup-hook 'completion-setup-function) |
dde69dbe | 5149 | |
1b5fd09e SM |
5150 | (define-key minibuffer-local-completion-map [prior] 'switch-to-completions) |
5151 | (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions) | |
dde69dbe RS |
5152 | |
5153 | (defun switch-to-completions () | |
5154 | "Select the completion list window." | |
5155 | (interactive) | |
9595fbdb RS |
5156 | ;; Make sure we have a completions window. |
5157 | (or (get-buffer-window "*Completions*") | |
5158 | (minibuffer-completion-help)) | |
fdbd7c4d KH |
5159 | (let ((window (get-buffer-window "*Completions*"))) |
5160 | (when window | |
5161 | (select-window window) | |
5162 | (goto-char (point-min)) | |
5163 | (search-forward "\n\n") | |
5164 | (forward-line 1)))) | |
f6039de6 JL |
5165 | \f |
5166 | ;;; Support keyboard commands to turn on various modifiers. | |
82072f33 RS |
5167 | |
5168 | ;; These functions -- which are not commands -- each add one modifier | |
5169 | ;; to the following event. | |
5170 | ||
5171 | (defun event-apply-alt-modifier (ignore-prompt) | |
1e96c007 | 5172 | "\\<function-key-map>Add the Alt modifier to the following event. |
70cf9f08 | 5173 | For example, type \\[event-apply-alt-modifier] & to enter Alt-&." |
82072f33 RS |
5174 | (vector (event-apply-modifier (read-event) 'alt 22 "A-"))) |
5175 | (defun event-apply-super-modifier (ignore-prompt) | |
1e96c007 | 5176 | "\\<function-key-map>Add the Super modifier to the following event. |
70cf9f08 | 5177 | For example, type \\[event-apply-super-modifier] & to enter Super-&." |
82072f33 RS |
5178 | (vector (event-apply-modifier (read-event) 'super 23 "s-"))) |
5179 | (defun event-apply-hyper-modifier (ignore-prompt) | |
1e96c007 | 5180 | "\\<function-key-map>Add the Hyper modifier to the following event. |
70cf9f08 | 5181 | For example, type \\[event-apply-hyper-modifier] & to enter Hyper-&." |
82072f33 RS |
5182 | (vector (event-apply-modifier (read-event) 'hyper 24 "H-"))) |
5183 | (defun event-apply-shift-modifier (ignore-prompt) | |
1e96c007 | 5184 | "\\<function-key-map>Add the Shift modifier to the following event. |
70cf9f08 | 5185 | For example, type \\[event-apply-shift-modifier] & to enter Shift-&." |
82072f33 RS |
5186 | (vector (event-apply-modifier (read-event) 'shift 25 "S-"))) |
5187 | (defun event-apply-control-modifier (ignore-prompt) | |
1e96c007 | 5188 | "\\<function-key-map>Add the Ctrl modifier to the following event. |
70cf9f08 | 5189 | For example, type \\[event-apply-control-modifier] & to enter Ctrl-&." |
82072f33 RS |
5190 | (vector (event-apply-modifier (read-event) 'control 26 "C-"))) |
5191 | (defun event-apply-meta-modifier (ignore-prompt) | |
1e96c007 | 5192 | "\\<function-key-map>Add the Meta modifier to the following event. |
70cf9f08 | 5193 | For example, type \\[event-apply-meta-modifier] & to enter Meta-&." |
82072f33 RS |
5194 | (vector (event-apply-modifier (read-event) 'meta 27 "M-"))) |
5195 | ||
5196 | (defun event-apply-modifier (event symbol lshiftby prefix) | |
5197 | "Apply a modifier flag to event EVENT. | |
5198 | SYMBOL is the name of this modifier, as a symbol. | |
5199 | LSHIFTBY is the numeric value of this modifier, in keyboard events. | |
5200 | PREFIX is the string that represents this modifier in an event type symbol." | |
5201 | (if (numberp event) | |
5202 | (cond ((eq symbol 'control) | |
90bebcb0 KH |
5203 | (if (and (<= (downcase event) ?z) |
5204 | (>= (downcase event) ?a)) | |
82072f33 | 5205 | (- (downcase event) ?a -1) |
90bebcb0 KH |
5206 | (if (and (<= (downcase event) ?Z) |
5207 | (>= (downcase event) ?A)) | |
82072f33 RS |
5208 | (- (downcase event) ?A -1) |
5209 | (logior (lsh 1 lshiftby) event)))) | |
5210 | ((eq symbol 'shift) | |
5211 | (if (and (<= (downcase event) ?z) | |
5212 | (>= (downcase event) ?a)) | |
5213 | (upcase event) | |
5214 | (logior (lsh 1 lshiftby) event))) | |
5215 | (t | |
5216 | (logior (lsh 1 lshiftby) event))) | |
5217 | (if (memq symbol (event-modifiers event)) | |
5218 | event | |
5219 | (let ((event-type (if (symbolp event) event (car event)))) | |
5220 | (setq event-type (intern (concat prefix (symbol-name event-type)))) | |
5221 | (if (symbolp event) | |
5222 | event-type | |
5223 | (cons event-type (cdr event))))))) | |
5224 | ||
e5fff738 KH |
5225 | (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier) |
5226 | (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier) | |
5227 | (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier) | |
5228 | (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier) | |
5229 | (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier) | |
5230 | (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier) | |
f6039de6 | 5231 | \f |
a3d1480b JB |
5232 | ;;;; Keypad support. |
5233 | ||
5234 | ;;; Make the keypad keys act like ordinary typing keys. If people add | |
5235 | ;;; bindings for the function key symbols, then those bindings will | |
5236 | ;;; override these, so this shouldn't interfere with any existing | |
5237 | ;;; bindings. | |
5238 | ||
0d173134 | 5239 | ;; Also tell read-char how to handle these keys. |
e1e04350 | 5240 | (mapc |
a3d1480b JB |
5241 | (lambda (keypad-normal) |
5242 | (let ((keypad (nth 0 keypad-normal)) | |
5243 | (normal (nth 1 keypad-normal))) | |
0d173134 | 5244 | (put keypad 'ascii-character normal) |
a3d1480b JB |
5245 | (define-key function-key-map (vector keypad) (vector normal)))) |
5246 | '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4) | |
5247 | (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9) | |
f33321ad | 5248 | (kp-space ?\s) |
a3d1480b JB |
5249 | (kp-tab ?\t) |
5250 | (kp-enter ?\r) | |
5251 | (kp-multiply ?*) | |
5252 | (kp-add ?+) | |
5253 | (kp-separator ?,) | |
5254 | (kp-subtract ?-) | |
5255 | (kp-decimal ?.) | |
5256 | (kp-divide ?/) | |
5257 | (kp-equal ?=))) | |
f54b0d85 | 5258 | \f |
1e722f9f | 5259 | ;;;; |
b005abd5 | 5260 | ;;;; forking a twin copy of a buffer. |
1e722f9f | 5261 | ;;;; |
b005abd5 SM |
5262 | |
5263 | (defvar clone-buffer-hook nil | |
5264 | "Normal hook to run in the new buffer at the end of `clone-buffer'.") | |
5265 | ||
5266 | (defun clone-process (process &optional newname) | |
5267 | "Create a twin copy of PROCESS. | |
5268 | If NEWNAME is nil, it defaults to PROCESS' name; | |
5269 | NEWNAME is modified by adding or incrementing <N> at the end as necessary. | |
5270 | If PROCESS is associated with a buffer, the new process will be associated | |
5271 | with the current buffer instead. | |
5272 | Returns nil if PROCESS has already terminated." | |
5273 | (setq newname (or newname (process-name process))) | |
5274 | (if (string-match "<[0-9]+>\\'" newname) | |
5275 | (setq newname (substring newname 0 (match-beginning 0)))) | |
5276 | (when (memq (process-status process) '(run stop open)) | |
5277 | (let* ((process-connection-type (process-tty-name process)) | |
b005abd5 SM |
5278 | (new-process |
5279 | (if (memq (process-status process) '(open)) | |
ed7069af KS |
5280 | (let ((args (process-contact process t))) |
5281 | (setq args (plist-put args :name newname)) | |
5282 | (setq args (plist-put args :buffer | |
403ca8d9 KS |
5283 | (if (process-buffer process) |
5284 | (current-buffer)))) | |
ed7069af | 5285 | (apply 'make-network-process args)) |
b005abd5 SM |
5286 | (apply 'start-process newname |
5287 | (if (process-buffer process) (current-buffer)) | |
5288 | (process-command process))))) | |
ed7069af KS |
5289 | (set-process-query-on-exit-flag |
5290 | new-process (process-query-on-exit-flag process)) | |
b005abd5 SM |
5291 | (set-process-inherit-coding-system-flag |
5292 | new-process (process-inherit-coding-system-flag process)) | |
5293 | (set-process-filter new-process (process-filter process)) | |
5294 | (set-process-sentinel new-process (process-sentinel process)) | |
403ca8d9 | 5295 | (set-process-plist new-process (copy-sequence (process-plist process))) |
b005abd5 SM |
5296 | new-process))) |
5297 | ||
b75b82ab | 5298 | ;; things to maybe add (currently partly covered by `funcall mode'): |
b005abd5 SM |
5299 | ;; - syntax-table |
5300 | ;; - overlays | |
5301 | (defun clone-buffer (&optional newname display-flag) | |
186f9ad1 LT |
5302 | "Create and return a twin copy of the current buffer. |
5303 | Unlike an indirect buffer, the new buffer can be edited | |
5304 | independently of the old one (if it is not read-only). | |
5305 | NEWNAME is the name of the new buffer. It may be modified by | |
5306 | adding or incrementing <N> at the end as necessary to create a | |
5307 | unique buffer name. If nil, it defaults to the name of the | |
5308 | current buffer, with the proper suffix. If DISPLAY-FLAG is | |
5309 | non-nil, the new buffer is shown with `pop-to-buffer'. Trying to | |
5310 | clone a file-visiting buffer, or a buffer whose major mode symbol | |
5311 | has a non-nil `no-clone' property, results in an error. | |
5312 | ||
5313 | Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the | |
5314 | current buffer with appropriate suffix. However, if a prefix | |
5315 | argument is given, then the command prompts for NEWNAME in the | |
5316 | minibuffer. | |
b005abd5 | 5317 | |
b005abd5 SM |
5318 | This runs the normal hook `clone-buffer-hook' in the new buffer |
5319 | after it has been set up properly in other respects." | |
61acfe7f RS |
5320 | (interactive |
5321 | (progn | |
5322 | (if buffer-file-name | |
5323 | (error "Cannot clone a file-visiting buffer")) | |
5324 | (if (get major-mode 'no-clone) | |
5325 | (error "Cannot clone a buffer in %s mode" mode-name)) | |
f6039de6 JL |
5326 | (list (if current-prefix-arg |
5327 | (read-buffer "Name of new cloned buffer: " (current-buffer))) | |
61acfe7f | 5328 | t))) |
b005abd5 SM |
5329 | (if buffer-file-name |
5330 | (error "Cannot clone a file-visiting buffer")) | |
5331 | (if (get major-mode 'no-clone) | |
5332 | (error "Cannot clone a buffer in %s mode" mode-name)) | |
5333 | (setq newname (or newname (buffer-name))) | |
5334 | (if (string-match "<[0-9]+>\\'" newname) | |
5335 | (setq newname (substring newname 0 (match-beginning 0)))) | |
5336 | (let ((buf (current-buffer)) | |
5337 | (ptmin (point-min)) | |
5338 | (ptmax (point-max)) | |
5339 | (pt (point)) | |
5340 | (mk (if mark-active (mark t))) | |
5341 | (modified (buffer-modified-p)) | |
5342 | (mode major-mode) | |
5343 | (lvars (buffer-local-variables)) | |
5344 | (process (get-buffer-process (current-buffer))) | |
5345 | (new (generate-new-buffer (or newname (buffer-name))))) | |
5346 | (save-restriction | |
5347 | (widen) | |
5348 | (with-current-buffer new | |
5349 | (insert-buffer-substring buf))) | |
5350 | (with-current-buffer new | |
5351 | (narrow-to-region ptmin ptmax) | |
5352 | (goto-char pt) | |
5353 | (if mk (set-mark mk)) | |
5354 | (set-buffer-modified-p modified) | |
5355 | ||
5356 | ;; Clone the old buffer's process, if any. | |
5357 | (when process (clone-process process)) | |
5358 | ||
5359 | ;; Now set up the major mode. | |
5360 | (funcall mode) | |
5361 | ||
5362 | ;; Set up other local variables. | |
5363 | (mapcar (lambda (v) | |
5364 | (condition-case () ;in case var is read-only | |
5365 | (if (symbolp v) | |
5366 | (makunbound v) | |
5367 | (set (make-local-variable (car v)) (cdr v))) | |
5368 | (error nil))) | |
5369 | lvars) | |
5370 | ||
5371 | ;; Run any hooks (typically set up by the major mode | |
5372 | ;; for cloning to work properly). | |
5373 | (run-hooks 'clone-buffer-hook)) | |
0a487199 SM |
5374 | (if display-flag |
5375 | ;; Presumably the current buffer is shown in the selected frame, so | |
5376 | ;; we want to display the clone elsewhere. | |
5377 | (let ((same-window-regexps nil) | |
5378 | (same-window-buffer-names)) | |
5379 | (pop-to-buffer new))) | |
b005abd5 SM |
5380 | new)) |
5381 | ||
fa65f20b | 5382 | |
7e3afb04 | 5383 | (defun clone-indirect-buffer (newname display-flag &optional norecord) |
fa65f20b GM |
5384 | "Create an indirect buffer that is a twin copy of the current buffer. |
5385 | ||
01ba9662 | 5386 | Give the indirect buffer name NEWNAME. Interactively, read NEWNAME |
fa65f20b GM |
5387 | from the minibuffer when invoked with a prefix arg. If NEWNAME is nil |
5388 | or if not called with a prefix arg, NEWNAME defaults to the current | |
5389 | buffer's name. The name is modified by adding a `<N>' suffix to it | |
5390 | or by incrementing the N in an existing suffix. | |
5391 | ||
5392 | DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'. | |
7e3afb04 GM |
5393 | This is always done when called interactively. |
5394 | ||
f33321ad | 5395 | Optional third arg NORECORD non-nil means do not put this buffer at the |
7e3afb04 | 5396 | front of the list of recently selected ones." |
61acfe7f RS |
5397 | (interactive |
5398 | (progn | |
5399 | (if (get major-mode 'no-clone-indirect) | |
5400 | (error "Cannot indirectly clone a buffer in %s mode" mode-name)) | |
5401 | (list (if current-prefix-arg | |
f6039de6 | 5402 | (read-buffer "Name of indirect buffer: " (current-buffer))) |
61acfe7f RS |
5403 | t))) |
5404 | (if (get major-mode 'no-clone-indirect) | |
5405 | (error "Cannot indirectly clone a buffer in %s mode" mode-name)) | |
fa65f20b GM |
5406 | (setq newname (or newname (buffer-name))) |
5407 | (if (string-match "<[0-9]+>\\'" newname) | |
5408 | (setq newname (substring newname 0 (match-beginning 0)))) | |
5409 | (let* ((name (generate-new-buffer-name newname)) | |
5410 | (buffer (make-indirect-buffer (current-buffer) name t))) | |
5411 | (when display-flag | |
58dd38f1 | 5412 | (pop-to-buffer buffer norecord)) |
fa65f20b GM |
5413 | buffer)) |
5414 | ||
5415 | ||
1fffd65f RS |
5416 | (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord) |
5417 | "Like `clone-indirect-buffer' but display in another window." | |
2ef0a47e RS |
5418 | (interactive |
5419 | (progn | |
5420 | (if (get major-mode 'no-clone-indirect) | |
5421 | (error "Cannot indirectly clone a buffer in %s mode" mode-name)) | |
5422 | (list (if current-prefix-arg | |
f6039de6 | 5423 | (read-buffer "Name of indirect buffer: " (current-buffer))) |
2ef0a47e | 5424 | t))) |
acd39eb6 | 5425 | (let ((pop-up-windows t)) |
1fffd65f | 5426 | (clone-indirect-buffer newname display-flag norecord))) |
7e3afb04 | 5427 | |
f54b0d85 | 5428 | \f |
1d4b11bf GM |
5429 | ;;; Handling of Backspace and Delete keys. |
5430 | ||
e5212545 SM |
5431 | (defcustom normal-erase-is-backspace |
5432 | (and (not noninteractive) | |
5433 | (or (memq system-type '(ms-dos windows-nt)) | |
267e1dbe | 5434 | (eq window-system 'mac) |
e5212545 SM |
5435 | (and (memq window-system '(x)) |
5436 | (fboundp 'x-backspace-delete-keys-p) | |
5437 | (x-backspace-delete-keys-p)) | |
5438 | ;; If the terminal Emacs is running on has erase char | |
5439 | ;; set to ^H, use the Backspace key for deleting | |
5440 | ;; backward and, and the Delete key for deleting forward. | |
5441 | (and (null window-system) | |
5442 | (eq tty-erase-char ?\^H)))) | |
7f62656b | 5443 | "If non-nil, Delete key deletes forward and Backspace key deletes backward. |
1d4b11bf GM |
5444 | |
5445 | On window systems, the default value of this option is chosen | |
5446 | according to the keyboard used. If the keyboard has both a Backspace | |
5447 | key and a Delete key, and both are mapped to their usual meanings, the | |
5448 | option's default value is set to t, so that Backspace can be used to | |
7f62656b | 5449 | delete backward, and Delete can be used to delete forward. |
1d4b11bf | 5450 | |
7f62656b | 5451 | If not running under a window system, customizing this option accomplishes |
1d4b11bf GM |
5452 | a similar effect by mapping C-h, which is usually generated by the |
5453 | Backspace key, to DEL, and by mapping DEL to C-d via | |
5454 | `keyboard-translate'. The former functionality of C-h is available on | |
5455 | the F1 key. You should probably not use this setting if you don't | |
f060b834 GM |
5456 | have both Backspace, Delete and F1 keys. |
5457 | ||
5458 | Setting this variable with setq doesn't take effect. Programmatically, | |
7f62656b | 5459 | call `normal-erase-is-backspace-mode' (which see) instead." |
1d4b11bf GM |
5460 | :type 'boolean |
5461 | :group 'editing-basics | |
5462 | :version "21.1" | |
5463 | :set (lambda (symbol value) | |
5464 | ;; The fboundp is because of a problem with :set when | |
5465 | ;; dumping Emacs. It doesn't really matter. | |
7f62656b EZ |
5466 | (if (fboundp 'normal-erase-is-backspace-mode) |
5467 | (normal-erase-is-backspace-mode (or value 0)) | |
1d4b11bf GM |
5468 | (set-default symbol value)))) |
5469 | ||
5470 | ||
7f62656b EZ |
5471 | (defun normal-erase-is-backspace-mode (&optional arg) |
5472 | "Toggle the Erase and Delete mode of the Backspace and Delete keys. | |
5473 | ||
e02160a3 | 5474 | With numeric arg, turn the mode on if and only if ARG is positive. |
7f62656b EZ |
5475 | |
5476 | On window systems, when this mode is on, Delete is mapped to C-d and | |
5477 | Backspace is mapped to DEL; when this mode is off, both Delete and | |
5478 | Backspace are mapped to DEL. (The remapping goes via | |
5479 | `function-key-map', so binding Delete or Backspace in the global or | |
5480 | local keymap will override that.) | |
5481 | ||
5482 | In addition, on window systems, the bindings of C-Delete, M-Delete, | |
5483 | C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in | |
5484 | the global keymap in accordance with the functionality of Delete and | |
5485 | Backspace. For example, if Delete is remapped to C-d, which deletes | |
5486 | forward, C-Delete is bound to `kill-word', but if Delete is remapped | |
5487 | to DEL, which deletes backward, C-Delete is bound to | |
5488 | `backward-kill-word'. | |
5489 | ||
5490 | If not running on a window system, a similar effect is accomplished by | |
5491 | remapping C-h (normally produced by the Backspace key) and DEL via | |
5492 | `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL | |
5493 | to C-d; if it's off, the keys are not remapped. | |
5494 | ||
5495 | When not running on a window system, and this mode is turned on, the | |
5496 | former functionality of C-h is available on the F1 key. You should | |
5497 | probably not turn on this mode on a text-only terminal if you don't | |
5498 | have both Backspace, Delete and F1 keys. | |
5499 | ||
5500 | See also `normal-erase-is-backspace'." | |
1d4b11bf | 5501 | (interactive "P") |
7f62656b | 5502 | (setq normal-erase-is-backspace |
1d4b11bf GM |
5503 | (if arg |
5504 | (> (prefix-numeric-value arg) 0) | |
7f62656b | 5505 | (not normal-erase-is-backspace))) |
1d4b11bf | 5506 | |
13a9eed7 EZ |
5507 | (cond ((or (memq window-system '(x w32 mac pc)) |
5508 | (memq system-type '(ms-dos windows-nt))) | |
7f62656b | 5509 | (let ((bindings |
103db06c RS |
5510 | `(([C-delete] [C-backspace]) |
5511 | ([M-delete] [M-backspace]) | |
5512 | ([C-M-delete] [C-M-backspace]) | |
ec9f4754 | 5513 | (,esc-map |
103db06c RS |
5514 | [C-delete] [C-backspace]))) |
5515 | (old-state (lookup-key function-key-map [delete]))) | |
ec9f4754 | 5516 | |
7f62656b | 5517 | (if normal-erase-is-backspace |
ec9f4754 GM |
5518 | (progn |
5519 | (define-key function-key-map [delete] [?\C-d]) | |
be4f1e41 | 5520 | (define-key function-key-map [kp-delete] [?\C-d]) |
ec9f4754 GM |
5521 | (define-key function-key-map [backspace] [?\C-?])) |
5522 | (define-key function-key-map [delete] [?\C-?]) | |
be4f1e41 | 5523 | (define-key function-key-map [kp-delete] [?\C-?]) |
ec9f4754 GM |
5524 | (define-key function-key-map [backspace] [?\C-?])) |
5525 | ||
103db06c RS |
5526 | ;; Maybe swap bindings of C-delete and C-backspace, etc. |
5527 | (unless (equal old-state (lookup-key function-key-map [delete])) | |
5528 | (dolist (binding bindings) | |
5529 | (let ((map global-map)) | |
5530 | (when (keymapp (car binding)) | |
5531 | (setq map (car binding) binding (cdr binding))) | |
5532 | (let* ((key1 (nth 0 binding)) | |
5533 | (key2 (nth 1 binding)) | |
5534 | (binding1 (lookup-key map key1)) | |
5535 | (binding2 (lookup-key map key2))) | |
5536 | (define-key map key1 binding2) | |
5537 | (define-key map key2 binding1))))))) | |
1d4b11bf | 5538 | (t |
7f62656b | 5539 | (if normal-erase-is-backspace |
1d4b11bf GM |
5540 | (progn |
5541 | (keyboard-translate ?\C-h ?\C-?) | |
5542 | (keyboard-translate ?\C-? ?\C-d)) | |
5543 | (keyboard-translate ?\C-h ?\C-h) | |
5544 | (keyboard-translate ?\C-? ?\C-?)))) | |
5545 | ||
7f62656b | 5546 | (run-hooks 'normal-erase-is-backspace-hook) |
1d4b11bf | 5547 | (if (interactive-p) |
7f62656b EZ |
5548 | (message "Delete key deletes %s" |
5549 | (if normal-erase-is-backspace "forward" "backward")))) | |
ea82f0df | 5550 | \f |
aca8bee5 | 5551 | (defvar vis-mode-saved-buffer-invisibility-spec nil |
0f7df535 | 5552 | "Saved value of `buffer-invisibility-spec' when Visible mode is on.") |
7f62656b | 5553 | |
0f7df535 RS |
5554 | (define-minor-mode visible-mode |
5555 | "Toggle Visible mode. | |
5556 | With argument ARG turn Visible mode on iff ARG is positive. | |
1d4b11bf | 5557 | |
0f7df535 RS |
5558 | Enabling Visible mode makes all invisible text temporarily visible. |
5559 | Disabling Visible mode turns off that effect. Visible mode | |
5560 | works by saving the value of `buffer-invisibility-spec' and setting it to nil." | |
4e57881d | 5561 | :lighter " Vis" |
ab77efd0 | 5562 | :group 'editing-basics |
aca8bee5 SM |
5563 | (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec) |
5564 | (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec) | |
5565 | (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec)) | |
0f7df535 | 5566 | (when visible-mode |
aca8bee5 SM |
5567 | (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec) |
5568 | buffer-invisibility-spec) | |
5569 | (setq buffer-invisibility-spec nil))) | |
4e57881d | 5570 | \f |
e1e04350 | 5571 | ;; Minibuffer prompt stuff. |
9b350152 | 5572 | |
49c14a05 GM |
5573 | ;(defun minibuffer-prompt-modification (start end) |
5574 | ; (error "You cannot modify the prompt")) | |
5575 | ; | |
5576 | ; | |
5577 | ;(defun minibuffer-prompt-insertion (start end) | |
5578 | ; (let ((inhibit-modification-hooks t)) | |
5579 | ; (delete-region start end) | |
5580 | ; ;; Discard undo information for the text insertion itself | |
5581 | ; ;; and for the text deletion.above. | |
5582 | ; (when (consp buffer-undo-list) | |
5583 | ; (setq buffer-undo-list (cddr buffer-undo-list))) | |
5584 | ; (message "You cannot modify the prompt"))) | |
5585 | ; | |
5586 | ; | |
f1180544 | 5587 | ;(setq minibuffer-prompt-properties |
49c14a05 GM |
5588 | ; (list 'modification-hooks '(minibuffer-prompt-modification) |
5589 | ; 'insert-in-front-hooks '(minibuffer-prompt-insertion))) | |
f1180544 | 5590 | ; |
9b350152 | 5591 | |
00398e3b | 5592 | (provide 'simple) |
ab5796a9 | 5593 | |
621a3f62 | 5594 | ;; arch-tag: 24af67c0-2a49-44f6-b3b1-312d8b570dfd |
c88ab9ce | 5595 | ;;; simple.el ends here |