| blob | 68682a6552f5cd377a84a68e7d22c85f8b730770 |
1 ;;; simple.el --- basic editing commands for Emacs
3 ;; Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 ;; 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
6 ;; Maintainer: FSF
7 ;; Keywords: internal
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
26 ;;; Commentary:
28 ;; A grab-bag of basic Emacs commands not specifically related to some
29 ;; major mode or to file-handling.
31 ;;; Code:
40 "*Idle time delay before updating various things on the screen.
41 Various Emacs features that update auxiliary information when point moves
42 wait this many seconds after Emacs becomes idle before doing an update."
48 "Killing and yanking commands."
52 "Highlight (un)matching of parens and expressions."
56 "Switch to the next buffer in cyclic order."
63 "Switch to the previous buffer in cyclic order."
66 found)
74 \f
75 ;;; next-error support framework
78 "`next-error' support framework."
84 "Face used to highlight next error locus."
89 "*Highlighting of locations in selected source buffers.
90 If number, highlight the locus in `next-error' face for given time in seconds.
91 If t, use persistent overlays fontified in `next-error' face.
92 If nil, don't highlight the locus in the source buffer.
93 If `fringe-arrow', indicate the locus by the fringe arrow."
102 "*Highlighting of locations in non-selected source buffers.
103 If number, highlight the locus in `next-error' face for given time in seconds.
104 If t, use persistent overlays fontified in `next-error' face.
105 If nil, don't highlight the locus in the source buffer.
106 If `fringe-arrow', indicate the locus by the fringe arrow."
115 "*List of hook functions run by `next-error' after visiting source file."
126 "The most recent `next-error' buffer.
127 A buffer becomes most recent when its compilation, grep, or
132 "Function to use to find the next error in the current buffer.
133 The function is called with 2 parameters:
134 ARG is an integer specifying by how many errors to move.
135 RESET is a boolean which, if non-nil, says to go back to the beginning
136 of the errors before moving.
137 Major modes providing compile-like functionality should set this variable
138 to indicate to `next-error' that this is a candidate buffer and how
144 &optional avoid-current
145 extra-test-inclusive
146 extra-test-exclusive)
147 "Test if BUFFER is a `next-error' capable buffer.
149 If AVOID-CURRENT is non-nil, treat the current buffer
150 as an absolute last resort only.
152 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
153 that normally would not qualify. If it returns t, the buffer
154 in question is treated as usable.
156 The function EXTRA-TEST-EXCLUSIVE, if non-nil is called in each buffer
157 that would normally be considered usable. If it returns nil,
158 that buffer is rejected."
163 ;; Optionally reject some buffers.
166 t)
167 ;; Optionally accept some other buffers.
172 extra-test-inclusive
173 extra-test-exclusive)
174 "Return a `next-error' capable buffer.
175 If AVOID-CURRENT is non-nil, treat the current buffer
176 as an absolute last resort only.
178 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
179 that normally would not qualify. If it returns t, the buffer
180 in question is treated as usable.
182 The function EXTRA-TEST-EXCLUSIVE, if non-nil is called in each buffer
183 that would normally be considered usable. If it returns nil,
184 that buffer is rejected."
186 ;; 1. If one window on the selected frame displays such buffer, return it.
192 avoid-current
193 extra-test-inclusive extra-test-exclusive)
198 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
201 extra-test-inclusive extra-test-exclusive))
202 next-error-last-buffer)
203 ;; 3. If the current buffer is acceptable, choose it.
205 extra-test-inclusive extra-test-exclusive)
207 ;; 4. Look for any acceptable buffer.
212 extra-test-inclusive extra-test-exclusive)))
215 ;; 5. Use the current buffer as a last resort if it qualifies,
216 ;; even despite AVOID-CURRENT.
219 extra-test-inclusive extra-test-exclusive)
223 ;; 6. Give up.
227 "Visit next `next-error' message and corresponding source code.
229 If all the error messages parsed so far have been processed already,
230 the message buffer is checked for new ones.
232 A prefix ARG specifies how many error messages to move;
233 negative means move back to previous error messages.
235 and start at the first error.
237 The RESET argument specifies that we should restart from the beginning.
240 compilation, grep, or occur buffer. It can also operate on any
242 more generally, on any buffer in Compilation mode or with
243 Compilation Minor mode enabled, or any buffer in which
244 `next-error-function' is bound to an appropriate function.
245 To specify use of a particular buffer for error messages, type
247 in the current frame.
250 runs `next-error-hook' with `run-hooks', and stays with that buffer
251 until you use it in some other buffer which uses Compilation mode
252 or Compilation Minor mode.
254 See variables `compilation-parse-errors-function' and
255 \`compilation-error-regexp-alist' for customization ideas."
259 ;; we know here that next-error-function is a valid symbol we can funcall
265 "Visit the source code corresponding to the `next-error' message at point."
267 ;; we know here that next-error-function is a valid symbol we can funcall
276 "Visit previous `next-error' message and corresponding source code.
278 Prefix arg N says how many error messages to move backwards (or
279 forwards, if negative).
286 "Restart at the first error.
287 Visit corresponding source code.
288 With prefix arg N, visit the source code of the Nth error.
294 "Move point to the next error in the `next-error' buffer and highlight match.
295 Prefix arg N says how many error messages to move forwards (or
296 backwards, if negative).
298 select the source buffer."
305 "Move point to the previous error in the `next-error' buffer and highlight match.
306 Prefix arg N says how many error messages to move backwards (or
307 forwards, if negative).
309 select the source buffer."
313 ;;; Internal variable for `next-error-follow-mode-post-command-hook'.
317 "Minor mode for compilation, occur and diff modes.
318 When turned on, cursor motion in the compilation, grep, occur or diff
319 buffer causes automatic display of the corresponding source code
320 location."
327 ;;; Used as a `post-command-hook' by `next-error-follow-mode'
328 ;;; for the *Compilation* *grep* and *Occur* buffers.
338 \f
339 ;;;
342 "Major mode not specialized for anything in particular.
343 Other major modes are defined by comparison with this one."
349 ;; Making and deleting lines.
352 "Insert a newline, and move to left margin of the new line if it's blank.
353 If `use-hard-newlines' is non-nil, the newline is marked with the
354 text-property `hard'.
355 With ARG, insert that many newlines.
356 Call `auto-fill-function' if the current column number is greater
357 than the value of `fill-column' and ARG is nil."
360 ;; Inserting a newline at the end of a line produces better redisplay in
361 ;; try_window_id than inserting at the beginning of a line, and the textual
362 ;; result is the same. So, if we're at beginning of line, pretend to be at
363 ;; the end of the previous line.
366 ;; Make sure no functions want to be told about
367 ;; the range of the changes.
370 ;; Make sure there are no markers here.
373 ;; Make sure no text properties want to know
374 ;; where the change was.
379 ;; Make sure the newline before point isn't intangible.
381 ;; Make sure the newline before point isn't read-only.
383 ;; Make sure the newline before point isn't invisible.
385 ;; Make sure the newline before point has the same
386 ;; properties as the char before it (if any).
393 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
394 ;; Set last-command-char to tell self-insert what to insert.
396 ;; Don't auto-fill if we have a numeric argument.
397 ;; Also not if flag is true (it would fill wrong line);
398 ;; there is no need to since we're at BOL.
402 ;; If we get an error in self-insert-command, put point at right place.
404 ;; Even if we did *not* get an error, keep that forward-char;
405 ;; all further processing should apply to the newline that the user
406 ;; thinks he inserted.
408 ;; Mark the newline(s) `hard'.
412 ;; If the newline leaves the previous line blank,
413 ;; and we have a left margin, delete that from the blank line.
421 ;; Indent the line after the newline, except in one case:
422 ;; when we added the newline at the beginning of a line
423 ;; which starts a page.
426 nil)
431 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
437 "Insert a newline and leave point before it.
438 If there is a fill prefix and/or a `left-margin', insert them
439 on the new line if the line would have been blank.
440 With arg N, insert N newlines."
445 ;; Don't expand an abbrev before point.
459 "Split current line, moving portion beyond point vertically down.
460 If the current line starts with `fill-prefix', insert it on the new
461 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
463 When called from Lisp code, ARG may be a prefix string to copy."
468 ;; What prefix should we check for (nil means don't).
472 ;; Does this line start with it?
483 "Join this line to previous and fix up whitespace at join.
484 If there is a fill prefix, delete it from the beginning of this line.
485 With argument, join this line to following line."
492 ;; If the second line started with the fill prefix,
493 ;; delete the prefix.
505 "On blank line, delete all surrounding blank lines, leaving just one.
506 On isolated blank line, delete that one.
507 On nonblank line, delete any immediately following blank lines."
513 ;; Set singleblank if there is just one blank line here.
520 ;; Delete preceding blank lines, and this one too if it's the only one.
529 ;; Delete following blank lines, unless the current line is blank
530 ;; and there are no following blank lines.
539 ;; Handle the special case where point is followed by newline and eob.
540 ;; Delete the line, leaving point at eob.
545 "Delete all the trailing whitespace across the current buffer.
546 All whitespace after the last non-whitespace character in a line is deleted.
548 A formfeed is not considered whitespace by this function."
555 ;; Don't delete formfeeds, even if they are considered whitespace.
562 "Insert a newline, then indent according to major mode.
563 Indentation is done using the value of `indent-line-function'.
564 In programming language modes, this is the same as TAB.
565 In some text modes, where TAB inserts a tab, this command indents to the
566 column specified by the function `current-left-margin'."
573 "Reindent current line, insert newline, then indent the new line.
574 Indentation of both lines is done according to the current major mode,
575 which means calling the current value of `indent-line-function'.
576 In programming language modes, this is the same as TAB.
577 In some text modes, where TAB inserts a tab, this indents to the
578 column specified by the function `current-left-margin'."
581 ;; Be careful to insert the newline before indenting the line.
582 ;; Otherwise, the indentation might be wrong.
591 "Read next input character and insert it.
592 This is useful for inserting control characters.
594 If the first character you type after this command is an octal digit,
595 you should type a sequence of octal digits which specify a character code.
596 Any nondigit terminates the sequence. If the terminator is a RET,
597 it is discarded; any other terminator is used itself as input.
598 The variable `read-quoted-char-radix' specifies the radix for this feature;
599 set it to 10 or 16 to use decimal or hex instead of octal.
601 In overwrite mode, this function inserts the character anyway, and
602 does not handle octal digits specially. This means that if you use
603 overwrite as your normal editing mode, you can use this function to
604 insert characters when necessary.
606 In binary overwrite mode, this function does overwrite, and octal
607 digits are interpreted as a character code. This is intended to be
608 useful for editing binary files."
615 ;; Assume character codes 0240 - 0377 stand for characters in some
616 ;; single-byte character set, and convert them to Emacs
617 ;; characters.
630 "Move forward ARG lines and position at first nonblank character."
636 "Move backward ARG lines and position at first nonblank character."
642 "Move point to the first non-whitespace character on this line."
646 ;; Move back over chars that have whitespace syntax but have the p flag.
650 "Fixup white space between objects around point.
651 Leave one space or none, according to the context."
658 nil
662 "Delete all spaces and tabs around point.
663 If BACKWARD-ONLY is non-nil, only delete spaces before point."
668 orig-pos
677 "Delete all spaces and tabs around point, leaving one space (or N spaces)."
691 \f
693 "Move point to the beginning of the buffer; leave mark at previous position.
695 With numeric arg N, put point N/10 of the way from the beginning.
697 If the buffer is narrowed, this command uses the beginning and size
698 of the accessible part of the buffer.
700 Don't use this command in Lisp programs!
701 \(goto-char (point-min)) is faster and avoids clobbering the mark."
710 ;; Avoid overflow for large buffer sizes!
718 "Move point to the end of the buffer; leave mark at previous position.
720 With numeric arg N, put point N/10 of the way from the end.
722 If the buffer is narrowed, this command uses the beginning and size
723 of the accessible part of the buffer.
725 Don't use this command in Lisp programs!
726 \(goto-char (point-max)) is faster and avoids clobbering the mark."
735 ;; Avoid overflow for large buffer sizes!
740 ;; If we went to a place in the middle of the buffer,
741 ;; adjust it to the beginning of a line.
744 ;; If the end of the buffer is not already on the screen,
745 ;; then scroll specially to put it near, but not at, the bottom.
750 "Put point at beginning and mark at end of buffer.
751 You probably should not use this function in Lisp programs;
752 it is usually a mistake for a Lisp function to use any subroutine
753 that uses or sets the mark."
758 \f
760 ;; Counting lines, one way or another.
763 "Goto line ARG, counting from line 1 at beginning of buffer.
764 Normally, move point in the current buffer.
766 displayed other buffer, and switch to it. When called from Lisp code,
767 the optional argument BUFFER specifies a buffer to switch to.
769 If there's a number in the buffer at point, it is the default for ARG."
773 ;; Look for a default, a number in the buffer at point.
782 ;; Decide if we're switching buffers.
790 ;; Read the argument, offering that number (if any) as default.
793 buffer-prompt
794 default)
795 nil nil t
796 'minibuffer-history
797 default)
798 buffer))))
799 ;; Switch to the desired buffer, one way or another.
804 ;; Move to the specified line number in that buffer.
813 "Print number of lines and characters in the region."
819 "Print the current buffer line number and narrowed line number of point."
832 "Return number of lines between START and END.
833 This is usually the number of newlines between them,
834 but can be one more if START is not equal to END
835 and the greater of them is not at the start of a line."
851 done)))
855 "Return (narrowed) buffer line number at position POS.
856 If POS is nil, use current buffer location."
866 "Print info on cursor position (on screen and within buffer).
867 Also describe the character after point, and give its character code
868 in octal, decimal and hex.
870 For a non-ASCII multibyte character, also give its encoding in the
871 buffer's selected coding system if the coding system encodes the
872 character safely. If the character is encoded into one byte, that
873 code is shown in hex. If the character is encoded into more than one
876 In addition, with prefix argument, show details about that character
877 in *Help* buffer. See also the command `describe-char'."
885 ;; Avoid overflow from multiplying by 100!
889 ""
895 pos total percent beg end col hscroll)
897 pos total percent col hscroll))
899 encoded encoding-msg display-prop under-display)
906 ;; Check if the character is displayed with some `display'
907 ;; text property. In that case, set under-display to the
908 ;; buffer substring covered by that property.
919 under-display)))
925 char char char under-display)
927 char char char under-display display-prop))
930 char char char
932 "..."
936 ;; We show the detailed information about CHAR.
943 encoding-msg pos total percent beg end col hscroll)
950 encoding-msg pos total percent col hscroll))))))
951 \f
956 m)
962 "Value for `print-level' while printing value in `eval-expression'.
963 A value of nil means no limit."
969 "Value for `print-length' while printing value in `eval-expression'.
970 A value of nil means no limit."
976 "If non-nil set `debug-on-error' to t in `eval-expression'.
977 If nil, don't change the value of `debug-on-error'."
983 "Format VALUE as a result of evaluated expression.
984 Return a formatted string which is displayed in the echo area
985 in addition to the value printed by prin1 in functions which
986 display the result of expression evaluation."
999 ;; We define this, rather than making `eval' interactive,
1000 ;; for the sake of completion of names like eval-region, eval-current-buffer.
1003 "Evaluate EVAL-EXPRESSION-ARG and print value in the echo area.
1004 Value is also consed on to front of the variable `values'.
1005 Optional argument EVAL-EXPRESSION-INSERT-VALUE, if non-nil, means
1006 insert the result into the current buffer instead of printing it in
1007 the echo area."
1010 nil read-expression-map t
1012 current-prefix-arg))
1017 ;; Bind debug-on-error to something unique so that we can
1018 ;; detect when evaled code changes it.
1022 ;; If evaled code has changed the value of debug-on-error,
1023 ;; propagate that change to the global binding.
1039 "Prompting with PROMPT, let user edit COMMAND and eval result.
1040 COMMAND is a Lisp expression. Let user edit that expression in
1041 the minibuffer, then read and evaluate the result."
1048 read-expression-map t
1050 ;; If command was added to command-history as a string,
1051 ;; get rid of that. We want only evaluable expressions there.
1055 ;; If command to be redone does not match front of history,
1056 ;; add it to the history.
1062 "Edit and re-evaluate last complex command, or ARGth from last.
1063 A complex command is one which used the minibuffer.
1064 The command is placed in the minibuffer as a Lisp form for editing.
1065 The result is executed, repeating the command as changed.
1066 If the command has been changed or is not the most recent previous command
1067 it is added to the front of the command history.
1068 You can use the minibuffer history commands \\<minibuffer-local-map>\\[next-history-element] and \\[previous-history-element]
1069 to get different commands to edit and resubmit."
1072 newcmd)
1084 ;; If command was added to command-history as a
1085 ;; string, get rid of that. We want only
1086 ;; evaluable expressions there.
1090 ;; If command to be redone does not match front of history,
1091 ;; add it to the history.
1098 \f
1100 "Default minibuffer history list.
1101 This is used for all minibuffer input
1104 "Control whether history list elements are expressions or strings.
1105 If the value of this variable equals current minibuffer depth,
1106 they are expressions; otherwise they are strings.
1107 \(That convention is designed to do the right thing fora
1114 "Text that was in this minibuffer before any history commands.
1115 This is nil if there have not yet been any history commands
1124 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1128 "*Minibuffer history variables for which matching should ignore case.
1129 If a history variable is a member of this list, then the
1131 commands ignore case when searching it, regardless of `case-fold-search'."
1136 "Find the previous history element that matches REGEXP.
1137 \(Previous history elements refer to earlier actions.)
1138 With prefix argument N, search for Nth previous match.
1139 If N is negative, find the next or Nth next match.
1140 Normally, history elements are matched case-insensitively if
1141 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1142 makes the search case-sensitive.
1143 See also `minibuffer-history-case-insensitive-variables'."
1147 nil
1148 minibuffer-local-map
1149 nil
1150 'minibuffer-history-search-history
1152 ;; Use the last regexp specified, by default, if input is empty.
1157 regexp)
1167 ;; On some systems, ignore case for file names.
1169 minibuffer-history-case-insensitive-variables)
1170 t
1171 ;; Respect the user's setting for case-fold-search:
1172 case-fold-search)
1173 nil))
1174 prevpos
1175 match-string
1176 match-offset
1183 "No later matching history item"
1204 next-matching-history-element))
1208 "Find the next history element that matches REGEXP.
1209 \(The next history element refers to a more recent action.)
1210 With prefix argument N, search for Nth next match.
1211 If N is negative, find the previous or Nth previous match.
1212 Normally, history elements are matched case-insensitively if
1213 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1214 makes the search case-sensitive."
1218 nil
1219 minibuffer-local-map
1220 nil
1221 'minibuffer-history-search-history
1223 ;; Use the last regexp specified, by default, if input is empty.
1228 regexp)
1235 "Insert the next element of the minibuffer history into the minibuffer."
1240 elt minibuffer-returned-to-present)
1252 previous-history-element))
1274 elt))
1278 "Inserts the previous element of the minibuffer history into the minibuffer."
1283 "Get next history element which completes the minibuffer before the point.
1284 The contents of the minibuffer after the point are deleted, and replaced
1285 by the new completion."
1291 n)
1292 ;; next-matching-history-element always puts us at (point-min).
1293 ;; Move to the position we were at before changing the buffer contents.
1294 ;; This is still sensical, because the text before point has not changed.
1298 "\
1299 Get previous history element which completes the minibuffer before the point.
1300 The contents of the minibuffer after the point are deleted, and replaced
1301 by the new completion."
1305 ;; For compatibility with the old subr of the same name.
1307 "Return the display width of the minibuffer prompt.
1308 Return 0 if current buffer is not a minibuffer."
1309 ;; Return the width of everything before the field at the end of
1310 ;; the buffer; this should be 0 for normal buffers.
1312 \f
1313 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
1317 "Table mapping redo records to the corresponding undo one.
1318 A redo record for undo-in-region maps to t.
1328 "Within a run of consecutive undo commands, list remaining to be undone.
1332 "Undo some previous changes.
1333 Repeat this command to undo more changes.
1334 A numeric argument serves as a repeat count.
1336 In Transient Mark mode when the mark is active, only undo changes within
1338 as an argument limits undo to changes within the current region."
1340 ;; Make last-command indicate for the next command that this was an undo.
1341 ;; That way, another undo will undo more.
1342 ;; If we get to the end of the undo history and get an error,
1343 ;; another undo command will find the undo history empty
1344 ;; and will get another error. To begin undoing the undos,
1345 ;; you must type some other command.
1348 message)
1349 ;; If we get an error in undo-start,
1350 ;; the next command should not be a "consecutive undo".
1351 ;; So set `this-command' to something other than `undo'.
1356 ;; If something (a timer or filter?) changed the buffer
1357 ;; since the previous command, don't continue the undo seq.
1361 ;; If the last undo record made was made by undo
1362 ;; it shows nothing else happened in between.
1369 ;; get rid of initial undo boundary
1371 ;; If we got this far, the next command should be a consecutive undo.
1373 ;; Check to see whether we're hitting a redo record, and if
1374 ;; so, ask the user whether she wants to skip the redo/undo pair.
1381 ;; The equiv entry might point to another redo record if we have done
1382 ;; undo-redo-undo-redo-... so skip to the very last equiv.
1390 ;; Record the fact that the just-generated undo records come from an
1391 ;; undo operation--that is, they are redo records.
1392 ;; In the ordinary case (not within a region), map the redo
1393 ;; record to the following undos.
1394 ;; I don't know how to do that in the undo-in-region case.
1397 undo-equiv-table)
1398 ;; Don't specify a position in the undo record for the undo command.
1399 ;; Instead, undoing this should move point to where the change is.
1418 ;; Record what the current undo list says,
1419 ;; so the next command can tell if the buffer was modified in between.
1422 ;; Display a message announcing success.
1427 "Make BUFFER stop keeping undo information.
1428 No argument or nil as argument means do this for the current buffer."
1434 "Undo some previous changes.
1435 Repeat this command to undo more changes.
1436 A numeric argument serves as a repeat count.
1437 Contrary to `undo', this will not redo a previous undo."
1442 "Non-nil while performing an undo.
1446 "Undo back N undo-boundaries beyond what was already undone recently.
1447 Call `undo-start' to get ready to undo recent changes,
1448 then call `undo-more' one or more times to undo them."
1458 ;; Deep copy of a list
1460 "Make a copy of undo list LIST."
1466 elt))
1469 "Set `pending-undo-list' to the front of the undo list.
1470 The next call to `undo-more' will undo the most recently made change.
1471 If BEG and END are specified, then only undo elements
1472 that apply to text between BEG and END are used; other undo elements
1473 are ignored. If BEG and END are nil, all undo elements are used."
1479 buffer-undo-list)))
1484 "Return a list of undo elements for the region START to END.
1485 The elements come from `buffer-undo-list', but we keep only
1486 the elements inside this region, and discard those outside this region.
1487 If we find an element that crosses an edge of this region,
1488 we stop and ignore all further elements."
1491 undo-adjusted-markers
1492 some-rejected
1493 undo-elt undo-elt temp-undo-list delta)
1498 ;; This is a "was unmodified" element.
1499 ;; Keep it if we have kept everything thus far.
1506 ;; Don't put two nils together in the list
1520 ;; Loop down the earlier events adjusting their buffer
1521 ;; positions to reflect the fact that a change to the buffer
1522 ;; isn't being undone. We only need to process those element
1523 ;; types which undo-elt-in-region will return as being in
1524 ;; the region since only those types can ever get into the
1525 ;; output
1534 ;; (TEXT . POSITION)
1541 ;; (BEGIN . END)
1546 ;; (nil PROPERTY VALUE BEG . END)
1556 "Determine whether UNDO-ELT falls inside the region START ... END.
1557 If it crosses the edge, we return nil."
1562 t)
1564 nil)
1566 ;; (TEXT . POSITION)
1570 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
1571 ;; See if MARKER is inside the region.
1582 ;; (nil PROPERTY VALUE BEG . END)
1587 ;; (BEGIN . END)
1592 "Test whether UNDO-ELT crosses one edge of that region START ... END.
1593 This assumes we have already decided that UNDO-ELT
1594 is not *inside* the region START...END."
1597 ;; (nil PROPERTY VALUE BEG . END)
1602 ;; (BEGIN . END)
1606 ;; Return the first affected buffer position and the delta for an undo element
1607 ;; delta is defined as the change in subsequent buffer positions if we *did*
1608 ;; the undo.
1612 ;; (TEXT . POSITION)
1615 ;; (BEGIN . END)
1622 "If non-nil ask about discarding undo info for the current command.
1623 Normally, Emacs discards the undo info for the current command if
1624 it exceeds `undo-outer-limit'. But if you set this option
1625 non-nil, it asks in the echo area whether to discard the info.
1626 If you answer no, there a slight risk that Emacs might crash, so
1627 only do it if you really want to undo the command.
1629 This option is mainly intended for debugging. You have to be
1630 careful if you use it for other purposes. Garbage collection is
1631 inhibited while the question is asked, meaning that Emacs might
1632 leak memory. So you should make sure that you do not wait
1633 excessively long before answering the question."
1639 "If non-nil, an extra level of size that's ok in an undo item.
1640 We don't ask the user about truncating the undo list until the
1641 current item gets bigger than this amount.
1646 ;; When the first undo batch in an undo list is longer than
1647 ;; undo-outer-limit, this function gets called to warn the user that
1648 ;; the undo info for the current command was discarded. Garbage
1649 ;; collection is inhibited around the call, so it had better not do a
1650 ;; lot of consing.
1656 ;; Don't ask the question again unless it gets even bigger.
1657 ;; This applies, in particular, if the user quits from the question.
1658 ;; Such a quit quits out of GC, but something else will call GC
1659 ;; again momentarily. It will call this function again,
1660 ;; but we don't want to ask the question again.
1667 t)
1668 nil))
1673 "The undo info was discarded because it exceeded \
1674 `undo-outer-limit'.
1676 This is normal if you executed a command that made a huge change
1677 to the buffer. In that case, to prevent similar problems in the
1678 future, set `undo-outer-limit' to a value that is large enough to
1679 cover the maximum size of normal changes you expect a single
1680 command to make, but not so large that it might exceed the
1681 maximum memory allotted to Emacs.
1683 If you did not execute any such command, the situation is
1684 probably due to a bug and you should report it.
1686 You can disable the popping up of this buffer by adding the entry
1690 t))
1691 \f
1699 "*Buffer name for `shell-command' and `shell-command-on-region' error output.
1700 This buffer is used when `shell-command' or `shell-command-on-region'
1701 is run interactively. A value of nil means that output to stderr and
1705 "Execute string COMMAND in inferior shell; display output, if any.
1706 With prefix argument, insert the COMMAND's output at point.
1708 If COMMAND ends in ampersand, execute it asynchronously.
1709 The output appears in the buffer `*Async Shell Command*'.
1710 That buffer is in shell mode.
1712 Otherwise, COMMAND is executed synchronously. The output appears in
1713 the buffer `*Shell Command Output*'. If the output is short enough to
1714 display in the echo area (which is determined by the variables
1715 `resize-mini-windows' and `max-mini-window-height'), it is shown
1716 there, but it is nonetheless available in buffer `*Shell Command
1717 Output*' even though that buffer is not automatically displayed.
1719 To specify a coding system for converting non-ASCII characters
1721 before this command.
1723 Noninteractive callers can specify coding systems by binding
1724 `coding-system-for-read' and `coding-system-for-write'.
1726 The optional second argument OUTPUT-BUFFER, if non-nil,
1727 says to put the output in some other buffer.
1728 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
1729 If OUTPUT-BUFFER is not a buffer and not nil,
1730 insert output in current buffer. (This cannot be done asynchronously.)
1731 In either case, the output is inserted after point (leaving mark after it).
1733 If the command terminates without error, but generates output,
1735 the output can be displayed in the echo area or in its buffer.
1736 If the output is short enough to display in the echo area
1737 \(determined by the variable `max-mini-window-height' if
1738 `resize-mini-windows' is non-nil), it is shown there. Otherwise,
1739 the buffer containing the output is displayed.
1743 of the output.
1745 If there is no output, or if output is inserted in the current buffer,
1746 then `*Shell Command Output*' is deleted.
1748 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
1749 or buffer name to which to direct the command's standard error output.
1750 If it is nil, error output is mingled with regular output.
1751 In an interactive call, the variable `shell-command-default-error-buffer'
1752 specifies the value of ERROR-BUFFER."
1756 current-prefix-arg
1757 shell-command-default-error-buffer))
1758 ;; Look for a handler in case default-directory is a remote file name.
1766 ;; Output goes in current buffer.
1772 temporary-file-directory)))
1773 nil)))
1776 ;; We do not use -f for csh; we will not support broken use of
1777 ;; .cshrcs. Even the BSD csh manual says to use
1778 ;; "if ($?prompt) exit" before things which are not useful
1779 ;; non-interactively. Besides, if someone wants their other
1780 ;; aliases for shell commands then they can still have them.
1784 t)
1785 nil shell-command-switch command)
1792 ;; Do no formatting while reading error file,
1793 ;; because that can run a shell command, and we
1794 ;; don't want that to cause an infinite recursion.
1796 ;; Put point after the inserted errors.
1800 ;; This is like exchange-point-and-mark, but doesn't
1801 ;; activate the mark. It is cleaner to avoid activation,
1802 ;; even though the command loop would deactivate the mark
1803 ;; because we inserted text.
1807 ;; Output goes in a separate buffer.
1808 ;; Preserve the match data in case called from a program.
1811 ;; Command ending with ampersand means asynchronous.
1815 proc)
1816 ;; Remove the ampersand.
1818 ;; If will kill a process, query first.
1830 shell-command-switch command))
1834 ))
1836 output-buffer nil error-buffer)))))))
1840 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
1841 MESSAGE may be either a string or a buffer.
1843 A buffer is displayed using `display-buffer' if MESSAGE is too long for
1844 the maximum height of the echo area, as defined by `max-mini-window-height'
1845 if `resize-mini-windows' is non-nil.
1847 Returns either the string shown in the echo area, or when a pop-up
1848 buffer is used, the window used to display it.
1850 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
1851 name of the buffer used to display it in the case where a pop-up buffer
1852 is used, defaulting to `*Message*'. In the case where MESSAGE is a
1853 string and it is displayed in the echo area, it is not specified whether
1854 the contents are inserted into the buffer anyway.
1856 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
1857 and only used if a buffer is displayed."
1859 ;; Trivial case where we can use the echo area
1863 ;; Trivial case where we can just remove single trailing newline
1866 ;; General case
1869 message
1878 0
1882 (<= lines
1886 max-mini-window-height))
1888 max-mini-window-height)
1892 ;; Don't use the echo area if the output buffer is
1893 ;; already dispayed in the selected frame.
1895 ;; Echo area
1901 ;; Buffer
1904 not-this-window frame))))))))
1907 ;; We have a sentinel to prevent insertion of a termination message
1908 ;; in the buffer itself.
1916 &optional output-buffer replace
1917 error-buffer display-error-buffer)
1918 "Execute string COMMAND in inferior shell with region as input.
1919 Normally display output (if any) in temp buffer `*Shell Command Output*';
1920 Prefix arg means replace the region with it. Return the exit code of
1921 COMMAND.
1923 To specify a coding system for converting non-ASCII characters
1925 before this command. By default, the input (from the current buffer)
1926 is encoded in the same coding system that will be used to save the file,
1927 `buffer-file-coding-system'. If the output is going to replace the region,
1928 then it is decoded from that same coding system.
1930 The noninteractive arguments are START, END, COMMAND,
1931 OUTPUT-BUFFER, REPLACE, ERROR-BUFFER, and DISPLAY-ERROR-BUFFER.
1932 Noninteractive callers can specify coding systems by binding
1933 `coding-system-for-read' and `coding-system-for-write'.
1935 If the command generates output, the output may be displayed
1936 in the echo area or in a buffer.
1937 If the output is short enough to display in the echo area
1938 \(determined by the variable `max-mini-window-height' if
1939 `resize-mini-windows' is non-nil), it is shown there. Otherwise
1940 it is displayed in the buffer `*Shell Command Output*'. The output
1941 is available in that buffer in both cases.
1943 If there is output and an error, a message about the error
1944 appears at the end of the output.
1946 If there is no output, or if output is inserted in the current buffer,
1947 then `*Shell Command Output*' is deleted.
1949 If the optional fourth argument OUTPUT-BUFFER is non-nil,
1950 that says to put the output in some other buffer.
1951 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
1952 If OUTPUT-BUFFER is not a buffer and not nil,
1953 insert output in the current buffer.
1954 In either case, the output is inserted after point (leaving mark after it).
1956 If REPLACE, the optional fifth argument, is non-nil, that means insert
1957 the output in place of text from START to END, putting point and mark
1958 around it.
1960 If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
1961 or buffer name to which to direct the command's standard error output.
1962 If it is nil, error output is mingled with regular output.
1963 If DISPLAY-ERROR-BUFFER is non-nil, display the error buffer if there
1964 were any errors. (This is always t, interactively.)
1965 In an interactive call, the variable `shell-command-default-error-buffer'
1966 specifies the value of ERROR-BUFFER."
1970 ;; Do this before calling region-beginning
1971 ;; and region-end, in case subprocess output
1972 ;; relocates them while we are in the minibuffer.
1974 nil nil nil
1976 ;; call-interactively recognizes region-beginning and
1977 ;; region-end specially, leaving them in the history.
1979 string
1980 current-prefix-arg
1981 current-prefix-arg
1982 shell-command-default-error-buffer
1983 t)))
1989 temporary-file-directory)))
1990 nil))
1991 exit-status)
1995 ;; Replace specified region with output from command.
1997 ;; Don't muck with mark unless REPLACE says we should.
2004 t)
2005 nil shell-command-switch command))
2006 ;; It is rude to delete a buffer which the command is not using.
2007 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
2008 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
2009 ;; (kill-buffer shell-buffer)))
2010 ;; Don't muck with mark unless REPLACE says we should.
2012 ;; No prefix argument: put the output in a temp buffer,
2013 ;; replacing its entire contents.
2018 ;; If the input is the same buffer as the output,
2019 ;; delete everything but the specified region,
2020 ;; then replace that region with the output.
2026 shell-file-name t
2029 t)
2030 nil shell-command-switch
2031 command)))
2032 ;; Clear the output buffer, then run the command with
2033 ;; output there.
2045 buffer)
2046 nil shell-command-switch command)))
2047 ;; Report the output.
2057 ;; There's some output, display it
2059 ;; No output; error?
2063 "some error output"
2069 output))
2072 exit-status))
2075 exit-status output))))
2076 ;; Don't kill: there might be useful info in the undo-log.
2077 ;; (kill-buffer buffer)
2078 ))))
2086 ;; Do no formatting while reading error file,
2087 ;; because that can run a shell command, and we
2088 ;; don't want that to cause an infinite recursion.
2090 ;; Put point after the inserted errors.
2095 exit-status))
2098 "Execute shell command COMMAND and return its output as a string."
2101 standard-output
2105 "Process files synchronously in a separate process.
2106 Similar to `call-process', but may invoke a file handler based on
2107 `default-directory'. The current working directory of the
2108 subprocess is `default-directory'.
2110 File names in INFILE and BUFFER are handled normally, but file
2111 names in ARGS should be relative to `default-directory', as they
2112 are passed to the process verbatim. \(This is a difference to
2113 `call-process' which does not support file handlers for INFILE
2114 and BUFFER.\)
2116 Some file handlers might not support all variants, for example
2117 they might behave as if DISPLAY was nil, regardless of the actual
2118 value passed."
2120 lc stderr-file)
2130 display args)
2136 \f
2140 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
2141 (define-key map [switch-frame] nil)
2142 (define-key map [?\C-u] 'universal-argument-more)
2143 (define-key map [?-] 'universal-argument-minus)
2144 (define-key map [?0] 'digit-argument)
2145 (define-key map [?1] 'digit-argument)
2146 (define-key map [?2] 'digit-argument)
2147 (define-key map [?3] 'digit-argument)
2148 (define-key map [?4] 'digit-argument)
2149 (define-key map [?5] 'digit-argument)
2150 (define-key map [?6] 'digit-argument)
2151 (define-key map [?7] 'digit-argument)
2152 (define-key map [?8] 'digit-argument)
2153 (define-key map [?9] 'digit-argument)
2154 (define-key map [kp-0] 'digit-argument)
2155 (define-key map [kp-1] 'digit-argument)
2156 (define-key map [kp-2] 'digit-argument)
2157 (define-key map [kp-3] 'digit-argument)
2158 (define-key map [kp-4] 'digit-argument)
2159 (define-key map [kp-5] 'digit-argument)
2160 (define-key map [kp-6] 'digit-argument)
2161 (define-key map [kp-7] 'digit-argument)
2162 (define-key map [kp-8] 'digit-argument)
2163 (define-key map [kp-9] 'digit-argument)
2164 (define-key map [kp-subtract] 'universal-argument-minus)
2165 map)
2168 (defvar universal-argument-num-events nil
2169 "Number of argument-specifying events read by `universal-argument'.
2170 `universal-argument-other-key' uses this to discard those events
2171 from (this-command-keys), and reread only the final command.")
2173 (defvar overriding-map-is-bound nil
2174 "Non-nil when `overriding-terminal-local-map' is `universal-argument-map'.")
2176 (defvar saved-overriding-map nil
2177 "The saved value of `overriding-terminal-local-map'.
2181 (defun ensure-overriding-map-is-bound ()
2182 "Check `overriding-terminal-local-map' is `universal-argument-map'."
2183 (unless overriding-map-is-bound
2184 (setq saved-overriding-map overriding-terminal-local-map)
2185 (setq overriding-terminal-local-map universal-argument-map)
2186 (setq overriding-map-is-bound t)))
2188 (defun restore-overriding-map ()
2189 "Restore `overriding-terminal-local-map' to its saved value."
2190 (setq overriding-terminal-local-map saved-overriding-map)
2191 (setq overriding-map-is-bound nil))
2193 (defun universal-argument ()
2194 "Begin a numeric argument for the following command.
2199 multiplies the argument by 4 each time.
2201 which is different in effect from any particular numeric argument.
2203 (interactive)
2204 (setq prefix-arg (list 4))
2205 (setq universal-argument-num-events (length (this-command-keys)))
2206 (ensure-overriding-map-is-bound))
2208 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
2209 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
2210 (defun universal-argument-more (arg)
2211 (interactive "P")
2212 (if (consp arg)
2213 (setq prefix-arg (list (* 4 (car arg))))
2214 (if (eq arg '-)
2215 (setq prefix-arg (list -4))
2216 (setq prefix-arg arg)
2217 (restore-overriding-map)))
2218 (setq universal-argument-num-events (length (this-command-keys))))
2220 (defun negative-argument (arg)
2221 "Begin a negative numeric argument for the next command.
2223 (interactive "P")
2224 (cond ((integerp arg)
2225 (setq prefix-arg (- arg)))
2226 ((eq arg '-)
2227 (setq prefix-arg nil))
2228 (t
2229 (setq prefix-arg '-)))
2230 (setq universal-argument-num-events (length (this-command-keys)))
2231 (ensure-overriding-map-is-bound))
2233 (defun digit-argument (arg)
2234 "Part of the numeric argument for the next command.
2236 (interactive "P")
2237 (let* ((char (if (integerp last-command-char)
2238 last-command-char
2239 (get last-command-char 'ascii-character)))
2241 (cond ((integerp arg)
2242 (setq prefix-arg (+ (* arg 10)
2243 (if (< arg 0) (- digit) digit))))
2244 ((eq arg '-)
2245 ;; Treat -0 as just -, so that -01 will work.
2246 (setq prefix-arg (if (zerop digit) '- (- digit))))
2247 (t
2248 (setq prefix-arg digit))))
2249 (setq universal-argument-num-events (length (this-command-keys)))
2250 (ensure-overriding-map-is-bound))
2252 ;; For backward compatibility, minus with no modifiers is an ordinary
2253 ;; command if digits have already been entered.
2254 (defun universal-argument-minus (arg)
2255 (interactive "P")
2256 (if (integerp arg)
2257 (universal-argument-other-key arg)
2258 (negative-argument arg)))
2260 ;; Anything else terminates the argument and is left in the queue to be
2261 ;; executed as a command.
2262 (defun universal-argument-other-key (arg)
2263 (interactive "P")
2264 (setq prefix-arg arg)
2265 (let* ((key (this-command-keys))
2266 (keylist (listify-key-sequence key)))
2267 (setq unread-command-events
2268 (append (nthcdr universal-argument-num-events keylist)
2269 unread-command-events)))
2270 (reset-this-command-lengths)
2271 (restore-overriding-map))
2272 \f
2273 (defvar buffer-substring-filters nil
2274 "List of filter functions for `filter-buffer-substring'.
2275 Each function must accept a single argument, a string, and return
2276 a string. The buffer substring is passed to the first function
2277 in the list, and the return value of each function is passed to
2278 the next. The return value of the last function is used as the
2279 return value of `filter-buffer-substring'.
2281 If this variable is nil, no filtering is performed.")
2283 (defun filter-buffer-substring (beg end &optional delete)
2284 "Return the buffer substring between BEG and END, after filtering.
2285 The buffer substring is passed through each of the filter
2286 functions in `buffer-substring-filters', and the value from the
2287 last filter function is returned. If `buffer-substring-filters'
2288 is nil, the buffer substring is returned unaltered.
2290 If DELETE is non-nil, the text between BEG and END is deleted
2291 from the buffer.
2293 Point is temporarily set to BEG before calling
2294 `buffer-substring-filters', in case the functions need to know
2295 where the text came from.
2297 This function should be used instead of `buffer-substring' or
2298 `delete-and-extract-region' when you want to allow filtering to
2299 take place. For example, major or minor modes can use
2300 `buffer-substring-filters' to extract characters that are special
2301 to a buffer, and should not be copied into other buffers."
2302 (save-excursion
2303 (goto-char beg)
2304 (let ((string (if delete (delete-and-extract-region beg end)
2305 (buffer-substring beg end))))
2306 (dolist (filter buffer-substring-filters string)
2307 (setq string (funcall filter string))))))
2309 ;;;; Window system cut and paste hooks.
2311 (defvar interprogram-cut-function nil
2312 "Function to call to make a killed region available to other programs.
2314 Most window systems provide some sort of facility for cutting and
2315 pasting text between the windows of different programs.
2316 This variable holds a function that Emacs calls whenever text
2317 is put in the kill ring, to make the new kill available to other
2318 programs.
2320 The function takes one or two arguments.
2321 The first argument, TEXT, is a string containing
2322 the text which should be made available.
2323 The second, optional, argument PUSH, has the same meaning as the
2324 similar argument to `x-set-cut-buffer', which see.")
2326 (defvar interprogram-paste-function nil
2327 "Function to call to get text cut from other programs.
2329 Most window systems provide some sort of facility for cutting and
2330 pasting text between the windows of different programs.
2331 This variable holds a function that Emacs calls to obtain
2332 text that other programs have provided for pasting.
2334 The function should be called with no arguments. If the function
2335 returns nil, then no other program has provided such text, and the top
2336 of the Emacs kill ring should be used. If the function returns a
2337 string, then the caller of the function \(usually `current-kill')
2338 should put this string in the kill ring as the latest kill.
2340 Note that the function should return a string only if a program other
2341 than Emacs has provided a string for pasting; if Emacs provided the
2342 most recent string, the function should return nil. If it is
2343 difficult to tell whether Emacs or some other program provided the
2344 current string, it is probably good enough to return nil if the string
2345 is equal (according to `string=') to the last text Emacs provided.")
2346 \f
2349 ;;;; The kill ring data structure.
2351 (defvar kill-ring nil
2352 "List of killed text sequences.
2353 Since the kill ring is supposed to interact nicely with cut-and-paste
2354 facilities offered by window systems, use of this variable should
2355 interact nicely with `interprogram-cut-function' and
2356 `interprogram-paste-function'. The functions `kill-new',
2357 `kill-append', and `current-kill' are supposed to implement this
2358 interaction; you may want to use them instead of manipulating the kill
2359 ring directly.")
2361 (defcustom kill-ring-max 60
2362 "*Maximum length of kill ring before oldest elements are thrown away."
2363 :type 'integer
2364 :group 'killing)
2366 (defvar kill-ring-yank-pointer nil
2367 "The tail of the kill ring whose car is the last thing yanked.")
2369 (defun kill-new (string &optional replace yank-handler)
2370 "Make STRING the latest kill in the kill ring.
2371 Set `kill-ring-yank-pointer' to point to it.
2372 If `interprogram-cut-function' is non-nil, apply it to STRING.
2373 Optional second argument REPLACE non-nil means that STRING will replace
2374 the front of the kill ring, rather than being added to the list.
2376 Optional third arguments YANK-HANDLER controls how the STRING is later
2377 inserted into a buffer; see `insert-for-yank' for details.
2378 When a yank handler is specified, STRING must be non-empty (the yank
2379 handler, if non-nil, is stored as a `yank-handler' text property on STRING).
2381 When the yank handler has a non-nil PARAM element, the original STRING
2382 argument is not used by `insert-for-yank'. However, since Lisp code
2383 may access and use elements from the kill ring directly, the STRING
2385 (if (> (length string) 0)
2386 (if yank-handler
2387 (put-text-property 0 (length string)
2388 'yank-handler yank-handler string))
2389 (if yank-handler
2390 (signal 'args-out-of-range
2391 (list string "yank-handler specified for empty string"))))
2392 (if (fboundp 'menu-bar-update-yank-menu)
2393 (menu-bar-update-yank-menu string (and replace (car kill-ring))))
2394 (if (and replace kill-ring)
2395 (setcar kill-ring string)
2396 (push string kill-ring)
2397 (if (> (length kill-ring) kill-ring-max)
2398 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil)))
2399 (setq kill-ring-yank-pointer kill-ring)
2400 (if interprogram-cut-function
2401 (funcall interprogram-cut-function string (not replace))))
2403 (defun kill-append (string before-p &optional yank-handler)
2404 "Append STRING to the end of the latest kill in the kill ring.
2405 If BEFORE-P is non-nil, prepend STRING to the kill.
2406 Optional third argument YANK-HANDLER, if non-nil, specifies the
2407 yank-handler text property to be set on the combined kill ring
2408 string. If the specified yank-handler arg differs from the
2409 yank-handler property of the latest kill string, this function
2410 adds the combined string to the kill ring as a new element,
2411 instead of replacing the last kill with it.
2412 If `interprogram-cut-function' is set, pass the resulting kill to it."
2413 (let* ((cur (car kill-ring)))
2414 (kill-new (if before-p (concat string cur) (concat cur string))
2415 (or (= (length cur) 0)
2416 (equal yank-handler (get-text-property 0 'yank-handler cur)))
2417 yank-handler)))
2419 (defun current-kill (n &optional do-not-move)
2420 "Rotate the yanking point by N places, and then return that kill.
2421 If N is zero, `interprogram-paste-function' is set, and calling it
2422 returns a string, then that string is added to the front of the
2423 kill ring and returned as the latest kill.
2424 If optional arg DO-NOT-MOVE is non-nil, then don't actually move the
2425 yanking point; just return the Nth kill forward."
2426 (let ((interprogram-paste (and (= n 0)
2427 interprogram-paste-function
2428 (funcall interprogram-paste-function))))
2429 (if interprogram-paste
2430 (progn
2431 ;; Disable the interprogram cut function when we add the new
2432 ;; text to the kill ring, so Emacs doesn't try to own the
2433 ;; selection, with identical text.
2434 (let ((interprogram-cut-function nil))
2435 (kill-new interprogram-paste))
2436 interprogram-paste)
2437 (or kill-ring (error "Kill ring is empty"))
2438 (let ((ARGth-kill-element
2439 (nthcdr (mod (- n (length kill-ring-yank-pointer))
2440 (length kill-ring))
2441 kill-ring)))
2442 (or do-not-move
2443 (setq kill-ring-yank-pointer ARGth-kill-element))
2444 (car ARGth-kill-element)))))
2448 ;;;; Commands for manipulating the kill ring.
2450 (defcustom kill-read-only-ok nil
2451 "*Non-nil means don't signal an error for killing read-only text."
2452 :type 'boolean
2453 :group 'killing)
2455 (put 'text-read-only 'error-conditions
2456 '(text-read-only buffer-read-only error))
2457 (put 'text-read-only 'error-message "Text is read-only")
2459 (defun kill-region (beg end &optional yank-handler)
2460 "Kill between point and mark.
2461 The text is deleted but saved in the kill ring.
2465 If you want to append the killed region to the last killed text,
2468 If the buffer is read-only, Emacs will beep and refrain from deleting
2469 the text, but put the text in the kill ring anyway. This means that
2470 you can use the killing commands to copy text from a read-only buffer.
2472 This is the primitive for programs to kill text (as opposed to deleting it).
2473 Supply two arguments, character positions indicating the stretch of text
2474 to be killed.
2476 If the previous command was also a kill command,
2477 the text killed this time appends to the text killed last time
2478 to make one entry in the kill ring.
2480 In Lisp code, optional third arg YANK-HANDLER, if non-nil,
2481 specifies the yank-handler text property to be set on the killed
2482 text. See `insert-for-yank'."
2483 (interactive "r")
2484 (condition-case nil
2485 (let ((string (filter-buffer-substring beg end t)))
2486 (when string ;STRING is nil if BEG = END
2487 ;; Add that string to the kill ring, one way or another.
2488 (if (eq last-command 'kill-region)
2489 (kill-append string (< end beg) yank-handler)
2490 (kill-new string nil yank-handler)))
2491 (when (or string (eq last-command 'kill-region))
2492 (setq this-command 'kill-region))
2493 nil)
2494 ((buffer-read-only text-read-only)
2495 ;; The code above failed because the buffer, or some of the characters
2496 ;; in the region, are read-only.
2497 ;; We should beep, in case the user just isn't aware of this.
2498 ;; However, there's no harm in putting
2499 ;; the region's text in the kill ring, anyway.
2500 (copy-region-as-kill beg end)
2501 ;; Set this-command now, so it will be set even if we get an error.
2502 (setq this-command 'kill-region)
2503 ;; This should barf, if appropriate, and give us the correct error.
2504 (if kill-read-only-ok
2505 (progn (message "Read only text copied to kill ring") nil)
2506 ;; Signal an error if the buffer is read-only.
2507 (barf-if-buffer-read-only)
2508 ;; If the buffer isn't read-only, the text is.
2509 (signal 'text-read-only (list (current-buffer)))))))
2511 ;; copy-region-as-kill no longer sets this-command, because it's confusing
2512 ;; to get two copies of the text when the user accidentally types M-w and
2513 ;; then corrects it with the intended C-w.
2514 (defun copy-region-as-kill (beg end)
2515 "Save the region as if killed, but don't kill it.
2516 In Transient Mark mode, deactivate the mark.
2517 If `interprogram-cut-function' is non-nil, also save the text for a window
2518 system cut and paste."
2519 (interactive "r")
2520 (if (eq last-command 'kill-region)
2521 (kill-append (filter-buffer-substring beg end) (< end beg))
2522 (kill-new (filter-buffer-substring beg end)))
2523 (if transient-mark-mode
2524 (setq deactivate-mark t))
2525 nil)
2527 (defun kill-ring-save (beg end)
2528 "Save the region as if killed, but don't kill it.
2529 In Transient Mark mode, deactivate the mark.
2530 If `interprogram-cut-function' is non-nil, also save the text for a window
2531 system cut and paste.
2533 If you want to append the killed line to the last killed text,
2536 This command is similar to `copy-region-as-kill', except that it gives
2537 visual feedback indicating the extent of the region being copied."
2538 (interactive "r")
2539 (copy-region-as-kill beg end)
2540 ;; This use of interactive-p is correct
2541 ;; because the code it controls just gives the user visual feedback.
2542 (if (interactive-p)
2543 (let ((other-end (if (= (point) beg) end beg))
2544 (opoint (point))
2545 ;; Inhibit quitting so we can make a quit here
2546 ;; look like a C-g typed as a command.
2547 (inhibit-quit t))
2548 (if (pos-visible-in-window-p other-end (selected-window))
2549 (unless (and transient-mark-mode
2550 (face-background 'region))
2551 ;; Swap point and mark.
2552 (set-marker (mark-marker) (point) (current-buffer))
2553 (goto-char other-end)
2554 (sit-for blink-matching-delay)
2555 ;; Swap back.
2556 (set-marker (mark-marker) other-end (current-buffer))
2557 (goto-char opoint)
2558 ;; If user quit, deactivate the mark
2559 ;; as C-g would as a command.
2560 (and quit-flag mark-active
2561 (deactivate-mark)))
2562 (let* ((killed-text (current-kill 0))
2563 (message-len (min (length killed-text) 40)))
2564 (if (= (point) beg)
2565 ;; Don't say "killed"; that is misleading.
2567 (substring killed-text (- message-len)))
2569 (substring killed-text 0 message-len))))))))
2571 (defun append-next-kill (&optional interactive)
2572 "Cause following command, if it kills, to append to previous kill.
2573 The argument is used for internal purposes; do not supply one."
2574 (interactive "p")
2575 ;; We don't use (interactive-p), since that breaks kbd macros.
2576 (if interactive
2577 (progn
2578 (setq this-command 'kill-region)
2579 (message "If the next command is a kill, it will append"))
2580 (setq last-command 'kill-region)))
2581 \f
2582 ;; Yanking.
2584 ;; This is actually used in subr.el but defcustom does not work there.
2585 (defcustom yank-excluded-properties
2586 '(read-only invisible intangible field mouse-face help-echo local-map keymap
2587 yank-handler follow-link)
2588 "*Text properties to discard when yanking.
2589 The value should be a list of text properties to discard or t,
2590 which means to discard all text properties."
2591 :type '(choice (const :tag "All" t) (repeat symbol))
2592 :group 'killing
2593 :version "22.1")
2595 (defvar yank-window-start nil)
2596 (defvar yank-undo-function nil
2597 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
2598 Function is called with two parameters, START and END corresponding to
2599 the value of the mark and point; it is guaranteed that START <= END.
2600 Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
2602 (defun yank-pop (&optional arg)
2603 "Replace just-yanked stretch of killed text with a different stretch.
2604 This command is allowed only immediately after a `yank' or a `yank-pop'.
2605 At such a time, the region contains a stretch of reinserted
2606 previously-killed text. `yank-pop' deletes that text and inserts in its
2607 place a different stretch of killed text.
2609 With no argument, the previous kill is inserted.
2610 With argument N, insert the Nth previous kill.
2611 If N is negative, this is a more recent kill.
2613 The sequence of kills wraps around, so that after the oldest one
2614 comes the newest one.
2616 When this command inserts killed text into the buffer, it honors
2617 `yank-excluded-properties' and `yank-handler' as described in the
2618 doc string for `insert-for-yank-1', which see."
2619 (interactive "*p")
2620 (if (not (eq last-command 'yank))
2621 (error "Previous command was not a yank"))
2622 (setq this-command 'yank)
2623 (unless arg (setq arg 1))
2624 (let ((inhibit-read-only t)
2625 (before (< (point) (mark t))))
2626 (if before
2627 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
2628 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
2629 (setq yank-undo-function nil)
2630 (set-marker (mark-marker) (point) (current-buffer))
2631 (insert-for-yank (current-kill arg))
2632 ;; Set the window start back where it was in the yank command,
2633 ;; if possible.
2634 (set-window-start (selected-window) yank-window-start t)
2635 (if before
2636 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
2637 ;; It is cleaner to avoid activation, even though the command
2638 ;; loop would deactivate the mark because we inserted text.
2639 (goto-char (prog1 (mark t)
2640 (set-marker (mark-marker) (point) (current-buffer))))))
2641 nil)
2643 (defun yank (&optional arg)
2644 "Reinsert the last stretch of killed text.
2645 More precisely, reinsert the stretch of killed text most recently
2646 killed OR yanked. Put point at end, and set mark at beginning.
2647 With just \\[universal-argument] as argument, same but put point at beginning (and mark at end).
2648 With argument N, reinsert the Nth most recently killed stretch of killed
2649 text.
2651 When this command inserts killed text into the buffer, it honors
2652 `yank-excluded-properties' and `yank-handler' as described in the
2653 doc string for `insert-for-yank-1', which see.
2656 (interactive "*P")
2657 (setq yank-window-start (window-start))
2658 ;; If we don't get all the way thru, make last-command indicate that
2659 ;; for the following command.
2660 (setq this-command t)
2661 (push-mark (point))
2662 (insert-for-yank (current-kill (cond
2663 ((listp arg) 0)
2664 ((eq arg '-) -2)
2665 (t (1- arg)))))
2666 (if (consp arg)
2667 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
2668 ;; It is cleaner to avoid activation, even though the command
2669 ;; loop would deactivate the mark because we inserted text.
2670 (goto-char (prog1 (mark t)
2671 (set-marker (mark-marker) (point) (current-buffer)))))
2672 ;; If we do get all the way thru, make this-command indicate that.
2673 (if (eq this-command t)
2674 (setq this-command 'yank))
2675 nil)
2677 (defun rotate-yank-pointer (arg)
2678 "Rotate the yanking point in the kill ring.
2679 With argument, rotate that many kills forward (or backward, if negative)."
2680 (interactive "p")
2681 (current-kill arg))
2682 \f
2683 ;; Some kill commands.
2685 ;; Internal subroutine of delete-char
2686 (defun kill-forward-chars (arg)
2687 (if (listp arg) (setq arg (car arg)))
2688 (if (eq arg '-) (setq arg -1))
2689 (kill-region (point) (forward-point arg)))
2691 ;; Internal subroutine of backward-delete-char
2692 (defun kill-backward-chars (arg)
2693 (if (listp arg) (setq arg (car arg)))
2694 (if (eq arg '-) (setq arg -1))
2695 (kill-region (point) (forward-point (- arg))))
2697 (defcustom backward-delete-char-untabify-method 'untabify
2698 "*The method for untabifying when deleting backward.
2699 Can be `untabify' -- turn a tab to many spaces, then delete one space;
2700 `hungry' -- delete all whitespace, both tabs and spaces;
2701 `all' -- delete all whitespace, including tabs, spaces and newlines;
2702 nil -- just delete one character."
2703 :type '(choice (const untabify) (const hungry) (const all) (const nil))
2704 :version "20.3"
2705 :group 'killing)
2707 (defun backward-delete-char-untabify (arg &optional killp)
2708 "Delete characters backward, changing tabs into spaces.
2709 The exact behavior depends on `backward-delete-char-untabify-method'.
2710 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
2711 Interactively, ARG is the prefix arg (default 1)
2712 and KILLP is t if a prefix arg was specified."
2714 (when (eq backward-delete-char-untabify-method 'untabify)
2715 (let ((count arg))
2716 (save-excursion
2717 (while (and (> count 0) (not (bobp)))
2719 (let ((col (current-column)))
2720 (forward-char -1)
2721 (setq col (- col (current-column)))
2722 (insert-char ?\s col)
2723 (delete-char 1)))
2724 (forward-char -1)
2725 (setq count (1- count))))))
2726 (delete-backward-char
2728 ((eq backward-delete-char-untabify-method 'all)
2730 (if skip
2731 (let ((wh (- (point) (save-excursion (skip-chars-backward skip)
2732 (point)))))
2733 (+ arg (if (zerop wh) 0 (1- wh))))
2734 arg))
2735 killp))
2737 (defun zap-to-char (arg char)
2738 "Kill up to and including ARG'th occurrence of CHAR.
2739 Case is ignored if `case-fold-search' is non-nil in the current buffer.
2740 Goes backward if ARG is negative; error if CHAR not found."
2742 (kill-region (point) (progn
2743 (search-forward (char-to-string char) nil nil arg)
2744 ; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
2745 (point))))
2747 ;; kill-line and its subroutines.
2749 (defcustom kill-whole-line nil
2750 "*If non-nil, `kill-line' with no arg at beg of line kills the whole line."
2751 :type 'boolean
2752 :group 'killing)
2754 (defun kill-line (&optional arg)
2755 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
2756 With prefix argument, kill that many lines from point.
2757 Negative arguments kill lines backward.
2758 With zero argument, kills the text before point on the current line.
2761 a number counts as a prefix arg.
2763 To kill a whole line, when point is not at the beginning, type \
2766 If `kill-whole-line' is non-nil, then this command kills the whole line
2767 including its terminating newline, when used at the beginning of a line
2768 with no argument. As a consequence, you can always kill a whole line
2771 If you want to append the killed line to the last killed text,
2774 If the buffer is read-only, Emacs will beep and refrain from deleting
2775 the line, but put the line in the kill ring anyway. This means that
2776 you can use this command to copy text from a read-only buffer.
2777 \(If the variable `kill-read-only-ok' is non-nil, then this won't
2778 even beep.)"
2779 (interactive "P")
2780 (kill-region (point)
2781 ;; It is better to move point to the other end of the kill
2782 ;; before killing. That way, in a read-only buffer, point
2783 ;; moves across the text that is copied to the kill ring.
2784 ;; The choice has no effect on undo now that undo records
2785 ;; the value of point from before the command was run.
2786 (progn
2787 (if arg
2788 (forward-visible-line (prefix-numeric-value arg))
2789 (if (eobp)
2790 (signal 'end-of-buffer nil))
2791 (let ((end
2792 (save-excursion
2793 (end-of-visible-line) (point))))
2794 (if (or (save-excursion
2795 ;; If trailing whitespace is visible,
2796 ;; don't treat it as nothing.
2797 (unless show-trailing-whitespace
2799 (= (point) end))
2800 (and kill-whole-line (bolp)))
2801 (forward-visible-line 1)
2802 (goto-char end))))
2803 (point))))
2805 (defun kill-whole-line (&optional arg)
2806 "Kill current line.
2807 With prefix arg, kill that many lines starting from the current line.
2808 If arg is negative, kill backward. Also kill the preceding newline.
2810 If arg is zero, kill current line but exclude the trailing newline."
2811 (interactive "p")
2812 (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
2813 (signal 'end-of-buffer nil))
2814 (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
2815 (signal 'beginning-of-buffer nil))
2816 (unless (eq last-command 'kill-region)
2817 (kill-new "")
2818 (setq last-command 'kill-region))
2819 (cond ((zerop arg)
2820 ;; We need to kill in two steps, because the previous command
2821 ;; could have been a kill command, in which case the text
2822 ;; before point needs to be prepended to the current kill
2823 ;; ring entry and the text after point appended. Also, we
2824 ;; need to use save-excursion to avoid copying the same text
2825 ;; twice to the kill ring in read-only buffers.
2826 (save-excursion
2827 (kill-region (point) (progn (forward-visible-line 0) (point))))
2828 (kill-region (point) (progn (end-of-visible-line) (point))))
2829 ((< arg 0)
2830 (save-excursion
2831 (kill-region (point) (progn (end-of-visible-line) (point))))
2832 (kill-region (point)
2833 (progn (forward-visible-line (1+ arg))
2834 (unless (bobp) (backward-char))
2835 (point))))
2836 (t
2837 (save-excursion
2838 (kill-region (point) (progn (forward-visible-line 0) (point))))
2839 (kill-region (point)
2840 (progn (forward-visible-line arg) (point))))))
2842 (defun forward-visible-line (arg)
2843 "Move forward by ARG lines, ignoring currently invisible newlines only.
2844 If ARG is negative, move backward -ARG lines.
2845 If ARG is zero, move to the beginning of the current line."
2846 (condition-case nil
2847 (if (> arg 0)
2848 (progn
2849 (while (> arg 0)
2850 (or (zerop (forward-line 1))
2851 (signal 'end-of-buffer nil))
2852 ;; If the newline we just skipped is invisible,
2853 ;; don't count it.
2854 (let ((prop
2855 (get-char-property (1- (point)) 'invisible)))
2856 (if (if (eq buffer-invisibility-spec t)
2857 prop
2858 (or (memq prop buffer-invisibility-spec)
2859 (assq prop buffer-invisibility-spec)))
2860 (setq arg (1+ arg))))
2861 (setq arg (1- arg)))
2862 ;; If invisible text follows, and it is a number of complete lines,
2863 ;; skip it.
2864 (let ((opoint (point)))
2865 (while (and (not (eobp))
2866 (let ((prop
2867 (get-char-property (point) 'invisible)))
2868 (if (eq buffer-invisibility-spec t)
2869 prop
2870 (or (memq prop buffer-invisibility-spec)
2871 (assq prop buffer-invisibility-spec)))))
2872 (goto-char
2873 (if (get-text-property (point) 'invisible)
2874 (or (next-single-property-change (point) 'invisible)
2875 (point-max))
2876 (next-overlay-change (point)))))
2877 (unless (bolp)
2878 (goto-char opoint))))
2879 (let ((first t))
2880 (while (or first (<= arg 0))
2881 (if first
2882 (beginning-of-line)
2883 (or (zerop (forward-line -1))
2884 (signal 'beginning-of-buffer nil)))
2885 ;; If the newline we just moved to is invisible,
2886 ;; don't count it.
2887 (unless (bobp)
2888 (let ((prop
2889 (get-char-property (1- (point)) 'invisible)))
2890 (unless (if (eq buffer-invisibility-spec t)
2891 prop
2892 (or (memq prop buffer-invisibility-spec)
2893 (assq prop buffer-invisibility-spec)))
2894 (setq arg (1+ arg)))))
2895 (setq first nil))
2896 ;; If invisible text follows, and it is a number of complete lines,
2897 ;; skip it.
2898 (let ((opoint (point)))
2899 (while (and (not (bobp))
2900 (let ((prop
2901 (get-char-property (1- (point)) 'invisible)))
2902 (if (eq buffer-invisibility-spec t)
2903 prop
2904 (or (memq prop buffer-invisibility-spec)
2905 (assq prop buffer-invisibility-spec)))))
2906 (goto-char
2907 (if (get-text-property (1- (point)) 'invisible)
2908 (or (previous-single-property-change (point) 'invisible)
2909 (point-min))
2910 (previous-overlay-change (point)))))
2911 (unless (bolp)
2912 (goto-char opoint)))))
2913 ((beginning-of-buffer end-of-buffer)
2914 nil)))
2916 (defun end-of-visible-line ()
2917 "Move to end of current visible line."
2918 (end-of-line)
2919 ;; If the following character is currently invisible,
2920 ;; skip all characters with that same `invisible' property value,
2921 ;; then find the next newline.
2922 (while (and (not (eobp))
2923 (save-excursion
2925 (let ((prop
2926 (get-char-property (point) 'invisible)))
2927 (if (eq buffer-invisibility-spec t)
2928 prop
2929 (or (memq prop buffer-invisibility-spec)
2930 (assq prop buffer-invisibility-spec))))))
2932 (if (get-text-property (point) 'invisible)
2933 (goto-char (next-single-property-change (point) 'invisible))
2934 (goto-char (next-overlay-change (point))))
2935 (end-of-line)))
2936 \f
2937 (defun insert-buffer (buffer)
2938 "Insert after point the contents of BUFFER.
2939 Puts mark after the inserted text.
2940 BUFFER may be a buffer or a buffer name.
2942 This function is meant for the user to run interactively.
2943 Don't call it from programs: use `insert-buffer-substring' instead!"
2944 (interactive
2945 (list
2946 (progn
2947 (barf-if-buffer-read-only)
2948 (read-buffer "Insert buffer: "
2949 (if (eq (selected-window) (next-window (selected-window)))
2950 (other-buffer (current-buffer))
2951 (window-buffer (next-window (selected-window))))
2952 t))))
2953 (push-mark
2954 (save-excursion
2955 (insert-buffer-substring (get-buffer buffer))
2956 (point)))
2957 nil)
2959 (defun append-to-buffer (buffer start end)
2960 "Append to specified buffer the text of the region.
2961 It is inserted into that buffer before its point.
2963 When calling from a program, give three arguments:
2964 BUFFER (or buffer name), START and END.
2965 START and END specify the portion of the current buffer to be copied."
2966 (interactive
2967 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
2968 (region-beginning) (region-end)))
2969 (let ((oldbuf (current-buffer)))
2970 (save-excursion
2971 (let* ((append-to (get-buffer-create buffer))
2972 (windows (get-buffer-window-list append-to t t))
2973 point)
2974 (set-buffer append-to)
2975 (setq point (point))
2976 (barf-if-buffer-read-only)
2977 (insert-buffer-substring oldbuf start end)
2978 (dolist (window windows)
2979 (when (= (window-point window) point)
2980 (set-window-point window (point))))))))
2982 (defun prepend-to-buffer (buffer start end)
2983 "Prepend to specified buffer the text of the region.
2984 It is inserted into that buffer after its point.
2986 When calling from a program, give three arguments:
2987 BUFFER (or buffer name), START and END.
2988 START and END specify the portion of the current buffer to be copied."
2990 (let ((oldbuf (current-buffer)))
2991 (save-excursion
2992 (set-buffer (get-buffer-create buffer))
2993 (barf-if-buffer-read-only)
2994 (save-excursion
2995 (insert-buffer-substring oldbuf start end)))))
2997 (defun copy-to-buffer (buffer start end)
2998 "Copy to specified buffer the text of the region.
2999 It is inserted into that buffer, replacing existing text there.
3001 When calling from a program, give three arguments:
3002 BUFFER (or buffer name), START and END.
3003 START and END specify the portion of the current buffer to be copied."
3005 (let ((oldbuf (current-buffer)))
3006 (with-current-buffer (get-buffer-create buffer)
3007 (barf-if-buffer-read-only)
3008 (erase-buffer)
3009 (save-excursion
3010 (insert-buffer-substring oldbuf start end)))))
3011 \f
3012 (put 'mark-inactive 'error-conditions '(mark-inactive error))
3013 (put 'mark-inactive 'error-message "The mark is not active now")
3015 (defvar activate-mark-hook nil
3016 "Hook run when the mark becomes active.
3017 It is also run at the end of a command, if the mark is active and
3018 it is possible that the region may have changed")
3020 (defvar deactivate-mark-hook nil
3021 "Hook run when the mark becomes inactive.")
3023 (defun mark (&optional force)
3024 "Return this buffer's mark value as integer; error if mark inactive.
3025 If optional argument FORCE is non-nil, access the mark value
3026 even if the mark is not currently active, and return nil
3027 if there is no mark at all.
3029 If you are using this in an editing command, you are most likely making
3030 a mistake; see the documentation of `set-mark'."
3031 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
3032 (marker-position (mark-marker))
3033 (signal 'mark-inactive nil)))
3035 ;; Many places set mark-active directly, and several of them failed to also
3036 ;; run deactivate-mark-hook. This shorthand should simplify.
3037 (defsubst deactivate-mark ()
3038 "Deactivate the mark by setting `mark-active' to nil.
3039 \(That makes a difference only in Transient Mark mode.)
3040 Also runs the hook `deactivate-mark-hook'."
3041 (cond
3042 ((eq transient-mark-mode 'lambda)
3043 (setq transient-mark-mode nil))
3044 (transient-mark-mode
3045 (setq mark-active nil)
3046 (run-hooks 'deactivate-mark-hook))))
3048 (defun set-mark (pos)
3049 "Set this buffer's mark to POS. Don't use this function!
3050 That is to say, don't use this function unless you want
3051 the user to see that the mark has moved, and you want the previous
3052 mark position to be lost.
3054 Normally, when a new mark is set, the old one should go on the stack.
3055 This is why most applications should use `push-mark', not `set-mark'.
3057 Novice Emacs Lisp programmers often try to use the mark for the wrong
3058 purposes. The mark saves a location for the user's convenience.
3059 Most editing commands should not alter the mark.
3060 To remember a location for internal use in the Lisp program,
3061 store it in a Lisp variable. Example:
3063 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
3065 (if pos
3066 (progn
3067 (setq mark-active t)
3068 (run-hooks 'activate-mark-hook)
3069 (set-marker (mark-marker) pos (current-buffer)))
3070 ;; Normally we never clear mark-active except in Transient Mark mode.
3071 ;; But when we actually clear out the mark value too,
3072 ;; we must clear mark-active in any mode.
3073 (setq mark-active nil)
3074 (run-hooks 'deactivate-mark-hook)
3075 (set-marker (mark-marker) nil)))
3077 (defvar mark-ring nil
3078 "The list of former marks of the current buffer, most recent first.")
3079 (make-variable-buffer-local 'mark-ring)
3080 (put 'mark-ring 'permanent-local t)
3082 (defcustom mark-ring-max 16
3083 "*Maximum size of mark ring. Start discarding off end if gets this big."
3084 :type 'integer
3085 :group 'editing-basics)
3087 (defvar global-mark-ring nil
3088 "The list of saved global marks, most recent first.")
3090 (defcustom global-mark-ring-max 16
3091 "*Maximum size of global mark ring. \
3092 Start discarding off end if gets this big."
3093 :type 'integer
3094 :group 'editing-basics)
3096 (defun pop-to-mark-command ()
3097 "Jump to mark, and pop a new position for mark off the ring
3098 \(does not affect global mark ring\)."
3099 (interactive)
3100 (if (null (mark t))
3101 (error "No mark set in this buffer")
3102 (goto-char (mark t))
3103 (pop-mark)))
3105 (defun push-mark-command (arg &optional nomsg)
3106 "Set mark at where point is.
3107 If no prefix arg and mark is already set there, just activate it.
3108 Display `Mark set' unless the optional second arg NOMSG is non-nil."
3109 (interactive "P")
3110 (let ((mark (marker-position (mark-marker))))
3111 (if (or arg (null mark) (/= mark (point)))
3112 (push-mark nil nomsg t)
3113 (setq mark-active t)
3114 (run-hooks 'activate-mark-hook)
3115 (unless nomsg
3116 (message "Mark activated")))))
3118 (defcustom set-mark-command-repeat-pop nil
3121 will pop twice."
3122 :type 'boolean
3123 :group 'editing)
3125 (defun set-mark-command (arg)
3126 "Set mark at where point is, or jump to mark.
3127 With no prefix argument, set mark, and push old mark position on local
3128 mark ring; also push mark on global mark ring if last mark was set in
3129 another buffer. Immediately repeating the command activates
3130 `transient-mark-mode' temporarily.
3133 jump to mark, and pop a new position
3134 for mark off the local mark ring \(this does not affect the global
3136 mark ring \(see `pop-global-mark'\).
3139 the next position off the local (or global) mark ring.
3143 set mark where point is.
3145 Novice Emacs Lisp programmers often try to use the mark for the wrong
3146 purposes. See the documentation of `set-mark' for more information."
3147 (interactive "P")
3148 (if (eq transient-mark-mode 'lambda)
3149 (setq transient-mark-mode nil))
3150 (cond
3151 ((and (consp arg) (> (prefix-numeric-value arg) 4))
3152 (push-mark-command nil))
3153 ((not (eq this-command 'set-mark-command))
3154 (if arg
3155 (pop-to-mark-command)
3156 (push-mark-command t)))
3157 ((and set-mark-command-repeat-pop
3158 (eq last-command 'pop-to-mark-command))
3159 (setq this-command 'pop-to-mark-command)
3160 (pop-to-mark-command))
3161 ((and set-mark-command-repeat-pop
3162 (eq last-command 'pop-global-mark)
3163 (not arg))
3164 (setq this-command 'pop-global-mark)
3165 (pop-global-mark))
3166 (arg
3167 (setq this-command 'pop-to-mark-command)
3168 (pop-to-mark-command))
3169 ((and (eq last-command 'set-mark-command)
3170 mark-active (null transient-mark-mode))
3171 (setq transient-mark-mode 'lambda)
3172 (message "Transient-mark-mode temporarily enabled"))
3173 (t
3174 (push-mark-command nil))))
3176 (defun push-mark (&optional location nomsg activate)
3177 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
3178 If the last global mark pushed was not in the current buffer,
3179 also push LOCATION on the global mark ring.
3180 Display `Mark set' unless the optional second arg NOMSG is non-nil.
3181 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil.
3183 Novice Emacs Lisp programmers often try to use the mark for the wrong
3184 purposes. See the documentation of `set-mark' for more information.
3186 In Transient Mark mode, this does not activate the mark."
3187 (unless (null (mark t))
3188 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
3189 (when (> (length mark-ring) mark-ring-max)
3190 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
3191 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))
3192 (set-marker (mark-marker) (or location (point)) (current-buffer))
3193 ;; Now push the mark on the global mark ring.
3194 (if (and global-mark-ring
3195 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
3196 ;; The last global mark pushed was in this same buffer.
3197 ;; Don't push another one.
3198 nil
3199 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
3200 (when (> (length global-mark-ring) global-mark-ring-max)
3201 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring)) nil)
3202 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))
3203 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
3204 (message "Mark set"))
3205 (if (or activate (not transient-mark-mode))
3206 (set-mark (mark t)))
3207 nil)
3209 (defun pop-mark ()
3210 "Pop off mark ring into the buffer's actual mark.
3211 Does not set point. Does nothing if mark ring is empty."
3212 (when mark-ring
3213 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
3214 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
3215 (move-marker (car mark-ring) nil)
3216 (if (null (mark t)) (ding))
3217 (setq mark-ring (cdr mark-ring)))
3218 (deactivate-mark))
3220 (defalias 'exchange-dot-and-mark 'exchange-point-and-mark)
3221 (defun exchange-point-and-mark (&optional arg)
3222 "Put the mark where point is now, and point where the mark is now.
3223 This command works even when the mark is not active,
3224 and it reactivates the mark.
3225 With prefix arg, `transient-mark-mode' is enabled temporarily."
3226 (interactive "P")
3227 (if arg
3228 (if mark-active
3229 (if (null transient-mark-mode)
3230 (setq transient-mark-mode 'lambda))
3231 (setq arg nil)))
3232 (unless arg
3233 (let ((omark (mark t)))
3234 (if (null omark)
3235 (error "No mark set in this buffer"))
3236 (set-mark (point))
3237 (goto-char omark)
3238 nil)))
3240 (define-minor-mode transient-mark-mode
3241 "Toggle Transient Mark mode.
3242 With arg, turn Transient Mark mode on if arg is positive, off otherwise.
3244 In Transient Mark mode, when the mark is active, the region is highlighted.
3246 So do certain other operations that set the mark
3247 but whose main purpose is something else--for example,
3253 Many commands change their behavior when Transient Mark mode is in effect
3254 and the mark is active, by acting on the region instead of their usual
3255 default part of the buffer's text. Examples of such commands include
3260 commands which are sensitive to the Transient Mark mode."
3261 :global t :group 'editing-basics :require nil)
3263 (defvar widen-automatically t
3264 "Non-nil means it is ok for commands to call `widen' when they want to.
3265 Some commands will do this in order to go to positions outside
3266 the current accessible part of the buffer.
3268 If `widen-automatically' is nil, these commands will do something else
3269 as a fallback, and won't change the buffer bounds.")
3271 (defun pop-global-mark ()
3272 "Pop off global mark ring and jump to the top location."
3273 (interactive)
3274 ;; Pop entries which refer to non-existent buffers.
3275 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
3276 (setq global-mark-ring (cdr global-mark-ring)))
3277 (or global-mark-ring
3278 (error "No global mark set"))
3279 (let* ((marker (car global-mark-ring))
3280 (buffer (marker-buffer marker))
3281 (position (marker-position marker)))
3282 (setq global-mark-ring (nconc (cdr global-mark-ring)
3283 (list (car global-mark-ring))))
3284 (set-buffer buffer)
3285 (or (and (>= position (point-min))
3286 (<= position (point-max)))
3287 (if widen-automatically
3288 (widen)
3289 (error "Global mark position is outside accessible part of buffer")))
3290 (goto-char position)
3291 (switch-to-buffer buffer)))
3292 \f
3293 (defcustom next-line-add-newlines nil
3294 "*If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
3295 :type 'boolean
3296 :version "21.1"
3297 :group 'editing-basics)
3299 (defun next-line (&optional arg try-vscroll)
3300 "Move cursor vertically down ARG lines.
3301 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
3302 If there is no character in the target line exactly under the current column,
3303 the cursor is positioned after the character in that line which spans this
3304 column, or at the end of the line if it is not long enough.
3305 If there is no line in the buffer after this one, behavior depends on the
3306 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
3307 to create a line, and moves the cursor to that line. Otherwise it moves the
3308 cursor to the end of the buffer.
3311 a semipermanent goal column for this command.
3312 Then instead of trying to move exactly vertically (or as close as possible),
3313 this command moves to the specified goal column (or as close as possible).
3314 The goal column is stored in the variable `goal-column', which is nil
3315 when there is no goal column.
3317 If you are thinking of using this in a Lisp program, consider
3318 using `forward-line' instead. It is usually easier to use
3319 and more reliable (no dependence on goal column, etc.)."
3321 (or arg (setq arg 1))
3322 (if (and next-line-add-newlines (= arg 1))
3323 (if (save-excursion (end-of-line) (eobp))
3324 ;; When adding a newline, don't expand an abbrev.
3325 (let ((abbrev-mode nil))
3326 (end-of-line)
3328 (line-move arg nil nil try-vscroll))
3329 (if (interactive-p)
3330 (condition-case nil
3331 (line-move arg nil nil try-vscroll)
3332 ((beginning-of-buffer end-of-buffer) (ding)))
3333 (line-move arg nil nil try-vscroll)))
3334 nil)
3336 (defun previous-line (&optional arg try-vscroll)
3337 "Move cursor vertically up ARG lines.
3338 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
3339 If there is no character in the target line exactly over the current column,
3340 the cursor is positioned after the character in that line which spans this
3341 column, or at the end of the line if it is not long enough.
3344 a semipermanent goal column for this command.
3345 Then instead of trying to move exactly vertically (or as close as possible),
3346 this command moves to the specified goal column (or as close as possible).
3347 The goal column is stored in the variable `goal-column', which is nil
3348 when there is no goal column.
3350 If you are thinking of using this in a Lisp program, consider using
3351 `forward-line' with a negative argument instead. It is usually easier
3352 to use and more reliable (no dependence on goal column, etc.)."
3354 (or arg (setq arg 1))
3355 (if (interactive-p)
3356 (condition-case nil
3357 (line-move (- arg) nil nil try-vscroll)
3358 ((beginning-of-buffer end-of-buffer) (ding)))
3359 (line-move (- arg) nil nil try-vscroll))
3360 nil)
3362 (defcustom track-eol nil
3363 "*Non-nil means vertical motion starting at end of line keeps to ends of lines.
3364 This means moving to the end of each line moved onto.
3365 The beginning of a blank line does not count as the end of a line."
3366 :type 'boolean
3367 :group 'editing-basics)
3369 (defcustom goal-column nil
3371 :type '(choice integer
3372 (const :tag "None" nil))
3373 :group 'editing-basics)
3374 (make-variable-buffer-local 'goal-column)
3376 (defvar temporary-goal-column 0
3377 "Current goal column for vertical motion.
3378 It is the column where point was
3379 at the start of current run of vertical motion commands.
3380 When the `track-eol' feature is doing its job, the value is 9999.")
3382 (defcustom line-move-ignore-invisible t
3384 Outline mode sets this."
3385 :type 'boolean
3386 :group 'editing-basics)
3388 (defun line-move-invisible-p (pos)
3389 "Return non-nil if the character after POS is currently invisible."
3390 (let ((prop
3391 (get-char-property pos 'invisible)))
3392 (if (eq buffer-invisibility-spec t)
3393 prop
3394 (or (memq prop buffer-invisibility-spec)
3395 (assq prop buffer-invisibility-spec)))))
3397 ;; This is like line-move-1 except that it also performs
3398 ;; vertical scrolling of tall images if appropriate.
3399 ;; That is not really a clean thing to do, since it mixes
3400 ;; scrolling with cursor motion. But so far we don't have
3401 ;; a cleaner solution to the problem of making C-n do something
3402 ;; useful given a tall image.
3403 (defun line-move (arg &optional noerror to-end try-vscroll)
3404 (if (and auto-window-vscroll try-vscroll
3405 ;; But don't vscroll in a keyboard macro.
3406 (not defining-kbd-macro)
3407 (not executing-kbd-macro))
3408 (let ((forward (> arg 0))
3409 (part (nth 2 (pos-visible-in-window-p (point) nil t))))
3410 (if (and (consp part)
3411 (> (if forward (cdr part) (car part)) 0))
3412 (set-window-vscroll nil
3413 (if forward
3414 (+ (window-vscroll nil t)
3415 (min (cdr part)
3416 (* (frame-char-height) arg)))
3417 (max 0
3418 (- (window-vscroll nil t)
3419 (min (car part)
3420 (* (frame-char-height) (- arg))))))
3421 t)
3422 (set-window-vscroll nil 0)
3423 (when (line-move-1 arg noerror to-end)
3424 (when (not forward)
3425 ;; Update display before calling pos-visible-in-window-p,
3426 ;; because it depends on window-start being up-to-date.
3427 (sit-for 0)
3428 ;; If the current line is partly hidden at the bottom,
3429 ;; scroll it partially up so as to unhide the bottom.
3430 (if (and (setq part (nth 2 (pos-visible-in-window-p
3431 (line-beginning-position) nil t)))
3432 (> (cdr part) 0))
3433 (set-window-vscroll nil (cdr part) t)))
3434 t)))
3435 (line-move-1 arg noerror to-end)))
3437 ;; This is the guts of next-line and previous-line.
3438 ;; Arg says how many lines to move.
3439 ;; The value is t if we can move the specified number of lines.
3440 (defun line-move-1 (arg &optional noerror to-end)
3441 ;; Don't run any point-motion hooks, and disregard intangibility,
3442 ;; for intermediate positions.
3443 (let ((inhibit-point-motion-hooks t)
3444 (opoint (point))
3445 (forward (> arg 0)))
3446 (unwind-protect
3447 (progn
3448 (if (not (memq last-command '(next-line previous-line)))
3449 (setq temporary-goal-column
3450 (if (and track-eol (eolp)
3451 ;; Don't count beg of empty line as end of line
3452 ;; unless we just did explicit end-of-line.
3453 (or (not (bolp)) (eq last-command 'end-of-line)))
3454 9999
3455 (current-column))))
3457 (if (and (not (integerp selective-display))
3458 (not line-move-ignore-invisible))
3459 ;; Use just newline characters.
3460 ;; Set ARG to 0 if we move as many lines as requested.
3461 (or (if (> arg 0)
3462 (progn (if (> arg 1) (forward-line (1- arg)))
3463 ;; This way of moving forward ARG lines
3464 ;; verifies that we have a newline after the last one.
3465 ;; It doesn't get confused by intangible text.
3466 (end-of-line)
3467 (if (zerop (forward-line 1))
3468 (setq arg 0)))
3469 (and (zerop (forward-line arg))
3470 (bolp)
3471 (setq arg 0)))
3472 (unless noerror
3473 (signal (if (< arg 0)
3474 'beginning-of-buffer
3475 'end-of-buffer)
3476 nil)))
3477 ;; Move by arg lines, but ignore invisible ones.
3478 (let (done)
3479 (while (and (> arg 0) (not done))
3480 ;; If the following character is currently invisible,
3481 ;; skip all characters with that same `invisible' property value.
3482 (while (and (not (eobp)) (line-move-invisible-p (point)))
3483 (goto-char (next-char-property-change (point))))
3484 ;; Now move a line.
3485 (end-of-line)
3486 ;; If there's no invisibility here, move over the newline.
3487 (cond
3488 ((eobp)
3489 (if (not noerror)
3490 (signal 'end-of-buffer nil)
3491 (setq done t)))
3492 ((and (> arg 1) ;; Use vertical-motion for last move
3493 (not (integerp selective-display))
3494 (not (line-move-invisible-p (point))))
3495 ;; We avoid vertical-motion when possible
3496 ;; because that has to fontify.
3497 (forward-line 1))
3498 ;; Otherwise move a more sophisticated way.
3499 ((zerop (vertical-motion 1))
3500 (if (not noerror)
3501 (signal 'end-of-buffer nil)
3502 (setq done t))))
3503 (unless done
3504 (setq arg (1- arg))))
3505 ;; The logic of this is the same as the loop above,
3506 ;; it just goes in the other direction.
3507 (while (and (< arg 0) (not done))
3508 (beginning-of-line)
3509 (cond
3510 ((bobp)
3511 (if (not noerror)
3512 (signal 'beginning-of-buffer nil)
3513 (setq done t)))
3514 ((and (< arg -1) ;; Use vertical-motion for last move
3515 (not (integerp selective-display))
3516 (not (line-move-invisible-p (1- (point)))))
3517 (forward-line -1))
3518 ((zerop (vertical-motion -1))
3519 (if (not noerror)
3520 (signal 'beginning-of-buffer nil)
3521 (setq done t))))
3522 (unless done
3523 (setq arg (1+ arg))
3524 (while (and ;; Don't move over previous invis lines
3525 ;; if our target is the middle of this line.
3526 (or (zerop (or goal-column temporary-goal-column))
3527 (< arg 0))
3528 (not (bobp)) (line-move-invisible-p (1- (point))))
3529 (goto-char (previous-char-property-change (point))))))))
3530 ;; This is the value the function returns.
3531 (= arg 0))
3533 (cond ((> arg 0)
3534 ;; If we did not move down as far as desired,
3535 ;; at least go to end of line.
3536 (end-of-line))
3537 ((< arg 0)
3538 ;; If we did not move up as far as desired,
3539 ;; at least go to beginning of line.
3540 (beginning-of-line))
3541 (t
3542 (line-move-finish (or goal-column temporary-goal-column)
3543 opoint forward))))))
3545 (defun line-move-finish (column opoint forward)
3546 (let ((repeat t))
3547 (while repeat
3548 ;; Set REPEAT to t to repeat the whole thing.
3549 (setq repeat nil)
3551 (let (new
3552 (line-beg (save-excursion (beginning-of-line) (point)))
3553 (line-end
3554 ;; Compute the end of the line
3555 ;; ignoring effectively invisible newlines.
3556 (save-excursion
3557 ;; Like end-of-line but ignores fields.
3559 (while (and (not (eobp)) (line-move-invisible-p (point)))
3560 (goto-char (next-char-property-change (point)))
3562 (point))))
3564 ;; Move to the desired column.
3565 (line-move-to-column column)
3566 (setq new (point))
3568 ;; Process intangibility within a line.
3569 ;; Move to the chosen destination position from above,
3570 ;; with intangibility processing enabled.
3572 (goto-char (point-min))
3573 (let ((inhibit-point-motion-hooks nil))
3574 (goto-char new)
3576 ;; If intangibility moves us to a different (later) place
3577 ;; in the same line, use that as the destination.
3578 (if (<= (point) line-end)
3579 (setq new (point))
3580 ;; If that position is "too late",
3581 ;; try the previous allowable position.
3582 ;; See if it is ok.
3583 (backward-char)
3584 (if (if forward
3585 ;; If going forward, don't accept the previous
3586 ;; allowable position if it is before the target line.
3587 (< line-beg (point))
3588 ;; If going backward, don't accept the previous
3589 ;; allowable position if it is still after the target line.
3590 (<= (point) line-end))
3591 (setq new (point))
3592 ;; As a last resort, use the end of the line.
3593 (setq new line-end))))
3595 ;; Now move to the updated destination, processing fields
3596 ;; as well as intangibility.
3597 (goto-char opoint)
3598 (let ((inhibit-point-motion-hooks nil))
3599 (goto-char
3600 (constrain-to-field new opoint nil t
3601 'inhibit-line-move-field-capture)))
3603 ;; If all this moved us to a different line,
3604 ;; retry everything within that new line.
3605 (when (or (< (point) line-beg) (> (point) line-end))
3606 ;; Repeat the intangibility and field processing.
3607 (setq repeat t))))))
3609 (defun line-move-to-column (col)
3610 "Try to find column COL, considering invisibility.
3611 This function works only in certain cases,
3612 because what we really need is for `move-to-column'
3613 and `current-column' to be able to ignore invisible text."
3614 (if (zerop col)
3615 (beginning-of-line)
3616 (move-to-column col))
3618 (when (and line-move-ignore-invisible
3619 (not (bolp)) (line-move-invisible-p (1- (point))))
3620 (let ((normal-location (point))
3621 (normal-column (current-column)))
3622 ;; If the following character is currently invisible,
3623 ;; skip all characters with that same `invisible' property value.
3624 (while (and (not (eobp))
3625 (line-move-invisible-p (point)))
3626 (goto-char (next-char-property-change (point))))
3627 ;; Have we advanced to a larger column position?
3628 (if (> (current-column) normal-column)
3629 ;; We have made some progress towards the desired column.
3630 ;; See if we can make any further progress.
3631 (line-move-to-column (+ (current-column) (- col normal-column)))
3632 ;; Otherwise, go to the place we originally found
3633 ;; and move back over invisible text.
3634 ;; that will get us to the same place on the screen
3635 ;; but with a more reasonable buffer position.
3636 (goto-char normal-location)
3637 (let ((line-beg (save-excursion (beginning-of-line) (point))))
3638 (while (and (not (bolp)) (line-move-invisible-p (1- (point))))
3639 (goto-char (previous-char-property-change (point) line-beg))))))))
3641 (defun move-end-of-line (arg)
3642 "Move point to end of current line.
3643 With argument ARG not nil or 1, move forward ARG - 1 lines first.
3644 If point reaches the beginning or end of buffer, it stops there.
3645 To ignore intangibility, bind `inhibit-point-motion-hooks' to t.
3647 This command does not move point across a field boundary unless doing so
3648 would move beyond there to a different line; if ARG is nil or 1, and
3649 point starts at a field boundary, point does not move. To ignore field
3650 boundaries bind `inhibit-field-text-motion' to t."
3651 (interactive "p")
3652 (or arg (setq arg 1))
3653 (let (done)
3654 (while (not done)
3655 (let ((newpos
3656 (save-excursion
3657 (let ((goal-column 0))
3658 (and (line-move arg t)
3659 (not (bobp))
3660 (progn
3661 (while (and (not (bobp)) (line-move-invisible-p (1- (point))))
3662 (goto-char (previous-char-property-change (point))))
3663 (backward-char 1)))
3664 (point)))))
3665 (goto-char newpos)
3666 (if (and (> (point) newpos)
3668 (backward-char 1)
3669 (if (and (> (point) newpos) (not (eobp))
3671 ;; If we skipped something intangible
3672 ;; and now we're not really at eol,
3673 ;; keep going.
3674 (setq arg 1)
3675 (setq done t)))))))
3677 (defun move-beginning-of-line (arg)
3678 "Move point to beginning of current display line.
3679 With argument ARG not nil or 1, move forward ARG - 1 lines first.
3680 If point reaches the beginning or end of buffer, it stops there.
3681 To ignore intangibility, bind `inhibit-point-motion-hooks' to t.
3683 This command does not move point across a field boundary unless doing so
3684 would move beyond there to a different line; if ARG is nil or 1, and
3685 point starts at a field boundary, point does not move. To ignore field
3686 boundaries bind `inhibit-field-text-motion' to t."
3687 (interactive "p")
3688 (or arg (setq arg 1))
3689 (if (/= arg 1)
3690 (line-move (1- arg) t))
3691 (beginning-of-line 1)
3692 (let ((orig (point)))
3693 (vertical-motion 0)
3694 (if (/= orig (point))
3695 (goto-char (constrain-to-field (point) orig (/= arg 1) t nil)))))
3698 ;;; Many people have said they rarely use this feature, and often type
3699 ;;; it by accident. Maybe it shouldn't even be on a key.
3700 (put 'set-goal-column 'disabled t)
3702 (defun set-goal-column (arg)
3704 Those commands will move to this position in the line moved to
3705 rather than trying to keep the same horizontal position.
3706 With a non-nil argument, clears out the goal column
3708 The goal column is stored in the variable `goal-column'."
3709 (interactive "P")
3710 (if arg
3711 (progn
3712 (setq goal-column nil)
3713 (message "No goal column"))
3714 (setq goal-column (current-column))
3715 ;; The older method below can be erroneous if `set-goal-column' is bound
3716 ;; to a sequence containing %
3717 ;;(message (substitute-command-keys
3719 ;;goal-column)
3720 (message "%s"
3721 (concat
3722 (format "Goal column %d " goal-column)
3723 (substitute-command-keys
3726 )
3727 nil)
3728 \f
3730 (defun scroll-other-window-down (lines)
3732 For more details, see the documentation for `scroll-other-window'."
3733 (interactive "P")
3734 (scroll-other-window
3735 ;; Just invert the argument's meaning.
3736 ;; We can do that without knowing which window it will be.
3737 (if (eq lines '-) nil
3738 (if (null lines) '-
3739 (- (prefix-numeric-value lines))))))
3741 (defun beginning-of-buffer-other-window (arg)
3742 "Move point to the beginning of the buffer in the other window.
3743 Leave mark at previous position.
3744 With arg N, put point N/10 of the way from the true beginning."
3745 (interactive "P")
3746 (let ((orig-window (selected-window))
3747 (window (other-window-for-scrolling)))
3748 ;; We use unwind-protect rather than save-window-excursion
3749 ;; because the latter would preserve the things we want to change.
3750 (unwind-protect
3751 (progn
3752 (select-window window)
3753 ;; Set point and mark in that window's buffer.
3754 (with-no-warnings
3755 (beginning-of-buffer arg))
3756 ;; Set point accordingly.
3757 (recenter '(t)))
3758 (select-window orig-window))))
3760 (defun end-of-buffer-other-window (arg)
3761 "Move point to the end of the buffer in the other window.
3762 Leave mark at previous position.
3763 With arg N, put point N/10 of the way from the true end."
3764 (interactive "P")
3765 ;; See beginning-of-buffer-other-window for comments.
3766 (let ((orig-window (selected-window))
3767 (window (other-window-for-scrolling)))
3768 (unwind-protect
3769 (progn
3770 (select-window window)
3771 (with-no-warnings
3772 (end-of-buffer arg))
3773 (recenter '(t)))
3774 (select-window orig-window))))
3775 \f
3776 (defun transpose-chars (arg)
3777 "Interchange characters around point, moving forward one character.
3778 With prefix arg ARG, effect is to take character before point
3779 and drag it forward past ARG other characters (backward if ARG negative).
3780 If no argument and at end of line, the previous two chars are exchanged."
3781 (interactive "*P")
3782 (and (null arg) (eolp) (forward-char -1))
3783 (transpose-subr 'forward-char (prefix-numeric-value arg)))
3785 (defun transpose-words (arg)
3786 "Interchange words around point, leaving point at end of them.
3787 With prefix arg ARG, effect is to take word before or around point
3788 and drag it forward past ARG other words (backward if ARG negative).
3789 If ARG is zero, the words around or after point and around or after mark
3790 are interchanged."
3791 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
3792 (interactive "*p")
3793 (transpose-subr 'forward-word arg))
3795 (defun transpose-sexps (arg)
3797 Does not work on a sexp that point is in the middle of
3798 if it is a list or string."
3799 (interactive "*p")
3800 (transpose-subr
3801 (lambda (arg)
3802 ;; Here we should try to simulate the behavior of
3803 ;; (cons (progn (forward-sexp x) (point))
3804 ;; (progn (forward-sexp (- x)) (point)))
3805 ;; Except that we don't want to rely on the second forward-sexp
3806 ;; putting us back to where we want to be, since forward-sexp-function
3807 ;; might do funny things like infix-precedence.
3808 (if (if (> arg 0)
3810 (and (not (bobp))
3812 ;; Jumping over a symbol. We might be inside it, mind you.
3813 (progn (funcall (if (> arg 0)
3814 'skip-syntax-backward 'skip-syntax-forward)
3815 "w_")
3816 (cons (save-excursion (forward-sexp arg) (point)) (point)))
3817 ;; Otherwise, we're between sexps. Take a step back before jumping
3818 ;; to make sure we'll obey the same precedence no matter which direction
3819 ;; we're going.
3820 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
3821 (cons (save-excursion (forward-sexp arg) (point))
3822 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
3823 (not (zerop (funcall (if (> arg 0)
3824 'skip-syntax-forward
3825 'skip-syntax-backward)
3826 ".")))))
3827 (point)))))
3828 arg 'special))
3830 (defun transpose-lines (arg)
3831 "Exchange current line and previous line, leaving point after both.
3832 With argument ARG, takes previous line and moves it past ARG lines.
3833 With argument 0, interchanges line point is in with line mark is in."
3834 (interactive "*p")
3835 (transpose-subr (function
3836 (lambda (arg)
3837 (if (> arg 0)
3838 (progn
3839 ;; Move forward over ARG lines,
3840 ;; but create newlines if necessary.
3841 (setq arg (forward-line arg))
3843 (setq arg (1+ arg)))
3844 (if (> arg 0)
3845 (newline arg)))
3846 (forward-line arg))))
3847 arg))
3849 (defun transpose-subr (mover arg &optional special)
3850 (let ((aux (if special mover
3851 (lambda (x)
3852 (cons (progn (funcall mover x) (point))
3853 (progn (funcall mover (- x)) (point))))))
3854 pos1 pos2)
3855 (cond
3856 ((= arg 0)
3857 (save-excursion
3858 (setq pos1 (funcall aux 1))
3859 (goto-char (mark))
3860 (setq pos2 (funcall aux 1))
3861 (transpose-subr-1 pos1 pos2))
3862 (exchange-point-and-mark))
3863 ((> arg 0)
3864 (setq pos1 (funcall aux -1))
3865 (setq pos2 (funcall aux arg))
3866 (transpose-subr-1 pos1 pos2)
3867 (goto-char (car pos2)))
3868 (t
3869 (setq pos1 (funcall aux -1))
3870 (goto-char (car pos1))
3871 (setq pos2 (funcall aux arg))
3872 (transpose-subr-1 pos1 pos2)))))
3874 (defun transpose-subr-1 (pos1 pos2)
3875 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
3876 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
3877 (when (> (car pos1) (car pos2))
3878 (let ((swap pos1))
3879 (setq pos1 pos2 pos2 swap)))
3880 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
3881 (atomic-change-group
3882 (let (word2)
3883 ;; FIXME: We first delete the two pieces of text, so markers that
3884 ;; used to point to after the text end up pointing to before it :-(
3885 (setq word2 (delete-and-extract-region (car pos2) (cdr pos2)))
3886 (goto-char (car pos2))
3887 (insert (delete-and-extract-region (car pos1) (cdr pos1)))
3888 (goto-char (car pos1))
3889 (insert word2))))
3890 \f
3891 (defun backward-word (&optional arg)
3892 "Move backward until encountering the beginning of a word.
3893 With argument, do this that many times."
3894 (interactive "p")
3895 (forward-word (- (or arg 1))))
3897 (defun mark-word (&optional arg allow-extend)
3898 "Set mark ARG words away from point.
3900 move to with the same argument.
3901 Interactively, if this command is repeated
3902 or (in Transient Mark mode) if the mark is active,
3903 it marks the next ARG words after the ones already marked."
3905 (cond ((and allow-extend
3906 (or (and (eq last-command this-command) (mark t))
3907 (and transient-mark-mode mark-active)))
3908 (setq arg (if arg (prefix-numeric-value arg)
3909 (if (< (mark) (point)) -1 1)))
3910 (set-mark
3911 (save-excursion
3912 (goto-char (mark))
3913 (forward-word arg)
3914 (point))))
3915 (t
3916 (push-mark
3917 (save-excursion
3918 (forward-word (prefix-numeric-value arg))
3919 (point))
3920 nil t))))
3922 (defun kill-word (arg)
3923 "Kill characters forward until encountering the end of a word.
3924 With argument, do this that many times."
3925 (interactive "p")
3926 (kill-region (point) (progn (forward-word arg) (point))))
3928 (defun backward-kill-word (arg)
3929 "Kill characters backward until encountering the end of a word.
3930 With argument, do this that many times."
3931 (interactive "p")
3932 (kill-word (- arg)))
3934 (defun current-word (&optional strict really-word)
3935 "Return the symbol or word that point is on (or a nearby one) as a string.
3936 The return value includes no text properties.
3937 If optional arg STRICT is non-nil, return nil unless point is within
3938 or adjacent to a symbol or word. In all cases the value can be nil
3939 if there is no word nearby.
3940 The function, belying its name, normally finds a symbol.
3941 If optional arg REALLY-WORD is non-nil, it finds just a word."
3942 (save-excursion
3943 (let* ((oldpoint (point)) (start (point)) (end (point))
3944 (syntaxes (if really-word "w" "w_"))
3945 (not-syntaxes (concat "^" syntaxes)))
3946 (skip-syntax-backward syntaxes) (setq start (point))
3947 (goto-char oldpoint)
3948 (skip-syntax-forward syntaxes) (setq end (point))
3949 (when (and (eq start oldpoint) (eq end oldpoint)
3950 ;; Point is neither within nor adjacent to a word.
3951 (not strict))
3952 ;; Look for preceding word in same line.
3953 (skip-syntax-backward not-syntaxes
3954 (save-excursion (beginning-of-line)
3955 (point)))
3956 (if (bolp)
3957 ;; No preceding word in same line.
3958 ;; Look for following word in same line.
3959 (progn
3960 (skip-syntax-forward not-syntaxes
3961 (save-excursion (end-of-line)
3962 (point)))
3963 (setq start (point))
3964 (skip-syntax-forward syntaxes)
3965 (setq end (point)))
3966 (setq end (point))
3967 (skip-syntax-backward syntaxes)
3968 (setq start (point))))
3969 ;; If we found something nonempty, return it as a string.
3970 (unless (= start end)
3971 (buffer-substring-no-properties start end)))))
3972 \f
3973 (defcustom fill-prefix nil
3974 "*String for filling to insert at front of new line, or nil for none."
3975 :type '(choice (const :tag "None" nil)
3976 string)
3977 :group 'fill)
3978 (make-variable-buffer-local 'fill-prefix)
3980 (defcustom auto-fill-inhibit-regexp nil
3981 "*Regexp to match lines which should not be auto-filled."
3982 :type '(choice (const :tag "None" nil)
3983 regexp)
3984 :group 'fill)
3986 (defvar comment-line-break-function 'comment-indent-new-line
3987 "*Mode-specific function which line breaks and continues a comment.
3989 This function is only called during auto-filling of a comment section.
3990 The function should take a single optional argument, which is a flag
3991 indicating whether it should use soft newlines.")
3993 ;; This function is used as the auto-fill-function of a buffer
3994 ;; when Auto-Fill mode is enabled.
3995 ;; It returns t if it really did any work.
3996 ;; (Actually some major modes use a different auto-fill function,
3997 ;; but this one is the default one.)
3998 (defun do-auto-fill ()
3999 (let (fc justify give-up
4000 (fill-prefix fill-prefix))
4001 (if (or (not (setq justify (current-justification)))
4002 (null (setq fc (current-fill-column)))
4003 (and (eq justify 'left)
4004 (<= (current-column) fc))
4005 (and auto-fill-inhibit-regexp
4006 (save-excursion (beginning-of-line)
4007 (looking-at auto-fill-inhibit-regexp))))
4008 nil ;; Auto-filling not required
4009 (if (memq justify '(full center right))
4010 (save-excursion (unjustify-current-line)))
4012 ;; Choose a fill-prefix automatically.
4013 (when (and adaptive-fill-mode
4014 (or (null fill-prefix) (string= fill-prefix "")))
4015 (let ((prefix
4016 (fill-context-prefix
4017 (save-excursion (backward-paragraph 1) (point))
4018 (save-excursion (forward-paragraph 1) (point)))))
4019 (and prefix (not (equal prefix ""))
4020 ;; Use auto-indentation rather than a guessed empty prefix.
4021 (not (and fill-indent-according-to-mode
4023 (setq fill-prefix prefix))))
4025 (while (and (not give-up) (> (current-column) fc))
4026 ;; Determine where to split the line.
4027 (let* (after-prefix
4028 (fill-point
4029 (save-excursion
4030 (beginning-of-line)
4031 (setq after-prefix (point))
4032 (and fill-prefix
4033 (looking-at (regexp-quote fill-prefix))
4034 (setq after-prefix (match-end 0)))
4035 (move-to-column (1+ fc))
4036 (fill-move-to-break-point after-prefix)
4037 (point))))
4039 ;; See whether the place we found is any good.
4040 (if (save-excursion
4041 (goto-char fill-point)
4042 (or (bolp)
4043 ;; There is no use breaking at end of line.
4044 (save-excursion (skip-chars-forward " ") (eolp))
4045 ;; It is futile to split at the end of the prefix
4046 ;; since we would just insert the prefix again.
4047 (and after-prefix (<= (point) after-prefix))
4048 ;; Don't split right after a comment starter
4049 ;; since we would just make another comment starter.
4050 (and comment-start-skip
4051 (let ((limit (point)))
4052 (beginning-of-line)
4053 (and (re-search-forward comment-start-skip
4054 limit t)
4055 (eq (point) limit))))))
4056 ;; No good place to break => stop trying.
4057 (setq give-up t)
4058 ;; Ok, we have a useful place to break the line. Do it.
4059 (let ((prev-column (current-column)))
4060 ;; If point is at the fill-point, do not `save-excursion'.
4061 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
4062 ;; point will end up before it rather than after it.
4063 (if (save-excursion
4065 (= (point) fill-point))
4066 (funcall comment-line-break-function t)
4067 (save-excursion
4068 (goto-char fill-point)
4069 (funcall comment-line-break-function t)))
4070 ;; Now do justification, if required
4071 (if (not (eq justify 'left))
4072 (save-excursion
4073 (end-of-line 0)
4074 (justify-current-line justify nil t)))
4075 ;; If making the new line didn't reduce the hpos of
4076 ;; the end of the line, then give up now;
4077 ;; trying again will not help.
4078 (if (>= (current-column) prev-column)
4079 (setq give-up t))))))
4080 ;; Justify last line.
4081 (justify-current-line justify t t)
4082 t)))
4084 (defvar normal-auto-fill-function 'do-auto-fill
4085 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
4086 Some major modes set this.")
4088 (put 'auto-fill-function :minor-mode-function 'auto-fill-mode)
4089 ;; FIXME: turn into a proper minor mode.
4090 ;; Add a global minor mode version of it.
4091 (defun auto-fill-mode (&optional arg)
4092 "Toggle Auto Fill mode.
4093 With arg, turn Auto Fill mode on if and only if arg is positive.
4094 In Auto Fill mode, inserting a space at a column beyond `current-fill-column'
4095 automatically breaks the line at a previous space.
4097 The value of `normal-auto-fill-function' specifies the function to use
4098 for `auto-fill-function' when turning Auto Fill mode on."
4099 (interactive "P")
4100 (prog1 (setq auto-fill-function
4101 (if (if (null arg)
4102 (not auto-fill-function)
4103 (> (prefix-numeric-value arg) 0))
4104 normal-auto-fill-function
4105 nil))
4106 (force-mode-line-update)))
4108 ;; This holds a document string used to document auto-fill-mode.
4109 (defun auto-fill-function ()
4110 "Automatically break line at a previous space, in insertion of text."
4111 nil)
4113 (defun turn-on-auto-fill ()
4114 "Unconditionally turn on Auto Fill mode."
4115 (auto-fill-mode 1))
4117 (defun turn-off-auto-fill ()
4118 "Unconditionally turn off Auto Fill mode."
4119 (auto-fill-mode -1))
4121 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
4123 (defun set-fill-column (arg)
4124 "Set `fill-column' to specified argument.
4127 (interactive "P")
4128 (if (consp arg)
4129 (setq arg (current-column)))
4130 (if (not (integerp arg))
4131 ;; Disallow missing argument; it's probably a typo for C-x C-f.
4132 (error "set-fill-column requires an explicit argument")
4133 (message "Fill column set to %d (was %d)" arg fill-column)
4134 (setq fill-column arg)))
4135 \f
4136 (defun set-selective-display (arg)
4137 "Set `selective-display' to ARG; clear it if no arg.
4138 When the value of `selective-display' is a number > 0,
4139 lines whose indentation is >= that value are not displayed.
4140 The variable `selective-display' has a separate value for each buffer."
4141 (interactive "P")
4142 (if (eq selective-display t)
4143 (error "selective-display already in use for marked lines"))
4144 (let ((current-vpos
4145 (save-restriction
4146 (narrow-to-region (point-min) (point))
4147 (goto-char (window-start))
4148 (vertical-motion (window-height)))))
4149 (setq selective-display
4150 (and arg (prefix-numeric-value arg)))
4151 (recenter current-vpos))
4152 (set-window-start (selected-window) (window-start (selected-window)))
4153 (princ "selective-display set to " t)
4154 (prin1 selective-display t)
4155 (princ "." t))
4157 (defvaralias 'indicate-unused-lines 'indicate-empty-lines)
4158 (defvaralias 'default-indicate-unused-lines 'default-indicate-empty-lines)
4160 (defun toggle-truncate-lines (arg)
4161 "Toggle whether to fold or truncate long lines on the screen.
4162 With arg, truncate long lines iff arg is positive.
4163 Note that in side-by-side windows, truncation is always enabled."
4164 (interactive "P")
4165 (setq truncate-lines
4166 (if (null arg)
4167 (not truncate-lines)
4168 (> (prefix-numeric-value arg) 0)))
4169 (force-mode-line-update)
4170 (unless truncate-lines
4171 (let ((buffer (current-buffer)))
4172 (walk-windows (lambda (window)
4173 (if (eq buffer (window-buffer window))
4174 (set-window-hscroll window 0)))
4175 nil t)))
4176 (message "Truncate long lines %s"
4177 (if truncate-lines "enabled" "disabled")))
4179 (defvar overwrite-mode-textual " Ovwrt"
4180 "The string displayed in the mode line when in overwrite mode.")
4181 (defvar overwrite-mode-binary " Bin Ovwrt"
4182 "The string displayed in the mode line when in binary overwrite mode.")
4184 (defun overwrite-mode (arg)
4185 "Toggle overwrite mode.
4186 With arg, turn overwrite mode on iff arg is positive.
4187 In overwrite mode, printing characters typed in replace existing text
4188 on a one-for-one basis, rather than pushing it to the right. At the
4189 end of a line, such characters extend the line. Before a tab,
4190 such characters insert until the tab is filled in.
4192 is supposed to make it easier to insert characters when necessary."
4193 (interactive "P")
4194 (setq overwrite-mode
4195 (if (if (null arg) (not overwrite-mode)
4196 (> (prefix-numeric-value arg) 0))
4197 'overwrite-mode-textual))
4198 (force-mode-line-update))
4200 (defun binary-overwrite-mode (arg)
4201 "Toggle binary overwrite mode.
4202 With arg, turn binary overwrite mode on iff arg is positive.
4203 In binary overwrite mode, printing characters typed in replace
4204 existing text. Newlines are not treated specially, so typing at the
4205 end of a line joins the line to the next, with the typed character
4206 between them. Typing before a tab character simply replaces the tab
4207 with the character typed.
4209 typing characters do.
4211 Note that binary overwrite mode is not its own minor mode; it is a
4212 specialization of overwrite mode, entered by setting the
4213 `overwrite-mode' variable to `overwrite-mode-binary'."
4214 (interactive "P")
4215 (setq overwrite-mode
4216 (if (if (null arg)
4217 (not (eq overwrite-mode 'overwrite-mode-binary))
4218 (> (prefix-numeric-value arg) 0))
4219 'overwrite-mode-binary))
4220 (force-mode-line-update))
4222 (define-minor-mode line-number-mode
4223 "Toggle Line Number mode.
4224 With arg, turn Line Number mode on iff arg is positive.
4225 When Line Number mode is enabled, the line number appears
4226 in the mode line.
4228 Line numbers do not appear for very large buffers and buffers
4229 with very long lines; see variables `line-number-display-limit'
4230 and `line-number-display-limit-width'."
4231 :init-value t :global t :group 'editing-basics :require nil)
4233 (define-minor-mode column-number-mode
4234 "Toggle Column Number mode.
4235 With arg, turn Column Number mode on iff arg is positive.
4236 When Column Number mode is enabled, the column number appears
4237 in the mode line."
4238 :global t :group 'editing-basics :require nil)
4240 (define-minor-mode size-indication-mode
4241 "Toggle Size Indication mode.
4242 With arg, turn Size Indication mode on iff arg is positive. When
4243 Size Indication mode is enabled, the size of the accessible part
4244 of the buffer appears in the mode line."
4245 :global t :group 'editing-basics :require nil)
4246 \f
4247 (defgroup paren-blinking nil
4248 "Blinking matching of parens and expressions."
4249 :prefix "blink-matching-"
4250 :group 'paren-matching)
4252 (defcustom blink-matching-paren t
4253 "*Non-nil means show matching open-paren when close-paren is inserted."
4254 :type 'boolean
4255 :group 'paren-blinking)
4257 (defcustom blink-matching-paren-on-screen t
4258 "*Non-nil means show matching open-paren when it is on screen.
4259 If nil, means don't show it (but the open-paren can still be shown
4260 when it is off screen)."
4261 :type 'boolean
4262 :group 'paren-blinking)
4264 (defcustom blink-matching-paren-distance (* 25 1024)
4265 "*If non-nil, maximum distance to search backwards for matching open-paren.
4266 If nil, search stops at the beginning of the accessible portion of the buffer."
4267 :type '(choice (const nil) integer)
4268 :group 'paren-blinking)
4270 (defcustom blink-matching-delay 1
4271 "*Time in seconds to delay after showing a matching paren."
4272 :type 'number
4273 :group 'paren-blinking)
4275 (defcustom blink-matching-paren-dont-ignore-comments nil
4276 "*Non-nil means `blink-matching-paren' will not ignore comments."
4277 :type 'boolean
4278 :group 'paren-blinking)
4280 (defun blink-matching-open ()
4281 "Move cursor momentarily to the beginning of the sexp before point."
4282 (interactive)
4283 (when (and (> (point) (point-min))
4284 blink-matching-paren
4285 ;; Verify an even number of quoting characters precede the close.
4286 (= 1 (logand 1 (- (point)
4287 (save-excursion
4288 (forward-char -1)
4290 (point))))))
4291 (let* ((oldpos (point))
4292 blinkpos
4293 message-log-max ; Don't log messages about paren matching.
4294 matching-paren
4295 open-paren-line-string)
4296 (save-excursion
4297 (save-restriction
4298 (if blink-matching-paren-distance
4299 (narrow-to-region (max (point-min)
4300 (- (point) blink-matching-paren-distance))
4301 oldpos))
4302 (condition-case ()
4303 (let ((parse-sexp-ignore-comments
4304 (and parse-sexp-ignore-comments
4305 (not blink-matching-paren-dont-ignore-comments))))
4306 (setq blinkpos (scan-sexps oldpos -1)))
4307 (error nil)))
4308 (and blinkpos
4309 ;; Not syntax '$'.
4310 (not (eq (syntax-class (syntax-after blinkpos)) 8))
4311 (setq matching-paren
4312 (let ((syntax (syntax-after blinkpos)))
4313 (and (consp syntax)
4314 (eq (syntax-class syntax) 4)
4315 (cdr syntax)))))
4316 (cond
4317 ((or (null matching-paren)
4318 (/= (char-before oldpos)
4319 matching-paren))
4320 (message "Mismatched parentheses"))
4321 ((not blinkpos)
4322 (if (not blink-matching-paren-distance)
4323 (message "Unmatched parenthesis")))
4324 ((pos-visible-in-window-p blinkpos)
4325 ;; Matching open within window, temporarily move to blinkpos but only
4326 ;; if `blink-matching-paren-on-screen' is non-nil.
4327 (when blink-matching-paren-on-screen
4328 (save-excursion
4329 (goto-char blinkpos)
4330 (sit-for blink-matching-delay))))
4331 (t
4332 (save-excursion
4333 (goto-char blinkpos)
4334 (setq open-paren-line-string
4335 ;; Show what precedes the open in its line, if anything.
4336 (if (save-excursion
4338 (not (bolp)))
4339 (buffer-substring (line-beginning-position)
4340 (1+ blinkpos))
4341 ;; Show what follows the open in its line, if anything.
4342 (if (save-excursion
4343 (forward-char 1)
4345 (not (eolp)))
4346 (buffer-substring blinkpos
4347 (line-end-position))
4348 ;; Otherwise show the previous nonblank line,
4349 ;; if there is one.
4350 (if (save-excursion
4352 (not (bobp)))
4353 (concat
4354 (buffer-substring (progn
4356 (line-beginning-position))
4357 (progn (end-of-line)
4359 (point)))
4360 ;; Replace the newline and other whitespace with `...'.
4361 "..."
4362 (buffer-substring blinkpos (1+ blinkpos)))
4363 ;; There is nothing to show except the char itself.
4364 (buffer-substring blinkpos (1+ blinkpos)))))))
4365 (message "Matches %s"
4366 (substring-no-properties open-paren-line-string))))))))
4368 ;Turned off because it makes dbx bomb out.
4369 (setq blink-paren-function 'blink-matching-open)
4370 \f
4371 ;; This executes C-g typed while Emacs is waiting for a command.
4372 ;; Quitting out of a program does not go through here;
4373 ;; that happens in the QUIT macro at the C code level.
4374 (defun keyboard-quit ()
4375 "Signal a `quit' condition.
4376 During execution of Lisp code, this character causes a quit directly.
4377 At top-level, as an editor command, this simply beeps."
4378 (interactive)
4379 (deactivate-mark)
4380 (if (fboundp 'kmacro-keyboard-quit)
4381 (kmacro-keyboard-quit))
4382 (setq defining-kbd-macro nil)
4383 (signal 'quit nil))
4385 (defvar buffer-quit-function nil
4388 \(such as cancelling a prefix argument, minibuffer or region) do not apply.")
4390 (defun keyboard-escape-quit ()
4392 This command can exit an interactive command such as `query-replace',
4393 can clear out a prefix argument or a region,
4394 can get out of the minibuffer or other recursive edit,
4395 cancel the use of the current buffer (for special-purpose buffers),
4396 or go back to just one window (by deleting all but the selected window)."
4397 (interactive)
4398 (cond ((eq last-command 'mode-exited) nil)
4399 ((> (minibuffer-depth) 0)
4400 (abort-recursive-edit))
4401 (current-prefix-arg
4402 nil)
4403 ((and transient-mark-mode mark-active)
4404 (deactivate-mark))
4405 ((> (recursion-depth) 0)
4406 (exit-recursive-edit))
4407 (buffer-quit-function
4408 (funcall buffer-quit-function))
4409 ((not (one-window-p t))
4410 (delete-other-windows))
4412 (bury-buffer))))
4414 (defun play-sound-file (file &optional volume device)
4415 "Play sound stored in FILE.
4416 VOLUME and DEVICE correspond to the keywords of the sound
4417 specification for `play-sound'."
4418 (interactive "fPlay sound file: ")
4419 (let ((sound (list :file file)))
4420 (if volume
4421 (plist-put sound :volume volume))
4422 (if device
4423 (plist-put sound :device device))
4424 (push 'sound sound)
4425 (play-sound sound)))
4427 \f
4428 (defcustom read-mail-command 'rmail
4429 "*Your preference for a mail reading package.
4430 This is used by some keybindings which support reading mail.
4431 See also `mail-user-agent' concerning sending mail."
4432 :type '(choice (function-item rmail)
4433 (function-item gnus)
4434 (function-item mh-rmail)
4435 (function :tag "Other"))
4436 :version "21.1"
4437 :group 'mail)
4439 (defcustom mail-user-agent 'sendmail-user-agent
4440 "*Your preference for a mail composition package.
4441 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
4442 outgoing email message. This variable lets you specify which
4443 mail-sending package you prefer.
4445 Valid values include:
4447 `sendmail-user-agent' -- use the default Emacs Mail package.
4448 See Info node `(emacs)Sending Mail'.
4449 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
4450 See Info node `(mh-e)'.
4451 `message-user-agent' -- use the Gnus Message package.
4452 See Info node `(message)'.
4453 `gnus-user-agent' -- like `message-user-agent', but with Gnus
4454 paraphernalia, particularly the Gcc: header for
4455 archiving.
4457 Additional valid symbols may be available; check with the author of
4458 your package for details. The function should return non-nil if it
4459 succeeds.
4461 See also `read-mail-command' concerning reading mail."
4462 :type '(radio (function-item :tag "Default Emacs mail"
4464 sendmail-user-agent)
4465 (function-item :tag "Emacs interface to MH"
4467 mh-e-user-agent)
4468 (function-item :tag "Gnus Message package"
4470 message-user-agent)
4471 (function-item :tag "Gnus Message with full Gnus features"
4473 gnus-user-agent)
4474 (function :tag "Other"))
4475 :group 'mail)
4477 (define-mail-user-agent 'sendmail-user-agent
4478 'sendmail-user-agent-compose
4479 'mail-send-and-exit)
4481 (defun rfc822-goto-eoh ()
4482 ;; Go to header delimiter line in a mail message, following RFC822 rules
4483 (goto-char (point-min))
4484 (when (re-search-forward
4486 (goto-char (match-beginning 0))))
4488 (defun sendmail-user-agent-compose (&optional to subject other-headers continue
4489 switch-function yank-action
4490 send-actions)
4491 (if switch-function
4492 (let ((special-display-buffer-names nil)
4493 (special-display-regexps nil)
4494 (same-window-buffer-names nil)
4495 (same-window-regexps nil))
4496 (funcall switch-function "*mail*")))
4497 (let ((cc (cdr (assoc-string "cc" other-headers t)))
4498 (in-reply-to (cdr (assoc-string "in-reply-to" other-headers t)))
4499 (body (cdr (assoc-string "body" other-headers t))))
4500 (or (mail continue to subject in-reply-to cc yank-action send-actions)
4501 continue
4502 (error "Message aborted"))
4503 (save-excursion
4504 (rfc822-goto-eoh)
4505 (while other-headers
4506 (unless (member-ignore-case (car (car other-headers))
4507 '("in-reply-to" "cc" "body"))
4508 (insert (car (car other-headers)) ": "
4510 (setq other-headers (cdr other-headers)))
4511 (when body
4512 (forward-line 1)
4513 (insert body))
4514 t)))
4516 (define-mail-user-agent 'mh-e-user-agent
4517 'mh-smail-batch 'mh-send-letter 'mh-fully-kill-draft
4518 'mh-before-send-letter-hook)
4520 (defun compose-mail (&optional to subject other-headers continue
4521 switch-function yank-action send-actions)
4522 "Start composing a mail message to send.
4523 This uses the user's chosen mail composition package
4524 as selected with the variable `mail-user-agent'.
4525 The optional arguments TO and SUBJECT specify recipients
4526 and the initial Subject field, respectively.
4528 OTHER-HEADERS is an alist specifying additional
4529 header fields. Elements look like (HEADER . VALUE) where both
4530 HEADER and VALUE are strings.
4532 CONTINUE, if non-nil, says to continue editing a message already
4533 being composed.
4535 SWITCH-FUNCTION, if non-nil, is a function to use to
4536 switch to and display the buffer used for mail composition.
4538 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
4539 to insert the raw text of the message being replied to.
4540 It has the form (FUNCTION . ARGS). The user agent will apply
4541 FUNCTION to ARGS, to insert the raw text of the original message.
4542 \(The user agent will also run `mail-citation-hook', *after* the
4543 original text has been inserted in this way.)
4545 SEND-ACTIONS is a list of actions to call when the message is sent.
4546 Each action has the form (FUNCTION . ARGS)."
4547 (interactive
4548 (list nil nil nil current-prefix-arg))
4549 (let ((function (get mail-user-agent 'composefunc)))
4550 (funcall function to subject other-headers continue
4551 switch-function yank-action send-actions)))
4553 (defun compose-mail-other-window (&optional to subject other-headers continue
4554 yank-action send-actions)
4556 (interactive
4557 (list nil nil nil current-prefix-arg))
4558 (compose-mail to subject other-headers continue
4559 'switch-to-buffer-other-window yank-action send-actions))
4562 (defun compose-mail-other-frame (&optional to subject other-headers continue
4563 yank-action send-actions)
4565 (interactive
4566 (list nil nil nil current-prefix-arg))
4567 (compose-mail to subject other-headers continue
4568 'switch-to-buffer-other-frame yank-action send-actions))
4569 \f
4570 (defvar set-variable-value-history nil
4571 "History of values entered with `set-variable'.")
4573 (defun set-variable (variable value &optional make-local)
4574 "Set VARIABLE to VALUE. VALUE is a Lisp object.
4575 VARIABLE should be a user option variable name, a Lisp variable
4576 meant to be customized by users. You should enter VALUE in Lisp syntax,
4577 so if you want VALUE to be a string, you must surround it with doublequotes.
4578 VALUE is used literally, not evaluated.
4580 If VARIABLE has a `variable-interactive' property, that is used as if
4581 it were the arg to `interactive' (which see) to interactively read VALUE.
4583 If VARIABLE has been defined with `defcustom', then the type information
4584 in the definition is used to check that VALUE is valid.
4586 With a prefix argument, set VARIABLE to VALUE buffer-locally."
4587 (interactive
4588 (let* ((default-var (variable-at-point))
4589 (var (if (user-variable-p default-var)
4590 (read-variable (format "Set variable (default %s): " default-var)
4591 default-var)
4592 (read-variable "Set variable: ")))
4593 (minibuffer-help-form '(describe-variable var))
4594 (prop (get var 'variable-interactive))
4595 (obsolete (car (get var 'byte-obsolete-variable)))
4596 (prompt (format "Set %s %s to value: " var
4597 (cond ((local-variable-p var)
4598 "(buffer-local)")
4599 ((or current-prefix-arg
4600 (local-variable-if-set-p var))
4601 "buffer-locally")
4602 (t "globally"))))
4603 (val (progn
4604 (when obsolete
4605 (message (concat "`%S' is obsolete; "
4606 (if (symbolp obsolete) "use `%S' instead" "%s"))
4607 var obsolete)
4608 (sit-for 3))
4609 (if prop
4610 ;; Use VAR's `variable-interactive' property
4611 ;; as an interactive spec for prompting.
4612 (call-interactively `(lambda (arg)
4613 (interactive ,prop)
4614 arg))
4615 (read
4616 (read-string prompt nil
4617 'set-variable-value-history
4618 (format "%S" (symbol-value var))))))))
4619 (list var val current-prefix-arg)))
4621 (and (custom-variable-p variable)
4622 (not (get variable 'custom-type))
4623 (custom-load-symbol variable))
4624 (let ((type (get variable 'custom-type)))
4625 (when type
4626 ;; Match with custom type.
4627 (require 'cus-edit)
4628 (setq type (widget-convert type))
4629 (unless (widget-apply type :match value)
4630 (error "Value `%S' does not match type %S of %S"
4631 value (car type) variable))))
4633 (if make-local
4634 (make-local-variable variable))
4636 (set variable value)
4638 ;; Force a thorough redisplay for the case that the variable
4639 ;; has an effect on the display, like `tab-width' has.
4640 (force-mode-line-update))
4641 \f
4642 ;; Define the major mode for lists of completions.
4644 (defvar completion-list-mode-map nil
4645 "Local map for completion list buffers.")
4646 (or completion-list-mode-map
4647 (let ((map (make-sparse-keymap)))
4648 (define-key map [mouse-2] 'mouse-choose-completion)
4649 (define-key map [follow-link] 'mouse-face)
4650 (define-key map [down-mouse-2] nil)
4651 (define-key map "\C-m" 'choose-completion)
4652 (define-key map "\e\e\e" 'delete-completion-window)
4653 (define-key map [left] 'previous-completion)
4654 (define-key map [right] 'next-completion)
4655 (setq completion-list-mode-map map)))
4657 ;; Completion mode is suitable only for specially formatted data.
4658 (put 'completion-list-mode 'mode-class 'special)
4660 (defvar completion-reference-buffer nil
4661 "Record the buffer that was current when the completion list was requested.
4662 This is a local variable in the completion list buffer.
4663 Initial value is nil to avoid some compiler warnings.")
4665 (defvar completion-no-auto-exit nil
4666 "Non-nil means `choose-completion-string' should never exit the minibuffer.
4667 This also applies to other functions such as `choose-completion'
4668 and `mouse-choose-completion'.")
4670 (defvar completion-base-size nil
4671 "Number of chars at beginning of minibuffer not involved in completion.
4672 This is a local variable in the completion list buffer
4673 but it talks about the buffer in `completion-reference-buffer'.
4674 If this is nil, it means to compare text to determine which part
4675 of the tail end of the buffer's text is involved in completion.")
4677 (defun delete-completion-window ()
4678 "Delete the completion list window.
4679 Go to the window from which completion was requested."
4680 (interactive)
4681 (let ((buf completion-reference-buffer))
4682 (if (one-window-p t)
4683 (if (window-dedicated-p (selected-window))
4684 (delete-frame (selected-frame)))
4685 (delete-window (selected-window))
4686 (if (get-buffer-window buf)
4687 (select-window (get-buffer-window buf))))))
4689 (defun previous-completion (n)
4690 "Move to the previous item in the completion list."
4691 (interactive "p")
4692 (next-completion (- n)))
4694 (defun next-completion (n)
4695 "Move to the next item in the completion list.
4696 With prefix argument N, move N items (negative N means move backward)."
4697 (interactive "p")
4698 (let ((beg (point-min)) (end (point-max)))
4699 (while (and (> n 0) (not (eobp)))
4700 ;; If in a completion, move to the end of it.
4701 (when (get-text-property (point) 'mouse-face)
4702 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
4703 ;; Move to start of next one.
4704 (unless (get-text-property (point) 'mouse-face)
4705 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
4706 (setq n (1- n)))
4707 (while (and (< n 0) (not (bobp)))
4708 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
4709 ;; If in a completion, move to the start of it.
4710 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
4711 (goto-char (previous-single-property-change
4712 (point) 'mouse-face nil beg)))
4713 ;; Move to end of the previous completion.
4714 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
4715 (goto-char (previous-single-property-change
4716 (point) 'mouse-face nil beg)))
4717 ;; Move to the start of that one.
4718 (goto-char (previous-single-property-change
4719 (point) 'mouse-face nil beg))
4720 (setq n (1+ n))))))
4722 (defun choose-completion ()
4723 "Choose the completion that point is in or next to."
4724 (interactive)
4725 (let (beg end completion (buffer completion-reference-buffer)
4726 (base-size completion-base-size))
4727 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
4728 (setq end (point) beg (1+ (point))))
4729 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
4730 (setq end (1- (point)) beg (point)))
4731 (if (null beg)
4732 (error "No completion here"))
4733 (setq beg (previous-single-property-change beg 'mouse-face))
4734 (setq end (or (next-single-property-change end 'mouse-face) (point-max)))
4735 (setq completion (buffer-substring beg end))
4736 (let ((owindow (selected-window)))
4737 (if (and (one-window-p t 'selected-frame)
4738 (window-dedicated-p (selected-window)))
4739 ;; This is a special buffer's frame
4740 (iconify-frame (selected-frame))
4741 (or (window-dedicated-p (selected-window))
4742 (bury-buffer)))
4743 (select-window owindow))
4744 (choose-completion-string completion buffer base-size)))
4746 ;; Delete the longest partial match for STRING
4747 ;; that can be found before POINT.
4748 (defun choose-completion-delete-max-match (string)
4749 (let ((opoint (point))
4750 len)
4751 ;; Try moving back by the length of the string.
4752 (goto-char (max (- (point) (length string))
4753 (minibuffer-prompt-end)))
4754 ;; See how far back we were actually able to move. That is the
4755 ;; upper bound on how much we can match and delete.
4756 (setq len (- opoint (point)))
4757 (if completion-ignore-case
4758 (setq string (downcase string)))
4759 (while (and (> len 0)
4760 (let ((tail (buffer-substring (point) opoint)))
4761 (if completion-ignore-case
4762 (setq tail (downcase tail)))
4763 (not (string= tail (substring string 0 len)))))
4764 (setq len (1- len))
4765 (forward-char 1))
4766 (delete-char len)))
4768 (defvar choose-completion-string-functions nil
4769 "Functions that may override the normal insertion of a completion choice.
4770 These functions are called in order with four arguments:
4771 CHOICE - the string to insert in the buffer,
4772 BUFFER - the buffer in which the choice should be inserted,
4773 MINI-P - non-nil iff BUFFER is a minibuffer, and
4774 BASE-SIZE - the number of characters in BUFFER before
4775 the string being completed.
4777 If a function in the list returns non-nil, that function is supposed
4778 to have inserted the CHOICE in the BUFFER, and possibly exited
4779 the minibuffer; no further functions will be called.
4781 If all functions in the list return nil, that means to use
4782 the default method of inserting the completion in BUFFER.")
4784 (defun choose-completion-string (choice &optional buffer base-size)
4785 "Switch to BUFFER and insert the completion choice CHOICE.
4786 BASE-SIZE, if non-nil, says how many characters of BUFFER's text
4787 to keep. If it is nil, we call `choose-completion-delete-max-match'
4788 to decide what to delete."
4790 ;; If BUFFER is the minibuffer, exit the minibuffer
4791 ;; unless it is reading a file name and CHOICE is a directory,
4792 ;; or completion-no-auto-exit is non-nil.
4794 (let* ((buffer (or buffer completion-reference-buffer))
4795 (mini-p (minibufferp buffer)))
4796 ;; If BUFFER is a minibuffer, barf unless it's the currently
4797 ;; active minibuffer.
4798 (if (and mini-p
4799 (or (not (active-minibuffer-window))
4800 (not (equal buffer
4801 (window-buffer (active-minibuffer-window))))))
4802 (error "Minibuffer is not active for completion")
4803 ;; Set buffer so buffer-local choose-completion-string-functions works.
4804 (set-buffer buffer)
4805 (unless (run-hook-with-args-until-success
4806 'choose-completion-string-functions
4807 choice buffer mini-p base-size)
4808 ;; Insert the completion into the buffer where it was requested.
4809 (if base-size
4810 (delete-region (+ base-size (if mini-p
4811 (minibuffer-prompt-end)
4812 (point-min)))
4813 (point))
4814 (choose-completion-delete-max-match choice))
4815 (insert choice)
4816 (remove-text-properties (- (point) (length choice)) (point)
4817 '(mouse-face nil))
4818 ;; Update point in the window that BUFFER is showing in.
4819 (let ((window (get-buffer-window buffer t)))
4820 (set-window-point window (point)))
4821 ;; If completing for the minibuffer, exit it with this choice.
4822 (and (not completion-no-auto-exit)
4823 (equal buffer (window-buffer (minibuffer-window)))
4824 minibuffer-completion-table
4825 ;; If this is reading a file name, and the file name chosen
4826 ;; is a directory, don't exit the minibuffer.
4827 (if (and (eq minibuffer-completion-table 'read-file-name-internal)
4828 (file-directory-p (field-string (point-max))))
4829 (let ((mini (active-minibuffer-window)))
4830 (select-window mini)
4831 (when minibuffer-auto-raise
4832 (raise-frame (window-frame mini))))
4833 (exit-minibuffer)))))))
4835 (defun completion-list-mode ()
4836 "Major mode for buffers showing lists of possible completions.
4838 to select the completion near point.
4840 with the mouse."
4841 (interactive)
4842 (kill-all-local-variables)
4843 (use-local-map completion-list-mode-map)
4844 (setq mode-name "Completion List")
4845 (setq major-mode 'completion-list-mode)
4846 (make-local-variable 'completion-base-size)
4847 (setq completion-base-size nil)
4848 (run-mode-hooks 'completion-list-mode-hook))
4850 (defun completion-list-mode-finish ()
4851 "Finish setup of the completions buffer.
4852 Called from `temp-buffer-show-hook'."
4853 (when (eq major-mode 'completion-list-mode)
4854 (toggle-read-only 1)))
4856 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
4858 (defvar completion-setup-hook nil
4859 "Normal hook run at the end of setting up a completion list buffer.
4860 When this hook is run, the current buffer is the one in which the
4861 command to display the completion list buffer was run.
4862 The completion list buffer is available as the value of `standard-output'.
4863 The common prefix substring for completion may be available as the
4864 value of `completion-common-substring'. See also `display-completion-list'.")
4867 ;; Variables and faces used in `completion-setup-function'.
4869 (defface completions-first-difference
4870 '((t (:inherit bold)))
4871 "Face put on the first uncommon character in completions in *Completions* buffer."
4872 :group 'completion)
4874 (defface completions-common-part
4875 '((t (:inherit default)))
4876 "Face put on the common prefix substring in completions in *Completions* buffer.
4877 The idea of `completions-common-part' is that you can use it to
4878 make the common parts less visible than normal, so that the rest
4879 of the differing parts is, by contrast, slightly highlighted."
4880 :group 'completion)
4882 ;; This is for packages that need to bind it to a non-default regexp
4883 ;; in order to make the first-differing character highlight work
4884 ;; to their liking
4885 (defvar completion-root-regexp "^/"
4886 "Regexp to use in `completion-setup-function' to find the root directory.")
4888 (defvar completion-common-substring nil
4889 "Common prefix substring to use in `completion-setup-function' to put faces.
4890 The value is set by `display-completion-list' during running `completion-setup-hook'.
4892 To put faces, `completions-first-difference' and `completions-common-part'
4894 needed as a hint. (Minibuffer is a special case. The content of minibuffer itself
4895 is the substring.)")
4897 ;; This function goes in completion-setup-hook, so that it is called
4898 ;; after the text of the completion list buffer is written.
4899 (defun completion-setup-function ()
4900 (let* ((mainbuf (current-buffer))
4901 (mbuf-contents (minibuffer-contents))
4902 (common-string-length (length mbuf-contents)))
4903 ;; When reading a file name in the minibuffer,
4904 ;; set default-directory in the minibuffer
4905 ;; so it will get copied into the completion list buffer.
4906 (if minibuffer-completing-file-name
4907 (with-current-buffer mainbuf
4908 (setq default-directory (file-name-directory mbuf-contents))))
4909 ;; If partial-completion-mode is on, point might not be after the
4910 ;; last character in the minibuffer.
4911 ;; FIXME: This still doesn't work if the text to be completed
4912 ;; starts with a `-'.
4913 (when (and partial-completion-mode (not (eobp)))
4914 (setq common-string-length
4915 (- common-string-length (- (point) (point-max)))))
4916 (with-current-buffer standard-output
4917 (completion-list-mode)
4918 (set (make-local-variable 'completion-reference-buffer) mainbuf)
4919 (if minibuffer-completing-file-name
4920 ;; For file name completion,
4921 ;; use the number of chars before the start of the
4922 ;; last file name component.
4923 (setq completion-base-size
4924 (with-current-buffer mainbuf
4925 (save-excursion
4926 (goto-char (point-max))
4927 (skip-chars-backward completion-root-regexp)
4928 (- (point) (minibuffer-prompt-end)))))
4929 ;; Otherwise, in minibuffer, the whole input is being completed.
4930 (if (minibufferp mainbuf)
4931 (if (and (symbolp minibuffer-completion-table)
4932 (get minibuffer-completion-table 'completion-base-size-function))
4933 (setq completion-base-size
4934 (funcall (get minibuffer-completion-table 'completion-base-size-function)))
4935 (setq completion-base-size 0))))
4936 ;; Put faces on first uncommon characters and common parts.
4937 (when (or completion-common-substring completion-base-size)
4938 (setq common-string-length
4939 (if completion-common-substring
4940 (length completion-common-substring)
4941 (- common-string-length completion-base-size)))
4942 (let ((element-start (point-min))
4943 (maxp (point-max))
4944 element-common-end)
4945 (while (and (setq element-start
4946 (next-single-property-change
4947 element-start 'mouse-face))
4948 (< (setq element-common-end
4949 (+ element-start common-string-length))
4950 maxp))
4951 (when (and (get-char-property element-start 'mouse-face)
4952 (get-char-property element-common-end 'mouse-face))
4953 (put-text-property element-start element-common-end
4954 'font-lock-face 'completions-common-part)
4955 (put-text-property element-common-end (1+ element-common-end)
4956 'font-lock-face 'completions-first-difference)))))
4957 ;; Insert help string.
4958 (goto-char (point-min))
4959 (if (display-mouse-p)
4960 (insert (substitute-command-keys
4962 (insert (substitute-command-keys
4966 (add-hook 'completion-setup-hook 'completion-setup-function)
4968 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
4969 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
4971 (defun switch-to-completions ()
4972 "Select the completion list window."
4973 (interactive)
4974 ;; Make sure we have a completions window.
4975 (or (get-buffer-window "*Completions*")
4976 (minibuffer-completion-help))
4977 (let ((window (get-buffer-window "*Completions*")))
4978 (when window
4979 (select-window window)
4980 (goto-char (point-min))
4982 (forward-line 1))))
4984 ;; Support keyboard commands to turn on various modifiers.
4986 ;; These functions -- which are not commands -- each add one modifier
4987 ;; to the following event.
4989 (defun event-apply-alt-modifier (ignore-prompt)
4992 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
4993 (defun event-apply-super-modifier (ignore-prompt)
4996 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
4997 (defun event-apply-hyper-modifier (ignore-prompt)
5000 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
5001 (defun event-apply-shift-modifier (ignore-prompt)
5004 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
5005 (defun event-apply-control-modifier (ignore-prompt)
5008 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
5009 (defun event-apply-meta-modifier (ignore-prompt)
5012 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
5014 (defun event-apply-modifier (event symbol lshiftby prefix)
5015 "Apply a modifier flag to event EVENT.
5016 SYMBOL is the name of this modifier, as a symbol.
5017 LSHIFTBY is the numeric value of this modifier, in keyboard events.
5018 PREFIX is the string that represents this modifier in an event type symbol."
5019 (if (numberp event)
5020 (cond ((eq symbol 'control)
5021 (if (and (<= (downcase event) ?z)
5022 (>= (downcase event) ?a))
5023 (- (downcase event) ?a -1)
5024 (if (and (<= (downcase event) ?Z)
5025 (>= (downcase event) ?A))
5026 (- (downcase event) ?A -1)
5027 (logior (lsh 1 lshiftby) event))))
5028 ((eq symbol 'shift)
5029 (if (and (<= (downcase event) ?z)
5030 (>= (downcase event) ?a))
5031 (upcase event)
5032 (logior (lsh 1 lshiftby) event)))
5033 (t
5034 (logior (lsh 1 lshiftby) event)))
5035 (if (memq symbol (event-modifiers event))
5036 event
5037 (let ((event-type (if (symbolp event) event (car event))))
5038 (setq event-type (intern (concat prefix (symbol-name event-type))))
5039 (if (symbolp event)
5040 event-type
5041 (cons event-type (cdr event)))))))
5043 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
5044 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
5045 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
5046 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
5047 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
5048 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
5050 ;;;; Keypad support.
5052 ;;; Make the keypad keys act like ordinary typing keys. If people add
5053 ;;; bindings for the function key symbols, then those bindings will
5054 ;;; override these, so this shouldn't interfere with any existing
5055 ;;; bindings.
5057 ;; Also tell read-char how to handle these keys.
5058 (mapc
5059 (lambda (keypad-normal)
5060 (let ((keypad (nth 0 keypad-normal))
5061 (normal (nth 1 keypad-normal)))
5062 (put keypad 'ascii-character normal)
5063 (define-key function-key-map (vector keypad) (vector normal))))
5064 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
5065 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
5066 (kp-space ?\s)
5069 (kp-multiply ?*)
5070 (kp-add ?+)
5071 (kp-separator ?,)
5072 (kp-subtract ?-)
5073 (kp-decimal ?.)
5074 (kp-divide ?/)
5075 (kp-equal ?=)))
5076 \f
5077 ;;;;
5078 ;;;; forking a twin copy of a buffer.
5079 ;;;;
5081 (defvar clone-buffer-hook nil
5082 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
5084 (defun clone-process (process &optional newname)
5085 "Create a twin copy of PROCESS.
5086 If NEWNAME is nil, it defaults to PROCESS' name;
5087 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
5088 If PROCESS is associated with a buffer, the new process will be associated
5089 with the current buffer instead.
5090 Returns nil if PROCESS has already terminated."
5091 (setq newname (or newname (process-name process)))
5093 (setq newname (substring newname 0 (match-beginning 0))))
5094 (when (memq (process-status process) '(run stop open))
5095 (let* ((process-connection-type (process-tty-name process))
5096 (new-process
5097 (if (memq (process-status process) '(open))
5098 (let ((args (process-contact process t)))
5099 (setq args (plist-put args :name newname))
5100 (setq args (plist-put args :buffer
5101 (if (process-buffer process)
5102 (current-buffer))))
5103 (apply 'make-network-process args))
5104 (apply 'start-process newname
5105 (if (process-buffer process) (current-buffer))
5106 (process-command process)))))
5107 (set-process-query-on-exit-flag
5108 new-process (process-query-on-exit-flag process))
5109 (set-process-inherit-coding-system-flag
5110 new-process (process-inherit-coding-system-flag process))
5111 (set-process-filter new-process (process-filter process))
5112 (set-process-sentinel new-process (process-sentinel process))
5113 (set-process-plist new-process (copy-sequence (process-plist process)))
5114 new-process)))
5116 ;; things to maybe add (currently partly covered by `funcall mode'):
5117 ;; - syntax-table
5118 ;; - overlays
5119 (defun clone-buffer (&optional newname display-flag)
5120 "Create and return a twin copy of the current buffer.
5121 Unlike an indirect buffer, the new buffer can be edited
5122 independently of the old one (if it is not read-only).
5123 NEWNAME is the name of the new buffer. It may be modified by
5124 adding or incrementing <N> at the end as necessary to create a
5125 unique buffer name. If nil, it defaults to the name of the
5126 current buffer, with the proper suffix. If DISPLAY-FLAG is
5127 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
5128 clone a file-visiting buffer, or a buffer whose major mode symbol
5129 has a non-nil `no-clone' property, results in an error.
5131 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
5132 current buffer with appropriate suffix. However, if a prefix
5133 argument is given, then the command prompts for NEWNAME in the
5134 minibuffer.
5136 This runs the normal hook `clone-buffer-hook' in the new buffer
5137 after it has been set up properly in other respects."
5138 (interactive
5139 (progn
5140 (if buffer-file-name
5141 (error "Cannot clone a file-visiting buffer"))
5142 (if (get major-mode 'no-clone)
5143 (error "Cannot clone a buffer in %s mode" mode-name))
5144 (list (if current-prefix-arg (read-string "Name: "))
5145 t)))
5146 (if buffer-file-name
5147 (error "Cannot clone a file-visiting buffer"))
5148 (if (get major-mode 'no-clone)
5149 (error "Cannot clone a buffer in %s mode" mode-name))
5150 (setq newname (or newname (buffer-name)))
5152 (setq newname (substring newname 0 (match-beginning 0))))
5153 (let ((buf (current-buffer))
5154 (ptmin (point-min))
5155 (ptmax (point-max))
5156 (pt (point))
5157 (mk (if mark-active (mark t)))
5158 (modified (buffer-modified-p))
5159 (mode major-mode)
5160 (lvars (buffer-local-variables))
5161 (process (get-buffer-process (current-buffer)))
5162 (new (generate-new-buffer (or newname (buffer-name)))))
5163 (save-restriction
5164 (widen)
5165 (with-current-buffer new
5166 (insert-buffer-substring buf)))
5167 (with-current-buffer new
5168 (narrow-to-region ptmin ptmax)
5169 (goto-char pt)
5170 (if mk (set-mark mk))
5171 (set-buffer-modified-p modified)
5173 ;; Clone the old buffer's process, if any.
5174 (when process (clone-process process))
5176 ;; Now set up the major mode.
5177 (funcall mode)
5179 ;; Set up other local variables.
5180 (mapcar (lambda (v)
5181 (condition-case () ;in case var is read-only
5182 (if (symbolp v)
5183 (makunbound v)
5184 (set (make-local-variable (car v)) (cdr v)))
5185 (error nil)))
5186 lvars)
5188 ;; Run any hooks (typically set up by the major mode
5189 ;; for cloning to work properly).
5190 (run-hooks 'clone-buffer-hook))
5191 (if display-flag (pop-to-buffer new))
5192 new))
5195 (defun clone-indirect-buffer (newname display-flag &optional norecord)
5196 "Create an indirect buffer that is a twin copy of the current buffer.
5198 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
5199 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
5200 or if not called with a prefix arg, NEWNAME defaults to the current
5201 buffer's name. The name is modified by adding a `<N>' suffix to it
5202 or by incrementing the N in an existing suffix.
5204 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
5205 This is always done when called interactively.
5207 Optional third arg NORECORD non-nil means do not put this buffer at the
5208 front of the list of recently selected ones."
5209 (interactive
5210 (progn
5211 (if (get major-mode 'no-clone-indirect)
5212 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
5213 (list (if current-prefix-arg
5214 (read-string "BName of indirect buffer: "))
5215 t)))
5216 (if (get major-mode 'no-clone-indirect)
5217 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
5218 (setq newname (or newname (buffer-name)))
5220 (setq newname (substring newname 0 (match-beginning 0))))
5221 (let* ((name (generate-new-buffer-name newname))
5222 (buffer (make-indirect-buffer (current-buffer) name t)))
5223 (when display-flag
5224 (pop-to-buffer buffer norecord))
5225 buffer))
5228 (defun clone-indirect-buffer-other-window (buffer &optional norecord)
5229 "Create an indirect buffer that is a twin copy of BUFFER.
5230 Select the new buffer in another window.
5231 Optional second arg NORECORD non-nil means do not put this buffer at
5232 the front of the list of recently selected ones."
5233 (interactive "bClone buffer in other window: ")
5234 (let ((pop-up-windows t))
5235 (set-buffer buffer)
5236 (clone-indirect-buffer nil t norecord)))
5238 \f
5239 ;;; Handling of Backspace and Delete keys.
5241 (defcustom normal-erase-is-backspace
5242 (and (not noninteractive)
5243 (or (memq system-type '(ms-dos windows-nt))
5244 (eq window-system 'mac)
5245 (and (memq window-system '(x))
5246 (fboundp 'x-backspace-delete-keys-p)
5247 (x-backspace-delete-keys-p))
5248 ;; If the terminal Emacs is running on has erase char
5249 ;; set to ^H, use the Backspace key for deleting
5250 ;; backward and, and the Delete key for deleting forward.
5251 (and (null window-system)
5252 (eq tty-erase-char ?\^H))))
5253 "If non-nil, Delete key deletes forward and Backspace key deletes backward.
5255 On window systems, the default value of this option is chosen
5256 according to the keyboard used. If the keyboard has both a Backspace
5257 key and a Delete key, and both are mapped to their usual meanings, the
5258 option's default value is set to t, so that Backspace can be used to
5259 delete backward, and Delete can be used to delete forward.
5261 If not running under a window system, customizing this option accomplishes
5262 a similar effect by mapping C-h, which is usually generated by the
5263 Backspace key, to DEL, and by mapping DEL to C-d via
5264 `keyboard-translate'. The former functionality of C-h is available on
5265 the F1 key. You should probably not use this setting if you don't
5266 have both Backspace, Delete and F1 keys.
5268 Setting this variable with setq doesn't take effect. Programmatically,
5269 call `normal-erase-is-backspace-mode' (which see) instead."
5270 :type 'boolean
5271 :group 'editing-basics
5272 :version "21.1"
5273 :set (lambda (symbol value)
5274 ;; The fboundp is because of a problem with :set when
5275 ;; dumping Emacs. It doesn't really matter.
5276 (if (fboundp 'normal-erase-is-backspace-mode)
5277 (normal-erase-is-backspace-mode (or value 0))
5278 (set-default symbol value))))
5281 (defun normal-erase-is-backspace-mode (&optional arg)
5282 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
5284 With numeric arg, turn the mode on if and only if ARG is positive.
5286 On window systems, when this mode is on, Delete is mapped to C-d and
5287 Backspace is mapped to DEL; when this mode is off, both Delete and
5288 Backspace are mapped to DEL. (The remapping goes via
5289 `function-key-map', so binding Delete or Backspace in the global or
5290 local keymap will override that.)
5292 In addition, on window systems, the bindings of C-Delete, M-Delete,
5293 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
5294 the global keymap in accordance with the functionality of Delete and
5295 Backspace. For example, if Delete is remapped to C-d, which deletes
5296 forward, C-Delete is bound to `kill-word', but if Delete is remapped
5297 to DEL, which deletes backward, C-Delete is bound to
5298 `backward-kill-word'.
5300 If not running on a window system, a similar effect is accomplished by
5301 remapping C-h (normally produced by the Backspace key) and DEL via
5302 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
5303 to C-d; if it's off, the keys are not remapped.
5305 When not running on a window system, and this mode is turned on, the
5306 former functionality of C-h is available on the F1 key. You should
5307 probably not turn on this mode on a text-only terminal if you don't
5308 have both Backspace, Delete and F1 keys.
5310 See also `normal-erase-is-backspace'."
5311 (interactive "P")
5312 (setq normal-erase-is-backspace
5313 (if arg
5314 (> (prefix-numeric-value arg) 0)
5315 (not normal-erase-is-backspace)))
5317 (cond ((or (memq window-system '(x w32 mac pc))
5318 (memq system-type '(ms-dos windows-nt)))
5319 (let ((bindings
5320 `(([C-delete] [C-backspace])
5321 ([M-delete] [M-backspace])
5322 ([C-M-delete] [C-M-backspace])
5323 (,esc-map
5324 [C-delete] [C-backspace])))
5325 (old-state (lookup-key function-key-map [delete])))
5327 (if normal-erase-is-backspace
5328 (progn
5329 (define-key function-key-map [delete] [?\C-d])
5330 (define-key function-key-map [kp-delete] [?\C-d])
5331 (define-key function-key-map [backspace] [?\C-?]))
5332 (define-key function-key-map [delete] [?\C-?])
5333 (define-key function-key-map [kp-delete] [?\C-?])
5334 (define-key function-key-map [backspace] [?\C-?]))
5336 ;; Maybe swap bindings of C-delete and C-backspace, etc.
5337 (unless (equal old-state (lookup-key function-key-map [delete]))
5338 (dolist (binding bindings)
5339 (let ((map global-map))
5340 (when (keymapp (car binding))
5341 (setq map (car binding) binding (cdr binding)))
5342 (let* ((key1 (nth 0 binding))
5343 (key2 (nth 1 binding))
5344 (binding1 (lookup-key map key1))
5345 (binding2 (lookup-key map key2)))
5346 (define-key map key1 binding2)
5347 (define-key map key2 binding1)))))))
5348 (t
5349 (if normal-erase-is-backspace
5350 (progn
5351 (keyboard-translate ?\C-h ?\C-?)
5352 (keyboard-translate ?\C-? ?\C-d))
5353 (keyboard-translate ?\C-h ?\C-h)
5354 (keyboard-translate ?\C-? ?\C-?))))
5356 (run-hooks 'normal-erase-is-backspace-hook)
5357 (if (interactive-p)
5358 (message "Delete key deletes %s"
5359 (if normal-erase-is-backspace "forward" "backward"))))
5360 \f
5361 (defvar vis-mode-saved-buffer-invisibility-spec nil
5362 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
5364 (define-minor-mode visible-mode
5365 "Toggle Visible mode.
5366 With argument ARG turn Visible mode on iff ARG is positive.
5368 Enabling Visible mode makes all invisible text temporarily visible.
5369 Disabling Visible mode turns off that effect. Visible mode
5370 works by saving the value of `buffer-invisibility-spec' and setting it to nil."
5371 :lighter " Vis"
5372 :group 'editing-basics
5373 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
5374 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
5375 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
5376 (when visible-mode
5377 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
5378 buffer-invisibility-spec)
5379 (setq buffer-invisibility-spec nil)))
5380 \f
5381 ;; Minibuffer prompt stuff.
5383 ;(defun minibuffer-prompt-modification (start end)
5384 ; (error "You cannot modify the prompt"))
5385 ;
5386 ;
5387 ;(defun minibuffer-prompt-insertion (start end)
5388 ; (let ((inhibit-modification-hooks t))
5389 ; (delete-region start end)
5390 ; ;; Discard undo information for the text insertion itself
5391 ; ;; and for the text deletion.above.
5392 ; (when (consp buffer-undo-list)
5393 ; (setq buffer-undo-list (cddr buffer-undo-list)))
5394 ; (message "You cannot modify the prompt")))
5395 ;
5396 ;
5397 ;(setq minibuffer-prompt-properties
5398 ; (list 'modification-hooks '(minibuffer-prompt-modification)
5399 ; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
5400 ;
5402 (provide 'simple)
5404 ;; arch-tag: 24af67c0-2a49-44f6-b3b1-312d8b570dfd
5405 ;;; simple.el ends here