| blob | 9062d39e1c1ffbc00377275440155c2596e46914 |
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
5 ;; Free Software Foundation, Inc.
7 ;; Maintainer: FSF
8 ;; Keywords: internal
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
27 ;;; Commentary:
29 ;; A grab-bag of basic Emacs commands not specifically related to some
30 ;; major mode or to file-handling.
32 ;;; Code:
40 "Killing and yanking commands."
44 "Highlight (un)matching of parens and expressions."
50 "Switch to the next buffer in cyclic order."
57 "Switch to the previous buffer in cyclic order."
60 found)
68 \f
69 ;;; next-error support framework
72 "next-error support framework."
78 "Face used to highlight next error locus."
83 "*Highlighting of locations in selected source buffers.
84 If number, highlight the locus in next-error face for given time in seconds.
85 If t, use persistent overlays fontified in next-error face.
86 If nil, don't highlight the locus in the source buffer.
87 If `fringe-arrow', indicate the locus by the fringe arrow."
96 "*Highlighting of locations in non-selected source buffers.
97 If number, highlight the locus in next-error face for given time in seconds.
98 If t, use persistent overlays fontified in next-error face.
99 If nil, don't highlight the locus in the source buffer.
100 If `fringe-arrow', indicate the locus by the fringe arrow."
109 "The most recent next-error buffer.
110 A buffer becomes most recent when its compilation, grep, or
115 "Function to use to find the next error in the current buffer.
116 The function is called with 2 parameters:
117 ARG is an integer specifying by how many errors to move.
118 RESET is a boolean which, if non-nil, says to go back to the beginning
119 of the errors before moving.
120 Major modes providing compile-like functionality should set this variable
121 to indicate to `next-error' that this is a candidate buffer and how
127 &optional avoid-current
128 extra-test-inclusive
129 extra-test-exclusive)
130 "Test if BUFFER is a next-error capable buffer.
132 If AVOID-CURRENT is non-nil, treat the current buffer
133 as an absolute last resort only.
135 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
136 that normally would not qualify. If it returns t, the buffer
137 in question is treated as usable.
139 The function EXTRA-TEST-EXCLUSIVE, if non-nil is called in each buffer
140 that would normally be considered usable. if it returns nil,
141 that buffer is rejected."
146 ;; Optionally reject some buffers.
149 t)
150 ;; Optionally accept some other buffers.
155 extra-test-inclusive
156 extra-test-exclusive)
157 "Return a next-error capable buffer.
158 If AVOID-CURRENT is non-nil, treat the current buffer
159 as an absolute last resort only.
161 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffers
162 that normally would not qualify. If it returns t, the buffer
163 in question is treated as usable.
165 The function EXTRA-TEST-EXCLUSIVE, if non-nil is called in each buffer
166 that would normally be considered usable. If it returns nil,
167 that buffer is rejected."
169 ;; 1. If one window on the selected frame displays such buffer, return it.
175 avoid-current
176 extra-test-inclusive extra-test-exclusive)
181 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
184 extra-test-inclusive extra-test-exclusive))
185 next-error-last-buffer)
186 ;; 3. If the current buffer is acceptable, choose it.
188 extra-test-inclusive extra-test-exclusive)
190 ;; 4. Look for any acceptable buffer.
195 extra-test-inclusive extra-test-exclusive)))
198 ;; 5. Use the current buffer as a last resort if it qualifies,
199 ;; even despite AVOID-CURRENT.
202 extra-test-inclusive extra-test-exclusive)
206 ;; 6. Give up.
210 "Visit next next-error message and corresponding source code.
212 If all the error messages parsed so far have been processed already,
213 the message buffer is checked for new ones.
215 A prefix ARG specifies how many error messages to move;
216 negative means move back to previous error messages.
218 and start at the first error.
220 The RESET argument specifies that we should restart from the beginning.
223 compilation, grep, or occur buffer. It can also operate on any
225 more generally, on any buffer in Compilation mode or with
226 Compilation Minor mode enabled, or any buffer in which
227 `next-error-function' is bound to an appropriate function.
228 To specify use of a particular buffer for error messages, type
230 in the current frame.
233 it stays with that buffer until you use it in some other buffer which
234 uses Compilation mode or Compilation Minor mode.
236 See variables `compilation-parse-errors-function' and
237 \`compilation-error-regexp-alist' for customization ideas."
241 ;; we know here that next-error-function is a valid symbol we can funcall
251 "Visit previous next-error message and corresponding source code.
253 Prefix arg N says how many error messages to move backwards (or
254 forwards, if negative).
261 "Restart at the first error.
262 Visit corresponding source code.
263 With prefix arg N, visit the source code of the Nth error.
269 "Move point to the next error in the next-error buffer and highlight match.
270 Prefix arg N says how many error messages to move forwards (or
271 backwards, if negative).
273 select the source buffer."
280 "Move point to the previous error in the next-error buffer and highlight match.
281 Prefix arg N says how many error messages to move backwards (or
282 forwards, if negative).
284 select the source buffer."
288 ;;; Internal variable for `next-error-follow-mode-post-command-hook'.
292 "Minor mode for compilation, occur and diff modes.
293 When turned on, cursor motion in the compilation, grep, occur or diff
294 buffer causes automatic display of the corresponding source code
295 location."
296 nil " Fol" nil
302 ;;; Used as a `post-command-hook' by `next-error-follow-mode'
303 ;;; for the *Compilation* *grep* and *Occur* buffers.
313 \f
314 ;;;
317 "Major mode not specialized for anything in particular.
318 Other major modes are defined by comparison with this one."
323 ;; Making and deleting lines.
326 "Insert a newline, and move to left margin of the new line if it's blank.
327 If `use-hard-newlines' is non-nil, the newline is marked with the
328 text-property `hard'.
329 With ARG, insert that many newlines.
330 Call `auto-fill-function' if the current column number is greater
331 than the value of `fill-column' and ARG is nil."
334 ;; Inserting a newline at the end of a line produces better redisplay in
335 ;; try_window_id than inserting at the beginning of a line, and the textual
336 ;; result is the same. So, if we're at beginning of line, pretend to be at
337 ;; the end of the previous line.
340 ;; Make sure no functions want to be told about
341 ;; the range of the changes.
344 ;; Make sure there are no markers here.
347 ;; Make sure no text properties want to know
348 ;; where the change was.
353 ;; Make sure the newline before point isn't intangible.
355 ;; Make sure the newline before point isn't read-only.
357 ;; Make sure the newline before point isn't invisible.
359 ;; Make sure the newline before point has the same
360 ;; properties as the char before it (if any).
367 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
368 ;; Set last-command-char to tell self-insert what to insert.
370 ;; Don't auto-fill if we have a numeric argument.
371 ;; Also not if flag is true (it would fill wrong line);
372 ;; there is no need to since we're at BOL.
376 ;; If we get an error in self-insert-command, put point at right place.
378 ;; Even if we did *not* get an error, keep that forward-char;
379 ;; all further processing should apply to the newline that the user
380 ;; thinks he inserted.
382 ;; Mark the newline(s) `hard'.
386 ;; If the newline leaves the previous line blank,
387 ;; and we have a left margin, delete that from the blank line.
395 ;; Indent the line after the newline, except in one case:
396 ;; when we added the newline at the beginning of a line
397 ;; which starts a page.
400 nil)
405 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
411 "Insert a newline and leave point before it.
412 If there is a fill prefix and/or a left-margin, insert them on the new line
413 if the line would have been blank.
414 With arg N, insert N newlines."
419 ;; Don't expand an abbrev before point.
433 "Split current line, moving portion beyond point vertically down.
434 If the current line starts with `fill-prefix', insert it on the new
435 line as well. With prefix ARG, don't insert fill-prefix on new line.
437 When called from Lisp code, ARG may be a prefix string to copy."
442 ;; What prefix should we check for (nil means don't).
446 ;; Does this line start with it?
457 "Join this line to previous and fix up whitespace at join.
458 If there is a fill prefix, delete it from the beginning of this line.
459 With argument, join this line to following line."
466 ;; If the second line started with the fill prefix,
467 ;; delete the prefix.
479 "On blank line, delete all surrounding blank lines, leaving just one.
480 On isolated blank line, delete that one.
481 On nonblank line, delete any immediately following blank lines."
487 ;; Set singleblank if there is just one blank line here.
494 ;; Delete preceding blank lines, and this one too if it's the only one.
503 ;; Delete following blank lines, unless the current line is blank
504 ;; and there are no following blank lines.
513 ;; Handle the special case where point is followed by newline and eob.
514 ;; Delete the line, leaving point at eob.
519 "Delete all the trailing whitespace across the current buffer.
520 All whitespace after the last non-whitespace character in a line is deleted.
522 A formfeed is not considered whitespace by this function."
529 ;; Don't delete formfeeds, even if they are considered whitespace.
536 "Insert a newline, then indent according to major mode.
537 Indentation is done using the value of `indent-line-function'.
538 In programming language modes, this is the same as TAB.
539 In some text modes, where TAB inserts a tab, this command indents to the
540 column specified by the function `current-left-margin'."
547 "Reindent current line, insert newline, then indent the new line.
548 Indentation of both lines is done according to the current major mode,
549 which means calling the current value of `indent-line-function'.
550 In programming language modes, this is the same as TAB.
551 In some text modes, where TAB inserts a tab, this indents to the
552 column specified by the function `current-left-margin'."
555 ;; Be careful to insert the newline before indenting the line.
556 ;; Otherwise, the indentation might be wrong.
565 "Read next input character and insert it.
566 This is useful for inserting control characters.
568 If the first character you type after this command is an octal digit,
569 you should type a sequence of octal digits which specify a character code.
570 Any nondigit terminates the sequence. If the terminator is a RET,
571 it is discarded; any other terminator is used itself as input.
572 The variable `read-quoted-char-radix' specifies the radix for this feature;
573 set it to 10 or 16 to use decimal or hex instead of octal.
575 In overwrite mode, this function inserts the character anyway, and
576 does not handle octal digits specially. This means that if you use
577 overwrite as your normal editing mode, you can use this function to
578 insert characters when necessary.
580 In binary overwrite mode, this function does overwrite, and octal
581 digits are interpreted as a character code. This is intended to be
582 useful for editing binary files."
589 ;; Assume character codes 0240 - 0377 stand for characters in some
590 ;; single-byte character set, and convert them to Emacs
591 ;; characters.
604 "Move forward ARG lines and position at first nonblank character."
610 "Move backward ARG lines and position at first nonblank character."
616 "Move point to the first non-whitespace character on this line."
620 ;; Move back over chars that have whitespace syntax but have the p flag.
624 "Fixup white space between objects around point.
625 Leave one space or none, according to the context."
632 nil
636 "Delete all spaces and tabs around point.
637 If BACKWARD-ONLY is non-nil, only delete spaces before point."
642 orig-pos
651 "Delete all spaces and tabs around point, leaving one space (or N spaces)."
665 \f
667 "Move point to the beginning of the buffer; leave mark at previous position.
669 With numeric arg N, put point N/10 of the way from the beginning.
671 If the buffer is narrowed, this command uses the beginning and size
672 of the accessible part of the buffer.
674 Don't use this command in Lisp programs!
675 \(goto-char (point-min)) is faster and avoids clobbering the mark."
684 ;; Avoid overflow for large buffer sizes!
692 "Move point to the end of the buffer; leave mark at previous position.
694 With numeric arg N, put point N/10 of the way from the end.
696 If the buffer is narrowed, this command uses the beginning and size
697 of the accessible part of the buffer.
699 Don't use this command in Lisp programs!
700 \(goto-char (point-max)) is faster and avoids clobbering the mark."
709 ;; Avoid overflow for large buffer sizes!
714 ;; If we went to a place in the middle of the buffer,
715 ;; adjust it to the beginning of a line.
718 ;; If the end of the buffer is not already on the screen,
719 ;; then scroll specially to put it near, but not at, the bottom.
724 "Put point at beginning and mark at end of buffer.
725 You probably should not use this function in Lisp programs;
726 it is usually a mistake for a Lisp function to use any subroutine
727 that uses or sets the mark."
732 \f
734 ;; Counting lines, one way or another.
737 "Goto line ARG, counting from line 1 at beginning of buffer.
738 Normally, move point in the curren buffer.
739 With just C-u as argument, move point in the most recently displayed
740 other buffer, and switch to it.
742 If there's a number in the buffer at point, it is the default for ARG."
746 ;; Look for a default, a number in the buffer at point.
755 ;; Decide if we're switching buffers.
763 ;; Read the argument, offering that number (if any) as default.
766 buffer-prompt
767 default)
768 nil nil t
769 'minibuffer-history
770 default)
771 buffer))))
772 ;; Switch to the desired buffer, one way or another.
777 ;; Move to the specified line number in that buffer.
786 "Print number of lines and characters in the region."
792 "Print the current buffer line number and narrowed line number of point."
805 "Return number of lines between START and END.
806 This is usually the number of newlines between them,
807 but can be one more if START is not equal to END
808 and the greater of them is not at the start of a line."
824 done)))
828 "Return (narrowed) buffer line number at position POS.
829 If POS is nil, use current buffer location."
839 "Print info on cursor position (on screen and within buffer).
840 Also describe the character after point, and give its character code
841 in octal, decimal and hex.
843 For a non-ASCII multibyte character, also give its encoding in the
844 buffer's selected coding system if the coding system encodes the
845 character safely. If the character is encoded into one byte, that
846 code is shown in hex. If the character is encoded into more than one
849 In addition, with prefix argument, show details about that character
850 in *Help* buffer. See also the command `describe-char'."
858 ;; Avoid overflow from multiplying by 100!
862 ""
868 pos total percent beg end col hscroll)
870 pos total percent col hscroll))
872 encoded encoding-msg)
883 char char char
885 "..."
889 ;; We show the detailed information about CHAR.
896 encoding-msg pos total percent beg end col hscroll)
901 encoding-msg pos total percent col hscroll))))))
902 \f
907 m)
913 "*Value to use for `print-level' when printing value in `eval-expression'.
914 A value of nil means no limit."
920 "*Value to use for `print-length' when printing value in `eval-expression'.
921 A value of nil means no limit."
927 "*Non-nil means set `debug-on-error' when evaluating in `eval-expression'.
928 If nil, don't change the value of `debug-on-error'."
934 "Format VALUE as a result of evaluated expression.
935 Return a formatted string which is displayed in the echo area
936 in addition to the value printed by prin1 in functions which
937 display the result of expression evaluation."
950 ;; We define this, rather than making `eval' interactive,
951 ;; for the sake of completion of names like eval-region, eval-current-buffer.
954 "Evaluate EVAL-EXPRESSION-ARG and print value in the echo area.
955 Value is also consed on to front of the variable `values'.
956 Optional argument EVAL-EXPRESSION-INSERT-VALUE, if non-nil, means
957 insert the result into the current buffer instead of printing it in
958 the echo area."
961 nil read-expression-map t
963 current-prefix-arg))
968 ;; Bind debug-on-error to something unique so that we can
969 ;; detect when evaled code changes it.
973 ;; If evaled code has changed the value of debug-on-error,
974 ;; propagate that change to the global binding.
990 "Prompting with PROMPT, let user edit COMMAND and eval result.
991 COMMAND is a Lisp expression. Let user edit that expression in
992 the minibuffer, then read and evaluate the result."
999 read-expression-map t
1001 ;; If command was added to command-history as a string,
1002 ;; get rid of that. We want only evaluable expressions there.
1006 ;; If command to be redone does not match front of history,
1007 ;; add it to the history.
1013 "Edit and re-evaluate last complex command, or ARGth from last.
1014 A complex command is one which used the minibuffer.
1015 The command is placed in the minibuffer as a Lisp form for editing.
1016 The result is executed, repeating the command as changed.
1017 If the command has been changed or is not the most recent previous command
1018 it is added to the front of the command history.
1019 You can use the minibuffer history commands \\<minibuffer-local-map>\\[next-history-element] and \\[previous-history-element]
1020 to get different commands to edit and resubmit."
1023 newcmd)
1035 ;; If command was added to command-history as a
1036 ;; string, get rid of that. We want only
1037 ;; evaluable expressions there.
1041 ;; If command to be redone does not match front of history,
1042 ;; add it to the history.
1049 \f
1051 "Default minibuffer history list.
1052 This is used for all minibuffer input
1055 "Control whether history list elements are expressions or strings.
1056 If the value of this variable equals current minibuffer depth,
1057 they are expressions; otherwise they are strings.
1058 \(That convention is designed to do the right thing fora
1065 "Text that was in this minibuffer before any history commands.
1066 This is nil if there have not yet been any history commands
1075 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1079 "*Minibuffer history variables for which matching should ignore case.
1080 If a history variable is a member of this list, then the
1082 commands ignore case when searching it, regardless of `case-fold-search'."
1087 "Find the previous history element that matches REGEXP.
1088 \(Previous history elements refer to earlier actions.)
1089 With prefix argument N, search for Nth previous match.
1090 If N is negative, find the next or Nth next match.
1091 Normally, history elements are matched case-insensitively if
1092 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1093 makes the search case-sensitive.
1094 See also `minibuffer-history-case-insensitive-variables'."
1098 nil
1099 minibuffer-local-map
1100 nil
1101 'minibuffer-history-search-history
1103 ;; Use the last regexp specified, by default, if input is empty.
1108 regexp)
1118 ;; On some systems, ignore case for file names.
1120 minibuffer-history-case-insensitive-variables)
1121 t
1122 ;; Respect the user's setting for case-fold-search:
1123 case-fold-search)
1124 nil))
1125 prevpos
1126 match-string
1127 match-offset
1134 "No later matching history item"
1155 next-matching-history-element))
1159 "Find the next history element that matches REGEXP.
1160 \(The next history element refers to a more recent action.)
1161 With prefix argument N, search for Nth next match.
1162 If N is negative, find the previous or Nth previous match.
1163 Normally, history elements are matched case-insensitively if
1164 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1165 makes the search case-sensitive."
1169 nil
1170 minibuffer-local-map
1171 nil
1172 'minibuffer-history-search-history
1174 ;; Use the last regexp specified, by default, if input is empty.
1179 regexp)
1186 "Insert the next element of the minibuffer history into the minibuffer."
1191 elt minibuffer-returned-to-present)
1203 previous-history-element))
1225 elt))
1229 "Inserts the previous element of the minibuffer history into the minibuffer."
1234 "Get next history element which completes the minibuffer before the point.
1235 The contents of the minibuffer after the point are deleted, and replaced
1236 by the new completion."
1242 n)
1243 ;; next-matching-history-element always puts us at (point-min).
1244 ;; Move to the position we were at before changing the buffer contents.
1245 ;; This is still sensical, because the text before point has not changed.
1249 "\
1250 Get previous history element which completes the minibuffer before the point.
1251 The contents of the minibuffer after the point are deleted, and replaced
1252 by the new completion."
1256 ;; For compatibility with the old subr of the same name.
1258 "Return the display width of the minibuffer prompt.
1259 Return 0 if current buffer is not a mini-buffer."
1260 ;; Return the width of everything before the field at the end of
1261 ;; the buffer; this should be 0 for normal buffers.
1263 \f
1264 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
1277 "Within a run of consecutive undo commands, list remaining to be undone.
1281 "Undo some previous changes.
1282 Repeat this command to undo more changes.
1283 A numeric argument serves as a repeat count.
1285 In Transient Mark mode when the mark is active, only undo changes within
1287 as an argument limits undo to changes within the current region."
1289 ;; Make last-command indicate for the next command that this was an undo.
1290 ;; That way, another undo will undo more.
1291 ;; If we get to the end of the undo history and get an error,
1292 ;; another undo command will find the undo history empty
1293 ;; and will get another error. To begin undoing the undos,
1294 ;; you must type some other command.
1297 ;; If we get an error in undo-start,
1298 ;; the next command should not be a "consecutive undo".
1299 ;; So set `this-command' to something other than `undo'.
1304 ;; If something (a timer or filter?) changed the buffer
1305 ;; since the previous command, don't continue the undo seq.
1309 ;; If the last undo record made was made by undo
1310 ;; it shows nothing else happened in between.
1317 ;; get rid of initial undo boundary
1319 ;; If we got this far, the next command should be a consecutive undo.
1321 ;; Check to see whether we're hitting a redo record, and if
1322 ;; so, ask the user whether she wants to skip the redo/undo pair.
1329 ;; The equiv entry might point to another redo record if we have done
1330 ;; undo-redo-undo-redo-... so skip to the very last equiv.
1338 ;; Record the fact that the just-generated undo records come from an
1339 ;; undo operation, so we can skip them later on.
1340 ;; I don't know how to do that in the undo-in-region case.
1343 ;; Don't specify a position in the undo record for the undo command.
1344 ;; Instead, undoing this should move point to where the change is.
1363 ;; Record what the current undo list says,
1364 ;; so the next command can tell if the buffer was modified in between.
1369 "Make BUFFER stop keeping undo information.
1370 No argument or nil as argument means do this for the current buffer."
1376 "Undo some previous changes.
1377 Repeat this command to undo more changes.
1378 A numeric argument serves as a repeat count.
1379 Contrary to `undo', this will not redo a previous undo."
1382 ;; Richard said that we should not use C-x <uppercase letter> and I have
1383 ;; no idea whereas to bind it. Any suggestion welcome. -stef
1384 ;; (define-key ctl-x-map "U" 'undo-only)
1387 "Non-nil while performing an undo.
1391 "Undo back N undo-boundaries beyond what was already undone recently.
1392 Call `undo-start' to get ready to undo recent changes,
1393 then call `undo-more' one or more times to undo them."
1403 ;; Deep copy of a list
1405 "Make a copy of undo list LIST."
1411 elt))
1414 "Set `pending-undo-list' to the front of the undo list.
1415 The next call to `undo-more' will undo the most recently made change.
1416 If BEG and END are specified, then only undo elements
1417 that apply to text between BEG and END are used; other undo elements
1418 are ignored. If BEG and END are nil, all undo elements are used."
1424 buffer-undo-list)))
1429 "Return a list of undo elements for the region START to END.
1430 The elements come from `buffer-undo-list', but we keep only
1431 the elements inside this region, and discard those outside this region.
1432 If we find an element that crosses an edge of this region,
1433 we stop and ignore all further elements."
1436 undo-adjusted-markers
1437 some-rejected
1438 undo-elt undo-elt temp-undo-list delta)
1443 ;; This is a "was unmodified" element.
1444 ;; Keep it if we have kept everything thus far.
1451 ;; Don't put two nils together in the list
1465 ;; Loop down the earlier events adjusting their buffer
1466 ;; positions to reflect the fact that a change to the buffer
1467 ;; isn't being undone. We only need to process those element
1468 ;; types which undo-elt-in-region will return as being in
1469 ;; the region since only those types can ever get into the
1470 ;; output
1479 ;; (TEXT . POSITION)
1486 ;; (BEGIN . END)
1491 ;; (nil PROPERTY VALUE BEG . END)
1501 "Determine whether UNDO-ELT falls inside the region START ... END.
1502 If it crosses the edge, we return nil."
1507 t)
1509 nil)
1511 ;; (TEXT . POSITION)
1515 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
1516 ;; See if MARKER is inside the region.
1527 ;; (nil PROPERTY VALUE BEG . END)
1532 ;; (BEGIN . END)
1537 "Test whether UNDO-ELT crosses one edge of that region START ... END.
1538 This assumes we have already decided that UNDO-ELT
1539 is not *inside* the region START...END."
1542 ;; (nil PROPERTY VALUE BEG . END)
1547 ;; (BEGIN . END)
1551 ;; Return the first affected buffer position and the delta for an undo element
1552 ;; delta is defined as the change in subsequent buffer positions if we *did*
1553 ;; the undo.
1557 ;; (TEXT . POSITION)
1560 ;; (BEGIN . END)
1567 "If non-nil ask about discarding undo info for the current command.
1568 Normally, Emacs discards the undo info for the current command if
1569 it exceeds `undo-outer-limit'. But if you set this option
1570 non-nil, it asks in the echo area whether to discard the info.
1571 If you answer no, there a slight risk that Emacs might crash, so
1572 only do it if you really want to undo the command.
1574 This option is mainly intended for debugging. You have to be
1575 careful if you use it for other purposes. Garbage collection is
1576 inhibited while the question is asked, meaning that Emacs might
1577 leak memory. So you should make sure that you do not wait
1578 excessively long before answering the question."
1584 "If non-nil, an extra level of size that's ok in an undo item.
1585 We don't ask the user about truncating the undo list until the
1586 current item gets bigger than this amount.
1591 ;; When the first undo batch in an undo list is longer than
1592 ;; undo-outer-limit, this function gets called to warn the user that
1593 ;; the undo info for the current command was discarded. Garbage
1594 ;; collection is inhibited around the call, so it had better not do a
1595 ;; lot of consing.
1601 ;; Don't ask the question again unless it gets even bigger.
1602 ;; This applies, in particular, if the user quits from the question.
1603 ;; Such a quit quits out of GC, but something else will call GC
1604 ;; again momentarily. It will call this function again,
1605 ;; but we don't want to ask the question again.
1612 t)
1613 nil))
1618 "The undo info was discarded because it exceeded \
1619 `undo-outer-limit'.
1621 This is normal if you executed a command that made a huge change
1622 to the buffer. In that case, to prevent similar problems in the
1623 future, set `undo-outer-limit' to a value that is large enough to
1624 cover the maximum size of normal changes you expect a single
1625 command to make, but not so large that it might exceed the
1626 maximum memory allotted to Emacs.
1628 If you did not execute any such command, the situation is
1629 probably due to a bug and you should report it.
1631 You can disable the popping up of this buffer by adding the entry
1635 t))
1636 \f
1644 "*Buffer name for `shell-command' and `shell-command-on-region' error output.
1645 This buffer is used when `shell-command' or `shell-command-on-region'
1646 is run interactively. A value of nil means that output to stderr and
1650 "Execute string COMMAND in inferior shell; display output, if any.
1651 With prefix argument, insert the COMMAND's output at point.
1653 If COMMAND ends in ampersand, execute it asynchronously.
1654 The output appears in the buffer `*Async Shell Command*'.
1655 That buffer is in shell mode.
1657 Otherwise, COMMAND is executed synchronously. The output appears in
1658 the buffer `*Shell Command Output*'. If the output is short enough to
1659 display in the echo area (which is determined by the variables
1660 `resize-mini-windows' and `max-mini-window-height'), it is shown
1661 there, but it is nonetheless available in buffer `*Shell Command
1662 Output*' even though that buffer is not automatically displayed.
1664 To specify a coding system for converting non-ASCII characters
1666 before this command.
1668 Noninteractive callers can specify coding systems by binding
1669 `coding-system-for-read' and `coding-system-for-write'.
1671 The optional second argument OUTPUT-BUFFER, if non-nil,
1672 says to put the output in some other buffer.
1673 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
1674 If OUTPUT-BUFFER is not a buffer and not nil,
1675 insert output in current buffer. (This cannot be done asynchronously.)
1676 In either case, the output is inserted after point (leaving mark after it).
1678 If the command terminates without error, but generates output,
1680 the output can be displayed in the echo area or in its buffer.
1681 If the output is short enough to display in the echo area
1682 \(determined by the variable `max-mini-window-height' if
1683 `resize-mini-windows' is non-nil), it is shown there. Otherwise,
1684 the buffer containing the output is displayed.
1688 of the output.
1690 If there is no output, or if output is inserted in the current buffer,
1691 then `*Shell Command Output*' is deleted.
1693 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
1694 or buffer name to which to direct the command's standard error output.
1695 If it is nil, error output is mingled with regular output.
1696 In an interactive call, the variable `shell-command-default-error-buffer'
1697 specifies the value of ERROR-BUFFER."
1701 current-prefix-arg
1702 shell-command-default-error-buffer))
1703 ;; Look for a handler in case default-directory is a remote file name.
1711 ;; Output goes in current buffer.
1717 temporary-file-directory)))
1718 nil)))
1721 ;; We do not use -f for csh; we will not support broken use of
1722 ;; .cshrcs. Even the BSD csh manual says to use
1723 ;; "if ($?prompt) exit" before things which are not useful
1724 ;; non-interactively. Besides, if someone wants their other
1725 ;; aliases for shell commands then they can still have them.
1729 t)
1730 nil shell-command-switch command)
1737 ;; Do no formatting while reading error file,
1738 ;; because that can run a shell command, and we
1739 ;; don't want that to cause an infinite recursion.
1741 ;; Put point after the inserted errors.
1745 ;; This is like exchange-point-and-mark, but doesn't
1746 ;; activate the mark. It is cleaner to avoid activation,
1747 ;; even though the command loop would deactivate the mark
1748 ;; because we inserted text.
1752 ;; Output goes in a separate buffer.
1753 ;; Preserve the match data in case called from a program.
1756 ;; Command ending with ampersand means asynchronous.
1760 proc)
1761 ;; Remove the ampersand.
1763 ;; If will kill a process, query first.
1775 shell-command-switch command))
1779 ))
1781 output-buffer nil error-buffer)))))))
1785 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
1786 MESSAGE may be either a string or a buffer.
1788 A buffer is displayed using `display-buffer' if MESSAGE is too long for
1789 the maximum height of the echo area, as defined by `max-mini-window-height'
1790 if `resize-mini-windows' is non-nil.
1792 Returns either the string shown in the echo area, or when a pop-up
1793 buffer is used, the window used to display it.
1795 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
1796 name of the buffer used to display it in the case where a pop-up buffer
1797 is used, defaulting to `*Message*'. In the case where MESSAGE is a
1798 string and it is displayed in the echo area, it is not specified whether
1799 the contents are inserted into the buffer anyway.
1801 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
1802 and only used if a buffer is displayed."
1804 ;; Trivial case where we can use the echo area
1808 ;; Trivial case where we can just remove single trailing newline
1811 ;; General case
1814 message
1823 0
1827 (<= lines
1831 max-mini-window-height))
1833 max-mini-window-height)
1837 ;; Don't use the echo area if the output buffer is
1838 ;; already dispayed in the selected frame.
1840 ;; Echo area
1846 ;; Buffer
1849 not-this-window frame))))))))
1852 ;; We have a sentinel to prevent insertion of a termination message
1853 ;; in the buffer itself.
1861 &optional output-buffer replace
1862 error-buffer display-error-buffer)
1863 "Execute string COMMAND in inferior shell with region as input.
1864 Normally display output (if any) in temp buffer `*Shell Command Output*';
1865 Prefix arg means replace the region with it. Return the exit code of
1866 COMMAND.
1868 To specify a coding system for converting non-ASCII characters
1870 before this command. By default, the input (from the current buffer)
1871 is encoded in the same coding system that will be used to save the file,
1872 `buffer-file-coding-system'. If the output is going to replace the region,
1873 then it is decoded from that same coding system.
1875 The noninteractive arguments are START, END, COMMAND,
1876 OUTPUT-BUFFER, REPLACE, ERROR-BUFFER, and DISPLAY-ERROR-BUFFER.
1877 Noninteractive callers can specify coding systems by binding
1878 `coding-system-for-read' and `coding-system-for-write'.
1880 If the command generates output, the output may be displayed
1881 in the echo area or in a buffer.
1882 If the output is short enough to display in the echo area
1883 \(determined by the variable `max-mini-window-height' if
1884 `resize-mini-windows' is non-nil), it is shown there. Otherwise
1885 it is displayed in the buffer `*Shell Command Output*'. The output
1886 is available in that buffer in both cases.
1888 If there is output and an error, a message about the error
1889 appears at the end of the output.
1891 If there is no output, or if output is inserted in the current buffer,
1892 then `*Shell Command Output*' is deleted.
1894 If the optional fourth argument OUTPUT-BUFFER is non-nil,
1895 that says to put the output in some other buffer.
1896 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
1897 If OUTPUT-BUFFER is not a buffer and not nil,
1898 insert output in the current buffer.
1899 In either case, the output is inserted after point (leaving mark after it).
1901 If REPLACE, the optional fifth argument, is non-nil, that means insert
1902 the output in place of text from START to END, putting point and mark
1903 around it.
1905 If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
1906 or buffer name to which to direct the command's standard error output.
1907 If it is nil, error output is mingled with regular output.
1908 If DISPLAY-ERROR-BUFFER is non-nil, display the error buffer if there
1909 were any errors. (This is always t, interactively.)
1910 In an interactive call, the variable `shell-command-default-error-buffer'
1911 specifies the value of ERROR-BUFFER."
1915 ;; Do this before calling region-beginning
1916 ;; and region-end, in case subprocess output
1917 ;; relocates them while we are in the minibuffer.
1919 nil nil nil
1921 ;; call-interactively recognizes region-beginning and
1922 ;; region-end specially, leaving them in the history.
1924 string
1925 current-prefix-arg
1926 current-prefix-arg
1927 shell-command-default-error-buffer
1928 t)))
1934 temporary-file-directory)))
1935 nil))
1936 exit-status)
1940 ;; Replace specified region with output from command.
1942 ;; Don't muck with mark unless REPLACE says we should.
1949 t)
1950 nil shell-command-switch command))
1951 ;; It is rude to delete a buffer which the command is not using.
1952 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
1953 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
1954 ;; (kill-buffer shell-buffer)))
1955 ;; Don't muck with mark unless REPLACE says we should.
1957 ;; No prefix argument: put the output in a temp buffer,
1958 ;; replacing its entire contents.
1963 ;; If the input is the same buffer as the output,
1964 ;; delete everything but the specified region,
1965 ;; then replace that region with the output.
1971 shell-file-name t
1974 t)
1975 nil shell-command-switch
1976 command)))
1977 ;; Clear the output buffer, then run the command with
1978 ;; output there.
1990 buffer)
1991 nil shell-command-switch command)))
1992 ;; Report the output.
2002 ;; There's some output, display it
2004 ;; No output; error?
2008 "some error output"
2014 output))
2017 exit-status))
2020 exit-status output))))
2021 ;; Don't kill: there might be useful info in the undo-log.
2022 ;; (kill-buffer buffer)
2023 ))))
2031 ;; Do no formatting while reading error file,
2032 ;; because that can run a shell command, and we
2033 ;; don't want that to cause an infinite recursion.
2035 ;; Put point after the inserted errors.
2040 exit-status))
2043 "Execute shell command COMMAND and return its output as a string."
2046 standard-output
2050 "Process files synchronously in a separate process.
2051 Similar to `call-process', but may invoke a file handler based on
2052 `default-directory'. The current working directory of the
2053 subprocess is `default-directory'.
2055 File names in INFILE and BUFFER are handled normally, but file
2056 names in ARGS should be relative to `default-directory', as they
2057 are passed to the process verbatim. \(This is a difference to
2058 `call-process' which does not support file handlers for INFILE
2059 and BUFFER.\)
2061 Some file handlers might not support all variants, for example
2062 they might behave as if DISPLAY was nil, regardless of the actual
2063 value passed."
2065 lc stderr-file)
2075 display args)
2081 \f
2085 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
2086 (define-key map [switch-frame] nil)
2087 (define-key map [?\C-u] 'universal-argument-more)
2088 (define-key map [?-] 'universal-argument-minus)
2089 (define-key map [?0] 'digit-argument)
2090 (define-key map [?1] 'digit-argument)
2091 (define-key map [?2] 'digit-argument)
2092 (define-key map [?3] 'digit-argument)
2093 (define-key map [?4] 'digit-argument)
2094 (define-key map [?5] 'digit-argument)
2095 (define-key map [?6] 'digit-argument)
2096 (define-key map [?7] 'digit-argument)
2097 (define-key map [?8] 'digit-argument)
2098 (define-key map [?9] 'digit-argument)
2099 (define-key map [kp-0] 'digit-argument)
2100 (define-key map [kp-1] 'digit-argument)
2101 (define-key map [kp-2] 'digit-argument)
2102 (define-key map [kp-3] 'digit-argument)
2103 (define-key map [kp-4] 'digit-argument)
2104 (define-key map [kp-5] 'digit-argument)
2105 (define-key map [kp-6] 'digit-argument)
2106 (define-key map [kp-7] 'digit-argument)
2107 (define-key map [kp-8] 'digit-argument)
2108 (define-key map [kp-9] 'digit-argument)
2109 (define-key map [kp-subtract] 'universal-argument-minus)
2110 map)
2113 (defvar universal-argument-num-events nil
2114 "Number of argument-specifying events read by `universal-argument'.
2115 `universal-argument-other-key' uses this to discard those events
2116 from (this-command-keys), and reread only the final command.")
2118 (defvar overriding-map-is-bound nil
2119 "Non-nil when `overriding-terminal-local-map' is `universal-argument-map'.")
2121 (defvar saved-overriding-map nil
2122 "The saved value of `overriding-terminal-local-map'.
2126 (defun ensure-overriding-map-is-bound ()
2127 "Check `overriding-terminal-local-map' is `universal-argument-map'."
2128 (unless overriding-map-is-bound
2129 (setq saved-overriding-map overriding-terminal-local-map)
2130 (setq overriding-terminal-local-map universal-argument-map)
2131 (setq overriding-map-is-bound t)))
2133 (defun restore-overriding-map ()
2134 "Restore `overriding-terminal-local-map' to its saved value."
2135 (setq overriding-terminal-local-map saved-overriding-map)
2136 (setq overriding-map-is-bound nil))
2138 (defun universal-argument ()
2139 "Begin a numeric argument for the following command.
2144 multiplies the argument by 4 each time.
2146 which is different in effect from any particular numeric argument.
2148 (interactive)
2149 (setq prefix-arg (list 4))
2150 (setq universal-argument-num-events (length (this-command-keys)))
2151 (ensure-overriding-map-is-bound))
2153 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
2154 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
2155 (defun universal-argument-more (arg)
2156 (interactive "P")
2157 (if (consp arg)
2158 (setq prefix-arg (list (* 4 (car arg))))
2159 (if (eq arg '-)
2160 (setq prefix-arg (list -4))
2161 (setq prefix-arg arg)
2162 (restore-overriding-map)))
2163 (setq universal-argument-num-events (length (this-command-keys))))
2165 (defun negative-argument (arg)
2166 "Begin a negative numeric argument for the next command.
2168 (interactive "P")
2169 (cond ((integerp arg)
2170 (setq prefix-arg (- arg)))
2171 ((eq arg '-)
2172 (setq prefix-arg nil))
2173 (t
2174 (setq prefix-arg '-)))
2175 (setq universal-argument-num-events (length (this-command-keys)))
2176 (ensure-overriding-map-is-bound))
2178 (defun digit-argument (arg)
2179 "Part of the numeric argument for the next command.
2181 (interactive "P")
2182 (let* ((char (if (integerp last-command-char)
2183 last-command-char
2184 (get last-command-char 'ascii-character)))
2186 (cond ((integerp arg)
2187 (setq prefix-arg (+ (* arg 10)
2188 (if (< arg 0) (- digit) digit))))
2189 ((eq arg '-)
2190 ;; Treat -0 as just -, so that -01 will work.
2191 (setq prefix-arg (if (zerop digit) '- (- digit))))
2192 (t
2193 (setq prefix-arg digit))))
2194 (setq universal-argument-num-events (length (this-command-keys)))
2195 (ensure-overriding-map-is-bound))
2197 ;; For backward compatibility, minus with no modifiers is an ordinary
2198 ;; command if digits have already been entered.
2199 (defun universal-argument-minus (arg)
2200 (interactive "P")
2201 (if (integerp arg)
2202 (universal-argument-other-key arg)
2203 (negative-argument arg)))
2205 ;; Anything else terminates the argument and is left in the queue to be
2206 ;; executed as a command.
2207 (defun universal-argument-other-key (arg)
2208 (interactive "P")
2209 (setq prefix-arg arg)
2210 (let* ((key (this-command-keys))
2211 (keylist (listify-key-sequence key)))
2212 (setq unread-command-events
2213 (append (nthcdr universal-argument-num-events keylist)
2214 unread-command-events)))
2215 (reset-this-command-lengths)
2216 (restore-overriding-map))
2217 \f
2218 ;;;; Window system cut and paste hooks.
2220 (defvar interprogram-cut-function nil
2221 "Function to call to make a killed region available to other programs.
2223 Most window systems provide some sort of facility for cutting and
2224 pasting text between the windows of different programs.
2225 This variable holds a function that Emacs calls whenever text
2226 is put in the kill ring, to make the new kill available to other
2227 programs.
2229 The function takes one or two arguments.
2230 The first argument, TEXT, is a string containing
2231 the text which should be made available.
2232 The second, optional, argument PUSH, has the same meaning as the
2233 similar argument to `x-set-cut-buffer', which see.")
2235 (defvar interprogram-paste-function nil
2236 "Function to call to get text cut from other programs.
2238 Most window systems provide some sort of facility for cutting and
2239 pasting text between the windows of different programs.
2240 This variable holds a function that Emacs calls to obtain
2241 text that other programs have provided for pasting.
2243 The function should be called with no arguments. If the function
2244 returns nil, then no other program has provided such text, and the top
2245 of the Emacs kill ring should be used. If the function returns a
2246 string, then the caller of the function \(usually `current-kill')
2247 should put this string in the kill ring as the latest kill.
2249 Note that the function should return a string only if a program other
2250 than Emacs has provided a string for pasting; if Emacs provided the
2251 most recent string, the function should return nil. If it is
2252 difficult to tell whether Emacs or some other program provided the
2253 current string, it is probably good enough to return nil if the string
2254 is equal (according to `string=') to the last text Emacs provided.")
2255 \f
2258 ;;;; The kill ring data structure.
2260 (defvar kill-ring nil
2261 "List of killed text sequences.
2262 Since the kill ring is supposed to interact nicely with cut-and-paste
2263 facilities offered by window systems, use of this variable should
2264 interact nicely with `interprogram-cut-function' and
2265 `interprogram-paste-function'. The functions `kill-new',
2266 `kill-append', and `current-kill' are supposed to implement this
2267 interaction; you may want to use them instead of manipulating the kill
2268 ring directly.")
2270 (defcustom kill-ring-max 60
2271 "*Maximum length of kill ring before oldest elements are thrown away."
2272 :type 'integer
2273 :group 'killing)
2275 (defvar kill-ring-yank-pointer nil
2276 "The tail of the kill ring whose car is the last thing yanked.")
2278 (defun kill-new (string &optional replace yank-handler)
2279 "Make STRING the latest kill in the kill ring.
2280 Set `kill-ring-yank-pointer' to point to it.
2281 If `interprogram-cut-function' is non-nil, apply it to STRING.
2282 Optional second argument REPLACE non-nil means that STRING will replace
2283 the front of the kill ring, rather than being added to the list.
2285 Optional third arguments YANK-HANDLER controls how the STRING is later
2286 inserted into a buffer; see `insert-for-yank' for details.
2287 When a yank handler is specified, STRING must be non-empty (the yank
2288 handler, if non-nil, is stored as a `yank-handler' text property on STRING).
2290 When the yank handler has a non-nil PARAM element, the original STRING
2291 argument is not used by `insert-for-yank'. However, since Lisp code
2292 may access and use elements from the kill-ring directly, the STRING
2294 (if (> (length string) 0)
2295 (if yank-handler
2296 (put-text-property 0 (length string)
2297 'yank-handler yank-handler string))
2298 (if yank-handler
2299 (signal 'args-out-of-range
2300 (list string "yank-handler specified for empty string"))))
2301 (if (fboundp 'menu-bar-update-yank-menu)
2302 (menu-bar-update-yank-menu string (and replace (car kill-ring))))
2303 (if (and replace kill-ring)
2304 (setcar kill-ring string)
2305 (setq kill-ring (cons string kill-ring))
2306 (if (> (length kill-ring) kill-ring-max)
2307 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil)))
2308 (setq kill-ring-yank-pointer kill-ring)
2309 (if interprogram-cut-function
2310 (funcall interprogram-cut-function string (not replace))))
2312 (defun kill-append (string before-p &optional yank-handler)
2313 "Append STRING to the end of the latest kill in the kill ring.
2314 If BEFORE-P is non-nil, prepend STRING to the kill.
2315 Optional third argument YANK-HANDLER, if non-nil, specifies the
2316 yank-handler text property to be set on the combined kill ring
2317 string. If the specified yank-handler arg differs from the
2318 yank-handler property of the latest kill string, this function
2319 adds the combined string to the kill ring as a new element,
2320 instead of replacing the last kill with it.
2321 If `interprogram-cut-function' is set, pass the resulting kill to it."
2322 (let* ((cur (car kill-ring)))
2323 (kill-new (if before-p (concat string cur) (concat cur string))
2324 (or (= (length cur) 0)
2325 (equal yank-handler (get-text-property 0 'yank-handler cur)))
2326 yank-handler)))
2328 (defun current-kill (n &optional do-not-move)
2329 "Rotate the yanking point by N places, and then return that kill.
2330 If N is zero, `interprogram-paste-function' is set, and calling it
2331 returns a string, then that string is added to the front of the
2332 kill ring and returned as the latest kill.
2333 If optional arg DO-NOT-MOVE is non-nil, then don't actually move the
2334 yanking point; just return the Nth kill forward."
2335 (let ((interprogram-paste (and (= n 0)
2336 interprogram-paste-function
2337 (funcall interprogram-paste-function))))
2338 (if interprogram-paste
2339 (progn
2340 ;; Disable the interprogram cut function when we add the new
2341 ;; text to the kill ring, so Emacs doesn't try to own the
2342 ;; selection, with identical text.
2343 (let ((interprogram-cut-function nil))
2344 (kill-new interprogram-paste))
2345 interprogram-paste)
2346 (or kill-ring (error "Kill ring is empty"))
2347 (let ((ARGth-kill-element
2348 (nthcdr (mod (- n (length kill-ring-yank-pointer))
2349 (length kill-ring))
2350 kill-ring)))
2351 (or do-not-move
2352 (setq kill-ring-yank-pointer ARGth-kill-element))
2353 (car ARGth-kill-element)))))
2357 ;;;; Commands for manipulating the kill ring.
2359 (defcustom kill-read-only-ok nil
2360 "*Non-nil means don't signal an error for killing read-only text."
2361 :type 'boolean
2362 :group 'killing)
2364 (put 'text-read-only 'error-conditions
2365 '(text-read-only buffer-read-only error))
2366 (put 'text-read-only 'error-message "Text is read-only")
2368 (defun kill-region (beg end &optional yank-handler)
2369 "Kill between point and mark.
2370 The text is deleted but saved in the kill ring.
2374 If you want to append the killed region to the last killed text,
2377 If the buffer is read-only, Emacs will beep and refrain from deleting
2378 the text, but put the text in the kill ring anyway. This means that
2379 you can use the killing commands to copy text from a read-only buffer.
2381 This is the primitive for programs to kill text (as opposed to deleting it).
2382 Supply two arguments, character positions indicating the stretch of text
2383 to be killed.
2385 If the previous command was also a kill command,
2386 the text killed this time appends to the text killed last time
2387 to make one entry in the kill ring.
2389 In Lisp code, optional third arg YANK-HANDLER, if non-nil,
2390 specifies the yank-handler text property to be set on the killed
2391 text. See `insert-for-yank'."
2392 (interactive "r")
2393 (condition-case nil
2394 (let ((string (delete-and-extract-region beg end)))
2395 (when string ;STRING is nil if BEG = END
2396 ;; Add that string to the kill ring, one way or another.
2397 (if (eq last-command 'kill-region)
2398 (kill-append string (< end beg) yank-handler)
2399 (kill-new string nil yank-handler)))
2400 (when (or string (eq last-command 'kill-region))
2401 (setq this-command 'kill-region))
2402 nil)
2403 ((buffer-read-only text-read-only)
2404 ;; The code above failed because the buffer, or some of the characters
2405 ;; in the region, are read-only.
2406 ;; We should beep, in case the user just isn't aware of this.
2407 ;; However, there's no harm in putting
2408 ;; the region's text in the kill ring, anyway.
2409 (copy-region-as-kill beg end)
2410 ;; Set this-command now, so it will be set even if we get an error.
2411 (setq this-command 'kill-region)
2412 ;; This should barf, if appropriate, and give us the correct error.
2413 (if kill-read-only-ok
2414 (progn (message "Read only text copied to kill ring") nil)
2415 ;; Signal an error if the buffer is read-only.
2416 (barf-if-buffer-read-only)
2417 ;; If the buffer isn't read-only, the text is.
2418 (signal 'text-read-only (list (current-buffer)))))))
2420 ;; copy-region-as-kill no longer sets this-command, because it's confusing
2421 ;; to get two copies of the text when the user accidentally types M-w and
2422 ;; then corrects it with the intended C-w.
2423 (defun copy-region-as-kill (beg end)
2424 "Save the region as if killed, but don't kill it.
2425 In Transient Mark mode, deactivate the mark.
2426 If `interprogram-cut-function' is non-nil, also save the text for a window
2427 system cut and paste."
2428 (interactive "r")
2429 (if (eq last-command 'kill-region)
2430 (kill-append (buffer-substring beg end) (< end beg))
2431 (kill-new (buffer-substring beg end)))
2432 (if transient-mark-mode
2433 (setq deactivate-mark t))
2434 nil)
2436 (defun kill-ring-save (beg end)
2437 "Save the region as if killed, but don't kill it.
2438 In Transient Mark mode, deactivate the mark.
2439 If `interprogram-cut-function' is non-nil, also save the text for a window
2440 system cut and paste.
2442 If you want to append the killed line to the last killed text,
2445 This command is similar to `copy-region-as-kill', except that it gives
2446 visual feedback indicating the extent of the region being copied."
2447 (interactive "r")
2448 (copy-region-as-kill beg end)
2449 ;; This use of interactive-p is correct
2450 ;; because the code it controls just gives the user visual feedback.
2451 (if (interactive-p)
2452 (let ((other-end (if (= (point) beg) end beg))
2453 (opoint (point))
2454 ;; Inhibit quitting so we can make a quit here
2455 ;; look like a C-g typed as a command.
2456 (inhibit-quit t))
2457 (if (pos-visible-in-window-p other-end (selected-window))
2458 (unless (and transient-mark-mode
2459 (face-background 'region))
2460 ;; Swap point and mark.
2461 (set-marker (mark-marker) (point) (current-buffer))
2462 (goto-char other-end)
2463 (sit-for blink-matching-delay)
2464 ;; Swap back.
2465 (set-marker (mark-marker) other-end (current-buffer))
2466 (goto-char opoint)
2467 ;; If user quit, deactivate the mark
2468 ;; as C-g would as a command.
2469 (and quit-flag mark-active
2470 (deactivate-mark)))
2471 (let* ((killed-text (current-kill 0))
2472 (message-len (min (length killed-text) 40)))
2473 (if (= (point) beg)
2474 ;; Don't say "killed"; that is misleading.
2476 (substring killed-text (- message-len)))
2478 (substring killed-text 0 message-len))))))))
2480 (defun append-next-kill (&optional interactive)
2481 "Cause following command, if it kills, to append to previous kill.
2482 The argument is used for internal purposes; do not supply one."
2483 (interactive "p")
2484 ;; We don't use (interactive-p), since that breaks kbd macros.
2485 (if interactive
2486 (progn
2487 (setq this-command 'kill-region)
2488 (message "If the next command is a kill, it will append"))
2489 (setq last-command 'kill-region)))
2490 \f
2491 ;; Yanking.
2493 ;; This is actually used in subr.el but defcustom does not work there.
2494 (defcustom yank-excluded-properties
2495 '(read-only invisible intangible field mouse-face help-echo local-map keymap
2496 yank-handler)
2497 "*Text properties to discard when yanking.
2498 The value should be a list of text properties to discard or t,
2499 which means to discard all text properties."
2500 :type '(choice (const :tag "All" t) (repeat symbol))
2501 :group 'killing
2502 :version "22.1")
2504 (defvar yank-window-start nil)
2505 (defvar yank-undo-function nil
2506 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
2507 Function is called with two parameters, START and END corresponding to
2508 the value of the mark and point; it is guaranteed that START <= END.
2509 Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
2511 (defun yank-pop (&optional arg)
2512 "Replace just-yanked stretch of killed text with a different stretch.
2513 This command is allowed only immediately after a `yank' or a `yank-pop'.
2514 At such a time, the region contains a stretch of reinserted
2515 previously-killed text. `yank-pop' deletes that text and inserts in its
2516 place a different stretch of killed text.
2518 With no argument, the previous kill is inserted.
2519 With argument N, insert the Nth previous kill.
2520 If N is negative, this is a more recent kill.
2522 The sequence of kills wraps around, so that after the oldest one
2523 comes the newest one."
2524 (interactive "*p")
2525 (if (not (eq last-command 'yank))
2526 (error "Previous command was not a yank"))
2527 (setq this-command 'yank)
2528 (unless arg (setq arg 1))
2529 (let ((inhibit-read-only t)
2530 (before (< (point) (mark t))))
2531 (if before
2532 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
2533 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
2534 (setq yank-undo-function nil)
2535 (set-marker (mark-marker) (point) (current-buffer))
2536 (insert-for-yank (current-kill arg))
2537 ;; Set the window start back where it was in the yank command,
2538 ;; if possible.
2539 (set-window-start (selected-window) yank-window-start t)
2540 (if before
2541 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
2542 ;; It is cleaner to avoid activation, even though the command
2543 ;; loop would deactivate the mark because we inserted text.
2544 (goto-char (prog1 (mark t)
2545 (set-marker (mark-marker) (point) (current-buffer))))))
2546 nil)
2548 (defun yank (&optional arg)
2549 "Reinsert the last stretch of killed text.
2550 More precisely, reinsert the stretch of killed text most recently
2551 killed OR yanked. Put point at end, and set mark at beginning.
2552 With just \\[universal-argument] as argument, same but put point at beginning (and mark at end).
2553 With argument N, reinsert the Nth most recently killed stretch of killed
2554 text.
2556 (interactive "*P")
2557 (setq yank-window-start (window-start))
2558 ;; If we don't get all the way thru, make last-command indicate that
2559 ;; for the following command.
2560 (setq this-command t)
2561 (push-mark (point))
2562 (insert-for-yank (current-kill (cond
2563 ((listp arg) 0)
2564 ((eq arg '-) -2)
2565 (t (1- arg)))))
2566 (if (consp arg)
2567 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
2568 ;; It is cleaner to avoid activation, even though the command
2569 ;; loop would deactivate the mark because we inserted text.
2570 (goto-char (prog1 (mark t)
2571 (set-marker (mark-marker) (point) (current-buffer)))))
2572 ;; If we do get all the way thru, make this-command indicate that.
2573 (if (eq this-command t)
2574 (setq this-command 'yank))
2575 nil)
2577 (defun rotate-yank-pointer (arg)
2578 "Rotate the yanking point in the kill ring.
2579 With argument, rotate that many kills forward (or backward, if negative)."
2580 (interactive "p")
2581 (current-kill arg))
2582 \f
2583 ;; Some kill commands.
2585 ;; Internal subroutine of delete-char
2586 (defun kill-forward-chars (arg)
2587 (if (listp arg) (setq arg (car arg)))
2588 (if (eq arg '-) (setq arg -1))
2589 (kill-region (point) (forward-point arg)))
2591 ;; Internal subroutine of backward-delete-char
2592 (defun kill-backward-chars (arg)
2593 (if (listp arg) (setq arg (car arg)))
2594 (if (eq arg '-) (setq arg -1))
2595 (kill-region (point) (forward-point (- arg))))
2597 (defcustom backward-delete-char-untabify-method 'untabify
2598 "*The method for untabifying when deleting backward.
2599 Can be `untabify' -- turn a tab to many spaces, then delete one space;
2600 `hungry' -- delete all whitespace, both tabs and spaces;
2601 `all' -- delete all whitespace, including tabs, spaces and newlines;
2602 nil -- just delete one character."
2603 :type '(choice (const untabify) (const hungry) (const all) (const nil))
2604 :version "20.3"
2605 :group 'killing)
2607 (defun backward-delete-char-untabify (arg &optional killp)
2608 "Delete characters backward, changing tabs into spaces.
2609 The exact behavior depends on `backward-delete-char-untabify-method'.
2610 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
2611 Interactively, ARG is the prefix arg (default 1)
2612 and KILLP is t if a prefix arg was specified."
2614 (when (eq backward-delete-char-untabify-method 'untabify)
2615 (let ((count arg))
2616 (save-excursion
2617 (while (and (> count 0) (not (bobp)))
2619 (let ((col (current-column)))
2620 (forward-char -1)
2621 (setq col (- col (current-column)))
2622 (insert-char ?\ col)
2623 (delete-char 1)))
2624 (forward-char -1)
2625 (setq count (1- count))))))
2626 (delete-backward-char
2628 ((eq backward-delete-char-untabify-method 'all)
2630 (if skip
2631 (let ((wh (- (point) (save-excursion (skip-chars-backward skip)
2632 (point)))))
2633 (+ arg (if (zerop wh) 0 (1- wh))))
2634 arg))
2635 killp))
2637 (defun zap-to-char (arg char)
2638 "Kill up to and including ARG'th occurrence of CHAR.
2639 Case is ignored if `case-fold-search' is non-nil in the current buffer.
2640 Goes backward if ARG is negative; error if CHAR not found."
2642 (kill-region (point) (progn
2643 (search-forward (char-to-string char) nil nil arg)
2644 ; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
2645 (point))))
2647 ;; kill-line and its subroutines.
2649 (defcustom kill-whole-line nil
2650 "*If non-nil, `kill-line' with no arg at beg of line kills the whole line."
2651 :type 'boolean
2652 :group 'killing)
2654 (defun kill-line (&optional arg)
2655 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
2656 With prefix argument, kill that many lines from point.
2657 Negative arguments kill lines backward.
2658 With zero argument, kills the text before point on the current line.
2661 a number counts as a prefix arg.
2663 To kill a whole line, when point is not at the beginning, type \
2666 If `kill-whole-line' is non-nil, then this command kills the whole line
2667 including its terminating newline, when used at the beginning of a line
2668 with no argument. As a consequence, you can always kill a whole line
2671 If you want to append the killed line to the last killed text,
2674 If the buffer is read-only, Emacs will beep and refrain from deleting
2675 the line, but put the line in the kill ring anyway. This means that
2676 you can use this command to copy text from a read-only buffer.
2677 \(If the variable `kill-read-only-ok' is non-nil, then this won't
2678 even beep.)"
2679 (interactive "P")
2680 (kill-region (point)
2681 ;; It is better to move point to the other end of the kill
2682 ;; before killing. That way, in a read-only buffer, point
2683 ;; moves across the text that is copied to the kill ring.
2684 ;; The choice has no effect on undo now that undo records
2685 ;; the value of point from before the command was run.
2686 (progn
2687 (if arg
2688 (forward-visible-line (prefix-numeric-value arg))
2689 (if (eobp)
2690 (signal 'end-of-buffer nil))
2691 (let ((end
2692 (save-excursion
2693 (end-of-visible-line) (point))))
2694 (if (or (save-excursion
2695 ;; If trailing whitespace is visible,
2696 ;; don't treat it as nothing.
2697 (unless show-trailing-whitespace
2699 (= (point) end))
2700 (and kill-whole-line (bolp)))
2701 (forward-visible-line 1)
2702 (goto-char end))))
2703 (point))))
2705 (defun kill-whole-line (&optional arg)
2706 "Kill current line.
2707 With prefix arg, kill that many lines starting from the current line.
2708 If arg is negative, kill backward. Also kill the preceding newline.
2709 \(This is meant to make C-x z work well with negative arguments.\)
2710 If arg is zero, kill current line but exclude the trailing newline."
2711 (interactive "p")
2712 (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
2713 (signal 'end-of-buffer nil))
2714 (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
2715 (signal 'beginning-of-buffer nil))
2716 (unless (eq last-command 'kill-region)
2717 (kill-new "")
2718 (setq last-command 'kill-region))
2719 (cond ((zerop arg)
2720 ;; We need to kill in two steps, because the previous command
2721 ;; could have been a kill command, in which case the text
2722 ;; before point needs to be prepended to the current kill
2723 ;; ring entry and the text after point appended. Also, we
2724 ;; need to use save-excursion to avoid copying the same text
2725 ;; twice to the kill ring in read-only buffers.
2726 (save-excursion
2727 (kill-region (point) (progn (forward-visible-line 0) (point))))
2728 (kill-region (point) (progn (end-of-visible-line) (point))))
2729 ((< arg 0)
2730 (save-excursion
2731 (kill-region (point) (progn (end-of-visible-line) (point))))
2732 (kill-region (point)
2733 (progn (forward-visible-line (1+ arg))
2734 (unless (bobp) (backward-char))
2735 (point))))
2736 (t
2737 (save-excursion
2738 (kill-region (point) (progn (forward-visible-line 0) (point))))
2739 (kill-region (point)
2740 (progn (forward-visible-line arg) (point))))))
2742 (defun forward-visible-line (arg)
2743 "Move forward by ARG lines, ignoring currently invisible newlines only.
2744 If ARG is negative, move backward -ARG lines.
2745 If ARG is zero, move to the beginning of the current line."
2746 (condition-case nil
2747 (if (> arg 0)
2748 (progn
2749 (while (> arg 0)
2750 (or (zerop (forward-line 1))
2751 (signal 'end-of-buffer nil))
2752 ;; If the newline we just skipped is invisible,
2753 ;; don't count it.
2754 (let ((prop
2755 (get-char-property (1- (point)) 'invisible)))
2756 (if (if (eq buffer-invisibility-spec t)
2757 prop
2758 (or (memq prop buffer-invisibility-spec)
2759 (assq prop buffer-invisibility-spec)))
2760 (setq arg (1+ arg))))
2761 (setq arg (1- arg)))
2762 ;; If invisible text follows, and it is a number of complete lines,
2763 ;; skip it.
2764 (let ((opoint (point)))
2765 (while (and (not (eobp))
2766 (let ((prop
2767 (get-char-property (point) 'invisible)))
2768 (if (eq buffer-invisibility-spec t)
2769 prop
2770 (or (memq prop buffer-invisibility-spec)
2771 (assq prop buffer-invisibility-spec)))))
2772 (goto-char
2773 (if (get-text-property (point) 'invisible)
2774 (or (next-single-property-change (point) 'invisible)
2775 (point-max))
2776 (next-overlay-change (point)))))
2777 (unless (bolp)
2778 (goto-char opoint))))
2779 (let ((first t))
2780 (while (or first (<= arg 0))
2781 (if first
2782 (beginning-of-line)
2783 (or (zerop (forward-line -1))
2784 (signal 'beginning-of-buffer nil)))
2785 ;; If the newline we just moved to is invisible,
2786 ;; don't count it.
2787 (unless (bobp)
2788 (let ((prop
2789 (get-char-property (1- (point)) 'invisible)))
2790 (unless (if (eq buffer-invisibility-spec t)
2791 prop
2792 (or (memq prop buffer-invisibility-spec)
2793 (assq prop buffer-invisibility-spec)))
2794 (setq arg (1+ arg)))))
2795 (setq first nil))
2796 ;; If invisible text follows, and it is a number of complete lines,
2797 ;; skip it.
2798 (let ((opoint (point)))
2799 (while (and (not (bobp))
2800 (let ((prop
2801 (get-char-property (1- (point)) 'invisible)))
2802 (if (eq buffer-invisibility-spec t)
2803 prop
2804 (or (memq prop buffer-invisibility-spec)
2805 (assq prop buffer-invisibility-spec)))))
2806 (goto-char
2807 (if (get-text-property (1- (point)) 'invisible)
2808 (or (previous-single-property-change (point) 'invisible)
2809 (point-min))
2810 (previous-overlay-change (point)))))
2811 (unless (bolp)
2812 (goto-char opoint)))))
2813 ((beginning-of-buffer end-of-buffer)
2814 nil)))
2816 (defun end-of-visible-line ()
2817 "Move to end of current visible line."
2818 (end-of-line)
2819 ;; If the following character is currently invisible,
2820 ;; skip all characters with that same `invisible' property value,
2821 ;; then find the next newline.
2822 (while (and (not (eobp))
2823 (save-excursion
2825 (let ((prop
2826 (get-char-property (point) 'invisible)))
2827 (if (eq buffer-invisibility-spec t)
2828 prop
2829 (or (memq prop buffer-invisibility-spec)
2830 (assq prop buffer-invisibility-spec))))))
2832 (if (get-text-property (point) 'invisible)
2833 (goto-char (next-single-property-change (point) 'invisible))
2834 (goto-char (next-overlay-change (point))))
2835 (end-of-line)))
2836 \f
2837 (defun insert-buffer (buffer)
2838 "Insert after point the contents of BUFFER.
2839 Puts mark after the inserted text.
2840 BUFFER may be a buffer or a buffer name.
2842 This function is meant for the user to run interactively.
2843 Don't call it from programs: use `insert-buffer-substring' instead!"
2844 (interactive
2845 (list
2846 (progn
2847 (barf-if-buffer-read-only)
2848 (read-buffer "Insert buffer: "
2849 (if (eq (selected-window) (next-window (selected-window)))
2850 (other-buffer (current-buffer))
2851 (window-buffer (next-window (selected-window))))
2852 t))))
2853 (push-mark
2854 (save-excursion
2855 (insert-buffer-substring (get-buffer buffer))
2856 (point)))
2857 nil)
2859 (defun append-to-buffer (buffer start end)
2860 "Append to specified buffer the text of the region.
2861 It is inserted into that buffer before its point.
2863 When calling from a program, give three arguments:
2864 BUFFER (or buffer name), START and END.
2865 START and END specify the portion of the current buffer to be copied."
2866 (interactive
2867 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
2868 (region-beginning) (region-end)))
2869 (let ((oldbuf (current-buffer)))
2870 (save-excursion
2871 (let* ((append-to (get-buffer-create buffer))
2872 (windows (get-buffer-window-list append-to t t))
2873 point)
2874 (set-buffer append-to)
2875 (setq point (point))
2876 (barf-if-buffer-read-only)
2877 (insert-buffer-substring oldbuf start end)
2878 (dolist (window windows)
2879 (when (= (window-point window) point)
2880 (set-window-point window (point))))))))
2882 (defun prepend-to-buffer (buffer start end)
2883 "Prepend to specified buffer the text of the region.
2884 It is inserted into that buffer after its point.
2886 When calling from a program, give three arguments:
2887 BUFFER (or buffer name), START and END.
2888 START and END specify the portion of the current buffer to be copied."
2890 (let ((oldbuf (current-buffer)))
2891 (save-excursion
2892 (set-buffer (get-buffer-create buffer))
2893 (barf-if-buffer-read-only)
2894 (save-excursion
2895 (insert-buffer-substring oldbuf start end)))))
2897 (defun copy-to-buffer (buffer start end)
2898 "Copy to specified buffer the text of the region.
2899 It is inserted into that buffer, replacing existing text there.
2901 When calling from a program, give three arguments:
2902 BUFFER (or buffer name), START and END.
2903 START and END specify the portion of the current buffer to be copied."
2905 (let ((oldbuf (current-buffer)))
2906 (save-excursion
2907 (set-buffer (get-buffer-create buffer))
2908 (barf-if-buffer-read-only)
2909 (erase-buffer)
2910 (save-excursion
2911 (insert-buffer-substring oldbuf start end)))))
2912 \f
2913 (put 'mark-inactive 'error-conditions '(mark-inactive error))
2914 (put 'mark-inactive 'error-message "The mark is not active now")
2916 (defvar activate-mark-hook nil
2917 "Hook run when the mark becomes active.
2918 It is also run at the end of a command, if the mark is active and
2919 it is possible that the region may have changed")
2921 (defvar deactivate-mark-hook nil
2922 "Hook run when the mark becomes inactive.")
2924 (defun mark (&optional force)
2925 "Return this buffer's mark value as integer; error if mark inactive.
2926 If optional argument FORCE is non-nil, access the mark value
2927 even if the mark is not currently active, and return nil
2928 if there is no mark at all.
2930 If you are using this in an editing command, you are most likely making
2931 a mistake; see the documentation of `set-mark'."
2932 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
2933 (marker-position (mark-marker))
2934 (signal 'mark-inactive nil)))
2936 ;; Many places set mark-active directly, and several of them failed to also
2937 ;; run deactivate-mark-hook. This shorthand should simplify.
2938 (defsubst deactivate-mark ()
2939 "Deactivate the mark by setting `mark-active' to nil.
2940 \(That makes a difference only in Transient Mark mode.)
2941 Also runs the hook `deactivate-mark-hook'."
2942 (cond
2943 ((eq transient-mark-mode 'lambda)
2944 (setq transient-mark-mode nil))
2945 (transient-mark-mode
2946 (setq mark-active nil)
2947 (run-hooks 'deactivate-mark-hook))))
2949 (defun set-mark (pos)
2950 "Set this buffer's mark to POS. Don't use this function!
2951 That is to say, don't use this function unless you want
2952 the user to see that the mark has moved, and you want the previous
2953 mark position to be lost.
2955 Normally, when a new mark is set, the old one should go on the stack.
2956 This is why most applications should use push-mark, not set-mark.
2958 Novice Emacs Lisp programmers often try to use the mark for the wrong
2959 purposes. The mark saves a location for the user's convenience.
2960 Most editing commands should not alter the mark.
2961 To remember a location for internal use in the Lisp program,
2962 store it in a Lisp variable. Example:
2964 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
2966 (if pos
2967 (progn
2968 (setq mark-active t)
2969 (run-hooks 'activate-mark-hook)
2970 (set-marker (mark-marker) pos (current-buffer)))
2971 ;; Normally we never clear mark-active except in Transient Mark mode.
2972 ;; But when we actually clear out the mark value too,
2973 ;; we must clear mark-active in any mode.
2974 (setq mark-active nil)
2975 (run-hooks 'deactivate-mark-hook)
2976 (set-marker (mark-marker) nil)))
2978 (defvar mark-ring nil
2979 "The list of former marks of the current buffer, most recent first.")
2980 (make-variable-buffer-local 'mark-ring)
2981 (put 'mark-ring 'permanent-local t)
2983 (defcustom mark-ring-max 16
2984 "*Maximum size of mark ring. Start discarding off end if gets this big."
2985 :type 'integer
2986 :group 'editing-basics)
2988 (defvar global-mark-ring nil
2989 "The list of saved global marks, most recent first.")
2991 (defcustom global-mark-ring-max 16
2992 "*Maximum size of global mark ring. \
2993 Start discarding off end if gets this big."
2994 :type 'integer
2995 :group 'editing-basics)
2997 (defun pop-to-mark-command ()
2998 "Jump to mark, and pop a new position for mark off the ring
2999 \(does not affect global mark ring\)."
3000 (interactive)
3001 (if (null (mark t))
3002 (error "No mark set in this buffer")
3003 (goto-char (mark t))
3004 (pop-mark)))
3006 (defun push-mark-command (arg &optional nomsg)
3007 "Set mark at where point is.
3008 If no prefix arg and mark is already set there, just activate it.
3009 Display `Mark set' unless the optional second arg NOMSG is non-nil."
3010 (interactive "P")
3011 (let ((mark (marker-position (mark-marker))))
3012 (if (or arg (null mark) (/= mark (point)))
3013 (push-mark nil nomsg t)
3014 (setq mark-active t)
3015 (run-hooks 'activate-mark-hook)
3016 (unless nomsg
3017 (message "Mark activated")))))
3019 (defun set-mark-command (arg)
3020 "Set mark at where point is, or jump to mark.
3021 With no prefix argument, set mark, and push old mark position on local
3022 mark ring; also push mark on global mark ring if last mark was set in
3023 another buffer. Immediately repeating the command activates
3024 `transient-mark-mode' temporarily.
3027 jump to mark, and pop a new position
3028 for mark off the local mark ring \(this does not affect the global
3030 mark ring \(see `pop-global-mark'\).
3033 the next position off the local (or global) mark ring.
3037 set mark where point is.
3039 Novice Emacs Lisp programmers often try to use the mark for the wrong
3040 purposes. See the documentation of `set-mark' for more information."
3041 (interactive "P")
3042 (if (eq transient-mark-mode 'lambda)
3043 (setq transient-mark-mode nil))
3044 (cond
3045 ((and (consp arg) (> (prefix-numeric-value arg) 4))
3046 (push-mark-command nil))
3047 ((not (eq this-command 'set-mark-command))
3048 (if arg
3049 (pop-to-mark-command)
3050 (push-mark-command t)))
3051 ((eq last-command 'pop-to-mark-command)
3052 (setq this-command 'pop-to-mark-command)
3053 (pop-to-mark-command))
3054 ((and (eq last-command 'pop-global-mark) (not arg))
3055 (setq this-command 'pop-global-mark)
3056 (pop-global-mark))
3057 (arg
3058 (setq this-command 'pop-to-mark-command)
3059 (pop-to-mark-command))
3060 ((and (eq last-command 'set-mark-command)
3061 mark-active (null transient-mark-mode))
3062 (setq transient-mark-mode 'lambda)
3063 (message "Transient-mark-mode temporarily enabled"))
3064 (t
3065 (push-mark-command nil))))
3067 (defun push-mark (&optional location nomsg activate)
3068 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
3069 If the last global mark pushed was not in the current buffer,
3070 also push LOCATION on the global mark ring.
3071 Display `Mark set' unless the optional second arg NOMSG is non-nil.
3072 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil.
3074 Novice Emacs Lisp programmers often try to use the mark for the wrong
3075 purposes. See the documentation of `set-mark' for more information.
3077 In Transient Mark mode, this does not activate the mark."
3078 (unless (null (mark t))
3079 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
3080 (when (> (length mark-ring) mark-ring-max)
3081 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
3082 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))
3083 (set-marker (mark-marker) (or location (point)) (current-buffer))
3084 ;; Now push the mark on the global mark ring.
3085 (if (and global-mark-ring
3086 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
3087 ;; The last global mark pushed was in this same buffer.
3088 ;; Don't push another one.
3089 nil
3090 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
3091 (when (> (length global-mark-ring) global-mark-ring-max)
3092 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring)) nil)
3093 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))
3094 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
3095 (message "Mark set"))
3096 (if (or activate (not transient-mark-mode))
3097 (set-mark (mark t)))
3098 nil)
3100 (defun pop-mark ()
3101 "Pop off mark ring into the buffer's actual mark.
3102 Does not set point. Does nothing if mark ring is empty."
3103 (when mark-ring
3104 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
3105 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
3106 (move-marker (car mark-ring) nil)
3107 (if (null (mark t)) (ding))
3108 (setq mark-ring (cdr mark-ring)))
3109 (deactivate-mark))
3111 (defalias 'exchange-dot-and-mark 'exchange-point-and-mark)
3112 (defun exchange-point-and-mark (&optional arg)
3113 "Put the mark where point is now, and point where the mark is now.
3114 This command works even when the mark is not active,
3115 and it reactivates the mark.
3116 With prefix arg, `transient-mark-mode' is enabled temporarily."
3117 (interactive "P")
3118 (if arg
3119 (if mark-active
3120 (if (null transient-mark-mode)
3121 (setq transient-mark-mode 'lambda))
3122 (setq arg nil)))
3123 (unless arg
3124 (let ((omark (mark t)))
3125 (if (null omark)
3126 (error "No mark set in this buffer"))
3127 (set-mark (point))
3128 (goto-char omark)
3129 nil)))
3131 (define-minor-mode transient-mark-mode
3132 "Toggle Transient Mark mode.
3133 With arg, turn Transient Mark mode on if arg is positive, off otherwise.
3135 In Transient Mark mode, when the mark is active, the region is highlighted.
3137 So do certain other operations that set the mark
3138 but whose main purpose is something else--for example,
3144 Many commands change their behavior when Transient Mark mode is in effect
3145 and the mark is active, by acting on the region instead of their usual
3146 default part of the buffer's text. Examples of such commands include
3151 commands which are sensitive to the Transient Mark mode."
3152 :global t :group 'editing-basics :require nil)
3154 (defun pop-global-mark ()
3155 "Pop off global mark ring and jump to the top location."
3156 (interactive)
3157 ;; Pop entries which refer to non-existent buffers.
3158 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
3159 (setq global-mark-ring (cdr global-mark-ring)))
3160 (or global-mark-ring
3161 (error "No global mark set"))
3162 (let* ((marker (car global-mark-ring))
3163 (buffer (marker-buffer marker))
3164 (position (marker-position marker)))
3165 (setq global-mark-ring (nconc (cdr global-mark-ring)
3166 (list (car global-mark-ring))))
3167 (set-buffer buffer)
3168 (or (and (>= position (point-min))
3169 (<= position (point-max)))
3170 (widen))
3171 (goto-char position)
3172 (switch-to-buffer buffer)))
3173 \f
3174 (defcustom next-line-add-newlines nil
3175 "*If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
3176 :type 'boolean
3177 :version "21.1"
3178 :group 'editing-basics)
3180 (defun next-line (&optional arg try-vscroll)
3181 "Move cursor vertically down ARG lines.
3182 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
3183 If there is no character in the target line exactly under the current column,
3184 the cursor is positioned after the character in that line which spans this
3185 column, or at the end of the line if it is not long enough.
3186 If there is no line in the buffer after this one, behavior depends on the
3187 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
3188 to create a line, and moves the cursor to that line. Otherwise it moves the
3189 cursor to the end of the buffer.
3192 a semipermanent goal column for this command.
3193 Then instead of trying to move exactly vertically (or as close as possible),
3194 this command moves to the specified goal column (or as close as possible).
3195 The goal column is stored in the variable `goal-column', which is nil
3196 when there is no goal column.
3198 If you are thinking of using this in a Lisp program, consider
3199 using `forward-line' instead. It is usually easier to use
3200 and more reliable (no dependence on goal column, etc.)."
3202 (or arg (setq arg 1))
3203 (if (and next-line-add-newlines (= arg 1))
3204 (if (save-excursion (end-of-line) (eobp))
3205 ;; When adding a newline, don't expand an abbrev.
3206 (let ((abbrev-mode nil))
3207 (end-of-line)
3209 (line-move arg nil nil try-vscroll))
3210 (if (interactive-p)
3211 (condition-case nil
3212 (line-move arg nil nil try-vscroll)
3213 ((beginning-of-buffer end-of-buffer) (ding)))
3214 (line-move arg nil nil try-vscroll)))
3215 nil)
3217 (defun previous-line (&optional arg try-vscroll)
3218 "Move cursor vertically up ARG lines.
3219 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
3220 If there is no character in the target line exactly over the current column,
3221 the cursor is positioned after the character in that line which spans this
3222 column, or at the end of the line if it is not long enough.
3225 a semipermanent goal column for this command.
3226 Then instead of trying to move exactly vertically (or as close as possible),
3227 this command moves to the specified goal column (or as close as possible).
3228 The goal column is stored in the variable `goal-column', which is nil
3229 when there is no goal column.
3231 If you are thinking of using this in a Lisp program, consider using
3232 `forward-line' with a negative argument instead. It is usually easier
3233 to use and more reliable (no dependence on goal column, etc.)."
3235 (or arg (setq arg 1))
3236 (if (interactive-p)
3237 (condition-case nil
3238 (line-move (- arg) nil nil try-vscroll)
3239 ((beginning-of-buffer end-of-buffer) (ding)))
3240 (line-move (- arg) nil nil try-vscroll))
3241 nil)
3243 (defcustom track-eol nil
3244 "*Non-nil means vertical motion starting at end of line keeps to ends of lines.
3245 This means moving to the end of each line moved onto.
3246 The beginning of a blank line does not count as the end of a line."
3247 :type 'boolean
3248 :group 'editing-basics)
3250 (defcustom goal-column nil
3252 :type '(choice integer
3253 (const :tag "None" nil))
3254 :group 'editing-basics)
3255 (make-variable-buffer-local 'goal-column)
3257 (defvar temporary-goal-column 0
3258 "Current goal column for vertical motion.
3259 It is the column where point was
3260 at the start of current run of vertical motion commands.
3261 When the `track-eol' feature is doing its job, the value is 9999.")
3263 (defcustom line-move-ignore-invisible t
3265 Outline mode sets this."
3266 :type 'boolean
3267 :group 'editing-basics)
3269 (defun line-move-invisible-p (pos)
3270 "Return non-nil if the character after POS is currently invisible."
3271 (let ((prop
3272 (get-char-property pos 'invisible)))
3273 (if (eq buffer-invisibility-spec t)
3274 prop
3275 (or (memq prop buffer-invisibility-spec)
3276 (assq prop buffer-invisibility-spec)))))
3278 ;; Perform vertical scrolling of tall images if necessary.
3279 ;; Don't vscroll in a keyboard macro.
3280 (defun line-move (arg &optional noerror to-end try-vscroll)
3281 (if (and auto-window-vscroll try-vscroll
3282 (not defining-kbd-macro)
3283 (not executing-kbd-macro))
3284 (let ((forward (> arg 0))
3285 (part (nth 2 (pos-visible-in-window-p (point) nil t))))
3286 (if (and (consp part)
3287 (> (setq part (if forward (cdr part) (car part))) 0))
3288 (set-window-vscroll nil
3289 (if forward
3290 (+ (window-vscroll nil t)
3291 (min part
3292 (* (frame-char-height) arg)))
3293 (max 0
3294 (- (window-vscroll nil t)
3295 (min part
3296 (* (frame-char-height) (- arg))))))
3297 t)
3298 (set-window-vscroll nil 0)
3299 (when (line-move-1 arg noerror to-end)
3300 (sit-for 0)
3301 (if (and (not forward)
3302 (setq part (nth 2 (pos-visible-in-window-p
3303 (line-beginning-position) nil t)))
3304 (> (cdr part) 0))
3305 (set-window-vscroll nil (cdr part) t))
3306 t)))
3307 (line-move-1 arg noerror to-end)))
3309 ;; This is the guts of next-line and previous-line.
3310 ;; Arg says how many lines to move.
3311 ;; The value is t if we can move the specified number of lines.
3312 (defun line-move-1 (arg &optional noerror to-end)
3313 ;; Don't run any point-motion hooks, and disregard intangibility,
3314 ;; for intermediate positions.
3315 (let ((inhibit-point-motion-hooks t)
3316 (opoint (point))
3317 (forward (> arg 0)))
3318 (unwind-protect
3319 (progn
3320 (if (not (memq last-command '(next-line previous-line)))
3321 (setq temporary-goal-column
3322 (if (and track-eol (eolp)
3323 ;; Don't count beg of empty line as end of line
3324 ;; unless we just did explicit end-of-line.
3325 (or (not (bolp)) (eq last-command 'end-of-line)))
3326 9999
3327 (current-column))))
3329 (if (and (not (integerp selective-display))
3330 (not line-move-ignore-invisible))
3331 ;; Use just newline characters.
3332 ;; Set ARG to 0 if we move as many lines as requested.
3333 (or (if (> arg 0)
3334 (progn (if (> arg 1) (forward-line (1- arg)))
3335 ;; This way of moving forward ARG lines
3336 ;; verifies that we have a newline after the last one.
3337 ;; It doesn't get confused by intangible text.
3338 (end-of-line)
3339 (if (zerop (forward-line 1))
3340 (setq arg 0)))
3341 (and (zerop (forward-line arg))
3342 (bolp)
3343 (setq arg 0)))
3344 (unless noerror
3345 (signal (if (< arg 0)
3346 'beginning-of-buffer
3347 'end-of-buffer)
3348 nil)))
3349 ;; Move by arg lines, but ignore invisible ones.
3350 (let (done)
3351 (while (and (> arg 0) (not done))
3352 ;; If the following character is currently invisible,
3353 ;; skip all characters with that same `invisible' property value.
3354 (while (and (not (eobp)) (line-move-invisible-p (point)))
3355 (goto-char (next-char-property-change (point))))
3356 ;; Now move a line.
3357 (end-of-line)
3358 (and (zerop (vertical-motion 1))
3359 (if (not noerror)
3360 (signal 'end-of-buffer nil)
3361 (setq done t)))
3362 (unless done
3363 (setq arg (1- arg))))
3364 (while (and (< arg 0) (not done))
3365 (beginning-of-line)
3367 (if (zerop (vertical-motion -1))
3368 (if (not noerror)
3369 (signal 'beginning-of-buffer nil)
3370 (setq done t)))
3371 (unless done
3372 (setq arg (1+ arg))
3373 (while (and ;; Don't move over previous invis lines
3374 ;; if our target is the middle of this line.
3375 (or (zerop (or goal-column temporary-goal-column))
3376 (< arg 0))
3377 (not (bobp)) (line-move-invisible-p (1- (point))))
3378 (goto-char (previous-char-property-change (point))))))))
3379 ;; This is the value the function returns.
3380 (= arg 0))
3382 (cond ((> arg 0)
3383 ;; If we did not move down as far as desired,
3384 ;; at least go to end of line.
3385 (end-of-line))
3386 ((< arg 0)
3387 ;; If we did not move down as far as desired,
3388 ;; at least go to end of line.
3389 (beginning-of-line))
3390 (t
3391 (line-move-finish (or goal-column temporary-goal-column)
3392 opoint forward))))))
3394 (defun line-move-finish (column opoint forward)
3395 (let ((repeat t))
3396 (while repeat
3397 ;; Set REPEAT to t to repeat the whole thing.
3398 (setq repeat nil)
3400 (let (new
3401 (line-beg (save-excursion (beginning-of-line) (point)))
3402 (line-end
3403 ;; Compute the end of the line
3404 ;; ignoring effectively invisible newlines.
3405 (save-excursion
3406 (end-of-line)
3407 (while (and (not (eobp)) (line-move-invisible-p (point)))
3408 (goto-char (next-char-property-change (point)))
3409 (end-of-line))
3410 (point))))
3412 ;; Move to the desired column.
3413 (line-move-to-column column)
3414 (setq new (point))
3416 ;; Process intangibility within a line.
3417 ;; Move to the chosen destination position from above,
3418 ;; with intangibility processing enabled.
3420 (goto-char (point-min))
3421 (let ((inhibit-point-motion-hooks nil))
3422 (goto-char new)
3424 ;; If intangibility moves us to a different (later) place
3425 ;; in the same line, use that as the destination.
3426 (if (<= (point) line-end)
3427 (setq new (point))
3428 ;; If that position is "too late",
3429 ;; try the previous allowable position.
3430 ;; See if it is ok.
3431 (backward-char)
3432 (if (if forward
3433 ;; If going forward, don't accept the previous
3434 ;; allowable position if it is before the target line.
3435 (< line-beg (point))
3436 ;; If going backward, don't accept the previous
3437 ;; allowable position if it is still after the target line.
3438 (<= (point) line-end))
3439 (setq new (point))
3440 ;; As a last resort, use the end of the line.
3441 (setq new line-end))))
3443 ;; Now move to the updated destination, processing fields
3444 ;; as well as intangibility.
3445 (goto-char opoint)
3446 (let ((inhibit-point-motion-hooks nil))
3447 (goto-char
3448 (constrain-to-field new opoint nil t
3449 'inhibit-line-move-field-capture)))
3451 ;; If all this moved us to a different line,
3452 ;; retry everything within that new line.
3453 (when (or (< (point) line-beg) (> (point) line-end))
3454 ;; Repeat the intangibility and field processing.
3455 (setq repeat t))))))
3457 (defun line-move-to-column (col)
3458 "Try to find column COL, considering invisibility.
3459 This function works only in certain cases,
3460 because what we really need is for `move-to-column'
3461 and `current-column' to be able to ignore invisible text."
3462 (if (zerop col)
3463 (beginning-of-line)
3464 (move-to-column col))
3466 (when (and line-move-ignore-invisible
3467 (not (bolp)) (line-move-invisible-p (1- (point))))
3468 (let ((normal-location (point))
3469 (normal-column (current-column)))
3470 ;; If the following character is currently invisible,
3471 ;; skip all characters with that same `invisible' property value.
3472 (while (and (not (eobp))
3473 (line-move-invisible-p (point)))
3474 (goto-char (next-char-property-change (point))))
3475 ;; Have we advanced to a larger column position?
3476 (if (> (current-column) normal-column)
3477 ;; We have made some progress towards the desired column.
3478 ;; See if we can make any further progress.
3479 (line-move-to-column (+ (current-column) (- col normal-column)))
3480 ;; Otherwise, go to the place we originally found
3481 ;; and move back over invisible text.
3482 ;; that will get us to the same place on the screen
3483 ;; but with a more reasonable buffer position.
3484 (goto-char normal-location)
3485 (let ((line-beg (save-excursion (beginning-of-line) (point))))
3486 (while (and (not (bolp)) (line-move-invisible-p (1- (point))))
3487 (goto-char (previous-char-property-change (point) line-beg))))))))
3489 (defun move-end-of-line (arg)
3490 "Move point to end of current line.
3491 With argument ARG not nil or 1, move forward ARG - 1 lines first.
3492 If point reaches the beginning or end of buffer, it stops there.
3493 To ignore intangibility, bind `inhibit-point-motion-hooks' to t.
3495 This command does not move point across a field boundary unless doing so
3496 would move beyond there to a different line; if ARG is nil or 1, and
3497 point starts at a field boundary, point does not move. To ignore field
3498 boundaries bind `inhibit-field-text-motion' to t."
3499 (interactive "p")
3500 (or arg (setq arg 1))
3501 (let (done)
3502 (while (not done)
3503 (let ((newpos
3504 (save-excursion
3505 (let ((goal-column 0))
3506 (and (line-move arg t)
3507 (not (bobp))
3508 (progn
3509 (while (and (not (bobp)) (line-move-invisible-p (1- (point))))
3510 (goto-char (previous-char-property-change (point))))
3511 (backward-char 1)))
3512 (point)))))
3513 (goto-char newpos)
3514 (if (and (> (point) newpos)
3516 (backward-char 1)
3517 (if (and (> (point) newpos) (not (eobp))
3519 ;; If we skipped something intangible
3520 ;; and now we're not really at eol,
3521 ;; keep going.
3522 (setq arg 1)
3523 (setq done t)))))))
3525 (defun move-beginning-of-line (arg)
3526 "Move point to beginning of current display line.
3527 With argument ARG not nil or 1, move forward ARG - 1 lines first.
3528 If point reaches the beginning or end of buffer, it stops there.
3529 To ignore intangibility, bind `inhibit-point-motion-hooks' to t.
3531 This command does not move point across a field boundary unless doing so
3532 would move beyond there to a different line; if ARG is nil or 1, and
3533 point starts at a field boundary, point does not move. To ignore field
3534 boundaries bind `inhibit-field-text-motion' to t."
3535 (interactive "p")
3536 (or arg (setq arg 1))
3537 (if (/= arg 1)
3538 (line-move (1- arg) t))
3539 (let (done pos)
3540 (while (not done)
3541 (beginning-of-line 1)
3542 ;; (not bolp) means that it stopped at a field boundary.
3543 (if (or (bobp) (not (bolp)))
3544 (setq done t)
3545 (sit-for 0)
3546 (if (and (consp (setq pos (pos-visible-in-window-p (point) nil t)))
3547 (= (car pos) 0))
3548 (setq done t)
3549 (backward-char 1))))))
3552 ;;; Many people have said they rarely use this feature, and often type
3553 ;;; it by accident. Maybe it shouldn't even be on a key.
3554 (put 'set-goal-column 'disabled t)
3556 (defun set-goal-column (arg)
3558 Those commands will move to this position in the line moved to
3559 rather than trying to keep the same horizontal position.
3560 With a non-nil argument, clears out the goal column
3562 The goal column is stored in the variable `goal-column'."
3563 (interactive "P")
3564 (if arg
3565 (progn
3566 (setq goal-column nil)
3567 (message "No goal column"))
3568 (setq goal-column (current-column))
3569 (message (substitute-command-keys
3571 goal-column))
3572 nil)
3573 \f
3575 (defun scroll-other-window-down (lines)
3577 For more details, see the documentation for `scroll-other-window'."
3578 (interactive "P")
3579 (scroll-other-window
3580 ;; Just invert the argument's meaning.
3581 ;; We can do that without knowing which window it will be.
3582 (if (eq lines '-) nil
3583 (if (null lines) '-
3584 (- (prefix-numeric-value lines))))))
3585 (define-key esc-map [?\C-\S-v] 'scroll-other-window-down)
3587 (defun beginning-of-buffer-other-window (arg)
3588 "Move point to the beginning of the buffer in the other window.
3589 Leave mark at previous position.
3590 With arg N, put point N/10 of the way from the true beginning."
3591 (interactive "P")
3592 (let ((orig-window (selected-window))
3593 (window (other-window-for-scrolling)))
3594 ;; We use unwind-protect rather than save-window-excursion
3595 ;; because the latter would preserve the things we want to change.
3596 (unwind-protect
3597 (progn
3598 (select-window window)
3599 ;; Set point and mark in that window's buffer.
3600 (with-no-warnings
3601 (beginning-of-buffer arg))
3602 ;; Set point accordingly.
3603 (recenter '(t)))
3604 (select-window orig-window))))
3606 (defun end-of-buffer-other-window (arg)
3607 "Move point to the end of the buffer in the other window.
3608 Leave mark at previous position.
3609 With arg N, put point N/10 of the way from the true end."
3610 (interactive "P")
3611 ;; See beginning-of-buffer-other-window for comments.
3612 (let ((orig-window (selected-window))
3613 (window (other-window-for-scrolling)))
3614 (unwind-protect
3615 (progn
3616 (select-window window)
3617 (with-no-warnings
3618 (end-of-buffer arg))
3619 (recenter '(t)))
3620 (select-window orig-window))))
3621 \f
3622 (defun transpose-chars (arg)
3623 "Interchange characters around point, moving forward one character.
3624 With prefix arg ARG, effect is to take character before point
3625 and drag it forward past ARG other characters (backward if ARG negative).
3626 If no argument and at end of line, the previous two chars are exchanged."
3627 (interactive "*P")
3628 (and (null arg) (eolp) (forward-char -1))
3629 (transpose-subr 'forward-char (prefix-numeric-value arg)))
3631 (defun transpose-words (arg)
3632 "Interchange words around point, leaving point at end of them.
3633 With prefix arg ARG, effect is to take word before or around point
3634 and drag it forward past ARG other words (backward if ARG negative).
3635 If ARG is zero, the words around or after point and around or after mark
3636 are interchanged."
3637 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
3638 (interactive "*p")
3639 (transpose-subr 'forward-word arg))
3641 (defun transpose-sexps (arg)
3643 Does not work on a sexp that point is in the middle of
3644 if it is a list or string."
3645 (interactive "*p")
3646 (transpose-subr
3647 (lambda (arg)
3648 ;; Here we should try to simulate the behavior of
3649 ;; (cons (progn (forward-sexp x) (point))
3650 ;; (progn (forward-sexp (- x)) (point)))
3651 ;; Except that we don't want to rely on the second forward-sexp
3652 ;; putting us back to where we want to be, since forward-sexp-function
3653 ;; might do funny things like infix-precedence.
3654 (if (if (> arg 0)
3656 (and (not (bobp))
3658 ;; Jumping over a symbol. We might be inside it, mind you.
3659 (progn (funcall (if (> arg 0)
3660 'skip-syntax-backward 'skip-syntax-forward)
3661 "w_")
3662 (cons (save-excursion (forward-sexp arg) (point)) (point)))
3663 ;; Otherwise, we're between sexps. Take a step back before jumping
3664 ;; to make sure we'll obey the same precedence no matter which direction
3665 ;; we're going.
3666 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
3667 (cons (save-excursion (forward-sexp arg) (point))
3668 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
3669 (not (zerop (funcall (if (> arg 0)
3670 'skip-syntax-forward
3671 'skip-syntax-backward)
3672 ".")))))
3673 (point)))))
3674 arg 'special))
3676 (defun transpose-lines (arg)
3677 "Exchange current line and previous line, leaving point after both.
3678 With argument ARG, takes previous line and moves it past ARG lines.
3679 With argument 0, interchanges line point is in with line mark is in."
3680 (interactive "*p")
3681 (transpose-subr (function
3682 (lambda (arg)
3683 (if (> arg 0)
3684 (progn
3685 ;; Move forward over ARG lines,
3686 ;; but create newlines if necessary.
3687 (setq arg (forward-line arg))
3689 (setq arg (1+ arg)))
3690 (if (> arg 0)
3691 (newline arg)))
3692 (forward-line arg))))
3693 arg))
3695 (defun transpose-subr (mover arg &optional special)
3696 (let ((aux (if special mover
3697 (lambda (x)
3698 (cons (progn (funcall mover x) (point))
3699 (progn (funcall mover (- x)) (point))))))
3700 pos1 pos2)
3701 (cond
3702 ((= arg 0)
3703 (save-excursion
3704 (setq pos1 (funcall aux 1))
3705 (goto-char (mark))
3706 (setq pos2 (funcall aux 1))
3707 (transpose-subr-1 pos1 pos2))
3708 (exchange-point-and-mark))
3709 ((> arg 0)
3710 (setq pos1 (funcall aux -1))
3711 (setq pos2 (funcall aux arg))
3712 (transpose-subr-1 pos1 pos2)
3713 (goto-char (car pos2)))
3714 (t
3715 (setq pos1 (funcall aux -1))
3716 (goto-char (car pos1))
3717 (setq pos2 (funcall aux arg))
3718 (transpose-subr-1 pos1 pos2)))))
3720 (defun transpose-subr-1 (pos1 pos2)
3721 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
3722 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
3723 (when (> (car pos1) (car pos2))
3724 (let ((swap pos1))
3725 (setq pos1 pos2 pos2 swap)))
3726 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
3727 (atomic-change-group
3728 (let (word2)
3729 ;; FIXME: We first delete the two pieces of text, so markers that
3730 ;; used to point to after the text end up pointing to before it :-(
3731 (setq word2 (delete-and-extract-region (car pos2) (cdr pos2)))
3732 (goto-char (car pos2))
3733 (insert (delete-and-extract-region (car pos1) (cdr pos1)))
3734 (goto-char (car pos1))
3735 (insert word2))))
3736 \f
3737 (defun backward-word (&optional arg)
3738 "Move backward until encountering the beginning of a word.
3739 With argument, do this that many times."
3740 (interactive "p")
3741 (forward-word (- (or arg 1))))
3743 (defun mark-word (&optional arg allow-extend)
3744 "Set mark ARG words away from point.
3746 move to with the same argument.
3747 Interactively, if this command is repeated
3748 or (in Transient Mark mode) if the mark is active,
3749 it marks the next ARG words after the ones already marked."
3751 (cond ((and allow-extend
3752 (or (and (eq last-command this-command) (mark t))
3753 (and transient-mark-mode mark-active)))
3754 (setq arg (if arg (prefix-numeric-value arg)
3755 (if (< (mark) (point)) -1 1)))
3756 (set-mark
3757 (save-excursion
3758 (goto-char (mark))
3759 (forward-word arg)
3760 (point))))
3761 (t
3762 (push-mark
3763 (save-excursion
3764 (forward-word (prefix-numeric-value arg))
3765 (point))
3766 nil t))))
3768 (defun kill-word (arg)
3769 "Kill characters forward until encountering the end of a word.
3770 With argument, do this that many times."
3771 (interactive "p")
3772 (kill-region (point) (progn (forward-word arg) (point))))
3774 (defun backward-kill-word (arg)
3775 "Kill characters backward until encountering the end of a word.
3776 With argument, do this that many times."
3777 (interactive "p")
3778 (kill-word (- arg)))
3780 (defun current-word (&optional strict really-word)
3781 "Return the symbol or word that point is on (or a nearby one) as a string.
3782 The return value includes no text properties.
3783 If optional arg STRICT is non-nil, return nil unless point is within
3784 or adjacent to a symbol or word. In all cases the value can be nil
3785 if there is no word nearby.
3786 The function, belying its name, normally finds a symbol.
3787 If optional arg REALLY-WORD is non-nil, it finds just a word."
3788 (save-excursion
3789 (let* ((oldpoint (point)) (start (point)) (end (point))
3790 (syntaxes (if really-word "w" "w_"))
3791 (not-syntaxes (concat "^" syntaxes)))
3792 (skip-syntax-backward syntaxes) (setq start (point))
3793 (goto-char oldpoint)
3794 (skip-syntax-forward syntaxes) (setq end (point))
3795 (when (and (eq start oldpoint) (eq end oldpoint)
3796 ;; Point is neither within nor adjacent to a word.
3797 (not strict))
3798 ;; Look for preceding word in same line.
3799 (skip-syntax-backward not-syntaxes
3800 (save-excursion (beginning-of-line)
3801 (point)))
3802 (if (bolp)
3803 ;; No preceding word in same line.
3804 ;; Look for following word in same line.
3805 (progn
3806 (skip-syntax-forward not-syntaxes
3807 (save-excursion (end-of-line)
3808 (point)))
3809 (setq start (point))
3810 (skip-syntax-forward syntaxes)
3811 (setq end (point)))
3812 (setq end (point))
3813 (skip-syntax-backward syntaxes)
3814 (setq start (point))))
3815 ;; If we found something nonempty, return it as a string.
3816 (unless (= start end)
3817 (buffer-substring-no-properties start end)))))
3818 \f
3819 (defcustom fill-prefix nil
3820 "*String for filling to insert at front of new line, or nil for none."
3821 :type '(choice (const :tag "None" nil)
3822 string)
3823 :group 'fill)
3824 (make-variable-buffer-local 'fill-prefix)
3826 (defcustom auto-fill-inhibit-regexp nil
3827 "*Regexp to match lines which should not be auto-filled."
3828 :type '(choice (const :tag "None" nil)
3829 regexp)
3830 :group 'fill)
3832 (defvar comment-line-break-function 'comment-indent-new-line
3833 "*Mode-specific function which line breaks and continues a comment.
3835 This function is only called during auto-filling of a comment section.
3836 The function should take a single optional argument, which is a flag
3837 indicating whether it should use soft newlines.
3839 Setting this variable automatically makes it local to the current buffer.")
3841 ;; This function is used as the auto-fill-function of a buffer
3842 ;; when Auto-Fill mode is enabled.
3843 ;; It returns t if it really did any work.
3844 ;; (Actually some major modes use a different auto-fill function,
3845 ;; but this one is the default one.)
3846 (defun do-auto-fill ()
3847 (let (fc justify give-up
3848 (fill-prefix fill-prefix))
3849 (if (or (not (setq justify (current-justification)))
3850 (null (setq fc (current-fill-column)))
3851 (and (eq justify 'left)
3852 (<= (current-column) fc))
3853 (and auto-fill-inhibit-regexp
3854 (save-excursion (beginning-of-line)
3855 (looking-at auto-fill-inhibit-regexp))))
3856 nil ;; Auto-filling not required
3857 (if (memq justify '(full center right))
3858 (save-excursion (unjustify-current-line)))
3860 ;; Choose a fill-prefix automatically.
3861 (when (and adaptive-fill-mode
3862 (or (null fill-prefix) (string= fill-prefix "")))
3863 (let ((prefix
3864 (fill-context-prefix
3865 (save-excursion (backward-paragraph 1) (point))
3866 (save-excursion (forward-paragraph 1) (point)))))
3867 (and prefix (not (equal prefix ""))
3868 ;; Use auto-indentation rather than a guessed empty prefix.
3869 (not (and fill-indent-according-to-mode
3871 (setq fill-prefix prefix))))
3873 (while (and (not give-up) (> (current-column) fc))
3874 ;; Determine where to split the line.
3875 (let* (after-prefix
3876 (fill-point
3877 (save-excursion
3878 (beginning-of-line)
3879 (setq after-prefix (point))
3880 (and fill-prefix
3881 (looking-at (regexp-quote fill-prefix))
3882 (setq after-prefix (match-end 0)))
3883 (move-to-column (1+ fc))
3884 (fill-move-to-break-point after-prefix)
3885 (point))))
3887 ;; See whether the place we found is any good.
3888 (if (save-excursion
3889 (goto-char fill-point)
3890 (or (bolp)
3891 ;; There is no use breaking at end of line.
3892 (save-excursion (skip-chars-forward " ") (eolp))
3893 ;; It is futile to split at the end of the prefix
3894 ;; since we would just insert the prefix again.
3895 (and after-prefix (<= (point) after-prefix))
3896 ;; Don't split right after a comment starter
3897 ;; since we would just make another comment starter.
3898 (and comment-start-skip
3899 (let ((limit (point)))
3900 (beginning-of-line)
3901 (and (re-search-forward comment-start-skip
3902 limit t)
3903 (eq (point) limit))))))
3904 ;; No good place to break => stop trying.
3905 (setq give-up t)
3906 ;; Ok, we have a useful place to break the line. Do it.
3907 (let ((prev-column (current-column)))
3908 ;; If point is at the fill-point, do not `save-excursion'.
3909 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
3910 ;; point will end up before it rather than after it.
3911 (if (save-excursion
3913 (= (point) fill-point))
3914 (funcall comment-line-break-function t)
3915 (save-excursion
3916 (goto-char fill-point)
3917 (funcall comment-line-break-function t)))
3918 ;; Now do justification, if required
3919 (if (not (eq justify 'left))
3920 (save-excursion
3921 (end-of-line 0)
3922 (justify-current-line justify nil t)))
3923 ;; If making the new line didn't reduce the hpos of
3924 ;; the end of the line, then give up now;
3925 ;; trying again will not help.
3926 (if (>= (current-column) prev-column)
3927 (setq give-up t))))))
3928 ;; Justify last line.
3929 (justify-current-line justify t t)
3930 t)))
3932 (defvar normal-auto-fill-function 'do-auto-fill
3933 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
3934 Some major modes set this.")
3936 ;; FIXME: turn into a proper minor mode.
3937 ;; Add a global minor mode version of it.
3938 (defun auto-fill-mode (&optional arg)
3939 "Toggle Auto Fill mode.
3940 With arg, turn Auto Fill mode on if and only if arg is positive.
3941 In Auto Fill mode, inserting a space at a column beyond `current-fill-column'
3942 automatically breaks the line at a previous space.
3944 The value of `normal-auto-fill-function' specifies the function to use
3945 for `auto-fill-function' when turning Auto Fill mode on."
3946 (interactive "P")
3947 (prog1 (setq auto-fill-function
3948 (if (if (null arg)
3949 (not auto-fill-function)
3950 (> (prefix-numeric-value arg) 0))
3951 normal-auto-fill-function
3952 nil))
3953 (force-mode-line-update)))
3955 ;; This holds a document string used to document auto-fill-mode.
3956 (defun auto-fill-function ()
3957 "Automatically break line at a previous space, in insertion of text."
3958 nil)
3960 (defun turn-on-auto-fill ()
3961 "Unconditionally turn on Auto Fill mode."
3962 (auto-fill-mode 1))
3964 (defun turn-off-auto-fill ()
3965 "Unconditionally turn off Auto Fill mode."
3966 (auto-fill-mode -1))
3968 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
3970 (defun set-fill-column (arg)
3971 "Set `fill-column' to specified argument.
3974 (interactive "P")
3975 (if (consp arg)
3976 (setq arg (current-column)))
3977 (if (not (integerp arg))
3978 ;; Disallow missing argument; it's probably a typo for C-x C-f.
3979 (error "Set-fill-column requires an explicit argument")
3980 (message "Fill column set to %d (was %d)" arg fill-column)
3981 (setq fill-column arg)))
3982 \f
3983 (defun set-selective-display (arg)
3984 "Set `selective-display' to ARG; clear it if no arg.
3985 When the value of `selective-display' is a number > 0,
3986 lines whose indentation is >= that value are not displayed.
3987 The variable `selective-display' has a separate value for each buffer."
3988 (interactive "P")
3989 (if (eq selective-display t)
3990 (error "selective-display already in use for marked lines"))
3991 (let ((current-vpos
3992 (save-restriction
3993 (narrow-to-region (point-min) (point))
3994 (goto-char (window-start))
3995 (vertical-motion (window-height)))))
3996 (setq selective-display
3997 (and arg (prefix-numeric-value arg)))
3998 (recenter current-vpos))
3999 (set-window-start (selected-window) (window-start (selected-window)))
4000 (princ "selective-display set to " t)
4001 (prin1 selective-display t)
4002 (princ "." t))
4004 (defvaralias 'indicate-unused-lines 'indicate-empty-lines)
4005 (defvaralias 'default-indicate-unused-lines 'default-indicate-empty-lines)
4007 (defun toggle-truncate-lines (arg)
4008 "Toggle whether to fold or truncate long lines on the screen.
4009 With arg, truncate long lines iff arg is positive.
4010 Note that in side-by-side windows, truncation is always enabled."
4011 (interactive "P")
4012 (setq truncate-lines
4013 (if (null arg)
4014 (not truncate-lines)
4015 (> (prefix-numeric-value arg) 0)))
4016 (force-mode-line-update)
4017 (unless truncate-lines
4018 (let ((buffer (current-buffer)))
4019 (walk-windows (lambda (window)
4020 (if (eq buffer (window-buffer window))
4021 (set-window-hscroll window 0)))
4022 nil t)))
4023 (message "Truncate long lines %s"
4024 (if truncate-lines "enabled" "disabled")))
4026 (defvar overwrite-mode-textual " Ovwrt"
4027 "The string displayed in the mode line when in overwrite mode.")
4028 (defvar overwrite-mode-binary " Bin Ovwrt"
4029 "The string displayed in the mode line when in binary overwrite mode.")
4031 (defun overwrite-mode (arg)
4032 "Toggle overwrite mode.
4033 With arg, turn overwrite mode on iff arg is positive.
4034 In overwrite mode, printing characters typed in replace existing text
4035 on a one-for-one basis, rather than pushing it to the right. At the
4036 end of a line, such characters extend the line. Before a tab,
4037 such characters insert until the tab is filled in.
4039 is supposed to make it easier to insert characters when necessary."
4040 (interactive "P")
4041 (setq overwrite-mode
4042 (if (if (null arg) (not overwrite-mode)
4043 (> (prefix-numeric-value arg) 0))
4044 'overwrite-mode-textual))
4045 (force-mode-line-update))
4047 (defun binary-overwrite-mode (arg)
4048 "Toggle binary overwrite mode.
4049 With arg, turn binary overwrite mode on iff arg is positive.
4050 In binary overwrite mode, printing characters typed in replace
4051 existing text. Newlines are not treated specially, so typing at the
4052 end of a line joins the line to the next, with the typed character
4053 between them. Typing before a tab character simply replaces the tab
4054 with the character typed.
4056 typing characters do.
4058 Note that binary overwrite mode is not its own minor mode; it is a
4059 specialization of overwrite-mode, entered by setting the
4060 `overwrite-mode' variable to `overwrite-mode-binary'."
4061 (interactive "P")
4062 (setq overwrite-mode
4063 (if (if (null arg)
4064 (not (eq overwrite-mode 'overwrite-mode-binary))
4065 (> (prefix-numeric-value arg) 0))
4066 'overwrite-mode-binary))
4067 (force-mode-line-update))
4069 (define-minor-mode line-number-mode
4070 "Toggle Line Number mode.
4071 With arg, turn Line Number mode on iff arg is positive.
4072 When Line Number mode is enabled, the line number appears
4073 in the mode line.
4075 Line numbers do not appear for very large buffers and buffers
4076 with very long lines; see variables `line-number-display-limit'
4077 and `line-number-display-limit-width'."
4078 :init-value t :global t :group 'editing-basics :require nil)
4080 (define-minor-mode column-number-mode
4081 "Toggle Column Number mode.
4082 With arg, turn Column Number mode on iff arg is positive.
4083 When Column Number mode is enabled, the column number appears
4084 in the mode line."
4085 :global t :group 'editing-basics :require nil)
4087 (define-minor-mode size-indication-mode
4088 "Toggle Size Indication mode.
4089 With arg, turn Size Indication mode on iff arg is positive. When
4090 Size Indication mode is enabled, the size of the accessible part
4091 of the buffer appears in the mode line."
4092 :global t :group 'editing-basics :require nil)
4093 \f
4094 (defgroup paren-blinking nil
4095 "Blinking matching of parens and expressions."
4096 :prefix "blink-matching-"
4097 :group 'paren-matching)
4099 (defcustom blink-matching-paren t
4100 "*Non-nil means show matching open-paren when close-paren is inserted."
4101 :type 'boolean
4102 :group 'paren-blinking)
4104 (defcustom blink-matching-paren-on-screen t
4105 "*Non-nil means show matching open-paren when it is on screen.
4106 If nil, means don't show it (but the open-paren can still be shown
4107 when it is off screen)."
4108 :type 'boolean
4109 :group 'paren-blinking)
4111 (defcustom blink-matching-paren-distance (* 25 1024)
4112 "*If non-nil, is maximum distance to search for matching open-paren."
4113 :type 'integer
4114 :group 'paren-blinking)
4116 (defcustom blink-matching-delay 1
4117 "*Time in seconds to delay after showing a matching paren."
4118 :type 'number
4119 :group 'paren-blinking)
4121 (defcustom blink-matching-paren-dont-ignore-comments nil
4122 "*Non-nil means `blink-matching-paren' will not ignore comments."
4123 :type 'boolean
4124 :group 'paren-blinking)
4126 (defun blink-matching-open ()
4127 "Move cursor momentarily to the beginning of the sexp before point."
4128 (interactive)
4129 (and (> (point) (1+ (point-min)))
4130 blink-matching-paren
4131 ;; Verify an even number of quoting characters precede the close.
4132 (= 1 (logand 1 (- (point)
4133 (save-excursion
4134 (forward-char -1)
4136 (point)))))
4137 (let* ((oldpos (point))
4138 (blinkpos)
4139 (mismatch)
4140 matching-paren)
4141 (save-excursion
4142 (save-restriction
4143 (if blink-matching-paren-distance
4144 (narrow-to-region (max (point-min)
4145 (- (point) blink-matching-paren-distance))
4146 oldpos))
4147 (condition-case ()
4148 (let ((parse-sexp-ignore-comments
4149 (and parse-sexp-ignore-comments
4150 (not blink-matching-paren-dont-ignore-comments))))
4151 (setq blinkpos (scan-sexps oldpos -1)))
4152 (error nil)))
4153 (and blinkpos
4154 (not (eq (car (syntax-after blinkpos)) 8)) ;Not syntax '$'.
4155 (setq matching-paren
4156 (let ((syntax (syntax-after blinkpos)))
4157 (and (consp syntax)
4158 (eq (logand (car syntax) 255) 4)
4159 (cdr syntax)))
4160 mismatch
4161 (or (null matching-paren)
4162 (/= (char-after (1- oldpos))
4163 matching-paren))))
4164 (if mismatch (setq blinkpos nil))
4165 (if blinkpos
4166 ;; Don't log messages about paren matching.
4167 (let (message-log-max)
4168 (goto-char blinkpos)
4169 (if (pos-visible-in-window-p)
4170 (and blink-matching-paren-on-screen
4171 (sit-for blink-matching-delay))
4172 (goto-char blinkpos)
4173 (message
4174 "Matches %s"
4175 ;; Show what precedes the open in its line, if anything.
4176 (if (save-excursion
4178 (not (bolp)))
4179 (buffer-substring (progn (beginning-of-line) (point))
4180 (1+ blinkpos))
4181 ;; Show what follows the open in its line, if anything.
4182 (if (save-excursion
4183 (forward-char 1)
4185 (not (eolp)))
4186 (buffer-substring blinkpos
4187 (progn (end-of-line) (point)))
4188 ;; Otherwise show the previous nonblank line,
4189 ;; if there is one.
4190 (if (save-excursion
4192 (not (bobp)))
4193 (concat
4194 (buffer-substring (progn
4196 (beginning-of-line)
4197 (point))
4198 (progn (end-of-line)
4200 (point)))
4201 ;; Replace the newline and other whitespace with `...'.
4202 "..."
4203 (buffer-substring blinkpos (1+ blinkpos)))
4204 ;; There is nothing to show except the char itself.
4205 (buffer-substring blinkpos (1+ blinkpos))))))))
4206 (cond (mismatch
4207 (message "Mismatched parentheses"))
4208 ((not blink-matching-paren-distance)
4209 (message "Unmatched parenthesis"))))))))
4211 ;Turned off because it makes dbx bomb out.
4212 (setq blink-paren-function 'blink-matching-open)
4213 \f
4214 ;; This executes C-g typed while Emacs is waiting for a command.
4215 ;; Quitting out of a program does not go through here;
4216 ;; that happens in the QUIT macro at the C code level.
4217 (defun keyboard-quit ()
4218 "Signal a `quit' condition.
4219 During execution of Lisp code, this character causes a quit directly.
4220 At top-level, as an editor command, this simply beeps."
4221 (interactive)
4222 (deactivate-mark)
4223 (if (fboundp 'kmacro-keyboard-quit)
4224 (kmacro-keyboard-quit))
4225 (setq defining-kbd-macro nil)
4226 (signal 'quit nil))
4228 (define-key global-map "\C-g" 'keyboard-quit)
4230 (defvar buffer-quit-function nil
4233 \(such as cancelling a prefix argument, minibuffer or region) do not apply.")
4235 (defun keyboard-escape-quit ()
4237 This command can exit an interactive command such as `query-replace',
4238 can clear out a prefix argument or a region,
4239 can get out of the minibuffer or other recursive edit,
4240 cancel the use of the current buffer (for special-purpose buffers),
4241 or go back to just one window (by deleting all but the selected window)."
4242 (interactive)
4243 (cond ((eq last-command 'mode-exited) nil)
4244 ((> (minibuffer-depth) 0)
4245 (abort-recursive-edit))
4246 (current-prefix-arg
4247 nil)
4248 ((and transient-mark-mode mark-active)
4249 (deactivate-mark))
4250 ((> (recursion-depth) 0)
4251 (exit-recursive-edit))
4252 (buffer-quit-function
4253 (funcall buffer-quit-function))
4254 ((not (one-window-p t))
4255 (delete-other-windows))
4257 (bury-buffer))))
4259 (defun play-sound-file (file &optional volume device)
4260 "Play sound stored in FILE.
4261 VOLUME and DEVICE correspond to the keywords of the sound
4262 specification for `play-sound'."
4263 (interactive "fPlay sound file: ")
4264 (let ((sound (list :file file)))
4265 (if volume
4266 (plist-put sound :volume volume))
4267 (if device
4268 (plist-put sound :device device))
4269 (push 'sound sound)
4270 (play-sound sound)))
4272 (define-key global-map "\e\e\e" 'keyboard-escape-quit)
4273 \f
4274 (defcustom read-mail-command 'rmail
4275 "*Your preference for a mail reading package.
4276 This is used by some keybindings which support reading mail.
4277 See also `mail-user-agent' concerning sending mail."
4278 :type '(choice (function-item rmail)
4279 (function-item gnus)
4280 (function-item mh-rmail)
4281 (function :tag "Other"))
4282 :version "21.1"
4283 :group 'mail)
4285 (defcustom mail-user-agent 'sendmail-user-agent
4286 "*Your preference for a mail composition package.
4287 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
4288 outgoing email message. This variable lets you specify which
4289 mail-sending package you prefer.
4291 Valid values include:
4293 `sendmail-user-agent' -- use the default Emacs Mail package.
4294 See Info node `(emacs)Sending Mail'.
4295 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
4296 See Info node `(mh-e)'.
4297 `message-user-agent' -- use the Gnus Message package.
4298 See Info node `(message)'.
4299 `gnus-user-agent' -- like `message-user-agent', but with Gnus
4300 paraphernalia, particularly the Gcc: header for
4301 archiving.
4303 Additional valid symbols may be available; check with the author of
4304 your package for details. The function should return non-nil if it
4305 succeeds.
4307 See also `read-mail-command' concerning reading mail."
4308 :type '(radio (function-item :tag "Default Emacs mail"
4310 sendmail-user-agent)
4311 (function-item :tag "Emacs interface to MH"
4313 mh-e-user-agent)
4314 (function-item :tag "Gnus Message package"
4316 message-user-agent)
4317 (function-item :tag "Gnus Message with full Gnus features"
4319 gnus-user-agent)
4320 (function :tag "Other"))
4321 :group 'mail)
4323 (define-mail-user-agent 'sendmail-user-agent
4324 'sendmail-user-agent-compose
4325 'mail-send-and-exit)
4327 (defun rfc822-goto-eoh ()
4328 ;; Go to header delimiter line in a mail message, following RFC822 rules
4329 (goto-char (point-min))
4330 (when (re-search-forward
4332 (goto-char (match-beginning 0))))
4334 (defun sendmail-user-agent-compose (&optional to subject other-headers continue
4335 switch-function yank-action
4336 send-actions)
4337 (if switch-function
4338 (let ((special-display-buffer-names nil)
4339 (special-display-regexps nil)
4340 (same-window-buffer-names nil)
4341 (same-window-regexps nil))
4342 (funcall switch-function "*mail*")))
4343 (let ((cc (cdr (assoc-string "cc" other-headers t)))
4344 (in-reply-to (cdr (assoc-string "in-reply-to" other-headers t)))
4345 (body (cdr (assoc-string "body" other-headers t))))
4346 (or (mail continue to subject in-reply-to cc yank-action send-actions)
4347 continue
4348 (error "Message aborted"))
4349 (save-excursion
4350 (rfc822-goto-eoh)
4351 (while other-headers
4352 (unless (member-ignore-case (car (car other-headers))
4353 '("in-reply-to" "cc" "body"))
4354 (insert (car (car other-headers)) ": "
4356 (setq other-headers (cdr other-headers)))
4357 (when body
4358 (forward-line 1)
4359 (insert body))
4360 t)))
4362 (define-mail-user-agent 'mh-e-user-agent
4363 'mh-smail-batch 'mh-send-letter 'mh-fully-kill-draft
4364 'mh-before-send-letter-hook)
4366 (defun compose-mail (&optional to subject other-headers continue
4367 switch-function yank-action send-actions)
4368 "Start composing a mail message to send.
4369 This uses the user's chosen mail composition package
4370 as selected with the variable `mail-user-agent'.
4371 The optional arguments TO and SUBJECT specify recipients
4372 and the initial Subject field, respectively.
4374 OTHER-HEADERS is an alist specifying additional
4375 header fields. Elements look like (HEADER . VALUE) where both
4376 HEADER and VALUE are strings.
4378 CONTINUE, if non-nil, says to continue editing a message already
4379 being composed.
4381 SWITCH-FUNCTION, if non-nil, is a function to use to
4382 switch to and display the buffer used for mail composition.
4384 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
4385 to insert the raw text of the message being replied to.
4386 It has the form (FUNCTION . ARGS). The user agent will apply
4387 FUNCTION to ARGS, to insert the raw text of the original message.
4388 \(The user agent will also run `mail-citation-hook', *after* the
4389 original text has been inserted in this way.)
4391 SEND-ACTIONS is a list of actions to call when the message is sent.
4392 Each action has the form (FUNCTION . ARGS)."
4393 (interactive
4394 (list nil nil nil current-prefix-arg))
4395 (let ((function (get mail-user-agent 'composefunc)))
4396 (funcall function to subject other-headers continue
4397 switch-function yank-action send-actions)))
4399 (defun compose-mail-other-window (&optional to subject other-headers continue
4400 yank-action send-actions)
4402 (interactive
4403 (list nil nil nil current-prefix-arg))
4404 (compose-mail to subject other-headers continue
4405 'switch-to-buffer-other-window yank-action send-actions))
4408 (defun compose-mail-other-frame (&optional to subject other-headers continue
4409 yank-action send-actions)
4411 (interactive
4412 (list nil nil nil current-prefix-arg))
4413 (compose-mail to subject other-headers continue
4414 'switch-to-buffer-other-frame yank-action send-actions))
4415 \f
4416 (defvar set-variable-value-history nil
4417 "History of values entered with `set-variable'.")
4419 (defun set-variable (var val &optional make-local)
4420 "Set VARIABLE to VALUE. VALUE is a Lisp object.
4421 When using this interactively, enter a Lisp object for VALUE.
4422 If you want VALUE to be a string, you must surround it with doublequotes.
4423 VALUE is used literally, not evaluated.
4425 If VARIABLE has a `variable-interactive' property, that is used as if
4426 it were the arg to `interactive' (which see) to interactively read VALUE.
4428 If VARIABLE has been defined with `defcustom', then the type information
4429 in the definition is used to check that VALUE is valid.
4431 With a prefix argument, set VARIABLE to VALUE buffer-locally."
4432 (interactive
4433 (let* ((default-var (variable-at-point))
4434 (var (if (symbolp default-var)
4435 (read-variable (format "Set variable (default %s): " default-var)
4436 default-var)
4437 (read-variable "Set variable: ")))
4438 (minibuffer-help-form '(describe-variable var))
4439 (prop (get var 'variable-interactive))
4440 (prompt (format "Set %s%s to value: " var
4441 (cond ((local-variable-p var)
4442 " (buffer-local)")
4443 ((or current-prefix-arg
4444 (local-variable-if-set-p var))
4445 " buffer-locally")
4446 (t " globally"))))
4447 (val (if prop
4448 ;; Use VAR's `variable-interactive' property
4449 ;; as an interactive spec for prompting.
4450 (call-interactively `(lambda (arg)
4451 (interactive ,prop)
4452 arg))
4453 (read
4454 (read-string prompt nil
4455 'set-variable-value-history)))))
4456 (list var val current-prefix-arg)))
4458 (and (custom-variable-p var)
4459 (not (get var 'custom-type))
4460 (custom-load-symbol var))
4461 (let ((type (get var 'custom-type)))
4462 (when type
4463 ;; Match with custom type.
4464 (require 'cus-edit)
4465 (setq type (widget-convert type))
4466 (unless (widget-apply type :match val)
4467 (error "Value `%S' does not match type %S of %S"
4468 val (car type) var))))
4470 (if make-local
4471 (make-local-variable var))
4473 (set var val)
4475 ;; Force a thorough redisplay for the case that the variable
4476 ;; has an effect on the display, like `tab-width' has.
4477 (force-mode-line-update))
4478 \f
4479 ;; Define the major mode for lists of completions.
4481 (defvar completion-list-mode-map nil
4482 "Local map for completion list buffers.")
4483 (or completion-list-mode-map
4484 (let ((map (make-sparse-keymap)))
4485 (define-key map [mouse-2] 'mouse-choose-completion)
4486 (define-key map [follow-link] 'mouse-face)
4487 (define-key map [down-mouse-2] nil)
4488 (define-key map "\C-m" 'choose-completion)
4489 (define-key map "\e\e\e" 'delete-completion-window)
4490 (define-key map [left] 'previous-completion)
4491 (define-key map [right] 'next-completion)
4492 (setq completion-list-mode-map map)))
4494 ;; Completion mode is suitable only for specially formatted data.
4495 (put 'completion-list-mode 'mode-class 'special)
4497 (defvar completion-reference-buffer nil
4498 "Record the buffer that was current when the completion list was requested.
4499 This is a local variable in the completion list buffer.
4500 Initial value is nil to avoid some compiler warnings.")
4502 (defvar completion-no-auto-exit nil
4503 "Non-nil means `choose-completion-string' should never exit the minibuffer.
4504 This also applies to other functions such as `choose-completion'
4505 and `mouse-choose-completion'.")
4507 (defvar completion-base-size nil
4508 "Number of chars at beginning of minibuffer not involved in completion.
4509 This is a local variable in the completion list buffer
4510 but it talks about the buffer in `completion-reference-buffer'.
4511 If this is nil, it means to compare text to determine which part
4512 of the tail end of the buffer's text is involved in completion.")
4514 (defun delete-completion-window ()
4515 "Delete the completion list window.
4516 Go to the window from which completion was requested."
4517 (interactive)
4518 (let ((buf completion-reference-buffer))
4519 (if (one-window-p t)
4520 (if (window-dedicated-p (selected-window))
4521 (delete-frame (selected-frame)))
4522 (delete-window (selected-window))
4523 (if (get-buffer-window buf)
4524 (select-window (get-buffer-window buf))))))
4526 (defun previous-completion (n)
4527 "Move to the previous item in the completion list."
4528 (interactive "p")
4529 (next-completion (- n)))
4531 (defun next-completion (n)
4532 "Move to the next item in the completion list.
4533 With prefix argument N, move N items (negative N means move backward)."
4534 (interactive "p")
4535 (let ((beg (point-min)) (end (point-max)))
4536 (while (and (> n 0) (not (eobp)))
4537 ;; If in a completion, move to the end of it.
4538 (when (get-text-property (point) 'mouse-face)
4539 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
4540 ;; Move to start of next one.
4541 (unless (get-text-property (point) 'mouse-face)
4542 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
4543 (setq n (1- n)))
4544 (while (and (< n 0) (not (bobp)))
4545 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
4546 ;; If in a completion, move to the start of it.
4547 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
4548 (goto-char (previous-single-property-change
4549 (point) 'mouse-face nil beg)))
4550 ;; Move to end of the previous completion.
4551 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
4552 (goto-char (previous-single-property-change
4553 (point) 'mouse-face nil beg)))
4554 ;; Move to the start of that one.
4555 (goto-char (previous-single-property-change
4556 (point) 'mouse-face nil beg))
4557 (setq n (1+ n))))))
4559 (defun choose-completion ()
4560 "Choose the completion that point is in or next to."
4561 (interactive)
4562 (let (beg end completion (buffer completion-reference-buffer)
4563 (base-size completion-base-size))
4564 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
4565 (setq end (point) beg (1+ (point))))
4566 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
4567 (setq end (1- (point)) beg (point)))
4568 (if (null beg)
4569 (error "No completion here"))
4570 (setq beg (previous-single-property-change beg 'mouse-face))
4571 (setq end (or (next-single-property-change end 'mouse-face) (point-max)))
4572 (setq completion (buffer-substring beg end))
4573 (let ((owindow (selected-window)))
4574 (if (and (one-window-p t 'selected-frame)
4575 (window-dedicated-p (selected-window)))
4576 ;; This is a special buffer's frame
4577 (iconify-frame (selected-frame))
4578 (or (window-dedicated-p (selected-window))
4579 (bury-buffer)))
4580 (select-window owindow))
4581 (choose-completion-string completion buffer base-size)))
4583 ;; Delete the longest partial match for STRING
4584 ;; that can be found before POINT.
4585 (defun choose-completion-delete-max-match (string)
4586 (let ((opoint (point))
4587 len)
4588 ;; Try moving back by the length of the string.
4589 (goto-char (max (- (point) (length string))
4590 (minibuffer-prompt-end)))
4591 ;; See how far back we were actually able to move. That is the
4592 ;; upper bound on how much we can match and delete.
4593 (setq len (- opoint (point)))
4594 (if completion-ignore-case
4595 (setq string (downcase string)))
4596 (while (and (> len 0)
4597 (let ((tail (buffer-substring (point) opoint)))
4598 (if completion-ignore-case
4599 (setq tail (downcase tail)))
4600 (not (string= tail (substring string 0 len)))))
4601 (setq len (1- len))
4602 (forward-char 1))
4603 (delete-char len)))
4605 (defvar choose-completion-string-functions nil
4606 "Functions that may override the normal insertion of a completion choice.
4607 These functions are called in order with four arguments:
4608 CHOICE - the string to insert in the buffer,
4609 BUFFER - the buffer in which the choice should be inserted,
4610 MINI-P - non-nil iff BUFFER is a minibuffer, and
4611 BASE-SIZE - the number of characters in BUFFER before
4612 the string being completed.
4614 If a function in the list returns non-nil, that function is supposed
4615 to have inserted the CHOICE in the BUFFER, and possibly exited
4616 the minibuffer; no further functions will be called.
4618 If all functions in the list return nil, that means to use
4619 the default method of inserting the completion in BUFFER.")
4621 (defun choose-completion-string (choice &optional buffer base-size)
4622 "Switch to BUFFER and insert the completion choice CHOICE.
4623 BASE-SIZE, if non-nil, says how many characters of BUFFER's text
4624 to keep. If it is nil, we call `choose-completion-delete-max-match'
4625 to decide what to delete."
4627 ;; If BUFFER is the minibuffer, exit the minibuffer
4628 ;; unless it is reading a file name and CHOICE is a directory,
4629 ;; or completion-no-auto-exit is non-nil.
4631 (let* ((buffer (or buffer completion-reference-buffer))
4632 (mini-p (minibufferp buffer)))
4633 ;; If BUFFER is a minibuffer, barf unless it's the currently
4634 ;; active minibuffer.
4635 (if (and mini-p
4636 (or (not (active-minibuffer-window))
4637 (not (equal buffer
4638 (window-buffer (active-minibuffer-window))))))
4639 (error "Minibuffer is not active for completion")
4640 ;; Set buffer so buffer-local choose-completion-string-functions works.
4641 (set-buffer buffer)
4642 (unless (run-hook-with-args-until-success
4643 'choose-completion-string-functions
4644 choice buffer mini-p base-size)
4645 ;; Insert the completion into the buffer where it was requested.
4646 (if base-size
4647 (delete-region (+ base-size (if mini-p
4648 (minibuffer-prompt-end)
4649 (point-min)))
4650 (point))
4651 (choose-completion-delete-max-match choice))
4652 (insert choice)
4653 (remove-text-properties (- (point) (length choice)) (point)
4654 '(mouse-face nil))
4655 ;; Update point in the window that BUFFER is showing in.
4656 (let ((window (get-buffer-window buffer t)))
4657 (set-window-point window (point)))
4658 ;; If completing for the minibuffer, exit it with this choice.
4659 (and (not completion-no-auto-exit)
4660 (equal buffer (window-buffer (minibuffer-window)))
4661 minibuffer-completion-table
4662 ;; If this is reading a file name, and the file name chosen
4663 ;; is a directory, don't exit the minibuffer.
4664 (if (and (eq minibuffer-completion-table 'read-file-name-internal)
4665 (file-directory-p (field-string (point-max))))
4666 (let ((mini (active-minibuffer-window)))
4667 (select-window mini)
4668 (when minibuffer-auto-raise
4669 (raise-frame (window-frame mini))))
4670 (exit-minibuffer)))))))
4672 (defun completion-list-mode ()
4673 "Major mode for buffers showing lists of possible completions.
4675 to select the completion near point.
4677 with the mouse."
4678 (interactive)
4679 (kill-all-local-variables)
4680 (use-local-map completion-list-mode-map)
4681 (setq mode-name "Completion List")
4682 (setq major-mode 'completion-list-mode)
4683 (make-local-variable 'completion-base-size)
4684 (setq completion-base-size nil)
4685 (run-hooks 'completion-list-mode-hook))
4687 (defun completion-list-mode-finish ()
4688 "Finish setup of the completions buffer.
4689 Called from `temp-buffer-show-hook'."
4690 (when (eq major-mode 'completion-list-mode)
4691 (toggle-read-only 1)))
4693 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
4695 (defvar completion-setup-hook nil
4696 "Normal hook run at the end of setting up a completion list buffer.
4697 When this hook is run, the current buffer is the one in which the
4698 command to display the completion list buffer was run.
4699 The completion list buffer is available as the value of `standard-output'.")
4701 ;; This function goes in completion-setup-hook, so that it is called
4702 ;; after the text of the completion list buffer is written.
4703 (defface completions-first-difference
4704 '((t (:inherit bold)))
4705 "Face put on the first uncommon character in completions in *Completions* buffer."
4706 :group 'completion)
4708 (defface completions-common-part
4709 '((t (:inherit default)))
4710 "Face put on the common prefix substring in completions in *Completions* buffer.
4711 The idea of `completions-common-part' is that you can use it to
4712 make the common parts less visible than normal, so that the rest
4713 of the differing parts is, by contrast, slightly highlighted."
4714 :group 'completion)
4716 ;; This is for packages that need to bind it to a non-default regexp
4717 ;; in order to make the first-differing character highlight work
4718 ;; to their liking
4719 (defvar completion-root-regexp "^/"
4720 "Regexp to use in `completion-setup-function' to find the root directory.")
4722 (defun completion-setup-function ()
4723 (let ((mainbuf (current-buffer))
4724 (mbuf-contents (minibuffer-contents)))
4725 ;; When reading a file name in the minibuffer,
4726 ;; set default-directory in the minibuffer
4727 ;; so it will get copied into the completion list buffer.
4728 (if minibuffer-completing-file-name
4729 (with-current-buffer mainbuf
4730 (setq default-directory (file-name-directory mbuf-contents))))
4731 ;; If partial-completion-mode is on, point might not be after the
4732 ;; last character in the minibuffer.
4733 ;; FIXME: This still doesn't work if the text to be completed
4734 ;; starts with a `-'.
4735 (when (and partial-completion-mode (not (eobp)))
4736 (setq mbuf-contents
4737 (substring mbuf-contents 0 (- (point) (point-max)))))
4738 (with-current-buffer standard-output
4739 (completion-list-mode)
4740 (make-local-variable 'completion-reference-buffer)
4741 (setq completion-reference-buffer mainbuf)
4742 (if minibuffer-completing-file-name
4743 ;; For file name completion,
4744 ;; use the number of chars before the start of the
4745 ;; last file name component.
4746 (setq completion-base-size
4747 (with-current-buffer mainbuf
4748 (save-excursion
4749 (goto-char (point-max))
4750 (skip-chars-backward completion-root-regexp)
4751 (- (point) (minibuffer-prompt-end)))))
4752 ;; Otherwise, in minibuffer, the whole input is being completed.
4753 (if (minibufferp mainbuf)
4754 (setq completion-base-size 0)))
4755 ;; Put faces on first uncommon characters and common parts.
4756 (when completion-base-size
4757 (let* ((common-string-length
4758 (- (length mbuf-contents) completion-base-size))
4759 (element-start (next-single-property-change
4760 (point-min)
4761 'mouse-face))
4762 (element-common-end
4763 (and element-start
4764 (+ (or element-start nil) common-string-length)))
4765 (maxp (point-max)))
4766 (while (and element-start (< element-common-end maxp))
4767 (when (and (get-char-property element-start 'mouse-face)
4768 (get-char-property element-common-end 'mouse-face))
4769 (put-text-property element-start element-common-end
4770 'font-lock-face 'completions-common-part)
4771 (put-text-property element-common-end (1+ element-common-end)
4772 'font-lock-face 'completions-first-difference))
4773 (setq element-start (next-single-property-change
4774 element-start
4775 'mouse-face))
4776 (if element-start
4777 (setq element-common-end (+ element-start common-string-length))))))
4778 ;; Insert help string.
4779 (goto-char (point-min))
4780 (if (display-mouse-p)
4781 (insert (substitute-command-keys
4783 (insert (substitute-command-keys
4787 (add-hook 'completion-setup-hook 'completion-setup-function)
4789 (define-key minibuffer-local-completion-map [prior]
4790 'switch-to-completions)
4791 (define-key minibuffer-local-must-match-map [prior]
4792 'switch-to-completions)
4793 (define-key minibuffer-local-completion-map "\M-v"
4794 'switch-to-completions)
4795 (define-key minibuffer-local-must-match-map "\M-v"
4796 'switch-to-completions)
4798 (defun switch-to-completions ()
4799 "Select the completion list window."
4800 (interactive)
4801 ;; Make sure we have a completions window.
4802 (or (get-buffer-window "*Completions*")
4803 (minibuffer-completion-help))
4804 (let ((window (get-buffer-window "*Completions*")))
4805 (when window
4806 (select-window window)
4807 (goto-char (point-min))
4809 (forward-line 1))))
4811 ;; Support keyboard commands to turn on various modifiers.
4813 ;; These functions -- which are not commands -- each add one modifier
4814 ;; to the following event.
4816 (defun event-apply-alt-modifier (ignore-prompt)
4819 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
4820 (defun event-apply-super-modifier (ignore-prompt)
4823 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
4824 (defun event-apply-hyper-modifier (ignore-prompt)
4827 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
4828 (defun event-apply-shift-modifier (ignore-prompt)
4831 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
4832 (defun event-apply-control-modifier (ignore-prompt)
4835 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
4836 (defun event-apply-meta-modifier (ignore-prompt)
4839 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
4841 (defun event-apply-modifier (event symbol lshiftby prefix)
4842 "Apply a modifier flag to event EVENT.
4843 SYMBOL is the name of this modifier, as a symbol.
4844 LSHIFTBY is the numeric value of this modifier, in keyboard events.
4845 PREFIX is the string that represents this modifier in an event type symbol."
4846 (if (numberp event)
4847 (cond ((eq symbol 'control)
4848 (if (and (<= (downcase event) ?z)
4849 (>= (downcase event) ?a))
4850 (- (downcase event) ?a -1)
4851 (if (and (<= (downcase event) ?Z)
4852 (>= (downcase event) ?A))
4853 (- (downcase event) ?A -1)
4854 (logior (lsh 1 lshiftby) event))))
4855 ((eq symbol 'shift)
4856 (if (and (<= (downcase event) ?z)
4857 (>= (downcase event) ?a))
4858 (upcase event)
4859 (logior (lsh 1 lshiftby) event)))
4860 (t
4861 (logior (lsh 1 lshiftby) event)))
4862 (if (memq symbol (event-modifiers event))
4863 event
4864 (let ((event-type (if (symbolp event) event (car event))))
4865 (setq event-type (intern (concat prefix (symbol-name event-type))))
4866 (if (symbolp event)
4867 event-type
4868 (cons event-type (cdr event)))))))
4870 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
4871 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
4872 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
4873 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
4874 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
4875 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
4877 ;;;; Keypad support.
4879 ;;; Make the keypad keys act like ordinary typing keys. If people add
4880 ;;; bindings for the function key symbols, then those bindings will
4881 ;;; override these, so this shouldn't interfere with any existing
4882 ;;; bindings.
4884 ;; Also tell read-char how to handle these keys.
4885 (mapc
4886 (lambda (keypad-normal)
4887 (let ((keypad (nth 0 keypad-normal))
4888 (normal (nth 1 keypad-normal)))
4889 (put keypad 'ascii-character normal)
4890 (define-key function-key-map (vector keypad) (vector normal))))
4891 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
4892 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
4893 (kp-space ?\ )
4896 (kp-multiply ?*)
4897 (kp-add ?+)
4898 (kp-separator ?,)
4899 (kp-subtract ?-)
4900 (kp-decimal ?.)
4901 (kp-divide ?/)
4902 (kp-equal ?=)))
4903 \f
4904 ;;;;
4905 ;;;; forking a twin copy of a buffer.
4906 ;;;;
4908 (defvar clone-buffer-hook nil
4909 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
4911 (defun clone-process (process &optional newname)
4912 "Create a twin copy of PROCESS.
4913 If NEWNAME is nil, it defaults to PROCESS' name;
4914 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
4915 If PROCESS is associated with a buffer, the new process will be associated
4916 with the current buffer instead.
4917 Returns nil if PROCESS has already terminated."
4918 (setq newname (or newname (process-name process)))
4920 (setq newname (substring newname 0 (match-beginning 0))))
4921 (when (memq (process-status process) '(run stop open))
4922 (let* ((process-connection-type (process-tty-name process))
4923 (new-process
4924 (if (memq (process-status process) '(open))
4925 (let ((args (process-contact process t)))
4926 (setq args (plist-put args :name newname))
4927 (setq args (plist-put args :buffer
4928 (if (process-buffer process)
4929 (current-buffer))))
4930 (apply 'make-network-process args))
4931 (apply 'start-process newname
4932 (if (process-buffer process) (current-buffer))
4933 (process-command process)))))
4934 (set-process-query-on-exit-flag
4935 new-process (process-query-on-exit-flag process))
4936 (set-process-inherit-coding-system-flag
4937 new-process (process-inherit-coding-system-flag process))
4938 (set-process-filter new-process (process-filter process))
4939 (set-process-sentinel new-process (process-sentinel process))
4940 (set-process-plist new-process (copy-sequence (process-plist process)))
4941 new-process)))
4943 ;; things to maybe add (currently partly covered by `funcall mode'):
4944 ;; - syntax-table
4945 ;; - overlays
4946 (defun clone-buffer (&optional newname display-flag)
4947 "Create and return a twin copy of the current buffer.
4948 Unlike an indirect buffer, the new buffer can be edited
4949 independently of the old one (if it is not read-only).
4950 NEWNAME is the name of the new buffer. It may be modified by
4951 adding or incrementing <N> at the end as necessary to create a
4952 unique buffer name. If nil, it defaults to the name of the
4953 current buffer, with the proper suffix. If DISPLAY-FLAG is
4954 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
4955 clone a file-visiting buffer, or a buffer whose major mode symbol
4956 has a non-nil `no-clone' property, results in an error.
4958 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
4959 current buffer with appropriate suffix. However, if a prefix
4960 argument is given, then the command prompts for NEWNAME in the
4961 minibuffer.
4963 This runs the normal hook `clone-buffer-hook' in the new buffer
4964 after it has been set up properly in other respects."
4965 (interactive
4966 (progn
4967 (if buffer-file-name
4968 (error "Cannot clone a file-visiting buffer"))
4969 (if (get major-mode 'no-clone)
4970 (error "Cannot clone a buffer in %s mode" mode-name))
4971 (list (if current-prefix-arg (read-string "Name: "))
4972 t)))
4973 (if buffer-file-name
4974 (error "Cannot clone a file-visiting buffer"))
4975 (if (get major-mode 'no-clone)
4976 (error "Cannot clone a buffer in %s mode" mode-name))
4977 (setq newname (or newname (buffer-name)))
4979 (setq newname (substring newname 0 (match-beginning 0))))
4980 (let ((buf (current-buffer))
4981 (ptmin (point-min))
4982 (ptmax (point-max))
4983 (pt (point))
4984 (mk (if mark-active (mark t)))
4985 (modified (buffer-modified-p))
4986 (mode major-mode)
4987 (lvars (buffer-local-variables))
4988 (process (get-buffer-process (current-buffer)))
4989 (new (generate-new-buffer (or newname (buffer-name)))))
4990 (save-restriction
4991 (widen)
4992 (with-current-buffer new
4993 (insert-buffer-substring buf)))
4994 (with-current-buffer new
4995 (narrow-to-region ptmin ptmax)
4996 (goto-char pt)
4997 (if mk (set-mark mk))
4998 (set-buffer-modified-p modified)
5000 ;; Clone the old buffer's process, if any.
5001 (when process (clone-process process))
5003 ;; Now set up the major mode.
5004 (funcall mode)
5006 ;; Set up other local variables.
5007 (mapcar (lambda (v)
5008 (condition-case () ;in case var is read-only
5009 (if (symbolp v)
5010 (makunbound v)
5011 (set (make-local-variable (car v)) (cdr v)))
5012 (error nil)))
5013 lvars)
5015 ;; Run any hooks (typically set up by the major mode
5016 ;; for cloning to work properly).
5017 (run-hooks 'clone-buffer-hook))
5018 (if display-flag (pop-to-buffer new))
5019 new))
5022 (defun clone-indirect-buffer (newname display-flag &optional norecord)
5023 "Create an indirect buffer that is a twin copy of the current buffer.
5025 Give the indirect buffer name NEWNAME. Interactively, read NEW-NAME
5026 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
5027 or if not called with a prefix arg, NEWNAME defaults to the current
5028 buffer's name. The name is modified by adding a `<N>' suffix to it
5029 or by incrementing the N in an existing suffix.
5031 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
5032 This is always done when called interactively.
5034 Optional last arg NORECORD non-nil means do not put this buffer at the
5035 front of the list of recently selected ones."
5036 (interactive
5037 (progn
5038 (if (get major-mode 'no-clone-indirect)
5039 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
5040 (list (if current-prefix-arg
5041 (read-string "BName of indirect buffer: "))
5042 t)))
5043 (if (get major-mode 'no-clone-indirect)
5044 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
5045 (setq newname (or newname (buffer-name)))
5047 (setq newname (substring newname 0 (match-beginning 0))))
5048 (let* ((name (generate-new-buffer-name newname))
5049 (buffer (make-indirect-buffer (current-buffer) name t)))
5050 (when display-flag
5051 (pop-to-buffer buffer norecord))
5052 buffer))
5055 (defun clone-indirect-buffer-other-window (buffer &optional norecord)
5056 "Create an indirect buffer that is a twin copy of BUFFER.
5057 Select the new buffer in another window.
5058 Optional second arg NORECORD non-nil means do not put this buffer at
5059 the front of the list of recently selected ones."
5060 (interactive "bClone buffer in other window: ")
5061 (let ((pop-up-windows t))
5062 (set-buffer buffer)
5063 (clone-indirect-buffer nil t norecord)))
5065 (define-key ctl-x-4-map "c" 'clone-indirect-buffer-other-window)
5066 \f
5067 ;;; Handling of Backspace and Delete keys.
5069 (defcustom normal-erase-is-backspace
5070 (and (not noninteractive)
5071 (or (memq system-type '(ms-dos windows-nt))
5072 (and (memq window-system '(x))
5073 (fboundp 'x-backspace-delete-keys-p)
5074 (x-backspace-delete-keys-p))
5075 ;; If the terminal Emacs is running on has erase char
5076 ;; set to ^H, use the Backspace key for deleting
5077 ;; backward and, and the Delete key for deleting forward.
5078 (and (null window-system)
5079 (eq tty-erase-char ?\^H))))
5080 "If non-nil, Delete key deletes forward and Backspace key deletes backward.
5082 On window systems, the default value of this option is chosen
5083 according to the keyboard used. If the keyboard has both a Backspace
5084 key and a Delete key, and both are mapped to their usual meanings, the
5085 option's default value is set to t, so that Backspace can be used to
5086 delete backward, and Delete can be used to delete forward.
5088 If not running under a window system, customizing this option accomplishes
5089 a similar effect by mapping C-h, which is usually generated by the
5090 Backspace key, to DEL, and by mapping DEL to C-d via
5091 `keyboard-translate'. The former functionality of C-h is available on
5092 the F1 key. You should probably not use this setting if you don't
5093 have both Backspace, Delete and F1 keys.
5095 Setting this variable with setq doesn't take effect. Programmatically,
5096 call `normal-erase-is-backspace-mode' (which see) instead."
5097 :type 'boolean
5098 :group 'editing-basics
5099 :version "21.1"
5100 :set (lambda (symbol value)
5101 ;; The fboundp is because of a problem with :set when
5102 ;; dumping Emacs. It doesn't really matter.
5103 (if (fboundp 'normal-erase-is-backspace-mode)
5104 (normal-erase-is-backspace-mode (or value 0))
5105 (set-default symbol value))))
5108 (defun normal-erase-is-backspace-mode (&optional arg)
5109 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
5111 With numeric arg, turn the mode on if and only if ARG is positive.
5113 On window systems, when this mode is on, Delete is mapped to C-d and
5114 Backspace is mapped to DEL; when this mode is off, both Delete and
5115 Backspace are mapped to DEL. (The remapping goes via
5116 `function-key-map', so binding Delete or Backspace in the global or
5117 local keymap will override that.)
5119 In addition, on window systems, the bindings of C-Delete, M-Delete,
5120 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
5121 the global keymap in accordance with the functionality of Delete and
5122 Backspace. For example, if Delete is remapped to C-d, which deletes
5123 forward, C-Delete is bound to `kill-word', but if Delete is remapped
5124 to DEL, which deletes backward, C-Delete is bound to
5125 `backward-kill-word'.
5127 If not running on a window system, a similar effect is accomplished by
5128 remapping C-h (normally produced by the Backspace key) and DEL via
5129 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
5130 to C-d; if it's off, the keys are not remapped.
5132 When not running on a window system, and this mode is turned on, the
5133 former functionality of C-h is available on the F1 key. You should
5134 probably not turn on this mode on a text-only terminal if you don't
5135 have both Backspace, Delete and F1 keys.
5137 See also `normal-erase-is-backspace'."
5138 (interactive "P")
5139 (setq normal-erase-is-backspace
5140 (if arg
5141 (> (prefix-numeric-value arg) 0)
5142 (not normal-erase-is-backspace)))
5144 (cond ((or (memq window-system '(x w32 mac pc))
5145 (memq system-type '(ms-dos windows-nt)))
5146 (let ((bindings
5147 `(([C-delete] [C-backspace])
5148 ([M-delete] [M-backspace])
5149 ([C-M-delete] [C-M-backspace])
5150 (,esc-map
5151 [C-delete] [C-backspace])))
5152 (old-state (lookup-key function-key-map [delete])))
5154 (if normal-erase-is-backspace
5155 (progn
5156 (define-key function-key-map [delete] [?\C-d])
5157 (define-key function-key-map [kp-delete] [?\C-d])
5158 (define-key function-key-map [backspace] [?\C-?]))
5159 (define-key function-key-map [delete] [?\C-?])
5160 (define-key function-key-map [kp-delete] [?\C-?])
5161 (define-key function-key-map [backspace] [?\C-?]))
5163 ;; Maybe swap bindings of C-delete and C-backspace, etc.
5164 (unless (equal old-state (lookup-key function-key-map [delete]))
5165 (dolist (binding bindings)
5166 (let ((map global-map))
5167 (when (keymapp (car binding))
5168 (setq map (car binding) binding (cdr binding)))
5169 (let* ((key1 (nth 0 binding))
5170 (key2 (nth 1 binding))
5171 (binding1 (lookup-key map key1))
5172 (binding2 (lookup-key map key2)))
5173 (define-key map key1 binding2)
5174 (define-key map key2 binding1)))))))
5175 (t
5176 (if normal-erase-is-backspace
5177 (progn
5178 (keyboard-translate ?\C-h ?\C-?)
5179 (keyboard-translate ?\C-? ?\C-d))
5180 (keyboard-translate ?\C-h ?\C-h)
5181 (keyboard-translate ?\C-? ?\C-?))))
5183 (run-hooks 'normal-erase-is-backspace-hook)
5184 (if (interactive-p)
5185 (message "Delete key deletes %s"
5186 (if normal-erase-is-backspace "forward" "backward"))))
5187 \f
5188 (defcustom idle-update-delay 0.5
5189 "*Idle time delay before updating various things on the screen.
5190 Various Emacs features that update auxiliary information when point moves
5191 wait this many seconds after Emacs becomes idle before doing an update."
5192 :type 'number
5193 :group 'display
5194 :version "22.1")
5195 \f
5196 (defvar vis-mode-saved-buffer-invisibility-spec nil
5197 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
5199 (define-minor-mode visible-mode
5200 "Toggle Visible mode.
5201 With argument ARG turn Visible mode on iff ARG is positive.
5203 Enabling Visible mode makes all invisible text temporarily visible.
5204 Disabling Visible mode turns off that effect. Visible mode
5205 works by saving the value of `buffer-invisibility-spec' and setting it to nil."
5206 :lighter " Vis"
5207 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
5208 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
5209 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
5210 (when visible-mode
5211 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
5212 buffer-invisibility-spec)
5213 (setq buffer-invisibility-spec nil)))
5214 \f
5215 ;; Minibuffer prompt stuff.
5217 ;(defun minibuffer-prompt-modification (start end)
5218 ; (error "You cannot modify the prompt"))
5219 ;
5220 ;
5221 ;(defun minibuffer-prompt-insertion (start end)
5222 ; (let ((inhibit-modification-hooks t))
5223 ; (delete-region start end)
5224 ; ;; Discard undo information for the text insertion itself
5225 ; ;; and for the text deletion.above.
5226 ; (when (consp buffer-undo-list)
5227 ; (setq buffer-undo-list (cddr buffer-undo-list)))
5228 ; (message "You cannot modify the prompt")))
5229 ;
5230 ;
5231 ;(setq minibuffer-prompt-properties
5232 ; (list 'modification-hooks '(minibuffer-prompt-modification)
5233 ; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
5234 ;
5236 (provide 'simple)
5238 ;; arch-tag: 24af67c0-2a49-44f6-b3b1-312d8b570dfd
5239 ;;; simple.el ends here