]> code.delx.au - gnu-emacs/blob - lisp/simple.el
(while): Comment out converter.
[gnu-emacs] / lisp / simple.el
1 ;;; simple.el --- basic editing commands for Emacs
2
3 ;; Copyright (C) 1985, 1986, 1987, 1993 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
19 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
20
21 ;;; Commentary:
22
23 ;; A grab-bag of basic Emacs commands not specifically related to some
24 ;; major mode or to file-handling.
25
26 ;;; Code:
27
28 (defun open-line (arg)
29 "Insert a newline and leave point before it.
30 If there is a fill prefix, insert the fill prefix on the new line
31 if the line would have been empty.
32 With arg N, insert N newlines."
33 (interactive "*p")
34 (let* ((do-fill-prefix (and fill-prefix (bolp)))
35 (flag (and (null do-fill-prefix) (bolp) (not (bobp)))))
36 ;; If this is a simple case, and we are at the beginning of a line,
37 ;; actually insert the newline *before* the preceding newline
38 ;; instead of after. That makes better display behavior.
39 (if flag
40 (progn
41 ;; If undo is enabled, don't let this hack be visible:
42 ;; record the real value of point as the place to move back to
43 ;; if we undo this insert.
44 (if (and buffer-undo-list (not (eq buffer-undo-list t)))
45 (setq buffer-undo-list (cons (point) buffer-undo-list)))
46 (forward-char -1)))
47 (while (> arg 0)
48 (save-excursion
49 (insert ?\n))
50 (if do-fill-prefix (insert fill-prefix))
51 (setq arg (1- arg)))
52 (if flag (forward-char 1))))
53
54 (defun split-line ()
55 "Split current line, moving portion beyond point vertically down."
56 (interactive "*")
57 (skip-chars-forward " \t")
58 (let ((col (current-column))
59 (pos (point)))
60 (insert ?\n)
61 (indent-to col 0)
62 (goto-char pos)))
63
64 (defun quoted-insert (arg)
65 "Read next input character and insert it.
66 This is useful for inserting control characters.
67 You may also type up to 3 octal digits, to insert a character with that code.
68
69 In overwrite mode, this function inserts the character anyway, and
70 does not handle octal digits specially. This means that if you use
71 overwrite as your normal editing mode, you can use this function to
72 insert characters when necessary.
73
74 In binary overwrite mode, this function does overwrite, and octal
75 digits are interpreted as a character code. This is supposed to make
76 this function useful in editing binary files."
77 (interactive "*p")
78 (let ((char (if (or (not overwrite-mode)
79 (eq overwrite-mode 'overwrite-mode-binary))
80 (read-quoted-char)
81 (read-char))))
82 (if (eq overwrite-mode 'overwrite-mode-binary)
83 (delete-char arg))
84 (insert-char char arg)))
85
86 (defun delete-indentation (&optional arg)
87 "Join this line to previous and fix up whitespace at join.
88 If there is a fill prefix, delete it from the beginning of this line.
89 With argument, join this line to following line."
90 (interactive "*P")
91 (beginning-of-line)
92 (if arg (forward-line 1))
93 (if (eq (preceding-char) ?\n)
94 (progn
95 (delete-region (point) (1- (point)))
96 ;; If the second line started with the fill prefix,
97 ;; delete the prefix.
98 (if (and fill-prefix
99 (<= (+ (point) (length fill-prefix)) (point-max))
100 (string= fill-prefix
101 (buffer-substring (point)
102 (+ (point) (length fill-prefix)))))
103 (delete-region (point) (+ (point) (length fill-prefix))))
104 (fixup-whitespace))))
105
106 (defun fixup-whitespace ()
107 "Fixup white space between objects around point.
108 Leave one space or none, according to the context."
109 (interactive "*")
110 (save-excursion
111 (delete-horizontal-space)
112 (if (or (looking-at "^\\|\\s)")
113 (save-excursion (forward-char -1)
114 (looking-at "$\\|\\s(\\|\\s'")))
115 nil
116 (insert ?\ ))))
117
118 (defun delete-horizontal-space ()
119 "Delete all spaces and tabs around point."
120 (interactive "*")
121 (skip-chars-backward " \t")
122 (delete-region (point) (progn (skip-chars-forward " \t") (point))))
123
124 (defun just-one-space ()
125 "Delete all spaces and tabs around point, leaving one space."
126 (interactive "*")
127 (skip-chars-backward " \t")
128 (if (= (following-char) ? )
129 (forward-char 1)
130 (insert ? ))
131 (delete-region (point) (progn (skip-chars-forward " \t") (point))))
132
133 (defun delete-blank-lines ()
134 "On blank line, delete all surrounding blank lines, leaving just one.
135 On isolated blank line, delete that one.
136 On nonblank line, delete all blank lines that follow it."
137 (interactive "*")
138 (let (thisblank singleblank)
139 (save-excursion
140 (beginning-of-line)
141 (setq thisblank (looking-at "[ \t]*$"))
142 ;; Set singleblank if there is just one blank line here.
143 (setq singleblank
144 (and thisblank
145 (not (looking-at "[ \t]*\n[ \t]*$"))
146 (or (bobp)
147 (progn (forward-line -1)
148 (not (looking-at "[ \t]*$")))))))
149 ;; Delete preceding blank lines, and this one too if it's the only one.
150 (if thisblank
151 (progn
152 (beginning-of-line)
153 (if singleblank (forward-line 1))
154 (delete-region (point)
155 (if (re-search-backward "[^ \t\n]" nil t)
156 (progn (forward-line 1) (point))
157 (point-min)))))
158 ;; Delete following blank lines, unless the current line is blank
159 ;; and there are no following blank lines.
160 (if (not (and thisblank singleblank))
161 (save-excursion
162 (end-of-line)
163 (forward-line 1)
164 (delete-region (point)
165 (if (re-search-forward "[^ \t\n]" nil t)
166 (progn (beginning-of-line) (point))
167 (point-max)))))
168 ;; Handle the special case where point is followed by newline and eob.
169 ;; Delete the line, leaving point at eob.
170 (if (looking-at "^[ \t]*\n\\'")
171 (delete-region (point) (point-max)))))
172
173 (defun back-to-indentation ()
174 "Move point to the first non-whitespace character on this line."
175 (interactive)
176 (beginning-of-line 1)
177 (skip-chars-forward " \t"))
178
179 (defun newline-and-indent ()
180 "Insert a newline, then indent according to major mode.
181 Indentation is done using the value of `indent-line-function'.
182 In programming language modes, this is the same as TAB.
183 In some text modes, where TAB inserts a tab, this command indents to the
184 column specified by the variable `left-margin'."
185 (interactive "*")
186 (delete-region (point) (progn (skip-chars-backward " \t") (point)))
187 (newline)
188 (indent-according-to-mode))
189
190 (defun reindent-then-newline-and-indent ()
191 "Reindent current line, insert newline, then indent the new line.
192 Indentation of both lines is done according to the current major mode,
193 which means calling the current value of `indent-line-function'.
194 In programming language modes, this is the same as TAB.
195 In some text modes, where TAB inserts a tab, this indents to the
196 column specified by the variable `left-margin'."
197 (interactive "*")
198 (save-excursion
199 (delete-region (point) (progn (skip-chars-backward " \t") (point)))
200 (indent-according-to-mode))
201 (newline)
202 (indent-according-to-mode))
203
204 ;; Internal subroutine of delete-char
205 (defun kill-forward-chars (arg)
206 (if (listp arg) (setq arg (car arg)))
207 (if (eq arg '-) (setq arg -1))
208 (kill-region (point) (+ (point) arg)))
209
210 ;; Internal subroutine of backward-delete-char
211 (defun kill-backward-chars (arg)
212 (if (listp arg) (setq arg (car arg)))
213 (if (eq arg '-) (setq arg -1))
214 (kill-region (point) (- (point) arg)))
215
216 (defun backward-delete-char-untabify (arg &optional killp)
217 "Delete characters backward, changing tabs into spaces.
218 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
219 Interactively, ARG is the prefix arg (default 1)
220 and KILLP is t if prefix arg is was specified."
221 (interactive "*p\nP")
222 (let ((count arg))
223 (save-excursion
224 (while (and (> count 0) (not (bobp)))
225 (if (= (preceding-char) ?\t)
226 (let ((col (current-column)))
227 (forward-char -1)
228 (setq col (- col (current-column)))
229 (insert-char ?\ col)
230 (delete-char 1)))
231 (forward-char -1)
232 (setq count (1- count)))))
233 (delete-backward-char arg killp)
234 ;; In overwrite mode, back over columns while clearing them out,
235 ;; unless at end of line.
236 (and overwrite-mode (not (eolp))
237 (save-excursion (insert-char ?\ arg))))
238
239 (defun zap-to-char (arg char)
240 "Kill up to and including ARG'th occurrence of CHAR.
241 Goes backward if ARG is negative; error if CHAR not found."
242 (interactive "p\ncZap to char: ")
243 (kill-region (point) (progn
244 (search-forward (char-to-string char) nil nil arg)
245 ; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
246 (point))))
247
248 (defun beginning-of-buffer (&optional arg)
249 "Move point to the beginning of the buffer; leave mark at previous position.
250 With arg N, put point N/10 of the way from the true beginning.
251
252 Don't use this command in Lisp programs!
253 \(goto-char (point-min)) is faster and avoids clobbering the mark."
254 (interactive "P")
255 (push-mark)
256 (goto-char (if arg
257 (if (> (buffer-size) 10000)
258 ;; Avoid overflow for large buffer sizes!
259 (* (prefix-numeric-value arg)
260 (/ (buffer-size) 10))
261 (/ (+ 10 (* (buffer-size) (prefix-numeric-value arg))) 10))
262 (point-min)))
263 (if arg (forward-line 1)))
264
265 (defun end-of-buffer (&optional arg)
266 "Move point to the end of the buffer; leave mark at previous position.
267 With arg N, put point N/10 of the way from the true end.
268
269 Don't use this command in Lisp programs!
270 \(goto-char (point-max)) is faster and avoids clobbering the mark."
271 (interactive "P")
272 (push-mark)
273 (goto-char (if arg
274 (- (1+ (buffer-size))
275 (if (> (buffer-size) 10000)
276 ;; Avoid overflow for large buffer sizes!
277 (* (prefix-numeric-value arg)
278 (/ (buffer-size) 10))
279 (/ (* (buffer-size) (prefix-numeric-value arg)) 10)))
280 (point-max)))
281 ;; If we went to a place in the middle of the buffer,
282 ;; adjust it to the beginning of a line.
283 (if arg (forward-line 1)
284 ;; If the end of the buffer is not already on the screen,
285 ;; then scroll specially to put it near, but not at, the bottom.
286 (if (let ((old-point (point)))
287 (save-excursion
288 (goto-char (window-start))
289 (vertical-motion (window-height))
290 (< (point) old-point)))
291 (recenter -3))))
292
293 (defun mark-whole-buffer ()
294 "Put point at beginning and mark at end of buffer.
295 You probably should not use this function in Lisp programs;
296 it is usually a mistake for a Lisp function to use any subroutine
297 that uses or sets the mark."
298 (interactive)
299 (push-mark (point))
300 (push-mark (point-max) nil t)
301 (goto-char (point-min)))
302
303 (defun count-lines-region (start end)
304 "Print number of lines and characters in the region."
305 (interactive "r")
306 (message "Region has %d lines, %d characters"
307 (count-lines start end) (- end start)))
308
309 (defun what-line ()
310 "Print the current line number (in the buffer) of point."
311 (interactive)
312 (save-restriction
313 (widen)
314 (save-excursion
315 (beginning-of-line)
316 (message "Line %d"
317 (1+ (count-lines 1 (point)))))))
318
319 (defun count-lines (start end)
320 "Return number of lines between START and END.
321 This is usually the number of newlines between them,
322 but can be one more if START is not equal to END
323 and the greater of them is not at the start of a line."
324 (save-match-data
325 (save-excursion
326 (save-restriction
327 (narrow-to-region start end)
328 (goto-char (point-min))
329 (if (eq selective-display t)
330 (let ((done 0))
331 (while (re-search-forward "[\n\C-m]" nil t 40)
332 (setq done (+ 40 done)))
333 (while (re-search-forward "[\n\C-m]" nil t 1)
334 (setq done (+ 1 done)))
335 done)
336 (- (buffer-size) (forward-line (buffer-size))))))))
337
338 (defun what-cursor-position ()
339 "Print info on cursor position (on screen and within buffer)."
340 (interactive)
341 (let* ((char (following-char))
342 (beg (point-min))
343 (end (point-max))
344 (pos (point))
345 (total (buffer-size))
346 (percent (if (> total 50000)
347 ;; Avoid overflow from multiplying by 100!
348 (/ (+ (/ total 200) (1- pos)) (max (/ total 100) 1))
349 (/ (+ (/ total 2) (* 100 (1- pos))) (max total 1))))
350 (hscroll (if (= (window-hscroll) 0)
351 ""
352 (format " Hscroll=%d" (window-hscroll))))
353 (col (current-column)))
354 (if (= pos end)
355 (if (or (/= beg 1) (/= end (1+ total)))
356 (message "point=%d of %d(%d%%) <%d - %d> column %d %s"
357 pos total percent beg end col hscroll)
358 (message "point=%d of %d(%d%%) column %d %s"
359 pos total percent col hscroll))
360 (if (or (/= beg 1) (/= end (1+ total)))
361 (message "Char: %s (0%o) point=%d of %d(%d%%) <%d - %d> column %d %s"
362 (single-key-description char) char pos total percent beg end col hscroll)
363 (message "Char: %s (0%o) point=%d of %d(%d%%) column %d %s"
364 (single-key-description char) char pos total percent col hscroll)))))
365
366 (defun fundamental-mode ()
367 "Major mode not specialized for anything in particular.
368 Other major modes are defined by comparison with this one."
369 (interactive)
370 (kill-all-local-variables))
371
372 (defvar read-expression-map (copy-keymap minibuffer-local-map)
373 "Minibuffer keymap used for reading Lisp expressions.")
374 (define-key read-expression-map "\M-\t" 'lisp-complete-symbol)
375
376 (put 'eval-expression 'disabled t)
377
378 ;; We define this, rather than making eval interactive,
379 ;; for the sake of completion of names like eval-region, eval-current-buffer.
380 (defun eval-expression (expression)
381 "Evaluate EXPRESSION and print value in minibuffer.
382 Value is also consed on to front of the variable `values'."
383 (interactive (list (read-from-minibuffer "Eval: "
384 nil read-expression-map t)))
385 (setq values (cons (eval expression) values))
386 (prin1 (car values) t))
387
388 (defun edit-and-eval-command (prompt command)
389 "Prompting with PROMPT, let user edit COMMAND and eval result.
390 COMMAND is a Lisp expression. Let user edit that expression in
391 the minibuffer, then read and evaluate the result."
392 (let ((command (read-from-minibuffer prompt
393 (prin1-to-string command)
394 read-expression-map t)))
395 ;; Add edited command to command history, unless redundant.
396 (or (equal command (car command-history))
397 (setq command-history (cons command command-history)))
398 (eval command)))
399
400 (defun repeat-complex-command (arg)
401 "Edit and re-evaluate last complex command, or ARGth from last.
402 A complex command is one which used the minibuffer.
403 The command is placed in the minibuffer as a Lisp form for editing.
404 The result is executed, repeating the command as changed.
405 If the command has been changed or is not the most recent previous command
406 it is added to the front of the command history.
407 You can use the minibuffer history commands \\<minibuffer-local-map>\\[next-history-element] and \\[previous-history-element]
408 to get different commands to edit and resubmit."
409 (interactive "p")
410 (let ((elt (nth (1- arg) command-history))
411 (minibuffer-history-position arg)
412 (minibuffer-history-sexp-flag t)
413 newcmd)
414 (if elt
415 (progn
416 (setq newcmd (read-from-minibuffer "Redo: "
417 (prin1-to-string elt)
418 read-expression-map
419 t
420 (cons 'command-history
421 arg)))
422 ;; If command was added to command-history as a string,
423 ;; get rid of that. We want only evallable expressions there.
424 (if (stringp (car command-history))
425 (setq command-history (cdr command-history)))
426 ;; If command to be redone does not match front of history,
427 ;; add it to the history.
428 (or (equal newcmd (car command-history))
429 (setq command-history (cons newcmd command-history)))
430 (eval newcmd))
431 (ding))))
432 \f
433 (defvar minibuffer-history nil
434 "Default minibuffer history list.
435 This is used for all minibuffer input
436 except when an alternate history list is specified.")
437 (defvar minibuffer-history-sexp-flag nil
438 "Nonzero when doing history operations on `command-history'.
439 More generally, indicates that the history list being acted on
440 contains expressions rather than strings.")
441 (setq minibuffer-history-variable 'minibuffer-history)
442 (setq minibuffer-history-position nil)
443 (defvar minibuffer-history-search-history nil)
444
445 (mapcar
446 (lambda (key-and-command)
447 (mapcar
448 (lambda (keymap-and-completionp)
449 ;; Arg is (KEYMAP-SYMBOL . COMPLETION-MAP-P).
450 ;; If the cdr of KEY-AND-COMMAND (the command) is a cons,
451 ;; its car is used if COMPLETION-MAP-P is nil, its cdr if it is t.
452 (define-key (symbol-value (car keymap-and-completionp))
453 (car key-and-command)
454 (let ((command (cdr key-and-command)))
455 (if (consp command)
456 ;; (and ... nil) => ... turns back on the completion-oriented
457 ;; history commands which rms turned off since they seem to
458 ;; do things he doesn't like.
459 (if (and (cdr keymap-and-completionp) nil) ;XXX turned off
460 (progn (error "EMACS BUG!") (cdr command))
461 (car command))
462 command))))
463 '((minibuffer-local-map . nil)
464 (minibuffer-local-ns-map . nil)
465 (minibuffer-local-completion-map . t)
466 (minibuffer-local-must-match-map . t)
467 (read-expression-map . nil))))
468 '(("\en" . (next-history-element . next-complete-history-element))
469 ([next] . (next-history-element . next-complete-history-element))
470 ("\ep" . (previous-history-element . previous-complete-history-element))
471 ([prior] . (previous-history-element . previous-complete-history-element))
472 ("\er" . previous-matching-history-element)
473 ("\es" . next-matching-history-element)))
474
475 (defun previous-matching-history-element (regexp n)
476 "Find the previous history element that matches REGEXP.
477 \(Previous history elements refer to earlier actions.)
478 With prefix argument N, search for Nth previous match.
479 If N is negative, find the next or Nth next match."
480 (interactive
481 (let* ((enable-recursive-minibuffers t)
482 (minibuffer-history-sexp-flag nil)
483 (regexp (read-from-minibuffer "Previous element matching (regexp): "
484 nil
485 minibuffer-local-map
486 nil
487 'minibuffer-history-search-history)))
488 ;; Use the last regexp specified, by default, if input is empty.
489 (list (if (string= regexp "")
490 (setcar minibuffer-history-search-history
491 (nth 1 minibuffer-history-search-history))
492 regexp)
493 (prefix-numeric-value current-prefix-arg))))
494 (let ((history (symbol-value minibuffer-history-variable))
495 prevpos
496 (pos minibuffer-history-position))
497 (while (/= n 0)
498 (setq prevpos pos)
499 (setq pos (min (max 1 (+ pos (if (< n 0) -1 1))) (length history)))
500 (if (= pos prevpos)
501 (error (if (= pos 1)
502 "No later matching history item"
503 "No earlier matching history item")))
504 (if (string-match regexp
505 (if minibuffer-history-sexp-flag
506 (prin1-to-string (nth (1- pos) history))
507 (nth (1- pos) history)))
508 (setq n (+ n (if (< n 0) 1 -1)))))
509 (setq minibuffer-history-position pos)
510 (erase-buffer)
511 (let ((elt (nth (1- pos) history)))
512 (insert (if minibuffer-history-sexp-flag
513 (prin1-to-string elt)
514 elt)))
515 (goto-char (point-min)))
516 (if (or (eq (car (car command-history)) 'previous-matching-history-element)
517 (eq (car (car command-history)) 'next-matching-history-element))
518 (setq command-history (cdr command-history))))
519
520 (defun next-matching-history-element (regexp n)
521 "Find the next history element that matches REGEXP.
522 \(The next history element refers to a more recent action.)
523 With prefix argument N, search for Nth next match.
524 If N is negative, find the previous or Nth previous match."
525 (interactive
526 (let* ((enable-recursive-minibuffers t)
527 (minibuffer-history-sexp-flag nil)
528 (regexp (read-from-minibuffer "Next element matching (regexp): "
529 nil
530 minibuffer-local-map
531 nil
532 'minibuffer-history-search-history)))
533 ;; Use the last regexp specified, by default, if input is empty.
534 (list (if (string= regexp "")
535 (setcar minibuffer-history-search-history
536 (nth 1 minibuffer-history-search-history))
537 regexp)
538 (prefix-numeric-value current-prefix-arg))))
539 (previous-matching-history-element regexp (- n)))
540
541 (defun next-history-element (n)
542 "Insert the next element of the minibuffer history into the minibuffer."
543 (interactive "p")
544 (let ((narg (min (max 1 (- minibuffer-history-position n))
545 (length (symbol-value minibuffer-history-variable)))))
546 (if (= minibuffer-history-position narg)
547 (error (if (= minibuffer-history-position 1)
548 "End of history; no next item"
549 "Beginning of history; no preceding item"))
550 (erase-buffer)
551 (setq minibuffer-history-position narg)
552 (let ((elt (nth (1- minibuffer-history-position)
553 (symbol-value minibuffer-history-variable))))
554 (insert
555 (if minibuffer-history-sexp-flag
556 (prin1-to-string elt)
557 elt)))
558 (goto-char (point-min)))))
559
560 (defun previous-history-element (n)
561 "Inserts the previous element of the minibuffer history into the minibuffer."
562 (interactive "p")
563 (next-history-element (- n)))
564
565 (defun next-complete-history-element (n)
566 "\
567 Get previous element of history which is a completion of minibuffer contents."
568 (interactive "p")
569 (let ((point-at-start (point)))
570 (next-matching-history-element
571 (concat "^" (regexp-quote (buffer-substring (point-min) (point)))) n)
572 ;; next-matching-history-element always puts us at (point-min).
573 ;; Move to the position we were at before changing the buffer contents.
574 ;; This is still sensical, because the text before point has not changed.
575 (goto-char point-at-start)))
576
577 (defun previous-complete-history-element (n)
578 "Get next element of history which is a completion of minibuffer contents."
579 (interactive "p")
580 (next-complete-history-element (- n)))
581 \f
582 (defun goto-line (arg)
583 "Goto line ARG, counting from line 1 at beginning of buffer."
584 (interactive "NGoto line: ")
585 (save-restriction
586 (widen)
587 (goto-char 1)
588 (if (eq selective-display t)
589 (re-search-forward "[\n\C-m]" nil 'end (1- arg))
590 (forward-line (1- arg)))))
591
592 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
593 (define-function 'advertised-undo 'undo)
594
595 (defun undo (&optional arg)
596 "Undo some previous changes.
597 Repeat this command to undo more changes.
598 A numeric argument serves as a repeat count."
599 (interactive "*p")
600 (let ((modified (buffer-modified-p))
601 (recent-save (recent-auto-save-p)))
602 (or (eq (selected-window) (minibuffer-window))
603 (message "Undo!"))
604 (or (eq last-command 'undo)
605 (progn (undo-start)
606 (undo-more 1)))
607 (setq this-command 'undo)
608 (undo-more (or arg 1))
609 (and modified (not (buffer-modified-p))
610 (delete-auto-save-file-if-necessary recent-save))))
611
612 (defvar pending-undo-list nil
613 "Within a run of consecutive undo commands, list remaining to be undone.")
614
615 (defun undo-start ()
616 "Set `pending-undo-list' to the front of the undo list.
617 The next call to `undo-more' will undo the most recently made change."
618 (if (eq buffer-undo-list t)
619 (error "No undo information in this buffer"))
620 (setq pending-undo-list buffer-undo-list))
621
622 (defun undo-more (count)
623 "Undo back N undo-boundaries beyond what was already undone recently.
624 Call `undo-start' to get ready to undo recent changes,
625 then call `undo-more' one or more times to undo them."
626 (or pending-undo-list
627 (error "No further undo information"))
628 (setq pending-undo-list (primitive-undo count pending-undo-list)))
629
630 (defvar last-shell-command "")
631 (defvar last-shell-command-on-region "")
632
633 (defun shell-command (command &optional flag)
634 "Execute string COMMAND in inferior shell; display output, if any.
635 If COMMAND ends in ampersand, execute it asynchronously.
636
637 Optional second arg non-nil (prefix arg, if interactive)
638 means insert output in current buffer after point (leave mark after it).
639 This cannot be done asynchronously."
640 (interactive (list (read-string "Shell command: " last-shell-command)
641 current-prefix-arg))
642 (if flag
643 (progn (barf-if-buffer-read-only)
644 (push-mark)
645 ;; We do not use -f for csh; we will not support broken use of
646 ;; .cshrcs. Even the BSD csh manual says to use
647 ;; "if ($?prompt) exit" before things which are not useful
648 ;; non-interactively. Besides, if someone wants their other
649 ;; aliases for shell commands then they can still have them.
650 (call-process shell-file-name nil t nil
651 "-c" command)
652 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
653 ;; It is cleaner to avoid activation, even though the command
654 ;; loop would deactivate the mark because we inserted text.
655 (goto-char (prog1 (mark t)
656 (set-marker (mark-marker) (point)
657 (current-buffer)))))
658 ;; Preserve the match data in case called from a program.
659 (let ((data (match-data)))
660 (unwind-protect
661 (if (string-match "[ \t]*&[ \t]*$" command)
662 ;; Command ending with ampersand means asynchronous.
663 (let ((buffer (get-buffer-create "*shell-command*"))
664 (directory default-directory)
665 proc)
666 ;; Remove the ampersand.
667 (setq command (substring command 0 (match-beginning 0)))
668 ;; If will kill a process, query first.
669 (setq proc (get-buffer-process buffer))
670 (if proc
671 (if (yes-or-no-p "A command is running. Kill it? ")
672 (kill-process proc)
673 (error "Shell command in progress")))
674 (save-excursion
675 (set-buffer buffer)
676 (erase-buffer)
677 (display-buffer buffer)
678 (setq default-directory directory)
679 (setq proc (start-process "Shell" buffer
680 shell-file-name "-c" command))
681 (setq mode-line-process '(": %s"))
682 (set-process-sentinel proc 'shell-command-sentinel)
683 (set-process-filter proc 'shell-command-filter)
684 ))
685 (shell-command-on-region (point) (point) command nil))
686 (store-match-data data)))))
687
688 ;; We have a sentinel to prevent insertion of a termination message
689 ;; in the buffer itself.
690 (defun shell-command-sentinel (process signal)
691 (if (memq (process-status process) '(exit signal))
692 (progn
693 (message "%s: %s."
694 (car (cdr (cdr (process-command process))))
695 (substring signal 0 -1))
696 (save-excursion
697 (set-buffer (process-buffer process))
698 (setq mode-line-process nil))
699 (delete-process process))))
700
701 (defun shell-command-filter (proc string)
702 ;; Do save-excursion by hand so that we can leave point numerically unchanged
703 ;; despite an insertion immediately after it.
704 (let* ((obuf (current-buffer))
705 (buffer (process-buffer proc))
706 opoint
707 (window (get-buffer-window buffer))
708 (pos (window-start window)))
709 (unwind-protect
710 (progn
711 (set-buffer buffer)
712 (setq opoint (point))
713 (goto-char (point-max))
714 (insert-before-markers string))
715 ;; insert-before-markers moved this marker: set it back.
716 (set-window-start window pos)
717 ;; Finish our save-excursion.
718 (goto-char opoint)
719 (set-buffer obuf))))
720
721 (defun shell-command-on-region (start end command &optional flag interactive)
722 "Execute string COMMAND in inferior shell with region as input.
723 Normally display output (if any) in temp buffer `*Shell Command Output*';
724 Prefix arg means replace the region with it.
725 Noninteractive args are START, END, COMMAND, FLAG.
726 Noninteractively FLAG means insert output in place of text from START to END,
727 and put point at the end, but don't alter the mark.
728
729 If the output is one line, it is displayed in the echo area,
730 but it is nonetheless available in buffer `*Shell Command Output*'
731 even though that buffer is not automatically displayed. If there is no output
732 or output is inserted in the current buffer then `*Shell Command Output*' is
733 deleted."
734 (interactive (list (region-beginning) (region-end)
735 (read-string "Shell command on region: "
736 last-shell-command-on-region)
737 current-prefix-arg
738 (prefix-numeric-value current-prefix-arg)))
739 (if flag
740 ;; Replace specified region with output from command.
741 (let ((swap (and interactive (< (point) (mark)))))
742 ;; Don't muck with mark
743 ;; unless called interactively.
744 (and interactive (push-mark))
745 (call-process-region start end shell-file-name t t nil
746 "-c" command)
747 (if (get-buffer "*Shell Command Output*")
748 (kill-buffer "*Shell Command Output*"))
749 (and interactive swap (exchange-point-and-mark)))
750 ;; No prefix argument: put the output in a temp buffer,
751 ;; replacing its entire contents.
752 (let ((buffer (get-buffer-create "*Shell Command Output*")))
753 (if (eq buffer (current-buffer))
754 ;; If the input is the same buffer as the output,
755 ;; delete everything but the specified region,
756 ;; then replace that region with the output.
757 (progn (delete-region end (point-max))
758 (delete-region (point-min) start)
759 (call-process-region (point-min) (point-max)
760 shell-file-name t t nil
761 "-c" command))
762 ;; Clear the output buffer, then run the command with output there.
763 (save-excursion
764 (set-buffer buffer)
765 (erase-buffer))
766 (call-process-region start end shell-file-name
767 nil buffer nil
768 "-c" command))
769 ;; Report the amount of output.
770 (let ((lines (save-excursion
771 (set-buffer buffer)
772 (if (= (buffer-size) 0)
773 0
774 (count-lines (point-min) (point-max))))))
775 (cond ((= lines 0)
776 (message "(Shell command completed with no output)")
777 (kill-buffer "*Shell Command Output*"))
778 ((= lines 1)
779 (message "%s"
780 (save-excursion
781 (set-buffer buffer)
782 (goto-char (point-min))
783 (buffer-substring (point)
784 (progn (end-of-line) (point))))))
785 (t
786 (set-window-start (display-buffer buffer) 1)))))))
787 \f
788 (defun universal-argument ()
789 "Begin a numeric argument for the following command.
790 Digits or minus sign following \\[universal-argument] make up the numeric argument.
791 \\[universal-argument] following the digits or minus sign ends the argument.
792 \\[universal-argument] without digits or minus sign provides 4 as argument.
793 Repeating \\[universal-argument] without digits or minus sign
794 multiplies the argument by 4 each time."
795 (interactive nil)
796 (let ((factor 4)
797 key)
798 ;; (describe-arg (list factor) 1)
799 (setq key (read-key-sequence nil t))
800 (while (equal (key-binding key) 'universal-argument)
801 (setq factor (* 4 factor))
802 ;; (describe-arg (list factor) 1)
803 (setq key (read-key-sequence nil t)))
804 (prefix-arg-internal key factor nil)))
805
806 (defun prefix-arg-internal (key factor value)
807 (let ((sign 1))
808 (if (and (numberp value) (< value 0))
809 (setq sign -1 value (- value)))
810 (if (eq value '-)
811 (setq sign -1 value nil))
812 ;; (describe-arg value sign)
813 (while (equal key "-")
814 (setq sign (- sign) factor nil)
815 ;; (describe-arg value sign)
816 (setq key (read-key-sequence nil t)))
817 (while (and (stringp key)
818 (= (length key) 1)
819 (not (string< key "0"))
820 (not (string< "9" key)))
821 (setq value (+ (* (if (numberp value) value 0) 10)
822 (- (aref key 0) ?0))
823 factor nil)
824 ;; (describe-arg value sign)
825 (setq key (read-key-sequence nil t)))
826 (setq prefix-arg
827 (cond (factor (list factor))
828 ((numberp value) (* value sign))
829 ((= sign -1) '-)))
830 ;; Calling universal-argument after digits
831 ;; terminates the argument but is ignored.
832 (if (eq (key-binding key) 'universal-argument)
833 (progn
834 (describe-arg value sign)
835 (setq key (read-key-sequence nil t))))
836 (setq unread-command-events (listify-key-sequence key))))
837
838 (defun describe-arg (value sign)
839 (cond ((numberp value)
840 (message "Arg: %d" (* value sign)))
841 ((consp value)
842 (message "Arg: [%d]" (car value)))
843 ((< sign 0)
844 (message "Arg: -"))))
845
846 (defun digit-argument (arg)
847 "Part of the numeric argument for the next command.
848 \\[universal-argument] following digits or minus sign ends the argument."
849 (interactive "P")
850 (prefix-arg-internal (char-to-string (logand last-command-char ?\177))
851 nil arg))
852
853 (defun negative-argument (arg)
854 "Begin a negative numeric argument for the next command.
855 \\[universal-argument] following digits or minus sign ends the argument."
856 (interactive "P")
857 (prefix-arg-internal "-" nil arg))
858 \f
859 (defun forward-to-indentation (arg)
860 "Move forward ARG lines and position at first nonblank character."
861 (interactive "p")
862 (forward-line arg)
863 (skip-chars-forward " \t"))
864
865 (defun backward-to-indentation (arg)
866 "Move backward ARG lines and position at first nonblank character."
867 (interactive "p")
868 (forward-line (- arg))
869 (skip-chars-forward " \t"))
870
871 (defvar kill-whole-line nil
872 "*If non-nil, `kill-line' with no arg at beg of line kills the whole line.")
873
874 (defun kill-line (&optional arg)
875 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
876 With prefix argument, kill that many lines from point.
877 Negative arguments kill lines backward.
878
879 When calling from a program, nil means \"no arg\",
880 a number counts as a prefix arg.
881
882 If `kill-whole-line' is non-nil, then kill the whole line
883 when given no argument at the beginning of a line."
884 (interactive "P")
885 (kill-region (point)
886 ;; Don't shift point before doing the delete; that way,
887 ;; undo will record the right position of point.
888 (save-excursion
889 (if arg
890 (forward-line (prefix-numeric-value arg))
891 (if (eobp)
892 (signal 'end-of-buffer nil))
893 (if (or (looking-at "[ \t]*$") (and kill-whole-line (bolp)))
894 (forward-line 1)
895 (end-of-line)))
896 (point))))
897 \f
898 ;;;; Window system cut and paste hooks.
899
900 (defvar interprogram-cut-function nil
901 "Function to call to make a killed region available to other programs.
902
903 Most window systems provide some sort of facility for cutting and
904 pasting text between the windows of different programs.
905 This variable holds a function that Emacs calls whenever text
906 is put in the kill ring, to make the new kill available to other
907 programs.
908
909 The function takes one or two arguments.
910 The first argument, TEXT, is a string containing
911 the text which should be made available.
912 The second, PUSH, if non-nil means this is a \"new\" kill;
913 nil means appending to an \"old\" kill.")
914
915 (defvar interprogram-paste-function nil
916 "Function to call to get text cut from other programs.
917
918 Most window systems provide some sort of facility for cutting and
919 pasting text between the windows of different programs.
920 This variable holds a function that Emacs calls to obtain
921 text that other programs have provided for pasting.
922
923 The function should be called with no arguments. If the function
924 returns nil, then no other program has provided such text, and the top
925 of the Emacs kill ring should be used. If the function returns a
926 string, that string should be put in the kill ring as the latest kill.
927
928 Note that the function should return a string only if a program other
929 than Emacs has provided a string for pasting; if Emacs provided the
930 most recent string, the function should return nil. If it is
931 difficult to tell whether Emacs or some other program provided the
932 current string, it is probably good enough to return nil if the string
933 is equal (according to `string=') to the last text Emacs provided.")
934
935
936 \f
937 ;;;; The kill ring data structure.
938
939 (defvar kill-ring nil
940 "List of killed text sequences.
941 Since the kill ring is supposed to interact nicely with cut-and-paste
942 facilities offered by window systems, use of this variable should
943 interact nicely with `interprogram-cut-function' and
944 `interprogram-paste-function'. The functions `kill-new',
945 `kill-append', and `current-kill' are supposed to implement this
946 interaction; you may want to use them instead of manipulating the kill
947 ring directly.")
948
949 (defconst kill-ring-max 30
950 "*Maximum length of kill ring before oldest elements are thrown away.")
951
952 (defvar kill-ring-yank-pointer nil
953 "The tail of the kill ring whose car is the last thing yanked.")
954
955 (defun kill-new (string)
956 "Make STRING the latest kill in the kill ring.
957 Set the kill-ring-yank pointer to point to it.
958 If `interprogram-cut-function' is non-nil, apply it to STRING."
959 (setq kill-ring (cons string kill-ring))
960 (if (> (length kill-ring) kill-ring-max)
961 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil))
962 (setq kill-ring-yank-pointer kill-ring)
963 (if interprogram-cut-function
964 (funcall interprogram-cut-function string t)))
965
966 (defun kill-append (string before-p)
967 "Append STRING to the end of the latest kill in the kill ring.
968 If BEFORE-P is non-nil, prepend STRING to the kill.
969 If `interprogram-cut-function' is set, pass the resulting kill to
970 it."
971 (setcar kill-ring
972 (if before-p
973 (concat string (car kill-ring))
974 (concat (car kill-ring) string)))
975 (if interprogram-cut-function
976 (funcall interprogram-cut-function (car kill-ring))))
977
978 (defun current-kill (n &optional do-not-move)
979 "Rotate the yanking point by N places, and then return that kill.
980 If N is zero, `interprogram-paste-function' is set, and calling it
981 returns a string, then that string is added to the front of the
982 kill ring and returned as the latest kill.
983 If optional arg DO-NOT-MOVE is non-nil, then don't actually move the
984 yanking point; just return the Nth kill forward."
985 (let ((interprogram-paste (and (= n 0)
986 interprogram-paste-function
987 (funcall interprogram-paste-function))))
988 (if interprogram-paste
989 (progn
990 ;; Disable the interprogram cut function when we add the new
991 ;; text to the kill ring, so Emacs doesn't try to own the
992 ;; selection, with identical text.
993 (let ((interprogram-cut-function nil))
994 (kill-new interprogram-paste))
995 interprogram-paste)
996 (or kill-ring (error "Kill ring is empty"))
997 (let* ((length (length kill-ring))
998 (ARGth-kill-element
999 (nthcdr (% (+ n (- length (length kill-ring-yank-pointer)))
1000 length)
1001 kill-ring)))
1002 (or do-not-move
1003 (setq kill-ring-yank-pointer ARGth-kill-element))
1004 (car ARGth-kill-element)))))
1005
1006
1007 \f
1008 ;;;; Commands for manipulating the kill ring.
1009
1010 (defun kill-region (beg end)
1011 "Kill between point and mark.
1012 The text is deleted but saved in the kill ring.
1013 The command \\[yank] can retrieve it from there.
1014 \(If you want to kill and then yank immediately, use \\[copy-region-as-kill].)
1015 If the buffer is read-only, Emacs will beep and refrain from deleting
1016 the text, but put the text in the kill ring anyway. This means that
1017 you can use the killing commands to copy text from a read-only buffer.
1018
1019 This is the primitive for programs to kill text (as opposed to deleting it).
1020 Supply two arguments, character numbers indicating the stretch of text
1021 to be killed.
1022 Any command that calls this function is a \"kill command\".
1023 If the previous command was also a kill command,
1024 the text killed this time appends to the text killed last time
1025 to make one entry in the kill ring."
1026 (interactive "r")
1027 (cond
1028
1029 ;; If the buffer is read-only, we should beep, in case the person
1030 ;; just isn't aware of this. However, there's no harm in putting
1031 ;; the region's text in the kill ring, anyway.
1032 (buffer-read-only
1033 (copy-region-as-kill beg end)
1034 ;; This should always barf, and give us the correct error.
1035 (barf-if-buffer-read-only))
1036
1037 ;; In certain cases, we can arrange for the undo list and the kill
1038 ;; ring to share the same string object. This code does that.
1039 ((not (or (eq buffer-undo-list t)
1040 (eq last-command 'kill-region)
1041 (eq beg end)))
1042 ;; Don't let the undo list be truncated before we can even access it.
1043 (let ((undo-strong-limit (+ (- (max beg end) (min beg end)) 100))
1044 (old-list buffer-undo-list)
1045 tail)
1046 (delete-region beg end)
1047 ;; Search back in buffer-undo-list for this string,
1048 ;; in case a change hook made property changes.
1049 (setq tail buffer-undo-list)
1050 (while (not (stringp (car (car tail))))
1051 (setq tail (cdr tail)))
1052 ;; Take the same string recorded for undo
1053 ;; and put it in the kill-ring.
1054 (kill-new (car (car tail)))
1055 (setq this-command 'kill-region)))
1056
1057 (t
1058 (copy-region-as-kill beg end)
1059 (delete-region beg end))))
1060
1061 (defun copy-region-as-kill (beg end)
1062 "Save the region as if killed, but don't kill it.
1063 If `interprogram-cut-function' is non-nil, also save the text for a window
1064 system cut and paste."
1065 (interactive "r")
1066 (if (eq last-command 'kill-region)
1067 (kill-append (buffer-substring beg end) (< end beg))
1068 (kill-new (buffer-substring beg end)))
1069 (setq this-command 'kill-region)
1070 nil)
1071
1072 (defun kill-ring-save (beg end)
1073 "Save the region as if killed, but don't kill it.
1074 This command is similar to `copy-region-as-kill', except that it gives
1075 visual feedback indicating the extent of the region being copied.
1076 If `interprogram-cut-function' is non-nil, also save the text for a window
1077 system cut and paste."
1078 (interactive "r")
1079 (copy-region-as-kill beg end)
1080 (if (interactive-p)
1081 (let ((other-end (if (= (point) beg) end beg))
1082 (opoint (point))
1083 ;; Inhibit quitting so we can make a quit here
1084 ;; look like a C-g typed as a command.
1085 (inhibit-quit t))
1086 (if (pos-visible-in-window-p other-end (selected-window))
1087 (progn
1088 ;; Swap point and mark.
1089 (set-marker (mark-marker) (point) (current-buffer))
1090 (goto-char other-end)
1091 (sit-for 1)
1092 ;; Swap back.
1093 (set-marker (mark-marker) other-end (current-buffer))
1094 (goto-char opoint)
1095 ;; If user quit, deactivate the mark
1096 ;; as C-g would as a command.
1097 (and quit-flag mark-active
1098 (progn
1099 (message "foo") ;XXX what is this here for? --roland
1100 (deactivate-mark))))
1101 (let* ((killed-text (current-kill 0))
1102 (message-len (min (length killed-text) 40)))
1103 (if (= (point) beg)
1104 ;; Don't say "killed"; that is misleading.
1105 (message "Saved text until \"%s\""
1106 (substring killed-text (- message-len)))
1107 (message "Saved text from \"%s\""
1108 (substring killed-text 0 message-len))))))))
1109
1110 (defun append-next-kill ()
1111 "Cause following command, if it kills, to append to previous kill."
1112 (interactive)
1113 (if (interactive-p)
1114 (progn
1115 (setq this-command 'kill-region)
1116 (message "If the next command is a kill, it will append"))
1117 (setq last-command 'kill-region)))
1118
1119 (defun yank-pop (arg)
1120 "Replace just-yanked stretch of killed text with a different stretch.
1121 This command is allowed only immediately after a `yank' or a `yank-pop'.
1122 At such a time, the region contains a stretch of reinserted
1123 previously-killed text. `yank-pop' deletes that text and inserts in its
1124 place a different stretch of killed text.
1125
1126 With no argument, the previous kill is inserted.
1127 With argument N, insert the Nth previous kill.
1128 If N is negative, this is a more recent kill.
1129
1130 The sequence of kills wraps around, so that after the oldest one
1131 comes the newest one."
1132 (interactive "*p")
1133 (if (not (eq last-command 'yank))
1134 (error "Previous command was not a yank"))
1135 (setq this-command 'yank)
1136 (let ((before (< (point) (mark t))))
1137 (delete-region (point) (mark t))
1138 (set-marker (mark-marker) (point) (current-buffer))
1139 (insert (current-kill arg))
1140 (if before
1141 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
1142 ;; It is cleaner to avoid activation, even though the command
1143 ;; loop would deactivate the mark because we inserted text.
1144 (goto-char (prog1 (mark t)
1145 (set-marker (mark-marker) (point) (current-buffer))))))
1146 nil)
1147
1148 (defun yank (&optional arg)
1149 "Reinsert the last stretch of killed text.
1150 More precisely, reinsert the stretch of killed text most recently
1151 killed OR yanked. Put point at end, and set mark at beginning.
1152 With just C-u as argument, same but put point at beginning (and mark at end).
1153 With argument N, reinsert the Nth most recently killed stretch of killed
1154 text.
1155 See also the command \\[yank-pop]."
1156 (interactive "*P")
1157 (push-mark (point))
1158 (insert (current-kill (cond
1159 ((listp arg) 0)
1160 ((eq arg '-) -1)
1161 (t (1- arg)))))
1162 (if (consp arg)
1163 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
1164 ;; It is cleaner to avoid activation, even though the command
1165 ;; loop would deactivate the mark because we inserted text.
1166 (goto-char (prog1 (mark t)
1167 (set-marker (mark-marker) (point) (current-buffer)))))
1168 nil)
1169
1170 (defun rotate-yank-pointer (arg)
1171 "Rotate the yanking point in the kill ring.
1172 With argument, rotate that many kills forward (or backward, if negative)."
1173 (interactive "p")
1174 (current-kill arg))
1175
1176 \f
1177 (defun insert-buffer (buffer)
1178 "Insert after point the contents of BUFFER.
1179 Puts mark after the inserted text.
1180 BUFFER may be a buffer or a buffer name."
1181 (interactive (list (progn (barf-if-buffer-read-only)
1182 (read-buffer "Insert buffer: " (other-buffer) t))))
1183 (or (bufferp buffer)
1184 (setq buffer (get-buffer buffer)))
1185 (let (start end newmark)
1186 (save-excursion
1187 (save-excursion
1188 (set-buffer buffer)
1189 (setq start (point-min) end (point-max)))
1190 (insert-buffer-substring buffer start end)
1191 (setq newmark (point)))
1192 (push-mark newmark))
1193 nil)
1194
1195 (defun append-to-buffer (buffer start end)
1196 "Append to specified buffer the text of the region.
1197 It is inserted into that buffer before its point.
1198
1199 When calling from a program, give three arguments:
1200 BUFFER (or buffer name), START and END.
1201 START and END specify the portion of the current buffer to be copied."
1202 (interactive
1203 (list (read-buffer "Append to buffer: " (other-buffer nil t))
1204 (region-beginning) (region-end)))
1205 (let ((oldbuf (current-buffer)))
1206 (save-excursion
1207 (set-buffer (get-buffer-create buffer))
1208 (insert-buffer-substring oldbuf start end))))
1209
1210 (defun prepend-to-buffer (buffer start end)
1211 "Prepend to specified buffer the text of the region.
1212 It is inserted into that buffer after its point.
1213
1214 When calling from a program, give three arguments:
1215 BUFFER (or buffer name), START and END.
1216 START and END specify the portion of the current buffer to be copied."
1217 (interactive "BPrepend to buffer: \nr")
1218 (let ((oldbuf (current-buffer)))
1219 (save-excursion
1220 (set-buffer (get-buffer-create buffer))
1221 (save-excursion
1222 (insert-buffer-substring oldbuf start end)))))
1223
1224 (defun copy-to-buffer (buffer start end)
1225 "Copy to specified buffer the text of the region.
1226 It is inserted into that buffer, replacing existing text there.
1227
1228 When calling from a program, give three arguments:
1229 BUFFER (or buffer name), START and END.
1230 START and END specify the portion of the current buffer to be copied."
1231 (interactive "BCopy to buffer: \nr")
1232 (let ((oldbuf (current-buffer)))
1233 (save-excursion
1234 (set-buffer (get-buffer-create buffer))
1235 (erase-buffer)
1236 (save-excursion
1237 (insert-buffer-substring oldbuf start end)))))
1238 \f
1239 (defvar mark-even-if-inactive nil
1240 "*Non-nil means you can use the mark even when inactive.
1241 This option makes a difference in Transient Mark mode.
1242 When the option is non-nil, deactivation of the mark
1243 turns off region highlighting, but commands that use the mark
1244 behave as if the mark were still active.")
1245
1246 (put 'mark-inactive 'error-conditions '(mark-inactive error))
1247 (put 'mark-inactive 'error-message "The mark is not active now")
1248
1249 (defun mark (&optional force)
1250 "Return this buffer's mark value as integer; error if mark inactive.
1251 If optional argument FORCE is non-nil, access the mark value
1252 even if the mark is not currently active, and return nil
1253 if there is no mark at all.
1254
1255 If you are using this in an editing command, you are most likely making
1256 a mistake; see the documentation of `set-mark'."
1257 (if (or force mark-active mark-even-if-inactive)
1258 (marker-position (mark-marker))
1259 (signal 'mark-inactive nil)))
1260
1261 ;; Many places set mark-active directly, and several of them failed to also
1262 ;; run deactivate-mark-hook. This shorthand should simplify.
1263 (defsubst deactivate-mark ()
1264 "Deactivate the mark by setting `mark-active' to nil.
1265 Also runs the hook `deactivate-mark-hook'."
1266 (setq mark-active nil)
1267 (run-hooks 'deactivate-mark-hook))
1268
1269 (defun set-mark (pos)
1270 "Set this buffer's mark to POS. Don't use this function!
1271 That is to say, don't use this function unless you want
1272 the user to see that the mark has moved, and you want the previous
1273 mark position to be lost.
1274
1275 Normally, when a new mark is set, the old one should go on the stack.
1276 This is why most applications should use push-mark, not set-mark.
1277
1278 Novice Emacs Lisp programmers often try to use the mark for the wrong
1279 purposes. The mark saves a location for the user's convenience.
1280 Most editing commands should not alter the mark.
1281 To remember a location for internal use in the Lisp program,
1282 store it in a Lisp variable. Example:
1283
1284 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
1285
1286 (setq mark-active t)
1287 (run-hooks 'activate-mark-hook)
1288 (set-marker (mark-marker) pos (current-buffer)))
1289
1290 (defvar mark-ring nil
1291 "The list of saved former marks of the current buffer,
1292 most recent first.")
1293 (make-variable-buffer-local 'mark-ring)
1294
1295 (defconst mark-ring-max 16
1296 "*Maximum size of mark ring. Start discarding off end if gets this big.")
1297
1298 (defun set-mark-command (arg)
1299 "Set mark at where point is, or jump to mark.
1300 With no prefix argument, set mark, and push old mark position on mark ring.
1301 With argument, jump to mark, and pop a new position for mark off the ring.
1302
1303 Novice Emacs Lisp programmers often try to use the mark for the wrong
1304 purposes. See the documentation of `set-mark' for more information."
1305 (interactive "P")
1306 (if (null arg)
1307 (progn
1308 (push-mark nil nil t))
1309 (if (null (mark t))
1310 (error "No mark set in this buffer")
1311 (goto-char (mark t))
1312 (pop-mark))))
1313
1314 (defun push-mark (&optional location nomsg activate)
1315 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
1316 Display `Mark set' unless the optional second arg NOMSG is non-nil.
1317 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil.
1318
1319 Novice Emacs Lisp programmers often try to use the mark for the wrong
1320 purposes. See the documentation of `set-mark' for more information.
1321
1322 In Transient Mark mode, this does not activate the mark."
1323 (if (null (mark t))
1324 nil
1325 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
1326 (if (> (length mark-ring) mark-ring-max)
1327 (progn
1328 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
1329 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil))))
1330 (set-marker (mark-marker) (or location (point)) (current-buffer))
1331 (or nomsg executing-macro (> (minibuffer-depth) 0)
1332 (message "Mark set"))
1333 (if (or activate (not transient-mark-mode))
1334 (set-mark (mark t)))
1335 nil)
1336
1337 (defun pop-mark ()
1338 "Pop off mark ring into the buffer's actual mark.
1339 Does not set point. Does nothing if mark ring is empty."
1340 (if mark-ring
1341 (progn
1342 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
1343 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
1344 (deactivate-mark)
1345 (move-marker (car mark-ring) nil)
1346 (if (null (mark t)) (ding))
1347 (setq mark-ring (cdr mark-ring)))))
1348
1349 (define-function 'exchange-dot-and-mark 'exchange-point-and-mark)
1350 (defun exchange-point-and-mark ()
1351 "Put the mark where point is now, and point where the mark is now.
1352 This command works even when the mark is not active,
1353 and it reactivates the mark."
1354 (interactive nil)
1355 (let ((omark (mark t)))
1356 (if (null omark)
1357 (error "No mark set in this buffer"))
1358 (set-mark (point))
1359 (goto-char omark)
1360 nil))
1361
1362 (defun transient-mark-mode (arg)
1363 "Toggle Transient Mark mode.
1364 With arg, turn Transient Mark mode on if arg is positive, off otherwise.
1365
1366 In Transient Mark mode, changing the buffer \"deactivates\" the mark.
1367 While the mark is active, the region is highlighted."
1368 (interactive "P")
1369 (setq transient-mark-mode
1370 (if (null arg)
1371 (not transient-mark-mode)
1372 (> (prefix-numeric-value arg) 0))))
1373 \f
1374 (defvar next-line-add-newlines t
1375 "*If non-nil, `next-line' inserts newline to avoid `end of buffer' error.")
1376
1377 (defun next-line (arg)
1378 "Move cursor vertically down ARG lines.
1379 If there is no character in the target line exactly under the current column,
1380 the cursor is positioned after the character in that line which spans this
1381 column, or at the end of the line if it is not long enough.
1382 If there is no line in the buffer after this one, behavior depends on the
1383 value of next-line-add-newlines. If non-nil, a newline character is inserted
1384 to create a line and the cursor moves to that line, otherwise the cursor is
1385 moved to the end of the buffer (if already at the end of the buffer, an error
1386 is signaled).
1387
1388 The command \\[set-goal-column] can be used to create
1389 a semipermanent goal column to which this command always moves.
1390 Then it does not try to move vertically. This goal column is stored
1391 in `goal-column', which is nil when there is none.
1392
1393 If you are thinking of using this in a Lisp program, consider
1394 using `forward-line' instead. It is usually easier to use
1395 and more reliable (no dependence on goal column, etc.)."
1396 (interactive "p")
1397 (let ((opoint (point)))
1398 (if next-line-add-newlines
1399 (if (/= arg 1)
1400 (line-move arg)
1401 (forward-line 1)
1402 (if (or (= opoint (point)) (not (eq (preceding-char) ?\n)))
1403 (insert ?\n)
1404 (goto-char opoint)
1405 (line-move arg)))
1406 (if (eobp)
1407 (signal 'end-of-buffer nil))
1408 (line-move arg)
1409 (if (= opoint (point))
1410 (end-of-line))))
1411 nil)
1412
1413 (defun previous-line (arg)
1414 "Move cursor vertically up ARG lines.
1415 If there is no character in the target line exactly over the current column,
1416 the cursor is positioned after the character in that line which spans this
1417 column, or at the end of the line if it is not long enough.
1418
1419 The command \\[set-goal-column] can be used to create
1420 a semipermanent goal column to which this command always moves.
1421 Then it does not try to move vertically.
1422
1423 If you are thinking of using this in a Lisp program, consider using
1424 `forward-line' with a negative argument instead. It is usually easier
1425 to use and more reliable (no dependence on goal column, etc.)."
1426 (interactive "p")
1427 (line-move (- arg))
1428 nil)
1429
1430 (defconst track-eol nil
1431 "*Non-nil means vertical motion starting at end of line keeps to ends of lines.
1432 This means moving to the end of each line moved onto.
1433 The beginning of a blank line does not count as the end of a line.")
1434
1435 (defvar goal-column nil
1436 "*Semipermanent goal column for vertical motion, as set by \\[set-goal-column], or nil.")
1437 (make-variable-buffer-local 'goal-column)
1438
1439 (defvar temporary-goal-column 0
1440 "Current goal column for vertical motion.
1441 It is the column where point was
1442 at the start of current run of vertical motion commands.
1443 When the `track-eol' feature is doing its job, the value is 9999.")
1444
1445 (defun line-move (arg)
1446 (if (not (or (eq last-command 'next-line)
1447 (eq last-command 'previous-line)))
1448 (setq temporary-goal-column
1449 (if (and track-eol (eolp)
1450 ;; Don't count beg of empty line as end of line
1451 ;; unless we just did explicit end-of-line.
1452 (or (not (bolp)) (eq last-command 'end-of-line)))
1453 9999
1454 (current-column))))
1455 (if (not (integerp selective-display))
1456 (forward-line arg)
1457 ;; Move by arg lines, but ignore invisible ones.
1458 (while (> arg 0)
1459 (vertical-motion 1)
1460 (forward-char -1)
1461 (forward-line 1)
1462 (setq arg (1- arg)))
1463 (while (< arg 0)
1464 (vertical-motion -1)
1465 (beginning-of-line)
1466 (setq arg (1+ arg))))
1467 (move-to-column (or goal-column temporary-goal-column))
1468 nil)
1469
1470 ;;; Many people have said they rarely use this feature, and often type
1471 ;;; it by accident. Maybe it shouldn't even be on a key.
1472 (put 'set-goal-column 'disabled t)
1473
1474 (defun set-goal-column (arg)
1475 "Set the current horizontal position as a goal for \\[next-line] and \\[previous-line].
1476 Those commands will move to this position in the line moved to
1477 rather than trying to keep the same horizontal position.
1478 With a non-nil argument, clears out the goal column
1479 so that \\[next-line] and \\[previous-line] resume vertical motion.
1480 The goal column is stored in the variable `goal-column'."
1481 (interactive "P")
1482 (if arg
1483 (progn
1484 (setq goal-column nil)
1485 (message "No goal column"))
1486 (setq goal-column (current-column))
1487 (message (substitute-command-keys
1488 "Goal column %d (use \\[set-goal-column] with an arg to unset it)")
1489 goal-column))
1490 nil)
1491 \f
1492 ;;; Partial support for horizontal autoscrolling. Someday, this feature
1493 ;;; will be built into the C level and all the (hscroll-point-visible) calls
1494 ;;; will go away.
1495
1496 (defvar hscroll-step 0
1497 "*The number of columns to try scrolling a window by when point moves out.
1498 If that fails to bring point back on frame, point is centered instead.
1499 If this is zero, point is always centered after it moves off frame.")
1500
1501 (defun hscroll-point-visible ()
1502 "Scrolls the window horizontally to make point visible."
1503 (let* ((here (current-column))
1504 (left (window-hscroll))
1505 (right (- (+ left (window-width)) 3)))
1506 (cond
1507 ;; Should we recenter?
1508 ((or (< here (- left hscroll-step))
1509 (> here (+ right hscroll-step)))
1510 (set-window-hscroll
1511 (selected-window)
1512 ;; Recenter, but don't show too much white space off the end of
1513 ;; the line.
1514 (max 0
1515 (min (- (save-excursion (end-of-line) (current-column))
1516 (window-width)
1517 -5)
1518 (- here (/ (window-width) 2))))))
1519 ;; Should we scroll left?
1520 ((> here right)
1521 (scroll-left hscroll-step))
1522 ;; Or right?
1523 ((< here left)
1524 (scroll-right hscroll-step)))))
1525
1526 ;; rms: (1) The definitions of arrow keys should not simply restate
1527 ;; what keys they are. The arrow keys should run the ordinary commands.
1528 ;; (2) The arrow keys are just one of many common ways of moving point
1529 ;; within a line. Real horizontal autoscrolling would be a good feature,
1530 ;; but supporting it only for arrow keys is too incomplete to be desirable.
1531
1532 ;;;;; Make arrow keys do the right thing for improved terminal support
1533 ;;;;; When we implement true horizontal autoscrolling, right-arrow and
1534 ;;;;; left-arrow can lose the (if truncate-lines ...) clause and become
1535 ;;;;; aliases. These functions are bound to the corresponding keyboard
1536 ;;;;; events in loaddefs.el.
1537
1538 ;;(defun right-arrow (arg)
1539 ;; "Move right one character on the screen (with prefix ARG, that many chars).
1540 ;;Scroll right if needed to keep point horizontally onscreen."
1541 ;; (interactive "P")
1542 ;; (forward-char arg)
1543 ;; (hscroll-point-visible))
1544
1545 ;;(defun left-arrow (arg)
1546 ;; "Move left one character on the screen (with prefix ARG, that many chars).
1547 ;;Scroll left if needed to keep point horizontally onscreen."
1548 ;; (interactive "P")
1549 ;; (backward-char arg)
1550 ;; (hscroll-point-visible))
1551 \f
1552 (defun transpose-chars (arg)
1553 "Interchange characters around point, moving forward one character.
1554 With prefix arg ARG, effect is to take character before point
1555 and drag it forward past ARG other characters (backward if ARG negative).
1556 If no argument and at end of line, the previous two chars are exchanged."
1557 (interactive "*P")
1558 (and (null arg) (eolp) (forward-char -1))
1559 (transpose-subr 'forward-char (prefix-numeric-value arg)))
1560
1561 (defun transpose-words (arg)
1562 "Interchange words around point, leaving point at end of them.
1563 With prefix arg ARG, effect is to take word before or around point
1564 and drag it forward past ARG other words (backward if ARG negative).
1565 If ARG is zero, the words around or after point and around or after mark
1566 are interchanged."
1567 (interactive "*p")
1568 (transpose-subr 'forward-word arg))
1569
1570 (defun transpose-sexps (arg)
1571 "Like \\[transpose-words] but applies to sexps.
1572 Does not work on a sexp that point is in the middle of
1573 if it is a list or string."
1574 (interactive "*p")
1575 (transpose-subr 'forward-sexp arg))
1576
1577 (defun transpose-lines (arg)
1578 "Exchange current line and previous line, leaving point after both.
1579 With argument ARG, takes previous line and moves it past ARG lines.
1580 With argument 0, interchanges line point is in with line mark is in."
1581 (interactive "*p")
1582 (transpose-subr (function
1583 (lambda (arg)
1584 (if (= arg 1)
1585 (progn
1586 ;; Move forward over a line,
1587 ;; but create a newline if none exists yet.
1588 (end-of-line)
1589 (if (eobp)
1590 (newline)
1591 (forward-char 1)))
1592 (forward-line arg))))
1593 arg))
1594
1595 (defun transpose-subr (mover arg)
1596 (let (start1 end1 start2 end2)
1597 (if (= arg 0)
1598 (progn
1599 (save-excursion
1600 (funcall mover 1)
1601 (setq end2 (point))
1602 (funcall mover -1)
1603 (setq start2 (point))
1604 (goto-char (mark))
1605 (funcall mover 1)
1606 (setq end1 (point))
1607 (funcall mover -1)
1608 (setq start1 (point))
1609 (transpose-subr-1))
1610 (exchange-point-and-mark)))
1611 (while (> arg 0)
1612 (funcall mover -1)
1613 (setq start1 (point))
1614 (funcall mover 1)
1615 (setq end1 (point))
1616 (funcall mover 1)
1617 (setq end2 (point))
1618 (funcall mover -1)
1619 (setq start2 (point))
1620 (transpose-subr-1)
1621 (goto-char end2)
1622 (setq arg (1- arg)))
1623 (while (< arg 0)
1624 (funcall mover -1)
1625 (setq start2 (point))
1626 (funcall mover -1)
1627 (setq start1 (point))
1628 (funcall mover 1)
1629 (setq end1 (point))
1630 (funcall mover 1)
1631 (setq end2 (point))
1632 (transpose-subr-1)
1633 (setq arg (1+ arg)))))
1634
1635 (defun transpose-subr-1 ()
1636 (if (> (min end1 end2) (max start1 start2))
1637 (error "Don't have two things to transpose"))
1638 (let ((word1 (buffer-substring start1 end1))
1639 (word2 (buffer-substring start2 end2)))
1640 (delete-region start2 end2)
1641 (goto-char start2)
1642 (insert word1)
1643 (goto-char (if (< start1 start2) start1
1644 (+ start1 (- (length word1) (length word2)))))
1645 (delete-char (length word1))
1646 (insert word2)))
1647 \f
1648 (defconst comment-column 32
1649 "*Column to indent right-margin comments to.
1650 Setting this variable automatically makes it local to the current buffer.
1651 Each mode establishes a different default value for this variable; you
1652 can the value for a particular mode using that mode's hook.")
1653 (make-variable-buffer-local 'comment-column)
1654
1655 (defconst comment-start nil
1656 "*String to insert to start a new comment, or nil if no comment syntax defined.")
1657
1658 (defconst comment-start-skip nil
1659 "*Regexp to match the start of a comment plus everything up to its body.
1660 If there are any \\(...\\) pairs, the comment delimiter text is held to begin
1661 at the place matched by the close of the first pair.")
1662
1663 (defconst comment-end ""
1664 "*String to insert to end a new comment.
1665 Should be an empty string if comments are terminated by end-of-line.")
1666
1667 (defconst comment-indent-hook nil
1668 "Obsolete variable for function to compute desired indentation for a comment.
1669 This function is called with no args with point at the beginning of
1670 the comment's starting delimiter.")
1671
1672 (defconst comment-indent-function
1673 '(lambda () comment-column)
1674 "Function to compute desired indentation for a comment.
1675 This function is called with no args with point at the beginning of
1676 the comment's starting delimiter.")
1677
1678 (defun indent-for-comment ()
1679 "Indent this line's comment to comment column, or insert an empty comment."
1680 (interactive "*")
1681 (beginning-of-line 1)
1682 (if (null comment-start)
1683 (error "No comment syntax defined")
1684 (let* ((eolpos (save-excursion (end-of-line) (point)))
1685 cpos indent begpos)
1686 (if (re-search-forward comment-start-skip eolpos 'move)
1687 (progn (setq cpos (point-marker))
1688 ;; Find the start of the comment delimiter.
1689 ;; If there were paren-pairs in comment-start-skip,
1690 ;; position at the end of the first pair.
1691 (if (match-end 1)
1692 (goto-char (match-end 1))
1693 ;; If comment-start-skip matched a string with
1694 ;; internal whitespace (not final whitespace) then
1695 ;; the delimiter start at the end of that
1696 ;; whitespace. Otherwise, it starts at the
1697 ;; beginning of what was matched.
1698 (skip-syntax-backward " " (match-beginning 0))
1699 (skip-syntax-backward "^ " (match-beginning 0)))))
1700 (setq begpos (point))
1701 ;; Compute desired indent.
1702 (if (= (current-column)
1703 (setq indent (if comment-indent-hook
1704 (funcall comment-indent-hook)
1705 (funcall comment-indent-function))))
1706 (goto-char begpos)
1707 ;; If that's different from current, change it.
1708 (skip-chars-backward " \t")
1709 (delete-region (point) begpos)
1710 (indent-to indent))
1711 ;; An existing comment?
1712 (if cpos
1713 (progn (goto-char cpos)
1714 (set-marker cpos nil))
1715 ;; No, insert one.
1716 (insert comment-start)
1717 (save-excursion
1718 (insert comment-end))))))
1719
1720 (defun set-comment-column (arg)
1721 "Set the comment column based on point.
1722 With no arg, set the comment column to the current column.
1723 With just minus as arg, kill any comment on this line.
1724 With any other arg, set comment column to indentation of the previous comment
1725 and then align or create a comment on this line at that column."
1726 (interactive "P")
1727 (if (eq arg '-)
1728 (kill-comment nil)
1729 (if arg
1730 (progn
1731 (save-excursion
1732 (beginning-of-line)
1733 (re-search-backward comment-start-skip)
1734 (beginning-of-line)
1735 (re-search-forward comment-start-skip)
1736 (goto-char (match-beginning 0))
1737 (setq comment-column (current-column))
1738 (message "Comment column set to %d" comment-column))
1739 (indent-for-comment))
1740 (setq comment-column (current-column))
1741 (message "Comment column set to %d" comment-column))))
1742
1743 (defun kill-comment (arg)
1744 "Kill the comment on this line, if any.
1745 With argument, kill comments on that many lines starting with this one."
1746 ;; this function loses in a lot of situations. it incorrectly recognises
1747 ;; comment delimiters sometimes (ergo, inside a string), doesn't work
1748 ;; with multi-line comments, can kill extra whitespace if comment wasn't
1749 ;; through end-of-line, et cetera.
1750 (interactive "P")
1751 (or comment-start-skip (error "No comment syntax defined"))
1752 (let ((count (prefix-numeric-value arg)) endc)
1753 (while (> count 0)
1754 (save-excursion
1755 (end-of-line)
1756 (setq endc (point))
1757 (beginning-of-line)
1758 (and (string< "" comment-end)
1759 (setq endc
1760 (progn
1761 (re-search-forward (regexp-quote comment-end) endc 'move)
1762 (skip-chars-forward " \t")
1763 (point))))
1764 (beginning-of-line)
1765 (if (re-search-forward comment-start-skip endc t)
1766 (progn
1767 (goto-char (match-beginning 0))
1768 (skip-chars-backward " \t")
1769 (kill-region (point) endc)
1770 ;; to catch comments a line beginnings
1771 (indent-according-to-mode))))
1772 (if arg (forward-line 1))
1773 (setq count (1- count)))))
1774
1775 (defun comment-region (beg end &optional arg)
1776 "Comment the region; third arg numeric means use ARG comment characters.
1777 If ARG is negative, delete that many comment characters instead.
1778 Comments are terminated on each line, even for syntax in which newline does
1779 not end the comment. Blank lines do not get comments."
1780 ;; if someone wants it to only put a comment-start at the beginning and
1781 ;; comment-end at the end then typing it, C-x C-x, closing it, C-x C-x
1782 ;; is easy enough. No option is made here for other than commenting
1783 ;; every line.
1784 (interactive "r\np")
1785 (or comment-start (error "No comment syntax is defined"))
1786 (if (> beg end) (let (mid) (setq mid beg beg end end mid)))
1787 (save-excursion
1788 (save-restriction
1789 (let ((cs comment-start) (ce comment-end))
1790 (cond ((not arg) (setq arg 1))
1791 ((> arg 1)
1792 (while (> (setq arg (1- arg)) 0)
1793 (setq cs (concat cs comment-start)
1794 ce (concat ce comment-end)))))
1795 (narrow-to-region beg end)
1796 (goto-char beg)
1797 (while (not (eobp))
1798 (if (< arg 0)
1799 (let ((count arg))
1800 (while (and (> 1 (setq count (1+ count)))
1801 (looking-at (regexp-quote cs)))
1802 (delete-char (length cs)))
1803 (if (string= "" ce) ()
1804 (setq count arg)
1805 (while (> 1 (setq count (1+ count)))
1806 (end-of-line)
1807 ;; this is questionable if comment-end ends in whitespace
1808 ;; that is pretty brain-damaged though
1809 (skip-chars-backward " \t")
1810 (backward-char (length ce))
1811 (if (looking-at (regexp-quote ce))
1812 (delete-char (length ce)))))
1813 (forward-line 1))
1814 (if (looking-at "[ \t]*$") ()
1815 (insert cs)
1816 (if (string= "" ce) ()
1817 (end-of-line)
1818 (insert ce)))
1819 (search-forward "\n" nil 'move)))))))
1820 \f
1821 (defun backward-word (arg)
1822 "Move backward until encountering the end of a word.
1823 With argument, do this that many times.
1824 In programs, it is faster to call `forward-word' with negative arg."
1825 (interactive "p")
1826 (forward-word (- arg)))
1827
1828 (defun mark-word (arg)
1829 "Set mark arg words away from point."
1830 (interactive "p")
1831 (push-mark
1832 (save-excursion
1833 (forward-word arg)
1834 (point))
1835 nil t))
1836
1837 (defun kill-word (arg)
1838 "Kill characters forward until encountering the end of a word.
1839 With argument, do this that many times."
1840 (interactive "p")
1841 (kill-region (point) (save-excursion (forward-word arg) (point))))
1842
1843 (defun backward-kill-word (arg)
1844 "Kill characters backward until encountering the end of a word.
1845 With argument, do this that many times."
1846 (interactive "p")
1847 (kill-word (- arg)))
1848
1849 (defun current-word ()
1850 "Return the word point is on as a string, if it's between two
1851 word-constituent characters. If not, but it immediately follows one,
1852 move back first. Otherwise, if point precedes a word constituent,
1853 move forward first. Otherwise, move backwards until a word constituent
1854 is found and get that word; if you reach a newline first, move forward
1855 instead."
1856 (interactive)
1857 (save-excursion
1858 (let ((oldpoint (point)) (start (point)) (end (point)))
1859 (skip-syntax-backward "w_") (setq start (point))
1860 (goto-char oldpoint)
1861 (skip-syntax-forward "w_") (setq end (point))
1862 (if (and (eq start oldpoint) (eq end oldpoint))
1863 (progn
1864 (skip-syntax-backward "^w_"
1865 (save-excursion (beginning-of-line) (point)))
1866 (if (eq (preceding-char) ?\n)
1867 (progn
1868 (skip-syntax-forward "^w_")
1869 (setq start (point))
1870 (skip-syntax-forward "w_")
1871 (setq end (point)))
1872 (setq end (point))
1873 (skip-syntax-backward "w_")
1874 (setq start (point)))))
1875 (buffer-substring start end))))
1876 \f
1877 (defconst fill-prefix nil
1878 "*String for filling to insert at front of new line, or nil for none.
1879 Setting this variable automatically makes it local to the current buffer.")
1880 (make-variable-buffer-local 'fill-prefix)
1881
1882 (defconst auto-fill-inhibit-regexp nil
1883 "*Regexp to match lines which should not be auto-filled.")
1884
1885 (defun do-auto-fill ()
1886 (let (give-up)
1887 (or (and auto-fill-inhibit-regexp
1888 (save-excursion (beginning-of-line)
1889 (looking-at auto-fill-inhibit-regexp)))
1890 (while (and (not give-up) (> (current-column) fill-column))
1891 (let ((fill-point
1892 (let ((opoint (point)))
1893 (save-excursion
1894 (move-to-column (1+ fill-column))
1895 (skip-chars-backward "^ \t\n")
1896 (if (bolp)
1897 (re-search-forward "[ \t]" opoint t))
1898 (skip-chars-backward " \t")
1899 (point)))))
1900 ;; If there is a space on the line before fill-point,
1901 ;; and nonspaces precede it, break the line there.
1902 (if (save-excursion
1903 (goto-char fill-point)
1904 (not (bolp)))
1905 ;; If point is at the fill-point, do not `save-excursion'.
1906 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
1907 ;; point will end up before it rather than after it.
1908 (if (save-excursion
1909 (skip-chars-backward " \t")
1910 (= (point) fill-point))
1911 (indent-new-comment-line)
1912 (save-excursion
1913 (goto-char fill-point)
1914 (indent-new-comment-line)))
1915 ;; No place to break => stop trying.
1916 (setq give-up t)))))))
1917
1918 (defconst comment-multi-line nil
1919 "*Non-nil means \\[indent-new-comment-line] should continue same comment
1920 on new line, with no new terminator or starter.
1921 This is obsolete because you might as well use \\[newline-and-indent].")
1922
1923 (defun indent-new-comment-line ()
1924 "Break line at point and indent, continuing comment if presently within one.
1925 The body of the continued comment is indented under the previous comment line.
1926
1927 This command is intended for styles where you write a comment per line,
1928 starting a new comment (and terminating it if necessary) on each line.
1929 If you want to continue one comment across several lines, use \\[newline-and-indent]."
1930 (interactive "*")
1931 (let (comcol comstart)
1932 (skip-chars-backward " \t")
1933 (delete-region (point)
1934 (progn (skip-chars-forward " \t")
1935 (point)))
1936 (insert ?\n)
1937 (if (not comment-multi-line)
1938 (save-excursion
1939 (if (and comment-start-skip
1940 (let ((opoint (point)))
1941 (forward-line -1)
1942 (re-search-forward comment-start-skip opoint t)))
1943 ;; The old line is a comment.
1944 ;; Set WIN to the pos of the comment-start.
1945 ;; But if the comment is empty, look at preceding lines
1946 ;; to find one that has a nonempty comment.
1947 (let ((win (match-beginning 0)))
1948 (while (and (eolp) (not (bobp))
1949 (let (opoint)
1950 (beginning-of-line)
1951 (setq opoint (point))
1952 (forward-line -1)
1953 (re-search-forward comment-start-skip opoint t)))
1954 (setq win (match-beginning 0)))
1955 ;; Indent this line like what we found.
1956 (goto-char win)
1957 (setq comcol (current-column))
1958 (setq comstart (buffer-substring (point) (match-end 0)))))))
1959 (if comcol
1960 (let ((comment-column comcol)
1961 (comment-start comstart)
1962 (comment-end comment-end))
1963 (and comment-end (not (equal comment-end ""))
1964 ; (if (not comment-multi-line)
1965 (progn
1966 (forward-char -1)
1967 (insert comment-end)
1968 (forward-char 1))
1969 ; (setq comment-column (+ comment-column (length comment-start))
1970 ; comment-start "")
1971 ; )
1972 )
1973 (if (not (eolp))
1974 (setq comment-end ""))
1975 (insert ?\n)
1976 (forward-char -1)
1977 (indent-for-comment)
1978 (save-excursion
1979 ;; Make sure we delete the newline inserted above.
1980 (end-of-line)
1981 (delete-char 1)))
1982 (if fill-prefix
1983 (insert fill-prefix)
1984 (indent-according-to-mode)))))
1985
1986 (defun auto-fill-mode (&optional arg)
1987 "Toggle auto-fill mode.
1988 With arg, turn auto-fill mode on if and only if arg is positive.
1989 In auto-fill mode, inserting a space at a column beyond fill-column
1990 automatically breaks the line at a previous space."
1991 (interactive "P")
1992 (prog1 (setq auto-fill-function
1993 (if (if (null arg)
1994 (not auto-fill-function)
1995 (> (prefix-numeric-value arg) 0))
1996 'do-auto-fill
1997 nil))
1998 ;; update mode-line
1999 (set-buffer-modified-p (buffer-modified-p))))
2000
2001 (defun turn-on-auto-fill ()
2002 "Unconditionally turn on Auto Fill mode."
2003 (auto-fill-mode 1))
2004
2005 (defun set-fill-column (arg)
2006 "Set `fill-column' to current column, or to argument if given.
2007 The variable `fill-column' has a separate value for each buffer."
2008 (interactive "P")
2009 (setq fill-column (if (integerp arg) arg (current-column)))
2010 (message "fill-column set to %d" fill-column))
2011 \f
2012 (defun set-selective-display (arg)
2013 "Set `selective-display' to ARG; clear it if no arg.
2014 When the value of `selective-display' is a number > 0,
2015 lines whose indentation is >= that value are not displayed.
2016 The variable `selective-display' has a separate value for each buffer."
2017 (interactive "P")
2018 (if (eq selective-display t)
2019 (error "selective-display already in use for marked lines"))
2020 (let ((current-vpos
2021 (save-restriction
2022 (narrow-to-region (point-min) (point))
2023 (goto-char (window-start))
2024 (vertical-motion (window-height)))))
2025 (setq selective-display
2026 (and arg (prefix-numeric-value arg)))
2027 (recenter current-vpos))
2028 (set-window-start (selected-window) (window-start (selected-window)))
2029 (princ "selective-display set to " t)
2030 (prin1 selective-display t)
2031 (princ "." t))
2032
2033 (defconst overwrite-mode-textual " Ovwrt"
2034 "The string displayed in the mode line when in overwrite mode.")
2035 (defconst overwrite-mode-binary " Bin Ovwrt"
2036 "The string displayed in the mode line when in binary overwrite mode.")
2037
2038 (defun overwrite-mode (arg)
2039 "Toggle overwrite mode.
2040 With arg, turn overwrite mode on iff arg is positive.
2041 In overwrite mode, printing characters typed in replace existing text
2042 on a one-for-one basis, rather than pushing it to the right. At the
2043 end of a line, such characters extend the line. Before a tab,
2044 such characters insert until the tab is filled in.
2045 \\[quoted-insert] still inserts characters in overwrite mode; this
2046 is supposed to make it easier to insert characters when necessary."
2047 (interactive "P")
2048 (setq overwrite-mode
2049 (if (if (null arg) (not overwrite-mode)
2050 (> (prefix-numeric-value arg) 0))
2051 'overwrite-mode-textual))
2052 (force-mode-line-update))
2053
2054 (defun binary-overwrite-mode (arg)
2055 "Toggle binary overwrite mode.
2056 With arg, turn binary overwrite mode on iff arg is positive.
2057 In binary overwrite mode, printing characters typed in replace
2058 existing text. Newlines are not treated specially, so typing at the
2059 end of a line joins the line to the next, with the typed character
2060 between them. Typing before a tab character simply replaces the tab
2061 with the character typed.
2062 \\[quoted-insert] replaces the text at the cursor, just as ordinary
2063 typing characters do.
2064
2065 Note that binary overwrite mode is not its own minor mode; it is a
2066 specialization of overwrite-mode, entered by setting the
2067 `overwrite-mode' variable to `overwrite-mode-binary'."
2068 (interactive "P")
2069 (setq overwrite-mode
2070 (if (if (null arg)
2071 (not (eq overwrite-mode 'overwrite-mode-binary))
2072 (> (prefix-numeric-value arg) 0))
2073 'overwrite-mode-binary))
2074 (force-mode-line-update))
2075 \f
2076 (defvar line-number-mode nil
2077 "*Non-nil means display line number in mode line.")
2078
2079 (defun line-number-mode (arg)
2080 "Toggle Line Number mode.
2081 With arg, turn Line Number mode on iff arg is positive.
2082 When Line Number mode is enabled, the line number appears
2083 in the mode line."
2084 (interactive "P")
2085 (setq line-number-mode
2086 (if (null arg) (not line-number-mode)
2087 (> (prefix-numeric-value arg) 0)))
2088 (force-mode-line-update))
2089
2090 (defvar blink-matching-paren t
2091 "*Non-nil means show matching open-paren when close-paren is inserted.")
2092
2093 (defconst blink-matching-paren-distance 12000
2094 "*If non-nil, is maximum distance to search for matching open-paren.")
2095
2096 (defun blink-matching-open ()
2097 "Move cursor momentarily to the beginning of the sexp before point."
2098 (interactive)
2099 (and (> (point) (1+ (point-min)))
2100 (/= (char-syntax (char-after (- (point) 2))) ?\\ )
2101 blink-matching-paren
2102 (let* ((oldpos (point))
2103 (blinkpos)
2104 (mismatch))
2105 (save-excursion
2106 (save-restriction
2107 (if blink-matching-paren-distance
2108 (narrow-to-region (max (point-min)
2109 (- (point) blink-matching-paren-distance))
2110 oldpos))
2111 (condition-case ()
2112 (setq blinkpos (scan-sexps oldpos -1))
2113 (error nil)))
2114 (and blinkpos (/= (char-syntax (char-after blinkpos))
2115 ?\$)
2116 (setq mismatch
2117 (/= (char-after (1- oldpos))
2118 (logand (lsh (aref (syntax-table)
2119 (char-after blinkpos))
2120 -8)
2121 255))))
2122 (if mismatch (setq blinkpos nil))
2123 (if blinkpos
2124 (progn
2125 (goto-char blinkpos)
2126 (if (pos-visible-in-window-p)
2127 (sit-for 1)
2128 (goto-char blinkpos)
2129 (message
2130 "Matches %s"
2131 (if (save-excursion
2132 (skip-chars-backward " \t")
2133 (not (bolp)))
2134 (buffer-substring (progn (beginning-of-line) (point))
2135 (1+ blinkpos))
2136 (buffer-substring blinkpos
2137 (progn
2138 (forward-char 1)
2139 (skip-chars-forward "\n \t")
2140 (end-of-line)
2141 (point)))))))
2142 (cond (mismatch
2143 (message "Mismatched parentheses"))
2144 ((not blink-matching-paren-distance)
2145 (message "Unmatched parenthesis"))))))))
2146
2147 ;Turned off because it makes dbx bomb out.
2148 (setq blink-paren-function 'blink-matching-open)
2149
2150 ;; This executes C-g typed while Emacs is waiting for a command.
2151 ;; Quitting out of a program does not go through here;
2152 ;; that happens in the QUIT macro at the C code level.
2153 (defun keyboard-quit ()
2154 "Signal a quit condition.
2155 During execution of Lisp code, this character causes a quit directly.
2156 At top-level, as an editor command, this simply beeps."
2157 (interactive)
2158 (deactivate-mark)
2159 (signal 'quit nil))
2160
2161 (define-key global-map "\C-g" 'keyboard-quit)
2162 \f
2163 (defun set-variable (var val)
2164 "Set VARIABLE to VALUE. VALUE is a Lisp object.
2165 When using this interactively, supply a Lisp expression for VALUE.
2166 If you want VALUE to be a string, you must surround it with doublequotes.
2167
2168 If VARIABLE has a `variable-interactive' property, that is used as if
2169 it were the arg to `interactive' (which see) to interactively read the value."
2170 (interactive
2171 (let* ((var (read-variable "Set variable: "))
2172 (minibuffer-help-form
2173 '(funcall myhelp))
2174 (myhelp
2175 (function
2176 (lambda ()
2177 (with-output-to-temp-buffer "*Help*"
2178 (prin1 var)
2179 (princ "\nDocumentation:\n")
2180 (princ (substring (documentation-property var 'variable-documentation)
2181 1))
2182 (if (boundp var)
2183 (let ((print-length 20))
2184 (princ "\n\nCurrent value: ")
2185 (prin1 (symbol-value var))))
2186 nil)))))
2187 (list var
2188 (let ((prop (get var 'variable-interactive)))
2189 (if prop
2190 ;; Use VAR's `variable-interactive' property
2191 ;; as an interactive spec for prompting.
2192 (call-interactively (list 'lambda '(arg)
2193 (list 'interactive prop)
2194 'arg))
2195 (eval-minibuffer (format "Set %s to value: " var)))))))
2196 (set var val))
2197 \f
2198 ;; Define the major mode for lists of completions.
2199
2200 (defvar completion-mode-map nil)
2201 (or completion-mode-map
2202 (let ((map (make-sparse-keymap)))
2203 (define-key map [mouse-2] 'mouse-choose-completion)
2204 (setq completion-mode-map map)))
2205
2206 ;; Completion mode is suitable only for specially formatted data.
2207 (put 'completion-mode 'mode-class 'special)
2208
2209 (defun completion-mode ()
2210 "Major mode for buffers showing lists of possible completions.
2211 Type \\<completion-mode-map>\\[mouse-choose-completion] to select
2212 a completion with the mouse."
2213 (interactive)
2214 (kill-all-local-variables)
2215 (use-local-map completion-mode-map)
2216 (setq mode-name "Completion")
2217 (setq major-mode 'completion-mode)
2218 (run-hooks 'completion-mode-hook))
2219
2220 (defun completion-setup-function ()
2221 (save-excursion
2222 (completion-mode)
2223 (goto-char (point-min))
2224 (if window-system
2225 (insert (substitute-command-keys
2226 "Click \\[mouse-choose-completion] on a completion to select it.\n\n")))))
2227
2228 (add-hook 'completion-setup-hook 'completion-setup-function)
2229 \f
2230 ;;;; Keypad support.
2231
2232 ;;; Make the keypad keys act like ordinary typing keys. If people add
2233 ;;; bindings for the function key symbols, then those bindings will
2234 ;;; override these, so this shouldn't interfere with any existing
2235 ;;; bindings.
2236
2237 (mapcar
2238 (lambda (keypad-normal)
2239 (let ((keypad (nth 0 keypad-normal))
2240 (normal (nth 1 keypad-normal)))
2241 (define-key function-key-map (vector keypad) (vector normal))))
2242 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
2243 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
2244 (kp-space ?\ )
2245 (kp-tab ?\t)
2246 (kp-enter ?\r)
2247 (kp-multiply ?*)
2248 (kp-add ?+)
2249 (kp-separator ?,)
2250 (kp-subtract ?-)
2251 (kp-decimal ?.)
2252 (kp-divide ?/)
2253 (kp-equal ?=)))
2254
2255 ;;; simple.el ends here