| blob | 1554378d138fde722381210ee814d343986ce9fc |
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, 2007 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 a number, highlight the locus in `next-error' face for the given time
134 in seconds, or until the next command is executed.
135 If t, highlight the locus until the next command is executed, or until
136 some other locus replaces it.
137 If nil, don't highlight the locus in the source buffer.
138 If `fringe-arrow', indicate the locus by the fringe arrow."
147 "*Highlighting of locations in `next-error-no-select'.
148 If number, highlight the locus in `next-error' face for given time in seconds.
149 If t, highlight the locus indefinitely until some other locus replaces it.
150 If nil, don't highlight the locus in the source buffer.
151 If `fringe-arrow', indicate the locus by the fringe arrow."
160 "*List of hook functions run by `next-error' after visiting source file."
171 "The most recent `next-error' buffer.
172 A buffer becomes most recent when its compilation, grep, or
177 "Function to use to find the next error in the current buffer.
178 The function is called with 2 parameters:
179 ARG is an integer specifying by how many errors to move.
180 RESET is a boolean which, if non-nil, says to go back to the beginning
181 of the errors before moving.
182 Major modes providing compile-like functionality should set this variable
183 to indicate to `next-error' that this is a candidate buffer and how
189 &optional avoid-current
190 extra-test-inclusive
191 extra-test-exclusive)
192 "Test if BUFFER is a `next-error' capable buffer.
194 If AVOID-CURRENT is non-nil, treat the current buffer
195 as an absolute last resort only.
197 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
198 that normally would not qualify. If it returns t, the buffer
199 in question is treated as usable.
201 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
202 that would normally be considered usable. If it returns nil,
203 that buffer is rejected."
208 ;; Optionally reject some buffers.
211 t)
212 ;; Optionally accept some other buffers.
217 extra-test-inclusive
218 extra-test-exclusive)
219 "Return a `next-error' capable buffer.
221 If AVOID-CURRENT is non-nil, treat the current buffer
222 as an absolute last resort only.
224 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
225 that normally would not qualify. If it returns t, the buffer
226 in question is treated as usable.
228 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
229 that would normally be considered usable. If it returns nil,
230 that buffer is rejected."
232 ;; 1. If one window on the selected frame displays such buffer, return it.
238 avoid-current
239 extra-test-inclusive extra-test-exclusive)
244 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
247 extra-test-inclusive extra-test-exclusive))
248 next-error-last-buffer)
249 ;; 3. If the current buffer is acceptable, choose it.
251 extra-test-inclusive extra-test-exclusive)
253 ;; 4. Look for any acceptable buffer.
258 extra-test-inclusive extra-test-exclusive)))
261 ;; 5. Use the current buffer as a last resort if it qualifies,
262 ;; even despite AVOID-CURRENT.
265 extra-test-inclusive extra-test-exclusive)
269 ;; 6. Give up.
273 "Visit next `next-error' message and corresponding source code.
275 If all the error messages parsed so far have been processed already,
276 the message buffer is checked for new ones.
278 A prefix ARG specifies how many error messages to move;
279 negative means move back to previous error messages.
281 and start at the first error.
283 The RESET argument specifies that we should restart from the beginning.
286 compilation, grep, or occur buffer. It can also operate on any
288 more generally, on any buffer in Compilation mode or with
289 Compilation Minor mode enabled, or any buffer in which
290 `next-error-function' is bound to an appropriate function.
291 To specify use of a particular buffer for error messages, type
293 in the current frame.
296 runs `next-error-hook' with `run-hooks', and stays with that buffer
297 until you use it in some other buffer which uses Compilation mode
298 or Compilation Minor mode.
300 See variables `compilation-parse-errors-function' and
301 \`compilation-error-regexp-alist' for customization ideas."
305 ;; we know here that next-error-function is a valid symbol we can funcall
311 "Visit the source code corresponding to the `next-error' message at point."
313 ;; we know here that next-error-function is a valid symbol we can funcall
322 "Visit previous `next-error' message and corresponding source code.
324 Prefix arg N says how many error messages to move backwards (or
325 forwards, if negative).
332 "Restart at the first error.
333 Visit corresponding source code.
334 With prefix arg N, visit the source code of the Nth error.
340 "Move point to the next error in the `next-error' buffer and highlight match.
341 Prefix arg N says how many error messages to move forwards (or
342 backwards, if negative).
344 select the source buffer."
351 "Move point to the previous error in the `next-error' buffer and highlight match.
352 Prefix arg N says how many error messages to move backwards (or
353 forwards, if negative).
355 select the source buffer."
359 ;;; Internal variable for `next-error-follow-mode-post-command-hook'.
363 "Minor mode for compilation, occur and diff modes.
364 When turned on, cursor motion in the compilation, grep, occur or diff
365 buffer causes automatic display of the corresponding source code
366 location."
373 ;;; Used as a `post-command-hook' by `next-error-follow-mode'
374 ;;; for the *Compilation* *grep* and *Occur* buffers.
384 \f
385 ;;;
388 "Major mode not specialized for anything in particular.
389 Other major modes are defined by comparison with this one."
395 ;; Making and deleting lines.
400 "Insert a newline, and move to left margin of the new line if it's blank.
401 If `use-hard-newlines' is non-nil, the newline is marked with the
402 text-property `hard'.
403 With ARG, insert that many newlines.
404 Call `auto-fill-function' if the current column number is greater
405 than the value of `fill-column' and ARG is nil."
408 ;; Inserting a newline at the end of a line produces better redisplay in
409 ;; try_window_id than inserting at the beginning of a line, and the textual
410 ;; result is the same. So, if we're at beginning of line, pretend to be at
411 ;; the end of the previous line.
414 ;; Make sure no functions want to be told about
415 ;; the range of the changes.
418 ;; Make sure there are no markers here.
421 ;; Make sure no text properties want to know
422 ;; where the change was.
427 ;; Make sure the newline before point isn't intangible.
429 ;; Make sure the newline before point isn't read-only.
431 ;; Make sure the newline before point isn't invisible.
433 ;; Make sure the newline before point has the same
434 ;; properties as the char before it (if any).
441 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
442 ;; Set last-command-char to tell self-insert what to insert.
444 ;; Don't auto-fill if we have a numeric argument.
445 ;; Also not if flag is true (it would fill wrong line);
446 ;; there is no need to since we're at BOL.
450 ;; If we get an error in self-insert-command, put point at right place.
452 ;; Even if we did *not* get an error, keep that forward-char;
453 ;; all further processing should apply to the newline that the user
454 ;; thinks he inserted.
456 ;; Mark the newline(s) `hard'.
460 ;; If the newline leaves the previous line blank,
461 ;; and we have a left margin, delete that from the blank line.
469 ;; Indent the line after the newline, except in one case:
470 ;; when we added the newline at the beginning of a line
471 ;; which starts a page.
474 nil)
479 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
485 "Insert a newline and leave point before it.
486 If there is a fill prefix and/or a `left-margin', insert them
487 on the new line if the line would have been blank.
488 With arg N, insert N newlines."
493 ;; Don't expand an abbrev before point.
507 "Split current line, moving portion beyond point vertically down.
508 If the current line starts with `fill-prefix', insert it on the new
509 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
511 When called from Lisp code, ARG may be a prefix string to copy."
516 ;; What prefix should we check for (nil means don't).
520 ;; Does this line start with it?
531 "Join this line to previous and fix up whitespace at join.
532 If there is a fill prefix, delete it from the beginning of this line.
533 With argument, join this line to following line."
540 ;; If the second line started with the fill prefix,
541 ;; delete the prefix.
553 "On blank line, delete all surrounding blank lines, leaving just one.
554 On isolated blank line, delete that one.
555 On nonblank line, delete any immediately following blank lines."
561 ;; Set singleblank if there is just one blank line here.
568 ;; Delete preceding blank lines, and this one too if it's the only one.
577 ;; Delete following blank lines, unless the current line is blank
578 ;; and there are no following blank lines.
587 ;; Handle the special case where point is followed by newline and eob.
588 ;; Delete the line, leaving point at eob.
593 "Delete all the trailing whitespace across the current buffer.
594 All whitespace after the last non-whitespace character in a line is deleted.
596 A formfeed is not considered whitespace by this function."
603 ;; Don't delete formfeeds, even if they are considered whitespace.
610 "Insert a newline, then indent according to major mode.
611 Indentation is done using the value of `indent-line-function'.
612 In programming language modes, this is the same as TAB.
613 In some text modes, where TAB inserts a tab, this command indents to the
614 column specified by the function `current-left-margin'."
621 "Reindent current line, insert newline, then indent the new line.
622 Indentation of both lines is done according to the current major mode,
623 which means calling the current value of `indent-line-function'.
624 In programming language modes, this is the same as TAB.
625 In some text modes, where TAB inserts a tab, this indents to the
626 column specified by the function `current-left-margin'."
629 ;; Be careful to insert the newline before indenting the line.
630 ;; Otherwise, the indentation might be wrong.
639 "Read next input character and insert it.
640 This is useful for inserting control characters.
642 If the first character you type after this command is an octal digit,
643 you should type a sequence of octal digits which specify a character code.
644 Any nondigit terminates the sequence. If the terminator is a RET,
645 it is discarded; any other terminator is used itself as input.
646 The variable `read-quoted-char-radix' specifies the radix for this feature;
647 set it to 10 or 16 to use decimal or hex instead of octal.
649 In overwrite mode, this function inserts the character anyway, and
650 does not handle octal digits specially. This means that if you use
651 overwrite as your normal editing mode, you can use this function to
652 insert characters when necessary.
654 In binary overwrite mode, this function does overwrite, and octal
655 digits are interpreted as a character code. This is intended to be
656 useful for editing binary files."
663 ;; Assume character codes 0240 - 0377 stand for characters in some
664 ;; single-byte character set, and convert them to Emacs
665 ;; characters.
678 "Move forward ARG lines and position at first nonblank character."
684 "Move backward ARG lines and position at first nonblank character."
690 "Move point to the first non-whitespace character on this line."
694 ;; Move back over chars that have whitespace syntax but have the p flag.
698 "Fixup white space between objects around point.
699 Leave one space or none, according to the context."
706 nil
710 "Delete all spaces and tabs around point.
711 If BACKWARD-ONLY is non-nil, only delete them before point."
716 orig-pos
725 "Delete all spaces and tabs around point, leaving one space (or N spaces)."
739 \f
741 "Move point to the beginning of the buffer; leave mark at previous position.
743 With numeric arg N, put point N/10 of the way from the beginning.
745 If the buffer is narrowed, this command uses the beginning and size
746 of the accessible part of the buffer.
748 Don't use this command in Lisp programs!
749 \(goto-char (point-min)) is faster and avoids clobbering the mark."
758 ;; Avoid overflow for large buffer sizes!
766 "Move point to the end of the buffer; leave mark at previous position.
768 With numeric arg N, put point N/10 of the way from the end.
770 If the buffer is narrowed, this command uses the beginning and size
771 of the accessible part of the buffer.
773 Don't use this command in Lisp programs!
774 \(goto-char (point-max)) is faster and avoids clobbering the mark."
783 ;; Avoid overflow for large buffer sizes!
788 ;; If we went to a place in the middle of the buffer,
789 ;; adjust it to the beginning of a line.
792 ;; If the end of the buffer is not already on the screen,
793 ;; then scroll specially to put it near, but not at, the bottom.
798 "Put point at beginning and mark at end of buffer.
799 You probably should not use this function in Lisp programs;
800 it is usually a mistake for a Lisp function to use any subroutine
801 that uses or sets the mark."
806 \f
808 ;; Counting lines, one way or another.
811 "Goto line ARG, counting from line 1 at beginning of buffer.
812 Normally, move point in the current buffer.
814 displayed other buffer, and switch to it. When called from Lisp code,
815 the optional argument BUFFER specifies a buffer to switch to.
817 If there's a number in the buffer at point, it is the default for ARG."
821 ;; Look for a default, a number in the buffer at point.
830 ;; Decide if we're switching buffers.
838 ;; Read the argument, offering that number (if any) as default.
841 buffer-prompt
842 default)
843 nil nil t
844 'minibuffer-history
845 default)
846 buffer))))
847 ;; Switch to the desired buffer, one way or another.
852 ;; Move to the specified line number in that buffer.
861 "Print number of lines and characters in the region."
867 "Print the current buffer line number and narrowed line number of point."
880 "Return number of lines between START and END.
881 This is usually the number of newlines between them,
882 but can be one more if START is not equal to END
883 and the greater of them is not at the start of a line."
899 done)))
903 "Return (narrowed) buffer line number at position POS.
904 If POS is nil, use current buffer location.
905 Counting starts at (point-min), so the value refers
906 to the contents of the accessible portion of the buffer."
916 "Print info on cursor position (on screen and within buffer).
917 Also describe the character after point, and give its character code
918 in octal, decimal and hex.
920 For a non-ASCII multibyte character, also give its encoding in the
921 buffer's selected coding system if the coding system encodes the
922 character safely. If the character is encoded into one byte, that
923 code is shown in hex. If the character is encoded into more than one
926 In addition, with prefix argument, show details about that character
927 in *Help* buffer. See also the command `describe-char'."
935 ;; Avoid overflow from multiplying by 100!
939 ""
945 pos total percent beg end col hscroll)
947 pos total col hscroll))
949 encoded encoding-msg display-prop under-display)
956 ;; Check if the character is displayed with some `display'
957 ;; text property. In that case, set under-display to the
958 ;; buffer substring covered by that property.
969 under-display)))
975 char char char under-display)
977 char char char under-display display-prop))
980 char char char
982 "..."
986 ;; We show the detailed information about CHAR.
993 encoding-msg pos total percent beg end col hscroll)
1000 encoding-msg pos total percent col hscroll))))))
1001 \f
1002 ;; Initialize read-expression-map. It is defined at C level.
1014 "Value for `print-level' while printing value in `eval-expression'.
1015 A value of nil means no limit."
1021 "Value for `print-length' while printing value in `eval-expression'.
1022 A value of nil means no limit."
1028 "If non-nil set `debug-on-error' to t in `eval-expression'.
1029 If nil, don't change the value of `debug-on-error'."
1035 "Format VALUE as a result of evaluated expression.
1036 Return a formatted string which is displayed in the echo area
1037 in addition to the value printed by prin1 in functions which
1038 display the result of expression evaluation."
1051 ;; We define this, rather than making `eval' interactive,
1052 ;; for the sake of completion of names like eval-region, eval-buffer.
1055 "Evaluate EVAL-EXPRESSION-ARG and print value in the echo area.
1056 Value is also consed on to front of the variable `values'.
1057 Optional argument EVAL-EXPRESSION-INSERT-VALUE, if non-nil, means
1058 insert the result into the current buffer instead of printing it in
1059 the echo area.
1061 If `eval-expression-debug-on-error' is non-nil, which is the default,
1062 this command arranges for all errors to enter the debugger."
1066 nil read-expression-map t
1068 current-prefix-arg))
1073 ;; Bind debug-on-error to something unique so that we can
1074 ;; detect when evaled code changes it.
1078 ;; If evaled code has changed the value of debug-on-error,
1079 ;; propagate that change to the global binding.
1095 "Prompting with PROMPT, let user edit COMMAND and eval result.
1096 COMMAND is a Lisp expression. Let user edit that expression in
1097 the minibuffer, then read and evaluate the result."
1104 read-expression-map t
1106 ;; If command was added to command-history as a string,
1107 ;; get rid of that. We want only evaluable expressions there.
1111 ;; If command to be redone does not match front of history,
1112 ;; add it to the history.
1118 "Edit and re-evaluate last complex command, or ARGth from last.
1119 A complex command is one which used the minibuffer.
1120 The command is placed in the minibuffer as a Lisp form for editing.
1121 The result is executed, repeating the command as changed.
1122 If the command has been changed or is not the most recent previous command
1123 it is added to the front of the command history.
1124 You can use the minibuffer history commands \\<minibuffer-local-map>\\[next-history-element] and \\[previous-history-element]
1125 to get different commands to edit and resubmit."
1128 newcmd)
1140 ;; If command was added to command-history as a
1141 ;; string, get rid of that. We want only
1142 ;; evaluable expressions there.
1146 ;; If command to be redone does not match front of history,
1147 ;; add it to the history.
1154 \f
1156 "Default minibuffer history list.
1157 This is used for all minibuffer input
1160 "Control whether history list elements are expressions or strings.
1161 If the value of this variable equals current minibuffer depth,
1162 they are expressions; otherwise they are strings.
1163 \(That convention is designed to do the right thing for
1170 "Text that was in this minibuffer before any history commands.
1171 This is nil if there have not yet been any history commands
1180 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1184 "*Minibuffer history variables for which matching should ignore case.
1185 If a history variable is a member of this list, then the
1187 commands ignore case when searching it, regardless of `case-fold-search'."
1192 "Find the previous history element that matches REGEXP.
1193 \(Previous history elements refer to earlier actions.)
1194 With prefix argument N, search for Nth previous match.
1195 If N is negative, find the next or Nth next match.
1196 Normally, history elements are matched case-insensitively if
1197 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1198 makes the search case-sensitive.
1199 See also `minibuffer-history-case-insensitive-variables'."
1203 nil
1204 minibuffer-local-map
1205 nil
1206 'minibuffer-history-search-history
1208 ;; Use the last regexp specified, by default, if input is empty.
1213 regexp)
1223 ;; On some systems, ignore case for file names.
1225 minibuffer-history-case-insensitive-variables)
1226 t
1227 ;; Respect the user's setting for case-fold-search:
1228 case-fold-search)
1229 nil))
1230 prevpos
1231 match-string
1232 match-offset
1239 "No later matching history item"
1260 next-matching-history-element))
1264 "Find the next history element that matches REGEXP.
1265 \(The next history element refers to a more recent action.)
1266 With prefix argument N, search for Nth next match.
1267 If N is negative, find the previous or Nth previous match.
1268 Normally, history elements are matched case-insensitively if
1269 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1270 makes the search case-sensitive."
1274 nil
1275 minibuffer-local-map
1276 nil
1277 'minibuffer-history-search-history
1279 ;; Use the last regexp specified, by default, if input is empty.
1284 regexp)
1291 "Puts next element of the minibuffer history in the minibuffer.
1292 With argument N, it uses the Nth following element."
1297 elt minibuffer-returned-to-present)
1309 previous-history-element))
1331 elt))
1335 "Puts previous element of the minibuffer history in the minibuffer.
1336 With argument N, it uses the Nth previous element."
1341 "Get next history element which completes the minibuffer before the point.
1342 The contents of the minibuffer after the point are deleted, and replaced
1343 by the new completion."
1349 n)
1350 ;; next-matching-history-element always puts us at (point-min).
1351 ;; Move to the position we were at before changing the buffer contents.
1352 ;; This is still sensical, because the text before point has not changed.
1356 "\
1357 Get previous history element which completes the minibuffer before the point.
1358 The contents of the minibuffer after the point are deleted, and replaced
1359 by the new completion."
1363 ;; For compatibility with the old subr of the same name.
1365 "Return the display width of the minibuffer prompt.
1366 Return 0 if current buffer is not a minibuffer."
1367 ;; Return the width of everything before the field at the end of
1368 ;; the buffer; this should be 0 for normal buffers.
1370 \f
1371 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
1375 "Table mapping redo records to the corresponding undo one.
1376 A redo record for undo-in-region maps to t.
1386 "Within a run of consecutive undo commands, list remaining to be undone.
1390 "Undo some previous changes.
1391 Repeat this command to undo more changes.
1392 A numeric argument serves as a repeat count.
1394 In Transient Mark mode when the mark is active, only undo changes within
1396 as an argument limits undo to changes within the current region."
1398 ;; Make last-command indicate for the next command that this was an undo.
1399 ;; That way, another undo will undo more.
1400 ;; If we get to the end of the undo history and get an error,
1401 ;; another undo command will find the undo history empty
1402 ;; and will get another error. To begin undoing the undos,
1403 ;; you must type some other command.
1406 message)
1407 ;; If we get an error in undo-start,
1408 ;; the next command should not be a "consecutive undo".
1409 ;; So set `this-command' to something other than `undo'.
1414 ;; If something (a timer or filter?) changed the buffer
1415 ;; since the previous command, don't continue the undo seq.
1419 ;; If the last undo record made was made by undo
1420 ;; it shows nothing else happened in between.
1427 ;; get rid of initial undo boundary
1429 ;; If we got this far, the next command should be a consecutive undo.
1431 ;; Check to see whether we're hitting a redo record, and if
1432 ;; so, ask the user whether she wants to skip the redo/undo pair.
1439 ;; The equiv entry might point to another redo record if we have done
1440 ;; undo-redo-undo-redo-... so skip to the very last equiv.
1448 ;; Record the fact that the just-generated undo records come from an
1449 ;; undo operation--that is, they are redo records.
1450 ;; In the ordinary case (not within a region), map the redo
1451 ;; record to the following undos.
1452 ;; I don't know how to do that in the undo-in-region case.
1455 undo-equiv-table)
1456 ;; Don't specify a position in the undo record for the undo command.
1457 ;; Instead, undoing this should move point to where the change is.
1476 ;; Record what the current undo list says,
1477 ;; so the next command can tell if the buffer was modified in between.
1480 ;; Display a message announcing success.
1485 "Make BUFFER stop keeping undo information.
1486 No argument or nil as argument means do this for the current buffer."
1492 "Undo some previous changes.
1493 Repeat this command to undo more changes.
1494 A numeric argument serves as a repeat count.
1495 Contrary to `undo', this will not redo a previous undo."
1500 "Non-nil while performing an undo.
1504 "Undo back N undo-boundaries beyond what was already undone recently.
1505 Call `undo-start' to get ready to undo recent changes,
1506 then call `undo-more' one or more times to undo them."
1515 ;; Deep copy of a list
1517 "Make a copy of undo list LIST."
1523 elt))
1526 "Set `pending-undo-list' to the front of the undo list.
1527 The next call to `undo-more' will undo the most recently made change.
1528 If BEG and END are specified, then only undo elements
1529 that apply to text between BEG and END are used; other undo elements
1530 are ignored. If BEG and END are nil, all undo elements are used."
1536 buffer-undo-list)))
1541 "Return a list of undo elements for the region START to END.
1542 The elements come from `buffer-undo-list', but we keep only
1543 the elements inside this region, and discard those outside this region.
1544 If we find an element that crosses an edge of this region,
1545 we stop and ignore all further elements."
1548 undo-adjusted-markers
1549 some-rejected
1550 undo-elt undo-elt temp-undo-list delta)
1555 ;; This is a "was unmodified" element.
1556 ;; Keep it if we have kept everything thus far.
1563 ;; Don't put two nils together in the list
1577 ;; Loop down the earlier events adjusting their buffer
1578 ;; positions to reflect the fact that a change to the buffer
1579 ;; isn't being undone. We only need to process those element
1580 ;; types which undo-elt-in-region will return as being in
1581 ;; the region since only those types can ever get into the
1582 ;; output
1591 ;; (TEXT . POSITION)
1598 ;; (BEGIN . END)
1603 ;; (nil PROPERTY VALUE BEG . END)
1613 "Determine whether UNDO-ELT falls inside the region START ... END.
1614 If it crosses the edge, we return nil."
1619 t)
1621 nil)
1623 ;; (TEXT . POSITION)
1627 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
1628 ;; See if MARKER is inside the region.
1639 ;; (nil PROPERTY VALUE BEG . END)
1644 ;; (BEGIN . END)
1649 "Test whether UNDO-ELT crosses one edge of that region START ... END.
1650 This assumes we have already decided that UNDO-ELT
1651 is not *inside* the region START...END."
1654 ;; (nil PROPERTY VALUE BEG . END)
1659 ;; (BEGIN . END)
1663 ;; Return the first affected buffer position and the delta for an undo element
1664 ;; delta is defined as the change in subsequent buffer positions if we *did*
1665 ;; the undo.
1669 ;; (TEXT . POSITION)
1672 ;; (BEGIN . END)
1679 "If non-nil ask about discarding undo info for the current command.
1680 Normally, Emacs discards the undo info for the current command if
1681 it exceeds `undo-outer-limit'. But if you set this option
1682 non-nil, it asks in the echo area whether to discard the info.
1683 If you answer no, there is a slight risk that Emacs might crash, so
1684 only do it if you really want to undo the command.
1686 This option is mainly intended for debugging. You have to be
1687 careful if you use it for other purposes. Garbage collection is
1688 inhibited while the question is asked, meaning that Emacs might
1689 leak memory. So you should make sure that you do not wait
1690 excessively long before answering the question."
1696 "If non-nil, an extra level of size that's ok in an undo item.
1697 We don't ask the user about truncating the undo list until the
1698 current item gets bigger than this amount.
1703 ;; When the first undo batch in an undo list is longer than
1704 ;; undo-outer-limit, this function gets called to warn the user that
1705 ;; the undo info for the current command was discarded. Garbage
1706 ;; collection is inhibited around the call, so it had better not do a
1707 ;; lot of consing.
1713 ;; Don't ask the question again unless it gets even bigger.
1714 ;; This applies, in particular, if the user quits from the question.
1715 ;; Such a quit quits out of GC, but something else will call GC
1716 ;; again momentarily. It will call this function again,
1717 ;; but we don't want to ask the question again.
1724 t)
1725 nil))
1730 "The undo info was discarded because it exceeded \
1731 `undo-outer-limit'.
1733 This is normal if you executed a command that made a huge change
1734 to the buffer. In that case, to prevent similar problems in the
1735 future, set `undo-outer-limit' to a value that is large enough to
1736 cover the maximum size of normal changes you expect a single
1737 command to make, but not so large that it might exceed the
1738 maximum memory allotted to Emacs.
1740 If you did not execute any such command, the situation is
1741 probably due to a bug and you should report it.
1743 You can disable the popping up of this buffer by adding the entry
1747 t))
1748 \f
1756 "*Buffer name for `shell-command' and `shell-command-on-region' error output.
1757 This buffer is used when `shell-command' or `shell-command-on-region'
1758 is run interactively. A value of nil means that output to stderr and
1762 "Execute string COMMAND in inferior shell; display output, if any.
1763 With prefix argument, insert the COMMAND's output at point.
1765 If COMMAND ends in ampersand, execute it asynchronously.
1766 The output appears in the buffer `*Async Shell Command*'.
1767 That buffer is in shell mode.
1769 Otherwise, COMMAND is executed synchronously. The output appears in
1770 the buffer `*Shell Command Output*'. If the output is short enough to
1771 display in the echo area (which is determined by the variables
1772 `resize-mini-windows' and `max-mini-window-height'), it is shown
1773 there, but it is nonetheless available in buffer `*Shell Command
1774 Output*' even though that buffer is not automatically displayed.
1776 To specify a coding system for converting non-ASCII characters
1778 before this command.
1780 Noninteractive callers can specify coding systems by binding
1781 `coding-system-for-read' and `coding-system-for-write'.
1783 The optional second argument OUTPUT-BUFFER, if non-nil,
1784 says to put the output in some other buffer.
1785 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
1786 If OUTPUT-BUFFER is not a buffer and not nil,
1787 insert output in current buffer. (This cannot be done asynchronously.)
1788 In either case, the output is inserted after point (leaving mark after it).
1790 If the command terminates without error, but generates output,
1792 the output can be displayed in the echo area or in its buffer.
1793 If the output is short enough to display in the echo area
1794 \(determined by the variable `max-mini-window-height' if
1795 `resize-mini-windows' is non-nil), it is shown there. Otherwise,
1796 the buffer containing the output is displayed.
1800 of the output.
1802 If there is no output, or if output is inserted in the current buffer,
1803 then `*Shell Command Output*' is deleted.
1805 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
1806 or buffer name to which to direct the command's standard error output.
1807 If it is nil, error output is mingled with regular output.
1808 In an interactive call, the variable `shell-command-default-error-buffer'
1809 specifies the value of ERROR-BUFFER."
1813 current-prefix-arg
1814 shell-command-default-error-buffer))
1815 ;; Look for a handler in case default-directory is a remote file name.
1823 ;; Output goes in current buffer.
1829 temporary-file-directory)))
1830 nil)))
1833 ;; We do not use -f for csh; we will not support broken use of
1834 ;; .cshrcs. Even the BSD csh manual says to use
1835 ;; "if ($?prompt) exit" before things which are not useful
1836 ;; non-interactively. Besides, if someone wants their other
1837 ;; aliases for shell commands then they can still have them.
1841 t)
1842 nil shell-command-switch command)
1849 ;; Do no formatting while reading error file,
1850 ;; because that can run a shell command, and we
1851 ;; don't want that to cause an infinite recursion.
1853 ;; Put point after the inserted errors.
1857 ;; This is like exchange-point-and-mark, but doesn't
1858 ;; activate the mark. It is cleaner to avoid activation,
1859 ;; even though the command loop would deactivate the mark
1860 ;; because we inserted text.
1864 ;; Output goes in a separate buffer.
1865 ;; Preserve the match data in case called from a program.
1868 ;; Command ending with ampersand means asynchronous.
1872 proc)
1873 ;; Remove the ampersand.
1875 ;; If will kill a process, query first.
1887 shell-command-switch command))
1891 ))
1893 output-buffer nil error-buffer)))))))
1897 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
1898 MESSAGE may be either a string or a buffer.
1900 A buffer is displayed using `display-buffer' if MESSAGE is too long for
1901 the maximum height of the echo area, as defined by `max-mini-window-height'
1902 if `resize-mini-windows' is non-nil.
1904 Returns either the string shown in the echo area, or when a pop-up
1905 buffer is used, the window used to display it.
1907 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
1908 name of the buffer used to display it in the case where a pop-up buffer
1909 is used, defaulting to `*Message*'. In the case where MESSAGE is a
1910 string and it is displayed in the echo area, it is not specified whether
1911 the contents are inserted into the buffer anyway.
1913 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
1914 and only used if a buffer is displayed."
1916 ;; Trivial case where we can use the echo area
1920 ;; Trivial case where we can just remove single trailing newline
1923 ;; General case
1926 message
1935 0
1939 (<= lines
1943 max-mini-window-height))
1945 max-mini-window-height)
1949 ;; Don't use the echo area if the output buffer is
1950 ;; already dispayed in the selected frame.
1952 ;; Echo area
1958 ;; Buffer
1961 not-this-window frame))))))))
1964 ;; We have a sentinel to prevent insertion of a termination message
1965 ;; in the buffer itself.
1973 &optional output-buffer replace
1974 error-buffer display-error-buffer)
1975 "Execute string COMMAND in inferior shell with region as input.
1976 Normally display output (if any) in temp buffer `*Shell Command Output*';
1977 Prefix arg means replace the region with it. Return the exit code of
1978 COMMAND.
1980 To specify a coding system for converting non-ASCII characters
1982 before this command. By default, the input (from the current buffer)
1983 is encoded in the same coding system that will be used to save the file,
1984 `buffer-file-coding-system'. If the output is going to replace the region,
1985 then it is decoded from that same coding system.
1987 The noninteractive arguments are START, END, COMMAND,
1988 OUTPUT-BUFFER, REPLACE, ERROR-BUFFER, and DISPLAY-ERROR-BUFFER.
1989 Noninteractive callers can specify coding systems by binding
1990 `coding-system-for-read' and `coding-system-for-write'.
1992 If the command generates output, the output may be displayed
1993 in the echo area or in a buffer.
1994 If the output is short enough to display in the echo area
1995 \(determined by the variable `max-mini-window-height' if
1996 `resize-mini-windows' is non-nil), it is shown there. Otherwise
1997 it is displayed in the buffer `*Shell Command Output*'. The output
1998 is available in that buffer in both cases.
2000 If there is output and an error, a message about the error
2001 appears at the end of the output.
2003 If there is no output, or if output is inserted in the current buffer,
2004 then `*Shell Command Output*' is deleted.
2006 If the optional fourth argument OUTPUT-BUFFER is non-nil,
2007 that says to put the output in some other buffer.
2008 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2009 If OUTPUT-BUFFER is not a buffer and not nil,
2010 insert output in the current buffer.
2011 In either case, the output is inserted after point (leaving mark after it).
2013 If REPLACE, the optional fifth argument, is non-nil, that means insert
2014 the output in place of text from START to END, putting point and mark
2015 around it.
2017 If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
2018 or buffer name to which to direct the command's standard error output.
2019 If it is nil, error output is mingled with regular output.
2020 If DISPLAY-ERROR-BUFFER is non-nil, display the error buffer if there
2021 were any errors. (This is always t, interactively.)
2022 In an interactive call, the variable `shell-command-default-error-buffer'
2023 specifies the value of ERROR-BUFFER."
2027 ;; Do this before calling region-beginning
2028 ;; and region-end, in case subprocess output
2029 ;; relocates them while we are in the minibuffer.
2031 nil nil nil
2033 ;; call-interactively recognizes region-beginning and
2034 ;; region-end specially, leaving them in the history.
2036 string
2037 current-prefix-arg
2038 current-prefix-arg
2039 shell-command-default-error-buffer
2040 t)))
2046 temporary-file-directory)))
2047 nil))
2048 exit-status)
2052 ;; Replace specified region with output from command.
2054 ;; Don't muck with mark unless REPLACE says we should.
2061 t)
2062 nil shell-command-switch command))
2063 ;; It is rude to delete a buffer which the command is not using.
2064 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
2065 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
2066 ;; (kill-buffer shell-buffer)))
2067 ;; Don't muck with mark unless REPLACE says we should.
2069 ;; No prefix argument: put the output in a temp buffer,
2070 ;; replacing its entire contents.
2075 ;; If the input is the same buffer as the output,
2076 ;; delete everything but the specified region,
2077 ;; then replace that region with the output.
2083 shell-file-name t
2086 t)
2087 nil shell-command-switch
2088 command)))
2089 ;; Clear the output buffer, then run the command with
2090 ;; output there.
2102 buffer)
2103 nil shell-command-switch command)))
2104 ;; Report the output.
2114 ;; There's some output, display it
2116 ;; No output; error?
2120 "some error output"
2126 output))
2129 exit-status))
2132 exit-status output))))
2133 ;; Don't kill: there might be useful info in the undo-log.
2134 ;; (kill-buffer buffer)
2135 ))))
2143 ;; Do no formatting while reading error file,
2144 ;; because that can run a shell command, and we
2145 ;; don't want that to cause an infinite recursion.
2147 ;; Put point after the inserted errors.
2152 exit-status))
2155 "Execute shell command COMMAND and return its output as a string."
2158 standard-output
2162 "Process files synchronously in a separate process.
2163 Similar to `call-process', but may invoke a file handler based on
2164 `default-directory'. The current working directory of the
2165 subprocess is `default-directory'.
2167 File names in INFILE and BUFFER are handled normally, but file
2168 names in ARGS should be relative to `default-directory', as they
2169 are passed to the process verbatim. \(This is a difference to
2170 `call-process' which does not support file handlers for INFILE
2171 and BUFFER.\)
2173 Some file handlers might not support all variants, for example
2174 they might behave as if DISPLAY was nil, regardless of the actual
2175 value passed."
2177 lc stderr-file)
2187 display args)
2193 \f
2197 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
2198 (define-key map [switch-frame] nil)
2199 (define-key map [?\C-u] 'universal-argument-more)
2200 (define-key map [?-] 'universal-argument-minus)
2201 (define-key map [?0] 'digit-argument)
2202 (define-key map [?1] 'digit-argument)
2203 (define-key map [?2] 'digit-argument)
2204 (define-key map [?3] 'digit-argument)
2205 (define-key map [?4] 'digit-argument)
2206 (define-key map [?5] 'digit-argument)
2207 (define-key map [?6] 'digit-argument)
2208 (define-key map [?7] 'digit-argument)
2209 (define-key map [?8] 'digit-argument)
2210 (define-key map [?9] 'digit-argument)
2211 (define-key map [kp-0] 'digit-argument)
2212 (define-key map [kp-1] 'digit-argument)
2213 (define-key map [kp-2] 'digit-argument)
2214 (define-key map [kp-3] 'digit-argument)
2215 (define-key map [kp-4] 'digit-argument)
2216 (define-key map [kp-5] 'digit-argument)
2217 (define-key map [kp-6] 'digit-argument)
2218 (define-key map [kp-7] 'digit-argument)
2219 (define-key map [kp-8] 'digit-argument)
2220 (define-key map [kp-9] 'digit-argument)
2221 (define-key map [kp-subtract] 'universal-argument-minus)
2222 map)
2225 (defvar universal-argument-num-events nil
2226 "Number of argument-specifying events read by `universal-argument'.
2227 `universal-argument-other-key' uses this to discard those events
2228 from (this-command-keys), and reread only the final command.")
2230 (defvar overriding-map-is-bound nil
2231 "Non-nil when `overriding-terminal-local-map' is `universal-argument-map'.")
2233 (defvar saved-overriding-map nil
2234 "The saved value of `overriding-terminal-local-map'.
2238 (defun ensure-overriding-map-is-bound ()
2239 "Check `overriding-terminal-local-map' is `universal-argument-map'."
2240 (unless overriding-map-is-bound
2241 (setq saved-overriding-map overriding-terminal-local-map)
2242 (setq overriding-terminal-local-map universal-argument-map)
2243 (setq overriding-map-is-bound t)))
2245 (defun restore-overriding-map ()
2246 "Restore `overriding-terminal-local-map' to its saved value."
2247 (setq overriding-terminal-local-map saved-overriding-map)
2248 (setq overriding-map-is-bound nil))
2250 (defun universal-argument ()
2251 "Begin a numeric argument for the following command.
2256 multiplies the argument by 4 each time.
2258 which is different in effect from any particular numeric argument.
2260 (interactive)
2261 (setq prefix-arg (list 4))
2262 (setq universal-argument-num-events (length (this-command-keys)))
2263 (ensure-overriding-map-is-bound))
2265 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
2266 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
2267 (defun universal-argument-more (arg)
2268 (interactive "P")
2269 (if (consp arg)
2270 (setq prefix-arg (list (* 4 (car arg))))
2271 (if (eq arg '-)
2272 (setq prefix-arg (list -4))
2273 (setq prefix-arg arg)
2274 (restore-overriding-map)))
2275 (setq universal-argument-num-events (length (this-command-keys))))
2277 (defun negative-argument (arg)
2278 "Begin a negative numeric argument for the next command.
2280 (interactive "P")
2281 (cond ((integerp arg)
2282 (setq prefix-arg (- arg)))
2283 ((eq arg '-)
2284 (setq prefix-arg nil))
2285 (t
2286 (setq prefix-arg '-)))
2287 (setq universal-argument-num-events (length (this-command-keys)))
2288 (ensure-overriding-map-is-bound))
2290 (defun digit-argument (arg)
2291 "Part of the numeric argument for the next command.
2293 (interactive "P")
2294 (let* ((char (if (integerp last-command-char)
2295 last-command-char
2296 (get last-command-char 'ascii-character)))
2298 (cond ((integerp arg)
2299 (setq prefix-arg (+ (* arg 10)
2300 (if (< arg 0) (- digit) digit))))
2301 ((eq arg '-)
2302 ;; Treat -0 as just -, so that -01 will work.
2303 (setq prefix-arg (if (zerop digit) '- (- digit))))
2304 (t
2305 (setq prefix-arg digit))))
2306 (setq universal-argument-num-events (length (this-command-keys)))
2307 (ensure-overriding-map-is-bound))
2309 ;; For backward compatibility, minus with no modifiers is an ordinary
2310 ;; command if digits have already been entered.
2311 (defun universal-argument-minus (arg)
2312 (interactive "P")
2313 (if (integerp arg)
2314 (universal-argument-other-key arg)
2315 (negative-argument arg)))
2317 ;; Anything else terminates the argument and is left in the queue to be
2318 ;; executed as a command.
2319 (defun universal-argument-other-key (arg)
2320 (interactive "P")
2321 (setq prefix-arg arg)
2322 (let* ((key (this-command-keys))
2323 (keylist (listify-key-sequence key)))
2324 (setq unread-command-events
2325 (append (nthcdr universal-argument-num-events keylist)
2326 unread-command-events)))
2327 (reset-this-command-lengths)
2328 (restore-overriding-map))
2329 \f
2330 (defvar buffer-substring-filters nil
2331 "List of filter functions for `filter-buffer-substring'.
2332 Each function must accept a single argument, a string, and return
2333 a string. The buffer substring is passed to the first function
2334 in the list, and the return value of each function is passed to
2335 the next. The return value of the last function is used as the
2336 return value of `filter-buffer-substring'.
2338 If this variable is nil, no filtering is performed.")
2340 (defun filter-buffer-substring (beg end &optional delete noprops)
2341 "Return the buffer substring between BEG and END, after filtering.
2342 The buffer substring is passed through each of the filter
2343 functions in `buffer-substring-filters', and the value from the
2344 last filter function is returned. If `buffer-substring-filters'
2345 is nil, the buffer substring is returned unaltered.
2347 If DELETE is non-nil, the text between BEG and END is deleted
2348 from the buffer.
2350 If NOPROPS is non-nil, final string returned does not include
2351 text properties, while the string passed to the filters still
2352 includes text properties from the buffer text.
2354 Point is temporarily set to BEG before calling
2355 `buffer-substring-filters', in case the functions need to know
2356 where the text came from.
2358 This function should be used instead of `buffer-substring',
2359 `buffer-substring-no-properties', or `delete-and-extract-region'
2360 when you want to allow filtering to take place. For example,
2361 major or minor modes can use `buffer-substring-filters' to
2362 extract characters that are special to a buffer, and should not
2363 be copied into other buffers."
2364 (cond
2365 ((or delete buffer-substring-filters)
2366 (save-excursion
2367 (goto-char beg)
2368 (let ((string (if delete (delete-and-extract-region beg end)
2369 (buffer-substring beg end))))
2370 (dolist (filter buffer-substring-filters)
2371 (setq string (funcall filter string)))
2372 (if noprops
2373 (set-text-properties 0 (length string) nil string))
2374 string)))
2375 (noprops
2376 (buffer-substring-no-properties beg end))
2377 (t
2378 (buffer-substring beg end))))
2381 ;;;; Window system cut and paste hooks.
2383 (defvar interprogram-cut-function nil
2384 "Function to call to make a killed region available to other programs.
2386 Most window systems provide some sort of facility for cutting and
2387 pasting text between the windows of different programs.
2388 This variable holds a function that Emacs calls whenever text
2389 is put in the kill ring, to make the new kill available to other
2390 programs.
2392 The function takes one or two arguments.
2393 The first argument, TEXT, is a string containing
2394 the text which should be made available.
2395 The second, optional, argument PUSH, has the same meaning as the
2396 similar argument to `x-set-cut-buffer', which see.")
2398 (defvar interprogram-paste-function nil
2399 "Function to call to get text cut from other programs.
2401 Most window systems provide some sort of facility for cutting and
2402 pasting text between the windows of different programs.
2403 This variable holds a function that Emacs calls to obtain
2404 text that other programs have provided for pasting.
2406 The function should be called with no arguments. If the function
2407 returns nil, then no other program has provided such text, and the top
2408 of the Emacs kill ring should be used. If the function returns a
2409 string, then the caller of the function \(usually `current-kill')
2410 should put this string in the kill ring as the latest kill.
2412 Note that the function should return a string only if a program other
2413 than Emacs has provided a string for pasting; if Emacs provided the
2414 most recent string, the function should return nil. If it is
2415 difficult to tell whether Emacs or some other program provided the
2416 current string, it is probably good enough to return nil if the string
2417 is equal (according to `string=') to the last text Emacs provided.")
2418 \f
2421 ;;;; The kill ring data structure.
2423 (defvar kill-ring nil
2424 "List of killed text sequences.
2425 Since the kill ring is supposed to interact nicely with cut-and-paste
2426 facilities offered by window systems, use of this variable should
2427 interact nicely with `interprogram-cut-function' and
2428 `interprogram-paste-function'. The functions `kill-new',
2429 `kill-append', and `current-kill' are supposed to implement this
2430 interaction; you may want to use them instead of manipulating the kill
2431 ring directly.")
2433 (defcustom kill-ring-max 60
2434 "*Maximum length of kill ring before oldest elements are thrown away."
2435 :type 'integer
2436 :group 'killing)
2438 (defvar kill-ring-yank-pointer nil
2439 "The tail of the kill ring whose car is the last thing yanked.")
2441 (defun kill-new (string &optional replace yank-handler)
2442 "Make STRING the latest kill in the kill ring.
2443 Set `kill-ring-yank-pointer' to point to it.
2444 If `interprogram-cut-function' is non-nil, apply it to STRING.
2445 Optional second argument REPLACE non-nil means that STRING will replace
2446 the front of the kill ring, rather than being added to the list.
2448 Optional third arguments YANK-HANDLER controls how the STRING is later
2449 inserted into a buffer; see `insert-for-yank' for details.
2450 When a yank handler is specified, STRING must be non-empty (the yank
2451 handler, if non-nil, is stored as a `yank-handler' text property on STRING).
2453 When the yank handler has a non-nil PARAM element, the original STRING
2454 argument is not used by `insert-for-yank'. However, since Lisp code
2455 may access and use elements from the kill ring directly, the STRING
2457 (if (> (length string) 0)
2458 (if yank-handler
2459 (put-text-property 0 (length string)
2460 'yank-handler yank-handler string))
2461 (if yank-handler
2462 (signal 'args-out-of-range
2463 (list string "yank-handler specified for empty string"))))
2464 (if (fboundp 'menu-bar-update-yank-menu)
2465 (menu-bar-update-yank-menu string (and replace (car kill-ring))))
2466 (if (and replace kill-ring)
2467 (setcar kill-ring string)
2468 (push string kill-ring)
2469 (if (> (length kill-ring) kill-ring-max)
2470 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil)))
2471 (setq kill-ring-yank-pointer kill-ring)
2472 (if interprogram-cut-function
2473 (funcall interprogram-cut-function string (not replace))))
2475 (defun kill-append (string before-p &optional yank-handler)
2476 "Append STRING to the end of the latest kill in the kill ring.
2477 If BEFORE-P is non-nil, prepend STRING to the kill.
2478 Optional third argument YANK-HANDLER, if non-nil, specifies the
2479 yank-handler text property to be set on the combined kill ring
2480 string. If the specified yank-handler arg differs from the
2481 yank-handler property of the latest kill string, this function
2482 adds the combined string to the kill ring as a new element,
2483 instead of replacing the last kill with it.
2484 If `interprogram-cut-function' is set, pass the resulting kill to it."
2485 (let* ((cur (car kill-ring)))
2486 (kill-new (if before-p (concat string cur) (concat cur string))
2487 (or (= (length cur) 0)
2488 (equal yank-handler (get-text-property 0 'yank-handler cur)))
2489 yank-handler)))
2491 (defun current-kill (n &optional do-not-move)
2492 "Rotate the yanking point by N places, and then return that kill.
2493 If N is zero, `interprogram-paste-function' is set, and calling it
2494 returns a string, then that string is added to the front of the
2495 kill ring and returned as the latest kill.
2496 If optional arg DO-NOT-MOVE is non-nil, then don't actually move the
2497 yanking point; just return the Nth kill forward."
2498 (let ((interprogram-paste (and (= n 0)
2499 interprogram-paste-function
2500 (funcall interprogram-paste-function))))
2501 (if interprogram-paste
2502 (progn
2503 ;; Disable the interprogram cut function when we add the new
2504 ;; text to the kill ring, so Emacs doesn't try to own the
2505 ;; selection, with identical text.
2506 (let ((interprogram-cut-function nil))
2507 (kill-new interprogram-paste))
2508 interprogram-paste)
2509 (or kill-ring (error "Kill ring is empty"))
2510 (let ((ARGth-kill-element
2511 (nthcdr (mod (- n (length kill-ring-yank-pointer))
2512 (length kill-ring))
2513 kill-ring)))
2514 (or do-not-move
2515 (setq kill-ring-yank-pointer ARGth-kill-element))
2516 (car ARGth-kill-element)))))
2520 ;;;; Commands for manipulating the kill ring.
2522 (defcustom kill-read-only-ok nil
2523 "*Non-nil means don't signal an error for killing read-only text."
2524 :type 'boolean
2525 :group 'killing)
2527 (put 'text-read-only 'error-conditions
2528 '(text-read-only buffer-read-only error))
2529 (put 'text-read-only 'error-message "Text is read-only")
2531 (defun kill-region (beg end &optional yank-handler)
2533 This deletes the text from the buffer and saves it in the kill ring.
2537 If you want to append the killed region to the last killed text,
2540 If the buffer is read-only, Emacs will beep and refrain from deleting
2541 the text, but put the text in the kill ring anyway. This means that
2542 you can use the killing commands to copy text from a read-only buffer.
2544 This is the primitive for programs to kill text (as opposed to deleting it).
2545 Supply two arguments, character positions indicating the stretch of text
2546 to be killed.
2548 If the previous command was also a kill command,
2549 the text killed this time appends to the text killed last time
2550 to make one entry in the kill ring.
2552 In Lisp code, optional third arg YANK-HANDLER, if non-nil,
2553 specifies the yank-handler text property to be set on the killed
2554 text. See `insert-for-yank'."
2555 ;; Pass point first, then mark, because the order matters
2556 ;; when calling kill-append.
2557 (interactive (list (point) (mark)))
2558 (unless (and beg end)
2559 (error "The mark is not set now, so there is no region"))
2560 (condition-case nil
2561 (let ((string (filter-buffer-substring beg end t)))
2562 (when string ;STRING is nil if BEG = END
2563 ;; Add that string to the kill ring, one way or another.
2564 (if (eq last-command 'kill-region)
2565 (kill-append string (< end beg) yank-handler)
2566 (kill-new string nil yank-handler)))
2567 (when (or string (eq last-command 'kill-region))
2568 (setq this-command 'kill-region))
2569 nil)
2570 ((buffer-read-only text-read-only)
2571 ;; The code above failed because the buffer, or some of the characters
2572 ;; in the region, are read-only.
2573 ;; We should beep, in case the user just isn't aware of this.
2574 ;; However, there's no harm in putting
2575 ;; the region's text in the kill ring, anyway.
2576 (copy-region-as-kill beg end)
2577 ;; Set this-command now, so it will be set even if we get an error.
2578 (setq this-command 'kill-region)
2579 ;; This should barf, if appropriate, and give us the correct error.
2580 (if kill-read-only-ok
2581 (progn (message "Read only text copied to kill ring") nil)
2582 ;; Signal an error if the buffer is read-only.
2583 (barf-if-buffer-read-only)
2584 ;; If the buffer isn't read-only, the text is.
2585 (signal 'text-read-only (list (current-buffer)))))))
2587 ;; copy-region-as-kill no longer sets this-command, because it's confusing
2588 ;; to get two copies of the text when the user accidentally types M-w and
2589 ;; then corrects it with the intended C-w.
2590 (defun copy-region-as-kill (beg end)
2591 "Save the region as if killed, but don't kill it.
2592 In Transient Mark mode, deactivate the mark.
2593 If `interprogram-cut-function' is non-nil, also save the text for a window
2594 system cut and paste."
2595 (interactive "r")
2596 (if (eq last-command 'kill-region)
2597 (kill-append (filter-buffer-substring beg end) (< end beg))
2598 (kill-new (filter-buffer-substring beg end)))
2599 (if transient-mark-mode
2600 (setq deactivate-mark t))
2601 nil)
2603 (defun kill-ring-save (beg end)
2604 "Save the region as if killed, but don't kill it.
2605 In Transient Mark mode, deactivate the mark.
2606 If `interprogram-cut-function' is non-nil, also save the text for a window
2607 system cut and paste.
2609 If you want to append the killed line to the last killed text,
2612 This command is similar to `copy-region-as-kill', except that it gives
2613 visual feedback indicating the extent of the region being copied."
2614 (interactive "r")
2615 (copy-region-as-kill beg end)
2616 ;; This use of interactive-p is correct
2617 ;; because the code it controls just gives the user visual feedback.
2618 (if (interactive-p)
2619 (let ((other-end (if (= (point) beg) end beg))
2620 (opoint (point))
2621 ;; Inhibit quitting so we can make a quit here
2622 ;; look like a C-g typed as a command.
2623 (inhibit-quit t))
2624 (if (pos-visible-in-window-p other-end (selected-window))
2625 (unless (and transient-mark-mode
2626 (face-background 'region))
2627 ;; Swap point and mark.
2628 (set-marker (mark-marker) (point) (current-buffer))
2629 (goto-char other-end)
2630 (sit-for blink-matching-delay)
2631 ;; Swap back.
2632 (set-marker (mark-marker) other-end (current-buffer))
2633 (goto-char opoint)
2634 ;; If user quit, deactivate the mark
2635 ;; as C-g would as a command.
2636 (and quit-flag mark-active
2637 (deactivate-mark)))
2638 (let* ((killed-text (current-kill 0))
2639 (message-len (min (length killed-text) 40)))
2640 (if (= (point) beg)
2641 ;; Don't say "killed"; that is misleading.
2643 (substring killed-text (- message-len)))
2645 (substring killed-text 0 message-len))))))))
2647 (defun append-next-kill (&optional interactive)
2648 "Cause following command, if it kills, to append to previous kill.
2649 The argument is used for internal purposes; do not supply one."
2650 (interactive "p")
2651 ;; We don't use (interactive-p), since that breaks kbd macros.
2652 (if interactive
2653 (progn
2654 (setq this-command 'kill-region)
2655 (message "If the next command is a kill, it will append"))
2656 (setq last-command 'kill-region)))
2657 \f
2658 ;; Yanking.
2660 ;; This is actually used in subr.el but defcustom does not work there.
2661 (defcustom yank-excluded-properties
2662 '(read-only invisible intangible field mouse-face help-echo local-map keymap
2663 yank-handler follow-link fontified)
2664 "*Text properties to discard when yanking.
2665 The value should be a list of text properties to discard or t,
2666 which means to discard all text properties."
2667 :type '(choice (const :tag "All" t) (repeat symbol))
2668 :group 'killing
2669 :version "22.1")
2671 (defvar yank-window-start nil)
2672 (defvar yank-undo-function nil
2673 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
2674 Function is called with two parameters, START and END corresponding to
2675 the value of the mark and point; it is guaranteed that START <= END.
2676 Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
2678 (defun yank-pop (&optional arg)
2679 "Replace just-yanked stretch of killed text with a different stretch.
2680 This command is allowed only immediately after a `yank' or a `yank-pop'.
2681 At such a time, the region contains a stretch of reinserted
2682 previously-killed text. `yank-pop' deletes that text and inserts in its
2683 place a different stretch of killed text.
2685 With no argument, the previous kill is inserted.
2686 With argument N, insert the Nth previous kill.
2687 If N is negative, this is a more recent kill.
2689 The sequence of kills wraps around, so that after the oldest one
2690 comes the newest one.
2692 When this command inserts killed text into the buffer, it honors
2693 `yank-excluded-properties' and `yank-handler' as described in the
2694 doc string for `insert-for-yank-1', which see."
2695 (interactive "*p")
2696 (if (not (eq last-command 'yank))
2697 (error "Previous command was not a yank"))
2698 (setq this-command 'yank)
2699 (unless arg (setq arg 1))
2700 (let ((inhibit-read-only t)
2701 (before (< (point) (mark t))))
2702 (if before
2703 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
2704 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
2705 (setq yank-undo-function nil)
2706 (set-marker (mark-marker) (point) (current-buffer))
2707 (insert-for-yank (current-kill arg))
2708 ;; Set the window start back where it was in the yank command,
2709 ;; if possible.
2710 (set-window-start (selected-window) yank-window-start t)
2711 (if before
2712 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
2713 ;; It is cleaner to avoid activation, even though the command
2714 ;; loop would deactivate the mark because we inserted text.
2715 (goto-char (prog1 (mark t)
2716 (set-marker (mark-marker) (point) (current-buffer))))))
2717 nil)
2719 (defun yank (&optional arg)
2721 More precisely, reinsert the stretch of killed text most recently
2722 killed OR yanked. Put point at end, and set mark at beginning.
2723 With just \\[universal-argument] as argument, same but put point at beginning (and mark at end).
2724 With argument N, reinsert the Nth most recently killed stretch of killed
2725 text.
2727 When this command inserts killed text into the buffer, it honors
2728 `yank-excluded-properties' and `yank-handler' as described in the
2729 doc string for `insert-for-yank-1', which see.
2732 (interactive "*P")
2733 (setq yank-window-start (window-start))
2734 ;; If we don't get all the way thru, make last-command indicate that
2735 ;; for the following command.
2736 (setq this-command t)
2737 (push-mark (point))
2738 (insert-for-yank (current-kill (cond
2739 ((listp arg) 0)
2740 ((eq arg '-) -2)
2741 (t (1- arg)))))
2742 (if (consp arg)
2743 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
2744 ;; It is cleaner to avoid activation, even though the command
2745 ;; loop would deactivate the mark because we inserted text.
2746 (goto-char (prog1 (mark t)
2747 (set-marker (mark-marker) (point) (current-buffer)))))
2748 ;; If we do get all the way thru, make this-command indicate that.
2749 (if (eq this-command t)
2750 (setq this-command 'yank))
2751 nil)
2753 (defun rotate-yank-pointer (arg)
2754 "Rotate the yanking point in the kill ring.
2755 With argument, rotate that many kills forward (or backward, if negative)."
2756 (interactive "p")
2757 (current-kill arg))
2758 \f
2759 ;; Some kill commands.
2761 ;; Internal subroutine of delete-char
2762 (defun kill-forward-chars (arg)
2763 (if (listp arg) (setq arg (car arg)))
2764 (if (eq arg '-) (setq arg -1))
2765 (kill-region (point) (forward-point arg)))
2767 ;; Internal subroutine of backward-delete-char
2768 (defun kill-backward-chars (arg)
2769 (if (listp arg) (setq arg (car arg)))
2770 (if (eq arg '-) (setq arg -1))
2771 (kill-region (point) (forward-point (- arg))))
2773 (defcustom backward-delete-char-untabify-method 'untabify
2774 "*The method for untabifying when deleting backward.
2775 Can be `untabify' -- turn a tab to many spaces, then delete one space;
2776 `hungry' -- delete all whitespace, both tabs and spaces;
2777 `all' -- delete all whitespace, including tabs, spaces and newlines;
2778 nil -- just delete one character."
2779 :type '(choice (const untabify) (const hungry) (const all) (const nil))
2780 :version "20.3"
2781 :group 'killing)
2783 (defun backward-delete-char-untabify (arg &optional killp)
2784 "Delete characters backward, changing tabs into spaces.
2785 The exact behavior depends on `backward-delete-char-untabify-method'.
2786 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
2787 Interactively, ARG is the prefix arg (default 1)
2788 and KILLP is t if a prefix arg was specified."
2790 (when (eq backward-delete-char-untabify-method 'untabify)
2791 (let ((count arg))
2792 (save-excursion
2793 (while (and (> count 0) (not (bobp)))
2795 (let ((col (current-column)))
2796 (forward-char -1)
2797 (setq col (- col (current-column)))
2798 (insert-char ?\s col)
2799 (delete-char 1)))
2800 (forward-char -1)
2801 (setq count (1- count))))))
2802 (delete-backward-char
2804 ((eq backward-delete-char-untabify-method 'all)
2806 (if skip
2807 (let ((wh (- (point) (save-excursion (skip-chars-backward skip)
2808 (point)))))
2809 (+ arg (if (zerop wh) 0 (1- wh))))
2810 arg))
2811 killp))
2813 (defun zap-to-char (arg char)
2814 "Kill up to and including ARG'th occurrence of CHAR.
2815 Case is ignored if `case-fold-search' is non-nil in the current buffer.
2816 Goes backward if ARG is negative; error if CHAR not found."
2818 (if (char-table-p translation-table-for-input)
2819 (setq char (or (aref translation-table-for-input char) char)))
2820 (kill-region (point) (progn
2821 (search-forward (char-to-string char) nil nil arg)
2822 ; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
2823 (point))))
2825 ;; kill-line and its subroutines.
2827 (defcustom kill-whole-line nil
2828 "*If non-nil, `kill-line' with no arg at beg of line kills the whole line."
2829 :type 'boolean
2830 :group 'killing)
2832 (defun kill-line (&optional arg)
2833 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
2834 With prefix argument, kill that many lines from point.
2835 Negative arguments kill lines backward.
2836 With zero argument, kills the text before point on the current line.
2839 a number counts as a prefix arg.
2841 To kill a whole line, when point is not at the beginning, type \
2844 If `kill-whole-line' is non-nil, then this command kills the whole line
2845 including its terminating newline, when used at the beginning of a line
2846 with no argument. As a consequence, you can always kill a whole line
2849 If you want to append the killed line to the last killed text,
2852 If the buffer is read-only, Emacs will beep and refrain from deleting
2853 the line, but put the line in the kill ring anyway. This means that
2854 you can use this command to copy text from a read-only buffer.
2855 \(If the variable `kill-read-only-ok' is non-nil, then this won't
2856 even beep.)"
2857 (interactive "P")
2858 (kill-region (point)
2859 ;; It is better to move point to the other end of the kill
2860 ;; before killing. That way, in a read-only buffer, point
2861 ;; moves across the text that is copied to the kill ring.
2862 ;; The choice has no effect on undo now that undo records
2863 ;; the value of point from before the command was run.
2864 (progn
2865 (if arg
2866 (forward-visible-line (prefix-numeric-value arg))
2867 (if (eobp)
2868 (signal 'end-of-buffer nil))
2869 (let ((end
2870 (save-excursion
2871 (end-of-visible-line) (point))))
2872 (if (or (save-excursion
2873 ;; If trailing whitespace is visible,
2874 ;; don't treat it as nothing.
2875 (unless show-trailing-whitespace
2877 (= (point) end))
2878 (and kill-whole-line (bolp)))
2879 (forward-visible-line 1)
2880 (goto-char end))))
2881 (point))))
2883 (defun kill-whole-line (&optional arg)
2884 "Kill current line.
2885 With prefix arg, kill that many lines starting from the current line.
2886 If arg is negative, kill backward. Also kill the preceding newline.
2888 If arg is zero, kill current line but exclude the trailing newline."
2889 (interactive "p")
2890 (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
2891 (signal 'end-of-buffer nil))
2892 (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
2893 (signal 'beginning-of-buffer nil))
2894 (unless (eq last-command 'kill-region)
2895 (kill-new "")
2896 (setq last-command 'kill-region))
2897 (cond ((zerop arg)
2898 ;; We need to kill in two steps, because the previous command
2899 ;; could have been a kill command, in which case the text
2900 ;; before point needs to be prepended to the current kill
2901 ;; ring entry and the text after point appended. Also, we
2902 ;; need to use save-excursion to avoid copying the same text
2903 ;; twice to the kill ring in read-only buffers.
2904 (save-excursion
2905 (kill-region (point) (progn (forward-visible-line 0) (point))))
2906 (kill-region (point) (progn (end-of-visible-line) (point))))
2907 ((< arg 0)
2908 (save-excursion
2909 (kill-region (point) (progn (end-of-visible-line) (point))))
2910 (kill-region (point)
2911 (progn (forward-visible-line (1+ arg))
2912 (unless (bobp) (backward-char))
2913 (point))))
2914 (t
2915 (save-excursion
2916 (kill-region (point) (progn (forward-visible-line 0) (point))))
2917 (kill-region (point)
2918 (progn (forward-visible-line arg) (point))))))
2920 (defun forward-visible-line (arg)
2921 "Move forward by ARG lines, ignoring currently invisible newlines only.
2922 If ARG is negative, move backward -ARG lines.
2923 If ARG is zero, move to the beginning of the current line."
2924 (condition-case nil
2925 (if (> arg 0)
2926 (progn
2927 (while (> arg 0)
2928 (or (zerop (forward-line 1))
2929 (signal 'end-of-buffer nil))
2930 ;; If the newline we just skipped is invisible,
2931 ;; don't count it.
2932 (let ((prop
2933 (get-char-property (1- (point)) 'invisible)))
2934 (if (if (eq buffer-invisibility-spec t)
2935 prop
2936 (or (memq prop buffer-invisibility-spec)
2937 (assq prop buffer-invisibility-spec)))
2938 (setq arg (1+ arg))))
2939 (setq arg (1- arg)))
2940 ;; If invisible text follows, and it is a number of complete lines,
2941 ;; skip it.
2942 (let ((opoint (point)))
2943 (while (and (not (eobp))
2944 (let ((prop
2945 (get-char-property (point) 'invisible)))
2946 (if (eq buffer-invisibility-spec t)
2947 prop
2948 (or (memq prop buffer-invisibility-spec)
2949 (assq prop buffer-invisibility-spec)))))
2950 (goto-char
2951 (if (get-text-property (point) 'invisible)
2952 (or (next-single-property-change (point) 'invisible)
2953 (point-max))
2954 (next-overlay-change (point)))))
2955 (unless (bolp)
2956 (goto-char opoint))))
2957 (let ((first t))
2958 (while (or first (<= arg 0))
2959 (if first
2960 (beginning-of-line)
2961 (or (zerop (forward-line -1))
2962 (signal 'beginning-of-buffer nil)))
2963 ;; If the newline we just moved to is invisible,
2964 ;; don't count it.
2965 (unless (bobp)
2966 (let ((prop
2967 (get-char-property (1- (point)) 'invisible)))
2968 (unless (if (eq buffer-invisibility-spec t)
2969 prop
2970 (or (memq prop buffer-invisibility-spec)
2971 (assq prop buffer-invisibility-spec)))
2972 (setq arg (1+ arg)))))
2973 (setq first nil))
2974 ;; If invisible text follows, and it is a number of complete lines,
2975 ;; skip it.
2976 (let ((opoint (point)))
2977 (while (and (not (bobp))
2978 (let ((prop
2979 (get-char-property (1- (point)) 'invisible)))
2980 (if (eq buffer-invisibility-spec t)
2981 prop
2982 (or (memq prop buffer-invisibility-spec)
2983 (assq prop buffer-invisibility-spec)))))
2984 (goto-char
2985 (if (get-text-property (1- (point)) 'invisible)
2986 (or (previous-single-property-change (point) 'invisible)
2987 (point-min))
2988 (previous-overlay-change (point)))))
2989 (unless (bolp)
2990 (goto-char opoint)))))
2991 ((beginning-of-buffer end-of-buffer)
2992 nil)))
2994 (defun end-of-visible-line ()
2995 "Move to end of current visible line."
2996 (end-of-line)
2997 ;; If the following character is currently invisible,
2998 ;; skip all characters with that same `invisible' property value,
2999 ;; then find the next newline.
3000 (while (and (not (eobp))
3001 (save-excursion
3003 (let ((prop
3004 (get-char-property (point) 'invisible)))
3005 (if (eq buffer-invisibility-spec t)
3006 prop
3007 (or (memq prop buffer-invisibility-spec)
3008 (assq prop buffer-invisibility-spec))))))
3010 (if (get-text-property (point) 'invisible)
3011 (goto-char (next-single-property-change (point) 'invisible))
3012 (goto-char (next-overlay-change (point))))
3013 (end-of-line)))
3014 \f
3015 (defun insert-buffer (buffer)
3016 "Insert after point the contents of BUFFER.
3017 Puts mark after the inserted text.
3018 BUFFER may be a buffer or a buffer name.
3020 This function is meant for the user to run interactively.
3021 Don't call it from programs: use `insert-buffer-substring' instead!"
3022 (interactive
3023 (list
3024 (progn
3025 (barf-if-buffer-read-only)
3026 (read-buffer "Insert buffer: "
3027 (if (eq (selected-window) (next-window (selected-window)))
3028 (other-buffer (current-buffer))
3029 (window-buffer (next-window (selected-window))))
3030 t))))
3031 (push-mark
3032 (save-excursion
3033 (insert-buffer-substring (get-buffer buffer))
3034 (point)))
3035 nil)
3037 (defun append-to-buffer (buffer start end)
3038 "Append to specified buffer the text of the region.
3039 It is inserted into that buffer before its point.
3041 When calling from a program, give three arguments:
3042 BUFFER (or buffer name), START and END.
3043 START and END specify the portion of the current buffer to be copied."
3044 (interactive
3045 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
3046 (region-beginning) (region-end)))
3047 (let ((oldbuf (current-buffer)))
3048 (save-excursion
3049 (let* ((append-to (get-buffer-create buffer))
3050 (windows (get-buffer-window-list append-to t t))
3051 point)
3052 (set-buffer append-to)
3053 (setq point (point))
3054 (barf-if-buffer-read-only)
3055 (insert-buffer-substring oldbuf start end)
3056 (dolist (window windows)
3057 (when (= (window-point window) point)
3058 (set-window-point window (point))))))))
3060 (defun prepend-to-buffer (buffer start end)
3061 "Prepend to specified buffer the text of the region.
3062 It is inserted into that buffer after its point.
3064 When calling from a program, give three arguments:
3065 BUFFER (or buffer name), START and END.
3066 START and END specify the portion of the current buffer to be copied."
3068 (let ((oldbuf (current-buffer)))
3069 (save-excursion
3070 (set-buffer (get-buffer-create buffer))
3071 (barf-if-buffer-read-only)
3072 (save-excursion
3073 (insert-buffer-substring oldbuf start end)))))
3075 (defun copy-to-buffer (buffer start end)
3076 "Copy to specified buffer the text of the region.
3077 It is inserted into that buffer, replacing existing text there.
3079 When calling from a program, give three arguments:
3080 BUFFER (or buffer name), START and END.
3081 START and END specify the portion of the current buffer to be copied."
3083 (let ((oldbuf (current-buffer)))
3084 (with-current-buffer (get-buffer-create buffer)
3085 (barf-if-buffer-read-only)
3086 (erase-buffer)
3087 (save-excursion
3088 (insert-buffer-substring oldbuf start end)))))
3089 \f
3090 (put 'mark-inactive 'error-conditions '(mark-inactive error))
3091 (put 'mark-inactive 'error-message "The mark is not active now")
3093 (defvar activate-mark-hook nil
3094 "Hook run when the mark becomes active.
3095 It is also run at the end of a command, if the mark is active and
3096 it is possible that the region may have changed.")
3098 (defvar deactivate-mark-hook nil
3099 "Hook run when the mark becomes inactive.")
3101 (defun mark (&optional force)
3102 "Return this buffer's mark value as integer, or nil if never set.
3104 In Transient Mark mode, this function signals an error if
3105 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
3106 or the argument FORCE is non-nil, it disregards whether the mark
3107 is active, and returns an integer or nil in the usual way.
3109 If you are using this in an editing command, you are most likely making
3110 a mistake; see the documentation of `set-mark'."
3111 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
3112 (marker-position (mark-marker))
3113 (signal 'mark-inactive nil)))
3115 ;; Many places set mark-active directly, and several of them failed to also
3116 ;; run deactivate-mark-hook. This shorthand should simplify.
3117 (defsubst deactivate-mark ()
3118 "Deactivate the mark by setting `mark-active' to nil.
3119 \(That makes a difference only in Transient Mark mode.)
3120 Also runs the hook `deactivate-mark-hook'."
3121 (cond
3122 ((eq transient-mark-mode 'lambda)
3123 (setq transient-mark-mode nil))
3124 (transient-mark-mode
3125 (setq mark-active nil)
3126 (run-hooks 'deactivate-mark-hook))))
3128 (defun set-mark (pos)
3129 "Set this buffer's mark to POS. Don't use this function!
3130 That is to say, don't use this function unless you want
3131 the user to see that the mark has moved, and you want the previous
3132 mark position to be lost.
3134 Normally, when a new mark is set, the old one should go on the stack.
3135 This is why most applications should use `push-mark', not `set-mark'.
3137 Novice Emacs Lisp programmers often try to use the mark for the wrong
3138 purposes. The mark saves a location for the user's convenience.
3139 Most editing commands should not alter the mark.
3140 To remember a location for internal use in the Lisp program,
3141 store it in a Lisp variable. Example:
3143 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
3145 (if pos
3146 (progn
3147 (setq mark-active t)
3148 (run-hooks 'activate-mark-hook)
3149 (set-marker (mark-marker) pos (current-buffer)))
3150 ;; Normally we never clear mark-active except in Transient Mark mode.
3151 ;; But when we actually clear out the mark value too,
3152 ;; we must clear mark-active in any mode.
3153 (setq mark-active nil)
3154 (run-hooks 'deactivate-mark-hook)
3155 (set-marker (mark-marker) nil)))
3157 (defvar mark-ring nil
3158 "The list of former marks of the current buffer, most recent first.")
3159 (make-variable-buffer-local 'mark-ring)
3160 (put 'mark-ring 'permanent-local t)
3162 (defcustom mark-ring-max 16
3163 "*Maximum size of mark ring. Start discarding off end if gets this big."
3164 :type 'integer
3165 :group 'editing-basics)
3167 (defvar global-mark-ring nil
3168 "The list of saved global marks, most recent first.")
3170 (defcustom global-mark-ring-max 16
3171 "*Maximum size of global mark ring. \
3172 Start discarding off end if gets this big."
3173 :type 'integer
3174 :group 'editing-basics)
3176 (defun pop-to-mark-command ()
3177 "Jump to mark, and pop a new position for mark off the ring
3178 \(does not affect global mark ring\)."
3179 (interactive)
3180 (if (null (mark t))
3181 (error "No mark set in this buffer")
3182 (goto-char (mark t))
3183 (pop-mark)))
3185 (defun push-mark-command (arg &optional nomsg)
3186 "Set mark at where point is.
3187 If no prefix arg and mark is already set there, just activate it.
3188 Display `Mark set' unless the optional second arg NOMSG is non-nil."
3189 (interactive "P")
3190 (let ((mark (marker-position (mark-marker))))
3191 (if (or arg (null mark) (/= mark (point)))
3192 (push-mark nil nomsg t)
3193 (setq mark-active t)
3194 (run-hooks 'activate-mark-hook)
3195 (unless nomsg
3196 (message "Mark activated")))))
3198 (defcustom set-mark-command-repeat-pop nil
3201 will pop twice."
3202 :type 'boolean
3203 :group 'editing)
3205 (defun set-mark-command (arg)
3206 "Set mark at where point is, or jump to mark.
3207 With no prefix argument, set mark, and push old mark position on local
3208 mark ring; also push mark on global mark ring if last mark was set in
3209 another buffer. Immediately repeating the command activates
3210 `transient-mark-mode' temporarily.
3213 jump to mark, and pop a new position
3214 for mark off the local mark ring \(this does not affect the global
3216 mark ring \(see `pop-global-mark'\).
3218 If `set-mark-command-repeat-pop' is non-nil, repeating
3220 off the local (or global) mark ring and jumps there.
3224 set mark where point is.
3229 Novice Emacs Lisp programmers often try to use the mark for the wrong
3230 purposes. See the documentation of `set-mark' for more information."
3231 (interactive "P")
3232 (if (eq transient-mark-mode 'lambda)
3233 (setq transient-mark-mode nil))
3234 (cond
3235 ((and (consp arg) (> (prefix-numeric-value arg) 4))
3236 (push-mark-command nil))
3237 ((not (eq this-command 'set-mark-command))
3238 (if arg
3239 (pop-to-mark-command)
3240 (push-mark-command t)))
3241 ((and set-mark-command-repeat-pop
3242 (eq last-command 'pop-to-mark-command))
3243 (setq this-command 'pop-to-mark-command)
3244 (pop-to-mark-command))
3245 ((and set-mark-command-repeat-pop
3246 (eq last-command 'pop-global-mark)
3247 (not arg))
3248 (setq this-command 'pop-global-mark)
3249 (pop-global-mark))
3250 (arg
3251 (setq this-command 'pop-to-mark-command)
3252 (pop-to-mark-command))
3253 ((and (eq last-command 'set-mark-command)
3254 mark-active (null transient-mark-mode))
3255 (setq transient-mark-mode 'lambda)
3256 (message "Transient-mark-mode temporarily enabled"))
3257 (t
3258 (push-mark-command nil))))
3260 (defun push-mark (&optional location nomsg activate)
3261 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
3262 If the last global mark pushed was not in the current buffer,
3263 also push LOCATION on the global mark ring.
3264 Display `Mark set' unless the optional second arg NOMSG is non-nil.
3265 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil.
3267 Novice Emacs Lisp programmers often try to use the mark for the wrong
3268 purposes. See the documentation of `set-mark' for more information.
3270 In Transient Mark mode, this does not activate the mark."
3271 (unless (null (mark t))
3272 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
3273 (when (> (length mark-ring) mark-ring-max)
3274 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
3275 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))
3276 (set-marker (mark-marker) (or location (point)) (current-buffer))
3277 ;; Now push the mark on the global mark ring.
3278 (if (and global-mark-ring
3279 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
3280 ;; The last global mark pushed was in this same buffer.
3281 ;; Don't push another one.
3282 nil
3283 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
3284 (when (> (length global-mark-ring) global-mark-ring-max)
3285 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring)) nil)
3286 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))
3287 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
3288 (message "Mark set"))
3289 (if (or activate (not transient-mark-mode))
3290 (set-mark (mark t)))
3291 nil)
3293 (defun pop-mark ()
3294 "Pop off mark ring into the buffer's actual mark.
3295 Does not set point. Does nothing if mark ring is empty."
3296 (when mark-ring
3297 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
3298 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
3299 (move-marker (car mark-ring) nil)
3300 (if (null (mark t)) (ding))
3301 (setq mark-ring (cdr mark-ring)))
3302 (deactivate-mark))
3304 (defalias 'exchange-dot-and-mark 'exchange-point-and-mark)
3305 (defun exchange-point-and-mark (&optional arg)
3306 "Put the mark where point is now, and point where the mark is now.
3307 This command works even when the mark is not active,
3308 and it reactivates the mark.
3309 With prefix arg, `transient-mark-mode' is enabled temporarily."
3310 (interactive "P")
3311 (if arg
3312 (if mark-active
3313 (if (null transient-mark-mode)
3314 (setq transient-mark-mode 'lambda))
3315 (setq arg nil)))
3316 (unless arg
3317 (let ((omark (mark t)))
3318 (if (null omark)
3319 (error "No mark set in this buffer"))
3320 (set-mark (point))
3321 (goto-char omark)
3322 nil)))
3324 (define-minor-mode transient-mark-mode
3325 "Toggle Transient Mark mode.
3326 With arg, turn Transient Mark mode on if arg is positive, off otherwise.
3328 In Transient Mark mode, when the mark is active, the region is highlighted.
3330 So do certain other operations that set the mark
3331 but whose main purpose is something else--for example,
3337 Many commands change their behavior when Transient Mark mode is in effect
3338 and the mark is active, by acting on the region instead of their usual
3339 default part of the buffer's text. Examples of such commands include
3344 commands which are sensitive to the Transient Mark mode."
3345 :global t :group 'editing-basics)
3347 (defvar widen-automatically t
3348 "Non-nil means it is ok for commands to call `widen' when they want to.
3349 Some commands will do this in order to go to positions outside
3350 the current accessible part of the buffer.
3352 If `widen-automatically' is nil, these commands will do something else
3353 as a fallback, and won't change the buffer bounds.")
3355 (defun pop-global-mark ()
3356 "Pop off global mark ring and jump to the top location."
3357 (interactive)
3358 ;; Pop entries which refer to non-existent buffers.
3359 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
3360 (setq global-mark-ring (cdr global-mark-ring)))
3361 (or global-mark-ring
3362 (error "No global mark set"))
3363 (let* ((marker (car global-mark-ring))
3364 (buffer (marker-buffer marker))
3365 (position (marker-position marker)))
3366 (setq global-mark-ring (nconc (cdr global-mark-ring)
3367 (list (car global-mark-ring))))
3368 (set-buffer buffer)
3369 (or (and (>= position (point-min))
3370 (<= position (point-max)))
3371 (if widen-automatically
3372 (widen)
3373 (error "Global mark position is outside accessible part of buffer")))
3374 (goto-char position)
3375 (switch-to-buffer buffer)))
3376 \f
3377 (defcustom next-line-add-newlines nil
3378 "*If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
3379 :type 'boolean
3380 :version "21.1"
3381 :group 'editing-basics)
3383 (defun next-line (&optional arg try-vscroll)
3384 "Move cursor vertically down ARG lines.
3385 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
3386 If there is no character in the target line exactly under the current column,
3387 the cursor is positioned after the character in that line which spans this
3388 column, or at the end of the line if it is not long enough.
3389 If there is no line in the buffer after this one, behavior depends on the
3390 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
3391 to create a line, and moves the cursor to that line. Otherwise it moves the
3392 cursor to the end of the buffer.
3395 a semipermanent goal column for this command.
3396 Then instead of trying to move exactly vertically (or as close as possible),
3397 this command moves to the specified goal column (or as close as possible).
3398 The goal column is stored in the variable `goal-column', which is nil
3399 when there is no goal column.
3401 If you are thinking of using this in a Lisp program, consider
3402 using `forward-line' instead. It is usually easier to use
3403 and more reliable (no dependence on goal column, etc.)."
3405 (or arg (setq arg 1))
3406 (if (and next-line-add-newlines (= arg 1))
3407 (if (save-excursion (end-of-line) (eobp))
3408 ;; When adding a newline, don't expand an abbrev.
3409 (let ((abbrev-mode nil))
3410 (end-of-line)
3412 (line-move arg nil nil try-vscroll))
3413 (if (interactive-p)
3414 (condition-case nil
3415 (line-move arg nil nil try-vscroll)
3416 ((beginning-of-buffer end-of-buffer) (ding)))
3417 (line-move arg nil nil try-vscroll)))
3418 nil)
3420 (defun previous-line (&optional arg try-vscroll)
3421 "Move cursor vertically up ARG lines.
3422 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
3423 If there is no character in the target line exactly over the current column,
3424 the cursor is positioned after the character in that line which spans this
3425 column, or at the end of the line if it is not long enough.
3428 a semipermanent goal column for this command.
3429 Then instead of trying to move exactly vertically (or as close as possible),
3430 this command moves to the specified goal column (or as close as possible).
3431 The goal column is stored in the variable `goal-column', which is nil
3432 when there is no goal column.
3434 If you are thinking of using this in a Lisp program, consider using
3435 `forward-line' with a negative argument instead. It is usually easier
3436 to use and more reliable (no dependence on goal column, etc.)."
3438 (or arg (setq arg 1))
3439 (if (interactive-p)
3440 (condition-case nil
3441 (line-move (- arg) nil nil try-vscroll)
3442 ((beginning-of-buffer end-of-buffer) (ding)))
3443 (line-move (- arg) nil nil try-vscroll))
3444 nil)
3446 (defcustom track-eol nil
3447 "*Non-nil means vertical motion starting at end of line keeps to ends of lines.
3448 This means moving to the end of each line moved onto.
3449 The beginning of a blank line does not count as the end of a line."
3450 :type 'boolean
3451 :group 'editing-basics)
3453 (defcustom goal-column nil
3455 :type '(choice integer
3456 (const :tag "None" nil))
3457 :group 'editing-basics)
3458 (make-variable-buffer-local 'goal-column)
3460 (defvar temporary-goal-column 0
3461 "Current goal column for vertical motion.
3462 It is the column where point was
3463 at the start of current run of vertical motion commands.
3464 When the `track-eol' feature is doing its job, the value is 9999.")
3466 (defcustom line-move-ignore-invisible t
3468 Outline mode sets this."
3469 :type 'boolean
3470 :group 'editing-basics)
3472 (defun line-move-invisible-p (pos)
3473 "Return non-nil if the character after POS is currently invisible."
3474 (let ((prop
3475 (get-char-property pos 'invisible)))
3476 (if (eq buffer-invisibility-spec t)
3477 prop
3478 (or (memq prop buffer-invisibility-spec)
3479 (assq prop buffer-invisibility-spec)))))
3481 ;; Returns non-nil if partial move was done.
3482 (defun line-move-partial (arg noerror to-end)
3483 (if (< arg 0)
3484 ;; Move backward (up).
3485 ;; If already vscrolled, reduce vscroll
3486 (let ((vs (window-vscroll nil t)))
3487 (when (> vs (frame-char-height))
3488 (set-window-vscroll nil (- vs (frame-char-height)) t)))
3490 ;; Move forward (down).
3491 (let* ((lh (window-line-height -1))
3492 (vpos (nth 1 lh))
3493 (ypos (nth 2 lh))
3494 (rbot (nth 3 lh))
3495 ppos py vs)
3496 (when (or (null lh)
3497 (>= rbot (frame-char-height))
3498 (<= ypos (- (frame-char-height))))
3499 (unless lh
3500 (let ((wend (pos-visible-in-window-p t nil t)))
3501 (setq rbot (nth 3 wend)
3502 vpos (nth 5 wend))))
3503 (cond
3504 ;; If last line of window is fully visible, move forward.
3505 ((or (null rbot) (= rbot 0))
3506 nil)
3507 ;; If cursor is not in the bottom scroll margin, move forward.
3508 ((and (> vpos 0)
3509 (< (setq py
3510 (or (nth 1 (window-line-height))
3511 (let ((ppos (posn-at-point)))
3512 (cdr (or (posn-actual-col-row ppos)
3513 (posn-col-row ppos))))))
3514 (min (- (window-text-height) scroll-margin 1) (1- vpos))))
3515 nil)
3516 ;; When already vscrolled, we vscroll some more if we can,
3517 ;; or clear vscroll and move forward at end of tall image.
3518 ((> (setq vs (window-vscroll nil t)) 0)
3519 (when (> rbot 0)
3520 (set-window-vscroll nil (+ vs (min rbot (frame-char-height))) t)))
3521 ;; If cursor just entered the bottom scroll margin, move forward,
3522 ;; but also vscroll one line so redisplay wont recenter.
3523 ((and (> vpos 0)
3524 (= py (min (- (window-text-height) scroll-margin 1)
3525 (1- vpos))))
3526 (set-window-vscroll nil (frame-char-height) t)
3527 (line-move-1 arg noerror to-end)
3528 t)
3529 ;; If there are lines above the last line, scroll-up one line.
3530 ((> vpos 0)
3531 (scroll-up 1)
3532 t)
3533 ;; Finally, start vscroll.
3534 (t
3535 (set-window-vscroll nil (frame-char-height) t)))))))
3538 ;; This is like line-move-1 except that it also performs
3539 ;; vertical scrolling of tall images if appropriate.
3540 ;; That is not really a clean thing to do, since it mixes
3541 ;; scrolling with cursor motion. But so far we don't have
3542 ;; a cleaner solution to the problem of making C-n do something
3543 ;; useful given a tall image.
3544 (defun line-move (arg &optional noerror to-end try-vscroll)
3545 (unless (and auto-window-vscroll try-vscroll
3546 ;; Only vscroll for single line moves
3547 (= (abs arg) 1)
3548 ;; But don't vscroll in a keyboard macro.
3549 (not defining-kbd-macro)
3550 (not executing-kbd-macro)
3551 (line-move-partial arg noerror to-end))
3552 (set-window-vscroll nil 0 t)
3553 (line-move-1 arg noerror to-end)))
3555 ;; This is the guts of next-line and previous-line.
3556 ;; Arg says how many lines to move.
3557 ;; The value is t if we can move the specified number of lines.
3558 (defun line-move-1 (arg &optional noerror to-end)
3559 ;; Don't run any point-motion hooks, and disregard intangibility,
3560 ;; for intermediate positions.
3561 (let ((inhibit-point-motion-hooks t)
3562 (opoint (point))
3563 (orig-arg arg))
3564 (unwind-protect
3565 (progn
3566 (if (not (memq last-command '(next-line previous-line)))
3567 (setq temporary-goal-column
3568 (if (and track-eol (eolp)
3569 ;; Don't count beg of empty line as end of line
3570 ;; unless we just did explicit end-of-line.
3571 (or (not (bolp)) (eq last-command 'move-end-of-line)))
3572 9999
3573 (current-column))))
3575 (if (and (not (integerp selective-display))
3576 (not line-move-ignore-invisible))
3577 ;; Use just newline characters.
3578 ;; Set ARG to 0 if we move as many lines as requested.
3579 (or (if (> arg 0)
3580 (progn (if (> arg 1) (forward-line (1- arg)))
3581 ;; This way of moving forward ARG lines
3582 ;; verifies that we have a newline after the last one.
3583 ;; It doesn't get confused by intangible text.
3584 (end-of-line)
3585 (if (zerop (forward-line 1))
3586 (setq arg 0)))
3587 (and (zerop (forward-line arg))
3588 (bolp)
3589 (setq arg 0)))
3590 (unless noerror
3591 (signal (if (< arg 0)
3592 'beginning-of-buffer
3593 'end-of-buffer)
3594 nil)))
3595 ;; Move by arg lines, but ignore invisible ones.
3596 (let (done)
3597 (while (and (> arg 0) (not done))
3598 ;; If the following character is currently invisible,
3599 ;; skip all characters with that same `invisible' property value.
3600 (while (and (not (eobp)) (line-move-invisible-p (point)))
3601 (goto-char (next-char-property-change (point))))
3602 ;; Move a line.
3603 ;; We don't use `end-of-line', since we want to escape
3604 ;; from field boundaries ocurring exactly at point.
3605 (goto-char (constrain-to-field
3606 (let ((inhibit-field-text-motion t))
3607 (line-end-position))
3608 (point) t t
3609 'inhibit-line-move-field-capture))
3610 ;; If there's no invisibility here, move over the newline.
3611 (cond
3612 ((eobp)
3613 (if (not noerror)
3614 (signal 'end-of-buffer nil)
3615 (setq done t)))
3616 ((and (> arg 1) ;; Use vertical-motion for last move
3617 (not (integerp selective-display))
3618 (not (line-move-invisible-p (point))))
3619 ;; We avoid vertical-motion when possible
3620 ;; because that has to fontify.
3621 (forward-line 1))
3622 ;; Otherwise move a more sophisticated way.
3623 ((zerop (vertical-motion 1))
3624 (if (not noerror)
3625 (signal 'end-of-buffer nil)
3626 (setq done t))))
3627 (unless done
3628 (setq arg (1- arg))))
3629 ;; The logic of this is the same as the loop above,
3630 ;; it just goes in the other direction.
3631 (while (and (< arg 0) (not done))
3632 ;; For completely consistency with the forward-motion
3633 ;; case, we should call beginning-of-line here.
3634 ;; However, if point is inside a field and on a
3635 ;; continued line, the call to (vertical-motion -1)
3636 ;; below won't move us back far enough; then we return
3637 ;; to the same column in line-move-finish, and point
3638 ;; gets stuck -- cyd
3639 (forward-line 0)
3640 (cond
3641 ((bobp)
3642 (if (not noerror)
3643 (signal 'beginning-of-buffer nil)
3644 (setq done t)))
3645 ((and (< arg -1) ;; Use vertical-motion for last move
3646 (not (integerp selective-display))
3647 (not (line-move-invisible-p (1- (point)))))
3648 (forward-line -1))
3649 ((zerop (vertical-motion -1))
3650 (if (not noerror)
3651 (signal 'beginning-of-buffer nil)
3652 (setq done t))))
3653 (unless done
3654 (setq arg (1+ arg))
3655 (while (and ;; Don't move over previous invis lines
3656 ;; if our target is the middle of this line.
3657 (or (zerop (or goal-column temporary-goal-column))
3658 (< arg 0))
3659 (not (bobp)) (line-move-invisible-p (1- (point))))
3660 (goto-char (previous-char-property-change (point))))))))
3661 ;; This is the value the function returns.
3662 (= arg 0))
3664 (cond ((> arg 0)
3665 ;; If we did not move down as far as desired,
3666 ;; at least go to end of line.
3667 (end-of-line))
3668 ((< arg 0)
3669 ;; If we did not move up as far as desired,
3670 ;; at least go to beginning of line.
3671 (beginning-of-line))
3672 (t
3673 (line-move-finish (or goal-column temporary-goal-column)
3674 opoint (> orig-arg 0)))))))
3676 (defun line-move-finish (column opoint forward)
3677 (let ((repeat t))
3678 (while repeat
3679 ;; Set REPEAT to t to repeat the whole thing.
3680 (setq repeat nil)
3682 (let (new
3683 (old (point))
3684 (line-beg (save-excursion (beginning-of-line) (point)))
3685 (line-end
3686 ;; Compute the end of the line
3687 ;; ignoring effectively invisible newlines.
3688 (save-excursion
3689 ;; Like end-of-line but ignores fields.
3691 (while (and (not (eobp)) (line-move-invisible-p (point)))
3692 (goto-char (next-char-property-change (point)))
3694 (point))))
3696 ;; Move to the desired column.
3697 (line-move-to-column column)
3699 ;; Corner case: suppose we start out in a field boundary in
3700 ;; the middle of a continued line. When we get to
3701 ;; line-move-finish, point is at the start of a new *screen*
3702 ;; line but the same text line; then line-move-to-column would
3703 ;; move us backwards. Test using C-n with point on the "x" in
3704 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
3705 (and forward
3706 (< (point) old)
3707 (goto-char old))
3709 (setq new (point))
3711 ;; Process intangibility within a line.
3712 ;; With inhibit-point-motion-hooks bound to nil, a call to
3713 ;; goto-char moves point past intangible text.
3715 ;; However, inhibit-point-motion-hooks controls both the
3716 ;; intangibility and the point-entered/point-left hooks. The
3717 ;; following hack avoids calling the point-* hooks
3718 ;; unnecessarily. Note that we move *forward* past intangible
3719 ;; text when the initial and final points are the same.
3720 (goto-char new)
3721 (let ((inhibit-point-motion-hooks nil))
3722 (goto-char new)
3724 ;; If intangibility moves us to a different (later) place
3725 ;; in the same line, use that as the destination.
3726 (if (<= (point) line-end)
3727 (setq new (point))
3728 ;; If that position is "too late",
3729 ;; try the previous allowable position.
3730 ;; See if it is ok.
3731 (backward-char)
3732 (if (if forward
3733 ;; If going forward, don't accept the previous
3734 ;; allowable position if it is before the target line.
3735 (< line-beg (point))
3736 ;; If going backward, don't accept the previous
3737 ;; allowable position if it is still after the target line.
3738 (<= (point) line-end))
3739 (setq new (point))
3740 ;; As a last resort, use the end of the line.
3741 (setq new line-end))))
3743 ;; Now move to the updated destination, processing fields
3744 ;; as well as intangibility.
3745 (goto-char opoint)
3746 (let ((inhibit-point-motion-hooks nil))
3747 (goto-char
3748 ;; Ignore field boundaries if the initial and final
3749 ;; positions have the same `field' property, even if the
3750 ;; fields are non-contiguous. This seems to be "nicer"
3751 ;; behavior in many situations.
3752 (if (eq (get-char-property new 'field)
3753 (get-char-property opoint 'field))
3754 new
3755 (constrain-to-field new opoint t t
3756 'inhibit-line-move-field-capture))))
3758 ;; If all this moved us to a different line,
3759 ;; retry everything within that new line.
3760 (when (or (< (point) line-beg) (> (point) line-end))
3761 ;; Repeat the intangibility and field processing.
3762 (setq repeat t))))))
3764 (defun line-move-to-column (col)
3765 "Try to find column COL, considering invisibility.
3766 This function works only in certain cases,
3767 because what we really need is for `move-to-column'
3768 and `current-column' to be able to ignore invisible text."
3769 (if (zerop col)
3770 (beginning-of-line)
3771 (move-to-column col))
3773 (when (and line-move-ignore-invisible
3774 (not (bolp)) (line-move-invisible-p (1- (point))))
3775 (let ((normal-location (point))
3776 (normal-column (current-column)))
3777 ;; If the following character is currently invisible,
3778 ;; skip all characters with that same `invisible' property value.
3779 (while (and (not (eobp))
3780 (line-move-invisible-p (point)))
3781 (goto-char (next-char-property-change (point))))
3782 ;; Have we advanced to a larger column position?
3783 (if (> (current-column) normal-column)
3784 ;; We have made some progress towards the desired column.
3785 ;; See if we can make any further progress.
3786 (line-move-to-column (+ (current-column) (- col normal-column)))
3787 ;; Otherwise, go to the place we originally found
3788 ;; and move back over invisible text.
3789 ;; that will get us to the same place on the screen
3790 ;; but with a more reasonable buffer position.
3791 (goto-char normal-location)
3792 (let ((line-beg (save-excursion (beginning-of-line) (point))))
3793 (while (and (not (bolp)) (line-move-invisible-p (1- (point))))
3794 (goto-char (previous-char-property-change (point) line-beg))))))))
3796 (defun move-end-of-line (arg)
3797 "Move point to end of current line as displayed.
3798 \(If there's an image in the line, this disregards newlines
3799 which are part of the text that the image rests on.)
3801 With argument ARG not nil or 1, move forward ARG - 1 lines first.
3802 If point reaches the beginning or end of buffer, it stops there.
3803 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
3804 (interactive "p")
3805 (or arg (setq arg 1))
3806 (let (done)
3807 (while (not done)
3808 (let ((newpos
3809 (save-excursion
3810 (let ((goal-column 0))
3811 (and (line-move arg t)
3812 (not (bobp))
3813 (progn
3814 (while (and (not (bobp)) (line-move-invisible-p (1- (point))))
3815 (goto-char (previous-char-property-change (point))))
3816 (backward-char 1)))
3817 (point)))))
3818 (goto-char newpos)
3819 (if (and (> (point) newpos)
3821 (backward-char 1)
3822 (if (and (> (point) newpos) (not (eobp))
3824 ;; If we skipped something intangible
3825 ;; and now we're not really at eol,
3826 ;; keep going.
3827 (setq arg 1)
3828 (setq done t)))))))
3830 (defun move-beginning-of-line (arg)
3831 "Move point to beginning of current line as displayed.
3832 \(If there's an image in the line, this disregards newlines
3833 which are part of the text that the image rests on.)
3835 With argument ARG not nil or 1, move forward ARG - 1 lines first.
3836 If point reaches the beginning or end of buffer, it stops there.
3837 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
3838 (interactive "p")
3839 (or arg (setq arg 1))
3841 (let ((orig (point))
3842 start first-vis first-vis-field-value)
3844 ;; Move by lines, if ARG is not 1 (the default).
3845 (if (/= arg 1)
3846 (line-move (1- arg) t))
3848 ;; Move to beginning-of-line, ignoring fields and invisibles.
3850 (while (and (not (bobp)) (line-move-invisible-p (1- (point))))
3851 (goto-char (previous-char-property-change (point)))
3853 (setq start (point))
3855 ;; Now find first visible char in the line
3856 (while (and (not (eobp)) (line-move-invisible-p (point)))
3857 (goto-char (next-char-property-change (point))))
3858 (setq first-vis (point))
3860 ;; See if fields would stop us from reaching FIRST-VIS.
3861 (setq first-vis-field-value
3862 (constrain-to-field first-vis orig (/= arg 1) t nil))
3864 (goto-char (if (/= first-vis-field-value first-vis)
3865 ;; If yes, obey them.
3866 first-vis-field-value
3867 ;; Otherwise, move to START with attention to fields.
3868 ;; (It is possible that fields never matter in this case.)
3869 (constrain-to-field (point) orig
3870 (/= arg 1) t nil)))))
3873 ;;; Many people have said they rarely use this feature, and often type
3874 ;;; it by accident. Maybe it shouldn't even be on a key.
3875 (put 'set-goal-column 'disabled t)
3877 (defun set-goal-column (arg)
3879 Those commands will move to this position in the line moved to
3880 rather than trying to keep the same horizontal position.
3881 With a non-nil argument, clears out the goal column
3883 The goal column is stored in the variable `goal-column'."
3884 (interactive "P")
3885 (if arg
3886 (progn
3887 (setq goal-column nil)
3888 (message "No goal column"))
3889 (setq goal-column (current-column))
3890 ;; The older method below can be erroneous if `set-goal-column' is bound
3891 ;; to a sequence containing %
3892 ;;(message (substitute-command-keys
3894 ;;goal-column)
3895 (message "%s"
3896 (concat
3897 (format "Goal column %d " goal-column)
3898 (substitute-command-keys
3901 )
3902 nil)
3903 \f
3905 (defun scroll-other-window-down (lines)
3907 For more details, see the documentation for `scroll-other-window'."
3908 (interactive "P")
3909 (scroll-other-window
3910 ;; Just invert the argument's meaning.
3911 ;; We can do that without knowing which window it will be.
3912 (if (eq lines '-) nil
3913 (if (null lines) '-
3914 (- (prefix-numeric-value lines))))))
3916 (defun beginning-of-buffer-other-window (arg)
3917 "Move point to the beginning of the buffer in the other window.
3918 Leave mark at previous position.
3919 With arg N, put point N/10 of the way from the true beginning."
3920 (interactive "P")
3921 (let ((orig-window (selected-window))
3922 (window (other-window-for-scrolling)))
3923 ;; We use unwind-protect rather than save-window-excursion
3924 ;; because the latter would preserve the things we want to change.
3925 (unwind-protect
3926 (progn
3927 (select-window window)
3928 ;; Set point and mark in that window's buffer.
3929 (with-no-warnings
3930 (beginning-of-buffer arg))
3931 ;; Set point accordingly.
3932 (recenter '(t)))
3933 (select-window orig-window))))
3935 (defun end-of-buffer-other-window (arg)
3936 "Move point to the end of the buffer in the other window.
3937 Leave mark at previous position.
3938 With arg N, put point N/10 of the way from the true end."
3939 (interactive "P")
3940 ;; See beginning-of-buffer-other-window for comments.
3941 (let ((orig-window (selected-window))
3942 (window (other-window-for-scrolling)))
3943 (unwind-protect
3944 (progn
3945 (select-window window)
3946 (with-no-warnings
3947 (end-of-buffer arg))
3948 (recenter '(t)))
3949 (select-window orig-window))))
3950 \f
3951 (defun transpose-chars (arg)
3952 "Interchange characters around point, moving forward one character.
3953 With prefix arg ARG, effect is to take character before point
3954 and drag it forward past ARG other characters (backward if ARG negative).
3955 If no argument and at end of line, the previous two chars are exchanged."
3956 (interactive "*P")
3957 (and (null arg) (eolp) (forward-char -1))
3958 (transpose-subr 'forward-char (prefix-numeric-value arg)))
3960 (defun transpose-words (arg)
3961 "Interchange words around point, leaving point at end of them.
3962 With prefix arg ARG, effect is to take word before or around point
3963 and drag it forward past ARG other words (backward if ARG negative).
3964 If ARG is zero, the words around or after point and around or after mark
3965 are interchanged."
3966 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
3967 (interactive "*p")
3968 (transpose-subr 'forward-word arg))
3970 (defun transpose-sexps (arg)
3972 Does not work on a sexp that point is in the middle of
3973 if it is a list or string."
3974 (interactive "*p")
3975 (transpose-subr
3976 (lambda (arg)
3977 ;; Here we should try to simulate the behavior of
3978 ;; (cons (progn (forward-sexp x) (point))
3979 ;; (progn (forward-sexp (- x)) (point)))
3980 ;; Except that we don't want to rely on the second forward-sexp
3981 ;; putting us back to where we want to be, since forward-sexp-function
3982 ;; might do funny things like infix-precedence.
3983 (if (if (> arg 0)
3985 (and (not (bobp))
3987 ;; Jumping over a symbol. We might be inside it, mind you.
3988 (progn (funcall (if (> arg 0)
3989 'skip-syntax-backward 'skip-syntax-forward)
3990 "w_")
3991 (cons (save-excursion (forward-sexp arg) (point)) (point)))
3992 ;; Otherwise, we're between sexps. Take a step back before jumping
3993 ;; to make sure we'll obey the same precedence no matter which direction
3994 ;; we're going.
3995 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
3996 (cons (save-excursion (forward-sexp arg) (point))
3997 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
3998 (not (zerop (funcall (if (> arg 0)
3999 'skip-syntax-forward
4000 'skip-syntax-backward)
4001 ".")))))
4002 (point)))))
4003 arg 'special))
4005 (defun transpose-lines (arg)
4006 "Exchange current line and previous line, leaving point after both.
4007 With argument ARG, takes previous line and moves it past ARG lines.
4008 With argument 0, interchanges line point is in with line mark is in."
4009 (interactive "*p")
4010 (transpose-subr (function
4011 (lambda (arg)
4012 (if (> arg 0)
4013 (progn
4014 ;; Move forward over ARG lines,
4015 ;; but create newlines if necessary.
4016 (setq arg (forward-line arg))
4018 (setq arg (1+ arg)))
4019 (if (> arg 0)
4020 (newline arg)))
4021 (forward-line arg))))
4022 arg))
4024 (defun transpose-subr (mover arg &optional special)
4025 (let ((aux (if special mover
4026 (lambda (x)
4027 (cons (progn (funcall mover x) (point))
4028 (progn (funcall mover (- x)) (point))))))
4029 pos1 pos2)
4030 (cond
4031 ((= arg 0)
4032 (save-excursion
4033 (setq pos1 (funcall aux 1))
4034 (goto-char (mark))
4035 (setq pos2 (funcall aux 1))
4036 (transpose-subr-1 pos1 pos2))
4037 (exchange-point-and-mark))
4038 ((> arg 0)
4039 (setq pos1 (funcall aux -1))
4040 (setq pos2 (funcall aux arg))
4041 (transpose-subr-1 pos1 pos2)
4042 (goto-char (car pos2)))
4043 (t
4044 (setq pos1 (funcall aux -1))
4045 (goto-char (car pos1))
4046 (setq pos2 (funcall aux arg))
4047 (transpose-subr-1 pos1 pos2)))))
4049 (defun transpose-subr-1 (pos1 pos2)
4050 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
4051 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
4052 (when (> (car pos1) (car pos2))
4053 (let ((swap pos1))
4054 (setq pos1 pos2 pos2 swap)))
4055 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
4056 (atomic-change-group
4057 (let (word2)
4058 ;; FIXME: We first delete the two pieces of text, so markers that
4059 ;; used to point to after the text end up pointing to before it :-(
4060 (setq word2 (delete-and-extract-region (car pos2) (cdr pos2)))
4061 (goto-char (car pos2))
4062 (insert (delete-and-extract-region (car pos1) (cdr pos1)))
4063 (goto-char (car pos1))
4064 (insert word2))))
4065 \f
4066 (defun backward-word (&optional arg)
4067 "Move backward until encountering the beginning of a word.
4068 With argument, do this that many times."
4069 (interactive "p")
4070 (forward-word (- (or arg 1))))
4072 (defun mark-word (&optional arg allow-extend)
4073 "Set mark ARG words away from point.
4075 move to with the same argument.
4076 Interactively, if this command is repeated
4077 or (in Transient Mark mode) if the mark is active,
4078 it marks the next ARG words after the ones already marked."
4080 (cond ((and allow-extend
4081 (or (and (eq last-command this-command) (mark t))
4082 (and transient-mark-mode mark-active)))
4083 (setq arg (if arg (prefix-numeric-value arg)
4084 (if (< (mark) (point)) -1 1)))
4085 (set-mark
4086 (save-excursion
4087 (goto-char (mark))
4088 (forward-word arg)
4089 (point))))
4090 (t
4091 (push-mark
4092 (save-excursion
4093 (forward-word (prefix-numeric-value arg))
4094 (point))
4095 nil t))))
4097 (defun kill-word (arg)
4098 "Kill characters forward until encountering the end of a word.
4099 With argument, do this that many times."
4100 (interactive "p")
4101 (kill-region (point) (progn (forward-word arg) (point))))
4103 (defun backward-kill-word (arg)
4104 "Kill characters backward until encountering the beginning of a word.
4105 With argument, do this that many times."
4106 (interactive "p")
4107 (kill-word (- arg)))
4109 (defun current-word (&optional strict really-word)
4110 "Return the symbol or word that point is on (or a nearby one) as a string.
4111 The return value includes no text properties.
4112 If optional arg STRICT is non-nil, return nil unless point is within
4113 or adjacent to a symbol or word. In all cases the value can be nil
4114 if there is no word nearby.
4115 The function, belying its name, normally finds a symbol.
4116 If optional arg REALLY-WORD is non-nil, it finds just a word."
4117 (save-excursion
4118 (let* ((oldpoint (point)) (start (point)) (end (point))
4119 (syntaxes (if really-word "w" "w_"))
4120 (not-syntaxes (concat "^" syntaxes)))
4121 (skip-syntax-backward syntaxes) (setq start (point))
4122 (goto-char oldpoint)
4123 (skip-syntax-forward syntaxes) (setq end (point))
4124 (when (and (eq start oldpoint) (eq end oldpoint)
4125 ;; Point is neither within nor adjacent to a word.
4126 (not strict))
4127 ;; Look for preceding word in same line.
4128 (skip-syntax-backward not-syntaxes
4129 (save-excursion (beginning-of-line)
4130 (point)))
4131 (if (bolp)
4132 ;; No preceding word in same line.
4133 ;; Look for following word in same line.
4134 (progn
4135 (skip-syntax-forward not-syntaxes
4136 (save-excursion (end-of-line)
4137 (point)))
4138 (setq start (point))
4139 (skip-syntax-forward syntaxes)
4140 (setq end (point)))
4141 (setq end (point))
4142 (skip-syntax-backward syntaxes)
4143 (setq start (point))))
4144 ;; If we found something nonempty, return it as a string.
4145 (unless (= start end)
4146 (buffer-substring-no-properties start end)))))
4147 \f
4148 (defcustom fill-prefix nil
4149 "*String for filling to insert at front of new line, or nil for none."
4150 :type '(choice (const :tag "None" nil)
4151 string)
4152 :group 'fill)
4153 (make-variable-buffer-local 'fill-prefix)
4154 ;;;###autoload(put 'fill-prefix 'safe-local-variable 'string-or-null-p)
4156 (defcustom auto-fill-inhibit-regexp nil
4157 "*Regexp to match lines which should not be auto-filled."
4158 :type '(choice (const :tag "None" nil)
4159 regexp)
4160 :group 'fill)
4162 (defvar comment-line-break-function 'comment-indent-new-line
4163 "*Mode-specific function which line breaks and continues a comment.
4165 This function is only called during auto-filling of a comment section.
4166 The function should take a single optional argument, which is a flag
4167 indicating whether it should use soft newlines.")
4169 ;; This function is used as the auto-fill-function of a buffer
4170 ;; when Auto-Fill mode is enabled.
4171 ;; It returns t if it really did any work.
4172 ;; (Actually some major modes use a different auto-fill function,
4173 ;; but this one is the default one.)
4174 (defun do-auto-fill ()
4175 (let (fc justify give-up
4176 (fill-prefix fill-prefix))
4177 (if (or (not (setq justify (current-justification)))
4178 (null (setq fc (current-fill-column)))
4179 (and (eq justify 'left)
4180 (<= (current-column) fc))
4181 (and auto-fill-inhibit-regexp
4182 (save-excursion (beginning-of-line)
4183 (looking-at auto-fill-inhibit-regexp))))
4184 nil ;; Auto-filling not required
4185 (if (memq justify '(full center right))
4186 (save-excursion (unjustify-current-line)))
4188 ;; Choose a fill-prefix automatically.
4189 (when (and adaptive-fill-mode
4190 (or (null fill-prefix) (string= fill-prefix "")))
4191 (let ((prefix
4192 (fill-context-prefix
4193 (save-excursion (backward-paragraph 1) (point))
4194 (save-excursion (forward-paragraph 1) (point)))))
4195 (and prefix (not (equal prefix ""))
4196 ;; Use auto-indentation rather than a guessed empty prefix.
4197 (not (and fill-indent-according-to-mode
4199 (setq fill-prefix prefix))))
4201 (while (and (not give-up) (> (current-column) fc))
4202 ;; Determine where to split the line.
4203 (let* (after-prefix
4204 (fill-point
4205 (save-excursion
4206 (beginning-of-line)
4207 (setq after-prefix (point))
4208 (and fill-prefix
4209 (looking-at (regexp-quote fill-prefix))
4210 (setq after-prefix (match-end 0)))
4211 (move-to-column (1+ fc))
4212 (fill-move-to-break-point after-prefix)
4213 (point))))
4215 ;; See whether the place we found is any good.
4216 (if (save-excursion
4217 (goto-char fill-point)
4218 (or (bolp)
4219 ;; There is no use breaking at end of line.
4220 (save-excursion (skip-chars-forward " ") (eolp))
4221 ;; It is futile to split at the end of the prefix
4222 ;; since we would just insert the prefix again.
4223 (and after-prefix (<= (point) after-prefix))
4224 ;; Don't split right after a comment starter
4225 ;; since we would just make another comment starter.
4226 (and comment-start-skip
4227 (let ((limit (point)))
4228 (beginning-of-line)
4229 (and (re-search-forward comment-start-skip
4230 limit t)
4231 (eq (point) limit))))))
4232 ;; No good place to break => stop trying.
4233 (setq give-up t)
4234 ;; Ok, we have a useful place to break the line. Do it.
4235 (let ((prev-column (current-column)))
4236 ;; If point is at the fill-point, do not `save-excursion'.
4237 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
4238 ;; point will end up before it rather than after it.
4239 (if (save-excursion
4241 (= (point) fill-point))
4242 (funcall comment-line-break-function t)
4243 (save-excursion
4244 (goto-char fill-point)
4245 (funcall comment-line-break-function t)))
4246 ;; Now do justification, if required
4247 (if (not (eq justify 'left))
4248 (save-excursion
4249 (end-of-line 0)
4250 (justify-current-line justify nil t)))
4251 ;; If making the new line didn't reduce the hpos of
4252 ;; the end of the line, then give up now;
4253 ;; trying again will not help.
4254 (if (>= (current-column) prev-column)
4255 (setq give-up t))))))
4256 ;; Justify last line.
4257 (justify-current-line justify t t)
4258 t)))
4260 (defvar normal-auto-fill-function 'do-auto-fill
4261 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
4262 Some major modes set this.")
4264 (put 'auto-fill-function :minor-mode-function 'auto-fill-mode)
4265 ;; FIXME: turn into a proper minor mode.
4266 ;; Add a global minor mode version of it.
4267 (defun auto-fill-mode (&optional arg)
4268 "Toggle Auto Fill mode.
4269 With arg, turn Auto Fill mode on if and only if arg is positive.
4270 In Auto Fill mode, inserting a space at a column beyond `current-fill-column'
4271 automatically breaks the line at a previous space.
4273 The value of `normal-auto-fill-function' specifies the function to use
4274 for `auto-fill-function' when turning Auto Fill mode on."
4275 (interactive "P")
4276 (prog1 (setq auto-fill-function
4277 (if (if (null arg)
4278 (not auto-fill-function)
4279 (> (prefix-numeric-value arg) 0))
4280 normal-auto-fill-function
4281 nil))
4282 (force-mode-line-update)))
4284 ;; This holds a document string used to document auto-fill-mode.
4285 (defun auto-fill-function ()
4286 "Automatically break line at a previous space, in insertion of text."
4287 nil)
4289 (defun turn-on-auto-fill ()
4290 "Unconditionally turn on Auto Fill mode."
4291 (auto-fill-mode 1))
4293 (defun turn-off-auto-fill ()
4294 "Unconditionally turn off Auto Fill mode."
4295 (auto-fill-mode -1))
4297 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
4299 (defun set-fill-column (arg)
4300 "Set `fill-column' to specified argument.
4303 (interactive "P")
4304 (if (consp arg)
4305 (setq arg (current-column)))
4306 (if (not (integerp arg))
4307 ;; Disallow missing argument; it's probably a typo for C-x C-f.
4308 (error "set-fill-column requires an explicit argument")
4309 (message "Fill column set to %d (was %d)" arg fill-column)
4310 (setq fill-column arg)))
4311 \f
4312 (defun set-selective-display (arg)
4313 "Set `selective-display' to ARG; clear it if no arg.
4314 When the value of `selective-display' is a number > 0,
4315 lines whose indentation is >= that value are not displayed.
4316 The variable `selective-display' has a separate value for each buffer."
4317 (interactive "P")
4318 (if (eq selective-display t)
4319 (error "selective-display already in use for marked lines"))
4320 (let ((current-vpos
4321 (save-restriction
4322 (narrow-to-region (point-min) (point))
4323 (goto-char (window-start))
4324 (vertical-motion (window-height)))))
4325 (setq selective-display
4326 (and arg (prefix-numeric-value arg)))
4327 (recenter current-vpos))
4328 (set-window-start (selected-window) (window-start (selected-window)))
4329 (princ "selective-display set to " t)
4330 (prin1 selective-display t)
4331 (princ "." t))
4333 (defvaralias 'indicate-unused-lines 'indicate-empty-lines)
4334 (defvaralias 'default-indicate-unused-lines 'default-indicate-empty-lines)
4336 (defun toggle-truncate-lines (&optional arg)
4337 "Toggle whether to fold or truncate long lines for the current buffer.
4338 With arg, truncate long lines iff arg is positive.
4339 Note that in side-by-side windows, truncation is always enabled."
4340 (interactive "P")
4341 (setq truncate-lines
4342 (if (null arg)
4343 (not truncate-lines)
4344 (> (prefix-numeric-value arg) 0)))
4345 (force-mode-line-update)
4346 (unless truncate-lines
4347 (let ((buffer (current-buffer)))
4348 (walk-windows (lambda (window)
4349 (if (eq buffer (window-buffer window))
4350 (set-window-hscroll window 0)))
4351 nil t)))
4352 (message "Truncate long lines %s"
4353 (if truncate-lines "enabled" "disabled")))
4355 (defvar overwrite-mode-textual " Ovwrt"
4356 "The string displayed in the mode line when in overwrite mode.")
4357 (defvar overwrite-mode-binary " Bin Ovwrt"
4358 "The string displayed in the mode line when in binary overwrite mode.")
4360 (defun overwrite-mode (arg)
4361 "Toggle overwrite mode.
4362 With arg, turn overwrite mode on iff arg is positive.
4363 In overwrite mode, printing characters typed in replace existing text
4364 on a one-for-one basis, rather than pushing it to the right. At the
4365 end of a line, such characters extend the line. Before a tab,
4366 such characters insert until the tab is filled in.
4368 is supposed to make it easier to insert characters when necessary."
4369 (interactive "P")
4370 (setq overwrite-mode
4371 (if (if (null arg) (not overwrite-mode)
4372 (> (prefix-numeric-value arg) 0))
4373 'overwrite-mode-textual))
4374 (force-mode-line-update))
4376 (defun binary-overwrite-mode (arg)
4377 "Toggle binary overwrite mode.
4378 With arg, turn binary overwrite mode on iff arg is positive.
4379 In binary overwrite mode, printing characters typed in replace
4380 existing text. Newlines are not treated specially, so typing at the
4381 end of a line joins the line to the next, with the typed character
4382 between them. Typing before a tab character simply replaces the tab
4383 with the character typed.
4385 typing characters do.
4387 Note that binary overwrite mode is not its own minor mode; it is a
4388 specialization of overwrite mode, entered by setting the
4389 `overwrite-mode' variable to `overwrite-mode-binary'."
4390 (interactive "P")
4391 (setq overwrite-mode
4392 (if (if (null arg)
4393 (not (eq overwrite-mode 'overwrite-mode-binary))
4394 (> (prefix-numeric-value arg) 0))
4395 'overwrite-mode-binary))
4396 (force-mode-line-update))
4398 (define-minor-mode line-number-mode
4399 "Toggle Line Number mode.
4400 With arg, turn Line Number mode on iff arg is positive.
4401 When Line Number mode is enabled, the line number appears
4402 in the mode line.
4404 Line numbers do not appear for very large buffers and buffers
4405 with very long lines; see variables `line-number-display-limit'
4406 and `line-number-display-limit-width'."
4407 :init-value t :global t :group 'mode-line)
4409 (define-minor-mode column-number-mode
4410 "Toggle Column Number mode.
4411 With arg, turn Column Number mode on iff arg is positive.
4412 When Column Number mode is enabled, the column number appears
4413 in the mode line."
4414 :global t :group 'mode-line)
4416 (define-minor-mode size-indication-mode
4417 "Toggle Size Indication mode.
4418 With arg, turn Size Indication mode on iff arg is positive. When
4419 Size Indication mode is enabled, the size of the accessible part
4420 of the buffer appears in the mode line."
4421 :global t :group 'mode-line)
4422 \f
4423 (defgroup paren-blinking nil
4424 "Blinking matching of parens and expressions."
4425 :prefix "blink-matching-"
4426 :group 'paren-matching)
4428 (defcustom blink-matching-paren t
4429 "*Non-nil means show matching open-paren when close-paren is inserted."
4430 :type 'boolean
4431 :group 'paren-blinking)
4433 (defcustom blink-matching-paren-on-screen t
4434 "*Non-nil means show matching open-paren when it is on screen.
4435 If nil, don't show it (but the open-paren can still be shown
4436 when it is off screen).
4438 This variable has no effect if `blink-matching-paren' is nil.
4439 \(In that case, the open-paren is never shown.)
4440 It is also ignored if `show-paren-mode' is enabled."
4441 :type 'boolean
4442 :group 'paren-blinking)
4444 (defcustom blink-matching-paren-distance (* 25 1024)
4445 "*If non-nil, maximum distance to search backwards for matching open-paren.
4446 If nil, search stops at the beginning of the accessible portion of the buffer."
4447 :type '(choice (const nil) integer)
4448 :group 'paren-blinking)
4450 (defcustom blink-matching-delay 1
4451 "*Time in seconds to delay after showing a matching paren."
4452 :type 'number
4453 :group 'paren-blinking)
4455 (defcustom blink-matching-paren-dont-ignore-comments nil
4456 "*If nil, `blink-matching-paren' ignores comments.
4457 More precisely, when looking for the matching parenthesis,
4458 it skips the contents of comments that end before point."
4459 :type 'boolean
4460 :group 'paren-blinking)
4462 (defun blink-matching-open ()
4463 "Move cursor momentarily to the beginning of the sexp before point."
4464 (interactive)
4465 (when (and (> (point) (point-min))
4466 blink-matching-paren
4467 ;; Verify an even number of quoting characters precede the close.
4468 (= 1 (logand 1 (- (point)
4469 (save-excursion
4470 (forward-char -1)
4472 (point))))))
4473 (let* ((oldpos (point))
4474 blinkpos
4475 message-log-max ; Don't log messages about paren matching.
4476 matching-paren
4477 open-paren-line-string)
4478 (save-excursion
4479 (save-restriction
4480 (if blink-matching-paren-distance
4481 (narrow-to-region (max (minibuffer-prompt-end)
4482 (- (point) blink-matching-paren-distance))
4483 oldpos))
4484 (condition-case ()
4485 (let ((parse-sexp-ignore-comments
4486 (and parse-sexp-ignore-comments
4487 (not blink-matching-paren-dont-ignore-comments))))
4488 (setq blinkpos (scan-sexps oldpos -1)))
4489 (error nil)))
4490 (and blinkpos
4491 ;; Not syntax '$'.
4492 (not (eq (syntax-class (syntax-after blinkpos)) 8))
4493 (setq matching-paren
4494 (let ((syntax (syntax-after blinkpos)))
4495 (and (consp syntax)
4496 (eq (syntax-class syntax) 4)
4497 (cdr syntax)))))
4498 (cond
4499 ((not (or (eq matching-paren (char-before oldpos))
4500 ;; The cdr might hold a new paren-class info rather than
4501 ;; a matching-char info, in which case the two CDRs
4502 ;; should match.
4503 (eq matching-paren (cdr (syntax-after (1- oldpos))))))
4504 (message "Mismatched parentheses"))
4505 ((not blinkpos)
4506 (if (not blink-matching-paren-distance)
4507 (message "Unmatched parenthesis")))
4508 ((pos-visible-in-window-p blinkpos)
4509 ;; Matching open within window, temporarily move to blinkpos but only
4510 ;; if `blink-matching-paren-on-screen' is non-nil.
4511 (and blink-matching-paren-on-screen
4512 (not show-paren-mode)
4513 (save-excursion
4514 (goto-char blinkpos)
4515 (sit-for blink-matching-delay))))
4516 (t
4517 (save-excursion
4518 (goto-char blinkpos)
4519 (setq open-paren-line-string
4520 ;; Show what precedes the open in its line, if anything.
4521 (if (save-excursion
4523 (not (bolp)))
4524 (buffer-substring (line-beginning-position)
4525 (1+ blinkpos))
4526 ;; Show what follows the open in its line, if anything.
4527 (if (save-excursion
4528 (forward-char 1)
4530 (not (eolp)))
4531 (buffer-substring blinkpos
4532 (line-end-position))
4533 ;; Otherwise show the previous nonblank line,
4534 ;; if there is one.
4535 (if (save-excursion
4537 (not (bobp)))
4538 (concat
4539 (buffer-substring (progn
4541 (line-beginning-position))
4542 (progn (end-of-line)
4544 (point)))
4545 ;; Replace the newline and other whitespace with `...'.
4546 "..."
4547 (buffer-substring blinkpos (1+ blinkpos)))
4548 ;; There is nothing to show except the char itself.
4549 (buffer-substring blinkpos (1+ blinkpos)))))))
4550 (message "Matches %s"
4551 (substring-no-properties open-paren-line-string))))))))
4553 ;Turned off because it makes dbx bomb out.
4554 (setq blink-paren-function 'blink-matching-open)
4555 \f
4556 ;; This executes C-g typed while Emacs is waiting for a command.
4557 ;; Quitting out of a program does not go through here;
4558 ;; that happens in the QUIT macro at the C code level.
4559 (defun keyboard-quit ()
4560 "Signal a `quit' condition.
4561 During execution of Lisp code, this character causes a quit directly.
4562 At top-level, as an editor command, this simply beeps."
4563 (interactive)
4564 (deactivate-mark)
4565 (if (fboundp 'kmacro-keyboard-quit)
4566 (kmacro-keyboard-quit))
4567 (setq defining-kbd-macro nil)
4568 (signal 'quit nil))
4570 (defvar buffer-quit-function nil
4573 \(such as cancelling a prefix argument, minibuffer or region) do not apply.")
4575 (defun keyboard-escape-quit ()
4577 This command can exit an interactive command such as `query-replace',
4578 can clear out a prefix argument or a region,
4579 can get out of the minibuffer or other recursive edit,
4580 cancel the use of the current buffer (for special-purpose buffers),
4581 or go back to just one window (by deleting all but the selected window)."
4582 (interactive)
4583 (cond ((eq last-command 'mode-exited) nil)
4584 ((> (minibuffer-depth) 0)
4585 (abort-recursive-edit))
4586 (current-prefix-arg
4587 nil)
4588 ((and transient-mark-mode mark-active)
4589 (deactivate-mark))
4590 ((> (recursion-depth) 0)
4591 (exit-recursive-edit))
4592 (buffer-quit-function
4593 (funcall buffer-quit-function))
4594 ((not (one-window-p t))
4595 (delete-other-windows))
4597 (bury-buffer))))
4599 (defun play-sound-file (file &optional volume device)
4600 "Play sound stored in FILE.
4601 VOLUME and DEVICE correspond to the keywords of the sound
4602 specification for `play-sound'."
4603 (interactive "fPlay sound file: ")
4604 (let ((sound (list :file file)))
4605 (if volume
4606 (plist-put sound :volume volume))
4607 (if device
4608 (plist-put sound :device device))
4609 (push 'sound sound)
4610 (play-sound sound)))
4612 \f
4613 (defcustom read-mail-command 'rmail
4614 "*Your preference for a mail reading package.
4615 This is used by some keybindings which support reading mail.
4616 See also `mail-user-agent' concerning sending mail."
4617 :type '(choice (function-item rmail)
4618 (function-item gnus)
4619 (function-item mh-rmail)
4620 (function :tag "Other"))
4621 :version "21.1"
4622 :group 'mail)
4624 (defcustom mail-user-agent 'sendmail-user-agent
4625 "*Your preference for a mail composition package.
4626 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
4627 outgoing email message. This variable lets you specify which
4628 mail-sending package you prefer.
4630 Valid values include:
4632 `sendmail-user-agent' -- use the default Emacs Mail package.
4633 See Info node `(emacs)Sending Mail'.
4634 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
4635 See Info node `(mh-e)'.
4636 `message-user-agent' -- use the Gnus Message package.
4637 See Info node `(message)'.
4638 `gnus-user-agent' -- like `message-user-agent', but with Gnus
4639 paraphernalia, particularly the Gcc: header for
4640 archiving.
4642 Additional valid symbols may be available; check with the author of
4643 your package for details. The function should return non-nil if it
4644 succeeds.
4646 See also `read-mail-command' concerning reading mail."
4647 :type '(radio (function-item :tag "Default Emacs mail"
4649 sendmail-user-agent)
4650 (function-item :tag "Emacs interface to MH"
4652 mh-e-user-agent)
4653 (function-item :tag "Gnus Message package"
4655 message-user-agent)
4656 (function-item :tag "Gnus Message with full Gnus features"
4658 gnus-user-agent)
4659 (function :tag "Other"))
4660 :group 'mail)
4662 (define-mail-user-agent 'sendmail-user-agent
4663 'sendmail-user-agent-compose
4664 'mail-send-and-exit)
4666 (defun rfc822-goto-eoh ()
4667 ;; Go to header delimiter line in a mail message, following RFC822 rules
4668 (goto-char (point-min))
4669 (when (re-search-forward
4671 (goto-char (match-beginning 0))))
4673 (defun sendmail-user-agent-compose (&optional to subject other-headers continue
4674 switch-function yank-action
4675 send-actions)
4676 (if switch-function
4677 (let ((special-display-buffer-names nil)
4678 (special-display-regexps nil)
4679 (same-window-buffer-names nil)
4680 (same-window-regexps nil))
4681 (funcall switch-function "*mail*")))
4682 (let ((cc (cdr (assoc-string "cc" other-headers t)))
4683 (in-reply-to (cdr (assoc-string "in-reply-to" other-headers t)))
4684 (body (cdr (assoc-string "body" other-headers t))))
4685 (or (mail continue to subject in-reply-to cc yank-action send-actions)
4686 continue
4687 (error "Message aborted"))
4688 (save-excursion
4689 (rfc822-goto-eoh)
4690 (while other-headers
4691 (unless (member-ignore-case (car (car other-headers))
4692 '("in-reply-to" "cc" "body"))
4693 (insert (car (car other-headers)) ": "
4694 (cdr (car other-headers))
4696 (setq other-headers (cdr other-headers)))
4697 (when body
4698 (forward-line 1)
4699 (insert body))
4700 t)))
4702 (defun compose-mail (&optional to subject other-headers continue
4703 switch-function yank-action send-actions)
4704 "Start composing a mail message to send.
4705 This uses the user's chosen mail composition package
4706 as selected with the variable `mail-user-agent'.
4707 The optional arguments TO and SUBJECT specify recipients
4708 and the initial Subject field, respectively.
4710 OTHER-HEADERS is an alist specifying additional
4711 header fields. Elements look like (HEADER . VALUE) where both
4712 HEADER and VALUE are strings.
4714 CONTINUE, if non-nil, says to continue editing a message already
4715 being composed.
4717 SWITCH-FUNCTION, if non-nil, is a function to use to
4718 switch to and display the buffer used for mail composition.
4720 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
4721 to insert the raw text of the message being replied to.
4722 It has the form (FUNCTION . ARGS). The user agent will apply
4723 FUNCTION to ARGS, to insert the raw text of the original message.
4724 \(The user agent will also run `mail-citation-hook', *after* the
4725 original text has been inserted in this way.)
4727 SEND-ACTIONS is a list of actions to call when the message is sent.
4728 Each action has the form (FUNCTION . ARGS)."
4729 (interactive
4730 (list nil nil nil current-prefix-arg))
4731 (let ((function (get mail-user-agent 'composefunc)))
4732 (funcall function to subject other-headers continue
4733 switch-function yank-action send-actions)))
4735 (defun compose-mail-other-window (&optional to subject other-headers continue
4736 yank-action send-actions)
4738 (interactive
4739 (list nil nil nil current-prefix-arg))
4740 (compose-mail to subject other-headers continue
4741 'switch-to-buffer-other-window yank-action send-actions))
4744 (defun compose-mail-other-frame (&optional to subject other-headers continue
4745 yank-action send-actions)
4747 (interactive
4748 (list nil nil nil current-prefix-arg))
4749 (compose-mail to subject other-headers continue
4750 'switch-to-buffer-other-frame yank-action send-actions))
4751 \f
4752 (defvar set-variable-value-history nil
4753 "History of values entered with `set-variable'.")
4755 (defun set-variable (variable value &optional make-local)
4756 "Set VARIABLE to VALUE. VALUE is a Lisp object.
4757 VARIABLE should be a user option variable name, a Lisp variable
4758 meant to be customized by users. You should enter VALUE in Lisp syntax,
4759 so if you want VALUE to be a string, you must surround it with doublequotes.
4760 VALUE is used literally, not evaluated.
4762 If VARIABLE has a `variable-interactive' property, that is used as if
4763 it were the arg to `interactive' (which see) to interactively read VALUE.
4765 If VARIABLE has been defined with `defcustom', then the type information
4766 in the definition is used to check that VALUE is valid.
4768 With a prefix argument, set VARIABLE to VALUE buffer-locally."
4769 (interactive
4770 (let* ((default-var (variable-at-point))
4771 (var (if (user-variable-p default-var)
4772 (read-variable (format "Set variable (default %s): " default-var)
4773 default-var)
4774 (read-variable "Set variable: ")))
4775 (minibuffer-help-form '(describe-variable var))
4776 (prop (get var 'variable-interactive))
4777 (obsolete (car (get var 'byte-obsolete-variable)))
4778 (prompt (format "Set %s %s to value: " var
4779 (cond ((local-variable-p var)
4780 "(buffer-local)")
4781 ((or current-prefix-arg
4782 (local-variable-if-set-p var))
4783 "buffer-locally")
4784 (t "globally"))))
4785 (val (progn
4786 (when obsolete
4787 (message (concat "`%S' is obsolete; "
4788 (if (symbolp obsolete) "use `%S' instead" "%s"))
4789 var obsolete)
4790 (sit-for 3))
4791 (if prop
4792 ;; Use VAR's `variable-interactive' property
4793 ;; as an interactive spec for prompting.
4794 (call-interactively `(lambda (arg)
4795 (interactive ,prop)
4796 arg))
4797 (read
4798 (read-string prompt nil
4799 'set-variable-value-history
4800 (format "%S" (symbol-value var))))))))
4801 (list var val current-prefix-arg)))
4803 (and (custom-variable-p variable)
4804 (not (get variable 'custom-type))
4805 (custom-load-symbol variable))
4806 (let ((type (get variable 'custom-type)))
4807 (when type
4808 ;; Match with custom type.
4809 (require 'cus-edit)
4810 (setq type (widget-convert type))
4811 (unless (widget-apply type :match value)
4812 (error "Value `%S' does not match type %S of %S"
4813 value (car type) variable))))
4815 (if make-local
4816 (make-local-variable variable))
4818 (set variable value)
4820 ;; Force a thorough redisplay for the case that the variable
4821 ;; has an effect on the display, like `tab-width' has.
4822 (force-mode-line-update))
4823 \f
4824 ;; Define the major mode for lists of completions.
4826 (defvar completion-list-mode-map nil
4827 "Local map for completion list buffers.")
4828 (or completion-list-mode-map
4829 (let ((map (make-sparse-keymap)))
4830 (define-key map [mouse-2] 'mouse-choose-completion)
4831 (define-key map [follow-link] 'mouse-face)
4832 (define-key map [down-mouse-2] nil)
4833 (define-key map "\C-m" 'choose-completion)
4834 (define-key map "\e\e\e" 'delete-completion-window)
4835 (define-key map [left] 'previous-completion)
4836 (define-key map [right] 'next-completion)
4837 (setq completion-list-mode-map map)))
4839 ;; Completion mode is suitable only for specially formatted data.
4840 (put 'completion-list-mode 'mode-class 'special)
4842 (defvar completion-reference-buffer nil
4843 "Record the buffer that was current when the completion list was requested.
4844 This is a local variable in the completion list buffer.
4845 Initial value is nil to avoid some compiler warnings.")
4847 (defvar completion-no-auto-exit nil
4848 "Non-nil means `choose-completion-string' should never exit the minibuffer.
4849 This also applies to other functions such as `choose-completion'
4850 and `mouse-choose-completion'.")
4852 (defvar completion-base-size nil
4853 "Number of chars at beginning of minibuffer not involved in completion.
4854 This is a local variable in the completion list buffer
4855 but it talks about the buffer in `completion-reference-buffer'.
4856 If this is nil, it means to compare text to determine which part
4857 of the tail end of the buffer's text is involved in completion.")
4859 (defun delete-completion-window ()
4860 "Delete the completion list window.
4861 Go to the window from which completion was requested."
4862 (interactive)
4863 (let ((buf completion-reference-buffer))
4864 (if (one-window-p t)
4865 (if (window-dedicated-p (selected-window))
4866 (delete-frame (selected-frame)))
4867 (delete-window (selected-window))
4868 (if (get-buffer-window buf)
4869 (select-window (get-buffer-window buf))))))
4871 (defun previous-completion (n)
4872 "Move to the previous item in the completion list."
4873 (interactive "p")
4874 (next-completion (- n)))
4876 (defun next-completion (n)
4877 "Move to the next item in the completion list.
4878 With prefix argument N, move N items (negative N means move backward)."
4879 (interactive "p")
4880 (let ((beg (point-min)) (end (point-max)))
4881 (while (and (> n 0) (not (eobp)))
4882 ;; If in a completion, move to the end of it.
4883 (when (get-text-property (point) 'mouse-face)
4884 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
4885 ;; Move to start of next one.
4886 (unless (get-text-property (point) 'mouse-face)
4887 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
4888 (setq n (1- n)))
4889 (while (and (< n 0) (not (bobp)))
4890 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
4891 ;; If in a completion, move to the start of it.
4892 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
4893 (goto-char (previous-single-property-change
4894 (point) 'mouse-face nil beg)))
4895 ;; Move to end of the previous completion.
4896 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
4897 (goto-char (previous-single-property-change
4898 (point) 'mouse-face nil beg)))
4899 ;; Move to the start of that one.
4900 (goto-char (previous-single-property-change
4901 (point) 'mouse-face nil beg))
4902 (setq n (1+ n))))))
4904 (defun choose-completion ()
4905 "Choose the completion that point is in or next to."
4906 (interactive)
4907 (let (beg end completion (buffer completion-reference-buffer)
4908 (base-size completion-base-size))
4909 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
4910 (setq end (point) beg (1+ (point))))
4911 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
4912 (setq end (1- (point)) beg (point)))
4913 (if (null beg)
4914 (error "No completion here"))
4915 (setq beg (previous-single-property-change beg 'mouse-face))
4916 (setq end (or (next-single-property-change end 'mouse-face) (point-max)))
4917 (setq completion (buffer-substring-no-properties beg end))
4918 (let ((owindow (selected-window)))
4919 (if (and (one-window-p t 'selected-frame)
4920 (window-dedicated-p (selected-window)))
4921 ;; This is a special buffer's frame
4922 (iconify-frame (selected-frame))
4923 (or (window-dedicated-p (selected-window))
4924 (bury-buffer)))
4925 (select-window owindow))
4926 (choose-completion-string completion buffer base-size)))
4928 ;; Delete the longest partial match for STRING
4929 ;; that can be found before POINT.
4930 (defun choose-completion-delete-max-match (string)
4931 (let ((opoint (point))
4932 len)
4933 ;; Try moving back by the length of the string.
4934 (goto-char (max (- (point) (length string))
4935 (minibuffer-prompt-end)))
4936 ;; See how far back we were actually able to move. That is the
4937 ;; upper bound on how much we can match and delete.
4938 (setq len (- opoint (point)))
4939 (if completion-ignore-case
4940 (setq string (downcase string)))
4941 (while (and (> len 0)
4942 (let ((tail (buffer-substring (point) opoint)))
4943 (if completion-ignore-case
4944 (setq tail (downcase tail)))
4945 (not (string= tail (substring string 0 len)))))
4946 (setq len (1- len))
4947 (forward-char 1))
4948 (delete-char len)))
4950 (defvar choose-completion-string-functions nil
4951 "Functions that may override the normal insertion of a completion choice.
4952 These functions are called in order with four arguments:
4953 CHOICE - the string to insert in the buffer,
4954 BUFFER - the buffer in which the choice should be inserted,
4955 MINI-P - non-nil iff BUFFER is a minibuffer, and
4956 BASE-SIZE - the number of characters in BUFFER before
4957 the string being completed.
4959 If a function in the list returns non-nil, that function is supposed
4960 to have inserted the CHOICE in the BUFFER, and possibly exited
4961 the minibuffer; no further functions will be called.
4963 If all functions in the list return nil, that means to use
4964 the default method of inserting the completion in BUFFER.")
4966 (defun choose-completion-string (choice &optional buffer base-size)
4967 "Switch to BUFFER and insert the completion choice CHOICE.
4968 BASE-SIZE, if non-nil, says how many characters of BUFFER's text
4969 to keep. If it is nil, we call `choose-completion-delete-max-match'
4970 to decide what to delete."
4972 ;; If BUFFER is the minibuffer, exit the minibuffer
4973 ;; unless it is reading a file name and CHOICE is a directory,
4974 ;; or completion-no-auto-exit is non-nil.
4976 (let* ((buffer (or buffer completion-reference-buffer))
4977 (mini-p (minibufferp buffer)))
4978 ;; If BUFFER is a minibuffer, barf unless it's the currently
4979 ;; active minibuffer.
4980 (if (and mini-p
4981 (or (not (active-minibuffer-window))
4982 (not (equal buffer
4983 (window-buffer (active-minibuffer-window))))))
4984 (error "Minibuffer is not active for completion")
4985 ;; Set buffer so buffer-local choose-completion-string-functions works.
4986 (set-buffer buffer)
4987 (unless (run-hook-with-args-until-success
4988 'choose-completion-string-functions
4989 choice buffer mini-p base-size)
4990 ;; Insert the completion into the buffer where it was requested.
4991 (if base-size
4992 (delete-region (+ base-size (if mini-p
4993 (minibuffer-prompt-end)
4994 (point-min)))
4995 (point))
4996 (choose-completion-delete-max-match choice))
4997 (insert choice)
4998 (remove-text-properties (- (point) (length choice)) (point)
4999 '(mouse-face nil))
5000 ;; Update point in the window that BUFFER is showing in.
5001 (let ((window (get-buffer-window buffer t)))
5002 (set-window-point window (point)))
5003 ;; If completing for the minibuffer, exit it with this choice.
5004 (and (not completion-no-auto-exit)
5005 (equal buffer (window-buffer (minibuffer-window)))
5006 minibuffer-completion-table
5007 ;; If this is reading a file name, and the file name chosen
5008 ;; is a directory, don't exit the minibuffer.
5009 (if (and (eq minibuffer-completion-table 'read-file-name-internal)
5010 (file-directory-p (field-string (point-max))))
5011 (let ((mini (active-minibuffer-window)))
5012 (select-window mini)
5013 (when minibuffer-auto-raise
5014 (raise-frame (window-frame mini))))
5015 (exit-minibuffer)))))))
5017 (defun completion-list-mode ()
5018 "Major mode for buffers showing lists of possible completions.
5020 to select the completion near point.
5022 with the mouse."
5023 (interactive)
5024 (kill-all-local-variables)
5025 (use-local-map completion-list-mode-map)
5026 (setq mode-name "Completion List")
5027 (setq major-mode 'completion-list-mode)
5028 (make-local-variable 'completion-base-size)
5029 (setq completion-base-size nil)
5030 (run-mode-hooks 'completion-list-mode-hook))
5032 (defun completion-list-mode-finish ()
5033 "Finish setup of the completions buffer.
5034 Called from `temp-buffer-show-hook'."
5035 (when (eq major-mode 'completion-list-mode)
5036 (toggle-read-only 1)))
5038 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
5040 (defvar completion-setup-hook nil
5041 "Normal hook run at the end of setting up a completion list buffer.
5042 When this hook is run, the current buffer is the one in which the
5043 command to display the completion list buffer was run.
5044 The completion list buffer is available as the value of `standard-output'.
5045 The common prefix substring for completion may be available as the
5046 value of `completion-common-substring'. See also `display-completion-list'.")
5049 ;; Variables and faces used in `completion-setup-function'.
5051 (defcustom completion-show-help t
5052 "Non-nil means show help message in *Completions* buffer."
5053 :type 'boolean
5054 :version "22.1"
5055 :group 'completion)
5057 (defface completions-first-difference
5058 '((t (:inherit bold)))
5059 "Face put on the first uncommon character in completions in *Completions* buffer."
5060 :group 'completion)
5062 (defface completions-common-part
5063 '((t (:inherit default)))
5064 "Face put on the common prefix substring in completions in *Completions* buffer.
5065 The idea of `completions-common-part' is that you can use it to
5066 make the common parts less visible than normal, so that the rest
5067 of the differing parts is, by contrast, slightly highlighted."
5068 :group 'completion)
5070 ;; This is for packages that need to bind it to a non-default regexp
5071 ;; in order to make the first-differing character highlight work
5072 ;; to their liking
5073 (defvar completion-root-regexp "^/"
5074 "Regexp to use in `completion-setup-function' to find the root directory.")
5076 (defvar completion-common-substring nil
5077 "Common prefix substring to use in `completion-setup-function' to put faces.
5078 The value is set by `display-completion-list' during running `completion-setup-hook'.
5080 To put faces `completions-first-difference' and `completions-common-part'
5081 in the `*Completions*' buffer, the common prefix substring in completions
5082 is needed as a hint. (The minibuffer is a special case. The content
5083 of the minibuffer before point is always the common substring.)")
5085 ;; This function goes in completion-setup-hook, so that it is called
5086 ;; after the text of the completion list buffer is written.
5087 (defun completion-setup-function ()
5088 (let* ((mainbuf (current-buffer))
5089 (mbuf-contents (minibuffer-completion-contents))
5090 common-string-length)
5091 ;; When reading a file name in the minibuffer,
5092 ;; set default-directory in the minibuffer
5093 ;; so it will get copied into the completion list buffer.
5094 (if minibuffer-completing-file-name
5095 (with-current-buffer mainbuf
5096 (setq default-directory
5097 (file-name-directory (expand-file-name mbuf-contents)))))
5098 (with-current-buffer standard-output
5099 (completion-list-mode)
5100 (set (make-local-variable 'completion-reference-buffer) mainbuf)
5101 (setq completion-base-size
5102 (cond
5103 ((and (symbolp minibuffer-completion-table)
5104 (get minibuffer-completion-table 'completion-base-size-function))
5105 ;; To compute base size, a function can use the global value of
5106 ;; completion-common-substring or minibuffer-completion-contents.
5107 (with-current-buffer mainbuf
5108 (funcall (get minibuffer-completion-table
5109 'completion-base-size-function))))
5110 (minibuffer-completing-file-name
5111 ;; For file name completion, use the number of chars before
5112 ;; the start of the file name component at point.
5113 (with-current-buffer mainbuf
5114 (save-excursion
5115 (skip-chars-backward completion-root-regexp)
5116 (- (point) (minibuffer-prompt-end)))))
5117 (minibuffer-completing-symbol nil)
5118 ;; Otherwise, in minibuffer, the base size is 0.
5119 ((minibufferp mainbuf) 0)))
5120 (setq common-string-length
5121 (cond
5122 (completion-common-substring
5123 (length completion-common-substring))
5124 (completion-base-size
5125 (- (length mbuf-contents) completion-base-size))))
5126 ;; Put faces on first uncommon characters and common parts.
5127 (when (and (integerp common-string-length) (>= common-string-length 0))
5128 (let ((element-start (point-min))
5129 (maxp (point-max))
5130 element-common-end)
5131 (while (and (setq element-start
5132 (next-single-property-change
5133 element-start 'mouse-face))
5134 (< (setq element-common-end
5135 (+ element-start common-string-length))
5136 maxp))
5137 (when (get-char-property element-start 'mouse-face)
5138 (if (and (> common-string-length 0)
5139 (get-char-property (1- element-common-end) 'mouse-face))
5140 (put-text-property element-start element-common-end
5141 'font-lock-face 'completions-common-part))
5142 (if (get-char-property element-common-end 'mouse-face)
5143 (put-text-property element-common-end (1+ element-common-end)
5144 'font-lock-face 'completions-first-difference))))))
5145 ;; Maybe insert help string.
5146 (when completion-show-help
5147 (goto-char (point-min))
5148 (if (display-mouse-p)
5149 (insert (substitute-command-keys
5151 (insert (substitute-command-keys
5155 (add-hook 'completion-setup-hook 'completion-setup-function)
5157 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
5158 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
5160 (defun switch-to-completions ()
5161 "Select the completion list window."
5162 (interactive)
5163 ;; Make sure we have a completions window.
5164 (or (get-buffer-window "*Completions*")
5165 (minibuffer-completion-help))
5166 (let ((window (get-buffer-window "*Completions*")))
5167 (when window
5168 (select-window window)
5169 (goto-char (point-min))
5171 (forward-line 1))))
5172 \f
5173 ;;; Support keyboard commands to turn on various modifiers.
5175 ;; These functions -- which are not commands -- each add one modifier
5176 ;; to the following event.
5178 (defun event-apply-alt-modifier (ignore-prompt)
5181 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
5182 (defun event-apply-super-modifier (ignore-prompt)
5185 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
5186 (defun event-apply-hyper-modifier (ignore-prompt)
5189 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
5190 (defun event-apply-shift-modifier (ignore-prompt)
5193 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
5194 (defun event-apply-control-modifier (ignore-prompt)
5197 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
5198 (defun event-apply-meta-modifier (ignore-prompt)
5201 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
5203 (defun event-apply-modifier (event symbol lshiftby prefix)
5204 "Apply a modifier flag to event EVENT.
5205 SYMBOL is the name of this modifier, as a symbol.
5206 LSHIFTBY is the numeric value of this modifier, in keyboard events.
5207 PREFIX is the string that represents this modifier in an event type symbol."
5208 (if (numberp event)
5209 (cond ((eq symbol 'control)
5210 (if (and (<= (downcase event) ?z)
5211 (>= (downcase event) ?a))
5212 (- (downcase event) ?a -1)
5213 (if (and (<= (downcase event) ?Z)
5214 (>= (downcase event) ?A))
5215 (- (downcase event) ?A -1)
5216 (logior (lsh 1 lshiftby) event))))
5217 ((eq symbol 'shift)
5218 (if (and (<= (downcase event) ?z)
5219 (>= (downcase event) ?a))
5220 (upcase event)
5221 (logior (lsh 1 lshiftby) event)))
5222 (t
5223 (logior (lsh 1 lshiftby) event)))
5224 (if (memq symbol (event-modifiers event))
5225 event
5226 (let ((event-type (if (symbolp event) event (car event))))
5227 (setq event-type (intern (concat prefix (symbol-name event-type))))
5228 (if (symbolp event)
5229 event-type
5230 (cons event-type (cdr event)))))))
5232 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
5233 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
5234 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
5235 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
5236 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
5237 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
5238 \f
5239 ;;;; Keypad support.
5241 ;;; Make the keypad keys act like ordinary typing keys. If people add
5242 ;;; bindings for the function key symbols, then those bindings will
5243 ;;; override these, so this shouldn't interfere with any existing
5244 ;;; bindings.
5246 ;; Also tell read-char how to handle these keys.
5247 (mapc
5248 (lambda (keypad-normal)
5249 (let ((keypad (nth 0 keypad-normal))
5250 (normal (nth 1 keypad-normal)))
5251 (put keypad 'ascii-character normal)
5252 (define-key function-key-map (vector keypad) (vector normal))))
5253 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
5254 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
5255 (kp-space ?\s)
5258 (kp-multiply ?*)
5259 (kp-add ?+)
5260 (kp-separator ?,)
5261 (kp-subtract ?-)
5262 (kp-decimal ?.)
5263 (kp-divide ?/)
5264 (kp-equal ?=)))
5265 \f
5266 ;;;;
5267 ;;;; forking a twin copy of a buffer.
5268 ;;;;
5270 (defvar clone-buffer-hook nil
5271 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
5273 (defun clone-process (process &optional newname)
5274 "Create a twin copy of PROCESS.
5275 If NEWNAME is nil, it defaults to PROCESS' name;
5276 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
5277 If PROCESS is associated with a buffer, the new process will be associated
5278 with the current buffer instead.
5279 Returns nil if PROCESS has already terminated."
5280 (setq newname (or newname (process-name process)))
5282 (setq newname (substring newname 0 (match-beginning 0))))
5283 (when (memq (process-status process) '(run stop open))
5284 (let* ((process-connection-type (process-tty-name process))
5285 (new-process
5286 (if (memq (process-status process) '(open))
5287 (let ((args (process-contact process t)))
5288 (setq args (plist-put args :name newname))
5289 (setq args (plist-put args :buffer
5290 (if (process-buffer process)
5291 (current-buffer))))
5292 (apply 'make-network-process args))
5293 (apply 'start-process newname
5294 (if (process-buffer process) (current-buffer))
5295 (process-command process)))))
5296 (set-process-query-on-exit-flag
5297 new-process (process-query-on-exit-flag process))
5298 (set-process-inherit-coding-system-flag
5299 new-process (process-inherit-coding-system-flag process))
5300 (set-process-filter new-process (process-filter process))
5301 (set-process-sentinel new-process (process-sentinel process))
5302 (set-process-plist new-process (copy-sequence (process-plist process)))
5303 new-process)))
5305 ;; things to maybe add (currently partly covered by `funcall mode'):
5306 ;; - syntax-table
5307 ;; - overlays
5308 (defun clone-buffer (&optional newname display-flag)
5309 "Create and return a twin copy of the current buffer.
5310 Unlike an indirect buffer, the new buffer can be edited
5311 independently of the old one (if it is not read-only).
5312 NEWNAME is the name of the new buffer. It may be modified by
5313 adding or incrementing <N> at the end as necessary to create a
5314 unique buffer name. If nil, it defaults to the name of the
5315 current buffer, with the proper suffix. If DISPLAY-FLAG is
5316 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
5317 clone a file-visiting buffer, or a buffer whose major mode symbol
5318 has a non-nil `no-clone' property, results in an error.
5320 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
5321 current buffer with appropriate suffix. However, if a prefix
5322 argument is given, then the command prompts for NEWNAME in the
5323 minibuffer.
5325 This runs the normal hook `clone-buffer-hook' in the new buffer
5326 after it has been set up properly in other respects."
5327 (interactive
5328 (progn
5329 (if buffer-file-name
5330 (error "Cannot clone a file-visiting buffer"))
5331 (if (get major-mode 'no-clone)
5332 (error "Cannot clone a buffer in %s mode" mode-name))
5333 (list (if current-prefix-arg
5334 (read-buffer "Name of new cloned buffer: " (current-buffer)))
5335 t)))
5336 (if buffer-file-name
5337 (error "Cannot clone a file-visiting buffer"))
5338 (if (get major-mode 'no-clone)
5339 (error "Cannot clone a buffer in %s mode" mode-name))
5340 (setq newname (or newname (buffer-name)))
5342 (setq newname (substring newname 0 (match-beginning 0))))
5343 (let ((buf (current-buffer))
5344 (ptmin (point-min))
5345 (ptmax (point-max))
5346 (pt (point))
5347 (mk (if mark-active (mark t)))
5348 (modified (buffer-modified-p))
5349 (mode major-mode)
5350 (lvars (buffer-local-variables))
5351 (process (get-buffer-process (current-buffer)))
5352 (new (generate-new-buffer (or newname (buffer-name)))))
5353 (save-restriction
5354 (widen)
5355 (with-current-buffer new
5356 (insert-buffer-substring buf)))
5357 (with-current-buffer new
5358 (narrow-to-region ptmin ptmax)
5359 (goto-char pt)
5360 (if mk (set-mark mk))
5361 (set-buffer-modified-p modified)
5363 ;; Clone the old buffer's process, if any.
5364 (when process (clone-process process))
5366 ;; Now set up the major mode.
5367 (funcall mode)
5369 ;; Set up other local variables.
5370 (mapcar (lambda (v)
5371 (condition-case () ;in case var is read-only
5372 (if (symbolp v)
5373 (makunbound v)
5374 (set (make-local-variable (car v)) (cdr v)))
5375 (error nil)))
5376 lvars)
5378 ;; Run any hooks (typically set up by the major mode
5379 ;; for cloning to work properly).
5380 (run-hooks 'clone-buffer-hook))
5381 (if display-flag
5382 ;; Presumably the current buffer is shown in the selected frame, so
5383 ;; we want to display the clone elsewhere.
5384 (let ((same-window-regexps nil)
5385 (same-window-buffer-names))
5386 (pop-to-buffer new)))
5387 new))
5390 (defun clone-indirect-buffer (newname display-flag &optional norecord)
5391 "Create an indirect buffer that is a twin copy of the current buffer.
5393 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
5394 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
5395 or if not called with a prefix arg, NEWNAME defaults to the current
5396 buffer's name. The name is modified by adding a `<N>' suffix to it
5397 or by incrementing the N in an existing suffix.
5399 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
5400 This is always done when called interactively.
5402 Optional third arg NORECORD non-nil means do not put this buffer at the
5403 front of the list of recently selected ones."
5404 (interactive
5405 (progn
5406 (if (get major-mode 'no-clone-indirect)
5407 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
5408 (list (if current-prefix-arg
5409 (read-buffer "Name of indirect buffer: " (current-buffer)))
5410 t)))
5411 (if (get major-mode 'no-clone-indirect)
5412 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
5413 (setq newname (or newname (buffer-name)))
5415 (setq newname (substring newname 0 (match-beginning 0))))
5416 (let* ((name (generate-new-buffer-name newname))
5417 (buffer (make-indirect-buffer (current-buffer) name t)))
5418 (when display-flag
5419 (pop-to-buffer buffer norecord))
5420 buffer))
5423 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
5424 "Like `clone-indirect-buffer' but display in another window."
5425 (interactive
5426 (progn
5427 (if (get major-mode 'no-clone-indirect)
5428 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
5429 (list (if current-prefix-arg
5430 (read-buffer "Name of indirect buffer: " (current-buffer)))
5431 t)))
5432 (let ((pop-up-windows t))
5433 (clone-indirect-buffer newname display-flag norecord)))
5435 \f
5436 ;;; Handling of Backspace and Delete keys.
5438 (defcustom normal-erase-is-backspace
5439 (and (not noninteractive)
5440 (or (memq system-type '(ms-dos windows-nt))
5441 (eq window-system 'mac)
5442 (and (memq window-system '(x))
5443 (fboundp 'x-backspace-delete-keys-p)
5444 (x-backspace-delete-keys-p))
5445 ;; If the terminal Emacs is running on has erase char
5446 ;; set to ^H, use the Backspace key for deleting
5447 ;; backward and, and the Delete key for deleting forward.
5448 (and (null window-system)
5449 (eq tty-erase-char ?\^H))))
5450 "If non-nil, Delete key deletes forward and Backspace key deletes backward.
5452 On window systems, the default value of this option is chosen
5453 according to the keyboard used. If the keyboard has both a Backspace
5454 key and a Delete key, and both are mapped to their usual meanings, the
5455 option's default value is set to t, so that Backspace can be used to
5456 delete backward, and Delete can be used to delete forward.
5458 If not running under a window system, customizing this option accomplishes
5459 a similar effect by mapping C-h, which is usually generated by the
5460 Backspace key, to DEL, and by mapping DEL to C-d via
5461 `keyboard-translate'. The former functionality of C-h is available on
5462 the F1 key. You should probably not use this setting if you don't
5463 have both Backspace, Delete and F1 keys.
5465 Setting this variable with setq doesn't take effect. Programmatically,
5466 call `normal-erase-is-backspace-mode' (which see) instead."
5467 :type 'boolean
5468 :group 'editing-basics
5469 :version "21.1"
5470 :set (lambda (symbol value)
5471 ;; The fboundp is because of a problem with :set when
5472 ;; dumping Emacs. It doesn't really matter.
5473 (if (fboundp 'normal-erase-is-backspace-mode)
5474 (normal-erase-is-backspace-mode (or value 0))
5475 (set-default symbol value))))
5478 (defun normal-erase-is-backspace-mode (&optional arg)
5479 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
5481 With numeric arg, turn the mode on if and only if ARG is positive.
5483 On window systems, when this mode is on, Delete is mapped to C-d and
5484 Backspace is mapped to DEL; when this mode is off, both Delete and
5485 Backspace are mapped to DEL. (The remapping goes via
5486 `function-key-map', so binding Delete or Backspace in the global or
5487 local keymap will override that.)
5489 In addition, on window systems, the bindings of C-Delete, M-Delete,
5490 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
5491 the global keymap in accordance with the functionality of Delete and
5492 Backspace. For example, if Delete is remapped to C-d, which deletes
5493 forward, C-Delete is bound to `kill-word', but if Delete is remapped
5494 to DEL, which deletes backward, C-Delete is bound to
5495 `backward-kill-word'.
5497 If not running on a window system, a similar effect is accomplished by
5498 remapping C-h (normally produced by the Backspace key) and DEL via
5499 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
5500 to C-d; if it's off, the keys are not remapped.
5502 When not running on a window system, and this mode is turned on, the
5503 former functionality of C-h is available on the F1 key. You should
5504 probably not turn on this mode on a text-only terminal if you don't
5505 have both Backspace, Delete and F1 keys.
5507 See also `normal-erase-is-backspace'."
5508 (interactive "P")
5509 (setq normal-erase-is-backspace
5510 (if arg
5511 (> (prefix-numeric-value arg) 0)
5512 (not normal-erase-is-backspace)))
5514 (cond ((or (memq window-system '(x w32 mac pc))
5515 (memq system-type '(ms-dos windows-nt)))
5516 (let ((bindings
5517 `(([C-delete] [C-backspace])
5518 ([M-delete] [M-backspace])
5519 ([C-M-delete] [C-M-backspace])
5520 (,esc-map
5521 [C-delete] [C-backspace])))
5522 (old-state (lookup-key function-key-map [delete])))
5524 (if normal-erase-is-backspace
5525 (progn
5526 (define-key function-key-map [delete] [?\C-d])
5527 (define-key function-key-map [kp-delete] [?\C-d])
5528 (define-key function-key-map [backspace] [?\C-?]))
5529 (define-key function-key-map [delete] [?\C-?])
5530 (define-key function-key-map [kp-delete] [?\C-?])
5531 (define-key function-key-map [backspace] [?\C-?]))
5533 ;; Maybe swap bindings of C-delete and C-backspace, etc.
5534 (unless (equal old-state (lookup-key function-key-map [delete]))
5535 (dolist (binding bindings)
5536 (let ((map global-map))
5537 (when (keymapp (car binding))
5538 (setq map (car binding) binding (cdr binding)))
5539 (let* ((key1 (nth 0 binding))
5540 (key2 (nth 1 binding))
5541 (binding1 (lookup-key map key1))
5542 (binding2 (lookup-key map key2)))
5543 (define-key map key1 binding2)
5544 (define-key map key2 binding1)))))))
5545 (t
5546 (if normal-erase-is-backspace
5547 (progn
5548 (keyboard-translate ?\C-h ?\C-?)
5549 (keyboard-translate ?\C-? ?\C-d))
5550 (keyboard-translate ?\C-h ?\C-h)
5551 (keyboard-translate ?\C-? ?\C-?))))
5553 (run-hooks 'normal-erase-is-backspace-hook)
5554 (if (interactive-p)
5555 (message "Delete key deletes %s"
5556 (if normal-erase-is-backspace "forward" "backward"))))
5557 \f
5558 (defvar vis-mode-saved-buffer-invisibility-spec nil
5559 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
5561 (define-minor-mode visible-mode
5562 "Toggle Visible mode.
5563 With argument ARG turn Visible mode on iff ARG is positive.
5565 Enabling Visible mode makes all invisible text temporarily visible.
5566 Disabling Visible mode turns off that effect. Visible mode
5567 works by saving the value of `buffer-invisibility-spec' and setting it to nil."
5568 :lighter " Vis"
5569 :group 'editing-basics
5570 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
5571 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
5572 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
5573 (when visible-mode
5574 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
5575 buffer-invisibility-spec)
5576 (setq buffer-invisibility-spec nil)))
5577 \f
5578 ;; Minibuffer prompt stuff.
5580 ;(defun minibuffer-prompt-modification (start end)
5581 ; (error "You cannot modify the prompt"))
5582 ;
5583 ;
5584 ;(defun minibuffer-prompt-insertion (start end)
5585 ; (let ((inhibit-modification-hooks t))
5586 ; (delete-region start end)
5587 ; ;; Discard undo information for the text insertion itself
5588 ; ;; and for the text deletion.above.
5589 ; (when (consp buffer-undo-list)
5590 ; (setq buffer-undo-list (cddr buffer-undo-list)))
5591 ; (message "You cannot modify the prompt")))
5592 ;
5593 ;
5594 ;(setq minibuffer-prompt-properties
5595 ; (list 'modification-hooks '(minibuffer-prompt-modification)
5596 ; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
5597 ;
5599 (provide 'simple)
5601 ;; arch-tag: 24af67c0-2a49-44f6-b3b1-312d8b570dfd
5602 ;;; simple.el ends here