*** empty log message ***
[emacs.git] / lisp / simple.el
blob85df4194088283ba540e82a7abaaee6585170e4f
1 ;;; simple.el --- basic editing commands for Emacs
3 ;; Copyright (C) 1985, 86, 87, 93, 94, 95, 96, 97, 98, 99, 2000
4 ;; Free Software Foundation, Inc.
6 ;; This file is part of GNU Emacs.
8 ;; GNU Emacs is free software; you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation; either version 2, or (at your option)
11 ;; any later version.
13 ;; GNU Emacs is distributed in the hope that it will be useful,
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ;; GNU General Public License for more details.
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with GNU Emacs; see the file COPYING. If not, write to the
20 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 ;; Boston, MA 02111-1307, USA.
23 ;;; Commentary:
25 ;; A grab-bag of basic Emacs commands not specifically related to some
26 ;; major mode or to file-handling.
28 ;;; Code:
30 (eval-when-compile
31 (require 'cl))
34 (defgroup killing nil
35 "Killing and yanking commands"
36 :group 'editing)
38 (defgroup paren-matching nil
39 "Highlight (un)matching of parens and expressions."
40 :group 'matching)
43 (defun fundamental-mode ()
44 "Major mode not specialized for anything in particular.
45 Other major modes are defined by comparison with this one."
46 (interactive)
47 (kill-all-local-variables))
49 ;; Making and deleting lines.
51 (defun newline (&optional arg)
52 "Insert a newline, and move to left margin of the new line if it's blank.
53 The newline is marked with the text-property `hard'.
54 With arg, insert that many newlines.
55 In Auto Fill mode, if no numeric arg, break the preceding line if it's long."
56 (interactive "*P")
57 (barf-if-buffer-read-only)
58 ;; Inserting a newline at the end of a line produces better redisplay in
59 ;; try_window_id than inserting at the beginning of a line, and the textual
60 ;; result is the same. So, if we're at beginning of line, pretend to be at
61 ;; the end of the previous line.
62 (let ((flag (and (not (bobp))
63 (bolp)
64 ;; Make sure no functions want to be told about
65 ;; the range of the changes.
66 (not after-change-functions)
67 (not before-change-functions)
68 ;; Make sure there are no markers here.
69 (not (buffer-has-markers-at (1- (point))))
70 (not (buffer-has-markers-at (point)))
71 ;; Make sure no text properties want to know
72 ;; where the change was.
73 (not (get-char-property (1- (point)) 'modification-hooks))
74 (not (get-char-property (1- (point)) 'insert-behind-hooks))
75 (or (eobp)
76 (not (get-char-property (point) 'insert-in-front-hooks)))
77 ;; Make sure the newline before point isn't intangible.
78 (not (get-char-property (1- (point)) 'intangible))
79 ;; Make sure the newline before point isn't read-only.
80 (not (get-char-property (1- (point)) 'read-only))
81 ;; Make sure the newline before point isn't invisible.
82 (not (get-char-property (1- (point)) 'invisible))
83 ;; Make sure the newline before point has the same
84 ;; properties as the char before it (if any).
85 (< (or (previous-property-change (point)) -2)
86 (- (point) 2))))
87 (was-page-start (and (bolp)
88 (looking-at page-delimiter)))
89 (beforepos (point)))
90 (if flag (backward-char 1))
91 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
92 ;; Set last-command-char to tell self-insert what to insert.
93 (let ((last-command-char ?\n)
94 ;; Don't auto-fill if we have a numeric argument.
95 ;; Also not if flag is true (it would fill wrong line);
96 ;; there is no need to since we're at BOL.
97 (auto-fill-function (if (or arg flag) nil auto-fill-function)))
98 (unwind-protect
99 (self-insert-command (prefix-numeric-value arg))
100 ;; If we get an error in self-insert-command, put point at right place.
101 (if flag (forward-char 1))))
102 ;; Even if we did *not* get an error, keep that forward-char;
103 ;; all further processing should apply to the newline that the user
104 ;; thinks he inserted.
106 ;; Mark the newline(s) `hard'.
107 (if use-hard-newlines
108 (set-hard-newline-properties
109 (- (point) (if arg (prefix-numeric-value arg) 1)) (point)))
110 ;; If the newline leaves the previous line blank,
111 ;; and we have a left margin, delete that from the blank line.
112 (or flag
113 (save-excursion
114 (goto-char beforepos)
115 (beginning-of-line)
116 (and (looking-at "[ \t]$")
117 (> (current-left-margin) 0)
118 (delete-region (point) (progn (end-of-line) (point))))))
119 ;; Indent the line after the newline, except in one case:
120 ;; when we added the newline at the beginning of a line
121 ;; which starts a page.
122 (or was-page-start
123 (move-to-left-margin nil t)))
124 nil)
126 (defun set-hard-newline-properties (from to)
127 (let ((sticky (get-text-property from 'rear-nonsticky)))
128 (put-text-property from to 'hard 't)
129 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
130 (if (and (listp sticky) (not (memq 'hard sticky)))
131 (put-text-property from (point) 'rear-nonsticky
132 (cons 'hard sticky)))))
134 (defun open-line (arg)
135 "Insert a newline and leave point before it.
136 If there is a fill prefix and/or a left-margin, insert them on the new line
137 if the line would have been blank.
138 With arg N, insert N newlines."
139 (interactive "*p")
140 (let* ((do-fill-prefix (and fill-prefix (bolp)))
141 (do-left-margin (and (bolp) (> (current-left-margin) 0)))
142 (loc (point)))
143 (newline arg)
144 (goto-char loc)
145 (while (> arg 0)
146 (cond ((bolp)
147 (if do-left-margin (indent-to (current-left-margin)))
148 (if do-fill-prefix (insert-and-inherit fill-prefix))))
149 (forward-line 1)
150 (setq arg (1- arg)))
151 (goto-char loc)
152 (end-of-line)))
154 (defun split-line ()
155 "Split current line, moving portion beyond point vertically down."
156 (interactive "*")
157 (skip-chars-forward " \t")
158 (let ((col (current-column))
159 (pos (point)))
160 (newline 1)
161 (indent-to col 0)
162 (goto-char pos)))
164 (defun delete-indentation (&optional arg)
165 "Join this line to previous and fix up whitespace at join.
166 If there is a fill prefix, delete it from the beginning of this line.
167 With argument, join this line to following line."
168 (interactive "*P")
169 (beginning-of-line)
170 (if arg (forward-line 1))
171 (if (eq (preceding-char) ?\n)
172 (progn
173 (delete-region (point) (1- (point)))
174 ;; If the second line started with the fill prefix,
175 ;; delete the prefix.
176 (if (and fill-prefix
177 (<= (+ (point) (length fill-prefix)) (point-max))
178 (string= fill-prefix
179 (buffer-substring (point)
180 (+ (point) (length fill-prefix)))))
181 (delete-region (point) (+ (point) (length fill-prefix))))
182 (fixup-whitespace))))
184 (defalias 'join-line #'delete-indentation) ; easier to find
186 (defun delete-blank-lines ()
187 "On blank line, delete all surrounding blank lines, leaving just one.
188 On isolated blank line, delete that one.
189 On nonblank line, delete any immediately following blank lines."
190 (interactive "*")
191 (let (thisblank singleblank)
192 (save-excursion
193 (beginning-of-line)
194 (setq thisblank (looking-at "[ \t]*$"))
195 ;; Set singleblank if there is just one blank line here.
196 (setq singleblank
197 (and thisblank
198 (not (looking-at "[ \t]*\n[ \t]*$"))
199 (or (bobp)
200 (progn (forward-line -1)
201 (not (looking-at "[ \t]*$")))))))
202 ;; Delete preceding blank lines, and this one too if it's the only one.
203 (if thisblank
204 (progn
205 (beginning-of-line)
206 (if singleblank (forward-line 1))
207 (delete-region (point)
208 (if (re-search-backward "[^ \t\n]" nil t)
209 (progn (forward-line 1) (point))
210 (point-min)))))
211 ;; Delete following blank lines, unless the current line is blank
212 ;; and there are no following blank lines.
213 (if (not (and thisblank singleblank))
214 (save-excursion
215 (end-of-line)
216 (forward-line 1)
217 (delete-region (point)
218 (if (re-search-forward "[^ \t\n]" nil t)
219 (progn (beginning-of-line) (point))
220 (point-max)))))
221 ;; Handle the special case where point is followed by newline and eob.
222 ;; Delete the line, leaving point at eob.
223 (if (looking-at "^[ \t]*\n\\'")
224 (delete-region (point) (point-max)))))
226 (defun newline-and-indent ()
227 "Insert a newline, then indent according to major mode.
228 Indentation is done using the value of `indent-line-function'.
229 In programming language modes, this is the same as TAB.
230 In some text modes, where TAB inserts a tab, this command indents to the
231 column specified by the function `current-left-margin'."
232 (interactive "*")
233 (delete-region (point) (progn (skip-chars-backward " \t") (point)))
234 (newline)
235 (indent-according-to-mode))
237 (defun reindent-then-newline-and-indent ()
238 "Reindent current line, insert newline, then indent the new line.
239 Indentation of both lines is done according to the current major mode,
240 which means calling the current value of `indent-line-function'.
241 In programming language modes, this is the same as TAB.
242 In some text modes, where TAB inserts a tab, this indents to the
243 column specified by the function `current-left-margin'."
244 (interactive "*")
245 (save-excursion
246 (delete-region (point) (progn (skip-chars-backward " \t") (point)))
247 (indent-according-to-mode))
248 (newline)
249 (indent-according-to-mode))
251 (defun quoted-insert (arg)
252 "Read next input character and insert it.
253 This is useful for inserting control characters.
255 If the first character you type after this command is an octal digit,
256 you should type a sequence of octal digits which specify a character code.
257 Any nondigit terminates the sequence. If the terminator is a RET,
258 it is discarded; any other terminator is used itself as input.
259 The variable `read-quoted-char-radix' specifies the radix for this feature;
260 set it to 10 or 16 to use decimal or hex instead of octal.
262 In overwrite mode, this function inserts the character anyway, and
263 does not handle octal digits specially. This means that if you use
264 overwrite as your normal editing mode, you can use this function to
265 insert characters when necessary.
267 In binary overwrite mode, this function does overwrite, and octal
268 digits are interpreted as a character code. This is intended to be
269 useful for editing binary files."
270 (interactive "*p")
271 (let ((char (if (or (not overwrite-mode)
272 (eq overwrite-mode 'overwrite-mode-binary))
273 (read-quoted-char)
274 (read-char))))
275 ;; Assume character codes 0240 - 0377 stand for characters in some
276 ;; single-byte character set, and convert them to Emacs
277 ;; characters.
278 (if (and enable-multibyte-characters
279 (>= char ?\240)
280 (<= char ?\377))
281 (setq char (unibyte-char-to-multibyte char)))
282 (if (> arg 0)
283 (if (eq overwrite-mode 'overwrite-mode-binary)
284 (delete-char arg)))
285 (while (> arg 0)
286 (insert-and-inherit char)
287 (setq arg (1- arg)))))
289 (defun forward-to-indentation (arg)
290 "Move forward ARG lines and position at first nonblank character."
291 (interactive "p")
292 (forward-line arg)
293 (skip-chars-forward " \t"))
295 (defun backward-to-indentation (arg)
296 "Move backward ARG lines and position at first nonblank character."
297 (interactive "p")
298 (forward-line (- arg))
299 (skip-chars-forward " \t"))
301 (defun back-to-indentation ()
302 "Move point to the first non-whitespace character on this line."
303 (interactive)
304 (beginning-of-line 1)
305 (skip-chars-forward " \t"))
307 (defun fixup-whitespace ()
308 "Fixup white space between objects around point.
309 Leave one space or none, according to the context."
310 (interactive "*")
311 (save-excursion
312 (delete-horizontal-space)
313 (if (or (looking-at "^\\|\\s)")
314 (save-excursion (forward-char -1)
315 (looking-at "$\\|\\s(\\|\\s'")))
317 (insert ?\ ))))
319 (defun delete-horizontal-space ()
320 "Delete all spaces and tabs around point."
321 (interactive "*")
322 (skip-chars-backward " \t")
323 (delete-region (point) (progn (skip-chars-forward " \t") (point))))
325 (defun just-one-space ()
326 "Delete all spaces and tabs around point, leaving one space."
327 (interactive "*")
328 (skip-chars-backward " \t")
329 (if (= (following-char) ? )
330 (forward-char 1)
331 (insert ? ))
332 (delete-region (point) (progn (skip-chars-forward " \t") (point))))
335 (defun beginning-of-buffer (&optional arg)
336 "Move point to the beginning of the buffer; leave mark at previous position.
337 With arg N, put point N/10 of the way from the beginning.
339 If the buffer is narrowed, this command uses the beginning and size
340 of the accessible part of the buffer.
342 Don't use this command in Lisp programs!
343 \(goto-char (point-min)) is faster and avoids clobbering the mark."
344 (interactive "P")
345 (push-mark)
346 (let ((size (- (point-max) (point-min))))
347 (goto-char (if arg
348 (+ (point-min)
349 (if (> size 10000)
350 ;; Avoid overflow for large buffer sizes!
351 (* (prefix-numeric-value arg)
352 (/ size 10))
353 (/ (+ 10 (* size (prefix-numeric-value arg))) 10)))
354 (point-min))))
355 (if arg (forward-line 1)))
357 (defun end-of-buffer (&optional arg)
358 "Move point to the end of the buffer; leave mark at previous position.
359 With arg N, put point N/10 of the way from the end.
361 If the buffer is narrowed, this command uses the beginning and size
362 of the accessible part of the buffer.
364 Don't use this command in Lisp programs!
365 \(goto-char (point-max)) is faster and avoids clobbering the mark."
366 (interactive "P")
367 (push-mark)
368 (let ((size (- (point-max) (point-min))))
369 (goto-char (if arg
370 (- (point-max)
371 (if (> size 10000)
372 ;; Avoid overflow for large buffer sizes!
373 (* (prefix-numeric-value arg)
374 (/ size 10))
375 (/ (* size (prefix-numeric-value arg)) 10)))
376 (point-max))))
377 ;; If we went to a place in the middle of the buffer,
378 ;; adjust it to the beginning of a line.
379 (cond (arg (forward-line 1))
380 ((< (point) (window-end nil t))
381 ;; If the end of the buffer is not already on the screen,
382 ;; then scroll specially to put it near, but not at, the bottom.
383 (overlay-recenter (point))
384 (recenter -3))))
386 (defun mark-whole-buffer ()
387 "Put point at beginning and mark at end of buffer.
388 You probably should not use this function in Lisp programs;
389 it is usually a mistake for a Lisp function to use any subroutine
390 that uses or sets the mark."
391 (interactive)
392 (push-mark (point))
393 (push-mark (point-max) nil t)
394 (goto-char (point-min)))
397 ;; Counting lines, one way or another.
399 (defun goto-line (arg)
400 "Goto line ARG, counting from line 1 at beginning of buffer."
401 (interactive "NGoto line: ")
402 (setq arg (prefix-numeric-value arg))
403 (save-restriction
404 (widen)
405 (goto-char 1)
406 (if (eq selective-display t)
407 (re-search-forward "[\n\C-m]" nil 'end (1- arg))
408 (forward-line (1- arg)))))
410 (defun count-lines-region (start end)
411 "Print number of lines and characters in the region."
412 (interactive "r")
413 (message "Region has %d lines, %d characters"
414 (count-lines start end) (- end start)))
416 (defun what-line ()
417 "Print the current buffer line number and narrowed line number of point."
418 (interactive)
419 (let ((opoint (point)) start)
420 (save-excursion
421 (save-restriction
422 (goto-char (point-min))
423 (widen)
424 (beginning-of-line)
425 (setq start (point))
426 (goto-char opoint)
427 (beginning-of-line)
428 (if (/= start 1)
429 (message "line %d (narrowed line %d)"
430 (1+ (count-lines 1 (point)))
431 (1+ (count-lines start (point))))
432 (message "Line %d" (1+ (count-lines 1 (point)))))))))
434 (defun count-lines (start end)
435 "Return number of lines between START and END.
436 This is usually the number of newlines between them,
437 but can be one more if START is not equal to END
438 and the greater of them is not at the start of a line."
439 (save-excursion
440 (save-restriction
441 (narrow-to-region start end)
442 (goto-char (point-min))
443 (if (eq selective-display t)
444 (save-match-data
445 (let ((done 0))
446 (while (re-search-forward "[\n\C-m]" nil t 40)
447 (setq done (+ 40 done)))
448 (while (re-search-forward "[\n\C-m]" nil t 1)
449 (setq done (+ 1 done)))
450 (goto-char (point-max))
451 (if (and (/= start end)
452 (not (bolp)))
453 (1+ done)
454 done)))
455 (- (buffer-size) (forward-line (buffer-size)))))))
457 (defun what-cursor-position (&optional detail)
458 "Print info on cursor position (on screen and within buffer).
459 Also describe the character after point, and give its character code
460 in octal, decimal and hex.
462 For a non-ASCII multibyte character, also give its encoding in the
463 buffer's selected coding system if the coding system encodes the
464 character safely. If the character is encoded into one byte, that
465 code is shown in hex. If the character is encoded into more than one
466 byte, just \"...\" is shown.
468 In addition, with prefix argument, show details about that character
469 in *Help* buffer. See also the command `describe-char-after'."
470 (interactive "P")
471 (let* ((char (following-char))
472 (beg (point-min))
473 (end (point-max))
474 (pos (point))
475 (total (buffer-size))
476 (percent (if (> total 50000)
477 ;; Avoid overflow from multiplying by 100!
478 (/ (+ (/ total 200) (1- pos)) (max (/ total 100) 1))
479 (/ (+ (/ total 2) (* 100 (1- pos))) (max total 1))))
480 (hscroll (if (= (window-hscroll) 0)
482 (format " Hscroll=%d" (window-hscroll))))
483 (col (current-column)))
484 (if (= pos end)
485 (if (or (/= beg 1) (/= end (1+ total)))
486 (message "point=%d of %d (%d%%) <%d - %d> column %d %s"
487 pos total percent beg end col hscroll)
488 (message "point=%d of %d (%d%%) column %d %s"
489 pos total percent col hscroll))
490 (let ((coding buffer-file-coding-system)
491 encoded encoding-msg)
492 (if (or (not coding)
493 (eq (coding-system-type coding) t))
494 (setq coding default-buffer-file-coding-system))
495 (if (not (char-valid-p char))
496 (setq encoding-msg
497 (format "(0%o, %d, 0x%x, invalid)" char char char))
498 (setq encoded (and (>= char 128) (encode-coding-char char coding)))
499 (setq encoding-msg
500 (if encoded
501 (format "(0%o, %d, 0x%x, file %s)"
502 char char char
503 (if (> (length encoded) 1)
504 "..."
505 (encoded-string-description encoded coding)))
506 (format "(0%o, %d, 0x%x)" char char char))))
507 (if detail
508 ;; We show the detailed information about CHAR.
509 (describe-char-after (point)))
510 (if (or (/= beg 1) (/= end (1+ total)))
511 (message "Char: %s %s point=%d of %d (%d%%) <%d - %d> column %d %s"
512 (if (< char 256)
513 (single-key-description char)
514 (buffer-substring-no-properties (point) (1+ (point))))
515 encoding-msg pos total percent beg end col hscroll)
516 (message "Char: %s %s point=%d of %d (%d%%) column %d %s"
517 (if (< char 256)
518 (single-key-description char)
519 (buffer-substring-no-properties (point) (1+ (point))))
520 encoding-msg pos total percent col hscroll))))))
522 (defvar read-expression-map (cons 'keymap minibuffer-local-map)
523 "Minibuffer keymap used for reading Lisp expressions.")
524 (define-key read-expression-map "\M-\t" 'lisp-complete-symbol)
526 (defvar read-expression-history nil)
528 (defcustom eval-expression-print-level 4
529 "*Value to use for `print-level' when printing value in `eval-expression'."
530 :group 'lisp
531 :type 'integer
532 :version "21.1")
534 (defcustom eval-expression-print-length 12
535 "*Value to use for `print-length' when printing value in `eval-expression'."
536 :group 'lisp
537 :type '(choice (const nil) integer)
538 :version "21.1")
540 (defcustom eval-expression-debug-on-error t
541 "*Non-nil means set `debug-on-error' when evaluating in `eval-expression'.
542 If nil, don't change the value of `debug-on-error'."
543 :group 'lisp
544 :type 'boolean
545 :version "21.1")
547 ;; We define this, rather than making `eval' interactive,
548 ;; for the sake of completion of names like eval-region, eval-current-buffer.
549 (defun eval-expression (eval-expression-arg
550 &optional eval-expression-insert-value)
551 "Evaluate EXPRESSION and print value in minibuffer.
552 Value is also consed on to front of the variable `values'."
553 (interactive
554 (list (read-from-minibuffer "Eval: "
555 nil read-expression-map t
556 'read-expression-history)
557 current-prefix-arg))
559 (if (null eval-expression-debug-on-error)
560 (setq values (cons (eval eval-expression-arg) values))
561 (let ((old-value (make-symbol "t")) new-value)
562 ;; Bind debug-on-error to something unique so that we can
563 ;; detect when evaled code changes it.
564 (let ((debug-on-error old-value))
565 (setq values (cons (eval eval-expression-arg) values))
566 (setq new-value debug-on-error))
567 ;; If evaled code has changed the value of debug-on-error,
568 ;; propagate that change to the global binding.
569 (unless (eq old-value new-value)
570 (setq debug-on-error new-value))))
572 (let ((print-length eval-expression-print-length)
573 (print-level eval-expression-print-level))
574 (prin1 (car values)
575 (if eval-expression-insert-value (current-buffer) t))))
577 (defun edit-and-eval-command (prompt command)
578 "Prompting with PROMPT, let user edit COMMAND and eval result.
579 COMMAND is a Lisp expression. Let user edit that expression in
580 the minibuffer, then read and evaluate the result."
581 (let ((command (read-from-minibuffer prompt
582 (prin1-to-string command)
583 read-expression-map t
584 '(command-history . 1))))
585 ;; If command was added to command-history as a string,
586 ;; get rid of that. We want only evaluable expressions there.
587 (if (stringp (car command-history))
588 (setq command-history (cdr command-history)))
590 ;; If command to be redone does not match front of history,
591 ;; add it to the history.
592 (or (equal command (car command-history))
593 (setq command-history (cons command command-history)))
594 (eval command)))
596 (defun repeat-complex-command (arg)
597 "Edit and re-evaluate last complex command, or ARGth from last.
598 A complex command is one which used the minibuffer.
599 The command is placed in the minibuffer as a Lisp form for editing.
600 The result is executed, repeating the command as changed.
601 If the command has been changed or is not the most recent previous command
602 it is added to the front of the command history.
603 You can use the minibuffer history commands \\<minibuffer-local-map>\\[next-history-element] and \\[previous-history-element]
604 to get different commands to edit and resubmit."
605 (interactive "p")
606 (let ((elt (nth (1- arg) command-history))
607 newcmd)
608 (if elt
609 (progn
610 (setq newcmd
611 (let ((print-level nil)
612 (minibuffer-history-position arg)
613 (minibuffer-history-sexp-flag (1+ (minibuffer-depth))))
614 (read-from-minibuffer
615 "Redo: " (prin1-to-string elt) read-expression-map t
616 (cons 'command-history arg))))
618 ;; If command was added to command-history as a string,
619 ;; get rid of that. We want only evaluable expressions there.
620 (if (stringp (car command-history))
621 (setq command-history (cdr command-history)))
623 ;; If command to be redone does not match front of history,
624 ;; add it to the history.
625 (or (equal newcmd (car command-history))
626 (setq command-history (cons newcmd command-history)))
627 (eval newcmd))
628 (ding))))
630 (defvar minibuffer-history nil
631 "Default minibuffer history list.
632 This is used for all minibuffer input
633 except when an alternate history list is specified.")
634 (defvar minibuffer-history-sexp-flag nil
635 "Non-nil when doing history operations on `command-history'.
636 More generally, indicates that the history list being acted on
637 contains expressions rather than strings.
638 It is only valid if its value equals the current minibuffer depth,
639 to handle recursive uses of the minibuffer.")
640 (setq minibuffer-history-variable 'minibuffer-history)
641 (setq minibuffer-history-position nil)
642 (defvar minibuffer-history-search-history nil)
644 (mapcar
645 (lambda (key-and-command)
646 (mapcar
647 (lambda (keymap-and-completionp)
648 ;; Arg is (KEYMAP-SYMBOL . COMPLETION-MAP-P).
649 ;; If the cdr of KEY-AND-COMMAND (the command) is a cons,
650 ;; its car is used if COMPLETION-MAP-P is nil, its cdr if it is t.
651 (define-key (symbol-value (car keymap-and-completionp))
652 (car key-and-command)
653 (let ((command (cdr key-and-command)))
654 (if (consp command)
655 ;; (and ... nil) => ... turns back on the completion-oriented
656 ;; history commands which rms turned off since they seem to
657 ;; do things he doesn't like.
658 (if (and (cdr keymap-and-completionp) nil) ;XXX turned off
659 (progn (error "EMACS BUG!") (cdr command))
660 (car command))
661 command))))
662 '((minibuffer-local-map . nil)
663 (minibuffer-local-ns-map . nil)
664 (minibuffer-local-completion-map . t)
665 (minibuffer-local-must-match-map . t)
666 (read-expression-map . nil))))
667 '(("\en" . (next-history-element . next-complete-history-element))
668 ([next] . (next-history-element . next-complete-history-element))
669 ("\ep" . (previous-history-element . previous-complete-history-element))
670 ([prior] . (previous-history-element . previous-complete-history-element))
671 ("\er" . previous-matching-history-element)
672 ("\es" . next-matching-history-element)))
674 (defvar minibuffer-text-before-history nil
675 "Text that was in this minibuffer before any history commands.
676 This is nil if there have not yet been any history commands
677 in this use of the minibuffer.")
679 (add-hook 'minibuffer-setup-hook 'minibuffer-history-initialize)
681 (defun minibuffer-history-initialize ()
682 (setq minibuffer-text-before-history nil))
684 (defcustom minibuffer-history-case-insensitive-variables nil
685 "*Minibuffer history variables for which matching should ignore case.
686 If a history variable is a member of this list, then the
687 \\[previous-matching-history-element] and \\[next-matching-history-element]\
688 commands ignore case when searching it, regardless of `case-fold-search'."
689 :type '(repeat variable)
690 :group 'minibuffer)
692 (defun previous-matching-history-element (regexp n)
693 "Find the previous history element that matches REGEXP.
694 \(Previous history elements refer to earlier actions.)
695 With prefix argument N, search for Nth previous match.
696 If N is negative, find the next or Nth next match.
697 An uppercase letter in REGEXP makes the search case-sensitive.
698 See also `minibuffer-history-case-insensitive-variables'."
699 (interactive
700 (let* ((enable-recursive-minibuffers t)
701 (regexp (read-from-minibuffer "Previous element matching (regexp): "
703 minibuffer-local-map
705 'minibuffer-history-search-history)))
706 ;; Use the last regexp specified, by default, if input is empty.
707 (list (if (string= regexp "")
708 (if minibuffer-history-search-history
709 (car minibuffer-history-search-history)
710 (error "No previous history search regexp"))
711 regexp)
712 (prefix-numeric-value current-prefix-arg))))
713 (if (and (zerop minibuffer-history-position)
714 (null minibuffer-text-before-history))
715 (setq minibuffer-text-before-history (field-string (point-max))))
716 (let ((history (symbol-value minibuffer-history-variable))
717 (case-fold-search
718 (if (isearch-no-upper-case-p regexp t) ; assume isearch.el is dumped
719 ;; On some systems, ignore case for file names.
720 (if (memq minibuffer-history-variable
721 minibuffer-history-case-insensitive-variables)
723 ;; Respect the user's setting for case-fold-search:
724 case-fold-search)
725 nil))
726 prevpos
727 (pos minibuffer-history-position))
728 (while (/= n 0)
729 (setq prevpos pos)
730 (setq pos (min (max 1 (+ pos (if (< n 0) -1 1))) (length history)))
731 (if (= pos prevpos)
732 (error (if (= pos 1)
733 "No later matching history item"
734 "No earlier matching history item")))
735 (if (string-match regexp
736 (if (eq minibuffer-history-sexp-flag
737 (minibuffer-depth))
738 (let ((print-level nil))
739 (prin1-to-string (nth (1- pos) history)))
740 (nth (1- pos) history)))
741 (setq n (+ n (if (< n 0) 1 -1)))))
742 (setq minibuffer-history-position pos)
743 (goto-char (point-max))
744 (delete-field)
745 (let ((elt (nth (1- pos) history)))
746 (insert (if (eq minibuffer-history-sexp-flag (minibuffer-depth))
747 (let ((print-level nil))
748 (prin1-to-string elt))
749 elt)))
750 (goto-char (field-beginning)))
751 (if (or (eq (car (car command-history)) 'previous-matching-history-element)
752 (eq (car (car command-history)) 'next-matching-history-element))
753 (setq command-history (cdr command-history))))
755 (defun next-matching-history-element (regexp n)
756 "Find the next history element that matches REGEXP.
757 \(The next history element refers to a more recent action.)
758 With prefix argument N, search for Nth next match.
759 If N is negative, find the previous or Nth previous match.
760 An uppercase letter in REGEXP makes the search case-sensitive."
761 (interactive
762 (let* ((enable-recursive-minibuffers t)
763 (regexp (read-from-minibuffer "Next element matching (regexp): "
765 minibuffer-local-map
767 'minibuffer-history-search-history)))
768 ;; Use the last regexp specified, by default, if input is empty.
769 (list (if (string= regexp "")
770 (setcar minibuffer-history-search-history
771 (nth 1 minibuffer-history-search-history))
772 regexp)
773 (prefix-numeric-value current-prefix-arg))))
774 (previous-matching-history-element regexp (- n)))
776 (defun next-history-element (n)
777 "Insert the next element of the minibuffer history into the minibuffer."
778 (interactive "p")
779 (or (zerop n)
780 (let ((narg (- minibuffer-history-position n))
781 (minimum (if minibuffer-default -1 0))
782 elt minibuffer-returned-to-present)
783 (if (and (zerop minibuffer-history-position)
784 (null minibuffer-text-before-history))
785 (setq minibuffer-text-before-history (field-string (point-max))))
786 (if (< narg minimum)
787 (if minibuffer-default
788 (error "End of history; no next item")
789 (error "End of history; no default available")))
790 (if (> narg (length (symbol-value minibuffer-history-variable)))
791 (error "Beginning of history; no preceding item"))
792 (goto-char (point-max))
793 (delete-field)
794 (setq minibuffer-history-position narg)
795 (cond ((= narg -1)
796 (setq elt minibuffer-default))
797 ((= narg 0)
798 (setq elt (or minibuffer-text-before-history ""))
799 (setq minibuffer-returned-to-present t)
800 (setq minibuffer-text-before-history nil))
801 (t (setq elt (nth (1- minibuffer-history-position)
802 (symbol-value minibuffer-history-variable)))))
803 (insert
804 (if (and (eq minibuffer-history-sexp-flag (minibuffer-depth))
805 (not minibuffer-returned-to-present))
806 (let ((print-level nil))
807 (prin1-to-string elt))
808 elt))
809 (goto-char (field-beginning)))))
811 (defun previous-history-element (n)
812 "Inserts the previous element of the minibuffer history into the minibuffer."
813 (interactive "p")
814 (next-history-element (- n)))
816 (defun next-complete-history-element (n)
817 "Get next history element which completes the minibuffer before the point.
818 The contents of the minibuffer after the point are deleted, and replaced
819 by the new completion."
820 (interactive "p")
821 (let ((point-at-start (point)))
822 (next-matching-history-element
823 (concat
824 "^" (regexp-quote (buffer-substring (field-beginning) (point))))
826 ;; next-matching-history-element always puts us at (point-min).
827 ;; Move to the position we were at before changing the buffer contents.
828 ;; This is still sensical, because the text before point has not changed.
829 (goto-char point-at-start)))
831 (defun previous-complete-history-element (n)
833 Get previous history element which completes the minibuffer before the point.
834 The contents of the minibuffer after the point are deleted, and replaced
835 by the new completion."
836 (interactive "p")
837 (next-complete-history-element (- n)))
839 ;; These two functions are for compatibility with the old subrs of the
840 ;; same name.
842 (defun minibuffer-prompt-width ()
843 "Return the display width of the minibuffer prompt.
844 Return 0 if current buffer is not a mini-buffer."
845 ;; Return the width of everything before the field at the end of
846 ;; the buffer; this should be 0 for normal buffers.
847 (1- (field-beginning (point-max))))
849 (defun minibuffer-prompt-end ()
850 "Return the buffer position of the end of the minibuffer prompt.
851 Return 0 if current buffer is not a mini-buffer."
852 (field-beginning (point-max)))
855 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
856 (defalias 'advertised-undo 'undo)
858 (defun undo (&optional arg)
859 "Undo some previous changes.
860 Repeat this command to undo more changes.
861 A numeric argument serves as a repeat count.
863 Just C-u as argument requests selective undo,
864 limited to changes within the current region.
865 Likewise in Transient Mark mode when the mark is active."
866 (interactive "*P")
867 ;; If we don't get all the way thru, make last-command indicate that
868 ;; for the following command.
869 (setq this-command t)
870 (let ((modified (buffer-modified-p))
871 (recent-save (recent-auto-save-p)))
872 (or (eq (selected-window) (minibuffer-window))
873 (message "Undo!"))
874 (or (eq last-command 'undo)
875 (progn (if (or arg (and transient-mark-mode mark-active))
876 (undo-start (region-beginning) (region-end))
877 (undo-start))
878 (undo-more 1)))
879 (undo-more (if arg (prefix-numeric-value arg) 1))
880 ;; Don't specify a position in the undo record for the undo command.
881 ;; Instead, undoing this should move point to where the change is.
882 (let ((tail buffer-undo-list)
883 done)
884 (while (and tail (not done) (not (null (car tail))))
885 (if (integerp (car tail))
886 (progn
887 (setq done t)
888 (setq buffer-undo-list (delq (car tail) buffer-undo-list))))
889 (setq tail (cdr tail))))
890 (and modified (not (buffer-modified-p))
891 (delete-auto-save-file-if-necessary recent-save)))
892 ;; If we do get all the way thru, make this-command indicate that.
893 (setq this-command 'undo))
895 (defvar pending-undo-list nil
896 "Within a run of consecutive undo commands, list remaining to be undone.")
898 (defvar undo-in-progress nil
899 "Non-nil while performing an undo.
900 Some change-hooks test this variable to do something different.")
902 (defun undo-more (count)
903 "Undo back N undo-boundaries beyond what was already undone recently.
904 Call `undo-start' to get ready to undo recent changes,
905 then call `undo-more' one or more times to undo them."
906 (or pending-undo-list
907 (error "No further undo information"))
908 (let ((undo-in-progress t))
909 (setq pending-undo-list (primitive-undo count pending-undo-list))))
911 ;; Deep copy of a list
912 (defun undo-copy-list (list)
913 "Make a copy of undo list LIST."
914 (mapcar 'undo-copy-list-1 list))
916 (defun undo-copy-list-1 (elt)
917 (if (consp elt)
918 (cons (car elt) (undo-copy-list-1 (cdr elt)))
919 elt))
921 (defun undo-start (&optional beg end)
922 "Set `pending-undo-list' to the front of the undo list.
923 The next call to `undo-more' will undo the most recently made change.
924 If BEG and END are specified, then only undo elements
925 that apply to text between BEG and END are used; other undo elements
926 are ignored. If BEG and END are nil, all undo elements are used."
927 (if (eq buffer-undo-list t)
928 (error "No undo information in this buffer"))
929 (setq pending-undo-list
930 (if (and beg end (not (= beg end)))
931 (undo-make-selective-list (min beg end) (max beg end))
932 buffer-undo-list)))
934 (defvar undo-adjusted-markers)
936 (defun undo-make-selective-list (start end)
937 "Return a list of undo elements for the region START to END.
938 The elements come from `buffer-undo-list', but we keep only
939 the elements inside this region, and discard those outside this region.
940 If we find an element that crosses an edge of this region,
941 we stop and ignore all further elements."
942 (let ((undo-list-copy (undo-copy-list buffer-undo-list))
943 (undo-list (list nil))
944 undo-adjusted-markers
945 some-rejected
946 undo-elt undo-elt temp-undo-list delta)
947 (while undo-list-copy
948 (setq undo-elt (car undo-list-copy))
949 (let ((keep-this
950 (cond ((and (consp undo-elt) (eq (car undo-elt) t))
951 ;; This is a "was unmodified" element.
952 ;; Keep it if we have kept everything thus far.
953 (not some-rejected))
955 (undo-elt-in-region undo-elt start end)))))
956 (if keep-this
957 (progn
958 (setq end (+ end (cdr (undo-delta undo-elt))))
959 ;; Don't put two nils together in the list
960 (if (not (and (eq (car undo-list) nil)
961 (eq undo-elt nil)))
962 (setq undo-list (cons undo-elt undo-list))))
963 (if (undo-elt-crosses-region undo-elt start end)
964 (setq undo-list-copy nil)
965 (setq some-rejected t)
966 (setq temp-undo-list (cdr undo-list-copy))
967 (setq delta (undo-delta undo-elt))
969 (when (/= (cdr delta) 0)
970 (let ((position (car delta))
971 (offset (cdr delta)))
973 ;; Loop down the earlier events adjusting their buffer positions
974 ;; to reflect the fact that a change to the buffer isn't being
975 ;; undone. We only need to process those element types which
976 ;; undo-elt-in-region will return as being in the region since
977 ;; only those types can ever get into the output
979 (while temp-undo-list
980 (setq undo-elt (car temp-undo-list))
981 (cond ((integerp undo-elt)
982 (if (>= undo-elt position)
983 (setcar temp-undo-list (- undo-elt offset))))
984 ((atom undo-elt) nil)
985 ((stringp (car undo-elt))
986 ;; (TEXT . POSITION)
987 (let ((text-pos (abs (cdr undo-elt)))
988 (point-at-end (< (cdr undo-elt) 0 )))
989 (if (>= text-pos position)
990 (setcdr undo-elt (* (if point-at-end -1 1)
991 (- text-pos offset))))))
992 ((integerp (car undo-elt))
993 ;; (BEGIN . END)
994 (when (>= (car undo-elt) position)
995 (setcar undo-elt (- (car undo-elt) offset))
996 (setcdr undo-elt (- (cdr undo-elt) offset))))
997 ((null (car undo-elt))
998 ;; (nil PROPERTY VALUE BEG . END)
999 (let ((tail (nthcdr 3 undo-elt)))
1000 (when (>= (car tail) position)
1001 (setcar tail (- (car tail) offset))
1002 (setcdr tail (- (cdr tail) offset))))))
1003 (setq temp-undo-list (cdr temp-undo-list))))))))
1004 (setq undo-list-copy (cdr undo-list-copy)))
1005 (nreverse undo-list)))
1007 (defun undo-elt-in-region (undo-elt start end)
1008 "Determine whether UNDO-ELT falls inside the region START ... END.
1009 If it crosses the edge, we return nil."
1010 (cond ((integerp undo-elt)
1011 (and (>= undo-elt start)
1012 (< undo-elt end)))
1013 ((eq undo-elt nil)
1015 ((atom undo-elt)
1016 nil)
1017 ((stringp (car undo-elt))
1018 ;; (TEXT . POSITION)
1019 (and (>= (abs (cdr undo-elt)) start)
1020 (< (abs (cdr undo-elt)) end)))
1021 ((and (consp undo-elt) (markerp (car undo-elt)))
1022 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
1023 ;; See if MARKER is inside the region.
1024 (let ((alist-elt (assq (car undo-elt) undo-adjusted-markers)))
1025 (unless alist-elt
1026 (setq alist-elt (cons (car undo-elt)
1027 (marker-position (car undo-elt))))
1028 (setq undo-adjusted-markers
1029 (cons alist-elt undo-adjusted-markers)))
1030 (and (cdr alist-elt)
1031 (>= (cdr alist-elt) start)
1032 (< (cdr alist-elt) end))))
1033 ((null (car undo-elt))
1034 ;; (nil PROPERTY VALUE BEG . END)
1035 (let ((tail (nthcdr 3 undo-elt)))
1036 (and (>= (car tail) start)
1037 (< (cdr tail) end))))
1038 ((integerp (car undo-elt))
1039 ;; (BEGIN . END)
1040 (and (>= (car undo-elt) start)
1041 (< (cdr undo-elt) end)))))
1043 (defun undo-elt-crosses-region (undo-elt start end)
1044 "Test whether UNDO-ELT crosses one edge of that region START ... END.
1045 This assumes we have already decided that UNDO-ELT
1046 is not *inside* the region START...END."
1047 (cond ((atom undo-elt) nil)
1048 ((null (car undo-elt))
1049 ;; (nil PROPERTY VALUE BEG . END)
1050 (let ((tail (nthcdr 3 undo-elt)))
1051 (not (or (< (car tail) end)
1052 (> (cdr tail) start)))))
1053 ((integerp (car undo-elt))
1054 ;; (BEGIN . END)
1055 (not (or (< (car undo-elt) end)
1056 (> (cdr undo-elt) start))))))
1058 ;; Return the first affected buffer position and the delta for an undo element
1059 ;; delta is defined as the change in subsequent buffer positions if we *did*
1060 ;; the undo.
1061 (defun undo-delta (undo-elt)
1062 (if (consp undo-elt)
1063 (cond ((stringp (car undo-elt))
1064 ;; (TEXT . POSITION)
1065 (cons (abs (cdr undo-elt)) (length (car undo-elt))))
1066 ((integerp (car undo-elt))
1067 ;; (BEGIN . END)
1068 (cons (car undo-elt) (- (car undo-elt) (cdr undo-elt))))
1070 '(0 . 0)))
1071 '(0 . 0)))
1073 (defvar shell-command-history nil
1074 "History list for some commands that read shell commands.")
1076 (defvar shell-command-switch "-c"
1077 "Switch used to have the shell execute its command line argument.")
1079 (defvar shell-command-default-error-buffer nil
1080 "*Buffer name for `shell-command' and `shell-command-on-region' error output.
1081 This buffer is used when `shell-command' or 'shell-command-on-region'
1082 is run interactively. A value of nil means that output to stderr and
1083 stdout will be intermixed in the output stream.")
1085 (defun shell-command (command &optional output-buffer error-buffer)
1086 "Execute string COMMAND in inferior shell; display output, if any.
1088 If COMMAND ends in ampersand, execute it asynchronously.
1089 The output appears in the buffer `*Async Shell Command*'.
1090 That buffer is in shell mode.
1092 Otherwise, COMMAND is executed synchronously. The output appears in the
1093 buffer `*Shell Command Output*'.
1094 If the output is one line, it is displayed in the echo area *as well*,
1095 but it is nonetheless available in buffer `*Shell Command Output*',
1096 even though that buffer is not automatically displayed.
1097 If there is no output, or if output is inserted in the current buffer,
1098 then `*Shell Command Output*' is deleted.
1100 To specify a coding system for converting non-ASCII characters
1101 in the shell command output, use \\[universal-coding-system-argument]
1102 before this command.
1104 Noninteractive callers can specify coding systems by binding
1105 `coding-system-for-read' and `coding-system-for-write'.
1107 The optional second argument OUTPUT-BUFFER, if non-nil,
1108 says to put the output in some other buffer.
1109 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
1110 If OUTPUT-BUFFER is not a buffer and not nil,
1111 insert output in current buffer. (This cannot be done asynchronously.)
1112 In either case, the output is inserted after point (leaving mark after it).
1114 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
1115 or buffer name to which to direct the command's standard error output.
1116 If it is nil, error output is mingled with regular output.
1117 In an interactive call, the variable `shell-command-default-error-buffer'
1118 specifies the value of ERROR-BUFFER."
1120 (interactive (list (read-from-minibuffer "Shell command: "
1121 nil nil nil 'shell-command-history)
1122 current-prefix-arg
1123 shell-command-default-error-buffer))
1124 ;; Look for a handler in case default-directory is a remote file name.
1125 (let ((handler
1126 (find-file-name-handler (directory-file-name default-directory)
1127 'shell-command)))
1128 (if handler
1129 (funcall handler 'shell-command command output-buffer error-buffer)
1130 (if (and output-buffer
1131 (not (or (bufferp output-buffer) (stringp output-buffer))))
1132 (let ((error-file
1133 (if error-buffer
1134 (make-temp-file
1135 (expand-file-name "scor"
1136 (or small-temporary-file-directory
1137 temporary-file-directory)))
1138 nil)))
1139 (barf-if-buffer-read-only)
1140 (push-mark nil t)
1141 ;; We do not use -f for csh; we will not support broken use of
1142 ;; .cshrcs. Even the BSD csh manual says to use
1143 ;; "if ($?prompt) exit" before things which are not useful
1144 ;; non-interactively. Besides, if someone wants their other
1145 ;; aliases for shell commands then they can still have them.
1146 (call-process shell-file-name nil
1147 (if error-file
1148 (list t error-file)
1150 nil shell-command-switch command)
1151 (when (and error-file (file-exists-p error-file))
1152 (if (< 0 (nth 7 (file-attributes error-file)))
1153 (with-current-buffer (get-buffer-create error-buffer)
1154 (let ((pos-from-end (- (point-max) (point))))
1155 (or (bobp)
1156 (insert "\f\n"))
1157 ;; Do no formatting while reading error file,
1158 ;; because that can run a shell command, and we
1159 ;; don't want that to cause an infinite recursion.
1160 (format-insert-file error-file nil)
1161 ;; Put point after the inserted errors.
1162 (goto-char (- (point-max) pos-from-end)))
1163 (display-buffer (current-buffer))))
1164 (delete-file error-file))
1165 ;; This is like exchange-point-and-mark, but doesn't
1166 ;; activate the mark. It is cleaner to avoid activation,
1167 ;; even though the command loop would deactivate the mark
1168 ;; because we inserted text.
1169 (goto-char (prog1 (mark t)
1170 (set-marker (mark-marker) (point)
1171 (current-buffer)))))
1172 ;; Preserve the match data in case called from a program.
1173 (save-match-data
1174 (if (string-match "[ \t]*&[ \t]*$" command)
1175 ;; Command ending with ampersand means asynchronous.
1176 (let ((buffer (get-buffer-create
1177 (or output-buffer "*Async Shell Command*")))
1178 (directory default-directory)
1179 proc)
1180 ;; Remove the ampersand.
1181 (setq command (substring command 0 (match-beginning 0)))
1182 ;; If will kill a process, query first.
1183 (setq proc (get-buffer-process buffer))
1184 (if proc
1185 (if (yes-or-no-p "A command is running. Kill it? ")
1186 (kill-process proc)
1187 (error "Shell command in progress")))
1188 (save-excursion
1189 (set-buffer buffer)
1190 (setq buffer-read-only nil)
1191 (erase-buffer)
1192 (display-buffer buffer)
1193 (setq default-directory directory)
1194 (setq proc (start-process "Shell" buffer shell-file-name
1195 shell-command-switch command))
1196 (setq mode-line-process '(":%s"))
1197 (require 'shell) (shell-mode)
1198 (set-process-sentinel proc 'shell-command-sentinel)
1200 (shell-command-on-region (point) (point) command
1201 output-buffer nil error-buffer)))))))
1203 ;; We have a sentinel to prevent insertion of a termination message
1204 ;; in the buffer itself.
1205 (defun shell-command-sentinel (process signal)
1206 (if (memq (process-status process) '(exit signal))
1207 (message "%s: %s."
1208 (car (cdr (cdr (process-command process))))
1209 (substring signal 0 -1))))
1211 (defun shell-command-on-region (start end command
1212 &optional output-buffer replace
1213 error-buffer)
1214 "Execute string COMMAND in inferior shell with region as input.
1215 Normally display output (if any) in temp buffer `*Shell Command Output*';
1216 Prefix arg means replace the region with it. Return the exit code of
1217 COMMAND.
1219 To specify a coding system for converting non-ASCII characters
1220 in the input and output to the shell command, use \\[universal-coding-system-argument]
1221 before this command. By default, the input (from the current buffer)
1222 is encoded in the same coding system that will be used to save the file,
1223 `buffer-file-coding-system'. If the output is going to replace the region,
1224 then it is decoded from that same coding system.
1226 The noninteractive arguments are START, END, COMMAND, OUTPUT-BUFFER,
1227 REPLACE, ERROR-BUFFER. Noninteractive callers can specify coding
1228 systems by binding `coding-system-for-read' and
1229 `coding-system-for-write'.
1231 If the output is one line, it is displayed in the echo area,
1232 but it is nonetheless available in buffer `*Shell Command Output*'
1233 even though that buffer is not automatically displayed.
1234 If there is no output, or if output is inserted in the current buffer,
1235 then `*Shell Command Output*' is deleted.
1237 If the optional fourth argument OUTPUT-BUFFER is non-nil,
1238 that says to put the output in some other buffer.
1239 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
1240 If OUTPUT-BUFFER is not a buffer and not nil,
1241 insert output in the current buffer.
1242 In either case, the output is inserted after point (leaving mark after it).
1244 If REPLACE, the optional fifth argument, is non-nil, that means insert
1245 the output in place of text from START to END, putting point and mark
1246 around it.
1248 If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
1249 or buffer name to which to direct the command's standard error output.
1250 If it is nil, error output is mingled with regular output.
1251 In an interactive call, the variable `shell-command-default-error-buffer'
1252 specifies the value of ERROR-BUFFER."
1253 (interactive (let ((string
1254 ;; Do this before calling region-beginning
1255 ;; and region-end, in case subprocess output
1256 ;; relocates them while we are in the minibuffer.
1257 (read-from-minibuffer "Shell command on region: "
1258 nil nil nil
1259 'shell-command-history)))
1260 ;; call-interactively recognizes region-beginning and
1261 ;; region-end specially, leaving them in the history.
1262 (list (region-beginning) (region-end)
1263 string
1264 current-prefix-arg
1265 current-prefix-arg
1266 shell-command-default-error-buffer)))
1267 (let ((error-file
1268 (if error-buffer
1269 (make-temp-file
1270 (expand-file-name "scor"
1271 (or small-temporary-file-directory
1272 temporary-file-directory)))
1273 nil))
1274 exit-status)
1275 (if (or replace
1276 (and output-buffer
1277 (not (or (bufferp output-buffer) (stringp output-buffer)))))
1278 ;; Replace specified region with output from command.
1279 (let ((swap (and replace (< start end))))
1280 ;; Don't muck with mark unless REPLACE says we should.
1281 (goto-char start)
1282 (and replace (push-mark))
1283 (setq exit-status
1284 (call-process-region start end shell-file-name t
1285 (if error-file
1286 (list t error-file)
1288 nil shell-command-switch command))
1289 (let ((shell-buffer (get-buffer "*Shell Command Output*")))
1290 (and shell-buffer (not (eq shell-buffer (current-buffer)))
1291 (kill-buffer shell-buffer)))
1292 ;; Don't muck with mark unless REPLACE says we should.
1293 (and replace swap (exchange-point-and-mark)))
1294 ;; No prefix argument: put the output in a temp buffer,
1295 ;; replacing its entire contents.
1296 (let ((buffer (get-buffer-create
1297 (or output-buffer "*Shell Command Output*")))
1298 (success nil))
1299 (unwind-protect
1300 (if (eq buffer (current-buffer))
1301 ;; If the input is the same buffer as the output,
1302 ;; delete everything but the specified region,
1303 ;; then replace that region with the output.
1304 (progn (setq buffer-read-only nil)
1305 (delete-region (max start end) (point-max))
1306 (delete-region (point-min) (min start end))
1307 (setq exit-status
1308 (call-process-region (point-min) (point-max)
1309 shell-file-name t
1310 (if error-file
1311 (list t error-file)
1313 nil shell-command-switch
1314 command)))
1315 ;; Clear the output buffer, then run the command with
1316 ;; output there.
1317 (let ((directory default-directory))
1318 (save-excursion
1319 (set-buffer buffer)
1320 (setq buffer-read-only nil)
1321 (if (not output-buffer)
1322 (setq default-directory directory))
1323 (erase-buffer)))
1324 (setq exit-status
1325 (call-process-region start end shell-file-name nil
1326 (if error-file
1327 (list buffer error-file)
1328 buffer)
1329 nil shell-command-switch command)))
1330 (setq success (and exit-status (equal 0 exit-status)))
1331 ;; Report the amount of output.
1332 (let ((lines (save-excursion
1333 (set-buffer buffer)
1334 (if (= (buffer-size) 0)
1336 (count-lines (point-min) (point-max))))))
1337 (cond ((= lines 0)
1338 (if (and error-file
1339 (< 0 (nth 7 (file-attributes error-file))))
1340 (message "(Shell command %sed with some error output)"
1341 (if (equal 0 exit-status)
1342 "succeed"
1343 "fail"))
1344 (message "(Shell command %sed with no output)"
1345 (if (equal 0 exit-status)
1346 "succeed"
1347 "fail")))
1348 (kill-buffer buffer))
1349 ((= lines 1)
1350 (message "%s"
1351 (save-excursion
1352 (set-buffer buffer)
1353 (goto-char (point-min))
1354 (buffer-substring (point)
1355 (progn (end-of-line) (point))))))
1357 (save-excursion
1358 (set-buffer buffer)
1359 (goto-char (point-min)))
1360 (display-buffer buffer)))))))
1361 (when (and error-file (file-exists-p error-file))
1362 (if (< 0 (nth 7 (file-attributes error-file)))
1363 (with-current-buffer (get-buffer-create error-buffer)
1364 (let ((pos-from-end (- (point-max) (point))))
1365 (or (bobp)
1366 (insert "\f\n"))
1367 ;; Do no formatting while reading error file,
1368 ;; because that can run a shell command, and we
1369 ;; don't want that to cause an infinite recursion.
1370 (format-insert-file error-file nil)
1371 ;; Put point after the inserted errors.
1372 (goto-char (- (point-max) pos-from-end)))
1373 (display-buffer (current-buffer))))
1374 (delete-file error-file))
1375 exit-status))
1377 (defun shell-command-to-string (command)
1378 "Execute shell command COMMAND and return its output as a string."
1379 (with-output-to-string
1380 (with-current-buffer
1381 standard-output
1382 (call-process shell-file-name nil t nil shell-command-switch command))))
1384 (defvar universal-argument-map
1385 (let ((map (make-sparse-keymap)))
1386 (define-key map [t] 'universal-argument-other-key)
1387 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
1388 (define-key map [switch-frame] nil)
1389 (define-key map [?\C-u] 'universal-argument-more)
1390 (define-key map [?-] 'universal-argument-minus)
1391 (define-key map [?0] 'digit-argument)
1392 (define-key map [?1] 'digit-argument)
1393 (define-key map [?2] 'digit-argument)
1394 (define-key map [?3] 'digit-argument)
1395 (define-key map [?4] 'digit-argument)
1396 (define-key map [?5] 'digit-argument)
1397 (define-key map [?6] 'digit-argument)
1398 (define-key map [?7] 'digit-argument)
1399 (define-key map [?8] 'digit-argument)
1400 (define-key map [?9] 'digit-argument)
1401 (define-key map [kp-0] 'digit-argument)
1402 (define-key map [kp-1] 'digit-argument)
1403 (define-key map [kp-2] 'digit-argument)
1404 (define-key map [kp-3] 'digit-argument)
1405 (define-key map [kp-4] 'digit-argument)
1406 (define-key map [kp-5] 'digit-argument)
1407 (define-key map [kp-6] 'digit-argument)
1408 (define-key map [kp-7] 'digit-argument)
1409 (define-key map [kp-8] 'digit-argument)
1410 (define-key map [kp-9] 'digit-argument)
1411 (define-key map [kp-subtract] 'universal-argument-minus)
1412 map)
1413 "Keymap used while processing \\[universal-argument].")
1415 (defvar universal-argument-num-events nil
1416 "Number of argument-specifying events read by `universal-argument'.
1417 `universal-argument-other-key' uses this to discard those events
1418 from (this-command-keys), and reread only the final command.")
1420 (defun universal-argument ()
1421 "Begin a numeric argument for the following command.
1422 Digits or minus sign following \\[universal-argument] make up the numeric argument.
1423 \\[universal-argument] following the digits or minus sign ends the argument.
1424 \\[universal-argument] without digits or minus sign provides 4 as argument.
1425 Repeating \\[universal-argument] without digits or minus sign
1426 multiplies the argument by 4 each time.
1427 For some commands, just \\[universal-argument] by itself serves as a flag
1428 which is different in effect from any particular numeric argument.
1429 These commands include \\[set-mark-command] and \\[start-kbd-macro]."
1430 (interactive)
1431 (setq prefix-arg (list 4))
1432 (setq universal-argument-num-events (length (this-command-keys)))
1433 (setq overriding-terminal-local-map universal-argument-map))
1435 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
1436 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
1437 (defun universal-argument-more (arg)
1438 (interactive "P")
1439 (if (consp arg)
1440 (setq prefix-arg (list (* 4 (car arg))))
1441 (if (eq arg '-)
1442 (setq prefix-arg (list -4))
1443 (setq prefix-arg arg)
1444 (setq overriding-terminal-local-map nil)))
1445 (setq universal-argument-num-events (length (this-command-keys))))
1447 (defun negative-argument (arg)
1448 "Begin a negative numeric argument for the next command.
1449 \\[universal-argument] following digits or minus sign ends the argument."
1450 (interactive "P")
1451 (cond ((integerp arg)
1452 (setq prefix-arg (- arg)))
1453 ((eq arg '-)
1454 (setq prefix-arg nil))
1456 (setq prefix-arg '-)))
1457 (setq universal-argument-num-events (length (this-command-keys)))
1458 (setq overriding-terminal-local-map universal-argument-map))
1460 (defun digit-argument (arg)
1461 "Part of the numeric argument for the next command.
1462 \\[universal-argument] following digits or minus sign ends the argument."
1463 (interactive "P")
1464 (let* ((char (if (integerp last-command-char)
1465 last-command-char
1466 (get last-command-char 'ascii-character)))
1467 (digit (- (logand char ?\177) ?0)))
1468 (cond ((integerp arg)
1469 (setq prefix-arg (+ (* arg 10)
1470 (if (< arg 0) (- digit) digit))))
1471 ((eq arg '-)
1472 ;; Treat -0 as just -, so that -01 will work.
1473 (setq prefix-arg (if (zerop digit) '- (- digit))))
1475 (setq prefix-arg digit))))
1476 (setq universal-argument-num-events (length (this-command-keys)))
1477 (setq overriding-terminal-local-map universal-argument-map))
1479 ;; For backward compatibility, minus with no modifiers is an ordinary
1480 ;; command if digits have already been entered.
1481 (defun universal-argument-minus (arg)
1482 (interactive "P")
1483 (if (integerp arg)
1484 (universal-argument-other-key arg)
1485 (negative-argument arg)))
1487 ;; Anything else terminates the argument and is left in the queue to be
1488 ;; executed as a command.
1489 (defun universal-argument-other-key (arg)
1490 (interactive "P")
1491 (setq prefix-arg arg)
1492 (let* ((key (this-command-keys))
1493 (keylist (listify-key-sequence key)))
1494 (setq unread-command-events
1495 (append (nthcdr universal-argument-num-events keylist)
1496 unread-command-events)))
1497 (reset-this-command-lengths)
1498 (setq overriding-terminal-local-map nil))
1500 ;;;; Window system cut and paste hooks.
1502 (defvar interprogram-cut-function nil
1503 "Function to call to make a killed region available to other programs.
1505 Most window systems provide some sort of facility for cutting and
1506 pasting text between the windows of different programs.
1507 This variable holds a function that Emacs calls whenever text
1508 is put in the kill ring, to make the new kill available to other
1509 programs.
1511 The function takes one or two arguments.
1512 The first argument, TEXT, is a string containing
1513 the text which should be made available.
1514 The second, PUSH, if non-nil means this is a \"new\" kill;
1515 nil means appending to an \"old\" kill.")
1517 (defvar interprogram-paste-function nil
1518 "Function to call to get text cut from other programs.
1520 Most window systems provide some sort of facility for cutting and
1521 pasting text between the windows of different programs.
1522 This variable holds a function that Emacs calls to obtain
1523 text that other programs have provided for pasting.
1525 The function should be called with no arguments. If the function
1526 returns nil, then no other program has provided such text, and the top
1527 of the Emacs kill ring should be used. If the function returns a
1528 string, that string should be put in the kill ring as the latest kill.
1530 Note that the function should return a string only if a program other
1531 than Emacs has provided a string for pasting; if Emacs provided the
1532 most recent string, the function should return nil. If it is
1533 difficult to tell whether Emacs or some other program provided the
1534 current string, it is probably good enough to return nil if the string
1535 is equal (according to `string=') to the last text Emacs provided.")
1539 ;;;; The kill ring data structure.
1541 (defvar kill-ring nil
1542 "List of killed text sequences.
1543 Since the kill ring is supposed to interact nicely with cut-and-paste
1544 facilities offered by window systems, use of this variable should
1545 interact nicely with `interprogram-cut-function' and
1546 `interprogram-paste-function'. The functions `kill-new',
1547 `kill-append', and `current-kill' are supposed to implement this
1548 interaction; you may want to use them instead of manipulating the kill
1549 ring directly.")
1551 (defcustom kill-ring-max 60
1552 "*Maximum length of kill ring before oldest elements are thrown away."
1553 :type 'integer
1554 :group 'killing)
1556 (defvar kill-ring-yank-pointer nil
1557 "The tail of the kill ring whose car is the last thing yanked.")
1559 (defun kill-new (string &optional replace)
1560 "Make STRING the latest kill in the kill ring.
1561 Set the kill-ring-yank pointer to point to it.
1562 If `interprogram-cut-function' is non-nil, apply it to STRING.
1563 Optional second argument REPLACE non-nil means that STRING will replace
1564 the front of the kill ring, rather than being added to the list."
1565 (and (fboundp 'menu-bar-update-yank-menu)
1566 (menu-bar-update-yank-menu string (and replace (car kill-ring))))
1567 (if replace
1568 (setcar kill-ring string)
1569 (setq kill-ring (cons string kill-ring))
1570 (if (> (length kill-ring) kill-ring-max)
1571 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil)))
1572 (setq kill-ring-yank-pointer kill-ring)
1573 (if interprogram-cut-function
1574 (funcall interprogram-cut-function string (not replace))))
1576 (defun kill-append (string before-p)
1577 "Append STRING to the end of the latest kill in the kill ring.
1578 If BEFORE-P is non-nil, prepend STRING to the kill.
1579 If `interprogram-cut-function' is set, pass the resulting kill to
1580 it."
1581 (kill-new (if before-p
1582 (concat string (car kill-ring))
1583 (concat (car kill-ring) string)) t))
1585 (defun current-kill (n &optional do-not-move)
1586 "Rotate the yanking point by N places, and then return that kill.
1587 If N is zero, `interprogram-paste-function' is set, and calling it
1588 returns a string, then that string is added to the front of the
1589 kill ring and returned as the latest kill.
1590 If optional arg DO-NOT-MOVE is non-nil, then don't actually move the
1591 yanking point; just return the Nth kill forward."
1592 (let ((interprogram-paste (and (= n 0)
1593 interprogram-paste-function
1594 (funcall interprogram-paste-function))))
1595 (if interprogram-paste
1596 (progn
1597 ;; Disable the interprogram cut function when we add the new
1598 ;; text to the kill ring, so Emacs doesn't try to own the
1599 ;; selection, with identical text.
1600 (let ((interprogram-cut-function nil))
1601 (kill-new interprogram-paste))
1602 interprogram-paste)
1603 (or kill-ring (error "Kill ring is empty"))
1604 (let ((ARGth-kill-element
1605 (nthcdr (mod (- n (length kill-ring-yank-pointer))
1606 (length kill-ring))
1607 kill-ring)))
1608 (or do-not-move
1609 (setq kill-ring-yank-pointer ARGth-kill-element))
1610 (car ARGth-kill-element)))))
1614 ;;;; Commands for manipulating the kill ring.
1616 (defcustom kill-read-only-ok nil
1617 "*Non-nil means don't signal an error for killing read-only text."
1618 :type 'boolean
1619 :group 'killing)
1621 (put 'text-read-only 'error-conditions
1622 '(text-read-only buffer-read-only error))
1623 (put 'text-read-only 'error-message "Text is read-only")
1625 (defun kill-region (beg end)
1626 "Kill between point and mark.
1627 The text is deleted but saved in the kill ring.
1628 The command \\[yank] can retrieve it from there.
1629 \(If you want to kill and then yank immediately, use \\[copy-region-as-kill].)
1630 If the buffer is read-only, Emacs will beep and refrain from deleting
1631 the text, but put the text in the kill ring anyway. This means that
1632 you can use the killing commands to copy text from a read-only buffer.
1634 This is the primitive for programs to kill text (as opposed to deleting it).
1635 Supply two arguments, character numbers indicating the stretch of text
1636 to be killed.
1637 Any command that calls this function is a \"kill command\".
1638 If the previous command was also a kill command,
1639 the text killed this time appends to the text killed last time
1640 to make one entry in the kill ring."
1641 (interactive "r")
1642 (condition-case nil
1643 (let ((string (delete-and-extract-region beg end)))
1644 (when string ;STRING is nil if BEG = END
1645 ;; Add that string to the kill ring, one way or another.
1646 (if (eq last-command 'kill-region)
1647 (kill-append string (< end beg))
1648 (kill-new string)))
1649 (setq this-command 'kill-region))
1650 ((buffer-read-only text-read-only)
1651 ;; The code above failed because the buffer, or some of the characters
1652 ;; in the region, are read-only.
1653 ;; We should beep, in case the user just isn't aware of this.
1654 ;; However, there's no harm in putting
1655 ;; the region's text in the kill ring, anyway.
1656 (copy-region-as-kill beg end)
1657 ;; Set this-command now, so it will be set even if we get an error.
1658 (setq this-command 'kill-region)
1659 ;; This should barf, if appropriate, and give us the correct error.
1660 (if kill-read-only-ok
1661 (message "Read only text copied to kill ring")
1662 ;; Signal an error if the buffer is read-only.
1663 (barf-if-buffer-read-only)
1664 ;; If the buffer isn't read-only, the text is.
1665 (signal 'text-read-only (list (current-buffer)))))))
1667 ;; copy-region-as-kill no longer sets this-command, because it's confusing
1668 ;; to get two copies of the text when the user accidentally types M-w and
1669 ;; then corrects it with the intended C-w.
1670 (defun copy-region-as-kill (beg end)
1671 "Save the region as if killed, but don't kill it.
1672 In Transient Mark mode, deactivate the mark.
1673 If `interprogram-cut-function' is non-nil, also save the text for a window
1674 system cut and paste."
1675 (interactive "r")
1676 (if (eq last-command 'kill-region)
1677 (kill-append (buffer-substring beg end) (< end beg))
1678 (kill-new (buffer-substring beg end)))
1679 (if transient-mark-mode
1680 (setq deactivate-mark t))
1681 nil)
1683 (defun kill-ring-save (beg end)
1684 "Save the region as if killed, but don't kill it.
1685 In Transient Mark mode, deactivate the mark.
1686 If `interprogram-cut-function' is non-nil, also save the text for a window
1687 system cut and paste.
1689 This command is similar to `copy-region-as-kill', except that it gives
1690 visual feedback indicating the extent of the region being copied."
1691 (interactive "r")
1692 (copy-region-as-kill beg end)
1693 (if (interactive-p)
1694 (let ((other-end (if (= (point) beg) end beg))
1695 (opoint (point))
1696 ;; Inhibit quitting so we can make a quit here
1697 ;; look like a C-g typed as a command.
1698 (inhibit-quit t))
1699 (if (pos-visible-in-window-p other-end (selected-window))
1700 (progn
1701 ;; Swap point and mark.
1702 (set-marker (mark-marker) (point) (current-buffer))
1703 (goto-char other-end)
1704 (sit-for 1)
1705 ;; Swap back.
1706 (set-marker (mark-marker) other-end (current-buffer))
1707 (goto-char opoint)
1708 ;; If user quit, deactivate the mark
1709 ;; as C-g would as a command.
1710 (and quit-flag mark-active
1711 (deactivate-mark)))
1712 (let* ((killed-text (current-kill 0))
1713 (message-len (min (length killed-text) 40)))
1714 (if (= (point) beg)
1715 ;; Don't say "killed"; that is misleading.
1716 (message "Saved text until \"%s\""
1717 (substring killed-text (- message-len)))
1718 (message "Saved text from \"%s\""
1719 (substring killed-text 0 message-len))))))))
1721 (defun append-next-kill (&optional interactive)
1722 "Cause following command, if it kills, to append to previous kill.
1723 The argument is used for internal purposes; do not supply one."
1724 (interactive "p")
1725 ;; We don't use (interactive-p), since that breaks kbd macros.
1726 (if interactive
1727 (progn
1728 (setq this-command 'kill-region)
1729 (message "If the next command is a kill, it will append"))
1730 (setq last-command 'kill-region)))
1732 ;; Yanking.
1734 (defun yank-pop (arg)
1735 "Replace just-yanked stretch of killed text with a different stretch.
1736 This command is allowed only immediately after a `yank' or a `yank-pop'.
1737 At such a time, the region contains a stretch of reinserted
1738 previously-killed text. `yank-pop' deletes that text and inserts in its
1739 place a different stretch of killed text.
1741 With no argument, the previous kill is inserted.
1742 With argument N, insert the Nth previous kill.
1743 If N is negative, this is a more recent kill.
1745 The sequence of kills wraps around, so that after the oldest one
1746 comes the newest one."
1747 (interactive "*p")
1748 (if (not (eq last-command 'yank))
1749 (error "Previous command was not a yank"))
1750 (setq this-command 'yank)
1751 (let ((inhibit-read-only t)
1752 (before (< (point) (mark t))))
1753 (delete-region (point) (mark t))
1754 (set-marker (mark-marker) (point) (current-buffer))
1755 (let ((opoint (point)))
1756 (insert (current-kill arg))
1757 (let ((inhibit-read-only t))
1758 (remove-text-properties opoint (point) '(read-only nil))))
1759 (if before
1760 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
1761 ;; It is cleaner to avoid activation, even though the command
1762 ;; loop would deactivate the mark because we inserted text.
1763 (goto-char (prog1 (mark t)
1764 (set-marker (mark-marker) (point) (current-buffer))))))
1765 nil)
1767 (defun yank (&optional arg)
1768 "Reinsert the last stretch of killed text.
1769 More precisely, reinsert the stretch of killed text most recently
1770 killed OR yanked. Put point at end, and set mark at beginning.
1771 With just C-u as argument, same but put point at beginning (and mark at end).
1772 With argument N, reinsert the Nth most recently killed stretch of killed
1773 text.
1774 See also the command \\[yank-pop]."
1775 (interactive "*P")
1776 ;; If we don't get all the way thru, make last-command indicate that
1777 ;; for the following command.
1778 (setq this-command t)
1779 (push-mark (point))
1780 (let ((opoint (point)))
1781 (insert (current-kill (cond
1782 ((listp arg) 0)
1783 ((eq arg '-) -1)
1784 (t (1- arg)))))
1785 (let ((inhibit-read-only t))
1786 (remove-text-properties opoint (point) '(read-only nil))))
1787 (if (consp arg)
1788 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
1789 ;; It is cleaner to avoid activation, even though the command
1790 ;; loop would deactivate the mark because we inserted text.
1791 (goto-char (prog1 (mark t)
1792 (set-marker (mark-marker) (point) (current-buffer)))))
1793 ;; If we do get all the way thru, make this-command indicate that.
1794 (setq this-command 'yank)
1795 nil)
1797 (defun rotate-yank-pointer (arg)
1798 "Rotate the yanking point in the kill ring.
1799 With argument, rotate that many kills forward (or backward, if negative)."
1800 (interactive "p")
1801 (current-kill arg))
1803 ;; Some kill commands.
1805 ;; Internal subroutine of delete-char
1806 (defun kill-forward-chars (arg)
1807 (if (listp arg) (setq arg (car arg)))
1808 (if (eq arg '-) (setq arg -1))
1809 (kill-region (point) (forward-point arg)))
1811 ;; Internal subroutine of backward-delete-char
1812 (defun kill-backward-chars (arg)
1813 (if (listp arg) (setq arg (car arg)))
1814 (if (eq arg '-) (setq arg -1))
1815 (kill-region (point) (forward-point (- arg))))
1817 (defcustom backward-delete-char-untabify-method 'untabify
1818 "*The method for untabifying when deleting backward.
1819 Can be `untabify' -- turn a tab to many spaces, then delete one space;
1820 `hungry' -- delete all whitespace, both tabs and spaces;
1821 `all' -- delete all whitespace, including tabs, spaces and newlines;
1822 nil -- just delete one character."
1823 :type '(choice (const untabify) (const hungry) (const all) (const nil))
1824 :group 'killing)
1826 (defun backward-delete-char-untabify (arg &optional killp)
1827 "Delete characters backward, changing tabs into spaces.
1828 The exact behavior depends on `backward-delete-char-untabify-method'.
1829 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
1830 Interactively, ARG is the prefix arg (default 1)
1831 and KILLP is t if a prefix arg was specified."
1832 (interactive "*p\nP")
1833 (when (eq backward-delete-char-untabify-method 'untabify)
1834 (let ((count arg))
1835 (save-excursion
1836 (while (and (> count 0) (not (bobp)))
1837 (if (= (preceding-char) ?\t)
1838 (let ((col (current-column)))
1839 (forward-char -1)
1840 (setq col (- col (current-column)))
1841 (insert-char ?\ col)
1842 (delete-char 1)))
1843 (forward-char -1)
1844 (setq count (1- count))))))
1845 (delete-backward-char
1846 (let ((skip (cond ((eq backward-delete-char-untabify-method 'hungry) " \t")
1847 ((eq backward-delete-char-untabify-method 'all)
1848 " \t\n\r"))))
1849 (if skip
1850 (let ((wh (- (point) (save-excursion (skip-chars-backward skip)
1851 (point)))))
1852 (+ arg (if (zerop wh) 0 (1- wh))))
1853 arg))
1854 killp))
1856 (defun zap-to-char (arg char)
1857 "Kill up to and including ARG'th occurrence of CHAR.
1858 Case is ignored if `case-fold-search' is non-nil in the current buffer.
1859 Goes backward if ARG is negative; error if CHAR not found."
1860 (interactive "p\ncZap to char: ")
1861 (kill-region (point) (progn
1862 (search-forward (char-to-string char) nil nil arg)
1863 ; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
1864 (point))))
1866 ;; kill-line and its subroutines.
1868 (defcustom kill-whole-line nil
1869 "*If non-nil, `kill-line' with no arg at beg of line kills the whole line."
1870 :type 'boolean
1871 :group 'killing)
1873 (defun kill-line (&optional arg)
1874 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
1875 With prefix argument, kill that many lines from point.
1876 Negative arguments kill lines backward.
1878 When calling from a program, nil means \"no arg\",
1879 a number counts as a prefix arg.
1881 To kill a whole line, when point is not at the beginning, type \
1882 \\[beginning-of-line] \\[kill-line] \\[kill-line].
1884 If `kill-whole-line' is non-nil, then this command kills the whole line
1885 including its terminating newline, when used at the beginning of a line
1886 with no argument. As a consequence, you can always kill a whole line
1887 by typing \\[beginning-of-line] \\[kill-line]."
1888 (interactive "P")
1889 (kill-region (point)
1890 ;; It is better to move point to the other end of the kill
1891 ;; before killing. That way, in a read-only buffer, point
1892 ;; moves across the text that is copied to the kill ring.
1893 ;; The choice has no effect on undo now that undo records
1894 ;; the value of point from before the command was run.
1895 (progn
1896 (if arg
1897 (forward-visible-line (prefix-numeric-value arg))
1898 (if (eobp)
1899 (signal 'end-of-buffer nil))
1900 (if (or (looking-at "[ \t]*$") (and kill-whole-line (bolp)))
1901 (forward-visible-line 1)
1902 (end-of-visible-line)))
1903 (point))))
1905 (defun forward-visible-line (arg)
1906 "Move forward by ARG lines, ignoring currently invisible newlines only.
1907 If ARG is negative, move backward -ARG lines.
1908 If ARG is zero, move to the beginning of the current line."
1909 (condition-case nil
1910 (if (> arg 0)
1911 (while (> arg 0)
1912 (or (zerop (forward-line 1))
1913 (signal 'end-of-buffer nil))
1914 ;; If the following character is currently invisible,
1915 ;; skip all characters with that same `invisible' property value,
1916 ;; then find the next newline.
1917 (while (and (not (eobp))
1918 (let ((prop
1919 (get-char-property (point) 'invisible)))
1920 (if (eq buffer-invisibility-spec t)
1921 prop
1922 (or (memq prop buffer-invisibility-spec)
1923 (assq prop buffer-invisibility-spec)))))
1924 (goto-char
1925 (if (get-text-property (point) 'invisible)
1926 (or (next-single-property-change (point) 'invisible)
1927 (point-max))
1928 (next-overlay-change (point))))
1929 (or (zerop (forward-line 1))
1930 (signal 'end-of-buffer nil)))
1931 (setq arg (1- arg)))
1932 (let ((first t))
1933 (while (or first (< arg 0))
1934 (if (zerop arg)
1935 (beginning-of-line)
1936 (or (zerop (forward-line -1))
1937 (signal 'beginning-of-buffer nil)))
1938 (while (and (not (bobp))
1939 (let ((prop
1940 (get-char-property (1- (point)) 'invisible)))
1941 (if (eq buffer-invisibility-spec t)
1942 prop
1943 (or (memq prop buffer-invisibility-spec)
1944 (assq prop buffer-invisibility-spec)))))
1945 (goto-char
1946 (if (get-text-property (1- (point)) 'invisible)
1947 (or (previous-single-property-change (point) 'invisible)
1948 (point-min))
1949 (previous-overlay-change (point))))
1950 (or (zerop (forward-line -1))
1951 (signal 'beginning-of-buffer nil)))
1952 (setq first nil)
1953 (setq arg (1+ arg)))))
1954 ((beginning-of-buffer end-of-buffer)
1955 nil)))
1957 (defun end-of-visible-line ()
1958 "Move to end of current visible line."
1959 (end-of-line)
1960 ;; If the following character is currently invisible,
1961 ;; skip all characters with that same `invisible' property value,
1962 ;; then find the next newline.
1963 (while (and (not (eobp))
1964 (let ((prop
1965 (get-char-property (point) 'invisible)))
1966 (if (eq buffer-invisibility-spec t)
1967 prop
1968 (or (memq prop buffer-invisibility-spec)
1969 (assq prop buffer-invisibility-spec)))))
1970 (if (get-text-property (point) 'invisible)
1971 (goto-char (next-single-property-change (point) 'invisible))
1972 (goto-char (next-overlay-change (point))))
1973 (end-of-line)))
1975 (defun insert-buffer (buffer)
1976 "Insert after point the contents of BUFFER.
1977 Puts mark after the inserted text.
1978 BUFFER may be a buffer or a buffer name.
1980 This function is meant for the user to run interactively.
1981 Don't call it from programs!"
1982 (interactive
1983 (list
1984 (progn
1985 (barf-if-buffer-read-only)
1986 (read-buffer "Insert buffer: "
1987 (if (eq (selected-window) (next-window (selected-window)))
1988 (other-buffer (current-buffer))
1989 (window-buffer (next-window (selected-window))))
1990 t))))
1991 (or (bufferp buffer)
1992 (setq buffer (get-buffer buffer)))
1993 (let (start end newmark)
1994 (save-excursion
1995 (save-excursion
1996 (set-buffer buffer)
1997 (setq start (point-min) end (point-max)))
1998 (insert-buffer-substring buffer start end)
1999 (setq newmark (point)))
2000 (push-mark newmark))
2001 nil)
2003 (defun append-to-buffer (buffer start end)
2004 "Append to specified buffer the text of the region.
2005 It is inserted into that buffer before its point.
2007 When calling from a program, give three arguments:
2008 BUFFER (or buffer name), START and END.
2009 START and END specify the portion of the current buffer to be copied."
2010 (interactive
2011 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
2012 (region-beginning) (region-end)))
2013 (let ((oldbuf (current-buffer)))
2014 (save-excursion
2015 (let* ((append-to (get-buffer-create buffer))
2016 (windows (get-buffer-window-list append-to t t))
2017 point)
2018 (set-buffer append-to)
2019 (setq point (point))
2020 (barf-if-buffer-read-only)
2021 (insert-buffer-substring oldbuf start end)
2022 (dolist (window windows)
2023 (when (= (window-point window) point)
2024 (set-window-point window (point))))))))
2026 (defun prepend-to-buffer (buffer start end)
2027 "Prepend to specified buffer the text of the region.
2028 It is inserted into that buffer after its point.
2030 When calling from a program, give three arguments:
2031 BUFFER (or buffer name), START and END.
2032 START and END specify the portion of the current buffer to be copied."
2033 (interactive "BPrepend to buffer: \nr")
2034 (let ((oldbuf (current-buffer)))
2035 (save-excursion
2036 (set-buffer (get-buffer-create buffer))
2037 (barf-if-buffer-read-only)
2038 (save-excursion
2039 (insert-buffer-substring oldbuf start end)))))
2041 (defun copy-to-buffer (buffer start end)
2042 "Copy to specified buffer the text of the region.
2043 It is inserted into that buffer, replacing existing text there.
2045 When calling from a program, give three arguments:
2046 BUFFER (or buffer name), START and END.
2047 START and END specify the portion of the current buffer to be copied."
2048 (interactive "BCopy to buffer: \nr")
2049 (let ((oldbuf (current-buffer)))
2050 (save-excursion
2051 (set-buffer (get-buffer-create buffer))
2052 (barf-if-buffer-read-only)
2053 (erase-buffer)
2054 (save-excursion
2055 (insert-buffer-substring oldbuf start end)))))
2057 (put 'mark-inactive 'error-conditions '(mark-inactive error))
2058 (put 'mark-inactive 'error-message "The mark is not active now")
2060 (defun mark (&optional force)
2061 "Return this buffer's mark value as integer; error if mark inactive.
2062 If optional argument FORCE is non-nil, access the mark value
2063 even if the mark is not currently active, and return nil
2064 if there is no mark at all.
2066 If you are using this in an editing command, you are most likely making
2067 a mistake; see the documentation of `set-mark'."
2068 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
2069 (marker-position (mark-marker))
2070 (signal 'mark-inactive nil)))
2072 ;; Many places set mark-active directly, and several of them failed to also
2073 ;; run deactivate-mark-hook. This shorthand should simplify.
2074 (defsubst deactivate-mark ()
2075 "Deactivate the mark by setting `mark-active' to nil.
2076 \(That makes a difference only in Transient Mark mode.)
2077 Also runs the hook `deactivate-mark-hook'."
2078 (if transient-mark-mode
2079 (progn
2080 (setq mark-active nil)
2081 (run-hooks 'deactivate-mark-hook))))
2083 (defun set-mark (pos)
2084 "Set this buffer's mark to POS. Don't use this function!
2085 That is to say, don't use this function unless you want
2086 the user to see that the mark has moved, and you want the previous
2087 mark position to be lost.
2089 Normally, when a new mark is set, the old one should go on the stack.
2090 This is why most applications should use push-mark, not set-mark.
2092 Novice Emacs Lisp programmers often try to use the mark for the wrong
2093 purposes. The mark saves a location for the user's convenience.
2094 Most editing commands should not alter the mark.
2095 To remember a location for internal use in the Lisp program,
2096 store it in a Lisp variable. Example:
2098 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
2100 (if pos
2101 (progn
2102 (setq mark-active t)
2103 (run-hooks 'activate-mark-hook)
2104 (set-marker (mark-marker) pos (current-buffer)))
2105 ;; Normally we never clear mark-active except in Transient Mark mode.
2106 ;; But when we actually clear out the mark value too,
2107 ;; we must clear mark-active in any mode.
2108 (setq mark-active nil)
2109 (run-hooks 'deactivate-mark-hook)
2110 (set-marker (mark-marker) nil)))
2112 (defvar mark-ring nil
2113 "The list of former marks of the current buffer, most recent first.")
2114 (make-variable-buffer-local 'mark-ring)
2115 (put 'mark-ring 'permanent-local t)
2117 (defcustom mark-ring-max 16
2118 "*Maximum size of mark ring. Start discarding off end if gets this big."
2119 :type 'integer
2120 :group 'editing-basics)
2122 (defvar global-mark-ring nil
2123 "The list of saved global marks, most recent first.")
2125 (defcustom global-mark-ring-max 16
2126 "*Maximum size of global mark ring. \
2127 Start discarding off end if gets this big."
2128 :type 'integer
2129 :group 'editing-basics)
2131 (defun set-mark-command (arg)
2132 "Set mark at where point is, or jump to mark.
2133 With no prefix argument, set mark, push old mark position on local mark
2134 ring, and push mark on global mark ring.
2135 With argument, jump to mark, and pop a new position for mark off the ring
2136 \(does not affect global mark ring\).
2138 Novice Emacs Lisp programmers often try to use the mark for the wrong
2139 purposes. See the documentation of `set-mark' for more information."
2140 (interactive "P")
2141 (if (null arg)
2142 (progn
2143 (push-mark nil nil t))
2144 (if (null (mark t))
2145 (error "No mark set in this buffer")
2146 (goto-char (mark t))
2147 (pop-mark))))
2149 (defun push-mark (&optional location nomsg activate)
2150 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
2151 If the last global mark pushed was not in the current buffer,
2152 also push LOCATION on the global mark ring.
2153 Display `Mark set' unless the optional second arg NOMSG is non-nil.
2154 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil.
2156 Novice Emacs Lisp programmers often try to use the mark for the wrong
2157 purposes. See the documentation of `set-mark' for more information.
2159 In Transient Mark mode, this does not activate the mark."
2160 (if (null (mark t))
2162 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
2163 (if (> (length mark-ring) mark-ring-max)
2164 (progn
2165 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
2166 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil))))
2167 (set-marker (mark-marker) (or location (point)) (current-buffer))
2168 ;; Now push the mark on the global mark ring.
2169 (if (and global-mark-ring
2170 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
2171 ;; The last global mark pushed was in this same buffer.
2172 ;; Don't push another one.
2174 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
2175 (if (> (length global-mark-ring) global-mark-ring-max)
2176 (progn
2177 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring))
2178 nil)
2179 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil))))
2180 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
2181 (message "Mark set"))
2182 (if (or activate (not transient-mark-mode))
2183 (set-mark (mark t)))
2184 nil)
2186 (defun pop-mark ()
2187 "Pop off mark ring into the buffer's actual mark.
2188 Does not set point. Does nothing if mark ring is empty."
2189 (if mark-ring
2190 (progn
2191 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
2192 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
2193 (deactivate-mark)
2194 (move-marker (car mark-ring) nil)
2195 (if (null (mark t)) (ding))
2196 (setq mark-ring (cdr mark-ring)))))
2198 (defalias 'exchange-dot-and-mark 'exchange-point-and-mark)
2199 (defun exchange-point-and-mark ()
2200 "Put the mark where point is now, and point where the mark is now.
2201 This command works even when the mark is not active,
2202 and it reactivates the mark."
2203 (interactive nil)
2204 (let ((omark (mark t)))
2205 (if (null omark)
2206 (error "No mark set in this buffer"))
2207 (set-mark (point))
2208 (goto-char omark)
2209 nil))
2211 (defun transient-mark-mode (arg)
2212 "Toggle Transient Mark mode.
2213 With arg, turn Transient Mark mode on if arg is positive, off otherwise.
2215 In Transient Mark mode, when the mark is active, the region is highlighted.
2216 Changing the buffer \"deactivates\" the mark.
2217 So do certain other operations that set the mark
2218 but whose main purpose is something else--for example,
2219 incremental search, \\[beginning-of-buffer], and \\[end-of-buffer]."
2220 (interactive "P")
2221 (setq transient-mark-mode
2222 (if (null arg)
2223 (not transient-mark-mode)
2224 (> (prefix-numeric-value arg) 0)))
2225 (if (interactive-p)
2226 (if transient-mark-mode
2227 (message "Transient Mark mode enabled")
2228 (message "Transient Mark mode disabled"))))
2230 (defun pop-global-mark ()
2231 "Pop off global mark ring and jump to the top location."
2232 (interactive)
2233 ;; Pop entries which refer to non-existent buffers.
2234 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
2235 (setq global-mark-ring (cdr global-mark-ring)))
2236 (or global-mark-ring
2237 (error "No global mark set"))
2238 (let* ((marker (car global-mark-ring))
2239 (buffer (marker-buffer marker))
2240 (position (marker-position marker)))
2241 (setq global-mark-ring (nconc (cdr global-mark-ring)
2242 (list (car global-mark-ring))))
2243 (set-buffer buffer)
2244 (or (and (>= position (point-min))
2245 (<= position (point-max)))
2246 (widen))
2247 (goto-char position)
2248 (switch-to-buffer buffer)))
2250 (defcustom next-line-add-newlines t
2251 "*If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
2252 :type 'boolean
2253 :group 'editing-basics)
2255 (defun next-line (arg)
2256 "Move cursor vertically down ARG lines.
2257 If there is no character in the target line exactly under the current column,
2258 the cursor is positioned after the character in that line which spans this
2259 column, or at the end of the line if it is not long enough.
2260 If there is no line in the buffer after this one, behavior depends on the
2261 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
2262 to create a line, and moves the cursor to that line. Otherwise it moves the
2263 cursor to the end of the buffer.
2265 The command \\[set-goal-column] can be used to create
2266 a semipermanent goal column for this command.
2267 Then instead of trying to move exactly vertically (or as close as possible),
2268 this command moves to the specified goal column (or as close as possible).
2269 The goal column is stored in the variable `goal-column', which is nil
2270 when there is no goal column.
2272 If you are thinking of using this in a Lisp program, consider
2273 using `forward-line' instead. It is usually easier to use
2274 and more reliable (no dependence on goal column, etc.)."
2275 (interactive "p")
2276 (if (and next-line-add-newlines (= arg 1))
2277 (let ((opoint (point)))
2278 (end-of-line)
2279 (if (eobp)
2280 (newline 1)
2281 (goto-char opoint)
2282 (line-move arg)))
2283 (if (interactive-p)
2284 (condition-case nil
2285 (line-move arg)
2286 ((beginning-of-buffer end-of-buffer) (ding)))
2287 (line-move arg)))
2288 nil)
2290 (defun previous-line (arg)
2291 "Move cursor vertically up ARG lines.
2292 If there is no character in the target line exactly over the current column,
2293 the cursor is positioned after the character in that line which spans this
2294 column, or at the end of the line if it is not long enough.
2296 The command \\[set-goal-column] can be used to create
2297 a semipermanent goal column for this command.
2298 Then instead of trying to move exactly vertically (or as close as possible),
2299 this command moves to the specified goal column (or as close as possible).
2300 The goal column is stored in the variable `goal-column', which is nil
2301 when there is no goal column.
2303 If you are thinking of using this in a Lisp program, consider using
2304 `forward-line' with a negative argument instead. It is usually easier
2305 to use and more reliable (no dependence on goal column, etc.)."
2306 (interactive "p")
2307 (if (interactive-p)
2308 (condition-case nil
2309 (line-move (- arg))
2310 ((beginning-of-buffer end-of-buffer) (ding)))
2311 (line-move (- arg)))
2312 nil)
2314 (defcustom track-eol nil
2315 "*Non-nil means vertical motion starting at end of line keeps to ends of lines.
2316 This means moving to the end of each line moved onto.
2317 The beginning of a blank line does not count as the end of a line."
2318 :type 'boolean
2319 :group 'editing-basics)
2321 (defcustom goal-column nil
2322 "*Semipermanent goal column for vertical motion, as set by \\[set-goal-column], or nil."
2323 :type '(choice integer
2324 (const :tag "None" nil))
2325 :group 'editing-basics)
2326 (make-variable-buffer-local 'goal-column)
2328 (defvar temporary-goal-column 0
2329 "Current goal column for vertical motion.
2330 It is the column where point was
2331 at the start of current run of vertical motion commands.
2332 When the `track-eol' feature is doing its job, the value is 9999.")
2334 (defcustom line-move-ignore-invisible nil
2335 "*Non-nil means \\[next-line] and \\[previous-line] ignore invisible lines.
2336 Outline mode sets this."
2337 :type 'boolean
2338 :group 'editing-basics)
2340 ;; This is the guts of next-line and previous-line.
2341 ;; Arg says how many lines to move.
2342 (defun line-move (arg)
2343 ;; Don't run any point-motion hooks, and disregard intangibility,
2344 ;; for intermediate positions.
2345 (let ((inhibit-point-motion-hooks t)
2346 (opoint (point))
2347 new line-end line-beg)
2348 (unwind-protect
2349 (progn
2350 (if (not (or (eq last-command 'next-line)
2351 (eq last-command 'previous-line)))
2352 (setq temporary-goal-column
2353 (if (and track-eol (eolp)
2354 ;; Don't count beg of empty line as end of line
2355 ;; unless we just did explicit end-of-line.
2356 (or (not (bolp)) (eq last-command 'end-of-line)))
2357 9999
2358 (current-column))))
2359 (if (and (not (integerp selective-display))
2360 (not line-move-ignore-invisible))
2361 ;; Use just newline characters.
2362 (or (if (> arg 0)
2363 (progn (if (> arg 1) (forward-line (1- arg)))
2364 ;; This way of moving forward ARG lines
2365 ;; verifies that we have a newline after the last one.
2366 ;; It doesn't get confused by intangible text.
2367 (end-of-line)
2368 (zerop (forward-line 1)))
2369 (and (zerop (forward-line arg))
2370 (bolp)))
2371 (signal (if (< arg 0)
2372 'beginning-of-buffer
2373 'end-of-buffer)
2374 nil))
2375 ;; Move by arg lines, but ignore invisible ones.
2376 (while (> arg 0)
2377 (end-of-line)
2378 (and (zerop (vertical-motion 1))
2379 (signal 'end-of-buffer nil))
2380 ;; If the following character is currently invisible,
2381 ;; skip all characters with that same `invisible' property value.
2382 (while (and (not (eobp))
2383 (let ((prop
2384 (get-char-property (point) 'invisible)))
2385 (if (eq buffer-invisibility-spec t)
2386 prop
2387 (or (memq prop buffer-invisibility-spec)
2388 (assq prop buffer-invisibility-spec)))))
2389 (if (get-text-property (point) 'invisible)
2390 (goto-char (next-single-property-change (point) 'invisible))
2391 (goto-char (next-overlay-change (point)))))
2392 (setq arg (1- arg)))
2393 (while (< arg 0)
2394 (beginning-of-line)
2395 (and (zerop (vertical-motion -1))
2396 (signal 'beginning-of-buffer nil))
2397 (while (and (not (bobp))
2398 (let ((prop
2399 (get-char-property (1- (point)) 'invisible)))
2400 (if (eq buffer-invisibility-spec t)
2401 prop
2402 (or (memq prop buffer-invisibility-spec)
2403 (assq prop buffer-invisibility-spec)))))
2404 (if (get-text-property (1- (point)) 'invisible)
2405 (goto-char (previous-single-property-change (point) 'invisible))
2406 (goto-char (previous-overlay-change (point)))))
2407 (setq arg (1+ arg))))
2408 (let ((buffer-invisibility-spec nil))
2409 (move-to-column (or goal-column temporary-goal-column))))
2410 (setq new (point))
2411 ;; If we are moving into some intangible text,
2412 ;; look for following text on the same line which isn't intangible
2413 ;; and move there.
2414 (setq line-end (save-excursion (end-of-line) (point)))
2415 (setq line-beg (save-excursion (beginning-of-line) (point)))
2416 (let ((after (and (< new (point-max))
2417 (get-char-property new 'intangible)))
2418 (before (and (> new (point-min))
2419 (get-char-property (1- new) 'intangible))))
2420 (when (and before (eq before after)
2421 (not (bolp)))
2422 (goto-char (point-min))
2423 (let ((inhibit-point-motion-hooks nil))
2424 (goto-char new))
2425 (if (<= new line-end)
2426 (setq new (point)))))
2427 ;; NEW is where we want to move to.
2428 ;; LINE-BEG and LINE-END are the beginning and end of the line.
2429 ;; Move there in just one step, from our starting position,
2430 ;; with intangibility and point-motion hooks enabled this time.
2431 (goto-char opoint)
2432 (setq inhibit-point-motion-hooks nil)
2433 (goto-char (constrain-to-field new opoint nil t
2434 'inhibit-line-move-field-capture))
2435 ;; If intangibility processing moved us to a different line,
2436 ;; readjust the horizontal position within the line we ended up at.
2437 (when (or (< (point) line-beg) (> (point) line-end))
2438 (setq new (point))
2439 (setq inhibit-point-motion-hooks t)
2440 (setq line-end (save-excursion (end-of-line) (point)))
2441 (beginning-of-line)
2442 (setq line-beg (point))
2443 (let ((buffer-invisibility-spec nil))
2444 (move-to-column (or goal-column temporary-goal-column)))
2445 (if (<= (point) line-end)
2446 (setq new (point)))
2447 (goto-char (point-min))
2448 (setq inhibit-point-motion-hooks nil)
2449 (goto-char (constrain-to-field new opoint nil t
2450 'inhibit-line-move-field-capture))
2452 nil)
2454 ;;; Many people have said they rarely use this feature, and often type
2455 ;;; it by accident. Maybe it shouldn't even be on a key.
2456 (put 'set-goal-column 'disabled t)
2458 (defun set-goal-column (arg)
2459 "Set the current horizontal position as a goal for \\[next-line] and \\[previous-line].
2460 Those commands will move to this position in the line moved to
2461 rather than trying to keep the same horizontal position.
2462 With a non-nil argument, clears out the goal column
2463 so that \\[next-line] and \\[previous-line] resume vertical motion.
2464 The goal column is stored in the variable `goal-column'."
2465 (interactive "P")
2466 (if arg
2467 (progn
2468 (setq goal-column nil)
2469 (message "No goal column"))
2470 (setq goal-column (current-column))
2471 (message (substitute-command-keys
2472 "Goal column %d (use \\[set-goal-column] with an arg to unset it)")
2473 goal-column))
2474 nil)
2477 (defun scroll-other-window-down (lines)
2478 "Scroll the \"other window\" down.
2479 For more details, see the documentation for `scroll-other-window'."
2480 (interactive "P")
2481 (scroll-other-window
2482 ;; Just invert the argument's meaning.
2483 ;; We can do that without knowing which window it will be.
2484 (if (eq lines '-) nil
2485 (if (null lines) '-
2486 (- (prefix-numeric-value lines))))))
2487 (define-key esc-map [?\C-\S-v] 'scroll-other-window-down)
2489 (defun beginning-of-buffer-other-window (arg)
2490 "Move point to the beginning of the buffer in the other window.
2491 Leave mark at previous position.
2492 With arg N, put point N/10 of the way from the true beginning."
2493 (interactive "P")
2494 (let ((orig-window (selected-window))
2495 (window (other-window-for-scrolling)))
2496 ;; We use unwind-protect rather than save-window-excursion
2497 ;; because the latter would preserve the things we want to change.
2498 (unwind-protect
2499 (progn
2500 (select-window window)
2501 ;; Set point and mark in that window's buffer.
2502 (beginning-of-buffer arg)
2503 ;; Set point accordingly.
2504 (recenter '(t)))
2505 (select-window orig-window))))
2507 (defun end-of-buffer-other-window (arg)
2508 "Move point to the end of the buffer in the other window.
2509 Leave mark at previous position.
2510 With arg N, put point N/10 of the way from the true end."
2511 (interactive "P")
2512 ;; See beginning-of-buffer-other-window for comments.
2513 (let ((orig-window (selected-window))
2514 (window (other-window-for-scrolling)))
2515 (unwind-protect
2516 (progn
2517 (select-window window)
2518 (end-of-buffer arg)
2519 (recenter '(t)))
2520 (select-window orig-window))))
2522 (defun transpose-chars (arg)
2523 "Interchange characters around point, moving forward one character.
2524 With prefix arg ARG, effect is to take character before point
2525 and drag it forward past ARG other characters (backward if ARG negative).
2526 If no argument and at end of line, the previous two chars are exchanged."
2527 (interactive "*P")
2528 (and (null arg) (eolp) (forward-char -1))
2529 (transpose-subr 'forward-char (prefix-numeric-value arg)))
2531 (defun transpose-words (arg)
2532 "Interchange words around point, leaving point at end of them.
2533 With prefix arg ARG, effect is to take word before or around point
2534 and drag it forward past ARG other words (backward if ARG negative).
2535 If ARG is zero, the words around or after point and around or after mark
2536 are interchanged."
2537 (interactive "*p")
2538 (transpose-subr 'forward-word arg))
2540 (defun transpose-sexps (arg)
2541 "Like \\[transpose-words] but applies to sexps.
2542 Does not work on a sexp that point is in the middle of
2543 if it is a list or string."
2544 (interactive "*p")
2545 (transpose-subr 'forward-sexp arg))
2547 (defun transpose-lines (arg)
2548 "Exchange current line and previous line, leaving point after both.
2549 With argument ARG, takes previous line and moves it past ARG lines.
2550 With argument 0, interchanges line point is in with line mark is in."
2551 (interactive "*p")
2552 (transpose-subr (function
2553 (lambda (arg)
2554 (if (> arg 0)
2555 (progn
2556 ;; Move forward over ARG lines,
2557 ;; but create newlines if necessary.
2558 (setq arg (forward-line arg))
2559 (if (/= (preceding-char) ?\n)
2560 (setq arg (1+ arg)))
2561 (if (> arg 0)
2562 (newline arg)))
2563 (forward-line arg))))
2564 arg))
2566 (defvar transpose-subr-start1)
2567 (defvar transpose-subr-start2)
2568 (defvar transpose-subr-end1)
2569 (defvar transpose-subr-end2)
2571 (defun transpose-subr (mover arg)
2572 (let (transpose-subr-start1
2573 transpose-subr-end1
2574 transpose-subr-start2
2575 transpose-subr-end2)
2576 (if (= arg 0)
2577 (progn
2578 (save-excursion
2579 (funcall mover 1)
2580 (setq transpose-subr-end2 (point))
2581 (funcall mover -1)
2582 (setq transpose-subr-start2 (point))
2583 (goto-char (mark))
2584 (funcall mover 1)
2585 (setq transpose-subr-end1 (point))
2586 (funcall mover -1)
2587 (setq transpose-subr-start1 (point))
2588 (transpose-subr-1))
2589 (exchange-point-and-mark))
2590 (if (> arg 0)
2591 (progn
2592 (funcall mover -1)
2593 (setq transpose-subr-start1 (point))
2594 (funcall mover 1)
2595 (setq transpose-subr-end1 (point))
2596 (funcall mover arg)
2597 (setq transpose-subr-end2 (point))
2598 (funcall mover (- arg))
2599 (setq transpose-subr-start2 (point))
2600 (transpose-subr-1)
2601 (goto-char transpose-subr-end2))
2602 (funcall mover -1)
2603 (setq transpose-subr-start2 (point))
2604 (funcall mover 1)
2605 (setq transpose-subr-end2 (point))
2606 (funcall mover (1- arg))
2607 (setq transpose-subr-start1 (point))
2608 (funcall mover (- arg))
2609 (setq transpose-subr-end1 (point))
2610 (transpose-subr-1)))))
2612 (defun transpose-subr-1 ()
2613 (if (> (min transpose-subr-end1 transpose-subr-end2)
2614 (max transpose-subr-start1 transpose-subr-start2))
2615 (error "Don't have two things to transpose"))
2616 (let* ((word1 (buffer-substring transpose-subr-start1 transpose-subr-end1))
2617 (len1 (length word1))
2618 (word2 (buffer-substring transpose-subr-start2 transpose-subr-end2))
2619 (len2 (length word2)))
2620 (delete-region transpose-subr-start2 transpose-subr-end2)
2621 (goto-char transpose-subr-start2)
2622 (insert word1)
2623 (goto-char (if (< transpose-subr-start1 transpose-subr-start2)
2624 transpose-subr-start1
2625 (+ transpose-subr-start1 (- len1 len2))))
2626 (delete-region (point) (+ (point) len1))
2627 (insert word2)))
2629 (defvar comment-indent-hook nil
2630 "Obsolete variable for function to compute desired indentation for a comment.
2631 This function is called with no args with point at the beginning of
2632 the comment's starting delimiter.")
2634 (defun backward-word (arg)
2635 "Move backward until encountering the end of a word.
2636 With argument, do this that many times.
2637 In programs, it is faster to call `forward-word' with negative arg."
2638 (interactive "p")
2639 (forward-word (- arg)))
2641 (defun mark-word (arg)
2642 "Set mark arg words away from point."
2643 (interactive "p")
2644 (push-mark
2645 (save-excursion
2646 (forward-word arg)
2647 (point))
2648 nil t))
2650 (defun kill-word (arg)
2651 "Kill characters forward until encountering the end of a word.
2652 With argument, do this that many times."
2653 (interactive "p")
2654 (kill-region (point) (progn (forward-word arg) (point))))
2656 (defun backward-kill-word (arg)
2657 "Kill characters backward until encountering the end of a word.
2658 With argument, do this that many times."
2659 (interactive "p")
2660 (kill-word (- arg)))
2662 (defun current-word (&optional strict)
2663 "Return the word point is on (or a nearby word) as a string.
2664 If optional arg STRICT is non-nil, return nil unless point is within
2665 or adjacent to a word."
2666 (save-excursion
2667 (let ((oldpoint (point)) (start (point)) (end (point)))
2668 (skip-syntax-backward "w_") (setq start (point))
2669 (goto-char oldpoint)
2670 (skip-syntax-forward "w_") (setq end (point))
2671 (if (and (eq start oldpoint) (eq end oldpoint))
2672 ;; Point is neither within nor adjacent to a word.
2673 (and (not strict)
2674 (progn
2675 ;; Look for preceding word in same line.
2676 (skip-syntax-backward "^w_"
2677 (save-excursion (beginning-of-line)
2678 (point)))
2679 (if (bolp)
2680 ;; No preceding word in same line.
2681 ;; Look for following word in same line.
2682 (progn
2683 (skip-syntax-forward "^w_"
2684 (save-excursion (end-of-line)
2685 (point)))
2686 (setq start (point))
2687 (skip-syntax-forward "w_")
2688 (setq end (point)))
2689 (setq end (point))
2690 (skip-syntax-backward "w_")
2691 (setq start (point)))
2692 (buffer-substring-no-properties start end)))
2693 (buffer-substring-no-properties start end)))))
2695 (defcustom fill-prefix nil
2696 "*String for filling to insert at front of new line, or nil for none.
2697 Setting this variable automatically makes it local to the current buffer."
2698 :type '(choice (const :tag "None" nil)
2699 string)
2700 :group 'fill)
2701 (make-variable-buffer-local 'fill-prefix)
2703 (defcustom auto-fill-inhibit-regexp nil
2704 "*Regexp to match lines which should not be auto-filled."
2705 :type '(choice (const :tag "None" nil)
2706 regexp)
2707 :group 'fill)
2709 (defvar comment-line-break-function 'indent-new-comment-line
2710 "*Mode-specific function which line breaks and continues a comment.
2712 This function is only called during auto-filling of a comment section.
2713 The function should take a single optional argument, which is a flag
2714 indicating whether it should use soft newlines.
2716 Setting this variable automatically makes it local to the current buffer.")
2718 ;; This function is used as the auto-fill-function of a buffer
2719 ;; when Auto-Fill mode is enabled.
2720 ;; It returns t if it really did any work.
2721 ;; (Actually some major modes use a different auto-fill function,
2722 ;; but this one is the default one.)
2723 (defun do-auto-fill ()
2724 (let (fc justify bol give-up
2725 (fill-prefix fill-prefix))
2726 (if (or (not (setq justify (current-justification)))
2727 (null (setq fc (current-fill-column)))
2728 (and (eq justify 'left)
2729 (<= (current-column) fc))
2730 (save-excursion (beginning-of-line)
2731 (setq bol (point))
2732 (and auto-fill-inhibit-regexp
2733 (looking-at auto-fill-inhibit-regexp))))
2734 nil ;; Auto-filling not required
2735 (if (memq justify '(full center right))
2736 (save-excursion (unjustify-current-line)))
2738 ;; Choose a fill-prefix automatically.
2739 (if (and adaptive-fill-mode
2740 (or (null fill-prefix) (string= fill-prefix "")))
2741 (let ((prefix
2742 (fill-context-prefix
2743 (save-excursion (backward-paragraph 1) (point))
2744 (save-excursion (forward-paragraph 1) (point)))))
2745 (and prefix (not (equal prefix ""))
2746 (setq fill-prefix prefix))))
2748 (while (and (not give-up) (> (current-column) fc))
2749 ;; Determine where to split the line.
2750 (let* (after-prefix
2751 (fill-point
2752 (let ((opoint (point))
2753 bounce
2754 (first t))
2755 (save-excursion
2756 (beginning-of-line)
2757 (setq after-prefix (point))
2758 (and fill-prefix
2759 (looking-at (regexp-quote fill-prefix))
2760 (setq after-prefix (match-end 0)))
2761 (move-to-column (1+ fc))
2762 ;; Move back to the point where we can break the line.
2763 ;; We break the line between word or
2764 ;; after/before the character which has character
2765 ;; category `|'. We search space, \c| followed by
2766 ;; a character, or \c| following a character. If
2767 ;; not found, place the point at beginning of line.
2768 (while (or first
2769 ;; If this is after period and a single space,
2770 ;; move back once more--we don't want to break
2771 ;; the line there and make it look like a
2772 ;; sentence end.
2773 (and (not (bobp))
2774 (not bounce)
2775 sentence-end-double-space
2776 (save-excursion (forward-char -1)
2777 (and (looking-at "\\. ")
2778 (not (looking-at "\\. ")))))
2779 (and (not (bobp))
2780 (not bounce)
2781 fill-nobreak-predicate
2782 (funcall fill-nobreak-predicate)))
2783 (setq first nil)
2784 (re-search-backward "[ \t]\\|\\c|.\\|.\\c|\\|^")
2785 ;; If we find nowhere on the line to break it,
2786 ;; break after one word. Set bounce to t
2787 ;; so we will not keep going in this while loop.
2788 (if (<= (point) after-prefix)
2789 (progn
2790 (goto-char after-prefix)
2791 (re-search-forward "[ \t]" opoint t)
2792 (setq bounce t))
2793 (if (looking-at "[ \t]")
2794 ;; Break the line at word boundary.
2795 (skip-chars-backward " \t")
2796 ;; Break the line after/before \c|.
2797 (forward-char 1))))
2798 (if enable-multibyte-characters
2799 ;; If we are going to break the line after or
2800 ;; before a non-ascii character, we may have
2801 ;; to run a special function for the charset
2802 ;; of the character to find the correct break
2803 ;; point.
2804 (if (not (and (eq (charset-after (1- (point))) 'ascii)
2805 (eq (charset-after (point)) 'ascii)))
2806 (fill-find-break-point after-prefix)))
2808 ;; Let fill-point be set to the place where we end up.
2809 ;; But move back before any whitespace here.
2810 (skip-chars-backward " \t")
2811 (point)))))
2813 ;; See whether the place we found is any good.
2814 (if (save-excursion
2815 (goto-char fill-point)
2816 (and (not (bolp))
2817 ;; There is no use breaking at end of line.
2818 (not (save-excursion (skip-chars-forward " ") (eolp)))
2819 ;; It is futile to split at the end of the prefix
2820 ;; since we would just insert the prefix again.
2821 (not (and after-prefix (<= (point) after-prefix)))
2822 ;; Don't split right after a comment starter
2823 ;; since we would just make another comment starter.
2824 (not (and comment-start-skip
2825 (let ((limit (point)))
2826 (beginning-of-line)
2827 (and (re-search-forward comment-start-skip
2828 limit t)
2829 (eq (point) limit)))))))
2830 ;; Ok, we have a useful place to break the line. Do it.
2831 (let ((prev-column (current-column)))
2832 ;; If point is at the fill-point, do not `save-excursion'.
2833 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
2834 ;; point will end up before it rather than after it.
2835 (if (save-excursion
2836 (skip-chars-backward " \t")
2837 (= (point) fill-point))
2838 (funcall comment-line-break-function t)
2839 (save-excursion
2840 (goto-char fill-point)
2841 (funcall comment-line-break-function t)))
2842 ;; Now do justification, if required
2843 (if (not (eq justify 'left))
2844 (save-excursion
2845 (end-of-line 0)
2846 (justify-current-line justify nil t)))
2847 ;; If making the new line didn't reduce the hpos of
2848 ;; the end of the line, then give up now;
2849 ;; trying again will not help.
2850 (if (>= (current-column) prev-column)
2851 (setq give-up t)))
2852 ;; No good place to break => stop trying.
2853 (setq give-up t))))
2854 ;; Justify last line.
2855 (justify-current-line justify t t)
2856 t)))
2858 (defvar normal-auto-fill-function 'do-auto-fill
2859 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
2860 Some major modes set this.")
2862 (defun auto-fill-mode (&optional arg)
2863 "Toggle Auto Fill mode.
2864 With arg, turn Auto Fill mode on if and only if arg is positive.
2865 In Auto Fill mode, inserting a space at a column beyond `current-fill-column'
2866 automatically breaks the line at a previous space.
2868 The value of `normal-auto-fill-function' specifies the function to use
2869 for `auto-fill-function' when turning Auto Fill mode on."
2870 (interactive "P")
2871 (prog1 (setq auto-fill-function
2872 (if (if (null arg)
2873 (not auto-fill-function)
2874 (> (prefix-numeric-value arg) 0))
2875 normal-auto-fill-function
2876 nil))
2877 (force-mode-line-update)))
2879 ;; This holds a document string used to document auto-fill-mode.
2880 (defun auto-fill-function ()
2881 "Automatically break line at a previous space, in insertion of text."
2882 nil)
2884 (defun turn-on-auto-fill ()
2885 "Unconditionally turn on Auto Fill mode."
2886 (auto-fill-mode 1))
2888 (defun turn-off-auto-fill ()
2889 "Unconditionally turn off Auto Fill mode."
2890 (auto-fill-mode -1))
2892 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
2894 (defun set-fill-column (arg)
2895 "Set `fill-column' to specified argument.
2896 Use \\[universal-argument] followed by a number to specify a column.
2897 Just \\[universal-argument] as argument means to use the current column."
2898 (interactive "P")
2899 (if (consp arg)
2900 (setq arg (current-column)))
2901 (if (not (integerp arg))
2902 ;; Disallow missing argument; it's probably a typo for C-x C-f.
2903 (error "set-fill-column requires an explicit argument")
2904 (message "Fill column set to %d (was %d)" arg fill-column)
2905 (setq fill-column arg)))
2907 (defun set-selective-display (arg)
2908 "Set `selective-display' to ARG; clear it if no arg.
2909 When the value of `selective-display' is a number > 0,
2910 lines whose indentation is >= that value are not displayed.
2911 The variable `selective-display' has a separate value for each buffer."
2912 (interactive "P")
2913 (if (eq selective-display t)
2914 (error "selective-display already in use for marked lines"))
2915 (let ((current-vpos
2916 (save-restriction
2917 (narrow-to-region (point-min) (point))
2918 (goto-char (window-start))
2919 (vertical-motion (window-height)))))
2920 (setq selective-display
2921 (and arg (prefix-numeric-value arg)))
2922 (recenter current-vpos))
2923 (set-window-start (selected-window) (window-start (selected-window)))
2924 (princ "selective-display set to " t)
2925 (prin1 selective-display t)
2926 (princ "." t))
2928 (defvar overwrite-mode-textual " Ovwrt"
2929 "The string displayed in the mode line when in overwrite mode.")
2930 (defvar overwrite-mode-binary " Bin Ovwrt"
2931 "The string displayed in the mode line when in binary overwrite mode.")
2933 (defun overwrite-mode (arg)
2934 "Toggle overwrite mode.
2935 With arg, turn overwrite mode on iff arg is positive.
2936 In overwrite mode, printing characters typed in replace existing text
2937 on a one-for-one basis, rather than pushing it to the right. At the
2938 end of a line, such characters extend the line. Before a tab,
2939 such characters insert until the tab is filled in.
2940 \\[quoted-insert] still inserts characters in overwrite mode; this
2941 is supposed to make it easier to insert characters when necessary."
2942 (interactive "P")
2943 (setq overwrite-mode
2944 (if (if (null arg) (not overwrite-mode)
2945 (> (prefix-numeric-value arg) 0))
2946 'overwrite-mode-textual))
2947 (force-mode-line-update))
2949 (defun binary-overwrite-mode (arg)
2950 "Toggle binary overwrite mode.
2951 With arg, turn binary overwrite mode on iff arg is positive.
2952 In binary overwrite mode, printing characters typed in replace
2953 existing text. Newlines are not treated specially, so typing at the
2954 end of a line joins the line to the next, with the typed character
2955 between them. Typing before a tab character simply replaces the tab
2956 with the character typed.
2957 \\[quoted-insert] replaces the text at the cursor, just as ordinary
2958 typing characters do.
2960 Note that binary overwrite mode is not its own minor mode; it is a
2961 specialization of overwrite-mode, entered by setting the
2962 `overwrite-mode' variable to `overwrite-mode-binary'."
2963 (interactive "P")
2964 (setq overwrite-mode
2965 (if (if (null arg)
2966 (not (eq overwrite-mode 'overwrite-mode-binary))
2967 (> (prefix-numeric-value arg) 0))
2968 'overwrite-mode-binary))
2969 (force-mode-line-update))
2971 (defcustom line-number-mode t
2972 "*Non-nil means display line number in mode line."
2973 :type 'boolean
2974 :group 'editing-basics)
2976 (defun line-number-mode (arg)
2977 "Toggle Line Number mode.
2978 With arg, turn Line Number mode on iff arg is positive.
2979 When Line Number mode is enabled, the line number appears
2980 in the mode line.
2982 Line numbers do not appear for very large buffers, see variable
2983 `line-number-display-limit'."
2984 (interactive "P")
2985 (setq line-number-mode
2986 (if (null arg) (not line-number-mode)
2987 (> (prefix-numeric-value arg) 0)))
2988 (force-mode-line-update))
2990 (defcustom column-number-mode nil
2991 "*Non-nil means display column number in mode line."
2992 :type 'boolean
2993 :group 'editing-basics)
2995 (defun column-number-mode (arg)
2996 "Toggle Column Number mode.
2997 With arg, turn Column Number mode on iff arg is positive.
2998 When Column Number mode is enabled, the column number appears
2999 in the mode line."
3000 (interactive "P")
3001 (setq column-number-mode
3002 (if (null arg) (not column-number-mode)
3003 (> (prefix-numeric-value arg) 0)))
3004 (force-mode-line-update))
3006 (defgroup paren-blinking nil
3007 "Blinking matching of parens and expressions."
3008 :prefix "blink-matching-"
3009 :group 'paren-matching)
3011 (defcustom blink-matching-paren t
3012 "*Non-nil means show matching open-paren when close-paren is inserted."
3013 :type 'boolean
3014 :group 'paren-blinking)
3016 (defcustom blink-matching-paren-on-screen t
3017 "*Non-nil means show matching open-paren when it is on screen.
3018 If nil, means don't show it (but the open-paren can still be shown
3019 when it is off screen)."
3020 :type 'boolean
3021 :group 'paren-blinking)
3023 (defcustom blink-matching-paren-distance (* 25 1024)
3024 "*If non-nil, is maximum distance to search for matching open-paren."
3025 :type 'integer
3026 :group 'paren-blinking)
3028 (defcustom blink-matching-delay 1
3029 "*Time in seconds to delay after showing a matching paren."
3030 :type 'number
3031 :group 'paren-blinking)
3033 (defcustom blink-matching-paren-dont-ignore-comments nil
3034 "*Non-nil means `blink-matching-paren' will not ignore comments."
3035 :type 'boolean
3036 :group 'paren-blinking)
3038 (defun blink-matching-open ()
3039 "Move cursor momentarily to the beginning of the sexp before point."
3040 (interactive)
3041 (and (> (point) (1+ (point-min)))
3042 blink-matching-paren
3043 ;; Verify an even number of quoting characters precede the close.
3044 (= 1 (logand 1 (- (point)
3045 (save-excursion
3046 (forward-char -1)
3047 (skip-syntax-backward "/\\")
3048 (point)))))
3049 (let* ((oldpos (point))
3050 (blinkpos)
3051 (mismatch))
3052 (save-excursion
3053 (save-restriction
3054 (if blink-matching-paren-distance
3055 (narrow-to-region (max (point-min)
3056 (- (point) blink-matching-paren-distance))
3057 oldpos))
3058 (condition-case ()
3059 (let ((parse-sexp-ignore-comments
3060 (and parse-sexp-ignore-comments
3061 (not blink-matching-paren-dont-ignore-comments))))
3062 (setq blinkpos (scan-sexps oldpos -1)))
3063 (error nil)))
3064 (and blinkpos
3065 (/= (char-syntax (char-after blinkpos))
3066 ?\$)
3067 (setq mismatch
3068 (or (null (matching-paren (char-after blinkpos)))
3069 (/= (char-after (1- oldpos))
3070 (matching-paren (char-after blinkpos))))))
3071 (if mismatch (setq blinkpos nil))
3072 (if blinkpos
3073 ;; Don't log messages about paren matching.
3074 (let (message-log-max)
3075 (goto-char blinkpos)
3076 (if (pos-visible-in-window-p)
3077 (and blink-matching-paren-on-screen
3078 (sit-for blink-matching-delay))
3079 (goto-char blinkpos)
3080 (message
3081 "Matches %s"
3082 ;; Show what precedes the open in its line, if anything.
3083 (if (save-excursion
3084 (skip-chars-backward " \t")
3085 (not (bolp)))
3086 (buffer-substring (progn (beginning-of-line) (point))
3087 (1+ blinkpos))
3088 ;; Show what follows the open in its line, if anything.
3089 (if (save-excursion
3090 (forward-char 1)
3091 (skip-chars-forward " \t")
3092 (not (eolp)))
3093 (buffer-substring blinkpos
3094 (progn (end-of-line) (point)))
3095 ;; Otherwise show the previous nonblank line,
3096 ;; if there is one.
3097 (if (save-excursion
3098 (skip-chars-backward "\n \t")
3099 (not (bobp)))
3100 (concat
3101 (buffer-substring (progn
3102 (skip-chars-backward "\n \t")
3103 (beginning-of-line)
3104 (point))
3105 (progn (end-of-line)
3106 (skip-chars-backward " \t")
3107 (point)))
3108 ;; Replace the newline and other whitespace with `...'.
3109 "..."
3110 (buffer-substring blinkpos (1+ blinkpos)))
3111 ;; There is nothing to show except the char itself.
3112 (buffer-substring blinkpos (1+ blinkpos))))))))
3113 (cond (mismatch
3114 (message "Mismatched parentheses"))
3115 ((not blink-matching-paren-distance)
3116 (message "Unmatched parenthesis"))))))))
3118 ;Turned off because it makes dbx bomb out.
3119 (setq blink-paren-function 'blink-matching-open)
3121 ;; This executes C-g typed while Emacs is waiting for a command.
3122 ;; Quitting out of a program does not go through here;
3123 ;; that happens in the QUIT macro at the C code level.
3124 (defun keyboard-quit ()
3125 "Signal a `quit' condition.
3126 During execution of Lisp code, this character causes a quit directly.
3127 At top-level, as an editor command, this simply beeps."
3128 (interactive)
3129 (deactivate-mark)
3130 (signal 'quit nil))
3132 (define-key global-map "\C-g" 'keyboard-quit)
3134 (defvar buffer-quit-function nil
3135 "Function to call to \"quit\" the current buffer, or nil if none.
3136 \\[keyboard-escape-quit] calls this function when its more local actions
3137 \(such as cancelling a prefix argument, minibuffer or region) do not apply.")
3139 (defun keyboard-escape-quit ()
3140 "Exit the current \"mode\" (in a generalized sense of the word).
3141 This command can exit an interactive command such as `query-replace',
3142 can clear out a prefix argument or a region,
3143 can get out of the minibuffer or other recursive edit,
3144 cancel the use of the current buffer (for special-purpose buffers),
3145 or go back to just one window (by deleting all but the selected window)."
3146 (interactive)
3147 (cond ((eq last-command 'mode-exited) nil)
3148 ((> (minibuffer-depth) 0)
3149 (abort-recursive-edit))
3150 (current-prefix-arg
3151 nil)
3152 ((and transient-mark-mode
3153 mark-active)
3154 (deactivate-mark))
3155 ((> (recursion-depth) 0)
3156 (exit-recursive-edit))
3157 (buffer-quit-function
3158 (funcall buffer-quit-function))
3159 ((not (one-window-p t))
3160 (delete-other-windows))
3161 ((string-match "^ \\*" (buffer-name (current-buffer)))
3162 (bury-buffer))))
3164 (define-key global-map "\e\e\e" 'keyboard-escape-quit)
3166 (defcustom input-mode-8-bit t
3167 "Control acceptance of 8-bit keyboard input.
3168 This may be useful for inputting non-ASCII characters if your keyboard
3169 can generate them. It is not necessary to change this under a window
3170 system which can distinguish 8-bit characters and Meta keys.
3171 Setting this variable directly does not take effect;
3172 use either M-x customize or the function `set-input-mode'."
3173 :set (lambda (symbol value)
3174 (let ((mode (current-input-mode)))
3175 (set-input-mode (nth 0 mode) (nth 1 mode) value)))
3176 :initialize 'custom-initialize-default
3177 :type '(choice (const :tag "8-bit input for a Meta key" t)
3178 (const :tag "Direct 8-bit character input" 0)
3179 (const :tag "Assume top bit is parity and ignore" nil))
3180 :version "21.1"
3181 :link '(custom-manual "Single-Byte European Support")
3182 :group 'keyboard)
3184 (defcustom read-mail-command 'rmail
3185 "*Your preference for a mail reading package.
3186 This is used by some keybindings which support reading mail."
3187 :type '(choice (function-item rmail)
3188 (function-item gnus)
3189 (function-item mh-rmail)
3190 (function :tag "Other"))
3191 :version "21.1"
3192 :group 'mail)
3194 (defcustom mail-user-agent 'sendmail-user-agent
3195 "*Your preference for a mail composition package.
3196 Various Emacs Lisp packages (e.g. reporter) require you to compose an
3197 outgoing email message. This variable lets you specify which
3198 mail-sending package you prefer.
3200 Valid values include:
3202 `sendmail-user-agent' -- use the default Emacs Mail package
3203 `mh-e-user-agent' -- use the Emacs interface to the MH mail system
3204 `message-user-agent' -- use the GNUS mail sending package
3206 Additional valid symbols may be available; check with the author of
3207 your package for details."
3208 :type '(radio (function-item :tag "Default Emacs mail"
3209 :format "%t\n"
3210 sendmail-user-agent)
3211 (function-item :tag "Emacs interface to MH"
3212 :format "%t\n"
3213 mh-e-user-agent)
3214 (function-item :tag "Gnus mail sending package"
3215 :format "%t\n"
3216 message-user-agent)
3217 (function :tag "Other"))
3218 :group 'mail)
3220 (defun define-mail-user-agent (symbol composefunc sendfunc
3221 &optional abortfunc hookvar)
3222 "Define a symbol to identify a mail-sending package for `mail-user-agent'.
3224 SYMBOL can be any Lisp symbol. Its function definition and/or
3225 value as a variable do not matter for this usage; we use only certain
3226 properties on its property list, to encode the rest of the arguments.
3228 COMPOSEFUNC is program callable function that composes an outgoing
3229 mail message buffer. This function should set up the basics of the
3230 buffer without requiring user interaction. It should populate the
3231 standard mail headers, leaving the `to:' and `subject:' headers blank
3232 by default.
3234 COMPOSEFUNC should accept several optional arguments--the same
3235 arguments that `compose-mail' takes. See that function's documentation.
3237 SENDFUNC is the command a user would run to send the message.
3239 Optional ABORTFUNC is the command a user would run to abort the
3240 message. For mail packages that don't have a separate abort function,
3241 this can be `kill-buffer' (the equivalent of omitting this argument).
3243 Optional HOOKVAR is a hook variable that gets run before the message
3244 is actually sent. Callers that use the `mail-user-agent' may
3245 install a hook function temporarily on this hook variable.
3246 If HOOKVAR is nil, `mail-send-hook' is used.
3248 The properties used on SYMBOL are `composefunc', `sendfunc',
3249 `abortfunc', and `hookvar'."
3250 (put symbol 'composefunc composefunc)
3251 (put symbol 'sendfunc sendfunc)
3252 (put symbol 'abortfunc (or abortfunc 'kill-buffer))
3253 (put symbol 'hookvar (or hookvar 'mail-send-hook)))
3255 (define-mail-user-agent 'sendmail-user-agent
3256 'sendmail-user-agent-compose
3257 'mail-send-and-exit)
3259 (defun rfc822-goto-eoh ()
3260 ;; Go to header delimiter line in a mail message, following RFC822 rules
3261 (goto-char (point-min))
3262 (while (looking-at "^[^: \n]+:\\|^[ \t]")
3263 (forward-line 1))
3264 (point))
3266 (defun sendmail-user-agent-compose (&optional to subject other-headers continue
3267 switch-function yank-action
3268 send-actions)
3269 (if switch-function
3270 (let ((special-display-buffer-names nil)
3271 (special-display-regexps nil)
3272 (same-window-buffer-names nil)
3273 (same-window-regexps nil))
3274 (funcall switch-function "*mail*")))
3275 (let ((cc (cdr (assoc-ignore-case "cc" other-headers)))
3276 (in-reply-to (cdr (assoc-ignore-case "in-reply-to" other-headers)))
3277 (body (cdr (assoc-ignore-case "body" other-headers))))
3278 (or (mail continue to subject in-reply-to cc yank-action send-actions)
3279 continue
3280 (error "Message aborted"))
3281 (save-excursion
3282 (rfc822-goto-eoh)
3283 (while other-headers
3284 (unless (member-ignore-case (car (car other-headers))
3285 '("in-reply-to" "cc" "body"))
3286 (insert (car (car other-headers)) ": "
3287 (cdr (car other-headers)) "\n"))
3288 (setq other-headers (cdr other-headers)))
3289 (when body
3290 (forward-line 1)
3291 (insert body))
3292 t)))
3294 (define-mail-user-agent 'mh-e-user-agent
3295 'mh-smail-batch 'mh-send-letter 'mh-fully-kill-draft
3296 'mh-before-send-letter-hook)
3298 (defun compose-mail (&optional to subject other-headers continue
3299 switch-function yank-action send-actions)
3300 "Start composing a mail message to send.
3301 This uses the user's chosen mail composition package
3302 as selected with the variable `mail-user-agent'.
3303 The optional arguments TO and SUBJECT specify recipients
3304 and the initial Subject field, respectively.
3306 OTHER-HEADERS is an alist specifying additional
3307 header fields. Elements look like (HEADER . VALUE) where both
3308 HEADER and VALUE are strings.
3310 CONTINUE, if non-nil, says to continue editing a message already
3311 being composed.
3313 SWITCH-FUNCTION, if non-nil, is a function to use to
3314 switch to and display the buffer used for mail composition.
3316 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
3317 to insert the raw text of the message being replied to.
3318 It has the form (FUNCTION . ARGS). The user agent will apply
3319 FUNCTION to ARGS, to insert the raw text of the original message.
3320 \(The user agent will also run `mail-citation-hook', *after* the
3321 original text has been inserted in this way.)
3323 SEND-ACTIONS is a list of actions to call when the message is sent.
3324 Each action has the form (FUNCTION . ARGS)."
3325 (interactive
3326 (list nil nil nil current-prefix-arg))
3327 (let ((function (get mail-user-agent 'composefunc)))
3328 (funcall function to subject other-headers continue
3329 switch-function yank-action send-actions)))
3331 (defun compose-mail-other-window (&optional to subject other-headers continue
3332 yank-action send-actions)
3333 "Like \\[compose-mail], but edit the outgoing message in another window."
3334 (interactive
3335 (list nil nil nil current-prefix-arg))
3336 (compose-mail to subject other-headers continue
3337 'switch-to-buffer-other-window yank-action send-actions))
3340 (defun compose-mail-other-frame (&optional to subject other-headers continue
3341 yank-action send-actions)
3342 "Like \\[compose-mail], but edit the outgoing message in another frame."
3343 (interactive
3344 (list nil nil nil current-prefix-arg))
3345 (compose-mail to subject other-headers continue
3346 'switch-to-buffer-other-frame yank-action send-actions))
3348 (defvar set-variable-value-history nil
3349 "History of values entered with `set-variable'.")
3351 (defun set-variable (var val)
3352 "Set VARIABLE to VALUE. VALUE is a Lisp object.
3353 When using this interactively, enter a Lisp object for VALUE.
3354 If you want VALUE to be a string, you must surround it with doublequotes.
3355 VALUE is used literally, not evaluated.
3357 If VARIABLE has a `variable-interactive' property, that is used as if
3358 it were the arg to `interactive' (which see) to interactively read VALUE.
3360 If VARIABLE has been defined with `defcustom', then the type information
3361 in the definition is used to check that VALUE is valid."
3362 (interactive
3363 (let* ((default-var (variable-at-point))
3364 (var (if (symbolp default-var)
3365 (read-variable (format "Set variable (default %s): " default-var)
3366 default-var)
3367 (read-variable "Set variable: ")))
3368 (minibuffer-help-form '(describe-variable var))
3369 (prop (get var 'variable-interactive))
3370 (prompt (format "Set %s to value: " var))
3371 (val (if prop
3372 ;; Use VAR's `variable-interactive' property
3373 ;; as an interactive spec for prompting.
3374 (call-interactively `(lambda (arg)
3375 (interactive ,prop)
3376 arg))
3377 (read
3378 (read-string prompt nil
3379 'set-variable-value-history)))))
3380 (list var val)))
3382 (let ((type (get var 'custom-type)))
3383 (when type
3384 ;; Match with custom type.
3385 (require 'wid-edit)
3386 (setq type (widget-convert type))
3387 (unless (widget-apply type :match val)
3388 (error "Value `%S' does not match type %S of %S"
3389 val (car type) var))))
3390 (set var val))
3392 ;; Define the major mode for lists of completions.
3394 (defvar completion-list-mode-map nil
3395 "Local map for completion list buffers.")
3396 (or completion-list-mode-map
3397 (let ((map (make-sparse-keymap)))
3398 (define-key map [mouse-2] 'mouse-choose-completion)
3399 (define-key map [down-mouse-2] nil)
3400 (define-key map "\C-m" 'choose-completion)
3401 (define-key map "\e\e\e" 'delete-completion-window)
3402 (define-key map [left] 'previous-completion)
3403 (define-key map [right] 'next-completion)
3404 (setq completion-list-mode-map map)))
3406 ;; Completion mode is suitable only for specially formatted data.
3407 (put 'completion-list-mode 'mode-class 'special)
3409 (defvar completion-reference-buffer nil
3410 "Record the buffer that was current when the completion list was requested.
3411 This is a local variable in the completion list buffer.
3412 Initial value is nil to avoid some compiler warnings.")
3414 (defvar completion-no-auto-exit nil
3415 "Non-nil means `choose-completion-string' should never exit the minibuffer.
3416 This also applies to other functions such as `choose-completion'
3417 and `mouse-choose-completion'.")
3419 (defvar completion-base-size nil
3420 "Number of chars at beginning of minibuffer not involved in completion.
3421 This is a local variable in the completion list buffer
3422 but it talks about the buffer in `completion-reference-buffer'.
3423 If this is nil, it means to compare text to determine which part
3424 of the tail end of the buffer's text is involved in completion.")
3426 (defun delete-completion-window ()
3427 "Delete the completion list window.
3428 Go to the window from which completion was requested."
3429 (interactive)
3430 (let ((buf completion-reference-buffer))
3431 (if (one-window-p t)
3432 (if (window-dedicated-p (selected-window))
3433 (delete-frame (selected-frame)))
3434 (delete-window (selected-window))
3435 (if (get-buffer-window buf)
3436 (select-window (get-buffer-window buf))))))
3438 (defun previous-completion (n)
3439 "Move to the previous item in the completion list."
3440 (interactive "p")
3441 (next-completion (- n)))
3443 (defun next-completion (n)
3444 "Move to the next item in the completion list.
3445 With prefix argument N, move N items (negative N means move backward)."
3446 (interactive "p")
3447 (while (and (> n 0) (not (eobp)))
3448 (let ((prop (get-text-property (point) 'mouse-face))
3449 (end (point-max)))
3450 ;; If in a completion, move to the end of it.
3451 (if prop
3452 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
3453 ;; Move to start of next one.
3454 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
3455 (setq n (1- n)))
3456 (while (and (< n 0) (not (bobp)))
3457 (let ((prop (get-text-property (1- (point)) 'mouse-face))
3458 (end (point-min)))
3459 ;; If in a completion, move to the start of it.
3460 (if prop
3461 (goto-char (previous-single-property-change
3462 (point) 'mouse-face nil end)))
3463 ;; Move to end of the previous completion.
3464 (goto-char (previous-single-property-change (point) 'mouse-face nil end))
3465 ;; Move to the start of that one.
3466 (goto-char (previous-single-property-change (point) 'mouse-face nil end)))
3467 (setq n (1+ n))))
3469 (defun choose-completion ()
3470 "Choose the completion that point is in or next to."
3471 (interactive)
3472 (let (beg end completion (buffer completion-reference-buffer)
3473 (base-size completion-base-size))
3474 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
3475 (setq end (point) beg (1+ (point))))
3476 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
3477 (setq end (1- (point)) beg (point)))
3478 (if (null beg)
3479 (error "No completion here"))
3480 (setq beg (previous-single-property-change beg 'mouse-face))
3481 (setq end (or (next-single-property-change end 'mouse-face) (point-max)))
3482 (setq completion (buffer-substring beg end))
3483 (let ((owindow (selected-window)))
3484 (if (and (one-window-p t 'selected-frame)
3485 (window-dedicated-p (selected-window)))
3486 ;; This is a special buffer's frame
3487 (iconify-frame (selected-frame))
3488 (or (window-dedicated-p (selected-window))
3489 (bury-buffer)))
3490 (select-window owindow))
3491 (choose-completion-string completion buffer base-size)))
3493 ;; Delete the longest partial match for STRING
3494 ;; that can be found before POINT.
3495 (defun choose-completion-delete-max-match (string)
3496 (let ((opoint (point))
3497 (len (min (length string)
3498 (- (point) (point-min)))))
3499 (goto-char (- (point) (length string)))
3500 (if completion-ignore-case
3501 (setq string (downcase string)))
3502 (while (and (> len 0)
3503 (let ((tail (buffer-substring (point)
3504 (+ (point) len))))
3505 (if completion-ignore-case
3506 (setq tail (downcase tail)))
3507 (not (string= tail (substring string 0 len)))))
3508 (setq len (1- len))
3509 (forward-char 1))
3510 (delete-char len)))
3512 ;; Switch to BUFFER and insert the completion choice CHOICE.
3513 ;; BASE-SIZE, if non-nil, says how many characters of BUFFER's text
3514 ;; to keep. If it is nil, use choose-completion-delete-max-match instead.
3516 ;; If BUFFER is the minibuffer, exit the minibuffer
3517 ;; unless it is reading a file name and CHOICE is a directory,
3518 ;; or completion-no-auto-exit is non-nil.
3519 (defun choose-completion-string (choice &optional buffer base-size)
3520 (let ((buffer (or buffer completion-reference-buffer))
3521 (mini-p (string-match "\\` \\*Minibuf-[0-9]+\\*\\'" (buffer-name buffer))))
3522 ;; If BUFFER is a minibuffer, barf unless it's the currently
3523 ;; active minibuffer.
3524 (if (and mini-p
3525 (or (not (active-minibuffer-window))
3526 (not (equal buffer
3527 (window-buffer (active-minibuffer-window))))))
3528 (error "Minibuffer is not active for completion")
3529 ;; Insert the completion into the buffer where completion was requested.
3530 (set-buffer buffer)
3531 (if base-size
3532 (delete-region (+ base-size (if mini-p
3533 (minibuffer-prompt-end)
3534 (point-min)))
3535 (point))
3536 (choose-completion-delete-max-match choice))
3537 (insert choice)
3538 (remove-text-properties (- (point) (length choice)) (point)
3539 '(mouse-face nil))
3540 ;; Update point in the window that BUFFER is showing in.
3541 (let ((window (get-buffer-window buffer t)))
3542 (set-window-point window (point)))
3543 ;; If completing for the minibuffer, exit it with this choice.
3544 (and (not completion-no-auto-exit)
3545 (equal buffer (window-buffer (minibuffer-window)))
3546 minibuffer-completion-table
3547 ;; If this is reading a file name, and the file name chosen
3548 ;; is a directory, don't exit the minibuffer.
3549 (if (and (eq minibuffer-completion-table 'read-file-name-internal)
3550 (file-directory-p (field-string (point-max))))
3551 (select-window (active-minibuffer-window))
3552 (exit-minibuffer))))))
3554 (defun completion-list-mode ()
3555 "Major mode for buffers showing lists of possible completions.
3556 Type \\<completion-list-mode-map>\\[choose-completion] in the completion list\
3557 to select the completion near point.
3558 Use \\<completion-list-mode-map>\\[mouse-choose-completion] to select one\
3559 with the mouse."
3560 (interactive)
3561 (kill-all-local-variables)
3562 (use-local-map completion-list-mode-map)
3563 (setq mode-name "Completion List")
3564 (setq major-mode 'completion-list-mode)
3565 (make-local-variable 'completion-base-size)
3566 (setq completion-base-size nil)
3567 (run-hooks 'completion-list-mode-hook))
3569 (defvar completion-setup-hook nil
3570 "Normal hook run at the end of setting up a completion list buffer.
3571 When this hook is run, the current buffer is the one in which the
3572 command to display the completion list buffer was run.
3573 The completion list buffer is available as the value of `standard-output'.")
3575 ;; This function goes in completion-setup-hook, so that it is called
3576 ;; after the text of the completion list buffer is written.
3578 (defun completion-setup-function ()
3579 (save-excursion
3580 (let ((mainbuf (current-buffer)))
3581 (set-buffer standard-output)
3582 (completion-list-mode)
3583 (make-local-variable 'completion-reference-buffer)
3584 (setq completion-reference-buffer mainbuf)
3585 (if (eq minibuffer-completion-table 'read-file-name-internal)
3586 ;; For file name completion,
3587 ;; use the number of chars before the start of the
3588 ;; last file name component.
3589 (setq completion-base-size
3590 (save-excursion
3591 (set-buffer mainbuf)
3592 (goto-char (point-max))
3593 (skip-chars-backward (format "^%c" directory-sep-char))
3594 (- (point) (minibuffer-prompt-end))))
3595 ;; Otherwise, in minibuffer, the whole input is being completed.
3596 (save-match-data
3597 (if (string-match "\\` \\*Minibuf-[0-9]+\\*\\'"
3598 (buffer-name mainbuf))
3599 (setq completion-base-size 0))))
3600 (goto-char (point-min))
3601 (if (display-mouse-p)
3602 (insert (substitute-command-keys
3603 "Click \\[mouse-choose-completion] on a completion to select it.\n")))
3604 (insert (substitute-command-keys
3605 "In this buffer, type \\[choose-completion] to \
3606 select the completion near point.\n\n")))))
3608 (add-hook 'completion-setup-hook 'completion-setup-function)
3610 (define-key minibuffer-local-completion-map [prior]
3611 'switch-to-completions)
3612 (define-key minibuffer-local-must-match-map [prior]
3613 'switch-to-completions)
3614 (define-key minibuffer-local-completion-map "\M-v"
3615 'switch-to-completions)
3616 (define-key minibuffer-local-must-match-map "\M-v"
3617 'switch-to-completions)
3619 (defun switch-to-completions ()
3620 "Select the completion list window."
3621 (interactive)
3622 ;; Make sure we have a completions window.
3623 (or (get-buffer-window "*Completions*")
3624 (minibuffer-completion-help))
3625 (let ((window (get-buffer-window "*Completions*")))
3626 (when window
3627 (select-window window)
3628 (goto-char (point-min))
3629 (search-forward "\n\n")
3630 (forward-line 1))))
3632 ;; Support keyboard commands to turn on various modifiers.
3634 ;; These functions -- which are not commands -- each add one modifier
3635 ;; to the following event.
3637 (defun event-apply-alt-modifier (ignore-prompt)
3638 "Add the Alt modifier to the following event.
3639 For example, type \\[event-apply-alt-modifier] & to enter Alt-&."
3640 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
3641 (defun event-apply-super-modifier (ignore-prompt)
3642 "Add the Super modifier to the following event.
3643 For example, type \\[event-apply-super-modifier] & to enter Super-&."
3644 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
3645 (defun event-apply-hyper-modifier (ignore-prompt)
3646 "Add the Hyper modifier to the following event.
3647 For example, type \\[event-apply-hyper-modifier] & to enter Hyper-&."
3648 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
3649 (defun event-apply-shift-modifier (ignore-prompt)
3650 "Add the Shift modifier to the following event.
3651 For example, type \\[event-apply-shift-modifier] & to enter Shift-&."
3652 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
3653 (defun event-apply-control-modifier (ignore-prompt)
3654 "Add the Ctrl modifier to the following event.
3655 For example, type \\[event-apply-control-modifier] & to enter Ctrl-&."
3656 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
3657 (defun event-apply-meta-modifier (ignore-prompt)
3658 "Add the Meta modifier to the following event.
3659 For example, type \\[event-apply-meta-modifier] & to enter Meta-&."
3660 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
3662 (defun event-apply-modifier (event symbol lshiftby prefix)
3663 "Apply a modifier flag to event EVENT.
3664 SYMBOL is the name of this modifier, as a symbol.
3665 LSHIFTBY is the numeric value of this modifier, in keyboard events.
3666 PREFIX is the string that represents this modifier in an event type symbol."
3667 (if (numberp event)
3668 (cond ((eq symbol 'control)
3669 (if (and (<= (downcase event) ?z)
3670 (>= (downcase event) ?a))
3671 (- (downcase event) ?a -1)
3672 (if (and (<= (downcase event) ?Z)
3673 (>= (downcase event) ?A))
3674 (- (downcase event) ?A -1)
3675 (logior (lsh 1 lshiftby) event))))
3676 ((eq symbol 'shift)
3677 (if (and (<= (downcase event) ?z)
3678 (>= (downcase event) ?a))
3679 (upcase event)
3680 (logior (lsh 1 lshiftby) event)))
3682 (logior (lsh 1 lshiftby) event)))
3683 (if (memq symbol (event-modifiers event))
3684 event
3685 (let ((event-type (if (symbolp event) event (car event))))
3686 (setq event-type (intern (concat prefix (symbol-name event-type))))
3687 (if (symbolp event)
3688 event-type
3689 (cons event-type (cdr event)))))))
3691 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
3692 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
3693 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
3694 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
3695 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
3696 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
3698 ;;;; Keypad support.
3700 ;;; Make the keypad keys act like ordinary typing keys. If people add
3701 ;;; bindings for the function key symbols, then those bindings will
3702 ;;; override these, so this shouldn't interfere with any existing
3703 ;;; bindings.
3705 ;; Also tell read-char how to handle these keys.
3706 (mapcar
3707 (lambda (keypad-normal)
3708 (let ((keypad (nth 0 keypad-normal))
3709 (normal (nth 1 keypad-normal)))
3710 (put keypad 'ascii-character normal)
3711 (define-key function-key-map (vector keypad) (vector normal))))
3712 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
3713 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
3714 (kp-space ?\ )
3715 (kp-tab ?\t)
3716 (kp-enter ?\r)
3717 (kp-multiply ?*)
3718 (kp-add ?+)
3719 (kp-separator ?,)
3720 (kp-subtract ?-)
3721 (kp-decimal ?.)
3722 (kp-divide ?/)
3723 (kp-equal ?=)))
3725 ;;;;
3726 ;;;; forking a twin copy of a buffer.
3727 ;;;;
3729 (defvar clone-buffer-hook nil
3730 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
3732 (defun clone-process (process &optional newname)
3733 "Create a twin copy of PROCESS.
3734 If NEWNAME is nil, it defaults to PROCESS' name;
3735 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
3736 If PROCESS is associated with a buffer, the new process will be associated
3737 with the current buffer instead.
3738 Returns nil if PROCESS has already terminated."
3739 (setq newname (or newname (process-name process)))
3740 (if (string-match "<[0-9]+>\\'" newname)
3741 (setq newname (substring newname 0 (match-beginning 0))))
3742 (when (memq (process-status process) '(run stop open))
3743 (let* ((process-connection-type (process-tty-name process))
3744 (old-kwoq (process-kill-without-query process nil))
3745 (new-process
3746 (if (memq (process-status process) '(open))
3747 (apply 'open-network-stream newname
3748 (if (process-buffer process) (current-buffer))
3749 (process-contact process))
3750 (apply 'start-process newname
3751 (if (process-buffer process) (current-buffer))
3752 (process-command process)))))
3753 (process-kill-without-query new-process old-kwoq)
3754 (process-kill-without-query process old-kwoq)
3755 (set-process-inherit-coding-system-flag
3756 new-process (process-inherit-coding-system-flag process))
3757 (set-process-filter new-process (process-filter process))
3758 (set-process-sentinel new-process (process-sentinel process))
3759 new-process)))
3761 ;; things to maybe add (currently partly covered by `funcall mode':
3762 ;; - syntax-table
3763 ;; - overlays
3764 (defun clone-buffer (&optional newname display-flag)
3765 "Create a twin copy of the current buffer.
3766 If NEWNAME is nil, it defaults to the current buffer's name;
3767 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
3769 If DISPLAY-FLAG is non-nil, the new buffer is shown with `pop-to-buffer'.
3770 This runs the normal hook `clone-buffer-hook' in the new buffer
3771 after it has been set up properly in other respects."
3772 (interactive (list (if current-prefix-arg (read-string "Name: "))
3774 (if buffer-file-name
3775 (error "Cannot clone a file-visiting buffer"))
3776 (if (get major-mode 'no-clone)
3777 (error "Cannot clone a buffer in %s mode" mode-name))
3778 (setq newname (or newname (buffer-name)))
3779 (if (string-match "<[0-9]+>\\'" newname)
3780 (setq newname (substring newname 0 (match-beginning 0))))
3781 (let ((buf (current-buffer))
3782 (ptmin (point-min))
3783 (ptmax (point-max))
3784 (pt (point))
3785 (mk (if mark-active (mark t)))
3786 (modified (buffer-modified-p))
3787 (mode major-mode)
3788 (lvars (buffer-local-variables))
3789 (process (get-buffer-process (current-buffer)))
3790 (new (generate-new-buffer (or newname (buffer-name)))))
3791 (save-restriction
3792 (widen)
3793 (with-current-buffer new
3794 (insert-buffer-substring buf)))
3795 (with-current-buffer new
3796 (narrow-to-region ptmin ptmax)
3797 (goto-char pt)
3798 (if mk (set-mark mk))
3799 (set-buffer-modified-p modified)
3801 ;; Clone the old buffer's process, if any.
3802 (when process (clone-process process))
3804 ;; Now set up the major mode.
3805 (funcall mode)
3807 ;; Set up other local variables.
3808 (mapcar (lambda (v)
3809 (condition-case () ;in case var is read-only
3810 (if (symbolp v)
3811 (makunbound v)
3812 (set (make-local-variable (car v)) (cdr v)))
3813 (error nil)))
3814 lvars)
3816 ;; Run any hooks (typically set up by the major mode
3817 ;; for cloning to work properly).
3818 (run-hooks 'clone-buffer-hook))
3819 (if display-flag (pop-to-buffer new))
3820 new))
3823 (defun clone-indirect-buffer (newname display-flag &optional norecord)
3824 "Create an indirect buffer that is a twin copy of the current buffer.
3826 Give the indirect buffer name NEWNAME. Interactively, read NEW-NAME
3827 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
3828 or if not called with a prefix arg, NEWNAME defaults to the current
3829 buffer's name. The name is modified by adding a `<N>' suffix to it
3830 or by incrementing the N in an existing suffix.
3832 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
3833 This is always done when called interactively.
3835 Optional last arg NORECORD non-nil means do not put this buffer at the
3836 front of the list of recently selected ones."
3837 (interactive (list (if current-prefix-arg
3838 (read-string "BName of indirect buffer: "))
3840 (setq newname (or newname (buffer-name)))
3841 (if (string-match "<[0-9]+>\\'" newname)
3842 (setq newname (substring newname 0 (match-beginning 0))))
3843 (let* ((name (generate-new-buffer-name newname))
3844 (buffer (make-indirect-buffer (current-buffer) name t)))
3845 (when display-flag
3846 (pop-to-buffer buffer))
3847 buffer))
3850 (defun clone-indirect-buffer-other-window (buffer &optional norecord)
3851 "Create an indirect buffer that is a twin copy of BUFFER.
3852 Select the new buffer in another window.
3853 Optional second arg NORECORD non-nil means do not put this buffer at
3854 the front of the list of recently selected ones."
3855 (interactive "bClone buffer in other window: ")
3856 (let ((popup-windows t))
3857 (set-buffer buffer)
3858 (clone-indirect-buffer nil t norecord)))
3860 (define-key ctl-x-4-map "c" 'clone-indirect-buffer-other-window)
3863 ;;; Syntax stuff.
3865 (defconst syntax-code-table
3866 '((?\ 0 "whitespace")
3867 (?- 0 "whitespace")
3868 (?. 1 "punctuation")
3869 (?w 2 "word")
3870 (?_ 3 "symbol")
3871 (?\( 4 "open parenthesis")
3872 (?\) 5 "close parenthesis")
3873 (?\' 6 "expression prefix")
3874 (?\" 7 "string quote")
3875 (?$ 8 "paired delimiter")
3876 (?\\ 9 "escape")
3877 (?/ 10 "character quote")
3878 (?< 11 "comment start")
3879 (?> 12 "comment end")
3880 (?@ 13 "inherit")
3881 (nil 14 "comment fence")
3882 (nil 15 "string fence"))
3883 "Alist of forms (CHAR CODE DESCRIPTION) mapping characters to syntax info.
3884 CHAR is a character that is allowed as first char in the string
3885 specifying the syntax when calling `modify-syntax-entry'. CODE is the
3886 corresponing syntax code as it is stored in a syntax cell, and
3887 can be used as value of a `syntax-table' property.
3888 DESCRIPTION is the descriptive string for the syntax.")
3890 (defconst syntax-flag-table
3891 '((?1 . #b10000000000000000)
3892 (?2 . #b100000000000000000)
3893 (?3 . #b1000000000000000000)
3894 (?4 . #b10000000000000000000)
3895 (?p . #b100000000000000000000)
3896 (?b . #b1000000000000000000000)
3897 (?n . #b10000000000000000000000))
3898 "Alist of pairs (CHAR . FLAG) mapping characters to syntax flags.
3899 CHAR is a character that is allowed as second or following character
3900 in the string argument to `modify-syntax-entry' specifying the syntax.
3901 FLAG is the corresponding syntax flag value that is stored in a
3902 syntax table.")
3904 (defun string-to-syntax (string)
3905 "Convert a syntax specification STRING into syntax cell form.
3906 STRING should be a string as it is allowed as argument of
3907 `modify-syntax-entry'. Value is the equivalent cons cell
3908 \(CODE . MATCHING-CHAR) that can be used as value of a `syntax-table'
3909 text property."
3910 (let* ((first-char (aref string 0))
3911 (code (or (nth 1 (assq first-char syntax-code-table))
3912 (error "Invalid syntax specification `%s'" string)))
3913 (length (length string))
3914 (i 1)
3915 matching-char)
3916 ;; Determine the matching character, if any.
3917 (when (and (> length 1)
3918 (memq first-char '(?\( ?\))))
3919 (setq matching-char (aref string i)
3920 i (1+ i)))
3921 ;; Add any flags to the syntax code.
3922 (while (< i length)
3923 (let ((flag (or (assq (aref string i) syntax-flag-table)
3924 (error "Invalid syntax flag in `%s'" string))))
3925 (setq code (logior flag code))
3926 (setq i (1+ i))))
3928 (cons code matching-char)))
3930 ;;; simple.el ends here