| blob | 2af4bbd1d76ada6d41133dd1195493eefe839cd5 |
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, 2006 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 "Search LIST for a valid buffer to display in FRAME.
57 Return nil when all buffers in LIST are undesirable for display,
58 otherwise return the first suitable buffer in LIST.
60 Buffers not visible in windows are preferred to visible buffers,
61 unless VISIBLE-OK is non-nil.
62 If the optional argument FRAME is nil, it defaults to the selected frame.
63 If BUFFER is non-nil, ignore occurrences of that buffer in LIST."
64 ;; This logic is more or less copied from other-buffer.
67 found buf)
80 "Return the last non-hidden displayable buffer in the buffer list.
81 If BUFFER is non-nil, last-buffer will ignore that buffer.
82 Buffers not visible in windows are preferred to visible buffers,
83 unless optional argument VISIBLE-OK is non-nil.
84 If the optional third argument FRAME is non-nil, use that frame's
85 buffer list instead of the selected frame's buffer list.
86 If no other buffer exists, the buffer `*scratch*' is returned."
89 buffer visible-ok frame)
91 buffer visible-ok frame)
97 "Switch to the next buffer in cyclic order."
107 "Switch to the previous buffer in cyclic order."
112 ;; Clean up buried-buffer-list up to and including the chosen buffer.
117 \f
118 ;;; next-error support framework
121 "`next-error' support framework."
127 "Face used to highlight next error locus."
132 "*Highlighting of locations in selected source buffers.
133 If number, highlight the locus in `next-error' face for given time in seconds.
134 If t, use persistent overlays fontified in `next-error' face.
135 If nil, don't highlight the locus in the source buffer.
136 If `fringe-arrow', indicate the locus by the fringe arrow."
145 "*Highlighting of locations in non-selected source buffers.
146 If number, highlight the locus in `next-error' face for given time in seconds.
147 If t, use persistent overlays fontified in `next-error' face.
148 If nil, don't highlight the locus in the source buffer.
149 If `fringe-arrow', indicate the locus by the fringe arrow."
158 "*List of hook functions run by `next-error' after visiting source file."
169 "The most recent `next-error' buffer.
170 A buffer becomes most recent when its compilation, grep, or
175 "Function to use to find the next error in the current buffer.
176 The function is called with 2 parameters:
177 ARG is an integer specifying by how many errors to move.
178 RESET is a boolean which, if non-nil, says to go back to the beginning
179 of the errors before moving.
180 Major modes providing compile-like functionality should set this variable
181 to indicate to `next-error' that this is a candidate buffer and how
187 &optional avoid-current
188 extra-test-inclusive
189 extra-test-exclusive)
190 "Test if BUFFER is a `next-error' capable buffer.
192 If AVOID-CURRENT is non-nil, treat the current buffer
193 as an absolute last resort only.
195 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
196 that normally would not qualify. If it returns t, the buffer
197 in question is treated as usable.
199 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
200 that would normally be considered usable. If it returns nil,
201 that buffer is rejected."
206 ;; Optionally reject some buffers.
209 t)
210 ;; Optionally accept some other buffers.
215 extra-test-inclusive
216 extra-test-exclusive)
217 "Return a `next-error' capable buffer.
219 If AVOID-CURRENT is non-nil, treat the current buffer
220 as an absolute last resort only.
222 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
223 that normally would not qualify. If it returns t, the buffer
224 in question is treated as usable.
226 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
227 that would normally be considered usable. If it returns nil,
228 that buffer is rejected."
230 ;; 1. If one window on the selected frame displays such buffer, return it.
236 avoid-current
237 extra-test-inclusive extra-test-exclusive)
242 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
245 extra-test-inclusive extra-test-exclusive))
246 next-error-last-buffer)
247 ;; 3. If the current buffer is acceptable, choose it.
249 extra-test-inclusive extra-test-exclusive)
251 ;; 4. Look for any acceptable buffer.
256 extra-test-inclusive extra-test-exclusive)))
259 ;; 5. Use the current buffer as a last resort if it qualifies,
260 ;; even despite AVOID-CURRENT.
263 extra-test-inclusive extra-test-exclusive)
267 ;; 6. Give up.
271 "Visit next `next-error' message and corresponding source code.
273 If all the error messages parsed so far have been processed already,
274 the message buffer is checked for new ones.
276 A prefix ARG specifies how many error messages to move;
277 negative means move back to previous error messages.
279 and start at the first error.
281 The RESET argument specifies that we should restart from the beginning.
284 compilation, grep, or occur buffer. It can also operate on any
286 more generally, on any buffer in Compilation mode or with
287 Compilation Minor mode enabled, or any buffer in which
288 `next-error-function' is bound to an appropriate function.
289 To specify use of a particular buffer for error messages, type
291 in the current frame.
294 runs `next-error-hook' with `run-hooks', and stays with that buffer
295 until you use it in some other buffer which uses Compilation mode
296 or Compilation Minor mode.
298 See variables `compilation-parse-errors-function' and
299 \`compilation-error-regexp-alist' for customization ideas."
303 ;; we know here that next-error-function is a valid symbol we can funcall
309 "Visit the source code corresponding to the `next-error' message at point."
311 ;; we know here that next-error-function is a valid symbol we can funcall
320 "Visit previous `next-error' message and corresponding source code.
322 Prefix arg N says how many error messages to move backwards (or
323 forwards, if negative).
330 "Restart at the first error.
331 Visit corresponding source code.
332 With prefix arg N, visit the source code of the Nth error.
338 "Move point to the next error in the `next-error' buffer and highlight match.
339 Prefix arg N says how many error messages to move forwards (or
340 backwards, if negative).
342 select the source buffer."
349 "Move point to the previous error in the `next-error' buffer and highlight match.
350 Prefix arg N says how many error messages to move backwards (or
351 forwards, if negative).
353 select the source buffer."
357 ;;; Internal variable for `next-error-follow-mode-post-command-hook'.
361 "Minor mode for compilation, occur and diff modes.
362 When turned on, cursor motion in the compilation, grep, occur or diff
363 buffer causes automatic display of the corresponding source code
364 location."
371 ;;; Used as a `post-command-hook' by `next-error-follow-mode'
372 ;;; for the *Compilation* *grep* and *Occur* buffers.
382 \f
383 ;;;
386 "Major mode not specialized for anything in particular.
387 Other major modes are defined by comparison with this one."
393 ;; Making and deleting lines.
398 "Insert a newline, and move to left margin of the new line if it's blank.
399 If `use-hard-newlines' is non-nil, the newline is marked with the
400 text-property `hard'.
401 With ARG, insert that many newlines.
402 Call `auto-fill-function' if the current column number is greater
403 than the value of `fill-column' and ARG is nil."
406 ;; Inserting a newline at the end of a line produces better redisplay in
407 ;; try_window_id than inserting at the beginning of a line, and the textual
408 ;; result is the same. So, if we're at beginning of line, pretend to be at
409 ;; the end of the previous line.
412 ;; Make sure no functions want to be told about
413 ;; the range of the changes.
416 ;; Make sure there are no markers here.
419 ;; Make sure no text properties want to know
420 ;; where the change was.
425 ;; Make sure the newline before point isn't intangible.
427 ;; Make sure the newline before point isn't read-only.
429 ;; Make sure the newline before point isn't invisible.
431 ;; Make sure the newline before point has the same
432 ;; properties as the char before it (if any).
439 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
440 ;; Set last-command-char to tell self-insert what to insert.
442 ;; Don't auto-fill if we have a numeric argument.
443 ;; Also not if flag is true (it would fill wrong line);
444 ;; there is no need to since we're at BOL.
448 ;; If we get an error in self-insert-command, put point at right place.
450 ;; Even if we did *not* get an error, keep that forward-char;
451 ;; all further processing should apply to the newline that the user
452 ;; thinks he inserted.
454 ;; Mark the newline(s) `hard'.
458 ;; If the newline leaves the previous line blank,
459 ;; and we have a left margin, delete that from the blank line.
467 ;; Indent the line after the newline, except in one case:
468 ;; when we added the newline at the beginning of a line
469 ;; which starts a page.
472 nil)
477 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
483 "Insert a newline and leave point before it.
484 If there is a fill prefix and/or a `left-margin', insert them
485 on the new line if the line would have been blank.
486 With arg N, insert N newlines."
491 ;; Don't expand an abbrev before point.
505 "Split current line, moving portion beyond point vertically down.
506 If the current line starts with `fill-prefix', insert it on the new
507 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
509 When called from Lisp code, ARG may be a prefix string to copy."
514 ;; What prefix should we check for (nil means don't).
518 ;; Does this line start with it?
529 "Join this line to previous and fix up whitespace at join.
530 If there is a fill prefix, delete it from the beginning of this line.
531 With argument, join this line to following line."
538 ;; If the second line started with the fill prefix,
539 ;; delete the prefix.
551 "On blank line, delete all surrounding blank lines, leaving just one.
552 On isolated blank line, delete that one.
553 On nonblank line, delete any immediately following blank lines."
559 ;; Set singleblank if there is just one blank line here.
566 ;; Delete preceding blank lines, and this one too if it's the only one.
575 ;; Delete following blank lines, unless the current line is blank
576 ;; and there are no following blank lines.
585 ;; Handle the special case where point is followed by newline and eob.
586 ;; Delete the line, leaving point at eob.
591 "Delete all the trailing whitespace across the current buffer.
592 All whitespace after the last non-whitespace character in a line is deleted.
594 A formfeed is not considered whitespace by this function."
601 ;; Don't delete formfeeds, even if they are considered whitespace.
608 "Insert a newline, then indent according to major mode.
609 Indentation is done using the value of `indent-line-function'.
610 In programming language modes, this is the same as TAB.
611 In some text modes, where TAB inserts a tab, this command indents to the
612 column specified by the function `current-left-margin'."
619 "Reindent current line, insert newline, then indent the new line.
620 Indentation of both lines is done according to the current major mode,
621 which means calling the current value of `indent-line-function'.
622 In programming language modes, this is the same as TAB.
623 In some text modes, where TAB inserts a tab, this indents to the
624 column specified by the function `current-left-margin'."
627 ;; Be careful to insert the newline before indenting the line.
628 ;; Otherwise, the indentation might be wrong.
637 "Read next input character and insert it.
638 This is useful for inserting control characters.
640 If the first character you type after this command is an octal digit,
641 you should type a sequence of octal digits which specify a character code.
642 Any nondigit terminates the sequence. If the terminator is a RET,
643 it is discarded; any other terminator is used itself as input.
644 The variable `read-quoted-char-radix' specifies the radix for this feature;
645 set it to 10 or 16 to use decimal or hex instead of octal.
647 In overwrite mode, this function inserts the character anyway, and
648 does not handle octal digits specially. This means that if you use
649 overwrite as your normal editing mode, you can use this function to
650 insert characters when necessary.
652 In binary overwrite mode, this function does overwrite, and octal
653 digits are interpreted as a character code. This is intended to be
654 useful for editing binary files."
661 ;; Assume character codes 0240 - 0377 stand for characters in some
662 ;; single-byte character set, and convert them to Emacs
663 ;; characters.
676 "Move forward ARG lines and position at first nonblank character."
682 "Move backward ARG lines and position at first nonblank character."
688 "Move point to the first non-whitespace character on this line."
692 ;; Move back over chars that have whitespace syntax but have the p flag.
696 "Fixup white space between objects around point.
697 Leave one space or none, according to the context."
704 nil
708 "Delete all spaces and tabs around point.
709 If BACKWARD-ONLY is non-nil, only delete spaces before point."
714 orig-pos
723 "Delete all spaces and tabs around point, leaving one space (or N spaces)."
737 \f
739 "Move point to the beginning of the buffer; leave mark at previous position.
741 With numeric arg N, put point N/10 of the way from the beginning.
743 If the buffer is narrowed, this command uses the beginning and size
744 of the accessible part of the buffer.
746 Don't use this command in Lisp programs!
747 \(goto-char (point-min)) is faster and avoids clobbering the mark."
756 ;; Avoid overflow for large buffer sizes!
764 "Move point to the end of the buffer; leave mark at previous position.
766 With numeric arg N, put point N/10 of the way from the end.
768 If the buffer is narrowed, this command uses the beginning and size
769 of the accessible part of the buffer.
771 Don't use this command in Lisp programs!
772 \(goto-char (point-max)) is faster and avoids clobbering the mark."
781 ;; Avoid overflow for large buffer sizes!
786 ;; If we went to a place in the middle of the buffer,
787 ;; adjust it to the beginning of a line.
790 ;; If the end of the buffer is not already on the screen,
791 ;; then scroll specially to put it near, but not at, the bottom.
796 "Put point at beginning and mark at end of buffer.
797 You probably should not use this function in Lisp programs;
798 it is usually a mistake for a Lisp function to use any subroutine
799 that uses or sets the mark."
804 \f
806 ;; Counting lines, one way or another.
809 "Goto line ARG, counting from line 1 at beginning of buffer.
810 Normally, move point in the current buffer.
812 displayed other buffer, and switch to it. When called from Lisp code,
813 the optional argument BUFFER specifies a buffer to switch to.
815 If there's a number in the buffer at point, it is the default for ARG."
819 ;; Look for a default, a number in the buffer at point.
828 ;; Decide if we're switching buffers.
836 ;; Read the argument, offering that number (if any) as default.
839 buffer-prompt
840 default)
841 nil nil t
842 'minibuffer-history
843 default)
844 buffer))))
845 ;; Switch to the desired buffer, one way or another.
850 ;; Move to the specified line number in that buffer.
859 "Print number of lines and characters in the region."
865 "Print the current buffer line number and narrowed line number of point."
878 "Return number of lines between START and END.
879 This is usually the number of newlines between them,
880 but can be one more if START is not equal to END
881 and the greater of them is not at the start of a line."
897 done)))
901 "Return (narrowed) buffer line number at position POS.
902 If POS is nil, use current buffer location."
912 "Print info on cursor position (on screen and within buffer).
913 Also describe the character after point, and give its character code
914 in octal, decimal and hex.
916 For a non-ASCII multibyte character, also give its encoding in the
917 buffer's selected coding system if the coding system encodes the
918 character safely. If the character is encoded into one byte, that
919 code is shown in hex. If the character is encoded into more than one
922 In addition, with prefix argument, show details about that character
923 in *Help* buffer. See also the command `describe-char'."
931 ;; Avoid overflow from multiplying by 100!
935 ""
941 pos total percent beg end col hscroll)
943 pos total col hscroll))
945 encoded encoding-msg display-prop under-display)
952 ;; Check if the character is displayed with some `display'
953 ;; text property. In that case, set under-display to the
954 ;; buffer substring covered by that property.
965 under-display)))
971 char char char under-display)
973 char char char under-display display-prop))
976 char char char
978 "..."
982 ;; We show the detailed information about CHAR.
989 encoding-msg pos total percent beg end col hscroll)
996 encoding-msg pos total percent col hscroll))))))
997 \f
1002 m)
1008 "Value for `print-level' while printing value in `eval-expression'.
1009 A value of nil means no limit."
1015 "Value for `print-length' while printing value in `eval-expression'.
1016 A value of nil means no limit."
1022 "If non-nil set `debug-on-error' to t in `eval-expression'.
1023 If nil, don't change the value of `debug-on-error'."
1029 "Format VALUE as a result of evaluated expression.
1030 Return a formatted string which is displayed in the echo area
1031 in addition to the value printed by prin1 in functions which
1032 display the result of expression evaluation."
1045 ;; We define this, rather than making `eval' interactive,
1046 ;; for the sake of completion of names like eval-region, eval-buffer.
1049 "Evaluate EVAL-EXPRESSION-ARG and print value in the echo area.
1050 Value is also consed on to front of the variable `values'.
1051 Optional argument EVAL-EXPRESSION-INSERT-VALUE, if non-nil, means
1052 insert the result into the current buffer instead of printing it in
1053 the echo area.
1055 If `eval-expression-debug-on-error' is non-nil, which is the default,
1056 this command arranges for all errors to enter the debugger."
1059 nil read-expression-map t
1061 current-prefix-arg))
1066 ;; Bind debug-on-error to something unique so that we can
1067 ;; detect when evaled code changes it.
1071 ;; If evaled code has changed the value of debug-on-error,
1072 ;; propagate that change to the global binding.
1088 "Prompting with PROMPT, let user edit COMMAND and eval result.
1089 COMMAND is a Lisp expression. Let user edit that expression in
1090 the minibuffer, then read and evaluate the result."
1097 read-expression-map t
1099 ;; If command was added to command-history as a string,
1100 ;; get rid of that. We want only evaluable expressions there.
1104 ;; If command to be redone does not match front of history,
1105 ;; add it to the history.
1111 "Edit and re-evaluate last complex command, or ARGth from last.
1112 A complex command is one which used the minibuffer.
1113 The command is placed in the minibuffer as a Lisp form for editing.
1114 The result is executed, repeating the command as changed.
1115 If the command has been changed or is not the most recent previous command
1116 it is added to the front of the command history.
1117 You can use the minibuffer history commands \\<minibuffer-local-map>\\[next-history-element] and \\[previous-history-element]
1118 to get different commands to edit and resubmit."
1121 newcmd)
1133 ;; If command was added to command-history as a
1134 ;; string, get rid of that. We want only
1135 ;; evaluable expressions there.
1139 ;; If command to be redone does not match front of history,
1140 ;; add it to the history.
1147 \f
1149 "Default minibuffer history list.
1150 This is used for all minibuffer input
1153 "Control whether history list elements are expressions or strings.
1154 If the value of this variable equals current minibuffer depth,
1155 they are expressions; otherwise they are strings.
1156 \(That convention is designed to do the right thing for
1163 "Text that was in this minibuffer before any history commands.
1164 This is nil if there have not yet been any history commands
1173 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1177 "*Minibuffer history variables for which matching should ignore case.
1178 If a history variable is a member of this list, then the
1180 commands ignore case when searching it, regardless of `case-fold-search'."
1185 "Find the previous history element that matches REGEXP.
1186 \(Previous history elements refer to earlier actions.)
1187 With prefix argument N, search for Nth previous match.
1188 If N is negative, find the next or Nth next match.
1189 Normally, history elements are matched case-insensitively if
1190 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1191 makes the search case-sensitive.
1192 See also `minibuffer-history-case-insensitive-variables'."
1196 nil
1197 minibuffer-local-map
1198 nil
1199 'minibuffer-history-search-history
1201 ;; Use the last regexp specified, by default, if input is empty.
1206 regexp)
1216 ;; On some systems, ignore case for file names.
1218 minibuffer-history-case-insensitive-variables)
1219 t
1220 ;; Respect the user's setting for case-fold-search:
1221 case-fold-search)
1222 nil))
1223 prevpos
1224 match-string
1225 match-offset
1232 "No later matching history item"
1253 next-matching-history-element))
1257 "Find the next history element that matches REGEXP.
1258 \(The next history element refers to a more recent action.)
1259 With prefix argument N, search for Nth next match.
1260 If N is negative, find the previous or Nth previous match.
1261 Normally, history elements are matched case-insensitively if
1262 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1263 makes the search case-sensitive."
1267 nil
1268 minibuffer-local-map
1269 nil
1270 'minibuffer-history-search-history
1272 ;; Use the last regexp specified, by default, if input is empty.
1277 regexp)
1284 "Puts next element of the minibuffer history in the minibuffer.
1285 With argument N, it uses the Nth following element."
1290 elt minibuffer-returned-to-present)
1302 previous-history-element))
1324 elt))
1328 "Puts previous element of the minibuffer history in the minibuffer.
1329 With argument N, it uses the Nth previous element."
1334 "Get next history element which completes the minibuffer before the point.
1335 The contents of the minibuffer after the point are deleted, and replaced
1336 by the new completion."
1342 n)
1343 ;; next-matching-history-element always puts us at (point-min).
1344 ;; Move to the position we were at before changing the buffer contents.
1345 ;; This is still sensical, because the text before point has not changed.
1349 "\
1350 Get previous history element which completes the minibuffer before the point.
1351 The contents of the minibuffer after the point are deleted, and replaced
1352 by the new completion."
1356 ;; For compatibility with the old subr of the same name.
1358 "Return the display width of the minibuffer prompt.
1359 Return 0 if current buffer is not a minibuffer."
1360 ;; Return the width of everything before the field at the end of
1361 ;; the buffer; this should be 0 for normal buffers.
1363 \f
1364 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
1368 "Table mapping redo records to the corresponding undo one.
1369 A redo record for undo-in-region maps to t.
1379 "Within a run of consecutive undo commands, list remaining to be undone.
1383 "Undo some previous changes.
1384 Repeat this command to undo more changes.
1385 A numeric argument serves as a repeat count.
1387 In Transient Mark mode when the mark is active, only undo changes within
1389 as an argument limits undo to changes within the current region."
1391 ;; Make last-command indicate for the next command that this was an undo.
1392 ;; That way, another undo will undo more.
1393 ;; If we get to the end of the undo history and get an error,
1394 ;; another undo command will find the undo history empty
1395 ;; and will get another error. To begin undoing the undos,
1396 ;; you must type some other command.
1399 message)
1400 ;; If we get an error in undo-start,
1401 ;; the next command should not be a "consecutive undo".
1402 ;; So set `this-command' to something other than `undo'.
1407 ;; If something (a timer or filter?) changed the buffer
1408 ;; since the previous command, don't continue the undo seq.
1412 ;; If the last undo record made was made by undo
1413 ;; it shows nothing else happened in between.
1420 ;; get rid of initial undo boundary
1422 ;; If we got this far, the next command should be a consecutive undo.
1424 ;; Check to see whether we're hitting a redo record, and if
1425 ;; so, ask the user whether she wants to skip the redo/undo pair.
1432 ;; The equiv entry might point to another redo record if we have done
1433 ;; undo-redo-undo-redo-... so skip to the very last equiv.
1441 ;; Record the fact that the just-generated undo records come from an
1442 ;; undo operation--that is, they are redo records.
1443 ;; In the ordinary case (not within a region), map the redo
1444 ;; record to the following undos.
1445 ;; I don't know how to do that in the undo-in-region case.
1448 undo-equiv-table)
1449 ;; Don't specify a position in the undo record for the undo command.
1450 ;; Instead, undoing this should move point to where the change is.
1469 ;; Record what the current undo list says,
1470 ;; so the next command can tell if the buffer was modified in between.
1473 ;; Display a message announcing success.
1478 "Make BUFFER stop keeping undo information.
1479 No argument or nil as argument means do this for the current buffer."
1485 "Undo some previous changes.
1486 Repeat this command to undo more changes.
1487 A numeric argument serves as a repeat count.
1488 Contrary to `undo', this will not redo a previous undo."
1493 "Non-nil while performing an undo.
1497 "Undo back N undo-boundaries beyond what was already undone recently.
1498 Call `undo-start' to get ready to undo recent changes,
1499 then call `undo-more' one or more times to undo them."
1509 ;; Deep copy of a list
1511 "Make a copy of undo list LIST."
1517 elt))
1520 "Set `pending-undo-list' to the front of the undo list.
1521 The next call to `undo-more' will undo the most recently made change.
1522 If BEG and END are specified, then only undo elements
1523 that apply to text between BEG and END are used; other undo elements
1524 are ignored. If BEG and END are nil, all undo elements are used."
1530 buffer-undo-list)))
1535 "Return a list of undo elements for the region START to END.
1536 The elements come from `buffer-undo-list', but we keep only
1537 the elements inside this region, and discard those outside this region.
1538 If we find an element that crosses an edge of this region,
1539 we stop and ignore all further elements."
1542 undo-adjusted-markers
1543 some-rejected
1544 undo-elt undo-elt temp-undo-list delta)
1549 ;; This is a "was unmodified" element.
1550 ;; Keep it if we have kept everything thus far.
1557 ;; Don't put two nils together in the list
1571 ;; Loop down the earlier events adjusting their buffer
1572 ;; positions to reflect the fact that a change to the buffer
1573 ;; isn't being undone. We only need to process those element
1574 ;; types which undo-elt-in-region will return as being in
1575 ;; the region since only those types can ever get into the
1576 ;; output
1585 ;; (TEXT . POSITION)
1592 ;; (BEGIN . END)
1597 ;; (nil PROPERTY VALUE BEG . END)
1607 "Determine whether UNDO-ELT falls inside the region START ... END.
1608 If it crosses the edge, we return nil."
1613 t)
1615 nil)
1617 ;; (TEXT . POSITION)
1621 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
1622 ;; See if MARKER is inside the region.
1633 ;; (nil PROPERTY VALUE BEG . END)
1638 ;; (BEGIN . END)
1643 "Test whether UNDO-ELT crosses one edge of that region START ... END.
1644 This assumes we have already decided that UNDO-ELT
1645 is not *inside* the region START...END."
1648 ;; (nil PROPERTY VALUE BEG . END)
1653 ;; (BEGIN . END)
1657 ;; Return the first affected buffer position and the delta for an undo element
1658 ;; delta is defined as the change in subsequent buffer positions if we *did*
1659 ;; the undo.
1663 ;; (TEXT . POSITION)
1666 ;; (BEGIN . END)
1673 "If non-nil ask about discarding undo info for the current command.
1674 Normally, Emacs discards the undo info for the current command if
1675 it exceeds `undo-outer-limit'. But if you set this option
1676 non-nil, it asks in the echo area whether to discard the info.
1677 If you answer no, there a slight risk that Emacs might crash, so
1678 only do it if you really want to undo the command.
1680 This option is mainly intended for debugging. You have to be
1681 careful if you use it for other purposes. Garbage collection is
1682 inhibited while the question is asked, meaning that Emacs might
1683 leak memory. So you should make sure that you do not wait
1684 excessively long before answering the question."
1690 "If non-nil, an extra level of size that's ok in an undo item.
1691 We don't ask the user about truncating the undo list until the
1692 current item gets bigger than this amount.
1697 ;; When the first undo batch in an undo list is longer than
1698 ;; undo-outer-limit, this function gets called to warn the user that
1699 ;; the undo info for the current command was discarded. Garbage
1700 ;; collection is inhibited around the call, so it had better not do a
1701 ;; lot of consing.
1707 ;; Don't ask the question again unless it gets even bigger.
1708 ;; This applies, in particular, if the user quits from the question.
1709 ;; Such a quit quits out of GC, but something else will call GC
1710 ;; again momentarily. It will call this function again,
1711 ;; but we don't want to ask the question again.
1718 t)
1719 nil))
1724 "The undo info was discarded because it exceeded \
1725 `undo-outer-limit'.
1727 This is normal if you executed a command that made a huge change
1728 to the buffer. In that case, to prevent similar problems in the
1729 future, set `undo-outer-limit' to a value that is large enough to
1730 cover the maximum size of normal changes you expect a single
1731 command to make, but not so large that it might exceed the
1732 maximum memory allotted to Emacs.
1734 If you did not execute any such command, the situation is
1735 probably due to a bug and you should report it.
1737 You can disable the popping up of this buffer by adding the entry
1741 t))
1742 \f
1750 "*Buffer name for `shell-command' and `shell-command-on-region' error output.
1751 This buffer is used when `shell-command' or `shell-command-on-region'
1752 is run interactively. A value of nil means that output to stderr and
1756 "Execute string COMMAND in inferior shell; display output, if any.
1757 With prefix argument, insert the COMMAND's output at point.
1759 If COMMAND ends in ampersand, execute it asynchronously.
1760 The output appears in the buffer `*Async Shell Command*'.
1761 That buffer is in shell mode.
1763 Otherwise, COMMAND is executed synchronously. The output appears in
1764 the buffer `*Shell Command Output*'. If the output is short enough to
1765 display in the echo area (which is determined by the variables
1766 `resize-mini-windows' and `max-mini-window-height'), it is shown
1767 there, but it is nonetheless available in buffer `*Shell Command
1768 Output*' even though that buffer is not automatically displayed.
1770 To specify a coding system for converting non-ASCII characters
1772 before this command.
1774 Noninteractive callers can specify coding systems by binding
1775 `coding-system-for-read' and `coding-system-for-write'.
1777 The optional second argument OUTPUT-BUFFER, if non-nil,
1778 says to put the output in some other buffer.
1779 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
1780 If OUTPUT-BUFFER is not a buffer and not nil,
1781 insert output in current buffer. (This cannot be done asynchronously.)
1782 In either case, the output is inserted after point (leaving mark after it).
1784 If the command terminates without error, but generates output,
1786 the output can be displayed in the echo area or in its buffer.
1787 If the output is short enough to display in the echo area
1788 \(determined by the variable `max-mini-window-height' if
1789 `resize-mini-windows' is non-nil), it is shown there. Otherwise,
1790 the buffer containing the output is displayed.
1794 of the output.
1796 If there is no output, or if output is inserted in the current buffer,
1797 then `*Shell Command Output*' is deleted.
1799 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
1800 or buffer name to which to direct the command's standard error output.
1801 If it is nil, error output is mingled with regular output.
1802 In an interactive call, the variable `shell-command-default-error-buffer'
1803 specifies the value of ERROR-BUFFER."
1807 current-prefix-arg
1808 shell-command-default-error-buffer))
1809 ;; Look for a handler in case default-directory is a remote file name.
1817 ;; Output goes in current buffer.
1823 temporary-file-directory)))
1824 nil)))
1827 ;; We do not use -f for csh; we will not support broken use of
1828 ;; .cshrcs. Even the BSD csh manual says to use
1829 ;; "if ($?prompt) exit" before things which are not useful
1830 ;; non-interactively. Besides, if someone wants their other
1831 ;; aliases for shell commands then they can still have them.
1835 t)
1836 nil shell-command-switch command)
1843 ;; Do no formatting while reading error file,
1844 ;; because that can run a shell command, and we
1845 ;; don't want that to cause an infinite recursion.
1847 ;; Put point after the inserted errors.
1851 ;; This is like exchange-point-and-mark, but doesn't
1852 ;; activate the mark. It is cleaner to avoid activation,
1853 ;; even though the command loop would deactivate the mark
1854 ;; because we inserted text.
1858 ;; Output goes in a separate buffer.
1859 ;; Preserve the match data in case called from a program.
1862 ;; Command ending with ampersand means asynchronous.
1866 proc)
1867 ;; Remove the ampersand.
1869 ;; If will kill a process, query first.
1881 shell-command-switch command))
1885 ))
1887 output-buffer nil error-buffer)))))))
1891 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
1892 MESSAGE may be either a string or a buffer.
1894 A buffer is displayed using `display-buffer' if MESSAGE is too long for
1895 the maximum height of the echo area, as defined by `max-mini-window-height'
1896 if `resize-mini-windows' is non-nil.
1898 Returns either the string shown in the echo area, or when a pop-up
1899 buffer is used, the window used to display it.
1901 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
1902 name of the buffer used to display it in the case where a pop-up buffer
1903 is used, defaulting to `*Message*'. In the case where MESSAGE is a
1904 string and it is displayed in the echo area, it is not specified whether
1905 the contents are inserted into the buffer anyway.
1907 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
1908 and only used if a buffer is displayed."
1912 ;; Trivial case where we can use the echo area
1917 ;; Trivial case where we can just remove single trailing newline
1920 ;; General case
1923 message
1932 0
1936 (<= lines
1940 max-mini-window-height))
1942 max-mini-window-height)
1946 ;; Don't use the echo area if the output buffer is
1947 ;; already dispayed in the selected frame.
1949 ;; Echo area
1955 ;; Buffer
1958 not-this-window frame))))))))
1961 ;; We have a sentinel to prevent insertion of a termination message
1962 ;; in the buffer itself.
1970 &optional output-buffer replace
1971 error-buffer display-error-buffer)
1972 "Execute string COMMAND in inferior shell with region as input.
1973 Normally display output (if any) in temp buffer `*Shell Command Output*';
1974 Prefix arg means replace the region with it. Return the exit code of
1975 COMMAND.
1977 To specify a coding system for converting non-ASCII characters
1979 before this command. By default, the input (from the current buffer)
1980 is encoded in the same coding system that will be used to save the file,
1981 `buffer-file-coding-system'. If the output is going to replace the region,
1982 then it is decoded from that same coding system.
1984 The noninteractive arguments are START, END, COMMAND,
1985 OUTPUT-BUFFER, REPLACE, ERROR-BUFFER, and DISPLAY-ERROR-BUFFER.
1986 Noninteractive callers can specify coding systems by binding
1987 `coding-system-for-read' and `coding-system-for-write'.
1989 If the command generates output, the output may be displayed
1990 in the echo area or in a buffer.
1991 If the output is short enough to display in the echo area
1992 \(determined by the variable `max-mini-window-height' if
1993 `resize-mini-windows' is non-nil), it is shown there. Otherwise
1994 it is displayed in the buffer `*Shell Command Output*'. The output
1995 is available in that buffer in both cases.
1997 If there is output and an error, a message about the error
1998 appears at the end of the output.
2000 If there is no output, or if output is inserted in the current buffer,
2001 then `*Shell Command Output*' is deleted.
2003 If the optional fourth argument OUTPUT-BUFFER is non-nil,
2004 that says to put the output in some other buffer.
2005 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2006 If OUTPUT-BUFFER is not a buffer and not nil,
2007 insert output in the current buffer.
2008 In either case, the output is inserted after point (leaving mark after it).
2010 If REPLACE, the optional fifth argument, is non-nil, that means insert
2011 the output in place of text from START to END, putting point and mark
2012 around it.
2014 If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
2015 or buffer name to which to direct the command's standard error output.
2016 If it is nil, error output is mingled with regular output.
2017 If DISPLAY-ERROR-BUFFER is non-nil, display the error buffer if there
2018 were any errors. (This is always t, interactively.)
2019 In an interactive call, the variable `shell-command-default-error-buffer'
2020 specifies the value of ERROR-BUFFER."
2024 ;; Do this before calling region-beginning
2025 ;; and region-end, in case subprocess output
2026 ;; relocates them while we are in the minibuffer.
2028 nil nil nil
2030 ;; call-interactively recognizes region-beginning and
2031 ;; region-end specially, leaving them in the history.
2033 string
2034 current-prefix-arg
2035 current-prefix-arg
2036 shell-command-default-error-buffer
2037 t)))
2043 temporary-file-directory)))
2044 nil))
2045 exit-status)
2049 ;; Replace specified region with output from command.
2051 ;; Don't muck with mark unless REPLACE says we should.
2058 t)
2059 nil shell-command-switch command))
2060 ;; It is rude to delete a buffer which the command is not using.
2061 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
2062 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
2063 ;; (kill-buffer shell-buffer)))
2064 ;; Don't muck with mark unless REPLACE says we should.
2066 ;; No prefix argument: put the output in a temp buffer,
2067 ;; replacing its entire contents.
2072 ;; If the input is the same buffer as the output,
2073 ;; delete everything but the specified region,
2074 ;; then replace that region with the output.
2080 shell-file-name t
2083 t)
2084 nil shell-command-switch
2085 command)))
2086 ;; Clear the output buffer, then run the command with
2087 ;; output there.
2099 buffer)
2100 nil shell-command-switch command)))
2101 ;; Report the output.
2111 ;; There's some output, display it
2113 ;; No output; error?
2117 "some error output"
2123 output))
2126 exit-status))
2129 exit-status output))))
2130 ;; Don't kill: there might be useful info in the undo-log.
2131 ;; (kill-buffer buffer)
2132 ))))
2140 ;; Do no formatting while reading error file,
2141 ;; because that can run a shell command, and we
2142 ;; don't want that to cause an infinite recursion.
2144 ;; Put point after the inserted errors.
2149 exit-status))
2152 "Execute shell command COMMAND and return its output as a string."
2155 standard-output
2159 "Process files synchronously in a separate process.
2160 Similar to `call-process', but may invoke a file handler based on
2161 `default-directory'. The current working directory of the
2162 subprocess is `default-directory'.
2164 File names in INFILE and BUFFER are handled normally, but file
2165 names in ARGS should be relative to `default-directory', as they
2166 are passed to the process verbatim. \(This is a difference to
2167 `call-process' which does not support file handlers for INFILE
2168 and BUFFER.\)
2170 Some file handlers might not support all variants, for example
2171 they might behave as if DISPLAY was nil, regardless of the actual
2172 value passed."
2174 lc stderr-file)
2184 display args)
2190 \f
2194 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
2195 (define-key map [switch-frame] nil)
2196 (define-key map [?\C-u] 'universal-argument-more)
2197 (define-key map [?-] 'universal-argument-minus)
2198 (define-key map [?0] 'digit-argument)
2199 (define-key map [?1] 'digit-argument)
2200 (define-key map [?2] 'digit-argument)
2201 (define-key map [?3] 'digit-argument)
2202 (define-key map [?4] 'digit-argument)
2203 (define-key map [?5] 'digit-argument)
2204 (define-key map [?6] 'digit-argument)
2205 (define-key map [?7] 'digit-argument)
2206 (define-key map [?8] 'digit-argument)
2207 (define-key map [?9] 'digit-argument)
2208 (define-key map [kp-0] 'digit-argument)
2209 (define-key map [kp-1] 'digit-argument)
2210 (define-key map [kp-2] 'digit-argument)
2211 (define-key map [kp-3] 'digit-argument)
2212 (define-key map [kp-4] 'digit-argument)
2213 (define-key map [kp-5] 'digit-argument)
2214 (define-key map [kp-6] 'digit-argument)
2215 (define-key map [kp-7] 'digit-argument)
2216 (define-key map [kp-8] 'digit-argument)
2217 (define-key map [kp-9] 'digit-argument)
2218 (define-key map [kp-subtract] 'universal-argument-minus)
2219 map)
2222 (defvar universal-argument-num-events nil
2223 "Number of argument-specifying events read by `universal-argument'.
2224 `universal-argument-other-key' uses this to discard those events
2225 from (this-command-keys), and reread only the final command.")
2227 (defvar overriding-map-is-bound nil
2228 "Non-nil when `overriding-terminal-local-map' is `universal-argument-map'.")
2230 (defvar saved-overriding-map nil
2231 "The saved value of `overriding-terminal-local-map'.
2235 (defun ensure-overriding-map-is-bound ()
2236 "Check `overriding-terminal-local-map' is `universal-argument-map'."
2237 (unless overriding-map-is-bound
2238 (setq saved-overriding-map overriding-terminal-local-map)
2239 (setq overriding-terminal-local-map universal-argument-map)
2240 (setq overriding-map-is-bound t)))
2242 (defun restore-overriding-map ()
2243 "Restore `overriding-terminal-local-map' to its saved value."
2244 (setq overriding-terminal-local-map saved-overriding-map)
2245 (setq overriding-map-is-bound nil))
2247 (defun universal-argument ()
2248 "Begin a numeric argument for the following command.
2253 multiplies the argument by 4 each time.
2255 which is different in effect from any particular numeric argument.
2257 (interactive)
2258 (setq prefix-arg (list 4))
2259 (setq universal-argument-num-events (length (this-command-keys)))
2260 (ensure-overriding-map-is-bound))
2262 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
2263 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
2264 (defun universal-argument-more (arg)
2265 (interactive "P")
2266 (if (consp arg)
2267 (setq prefix-arg (list (* 4 (car arg))))
2268 (if (eq arg '-)
2269 (setq prefix-arg (list -4))
2270 (setq prefix-arg arg)
2271 (restore-overriding-map)))
2272 (setq universal-argument-num-events (length (this-command-keys))))
2274 (defun negative-argument (arg)
2275 "Begin a negative numeric argument for the next command.
2277 (interactive "P")
2278 (cond ((integerp arg)
2279 (setq prefix-arg (- arg)))
2280 ((eq arg '-)
2281 (setq prefix-arg nil))
2282 (t
2283 (setq prefix-arg '-)))
2284 (setq universal-argument-num-events (length (this-command-keys)))
2285 (ensure-overriding-map-is-bound))
2287 (defun digit-argument (arg)
2288 "Part of the numeric argument for the next command.
2290 (interactive "P")
2291 (let* ((char (if (integerp last-command-char)
2292 last-command-char
2293 (get last-command-char 'ascii-character)))
2295 (cond ((integerp arg)
2296 (setq prefix-arg (+ (* arg 10)
2297 (if (< arg 0) (- digit) digit))))
2298 ((eq arg '-)
2299 ;; Treat -0 as just -, so that -01 will work.
2300 (setq prefix-arg (if (zerop digit) '- (- digit))))
2301 (t
2302 (setq prefix-arg digit))))
2303 (setq universal-argument-num-events (length (this-command-keys)))
2304 (ensure-overriding-map-is-bound))
2306 ;; For backward compatibility, minus with no modifiers is an ordinary
2307 ;; command if digits have already been entered.
2308 (defun universal-argument-minus (arg)
2309 (interactive "P")
2310 (if (integerp arg)
2311 (universal-argument-other-key arg)
2312 (negative-argument arg)))
2314 ;; Anything else terminates the argument and is left in the queue to be
2315 ;; executed as a command.
2316 (defun universal-argument-other-key (arg)
2317 (interactive "P")
2318 (setq prefix-arg arg)
2319 (let* ((key (this-command-keys))
2320 (keylist (listify-key-sequence key)))
2321 (setq unread-command-events
2322 (append (nthcdr universal-argument-num-events keylist)
2323 unread-command-events)))
2324 (reset-this-command-lengths)
2325 (restore-overriding-map))
2326 \f
2327 (defvar buffer-substring-filters nil
2328 "List of filter functions for `filter-buffer-substring'.
2329 Each function must accept a single argument, a string, and return
2330 a string. The buffer substring is passed to the first function
2331 in the list, and the return value of each function is passed to
2332 the next. The return value of the last function is used as the
2333 return value of `filter-buffer-substring'.
2335 If this variable is nil, no filtering is performed.")
2337 (defun filter-buffer-substring (beg end &optional delete noprops)
2338 "Return the buffer substring between BEG and END, after filtering.
2339 The buffer substring is passed through each of the filter
2340 functions in `buffer-substring-filters', and the value from the
2341 last filter function is returned. If `buffer-substring-filters'
2342 is nil, the buffer substring is returned unaltered.
2344 If DELETE is non-nil, the text between BEG and END is deleted
2345 from the buffer.
2347 If NOPROPS is non-nil, final string returned does not include
2348 text properties, while the string passed to the filters still
2349 includes text properties from the buffer text.
2351 Point is temporarily set to BEG before calling
2352 `buffer-substring-filters', in case the functions need to know
2353 where the text came from.
2355 This function should be used instead of `buffer-substring',
2356 `buffer-substring-no-properties', or `delete-and-extract-region'
2357 when you want to allow filtering to take place. For example,
2358 major or minor modes can use `buffer-substring-filters' to
2359 extract characters that are special to a buffer, and should not
2360 be copied into other buffers."
2361 (cond
2362 ((or delete buffer-substring-filters)
2363 (save-excursion
2364 (goto-char beg)
2365 (let ((string (if delete (delete-and-extract-region beg end)
2366 (buffer-substring beg end))))
2367 (dolist (filter buffer-substring-filters)
2368 (setq string (funcall filter string)))
2369 (if noprops
2370 (set-text-properties 0 (length string) nil string))
2371 string)))
2372 (noprops
2373 (buffer-substring-no-properties beg end))
2374 (t
2375 (buffer-substring beg end))))
2378 ;;;; Window system cut and paste hooks.
2380 (defvar interprogram-cut-function nil
2381 "Function to call to make a killed region available to other programs.
2383 Most window systems provide some sort of facility for cutting and
2384 pasting text between the windows of different programs.
2385 This variable holds a function that Emacs calls whenever text
2386 is put in the kill ring, to make the new kill available to other
2387 programs.
2389 The function takes one or two arguments.
2390 The first argument, TEXT, is a string containing
2391 the text which should be made available.
2392 The second, optional, argument PUSH, has the same meaning as the
2393 similar argument to `x-set-cut-buffer', which see.")
2395 (defvar interprogram-paste-function nil
2396 "Function to call to get text cut from other programs.
2398 Most window systems provide some sort of facility for cutting and
2399 pasting text between the windows of different programs.
2400 This variable holds a function that Emacs calls to obtain
2401 text that other programs have provided for pasting.
2403 The function should be called with no arguments. If the function
2404 returns nil, then no other program has provided such text, and the top
2405 of the Emacs kill ring should be used. If the function returns a
2406 string, then the caller of the function \(usually `current-kill')
2407 should put this string in the kill ring as the latest kill.
2409 Note that the function should return a string only if a program other
2410 than Emacs has provided a string for pasting; if Emacs provided the
2411 most recent string, the function should return nil. If it is
2412 difficult to tell whether Emacs or some other program provided the
2413 current string, it is probably good enough to return nil if the string
2414 is equal (according to `string=') to the last text Emacs provided.")
2415 \f
2418 ;;;; The kill ring data structure.
2420 (defvar kill-ring nil
2421 "List of killed text sequences.
2422 Since the kill ring is supposed to interact nicely with cut-and-paste
2423 facilities offered by window systems, use of this variable should
2424 interact nicely with `interprogram-cut-function' and
2425 `interprogram-paste-function'. The functions `kill-new',
2426 `kill-append', and `current-kill' are supposed to implement this
2427 interaction; you may want to use them instead of manipulating the kill
2428 ring directly.")
2430 (defcustom kill-ring-max 60
2431 "*Maximum length of kill ring before oldest elements are thrown away."
2432 :type 'integer
2433 :group 'killing)
2435 (defvar kill-ring-yank-pointer nil
2436 "The tail of the kill ring whose car is the last thing yanked.")
2438 (defun kill-new (string &optional replace yank-handler)
2439 "Make STRING the latest kill in the kill ring.
2440 Set `kill-ring-yank-pointer' to point to it.
2441 If `interprogram-cut-function' is non-nil, apply it to STRING.
2442 Optional second argument REPLACE non-nil means that STRING will replace
2443 the front of the kill ring, rather than being added to the list.
2445 Optional third arguments YANK-HANDLER controls how the STRING is later
2446 inserted into a buffer; see `insert-for-yank' for details.
2447 When a yank handler is specified, STRING must be non-empty (the yank
2448 handler, if non-nil, is stored as a `yank-handler' text property on STRING).
2450 When the yank handler has a non-nil PARAM element, the original STRING
2451 argument is not used by `insert-for-yank'. However, since Lisp code
2452 may access and use elements from the kill ring directly, the STRING
2454 (if (> (length string) 0)
2455 (if yank-handler
2456 (put-text-property 0 (length string)
2457 'yank-handler yank-handler string))
2458 (if yank-handler
2459 (signal 'args-out-of-range
2460 (list string "yank-handler specified for empty string"))))
2461 (if (fboundp 'menu-bar-update-yank-menu)
2462 (menu-bar-update-yank-menu string (and replace (car kill-ring))))
2463 (if (and replace kill-ring)
2464 (setcar kill-ring string)
2465 (push string kill-ring)
2466 (if (> (length kill-ring) kill-ring-max)
2467 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil)))
2468 (setq kill-ring-yank-pointer kill-ring)
2469 (if interprogram-cut-function
2470 (funcall interprogram-cut-function string (not replace))))
2472 (defun kill-append (string before-p &optional yank-handler)
2473 "Append STRING to the end of the latest kill in the kill ring.
2474 If BEFORE-P is non-nil, prepend STRING to the kill.
2475 Optional third argument YANK-HANDLER, if non-nil, specifies the
2476 yank-handler text property to be set on the combined kill ring
2477 string. If the specified yank-handler arg differs from the
2478 yank-handler property of the latest kill string, this function
2479 adds the combined string to the kill ring as a new element,
2480 instead of replacing the last kill with it.
2481 If `interprogram-cut-function' is set, pass the resulting kill to it."
2482 (let* ((cur (car kill-ring)))
2483 (kill-new (if before-p (concat string cur) (concat cur string))
2484 (or (= (length cur) 0)
2485 (equal yank-handler (get-text-property 0 'yank-handler cur)))
2486 yank-handler)))
2488 (defun current-kill (n &optional do-not-move)
2489 "Rotate the yanking point by N places, and then return that kill.
2490 If N is zero, `interprogram-paste-function' is set, and calling it
2491 returns a string, then that string is added to the front of the
2492 kill ring and returned as the latest kill.
2493 If optional arg DO-NOT-MOVE is non-nil, then don't actually move the
2494 yanking point; just return the Nth kill forward."
2495 (let ((interprogram-paste (and (= n 0)
2496 interprogram-paste-function
2497 (funcall interprogram-paste-function))))
2498 (if interprogram-paste
2499 (progn
2500 ;; Disable the interprogram cut function when we add the new
2501 ;; text to the kill ring, so Emacs doesn't try to own the
2502 ;; selection, with identical text.
2503 (let ((interprogram-cut-function nil))
2504 (kill-new interprogram-paste))
2505 interprogram-paste)
2506 (or kill-ring (error "Kill ring is empty"))
2507 (let ((ARGth-kill-element
2508 (nthcdr (mod (- n (length kill-ring-yank-pointer))
2509 (length kill-ring))
2510 kill-ring)))
2511 (or do-not-move
2512 (setq kill-ring-yank-pointer ARGth-kill-element))
2513 (car ARGth-kill-element)))))
2517 ;;;; Commands for manipulating the kill ring.
2519 (defcustom kill-read-only-ok nil
2520 "*Non-nil means don't signal an error for killing read-only text."
2521 :type 'boolean
2522 :group 'killing)
2524 (put 'text-read-only 'error-conditions
2525 '(text-read-only buffer-read-only error))
2526 (put 'text-read-only 'error-message "Text is read-only")
2528 (defun kill-region (beg end &optional yank-handler)
2530 This deletes the text from the buffer and saves it in the kill ring.
2534 If you want to append the killed region to the last killed text,
2537 If the buffer is read-only, Emacs will beep and refrain from deleting
2538 the text, but put the text in the kill ring anyway. This means that
2539 you can use the killing commands to copy text from a read-only buffer.
2541 This is the primitive for programs to kill text (as opposed to deleting it).
2542 Supply two arguments, character positions indicating the stretch of text
2543 to be killed.
2545 If the previous command was also a kill command,
2546 the text killed this time appends to the text killed last time
2547 to make one entry in the kill ring.
2549 In Lisp code, optional third arg YANK-HANDLER, if non-nil,
2550 specifies the yank-handler text property to be set on the killed
2551 text. See `insert-for-yank'."
2552 ;; Pass point first, then mark, because the order matters
2553 ;; when calling kill-append.
2554 (interactive (list (point) (mark)))
2555 (condition-case nil
2556 (let ((string (filter-buffer-substring beg end t)))
2557 (when string ;STRING is nil if BEG = END
2558 ;; Add that string to the kill ring, one way or another.
2559 (if (eq last-command 'kill-region)
2560 (kill-append string (< end beg) yank-handler)
2561 (kill-new string nil yank-handler)))
2562 (when (or string (eq last-command 'kill-region))
2563 (setq this-command 'kill-region))
2564 nil)
2565 ((buffer-read-only text-read-only)
2566 ;; The code above failed because the buffer, or some of the characters
2567 ;; in the region, are read-only.
2568 ;; We should beep, in case the user just isn't aware of this.
2569 ;; However, there's no harm in putting
2570 ;; the region's text in the kill ring, anyway.
2571 (copy-region-as-kill beg end)
2572 ;; Set this-command now, so it will be set even if we get an error.
2573 (setq this-command 'kill-region)
2574 ;; This should barf, if appropriate, and give us the correct error.
2575 (if kill-read-only-ok
2576 (progn (message "Read only text copied to kill ring") nil)
2577 ;; Signal an error if the buffer is read-only.
2578 (barf-if-buffer-read-only)
2579 ;; If the buffer isn't read-only, the text is.
2580 (signal 'text-read-only (list (current-buffer)))))))
2582 ;; copy-region-as-kill no longer sets this-command, because it's confusing
2583 ;; to get two copies of the text when the user accidentally types M-w and
2584 ;; then corrects it with the intended C-w.
2585 (defun copy-region-as-kill (beg end)
2586 "Save the region as if killed, but don't kill it.
2587 In Transient Mark mode, deactivate the mark.
2588 If `interprogram-cut-function' is non-nil, also save the text for a window
2589 system cut and paste."
2590 (interactive "r")
2591 (if (eq last-command 'kill-region)
2592 (kill-append (filter-buffer-substring beg end) (< end beg))
2593 (kill-new (filter-buffer-substring beg end)))
2594 (if transient-mark-mode
2595 (setq deactivate-mark t))
2596 nil)
2598 (defun kill-ring-save (beg end)
2599 "Save the region as if killed, but don't kill it.
2600 In Transient Mark mode, deactivate the mark.
2601 If `interprogram-cut-function' is non-nil, also save the text for a window
2602 system cut and paste.
2604 If you want to append the killed line to the last killed text,
2607 This command is similar to `copy-region-as-kill', except that it gives
2608 visual feedback indicating the extent of the region being copied."
2609 (interactive "r")
2610 (copy-region-as-kill beg end)
2611 ;; This use of interactive-p is correct
2612 ;; because the code it controls just gives the user visual feedback.
2613 (if (interactive-p)
2614 (let ((other-end (if (= (point) beg) end beg))
2615 (opoint (point))
2616 ;; Inhibit quitting so we can make a quit here
2617 ;; look like a C-g typed as a command.
2618 (inhibit-quit t))
2619 (if (pos-visible-in-window-p other-end (selected-window))
2620 (unless (and transient-mark-mode
2621 (face-background 'region))
2622 ;; Swap point and mark.
2623 (set-marker (mark-marker) (point) (current-buffer))
2624 (goto-char other-end)
2625 (sit-for blink-matching-delay)
2626 ;; Swap back.
2627 (set-marker (mark-marker) other-end (current-buffer))
2628 (goto-char opoint)
2629 ;; If user quit, deactivate the mark
2630 ;; as C-g would as a command.
2631 (and quit-flag mark-active
2632 (deactivate-mark)))
2633 (let* ((killed-text (current-kill 0))
2634 (message-len (min (length killed-text) 40)))
2635 (if (= (point) beg)
2636 ;; Don't say "killed"; that is misleading.
2638 (substring killed-text (- message-len)))
2640 (substring killed-text 0 message-len))))))))
2642 (defun append-next-kill (&optional interactive)
2643 "Cause following command, if it kills, to append to previous kill.
2644 The argument is used for internal purposes; do not supply one."
2645 (interactive "p")
2646 ;; We don't use (interactive-p), since that breaks kbd macros.
2647 (if interactive
2648 (progn
2649 (setq this-command 'kill-region)
2650 (message "If the next command is a kill, it will append"))
2651 (setq last-command 'kill-region)))
2652 \f
2653 ;; Yanking.
2655 ;; This is actually used in subr.el but defcustom does not work there.
2656 (defcustom yank-excluded-properties
2657 '(read-only invisible intangible field mouse-face help-echo local-map keymap
2658 yank-handler follow-link)
2659 "*Text properties to discard when yanking.
2660 The value should be a list of text properties to discard or t,
2661 which means to discard all text properties."
2662 :type '(choice (const :tag "All" t) (repeat symbol))
2663 :group 'killing
2664 :version "22.1")
2666 (defvar yank-window-start nil)
2667 (defvar yank-undo-function nil
2668 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
2669 Function is called with two parameters, START and END corresponding to
2670 the value of the mark and point; it is guaranteed that START <= END.
2671 Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
2673 (defun yank-pop (&optional arg)
2674 "Replace just-yanked stretch of killed text with a different stretch.
2675 This command is allowed only immediately after a `yank' or a `yank-pop'.
2676 At such a time, the region contains a stretch of reinserted
2677 previously-killed text. `yank-pop' deletes that text and inserts in its
2678 place a different stretch of killed text.
2680 With no argument, the previous kill is inserted.
2681 With argument N, insert the Nth previous kill.
2682 If N is negative, this is a more recent kill.
2684 The sequence of kills wraps around, so that after the oldest one
2685 comes the newest one.
2687 When this command inserts killed text into the buffer, it honors
2688 `yank-excluded-properties' and `yank-handler' as described in the
2689 doc string for `insert-for-yank-1', which see."
2690 (interactive "*p")
2691 (if (not (eq last-command 'yank))
2692 (error "Previous command was not a yank"))
2693 (setq this-command 'yank)
2694 (unless arg (setq arg 1))
2695 (let ((inhibit-read-only t)
2696 (before (< (point) (mark t))))
2697 (if before
2698 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
2699 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
2700 (setq yank-undo-function nil)
2701 (set-marker (mark-marker) (point) (current-buffer))
2702 (insert-for-yank (current-kill arg))
2703 ;; Set the window start back where it was in the yank command,
2704 ;; if possible.
2705 (set-window-start (selected-window) yank-window-start t)
2706 (if before
2707 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
2708 ;; It is cleaner to avoid activation, even though the command
2709 ;; loop would deactivate the mark because we inserted text.
2710 (goto-char (prog1 (mark t)
2711 (set-marker (mark-marker) (point) (current-buffer))))))
2712 nil)
2714 (defun yank (&optional arg)
2716 More precisely, reinsert the stretch of killed text most recently
2717 killed OR yanked. Put point at end, and set mark at beginning.
2718 With just \\[universal-argument] as argument, same but put point at beginning (and mark at end).
2719 With argument N, reinsert the Nth most recently killed stretch of killed
2720 text.
2722 When this command inserts killed text into the buffer, it honors
2723 `yank-excluded-properties' and `yank-handler' as described in the
2724 doc string for `insert-for-yank-1', which see.
2727 (interactive "*P")
2728 (setq yank-window-start (window-start))
2729 ;; If we don't get all the way thru, make last-command indicate that
2730 ;; for the following command.
2731 (setq this-command t)
2732 (push-mark (point))
2733 (insert-for-yank (current-kill (cond
2734 ((listp arg) 0)
2735 ((eq arg '-) -2)
2736 (t (1- arg)))))
2737 (if (consp arg)
2738 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
2739 ;; It is cleaner to avoid activation, even though the command
2740 ;; loop would deactivate the mark because we inserted text.
2741 (goto-char (prog1 (mark t)
2742 (set-marker (mark-marker) (point) (current-buffer)))))
2743 ;; If we do get all the way thru, make this-command indicate that.
2744 (if (eq this-command t)
2745 (setq this-command 'yank))
2746 nil)
2748 (defun rotate-yank-pointer (arg)
2749 "Rotate the yanking point in the kill ring.
2750 With argument, rotate that many kills forward (or backward, if negative)."
2751 (interactive "p")
2752 (current-kill arg))
2753 \f
2754 ;; Some kill commands.
2756 ;; Internal subroutine of delete-char
2757 (defun kill-forward-chars (arg)
2758 (if (listp arg) (setq arg (car arg)))
2759 (if (eq arg '-) (setq arg -1))
2760 (kill-region (point) (forward-point arg)))
2762 ;; Internal subroutine of backward-delete-char
2763 (defun kill-backward-chars (arg)
2764 (if (listp arg) (setq arg (car arg)))
2765 (if (eq arg '-) (setq arg -1))
2766 (kill-region (point) (forward-point (- arg))))
2768 (defcustom backward-delete-char-untabify-method 'untabify
2769 "*The method for untabifying when deleting backward.
2770 Can be `untabify' -- turn a tab to many spaces, then delete one space;
2771 `hungry' -- delete all whitespace, both tabs and spaces;
2772 `all' -- delete all whitespace, including tabs, spaces and newlines;
2773 nil -- just delete one character."
2774 :type '(choice (const untabify) (const hungry) (const all) (const nil))
2775 :version "20.3"
2776 :group 'killing)
2778 (defun backward-delete-char-untabify (arg &optional killp)
2779 "Delete characters backward, changing tabs into spaces.
2780 The exact behavior depends on `backward-delete-char-untabify-method'.
2781 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
2782 Interactively, ARG is the prefix arg (default 1)
2783 and KILLP is t if a prefix arg was specified."
2785 (when (eq backward-delete-char-untabify-method 'untabify)
2786 (let ((count arg))
2787 (save-excursion
2788 (while (and (> count 0) (not (bobp)))
2790 (let ((col (current-column)))
2791 (forward-char -1)
2792 (setq col (- col (current-column)))
2793 (insert-char ?\s col)
2794 (delete-char 1)))
2795 (forward-char -1)
2796 (setq count (1- count))))))
2797 (delete-backward-char
2799 ((eq backward-delete-char-untabify-method 'all)
2801 (if skip
2802 (let ((wh (- (point) (save-excursion (skip-chars-backward skip)
2803 (point)))))
2804 (+ arg (if (zerop wh) 0 (1- wh))))
2805 arg))
2806 killp))
2808 (defun zap-to-char (arg char)
2809 "Kill up to and including ARG'th occurrence of CHAR.
2810 Case is ignored if `case-fold-search' is non-nil in the current buffer.
2811 Goes backward if ARG is negative; error if CHAR not found."
2813 (if (char-table-p translation-table-for-input)
2814 (setq char (or (aref translation-table-for-input char) char)))
2815 (kill-region (point) (progn
2816 (search-forward (char-to-string char) nil nil arg)
2817 ; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
2818 (point))))
2820 ;; kill-line and its subroutines.
2822 (defcustom kill-whole-line nil
2823 "*If non-nil, `kill-line' with no arg at beg of line kills the whole line."
2824 :type 'boolean
2825 :group 'killing)
2827 (defun kill-line (&optional arg)
2828 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
2829 With prefix argument, kill that many lines from point.
2830 Negative arguments kill lines backward.
2831 With zero argument, kills the text before point on the current line.
2834 a number counts as a prefix arg.
2836 To kill a whole line, when point is not at the beginning, type \
2839 If `kill-whole-line' is non-nil, then this command kills the whole line
2840 including its terminating newline, when used at the beginning of a line
2841 with no argument. As a consequence, you can always kill a whole line
2844 If you want to append the killed line to the last killed text,
2847 If the buffer is read-only, Emacs will beep and refrain from deleting
2848 the line, but put the line in the kill ring anyway. This means that
2849 you can use this command to copy text from a read-only buffer.
2850 \(If the variable `kill-read-only-ok' is non-nil, then this won't
2851 even beep.)"
2852 (interactive "P")
2853 (kill-region (point)
2854 ;; It is better to move point to the other end of the kill
2855 ;; before killing. That way, in a read-only buffer, point
2856 ;; moves across the text that is copied to the kill ring.
2857 ;; The choice has no effect on undo now that undo records
2858 ;; the value of point from before the command was run.
2859 (progn
2860 (if arg
2861 (forward-visible-line (prefix-numeric-value arg))
2862 (if (eobp)
2863 (signal 'end-of-buffer nil))
2864 (let ((end
2865 (save-excursion
2866 (end-of-visible-line) (point))))
2867 (if (or (save-excursion
2868 ;; If trailing whitespace is visible,
2869 ;; don't treat it as nothing.
2870 (unless show-trailing-whitespace
2872 (= (point) end))
2873 (and kill-whole-line (bolp)))
2874 (forward-visible-line 1)
2875 (goto-char end))))
2876 (point))))
2878 (defun kill-whole-line (&optional arg)
2879 "Kill current line.
2880 With prefix arg, kill that many lines starting from the current line.
2881 If arg is negative, kill backward. Also kill the preceding newline.
2883 If arg is zero, kill current line but exclude the trailing newline."
2884 (interactive "p")
2885 (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
2886 (signal 'end-of-buffer nil))
2887 (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
2888 (signal 'beginning-of-buffer nil))
2889 (unless (eq last-command 'kill-region)
2890 (kill-new "")
2891 (setq last-command 'kill-region))
2892 (cond ((zerop arg)
2893 ;; We need to kill in two steps, because the previous command
2894 ;; could have been a kill command, in which case the text
2895 ;; before point needs to be prepended to the current kill
2896 ;; ring entry and the text after point appended. Also, we
2897 ;; need to use save-excursion to avoid copying the same text
2898 ;; twice to the kill ring in read-only buffers.
2899 (save-excursion
2900 (kill-region (point) (progn (forward-visible-line 0) (point))))
2901 (kill-region (point) (progn (end-of-visible-line) (point))))
2902 ((< arg 0)
2903 (save-excursion
2904 (kill-region (point) (progn (end-of-visible-line) (point))))
2905 (kill-region (point)
2906 (progn (forward-visible-line (1+ arg))
2907 (unless (bobp) (backward-char))
2908 (point))))
2909 (t
2910 (save-excursion
2911 (kill-region (point) (progn (forward-visible-line 0) (point))))
2912 (kill-region (point)
2913 (progn (forward-visible-line arg) (point))))))
2915 (defun forward-visible-line (arg)
2916 "Move forward by ARG lines, ignoring currently invisible newlines only.
2917 If ARG is negative, move backward -ARG lines.
2918 If ARG is zero, move to the beginning of the current line."
2919 (condition-case nil
2920 (if (> arg 0)
2921 (progn
2922 (while (> arg 0)
2923 (or (zerop (forward-line 1))
2924 (signal 'end-of-buffer nil))
2925 ;; If the newline we just skipped is invisible,
2926 ;; don't count it.
2927 (let ((prop
2928 (get-char-property (1- (point)) 'invisible)))
2929 (if (if (eq buffer-invisibility-spec t)
2930 prop
2931 (or (memq prop buffer-invisibility-spec)
2932 (assq prop buffer-invisibility-spec)))
2933 (setq arg (1+ arg))))
2934 (setq arg (1- arg)))
2935 ;; If invisible text follows, and it is a number of complete lines,
2936 ;; skip it.
2937 (let ((opoint (point)))
2938 (while (and (not (eobp))
2939 (let ((prop
2940 (get-char-property (point) 'invisible)))
2941 (if (eq buffer-invisibility-spec t)
2942 prop
2943 (or (memq prop buffer-invisibility-spec)
2944 (assq prop buffer-invisibility-spec)))))
2945 (goto-char
2946 (if (get-text-property (point) 'invisible)
2947 (or (next-single-property-change (point) 'invisible)
2948 (point-max))
2949 (next-overlay-change (point)))))
2950 (unless (bolp)
2951 (goto-char opoint))))
2952 (let ((first t))
2953 (while (or first (<= arg 0))
2954 (if first
2955 (beginning-of-line)
2956 (or (zerop (forward-line -1))
2957 (signal 'beginning-of-buffer nil)))
2958 ;; If the newline we just moved to is invisible,
2959 ;; don't count it.
2960 (unless (bobp)
2961 (let ((prop
2962 (get-char-property (1- (point)) 'invisible)))
2963 (unless (if (eq buffer-invisibility-spec t)
2964 prop
2965 (or (memq prop buffer-invisibility-spec)
2966 (assq prop buffer-invisibility-spec)))
2967 (setq arg (1+ arg)))))
2968 (setq first nil))
2969 ;; If invisible text follows, and it is a number of complete lines,
2970 ;; skip it.
2971 (let ((opoint (point)))
2972 (while (and (not (bobp))
2973 (let ((prop
2974 (get-char-property (1- (point)) 'invisible)))
2975 (if (eq buffer-invisibility-spec t)
2976 prop
2977 (or (memq prop buffer-invisibility-spec)
2978 (assq prop buffer-invisibility-spec)))))
2979 (goto-char
2980 (if (get-text-property (1- (point)) 'invisible)
2981 (or (previous-single-property-change (point) 'invisible)
2982 (point-min))
2983 (previous-overlay-change (point)))))
2984 (unless (bolp)
2985 (goto-char opoint)))))
2986 ((beginning-of-buffer end-of-buffer)
2987 nil)))
2989 (defun end-of-visible-line ()
2990 "Move to end of current visible line."
2991 (end-of-line)
2992 ;; If the following character is currently invisible,
2993 ;; skip all characters with that same `invisible' property value,
2994 ;; then find the next newline.
2995 (while (and (not (eobp))
2996 (save-excursion
2998 (let ((prop
2999 (get-char-property (point) 'invisible)))
3000 (if (eq buffer-invisibility-spec t)
3001 prop
3002 (or (memq prop buffer-invisibility-spec)
3003 (assq prop buffer-invisibility-spec))))))
3005 (if (get-text-property (point) 'invisible)
3006 (goto-char (next-single-property-change (point) 'invisible))
3007 (goto-char (next-overlay-change (point))))
3008 (end-of-line)))
3009 \f
3010 (defun insert-buffer (buffer)
3011 "Insert after point the contents of BUFFER.
3012 Puts mark after the inserted text.
3013 BUFFER may be a buffer or a buffer name.
3015 This function is meant for the user to run interactively.
3016 Don't call it from programs: use `insert-buffer-substring' instead!"
3017 (interactive
3018 (list
3019 (progn
3020 (barf-if-buffer-read-only)
3021 (read-buffer "Insert buffer: "
3022 (if (eq (selected-window) (next-window (selected-window)))
3023 (other-buffer (current-buffer))
3024 (window-buffer (next-window (selected-window))))
3025 t))))
3026 (push-mark
3027 (save-excursion
3028 (insert-buffer-substring (get-buffer buffer))
3029 (point)))
3030 nil)
3032 (defun append-to-buffer (buffer start end)
3033 "Append to specified buffer the text of the region.
3034 It is inserted into that buffer before its point.
3036 When calling from a program, give three arguments:
3037 BUFFER (or buffer name), START and END.
3038 START and END specify the portion of the current buffer to be copied."
3039 (interactive
3040 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
3041 (region-beginning) (region-end)))
3042 (let ((oldbuf (current-buffer)))
3043 (save-excursion
3044 (let* ((append-to (get-buffer-create buffer))
3045 (windows (get-buffer-window-list append-to t t))
3046 point)
3047 (set-buffer append-to)
3048 (setq point (point))
3049 (barf-if-buffer-read-only)
3050 (insert-buffer-substring oldbuf start end)
3051 (dolist (window windows)
3052 (when (= (window-point window) point)
3053 (set-window-point window (point))))))))
3055 (defun prepend-to-buffer (buffer start end)
3056 "Prepend to specified buffer the text of the region.
3057 It is inserted into that buffer after its point.
3059 When calling from a program, give three arguments:
3060 BUFFER (or buffer name), START and END.
3061 START and END specify the portion of the current buffer to be copied."
3063 (let ((oldbuf (current-buffer)))
3064 (save-excursion
3065 (set-buffer (get-buffer-create buffer))
3066 (barf-if-buffer-read-only)
3067 (save-excursion
3068 (insert-buffer-substring oldbuf start end)))))
3070 (defun copy-to-buffer (buffer start end)
3071 "Copy to specified buffer the text of the region.
3072 It is inserted into that buffer, replacing existing text there.
3074 When calling from a program, give three arguments:
3075 BUFFER (or buffer name), START and END.
3076 START and END specify the portion of the current buffer to be copied."
3078 (let ((oldbuf (current-buffer)))
3079 (with-current-buffer (get-buffer-create buffer)
3080 (barf-if-buffer-read-only)
3081 (erase-buffer)
3082 (save-excursion
3083 (insert-buffer-substring oldbuf start end)))))
3084 \f
3085 (put 'mark-inactive 'error-conditions '(mark-inactive error))
3086 (put 'mark-inactive 'error-message "The mark is not active now")
3088 (defvar activate-mark-hook nil
3089 "Hook run when the mark becomes active.
3090 It is also run at the end of a command, if the mark is active and
3091 it is possible that the region may have changed")
3093 (defvar deactivate-mark-hook nil
3094 "Hook run when the mark becomes inactive.")
3096 (defun mark (&optional force)
3097 "Return this buffer's mark value as integer, or nil if never set.
3099 In Transient Mark mode, this function signals an error if
3100 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
3101 or the argument FORCE is non-nil, it disregards whether the mark
3102 is active, and returns an integer or nil in the usual way.
3104 If you are using this in an editing command, you are most likely making
3105 a mistake; see the documentation of `set-mark'."
3106 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
3107 (marker-position (mark-marker))
3108 (signal 'mark-inactive nil)))
3110 ;; Many places set mark-active directly, and several of them failed to also
3111 ;; run deactivate-mark-hook. This shorthand should simplify.
3112 (defsubst deactivate-mark ()
3113 "Deactivate the mark by setting `mark-active' to nil.
3114 \(That makes a difference only in Transient Mark mode.)
3115 Also runs the hook `deactivate-mark-hook'."
3116 (cond
3117 ((eq transient-mark-mode 'lambda)
3118 (setq transient-mark-mode nil))
3119 (transient-mark-mode
3120 (setq mark-active nil)
3121 (run-hooks 'deactivate-mark-hook))))
3123 (defun set-mark (pos)
3124 "Set this buffer's mark to POS. Don't use this function!
3125 That is to say, don't use this function unless you want
3126 the user to see that the mark has moved, and you want the previous
3127 mark position to be lost.
3129 Normally, when a new mark is set, the old one should go on the stack.
3130 This is why most applications should use `push-mark', not `set-mark'.
3132 Novice Emacs Lisp programmers often try to use the mark for the wrong
3133 purposes. The mark saves a location for the user's convenience.
3134 Most editing commands should not alter the mark.
3135 To remember a location for internal use in the Lisp program,
3136 store it in a Lisp variable. Example:
3138 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
3140 (if pos
3141 (progn
3142 (setq mark-active t)
3143 (run-hooks 'activate-mark-hook)
3144 (set-marker (mark-marker) pos (current-buffer)))
3145 ;; Normally we never clear mark-active except in Transient Mark mode.
3146 ;; But when we actually clear out the mark value too,
3147 ;; we must clear mark-active in any mode.
3148 (setq mark-active nil)
3149 (run-hooks 'deactivate-mark-hook)
3150 (set-marker (mark-marker) nil)))
3152 (defvar mark-ring nil
3153 "The list of former marks of the current buffer, most recent first.")
3154 (make-variable-buffer-local 'mark-ring)
3155 (put 'mark-ring 'permanent-local t)
3157 (defcustom mark-ring-max 16
3158 "*Maximum size of mark ring. Start discarding off end if gets this big."
3159 :type 'integer
3160 :group 'editing-basics)
3162 (defvar global-mark-ring nil
3163 "The list of saved global marks, most recent first.")
3165 (defcustom global-mark-ring-max 16
3166 "*Maximum size of global mark ring. \
3167 Start discarding off end if gets this big."
3168 :type 'integer
3169 :group 'editing-basics)
3171 (defun pop-to-mark-command ()
3172 "Jump to mark, and pop a new position for mark off the ring
3173 \(does not affect global mark ring\)."
3174 (interactive)
3175 (if (null (mark t))
3176 (error "No mark set in this buffer")
3177 (goto-char (mark t))
3178 (pop-mark)))
3180 (defun push-mark-command (arg &optional nomsg)
3181 "Set mark at where point is.
3182 If no prefix arg and mark is already set there, just activate it.
3183 Display `Mark set' unless the optional second arg NOMSG is non-nil."
3184 (interactive "P")
3185 (let ((mark (marker-position (mark-marker))))
3186 (if (or arg (null mark) (/= mark (point)))
3187 (push-mark nil nomsg t)
3188 (setq mark-active t)
3189 (run-hooks 'activate-mark-hook)
3190 (unless nomsg
3191 (message "Mark activated")))))
3193 (defcustom set-mark-command-repeat-pop nil
3196 will pop twice."
3197 :type 'boolean
3198 :group 'editing)
3200 (defun set-mark-command (arg)
3201 "Set mark at where point is, or jump to mark.
3202 With no prefix argument, set mark, and push old mark position on local
3203 mark ring; also push mark on global mark ring if last mark was set in
3204 another buffer. Immediately repeating the command activates
3205 `transient-mark-mode' temporarily.
3208 jump to mark, and pop a new position
3209 for mark off the local mark ring \(this does not affect the global
3211 mark ring \(see `pop-global-mark'\).
3213 If `set-mark-command-repeat-pop' is non-nil, repeating
3215 off the local (or global) mark ring and jumps there.
3219 set mark where point is.
3224 Novice Emacs Lisp programmers often try to use the mark for the wrong
3225 purposes. See the documentation of `set-mark' for more information."
3226 (interactive "P")
3227 (if (eq transient-mark-mode 'lambda)
3228 (setq transient-mark-mode nil))
3229 (cond
3230 ((and (consp arg) (> (prefix-numeric-value arg) 4))
3231 (push-mark-command nil))
3232 ((not (eq this-command 'set-mark-command))
3233 (if arg
3234 (pop-to-mark-command)
3235 (push-mark-command t)))
3236 ((and set-mark-command-repeat-pop
3237 (eq last-command 'pop-to-mark-command))
3238 (setq this-command 'pop-to-mark-command)
3239 (pop-to-mark-command))
3240 ((and set-mark-command-repeat-pop
3241 (eq last-command 'pop-global-mark)
3242 (not arg))
3243 (setq this-command 'pop-global-mark)
3244 (pop-global-mark))
3245 (arg
3246 (setq this-command 'pop-to-mark-command)
3247 (pop-to-mark-command))
3248 ((and (eq last-command 'set-mark-command)
3249 mark-active (null transient-mark-mode))
3250 (setq transient-mark-mode 'lambda)
3251 (message "Transient-mark-mode temporarily enabled"))
3252 (t
3253 (push-mark-command nil))))
3255 (defun push-mark (&optional location nomsg activate)
3256 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
3257 If the last global mark pushed was not in the current buffer,
3258 also push LOCATION on the global mark ring.
3259 Display `Mark set' unless the optional second arg NOMSG is non-nil.
3260 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil.
3262 Novice Emacs Lisp programmers often try to use the mark for the wrong
3263 purposes. See the documentation of `set-mark' for more information.
3265 In Transient Mark mode, this does not activate the mark."
3266 (unless (null (mark t))
3267 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
3268 (when (> (length mark-ring) mark-ring-max)
3269 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
3270 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))
3271 (set-marker (mark-marker) (or location (point)) (current-buffer))
3272 ;; Now push the mark on the global mark ring.
3273 (if (and global-mark-ring
3274 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
3275 ;; The last global mark pushed was in this same buffer.
3276 ;; Don't push another one.
3277 nil
3278 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
3279 (when (> (length global-mark-ring) global-mark-ring-max)
3280 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring)) nil)
3281 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))
3282 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
3283 (message "Mark set"))
3284 (if (or activate (not transient-mark-mode))
3285 (set-mark (mark t)))
3286 nil)
3288 (defun pop-mark ()
3289 "Pop off mark ring into the buffer's actual mark.
3290 Does not set point. Does nothing if mark ring is empty."
3291 (when mark-ring
3292 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
3293 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
3294 (move-marker (car mark-ring) nil)
3295 (if (null (mark t)) (ding))
3296 (setq mark-ring (cdr mark-ring)))
3297 (deactivate-mark))
3299 (defalias 'exchange-dot-and-mark 'exchange-point-and-mark)
3300 (defun exchange-point-and-mark (&optional arg)
3301 "Put the mark where point is now, and point where the mark is now.
3302 This command works even when the mark is not active,
3303 and it reactivates the mark.
3304 With prefix arg, `transient-mark-mode' is enabled temporarily."
3305 (interactive "P")
3306 (if arg
3307 (if mark-active
3308 (if (null transient-mark-mode)
3309 (setq transient-mark-mode 'lambda))
3310 (setq arg nil)))
3311 (unless arg
3312 (let ((omark (mark t)))
3313 (if (null omark)
3314 (error "No mark set in this buffer"))
3315 (set-mark (point))
3316 (goto-char omark)
3317 nil)))
3319 (define-minor-mode transient-mark-mode
3320 "Toggle Transient Mark mode.
3321 With arg, turn Transient Mark mode on if arg is positive, off otherwise.
3323 In Transient Mark mode, when the mark is active, the region is highlighted.
3325 So do certain other operations that set the mark
3326 but whose main purpose is something else--for example,
3332 Many commands change their behavior when Transient Mark mode is in effect
3333 and the mark is active, by acting on the region instead of their usual
3334 default part of the buffer's text. Examples of such commands include
3339 commands which are sensitive to the Transient Mark mode."
3340 :global t :group 'editing-basics)
3342 (defvar widen-automatically t
3343 "Non-nil means it is ok for commands to call `widen' when they want to.
3344 Some commands will do this in order to go to positions outside
3345 the current accessible part of the buffer.
3347 If `widen-automatically' is nil, these commands will do something else
3348 as a fallback, and won't change the buffer bounds.")
3350 (defun pop-global-mark ()
3351 "Pop off global mark ring and jump to the top location."
3352 (interactive)
3353 ;; Pop entries which refer to non-existent buffers.
3354 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
3355 (setq global-mark-ring (cdr global-mark-ring)))
3356 (or global-mark-ring
3357 (error "No global mark set"))
3358 (let* ((marker (car global-mark-ring))
3359 (buffer (marker-buffer marker))
3360 (position (marker-position marker)))
3361 (setq global-mark-ring (nconc (cdr global-mark-ring)
3362 (list (car global-mark-ring))))
3363 (set-buffer buffer)
3364 (or (and (>= position (point-min))
3365 (<= position (point-max)))
3366 (if widen-automatically
3367 (widen)
3368 (error "Global mark position is outside accessible part of buffer")))
3369 (goto-char position)
3370 (switch-to-buffer buffer)))
3371 \f
3372 (defcustom next-line-add-newlines nil
3373 "*If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
3374 :type 'boolean
3375 :version "21.1"
3376 :group 'editing-basics)
3378 (defun next-line (&optional arg try-vscroll)
3379 "Move cursor vertically down ARG lines.
3380 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
3381 If there is no character in the target line exactly under the current column,
3382 the cursor is positioned after the character in that line which spans this
3383 column, or at the end of the line if it is not long enough.
3384 If there is no line in the buffer after this one, behavior depends on the
3385 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
3386 to create a line, and moves the cursor to that line. Otherwise it moves the
3387 cursor to the end of the buffer.
3390 a semipermanent goal column for this command.
3391 Then instead of trying to move exactly vertically (or as close as possible),
3392 this command moves to the specified goal column (or as close as possible).
3393 The goal column is stored in the variable `goal-column', which is nil
3394 when there is no goal column.
3396 If you are thinking of using this in a Lisp program, consider
3397 using `forward-line' instead. It is usually easier to use
3398 and more reliable (no dependence on goal column, etc.)."
3400 (or arg (setq arg 1))
3401 (if (and next-line-add-newlines (= arg 1))
3402 (if (save-excursion (end-of-line) (eobp))
3403 ;; When adding a newline, don't expand an abbrev.
3404 (let ((abbrev-mode nil))
3405 (end-of-line)
3407 (line-move arg nil nil try-vscroll))
3408 (if (interactive-p)
3409 (condition-case nil
3410 (line-move arg nil nil try-vscroll)
3411 ((beginning-of-buffer end-of-buffer) (ding)))
3412 (line-move arg nil nil try-vscroll)))
3413 nil)
3415 (defun previous-line (&optional arg try-vscroll)
3416 "Move cursor vertically up ARG lines.
3417 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
3418 If there is no character in the target line exactly over the current column,
3419 the cursor is positioned after the character in that line which spans this
3420 column, or at the end of the line if it is not long enough.
3423 a semipermanent goal column for this command.
3424 Then instead of trying to move exactly vertically (or as close as possible),
3425 this command moves to the specified goal column (or as close as possible).
3426 The goal column is stored in the variable `goal-column', which is nil
3427 when there is no goal column.
3429 If you are thinking of using this in a Lisp program, consider using
3430 `forward-line' with a negative argument instead. It is usually easier
3431 to use and more reliable (no dependence on goal column, etc.)."
3433 (or arg (setq arg 1))
3434 (if (interactive-p)
3435 (condition-case nil
3436 (line-move (- arg) nil nil try-vscroll)
3437 ((beginning-of-buffer end-of-buffer) (ding)))
3438 (line-move (- arg) nil nil try-vscroll))
3439 nil)
3441 (defcustom track-eol nil
3442 "*Non-nil means vertical motion starting at end of line keeps to ends of lines.
3443 This means moving to the end of each line moved onto.
3444 The beginning of a blank line does not count as the end of a line."
3445 :type 'boolean
3446 :group 'editing-basics)
3448 (defcustom goal-column nil
3450 :type '(choice integer
3451 (const :tag "None" nil))
3452 :group 'editing-basics)
3453 (make-variable-buffer-local 'goal-column)
3455 (defvar temporary-goal-column 0
3456 "Current goal column for vertical motion.
3457 It is the column where point was
3458 at the start of current run of vertical motion commands.
3459 When the `track-eol' feature is doing its job, the value is 9999.")
3461 (defcustom line-move-ignore-invisible t
3463 Outline mode sets this."
3464 :type 'boolean
3465 :group 'editing-basics)
3467 (defun line-move-invisible-p (pos)
3468 "Return non-nil if the character after POS is currently invisible."
3469 (let ((prop
3470 (get-char-property pos 'invisible)))
3471 (if (eq buffer-invisibility-spec t)
3472 prop
3473 (or (memq prop buffer-invisibility-spec)
3474 (assq prop buffer-invisibility-spec)))))
3476 ;; This is like line-move-1 except that it also performs
3477 ;; vertical scrolling of tall images if appropriate.
3478 ;; That is not really a clean thing to do, since it mixes
3479 ;; scrolling with cursor motion. But so far we don't have
3480 ;; a cleaner solution to the problem of making C-n do something
3481 ;; useful given a tall image.
3482 (defun line-move (arg &optional noerror to-end try-vscroll)
3483 (if (and auto-window-vscroll try-vscroll
3484 ;; But don't vscroll in a keyboard macro.
3485 (not defining-kbd-macro)
3486 (not executing-kbd-macro))
3487 (let ((forward (> arg 0))
3488 (part (nth 2 (pos-visible-in-window-p (point) nil t))))
3489 (if (and (consp part)
3490 (> (if forward (cdr part) (car part)) 0))
3491 (set-window-vscroll nil
3492 (if forward
3493 (+ (window-vscroll nil t)
3494 (min (cdr part)
3495 (* (frame-char-height) arg)))
3496 (max 0
3497 (- (window-vscroll nil t)
3498 (min (car part)
3499 (* (frame-char-height) (- arg))))))
3500 t)
3501 (set-window-vscroll nil 0)
3502 (when (line-move-1 arg noerror to-end)
3503 (when (not forward)
3504 ;; Update display before calling pos-visible-in-window-p,
3505 ;; because it depends on window-start being up-to-date.
3506 (sit-for 0)
3507 ;; If the current line is partly hidden at the bottom,
3508 ;; scroll it partially up so as to unhide the bottom.
3509 (if (and (setq part (nth 2 (pos-visible-in-window-p
3510 (line-beginning-position) nil t)))
3511 (> (cdr part) 0))
3512 (set-window-vscroll nil (cdr part) t)))
3513 t)))
3514 (line-move-1 arg noerror to-end)))
3516 ;; This is the guts of next-line and previous-line.
3517 ;; Arg says how many lines to move.
3518 ;; The value is t if we can move the specified number of lines.
3519 (defun line-move-1 (arg &optional noerror to-end)
3520 ;; Don't run any point-motion hooks, and disregard intangibility,
3521 ;; for intermediate positions.
3522 (let ((inhibit-point-motion-hooks t)
3523 (opoint (point))
3524 (forward (> arg 0)))
3525 (unwind-protect
3526 (progn
3527 (if (not (memq last-command '(next-line previous-line)))
3528 (setq temporary-goal-column
3529 (if (and track-eol (eolp)
3530 ;; Don't count beg of empty line as end of line
3531 ;; unless we just did explicit end-of-line.
3532 (or (not (bolp)) (eq last-command 'move-end-of-line)))
3533 9999
3534 (current-column))))
3536 (if (and (not (integerp selective-display))
3537 (not line-move-ignore-invisible))
3538 ;; Use just newline characters.
3539 ;; Set ARG to 0 if we move as many lines as requested.
3540 (or (if (> arg 0)
3541 (progn (if (> arg 1) (forward-line (1- arg)))
3542 ;; This way of moving forward ARG lines
3543 ;; verifies that we have a newline after the last one.
3544 ;; It doesn't get confused by intangible text.
3545 (end-of-line)
3546 (if (zerop (forward-line 1))
3547 (setq arg 0)))
3548 (and (zerop (forward-line arg))
3549 (bolp)
3550 (setq arg 0)))
3551 (unless noerror
3552 (signal (if (< arg 0)
3553 'beginning-of-buffer
3554 'end-of-buffer)
3555 nil)))
3556 ;; Move by arg lines, but ignore invisible ones.
3557 (let (done)
3558 (while (and (> arg 0) (not done))
3559 ;; If the following character is currently invisible,
3560 ;; skip all characters with that same `invisible' property value.
3561 (while (and (not (eobp)) (line-move-invisible-p (point)))
3562 (goto-char (next-char-property-change (point))))
3563 ;; Now move a line.
3564 (end-of-line)
3565 ;; If there's no invisibility here, move over the newline.
3566 (cond
3567 ((eobp)
3568 (if (not noerror)
3569 (signal 'end-of-buffer nil)
3570 (setq done t)))
3571 ((and (> arg 1) ;; Use vertical-motion for last move
3572 (not (integerp selective-display))
3573 (not (line-move-invisible-p (point))))
3574 ;; We avoid vertical-motion when possible
3575 ;; because that has to fontify.
3576 (forward-line 1))
3577 ;; Otherwise move a more sophisticated way.
3578 ((zerop (vertical-motion 1))
3579 (if (not noerror)
3580 (signal 'end-of-buffer nil)
3581 (setq done t))))
3582 (unless done
3583 (setq arg (1- arg))))
3584 ;; The logic of this is the same as the loop above,
3585 ;; it just goes in the other direction.
3586 (while (and (< arg 0) (not done))
3587 (beginning-of-line)
3588 (cond
3589 ((bobp)
3590 (if (not noerror)
3591 (signal 'beginning-of-buffer nil)
3592 (setq done t)))
3593 ((and (< arg -1) ;; Use vertical-motion for last move
3594 (not (integerp selective-display))
3595 (not (line-move-invisible-p (1- (point)))))
3596 (forward-line -1))
3597 ((zerop (vertical-motion -1))
3598 (if (not noerror)
3599 (signal 'beginning-of-buffer nil)
3600 (setq done t))))
3601 (unless done
3602 (setq arg (1+ arg))
3603 (while (and ;; Don't move over previous invis lines
3604 ;; if our target is the middle of this line.
3605 (or (zerop (or goal-column temporary-goal-column))
3606 (< arg 0))
3607 (not (bobp)) (line-move-invisible-p (1- (point))))
3608 (goto-char (previous-char-property-change (point))))))))
3609 ;; This is the value the function returns.
3610 (= arg 0))
3612 (cond ((> arg 0)
3613 ;; If we did not move down as far as desired,
3614 ;; at least go to end of line.
3615 (end-of-line))
3616 ((< arg 0)
3617 ;; If we did not move up as far as desired,
3618 ;; at least go to beginning of line.
3619 (beginning-of-line))
3620 (t
3621 (line-move-finish (or goal-column temporary-goal-column)
3622 opoint forward))))))
3624 (defun line-move-finish (column opoint forward)
3625 (let ((repeat t))
3626 (while repeat
3627 ;; Set REPEAT to t to repeat the whole thing.
3628 (setq repeat nil)
3630 (let (new
3631 (line-beg (save-excursion (beginning-of-line) (point)))
3632 (line-end
3633 ;; Compute the end of the line
3634 ;; ignoring effectively invisible newlines.
3635 (save-excursion
3636 ;; Like end-of-line but ignores fields.
3638 (while (and (not (eobp)) (line-move-invisible-p (point)))
3639 (goto-char (next-char-property-change (point)))
3641 (point))))
3643 ;; Move to the desired column.
3644 (line-move-to-column column)
3645 (setq new (point))
3647 ;; Process intangibility within a line.
3648 ;; With inhibit-point-motion-hooks bound to nil, a call to
3649 ;; goto-char moves point past intangible text.
3651 ;; However, inhibit-point-motion-hooks controls both the
3652 ;; intangibility and the point-entered/point-left hooks. The
3653 ;; following hack avoids calling the point-* hooks
3654 ;; unnecessarily. Note that we move *forward* past intangible
3655 ;; text when the initial and final points are the same.
3656 (goto-char new)
3657 (let ((inhibit-point-motion-hooks nil))
3658 (goto-char new)
3660 ;; If intangibility moves us to a different (later) place
3661 ;; in the same line, use that as the destination.
3662 (if (<= (point) line-end)
3663 (setq new (point))
3664 ;; If that position is "too late",
3665 ;; try the previous allowable position.
3666 ;; See if it is ok.
3667 (backward-char)
3668 (if (if forward
3669 ;; If going forward, don't accept the previous
3670 ;; allowable position if it is before the target line.
3671 (< line-beg (point))
3672 ;; If going backward, don't accept the previous
3673 ;; allowable position if it is still after the target line.
3674 (<= (point) line-end))
3675 (setq new (point))
3676 ;; As a last resort, use the end of the line.
3677 (setq new line-end))))
3679 ;; Now move to the updated destination, processing fields
3680 ;; as well as intangibility.
3681 (goto-char opoint)
3682 (let ((inhibit-point-motion-hooks nil))
3683 (goto-char
3684 (constrain-to-field new opoint nil t
3685 'inhibit-line-move-field-capture)))
3687 ;; If all this moved us to a different line,
3688 ;; retry everything within that new line.
3689 (when (or (< (point) line-beg) (> (point) line-end))
3690 ;; Repeat the intangibility and field processing.
3691 (setq repeat t))))))
3693 (defun line-move-to-column (col)
3694 "Try to find column COL, considering invisibility.
3695 This function works only in certain cases,
3696 because what we really need is for `move-to-column'
3697 and `current-column' to be able to ignore invisible text."
3698 (if (zerop col)
3699 (beginning-of-line)
3700 (move-to-column col))
3702 (when (and line-move-ignore-invisible
3703 (not (bolp)) (line-move-invisible-p (1- (point))))
3704 (let ((normal-location (point))
3705 (normal-column (current-column)))
3706 ;; If the following character is currently invisible,
3707 ;; skip all characters with that same `invisible' property value.
3708 (while (and (not (eobp))
3709 (line-move-invisible-p (point)))
3710 (goto-char (next-char-property-change (point))))
3711 ;; Have we advanced to a larger column position?
3712 (if (> (current-column) normal-column)
3713 ;; We have made some progress towards the desired column.
3714 ;; See if we can make any further progress.
3715 (line-move-to-column (+ (current-column) (- col normal-column)))
3716 ;; Otherwise, go to the place we originally found
3717 ;; and move back over invisible text.
3718 ;; that will get us to the same place on the screen
3719 ;; but with a more reasonable buffer position.
3720 (goto-char normal-location)
3721 (let ((line-beg (save-excursion (beginning-of-line) (point))))
3722 (while (and (not (bolp)) (line-move-invisible-p (1- (point))))
3723 (goto-char (previous-char-property-change (point) line-beg))))))))
3725 (defun move-end-of-line (arg)
3726 "Move point to end of current line as displayed.
3727 \(If there's an image in the line, this disregards newlines
3728 which are part of the text that the image rests on.)
3730 With argument ARG not nil or 1, move forward ARG - 1 lines first.
3731 If point reaches the beginning or end of buffer, it stops there.
3732 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
3733 (interactive "p")
3734 (or arg (setq arg 1))
3735 (let (done)
3736 (while (not done)
3737 (let ((newpos
3738 (save-excursion
3739 (let ((goal-column 0))
3740 (and (line-move arg t)
3741 (not (bobp))
3742 (progn
3743 (while (and (not (bobp)) (line-move-invisible-p (1- (point))))
3744 (goto-char (previous-char-property-change (point))))
3745 (backward-char 1)))
3746 (point)))))
3747 (goto-char newpos)
3748 (if (and (> (point) newpos)
3750 (backward-char 1)
3751 (if (and (> (point) newpos) (not (eobp))
3753 ;; If we skipped something intangible
3754 ;; and now we're not really at eol,
3755 ;; keep going.
3756 (setq arg 1)
3757 (setq done t)))))))
3759 (defun move-beginning-of-line (arg)
3760 "Move point to beginning of current line as displayed.
3761 \(If there's an image in the line, this disregards newlines
3762 which are part of the text that the image rests on.)
3764 With argument ARG not nil or 1, move forward ARG - 1 lines first.
3765 If point reaches the beginning or end of buffer, it stops there.
3766 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
3767 (interactive "p")
3768 (or arg (setq arg 1))
3770 (let ((orig (point)))
3772 ;; Move by lines, if ARG is not 1 (the default).
3773 (if (/= arg 1)
3774 (line-move (1- arg) t))
3776 ;; Move to beginning-of-line, ignoring fields and invisibles.
3778 (while (and (not (bobp)) (line-move-invisible-p (1- (point))))
3779 (goto-char (previous-char-property-change (point)))
3782 ;; Take care of fields.
3783 (goto-char (constrain-to-field (point) orig
3784 (/= arg 1) t nil))))
3787 ;;; Many people have said they rarely use this feature, and often type
3788 ;;; it by accident. Maybe it shouldn't even be on a key.
3789 (put 'set-goal-column 'disabled t)
3791 (defun set-goal-column (arg)
3793 Those commands will move to this position in the line moved to
3794 rather than trying to keep the same horizontal position.
3795 With a non-nil argument, clears out the goal column
3797 The goal column is stored in the variable `goal-column'."
3798 (interactive "P")
3799 (if arg
3800 (progn
3801 (setq goal-column nil)
3802 (message "No goal column"))
3803 (setq goal-column (current-column))
3804 ;; The older method below can be erroneous if `set-goal-column' is bound
3805 ;; to a sequence containing %
3806 ;;(message (substitute-command-keys
3808 ;;goal-column)
3809 (message "%s"
3810 (concat
3811 (format "Goal column %d " goal-column)
3812 (substitute-command-keys
3815 )
3816 nil)
3817 \f
3819 (defun scroll-other-window-down (lines)
3821 For more details, see the documentation for `scroll-other-window'."
3822 (interactive "P")
3823 (scroll-other-window
3824 ;; Just invert the argument's meaning.
3825 ;; We can do that without knowing which window it will be.
3826 (if (eq lines '-) nil
3827 (if (null lines) '-
3828 (- (prefix-numeric-value lines))))))
3830 (defun beginning-of-buffer-other-window (arg)
3831 "Move point to the beginning of the buffer in the other window.
3832 Leave mark at previous position.
3833 With arg N, put point N/10 of the way from the true beginning."
3834 (interactive "P")
3835 (let ((orig-window (selected-window))
3836 (window (other-window-for-scrolling)))
3837 ;; We use unwind-protect rather than save-window-excursion
3838 ;; because the latter would preserve the things we want to change.
3839 (unwind-protect
3840 (progn
3841 (select-window window)
3842 ;; Set point and mark in that window's buffer.
3843 (with-no-warnings
3844 (beginning-of-buffer arg))
3845 ;; Set point accordingly.
3846 (recenter '(t)))
3847 (select-window orig-window))))
3849 (defun end-of-buffer-other-window (arg)
3850 "Move point to the end of the buffer in the other window.
3851 Leave mark at previous position.
3852 With arg N, put point N/10 of the way from the true end."
3853 (interactive "P")
3854 ;; See beginning-of-buffer-other-window for comments.
3855 (let ((orig-window (selected-window))
3856 (window (other-window-for-scrolling)))
3857 (unwind-protect
3858 (progn
3859 (select-window window)
3860 (with-no-warnings
3861 (end-of-buffer arg))
3862 (recenter '(t)))
3863 (select-window orig-window))))
3864 \f
3865 (defun transpose-chars (arg)
3866 "Interchange characters around point, moving forward one character.
3867 With prefix arg ARG, effect is to take character before point
3868 and drag it forward past ARG other characters (backward if ARG negative).
3869 If no argument and at end of line, the previous two chars are exchanged."
3870 (interactive "*P")
3871 (and (null arg) (eolp) (forward-char -1))
3872 (transpose-subr 'forward-char (prefix-numeric-value arg)))
3874 (defun transpose-words (arg)
3875 "Interchange words around point, leaving point at end of them.
3876 With prefix arg ARG, effect is to take word before or around point
3877 and drag it forward past ARG other words (backward if ARG negative).
3878 If ARG is zero, the words around or after point and around or after mark
3879 are interchanged."
3880 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
3881 (interactive "*p")
3882 (transpose-subr 'forward-word arg))
3884 (defun transpose-sexps (arg)
3886 Does not work on a sexp that point is in the middle of
3887 if it is a list or string."
3888 (interactive "*p")
3889 (transpose-subr
3890 (lambda (arg)
3891 ;; Here we should try to simulate the behavior of
3892 ;; (cons (progn (forward-sexp x) (point))
3893 ;; (progn (forward-sexp (- x)) (point)))
3894 ;; Except that we don't want to rely on the second forward-sexp
3895 ;; putting us back to where we want to be, since forward-sexp-function
3896 ;; might do funny things like infix-precedence.
3897 (if (if (> arg 0)
3899 (and (not (bobp))
3901 ;; Jumping over a symbol. We might be inside it, mind you.
3902 (progn (funcall (if (> arg 0)
3903 'skip-syntax-backward 'skip-syntax-forward)
3904 "w_")
3905 (cons (save-excursion (forward-sexp arg) (point)) (point)))
3906 ;; Otherwise, we're between sexps. Take a step back before jumping
3907 ;; to make sure we'll obey the same precedence no matter which direction
3908 ;; we're going.
3909 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
3910 (cons (save-excursion (forward-sexp arg) (point))
3911 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
3912 (not (zerop (funcall (if (> arg 0)
3913 'skip-syntax-forward
3914 'skip-syntax-backward)
3915 ".")))))
3916 (point)))))
3917 arg 'special))
3919 (defun transpose-lines (arg)
3920 "Exchange current line and previous line, leaving point after both.
3921 With argument ARG, takes previous line and moves it past ARG lines.
3922 With argument 0, interchanges line point is in with line mark is in."
3923 (interactive "*p")
3924 (transpose-subr (function
3925 (lambda (arg)
3926 (if (> arg 0)
3927 (progn
3928 ;; Move forward over ARG lines,
3929 ;; but create newlines if necessary.
3930 (setq arg (forward-line arg))
3932 (setq arg (1+ arg)))
3933 (if (> arg 0)
3934 (newline arg)))
3935 (forward-line arg))))
3936 arg))
3938 (defun transpose-subr (mover arg &optional special)
3939 (let ((aux (if special mover
3940 (lambda (x)
3941 (cons (progn (funcall mover x) (point))
3942 (progn (funcall mover (- x)) (point))))))
3943 pos1 pos2)
3944 (cond
3945 ((= arg 0)
3946 (save-excursion
3947 (setq pos1 (funcall aux 1))
3948 (goto-char (mark))
3949 (setq pos2 (funcall aux 1))
3950 (transpose-subr-1 pos1 pos2))
3951 (exchange-point-and-mark))
3952 ((> arg 0)
3953 (setq pos1 (funcall aux -1))
3954 (setq pos2 (funcall aux arg))
3955 (transpose-subr-1 pos1 pos2)
3956 (goto-char (car pos2)))
3957 (t
3958 (setq pos1 (funcall aux -1))
3959 (goto-char (car pos1))
3960 (setq pos2 (funcall aux arg))
3961 (transpose-subr-1 pos1 pos2)))))
3963 (defun transpose-subr-1 (pos1 pos2)
3964 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
3965 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
3966 (when (> (car pos1) (car pos2))
3967 (let ((swap pos1))
3968 (setq pos1 pos2 pos2 swap)))
3969 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
3970 (atomic-change-group
3971 (let (word2)
3972 ;; FIXME: We first delete the two pieces of text, so markers that
3973 ;; used to point to after the text end up pointing to before it :-(
3974 (setq word2 (delete-and-extract-region (car pos2) (cdr pos2)))
3975 (goto-char (car pos2))
3976 (insert (delete-and-extract-region (car pos1) (cdr pos1)))
3977 (goto-char (car pos1))
3978 (insert word2))))
3979 \f
3980 (defun backward-word (&optional arg)
3981 "Move backward until encountering the beginning of a word.
3982 With argument, do this that many times."
3983 (interactive "p")
3984 (forward-word (- (or arg 1))))
3986 (defun mark-word (&optional arg allow-extend)
3987 "Set mark ARG words away from point.
3989 move to with the same argument.
3990 Interactively, if this command is repeated
3991 or (in Transient Mark mode) if the mark is active,
3992 it marks the next ARG words after the ones already marked."
3994 (cond ((and allow-extend
3995 (or (and (eq last-command this-command) (mark t))
3996 (and transient-mark-mode mark-active)))
3997 (setq arg (if arg (prefix-numeric-value arg)
3998 (if (< (mark) (point)) -1 1)))
3999 (set-mark
4000 (save-excursion
4001 (goto-char (mark))
4002 (forward-word arg)
4003 (point))))
4004 (t
4005 (push-mark
4006 (save-excursion
4007 (forward-word (prefix-numeric-value arg))
4008 (point))
4009 nil t))))
4011 (defun kill-word (arg)
4012 "Kill characters forward until encountering the end of a word.
4013 With argument, do this that many times."
4014 (interactive "p")
4015 (kill-region (point) (progn (forward-word arg) (point))))
4017 (defun backward-kill-word (arg)
4018 "Kill characters backward until encountering the end of a word.
4019 With argument, do this that many times."
4020 (interactive "p")
4021 (kill-word (- arg)))
4023 (defun current-word (&optional strict really-word)
4024 "Return the symbol or word that point is on (or a nearby one) as a string.
4025 The return value includes no text properties.
4026 If optional arg STRICT is non-nil, return nil unless point is within
4027 or adjacent to a symbol or word. In all cases the value can be nil
4028 if there is no word nearby.
4029 The function, belying its name, normally finds a symbol.
4030 If optional arg REALLY-WORD is non-nil, it finds just a word."
4031 (save-excursion
4032 (let* ((oldpoint (point)) (start (point)) (end (point))
4033 (syntaxes (if really-word "w" "w_"))
4034 (not-syntaxes (concat "^" syntaxes)))
4035 (skip-syntax-backward syntaxes) (setq start (point))
4036 (goto-char oldpoint)
4037 (skip-syntax-forward syntaxes) (setq end (point))
4038 (when (and (eq start oldpoint) (eq end oldpoint)
4039 ;; Point is neither within nor adjacent to a word.
4040 (not strict))
4041 ;; Look for preceding word in same line.
4042 (skip-syntax-backward not-syntaxes
4043 (save-excursion (beginning-of-line)
4044 (point)))
4045 (if (bolp)
4046 ;; No preceding word in same line.
4047 ;; Look for following word in same line.
4048 (progn
4049 (skip-syntax-forward not-syntaxes
4050 (save-excursion (end-of-line)
4051 (point)))
4052 (setq start (point))
4053 (skip-syntax-forward syntaxes)
4054 (setq end (point)))
4055 (setq end (point))
4056 (skip-syntax-backward syntaxes)
4057 (setq start (point))))
4058 ;; If we found something nonempty, return it as a string.
4059 (unless (= start end)
4060 (buffer-substring-no-properties start end)))))
4061 \f
4062 (defcustom fill-prefix nil
4063 "*String for filling to insert at front of new line, or nil for none."
4064 :type '(choice (const :tag "None" nil)
4065 string)
4066 :group 'fill)
4067 (make-variable-buffer-local 'fill-prefix)
4068 ;;;###autoload(put 'fill-prefix 'safe-local-variable 'string-or-null-p)
4070 (defcustom auto-fill-inhibit-regexp nil
4071 "*Regexp to match lines which should not be auto-filled."
4072 :type '(choice (const :tag "None" nil)
4073 regexp)
4074 :group 'fill)
4076 (defvar comment-line-break-function 'comment-indent-new-line
4077 "*Mode-specific function which line breaks and continues a comment.
4079 This function is only called during auto-filling of a comment section.
4080 The function should take a single optional argument, which is a flag
4081 indicating whether it should use soft newlines.")
4083 ;; This function is used as the auto-fill-function of a buffer
4084 ;; when Auto-Fill mode is enabled.
4085 ;; It returns t if it really did any work.
4086 ;; (Actually some major modes use a different auto-fill function,
4087 ;; but this one is the default one.)
4088 (defun do-auto-fill ()
4089 (let (fc justify give-up
4090 (fill-prefix fill-prefix))
4091 (if (or (not (setq justify (current-justification)))
4092 (null (setq fc (current-fill-column)))
4093 (and (eq justify 'left)
4094 (<= (current-column) fc))
4095 (and auto-fill-inhibit-regexp
4096 (save-excursion (beginning-of-line)
4097 (looking-at auto-fill-inhibit-regexp))))
4098 nil ;; Auto-filling not required
4099 (if (memq justify '(full center right))
4100 (save-excursion (unjustify-current-line)))
4102 ;; Choose a fill-prefix automatically.
4103 (when (and adaptive-fill-mode
4104 (or (null fill-prefix) (string= fill-prefix "")))
4105 (let ((prefix
4106 (fill-context-prefix
4107 (save-excursion (backward-paragraph 1) (point))
4108 (save-excursion (forward-paragraph 1) (point)))))
4109 (and prefix (not (equal prefix ""))
4110 ;; Use auto-indentation rather than a guessed empty prefix.
4111 (not (and fill-indent-according-to-mode
4113 (setq fill-prefix prefix))))
4115 (while (and (not give-up) (> (current-column) fc))
4116 ;; Determine where to split the line.
4117 (let* (after-prefix
4118 (fill-point
4119 (save-excursion
4120 (beginning-of-line)
4121 (setq after-prefix (point))
4122 (and fill-prefix
4123 (looking-at (regexp-quote fill-prefix))
4124 (setq after-prefix (match-end 0)))
4125 (move-to-column (1+ fc))
4126 (fill-move-to-break-point after-prefix)
4127 (point))))
4129 ;; See whether the place we found is any good.
4130 (if (save-excursion
4131 (goto-char fill-point)
4132 (or (bolp)
4133 ;; There is no use breaking at end of line.
4134 (save-excursion (skip-chars-forward " ") (eolp))
4135 ;; It is futile to split at the end of the prefix
4136 ;; since we would just insert the prefix again.
4137 (and after-prefix (<= (point) after-prefix))
4138 ;; Don't split right after a comment starter
4139 ;; since we would just make another comment starter.
4140 (and comment-start-skip
4141 (let ((limit (point)))
4142 (beginning-of-line)
4143 (and (re-search-forward comment-start-skip
4144 limit t)
4145 (eq (point) limit))))))
4146 ;; No good place to break => stop trying.
4147 (setq give-up t)
4148 ;; Ok, we have a useful place to break the line. Do it.
4149 (let ((prev-column (current-column)))
4150 ;; If point is at the fill-point, do not `save-excursion'.
4151 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
4152 ;; point will end up before it rather than after it.
4153 (if (save-excursion
4155 (= (point) fill-point))
4156 (funcall comment-line-break-function t)
4157 (save-excursion
4158 (goto-char fill-point)
4159 (funcall comment-line-break-function t)))
4160 ;; Now do justification, if required
4161 (if (not (eq justify 'left))
4162 (save-excursion
4163 (end-of-line 0)
4164 (justify-current-line justify nil t)))
4165 ;; If making the new line didn't reduce the hpos of
4166 ;; the end of the line, then give up now;
4167 ;; trying again will not help.
4168 (if (>= (current-column) prev-column)
4169 (setq give-up t))))))
4170 ;; Justify last line.
4171 (justify-current-line justify t t)
4172 t)))
4174 (defvar normal-auto-fill-function 'do-auto-fill
4175 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
4176 Some major modes set this.")
4178 (put 'auto-fill-function :minor-mode-function 'auto-fill-mode)
4179 ;; FIXME: turn into a proper minor mode.
4180 ;; Add a global minor mode version of it.
4181 (defun auto-fill-mode (&optional arg)
4182 "Toggle Auto Fill mode.
4183 With arg, turn Auto Fill mode on if and only if arg is positive.
4184 In Auto Fill mode, inserting a space at a column beyond `current-fill-column'
4185 automatically breaks the line at a previous space.
4187 The value of `normal-auto-fill-function' specifies the function to use
4188 for `auto-fill-function' when turning Auto Fill mode on."
4189 (interactive "P")
4190 (prog1 (setq auto-fill-function
4191 (if (if (null arg)
4192 (not auto-fill-function)
4193 (> (prefix-numeric-value arg) 0))
4194 normal-auto-fill-function
4195 nil))
4196 (force-mode-line-update)))
4198 ;; This holds a document string used to document auto-fill-mode.
4199 (defun auto-fill-function ()
4200 "Automatically break line at a previous space, in insertion of text."
4201 nil)
4203 (defun turn-on-auto-fill ()
4204 "Unconditionally turn on Auto Fill mode."
4205 (auto-fill-mode 1))
4207 (defun turn-off-auto-fill ()
4208 "Unconditionally turn off Auto Fill mode."
4209 (auto-fill-mode -1))
4211 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
4213 (defun set-fill-column (arg)
4214 "Set `fill-column' to specified argument.
4217 (interactive "P")
4218 (if (consp arg)
4219 (setq arg (current-column)))
4220 (if (not (integerp arg))
4221 ;; Disallow missing argument; it's probably a typo for C-x C-f.
4222 (error "set-fill-column requires an explicit argument")
4223 (message "Fill column set to %d (was %d)" arg fill-column)
4224 (setq fill-column arg)))
4225 \f
4226 (defun set-selective-display (arg)
4227 "Set `selective-display' to ARG; clear it if no arg.
4228 When the value of `selective-display' is a number > 0,
4229 lines whose indentation is >= that value are not displayed.
4230 The variable `selective-display' has a separate value for each buffer."
4231 (interactive "P")
4232 (if (eq selective-display t)
4233 (error "selective-display already in use for marked lines"))
4234 (let ((current-vpos
4235 (save-restriction
4236 (narrow-to-region (point-min) (point))
4237 (goto-char (window-start))
4238 (vertical-motion (window-height)))))
4239 (setq selective-display
4240 (and arg (prefix-numeric-value arg)))
4241 (recenter current-vpos))
4242 (set-window-start (selected-window) (window-start (selected-window)))
4243 (princ "selective-display set to " t)
4244 (prin1 selective-display t)
4245 (princ "." t))
4247 (defvaralias 'indicate-unused-lines 'indicate-empty-lines)
4248 (defvaralias 'default-indicate-unused-lines 'default-indicate-empty-lines)
4250 (defun toggle-truncate-lines (&optional arg)
4251 "Toggle whether to fold or truncate long lines on the screen.
4252 With arg, truncate long lines iff arg is positive.
4253 Note that in side-by-side windows, truncation is always enabled."
4254 (interactive "P")
4255 (setq truncate-lines
4256 (if (null arg)
4257 (not truncate-lines)
4258 (> (prefix-numeric-value arg) 0)))
4259 (force-mode-line-update)
4260 (unless truncate-lines
4261 (let ((buffer (current-buffer)))
4262 (walk-windows (lambda (window)
4263 (if (eq buffer (window-buffer window))
4264 (set-window-hscroll window 0)))
4265 nil t)))
4266 (message "Truncate long lines %s"
4267 (if truncate-lines "enabled" "disabled")))
4269 (defvar overwrite-mode-textual " Ovwrt"
4270 "The string displayed in the mode line when in overwrite mode.")
4271 (defvar overwrite-mode-binary " Bin Ovwrt"
4272 "The string displayed in the mode line when in binary overwrite mode.")
4274 (defun overwrite-mode (arg)
4275 "Toggle overwrite mode.
4276 With arg, turn overwrite mode on iff arg is positive.
4277 In overwrite mode, printing characters typed in replace existing text
4278 on a one-for-one basis, rather than pushing it to the right. At the
4279 end of a line, such characters extend the line. Before a tab,
4280 such characters insert until the tab is filled in.
4282 is supposed to make it easier to insert characters when necessary."
4283 (interactive "P")
4284 (setq overwrite-mode
4285 (if (if (null arg) (not overwrite-mode)
4286 (> (prefix-numeric-value arg) 0))
4287 'overwrite-mode-textual))
4288 (force-mode-line-update))
4290 (defun binary-overwrite-mode (arg)
4291 "Toggle binary overwrite mode.
4292 With arg, turn binary overwrite mode on iff arg is positive.
4293 In binary overwrite mode, printing characters typed in replace
4294 existing text. Newlines are not treated specially, so typing at the
4295 end of a line joins the line to the next, with the typed character
4296 between them. Typing before a tab character simply replaces the tab
4297 with the character typed.
4299 typing characters do.
4301 Note that binary overwrite mode is not its own minor mode; it is a
4302 specialization of overwrite mode, entered by setting the
4303 `overwrite-mode' variable to `overwrite-mode-binary'."
4304 (interactive "P")
4305 (setq overwrite-mode
4306 (if (if (null arg)
4307 (not (eq overwrite-mode 'overwrite-mode-binary))
4308 (> (prefix-numeric-value arg) 0))
4309 'overwrite-mode-binary))
4310 (force-mode-line-update))
4312 (define-minor-mode line-number-mode
4313 "Toggle Line Number mode.
4314 With arg, turn Line Number mode on iff arg is positive.
4315 When Line Number mode is enabled, the line number appears
4316 in the mode line.
4318 Line numbers do not appear for very large buffers and buffers
4319 with very long lines; see variables `line-number-display-limit'
4320 and `line-number-display-limit-width'."
4321 :init-value t :global t :group 'editing-basics)
4323 (define-minor-mode column-number-mode
4324 "Toggle Column Number mode.
4325 With arg, turn Column Number mode on iff arg is positive.
4326 When Column Number mode is enabled, the column number appears
4327 in the mode line."
4328 :global t :group 'editing-basics)
4330 (define-minor-mode size-indication-mode
4331 "Toggle Size Indication mode.
4332 With arg, turn Size Indication mode on iff arg is positive. When
4333 Size Indication mode is enabled, the size of the accessible part
4334 of the buffer appears in the mode line."
4335 :global t :group 'editing-basics)
4336 \f
4337 (defgroup paren-blinking nil
4338 "Blinking matching of parens and expressions."
4339 :prefix "blink-matching-"
4340 :group 'paren-matching)
4342 (defcustom blink-matching-paren t
4343 "*Non-nil means show matching open-paren when close-paren is inserted."
4344 :type 'boolean
4345 :group 'paren-blinking)
4347 (defcustom blink-matching-paren-on-screen t
4348 "*Non-nil means show matching open-paren when it is on screen.
4349 If nil, means don't show it (but the open-paren can still be shown
4350 when it is off screen).
4352 This variable has no effect if `blink-matching-paren' is nil.
4353 \(In that case, the open-paren is never shown.)
4354 It is also ignored if `show-paren-mode' is enabled."
4355 :type 'boolean
4356 :group 'paren-blinking)
4358 (defcustom blink-matching-paren-distance (* 25 1024)
4359 "*If non-nil, maximum distance to search backwards for matching open-paren.
4360 If nil, search stops at the beginning of the accessible portion of the buffer."
4361 :type '(choice (const nil) integer)
4362 :group 'paren-blinking)
4364 (defcustom blink-matching-delay 1
4365 "*Time in seconds to delay after showing a matching paren."
4366 :type 'number
4367 :group 'paren-blinking)
4369 (defcustom blink-matching-paren-dont-ignore-comments nil
4370 "*nil means `blink-matching-paren' ignores comments.
4371 More precisely, when looking for the matching parenthesis,
4372 it skips the contents of comments that end before point."
4373 :type 'boolean
4374 :group 'paren-blinking)
4376 (defun blink-matching-open ()
4377 "Move cursor momentarily to the beginning of the sexp before point."
4378 (interactive)
4379 (when (and (> (point) (point-min))
4380 blink-matching-paren
4381 ;; Verify an even number of quoting characters precede the close.
4382 (= 1 (logand 1 (- (point)
4383 (save-excursion
4384 (forward-char -1)
4386 (point))))))
4387 (let* ((oldpos (point))
4388 blinkpos
4389 message-log-max ; Don't log messages about paren matching.
4390 matching-paren
4391 open-paren-line-string)
4392 (save-excursion
4393 (save-restriction
4394 (if blink-matching-paren-distance
4395 (narrow-to-region (max (point-min)
4396 (- (point) blink-matching-paren-distance))
4397 oldpos))
4398 (condition-case ()
4399 (let ((parse-sexp-ignore-comments
4400 (and parse-sexp-ignore-comments
4401 (not blink-matching-paren-dont-ignore-comments))))
4402 (setq blinkpos (scan-sexps oldpos -1)))
4403 (error nil)))
4404 (and blinkpos
4405 ;; Not syntax '$'.
4406 (not (eq (syntax-class (syntax-after blinkpos)) 8))
4407 (setq matching-paren
4408 (let ((syntax (syntax-after blinkpos)))
4409 (and (consp syntax)
4410 (eq (syntax-class syntax) 4)
4411 (cdr syntax)))))
4412 (cond
4413 ((not (or (eq matching-paren (char-before oldpos))
4414 ;; The cdr might hold a new paren-class info rather than
4415 ;; a matching-char info, in which case the two CDRs
4416 ;; should match.
4417 (eq matching-paren (cdr (syntax-after (1- oldpos))))))
4418 (message "Mismatched parentheses"))
4419 ((not blinkpos)
4420 (if (not blink-matching-paren-distance)
4421 (message "Unmatched parenthesis")))
4422 ((pos-visible-in-window-p blinkpos)
4423 ;; Matching open within window, temporarily move to blinkpos but only
4424 ;; if `blink-matching-paren-on-screen' is non-nil.
4425 (and blink-matching-paren-on-screen
4426 (not show-paren-mode)
4427 (save-excursion
4428 (goto-char blinkpos)
4429 (sit-for blink-matching-delay))))
4430 (t
4431 (save-excursion
4432 (goto-char blinkpos)
4433 (setq open-paren-line-string
4434 ;; Show what precedes the open in its line, if anything.
4435 (if (save-excursion
4437 (not (bolp)))
4438 (buffer-substring (line-beginning-position)
4439 (1+ blinkpos))
4440 ;; Show what follows the open in its line, if anything.
4441 (if (save-excursion
4442 (forward-char 1)
4444 (not (eolp)))
4445 (buffer-substring blinkpos
4446 (line-end-position))
4447 ;; Otherwise show the previous nonblank line,
4448 ;; if there is one.
4449 (if (save-excursion
4451 (not (bobp)))
4452 (concat
4453 (buffer-substring (progn
4455 (line-beginning-position))
4456 (progn (end-of-line)
4458 (point)))
4459 ;; Replace the newline and other whitespace with `...'.
4460 "..."
4461 (buffer-substring blinkpos (1+ blinkpos)))
4462 ;; There is nothing to show except the char itself.
4463 (buffer-substring blinkpos (1+ blinkpos)))))))
4464 (message "Matches %s"
4465 (substring-no-properties open-paren-line-string))))))))
4467 ;Turned off because it makes dbx bomb out.
4468 (setq blink-paren-function 'blink-matching-open)
4469 \f
4470 ;; This executes C-g typed while Emacs is waiting for a command.
4471 ;; Quitting out of a program does not go through here;
4472 ;; that happens in the QUIT macro at the C code level.
4473 (defun keyboard-quit ()
4474 "Signal a `quit' condition.
4475 During execution of Lisp code, this character causes a quit directly.
4476 At top-level, as an editor command, this simply beeps."
4477 (interactive)
4478 (deactivate-mark)
4479 (if (fboundp 'kmacro-keyboard-quit)
4480 (kmacro-keyboard-quit))
4481 (setq defining-kbd-macro nil)
4482 (signal 'quit nil))
4484 (defvar buffer-quit-function nil
4487 \(such as cancelling a prefix argument, minibuffer or region) do not apply.")
4489 (defun keyboard-escape-quit ()
4491 This command can exit an interactive command such as `query-replace',
4492 can clear out a prefix argument or a region,
4493 can get out of the minibuffer or other recursive edit,
4494 cancel the use of the current buffer (for special-purpose buffers),
4495 or go back to just one window (by deleting all but the selected window)."
4496 (interactive)
4497 (cond ((eq last-command 'mode-exited) nil)
4498 ((> (minibuffer-depth) 0)
4499 (abort-recursive-edit))
4500 (current-prefix-arg
4501 nil)
4502 ((and transient-mark-mode mark-active)
4503 (deactivate-mark))
4504 ((> (recursion-depth) 0)
4505 (exit-recursive-edit))
4506 (buffer-quit-function
4507 (funcall buffer-quit-function))
4508 ((not (one-window-p t))
4509 (delete-other-windows))
4511 (bury-buffer))))
4513 (defun play-sound-file (file &optional volume device)
4514 "Play sound stored in FILE.
4515 VOLUME and DEVICE correspond to the keywords of the sound
4516 specification for `play-sound'."
4517 (interactive "fPlay sound file: ")
4518 (let ((sound (list :file file)))
4519 (if volume
4520 (plist-put sound :volume volume))
4521 (if device
4522 (plist-put sound :device device))
4523 (push 'sound sound)
4524 (play-sound sound)))
4526 \f
4527 (defcustom read-mail-command 'rmail
4528 "*Your preference for a mail reading package.
4529 This is used by some keybindings which support reading mail.
4530 See also `mail-user-agent' concerning sending mail."
4531 :type '(choice (function-item rmail)
4532 (function-item gnus)
4533 (function-item mh-rmail)
4534 (function :tag "Other"))
4535 :version "21.1"
4536 :group 'mail)
4538 (defcustom mail-user-agent 'sendmail-user-agent
4539 "*Your preference for a mail composition package.
4540 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
4541 outgoing email message. This variable lets you specify which
4542 mail-sending package you prefer.
4544 Valid values include:
4546 `sendmail-user-agent' -- use the default Emacs Mail package.
4547 See Info node `(emacs)Sending Mail'.
4548 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
4549 See Info node `(mh-e)'.
4550 `message-user-agent' -- use the Gnus Message package.
4551 See Info node `(message)'.
4552 `gnus-user-agent' -- like `message-user-agent', but with Gnus
4553 paraphernalia, particularly the Gcc: header for
4554 archiving.
4556 Additional valid symbols may be available; check with the author of
4557 your package for details. The function should return non-nil if it
4558 succeeds.
4560 See also `read-mail-command' concerning reading mail."
4561 :type '(radio (function-item :tag "Default Emacs mail"
4563 sendmail-user-agent)
4564 (function-item :tag "Emacs interface to MH"
4566 mh-e-user-agent)
4567 (function-item :tag "Gnus Message package"
4569 message-user-agent)
4570 (function-item :tag "Gnus Message with full Gnus features"
4572 gnus-user-agent)
4573 (function :tag "Other"))
4574 :group 'mail)
4576 (define-mail-user-agent 'sendmail-user-agent
4577 'sendmail-user-agent-compose
4578 'mail-send-and-exit)
4580 (defun rfc822-goto-eoh ()
4581 ;; Go to header delimiter line in a mail message, following RFC822 rules
4582 (goto-char (point-min))
4583 (when (re-search-forward
4585 (goto-char (match-beginning 0))))
4587 (defun sendmail-user-agent-compose (&optional to subject other-headers continue
4588 switch-function yank-action
4589 send-actions)
4590 (if switch-function
4591 (let ((special-display-buffer-names nil)
4592 (special-display-regexps nil)
4593 (same-window-buffer-names nil)
4594 (same-window-regexps nil))
4595 (funcall switch-function "*mail*")))
4596 (let ((cc (cdr (assoc-string "cc" other-headers t)))
4597 (in-reply-to (cdr (assoc-string "in-reply-to" other-headers t)))
4598 (body (cdr (assoc-string "body" other-headers t))))
4599 (or (mail continue to subject in-reply-to cc yank-action send-actions)
4600 continue
4601 (error "Message aborted"))
4602 (save-excursion
4603 (rfc822-goto-eoh)
4604 (while other-headers
4605 (unless (member-ignore-case (car (car other-headers))
4606 '("in-reply-to" "cc" "body"))
4607 (insert (car (car other-headers)) ": "
4608 (cdr (car other-headers))
4610 (setq other-headers (cdr other-headers)))
4611 (when body
4612 (forward-line 1)
4613 (insert body))
4614 t)))
4616 (defun compose-mail (&optional to subject other-headers continue
4617 switch-function yank-action send-actions)
4618 "Start composing a mail message to send.
4619 This uses the user's chosen mail composition package
4620 as selected with the variable `mail-user-agent'.
4621 The optional arguments TO and SUBJECT specify recipients
4622 and the initial Subject field, respectively.
4624 OTHER-HEADERS is an alist specifying additional
4625 header fields. Elements look like (HEADER . VALUE) where both
4626 HEADER and VALUE are strings.
4628 CONTINUE, if non-nil, says to continue editing a message already
4629 being composed.
4631 SWITCH-FUNCTION, if non-nil, is a function to use to
4632 switch to and display the buffer used for mail composition.
4634 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
4635 to insert the raw text of the message being replied to.
4636 It has the form (FUNCTION . ARGS). The user agent will apply
4637 FUNCTION to ARGS, to insert the raw text of the original message.
4638 \(The user agent will also run `mail-citation-hook', *after* the
4639 original text has been inserted in this way.)
4641 SEND-ACTIONS is a list of actions to call when the message is sent.
4642 Each action has the form (FUNCTION . ARGS)."
4643 (interactive
4644 (list nil nil nil current-prefix-arg))
4645 (let ((function (get mail-user-agent 'composefunc)))
4646 (funcall function to subject other-headers continue
4647 switch-function yank-action send-actions)))
4649 (defun compose-mail-other-window (&optional to subject other-headers continue
4650 yank-action send-actions)
4652 (interactive
4653 (list nil nil nil current-prefix-arg))
4654 (compose-mail to subject other-headers continue
4655 'switch-to-buffer-other-window yank-action send-actions))
4658 (defun compose-mail-other-frame (&optional to subject other-headers continue
4659 yank-action send-actions)
4661 (interactive
4662 (list nil nil nil current-prefix-arg))
4663 (compose-mail to subject other-headers continue
4664 'switch-to-buffer-other-frame yank-action send-actions))
4665 \f
4666 (defvar set-variable-value-history nil
4667 "History of values entered with `set-variable'.")
4669 (defun set-variable (variable value &optional make-local)
4670 "Set VARIABLE to VALUE. VALUE is a Lisp object.
4671 VARIABLE should be a user option variable name, a Lisp variable
4672 meant to be customized by users. You should enter VALUE in Lisp syntax,
4673 so if you want VALUE to be a string, you must surround it with doublequotes.
4674 VALUE is used literally, not evaluated.
4676 If VARIABLE has a `variable-interactive' property, that is used as if
4677 it were the arg to `interactive' (which see) to interactively read VALUE.
4679 If VARIABLE has been defined with `defcustom', then the type information
4680 in the definition is used to check that VALUE is valid.
4682 With a prefix argument, set VARIABLE to VALUE buffer-locally."
4683 (interactive
4684 (let* ((default-var (variable-at-point))
4685 (var (if (user-variable-p default-var)
4686 (read-variable (format "Set variable (default %s): " default-var)
4687 default-var)
4688 (read-variable "Set variable: ")))
4689 (minibuffer-help-form '(describe-variable var))
4690 (prop (get var 'variable-interactive))
4691 (obsolete (car (get var 'byte-obsolete-variable)))
4692 (prompt (format "Set %s %s to value: " var
4693 (cond ((local-variable-p var)
4694 "(buffer-local)")
4695 ((or current-prefix-arg
4696 (local-variable-if-set-p var))
4697 "buffer-locally")
4698 (t "globally"))))
4699 (val (progn
4700 (when obsolete
4701 (message (concat "`%S' is obsolete; "
4702 (if (symbolp obsolete) "use `%S' instead" "%s"))
4703 var obsolete)
4704 (sit-for 3))
4705 (if prop
4706 ;; Use VAR's `variable-interactive' property
4707 ;; as an interactive spec for prompting.
4708 (call-interactively `(lambda (arg)
4709 (interactive ,prop)
4710 arg))
4711 (read
4712 (read-string prompt nil
4713 'set-variable-value-history
4714 (format "%S" (symbol-value var))))))))
4715 (list var val current-prefix-arg)))
4717 (and (custom-variable-p variable)
4718 (not (get variable 'custom-type))
4719 (custom-load-symbol variable))
4720 (let ((type (get variable 'custom-type)))
4721 (when type
4722 ;; Match with custom type.
4723 (require 'cus-edit)
4724 (setq type (widget-convert type))
4725 (unless (widget-apply type :match value)
4726 (error "Value `%S' does not match type %S of %S"
4727 value (car type) variable))))
4729 (if make-local
4730 (make-local-variable variable))
4732 (set variable value)
4734 ;; Force a thorough redisplay for the case that the variable
4735 ;; has an effect on the display, like `tab-width' has.
4736 (force-mode-line-update))
4737 \f
4738 ;; Define the major mode for lists of completions.
4740 (defvar completion-list-mode-map nil
4741 "Local map for completion list buffers.")
4742 (or completion-list-mode-map
4743 (let ((map (make-sparse-keymap)))
4744 (define-key map [mouse-2] 'mouse-choose-completion)
4745 (define-key map [follow-link] 'mouse-face)
4746 (define-key map [down-mouse-2] nil)
4747 (define-key map "\C-m" 'choose-completion)
4748 (define-key map "\e\e\e" 'delete-completion-window)
4749 (define-key map [left] 'previous-completion)
4750 (define-key map [right] 'next-completion)
4751 (setq completion-list-mode-map map)))
4753 ;; Completion mode is suitable only for specially formatted data.
4754 (put 'completion-list-mode 'mode-class 'special)
4756 (defvar completion-reference-buffer nil
4757 "Record the buffer that was current when the completion list was requested.
4758 This is a local variable in the completion list buffer.
4759 Initial value is nil to avoid some compiler warnings.")
4761 (defvar completion-no-auto-exit nil
4762 "Non-nil means `choose-completion-string' should never exit the minibuffer.
4763 This also applies to other functions such as `choose-completion'
4764 and `mouse-choose-completion'.")
4766 (defvar completion-base-size nil
4767 "Number of chars at beginning of minibuffer not involved in completion.
4768 This is a local variable in the completion list buffer
4769 but it talks about the buffer in `completion-reference-buffer'.
4770 If this is nil, it means to compare text to determine which part
4771 of the tail end of the buffer's text is involved in completion.")
4773 (defun delete-completion-window ()
4774 "Delete the completion list window.
4775 Go to the window from which completion was requested."
4776 (interactive)
4777 (let ((buf completion-reference-buffer))
4778 (if (one-window-p t)
4779 (if (window-dedicated-p (selected-window))
4780 (delete-frame (selected-frame)))
4781 (delete-window (selected-window))
4782 (if (get-buffer-window buf)
4783 (select-window (get-buffer-window buf))))))
4785 (defun previous-completion (n)
4786 "Move to the previous item in the completion list."
4787 (interactive "p")
4788 (next-completion (- n)))
4790 (defun next-completion (n)
4791 "Move to the next item in the completion list.
4792 With prefix argument N, move N items (negative N means move backward)."
4793 (interactive "p")
4794 (let ((beg (point-min)) (end (point-max)))
4795 (while (and (> n 0) (not (eobp)))
4796 ;; If in a completion, move to the end of it.
4797 (when (get-text-property (point) 'mouse-face)
4798 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
4799 ;; Move to start of next one.
4800 (unless (get-text-property (point) 'mouse-face)
4801 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
4802 (setq n (1- n)))
4803 (while (and (< n 0) (not (bobp)))
4804 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
4805 ;; If in a completion, move to the start of it.
4806 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
4807 (goto-char (previous-single-property-change
4808 (point) 'mouse-face nil beg)))
4809 ;; Move to end of the previous completion.
4810 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
4811 (goto-char (previous-single-property-change
4812 (point) 'mouse-face nil beg)))
4813 ;; Move to the start of that one.
4814 (goto-char (previous-single-property-change
4815 (point) 'mouse-face nil beg))
4816 (setq n (1+ n))))))
4818 (defun choose-completion ()
4819 "Choose the completion that point is in or next to."
4820 (interactive)
4821 (let (beg end completion (buffer completion-reference-buffer)
4822 (base-size completion-base-size))
4823 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
4824 (setq end (point) beg (1+ (point))))
4825 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
4826 (setq end (1- (point)) beg (point)))
4827 (if (null beg)
4828 (error "No completion here"))
4829 (setq beg (previous-single-property-change beg 'mouse-face))
4830 (setq end (or (next-single-property-change end 'mouse-face) (point-max)))
4831 (setq completion (buffer-substring-no-properties beg end))
4832 (let ((owindow (selected-window)))
4833 (if (and (one-window-p t 'selected-frame)
4834 (window-dedicated-p (selected-window)))
4835 ;; This is a special buffer's frame
4836 (iconify-frame (selected-frame))
4837 (or (window-dedicated-p (selected-window))
4838 (bury-buffer)))
4839 (select-window owindow))
4840 (choose-completion-string completion buffer base-size)))
4842 ;; Delete the longest partial match for STRING
4843 ;; that can be found before POINT.
4844 (defun choose-completion-delete-max-match (string)
4845 (let ((opoint (point))
4846 len)
4847 ;; Try moving back by the length of the string.
4848 (goto-char (max (- (point) (length string))
4849 (minibuffer-prompt-end)))
4850 ;; See how far back we were actually able to move. That is the
4851 ;; upper bound on how much we can match and delete.
4852 (setq len (- opoint (point)))
4853 (if completion-ignore-case
4854 (setq string (downcase string)))
4855 (while (and (> len 0)
4856 (let ((tail (buffer-substring (point) opoint)))
4857 (if completion-ignore-case
4858 (setq tail (downcase tail)))
4859 (not (string= tail (substring string 0 len)))))
4860 (setq len (1- len))
4861 (forward-char 1))
4862 (delete-char len)))
4864 (defvar choose-completion-string-functions nil
4865 "Functions that may override the normal insertion of a completion choice.
4866 These functions are called in order with four arguments:
4867 CHOICE - the string to insert in the buffer,
4868 BUFFER - the buffer in which the choice should be inserted,
4869 MINI-P - non-nil iff BUFFER is a minibuffer, and
4870 BASE-SIZE - the number of characters in BUFFER before
4871 the string being completed.
4873 If a function in the list returns non-nil, that function is supposed
4874 to have inserted the CHOICE in the BUFFER, and possibly exited
4875 the minibuffer; no further functions will be called.
4877 If all functions in the list return nil, that means to use
4878 the default method of inserting the completion in BUFFER.")
4880 (defun choose-completion-string (choice &optional buffer base-size)
4881 "Switch to BUFFER and insert the completion choice CHOICE.
4882 BASE-SIZE, if non-nil, says how many characters of BUFFER's text
4883 to keep. If it is nil, we call `choose-completion-delete-max-match'
4884 to decide what to delete."
4886 ;; If BUFFER is the minibuffer, exit the minibuffer
4887 ;; unless it is reading a file name and CHOICE is a directory,
4888 ;; or completion-no-auto-exit is non-nil.
4890 (let* ((buffer (or buffer completion-reference-buffer))
4891 (mini-p (minibufferp buffer)))
4892 ;; If BUFFER is a minibuffer, barf unless it's the currently
4893 ;; active minibuffer.
4894 (if (and mini-p
4895 (or (not (active-minibuffer-window))
4896 (not (equal buffer
4897 (window-buffer (active-minibuffer-window))))))
4898 (error "Minibuffer is not active for completion")
4899 ;; Set buffer so buffer-local choose-completion-string-functions works.
4900 (set-buffer buffer)
4901 (unless (run-hook-with-args-until-success
4902 'choose-completion-string-functions
4903 choice buffer mini-p base-size)
4904 ;; Insert the completion into the buffer where it was requested.
4905 (if base-size
4906 (delete-region (+ base-size (if mini-p
4907 (minibuffer-prompt-end)
4908 (point-min)))
4909 (point))
4910 (choose-completion-delete-max-match choice))
4911 (insert choice)
4912 (remove-text-properties (- (point) (length choice)) (point)
4913 '(mouse-face nil))
4914 ;; Update point in the window that BUFFER is showing in.
4915 (let ((window (get-buffer-window buffer t)))
4916 (set-window-point window (point)))
4917 ;; If completing for the minibuffer, exit it with this choice.
4918 (and (not completion-no-auto-exit)
4919 (equal buffer (window-buffer (minibuffer-window)))
4920 minibuffer-completion-table
4921 ;; If this is reading a file name, and the file name chosen
4922 ;; is a directory, don't exit the minibuffer.
4923 (if (and (eq minibuffer-completion-table 'read-file-name-internal)
4924 (file-directory-p (field-string (point-max))))
4925 (let ((mini (active-minibuffer-window)))
4926 (select-window mini)
4927 (when minibuffer-auto-raise
4928 (raise-frame (window-frame mini))))
4929 (exit-minibuffer)))))))
4931 (defun completion-list-mode ()
4932 "Major mode for buffers showing lists of possible completions.
4934 to select the completion near point.
4936 with the mouse."
4937 (interactive)
4938 (kill-all-local-variables)
4939 (use-local-map completion-list-mode-map)
4940 (setq mode-name "Completion List")
4941 (setq major-mode 'completion-list-mode)
4942 (make-local-variable 'completion-base-size)
4943 (setq completion-base-size nil)
4944 (run-mode-hooks 'completion-list-mode-hook))
4946 (defun completion-list-mode-finish ()
4947 "Finish setup of the completions buffer.
4948 Called from `temp-buffer-show-hook'."
4949 (when (eq major-mode 'completion-list-mode)
4950 (toggle-read-only 1)))
4952 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
4954 (defvar completion-setup-hook nil
4955 "Normal hook run at the end of setting up a completion list buffer.
4956 When this hook is run, the current buffer is the one in which the
4957 command to display the completion list buffer was run.
4958 The completion list buffer is available as the value of `standard-output'.
4959 The common prefix substring for completion may be available as the
4960 value of `completion-common-substring'. See also `display-completion-list'.")
4963 ;; Variables and faces used in `completion-setup-function'.
4965 (defface completions-first-difference
4966 '((t (:inherit bold)))
4967 "Face put on the first uncommon character in completions in *Completions* buffer."
4968 :group 'completion)
4970 (defface completions-common-part
4971 '((t (:inherit default)))
4972 "Face put on the common prefix substring in completions in *Completions* buffer.
4973 The idea of `completions-common-part' is that you can use it to
4974 make the common parts less visible than normal, so that the rest
4975 of the differing parts is, by contrast, slightly highlighted."
4976 :group 'completion)
4978 ;; This is for packages that need to bind it to a non-default regexp
4979 ;; in order to make the first-differing character highlight work
4980 ;; to their liking
4981 (defvar completion-root-regexp "^/"
4982 "Regexp to use in `completion-setup-function' to find the root directory.")
4984 (defvar completion-common-substring nil
4985 "Common prefix substring to use in `completion-setup-function' to put faces.
4986 The value is set by `display-completion-list' during running `completion-setup-hook'.
4988 To put faces `completions-first-difference' and `completions-common-part'
4989 in the `*Completions*' buffer, the common prefix substring in completions
4990 is needed as a hint. (The minibuffer is a special case. The content
4991 of the minibuffer before point is always the common substring.)")
4993 ;; This function goes in completion-setup-hook, so that it is called
4994 ;; after the text of the completion list buffer is written.
4995 (defun completion-setup-function ()
4996 (let* ((mainbuf (current-buffer))
4997 (mbuf-contents (minibuffer-completion-contents))
4998 common-string-length)
4999 ;; When reading a file name in the minibuffer,
5000 ;; set default-directory in the minibuffer
5001 ;; so it will get copied into the completion list buffer.
5002 (if minibuffer-completing-file-name
5003 (with-current-buffer mainbuf
5004 (setq default-directory (file-name-directory mbuf-contents))))
5005 (with-current-buffer standard-output
5006 (completion-list-mode)
5007 (set (make-local-variable 'completion-reference-buffer) mainbuf)
5008 (setq completion-base-size
5009 (cond
5010 ((and (symbolp minibuffer-completion-table)
5011 (get minibuffer-completion-table 'completion-base-size-function))
5012 ;; To compute base size, a function can use the global value of
5013 ;; completion-common-substring or minibuffer-completion-contents.
5014 (with-current-buffer mainbuf
5015 (funcall (get minibuffer-completion-table
5016 'completion-base-size-function))))
5017 (minibuffer-completing-file-name
5018 ;; For file name completion, use the number of chars before
5019 ;; the start of the file name component at point.
5020 (with-current-buffer mainbuf
5021 (save-excursion
5022 (skip-chars-backward completion-root-regexp)
5023 (- (point) (minibuffer-prompt-end)))))
5024 ;; Otherwise, in minibuffer, the base size is 0.
5025 ((minibufferp mainbuf) 0)))
5026 (setq common-string-length
5027 (cond
5028 (completion-common-substring
5029 (length completion-common-substring))
5030 (completion-base-size
5031 (- (length mbuf-contents) completion-base-size))))
5032 ;; Put faces on first uncommon characters and common parts.
5033 (when (and (integerp common-string-length) (>= common-string-length 0))
5034 (let ((element-start (point-min))
5035 (maxp (point-max))
5036 element-common-end)
5037 (while (and (setq element-start
5038 (next-single-property-change
5039 element-start 'mouse-face))
5040 (< (setq element-common-end
5041 (+ element-start common-string-length))
5042 maxp))
5043 (when (get-char-property element-start 'mouse-face)
5044 (if (and (> common-string-length 0)
5045 (get-char-property (1- element-common-end) 'mouse-face))
5046 (put-text-property element-start element-common-end
5047 'font-lock-face 'completions-common-part))
5048 (if (get-char-property element-common-end 'mouse-face)
5049 (put-text-property element-common-end (1+ element-common-end)
5050 'font-lock-face 'completions-first-difference))))))
5051 ;; Insert help string.
5052 (goto-char (point-min))
5053 (if (display-mouse-p)
5054 (insert (substitute-command-keys
5056 (insert (substitute-command-keys
5060 (add-hook 'completion-setup-hook 'completion-setup-function)
5062 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
5063 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
5065 (defun switch-to-completions ()
5066 "Select the completion list window."
5067 (interactive)
5068 ;; Make sure we have a completions window.
5069 (or (get-buffer-window "*Completions*")
5070 (minibuffer-completion-help))
5071 (let ((window (get-buffer-window "*Completions*")))
5072 (when window
5073 (select-window window)
5074 (goto-char (point-min))
5076 (forward-line 1))))
5077 \f
5078 ;;; Support keyboard commands to turn on various modifiers.
5080 ;; These functions -- which are not commands -- each add one modifier
5081 ;; to the following event.
5083 (defun event-apply-alt-modifier (ignore-prompt)
5086 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
5087 (defun event-apply-super-modifier (ignore-prompt)
5090 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
5091 (defun event-apply-hyper-modifier (ignore-prompt)
5094 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
5095 (defun event-apply-shift-modifier (ignore-prompt)
5098 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
5099 (defun event-apply-control-modifier (ignore-prompt)
5102 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
5103 (defun event-apply-meta-modifier (ignore-prompt)
5106 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
5108 (defun event-apply-modifier (event symbol lshiftby prefix)
5109 "Apply a modifier flag to event EVENT.
5110 SYMBOL is the name of this modifier, as a symbol.
5111 LSHIFTBY is the numeric value of this modifier, in keyboard events.
5112 PREFIX is the string that represents this modifier in an event type symbol."
5113 (if (numberp event)
5114 (cond ((eq symbol 'control)
5115 (if (and (<= (downcase event) ?z)
5116 (>= (downcase event) ?a))
5117 (- (downcase event) ?a -1)
5118 (if (and (<= (downcase event) ?Z)
5119 (>= (downcase event) ?A))
5120 (- (downcase event) ?A -1)
5121 (logior (lsh 1 lshiftby) event))))
5122 ((eq symbol 'shift)
5123 (if (and (<= (downcase event) ?z)
5124 (>= (downcase event) ?a))
5125 (upcase event)
5126 (logior (lsh 1 lshiftby) event)))
5127 (t
5128 (logior (lsh 1 lshiftby) event)))
5129 (if (memq symbol (event-modifiers event))
5130 event
5131 (let ((event-type (if (symbolp event) event (car event))))
5132 (setq event-type (intern (concat prefix (symbol-name event-type))))
5133 (if (symbolp event)
5134 event-type
5135 (cons event-type (cdr event)))))))
5137 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
5138 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
5139 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
5140 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
5141 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
5142 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
5143 \f
5144 ;;;; Keypad support.
5146 ;;; Make the keypad keys act like ordinary typing keys. If people add
5147 ;;; bindings for the function key symbols, then those bindings will
5148 ;;; override these, so this shouldn't interfere with any existing
5149 ;;; bindings.
5151 ;; Also tell read-char how to handle these keys.
5152 (mapc
5153 (lambda (keypad-normal)
5154 (let ((keypad (nth 0 keypad-normal))
5155 (normal (nth 1 keypad-normal)))
5156 (put keypad 'ascii-character normal)
5157 (define-key function-key-map (vector keypad) (vector normal))))
5158 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
5159 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
5160 (kp-space ?\s)
5163 (kp-multiply ?*)
5164 (kp-add ?+)
5165 (kp-separator ?,)
5166 (kp-subtract ?-)
5167 (kp-decimal ?.)
5168 (kp-divide ?/)
5169 (kp-equal ?=)))
5170 \f
5171 ;;;;
5172 ;;;; forking a twin copy of a buffer.
5173 ;;;;
5175 (defvar clone-buffer-hook nil
5176 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
5178 (defun clone-process (process &optional newname)
5179 "Create a twin copy of PROCESS.
5180 If NEWNAME is nil, it defaults to PROCESS' name;
5181 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
5182 If PROCESS is associated with a buffer, the new process will be associated
5183 with the current buffer instead.
5184 Returns nil if PROCESS has already terminated."
5185 (setq newname (or newname (process-name process)))
5187 (setq newname (substring newname 0 (match-beginning 0))))
5188 (when (memq (process-status process) '(run stop open))
5189 (let* ((process-connection-type (process-tty-name process))
5190 (new-process
5191 (if (memq (process-status process) '(open))
5192 (let ((args (process-contact process t)))
5193 (setq args (plist-put args :name newname))
5194 (setq args (plist-put args :buffer
5195 (if (process-buffer process)
5196 (current-buffer))))
5197 (apply 'make-network-process args))
5198 (apply 'start-process newname
5199 (if (process-buffer process) (current-buffer))
5200 (process-command process)))))
5201 (set-process-query-on-exit-flag
5202 new-process (process-query-on-exit-flag process))
5203 (set-process-inherit-coding-system-flag
5204 new-process (process-inherit-coding-system-flag process))
5205 (set-process-filter new-process (process-filter process))
5206 (set-process-sentinel new-process (process-sentinel process))
5207 (set-process-plist new-process (copy-sequence (process-plist process)))
5208 new-process)))
5210 ;; things to maybe add (currently partly covered by `funcall mode'):
5211 ;; - syntax-table
5212 ;; - overlays
5213 (defun clone-buffer (&optional newname display-flag)
5214 "Create and return a twin copy of the current buffer.
5215 Unlike an indirect buffer, the new buffer can be edited
5216 independently of the old one (if it is not read-only).
5217 NEWNAME is the name of the new buffer. It may be modified by
5218 adding or incrementing <N> at the end as necessary to create a
5219 unique buffer name. If nil, it defaults to the name of the
5220 current buffer, with the proper suffix. If DISPLAY-FLAG is
5221 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
5222 clone a file-visiting buffer, or a buffer whose major mode symbol
5223 has a non-nil `no-clone' property, results in an error.
5225 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
5226 current buffer with appropriate suffix. However, if a prefix
5227 argument is given, then the command prompts for NEWNAME in the
5228 minibuffer.
5230 This runs the normal hook `clone-buffer-hook' in the new buffer
5231 after it has been set up properly in other respects."
5232 (interactive
5233 (progn
5234 (if buffer-file-name
5235 (error "Cannot clone a file-visiting buffer"))
5236 (if (get major-mode 'no-clone)
5237 (error "Cannot clone a buffer in %s mode" mode-name))
5238 (list (if current-prefix-arg
5239 (read-buffer "Name of new cloned buffer: " (current-buffer)))
5240 t)))
5241 (if buffer-file-name
5242 (error "Cannot clone a file-visiting buffer"))
5243 (if (get major-mode 'no-clone)
5244 (error "Cannot clone a buffer in %s mode" mode-name))
5245 (setq newname (or newname (buffer-name)))
5247 (setq newname (substring newname 0 (match-beginning 0))))
5248 (let ((buf (current-buffer))
5249 (ptmin (point-min))
5250 (ptmax (point-max))
5251 (pt (point))
5252 (mk (if mark-active (mark t)))
5253 (modified (buffer-modified-p))
5254 (mode major-mode)
5255 (lvars (buffer-local-variables))
5256 (process (get-buffer-process (current-buffer)))
5257 (new (generate-new-buffer (or newname (buffer-name)))))
5258 (save-restriction
5259 (widen)
5260 (with-current-buffer new
5261 (insert-buffer-substring buf)))
5262 (with-current-buffer new
5263 (narrow-to-region ptmin ptmax)
5264 (goto-char pt)
5265 (if mk (set-mark mk))
5266 (set-buffer-modified-p modified)
5268 ;; Clone the old buffer's process, if any.
5269 (when process (clone-process process))
5271 ;; Now set up the major mode.
5272 (funcall mode)
5274 ;; Set up other local variables.
5275 (mapcar (lambda (v)
5276 (condition-case () ;in case var is read-only
5277 (if (symbolp v)
5278 (makunbound v)
5279 (set (make-local-variable (car v)) (cdr v)))
5280 (error nil)))
5281 lvars)
5283 ;; Run any hooks (typically set up by the major mode
5284 ;; for cloning to work properly).
5285 (run-hooks 'clone-buffer-hook))
5286 (if display-flag
5287 ;; Presumably the current buffer is shown in the selected frame, so
5288 ;; we want to display the clone elsewhere.
5289 (let ((same-window-regexps nil)
5290 (same-window-buffer-names))
5291 (pop-to-buffer new)))
5292 new))
5295 (defun clone-indirect-buffer (newname display-flag &optional norecord)
5296 "Create an indirect buffer that is a twin copy of the current buffer.
5298 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
5299 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
5300 or if not called with a prefix arg, NEWNAME defaults to the current
5301 buffer's name. The name is modified by adding a `<N>' suffix to it
5302 or by incrementing the N in an existing suffix.
5304 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
5305 This is always done when called interactively.
5307 Optional third arg NORECORD non-nil means do not put this buffer at the
5308 front of the list of recently selected ones."
5309 (interactive
5310 (progn
5311 (if (get major-mode 'no-clone-indirect)
5312 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
5313 (list (if current-prefix-arg
5314 (read-buffer "Name of indirect buffer: " (current-buffer)))
5315 t)))
5316 (if (get major-mode 'no-clone-indirect)
5317 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
5318 (setq newname (or newname (buffer-name)))
5320 (setq newname (substring newname 0 (match-beginning 0))))
5321 (let* ((name (generate-new-buffer-name newname))
5322 (buffer (make-indirect-buffer (current-buffer) name t)))
5323 (when display-flag
5324 (pop-to-buffer buffer norecord))
5325 buffer))
5328 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
5329 "Like `clone-indirect-buffer' but display in another window."
5330 (interactive
5331 (progn
5332 (if (get major-mode 'no-clone-indirect)
5333 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
5334 (list (if current-prefix-arg
5335 (read-buffer "Name of indirect buffer: " (current-buffer)))
5336 t)))
5337 (let ((pop-up-windows t))
5338 (clone-indirect-buffer newname display-flag norecord)))
5340 \f
5341 ;;; Handling of Backspace and Delete keys.
5343 (defcustom normal-erase-is-backspace
5344 (and (not noninteractive)
5345 (or (memq system-type '(ms-dos windows-nt))
5346 (eq window-system 'mac)
5347 (and (memq window-system '(x))
5348 (fboundp 'x-backspace-delete-keys-p)
5349 (x-backspace-delete-keys-p))
5350 ;; If the terminal Emacs is running on has erase char
5351 ;; set to ^H, use the Backspace key for deleting
5352 ;; backward and, and the Delete key for deleting forward.
5353 (and (null window-system)
5354 (eq tty-erase-char ?\^H))))
5355 "If non-nil, Delete key deletes forward and Backspace key deletes backward.
5357 On window systems, the default value of this option is chosen
5358 according to the keyboard used. If the keyboard has both a Backspace
5359 key and a Delete key, and both are mapped to their usual meanings, the
5360 option's default value is set to t, so that Backspace can be used to
5361 delete backward, and Delete can be used to delete forward.
5363 If not running under a window system, customizing this option accomplishes
5364 a similar effect by mapping C-h, which is usually generated by the
5365 Backspace key, to DEL, and by mapping DEL to C-d via
5366 `keyboard-translate'. The former functionality of C-h is available on
5367 the F1 key. You should probably not use this setting if you don't
5368 have both Backspace, Delete and F1 keys.
5370 Setting this variable with setq doesn't take effect. Programmatically,
5371 call `normal-erase-is-backspace-mode' (which see) instead."
5372 :type 'boolean
5373 :group 'editing-basics
5374 :version "21.1"
5375 :set (lambda (symbol value)
5376 ;; The fboundp is because of a problem with :set when
5377 ;; dumping Emacs. It doesn't really matter.
5378 (if (fboundp 'normal-erase-is-backspace-mode)
5379 (normal-erase-is-backspace-mode (or value 0))
5380 (set-default symbol value))))
5383 (defun normal-erase-is-backspace-mode (&optional arg)
5384 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
5386 With numeric arg, turn the mode on if and only if ARG is positive.
5388 On window systems, when this mode is on, Delete is mapped to C-d and
5389 Backspace is mapped to DEL; when this mode is off, both Delete and
5390 Backspace are mapped to DEL. (The remapping goes via
5391 `function-key-map', so binding Delete or Backspace in the global or
5392 local keymap will override that.)
5394 In addition, on window systems, the bindings of C-Delete, M-Delete,
5395 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
5396 the global keymap in accordance with the functionality of Delete and
5397 Backspace. For example, if Delete is remapped to C-d, which deletes
5398 forward, C-Delete is bound to `kill-word', but if Delete is remapped
5399 to DEL, which deletes backward, C-Delete is bound to
5400 `backward-kill-word'.
5402 If not running on a window system, a similar effect is accomplished by
5403 remapping C-h (normally produced by the Backspace key) and DEL via
5404 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
5405 to C-d; if it's off, the keys are not remapped.
5407 When not running on a window system, and this mode is turned on, the
5408 former functionality of C-h is available on the F1 key. You should
5409 probably not turn on this mode on a text-only terminal if you don't
5410 have both Backspace, Delete and F1 keys.
5412 See also `normal-erase-is-backspace'."
5413 (interactive "P")
5414 (setq normal-erase-is-backspace
5415 (if arg
5416 (> (prefix-numeric-value arg) 0)
5417 (not normal-erase-is-backspace)))
5419 (cond ((or (memq window-system '(x w32 mac pc))
5420 (memq system-type '(ms-dos windows-nt)))
5421 (let ((bindings
5422 `(([C-delete] [C-backspace])
5423 ([M-delete] [M-backspace])
5424 ([C-M-delete] [C-M-backspace])
5425 (,esc-map
5426 [C-delete] [C-backspace])))
5427 (old-state (lookup-key function-key-map [delete])))
5429 (if normal-erase-is-backspace
5430 (progn
5431 (define-key function-key-map [delete] [?\C-d])
5432 (define-key function-key-map [kp-delete] [?\C-d])
5433 (define-key function-key-map [backspace] [?\C-?]))
5434 (define-key function-key-map [delete] [?\C-?])
5435 (define-key function-key-map [kp-delete] [?\C-?])
5436 (define-key function-key-map [backspace] [?\C-?]))
5438 ;; Maybe swap bindings of C-delete and C-backspace, etc.
5439 (unless (equal old-state (lookup-key function-key-map [delete]))
5440 (dolist (binding bindings)
5441 (let ((map global-map))
5442 (when (keymapp (car binding))
5443 (setq map (car binding) binding (cdr binding)))
5444 (let* ((key1 (nth 0 binding))
5445 (key2 (nth 1 binding))
5446 (binding1 (lookup-key map key1))
5447 (binding2 (lookup-key map key2)))
5448 (define-key map key1 binding2)
5449 (define-key map key2 binding1)))))))
5450 (t
5451 (if normal-erase-is-backspace
5452 (progn
5453 (keyboard-translate ?\C-h ?\C-?)
5454 (keyboard-translate ?\C-? ?\C-d))
5455 (keyboard-translate ?\C-h ?\C-h)
5456 (keyboard-translate ?\C-? ?\C-?))))
5458 (run-hooks 'normal-erase-is-backspace-hook)
5459 (if (interactive-p)
5460 (message "Delete key deletes %s"
5461 (if normal-erase-is-backspace "forward" "backward"))))
5462 \f
5463 (defvar vis-mode-saved-buffer-invisibility-spec nil
5464 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
5466 (define-minor-mode visible-mode
5467 "Toggle Visible mode.
5468 With argument ARG turn Visible mode on iff ARG is positive.
5470 Enabling Visible mode makes all invisible text temporarily visible.
5471 Disabling Visible mode turns off that effect. Visible mode
5472 works by saving the value of `buffer-invisibility-spec' and setting it to nil."
5473 :lighter " Vis"
5474 :group 'editing-basics
5475 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
5476 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
5477 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
5478 (when visible-mode
5479 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
5480 buffer-invisibility-spec)
5481 (setq buffer-invisibility-spec nil)))
5482 \f
5483 ;; Minibuffer prompt stuff.
5485 ;(defun minibuffer-prompt-modification (start end)
5486 ; (error "You cannot modify the prompt"))
5487 ;
5488 ;
5489 ;(defun minibuffer-prompt-insertion (start end)
5490 ; (let ((inhibit-modification-hooks t))
5491 ; (delete-region start end)
5492 ; ;; Discard undo information for the text insertion itself
5493 ; ;; and for the text deletion.above.
5494 ; (when (consp buffer-undo-list)
5495 ; (setq buffer-undo-list (cddr buffer-undo-list)))
5496 ; (message "You cannot modify the prompt")))
5497 ;
5498 ;
5499 ;(setq minibuffer-prompt-properties
5500 ; (list 'modification-hooks '(minibuffer-prompt-modification)
5501 ; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
5502 ;
5504 (provide 'simple)
5506 ;; arch-tag: 24af67c0-2a49-44f6-b3b1-312d8b570dfd
5507 ;;; simple.el ends here