| blob | daf297d5fe2b8585977b4f1226986c45275432e7 |
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-current-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 "Insert the next element of the minibuffer history into the minibuffer."
1289 elt minibuffer-returned-to-present)
1301 previous-history-element))
1323 elt))
1327 "Inserts the previous element of the minibuffer history into the minibuffer."
1332 "Get next history element which completes the minibuffer before the point.
1333 The contents of the minibuffer after the point are deleted, and replaced
1334 by the new completion."
1340 n)
1341 ;; next-matching-history-element always puts us at (point-min).
1342 ;; Move to the position we were at before changing the buffer contents.
1343 ;; This is still sensical, because the text before point has not changed.
1347 "\
1348 Get previous history element which completes the minibuffer before the point.
1349 The contents of the minibuffer after the point are deleted, and replaced
1350 by the new completion."
1354 ;; For compatibility with the old subr of the same name.
1356 "Return the display width of the minibuffer prompt.
1357 Return 0 if current buffer is not a minibuffer."
1358 ;; Return the width of everything before the field at the end of
1359 ;; the buffer; this should be 0 for normal buffers.
1361 \f
1362 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
1366 "Table mapping redo records to the corresponding undo one.
1367 A redo record for undo-in-region maps to t.
1377 "Within a run of consecutive undo commands, list remaining to be undone.
1381 "Undo some previous changes.
1382 Repeat this command to undo more changes.
1383 A numeric argument serves as a repeat count.
1385 In Transient Mark mode when the mark is active, only undo changes within
1387 as an argument limits undo to changes within the current region."
1389 ;; Make last-command indicate for the next command that this was an undo.
1390 ;; That way, another undo will undo more.
1391 ;; If we get to the end of the undo history and get an error,
1392 ;; another undo command will find the undo history empty
1393 ;; and will get another error. To begin undoing the undos,
1394 ;; you must type some other command.
1397 message)
1398 ;; If we get an error in undo-start,
1399 ;; the next command should not be a "consecutive undo".
1400 ;; So set `this-command' to something other than `undo'.
1405 ;; If something (a timer or filter?) changed the buffer
1406 ;; since the previous command, don't continue the undo seq.
1410 ;; If the last undo record made was made by undo
1411 ;; it shows nothing else happened in between.
1418 ;; get rid of initial undo boundary
1420 ;; If we got this far, the next command should be a consecutive undo.
1422 ;; Check to see whether we're hitting a redo record, and if
1423 ;; so, ask the user whether she wants to skip the redo/undo pair.
1430 ;; The equiv entry might point to another redo record if we have done
1431 ;; undo-redo-undo-redo-... so skip to the very last equiv.
1439 ;; Record the fact that the just-generated undo records come from an
1440 ;; undo operation--that is, they are redo records.
1441 ;; In the ordinary case (not within a region), map the redo
1442 ;; record to the following undos.
1443 ;; I don't know how to do that in the undo-in-region case.
1446 undo-equiv-table)
1447 ;; Don't specify a position in the undo record for the undo command.
1448 ;; Instead, undoing this should move point to where the change is.
1467 ;; Record what the current undo list says,
1468 ;; so the next command can tell if the buffer was modified in between.
1471 ;; Display a message announcing success.
1476 "Make BUFFER stop keeping undo information.
1477 No argument or nil as argument means do this for the current buffer."
1483 "Undo some previous changes.
1484 Repeat this command to undo more changes.
1485 A numeric argument serves as a repeat count.
1486 Contrary to `undo', this will not redo a previous undo."
1491 "Non-nil while performing an undo.
1495 "Undo back N undo-boundaries beyond what was already undone recently.
1496 Call `undo-start' to get ready to undo recent changes,
1497 then call `undo-more' one or more times to undo them."
1507 ;; Deep copy of a list
1509 "Make a copy of undo list LIST."
1515 elt))
1518 "Set `pending-undo-list' to the front of the undo list.
1519 The next call to `undo-more' will undo the most recently made change.
1520 If BEG and END are specified, then only undo elements
1521 that apply to text between BEG and END are used; other undo elements
1522 are ignored. If BEG and END are nil, all undo elements are used."
1528 buffer-undo-list)))
1533 "Return a list of undo elements for the region START to END.
1534 The elements come from `buffer-undo-list', but we keep only
1535 the elements inside this region, and discard those outside this region.
1536 If we find an element that crosses an edge of this region,
1537 we stop and ignore all further elements."
1540 undo-adjusted-markers
1541 some-rejected
1542 undo-elt undo-elt temp-undo-list delta)
1547 ;; This is a "was unmodified" element.
1548 ;; Keep it if we have kept everything thus far.
1555 ;; Don't put two nils together in the list
1569 ;; Loop down the earlier events adjusting their buffer
1570 ;; positions to reflect the fact that a change to the buffer
1571 ;; isn't being undone. We only need to process those element
1572 ;; types which undo-elt-in-region will return as being in
1573 ;; the region since only those types can ever get into the
1574 ;; output
1583 ;; (TEXT . POSITION)
1590 ;; (BEGIN . END)
1595 ;; (nil PROPERTY VALUE BEG . END)
1605 "Determine whether UNDO-ELT falls inside the region START ... END.
1606 If it crosses the edge, we return nil."
1611 t)
1613 nil)
1615 ;; (TEXT . POSITION)
1619 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
1620 ;; See if MARKER is inside the region.
1631 ;; (nil PROPERTY VALUE BEG . END)
1636 ;; (BEGIN . END)
1641 "Test whether UNDO-ELT crosses one edge of that region START ... END.
1642 This assumes we have already decided that UNDO-ELT
1643 is not *inside* the region START...END."
1646 ;; (nil PROPERTY VALUE BEG . END)
1651 ;; (BEGIN . END)
1655 ;; Return the first affected buffer position and the delta for an undo element
1656 ;; delta is defined as the change in subsequent buffer positions if we *did*
1657 ;; the undo.
1661 ;; (TEXT . POSITION)
1664 ;; (BEGIN . END)
1671 "If non-nil ask about discarding undo info for the current command.
1672 Normally, Emacs discards the undo info for the current command if
1673 it exceeds `undo-outer-limit'. But if you set this option
1674 non-nil, it asks in the echo area whether to discard the info.
1675 If you answer no, there a slight risk that Emacs might crash, so
1676 only do it if you really want to undo the command.
1678 This option is mainly intended for debugging. You have to be
1679 careful if you use it for other purposes. Garbage collection is
1680 inhibited while the question is asked, meaning that Emacs might
1681 leak memory. So you should make sure that you do not wait
1682 excessively long before answering the question."
1688 "If non-nil, an extra level of size that's ok in an undo item.
1689 We don't ask the user about truncating the undo list until the
1690 current item gets bigger than this amount.
1695 ;; When the first undo batch in an undo list is longer than
1696 ;; undo-outer-limit, this function gets called to warn the user that
1697 ;; the undo info for the current command was discarded. Garbage
1698 ;; collection is inhibited around the call, so it had better not do a
1699 ;; lot of consing.
1705 ;; Don't ask the question again unless it gets even bigger.
1706 ;; This applies, in particular, if the user quits from the question.
1707 ;; Such a quit quits out of GC, but something else will call GC
1708 ;; again momentarily. It will call this function again,
1709 ;; but we don't want to ask the question again.
1716 t)
1717 nil))
1722 "The undo info was discarded because it exceeded \
1723 `undo-outer-limit'.
1725 This is normal if you executed a command that made a huge change
1726 to the buffer. In that case, to prevent similar problems in the
1727 future, set `undo-outer-limit' to a value that is large enough to
1728 cover the maximum size of normal changes you expect a single
1729 command to make, but not so large that it might exceed the
1730 maximum memory allotted to Emacs.
1732 If you did not execute any such command, the situation is
1733 probably due to a bug and you should report it.
1735 You can disable the popping up of this buffer by adding the entry
1739 t))
1740 \f
1748 "*Buffer name for `shell-command' and `shell-command-on-region' error output.
1749 This buffer is used when `shell-command' or `shell-command-on-region'
1750 is run interactively. A value of nil means that output to stderr and
1754 "Execute string COMMAND in inferior shell; display output, if any.
1755 With prefix argument, insert the COMMAND's output at point.
1757 If COMMAND ends in ampersand, execute it asynchronously.
1758 The output appears in the buffer `*Async Shell Command*'.
1759 That buffer is in shell mode.
1761 Otherwise, COMMAND is executed synchronously. The output appears in
1762 the buffer `*Shell Command Output*'. If the output is short enough to
1763 display in the echo area (which is determined by the variables
1764 `resize-mini-windows' and `max-mini-window-height'), it is shown
1765 there, but it is nonetheless available in buffer `*Shell Command
1766 Output*' even though that buffer is not automatically displayed.
1768 To specify a coding system for converting non-ASCII characters
1770 before this command.
1772 Noninteractive callers can specify coding systems by binding
1773 `coding-system-for-read' and `coding-system-for-write'.
1775 The optional second argument OUTPUT-BUFFER, if non-nil,
1776 says to put the output in some other buffer.
1777 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
1778 If OUTPUT-BUFFER is not a buffer and not nil,
1779 insert output in current buffer. (This cannot be done asynchronously.)
1780 In either case, the output is inserted after point (leaving mark after it).
1782 If the command terminates without error, but generates output,
1784 the output can be displayed in the echo area or in its buffer.
1785 If the output is short enough to display in the echo area
1786 \(determined by the variable `max-mini-window-height' if
1787 `resize-mini-windows' is non-nil), it is shown there. Otherwise,
1788 the buffer containing the output is displayed.
1792 of the output.
1794 If there is no output, or if output is inserted in the current buffer,
1795 then `*Shell Command Output*' is deleted.
1797 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
1798 or buffer name to which to direct the command's standard error output.
1799 If it is nil, error output is mingled with regular output.
1800 In an interactive call, the variable `shell-command-default-error-buffer'
1801 specifies the value of ERROR-BUFFER."
1805 current-prefix-arg
1806 shell-command-default-error-buffer))
1807 ;; Look for a handler in case default-directory is a remote file name.
1815 ;; Output goes in current buffer.
1821 temporary-file-directory)))
1822 nil)))
1825 ;; We do not use -f for csh; we will not support broken use of
1826 ;; .cshrcs. Even the BSD csh manual says to use
1827 ;; "if ($?prompt) exit" before things which are not useful
1828 ;; non-interactively. Besides, if someone wants their other
1829 ;; aliases for shell commands then they can still have them.
1833 t)
1834 nil shell-command-switch command)
1841 ;; Do no formatting while reading error file,
1842 ;; because that can run a shell command, and we
1843 ;; don't want that to cause an infinite recursion.
1845 ;; Put point after the inserted errors.
1849 ;; This is like exchange-point-and-mark, but doesn't
1850 ;; activate the mark. It is cleaner to avoid activation,
1851 ;; even though the command loop would deactivate the mark
1852 ;; because we inserted text.
1856 ;; Output goes in a separate buffer.
1857 ;; Preserve the match data in case called from a program.
1860 ;; Command ending with ampersand means asynchronous.
1864 proc)
1865 ;; Remove the ampersand.
1867 ;; If will kill a process, query first.
1879 shell-command-switch command))
1883 ))
1885 output-buffer nil error-buffer)))))))
1889 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
1890 MESSAGE may be either a string or a buffer.
1892 A buffer is displayed using `display-buffer' if MESSAGE is too long for
1893 the maximum height of the echo area, as defined by `max-mini-window-height'
1894 if `resize-mini-windows' is non-nil.
1896 Returns either the string shown in the echo area, or when a pop-up
1897 buffer is used, the window used to display it.
1899 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
1900 name of the buffer used to display it in the case where a pop-up buffer
1901 is used, defaulting to `*Message*'. In the case where MESSAGE is a
1902 string and it is displayed in the echo area, it is not specified whether
1903 the contents are inserted into the buffer anyway.
1905 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
1906 and only used if a buffer is displayed."
1910 ;; Trivial case where we can use the echo area
1915 ;; Trivial case where we can just remove single trailing newline
1918 ;; General case
1921 message
1930 0
1934 (<= lines
1938 max-mini-window-height))
1940 max-mini-window-height)
1944 ;; Don't use the echo area if the output buffer is
1945 ;; already dispayed in the selected frame.
1947 ;; Echo area
1953 ;; Buffer
1956 not-this-window frame))))))))
1959 ;; We have a sentinel to prevent insertion of a termination message
1960 ;; in the buffer itself.
1968 &optional output-buffer replace
1969 error-buffer display-error-buffer)
1970 "Execute string COMMAND in inferior shell with region as input.
1971 Normally display output (if any) in temp buffer `*Shell Command Output*';
1972 Prefix arg means replace the region with it. Return the exit code of
1973 COMMAND.
1975 To specify a coding system for converting non-ASCII characters
1977 before this command. By default, the input (from the current buffer)
1978 is encoded in the same coding system that will be used to save the file,
1979 `buffer-file-coding-system'. If the output is going to replace the region,
1980 then it is decoded from that same coding system.
1982 The noninteractive arguments are START, END, COMMAND,
1983 OUTPUT-BUFFER, REPLACE, ERROR-BUFFER, and DISPLAY-ERROR-BUFFER.
1984 Noninteractive callers can specify coding systems by binding
1985 `coding-system-for-read' and `coding-system-for-write'.
1987 If the command generates output, the output may be displayed
1988 in the echo area or in a buffer.
1989 If the output is short enough to display in the echo area
1990 \(determined by the variable `max-mini-window-height' if
1991 `resize-mini-windows' is non-nil), it is shown there. Otherwise
1992 it is displayed in the buffer `*Shell Command Output*'. The output
1993 is available in that buffer in both cases.
1995 If there is output and an error, a message about the error
1996 appears at the end of the output.
1998 If there is no output, or if output is inserted in the current buffer,
1999 then `*Shell Command Output*' is deleted.
2001 If the optional fourth argument OUTPUT-BUFFER is non-nil,
2002 that says to put the output in some other buffer.
2003 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2004 If OUTPUT-BUFFER is not a buffer and not nil,
2005 insert output in the current buffer.
2006 In either case, the output is inserted after point (leaving mark after it).
2008 If REPLACE, the optional fifth argument, is non-nil, that means insert
2009 the output in place of text from START to END, putting point and mark
2010 around it.
2012 If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
2013 or buffer name to which to direct the command's standard error output.
2014 If it is nil, error output is mingled with regular output.
2015 If DISPLAY-ERROR-BUFFER is non-nil, display the error buffer if there
2016 were any errors. (This is always t, interactively.)
2017 In an interactive call, the variable `shell-command-default-error-buffer'
2018 specifies the value of ERROR-BUFFER."
2022 ;; Do this before calling region-beginning
2023 ;; and region-end, in case subprocess output
2024 ;; relocates them while we are in the minibuffer.
2026 nil nil nil
2028 ;; call-interactively recognizes region-beginning and
2029 ;; region-end specially, leaving them in the history.
2031 string
2032 current-prefix-arg
2033 current-prefix-arg
2034 shell-command-default-error-buffer
2035 t)))
2041 temporary-file-directory)))
2042 nil))
2043 exit-status)
2047 ;; Replace specified region with output from command.
2049 ;; Don't muck with mark unless REPLACE says we should.
2056 t)
2057 nil shell-command-switch command))
2058 ;; It is rude to delete a buffer which the command is not using.
2059 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
2060 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
2061 ;; (kill-buffer shell-buffer)))
2062 ;; Don't muck with mark unless REPLACE says we should.
2064 ;; No prefix argument: put the output in a temp buffer,
2065 ;; replacing its entire contents.
2070 ;; If the input is the same buffer as the output,
2071 ;; delete everything but the specified region,
2072 ;; then replace that region with the output.
2078 shell-file-name t
2081 t)
2082 nil shell-command-switch
2083 command)))
2084 ;; Clear the output buffer, then run the command with
2085 ;; output there.
2097 buffer)
2098 nil shell-command-switch command)))
2099 ;; Report the output.
2109 ;; There's some output, display it
2111 ;; No output; error?
2115 "some error output"
2121 output))
2124 exit-status))
2127 exit-status output))))
2128 ;; Don't kill: there might be useful info in the undo-log.
2129 ;; (kill-buffer buffer)
2130 ))))
2138 ;; Do no formatting while reading error file,
2139 ;; because that can run a shell command, and we
2140 ;; don't want that to cause an infinite recursion.
2142 ;; Put point after the inserted errors.
2147 exit-status))
2150 "Execute shell command COMMAND and return its output as a string."
2153 standard-output
2157 "Process files synchronously in a separate process.
2158 Similar to `call-process', but may invoke a file handler based on
2159 `default-directory'. The current working directory of the
2160 subprocess is `default-directory'.
2162 File names in INFILE and BUFFER are handled normally, but file
2163 names in ARGS should be relative to `default-directory', as they
2164 are passed to the process verbatim. \(This is a difference to
2165 `call-process' which does not support file handlers for INFILE
2166 and BUFFER.\)
2168 Some file handlers might not support all variants, for example
2169 they might behave as if DISPLAY was nil, regardless of the actual
2170 value passed."
2172 lc stderr-file)
2182 display args)
2188 \f
2192 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
2193 (define-key map [switch-frame] nil)
2194 (define-key map [?\C-u] 'universal-argument-more)
2195 (define-key map [?-] 'universal-argument-minus)
2196 (define-key map [?0] 'digit-argument)
2197 (define-key map [?1] 'digit-argument)
2198 (define-key map [?2] 'digit-argument)
2199 (define-key map [?3] 'digit-argument)
2200 (define-key map [?4] 'digit-argument)
2201 (define-key map [?5] 'digit-argument)
2202 (define-key map [?6] 'digit-argument)
2203 (define-key map [?7] 'digit-argument)
2204 (define-key map [?8] 'digit-argument)
2205 (define-key map [?9] 'digit-argument)
2206 (define-key map [kp-0] 'digit-argument)
2207 (define-key map [kp-1] 'digit-argument)
2208 (define-key map [kp-2] 'digit-argument)
2209 (define-key map [kp-3] 'digit-argument)
2210 (define-key map [kp-4] 'digit-argument)
2211 (define-key map [kp-5] 'digit-argument)
2212 (define-key map [kp-6] 'digit-argument)
2213 (define-key map [kp-7] 'digit-argument)
2214 (define-key map [kp-8] 'digit-argument)
2215 (define-key map [kp-9] 'digit-argument)
2216 (define-key map [kp-subtract] 'universal-argument-minus)
2217 map)
2220 (defvar universal-argument-num-events nil
2221 "Number of argument-specifying events read by `universal-argument'.
2222 `universal-argument-other-key' uses this to discard those events
2223 from (this-command-keys), and reread only the final command.")
2225 (defvar overriding-map-is-bound nil
2226 "Non-nil when `overriding-terminal-local-map' is `universal-argument-map'.")
2228 (defvar saved-overriding-map nil
2229 "The saved value of `overriding-terminal-local-map'.
2233 (defun ensure-overriding-map-is-bound ()
2234 "Check `overriding-terminal-local-map' is `universal-argument-map'."
2235 (unless overriding-map-is-bound
2236 (setq saved-overriding-map overriding-terminal-local-map)
2237 (setq overriding-terminal-local-map universal-argument-map)
2238 (setq overriding-map-is-bound t)))
2240 (defun restore-overriding-map ()
2241 "Restore `overriding-terminal-local-map' to its saved value."
2242 (setq overriding-terminal-local-map saved-overriding-map)
2243 (setq overriding-map-is-bound nil))
2245 (defun universal-argument ()
2246 "Begin a numeric argument for the following command.
2251 multiplies the argument by 4 each time.
2253 which is different in effect from any particular numeric argument.
2255 (interactive)
2256 (setq prefix-arg (list 4))
2257 (setq universal-argument-num-events (length (this-command-keys)))
2258 (ensure-overriding-map-is-bound))
2260 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
2261 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
2262 (defun universal-argument-more (arg)
2263 (interactive "P")
2264 (if (consp arg)
2265 (setq prefix-arg (list (* 4 (car arg))))
2266 (if (eq arg '-)
2267 (setq prefix-arg (list -4))
2268 (setq prefix-arg arg)
2269 (restore-overriding-map)))
2270 (setq universal-argument-num-events (length (this-command-keys))))
2272 (defun negative-argument (arg)
2273 "Begin a negative numeric argument for the next command.
2275 (interactive "P")
2276 (cond ((integerp arg)
2277 (setq prefix-arg (- arg)))
2278 ((eq arg '-)
2279 (setq prefix-arg nil))
2280 (t
2281 (setq prefix-arg '-)))
2282 (setq universal-argument-num-events (length (this-command-keys)))
2283 (ensure-overriding-map-is-bound))
2285 (defun digit-argument (arg)
2286 "Part of the numeric argument for the next command.
2288 (interactive "P")
2289 (let* ((char (if (integerp last-command-char)
2290 last-command-char
2291 (get last-command-char 'ascii-character)))
2293 (cond ((integerp arg)
2294 (setq prefix-arg (+ (* arg 10)
2295 (if (< arg 0) (- digit) digit))))
2296 ((eq arg '-)
2297 ;; Treat -0 as just -, so that -01 will work.
2298 (setq prefix-arg (if (zerop digit) '- (- digit))))
2299 (t
2300 (setq prefix-arg digit))))
2301 (setq universal-argument-num-events (length (this-command-keys)))
2302 (ensure-overriding-map-is-bound))
2304 ;; For backward compatibility, minus with no modifiers is an ordinary
2305 ;; command if digits have already been entered.
2306 (defun universal-argument-minus (arg)
2307 (interactive "P")
2308 (if (integerp arg)
2309 (universal-argument-other-key arg)
2310 (negative-argument arg)))
2312 ;; Anything else terminates the argument and is left in the queue to be
2313 ;; executed as a command.
2314 (defun universal-argument-other-key (arg)
2315 (interactive "P")
2316 (setq prefix-arg arg)
2317 (let* ((key (this-command-keys))
2318 (keylist (listify-key-sequence key)))
2319 (setq unread-command-events
2320 (append (nthcdr universal-argument-num-events keylist)
2321 unread-command-events)))
2322 (reset-this-command-lengths)
2323 (restore-overriding-map))
2324 \f
2325 (defvar buffer-substring-filters nil
2326 "List of filter functions for `filter-buffer-substring'.
2327 Each function must accept a single argument, a string, and return
2328 a string. The buffer substring is passed to the first function
2329 in the list, and the return value of each function is passed to
2330 the next. The return value of the last function is used as the
2331 return value of `filter-buffer-substring'.
2333 If this variable is nil, no filtering is performed.")
2335 (defun filter-buffer-substring (beg end &optional delete noprops)
2336 "Return the buffer substring between BEG and END, after filtering.
2337 The buffer substring is passed through each of the filter
2338 functions in `buffer-substring-filters', and the value from the
2339 last filter function is returned. If `buffer-substring-filters'
2340 is nil, the buffer substring is returned unaltered.
2342 If DELETE is non-nil, the text between BEG and END is deleted
2343 from the buffer.
2345 If NOPROPS is non-nil, final string returned does not include
2346 text properties, while the string passed to the filters still
2347 includes text properties from the buffer text.
2349 Point is temporarily set to BEG before calling
2350 `buffer-substring-filters', in case the functions need to know
2351 where the text came from.
2353 This function should be used instead of `buffer-substring',
2354 `buffer-substring-no-properties', or `delete-and-extract-region'
2355 when you want to allow filtering to take place. For example,
2356 major or minor modes can use `buffer-substring-filters' to
2357 extract characters that are special to a buffer, and should not
2358 be copied into other buffers."
2359 (cond
2360 ((or delete buffer-substring-filters)
2361 (save-excursion
2362 (goto-char beg)
2363 (let ((string (if delete (delete-and-extract-region beg end)
2364 (buffer-substring beg end))))
2365 (dolist (filter buffer-substring-filters)
2366 (setq string (funcall filter string)))
2367 (if noprops
2368 (set-text-properties 0 (length string) nil string))
2369 string)))
2370 (noprops
2371 (buffer-substring-no-properties beg end))
2372 (t
2373 (buffer-substring beg end))))
2376 ;;;; Window system cut and paste hooks.
2378 (defvar interprogram-cut-function nil
2379 "Function to call to make a killed region available to other programs.
2381 Most window systems provide some sort of facility for cutting and
2382 pasting text between the windows of different programs.
2383 This variable holds a function that Emacs calls whenever text
2384 is put in the kill ring, to make the new kill available to other
2385 programs.
2387 The function takes one or two arguments.
2388 The first argument, TEXT, is a string containing
2389 the text which should be made available.
2390 The second, optional, argument PUSH, has the same meaning as the
2391 similar argument to `x-set-cut-buffer', which see.")
2393 (defvar interprogram-paste-function nil
2394 "Function to call to get text cut from other programs.
2396 Most window systems provide some sort of facility for cutting and
2397 pasting text between the windows of different programs.
2398 This variable holds a function that Emacs calls to obtain
2399 text that other programs have provided for pasting.
2401 The function should be called with no arguments. If the function
2402 returns nil, then no other program has provided such text, and the top
2403 of the Emacs kill ring should be used. If the function returns a
2404 string, then the caller of the function \(usually `current-kill')
2405 should put this string in the kill ring as the latest kill.
2407 Note that the function should return a string only if a program other
2408 than Emacs has provided a string for pasting; if Emacs provided the
2409 most recent string, the function should return nil. If it is
2410 difficult to tell whether Emacs or some other program provided the
2411 current string, it is probably good enough to return nil if the string
2412 is equal (according to `string=') to the last text Emacs provided.")
2413 \f
2416 ;;;; The kill ring data structure.
2418 (defvar kill-ring nil
2419 "List of killed text sequences.
2420 Since the kill ring is supposed to interact nicely with cut-and-paste
2421 facilities offered by window systems, use of this variable should
2422 interact nicely with `interprogram-cut-function' and
2423 `interprogram-paste-function'. The functions `kill-new',
2424 `kill-append', and `current-kill' are supposed to implement this
2425 interaction; you may want to use them instead of manipulating the kill
2426 ring directly.")
2428 (defcustom kill-ring-max 60
2429 "*Maximum length of kill ring before oldest elements are thrown away."
2430 :type 'integer
2431 :group 'killing)
2433 (defvar kill-ring-yank-pointer nil
2434 "The tail of the kill ring whose car is the last thing yanked.")
2436 (defun kill-new (string &optional replace yank-handler)
2437 "Make STRING the latest kill in the kill ring.
2438 Set `kill-ring-yank-pointer' to point to it.
2439 If `interprogram-cut-function' is non-nil, apply it to STRING.
2440 Optional second argument REPLACE non-nil means that STRING will replace
2441 the front of the kill ring, rather than being added to the list.
2443 Optional third arguments YANK-HANDLER controls how the STRING is later
2444 inserted into a buffer; see `insert-for-yank' for details.
2445 When a yank handler is specified, STRING must be non-empty (the yank
2446 handler, if non-nil, is stored as a `yank-handler' text property on STRING).
2448 When the yank handler has a non-nil PARAM element, the original STRING
2449 argument is not used by `insert-for-yank'. However, since Lisp code
2450 may access and use elements from the kill ring directly, the STRING
2452 (if (> (length string) 0)
2453 (if yank-handler
2454 (put-text-property 0 (length string)
2455 'yank-handler yank-handler string))
2456 (if yank-handler
2457 (signal 'args-out-of-range
2458 (list string "yank-handler specified for empty string"))))
2459 (if (fboundp 'menu-bar-update-yank-menu)
2460 (menu-bar-update-yank-menu string (and replace (car kill-ring))))
2461 (if (and replace kill-ring)
2462 (setcar kill-ring string)
2463 (push string kill-ring)
2464 (if (> (length kill-ring) kill-ring-max)
2465 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil)))
2466 (setq kill-ring-yank-pointer kill-ring)
2467 (if interprogram-cut-function
2468 (funcall interprogram-cut-function string (not replace))))
2470 (defun kill-append (string before-p &optional yank-handler)
2471 "Append STRING to the end of the latest kill in the kill ring.
2472 If BEFORE-P is non-nil, prepend STRING to the kill.
2473 Optional third argument YANK-HANDLER, if non-nil, specifies the
2474 yank-handler text property to be set on the combined kill ring
2475 string. If the specified yank-handler arg differs from the
2476 yank-handler property of the latest kill string, this function
2477 adds the combined string to the kill ring as a new element,
2478 instead of replacing the last kill with it.
2479 If `interprogram-cut-function' is set, pass the resulting kill to it."
2480 (let* ((cur (car kill-ring)))
2481 (kill-new (if before-p (concat string cur) (concat cur string))
2482 (or (= (length cur) 0)
2483 (equal yank-handler (get-text-property 0 'yank-handler cur)))
2484 yank-handler)))
2486 (defun current-kill (n &optional do-not-move)
2487 "Rotate the yanking point by N places, and then return that kill.
2488 If N is zero, `interprogram-paste-function' is set, and calling it
2489 returns a string, then that string is added to the front of the
2490 kill ring and returned as the latest kill.
2491 If optional arg DO-NOT-MOVE is non-nil, then don't actually move the
2492 yanking point; just return the Nth kill forward."
2493 (let ((interprogram-paste (and (= n 0)
2494 interprogram-paste-function
2495 (funcall interprogram-paste-function))))
2496 (if interprogram-paste
2497 (progn
2498 ;; Disable the interprogram cut function when we add the new
2499 ;; text to the kill ring, so Emacs doesn't try to own the
2500 ;; selection, with identical text.
2501 (let ((interprogram-cut-function nil))
2502 (kill-new interprogram-paste))
2503 interprogram-paste)
2504 (or kill-ring (error "Kill ring is empty"))
2505 (let ((ARGth-kill-element
2506 (nthcdr (mod (- n (length kill-ring-yank-pointer))
2507 (length kill-ring))
2508 kill-ring)))
2509 (or do-not-move
2510 (setq kill-ring-yank-pointer ARGth-kill-element))
2511 (car ARGth-kill-element)))))
2515 ;;;; Commands for manipulating the kill ring.
2517 (defcustom kill-read-only-ok nil
2518 "*Non-nil means don't signal an error for killing read-only text."
2519 :type 'boolean
2520 :group 'killing)
2522 (put 'text-read-only 'error-conditions
2523 '(text-read-only buffer-read-only error))
2524 (put 'text-read-only 'error-message "Text is read-only")
2526 (defun kill-region (beg end &optional yank-handler)
2528 This deletes the text from the buffer and saves it in the kill ring.
2532 If you want to append the killed region to the last killed text,
2535 If the buffer is read-only, Emacs will beep and refrain from deleting
2536 the text, but put the text in the kill ring anyway. This means that
2537 you can use the killing commands to copy text from a read-only buffer.
2539 This is the primitive for programs to kill text (as opposed to deleting it).
2540 Supply two arguments, character positions indicating the stretch of text
2541 to be killed.
2543 If the previous command was also a kill command,
2544 the text killed this time appends to the text killed last time
2545 to make one entry in the kill ring.
2547 In Lisp code, optional third arg YANK-HANDLER, if non-nil,
2548 specifies the yank-handler text property to be set on the killed
2549 text. See `insert-for-yank'."
2550 (interactive "r")
2551 (condition-case nil
2552 (let ((string (filter-buffer-substring beg end t)))
2553 (when string ;STRING is nil if BEG = END
2554 ;; Add that string to the kill ring, one way or another.
2555 (if (eq last-command 'kill-region)
2556 (kill-append string (< end beg) yank-handler)
2557 (kill-new string nil yank-handler)))
2558 (when (or string (eq last-command 'kill-region))
2559 (setq this-command 'kill-region))
2560 nil)
2561 ((buffer-read-only text-read-only)
2562 ;; The code above failed because the buffer, or some of the characters
2563 ;; in the region, are read-only.
2564 ;; We should beep, in case the user just isn't aware of this.
2565 ;; However, there's no harm in putting
2566 ;; the region's text in the kill ring, anyway.
2567 (copy-region-as-kill beg end)
2568 ;; Set this-command now, so it will be set even if we get an error.
2569 (setq this-command 'kill-region)
2570 ;; This should barf, if appropriate, and give us the correct error.
2571 (if kill-read-only-ok
2572 (progn (message "Read only text copied to kill ring") nil)
2573 ;; Signal an error if the buffer is read-only.
2574 (barf-if-buffer-read-only)
2575 ;; If the buffer isn't read-only, the text is.
2576 (signal 'text-read-only (list (current-buffer)))))))
2578 ;; copy-region-as-kill no longer sets this-command, because it's confusing
2579 ;; to get two copies of the text when the user accidentally types M-w and
2580 ;; then corrects it with the intended C-w.
2581 (defun copy-region-as-kill (beg end)
2582 "Save the region as if killed, but don't kill it.
2583 In Transient Mark mode, deactivate the mark.
2584 If `interprogram-cut-function' is non-nil, also save the text for a window
2585 system cut and paste."
2586 (interactive "r")
2587 (if (eq last-command 'kill-region)
2588 (kill-append (filter-buffer-substring beg end) (< end beg))
2589 (kill-new (filter-buffer-substring beg end)))
2590 (if transient-mark-mode
2591 (setq deactivate-mark t))
2592 nil)
2594 (defun kill-ring-save (beg end)
2595 "Save the region as if killed, but don't kill it.
2596 In Transient Mark mode, deactivate the mark.
2597 If `interprogram-cut-function' is non-nil, also save the text for a window
2598 system cut and paste.
2600 If you want to append the killed line to the last killed text,
2603 This command is similar to `copy-region-as-kill', except that it gives
2604 visual feedback indicating the extent of the region being copied."
2605 (interactive "r")
2606 (copy-region-as-kill beg end)
2607 ;; This use of interactive-p is correct
2608 ;; because the code it controls just gives the user visual feedback.
2609 (if (interactive-p)
2610 (let ((other-end (if (= (point) beg) end beg))
2611 (opoint (point))
2612 ;; Inhibit quitting so we can make a quit here
2613 ;; look like a C-g typed as a command.
2614 (inhibit-quit t))
2615 (if (pos-visible-in-window-p other-end (selected-window))
2616 (unless (and transient-mark-mode
2617 (face-background 'region))
2618 ;; Swap point and mark.
2619 (set-marker (mark-marker) (point) (current-buffer))
2620 (goto-char other-end)
2621 (sit-for blink-matching-delay)
2622 ;; Swap back.
2623 (set-marker (mark-marker) other-end (current-buffer))
2624 (goto-char opoint)
2625 ;; If user quit, deactivate the mark
2626 ;; as C-g would as a command.
2627 (and quit-flag mark-active
2628 (deactivate-mark)))
2629 (let* ((killed-text (current-kill 0))
2630 (message-len (min (length killed-text) 40)))
2631 (if (= (point) beg)
2632 ;; Don't say "killed"; that is misleading.
2634 (substring killed-text (- message-len)))
2636 (substring killed-text 0 message-len))))))))
2638 (defun append-next-kill (&optional interactive)
2639 "Cause following command, if it kills, to append to previous kill.
2640 The argument is used for internal purposes; do not supply one."
2641 (interactive "p")
2642 ;; We don't use (interactive-p), since that breaks kbd macros.
2643 (if interactive
2644 (progn
2645 (setq this-command 'kill-region)
2646 (message "If the next command is a kill, it will append"))
2647 (setq last-command 'kill-region)))
2648 \f
2649 ;; Yanking.
2651 ;; This is actually used in subr.el but defcustom does not work there.
2652 (defcustom yank-excluded-properties
2653 '(read-only invisible intangible field mouse-face help-echo local-map keymap
2654 yank-handler follow-link)
2655 "*Text properties to discard when yanking.
2656 The value should be a list of text properties to discard or t,
2657 which means to discard all text properties."
2658 :type '(choice (const :tag "All" t) (repeat symbol))
2659 :group 'killing
2660 :version "22.1")
2662 (defvar yank-window-start nil)
2663 (defvar yank-undo-function nil
2664 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
2665 Function is called with two parameters, START and END corresponding to
2666 the value of the mark and point; it is guaranteed that START <= END.
2667 Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
2669 (defun yank-pop (&optional arg)
2670 "Replace just-yanked stretch of killed text with a different stretch.
2671 This command is allowed only immediately after a `yank' or a `yank-pop'.
2672 At such a time, the region contains a stretch of reinserted
2673 previously-killed text. `yank-pop' deletes that text and inserts in its
2674 place a different stretch of killed text.
2676 With no argument, the previous kill is inserted.
2677 With argument N, insert the Nth previous kill.
2678 If N is negative, this is a more recent kill.
2680 The sequence of kills wraps around, so that after the oldest one
2681 comes the newest one.
2683 When this command inserts killed text into the buffer, it honors
2684 `yank-excluded-properties' and `yank-handler' as described in the
2685 doc string for `insert-for-yank-1', which see."
2686 (interactive "*p")
2687 (if (not (eq last-command 'yank))
2688 (error "Previous command was not a yank"))
2689 (setq this-command 'yank)
2690 (unless arg (setq arg 1))
2691 (let ((inhibit-read-only t)
2692 (before (< (point) (mark t))))
2693 (if before
2694 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
2695 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
2696 (setq yank-undo-function nil)
2697 (set-marker (mark-marker) (point) (current-buffer))
2698 (insert-for-yank (current-kill arg))
2699 ;; Set the window start back where it was in the yank command,
2700 ;; if possible.
2701 (set-window-start (selected-window) yank-window-start t)
2702 (if before
2703 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
2704 ;; It is cleaner to avoid activation, even though the command
2705 ;; loop would deactivate the mark because we inserted text.
2706 (goto-char (prog1 (mark t)
2707 (set-marker (mark-marker) (point) (current-buffer))))))
2708 nil)
2710 (defun yank (&optional arg)
2712 More precisely, reinsert the stretch of killed text most recently
2713 killed OR yanked. Put point at end, and set mark at beginning.
2714 With just \\[universal-argument] as argument, same but put point at beginning (and mark at end).
2715 With argument N, reinsert the Nth most recently killed stretch of killed
2716 text.
2718 When this command inserts killed text into the buffer, it honors
2719 `yank-excluded-properties' and `yank-handler' as described in the
2720 doc string for `insert-for-yank-1', which see.
2723 (interactive "*P")
2724 (setq yank-window-start (window-start))
2725 ;; If we don't get all the way thru, make last-command indicate that
2726 ;; for the following command.
2727 (setq this-command t)
2728 (push-mark (point))
2729 (insert-for-yank (current-kill (cond
2730 ((listp arg) 0)
2731 ((eq arg '-) -2)
2732 (t (1- arg)))))
2733 (if (consp arg)
2734 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
2735 ;; It is cleaner to avoid activation, even though the command
2736 ;; loop would deactivate the mark because we inserted text.
2737 (goto-char (prog1 (mark t)
2738 (set-marker (mark-marker) (point) (current-buffer)))))
2739 ;; If we do get all the way thru, make this-command indicate that.
2740 (if (eq this-command t)
2741 (setq this-command 'yank))
2742 nil)
2744 (defun rotate-yank-pointer (arg)
2745 "Rotate the yanking point in the kill ring.
2746 With argument, rotate that many kills forward (or backward, if negative)."
2747 (interactive "p")
2748 (current-kill arg))
2749 \f
2750 ;; Some kill commands.
2752 ;; Internal subroutine of delete-char
2753 (defun kill-forward-chars (arg)
2754 (if (listp arg) (setq arg (car arg)))
2755 (if (eq arg '-) (setq arg -1))
2756 (kill-region (point) (forward-point arg)))
2758 ;; Internal subroutine of backward-delete-char
2759 (defun kill-backward-chars (arg)
2760 (if (listp arg) (setq arg (car arg)))
2761 (if (eq arg '-) (setq arg -1))
2762 (kill-region (point) (forward-point (- arg))))
2764 (defcustom backward-delete-char-untabify-method 'untabify
2765 "*The method for untabifying when deleting backward.
2766 Can be `untabify' -- turn a tab to many spaces, then delete one space;
2767 `hungry' -- delete all whitespace, both tabs and spaces;
2768 `all' -- delete all whitespace, including tabs, spaces and newlines;
2769 nil -- just delete one character."
2770 :type '(choice (const untabify) (const hungry) (const all) (const nil))
2771 :version "20.3"
2772 :group 'killing)
2774 (defun backward-delete-char-untabify (arg &optional killp)
2775 "Delete characters backward, changing tabs into spaces.
2776 The exact behavior depends on `backward-delete-char-untabify-method'.
2777 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
2778 Interactively, ARG is the prefix arg (default 1)
2779 and KILLP is t if a prefix arg was specified."
2781 (when (eq backward-delete-char-untabify-method 'untabify)
2782 (let ((count arg))
2783 (save-excursion
2784 (while (and (> count 0) (not (bobp)))
2786 (let ((col (current-column)))
2787 (forward-char -1)
2788 (setq col (- col (current-column)))
2789 (insert-char ?\s col)
2790 (delete-char 1)))
2791 (forward-char -1)
2792 (setq count (1- count))))))
2793 (delete-backward-char
2795 ((eq backward-delete-char-untabify-method 'all)
2797 (if skip
2798 (let ((wh (- (point) (save-excursion (skip-chars-backward skip)
2799 (point)))))
2800 (+ arg (if (zerop wh) 0 (1- wh))))
2801 arg))
2802 killp))
2804 (defun zap-to-char (arg char)
2805 "Kill up to and including ARG'th occurrence of CHAR.
2806 Case is ignored if `case-fold-search' is non-nil in the current buffer.
2807 Goes backward if ARG is negative; error if CHAR not found."
2809 (if (char-table-p translation-table-for-input)
2810 (setq char (or (aref translation-table-for-input char) char)))
2811 (kill-region (point) (progn
2812 (search-forward (char-to-string char) nil nil arg)
2813 ; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
2814 (point))))
2816 ;; kill-line and its subroutines.
2818 (defcustom kill-whole-line nil
2819 "*If non-nil, `kill-line' with no arg at beg of line kills the whole line."
2820 :type 'boolean
2821 :group 'killing)
2823 (defun kill-line (&optional arg)
2824 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
2825 With prefix argument, kill that many lines from point.
2826 Negative arguments kill lines backward.
2827 With zero argument, kills the text before point on the current line.
2830 a number counts as a prefix arg.
2832 To kill a whole line, when point is not at the beginning, type \
2835 If `kill-whole-line' is non-nil, then this command kills the whole line
2836 including its terminating newline, when used at the beginning of a line
2837 with no argument. As a consequence, you can always kill a whole line
2840 If you want to append the killed line to the last killed text,
2843 If the buffer is read-only, Emacs will beep and refrain from deleting
2844 the line, but put the line in the kill ring anyway. This means that
2845 you can use this command to copy text from a read-only buffer.
2846 \(If the variable `kill-read-only-ok' is non-nil, then this won't
2847 even beep.)"
2848 (interactive "P")
2849 (kill-region (point)
2850 ;; It is better to move point to the other end of the kill
2851 ;; before killing. That way, in a read-only buffer, point
2852 ;; moves across the text that is copied to the kill ring.
2853 ;; The choice has no effect on undo now that undo records
2854 ;; the value of point from before the command was run.
2855 (progn
2856 (if arg
2857 (forward-visible-line (prefix-numeric-value arg))
2858 (if (eobp)
2859 (signal 'end-of-buffer nil))
2860 (let ((end
2861 (save-excursion
2862 (end-of-visible-line) (point))))
2863 (if (or (save-excursion
2864 ;; If trailing whitespace is visible,
2865 ;; don't treat it as nothing.
2866 (unless show-trailing-whitespace
2868 (= (point) end))
2869 (and kill-whole-line (bolp)))
2870 (forward-visible-line 1)
2871 (goto-char end))))
2872 (point))))
2874 (defun kill-whole-line (&optional arg)
2875 "Kill current line.
2876 With prefix arg, kill that many lines starting from the current line.
2877 If arg is negative, kill backward. Also kill the preceding newline.
2879 If arg is zero, kill current line but exclude the trailing newline."
2880 (interactive "p")
2881 (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
2882 (signal 'end-of-buffer nil))
2883 (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
2884 (signal 'beginning-of-buffer nil))
2885 (unless (eq last-command 'kill-region)
2886 (kill-new "")
2887 (setq last-command 'kill-region))
2888 (cond ((zerop arg)
2889 ;; We need to kill in two steps, because the previous command
2890 ;; could have been a kill command, in which case the text
2891 ;; before point needs to be prepended to the current kill
2892 ;; ring entry and the text after point appended. Also, we
2893 ;; need to use save-excursion to avoid copying the same text
2894 ;; twice to the kill ring in read-only buffers.
2895 (save-excursion
2896 (kill-region (point) (progn (forward-visible-line 0) (point))))
2897 (kill-region (point) (progn (end-of-visible-line) (point))))
2898 ((< arg 0)
2899 (save-excursion
2900 (kill-region (point) (progn (end-of-visible-line) (point))))
2901 (kill-region (point)
2902 (progn (forward-visible-line (1+ arg))
2903 (unless (bobp) (backward-char))
2904 (point))))
2905 (t
2906 (save-excursion
2907 (kill-region (point) (progn (forward-visible-line 0) (point))))
2908 (kill-region (point)
2909 (progn (forward-visible-line arg) (point))))))
2911 (defun forward-visible-line (arg)
2912 "Move forward by ARG lines, ignoring currently invisible newlines only.
2913 If ARG is negative, move backward -ARG lines.
2914 If ARG is zero, move to the beginning of the current line."
2915 (condition-case nil
2916 (if (> arg 0)
2917 (progn
2918 (while (> arg 0)
2919 (or (zerop (forward-line 1))
2920 (signal 'end-of-buffer nil))
2921 ;; If the newline we just skipped is invisible,
2922 ;; don't count it.
2923 (let ((prop
2924 (get-char-property (1- (point)) 'invisible)))
2925 (if (if (eq buffer-invisibility-spec t)
2926 prop
2927 (or (memq prop buffer-invisibility-spec)
2928 (assq prop buffer-invisibility-spec)))
2929 (setq arg (1+ arg))))
2930 (setq arg (1- arg)))
2931 ;; If invisible text follows, and it is a number of complete lines,
2932 ;; skip it.
2933 (let ((opoint (point)))
2934 (while (and (not (eobp))
2935 (let ((prop
2936 (get-char-property (point) 'invisible)))
2937 (if (eq buffer-invisibility-spec t)
2938 prop
2939 (or (memq prop buffer-invisibility-spec)
2940 (assq prop buffer-invisibility-spec)))))
2941 (goto-char
2942 (if (get-text-property (point) 'invisible)
2943 (or (next-single-property-change (point) 'invisible)
2944 (point-max))
2945 (next-overlay-change (point)))))
2946 (unless (bolp)
2947 (goto-char opoint))))
2948 (let ((first t))
2949 (while (or first (<= arg 0))
2950 (if first
2951 (beginning-of-line)
2952 (or (zerop (forward-line -1))
2953 (signal 'beginning-of-buffer nil)))
2954 ;; If the newline we just moved to is invisible,
2955 ;; don't count it.
2956 (unless (bobp)
2957 (let ((prop
2958 (get-char-property (1- (point)) 'invisible)))
2959 (unless (if (eq buffer-invisibility-spec t)
2960 prop
2961 (or (memq prop buffer-invisibility-spec)
2962 (assq prop buffer-invisibility-spec)))
2963 (setq arg (1+ arg)))))
2964 (setq first nil))
2965 ;; If invisible text follows, and it is a number of complete lines,
2966 ;; skip it.
2967 (let ((opoint (point)))
2968 (while (and (not (bobp))
2969 (let ((prop
2970 (get-char-property (1- (point)) 'invisible)))
2971 (if (eq buffer-invisibility-spec t)
2972 prop
2973 (or (memq prop buffer-invisibility-spec)
2974 (assq prop buffer-invisibility-spec)))))
2975 (goto-char
2976 (if (get-text-property (1- (point)) 'invisible)
2977 (or (previous-single-property-change (point) 'invisible)
2978 (point-min))
2979 (previous-overlay-change (point)))))
2980 (unless (bolp)
2981 (goto-char opoint)))))
2982 ((beginning-of-buffer end-of-buffer)
2983 nil)))
2985 (defun end-of-visible-line ()
2986 "Move to end of current visible line."
2987 (end-of-line)
2988 ;; If the following character is currently invisible,
2989 ;; skip all characters with that same `invisible' property value,
2990 ;; then find the next newline.
2991 (while (and (not (eobp))
2992 (save-excursion
2994 (let ((prop
2995 (get-char-property (point) 'invisible)))
2996 (if (eq buffer-invisibility-spec t)
2997 prop
2998 (or (memq prop buffer-invisibility-spec)
2999 (assq prop buffer-invisibility-spec))))))
3001 (if (get-text-property (point) 'invisible)
3002 (goto-char (next-single-property-change (point) 'invisible))
3003 (goto-char (next-overlay-change (point))))
3004 (end-of-line)))
3005 \f
3006 (defun insert-buffer (buffer)
3007 "Insert after point the contents of BUFFER.
3008 Puts mark after the inserted text.
3009 BUFFER may be a buffer or a buffer name.
3011 This function is meant for the user to run interactively.
3012 Don't call it from programs: use `insert-buffer-substring' instead!"
3013 (interactive
3014 (list
3015 (progn
3016 (barf-if-buffer-read-only)
3017 (read-buffer "Insert buffer: "
3018 (if (eq (selected-window) (next-window (selected-window)))
3019 (other-buffer (current-buffer))
3020 (window-buffer (next-window (selected-window))))
3021 t))))
3022 (push-mark
3023 (save-excursion
3024 (insert-buffer-substring (get-buffer buffer))
3025 (point)))
3026 nil)
3028 (defun append-to-buffer (buffer start end)
3029 "Append to specified buffer the text of the region.
3030 It is inserted into that buffer before its point.
3032 When calling from a program, give three arguments:
3033 BUFFER (or buffer name), START and END.
3034 START and END specify the portion of the current buffer to be copied."
3035 (interactive
3036 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
3037 (region-beginning) (region-end)))
3038 (let ((oldbuf (current-buffer)))
3039 (save-excursion
3040 (let* ((append-to (get-buffer-create buffer))
3041 (windows (get-buffer-window-list append-to t t))
3042 point)
3043 (set-buffer append-to)
3044 (setq point (point))
3045 (barf-if-buffer-read-only)
3046 (insert-buffer-substring oldbuf start end)
3047 (dolist (window windows)
3048 (when (= (window-point window) point)
3049 (set-window-point window (point))))))))
3051 (defun prepend-to-buffer (buffer start end)
3052 "Prepend to specified buffer the text of the region.
3053 It is inserted into that buffer after its point.
3055 When calling from a program, give three arguments:
3056 BUFFER (or buffer name), START and END.
3057 START and END specify the portion of the current buffer to be copied."
3059 (let ((oldbuf (current-buffer)))
3060 (save-excursion
3061 (set-buffer (get-buffer-create buffer))
3062 (barf-if-buffer-read-only)
3063 (save-excursion
3064 (insert-buffer-substring oldbuf start end)))))
3066 (defun copy-to-buffer (buffer start end)
3067 "Copy to specified buffer the text of the region.
3068 It is inserted into that buffer, replacing existing text there.
3070 When calling from a program, give three arguments:
3071 BUFFER (or buffer name), START and END.
3072 START and END specify the portion of the current buffer to be copied."
3074 (let ((oldbuf (current-buffer)))
3075 (with-current-buffer (get-buffer-create buffer)
3076 (barf-if-buffer-read-only)
3077 (erase-buffer)
3078 (save-excursion
3079 (insert-buffer-substring oldbuf start end)))))
3080 \f
3081 (put 'mark-inactive 'error-conditions '(mark-inactive error))
3082 (put 'mark-inactive 'error-message "The mark is not active now")
3084 (defvar activate-mark-hook nil
3085 "Hook run when the mark becomes active.
3086 It is also run at the end of a command, if the mark is active and
3087 it is possible that the region may have changed")
3089 (defvar deactivate-mark-hook nil
3090 "Hook run when the mark becomes inactive.")
3092 (defun mark (&optional force)
3093 "Return this buffer's mark value as integer, or nil if never set.
3095 In Transient Mark mode, this function signals an error if
3096 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
3097 or the argument FORCE is non-nil, it disregards whether the mark
3098 is active, and returns an integer or nil in the usual way.
3100 If you are using this in an editing command, you are most likely making
3101 a mistake; see the documentation of `set-mark'."
3102 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
3103 (marker-position (mark-marker))
3104 (signal 'mark-inactive nil)))
3106 ;; Many places set mark-active directly, and several of them failed to also
3107 ;; run deactivate-mark-hook. This shorthand should simplify.
3108 (defsubst deactivate-mark ()
3109 "Deactivate the mark by setting `mark-active' to nil.
3110 \(That makes a difference only in Transient Mark mode.)
3111 Also runs the hook `deactivate-mark-hook'."
3112 (cond
3113 ((eq transient-mark-mode 'lambda)
3114 (setq transient-mark-mode nil))
3115 (transient-mark-mode
3116 (setq mark-active nil)
3117 (run-hooks 'deactivate-mark-hook))))
3119 (defun set-mark (pos)
3120 "Set this buffer's mark to POS. Don't use this function!
3121 That is to say, don't use this function unless you want
3122 the user to see that the mark has moved, and you want the previous
3123 mark position to be lost.
3125 Normally, when a new mark is set, the old one should go on the stack.
3126 This is why most applications should use `push-mark', not `set-mark'.
3128 Novice Emacs Lisp programmers often try to use the mark for the wrong
3129 purposes. The mark saves a location for the user's convenience.
3130 Most editing commands should not alter the mark.
3131 To remember a location for internal use in the Lisp program,
3132 store it in a Lisp variable. Example:
3134 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
3136 (if pos
3137 (progn
3138 (setq mark-active t)
3139 (run-hooks 'activate-mark-hook)
3140 (set-marker (mark-marker) pos (current-buffer)))
3141 ;; Normally we never clear mark-active except in Transient Mark mode.
3142 ;; But when we actually clear out the mark value too,
3143 ;; we must clear mark-active in any mode.
3144 (setq mark-active nil)
3145 (run-hooks 'deactivate-mark-hook)
3146 (set-marker (mark-marker) nil)))
3148 (defvar mark-ring nil
3149 "The list of former marks of the current buffer, most recent first.")
3150 (make-variable-buffer-local 'mark-ring)
3151 (put 'mark-ring 'permanent-local t)
3153 (defcustom mark-ring-max 16
3154 "*Maximum size of mark ring. Start discarding off end if gets this big."
3155 :type 'integer
3156 :group 'editing-basics)
3158 (defvar global-mark-ring nil
3159 "The list of saved global marks, most recent first.")
3161 (defcustom global-mark-ring-max 16
3162 "*Maximum size of global mark ring. \
3163 Start discarding off end if gets this big."
3164 :type 'integer
3165 :group 'editing-basics)
3167 (defun pop-to-mark-command ()
3168 "Jump to mark, and pop a new position for mark off the ring
3169 \(does not affect global mark ring\)."
3170 (interactive)
3171 (if (null (mark t))
3172 (error "No mark set in this buffer")
3173 (goto-char (mark t))
3174 (pop-mark)))
3176 (defun push-mark-command (arg &optional nomsg)
3177 "Set mark at where point is.
3178 If no prefix arg and mark is already set there, just activate it.
3179 Display `Mark set' unless the optional second arg NOMSG is non-nil."
3180 (interactive "P")
3181 (let ((mark (marker-position (mark-marker))))
3182 (if (or arg (null mark) (/= mark (point)))
3183 (push-mark nil nomsg t)
3184 (setq mark-active t)
3185 (run-hooks 'activate-mark-hook)
3186 (unless nomsg
3187 (message "Mark activated")))))
3189 (defcustom set-mark-command-repeat-pop nil
3192 will pop twice."
3193 :type 'boolean
3194 :group 'editing)
3196 (defun set-mark-command (arg)
3197 "Set mark at where point is, or jump to mark.
3198 With no prefix argument, set mark, and push old mark position on local
3199 mark ring; also push mark on global mark ring if last mark was set in
3200 another buffer. Immediately repeating the command activates
3201 `transient-mark-mode' temporarily.
3204 jump to mark, and pop a new position
3205 for mark off the local mark ring \(this does not affect the global
3207 mark ring \(see `pop-global-mark'\).
3209 If `set-mark-command-repeat-pop' is non-nil, repeating
3211 off the local (or global) mark ring and jumps there.
3215 set mark where point is.
3220 Novice Emacs Lisp programmers often try to use the mark for the wrong
3221 purposes. See the documentation of `set-mark' for more information."
3222 (interactive "P")
3223 (if (eq transient-mark-mode 'lambda)
3224 (setq transient-mark-mode nil))
3225 (cond
3226 ((and (consp arg) (> (prefix-numeric-value arg) 4))
3227 (push-mark-command nil))
3228 ((not (eq this-command 'set-mark-command))
3229 (if arg
3230 (pop-to-mark-command)
3231 (push-mark-command t)))
3232 ((and set-mark-command-repeat-pop
3233 (eq last-command 'pop-to-mark-command))
3234 (setq this-command 'pop-to-mark-command)
3235 (pop-to-mark-command))
3236 ((and set-mark-command-repeat-pop
3237 (eq last-command 'pop-global-mark)
3238 (not arg))
3239 (setq this-command 'pop-global-mark)
3240 (pop-global-mark))
3241 (arg
3242 (setq this-command 'pop-to-mark-command)
3243 (pop-to-mark-command))
3244 ((and (eq last-command 'set-mark-command)
3245 mark-active (null transient-mark-mode))
3246 (setq transient-mark-mode 'lambda)
3247 (message "Transient-mark-mode temporarily enabled"))
3248 (t
3249 (push-mark-command nil))))
3251 (defun push-mark (&optional location nomsg activate)
3252 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
3253 If the last global mark pushed was not in the current buffer,
3254 also push LOCATION on the global mark ring.
3255 Display `Mark set' unless the optional second arg NOMSG is non-nil.
3256 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil.
3258 Novice Emacs Lisp programmers often try to use the mark for the wrong
3259 purposes. See the documentation of `set-mark' for more information.
3261 In Transient Mark mode, this does not activate the mark."
3262 (unless (null (mark t))
3263 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
3264 (when (> (length mark-ring) mark-ring-max)
3265 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
3266 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))
3267 (set-marker (mark-marker) (or location (point)) (current-buffer))
3268 ;; Now push the mark on the global mark ring.
3269 (if (and global-mark-ring
3270 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
3271 ;; The last global mark pushed was in this same buffer.
3272 ;; Don't push another one.
3273 nil
3274 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
3275 (when (> (length global-mark-ring) global-mark-ring-max)
3276 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring)) nil)
3277 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))
3278 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
3279 (message "Mark set"))
3280 (if (or activate (not transient-mark-mode))
3281 (set-mark (mark t)))
3282 nil)
3284 (defun pop-mark ()
3285 "Pop off mark ring into the buffer's actual mark.
3286 Does not set point. Does nothing if mark ring is empty."
3287 (when mark-ring
3288 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
3289 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
3290 (move-marker (car mark-ring) nil)
3291 (if (null (mark t)) (ding))
3292 (setq mark-ring (cdr mark-ring)))
3293 (deactivate-mark))
3295 (defalias 'exchange-dot-and-mark 'exchange-point-and-mark)
3296 (defun exchange-point-and-mark (&optional arg)
3297 "Put the mark where point is now, and point where the mark is now.
3298 This command works even when the mark is not active,
3299 and it reactivates the mark.
3300 With prefix arg, `transient-mark-mode' is enabled temporarily."
3301 (interactive "P")
3302 (if arg
3303 (if mark-active
3304 (if (null transient-mark-mode)
3305 (setq transient-mark-mode 'lambda))
3306 (setq arg nil)))
3307 (unless arg
3308 (let ((omark (mark t)))
3309 (if (null omark)
3310 (error "No mark set in this buffer"))
3311 (set-mark (point))
3312 (goto-char omark)
3313 nil)))
3315 (define-minor-mode transient-mark-mode
3316 "Toggle Transient Mark mode.
3317 With arg, turn Transient Mark mode on if arg is positive, off otherwise.
3319 In Transient Mark mode, when the mark is active, the region is highlighted.
3321 So do certain other operations that set the mark
3322 but whose main purpose is something else--for example,
3328 Many commands change their behavior when Transient Mark mode is in effect
3329 and the mark is active, by acting on the region instead of their usual
3330 default part of the buffer's text. Examples of such commands include
3335 commands which are sensitive to the Transient Mark mode."
3336 :global t :group 'editing-basics)
3338 (defvar widen-automatically t
3339 "Non-nil means it is ok for commands to call `widen' when they want to.
3340 Some commands will do this in order to go to positions outside
3341 the current accessible part of the buffer.
3343 If `widen-automatically' is nil, these commands will do something else
3344 as a fallback, and won't change the buffer bounds.")
3346 (defun pop-global-mark ()
3347 "Pop off global mark ring and jump to the top location."
3348 (interactive)
3349 ;; Pop entries which refer to non-existent buffers.
3350 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
3351 (setq global-mark-ring (cdr global-mark-ring)))
3352 (or global-mark-ring
3353 (error "No global mark set"))
3354 (let* ((marker (car global-mark-ring))
3355 (buffer (marker-buffer marker))
3356 (position (marker-position marker)))
3357 (setq global-mark-ring (nconc (cdr global-mark-ring)
3358 (list (car global-mark-ring))))
3359 (set-buffer buffer)
3360 (or (and (>= position (point-min))
3361 (<= position (point-max)))
3362 (if widen-automatically
3363 (widen)
3364 (error "Global mark position is outside accessible part of buffer")))
3365 (goto-char position)
3366 (switch-to-buffer buffer)))
3367 \f
3368 (defcustom next-line-add-newlines nil
3369 "*If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
3370 :type 'boolean
3371 :version "21.1"
3372 :group 'editing-basics)
3374 (defun next-line (&optional arg try-vscroll)
3375 "Move cursor vertically down ARG lines.
3376 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
3377 If there is no character in the target line exactly under the current column,
3378 the cursor is positioned after the character in that line which spans this
3379 column, or at the end of the line if it is not long enough.
3380 If there is no line in the buffer after this one, behavior depends on the
3381 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
3382 to create a line, and moves the cursor to that line. Otherwise it moves the
3383 cursor to the end of the buffer.
3386 a semipermanent goal column for this command.
3387 Then instead of trying to move exactly vertically (or as close as possible),
3388 this command moves to the specified goal column (or as close as possible).
3389 The goal column is stored in the variable `goal-column', which is nil
3390 when there is no goal column.
3392 If you are thinking of using this in a Lisp program, consider
3393 using `forward-line' instead. It is usually easier to use
3394 and more reliable (no dependence on goal column, etc.)."
3396 (or arg (setq arg 1))
3397 (if (and next-line-add-newlines (= arg 1))
3398 (if (save-excursion (end-of-line) (eobp))
3399 ;; When adding a newline, don't expand an abbrev.
3400 (let ((abbrev-mode nil))
3401 (end-of-line)
3403 (line-move arg nil nil try-vscroll))
3404 (if (interactive-p)
3405 (condition-case nil
3406 (line-move arg nil nil try-vscroll)
3407 ((beginning-of-buffer end-of-buffer) (ding)))
3408 (line-move arg nil nil try-vscroll)))
3409 nil)
3411 (defun previous-line (&optional arg try-vscroll)
3412 "Move cursor vertically up ARG lines.
3413 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
3414 If there is no character in the target line exactly over the current column,
3415 the cursor is positioned after the character in that line which spans this
3416 column, or at the end of the line if it is not long enough.
3419 a semipermanent goal column for this command.
3420 Then instead of trying to move exactly vertically (or as close as possible),
3421 this command moves to the specified goal column (or as close as possible).
3422 The goal column is stored in the variable `goal-column', which is nil
3423 when there is no goal column.
3425 If you are thinking of using this in a Lisp program, consider using
3426 `forward-line' with a negative argument instead. It is usually easier
3427 to use and more reliable (no dependence on goal column, etc.)."
3429 (or arg (setq arg 1))
3430 (if (interactive-p)
3431 (condition-case nil
3432 (line-move (- arg) nil nil try-vscroll)
3433 ((beginning-of-buffer end-of-buffer) (ding)))
3434 (line-move (- arg) nil nil try-vscroll))
3435 nil)
3437 (defcustom track-eol nil
3438 "*Non-nil means vertical motion starting at end of line keeps to ends of lines.
3439 This means moving to the end of each line moved onto.
3440 The beginning of a blank line does not count as the end of a line."
3441 :type 'boolean
3442 :group 'editing-basics)
3444 (defcustom goal-column nil
3446 :type '(choice integer
3447 (const :tag "None" nil))
3448 :group 'editing-basics)
3449 (make-variable-buffer-local 'goal-column)
3451 (defvar temporary-goal-column 0
3452 "Current goal column for vertical motion.
3453 It is the column where point was
3454 at the start of current run of vertical motion commands.
3455 When the `track-eol' feature is doing its job, the value is 9999.")
3457 (defcustom line-move-ignore-invisible t
3459 Outline mode sets this."
3460 :type 'boolean
3461 :group 'editing-basics)
3463 (defun line-move-invisible-p (pos)
3464 "Return non-nil if the character after POS is currently invisible."
3465 (let ((prop
3466 (get-char-property pos 'invisible)))
3467 (if (eq buffer-invisibility-spec t)
3468 prop
3469 (or (memq prop buffer-invisibility-spec)
3470 (assq prop buffer-invisibility-spec)))))
3472 ;; This is like line-move-1 except that it also performs
3473 ;; vertical scrolling of tall images if appropriate.
3474 ;; That is not really a clean thing to do, since it mixes
3475 ;; scrolling with cursor motion. But so far we don't have
3476 ;; a cleaner solution to the problem of making C-n do something
3477 ;; useful given a tall image.
3478 (defun line-move (arg &optional noerror to-end try-vscroll)
3479 (if (and auto-window-vscroll try-vscroll
3480 ;; But don't vscroll in a keyboard macro.
3481 (not defining-kbd-macro)
3482 (not executing-kbd-macro))
3483 (let ((forward (> arg 0))
3484 (part (nth 2 (pos-visible-in-window-p (point) nil t))))
3485 (if (and (consp part)
3486 (> (if forward (cdr part) (car part)) 0))
3487 (set-window-vscroll nil
3488 (if forward
3489 (+ (window-vscroll nil t)
3490 (min (cdr part)
3491 (* (frame-char-height) arg)))
3492 (max 0
3493 (- (window-vscroll nil t)
3494 (min (car part)
3495 (* (frame-char-height) (- arg))))))
3496 t)
3497 (set-window-vscroll nil 0)
3498 (when (line-move-1 arg noerror to-end)
3499 (when (not forward)
3500 ;; Update display before calling pos-visible-in-window-p,
3501 ;; because it depends on window-start being up-to-date.
3502 (sit-for 0)
3503 ;; If the current line is partly hidden at the bottom,
3504 ;; scroll it partially up so as to unhide the bottom.
3505 (if (and (setq part (nth 2 (pos-visible-in-window-p
3506 (line-beginning-position) nil t)))
3507 (> (cdr part) 0))
3508 (set-window-vscroll nil (cdr part) t)))
3509 t)))
3510 (line-move-1 arg noerror to-end)))
3512 ;; This is the guts of next-line and previous-line.
3513 ;; Arg says how many lines to move.
3514 ;; The value is t if we can move the specified number of lines.
3515 (defun line-move-1 (arg &optional noerror to-end)
3516 ;; Don't run any point-motion hooks, and disregard intangibility,
3517 ;; for intermediate positions.
3518 (let ((inhibit-point-motion-hooks t)
3519 (opoint (point))
3520 (forward (> arg 0)))
3521 (unwind-protect
3522 (progn
3523 (if (not (memq last-command '(next-line previous-line)))
3524 (setq temporary-goal-column
3525 (if (and track-eol (eolp)
3526 ;; Don't count beg of empty line as end of line
3527 ;; unless we just did explicit end-of-line.
3528 (or (not (bolp)) (eq last-command 'end-of-line)))
3529 9999
3530 (current-column))))
3532 (if (and (not (integerp selective-display))
3533 (not line-move-ignore-invisible))
3534 ;; Use just newline characters.
3535 ;; Set ARG to 0 if we move as many lines as requested.
3536 (or (if (> arg 0)
3537 (progn (if (> arg 1) (forward-line (1- arg)))
3538 ;; This way of moving forward ARG lines
3539 ;; verifies that we have a newline after the last one.
3540 ;; It doesn't get confused by intangible text.
3541 (end-of-line)
3542 (if (zerop (forward-line 1))
3543 (setq arg 0)))
3544 (and (zerop (forward-line arg))
3545 (bolp)
3546 (setq arg 0)))
3547 (unless noerror
3548 (signal (if (< arg 0)
3549 'beginning-of-buffer
3550 'end-of-buffer)
3551 nil)))
3552 ;; Move by arg lines, but ignore invisible ones.
3553 (let (done)
3554 (while (and (> arg 0) (not done))
3555 ;; If the following character is currently invisible,
3556 ;; skip all characters with that same `invisible' property value.
3557 (while (and (not (eobp)) (line-move-invisible-p (point)))
3558 (goto-char (next-char-property-change (point))))
3559 ;; Now move a line.
3560 (end-of-line)
3561 ;; If there's no invisibility here, move over the newline.
3562 (cond
3563 ((eobp)
3564 (if (not noerror)
3565 (signal 'end-of-buffer nil)
3566 (setq done t)))
3567 ((and (> arg 1) ;; Use vertical-motion for last move
3568 (not (integerp selective-display))
3569 (not (line-move-invisible-p (point))))
3570 ;; We avoid vertical-motion when possible
3571 ;; because that has to fontify.
3572 (forward-line 1))
3573 ;; Otherwise move a more sophisticated way.
3574 ((zerop (vertical-motion 1))
3575 (if (not noerror)
3576 (signal 'end-of-buffer nil)
3577 (setq done t))))
3578 (unless done
3579 (setq arg (1- arg))))
3580 ;; The logic of this is the same as the loop above,
3581 ;; it just goes in the other direction.
3582 (while (and (< arg 0) (not done))
3583 (beginning-of-line)
3584 (cond
3585 ((bobp)
3586 (if (not noerror)
3587 (signal 'beginning-of-buffer nil)
3588 (setq done t)))
3589 ((and (< arg -1) ;; Use vertical-motion for last move
3590 (not (integerp selective-display))
3591 (not (line-move-invisible-p (1- (point)))))
3592 (forward-line -1))
3593 ((zerop (vertical-motion -1))
3594 (if (not noerror)
3595 (signal 'beginning-of-buffer nil)
3596 (setq done t))))
3597 (unless done
3598 (setq arg (1+ arg))
3599 (while (and ;; Don't move over previous invis lines
3600 ;; if our target is the middle of this line.
3601 (or (zerop (or goal-column temporary-goal-column))
3602 (< arg 0))
3603 (not (bobp)) (line-move-invisible-p (1- (point))))
3604 (goto-char (previous-char-property-change (point))))))))
3605 ;; This is the value the function returns.
3606 (= arg 0))
3608 (cond ((> arg 0)
3609 ;; If we did not move down as far as desired,
3610 ;; at least go to end of line.
3611 (end-of-line))
3612 ((< arg 0)
3613 ;; If we did not move up as far as desired,
3614 ;; at least go to beginning of line.
3615 (beginning-of-line))
3616 (t
3617 (line-move-finish (or goal-column temporary-goal-column)
3618 opoint forward))))))
3620 (defun line-move-finish (column opoint forward)
3621 (let ((repeat t))
3622 (while repeat
3623 ;; Set REPEAT to t to repeat the whole thing.
3624 (setq repeat nil)
3626 (let (new
3627 (line-beg (save-excursion (beginning-of-line) (point)))
3628 (line-end
3629 ;; Compute the end of the line
3630 ;; ignoring effectively invisible newlines.
3631 (save-excursion
3632 ;; Like end-of-line but ignores fields.
3634 (while (and (not (eobp)) (line-move-invisible-p (point)))
3635 (goto-char (next-char-property-change (point)))
3637 (point))))
3639 ;; Move to the desired column.
3640 (line-move-to-column column)
3641 (setq new (point))
3643 ;; Process intangibility within a line.
3644 ;; Move to the chosen destination position from above,
3645 ;; with intangibility processing enabled.
3647 (goto-char (point-min))
3648 (let ((inhibit-point-motion-hooks nil))
3649 (goto-char new)
3651 ;; If intangibility moves us to a different (later) place
3652 ;; in the same line, use that as the destination.
3653 (if (<= (point) line-end)
3654 (setq new (point))
3655 ;; If that position is "too late",
3656 ;; try the previous allowable position.
3657 ;; See if it is ok.
3658 (backward-char)
3659 (if (if forward
3660 ;; If going forward, don't accept the previous
3661 ;; allowable position if it is before the target line.
3662 (< line-beg (point))
3663 ;; If going backward, don't accept the previous
3664 ;; allowable position if it is still after the target line.
3665 (<= (point) line-end))
3666 (setq new (point))
3667 ;; As a last resort, use the end of the line.
3668 (setq new line-end))))
3670 ;; Now move to the updated destination, processing fields
3671 ;; as well as intangibility.
3672 (goto-char opoint)
3673 (let ((inhibit-point-motion-hooks nil))
3674 (goto-char
3675 (constrain-to-field new opoint nil t
3676 'inhibit-line-move-field-capture)))
3678 ;; If all this moved us to a different line,
3679 ;; retry everything within that new line.
3680 (when (or (< (point) line-beg) (> (point) line-end))
3681 ;; Repeat the intangibility and field processing.
3682 (setq repeat t))))))
3684 (defun line-move-to-column (col)
3685 "Try to find column COL, considering invisibility.
3686 This function works only in certain cases,
3687 because what we really need is for `move-to-column'
3688 and `current-column' to be able to ignore invisible text."
3689 (if (zerop col)
3690 (beginning-of-line)
3691 (move-to-column col))
3693 (when (and line-move-ignore-invisible
3694 (not (bolp)) (line-move-invisible-p (1- (point))))
3695 (let ((normal-location (point))
3696 (normal-column (current-column)))
3697 ;; If the following character is currently invisible,
3698 ;; skip all characters with that same `invisible' property value.
3699 (while (and (not (eobp))
3700 (line-move-invisible-p (point)))
3701 (goto-char (next-char-property-change (point))))
3702 ;; Have we advanced to a larger column position?
3703 (if (> (current-column) normal-column)
3704 ;; We have made some progress towards the desired column.
3705 ;; See if we can make any further progress.
3706 (line-move-to-column (+ (current-column) (- col normal-column)))
3707 ;; Otherwise, go to the place we originally found
3708 ;; and move back over invisible text.
3709 ;; that will get us to the same place on the screen
3710 ;; but with a more reasonable buffer position.
3711 (goto-char normal-location)
3712 (let ((line-beg (save-excursion (beginning-of-line) (point))))
3713 (while (and (not (bolp)) (line-move-invisible-p (1- (point))))
3714 (goto-char (previous-char-property-change (point) line-beg))))))))
3716 (defun move-end-of-line (arg)
3717 "Move point to end of current line as displayed.
3718 \(If there's an image in the line, this disregards newlines
3719 which are part of the text that the image rests on.)
3721 With argument ARG not nil or 1, move forward ARG - 1 lines first.
3722 If point reaches the beginning or end of buffer, it stops there.
3723 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
3724 (interactive "p")
3725 (or arg (setq arg 1))
3726 (let (done)
3727 (while (not done)
3728 (let ((newpos
3729 (save-excursion
3730 (let ((goal-column 0))
3731 (and (line-move arg t)
3732 (not (bobp))
3733 (progn
3734 (while (and (not (bobp)) (line-move-invisible-p (1- (point))))
3735 (goto-char (previous-char-property-change (point))))
3736 (backward-char 1)))
3737 (point)))))
3738 (goto-char newpos)
3739 (if (and (> (point) newpos)
3741 (backward-char 1)
3742 (if (and (> (point) newpos) (not (eobp))
3744 ;; If we skipped something intangible
3745 ;; and now we're not really at eol,
3746 ;; keep going.
3747 (setq arg 1)
3748 (setq done t)))))))
3750 (defun move-beginning-of-line (arg)
3751 "Move point to beginning of current line as displayed.
3752 \(If there's an image in the line, this disregards newlines
3753 which are part of the text that the image rests on.)
3755 With argument ARG not nil or 1, move forward ARG - 1 lines first.
3756 If point reaches the beginning or end of buffer, it stops there.
3757 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
3758 (interactive "p")
3759 (or arg (setq arg 1))
3761 (let ((orig (point)))
3763 ;; Move by lines, if ARG is not 1 (the default).
3764 (if (/= arg 1)
3765 (line-move (1- arg) t))
3767 ;; Move to beginning-of-line, ignoring fields and invisibles.
3769 (while (and (not (bobp)) (line-move-invisible-p (1- (point))))
3770 (goto-char (previous-char-property-change (point)))
3773 ;; Take care of fields.
3774 (goto-char (constrain-to-field (point) orig
3775 (/= arg 1) t nil))))
3778 ;;; Many people have said they rarely use this feature, and often type
3779 ;;; it by accident. Maybe it shouldn't even be on a key.
3780 (put 'set-goal-column 'disabled t)
3782 (defun set-goal-column (arg)
3784 Those commands will move to this position in the line moved to
3785 rather than trying to keep the same horizontal position.
3786 With a non-nil argument, clears out the goal column
3788 The goal column is stored in the variable `goal-column'."
3789 (interactive "P")
3790 (if arg
3791 (progn
3792 (setq goal-column nil)
3793 (message "No goal column"))
3794 (setq goal-column (current-column))
3795 ;; The older method below can be erroneous if `set-goal-column' is bound
3796 ;; to a sequence containing %
3797 ;;(message (substitute-command-keys
3799 ;;goal-column)
3800 (message "%s"
3801 (concat
3802 (format "Goal column %d " goal-column)
3803 (substitute-command-keys
3806 )
3807 nil)
3808 \f
3810 (defun scroll-other-window-down (lines)
3812 For more details, see the documentation for `scroll-other-window'."
3813 (interactive "P")
3814 (scroll-other-window
3815 ;; Just invert the argument's meaning.
3816 ;; We can do that without knowing which window it will be.
3817 (if (eq lines '-) nil
3818 (if (null lines) '-
3819 (- (prefix-numeric-value lines))))))
3821 (defun beginning-of-buffer-other-window (arg)
3822 "Move point to the beginning of the buffer in the other window.
3823 Leave mark at previous position.
3824 With arg N, put point N/10 of the way from the true beginning."
3825 (interactive "P")
3826 (let ((orig-window (selected-window))
3827 (window (other-window-for-scrolling)))
3828 ;; We use unwind-protect rather than save-window-excursion
3829 ;; because the latter would preserve the things we want to change.
3830 (unwind-protect
3831 (progn
3832 (select-window window)
3833 ;; Set point and mark in that window's buffer.
3834 (with-no-warnings
3835 (beginning-of-buffer arg))
3836 ;; Set point accordingly.
3837 (recenter '(t)))
3838 (select-window orig-window))))
3840 (defun end-of-buffer-other-window (arg)
3841 "Move point to the end of the buffer in the other window.
3842 Leave mark at previous position.
3843 With arg N, put point N/10 of the way from the true end."
3844 (interactive "P")
3845 ;; See beginning-of-buffer-other-window for comments.
3846 (let ((orig-window (selected-window))
3847 (window (other-window-for-scrolling)))
3848 (unwind-protect
3849 (progn
3850 (select-window window)
3851 (with-no-warnings
3852 (end-of-buffer arg))
3853 (recenter '(t)))
3854 (select-window orig-window))))
3855 \f
3856 (defun transpose-chars (arg)
3857 "Interchange characters around point, moving forward one character.
3858 With prefix arg ARG, effect is to take character before point
3859 and drag it forward past ARG other characters (backward if ARG negative).
3860 If no argument and at end of line, the previous two chars are exchanged."
3861 (interactive "*P")
3862 (and (null arg) (eolp) (forward-char -1))
3863 (transpose-subr 'forward-char (prefix-numeric-value arg)))
3865 (defun transpose-words (arg)
3866 "Interchange words around point, leaving point at end of them.
3867 With prefix arg ARG, effect is to take word before or around point
3868 and drag it forward past ARG other words (backward if ARG negative).
3869 If ARG is zero, the words around or after point and around or after mark
3870 are interchanged."
3871 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
3872 (interactive "*p")
3873 (transpose-subr 'forward-word arg))
3875 (defun transpose-sexps (arg)
3877 Does not work on a sexp that point is in the middle of
3878 if it is a list or string."
3879 (interactive "*p")
3880 (transpose-subr
3881 (lambda (arg)
3882 ;; Here we should try to simulate the behavior of
3883 ;; (cons (progn (forward-sexp x) (point))
3884 ;; (progn (forward-sexp (- x)) (point)))
3885 ;; Except that we don't want to rely on the second forward-sexp
3886 ;; putting us back to where we want to be, since forward-sexp-function
3887 ;; might do funny things like infix-precedence.
3888 (if (if (> arg 0)
3890 (and (not (bobp))
3892 ;; Jumping over a symbol. We might be inside it, mind you.
3893 (progn (funcall (if (> arg 0)
3894 'skip-syntax-backward 'skip-syntax-forward)
3895 "w_")
3896 (cons (save-excursion (forward-sexp arg) (point)) (point)))
3897 ;; Otherwise, we're between sexps. Take a step back before jumping
3898 ;; to make sure we'll obey the same precedence no matter which direction
3899 ;; we're going.
3900 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
3901 (cons (save-excursion (forward-sexp arg) (point))
3902 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
3903 (not (zerop (funcall (if (> arg 0)
3904 'skip-syntax-forward
3905 'skip-syntax-backward)
3906 ".")))))
3907 (point)))))
3908 arg 'special))
3910 (defun transpose-lines (arg)
3911 "Exchange current line and previous line, leaving point after both.
3912 With argument ARG, takes previous line and moves it past ARG lines.
3913 With argument 0, interchanges line point is in with line mark is in."
3914 (interactive "*p")
3915 (transpose-subr (function
3916 (lambda (arg)
3917 (if (> arg 0)
3918 (progn
3919 ;; Move forward over ARG lines,
3920 ;; but create newlines if necessary.
3921 (setq arg (forward-line arg))
3923 (setq arg (1+ arg)))
3924 (if (> arg 0)
3925 (newline arg)))
3926 (forward-line arg))))
3927 arg))
3929 (defun transpose-subr (mover arg &optional special)
3930 (let ((aux (if special mover
3931 (lambda (x)
3932 (cons (progn (funcall mover x) (point))
3933 (progn (funcall mover (- x)) (point))))))
3934 pos1 pos2)
3935 (cond
3936 ((= arg 0)
3937 (save-excursion
3938 (setq pos1 (funcall aux 1))
3939 (goto-char (mark))
3940 (setq pos2 (funcall aux 1))
3941 (transpose-subr-1 pos1 pos2))
3942 (exchange-point-and-mark))
3943 ((> arg 0)
3944 (setq pos1 (funcall aux -1))
3945 (setq pos2 (funcall aux arg))
3946 (transpose-subr-1 pos1 pos2)
3947 (goto-char (car pos2)))
3948 (t
3949 (setq pos1 (funcall aux -1))
3950 (goto-char (car pos1))
3951 (setq pos2 (funcall aux arg))
3952 (transpose-subr-1 pos1 pos2)))))
3954 (defun transpose-subr-1 (pos1 pos2)
3955 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
3956 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
3957 (when (> (car pos1) (car pos2))
3958 (let ((swap pos1))
3959 (setq pos1 pos2 pos2 swap)))
3960 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
3961 (atomic-change-group
3962 (let (word2)
3963 ;; FIXME: We first delete the two pieces of text, so markers that
3964 ;; used to point to after the text end up pointing to before it :-(
3965 (setq word2 (delete-and-extract-region (car pos2) (cdr pos2)))
3966 (goto-char (car pos2))
3967 (insert (delete-and-extract-region (car pos1) (cdr pos1)))
3968 (goto-char (car pos1))
3969 (insert word2))))
3970 \f
3971 (defun backward-word (&optional arg)
3972 "Move backward until encountering the beginning of a word.
3973 With argument, do this that many times."
3974 (interactive "p")
3975 (forward-word (- (or arg 1))))
3977 (defun mark-word (&optional arg allow-extend)
3978 "Set mark ARG words away from point.
3980 move to with the same argument.
3981 Interactively, if this command is repeated
3982 or (in Transient Mark mode) if the mark is active,
3983 it marks the next ARG words after the ones already marked."
3985 (cond ((and allow-extend
3986 (or (and (eq last-command this-command) (mark t))
3987 (and transient-mark-mode mark-active)))
3988 (setq arg (if arg (prefix-numeric-value arg)
3989 (if (< (mark) (point)) -1 1)))
3990 (set-mark
3991 (save-excursion
3992 (goto-char (mark))
3993 (forward-word arg)
3994 (point))))
3995 (t
3996 (push-mark
3997 (save-excursion
3998 (forward-word (prefix-numeric-value arg))
3999 (point))
4000 nil t))))
4002 (defun kill-word (arg)
4003 "Kill characters forward until encountering the end of a word.
4004 With argument, do this that many times."
4005 (interactive "p")
4006 (kill-region (point) (progn (forward-word arg) (point))))
4008 (defun backward-kill-word (arg)
4009 "Kill characters backward until encountering the end of a word.
4010 With argument, do this that many times."
4011 (interactive "p")
4012 (kill-word (- arg)))
4014 (defun current-word (&optional strict really-word)
4015 "Return the symbol or word that point is on (or a nearby one) as a string.
4016 The return value includes no text properties.
4017 If optional arg STRICT is non-nil, return nil unless point is within
4018 or adjacent to a symbol or word. In all cases the value can be nil
4019 if there is no word nearby.
4020 The function, belying its name, normally finds a symbol.
4021 If optional arg REALLY-WORD is non-nil, it finds just a word."
4022 (save-excursion
4023 (let* ((oldpoint (point)) (start (point)) (end (point))
4024 (syntaxes (if really-word "w" "w_"))
4025 (not-syntaxes (concat "^" syntaxes)))
4026 (skip-syntax-backward syntaxes) (setq start (point))
4027 (goto-char oldpoint)
4028 (skip-syntax-forward syntaxes) (setq end (point))
4029 (when (and (eq start oldpoint) (eq end oldpoint)
4030 ;; Point is neither within nor adjacent to a word.
4031 (not strict))
4032 ;; Look for preceding word in same line.
4033 (skip-syntax-backward not-syntaxes
4034 (save-excursion (beginning-of-line)
4035 (point)))
4036 (if (bolp)
4037 ;; No preceding word in same line.
4038 ;; Look for following word in same line.
4039 (progn
4040 (skip-syntax-forward not-syntaxes
4041 (save-excursion (end-of-line)
4042 (point)))
4043 (setq start (point))
4044 (skip-syntax-forward syntaxes)
4045 (setq end (point)))
4046 (setq end (point))
4047 (skip-syntax-backward syntaxes)
4048 (setq start (point))))
4049 ;; If we found something nonempty, return it as a string.
4050 (unless (= start end)
4051 (buffer-substring-no-properties start end)))))
4052 \f
4053 (defcustom fill-prefix nil
4054 "*String for filling to insert at front of new line, or nil for none."
4055 :type '(choice (const :tag "None" nil)
4056 string)
4057 :group 'fill)
4058 (make-variable-buffer-local 'fill-prefix)
4060 (defcustom auto-fill-inhibit-regexp nil
4061 "*Regexp to match lines which should not be auto-filled."
4062 :type '(choice (const :tag "None" nil)
4063 regexp)
4064 :group 'fill)
4066 (defvar comment-line-break-function 'comment-indent-new-line
4067 "*Mode-specific function which line breaks and continues a comment.
4069 This function is only called during auto-filling of a comment section.
4070 The function should take a single optional argument, which is a flag
4071 indicating whether it should use soft newlines.")
4073 ;; This function is used as the auto-fill-function of a buffer
4074 ;; when Auto-Fill mode is enabled.
4075 ;; It returns t if it really did any work.
4076 ;; (Actually some major modes use a different auto-fill function,
4077 ;; but this one is the default one.)
4078 (defun do-auto-fill ()
4079 (let (fc justify give-up
4080 (fill-prefix fill-prefix))
4081 (if (or (not (setq justify (current-justification)))
4082 (null (setq fc (current-fill-column)))
4083 (and (eq justify 'left)
4084 (<= (current-column) fc))
4085 (and auto-fill-inhibit-regexp
4086 (save-excursion (beginning-of-line)
4087 (looking-at auto-fill-inhibit-regexp))))
4088 nil ;; Auto-filling not required
4089 (if (memq justify '(full center right))
4090 (save-excursion (unjustify-current-line)))
4092 ;; Choose a fill-prefix automatically.
4093 (when (and adaptive-fill-mode
4094 (or (null fill-prefix) (string= fill-prefix "")))
4095 (let ((prefix
4096 (fill-context-prefix
4097 (save-excursion (backward-paragraph 1) (point))
4098 (save-excursion (forward-paragraph 1) (point)))))
4099 (and prefix (not (equal prefix ""))
4100 ;; Use auto-indentation rather than a guessed empty prefix.
4101 (not (and fill-indent-according-to-mode
4103 (setq fill-prefix prefix))))
4105 (while (and (not give-up) (> (current-column) fc))
4106 ;; Determine where to split the line.
4107 (let* (after-prefix
4108 (fill-point
4109 (save-excursion
4110 (beginning-of-line)
4111 (setq after-prefix (point))
4112 (and fill-prefix
4113 (looking-at (regexp-quote fill-prefix))
4114 (setq after-prefix (match-end 0)))
4115 (move-to-column (1+ fc))
4116 (fill-move-to-break-point after-prefix)
4117 (point))))
4119 ;; See whether the place we found is any good.
4120 (if (save-excursion
4121 (goto-char fill-point)
4122 (or (bolp)
4123 ;; There is no use breaking at end of line.
4124 (save-excursion (skip-chars-forward " ") (eolp))
4125 ;; It is futile to split at the end of the prefix
4126 ;; since we would just insert the prefix again.
4127 (and after-prefix (<= (point) after-prefix))
4128 ;; Don't split right after a comment starter
4129 ;; since we would just make another comment starter.
4130 (and comment-start-skip
4131 (let ((limit (point)))
4132 (beginning-of-line)
4133 (and (re-search-forward comment-start-skip
4134 limit t)
4135 (eq (point) limit))))))
4136 ;; No good place to break => stop trying.
4137 (setq give-up t)
4138 ;; Ok, we have a useful place to break the line. Do it.
4139 (let ((prev-column (current-column)))
4140 ;; If point is at the fill-point, do not `save-excursion'.
4141 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
4142 ;; point will end up before it rather than after it.
4143 (if (save-excursion
4145 (= (point) fill-point))
4146 (funcall comment-line-break-function t)
4147 (save-excursion
4148 (goto-char fill-point)
4149 (funcall comment-line-break-function t)))
4150 ;; Now do justification, if required
4151 (if (not (eq justify 'left))
4152 (save-excursion
4153 (end-of-line 0)
4154 (justify-current-line justify nil t)))
4155 ;; If making the new line didn't reduce the hpos of
4156 ;; the end of the line, then give up now;
4157 ;; trying again will not help.
4158 (if (>= (current-column) prev-column)
4159 (setq give-up t))))))
4160 ;; Justify last line.
4161 (justify-current-line justify t t)
4162 t)))
4164 (defvar normal-auto-fill-function 'do-auto-fill
4165 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
4166 Some major modes set this.")
4168 (put 'auto-fill-function :minor-mode-function 'auto-fill-mode)
4169 ;; FIXME: turn into a proper minor mode.
4170 ;; Add a global minor mode version of it.
4171 (defun auto-fill-mode (&optional arg)
4172 "Toggle Auto Fill mode.
4173 With arg, turn Auto Fill mode on if and only if arg is positive.
4174 In Auto Fill mode, inserting a space at a column beyond `current-fill-column'
4175 automatically breaks the line at a previous space.
4177 The value of `normal-auto-fill-function' specifies the function to use
4178 for `auto-fill-function' when turning Auto Fill mode on."
4179 (interactive "P")
4180 (prog1 (setq auto-fill-function
4181 (if (if (null arg)
4182 (not auto-fill-function)
4183 (> (prefix-numeric-value arg) 0))
4184 normal-auto-fill-function
4185 nil))
4186 (force-mode-line-update)))
4188 ;; This holds a document string used to document auto-fill-mode.
4189 (defun auto-fill-function ()
4190 "Automatically break line at a previous space, in insertion of text."
4191 nil)
4193 (defun turn-on-auto-fill ()
4194 "Unconditionally turn on Auto Fill mode."
4195 (auto-fill-mode 1))
4197 (defun turn-off-auto-fill ()
4198 "Unconditionally turn off Auto Fill mode."
4199 (auto-fill-mode -1))
4201 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
4203 (defun set-fill-column (arg)
4204 "Set `fill-column' to specified argument.
4207 (interactive "P")
4208 (if (consp arg)
4209 (setq arg (current-column)))
4210 (if (not (integerp arg))
4211 ;; Disallow missing argument; it's probably a typo for C-x C-f.
4212 (error "set-fill-column requires an explicit argument")
4213 (message "Fill column set to %d (was %d)" arg fill-column)
4214 (setq fill-column arg)))
4215 \f
4216 (defun set-selective-display (arg)
4217 "Set `selective-display' to ARG; clear it if no arg.
4218 When the value of `selective-display' is a number > 0,
4219 lines whose indentation is >= that value are not displayed.
4220 The variable `selective-display' has a separate value for each buffer."
4221 (interactive "P")
4222 (if (eq selective-display t)
4223 (error "selective-display already in use for marked lines"))
4224 (let ((current-vpos
4225 (save-restriction
4226 (narrow-to-region (point-min) (point))
4227 (goto-char (window-start))
4228 (vertical-motion (window-height)))))
4229 (setq selective-display
4230 (and arg (prefix-numeric-value arg)))
4231 (recenter current-vpos))
4232 (set-window-start (selected-window) (window-start (selected-window)))
4233 (princ "selective-display set to " t)
4234 (prin1 selective-display t)
4235 (princ "." t))
4237 (defvaralias 'indicate-unused-lines 'indicate-empty-lines)
4238 (defvaralias 'default-indicate-unused-lines 'default-indicate-empty-lines)
4240 (defun toggle-truncate-lines (arg)
4241 "Toggle whether to fold or truncate long lines on the screen.
4242 With arg, truncate long lines iff arg is positive.
4243 Note that in side-by-side windows, truncation is always enabled."
4244 (interactive "P")
4245 (setq truncate-lines
4246 (if (null arg)
4247 (not truncate-lines)
4248 (> (prefix-numeric-value arg) 0)))
4249 (force-mode-line-update)
4250 (unless truncate-lines
4251 (let ((buffer (current-buffer)))
4252 (walk-windows (lambda (window)
4253 (if (eq buffer (window-buffer window))
4254 (set-window-hscroll window 0)))
4255 nil t)))
4256 (message "Truncate long lines %s"
4257 (if truncate-lines "enabled" "disabled")))
4259 (defvar overwrite-mode-textual " Ovwrt"
4260 "The string displayed in the mode line when in overwrite mode.")
4261 (defvar overwrite-mode-binary " Bin Ovwrt"
4262 "The string displayed in the mode line when in binary overwrite mode.")
4264 (defun overwrite-mode (arg)
4265 "Toggle overwrite mode.
4266 With arg, turn overwrite mode on iff arg is positive.
4267 In overwrite mode, printing characters typed in replace existing text
4268 on a one-for-one basis, rather than pushing it to the right. At the
4269 end of a line, such characters extend the line. Before a tab,
4270 such characters insert until the tab is filled in.
4272 is supposed to make it easier to insert characters when necessary."
4273 (interactive "P")
4274 (setq overwrite-mode
4275 (if (if (null arg) (not overwrite-mode)
4276 (> (prefix-numeric-value arg) 0))
4277 'overwrite-mode-textual))
4278 (force-mode-line-update))
4280 (defun binary-overwrite-mode (arg)
4281 "Toggle binary overwrite mode.
4282 With arg, turn binary overwrite mode on iff arg is positive.
4283 In binary overwrite mode, printing characters typed in replace
4284 existing text. Newlines are not treated specially, so typing at the
4285 end of a line joins the line to the next, with the typed character
4286 between them. Typing before a tab character simply replaces the tab
4287 with the character typed.
4289 typing characters do.
4291 Note that binary overwrite mode is not its own minor mode; it is a
4292 specialization of overwrite mode, entered by setting the
4293 `overwrite-mode' variable to `overwrite-mode-binary'."
4294 (interactive "P")
4295 (setq overwrite-mode
4296 (if (if (null arg)
4297 (not (eq overwrite-mode 'overwrite-mode-binary))
4298 (> (prefix-numeric-value arg) 0))
4299 'overwrite-mode-binary))
4300 (force-mode-line-update))
4302 (define-minor-mode line-number-mode
4303 "Toggle Line Number mode.
4304 With arg, turn Line Number mode on iff arg is positive.
4305 When Line Number mode is enabled, the line number appears
4306 in the mode line.
4308 Line numbers do not appear for very large buffers and buffers
4309 with very long lines; see variables `line-number-display-limit'
4310 and `line-number-display-limit-width'."
4311 :init-value t :global t :group 'editing-basics)
4313 (define-minor-mode column-number-mode
4314 "Toggle Column Number mode.
4315 With arg, turn Column Number mode on iff arg is positive.
4316 When Column Number mode is enabled, the column number appears
4317 in the mode line."
4318 :global t :group 'editing-basics)
4320 (define-minor-mode size-indication-mode
4321 "Toggle Size Indication mode.
4322 With arg, turn Size Indication mode on iff arg is positive. When
4323 Size Indication mode is enabled, the size of the accessible part
4324 of the buffer appears in the mode line."
4325 :global t :group 'editing-basics)
4326 \f
4327 (defgroup paren-blinking nil
4328 "Blinking matching of parens and expressions."
4329 :prefix "blink-matching-"
4330 :group 'paren-matching)
4332 (defcustom blink-matching-paren t
4333 "*Non-nil means show matching open-paren when close-paren is inserted."
4334 :type 'boolean
4335 :group 'paren-blinking)
4337 (defcustom blink-matching-paren-on-screen t
4338 "*Non-nil means show matching open-paren when it is on screen.
4339 If nil, means don't show it (but the open-paren can still be shown
4340 when it is off screen).
4342 This variable has no effect if `blink-matching-paren' is nil.
4343 \(In that case, the open-paren is never shown.)
4344 It is also ignored if `show-paren-mode' is enabled."
4345 :type 'boolean
4346 :group 'paren-blinking)
4348 (defcustom blink-matching-paren-distance (* 25 1024)
4349 "*If non-nil, maximum distance to search backwards for matching open-paren.
4350 If nil, search stops at the beginning of the accessible portion of the buffer."
4351 :type '(choice (const nil) integer)
4352 :group 'paren-blinking)
4354 (defcustom blink-matching-delay 1
4355 "*Time in seconds to delay after showing a matching paren."
4356 :type 'number
4357 :group 'paren-blinking)
4359 (defcustom blink-matching-paren-dont-ignore-comments nil
4360 "*nil means `blink-matching-paren' ignores comments.
4361 More precisely, when looking for the matching parenthesis,
4362 it skips the contents of comments that end before point."
4363 :type 'boolean
4364 :group 'paren-blinking)
4366 (defun blink-matching-open ()
4367 "Move cursor momentarily to the beginning of the sexp before point."
4368 (interactive)
4369 (when (and (> (point) (point-min))
4370 blink-matching-paren
4371 ;; Verify an even number of quoting characters precede the close.
4372 (= 1 (logand 1 (- (point)
4373 (save-excursion
4374 (forward-char -1)
4376 (point))))))
4377 (let* ((oldpos (point))
4378 blinkpos
4379 message-log-max ; Don't log messages about paren matching.
4380 matching-paren
4381 open-paren-line-string)
4382 (save-excursion
4383 (save-restriction
4384 (if blink-matching-paren-distance
4385 (narrow-to-region (max (point-min)
4386 (- (point) blink-matching-paren-distance))
4387 oldpos))
4388 (condition-case ()
4389 (let ((parse-sexp-ignore-comments
4390 (and parse-sexp-ignore-comments
4391 (not blink-matching-paren-dont-ignore-comments))))
4392 (setq blinkpos (scan-sexps oldpos -1)))
4393 (error nil)))
4394 (and blinkpos
4395 ;; Not syntax '$'.
4396 (not (eq (syntax-class (syntax-after blinkpos)) 8))
4397 (setq matching-paren
4398 (let ((syntax (syntax-after blinkpos)))
4399 (and (consp syntax)
4400 (eq (syntax-class syntax) 4)
4401 (cdr syntax)))))
4402 (cond
4403 ((not (or (eq matching-paren (char-before oldpos))
4404 ;; The cdr might hold a new paren-class info rather than
4405 ;; a matching-char info, in which case the two CDRs
4406 ;; should match.
4407 (eq matching-paren (cdr (syntax-after (1- oldpos))))))
4408 (message "Mismatched parentheses"))
4409 ((not blinkpos)
4410 (if (not blink-matching-paren-distance)
4411 (message "Unmatched parenthesis")))
4412 ((pos-visible-in-window-p blinkpos)
4413 ;; Matching open within window, temporarily move to blinkpos but only
4414 ;; if `blink-matching-paren-on-screen' is non-nil.
4415 (and blink-matching-paren-on-screen
4416 (not show-paren-mode)
4417 (save-excursion
4418 (goto-char blinkpos)
4419 (sit-for blink-matching-delay))))
4420 (t
4421 (save-excursion
4422 (goto-char blinkpos)
4423 (setq open-paren-line-string
4424 ;; Show what precedes the open in its line, if anything.
4425 (if (save-excursion
4427 (not (bolp)))
4428 (buffer-substring (line-beginning-position)
4429 (1+ blinkpos))
4430 ;; Show what follows the open in its line, if anything.
4431 (if (save-excursion
4432 (forward-char 1)
4434 (not (eolp)))
4435 (buffer-substring blinkpos
4436 (line-end-position))
4437 ;; Otherwise show the previous nonblank line,
4438 ;; if there is one.
4439 (if (save-excursion
4441 (not (bobp)))
4442 (concat
4443 (buffer-substring (progn
4445 (line-beginning-position))
4446 (progn (end-of-line)
4448 (point)))
4449 ;; Replace the newline and other whitespace with `...'.
4450 "..."
4451 (buffer-substring blinkpos (1+ blinkpos)))
4452 ;; There is nothing to show except the char itself.
4453 (buffer-substring blinkpos (1+ blinkpos)))))))
4454 (message "Matches %s"
4455 (substring-no-properties open-paren-line-string))))))))
4457 ;Turned off because it makes dbx bomb out.
4458 (setq blink-paren-function 'blink-matching-open)
4459 \f
4460 ;; This executes C-g typed while Emacs is waiting for a command.
4461 ;; Quitting out of a program does not go through here;
4462 ;; that happens in the QUIT macro at the C code level.
4463 (defun keyboard-quit ()
4464 "Signal a `quit' condition.
4465 During execution of Lisp code, this character causes a quit directly.
4466 At top-level, as an editor command, this simply beeps."
4467 (interactive)
4468 (deactivate-mark)
4469 (if (fboundp 'kmacro-keyboard-quit)
4470 (kmacro-keyboard-quit))
4471 (setq defining-kbd-macro nil)
4472 (signal 'quit nil))
4474 (defvar buffer-quit-function nil
4477 \(such as cancelling a prefix argument, minibuffer or region) do not apply.")
4479 (defun keyboard-escape-quit ()
4481 This command can exit an interactive command such as `query-replace',
4482 can clear out a prefix argument or a region,
4483 can get out of the minibuffer or other recursive edit,
4484 cancel the use of the current buffer (for special-purpose buffers),
4485 or go back to just one window (by deleting all but the selected window)."
4486 (interactive)
4487 (cond ((eq last-command 'mode-exited) nil)
4488 ((> (minibuffer-depth) 0)
4489 (abort-recursive-edit))
4490 (current-prefix-arg
4491 nil)
4492 ((and transient-mark-mode mark-active)
4493 (deactivate-mark))
4494 ((> (recursion-depth) 0)
4495 (exit-recursive-edit))
4496 (buffer-quit-function
4497 (funcall buffer-quit-function))
4498 ((not (one-window-p t))
4499 (delete-other-windows))
4501 (bury-buffer))))
4503 (defun play-sound-file (file &optional volume device)
4504 "Play sound stored in FILE.
4505 VOLUME and DEVICE correspond to the keywords of the sound
4506 specification for `play-sound'."
4507 (interactive "fPlay sound file: ")
4508 (let ((sound (list :file file)))
4509 (if volume
4510 (plist-put sound :volume volume))
4511 (if device
4512 (plist-put sound :device device))
4513 (push 'sound sound)
4514 (play-sound sound)))
4516 \f
4517 (defcustom read-mail-command 'rmail
4518 "*Your preference for a mail reading package.
4519 This is used by some keybindings which support reading mail.
4520 See also `mail-user-agent' concerning sending mail."
4521 :type '(choice (function-item rmail)
4522 (function-item gnus)
4523 (function-item mh-rmail)
4524 (function :tag "Other"))
4525 :version "21.1"
4526 :group 'mail)
4528 (defcustom mail-user-agent 'sendmail-user-agent
4529 "*Your preference for a mail composition package.
4530 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
4531 outgoing email message. This variable lets you specify which
4532 mail-sending package you prefer.
4534 Valid values include:
4536 `sendmail-user-agent' -- use the default Emacs Mail package.
4537 See Info node `(emacs)Sending Mail'.
4538 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
4539 See Info node `(mh-e)'.
4540 `message-user-agent' -- use the Gnus Message package.
4541 See Info node `(message)'.
4542 `gnus-user-agent' -- like `message-user-agent', but with Gnus
4543 paraphernalia, particularly the Gcc: header for
4544 archiving.
4546 Additional valid symbols may be available; check with the author of
4547 your package for details. The function should return non-nil if it
4548 succeeds.
4550 See also `read-mail-command' concerning reading mail."
4551 :type '(radio (function-item :tag "Default Emacs mail"
4553 sendmail-user-agent)
4554 (function-item :tag "Emacs interface to MH"
4556 mh-e-user-agent)
4557 (function-item :tag "Gnus Message package"
4559 message-user-agent)
4560 (function-item :tag "Gnus Message with full Gnus features"
4562 gnus-user-agent)
4563 (function :tag "Other"))
4564 :group 'mail)
4566 (define-mail-user-agent 'sendmail-user-agent
4567 'sendmail-user-agent-compose
4568 'mail-send-and-exit)
4570 (defun rfc822-goto-eoh ()
4571 ;; Go to header delimiter line in a mail message, following RFC822 rules
4572 (goto-char (point-min))
4573 (when (re-search-forward
4575 (goto-char (match-beginning 0))))
4577 (defun sendmail-user-agent-compose (&optional to subject other-headers continue
4578 switch-function yank-action
4579 send-actions)
4580 (if switch-function
4581 (let ((special-display-buffer-names nil)
4582 (special-display-regexps nil)
4583 (same-window-buffer-names nil)
4584 (same-window-regexps nil))
4585 (funcall switch-function "*mail*")))
4586 (let ((cc (cdr (assoc-string "cc" other-headers t)))
4587 (in-reply-to (cdr (assoc-string "in-reply-to" other-headers t)))
4588 (body (cdr (assoc-string "body" other-headers t))))
4589 (or (mail continue to subject in-reply-to cc yank-action send-actions)
4590 continue
4591 (error "Message aborted"))
4592 (save-excursion
4593 (rfc822-goto-eoh)
4594 (while other-headers
4595 (unless (member-ignore-case (car (car other-headers))
4596 '("in-reply-to" "cc" "body"))
4597 (insert (car (car other-headers)) ": "
4598 (cdr (car other-headers))
4600 (setq other-headers (cdr other-headers)))
4601 (when body
4602 (forward-line 1)
4603 (insert body))
4604 t)))
4606 (defun compose-mail (&optional to subject other-headers continue
4607 switch-function yank-action send-actions)
4608 "Start composing a mail message to send.
4609 This uses the user's chosen mail composition package
4610 as selected with the variable `mail-user-agent'.
4611 The optional arguments TO and SUBJECT specify recipients
4612 and the initial Subject field, respectively.
4614 OTHER-HEADERS is an alist specifying additional
4615 header fields. Elements look like (HEADER . VALUE) where both
4616 HEADER and VALUE are strings.
4618 CONTINUE, if non-nil, says to continue editing a message already
4619 being composed.
4621 SWITCH-FUNCTION, if non-nil, is a function to use to
4622 switch to and display the buffer used for mail composition.
4624 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
4625 to insert the raw text of the message being replied to.
4626 It has the form (FUNCTION . ARGS). The user agent will apply
4627 FUNCTION to ARGS, to insert the raw text of the original message.
4628 \(The user agent will also run `mail-citation-hook', *after* the
4629 original text has been inserted in this way.)
4631 SEND-ACTIONS is a list of actions to call when the message is sent.
4632 Each action has the form (FUNCTION . ARGS)."
4633 (interactive
4634 (list nil nil nil current-prefix-arg))
4635 (let ((function (get mail-user-agent 'composefunc)))
4636 (funcall function to subject other-headers continue
4637 switch-function yank-action send-actions)))
4639 (defun compose-mail-other-window (&optional to subject other-headers continue
4640 yank-action send-actions)
4642 (interactive
4643 (list nil nil nil current-prefix-arg))
4644 (compose-mail to subject other-headers continue
4645 'switch-to-buffer-other-window yank-action send-actions))
4648 (defun compose-mail-other-frame (&optional to subject other-headers continue
4649 yank-action send-actions)
4651 (interactive
4652 (list nil nil nil current-prefix-arg))
4653 (compose-mail to subject other-headers continue
4654 'switch-to-buffer-other-frame yank-action send-actions))
4655 \f
4656 (defvar set-variable-value-history nil
4657 "History of values entered with `set-variable'.")
4659 (defun set-variable (variable value &optional make-local)
4660 "Set VARIABLE to VALUE. VALUE is a Lisp object.
4661 VARIABLE should be a user option variable name, a Lisp variable
4662 meant to be customized by users. You should enter VALUE in Lisp syntax,
4663 so if you want VALUE to be a string, you must surround it with doublequotes.
4664 VALUE is used literally, not evaluated.
4666 If VARIABLE has a `variable-interactive' property, that is used as if
4667 it were the arg to `interactive' (which see) to interactively read VALUE.
4669 If VARIABLE has been defined with `defcustom', then the type information
4670 in the definition is used to check that VALUE is valid.
4672 With a prefix argument, set VARIABLE to VALUE buffer-locally."
4673 (interactive
4674 (let* ((default-var (variable-at-point))
4675 (var (if (user-variable-p default-var)
4676 (read-variable (format "Set variable (default %s): " default-var)
4677 default-var)
4678 (read-variable "Set variable: ")))
4679 (minibuffer-help-form '(describe-variable var))
4680 (prop (get var 'variable-interactive))
4681 (obsolete (car (get var 'byte-obsolete-variable)))
4682 (prompt (format "Set %s %s to value: " var
4683 (cond ((local-variable-p var)
4684 "(buffer-local)")
4685 ((or current-prefix-arg
4686 (local-variable-if-set-p var))
4687 "buffer-locally")
4688 (t "globally"))))
4689 (val (progn
4690 (when obsolete
4691 (message (concat "`%S' is obsolete; "
4692 (if (symbolp obsolete) "use `%S' instead" "%s"))
4693 var obsolete)
4694 (sit-for 3))
4695 (if prop
4696 ;; Use VAR's `variable-interactive' property
4697 ;; as an interactive spec for prompting.
4698 (call-interactively `(lambda (arg)
4699 (interactive ,prop)
4700 arg))
4701 (read
4702 (read-string prompt nil
4703 'set-variable-value-history
4704 (format "%S" (symbol-value var))))))))
4705 (list var val current-prefix-arg)))
4707 (and (custom-variable-p variable)
4708 (not (get variable 'custom-type))
4709 (custom-load-symbol variable))
4710 (let ((type (get variable 'custom-type)))
4711 (when type
4712 ;; Match with custom type.
4713 (require 'cus-edit)
4714 (setq type (widget-convert type))
4715 (unless (widget-apply type :match value)
4716 (error "Value `%S' does not match type %S of %S"
4717 value (car type) variable))))
4719 (if make-local
4720 (make-local-variable variable))
4722 (set variable value)
4724 ;; Force a thorough redisplay for the case that the variable
4725 ;; has an effect on the display, like `tab-width' has.
4726 (force-mode-line-update))
4727 \f
4728 ;; Define the major mode for lists of completions.
4730 (defvar completion-list-mode-map nil
4731 "Local map for completion list buffers.")
4732 (or completion-list-mode-map
4733 (let ((map (make-sparse-keymap)))
4734 (define-key map [mouse-2] 'mouse-choose-completion)
4735 (define-key map [follow-link] 'mouse-face)
4736 (define-key map [down-mouse-2] nil)
4737 (define-key map "\C-m" 'choose-completion)
4738 (define-key map "\e\e\e" 'delete-completion-window)
4739 (define-key map [left] 'previous-completion)
4740 (define-key map [right] 'next-completion)
4741 (setq completion-list-mode-map map)))
4743 ;; Completion mode is suitable only for specially formatted data.
4744 (put 'completion-list-mode 'mode-class 'special)
4746 (defvar completion-reference-buffer nil
4747 "Record the buffer that was current when the completion list was requested.
4748 This is a local variable in the completion list buffer.
4749 Initial value is nil to avoid some compiler warnings.")
4751 (defvar completion-no-auto-exit nil
4752 "Non-nil means `choose-completion-string' should never exit the minibuffer.
4753 This also applies to other functions such as `choose-completion'
4754 and `mouse-choose-completion'.")
4756 (defvar completion-base-size nil
4757 "Number of chars at beginning of minibuffer not involved in completion.
4758 This is a local variable in the completion list buffer
4759 but it talks about the buffer in `completion-reference-buffer'.
4760 If this is nil, it means to compare text to determine which part
4761 of the tail end of the buffer's text is involved in completion.")
4763 (defun delete-completion-window ()
4764 "Delete the completion list window.
4765 Go to the window from which completion was requested."
4766 (interactive)
4767 (let ((buf completion-reference-buffer))
4768 (if (one-window-p t)
4769 (if (window-dedicated-p (selected-window))
4770 (delete-frame (selected-frame)))
4771 (delete-window (selected-window))
4772 (if (get-buffer-window buf)
4773 (select-window (get-buffer-window buf))))))
4775 (defun previous-completion (n)
4776 "Move to the previous item in the completion list."
4777 (interactive "p")
4778 (next-completion (- n)))
4780 (defun next-completion (n)
4781 "Move to the next item in the completion list.
4782 With prefix argument N, move N items (negative N means move backward)."
4783 (interactive "p")
4784 (let ((beg (point-min)) (end (point-max)))
4785 (while (and (> n 0) (not (eobp)))
4786 ;; If in a completion, move to the end of it.
4787 (when (get-text-property (point) 'mouse-face)
4788 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
4789 ;; Move to start of next one.
4790 (unless (get-text-property (point) 'mouse-face)
4791 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
4792 (setq n (1- n)))
4793 (while (and (< n 0) (not (bobp)))
4794 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
4795 ;; If in a completion, move to the start of it.
4796 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
4797 (goto-char (previous-single-property-change
4798 (point) 'mouse-face nil beg)))
4799 ;; Move to end of the previous completion.
4800 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
4801 (goto-char (previous-single-property-change
4802 (point) 'mouse-face nil beg)))
4803 ;; Move to the start of that one.
4804 (goto-char (previous-single-property-change
4805 (point) 'mouse-face nil beg))
4806 (setq n (1+ n))))))
4808 (defun choose-completion ()
4809 "Choose the completion that point is in or next to."
4810 (interactive)
4811 (let (beg end completion (buffer completion-reference-buffer)
4812 (base-size completion-base-size))
4813 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
4814 (setq end (point) beg (1+ (point))))
4815 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
4816 (setq end (1- (point)) beg (point)))
4817 (if (null beg)
4818 (error "No completion here"))
4819 (setq beg (previous-single-property-change beg 'mouse-face))
4820 (setq end (or (next-single-property-change end 'mouse-face) (point-max)))
4821 (setq completion (buffer-substring-no-properties beg end))
4822 (let ((owindow (selected-window)))
4823 (if (and (one-window-p t 'selected-frame)
4824 (window-dedicated-p (selected-window)))
4825 ;; This is a special buffer's frame
4826 (iconify-frame (selected-frame))
4827 (or (window-dedicated-p (selected-window))
4828 (bury-buffer)))
4829 (select-window owindow))
4830 (choose-completion-string completion buffer base-size)))
4832 ;; Delete the longest partial match for STRING
4833 ;; that can be found before POINT.
4834 (defun choose-completion-delete-max-match (string)
4835 (let ((opoint (point))
4836 len)
4837 ;; Try moving back by the length of the string.
4838 (goto-char (max (- (point) (length string))
4839 (minibuffer-prompt-end)))
4840 ;; See how far back we were actually able to move. That is the
4841 ;; upper bound on how much we can match and delete.
4842 (setq len (- opoint (point)))
4843 (if completion-ignore-case
4844 (setq string (downcase string)))
4845 (while (and (> len 0)
4846 (let ((tail (buffer-substring (point) opoint)))
4847 (if completion-ignore-case
4848 (setq tail (downcase tail)))
4849 (not (string= tail (substring string 0 len)))))
4850 (setq len (1- len))
4851 (forward-char 1))
4852 (delete-char len)))
4854 (defvar choose-completion-string-functions nil
4855 "Functions that may override the normal insertion of a completion choice.
4856 These functions are called in order with four arguments:
4857 CHOICE - the string to insert in the buffer,
4858 BUFFER - the buffer in which the choice should be inserted,
4859 MINI-P - non-nil iff BUFFER is a minibuffer, and
4860 BASE-SIZE - the number of characters in BUFFER before
4861 the string being completed.
4863 If a function in the list returns non-nil, that function is supposed
4864 to have inserted the CHOICE in the BUFFER, and possibly exited
4865 the minibuffer; no further functions will be called.
4867 If all functions in the list return nil, that means to use
4868 the default method of inserting the completion in BUFFER.")
4870 (defun choose-completion-string (choice &optional buffer base-size)
4871 "Switch to BUFFER and insert the completion choice CHOICE.
4872 BASE-SIZE, if non-nil, says how many characters of BUFFER's text
4873 to keep. If it is nil, we call `choose-completion-delete-max-match'
4874 to decide what to delete."
4876 ;; If BUFFER is the minibuffer, exit the minibuffer
4877 ;; unless it is reading a file name and CHOICE is a directory,
4878 ;; or completion-no-auto-exit is non-nil.
4880 (let* ((buffer (or buffer completion-reference-buffer))
4881 (mini-p (minibufferp buffer)))
4882 ;; If BUFFER is a minibuffer, barf unless it's the currently
4883 ;; active minibuffer.
4884 (if (and mini-p
4885 (or (not (active-minibuffer-window))
4886 (not (equal buffer
4887 (window-buffer (active-minibuffer-window))))))
4888 (error "Minibuffer is not active for completion")
4889 ;; Set buffer so buffer-local choose-completion-string-functions works.
4890 (set-buffer buffer)
4891 (unless (run-hook-with-args-until-success
4892 'choose-completion-string-functions
4893 choice buffer mini-p base-size)
4894 ;; Insert the completion into the buffer where it was requested.
4895 (if base-size
4896 (delete-region (+ base-size (if mini-p
4897 (minibuffer-prompt-end)
4898 (point-min)))
4899 (point))
4900 (choose-completion-delete-max-match choice))
4901 (insert choice)
4902 (remove-text-properties (- (point) (length choice)) (point)
4903 '(mouse-face nil))
4904 ;; Update point in the window that BUFFER is showing in.
4905 (let ((window (get-buffer-window buffer t)))
4906 (set-window-point window (point)))
4907 ;; If completing for the minibuffer, exit it with this choice.
4908 (and (not completion-no-auto-exit)
4909 (equal buffer (window-buffer (minibuffer-window)))
4910 minibuffer-completion-table
4911 ;; If this is reading a file name, and the file name chosen
4912 ;; is a directory, don't exit the minibuffer.
4913 (if (and (eq minibuffer-completion-table 'read-file-name-internal)
4914 (file-directory-p (field-string (point-max))))
4915 (let ((mini (active-minibuffer-window)))
4916 (select-window mini)
4917 (when minibuffer-auto-raise
4918 (raise-frame (window-frame mini))))
4919 (exit-minibuffer)))))))
4921 (defun completion-list-mode ()
4922 "Major mode for buffers showing lists of possible completions.
4924 to select the completion near point.
4926 with the mouse."
4927 (interactive)
4928 (kill-all-local-variables)
4929 (use-local-map completion-list-mode-map)
4930 (setq mode-name "Completion List")
4931 (setq major-mode 'completion-list-mode)
4932 (make-local-variable 'completion-base-size)
4933 (setq completion-base-size nil)
4934 (run-mode-hooks 'completion-list-mode-hook))
4936 (defun completion-list-mode-finish ()
4937 "Finish setup of the completions buffer.
4938 Called from `temp-buffer-show-hook'."
4939 (when (eq major-mode 'completion-list-mode)
4940 (toggle-read-only 1)))
4942 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
4944 (defvar completion-setup-hook nil
4945 "Normal hook run at the end of setting up a completion list buffer.
4946 When this hook is run, the current buffer is the one in which the
4947 command to display the completion list buffer was run.
4948 The completion list buffer is available as the value of `standard-output'.
4949 The common prefix substring for completion may be available as the
4950 value of `completion-common-substring'. See also `display-completion-list'.")
4953 ;; Variables and faces used in `completion-setup-function'.
4955 (defface completions-first-difference
4956 '((t (:inherit bold)))
4957 "Face put on the first uncommon character in completions in *Completions* buffer."
4958 :group 'completion)
4960 (defface completions-common-part
4961 '((t (:inherit default)))
4962 "Face put on the common prefix substring in completions in *Completions* buffer.
4963 The idea of `completions-common-part' is that you can use it to
4964 make the common parts less visible than normal, so that the rest
4965 of the differing parts is, by contrast, slightly highlighted."
4966 :group 'completion)
4968 ;; This is for packages that need to bind it to a non-default regexp
4969 ;; in order to make the first-differing character highlight work
4970 ;; to their liking
4971 (defvar completion-root-regexp "^/"
4972 "Regexp to use in `completion-setup-function' to find the root directory.")
4974 (defvar completion-common-substring nil
4975 "Common prefix substring to use in `completion-setup-function' to put faces.
4976 The value is set by `display-completion-list' during running `completion-setup-hook'.
4978 To put faces `completions-first-difference' and `completions-common-part'
4979 in the `*Completions*' buffer, the common prefix substring in completions
4980 is needed as a hint. (The minibuffer is a special case. The content
4981 of the minibuffer before point is always the common substring.)")
4983 ;; This function goes in completion-setup-hook, so that it is called
4984 ;; after the text of the completion list buffer is written.
4985 (defun completion-setup-function ()
4986 (let* ((mainbuf (current-buffer))
4987 (mbuf-contents (minibuffer-completion-contents))
4988 common-string-length)
4989 ;; When reading a file name in the minibuffer,
4990 ;; set default-directory in the minibuffer
4991 ;; so it will get copied into the completion list buffer.
4992 (if minibuffer-completing-file-name
4993 (with-current-buffer mainbuf
4994 (setq default-directory (file-name-directory mbuf-contents))))
4995 (with-current-buffer standard-output
4996 (completion-list-mode)
4997 (set (make-local-variable 'completion-reference-buffer) mainbuf)
4998 (setq completion-base-size
4999 (cond
5000 ((and (symbolp minibuffer-completion-table)
5001 (get minibuffer-completion-table 'completion-base-size-function))
5002 ;; To compute base size, a function can use the global value of
5003 ;; completion-common-substring or minibuffer-completion-contents.
5004 (with-current-buffer mainbuf
5005 (funcall (get minibuffer-completion-table
5006 'completion-base-size-function))))
5007 (minibuffer-completing-file-name
5008 ;; For file name completion, use the number of chars before
5009 ;; the start of the file name component at point.
5010 (with-current-buffer mainbuf
5011 (save-excursion
5012 (skip-chars-backward completion-root-regexp)
5013 (- (point) (minibuffer-prompt-end)))))
5014 ;; Otherwise, in minibuffer, the base size is 0.
5015 ((minibufferp mainbuf) 0)))
5016 (setq common-string-length
5017 (cond
5018 (completion-common-substring
5019 (length completion-common-substring))
5020 (completion-base-size
5021 (- (length mbuf-contents) completion-base-size))))
5022 ;; Put faces on first uncommon characters and common parts.
5023 (when (and (integerp common-string-length) (>= common-string-length 0))
5024 (let ((element-start (point-min))
5025 (maxp (point-max))
5026 element-common-end)
5027 (while (and (setq element-start
5028 (next-single-property-change
5029 element-start 'mouse-face))
5030 (< (setq element-common-end
5031 (+ element-start common-string-length))
5032 maxp))
5033 (when (get-char-property element-start 'mouse-face)
5034 (if (and (> common-string-length 0)
5035 (get-char-property (1- element-common-end) 'mouse-face))
5036 (put-text-property element-start element-common-end
5037 'font-lock-face 'completions-common-part))
5038 (if (get-char-property element-common-end 'mouse-face)
5039 (put-text-property element-common-end (1+ element-common-end)
5040 'font-lock-face 'completions-first-difference))))))
5041 ;; Insert help string.
5042 (goto-char (point-min))
5043 (if (display-mouse-p)
5044 (insert (substitute-command-keys
5046 (insert (substitute-command-keys
5050 (add-hook 'completion-setup-hook 'completion-setup-function)
5052 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
5053 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
5055 (defun switch-to-completions ()
5056 "Select the completion list window."
5057 (interactive)
5058 ;; Make sure we have a completions window.
5059 (or (get-buffer-window "*Completions*")
5060 (minibuffer-completion-help))
5061 (let ((window (get-buffer-window "*Completions*")))
5062 (when window
5063 (select-window window)
5064 (goto-char (point-min))
5066 (forward-line 1))))
5067 \f
5068 ;;; Support keyboard commands to turn on various modifiers.
5070 ;; These functions -- which are not commands -- each add one modifier
5071 ;; to the following event.
5073 (defun event-apply-alt-modifier (ignore-prompt)
5076 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
5077 (defun event-apply-super-modifier (ignore-prompt)
5080 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
5081 (defun event-apply-hyper-modifier (ignore-prompt)
5084 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
5085 (defun event-apply-shift-modifier (ignore-prompt)
5088 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
5089 (defun event-apply-control-modifier (ignore-prompt)
5092 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
5093 (defun event-apply-meta-modifier (ignore-prompt)
5096 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
5098 (defun event-apply-modifier (event symbol lshiftby prefix)
5099 "Apply a modifier flag to event EVENT.
5100 SYMBOL is the name of this modifier, as a symbol.
5101 LSHIFTBY is the numeric value of this modifier, in keyboard events.
5102 PREFIX is the string that represents this modifier in an event type symbol."
5103 (if (numberp event)
5104 (cond ((eq symbol 'control)
5105 (if (and (<= (downcase event) ?z)
5106 (>= (downcase event) ?a))
5107 (- (downcase event) ?a -1)
5108 (if (and (<= (downcase event) ?Z)
5109 (>= (downcase event) ?A))
5110 (- (downcase event) ?A -1)
5111 (logior (lsh 1 lshiftby) event))))
5112 ((eq symbol 'shift)
5113 (if (and (<= (downcase event) ?z)
5114 (>= (downcase event) ?a))
5115 (upcase event)
5116 (logior (lsh 1 lshiftby) event)))
5117 (t
5118 (logior (lsh 1 lshiftby) event)))
5119 (if (memq symbol (event-modifiers event))
5120 event
5121 (let ((event-type (if (symbolp event) event (car event))))
5122 (setq event-type (intern (concat prefix (symbol-name event-type))))
5123 (if (symbolp event)
5124 event-type
5125 (cons event-type (cdr event)))))))
5127 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
5128 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
5129 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
5130 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
5131 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
5132 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
5133 \f
5134 ;;;; Keypad support.
5136 ;;; Make the keypad keys act like ordinary typing keys. If people add
5137 ;;; bindings for the function key symbols, then those bindings will
5138 ;;; override these, so this shouldn't interfere with any existing
5139 ;;; bindings.
5141 ;; Also tell read-char how to handle these keys.
5142 (mapc
5143 (lambda (keypad-normal)
5144 (let ((keypad (nth 0 keypad-normal))
5145 (normal (nth 1 keypad-normal)))
5146 (put keypad 'ascii-character normal)
5147 (define-key function-key-map (vector keypad) (vector normal))))
5148 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
5149 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
5150 (kp-space ?\s)
5153 (kp-multiply ?*)
5154 (kp-add ?+)
5155 (kp-separator ?,)
5156 (kp-subtract ?-)
5157 (kp-decimal ?.)
5158 (kp-divide ?/)
5159 (kp-equal ?=)))
5160 \f
5161 ;;;;
5162 ;;;; forking a twin copy of a buffer.
5163 ;;;;
5165 (defvar clone-buffer-hook nil
5166 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
5168 (defun clone-process (process &optional newname)
5169 "Create a twin copy of PROCESS.
5170 If NEWNAME is nil, it defaults to PROCESS' name;
5171 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
5172 If PROCESS is associated with a buffer, the new process will be associated
5173 with the current buffer instead.
5174 Returns nil if PROCESS has already terminated."
5175 (setq newname (or newname (process-name process)))
5177 (setq newname (substring newname 0 (match-beginning 0))))
5178 (when (memq (process-status process) '(run stop open))
5179 (let* ((process-connection-type (process-tty-name process))
5180 (new-process
5181 (if (memq (process-status process) '(open))
5182 (let ((args (process-contact process t)))
5183 (setq args (plist-put args :name newname))
5184 (setq args (plist-put args :buffer
5185 (if (process-buffer process)
5186 (current-buffer))))
5187 (apply 'make-network-process args))
5188 (apply 'start-process newname
5189 (if (process-buffer process) (current-buffer))
5190 (process-command process)))))
5191 (set-process-query-on-exit-flag
5192 new-process (process-query-on-exit-flag process))
5193 (set-process-inherit-coding-system-flag
5194 new-process (process-inherit-coding-system-flag process))
5195 (set-process-filter new-process (process-filter process))
5196 (set-process-sentinel new-process (process-sentinel process))
5197 (set-process-plist new-process (copy-sequence (process-plist process)))
5198 new-process)))
5200 ;; things to maybe add (currently partly covered by `funcall mode'):
5201 ;; - syntax-table
5202 ;; - overlays
5203 (defun clone-buffer (&optional newname display-flag)
5204 "Create and return a twin copy of the current buffer.
5205 Unlike an indirect buffer, the new buffer can be edited
5206 independently of the old one (if it is not read-only).
5207 NEWNAME is the name of the new buffer. It may be modified by
5208 adding or incrementing <N> at the end as necessary to create a
5209 unique buffer name. If nil, it defaults to the name of the
5210 current buffer, with the proper suffix. If DISPLAY-FLAG is
5211 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
5212 clone a file-visiting buffer, or a buffer whose major mode symbol
5213 has a non-nil `no-clone' property, results in an error.
5215 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
5216 current buffer with appropriate suffix. However, if a prefix
5217 argument is given, then the command prompts for NEWNAME in the
5218 minibuffer.
5220 This runs the normal hook `clone-buffer-hook' in the new buffer
5221 after it has been set up properly in other respects."
5222 (interactive
5223 (progn
5224 (if buffer-file-name
5225 (error "Cannot clone a file-visiting buffer"))
5226 (if (get major-mode 'no-clone)
5227 (error "Cannot clone a buffer in %s mode" mode-name))
5228 (list (if current-prefix-arg
5229 (read-buffer "Name of new cloned buffer: " (current-buffer)))
5230 t)))
5231 (if buffer-file-name
5232 (error "Cannot clone a file-visiting buffer"))
5233 (if (get major-mode 'no-clone)
5234 (error "Cannot clone a buffer in %s mode" mode-name))
5235 (setq newname (or newname (buffer-name)))
5237 (setq newname (substring newname 0 (match-beginning 0))))
5238 (let ((buf (current-buffer))
5239 (ptmin (point-min))
5240 (ptmax (point-max))
5241 (pt (point))
5242 (mk (if mark-active (mark t)))
5243 (modified (buffer-modified-p))
5244 (mode major-mode)
5245 (lvars (buffer-local-variables))
5246 (process (get-buffer-process (current-buffer)))
5247 (new (generate-new-buffer (or newname (buffer-name)))))
5248 (save-restriction
5249 (widen)
5250 (with-current-buffer new
5251 (insert-buffer-substring buf)))
5252 (with-current-buffer new
5253 (narrow-to-region ptmin ptmax)
5254 (goto-char pt)
5255 (if mk (set-mark mk))
5256 (set-buffer-modified-p modified)
5258 ;; Clone the old buffer's process, if any.
5259 (when process (clone-process process))
5261 ;; Now set up the major mode.
5262 (funcall mode)
5264 ;; Set up other local variables.
5265 (mapcar (lambda (v)
5266 (condition-case () ;in case var is read-only
5267 (if (symbolp v)
5268 (makunbound v)
5269 (set (make-local-variable (car v)) (cdr v)))
5270 (error nil)))
5271 lvars)
5273 ;; Run any hooks (typically set up by the major mode
5274 ;; for cloning to work properly).
5275 (run-hooks 'clone-buffer-hook))
5276 (if display-flag
5277 ;; Presumably the current buffer is shown in the selected frame, so
5278 ;; we want to display the clone elsewhere.
5279 (let ((same-window-regexps nil)
5280 (same-window-buffer-names))
5281 (pop-to-buffer new)))
5282 new))
5285 (defun clone-indirect-buffer (newname display-flag &optional norecord)
5286 "Create an indirect buffer that is a twin copy of the current buffer.
5288 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
5289 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
5290 or if not called with a prefix arg, NEWNAME defaults to the current
5291 buffer's name. The name is modified by adding a `<N>' suffix to it
5292 or by incrementing the N in an existing suffix.
5294 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
5295 This is always done when called interactively.
5297 Optional third arg NORECORD non-nil means do not put this buffer at the
5298 front of the list of recently selected ones."
5299 (interactive
5300 (progn
5301 (if (get major-mode 'no-clone-indirect)
5302 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
5303 (list (if current-prefix-arg
5304 (read-buffer "Name of indirect buffer: " (current-buffer)))
5305 t)))
5306 (if (get major-mode 'no-clone-indirect)
5307 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
5308 (setq newname (or newname (buffer-name)))
5310 (setq newname (substring newname 0 (match-beginning 0))))
5311 (let* ((name (generate-new-buffer-name newname))
5312 (buffer (make-indirect-buffer (current-buffer) name t)))
5313 (when display-flag
5314 (pop-to-buffer buffer norecord))
5315 buffer))
5318 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
5319 "Like `clone-indirect-buffer' but display in another window."
5320 (interactive
5321 (progn
5322 (if (get major-mode 'no-clone-indirect)
5323 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
5324 (list (if current-prefix-arg
5325 (read-buffer "Name of indirect buffer: " (current-buffer)))
5326 t)))
5327 (let ((pop-up-windows t))
5328 (clone-indirect-buffer newname display-flag norecord)))
5330 \f
5331 ;;; Handling of Backspace and Delete keys.
5333 (defcustom normal-erase-is-backspace
5334 (and (not noninteractive)
5335 (or (memq system-type '(ms-dos windows-nt))
5336 (eq window-system 'mac)
5337 (and (memq window-system '(x))
5338 (fboundp 'x-backspace-delete-keys-p)
5339 (x-backspace-delete-keys-p))
5340 ;; If the terminal Emacs is running on has erase char
5341 ;; set to ^H, use the Backspace key for deleting
5342 ;; backward and, and the Delete key for deleting forward.
5343 (and (null window-system)
5344 (eq tty-erase-char ?\^H))))
5345 "If non-nil, Delete key deletes forward and Backspace key deletes backward.
5347 On window systems, the default value of this option is chosen
5348 according to the keyboard used. If the keyboard has both a Backspace
5349 key and a Delete key, and both are mapped to their usual meanings, the
5350 option's default value is set to t, so that Backspace can be used to
5351 delete backward, and Delete can be used to delete forward.
5353 If not running under a window system, customizing this option accomplishes
5354 a similar effect by mapping C-h, which is usually generated by the
5355 Backspace key, to DEL, and by mapping DEL to C-d via
5356 `keyboard-translate'. The former functionality of C-h is available on
5357 the F1 key. You should probably not use this setting if you don't
5358 have both Backspace, Delete and F1 keys.
5360 Setting this variable with setq doesn't take effect. Programmatically,
5361 call `normal-erase-is-backspace-mode' (which see) instead."
5362 :type 'boolean
5363 :group 'editing-basics
5364 :version "21.1"
5365 :set (lambda (symbol value)
5366 ;; The fboundp is because of a problem with :set when
5367 ;; dumping Emacs. It doesn't really matter.
5368 (if (fboundp 'normal-erase-is-backspace-mode)
5369 (normal-erase-is-backspace-mode (or value 0))
5370 (set-default symbol value))))
5373 (defun normal-erase-is-backspace-mode (&optional arg)
5374 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
5376 With numeric arg, turn the mode on if and only if ARG is positive.
5378 On window systems, when this mode is on, Delete is mapped to C-d and
5379 Backspace is mapped to DEL; when this mode is off, both Delete and
5380 Backspace are mapped to DEL. (The remapping goes via
5381 `function-key-map', so binding Delete or Backspace in the global or
5382 local keymap will override that.)
5384 In addition, on window systems, the bindings of C-Delete, M-Delete,
5385 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
5386 the global keymap in accordance with the functionality of Delete and
5387 Backspace. For example, if Delete is remapped to C-d, which deletes
5388 forward, C-Delete is bound to `kill-word', but if Delete is remapped
5389 to DEL, which deletes backward, C-Delete is bound to
5390 `backward-kill-word'.
5392 If not running on a window system, a similar effect is accomplished by
5393 remapping C-h (normally produced by the Backspace key) and DEL via
5394 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
5395 to C-d; if it's off, the keys are not remapped.
5397 When not running on a window system, and this mode is turned on, the
5398 former functionality of C-h is available on the F1 key. You should
5399 probably not turn on this mode on a text-only terminal if you don't
5400 have both Backspace, Delete and F1 keys.
5402 See also `normal-erase-is-backspace'."
5403 (interactive "P")
5404 (setq normal-erase-is-backspace
5405 (if arg
5406 (> (prefix-numeric-value arg) 0)
5407 (not normal-erase-is-backspace)))
5409 (cond ((or (memq window-system '(x w32 mac pc))
5410 (memq system-type '(ms-dos windows-nt)))
5411 (let ((bindings
5412 `(([C-delete] [C-backspace])
5413 ([M-delete] [M-backspace])
5414 ([C-M-delete] [C-M-backspace])
5415 (,esc-map
5416 [C-delete] [C-backspace])))
5417 (old-state (lookup-key function-key-map [delete])))
5419 (if normal-erase-is-backspace
5420 (progn
5421 (define-key function-key-map [delete] [?\C-d])
5422 (define-key function-key-map [kp-delete] [?\C-d])
5423 (define-key function-key-map [backspace] [?\C-?]))
5424 (define-key function-key-map [delete] [?\C-?])
5425 (define-key function-key-map [kp-delete] [?\C-?])
5426 (define-key function-key-map [backspace] [?\C-?]))
5428 ;; Maybe swap bindings of C-delete and C-backspace, etc.
5429 (unless (equal old-state (lookup-key function-key-map [delete]))
5430 (dolist (binding bindings)
5431 (let ((map global-map))
5432 (when (keymapp (car binding))
5433 (setq map (car binding) binding (cdr binding)))
5434 (let* ((key1 (nth 0 binding))
5435 (key2 (nth 1 binding))
5436 (binding1 (lookup-key map key1))
5437 (binding2 (lookup-key map key2)))
5438 (define-key map key1 binding2)
5439 (define-key map key2 binding1)))))))
5440 (t
5441 (if normal-erase-is-backspace
5442 (progn
5443 (keyboard-translate ?\C-h ?\C-?)
5444 (keyboard-translate ?\C-? ?\C-d))
5445 (keyboard-translate ?\C-h ?\C-h)
5446 (keyboard-translate ?\C-? ?\C-?))))
5448 (run-hooks 'normal-erase-is-backspace-hook)
5449 (if (interactive-p)
5450 (message "Delete key deletes %s"
5451 (if normal-erase-is-backspace "forward" "backward"))))
5452 \f
5453 (defvar vis-mode-saved-buffer-invisibility-spec nil
5454 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
5456 (define-minor-mode visible-mode
5457 "Toggle Visible mode.
5458 With argument ARG turn Visible mode on iff ARG is positive.
5460 Enabling Visible mode makes all invisible text temporarily visible.
5461 Disabling Visible mode turns off that effect. Visible mode
5462 works by saving the value of `buffer-invisibility-spec' and setting it to nil."
5463 :lighter " Vis"
5464 :group 'editing-basics
5465 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
5466 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
5467 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
5468 (when visible-mode
5469 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
5470 buffer-invisibility-spec)
5471 (setq buffer-invisibility-spec nil)))
5472 \f
5473 ;; Minibuffer prompt stuff.
5475 ;(defun minibuffer-prompt-modification (start end)
5476 ; (error "You cannot modify the prompt"))
5477 ;
5478 ;
5479 ;(defun minibuffer-prompt-insertion (start end)
5480 ; (let ((inhibit-modification-hooks t))
5481 ; (delete-region start end)
5482 ; ;; Discard undo information for the text insertion itself
5483 ; ;; and for the text deletion.above.
5484 ; (when (consp buffer-undo-list)
5485 ; (setq buffer-undo-list (cddr buffer-undo-list)))
5486 ; (message "You cannot modify the prompt")))
5487 ;
5488 ;
5489 ;(setq minibuffer-prompt-properties
5490 ; (list 'modification-hooks '(minibuffer-prompt-modification)
5491 ; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
5492 ;
5494 (provide 'simple)
5496 ;; arch-tag: 24af67c0-2a49-44f6-b3b1-312d8b570dfd
5497 ;;; simple.el ends here