(make-lucid-menu-keymap): Add menu-alias property.
[bpt/emacs.git] / lisp / simple.el
1 ;;; simple.el --- basic editing commands for Emacs
2
3 ;; Copyright (C) 1985, 86, 87, 93, 94, 95 Free Software Foundation, Inc.
4
5 ;; This file is part of GNU Emacs.
6
7 ;; GNU Emacs is free software; you can redistribute it and/or modify
8 ;; it under the terms of the GNU General Public License as published by
9 ;; the Free Software Foundation; either version 2, or (at your option)
10 ;; any later version.
11
12 ;; GNU Emacs is distributed in the hope that it will be useful,
13 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
14 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 ;; GNU General Public License for more details.
16
17 ;; You should have received a copy of the GNU General Public License
18 ;; along with GNU Emacs; see the file COPYING. If not, write to the
19 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 ;; Boston, MA 02111-1307, USA.
21
22 ;;; Commentary:
23
24 ;; A grab-bag of basic Emacs commands not specifically related to some
25 ;; major mode or to file-handling.
26
27 ;;; Code:
28
29 (defun newline (&optional arg)
30 "Insert a newline, and move to left margin of the new line if it's blank.
31 The newline is marked with the text-property `hard'.
32 With arg, insert that many newlines.
33 In Auto Fill mode, if no numeric arg, break the preceding line if it's long."
34 (interactive "*P")
35 (barf-if-buffer-read-only)
36 ;; Inserting a newline at the end of a line produces better redisplay in
37 ;; try_window_id than inserting at the beginning of a line, and the textual
38 ;; result is the same. So, if we're at beginning of line, pretend to be at
39 ;; the end of the previous line.
40 (let ((flag (and (not (bobp))
41 (bolp)
42 (< (or (previous-property-change (point)) -2)
43 (- (point) 2))))
44 (was-page-start (and (bolp)
45 (looking-at page-delimiter)))
46 (beforepos (point)))
47 (if flag (backward-char 1))
48 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
49 ;; Set last-command-char to tell self-insert what to insert.
50 (let ((last-command-char ?\n)
51 ;; Don't auto-fill if we have a numeric argument.
52 ;; Also not if flag is true (it would fill wrong line);
53 ;; there is no need to since we're at BOL.
54 (auto-fill-function (if (or arg flag) nil auto-fill-function)))
55 (unwind-protect
56 (self-insert-command (prefix-numeric-value arg))
57 ;; If we get an error in self-insert-command, put point at right place.
58 (if flag (forward-char 1))))
59 ;; If we did *not* get an error, cancel that forward-char.
60 (if flag (backward-char 1))
61 ;; Mark the newline(s) `hard'.
62 (if use-hard-newlines
63 (let* ((from (- (point) (if arg (prefix-numeric-value arg) 1)))
64 (sticky (get-text-property from 'rear-nonsticky)))
65 (put-text-property from (point) 'hard 't)
66 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
67 (if (and (listp sticky) (not (memq 'hard sticky)))
68 (put-text-property from (point) 'rear-nonsticky
69 (cons 'hard sticky)))))
70 ;; If the newline leaves the previous line blank,
71 ;; and we have a left margin, delete that from the blank line.
72 (or flag
73 (save-excursion
74 (goto-char beforepos)
75 (beginning-of-line)
76 (and (looking-at "[ \t]$")
77 (> (current-left-margin) 0)
78 (delete-region (point) (progn (end-of-line) (point))))))
79 (if flag (forward-char 1))
80 ;; Indent the line after the newline, except in one case:
81 ;; when we added the newline at the beginning of a line
82 ;; which starts a page.
83 (or was-page-start
84 (move-to-left-margin nil t)))
85 nil)
86
87 (defun open-line (arg)
88 "Insert a newline and leave point before it.
89 If there is a fill prefix and/or a left-margin, insert them on the new line
90 if the line would have been blank.
91 With arg N, insert N newlines."
92 (interactive "*p")
93 (let* ((do-fill-prefix (and fill-prefix (bolp)))
94 (do-left-margin (and (bolp) (> (current-left-margin) 0)))
95 (loc (point)))
96 (newline arg)
97 (goto-char loc)
98 (while (> arg 0)
99 (cond ((bolp)
100 (if do-left-margin (indent-to (current-left-margin)))
101 (if do-fill-prefix (insert-and-inherit fill-prefix))))
102 (forward-line 1)
103 (setq arg (1- arg)))
104 (goto-char loc)
105 (end-of-line)))
106
107 (defun split-line ()
108 "Split current line, moving portion beyond point vertically down."
109 (interactive "*")
110 (skip-chars-forward " \t")
111 (let ((col (current-column))
112 (pos (point)))
113 (newline 1)
114 (indent-to col 0)
115 (goto-char pos)))
116
117 (defun quoted-insert (arg)
118 "Read next input character and insert it.
119 This is useful for inserting control characters.
120 You may also type up to 3 octal digits, to insert a character with that code.
121
122 In overwrite mode, this function inserts the character anyway, and
123 does not handle octal digits specially. This means that if you use
124 overwrite as your normal editing mode, you can use this function to
125 insert characters when necessary.
126
127 In binary overwrite mode, this function does overwrite, and octal
128 digits are interpreted as a character code. This is supposed to make
129 this function useful in editing binary files."
130 (interactive "*p")
131 (let ((char (if (or (not overwrite-mode)
132 (eq overwrite-mode 'overwrite-mode-binary))
133 (read-quoted-char)
134 (read-char))))
135 (if (> arg 0)
136 (if (eq overwrite-mode 'overwrite-mode-binary)
137 (delete-char arg)))
138 (while (> arg 0)
139 (insert-and-inherit char)
140 (setq arg (1- arg)))))
141
142 (defun delete-indentation (&optional arg)
143 "Join this line to previous and fix up whitespace at join.
144 If there is a fill prefix, delete it from the beginning of this line.
145 With argument, join this line to following line."
146 (interactive "*P")
147 (beginning-of-line)
148 (if arg (forward-line 1))
149 (if (eq (preceding-char) ?\n)
150 (progn
151 (delete-region (point) (1- (point)))
152 ;; If the second line started with the fill prefix,
153 ;; delete the prefix.
154 (if (and fill-prefix
155 (<= (+ (point) (length fill-prefix)) (point-max))
156 (string= fill-prefix
157 (buffer-substring (point)
158 (+ (point) (length fill-prefix)))))
159 (delete-region (point) (+ (point) (length fill-prefix))))
160 (fixup-whitespace))))
161
162 (defun fixup-whitespace ()
163 "Fixup white space between objects around point.
164 Leave one space or none, according to the context."
165 (interactive "*")
166 (save-excursion
167 (delete-horizontal-space)
168 (if (or (looking-at "^\\|\\s)")
169 (save-excursion (forward-char -1)
170 (looking-at "$\\|\\s(\\|\\s'")))
171 nil
172 (insert ?\ ))))
173
174 (defun delete-horizontal-space ()
175 "Delete all spaces and tabs around point."
176 (interactive "*")
177 (skip-chars-backward " \t")
178 (delete-region (point) (progn (skip-chars-forward " \t") (point))))
179
180 (defun just-one-space ()
181 "Delete all spaces and tabs around point, leaving one space."
182 (interactive "*")
183 (skip-chars-backward " \t")
184 (if (= (following-char) ? )
185 (forward-char 1)
186 (insert ? ))
187 (delete-region (point) (progn (skip-chars-forward " \t") (point))))
188
189 (defun delete-blank-lines ()
190 "On blank line, delete all surrounding blank lines, leaving just one.
191 On isolated blank line, delete that one.
192 On nonblank line, delete any immediately following blank lines."
193 (interactive "*")
194 (let (thisblank singleblank)
195 (save-excursion
196 (beginning-of-line)
197 (setq thisblank (looking-at "[ \t]*$"))
198 ;; Set singleblank if there is just one blank line here.
199 (setq singleblank
200 (and thisblank
201 (not (looking-at "[ \t]*\n[ \t]*$"))
202 (or (bobp)
203 (progn (forward-line -1)
204 (not (looking-at "[ \t]*$")))))))
205 ;; Delete preceding blank lines, and this one too if it's the only one.
206 (if thisblank
207 (progn
208 (beginning-of-line)
209 (if singleblank (forward-line 1))
210 (delete-region (point)
211 (if (re-search-backward "[^ \t\n]" nil t)
212 (progn (forward-line 1) (point))
213 (point-min)))))
214 ;; Delete following blank lines, unless the current line is blank
215 ;; and there are no following blank lines.
216 (if (not (and thisblank singleblank))
217 (save-excursion
218 (end-of-line)
219 (forward-line 1)
220 (delete-region (point)
221 (if (re-search-forward "[^ \t\n]" nil t)
222 (progn (beginning-of-line) (point))
223 (point-max)))))
224 ;; Handle the special case where point is followed by newline and eob.
225 ;; Delete the line, leaving point at eob.
226 (if (looking-at "^[ \t]*\n\\'")
227 (delete-region (point) (point-max)))))
228
229 (defun back-to-indentation ()
230 "Move point to the first non-whitespace character on this line."
231 (interactive)
232 (beginning-of-line 1)
233 (skip-chars-forward " \t"))
234
235 (defun newline-and-indent ()
236 "Insert a newline, then indent according to major mode.
237 Indentation is done using the value of `indent-line-function'.
238 In programming language modes, this is the same as TAB.
239 In some text modes, where TAB inserts a tab, this command indents to the
240 column specified by the function `current-left-margin'."
241 (interactive "*")
242 (delete-region (point) (progn (skip-chars-backward " \t") (point)))
243 (newline)
244 (indent-according-to-mode))
245
246 (defun reindent-then-newline-and-indent ()
247 "Reindent current line, insert newline, then indent the new line.
248 Indentation of both lines is done according to the current major mode,
249 which means calling the current value of `indent-line-function'.
250 In programming language modes, this is the same as TAB.
251 In some text modes, where TAB inserts a tab, this indents to the
252 column specified by the function `current-left-margin'."
253 (interactive "*")
254 (save-excursion
255 (delete-region (point) (progn (skip-chars-backward " \t") (point)))
256 (indent-according-to-mode))
257 (newline)
258 (indent-according-to-mode))
259
260 ;; Internal subroutine of delete-char
261 (defun kill-forward-chars (arg)
262 (if (listp arg) (setq arg (car arg)))
263 (if (eq arg '-) (setq arg -1))
264 (kill-region (point) (+ (point) arg)))
265
266 ;; Internal subroutine of backward-delete-char
267 (defun kill-backward-chars (arg)
268 (if (listp arg) (setq arg (car arg)))
269 (if (eq arg '-) (setq arg -1))
270 (kill-region (point) (- (point) arg)))
271
272 (defun backward-delete-char-untabify (arg &optional killp)
273 "Delete characters backward, changing tabs into spaces.
274 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
275 Interactively, ARG is the prefix arg (default 1)
276 and KILLP is t if a prefix arg was specified."
277 (interactive "*p\nP")
278 (let ((count arg))
279 (save-excursion
280 (while (and (> count 0) (not (bobp)))
281 (if (= (preceding-char) ?\t)
282 (let ((col (current-column)))
283 (forward-char -1)
284 (setq col (- col (current-column)))
285 (insert-char ?\ col)
286 (delete-char 1)))
287 (forward-char -1)
288 (setq count (1- count)))))
289 (delete-backward-char arg killp))
290
291 (defun zap-to-char (arg char)
292 "Kill up to and including ARG'th occurrence of CHAR.
293 Goes backward if ARG is negative; error if CHAR not found."
294 (interactive "p\ncZap to char: ")
295 (kill-region (point) (progn
296 (search-forward (char-to-string char) nil nil arg)
297 ; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
298 (point))))
299
300 (defun beginning-of-buffer (&optional arg)
301 "Move point to the beginning of the buffer; leave mark at previous position.
302 With arg N, put point N/10 of the way from the beginning.
303
304 If the buffer is narrowed, this command uses the beginning and size
305 of the accessible part of the buffer.
306
307 Don't use this command in Lisp programs!
308 \(goto-char (point-min)) is faster and avoids clobbering the mark."
309 (interactive "P")
310 (push-mark)
311 (let ((size (- (point-max) (point-min))))
312 (goto-char (if arg
313 (+ (point-min)
314 (if (> size 10000)
315 ;; Avoid overflow for large buffer sizes!
316 (* (prefix-numeric-value arg)
317 (/ size 10))
318 (/ (+ 10 (* size (prefix-numeric-value arg))) 10)))
319 (point-min))))
320 (if arg (forward-line 1)))
321
322 (defun end-of-buffer (&optional arg)
323 "Move point to the end of the buffer; leave mark at previous position.
324 With arg N, put point N/10 of the way from the end.
325
326 If the buffer is narrowed, this command uses the beginning and size
327 of the accessible part of the buffer.
328
329 Don't use this command in Lisp programs!
330 \(goto-char (point-max)) is faster and avoids clobbering the mark."
331 (interactive "P")
332 (push-mark)
333 (let ((size (- (point-max) (point-min))))
334 (goto-char (if arg
335 (- (point-max)
336 (if (> size 10000)
337 ;; Avoid overflow for large buffer sizes!
338 (* (prefix-numeric-value arg)
339 (/ size 10))
340 (/ (* size (prefix-numeric-value arg)) 10)))
341 (point-max))))
342 ;; If we went to a place in the middle of the buffer,
343 ;; adjust it to the beginning of a line.
344 (if arg (forward-line 1)
345 ;; If the end of the buffer is not already on the screen,
346 ;; then scroll specially to put it near, but not at, the bottom.
347 (if (let ((old-point (point)))
348 (save-excursion
349 (goto-char (window-start))
350 (vertical-motion (window-height))
351 (< (point) old-point)))
352 (progn
353 (overlay-recenter (point))
354 (recenter -3)))))
355
356 (defun mark-whole-buffer ()
357 "Put point at beginning and mark at end of buffer.
358 You probably should not use this function in Lisp programs;
359 it is usually a mistake for a Lisp function to use any subroutine
360 that uses or sets the mark."
361 (interactive)
362 (push-mark (point))
363 (push-mark (point-max) nil t)
364 (goto-char (point-min)))
365
366 (defun count-lines-region (start end)
367 "Print number of lines and characters in the region."
368 (interactive "r")
369 (message "Region has %d lines, %d characters"
370 (count-lines start end) (- end start)))
371
372 (defun what-line ()
373 "Print the current buffer line number and narrowed line number of point."
374 (interactive)
375 (let ((opoint (point)) start)
376 (save-excursion
377 (save-restriction
378 (goto-char (point-min))
379 (widen)
380 (beginning-of-line)
381 (setq start (point))
382 (goto-char opoint)
383 (beginning-of-line)
384 (if (/= start 1)
385 (message "line %d (narrowed line %d)"
386 (1+ (count-lines 1 (point)))
387 (1+ (count-lines start (point))))
388 (message "Line %d" (1+ (count-lines 1 (point)))))))))
389
390
391 (defun count-lines (start end)
392 "Return number of lines between START and END.
393 This is usually the number of newlines between them,
394 but can be one more if START is not equal to END
395 and the greater of them is not at the start of a line."
396 (save-excursion
397 (save-restriction
398 (narrow-to-region start end)
399 (goto-char (point-min))
400 (if (eq selective-display t)
401 (save-match-data
402 (let ((done 0))
403 (while (re-search-forward "[\n\C-m]" nil t 40)
404 (setq done (+ 40 done)))
405 (while (re-search-forward "[\n\C-m]" nil t 1)
406 (setq done (+ 1 done)))
407 (goto-char (point-max))
408 (if (and (/= start end)
409 (not (bolp)))
410 (1+ done)
411 done)))
412 (- (buffer-size) (forward-line (buffer-size)))))))
413
414 (defun what-cursor-position ()
415 "Print info on cursor position (on screen and within buffer)."
416 (interactive)
417 (let* ((char (following-char))
418 (beg (point-min))
419 (end (point-max))
420 (pos (point))
421 (total (buffer-size))
422 (percent (if (> total 50000)
423 ;; Avoid overflow from multiplying by 100!
424 (/ (+ (/ total 200) (1- pos)) (max (/ total 100) 1))
425 (/ (+ (/ total 2) (* 100 (1- pos))) (max total 1))))
426 (hscroll (if (= (window-hscroll) 0)
427 ""
428 (format " Hscroll=%d" (window-hscroll))))
429 (col (current-column)))
430 (if (= pos end)
431 (if (or (/= beg 1) (/= end (1+ total)))
432 (message "point=%d of %d(%d%%) <%d - %d> column %d %s"
433 pos total percent beg end col hscroll)
434 (message "point=%d of %d(%d%%) column %d %s"
435 pos total percent col hscroll))
436 (if (or (/= beg 1) (/= end (1+ total)))
437 (message "Char: %s (0%o, %d, 0x%x) point=%d of %d(%d%%) <%d - %d> column %d %s"
438 (single-key-description char) char char char pos total percent beg end col hscroll)
439 (message "Char: %s (0%o, %d, 0x%x) point=%d of %d(%d%%) column %d %s"
440 (single-key-description char) char char char pos total percent col hscroll)))))
441
442 (defun fundamental-mode ()
443 "Major mode not specialized for anything in particular.
444 Other major modes are defined by comparison with this one."
445 (interactive)
446 (kill-all-local-variables))
447
448 (defvar read-expression-map (cons 'keymap minibuffer-local-map)
449 "Minibuffer keymap used for reading Lisp expressions.")
450 (define-key read-expression-map "\M-\t" 'lisp-complete-symbol)
451
452 (put 'eval-expression 'disabled t)
453
454 (defvar read-expression-history nil)
455
456 ;; We define this, rather than making `eval' interactive,
457 ;; for the sake of completion of names like eval-region, eval-current-buffer.
458 (defun eval-expression (expression)
459 "Evaluate EXPRESSION and print value in minibuffer.
460 Value is also consed on to front of the variable `values'."
461 (interactive
462 (list (read-from-minibuffer "Eval: "
463 nil read-expression-map t
464 'read-expression-history)))
465 (setq values (cons (eval expression) values))
466 (prin1 (car values) t))
467
468 (defun edit-and-eval-command (prompt command)
469 "Prompting with PROMPT, let user edit COMMAND and eval result.
470 COMMAND is a Lisp expression. Let user edit that expression in
471 the minibuffer, then read and evaluate the result."
472 (let ((command (read-from-minibuffer prompt
473 (prin1-to-string command)
474 read-expression-map t
475 '(command-history . 1))))
476 ;; If command was added to command-history as a string,
477 ;; get rid of that. We want only evaluable expressions there.
478 (if (stringp (car command-history))
479 (setq command-history (cdr command-history)))
480
481 ;; If command to be redone does not match front of history,
482 ;; add it to the history.
483 (or (equal command (car command-history))
484 (setq command-history (cons command command-history)))
485 (eval command)))
486
487 (defun repeat-complex-command (arg)
488 "Edit and re-evaluate last complex command, or ARGth from last.
489 A complex command is one which used the minibuffer.
490 The command is placed in the minibuffer as a Lisp form for editing.
491 The result is executed, repeating the command as changed.
492 If the command has been changed or is not the most recent previous command
493 it is added to the front of the command history.
494 You can use the minibuffer history commands \\<minibuffer-local-map>\\[next-history-element] and \\[previous-history-element]
495 to get different commands to edit and resubmit."
496 (interactive "p")
497 (let ((elt (nth (1- arg) command-history))
498 (minibuffer-history-position arg)
499 (minibuffer-history-sexp-flag t)
500 newcmd)
501 (if elt
502 (progn
503 (setq newcmd
504 (let ((print-level nil))
505 (read-from-minibuffer
506 "Redo: " (prin1-to-string elt) read-expression-map t
507 (cons 'command-history arg))))
508
509 ;; If command was added to command-history as a string,
510 ;; get rid of that. We want only evaluable expressions there.
511 (if (stringp (car command-history))
512 (setq command-history (cdr command-history)))
513
514 ;; If command to be redone does not match front of history,
515 ;; add it to the history.
516 (or (equal newcmd (car command-history))
517 (setq command-history (cons newcmd command-history)))
518 (eval newcmd))
519 (ding))))
520 \f
521 (defvar minibuffer-history nil
522 "Default minibuffer history list.
523 This is used for all minibuffer input
524 except when an alternate history list is specified.")
525 (defvar minibuffer-history-sexp-flag nil
526 "Non-nil when doing history operations on `command-history'.
527 More generally, indicates that the history list being acted on
528 contains expressions rather than strings.")
529 (setq minibuffer-history-variable 'minibuffer-history)
530 (setq minibuffer-history-position nil)
531 (defvar minibuffer-history-search-history nil)
532
533 (mapcar
534 (lambda (key-and-command)
535 (mapcar
536 (lambda (keymap-and-completionp)
537 ;; Arg is (KEYMAP-SYMBOL . COMPLETION-MAP-P).
538 ;; If the cdr of KEY-AND-COMMAND (the command) is a cons,
539 ;; its car is used if COMPLETION-MAP-P is nil, its cdr if it is t.
540 (define-key (symbol-value (car keymap-and-completionp))
541 (car key-and-command)
542 (let ((command (cdr key-and-command)))
543 (if (consp command)
544 ;; (and ... nil) => ... turns back on the completion-oriented
545 ;; history commands which rms turned off since they seem to
546 ;; do things he doesn't like.
547 (if (and (cdr keymap-and-completionp) nil) ;XXX turned off
548 (progn (error "EMACS BUG!") (cdr command))
549 (car command))
550 command))))
551 '((minibuffer-local-map . nil)
552 (minibuffer-local-ns-map . nil)
553 (minibuffer-local-completion-map . t)
554 (minibuffer-local-must-match-map . t)
555 (read-expression-map . nil))))
556 '(("\en" . (next-history-element . next-complete-history-element))
557 ([next] . (next-history-element . next-complete-history-element))
558 ("\ep" . (previous-history-element . previous-complete-history-element))
559 ([prior] . (previous-history-element . previous-complete-history-element))
560 ("\er" . previous-matching-history-element)
561 ("\es" . next-matching-history-element)))
562
563 (defun previous-matching-history-element (regexp n)
564 "Find the previous history element that matches REGEXP.
565 \(Previous history elements refer to earlier actions.)
566 With prefix argument N, search for Nth previous match.
567 If N is negative, find the next or Nth next match."
568 (interactive
569 (let* ((enable-recursive-minibuffers t)
570 (minibuffer-history-sexp-flag nil)
571 (regexp (read-from-minibuffer "Previous element matching (regexp): "
572 nil
573 minibuffer-local-map
574 nil
575 'minibuffer-history-search-history)))
576 ;; Use the last regexp specified, by default, if input is empty.
577 (list (if (string= regexp "")
578 (if minibuffer-history-search-history
579 (car minibuffer-history-search-history)
580 (error "No previous history search regexp"))
581 regexp)
582 (prefix-numeric-value current-prefix-arg))))
583 (let ((history (symbol-value minibuffer-history-variable))
584 prevpos
585 (pos minibuffer-history-position))
586 (while (/= n 0)
587 (setq prevpos pos)
588 (setq pos (min (max 1 (+ pos (if (< n 0) -1 1))) (length history)))
589 (if (= pos prevpos)
590 (error (if (= pos 1)
591 "No later matching history item"
592 "No earlier matching history item")))
593 (if (string-match regexp
594 (if minibuffer-history-sexp-flag
595 (let ((print-level nil))
596 (prin1-to-string (nth (1- pos) history)))
597 (nth (1- pos) history)))
598 (setq n (+ n (if (< n 0) 1 -1)))))
599 (setq minibuffer-history-position pos)
600 (erase-buffer)
601 (let ((elt (nth (1- pos) history)))
602 (insert (if minibuffer-history-sexp-flag
603 (let ((print-level nil))
604 (prin1-to-string elt))
605 elt)))
606 (goto-char (point-min)))
607 (if (or (eq (car (car command-history)) 'previous-matching-history-element)
608 (eq (car (car command-history)) 'next-matching-history-element))
609 (setq command-history (cdr command-history))))
610
611 (defun next-matching-history-element (regexp n)
612 "Find the next history element that matches REGEXP.
613 \(The next history element refers to a more recent action.)
614 With prefix argument N, search for Nth next match.
615 If N is negative, find the previous or Nth previous match."
616 (interactive
617 (let* ((enable-recursive-minibuffers t)
618 (minibuffer-history-sexp-flag nil)
619 (regexp (read-from-minibuffer "Next element matching (regexp): "
620 nil
621 minibuffer-local-map
622 nil
623 'minibuffer-history-search-history)))
624 ;; Use the last regexp specified, by default, if input is empty.
625 (list (if (string= regexp "")
626 (setcar minibuffer-history-search-history
627 (nth 1 minibuffer-history-search-history))
628 regexp)
629 (prefix-numeric-value current-prefix-arg))))
630 (previous-matching-history-element regexp (- n)))
631
632 (defun next-history-element (n)
633 "Insert the next element of the minibuffer history into the minibuffer."
634 (interactive "p")
635 (or (zerop n)
636 (let ((narg (min (max 1 (- minibuffer-history-position n))
637 (length (symbol-value minibuffer-history-variable)))))
638 (if (or (zerop narg)
639 (= minibuffer-history-position narg))
640 (error (if (if (zerop narg)
641 (> n 0)
642 (= minibuffer-history-position 1))
643 "End of history; no next item"
644 "Beginning of history; no preceding item"))
645 (erase-buffer)
646 (setq minibuffer-history-position narg)
647 (let ((elt (nth (1- minibuffer-history-position)
648 (symbol-value minibuffer-history-variable))))
649 (insert
650 (if minibuffer-history-sexp-flag
651 (let ((print-level nil))
652 (prin1-to-string elt))
653 elt)))
654 (goto-char (point-min))))))
655
656 (defun previous-history-element (n)
657 "Inserts the previous element of the minibuffer history into the minibuffer."
658 (interactive "p")
659 (next-history-element (- n)))
660
661 (defun next-complete-history-element (n)
662 "Get next element of history which is a completion of minibuffer contents."
663 (interactive "p")
664 (let ((point-at-start (point)))
665 (next-matching-history-element
666 (concat "^" (regexp-quote (buffer-substring (point-min) (point)))) n)
667 ;; next-matching-history-element always puts us at (point-min).
668 ;; Move to the position we were at before changing the buffer contents.
669 ;; This is still sensical, because the text before point has not changed.
670 (goto-char point-at-start)))
671
672 (defun previous-complete-history-element (n)
673 "\
674 Get previous element of history which is a completion of minibuffer contents."
675 (interactive "p")
676 (next-complete-history-element (- n)))
677 \f
678 (defun goto-line (arg)
679 "Goto line ARG, counting from line 1 at beginning of buffer."
680 (interactive "NGoto line: ")
681 (setq arg (prefix-numeric-value arg))
682 (save-restriction
683 (widen)
684 (goto-char 1)
685 (if (eq selective-display t)
686 (re-search-forward "[\n\C-m]" nil 'end (1- arg))
687 (forward-line (1- arg)))))
688
689 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
690 (define-function 'advertised-undo 'undo)
691
692 (defun undo (&optional arg)
693 "Undo some previous changes.
694 Repeat this command to undo more changes.
695 A numeric argument serves as a repeat count."
696 (interactive "*p")
697 ;; If we don't get all the way thru, make last-command indicate that
698 ;; for the following command.
699 (setq this-command t)
700 (let ((modified (buffer-modified-p))
701 (recent-save (recent-auto-save-p)))
702 (or (eq (selected-window) (minibuffer-window))
703 (message "Undo!"))
704 (or (eq last-command 'undo)
705 (progn (undo-start)
706 (undo-more 1)))
707 (undo-more (or arg 1))
708 ;; Don't specify a position in the undo record for the undo command.
709 ;; Instead, undoing this should move point to where the change is.
710 (let ((tail buffer-undo-list)
711 done)
712 (while (and tail (not done) (not (null (car tail))))
713 (if (integerp (car tail))
714 (progn
715 (setq done t)
716 (setq buffer-undo-list (delq (car tail) buffer-undo-list))))
717 (setq tail (cdr tail))))
718 (and modified (not (buffer-modified-p))
719 (delete-auto-save-file-if-necessary recent-save)))
720 ;; If we do get all the way thru, make this-command indicate that.
721 (setq this-command 'undo))
722
723 (defvar pending-undo-list nil
724 "Within a run of consecutive undo commands, list remaining to be undone.")
725
726 (defun undo-start ()
727 "Set `pending-undo-list' to the front of the undo list.
728 The next call to `undo-more' will undo the most recently made change."
729 (if (eq buffer-undo-list t)
730 (error "No undo information in this buffer"))
731 (setq pending-undo-list buffer-undo-list))
732
733 (defun undo-more (count)
734 "Undo back N undo-boundaries beyond what was already undone recently.
735 Call `undo-start' to get ready to undo recent changes,
736 then call `undo-more' one or more times to undo them."
737 (or pending-undo-list
738 (error "No further undo information"))
739 (setq pending-undo-list (primitive-undo count pending-undo-list)))
740
741 (defvar shell-command-history nil
742 "History list for some commands that read shell commands.")
743
744 (defvar shell-command-switch "-c"
745 "Switch used to have the shell execute its command line argument.")
746
747 (defun shell-command (command &optional output-buffer)
748 "Execute string COMMAND in inferior shell; display output, if any.
749
750 If COMMAND ends in ampersand, execute it asynchronously.
751 The output appears in the buffer `*Async Shell Command*'.
752 That buffer is in shell mode.
753
754 Otherwise, COMMAND is executed synchronously. The output appears in the
755 buffer `*Shell Command Output*'.
756 If the output is one line, it is displayed in the echo area *as well*,
757 but it is nonetheless available in buffer `*Shell Command Output*',
758 even though that buffer is not automatically displayed.
759 If there is no output, or if output is inserted in the current buffer,
760 then `*Shell Command Output*' is deleted.
761
762 The optional second argument OUTPUT-BUFFER, if non-nil,
763 says to put the output in some other buffer.
764 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
765 If OUTPUT-BUFFER is not a buffer and not nil,
766 insert output in current buffer. (This cannot be done asynchronously.)
767 In either case, the output is inserted after point (leaving mark after it)."
768 (interactive (list (read-from-minibuffer "Shell command: "
769 nil nil nil 'shell-command-history)
770 current-prefix-arg))
771 ;; Look for a handler in case default-directory is a remote file name.
772 (let ((handler
773 (find-file-name-handler (directory-file-name default-directory)
774 'shell-command)))
775 (if handler
776 (funcall handler 'shell-command command output-buffer)
777 (if (and output-buffer
778 (not (or (bufferp output-buffer) (stringp output-buffer))))
779 (progn (barf-if-buffer-read-only)
780 (push-mark)
781 ;; We do not use -f for csh; we will not support broken use of
782 ;; .cshrcs. Even the BSD csh manual says to use
783 ;; "if ($?prompt) exit" before things which are not useful
784 ;; non-interactively. Besides, if someone wants their other
785 ;; aliases for shell commands then they can still have them.
786 (call-process shell-file-name nil t nil
787 shell-command-switch command)
788 ;; This is like exchange-point-and-mark, but doesn't
789 ;; activate the mark. It is cleaner to avoid activation,
790 ;; even though the command loop would deactivate the mark
791 ;; because we inserted text.
792 (goto-char (prog1 (mark t)
793 (set-marker (mark-marker) (point)
794 (current-buffer)))))
795 ;; Preserve the match data in case called from a program.
796 (save-match-data
797 (if (string-match "[ \t]*&[ \t]*$" command)
798 ;; Command ending with ampersand means asynchronous.
799 (let ((buffer (get-buffer-create
800 (or output-buffer "*Async Shell Command*")))
801 (directory default-directory)
802 proc)
803 ;; Remove the ampersand.
804 (setq command (substring command 0 (match-beginning 0)))
805 ;; If will kill a process, query first.
806 (setq proc (get-buffer-process buffer))
807 (if proc
808 (if (yes-or-no-p "A command is running. Kill it? ")
809 (kill-process proc)
810 (error "Shell command in progress")))
811 (save-excursion
812 (set-buffer buffer)
813 (setq buffer-read-only nil)
814 (erase-buffer)
815 (display-buffer buffer)
816 (setq default-directory directory)
817 (setq proc (start-process "Shell" buffer shell-file-name
818 shell-command-switch command))
819 (setq mode-line-process '(":%s"))
820 (require 'shell) (shell-mode)
821 (set-process-sentinel proc 'shell-command-sentinel)
822 ))
823 (shell-command-on-region (point) (point) command nil)
824 ))))))
825
826 ;; We have a sentinel to prevent insertion of a termination message
827 ;; in the buffer itself.
828 (defun shell-command-sentinel (process signal)
829 (if (memq (process-status process) '(exit signal))
830 (message "%s: %s."
831 (car (cdr (cdr (process-command process))))
832 (substring signal 0 -1))))
833
834 (defun shell-command-on-region (start end command
835 &optional output-buffer replace)
836 "Execute string COMMAND in inferior shell with region as input.
837 Normally display output (if any) in temp buffer `*Shell Command Output*';
838 Prefix arg means replace the region with it.
839
840 The noninteractive arguments are START, END, COMMAND, OUTPUT-BUFFER, REPLACE.
841 If REPLACE is non-nil, that means insert the output
842 in place of text from START to END, putting point and mark around it.
843
844 If the output is one line, it is displayed in the echo area,
845 but it is nonetheless available in buffer `*Shell Command Output*'
846 even though that buffer is not automatically displayed.
847 If there is no output, or if output is inserted in the current buffer,
848 then `*Shell Command Output*' is deleted.
849
850 If the optional fourth argument OUTPUT-BUFFER is non-nil,
851 that says to put the output in some other buffer.
852 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
853 If OUTPUT-BUFFER is not a buffer and not nil,
854 insert output in the current buffer.
855 In either case, the output is inserted after point (leaving mark after it)."
856 (interactive (let ((string
857 ;; Do this before calling region-beginning
858 ;; and region-end, in case subprocess output
859 ;; relocates them while we are in the minibuffer.
860 (read-from-minibuffer "Shell command on region: "
861 nil nil nil
862 'shell-command-history)))
863 ;; call-interactively recognizes region-beginning and
864 ;; region-end specially, leaving them in the history.
865 (list (region-beginning) (region-end)
866 string
867 current-prefix-arg
868 current-prefix-arg)))
869 (if (or replace
870 (and output-buffer
871 (not (or (bufferp output-buffer) (stringp output-buffer))))
872 (equal (buffer-name (current-buffer)) "*Shell Command Output*"))
873 ;; Replace specified region with output from command.
874 (let ((swap (and replace (< start end))))
875 ;; Don't muck with mark unless REPLACE says we should.
876 (goto-char start)
877 (and replace (push-mark))
878 (call-process-region start end shell-file-name t t nil
879 shell-command-switch command)
880 (let ((shell-buffer (get-buffer "*Shell Command Output*")))
881 (and shell-buffer (not (eq shell-buffer (current-buffer)))
882 (kill-buffer shell-buffer)))
883 ;; Don't muck with mark unless REPLACE says we should.
884 (and replace swap (exchange-point-and-mark)))
885 ;; No prefix argument: put the output in a temp buffer,
886 ;; replacing its entire contents.
887 (let ((buffer (get-buffer-create
888 (or output-buffer "*Shell Command Output*")))
889 (success nil))
890 (unwind-protect
891 (if (eq buffer (current-buffer))
892 ;; If the input is the same buffer as the output,
893 ;; delete everything but the specified region,
894 ;; then replace that region with the output.
895 (progn (setq buffer-read-only nil)
896 (delete-region (max start end) (point-max))
897 (delete-region (point-min) (min start end))
898 (call-process-region (point-min) (point-max)
899 shell-file-name t t nil
900 shell-command-switch command)
901 (setq success t))
902 ;; Clear the output buffer, then run the command with output there.
903 (save-excursion
904 (set-buffer buffer)
905 (setq buffer-read-only nil)
906 (erase-buffer))
907 (call-process-region start end shell-file-name
908 nil buffer nil
909 shell-command-switch command)
910 (setq success t))
911 ;; Report the amount of output.
912 (let ((lines (save-excursion
913 (set-buffer buffer)
914 (if (= (buffer-size) 0)
915 0
916 (count-lines (point-min) (point-max))))))
917 (cond ((= lines 0)
918 (if success
919 (message "(Shell command completed with no output)"))
920 (kill-buffer buffer))
921 ((and success (= lines 1))
922 (message "%s"
923 (save-excursion
924 (set-buffer buffer)
925 (goto-char (point-min))
926 (buffer-substring (point)
927 (progn (end-of-line) (point))))))
928 (t
929 (save-excursion
930 (set-buffer buffer)
931 (goto-char (point-min)))
932 (display-buffer buffer))))))))
933 \f
934 (defconst universal-argument-map
935 (let ((map (make-sparse-keymap)))
936 (define-key map [t] 'universal-argument-other-key)
937 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
938 (define-key map [switch-frame] nil)
939 (define-key map [?\C-u] 'universal-argument-more)
940 (define-key map [?-] 'universal-argument-minus)
941 (define-key map [?0] 'digit-argument)
942 (define-key map [?1] 'digit-argument)
943 (define-key map [?2] 'digit-argument)
944 (define-key map [?3] 'digit-argument)
945 (define-key map [?4] 'digit-argument)
946 (define-key map [?5] 'digit-argument)
947 (define-key map [?6] 'digit-argument)
948 (define-key map [?7] 'digit-argument)
949 (define-key map [?8] 'digit-argument)
950 (define-key map [?9] 'digit-argument)
951 map)
952 "Keymap used while processing \\[universal-argument].")
953
954 (defvar universal-argument-num-events nil
955 "Number of argument-specifying events read by `universal-argument'.
956 `universal-argument-other-key' uses this to discard those events
957 from (this-command-keys), and reread only the final command.")
958
959 (defun universal-argument ()
960 "Begin a numeric argument for the following command.
961 Digits or minus sign following \\[universal-argument] make up the numeric argument.
962 \\[universal-argument] following the digits or minus sign ends the argument.
963 \\[universal-argument] without digits or minus sign provides 4 as argument.
964 Repeating \\[universal-argument] without digits or minus sign
965 multiplies the argument by 4 each time."
966 (interactive)
967 (setq prefix-arg (list 4))
968 (setq universal-argument-num-events (length (this-command-keys)))
969 (setq overriding-terminal-local-map universal-argument-map))
970
971 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
972 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
973 (defun universal-argument-more (arg)
974 (interactive "P")
975 (if (consp arg)
976 (setq prefix-arg (list (* 4 (car arg))))
977 (setq prefix-arg arg)
978 (setq overriding-terminal-local-map nil))
979 (setq universal-argument-num-events (length (this-command-keys))))
980
981 (defun negative-argument (arg)
982 "Begin a negative numeric argument for the next command.
983 \\[universal-argument] following digits or minus sign ends the argument."
984 (interactive "P")
985 (cond ((integerp arg)
986 (setq prefix-arg (- arg)))
987 ((eq arg '-)
988 (setq prefix-arg nil))
989 (t
990 (setq prefix-arg '-)))
991 (setq universal-argument-num-events (length (this-command-keys)))
992 (setq overriding-terminal-local-map universal-argument-map))
993
994 (defun digit-argument (arg)
995 "Part of the numeric argument for the next command.
996 \\[universal-argument] following digits or minus sign ends the argument."
997 (interactive "P")
998 (let ((digit (- (logand last-command-char ?\177) ?0)))
999 (cond ((integerp arg)
1000 (setq prefix-arg (+ (* arg 10)
1001 (if (< arg 0) (- digit) digit))))
1002 ((eq arg '-)
1003 ;; Treat -0 as just -, so that -01 will work.
1004 (setq prefix-arg (if (zerop digit) '- (- digit))))
1005 (t
1006 (setq prefix-arg digit))))
1007 (setq universal-argument-num-events (length (this-command-keys)))
1008 (setq overriding-terminal-local-map universal-argument-map))
1009
1010 ;; For backward compatibility, minus with no modifiers is an ordinary
1011 ;; command if digits have already been entered.
1012 (defun universal-argument-minus (arg)
1013 (interactive "P")
1014 (if (integerp arg)
1015 (universal-argument-other-key arg)
1016 (negative-argument arg)))
1017
1018 ;; Anything else terminates the argument and is left in the queue to be
1019 ;; executed as a command.
1020 (defun universal-argument-other-key (arg)
1021 (interactive "P")
1022 (setq prefix-arg arg)
1023 (let* ((key (this-command-keys))
1024 (keylist (listify-key-sequence key)))
1025 (setq unread-command-events
1026 (append (nthcdr universal-argument-num-events keylist)
1027 unread-command-events)))
1028 (reset-this-command-lengths)
1029 (setq overriding-terminal-local-map nil))
1030 \f
1031 (defun forward-to-indentation (arg)
1032 "Move forward ARG lines and position at first nonblank character."
1033 (interactive "p")
1034 (forward-line arg)
1035 (skip-chars-forward " \t"))
1036
1037 (defun backward-to-indentation (arg)
1038 "Move backward ARG lines and position at first nonblank character."
1039 (interactive "p")
1040 (forward-line (- arg))
1041 (skip-chars-forward " \t"))
1042
1043 (defvar kill-whole-line nil
1044 "*If non-nil, `kill-line' with no arg at beg of line kills the whole line.")
1045
1046 (defun kill-line (&optional arg)
1047 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
1048 With prefix argument, kill that many lines from point.
1049 Negative arguments kill lines backward.
1050
1051 When calling from a program, nil means \"no arg\",
1052 a number counts as a prefix arg.
1053
1054 If `kill-whole-line' is non-nil, then kill the whole line
1055 when given no argument at the beginning of a line."
1056 (interactive "P")
1057 (kill-region (point)
1058 ;; It is better to move point to the other end of the kill
1059 ;; before killing. That way, in a read-only buffer, point
1060 ;; moves across the text that is copied to the kill ring.
1061 ;; The choice has no effect on undo now that undo records
1062 ;; the value of point from before the command was run.
1063 (progn
1064 (if arg
1065 (forward-line (prefix-numeric-value arg))
1066 (if (eobp)
1067 (signal 'end-of-buffer nil))
1068 (if (or (looking-at "[ \t]*$") (and kill-whole-line (bolp)))
1069 (forward-line 1)
1070 (end-of-line)))
1071 (point))))
1072 \f
1073 ;;;; Window system cut and paste hooks.
1074
1075 (defvar interprogram-cut-function nil
1076 "Function to call to make a killed region available to other programs.
1077
1078 Most window systems provide some sort of facility for cutting and
1079 pasting text between the windows of different programs.
1080 This variable holds a function that Emacs calls whenever text
1081 is put in the kill ring, to make the new kill available to other
1082 programs.
1083
1084 The function takes one or two arguments.
1085 The first argument, TEXT, is a string containing
1086 the text which should be made available.
1087 The second, PUSH, if non-nil means this is a \"new\" kill;
1088 nil means appending to an \"old\" kill.")
1089
1090 (defvar interprogram-paste-function nil
1091 "Function to call to get text cut from other programs.
1092
1093 Most window systems provide some sort of facility for cutting and
1094 pasting text between the windows of different programs.
1095 This variable holds a function that Emacs calls to obtain
1096 text that other programs have provided for pasting.
1097
1098 The function should be called with no arguments. If the function
1099 returns nil, then no other program has provided such text, and the top
1100 of the Emacs kill ring should be used. If the function returns a
1101 string, that string should be put in the kill ring as the latest kill.
1102
1103 Note that the function should return a string only if a program other
1104 than Emacs has provided a string for pasting; if Emacs provided the
1105 most recent string, the function should return nil. If it is
1106 difficult to tell whether Emacs or some other program provided the
1107 current string, it is probably good enough to return nil if the string
1108 is equal (according to `string=') to the last text Emacs provided.")
1109
1110
1111 \f
1112 ;;;; The kill ring data structure.
1113
1114 (defvar kill-ring nil
1115 "List of killed text sequences.
1116 Since the kill ring is supposed to interact nicely with cut-and-paste
1117 facilities offered by window systems, use of this variable should
1118 interact nicely with `interprogram-cut-function' and
1119 `interprogram-paste-function'. The functions `kill-new',
1120 `kill-append', and `current-kill' are supposed to implement this
1121 interaction; you may want to use them instead of manipulating the kill
1122 ring directly.")
1123
1124 (defconst kill-ring-max 30
1125 "*Maximum length of kill ring before oldest elements are thrown away.")
1126
1127 (defvar kill-ring-yank-pointer nil
1128 "The tail of the kill ring whose car is the last thing yanked.")
1129
1130 (defun kill-new (string &optional replace)
1131 "Make STRING the latest kill in the kill ring.
1132 Set the kill-ring-yank pointer to point to it.
1133 If `interprogram-cut-function' is non-nil, apply it to STRING.
1134 Optional second argument REPLACE non-nil means that STRING will replace
1135 the front of the kill ring, rather than being added to the list."
1136 (and (fboundp 'menu-bar-update-yank-menu)
1137 (menu-bar-update-yank-menu string (and replace (car kill-ring))))
1138 (if replace
1139 (setcar kill-ring string)
1140 (setq kill-ring (cons string kill-ring))
1141 (if (> (length kill-ring) kill-ring-max)
1142 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil)))
1143 (setq kill-ring-yank-pointer kill-ring)
1144 (if interprogram-cut-function
1145 (funcall interprogram-cut-function string (not replace))))
1146
1147 (defun kill-append (string before-p)
1148 "Append STRING to the end of the latest kill in the kill ring.
1149 If BEFORE-P is non-nil, prepend STRING to the kill.
1150 If `interprogram-cut-function' is set, pass the resulting kill to
1151 it."
1152 (kill-new (if before-p
1153 (concat string (car kill-ring))
1154 (concat (car kill-ring) string)) t))
1155
1156 (defun current-kill (n &optional do-not-move)
1157 "Rotate the yanking point by N places, and then return that kill.
1158 If N is zero, `interprogram-paste-function' is set, and calling it
1159 returns a string, then that string is added to the front of the
1160 kill ring and returned as the latest kill.
1161 If optional arg DO-NOT-MOVE is non-nil, then don't actually move the
1162 yanking point; just return the Nth kill forward."
1163 (let ((interprogram-paste (and (= n 0)
1164 interprogram-paste-function
1165 (funcall interprogram-paste-function))))
1166 (if interprogram-paste
1167 (progn
1168 ;; Disable the interprogram cut function when we add the new
1169 ;; text to the kill ring, so Emacs doesn't try to own the
1170 ;; selection, with identical text.
1171 (let ((interprogram-cut-function nil))
1172 (kill-new interprogram-paste))
1173 interprogram-paste)
1174 (or kill-ring (error "Kill ring is empty"))
1175 (let ((ARGth-kill-element
1176 (nthcdr (mod (- n (length kill-ring-yank-pointer))
1177 (length kill-ring))
1178 kill-ring)))
1179 (or do-not-move
1180 (setq kill-ring-yank-pointer ARGth-kill-element))
1181 (car ARGth-kill-element)))))
1182
1183
1184 \f
1185 ;;;; Commands for manipulating the kill ring.
1186
1187 (defvar kill-read-only-ok nil
1188 "*Non-nil means don't signal an error for killing read-only text.")
1189
1190 (put 'text-read-only 'error-conditions
1191 '(text-read-only buffer-read-only error))
1192 (put 'text-read-only 'error-message "Text is read-only")
1193
1194 (defun kill-region (beg end)
1195 "Kill between point and mark.
1196 The text is deleted but saved in the kill ring.
1197 The command \\[yank] can retrieve it from there.
1198 \(If you want to kill and then yank immediately, use \\[copy-region-as-kill].)
1199 If the buffer is read-only, Emacs will beep and refrain from deleting
1200 the text, but put the text in the kill ring anyway. This means that
1201 you can use the killing commands to copy text from a read-only buffer.
1202
1203 This is the primitive for programs to kill text (as opposed to deleting it).
1204 Supply two arguments, character numbers indicating the stretch of text
1205 to be killed.
1206 Any command that calls this function is a \"kill command\".
1207 If the previous command was also a kill command,
1208 the text killed this time appends to the text killed last time
1209 to make one entry in the kill ring."
1210 (interactive "r")
1211 (cond
1212
1213 ;; If the buffer is read-only, we should beep, in case the person
1214 ;; just isn't aware of this. However, there's no harm in putting
1215 ;; the region's text in the kill ring, anyway.
1216 ((or (and buffer-read-only (not inhibit-read-only))
1217 (text-property-not-all beg end 'read-only nil))
1218 (copy-region-as-kill beg end)
1219 ;; This should always barf, and give us the correct error.
1220 (if kill-read-only-ok
1221 (message "Read only text copied to kill ring")
1222 (setq this-command 'kill-region)
1223 ;; Signal an error if the buffer is read-only.
1224 (barf-if-buffer-read-only)
1225 ;; If the buffer isn't read-only, the text is.
1226 (signal 'text-read-only (list (current-buffer)))))
1227
1228 ;; In certain cases, we can arrange for the undo list and the kill
1229 ;; ring to share the same string object. This code does that.
1230 ((not (or (eq buffer-undo-list t)
1231 (eq last-command 'kill-region)
1232 ;; Use = since positions may be numbers or markers.
1233 (= beg end)))
1234 ;; Don't let the undo list be truncated before we can even access it.
1235 (let ((undo-strong-limit (+ (- (max beg end) (min beg end)) 100))
1236 (old-list buffer-undo-list)
1237 tail)
1238 (delete-region beg end)
1239 ;; Search back in buffer-undo-list for this string,
1240 ;; in case a change hook made property changes.
1241 (setq tail buffer-undo-list)
1242 (while (not (stringp (car (car tail))))
1243 (setq tail (cdr tail)))
1244 ;; Take the same string recorded for undo
1245 ;; and put it in the kill-ring.
1246 (kill-new (car (car tail)))))
1247
1248 (t
1249 (copy-region-as-kill beg end)
1250 (delete-region beg end)))
1251 (setq this-command 'kill-region))
1252
1253 ;; copy-region-as-kill no longer sets this-command, because it's confusing
1254 ;; to get two copies of the text when the user accidentally types M-w and
1255 ;; then corrects it with the intended C-w.
1256 (defun copy-region-as-kill (beg end)
1257 "Save the region as if killed, but don't kill it.
1258 If `interprogram-cut-function' is non-nil, also save the text for a window
1259 system cut and paste."
1260 (interactive "r")
1261 (if (eq last-command 'kill-region)
1262 (kill-append (buffer-substring beg end) (< end beg))
1263 (kill-new (buffer-substring beg end)))
1264 nil)
1265
1266 (defun kill-ring-save (beg end)
1267 "Save the region as if killed, but don't kill it.
1268 This command is similar to `copy-region-as-kill', except that it gives
1269 visual feedback indicating the extent of the region being copied.
1270 If `interprogram-cut-function' is non-nil, also save the text for a window
1271 system cut and paste."
1272 (interactive "r")
1273 (copy-region-as-kill beg end)
1274 (if (interactive-p)
1275 (let ((other-end (if (= (point) beg) end beg))
1276 (opoint (point))
1277 ;; Inhibit quitting so we can make a quit here
1278 ;; look like a C-g typed as a command.
1279 (inhibit-quit t))
1280 (if (pos-visible-in-window-p other-end (selected-window))
1281 (progn
1282 ;; Swap point and mark.
1283 (set-marker (mark-marker) (point) (current-buffer))
1284 (goto-char other-end)
1285 (sit-for 1)
1286 ;; Swap back.
1287 (set-marker (mark-marker) other-end (current-buffer))
1288 (goto-char opoint)
1289 ;; If user quit, deactivate the mark
1290 ;; as C-g would as a command.
1291 (and quit-flag mark-active
1292 (deactivate-mark)))
1293 (let* ((killed-text (current-kill 0))
1294 (message-len (min (length killed-text) 40)))
1295 (if (= (point) beg)
1296 ;; Don't say "killed"; that is misleading.
1297 (message "Saved text until \"%s\""
1298 (substring killed-text (- message-len)))
1299 (message "Saved text from \"%s\""
1300 (substring killed-text 0 message-len))))))))
1301
1302 (defun append-next-kill ()
1303 "Cause following command, if it kills, to append to previous kill."
1304 (interactive)
1305 (if (interactive-p)
1306 (progn
1307 (setq this-command 'kill-region)
1308 (message "If the next command is a kill, it will append"))
1309 (setq last-command 'kill-region)))
1310
1311 (defun yank-pop (arg)
1312 "Replace just-yanked stretch of killed text with a different stretch.
1313 This command is allowed only immediately after a `yank' or a `yank-pop'.
1314 At such a time, the region contains a stretch of reinserted
1315 previously-killed text. `yank-pop' deletes that text and inserts in its
1316 place a different stretch of killed text.
1317
1318 With no argument, the previous kill is inserted.
1319 With argument N, insert the Nth previous kill.
1320 If N is negative, this is a more recent kill.
1321
1322 The sequence of kills wraps around, so that after the oldest one
1323 comes the newest one."
1324 (interactive "*p")
1325 (if (not (eq last-command 'yank))
1326 (error "Previous command was not a yank"))
1327 (setq this-command 'yank)
1328 (let ((inhibit-read-only t)
1329 (before (< (point) (mark t))))
1330 (delete-region (point) (mark t))
1331 (set-marker (mark-marker) (point) (current-buffer))
1332 (insert (current-kill arg))
1333 (if before
1334 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
1335 ;; It is cleaner to avoid activation, even though the command
1336 ;; loop would deactivate the mark because we inserted text.
1337 (goto-char (prog1 (mark t)
1338 (set-marker (mark-marker) (point) (current-buffer))))))
1339 nil)
1340
1341 (defun yank (&optional arg)
1342 "Reinsert the last stretch of killed text.
1343 More precisely, reinsert the stretch of killed text most recently
1344 killed OR yanked. Put point at end, and set mark at beginning.
1345 With just C-u as argument, same but put point at beginning (and mark at end).
1346 With argument N, reinsert the Nth most recently killed stretch of killed
1347 text.
1348 See also the command \\[yank-pop]."
1349 (interactive "*P")
1350 ;; If we don't get all the way thru, make last-command indicate that
1351 ;; for the following command.
1352 (setq this-command t)
1353 (push-mark (point))
1354 (insert (current-kill (cond
1355 ((listp arg) 0)
1356 ((eq arg '-) -1)
1357 (t (1- arg)))))
1358 (if (consp arg)
1359 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
1360 ;; It is cleaner to avoid activation, even though the command
1361 ;; loop would deactivate the mark because we inserted text.
1362 (goto-char (prog1 (mark t)
1363 (set-marker (mark-marker) (point) (current-buffer)))))
1364 ;; If we do get all the way thru, make this-command indicate that.
1365 (setq this-command 'yank)
1366 nil)
1367
1368 (defun rotate-yank-pointer (arg)
1369 "Rotate the yanking point in the kill ring.
1370 With argument, rotate that many kills forward (or backward, if negative)."
1371 (interactive "p")
1372 (current-kill arg))
1373
1374 \f
1375 (defun insert-buffer (buffer)
1376 "Insert after point the contents of BUFFER.
1377 Puts mark after the inserted text.
1378 BUFFER may be a buffer or a buffer name."
1379 (interactive
1380 (list
1381 (progn
1382 (barf-if-buffer-read-only)
1383 (read-buffer "Insert buffer: "
1384 (if (eq (selected-window) (next-window (selected-window)))
1385 (other-buffer (current-buffer))
1386 (window-buffer (next-window (selected-window))))
1387 t))))
1388 (or (bufferp buffer)
1389 (setq buffer (get-buffer buffer)))
1390 (let (start end newmark)
1391 (save-excursion
1392 (save-excursion
1393 (set-buffer buffer)
1394 (setq start (point-min) end (point-max)))
1395 (insert-buffer-substring buffer start end)
1396 (setq newmark (point)))
1397 (push-mark newmark))
1398 nil)
1399
1400 (defun append-to-buffer (buffer start end)
1401 "Append to specified buffer the text of the region.
1402 It is inserted into that buffer before its point.
1403
1404 When calling from a program, give three arguments:
1405 BUFFER (or buffer name), START and END.
1406 START and END specify the portion of the current buffer to be copied."
1407 (interactive
1408 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
1409 (region-beginning) (region-end)))
1410 (let ((oldbuf (current-buffer)))
1411 (save-excursion
1412 (set-buffer (get-buffer-create buffer))
1413 (insert-buffer-substring oldbuf start end))))
1414
1415 (defun prepend-to-buffer (buffer start end)
1416 "Prepend to specified buffer the text of the region.
1417 It is inserted into that buffer after its point.
1418
1419 When calling from a program, give three arguments:
1420 BUFFER (or buffer name), START and END.
1421 START and END specify the portion of the current buffer to be copied."
1422 (interactive "BPrepend to buffer: \nr")
1423 (let ((oldbuf (current-buffer)))
1424 (save-excursion
1425 (set-buffer (get-buffer-create buffer))
1426 (save-excursion
1427 (insert-buffer-substring oldbuf start end)))))
1428
1429 (defun copy-to-buffer (buffer start end)
1430 "Copy to specified buffer the text of the region.
1431 It is inserted into that buffer, replacing existing text there.
1432
1433 When calling from a program, give three arguments:
1434 BUFFER (or buffer name), START and END.
1435 START and END specify the portion of the current buffer to be copied."
1436 (interactive "BCopy to buffer: \nr")
1437 (let ((oldbuf (current-buffer)))
1438 (save-excursion
1439 (set-buffer (get-buffer-create buffer))
1440 (erase-buffer)
1441 (save-excursion
1442 (insert-buffer-substring oldbuf start end)))))
1443 \f
1444 (put 'mark-inactive 'error-conditions '(mark-inactive error))
1445 (put 'mark-inactive 'error-message "The mark is not active now")
1446
1447 (defun mark (&optional force)
1448 "Return this buffer's mark value as integer; error if mark inactive.
1449 If optional argument FORCE is non-nil, access the mark value
1450 even if the mark is not currently active, and return nil
1451 if there is no mark at all.
1452
1453 If you are using this in an editing command, you are most likely making
1454 a mistake; see the documentation of `set-mark'."
1455 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
1456 (marker-position (mark-marker))
1457 (signal 'mark-inactive nil)))
1458
1459 ;; Many places set mark-active directly, and several of them failed to also
1460 ;; run deactivate-mark-hook. This shorthand should simplify.
1461 (defsubst deactivate-mark ()
1462 "Deactivate the mark by setting `mark-active' to nil.
1463 \(That makes a difference only in Transient Mark mode.)
1464 Also runs the hook `deactivate-mark-hook'."
1465 (if transient-mark-mode
1466 (progn
1467 (setq mark-active nil)
1468 (run-hooks 'deactivate-mark-hook))))
1469
1470 (defun set-mark (pos)
1471 "Set this buffer's mark to POS. Don't use this function!
1472 That is to say, don't use this function unless you want
1473 the user to see that the mark has moved, and you want the previous
1474 mark position to be lost.
1475
1476 Normally, when a new mark is set, the old one should go on the stack.
1477 This is why most applications should use push-mark, not set-mark.
1478
1479 Novice Emacs Lisp programmers often try to use the mark for the wrong
1480 purposes. The mark saves a location for the user's convenience.
1481 Most editing commands should not alter the mark.
1482 To remember a location for internal use in the Lisp program,
1483 store it in a Lisp variable. Example:
1484
1485 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
1486
1487 (if pos
1488 (progn
1489 (setq mark-active t)
1490 (run-hooks 'activate-mark-hook)
1491 (set-marker (mark-marker) pos (current-buffer)))
1492 ;; Normally we never clear mark-active except in Transient Mark mode.
1493 ;; But when we actually clear out the mark value too,
1494 ;; we must clear mark-active in any mode.
1495 (setq mark-active nil)
1496 (run-hooks 'deactivate-mark-hook)
1497 (set-marker (mark-marker) nil)))
1498
1499 (defvar mark-ring nil
1500 "The list of former marks of the current buffer, most recent first.")
1501 (make-variable-buffer-local 'mark-ring)
1502 (put 'mark-ring 'permanent-local t)
1503
1504 (defconst mark-ring-max 16
1505 "*Maximum size of mark ring. Start discarding off end if gets this big.")
1506
1507 (defvar global-mark-ring nil
1508 "The list of saved global marks, most recent first.")
1509
1510 (defconst global-mark-ring-max 16
1511 "*Maximum size of global mark ring. \
1512 Start discarding off end if gets this big.")
1513
1514 (defun set-mark-command (arg)
1515 "Set mark at where point is, or jump to mark.
1516 With no prefix argument, set mark, push old mark position on local mark
1517 ring, and push mark on global mark ring.
1518 With argument, jump to mark, and pop a new position for mark off the ring
1519 \(does not affect global mark ring\).
1520
1521 Novice Emacs Lisp programmers often try to use the mark for the wrong
1522 purposes. See the documentation of `set-mark' for more information."
1523 (interactive "P")
1524 (if (null arg)
1525 (progn
1526 (push-mark nil nil t))
1527 (if (null (mark t))
1528 (error "No mark set in this buffer")
1529 (goto-char (mark t))
1530 (pop-mark))))
1531
1532 (defun push-mark (&optional location nomsg activate)
1533 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
1534 If the last global mark pushed was not in the current buffer,
1535 also push LOCATION on the global mark ring.
1536 Display `Mark set' unless the optional second arg NOMSG is non-nil.
1537 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil.
1538
1539 Novice Emacs Lisp programmers often try to use the mark for the wrong
1540 purposes. See the documentation of `set-mark' for more information.
1541
1542 In Transient Mark mode, this does not activate the mark."
1543 (if (null (mark t))
1544 nil
1545 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
1546 (if (> (length mark-ring) mark-ring-max)
1547 (progn
1548 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
1549 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil))))
1550 (set-marker (mark-marker) (or location (point)) (current-buffer))
1551 ;; Now push the mark on the global mark ring.
1552 (if (and global-mark-ring
1553 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
1554 ;; The last global mark pushed was in this same buffer.
1555 ;; Don't push another one.
1556 nil
1557 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
1558 (if (> (length global-mark-ring) global-mark-ring-max)
1559 (progn
1560 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring))
1561 nil)
1562 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil))))
1563 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
1564 (message "Mark set"))
1565 (if (or activate (not transient-mark-mode))
1566 (set-mark (mark t)))
1567 nil)
1568
1569 (defun pop-mark ()
1570 "Pop off mark ring into the buffer's actual mark.
1571 Does not set point. Does nothing if mark ring is empty."
1572 (if mark-ring
1573 (progn
1574 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
1575 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
1576 (deactivate-mark)
1577 (move-marker (car mark-ring) nil)
1578 (if (null (mark t)) (ding))
1579 (setq mark-ring (cdr mark-ring)))))
1580
1581 (define-function 'exchange-dot-and-mark 'exchange-point-and-mark)
1582 (defun exchange-point-and-mark ()
1583 "Put the mark where point is now, and point where the mark is now.
1584 This command works even when the mark is not active,
1585 and it reactivates the mark."
1586 (interactive nil)
1587 (let ((omark (mark t)))
1588 (if (null omark)
1589 (error "No mark set in this buffer"))
1590 (set-mark (point))
1591 (goto-char omark)
1592 nil))
1593
1594 (defun transient-mark-mode (arg)
1595 "Toggle Transient Mark mode.
1596 With arg, turn Transient Mark mode on if arg is positive, off otherwise.
1597
1598 In Transient Mark mode, when the mark is active, the region is highlighted.
1599 Changing the buffer \"deactivates\" the mark.
1600 So do certain other operations that set the mark
1601 but whose main purpose is something else--for example,
1602 incremental search, \\[beginning-of-buffer], and \\[end-of-buffer]."
1603 (interactive "P")
1604 (setq transient-mark-mode
1605 (if (null arg)
1606 (not transient-mark-mode)
1607 (> (prefix-numeric-value arg) 0))))
1608
1609 (defun pop-global-mark ()
1610 "Pop off global mark ring and jump to the top location."
1611 (interactive)
1612 ;; Pop entries which refer to non-existent buffers.
1613 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
1614 (setq global-mark-ring (cdr global-mark-ring)))
1615 (or global-mark-ring
1616 (error "No global mark set"))
1617 (let* ((marker (car global-mark-ring))
1618 (buffer (marker-buffer marker))
1619 (position (marker-position marker)))
1620 (setq global-mark-ring (nconc (cdr global-mark-ring)
1621 (list (car global-mark-ring))))
1622 (set-buffer buffer)
1623 (or (and (>= position (point-min))
1624 (<= position (point-max)))
1625 (widen))
1626 (goto-char position)
1627 (switch-to-buffer buffer)))
1628 \f
1629 (defvar next-line-add-newlines t
1630 "*If non-nil, `next-line' inserts newline to avoid `end of buffer' error.")
1631
1632 (defun next-line (arg)
1633 "Move cursor vertically down ARG lines.
1634 If there is no character in the target line exactly under the current column,
1635 the cursor is positioned after the character in that line which spans this
1636 column, or at the end of the line if it is not long enough.
1637 If there is no line in the buffer after this one, behavior depends on the
1638 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
1639 to create a line, and moves the cursor to that line. Otherwise it moves the
1640 cursor to the end of the buffer.
1641
1642 The command \\[set-goal-column] can be used to create
1643 a semipermanent goal column to which this command always moves.
1644 Then it does not try to move vertically. This goal column is stored
1645 in `goal-column', which is nil when there is none.
1646
1647 If you are thinking of using this in a Lisp program, consider
1648 using `forward-line' instead. It is usually easier to use
1649 and more reliable (no dependence on goal column, etc.)."
1650 (interactive "p")
1651 (if (and next-line-add-newlines (= arg 1))
1652 (let ((opoint (point)))
1653 (end-of-line)
1654 (if (eobp)
1655 (newline 1)
1656 (goto-char opoint)
1657 (line-move arg)))
1658 (if (interactive-p)
1659 (condition-case nil
1660 (line-move arg)
1661 ((beginning-of-buffer end-of-buffer) (ding)))
1662 (line-move arg)))
1663 nil)
1664
1665 (defun previous-line (arg)
1666 "Move cursor vertically up ARG lines.
1667 If there is no character in the target line exactly over the current column,
1668 the cursor is positioned after the character in that line which spans this
1669 column, or at the end of the line if it is not long enough.
1670
1671 The command \\[set-goal-column] can be used to create
1672 a semipermanent goal column to which this command always moves.
1673 Then it does not try to move vertically.
1674
1675 If you are thinking of using this in a Lisp program, consider using
1676 `forward-line' with a negative argument instead. It is usually easier
1677 to use and more reliable (no dependence on goal column, etc.)."
1678 (interactive "p")
1679 (if (interactive-p)
1680 (condition-case nil
1681 (line-move (- arg))
1682 ((beginning-of-buffer end-of-buffer) (ding)))
1683 (line-move (- arg)))
1684 nil)
1685
1686 (defconst track-eol nil
1687 "*Non-nil means vertical motion starting at end of line keeps to ends of lines.
1688 This means moving to the end of each line moved onto.
1689 The beginning of a blank line does not count as the end of a line.")
1690
1691 (defvar goal-column nil
1692 "*Semipermanent goal column for vertical motion, as set by \\[set-goal-column], or nil.")
1693 (make-variable-buffer-local 'goal-column)
1694
1695 (defvar temporary-goal-column 0
1696 "Current goal column for vertical motion.
1697 It is the column where point was
1698 at the start of current run of vertical motion commands.
1699 When the `track-eol' feature is doing its job, the value is 9999.")
1700
1701 (defvar line-move-ignore-invisible nil
1702 "*Non-nil means \\[next-line] and \\[previous-line] ignore invisible lines.
1703 Outline mode sets this.")
1704
1705 ;; This is the guts of next-line and previous-line.
1706 ;; Arg says how many lines to move.
1707 (defun line-move (arg)
1708 ;; Don't run any point-motion hooks, and disregard intangibility,
1709 ;; for intermediate positions.
1710 (let ((inhibit-point-motion-hooks t)
1711 (opoint (point))
1712 new)
1713 (unwind-protect
1714 (progn
1715 (if (not (or (eq last-command 'next-line)
1716 (eq last-command 'previous-line)))
1717 (setq temporary-goal-column
1718 (if (and track-eol (eolp)
1719 ;; Don't count beg of empty line as end of line
1720 ;; unless we just did explicit end-of-line.
1721 (or (not (bolp)) (eq last-command 'end-of-line)))
1722 9999
1723 (current-column))))
1724 (if (and (not (integerp selective-display))
1725 (not line-move-ignore-invisible))
1726 ;; Use just newline characters.
1727 (or (if (> arg 0)
1728 (progn (if (> arg 1) (forward-line (1- arg)))
1729 ;; This way of moving forward ARG lines
1730 ;; verifies that we have a newline after the last one.
1731 ;; It doesn't get confused by intangible text.
1732 (end-of-line)
1733 (zerop (forward-line 1)))
1734 (and (zerop (forward-line arg))
1735 (bolp)))
1736 (signal (if (< arg 0)
1737 'beginning-of-buffer
1738 'end-of-buffer)
1739 nil))
1740 ;; Move by arg lines, but ignore invisible ones.
1741 (while (> arg 0)
1742 (end-of-line)
1743 (and (zerop (vertical-motion 1))
1744 (signal 'end-of-buffer nil))
1745 ;; If the following character is currently invisible,
1746 ;; skip all characters with that same `invisible' property value.
1747 (while (and (not (eobp))
1748 (let ((prop
1749 (get-char-property (point) 'invisible)))
1750 (if (eq buffer-invisibility-spec t)
1751 prop
1752 (or (memq prop buffer-invisibility-spec)
1753 (assq prop buffer-invisibility-spec)))))
1754 (if (get-text-property (point) 'invisible)
1755 (goto-char (next-single-property-change (point) 'invisible))
1756 (goto-char (next-overlay-change (point)))))
1757 (setq arg (1- arg)))
1758 (while (< arg 0)
1759 (beginning-of-line)
1760 (and (zerop (vertical-motion -1))
1761 (signal 'beginning-of-buffer nil))
1762 (while (and (not (bobp))
1763 (let ((prop
1764 (get-char-property (1- (point)) 'invisible)))
1765 (if (eq buffer-invisibility-spec t)
1766 prop
1767 (or (memq prop buffer-invisibility-spec)
1768 (assq prop buffer-invisibility-spec)))))
1769 (if (get-text-property (1- (point)) 'invisible)
1770 (goto-char (previous-single-property-change (point) 'invisible))
1771 (goto-char (previous-overlay-change (point)))))
1772 (setq arg (1+ arg))))
1773 (move-to-column (or goal-column temporary-goal-column)))
1774 ;; Remember where we moved to, go back home,
1775 ;; then do the motion over again
1776 ;; in just one step, with intangibility and point-motion hooks
1777 ;; enabled this time.
1778 (setq new (point))
1779 (goto-char opoint)
1780 (setq inhibit-point-motion-hooks nil)
1781 (goto-char new)))
1782 nil)
1783
1784 ;;; Many people have said they rarely use this feature, and often type
1785 ;;; it by accident. Maybe it shouldn't even be on a key.
1786 (put 'set-goal-column 'disabled t)
1787
1788 (defun set-goal-column (arg)
1789 "Set the current horizontal position as a goal for \\[next-line] and \\[previous-line].
1790 Those commands will move to this position in the line moved to
1791 rather than trying to keep the same horizontal position.
1792 With a non-nil argument, clears out the goal column
1793 so that \\[next-line] and \\[previous-line] resume vertical motion.
1794 The goal column is stored in the variable `goal-column'."
1795 (interactive "P")
1796 (if arg
1797 (progn
1798 (setq goal-column nil)
1799 (message "No goal column"))
1800 (setq goal-column (current-column))
1801 (message (substitute-command-keys
1802 "Goal column %d (use \\[set-goal-column] with an arg to unset it)")
1803 goal-column))
1804 nil)
1805 \f
1806 ;;; Partial support for horizontal autoscrolling. Someday, this feature
1807 ;;; will be built into the C level and all the (hscroll-point-visible) calls
1808 ;;; will go away.
1809
1810 (defvar hscroll-step 0
1811 "*The number of columns to try scrolling a window by when point moves out.
1812 If that fails to bring point back on frame, point is centered instead.
1813 If this is zero, point is always centered after it moves off frame.")
1814
1815 (defun hscroll-point-visible ()
1816 "Scrolls the selected window horizontally to make point visible."
1817 (save-excursion
1818 (set-buffer (window-buffer))
1819 (if (not (or truncate-lines
1820 (> (window-hscroll) 0)
1821 (and truncate-partial-width-windows
1822 (< (window-width) (frame-width)))))
1823 ;; Point is always visible when lines are wrapped.
1824 ()
1825 ;; If point is on the invisible part of the line before window-start,
1826 ;; then hscrolling can't bring it back, so reset window-start first.
1827 (and (< (point) (window-start))
1828 (let ((ws-bol (save-excursion
1829 (goto-char (window-start))
1830 (beginning-of-line)
1831 (point))))
1832 (and (>= (point) ws-bol)
1833 (set-window-start nil ws-bol))))
1834 (let* ((here (hscroll-window-column))
1835 (left (min (window-hscroll) 1))
1836 (right (1- (window-width))))
1837 ;; Allow for the truncation glyph, if we're not exactly at eol.
1838 (if (not (and (= here right)
1839 (= (following-char) ?\n)))
1840 (setq right (1- right)))
1841 (cond
1842 ;; If too far away, just recenter. But don't show too much
1843 ;; white space off the end of the line.
1844 ((or (< here (- left hscroll-step))
1845 (> here (+ right hscroll-step)))
1846 (let ((eol (save-excursion (end-of-line) (hscroll-window-column))))
1847 (scroll-left (min (- here (/ (window-width) 2))
1848 (- eol (window-width) -5)))))
1849 ;; Within range. Scroll by one step (or maybe not at all).
1850 ((< here left)
1851 (scroll-right hscroll-step))
1852 ((> here right)
1853 (scroll-left hscroll-step)))))))
1854
1855 ;; This function returns the window's idea of the display column of point,
1856 ;; assuming that the window is already known to be truncated rather than
1857 ;; wrapped, and that we've already handled the case where point is on the
1858 ;; part of the line before window-start. We ignore window-width; if point
1859 ;; is beyond the right margin, we want to know how far. The return value
1860 ;; includes the effects of window-hscroll, window-start, and the prompt
1861 ;; string in the minibuffer. It may be negative due to hscroll.
1862 (defun hscroll-window-column ()
1863 (let* ((hscroll (window-hscroll))
1864 (startpos (save-excursion
1865 (beginning-of-line)
1866 (if (= (point) (save-excursion
1867 (goto-char (window-start))
1868 (beginning-of-line)
1869 (point)))
1870 (goto-char (window-start)))
1871 (point)))
1872 (hpos (+ (if (and (eq (selected-window) (minibuffer-window))
1873 (= 1 (window-start))
1874 (= startpos (point-min)))
1875 (minibuffer-prompt-width)
1876 0)
1877 (min 0 (- 1 hscroll))))
1878 val)
1879 (car (cdr (compute-motion startpos (cons hpos 0)
1880 (point) (cons 0 1)
1881 1000000 (cons hscroll 0) nil)))))
1882
1883
1884 ;; rms: (1) The definitions of arrow keys should not simply restate
1885 ;; what keys they are. The arrow keys should run the ordinary commands.
1886 ;; (2) The arrow keys are just one of many common ways of moving point
1887 ;; within a line. Real horizontal autoscrolling would be a good feature,
1888 ;; but supporting it only for arrow keys is too incomplete to be desirable.
1889
1890 ;;;;; Make arrow keys do the right thing for improved terminal support
1891 ;;;;; When we implement true horizontal autoscrolling, right-arrow and
1892 ;;;;; left-arrow can lose the (if truncate-lines ...) clause and become
1893 ;;;;; aliases. These functions are bound to the corresponding keyboard
1894 ;;;;; events in loaddefs.el.
1895
1896 ;;(defun right-arrow (arg)
1897 ;; "Move right one character on the screen (with prefix ARG, that many chars).
1898 ;;Scroll right if needed to keep point horizontally onscreen."
1899 ;; (interactive "P")
1900 ;; (forward-char arg)
1901 ;; (hscroll-point-visible))
1902
1903 ;;(defun left-arrow (arg)
1904 ;; "Move left one character on the screen (with prefix ARG, that many chars).
1905 ;;Scroll left if needed to keep point horizontally onscreen."
1906 ;; (interactive "P")
1907 ;; (backward-char arg)
1908 ;; (hscroll-point-visible))
1909
1910 (defun scroll-other-window-down (lines)
1911 "Scroll the \"other window\" down.
1912 For more details, see the documentation for `scroll-other-window'."
1913 (interactive "P")
1914 (scroll-other-window
1915 ;; Just invert the argument's meaning.
1916 ;; We can do that without knowing which window it will be.
1917 (if (eq lines '-) nil
1918 (if (null lines) '-
1919 (- (prefix-numeric-value lines))))))
1920 (define-key esc-map [?\C-\S-v] 'scroll-other-window-down)
1921
1922 (defun beginning-of-buffer-other-window (arg)
1923 "Move point to the beginning of the buffer in the other window.
1924 Leave mark at previous position.
1925 With arg N, put point N/10 of the way from the true beginning."
1926 (interactive "P")
1927 (let ((orig-window (selected-window))
1928 (window (other-window-for-scrolling)))
1929 ;; We use unwind-protect rather than save-window-excursion
1930 ;; because the latter would preserve the things we want to change.
1931 (unwind-protect
1932 (progn
1933 (select-window window)
1934 ;; Set point and mark in that window's buffer.
1935 (beginning-of-buffer arg)
1936 ;; Set point accordingly.
1937 (recenter '(t)))
1938 (select-window orig-window))))
1939
1940 (defun end-of-buffer-other-window (arg)
1941 "Move point to the end of the buffer in the other window.
1942 Leave mark at previous position.
1943 With arg N, put point N/10 of the way from the true end."
1944 (interactive "P")
1945 ;; See beginning-of-buffer-other-window for comments.
1946 (let ((orig-window (selected-window))
1947 (window (other-window-for-scrolling)))
1948 (unwind-protect
1949 (progn
1950 (select-window window)
1951 (end-of-buffer arg)
1952 (recenter '(t)))
1953 (select-window orig-window))))
1954 \f
1955 (defun transpose-chars (arg)
1956 "Interchange characters around point, moving forward one character.
1957 With prefix arg ARG, effect is to take character before point
1958 and drag it forward past ARG other characters (backward if ARG negative).
1959 If no argument and at end of line, the previous two chars are exchanged."
1960 (interactive "*P")
1961 (and (null arg) (eolp) (forward-char -1))
1962 (transpose-subr 'forward-char (prefix-numeric-value arg)))
1963
1964 (defun transpose-words (arg)
1965 "Interchange words around point, leaving point at end of them.
1966 With prefix arg ARG, effect is to take word before or around point
1967 and drag it forward past ARG other words (backward if ARG negative).
1968 If ARG is zero, the words around or after point and around or after mark
1969 are interchanged."
1970 (interactive "*p")
1971 (transpose-subr 'forward-word arg))
1972
1973 (defun transpose-sexps (arg)
1974 "Like \\[transpose-words] but applies to sexps.
1975 Does not work on a sexp that point is in the middle of
1976 if it is a list or string."
1977 (interactive "*p")
1978 (transpose-subr 'forward-sexp arg))
1979
1980 (defun transpose-lines (arg)
1981 "Exchange current line and previous line, leaving point after both.
1982 With argument ARG, takes previous line and moves it past ARG lines.
1983 With argument 0, interchanges line point is in with line mark is in."
1984 (interactive "*p")
1985 (transpose-subr (function
1986 (lambda (arg)
1987 (if (= arg 1)
1988 (progn
1989 ;; Move forward over a line,
1990 ;; but create a newline if none exists yet.
1991 (end-of-line)
1992 (if (eobp)
1993 (newline)
1994 (forward-char 1)))
1995 (forward-line arg))))
1996 arg))
1997
1998 (defun transpose-subr (mover arg)
1999 (let (start1 end1 start2 end2)
2000 (if (= arg 0)
2001 (progn
2002 (save-excursion
2003 (funcall mover 1)
2004 (setq end2 (point))
2005 (funcall mover -1)
2006 (setq start2 (point))
2007 (goto-char (mark))
2008 (funcall mover 1)
2009 (setq end1 (point))
2010 (funcall mover -1)
2011 (setq start1 (point))
2012 (transpose-subr-1))
2013 (exchange-point-and-mark)))
2014 (while (> arg 0)
2015 (funcall mover -1)
2016 (setq start1 (point))
2017 (funcall mover 1)
2018 (setq end1 (point))
2019 (funcall mover 1)
2020 (setq end2 (point))
2021 (funcall mover -1)
2022 (setq start2 (point))
2023 (transpose-subr-1)
2024 (goto-char end2)
2025 (setq arg (1- arg)))
2026 (while (< arg 0)
2027 (funcall mover -1)
2028 (setq start2 (point))
2029 (funcall mover -1)
2030 (setq start1 (point))
2031 (funcall mover 1)
2032 (setq end1 (point))
2033 (funcall mover 1)
2034 (setq end2 (point))
2035 (transpose-subr-1)
2036 (setq arg (1+ arg)))))
2037
2038 (defun transpose-subr-1 ()
2039 (if (> (min end1 end2) (max start1 start2))
2040 (error "Don't have two things to transpose"))
2041 (let ((word1 (buffer-substring start1 end1))
2042 (word2 (buffer-substring start2 end2)))
2043 (delete-region start2 end2)
2044 (goto-char start2)
2045 (insert word1)
2046 (goto-char (if (< start1 start2) start1
2047 (+ start1 (- (length word1) (length word2)))))
2048 (delete-char (length word1))
2049 (insert word2)))
2050 \f
2051 (defconst comment-column 32
2052 "*Column to indent right-margin comments to.
2053 Setting this variable automatically makes it local to the current buffer.
2054 Each mode establishes a different default value for this variable; you
2055 can set the value for a particular mode using that mode's hook.")
2056 (make-variable-buffer-local 'comment-column)
2057
2058 (defconst comment-start nil
2059 "*String to insert to start a new comment, or nil if no comment syntax.")
2060
2061 (defconst comment-start-skip nil
2062 "*Regexp to match the start of a comment plus everything up to its body.
2063 If there are any \\(...\\) pairs, the comment delimiter text is held to begin
2064 at the place matched by the close of the first pair.")
2065
2066 (defconst comment-end ""
2067 "*String to insert to end a new comment.
2068 Should be an empty string if comments are terminated by end-of-line.")
2069
2070 (defconst comment-indent-hook nil
2071 "Obsolete variable for function to compute desired indentation for a comment.
2072 This function is called with no args with point at the beginning of
2073 the comment's starting delimiter.")
2074
2075 (defconst comment-indent-function
2076 '(lambda () comment-column)
2077 "Function to compute desired indentation for a comment.
2078 This function is called with no args with point at the beginning of
2079 the comment's starting delimiter.")
2080
2081 (defconst block-comment-start nil
2082 "*String to insert to start a new comment on a line by itself.
2083 If nil, use `comment-start' instead.
2084 Note that the regular expression `comment-start-skip' should skip this string
2085 as well as the `comment-start' string.")
2086
2087 (defconst block-comment-end nil
2088 "*String to insert to end a new comment on a line by itself.
2089 Should be an empty string if comments are terminated by end-of-line.
2090 If nil, use `comment-end' instead.")
2091
2092 (defun indent-for-comment ()
2093 "Indent this line's comment to comment column, or insert an empty comment."
2094 (interactive "*")
2095 (let* ((empty (save-excursion (beginning-of-line)
2096 (looking-at "[ \t]*$")))
2097 (starter (or (and empty block-comment-start) comment-start))
2098 (ender (or (and empty block-comment-end) comment-end)))
2099 (if (null starter)
2100 (error "No comment syntax defined")
2101 (let* ((eolpos (save-excursion (end-of-line) (point)))
2102 cpos indent begpos)
2103 (beginning-of-line)
2104 (if (re-search-forward comment-start-skip eolpos 'move)
2105 (progn (setq cpos (point-marker))
2106 ;; Find the start of the comment delimiter.
2107 ;; If there were paren-pairs in comment-start-skip,
2108 ;; position at the end of the first pair.
2109 (if (match-end 1)
2110 (goto-char (match-end 1))
2111 ;; If comment-start-skip matched a string with
2112 ;; internal whitespace (not final whitespace) then
2113 ;; the delimiter start at the end of that
2114 ;; whitespace. Otherwise, it starts at the
2115 ;; beginning of what was matched.
2116 (skip-syntax-backward " " (match-beginning 0))
2117 (skip-syntax-backward "^ " (match-beginning 0)))))
2118 (setq begpos (point))
2119 ;; Compute desired indent.
2120 (if (= (current-column)
2121 (setq indent (if comment-indent-hook
2122 (funcall comment-indent-hook)
2123 (funcall comment-indent-function))))
2124 (goto-char begpos)
2125 ;; If that's different from current, change it.
2126 (skip-chars-backward " \t")
2127 (delete-region (point) begpos)
2128 (indent-to indent))
2129 ;; An existing comment?
2130 (if cpos
2131 (progn (goto-char cpos)
2132 (set-marker cpos nil))
2133 ;; No, insert one.
2134 (insert starter)
2135 (save-excursion
2136 (insert ender)))))))
2137
2138 (defun set-comment-column (arg)
2139 "Set the comment column based on point.
2140 With no arg, set the comment column to the current column.
2141 With just minus as arg, kill any comment on this line.
2142 With any other arg, set comment column to indentation of the previous comment
2143 and then align or create a comment on this line at that column."
2144 (interactive "P")
2145 (if (eq arg '-)
2146 (kill-comment nil)
2147 (if arg
2148 (progn
2149 (save-excursion
2150 (beginning-of-line)
2151 (re-search-backward comment-start-skip)
2152 (beginning-of-line)
2153 (re-search-forward comment-start-skip)
2154 (goto-char (match-beginning 0))
2155 (setq comment-column (current-column))
2156 (message "Comment column set to %d" comment-column))
2157 (indent-for-comment))
2158 (setq comment-column (current-column))
2159 (message "Comment column set to %d" comment-column))))
2160
2161 (defun kill-comment (arg)
2162 "Kill the comment on this line, if any.
2163 With argument, kill comments on that many lines starting with this one."
2164 ;; this function loses in a lot of situations. it incorrectly recognises
2165 ;; comment delimiters sometimes (ergo, inside a string), doesn't work
2166 ;; with multi-line comments, can kill extra whitespace if comment wasn't
2167 ;; through end-of-line, et cetera.
2168 (interactive "P")
2169 (or comment-start-skip (error "No comment syntax defined"))
2170 (let ((count (prefix-numeric-value arg)) endc)
2171 (while (> count 0)
2172 (save-excursion
2173 (end-of-line)
2174 (setq endc (point))
2175 (beginning-of-line)
2176 (and (string< "" comment-end)
2177 (setq endc
2178 (progn
2179 (re-search-forward (regexp-quote comment-end) endc 'move)
2180 (skip-chars-forward " \t")
2181 (point))))
2182 (beginning-of-line)
2183 (if (re-search-forward comment-start-skip endc t)
2184 (progn
2185 (goto-char (match-beginning 0))
2186 (skip-chars-backward " \t")
2187 (kill-region (point) endc)
2188 ;; to catch comments a line beginnings
2189 (indent-according-to-mode))))
2190 (if arg (forward-line 1))
2191 (setq count (1- count)))))
2192
2193 (defun comment-region (beg end &optional arg)
2194 "Comment or uncomment each line in the region.
2195 With just C-u prefix arg, uncomment each line in region.
2196 Numeric prefix arg ARG means use ARG comment characters.
2197 If ARG is negative, delete that many comment characters instead.
2198 Comments are terminated on each line, even for syntax in which newline does
2199 not end the comment. Blank lines do not get comments."
2200 ;; if someone wants it to only put a comment-start at the beginning and
2201 ;; comment-end at the end then typing it, C-x C-x, closing it, C-x C-x
2202 ;; is easy enough. No option is made here for other than commenting
2203 ;; every line.
2204 (interactive "r\nP")
2205 (or comment-start (error "No comment syntax is defined"))
2206 (if (> beg end) (let (mid) (setq mid beg beg end end mid)))
2207 (save-excursion
2208 (save-restriction
2209 (let ((cs comment-start) (ce comment-end)
2210 numarg)
2211 (if (consp arg) (setq numarg t)
2212 (setq numarg (prefix-numeric-value arg))
2213 ;; For positive arg > 1, replicate the comment delims now,
2214 ;; then insert the replicated strings just once.
2215 (while (> numarg 1)
2216 (setq cs (concat cs comment-start)
2217 ce (concat ce comment-end))
2218 (setq numarg (1- numarg))))
2219 ;; Loop over all lines from BEG to END.
2220 (narrow-to-region beg end)
2221 (goto-char beg)
2222 (while (not (eobp))
2223 (if (or (eq numarg t) (< numarg 0))
2224 (progn
2225 ;; Delete comment start from beginning of line.
2226 (if (eq numarg t)
2227 (while (looking-at (regexp-quote cs))
2228 (delete-char (length cs)))
2229 (let ((count numarg))
2230 (while (and (> 1 (setq count (1+ count)))
2231 (looking-at (regexp-quote cs)))
2232 (delete-char (length cs)))))
2233 ;; Delete comment end from end of line.
2234 (if (string= "" ce)
2235 nil
2236 (if (eq numarg t)
2237 (progn
2238 (end-of-line)
2239 ;; This is questionable if comment-end ends in
2240 ;; whitespace. That is pretty brain-damaged,
2241 ;; though.
2242 (skip-chars-backward " \t")
2243 (if (and (>= (- (point) (point-min)) (length ce))
2244 (save-excursion
2245 (backward-char (length ce))
2246 (looking-at (regexp-quote ce))))
2247 (delete-char (- (length ce)))))
2248 (let ((count numarg))
2249 (while (> 1 (setq count (1+ count)))
2250 (end-of-line)
2251 ;; this is questionable if comment-end ends in whitespace
2252 ;; that is pretty brain-damaged though
2253 (skip-chars-backward " \t")
2254 (save-excursion
2255 (backward-char (length ce))
2256 (if (looking-at (regexp-quote ce))
2257 (delete-char (length ce))))))))
2258 (forward-line 1))
2259 ;; Insert at beginning and at end.
2260 (if (looking-at "[ \t]*$") ()
2261 (insert cs)
2262 (if (string= "" ce) ()
2263 (end-of-line)
2264 (insert ce)))
2265 (search-forward "\n" nil 'move)))))))
2266 \f
2267 (defun backward-word (arg)
2268 "Move backward until encountering the end of a word.
2269 With argument, do this that many times.
2270 In programs, it is faster to call `forward-word' with negative arg."
2271 (interactive "p")
2272 (forward-word (- arg)))
2273
2274 (defun mark-word (arg)
2275 "Set mark arg words away from point."
2276 (interactive "p")
2277 (push-mark
2278 (save-excursion
2279 (forward-word arg)
2280 (point))
2281 nil t))
2282
2283 (defun kill-word (arg)
2284 "Kill characters forward until encountering the end of a word.
2285 With argument, do this that many times."
2286 (interactive "p")
2287 (kill-region (point) (progn (forward-word arg) (point))))
2288
2289 (defun backward-kill-word (arg)
2290 "Kill characters backward until encountering the end of a word.
2291 With argument, do this that many times."
2292 (interactive "p")
2293 (kill-word (- arg)))
2294
2295 (defun current-word (&optional strict)
2296 "Return the word point is on (or a nearby word) as a string.
2297 If optional arg STRICT is non-nil, return nil unless point is within
2298 or adjacent to a word."
2299 (save-excursion
2300 (let ((oldpoint (point)) (start (point)) (end (point)))
2301 (skip-syntax-backward "w_") (setq start (point))
2302 (goto-char oldpoint)
2303 (skip-syntax-forward "w_") (setq end (point))
2304 (if (and (eq start oldpoint) (eq end oldpoint))
2305 ;; Point is neither within nor adjacent to a word.
2306 (and (not strict)
2307 (progn
2308 ;; Look for preceding word in same line.
2309 (skip-syntax-backward "^w_"
2310 (save-excursion (beginning-of-line)
2311 (point)))
2312 (if (bolp)
2313 ;; No preceding word in same line.
2314 ;; Look for following word in same line.
2315 (progn
2316 (skip-syntax-forward "^w_"
2317 (save-excursion (end-of-line)
2318 (point)))
2319 (setq start (point))
2320 (skip-syntax-forward "w_")
2321 (setq end (point)))
2322 (setq end (point))
2323 (skip-syntax-backward "w_")
2324 (setq start (point)))
2325 (buffer-substring start end)))
2326 (buffer-substring start end)))))
2327 \f
2328 (defconst fill-prefix nil
2329 "*String for filling to insert at front of new line, or nil for none.
2330 Setting this variable automatically makes it local to the current buffer.")
2331 (make-variable-buffer-local 'fill-prefix)
2332
2333 (defconst auto-fill-inhibit-regexp nil
2334 "*Regexp to match lines which should not be auto-filled.")
2335
2336 ;; This function is the auto-fill-function of a buffer
2337 ;; when Auto-Fill mode is enabled.
2338 ;; It returns t if it really did any work.
2339 (defun do-auto-fill ()
2340 (let (fc justify bol give-up
2341 (fill-prefix fill-prefix))
2342 (if (or (not (setq justify (current-justification)))
2343 (null (setq fc (current-fill-column)))
2344 (and (eq justify 'left)
2345 (<= (current-column) fc))
2346 (save-excursion (beginning-of-line)
2347 (setq bol (point))
2348 (and auto-fill-inhibit-regexp
2349 (looking-at auto-fill-inhibit-regexp))))
2350 nil ;; Auto-filling not required
2351 (if (memq justify '(full center right))
2352 (save-excursion (unjustify-current-line)))
2353
2354 ;; Choose a fill-prefix automatically.
2355 (if (and adaptive-fill-mode
2356 (or (null fill-prefix) (string= fill-prefix "")))
2357 (let ((prefix
2358 (fill-context-prefix
2359 (save-excursion (backward-paragraph 1) (point))
2360 (save-excursion (forward-paragraph 1) (point))
2361 ;; Don't accept a non-whitespace fill prefix
2362 ;; from the first line of a paragraph.
2363 "^[ \t]*$")))
2364 (and prefix (not (equal prefix ""))
2365 (setq fill-prefix prefix))))
2366
2367 (while (and (not give-up) (> (current-column) fc))
2368 ;; Determine where to split the line.
2369 (let ((fill-point
2370 (let ((opoint (point))
2371 bounce
2372 (first t))
2373 (save-excursion
2374 (move-to-column (1+ fc))
2375 ;; Move back to a word boundary.
2376 (while (or first
2377 ;; If this is after period and a single space,
2378 ;; move back once more--we don't want to break
2379 ;; the line there and make it look like a
2380 ;; sentence end.
2381 (and (not (bobp))
2382 (not bounce)
2383 sentence-end-double-space
2384 (save-excursion (forward-char -1)
2385 (and (looking-at "\\. ")
2386 (not (looking-at "\\. "))))))
2387 (setq first nil)
2388 (skip-chars-backward "^ \t\n")
2389 ;; If we find nowhere on the line to break it,
2390 ;; break after one word. Set bounce to t
2391 ;; so we will not keep going in this while loop.
2392 (if (bolp)
2393 (progn
2394 (re-search-forward "[ \t]" opoint t)
2395 (setq bounce t)))
2396 (skip-chars-backward " \t"))
2397 ;; Let fill-point be set to the place where we end up.
2398 (point)))))
2399 ;; If that place is not the beginning of the line,
2400 ;; break the line there.
2401 (if (save-excursion
2402 (goto-char fill-point)
2403 (not (bolp)))
2404 (let ((prev-column (current-column)))
2405 ;; If point is at the fill-point, do not `save-excursion'.
2406 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
2407 ;; point will end up before it rather than after it.
2408 (if (save-excursion
2409 (skip-chars-backward " \t")
2410 (= (point) fill-point))
2411 (indent-new-comment-line t)
2412 (save-excursion
2413 (goto-char fill-point)
2414 (indent-new-comment-line t)))
2415 ;; Now do justification, if required
2416 (if (not (eq justify 'left))
2417 (save-excursion
2418 (end-of-line 0)
2419 (justify-current-line justify nil t)))
2420 ;; If making the new line didn't reduce the hpos of
2421 ;; the end of the line, then give up now;
2422 ;; trying again will not help.
2423 (if (>= (current-column) prev-column)
2424 (setq give-up t)))
2425 ;; No place to break => stop trying.
2426 (setq give-up t))))
2427 ;; justify last line
2428 (justify-current-line justify t t)
2429 t)))
2430
2431 (defun auto-fill-mode (&optional arg)
2432 "Toggle auto-fill mode.
2433 With arg, turn Auto-Fill mode on if and only if arg is positive.
2434 In Auto-Fill mode, inserting a space at a column beyond `current-fill-column'
2435 automatically breaks the line at a previous space."
2436 (interactive "P")
2437 (prog1 (setq auto-fill-function
2438 (if (if (null arg)
2439 (not auto-fill-function)
2440 (> (prefix-numeric-value arg) 0))
2441 'do-auto-fill
2442 nil))
2443 (force-mode-line-update)))
2444
2445 ;; This holds a document string used to document auto-fill-mode.
2446 (defun auto-fill-function ()
2447 "Automatically break line at a previous space, in insertion of text."
2448 nil)
2449
2450 (defun turn-on-auto-fill ()
2451 "Unconditionally turn on Auto Fill mode."
2452 (auto-fill-mode 1))
2453
2454 (defun set-fill-column (arg)
2455 "Set `fill-column' to current column, or to argument if given.
2456 The variable `fill-column' has a separate value for each buffer."
2457 (interactive "P")
2458 (setq fill-column (if (integerp arg) arg (current-column)))
2459 (message "fill-column set to %d" fill-column))
2460 \f
2461 (defconst comment-multi-line nil
2462 "*Non-nil means \\[indent-new-comment-line] should continue same comment
2463 on new line, with no new terminator or starter.
2464 This is obsolete because you might as well use \\[newline-and-indent].")
2465
2466 (defun indent-new-comment-line (&optional soft)
2467 "Break line at point and indent, continuing comment if within one.
2468 This indents the body of the continued comment
2469 under the previous comment line.
2470
2471 This command is intended for styles where you write a comment per line,
2472 starting a new comment (and terminating it if necessary) on each line.
2473 If you want to continue one comment across several lines, use \\[newline-and-indent].
2474
2475 If a fill column is specified, it overrides the use of the comment column
2476 or comment indentation.
2477
2478 The inserted newline is marked hard if `use-hard-newlines' is true,
2479 unless optional argument SOFT is non-nil."
2480 (interactive)
2481 (let (comcol comstart)
2482 (skip-chars-backward " \t")
2483 (delete-region (point)
2484 (progn (skip-chars-forward " \t")
2485 (point)))
2486 (if soft (insert-and-inherit ?\n) (newline 1))
2487 (if fill-prefix
2488 (progn
2489 (indent-to-left-margin)
2490 (insert-and-inherit fill-prefix))
2491 (if (not comment-multi-line)
2492 (save-excursion
2493 (if (and comment-start-skip
2494 (let ((opoint (point)))
2495 (forward-line -1)
2496 (re-search-forward comment-start-skip opoint t)))
2497 ;; The old line is a comment.
2498 ;; Set WIN to the pos of the comment-start.
2499 ;; But if the comment is empty, look at preceding lines
2500 ;; to find one that has a nonempty comment.
2501
2502 ;; If comment-start-skip contains a \(...\) pair,
2503 ;; the real comment delimiter starts at the end of that pair.
2504 (let ((win (or (match-end 1) (match-beginning 0))))
2505 (while (and (eolp) (not (bobp))
2506 (let (opoint)
2507 (beginning-of-line)
2508 (setq opoint (point))
2509 (forward-line -1)
2510 (re-search-forward comment-start-skip opoint t)))
2511 (setq win (or (match-end 1) (match-beginning 0))))
2512 ;; Indent this line like what we found.
2513 (goto-char win)
2514 (setq comcol (current-column))
2515 (setq comstart
2516 (buffer-substring (point) (match-end 0)))))))
2517 (if comcol
2518 (let ((comment-column comcol)
2519 (comment-start comstart)
2520 (comment-end comment-end))
2521 (and comment-end (not (equal comment-end ""))
2522 ; (if (not comment-multi-line)
2523 (progn
2524 (forward-char -1)
2525 (insert comment-end)
2526 (forward-char 1))
2527 ; (setq comment-column (+ comment-column (length comment-start))
2528 ; comment-start "")
2529 ; )
2530 )
2531 (if (not (eolp))
2532 (setq comment-end ""))
2533 (insert-and-inherit ?\n)
2534 (forward-char -1)
2535 (indent-for-comment)
2536 (save-excursion
2537 ;; Make sure we delete the newline inserted above.
2538 (end-of-line)
2539 (delete-char 1)))
2540 (indent-according-to-mode)))))
2541 \f
2542 (defun set-selective-display (arg)
2543 "Set `selective-display' to ARG; clear it if no arg.
2544 When the value of `selective-display' is a number > 0,
2545 lines whose indentation is >= that value are not displayed.
2546 The variable `selective-display' has a separate value for each buffer."
2547 (interactive "P")
2548 (if (eq selective-display t)
2549 (error "selective-display already in use for marked lines"))
2550 (let ((current-vpos
2551 (save-restriction
2552 (narrow-to-region (point-min) (point))
2553 (goto-char (window-start))
2554 (vertical-motion (window-height)))))
2555 (setq selective-display
2556 (and arg (prefix-numeric-value arg)))
2557 (recenter current-vpos))
2558 (set-window-start (selected-window) (window-start (selected-window)))
2559 (princ "selective-display set to " t)
2560 (prin1 selective-display t)
2561 (princ "." t))
2562
2563 (defconst overwrite-mode-textual " Ovwrt"
2564 "The string displayed in the mode line when in overwrite mode.")
2565 (defconst overwrite-mode-binary " Bin Ovwrt"
2566 "The string displayed in the mode line when in binary overwrite mode.")
2567
2568 (defun overwrite-mode (arg)
2569 "Toggle overwrite mode.
2570 With arg, turn overwrite mode on iff arg is positive.
2571 In overwrite mode, printing characters typed in replace existing text
2572 on a one-for-one basis, rather than pushing it to the right. At the
2573 end of a line, such characters extend the line. Before a tab,
2574 such characters insert until the tab is filled in.
2575 \\[quoted-insert] still inserts characters in overwrite mode; this
2576 is supposed to make it easier to insert characters when necessary."
2577 (interactive "P")
2578 (setq overwrite-mode
2579 (if (if (null arg) (not overwrite-mode)
2580 (> (prefix-numeric-value arg) 0))
2581 'overwrite-mode-textual))
2582 (force-mode-line-update))
2583
2584 (defun binary-overwrite-mode (arg)
2585 "Toggle binary overwrite mode.
2586 With arg, turn binary overwrite mode on iff arg is positive.
2587 In binary overwrite mode, printing characters typed in replace
2588 existing text. Newlines are not treated specially, so typing at the
2589 end of a line joins the line to the next, with the typed character
2590 between them. Typing before a tab character simply replaces the tab
2591 with the character typed.
2592 \\[quoted-insert] replaces the text at the cursor, just as ordinary
2593 typing characters do.
2594
2595 Note that binary overwrite mode is not its own minor mode; it is a
2596 specialization of overwrite-mode, entered by setting the
2597 `overwrite-mode' variable to `overwrite-mode-binary'."
2598 (interactive "P")
2599 (setq overwrite-mode
2600 (if (if (null arg)
2601 (not (eq overwrite-mode 'overwrite-mode-binary))
2602 (> (prefix-numeric-value arg) 0))
2603 'overwrite-mode-binary))
2604 (force-mode-line-update))
2605 \f
2606 (defvar line-number-mode t
2607 "*Non-nil means display line number in mode line.")
2608
2609 (defun line-number-mode (arg)
2610 "Toggle Line Number mode.
2611 With arg, turn Line Number mode on iff arg is positive.
2612 When Line Number mode is enabled, the line number appears
2613 in the mode line."
2614 (interactive "P")
2615 (setq line-number-mode
2616 (if (null arg) (not line-number-mode)
2617 (> (prefix-numeric-value arg) 0)))
2618 (force-mode-line-update))
2619
2620 (defvar column-number-mode nil
2621 "*Non-nil means display column number in mode line.")
2622
2623 (defun column-number-mode (arg)
2624 "Toggle Column Number mode.
2625 With arg, turn Column Number mode on iff arg is positive.
2626 When Column Number mode is enabled, the column number appears
2627 in the mode line."
2628 (interactive "P")
2629 (setq column-number-mode
2630 (if (null arg) (not column-number-mode)
2631 (> (prefix-numeric-value arg) 0)))
2632 (force-mode-line-update))
2633
2634 (defvar blink-matching-paren t
2635 "*Non-nil means show matching open-paren when close-paren is inserted.")
2636
2637 (defvar blink-matching-paren-on-screen t
2638 "*Non-nil means show matching open-paren when it is on screen.
2639 nil means don't show it (but the open-paren can still be shown
2640 when it is off screen.")
2641
2642 (defconst blink-matching-paren-distance 12000
2643 "*If non-nil, is maximum distance to search for matching open-paren.")
2644
2645 (defconst blink-matching-delay 1
2646 "*The number of seconds that `blink-matching-open' will delay at a match.")
2647
2648 (defconst blink-matching-paren-dont-ignore-comments nil
2649 "*Non-nil means `blink-matching-paren' should not ignore comments.")
2650
2651 (defun blink-matching-open ()
2652 "Move cursor momentarily to the beginning of the sexp before point."
2653 (interactive)
2654 (and (> (point) (1+ (point-min)))
2655 blink-matching-paren
2656 ;; Verify an even number of quoting characters precede the close.
2657 (= 1 (logand 1 (- (point)
2658 (save-excursion
2659 (forward-char -1)
2660 (skip-syntax-backward "/\\")
2661 (point)))))
2662 (let* ((oldpos (point))
2663 (blinkpos)
2664 (mismatch))
2665 (save-excursion
2666 (save-restriction
2667 (if blink-matching-paren-distance
2668 (narrow-to-region (max (point-min)
2669 (- (point) blink-matching-paren-distance))
2670 oldpos))
2671 (condition-case ()
2672 (let ((parse-sexp-ignore-comments
2673 (and parse-sexp-ignore-comments
2674 (not blink-matching-paren-dont-ignore-comments))))
2675 (setq blinkpos (scan-sexps oldpos -1)))
2676 (error nil)))
2677 (and blinkpos
2678 (/= (char-syntax (char-after blinkpos))
2679 ?\$)
2680 (setq mismatch
2681 (or (null (matching-paren (char-after blinkpos)))
2682 (/= (char-after (1- oldpos))
2683 (matching-paren (char-after blinkpos))))))
2684 (if mismatch (setq blinkpos nil))
2685 (if blinkpos
2686 (progn
2687 (goto-char blinkpos)
2688 (if (pos-visible-in-window-p)
2689 (and blink-matching-paren-on-screen
2690 (sit-for blink-matching-delay))
2691 (goto-char blinkpos)
2692 (message
2693 "Matches %s"
2694 ;; Show what precedes the open in its line, if anything.
2695 (if (save-excursion
2696 (skip-chars-backward " \t")
2697 (not (bolp)))
2698 (buffer-substring (progn (beginning-of-line) (point))
2699 (1+ blinkpos))
2700 ;; Show what follows the open in its line, if anything.
2701 (if (save-excursion
2702 (forward-char 1)
2703 (skip-chars-forward " \t")
2704 (not (eolp)))
2705 (buffer-substring blinkpos
2706 (progn (end-of-line) (point)))
2707 ;; Otherwise show the previous nonblank line,
2708 ;; if there is one.
2709 (if (save-excursion
2710 (skip-chars-backward "\n \t")
2711 (not (bobp)))
2712 (concat
2713 (buffer-substring (progn
2714 (skip-chars-backward "\n \t")
2715 (beginning-of-line)
2716 (point))
2717 (progn (end-of-line)
2718 (skip-chars-backward " \t")
2719 (point)))
2720 ;; Replace the newline and other whitespace with `...'.
2721 "..."
2722 (buffer-substring blinkpos (1+ blinkpos)))
2723 ;; There is nothing to show except the char itself.
2724 (buffer-substring blinkpos (1+ blinkpos))))))))
2725 (cond (mismatch
2726 (message "Mismatched parentheses"))
2727 ((not blink-matching-paren-distance)
2728 (message "Unmatched parenthesis"))))))))
2729
2730 ;Turned off because it makes dbx bomb out.
2731 (setq blink-paren-function 'blink-matching-open)
2732
2733 ;; This executes C-g typed while Emacs is waiting for a command.
2734 ;; Quitting out of a program does not go through here;
2735 ;; that happens in the QUIT macro at the C code level.
2736 (defun keyboard-quit ()
2737 "Signal a quit condition.
2738 During execution of Lisp code, this character causes a quit directly.
2739 At top-level, as an editor command, this simply beeps."
2740 (interactive)
2741 (deactivate-mark)
2742 (signal 'quit nil))
2743
2744 (define-key global-map "\C-g" 'keyboard-quit)
2745
2746 (defvar buffer-quit-function nil
2747 "Function to call to \"quit\" the current buffer, or nil if none.
2748 \\[keyboard-escape-quit] calls this function when its more local actions
2749 \(such as cancelling a prefix argument, minibuffer or region) do not apply.")
2750
2751 (defun keyboard-escape-quit ()
2752 "Exit the current \"mode\" (in a generalized sense of the word).
2753 This command can exit an interactive command such as `query-replace',
2754 can clear out a prefix argument or a region,
2755 can get out of the minibuffer or other recursive edit,
2756 cancel the use of the current buffer (for special-purpose buffers),
2757 or go back to just one window (by deleting all but the selected window)."
2758 (interactive)
2759 (cond ((eq last-command 'mode-exited) nil)
2760 ((> (minibuffer-depth) 0)
2761 (abort-recursive-edit))
2762 (current-prefix-arg
2763 nil)
2764 ((and transient-mark-mode
2765 mark-active)
2766 (deactivate-mark))
2767 (buffer-quit-function
2768 (funcall buffer-quit-function))
2769 ((not (one-window-p t))
2770 (delete-other-windows))))
2771
2772 (define-key global-map "\e\e\e" 'keyboard-escape-quit)
2773 \f
2774 (defun set-variable (var val)
2775 "Set VARIABLE to VALUE. VALUE is a Lisp object.
2776 When using this interactively, supply a Lisp expression for VALUE.
2777 If you want VALUE to be a string, you must surround it with doublequotes.
2778
2779 If VARIABLE has a `variable-interactive' property, that is used as if
2780 it were the arg to `interactive' (which see) to interactively read the value."
2781 (interactive
2782 (let* ((var (read-variable "Set variable: "))
2783 (minibuffer-help-form
2784 '(funcall myhelp))
2785 (myhelp
2786 (function
2787 (lambda ()
2788 (with-output-to-temp-buffer "*Help*"
2789 (prin1 var)
2790 (princ "\nDocumentation:\n")
2791 (princ (substring (documentation-property var 'variable-documentation)
2792 1))
2793 (if (boundp var)
2794 (let ((print-length 20))
2795 (princ "\n\nCurrent value: ")
2796 (prin1 (symbol-value var))))
2797 (save-excursion
2798 (set-buffer standard-output)
2799 (help-mode))
2800 nil)))))
2801 (list var
2802 (let ((prop (get var 'variable-interactive)))
2803 (if prop
2804 ;; Use VAR's `variable-interactive' property
2805 ;; as an interactive spec for prompting.
2806 (call-interactively (list 'lambda '(arg)
2807 (list 'interactive prop)
2808 'arg))
2809 (eval-minibuffer (format "Set %s to value: " var)))))))
2810 (set var val))
2811 \f
2812 ;; Define the major mode for lists of completions.
2813
2814 (defvar completion-list-mode-map nil
2815 "Local map for completion list buffers.")
2816 (or completion-list-mode-map
2817 (let ((map (make-sparse-keymap)))
2818 (define-key map [mouse-2] 'mouse-choose-completion)
2819 (define-key map [down-mouse-2] nil)
2820 (define-key map "\C-m" 'choose-completion)
2821 (define-key map "\e\e\e" 'delete-completion-window)
2822 (define-key map [left] 'previous-completion)
2823 (define-key map [right] 'next-completion)
2824 (setq completion-list-mode-map map)))
2825
2826 ;; Completion mode is suitable only for specially formatted data.
2827 (put 'completion-list-mode 'mode-class 'special)
2828
2829 (defvar completion-reference-buffer nil
2830 "Record the buffer that was current when the completion list was requested.
2831 This is a local variable in the completion list buffer.
2832 Initial value is nil to avoid some compiler warnings.")
2833
2834 (defvar completion-base-size nil
2835 "Number of chars at beginning of minibuffer not involved in completion.
2836 This is a local variable in the completion list buffer
2837 but it talks about the buffer in `completion-reference-buffer'.
2838 If this is nil, it means to compare text to determine which part
2839 of the tail end of the buffer's text is involved in completion.")
2840
2841 (defun delete-completion-window ()
2842 "Delete the completion list window.
2843 Go to the window from which completion was requested."
2844 (interactive)
2845 (let ((buf completion-reference-buffer))
2846 (delete-window (selected-window))
2847 (if (get-buffer-window buf)
2848 (select-window (get-buffer-window buf)))))
2849
2850 (defun previous-completion (n)
2851 "Move to the previous item in the completion list."
2852 (interactive "p")
2853 (next-completion (- n)))
2854
2855 (defun next-completion (n)
2856 "Move to the next item in the completion list.
2857 With prefix argument N, move N items (negative N means move backward)."
2858 (interactive "p")
2859 (while (and (> n 0) (not (eobp)))
2860 (let ((prop (get-text-property (point) 'mouse-face))
2861 (end (point-max)))
2862 ;; If in a completion, move to the end of it.
2863 (if prop
2864 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
2865 ;; Move to start of next one.
2866 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
2867 (setq n (1- n)))
2868 (while (and (< n 0) (not (bobp)))
2869 (let ((prop (get-text-property (1- (point)) 'mouse-face))
2870 (end (point-min)))
2871 ;; If in a completion, move to the start of it.
2872 (if prop
2873 (goto-char (previous-single-property-change
2874 (point) 'mouse-face nil end)))
2875 ;; Move to end of the previous completion.
2876 (goto-char (previous-single-property-change (point) 'mouse-face nil end))
2877 ;; Move to the start of that one.
2878 (goto-char (previous-single-property-change (point) 'mouse-face nil end)))
2879 (setq n (1+ n))))
2880
2881 (defun choose-completion ()
2882 "Choose the completion that point is in or next to."
2883 (interactive)
2884 (let (beg end completion (buffer completion-reference-buffer)
2885 (base-size completion-base-size))
2886 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
2887 (setq end (point) beg (1+ (point))))
2888 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
2889 (setq end (1- (point)) beg (point)))
2890 (if (null beg)
2891 (error "No completion here"))
2892 (setq beg (previous-single-property-change beg 'mouse-face))
2893 (setq end (or (next-single-property-change end 'mouse-face) (point-max)))
2894 (setq completion (buffer-substring beg end))
2895 (let ((owindow (selected-window)))
2896 (if (and (one-window-p t 'selected-frame)
2897 (window-dedicated-p (selected-window)))
2898 ;; This is a special buffer's frame
2899 (iconify-frame (selected-frame))
2900 (or (window-dedicated-p (selected-window))
2901 (bury-buffer)))
2902 (select-window owindow))
2903 (choose-completion-string completion buffer base-size)))
2904
2905 ;; Delete the longest partial match for STRING
2906 ;; that can be found before POINT.
2907 (defun choose-completion-delete-max-match (string)
2908 (let ((opoint (point))
2909 (len (min (length string)
2910 (- (point) (point-min)))))
2911 (goto-char (- (point) (length string)))
2912 (if completion-ignore-case
2913 (setq string (downcase string)))
2914 (while (and (> len 0)
2915 (let ((tail (buffer-substring (point)
2916 (+ (point) len))))
2917 (if completion-ignore-case
2918 (setq tail (downcase tail)))
2919 (not (string= tail (substring string 0 len)))))
2920 (setq len (1- len))
2921 (forward-char 1))
2922 (delete-char len)))
2923
2924 ;; Switch to BUFFER and insert the completion choice CHOICE.
2925 ;; BASE-SIZE, if non-nil, says how many characters of BUFFER's text
2926 ;; to keep. If it is nil, use choose-completion-delete-max-match instead.
2927 (defun choose-completion-string (choice &optional buffer base-size)
2928 (let ((buffer (or buffer completion-reference-buffer)))
2929 ;; If BUFFER is a minibuffer, barf unless it's the currently
2930 ;; active minibuffer.
2931 (if (and (string-match "\\` \\*Minibuf-[0-9]+\\*\\'" (buffer-name buffer))
2932 (or (not (active-minibuffer-window))
2933 (not (equal buffer
2934 (window-buffer (active-minibuffer-window))))))
2935 (error "Minibuffer is not active for completion")
2936 ;; Insert the completion into the buffer where completion was requested.
2937 (set-buffer buffer)
2938 (if base-size
2939 (delete-region (+ base-size (point-min)) (point))
2940 (choose-completion-delete-max-match choice))
2941 (insert choice)
2942 (remove-text-properties (- (point) (length choice)) (point)
2943 '(mouse-face nil))
2944 ;; Update point in the window that BUFFER is showing in.
2945 (let ((window (get-buffer-window buffer t)))
2946 (set-window-point window (point)))
2947 ;; If completing for the minibuffer, exit it with this choice.
2948 (and (equal buffer (window-buffer (minibuffer-window)))
2949 minibuffer-completion-table
2950 (exit-minibuffer)))))
2951
2952 (defun completion-list-mode ()
2953 "Major mode for buffers showing lists of possible completions.
2954 Type \\<completion-list-mode-map>\\[choose-completion] in the completion list\
2955 to select the completion near point.
2956 Use \\<completion-list-mode-map>\\[mouse-choose-completion] to select one\
2957 with the mouse."
2958 (interactive)
2959 (kill-all-local-variables)
2960 (use-local-map completion-list-mode-map)
2961 (setq mode-name "Completion List")
2962 (setq major-mode 'completion-list-mode)
2963 (make-local-variable 'completion-base-size)
2964 (setq completion-base-size nil)
2965 (run-hooks 'completion-list-mode-hook))
2966
2967 (defvar completion-fixup-function nil
2968 "A function to customize how completions are identified in completion lists.
2969 `completion-setup-function' calls this function with no arguments
2970 each time it has found what it thinks is one completion.
2971 Point is at the end of the completion in the completion list buffer.
2972 If this function moves point, it can alter the end of that completion.")
2973
2974 ;; This function goes in completion-setup-hook, so that it is called
2975 ;; after the text of the completion list buffer is written.
2976
2977 (defun completion-setup-function ()
2978 (save-excursion
2979 (let ((mainbuf (current-buffer)))
2980 (set-buffer standard-output)
2981 (completion-list-mode)
2982 (make-local-variable 'completion-reference-buffer)
2983 (setq completion-reference-buffer mainbuf)
2984 ;;; The value 0 is right in most cases, but not for file name completion.
2985 ;;; so this has to be turned off.
2986 ;;; (setq completion-base-size 0)
2987 (goto-char (point-min))
2988 (if window-system
2989 (insert (substitute-command-keys
2990 "Click \\[mouse-choose-completion] on a completion to select it.\n")))
2991 (insert (substitute-command-keys
2992 "In this buffer, type \\[choose-completion] to \
2993 select the completion near point.\n\n"))
2994 (forward-line 1)
2995 (while (re-search-forward "[^ \t\n]+\\( [^ \t\n]+\\)*" nil t)
2996 (let ((beg (match-beginning 0))
2997 (end (point)))
2998 (if completion-fixup-function
2999 (funcall completion-fixup-function))
3000 (put-text-property beg (point) 'mouse-face 'highlight)
3001 (goto-char end))))))
3002
3003 (add-hook 'completion-setup-hook 'completion-setup-function)
3004
3005 (define-key minibuffer-local-completion-map [prior]
3006 'switch-to-completions)
3007 (define-key minibuffer-local-must-match-map [prior]
3008 'switch-to-completions)
3009 (define-key minibuffer-local-completion-map "\M-v"
3010 'switch-to-completions)
3011 (define-key minibuffer-local-must-match-map "\M-v"
3012 'switch-to-completions)
3013
3014 (defun switch-to-completions ()
3015 "Select the completion list window."
3016 (interactive)
3017 ;; Make sure we have a completions window.
3018 (or (get-buffer-window "*Completions*")
3019 (minibuffer-completion-help))
3020 (select-window (get-buffer-window "*Completions*"))
3021 (goto-char (point-min))
3022 (search-forward "\n\n")
3023 (forward-line 1))
3024 \f
3025 ;; Support keyboard commands to turn on various modifiers.
3026
3027 ;; These functions -- which are not commands -- each add one modifier
3028 ;; to the following event.
3029
3030 (defun event-apply-alt-modifier (ignore-prompt)
3031 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
3032 (defun event-apply-super-modifier (ignore-prompt)
3033 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
3034 (defun event-apply-hyper-modifier (ignore-prompt)
3035 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
3036 (defun event-apply-shift-modifier (ignore-prompt)
3037 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
3038 (defun event-apply-control-modifier (ignore-prompt)
3039 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
3040 (defun event-apply-meta-modifier (ignore-prompt)
3041 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
3042
3043 (defun event-apply-modifier (event symbol lshiftby prefix)
3044 "Apply a modifier flag to event EVENT.
3045 SYMBOL is the name of this modifier, as a symbol.
3046 LSHIFTBY is the numeric value of this modifier, in keyboard events.
3047 PREFIX is the string that represents this modifier in an event type symbol."
3048 (if (numberp event)
3049 (cond ((eq symbol 'control)
3050 (if (and (<= (downcase event) ?z)
3051 (>= (downcase event) ?a))
3052 (- (downcase event) ?a -1)
3053 (if (and (<= (downcase event) ?Z)
3054 (>= (downcase event) ?A))
3055 (- (downcase event) ?A -1)
3056 (logior (lsh 1 lshiftby) event))))
3057 ((eq symbol 'shift)
3058 (if (and (<= (downcase event) ?z)
3059 (>= (downcase event) ?a))
3060 (upcase event)
3061 (logior (lsh 1 lshiftby) event)))
3062 (t
3063 (logior (lsh 1 lshiftby) event)))
3064 (if (memq symbol (event-modifiers event))
3065 event
3066 (let ((event-type (if (symbolp event) event (car event))))
3067 (setq event-type (intern (concat prefix (symbol-name event-type))))
3068 (if (symbolp event)
3069 event-type
3070 (cons event-type (cdr event)))))))
3071
3072 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
3073 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
3074 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
3075 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
3076 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
3077 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
3078 \f
3079 ;;;; Keypad support.
3080
3081 ;;; Make the keypad keys act like ordinary typing keys. If people add
3082 ;;; bindings for the function key symbols, then those bindings will
3083 ;;; override these, so this shouldn't interfere with any existing
3084 ;;; bindings.
3085
3086 ;; Also tell read-char how to handle these keys.
3087 (mapcar
3088 (lambda (keypad-normal)
3089 (let ((keypad (nth 0 keypad-normal))
3090 (normal (nth 1 keypad-normal)))
3091 (put keypad 'ascii-character normal)
3092 (define-key function-key-map (vector keypad) (vector normal))))
3093 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
3094 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
3095 (kp-space ?\ )
3096 (kp-tab ?\t)
3097 (kp-enter ?\r)
3098 (kp-multiply ?*)
3099 (kp-add ?+)
3100 (kp-separator ?,)
3101 (kp-subtract ?-)
3102 (kp-decimal ?.)
3103 (kp-divide ?/)
3104 (kp-equal ?=)))
3105
3106 ;;; simple.el ends here